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 416*74fa22edSPrabhakar Kushwaha CONFIG_A003399_NOR_WORKAROUND 417*74fa22edSPrabhakar Kushwaha Enables a workaround for IFC erratum A003399. It is only 418*74fa22edSPrabhakar Kushwaha requred during NOR boot. 419*74fa22edSPrabhakar Kushwaha 42033eee330SScott Wood CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY 42133eee330SScott Wood 42233eee330SScott Wood This is the value to write into CCSR offset 0x18600 42333eee330SScott Wood according to the A004510 workaround. 42433eee330SScott Wood 4256cb461b4SDaniel Schwierzeck- Generic CPU options: 4266cb461b4SDaniel Schwierzeck CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN 4276cb461b4SDaniel Schwierzeck 4286cb461b4SDaniel Schwierzeck Defines the endianess of the CPU. Implementation of those 4296cb461b4SDaniel Schwierzeck values is arch specific. 4306cb461b4SDaniel Schwierzeck 4310b953ffcSMarkus Klotzbuecher- Intel Monahans options: 4326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO 4330b953ffcSMarkus Klotzbuecher 4340b953ffcSMarkus Klotzbuecher Defines the Monahans run mode to oscillator 4350b953ffcSMarkus Klotzbuecher ratio. Valid values are 8, 16, 24, 31. The core 4360b953ffcSMarkus Klotzbuecher frequency is this value multiplied by 13 MHz. 4370b953ffcSMarkus Klotzbuecher 4386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO 4390b953ffcSMarkus Klotzbuecher 4400b953ffcSMarkus Klotzbuecher Defines the Monahans turbo mode to oscillator 4410b953ffcSMarkus Klotzbuecher ratio. Valid values are 1 (default if undefined) and 4420b953ffcSMarkus Klotzbuecher 2. The core frequency as calculated above is multiplied 4430b953ffcSMarkus Klotzbuecher by this value. 4440b953ffcSMarkus Klotzbuecher 44592bbd64eSDaniel Schwierzeck- MIPS CPU options: 44692bbd64eSDaniel Schwierzeck CONFIG_SYS_INIT_SP_OFFSET 44792bbd64eSDaniel Schwierzeck 44892bbd64eSDaniel Schwierzeck Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack 44992bbd64eSDaniel Schwierzeck pointer. This is needed for the temporary stack before 45092bbd64eSDaniel Schwierzeck relocation. 45192bbd64eSDaniel Schwierzeck 45292bbd64eSDaniel Schwierzeck CONFIG_SYS_MIPS_CACHE_MODE 45392bbd64eSDaniel Schwierzeck 45492bbd64eSDaniel Schwierzeck Cache operation mode for the MIPS CPU. 45592bbd64eSDaniel Schwierzeck See also arch/mips/include/asm/mipsregs.h. 45692bbd64eSDaniel Schwierzeck Possible values are: 45792bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_NO_WA 45892bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_WA 45992bbd64eSDaniel Schwierzeck CONF_CM_UNCACHED 46092bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_NONCOHERENT 46192bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_CE 46292bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_COW 46392bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_CUW 46492bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_ACCELERATED 46592bbd64eSDaniel Schwierzeck 46692bbd64eSDaniel Schwierzeck CONFIG_SYS_XWAY_EBU_BOOTCFG 46792bbd64eSDaniel Schwierzeck 46892bbd64eSDaniel Schwierzeck Special option for Lantiq XWAY SoCs for booting from NOR flash. 46992bbd64eSDaniel Schwierzeck See also arch/mips/cpu/mips32/start.S. 47092bbd64eSDaniel Schwierzeck 47192bbd64eSDaniel Schwierzeck CONFIG_XWAY_SWAP_BYTES 47292bbd64eSDaniel Schwierzeck 47392bbd64eSDaniel Schwierzeck Enable compilation of tools/xway-swap-bytes needed for Lantiq 47492bbd64eSDaniel Schwierzeck XWAY SoCs for booting from NOR flash. The U-Boot image needs to 47592bbd64eSDaniel Schwierzeck be swapped if a flash programmer is used. 47692bbd64eSDaniel Schwierzeck 477b67d8816SChristian Riesch- ARM options: 478b67d8816SChristian Riesch CONFIG_SYS_EXCEPTION_VECTORS_HIGH 479b67d8816SChristian Riesch 480b67d8816SChristian Riesch Select high exception vectors of the ARM core, e.g., do not 481b67d8816SChristian Riesch clear the V bit of the c1 register of CP15. 482b67d8816SChristian Riesch 4835356f545SAneesh V CONFIG_SYS_THUMB_BUILD 4845356f545SAneesh V 4855356f545SAneesh V Use this flag to build U-Boot using the Thumb instruction 4865356f545SAneesh V set for ARM architectures. Thumb instruction set provides 4875356f545SAneesh V better code density. For ARM architectures that support 4885356f545SAneesh V Thumb2 this flag will result in Thumb2 code generated by 4895356f545SAneesh V GCC. 4905356f545SAneesh V 491c5d4752cSStephen Warren CONFIG_ARM_ERRATA_716044 4920678587fSStephen Warren CONFIG_ARM_ERRATA_742230 4930678587fSStephen Warren CONFIG_ARM_ERRATA_743622 4940678587fSStephen Warren CONFIG_ARM_ERRATA_751472 4950678587fSStephen Warren 4960678587fSStephen Warren If set, the workarounds for these ARM errata are applied early 4970678587fSStephen Warren during U-Boot startup. Note that these options force the 4980678587fSStephen Warren workarounds to be applied; no CPU-type/version detection 4990678587fSStephen Warren exists, unlike the similar options in the Linux kernel. Do not 5000678587fSStephen Warren set these options unless they apply! 5010678587fSStephen Warren 502795659dcSStephen Warren- CPU timer options: 503795659dcSStephen Warren CONFIG_SYS_HZ 504795659dcSStephen Warren 505795659dcSStephen Warren The frequency of the timer returned by get_timer(). 506795659dcSStephen Warren get_timer() must operate in milliseconds and this CONFIG 507795659dcSStephen Warren option must be set to 1000. 508795659dcSStephen Warren 5095da627a4Swdenk- Linux Kernel Interface: 510c609719bSwdenk CONFIG_CLOCKS_IN_MHZ 511c609719bSwdenk 512c609719bSwdenk U-Boot stores all clock information in Hz 513c609719bSwdenk internally. For binary compatibility with older Linux 514c609719bSwdenk kernels (which expect the clocks passed in the 515c609719bSwdenk bd_info data to be in MHz) the environment variable 516c609719bSwdenk "clocks_in_mhz" can be defined so that U-Boot 517c609719bSwdenk converts clock data to MHZ before passing it to the 518c609719bSwdenk Linux kernel. 519c609719bSwdenk When CONFIG_CLOCKS_IN_MHZ is defined, a definition of 520c609719bSwdenk "clocks_in_mhz=1" is automatically included in the 521c609719bSwdenk default environment. 522c609719bSwdenk 5235da627a4Swdenk CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only] 5245da627a4Swdenk 52511ccc33fSMarcel Ziswiler When transferring memsize parameter to linux, some versions 5265da627a4Swdenk expect it to be in bytes, others in MB. 5275da627a4Swdenk Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes. 5285da627a4Swdenk 529fec6d9eeSGerald Van Baren CONFIG_OF_LIBFDT 530f57f70aaSWolfgang Denk 531f57f70aaSWolfgang Denk New kernel versions are expecting firmware settings to be 532213bf8c8SGerald Van Baren passed using flattened device trees (based on open firmware 533213bf8c8SGerald Van Baren concepts). 534213bf8c8SGerald Van Baren 535213bf8c8SGerald Van Baren CONFIG_OF_LIBFDT 536213bf8c8SGerald Van Baren * New libfdt-based support 537213bf8c8SGerald Van Baren * Adds the "fdt" command 5383bb342fcSKim Phillips * The bootm command automatically updates the fdt 539213bf8c8SGerald Van Baren 540b55ae402SMarcel Ziswiler OF_CPU - The proper name of the cpus node (only required for 541b55ae402SMarcel Ziswiler MPC512X and MPC5xxx based boards). 542b55ae402SMarcel Ziswiler OF_SOC - The proper name of the soc node (only required for 543b55ae402SMarcel Ziswiler MPC512X and MPC5xxx based boards). 544f57f70aaSWolfgang Denk OF_TBCLK - The timebase frequency. 545c2871f03SKumar Gala OF_STDOUT_PATH - The path to the console device 546f57f70aaSWolfgang Denk 54711ccc33fSMarcel Ziswiler boards with QUICC Engines require OF_QE to set UCC MAC 54811ccc33fSMarcel Ziswiler addresses 5493bb342fcSKim Phillips 5504e253137SKumar Gala CONFIG_OF_BOARD_SETUP 5514e253137SKumar Gala 5524e253137SKumar Gala Board code has addition modification that it wants to make 5534e253137SKumar Gala to the flat device tree before handing it off to the kernel 5546705d81eSwdenk 5550267768eSMatthew McClintock CONFIG_OF_BOOT_CPU 5560267768eSMatthew McClintock 55711ccc33fSMarcel Ziswiler This define fills in the correct boot CPU in the boot 5580267768eSMatthew McClintock param header, the default value is zero if undefined. 5590267768eSMatthew McClintock 5603887c3fbSHeiko Schocher CONFIG_OF_IDE_FIXUP 5613887c3fbSHeiko Schocher 5623887c3fbSHeiko Schocher U-Boot can detect if an IDE device is present or not. 5633887c3fbSHeiko Schocher If not, and this new config option is activated, U-Boot 5643887c3fbSHeiko Schocher removes the ATA node from the DTS before booting Linux, 5653887c3fbSHeiko Schocher so the Linux IDE driver does not probe the device and 5663887c3fbSHeiko Schocher crash. This is needed for buggy hardware (uc101) where 5673887c3fbSHeiko Schocher no pull down resistor is connected to the signal IDE5V_DD7. 5683887c3fbSHeiko Schocher 5697eb29398SIgor Grinberg CONFIG_MACH_TYPE [relevant for ARM only][mandatory] 5707eb29398SIgor Grinberg 5717eb29398SIgor Grinberg This setting is mandatory for all boards that have only one 5727eb29398SIgor Grinberg machine type and must be used to specify the machine type 5737eb29398SIgor Grinberg number as it appears in the ARM machine registry 5747eb29398SIgor Grinberg (see http://www.arm.linux.org.uk/developer/machines/). 5757eb29398SIgor Grinberg Only boards that have multiple machine types supported 5767eb29398SIgor Grinberg in a single configuration file and the machine type is 5777eb29398SIgor Grinberg runtime discoverable, do not have to use this setting. 5787eb29398SIgor Grinberg 5790b2f4ecaSNiklaus Giger- vxWorks boot parameters: 5800b2f4ecaSNiklaus Giger 5810b2f4ecaSNiklaus Giger bootvx constructs a valid bootline using the following 5820b2f4ecaSNiklaus Giger environments variables: bootfile, ipaddr, serverip, hostname. 5830b2f4ecaSNiklaus Giger It loads the vxWorks image pointed bootfile. 5840b2f4ecaSNiklaus Giger 5850b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name 5860b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address 5870b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server 5880b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters 5890b2f4ecaSNiklaus Giger 5900b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_ADD_PARAMS 5910b2f4ecaSNiklaus Giger 5920b2f4ecaSNiklaus Giger Add it at the end of the bootline. E.g "u=username pw=secret" 5930b2f4ecaSNiklaus Giger 5940b2f4ecaSNiklaus Giger Note: If a "bootargs" environment is defined, it will overwride 5950b2f4ecaSNiklaus Giger the defaults discussed just above. 5960b2f4ecaSNiklaus Giger 5972c451f78SAneesh V- Cache Configuration: 5982c451f78SAneesh V CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot 5992c451f78SAneesh V CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot 6002c451f78SAneesh V CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot 6012c451f78SAneesh V 60293bc2193SAneesh V- Cache Configuration for ARM: 60393bc2193SAneesh V CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache 60493bc2193SAneesh V controller 60593bc2193SAneesh V CONFIG_SYS_PL310_BASE - Physical base address of PL310 60693bc2193SAneesh V controller register space 60793bc2193SAneesh V 6086705d81eSwdenk- Serial Ports: 60948d0192fSAndreas Engel CONFIG_PL010_SERIAL 6106705d81eSwdenk 6116705d81eSwdenk Define this if you want support for Amba PrimeCell PL010 UARTs. 6126705d81eSwdenk 61348d0192fSAndreas Engel CONFIG_PL011_SERIAL 6146705d81eSwdenk 6156705d81eSwdenk Define this if you want support for Amba PrimeCell PL011 UARTs. 6166705d81eSwdenk 6176705d81eSwdenk CONFIG_PL011_CLOCK 6186705d81eSwdenk 6196705d81eSwdenk If you have Amba PrimeCell PL011 UARTs, set this variable to 6206705d81eSwdenk the clock speed of the UARTs. 6216705d81eSwdenk 6226705d81eSwdenk CONFIG_PL01x_PORTS 6236705d81eSwdenk 6246705d81eSwdenk If you have Amba PrimeCell PL010 or PL011 UARTs on your board, 6256705d81eSwdenk define this to a list of base addresses for each (supported) 6266705d81eSwdenk port. See e.g. include/configs/versatile.h 6276705d81eSwdenk 628910f1ae3SJohn Rigby CONFIG_PL011_SERIAL_RLCR 629910f1ae3SJohn Rigby 630910f1ae3SJohn Rigby Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500) 631910f1ae3SJohn Rigby have separate receive and transmit line control registers. Set 632910f1ae3SJohn Rigby this variable to initialize the extra register. 633910f1ae3SJohn Rigby 634910f1ae3SJohn Rigby CONFIG_PL011_SERIAL_FLUSH_ON_INIT 635910f1ae3SJohn Rigby 636910f1ae3SJohn Rigby On some platforms (e.g. U8500) U-Boot is loaded by a second stage 637910f1ae3SJohn Rigby boot loader that has already initialized the UART. Define this 638910f1ae3SJohn Rigby variable to flush the UART at init time. 639910f1ae3SJohn Rigby 6406705d81eSwdenk 641c609719bSwdenk- Console Interface: 642c609719bSwdenk Depending on board, define exactly one serial port 643c609719bSwdenk (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2, 644c609719bSwdenk CONFIG_8xx_CONS_SCC1, ...), or switch off the serial 645c609719bSwdenk console by defining CONFIG_8xx_CONS_NONE 646c609719bSwdenk 647c609719bSwdenk Note: if CONFIG_8xx_CONS_NONE is defined, the serial 648c609719bSwdenk port routines must be defined elsewhere 649c609719bSwdenk (i.e. serial_init(), serial_getc(), ...) 650c609719bSwdenk 651c609719bSwdenk CONFIG_CFB_CONSOLE 652c609719bSwdenk Enables console device for a color framebuffer. Needs following 653c53043b7SWolfgang Denk defines (cf. smiLynxEM, i8042) 654c609719bSwdenk VIDEO_FB_LITTLE_ENDIAN graphic memory organisation 655c609719bSwdenk (default big endian) 656c609719bSwdenk VIDEO_HW_RECTFILL graphic chip supports 657c609719bSwdenk rectangle fill 658c609719bSwdenk (cf. smiLynxEM) 659c609719bSwdenk VIDEO_HW_BITBLT graphic chip supports 660c609719bSwdenk bit-blit (cf. smiLynxEM) 661c609719bSwdenk VIDEO_VISIBLE_COLS visible pixel columns 662c609719bSwdenk (cols=pitch) 663c609719bSwdenk VIDEO_VISIBLE_ROWS visible pixel rows 664c609719bSwdenk VIDEO_PIXEL_SIZE bytes per pixel 665c609719bSwdenk VIDEO_DATA_FORMAT graphic data format 666c609719bSwdenk (0-5, cf. cfb_console.c) 667c609719bSwdenk VIDEO_FB_ADRS framebuffer address 668c609719bSwdenk VIDEO_KBD_INIT_FCT keyboard int fct 669c609719bSwdenk (i.e. i8042_kbd_init()) 670c609719bSwdenk VIDEO_TSTC_FCT test char fct 671c609719bSwdenk (i.e. i8042_tstc) 672c609719bSwdenk VIDEO_GETC_FCT get char fct 673c609719bSwdenk (i.e. i8042_getc) 674c609719bSwdenk CONFIG_CONSOLE_CURSOR cursor drawing on/off 675c609719bSwdenk (requires blink timer 676c609719bSwdenk cf. i8042.c) 6776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c) 678c609719bSwdenk CONFIG_CONSOLE_TIME display time/date info in 679c609719bSwdenk upper right corner 680602ad3b3SJon Loeliger (requires CONFIG_CMD_DATE) 681c609719bSwdenk CONFIG_VIDEO_LOGO display Linux logo in 682c609719bSwdenk upper left corner 683a6c7ad2fSwdenk CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of 684a6c7ad2fSwdenk linux_logo.h for logo. 685a6c7ad2fSwdenk Requires CONFIG_VIDEO_LOGO 686c609719bSwdenk CONFIG_CONSOLE_EXTRA_INFO 68711ccc33fSMarcel Ziswiler additional board info beside 688c609719bSwdenk the logo 689c609719bSwdenk 69033a35bbbSPali Rohár When CONFIG_CFB_CONSOLE_ANSI is defined, console will support 69133a35bbbSPali Rohár a limited number of ANSI escape sequences (cursor control, 69233a35bbbSPali Rohár erase functions and limited graphics rendition control). 69333a35bbbSPali Rohár 694c609719bSwdenk When CONFIG_CFB_CONSOLE is defined, video console is 695c609719bSwdenk default i/o. Serial console can be forced with 696c609719bSwdenk environment 'console=serial'. 697c609719bSwdenk 698a3ad8e26Swdenk When CONFIG_SILENT_CONSOLE is defined, all console 699a3ad8e26Swdenk messages (by U-Boot and Linux!) can be silenced with 700a3ad8e26Swdenk the "silent" environment variable. See 701a3ad8e26Swdenk doc/README.silent for more information. 702a3ad8e26Swdenk 703c609719bSwdenk- Console Baudrate: 704c609719bSwdenk CONFIG_BAUDRATE - in bps 705c609719bSwdenk Select one of the baudrates listed in 7066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BAUDRATE_TABLE, see below. 7076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale 708c609719bSwdenk 709c92fac91SHeiko Schocher- Console Rx buffer length 710c92fac91SHeiko Schocher With CONFIG_SYS_SMC_RXBUFLEN it is possible to define 711c92fac91SHeiko Schocher the maximum receive buffer length for the SMC. 7122b3f12c2SHeiko Schocher This option is actual only for 82xx and 8xx possible. 713c92fac91SHeiko Schocher If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE 714c92fac91SHeiko Schocher must be defined, to setup the maximum idle timeout for 715c92fac91SHeiko Schocher the SMC. 716c92fac91SHeiko Schocher 7179558b48aSGraeme Russ- Pre-Console Buffer: 7189558b48aSGraeme Russ Prior to the console being initialised (i.e. serial UART 7199558b48aSGraeme Russ initialised etc) all console output is silently discarded. 7209558b48aSGraeme Russ Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to 7219558b48aSGraeme Russ buffer any console messages prior to the console being 7229558b48aSGraeme Russ initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ 7239558b48aSGraeme Russ bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is 7249558b48aSGraeme Russ a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ 7259558b48aSGraeme Russ bytes are output before the console is initialised, the 7269558b48aSGraeme Russ earlier bytes are discarded. 7279558b48aSGraeme Russ 7289558b48aSGraeme Russ 'Sane' compilers will generate smaller code if 7299558b48aSGraeme Russ CONFIG_PRE_CON_BUF_SZ is a power of 2 7309558b48aSGraeme Russ 731046a37bdSSonny Rao- Safe printf() functions 732046a37bdSSonny Rao Define CONFIG_SYS_VSNPRINTF to compile in safe versions of 733046a37bdSSonny Rao the printf() functions. These are defined in 734046a37bdSSonny Rao include/vsprintf.h and include snprintf(), vsnprintf() and 735046a37bdSSonny Rao so on. Code size increase is approximately 300-500 bytes. 736046a37bdSSonny Rao If this option is not given then these functions will 737046a37bdSSonny Rao silently discard their buffer size argument - this means 738046a37bdSSonny Rao you are not getting any overflow checking in this case. 739046a37bdSSonny Rao 740c609719bSwdenk- Boot Delay: CONFIG_BOOTDELAY - in seconds 741c609719bSwdenk Delay before automatically booting the default image; 742c609719bSwdenk set to -1 to disable autoboot. 74393d7212fSJoe Hershberger set to -2 to autoboot with no delay and not check for abort 74493d7212fSJoe Hershberger (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined). 745c609719bSwdenk 746c609719bSwdenk See doc/README.autoboot for these options that 747c609719bSwdenk work with CONFIG_BOOTDELAY. None are required. 748c609719bSwdenk CONFIG_BOOT_RETRY_TIME 749c609719bSwdenk CONFIG_BOOT_RETRY_MIN 750c609719bSwdenk CONFIG_AUTOBOOT_KEYED 751c609719bSwdenk CONFIG_AUTOBOOT_PROMPT 752c609719bSwdenk CONFIG_AUTOBOOT_DELAY_STR 753c609719bSwdenk CONFIG_AUTOBOOT_STOP_STR 754c609719bSwdenk CONFIG_AUTOBOOT_DELAY_STR2 755c609719bSwdenk CONFIG_AUTOBOOT_STOP_STR2 756c609719bSwdenk CONFIG_ZERO_BOOTDELAY_CHECK 757c609719bSwdenk CONFIG_RESET_TO_RETRY 758c609719bSwdenk 759c609719bSwdenk- Autoboot Command: 760c609719bSwdenk CONFIG_BOOTCOMMAND 761c609719bSwdenk Only needed when CONFIG_BOOTDELAY is enabled; 762c609719bSwdenk define a command string that is automatically executed 763c609719bSwdenk when no character is read on the console interface 764c609719bSwdenk within "Boot Delay" after reset. 765c609719bSwdenk 766c609719bSwdenk CONFIG_BOOTARGS 767c609719bSwdenk This can be used to pass arguments to the bootm 768c609719bSwdenk command. The value of CONFIG_BOOTARGS goes into the 769c609719bSwdenk environment value "bootargs". 770c609719bSwdenk 771c609719bSwdenk CONFIG_RAMBOOT and CONFIG_NFSBOOT 772c609719bSwdenk The value of these goes into the environment as 773c609719bSwdenk "ramboot" and "nfsboot" respectively, and can be used 774c609719bSwdenk as a convenience, when switching between booting from 77511ccc33fSMarcel Ziswiler RAM and NFS. 776c609719bSwdenk 777c609719bSwdenk- Pre-Boot Commands: 778c609719bSwdenk CONFIG_PREBOOT 779c609719bSwdenk 780c609719bSwdenk When this option is #defined, the existence of the 781c609719bSwdenk environment variable "preboot" will be checked 782c609719bSwdenk immediately before starting the CONFIG_BOOTDELAY 783c609719bSwdenk countdown and/or running the auto-boot command resp. 784c609719bSwdenk entering interactive mode. 785c609719bSwdenk 786c609719bSwdenk This feature is especially useful when "preboot" is 787c609719bSwdenk automatically generated or modified. For an example 788c609719bSwdenk see the LWMON board specific code: here "preboot" is 789c609719bSwdenk modified when the user holds down a certain 790c609719bSwdenk combination of keys on the (special) keyboard when 791c609719bSwdenk booting the systems 792c609719bSwdenk 793c609719bSwdenk- Serial Download Echo Mode: 794c609719bSwdenk CONFIG_LOADS_ECHO 795c609719bSwdenk If defined to 1, all characters received during a 796c609719bSwdenk serial download (using the "loads" command) are 797c609719bSwdenk echoed back. This might be needed by some terminal 798c609719bSwdenk emulations (like "cu"), but may as well just take 799c609719bSwdenk time on others. This setting #define's the initial 800c609719bSwdenk value of the "loads_echo" environment variable. 801c609719bSwdenk 802602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined) 803c609719bSwdenk CONFIG_KGDB_BAUDRATE 804c609719bSwdenk Select one of the baudrates listed in 8056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BAUDRATE_TABLE, see below. 806c609719bSwdenk 807c609719bSwdenk- Monitor Functions: 808602ad3b3SJon Loeliger Monitor commands can be included or excluded 809602ad3b3SJon Loeliger from the build by using the #include files 810c6c621bdSStephen Warren <config_cmd_all.h> and #undef'ing unwanted 811c6c621bdSStephen Warren commands, or using <config_cmd_default.h> 812602ad3b3SJon Loeliger and augmenting with additional #define's 813602ad3b3SJon Loeliger for wanted commands. 814c609719bSwdenk 815602ad3b3SJon Loeliger The default command configuration includes all commands 816602ad3b3SJon Loeliger except those marked below with a "*". 817602ad3b3SJon Loeliger 818602ad3b3SJon Loeliger CONFIG_CMD_ASKENV * ask for env variable 819602ad3b3SJon Loeliger CONFIG_CMD_BDI bdinfo 820602ad3b3SJon Loeliger CONFIG_CMD_BEDBUG * Include BedBug Debugger 821602ad3b3SJon Loeliger CONFIG_CMD_BMP * BMP support 822602ad3b3SJon Loeliger CONFIG_CMD_BSP * Board specific commands 823602ad3b3SJon Loeliger CONFIG_CMD_BOOTD bootd 824602ad3b3SJon Loeliger CONFIG_CMD_CACHE * icache, dcache 825602ad3b3SJon Loeliger CONFIG_CMD_CONSOLE coninfo 826710b9938SMike Frysinger CONFIG_CMD_CRC32 * crc32 827602ad3b3SJon Loeliger CONFIG_CMD_DATE * support for RTC, date/time... 828602ad3b3SJon Loeliger CONFIG_CMD_DHCP * DHCP support 829602ad3b3SJon Loeliger CONFIG_CMD_DIAG * Diagnostics 830a7c93104SPeter Tyser CONFIG_CMD_DS4510 * ds4510 I2C gpio commands 831a7c93104SPeter Tyser CONFIG_CMD_DS4510_INFO * ds4510 I2C info command 832a7c93104SPeter Tyser CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd 833a7c93104SPeter Tyser CONFIG_CMD_DS4510_RST * ds4510 I2C rst command 834602ad3b3SJon Loeliger CONFIG_CMD_DTT * Digital Therm and Thermostat 835602ad3b3SJon Loeliger CONFIG_CMD_ECHO echo arguments 836246c6922SPeter Tyser CONFIG_CMD_EDITENV edit env variable 837602ad3b3SJon Loeliger CONFIG_CMD_EEPROM * EEPROM read/write support 838602ad3b3SJon Loeliger CONFIG_CMD_ELF * bootelf, bootvx 8395e2b3e0cSJoe Hershberger CONFIG_CMD_ENV_CALLBACK * display details about env callbacks 840fffad71bSJoe Hershberger CONFIG_CMD_ENV_FLAGS * display details about env flags 8410c79cda0SMike Frysinger CONFIG_CMD_EXPORTENV * export the environment 84203e2ecf6SStephen Warren CONFIG_CMD_EXT2 * ext2 command support 84303e2ecf6SStephen Warren CONFIG_CMD_EXT4 * ext4 command support 844bdab39d3SMike Frysinger CONFIG_CMD_SAVEENV saveenv 845602ad3b3SJon Loeliger CONFIG_CMD_FDC * Floppy Disk Support 84603e2ecf6SStephen Warren CONFIG_CMD_FAT * FAT command support 847602ad3b3SJon Loeliger CONFIG_CMD_FDOS * Dos diskette Support 848602ad3b3SJon Loeliger CONFIG_CMD_FLASH flinfo, erase, protect 849602ad3b3SJon Loeliger CONFIG_CMD_FPGA FPGA device initialization support 850ccca7dfdSBenoît Thébaudeau CONFIG_CMD_FUSE Device fuse support 85153fdc7efSAnton Staaf CONFIG_CMD_GETTIME * Get time since boot 852a641b979SMike Frysinger CONFIG_CMD_GO * the 'go' command (exec code) 853a000b795SKim Phillips CONFIG_CMD_GREPENV * search environment 854bf36c5d5SSimon Glass CONFIG_CMD_HASH * calculate hash / digest 855602ad3b3SJon Loeliger CONFIG_CMD_HWFLOW * RTS/CTS hw flow control 856602ad3b3SJon Loeliger CONFIG_CMD_I2C * I2C serial bus support 857602ad3b3SJon Loeliger CONFIG_CMD_IDE * IDE harddisk support 858602ad3b3SJon Loeliger CONFIG_CMD_IMI iminfo 8598fdf1e0fSVipin Kumar CONFIG_CMD_IMLS List all images found in NOR flash 8608fdf1e0fSVipin Kumar CONFIG_CMD_IMLS_NAND List all images found in NAND flash 861602ad3b3SJon Loeliger CONFIG_CMD_IMMAP * IMMR dump support 8620c79cda0SMike Frysinger CONFIG_CMD_IMPORTENV * import an environment 863c167cc02SJoe Hershberger CONFIG_CMD_INI * import data from an ini file into the env 864602ad3b3SJon Loeliger CONFIG_CMD_IRQ * irqinfo 865602ad3b3SJon Loeliger CONFIG_CMD_ITEST Integer/string test of 2 values 866602ad3b3SJon Loeliger CONFIG_CMD_JFFS2 * JFFS2 Support 867602ad3b3SJon Loeliger CONFIG_CMD_KGDB * kgdb 8681ba7fd25SMike Frysinger CONFIG_CMD_LDRINFO ldrinfo (display Blackfin loader) 869d22c338eSJoe Hershberger CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration 870d22c338eSJoe Hershberger (169.254.*.*) 871602ad3b3SJon Loeliger CONFIG_CMD_LOADB loadb 872602ad3b3SJon Loeliger CONFIG_CMD_LOADS loads 87302c9aa1dSRobin Getz CONFIG_CMD_MD5SUM print md5 message digest 87402c9aa1dSRobin Getz (requires CONFIG_CMD_MEMORY and CONFIG_MD5) 87515a33e49SSimon Glass CONFIG_CMD_MEMINFO * Display detailed memory information 876602ad3b3SJon Loeliger CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base, 877a2681707SWolfgang Denk loop, loopw 878a2681707SWolfgang Denk CONFIG_CMD_MEMTEST mtest 879602ad3b3SJon Loeliger CONFIG_CMD_MISC Misc functions like sleep etc 880602ad3b3SJon Loeliger CONFIG_CMD_MMC * MMC memory mapped support 881602ad3b3SJon Loeliger CONFIG_CMD_MII * MII utility commands 88268d7d651SStefan Roese CONFIG_CMD_MTDPARTS * MTD partition support 883602ad3b3SJon Loeliger CONFIG_CMD_NAND * NAND support 884602ad3b3SJon Loeliger CONFIG_CMD_NET bootp, tftpboot, rarpboot 885e92739d3SPeter Tyser CONFIG_CMD_PCA953X * PCA953x I2C gpio commands 886e92739d3SPeter Tyser CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command 887602ad3b3SJon Loeliger CONFIG_CMD_PCI * pciinfo 888602ad3b3SJon Loeliger CONFIG_CMD_PCMCIA * PCMCIA support 889602ad3b3SJon Loeliger CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network 890602ad3b3SJon Loeliger host 891602ad3b3SJon Loeliger CONFIG_CMD_PORTIO * Port I/O 892ff048ea9SKenneth Waters CONFIG_CMD_READ * Read raw data from partition 893602ad3b3SJon Loeliger CONFIG_CMD_REGINFO * Register dump 894602ad3b3SJon Loeliger CONFIG_CMD_RUN run command in env variable 895d304931fSSimon Glass CONFIG_CMD_SANDBOX * sb command to access sandbox features 896602ad3b3SJon Loeliger CONFIG_CMD_SAVES * save S record dump 897602ad3b3SJon Loeliger CONFIG_CMD_SCSI * SCSI Support 898602ad3b3SJon Loeliger CONFIG_CMD_SDRAM * print SDRAM configuration information 899602ad3b3SJon Loeliger (requires CONFIG_CMD_I2C) 900602ad3b3SJon Loeliger CONFIG_CMD_SETGETDCR Support for DCR Register access 901602ad3b3SJon Loeliger (4xx only) 902f61ec45eSEric Nelson CONFIG_CMD_SF * Read/write/erase SPI NOR flash 903c6b1ee66SAlexander Holler CONFIG_CMD_SHA1SUM print sha1 memory digest 90402c9aa1dSRobin Getz (requires CONFIG_CMD_MEMORY) 9057d861d95SBob Liu CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x 90674de7aefSWolfgang Denk CONFIG_CMD_SOURCE "source" command Support 907602ad3b3SJon Loeliger CONFIG_CMD_SPI * SPI serial bus support 9087a83af07SLuca Ceresoli CONFIG_CMD_TFTPSRV * TFTP transfer in server mode 9091fb7cd49SSimon Glass CONFIG_CMD_TFTPPUT * TFTP put command (upload) 910da83bcd7SJoe Hershberger CONFIG_CMD_TIME * run command and report execution time (ARM specific) 911da83bcd7SJoe Hershberger CONFIG_CMD_TIMER * access to the system tick timer 912602ad3b3SJon Loeliger CONFIG_CMD_USB * USB support 913602ad3b3SJon Loeliger CONFIG_CMD_CDP * Cisco Discover Protocol support 914c8339f51SMarek Vasut CONFIG_CMD_MFSL * Microblaze FSL support 915c609719bSwdenk 916c609719bSwdenk 917c609719bSwdenk EXAMPLE: If you want all functions except of network 918c609719bSwdenk support you can write: 919c609719bSwdenk 920602ad3b3SJon Loeliger #include "config_cmd_all.h" 921602ad3b3SJon Loeliger #undef CONFIG_CMD_NET 922c609719bSwdenk 923213bf8c8SGerald Van Baren Other Commands: 924213bf8c8SGerald Van Baren fdt (flattened device tree) command: CONFIG_OF_LIBFDT 925c609719bSwdenk 926c609719bSwdenk Note: Don't enable the "icache" and "dcache" commands 927602ad3b3SJon Loeliger (configuration option CONFIG_CMD_CACHE) unless you know 928c609719bSwdenk what you (and your U-Boot users) are doing. Data 929c609719bSwdenk cache cannot be enabled on systems like the 8xx or 930c609719bSwdenk 8260 (where accesses to the IMMR region must be 931c609719bSwdenk uncached), and it cannot be disabled on all other 932c609719bSwdenk systems where we (mis-) use the data cache to hold an 933c609719bSwdenk initial stack and some data. 934c609719bSwdenk 935c609719bSwdenk 936c609719bSwdenk XXX - this list needs to get updated! 937c609719bSwdenk 938a5ecbe62SWolfgang Denk- Regular expression support: 939a5ecbe62SWolfgang Denk CONFIG_REGEX 940a5ecbe62SWolfgang Denk If this variable is defined, U-Boot is linked against 941a5ecbe62SWolfgang Denk the SLRE (Super Light Regular Expression) library, 942a5ecbe62SWolfgang Denk which adds regex support to some commands, as for 943a5ecbe62SWolfgang Denk example "env grep" and "setexpr". 944a5ecbe62SWolfgang Denk 94545ba8077SSimon Glass- Device tree: 94645ba8077SSimon Glass CONFIG_OF_CONTROL 94745ba8077SSimon Glass If this variable is defined, U-Boot will use a device tree 94845ba8077SSimon Glass to configure its devices, instead of relying on statically 94945ba8077SSimon Glass compiled #defines in the board file. This option is 95045ba8077SSimon Glass experimental and only available on a few boards. The device 95145ba8077SSimon Glass tree is available in the global data as gd->fdt_blob. 95245ba8077SSimon Glass 9532c0f79e4SSimon Glass U-Boot needs to get its device tree from somewhere. This can 9542c0f79e4SSimon Glass be done using one of the two options below: 955bbb0b128SSimon Glass 956bbb0b128SSimon Glass CONFIG_OF_EMBED 957bbb0b128SSimon Glass If this variable is defined, U-Boot will embed a device tree 958bbb0b128SSimon Glass binary in its image. This device tree file should be in the 959bbb0b128SSimon Glass board directory and called <soc>-<board>.dts. The binary file 960bbb0b128SSimon Glass is then picked up in board_init_f() and made available through 961bbb0b128SSimon Glass the global data structure as gd->blob. 96245ba8077SSimon Glass 9632c0f79e4SSimon Glass CONFIG_OF_SEPARATE 9642c0f79e4SSimon Glass If this variable is defined, U-Boot will build a device tree 9652c0f79e4SSimon Glass binary. It will be called u-boot.dtb. Architecture-specific 9662c0f79e4SSimon Glass code will locate it at run-time. Generally this works by: 9672c0f79e4SSimon Glass 9682c0f79e4SSimon Glass cat u-boot.bin u-boot.dtb >image.bin 9692c0f79e4SSimon Glass 9702c0f79e4SSimon Glass and in fact, U-Boot does this for you, creating a file called 9712c0f79e4SSimon Glass u-boot-dtb.bin which is useful in the common case. You can 9722c0f79e4SSimon Glass still use the individual files if you need something more 9732c0f79e4SSimon Glass exotic. 9742c0f79e4SSimon Glass 975c609719bSwdenk- Watchdog: 976c609719bSwdenk CONFIG_WATCHDOG 977c609719bSwdenk If this variable is defined, it enables watchdog 9786abe6fb6SDetlev Zundel support for the SoC. There must be support in the SoC 9796abe6fb6SDetlev Zundel specific code for a watchdog. For the 8xx and 8260 9806abe6fb6SDetlev Zundel CPUs, the SIU Watchdog feature is enabled in the SYPCR 9816abe6fb6SDetlev Zundel register. When supported for a specific SoC is 9826abe6fb6SDetlev Zundel available, then no further board specific code should 9836abe6fb6SDetlev Zundel be needed to use it. 9846abe6fb6SDetlev Zundel 9856abe6fb6SDetlev Zundel CONFIG_HW_WATCHDOG 9866abe6fb6SDetlev Zundel When using a watchdog circuitry external to the used 9876abe6fb6SDetlev Zundel SoC, then define this variable and provide board 9886abe6fb6SDetlev Zundel specific code for the "hw_watchdog_reset" function. 989c609719bSwdenk 990c1551ea8Sstroese- U-Boot Version: 991c1551ea8Sstroese CONFIG_VERSION_VARIABLE 992c1551ea8Sstroese If this variable is defined, an environment variable 993c1551ea8Sstroese named "ver" is created by U-Boot showing the U-Boot 994c1551ea8Sstroese version as printed by the "version" command. 995a1ea8e51SBenoît Thébaudeau Any change to this variable will be reverted at the 996a1ea8e51SBenoît Thébaudeau next reset. 997c1551ea8Sstroese 998c609719bSwdenk- Real-Time Clock: 999c609719bSwdenk 1000602ad3b3SJon Loeliger When CONFIG_CMD_DATE is selected, the type of the RTC 1001c609719bSwdenk has to be selected, too. Define exactly one of the 1002c609719bSwdenk following options: 1003c609719bSwdenk 1004c609719bSwdenk CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx 1005c609719bSwdenk CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC 10064e8b7544SFabio Estevam CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC 1007c609719bSwdenk CONFIG_RTC_MC146818 - use MC146818 RTC 10081cb8e980Swdenk CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC 1009c609719bSwdenk CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC 10107f70e853Swdenk CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC 10113bac3513Swdenk CONFIG_RTC_DS164x - use Dallas DS164x RTC 10129536dfccSTor Krill CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC 10134c0d4c3bSwdenk CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC 10146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337 101571d19f30SHeiko Schocher CONFIG_SYS_RV3029_TCR - enable trickle charger on 101671d19f30SHeiko Schocher RV3029 RTC. 1017c609719bSwdenk 1018b37c7e5eSwdenk Note that if the RTC uses I2C, then the I2C interface 1019b37c7e5eSwdenk must also be configured. See I2C Support, below. 1020b37c7e5eSwdenk 1021e92739d3SPeter Tyser- GPIO Support: 1022e92739d3SPeter Tyser CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO 1023e92739d3SPeter Tyser CONFIG_PCA953X_INFO - enable pca953x info command 1024e92739d3SPeter Tyser 10255dec49caSChris Packham The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of 10265dec49caSChris Packham chip-ngpio pairs that tell the PCA953X driver the number of 10275dec49caSChris Packham pins supported by a particular chip. 10285dec49caSChris Packham 1029e92739d3SPeter Tyser Note that if the GPIO device uses I2C, then the I2C interface 1030e92739d3SPeter Tyser must also be configured. See I2C Support, below. 1031e92739d3SPeter Tyser 1032c609719bSwdenk- Timestamp Support: 1033c609719bSwdenk 1034c609719bSwdenk When CONFIG_TIMESTAMP is selected, the timestamp 1035c609719bSwdenk (date and time) of an image is printed by image 1036c609719bSwdenk commands like bootm or iminfo. This option is 1037602ad3b3SJon Loeliger automatically enabled when you select CONFIG_CMD_DATE . 1038c609719bSwdenk 1039923c46f9SKarl O. Pinc- Partition Labels (disklabels) Supported: 1040923c46f9SKarl O. Pinc Zero or more of the following: 1041923c46f9SKarl O. Pinc CONFIG_MAC_PARTITION Apple's MacOS partition table. 1042923c46f9SKarl O. Pinc CONFIG_DOS_PARTITION MS Dos partition table, traditional on the 1043923c46f9SKarl O. Pinc Intel architecture, USB sticks, etc. 1044923c46f9SKarl O. Pinc CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc. 1045923c46f9SKarl O. Pinc CONFIG_EFI_PARTITION GPT partition table, common when EFI is the 1046923c46f9SKarl O. Pinc bootloader. Note 2TB partition limit; see 1047923c46f9SKarl O. Pinc disk/part_efi.c 1048923c46f9SKarl O. Pinc CONFIG_MTD_PARTITIONS Memory Technology Device partition table. 1049c609719bSwdenk 1050602ad3b3SJon Loeliger If IDE or SCSI support is enabled (CONFIG_CMD_IDE or 1051218ca724SWolfgang Denk CONFIG_CMD_SCSI) you must configure support for at 1052923c46f9SKarl O. Pinc least one non-MTD partition type as well. 1053c609719bSwdenk 1054c609719bSwdenk- IDE Reset method: 10554d13cbadSwdenk CONFIG_IDE_RESET_ROUTINE - this is defined in several 10564d13cbadSwdenk board configurations files but used nowhere! 1057c609719bSwdenk 10584d13cbadSwdenk CONFIG_IDE_RESET - is this is defined, IDE Reset will 10594d13cbadSwdenk be performed by calling the function 10604d13cbadSwdenk ide_set_reset(int reset) 10614d13cbadSwdenk which has to be defined in a board specific file 1062c609719bSwdenk 1063c609719bSwdenk- ATAPI Support: 1064c609719bSwdenk CONFIG_ATAPI 1065c609719bSwdenk 1066c609719bSwdenk Set this to enable ATAPI support. 1067c609719bSwdenk 1068c40b2956Swdenk- LBA48 Support 1069c40b2956Swdenk CONFIG_LBA48 1070c40b2956Swdenk 1071c40b2956Swdenk Set this to enable support for disks larger than 137GB 10724b142febSHeiko Schocher Also look at CONFIG_SYS_64BIT_LBA. 1073c40b2956Swdenk Whithout these , LBA48 support uses 32bit variables and will 'only' 1074c40b2956Swdenk support disks up to 2.1TB. 1075c40b2956Swdenk 10766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_64BIT_LBA: 1077c40b2956Swdenk When enabled, makes the IDE subsystem use 64bit sector addresses. 1078c40b2956Swdenk Default is 32bit. 1079c40b2956Swdenk 1080c609719bSwdenk- SCSI Support: 1081c609719bSwdenk At the moment only there is only support for the 1082c609719bSwdenk SYM53C8XX SCSI controller; define 1083c609719bSwdenk CONFIG_SCSI_SYM53C8XX to enable it. 1084c609719bSwdenk 10856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and 10866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID * 10876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the 1088c609719bSwdenk maximum numbers of LUNs, SCSI ID's and target 1089c609719bSwdenk devices. 10906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz) 1091c609719bSwdenk 1092447c031bSStefan Reinauer The environment variable 'scsidevs' is set to the number of 1093447c031bSStefan Reinauer SCSI devices found during the last scan. 1094447c031bSStefan Reinauer 1095c609719bSwdenk- NETWORK Support (PCI): 1096682011ffSwdenk CONFIG_E1000 1097ce5207e1SKyle Moffett Support for Intel 8254x/8257x gigabit chips. 1098ce5207e1SKyle Moffett 1099ce5207e1SKyle Moffett CONFIG_E1000_SPI 1100ce5207e1SKyle Moffett Utility code for direct access to the SPI bus on Intel 8257x. 1101ce5207e1SKyle Moffett This does not do anything useful unless you set at least one 1102ce5207e1SKyle Moffett of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC. 1103ce5207e1SKyle Moffett 1104ce5207e1SKyle Moffett CONFIG_E1000_SPI_GENERIC 1105ce5207e1SKyle Moffett Allow generic access to the SPI bus on the Intel 8257x, for 1106ce5207e1SKyle Moffett example with the "sspi" command. 1107ce5207e1SKyle Moffett 1108ce5207e1SKyle Moffett CONFIG_CMD_E1000 1109ce5207e1SKyle Moffett Management command for E1000 devices. When used on devices 1110ce5207e1SKyle Moffett with SPI support you can reprogram the EEPROM from U-Boot. 1111682011ffSwdenk 1112ac3315c2SAndre Schwarz CONFIG_E1000_FALLBACK_MAC 111311ccc33fSMarcel Ziswiler default MAC for empty EEPROM after production. 1114ac3315c2SAndre Schwarz 1115c609719bSwdenk CONFIG_EEPRO100 1116c609719bSwdenk Support for Intel 82557/82559/82559ER chips. 111711ccc33fSMarcel Ziswiler Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM 1118c609719bSwdenk write routine for first time initialisation. 1119c609719bSwdenk 1120c609719bSwdenk CONFIG_TULIP 1121c609719bSwdenk Support for Digital 2114x chips. 1122c609719bSwdenk Optional CONFIG_TULIP_SELECT_MEDIA for board specific 1123c609719bSwdenk modem chip initialisation (KS8761/QS6611). 1124c609719bSwdenk 1125c609719bSwdenk CONFIG_NATSEMI 1126c609719bSwdenk Support for National dp83815 chips. 1127c609719bSwdenk 1128c609719bSwdenk CONFIG_NS8382X 1129c609719bSwdenk Support for National dp8382[01] gigabit chips. 1130c609719bSwdenk 113145219c46Swdenk- NETWORK Support (other): 113245219c46Swdenk 1133c041e9d2SJens Scharsig CONFIG_DRIVER_AT91EMAC 1134c041e9d2SJens Scharsig Support for AT91RM9200 EMAC. 1135c041e9d2SJens Scharsig 1136c041e9d2SJens Scharsig CONFIG_RMII 1137c041e9d2SJens Scharsig Define this to use reduced MII inteface 1138c041e9d2SJens Scharsig 1139c041e9d2SJens Scharsig CONFIG_DRIVER_AT91EMAC_QUIET 1140c041e9d2SJens Scharsig If this defined, the driver is quiet. 1141c041e9d2SJens Scharsig The driver doen't show link status messages. 1142c041e9d2SJens Scharsig 1143efdd7319SRob Herring CONFIG_CALXEDA_XGMAC 1144efdd7319SRob Herring Support for the Calxeda XGMAC device 1145efdd7319SRob Herring 11463bb46d23SAshok CONFIG_LAN91C96 114745219c46Swdenk Support for SMSC's LAN91C96 chips. 114845219c46Swdenk 114945219c46Swdenk CONFIG_LAN91C96_BASE 115045219c46Swdenk Define this to hold the physical address 115145219c46Swdenk of the LAN91C96's I/O space 115245219c46Swdenk 115345219c46Swdenk CONFIG_LAN91C96_USE_32_BIT 115445219c46Swdenk Define this to enable 32 bit addressing 115545219c46Swdenk 11563bb46d23SAshok CONFIG_SMC91111 1157f39748aeSwdenk Support for SMSC's LAN91C111 chip 1158f39748aeSwdenk 1159f39748aeSwdenk CONFIG_SMC91111_BASE 1160f39748aeSwdenk Define this to hold the physical address 1161f39748aeSwdenk of the device (I/O space) 1162f39748aeSwdenk 1163f39748aeSwdenk CONFIG_SMC_USE_32_BIT 1164f39748aeSwdenk Define this if data bus is 32 bits 1165f39748aeSwdenk 1166f39748aeSwdenk CONFIG_SMC_USE_IOFUNCS 1167f39748aeSwdenk Define this to use i/o functions instead of macros 1168f39748aeSwdenk (some hardware wont work with macros) 1169f39748aeSwdenk 1170dc02badaSHeiko Schocher CONFIG_DRIVER_TI_EMAC 1171dc02badaSHeiko Schocher Support for davinci emac 1172dc02badaSHeiko Schocher 1173dc02badaSHeiko Schocher CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT 1174dc02badaSHeiko Schocher Define this if you have more then 3 PHYs. 1175dc02badaSHeiko Schocher 1176b3dbf4a5SMacpaul Lin CONFIG_FTGMAC100 1177b3dbf4a5SMacpaul Lin Support for Faraday's FTGMAC100 Gigabit SoC Ethernet 1178b3dbf4a5SMacpaul Lin 1179b3dbf4a5SMacpaul Lin CONFIG_FTGMAC100_EGIGA 1180b3dbf4a5SMacpaul Lin Define this to use GE link update with gigabit PHY. 1181b3dbf4a5SMacpaul Lin Define this if FTGMAC100 is connected to gigabit PHY. 1182b3dbf4a5SMacpaul Lin If your system has 10/100 PHY only, it might not occur 1183b3dbf4a5SMacpaul Lin wrong behavior. Because PHY usually return timeout or 1184b3dbf4a5SMacpaul Lin useless data when polling gigabit status and gigabit 1185b3dbf4a5SMacpaul Lin control registers. This behavior won't affect the 1186b3dbf4a5SMacpaul Lin correctnessof 10/100 link speed update. 1187b3dbf4a5SMacpaul Lin 1188c2fff331SMike Rapoport CONFIG_SMC911X 1189557b377dSJens Gehrlein Support for SMSC's LAN911x and LAN921x chips 1190557b377dSJens Gehrlein 1191c2fff331SMike Rapoport CONFIG_SMC911X_BASE 1192557b377dSJens Gehrlein Define this to hold the physical address 1193557b377dSJens Gehrlein of the device (I/O space) 1194557b377dSJens Gehrlein 1195c2fff331SMike Rapoport CONFIG_SMC911X_32_BIT 1196557b377dSJens Gehrlein Define this if data bus is 32 bits 1197557b377dSJens Gehrlein 1198c2fff331SMike Rapoport CONFIG_SMC911X_16_BIT 1199557b377dSJens Gehrlein Define this if data bus is 16 bits. If your processor 1200557b377dSJens Gehrlein automatically converts one 32 bit word to two 16 bit 1201c2fff331SMike Rapoport words you may also try CONFIG_SMC911X_32_BIT. 1202557b377dSJens Gehrlein 12033d0075faSYoshihiro Shimoda CONFIG_SH_ETHER 12043d0075faSYoshihiro Shimoda Support for Renesas on-chip Ethernet controller 12053d0075faSYoshihiro Shimoda 12063d0075faSYoshihiro Shimoda CONFIG_SH_ETHER_USE_PORT 12073d0075faSYoshihiro Shimoda Define the number of ports to be used 12083d0075faSYoshihiro Shimoda 12093d0075faSYoshihiro Shimoda CONFIG_SH_ETHER_PHY_ADDR 12103d0075faSYoshihiro Shimoda Define the ETH PHY's address 12113d0075faSYoshihiro Shimoda 121268260aabSYoshihiro Shimoda CONFIG_SH_ETHER_CACHE_WRITEBACK 121368260aabSYoshihiro Shimoda If this option is set, the driver enables cache flush. 121468260aabSYoshihiro Shimoda 12155e124724SVadim Bendebury- TPM Support: 121690899cc0SChe-liang Chiou CONFIG_TPM 121790899cc0SChe-liang Chiou Support TPM devices. 121890899cc0SChe-liang Chiou 12191b393db5STom Wai-Hong Tam CONFIG_TPM_TIS_I2C 12201b393db5STom Wai-Hong Tam Support for i2c bus TPM devices. Only one device 12211b393db5STom Wai-Hong Tam per system is supported at this time. 12221b393db5STom Wai-Hong Tam 12231b393db5STom Wai-Hong Tam CONFIG_TPM_TIS_I2C_BUS_NUMBER 12241b393db5STom Wai-Hong Tam Define the the i2c bus number for the TPM device 12251b393db5STom Wai-Hong Tam 12261b393db5STom Wai-Hong Tam CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS 12271b393db5STom Wai-Hong Tam Define the TPM's address on the i2c bus 12281b393db5STom Wai-Hong Tam 12291b393db5STom Wai-Hong Tam CONFIG_TPM_TIS_I2C_BURST_LIMITATION 12301b393db5STom Wai-Hong Tam Define the burst count bytes upper limit 12311b393db5STom Wai-Hong Tam 123290899cc0SChe-liang Chiou CONFIG_TPM_TIS_LPC 12335e124724SVadim Bendebury Support for generic parallel port TPM devices. Only one device 12345e124724SVadim Bendebury per system is supported at this time. 12355e124724SVadim Bendebury 12365e124724SVadim Bendebury CONFIG_TPM_TIS_BASE_ADDRESS 12375e124724SVadim Bendebury Base address where the generic TPM device is mapped 12385e124724SVadim Bendebury to. Contemporary x86 systems usually map it at 12395e124724SVadim Bendebury 0xfed40000. 12405e124724SVadim Bendebury 1241c609719bSwdenk- USB Support: 1242c609719bSwdenk At the moment only the UHCI host controller is 12434d13cbadSwdenk supported (PIP405, MIP405, MPC5200); define 1244c609719bSwdenk CONFIG_USB_UHCI to enable it. 1245c609719bSwdenk define CONFIG_USB_KEYBOARD to enable the USB Keyboard 124630d56faeSwdenk and define CONFIG_USB_STORAGE to enable the USB 1247c609719bSwdenk storage devices. 1248c609719bSwdenk Note: 1249c609719bSwdenk Supported are USB Keyboards and USB Floppy drives 1250c609719bSwdenk (TEAC FD-05PUB). 12514d13cbadSwdenk MPC5200 USB requires additional defines: 12524d13cbadSwdenk CONFIG_USB_CLOCK 12534d13cbadSwdenk for 528 MHz Clock: 0x0001bbbb 1254307ecb6dSEric Millbrandt CONFIG_PSC3_USB 1255307ecb6dSEric Millbrandt for USB on PSC3 12564d13cbadSwdenk CONFIG_USB_CONFIG 12574d13cbadSwdenk for differential drivers: 0x00001000 12584d13cbadSwdenk for single ended drivers: 0x00005000 1259307ecb6dSEric Millbrandt for differential drivers on PSC3: 0x00000100 1260307ecb6dSEric Millbrandt for single ended drivers on PSC3: 0x00004100 12616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_USB_EVENT_POLL 1262fdcfaa1bSZhang Wei May be defined to allow interrupt polling 1263fdcfaa1bSZhang Wei instead of using asynchronous interrupts 12644d13cbadSwdenk 12659ab4ce22SSimon Glass CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the 12669ab4ce22SSimon Glass txfilltuning field in the EHCI controller on reset. 12679ab4ce22SSimon Glass 1268aa155058SKuo-Jung Su CONFIG_USB_HUB_MIN_POWER_ON_DELAY defines the minimum 1269aa155058SKuo-Jung Su interval for usb hub power-on delay.(minimum 100msec) 1270aa155058SKuo-Jung Su 127116c8d5e7SWolfgang Denk- USB Device: 127216c8d5e7SWolfgang Denk Define the below if you wish to use the USB console. 127316c8d5e7SWolfgang Denk Once firmware is rebuilt from a serial console issue the 127416c8d5e7SWolfgang Denk command "setenv stdin usbtty; setenv stdout usbtty" and 127511ccc33fSMarcel Ziswiler attach your USB cable. The Unix command "dmesg" should print 127616c8d5e7SWolfgang Denk it has found a new device. The environment variable usbtty 127716c8d5e7SWolfgang Denk can be set to gserial or cdc_acm to enable your device to 127816c8d5e7SWolfgang Denk appear to a USB host as a Linux gserial device or a 127916c8d5e7SWolfgang Denk Common Device Class Abstract Control Model serial device. 128016c8d5e7SWolfgang Denk If you select usbtty = gserial you should be able to enumerate 128116c8d5e7SWolfgang Denk a Linux host by 128216c8d5e7SWolfgang Denk # modprobe usbserial vendor=0xVendorID product=0xProductID 128316c8d5e7SWolfgang Denk else if using cdc_acm, simply setting the environment 128416c8d5e7SWolfgang Denk variable usbtty to be cdc_acm should suffice. The following 128516c8d5e7SWolfgang Denk might be defined in YourBoardName.h 128616c8d5e7SWolfgang Denk 128716c8d5e7SWolfgang Denk CONFIG_USB_DEVICE 128816c8d5e7SWolfgang Denk Define this to build a UDC device 128916c8d5e7SWolfgang Denk 129016c8d5e7SWolfgang Denk CONFIG_USB_TTY 129116c8d5e7SWolfgang Denk Define this to have a tty type of device available to 129216c8d5e7SWolfgang Denk talk to the UDC device 129316c8d5e7SWolfgang Denk 1294f9da0f89SVipin KUMAR CONFIG_USBD_HS 1295f9da0f89SVipin KUMAR Define this to enable the high speed support for usb 1296f9da0f89SVipin KUMAR device and usbtty. If this feature is enabled, a routine 1297f9da0f89SVipin KUMAR int is_usbd_high_speed(void) 1298f9da0f89SVipin KUMAR also needs to be defined by the driver to dynamically poll 1299f9da0f89SVipin KUMAR whether the enumeration has succeded at high speed or full 1300f9da0f89SVipin KUMAR speed. 1301f9da0f89SVipin KUMAR 13026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_CONSOLE_IS_IN_ENV 130316c8d5e7SWolfgang Denk Define this if you want stdin, stdout &/or stderr to 130416c8d5e7SWolfgang Denk be set to usbtty. 130516c8d5e7SWolfgang Denk 130616c8d5e7SWolfgang Denk mpc8xx: 13076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_USB_EXTC_CLK 0xBLAH 130816c8d5e7SWolfgang Denk Derive USB clock from external clock "blah" 13096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_USB_EXTC_CLK 0x02 131016c8d5e7SWolfgang Denk 13116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_USB_BRG_CLK 0xBLAH 131216c8d5e7SWolfgang Denk Derive USB clock from brgclk 13136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_USB_BRG_CLK 0x04 131416c8d5e7SWolfgang Denk 131516c8d5e7SWolfgang Denk If you have a USB-IF assigned VendorID then you may wish to 131616c8d5e7SWolfgang Denk define your own vendor specific values either in BoardName.h 131716c8d5e7SWolfgang Denk or directly in usbd_vendor_info.h. If you don't define 131816c8d5e7SWolfgang Denk CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME, 131916c8d5e7SWolfgang Denk CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot 132016c8d5e7SWolfgang Denk should pretend to be a Linux device to it's target host. 132116c8d5e7SWolfgang Denk 132216c8d5e7SWolfgang Denk CONFIG_USBD_MANUFACTURER 132316c8d5e7SWolfgang Denk Define this string as the name of your company for 132416c8d5e7SWolfgang Denk - CONFIG_USBD_MANUFACTURER "my company" 132516c8d5e7SWolfgang Denk 132616c8d5e7SWolfgang Denk CONFIG_USBD_PRODUCT_NAME 132716c8d5e7SWolfgang Denk Define this string as the name of your product 132816c8d5e7SWolfgang Denk - CONFIG_USBD_PRODUCT_NAME "acme usb device" 132916c8d5e7SWolfgang Denk 133016c8d5e7SWolfgang Denk CONFIG_USBD_VENDORID 133116c8d5e7SWolfgang Denk Define this as your assigned Vendor ID from the USB 133216c8d5e7SWolfgang Denk Implementors Forum. This *must* be a genuine Vendor ID 133316c8d5e7SWolfgang Denk to avoid polluting the USB namespace. 133416c8d5e7SWolfgang Denk - CONFIG_USBD_VENDORID 0xFFFF 133516c8d5e7SWolfgang Denk 133616c8d5e7SWolfgang Denk CONFIG_USBD_PRODUCTID 133716c8d5e7SWolfgang Denk Define this as the unique Product ID 133816c8d5e7SWolfgang Denk for your device 133916c8d5e7SWolfgang Denk - CONFIG_USBD_PRODUCTID 0xFFFF 1340c609719bSwdenk 1341d70a560fSIgor Grinberg- ULPI Layer Support: 1342d70a560fSIgor Grinberg The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via 1343d70a560fSIgor Grinberg the generic ULPI layer. The generic layer accesses the ULPI PHY 1344d70a560fSIgor Grinberg via the platform viewport, so you need both the genric layer and 1345d70a560fSIgor Grinberg the viewport enabled. Currently only Chipidea/ARC based 1346d70a560fSIgor Grinberg viewport is supported. 1347d70a560fSIgor Grinberg To enable the ULPI layer support, define CONFIG_USB_ULPI and 1348d70a560fSIgor Grinberg CONFIG_USB_ULPI_VIEWPORT in your board configuration file. 13496d365ea0SLucas Stach If your ULPI phy needs a different reference clock than the 13506d365ea0SLucas Stach standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to 13516d365ea0SLucas Stach the appropriate value in Hz. 1352c609719bSwdenk 1353c609719bSwdenk- MMC Support: 1354c609719bSwdenk The MMC controller on the Intel PXA is supported. To 1355c609719bSwdenk enable this define CONFIG_MMC. The MMC can be 1356c609719bSwdenk accessed from the boot prompt by mapping the device 1357c609719bSwdenk to physical memory similar to flash. Command line is 1358602ad3b3SJon Loeliger enabled with CONFIG_CMD_MMC. The MMC driver also works with 1359602ad3b3SJon Loeliger the FAT fs. This is enabled with CONFIG_CMD_FAT. 1360c609719bSwdenk 1361afb35666SYoshihiro Shimoda CONFIG_SH_MMCIF 1362afb35666SYoshihiro Shimoda Support for Renesas on-chip MMCIF controller 1363afb35666SYoshihiro Shimoda 1364afb35666SYoshihiro Shimoda CONFIG_SH_MMCIF_ADDR 1365afb35666SYoshihiro Shimoda Define the base address of MMCIF registers 1366afb35666SYoshihiro Shimoda 1367afb35666SYoshihiro Shimoda CONFIG_SH_MMCIF_CLK 1368afb35666SYoshihiro Shimoda Define the clock frequency for MMCIF 1369afb35666SYoshihiro Shimoda 1370b3ba6e94STom Rini- USB Device Firmware Update (DFU) class support: 1371b3ba6e94STom Rini CONFIG_DFU_FUNCTION 1372b3ba6e94STom Rini This enables the USB portion of the DFU USB class 1373b3ba6e94STom Rini 1374b3ba6e94STom Rini CONFIG_CMD_DFU 1375b3ba6e94STom Rini This enables the command "dfu" which is used to have 1376b3ba6e94STom Rini U-Boot create a DFU class device via USB. This command 1377b3ba6e94STom Rini requires that the "dfu_alt_info" environment variable be 1378b3ba6e94STom Rini set and define the alt settings to expose to the host. 1379b3ba6e94STom Rini 1380b3ba6e94STom Rini CONFIG_DFU_MMC 1381b3ba6e94STom Rini This enables support for exposing (e)MMC devices via DFU. 1382b3ba6e94STom Rini 1383c6631764SPantelis Antoniou CONFIG_DFU_NAND 1384c6631764SPantelis Antoniou This enables support for exposing NAND devices via DFU. 1385c6631764SPantelis Antoniou 1386ea2453d5SPantelis Antoniou CONFIG_SYS_DFU_MAX_FILE_SIZE 1387ea2453d5SPantelis Antoniou When updating files rather than the raw storage device, 1388ea2453d5SPantelis Antoniou we use a static buffer to copy the file into and then write 1389ea2453d5SPantelis Antoniou the buffer once we've been given the whole file. Define 1390ea2453d5SPantelis Antoniou this to the maximum filesize (in bytes) for the buffer. 1391ea2453d5SPantelis Antoniou Default is 4 MiB if undefined. 1392ea2453d5SPantelis Antoniou 13936705d81eSwdenk- Journaling Flash filesystem support: 13946705d81eSwdenk CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE, 13956705d81eSwdenk CONFIG_JFFS2_NAND_DEV 13966705d81eSwdenk Define these for a default partition on a NAND device 13976705d81eSwdenk 13986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS2_FIRST_SECTOR, 13996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS 14006705d81eSwdenk Define these for a default partition on a NOR device 14016705d81eSwdenk 14026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS_CUSTOM_PART 14036705d81eSwdenk Define this to create an own partition. You have to provide a 14046705d81eSwdenk function struct part_info* jffs2_part_info(int part_num) 14056705d81eSwdenk 14066705d81eSwdenk If you define only one JFFS2 partition you may also want to 14076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_JFFS_SINGLE_PART 1 14086705d81eSwdenk to disable the command chpart. This is the default when you 14096705d81eSwdenk have not defined a custom partition 14106705d81eSwdenk 1411c30a15e5SDonggeun Kim- FAT(File Allocation Table) filesystem write function support: 1412c30a15e5SDonggeun Kim CONFIG_FAT_WRITE 1413656f4c65SDonggeun Kim 1414656f4c65SDonggeun Kim Define this to enable support for saving memory data as a 1415656f4c65SDonggeun Kim file in FAT formatted partition. 1416656f4c65SDonggeun Kim 1417656f4c65SDonggeun Kim This will also enable the command "fatwrite" enabling the 1418656f4c65SDonggeun Kim user to write files to FAT. 1419c30a15e5SDonggeun Kim 142084cd9327SGabe BlackCBFS (Coreboot Filesystem) support 142184cd9327SGabe Black CONFIG_CMD_CBFS 142284cd9327SGabe Black 142384cd9327SGabe Black Define this to enable support for reading from a Coreboot 142484cd9327SGabe Black filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls 142584cd9327SGabe Black and cbfsload. 142684cd9327SGabe Black 1427c609719bSwdenk- Keyboard Support: 1428c609719bSwdenk CONFIG_ISA_KEYBOARD 1429c609719bSwdenk 1430c609719bSwdenk Define this to enable standard (PC-Style) keyboard 1431c609719bSwdenk support 1432c609719bSwdenk 1433c609719bSwdenk CONFIG_I8042_KBD 1434c609719bSwdenk Standard PC keyboard driver with US (is default) and 1435c609719bSwdenk GERMAN key layout (switch via environment 'keymap=de') support. 1436c609719bSwdenk Export function i8042_kbd_init, i8042_tstc and i8042_getc 1437c609719bSwdenk for cfb_console. Supports cursor blinking. 1438c609719bSwdenk 1439c609719bSwdenk- Video support: 1440c609719bSwdenk CONFIG_VIDEO 1441c609719bSwdenk 1442c609719bSwdenk Define this to enable video support (for output to 1443c609719bSwdenk video). 1444c609719bSwdenk 1445c609719bSwdenk CONFIG_VIDEO_CT69000 1446c609719bSwdenk 1447c609719bSwdenk Enable Chips & Technologies 69000 Video chip 1448c609719bSwdenk 1449c609719bSwdenk CONFIG_VIDEO_SMI_LYNXEM 1450eeb1b77bSwdenk Enable Silicon Motion SMI 712/710/810 Video chip. The 1451eeb1b77bSwdenk video output is selected via environment 'videoout' 1452eeb1b77bSwdenk (1 = LCD and 2 = CRT). If videoout is undefined, CRT is 1453eeb1b77bSwdenk assumed. 1454c609719bSwdenk 1455eeb1b77bSwdenk For the CT69000 and SMI_LYNXEM drivers, videomode is 145611ccc33fSMarcel Ziswiler selected via environment 'videomode'. Two different ways 1457eeb1b77bSwdenk are possible: 1458eeb1b77bSwdenk - "videomode=num" 'num' is a standard LiLo mode numbers. 1459eeb1b77bSwdenk Following standard modes are supported (* is default): 1460eeb1b77bSwdenk 1461eeb1b77bSwdenk Colors 640x480 800x600 1024x768 1152x864 1280x1024 1462eeb1b77bSwdenk -------------+--------------------------------------------- 1463eeb1b77bSwdenk 8 bits | 0x301* 0x303 0x305 0x161 0x307 1464eeb1b77bSwdenk 15 bits | 0x310 0x313 0x316 0x162 0x319 1465eeb1b77bSwdenk 16 bits | 0x311 0x314 0x317 0x163 0x31A 1466eeb1b77bSwdenk 24 bits | 0x312 0x315 0x318 ? 0x31B 1467eeb1b77bSwdenk -------------+--------------------------------------------- 1468c609719bSwdenk (i.e. setenv videomode 317; saveenv; reset;) 1469c609719bSwdenk 1470eeb1b77bSwdenk - "videomode=bootargs" all the video parameters are parsed 14717817cb20SMarcel Ziswiler from the bootargs. (See drivers/video/videomodes.c) 1472eeb1b77bSwdenk 1473eeb1b77bSwdenk 1474a6c7ad2fSwdenk CONFIG_VIDEO_SED13806 1475a6c7ad2fSwdenk Enable Epson SED13806 driver. This driver supports 8bpp 1476a6c7ad2fSwdenk and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP 1477a6c7ad2fSwdenk or CONFIG_VIDEO_SED13806_16BPP 1478a6c7ad2fSwdenk 14797d3053fbSTimur Tabi CONFIG_FSL_DIU_FB 14807d3053fbSTimur Tabi Enable the Freescale DIU video driver. Reference boards for 14817d3053fbSTimur Tabi SOCs that have a DIU should define this macro to enable DIU 14827d3053fbSTimur Tabi support, and should also define these other macros: 14837d3053fbSTimur Tabi 14847d3053fbSTimur Tabi CONFIG_SYS_DIU_ADDR 14857d3053fbSTimur Tabi CONFIG_VIDEO 14867d3053fbSTimur Tabi CONFIG_CMD_BMP 14877d3053fbSTimur Tabi CONFIG_CFB_CONSOLE 14887d3053fbSTimur Tabi CONFIG_VIDEO_SW_CURSOR 14897d3053fbSTimur Tabi CONFIG_VGA_AS_SINGLE_DEVICE 14907d3053fbSTimur Tabi CONFIG_VIDEO_LOGO 14917d3053fbSTimur Tabi CONFIG_VIDEO_BMP_LOGO 14927d3053fbSTimur Tabi 1493ba8e76bdSTimur Tabi The DIU driver will look for the 'video-mode' environment 1494ba8e76bdSTimur Tabi variable, and if defined, enable the DIU as a console during 1495ba8e76bdSTimur Tabi boot. See the documentation file README.video for a 1496ba8e76bdSTimur Tabi description of this variable. 14977d3053fbSTimur Tabi 1498058d59b0SSimon Glass CONFIG_VIDEO_VGA 1499058d59b0SSimon Glass 1500058d59b0SSimon Glass Enable the VGA video / BIOS for x86. The alternative if you 1501058d59b0SSimon Glass are using coreboot is to use the coreboot frame buffer 1502058d59b0SSimon Glass driver. 1503058d59b0SSimon Glass 1504058d59b0SSimon Glass 1505682011ffSwdenk- Keyboard Support: 1506682011ffSwdenk CONFIG_KEYBOARD 1507682011ffSwdenk 1508682011ffSwdenk Define this to enable a custom keyboard support. 1509682011ffSwdenk This simply calls drv_keyboard_init() which must be 1510682011ffSwdenk defined in your board-specific files. 1511682011ffSwdenk The only board using this so far is RBC823. 1512a6c7ad2fSwdenk 1513c609719bSwdenk- LCD Support: CONFIG_LCD 1514c609719bSwdenk 1515c609719bSwdenk Define this to enable LCD support (for output to LCD 1516c609719bSwdenk display); also select one of the supported displays 1517c609719bSwdenk by defining one of these: 1518c609719bSwdenk 151939cf4804SStelian Pop CONFIG_ATMEL_LCD: 152039cf4804SStelian Pop 152139cf4804SStelian Pop HITACHI TX09D70VM1CCA, 3.5", 240x320. 152239cf4804SStelian Pop 1523fd3103bbSwdenk CONFIG_NEC_NL6448AC33: 1524c609719bSwdenk 1525fd3103bbSwdenk NEC NL6448AC33-18. Active, color, single scan. 1526c609719bSwdenk 1527fd3103bbSwdenk CONFIG_NEC_NL6448BC20 1528c609719bSwdenk 1529fd3103bbSwdenk NEC NL6448BC20-08. 6.5", 640x480. 1530fd3103bbSwdenk Active, color, single scan. 1531fd3103bbSwdenk 1532fd3103bbSwdenk CONFIG_NEC_NL6448BC33_54 1533fd3103bbSwdenk 1534fd3103bbSwdenk NEC NL6448BC33-54. 10.4", 640x480. 1535c609719bSwdenk Active, color, single scan. 1536c609719bSwdenk 1537c609719bSwdenk CONFIG_SHARP_16x9 1538c609719bSwdenk 1539c609719bSwdenk Sharp 320x240. Active, color, single scan. 1540c609719bSwdenk It isn't 16x9, and I am not sure what it is. 1541c609719bSwdenk 1542c609719bSwdenk CONFIG_SHARP_LQ64D341 1543c609719bSwdenk 1544c609719bSwdenk Sharp LQ64D341 display, 640x480. 1545c609719bSwdenk Active, color, single scan. 1546c609719bSwdenk 1547c609719bSwdenk CONFIG_HLD1045 1548c609719bSwdenk 1549c609719bSwdenk HLD1045 display, 640x480. 1550c609719bSwdenk Active, color, single scan. 1551c609719bSwdenk 1552c609719bSwdenk CONFIG_OPTREX_BW 1553c609719bSwdenk 1554c609719bSwdenk Optrex CBL50840-2 NF-FW 99 22 M5 1555c609719bSwdenk or 1556c609719bSwdenk Hitachi LMG6912RPFC-00T 1557c609719bSwdenk or 1558c609719bSwdenk Hitachi SP14Q002 1559c609719bSwdenk 1560c609719bSwdenk 320x240. Black & white. 1561c609719bSwdenk 1562c609719bSwdenk Normally display is black on white background; define 15636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_WHITE_ON_BLACK to get it inverted. 1564c609719bSwdenk 1565676d319eSSimon Glass CONFIG_LCD_ALIGNMENT 1566676d319eSSimon Glass 1567676d319eSSimon Glass Normally the LCD is page-aligned (tyically 4KB). If this is 1568676d319eSSimon Glass defined then the LCD will be aligned to this value instead. 1569676d319eSSimon Glass For ARM it is sometimes useful to use MMU_SECTION_SIZE 1570676d319eSSimon Glass here, since it is cheaper to change data cache settings on 1571676d319eSSimon Glass a per-section basis. 1572676d319eSSimon Glass 15730d89efefSSimon Glass CONFIG_CONSOLE_SCROLL_LINES 15740d89efefSSimon Glass 15750d89efefSSimon Glass When the console need to be scrolled, this is the number of 15760d89efefSSimon Glass lines to scroll by. It defaults to 1. Increasing this makes 15770d89efefSSimon Glass the console jump but can help speed up operation when scrolling 15780d89efefSSimon Glass is slow. 1579676d319eSSimon Glass 158045d7f525STom Wai-Hong Tam CONFIG_LCD_BMP_RLE8 158145d7f525STom Wai-Hong Tam 158245d7f525STom Wai-Hong Tam Support drawing of RLE8-compressed bitmaps on the LCD. 158345d7f525STom Wai-Hong Tam 1584735987c5STom Wai-Hong Tam CONFIG_I2C_EDID 1585735987c5STom Wai-Hong Tam 1586735987c5STom Wai-Hong Tam Enables an 'i2c edid' command which can read EDID 1587735987c5STom Wai-Hong Tam information over I2C from an attached LCD display. 1588735987c5STom Wai-Hong Tam 15897152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN 1590d791b1dcSwdenk 1591d791b1dcSwdenk If this option is set, the environment is checked for 1592d791b1dcSwdenk a variable "splashimage". If found, the usual display 1593d791b1dcSwdenk of logo, copyright and system information on the LCD 1594e94d2cd9Swdenk is suppressed and the BMP image at the address 1595d791b1dcSwdenk specified in "splashimage" is loaded instead. The 1596d791b1dcSwdenk console is redirected to the "nulldev", too. This 1597d791b1dcSwdenk allows for a "silent" boot where a splash screen is 1598d791b1dcSwdenk loaded very quickly after power-on. 1599d791b1dcSwdenk 1600c0880485SNikita Kiryanov CONFIG_SPLASHIMAGE_GUARD 1601c0880485SNikita Kiryanov 1602c0880485SNikita Kiryanov If this option is set, then U-Boot will prevent the environment 1603c0880485SNikita Kiryanov variable "splashimage" from being set to a problematic address 1604c0880485SNikita Kiryanov (see README.displaying-bmps and README.arm-unaligned-accesses). 1605c0880485SNikita Kiryanov This option is useful for targets where, due to alignment 1606c0880485SNikita Kiryanov restrictions, an improperly aligned BMP image will cause a data 1607c0880485SNikita Kiryanov abort. If you think you will not have problems with unaligned 1608c0880485SNikita Kiryanov accesses (for example because your toolchain prevents them) 1609c0880485SNikita Kiryanov there is no need to set this option. 1610c0880485SNikita Kiryanov 16111ca298ceSMatthias Weisser CONFIG_SPLASH_SCREEN_ALIGN 16121ca298ceSMatthias Weisser 16131ca298ceSMatthias Weisser If this option is set the splash image can be freely positioned 16141ca298ceSMatthias Weisser on the screen. Environment variable "splashpos" specifies the 16151ca298ceSMatthias Weisser position as "x,y". If a positive number is given it is used as 16161ca298ceSMatthias Weisser number of pixel from left/top. If a negative number is given it 16171ca298ceSMatthias Weisser is used as number of pixel from right/bottom. You can also 16181ca298ceSMatthias Weisser specify 'm' for centering the image. 16191ca298ceSMatthias Weisser 16201ca298ceSMatthias Weisser Example: 16211ca298ceSMatthias Weisser setenv splashpos m,m 16221ca298ceSMatthias Weisser => image at center of screen 16231ca298ceSMatthias Weisser 16241ca298ceSMatthias Weisser setenv splashpos 30,20 16251ca298ceSMatthias Weisser => image at x = 30 and y = 20 16261ca298ceSMatthias Weisser 16271ca298ceSMatthias Weisser setenv splashpos -10,m 16281ca298ceSMatthias Weisser => vertically centered image 16291ca298ceSMatthias Weisser at x = dspWidth - bmpWidth - 9 16301ca298ceSMatthias Weisser 1631581bb419SNikita Kiryanov CONFIG_SPLASH_SCREEN_PREPARE 1632581bb419SNikita Kiryanov 1633581bb419SNikita Kiryanov If this option is set then the board_splash_screen_prepare() 1634581bb419SNikita Kiryanov function, which must be defined in your code, is called as part 1635581bb419SNikita Kiryanov of the splash screen display sequence. It gives the board an 1636581bb419SNikita Kiryanov opportunity to prepare the splash image data before it is 1637581bb419SNikita Kiryanov processed and sent to the frame buffer by U-Boot. 1638581bb419SNikita Kiryanov 163998f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP 164098f4a3dfSStefan Roese 164198f4a3dfSStefan Roese If this option is set, additionally to standard BMP 164298f4a3dfSStefan Roese images, gzipped BMP images can be displayed via the 164398f4a3dfSStefan Roese splashscreen support or the bmp command. 164498f4a3dfSStefan Roese 1645d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8 1646d5011762SAnatolij Gustschin 1647d5011762SAnatolij Gustschin If this option is set, 8-bit RLE compressed BMP images 1648d5011762SAnatolij Gustschin can be displayed via the splashscreen support or the 1649d5011762SAnatolij Gustschin bmp command. 1650d5011762SAnatolij Gustschin 1651f2b96dfbSLei Wen- Do compresssing for memory range: 1652f2b96dfbSLei Wen CONFIG_CMD_ZIP 1653f2b96dfbSLei Wen 1654f2b96dfbSLei Wen If this option is set, it would use zlib deflate method 1655f2b96dfbSLei Wen to compress the specified memory at its best effort. 1656f2b96dfbSLei Wen 1657c29fdfc1Swdenk- Compression support: 1658c29fdfc1Swdenk CONFIG_BZIP2 1659c29fdfc1Swdenk 1660c29fdfc1Swdenk If this option is set, support for bzip2 compressed 1661c29fdfc1Swdenk images is included. If not, only uncompressed and gzip 1662c29fdfc1Swdenk compressed images are supported. 1663c29fdfc1Swdenk 1664c29fdfc1Swdenk NOTE: the bzip2 algorithm requires a lot of RAM, so 16656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should 1666c29fdfc1Swdenk be at least 4MB. 1667d791b1dcSwdenk 1668fc9c1727SLuigi 'Comio' Mantellini CONFIG_LZMA 1669fc9c1727SLuigi 'Comio' Mantellini 1670fc9c1727SLuigi 'Comio' Mantellini If this option is set, support for lzma compressed 1671fc9c1727SLuigi 'Comio' Mantellini images is included. 1672fc9c1727SLuigi 'Comio' Mantellini 1673fc9c1727SLuigi 'Comio' Mantellini Note: The LZMA algorithm adds between 2 and 4KB of code and it 1674fc9c1727SLuigi 'Comio' Mantellini requires an amount of dynamic memory that is given by the 1675fc9c1727SLuigi 'Comio' Mantellini formula: 1676fc9c1727SLuigi 'Comio' Mantellini 1677fc9c1727SLuigi 'Comio' Mantellini (1846 + 768 << (lc + lp)) * sizeof(uint16) 1678fc9c1727SLuigi 'Comio' Mantellini 1679fc9c1727SLuigi 'Comio' Mantellini Where lc and lp stand for, respectively, Literal context bits 1680fc9c1727SLuigi 'Comio' Mantellini and Literal pos bits. 1681fc9c1727SLuigi 'Comio' Mantellini 1682fc9c1727SLuigi 'Comio' Mantellini This value is upper-bounded by 14MB in the worst case. Anyway, 1683fc9c1727SLuigi 'Comio' Mantellini for a ~4MB large kernel image, we have lc=3 and lp=0 for a 1684fc9c1727SLuigi 'Comio' Mantellini total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is 1685fc9c1727SLuigi 'Comio' Mantellini a very small buffer. 1686fc9c1727SLuigi 'Comio' Mantellini 1687fc9c1727SLuigi 'Comio' Mantellini Use the lzmainfo tool to determinate the lc and lp values and 1688fc9c1727SLuigi 'Comio' Mantellini then calculate the amount of needed dynamic memory (ensuring 16896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD the appropriate CONFIG_SYS_MALLOC_LEN value). 1690fc9c1727SLuigi 'Comio' Mantellini 169117ea1177Swdenk- MII/PHY support: 169217ea1177Swdenk CONFIG_PHY_ADDR 169317ea1177Swdenk 169417ea1177Swdenk The address of PHY on MII bus. 169517ea1177Swdenk 169617ea1177Swdenk CONFIG_PHY_CLOCK_FREQ (ppc4xx) 169717ea1177Swdenk 169817ea1177Swdenk The clock frequency of the MII bus 169917ea1177Swdenk 170017ea1177Swdenk CONFIG_PHY_GIGE 170117ea1177Swdenk 170217ea1177Swdenk If this option is set, support for speed/duplex 170311ccc33fSMarcel Ziswiler detection of gigabit PHY is included. 170417ea1177Swdenk 170517ea1177Swdenk CONFIG_PHY_RESET_DELAY 170617ea1177Swdenk 170717ea1177Swdenk Some PHY like Intel LXT971A need extra delay after 170817ea1177Swdenk reset before any MII register access is possible. 170917ea1177Swdenk For such PHY, set this option to the usec delay 171017ea1177Swdenk required. (minimum 300usec for LXT971A) 171117ea1177Swdenk 171217ea1177Swdenk CONFIG_PHY_CMD_DELAY (ppc4xx) 171317ea1177Swdenk 171417ea1177Swdenk Some PHY like Intel LXT971A need extra delay after 171517ea1177Swdenk command issued before MII status register can be read 171617ea1177Swdenk 1717c609719bSwdenk- Ethernet address: 1718c609719bSwdenk CONFIG_ETHADDR 1719c68a05feSrichardretanubun CONFIG_ETH1ADDR 1720c609719bSwdenk CONFIG_ETH2ADDR 1721c609719bSwdenk CONFIG_ETH3ADDR 1722c68a05feSrichardretanubun CONFIG_ETH4ADDR 1723c68a05feSrichardretanubun CONFIG_ETH5ADDR 1724c609719bSwdenk 172511ccc33fSMarcel Ziswiler Define a default value for Ethernet address to use 172611ccc33fSMarcel Ziswiler for the respective Ethernet interface, in case this 1727c609719bSwdenk is not determined automatically. 1728c609719bSwdenk 1729c609719bSwdenk- IP address: 1730c609719bSwdenk CONFIG_IPADDR 1731c609719bSwdenk 1732c609719bSwdenk Define a default value for the IP address to use for 173311ccc33fSMarcel Ziswiler the default Ethernet interface, in case this is not 1734c609719bSwdenk determined through e.g. bootp. 17351ebcd654SWolfgang Denk (Environment variable "ipaddr") 1736c609719bSwdenk 1737c609719bSwdenk- Server IP address: 1738c609719bSwdenk CONFIG_SERVERIP 1739c609719bSwdenk 1740c609719bSwdenk Defines a default value for the IP address of a TFTP 1741c609719bSwdenk server to contact when using the "tftboot" command. 17421ebcd654SWolfgang Denk (Environment variable "serverip") 1743c609719bSwdenk 174497cfe861SRobin Getz CONFIG_KEEP_SERVERADDR 174597cfe861SRobin Getz 174697cfe861SRobin Getz Keeps the server's MAC address, in the env 'serveraddr' 174797cfe861SRobin Getz for passing to bootargs (like Linux's netconsole option) 174897cfe861SRobin Getz 17491ebcd654SWolfgang Denk- Gateway IP address: 17501ebcd654SWolfgang Denk CONFIG_GATEWAYIP 17511ebcd654SWolfgang Denk 17521ebcd654SWolfgang Denk Defines a default value for the IP address of the 17531ebcd654SWolfgang Denk default router where packets to other networks are 17541ebcd654SWolfgang Denk sent to. 17551ebcd654SWolfgang Denk (Environment variable "gatewayip") 17561ebcd654SWolfgang Denk 17571ebcd654SWolfgang Denk- Subnet mask: 17581ebcd654SWolfgang Denk CONFIG_NETMASK 17591ebcd654SWolfgang Denk 17601ebcd654SWolfgang Denk Defines a default value for the subnet mask (or 17611ebcd654SWolfgang Denk routing prefix) which is used to determine if an IP 17621ebcd654SWolfgang Denk address belongs to the local subnet or needs to be 17631ebcd654SWolfgang Denk forwarded through a router. 17641ebcd654SWolfgang Denk (Environment variable "netmask") 17651ebcd654SWolfgang Denk 176653a5c424SDavid Updegraff- Multicast TFTP Mode: 176753a5c424SDavid Updegraff CONFIG_MCAST_TFTP 176853a5c424SDavid Updegraff 176953a5c424SDavid Updegraff Defines whether you want to support multicast TFTP as per 177053a5c424SDavid Updegraff rfc-2090; for example to work with atftp. Lets lots of targets 177111ccc33fSMarcel Ziswiler tftp down the same boot image concurrently. Note: the Ethernet 177253a5c424SDavid Updegraff driver in use must provide a function: mcast() to join/leave a 177353a5c424SDavid Updegraff multicast group. 177453a5c424SDavid Updegraff 1775c609719bSwdenk- BOOTP Recovery Mode: 1776c609719bSwdenk CONFIG_BOOTP_RANDOM_DELAY 1777c609719bSwdenk 1778c609719bSwdenk If you have many targets in a network that try to 1779c609719bSwdenk boot using BOOTP, you may want to avoid that all 1780c609719bSwdenk systems send out BOOTP requests at precisely the same 1781c609719bSwdenk moment (which would happen for instance at recovery 1782c609719bSwdenk from a power failure, when all systems will try to 1783c609719bSwdenk boot, thus flooding the BOOTP server. Defining 1784c609719bSwdenk CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be 1785c609719bSwdenk inserted before sending out BOOTP requests. The 17866c33c785SWolfgang Denk following delays are inserted then: 1787c609719bSwdenk 1788c609719bSwdenk 1st BOOTP request: delay 0 ... 1 sec 1789c609719bSwdenk 2nd BOOTP request: delay 0 ... 2 sec 1790c609719bSwdenk 3rd BOOTP request: delay 0 ... 4 sec 1791c609719bSwdenk 4th and following 1792c609719bSwdenk BOOTP requests: delay 0 ... 8 sec 1793c609719bSwdenk 1794fe389a82Sstroese- DHCP Advanced Options: 17951fe80d79SJon Loeliger You can fine tune the DHCP functionality by defining 17961fe80d79SJon Loeliger CONFIG_BOOTP_* symbols: 1797fe389a82Sstroese 17981fe80d79SJon Loeliger CONFIG_BOOTP_SUBNETMASK 17991fe80d79SJon Loeliger CONFIG_BOOTP_GATEWAY 18001fe80d79SJon Loeliger CONFIG_BOOTP_HOSTNAME 18011fe80d79SJon Loeliger CONFIG_BOOTP_NISDOMAIN 18021fe80d79SJon Loeliger CONFIG_BOOTP_BOOTPATH 18031fe80d79SJon Loeliger CONFIG_BOOTP_BOOTFILESIZE 18041fe80d79SJon Loeliger CONFIG_BOOTP_DNS 18051fe80d79SJon Loeliger CONFIG_BOOTP_DNS2 18061fe80d79SJon Loeliger CONFIG_BOOTP_SEND_HOSTNAME 18071fe80d79SJon Loeliger CONFIG_BOOTP_NTPSERVER 18081fe80d79SJon Loeliger CONFIG_BOOTP_TIMEOFFSET 18091fe80d79SJon Loeliger CONFIG_BOOTP_VENDOREX 18102c00e099SJoe Hershberger CONFIG_BOOTP_MAY_FAIL 1811fe389a82Sstroese 18125d110f0aSWilson Callan CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip 18135d110f0aSWilson Callan environment variable, not the BOOTP server. 1814fe389a82Sstroese 18152c00e099SJoe Hershberger CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found 18162c00e099SJoe Hershberger after the configured retry count, the call will fail 18172c00e099SJoe Hershberger instead of starting over. This can be used to fail over 18182c00e099SJoe Hershberger to Link-local IP address configuration if the DHCP server 18192c00e099SJoe Hershberger is not available. 18202c00e099SJoe Hershberger 1821fe389a82Sstroese CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS 1822fe389a82Sstroese serverip from a DHCP server, it is possible that more 1823fe389a82Sstroese than one DNS serverip is offered to the client. 1824fe389a82Sstroese If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS 1825fe389a82Sstroese serverip will be stored in the additional environment 1826fe389a82Sstroese variable "dnsip2". The first DNS serverip is always 1827fe389a82Sstroese stored in the variable "dnsip", when CONFIG_BOOTP_DNS 18281fe80d79SJon Loeliger is defined. 1829fe389a82Sstroese 1830fe389a82Sstroese CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable 1831fe389a82Sstroese to do a dynamic update of a DNS server. To do this, they 1832fe389a82Sstroese need the hostname of the DHCP requester. 18335d110f0aSWilson Callan If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content 18341fe80d79SJon Loeliger of the "hostname" environment variable is passed as 18351fe80d79SJon Loeliger option 12 to the DHCP server. 1836fe389a82Sstroese 1837d9a2f416SAras Vaichas CONFIG_BOOTP_DHCP_REQUEST_DELAY 1838d9a2f416SAras Vaichas 1839d9a2f416SAras Vaichas A 32bit value in microseconds for a delay between 1840d9a2f416SAras Vaichas receiving a "DHCP Offer" and sending the "DHCP Request". 1841d9a2f416SAras Vaichas This fixes a problem with certain DHCP servers that don't 1842d9a2f416SAras Vaichas respond 100% of the time to a "DHCP request". E.g. On an 1843d9a2f416SAras Vaichas AT91RM9200 processor running at 180MHz, this delay needed 1844d9a2f416SAras Vaichas to be *at least* 15,000 usec before a Windows Server 2003 1845d9a2f416SAras Vaichas DHCP server would reply 100% of the time. I recommend at 1846d9a2f416SAras Vaichas least 50,000 usec to be safe. The alternative is to hope 1847d9a2f416SAras Vaichas that one of the retries will be successful but note that 1848d9a2f416SAras Vaichas the DHCP timeout and retry process takes a longer than 1849d9a2f416SAras Vaichas this delay. 1850d9a2f416SAras Vaichas 1851d22c338eSJoe Hershberger - Link-local IP address negotiation: 1852d22c338eSJoe Hershberger Negotiate with other link-local clients on the local network 1853d22c338eSJoe Hershberger for an address that doesn't require explicit configuration. 1854d22c338eSJoe Hershberger This is especially useful if a DHCP server cannot be guaranteed 1855d22c338eSJoe Hershberger to exist in all environments that the device must operate. 1856d22c338eSJoe Hershberger 1857d22c338eSJoe Hershberger See doc/README.link-local for more information. 1858d22c338eSJoe Hershberger 1859a3d991bdSwdenk - CDP Options: 1860a3d991bdSwdenk CONFIG_CDP_DEVICE_ID 1861a3d991bdSwdenk 1862a3d991bdSwdenk The device id used in CDP trigger frames. 1863a3d991bdSwdenk 1864a3d991bdSwdenk CONFIG_CDP_DEVICE_ID_PREFIX 1865a3d991bdSwdenk 1866a3d991bdSwdenk A two character string which is prefixed to the MAC address 1867a3d991bdSwdenk of the device. 1868a3d991bdSwdenk 1869a3d991bdSwdenk CONFIG_CDP_PORT_ID 1870a3d991bdSwdenk 1871a3d991bdSwdenk A printf format string which contains the ascii name of 1872a3d991bdSwdenk the port. Normally is set to "eth%d" which sets 187311ccc33fSMarcel Ziswiler eth0 for the first Ethernet, eth1 for the second etc. 1874a3d991bdSwdenk 1875a3d991bdSwdenk CONFIG_CDP_CAPABILITIES 1876a3d991bdSwdenk 1877a3d991bdSwdenk A 32bit integer which indicates the device capabilities; 1878a3d991bdSwdenk 0x00000010 for a normal host which does not forwards. 1879a3d991bdSwdenk 1880a3d991bdSwdenk CONFIG_CDP_VERSION 1881a3d991bdSwdenk 1882a3d991bdSwdenk An ascii string containing the version of the software. 1883a3d991bdSwdenk 1884a3d991bdSwdenk CONFIG_CDP_PLATFORM 1885a3d991bdSwdenk 1886a3d991bdSwdenk An ascii string containing the name of the platform. 1887a3d991bdSwdenk 1888a3d991bdSwdenk CONFIG_CDP_TRIGGER 1889a3d991bdSwdenk 1890a3d991bdSwdenk A 32bit integer sent on the trigger. 1891a3d991bdSwdenk 1892a3d991bdSwdenk CONFIG_CDP_POWER_CONSUMPTION 1893a3d991bdSwdenk 1894a3d991bdSwdenk A 16bit integer containing the power consumption of the 1895a3d991bdSwdenk device in .1 of milliwatts. 1896a3d991bdSwdenk 1897a3d991bdSwdenk CONFIG_CDP_APPLIANCE_VLAN_TYPE 1898a3d991bdSwdenk 1899a3d991bdSwdenk A byte containing the id of the VLAN. 1900a3d991bdSwdenk 1901c609719bSwdenk- Status LED: CONFIG_STATUS_LED 1902c609719bSwdenk 1903c609719bSwdenk Several configurations allow to display the current 1904c609719bSwdenk status using a LED. For instance, the LED will blink 1905c609719bSwdenk fast while running U-Boot code, stop blinking as 1906c609719bSwdenk soon as a reply to a BOOTP request was received, and 1907c609719bSwdenk start blinking slow once the Linux kernel is running 1908c609719bSwdenk (supported by a status LED driver in the Linux 1909c609719bSwdenk kernel). Defining CONFIG_STATUS_LED enables this 1910c609719bSwdenk feature in U-Boot. 1911c609719bSwdenk 1912c609719bSwdenk- CAN Support: CONFIG_CAN_DRIVER 1913c609719bSwdenk 1914c609719bSwdenk Defining CONFIG_CAN_DRIVER enables CAN driver support 1915c609719bSwdenk on those systems that support this (optional) 1916c609719bSwdenk feature, like the TQM8xxL modules. 1917c609719bSwdenk 1918c609719bSwdenk- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C 1919c609719bSwdenk 1920b37c7e5eSwdenk These enable I2C serial bus commands. Defining either of 1921b37c7e5eSwdenk (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will 192211ccc33fSMarcel Ziswiler include the appropriate I2C driver for the selected CPU. 1923c609719bSwdenk 1924b37c7e5eSwdenk This will allow you to use i2c commands at the u-boot 1925602ad3b3SJon Loeliger command line (as long as you set CONFIG_CMD_I2C in 1926b37c7e5eSwdenk CONFIG_COMMANDS) and communicate with i2c based realtime 1927b37c7e5eSwdenk clock chips. See common/cmd_i2c.c for a description of the 1928c609719bSwdenk command line interface. 1929c609719bSwdenk 1930bb99ad6dSBen Warren CONFIG_HARD_I2C selects a hardware I2C controller. 1931c609719bSwdenk 1932b37c7e5eSwdenk CONFIG_SOFT_I2C configures u-boot to use a software (aka 1933b37c7e5eSwdenk bit-banging) driver instead of CPM or similar hardware 1934b37c7e5eSwdenk support for I2C. 1935c609719bSwdenk 1936b37c7e5eSwdenk There are several other quantities that must also be 1937b37c7e5eSwdenk defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C. 1938c609719bSwdenk 19396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD In both cases you will need to define CONFIG_SYS_I2C_SPEED 1940b37c7e5eSwdenk to be the frequency (in Hz) at which you wish your i2c bus 19416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie 194211ccc33fSMarcel Ziswiler the CPU's i2c node address). 1943c609719bSwdenk 19448d321b81SPeter Tyser Now, the u-boot i2c code for the mpc8xx 1945a47a12beSStefan Roese (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node 19468d321b81SPeter Tyser and so its address should therefore be cleared to 0 (See, 19478d321b81SPeter Tyser eg, MPC823e User's Manual p.16-473). So, set 19488d321b81SPeter Tyser CONFIG_SYS_I2C_SLAVE to 0. 1949b37c7e5eSwdenk 19505da71efaSEric Millbrandt CONFIG_SYS_I2C_INIT_MPC5XXX 19515da71efaSEric Millbrandt 19525da71efaSEric Millbrandt When a board is reset during an i2c bus transfer 19535da71efaSEric Millbrandt chips might think that the current transfer is still 19545da71efaSEric Millbrandt in progress. Reset the slave devices by sending start 19555da71efaSEric Millbrandt commands until the slave device responds. 19565da71efaSEric Millbrandt 1957b37c7e5eSwdenk That's all that's required for CONFIG_HARD_I2C. 1958b37c7e5eSwdenk 1959b37c7e5eSwdenk If you use the software i2c interface (CONFIG_SOFT_I2C) 1960b37c7e5eSwdenk then the following macros need to be defined (examples are 1961b37c7e5eSwdenk from include/configs/lwmon.h): 1962c609719bSwdenk 1963c609719bSwdenk I2C_INIT 1964c609719bSwdenk 1965b37c7e5eSwdenk (Optional). Any commands necessary to enable the I2C 1966c609719bSwdenk controller or configure ports. 1967c609719bSwdenk 1968b37c7e5eSwdenk eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL) 1969b37c7e5eSwdenk 1970c609719bSwdenk I2C_PORT 1971c609719bSwdenk 1972c609719bSwdenk (Only for MPC8260 CPU). The I/O port to use (the code 1973c609719bSwdenk assumes both bits are on the same port). Valid values 1974c609719bSwdenk are 0..3 for ports A..D. 1975c609719bSwdenk 1976c609719bSwdenk I2C_ACTIVE 1977c609719bSwdenk 1978c609719bSwdenk The code necessary to make the I2C data line active 1979c609719bSwdenk (driven). If the data line is open collector, this 1980c609719bSwdenk define can be null. 1981c609719bSwdenk 1982b37c7e5eSwdenk eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA) 1983b37c7e5eSwdenk 1984c609719bSwdenk I2C_TRISTATE 1985c609719bSwdenk 1986c609719bSwdenk The code necessary to make the I2C data line tri-stated 1987c609719bSwdenk (inactive). If the data line is open collector, this 1988c609719bSwdenk define can be null. 1989c609719bSwdenk 1990b37c7e5eSwdenk eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA) 1991b37c7e5eSwdenk 1992c609719bSwdenk I2C_READ 1993c609719bSwdenk 1994472d5460SYork Sun Code that returns true if the I2C data line is high, 1995472d5460SYork Sun false if it is low. 1996c609719bSwdenk 1997b37c7e5eSwdenk eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0) 1998b37c7e5eSwdenk 1999c609719bSwdenk I2C_SDA(bit) 2000c609719bSwdenk 2001472d5460SYork Sun If <bit> is true, sets the I2C data line high. If it 2002472d5460SYork Sun is false, it clears it (low). 2003c609719bSwdenk 2004b37c7e5eSwdenk eg: #define I2C_SDA(bit) \ 2005b37c7e5eSwdenk if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \ 2006b37c7e5eSwdenk else immr->im_cpm.cp_pbdat &= ~PB_SDA 2007b37c7e5eSwdenk 2008c609719bSwdenk I2C_SCL(bit) 2009c609719bSwdenk 2010472d5460SYork Sun If <bit> is true, sets the I2C clock line high. If it 2011472d5460SYork Sun is false, it clears it (low). 2012c609719bSwdenk 2013b37c7e5eSwdenk eg: #define I2C_SCL(bit) \ 2014b37c7e5eSwdenk if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \ 2015b37c7e5eSwdenk else immr->im_cpm.cp_pbdat &= ~PB_SCL 2016b37c7e5eSwdenk 2017c609719bSwdenk I2C_DELAY 2018c609719bSwdenk 2019c609719bSwdenk This delay is invoked four times per clock cycle so this 2020c609719bSwdenk controls the rate of data transfer. The data rate thus 2021b37c7e5eSwdenk is 1 / (I2C_DELAY * 4). Often defined to be something 2022b37c7e5eSwdenk like: 2023b37c7e5eSwdenk 2024b37c7e5eSwdenk #define I2C_DELAY udelay(2) 2025c609719bSwdenk 2026793b5726SMike Frysinger CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA 2027793b5726SMike Frysinger 2028793b5726SMike Frysinger If your arch supports the generic GPIO framework (asm/gpio.h), 2029793b5726SMike Frysinger then you may alternatively define the two GPIOs that are to be 2030793b5726SMike Frysinger used as SCL / SDA. Any of the previous I2C_xxx macros will 2031793b5726SMike Frysinger have GPIO-based defaults assigned to them as appropriate. 2032793b5726SMike Frysinger 2033793b5726SMike Frysinger You should define these to the GPIO value as given directly to 2034793b5726SMike Frysinger the generic GPIO functions. 2035793b5726SMike Frysinger 20366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_INIT_BOARD 203747cd00faSwdenk 203847cd00faSwdenk When a board is reset during an i2c bus transfer 203947cd00faSwdenk chips might think that the current transfer is still 204047cd00faSwdenk in progress. On some boards it is possible to access 204147cd00faSwdenk the i2c SCLK line directly, either by using the 204247cd00faSwdenk processor pin as a GPIO or by having a second pin 204347cd00faSwdenk connected to the bus. If this option is defined a 204447cd00faSwdenk custom i2c_init_board() routine in boards/xxx/board.c 204547cd00faSwdenk is run early in the boot sequence. 204647cd00faSwdenk 204726a33504SRichard Retanubun CONFIG_SYS_I2C_BOARD_LATE_INIT 204826a33504SRichard Retanubun 204926a33504SRichard Retanubun An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is 205026a33504SRichard Retanubun defined a custom i2c_board_late_init() routine in 205126a33504SRichard Retanubun boards/xxx/board.c is run AFTER the operations in i2c_init() 205226a33504SRichard Retanubun is completed. This callpoint can be used to unreset i2c bus 205326a33504SRichard Retanubun using CPU i2c controller register accesses for CPUs whose i2c 205426a33504SRichard Retanubun controller provide such a method. It is called at the end of 205526a33504SRichard Retanubun i2c_init() to allow i2c_init operations to setup the i2c bus 205626a33504SRichard Retanubun controller on the CPU (e.g. setting bus speed & slave address). 205726a33504SRichard Retanubun 205817ea1177Swdenk CONFIG_I2CFAST (PPC405GP|PPC405EP only) 205917ea1177Swdenk 206017ea1177Swdenk This option enables configuration of bi_iic_fast[] flags 206117ea1177Swdenk in u-boot bd_info structure based on u-boot environment 206217ea1177Swdenk variable "i2cfast". (see also i2cfast) 206317ea1177Swdenk 2064bb99ad6dSBen Warren CONFIG_I2C_MULTI_BUS 2065bb99ad6dSBen Warren 2066bb99ad6dSBen Warren This option allows the use of multiple I2C buses, each of which 2067bb99ad6dSBen Warren must have a controller. At any point in time, only one bus is 2068bb99ad6dSBen Warren active. To switch to a different bus, use the 'i2c dev' command. 2069bb99ad6dSBen Warren Note that bus numbering is zero-based. 2070bb99ad6dSBen Warren 20716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_NOPROBES 2072bb99ad6dSBen Warren 2073bb99ad6dSBen Warren This option specifies a list of I2C devices that will be skipped 20740f89c54bSPeter Tyser when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS 20750f89c54bSPeter Tyser is set, specify a list of bus-device pairs. Otherwise, specify 20760f89c54bSPeter Tyser a 1D array of device addresses 2077bb99ad6dSBen Warren 2078bb99ad6dSBen Warren e.g. 2079bb99ad6dSBen Warren #undef CONFIG_I2C_MULTI_BUS 20806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68} 2081bb99ad6dSBen Warren 2082bb99ad6dSBen Warren will skip addresses 0x50 and 0x68 on a board with one I2C bus 2083bb99ad6dSBen Warren 2084bb99ad6dSBen Warren #define CONFIG_I2C_MULTI_BUS 20856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}} 2086bb99ad6dSBen Warren 2087bb99ad6dSBen Warren will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1 2088bb99ad6dSBen Warren 20896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SPD_BUS_NUM 2090be5e6181STimur Tabi 2091be5e6181STimur Tabi If defined, then this indicates the I2C bus number for DDR SPD. 2092be5e6181STimur Tabi If not defined, then U-Boot assumes that SPD is on I2C bus 0. 2093be5e6181STimur Tabi 20946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_RTC_BUS_NUM 20950dc018ecSStefan Roese 20960dc018ecSStefan Roese If defined, then this indicates the I2C bus number for the RTC. 20970dc018ecSStefan Roese If not defined, then U-Boot assumes that RTC is on I2C bus 0. 20980dc018ecSStefan Roese 20996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_DTT_BUS_NUM 21000dc018ecSStefan Roese 21010dc018ecSStefan Roese If defined, then this indicates the I2C bus number for the DTT. 21020dc018ecSStefan Roese If not defined, then U-Boot assumes that DTT is on I2C bus 0. 21030dc018ecSStefan Roese 21046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_DTT_ADDR: 21059ebbb54fSVictor Gallardo 21069ebbb54fSVictor Gallardo If defined, specifies the I2C address of the DTT device. 21079ebbb54fSVictor Gallardo If not defined, then U-Boot uses predefined value for 21089ebbb54fSVictor Gallardo specified DTT device. 21099ebbb54fSVictor Gallardo 2110be5e6181STimur Tabi CONFIG_FSL_I2C 2111be5e6181STimur Tabi 2112be5e6181STimur Tabi Define this option if you want to use Freescale's I2C driver in 21137817cb20SMarcel Ziswiler drivers/i2c/fsl_i2c.c. 2114be5e6181STimur Tabi 211567b23a32SHeiko Schocher CONFIG_I2C_MUX 211667b23a32SHeiko Schocher 211767b23a32SHeiko Schocher Define this option if you have I2C devices reached over 1 .. n 211867b23a32SHeiko Schocher I2C Muxes like the pca9544a. This option addes a new I2C 211967b23a32SHeiko Schocher Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a 212067b23a32SHeiko Schocher new I2C Bus to the existing I2C Busses. If you select the 212167b23a32SHeiko Schocher new Bus with "i2c dev", u-bbot sends first the commandos for 212267b23a32SHeiko Schocher the muxes to activate this new "bus". 212367b23a32SHeiko Schocher 212467b23a32SHeiko Schocher CONFIG_I2C_MULTI_BUS must be also defined, to use this 212567b23a32SHeiko Schocher feature! 212667b23a32SHeiko Schocher 212767b23a32SHeiko Schocher Example: 212867b23a32SHeiko Schocher Adding a new I2C Bus reached over 2 pca9544a muxes 212967b23a32SHeiko Schocher The First mux with address 70 and channel 6 213067b23a32SHeiko Schocher The Second mux with address 71 and channel 4 213167b23a32SHeiko Schocher 213267b23a32SHeiko Schocher => i2c bus pca9544a:70:6:pca9544a:71:4 213367b23a32SHeiko Schocher 213467b23a32SHeiko Schocher Use the "i2c bus" command without parameter, to get a list 213567b23a32SHeiko Schocher of I2C Busses with muxes: 213667b23a32SHeiko Schocher 213767b23a32SHeiko Schocher => i2c bus 213867b23a32SHeiko Schocher Busses reached over muxes: 213967b23a32SHeiko Schocher Bus ID: 2 214067b23a32SHeiko Schocher reached over Mux(es): 214167b23a32SHeiko Schocher pca9544a@70 ch: 4 214267b23a32SHeiko Schocher Bus ID: 3 214367b23a32SHeiko Schocher reached over Mux(es): 214467b23a32SHeiko Schocher pca9544a@70 ch: 6 214567b23a32SHeiko Schocher pca9544a@71 ch: 4 214667b23a32SHeiko Schocher => 214767b23a32SHeiko Schocher 214867b23a32SHeiko Schocher If you now switch to the new I2C Bus 3 with "i2c dev 3" 2149f9a78b8dSMichael Jones u-boot first sends the command to the mux@70 to enable 2150f9a78b8dSMichael Jones channel 6, and then the command to the mux@71 to enable 215167b23a32SHeiko Schocher the channel 4. 215267b23a32SHeiko Schocher 215367b23a32SHeiko Schocher After that, you can use the "normal" i2c commands as 2154f9a78b8dSMichael Jones usual to communicate with your I2C devices behind 215567b23a32SHeiko Schocher the 2 muxes. 215667b23a32SHeiko Schocher 215767b23a32SHeiko Schocher This option is actually implemented for the bitbanging 215867b23a32SHeiko Schocher algorithm in common/soft_i2c.c and for the Hardware I2C 215967b23a32SHeiko Schocher Bus on the MPC8260. But it should be not so difficult 216067b23a32SHeiko Schocher to add this option to other architectures. 216167b23a32SHeiko Schocher 21622ac6985aSAndrew Dyer CONFIG_SOFT_I2C_READ_REPEATED_START 21632ac6985aSAndrew Dyer 21642ac6985aSAndrew Dyer defining this will force the i2c_read() function in 21652ac6985aSAndrew Dyer the soft_i2c driver to perform an I2C repeated start 21662ac6985aSAndrew Dyer between writing the address pointer and reading the 21672ac6985aSAndrew Dyer data. If this define is omitted the default behaviour 21682ac6985aSAndrew Dyer of doing a stop-start sequence will be used. Most I2C 21692ac6985aSAndrew Dyer devices can use either method, but some require one or 21702ac6985aSAndrew Dyer the other. 2171be5e6181STimur Tabi 2172c609719bSwdenk- SPI Support: CONFIG_SPI 2173c609719bSwdenk 2174c609719bSwdenk Enables SPI driver (so far only tested with 2175c609719bSwdenk SPI EEPROM, also an instance works with Crystal A/D and 2176c609719bSwdenk D/As on the SACSng board) 2177c609719bSwdenk 21786639562eSYoshihiro Shimoda CONFIG_SH_SPI 21796639562eSYoshihiro Shimoda 21806639562eSYoshihiro Shimoda Enables the driver for SPI controller on SuperH. Currently 21816639562eSYoshihiro Shimoda only SH7757 is supported. 21826639562eSYoshihiro Shimoda 2183c609719bSwdenk CONFIG_SPI_X 2184c609719bSwdenk 2185c609719bSwdenk Enables extended (16-bit) SPI EEPROM addressing. 2186c609719bSwdenk (symmetrical to CONFIG_I2C_X) 2187c609719bSwdenk 2188c609719bSwdenk CONFIG_SOFT_SPI 2189c609719bSwdenk 2190c609719bSwdenk Enables a software (bit-bang) SPI driver rather than 2191c609719bSwdenk using hardware support. This is a general purpose 2192c609719bSwdenk driver that only requires three general I/O port pins 2193c609719bSwdenk (two outputs, one input) to function. If this is 2194c609719bSwdenk defined, the board configuration must define several 2195c609719bSwdenk SPI configuration items (port pins to use, etc). For 2196c609719bSwdenk an example, see include/configs/sacsng.h. 2197c609719bSwdenk 219804a9e118SBen Warren CONFIG_HARD_SPI 219904a9e118SBen Warren 220004a9e118SBen Warren Enables a hardware SPI driver for general-purpose reads 220104a9e118SBen Warren and writes. As with CONFIG_SOFT_SPI, the board configuration 220204a9e118SBen Warren must define a list of chip-select function pointers. 220304a9e118SBen Warren Currently supported on some MPC8xxx processors. For an 220404a9e118SBen Warren example, see include/configs/mpc8349emds.h. 220504a9e118SBen Warren 220638254f45SGuennadi Liakhovetski CONFIG_MXC_SPI 220738254f45SGuennadi Liakhovetski 220838254f45SGuennadi Liakhovetski Enables the driver for the SPI controllers on i.MX and MXC 22092e3cd1cdSFabio Estevam SoCs. Currently i.MX31/35/51 are supported. 221038254f45SGuennadi Liakhovetski 22110133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA 22120133502eSMatthias Fuchs 22130133502eSMatthias Fuchs Enables FPGA subsystem. 22140133502eSMatthias Fuchs 22150133502eSMatthias Fuchs CONFIG_FPGA_<vendor> 22160133502eSMatthias Fuchs 22170133502eSMatthias Fuchs Enables support for specific chip vendors. 22180133502eSMatthias Fuchs (ALTERA, XILINX) 22190133502eSMatthias Fuchs 22200133502eSMatthias Fuchs CONFIG_FPGA_<family> 22210133502eSMatthias Fuchs 22220133502eSMatthias Fuchs Enables support for FPGA family. 22230133502eSMatthias Fuchs (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX) 22240133502eSMatthias Fuchs 22250133502eSMatthias Fuchs CONFIG_FPGA_COUNT 2226c609719bSwdenk 2227c609719bSwdenk Specify the number of FPGA devices to support. 2228c609719bSwdenk 22296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_PROG_FEEDBACK 2230c609719bSwdenk 2231c609719bSwdenk Enable printing of hash marks during FPGA configuration. 2232c609719bSwdenk 22336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_BUSY 2234c609719bSwdenk 2235c609719bSwdenk Enable checks on FPGA configuration interface busy 2236c609719bSwdenk status by the configuration function. This option 2237c609719bSwdenk will require a board or device specific function to 2238c609719bSwdenk be written. 2239c609719bSwdenk 2240c609719bSwdenk CONFIG_FPGA_DELAY 2241c609719bSwdenk 2242c609719bSwdenk If defined, a function that provides delays in the FPGA 2243c609719bSwdenk configuration driver. 2244c609719bSwdenk 22456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_CTRLC 2246c609719bSwdenk Allow Control-C to interrupt FPGA configuration 2247c609719bSwdenk 22486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_ERROR 2249c609719bSwdenk 2250c609719bSwdenk Check for configuration errors during FPGA bitfile 2251c609719bSwdenk loading. For example, abort during Virtex II 2252c609719bSwdenk configuration if the INIT_B line goes low (which 2253c609719bSwdenk indicated a CRC error). 2254c609719bSwdenk 22556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_INIT 2256c609719bSwdenk 2257c609719bSwdenk Maximum time to wait for the INIT_B line to deassert 2258c609719bSwdenk after PROB_B has been deasserted during a Virtex II 2259c609719bSwdenk FPGA configuration sequence. The default time is 500 226011ccc33fSMarcel Ziswiler ms. 2261c609719bSwdenk 22626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_BUSY 2263c609719bSwdenk 2264c609719bSwdenk Maximum time to wait for BUSY to deassert during 226511ccc33fSMarcel Ziswiler Virtex II FPGA configuration. The default is 5 ms. 2266c609719bSwdenk 22676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_CONFIG 2268c609719bSwdenk 2269c609719bSwdenk Time to wait after FPGA configuration. The default is 227011ccc33fSMarcel Ziswiler 200 ms. 2271c609719bSwdenk 2272c609719bSwdenk- Configuration Management: 2273c609719bSwdenk CONFIG_IDENT_STRING 2274c609719bSwdenk 2275c609719bSwdenk If defined, this string will be added to the U-Boot 2276c609719bSwdenk version information (U_BOOT_VERSION) 2277c609719bSwdenk 2278c609719bSwdenk- Vendor Parameter Protection: 2279c609719bSwdenk 2280c609719bSwdenk U-Boot considers the values of the environment 2281c609719bSwdenk variables "serial#" (Board Serial Number) and 22827152b1d0Swdenk "ethaddr" (Ethernet Address) to be parameters that 2283c609719bSwdenk are set once by the board vendor / manufacturer, and 2284c609719bSwdenk protects these variables from casual modification by 2285c609719bSwdenk the user. Once set, these variables are read-only, 2286c609719bSwdenk and write or delete attempts are rejected. You can 228711ccc33fSMarcel Ziswiler change this behaviour: 2288c609719bSwdenk 2289c609719bSwdenk If CONFIG_ENV_OVERWRITE is #defined in your config 2290c609719bSwdenk file, the write protection for vendor parameters is 229147cd00faSwdenk completely disabled. Anybody can change or delete 2292c609719bSwdenk these parameters. 2293c609719bSwdenk 2294c609719bSwdenk Alternatively, if you #define _both_ CONFIG_ETHADDR 2295c609719bSwdenk _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default 229611ccc33fSMarcel Ziswiler Ethernet address is installed in the environment, 2297c609719bSwdenk which can be changed exactly ONCE by the user. [The 2298c609719bSwdenk serial# is unaffected by this, i. e. it remains 2299c609719bSwdenk read-only.] 2300c609719bSwdenk 23012598090bSJoe Hershberger The same can be accomplished in a more flexible way 23022598090bSJoe Hershberger for any variable by configuring the type of access 23032598090bSJoe Hershberger to allow for those variables in the ".flags" variable 23042598090bSJoe Hershberger or define CONFIG_ENV_FLAGS_LIST_STATIC. 23052598090bSJoe Hershberger 2306c609719bSwdenk- Protected RAM: 2307c609719bSwdenk CONFIG_PRAM 2308c609719bSwdenk 2309c609719bSwdenk Define this variable to enable the reservation of 2310c609719bSwdenk "protected RAM", i. e. RAM which is not overwritten 2311c609719bSwdenk by U-Boot. Define CONFIG_PRAM to hold the number of 2312c609719bSwdenk kB you want to reserve for pRAM. You can overwrite 2313c609719bSwdenk this default value by defining an environment 2314c609719bSwdenk variable "pram" to the number of kB you want to 2315c609719bSwdenk reserve. Note that the board info structure will 2316c609719bSwdenk still show the full amount of RAM. If pRAM is 2317c609719bSwdenk reserved, a new environment variable "mem" will 2318c609719bSwdenk automatically be defined to hold the amount of 2319c609719bSwdenk remaining RAM in a form that can be passed as boot 2320c609719bSwdenk argument to Linux, for instance like that: 2321c609719bSwdenk 2322fe126d8bSWolfgang Denk setenv bootargs ... mem=\${mem} 2323c609719bSwdenk saveenv 2324c609719bSwdenk 2325c609719bSwdenk This way you can tell Linux not to use this memory, 2326c609719bSwdenk either, which results in a memory region that will 2327c609719bSwdenk not be affected by reboots. 2328c609719bSwdenk 2329c609719bSwdenk *WARNING* If your board configuration uses automatic 2330c609719bSwdenk detection of the RAM size, you must make sure that 2331c609719bSwdenk this memory test is non-destructive. So far, the 2332c609719bSwdenk following board configurations are known to be 2333c609719bSwdenk "pRAM-clean": 2334c609719bSwdenk 23351b0757ecSWolfgang Denk IVMS8, IVML24, SPD8xx, TQM8xxL, 23361b0757ecSWolfgang Denk HERMES, IP860, RPXlite, LWMON, 2337544d97e9SWolfgang Denk FLAGADM, TQM8260 2338c609719bSwdenk 233940fef049SGabe Black- Access to physical memory region (> 4GB) 234040fef049SGabe Black Some basic support is provided for operations on memory not 234140fef049SGabe Black normally accessible to U-Boot - e.g. some architectures 234240fef049SGabe Black support access to more than 4GB of memory on 32-bit 234340fef049SGabe Black machines using physical address extension or similar. 234440fef049SGabe Black Define CONFIG_PHYSMEM to access this basic support, which 234540fef049SGabe Black currently only supports clearing the memory. 234640fef049SGabe Black 2347c609719bSwdenk- Error Recovery: 2348c609719bSwdenk CONFIG_PANIC_HANG 2349c609719bSwdenk 2350c609719bSwdenk Define this variable to stop the system in case of a 2351c609719bSwdenk fatal error, so that you have to reset it manually. 2352c609719bSwdenk This is probably NOT a good idea for an embedded 235311ccc33fSMarcel Ziswiler system where you want the system to reboot 2354c609719bSwdenk automatically as fast as possible, but it may be 2355c609719bSwdenk useful during development since you can try to debug 2356c609719bSwdenk the conditions that lead to the situation. 2357c609719bSwdenk 2358c609719bSwdenk CONFIG_NET_RETRY_COUNT 2359c609719bSwdenk 2360c609719bSwdenk This variable defines the number of retries for 2361c609719bSwdenk network operations like ARP, RARP, TFTP, or BOOTP 2362c609719bSwdenk before giving up the operation. If not defined, a 2363c609719bSwdenk default value of 5 is used. 2364c609719bSwdenk 236540cb90eeSGuennadi Liakhovetski CONFIG_ARP_TIMEOUT 236640cb90eeSGuennadi Liakhovetski 236740cb90eeSGuennadi Liakhovetski Timeout waiting for an ARP reply in milliseconds. 236840cb90eeSGuennadi Liakhovetski 236948a3e999STetsuyuki Kobayashi CONFIG_NFS_TIMEOUT 237048a3e999STetsuyuki Kobayashi 237148a3e999STetsuyuki Kobayashi Timeout in milliseconds used in NFS protocol. 237248a3e999STetsuyuki Kobayashi If you encounter "ERROR: Cannot umount" in nfs command, 237348a3e999STetsuyuki Kobayashi try longer timeout such as 237448a3e999STetsuyuki Kobayashi #define CONFIG_NFS_TIMEOUT 10000UL 237548a3e999STetsuyuki Kobayashi 2376c609719bSwdenk- Command Interpreter: 23778078f1a5SWolfgang Denk CONFIG_AUTO_COMPLETE 237804a85b3bSwdenk 237904a85b3bSwdenk Enable auto completion of commands using TAB. 238004a85b3bSwdenk 23818078f1a5SWolfgang Denk Note that this feature has NOT been implemented yet 23828078f1a5SWolfgang Denk for the "hush" shell. 23838078f1a5SWolfgang Denk 23848078f1a5SWolfgang Denk 23856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_HUSH_PARSER 2386c609719bSwdenk 2387c609719bSwdenk Define this variable to enable the "hush" shell (from 2388c609719bSwdenk Busybox) as command line interpreter, thus enabling 2389c609719bSwdenk powerful command line syntax like 2390c609719bSwdenk if...then...else...fi conditionals or `&&' and '||' 2391c609719bSwdenk constructs ("shell scripts"). 2392c609719bSwdenk 2393c609719bSwdenk If undefined, you get the old, much simpler behaviour 2394c609719bSwdenk with a somewhat smaller memory footprint. 2395c609719bSwdenk 2396c609719bSwdenk 23976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PROMPT_HUSH_PS2 2398c609719bSwdenk 2399c609719bSwdenk This defines the secondary prompt string, which is 2400c609719bSwdenk printed when the command interpreter needs more input 2401c609719bSwdenk to complete a command. Usually "> ". 2402c609719bSwdenk 2403c609719bSwdenk Note: 2404c609719bSwdenk 2405c609719bSwdenk In the current implementation, the local variables 2406c609719bSwdenk space and global environment variables space are 2407c609719bSwdenk separated. Local variables are those you define by 24083b57fe0aSwdenk simply typing `name=value'. To access a local 2409c609719bSwdenk variable later on, you have write `$name' or 24103b57fe0aSwdenk `${name}'; to execute the contents of a variable 24113b57fe0aSwdenk directly type `$name' at the command prompt. 2412c609719bSwdenk 2413c609719bSwdenk Global environment variables are those you use 2414c609719bSwdenk setenv/printenv to work with. To run a command stored 2415c609719bSwdenk in such a variable, you need to use the run command, 2416c609719bSwdenk and you must not use the '$' sign to access them. 2417c609719bSwdenk 2418c609719bSwdenk To store commands and special characters in a 2419c609719bSwdenk variable, please use double quotation marks 2420c609719bSwdenk surrounding the whole text of the variable, instead 2421c609719bSwdenk of the backslashes before semicolons and special 2422c609719bSwdenk symbols. 2423c609719bSwdenk 2424aa0c71acSWolfgang Denk- Commandline Editing and History: 2425aa0c71acSWolfgang Denk CONFIG_CMDLINE_EDITING 2426aa0c71acSWolfgang Denk 242711ccc33fSMarcel Ziswiler Enable editing and History functions for interactive 2428aa0c71acSWolfgang Denk commandline input operations 2429aa0c71acSWolfgang Denk 2430a8c7c708Swdenk- Default Environment: 2431c609719bSwdenk CONFIG_EXTRA_ENV_SETTINGS 2432c609719bSwdenk 2433c609719bSwdenk Define this to contain any number of null terminated 2434c609719bSwdenk strings (variable = value pairs) that will be part of 24357152b1d0Swdenk the default environment compiled into the boot image. 24362262cfeeSwdenk 2437c609719bSwdenk For example, place something like this in your 2438c609719bSwdenk board's config file: 2439c609719bSwdenk 2440c609719bSwdenk #define CONFIG_EXTRA_ENV_SETTINGS \ 2441c609719bSwdenk "myvar1=value1\0" \ 2442c609719bSwdenk "myvar2=value2\0" 2443c609719bSwdenk 2444c609719bSwdenk Warning: This method is based on knowledge about the 2445c609719bSwdenk internal format how the environment is stored by the 24462262cfeeSwdenk U-Boot code. This is NOT an official, exported 2447c609719bSwdenk interface! Although it is unlikely that this format 24487152b1d0Swdenk will change soon, there is no guarantee either. 2449c609719bSwdenk You better know what you are doing here. 2450c609719bSwdenk 2451c609719bSwdenk Note: overly (ab)use of the default environment is 2452c609719bSwdenk discouraged. Make sure to check other ways to preset 245374de7aefSWolfgang Denk the environment like the "source" command or the 2454c609719bSwdenk boot command first. 2455c609719bSwdenk 24565e724ca2SStephen Warren CONFIG_ENV_VARS_UBOOT_CONFIG 24575e724ca2SStephen Warren 24585e724ca2SStephen Warren Define this in order to add variables describing the 24595e724ca2SStephen Warren U-Boot build configuration to the default environment. 24605e724ca2SStephen Warren These will be named arch, cpu, board, vendor, and soc. 24615e724ca2SStephen Warren 24625e724ca2SStephen Warren Enabling this option will cause the following to be defined: 24635e724ca2SStephen Warren 24645e724ca2SStephen Warren - CONFIG_SYS_ARCH 24655e724ca2SStephen Warren - CONFIG_SYS_CPU 24665e724ca2SStephen Warren - CONFIG_SYS_BOARD 24675e724ca2SStephen Warren - CONFIG_SYS_VENDOR 24685e724ca2SStephen Warren - CONFIG_SYS_SOC 24695e724ca2SStephen Warren 24707e27f89fSTom Rini CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG 24717e27f89fSTom Rini 24727e27f89fSTom Rini Define this in order to add variables describing certain 24737e27f89fSTom Rini run-time determined information about the hardware to the 24747e27f89fSTom Rini environment. These will be named board_name, board_rev. 24757e27f89fSTom Rini 247606fd8538SSimon Glass CONFIG_DELAY_ENVIRONMENT 247706fd8538SSimon Glass 247806fd8538SSimon Glass Normally the environment is loaded when the board is 247906fd8538SSimon Glass intialised so that it is available to U-Boot. This inhibits 248006fd8538SSimon Glass that so that the environment is not available until 248106fd8538SSimon Glass explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL 248206fd8538SSimon Glass this is instead controlled by the value of 248306fd8538SSimon Glass /config/load-environment. 248406fd8538SSimon Glass 2485a8c7c708Swdenk- DataFlash Support: 24862abbe075Swdenk CONFIG_HAS_DATAFLASH 24872abbe075Swdenk 24882abbe075Swdenk Defining this option enables DataFlash features and 24892abbe075Swdenk allows to read/write in Dataflash via the standard 24902abbe075Swdenk commands cp, md... 24912abbe075Swdenk 2492f61ec45eSEric Nelson- Serial Flash support 2493f61ec45eSEric Nelson CONFIG_CMD_SF 2494f61ec45eSEric Nelson 2495f61ec45eSEric Nelson Defining this option enables SPI flash commands 2496f61ec45eSEric Nelson 'sf probe/read/write/erase/update'. 2497f61ec45eSEric Nelson 2498f61ec45eSEric Nelson Usage requires an initial 'probe' to define the serial 2499f61ec45eSEric Nelson flash parameters, followed by read/write/erase/update 2500f61ec45eSEric Nelson commands. 2501f61ec45eSEric Nelson 2502f61ec45eSEric Nelson The following defaults may be provided by the platform 2503f61ec45eSEric Nelson to handle the common case when only a single serial 2504f61ec45eSEric Nelson flash is present on the system. 2505f61ec45eSEric Nelson 2506f61ec45eSEric Nelson CONFIG_SF_DEFAULT_BUS Bus identifier 2507f61ec45eSEric Nelson CONFIG_SF_DEFAULT_CS Chip-select 2508f61ec45eSEric Nelson CONFIG_SF_DEFAULT_MODE (see include/spi.h) 2509f61ec45eSEric Nelson CONFIG_SF_DEFAULT_SPEED in Hz 2510f61ec45eSEric Nelson 251124007273SSimon Glass CONFIG_CMD_SF_TEST 251224007273SSimon Glass 251324007273SSimon Glass Define this option to include a destructive SPI flash 251424007273SSimon Glass test ('sf test'). 251524007273SSimon Glass 25163f85ce27Swdenk- SystemACE Support: 25173f85ce27Swdenk CONFIG_SYSTEMACE 25183f85ce27Swdenk 25193f85ce27Swdenk Adding this option adds support for Xilinx SystemACE 25203f85ce27Swdenk chips attached via some sort of local bus. The address 252111ccc33fSMarcel Ziswiler of the chip must also be defined in the 25226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SYSTEMACE_BASE macro. For example: 25233f85ce27Swdenk 25243f85ce27Swdenk #define CONFIG_SYSTEMACE 25256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000 25263f85ce27Swdenk 25273f85ce27Swdenk When SystemACE support is added, the "ace" device type 25283f85ce27Swdenk becomes available to the fat commands, i.e. fatls. 25293f85ce27Swdenk 2530ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port: 2531ecb0ccd9SWolfgang Denk CONFIG_TFTP_PORT 2532ecb0ccd9SWolfgang Denk 253328cb9375SWolfgang Denk If this is defined, the environment variable tftpsrcp 2534ecb0ccd9SWolfgang Denk is used to supply the TFTP UDP source port value. 253528cb9375SWolfgang Denk If tftpsrcp isn't defined, the normal pseudo-random port 2536ecb0ccd9SWolfgang Denk number generator is used. 2537ecb0ccd9SWolfgang Denk 253828cb9375SWolfgang Denk Also, the environment variable tftpdstp is used to supply 253928cb9375SWolfgang Denk the TFTP UDP destination port value. If tftpdstp isn't 254028cb9375SWolfgang Denk defined, the normal port 69 is used. 254128cb9375SWolfgang Denk 254228cb9375SWolfgang Denk The purpose for tftpsrcp is to allow a TFTP server to 2543ecb0ccd9SWolfgang Denk blindly start the TFTP transfer using the pre-configured 2544ecb0ccd9SWolfgang Denk target IP address and UDP port. This has the effect of 2545ecb0ccd9SWolfgang Denk "punching through" the (Windows XP) firewall, allowing 2546ecb0ccd9SWolfgang Denk the remainder of the TFTP transfer to proceed normally. 2547ecb0ccd9SWolfgang Denk A better solution is to properly configure the firewall, 2548ecb0ccd9SWolfgang Denk but sometimes that is not allowed. 2549ecb0ccd9SWolfgang Denk 2550bf36c5d5SSimon Glass- Hashing support: 2551bf36c5d5SSimon Glass CONFIG_CMD_HASH 2552bf36c5d5SSimon Glass 2553bf36c5d5SSimon Glass This enables a generic 'hash' command which can produce 2554bf36c5d5SSimon Glass hashes / digests from a few algorithms (e.g. SHA1, SHA256). 2555bf36c5d5SSimon Glass 2556bf36c5d5SSimon Glass CONFIG_HASH_VERIFY 2557bf36c5d5SSimon Glass 2558bf36c5d5SSimon Glass Enable the hash verify command (hash -v). This adds to code 2559bf36c5d5SSimon Glass size a little. 2560bf36c5d5SSimon Glass 2561bf36c5d5SSimon Glass CONFIG_SHA1 - support SHA1 hashing 2562bf36c5d5SSimon Glass CONFIG_SHA256 - support SHA256 hashing 2563bf36c5d5SSimon Glass 2564bf36c5d5SSimon Glass Note: There is also a sha1sum command, which should perhaps 2565bf36c5d5SSimon Glass be deprecated in favour of 'hash sha1'. 2566bf36c5d5SSimon Glass 2567a8c7c708Swdenk- Show boot progress: 2568c609719bSwdenk CONFIG_SHOW_BOOT_PROGRESS 2569c609719bSwdenk 2570c609719bSwdenk Defining this option allows to add some board- 2571c609719bSwdenk specific code (calling a user-provided function 2572c609719bSwdenk "show_boot_progress(int)") that enables you to show 2573c609719bSwdenk the system's boot progress on some display (for 2574c609719bSwdenk example, some LED's) on your board. At the moment, 2575c609719bSwdenk the following checkpoints are implemented: 2576c609719bSwdenk 25773a608ca0SSimon Glass- Detailed boot stage timing 25783a608ca0SSimon Glass CONFIG_BOOTSTAGE 25793a608ca0SSimon Glass Define this option to get detailed timing of each stage 25803a608ca0SSimon Glass of the boot process. 25813a608ca0SSimon Glass 25823a608ca0SSimon Glass CONFIG_BOOTSTAGE_USER_COUNT 25833a608ca0SSimon Glass This is the number of available user bootstage records. 25843a608ca0SSimon Glass Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...) 25853a608ca0SSimon Glass a new ID will be allocated from this stash. If you exceed 25863a608ca0SSimon Glass the limit, recording will stop. 25873a608ca0SSimon Glass 25883a608ca0SSimon Glass CONFIG_BOOTSTAGE_REPORT 25893a608ca0SSimon Glass Define this to print a report before boot, similar to this: 25903a608ca0SSimon Glass 25913a608ca0SSimon Glass Timer summary in microseconds: 25923a608ca0SSimon Glass Mark Elapsed Stage 25933a608ca0SSimon Glass 0 0 reset 25943a608ca0SSimon Glass 3,575,678 3,575,678 board_init_f start 25953a608ca0SSimon Glass 3,575,695 17 arch_cpu_init A9 25963a608ca0SSimon Glass 3,575,777 82 arch_cpu_init done 25973a608ca0SSimon Glass 3,659,598 83,821 board_init_r start 25983a608ca0SSimon Glass 3,910,375 250,777 main_loop 25993a608ca0SSimon Glass 29,916,167 26,005,792 bootm_start 26003a608ca0SSimon Glass 30,361,327 445,160 start_kernel 26013a608ca0SSimon Glass 26022eba38cfSSimon Glass CONFIG_CMD_BOOTSTAGE 26032eba38cfSSimon Glass Add a 'bootstage' command which supports printing a report 26042eba38cfSSimon Glass and un/stashing of bootstage data. 26052eba38cfSSimon Glass 260694fd1316SSimon Glass CONFIG_BOOTSTAGE_FDT 260794fd1316SSimon Glass Stash the bootstage information in the FDT. A root 'bootstage' 260894fd1316SSimon Glass node is created with each bootstage id as a child. Each child 260994fd1316SSimon Glass has a 'name' property and either 'mark' containing the 261094fd1316SSimon Glass mark time in microsecond, or 'accum' containing the 261194fd1316SSimon Glass accumulated time for that bootstage id in microseconds. 261294fd1316SSimon Glass For example: 261394fd1316SSimon Glass 261494fd1316SSimon Glass bootstage { 261594fd1316SSimon Glass 154 { 261694fd1316SSimon Glass name = "board_init_f"; 261794fd1316SSimon Glass mark = <3575678>; 261894fd1316SSimon Glass }; 261994fd1316SSimon Glass 170 { 262094fd1316SSimon Glass name = "lcd"; 262194fd1316SSimon Glass accum = <33482>; 262294fd1316SSimon Glass }; 262394fd1316SSimon Glass }; 262494fd1316SSimon Glass 262594fd1316SSimon Glass Code in the Linux kernel can find this in /proc/devicetree. 262694fd1316SSimon Glass 26271372cce2SMarian BalakowiczLegacy uImage format: 26281372cce2SMarian Balakowicz 2629c609719bSwdenk Arg Where When 2630c609719bSwdenk 1 common/cmd_bootm.c before attempting to boot an image 2631c609719bSwdenk -1 common/cmd_bootm.c Image header has bad magic number 2632c609719bSwdenk 2 common/cmd_bootm.c Image header has correct magic number 2633c609719bSwdenk -2 common/cmd_bootm.c Image header has bad checksum 2634c609719bSwdenk 3 common/cmd_bootm.c Image header has correct checksum 2635c609719bSwdenk -3 common/cmd_bootm.c Image data has bad checksum 2636c609719bSwdenk 4 common/cmd_bootm.c Image data has correct checksum 2637c609719bSwdenk -4 common/cmd_bootm.c Image is for unsupported architecture 2638c609719bSwdenk 5 common/cmd_bootm.c Architecture check OK 26391372cce2SMarian Balakowicz -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi) 2640c609719bSwdenk 6 common/cmd_bootm.c Image Type check OK 2641c609719bSwdenk -6 common/cmd_bootm.c gunzip uncompression error 2642c609719bSwdenk -7 common/cmd_bootm.c Unimplemented compression type 2643c609719bSwdenk 7 common/cmd_bootm.c Uncompression OK 26441372cce2SMarian Balakowicz 8 common/cmd_bootm.c No uncompress/copy overwrite error 2645c609719bSwdenk -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX) 26461372cce2SMarian Balakowicz 26471372cce2SMarian Balakowicz 9 common/image.c Start initial ramdisk verification 26481372cce2SMarian Balakowicz -10 common/image.c Ramdisk header has bad magic number 26491372cce2SMarian Balakowicz -11 common/image.c Ramdisk header has bad checksum 26501372cce2SMarian Balakowicz 10 common/image.c Ramdisk header is OK 26511372cce2SMarian Balakowicz -12 common/image.c Ramdisk data has bad checksum 26521372cce2SMarian Balakowicz 11 common/image.c Ramdisk data has correct checksum 26531372cce2SMarian Balakowicz 12 common/image.c Ramdisk verification complete, start loading 265411ccc33fSMarcel Ziswiler -13 common/image.c Wrong Image Type (not PPC Linux ramdisk) 26551372cce2SMarian Balakowicz 13 common/image.c Start multifile image verification 26561372cce2SMarian Balakowicz 14 common/image.c No initial ramdisk, no multifile, continue. 26571372cce2SMarian Balakowicz 2658ea0364f1SPeter Tyser 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS 2659c609719bSwdenk 2660a47a12beSStefan Roese -30 arch/powerpc/lib/board.c Fatal error, hang the system 266163e73c9aSwdenk -31 post/post.c POST test failed, detected by post_output_backlog() 266263e73c9aSwdenk -32 post/post.c POST test failed, detected by post_run_single() 266363e73c9aSwdenk 2664566a494fSHeiko Schocher 34 common/cmd_doc.c before loading a Image from a DOC device 2665566a494fSHeiko Schocher -35 common/cmd_doc.c Bad usage of "doc" command 2666566a494fSHeiko Schocher 35 common/cmd_doc.c correct usage of "doc" command 2667566a494fSHeiko Schocher -36 common/cmd_doc.c No boot device 2668566a494fSHeiko Schocher 36 common/cmd_doc.c correct boot device 2669566a494fSHeiko Schocher -37 common/cmd_doc.c Unknown Chip ID on boot device 2670566a494fSHeiko Schocher 37 common/cmd_doc.c correct chip ID found, device available 2671566a494fSHeiko Schocher -38 common/cmd_doc.c Read Error on boot device 2672566a494fSHeiko Schocher 38 common/cmd_doc.c reading Image header from DOC device OK 2673566a494fSHeiko Schocher -39 common/cmd_doc.c Image header has bad magic number 2674566a494fSHeiko Schocher 39 common/cmd_doc.c Image header has correct magic number 2675566a494fSHeiko Schocher -40 common/cmd_doc.c Error reading Image from DOC device 2676566a494fSHeiko Schocher 40 common/cmd_doc.c Image header has correct magic number 2677566a494fSHeiko Schocher 41 common/cmd_ide.c before loading a Image from a IDE device 2678566a494fSHeiko Schocher -42 common/cmd_ide.c Bad usage of "ide" command 2679566a494fSHeiko Schocher 42 common/cmd_ide.c correct usage of "ide" command 2680566a494fSHeiko Schocher -43 common/cmd_ide.c No boot device 2681566a494fSHeiko Schocher 43 common/cmd_ide.c boot device found 2682566a494fSHeiko Schocher -44 common/cmd_ide.c Device not available 2683566a494fSHeiko Schocher 44 common/cmd_ide.c Device available 2684566a494fSHeiko Schocher -45 common/cmd_ide.c wrong partition selected 2685566a494fSHeiko Schocher 45 common/cmd_ide.c partition selected 2686566a494fSHeiko Schocher -46 common/cmd_ide.c Unknown partition table 2687566a494fSHeiko Schocher 46 common/cmd_ide.c valid partition table found 2688566a494fSHeiko Schocher -47 common/cmd_ide.c Invalid partition type 2689566a494fSHeiko Schocher 47 common/cmd_ide.c correct partition type 2690566a494fSHeiko Schocher -48 common/cmd_ide.c Error reading Image Header on boot device 2691566a494fSHeiko Schocher 48 common/cmd_ide.c reading Image Header from IDE device OK 2692566a494fSHeiko Schocher -49 common/cmd_ide.c Image header has bad magic number 2693566a494fSHeiko Schocher 49 common/cmd_ide.c Image header has correct magic number 2694566a494fSHeiko Schocher -50 common/cmd_ide.c Image header has bad checksum 2695566a494fSHeiko Schocher 50 common/cmd_ide.c Image header has correct checksum 2696566a494fSHeiko Schocher -51 common/cmd_ide.c Error reading Image from IDE device 2697566a494fSHeiko Schocher 51 common/cmd_ide.c reading Image from IDE device OK 2698566a494fSHeiko Schocher 52 common/cmd_nand.c before loading a Image from a NAND device 2699566a494fSHeiko Schocher -53 common/cmd_nand.c Bad usage of "nand" command 2700566a494fSHeiko Schocher 53 common/cmd_nand.c correct usage of "nand" command 2701566a494fSHeiko Schocher -54 common/cmd_nand.c No boot device 2702566a494fSHeiko Schocher 54 common/cmd_nand.c boot device found 2703566a494fSHeiko Schocher -55 common/cmd_nand.c Unknown Chip ID on boot device 2704566a494fSHeiko Schocher 55 common/cmd_nand.c correct chip ID found, device available 2705566a494fSHeiko Schocher -56 common/cmd_nand.c Error reading Image Header on boot device 2706566a494fSHeiko Schocher 56 common/cmd_nand.c reading Image Header from NAND device OK 2707566a494fSHeiko Schocher -57 common/cmd_nand.c Image header has bad magic number 2708566a494fSHeiko Schocher 57 common/cmd_nand.c Image header has correct magic number 2709566a494fSHeiko Schocher -58 common/cmd_nand.c Error reading Image from NAND device 2710566a494fSHeiko Schocher 58 common/cmd_nand.c reading Image from NAND device OK 2711c609719bSwdenk 2712566a494fSHeiko Schocher -60 common/env_common.c Environment has a bad CRC, using default 2713c609719bSwdenk 2714566a494fSHeiko Schocher 64 net/eth.c starting with Ethernet configuration. 2715566a494fSHeiko Schocher -64 net/eth.c no Ethernet found. 2716566a494fSHeiko Schocher 65 net/eth.c Ethernet found. 2717206c60cbSwdenk 2718566a494fSHeiko Schocher -80 common/cmd_net.c usage wrong 2719566a494fSHeiko Schocher 80 common/cmd_net.c before calling NetLoop() 272011ccc33fSMarcel Ziswiler -81 common/cmd_net.c some error in NetLoop() occurred 2721566a494fSHeiko Schocher 81 common/cmd_net.c NetLoop() back without error 2722566a494fSHeiko Schocher -82 common/cmd_net.c size == 0 (File with size 0 loaded) 2723566a494fSHeiko Schocher 82 common/cmd_net.c trying automatic boot 272474de7aefSWolfgang Denk 83 common/cmd_net.c running "source" command 272574de7aefSWolfgang Denk -83 common/cmd_net.c some error in automatic boot or "source" command 2726566a494fSHeiko Schocher 84 common/cmd_net.c end without errors 2727c609719bSwdenk 27281372cce2SMarian BalakowiczFIT uImage format: 27291372cce2SMarian Balakowicz 27301372cce2SMarian Balakowicz Arg Where When 27311372cce2SMarian Balakowicz 100 common/cmd_bootm.c Kernel FIT Image has correct format 27321372cce2SMarian Balakowicz -100 common/cmd_bootm.c Kernel FIT Image has incorrect format 27331372cce2SMarian Balakowicz 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration 27341372cce2SMarian Balakowicz -101 common/cmd_bootm.c Can't get configuration for kernel subimage 27351372cce2SMarian Balakowicz 102 common/cmd_bootm.c Kernel unit name specified 27361372cce2SMarian Balakowicz -103 common/cmd_bootm.c Can't get kernel subimage node offset 2737f773bea8SMarian Balakowicz 103 common/cmd_bootm.c Found configuration node 27381372cce2SMarian Balakowicz 104 common/cmd_bootm.c Got kernel subimage node offset 27391372cce2SMarian Balakowicz -104 common/cmd_bootm.c Kernel subimage hash verification failed 27401372cce2SMarian Balakowicz 105 common/cmd_bootm.c Kernel subimage hash verification OK 27411372cce2SMarian Balakowicz -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture 27421372cce2SMarian Balakowicz 106 common/cmd_bootm.c Architecture check OK 274311ccc33fSMarcel Ziswiler -106 common/cmd_bootm.c Kernel subimage has wrong type 274411ccc33fSMarcel Ziswiler 107 common/cmd_bootm.c Kernel subimage type OK 27451372cce2SMarian Balakowicz -107 common/cmd_bootm.c Can't get kernel subimage data/size 27461372cce2SMarian Balakowicz 108 common/cmd_bootm.c Got kernel subimage data/size 27471372cce2SMarian Balakowicz -108 common/cmd_bootm.c Wrong image type (not legacy, FIT) 27481372cce2SMarian Balakowicz -109 common/cmd_bootm.c Can't get kernel subimage type 27491372cce2SMarian Balakowicz -110 common/cmd_bootm.c Can't get kernel subimage comp 27501372cce2SMarian Balakowicz -111 common/cmd_bootm.c Can't get kernel subimage os 27511372cce2SMarian Balakowicz -112 common/cmd_bootm.c Can't get kernel subimage load address 27521372cce2SMarian Balakowicz -113 common/cmd_bootm.c Image uncompress/copy overwrite error 27531372cce2SMarian Balakowicz 27541372cce2SMarian Balakowicz 120 common/image.c Start initial ramdisk verification 27551372cce2SMarian Balakowicz -120 common/image.c Ramdisk FIT image has incorrect format 27561372cce2SMarian Balakowicz 121 common/image.c Ramdisk FIT image has correct format 275711ccc33fSMarcel Ziswiler 122 common/image.c No ramdisk subimage unit name, using configuration 27581372cce2SMarian Balakowicz -122 common/image.c Can't get configuration for ramdisk subimage 27591372cce2SMarian Balakowicz 123 common/image.c Ramdisk unit name specified 27601372cce2SMarian Balakowicz -124 common/image.c Can't get ramdisk subimage node offset 27611372cce2SMarian Balakowicz 125 common/image.c Got ramdisk subimage node offset 27621372cce2SMarian Balakowicz -125 common/image.c Ramdisk subimage hash verification failed 27631372cce2SMarian Balakowicz 126 common/image.c Ramdisk subimage hash verification OK 27641372cce2SMarian Balakowicz -126 common/image.c Ramdisk subimage for unsupported architecture 27651372cce2SMarian Balakowicz 127 common/image.c Architecture check OK 27661372cce2SMarian Balakowicz -127 common/image.c Can't get ramdisk subimage data/size 27671372cce2SMarian Balakowicz 128 common/image.c Got ramdisk subimage data/size 27681372cce2SMarian Balakowicz 129 common/image.c Can't get ramdisk load address 27691372cce2SMarian Balakowicz -129 common/image.c Got ramdisk load address 27701372cce2SMarian Balakowicz 277111ccc33fSMarcel Ziswiler -130 common/cmd_doc.c Incorrect FIT image format 27721372cce2SMarian Balakowicz 131 common/cmd_doc.c FIT image format OK 27731372cce2SMarian Balakowicz 277411ccc33fSMarcel Ziswiler -140 common/cmd_ide.c Incorrect FIT image format 27751372cce2SMarian Balakowicz 141 common/cmd_ide.c FIT image format OK 27761372cce2SMarian Balakowicz 277711ccc33fSMarcel Ziswiler -150 common/cmd_nand.c Incorrect FIT image format 27781372cce2SMarian Balakowicz 151 common/cmd_nand.c FIT image format OK 27791372cce2SMarian Balakowicz 2780d95f6ec7SGabe Black- FIT image support: 2781d95f6ec7SGabe Black CONFIG_FIT 2782d95f6ec7SGabe Black Enable support for the FIT uImage format. 2783d95f6ec7SGabe Black 2784d95f6ec7SGabe Black CONFIG_FIT_BEST_MATCH 2785d95f6ec7SGabe Black When no configuration is explicitly selected, default to the 2786d95f6ec7SGabe Black one whose fdt's compatibility field best matches that of 2787d95f6ec7SGabe Black U-Boot itself. A match is considered "best" if it matches the 2788d95f6ec7SGabe Black most specific compatibility entry of U-Boot's fdt's root node. 2789d95f6ec7SGabe Black The order of entries in the configuration's fdt is ignored. 2790d95f6ec7SGabe Black 27914cf2609bSWolfgang Denk- Standalone program support: 27924cf2609bSWolfgang Denk CONFIG_STANDALONE_LOAD_ADDR 27934cf2609bSWolfgang Denk 27946feff899SWolfgang Denk This option defines a board specific value for the 27956feff899SWolfgang Denk address where standalone program gets loaded, thus 27966feff899SWolfgang Denk overwriting the architecture dependent default 27974cf2609bSWolfgang Denk settings. 27984cf2609bSWolfgang Denk 27994cf2609bSWolfgang Denk- Frame Buffer Address: 28004cf2609bSWolfgang Denk CONFIG_FB_ADDR 28014cf2609bSWolfgang Denk 28024cf2609bSWolfgang Denk Define CONFIG_FB_ADDR if you want to use specific 280344a53b57SWolfgang Denk address for frame buffer. This is typically the case 280444a53b57SWolfgang Denk when using a graphics controller has separate video 280544a53b57SWolfgang Denk memory. U-Boot will then place the frame buffer at 280644a53b57SWolfgang Denk the given address instead of dynamically reserving it 280744a53b57SWolfgang Denk in system RAM by calling lcd_setmem(), which grabs 280844a53b57SWolfgang Denk the memory for the frame buffer depending on the 280944a53b57SWolfgang Denk configured panel size. 28104cf2609bSWolfgang Denk 28114cf2609bSWolfgang Denk Please see board_init_f function. 28124cf2609bSWolfgang Denk 2813cccfc2abSDetlev Zundel- Automatic software updates via TFTP server 2814cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP 2815cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP_CNT_MAX 2816cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP_MSEC_MAX 2817cccfc2abSDetlev Zundel 2818cccfc2abSDetlev Zundel These options enable and control the auto-update feature; 2819cccfc2abSDetlev Zundel for a more detailed description refer to doc/README.update. 2820cccfc2abSDetlev Zundel 2821cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support) 2822cccfc2abSDetlev Zundel CONFIG_MTD_DEVICE 2823cccfc2abSDetlev Zundel 2824cccfc2abSDetlev Zundel Adds the MTD device infrastructure from the Linux kernel. 2825cccfc2abSDetlev Zundel Needed for mtdparts command support. 2826cccfc2abSDetlev Zundel 2827cccfc2abSDetlev Zundel CONFIG_MTD_PARTITIONS 2828cccfc2abSDetlev Zundel 2829cccfc2abSDetlev Zundel Adds the MTD partitioning infrastructure from the Linux 2830cccfc2abSDetlev Zundel kernel. Needed for UBI support. 2831cccfc2abSDetlev Zundel 283270c219cdSJoe Hershberger- UBI support 283370c219cdSJoe Hershberger CONFIG_CMD_UBI 283470c219cdSJoe Hershberger 283570c219cdSJoe Hershberger Adds commands for interacting with MTD partitions formatted 283670c219cdSJoe Hershberger with the UBI flash translation layer 283770c219cdSJoe Hershberger 283870c219cdSJoe Hershberger Requires also defining CONFIG_RBTREE 283970c219cdSJoe Hershberger 2840147162daSJoe Hershberger CONFIG_UBI_SILENCE_MSG 2841147162daSJoe Hershberger 2842147162daSJoe Hershberger Make the verbose messages from UBI stop printing. This leaves 2843147162daSJoe Hershberger warnings and errors enabled. 2844147162daSJoe Hershberger 284570c219cdSJoe Hershberger- UBIFS support 284670c219cdSJoe Hershberger CONFIG_CMD_UBIFS 284770c219cdSJoe Hershberger 284870c219cdSJoe Hershberger Adds commands for interacting with UBI volumes formatted as 284970c219cdSJoe Hershberger UBIFS. UBIFS is read-only in u-boot. 285070c219cdSJoe Hershberger 285170c219cdSJoe Hershberger Requires UBI support as well as CONFIG_LZO 285270c219cdSJoe Hershberger 2853147162daSJoe Hershberger CONFIG_UBIFS_SILENCE_MSG 2854147162daSJoe Hershberger 2855147162daSJoe Hershberger Make the verbose messages from UBIFS stop printing. This leaves 2856147162daSJoe Hershberger warnings and errors enabled. 2857147162daSJoe Hershberger 28586a11cf48SDaniel Schwierzeck- SPL framework 28596a11cf48SDaniel Schwierzeck CONFIG_SPL 28606a11cf48SDaniel Schwierzeck Enable building of SPL globally. 28616a11cf48SDaniel Schwierzeck 286295579793STom Rini CONFIG_SPL_LDSCRIPT 286395579793STom Rini LDSCRIPT for linking the SPL binary. 286495579793STom Rini 28656ebc3461SAlbert ARIBAUD CONFIG_SPL_MAX_FOOTPRINT 28666ebc3461SAlbert ARIBAUD Maximum size in memory allocated to the SPL, BSS included. 28676ebc3461SAlbert ARIBAUD When defined, the linker checks that the actual memory 28686ebc3461SAlbert ARIBAUD used by SPL from _start to __bss_end does not exceed it. 28698960af8bSAlbert ARIBAUD CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE 28706ebc3461SAlbert ARIBAUD must not be both defined at the same time. 28716ebc3461SAlbert ARIBAUD 287295579793STom Rini CONFIG_SPL_MAX_SIZE 28736ebc3461SAlbert ARIBAUD Maximum size of the SPL image (text, data, rodata, and 28746ebc3461SAlbert ARIBAUD linker lists sections), BSS excluded. 28756ebc3461SAlbert ARIBAUD When defined, the linker checks that the actual size does 28766ebc3461SAlbert ARIBAUD not exceed it. 287795579793STom Rini 28786a11cf48SDaniel Schwierzeck CONFIG_SPL_TEXT_BASE 28796a11cf48SDaniel Schwierzeck TEXT_BASE for linking the SPL binary. 28806a11cf48SDaniel Schwierzeck 288194a45bb1SScott Wood CONFIG_SPL_RELOC_TEXT_BASE 288294a45bb1SScott Wood Address to relocate to. If unspecified, this is equal to 288394a45bb1SScott Wood CONFIG_SPL_TEXT_BASE (i.e. no relocation is done). 288494a45bb1SScott Wood 288595579793STom Rini CONFIG_SPL_BSS_START_ADDR 288695579793STom Rini Link address for the BSS within the SPL binary. 288795579793STom Rini 288895579793STom Rini CONFIG_SPL_BSS_MAX_SIZE 28896ebc3461SAlbert ARIBAUD Maximum size in memory allocated to the SPL BSS. 28906ebc3461SAlbert ARIBAUD When defined, the linker checks that the actual memory used 28916ebc3461SAlbert ARIBAUD by SPL from __bss_start to __bss_end does not exceed it. 28928960af8bSAlbert ARIBAUD CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE 28936ebc3461SAlbert ARIBAUD must not be both defined at the same time. 289495579793STom Rini 289595579793STom Rini CONFIG_SPL_STACK 289695579793STom Rini Adress of the start of the stack SPL will use 289795579793STom Rini 289894a45bb1SScott Wood CONFIG_SPL_RELOC_STACK 289994a45bb1SScott Wood Adress of the start of the stack SPL will use after 290094a45bb1SScott Wood relocation. If unspecified, this is equal to 290194a45bb1SScott Wood CONFIG_SPL_STACK. 290294a45bb1SScott Wood 290395579793STom Rini CONFIG_SYS_SPL_MALLOC_START 290495579793STom Rini Starting address of the malloc pool used in SPL. 290595579793STom Rini 290695579793STom Rini CONFIG_SYS_SPL_MALLOC_SIZE 290795579793STom Rini The size of the malloc pool used in SPL. 29086a11cf48SDaniel Schwierzeck 290947f7bcaeSTom Rini CONFIG_SPL_FRAMEWORK 291047f7bcaeSTom Rini Enable the SPL framework under common/. This framework 291147f7bcaeSTom Rini supports MMC, NAND and YMODEM loading of U-Boot and NAND 291247f7bcaeSTom Rini NAND loading of the Linux Kernel. 291347f7bcaeSTom Rini 2914861a86f4STom Rini CONFIG_SPL_DISPLAY_PRINT 2915861a86f4STom Rini For ARM, enable an optional function to print more information 2916861a86f4STom Rini about the running system. 2917861a86f4STom Rini 29184b919725SScott Wood CONFIG_SPL_INIT_MINIMAL 29194b919725SScott Wood Arch init code should be built for a very small image 29204b919725SScott Wood 29216a11cf48SDaniel Schwierzeck CONFIG_SPL_LIBCOMMON_SUPPORT 29226a11cf48SDaniel Schwierzeck Support for common/libcommon.o in SPL binary 29236a11cf48SDaniel Schwierzeck 29246a11cf48SDaniel Schwierzeck CONFIG_SPL_LIBDISK_SUPPORT 29256a11cf48SDaniel Schwierzeck Support for disk/libdisk.o in SPL binary 29266a11cf48SDaniel Schwierzeck 29276a11cf48SDaniel Schwierzeck CONFIG_SPL_I2C_SUPPORT 29286a11cf48SDaniel Schwierzeck Support for drivers/i2c/libi2c.o in SPL binary 29296a11cf48SDaniel Schwierzeck 29306a11cf48SDaniel Schwierzeck CONFIG_SPL_GPIO_SUPPORT 29316a11cf48SDaniel Schwierzeck Support for drivers/gpio/libgpio.o in SPL binary 29326a11cf48SDaniel Schwierzeck 29336a11cf48SDaniel Schwierzeck CONFIG_SPL_MMC_SUPPORT 29346a11cf48SDaniel Schwierzeck Support for drivers/mmc/libmmc.o in SPL binary 29356a11cf48SDaniel Schwierzeck 293695579793STom Rini CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR, 293795579793STom Rini CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS, 293895579793STom Rini CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION 293995579793STom Rini Address, size and partition on the MMC to load U-Boot from 294095579793STom Rini when the MMC is being used in raw mode. 294195579793STom Rini 29422b75b0adSPeter Korsgaard CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR 29432b75b0adSPeter Korsgaard Sector to load kernel uImage from when MMC is being 29442b75b0adSPeter Korsgaard used in raw mode (for Falcon mode) 29452b75b0adSPeter Korsgaard 29462b75b0adSPeter Korsgaard CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR, 29472b75b0adSPeter Korsgaard CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS 29482b75b0adSPeter Korsgaard Sector and number of sectors to load kernel argument 29492b75b0adSPeter Korsgaard parameters from when MMC is being used in raw mode 29502b75b0adSPeter Korsgaard (for falcon mode) 29512b75b0adSPeter Korsgaard 295295579793STom Rini CONFIG_SPL_FAT_SUPPORT 295395579793STom Rini Support for fs/fat/libfat.o in SPL binary 295495579793STom Rini 295595579793STom Rini CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME 295695579793STom Rini Filename to read to load U-Boot when reading from FAT 295795579793STom Rini 29587ad2cc79SPeter Korsgaard CONFIG_SPL_FAT_LOAD_KERNEL_NAME 29597ad2cc79SPeter Korsgaard Filename to read to load kernel uImage when reading 29607ad2cc79SPeter Korsgaard from FAT (for Falcon mode) 29617ad2cc79SPeter Korsgaard 29627ad2cc79SPeter Korsgaard CONFIG_SPL_FAT_LOAD_ARGS_NAME 29637ad2cc79SPeter Korsgaard Filename to read to load kernel argument parameters 29647ad2cc79SPeter Korsgaard when reading from FAT (for Falcon mode) 29657ad2cc79SPeter Korsgaard 296606f60ae3SScott Wood CONFIG_SPL_MPC83XX_WAIT_FOR_NAND 296706f60ae3SScott Wood Set this for NAND SPL on PPC mpc83xx targets, so that 296806f60ae3SScott Wood start.S waits for the rest of the SPL to load before 296906f60ae3SScott Wood continuing (the hardware starts execution after just 297006f60ae3SScott Wood loading the first page rather than the full 4K). 297106f60ae3SScott Wood 29726f2f01b9SScott Wood CONFIG_SPL_NAND_BASE 29736f2f01b9SScott Wood Include nand_base.c in the SPL. Requires 29746f2f01b9SScott Wood CONFIG_SPL_NAND_DRIVERS. 29756f2f01b9SScott Wood 29766f2f01b9SScott Wood CONFIG_SPL_NAND_DRIVERS 29776f2f01b9SScott Wood SPL uses normal NAND drivers, not minimal drivers. 29786f2f01b9SScott Wood 29796f2f01b9SScott Wood CONFIG_SPL_NAND_ECC 29806f2f01b9SScott Wood Include standard software ECC in the SPL 29816f2f01b9SScott Wood 298295579793STom Rini CONFIG_SPL_NAND_SIMPLE 29837d4b7955SScott Wood Support for NAND boot using simple NAND drivers that 29847d4b7955SScott Wood expose the cmd_ctrl() interface. 298595579793STom Rini 298695579793STom Rini CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT, 298795579793STom Rini CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE, 298895579793STom Rini CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS, 298995579793STom Rini CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE, 299095579793STom Rini CONFIG_SYS_NAND_ECCBYTES 299195579793STom Rini Defines the size and behavior of the NAND that SPL uses 29927d4b7955SScott Wood to read U-Boot 299395579793STom Rini 299495579793STom Rini CONFIG_SYS_NAND_U_BOOT_OFFS 29957d4b7955SScott Wood Location in NAND to read U-Boot from 29967d4b7955SScott Wood 29977d4b7955SScott Wood CONFIG_SYS_NAND_U_BOOT_DST 29987d4b7955SScott Wood Location in memory to load U-Boot to 29997d4b7955SScott Wood 30007d4b7955SScott Wood CONFIG_SYS_NAND_U_BOOT_SIZE 30017d4b7955SScott Wood Size of image to load 300295579793STom Rini 300395579793STom Rini CONFIG_SYS_NAND_U_BOOT_START 30047d4b7955SScott Wood Entry point in loaded image to jump to 300595579793STom Rini 300695579793STom Rini CONFIG_SYS_NAND_HW_ECC_OOBFIRST 300795579793STom Rini Define this if you need to first read the OOB and then the 300895579793STom Rini data. This is used for example on davinci plattforms. 300995579793STom Rini 301095579793STom Rini CONFIG_SPL_OMAP3_ID_NAND 301195579793STom Rini Support for an OMAP3-specific set of functions to return the 301295579793STom Rini ID and MFR of the first attached NAND chip, if present. 301395579793STom Rini 30146a11cf48SDaniel Schwierzeck CONFIG_SPL_SERIAL_SUPPORT 30156a11cf48SDaniel Schwierzeck Support for drivers/serial/libserial.o in SPL binary 30166a11cf48SDaniel Schwierzeck 30176a11cf48SDaniel Schwierzeck CONFIG_SPL_SPI_FLASH_SUPPORT 30186a11cf48SDaniel Schwierzeck Support for drivers/mtd/spi/libspi_flash.o in SPL binary 30196a11cf48SDaniel Schwierzeck 30206a11cf48SDaniel Schwierzeck CONFIG_SPL_SPI_SUPPORT 30216a11cf48SDaniel Schwierzeck Support for drivers/spi/libspi.o in SPL binary 30226a11cf48SDaniel Schwierzeck 3023c57b953dSPavel Machek CONFIG_SPL_RAM_DEVICE 3024c57b953dSPavel Machek Support for running image already present in ram, in SPL binary 3025c57b953dSPavel Machek 30266a11cf48SDaniel Schwierzeck CONFIG_SPL_LIBGENERIC_SUPPORT 30276a11cf48SDaniel Schwierzeck Support for lib/libgeneric.o in SPL binary 30281372cce2SMarian Balakowicz 302974752baaSScott Wood CONFIG_SPL_PAD_TO 30306113d3f2SBenoît Thébaudeau Image offset to which the SPL should be padded before appending 30316113d3f2SBenoît Thébaudeau the SPL payload. By default, this is defined as 30326113d3f2SBenoît Thébaudeau CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined. 30336113d3f2SBenoît Thébaudeau CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL 30346113d3f2SBenoît Thébaudeau payload without any padding, or >= CONFIG_SPL_MAX_SIZE. 303574752baaSScott Wood 3036ca2fca22SScott Wood CONFIG_SPL_TARGET 3037ca2fca22SScott Wood Final target image containing SPL and payload. Some SPLs 3038ca2fca22SScott Wood use an arch-specific makefile fragment instead, for 3039ca2fca22SScott Wood example if more than one image needs to be produced. 3040ca2fca22SScott Wood 304187ebee39SSimon Glass CONFIG_FIT_SPL_PRINT 304287ebee39SSimon Glass Printing information about a FIT image adds quite a bit of 304387ebee39SSimon Glass code to SPL. So this is normally disabled in SPL. Use this 304487ebee39SSimon Glass option to re-enable it. This will affect the output of the 304587ebee39SSimon Glass bootm command when booting a FIT image. 304687ebee39SSimon Glass 3047c609719bSwdenkModem Support: 3048c609719bSwdenk-------------- 3049c609719bSwdenk 3050566e5cf4SWolfgang Denk[so far only for SMDK2400 boards] 3051c609719bSwdenk 305211ccc33fSMarcel Ziswiler- Modem support enable: 3053c609719bSwdenk CONFIG_MODEM_SUPPORT 3054c609719bSwdenk 3055c609719bSwdenk- RTS/CTS Flow control enable: 3056c609719bSwdenk CONFIG_HWFLOW 3057c609719bSwdenk 3058c609719bSwdenk- Modem debug support: 3059c609719bSwdenk CONFIG_MODEM_SUPPORT_DEBUG 3060c609719bSwdenk 3061c609719bSwdenk Enables debugging stuff (char screen[1024], dbg()) 3062c609719bSwdenk for modem support. Useful only with BDI2000. 3063c609719bSwdenk 3064a8c7c708Swdenk- Interrupt support (PPC): 3065a8c7c708Swdenk 3066a8c7c708Swdenk There are common interrupt_init() and timer_interrupt() 3067a8c7c708Swdenk for all PPC archs. interrupt_init() calls interrupt_init_cpu() 306811ccc33fSMarcel Ziswiler for CPU specific initialization. interrupt_init_cpu() 3069a8c7c708Swdenk should set decrementer_count to appropriate value. If 307011ccc33fSMarcel Ziswiler CPU resets decrementer automatically after interrupt 3071a8c7c708Swdenk (ppc4xx) it should set decrementer_count to zero. 307211ccc33fSMarcel Ziswiler timer_interrupt() calls timer_interrupt_cpu() for CPU 3073a8c7c708Swdenk specific handling. If board has watchdog / status_led 3074a8c7c708Swdenk / other_activity_monitor it works automatically from 3075a8c7c708Swdenk general timer_interrupt(). 3076a8c7c708Swdenk 3077c609719bSwdenk- General: 3078c609719bSwdenk 3079c609719bSwdenk In the target system modem support is enabled when a 3080c609719bSwdenk specific key (key combination) is pressed during 3081c609719bSwdenk power-on. Otherwise U-Boot will boot normally 308211ccc33fSMarcel Ziswiler (autoboot). The key_pressed() function is called from 3083c609719bSwdenk board_init(). Currently key_pressed() is a dummy 3084c609719bSwdenk function, returning 1 and thus enabling modem 3085c609719bSwdenk initialization. 3086c609719bSwdenk 3087c609719bSwdenk If there are no modem init strings in the 3088c609719bSwdenk environment, U-Boot proceed to autoboot; the 3089c609719bSwdenk previous output (banner, info printfs) will be 309011ccc33fSMarcel Ziswiler suppressed, though. 3091c609719bSwdenk 3092c609719bSwdenk See also: doc/README.Modem 3093c609719bSwdenk 30949660e442SHelmut RaigerBoard initialization settings: 30959660e442SHelmut Raiger------------------------------ 30969660e442SHelmut Raiger 30979660e442SHelmut RaigerDuring Initialization u-boot calls a number of board specific functions 30989660e442SHelmut Raigerto allow the preparation of board specific prerequisites, e.g. pin setup 30999660e442SHelmut Raigerbefore drivers are initialized. To enable these callbacks the 31009660e442SHelmut Raigerfollowing configuration macros have to be defined. Currently this is 31019660e442SHelmut Raigerarchitecture specific, so please check arch/your_architecture/lib/board.c 31029660e442SHelmut Raigertypically in board_init_f() and board_init_r(). 31039660e442SHelmut Raiger 31049660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f() 31059660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r() 31069660e442SHelmut Raiger- CONFIG_BOARD_LATE_INIT: Call board_late_init() 31079660e442SHelmut Raiger- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init() 3108c609719bSwdenk 3109c609719bSwdenkConfiguration Settings: 3110c609719bSwdenk----------------------- 3111c609719bSwdenk 31126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included; 3113c609719bSwdenk undefine this when you're short of memory. 3114c609719bSwdenk 31152fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default 31162fb2604dSPeter Tyser width of the commands listed in the 'help' command output. 31172fb2604dSPeter Tyser 31186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to 3119c609719bSwdenk prompt for user input. 3120c609719bSwdenk 31216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE: Buffer size for input from the Console 3122c609719bSwdenk 31236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE: Buffer size for Console output 3124c609719bSwdenk 31256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands 3126c609719bSwdenk 31276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to 3128c609719bSwdenk the application (usually a Linux kernel) when it is 3129c609719bSwdenk booted 3130c609719bSwdenk 31316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE: 3132c609719bSwdenk List of legal baudrate settings for this board. 3133c609719bSwdenk 31346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET 3135c609719bSwdenk Suppress display of console information at boot. 3136c609719bSwdenk 31376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV 3138c609719bSwdenk If the board specific function 3139c609719bSwdenk extern int overwrite_console (void); 3140c609719bSwdenk returns 1, the stdin, stderr and stdout are switched to the 3141c609719bSwdenk serial port, else the settings in the environment are used. 3142c609719bSwdenk 31436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE 3144c609719bSwdenk Enable the call to overwrite_console(). 3145c609719bSwdenk 31466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE 3147c609719bSwdenk Enable overwrite of previous console environment settings. 3148c609719bSwdenk 31496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END: 3150c609719bSwdenk Begin and End addresses of the area used by the 3151c609719bSwdenk simple memory test. 3152c609719bSwdenk 31536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST: 3154c609719bSwdenk Enable an alternate, more extensive memory test. 3155c609719bSwdenk 31566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH: 31575f535fe1Swdenk Scratch address used by the alternate memory test 31585f535fe1Swdenk You only need to set this if address zero isn't writeable 31595f535fe1Swdenk 31606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only): 31616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header, 316214f73ca6SStefan Roese this specified memory area will get subtracted from the top 316311ccc33fSMarcel Ziswiler (end) of RAM and won't get "touched" at all by U-Boot. By 316414f73ca6SStefan Roese fixing up gd->ram_size the Linux kernel should gets passed 316514f73ca6SStefan Roese the now "corrected" memory size and won't touch it either. 316614f73ca6SStefan Roese This should work for arch/ppc and arch/powerpc. Only Linux 31675e12e75dSStefan Roese board ports in arch/powerpc with bootwrapper support that 316814f73ca6SStefan Roese recalculate the memory size from the SDRAM controller setup 31695e12e75dSStefan Roese will have to get fixed in Linux additionally. 317014f73ca6SStefan Roese 317114f73ca6SStefan Roese This option can be used as a workaround for the 440EPx/GRx 317214f73ca6SStefan Roese CHIP 11 errata where the last 256 bytes in SDRAM shouldn't 317314f73ca6SStefan Roese be touched. 317414f73ca6SStefan Roese 317514f73ca6SStefan Roese WARNING: Please make sure that this value is a multiple of 317614f73ca6SStefan Roese the Linux page size (normally 4k). If this is not the case, 317714f73ca6SStefan Roese then the end address of the Linux memory will be located at a 317814f73ca6SStefan Roese non page size aligned address and this could cause major 317914f73ca6SStefan Roese problems. 318014f73ca6SStefan Roese 31816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE: 3182c609719bSwdenk Enable temporary baudrate change while serial download 3183c609719bSwdenk 31846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE: 3185c609719bSwdenk Physical start address of SDRAM. _Must_ be 0 here. 3186c609719bSwdenk 31876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE: 3188c609719bSwdenk Physical start address of Motherboard I/O (if using a 3189c609719bSwdenk Cogent motherboard) 3190c609719bSwdenk 31916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE: 3192c609719bSwdenk Physical start address of Flash memory. 3193c609719bSwdenk 31946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE: 3195c609719bSwdenk Physical start address of boot monitor code (set by 3196c609719bSwdenk make config files to be same as the text base address 319714d0a02aSWolfgang Denk (CONFIG_SYS_TEXT_BASE) used when linking) - same as 31986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FLASH_BASE when booting from flash. 3199c609719bSwdenk 32006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN: 32013b57fe0aSwdenk Size of memory reserved for monitor code, used to 32023b57fe0aSwdenk determine _at_compile_time_ (!) if the environment is 32033b57fe0aSwdenk embedded within the U-Boot image, or in a separate 32043b57fe0aSwdenk flash sector. 3205c609719bSwdenk 32066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN: 3207c609719bSwdenk Size of DRAM reserved for malloc() use. 3208c609719bSwdenk 32096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN: 321015940c9aSStefan Roese Normally compressed uImages are limited to an 321115940c9aSStefan Roese uncompressed size of 8 MBytes. If this is not enough, 32126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD you can define CONFIG_SYS_BOOTM_LEN in your board config file 321315940c9aSStefan Roese to adjust this setting to your needs. 3214c609719bSwdenk 32156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ: 3216c609719bSwdenk Maximum size of memory mapped by the startup code of 3217c609719bSwdenk the Linux kernel; all data that must be processed by 32187d721e34SBartlomiej Sieka the Linux kernel (bd_info, boot arguments, FDT blob if 32197d721e34SBartlomiej Sieka used) must be put below this limit, unless "bootm_low" 32207d721e34SBartlomiej Sieka enviroment variable is defined and non-zero. In such case 32217d721e34SBartlomiej Sieka all data for the Linux kernel must be between "bootm_low" 3222c3624e6eSGrant Likely and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment 3223c3624e6eSGrant Likely variable "bootm_mapsize" will override the value of 3224c3624e6eSGrant Likely CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined, 3225c3624e6eSGrant Likely then the value in "bootm_size" will be used instead. 3226c609719bSwdenk 3227fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH: 3228fca43cc8SJohn Rigby Enable initrd_high functionality. If defined then the 3229fca43cc8SJohn Rigby initrd_high feature is enabled and the bootm ramdisk subcommand 3230fca43cc8SJohn Rigby is enabled. 3231fca43cc8SJohn Rigby 3232fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE: 3233fca43cc8SJohn Rigby Enables allocating and saving kernel cmdline in space between 3234fca43cc8SJohn Rigby "bootm_low" and "bootm_low" + BOOTMAPSZ. 3235fca43cc8SJohn Rigby 3236fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD: 3237fca43cc8SJohn Rigby Enables allocating and saving a kernel copy of the bd_info in 3238fca43cc8SJohn Rigby space between "bootm_low" and "bootm_low" + BOOTMAPSZ. 3239fca43cc8SJohn Rigby 32406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS: 3241c609719bSwdenk Max number of Flash memory banks 3242c609719bSwdenk 32436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT: 3244c609719bSwdenk Max number of sectors on a Flash chip 3245c609719bSwdenk 32466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT: 3247c609719bSwdenk Timeout for Flash erase operations (in ms) 3248c609719bSwdenk 32496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT: 3250c609719bSwdenk Timeout for Flash write operations (in ms) 3251c609719bSwdenk 32526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT 32538564acf9Swdenk Timeout for Flash set sector lock bit operation (in ms) 32548564acf9Swdenk 32556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT 32568564acf9Swdenk Timeout for Flash clear lock bits operation (in ms) 32578564acf9Swdenk 32586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION 32598564acf9Swdenk If defined, hardware flash sectors protection is used 32608564acf9Swdenk instead of U-Boot software protection. 32618564acf9Swdenk 32626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP: 3263c609719bSwdenk 3264c609719bSwdenk Enable TFTP transfers directly to flash memory; 3265c609719bSwdenk without this option such a download has to be 3266c609719bSwdenk performed in two steps: (1) download to RAM, and (2) 3267c609719bSwdenk copy from RAM to flash. 3268c609719bSwdenk 3269c609719bSwdenk The two-step approach is usually more reliable, since 3270c609719bSwdenk you can check if the download worked before you erase 327111ccc33fSMarcel Ziswiler the flash, but in some situations (when system RAM is 327211ccc33fSMarcel Ziswiler too limited to allow for a temporary copy of the 3273c609719bSwdenk downloaded image) this option may be very useful. 3274c609719bSwdenk 32756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI: 3276c609719bSwdenk Define if the flash driver uses extra elements in the 32775653fc33Swdenk common flash structure for storing flash geometry. 32785653fc33Swdenk 327900b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER 32805653fc33Swdenk This option also enables the building of the cfi_flash driver 32815653fc33Swdenk in the drivers directory 328253cf9435Sstroese 328391809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD 328491809ed5SPiotr Ziecik This option enables the building of the cfi_mtd driver 328591809ed5SPiotr Ziecik in the drivers directory. The driver exports CFI flash 328691809ed5SPiotr Ziecik to the MTD layer. 328791809ed5SPiotr Ziecik 32886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE 328996ef831fSGuennadi Liakhovetski Use buffered writes to flash. 329096ef831fSGuennadi Liakhovetski 329196ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N 329296ef831fSGuennadi Liakhovetski s29ws-n MirrorBit flash has non-standard addresses for buffered 329396ef831fSGuennadi Liakhovetski write commands. 329496ef831fSGuennadi Liakhovetski 32956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST 32965568e613SStefan Roese If this option is defined, the common CFI flash doesn't 32975568e613SStefan Roese print it's warning upon not recognized FLASH banks. This 32985568e613SStefan Roese is useful, if some of the configured banks are only 32995568e613SStefan Roese optionally available. 33005568e613SStefan Roese 33019a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS 33029a042e9cSJerry Van Baren If defined (must be an integer), print out countdown 33039a042e9cSJerry Van Baren digits and dots. Recommended value: 45 (9..1) for 80 33049a042e9cSJerry Van Baren column displays, 15 (3..1) for 40 column displays. 33059a042e9cSJerry Van Baren 3306352ef3f1SStefan Roese- CONFIG_FLASH_VERIFY 3307352ef3f1SStefan Roese If defined, the content of the flash (destination) is compared 3308352ef3f1SStefan Roese against the source after the write operation. An error message 3309352ef3f1SStefan Roese will be printed when the contents are not identical. 3310352ef3f1SStefan Roese Please note that this option is useless in nearly all cases, 3311352ef3f1SStefan Roese since such flash programming errors usually are detected earlier 3312352ef3f1SStefan Roese while unprotecting/erasing/programming. Please only enable 3313352ef3f1SStefan Roese this option if you really know what you are doing. 3314352ef3f1SStefan Roese 33156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER: 331611ccc33fSMarcel Ziswiler Defines the number of Ethernet receive buffers. On some 331711ccc33fSMarcel Ziswiler Ethernet controllers it is recommended to set this value 331853cf9435Sstroese to 8 or even higher (EEPRO100 or 405 EMAC), since all 331953cf9435Sstroese buffers can be full shortly after enabling the interface 332011ccc33fSMarcel Ziswiler on high Ethernet traffic. 332153cf9435Sstroese Defaults to 4 if not defined. 3322c609719bSwdenk 3323ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES 3324ea882bafSWolfgang Denk 3325ea882bafSWolfgang Denk Maximum number of entries in the hash table that is used 3326ea882bafSWolfgang Denk internally to store the environment settings. The default 3327ea882bafSWolfgang Denk setting is supposed to be generous and should work in most 3328ea882bafSWolfgang Denk cases. This setting can be used to tune behaviour; see 3329ea882bafSWolfgang Denk lib/hashtable.c for details. 3330ea882bafSWolfgang Denk 33312598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_DEFAULT 33322598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_STATIC 33332598090bSJoe Hershberger Enable validation of the values given to enviroment variables when 33342598090bSJoe Hershberger calling env set. Variables can be restricted to only decimal, 33352598090bSJoe Hershberger hexadecimal, or boolean. If CONFIG_CMD_NET is also defined, 33362598090bSJoe Hershberger the variables can also be restricted to IP address or MAC address. 33372598090bSJoe Hershberger 33382598090bSJoe Hershberger The format of the list is: 33392598090bSJoe Hershberger type_attribute = [s|d|x|b|i|m] 3340267541f7SJoe Hershberger access_atribute = [a|r|o|c] 3341267541f7SJoe Hershberger attributes = type_attribute[access_atribute] 33422598090bSJoe Hershberger entry = variable_name[:attributes] 33432598090bSJoe Hershberger list = entry[,list] 33442598090bSJoe Hershberger 33452598090bSJoe Hershberger The type attributes are: 33462598090bSJoe Hershberger s - String (default) 33472598090bSJoe Hershberger d - Decimal 33482598090bSJoe Hershberger x - Hexadecimal 33492598090bSJoe Hershberger b - Boolean ([1yYtT|0nNfF]) 33502598090bSJoe Hershberger i - IP address 33512598090bSJoe Hershberger m - MAC address 33522598090bSJoe Hershberger 3353267541f7SJoe Hershberger The access attributes are: 3354267541f7SJoe Hershberger a - Any (default) 3355267541f7SJoe Hershberger r - Read-only 3356267541f7SJoe Hershberger o - Write-once 3357267541f7SJoe Hershberger c - Change-default 3358267541f7SJoe Hershberger 33592598090bSJoe Hershberger - CONFIG_ENV_FLAGS_LIST_DEFAULT 33602598090bSJoe Hershberger Define this to a list (string) to define the ".flags" 33612598090bSJoe Hershberger envirnoment variable in the default or embedded environment. 33622598090bSJoe Hershberger 33632598090bSJoe Hershberger - CONFIG_ENV_FLAGS_LIST_STATIC 33642598090bSJoe Hershberger Define this to a list (string) to define validation that 33652598090bSJoe Hershberger should be done if an entry is not found in the ".flags" 33662598090bSJoe Hershberger environment variable. To override a setting in the static 33672598090bSJoe Hershberger list, simply add an entry for the same variable name to the 33682598090bSJoe Hershberger ".flags" variable. 33692598090bSJoe Hershberger 3370267541f7SJoe Hershberger- CONFIG_ENV_ACCESS_IGNORE_FORCE 3371267541f7SJoe Hershberger If defined, don't allow the -f switch to env set override variable 3372267541f7SJoe Hershberger access flags. 3373267541f7SJoe Hershberger 33745c1a7ea6SSimon Glass- CONFIG_SYS_GENERIC_BOARD 33755c1a7ea6SSimon Glass This selects the architecture-generic board system instead of the 33765c1a7ea6SSimon Glass architecture-specific board files. It is intended to move boards 33775c1a7ea6SSimon Glass to this new framework over time. Defining this will disable the 33785c1a7ea6SSimon Glass arch/foo/lib/board.c file and use common/board_f.c and 33795c1a7ea6SSimon Glass common/board_r.c instead. To use this option your architecture 33805c1a7ea6SSimon Glass must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in 33815c1a7ea6SSimon Glass its config.mk file). If you find problems enabling this option on 33825c1a7ea6SSimon Glass your board please report the problem and send patches! 33835c1a7ea6SSimon Glass 3384632efa74SSimon Glass- CONFIG_SYS_SYM_OFFSETS 3385632efa74SSimon Glass This is set by architectures that use offsets for link symbols 3386632efa74SSimon Glass instead of absolute values. So bss_start is obtained using an 3387632efa74SSimon Glass offset _bss_start_ofs from CONFIG_SYS_TEXT_BASE, rather than 3388632efa74SSimon Glass directly. You should not need to touch this setting. 3389632efa74SSimon Glass 33900b1b60c7SLokesh Vutla- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only) 33910b1b60c7SLokesh Vutla This is set by OMAP boards for the max time that reset should 33920b1b60c7SLokesh Vutla be asserted. See doc/README.omap-reset-time for details on how 33930b1b60c7SLokesh Vutla the value can be calulated on a given board. 3394632efa74SSimon Glass 3395c609719bSwdenkThe following definitions that deal with the placement and management 3396c609719bSwdenkof environment data (variable area); in general, we support the 3397c609719bSwdenkfollowing configurations: 3398c609719bSwdenk 3399c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC: 3400c3eb3fe4SMike Frysinger 3401c3eb3fe4SMike Frysinger Builds up envcrc with the target environment so that external utils 3402c3eb3fe4SMike Frysinger may easily extract it and embed it in final U-Boot images. 3403c3eb3fe4SMike Frysinger 34045a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH: 3405c609719bSwdenk 3406c609719bSwdenk Define this if the environment is in flash memory. 3407c609719bSwdenk 3408c609719bSwdenk a) The environment occupies one whole flash sector, which is 3409c609719bSwdenk "embedded" in the text segment with the U-Boot code. This 3410c609719bSwdenk happens usually with "bottom boot sector" or "top boot 3411c609719bSwdenk sector" type flash chips, which have several smaller 3412c609719bSwdenk sectors at the start or the end. For instance, such a 3413c609719bSwdenk layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In 3414c609719bSwdenk such a case you would place the environment in one of the 3415c609719bSwdenk 4 kB sectors - with U-Boot code before and after it. With 3416c609719bSwdenk "top boot sector" type flash chips, you would put the 3417c609719bSwdenk environment in one of the last sectors, leaving a gap 3418c609719bSwdenk between U-Boot and the environment. 3419c609719bSwdenk 34200e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 3421c609719bSwdenk 3422c609719bSwdenk Offset of environment data (variable area) to the 3423c609719bSwdenk beginning of flash memory; for instance, with bottom boot 3424c609719bSwdenk type flash chips the second sector can be used: the offset 3425c609719bSwdenk for this sector is given here. 3426c609719bSwdenk 34276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE. 3428c609719bSwdenk 34290e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 3430c609719bSwdenk 3431c609719bSwdenk This is just another way to specify the start address of 3432c609719bSwdenk the flash sector containing the environment (instead of 34330e8d1586SJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_OFFSET). 3434c609719bSwdenk 34350e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SECT_SIZE: 3436c609719bSwdenk 3437c609719bSwdenk Size of the sector containing the environment. 3438c609719bSwdenk 3439c609719bSwdenk 3440c609719bSwdenk b) Sometimes flash chips have few, equal sized, BIG sectors. 3441c609719bSwdenk In such a case you don't want to spend a whole sector for 3442c609719bSwdenk the environment. 3443c609719bSwdenk 34440e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 3445c609719bSwdenk 34465a1aceb0SJean-Christophe PLAGNIOL-VILLARD If you use this in combination with CONFIG_ENV_IS_IN_FLASH 34470e8d1586SJean-Christophe PLAGNIOL-VILLARD and CONFIG_ENV_SECT_SIZE, you can specify to use only a part 3448c609719bSwdenk of this flash sector for the environment. This saves 3449c609719bSwdenk memory for the RAM copy of the environment. 3450c609719bSwdenk 3451c609719bSwdenk It may also save flash memory if you decide to use this 3452c609719bSwdenk when your environment is "embedded" within U-Boot code, 3453c609719bSwdenk since then the remainder of the flash sector could be used 3454c609719bSwdenk for U-Boot code. It should be pointed out that this is 3455c609719bSwdenk STRONGLY DISCOURAGED from a robustness point of view: 3456c609719bSwdenk updating the environment in flash makes it always 3457c609719bSwdenk necessary to erase the WHOLE sector. If something goes 3458c609719bSwdenk wrong before the contents has been restored from a copy in 3459c609719bSwdenk RAM, your target system will be dead. 3460c609719bSwdenk 34610e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR_REDUND 34620e8d1586SJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_SIZE_REDUND 3463c609719bSwdenk 3464c609719bSwdenk These settings describe a second storage area used to hold 346511ccc33fSMarcel Ziswiler a redundant copy of the environment data, so that there is 34663e38691eSwdenk a valid backup copy in case there is a power failure during 3467c609719bSwdenk a "saveenv" operation. 3468c609719bSwdenk 3469c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the 3470c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds* 3471c609719bSwdenkaccordingly! 3472c609719bSwdenk 3473c609719bSwdenk 34749314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM: 3475c609719bSwdenk 3476c609719bSwdenk Define this if you have some non-volatile memory device 3477c609719bSwdenk (NVRAM, battery buffered SRAM) which you want to use for the 3478c609719bSwdenk environment. 3479c609719bSwdenk 34800e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 34810e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 3482c609719bSwdenk 348311ccc33fSMarcel Ziswiler These two #defines are used to determine the memory area you 3484c609719bSwdenk want to use for environment. It is assumed that this memory 3485c609719bSwdenk can just be read and written to, without any special 3486c609719bSwdenk provision. 3487c609719bSwdenk 3488c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early 3489c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the 349011ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or 3491c609719bSwdenkU-Boot will hang. 3492c609719bSwdenk 3493c609719bSwdenkPlease note that even with NVRAM we still use a copy of the 3494c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to 3495c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv" 3496c609719bSwdenkto save the current settings. 3497c609719bSwdenk 3498c609719bSwdenk 3499bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM: 3500c609719bSwdenk 3501c609719bSwdenk Use this if you have an EEPROM or similar serial access 3502c609719bSwdenk device and a driver for it. 3503c609719bSwdenk 35040e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 35050e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 3506c609719bSwdenk 3507c609719bSwdenk These two #defines specify the offset and size of the 3508c609719bSwdenk environment area within the total memory of your EEPROM. 3509c609719bSwdenk 35106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR: 3511c609719bSwdenk If defined, specified the chip address of the EEPROM device. 3512c609719bSwdenk The default address is zero. 3513c609719bSwdenk 35146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS: 3515c609719bSwdenk If defined, the number of bits used to address bytes in a 3516c609719bSwdenk single page in the EEPROM device. A 64 byte page, for example 3517c609719bSwdenk would require six bits. 3518c609719bSwdenk 35196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS: 3520c609719bSwdenk If defined, the number of milliseconds to delay between 3521c609719bSwdenk page writes. The default is zero milliseconds. 3522c609719bSwdenk 35236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR_LEN: 3524c609719bSwdenk The length in bytes of the EEPROM memory array address. Note 3525c609719bSwdenk that this is NOT the chip address length! 3526c609719bSwdenk 35276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW: 35285cf91d6bSwdenk EEPROM chips that implement "address overflow" are ones 35295cf91d6bSwdenk like Catalyst 24WC04/08/16 which has 9/10/11 bits of 35305cf91d6bSwdenk address and the extra bits end up in the "chip address" bit 35315cf91d6bSwdenk slots. This makes a 24WC08 (1Kbyte) chip look like four 256 35325cf91d6bSwdenk byte chips. 35335cf91d6bSwdenk 35345cf91d6bSwdenk Note that we consider the length of the address field to 35355cf91d6bSwdenk still be one byte because the extra address bits are hidden 35365cf91d6bSwdenk in the chip address. 35375cf91d6bSwdenk 35386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_SIZE: 3539c609719bSwdenk The size in bytes of the EEPROM device. 3540c609719bSwdenk 3541548738b4SHeiko Schocher - CONFIG_ENV_EEPROM_IS_ON_I2C 3542548738b4SHeiko Schocher define this, if you have I2C and SPI activated, and your 3543548738b4SHeiko Schocher EEPROM, which holds the environment, is on the I2C bus. 3544548738b4SHeiko Schocher 3545548738b4SHeiko Schocher - CONFIG_I2C_ENV_EEPROM_BUS 3546548738b4SHeiko Schocher if you have an Environment on an EEPROM reached over 3547548738b4SHeiko Schocher I2C muxes, you can define here, how to reach this 3548548738b4SHeiko Schocher EEPROM. For example: 3549548738b4SHeiko Schocher 3550548738b4SHeiko Schocher #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0" 3551548738b4SHeiko Schocher 3552548738b4SHeiko Schocher EEPROM which holds the environment, is reached over 3553548738b4SHeiko Schocher a pca9547 i2c mux with address 0x70, channel 3. 3554c609719bSwdenk 3555057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH: 35565779d8d9Swdenk 35575779d8d9Swdenk Define this if you have a DataFlash memory device which you 35585779d8d9Swdenk want to use for the environment. 35595779d8d9Swdenk 35600e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 35610e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 35620e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 35635779d8d9Swdenk 35645779d8d9Swdenk These three #defines specify the offset and size of the 35655779d8d9Swdenk environment area within the total memory of your DataFlash placed 35665779d8d9Swdenk at the specified address. 35675779d8d9Swdenk 35680a85a9e7SLiu Gang- CONFIG_ENV_IS_IN_REMOTE: 35690a85a9e7SLiu Gang 35700a85a9e7SLiu Gang Define this if you have a remote memory space which you 35710a85a9e7SLiu Gang want to use for the local device's environment. 35720a85a9e7SLiu Gang 35730a85a9e7SLiu Gang - CONFIG_ENV_ADDR: 35740a85a9e7SLiu Gang - CONFIG_ENV_SIZE: 35750a85a9e7SLiu Gang 35760a85a9e7SLiu Gang These two #defines specify the address and size of the 35770a85a9e7SLiu Gang environment area within the remote memory space. The 35780a85a9e7SLiu Gang local device can get the environment from remote memory 3579fc54c7faSLiu Gang space by SRIO or PCIE links. 35800a85a9e7SLiu Gang 35810a85a9e7SLiu GangBE CAREFUL! For some special cases, the local device can not use 35820a85a9e7SLiu Gang"saveenv" command. For example, the local device will get the 3583fc54c7faSLiu Gangenvironment stored in a remote NOR flash by SRIO or PCIE link, 3584fc54c7faSLiu Gangbut it can not erase, write this NOR flash by SRIO or PCIE interface. 35850a85a9e7SLiu Gang 358651bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND: 358713a5695bSwdenk 358813a5695bSwdenk Define this if you have a NAND device which you want to use 358913a5695bSwdenk for the environment. 359013a5695bSwdenk 35910e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 35920e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 359313a5695bSwdenk 359413a5695bSwdenk These two #defines specify the offset and size of the environment 3595fdd813deSScott Wood area within the first NAND device. CONFIG_ENV_OFFSET must be 3596fdd813deSScott Wood aligned to an erase block boundary. 35975779d8d9Swdenk 3598fdd813deSScott Wood - CONFIG_ENV_OFFSET_REDUND (optional): 3599e443c944SMarkus Klotzbuecher 36000e8d1586SJean-Christophe PLAGNIOL-VILLARD This setting describes a second storage area of CONFIG_ENV_SIZE 3601fdd813deSScott Wood size used to hold a redundant copy of the environment data, so 3602fdd813deSScott Wood that there is a valid backup copy in case there is a power failure 3603fdd813deSScott Wood during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be 3604fdd813deSScott Wood aligned to an erase block boundary. 3605e443c944SMarkus Klotzbuecher 3606fdd813deSScott Wood - CONFIG_ENV_RANGE (optional): 3607fdd813deSScott Wood 3608fdd813deSScott Wood Specifies the length of the region in which the environment 3609fdd813deSScott Wood can be written. This should be a multiple of the NAND device's 3610fdd813deSScott Wood block size. Specifying a range with more erase blocks than 3611fdd813deSScott Wood are needed to hold CONFIG_ENV_SIZE allows bad blocks within 3612fdd813deSScott Wood the range to be avoided. 3613fdd813deSScott Wood 3614fdd813deSScott Wood - CONFIG_ENV_OFFSET_OOB (optional): 3615fdd813deSScott Wood 3616fdd813deSScott Wood Enables support for dynamically retrieving the offset of the 3617fdd813deSScott Wood environment from block zero's out-of-band data. The 3618fdd813deSScott Wood "nand env.oob" command can be used to record this offset. 3619fdd813deSScott Wood Currently, CONFIG_ENV_OFFSET_REDUND is not supported when 3620fdd813deSScott Wood using CONFIG_ENV_OFFSET_OOB. 3621e443c944SMarkus Klotzbuecher 3622b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST 3623b74ab737SGuennadi Liakhovetski 3624b74ab737SGuennadi Liakhovetski Defines address in RAM to which the nand_spl code should copy the 3625b74ab737SGuennadi Liakhovetski environment. If redundant environment is used, it will be copied to 3626b74ab737SGuennadi Liakhovetski CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE. 3627b74ab737SGuennadi Liakhovetski 36282b74433fSJoe Hershberger- CONFIG_ENV_IS_IN_UBI: 36292b74433fSJoe Hershberger 36302b74433fSJoe Hershberger Define this if you have an UBI volume that you want to use for the 36312b74433fSJoe Hershberger environment. This has the benefit of wear-leveling the environment 36322b74433fSJoe Hershberger accesses, which is important on NAND. 36332b74433fSJoe Hershberger 36342b74433fSJoe Hershberger - CONFIG_ENV_UBI_PART: 36352b74433fSJoe Hershberger 36362b74433fSJoe Hershberger Define this to a string that is the mtd partition containing the UBI. 36372b74433fSJoe Hershberger 36382b74433fSJoe Hershberger - CONFIG_ENV_UBI_VOLUME: 36392b74433fSJoe Hershberger 36402b74433fSJoe Hershberger Define this to the name of the volume that you want to store the 36412b74433fSJoe Hershberger environment in. 36422b74433fSJoe Hershberger 3643785881f7SJoe Hershberger - CONFIG_ENV_UBI_VOLUME_REDUND: 3644785881f7SJoe Hershberger 3645785881f7SJoe Hershberger Define this to the name of another volume to store a second copy of 3646785881f7SJoe Hershberger the environment in. This will enable redundant environments in UBI. 3647785881f7SJoe Hershberger It is assumed that both volumes are in the same MTD partition. 3648785881f7SJoe Hershberger 36492b74433fSJoe Hershberger - CONFIG_UBI_SILENCE_MSG 36502b74433fSJoe Hershberger - CONFIG_UBIFS_SILENCE_MSG 36512b74433fSJoe Hershberger 36522b74433fSJoe Hershberger You will probably want to define these to avoid a really noisy system 36532b74433fSJoe Hershberger when storing the env in UBI. 36542b74433fSJoe Hershberger 365506e4ae5fSStephen Warren- CONFIG_ENV_IS_IN_MMC: 365606e4ae5fSStephen Warren 365706e4ae5fSStephen Warren Define this if you have an MMC device which you want to use for the 365806e4ae5fSStephen Warren environment. 365906e4ae5fSStephen Warren 366006e4ae5fSStephen Warren - CONFIG_SYS_MMC_ENV_DEV: 366106e4ae5fSStephen Warren 366206e4ae5fSStephen Warren Specifies which MMC device the environment is stored in. 366306e4ae5fSStephen Warren 366406e4ae5fSStephen Warren - CONFIG_SYS_MMC_ENV_PART (optional): 366506e4ae5fSStephen Warren 366606e4ae5fSStephen Warren Specifies which MMC partition the environment is stored in. If not 366706e4ae5fSStephen Warren set, defaults to partition 0, the user area. Common values might be 366806e4ae5fSStephen Warren 1 (first MMC boot partition), 2 (second MMC boot partition). 366906e4ae5fSStephen Warren 367006e4ae5fSStephen Warren - CONFIG_ENV_OFFSET: 367106e4ae5fSStephen Warren - CONFIG_ENV_SIZE: 367206e4ae5fSStephen Warren 367306e4ae5fSStephen Warren These two #defines specify the offset and size of the environment 367406e4ae5fSStephen Warren area within the specified MMC device. 367506e4ae5fSStephen Warren 36765c088ee8SStephen Warren If offset is positive (the usual case), it is treated as relative to 36775c088ee8SStephen Warren the start of the MMC partition. If offset is negative, it is treated 36785c088ee8SStephen Warren as relative to the end of the MMC partition. This can be useful if 36795c088ee8SStephen Warren your board may be fitted with different MMC devices, which have 36805c088ee8SStephen Warren different sizes for the MMC partitions, and you always want the 36815c088ee8SStephen Warren environment placed at the very end of the partition, to leave the 36825c088ee8SStephen Warren maximum possible space before it, to store other data. 36835c088ee8SStephen Warren 368406e4ae5fSStephen Warren These two values are in units of bytes, but must be aligned to an 368506e4ae5fSStephen Warren MMC sector boundary. 368606e4ae5fSStephen Warren 368706e4ae5fSStephen Warren - CONFIG_ENV_OFFSET_REDUND (optional): 368806e4ae5fSStephen Warren 368906e4ae5fSStephen Warren Specifies a second storage area, of CONFIG_ENV_SIZE size, used to 369006e4ae5fSStephen Warren hold a redundant copy of the environment data. This provides a 369106e4ae5fSStephen Warren valid backup copy in case the other copy is corrupted, e.g. due 369206e4ae5fSStephen Warren to a power failure during a "saveenv" operation. 369306e4ae5fSStephen Warren 36945c088ee8SStephen Warren This value may also be positive or negative; this is handled in the 36955c088ee8SStephen Warren same way as CONFIG_ENV_OFFSET. 36965c088ee8SStephen Warren 369706e4ae5fSStephen Warren This value is also in units of bytes, but must also be aligned to 369806e4ae5fSStephen Warren an MMC sector boundary. 369906e4ae5fSStephen Warren 370006e4ae5fSStephen Warren - CONFIG_ENV_SIZE_REDUND (optional): 370106e4ae5fSStephen Warren 370206e4ae5fSStephen Warren This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is 370306e4ae5fSStephen Warren set. If this value is set, it must be set to the same value as 370406e4ae5fSStephen Warren CONFIG_ENV_SIZE. 370506e4ae5fSStephen Warren 37066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET 3707c609719bSwdenk 3708c609719bSwdenk Defines offset to the initial SPI buffer area in DPRAM. The 3709c609719bSwdenk area is used at an early stage (ROM part) if the environment 3710c609719bSwdenk is configured to reside in the SPI EEPROM: We need a 520 byte 3711c609719bSwdenk scratch DPRAM area. It is used between the two initialization 3712c609719bSwdenk calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems 3713c609719bSwdenk to be a good choice since it makes it far enough from the 3714c609719bSwdenk start of the data area as well as from the stack pointer. 3715c609719bSwdenk 3716e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor 3717c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been 3718cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f() 3719c609719bSwdenkuntil then to read environment variables. 3720c609719bSwdenk 372185ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor 372285ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working 372385ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is 372485ec0bccSwdenknecessary, because the first environment variable we need is the 372585ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't 372685ec0bccSwdenkhave any device yet where we could complain.] 3727c609719bSwdenk 3728c609719bSwdenkNote: once the monitor has been relocated, then it will complain if 3729c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you 373085ec0bccSwdenkuse the "saveenv" command to store a valid environment. 3731c609719bSwdenk 37326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN: 3733fc3e2165Swdenk Echo the inverted Ethernet link state to the fault LED. 3734fc3e2165Swdenk 37356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR 3736fc3e2165Swdenk also needs to be defined. 3737fc3e2165Swdenk 37386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR: 3739fc3e2165Swdenk MII address of the PHY to check for the Ethernet link state. 3740c609719bSwdenk 3741f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS: 3742f5675aa5SRon Madrid Define this if you desire to only have use of the NS16550_init 3743f5675aa5SRon Madrid and NS16550_putc functions for the serial driver located at 3744f5675aa5SRon Madrid drivers/serial/ns16550.c. This option is useful for saving 3745f5675aa5SRon Madrid space for already greatly restricted images, including but not 3746f5675aa5SRon Madrid limited to NAND_SPL configurations. 3747f5675aa5SRon Madrid 3748b2b92f53SSimon Glass- CONFIG_DISPLAY_BOARDINFO 3749b2b92f53SSimon Glass Display information about the board that U-Boot is running on 3750b2b92f53SSimon Glass when U-Boot starts up. The board function checkboard() is called 3751b2b92f53SSimon Glass to do this. 3752b2b92f53SSimon Glass 3753e2e3e2b1SSimon Glass- CONFIG_DISPLAY_BOARDINFO_LATE 3754e2e3e2b1SSimon Glass Similar to the previous option, but display this information 3755e2e3e2b1SSimon Glass later, once stdio is running and output goes to the LCD, if 3756e2e3e2b1SSimon Glass present. 3757e2e3e2b1SSimon Glass 3758c609719bSwdenkLow Level (hardware related) configuration options: 3759dc7c9a1aSwdenk--------------------------------------------------- 3760c609719bSwdenk 37616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE: 3762c609719bSwdenk Cache Line Size of the CPU. 3763c609719bSwdenk 37646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR: 3765c609719bSwdenk Default address of the IMMR after system reset. 37662535d602Swdenk 37672535d602Swdenk Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU, 37682535d602Swdenk and RPXsuper) to be able to adjust the position of 37692535d602Swdenk the IMMR register after a reset. 3770c609719bSwdenk 3771e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT: 3772e46fedfeSTimur Tabi Default (power-on reset) physical address of CCSR on Freescale 3773e46fedfeSTimur Tabi PowerPC SOCs. 3774e46fedfeSTimur Tabi 3775e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR: 3776e46fedfeSTimur Tabi Virtual address of CCSR. On a 32-bit build, this is typically 3777e46fedfeSTimur Tabi the same value as CONFIG_SYS_CCSRBAR_DEFAULT. 3778e46fedfeSTimur Tabi 3779e46fedfeSTimur Tabi CONFIG_SYS_DEFAULT_IMMR must also be set to this value, 3780e46fedfeSTimur Tabi for cross-platform code that uses that macro instead. 3781e46fedfeSTimur Tabi 3782e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS: 3783e46fedfeSTimur Tabi Physical address of CCSR. CCSR can be relocated to a new 3784e46fedfeSTimur Tabi physical address, if desired. In this case, this macro should 3785e46fedfeSTimur Tabi be set to that address. Otherwise, it should be set to the 3786e46fedfeSTimur Tabi same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR 3787e46fedfeSTimur Tabi is typically relocated on 36-bit builds. It is recommended 3788e46fedfeSTimur Tabi that this macro be defined via the _HIGH and _LOW macros: 3789e46fedfeSTimur Tabi 3790e46fedfeSTimur Tabi #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH 3791e46fedfeSTimur Tabi * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW) 3792e46fedfeSTimur Tabi 3793e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH: 3794e46fedfeSTimur Tabi Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically 3795e46fedfeSTimur Tabi either 0 (32-bit build) or 0xF (36-bit build). This macro is 3796e46fedfeSTimur Tabi used in assembly code, so it must not contain typecasts or 3797e46fedfeSTimur Tabi integer size suffixes (e.g. "ULL"). 3798e46fedfeSTimur Tabi 3799e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW: 3800e46fedfeSTimur Tabi Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is 3801e46fedfeSTimur Tabi used in assembly code, so it must not contain typecasts or 3802e46fedfeSTimur Tabi integer size suffixes (e.g. "ULL"). 3803e46fedfeSTimur Tabi 3804e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE: 3805e46fedfeSTimur Tabi If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be 3806e46fedfeSTimur Tabi forced to a value that ensures that CCSR is not relocated. 3807e46fedfeSTimur Tabi 38087f6c2cbcSwdenk- Floppy Disk Support: 38096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FDC_DRIVE_NUMBER 38107f6c2cbcSwdenk 38117f6c2cbcSwdenk the default drive number (default value 0) 38127f6c2cbcSwdenk 38136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_ISA_IO_STRIDE 38147f6c2cbcSwdenk 381511ccc33fSMarcel Ziswiler defines the spacing between FDC chipset registers 38167f6c2cbcSwdenk (default value 1) 38177f6c2cbcSwdenk 38186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_ISA_IO_OFFSET 38197f6c2cbcSwdenk 38207f6c2cbcSwdenk defines the offset of register from address. It 38217f6c2cbcSwdenk depends on which part of the data bus is connected to 382211ccc33fSMarcel Ziswiler the FDC chipset. (default value 0) 38237f6c2cbcSwdenk 38246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and 38256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their 38267f6c2cbcSwdenk default value. 38277f6c2cbcSwdenk 38286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD if CONFIG_SYS_FDC_HW_INIT is defined, then the function 38297f6c2cbcSwdenk fdc_hw_init() is called at the beginning of the FDC 38307f6c2cbcSwdenk setup. fdc_hw_init() must be provided by the board 38317f6c2cbcSwdenk source code. It is used to make hardware dependant 38327f6c2cbcSwdenk initializations. 38337f6c2cbcSwdenk 38340abddf82SMacpaul Lin- CONFIG_IDE_AHB: 38350abddf82SMacpaul Lin Most IDE controllers were designed to be connected with PCI 38360abddf82SMacpaul Lin interface. Only few of them were designed for AHB interface. 38370abddf82SMacpaul Lin When software is doing ATA command and data transfer to 38380abddf82SMacpaul Lin IDE devices through IDE-AHB controller, some additional 38390abddf82SMacpaul Lin registers accessing to these kind of IDE-AHB controller 38400abddf82SMacpaul Lin is requierd. 38410abddf82SMacpaul Lin 38426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR: Physical address of the Internal Memory. 384325d6712aSwdenk DO NOT CHANGE unless you know exactly what you're 384425d6712aSwdenk doing! (11-4) [MPC8xx/82xx systems only] 3845c609719bSwdenk 38466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR: 3847c609719bSwdenk 38487152b1d0Swdenk Start address of memory area that can be used for 3849c609719bSwdenk initial data and stack; please note that this must be 3850c609719bSwdenk writable memory that is working WITHOUT special 3851c609719bSwdenk initialization, i. e. you CANNOT use normal RAM which 3852c609719bSwdenk will become available only after programming the 3853c609719bSwdenk memory controller and running certain initialization 3854c609719bSwdenk sequences. 3855c609719bSwdenk 3856c609719bSwdenk U-Boot uses the following memory types: 3857c609719bSwdenk - MPC8xx and MPC8260: IMMR (internal memory of the CPU) 3858c609719bSwdenk - MPC824X: data cache 3859c609719bSwdenk - PPC4xx: data cache 3860c609719bSwdenk 38616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET: 3862c609719bSwdenk 3863c609719bSwdenk Offset of the initial data structure in the memory 38646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually 38656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial 3866c609719bSwdenk data is located at the end of the available space 3867553f0982SWolfgang Denk (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE - 38686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just 38696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR + 38706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_GBL_DATA_OFFSET) downward. 3871c609719bSwdenk 3872c609719bSwdenk Note: 3873c609719bSwdenk On the MPC824X (or other systems that use the data 3874c609719bSwdenk cache for initial memory) the address chosen for 38756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must 3876c609719bSwdenk point to an otherwise UNUSED address space between 3877c609719bSwdenk the top of RAM and the start of the PCI space. 3878c609719bSwdenk 38796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6) 3880c609719bSwdenk 38816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR: System Protection Control (11-9) 3882c609719bSwdenk 38836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26) 3884c609719bSwdenk 38856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31) 3886c609719bSwdenk 38876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30) 3888c609719bSwdenk 38896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27) 3890c609719bSwdenk 38916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM: 3892c609719bSwdenk SDRAM timing 3893c609719bSwdenk 38946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA: 3895c609719bSwdenk periodic timer for refresh 3896c609719bSwdenk 38976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER: Debug Event Register (37-47) 3898c609719bSwdenk 38996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM, 39006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP, 39016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM, 39026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BR1_PRELIM: 3903c609719bSwdenk Memory Controller Definitions: BR0/1 and OR0/1 (FLASH) 3904c609719bSwdenk 3905c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE, 39066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM, 39076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM: 3908c609719bSwdenk Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM) 3909c609719bSwdenk 39106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K, 39116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL: 3912c609719bSwdenk Machine Mode Register and Memory Periodic Timer 3913c609719bSwdenk Prescaler definitions (SDRAM timing) 3914c609719bSwdenk 39156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]: 3916c609719bSwdenk enable I2C microcode relocation patch (MPC8xx); 3917c609719bSwdenk define relocation offset in DPRAM [DSP2] 3918c609719bSwdenk 39196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]: 3920b423d055SHeiko Schocher enable SMC microcode relocation patch (MPC8xx); 3921b423d055SHeiko Schocher define relocation offset in DPRAM [SMC1] 3922b423d055SHeiko Schocher 39236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]: 3924c609719bSwdenk enable SPI microcode relocation patch (MPC8xx); 3925c609719bSwdenk define relocation offset in DPRAM [SCC4] 3926c609719bSwdenk 39276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK: 3928c609719bSwdenk Use OSCM clock mode on MBX8xx board. Be careful, 3929c609719bSwdenk wrong setting might damage your board. Read 3930c609719bSwdenk doc/README.MBX before setting this variable! 3931c609719bSwdenk 39326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only) 3933ea909b76Swdenk Offset of the bootmode word in DPRAM used by post 3934ea909b76Swdenk (Power On Self Tests). This definition overrides 3935ea909b76Swdenk #define'd default value in commproc.h resp. 3936ea909b76Swdenk cpm_8260.h. 3937ea909b76Swdenk 39386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB, 39396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL, 39406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS, 39416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB, 39426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START, 39436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL, 39446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE, 39456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only) 3946a47a12beSStefan Roese Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set. 39475d232d0eSwdenk 39489cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE: 39499cacf4fcSDirk Eibach Disable PCI-Express on systems where it is supported but not 39509cacf4fcSDirk Eibach required. 39519cacf4fcSDirk Eibach 395269fd2d3bSAndrew Sharp- CONFIG_PCI_ENUM_ONLY 395369fd2d3bSAndrew Sharp Only scan through and get the devices on the busses. 395469fd2d3bSAndrew Sharp Don't do any setup work, presumably because someone or 395569fd2d3bSAndrew Sharp something has already done it, and we don't need to do it 395669fd2d3bSAndrew Sharp a second time. Useful for platforms that are pre-booted 395769fd2d3bSAndrew Sharp by coreboot or similar. 395869fd2d3bSAndrew Sharp 3959842033e6SGabor Juhos- CONFIG_PCI_INDIRECT_BRIDGE: 3960842033e6SGabor Juhos Enable support for indirect PCI bridges. 3961842033e6SGabor Juhos 3962a09b9b68SKumar Gala- CONFIG_SYS_SRIO: 3963a09b9b68SKumar Gala Chip has SRIO or not 3964a09b9b68SKumar Gala 3965a09b9b68SKumar Gala- CONFIG_SRIO1: 3966a09b9b68SKumar Gala Board has SRIO 1 port available 3967a09b9b68SKumar Gala 3968a09b9b68SKumar Gala- CONFIG_SRIO2: 3969a09b9b68SKumar Gala Board has SRIO 2 port available 3970a09b9b68SKumar Gala 3971a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT: 3972a09b9b68SKumar Gala Virtual Address of SRIO port 'n' memory region 3973a09b9b68SKumar Gala 3974a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS: 3975a09b9b68SKumar Gala Physical Address of SRIO port 'n' memory region 3976a09b9b68SKumar Gala 3977a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE: 3978a09b9b68SKumar Gala Size of SRIO port 'n' memory region 3979a09b9b68SKumar Gala 398066bd1846SFabio Estevam- CONFIG_SYS_NAND_BUSWIDTH_16BIT 398166bd1846SFabio Estevam Defined to tell the NAND controller that the NAND chip is using 398266bd1846SFabio Estevam a 16 bit bus. 398366bd1846SFabio Estevam Not all NAND drivers use this symbol. 3984a430e916SFabio Estevam Example of drivers that use it: 398566bd1846SFabio Estevam - drivers/mtd/nand/ndfc.c 3986a430e916SFabio Estevam - drivers/mtd/nand/mxc_nand.c 3987eced4626SAlex Waterman 3988eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG 3989eced4626SAlex Waterman Sets the EBC0_CFG register for the NDFC. If not defined 3990eced4626SAlex Waterman a default value will be used. 3991eced4626SAlex Waterman 3992bb99ad6dSBen Warren- CONFIG_SPD_EEPROM 3993218ca724SWolfgang Denk Get DDR timing information from an I2C EEPROM. Common 3994218ca724SWolfgang Denk with pluggable memory modules such as SODIMMs 3995218ca724SWolfgang Denk 3996bb99ad6dSBen Warren SPD_EEPROM_ADDRESS 3997bb99ad6dSBen Warren I2C address of the SPD EEPROM 3998bb99ad6dSBen Warren 39996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM 4000218ca724SWolfgang Denk If SPD EEPROM is on an I2C bus other than the first 4001218ca724SWolfgang Denk one, specify here. Note that the value must resolve 4002218ca724SWolfgang Denk to something your driver can deal with. 4003bb99ad6dSBen Warren 40041b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING 40051b3e3c4fSYork Sun Get DDR timing information from other than SPD. Common with 40061b3e3c4fSYork Sun soldered DDR chips onboard without SPD. DDR raw timing 40071b3e3c4fSYork Sun parameters are extracted from datasheet and hard-coded into 40081b3e3c4fSYork Sun header files or board specific files. 40091b3e3c4fSYork Sun 40106f5e1dc5SYork Sun- CONFIG_FSL_DDR_INTERACTIVE 40116f5e1dc5SYork Sun Enable interactive DDR debugging. See doc/README.fsl-ddr. 40126f5e1dc5SYork Sun 40136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0 4014218ca724SWolfgang Denk Only for 83xx systems. If specified, then DDR should 4015218ca724SWolfgang Denk be configured using CS0 and CS1 instead of CS2 and CS3. 40162ad6b513STimur Tabi 4017c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12] 4018c26e454dSwdenk Define to enable FEC[12] on a 8xx series processor. 4019c26e454dSwdenk 4020c26e454dSwdenk- CONFIG_FEC[12]_PHY 4021c26e454dSwdenk Define to the hardcoded PHY address which corresponds 40226e592385Swdenk to the given FEC; i. e. 4023c26e454dSwdenk #define CONFIG_FEC1_PHY 4 4024c26e454dSwdenk means that the PHY with address 4 is connected to FEC1 4025c26e454dSwdenk 4026c26e454dSwdenk When set to -1, means to probe for first available. 4027c26e454dSwdenk 4028c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR 4029c26e454dSwdenk The PHY does not have a RXERR line (RMII only). 4030c26e454dSwdenk (so program the FEC to ignore it). 4031c26e454dSwdenk 4032c26e454dSwdenk- CONFIG_RMII 4033c26e454dSwdenk Enable RMII mode for all FECs. 4034c26e454dSwdenk Note that this is a global option, we can't 4035c26e454dSwdenk have one FEC in standard MII mode and another in RMII mode. 4036c26e454dSwdenk 40375cf91d6bSwdenk- CONFIG_CRC32_VERIFY 40385cf91d6bSwdenk Add a verify option to the crc32 command. 40395cf91d6bSwdenk The syntax is: 40405cf91d6bSwdenk 40415cf91d6bSwdenk => crc32 -v <address> <count> <crc32> 40425cf91d6bSwdenk 40435cf91d6bSwdenk Where address/count indicate a memory area 40445cf91d6bSwdenk and crc32 is the correct crc32 which the 40455cf91d6bSwdenk area should have. 40465cf91d6bSwdenk 404756523f12Swdenk- CONFIG_LOOPW 404856523f12Swdenk Add the "loopw" memory command. This only takes effect if 4049602ad3b3SJon Loeliger the memory commands are activated globally (CONFIG_CMD_MEM). 405056523f12Swdenk 40517b466641Sstroese- CONFIG_MX_CYCLIC 40527b466641Sstroese Add the "mdc" and "mwc" memory commands. These are cyclic 40537b466641Sstroese "md/mw" commands. 40547b466641Sstroese Examples: 40557b466641Sstroese 40567b466641Sstroese => mdc.b 10 4 500 40577b466641Sstroese This command will print 4 bytes (10,11,12,13) each 500 ms. 40587b466641Sstroese 40597b466641Sstroese => mwc.l 100 12345678 10 40607b466641Sstroese This command will write 12345678 to address 100 all 10 ms. 40617b466641Sstroese 40627b466641Sstroese This only takes effect if the memory commands are activated 4063602ad3b3SJon Loeliger globally (CONFIG_CMD_MEM). 40647b466641Sstroese 40658aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT 4066afc1ce82SMacpaul Lin [ARM, NDS32, MIPS only] If this variable is defined, then certain 4067e03f3169SWolfgang Denk low level initializations (like setting up the memory 4068e03f3169SWolfgang Denk controller) are omitted and/or U-Boot does not 4069e03f3169SWolfgang Denk relocate itself into RAM. 40708aa1a2d1Swdenk 4071e03f3169SWolfgang Denk Normally this variable MUST NOT be defined. The only 4072e03f3169SWolfgang Denk exception is when U-Boot is loaded (to RAM) by some 4073e03f3169SWolfgang Denk other boot loader or by a debugger which performs 4074e03f3169SWolfgang Denk these initializations itself. 40758aa1a2d1Swdenk 4076401bb30bSAneesh V- CONFIG_SPL_BUILD 4077df81238bSMagnus Lilja Modifies the behaviour of start.S when compiling a loader 4078df81238bSMagnus Lilja that is executed before the actual U-Boot. E.g. when 4079df81238bSMagnus Lilja compiling a NAND SPL. 4080400558b5Swdenk 40814213fc29SSimon Glass- CONFIG_ARCH_MAP_SYSMEM 40824213fc29SSimon Glass Generally U-Boot (and in particular the md command) uses 40834213fc29SSimon Glass effective address. It is therefore not necessary to regard 40844213fc29SSimon Glass U-Boot address as virtual addresses that need to be translated 40854213fc29SSimon Glass to physical addresses. However, sandbox requires this, since 40864213fc29SSimon Glass it maintains its own little RAM buffer which contains all 40874213fc29SSimon Glass addressable memory. This option causes some memory accesses 40884213fc29SSimon Glass to be mapped through map_sysmem() / unmap_sysmem(). 40894213fc29SSimon Glass 4090d8834a13SMatthias Weisser- CONFIG_USE_ARCH_MEMCPY 4091d8834a13SMatthias Weisser CONFIG_USE_ARCH_MEMSET 4092d8834a13SMatthias Weisser If these options are used a optimized version of memcpy/memset will 4093d8834a13SMatthias Weisser be used if available. These functions may be faster under some 4094d8834a13SMatthias Weisser conditions but may increase the binary size. 4095d8834a13SMatthias Weisser 4096588a13f7SSimon Glass- CONFIG_X86_RESET_VECTOR 4097588a13f7SSimon Glass If defined, the x86 reset vector code is included. This is not 4098588a13f7SSimon Glass needed when U-Boot is running from Coreboot. 4099b16f521aSGabe Black 4100fc33705eSMark Jackson- CONFIG_SYS_MPUCLK 4101fc33705eSMark Jackson Defines the MPU clock speed (in MHz). 4102fc33705eSMark Jackson 4103fc33705eSMark Jackson NOTE : currently only supported on AM335x platforms. 41045b5ece9eSGabe Black 4105f2717b47STimur TabiFreescale QE/FMAN Firmware Support: 4106f2717b47STimur Tabi----------------------------------- 4107f2717b47STimur Tabi 4108f2717b47STimur TabiThe Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the 4109f2717b47STimur Tabiloading of "firmware", which is encoded in the QE firmware binary format. 4110f2717b47STimur TabiThis firmware often needs to be loaded during U-Boot booting, so macros 4111f2717b47STimur Tabiare used to identify the storage device (NOR flash, SPI, etc) and the address 4112f2717b47STimur Tabiwithin that device. 4113f2717b47STimur Tabi 4114f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_ADDR 4115f2717b47STimur Tabi The address in the storage device where the firmware is located. The 4116f2717b47STimur Tabi meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro 4117f2717b47STimur Tabi is also specified. 4118f2717b47STimur Tabi 4119f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_LENGTH 4120f2717b47STimur Tabi The maximum possible size of the firmware. The firmware binary format 4121f2717b47STimur Tabi has a field that specifies the actual size of the firmware, but it 4122f2717b47STimur Tabi might not be possible to read any part of the firmware unless some 4123f2717b47STimur Tabi local storage is allocated to hold the entire firmware first. 4124f2717b47STimur Tabi 4125f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NOR 4126f2717b47STimur Tabi Specifies that QE/FMAN firmware is located in NOR flash, mapped as 4127f2717b47STimur Tabi normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the 4128f2717b47STimur Tabi virtual address in NOR flash. 4129f2717b47STimur Tabi 4130f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NAND 4131f2717b47STimur Tabi Specifies that QE/FMAN firmware is located in NAND flash. 4132f2717b47STimur Tabi CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash. 4133f2717b47STimur Tabi 4134f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_MMC 4135f2717b47STimur Tabi Specifies that QE/FMAN firmware is located on the primary SD/MMC 4136f2717b47STimur Tabi device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device. 4137f2717b47STimur Tabi 4138f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH 4139f2717b47STimur Tabi Specifies that QE/FMAN firmware is located on the primary SPI 4140f2717b47STimur Tabi device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device. 4141f2717b47STimur Tabi 4142292dc6c5SLiu Gang- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE 4143292dc6c5SLiu Gang Specifies that QE/FMAN firmware is located in the remote (master) 4144292dc6c5SLiu Gang memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which 4145fc54c7faSLiu Gang can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound 4146fc54c7faSLiu Gang window->master inbound window->master LAW->the ucode address in 4147fc54c7faSLiu Gang master's memory space. 4148f2717b47STimur Tabi 4149c609719bSwdenkBuilding the Software: 4150c609719bSwdenk====================== 4151c609719bSwdenk 4152218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments 4153218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support 4154218ca724SWolfgang Denkall possibly existing versions of cross development tools in all 4155218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we 4156218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK) 4157218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot. 4158c609719bSwdenk 4159218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you 4160218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case, 4161218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell. 4162218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are 4163218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter: 4164c609719bSwdenk 4165218ca724SWolfgang Denk $ CROSS_COMPILE=ppc_4xx- 4166218ca724SWolfgang Denk $ export CROSS_COMPILE 4167c609719bSwdenk 41682f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in 41692f8d396bSPeter Tyser the tools directory you can use the MinGW toolchain 41702f8d396bSPeter Tyser (http://www.mingw.org). Set your HOST tools to the MinGW 41712f8d396bSPeter Tyser toolchain and execute 'make tools'. For example: 41722f8d396bSPeter Tyser 41732f8d396bSPeter Tyser $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools 41742f8d396bSPeter Tyser 41752f8d396bSPeter Tyser Binaries such as tools/mkimage.exe will be created which can 41762f8d396bSPeter Tyser be executed on computers running Windows. 41772f8d396bSPeter Tyser 4178c609719bSwdenkU-Boot is intended to be simple to build. After installing the 4179c609719bSwdenksources you must configure U-Boot for one specific board type. This 4180c609719bSwdenkis done by typing: 4181c609719bSwdenk 4182c609719bSwdenk make NAME_config 4183c609719bSwdenk 4184218ca724SWolfgang Denkwhere "NAME_config" is the name of one of the existing configu- 41854d675ae6SMichael Jonesrations; see boards.cfg for supported names. 418654387ac9Swdenk 4187c609719bSwdenkNote: for some board special configuration names may exist; check if 4188c609719bSwdenk additional information is available from the board vendor; for 41892729af9dSwdenk instance, the TQM823L systems are available without (standard) 41902729af9dSwdenk or with LCD support. You can select such additional "features" 419111ccc33fSMarcel Ziswiler when choosing the configuration, i. e. 4192c609719bSwdenk 41932729af9dSwdenk make TQM823L_config 41942729af9dSwdenk - will configure for a plain TQM823L, i. e. no LCD support 4195c609719bSwdenk 4196c609719bSwdenk make TQM823L_LCD_config 4197c609719bSwdenk - will configure for a TQM823L with U-Boot console on LCD 4198c609719bSwdenk 4199c609719bSwdenk etc. 4200c609719bSwdenk 4201c609719bSwdenk 4202c609719bSwdenkFinally, type "make all", and you should get some working U-Boot 42037152b1d0Swdenkimages ready for download to / installation on your system: 4204c609719bSwdenk 4205c609719bSwdenk- "u-boot.bin" is a raw binary image 4206c609719bSwdenk- "u-boot" is an image in ELF binary format 4207c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format 4208c609719bSwdenk 4209baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved 4210baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change 4211baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory: 4212baf31249SMarian Balakowicz 4213baf31249SMarian Balakowicz1. Add O= to the make command line invocations: 4214baf31249SMarian Balakowicz 4215baf31249SMarian Balakowicz make O=/tmp/build distclean 4216baf31249SMarian Balakowicz make O=/tmp/build NAME_config 4217baf31249SMarian Balakowicz make O=/tmp/build all 4218baf31249SMarian Balakowicz 4219baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location: 4220baf31249SMarian Balakowicz 4221baf31249SMarian Balakowicz export BUILD_DIR=/tmp/build 4222baf31249SMarian Balakowicz make distclean 4223baf31249SMarian Balakowicz make NAME_config 4224baf31249SMarian Balakowicz make all 4225baf31249SMarian Balakowicz 4226baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment 4227baf31249SMarian Balakowiczvariable. 4228baf31249SMarian Balakowicz 4229c609719bSwdenk 4230c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so 4231c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of 4232c609719bSwdenknative "make". 4233c609719bSwdenk 4234c609719bSwdenk 4235c609719bSwdenkIf the system board that you have is not listed, then you will need 4236c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these 4237c609719bSwdenksteps: 4238c609719bSwdenk 4239c609719bSwdenk1. Add a new configuration option for your board to the toplevel 42404d675ae6SMichael Jones "boards.cfg" file, using the existing entries as examples. 42414d675ae6SMichael Jones Follow the instructions there to keep the boards in order. 4242c609719bSwdenk2. Create a new directory to hold your board specific code. Add any 424385ec0bccSwdenk files you need. In your board directory, you will need at least 424485ec0bccSwdenk the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds". 424585ec0bccSwdenk3. Create a new configuration file "include/configs/<board>.h" for 424685ec0bccSwdenk your board 4247c609719bSwdenk3. If you're porting U-Boot to a new CPU, then also create a new 4248c609719bSwdenk directory to hold your CPU specific code. Add any files you need. 424985ec0bccSwdenk4. Run "make <board>_config" with your new name. 4250c609719bSwdenk5. Type "make", and you should get a working "u-boot.srec" file 4251c609719bSwdenk to be installed on your target system. 425285ec0bccSwdenk6. Debug and solve any problems that might arise. 4253c609719bSwdenk [Of course, this last step is much harder than it sounds.] 4254c609719bSwdenk 4255c609719bSwdenk 4256c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.: 4257c609719bSwdenk============================================================== 4258c609719bSwdenk 4259c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board 4260c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to 4261c609719bSwdenkprovide feedback to the other developers. The feedback normally takes 4262c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest 4263218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources. 4264c609719bSwdenk 4265c609719bSwdenkBut before you submit such a patch, please verify that your modifi- 4266c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of 4267c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so, 4268c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot 4269c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can 42707152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE' 4271218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools 4272218ca724SWolfgang Denkyou can type 4273c609719bSwdenk 4274c609719bSwdenk CROSS_COMPILE=ppc_8xx- MAKEALL 4275c609719bSwdenk 4276c609719bSwdenkor to build on a native PowerPC system you can type 4277c609719bSwdenk 4278c609719bSwdenk CROSS_COMPILE=' ' MAKEALL 4279c609719bSwdenk 4280218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build 4281218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by 4282218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target 4283218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and 4284218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default 4285218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment 4286218ca724SWolfgang Denkvariable. For example: 4287baf31249SMarian Balakowicz 4288baf31249SMarian Balakowicz export BUILD_DIR=/tmp/build 4289baf31249SMarian Balakowicz export MAKEALL_LOGDIR=/tmp/log 4290baf31249SMarian Balakowicz CROSS_COMPILE=ppc_8xx- MAKEALL 4291baf31249SMarian Balakowicz 4292218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build, 4293218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean 4294218ca724SWolfgang Denkduring the whole build process. 4295baf31249SMarian Balakowicz 4296baf31249SMarian Balakowicz 4297c609719bSwdenkSee also "U-Boot Porting Guide" below. 4298c609719bSwdenk 4299c609719bSwdenk 4300c609719bSwdenkMonitor Commands - Overview: 4301c609719bSwdenk============================ 4302c609719bSwdenk 4303c609719bSwdenkgo - start application at address 'addr' 4304c609719bSwdenkrun - run commands in an environment variable 4305c609719bSwdenkbootm - boot application image from memory 4306c609719bSwdenkbootp - boot image via network using BootP/TFTP protocol 430744f074c7SMarek Vasutbootz - boot zImage from memory 4308c609719bSwdenktftpboot- boot image via network using TFTP protocol 4309c609719bSwdenk and env variables "ipaddr" and "serverip" 4310c609719bSwdenk (and eventually "gatewayip") 43111fb7cd49SSimon Glasstftpput - upload a file via network using TFTP protocol 4312c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol 4313c609719bSwdenkdiskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd' 4314c609719bSwdenkloads - load S-Record file over serial line 4315c609719bSwdenkloadb - load binary file over serial line (kermit mode) 4316c609719bSwdenkmd - memory display 4317c609719bSwdenkmm - memory modify (auto-incrementing) 4318c609719bSwdenknm - memory modify (constant address) 4319c609719bSwdenkmw - memory write (fill) 4320c609719bSwdenkcp - memory copy 4321c609719bSwdenkcmp - memory compare 4322c609719bSwdenkcrc32 - checksum calculation 43230f89c54bSPeter Tyseri2c - I2C sub-system 4324c609719bSwdenksspi - SPI utility commands 4325c609719bSwdenkbase - print or set address offset 4326c609719bSwdenkprintenv- print environment variables 4327c609719bSwdenksetenv - set environment variables 4328c609719bSwdenksaveenv - save environment variables to persistent storage 4329c609719bSwdenkprotect - enable or disable FLASH write protection 4330c609719bSwdenkerase - erase FLASH memory 4331c609719bSwdenkflinfo - print FLASH memory information 433210635afaSKarl O. Pincnand - NAND memory operations (see doc/README.nand) 4333c609719bSwdenkbdinfo - print Board Info structure 4334c609719bSwdenkiminfo - print header information for application image 4335c609719bSwdenkconinfo - print console devices and informations 4336c609719bSwdenkide - IDE sub-system 4337c609719bSwdenkloop - infinite loop on address range 433856523f12Swdenkloopw - infinite write loop on address range 4339c609719bSwdenkmtest - simple RAM test 4340c609719bSwdenkicache - enable or disable instruction cache 4341c609719bSwdenkdcache - enable or disable data cache 4342c609719bSwdenkreset - Perform RESET of the CPU 4343c609719bSwdenkecho - echo args to console 4344c609719bSwdenkversion - print monitor version 4345c609719bSwdenkhelp - print online help 4346c609719bSwdenk? - alias for 'help' 4347c609719bSwdenk 4348c609719bSwdenk 4349c609719bSwdenkMonitor Commands - Detailed Description: 4350c609719bSwdenk======================================== 4351c609719bSwdenk 4352c609719bSwdenkTODO. 4353c609719bSwdenk 4354c609719bSwdenkFor now: just type "help <command>". 4355c609719bSwdenk 4356c609719bSwdenk 4357c609719bSwdenkEnvironment Variables: 4358c609719bSwdenk====================== 4359c609719bSwdenk 4360c609719bSwdenkU-Boot supports user configuration using Environment Variables which 4361c609719bSwdenkcan be made persistent by saving to Flash memory. 4362c609719bSwdenk 4363c609719bSwdenkEnvironment Variables are set using "setenv", printed using 4364c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv" 4365c609719bSwdenkwithout a value can be used to delete a variable from the 4366c609719bSwdenkenvironment. As long as you don't save the environment you are 4367c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the 4368c609719bSwdenkenvironment is erased by accident, a default environment is provided. 4369c609719bSwdenk 4370c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables. 4371c96f86eeSWolfgang Denk 4372c96f86eeSWolfgang DenkList of environment variables (most likely not complete): 4373c609719bSwdenk 4374c609719bSwdenk baudrate - see CONFIG_BAUDRATE 4375c609719bSwdenk 4376c609719bSwdenk bootdelay - see CONFIG_BOOTDELAY 4377c609719bSwdenk 4378c609719bSwdenk bootcmd - see CONFIG_BOOTCOMMAND 4379c609719bSwdenk 4380c609719bSwdenk bootargs - Boot arguments when booting an RTOS image 4381c609719bSwdenk 4382c609719bSwdenk bootfile - Name of the image to load with TFTP 4383c609719bSwdenk 43847d721e34SBartlomiej Sieka bootm_low - Memory range available for image processing in the bootm 43857d721e34SBartlomiej Sieka command can be restricted. This variable is given as 43867d721e34SBartlomiej Sieka a hexadecimal number and defines lowest address allowed 43877d721e34SBartlomiej Sieka for use by the bootm command. See also "bootm_size" 43887d721e34SBartlomiej Sieka environment variable. Address defined by "bootm_low" is 43897d721e34SBartlomiej Sieka also the base of the initial memory mapping for the Linux 4390c3624e6eSGrant Likely kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and 4391c3624e6eSGrant Likely bootm_mapsize. 4392c3624e6eSGrant Likely 4393c3624e6eSGrant Likely bootm_mapsize - Size of the initial memory mapping for the Linux kernel. 4394c3624e6eSGrant Likely This variable is given as a hexadecimal number and it 4395c3624e6eSGrant Likely defines the size of the memory region starting at base 4396c3624e6eSGrant Likely address bootm_low that is accessible by the Linux kernel 4397c3624e6eSGrant Likely during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used 4398c3624e6eSGrant Likely as the default value if it is defined, and bootm_size is 4399c3624e6eSGrant Likely used otherwise. 44007d721e34SBartlomiej Sieka 44017d721e34SBartlomiej Sieka bootm_size - Memory range available for image processing in the bootm 44027d721e34SBartlomiej Sieka command can be restricted. This variable is given as 44037d721e34SBartlomiej Sieka a hexadecimal number and defines the size of the region 44047d721e34SBartlomiej Sieka allowed for use by the bootm command. See also "bootm_low" 44057d721e34SBartlomiej Sieka environment variable. 44067d721e34SBartlomiej Sieka 44074bae9090SBartlomiej Sieka updatefile - Location of the software update file on a TFTP server, used 44084bae9090SBartlomiej Sieka by the automatic software update feature. Please refer to 44094bae9090SBartlomiej Sieka documentation in doc/README.update for more details. 44104bae9090SBartlomiej Sieka 4411c609719bSwdenk autoload - if set to "no" (any string beginning with 'n'), 4412c609719bSwdenk "bootp" will just load perform a lookup of the 4413c609719bSwdenk configuration from the BOOTP server, but not try to 4414c609719bSwdenk load any image using TFTP 4415c609719bSwdenk 4416c609719bSwdenk autostart - if set to "yes", an image loaded using the "bootp", 4417c609719bSwdenk "rarpboot", "tftpboot" or "diskboot" commands will 4418c609719bSwdenk be automatically started (by internally calling 4419c609719bSwdenk "bootm") 4420c609719bSwdenk 44214a6fd34bSwdenk If set to "no", a standalone image passed to the 44224a6fd34bSwdenk "bootm" command will be copied to the load address 44234a6fd34bSwdenk (and eventually uncompressed), but NOT be started. 44244a6fd34bSwdenk This can be used to load and uncompress arbitrary 44254a6fd34bSwdenk data. 44264a6fd34bSwdenk 4427a28afca5SDavid A. Long fdt_high - if set this restricts the maximum address that the 4428a28afca5SDavid A. Long flattened device tree will be copied into upon boot. 4429fa34f6b2SShawn Guo For example, if you have a system with 1 GB memory 4430fa34f6b2SShawn Guo at physical address 0x10000000, while Linux kernel 4431fa34f6b2SShawn Guo only recognizes the first 704 MB as low memory, you 4432fa34f6b2SShawn Guo may need to set fdt_high as 0x3C000000 to have the 4433fa34f6b2SShawn Guo device tree blob be copied to the maximum address 4434fa34f6b2SShawn Guo of the 704 MB low memory, so that Linux kernel can 4435fa34f6b2SShawn Guo access it during the boot procedure. 4436fa34f6b2SShawn Guo 4437a28afca5SDavid A. Long If this is set to the special value 0xFFFFFFFF then 4438a28afca5SDavid A. Long the fdt will not be copied at all on boot. For this 4439a28afca5SDavid A. Long to work it must reside in writable memory, have 4440a28afca5SDavid A. Long sufficient padding on the end of it for u-boot to 4441a28afca5SDavid A. Long add the information it needs into it, and the memory 4442a28afca5SDavid A. Long must be accessible by the kernel. 4443a28afca5SDavid A. Long 4444eea63e05SSimon Glass fdtcontroladdr- if set this is the address of the control flattened 4445eea63e05SSimon Glass device tree used by U-Boot when CONFIG_OF_CONTROL is 4446eea63e05SSimon Glass defined. 4447eea63e05SSimon Glass 444817ea1177Swdenk i2cfast - (PPC405GP|PPC405EP only) 444917ea1177Swdenk if set to 'y' configures Linux I2C driver for fast 445017ea1177Swdenk mode (400kHZ). This environment variable is used in 445117ea1177Swdenk initialization code. So, for changes to be effective 445217ea1177Swdenk it must be saved and board must be reset. 445317ea1177Swdenk 4454c609719bSwdenk initrd_high - restrict positioning of initrd images: 4455c609719bSwdenk If this variable is not set, initrd images will be 4456c609719bSwdenk copied to the highest possible address in RAM; this 4457c609719bSwdenk is usually what you want since it allows for 4458c609719bSwdenk maximum initrd size. If for some reason you want to 4459c609719bSwdenk make sure that the initrd image is loaded below the 44606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BOOTMAPSZ limit, you can set this environment 4461c609719bSwdenk variable to a value of "no" or "off" or "0". 4462c609719bSwdenk Alternatively, you can set it to a maximum upper 4463c609719bSwdenk address to use (U-Boot will still check that it 4464c609719bSwdenk does not overwrite the U-Boot stack and data). 4465c609719bSwdenk 4466c609719bSwdenk For instance, when you have a system with 16 MB 44677152b1d0Swdenk RAM, and want to reserve 4 MB from use by Linux, 4468c609719bSwdenk you can do this by adding "mem=12M" to the value of 4469c609719bSwdenk the "bootargs" variable. However, now you must make 44707152b1d0Swdenk sure that the initrd image is placed in the first 4471c609719bSwdenk 12 MB as well - this can be done with 4472c609719bSwdenk 4473c609719bSwdenk setenv initrd_high 00c00000 4474c609719bSwdenk 447538b99261Swdenk If you set initrd_high to 0xFFFFFFFF, this is an 447638b99261Swdenk indication to U-Boot that all addresses are legal 447738b99261Swdenk for the Linux kernel, including addresses in flash 447838b99261Swdenk memory. In this case U-Boot will NOT COPY the 447938b99261Swdenk ramdisk at all. This may be useful to reduce the 448038b99261Swdenk boot time on your system, but requires that this 448138b99261Swdenk feature is supported by your Linux kernel. 448238b99261Swdenk 4483c609719bSwdenk ipaddr - IP address; needed for tftpboot command 4484c609719bSwdenk 4485c609719bSwdenk loadaddr - Default load address for commands like "bootp", 4486dc7c9a1aSwdenk "rarpboot", "tftpboot", "loadb" or "diskboot" 4487c609719bSwdenk 4488c609719bSwdenk loads_echo - see CONFIG_LOADS_ECHO 4489c609719bSwdenk 4490c609719bSwdenk serverip - TFTP server IP address; needed for tftpboot command 4491c609719bSwdenk 4492c609719bSwdenk bootretry - see CONFIG_BOOT_RETRY_TIME 4493c609719bSwdenk 4494c609719bSwdenk bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR 4495c609719bSwdenk 4496c609719bSwdenk bootstopkey - see CONFIG_AUTOBOOT_STOP_STR 4497c609719bSwdenk 4498e2a53458SMike Frysinger ethprime - controls which interface is used first. 4499a3d991bdSwdenk 4500e2a53458SMike Frysinger ethact - controls which interface is currently active. 4501e2a53458SMike Frysinger For example you can do the following 4502a3d991bdSwdenk 450348690d80SHeiko Schocher => setenv ethact FEC 450448690d80SHeiko Schocher => ping 192.168.0.1 # traffic sent on FEC 450548690d80SHeiko Schocher => setenv ethact SCC 450648690d80SHeiko Schocher => ping 10.0.0.1 # traffic sent on SCC 4507a3d991bdSwdenk 4508e1692577SMatthias Fuchs ethrotate - When set to "no" U-Boot does not go through all 4509e1692577SMatthias Fuchs available network interfaces. 4510e1692577SMatthias Fuchs It just stays at the currently selected interface. 4511e1692577SMatthias Fuchs 4512a3d991bdSwdenk netretry - When set to "no" each network operation will 4513a3d991bdSwdenk either succeed or fail without retrying. 45146e592385Swdenk When set to "once" the network operation will 45156e592385Swdenk fail when all the available network interfaces 45166e592385Swdenk are tried once without success. 4517a3d991bdSwdenk Useful on scripts which control the retry operation 4518a3d991bdSwdenk themselves. 4519a3d991bdSwdenk 4520b4e2f89dSJean-Christophe PLAGNIOL-VILLARD npe_ucode - set load address for the NPE microcode 4521a1cf027aSJean-Christophe PLAGNIOL-VILLARD 452228cb9375SWolfgang Denk tftpsrcport - If this is set, the value is used for TFTP's 4523ecb0ccd9SWolfgang Denk UDP source port. 4524ecb0ccd9SWolfgang Denk 452528cb9375SWolfgang Denk tftpdstport - If this is set, the value is used for TFTP's UDP 452628cb9375SWolfgang Denk destination port instead of the Well Know Port 69. 452728cb9375SWolfgang Denk 4528c96f86eeSWolfgang Denk tftpblocksize - Block size to use for TFTP transfers; if not set, 4529c96f86eeSWolfgang Denk we use the TFTP server's default block size 4530c96f86eeSWolfgang Denk 4531c96f86eeSWolfgang Denk tftptimeout - Retransmission timeout for TFTP packets (in milli- 4532c96f86eeSWolfgang Denk seconds, minimum value is 1000 = 1 second). Defines 4533c96f86eeSWolfgang Denk when a packet is considered to be lost so it has to 4534c96f86eeSWolfgang Denk be retransmitted. The default is 5000 = 5 seconds. 4535c96f86eeSWolfgang Denk Lowering this value may make downloads succeed 4536c96f86eeSWolfgang Denk faster in networks with high packet loss rates or 4537c96f86eeSWolfgang Denk with unreliable TFTP servers. 4538c96f86eeSWolfgang Denk 4539a3d991bdSwdenk vlan - When set to a value < 4095 the traffic over 454011ccc33fSMarcel Ziswiler Ethernet is encapsulated/received over 802.1q 4541a3d991bdSwdenk VLAN tagged frames. 4542c609719bSwdenk 4543dc0b7b0eSJason HobbsThe following image location variables contain the location of images 4544dc0b7b0eSJason Hobbsused in booting. The "Image" column gives the role of the image and is 4545dc0b7b0eSJason Hobbsnot an environment variable name. The other columns are environment 4546dc0b7b0eSJason Hobbsvariable names. "File Name" gives the name of the file on a TFTP 4547dc0b7b0eSJason Hobbsserver, "RAM Address" gives the location in RAM the image will be 4548dc0b7b0eSJason Hobbsloaded to, and "Flash Location" gives the image's address in NOR 4549dc0b7b0eSJason Hobbsflash or offset in NAND flash. 4550dc0b7b0eSJason Hobbs 4551dc0b7b0eSJason Hobbs*Note* - these variables don't have to be defined for all boards, some 4552dc0b7b0eSJason Hobbsboards currenlty use other variables for these purposes, and some 4553dc0b7b0eSJason Hobbsboards use these variables for other purposes. 4554dc0b7b0eSJason Hobbs 4555dc0b7b0eSJason HobbsImage File Name RAM Address Flash Location 4556dc0b7b0eSJason Hobbs----- --------- ----------- -------------- 4557dc0b7b0eSJason Hobbsu-boot u-boot u-boot_addr_r u-boot_addr 4558dc0b7b0eSJason HobbsLinux kernel bootfile kernel_addr_r kernel_addr 4559dc0b7b0eSJason Hobbsdevice tree blob fdtfile fdt_addr_r fdt_addr 4560dc0b7b0eSJason Hobbsramdisk ramdiskfile ramdisk_addr_r ramdisk_addr 4561dc0b7b0eSJason Hobbs 4562c609719bSwdenkThe following environment variables may be used and automatically 4563c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"), 4564c609719bSwdenkdepending the information provided by your boot server: 4565c609719bSwdenk 4566c609719bSwdenk bootfile - see above 4567c609719bSwdenk dnsip - IP address of your Domain Name Server 4568fe389a82Sstroese dnsip2 - IP address of your secondary Domain Name Server 4569c609719bSwdenk gatewayip - IP address of the Gateway (Router) to use 4570c609719bSwdenk hostname - Target hostname 4571c609719bSwdenk ipaddr - see above 4572c609719bSwdenk netmask - Subnet Mask 4573c609719bSwdenk rootpath - Pathname of the root filesystem on the NFS server 4574c609719bSwdenk serverip - see above 4575c609719bSwdenk 4576c609719bSwdenk 4577c609719bSwdenkThere are two special Environment Variables: 4578c609719bSwdenk 4579c609719bSwdenk serial# - contains hardware identification information such 4580c609719bSwdenk as type string and/or serial number 4581c609719bSwdenk ethaddr - Ethernet address 4582c609719bSwdenk 4583c609719bSwdenkThese variables can be set only once (usually during manufacturing of 4584c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables 4585c609719bSwdenkonce they have been set once. 4586c609719bSwdenk 4587c609719bSwdenk 4588c1551ea8SstroeseFurther special Environment Variables: 4589c1551ea8Sstroese 4590c1551ea8Sstroese ver - Contains the U-Boot version string as printed 4591c1551ea8Sstroese with the "version" command. This variable is 4592c1551ea8Sstroese readonly (see CONFIG_VERSION_VARIABLE). 4593c1551ea8Sstroese 4594c1551ea8Sstroese 4595c609719bSwdenkPlease note that changes to some configuration parameters may take 4596c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-). 4597c609719bSwdenk 4598c609719bSwdenk 4599170ab110SJoe HershbergerCallback functions for environment variables: 4600170ab110SJoe Hershberger--------------------------------------------- 4601170ab110SJoe Hershberger 4602170ab110SJoe HershbergerFor some environment variables, the behavior of u-boot needs to change 4603170ab110SJoe Hershbergerwhen their values are changed. This functionailty allows functions to 4604170ab110SJoe Hershbergerbe associated with arbitrary variables. On creation, overwrite, or 4605170ab110SJoe Hershbergerdeletion, the callback will provide the opportunity for some side 4606170ab110SJoe Hershbergereffect to happen or for the change to be rejected. 4607170ab110SJoe Hershberger 4608170ab110SJoe HershbergerThe callbacks are named and associated with a function using the 4609170ab110SJoe HershbergerU_BOOT_ENV_CALLBACK macro in your board or driver code. 4610170ab110SJoe Hershberger 4611170ab110SJoe HershbergerThese callbacks are associated with variables in one of two ways. The 4612170ab110SJoe Hershbergerstatic list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC 4613170ab110SJoe Hershbergerin the board configuration to a string that defines a list of 4614170ab110SJoe Hershbergerassociations. The list must be in the following format: 4615170ab110SJoe Hershberger 4616170ab110SJoe Hershberger entry = variable_name[:callback_name] 4617170ab110SJoe Hershberger list = entry[,list] 4618170ab110SJoe Hershberger 4619170ab110SJoe HershbergerIf the callback name is not specified, then the callback is deleted. 4620170ab110SJoe HershbergerSpaces are also allowed anywhere in the list. 4621170ab110SJoe Hershberger 4622170ab110SJoe HershbergerCallbacks can also be associated by defining the ".callbacks" variable 4623170ab110SJoe Hershbergerwith the same list format above. Any association in ".callbacks" will 4624170ab110SJoe Hershbergeroverride any association in the static list. You can define 4625170ab110SJoe HershbergerCONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the 4626170ab110SJoe Hershberger".callbacks" envirnoment variable in the default or embedded environment. 4627170ab110SJoe Hershberger 4628170ab110SJoe Hershberger 4629f07771ccSwdenkCommand Line Parsing: 4630f07771ccSwdenk===================== 4631f07771ccSwdenk 4632f07771ccSwdenkThere are two different command line parsers available with U-Boot: 46337152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell: 4634f07771ccSwdenk 4635f07771ccSwdenkOld, simple command line parser: 4636f07771ccSwdenk-------------------------------- 4637f07771ccSwdenk 4638f07771ccSwdenk- supports environment variables (through setenv / saveenv commands) 4639f07771ccSwdenk- several commands on one line, separated by ';' 4640fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax 4641f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\', 4642f07771ccSwdenk for example: 4643fe126d8bSWolfgang Denk setenv bootcmd bootm \${address} 4644f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example: 4645f07771ccSwdenk setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off' 4646f07771ccSwdenk 4647f07771ccSwdenkHush shell: 4648f07771ccSwdenk----------- 4649f07771ccSwdenk 4650f07771ccSwdenk- similar to Bourne shell, with control structures like 4651f07771ccSwdenk if...then...else...fi, for...do...done; while...do...done, 4652f07771ccSwdenk until...do...done, ... 4653f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv 4654f07771ccSwdenk commands) and local shell variables (through standard shell syntax 4655f07771ccSwdenk "name=value"); only environment variables can be used with "run" 4656f07771ccSwdenk command 4657f07771ccSwdenk 4658f07771ccSwdenkGeneral rules: 4659f07771ccSwdenk-------------- 4660f07771ccSwdenk 4661f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run" 4662f07771ccSwdenk command) contains several commands separated by semicolon, and 4663f07771ccSwdenk one of these commands fails, then the remaining commands will be 4664f07771ccSwdenk executed anyway. 4665f07771ccSwdenk 4666f07771ccSwdenk(2) If you execute several variables with one call to run (i. e. 466711ccc33fSMarcel Ziswiler calling run with a list of variables as arguments), any failing 4668f07771ccSwdenk command will cause "run" to terminate, i. e. the remaining 4669f07771ccSwdenk variables are not executed. 4670f07771ccSwdenk 4671c609719bSwdenkNote for Redundant Ethernet Interfaces: 4672c609719bSwdenk======================================= 4673c609719bSwdenk 467411ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports 4675c609719bSwdenksuch configurations and is capable of automatic selection of a 46767152b1d0Swdenk"working" interface when needed. MAC assignment works as follows: 4677c609719bSwdenk 4678c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding 4679c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0), 4680c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ... 4681c609719bSwdenk 4682c609719bSwdenkIf the network interface stores some valid MAC address (for instance 4683c609719bSwdenkin SROM), this is used as default address if there is NO correspon- 4684c609719bSwdenkding setting in the environment; if the corresponding environment 4685c609719bSwdenkvariable is set, this overrides the settings in the card; that means: 4686c609719bSwdenk 4687c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the 4688c609719bSwdenk environment, the SROM's address is used. 4689c609719bSwdenk 4690c609719bSwdenko If there is no valid address in the SROM, and a definition in the 4691c609719bSwdenk environment exists, then the value from the environment variable is 4692c609719bSwdenk used. 4693c609719bSwdenk 4694c609719bSwdenko If both the SROM and the environment contain a MAC address, and 4695c609719bSwdenk both addresses are the same, this MAC address is used. 4696c609719bSwdenk 4697c609719bSwdenko If both the SROM and the environment contain a MAC address, and the 4698c609719bSwdenk addresses differ, the value from the environment is used and a 4699c609719bSwdenk warning is printed. 4700c609719bSwdenk 4701c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error 4702c609719bSwdenk is raised. 4703c609719bSwdenk 4704ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses 4705ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process. This 4706ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable. 4707ecee9324SBen WarrenThe naming convention is as follows: 4708ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc. 4709c609719bSwdenk 4710c609719bSwdenkImage Formats: 4711c609719bSwdenk============== 4712c609719bSwdenk 47133310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on) 47143310c549SMarian Balakowiczimages in two formats: 47153310c549SMarian Balakowicz 47163310c549SMarian BalakowiczNew uImage format (FIT) 47173310c549SMarian Balakowicz----------------------- 47183310c549SMarian Balakowicz 47193310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar 47203310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple 47213310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by 47223310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory. 47233310c549SMarian Balakowicz 47243310c549SMarian Balakowicz 47253310c549SMarian BalakowiczOld uImage format 47263310c549SMarian Balakowicz----------------- 47273310c549SMarian Balakowicz 47283310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything, 47293310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for 47303310c549SMarian Balakowiczdetails; basically, the header defines the following image properties: 4731c609719bSwdenk 4732c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD, 4733c609719bSwdenk 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks, 4734f5ed9e39SPeter Tyser LynxOS, pSOS, QNX, RTEMS, INTEGRITY; 4735f5ed9e39SPeter Tyser Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS, 4736f5ed9e39SPeter Tyser INTEGRITY). 47377b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86, 4738afc1ce82SMacpaul Lin IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit; 4739afc1ce82SMacpaul Lin Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC). 4740c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2) 4741c609719bSwdenk* Load Address 4742c609719bSwdenk* Entry Point 4743c609719bSwdenk* Image Name 4744c609719bSwdenk* Image Timestamp 4745c609719bSwdenk 4746c609719bSwdenkThe header is marked by a special Magic Number, and both the header 4747c609719bSwdenkand the data portions of the image are secured against corruption by 4748c609719bSwdenkCRC32 checksums. 4749c609719bSwdenk 4750c609719bSwdenk 4751c609719bSwdenkLinux Support: 4752c609719bSwdenk============== 4753c609719bSwdenk 4754c609719bSwdenkAlthough U-Boot should support any OS or standalone application 47557152b1d0Swdenkeasily, the main focus has always been on Linux during the design of 4756c609719bSwdenkU-Boot. 4757c609719bSwdenk 4758c609719bSwdenkU-Boot includes many features that so far have been part of some 4759c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any 4760c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image; 4761c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation 47627152b1d0Swdenkserves several purposes: 4763c609719bSwdenk 4764c609719bSwdenk- the same features can be used for other OS or standalone 4765c609719bSwdenk applications (for instance: using compressed images to reduce the 4766c609719bSwdenk Flash memory footprint) 4767c609719bSwdenk 4768c609719bSwdenk- it becomes much easier to port new Linux kernel versions because 47697152b1d0Swdenk lots of low-level, hardware dependent stuff are done by U-Boot 4770c609719bSwdenk 4771c609719bSwdenk- the same Linux kernel image can now be used with different "initrd" 4772c609719bSwdenk images; of course this also means that different kernel images can 4773c609719bSwdenk be run with the same "initrd". This makes testing easier (you don't 4774c609719bSwdenk have to build a new "zImage.initrd" Linux image when you just 4775c609719bSwdenk change a file in your "initrd"). Also, a field-upgrade of the 4776c609719bSwdenk software is easier now. 4777c609719bSwdenk 4778c609719bSwdenk 4779c609719bSwdenkLinux HOWTO: 4780c609719bSwdenk============ 4781c609719bSwdenk 4782c609719bSwdenkPorting Linux to U-Boot based systems: 4783c609719bSwdenk--------------------------------------- 4784c609719bSwdenk 4785c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to 4786c609719bSwdenkconfigure the Linux device drivers for use with your target hardware 4787c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to 4788c609719bSwdenkLinux :-). 4789c609719bSwdenk 4790a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot). 4791c609719bSwdenk 4792c609719bSwdenkJust make sure your machine specific header file (for instance 4793c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board 47941dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h, 47951dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value 47966d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR. 4797c609719bSwdenk 4798c609719bSwdenk 4799c609719bSwdenkConfiguring the Linux kernel: 4800c609719bSwdenk----------------------------- 4801c609719bSwdenk 4802c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root 4803c609719bSwdenkdevice (initial ramdisk, NFS) for your target system. 4804c609719bSwdenk 4805c609719bSwdenk 4806c609719bSwdenkBuilding a Linux Image: 4807c609719bSwdenk----------------------- 4808c609719bSwdenk 480924ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are 481024ee89b9Swdenknot used. If you use recent kernel source, a new build target 481124ee89b9Swdenk"uImage" will exist which automatically builds an image usable by 481224ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target, 481324ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a 481424ee89b9Swdenk100% compatible format. 4815c609719bSwdenk 4816c609719bSwdenkExample: 4817c609719bSwdenk 4818c609719bSwdenk make TQM850L_config 4819c609719bSwdenk make oldconfig 4820c609719bSwdenk make dep 482124ee89b9Swdenk make uImage 4822c609719bSwdenk 482324ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to 482424ee89b9Swdenkencapsulate a compressed Linux kernel image with header information, 482524ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing: 4826c609719bSwdenk 482724ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format): 482824ee89b9Swdenk 482924ee89b9Swdenk* convert the kernel into a raw binary image: 483024ee89b9Swdenk 483124ee89b9Swdenk ${CROSS_COMPILE}-objcopy -O binary \ 483224ee89b9Swdenk -R .note -R .comment \ 483324ee89b9Swdenk -S vmlinux linux.bin 483424ee89b9Swdenk 483524ee89b9Swdenk* compress the binary image: 483624ee89b9Swdenk 483724ee89b9Swdenk gzip -9 linux.bin 483824ee89b9Swdenk 483924ee89b9Swdenk* package compressed binary image for U-Boot: 484024ee89b9Swdenk 484124ee89b9Swdenk mkimage -A ppc -O linux -T kernel -C gzip \ 484224ee89b9Swdenk -a 0 -e 0 -n "Linux Kernel Image" \ 484324ee89b9Swdenk -d linux.bin.gz uImage 484424ee89b9Swdenk 484524ee89b9Swdenk 484624ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use 484724ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or 484824ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64 484924ee89b9Swdenkbyte header containing information about target architecture, 485024ee89b9Swdenkoperating system, image type, compression method, entry points, time 485124ee89b9Swdenkstamp, CRC32 checksums, etc. 485224ee89b9Swdenk 485324ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and 485424ee89b9Swdenkprint the header information, or to build new images. 4855c609719bSwdenk 4856c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information 4857c609719bSwdenkcontained in the header of an existing U-Boot image; this includes 4858c609719bSwdenkchecksum verification: 4859c609719bSwdenk 4860c609719bSwdenk tools/mkimage -l image 4861c609719bSwdenk -l ==> list image header information 4862c609719bSwdenk 4863c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image 4864c609719bSwdenkfrom a "data file" which is used as image payload: 4865c609719bSwdenk 4866c609719bSwdenk tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \ 4867c609719bSwdenk -n name -d data_file image 4868c609719bSwdenk -A ==> set architecture to 'arch' 4869c609719bSwdenk -O ==> set operating system to 'os' 4870c609719bSwdenk -T ==> set image type to 'type' 4871c609719bSwdenk -C ==> set compression type 'comp' 4872c609719bSwdenk -a ==> set load address to 'addr' (hex) 4873c609719bSwdenk -e ==> set entry point to 'ep' (hex) 4874c609719bSwdenk -n ==> set image name to 'name' 4875c609719bSwdenk -d ==> use image data from 'datafile' 4876c609719bSwdenk 487769459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load 487869459791Swdenkaddress (0x00000000), but the entry point address depends on the 487969459791Swdenkkernel version: 4880c609719bSwdenk 4881c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C, 488224ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000. 4883c609719bSwdenk 4884c609719bSwdenkSo a typical call to build a U-Boot image would read: 4885c609719bSwdenk 488624ee89b9Swdenk -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 488724ee89b9Swdenk > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \ 4888a47a12beSStefan Roese > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \ 488924ee89b9Swdenk > examples/uImage.TQM850L 489024ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 4891c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 4892c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 4893c609719bSwdenk Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 4894c609719bSwdenk Load Address: 0x00000000 489524ee89b9Swdenk Entry Point: 0x00000000 4896c609719bSwdenk 4897c609719bSwdenkTo verify the contents of the image (or check for corruption): 4898c609719bSwdenk 489924ee89b9Swdenk -> tools/mkimage -l examples/uImage.TQM850L 490024ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 4901c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 4902c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 4903c609719bSwdenk Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 4904c609719bSwdenk Load Address: 0x00000000 490524ee89b9Swdenk Entry Point: 0x00000000 4906c609719bSwdenk 4907c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade 4908c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this 4909c609719bSwdenkneeds more space in Flash, but boots much faster since it does not 4910c609719bSwdenkneed to be uncompressed: 4911c609719bSwdenk 4912a47a12beSStefan Roese -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz 491324ee89b9Swdenk -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 491424ee89b9Swdenk > -A ppc -O linux -T kernel -C none -a 0 -e 0 \ 4915a47a12beSStefan Roese > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \ 491624ee89b9Swdenk > examples/uImage.TQM850L-uncompressed 491724ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 4918c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 4919c609719bSwdenk Image Type: PowerPC Linux Kernel Image (uncompressed) 4920c609719bSwdenk Data Size: 792160 Bytes = 773.59 kB = 0.76 MB 4921c609719bSwdenk Load Address: 0x00000000 492224ee89b9Swdenk Entry Point: 0x00000000 4923c609719bSwdenk 4924c609719bSwdenk 4925c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file 4926c609719bSwdenkwhen your kernel is intended to use an initial ramdisk: 4927c609719bSwdenk 4928c609719bSwdenk -> tools/mkimage -n 'Simple Ramdisk Image' \ 4929c609719bSwdenk > -A ppc -O linux -T ramdisk -C gzip \ 4930c609719bSwdenk > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd 4931c609719bSwdenk Image Name: Simple Ramdisk Image 4932c609719bSwdenk Created: Wed Jan 12 14:01:50 2000 4933c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 4934c609719bSwdenk Data Size: 566530 Bytes = 553.25 kB = 0.54 MB 4935c609719bSwdenk Load Address: 0x00000000 4936c609719bSwdenk Entry Point: 0x00000000 4937c609719bSwdenk 4938c609719bSwdenk 4939c609719bSwdenkInstalling a Linux Image: 4940c609719bSwdenk------------------------- 4941c609719bSwdenk 4942c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface, 4943c609719bSwdenkyou must convert the image to S-Record format: 4944c609719bSwdenk 4945c609719bSwdenk objcopy -I binary -O srec examples/image examples/image.srec 4946c609719bSwdenk 4947c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot 4948c609719bSwdenkimage header, so the resulting S-Record file will be relative to 4949c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to 4950c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads' 4951c609719bSwdenkcommand. 4952c609719bSwdenk 4953c609719bSwdenkExample: install the image to address 0x40100000 (which on the 4954c609719bSwdenkTQM8xxL is in the first Flash bank): 4955c609719bSwdenk 4956c609719bSwdenk => erase 40100000 401FFFFF 4957c609719bSwdenk 4958c609719bSwdenk .......... done 4959c609719bSwdenk Erased 8 sectors 4960c609719bSwdenk 4961c609719bSwdenk => loads 40100000 4962c609719bSwdenk ## Ready for S-Record download ... 4963c609719bSwdenk ~>examples/image.srec 4964c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 12 13 ... 4965c609719bSwdenk ... 4966c609719bSwdenk 15989 15990 15991 15992 4967c609719bSwdenk [file transfer complete] 4968c609719bSwdenk [connected] 4969c609719bSwdenk ## Start Addr = 0x00000000 4970c609719bSwdenk 4971c609719bSwdenk 4972c609719bSwdenkYou can check the success of the download using the 'iminfo' command; 4973c609719bSwdenkthis includes a checksum verification so you can be sure no data 4974c609719bSwdenkcorruption happened: 4975c609719bSwdenk 4976c609719bSwdenk => imi 40100000 4977c609719bSwdenk 4978c609719bSwdenk ## Checking Image at 40100000 ... 4979c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 4980c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 4981c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 4982c609719bSwdenk Load Address: 00000000 4983c609719bSwdenk Entry Point: 0000000c 4984c609719bSwdenk Verifying Checksum ... OK 4985c609719bSwdenk 4986c609719bSwdenk 4987c609719bSwdenkBoot Linux: 4988c609719bSwdenk----------- 4989c609719bSwdenk 4990c609719bSwdenkThe "bootm" command is used to boot an application that is stored in 4991c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents 4992c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as 4993c609719bSwdenkparameters. You can check and modify this variable using the 4994c609719bSwdenk"printenv" and "setenv" commands: 4995c609719bSwdenk 4996c609719bSwdenk 4997c609719bSwdenk => printenv bootargs 4998c609719bSwdenk bootargs=root=/dev/ram 4999c609719bSwdenk 5000c609719bSwdenk => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 5001c609719bSwdenk 5002c609719bSwdenk => printenv bootargs 5003c609719bSwdenk bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 5004c609719bSwdenk 5005c609719bSwdenk => bootm 40020000 5006c609719bSwdenk ## Booting Linux kernel at 40020000 ... 5007c609719bSwdenk Image Name: 2.2.13 for NFS on TQM850L 5008c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 5009c609719bSwdenk Data Size: 381681 Bytes = 372 kB = 0 MB 5010c609719bSwdenk Load Address: 00000000 5011c609719bSwdenk Entry Point: 0000000c 5012c609719bSwdenk Verifying Checksum ... OK 5013c609719bSwdenk Uncompressing Kernel Image ... OK 5014c609719bSwdenk 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 5015c609719bSwdenk Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 5016c609719bSwdenk time_init: decrementer frequency = 187500000/60 5017c609719bSwdenk Calibrating delay loop... 49.77 BogoMIPS 5018c609719bSwdenk Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000] 5019c609719bSwdenk ... 5020c609719bSwdenk 502111ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass 50227152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT 5023c609719bSwdenkformat!) to the "bootm" command: 5024c609719bSwdenk 5025c609719bSwdenk => imi 40100000 40200000 5026c609719bSwdenk 5027c609719bSwdenk ## Checking Image at 40100000 ... 5028c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 5029c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 5030c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 5031c609719bSwdenk Load Address: 00000000 5032c609719bSwdenk Entry Point: 0000000c 5033c609719bSwdenk Verifying Checksum ... OK 5034c609719bSwdenk 5035c609719bSwdenk ## Checking Image at 40200000 ... 5036c609719bSwdenk Image Name: Simple Ramdisk Image 5037c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 5038c609719bSwdenk Data Size: 566530 Bytes = 553 kB = 0 MB 5039c609719bSwdenk Load Address: 00000000 5040c609719bSwdenk Entry Point: 00000000 5041c609719bSwdenk Verifying Checksum ... OK 5042c609719bSwdenk 5043c609719bSwdenk => bootm 40100000 40200000 5044c609719bSwdenk ## Booting Linux kernel at 40100000 ... 5045c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 5046c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 5047c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 5048c609719bSwdenk Load Address: 00000000 5049c609719bSwdenk Entry Point: 0000000c 5050c609719bSwdenk Verifying Checksum ... OK 5051c609719bSwdenk Uncompressing Kernel Image ... OK 5052c609719bSwdenk ## Loading RAMDisk Image at 40200000 ... 5053c609719bSwdenk Image Name: Simple Ramdisk Image 5054c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 5055c609719bSwdenk Data Size: 566530 Bytes = 553 kB = 0 MB 5056c609719bSwdenk Load Address: 00000000 5057c609719bSwdenk Entry Point: 00000000 5058c609719bSwdenk Verifying Checksum ... OK 5059c609719bSwdenk Loading Ramdisk ... OK 5060c609719bSwdenk 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 5061c609719bSwdenk Boot arguments: root=/dev/ram 5062c609719bSwdenk time_init: decrementer frequency = 187500000/60 5063c609719bSwdenk Calibrating delay loop... 49.77 BogoMIPS 5064c609719bSwdenk ... 5065c609719bSwdenk RAMDISK: Compressed image found at block 0 5066c609719bSwdenk VFS: Mounted root (ext2 filesystem). 5067c609719bSwdenk 5068c609719bSwdenk bash# 5069c609719bSwdenk 50700267768eSMatthew McClintockBoot Linux and pass a flat device tree: 50710267768eSMatthew McClintock----------- 50720267768eSMatthew McClintock 50730267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section 50740267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The 50750267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated 50760267768eSMatthew McClintockflat device tree: 50770267768eSMatthew McClintock 50780267768eSMatthew McClintock=> print oftaddr 50790267768eSMatthew McClintockoftaddr=0x300000 50800267768eSMatthew McClintock=> print oft 50810267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb 50820267768eSMatthew McClintock=> tftp $oftaddr $oft 50830267768eSMatthew McClintockSpeed: 1000, full duplex 50840267768eSMatthew McClintockUsing TSEC0 device 50850267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101 50860267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'. 50870267768eSMatthew McClintockLoad address: 0x300000 50880267768eSMatthew McClintockLoading: # 50890267768eSMatthew McClintockdone 50900267768eSMatthew McClintockBytes transferred = 4106 (100a hex) 50910267768eSMatthew McClintock=> tftp $loadaddr $bootfile 50920267768eSMatthew McClintockSpeed: 1000, full duplex 50930267768eSMatthew McClintockUsing TSEC0 device 50940267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2 50950267768eSMatthew McClintockFilename 'uImage'. 50960267768eSMatthew McClintockLoad address: 0x200000 50970267768eSMatthew McClintockLoading:############ 50980267768eSMatthew McClintockdone 50990267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex) 51000267768eSMatthew McClintock=> print loadaddr 51010267768eSMatthew McClintockloadaddr=200000 51020267768eSMatthew McClintock=> print oftaddr 51030267768eSMatthew McClintockoftaddr=0x300000 51040267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr 51050267768eSMatthew McClintock## Booting image at 00200000 ... 51060267768eSMatthew McClintock Image Name: Linux-2.6.17-dirty 51070267768eSMatthew McClintock Image Type: PowerPC Linux Kernel Image (gzip compressed) 51080267768eSMatthew McClintock Data Size: 1029343 Bytes = 1005.2 kB 51090267768eSMatthew McClintock Load Address: 00000000 51100267768eSMatthew McClintock Entry Point: 00000000 51110267768eSMatthew McClintock Verifying Checksum ... OK 51120267768eSMatthew McClintock Uncompressing Kernel Image ... OK 51130267768eSMatthew McClintockBooting using flat device tree at 0x300000 51140267768eSMatthew McClintockUsing MPC85xx ADS machine description 51150267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb 51160267768eSMatthew McClintock[snip] 51170267768eSMatthew McClintock 51180267768eSMatthew McClintock 51196069ff26SwdenkMore About U-Boot Image Types: 51206069ff26Swdenk------------------------------ 51216069ff26Swdenk 51226069ff26SwdenkU-Boot supports the following image types: 51236069ff26Swdenk 51246069ff26Swdenk "Standalone Programs" are directly runnable in the environment 51256069ff26Swdenk provided by U-Boot; it is expected that (if they behave 51266069ff26Swdenk well) you can continue to work in U-Boot after return from 51276069ff26Swdenk the Standalone Program. 51286069ff26Swdenk "OS Kernel Images" are usually images of some Embedded OS which 51296069ff26Swdenk will take over control completely. Usually these programs 51306069ff26Swdenk will install their own set of exception handlers, device 51316069ff26Swdenk drivers, set up the MMU, etc. - this means, that you cannot 51326069ff26Swdenk expect to re-enter U-Boot except by resetting the CPU. 51336069ff26Swdenk "RAMDisk Images" are more or less just data blocks, and their 51346069ff26Swdenk parameters (address, size) are passed to an OS kernel that is 51356069ff26Swdenk being started. 51366069ff26Swdenk "Multi-File Images" contain several images, typically an OS 51376069ff26Swdenk (Linux) kernel image and one or more data images like 51386069ff26Swdenk RAMDisks. This construct is useful for instance when you want 51396069ff26Swdenk to boot over the network using BOOTP etc., where the boot 51406069ff26Swdenk server provides just a single image file, but you want to get 51416069ff26Swdenk for instance an OS kernel and a RAMDisk image. 51426069ff26Swdenk 51436069ff26Swdenk "Multi-File Images" start with a list of image sizes, each 51446069ff26Swdenk image size (in bytes) specified by an "uint32_t" in network 51456069ff26Swdenk byte order. This list is terminated by an "(uint32_t)0". 51466069ff26Swdenk Immediately after the terminating 0 follow the images, one by 51476069ff26Swdenk one, all aligned on "uint32_t" boundaries (size rounded up to 51486069ff26Swdenk a multiple of 4 bytes). 51496069ff26Swdenk 51506069ff26Swdenk "Firmware Images" are binary images containing firmware (like 51516069ff26Swdenk U-Boot or FPGA images) which usually will be programmed to 51526069ff26Swdenk flash memory. 51536069ff26Swdenk 51546069ff26Swdenk "Script files" are command sequences that will be executed by 51556069ff26Swdenk U-Boot's command interpreter; this feature is especially 51566069ff26Swdenk useful when you configure U-Boot to use a real shell (hush) 51576069ff26Swdenk as command interpreter. 51586069ff26Swdenk 515944f074c7SMarek VasutBooting the Linux zImage: 516044f074c7SMarek Vasut------------------------- 516144f074c7SMarek Vasut 516244f074c7SMarek VasutOn some platforms, it's possible to boot Linux zImage. This is done 516344f074c7SMarek Vasutusing the "bootz" command. The syntax of "bootz" command is the same 516444f074c7SMarek Vasutas the syntax of "bootm" command. 516544f074c7SMarek Vasut 51668ac28563STom RiniNote, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply 5167017e1f3fSMarek Vasutkernel with raw initrd images. The syntax is slightly different, the 5168017e1f3fSMarek Vasutaddress of the initrd must be augmented by it's size, in the following 5169017e1f3fSMarek Vasutformat: "<initrd addres>:<initrd size>". 5170017e1f3fSMarek Vasut 5171c609719bSwdenk 5172c609719bSwdenkStandalone HOWTO: 5173c609719bSwdenk================= 5174c609719bSwdenk 5175c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and 5176c609719bSwdenkrun "standalone" applications, which can use some resources of 5177c609719bSwdenkU-Boot like console I/O functions or interrupt services. 5178c609719bSwdenk 5179c609719bSwdenkTwo simple examples are included with the sources: 5180c609719bSwdenk 5181c609719bSwdenk"Hello World" Demo: 5182c609719bSwdenk------------------- 5183c609719bSwdenk 5184c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo 5185c609719bSwdenkapplication; it is automatically compiled when you build U-Boot. 5186c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it 5187c609719bSwdenklike that: 5188c609719bSwdenk 5189c609719bSwdenk => loads 5190c609719bSwdenk ## Ready for S-Record download ... 5191c609719bSwdenk ~>examples/hello_world.srec 5192c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 ... 5193c609719bSwdenk [file transfer complete] 5194c609719bSwdenk [connected] 5195c609719bSwdenk ## Start Addr = 0x00040004 5196c609719bSwdenk 5197c609719bSwdenk => go 40004 Hello World! This is a test. 5198c609719bSwdenk ## Starting application at 0x00040004 ... 5199c609719bSwdenk Hello World 5200c609719bSwdenk argc = 7 5201c609719bSwdenk argv[0] = "40004" 5202c609719bSwdenk argv[1] = "Hello" 5203c609719bSwdenk argv[2] = "World!" 5204c609719bSwdenk argv[3] = "This" 5205c609719bSwdenk argv[4] = "is" 5206c609719bSwdenk argv[5] = "a" 5207c609719bSwdenk argv[6] = "test." 5208c609719bSwdenk argv[7] = "<NULL>" 5209c609719bSwdenk Hit any key to exit ... 5210c609719bSwdenk 5211c609719bSwdenk ## Application terminated, rc = 0x0 5212c609719bSwdenk 5213c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt 5214c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'. 5215c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second. 5216c609719bSwdenkThe interrupt service routine is trivial, just printing a '.' 5217c609719bSwdenkcharacter, but this is just a demo program. The application can be 5218c609719bSwdenkcontrolled by the following keys: 5219c609719bSwdenk 5220c609719bSwdenk ? - print current values og the CPM Timer registers 5221c609719bSwdenk b - enable interrupts and start timer 5222c609719bSwdenk e - stop timer and disable interrupts 5223c609719bSwdenk q - quit application 5224c609719bSwdenk 5225c609719bSwdenk => loads 5226c609719bSwdenk ## Ready for S-Record download ... 5227c609719bSwdenk ~>examples/timer.srec 5228c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 ... 5229c609719bSwdenk [file transfer complete] 5230c609719bSwdenk [connected] 5231c609719bSwdenk ## Start Addr = 0x00040004 5232c609719bSwdenk 5233c609719bSwdenk => go 40004 5234c609719bSwdenk ## Starting application at 0x00040004 ... 5235c609719bSwdenk TIMERS=0xfff00980 5236c609719bSwdenk Using timer 1 5237c609719bSwdenk tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0 5238c609719bSwdenk 5239c609719bSwdenkHit 'b': 5240c609719bSwdenk [q, b, e, ?] Set interval 1000000 us 5241c609719bSwdenk Enabling timer 5242c609719bSwdenkHit '?': 5243c609719bSwdenk [q, b, e, ?] ........ 5244c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0 5245c609719bSwdenkHit '?': 5246c609719bSwdenk [q, b, e, ?] . 5247c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0 5248c609719bSwdenkHit '?': 5249c609719bSwdenk [q, b, e, ?] . 5250c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0 5251c609719bSwdenkHit '?': 5252c609719bSwdenk [q, b, e, ?] . 5253c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0 5254c609719bSwdenkHit 'e': 5255c609719bSwdenk [q, b, e, ?] ...Stopping timer 5256c609719bSwdenkHit 'q': 5257c609719bSwdenk [q, b, e, ?] ## Application terminated, rc = 0x0 5258c609719bSwdenk 5259c609719bSwdenk 526085ec0bccSwdenkMinicom warning: 526185ec0bccSwdenk================ 526285ec0bccSwdenk 52637152b1d0SwdenkOver time, many people have reported problems when trying to use the 526485ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd) 526585ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under 5266f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and 526785ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and 5268e53515a2SKarl O. Pincuse "cu" for S-Record download ("loads" command). See 5269e53515a2SKarl O. Pinchttp://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3. 5270e53515a2SKarl O. Pincfor help with kermit. 5271e53515a2SKarl O. Pinc 527285ec0bccSwdenk 527352f52c14SwdenkNevertheless, if you absolutely want to use it try adding this 527452f52c14Swdenkconfiguration to your "File transfer protocols" section: 527552f52c14Swdenk 527652f52c14Swdenk Name Program Name U/D FullScr IO-Red. Multi 527752f52c14Swdenk X kermit /usr/bin/kermit -i -l %l -s Y U Y N N 527852f52c14Swdenk Y kermit /usr/bin/kermit -i -l %l -r N D Y N N 527952f52c14Swdenk 528052f52c14Swdenk 5281c609719bSwdenkNetBSD Notes: 5282c609719bSwdenk============= 5283c609719bSwdenk 5284c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host 5285c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx). 5286c609719bSwdenk 5287c609719bSwdenkBuilding requires a cross environment; it is known to work on 5288c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also 5289c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make). 5290c609719bSwdenkNote that the cross-powerpc package does not install include files; 5291c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is 5292c609719bSwdenkmissing. This file has to be installed and patched manually: 5293c609719bSwdenk 5294c609719bSwdenk # cd /usr/pkg/cross/powerpc-netbsd/include 5295c609719bSwdenk # mkdir powerpc 5296c609719bSwdenk # ln -s powerpc machine 5297c609719bSwdenk # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h 5298c609719bSwdenk # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST 5299c609719bSwdenk 5300c609719bSwdenkNative builds *don't* work due to incompatibilities between native 5301c609719bSwdenkand U-Boot include files. 5302c609719bSwdenk 5303c609719bSwdenkBooting assumes that (the first part of) the image booted is a 5304c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel 5305c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source 5306c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the 53072a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz 5308c609719bSwdenk 5309c609719bSwdenk 5310c609719bSwdenkImplementation Internals: 5311c609719bSwdenk========================= 5312c609719bSwdenk 5313c609719bSwdenkThe following is not intended to be a complete description of every 5314c609719bSwdenkimplementation detail. However, it should help to understand the 5315c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom 5316c609719bSwdenkhardware. 5317c609719bSwdenk 5318c609719bSwdenk 5319c609719bSwdenkInitial Stack, Global Data: 5320c609719bSwdenk--------------------------- 5321c609719bSwdenk 5322c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot 5323c609719bSwdenkstarts running out of ROM (flash memory), usually without access to 5324c609719bSwdenksystem RAM (because the memory controller is not initialized yet). 5325c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS 5326c609719bSwdenkis not initialized as zero. To be able to get a C environment working 5327c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation 5328c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU 5329c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and 5330c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be 5331c609719bSwdenklocked as (mis-) used as memory, etc. 5332c609719bSwdenk 53337152b1d0Swdenk Chris Hallinan posted a good summary of these issues to the 53340668236bSWolfgang Denk U-Boot mailing list: 533543d9616cSwdenk 533643d9616cSwdenk Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)? 533743d9616cSwdenk From: "Chris Hallinan" <clh@net1plus.com> 533843d9616cSwdenk Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET) 533943d9616cSwdenk ... 534043d9616cSwdenk 534143d9616cSwdenk Correct me if I'm wrong, folks, but the way I understand it 534243d9616cSwdenk is this: Using DCACHE as initial RAM for Stack, etc, does not 534343d9616cSwdenk require any physical RAM backing up the cache. The cleverness 534443d9616cSwdenk is that the cache is being used as a temporary supply of 534543d9616cSwdenk necessary storage before the SDRAM controller is setup. It's 534611ccc33fSMarcel Ziswiler beyond the scope of this list to explain the details, but you 534743d9616cSwdenk can see how this works by studying the cache architecture and 534843d9616cSwdenk operation in the architecture and processor-specific manuals. 534943d9616cSwdenk 535043d9616cSwdenk OCM is On Chip Memory, which I believe the 405GP has 4K. It 535143d9616cSwdenk is another option for the system designer to use as an 535211ccc33fSMarcel Ziswiler initial stack/RAM area prior to SDRAM being available. Either 535343d9616cSwdenk option should work for you. Using CS 4 should be fine if your 535443d9616cSwdenk board designers haven't used it for something that would 535543d9616cSwdenk cause you grief during the initial boot! It is frequently not 535643d9616cSwdenk used. 535743d9616cSwdenk 53586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere 535943d9616cSwdenk with your processor/board/system design. The default value 536043d9616cSwdenk you will find in any recent u-boot distribution in 53618a316c9bSStefan Roese walnut.h should work for you. I'd set it to a value larger 536243d9616cSwdenk than your SDRAM module. If you have a 64MB SDRAM module, set 536343d9616cSwdenk it above 400_0000. Just make sure your board has no resources 536443d9616cSwdenk that are supposed to respond to that address! That code in 536543d9616cSwdenk start.S has been around a while and should work as is when 536643d9616cSwdenk you get the config right. 536743d9616cSwdenk 536843d9616cSwdenk -Chris Hallinan 536943d9616cSwdenk DS4.COM, Inc. 537043d9616cSwdenk 5371c609719bSwdenkIt is essential to remember this, since it has some impact on the C 5372c609719bSwdenkcode for the initialization procedures: 5373c609719bSwdenk 5374c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt 5375c609719bSwdenk to write it. 5376c609719bSwdenk 537711ccc33fSMarcel Ziswiler* Do not use any uninitialized global data (or implicitely initialized 5378c609719bSwdenk as zero data - BSS segment) at all - this is undefined, initiali- 53797152b1d0Swdenk zation is performed later (when relocating to RAM). 5380c609719bSwdenk 5381c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like 5382c609719bSwdenk that. 5383c609719bSwdenk 5384c609719bSwdenkHaving only the stack as writable memory limits means we cannot use 5385c609719bSwdenknormal global data to share information beween the code. But it 5386c609719bSwdenkturned out that the implementation of U-Boot can be greatly 5387c609719bSwdenksimplified by making a global data structure (gd_t) available to all 5388c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_ 5389c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of 5390c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we 5391c609719bSwdenkplace a pointer (gd) to the global data into a register which we 5392c609719bSwdenkreserve for this purpose. 5393c609719bSwdenk 53947152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the 5395c609719bSwdenkrelevant (E)ABI specifications for the current architecture, and by 5396c609719bSwdenkGCC's implementation. 5397c609719bSwdenk 5398c609719bSwdenkFor PowerPC, the following registers have specific use: 5399c609719bSwdenk R1: stack pointer 5400e7670f6cSWolfgang Denk R2: reserved for system use 5401c609719bSwdenk R3-R4: parameter passing and return values 5402c609719bSwdenk R5-R10: parameter passing 5403c609719bSwdenk R13: small data area pointer 5404c609719bSwdenk R30: GOT pointer 5405c609719bSwdenk R31: frame pointer 5406c609719bSwdenk 5407e6bee808SJoakim Tjernlund (U-Boot also uses R12 as internal GOT pointer. r12 5408e6bee808SJoakim Tjernlund is a volatile register so r12 needs to be reset when 5409e6bee808SJoakim Tjernlund going back and forth between asm and C) 5410c609719bSwdenk 5411e7670f6cSWolfgang Denk ==> U-Boot will use R2 to hold a pointer to the global data 5412c609719bSwdenk 5413c609719bSwdenk Note: on PPC, we could use a static initializer (since the 5414c609719bSwdenk address of the global data structure is known at compile time), 5415c609719bSwdenk but it turned out that reserving a register results in somewhat 5416c609719bSwdenk smaller code - although the code savings are not that big (on 5417c609719bSwdenk average for all boards 752 bytes for the whole U-Boot image, 5418c609719bSwdenk 624 text + 127 data). 5419c609719bSwdenk 5420c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here: 54214c58eb55SMike Frysinger http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface 54224c58eb55SMike Frysinger 5423c4db335cSRobin Getz ==> U-Boot will use P3 to hold a pointer to the global data 54244c58eb55SMike Frysinger 5425c609719bSwdenkOn ARM, the following registers are used: 5426c609719bSwdenk 5427c609719bSwdenk R0: function argument word/integer result 5428c609719bSwdenk R1-R3: function argument word 5429c609719bSwdenk R9: GOT pointer 5430c609719bSwdenk R10: stack limit (used only if stack checking if enabled) 5431c609719bSwdenk R11: argument (frame) pointer 5432c609719bSwdenk R12: temporary workspace 5433c609719bSwdenk R13: stack pointer 5434c609719bSwdenk R14: link register 5435c609719bSwdenk R15: program counter 5436c609719bSwdenk 5437c609719bSwdenk ==> U-Boot will use R8 to hold a pointer to the global data 5438c609719bSwdenk 54390df01fd3SThomas ChouOn Nios II, the ABI is documented here: 54400df01fd3SThomas Chou http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf 54410df01fd3SThomas Chou 54420df01fd3SThomas Chou ==> U-Boot will use gp to hold a pointer to the global data 54430df01fd3SThomas Chou 54440df01fd3SThomas Chou Note: on Nios II, we give "-G0" option to gcc and don't use gp 54450df01fd3SThomas Chou to access small data sections, so gp is free. 54460df01fd3SThomas Chou 5447afc1ce82SMacpaul LinOn NDS32, the following registers are used: 5448afc1ce82SMacpaul Lin 5449afc1ce82SMacpaul Lin R0-R1: argument/return 5450afc1ce82SMacpaul Lin R2-R5: argument 5451afc1ce82SMacpaul Lin R15: temporary register for assembler 5452afc1ce82SMacpaul Lin R16: trampoline register 5453afc1ce82SMacpaul Lin R28: frame pointer (FP) 5454afc1ce82SMacpaul Lin R29: global pointer (GP) 5455afc1ce82SMacpaul Lin R30: link register (LP) 5456afc1ce82SMacpaul Lin R31: stack pointer (SP) 5457afc1ce82SMacpaul Lin PC: program counter (PC) 5458afc1ce82SMacpaul Lin 5459afc1ce82SMacpaul Lin ==> U-Boot will use R10 to hold a pointer to the global data 5460afc1ce82SMacpaul Lin 5461d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope, 5462d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much. 5463c609719bSwdenk 5464c609719bSwdenkMemory Management: 5465c609719bSwdenk------------------ 5466c609719bSwdenk 5467c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the 5468c609719bSwdenkMMU is not used either for address mapping nor for memory protection. 5469c609719bSwdenk 5470c609719bSwdenkThe available memory is mapped to fixed addresses using the memory 5471c609719bSwdenkcontroller. In this process, a contiguous block is formed for each 5472c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several 5473c609719bSwdenkphysical memory banks. 5474c609719bSwdenk 5475c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on 5476c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After 5477c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself 5478c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some 54796d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN 5480c609719bSwdenkconfiguration setting]. Below that, a structure with global Board 5481c609719bSwdenkInfo data is placed, followed by the stack (growing downward). 5482c609719bSwdenk 5483c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB 5484c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF). 5485c609719bSwdenk 5486c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like 5487c609719bSwdenkthis: 5488c609719bSwdenk 5489c609719bSwdenk 0x0000 0000 Exception Vector code 5490c609719bSwdenk : 5491c609719bSwdenk 0x0000 1FFF 5492c609719bSwdenk 0x0000 2000 Free for Application Use 5493c609719bSwdenk : 5494c609719bSwdenk : 5495c609719bSwdenk 5496c609719bSwdenk : 5497c609719bSwdenk : 5498c609719bSwdenk 0x00FB FF20 Monitor Stack (Growing downward) 5499c609719bSwdenk 0x00FB FFAC Board Info Data and permanent copy of global data 5500c609719bSwdenk 0x00FC 0000 Malloc Arena 5501c609719bSwdenk : 5502c609719bSwdenk 0x00FD FFFF 5503c609719bSwdenk 0x00FE 0000 RAM Copy of Monitor Code 5504c609719bSwdenk ... eventually: LCD or video framebuffer 5505c609719bSwdenk ... eventually: pRAM (Protected RAM - unchanged by reset) 5506c609719bSwdenk 0x00FF FFFF [End of RAM] 5507c609719bSwdenk 5508c609719bSwdenk 5509c609719bSwdenkSystem Initialization: 5510c609719bSwdenk---------------------- 5511c609719bSwdenk 5512c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point 551311ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset 5514c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory. 55157152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address. 5516c609719bSwdenkTo be able to implement the initialization code in C, a (small!) 5517c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs 5518c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked 5519c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core, 5520c609719bSwdenkthe caches and the SIU. 5521c609719bSwdenk 5522c609719bSwdenkNext, all (potentially) available memory banks are mapped using a 5523c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries 5524c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash 5525c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is 5526c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a 5527c609719bSwdenksimple memory test is run that determines the size of the SDRAM 5528c609719bSwdenkbanks. 5529c609719bSwdenk 5530c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of 55317152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first 5532c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address 5533c609719bSwdenk0x00000000, with any additional banks following immediately to create 5534c609719bSwdenkcontiguous memory starting from 0. 5535c609719bSwdenk 5536c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area 5537c609719bSwdenkand allocates memory for use by malloc() and for the global Board 5538c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM 5539c609719bSwdenkpages, and the final stack is set up. 5540c609719bSwdenk 5541c609719bSwdenkOnly after this relocation will you have a "normal" C environment; 5542c609719bSwdenkuntil that you are restricted in several ways, mostly because you are 5543c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a 5544c609719bSwdenknew address in RAM. 5545c609719bSwdenk 5546c609719bSwdenk 5547c609719bSwdenkU-Boot Porting Guide: 5548c609719bSwdenk---------------------- 5549c609719bSwdenk 5550c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing 55516aff3115Swdenklist, October 2002] 5552c609719bSwdenk 5553c609719bSwdenk 5554c609719bSwdenkint main(int argc, char *argv[]) 5555c609719bSwdenk{ 5556c609719bSwdenk sighandler_t no_more_time; 5557c609719bSwdenk 5558c609719bSwdenk signal(SIGALRM, no_more_time); 5559c609719bSwdenk alarm(PROJECT_DEADLINE - toSec (3 * WEEK)); 5560c609719bSwdenk 5561c609719bSwdenk if (available_money > available_manpower) { 55626c3fef28SJerry Van Baren Pay consultant to port U-Boot; 5563c609719bSwdenk return 0; 5564c609719bSwdenk } 5565c609719bSwdenk 5566c609719bSwdenk Download latest U-Boot source; 5567c609719bSwdenk 55680668236bSWolfgang Denk Subscribe to u-boot mailing list; 55696aff3115Swdenk 55706c3fef28SJerry Van Baren if (clueless) 5571c609719bSwdenk email("Hi, I am new to U-Boot, how do I get started?"); 5572c609719bSwdenk 5573c609719bSwdenk while (learning) { 5574c609719bSwdenk Read the README file in the top level directory; 55757cb22f97Swdenk Read http://www.denx.de/twiki/bin/view/DULG/Manual; 55766c3fef28SJerry Van Baren Read applicable doc/*.README; 5577c609719bSwdenk Read the source, Luke; 55786c3fef28SJerry Van Baren /* find . -name "*.[chS]" | xargs grep -i <keyword> */ 5579c609719bSwdenk } 5580c609719bSwdenk 55816c3fef28SJerry Van Baren if (available_money > toLocalCurrency ($2500)) 55826c3fef28SJerry Van Baren Buy a BDI3000; 55836c3fef28SJerry Van Baren else 5584c609719bSwdenk Add a lot of aggravation and time; 5585c609719bSwdenk 55866c3fef28SJerry Van Baren if (a similar board exists) { /* hopefully... */ 55876c3fef28SJerry Van Baren cp -a board/<similar> board/<myboard> 55886c3fef28SJerry Van Baren cp include/configs/<similar>.h include/configs/<myboard>.h 55896c3fef28SJerry Van Baren } else { 5590c609719bSwdenk Create your own board support subdirectory; 55916c3fef28SJerry Van Baren Create your own board include/configs/<myboard>.h file; 55926c3fef28SJerry Van Baren } 55936c3fef28SJerry Van Baren Edit new board/<myboard> files 55946c3fef28SJerry Van Baren Edit new include/configs/<myboard>.h 5595c609719bSwdenk 55966c3fef28SJerry Van Baren while (!accepted) { 5597c609719bSwdenk while (!running) { 5598c609719bSwdenk do { 5599c609719bSwdenk Add / modify source code; 5600c609719bSwdenk } until (compiles); 5601c609719bSwdenk Debug; 5602c609719bSwdenk if (clueless) 5603c609719bSwdenk email("Hi, I am having problems..."); 5604c609719bSwdenk } 56056c3fef28SJerry Van Baren Send patch file to the U-Boot email list; 56066c3fef28SJerry Van Baren if (reasonable critiques) 56076c3fef28SJerry Van Baren Incorporate improvements from email list code review; 56086c3fef28SJerry Van Baren else 56096c3fef28SJerry Van Baren Defend code as written; 56106c3fef28SJerry Van Baren } 5611c609719bSwdenk 5612c609719bSwdenk return 0; 5613c609719bSwdenk} 5614c609719bSwdenk 5615c609719bSwdenkvoid no_more_time (int sig) 5616c609719bSwdenk{ 5617c609719bSwdenk hire_a_guru(); 5618c609719bSwdenk} 5619c609719bSwdenk 5620c609719bSwdenk 5621c609719bSwdenkCoding Standards: 5622c609719bSwdenk----------------- 5623c609719bSwdenk 5624c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel 56252c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script 56267ca9296eSWolfgang Denk"scripts/Lindent" in your Linux kernel source directory. 5627c609719bSwdenk 56282c051651SDetlev ZundelSource files originating from a different project (for example the 56292c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not 56302c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those 56312c051651SDetlev Zundelsources. 56322c051651SDetlev Zundel 56332c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in 56342c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//) 56352c051651SDetlev Zundelin your code. 5636c609719bSwdenk 5637c178d3daSwdenkPlease also stick to the following formatting rules: 5638180d3f74Swdenk- remove any trailing white space 56397ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces 5640180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds 56417ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files 5642180d3f74Swdenk- do not add trailing empty lines to source files 5643180d3f74Swdenk 5644c609719bSwdenkSubmissions which do not conform to the standards may be returned 5645c609719bSwdenkwith a request to reformat the changes. 5646c609719bSwdenk 5647c609719bSwdenk 5648c609719bSwdenkSubmitting Patches: 5649c609719bSwdenk------------------- 5650c609719bSwdenk 5651c609719bSwdenkSince the number of patches for U-Boot is growing, we need to 5652c609719bSwdenkestablish some rules. Submissions which do not conform to these rules 5653c609719bSwdenkmay be rejected, even when they contain important and valuable stuff. 5654c609719bSwdenk 56550d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details. 5656218ca724SWolfgang Denk 56570668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>; 56580668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot 56590668236bSWolfgang Denk 5660c609719bSwdenkWhen you send a patch, please include the following information with 5661c609719bSwdenkit: 5662c609719bSwdenk 5663c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes 5664c609719bSwdenk this bug. Please try to include a way of demonstrating that the 5665c609719bSwdenk patch actually fixes something. 5666c609719bSwdenk 5667c609719bSwdenk* For new features: a description of the feature and your 5668c609719bSwdenk implementation. 5669c609719bSwdenk 5670c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch) 5671c609719bSwdenk 5672c609719bSwdenk* For major contributions, your entry to the CREDITS file 5673c609719bSwdenk 5674c609719bSwdenk* When you add support for a new board, don't forget to add this 56757ca9296eSWolfgang Denk board to the MAINTAINERS file, too. 5676c609719bSwdenk 5677c609719bSwdenk* If your patch adds new configuration options, don't forget to 5678c609719bSwdenk document these in the README file. 5679c609719bSwdenk 5680218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly* 5681218ca724SWolfgang Denk recommended) you can easily generate the patch using the 56827ca9296eSWolfgang Denk "git format-patch". If you then use "git send-email" to send it to 5683218ca724SWolfgang Denk the U-Boot mailing list, you will avoid most of the common problems 5684218ca724SWolfgang Denk with some other mail clients. 5685c609719bSwdenk 5686218ca724SWolfgang Denk If you cannot use git, use "diff -purN OLD NEW". If your version of 5687218ca724SWolfgang Denk diff does not support these options, then get the latest version of 5688218ca724SWolfgang Denk GNU diff. 56896dff5529Swdenk 5690218ca724SWolfgang Denk The current directory when running this command shall be the parent 5691218ca724SWolfgang Denk directory of the U-Boot source tree (i. e. please make sure that 5692218ca724SWolfgang Denk your patch includes sufficient directory information for the 5693218ca724SWolfgang Denk affected files). 5694218ca724SWolfgang Denk 5695218ca724SWolfgang Denk We prefer patches as plain text. MIME attachments are discouraged, 5696218ca724SWolfgang Denk and compressed attachments must not be used. 5697c609719bSwdenk 569852f52c14Swdenk* If one logical set of modifications affects or creates several 569952f52c14Swdenk files, all these changes shall be submitted in a SINGLE patch file. 570052f52c14Swdenk 570152f52c14Swdenk* Changesets that contain different, unrelated modifications shall be 570252f52c14Swdenk submitted as SEPARATE patches, one patch per changeset. 570352f52c14Swdenk 570452f52c14Swdenk 5705c609719bSwdenkNotes: 5706c609719bSwdenk 5707c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched 5708c609719bSwdenk source tree and make sure that no errors or warnings are reported 5709c609719bSwdenk for any of the boards. 5710c609719bSwdenk 5711c609719bSwdenk* Keep your modifications to the necessary minimum: A patch 5712c609719bSwdenk containing several unrelated changes or arbitrary reformats will be 5713c609719bSwdenk returned with a request to re-formatting / split it. 5714c609719bSwdenk 5715c609719bSwdenk* If you modify existing code, make sure that your new code does not 5716c609719bSwdenk add to the memory footprint of the code ;-) Small is beautiful! 5717c609719bSwdenk When adding new features, these should compile conditionally only 5718c609719bSwdenk (using #ifdef), and the resulting code with the new feature 5719c609719bSwdenk disabled must not need more memory than the old code without your 5720c609719bSwdenk modification. 572190dc6704Swdenk 57220668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the 57230668236bSWolfgang Denk u-boot mailing list. Bigger patches will be moderated. If they are 57240668236bSWolfgang Denk reasonable and not too big, they will be acknowledged. But patches 57250668236bSWolfgang Denk bigger than the size limit should be avoided. 5726