1c609719bSwdenk# 2b75190deSWolfgang Denk# (C) Copyright 2000 - 2012 3c609719bSwdenk# Wolfgang Denk, DENX Software Engineering, wd@denx.de. 4c609719bSwdenk# 5c609719bSwdenk# See file CREDITS for list of people who contributed to this 6c609719bSwdenk# project. 7c609719bSwdenk# 8c609719bSwdenk# This program is free software; you can redistribute it and/or 9c609719bSwdenk# modify it under the terms of the GNU General Public License as 10c609719bSwdenk# published by the Free Software Foundation; either version 2 of 11c609719bSwdenk# the License, or (at your option) any later version. 12c609719bSwdenk# 13c609719bSwdenk# This program is distributed in the hope that it will be useful, 14c609719bSwdenk# but WITHOUT ANY WARRANTY; without even the implied warranty of 15c609719bSwdenk# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16c609719bSwdenk# GNU General Public License for more details. 17c609719bSwdenk# 18c609719bSwdenk# You should have received a copy of the GNU General Public License 19c609719bSwdenk# along with this program; if not, write to the Free Software 20c609719bSwdenk# Foundation, Inc., 59 Temple Place, Suite 330, Boston, 21c609719bSwdenk# MA 02111-1307 USA 22c609719bSwdenk# 23c609719bSwdenk 24c609719bSwdenkSummary: 25c609719bSwdenk======== 26c609719bSwdenk 2724ee89b9SwdenkThis directory contains the source code for U-Boot, a boot loader for 28e86e5a07SwdenkEmbedded boards based on PowerPC, ARM, MIPS and several other 29e86e5a07Swdenkprocessors, which can be installed in a boot ROM and used to 30e86e5a07Swdenkinitialize and test the hardware or to download and run application 31e86e5a07Swdenkcode. 32c609719bSwdenk 33c609719bSwdenkThe development of U-Boot is closely related to Linux: some parts of 3424ee89b9Swdenkthe source code originate in the Linux source tree, we have some 3524ee89b9Swdenkheader files in common, and special provision has been made to 36c609719bSwdenksupport booting of Linux images. 37c609719bSwdenk 38c609719bSwdenkSome attention has been paid to make this software easily 39c609719bSwdenkconfigurable and extendable. For instance, all monitor commands are 40c609719bSwdenkimplemented with the same call interface, so that it's very easy to 41c609719bSwdenkadd new commands. Also, instead of permanently adding rarely used 42c609719bSwdenkcode (for instance hardware test utilities) to the monitor, you can 43c609719bSwdenkload and run it dynamically. 44c609719bSwdenk 45c609719bSwdenk 46c609719bSwdenkStatus: 47c609719bSwdenk======= 48c609719bSwdenk 49c609719bSwdenkIn general, all boards for which a configuration option exists in the 50c609719bSwdenkMakefile have been tested to some extent and can be considered 51c609719bSwdenk"working". In fact, many of them are used in production systems. 52c609719bSwdenk 53c609719bSwdenkIn case of problems see the CHANGELOG and CREDITS files to find out 54218ca724SWolfgang Denkwho contributed the specific port. The MAINTAINERS file lists board 55218ca724SWolfgang Denkmaintainers. 56c609719bSwdenk 57adb9d851SRobert P. J. DayNote: There is no CHANGELOG file in the actual U-Boot source tree; 58adb9d851SRobert P. J. Dayit can be created dynamically from the Git log using: 59adb9d851SRobert P. J. Day 60adb9d851SRobert P. J. Day make CHANGELOG 61adb9d851SRobert P. J. Day 62c609719bSwdenk 63c609719bSwdenkWhere to get help: 64c609719bSwdenk================== 65c609719bSwdenk 66c609719bSwdenkIn case you have questions about, problems with or contributions for 67c609719bSwdenkU-Boot you should send a message to the U-Boot mailing list at 680c32565fSPeter Tyser<u-boot@lists.denx.de>. There is also an archive of previous traffic 690c32565fSPeter Tyseron the mailing list - please search the archive before asking FAQ's. 700c32565fSPeter TyserPlease see http://lists.denx.de/pipermail/u-boot and 710c32565fSPeter Tyserhttp://dir.gmane.org/gmane.comp.boot-loaders.u-boot 72c609719bSwdenk 73c609719bSwdenk 74218ca724SWolfgang DenkWhere to get source code: 75218ca724SWolfgang Denk========================= 76218ca724SWolfgang Denk 77218ca724SWolfgang DenkThe U-Boot source code is maintained in the git repository at 78218ca724SWolfgang Denkgit://www.denx.de/git/u-boot.git ; you can browse it online at 79218ca724SWolfgang Denkhttp://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary 80218ca724SWolfgang Denk 81218ca724SWolfgang DenkThe "snapshot" links on this page allow you to download tarballs of 8211ccc33fSMarcel Ziswilerany version you might be interested in. Official releases are also 83218ca724SWolfgang Denkavailable for FTP download from the ftp://ftp.denx.de/pub/u-boot/ 84218ca724SWolfgang Denkdirectory. 85218ca724SWolfgang Denk 86d4ee711dSAnatolij GustschinPre-built (and tested) images are available from 87218ca724SWolfgang Denkftp://ftp.denx.de/pub/u-boot/images/ 88218ca724SWolfgang Denk 89218ca724SWolfgang Denk 90c609719bSwdenkWhere we come from: 91c609719bSwdenk=================== 92c609719bSwdenk 93c609719bSwdenk- start from 8xxrom sources 9424ee89b9Swdenk- create PPCBoot project (http://sourceforge.net/projects/ppcboot) 95c609719bSwdenk- clean up code 96c609719bSwdenk- make it easier to add custom boards 97c609719bSwdenk- make it possible to add other [PowerPC] CPUs 98c609719bSwdenk- extend functions, especially: 99c609719bSwdenk * Provide extended interface to Linux boot loader 100c609719bSwdenk * S-Record download 101c609719bSwdenk * network boot 10211ccc33fSMarcel Ziswiler * PCMCIA / CompactFlash / ATA disk / SCSI ... boot 10324ee89b9Swdenk- create ARMBoot project (http://sourceforge.net/projects/armboot) 104c609719bSwdenk- add other CPU families (starting with ARM) 10524ee89b9Swdenk- create U-Boot project (http://sourceforge.net/projects/u-boot) 1060d28f34bSMagnus Lilja- current project page: see http://www.denx.de/wiki/U-Boot 10724ee89b9Swdenk 10824ee89b9Swdenk 10924ee89b9SwdenkNames and Spelling: 11024ee89b9Swdenk=================== 11124ee89b9Swdenk 11224ee89b9SwdenkThe "official" name of this project is "Das U-Boot". The spelling 11324ee89b9Swdenk"U-Boot" shall be used in all written text (documentation, comments 11424ee89b9Swdenkin source files etc.). Example: 11524ee89b9Swdenk 11624ee89b9Swdenk This is the README file for the U-Boot project. 11724ee89b9Swdenk 11824ee89b9SwdenkFile names etc. shall be based on the string "u-boot". Examples: 11924ee89b9Swdenk 12024ee89b9Swdenk include/asm-ppc/u-boot.h 12124ee89b9Swdenk 12224ee89b9Swdenk #include <asm/u-boot.h> 12324ee89b9Swdenk 12424ee89b9SwdenkVariable names, preprocessor constants etc. shall be either based on 12524ee89b9Swdenkthe string "u_boot" or on "U_BOOT". Example: 12624ee89b9Swdenk 12724ee89b9Swdenk U_BOOT_VERSION u_boot_logo 12824ee89b9Swdenk IH_OS_U_BOOT u_boot_hush_start 129c609719bSwdenk 130c609719bSwdenk 13193f19cc0SwdenkVersioning: 13293f19cc0Swdenk=========== 13393f19cc0Swdenk 134360d883aSThomas WeberStarting with the release in October 2008, the names of the releases 135360d883aSThomas Weberwere changed from numerical release numbers without deeper meaning 136360d883aSThomas Weberinto a time stamp based numbering. Regular releases are identified by 137360d883aSThomas Webernames consisting of the calendar year and month of the release date. 138360d883aSThomas WeberAdditional fields (if present) indicate release candidates or bug fix 139360d883aSThomas Weberreleases in "stable" maintenance trees. 14093f19cc0Swdenk 141360d883aSThomas WeberExamples: 142360d883aSThomas Weber U-Boot v2009.11 - Release November 2009 143360d883aSThomas Weber U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree 144360d883aSThomas Weber U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release 14593f19cc0Swdenk 14693f19cc0Swdenk 147c609719bSwdenkDirectory Hierarchy: 148c609719bSwdenk==================== 149c609719bSwdenk 1508d321b81SPeter Tyser/arch Architecture specific files 1518d321b81SPeter Tyser /arm Files generic to ARM architecture 1528d321b81SPeter Tyser /cpu CPU specific files 1538d321b81SPeter Tyser /arm720t Files specific to ARM 720 CPUs 1548d321b81SPeter Tyser /arm920t Files specific to ARM 920 CPUs 1556eb0921aSAndreas Bießmann /at91 Files specific to Atmel AT91RM9200 CPU 1568d321b81SPeter Tyser /imx Files specific to Freescale MC9328 i.MX CPUs 1578d321b81SPeter Tyser /s3c24x0 Files specific to Samsung S3C24X0 CPUs 1588d321b81SPeter Tyser /arm925t Files specific to ARM 925 CPUs 1598d321b81SPeter Tyser /arm926ejs Files specific to ARM 926 CPUs 1608d321b81SPeter Tyser /arm1136 Files specific to ARM 1136 CPUs 1618d321b81SPeter Tyser /ixp Files specific to Intel XScale IXP CPUs 1628d321b81SPeter Tyser /pxa Files specific to Intel XScale PXA CPUs 1638d321b81SPeter Tyser /s3c44b0 Files specific to Samsung S3C44B0 CPUs 1648d321b81SPeter Tyser /sa1100 Files specific to Intel StrongARM SA1100 CPUs 1658d321b81SPeter Tyser /lib Architecture specific library files 1668d321b81SPeter Tyser /avr32 Files generic to AVR32 architecture 1678d321b81SPeter Tyser /cpu CPU specific files 1688d321b81SPeter Tyser /lib Architecture specific library files 1698d321b81SPeter Tyser /blackfin Files generic to Analog Devices Blackfin architecture 1708d321b81SPeter Tyser /cpu CPU specific files 1718d321b81SPeter Tyser /lib Architecture specific library files 172fea25720SGraeme Russ /x86 Files generic to x86 architecture 1738d321b81SPeter Tyser /cpu CPU specific files 1748d321b81SPeter Tyser /lib Architecture specific library files 1758d321b81SPeter Tyser /m68k Files generic to m68k architecture 1768d321b81SPeter Tyser /cpu CPU specific files 1778d321b81SPeter Tyser /mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs 1788d321b81SPeter Tyser /mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs 1798d321b81SPeter Tyser /mcf532x Files specific to Freescale ColdFire MCF5329 CPUs 1808d321b81SPeter Tyser /mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs 1818d321b81SPeter Tyser /mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs 1828d321b81SPeter Tyser /lib Architecture specific library files 1838d321b81SPeter Tyser /microblaze Files generic to microblaze architecture 1848d321b81SPeter Tyser /cpu CPU specific files 1858d321b81SPeter Tyser /lib Architecture specific library files 1868d321b81SPeter Tyser /mips Files generic to MIPS architecture 1878d321b81SPeter Tyser /cpu CPU specific files 18892bbd64eSDaniel Schwierzeck /mips32 Files specific to MIPS32 CPUs 18980421fccSXiangfu Liu /xburst Files specific to Ingenic XBurst CPUs 1908d321b81SPeter Tyser /lib Architecture specific library files 191afc1ce82SMacpaul Lin /nds32 Files generic to NDS32 architecture 192afc1ce82SMacpaul Lin /cpu CPU specific files 193afc1ce82SMacpaul Lin /n1213 Files specific to Andes Technology N1213 CPUs 194afc1ce82SMacpaul Lin /lib Architecture specific library files 1958d321b81SPeter Tyser /nios2 Files generic to Altera NIOS2 architecture 1968d321b81SPeter Tyser /cpu CPU specific files 1978d321b81SPeter Tyser /lib Architecture specific library files 198a47a12beSStefan Roese /powerpc Files generic to PowerPC architecture 1998d321b81SPeter Tyser /cpu CPU specific files 2008d321b81SPeter Tyser /74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs 2018d321b81SPeter Tyser /mpc5xx Files specific to Freescale MPC5xx CPUs 2028d321b81SPeter Tyser /mpc5xxx Files specific to Freescale MPC5xxx CPUs 2038d321b81SPeter Tyser /mpc8xx Files specific to Freescale MPC8xx CPUs 2048d321b81SPeter Tyser /mpc824x Files specific to Freescale MPC824x CPUs 2058d321b81SPeter Tyser /mpc8260 Files specific to Freescale MPC8260 CPUs 2068d321b81SPeter Tyser /mpc85xx Files specific to Freescale MPC85xx CPUs 2078d321b81SPeter Tyser /ppc4xx Files specific to AMCC PowerPC 4xx CPUs 2088d321b81SPeter Tyser /lib Architecture specific library files 2098d321b81SPeter Tyser /sh Files generic to SH architecture 2108d321b81SPeter Tyser /cpu CPU specific files 2118d321b81SPeter Tyser /sh2 Files specific to sh2 CPUs 2128d321b81SPeter Tyser /sh3 Files specific to sh3 CPUs 2138d321b81SPeter Tyser /sh4 Files specific to sh4 CPUs 2148d321b81SPeter Tyser /lib Architecture specific library files 2158d321b81SPeter Tyser /sparc Files generic to SPARC architecture 2168d321b81SPeter Tyser /cpu CPU specific files 2178d321b81SPeter Tyser /leon2 Files specific to Gaisler LEON2 SPARC CPU 2188d321b81SPeter Tyser /leon3 Files specific to Gaisler LEON3 SPARC CPU 2198d321b81SPeter Tyser /lib Architecture specific library files 2208d321b81SPeter Tyser/api Machine/arch independent API for external apps 2218d321b81SPeter Tyser/board Board dependent files 2228d321b81SPeter Tyser/common Misc architecture independent functions 2238d321b81SPeter Tyser/disk Code for disk drive partition handling 2248d321b81SPeter Tyser/doc Documentation (don't expect too much) 2258d321b81SPeter Tyser/drivers Commonly used device drivers 2268d321b81SPeter Tyser/examples Example code for standalone applications, etc. 2278d321b81SPeter Tyser/fs Filesystem code (cramfs, ext2, jffs2, etc.) 2288d321b81SPeter Tyser/include Header Files 2298d321b81SPeter Tyser/lib Files generic to all architectures 2308d321b81SPeter Tyser /libfdt Library files to support flattened device trees 2318d321b81SPeter Tyser /lzma Library files to support LZMA decompression 2328d321b81SPeter Tyser /lzo Library files to support LZO decompression 2338d321b81SPeter Tyser/net Networking code 2348d321b81SPeter Tyser/post Power On Self Test 2358d321b81SPeter Tyser/rtc Real Time Clock drivers 2368d321b81SPeter Tyser/tools Tools to build S-Record or U-Boot images, etc. 237c609719bSwdenk 238c609719bSwdenkSoftware Configuration: 239c609719bSwdenk======================= 240c609719bSwdenk 241c609719bSwdenkConfiguration is usually done using C preprocessor defines; the 242c609719bSwdenkrationale behind that is to avoid dead code whenever possible. 243c609719bSwdenk 244c609719bSwdenkThere are two classes of configuration variables: 245c609719bSwdenk 246c609719bSwdenk* Configuration _OPTIONS_: 247c609719bSwdenk These are selectable by the user and have names beginning with 248c609719bSwdenk "CONFIG_". 249c609719bSwdenk 250c609719bSwdenk* Configuration _SETTINGS_: 251c609719bSwdenk These depend on the hardware etc. and should not be meddled with if 252c609719bSwdenk you don't know what you're doing; they have names beginning with 2536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD "CONFIG_SYS_". 254c609719bSwdenk 255c609719bSwdenkLater we will add a configuration tool - probably similar to or even 256c609719bSwdenkidentical to what's used for the Linux kernel. Right now, we have to 257c609719bSwdenkdo the configuration by hand, which means creating some symbolic 258c609719bSwdenklinks and editing some configuration files. We use the TQM8xxL boards 259c609719bSwdenkas an example here. 260c609719bSwdenk 261c609719bSwdenk 262c609719bSwdenkSelection of Processor Architecture and Board Type: 263c609719bSwdenk--------------------------------------------------- 264c609719bSwdenk 265c609719bSwdenkFor all supported boards there are ready-to-use default 266c609719bSwdenkconfigurations available; just type "make <board_name>_config". 267c609719bSwdenk 268c609719bSwdenkExample: For a TQM823L module type: 269c609719bSwdenk 270c609719bSwdenk cd u-boot 271c609719bSwdenk make TQM823L_config 272c609719bSwdenk 27311ccc33fSMarcel ZiswilerFor the Cogent platform, you need to specify the CPU type as well; 274c609719bSwdenke.g. "make cogent_mpc8xx_config". And also configure the cogent 275c609719bSwdenkdirectory according to the instructions in cogent/README. 276c609719bSwdenk 277c609719bSwdenk 278c609719bSwdenkConfiguration Options: 279c609719bSwdenk---------------------- 280c609719bSwdenk 281c609719bSwdenkConfiguration depends on the combination of board and CPU type; all 282c609719bSwdenksuch information is kept in a configuration file 283c609719bSwdenk"include/configs/<board_name>.h". 284c609719bSwdenk 285c609719bSwdenkExample: For a TQM823L module, all configuration settings are in 286c609719bSwdenk"include/configs/TQM823L.h". 287c609719bSwdenk 288c609719bSwdenk 2897f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux 2907f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to 2917f6c2cbcSwdenkbuild a config tool - later. 2927f6c2cbcSwdenk 2937f6c2cbcSwdenk 294c609719bSwdenkThe following options need to be configured: 295c609719bSwdenk 2962628114eSKim Phillips- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX. 297c609719bSwdenk 2982628114eSKim Phillips- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS. 2996ccec449SWolfgang Denk 3006ccec449SWolfgang Denk- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined) 30109ea0de0SHaavard Skinnemoen Define exactly one, e.g. CONFIG_ATSTK1002 302c609719bSwdenk 303c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined) 304c609719bSwdenk Define exactly one of 305c609719bSwdenk CONFIG_CMA286_60_OLD 306c609719bSwdenk--- FIXME --- not tested yet: 307c609719bSwdenk CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P, 308c609719bSwdenk CONFIG_CMA287_23, CONFIG_CMA287_50 309c609719bSwdenk 310c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined) 311c609719bSwdenk Define exactly one of 312c609719bSwdenk CONFIG_CMA101, CONFIG_CMA102 313c609719bSwdenk 314c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined) 315c609719bSwdenk Define one or more of 316c609719bSwdenk CONFIG_CMA302 317c609719bSwdenk 318c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined) 319c609719bSwdenk Define one or more of 320c609719bSwdenk CONFIG_LCD_HEARTBEAT - update a character position on 32111ccc33fSMarcel Ziswiler the LCD display every second with 322c609719bSwdenk a "rotator" |\-/|\-/ 323c609719bSwdenk 3242535d602Swdenk- Board flavour: (if CONFIG_MPC8260ADS is defined) 3252535d602Swdenk CONFIG_ADSTYPE 3262535d602Swdenk Possible values are: 3276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8260ADS - original MPC8260ADS 3286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8266ADS - MPC8266ADS 3296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR 3306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8272ADS - MPC8272ADS 3312535d602Swdenk 332cf946c6dSLei Wen- Marvell Family Member 333cf946c6dSLei Wen CONFIG_SYS_MVFS - define it if you want to enable 334cf946c6dSLei Wen multiple fs option at one time 335cf946c6dSLei Wen for marvell soc family 336cf946c6dSLei Wen 337c609719bSwdenk- MPC824X Family Member (if CONFIG_MPC824X is defined) 338c609719bSwdenk Define exactly one of 339c609719bSwdenk CONFIG_MPC8240, CONFIG_MPC8245 340c609719bSwdenk 34111ccc33fSMarcel Ziswiler- 8xx CPU Options: (if using an MPC8xx CPU) 34266ca92a5Swdenk CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if 34366ca92a5Swdenk get_gclk_freq() cannot work 3445da627a4Swdenk e.g. if there is no 32KHz 3455da627a4Swdenk reference PIT/RTC clock 34666ca92a5Swdenk CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK 34766ca92a5Swdenk or XTAL/EXTAL) 348c609719bSwdenk 34966ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU): 3506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8xx_CPUCLK_MIN 3516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8xx_CPUCLK_MAX 35266ca92a5Swdenk CONFIG_8xx_CPUCLK_DEFAULT 35375d1ea7fSwdenk See doc/README.MPC866 35475d1ea7fSwdenk 3556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MEASURE_CPUCLK 35675d1ea7fSwdenk 35775d1ea7fSwdenk Define this to measure the actual CPU clock instead 35875d1ea7fSwdenk of relying on the correctness of the configured 35975d1ea7fSwdenk values. Mostly useful for board bringup to make sure 36075d1ea7fSwdenk the PLL is locked at the intended frequency. Note 36175d1ea7fSwdenk that this requires a (stable) reference clock (32 kHz 3626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD RTC clock or CONFIG_SYS_8XX_XIN) 36375d1ea7fSwdenk 364506f3918SHeiko Schocher CONFIG_SYS_DELAYED_ICACHE 365506f3918SHeiko Schocher 366506f3918SHeiko Schocher Define this option if you want to enable the 367506f3918SHeiko Schocher ICache only when Code runs from RAM. 368506f3918SHeiko Schocher 36966412c63SKumar Gala- 85xx CPU Options: 370ffd06e02SYork Sun CONFIG_SYS_PPC64 371ffd06e02SYork Sun 372ffd06e02SYork Sun Specifies that the core is a 64-bit PowerPC implementation (implements 373ffd06e02SYork Sun the "64" category of the Power ISA). This is necessary for ePAPR 374ffd06e02SYork Sun compliance, among other possible reasons. 375ffd06e02SYork Sun 37666412c63SKumar Gala CONFIG_SYS_FSL_TBCLK_DIV 37766412c63SKumar Gala 37866412c63SKumar Gala Defines the core time base clock divider ratio compared to the 37966412c63SKumar Gala system clock. On most PQ3 devices this is 8, on newer QorIQ 38066412c63SKumar Gala devices it can be 16 or 32. The ratio varies from SoC to Soc. 38166412c63SKumar Gala 3828f29084aSKumar Gala CONFIG_SYS_FSL_PCIE_COMPAT 3838f29084aSKumar Gala 3848f29084aSKumar Gala Defines the string to utilize when trying to match PCIe device 3858f29084aSKumar Gala tree nodes for the given platform. 3868f29084aSKumar Gala 387afa6b551SPrabhakar Kushwaha CONFIG_SYS_PPC_E500_DEBUG_TLB 388afa6b551SPrabhakar Kushwaha 389afa6b551SPrabhakar Kushwaha Enables a temporary TLB entry to be used during boot to work 390afa6b551SPrabhakar Kushwaha around limitations in e500v1 and e500v2 external debugger 391afa6b551SPrabhakar Kushwaha support. This reduces the portions of the boot code where 392afa6b551SPrabhakar Kushwaha breakpoints and single stepping do not work. The value of this 393afa6b551SPrabhakar Kushwaha symbol should be set to the TLB1 entry to be used for this 394afa6b551SPrabhakar Kushwaha purpose. 395afa6b551SPrabhakar Kushwaha 39633eee330SScott Wood CONFIG_SYS_FSL_ERRATUM_A004510 39733eee330SScott Wood 39833eee330SScott Wood Enables a workaround for erratum A004510. If set, 39933eee330SScott Wood then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and 40033eee330SScott Wood CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set. 40133eee330SScott Wood 40233eee330SScott Wood CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV 40333eee330SScott Wood CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional) 40433eee330SScott Wood 40533eee330SScott Wood Defines one or two SoC revisions (low 8 bits of SVR) 40633eee330SScott Wood for which the A004510 workaround should be applied. 40733eee330SScott Wood 40833eee330SScott Wood The rest of SVR is either not relevant to the decision 40933eee330SScott Wood of whether the erratum is present (e.g. p2040 versus 41033eee330SScott Wood p2041) or is implied by the build target, which controls 41133eee330SScott Wood whether CONFIG_SYS_FSL_ERRATUM_A004510 is set. 41233eee330SScott Wood 41333eee330SScott Wood See Freescale App Note 4493 for more information about 41433eee330SScott Wood this erratum. 41533eee330SScott Wood 41633eee330SScott Wood CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY 41733eee330SScott Wood 41833eee330SScott Wood This is the value to write into CCSR offset 0x18600 41933eee330SScott Wood according to the A004510 workaround. 42033eee330SScott Wood 4216cb461b4SDaniel Schwierzeck- Generic CPU options: 4226cb461b4SDaniel Schwierzeck CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN 4236cb461b4SDaniel Schwierzeck 4246cb461b4SDaniel Schwierzeck Defines the endianess of the CPU. Implementation of those 4256cb461b4SDaniel Schwierzeck values is arch specific. 4266cb461b4SDaniel Schwierzeck 4270b953ffcSMarkus Klotzbuecher- Intel Monahans options: 4286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO 4290b953ffcSMarkus Klotzbuecher 4300b953ffcSMarkus Klotzbuecher Defines the Monahans run mode to oscillator 4310b953ffcSMarkus Klotzbuecher ratio. Valid values are 8, 16, 24, 31. The core 4320b953ffcSMarkus Klotzbuecher frequency is this value multiplied by 13 MHz. 4330b953ffcSMarkus Klotzbuecher 4346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO 4350b953ffcSMarkus Klotzbuecher 4360b953ffcSMarkus Klotzbuecher Defines the Monahans turbo mode to oscillator 4370b953ffcSMarkus Klotzbuecher ratio. Valid values are 1 (default if undefined) and 4380b953ffcSMarkus Klotzbuecher 2. The core frequency as calculated above is multiplied 4390b953ffcSMarkus Klotzbuecher by this value. 4400b953ffcSMarkus Klotzbuecher 44192bbd64eSDaniel Schwierzeck- MIPS CPU options: 44292bbd64eSDaniel Schwierzeck CONFIG_SYS_INIT_SP_OFFSET 44392bbd64eSDaniel Schwierzeck 44492bbd64eSDaniel Schwierzeck Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack 44592bbd64eSDaniel Schwierzeck pointer. This is needed for the temporary stack before 44692bbd64eSDaniel Schwierzeck relocation. 44792bbd64eSDaniel Schwierzeck 44892bbd64eSDaniel Schwierzeck CONFIG_SYS_MIPS_CACHE_MODE 44992bbd64eSDaniel Schwierzeck 45092bbd64eSDaniel Schwierzeck Cache operation mode for the MIPS CPU. 45192bbd64eSDaniel Schwierzeck See also arch/mips/include/asm/mipsregs.h. 45292bbd64eSDaniel Schwierzeck Possible values are: 45392bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_NO_WA 45492bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_WA 45592bbd64eSDaniel Schwierzeck CONF_CM_UNCACHED 45692bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_NONCOHERENT 45792bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_CE 45892bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_COW 45992bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_CUW 46092bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_ACCELERATED 46192bbd64eSDaniel Schwierzeck 46292bbd64eSDaniel Schwierzeck CONFIG_SYS_XWAY_EBU_BOOTCFG 46392bbd64eSDaniel Schwierzeck 46492bbd64eSDaniel Schwierzeck Special option for Lantiq XWAY SoCs for booting from NOR flash. 46592bbd64eSDaniel Schwierzeck See also arch/mips/cpu/mips32/start.S. 46692bbd64eSDaniel Schwierzeck 46792bbd64eSDaniel Schwierzeck CONFIG_XWAY_SWAP_BYTES 46892bbd64eSDaniel Schwierzeck 46992bbd64eSDaniel Schwierzeck Enable compilation of tools/xway-swap-bytes needed for Lantiq 47092bbd64eSDaniel Schwierzeck XWAY SoCs for booting from NOR flash. The U-Boot image needs to 47192bbd64eSDaniel Schwierzeck be swapped if a flash programmer is used. 47292bbd64eSDaniel Schwierzeck 473b67d8816SChristian Riesch- ARM options: 474b67d8816SChristian Riesch CONFIG_SYS_EXCEPTION_VECTORS_HIGH 475b67d8816SChristian Riesch 476b67d8816SChristian Riesch Select high exception vectors of the ARM core, e.g., do not 477b67d8816SChristian Riesch clear the V bit of the c1 register of CP15. 478b67d8816SChristian Riesch 4795356f545SAneesh V CONFIG_SYS_THUMB_BUILD 4805356f545SAneesh V 4815356f545SAneesh V Use this flag to build U-Boot using the Thumb instruction 4825356f545SAneesh V set for ARM architectures. Thumb instruction set provides 4835356f545SAneesh V better code density. For ARM architectures that support 4845356f545SAneesh V Thumb2 this flag will result in Thumb2 code generated by 4855356f545SAneesh V GCC. 4865356f545SAneesh V 487c5d4752cSStephen Warren CONFIG_ARM_ERRATA_716044 4880678587fSStephen Warren CONFIG_ARM_ERRATA_742230 4890678587fSStephen Warren CONFIG_ARM_ERRATA_743622 4900678587fSStephen Warren CONFIG_ARM_ERRATA_751472 4910678587fSStephen Warren 4920678587fSStephen Warren If set, the workarounds for these ARM errata are applied early 4930678587fSStephen Warren during U-Boot startup. Note that these options force the 4940678587fSStephen Warren workarounds to be applied; no CPU-type/version detection 4950678587fSStephen Warren exists, unlike the similar options in the Linux kernel. Do not 4960678587fSStephen Warren set these options unless they apply! 4970678587fSStephen Warren 498795659dcSStephen Warren- CPU timer options: 499795659dcSStephen Warren CONFIG_SYS_HZ 500795659dcSStephen Warren 501795659dcSStephen Warren The frequency of the timer returned by get_timer(). 502795659dcSStephen Warren get_timer() must operate in milliseconds and this CONFIG 503795659dcSStephen Warren option must be set to 1000. 504795659dcSStephen Warren 5055da627a4Swdenk- Linux Kernel Interface: 506c609719bSwdenk CONFIG_CLOCKS_IN_MHZ 507c609719bSwdenk 508c609719bSwdenk U-Boot stores all clock information in Hz 509c609719bSwdenk internally. For binary compatibility with older Linux 510c609719bSwdenk kernels (which expect the clocks passed in the 511c609719bSwdenk bd_info data to be in MHz) the environment variable 512c609719bSwdenk "clocks_in_mhz" can be defined so that U-Boot 513c609719bSwdenk converts clock data to MHZ before passing it to the 514c609719bSwdenk Linux kernel. 515c609719bSwdenk When CONFIG_CLOCKS_IN_MHZ is defined, a definition of 516c609719bSwdenk "clocks_in_mhz=1" is automatically included in the 517c609719bSwdenk default environment. 518c609719bSwdenk 5195da627a4Swdenk CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only] 5205da627a4Swdenk 52111ccc33fSMarcel Ziswiler When transferring memsize parameter to linux, some versions 5225da627a4Swdenk expect it to be in bytes, others in MB. 5235da627a4Swdenk Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes. 5245da627a4Swdenk 525fec6d9eeSGerald Van Baren CONFIG_OF_LIBFDT 526f57f70aaSWolfgang Denk 527f57f70aaSWolfgang Denk New kernel versions are expecting firmware settings to be 528213bf8c8SGerald Van Baren passed using flattened device trees (based on open firmware 529213bf8c8SGerald Van Baren concepts). 530213bf8c8SGerald Van Baren 531213bf8c8SGerald Van Baren CONFIG_OF_LIBFDT 532213bf8c8SGerald Van Baren * New libfdt-based support 533213bf8c8SGerald Van Baren * Adds the "fdt" command 5343bb342fcSKim Phillips * The bootm command automatically updates the fdt 535213bf8c8SGerald Van Baren 536b55ae402SMarcel Ziswiler OF_CPU - The proper name of the cpus node (only required for 537b55ae402SMarcel Ziswiler MPC512X and MPC5xxx based boards). 538b55ae402SMarcel Ziswiler OF_SOC - The proper name of the soc node (only required for 539b55ae402SMarcel Ziswiler MPC512X and MPC5xxx based boards). 540f57f70aaSWolfgang Denk OF_TBCLK - The timebase frequency. 541c2871f03SKumar Gala OF_STDOUT_PATH - The path to the console device 542f57f70aaSWolfgang Denk 54311ccc33fSMarcel Ziswiler boards with QUICC Engines require OF_QE to set UCC MAC 54411ccc33fSMarcel Ziswiler addresses 5453bb342fcSKim Phillips 5464e253137SKumar Gala CONFIG_OF_BOARD_SETUP 5474e253137SKumar Gala 5484e253137SKumar Gala Board code has addition modification that it wants to make 5494e253137SKumar Gala to the flat device tree before handing it off to the kernel 5506705d81eSwdenk 5510267768eSMatthew McClintock CONFIG_OF_BOOT_CPU 5520267768eSMatthew McClintock 55311ccc33fSMarcel Ziswiler This define fills in the correct boot CPU in the boot 5540267768eSMatthew McClintock param header, the default value is zero if undefined. 5550267768eSMatthew McClintock 5563887c3fbSHeiko Schocher CONFIG_OF_IDE_FIXUP 5573887c3fbSHeiko Schocher 5583887c3fbSHeiko Schocher U-Boot can detect if an IDE device is present or not. 5593887c3fbSHeiko Schocher If not, and this new config option is activated, U-Boot 5603887c3fbSHeiko Schocher removes the ATA node from the DTS before booting Linux, 5613887c3fbSHeiko Schocher so the Linux IDE driver does not probe the device and 5623887c3fbSHeiko Schocher crash. This is needed for buggy hardware (uc101) where 5633887c3fbSHeiko Schocher no pull down resistor is connected to the signal IDE5V_DD7. 5643887c3fbSHeiko Schocher 5657eb29398SIgor Grinberg CONFIG_MACH_TYPE [relevant for ARM only][mandatory] 5667eb29398SIgor Grinberg 5677eb29398SIgor Grinberg This setting is mandatory for all boards that have only one 5687eb29398SIgor Grinberg machine type and must be used to specify the machine type 5697eb29398SIgor Grinberg number as it appears in the ARM machine registry 5707eb29398SIgor Grinberg (see http://www.arm.linux.org.uk/developer/machines/). 5717eb29398SIgor Grinberg Only boards that have multiple machine types supported 5727eb29398SIgor Grinberg in a single configuration file and the machine type is 5737eb29398SIgor Grinberg runtime discoverable, do not have to use this setting. 5747eb29398SIgor Grinberg 5750b2f4ecaSNiklaus Giger- vxWorks boot parameters: 5760b2f4ecaSNiklaus Giger 5770b2f4ecaSNiklaus Giger bootvx constructs a valid bootline using the following 5780b2f4ecaSNiklaus Giger environments variables: bootfile, ipaddr, serverip, hostname. 5790b2f4ecaSNiklaus Giger It loads the vxWorks image pointed bootfile. 5800b2f4ecaSNiklaus Giger 5810b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name 5820b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address 5830b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server 5840b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters 5850b2f4ecaSNiklaus Giger 5860b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_ADD_PARAMS 5870b2f4ecaSNiklaus Giger 5880b2f4ecaSNiklaus Giger Add it at the end of the bootline. E.g "u=username pw=secret" 5890b2f4ecaSNiklaus Giger 5900b2f4ecaSNiklaus Giger Note: If a "bootargs" environment is defined, it will overwride 5910b2f4ecaSNiklaus Giger the defaults discussed just above. 5920b2f4ecaSNiklaus Giger 5932c451f78SAneesh V- Cache Configuration: 5942c451f78SAneesh V CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot 5952c451f78SAneesh V CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot 5962c451f78SAneesh V CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot 5972c451f78SAneesh V 59893bc2193SAneesh V- Cache Configuration for ARM: 59993bc2193SAneesh V CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache 60093bc2193SAneesh V controller 60193bc2193SAneesh V CONFIG_SYS_PL310_BASE - Physical base address of PL310 60293bc2193SAneesh V controller register space 60393bc2193SAneesh V 6046705d81eSwdenk- Serial Ports: 60548d0192fSAndreas Engel CONFIG_PL010_SERIAL 6066705d81eSwdenk 6076705d81eSwdenk Define this if you want support for Amba PrimeCell PL010 UARTs. 6086705d81eSwdenk 60948d0192fSAndreas Engel CONFIG_PL011_SERIAL 6106705d81eSwdenk 6116705d81eSwdenk Define this if you want support for Amba PrimeCell PL011 UARTs. 6126705d81eSwdenk 6136705d81eSwdenk CONFIG_PL011_CLOCK 6146705d81eSwdenk 6156705d81eSwdenk If you have Amba PrimeCell PL011 UARTs, set this variable to 6166705d81eSwdenk the clock speed of the UARTs. 6176705d81eSwdenk 6186705d81eSwdenk CONFIG_PL01x_PORTS 6196705d81eSwdenk 6206705d81eSwdenk If you have Amba PrimeCell PL010 or PL011 UARTs on your board, 6216705d81eSwdenk define this to a list of base addresses for each (supported) 6226705d81eSwdenk port. See e.g. include/configs/versatile.h 6236705d81eSwdenk 624910f1ae3SJohn Rigby CONFIG_PL011_SERIAL_RLCR 625910f1ae3SJohn Rigby 626910f1ae3SJohn Rigby Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500) 627910f1ae3SJohn Rigby have separate receive and transmit line control registers. Set 628910f1ae3SJohn Rigby this variable to initialize the extra register. 629910f1ae3SJohn Rigby 630910f1ae3SJohn Rigby CONFIG_PL011_SERIAL_FLUSH_ON_INIT 631910f1ae3SJohn Rigby 632910f1ae3SJohn Rigby On some platforms (e.g. U8500) U-Boot is loaded by a second stage 633910f1ae3SJohn Rigby boot loader that has already initialized the UART. Define this 634910f1ae3SJohn Rigby variable to flush the UART at init time. 635910f1ae3SJohn Rigby 6366705d81eSwdenk 637c609719bSwdenk- Console Interface: 638c609719bSwdenk Depending on board, define exactly one serial port 639c609719bSwdenk (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2, 640c609719bSwdenk CONFIG_8xx_CONS_SCC1, ...), or switch off the serial 641c609719bSwdenk console by defining CONFIG_8xx_CONS_NONE 642c609719bSwdenk 643c609719bSwdenk Note: if CONFIG_8xx_CONS_NONE is defined, the serial 644c609719bSwdenk port routines must be defined elsewhere 645c609719bSwdenk (i.e. serial_init(), serial_getc(), ...) 646c609719bSwdenk 647c609719bSwdenk CONFIG_CFB_CONSOLE 648c609719bSwdenk Enables console device for a color framebuffer. Needs following 649c53043b7SWolfgang Denk defines (cf. smiLynxEM, i8042) 650c609719bSwdenk VIDEO_FB_LITTLE_ENDIAN graphic memory organisation 651c609719bSwdenk (default big endian) 652c609719bSwdenk VIDEO_HW_RECTFILL graphic chip supports 653c609719bSwdenk rectangle fill 654c609719bSwdenk (cf. smiLynxEM) 655c609719bSwdenk VIDEO_HW_BITBLT graphic chip supports 656c609719bSwdenk bit-blit (cf. smiLynxEM) 657c609719bSwdenk VIDEO_VISIBLE_COLS visible pixel columns 658c609719bSwdenk (cols=pitch) 659c609719bSwdenk VIDEO_VISIBLE_ROWS visible pixel rows 660c609719bSwdenk VIDEO_PIXEL_SIZE bytes per pixel 661c609719bSwdenk VIDEO_DATA_FORMAT graphic data format 662c609719bSwdenk (0-5, cf. cfb_console.c) 663c609719bSwdenk VIDEO_FB_ADRS framebuffer address 664c609719bSwdenk VIDEO_KBD_INIT_FCT keyboard int fct 665c609719bSwdenk (i.e. i8042_kbd_init()) 666c609719bSwdenk VIDEO_TSTC_FCT test char fct 667c609719bSwdenk (i.e. i8042_tstc) 668c609719bSwdenk VIDEO_GETC_FCT get char fct 669c609719bSwdenk (i.e. i8042_getc) 670c609719bSwdenk CONFIG_CONSOLE_CURSOR cursor drawing on/off 671c609719bSwdenk (requires blink timer 672c609719bSwdenk cf. i8042.c) 6736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c) 674c609719bSwdenk CONFIG_CONSOLE_TIME display time/date info in 675c609719bSwdenk upper right corner 676602ad3b3SJon Loeliger (requires CONFIG_CMD_DATE) 677c609719bSwdenk CONFIG_VIDEO_LOGO display Linux logo in 678c609719bSwdenk upper left corner 679a6c7ad2fSwdenk CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of 680a6c7ad2fSwdenk linux_logo.h for logo. 681a6c7ad2fSwdenk Requires CONFIG_VIDEO_LOGO 682c609719bSwdenk CONFIG_CONSOLE_EXTRA_INFO 68311ccc33fSMarcel Ziswiler additional board info beside 684c609719bSwdenk the logo 685c609719bSwdenk 68633a35bbbSPali Rohár When CONFIG_CFB_CONSOLE_ANSI is defined, console will support 68733a35bbbSPali Rohár a limited number of ANSI escape sequences (cursor control, 68833a35bbbSPali Rohár erase functions and limited graphics rendition control). 68933a35bbbSPali Rohár 690c609719bSwdenk When CONFIG_CFB_CONSOLE is defined, video console is 691c609719bSwdenk default i/o. Serial console can be forced with 692c609719bSwdenk environment 'console=serial'. 693c609719bSwdenk 694a3ad8e26Swdenk When CONFIG_SILENT_CONSOLE is defined, all console 695a3ad8e26Swdenk messages (by U-Boot and Linux!) can be silenced with 696a3ad8e26Swdenk the "silent" environment variable. See 697a3ad8e26Swdenk doc/README.silent for more information. 698a3ad8e26Swdenk 699c609719bSwdenk- Console Baudrate: 700c609719bSwdenk CONFIG_BAUDRATE - in bps 701c609719bSwdenk Select one of the baudrates listed in 7026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BAUDRATE_TABLE, see below. 7036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale 704c609719bSwdenk 705c92fac91SHeiko Schocher- Console Rx buffer length 706c92fac91SHeiko Schocher With CONFIG_SYS_SMC_RXBUFLEN it is possible to define 707c92fac91SHeiko Schocher the maximum receive buffer length for the SMC. 7082b3f12c2SHeiko Schocher This option is actual only for 82xx and 8xx possible. 709c92fac91SHeiko Schocher If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE 710c92fac91SHeiko Schocher must be defined, to setup the maximum idle timeout for 711c92fac91SHeiko Schocher the SMC. 712c92fac91SHeiko Schocher 7139558b48aSGraeme Russ- Pre-Console Buffer: 7149558b48aSGraeme Russ Prior to the console being initialised (i.e. serial UART 7159558b48aSGraeme Russ initialised etc) all console output is silently discarded. 7169558b48aSGraeme Russ Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to 7179558b48aSGraeme Russ buffer any console messages prior to the console being 7189558b48aSGraeme Russ initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ 7199558b48aSGraeme Russ bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is 7209558b48aSGraeme Russ a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ 7219558b48aSGraeme Russ bytes are output before the console is initialised, the 7229558b48aSGraeme Russ earlier bytes are discarded. 7239558b48aSGraeme Russ 7249558b48aSGraeme Russ 'Sane' compilers will generate smaller code if 7259558b48aSGraeme Russ CONFIG_PRE_CON_BUF_SZ is a power of 2 7269558b48aSGraeme Russ 727046a37bdSSonny Rao- Safe printf() functions 728046a37bdSSonny Rao Define CONFIG_SYS_VSNPRINTF to compile in safe versions of 729046a37bdSSonny Rao the printf() functions. These are defined in 730046a37bdSSonny Rao include/vsprintf.h and include snprintf(), vsnprintf() and 731046a37bdSSonny Rao so on. Code size increase is approximately 300-500 bytes. 732046a37bdSSonny Rao If this option is not given then these functions will 733046a37bdSSonny Rao silently discard their buffer size argument - this means 734046a37bdSSonny Rao you are not getting any overflow checking in this case. 735046a37bdSSonny Rao 736c609719bSwdenk- Boot Delay: CONFIG_BOOTDELAY - in seconds 737c609719bSwdenk Delay before automatically booting the default image; 738c609719bSwdenk set to -1 to disable autoboot. 73993d7212fSJoe Hershberger set to -2 to autoboot with no delay and not check for abort 74093d7212fSJoe Hershberger (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined). 741c609719bSwdenk 742c609719bSwdenk See doc/README.autoboot for these options that 743c609719bSwdenk work with CONFIG_BOOTDELAY. None are required. 744c609719bSwdenk CONFIG_BOOT_RETRY_TIME 745c609719bSwdenk CONFIG_BOOT_RETRY_MIN 746c609719bSwdenk CONFIG_AUTOBOOT_KEYED 747c609719bSwdenk CONFIG_AUTOBOOT_PROMPT 748c609719bSwdenk CONFIG_AUTOBOOT_DELAY_STR 749c609719bSwdenk CONFIG_AUTOBOOT_STOP_STR 750c609719bSwdenk CONFIG_AUTOBOOT_DELAY_STR2 751c609719bSwdenk CONFIG_AUTOBOOT_STOP_STR2 752c609719bSwdenk CONFIG_ZERO_BOOTDELAY_CHECK 753c609719bSwdenk CONFIG_RESET_TO_RETRY 754c609719bSwdenk 755c609719bSwdenk- Autoboot Command: 756c609719bSwdenk CONFIG_BOOTCOMMAND 757c609719bSwdenk Only needed when CONFIG_BOOTDELAY is enabled; 758c609719bSwdenk define a command string that is automatically executed 759c609719bSwdenk when no character is read on the console interface 760c609719bSwdenk within "Boot Delay" after reset. 761c609719bSwdenk 762c609719bSwdenk CONFIG_BOOTARGS 763c609719bSwdenk This can be used to pass arguments to the bootm 764c609719bSwdenk command. The value of CONFIG_BOOTARGS goes into the 765c609719bSwdenk environment value "bootargs". 766c609719bSwdenk 767c609719bSwdenk CONFIG_RAMBOOT and CONFIG_NFSBOOT 768c609719bSwdenk The value of these goes into the environment as 769c609719bSwdenk "ramboot" and "nfsboot" respectively, and can be used 770c609719bSwdenk as a convenience, when switching between booting from 77111ccc33fSMarcel Ziswiler RAM and NFS. 772c609719bSwdenk 773c609719bSwdenk- Pre-Boot Commands: 774c609719bSwdenk CONFIG_PREBOOT 775c609719bSwdenk 776c609719bSwdenk When this option is #defined, the existence of the 777c609719bSwdenk environment variable "preboot" will be checked 778c609719bSwdenk immediately before starting the CONFIG_BOOTDELAY 779c609719bSwdenk countdown and/or running the auto-boot command resp. 780c609719bSwdenk entering interactive mode. 781c609719bSwdenk 782c609719bSwdenk This feature is especially useful when "preboot" is 783c609719bSwdenk automatically generated or modified. For an example 784c609719bSwdenk see the LWMON board specific code: here "preboot" is 785c609719bSwdenk modified when the user holds down a certain 786c609719bSwdenk combination of keys on the (special) keyboard when 787c609719bSwdenk booting the systems 788c609719bSwdenk 789c609719bSwdenk- Serial Download Echo Mode: 790c609719bSwdenk CONFIG_LOADS_ECHO 791c609719bSwdenk If defined to 1, all characters received during a 792c609719bSwdenk serial download (using the "loads" command) are 793c609719bSwdenk echoed back. This might be needed by some terminal 794c609719bSwdenk emulations (like "cu"), but may as well just take 795c609719bSwdenk time on others. This setting #define's the initial 796c609719bSwdenk value of the "loads_echo" environment variable. 797c609719bSwdenk 798602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined) 799c609719bSwdenk CONFIG_KGDB_BAUDRATE 800c609719bSwdenk Select one of the baudrates listed in 8016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BAUDRATE_TABLE, see below. 802c609719bSwdenk 803c609719bSwdenk- Monitor Functions: 804602ad3b3SJon Loeliger Monitor commands can be included or excluded 805602ad3b3SJon Loeliger from the build by using the #include files 806c6c621bdSStephen Warren <config_cmd_all.h> and #undef'ing unwanted 807c6c621bdSStephen Warren commands, or using <config_cmd_default.h> 808602ad3b3SJon Loeliger and augmenting with additional #define's 809602ad3b3SJon Loeliger for wanted commands. 810c609719bSwdenk 811602ad3b3SJon Loeliger The default command configuration includes all commands 812602ad3b3SJon Loeliger except those marked below with a "*". 813602ad3b3SJon Loeliger 814602ad3b3SJon Loeliger CONFIG_CMD_ASKENV * ask for env variable 815602ad3b3SJon Loeliger CONFIG_CMD_BDI bdinfo 816602ad3b3SJon Loeliger CONFIG_CMD_BEDBUG * Include BedBug Debugger 817602ad3b3SJon Loeliger CONFIG_CMD_BMP * BMP support 818602ad3b3SJon Loeliger CONFIG_CMD_BSP * Board specific commands 819602ad3b3SJon Loeliger CONFIG_CMD_BOOTD bootd 820602ad3b3SJon Loeliger CONFIG_CMD_CACHE * icache, dcache 821602ad3b3SJon Loeliger CONFIG_CMD_CONSOLE coninfo 822710b9938SMike Frysinger CONFIG_CMD_CRC32 * crc32 823602ad3b3SJon Loeliger CONFIG_CMD_DATE * support for RTC, date/time... 824602ad3b3SJon Loeliger CONFIG_CMD_DHCP * DHCP support 825602ad3b3SJon Loeliger CONFIG_CMD_DIAG * Diagnostics 826a7c93104SPeter Tyser CONFIG_CMD_DS4510 * ds4510 I2C gpio commands 827a7c93104SPeter Tyser CONFIG_CMD_DS4510_INFO * ds4510 I2C info command 828a7c93104SPeter Tyser CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd 829a7c93104SPeter Tyser CONFIG_CMD_DS4510_RST * ds4510 I2C rst command 830602ad3b3SJon Loeliger CONFIG_CMD_DTT * Digital Therm and Thermostat 831602ad3b3SJon Loeliger CONFIG_CMD_ECHO echo arguments 832246c6922SPeter Tyser CONFIG_CMD_EDITENV edit env variable 833602ad3b3SJon Loeliger CONFIG_CMD_EEPROM * EEPROM read/write support 834602ad3b3SJon Loeliger CONFIG_CMD_ELF * bootelf, bootvx 8355e2b3e0cSJoe Hershberger CONFIG_CMD_ENV_CALLBACK * display details about env callbacks 836fffad71bSJoe Hershberger CONFIG_CMD_ENV_FLAGS * display details about env flags 8370c79cda0SMike Frysinger CONFIG_CMD_EXPORTENV * export the environment 83803e2ecf6SStephen Warren CONFIG_CMD_EXT2 * ext2 command support 83903e2ecf6SStephen Warren CONFIG_CMD_EXT4 * ext4 command support 840bdab39d3SMike Frysinger CONFIG_CMD_SAVEENV saveenv 841602ad3b3SJon Loeliger CONFIG_CMD_FDC * Floppy Disk Support 84203e2ecf6SStephen Warren CONFIG_CMD_FAT * FAT command support 843602ad3b3SJon Loeliger CONFIG_CMD_FDOS * Dos diskette Support 844602ad3b3SJon Loeliger CONFIG_CMD_FLASH flinfo, erase, protect 845602ad3b3SJon Loeliger CONFIG_CMD_FPGA FPGA device initialization support 846ccca7dfdSBenoît Thébaudeau CONFIG_CMD_FUSE Device fuse support 84753fdc7efSAnton Staaf CONFIG_CMD_GETTIME * Get time since boot 848a641b979SMike Frysinger CONFIG_CMD_GO * the 'go' command (exec code) 849a000b795SKim Phillips CONFIG_CMD_GREPENV * search environment 850bf36c5d5SSimon Glass CONFIG_CMD_HASH * calculate hash / digest 851602ad3b3SJon Loeliger CONFIG_CMD_HWFLOW * RTS/CTS hw flow control 852602ad3b3SJon Loeliger CONFIG_CMD_I2C * I2C serial bus support 853602ad3b3SJon Loeliger CONFIG_CMD_IDE * IDE harddisk support 854602ad3b3SJon Loeliger CONFIG_CMD_IMI iminfo 8558fdf1e0fSVipin Kumar CONFIG_CMD_IMLS List all images found in NOR flash 8568fdf1e0fSVipin Kumar CONFIG_CMD_IMLS_NAND List all images found in NAND flash 857602ad3b3SJon Loeliger CONFIG_CMD_IMMAP * IMMR dump support 8580c79cda0SMike Frysinger CONFIG_CMD_IMPORTENV * import an environment 859c167cc02SJoe Hershberger CONFIG_CMD_INI * import data from an ini file into the env 860602ad3b3SJon Loeliger CONFIG_CMD_IRQ * irqinfo 861602ad3b3SJon Loeliger CONFIG_CMD_ITEST Integer/string test of 2 values 862602ad3b3SJon Loeliger CONFIG_CMD_JFFS2 * JFFS2 Support 863602ad3b3SJon Loeliger CONFIG_CMD_KGDB * kgdb 8641ba7fd25SMike Frysinger CONFIG_CMD_LDRINFO ldrinfo (display Blackfin loader) 865d22c338eSJoe Hershberger CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration 866d22c338eSJoe Hershberger (169.254.*.*) 867602ad3b3SJon Loeliger CONFIG_CMD_LOADB loadb 868602ad3b3SJon Loeliger CONFIG_CMD_LOADS loads 86902c9aa1dSRobin Getz CONFIG_CMD_MD5SUM print md5 message digest 87002c9aa1dSRobin Getz (requires CONFIG_CMD_MEMORY and CONFIG_MD5) 87115a33e49SSimon Glass CONFIG_CMD_MEMINFO * Display detailed memory information 872602ad3b3SJon Loeliger CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base, 873a2681707SWolfgang Denk loop, loopw 874a2681707SWolfgang Denk CONFIG_CMD_MEMTEST mtest 875602ad3b3SJon Loeliger CONFIG_CMD_MISC Misc functions like sleep etc 876602ad3b3SJon Loeliger CONFIG_CMD_MMC * MMC memory mapped support 877602ad3b3SJon Loeliger CONFIG_CMD_MII * MII utility commands 87868d7d651SStefan Roese CONFIG_CMD_MTDPARTS * MTD partition support 879602ad3b3SJon Loeliger CONFIG_CMD_NAND * NAND support 880602ad3b3SJon Loeliger CONFIG_CMD_NET bootp, tftpboot, rarpboot 881e92739d3SPeter Tyser CONFIG_CMD_PCA953X * PCA953x I2C gpio commands 882e92739d3SPeter Tyser CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command 883602ad3b3SJon Loeliger CONFIG_CMD_PCI * pciinfo 884602ad3b3SJon Loeliger CONFIG_CMD_PCMCIA * PCMCIA support 885602ad3b3SJon Loeliger CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network 886602ad3b3SJon Loeliger host 887602ad3b3SJon Loeliger CONFIG_CMD_PORTIO * Port I/O 888ff048ea9SKenneth Waters CONFIG_CMD_READ * Read raw data from partition 889602ad3b3SJon Loeliger CONFIG_CMD_REGINFO * Register dump 890602ad3b3SJon Loeliger CONFIG_CMD_RUN run command in env variable 891d304931fSSimon Glass CONFIG_CMD_SANDBOX * sb command to access sandbox features 892602ad3b3SJon Loeliger CONFIG_CMD_SAVES * save S record dump 893602ad3b3SJon Loeliger CONFIG_CMD_SCSI * SCSI Support 894602ad3b3SJon Loeliger CONFIG_CMD_SDRAM * print SDRAM configuration information 895602ad3b3SJon Loeliger (requires CONFIG_CMD_I2C) 896602ad3b3SJon Loeliger CONFIG_CMD_SETGETDCR Support for DCR Register access 897602ad3b3SJon Loeliger (4xx only) 898f61ec45eSEric Nelson CONFIG_CMD_SF * Read/write/erase SPI NOR flash 899c6b1ee66SAlexander Holler CONFIG_CMD_SHA1SUM print sha1 memory digest 90002c9aa1dSRobin Getz (requires CONFIG_CMD_MEMORY) 9017d861d95SBob Liu CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x 90274de7aefSWolfgang Denk CONFIG_CMD_SOURCE "source" command Support 903602ad3b3SJon Loeliger CONFIG_CMD_SPI * SPI serial bus support 9047a83af07SLuca Ceresoli CONFIG_CMD_TFTPSRV * TFTP transfer in server mode 9051fb7cd49SSimon Glass CONFIG_CMD_TFTPPUT * TFTP put command (upload) 906da83bcd7SJoe Hershberger CONFIG_CMD_TIME * run command and report execution time (ARM specific) 907da83bcd7SJoe Hershberger CONFIG_CMD_TIMER * access to the system tick timer 908602ad3b3SJon Loeliger CONFIG_CMD_USB * USB support 909602ad3b3SJon Loeliger CONFIG_CMD_CDP * Cisco Discover Protocol support 910c8339f51SMarek Vasut CONFIG_CMD_MFSL * Microblaze FSL support 911c609719bSwdenk 912c609719bSwdenk 913c609719bSwdenk EXAMPLE: If you want all functions except of network 914c609719bSwdenk support you can write: 915c609719bSwdenk 916602ad3b3SJon Loeliger #include "config_cmd_all.h" 917602ad3b3SJon Loeliger #undef CONFIG_CMD_NET 918c609719bSwdenk 919213bf8c8SGerald Van Baren Other Commands: 920213bf8c8SGerald Van Baren fdt (flattened device tree) command: CONFIG_OF_LIBFDT 921c609719bSwdenk 922c609719bSwdenk Note: Don't enable the "icache" and "dcache" commands 923602ad3b3SJon Loeliger (configuration option CONFIG_CMD_CACHE) unless you know 924c609719bSwdenk what you (and your U-Boot users) are doing. Data 925c609719bSwdenk cache cannot be enabled on systems like the 8xx or 926c609719bSwdenk 8260 (where accesses to the IMMR region must be 927c609719bSwdenk uncached), and it cannot be disabled on all other 928c609719bSwdenk systems where we (mis-) use the data cache to hold an 929c609719bSwdenk initial stack and some data. 930c609719bSwdenk 931c609719bSwdenk 932c609719bSwdenk XXX - this list needs to get updated! 933c609719bSwdenk 934a5ecbe62SWolfgang Denk- Regular expression support: 935a5ecbe62SWolfgang Denk CONFIG_REGEX 936a5ecbe62SWolfgang Denk If this variable is defined, U-Boot is linked against 937a5ecbe62SWolfgang Denk the SLRE (Super Light Regular Expression) library, 938a5ecbe62SWolfgang Denk which adds regex support to some commands, as for 939a5ecbe62SWolfgang Denk example "env grep" and "setexpr". 940a5ecbe62SWolfgang Denk 94145ba8077SSimon Glass- Device tree: 94245ba8077SSimon Glass CONFIG_OF_CONTROL 94345ba8077SSimon Glass If this variable is defined, U-Boot will use a device tree 94445ba8077SSimon Glass to configure its devices, instead of relying on statically 94545ba8077SSimon Glass compiled #defines in the board file. This option is 94645ba8077SSimon Glass experimental and only available on a few boards. The device 94745ba8077SSimon Glass tree is available in the global data as gd->fdt_blob. 94845ba8077SSimon Glass 9492c0f79e4SSimon Glass U-Boot needs to get its device tree from somewhere. This can 9502c0f79e4SSimon Glass be done using one of the two options below: 951bbb0b128SSimon Glass 952bbb0b128SSimon Glass CONFIG_OF_EMBED 953bbb0b128SSimon Glass If this variable is defined, U-Boot will embed a device tree 954bbb0b128SSimon Glass binary in its image. This device tree file should be in the 955bbb0b128SSimon Glass board directory and called <soc>-<board>.dts. The binary file 956bbb0b128SSimon Glass is then picked up in board_init_f() and made available through 957bbb0b128SSimon Glass the global data structure as gd->blob. 95845ba8077SSimon Glass 9592c0f79e4SSimon Glass CONFIG_OF_SEPARATE 9602c0f79e4SSimon Glass If this variable is defined, U-Boot will build a device tree 9612c0f79e4SSimon Glass binary. It will be called u-boot.dtb. Architecture-specific 9622c0f79e4SSimon Glass code will locate it at run-time. Generally this works by: 9632c0f79e4SSimon Glass 9642c0f79e4SSimon Glass cat u-boot.bin u-boot.dtb >image.bin 9652c0f79e4SSimon Glass 9662c0f79e4SSimon Glass and in fact, U-Boot does this for you, creating a file called 9672c0f79e4SSimon Glass u-boot-dtb.bin which is useful in the common case. You can 9682c0f79e4SSimon Glass still use the individual files if you need something more 9692c0f79e4SSimon Glass exotic. 9702c0f79e4SSimon Glass 971c609719bSwdenk- Watchdog: 972c609719bSwdenk CONFIG_WATCHDOG 973c609719bSwdenk If this variable is defined, it enables watchdog 9746abe6fb6SDetlev Zundel support for the SoC. There must be support in the SoC 9756abe6fb6SDetlev Zundel specific code for a watchdog. For the 8xx and 8260 9766abe6fb6SDetlev Zundel CPUs, the SIU Watchdog feature is enabled in the SYPCR 9776abe6fb6SDetlev Zundel register. When supported for a specific SoC is 9786abe6fb6SDetlev Zundel available, then no further board specific code should 9796abe6fb6SDetlev Zundel be needed to use it. 9806abe6fb6SDetlev Zundel 9816abe6fb6SDetlev Zundel CONFIG_HW_WATCHDOG 9826abe6fb6SDetlev Zundel When using a watchdog circuitry external to the used 9836abe6fb6SDetlev Zundel SoC, then define this variable and provide board 9846abe6fb6SDetlev Zundel specific code for the "hw_watchdog_reset" function. 985c609719bSwdenk 986c1551ea8Sstroese- U-Boot Version: 987c1551ea8Sstroese CONFIG_VERSION_VARIABLE 988c1551ea8Sstroese If this variable is defined, an environment variable 989c1551ea8Sstroese named "ver" is created by U-Boot showing the U-Boot 990c1551ea8Sstroese version as printed by the "version" command. 991a1ea8e51SBenoît Thébaudeau Any change to this variable will be reverted at the 992a1ea8e51SBenoît Thébaudeau next reset. 993c1551ea8Sstroese 994c609719bSwdenk- Real-Time Clock: 995c609719bSwdenk 996602ad3b3SJon Loeliger When CONFIG_CMD_DATE is selected, the type of the RTC 997c609719bSwdenk has to be selected, too. Define exactly one of the 998c609719bSwdenk following options: 999c609719bSwdenk 1000c609719bSwdenk CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx 1001c609719bSwdenk CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC 10024e8b7544SFabio Estevam CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC 1003c609719bSwdenk CONFIG_RTC_MC146818 - use MC146818 RTC 10041cb8e980Swdenk CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC 1005c609719bSwdenk CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC 10067f70e853Swdenk CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC 10073bac3513Swdenk CONFIG_RTC_DS164x - use Dallas DS164x RTC 10089536dfccSTor Krill CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC 10094c0d4c3bSwdenk CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC 10106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337 101171d19f30SHeiko Schocher CONFIG_SYS_RV3029_TCR - enable trickle charger on 101271d19f30SHeiko Schocher RV3029 RTC. 1013c609719bSwdenk 1014b37c7e5eSwdenk Note that if the RTC uses I2C, then the I2C interface 1015b37c7e5eSwdenk must also be configured. See I2C Support, below. 1016b37c7e5eSwdenk 1017e92739d3SPeter Tyser- GPIO Support: 1018e92739d3SPeter Tyser CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO 1019e92739d3SPeter Tyser CONFIG_PCA953X_INFO - enable pca953x info command 1020e92739d3SPeter Tyser 10215dec49caSChris Packham The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of 10225dec49caSChris Packham chip-ngpio pairs that tell the PCA953X driver the number of 10235dec49caSChris Packham pins supported by a particular chip. 10245dec49caSChris Packham 1025e92739d3SPeter Tyser Note that if the GPIO device uses I2C, then the I2C interface 1026e92739d3SPeter Tyser must also be configured. See I2C Support, below. 1027e92739d3SPeter Tyser 1028c609719bSwdenk- Timestamp Support: 1029c609719bSwdenk 1030c609719bSwdenk When CONFIG_TIMESTAMP is selected, the timestamp 1031c609719bSwdenk (date and time) of an image is printed by image 1032c609719bSwdenk commands like bootm or iminfo. This option is 1033602ad3b3SJon Loeliger automatically enabled when you select CONFIG_CMD_DATE . 1034c609719bSwdenk 1035923c46f9SKarl O. Pinc- Partition Labels (disklabels) Supported: 1036923c46f9SKarl O. Pinc Zero or more of the following: 1037923c46f9SKarl O. Pinc CONFIG_MAC_PARTITION Apple's MacOS partition table. 1038923c46f9SKarl O. Pinc CONFIG_DOS_PARTITION MS Dos partition table, traditional on the 1039923c46f9SKarl O. Pinc Intel architecture, USB sticks, etc. 1040923c46f9SKarl O. Pinc CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc. 1041923c46f9SKarl O. Pinc CONFIG_EFI_PARTITION GPT partition table, common when EFI is the 1042923c46f9SKarl O. Pinc bootloader. Note 2TB partition limit; see 1043923c46f9SKarl O. Pinc disk/part_efi.c 1044923c46f9SKarl O. Pinc CONFIG_MTD_PARTITIONS Memory Technology Device partition table. 1045c609719bSwdenk 1046602ad3b3SJon Loeliger If IDE or SCSI support is enabled (CONFIG_CMD_IDE or 1047218ca724SWolfgang Denk CONFIG_CMD_SCSI) you must configure support for at 1048923c46f9SKarl O. Pinc least one non-MTD partition type as well. 1049c609719bSwdenk 1050c609719bSwdenk- IDE Reset method: 10514d13cbadSwdenk CONFIG_IDE_RESET_ROUTINE - this is defined in several 10524d13cbadSwdenk board configurations files but used nowhere! 1053c609719bSwdenk 10544d13cbadSwdenk CONFIG_IDE_RESET - is this is defined, IDE Reset will 10554d13cbadSwdenk be performed by calling the function 10564d13cbadSwdenk ide_set_reset(int reset) 10574d13cbadSwdenk which has to be defined in a board specific file 1058c609719bSwdenk 1059c609719bSwdenk- ATAPI Support: 1060c609719bSwdenk CONFIG_ATAPI 1061c609719bSwdenk 1062c609719bSwdenk Set this to enable ATAPI support. 1063c609719bSwdenk 1064c40b2956Swdenk- LBA48 Support 1065c40b2956Swdenk CONFIG_LBA48 1066c40b2956Swdenk 1067c40b2956Swdenk Set this to enable support for disks larger than 137GB 10684b142febSHeiko Schocher Also look at CONFIG_SYS_64BIT_LBA. 1069c40b2956Swdenk Whithout these , LBA48 support uses 32bit variables and will 'only' 1070c40b2956Swdenk support disks up to 2.1TB. 1071c40b2956Swdenk 10726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_64BIT_LBA: 1073c40b2956Swdenk When enabled, makes the IDE subsystem use 64bit sector addresses. 1074c40b2956Swdenk Default is 32bit. 1075c40b2956Swdenk 1076c609719bSwdenk- SCSI Support: 1077c609719bSwdenk At the moment only there is only support for the 1078c609719bSwdenk SYM53C8XX SCSI controller; define 1079c609719bSwdenk CONFIG_SCSI_SYM53C8XX to enable it. 1080c609719bSwdenk 10816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and 10826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID * 10836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the 1084c609719bSwdenk maximum numbers of LUNs, SCSI ID's and target 1085c609719bSwdenk devices. 10866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz) 1087c609719bSwdenk 1088447c031bSStefan Reinauer The environment variable 'scsidevs' is set to the number of 1089447c031bSStefan Reinauer SCSI devices found during the last scan. 1090447c031bSStefan Reinauer 1091c609719bSwdenk- NETWORK Support (PCI): 1092682011ffSwdenk CONFIG_E1000 1093ce5207e1SKyle Moffett Support for Intel 8254x/8257x gigabit chips. 1094ce5207e1SKyle Moffett 1095ce5207e1SKyle Moffett CONFIG_E1000_SPI 1096ce5207e1SKyle Moffett Utility code for direct access to the SPI bus on Intel 8257x. 1097ce5207e1SKyle Moffett This does not do anything useful unless you set at least one 1098ce5207e1SKyle Moffett of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC. 1099ce5207e1SKyle Moffett 1100ce5207e1SKyle Moffett CONFIG_E1000_SPI_GENERIC 1101ce5207e1SKyle Moffett Allow generic access to the SPI bus on the Intel 8257x, for 1102ce5207e1SKyle Moffett example with the "sspi" command. 1103ce5207e1SKyle Moffett 1104ce5207e1SKyle Moffett CONFIG_CMD_E1000 1105ce5207e1SKyle Moffett Management command for E1000 devices. When used on devices 1106ce5207e1SKyle Moffett with SPI support you can reprogram the EEPROM from U-Boot. 1107682011ffSwdenk 1108ac3315c2SAndre Schwarz CONFIG_E1000_FALLBACK_MAC 110911ccc33fSMarcel Ziswiler default MAC for empty EEPROM after production. 1110ac3315c2SAndre Schwarz 1111c609719bSwdenk CONFIG_EEPRO100 1112c609719bSwdenk Support for Intel 82557/82559/82559ER chips. 111311ccc33fSMarcel Ziswiler Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM 1114c609719bSwdenk write routine for first time initialisation. 1115c609719bSwdenk 1116c609719bSwdenk CONFIG_TULIP 1117c609719bSwdenk Support for Digital 2114x chips. 1118c609719bSwdenk Optional CONFIG_TULIP_SELECT_MEDIA for board specific 1119c609719bSwdenk modem chip initialisation (KS8761/QS6611). 1120c609719bSwdenk 1121c609719bSwdenk CONFIG_NATSEMI 1122c609719bSwdenk Support for National dp83815 chips. 1123c609719bSwdenk 1124c609719bSwdenk CONFIG_NS8382X 1125c609719bSwdenk Support for National dp8382[01] gigabit chips. 1126c609719bSwdenk 112745219c46Swdenk- NETWORK Support (other): 112845219c46Swdenk 1129c041e9d2SJens Scharsig CONFIG_DRIVER_AT91EMAC 1130c041e9d2SJens Scharsig Support for AT91RM9200 EMAC. 1131c041e9d2SJens Scharsig 1132c041e9d2SJens Scharsig CONFIG_RMII 1133c041e9d2SJens Scharsig Define this to use reduced MII inteface 1134c041e9d2SJens Scharsig 1135c041e9d2SJens Scharsig CONFIG_DRIVER_AT91EMAC_QUIET 1136c041e9d2SJens Scharsig If this defined, the driver is quiet. 1137c041e9d2SJens Scharsig The driver doen't show link status messages. 1138c041e9d2SJens Scharsig 1139efdd7319SRob Herring CONFIG_CALXEDA_XGMAC 1140efdd7319SRob Herring Support for the Calxeda XGMAC device 1141efdd7319SRob Herring 11423bb46d23SAshok CONFIG_LAN91C96 114345219c46Swdenk Support for SMSC's LAN91C96 chips. 114445219c46Swdenk 114545219c46Swdenk CONFIG_LAN91C96_BASE 114645219c46Swdenk Define this to hold the physical address 114745219c46Swdenk of the LAN91C96's I/O space 114845219c46Swdenk 114945219c46Swdenk CONFIG_LAN91C96_USE_32_BIT 115045219c46Swdenk Define this to enable 32 bit addressing 115145219c46Swdenk 11523bb46d23SAshok CONFIG_SMC91111 1153f39748aeSwdenk Support for SMSC's LAN91C111 chip 1154f39748aeSwdenk 1155f39748aeSwdenk CONFIG_SMC91111_BASE 1156f39748aeSwdenk Define this to hold the physical address 1157f39748aeSwdenk of the device (I/O space) 1158f39748aeSwdenk 1159f39748aeSwdenk CONFIG_SMC_USE_32_BIT 1160f39748aeSwdenk Define this if data bus is 32 bits 1161f39748aeSwdenk 1162f39748aeSwdenk CONFIG_SMC_USE_IOFUNCS 1163f39748aeSwdenk Define this to use i/o functions instead of macros 1164f39748aeSwdenk (some hardware wont work with macros) 1165f39748aeSwdenk 1166dc02badaSHeiko Schocher CONFIG_DRIVER_TI_EMAC 1167dc02badaSHeiko Schocher Support for davinci emac 1168dc02badaSHeiko Schocher 1169dc02badaSHeiko Schocher CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT 1170dc02badaSHeiko Schocher Define this if you have more then 3 PHYs. 1171dc02badaSHeiko Schocher 1172b3dbf4a5SMacpaul Lin CONFIG_FTGMAC100 1173b3dbf4a5SMacpaul Lin Support for Faraday's FTGMAC100 Gigabit SoC Ethernet 1174b3dbf4a5SMacpaul Lin 1175b3dbf4a5SMacpaul Lin CONFIG_FTGMAC100_EGIGA 1176b3dbf4a5SMacpaul Lin Define this to use GE link update with gigabit PHY. 1177b3dbf4a5SMacpaul Lin Define this if FTGMAC100 is connected to gigabit PHY. 1178b3dbf4a5SMacpaul Lin If your system has 10/100 PHY only, it might not occur 1179b3dbf4a5SMacpaul Lin wrong behavior. Because PHY usually return timeout or 1180b3dbf4a5SMacpaul Lin useless data when polling gigabit status and gigabit 1181b3dbf4a5SMacpaul Lin control registers. This behavior won't affect the 1182b3dbf4a5SMacpaul Lin correctnessof 10/100 link speed update. 1183b3dbf4a5SMacpaul Lin 1184c2fff331SMike Rapoport CONFIG_SMC911X 1185557b377dSJens Gehrlein Support for SMSC's LAN911x and LAN921x chips 1186557b377dSJens Gehrlein 1187c2fff331SMike Rapoport CONFIG_SMC911X_BASE 1188557b377dSJens Gehrlein Define this to hold the physical address 1189557b377dSJens Gehrlein of the device (I/O space) 1190557b377dSJens Gehrlein 1191c2fff331SMike Rapoport CONFIG_SMC911X_32_BIT 1192557b377dSJens Gehrlein Define this if data bus is 32 bits 1193557b377dSJens Gehrlein 1194c2fff331SMike Rapoport CONFIG_SMC911X_16_BIT 1195557b377dSJens Gehrlein Define this if data bus is 16 bits. If your processor 1196557b377dSJens Gehrlein automatically converts one 32 bit word to two 16 bit 1197c2fff331SMike Rapoport words you may also try CONFIG_SMC911X_32_BIT. 1198557b377dSJens Gehrlein 11993d0075faSYoshihiro Shimoda CONFIG_SH_ETHER 12003d0075faSYoshihiro Shimoda Support for Renesas on-chip Ethernet controller 12013d0075faSYoshihiro Shimoda 12023d0075faSYoshihiro Shimoda CONFIG_SH_ETHER_USE_PORT 12033d0075faSYoshihiro Shimoda Define the number of ports to be used 12043d0075faSYoshihiro Shimoda 12053d0075faSYoshihiro Shimoda CONFIG_SH_ETHER_PHY_ADDR 12063d0075faSYoshihiro Shimoda Define the ETH PHY's address 12073d0075faSYoshihiro Shimoda 120868260aabSYoshihiro Shimoda CONFIG_SH_ETHER_CACHE_WRITEBACK 120968260aabSYoshihiro Shimoda If this option is set, the driver enables cache flush. 121068260aabSYoshihiro Shimoda 12115e124724SVadim Bendebury- TPM Support: 1212*90899cc0SChe-liang Chiou CONFIG_TPM 1213*90899cc0SChe-liang Chiou Support TPM devices. 1214*90899cc0SChe-liang Chiou 1215*90899cc0SChe-liang Chiou CONFIG_TPM_TIS_LPC 12165e124724SVadim Bendebury Support for generic parallel port TPM devices. Only one device 12175e124724SVadim Bendebury per system is supported at this time. 12185e124724SVadim Bendebury 12195e124724SVadim Bendebury CONFIG_TPM_TIS_BASE_ADDRESS 12205e124724SVadim Bendebury Base address where the generic TPM device is mapped 12215e124724SVadim Bendebury to. Contemporary x86 systems usually map it at 12225e124724SVadim Bendebury 0xfed40000. 12235e124724SVadim Bendebury 1224c609719bSwdenk- USB Support: 1225c609719bSwdenk At the moment only the UHCI host controller is 12264d13cbadSwdenk supported (PIP405, MIP405, MPC5200); define 1227c609719bSwdenk CONFIG_USB_UHCI to enable it. 1228c609719bSwdenk define CONFIG_USB_KEYBOARD to enable the USB Keyboard 122930d56faeSwdenk and define CONFIG_USB_STORAGE to enable the USB 1230c609719bSwdenk storage devices. 1231c609719bSwdenk Note: 1232c609719bSwdenk Supported are USB Keyboards and USB Floppy drives 1233c609719bSwdenk (TEAC FD-05PUB). 12344d13cbadSwdenk MPC5200 USB requires additional defines: 12354d13cbadSwdenk CONFIG_USB_CLOCK 12364d13cbadSwdenk for 528 MHz Clock: 0x0001bbbb 1237307ecb6dSEric Millbrandt CONFIG_PSC3_USB 1238307ecb6dSEric Millbrandt for USB on PSC3 12394d13cbadSwdenk CONFIG_USB_CONFIG 12404d13cbadSwdenk for differential drivers: 0x00001000 12414d13cbadSwdenk for single ended drivers: 0x00005000 1242307ecb6dSEric Millbrandt for differential drivers on PSC3: 0x00000100 1243307ecb6dSEric Millbrandt for single ended drivers on PSC3: 0x00004100 12446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_USB_EVENT_POLL 1245fdcfaa1bSZhang Wei May be defined to allow interrupt polling 1246fdcfaa1bSZhang Wei instead of using asynchronous interrupts 12474d13cbadSwdenk 12489ab4ce22SSimon Glass CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the 12499ab4ce22SSimon Glass txfilltuning field in the EHCI controller on reset. 12509ab4ce22SSimon Glass 125116c8d5e7SWolfgang Denk- USB Device: 125216c8d5e7SWolfgang Denk Define the below if you wish to use the USB console. 125316c8d5e7SWolfgang Denk Once firmware is rebuilt from a serial console issue the 125416c8d5e7SWolfgang Denk command "setenv stdin usbtty; setenv stdout usbtty" and 125511ccc33fSMarcel Ziswiler attach your USB cable. The Unix command "dmesg" should print 125616c8d5e7SWolfgang Denk it has found a new device. The environment variable usbtty 125716c8d5e7SWolfgang Denk can be set to gserial or cdc_acm to enable your device to 125816c8d5e7SWolfgang Denk appear to a USB host as a Linux gserial device or a 125916c8d5e7SWolfgang Denk Common Device Class Abstract Control Model serial device. 126016c8d5e7SWolfgang Denk If you select usbtty = gserial you should be able to enumerate 126116c8d5e7SWolfgang Denk a Linux host by 126216c8d5e7SWolfgang Denk # modprobe usbserial vendor=0xVendorID product=0xProductID 126316c8d5e7SWolfgang Denk else if using cdc_acm, simply setting the environment 126416c8d5e7SWolfgang Denk variable usbtty to be cdc_acm should suffice. The following 126516c8d5e7SWolfgang Denk might be defined in YourBoardName.h 126616c8d5e7SWolfgang Denk 126716c8d5e7SWolfgang Denk CONFIG_USB_DEVICE 126816c8d5e7SWolfgang Denk Define this to build a UDC device 126916c8d5e7SWolfgang Denk 127016c8d5e7SWolfgang Denk CONFIG_USB_TTY 127116c8d5e7SWolfgang Denk Define this to have a tty type of device available to 127216c8d5e7SWolfgang Denk talk to the UDC device 127316c8d5e7SWolfgang Denk 1274f9da0f89SVipin KUMAR CONFIG_USBD_HS 1275f9da0f89SVipin KUMAR Define this to enable the high speed support for usb 1276f9da0f89SVipin KUMAR device and usbtty. If this feature is enabled, a routine 1277f9da0f89SVipin KUMAR int is_usbd_high_speed(void) 1278f9da0f89SVipin KUMAR also needs to be defined by the driver to dynamically poll 1279f9da0f89SVipin KUMAR whether the enumeration has succeded at high speed or full 1280f9da0f89SVipin KUMAR speed. 1281f9da0f89SVipin KUMAR 12826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_CONSOLE_IS_IN_ENV 128316c8d5e7SWolfgang Denk Define this if you want stdin, stdout &/or stderr to 128416c8d5e7SWolfgang Denk be set to usbtty. 128516c8d5e7SWolfgang Denk 128616c8d5e7SWolfgang Denk mpc8xx: 12876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_USB_EXTC_CLK 0xBLAH 128816c8d5e7SWolfgang Denk Derive USB clock from external clock "blah" 12896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_USB_EXTC_CLK 0x02 129016c8d5e7SWolfgang Denk 12916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_USB_BRG_CLK 0xBLAH 129216c8d5e7SWolfgang Denk Derive USB clock from brgclk 12936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_USB_BRG_CLK 0x04 129416c8d5e7SWolfgang Denk 129516c8d5e7SWolfgang Denk If you have a USB-IF assigned VendorID then you may wish to 129616c8d5e7SWolfgang Denk define your own vendor specific values either in BoardName.h 129716c8d5e7SWolfgang Denk or directly in usbd_vendor_info.h. If you don't define 129816c8d5e7SWolfgang Denk CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME, 129916c8d5e7SWolfgang Denk CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot 130016c8d5e7SWolfgang Denk should pretend to be a Linux device to it's target host. 130116c8d5e7SWolfgang Denk 130216c8d5e7SWolfgang Denk CONFIG_USBD_MANUFACTURER 130316c8d5e7SWolfgang Denk Define this string as the name of your company for 130416c8d5e7SWolfgang Denk - CONFIG_USBD_MANUFACTURER "my company" 130516c8d5e7SWolfgang Denk 130616c8d5e7SWolfgang Denk CONFIG_USBD_PRODUCT_NAME 130716c8d5e7SWolfgang Denk Define this string as the name of your product 130816c8d5e7SWolfgang Denk - CONFIG_USBD_PRODUCT_NAME "acme usb device" 130916c8d5e7SWolfgang Denk 131016c8d5e7SWolfgang Denk CONFIG_USBD_VENDORID 131116c8d5e7SWolfgang Denk Define this as your assigned Vendor ID from the USB 131216c8d5e7SWolfgang Denk Implementors Forum. This *must* be a genuine Vendor ID 131316c8d5e7SWolfgang Denk to avoid polluting the USB namespace. 131416c8d5e7SWolfgang Denk - CONFIG_USBD_VENDORID 0xFFFF 131516c8d5e7SWolfgang Denk 131616c8d5e7SWolfgang Denk CONFIG_USBD_PRODUCTID 131716c8d5e7SWolfgang Denk Define this as the unique Product ID 131816c8d5e7SWolfgang Denk for your device 131916c8d5e7SWolfgang Denk - CONFIG_USBD_PRODUCTID 0xFFFF 1320c609719bSwdenk 1321d70a560fSIgor Grinberg- ULPI Layer Support: 1322d70a560fSIgor Grinberg The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via 1323d70a560fSIgor Grinberg the generic ULPI layer. The generic layer accesses the ULPI PHY 1324d70a560fSIgor Grinberg via the platform viewport, so you need both the genric layer and 1325d70a560fSIgor Grinberg the viewport enabled. Currently only Chipidea/ARC based 1326d70a560fSIgor Grinberg viewport is supported. 1327d70a560fSIgor Grinberg To enable the ULPI layer support, define CONFIG_USB_ULPI and 1328d70a560fSIgor Grinberg CONFIG_USB_ULPI_VIEWPORT in your board configuration file. 13296d365ea0SLucas Stach If your ULPI phy needs a different reference clock than the 13306d365ea0SLucas Stach standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to 13316d365ea0SLucas Stach the appropriate value in Hz. 1332c609719bSwdenk 1333c609719bSwdenk- MMC Support: 1334c609719bSwdenk The MMC controller on the Intel PXA is supported. To 1335c609719bSwdenk enable this define CONFIG_MMC. The MMC can be 1336c609719bSwdenk accessed from the boot prompt by mapping the device 1337c609719bSwdenk to physical memory similar to flash. Command line is 1338602ad3b3SJon Loeliger enabled with CONFIG_CMD_MMC. The MMC driver also works with 1339602ad3b3SJon Loeliger the FAT fs. This is enabled with CONFIG_CMD_FAT. 1340c609719bSwdenk 1341afb35666SYoshihiro Shimoda CONFIG_SH_MMCIF 1342afb35666SYoshihiro Shimoda Support for Renesas on-chip MMCIF controller 1343afb35666SYoshihiro Shimoda 1344afb35666SYoshihiro Shimoda CONFIG_SH_MMCIF_ADDR 1345afb35666SYoshihiro Shimoda Define the base address of MMCIF registers 1346afb35666SYoshihiro Shimoda 1347afb35666SYoshihiro Shimoda CONFIG_SH_MMCIF_CLK 1348afb35666SYoshihiro Shimoda Define the clock frequency for MMCIF 1349afb35666SYoshihiro Shimoda 1350b3ba6e94STom Rini- USB Device Firmware Update (DFU) class support: 1351b3ba6e94STom Rini CONFIG_DFU_FUNCTION 1352b3ba6e94STom Rini This enables the USB portion of the DFU USB class 1353b3ba6e94STom Rini 1354b3ba6e94STom Rini CONFIG_CMD_DFU 1355b3ba6e94STom Rini This enables the command "dfu" which is used to have 1356b3ba6e94STom Rini U-Boot create a DFU class device via USB. This command 1357b3ba6e94STom Rini requires that the "dfu_alt_info" environment variable be 1358b3ba6e94STom Rini set and define the alt settings to expose to the host. 1359b3ba6e94STom Rini 1360b3ba6e94STom Rini CONFIG_DFU_MMC 1361b3ba6e94STom Rini This enables support for exposing (e)MMC devices via DFU. 1362b3ba6e94STom Rini 1363c6631764SPantelis Antoniou CONFIG_DFU_NAND 1364c6631764SPantelis Antoniou This enables support for exposing NAND devices via DFU. 1365c6631764SPantelis Antoniou 1366ea2453d5SPantelis Antoniou CONFIG_SYS_DFU_MAX_FILE_SIZE 1367ea2453d5SPantelis Antoniou When updating files rather than the raw storage device, 1368ea2453d5SPantelis Antoniou we use a static buffer to copy the file into and then write 1369ea2453d5SPantelis Antoniou the buffer once we've been given the whole file. Define 1370ea2453d5SPantelis Antoniou this to the maximum filesize (in bytes) for the buffer. 1371ea2453d5SPantelis Antoniou Default is 4 MiB if undefined. 1372ea2453d5SPantelis Antoniou 13736705d81eSwdenk- Journaling Flash filesystem support: 13746705d81eSwdenk CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE, 13756705d81eSwdenk CONFIG_JFFS2_NAND_DEV 13766705d81eSwdenk Define these for a default partition on a NAND device 13776705d81eSwdenk 13786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS2_FIRST_SECTOR, 13796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS 13806705d81eSwdenk Define these for a default partition on a NOR device 13816705d81eSwdenk 13826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS_CUSTOM_PART 13836705d81eSwdenk Define this to create an own partition. You have to provide a 13846705d81eSwdenk function struct part_info* jffs2_part_info(int part_num) 13856705d81eSwdenk 13866705d81eSwdenk If you define only one JFFS2 partition you may also want to 13876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_JFFS_SINGLE_PART 1 13886705d81eSwdenk to disable the command chpart. This is the default when you 13896705d81eSwdenk have not defined a custom partition 13906705d81eSwdenk 1391c30a15e5SDonggeun Kim- FAT(File Allocation Table) filesystem write function support: 1392c30a15e5SDonggeun Kim CONFIG_FAT_WRITE 1393656f4c65SDonggeun Kim 1394656f4c65SDonggeun Kim Define this to enable support for saving memory data as a 1395656f4c65SDonggeun Kim file in FAT formatted partition. 1396656f4c65SDonggeun Kim 1397656f4c65SDonggeun Kim This will also enable the command "fatwrite" enabling the 1398656f4c65SDonggeun Kim user to write files to FAT. 1399c30a15e5SDonggeun Kim 140084cd9327SGabe BlackCBFS (Coreboot Filesystem) support 140184cd9327SGabe Black CONFIG_CMD_CBFS 140284cd9327SGabe Black 140384cd9327SGabe Black Define this to enable support for reading from a Coreboot 140484cd9327SGabe Black filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls 140584cd9327SGabe Black and cbfsload. 140684cd9327SGabe Black 1407c609719bSwdenk- Keyboard Support: 1408c609719bSwdenk CONFIG_ISA_KEYBOARD 1409c609719bSwdenk 1410c609719bSwdenk Define this to enable standard (PC-Style) keyboard 1411c609719bSwdenk support 1412c609719bSwdenk 1413c609719bSwdenk CONFIG_I8042_KBD 1414c609719bSwdenk Standard PC keyboard driver with US (is default) and 1415c609719bSwdenk GERMAN key layout (switch via environment 'keymap=de') support. 1416c609719bSwdenk Export function i8042_kbd_init, i8042_tstc and i8042_getc 1417c609719bSwdenk for cfb_console. Supports cursor blinking. 1418c609719bSwdenk 1419c609719bSwdenk- Video support: 1420c609719bSwdenk CONFIG_VIDEO 1421c609719bSwdenk 1422c609719bSwdenk Define this to enable video support (for output to 1423c609719bSwdenk video). 1424c609719bSwdenk 1425c609719bSwdenk CONFIG_VIDEO_CT69000 1426c609719bSwdenk 1427c609719bSwdenk Enable Chips & Technologies 69000 Video chip 1428c609719bSwdenk 1429c609719bSwdenk CONFIG_VIDEO_SMI_LYNXEM 1430eeb1b77bSwdenk Enable Silicon Motion SMI 712/710/810 Video chip. The 1431eeb1b77bSwdenk video output is selected via environment 'videoout' 1432eeb1b77bSwdenk (1 = LCD and 2 = CRT). If videoout is undefined, CRT is 1433eeb1b77bSwdenk assumed. 1434c609719bSwdenk 1435eeb1b77bSwdenk For the CT69000 and SMI_LYNXEM drivers, videomode is 143611ccc33fSMarcel Ziswiler selected via environment 'videomode'. Two different ways 1437eeb1b77bSwdenk are possible: 1438eeb1b77bSwdenk - "videomode=num" 'num' is a standard LiLo mode numbers. 1439eeb1b77bSwdenk Following standard modes are supported (* is default): 1440eeb1b77bSwdenk 1441eeb1b77bSwdenk Colors 640x480 800x600 1024x768 1152x864 1280x1024 1442eeb1b77bSwdenk -------------+--------------------------------------------- 1443eeb1b77bSwdenk 8 bits | 0x301* 0x303 0x305 0x161 0x307 1444eeb1b77bSwdenk 15 bits | 0x310 0x313 0x316 0x162 0x319 1445eeb1b77bSwdenk 16 bits | 0x311 0x314 0x317 0x163 0x31A 1446eeb1b77bSwdenk 24 bits | 0x312 0x315 0x318 ? 0x31B 1447eeb1b77bSwdenk -------------+--------------------------------------------- 1448c609719bSwdenk (i.e. setenv videomode 317; saveenv; reset;) 1449c609719bSwdenk 1450eeb1b77bSwdenk - "videomode=bootargs" all the video parameters are parsed 14517817cb20SMarcel Ziswiler from the bootargs. (See drivers/video/videomodes.c) 1452eeb1b77bSwdenk 1453eeb1b77bSwdenk 1454a6c7ad2fSwdenk CONFIG_VIDEO_SED13806 1455a6c7ad2fSwdenk Enable Epson SED13806 driver. This driver supports 8bpp 1456a6c7ad2fSwdenk and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP 1457a6c7ad2fSwdenk or CONFIG_VIDEO_SED13806_16BPP 1458a6c7ad2fSwdenk 14597d3053fbSTimur Tabi CONFIG_FSL_DIU_FB 14607d3053fbSTimur Tabi Enable the Freescale DIU video driver. Reference boards for 14617d3053fbSTimur Tabi SOCs that have a DIU should define this macro to enable DIU 14627d3053fbSTimur Tabi support, and should also define these other macros: 14637d3053fbSTimur Tabi 14647d3053fbSTimur Tabi CONFIG_SYS_DIU_ADDR 14657d3053fbSTimur Tabi CONFIG_VIDEO 14667d3053fbSTimur Tabi CONFIG_CMD_BMP 14677d3053fbSTimur Tabi CONFIG_CFB_CONSOLE 14687d3053fbSTimur Tabi CONFIG_VIDEO_SW_CURSOR 14697d3053fbSTimur Tabi CONFIG_VGA_AS_SINGLE_DEVICE 14707d3053fbSTimur Tabi CONFIG_VIDEO_LOGO 14717d3053fbSTimur Tabi CONFIG_VIDEO_BMP_LOGO 14727d3053fbSTimur Tabi 1473ba8e76bdSTimur Tabi The DIU driver will look for the 'video-mode' environment 1474ba8e76bdSTimur Tabi variable, and if defined, enable the DIU as a console during 1475ba8e76bdSTimur Tabi boot. See the documentation file README.video for a 1476ba8e76bdSTimur Tabi description of this variable. 14777d3053fbSTimur Tabi 1478058d59b0SSimon Glass CONFIG_VIDEO_VGA 1479058d59b0SSimon Glass 1480058d59b0SSimon Glass Enable the VGA video / BIOS for x86. The alternative if you 1481058d59b0SSimon Glass are using coreboot is to use the coreboot frame buffer 1482058d59b0SSimon Glass driver. 1483058d59b0SSimon Glass 1484058d59b0SSimon Glass 1485682011ffSwdenk- Keyboard Support: 1486682011ffSwdenk CONFIG_KEYBOARD 1487682011ffSwdenk 1488682011ffSwdenk Define this to enable a custom keyboard support. 1489682011ffSwdenk This simply calls drv_keyboard_init() which must be 1490682011ffSwdenk defined in your board-specific files. 1491682011ffSwdenk The only board using this so far is RBC823. 1492a6c7ad2fSwdenk 1493c609719bSwdenk- LCD Support: CONFIG_LCD 1494c609719bSwdenk 1495c609719bSwdenk Define this to enable LCD support (for output to LCD 1496c609719bSwdenk display); also select one of the supported displays 1497c609719bSwdenk by defining one of these: 1498c609719bSwdenk 149939cf4804SStelian Pop CONFIG_ATMEL_LCD: 150039cf4804SStelian Pop 150139cf4804SStelian Pop HITACHI TX09D70VM1CCA, 3.5", 240x320. 150239cf4804SStelian Pop 1503fd3103bbSwdenk CONFIG_NEC_NL6448AC33: 1504c609719bSwdenk 1505fd3103bbSwdenk NEC NL6448AC33-18. Active, color, single scan. 1506c609719bSwdenk 1507fd3103bbSwdenk CONFIG_NEC_NL6448BC20 1508c609719bSwdenk 1509fd3103bbSwdenk NEC NL6448BC20-08. 6.5", 640x480. 1510fd3103bbSwdenk Active, color, single scan. 1511fd3103bbSwdenk 1512fd3103bbSwdenk CONFIG_NEC_NL6448BC33_54 1513fd3103bbSwdenk 1514fd3103bbSwdenk NEC NL6448BC33-54. 10.4", 640x480. 1515c609719bSwdenk Active, color, single scan. 1516c609719bSwdenk 1517c609719bSwdenk CONFIG_SHARP_16x9 1518c609719bSwdenk 1519c609719bSwdenk Sharp 320x240. Active, color, single scan. 1520c609719bSwdenk It isn't 16x9, and I am not sure what it is. 1521c609719bSwdenk 1522c609719bSwdenk CONFIG_SHARP_LQ64D341 1523c609719bSwdenk 1524c609719bSwdenk Sharp LQ64D341 display, 640x480. 1525c609719bSwdenk Active, color, single scan. 1526c609719bSwdenk 1527c609719bSwdenk CONFIG_HLD1045 1528c609719bSwdenk 1529c609719bSwdenk HLD1045 display, 640x480. 1530c609719bSwdenk Active, color, single scan. 1531c609719bSwdenk 1532c609719bSwdenk CONFIG_OPTREX_BW 1533c609719bSwdenk 1534c609719bSwdenk Optrex CBL50840-2 NF-FW 99 22 M5 1535c609719bSwdenk or 1536c609719bSwdenk Hitachi LMG6912RPFC-00T 1537c609719bSwdenk or 1538c609719bSwdenk Hitachi SP14Q002 1539c609719bSwdenk 1540c609719bSwdenk 320x240. Black & white. 1541c609719bSwdenk 1542c609719bSwdenk Normally display is black on white background; define 15436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_WHITE_ON_BLACK to get it inverted. 1544c609719bSwdenk 1545676d319eSSimon Glass CONFIG_LCD_ALIGNMENT 1546676d319eSSimon Glass 1547676d319eSSimon Glass Normally the LCD is page-aligned (tyically 4KB). If this is 1548676d319eSSimon Glass defined then the LCD will be aligned to this value instead. 1549676d319eSSimon Glass For ARM it is sometimes useful to use MMU_SECTION_SIZE 1550676d319eSSimon Glass here, since it is cheaper to change data cache settings on 1551676d319eSSimon Glass a per-section basis. 1552676d319eSSimon Glass 15530d89efefSSimon Glass CONFIG_CONSOLE_SCROLL_LINES 15540d89efefSSimon Glass 15550d89efefSSimon Glass When the console need to be scrolled, this is the number of 15560d89efefSSimon Glass lines to scroll by. It defaults to 1. Increasing this makes 15570d89efefSSimon Glass the console jump but can help speed up operation when scrolling 15580d89efefSSimon Glass is slow. 1559676d319eSSimon Glass 156045d7f525STom Wai-Hong Tam CONFIG_LCD_BMP_RLE8 156145d7f525STom Wai-Hong Tam 156245d7f525STom Wai-Hong Tam Support drawing of RLE8-compressed bitmaps on the LCD. 156345d7f525STom Wai-Hong Tam 1564735987c5STom Wai-Hong Tam CONFIG_I2C_EDID 1565735987c5STom Wai-Hong Tam 1566735987c5STom Wai-Hong Tam Enables an 'i2c edid' command which can read EDID 1567735987c5STom Wai-Hong Tam information over I2C from an attached LCD display. 1568735987c5STom Wai-Hong Tam 15697152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN 1570d791b1dcSwdenk 1571d791b1dcSwdenk If this option is set, the environment is checked for 1572d791b1dcSwdenk a variable "splashimage". If found, the usual display 1573d791b1dcSwdenk of logo, copyright and system information on the LCD 1574e94d2cd9Swdenk is suppressed and the BMP image at the address 1575d791b1dcSwdenk specified in "splashimage" is loaded instead. The 1576d791b1dcSwdenk console is redirected to the "nulldev", too. This 1577d791b1dcSwdenk allows for a "silent" boot where a splash screen is 1578d791b1dcSwdenk loaded very quickly after power-on. 1579d791b1dcSwdenk 1580c0880485SNikita Kiryanov CONFIG_SPLASHIMAGE_GUARD 1581c0880485SNikita Kiryanov 1582c0880485SNikita Kiryanov If this option is set, then U-Boot will prevent the environment 1583c0880485SNikita Kiryanov variable "splashimage" from being set to a problematic address 1584c0880485SNikita Kiryanov (see README.displaying-bmps and README.arm-unaligned-accesses). 1585c0880485SNikita Kiryanov This option is useful for targets where, due to alignment 1586c0880485SNikita Kiryanov restrictions, an improperly aligned BMP image will cause a data 1587c0880485SNikita Kiryanov abort. If you think you will not have problems with unaligned 1588c0880485SNikita Kiryanov accesses (for example because your toolchain prevents them) 1589c0880485SNikita Kiryanov there is no need to set this option. 1590c0880485SNikita Kiryanov 15911ca298ceSMatthias Weisser CONFIG_SPLASH_SCREEN_ALIGN 15921ca298ceSMatthias Weisser 15931ca298ceSMatthias Weisser If this option is set the splash image can be freely positioned 15941ca298ceSMatthias Weisser on the screen. Environment variable "splashpos" specifies the 15951ca298ceSMatthias Weisser position as "x,y". If a positive number is given it is used as 15961ca298ceSMatthias Weisser number of pixel from left/top. If a negative number is given it 15971ca298ceSMatthias Weisser is used as number of pixel from right/bottom. You can also 15981ca298ceSMatthias Weisser specify 'm' for centering the image. 15991ca298ceSMatthias Weisser 16001ca298ceSMatthias Weisser Example: 16011ca298ceSMatthias Weisser setenv splashpos m,m 16021ca298ceSMatthias Weisser => image at center of screen 16031ca298ceSMatthias Weisser 16041ca298ceSMatthias Weisser setenv splashpos 30,20 16051ca298ceSMatthias Weisser => image at x = 30 and y = 20 16061ca298ceSMatthias Weisser 16071ca298ceSMatthias Weisser setenv splashpos -10,m 16081ca298ceSMatthias Weisser => vertically centered image 16091ca298ceSMatthias Weisser at x = dspWidth - bmpWidth - 9 16101ca298ceSMatthias Weisser 1611581bb419SNikita Kiryanov CONFIG_SPLASH_SCREEN_PREPARE 1612581bb419SNikita Kiryanov 1613581bb419SNikita Kiryanov If this option is set then the board_splash_screen_prepare() 1614581bb419SNikita Kiryanov function, which must be defined in your code, is called as part 1615581bb419SNikita Kiryanov of the splash screen display sequence. It gives the board an 1616581bb419SNikita Kiryanov opportunity to prepare the splash image data before it is 1617581bb419SNikita Kiryanov processed and sent to the frame buffer by U-Boot. 1618581bb419SNikita Kiryanov 161998f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP 162098f4a3dfSStefan Roese 162198f4a3dfSStefan Roese If this option is set, additionally to standard BMP 162298f4a3dfSStefan Roese images, gzipped BMP images can be displayed via the 162398f4a3dfSStefan Roese splashscreen support or the bmp command. 162498f4a3dfSStefan Roese 1625d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8 1626d5011762SAnatolij Gustschin 1627d5011762SAnatolij Gustschin If this option is set, 8-bit RLE compressed BMP images 1628d5011762SAnatolij Gustschin can be displayed via the splashscreen support or the 1629d5011762SAnatolij Gustschin bmp command. 1630d5011762SAnatolij Gustschin 1631f2b96dfbSLei Wen- Do compresssing for memory range: 1632f2b96dfbSLei Wen CONFIG_CMD_ZIP 1633f2b96dfbSLei Wen 1634f2b96dfbSLei Wen If this option is set, it would use zlib deflate method 1635f2b96dfbSLei Wen to compress the specified memory at its best effort. 1636f2b96dfbSLei Wen 1637c29fdfc1Swdenk- Compression support: 1638c29fdfc1Swdenk CONFIG_BZIP2 1639c29fdfc1Swdenk 1640c29fdfc1Swdenk If this option is set, support for bzip2 compressed 1641c29fdfc1Swdenk images is included. If not, only uncompressed and gzip 1642c29fdfc1Swdenk compressed images are supported. 1643c29fdfc1Swdenk 1644c29fdfc1Swdenk NOTE: the bzip2 algorithm requires a lot of RAM, so 16456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should 1646c29fdfc1Swdenk be at least 4MB. 1647d791b1dcSwdenk 1648fc9c1727SLuigi 'Comio' Mantellini CONFIG_LZMA 1649fc9c1727SLuigi 'Comio' Mantellini 1650fc9c1727SLuigi 'Comio' Mantellini If this option is set, support for lzma compressed 1651fc9c1727SLuigi 'Comio' Mantellini images is included. 1652fc9c1727SLuigi 'Comio' Mantellini 1653fc9c1727SLuigi 'Comio' Mantellini Note: The LZMA algorithm adds between 2 and 4KB of code and it 1654fc9c1727SLuigi 'Comio' Mantellini requires an amount of dynamic memory that is given by the 1655fc9c1727SLuigi 'Comio' Mantellini formula: 1656fc9c1727SLuigi 'Comio' Mantellini 1657fc9c1727SLuigi 'Comio' Mantellini (1846 + 768 << (lc + lp)) * sizeof(uint16) 1658fc9c1727SLuigi 'Comio' Mantellini 1659fc9c1727SLuigi 'Comio' Mantellini Where lc and lp stand for, respectively, Literal context bits 1660fc9c1727SLuigi 'Comio' Mantellini and Literal pos bits. 1661fc9c1727SLuigi 'Comio' Mantellini 1662fc9c1727SLuigi 'Comio' Mantellini This value is upper-bounded by 14MB in the worst case. Anyway, 1663fc9c1727SLuigi 'Comio' Mantellini for a ~4MB large kernel image, we have lc=3 and lp=0 for a 1664fc9c1727SLuigi 'Comio' Mantellini total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is 1665fc9c1727SLuigi 'Comio' Mantellini a very small buffer. 1666fc9c1727SLuigi 'Comio' Mantellini 1667fc9c1727SLuigi 'Comio' Mantellini Use the lzmainfo tool to determinate the lc and lp values and 1668fc9c1727SLuigi 'Comio' Mantellini then calculate the amount of needed dynamic memory (ensuring 16696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD the appropriate CONFIG_SYS_MALLOC_LEN value). 1670fc9c1727SLuigi 'Comio' Mantellini 167117ea1177Swdenk- MII/PHY support: 167217ea1177Swdenk CONFIG_PHY_ADDR 167317ea1177Swdenk 167417ea1177Swdenk The address of PHY on MII bus. 167517ea1177Swdenk 167617ea1177Swdenk CONFIG_PHY_CLOCK_FREQ (ppc4xx) 167717ea1177Swdenk 167817ea1177Swdenk The clock frequency of the MII bus 167917ea1177Swdenk 168017ea1177Swdenk CONFIG_PHY_GIGE 168117ea1177Swdenk 168217ea1177Swdenk If this option is set, support for speed/duplex 168311ccc33fSMarcel Ziswiler detection of gigabit PHY is included. 168417ea1177Swdenk 168517ea1177Swdenk CONFIG_PHY_RESET_DELAY 168617ea1177Swdenk 168717ea1177Swdenk Some PHY like Intel LXT971A need extra delay after 168817ea1177Swdenk reset before any MII register access is possible. 168917ea1177Swdenk For such PHY, set this option to the usec delay 169017ea1177Swdenk required. (minimum 300usec for LXT971A) 169117ea1177Swdenk 169217ea1177Swdenk CONFIG_PHY_CMD_DELAY (ppc4xx) 169317ea1177Swdenk 169417ea1177Swdenk Some PHY like Intel LXT971A need extra delay after 169517ea1177Swdenk command issued before MII status register can be read 169617ea1177Swdenk 1697c609719bSwdenk- Ethernet address: 1698c609719bSwdenk CONFIG_ETHADDR 1699c68a05feSrichardretanubun CONFIG_ETH1ADDR 1700c609719bSwdenk CONFIG_ETH2ADDR 1701c609719bSwdenk CONFIG_ETH3ADDR 1702c68a05feSrichardretanubun CONFIG_ETH4ADDR 1703c68a05feSrichardretanubun CONFIG_ETH5ADDR 1704c609719bSwdenk 170511ccc33fSMarcel Ziswiler Define a default value for Ethernet address to use 170611ccc33fSMarcel Ziswiler for the respective Ethernet interface, in case this 1707c609719bSwdenk is not determined automatically. 1708c609719bSwdenk 1709c609719bSwdenk- IP address: 1710c609719bSwdenk CONFIG_IPADDR 1711c609719bSwdenk 1712c609719bSwdenk Define a default value for the IP address to use for 171311ccc33fSMarcel Ziswiler the default Ethernet interface, in case this is not 1714c609719bSwdenk determined through e.g. bootp. 17151ebcd654SWolfgang Denk (Environment variable "ipaddr") 1716c609719bSwdenk 1717c609719bSwdenk- Server IP address: 1718c609719bSwdenk CONFIG_SERVERIP 1719c609719bSwdenk 1720c609719bSwdenk Defines a default value for the IP address of a TFTP 1721c609719bSwdenk server to contact when using the "tftboot" command. 17221ebcd654SWolfgang Denk (Environment variable "serverip") 1723c609719bSwdenk 172497cfe861SRobin Getz CONFIG_KEEP_SERVERADDR 172597cfe861SRobin Getz 172697cfe861SRobin Getz Keeps the server's MAC address, in the env 'serveraddr' 172797cfe861SRobin Getz for passing to bootargs (like Linux's netconsole option) 172897cfe861SRobin Getz 17291ebcd654SWolfgang Denk- Gateway IP address: 17301ebcd654SWolfgang Denk CONFIG_GATEWAYIP 17311ebcd654SWolfgang Denk 17321ebcd654SWolfgang Denk Defines a default value for the IP address of the 17331ebcd654SWolfgang Denk default router where packets to other networks are 17341ebcd654SWolfgang Denk sent to. 17351ebcd654SWolfgang Denk (Environment variable "gatewayip") 17361ebcd654SWolfgang Denk 17371ebcd654SWolfgang Denk- Subnet mask: 17381ebcd654SWolfgang Denk CONFIG_NETMASK 17391ebcd654SWolfgang Denk 17401ebcd654SWolfgang Denk Defines a default value for the subnet mask (or 17411ebcd654SWolfgang Denk routing prefix) which is used to determine if an IP 17421ebcd654SWolfgang Denk address belongs to the local subnet or needs to be 17431ebcd654SWolfgang Denk forwarded through a router. 17441ebcd654SWolfgang Denk (Environment variable "netmask") 17451ebcd654SWolfgang Denk 174653a5c424SDavid Updegraff- Multicast TFTP Mode: 174753a5c424SDavid Updegraff CONFIG_MCAST_TFTP 174853a5c424SDavid Updegraff 174953a5c424SDavid Updegraff Defines whether you want to support multicast TFTP as per 175053a5c424SDavid Updegraff rfc-2090; for example to work with atftp. Lets lots of targets 175111ccc33fSMarcel Ziswiler tftp down the same boot image concurrently. Note: the Ethernet 175253a5c424SDavid Updegraff driver in use must provide a function: mcast() to join/leave a 175353a5c424SDavid Updegraff multicast group. 175453a5c424SDavid Updegraff 1755c609719bSwdenk- BOOTP Recovery Mode: 1756c609719bSwdenk CONFIG_BOOTP_RANDOM_DELAY 1757c609719bSwdenk 1758c609719bSwdenk If you have many targets in a network that try to 1759c609719bSwdenk boot using BOOTP, you may want to avoid that all 1760c609719bSwdenk systems send out BOOTP requests at precisely the same 1761c609719bSwdenk moment (which would happen for instance at recovery 1762c609719bSwdenk from a power failure, when all systems will try to 1763c609719bSwdenk boot, thus flooding the BOOTP server. Defining 1764c609719bSwdenk CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be 1765c609719bSwdenk inserted before sending out BOOTP requests. The 17666c33c785SWolfgang Denk following delays are inserted then: 1767c609719bSwdenk 1768c609719bSwdenk 1st BOOTP request: delay 0 ... 1 sec 1769c609719bSwdenk 2nd BOOTP request: delay 0 ... 2 sec 1770c609719bSwdenk 3rd BOOTP request: delay 0 ... 4 sec 1771c609719bSwdenk 4th and following 1772c609719bSwdenk BOOTP requests: delay 0 ... 8 sec 1773c609719bSwdenk 1774fe389a82Sstroese- DHCP Advanced Options: 17751fe80d79SJon Loeliger You can fine tune the DHCP functionality by defining 17761fe80d79SJon Loeliger CONFIG_BOOTP_* symbols: 1777fe389a82Sstroese 17781fe80d79SJon Loeliger CONFIG_BOOTP_SUBNETMASK 17791fe80d79SJon Loeliger CONFIG_BOOTP_GATEWAY 17801fe80d79SJon Loeliger CONFIG_BOOTP_HOSTNAME 17811fe80d79SJon Loeliger CONFIG_BOOTP_NISDOMAIN 17821fe80d79SJon Loeliger CONFIG_BOOTP_BOOTPATH 17831fe80d79SJon Loeliger CONFIG_BOOTP_BOOTFILESIZE 17841fe80d79SJon Loeliger CONFIG_BOOTP_DNS 17851fe80d79SJon Loeliger CONFIG_BOOTP_DNS2 17861fe80d79SJon Loeliger CONFIG_BOOTP_SEND_HOSTNAME 17871fe80d79SJon Loeliger CONFIG_BOOTP_NTPSERVER 17881fe80d79SJon Loeliger CONFIG_BOOTP_TIMEOFFSET 17891fe80d79SJon Loeliger CONFIG_BOOTP_VENDOREX 17902c00e099SJoe Hershberger CONFIG_BOOTP_MAY_FAIL 1791fe389a82Sstroese 17925d110f0aSWilson Callan CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip 17935d110f0aSWilson Callan environment variable, not the BOOTP server. 1794fe389a82Sstroese 17952c00e099SJoe Hershberger CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found 17962c00e099SJoe Hershberger after the configured retry count, the call will fail 17972c00e099SJoe Hershberger instead of starting over. This can be used to fail over 17982c00e099SJoe Hershberger to Link-local IP address configuration if the DHCP server 17992c00e099SJoe Hershberger is not available. 18002c00e099SJoe Hershberger 1801fe389a82Sstroese CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS 1802fe389a82Sstroese serverip from a DHCP server, it is possible that more 1803fe389a82Sstroese than one DNS serverip is offered to the client. 1804fe389a82Sstroese If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS 1805fe389a82Sstroese serverip will be stored in the additional environment 1806fe389a82Sstroese variable "dnsip2". The first DNS serverip is always 1807fe389a82Sstroese stored in the variable "dnsip", when CONFIG_BOOTP_DNS 18081fe80d79SJon Loeliger is defined. 1809fe389a82Sstroese 1810fe389a82Sstroese CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable 1811fe389a82Sstroese to do a dynamic update of a DNS server. To do this, they 1812fe389a82Sstroese need the hostname of the DHCP requester. 18135d110f0aSWilson Callan If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content 18141fe80d79SJon Loeliger of the "hostname" environment variable is passed as 18151fe80d79SJon Loeliger option 12 to the DHCP server. 1816fe389a82Sstroese 1817d9a2f416SAras Vaichas CONFIG_BOOTP_DHCP_REQUEST_DELAY 1818d9a2f416SAras Vaichas 1819d9a2f416SAras Vaichas A 32bit value in microseconds for a delay between 1820d9a2f416SAras Vaichas receiving a "DHCP Offer" and sending the "DHCP Request". 1821d9a2f416SAras Vaichas This fixes a problem with certain DHCP servers that don't 1822d9a2f416SAras Vaichas respond 100% of the time to a "DHCP request". E.g. On an 1823d9a2f416SAras Vaichas AT91RM9200 processor running at 180MHz, this delay needed 1824d9a2f416SAras Vaichas to be *at least* 15,000 usec before a Windows Server 2003 1825d9a2f416SAras Vaichas DHCP server would reply 100% of the time. I recommend at 1826d9a2f416SAras Vaichas least 50,000 usec to be safe. The alternative is to hope 1827d9a2f416SAras Vaichas that one of the retries will be successful but note that 1828d9a2f416SAras Vaichas the DHCP timeout and retry process takes a longer than 1829d9a2f416SAras Vaichas this delay. 1830d9a2f416SAras Vaichas 1831d22c338eSJoe Hershberger - Link-local IP address negotiation: 1832d22c338eSJoe Hershberger Negotiate with other link-local clients on the local network 1833d22c338eSJoe Hershberger for an address that doesn't require explicit configuration. 1834d22c338eSJoe Hershberger This is especially useful if a DHCP server cannot be guaranteed 1835d22c338eSJoe Hershberger to exist in all environments that the device must operate. 1836d22c338eSJoe Hershberger 1837d22c338eSJoe Hershberger See doc/README.link-local for more information. 1838d22c338eSJoe Hershberger 1839a3d991bdSwdenk - CDP Options: 1840a3d991bdSwdenk CONFIG_CDP_DEVICE_ID 1841a3d991bdSwdenk 1842a3d991bdSwdenk The device id used in CDP trigger frames. 1843a3d991bdSwdenk 1844a3d991bdSwdenk CONFIG_CDP_DEVICE_ID_PREFIX 1845a3d991bdSwdenk 1846a3d991bdSwdenk A two character string which is prefixed to the MAC address 1847a3d991bdSwdenk of the device. 1848a3d991bdSwdenk 1849a3d991bdSwdenk CONFIG_CDP_PORT_ID 1850a3d991bdSwdenk 1851a3d991bdSwdenk A printf format string which contains the ascii name of 1852a3d991bdSwdenk the port. Normally is set to "eth%d" which sets 185311ccc33fSMarcel Ziswiler eth0 for the first Ethernet, eth1 for the second etc. 1854a3d991bdSwdenk 1855a3d991bdSwdenk CONFIG_CDP_CAPABILITIES 1856a3d991bdSwdenk 1857a3d991bdSwdenk A 32bit integer which indicates the device capabilities; 1858a3d991bdSwdenk 0x00000010 for a normal host which does not forwards. 1859a3d991bdSwdenk 1860a3d991bdSwdenk CONFIG_CDP_VERSION 1861a3d991bdSwdenk 1862a3d991bdSwdenk An ascii string containing the version of the software. 1863a3d991bdSwdenk 1864a3d991bdSwdenk CONFIG_CDP_PLATFORM 1865a3d991bdSwdenk 1866a3d991bdSwdenk An ascii string containing the name of the platform. 1867a3d991bdSwdenk 1868a3d991bdSwdenk CONFIG_CDP_TRIGGER 1869a3d991bdSwdenk 1870a3d991bdSwdenk A 32bit integer sent on the trigger. 1871a3d991bdSwdenk 1872a3d991bdSwdenk CONFIG_CDP_POWER_CONSUMPTION 1873a3d991bdSwdenk 1874a3d991bdSwdenk A 16bit integer containing the power consumption of the 1875a3d991bdSwdenk device in .1 of milliwatts. 1876a3d991bdSwdenk 1877a3d991bdSwdenk CONFIG_CDP_APPLIANCE_VLAN_TYPE 1878a3d991bdSwdenk 1879a3d991bdSwdenk A byte containing the id of the VLAN. 1880a3d991bdSwdenk 1881c609719bSwdenk- Status LED: CONFIG_STATUS_LED 1882c609719bSwdenk 1883c609719bSwdenk Several configurations allow to display the current 1884c609719bSwdenk status using a LED. For instance, the LED will blink 1885c609719bSwdenk fast while running U-Boot code, stop blinking as 1886c609719bSwdenk soon as a reply to a BOOTP request was received, and 1887c609719bSwdenk start blinking slow once the Linux kernel is running 1888c609719bSwdenk (supported by a status LED driver in the Linux 1889c609719bSwdenk kernel). Defining CONFIG_STATUS_LED enables this 1890c609719bSwdenk feature in U-Boot. 1891c609719bSwdenk 1892c609719bSwdenk- CAN Support: CONFIG_CAN_DRIVER 1893c609719bSwdenk 1894c609719bSwdenk Defining CONFIG_CAN_DRIVER enables CAN driver support 1895c609719bSwdenk on those systems that support this (optional) 1896c609719bSwdenk feature, like the TQM8xxL modules. 1897c609719bSwdenk 1898c609719bSwdenk- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C 1899c609719bSwdenk 1900b37c7e5eSwdenk These enable I2C serial bus commands. Defining either of 1901b37c7e5eSwdenk (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will 190211ccc33fSMarcel Ziswiler include the appropriate I2C driver for the selected CPU. 1903c609719bSwdenk 1904b37c7e5eSwdenk This will allow you to use i2c commands at the u-boot 1905602ad3b3SJon Loeliger command line (as long as you set CONFIG_CMD_I2C in 1906b37c7e5eSwdenk CONFIG_COMMANDS) and communicate with i2c based realtime 1907b37c7e5eSwdenk clock chips. See common/cmd_i2c.c for a description of the 1908c609719bSwdenk command line interface. 1909c609719bSwdenk 1910bb99ad6dSBen Warren CONFIG_HARD_I2C selects a hardware I2C controller. 1911c609719bSwdenk 1912b37c7e5eSwdenk CONFIG_SOFT_I2C configures u-boot to use a software (aka 1913b37c7e5eSwdenk bit-banging) driver instead of CPM or similar hardware 1914b37c7e5eSwdenk support for I2C. 1915c609719bSwdenk 1916b37c7e5eSwdenk There are several other quantities that must also be 1917b37c7e5eSwdenk defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C. 1918c609719bSwdenk 19196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD In both cases you will need to define CONFIG_SYS_I2C_SPEED 1920b37c7e5eSwdenk to be the frequency (in Hz) at which you wish your i2c bus 19216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie 192211ccc33fSMarcel Ziswiler the CPU's i2c node address). 1923c609719bSwdenk 19248d321b81SPeter Tyser Now, the u-boot i2c code for the mpc8xx 1925a47a12beSStefan Roese (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node 19268d321b81SPeter Tyser and so its address should therefore be cleared to 0 (See, 19278d321b81SPeter Tyser eg, MPC823e User's Manual p.16-473). So, set 19288d321b81SPeter Tyser CONFIG_SYS_I2C_SLAVE to 0. 1929b37c7e5eSwdenk 19305da71efaSEric Millbrandt CONFIG_SYS_I2C_INIT_MPC5XXX 19315da71efaSEric Millbrandt 19325da71efaSEric Millbrandt When a board is reset during an i2c bus transfer 19335da71efaSEric Millbrandt chips might think that the current transfer is still 19345da71efaSEric Millbrandt in progress. Reset the slave devices by sending start 19355da71efaSEric Millbrandt commands until the slave device responds. 19365da71efaSEric Millbrandt 1937b37c7e5eSwdenk That's all that's required for CONFIG_HARD_I2C. 1938b37c7e5eSwdenk 1939b37c7e5eSwdenk If you use the software i2c interface (CONFIG_SOFT_I2C) 1940b37c7e5eSwdenk then the following macros need to be defined (examples are 1941b37c7e5eSwdenk from include/configs/lwmon.h): 1942c609719bSwdenk 1943c609719bSwdenk I2C_INIT 1944c609719bSwdenk 1945b37c7e5eSwdenk (Optional). Any commands necessary to enable the I2C 1946c609719bSwdenk controller or configure ports. 1947c609719bSwdenk 1948b37c7e5eSwdenk eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL) 1949b37c7e5eSwdenk 1950c609719bSwdenk I2C_PORT 1951c609719bSwdenk 1952c609719bSwdenk (Only for MPC8260 CPU). The I/O port to use (the code 1953c609719bSwdenk assumes both bits are on the same port). Valid values 1954c609719bSwdenk are 0..3 for ports A..D. 1955c609719bSwdenk 1956c609719bSwdenk I2C_ACTIVE 1957c609719bSwdenk 1958c609719bSwdenk The code necessary to make the I2C data line active 1959c609719bSwdenk (driven). If the data line is open collector, this 1960c609719bSwdenk define can be null. 1961c609719bSwdenk 1962b37c7e5eSwdenk eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA) 1963b37c7e5eSwdenk 1964c609719bSwdenk I2C_TRISTATE 1965c609719bSwdenk 1966c609719bSwdenk The code necessary to make the I2C data line tri-stated 1967c609719bSwdenk (inactive). If the data line is open collector, this 1968c609719bSwdenk define can be null. 1969c609719bSwdenk 1970b37c7e5eSwdenk eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA) 1971b37c7e5eSwdenk 1972c609719bSwdenk I2C_READ 1973c609719bSwdenk 1974472d5460SYork Sun Code that returns true if the I2C data line is high, 1975472d5460SYork Sun false if it is low. 1976c609719bSwdenk 1977b37c7e5eSwdenk eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0) 1978b37c7e5eSwdenk 1979c609719bSwdenk I2C_SDA(bit) 1980c609719bSwdenk 1981472d5460SYork Sun If <bit> is true, sets the I2C data line high. If it 1982472d5460SYork Sun is false, it clears it (low). 1983c609719bSwdenk 1984b37c7e5eSwdenk eg: #define I2C_SDA(bit) \ 1985b37c7e5eSwdenk if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \ 1986b37c7e5eSwdenk else immr->im_cpm.cp_pbdat &= ~PB_SDA 1987b37c7e5eSwdenk 1988c609719bSwdenk I2C_SCL(bit) 1989c609719bSwdenk 1990472d5460SYork Sun If <bit> is true, sets the I2C clock line high. If it 1991472d5460SYork Sun is false, it clears it (low). 1992c609719bSwdenk 1993b37c7e5eSwdenk eg: #define I2C_SCL(bit) \ 1994b37c7e5eSwdenk if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \ 1995b37c7e5eSwdenk else immr->im_cpm.cp_pbdat &= ~PB_SCL 1996b37c7e5eSwdenk 1997c609719bSwdenk I2C_DELAY 1998c609719bSwdenk 1999c609719bSwdenk This delay is invoked four times per clock cycle so this 2000c609719bSwdenk controls the rate of data transfer. The data rate thus 2001b37c7e5eSwdenk is 1 / (I2C_DELAY * 4). Often defined to be something 2002b37c7e5eSwdenk like: 2003b37c7e5eSwdenk 2004b37c7e5eSwdenk #define I2C_DELAY udelay(2) 2005c609719bSwdenk 2006793b5726SMike Frysinger CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA 2007793b5726SMike Frysinger 2008793b5726SMike Frysinger If your arch supports the generic GPIO framework (asm/gpio.h), 2009793b5726SMike Frysinger then you may alternatively define the two GPIOs that are to be 2010793b5726SMike Frysinger used as SCL / SDA. Any of the previous I2C_xxx macros will 2011793b5726SMike Frysinger have GPIO-based defaults assigned to them as appropriate. 2012793b5726SMike Frysinger 2013793b5726SMike Frysinger You should define these to the GPIO value as given directly to 2014793b5726SMike Frysinger the generic GPIO functions. 2015793b5726SMike Frysinger 20166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_INIT_BOARD 201747cd00faSwdenk 201847cd00faSwdenk When a board is reset during an i2c bus transfer 201947cd00faSwdenk chips might think that the current transfer is still 202047cd00faSwdenk in progress. On some boards it is possible to access 202147cd00faSwdenk the i2c SCLK line directly, either by using the 202247cd00faSwdenk processor pin as a GPIO or by having a second pin 202347cd00faSwdenk connected to the bus. If this option is defined a 202447cd00faSwdenk custom i2c_init_board() routine in boards/xxx/board.c 202547cd00faSwdenk is run early in the boot sequence. 202647cd00faSwdenk 202726a33504SRichard Retanubun CONFIG_SYS_I2C_BOARD_LATE_INIT 202826a33504SRichard Retanubun 202926a33504SRichard Retanubun An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is 203026a33504SRichard Retanubun defined a custom i2c_board_late_init() routine in 203126a33504SRichard Retanubun boards/xxx/board.c is run AFTER the operations in i2c_init() 203226a33504SRichard Retanubun is completed. This callpoint can be used to unreset i2c bus 203326a33504SRichard Retanubun using CPU i2c controller register accesses for CPUs whose i2c 203426a33504SRichard Retanubun controller provide such a method. It is called at the end of 203526a33504SRichard Retanubun i2c_init() to allow i2c_init operations to setup the i2c bus 203626a33504SRichard Retanubun controller on the CPU (e.g. setting bus speed & slave address). 203726a33504SRichard Retanubun 203817ea1177Swdenk CONFIG_I2CFAST (PPC405GP|PPC405EP only) 203917ea1177Swdenk 204017ea1177Swdenk This option enables configuration of bi_iic_fast[] flags 204117ea1177Swdenk in u-boot bd_info structure based on u-boot environment 204217ea1177Swdenk variable "i2cfast". (see also i2cfast) 204317ea1177Swdenk 2044bb99ad6dSBen Warren CONFIG_I2C_MULTI_BUS 2045bb99ad6dSBen Warren 2046bb99ad6dSBen Warren This option allows the use of multiple I2C buses, each of which 2047bb99ad6dSBen Warren must have a controller. At any point in time, only one bus is 2048bb99ad6dSBen Warren active. To switch to a different bus, use the 'i2c dev' command. 2049bb99ad6dSBen Warren Note that bus numbering is zero-based. 2050bb99ad6dSBen Warren 20516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_NOPROBES 2052bb99ad6dSBen Warren 2053bb99ad6dSBen Warren This option specifies a list of I2C devices that will be skipped 20540f89c54bSPeter Tyser when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS 20550f89c54bSPeter Tyser is set, specify a list of bus-device pairs. Otherwise, specify 20560f89c54bSPeter Tyser a 1D array of device addresses 2057bb99ad6dSBen Warren 2058bb99ad6dSBen Warren e.g. 2059bb99ad6dSBen Warren #undef CONFIG_I2C_MULTI_BUS 20606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68} 2061bb99ad6dSBen Warren 2062bb99ad6dSBen Warren will skip addresses 0x50 and 0x68 on a board with one I2C bus 2063bb99ad6dSBen Warren 2064bb99ad6dSBen Warren #define CONFIG_I2C_MULTI_BUS 20656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}} 2066bb99ad6dSBen Warren 2067bb99ad6dSBen Warren will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1 2068bb99ad6dSBen Warren 20696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SPD_BUS_NUM 2070be5e6181STimur Tabi 2071be5e6181STimur Tabi If defined, then this indicates the I2C bus number for DDR SPD. 2072be5e6181STimur Tabi If not defined, then U-Boot assumes that SPD is on I2C bus 0. 2073be5e6181STimur Tabi 20746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_RTC_BUS_NUM 20750dc018ecSStefan Roese 20760dc018ecSStefan Roese If defined, then this indicates the I2C bus number for the RTC. 20770dc018ecSStefan Roese If not defined, then U-Boot assumes that RTC is on I2C bus 0. 20780dc018ecSStefan Roese 20796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_DTT_BUS_NUM 20800dc018ecSStefan Roese 20810dc018ecSStefan Roese If defined, then this indicates the I2C bus number for the DTT. 20820dc018ecSStefan Roese If not defined, then U-Boot assumes that DTT is on I2C bus 0. 20830dc018ecSStefan Roese 20846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_DTT_ADDR: 20859ebbb54fSVictor Gallardo 20869ebbb54fSVictor Gallardo If defined, specifies the I2C address of the DTT device. 20879ebbb54fSVictor Gallardo If not defined, then U-Boot uses predefined value for 20889ebbb54fSVictor Gallardo specified DTT device. 20899ebbb54fSVictor Gallardo 2090be5e6181STimur Tabi CONFIG_FSL_I2C 2091be5e6181STimur Tabi 2092be5e6181STimur Tabi Define this option if you want to use Freescale's I2C driver in 20937817cb20SMarcel Ziswiler drivers/i2c/fsl_i2c.c. 2094be5e6181STimur Tabi 209567b23a32SHeiko Schocher CONFIG_I2C_MUX 209667b23a32SHeiko Schocher 209767b23a32SHeiko Schocher Define this option if you have I2C devices reached over 1 .. n 209867b23a32SHeiko Schocher I2C Muxes like the pca9544a. This option addes a new I2C 209967b23a32SHeiko Schocher Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a 210067b23a32SHeiko Schocher new I2C Bus to the existing I2C Busses. If you select the 210167b23a32SHeiko Schocher new Bus with "i2c dev", u-bbot sends first the commandos for 210267b23a32SHeiko Schocher the muxes to activate this new "bus". 210367b23a32SHeiko Schocher 210467b23a32SHeiko Schocher CONFIG_I2C_MULTI_BUS must be also defined, to use this 210567b23a32SHeiko Schocher feature! 210667b23a32SHeiko Schocher 210767b23a32SHeiko Schocher Example: 210867b23a32SHeiko Schocher Adding a new I2C Bus reached over 2 pca9544a muxes 210967b23a32SHeiko Schocher The First mux with address 70 and channel 6 211067b23a32SHeiko Schocher The Second mux with address 71 and channel 4 211167b23a32SHeiko Schocher 211267b23a32SHeiko Schocher => i2c bus pca9544a:70:6:pca9544a:71:4 211367b23a32SHeiko Schocher 211467b23a32SHeiko Schocher Use the "i2c bus" command without parameter, to get a list 211567b23a32SHeiko Schocher of I2C Busses with muxes: 211667b23a32SHeiko Schocher 211767b23a32SHeiko Schocher => i2c bus 211867b23a32SHeiko Schocher Busses reached over muxes: 211967b23a32SHeiko Schocher Bus ID: 2 212067b23a32SHeiko Schocher reached over Mux(es): 212167b23a32SHeiko Schocher pca9544a@70 ch: 4 212267b23a32SHeiko Schocher Bus ID: 3 212367b23a32SHeiko Schocher reached over Mux(es): 212467b23a32SHeiko Schocher pca9544a@70 ch: 6 212567b23a32SHeiko Schocher pca9544a@71 ch: 4 212667b23a32SHeiko Schocher => 212767b23a32SHeiko Schocher 212867b23a32SHeiko Schocher If you now switch to the new I2C Bus 3 with "i2c dev 3" 2129f9a78b8dSMichael Jones u-boot first sends the command to the mux@70 to enable 2130f9a78b8dSMichael Jones channel 6, and then the command to the mux@71 to enable 213167b23a32SHeiko Schocher the channel 4. 213267b23a32SHeiko Schocher 213367b23a32SHeiko Schocher After that, you can use the "normal" i2c commands as 2134f9a78b8dSMichael Jones usual to communicate with your I2C devices behind 213567b23a32SHeiko Schocher the 2 muxes. 213667b23a32SHeiko Schocher 213767b23a32SHeiko Schocher This option is actually implemented for the bitbanging 213867b23a32SHeiko Schocher algorithm in common/soft_i2c.c and for the Hardware I2C 213967b23a32SHeiko Schocher Bus on the MPC8260. But it should be not so difficult 214067b23a32SHeiko Schocher to add this option to other architectures. 214167b23a32SHeiko Schocher 21422ac6985aSAndrew Dyer CONFIG_SOFT_I2C_READ_REPEATED_START 21432ac6985aSAndrew Dyer 21442ac6985aSAndrew Dyer defining this will force the i2c_read() function in 21452ac6985aSAndrew Dyer the soft_i2c driver to perform an I2C repeated start 21462ac6985aSAndrew Dyer between writing the address pointer and reading the 21472ac6985aSAndrew Dyer data. If this define is omitted the default behaviour 21482ac6985aSAndrew Dyer of doing a stop-start sequence will be used. Most I2C 21492ac6985aSAndrew Dyer devices can use either method, but some require one or 21502ac6985aSAndrew Dyer the other. 2151be5e6181STimur Tabi 2152c609719bSwdenk- SPI Support: CONFIG_SPI 2153c609719bSwdenk 2154c609719bSwdenk Enables SPI driver (so far only tested with 2155c609719bSwdenk SPI EEPROM, also an instance works with Crystal A/D and 2156c609719bSwdenk D/As on the SACSng board) 2157c609719bSwdenk 21586639562eSYoshihiro Shimoda CONFIG_SH_SPI 21596639562eSYoshihiro Shimoda 21606639562eSYoshihiro Shimoda Enables the driver for SPI controller on SuperH. Currently 21616639562eSYoshihiro Shimoda only SH7757 is supported. 21626639562eSYoshihiro Shimoda 2163c609719bSwdenk CONFIG_SPI_X 2164c609719bSwdenk 2165c609719bSwdenk Enables extended (16-bit) SPI EEPROM addressing. 2166c609719bSwdenk (symmetrical to CONFIG_I2C_X) 2167c609719bSwdenk 2168c609719bSwdenk CONFIG_SOFT_SPI 2169c609719bSwdenk 2170c609719bSwdenk Enables a software (bit-bang) SPI driver rather than 2171c609719bSwdenk using hardware support. This is a general purpose 2172c609719bSwdenk driver that only requires three general I/O port pins 2173c609719bSwdenk (two outputs, one input) to function. If this is 2174c609719bSwdenk defined, the board configuration must define several 2175c609719bSwdenk SPI configuration items (port pins to use, etc). For 2176c609719bSwdenk an example, see include/configs/sacsng.h. 2177c609719bSwdenk 217804a9e118SBen Warren CONFIG_HARD_SPI 217904a9e118SBen Warren 218004a9e118SBen Warren Enables a hardware SPI driver for general-purpose reads 218104a9e118SBen Warren and writes. As with CONFIG_SOFT_SPI, the board configuration 218204a9e118SBen Warren must define a list of chip-select function pointers. 218304a9e118SBen Warren Currently supported on some MPC8xxx processors. For an 218404a9e118SBen Warren example, see include/configs/mpc8349emds.h. 218504a9e118SBen Warren 218638254f45SGuennadi Liakhovetski CONFIG_MXC_SPI 218738254f45SGuennadi Liakhovetski 218838254f45SGuennadi Liakhovetski Enables the driver for the SPI controllers on i.MX and MXC 21892e3cd1cdSFabio Estevam SoCs. Currently i.MX31/35/51 are supported. 219038254f45SGuennadi Liakhovetski 21910133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA 21920133502eSMatthias Fuchs 21930133502eSMatthias Fuchs Enables FPGA subsystem. 21940133502eSMatthias Fuchs 21950133502eSMatthias Fuchs CONFIG_FPGA_<vendor> 21960133502eSMatthias Fuchs 21970133502eSMatthias Fuchs Enables support for specific chip vendors. 21980133502eSMatthias Fuchs (ALTERA, XILINX) 21990133502eSMatthias Fuchs 22000133502eSMatthias Fuchs CONFIG_FPGA_<family> 22010133502eSMatthias Fuchs 22020133502eSMatthias Fuchs Enables support for FPGA family. 22030133502eSMatthias Fuchs (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX) 22040133502eSMatthias Fuchs 22050133502eSMatthias Fuchs CONFIG_FPGA_COUNT 2206c609719bSwdenk 2207c609719bSwdenk Specify the number of FPGA devices to support. 2208c609719bSwdenk 22096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_PROG_FEEDBACK 2210c609719bSwdenk 2211c609719bSwdenk Enable printing of hash marks during FPGA configuration. 2212c609719bSwdenk 22136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_BUSY 2214c609719bSwdenk 2215c609719bSwdenk Enable checks on FPGA configuration interface busy 2216c609719bSwdenk status by the configuration function. This option 2217c609719bSwdenk will require a board or device specific function to 2218c609719bSwdenk be written. 2219c609719bSwdenk 2220c609719bSwdenk CONFIG_FPGA_DELAY 2221c609719bSwdenk 2222c609719bSwdenk If defined, a function that provides delays in the FPGA 2223c609719bSwdenk configuration driver. 2224c609719bSwdenk 22256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_CTRLC 2226c609719bSwdenk Allow Control-C to interrupt FPGA configuration 2227c609719bSwdenk 22286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_ERROR 2229c609719bSwdenk 2230c609719bSwdenk Check for configuration errors during FPGA bitfile 2231c609719bSwdenk loading. For example, abort during Virtex II 2232c609719bSwdenk configuration if the INIT_B line goes low (which 2233c609719bSwdenk indicated a CRC error). 2234c609719bSwdenk 22356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_INIT 2236c609719bSwdenk 2237c609719bSwdenk Maximum time to wait for the INIT_B line to deassert 2238c609719bSwdenk after PROB_B has been deasserted during a Virtex II 2239c609719bSwdenk FPGA configuration sequence. The default time is 500 224011ccc33fSMarcel Ziswiler ms. 2241c609719bSwdenk 22426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_BUSY 2243c609719bSwdenk 2244c609719bSwdenk Maximum time to wait for BUSY to deassert during 224511ccc33fSMarcel Ziswiler Virtex II FPGA configuration. The default is 5 ms. 2246c609719bSwdenk 22476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_CONFIG 2248c609719bSwdenk 2249c609719bSwdenk Time to wait after FPGA configuration. The default is 225011ccc33fSMarcel Ziswiler 200 ms. 2251c609719bSwdenk 2252c609719bSwdenk- Configuration Management: 2253c609719bSwdenk CONFIG_IDENT_STRING 2254c609719bSwdenk 2255c609719bSwdenk If defined, this string will be added to the U-Boot 2256c609719bSwdenk version information (U_BOOT_VERSION) 2257c609719bSwdenk 2258c609719bSwdenk- Vendor Parameter Protection: 2259c609719bSwdenk 2260c609719bSwdenk U-Boot considers the values of the environment 2261c609719bSwdenk variables "serial#" (Board Serial Number) and 22627152b1d0Swdenk "ethaddr" (Ethernet Address) to be parameters that 2263c609719bSwdenk are set once by the board vendor / manufacturer, and 2264c609719bSwdenk protects these variables from casual modification by 2265c609719bSwdenk the user. Once set, these variables are read-only, 2266c609719bSwdenk and write or delete attempts are rejected. You can 226711ccc33fSMarcel Ziswiler change this behaviour: 2268c609719bSwdenk 2269c609719bSwdenk If CONFIG_ENV_OVERWRITE is #defined in your config 2270c609719bSwdenk file, the write protection for vendor parameters is 227147cd00faSwdenk completely disabled. Anybody can change or delete 2272c609719bSwdenk these parameters. 2273c609719bSwdenk 2274c609719bSwdenk Alternatively, if you #define _both_ CONFIG_ETHADDR 2275c609719bSwdenk _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default 227611ccc33fSMarcel Ziswiler Ethernet address is installed in the environment, 2277c609719bSwdenk which can be changed exactly ONCE by the user. [The 2278c609719bSwdenk serial# is unaffected by this, i. e. it remains 2279c609719bSwdenk read-only.] 2280c609719bSwdenk 22812598090bSJoe Hershberger The same can be accomplished in a more flexible way 22822598090bSJoe Hershberger for any variable by configuring the type of access 22832598090bSJoe Hershberger to allow for those variables in the ".flags" variable 22842598090bSJoe Hershberger or define CONFIG_ENV_FLAGS_LIST_STATIC. 22852598090bSJoe Hershberger 2286c609719bSwdenk- Protected RAM: 2287c609719bSwdenk CONFIG_PRAM 2288c609719bSwdenk 2289c609719bSwdenk Define this variable to enable the reservation of 2290c609719bSwdenk "protected RAM", i. e. RAM which is not overwritten 2291c609719bSwdenk by U-Boot. Define CONFIG_PRAM to hold the number of 2292c609719bSwdenk kB you want to reserve for pRAM. You can overwrite 2293c609719bSwdenk this default value by defining an environment 2294c609719bSwdenk variable "pram" to the number of kB you want to 2295c609719bSwdenk reserve. Note that the board info structure will 2296c609719bSwdenk still show the full amount of RAM. If pRAM is 2297c609719bSwdenk reserved, a new environment variable "mem" will 2298c609719bSwdenk automatically be defined to hold the amount of 2299c609719bSwdenk remaining RAM in a form that can be passed as boot 2300c609719bSwdenk argument to Linux, for instance like that: 2301c609719bSwdenk 2302fe126d8bSWolfgang Denk setenv bootargs ... mem=\${mem} 2303c609719bSwdenk saveenv 2304c609719bSwdenk 2305c609719bSwdenk This way you can tell Linux not to use this memory, 2306c609719bSwdenk either, which results in a memory region that will 2307c609719bSwdenk not be affected by reboots. 2308c609719bSwdenk 2309c609719bSwdenk *WARNING* If your board configuration uses automatic 2310c609719bSwdenk detection of the RAM size, you must make sure that 2311c609719bSwdenk this memory test is non-destructive. So far, the 2312c609719bSwdenk following board configurations are known to be 2313c609719bSwdenk "pRAM-clean": 2314c609719bSwdenk 23151b0757ecSWolfgang Denk IVMS8, IVML24, SPD8xx, TQM8xxL, 23161b0757ecSWolfgang Denk HERMES, IP860, RPXlite, LWMON, 2317544d97e9SWolfgang Denk FLAGADM, TQM8260 2318c609719bSwdenk 231940fef049SGabe Black- Access to physical memory region (> 4GB) 232040fef049SGabe Black Some basic support is provided for operations on memory not 232140fef049SGabe Black normally accessible to U-Boot - e.g. some architectures 232240fef049SGabe Black support access to more than 4GB of memory on 32-bit 232340fef049SGabe Black machines using physical address extension or similar. 232440fef049SGabe Black Define CONFIG_PHYSMEM to access this basic support, which 232540fef049SGabe Black currently only supports clearing the memory. 232640fef049SGabe Black 2327c609719bSwdenk- Error Recovery: 2328c609719bSwdenk CONFIG_PANIC_HANG 2329c609719bSwdenk 2330c609719bSwdenk Define this variable to stop the system in case of a 2331c609719bSwdenk fatal error, so that you have to reset it manually. 2332c609719bSwdenk This is probably NOT a good idea for an embedded 233311ccc33fSMarcel Ziswiler system where you want the system to reboot 2334c609719bSwdenk automatically as fast as possible, but it may be 2335c609719bSwdenk useful during development since you can try to debug 2336c609719bSwdenk the conditions that lead to the situation. 2337c609719bSwdenk 2338c609719bSwdenk CONFIG_NET_RETRY_COUNT 2339c609719bSwdenk 2340c609719bSwdenk This variable defines the number of retries for 2341c609719bSwdenk network operations like ARP, RARP, TFTP, or BOOTP 2342c609719bSwdenk before giving up the operation. If not defined, a 2343c609719bSwdenk default value of 5 is used. 2344c609719bSwdenk 234540cb90eeSGuennadi Liakhovetski CONFIG_ARP_TIMEOUT 234640cb90eeSGuennadi Liakhovetski 234740cb90eeSGuennadi Liakhovetski Timeout waiting for an ARP reply in milliseconds. 234840cb90eeSGuennadi Liakhovetski 234948a3e999STetsuyuki Kobayashi CONFIG_NFS_TIMEOUT 235048a3e999STetsuyuki Kobayashi 235148a3e999STetsuyuki Kobayashi Timeout in milliseconds used in NFS protocol. 235248a3e999STetsuyuki Kobayashi If you encounter "ERROR: Cannot umount" in nfs command, 235348a3e999STetsuyuki Kobayashi try longer timeout such as 235448a3e999STetsuyuki Kobayashi #define CONFIG_NFS_TIMEOUT 10000UL 235548a3e999STetsuyuki Kobayashi 2356c609719bSwdenk- Command Interpreter: 23578078f1a5SWolfgang Denk CONFIG_AUTO_COMPLETE 235804a85b3bSwdenk 235904a85b3bSwdenk Enable auto completion of commands using TAB. 236004a85b3bSwdenk 23618078f1a5SWolfgang Denk Note that this feature has NOT been implemented yet 23628078f1a5SWolfgang Denk for the "hush" shell. 23638078f1a5SWolfgang Denk 23648078f1a5SWolfgang Denk 23656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_HUSH_PARSER 2366c609719bSwdenk 2367c609719bSwdenk Define this variable to enable the "hush" shell (from 2368c609719bSwdenk Busybox) as command line interpreter, thus enabling 2369c609719bSwdenk powerful command line syntax like 2370c609719bSwdenk if...then...else...fi conditionals or `&&' and '||' 2371c609719bSwdenk constructs ("shell scripts"). 2372c609719bSwdenk 2373c609719bSwdenk If undefined, you get the old, much simpler behaviour 2374c609719bSwdenk with a somewhat smaller memory footprint. 2375c609719bSwdenk 2376c609719bSwdenk 23776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PROMPT_HUSH_PS2 2378c609719bSwdenk 2379c609719bSwdenk This defines the secondary prompt string, which is 2380c609719bSwdenk printed when the command interpreter needs more input 2381c609719bSwdenk to complete a command. Usually "> ". 2382c609719bSwdenk 2383c609719bSwdenk Note: 2384c609719bSwdenk 2385c609719bSwdenk In the current implementation, the local variables 2386c609719bSwdenk space and global environment variables space are 2387c609719bSwdenk separated. Local variables are those you define by 23883b57fe0aSwdenk simply typing `name=value'. To access a local 2389c609719bSwdenk variable later on, you have write `$name' or 23903b57fe0aSwdenk `${name}'; to execute the contents of a variable 23913b57fe0aSwdenk directly type `$name' at the command prompt. 2392c609719bSwdenk 2393c609719bSwdenk Global environment variables are those you use 2394c609719bSwdenk setenv/printenv to work with. To run a command stored 2395c609719bSwdenk in such a variable, you need to use the run command, 2396c609719bSwdenk and you must not use the '$' sign to access them. 2397c609719bSwdenk 2398c609719bSwdenk To store commands and special characters in a 2399c609719bSwdenk variable, please use double quotation marks 2400c609719bSwdenk surrounding the whole text of the variable, instead 2401c609719bSwdenk of the backslashes before semicolons and special 2402c609719bSwdenk symbols. 2403c609719bSwdenk 2404aa0c71acSWolfgang Denk- Commandline Editing and History: 2405aa0c71acSWolfgang Denk CONFIG_CMDLINE_EDITING 2406aa0c71acSWolfgang Denk 240711ccc33fSMarcel Ziswiler Enable editing and History functions for interactive 2408aa0c71acSWolfgang Denk commandline input operations 2409aa0c71acSWolfgang Denk 2410a8c7c708Swdenk- Default Environment: 2411c609719bSwdenk CONFIG_EXTRA_ENV_SETTINGS 2412c609719bSwdenk 2413c609719bSwdenk Define this to contain any number of null terminated 2414c609719bSwdenk strings (variable = value pairs) that will be part of 24157152b1d0Swdenk the default environment compiled into the boot image. 24162262cfeeSwdenk 2417c609719bSwdenk For example, place something like this in your 2418c609719bSwdenk board's config file: 2419c609719bSwdenk 2420c609719bSwdenk #define CONFIG_EXTRA_ENV_SETTINGS \ 2421c609719bSwdenk "myvar1=value1\0" \ 2422c609719bSwdenk "myvar2=value2\0" 2423c609719bSwdenk 2424c609719bSwdenk Warning: This method is based on knowledge about the 2425c609719bSwdenk internal format how the environment is stored by the 24262262cfeeSwdenk U-Boot code. This is NOT an official, exported 2427c609719bSwdenk interface! Although it is unlikely that this format 24287152b1d0Swdenk will change soon, there is no guarantee either. 2429c609719bSwdenk You better know what you are doing here. 2430c609719bSwdenk 2431c609719bSwdenk Note: overly (ab)use of the default environment is 2432c609719bSwdenk discouraged. Make sure to check other ways to preset 243374de7aefSWolfgang Denk the environment like the "source" command or the 2434c609719bSwdenk boot command first. 2435c609719bSwdenk 24365e724ca2SStephen Warren CONFIG_ENV_VARS_UBOOT_CONFIG 24375e724ca2SStephen Warren 24385e724ca2SStephen Warren Define this in order to add variables describing the 24395e724ca2SStephen Warren U-Boot build configuration to the default environment. 24405e724ca2SStephen Warren These will be named arch, cpu, board, vendor, and soc. 24415e724ca2SStephen Warren 24425e724ca2SStephen Warren Enabling this option will cause the following to be defined: 24435e724ca2SStephen Warren 24445e724ca2SStephen Warren - CONFIG_SYS_ARCH 24455e724ca2SStephen Warren - CONFIG_SYS_CPU 24465e724ca2SStephen Warren - CONFIG_SYS_BOARD 24475e724ca2SStephen Warren - CONFIG_SYS_VENDOR 24485e724ca2SStephen Warren - CONFIG_SYS_SOC 24495e724ca2SStephen Warren 24507e27f89fSTom Rini CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG 24517e27f89fSTom Rini 24527e27f89fSTom Rini Define this in order to add variables describing certain 24537e27f89fSTom Rini run-time determined information about the hardware to the 24547e27f89fSTom Rini environment. These will be named board_name, board_rev. 24557e27f89fSTom Rini 245606fd8538SSimon Glass CONFIG_DELAY_ENVIRONMENT 245706fd8538SSimon Glass 245806fd8538SSimon Glass Normally the environment is loaded when the board is 245906fd8538SSimon Glass intialised so that it is available to U-Boot. This inhibits 246006fd8538SSimon Glass that so that the environment is not available until 246106fd8538SSimon Glass explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL 246206fd8538SSimon Glass this is instead controlled by the value of 246306fd8538SSimon Glass /config/load-environment. 246406fd8538SSimon Glass 2465a8c7c708Swdenk- DataFlash Support: 24662abbe075Swdenk CONFIG_HAS_DATAFLASH 24672abbe075Swdenk 24682abbe075Swdenk Defining this option enables DataFlash features and 24692abbe075Swdenk allows to read/write in Dataflash via the standard 24702abbe075Swdenk commands cp, md... 24712abbe075Swdenk 2472f61ec45eSEric Nelson- Serial Flash support 2473f61ec45eSEric Nelson CONFIG_CMD_SF 2474f61ec45eSEric Nelson 2475f61ec45eSEric Nelson Defining this option enables SPI flash commands 2476f61ec45eSEric Nelson 'sf probe/read/write/erase/update'. 2477f61ec45eSEric Nelson 2478f61ec45eSEric Nelson Usage requires an initial 'probe' to define the serial 2479f61ec45eSEric Nelson flash parameters, followed by read/write/erase/update 2480f61ec45eSEric Nelson commands. 2481f61ec45eSEric Nelson 2482f61ec45eSEric Nelson The following defaults may be provided by the platform 2483f61ec45eSEric Nelson to handle the common case when only a single serial 2484f61ec45eSEric Nelson flash is present on the system. 2485f61ec45eSEric Nelson 2486f61ec45eSEric Nelson CONFIG_SF_DEFAULT_BUS Bus identifier 2487f61ec45eSEric Nelson CONFIG_SF_DEFAULT_CS Chip-select 2488f61ec45eSEric Nelson CONFIG_SF_DEFAULT_MODE (see include/spi.h) 2489f61ec45eSEric Nelson CONFIG_SF_DEFAULT_SPEED in Hz 2490f61ec45eSEric Nelson 249124007273SSimon Glass CONFIG_CMD_SF_TEST 249224007273SSimon Glass 249324007273SSimon Glass Define this option to include a destructive SPI flash 249424007273SSimon Glass test ('sf test'). 249524007273SSimon Glass 24963f85ce27Swdenk- SystemACE Support: 24973f85ce27Swdenk CONFIG_SYSTEMACE 24983f85ce27Swdenk 24993f85ce27Swdenk Adding this option adds support for Xilinx SystemACE 25003f85ce27Swdenk chips attached via some sort of local bus. The address 250111ccc33fSMarcel Ziswiler of the chip must also be defined in the 25026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SYSTEMACE_BASE macro. For example: 25033f85ce27Swdenk 25043f85ce27Swdenk #define CONFIG_SYSTEMACE 25056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000 25063f85ce27Swdenk 25073f85ce27Swdenk When SystemACE support is added, the "ace" device type 25083f85ce27Swdenk becomes available to the fat commands, i.e. fatls. 25093f85ce27Swdenk 2510ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port: 2511ecb0ccd9SWolfgang Denk CONFIG_TFTP_PORT 2512ecb0ccd9SWolfgang Denk 251328cb9375SWolfgang Denk If this is defined, the environment variable tftpsrcp 2514ecb0ccd9SWolfgang Denk is used to supply the TFTP UDP source port value. 251528cb9375SWolfgang Denk If tftpsrcp isn't defined, the normal pseudo-random port 2516ecb0ccd9SWolfgang Denk number generator is used. 2517ecb0ccd9SWolfgang Denk 251828cb9375SWolfgang Denk Also, the environment variable tftpdstp is used to supply 251928cb9375SWolfgang Denk the TFTP UDP destination port value. If tftpdstp isn't 252028cb9375SWolfgang Denk defined, the normal port 69 is used. 252128cb9375SWolfgang Denk 252228cb9375SWolfgang Denk The purpose for tftpsrcp is to allow a TFTP server to 2523ecb0ccd9SWolfgang Denk blindly start the TFTP transfer using the pre-configured 2524ecb0ccd9SWolfgang Denk target IP address and UDP port. This has the effect of 2525ecb0ccd9SWolfgang Denk "punching through" the (Windows XP) firewall, allowing 2526ecb0ccd9SWolfgang Denk the remainder of the TFTP transfer to proceed normally. 2527ecb0ccd9SWolfgang Denk A better solution is to properly configure the firewall, 2528ecb0ccd9SWolfgang Denk but sometimes that is not allowed. 2529ecb0ccd9SWolfgang Denk 2530bf36c5d5SSimon Glass- Hashing support: 2531bf36c5d5SSimon Glass CONFIG_CMD_HASH 2532bf36c5d5SSimon Glass 2533bf36c5d5SSimon Glass This enables a generic 'hash' command which can produce 2534bf36c5d5SSimon Glass hashes / digests from a few algorithms (e.g. SHA1, SHA256). 2535bf36c5d5SSimon Glass 2536bf36c5d5SSimon Glass CONFIG_HASH_VERIFY 2537bf36c5d5SSimon Glass 2538bf36c5d5SSimon Glass Enable the hash verify command (hash -v). This adds to code 2539bf36c5d5SSimon Glass size a little. 2540bf36c5d5SSimon Glass 2541bf36c5d5SSimon Glass CONFIG_SHA1 - support SHA1 hashing 2542bf36c5d5SSimon Glass CONFIG_SHA256 - support SHA256 hashing 2543bf36c5d5SSimon Glass 2544bf36c5d5SSimon Glass Note: There is also a sha1sum command, which should perhaps 2545bf36c5d5SSimon Glass be deprecated in favour of 'hash sha1'. 2546bf36c5d5SSimon Glass 2547a8c7c708Swdenk- Show boot progress: 2548c609719bSwdenk CONFIG_SHOW_BOOT_PROGRESS 2549c609719bSwdenk 2550c609719bSwdenk Defining this option allows to add some board- 2551c609719bSwdenk specific code (calling a user-provided function 2552c609719bSwdenk "show_boot_progress(int)") that enables you to show 2553c609719bSwdenk the system's boot progress on some display (for 2554c609719bSwdenk example, some LED's) on your board. At the moment, 2555c609719bSwdenk the following checkpoints are implemented: 2556c609719bSwdenk 25573a608ca0SSimon Glass- Detailed boot stage timing 25583a608ca0SSimon Glass CONFIG_BOOTSTAGE 25593a608ca0SSimon Glass Define this option to get detailed timing of each stage 25603a608ca0SSimon Glass of the boot process. 25613a608ca0SSimon Glass 25623a608ca0SSimon Glass CONFIG_BOOTSTAGE_USER_COUNT 25633a608ca0SSimon Glass This is the number of available user bootstage records. 25643a608ca0SSimon Glass Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...) 25653a608ca0SSimon Glass a new ID will be allocated from this stash. If you exceed 25663a608ca0SSimon Glass the limit, recording will stop. 25673a608ca0SSimon Glass 25683a608ca0SSimon Glass CONFIG_BOOTSTAGE_REPORT 25693a608ca0SSimon Glass Define this to print a report before boot, similar to this: 25703a608ca0SSimon Glass 25713a608ca0SSimon Glass Timer summary in microseconds: 25723a608ca0SSimon Glass Mark Elapsed Stage 25733a608ca0SSimon Glass 0 0 reset 25743a608ca0SSimon Glass 3,575,678 3,575,678 board_init_f start 25753a608ca0SSimon Glass 3,575,695 17 arch_cpu_init A9 25763a608ca0SSimon Glass 3,575,777 82 arch_cpu_init done 25773a608ca0SSimon Glass 3,659,598 83,821 board_init_r start 25783a608ca0SSimon Glass 3,910,375 250,777 main_loop 25793a608ca0SSimon Glass 29,916,167 26,005,792 bootm_start 25803a608ca0SSimon Glass 30,361,327 445,160 start_kernel 25813a608ca0SSimon Glass 25822eba38cfSSimon Glass CONFIG_CMD_BOOTSTAGE 25832eba38cfSSimon Glass Add a 'bootstage' command which supports printing a report 25842eba38cfSSimon Glass and un/stashing of bootstage data. 25852eba38cfSSimon Glass 258694fd1316SSimon Glass CONFIG_BOOTSTAGE_FDT 258794fd1316SSimon Glass Stash the bootstage information in the FDT. A root 'bootstage' 258894fd1316SSimon Glass node is created with each bootstage id as a child. Each child 258994fd1316SSimon Glass has a 'name' property and either 'mark' containing the 259094fd1316SSimon Glass mark time in microsecond, or 'accum' containing the 259194fd1316SSimon Glass accumulated time for that bootstage id in microseconds. 259294fd1316SSimon Glass For example: 259394fd1316SSimon Glass 259494fd1316SSimon Glass bootstage { 259594fd1316SSimon Glass 154 { 259694fd1316SSimon Glass name = "board_init_f"; 259794fd1316SSimon Glass mark = <3575678>; 259894fd1316SSimon Glass }; 259994fd1316SSimon Glass 170 { 260094fd1316SSimon Glass name = "lcd"; 260194fd1316SSimon Glass accum = <33482>; 260294fd1316SSimon Glass }; 260394fd1316SSimon Glass }; 260494fd1316SSimon Glass 260594fd1316SSimon Glass Code in the Linux kernel can find this in /proc/devicetree. 260694fd1316SSimon Glass 26071372cce2SMarian BalakowiczLegacy uImage format: 26081372cce2SMarian Balakowicz 2609c609719bSwdenk Arg Where When 2610c609719bSwdenk 1 common/cmd_bootm.c before attempting to boot an image 2611c609719bSwdenk -1 common/cmd_bootm.c Image header has bad magic number 2612c609719bSwdenk 2 common/cmd_bootm.c Image header has correct magic number 2613c609719bSwdenk -2 common/cmd_bootm.c Image header has bad checksum 2614c609719bSwdenk 3 common/cmd_bootm.c Image header has correct checksum 2615c609719bSwdenk -3 common/cmd_bootm.c Image data has bad checksum 2616c609719bSwdenk 4 common/cmd_bootm.c Image data has correct checksum 2617c609719bSwdenk -4 common/cmd_bootm.c Image is for unsupported architecture 2618c609719bSwdenk 5 common/cmd_bootm.c Architecture check OK 26191372cce2SMarian Balakowicz -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi) 2620c609719bSwdenk 6 common/cmd_bootm.c Image Type check OK 2621c609719bSwdenk -6 common/cmd_bootm.c gunzip uncompression error 2622c609719bSwdenk -7 common/cmd_bootm.c Unimplemented compression type 2623c609719bSwdenk 7 common/cmd_bootm.c Uncompression OK 26241372cce2SMarian Balakowicz 8 common/cmd_bootm.c No uncompress/copy overwrite error 2625c609719bSwdenk -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX) 26261372cce2SMarian Balakowicz 26271372cce2SMarian Balakowicz 9 common/image.c Start initial ramdisk verification 26281372cce2SMarian Balakowicz -10 common/image.c Ramdisk header has bad magic number 26291372cce2SMarian Balakowicz -11 common/image.c Ramdisk header has bad checksum 26301372cce2SMarian Balakowicz 10 common/image.c Ramdisk header is OK 26311372cce2SMarian Balakowicz -12 common/image.c Ramdisk data has bad checksum 26321372cce2SMarian Balakowicz 11 common/image.c Ramdisk data has correct checksum 26331372cce2SMarian Balakowicz 12 common/image.c Ramdisk verification complete, start loading 263411ccc33fSMarcel Ziswiler -13 common/image.c Wrong Image Type (not PPC Linux ramdisk) 26351372cce2SMarian Balakowicz 13 common/image.c Start multifile image verification 26361372cce2SMarian Balakowicz 14 common/image.c No initial ramdisk, no multifile, continue. 26371372cce2SMarian Balakowicz 2638ea0364f1SPeter Tyser 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS 2639c609719bSwdenk 2640a47a12beSStefan Roese -30 arch/powerpc/lib/board.c Fatal error, hang the system 264163e73c9aSwdenk -31 post/post.c POST test failed, detected by post_output_backlog() 264263e73c9aSwdenk -32 post/post.c POST test failed, detected by post_run_single() 264363e73c9aSwdenk 2644566a494fSHeiko Schocher 34 common/cmd_doc.c before loading a Image from a DOC device 2645566a494fSHeiko Schocher -35 common/cmd_doc.c Bad usage of "doc" command 2646566a494fSHeiko Schocher 35 common/cmd_doc.c correct usage of "doc" command 2647566a494fSHeiko Schocher -36 common/cmd_doc.c No boot device 2648566a494fSHeiko Schocher 36 common/cmd_doc.c correct boot device 2649566a494fSHeiko Schocher -37 common/cmd_doc.c Unknown Chip ID on boot device 2650566a494fSHeiko Schocher 37 common/cmd_doc.c correct chip ID found, device available 2651566a494fSHeiko Schocher -38 common/cmd_doc.c Read Error on boot device 2652566a494fSHeiko Schocher 38 common/cmd_doc.c reading Image header from DOC device OK 2653566a494fSHeiko Schocher -39 common/cmd_doc.c Image header has bad magic number 2654566a494fSHeiko Schocher 39 common/cmd_doc.c Image header has correct magic number 2655566a494fSHeiko Schocher -40 common/cmd_doc.c Error reading Image from DOC device 2656566a494fSHeiko Schocher 40 common/cmd_doc.c Image header has correct magic number 2657566a494fSHeiko Schocher 41 common/cmd_ide.c before loading a Image from a IDE device 2658566a494fSHeiko Schocher -42 common/cmd_ide.c Bad usage of "ide" command 2659566a494fSHeiko Schocher 42 common/cmd_ide.c correct usage of "ide" command 2660566a494fSHeiko Schocher -43 common/cmd_ide.c No boot device 2661566a494fSHeiko Schocher 43 common/cmd_ide.c boot device found 2662566a494fSHeiko Schocher -44 common/cmd_ide.c Device not available 2663566a494fSHeiko Schocher 44 common/cmd_ide.c Device available 2664566a494fSHeiko Schocher -45 common/cmd_ide.c wrong partition selected 2665566a494fSHeiko Schocher 45 common/cmd_ide.c partition selected 2666566a494fSHeiko Schocher -46 common/cmd_ide.c Unknown partition table 2667566a494fSHeiko Schocher 46 common/cmd_ide.c valid partition table found 2668566a494fSHeiko Schocher -47 common/cmd_ide.c Invalid partition type 2669566a494fSHeiko Schocher 47 common/cmd_ide.c correct partition type 2670566a494fSHeiko Schocher -48 common/cmd_ide.c Error reading Image Header on boot device 2671566a494fSHeiko Schocher 48 common/cmd_ide.c reading Image Header from IDE device OK 2672566a494fSHeiko Schocher -49 common/cmd_ide.c Image header has bad magic number 2673566a494fSHeiko Schocher 49 common/cmd_ide.c Image header has correct magic number 2674566a494fSHeiko Schocher -50 common/cmd_ide.c Image header has bad checksum 2675566a494fSHeiko Schocher 50 common/cmd_ide.c Image header has correct checksum 2676566a494fSHeiko Schocher -51 common/cmd_ide.c Error reading Image from IDE device 2677566a494fSHeiko Schocher 51 common/cmd_ide.c reading Image from IDE device OK 2678566a494fSHeiko Schocher 52 common/cmd_nand.c before loading a Image from a NAND device 2679566a494fSHeiko Schocher -53 common/cmd_nand.c Bad usage of "nand" command 2680566a494fSHeiko Schocher 53 common/cmd_nand.c correct usage of "nand" command 2681566a494fSHeiko Schocher -54 common/cmd_nand.c No boot device 2682566a494fSHeiko Schocher 54 common/cmd_nand.c boot device found 2683566a494fSHeiko Schocher -55 common/cmd_nand.c Unknown Chip ID on boot device 2684566a494fSHeiko Schocher 55 common/cmd_nand.c correct chip ID found, device available 2685566a494fSHeiko Schocher -56 common/cmd_nand.c Error reading Image Header on boot device 2686566a494fSHeiko Schocher 56 common/cmd_nand.c reading Image Header from NAND device OK 2687566a494fSHeiko Schocher -57 common/cmd_nand.c Image header has bad magic number 2688566a494fSHeiko Schocher 57 common/cmd_nand.c Image header has correct magic number 2689566a494fSHeiko Schocher -58 common/cmd_nand.c Error reading Image from NAND device 2690566a494fSHeiko Schocher 58 common/cmd_nand.c reading Image from NAND device OK 2691c609719bSwdenk 2692566a494fSHeiko Schocher -60 common/env_common.c Environment has a bad CRC, using default 2693c609719bSwdenk 2694566a494fSHeiko Schocher 64 net/eth.c starting with Ethernet configuration. 2695566a494fSHeiko Schocher -64 net/eth.c no Ethernet found. 2696566a494fSHeiko Schocher 65 net/eth.c Ethernet found. 2697206c60cbSwdenk 2698566a494fSHeiko Schocher -80 common/cmd_net.c usage wrong 2699566a494fSHeiko Schocher 80 common/cmd_net.c before calling NetLoop() 270011ccc33fSMarcel Ziswiler -81 common/cmd_net.c some error in NetLoop() occurred 2701566a494fSHeiko Schocher 81 common/cmd_net.c NetLoop() back without error 2702566a494fSHeiko Schocher -82 common/cmd_net.c size == 0 (File with size 0 loaded) 2703566a494fSHeiko Schocher 82 common/cmd_net.c trying automatic boot 270474de7aefSWolfgang Denk 83 common/cmd_net.c running "source" command 270574de7aefSWolfgang Denk -83 common/cmd_net.c some error in automatic boot or "source" command 2706566a494fSHeiko Schocher 84 common/cmd_net.c end without errors 2707c609719bSwdenk 27081372cce2SMarian BalakowiczFIT uImage format: 27091372cce2SMarian Balakowicz 27101372cce2SMarian Balakowicz Arg Where When 27111372cce2SMarian Balakowicz 100 common/cmd_bootm.c Kernel FIT Image has correct format 27121372cce2SMarian Balakowicz -100 common/cmd_bootm.c Kernel FIT Image has incorrect format 27131372cce2SMarian Balakowicz 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration 27141372cce2SMarian Balakowicz -101 common/cmd_bootm.c Can't get configuration for kernel subimage 27151372cce2SMarian Balakowicz 102 common/cmd_bootm.c Kernel unit name specified 27161372cce2SMarian Balakowicz -103 common/cmd_bootm.c Can't get kernel subimage node offset 2717f773bea8SMarian Balakowicz 103 common/cmd_bootm.c Found configuration node 27181372cce2SMarian Balakowicz 104 common/cmd_bootm.c Got kernel subimage node offset 27191372cce2SMarian Balakowicz -104 common/cmd_bootm.c Kernel subimage hash verification failed 27201372cce2SMarian Balakowicz 105 common/cmd_bootm.c Kernel subimage hash verification OK 27211372cce2SMarian Balakowicz -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture 27221372cce2SMarian Balakowicz 106 common/cmd_bootm.c Architecture check OK 272311ccc33fSMarcel Ziswiler -106 common/cmd_bootm.c Kernel subimage has wrong type 272411ccc33fSMarcel Ziswiler 107 common/cmd_bootm.c Kernel subimage type OK 27251372cce2SMarian Balakowicz -107 common/cmd_bootm.c Can't get kernel subimage data/size 27261372cce2SMarian Balakowicz 108 common/cmd_bootm.c Got kernel subimage data/size 27271372cce2SMarian Balakowicz -108 common/cmd_bootm.c Wrong image type (not legacy, FIT) 27281372cce2SMarian Balakowicz -109 common/cmd_bootm.c Can't get kernel subimage type 27291372cce2SMarian Balakowicz -110 common/cmd_bootm.c Can't get kernel subimage comp 27301372cce2SMarian Balakowicz -111 common/cmd_bootm.c Can't get kernel subimage os 27311372cce2SMarian Balakowicz -112 common/cmd_bootm.c Can't get kernel subimage load address 27321372cce2SMarian Balakowicz -113 common/cmd_bootm.c Image uncompress/copy overwrite error 27331372cce2SMarian Balakowicz 27341372cce2SMarian Balakowicz 120 common/image.c Start initial ramdisk verification 27351372cce2SMarian Balakowicz -120 common/image.c Ramdisk FIT image has incorrect format 27361372cce2SMarian Balakowicz 121 common/image.c Ramdisk FIT image has correct format 273711ccc33fSMarcel Ziswiler 122 common/image.c No ramdisk subimage unit name, using configuration 27381372cce2SMarian Balakowicz -122 common/image.c Can't get configuration for ramdisk subimage 27391372cce2SMarian Balakowicz 123 common/image.c Ramdisk unit name specified 27401372cce2SMarian Balakowicz -124 common/image.c Can't get ramdisk subimage node offset 27411372cce2SMarian Balakowicz 125 common/image.c Got ramdisk subimage node offset 27421372cce2SMarian Balakowicz -125 common/image.c Ramdisk subimage hash verification failed 27431372cce2SMarian Balakowicz 126 common/image.c Ramdisk subimage hash verification OK 27441372cce2SMarian Balakowicz -126 common/image.c Ramdisk subimage for unsupported architecture 27451372cce2SMarian Balakowicz 127 common/image.c Architecture check OK 27461372cce2SMarian Balakowicz -127 common/image.c Can't get ramdisk subimage data/size 27471372cce2SMarian Balakowicz 128 common/image.c Got ramdisk subimage data/size 27481372cce2SMarian Balakowicz 129 common/image.c Can't get ramdisk load address 27491372cce2SMarian Balakowicz -129 common/image.c Got ramdisk load address 27501372cce2SMarian Balakowicz 275111ccc33fSMarcel Ziswiler -130 common/cmd_doc.c Incorrect FIT image format 27521372cce2SMarian Balakowicz 131 common/cmd_doc.c FIT image format OK 27531372cce2SMarian Balakowicz 275411ccc33fSMarcel Ziswiler -140 common/cmd_ide.c Incorrect FIT image format 27551372cce2SMarian Balakowicz 141 common/cmd_ide.c FIT image format OK 27561372cce2SMarian Balakowicz 275711ccc33fSMarcel Ziswiler -150 common/cmd_nand.c Incorrect FIT image format 27581372cce2SMarian Balakowicz 151 common/cmd_nand.c FIT image format OK 27591372cce2SMarian Balakowicz 2760d95f6ec7SGabe Black- FIT image support: 2761d95f6ec7SGabe Black CONFIG_FIT 2762d95f6ec7SGabe Black Enable support for the FIT uImage format. 2763d95f6ec7SGabe Black 2764d95f6ec7SGabe Black CONFIG_FIT_BEST_MATCH 2765d95f6ec7SGabe Black When no configuration is explicitly selected, default to the 2766d95f6ec7SGabe Black one whose fdt's compatibility field best matches that of 2767d95f6ec7SGabe Black U-Boot itself. A match is considered "best" if it matches the 2768d95f6ec7SGabe Black most specific compatibility entry of U-Boot's fdt's root node. 2769d95f6ec7SGabe Black The order of entries in the configuration's fdt is ignored. 2770d95f6ec7SGabe Black 27714cf2609bSWolfgang Denk- Standalone program support: 27724cf2609bSWolfgang Denk CONFIG_STANDALONE_LOAD_ADDR 27734cf2609bSWolfgang Denk 27746feff899SWolfgang Denk This option defines a board specific value for the 27756feff899SWolfgang Denk address where standalone program gets loaded, thus 27766feff899SWolfgang Denk overwriting the architecture dependent default 27774cf2609bSWolfgang Denk settings. 27784cf2609bSWolfgang Denk 27794cf2609bSWolfgang Denk- Frame Buffer Address: 27804cf2609bSWolfgang Denk CONFIG_FB_ADDR 27814cf2609bSWolfgang Denk 27824cf2609bSWolfgang Denk Define CONFIG_FB_ADDR if you want to use specific 278344a53b57SWolfgang Denk address for frame buffer. This is typically the case 278444a53b57SWolfgang Denk when using a graphics controller has separate video 278544a53b57SWolfgang Denk memory. U-Boot will then place the frame buffer at 278644a53b57SWolfgang Denk the given address instead of dynamically reserving it 278744a53b57SWolfgang Denk in system RAM by calling lcd_setmem(), which grabs 278844a53b57SWolfgang Denk the memory for the frame buffer depending on the 278944a53b57SWolfgang Denk configured panel size. 27904cf2609bSWolfgang Denk 27914cf2609bSWolfgang Denk Please see board_init_f function. 27924cf2609bSWolfgang Denk 2793cccfc2abSDetlev Zundel- Automatic software updates via TFTP server 2794cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP 2795cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP_CNT_MAX 2796cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP_MSEC_MAX 2797cccfc2abSDetlev Zundel 2798cccfc2abSDetlev Zundel These options enable and control the auto-update feature; 2799cccfc2abSDetlev Zundel for a more detailed description refer to doc/README.update. 2800cccfc2abSDetlev Zundel 2801cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support) 2802cccfc2abSDetlev Zundel CONFIG_MTD_DEVICE 2803cccfc2abSDetlev Zundel 2804cccfc2abSDetlev Zundel Adds the MTD device infrastructure from the Linux kernel. 2805cccfc2abSDetlev Zundel Needed for mtdparts command support. 2806cccfc2abSDetlev Zundel 2807cccfc2abSDetlev Zundel CONFIG_MTD_PARTITIONS 2808cccfc2abSDetlev Zundel 2809cccfc2abSDetlev Zundel Adds the MTD partitioning infrastructure from the Linux 2810cccfc2abSDetlev Zundel kernel. Needed for UBI support. 2811cccfc2abSDetlev Zundel 281270c219cdSJoe Hershberger- UBI support 281370c219cdSJoe Hershberger CONFIG_CMD_UBI 281470c219cdSJoe Hershberger 281570c219cdSJoe Hershberger Adds commands for interacting with MTD partitions formatted 281670c219cdSJoe Hershberger with the UBI flash translation layer 281770c219cdSJoe Hershberger 281870c219cdSJoe Hershberger Requires also defining CONFIG_RBTREE 281970c219cdSJoe Hershberger 2820147162daSJoe Hershberger CONFIG_UBI_SILENCE_MSG 2821147162daSJoe Hershberger 2822147162daSJoe Hershberger Make the verbose messages from UBI stop printing. This leaves 2823147162daSJoe Hershberger warnings and errors enabled. 2824147162daSJoe Hershberger 282570c219cdSJoe Hershberger- UBIFS support 282670c219cdSJoe Hershberger CONFIG_CMD_UBIFS 282770c219cdSJoe Hershberger 282870c219cdSJoe Hershberger Adds commands for interacting with UBI volumes formatted as 282970c219cdSJoe Hershberger UBIFS. UBIFS is read-only in u-boot. 283070c219cdSJoe Hershberger 283170c219cdSJoe Hershberger Requires UBI support as well as CONFIG_LZO 283270c219cdSJoe Hershberger 2833147162daSJoe Hershberger CONFIG_UBIFS_SILENCE_MSG 2834147162daSJoe Hershberger 2835147162daSJoe Hershberger Make the verbose messages from UBIFS stop printing. This leaves 2836147162daSJoe Hershberger warnings and errors enabled. 2837147162daSJoe Hershberger 28386a11cf48SDaniel Schwierzeck- SPL framework 28396a11cf48SDaniel Schwierzeck CONFIG_SPL 28406a11cf48SDaniel Schwierzeck Enable building of SPL globally. 28416a11cf48SDaniel Schwierzeck 284295579793STom Rini CONFIG_SPL_LDSCRIPT 284395579793STom Rini LDSCRIPT for linking the SPL binary. 284495579793STom Rini 28456ebc3461SAlbert ARIBAUD CONFIG_SPL_MAX_FOOTPRINT 28466ebc3461SAlbert ARIBAUD Maximum size in memory allocated to the SPL, BSS included. 28476ebc3461SAlbert ARIBAUD When defined, the linker checks that the actual memory 28486ebc3461SAlbert ARIBAUD used by SPL from _start to __bss_end does not exceed it. 28498960af8bSAlbert ARIBAUD CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE 28506ebc3461SAlbert ARIBAUD must not be both defined at the same time. 28516ebc3461SAlbert ARIBAUD 285295579793STom Rini CONFIG_SPL_MAX_SIZE 28536ebc3461SAlbert ARIBAUD Maximum size of the SPL image (text, data, rodata, and 28546ebc3461SAlbert ARIBAUD linker lists sections), BSS excluded. 28556ebc3461SAlbert ARIBAUD When defined, the linker checks that the actual size does 28566ebc3461SAlbert ARIBAUD not exceed it. 285795579793STom Rini 28586a11cf48SDaniel Schwierzeck CONFIG_SPL_TEXT_BASE 28596a11cf48SDaniel Schwierzeck TEXT_BASE for linking the SPL binary. 28606a11cf48SDaniel Schwierzeck 286194a45bb1SScott Wood CONFIG_SPL_RELOC_TEXT_BASE 286294a45bb1SScott Wood Address to relocate to. If unspecified, this is equal to 286394a45bb1SScott Wood CONFIG_SPL_TEXT_BASE (i.e. no relocation is done). 286494a45bb1SScott Wood 286595579793STom Rini CONFIG_SPL_BSS_START_ADDR 286695579793STom Rini Link address for the BSS within the SPL binary. 286795579793STom Rini 286895579793STom Rini CONFIG_SPL_BSS_MAX_SIZE 28696ebc3461SAlbert ARIBAUD Maximum size in memory allocated to the SPL BSS. 28706ebc3461SAlbert ARIBAUD When defined, the linker checks that the actual memory used 28716ebc3461SAlbert ARIBAUD by SPL from __bss_start to __bss_end does not exceed it. 28728960af8bSAlbert ARIBAUD CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE 28736ebc3461SAlbert ARIBAUD must not be both defined at the same time. 287495579793STom Rini 287595579793STom Rini CONFIG_SPL_STACK 287695579793STom Rini Adress of the start of the stack SPL will use 287795579793STom Rini 287894a45bb1SScott Wood CONFIG_SPL_RELOC_STACK 287994a45bb1SScott Wood Adress of the start of the stack SPL will use after 288094a45bb1SScott Wood relocation. If unspecified, this is equal to 288194a45bb1SScott Wood CONFIG_SPL_STACK. 288294a45bb1SScott Wood 288395579793STom Rini CONFIG_SYS_SPL_MALLOC_START 288495579793STom Rini Starting address of the malloc pool used in SPL. 288595579793STom Rini 288695579793STom Rini CONFIG_SYS_SPL_MALLOC_SIZE 288795579793STom Rini The size of the malloc pool used in SPL. 28886a11cf48SDaniel Schwierzeck 288947f7bcaeSTom Rini CONFIG_SPL_FRAMEWORK 289047f7bcaeSTom Rini Enable the SPL framework under common/. This framework 289147f7bcaeSTom Rini supports MMC, NAND and YMODEM loading of U-Boot and NAND 289247f7bcaeSTom Rini NAND loading of the Linux Kernel. 289347f7bcaeSTom Rini 2894861a86f4STom Rini CONFIG_SPL_DISPLAY_PRINT 2895861a86f4STom Rini For ARM, enable an optional function to print more information 2896861a86f4STom Rini about the running system. 2897861a86f4STom Rini 28984b919725SScott Wood CONFIG_SPL_INIT_MINIMAL 28994b919725SScott Wood Arch init code should be built for a very small image 29004b919725SScott Wood 29016a11cf48SDaniel Schwierzeck CONFIG_SPL_LIBCOMMON_SUPPORT 29026a11cf48SDaniel Schwierzeck Support for common/libcommon.o in SPL binary 29036a11cf48SDaniel Schwierzeck 29046a11cf48SDaniel Schwierzeck CONFIG_SPL_LIBDISK_SUPPORT 29056a11cf48SDaniel Schwierzeck Support for disk/libdisk.o in SPL binary 29066a11cf48SDaniel Schwierzeck 29076a11cf48SDaniel Schwierzeck CONFIG_SPL_I2C_SUPPORT 29086a11cf48SDaniel Schwierzeck Support for drivers/i2c/libi2c.o in SPL binary 29096a11cf48SDaniel Schwierzeck 29106a11cf48SDaniel Schwierzeck CONFIG_SPL_GPIO_SUPPORT 29116a11cf48SDaniel Schwierzeck Support for drivers/gpio/libgpio.o in SPL binary 29126a11cf48SDaniel Schwierzeck 29136a11cf48SDaniel Schwierzeck CONFIG_SPL_MMC_SUPPORT 29146a11cf48SDaniel Schwierzeck Support for drivers/mmc/libmmc.o in SPL binary 29156a11cf48SDaniel Schwierzeck 291695579793STom Rini CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR, 291795579793STom Rini CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS, 291895579793STom Rini CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION 291995579793STom Rini Address, size and partition on the MMC to load U-Boot from 292095579793STom Rini when the MMC is being used in raw mode. 292195579793STom Rini 292295579793STom Rini CONFIG_SPL_FAT_SUPPORT 292395579793STom Rini Support for fs/fat/libfat.o in SPL binary 292495579793STom Rini 292595579793STom Rini CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME 292695579793STom Rini Filename to read to load U-Boot when reading from FAT 292795579793STom Rini 292806f60ae3SScott Wood CONFIG_SPL_MPC83XX_WAIT_FOR_NAND 292906f60ae3SScott Wood Set this for NAND SPL on PPC mpc83xx targets, so that 293006f60ae3SScott Wood start.S waits for the rest of the SPL to load before 293106f60ae3SScott Wood continuing (the hardware starts execution after just 293206f60ae3SScott Wood loading the first page rather than the full 4K). 293306f60ae3SScott Wood 29346f2f01b9SScott Wood CONFIG_SPL_NAND_BASE 29356f2f01b9SScott Wood Include nand_base.c in the SPL. Requires 29366f2f01b9SScott Wood CONFIG_SPL_NAND_DRIVERS. 29376f2f01b9SScott Wood 29386f2f01b9SScott Wood CONFIG_SPL_NAND_DRIVERS 29396f2f01b9SScott Wood SPL uses normal NAND drivers, not minimal drivers. 29406f2f01b9SScott Wood 29416f2f01b9SScott Wood CONFIG_SPL_NAND_ECC 29426f2f01b9SScott Wood Include standard software ECC in the SPL 29436f2f01b9SScott Wood 294495579793STom Rini CONFIG_SPL_NAND_SIMPLE 29457d4b7955SScott Wood Support for NAND boot using simple NAND drivers that 29467d4b7955SScott Wood expose the cmd_ctrl() interface. 294795579793STom Rini 294895579793STom Rini CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT, 294995579793STom Rini CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE, 295095579793STom Rini CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS, 295195579793STom Rini CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE, 295295579793STom Rini CONFIG_SYS_NAND_ECCBYTES 295395579793STom Rini Defines the size and behavior of the NAND that SPL uses 29547d4b7955SScott Wood to read U-Boot 295595579793STom Rini 295695579793STom Rini CONFIG_SYS_NAND_U_BOOT_OFFS 29577d4b7955SScott Wood Location in NAND to read U-Boot from 29587d4b7955SScott Wood 29597d4b7955SScott Wood CONFIG_SYS_NAND_U_BOOT_DST 29607d4b7955SScott Wood Location in memory to load U-Boot to 29617d4b7955SScott Wood 29627d4b7955SScott Wood CONFIG_SYS_NAND_U_BOOT_SIZE 29637d4b7955SScott Wood Size of image to load 296495579793STom Rini 296595579793STom Rini CONFIG_SYS_NAND_U_BOOT_START 29667d4b7955SScott Wood Entry point in loaded image to jump to 296795579793STom Rini 296895579793STom Rini CONFIG_SYS_NAND_HW_ECC_OOBFIRST 296995579793STom Rini Define this if you need to first read the OOB and then the 297095579793STom Rini data. This is used for example on davinci plattforms. 297195579793STom Rini 297295579793STom Rini CONFIG_SPL_OMAP3_ID_NAND 297395579793STom Rini Support for an OMAP3-specific set of functions to return the 297495579793STom Rini ID and MFR of the first attached NAND chip, if present. 297595579793STom Rini 29766a11cf48SDaniel Schwierzeck CONFIG_SPL_SERIAL_SUPPORT 29776a11cf48SDaniel Schwierzeck Support for drivers/serial/libserial.o in SPL binary 29786a11cf48SDaniel Schwierzeck 29796a11cf48SDaniel Schwierzeck CONFIG_SPL_SPI_FLASH_SUPPORT 29806a11cf48SDaniel Schwierzeck Support for drivers/mtd/spi/libspi_flash.o in SPL binary 29816a11cf48SDaniel Schwierzeck 29826a11cf48SDaniel Schwierzeck CONFIG_SPL_SPI_SUPPORT 29836a11cf48SDaniel Schwierzeck Support for drivers/spi/libspi.o in SPL binary 29846a11cf48SDaniel Schwierzeck 2985c57b953dSPavel Machek CONFIG_SPL_RAM_DEVICE 2986c57b953dSPavel Machek Support for running image already present in ram, in SPL binary 2987c57b953dSPavel Machek 29886a11cf48SDaniel Schwierzeck CONFIG_SPL_LIBGENERIC_SUPPORT 29896a11cf48SDaniel Schwierzeck Support for lib/libgeneric.o in SPL binary 29901372cce2SMarian Balakowicz 299174752baaSScott Wood CONFIG_SPL_PAD_TO 29926113d3f2SBenoît Thébaudeau Image offset to which the SPL should be padded before appending 29936113d3f2SBenoît Thébaudeau the SPL payload. By default, this is defined as 29946113d3f2SBenoît Thébaudeau CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined. 29956113d3f2SBenoît Thébaudeau CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL 29966113d3f2SBenoît Thébaudeau payload without any padding, or >= CONFIG_SPL_MAX_SIZE. 299774752baaSScott Wood 2998ca2fca22SScott Wood CONFIG_SPL_TARGET 2999ca2fca22SScott Wood Final target image containing SPL and payload. Some SPLs 3000ca2fca22SScott Wood use an arch-specific makefile fragment instead, for 3001ca2fca22SScott Wood example if more than one image needs to be produced. 3002ca2fca22SScott Wood 300387ebee39SSimon Glass CONFIG_FIT_SPL_PRINT 300487ebee39SSimon Glass Printing information about a FIT image adds quite a bit of 300587ebee39SSimon Glass code to SPL. So this is normally disabled in SPL. Use this 300687ebee39SSimon Glass option to re-enable it. This will affect the output of the 300787ebee39SSimon Glass bootm command when booting a FIT image. 300887ebee39SSimon Glass 3009c609719bSwdenkModem Support: 3010c609719bSwdenk-------------- 3011c609719bSwdenk 3012566e5cf4SWolfgang Denk[so far only for SMDK2400 boards] 3013c609719bSwdenk 301411ccc33fSMarcel Ziswiler- Modem support enable: 3015c609719bSwdenk CONFIG_MODEM_SUPPORT 3016c609719bSwdenk 3017c609719bSwdenk- RTS/CTS Flow control enable: 3018c609719bSwdenk CONFIG_HWFLOW 3019c609719bSwdenk 3020c609719bSwdenk- Modem debug support: 3021c609719bSwdenk CONFIG_MODEM_SUPPORT_DEBUG 3022c609719bSwdenk 3023c609719bSwdenk Enables debugging stuff (char screen[1024], dbg()) 3024c609719bSwdenk for modem support. Useful only with BDI2000. 3025c609719bSwdenk 3026a8c7c708Swdenk- Interrupt support (PPC): 3027a8c7c708Swdenk 3028a8c7c708Swdenk There are common interrupt_init() and timer_interrupt() 3029a8c7c708Swdenk for all PPC archs. interrupt_init() calls interrupt_init_cpu() 303011ccc33fSMarcel Ziswiler for CPU specific initialization. interrupt_init_cpu() 3031a8c7c708Swdenk should set decrementer_count to appropriate value. If 303211ccc33fSMarcel Ziswiler CPU resets decrementer automatically after interrupt 3033a8c7c708Swdenk (ppc4xx) it should set decrementer_count to zero. 303411ccc33fSMarcel Ziswiler timer_interrupt() calls timer_interrupt_cpu() for CPU 3035a8c7c708Swdenk specific handling. If board has watchdog / status_led 3036a8c7c708Swdenk / other_activity_monitor it works automatically from 3037a8c7c708Swdenk general timer_interrupt(). 3038a8c7c708Swdenk 3039c609719bSwdenk- General: 3040c609719bSwdenk 3041c609719bSwdenk In the target system modem support is enabled when a 3042c609719bSwdenk specific key (key combination) is pressed during 3043c609719bSwdenk power-on. Otherwise U-Boot will boot normally 304411ccc33fSMarcel Ziswiler (autoboot). The key_pressed() function is called from 3045c609719bSwdenk board_init(). Currently key_pressed() is a dummy 3046c609719bSwdenk function, returning 1 and thus enabling modem 3047c609719bSwdenk initialization. 3048c609719bSwdenk 3049c609719bSwdenk If there are no modem init strings in the 3050c609719bSwdenk environment, U-Boot proceed to autoboot; the 3051c609719bSwdenk previous output (banner, info printfs) will be 305211ccc33fSMarcel Ziswiler suppressed, though. 3053c609719bSwdenk 3054c609719bSwdenk See also: doc/README.Modem 3055c609719bSwdenk 30569660e442SHelmut RaigerBoard initialization settings: 30579660e442SHelmut Raiger------------------------------ 30589660e442SHelmut Raiger 30599660e442SHelmut RaigerDuring Initialization u-boot calls a number of board specific functions 30609660e442SHelmut Raigerto allow the preparation of board specific prerequisites, e.g. pin setup 30619660e442SHelmut Raigerbefore drivers are initialized. To enable these callbacks the 30629660e442SHelmut Raigerfollowing configuration macros have to be defined. Currently this is 30639660e442SHelmut Raigerarchitecture specific, so please check arch/your_architecture/lib/board.c 30649660e442SHelmut Raigertypically in board_init_f() and board_init_r(). 30659660e442SHelmut Raiger 30669660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f() 30679660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r() 30689660e442SHelmut Raiger- CONFIG_BOARD_LATE_INIT: Call board_late_init() 30699660e442SHelmut Raiger- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init() 3070c609719bSwdenk 3071c609719bSwdenkConfiguration Settings: 3072c609719bSwdenk----------------------- 3073c609719bSwdenk 30746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included; 3075c609719bSwdenk undefine this when you're short of memory. 3076c609719bSwdenk 30772fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default 30782fb2604dSPeter Tyser width of the commands listed in the 'help' command output. 30792fb2604dSPeter Tyser 30806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to 3081c609719bSwdenk prompt for user input. 3082c609719bSwdenk 30836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE: Buffer size for input from the Console 3084c609719bSwdenk 30856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE: Buffer size for Console output 3086c609719bSwdenk 30876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands 3088c609719bSwdenk 30896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to 3090c609719bSwdenk the application (usually a Linux kernel) when it is 3091c609719bSwdenk booted 3092c609719bSwdenk 30936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE: 3094c609719bSwdenk List of legal baudrate settings for this board. 3095c609719bSwdenk 30966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET 3097c609719bSwdenk Suppress display of console information at boot. 3098c609719bSwdenk 30996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV 3100c609719bSwdenk If the board specific function 3101c609719bSwdenk extern int overwrite_console (void); 3102c609719bSwdenk returns 1, the stdin, stderr and stdout are switched to the 3103c609719bSwdenk serial port, else the settings in the environment are used. 3104c609719bSwdenk 31056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE 3106c609719bSwdenk Enable the call to overwrite_console(). 3107c609719bSwdenk 31086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE 3109c609719bSwdenk Enable overwrite of previous console environment settings. 3110c609719bSwdenk 31116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END: 3112c609719bSwdenk Begin and End addresses of the area used by the 3113c609719bSwdenk simple memory test. 3114c609719bSwdenk 31156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST: 3116c609719bSwdenk Enable an alternate, more extensive memory test. 3117c609719bSwdenk 31186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH: 31195f535fe1Swdenk Scratch address used by the alternate memory test 31205f535fe1Swdenk You only need to set this if address zero isn't writeable 31215f535fe1Swdenk 31226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only): 31236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header, 312414f73ca6SStefan Roese this specified memory area will get subtracted from the top 312511ccc33fSMarcel Ziswiler (end) of RAM and won't get "touched" at all by U-Boot. By 312614f73ca6SStefan Roese fixing up gd->ram_size the Linux kernel should gets passed 312714f73ca6SStefan Roese the now "corrected" memory size and won't touch it either. 312814f73ca6SStefan Roese This should work for arch/ppc and arch/powerpc. Only Linux 31295e12e75dSStefan Roese board ports in arch/powerpc with bootwrapper support that 313014f73ca6SStefan Roese recalculate the memory size from the SDRAM controller setup 31315e12e75dSStefan Roese will have to get fixed in Linux additionally. 313214f73ca6SStefan Roese 313314f73ca6SStefan Roese This option can be used as a workaround for the 440EPx/GRx 313414f73ca6SStefan Roese CHIP 11 errata where the last 256 bytes in SDRAM shouldn't 313514f73ca6SStefan Roese be touched. 313614f73ca6SStefan Roese 313714f73ca6SStefan Roese WARNING: Please make sure that this value is a multiple of 313814f73ca6SStefan Roese the Linux page size (normally 4k). If this is not the case, 313914f73ca6SStefan Roese then the end address of the Linux memory will be located at a 314014f73ca6SStefan Roese non page size aligned address and this could cause major 314114f73ca6SStefan Roese problems. 314214f73ca6SStefan Roese 31436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE: 3144c609719bSwdenk Enable temporary baudrate change while serial download 3145c609719bSwdenk 31466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE: 3147c609719bSwdenk Physical start address of SDRAM. _Must_ be 0 here. 3148c609719bSwdenk 31496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE: 3150c609719bSwdenk Physical start address of Motherboard I/O (if using a 3151c609719bSwdenk Cogent motherboard) 3152c609719bSwdenk 31536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE: 3154c609719bSwdenk Physical start address of Flash memory. 3155c609719bSwdenk 31566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE: 3157c609719bSwdenk Physical start address of boot monitor code (set by 3158c609719bSwdenk make config files to be same as the text base address 315914d0a02aSWolfgang Denk (CONFIG_SYS_TEXT_BASE) used when linking) - same as 31606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FLASH_BASE when booting from flash. 3161c609719bSwdenk 31626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN: 31633b57fe0aSwdenk Size of memory reserved for monitor code, used to 31643b57fe0aSwdenk determine _at_compile_time_ (!) if the environment is 31653b57fe0aSwdenk embedded within the U-Boot image, or in a separate 31663b57fe0aSwdenk flash sector. 3167c609719bSwdenk 31686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN: 3169c609719bSwdenk Size of DRAM reserved for malloc() use. 3170c609719bSwdenk 31716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN: 317215940c9aSStefan Roese Normally compressed uImages are limited to an 317315940c9aSStefan Roese uncompressed size of 8 MBytes. If this is not enough, 31746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD you can define CONFIG_SYS_BOOTM_LEN in your board config file 317515940c9aSStefan Roese to adjust this setting to your needs. 3176c609719bSwdenk 31776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ: 3178c609719bSwdenk Maximum size of memory mapped by the startup code of 3179c609719bSwdenk the Linux kernel; all data that must be processed by 31807d721e34SBartlomiej Sieka the Linux kernel (bd_info, boot arguments, FDT blob if 31817d721e34SBartlomiej Sieka used) must be put below this limit, unless "bootm_low" 31827d721e34SBartlomiej Sieka enviroment variable is defined and non-zero. In such case 31837d721e34SBartlomiej Sieka all data for the Linux kernel must be between "bootm_low" 3184c3624e6eSGrant Likely and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment 3185c3624e6eSGrant Likely variable "bootm_mapsize" will override the value of 3186c3624e6eSGrant Likely CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined, 3187c3624e6eSGrant Likely then the value in "bootm_size" will be used instead. 3188c609719bSwdenk 3189fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH: 3190fca43cc8SJohn Rigby Enable initrd_high functionality. If defined then the 3191fca43cc8SJohn Rigby initrd_high feature is enabled and the bootm ramdisk subcommand 3192fca43cc8SJohn Rigby is enabled. 3193fca43cc8SJohn Rigby 3194fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE: 3195fca43cc8SJohn Rigby Enables allocating and saving kernel cmdline in space between 3196fca43cc8SJohn Rigby "bootm_low" and "bootm_low" + BOOTMAPSZ. 3197fca43cc8SJohn Rigby 3198fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD: 3199fca43cc8SJohn Rigby Enables allocating and saving a kernel copy of the bd_info in 3200fca43cc8SJohn Rigby space between "bootm_low" and "bootm_low" + BOOTMAPSZ. 3201fca43cc8SJohn Rigby 32026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS: 3203c609719bSwdenk Max number of Flash memory banks 3204c609719bSwdenk 32056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT: 3206c609719bSwdenk Max number of sectors on a Flash chip 3207c609719bSwdenk 32086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT: 3209c609719bSwdenk Timeout for Flash erase operations (in ms) 3210c609719bSwdenk 32116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT: 3212c609719bSwdenk Timeout for Flash write operations (in ms) 3213c609719bSwdenk 32146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT 32158564acf9Swdenk Timeout for Flash set sector lock bit operation (in ms) 32168564acf9Swdenk 32176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT 32188564acf9Swdenk Timeout for Flash clear lock bits operation (in ms) 32198564acf9Swdenk 32206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION 32218564acf9Swdenk If defined, hardware flash sectors protection is used 32228564acf9Swdenk instead of U-Boot software protection. 32238564acf9Swdenk 32246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP: 3225c609719bSwdenk 3226c609719bSwdenk Enable TFTP transfers directly to flash memory; 3227c609719bSwdenk without this option such a download has to be 3228c609719bSwdenk performed in two steps: (1) download to RAM, and (2) 3229c609719bSwdenk copy from RAM to flash. 3230c609719bSwdenk 3231c609719bSwdenk The two-step approach is usually more reliable, since 3232c609719bSwdenk you can check if the download worked before you erase 323311ccc33fSMarcel Ziswiler the flash, but in some situations (when system RAM is 323411ccc33fSMarcel Ziswiler too limited to allow for a temporary copy of the 3235c609719bSwdenk downloaded image) this option may be very useful. 3236c609719bSwdenk 32376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI: 3238c609719bSwdenk Define if the flash driver uses extra elements in the 32395653fc33Swdenk common flash structure for storing flash geometry. 32405653fc33Swdenk 324100b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER 32425653fc33Swdenk This option also enables the building of the cfi_flash driver 32435653fc33Swdenk in the drivers directory 324453cf9435Sstroese 324591809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD 324691809ed5SPiotr Ziecik This option enables the building of the cfi_mtd driver 324791809ed5SPiotr Ziecik in the drivers directory. The driver exports CFI flash 324891809ed5SPiotr Ziecik to the MTD layer. 324991809ed5SPiotr Ziecik 32506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE 325196ef831fSGuennadi Liakhovetski Use buffered writes to flash. 325296ef831fSGuennadi Liakhovetski 325396ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N 325496ef831fSGuennadi Liakhovetski s29ws-n MirrorBit flash has non-standard addresses for buffered 325596ef831fSGuennadi Liakhovetski write commands. 325696ef831fSGuennadi Liakhovetski 32576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST 32585568e613SStefan Roese If this option is defined, the common CFI flash doesn't 32595568e613SStefan Roese print it's warning upon not recognized FLASH banks. This 32605568e613SStefan Roese is useful, if some of the configured banks are only 32615568e613SStefan Roese optionally available. 32625568e613SStefan Roese 32639a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS 32649a042e9cSJerry Van Baren If defined (must be an integer), print out countdown 32659a042e9cSJerry Van Baren digits and dots. Recommended value: 45 (9..1) for 80 32669a042e9cSJerry Van Baren column displays, 15 (3..1) for 40 column displays. 32679a042e9cSJerry Van Baren 3268352ef3f1SStefan Roese- CONFIG_FLASH_VERIFY 3269352ef3f1SStefan Roese If defined, the content of the flash (destination) is compared 3270352ef3f1SStefan Roese against the source after the write operation. An error message 3271352ef3f1SStefan Roese will be printed when the contents are not identical. 3272352ef3f1SStefan Roese Please note that this option is useless in nearly all cases, 3273352ef3f1SStefan Roese since such flash programming errors usually are detected earlier 3274352ef3f1SStefan Roese while unprotecting/erasing/programming. Please only enable 3275352ef3f1SStefan Roese this option if you really know what you are doing. 3276352ef3f1SStefan Roese 32776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER: 327811ccc33fSMarcel Ziswiler Defines the number of Ethernet receive buffers. On some 327911ccc33fSMarcel Ziswiler Ethernet controllers it is recommended to set this value 328053cf9435Sstroese to 8 or even higher (EEPRO100 or 405 EMAC), since all 328153cf9435Sstroese buffers can be full shortly after enabling the interface 328211ccc33fSMarcel Ziswiler on high Ethernet traffic. 328353cf9435Sstroese Defaults to 4 if not defined. 3284c609719bSwdenk 3285ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES 3286ea882bafSWolfgang Denk 3287ea882bafSWolfgang Denk Maximum number of entries in the hash table that is used 3288ea882bafSWolfgang Denk internally to store the environment settings. The default 3289ea882bafSWolfgang Denk setting is supposed to be generous and should work in most 3290ea882bafSWolfgang Denk cases. This setting can be used to tune behaviour; see 3291ea882bafSWolfgang Denk lib/hashtable.c for details. 3292ea882bafSWolfgang Denk 32932598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_DEFAULT 32942598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_STATIC 32952598090bSJoe Hershberger Enable validation of the values given to enviroment variables when 32962598090bSJoe Hershberger calling env set. Variables can be restricted to only decimal, 32972598090bSJoe Hershberger hexadecimal, or boolean. If CONFIG_CMD_NET is also defined, 32982598090bSJoe Hershberger the variables can also be restricted to IP address or MAC address. 32992598090bSJoe Hershberger 33002598090bSJoe Hershberger The format of the list is: 33012598090bSJoe Hershberger type_attribute = [s|d|x|b|i|m] 3302267541f7SJoe Hershberger access_atribute = [a|r|o|c] 3303267541f7SJoe Hershberger attributes = type_attribute[access_atribute] 33042598090bSJoe Hershberger entry = variable_name[:attributes] 33052598090bSJoe Hershberger list = entry[,list] 33062598090bSJoe Hershberger 33072598090bSJoe Hershberger The type attributes are: 33082598090bSJoe Hershberger s - String (default) 33092598090bSJoe Hershberger d - Decimal 33102598090bSJoe Hershberger x - Hexadecimal 33112598090bSJoe Hershberger b - Boolean ([1yYtT|0nNfF]) 33122598090bSJoe Hershberger i - IP address 33132598090bSJoe Hershberger m - MAC address 33142598090bSJoe Hershberger 3315267541f7SJoe Hershberger The access attributes are: 3316267541f7SJoe Hershberger a - Any (default) 3317267541f7SJoe Hershberger r - Read-only 3318267541f7SJoe Hershberger o - Write-once 3319267541f7SJoe Hershberger c - Change-default 3320267541f7SJoe Hershberger 33212598090bSJoe Hershberger - CONFIG_ENV_FLAGS_LIST_DEFAULT 33222598090bSJoe Hershberger Define this to a list (string) to define the ".flags" 33232598090bSJoe Hershberger envirnoment variable in the default or embedded environment. 33242598090bSJoe Hershberger 33252598090bSJoe Hershberger - CONFIG_ENV_FLAGS_LIST_STATIC 33262598090bSJoe Hershberger Define this to a list (string) to define validation that 33272598090bSJoe Hershberger should be done if an entry is not found in the ".flags" 33282598090bSJoe Hershberger environment variable. To override a setting in the static 33292598090bSJoe Hershberger list, simply add an entry for the same variable name to the 33302598090bSJoe Hershberger ".flags" variable. 33312598090bSJoe Hershberger 3332267541f7SJoe Hershberger- CONFIG_ENV_ACCESS_IGNORE_FORCE 3333267541f7SJoe Hershberger If defined, don't allow the -f switch to env set override variable 3334267541f7SJoe Hershberger access flags. 3335267541f7SJoe Hershberger 33365c1a7ea6SSimon Glass- CONFIG_SYS_GENERIC_BOARD 33375c1a7ea6SSimon Glass This selects the architecture-generic board system instead of the 33385c1a7ea6SSimon Glass architecture-specific board files. It is intended to move boards 33395c1a7ea6SSimon Glass to this new framework over time. Defining this will disable the 33405c1a7ea6SSimon Glass arch/foo/lib/board.c file and use common/board_f.c and 33415c1a7ea6SSimon Glass common/board_r.c instead. To use this option your architecture 33425c1a7ea6SSimon Glass must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in 33435c1a7ea6SSimon Glass its config.mk file). If you find problems enabling this option on 33445c1a7ea6SSimon Glass your board please report the problem and send patches! 33455c1a7ea6SSimon Glass 3346632efa74SSimon Glass- CONFIG_SYS_SYM_OFFSETS 3347632efa74SSimon Glass This is set by architectures that use offsets for link symbols 3348632efa74SSimon Glass instead of absolute values. So bss_start is obtained using an 3349632efa74SSimon Glass offset _bss_start_ofs from CONFIG_SYS_TEXT_BASE, rather than 3350632efa74SSimon Glass directly. You should not need to touch this setting. 3351632efa74SSimon Glass 33520b1b60c7SLokesh Vutla- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only) 33530b1b60c7SLokesh Vutla This is set by OMAP boards for the max time that reset should 33540b1b60c7SLokesh Vutla be asserted. See doc/README.omap-reset-time for details on how 33550b1b60c7SLokesh Vutla the value can be calulated on a given board. 3356632efa74SSimon Glass 3357c609719bSwdenkThe following definitions that deal with the placement and management 3358c609719bSwdenkof environment data (variable area); in general, we support the 3359c609719bSwdenkfollowing configurations: 3360c609719bSwdenk 3361c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC: 3362c3eb3fe4SMike Frysinger 3363c3eb3fe4SMike Frysinger Builds up envcrc with the target environment so that external utils 3364c3eb3fe4SMike Frysinger may easily extract it and embed it in final U-Boot images. 3365c3eb3fe4SMike Frysinger 33665a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH: 3367c609719bSwdenk 3368c609719bSwdenk Define this if the environment is in flash memory. 3369c609719bSwdenk 3370c609719bSwdenk a) The environment occupies one whole flash sector, which is 3371c609719bSwdenk "embedded" in the text segment with the U-Boot code. This 3372c609719bSwdenk happens usually with "bottom boot sector" or "top boot 3373c609719bSwdenk sector" type flash chips, which have several smaller 3374c609719bSwdenk sectors at the start or the end. For instance, such a 3375c609719bSwdenk layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In 3376c609719bSwdenk such a case you would place the environment in one of the 3377c609719bSwdenk 4 kB sectors - with U-Boot code before and after it. With 3378c609719bSwdenk "top boot sector" type flash chips, you would put the 3379c609719bSwdenk environment in one of the last sectors, leaving a gap 3380c609719bSwdenk between U-Boot and the environment. 3381c609719bSwdenk 33820e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 3383c609719bSwdenk 3384c609719bSwdenk Offset of environment data (variable area) to the 3385c609719bSwdenk beginning of flash memory; for instance, with bottom boot 3386c609719bSwdenk type flash chips the second sector can be used: the offset 3387c609719bSwdenk for this sector is given here. 3388c609719bSwdenk 33896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE. 3390c609719bSwdenk 33910e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 3392c609719bSwdenk 3393c609719bSwdenk This is just another way to specify the start address of 3394c609719bSwdenk the flash sector containing the environment (instead of 33950e8d1586SJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_OFFSET). 3396c609719bSwdenk 33970e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SECT_SIZE: 3398c609719bSwdenk 3399c609719bSwdenk Size of the sector containing the environment. 3400c609719bSwdenk 3401c609719bSwdenk 3402c609719bSwdenk b) Sometimes flash chips have few, equal sized, BIG sectors. 3403c609719bSwdenk In such a case you don't want to spend a whole sector for 3404c609719bSwdenk the environment. 3405c609719bSwdenk 34060e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 3407c609719bSwdenk 34085a1aceb0SJean-Christophe PLAGNIOL-VILLARD If you use this in combination with CONFIG_ENV_IS_IN_FLASH 34090e8d1586SJean-Christophe PLAGNIOL-VILLARD and CONFIG_ENV_SECT_SIZE, you can specify to use only a part 3410c609719bSwdenk of this flash sector for the environment. This saves 3411c609719bSwdenk memory for the RAM copy of the environment. 3412c609719bSwdenk 3413c609719bSwdenk It may also save flash memory if you decide to use this 3414c609719bSwdenk when your environment is "embedded" within U-Boot code, 3415c609719bSwdenk since then the remainder of the flash sector could be used 3416c609719bSwdenk for U-Boot code. It should be pointed out that this is 3417c609719bSwdenk STRONGLY DISCOURAGED from a robustness point of view: 3418c609719bSwdenk updating the environment in flash makes it always 3419c609719bSwdenk necessary to erase the WHOLE sector. If something goes 3420c609719bSwdenk wrong before the contents has been restored from a copy in 3421c609719bSwdenk RAM, your target system will be dead. 3422c609719bSwdenk 34230e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR_REDUND 34240e8d1586SJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_SIZE_REDUND 3425c609719bSwdenk 3426c609719bSwdenk These settings describe a second storage area used to hold 342711ccc33fSMarcel Ziswiler a redundant copy of the environment data, so that there is 34283e38691eSwdenk a valid backup copy in case there is a power failure during 3429c609719bSwdenk a "saveenv" operation. 3430c609719bSwdenk 3431c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the 3432c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds* 3433c609719bSwdenkaccordingly! 3434c609719bSwdenk 3435c609719bSwdenk 34369314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM: 3437c609719bSwdenk 3438c609719bSwdenk Define this if you have some non-volatile memory device 3439c609719bSwdenk (NVRAM, battery buffered SRAM) which you want to use for the 3440c609719bSwdenk environment. 3441c609719bSwdenk 34420e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 34430e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 3444c609719bSwdenk 344511ccc33fSMarcel Ziswiler These two #defines are used to determine the memory area you 3446c609719bSwdenk want to use for environment. It is assumed that this memory 3447c609719bSwdenk can just be read and written to, without any special 3448c609719bSwdenk provision. 3449c609719bSwdenk 3450c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early 3451c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the 345211ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or 3453c609719bSwdenkU-Boot will hang. 3454c609719bSwdenk 3455c609719bSwdenkPlease note that even with NVRAM we still use a copy of the 3456c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to 3457c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv" 3458c609719bSwdenkto save the current settings. 3459c609719bSwdenk 3460c609719bSwdenk 3461bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM: 3462c609719bSwdenk 3463c609719bSwdenk Use this if you have an EEPROM or similar serial access 3464c609719bSwdenk device and a driver for it. 3465c609719bSwdenk 34660e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 34670e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 3468c609719bSwdenk 3469c609719bSwdenk These two #defines specify the offset and size of the 3470c609719bSwdenk environment area within the total memory of your EEPROM. 3471c609719bSwdenk 34726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR: 3473c609719bSwdenk If defined, specified the chip address of the EEPROM device. 3474c609719bSwdenk The default address is zero. 3475c609719bSwdenk 34766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS: 3477c609719bSwdenk If defined, the number of bits used to address bytes in a 3478c609719bSwdenk single page in the EEPROM device. A 64 byte page, for example 3479c609719bSwdenk would require six bits. 3480c609719bSwdenk 34816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS: 3482c609719bSwdenk If defined, the number of milliseconds to delay between 3483c609719bSwdenk page writes. The default is zero milliseconds. 3484c609719bSwdenk 34856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR_LEN: 3486c609719bSwdenk The length in bytes of the EEPROM memory array address. Note 3487c609719bSwdenk that this is NOT the chip address length! 3488c609719bSwdenk 34896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW: 34905cf91d6bSwdenk EEPROM chips that implement "address overflow" are ones 34915cf91d6bSwdenk like Catalyst 24WC04/08/16 which has 9/10/11 bits of 34925cf91d6bSwdenk address and the extra bits end up in the "chip address" bit 34935cf91d6bSwdenk slots. This makes a 24WC08 (1Kbyte) chip look like four 256 34945cf91d6bSwdenk byte chips. 34955cf91d6bSwdenk 34965cf91d6bSwdenk Note that we consider the length of the address field to 34975cf91d6bSwdenk still be one byte because the extra address bits are hidden 34985cf91d6bSwdenk in the chip address. 34995cf91d6bSwdenk 35006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_SIZE: 3501c609719bSwdenk The size in bytes of the EEPROM device. 3502c609719bSwdenk 3503548738b4SHeiko Schocher - CONFIG_ENV_EEPROM_IS_ON_I2C 3504548738b4SHeiko Schocher define this, if you have I2C and SPI activated, and your 3505548738b4SHeiko Schocher EEPROM, which holds the environment, is on the I2C bus. 3506548738b4SHeiko Schocher 3507548738b4SHeiko Schocher - CONFIG_I2C_ENV_EEPROM_BUS 3508548738b4SHeiko Schocher if you have an Environment on an EEPROM reached over 3509548738b4SHeiko Schocher I2C muxes, you can define here, how to reach this 3510548738b4SHeiko Schocher EEPROM. For example: 3511548738b4SHeiko Schocher 3512548738b4SHeiko Schocher #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0" 3513548738b4SHeiko Schocher 3514548738b4SHeiko Schocher EEPROM which holds the environment, is reached over 3515548738b4SHeiko Schocher a pca9547 i2c mux with address 0x70, channel 3. 3516c609719bSwdenk 3517057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH: 35185779d8d9Swdenk 35195779d8d9Swdenk Define this if you have a DataFlash memory device which you 35205779d8d9Swdenk want to use for the environment. 35215779d8d9Swdenk 35220e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 35230e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 35240e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 35255779d8d9Swdenk 35265779d8d9Swdenk These three #defines specify the offset and size of the 35275779d8d9Swdenk environment area within the total memory of your DataFlash placed 35285779d8d9Swdenk at the specified address. 35295779d8d9Swdenk 35300a85a9e7SLiu Gang- CONFIG_ENV_IS_IN_REMOTE: 35310a85a9e7SLiu Gang 35320a85a9e7SLiu Gang Define this if you have a remote memory space which you 35330a85a9e7SLiu Gang want to use for the local device's environment. 35340a85a9e7SLiu Gang 35350a85a9e7SLiu Gang - CONFIG_ENV_ADDR: 35360a85a9e7SLiu Gang - CONFIG_ENV_SIZE: 35370a85a9e7SLiu Gang 35380a85a9e7SLiu Gang These two #defines specify the address and size of the 35390a85a9e7SLiu Gang environment area within the remote memory space. The 35400a85a9e7SLiu Gang local device can get the environment from remote memory 3541fc54c7faSLiu Gang space by SRIO or PCIE links. 35420a85a9e7SLiu Gang 35430a85a9e7SLiu GangBE CAREFUL! For some special cases, the local device can not use 35440a85a9e7SLiu Gang"saveenv" command. For example, the local device will get the 3545fc54c7faSLiu Gangenvironment stored in a remote NOR flash by SRIO or PCIE link, 3546fc54c7faSLiu Gangbut it can not erase, write this NOR flash by SRIO or PCIE interface. 35470a85a9e7SLiu Gang 354851bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND: 354913a5695bSwdenk 355013a5695bSwdenk Define this if you have a NAND device which you want to use 355113a5695bSwdenk for the environment. 355213a5695bSwdenk 35530e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 35540e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 355513a5695bSwdenk 355613a5695bSwdenk These two #defines specify the offset and size of the environment 3557fdd813deSScott Wood area within the first NAND device. CONFIG_ENV_OFFSET must be 3558fdd813deSScott Wood aligned to an erase block boundary. 35595779d8d9Swdenk 3560fdd813deSScott Wood - CONFIG_ENV_OFFSET_REDUND (optional): 3561e443c944SMarkus Klotzbuecher 35620e8d1586SJean-Christophe PLAGNIOL-VILLARD This setting describes a second storage area of CONFIG_ENV_SIZE 3563fdd813deSScott Wood size used to hold a redundant copy of the environment data, so 3564fdd813deSScott Wood that there is a valid backup copy in case there is a power failure 3565fdd813deSScott Wood during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be 3566fdd813deSScott Wood aligned to an erase block boundary. 3567e443c944SMarkus Klotzbuecher 3568fdd813deSScott Wood - CONFIG_ENV_RANGE (optional): 3569fdd813deSScott Wood 3570fdd813deSScott Wood Specifies the length of the region in which the environment 3571fdd813deSScott Wood can be written. This should be a multiple of the NAND device's 3572fdd813deSScott Wood block size. Specifying a range with more erase blocks than 3573fdd813deSScott Wood are needed to hold CONFIG_ENV_SIZE allows bad blocks within 3574fdd813deSScott Wood the range to be avoided. 3575fdd813deSScott Wood 3576fdd813deSScott Wood - CONFIG_ENV_OFFSET_OOB (optional): 3577fdd813deSScott Wood 3578fdd813deSScott Wood Enables support for dynamically retrieving the offset of the 3579fdd813deSScott Wood environment from block zero's out-of-band data. The 3580fdd813deSScott Wood "nand env.oob" command can be used to record this offset. 3581fdd813deSScott Wood Currently, CONFIG_ENV_OFFSET_REDUND is not supported when 3582fdd813deSScott Wood using CONFIG_ENV_OFFSET_OOB. 3583e443c944SMarkus Klotzbuecher 3584b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST 3585b74ab737SGuennadi Liakhovetski 3586b74ab737SGuennadi Liakhovetski Defines address in RAM to which the nand_spl code should copy the 3587b74ab737SGuennadi Liakhovetski environment. If redundant environment is used, it will be copied to 3588b74ab737SGuennadi Liakhovetski CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE. 3589b74ab737SGuennadi Liakhovetski 35902b74433fSJoe Hershberger- CONFIG_ENV_IS_IN_UBI: 35912b74433fSJoe Hershberger 35922b74433fSJoe Hershberger Define this if you have an UBI volume that you want to use for the 35932b74433fSJoe Hershberger environment. This has the benefit of wear-leveling the environment 35942b74433fSJoe Hershberger accesses, which is important on NAND. 35952b74433fSJoe Hershberger 35962b74433fSJoe Hershberger - CONFIG_ENV_UBI_PART: 35972b74433fSJoe Hershberger 35982b74433fSJoe Hershberger Define this to a string that is the mtd partition containing the UBI. 35992b74433fSJoe Hershberger 36002b74433fSJoe Hershberger - CONFIG_ENV_UBI_VOLUME: 36012b74433fSJoe Hershberger 36022b74433fSJoe Hershberger Define this to the name of the volume that you want to store the 36032b74433fSJoe Hershberger environment in. 36042b74433fSJoe Hershberger 3605785881f7SJoe Hershberger - CONFIG_ENV_UBI_VOLUME_REDUND: 3606785881f7SJoe Hershberger 3607785881f7SJoe Hershberger Define this to the name of another volume to store a second copy of 3608785881f7SJoe Hershberger the environment in. This will enable redundant environments in UBI. 3609785881f7SJoe Hershberger It is assumed that both volumes are in the same MTD partition. 3610785881f7SJoe Hershberger 36112b74433fSJoe Hershberger - CONFIG_UBI_SILENCE_MSG 36122b74433fSJoe Hershberger - CONFIG_UBIFS_SILENCE_MSG 36132b74433fSJoe Hershberger 36142b74433fSJoe Hershberger You will probably want to define these to avoid a really noisy system 36152b74433fSJoe Hershberger when storing the env in UBI. 36162b74433fSJoe Hershberger 36176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET 3618c609719bSwdenk 3619c609719bSwdenk Defines offset to the initial SPI buffer area in DPRAM. The 3620c609719bSwdenk area is used at an early stage (ROM part) if the environment 3621c609719bSwdenk is configured to reside in the SPI EEPROM: We need a 520 byte 3622c609719bSwdenk scratch DPRAM area. It is used between the two initialization 3623c609719bSwdenk calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems 3624c609719bSwdenk to be a good choice since it makes it far enough from the 3625c609719bSwdenk start of the data area as well as from the stack pointer. 3626c609719bSwdenk 3627e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor 3628c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been 3629cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f() 3630c609719bSwdenkuntil then to read environment variables. 3631c609719bSwdenk 363285ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor 363385ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working 363485ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is 363585ec0bccSwdenknecessary, because the first environment variable we need is the 363685ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't 363785ec0bccSwdenkhave any device yet where we could complain.] 3638c609719bSwdenk 3639c609719bSwdenkNote: once the monitor has been relocated, then it will complain if 3640c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you 364185ec0bccSwdenkuse the "saveenv" command to store a valid environment. 3642c609719bSwdenk 36436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN: 3644fc3e2165Swdenk Echo the inverted Ethernet link state to the fault LED. 3645fc3e2165Swdenk 36466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR 3647fc3e2165Swdenk also needs to be defined. 3648fc3e2165Swdenk 36496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR: 3650fc3e2165Swdenk MII address of the PHY to check for the Ethernet link state. 3651c609719bSwdenk 3652f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS: 3653f5675aa5SRon Madrid Define this if you desire to only have use of the NS16550_init 3654f5675aa5SRon Madrid and NS16550_putc functions for the serial driver located at 3655f5675aa5SRon Madrid drivers/serial/ns16550.c. This option is useful for saving 3656f5675aa5SRon Madrid space for already greatly restricted images, including but not 3657f5675aa5SRon Madrid limited to NAND_SPL configurations. 3658f5675aa5SRon Madrid 3659b2b92f53SSimon Glass- CONFIG_DISPLAY_BOARDINFO 3660b2b92f53SSimon Glass Display information about the board that U-Boot is running on 3661b2b92f53SSimon Glass when U-Boot starts up. The board function checkboard() is called 3662b2b92f53SSimon Glass to do this. 3663b2b92f53SSimon Glass 3664e2e3e2b1SSimon Glass- CONFIG_DISPLAY_BOARDINFO_LATE 3665e2e3e2b1SSimon Glass Similar to the previous option, but display this information 3666e2e3e2b1SSimon Glass later, once stdio is running and output goes to the LCD, if 3667e2e3e2b1SSimon Glass present. 3668e2e3e2b1SSimon Glass 3669c609719bSwdenkLow Level (hardware related) configuration options: 3670dc7c9a1aSwdenk--------------------------------------------------- 3671c609719bSwdenk 36726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE: 3673c609719bSwdenk Cache Line Size of the CPU. 3674c609719bSwdenk 36756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR: 3676c609719bSwdenk Default address of the IMMR after system reset. 36772535d602Swdenk 36782535d602Swdenk Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU, 36792535d602Swdenk and RPXsuper) to be able to adjust the position of 36802535d602Swdenk the IMMR register after a reset. 3681c609719bSwdenk 3682e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT: 3683e46fedfeSTimur Tabi Default (power-on reset) physical address of CCSR on Freescale 3684e46fedfeSTimur Tabi PowerPC SOCs. 3685e46fedfeSTimur Tabi 3686e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR: 3687e46fedfeSTimur Tabi Virtual address of CCSR. On a 32-bit build, this is typically 3688e46fedfeSTimur Tabi the same value as CONFIG_SYS_CCSRBAR_DEFAULT. 3689e46fedfeSTimur Tabi 3690e46fedfeSTimur Tabi CONFIG_SYS_DEFAULT_IMMR must also be set to this value, 3691e46fedfeSTimur Tabi for cross-platform code that uses that macro instead. 3692e46fedfeSTimur Tabi 3693e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS: 3694e46fedfeSTimur Tabi Physical address of CCSR. CCSR can be relocated to a new 3695e46fedfeSTimur Tabi physical address, if desired. In this case, this macro should 3696e46fedfeSTimur Tabi be set to that address. Otherwise, it should be set to the 3697e46fedfeSTimur Tabi same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR 3698e46fedfeSTimur Tabi is typically relocated on 36-bit builds. It is recommended 3699e46fedfeSTimur Tabi that this macro be defined via the _HIGH and _LOW macros: 3700e46fedfeSTimur Tabi 3701e46fedfeSTimur Tabi #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH 3702e46fedfeSTimur Tabi * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW) 3703e46fedfeSTimur Tabi 3704e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH: 3705e46fedfeSTimur Tabi Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically 3706e46fedfeSTimur Tabi either 0 (32-bit build) or 0xF (36-bit build). This macro is 3707e46fedfeSTimur Tabi used in assembly code, so it must not contain typecasts or 3708e46fedfeSTimur Tabi integer size suffixes (e.g. "ULL"). 3709e46fedfeSTimur Tabi 3710e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW: 3711e46fedfeSTimur Tabi Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is 3712e46fedfeSTimur Tabi used in assembly code, so it must not contain typecasts or 3713e46fedfeSTimur Tabi integer size suffixes (e.g. "ULL"). 3714e46fedfeSTimur Tabi 3715e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE: 3716e46fedfeSTimur Tabi If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be 3717e46fedfeSTimur Tabi forced to a value that ensures that CCSR is not relocated. 3718e46fedfeSTimur Tabi 37197f6c2cbcSwdenk- Floppy Disk Support: 37206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FDC_DRIVE_NUMBER 37217f6c2cbcSwdenk 37227f6c2cbcSwdenk the default drive number (default value 0) 37237f6c2cbcSwdenk 37246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_ISA_IO_STRIDE 37257f6c2cbcSwdenk 372611ccc33fSMarcel Ziswiler defines the spacing between FDC chipset registers 37277f6c2cbcSwdenk (default value 1) 37287f6c2cbcSwdenk 37296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_ISA_IO_OFFSET 37307f6c2cbcSwdenk 37317f6c2cbcSwdenk defines the offset of register from address. It 37327f6c2cbcSwdenk depends on which part of the data bus is connected to 373311ccc33fSMarcel Ziswiler the FDC chipset. (default value 0) 37347f6c2cbcSwdenk 37356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and 37366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their 37377f6c2cbcSwdenk default value. 37387f6c2cbcSwdenk 37396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD if CONFIG_SYS_FDC_HW_INIT is defined, then the function 37407f6c2cbcSwdenk fdc_hw_init() is called at the beginning of the FDC 37417f6c2cbcSwdenk setup. fdc_hw_init() must be provided by the board 37427f6c2cbcSwdenk source code. It is used to make hardware dependant 37437f6c2cbcSwdenk initializations. 37447f6c2cbcSwdenk 37450abddf82SMacpaul Lin- CONFIG_IDE_AHB: 37460abddf82SMacpaul Lin Most IDE controllers were designed to be connected with PCI 37470abddf82SMacpaul Lin interface. Only few of them were designed for AHB interface. 37480abddf82SMacpaul Lin When software is doing ATA command and data transfer to 37490abddf82SMacpaul Lin IDE devices through IDE-AHB controller, some additional 37500abddf82SMacpaul Lin registers accessing to these kind of IDE-AHB controller 37510abddf82SMacpaul Lin is requierd. 37520abddf82SMacpaul Lin 37536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR: Physical address of the Internal Memory. 375425d6712aSwdenk DO NOT CHANGE unless you know exactly what you're 375525d6712aSwdenk doing! (11-4) [MPC8xx/82xx systems only] 3756c609719bSwdenk 37576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR: 3758c609719bSwdenk 37597152b1d0Swdenk Start address of memory area that can be used for 3760c609719bSwdenk initial data and stack; please note that this must be 3761c609719bSwdenk writable memory that is working WITHOUT special 3762c609719bSwdenk initialization, i. e. you CANNOT use normal RAM which 3763c609719bSwdenk will become available only after programming the 3764c609719bSwdenk memory controller and running certain initialization 3765c609719bSwdenk sequences. 3766c609719bSwdenk 3767c609719bSwdenk U-Boot uses the following memory types: 3768c609719bSwdenk - MPC8xx and MPC8260: IMMR (internal memory of the CPU) 3769c609719bSwdenk - MPC824X: data cache 3770c609719bSwdenk - PPC4xx: data cache 3771c609719bSwdenk 37726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET: 3773c609719bSwdenk 3774c609719bSwdenk Offset of the initial data structure in the memory 37756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually 37766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial 3777c609719bSwdenk data is located at the end of the available space 3778553f0982SWolfgang Denk (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE - 37796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just 37806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR + 37816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_GBL_DATA_OFFSET) downward. 3782c609719bSwdenk 3783c609719bSwdenk Note: 3784c609719bSwdenk On the MPC824X (or other systems that use the data 3785c609719bSwdenk cache for initial memory) the address chosen for 37866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must 3787c609719bSwdenk point to an otherwise UNUSED address space between 3788c609719bSwdenk the top of RAM and the start of the PCI space. 3789c609719bSwdenk 37906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6) 3791c609719bSwdenk 37926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR: System Protection Control (11-9) 3793c609719bSwdenk 37946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26) 3795c609719bSwdenk 37966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31) 3797c609719bSwdenk 37986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30) 3799c609719bSwdenk 38006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27) 3801c609719bSwdenk 38026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM: 3803c609719bSwdenk SDRAM timing 3804c609719bSwdenk 38056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA: 3806c609719bSwdenk periodic timer for refresh 3807c609719bSwdenk 38086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER: Debug Event Register (37-47) 3809c609719bSwdenk 38106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM, 38116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP, 38126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM, 38136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BR1_PRELIM: 3814c609719bSwdenk Memory Controller Definitions: BR0/1 and OR0/1 (FLASH) 3815c609719bSwdenk 3816c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE, 38176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM, 38186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM: 3819c609719bSwdenk Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM) 3820c609719bSwdenk 38216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K, 38226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL: 3823c609719bSwdenk Machine Mode Register and Memory Periodic Timer 3824c609719bSwdenk Prescaler definitions (SDRAM timing) 3825c609719bSwdenk 38266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]: 3827c609719bSwdenk enable I2C microcode relocation patch (MPC8xx); 3828c609719bSwdenk define relocation offset in DPRAM [DSP2] 3829c609719bSwdenk 38306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]: 3831b423d055SHeiko Schocher enable SMC microcode relocation patch (MPC8xx); 3832b423d055SHeiko Schocher define relocation offset in DPRAM [SMC1] 3833b423d055SHeiko Schocher 38346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]: 3835c609719bSwdenk enable SPI microcode relocation patch (MPC8xx); 3836c609719bSwdenk define relocation offset in DPRAM [SCC4] 3837c609719bSwdenk 38386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK: 3839c609719bSwdenk Use OSCM clock mode on MBX8xx board. Be careful, 3840c609719bSwdenk wrong setting might damage your board. Read 3841c609719bSwdenk doc/README.MBX before setting this variable! 3842c609719bSwdenk 38436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only) 3844ea909b76Swdenk Offset of the bootmode word in DPRAM used by post 3845ea909b76Swdenk (Power On Self Tests). This definition overrides 3846ea909b76Swdenk #define'd default value in commproc.h resp. 3847ea909b76Swdenk cpm_8260.h. 3848ea909b76Swdenk 38496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB, 38506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL, 38516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS, 38526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB, 38536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START, 38546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL, 38556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE, 38566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only) 3857a47a12beSStefan Roese Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set. 38585d232d0eSwdenk 38599cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE: 38609cacf4fcSDirk Eibach Disable PCI-Express on systems where it is supported but not 38619cacf4fcSDirk Eibach required. 38629cacf4fcSDirk Eibach 386369fd2d3bSAndrew Sharp- CONFIG_PCI_ENUM_ONLY 386469fd2d3bSAndrew Sharp Only scan through and get the devices on the busses. 386569fd2d3bSAndrew Sharp Don't do any setup work, presumably because someone or 386669fd2d3bSAndrew Sharp something has already done it, and we don't need to do it 386769fd2d3bSAndrew Sharp a second time. Useful for platforms that are pre-booted 386869fd2d3bSAndrew Sharp by coreboot or similar. 386969fd2d3bSAndrew Sharp 3870a09b9b68SKumar Gala- CONFIG_SYS_SRIO: 3871a09b9b68SKumar Gala Chip has SRIO or not 3872a09b9b68SKumar Gala 3873a09b9b68SKumar Gala- CONFIG_SRIO1: 3874a09b9b68SKumar Gala Board has SRIO 1 port available 3875a09b9b68SKumar Gala 3876a09b9b68SKumar Gala- CONFIG_SRIO2: 3877a09b9b68SKumar Gala Board has SRIO 2 port available 3878a09b9b68SKumar Gala 3879a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT: 3880a09b9b68SKumar Gala Virtual Address of SRIO port 'n' memory region 3881a09b9b68SKumar Gala 3882a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS: 3883a09b9b68SKumar Gala Physical Address of SRIO port 'n' memory region 3884a09b9b68SKumar Gala 3885a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE: 3886a09b9b68SKumar Gala Size of SRIO port 'n' memory region 3887a09b9b68SKumar Gala 388866bd1846SFabio Estevam- CONFIG_SYS_NAND_BUSWIDTH_16BIT 388966bd1846SFabio Estevam Defined to tell the NAND controller that the NAND chip is using 389066bd1846SFabio Estevam a 16 bit bus. 389166bd1846SFabio Estevam Not all NAND drivers use this symbol. 3892a430e916SFabio Estevam Example of drivers that use it: 389366bd1846SFabio Estevam - drivers/mtd/nand/ndfc.c 3894a430e916SFabio Estevam - drivers/mtd/nand/mxc_nand.c 3895eced4626SAlex Waterman 3896eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG 3897eced4626SAlex Waterman Sets the EBC0_CFG register for the NDFC. If not defined 3898eced4626SAlex Waterman a default value will be used. 3899eced4626SAlex Waterman 3900bb99ad6dSBen Warren- CONFIG_SPD_EEPROM 3901218ca724SWolfgang Denk Get DDR timing information from an I2C EEPROM. Common 3902218ca724SWolfgang Denk with pluggable memory modules such as SODIMMs 3903218ca724SWolfgang Denk 3904bb99ad6dSBen Warren SPD_EEPROM_ADDRESS 3905bb99ad6dSBen Warren I2C address of the SPD EEPROM 3906bb99ad6dSBen Warren 39076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM 3908218ca724SWolfgang Denk If SPD EEPROM is on an I2C bus other than the first 3909218ca724SWolfgang Denk one, specify here. Note that the value must resolve 3910218ca724SWolfgang Denk to something your driver can deal with. 3911bb99ad6dSBen Warren 39121b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING 39131b3e3c4fSYork Sun Get DDR timing information from other than SPD. Common with 39141b3e3c4fSYork Sun soldered DDR chips onboard without SPD. DDR raw timing 39151b3e3c4fSYork Sun parameters are extracted from datasheet and hard-coded into 39161b3e3c4fSYork Sun header files or board specific files. 39171b3e3c4fSYork Sun 39186f5e1dc5SYork Sun- CONFIG_FSL_DDR_INTERACTIVE 39196f5e1dc5SYork Sun Enable interactive DDR debugging. See doc/README.fsl-ddr. 39206f5e1dc5SYork Sun 39216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0 3922218ca724SWolfgang Denk Only for 83xx systems. If specified, then DDR should 3923218ca724SWolfgang Denk be configured using CS0 and CS1 instead of CS2 and CS3. 39242ad6b513STimur Tabi 3925c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12] 3926c26e454dSwdenk Define to enable FEC[12] on a 8xx series processor. 3927c26e454dSwdenk 3928c26e454dSwdenk- CONFIG_FEC[12]_PHY 3929c26e454dSwdenk Define to the hardcoded PHY address which corresponds 39306e592385Swdenk to the given FEC; i. e. 3931c26e454dSwdenk #define CONFIG_FEC1_PHY 4 3932c26e454dSwdenk means that the PHY with address 4 is connected to FEC1 3933c26e454dSwdenk 3934c26e454dSwdenk When set to -1, means to probe for first available. 3935c26e454dSwdenk 3936c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR 3937c26e454dSwdenk The PHY does not have a RXERR line (RMII only). 3938c26e454dSwdenk (so program the FEC to ignore it). 3939c26e454dSwdenk 3940c26e454dSwdenk- CONFIG_RMII 3941c26e454dSwdenk Enable RMII mode for all FECs. 3942c26e454dSwdenk Note that this is a global option, we can't 3943c26e454dSwdenk have one FEC in standard MII mode and another in RMII mode. 3944c26e454dSwdenk 39455cf91d6bSwdenk- CONFIG_CRC32_VERIFY 39465cf91d6bSwdenk Add a verify option to the crc32 command. 39475cf91d6bSwdenk The syntax is: 39485cf91d6bSwdenk 39495cf91d6bSwdenk => crc32 -v <address> <count> <crc32> 39505cf91d6bSwdenk 39515cf91d6bSwdenk Where address/count indicate a memory area 39525cf91d6bSwdenk and crc32 is the correct crc32 which the 39535cf91d6bSwdenk area should have. 39545cf91d6bSwdenk 395556523f12Swdenk- CONFIG_LOOPW 395656523f12Swdenk Add the "loopw" memory command. This only takes effect if 3957602ad3b3SJon Loeliger the memory commands are activated globally (CONFIG_CMD_MEM). 395856523f12Swdenk 39597b466641Sstroese- CONFIG_MX_CYCLIC 39607b466641Sstroese Add the "mdc" and "mwc" memory commands. These are cyclic 39617b466641Sstroese "md/mw" commands. 39627b466641Sstroese Examples: 39637b466641Sstroese 39647b466641Sstroese => mdc.b 10 4 500 39657b466641Sstroese This command will print 4 bytes (10,11,12,13) each 500 ms. 39667b466641Sstroese 39677b466641Sstroese => mwc.l 100 12345678 10 39687b466641Sstroese This command will write 12345678 to address 100 all 10 ms. 39697b466641Sstroese 39707b466641Sstroese This only takes effect if the memory commands are activated 3971602ad3b3SJon Loeliger globally (CONFIG_CMD_MEM). 39727b466641Sstroese 39738aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT 3974afc1ce82SMacpaul Lin [ARM, NDS32, MIPS only] If this variable is defined, then certain 3975e03f3169SWolfgang Denk low level initializations (like setting up the memory 3976e03f3169SWolfgang Denk controller) are omitted and/or U-Boot does not 3977e03f3169SWolfgang Denk relocate itself into RAM. 39788aa1a2d1Swdenk 3979e03f3169SWolfgang Denk Normally this variable MUST NOT be defined. The only 3980e03f3169SWolfgang Denk exception is when U-Boot is loaded (to RAM) by some 3981e03f3169SWolfgang Denk other boot loader or by a debugger which performs 3982e03f3169SWolfgang Denk these initializations itself. 39838aa1a2d1Swdenk 3984401bb30bSAneesh V- CONFIG_SPL_BUILD 3985df81238bSMagnus Lilja Modifies the behaviour of start.S when compiling a loader 3986df81238bSMagnus Lilja that is executed before the actual U-Boot. E.g. when 3987df81238bSMagnus Lilja compiling a NAND SPL. 3988400558b5Swdenk 39894213fc29SSimon Glass- CONFIG_ARCH_MAP_SYSMEM 39904213fc29SSimon Glass Generally U-Boot (and in particular the md command) uses 39914213fc29SSimon Glass effective address. It is therefore not necessary to regard 39924213fc29SSimon Glass U-Boot address as virtual addresses that need to be translated 39934213fc29SSimon Glass to physical addresses. However, sandbox requires this, since 39944213fc29SSimon Glass it maintains its own little RAM buffer which contains all 39954213fc29SSimon Glass addressable memory. This option causes some memory accesses 39964213fc29SSimon Glass to be mapped through map_sysmem() / unmap_sysmem(). 39974213fc29SSimon Glass 3998d8834a13SMatthias Weisser- CONFIG_USE_ARCH_MEMCPY 3999d8834a13SMatthias Weisser CONFIG_USE_ARCH_MEMSET 4000d8834a13SMatthias Weisser If these options are used a optimized version of memcpy/memset will 4001d8834a13SMatthias Weisser be used if available. These functions may be faster under some 4002d8834a13SMatthias Weisser conditions but may increase the binary size. 4003d8834a13SMatthias Weisser 4004588a13f7SSimon Glass- CONFIG_X86_RESET_VECTOR 4005588a13f7SSimon Glass If defined, the x86 reset vector code is included. This is not 4006588a13f7SSimon Glass needed when U-Boot is running from Coreboot. 4007b16f521aSGabe Black 4008fc33705eSMark Jackson- CONFIG_SYS_MPUCLK 4009fc33705eSMark Jackson Defines the MPU clock speed (in MHz). 4010fc33705eSMark Jackson 4011fc33705eSMark Jackson NOTE : currently only supported on AM335x platforms. 40125b5ece9eSGabe Black 4013f2717b47STimur TabiFreescale QE/FMAN Firmware Support: 4014f2717b47STimur Tabi----------------------------------- 4015f2717b47STimur Tabi 4016f2717b47STimur TabiThe Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the 4017f2717b47STimur Tabiloading of "firmware", which is encoded in the QE firmware binary format. 4018f2717b47STimur TabiThis firmware often needs to be loaded during U-Boot booting, so macros 4019f2717b47STimur Tabiare used to identify the storage device (NOR flash, SPI, etc) and the address 4020f2717b47STimur Tabiwithin that device. 4021f2717b47STimur Tabi 4022f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_ADDR 4023f2717b47STimur Tabi The address in the storage device where the firmware is located. The 4024f2717b47STimur Tabi meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro 4025f2717b47STimur Tabi is also specified. 4026f2717b47STimur Tabi 4027f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_LENGTH 4028f2717b47STimur Tabi The maximum possible size of the firmware. The firmware binary format 4029f2717b47STimur Tabi has a field that specifies the actual size of the firmware, but it 4030f2717b47STimur Tabi might not be possible to read any part of the firmware unless some 4031f2717b47STimur Tabi local storage is allocated to hold the entire firmware first. 4032f2717b47STimur Tabi 4033f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NOR 4034f2717b47STimur Tabi Specifies that QE/FMAN firmware is located in NOR flash, mapped as 4035f2717b47STimur Tabi normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the 4036f2717b47STimur Tabi virtual address in NOR flash. 4037f2717b47STimur Tabi 4038f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NAND 4039f2717b47STimur Tabi Specifies that QE/FMAN firmware is located in NAND flash. 4040f2717b47STimur Tabi CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash. 4041f2717b47STimur Tabi 4042f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_MMC 4043f2717b47STimur Tabi Specifies that QE/FMAN firmware is located on the primary SD/MMC 4044f2717b47STimur Tabi device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device. 4045f2717b47STimur Tabi 4046f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH 4047f2717b47STimur Tabi Specifies that QE/FMAN firmware is located on the primary SPI 4048f2717b47STimur Tabi device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device. 4049f2717b47STimur Tabi 4050292dc6c5SLiu Gang- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE 4051292dc6c5SLiu Gang Specifies that QE/FMAN firmware is located in the remote (master) 4052292dc6c5SLiu Gang memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which 4053fc54c7faSLiu Gang can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound 4054fc54c7faSLiu Gang window->master inbound window->master LAW->the ucode address in 4055fc54c7faSLiu Gang master's memory space. 4056f2717b47STimur Tabi 4057c609719bSwdenkBuilding the Software: 4058c609719bSwdenk====================== 4059c609719bSwdenk 4060218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments 4061218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support 4062218ca724SWolfgang Denkall possibly existing versions of cross development tools in all 4063218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we 4064218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK) 4065218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot. 4066c609719bSwdenk 4067218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you 4068218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case, 4069218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell. 4070218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are 4071218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter: 4072c609719bSwdenk 4073218ca724SWolfgang Denk $ CROSS_COMPILE=ppc_4xx- 4074218ca724SWolfgang Denk $ export CROSS_COMPILE 4075c609719bSwdenk 40762f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in 40772f8d396bSPeter Tyser the tools directory you can use the MinGW toolchain 40782f8d396bSPeter Tyser (http://www.mingw.org). Set your HOST tools to the MinGW 40792f8d396bSPeter Tyser toolchain and execute 'make tools'. For example: 40802f8d396bSPeter Tyser 40812f8d396bSPeter Tyser $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools 40822f8d396bSPeter Tyser 40832f8d396bSPeter Tyser Binaries such as tools/mkimage.exe will be created which can 40842f8d396bSPeter Tyser be executed on computers running Windows. 40852f8d396bSPeter Tyser 4086c609719bSwdenkU-Boot is intended to be simple to build. After installing the 4087c609719bSwdenksources you must configure U-Boot for one specific board type. This 4088c609719bSwdenkis done by typing: 4089c609719bSwdenk 4090c609719bSwdenk make NAME_config 4091c609719bSwdenk 4092218ca724SWolfgang Denkwhere "NAME_config" is the name of one of the existing configu- 40934d675ae6SMichael Jonesrations; see boards.cfg for supported names. 409454387ac9Swdenk 4095c609719bSwdenkNote: for some board special configuration names may exist; check if 4096c609719bSwdenk additional information is available from the board vendor; for 40972729af9dSwdenk instance, the TQM823L systems are available without (standard) 40982729af9dSwdenk or with LCD support. You can select such additional "features" 409911ccc33fSMarcel Ziswiler when choosing the configuration, i. e. 4100c609719bSwdenk 41012729af9dSwdenk make TQM823L_config 41022729af9dSwdenk - will configure for a plain TQM823L, i. e. no LCD support 4103c609719bSwdenk 4104c609719bSwdenk make TQM823L_LCD_config 4105c609719bSwdenk - will configure for a TQM823L with U-Boot console on LCD 4106c609719bSwdenk 4107c609719bSwdenk etc. 4108c609719bSwdenk 4109c609719bSwdenk 4110c609719bSwdenkFinally, type "make all", and you should get some working U-Boot 41117152b1d0Swdenkimages ready for download to / installation on your system: 4112c609719bSwdenk 4113c609719bSwdenk- "u-boot.bin" is a raw binary image 4114c609719bSwdenk- "u-boot" is an image in ELF binary format 4115c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format 4116c609719bSwdenk 4117baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved 4118baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change 4119baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory: 4120baf31249SMarian Balakowicz 4121baf31249SMarian Balakowicz1. Add O= to the make command line invocations: 4122baf31249SMarian Balakowicz 4123baf31249SMarian Balakowicz make O=/tmp/build distclean 4124baf31249SMarian Balakowicz make O=/tmp/build NAME_config 4125baf31249SMarian Balakowicz make O=/tmp/build all 4126baf31249SMarian Balakowicz 4127baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location: 4128baf31249SMarian Balakowicz 4129baf31249SMarian Balakowicz export BUILD_DIR=/tmp/build 4130baf31249SMarian Balakowicz make distclean 4131baf31249SMarian Balakowicz make NAME_config 4132baf31249SMarian Balakowicz make all 4133baf31249SMarian Balakowicz 4134baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment 4135baf31249SMarian Balakowiczvariable. 4136baf31249SMarian Balakowicz 4137c609719bSwdenk 4138c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so 4139c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of 4140c609719bSwdenknative "make". 4141c609719bSwdenk 4142c609719bSwdenk 4143c609719bSwdenkIf the system board that you have is not listed, then you will need 4144c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these 4145c609719bSwdenksteps: 4146c609719bSwdenk 4147c609719bSwdenk1. Add a new configuration option for your board to the toplevel 41484d675ae6SMichael Jones "boards.cfg" file, using the existing entries as examples. 41494d675ae6SMichael Jones Follow the instructions there to keep the boards in order. 4150c609719bSwdenk2. Create a new directory to hold your board specific code. Add any 415185ec0bccSwdenk files you need. In your board directory, you will need at least 415285ec0bccSwdenk the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds". 415385ec0bccSwdenk3. Create a new configuration file "include/configs/<board>.h" for 415485ec0bccSwdenk your board 4155c609719bSwdenk3. If you're porting U-Boot to a new CPU, then also create a new 4156c609719bSwdenk directory to hold your CPU specific code. Add any files you need. 415785ec0bccSwdenk4. Run "make <board>_config" with your new name. 4158c609719bSwdenk5. Type "make", and you should get a working "u-boot.srec" file 4159c609719bSwdenk to be installed on your target system. 416085ec0bccSwdenk6. Debug and solve any problems that might arise. 4161c609719bSwdenk [Of course, this last step is much harder than it sounds.] 4162c609719bSwdenk 4163c609719bSwdenk 4164c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.: 4165c609719bSwdenk============================================================== 4166c609719bSwdenk 4167c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board 4168c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to 4169c609719bSwdenkprovide feedback to the other developers. The feedback normally takes 4170c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest 4171218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources. 4172c609719bSwdenk 4173c609719bSwdenkBut before you submit such a patch, please verify that your modifi- 4174c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of 4175c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so, 4176c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot 4177c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can 41787152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE' 4179218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools 4180218ca724SWolfgang Denkyou can type 4181c609719bSwdenk 4182c609719bSwdenk CROSS_COMPILE=ppc_8xx- MAKEALL 4183c609719bSwdenk 4184c609719bSwdenkor to build on a native PowerPC system you can type 4185c609719bSwdenk 4186c609719bSwdenk CROSS_COMPILE=' ' MAKEALL 4187c609719bSwdenk 4188218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build 4189218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by 4190218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target 4191218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and 4192218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default 4193218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment 4194218ca724SWolfgang Denkvariable. For example: 4195baf31249SMarian Balakowicz 4196baf31249SMarian Balakowicz export BUILD_DIR=/tmp/build 4197baf31249SMarian Balakowicz export MAKEALL_LOGDIR=/tmp/log 4198baf31249SMarian Balakowicz CROSS_COMPILE=ppc_8xx- MAKEALL 4199baf31249SMarian Balakowicz 4200218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build, 4201218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean 4202218ca724SWolfgang Denkduring the whole build process. 4203baf31249SMarian Balakowicz 4204baf31249SMarian Balakowicz 4205c609719bSwdenkSee also "U-Boot Porting Guide" below. 4206c609719bSwdenk 4207c609719bSwdenk 4208c609719bSwdenkMonitor Commands - Overview: 4209c609719bSwdenk============================ 4210c609719bSwdenk 4211c609719bSwdenkgo - start application at address 'addr' 4212c609719bSwdenkrun - run commands in an environment variable 4213c609719bSwdenkbootm - boot application image from memory 4214c609719bSwdenkbootp - boot image via network using BootP/TFTP protocol 421544f074c7SMarek Vasutbootz - boot zImage from memory 4216c609719bSwdenktftpboot- boot image via network using TFTP protocol 4217c609719bSwdenk and env variables "ipaddr" and "serverip" 4218c609719bSwdenk (and eventually "gatewayip") 42191fb7cd49SSimon Glasstftpput - upload a file via network using TFTP protocol 4220c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol 4221c609719bSwdenkdiskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd' 4222c609719bSwdenkloads - load S-Record file over serial line 4223c609719bSwdenkloadb - load binary file over serial line (kermit mode) 4224c609719bSwdenkmd - memory display 4225c609719bSwdenkmm - memory modify (auto-incrementing) 4226c609719bSwdenknm - memory modify (constant address) 4227c609719bSwdenkmw - memory write (fill) 4228c609719bSwdenkcp - memory copy 4229c609719bSwdenkcmp - memory compare 4230c609719bSwdenkcrc32 - checksum calculation 42310f89c54bSPeter Tyseri2c - I2C sub-system 4232c609719bSwdenksspi - SPI utility commands 4233c609719bSwdenkbase - print or set address offset 4234c609719bSwdenkprintenv- print environment variables 4235c609719bSwdenksetenv - set environment variables 4236c609719bSwdenksaveenv - save environment variables to persistent storage 4237c609719bSwdenkprotect - enable or disable FLASH write protection 4238c609719bSwdenkerase - erase FLASH memory 4239c609719bSwdenkflinfo - print FLASH memory information 424010635afaSKarl O. Pincnand - NAND memory operations (see doc/README.nand) 4241c609719bSwdenkbdinfo - print Board Info structure 4242c609719bSwdenkiminfo - print header information for application image 4243c609719bSwdenkconinfo - print console devices and informations 4244c609719bSwdenkide - IDE sub-system 4245c609719bSwdenkloop - infinite loop on address range 424656523f12Swdenkloopw - infinite write loop on address range 4247c609719bSwdenkmtest - simple RAM test 4248c609719bSwdenkicache - enable or disable instruction cache 4249c609719bSwdenkdcache - enable or disable data cache 4250c609719bSwdenkreset - Perform RESET of the CPU 4251c609719bSwdenkecho - echo args to console 4252c609719bSwdenkversion - print monitor version 4253c609719bSwdenkhelp - print online help 4254c609719bSwdenk? - alias for 'help' 4255c609719bSwdenk 4256c609719bSwdenk 4257c609719bSwdenkMonitor Commands - Detailed Description: 4258c609719bSwdenk======================================== 4259c609719bSwdenk 4260c609719bSwdenkTODO. 4261c609719bSwdenk 4262c609719bSwdenkFor now: just type "help <command>". 4263c609719bSwdenk 4264c609719bSwdenk 4265c609719bSwdenkEnvironment Variables: 4266c609719bSwdenk====================== 4267c609719bSwdenk 4268c609719bSwdenkU-Boot supports user configuration using Environment Variables which 4269c609719bSwdenkcan be made persistent by saving to Flash memory. 4270c609719bSwdenk 4271c609719bSwdenkEnvironment Variables are set using "setenv", printed using 4272c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv" 4273c609719bSwdenkwithout a value can be used to delete a variable from the 4274c609719bSwdenkenvironment. As long as you don't save the environment you are 4275c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the 4276c609719bSwdenkenvironment is erased by accident, a default environment is provided. 4277c609719bSwdenk 4278c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables. 4279c96f86eeSWolfgang Denk 4280c96f86eeSWolfgang DenkList of environment variables (most likely not complete): 4281c609719bSwdenk 4282c609719bSwdenk baudrate - see CONFIG_BAUDRATE 4283c609719bSwdenk 4284c609719bSwdenk bootdelay - see CONFIG_BOOTDELAY 4285c609719bSwdenk 4286c609719bSwdenk bootcmd - see CONFIG_BOOTCOMMAND 4287c609719bSwdenk 4288c609719bSwdenk bootargs - Boot arguments when booting an RTOS image 4289c609719bSwdenk 4290c609719bSwdenk bootfile - Name of the image to load with TFTP 4291c609719bSwdenk 42927d721e34SBartlomiej Sieka bootm_low - Memory range available for image processing in the bootm 42937d721e34SBartlomiej Sieka command can be restricted. This variable is given as 42947d721e34SBartlomiej Sieka a hexadecimal number and defines lowest address allowed 42957d721e34SBartlomiej Sieka for use by the bootm command. See also "bootm_size" 42967d721e34SBartlomiej Sieka environment variable. Address defined by "bootm_low" is 42977d721e34SBartlomiej Sieka also the base of the initial memory mapping for the Linux 4298c3624e6eSGrant Likely kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and 4299c3624e6eSGrant Likely bootm_mapsize. 4300c3624e6eSGrant Likely 4301c3624e6eSGrant Likely bootm_mapsize - Size of the initial memory mapping for the Linux kernel. 4302c3624e6eSGrant Likely This variable is given as a hexadecimal number and it 4303c3624e6eSGrant Likely defines the size of the memory region starting at base 4304c3624e6eSGrant Likely address bootm_low that is accessible by the Linux kernel 4305c3624e6eSGrant Likely during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used 4306c3624e6eSGrant Likely as the default value if it is defined, and bootm_size is 4307c3624e6eSGrant Likely used otherwise. 43087d721e34SBartlomiej Sieka 43097d721e34SBartlomiej Sieka bootm_size - Memory range available for image processing in the bootm 43107d721e34SBartlomiej Sieka command can be restricted. This variable is given as 43117d721e34SBartlomiej Sieka a hexadecimal number and defines the size of the region 43127d721e34SBartlomiej Sieka allowed for use by the bootm command. See also "bootm_low" 43137d721e34SBartlomiej Sieka environment variable. 43147d721e34SBartlomiej Sieka 43154bae9090SBartlomiej Sieka updatefile - Location of the software update file on a TFTP server, used 43164bae9090SBartlomiej Sieka by the automatic software update feature. Please refer to 43174bae9090SBartlomiej Sieka documentation in doc/README.update for more details. 43184bae9090SBartlomiej Sieka 4319c609719bSwdenk autoload - if set to "no" (any string beginning with 'n'), 4320c609719bSwdenk "bootp" will just load perform a lookup of the 4321c609719bSwdenk configuration from the BOOTP server, but not try to 4322c609719bSwdenk load any image using TFTP 4323c609719bSwdenk 4324c609719bSwdenk autostart - if set to "yes", an image loaded using the "bootp", 4325c609719bSwdenk "rarpboot", "tftpboot" or "diskboot" commands will 4326c609719bSwdenk be automatically started (by internally calling 4327c609719bSwdenk "bootm") 4328c609719bSwdenk 43294a6fd34bSwdenk If set to "no", a standalone image passed to the 43304a6fd34bSwdenk "bootm" command will be copied to the load address 43314a6fd34bSwdenk (and eventually uncompressed), but NOT be started. 43324a6fd34bSwdenk This can be used to load and uncompress arbitrary 43334a6fd34bSwdenk data. 43344a6fd34bSwdenk 4335a28afca5SDavid A. Long fdt_high - if set this restricts the maximum address that the 4336a28afca5SDavid A. Long flattened device tree will be copied into upon boot. 4337fa34f6b2SShawn Guo For example, if you have a system with 1 GB memory 4338fa34f6b2SShawn Guo at physical address 0x10000000, while Linux kernel 4339fa34f6b2SShawn Guo only recognizes the first 704 MB as low memory, you 4340fa34f6b2SShawn Guo may need to set fdt_high as 0x3C000000 to have the 4341fa34f6b2SShawn Guo device tree blob be copied to the maximum address 4342fa34f6b2SShawn Guo of the 704 MB low memory, so that Linux kernel can 4343fa34f6b2SShawn Guo access it during the boot procedure. 4344fa34f6b2SShawn Guo 4345a28afca5SDavid A. Long If this is set to the special value 0xFFFFFFFF then 4346a28afca5SDavid A. Long the fdt will not be copied at all on boot. For this 4347a28afca5SDavid A. Long to work it must reside in writable memory, have 4348a28afca5SDavid A. Long sufficient padding on the end of it for u-boot to 4349a28afca5SDavid A. Long add the information it needs into it, and the memory 4350a28afca5SDavid A. Long must be accessible by the kernel. 4351a28afca5SDavid A. Long 4352eea63e05SSimon Glass fdtcontroladdr- if set this is the address of the control flattened 4353eea63e05SSimon Glass device tree used by U-Boot when CONFIG_OF_CONTROL is 4354eea63e05SSimon Glass defined. 4355eea63e05SSimon Glass 435617ea1177Swdenk i2cfast - (PPC405GP|PPC405EP only) 435717ea1177Swdenk if set to 'y' configures Linux I2C driver for fast 435817ea1177Swdenk mode (400kHZ). This environment variable is used in 435917ea1177Swdenk initialization code. So, for changes to be effective 436017ea1177Swdenk it must be saved and board must be reset. 436117ea1177Swdenk 4362c609719bSwdenk initrd_high - restrict positioning of initrd images: 4363c609719bSwdenk If this variable is not set, initrd images will be 4364c609719bSwdenk copied to the highest possible address in RAM; this 4365c609719bSwdenk is usually what you want since it allows for 4366c609719bSwdenk maximum initrd size. If for some reason you want to 4367c609719bSwdenk make sure that the initrd image is loaded below the 43686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BOOTMAPSZ limit, you can set this environment 4369c609719bSwdenk variable to a value of "no" or "off" or "0". 4370c609719bSwdenk Alternatively, you can set it to a maximum upper 4371c609719bSwdenk address to use (U-Boot will still check that it 4372c609719bSwdenk does not overwrite the U-Boot stack and data). 4373c609719bSwdenk 4374c609719bSwdenk For instance, when you have a system with 16 MB 43757152b1d0Swdenk RAM, and want to reserve 4 MB from use by Linux, 4376c609719bSwdenk you can do this by adding "mem=12M" to the value of 4377c609719bSwdenk the "bootargs" variable. However, now you must make 43787152b1d0Swdenk sure that the initrd image is placed in the first 4379c609719bSwdenk 12 MB as well - this can be done with 4380c609719bSwdenk 4381c609719bSwdenk setenv initrd_high 00c00000 4382c609719bSwdenk 438338b99261Swdenk If you set initrd_high to 0xFFFFFFFF, this is an 438438b99261Swdenk indication to U-Boot that all addresses are legal 438538b99261Swdenk for the Linux kernel, including addresses in flash 438638b99261Swdenk memory. In this case U-Boot will NOT COPY the 438738b99261Swdenk ramdisk at all. This may be useful to reduce the 438838b99261Swdenk boot time on your system, but requires that this 438938b99261Swdenk feature is supported by your Linux kernel. 439038b99261Swdenk 4391c609719bSwdenk ipaddr - IP address; needed for tftpboot command 4392c609719bSwdenk 4393c609719bSwdenk loadaddr - Default load address for commands like "bootp", 4394dc7c9a1aSwdenk "rarpboot", "tftpboot", "loadb" or "diskboot" 4395c609719bSwdenk 4396c609719bSwdenk loads_echo - see CONFIG_LOADS_ECHO 4397c609719bSwdenk 4398c609719bSwdenk serverip - TFTP server IP address; needed for tftpboot command 4399c609719bSwdenk 4400c609719bSwdenk bootretry - see CONFIG_BOOT_RETRY_TIME 4401c609719bSwdenk 4402c609719bSwdenk bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR 4403c609719bSwdenk 4404c609719bSwdenk bootstopkey - see CONFIG_AUTOBOOT_STOP_STR 4405c609719bSwdenk 4406e2a53458SMike Frysinger ethprime - controls which interface is used first. 4407a3d991bdSwdenk 4408e2a53458SMike Frysinger ethact - controls which interface is currently active. 4409e2a53458SMike Frysinger For example you can do the following 4410a3d991bdSwdenk 441148690d80SHeiko Schocher => setenv ethact FEC 441248690d80SHeiko Schocher => ping 192.168.0.1 # traffic sent on FEC 441348690d80SHeiko Schocher => setenv ethact SCC 441448690d80SHeiko Schocher => ping 10.0.0.1 # traffic sent on SCC 4415a3d991bdSwdenk 4416e1692577SMatthias Fuchs ethrotate - When set to "no" U-Boot does not go through all 4417e1692577SMatthias Fuchs available network interfaces. 4418e1692577SMatthias Fuchs It just stays at the currently selected interface. 4419e1692577SMatthias Fuchs 4420a3d991bdSwdenk netretry - When set to "no" each network operation will 4421a3d991bdSwdenk either succeed or fail without retrying. 44226e592385Swdenk When set to "once" the network operation will 44236e592385Swdenk fail when all the available network interfaces 44246e592385Swdenk are tried once without success. 4425a3d991bdSwdenk Useful on scripts which control the retry operation 4426a3d991bdSwdenk themselves. 4427a3d991bdSwdenk 4428b4e2f89dSJean-Christophe PLAGNIOL-VILLARD npe_ucode - set load address for the NPE microcode 4429a1cf027aSJean-Christophe PLAGNIOL-VILLARD 443028cb9375SWolfgang Denk tftpsrcport - If this is set, the value is used for TFTP's 4431ecb0ccd9SWolfgang Denk UDP source port. 4432ecb0ccd9SWolfgang Denk 443328cb9375SWolfgang Denk tftpdstport - If this is set, the value is used for TFTP's UDP 443428cb9375SWolfgang Denk destination port instead of the Well Know Port 69. 443528cb9375SWolfgang Denk 4436c96f86eeSWolfgang Denk tftpblocksize - Block size to use for TFTP transfers; if not set, 4437c96f86eeSWolfgang Denk we use the TFTP server's default block size 4438c96f86eeSWolfgang Denk 4439c96f86eeSWolfgang Denk tftptimeout - Retransmission timeout for TFTP packets (in milli- 4440c96f86eeSWolfgang Denk seconds, minimum value is 1000 = 1 second). Defines 4441c96f86eeSWolfgang Denk when a packet is considered to be lost so it has to 4442c96f86eeSWolfgang Denk be retransmitted. The default is 5000 = 5 seconds. 4443c96f86eeSWolfgang Denk Lowering this value may make downloads succeed 4444c96f86eeSWolfgang Denk faster in networks with high packet loss rates or 4445c96f86eeSWolfgang Denk with unreliable TFTP servers. 4446c96f86eeSWolfgang Denk 4447a3d991bdSwdenk vlan - When set to a value < 4095 the traffic over 444811ccc33fSMarcel Ziswiler Ethernet is encapsulated/received over 802.1q 4449a3d991bdSwdenk VLAN tagged frames. 4450c609719bSwdenk 4451dc0b7b0eSJason HobbsThe following image location variables contain the location of images 4452dc0b7b0eSJason Hobbsused in booting. The "Image" column gives the role of the image and is 4453dc0b7b0eSJason Hobbsnot an environment variable name. The other columns are environment 4454dc0b7b0eSJason Hobbsvariable names. "File Name" gives the name of the file on a TFTP 4455dc0b7b0eSJason Hobbsserver, "RAM Address" gives the location in RAM the image will be 4456dc0b7b0eSJason Hobbsloaded to, and "Flash Location" gives the image's address in NOR 4457dc0b7b0eSJason Hobbsflash or offset in NAND flash. 4458dc0b7b0eSJason Hobbs 4459dc0b7b0eSJason Hobbs*Note* - these variables don't have to be defined for all boards, some 4460dc0b7b0eSJason Hobbsboards currenlty use other variables for these purposes, and some 4461dc0b7b0eSJason Hobbsboards use these variables for other purposes. 4462dc0b7b0eSJason Hobbs 4463dc0b7b0eSJason HobbsImage File Name RAM Address Flash Location 4464dc0b7b0eSJason Hobbs----- --------- ----------- -------------- 4465dc0b7b0eSJason Hobbsu-boot u-boot u-boot_addr_r u-boot_addr 4466dc0b7b0eSJason HobbsLinux kernel bootfile kernel_addr_r kernel_addr 4467dc0b7b0eSJason Hobbsdevice tree blob fdtfile fdt_addr_r fdt_addr 4468dc0b7b0eSJason Hobbsramdisk ramdiskfile ramdisk_addr_r ramdisk_addr 4469dc0b7b0eSJason Hobbs 4470c609719bSwdenkThe following environment variables may be used and automatically 4471c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"), 4472c609719bSwdenkdepending the information provided by your boot server: 4473c609719bSwdenk 4474c609719bSwdenk bootfile - see above 4475c609719bSwdenk dnsip - IP address of your Domain Name Server 4476fe389a82Sstroese dnsip2 - IP address of your secondary Domain Name Server 4477c609719bSwdenk gatewayip - IP address of the Gateway (Router) to use 4478c609719bSwdenk hostname - Target hostname 4479c609719bSwdenk ipaddr - see above 4480c609719bSwdenk netmask - Subnet Mask 4481c609719bSwdenk rootpath - Pathname of the root filesystem on the NFS server 4482c609719bSwdenk serverip - see above 4483c609719bSwdenk 4484c609719bSwdenk 4485c609719bSwdenkThere are two special Environment Variables: 4486c609719bSwdenk 4487c609719bSwdenk serial# - contains hardware identification information such 4488c609719bSwdenk as type string and/or serial number 4489c609719bSwdenk ethaddr - Ethernet address 4490c609719bSwdenk 4491c609719bSwdenkThese variables can be set only once (usually during manufacturing of 4492c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables 4493c609719bSwdenkonce they have been set once. 4494c609719bSwdenk 4495c609719bSwdenk 4496c1551ea8SstroeseFurther special Environment Variables: 4497c1551ea8Sstroese 4498c1551ea8Sstroese ver - Contains the U-Boot version string as printed 4499c1551ea8Sstroese with the "version" command. This variable is 4500c1551ea8Sstroese readonly (see CONFIG_VERSION_VARIABLE). 4501c1551ea8Sstroese 4502c1551ea8Sstroese 4503c609719bSwdenkPlease note that changes to some configuration parameters may take 4504c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-). 4505c609719bSwdenk 4506c609719bSwdenk 4507170ab110SJoe HershbergerCallback functions for environment variables: 4508170ab110SJoe Hershberger--------------------------------------------- 4509170ab110SJoe Hershberger 4510170ab110SJoe HershbergerFor some environment variables, the behavior of u-boot needs to change 4511170ab110SJoe Hershbergerwhen their values are changed. This functionailty allows functions to 4512170ab110SJoe Hershbergerbe associated with arbitrary variables. On creation, overwrite, or 4513170ab110SJoe Hershbergerdeletion, the callback will provide the opportunity for some side 4514170ab110SJoe Hershbergereffect to happen or for the change to be rejected. 4515170ab110SJoe Hershberger 4516170ab110SJoe HershbergerThe callbacks are named and associated with a function using the 4517170ab110SJoe HershbergerU_BOOT_ENV_CALLBACK macro in your board or driver code. 4518170ab110SJoe Hershberger 4519170ab110SJoe HershbergerThese callbacks are associated with variables in one of two ways. The 4520170ab110SJoe Hershbergerstatic list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC 4521170ab110SJoe Hershbergerin the board configuration to a string that defines a list of 4522170ab110SJoe Hershbergerassociations. The list must be in the following format: 4523170ab110SJoe Hershberger 4524170ab110SJoe Hershberger entry = variable_name[:callback_name] 4525170ab110SJoe Hershberger list = entry[,list] 4526170ab110SJoe Hershberger 4527170ab110SJoe HershbergerIf the callback name is not specified, then the callback is deleted. 4528170ab110SJoe HershbergerSpaces are also allowed anywhere in the list. 4529170ab110SJoe Hershberger 4530170ab110SJoe HershbergerCallbacks can also be associated by defining the ".callbacks" variable 4531170ab110SJoe Hershbergerwith the same list format above. Any association in ".callbacks" will 4532170ab110SJoe Hershbergeroverride any association in the static list. You can define 4533170ab110SJoe HershbergerCONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the 4534170ab110SJoe Hershberger".callbacks" envirnoment variable in the default or embedded environment. 4535170ab110SJoe Hershberger 4536170ab110SJoe Hershberger 4537f07771ccSwdenkCommand Line Parsing: 4538f07771ccSwdenk===================== 4539f07771ccSwdenk 4540f07771ccSwdenkThere are two different command line parsers available with U-Boot: 45417152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell: 4542f07771ccSwdenk 4543f07771ccSwdenkOld, simple command line parser: 4544f07771ccSwdenk-------------------------------- 4545f07771ccSwdenk 4546f07771ccSwdenk- supports environment variables (through setenv / saveenv commands) 4547f07771ccSwdenk- several commands on one line, separated by ';' 4548fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax 4549f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\', 4550f07771ccSwdenk for example: 4551fe126d8bSWolfgang Denk setenv bootcmd bootm \${address} 4552f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example: 4553f07771ccSwdenk setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off' 4554f07771ccSwdenk 4555f07771ccSwdenkHush shell: 4556f07771ccSwdenk----------- 4557f07771ccSwdenk 4558f07771ccSwdenk- similar to Bourne shell, with control structures like 4559f07771ccSwdenk if...then...else...fi, for...do...done; while...do...done, 4560f07771ccSwdenk until...do...done, ... 4561f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv 4562f07771ccSwdenk commands) and local shell variables (through standard shell syntax 4563f07771ccSwdenk "name=value"); only environment variables can be used with "run" 4564f07771ccSwdenk command 4565f07771ccSwdenk 4566f07771ccSwdenkGeneral rules: 4567f07771ccSwdenk-------------- 4568f07771ccSwdenk 4569f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run" 4570f07771ccSwdenk command) contains several commands separated by semicolon, and 4571f07771ccSwdenk one of these commands fails, then the remaining commands will be 4572f07771ccSwdenk executed anyway. 4573f07771ccSwdenk 4574f07771ccSwdenk(2) If you execute several variables with one call to run (i. e. 457511ccc33fSMarcel Ziswiler calling run with a list of variables as arguments), any failing 4576f07771ccSwdenk command will cause "run" to terminate, i. e. the remaining 4577f07771ccSwdenk variables are not executed. 4578f07771ccSwdenk 4579c609719bSwdenkNote for Redundant Ethernet Interfaces: 4580c609719bSwdenk======================================= 4581c609719bSwdenk 458211ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports 4583c609719bSwdenksuch configurations and is capable of automatic selection of a 45847152b1d0Swdenk"working" interface when needed. MAC assignment works as follows: 4585c609719bSwdenk 4586c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding 4587c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0), 4588c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ... 4589c609719bSwdenk 4590c609719bSwdenkIf the network interface stores some valid MAC address (for instance 4591c609719bSwdenkin SROM), this is used as default address if there is NO correspon- 4592c609719bSwdenkding setting in the environment; if the corresponding environment 4593c609719bSwdenkvariable is set, this overrides the settings in the card; that means: 4594c609719bSwdenk 4595c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the 4596c609719bSwdenk environment, the SROM's address is used. 4597c609719bSwdenk 4598c609719bSwdenko If there is no valid address in the SROM, and a definition in the 4599c609719bSwdenk environment exists, then the value from the environment variable is 4600c609719bSwdenk used. 4601c609719bSwdenk 4602c609719bSwdenko If both the SROM and the environment contain a MAC address, and 4603c609719bSwdenk both addresses are the same, this MAC address is used. 4604c609719bSwdenk 4605c609719bSwdenko If both the SROM and the environment contain a MAC address, and the 4606c609719bSwdenk addresses differ, the value from the environment is used and a 4607c609719bSwdenk warning is printed. 4608c609719bSwdenk 4609c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error 4610c609719bSwdenk is raised. 4611c609719bSwdenk 4612ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses 4613ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process. This 4614ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable. 4615ecee9324SBen WarrenThe naming convention is as follows: 4616ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc. 4617c609719bSwdenk 4618c609719bSwdenkImage Formats: 4619c609719bSwdenk============== 4620c609719bSwdenk 46213310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on) 46223310c549SMarian Balakowiczimages in two formats: 46233310c549SMarian Balakowicz 46243310c549SMarian BalakowiczNew uImage format (FIT) 46253310c549SMarian Balakowicz----------------------- 46263310c549SMarian Balakowicz 46273310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar 46283310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple 46293310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by 46303310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory. 46313310c549SMarian Balakowicz 46323310c549SMarian Balakowicz 46333310c549SMarian BalakowiczOld uImage format 46343310c549SMarian Balakowicz----------------- 46353310c549SMarian Balakowicz 46363310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything, 46373310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for 46383310c549SMarian Balakowiczdetails; basically, the header defines the following image properties: 4639c609719bSwdenk 4640c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD, 4641c609719bSwdenk 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks, 4642f5ed9e39SPeter Tyser LynxOS, pSOS, QNX, RTEMS, INTEGRITY; 4643f5ed9e39SPeter Tyser Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS, 4644f5ed9e39SPeter Tyser INTEGRITY). 46457b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86, 4646afc1ce82SMacpaul Lin IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit; 4647afc1ce82SMacpaul Lin Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC). 4648c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2) 4649c609719bSwdenk* Load Address 4650c609719bSwdenk* Entry Point 4651c609719bSwdenk* Image Name 4652c609719bSwdenk* Image Timestamp 4653c609719bSwdenk 4654c609719bSwdenkThe header is marked by a special Magic Number, and both the header 4655c609719bSwdenkand the data portions of the image are secured against corruption by 4656c609719bSwdenkCRC32 checksums. 4657c609719bSwdenk 4658c609719bSwdenk 4659c609719bSwdenkLinux Support: 4660c609719bSwdenk============== 4661c609719bSwdenk 4662c609719bSwdenkAlthough U-Boot should support any OS or standalone application 46637152b1d0Swdenkeasily, the main focus has always been on Linux during the design of 4664c609719bSwdenkU-Boot. 4665c609719bSwdenk 4666c609719bSwdenkU-Boot includes many features that so far have been part of some 4667c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any 4668c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image; 4669c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation 46707152b1d0Swdenkserves several purposes: 4671c609719bSwdenk 4672c609719bSwdenk- the same features can be used for other OS or standalone 4673c609719bSwdenk applications (for instance: using compressed images to reduce the 4674c609719bSwdenk Flash memory footprint) 4675c609719bSwdenk 4676c609719bSwdenk- it becomes much easier to port new Linux kernel versions because 46777152b1d0Swdenk lots of low-level, hardware dependent stuff are done by U-Boot 4678c609719bSwdenk 4679c609719bSwdenk- the same Linux kernel image can now be used with different "initrd" 4680c609719bSwdenk images; of course this also means that different kernel images can 4681c609719bSwdenk be run with the same "initrd". This makes testing easier (you don't 4682c609719bSwdenk have to build a new "zImage.initrd" Linux image when you just 4683c609719bSwdenk change a file in your "initrd"). Also, a field-upgrade of the 4684c609719bSwdenk software is easier now. 4685c609719bSwdenk 4686c609719bSwdenk 4687c609719bSwdenkLinux HOWTO: 4688c609719bSwdenk============ 4689c609719bSwdenk 4690c609719bSwdenkPorting Linux to U-Boot based systems: 4691c609719bSwdenk--------------------------------------- 4692c609719bSwdenk 4693c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to 4694c609719bSwdenkconfigure the Linux device drivers for use with your target hardware 4695c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to 4696c609719bSwdenkLinux :-). 4697c609719bSwdenk 4698a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot). 4699c609719bSwdenk 4700c609719bSwdenkJust make sure your machine specific header file (for instance 4701c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board 47021dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h, 47031dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value 47046d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR. 4705c609719bSwdenk 4706c609719bSwdenk 4707c609719bSwdenkConfiguring the Linux kernel: 4708c609719bSwdenk----------------------------- 4709c609719bSwdenk 4710c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root 4711c609719bSwdenkdevice (initial ramdisk, NFS) for your target system. 4712c609719bSwdenk 4713c609719bSwdenk 4714c609719bSwdenkBuilding a Linux Image: 4715c609719bSwdenk----------------------- 4716c609719bSwdenk 471724ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are 471824ee89b9Swdenknot used. If you use recent kernel source, a new build target 471924ee89b9Swdenk"uImage" will exist which automatically builds an image usable by 472024ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target, 472124ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a 472224ee89b9Swdenk100% compatible format. 4723c609719bSwdenk 4724c609719bSwdenkExample: 4725c609719bSwdenk 4726c609719bSwdenk make TQM850L_config 4727c609719bSwdenk make oldconfig 4728c609719bSwdenk make dep 472924ee89b9Swdenk make uImage 4730c609719bSwdenk 473124ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to 473224ee89b9Swdenkencapsulate a compressed Linux kernel image with header information, 473324ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing: 4734c609719bSwdenk 473524ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format): 473624ee89b9Swdenk 473724ee89b9Swdenk* convert the kernel into a raw binary image: 473824ee89b9Swdenk 473924ee89b9Swdenk ${CROSS_COMPILE}-objcopy -O binary \ 474024ee89b9Swdenk -R .note -R .comment \ 474124ee89b9Swdenk -S vmlinux linux.bin 474224ee89b9Swdenk 474324ee89b9Swdenk* compress the binary image: 474424ee89b9Swdenk 474524ee89b9Swdenk gzip -9 linux.bin 474624ee89b9Swdenk 474724ee89b9Swdenk* package compressed binary image for U-Boot: 474824ee89b9Swdenk 474924ee89b9Swdenk mkimage -A ppc -O linux -T kernel -C gzip \ 475024ee89b9Swdenk -a 0 -e 0 -n "Linux Kernel Image" \ 475124ee89b9Swdenk -d linux.bin.gz uImage 475224ee89b9Swdenk 475324ee89b9Swdenk 475424ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use 475524ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or 475624ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64 475724ee89b9Swdenkbyte header containing information about target architecture, 475824ee89b9Swdenkoperating system, image type, compression method, entry points, time 475924ee89b9Swdenkstamp, CRC32 checksums, etc. 476024ee89b9Swdenk 476124ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and 476224ee89b9Swdenkprint the header information, or to build new images. 4763c609719bSwdenk 4764c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information 4765c609719bSwdenkcontained in the header of an existing U-Boot image; this includes 4766c609719bSwdenkchecksum verification: 4767c609719bSwdenk 4768c609719bSwdenk tools/mkimage -l image 4769c609719bSwdenk -l ==> list image header information 4770c609719bSwdenk 4771c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image 4772c609719bSwdenkfrom a "data file" which is used as image payload: 4773c609719bSwdenk 4774c609719bSwdenk tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \ 4775c609719bSwdenk -n name -d data_file image 4776c609719bSwdenk -A ==> set architecture to 'arch' 4777c609719bSwdenk -O ==> set operating system to 'os' 4778c609719bSwdenk -T ==> set image type to 'type' 4779c609719bSwdenk -C ==> set compression type 'comp' 4780c609719bSwdenk -a ==> set load address to 'addr' (hex) 4781c609719bSwdenk -e ==> set entry point to 'ep' (hex) 4782c609719bSwdenk -n ==> set image name to 'name' 4783c609719bSwdenk -d ==> use image data from 'datafile' 4784c609719bSwdenk 478569459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load 478669459791Swdenkaddress (0x00000000), but the entry point address depends on the 478769459791Swdenkkernel version: 4788c609719bSwdenk 4789c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C, 479024ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000. 4791c609719bSwdenk 4792c609719bSwdenkSo a typical call to build a U-Boot image would read: 4793c609719bSwdenk 479424ee89b9Swdenk -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 479524ee89b9Swdenk > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \ 4796a47a12beSStefan Roese > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \ 479724ee89b9Swdenk > examples/uImage.TQM850L 479824ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 4799c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 4800c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 4801c609719bSwdenk Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 4802c609719bSwdenk Load Address: 0x00000000 480324ee89b9Swdenk Entry Point: 0x00000000 4804c609719bSwdenk 4805c609719bSwdenkTo verify the contents of the image (or check for corruption): 4806c609719bSwdenk 480724ee89b9Swdenk -> tools/mkimage -l examples/uImage.TQM850L 480824ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 4809c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 4810c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 4811c609719bSwdenk Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 4812c609719bSwdenk Load Address: 0x00000000 481324ee89b9Swdenk Entry Point: 0x00000000 4814c609719bSwdenk 4815c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade 4816c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this 4817c609719bSwdenkneeds more space in Flash, but boots much faster since it does not 4818c609719bSwdenkneed to be uncompressed: 4819c609719bSwdenk 4820a47a12beSStefan Roese -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz 482124ee89b9Swdenk -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 482224ee89b9Swdenk > -A ppc -O linux -T kernel -C none -a 0 -e 0 \ 4823a47a12beSStefan Roese > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \ 482424ee89b9Swdenk > examples/uImage.TQM850L-uncompressed 482524ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 4826c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 4827c609719bSwdenk Image Type: PowerPC Linux Kernel Image (uncompressed) 4828c609719bSwdenk Data Size: 792160 Bytes = 773.59 kB = 0.76 MB 4829c609719bSwdenk Load Address: 0x00000000 483024ee89b9Swdenk Entry Point: 0x00000000 4831c609719bSwdenk 4832c609719bSwdenk 4833c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file 4834c609719bSwdenkwhen your kernel is intended to use an initial ramdisk: 4835c609719bSwdenk 4836c609719bSwdenk -> tools/mkimage -n 'Simple Ramdisk Image' \ 4837c609719bSwdenk > -A ppc -O linux -T ramdisk -C gzip \ 4838c609719bSwdenk > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd 4839c609719bSwdenk Image Name: Simple Ramdisk Image 4840c609719bSwdenk Created: Wed Jan 12 14:01:50 2000 4841c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 4842c609719bSwdenk Data Size: 566530 Bytes = 553.25 kB = 0.54 MB 4843c609719bSwdenk Load Address: 0x00000000 4844c609719bSwdenk Entry Point: 0x00000000 4845c609719bSwdenk 4846c609719bSwdenk 4847c609719bSwdenkInstalling a Linux Image: 4848c609719bSwdenk------------------------- 4849c609719bSwdenk 4850c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface, 4851c609719bSwdenkyou must convert the image to S-Record format: 4852c609719bSwdenk 4853c609719bSwdenk objcopy -I binary -O srec examples/image examples/image.srec 4854c609719bSwdenk 4855c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot 4856c609719bSwdenkimage header, so the resulting S-Record file will be relative to 4857c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to 4858c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads' 4859c609719bSwdenkcommand. 4860c609719bSwdenk 4861c609719bSwdenkExample: install the image to address 0x40100000 (which on the 4862c609719bSwdenkTQM8xxL is in the first Flash bank): 4863c609719bSwdenk 4864c609719bSwdenk => erase 40100000 401FFFFF 4865c609719bSwdenk 4866c609719bSwdenk .......... done 4867c609719bSwdenk Erased 8 sectors 4868c609719bSwdenk 4869c609719bSwdenk => loads 40100000 4870c609719bSwdenk ## Ready for S-Record download ... 4871c609719bSwdenk ~>examples/image.srec 4872c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 12 13 ... 4873c609719bSwdenk ... 4874c609719bSwdenk 15989 15990 15991 15992 4875c609719bSwdenk [file transfer complete] 4876c609719bSwdenk [connected] 4877c609719bSwdenk ## Start Addr = 0x00000000 4878c609719bSwdenk 4879c609719bSwdenk 4880c609719bSwdenkYou can check the success of the download using the 'iminfo' command; 4881c609719bSwdenkthis includes a checksum verification so you can be sure no data 4882c609719bSwdenkcorruption happened: 4883c609719bSwdenk 4884c609719bSwdenk => imi 40100000 4885c609719bSwdenk 4886c609719bSwdenk ## Checking Image at 40100000 ... 4887c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 4888c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 4889c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 4890c609719bSwdenk Load Address: 00000000 4891c609719bSwdenk Entry Point: 0000000c 4892c609719bSwdenk Verifying Checksum ... OK 4893c609719bSwdenk 4894c609719bSwdenk 4895c609719bSwdenkBoot Linux: 4896c609719bSwdenk----------- 4897c609719bSwdenk 4898c609719bSwdenkThe "bootm" command is used to boot an application that is stored in 4899c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents 4900c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as 4901c609719bSwdenkparameters. You can check and modify this variable using the 4902c609719bSwdenk"printenv" and "setenv" commands: 4903c609719bSwdenk 4904c609719bSwdenk 4905c609719bSwdenk => printenv bootargs 4906c609719bSwdenk bootargs=root=/dev/ram 4907c609719bSwdenk 4908c609719bSwdenk => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 4909c609719bSwdenk 4910c609719bSwdenk => printenv bootargs 4911c609719bSwdenk bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 4912c609719bSwdenk 4913c609719bSwdenk => bootm 40020000 4914c609719bSwdenk ## Booting Linux kernel at 40020000 ... 4915c609719bSwdenk Image Name: 2.2.13 for NFS on TQM850L 4916c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 4917c609719bSwdenk Data Size: 381681 Bytes = 372 kB = 0 MB 4918c609719bSwdenk Load Address: 00000000 4919c609719bSwdenk Entry Point: 0000000c 4920c609719bSwdenk Verifying Checksum ... OK 4921c609719bSwdenk Uncompressing Kernel Image ... OK 4922c609719bSwdenk 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 4923c609719bSwdenk Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 4924c609719bSwdenk time_init: decrementer frequency = 187500000/60 4925c609719bSwdenk Calibrating delay loop... 49.77 BogoMIPS 4926c609719bSwdenk Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000] 4927c609719bSwdenk ... 4928c609719bSwdenk 492911ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass 49307152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT 4931c609719bSwdenkformat!) to the "bootm" command: 4932c609719bSwdenk 4933c609719bSwdenk => imi 40100000 40200000 4934c609719bSwdenk 4935c609719bSwdenk ## Checking Image at 40100000 ... 4936c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 4937c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 4938c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 4939c609719bSwdenk Load Address: 00000000 4940c609719bSwdenk Entry Point: 0000000c 4941c609719bSwdenk Verifying Checksum ... OK 4942c609719bSwdenk 4943c609719bSwdenk ## Checking Image at 40200000 ... 4944c609719bSwdenk Image Name: Simple Ramdisk Image 4945c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 4946c609719bSwdenk Data Size: 566530 Bytes = 553 kB = 0 MB 4947c609719bSwdenk Load Address: 00000000 4948c609719bSwdenk Entry Point: 00000000 4949c609719bSwdenk Verifying Checksum ... OK 4950c609719bSwdenk 4951c609719bSwdenk => bootm 40100000 40200000 4952c609719bSwdenk ## Booting Linux kernel at 40100000 ... 4953c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 4954c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 4955c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 4956c609719bSwdenk Load Address: 00000000 4957c609719bSwdenk Entry Point: 0000000c 4958c609719bSwdenk Verifying Checksum ... OK 4959c609719bSwdenk Uncompressing Kernel Image ... OK 4960c609719bSwdenk ## Loading RAMDisk Image at 40200000 ... 4961c609719bSwdenk Image Name: Simple Ramdisk Image 4962c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 4963c609719bSwdenk Data Size: 566530 Bytes = 553 kB = 0 MB 4964c609719bSwdenk Load Address: 00000000 4965c609719bSwdenk Entry Point: 00000000 4966c609719bSwdenk Verifying Checksum ... OK 4967c609719bSwdenk Loading Ramdisk ... OK 4968c609719bSwdenk 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 4969c609719bSwdenk Boot arguments: root=/dev/ram 4970c609719bSwdenk time_init: decrementer frequency = 187500000/60 4971c609719bSwdenk Calibrating delay loop... 49.77 BogoMIPS 4972c609719bSwdenk ... 4973c609719bSwdenk RAMDISK: Compressed image found at block 0 4974c609719bSwdenk VFS: Mounted root (ext2 filesystem). 4975c609719bSwdenk 4976c609719bSwdenk bash# 4977c609719bSwdenk 49780267768eSMatthew McClintockBoot Linux and pass a flat device tree: 49790267768eSMatthew McClintock----------- 49800267768eSMatthew McClintock 49810267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section 49820267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The 49830267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated 49840267768eSMatthew McClintockflat device tree: 49850267768eSMatthew McClintock 49860267768eSMatthew McClintock=> print oftaddr 49870267768eSMatthew McClintockoftaddr=0x300000 49880267768eSMatthew McClintock=> print oft 49890267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb 49900267768eSMatthew McClintock=> tftp $oftaddr $oft 49910267768eSMatthew McClintockSpeed: 1000, full duplex 49920267768eSMatthew McClintockUsing TSEC0 device 49930267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101 49940267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'. 49950267768eSMatthew McClintockLoad address: 0x300000 49960267768eSMatthew McClintockLoading: # 49970267768eSMatthew McClintockdone 49980267768eSMatthew McClintockBytes transferred = 4106 (100a hex) 49990267768eSMatthew McClintock=> tftp $loadaddr $bootfile 50000267768eSMatthew McClintockSpeed: 1000, full duplex 50010267768eSMatthew McClintockUsing TSEC0 device 50020267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2 50030267768eSMatthew McClintockFilename 'uImage'. 50040267768eSMatthew McClintockLoad address: 0x200000 50050267768eSMatthew McClintockLoading:############ 50060267768eSMatthew McClintockdone 50070267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex) 50080267768eSMatthew McClintock=> print loadaddr 50090267768eSMatthew McClintockloadaddr=200000 50100267768eSMatthew McClintock=> print oftaddr 50110267768eSMatthew McClintockoftaddr=0x300000 50120267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr 50130267768eSMatthew McClintock## Booting image at 00200000 ... 50140267768eSMatthew McClintock Image Name: Linux-2.6.17-dirty 50150267768eSMatthew McClintock Image Type: PowerPC Linux Kernel Image (gzip compressed) 50160267768eSMatthew McClintock Data Size: 1029343 Bytes = 1005.2 kB 50170267768eSMatthew McClintock Load Address: 00000000 50180267768eSMatthew McClintock Entry Point: 00000000 50190267768eSMatthew McClintock Verifying Checksum ... OK 50200267768eSMatthew McClintock Uncompressing Kernel Image ... OK 50210267768eSMatthew McClintockBooting using flat device tree at 0x300000 50220267768eSMatthew McClintockUsing MPC85xx ADS machine description 50230267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb 50240267768eSMatthew McClintock[snip] 50250267768eSMatthew McClintock 50260267768eSMatthew McClintock 50276069ff26SwdenkMore About U-Boot Image Types: 50286069ff26Swdenk------------------------------ 50296069ff26Swdenk 50306069ff26SwdenkU-Boot supports the following image types: 50316069ff26Swdenk 50326069ff26Swdenk "Standalone Programs" are directly runnable in the environment 50336069ff26Swdenk provided by U-Boot; it is expected that (if they behave 50346069ff26Swdenk well) you can continue to work in U-Boot after return from 50356069ff26Swdenk the Standalone Program. 50366069ff26Swdenk "OS Kernel Images" are usually images of some Embedded OS which 50376069ff26Swdenk will take over control completely. Usually these programs 50386069ff26Swdenk will install their own set of exception handlers, device 50396069ff26Swdenk drivers, set up the MMU, etc. - this means, that you cannot 50406069ff26Swdenk expect to re-enter U-Boot except by resetting the CPU. 50416069ff26Swdenk "RAMDisk Images" are more or less just data blocks, and their 50426069ff26Swdenk parameters (address, size) are passed to an OS kernel that is 50436069ff26Swdenk being started. 50446069ff26Swdenk "Multi-File Images" contain several images, typically an OS 50456069ff26Swdenk (Linux) kernel image and one or more data images like 50466069ff26Swdenk RAMDisks. This construct is useful for instance when you want 50476069ff26Swdenk to boot over the network using BOOTP etc., where the boot 50486069ff26Swdenk server provides just a single image file, but you want to get 50496069ff26Swdenk for instance an OS kernel and a RAMDisk image. 50506069ff26Swdenk 50516069ff26Swdenk "Multi-File Images" start with a list of image sizes, each 50526069ff26Swdenk image size (in bytes) specified by an "uint32_t" in network 50536069ff26Swdenk byte order. This list is terminated by an "(uint32_t)0". 50546069ff26Swdenk Immediately after the terminating 0 follow the images, one by 50556069ff26Swdenk one, all aligned on "uint32_t" boundaries (size rounded up to 50566069ff26Swdenk a multiple of 4 bytes). 50576069ff26Swdenk 50586069ff26Swdenk "Firmware Images" are binary images containing firmware (like 50596069ff26Swdenk U-Boot or FPGA images) which usually will be programmed to 50606069ff26Swdenk flash memory. 50616069ff26Swdenk 50626069ff26Swdenk "Script files" are command sequences that will be executed by 50636069ff26Swdenk U-Boot's command interpreter; this feature is especially 50646069ff26Swdenk useful when you configure U-Boot to use a real shell (hush) 50656069ff26Swdenk as command interpreter. 50666069ff26Swdenk 506744f074c7SMarek VasutBooting the Linux zImage: 506844f074c7SMarek Vasut------------------------- 506944f074c7SMarek Vasut 507044f074c7SMarek VasutOn some platforms, it's possible to boot Linux zImage. This is done 507144f074c7SMarek Vasutusing the "bootz" command. The syntax of "bootz" command is the same 507244f074c7SMarek Vasutas the syntax of "bootm" command. 507344f074c7SMarek Vasut 50748ac28563STom RiniNote, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply 5075017e1f3fSMarek Vasutkernel with raw initrd images. The syntax is slightly different, the 5076017e1f3fSMarek Vasutaddress of the initrd must be augmented by it's size, in the following 5077017e1f3fSMarek Vasutformat: "<initrd addres>:<initrd size>". 5078017e1f3fSMarek Vasut 5079c609719bSwdenk 5080c609719bSwdenkStandalone HOWTO: 5081c609719bSwdenk================= 5082c609719bSwdenk 5083c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and 5084c609719bSwdenkrun "standalone" applications, which can use some resources of 5085c609719bSwdenkU-Boot like console I/O functions or interrupt services. 5086c609719bSwdenk 5087c609719bSwdenkTwo simple examples are included with the sources: 5088c609719bSwdenk 5089c609719bSwdenk"Hello World" Demo: 5090c609719bSwdenk------------------- 5091c609719bSwdenk 5092c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo 5093c609719bSwdenkapplication; it is automatically compiled when you build U-Boot. 5094c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it 5095c609719bSwdenklike that: 5096c609719bSwdenk 5097c609719bSwdenk => loads 5098c609719bSwdenk ## Ready for S-Record download ... 5099c609719bSwdenk ~>examples/hello_world.srec 5100c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 ... 5101c609719bSwdenk [file transfer complete] 5102c609719bSwdenk [connected] 5103c609719bSwdenk ## Start Addr = 0x00040004 5104c609719bSwdenk 5105c609719bSwdenk => go 40004 Hello World! This is a test. 5106c609719bSwdenk ## Starting application at 0x00040004 ... 5107c609719bSwdenk Hello World 5108c609719bSwdenk argc = 7 5109c609719bSwdenk argv[0] = "40004" 5110c609719bSwdenk argv[1] = "Hello" 5111c609719bSwdenk argv[2] = "World!" 5112c609719bSwdenk argv[3] = "This" 5113c609719bSwdenk argv[4] = "is" 5114c609719bSwdenk argv[5] = "a" 5115c609719bSwdenk argv[6] = "test." 5116c609719bSwdenk argv[7] = "<NULL>" 5117c609719bSwdenk Hit any key to exit ... 5118c609719bSwdenk 5119c609719bSwdenk ## Application terminated, rc = 0x0 5120c609719bSwdenk 5121c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt 5122c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'. 5123c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second. 5124c609719bSwdenkThe interrupt service routine is trivial, just printing a '.' 5125c609719bSwdenkcharacter, but this is just a demo program. The application can be 5126c609719bSwdenkcontrolled by the following keys: 5127c609719bSwdenk 5128c609719bSwdenk ? - print current values og the CPM Timer registers 5129c609719bSwdenk b - enable interrupts and start timer 5130c609719bSwdenk e - stop timer and disable interrupts 5131c609719bSwdenk q - quit application 5132c609719bSwdenk 5133c609719bSwdenk => loads 5134c609719bSwdenk ## Ready for S-Record download ... 5135c609719bSwdenk ~>examples/timer.srec 5136c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 ... 5137c609719bSwdenk [file transfer complete] 5138c609719bSwdenk [connected] 5139c609719bSwdenk ## Start Addr = 0x00040004 5140c609719bSwdenk 5141c609719bSwdenk => go 40004 5142c609719bSwdenk ## Starting application at 0x00040004 ... 5143c609719bSwdenk TIMERS=0xfff00980 5144c609719bSwdenk Using timer 1 5145c609719bSwdenk tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0 5146c609719bSwdenk 5147c609719bSwdenkHit 'b': 5148c609719bSwdenk [q, b, e, ?] Set interval 1000000 us 5149c609719bSwdenk Enabling timer 5150c609719bSwdenkHit '?': 5151c609719bSwdenk [q, b, e, ?] ........ 5152c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0 5153c609719bSwdenkHit '?': 5154c609719bSwdenk [q, b, e, ?] . 5155c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0 5156c609719bSwdenkHit '?': 5157c609719bSwdenk [q, b, e, ?] . 5158c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0 5159c609719bSwdenkHit '?': 5160c609719bSwdenk [q, b, e, ?] . 5161c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0 5162c609719bSwdenkHit 'e': 5163c609719bSwdenk [q, b, e, ?] ...Stopping timer 5164c609719bSwdenkHit 'q': 5165c609719bSwdenk [q, b, e, ?] ## Application terminated, rc = 0x0 5166c609719bSwdenk 5167c609719bSwdenk 516885ec0bccSwdenkMinicom warning: 516985ec0bccSwdenk================ 517085ec0bccSwdenk 51717152b1d0SwdenkOver time, many people have reported problems when trying to use the 517285ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd) 517385ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under 5174f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and 517585ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and 5176e53515a2SKarl O. Pincuse "cu" for S-Record download ("loads" command). See 5177e53515a2SKarl O. Pinchttp://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3. 5178e53515a2SKarl O. Pincfor help with kermit. 5179e53515a2SKarl O. Pinc 518085ec0bccSwdenk 518152f52c14SwdenkNevertheless, if you absolutely want to use it try adding this 518252f52c14Swdenkconfiguration to your "File transfer protocols" section: 518352f52c14Swdenk 518452f52c14Swdenk Name Program Name U/D FullScr IO-Red. Multi 518552f52c14Swdenk X kermit /usr/bin/kermit -i -l %l -s Y U Y N N 518652f52c14Swdenk Y kermit /usr/bin/kermit -i -l %l -r N D Y N N 518752f52c14Swdenk 518852f52c14Swdenk 5189c609719bSwdenkNetBSD Notes: 5190c609719bSwdenk============= 5191c609719bSwdenk 5192c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host 5193c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx). 5194c609719bSwdenk 5195c609719bSwdenkBuilding requires a cross environment; it is known to work on 5196c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also 5197c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make). 5198c609719bSwdenkNote that the cross-powerpc package does not install include files; 5199c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is 5200c609719bSwdenkmissing. This file has to be installed and patched manually: 5201c609719bSwdenk 5202c609719bSwdenk # cd /usr/pkg/cross/powerpc-netbsd/include 5203c609719bSwdenk # mkdir powerpc 5204c609719bSwdenk # ln -s powerpc machine 5205c609719bSwdenk # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h 5206c609719bSwdenk # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST 5207c609719bSwdenk 5208c609719bSwdenkNative builds *don't* work due to incompatibilities between native 5209c609719bSwdenkand U-Boot include files. 5210c609719bSwdenk 5211c609719bSwdenkBooting assumes that (the first part of) the image booted is a 5212c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel 5213c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source 5214c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the 52152a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz 5216c609719bSwdenk 5217c609719bSwdenk 5218c609719bSwdenkImplementation Internals: 5219c609719bSwdenk========================= 5220c609719bSwdenk 5221c609719bSwdenkThe following is not intended to be a complete description of every 5222c609719bSwdenkimplementation detail. However, it should help to understand the 5223c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom 5224c609719bSwdenkhardware. 5225c609719bSwdenk 5226c609719bSwdenk 5227c609719bSwdenkInitial Stack, Global Data: 5228c609719bSwdenk--------------------------- 5229c609719bSwdenk 5230c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot 5231c609719bSwdenkstarts running out of ROM (flash memory), usually without access to 5232c609719bSwdenksystem RAM (because the memory controller is not initialized yet). 5233c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS 5234c609719bSwdenkis not initialized as zero. To be able to get a C environment working 5235c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation 5236c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU 5237c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and 5238c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be 5239c609719bSwdenklocked as (mis-) used as memory, etc. 5240c609719bSwdenk 52417152b1d0Swdenk Chris Hallinan posted a good summary of these issues to the 52420668236bSWolfgang Denk U-Boot mailing list: 524343d9616cSwdenk 524443d9616cSwdenk Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)? 524543d9616cSwdenk From: "Chris Hallinan" <clh@net1plus.com> 524643d9616cSwdenk Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET) 524743d9616cSwdenk ... 524843d9616cSwdenk 524943d9616cSwdenk Correct me if I'm wrong, folks, but the way I understand it 525043d9616cSwdenk is this: Using DCACHE as initial RAM for Stack, etc, does not 525143d9616cSwdenk require any physical RAM backing up the cache. The cleverness 525243d9616cSwdenk is that the cache is being used as a temporary supply of 525343d9616cSwdenk necessary storage before the SDRAM controller is setup. It's 525411ccc33fSMarcel Ziswiler beyond the scope of this list to explain the details, but you 525543d9616cSwdenk can see how this works by studying the cache architecture and 525643d9616cSwdenk operation in the architecture and processor-specific manuals. 525743d9616cSwdenk 525843d9616cSwdenk OCM is On Chip Memory, which I believe the 405GP has 4K. It 525943d9616cSwdenk is another option for the system designer to use as an 526011ccc33fSMarcel Ziswiler initial stack/RAM area prior to SDRAM being available. Either 526143d9616cSwdenk option should work for you. Using CS 4 should be fine if your 526243d9616cSwdenk board designers haven't used it for something that would 526343d9616cSwdenk cause you grief during the initial boot! It is frequently not 526443d9616cSwdenk used. 526543d9616cSwdenk 52666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere 526743d9616cSwdenk with your processor/board/system design. The default value 526843d9616cSwdenk you will find in any recent u-boot distribution in 52698a316c9bSStefan Roese walnut.h should work for you. I'd set it to a value larger 527043d9616cSwdenk than your SDRAM module. If you have a 64MB SDRAM module, set 527143d9616cSwdenk it above 400_0000. Just make sure your board has no resources 527243d9616cSwdenk that are supposed to respond to that address! That code in 527343d9616cSwdenk start.S has been around a while and should work as is when 527443d9616cSwdenk you get the config right. 527543d9616cSwdenk 527643d9616cSwdenk -Chris Hallinan 527743d9616cSwdenk DS4.COM, Inc. 527843d9616cSwdenk 5279c609719bSwdenkIt is essential to remember this, since it has some impact on the C 5280c609719bSwdenkcode for the initialization procedures: 5281c609719bSwdenk 5282c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt 5283c609719bSwdenk to write it. 5284c609719bSwdenk 528511ccc33fSMarcel Ziswiler* Do not use any uninitialized global data (or implicitely initialized 5286c609719bSwdenk as zero data - BSS segment) at all - this is undefined, initiali- 52877152b1d0Swdenk zation is performed later (when relocating to RAM). 5288c609719bSwdenk 5289c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like 5290c609719bSwdenk that. 5291c609719bSwdenk 5292c609719bSwdenkHaving only the stack as writable memory limits means we cannot use 5293c609719bSwdenknormal global data to share information beween the code. But it 5294c609719bSwdenkturned out that the implementation of U-Boot can be greatly 5295c609719bSwdenksimplified by making a global data structure (gd_t) available to all 5296c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_ 5297c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of 5298c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we 5299c609719bSwdenkplace a pointer (gd) to the global data into a register which we 5300c609719bSwdenkreserve for this purpose. 5301c609719bSwdenk 53027152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the 5303c609719bSwdenkrelevant (E)ABI specifications for the current architecture, and by 5304c609719bSwdenkGCC's implementation. 5305c609719bSwdenk 5306c609719bSwdenkFor PowerPC, the following registers have specific use: 5307c609719bSwdenk R1: stack pointer 5308e7670f6cSWolfgang Denk R2: reserved for system use 5309c609719bSwdenk R3-R4: parameter passing and return values 5310c609719bSwdenk R5-R10: parameter passing 5311c609719bSwdenk R13: small data area pointer 5312c609719bSwdenk R30: GOT pointer 5313c609719bSwdenk R31: frame pointer 5314c609719bSwdenk 5315e6bee808SJoakim Tjernlund (U-Boot also uses R12 as internal GOT pointer. r12 5316e6bee808SJoakim Tjernlund is a volatile register so r12 needs to be reset when 5317e6bee808SJoakim Tjernlund going back and forth between asm and C) 5318c609719bSwdenk 5319e7670f6cSWolfgang Denk ==> U-Boot will use R2 to hold a pointer to the global data 5320c609719bSwdenk 5321c609719bSwdenk Note: on PPC, we could use a static initializer (since the 5322c609719bSwdenk address of the global data structure is known at compile time), 5323c609719bSwdenk but it turned out that reserving a register results in somewhat 5324c609719bSwdenk smaller code - although the code savings are not that big (on 5325c609719bSwdenk average for all boards 752 bytes for the whole U-Boot image, 5326c609719bSwdenk 624 text + 127 data). 5327c609719bSwdenk 5328c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here: 53294c58eb55SMike Frysinger http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface 53304c58eb55SMike Frysinger 5331c4db335cSRobin Getz ==> U-Boot will use P3 to hold a pointer to the global data 53324c58eb55SMike Frysinger 5333c609719bSwdenkOn ARM, the following registers are used: 5334c609719bSwdenk 5335c609719bSwdenk R0: function argument word/integer result 5336c609719bSwdenk R1-R3: function argument word 5337c609719bSwdenk R9: GOT pointer 5338c609719bSwdenk R10: stack limit (used only if stack checking if enabled) 5339c609719bSwdenk R11: argument (frame) pointer 5340c609719bSwdenk R12: temporary workspace 5341c609719bSwdenk R13: stack pointer 5342c609719bSwdenk R14: link register 5343c609719bSwdenk R15: program counter 5344c609719bSwdenk 5345c609719bSwdenk ==> U-Boot will use R8 to hold a pointer to the global data 5346c609719bSwdenk 53470df01fd3SThomas ChouOn Nios II, the ABI is documented here: 53480df01fd3SThomas Chou http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf 53490df01fd3SThomas Chou 53500df01fd3SThomas Chou ==> U-Boot will use gp to hold a pointer to the global data 53510df01fd3SThomas Chou 53520df01fd3SThomas Chou Note: on Nios II, we give "-G0" option to gcc and don't use gp 53530df01fd3SThomas Chou to access small data sections, so gp is free. 53540df01fd3SThomas Chou 5355afc1ce82SMacpaul LinOn NDS32, the following registers are used: 5356afc1ce82SMacpaul Lin 5357afc1ce82SMacpaul Lin R0-R1: argument/return 5358afc1ce82SMacpaul Lin R2-R5: argument 5359afc1ce82SMacpaul Lin R15: temporary register for assembler 5360afc1ce82SMacpaul Lin R16: trampoline register 5361afc1ce82SMacpaul Lin R28: frame pointer (FP) 5362afc1ce82SMacpaul Lin R29: global pointer (GP) 5363afc1ce82SMacpaul Lin R30: link register (LP) 5364afc1ce82SMacpaul Lin R31: stack pointer (SP) 5365afc1ce82SMacpaul Lin PC: program counter (PC) 5366afc1ce82SMacpaul Lin 5367afc1ce82SMacpaul Lin ==> U-Boot will use R10 to hold a pointer to the global data 5368afc1ce82SMacpaul Lin 5369d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope, 5370d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much. 5371c609719bSwdenk 5372c609719bSwdenkMemory Management: 5373c609719bSwdenk------------------ 5374c609719bSwdenk 5375c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the 5376c609719bSwdenkMMU is not used either for address mapping nor for memory protection. 5377c609719bSwdenk 5378c609719bSwdenkThe available memory is mapped to fixed addresses using the memory 5379c609719bSwdenkcontroller. In this process, a contiguous block is formed for each 5380c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several 5381c609719bSwdenkphysical memory banks. 5382c609719bSwdenk 5383c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on 5384c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After 5385c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself 5386c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some 53876d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN 5388c609719bSwdenkconfiguration setting]. Below that, a structure with global Board 5389c609719bSwdenkInfo data is placed, followed by the stack (growing downward). 5390c609719bSwdenk 5391c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB 5392c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF). 5393c609719bSwdenk 5394c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like 5395c609719bSwdenkthis: 5396c609719bSwdenk 5397c609719bSwdenk 0x0000 0000 Exception Vector code 5398c609719bSwdenk : 5399c609719bSwdenk 0x0000 1FFF 5400c609719bSwdenk 0x0000 2000 Free for Application Use 5401c609719bSwdenk : 5402c609719bSwdenk : 5403c609719bSwdenk 5404c609719bSwdenk : 5405c609719bSwdenk : 5406c609719bSwdenk 0x00FB FF20 Monitor Stack (Growing downward) 5407c609719bSwdenk 0x00FB FFAC Board Info Data and permanent copy of global data 5408c609719bSwdenk 0x00FC 0000 Malloc Arena 5409c609719bSwdenk : 5410c609719bSwdenk 0x00FD FFFF 5411c609719bSwdenk 0x00FE 0000 RAM Copy of Monitor Code 5412c609719bSwdenk ... eventually: LCD or video framebuffer 5413c609719bSwdenk ... eventually: pRAM (Protected RAM - unchanged by reset) 5414c609719bSwdenk 0x00FF FFFF [End of RAM] 5415c609719bSwdenk 5416c609719bSwdenk 5417c609719bSwdenkSystem Initialization: 5418c609719bSwdenk---------------------- 5419c609719bSwdenk 5420c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point 542111ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset 5422c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory. 54237152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address. 5424c609719bSwdenkTo be able to implement the initialization code in C, a (small!) 5425c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs 5426c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked 5427c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core, 5428c609719bSwdenkthe caches and the SIU. 5429c609719bSwdenk 5430c609719bSwdenkNext, all (potentially) available memory banks are mapped using a 5431c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries 5432c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash 5433c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is 5434c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a 5435c609719bSwdenksimple memory test is run that determines the size of the SDRAM 5436c609719bSwdenkbanks. 5437c609719bSwdenk 5438c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of 54397152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first 5440c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address 5441c609719bSwdenk0x00000000, with any additional banks following immediately to create 5442c609719bSwdenkcontiguous memory starting from 0. 5443c609719bSwdenk 5444c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area 5445c609719bSwdenkand allocates memory for use by malloc() and for the global Board 5446c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM 5447c609719bSwdenkpages, and the final stack is set up. 5448c609719bSwdenk 5449c609719bSwdenkOnly after this relocation will you have a "normal" C environment; 5450c609719bSwdenkuntil that you are restricted in several ways, mostly because you are 5451c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a 5452c609719bSwdenknew address in RAM. 5453c609719bSwdenk 5454c609719bSwdenk 5455c609719bSwdenkU-Boot Porting Guide: 5456c609719bSwdenk---------------------- 5457c609719bSwdenk 5458c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing 54596aff3115Swdenklist, October 2002] 5460c609719bSwdenk 5461c609719bSwdenk 5462c609719bSwdenkint main(int argc, char *argv[]) 5463c609719bSwdenk{ 5464c609719bSwdenk sighandler_t no_more_time; 5465c609719bSwdenk 5466c609719bSwdenk signal(SIGALRM, no_more_time); 5467c609719bSwdenk alarm(PROJECT_DEADLINE - toSec (3 * WEEK)); 5468c609719bSwdenk 5469c609719bSwdenk if (available_money > available_manpower) { 54706c3fef28SJerry Van Baren Pay consultant to port U-Boot; 5471c609719bSwdenk return 0; 5472c609719bSwdenk } 5473c609719bSwdenk 5474c609719bSwdenk Download latest U-Boot source; 5475c609719bSwdenk 54760668236bSWolfgang Denk Subscribe to u-boot mailing list; 54776aff3115Swdenk 54786c3fef28SJerry Van Baren if (clueless) 5479c609719bSwdenk email("Hi, I am new to U-Boot, how do I get started?"); 5480c609719bSwdenk 5481c609719bSwdenk while (learning) { 5482c609719bSwdenk Read the README file in the top level directory; 54837cb22f97Swdenk Read http://www.denx.de/twiki/bin/view/DULG/Manual; 54846c3fef28SJerry Van Baren Read applicable doc/*.README; 5485c609719bSwdenk Read the source, Luke; 54866c3fef28SJerry Van Baren /* find . -name "*.[chS]" | xargs grep -i <keyword> */ 5487c609719bSwdenk } 5488c609719bSwdenk 54896c3fef28SJerry Van Baren if (available_money > toLocalCurrency ($2500)) 54906c3fef28SJerry Van Baren Buy a BDI3000; 54916c3fef28SJerry Van Baren else 5492c609719bSwdenk Add a lot of aggravation and time; 5493c609719bSwdenk 54946c3fef28SJerry Van Baren if (a similar board exists) { /* hopefully... */ 54956c3fef28SJerry Van Baren cp -a board/<similar> board/<myboard> 54966c3fef28SJerry Van Baren cp include/configs/<similar>.h include/configs/<myboard>.h 54976c3fef28SJerry Van Baren } else { 5498c609719bSwdenk Create your own board support subdirectory; 54996c3fef28SJerry Van Baren Create your own board include/configs/<myboard>.h file; 55006c3fef28SJerry Van Baren } 55016c3fef28SJerry Van Baren Edit new board/<myboard> files 55026c3fef28SJerry Van Baren Edit new include/configs/<myboard>.h 5503c609719bSwdenk 55046c3fef28SJerry Van Baren while (!accepted) { 5505c609719bSwdenk while (!running) { 5506c609719bSwdenk do { 5507c609719bSwdenk Add / modify source code; 5508c609719bSwdenk } until (compiles); 5509c609719bSwdenk Debug; 5510c609719bSwdenk if (clueless) 5511c609719bSwdenk email("Hi, I am having problems..."); 5512c609719bSwdenk } 55136c3fef28SJerry Van Baren Send patch file to the U-Boot email list; 55146c3fef28SJerry Van Baren if (reasonable critiques) 55156c3fef28SJerry Van Baren Incorporate improvements from email list code review; 55166c3fef28SJerry Van Baren else 55176c3fef28SJerry Van Baren Defend code as written; 55186c3fef28SJerry Van Baren } 5519c609719bSwdenk 5520c609719bSwdenk return 0; 5521c609719bSwdenk} 5522c609719bSwdenk 5523c609719bSwdenkvoid no_more_time (int sig) 5524c609719bSwdenk{ 5525c609719bSwdenk hire_a_guru(); 5526c609719bSwdenk} 5527c609719bSwdenk 5528c609719bSwdenk 5529c609719bSwdenkCoding Standards: 5530c609719bSwdenk----------------- 5531c609719bSwdenk 5532c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel 55332c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script 55347ca9296eSWolfgang Denk"scripts/Lindent" in your Linux kernel source directory. 5535c609719bSwdenk 55362c051651SDetlev ZundelSource files originating from a different project (for example the 55372c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not 55382c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those 55392c051651SDetlev Zundelsources. 55402c051651SDetlev Zundel 55412c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in 55422c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//) 55432c051651SDetlev Zundelin your code. 5544c609719bSwdenk 5545c178d3daSwdenkPlease also stick to the following formatting rules: 5546180d3f74Swdenk- remove any trailing white space 55477ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces 5548180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds 55497ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files 5550180d3f74Swdenk- do not add trailing empty lines to source files 5551180d3f74Swdenk 5552c609719bSwdenkSubmissions which do not conform to the standards may be returned 5553c609719bSwdenkwith a request to reformat the changes. 5554c609719bSwdenk 5555c609719bSwdenk 5556c609719bSwdenkSubmitting Patches: 5557c609719bSwdenk------------------- 5558c609719bSwdenk 5559c609719bSwdenkSince the number of patches for U-Boot is growing, we need to 5560c609719bSwdenkestablish some rules. Submissions which do not conform to these rules 5561c609719bSwdenkmay be rejected, even when they contain important and valuable stuff. 5562c609719bSwdenk 55630d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details. 5564218ca724SWolfgang Denk 55650668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>; 55660668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot 55670668236bSWolfgang Denk 5568c609719bSwdenkWhen you send a patch, please include the following information with 5569c609719bSwdenkit: 5570c609719bSwdenk 5571c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes 5572c609719bSwdenk this bug. Please try to include a way of demonstrating that the 5573c609719bSwdenk patch actually fixes something. 5574c609719bSwdenk 5575c609719bSwdenk* For new features: a description of the feature and your 5576c609719bSwdenk implementation. 5577c609719bSwdenk 5578c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch) 5579c609719bSwdenk 5580c609719bSwdenk* For major contributions, your entry to the CREDITS file 5581c609719bSwdenk 5582c609719bSwdenk* When you add support for a new board, don't forget to add this 55837ca9296eSWolfgang Denk board to the MAINTAINERS file, too. 5584c609719bSwdenk 5585c609719bSwdenk* If your patch adds new configuration options, don't forget to 5586c609719bSwdenk document these in the README file. 5587c609719bSwdenk 5588218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly* 5589218ca724SWolfgang Denk recommended) you can easily generate the patch using the 55907ca9296eSWolfgang Denk "git format-patch". If you then use "git send-email" to send it to 5591218ca724SWolfgang Denk the U-Boot mailing list, you will avoid most of the common problems 5592218ca724SWolfgang Denk with some other mail clients. 5593c609719bSwdenk 5594218ca724SWolfgang Denk If you cannot use git, use "diff -purN OLD NEW". If your version of 5595218ca724SWolfgang Denk diff does not support these options, then get the latest version of 5596218ca724SWolfgang Denk GNU diff. 55976dff5529Swdenk 5598218ca724SWolfgang Denk The current directory when running this command shall be the parent 5599218ca724SWolfgang Denk directory of the U-Boot source tree (i. e. please make sure that 5600218ca724SWolfgang Denk your patch includes sufficient directory information for the 5601218ca724SWolfgang Denk affected files). 5602218ca724SWolfgang Denk 5603218ca724SWolfgang Denk We prefer patches as plain text. MIME attachments are discouraged, 5604218ca724SWolfgang Denk and compressed attachments must not be used. 5605c609719bSwdenk 560652f52c14Swdenk* If one logical set of modifications affects or creates several 560752f52c14Swdenk files, all these changes shall be submitted in a SINGLE patch file. 560852f52c14Swdenk 560952f52c14Swdenk* Changesets that contain different, unrelated modifications shall be 561052f52c14Swdenk submitted as SEPARATE patches, one patch per changeset. 561152f52c14Swdenk 561252f52c14Swdenk 5613c609719bSwdenkNotes: 5614c609719bSwdenk 5615c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched 5616c609719bSwdenk source tree and make sure that no errors or warnings are reported 5617c609719bSwdenk for any of the boards. 5618c609719bSwdenk 5619c609719bSwdenk* Keep your modifications to the necessary minimum: A patch 5620c609719bSwdenk containing several unrelated changes or arbitrary reformats will be 5621c609719bSwdenk returned with a request to re-formatting / split it. 5622c609719bSwdenk 5623c609719bSwdenk* If you modify existing code, make sure that your new code does not 5624c609719bSwdenk add to the memory footprint of the code ;-) Small is beautiful! 5625c609719bSwdenk When adding new features, these should compile conditionally only 5626c609719bSwdenk (using #ifdef), and the resulting code with the new feature 5627c609719bSwdenk disabled must not need more memory than the old code without your 5628c609719bSwdenk modification. 562990dc6704Swdenk 56300668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the 56310668236bSWolfgang Denk u-boot mailing list. Bigger patches will be moderated. If they are 56320668236bSWolfgang Denk reasonable and not too big, they will be acknowledged. But patches 56330668236bSWolfgang Denk bigger than the size limit should be avoided. 5634