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 57c609719bSwdenk 58c609719bSwdenkWhere to get help: 59c609719bSwdenk================== 60c609719bSwdenk 61c609719bSwdenkIn case you have questions about, problems with or contributions for 62c609719bSwdenkU-Boot you should send a message to the U-Boot mailing list at 630c32565fSPeter Tyser<u-boot@lists.denx.de>. There is also an archive of previous traffic 640c32565fSPeter Tyseron the mailing list - please search the archive before asking FAQ's. 650c32565fSPeter TyserPlease see http://lists.denx.de/pipermail/u-boot and 660c32565fSPeter Tyserhttp://dir.gmane.org/gmane.comp.boot-loaders.u-boot 67c609719bSwdenk 68c609719bSwdenk 69218ca724SWolfgang DenkWhere to get source code: 70218ca724SWolfgang Denk========================= 71218ca724SWolfgang Denk 72218ca724SWolfgang DenkThe U-Boot source code is maintained in the git repository at 73218ca724SWolfgang Denkgit://www.denx.de/git/u-boot.git ; you can browse it online at 74218ca724SWolfgang Denkhttp://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary 75218ca724SWolfgang Denk 76218ca724SWolfgang DenkThe "snapshot" links on this page allow you to download tarballs of 7711ccc33fSMarcel Ziswilerany version you might be interested in. Official releases are also 78218ca724SWolfgang Denkavailable for FTP download from the ftp://ftp.denx.de/pub/u-boot/ 79218ca724SWolfgang Denkdirectory. 80218ca724SWolfgang Denk 81d4ee711dSAnatolij GustschinPre-built (and tested) images are available from 82218ca724SWolfgang Denkftp://ftp.denx.de/pub/u-boot/images/ 83218ca724SWolfgang Denk 84218ca724SWolfgang Denk 85c609719bSwdenkWhere we come from: 86c609719bSwdenk=================== 87c609719bSwdenk 88c609719bSwdenk- start from 8xxrom sources 8924ee89b9Swdenk- create PPCBoot project (http://sourceforge.net/projects/ppcboot) 90c609719bSwdenk- clean up code 91c609719bSwdenk- make it easier to add custom boards 92c609719bSwdenk- make it possible to add other [PowerPC] CPUs 93c609719bSwdenk- extend functions, especially: 94c609719bSwdenk * Provide extended interface to Linux boot loader 95c609719bSwdenk * S-Record download 96c609719bSwdenk * network boot 9711ccc33fSMarcel Ziswiler * PCMCIA / CompactFlash / ATA disk / SCSI ... boot 9824ee89b9Swdenk- create ARMBoot project (http://sourceforge.net/projects/armboot) 99c609719bSwdenk- add other CPU families (starting with ARM) 10024ee89b9Swdenk- create U-Boot project (http://sourceforge.net/projects/u-boot) 1010d28f34bSMagnus Lilja- current project page: see http://www.denx.de/wiki/U-Boot 10224ee89b9Swdenk 10324ee89b9Swdenk 10424ee89b9SwdenkNames and Spelling: 10524ee89b9Swdenk=================== 10624ee89b9Swdenk 10724ee89b9SwdenkThe "official" name of this project is "Das U-Boot". The spelling 10824ee89b9Swdenk"U-Boot" shall be used in all written text (documentation, comments 10924ee89b9Swdenkin source files etc.). Example: 11024ee89b9Swdenk 11124ee89b9Swdenk This is the README file for the U-Boot project. 11224ee89b9Swdenk 11324ee89b9SwdenkFile names etc. shall be based on the string "u-boot". Examples: 11424ee89b9Swdenk 11524ee89b9Swdenk include/asm-ppc/u-boot.h 11624ee89b9Swdenk 11724ee89b9Swdenk #include <asm/u-boot.h> 11824ee89b9Swdenk 11924ee89b9SwdenkVariable names, preprocessor constants etc. shall be either based on 12024ee89b9Swdenkthe string "u_boot" or on "U_BOOT". Example: 12124ee89b9Swdenk 12224ee89b9Swdenk U_BOOT_VERSION u_boot_logo 12324ee89b9Swdenk IH_OS_U_BOOT u_boot_hush_start 124c609719bSwdenk 125c609719bSwdenk 12693f19cc0SwdenkVersioning: 12793f19cc0Swdenk=========== 12893f19cc0Swdenk 129360d883aSThomas WeberStarting with the release in October 2008, the names of the releases 130360d883aSThomas Weberwere changed from numerical release numbers without deeper meaning 131360d883aSThomas Weberinto a time stamp based numbering. Regular releases are identified by 132360d883aSThomas Webernames consisting of the calendar year and month of the release date. 133360d883aSThomas WeberAdditional fields (if present) indicate release candidates or bug fix 134360d883aSThomas Weberreleases in "stable" maintenance trees. 13593f19cc0Swdenk 136360d883aSThomas WeberExamples: 137360d883aSThomas Weber U-Boot v2009.11 - Release November 2009 138360d883aSThomas Weber U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree 139360d883aSThomas Weber U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release 14093f19cc0Swdenk 14193f19cc0Swdenk 142c609719bSwdenkDirectory Hierarchy: 143c609719bSwdenk==================== 144c609719bSwdenk 1458d321b81SPeter Tyser/arch Architecture specific files 1468d321b81SPeter Tyser /arm Files generic to ARM architecture 1478d321b81SPeter Tyser /cpu CPU specific files 1488d321b81SPeter Tyser /arm720t Files specific to ARM 720 CPUs 1498d321b81SPeter Tyser /arm920t Files specific to ARM 920 CPUs 1506eb0921aSAndreas Bießmann /at91 Files specific to Atmel AT91RM9200 CPU 1518d321b81SPeter Tyser /imx Files specific to Freescale MC9328 i.MX CPUs 1528d321b81SPeter Tyser /s3c24x0 Files specific to Samsung S3C24X0 CPUs 1538d321b81SPeter Tyser /arm925t Files specific to ARM 925 CPUs 1548d321b81SPeter Tyser /arm926ejs Files specific to ARM 926 CPUs 1558d321b81SPeter Tyser /arm1136 Files specific to ARM 1136 CPUs 1568d321b81SPeter Tyser /ixp Files specific to Intel XScale IXP CPUs 1578d321b81SPeter Tyser /pxa Files specific to Intel XScale PXA CPUs 1588d321b81SPeter Tyser /s3c44b0 Files specific to Samsung S3C44B0 CPUs 1598d321b81SPeter Tyser /sa1100 Files specific to Intel StrongARM SA1100 CPUs 1608d321b81SPeter Tyser /lib Architecture specific library files 1618d321b81SPeter Tyser /avr32 Files generic to AVR32 architecture 1628d321b81SPeter Tyser /cpu CPU specific files 1638d321b81SPeter Tyser /lib Architecture specific library files 1648d321b81SPeter Tyser /blackfin Files generic to Analog Devices Blackfin architecture 1658d321b81SPeter Tyser /cpu CPU specific files 1668d321b81SPeter Tyser /lib Architecture specific library files 167fea25720SGraeme Russ /x86 Files generic to x86 architecture 1688d321b81SPeter Tyser /cpu CPU specific files 1698d321b81SPeter Tyser /lib Architecture specific library files 1708d321b81SPeter Tyser /m68k Files generic to m68k architecture 1718d321b81SPeter Tyser /cpu CPU specific files 1728d321b81SPeter Tyser /mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs 1738d321b81SPeter Tyser /mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs 1748d321b81SPeter Tyser /mcf532x Files specific to Freescale ColdFire MCF5329 CPUs 1758d321b81SPeter Tyser /mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs 1768d321b81SPeter Tyser /mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs 1778d321b81SPeter Tyser /lib Architecture specific library files 1788d321b81SPeter Tyser /microblaze Files generic to microblaze architecture 1798d321b81SPeter Tyser /cpu CPU specific files 1808d321b81SPeter Tyser /lib Architecture specific library files 1818d321b81SPeter Tyser /mips Files generic to MIPS architecture 1828d321b81SPeter Tyser /cpu CPU specific files 18392bbd64eSDaniel Schwierzeck /mips32 Files specific to MIPS32 CPUs 18480421fccSXiangfu Liu /xburst Files specific to Ingenic XBurst CPUs 1858d321b81SPeter Tyser /lib Architecture specific library files 186afc1ce82SMacpaul Lin /nds32 Files generic to NDS32 architecture 187afc1ce82SMacpaul Lin /cpu CPU specific files 188afc1ce82SMacpaul Lin /n1213 Files specific to Andes Technology N1213 CPUs 189afc1ce82SMacpaul Lin /lib Architecture specific library files 1908d321b81SPeter Tyser /nios2 Files generic to Altera NIOS2 architecture 1918d321b81SPeter Tyser /cpu CPU specific files 1928d321b81SPeter Tyser /lib Architecture specific library files 193a47a12beSStefan Roese /powerpc Files generic to PowerPC architecture 1948d321b81SPeter Tyser /cpu CPU specific files 1958d321b81SPeter Tyser /74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs 1968d321b81SPeter Tyser /mpc5xx Files specific to Freescale MPC5xx CPUs 1978d321b81SPeter Tyser /mpc5xxx Files specific to Freescale MPC5xxx CPUs 1988d321b81SPeter Tyser /mpc8xx Files specific to Freescale MPC8xx CPUs 1998d321b81SPeter Tyser /mpc8220 Files specific to Freescale MPC8220 CPUs 2008d321b81SPeter Tyser /mpc824x Files specific to Freescale MPC824x CPUs 2018d321b81SPeter Tyser /mpc8260 Files specific to Freescale MPC8260 CPUs 2028d321b81SPeter Tyser /mpc85xx Files specific to Freescale MPC85xx CPUs 2038d321b81SPeter Tyser /ppc4xx Files specific to AMCC PowerPC 4xx CPUs 2048d321b81SPeter Tyser /lib Architecture specific library files 2058d321b81SPeter Tyser /sh Files generic to SH architecture 2068d321b81SPeter Tyser /cpu CPU specific files 2078d321b81SPeter Tyser /sh2 Files specific to sh2 CPUs 2088d321b81SPeter Tyser /sh3 Files specific to sh3 CPUs 2098d321b81SPeter Tyser /sh4 Files specific to sh4 CPUs 2108d321b81SPeter Tyser /lib Architecture specific library files 2118d321b81SPeter Tyser /sparc Files generic to SPARC architecture 2128d321b81SPeter Tyser /cpu CPU specific files 2138d321b81SPeter Tyser /leon2 Files specific to Gaisler LEON2 SPARC CPU 2148d321b81SPeter Tyser /leon3 Files specific to Gaisler LEON3 SPARC CPU 2158d321b81SPeter Tyser /lib Architecture specific library files 2168d321b81SPeter Tyser/api Machine/arch independent API for external apps 2178d321b81SPeter Tyser/board Board dependent files 2188d321b81SPeter Tyser/common Misc architecture independent functions 2198d321b81SPeter Tyser/disk Code for disk drive partition handling 2208d321b81SPeter Tyser/doc Documentation (don't expect too much) 2218d321b81SPeter Tyser/drivers Commonly used device drivers 2228d321b81SPeter Tyser/examples Example code for standalone applications, etc. 2238d321b81SPeter Tyser/fs Filesystem code (cramfs, ext2, jffs2, etc.) 2248d321b81SPeter Tyser/include Header Files 2258d321b81SPeter Tyser/lib Files generic to all architectures 2268d321b81SPeter Tyser /libfdt Library files to support flattened device trees 2278d321b81SPeter Tyser /lzma Library files to support LZMA decompression 2288d321b81SPeter Tyser /lzo Library files to support LZO decompression 2298d321b81SPeter Tyser/net Networking code 2308d321b81SPeter Tyser/post Power On Self Test 2318d321b81SPeter Tyser/rtc Real Time Clock drivers 2328d321b81SPeter Tyser/tools Tools to build S-Record or U-Boot images, etc. 233c609719bSwdenk 234c609719bSwdenkSoftware Configuration: 235c609719bSwdenk======================= 236c609719bSwdenk 237c609719bSwdenkConfiguration is usually done using C preprocessor defines; the 238c609719bSwdenkrationale behind that is to avoid dead code whenever possible. 239c609719bSwdenk 240c609719bSwdenkThere are two classes of configuration variables: 241c609719bSwdenk 242c609719bSwdenk* Configuration _OPTIONS_: 243c609719bSwdenk These are selectable by the user and have names beginning with 244c609719bSwdenk "CONFIG_". 245c609719bSwdenk 246c609719bSwdenk* Configuration _SETTINGS_: 247c609719bSwdenk These depend on the hardware etc. and should not be meddled with if 248c609719bSwdenk you don't know what you're doing; they have names beginning with 2496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD "CONFIG_SYS_". 250c609719bSwdenk 251c609719bSwdenkLater we will add a configuration tool - probably similar to or even 252c609719bSwdenkidentical to what's used for the Linux kernel. Right now, we have to 253c609719bSwdenkdo the configuration by hand, which means creating some symbolic 254c609719bSwdenklinks and editing some configuration files. We use the TQM8xxL boards 255c609719bSwdenkas an example here. 256c609719bSwdenk 257c609719bSwdenk 258c609719bSwdenkSelection of Processor Architecture and Board Type: 259c609719bSwdenk--------------------------------------------------- 260c609719bSwdenk 261c609719bSwdenkFor all supported boards there are ready-to-use default 262c609719bSwdenkconfigurations available; just type "make <board_name>_config". 263c609719bSwdenk 264c609719bSwdenkExample: For a TQM823L module type: 265c609719bSwdenk 266c609719bSwdenk cd u-boot 267c609719bSwdenk make TQM823L_config 268c609719bSwdenk 26911ccc33fSMarcel ZiswilerFor the Cogent platform, you need to specify the CPU type as well; 270c609719bSwdenke.g. "make cogent_mpc8xx_config". And also configure the cogent 271c609719bSwdenkdirectory according to the instructions in cogent/README. 272c609719bSwdenk 273c609719bSwdenk 274c609719bSwdenkConfiguration Options: 275c609719bSwdenk---------------------- 276c609719bSwdenk 277c609719bSwdenkConfiguration depends on the combination of board and CPU type; all 278c609719bSwdenksuch information is kept in a configuration file 279c609719bSwdenk"include/configs/<board_name>.h". 280c609719bSwdenk 281c609719bSwdenkExample: For a TQM823L module, all configuration settings are in 282c609719bSwdenk"include/configs/TQM823L.h". 283c609719bSwdenk 284c609719bSwdenk 2857f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux 2867f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to 2877f6c2cbcSwdenkbuild a config tool - later. 2887f6c2cbcSwdenk 2897f6c2cbcSwdenk 290c609719bSwdenkThe following options need to be configured: 291c609719bSwdenk 2922628114eSKim Phillips- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX. 293c609719bSwdenk 2942628114eSKim Phillips- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS. 2956ccec449SWolfgang Denk 2966ccec449SWolfgang Denk- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined) 29709ea0de0SHaavard Skinnemoen Define exactly one, e.g. CONFIG_ATSTK1002 298c609719bSwdenk 299c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined) 300c609719bSwdenk Define exactly one of 301c609719bSwdenk CONFIG_CMA286_60_OLD 302c609719bSwdenk--- FIXME --- not tested yet: 303c609719bSwdenk CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P, 304c609719bSwdenk CONFIG_CMA287_23, CONFIG_CMA287_50 305c609719bSwdenk 306c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined) 307c609719bSwdenk Define exactly one of 308c609719bSwdenk CONFIG_CMA101, CONFIG_CMA102 309c609719bSwdenk 310c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined) 311c609719bSwdenk Define one or more of 312c609719bSwdenk CONFIG_CMA302 313c609719bSwdenk 314c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined) 315c609719bSwdenk Define one or more of 316c609719bSwdenk CONFIG_LCD_HEARTBEAT - update a character position on 31711ccc33fSMarcel Ziswiler the LCD display every second with 318c609719bSwdenk a "rotator" |\-/|\-/ 319c609719bSwdenk 3202535d602Swdenk- Board flavour: (if CONFIG_MPC8260ADS is defined) 3212535d602Swdenk CONFIG_ADSTYPE 3222535d602Swdenk Possible values are: 3236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8260ADS - original MPC8260ADS 3246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8266ADS - MPC8266ADS 3256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR 3266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8272ADS - MPC8272ADS 3272535d602Swdenk 328cf946c6dSLei Wen- Marvell Family Member 329cf946c6dSLei Wen CONFIG_SYS_MVFS - define it if you want to enable 330cf946c6dSLei Wen multiple fs option at one time 331cf946c6dSLei Wen for marvell soc family 332cf946c6dSLei Wen 333c609719bSwdenk- MPC824X Family Member (if CONFIG_MPC824X is defined) 334c609719bSwdenk Define exactly one of 335c609719bSwdenk CONFIG_MPC8240, CONFIG_MPC8245 336c609719bSwdenk 33711ccc33fSMarcel Ziswiler- 8xx CPU Options: (if using an MPC8xx CPU) 33866ca92a5Swdenk CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if 33966ca92a5Swdenk get_gclk_freq() cannot work 3405da627a4Swdenk e.g. if there is no 32KHz 3415da627a4Swdenk reference PIT/RTC clock 34266ca92a5Swdenk CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK 34366ca92a5Swdenk or XTAL/EXTAL) 344c609719bSwdenk 34566ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU): 3466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8xx_CPUCLK_MIN 3476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8xx_CPUCLK_MAX 34866ca92a5Swdenk CONFIG_8xx_CPUCLK_DEFAULT 34975d1ea7fSwdenk See doc/README.MPC866 35075d1ea7fSwdenk 3516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MEASURE_CPUCLK 35275d1ea7fSwdenk 35375d1ea7fSwdenk Define this to measure the actual CPU clock instead 35475d1ea7fSwdenk of relying on the correctness of the configured 35575d1ea7fSwdenk values. Mostly useful for board bringup to make sure 35675d1ea7fSwdenk the PLL is locked at the intended frequency. Note 35775d1ea7fSwdenk that this requires a (stable) reference clock (32 kHz 3586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD RTC clock or CONFIG_SYS_8XX_XIN) 35975d1ea7fSwdenk 360506f3918SHeiko Schocher CONFIG_SYS_DELAYED_ICACHE 361506f3918SHeiko Schocher 362506f3918SHeiko Schocher Define this option if you want to enable the 363506f3918SHeiko Schocher ICache only when Code runs from RAM. 364506f3918SHeiko Schocher 36566412c63SKumar Gala- 85xx CPU Options: 36666412c63SKumar Gala CONFIG_SYS_FSL_TBCLK_DIV 36766412c63SKumar Gala 36866412c63SKumar Gala Defines the core time base clock divider ratio compared to the 36966412c63SKumar Gala system clock. On most PQ3 devices this is 8, on newer QorIQ 37066412c63SKumar Gala devices it can be 16 or 32. The ratio varies from SoC to Soc. 37166412c63SKumar Gala 3728f29084aSKumar Gala CONFIG_SYS_FSL_PCIE_COMPAT 3738f29084aSKumar Gala 3748f29084aSKumar Gala Defines the string to utilize when trying to match PCIe device 3758f29084aSKumar Gala tree nodes for the given platform. 3768f29084aSKumar Gala 377afa6b551SPrabhakar Kushwaha CONFIG_SYS_PPC_E500_DEBUG_TLB 378afa6b551SPrabhakar Kushwaha 379afa6b551SPrabhakar Kushwaha Enables a temporary TLB entry to be used during boot to work 380afa6b551SPrabhakar Kushwaha around limitations in e500v1 and e500v2 external debugger 381afa6b551SPrabhakar Kushwaha support. This reduces the portions of the boot code where 382afa6b551SPrabhakar Kushwaha breakpoints and single stepping do not work. The value of this 383afa6b551SPrabhakar Kushwaha symbol should be set to the TLB1 entry to be used for this 384afa6b551SPrabhakar Kushwaha purpose. 385afa6b551SPrabhakar Kushwaha 38633eee330SScott Wood CONFIG_SYS_FSL_ERRATUM_A004510 38733eee330SScott Wood 38833eee330SScott Wood Enables a workaround for erratum A004510. If set, 38933eee330SScott Wood then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and 39033eee330SScott Wood CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set. 39133eee330SScott Wood 39233eee330SScott Wood CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV 39333eee330SScott Wood CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional) 39433eee330SScott Wood 39533eee330SScott Wood Defines one or two SoC revisions (low 8 bits of SVR) 39633eee330SScott Wood for which the A004510 workaround should be applied. 39733eee330SScott Wood 39833eee330SScott Wood The rest of SVR is either not relevant to the decision 39933eee330SScott Wood of whether the erratum is present (e.g. p2040 versus 40033eee330SScott Wood p2041) or is implied by the build target, which controls 40133eee330SScott Wood whether CONFIG_SYS_FSL_ERRATUM_A004510 is set. 40233eee330SScott Wood 40333eee330SScott Wood See Freescale App Note 4493 for more information about 40433eee330SScott Wood this erratum. 40533eee330SScott Wood 40633eee330SScott Wood CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY 40733eee330SScott Wood 40833eee330SScott Wood This is the value to write into CCSR offset 0x18600 40933eee330SScott Wood according to the A004510 workaround. 41033eee330SScott Wood 4116cb461b4SDaniel Schwierzeck- Generic CPU options: 4126cb461b4SDaniel Schwierzeck CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN 4136cb461b4SDaniel Schwierzeck 4146cb461b4SDaniel Schwierzeck Defines the endianess of the CPU. Implementation of those 4156cb461b4SDaniel Schwierzeck values is arch specific. 4166cb461b4SDaniel Schwierzeck 4170b953ffcSMarkus Klotzbuecher- Intel Monahans options: 4186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO 4190b953ffcSMarkus Klotzbuecher 4200b953ffcSMarkus Klotzbuecher Defines the Monahans run mode to oscillator 4210b953ffcSMarkus Klotzbuecher ratio. Valid values are 8, 16, 24, 31. The core 4220b953ffcSMarkus Klotzbuecher frequency is this value multiplied by 13 MHz. 4230b953ffcSMarkus Klotzbuecher 4246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO 4250b953ffcSMarkus Klotzbuecher 4260b953ffcSMarkus Klotzbuecher Defines the Monahans turbo mode to oscillator 4270b953ffcSMarkus Klotzbuecher ratio. Valid values are 1 (default if undefined) and 4280b953ffcSMarkus Klotzbuecher 2. The core frequency as calculated above is multiplied 4290b953ffcSMarkus Klotzbuecher by this value. 4300b953ffcSMarkus Klotzbuecher 43192bbd64eSDaniel Schwierzeck- MIPS CPU options: 43292bbd64eSDaniel Schwierzeck CONFIG_SYS_INIT_SP_OFFSET 43392bbd64eSDaniel Schwierzeck 43492bbd64eSDaniel Schwierzeck Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack 43592bbd64eSDaniel Schwierzeck pointer. This is needed for the temporary stack before 43692bbd64eSDaniel Schwierzeck relocation. 43792bbd64eSDaniel Schwierzeck 43892bbd64eSDaniel Schwierzeck CONFIG_SYS_MIPS_CACHE_MODE 43992bbd64eSDaniel Schwierzeck 44092bbd64eSDaniel Schwierzeck Cache operation mode for the MIPS CPU. 44192bbd64eSDaniel Schwierzeck See also arch/mips/include/asm/mipsregs.h. 44292bbd64eSDaniel Schwierzeck Possible values are: 44392bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_NO_WA 44492bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_WA 44592bbd64eSDaniel Schwierzeck CONF_CM_UNCACHED 44692bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_NONCOHERENT 44792bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_CE 44892bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_COW 44992bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_CUW 45092bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_ACCELERATED 45192bbd64eSDaniel Schwierzeck 45292bbd64eSDaniel Schwierzeck CONFIG_SYS_XWAY_EBU_BOOTCFG 45392bbd64eSDaniel Schwierzeck 45492bbd64eSDaniel Schwierzeck Special option for Lantiq XWAY SoCs for booting from NOR flash. 45592bbd64eSDaniel Schwierzeck See also arch/mips/cpu/mips32/start.S. 45692bbd64eSDaniel Schwierzeck 45792bbd64eSDaniel Schwierzeck CONFIG_XWAY_SWAP_BYTES 45892bbd64eSDaniel Schwierzeck 45992bbd64eSDaniel Schwierzeck Enable compilation of tools/xway-swap-bytes needed for Lantiq 46092bbd64eSDaniel Schwierzeck XWAY SoCs for booting from NOR flash. The U-Boot image needs to 46192bbd64eSDaniel Schwierzeck be swapped if a flash programmer is used. 46292bbd64eSDaniel Schwierzeck 463b67d8816SChristian Riesch- ARM options: 464b67d8816SChristian Riesch CONFIG_SYS_EXCEPTION_VECTORS_HIGH 465b67d8816SChristian Riesch 466b67d8816SChristian Riesch Select high exception vectors of the ARM core, e.g., do not 467b67d8816SChristian Riesch clear the V bit of the c1 register of CP15. 468b67d8816SChristian Riesch 4695356f545SAneesh V CONFIG_SYS_THUMB_BUILD 4705356f545SAneesh V 4715356f545SAneesh V Use this flag to build U-Boot using the Thumb instruction 4725356f545SAneesh V set for ARM architectures. Thumb instruction set provides 4735356f545SAneesh V better code density. For ARM architectures that support 4745356f545SAneesh V Thumb2 this flag will result in Thumb2 code generated by 4755356f545SAneesh V GCC. 4765356f545SAneesh V 4775da627a4Swdenk- Linux Kernel Interface: 478c609719bSwdenk CONFIG_CLOCKS_IN_MHZ 479c609719bSwdenk 480c609719bSwdenk U-Boot stores all clock information in Hz 481c609719bSwdenk internally. For binary compatibility with older Linux 482c609719bSwdenk kernels (which expect the clocks passed in the 483c609719bSwdenk bd_info data to be in MHz) the environment variable 484c609719bSwdenk "clocks_in_mhz" can be defined so that U-Boot 485c609719bSwdenk converts clock data to MHZ before passing it to the 486c609719bSwdenk Linux kernel. 487c609719bSwdenk When CONFIG_CLOCKS_IN_MHZ is defined, a definition of 488c609719bSwdenk "clocks_in_mhz=1" is automatically included in the 489c609719bSwdenk default environment. 490c609719bSwdenk 4915da627a4Swdenk CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only] 4925da627a4Swdenk 49311ccc33fSMarcel Ziswiler When transferring memsize parameter to linux, some versions 4945da627a4Swdenk expect it to be in bytes, others in MB. 4955da627a4Swdenk Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes. 4965da627a4Swdenk 497fec6d9eeSGerald Van Baren CONFIG_OF_LIBFDT 498f57f70aaSWolfgang Denk 499f57f70aaSWolfgang Denk New kernel versions are expecting firmware settings to be 500213bf8c8SGerald Van Baren passed using flattened device trees (based on open firmware 501213bf8c8SGerald Van Baren concepts). 502213bf8c8SGerald Van Baren 503213bf8c8SGerald Van Baren CONFIG_OF_LIBFDT 504213bf8c8SGerald Van Baren * New libfdt-based support 505213bf8c8SGerald Van Baren * Adds the "fdt" command 5063bb342fcSKim Phillips * The bootm command automatically updates the fdt 507213bf8c8SGerald Van Baren 508b55ae402SMarcel Ziswiler OF_CPU - The proper name of the cpus node (only required for 509b55ae402SMarcel Ziswiler MPC512X and MPC5xxx based boards). 510b55ae402SMarcel Ziswiler OF_SOC - The proper name of the soc node (only required for 511b55ae402SMarcel Ziswiler MPC512X and MPC5xxx based boards). 512f57f70aaSWolfgang Denk OF_TBCLK - The timebase frequency. 513c2871f03SKumar Gala OF_STDOUT_PATH - The path to the console device 514f57f70aaSWolfgang Denk 51511ccc33fSMarcel Ziswiler boards with QUICC Engines require OF_QE to set UCC MAC 51611ccc33fSMarcel Ziswiler addresses 5173bb342fcSKim Phillips 5184e253137SKumar Gala CONFIG_OF_BOARD_SETUP 5194e253137SKumar Gala 5204e253137SKumar Gala Board code has addition modification that it wants to make 5214e253137SKumar Gala to the flat device tree before handing it off to the kernel 5226705d81eSwdenk 5230267768eSMatthew McClintock CONFIG_OF_BOOT_CPU 5240267768eSMatthew McClintock 52511ccc33fSMarcel Ziswiler This define fills in the correct boot CPU in the boot 5260267768eSMatthew McClintock param header, the default value is zero if undefined. 5270267768eSMatthew McClintock 5283887c3fbSHeiko Schocher CONFIG_OF_IDE_FIXUP 5293887c3fbSHeiko Schocher 5303887c3fbSHeiko Schocher U-Boot can detect if an IDE device is present or not. 5313887c3fbSHeiko Schocher If not, and this new config option is activated, U-Boot 5323887c3fbSHeiko Schocher removes the ATA node from the DTS before booting Linux, 5333887c3fbSHeiko Schocher so the Linux IDE driver does not probe the device and 5343887c3fbSHeiko Schocher crash. This is needed for buggy hardware (uc101) where 5353887c3fbSHeiko Schocher no pull down resistor is connected to the signal IDE5V_DD7. 5363887c3fbSHeiko Schocher 5377eb29398SIgor Grinberg CONFIG_MACH_TYPE [relevant for ARM only][mandatory] 5387eb29398SIgor Grinberg 5397eb29398SIgor Grinberg This setting is mandatory for all boards that have only one 5407eb29398SIgor Grinberg machine type and must be used to specify the machine type 5417eb29398SIgor Grinberg number as it appears in the ARM machine registry 5427eb29398SIgor Grinberg (see http://www.arm.linux.org.uk/developer/machines/). 5437eb29398SIgor Grinberg Only boards that have multiple machine types supported 5447eb29398SIgor Grinberg in a single configuration file and the machine type is 5457eb29398SIgor Grinberg runtime discoverable, do not have to use this setting. 5467eb29398SIgor Grinberg 5470b2f4ecaSNiklaus Giger- vxWorks boot parameters: 5480b2f4ecaSNiklaus Giger 5490b2f4ecaSNiklaus Giger bootvx constructs a valid bootline using the following 5500b2f4ecaSNiklaus Giger environments variables: bootfile, ipaddr, serverip, hostname. 5510b2f4ecaSNiklaus Giger It loads the vxWorks image pointed bootfile. 5520b2f4ecaSNiklaus Giger 5530b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name 5540b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address 5550b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server 5560b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters 5570b2f4ecaSNiklaus Giger 5580b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_ADD_PARAMS 5590b2f4ecaSNiklaus Giger 5600b2f4ecaSNiklaus Giger Add it at the end of the bootline. E.g "u=username pw=secret" 5610b2f4ecaSNiklaus Giger 5620b2f4ecaSNiklaus Giger Note: If a "bootargs" environment is defined, it will overwride 5630b2f4ecaSNiklaus Giger the defaults discussed just above. 5640b2f4ecaSNiklaus Giger 5652c451f78SAneesh V- Cache Configuration: 5662c451f78SAneesh V CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot 5672c451f78SAneesh V CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot 5682c451f78SAneesh V CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot 5692c451f78SAneesh V 57093bc2193SAneesh V- Cache Configuration for ARM: 57193bc2193SAneesh V CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache 57293bc2193SAneesh V controller 57393bc2193SAneesh V CONFIG_SYS_PL310_BASE - Physical base address of PL310 57493bc2193SAneesh V controller register space 57593bc2193SAneesh V 5766705d81eSwdenk- Serial Ports: 57748d0192fSAndreas Engel CONFIG_PL010_SERIAL 5786705d81eSwdenk 5796705d81eSwdenk Define this if you want support for Amba PrimeCell PL010 UARTs. 5806705d81eSwdenk 58148d0192fSAndreas Engel CONFIG_PL011_SERIAL 5826705d81eSwdenk 5836705d81eSwdenk Define this if you want support for Amba PrimeCell PL011 UARTs. 5846705d81eSwdenk 5856705d81eSwdenk CONFIG_PL011_CLOCK 5866705d81eSwdenk 5876705d81eSwdenk If you have Amba PrimeCell PL011 UARTs, set this variable to 5886705d81eSwdenk the clock speed of the UARTs. 5896705d81eSwdenk 5906705d81eSwdenk CONFIG_PL01x_PORTS 5916705d81eSwdenk 5926705d81eSwdenk If you have Amba PrimeCell PL010 or PL011 UARTs on your board, 5936705d81eSwdenk define this to a list of base addresses for each (supported) 5946705d81eSwdenk port. See e.g. include/configs/versatile.h 5956705d81eSwdenk 596910f1ae3SJohn Rigby CONFIG_PL011_SERIAL_RLCR 597910f1ae3SJohn Rigby 598910f1ae3SJohn Rigby Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500) 599910f1ae3SJohn Rigby have separate receive and transmit line control registers. Set 600910f1ae3SJohn Rigby this variable to initialize the extra register. 601910f1ae3SJohn Rigby 602910f1ae3SJohn Rigby CONFIG_PL011_SERIAL_FLUSH_ON_INIT 603910f1ae3SJohn Rigby 604910f1ae3SJohn Rigby On some platforms (e.g. U8500) U-Boot is loaded by a second stage 605910f1ae3SJohn Rigby boot loader that has already initialized the UART. Define this 606910f1ae3SJohn Rigby variable to flush the UART at init time. 607910f1ae3SJohn Rigby 6086705d81eSwdenk 609c609719bSwdenk- Console Interface: 610c609719bSwdenk Depending on board, define exactly one serial port 611c609719bSwdenk (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2, 612c609719bSwdenk CONFIG_8xx_CONS_SCC1, ...), or switch off the serial 613c609719bSwdenk console by defining CONFIG_8xx_CONS_NONE 614c609719bSwdenk 615c609719bSwdenk Note: if CONFIG_8xx_CONS_NONE is defined, the serial 616c609719bSwdenk port routines must be defined elsewhere 617c609719bSwdenk (i.e. serial_init(), serial_getc(), ...) 618c609719bSwdenk 619c609719bSwdenk CONFIG_CFB_CONSOLE 620c609719bSwdenk Enables console device for a color framebuffer. Needs following 621c53043b7SWolfgang Denk defines (cf. smiLynxEM, i8042) 622c609719bSwdenk VIDEO_FB_LITTLE_ENDIAN graphic memory organisation 623c609719bSwdenk (default big endian) 624c609719bSwdenk VIDEO_HW_RECTFILL graphic chip supports 625c609719bSwdenk rectangle fill 626c609719bSwdenk (cf. smiLynxEM) 627c609719bSwdenk VIDEO_HW_BITBLT graphic chip supports 628c609719bSwdenk bit-blit (cf. smiLynxEM) 629c609719bSwdenk VIDEO_VISIBLE_COLS visible pixel columns 630c609719bSwdenk (cols=pitch) 631c609719bSwdenk VIDEO_VISIBLE_ROWS visible pixel rows 632c609719bSwdenk VIDEO_PIXEL_SIZE bytes per pixel 633c609719bSwdenk VIDEO_DATA_FORMAT graphic data format 634c609719bSwdenk (0-5, cf. cfb_console.c) 635c609719bSwdenk VIDEO_FB_ADRS framebuffer address 636c609719bSwdenk VIDEO_KBD_INIT_FCT keyboard int fct 637c609719bSwdenk (i.e. i8042_kbd_init()) 638c609719bSwdenk VIDEO_TSTC_FCT test char fct 639c609719bSwdenk (i.e. i8042_tstc) 640c609719bSwdenk VIDEO_GETC_FCT get char fct 641c609719bSwdenk (i.e. i8042_getc) 642c609719bSwdenk CONFIG_CONSOLE_CURSOR cursor drawing on/off 643c609719bSwdenk (requires blink timer 644c609719bSwdenk cf. i8042.c) 6456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c) 646c609719bSwdenk CONFIG_CONSOLE_TIME display time/date info in 647c609719bSwdenk upper right corner 648602ad3b3SJon Loeliger (requires CONFIG_CMD_DATE) 649c609719bSwdenk CONFIG_VIDEO_LOGO display Linux logo in 650c609719bSwdenk upper left corner 651a6c7ad2fSwdenk CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of 652a6c7ad2fSwdenk linux_logo.h for logo. 653a6c7ad2fSwdenk Requires CONFIG_VIDEO_LOGO 654c609719bSwdenk CONFIG_CONSOLE_EXTRA_INFO 65511ccc33fSMarcel Ziswiler additional board info beside 656c609719bSwdenk the logo 657c609719bSwdenk 658c609719bSwdenk When CONFIG_CFB_CONSOLE is defined, video console is 659c609719bSwdenk default i/o. Serial console can be forced with 660c609719bSwdenk environment 'console=serial'. 661c609719bSwdenk 662a3ad8e26Swdenk When CONFIG_SILENT_CONSOLE is defined, all console 663a3ad8e26Swdenk messages (by U-Boot and Linux!) can be silenced with 664a3ad8e26Swdenk the "silent" environment variable. See 665a3ad8e26Swdenk doc/README.silent for more information. 666a3ad8e26Swdenk 667c609719bSwdenk- Console Baudrate: 668c609719bSwdenk CONFIG_BAUDRATE - in bps 669c609719bSwdenk Select one of the baudrates listed in 6706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BAUDRATE_TABLE, see below. 6716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale 672c609719bSwdenk 673c92fac91SHeiko Schocher- Console Rx buffer length 674c92fac91SHeiko Schocher With CONFIG_SYS_SMC_RXBUFLEN it is possible to define 675c92fac91SHeiko Schocher the maximum receive buffer length for the SMC. 6762b3f12c2SHeiko Schocher This option is actual only for 82xx and 8xx possible. 677c92fac91SHeiko Schocher If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE 678c92fac91SHeiko Schocher must be defined, to setup the maximum idle timeout for 679c92fac91SHeiko Schocher the SMC. 680c92fac91SHeiko Schocher 6819558b48aSGraeme Russ- Pre-Console Buffer: 6829558b48aSGraeme Russ Prior to the console being initialised (i.e. serial UART 6839558b48aSGraeme Russ initialised etc) all console output is silently discarded. 6849558b48aSGraeme Russ Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to 6859558b48aSGraeme Russ buffer any console messages prior to the console being 6869558b48aSGraeme Russ initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ 6879558b48aSGraeme Russ bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is 6889558b48aSGraeme Russ a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ 6899558b48aSGraeme Russ bytes are output before the console is initialised, the 6909558b48aSGraeme Russ earlier bytes are discarded. 6919558b48aSGraeme Russ 6929558b48aSGraeme Russ 'Sane' compilers will generate smaller code if 6939558b48aSGraeme Russ CONFIG_PRE_CON_BUF_SZ is a power of 2 6949558b48aSGraeme Russ 695046a37bdSSonny Rao- Safe printf() functions 696046a37bdSSonny Rao Define CONFIG_SYS_VSNPRINTF to compile in safe versions of 697046a37bdSSonny Rao the printf() functions. These are defined in 698046a37bdSSonny Rao include/vsprintf.h and include snprintf(), vsnprintf() and 699046a37bdSSonny Rao so on. Code size increase is approximately 300-500 bytes. 700046a37bdSSonny Rao If this option is not given then these functions will 701046a37bdSSonny Rao silently discard their buffer size argument - this means 702046a37bdSSonny Rao you are not getting any overflow checking in this case. 703046a37bdSSonny Rao 704c609719bSwdenk- Boot Delay: CONFIG_BOOTDELAY - in seconds 705c609719bSwdenk Delay before automatically booting the default image; 706c609719bSwdenk set to -1 to disable autoboot. 70793d7212fSJoe Hershberger set to -2 to autoboot with no delay and not check for abort 70893d7212fSJoe Hershberger (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined). 709c609719bSwdenk 710c609719bSwdenk See doc/README.autoboot for these options that 711c609719bSwdenk work with CONFIG_BOOTDELAY. None are required. 712c609719bSwdenk CONFIG_BOOT_RETRY_TIME 713c609719bSwdenk CONFIG_BOOT_RETRY_MIN 714c609719bSwdenk CONFIG_AUTOBOOT_KEYED 715c609719bSwdenk CONFIG_AUTOBOOT_PROMPT 716c609719bSwdenk CONFIG_AUTOBOOT_DELAY_STR 717c609719bSwdenk CONFIG_AUTOBOOT_STOP_STR 718c609719bSwdenk CONFIG_AUTOBOOT_DELAY_STR2 719c609719bSwdenk CONFIG_AUTOBOOT_STOP_STR2 720c609719bSwdenk CONFIG_ZERO_BOOTDELAY_CHECK 721c609719bSwdenk CONFIG_RESET_TO_RETRY 722c609719bSwdenk 723c609719bSwdenk- Autoboot Command: 724c609719bSwdenk CONFIG_BOOTCOMMAND 725c609719bSwdenk Only needed when CONFIG_BOOTDELAY is enabled; 726c609719bSwdenk define a command string that is automatically executed 727c609719bSwdenk when no character is read on the console interface 728c609719bSwdenk within "Boot Delay" after reset. 729c609719bSwdenk 730c609719bSwdenk CONFIG_BOOTARGS 731c609719bSwdenk This can be used to pass arguments to the bootm 732c609719bSwdenk command. The value of CONFIG_BOOTARGS goes into the 733c609719bSwdenk environment value "bootargs". 734c609719bSwdenk 735c609719bSwdenk CONFIG_RAMBOOT and CONFIG_NFSBOOT 736c609719bSwdenk The value of these goes into the environment as 737c609719bSwdenk "ramboot" and "nfsboot" respectively, and can be used 738c609719bSwdenk as a convenience, when switching between booting from 73911ccc33fSMarcel Ziswiler RAM and NFS. 740c609719bSwdenk 741c609719bSwdenk- Pre-Boot Commands: 742c609719bSwdenk CONFIG_PREBOOT 743c609719bSwdenk 744c609719bSwdenk When this option is #defined, the existence of the 745c609719bSwdenk environment variable "preboot" will be checked 746c609719bSwdenk immediately before starting the CONFIG_BOOTDELAY 747c609719bSwdenk countdown and/or running the auto-boot command resp. 748c609719bSwdenk entering interactive mode. 749c609719bSwdenk 750c609719bSwdenk This feature is especially useful when "preboot" is 751c609719bSwdenk automatically generated or modified. For an example 752c609719bSwdenk see the LWMON board specific code: here "preboot" is 753c609719bSwdenk modified when the user holds down a certain 754c609719bSwdenk combination of keys on the (special) keyboard when 755c609719bSwdenk booting the systems 756c609719bSwdenk 757c609719bSwdenk- Serial Download Echo Mode: 758c609719bSwdenk CONFIG_LOADS_ECHO 759c609719bSwdenk If defined to 1, all characters received during a 760c609719bSwdenk serial download (using the "loads" command) are 761c609719bSwdenk echoed back. This might be needed by some terminal 762c609719bSwdenk emulations (like "cu"), but may as well just take 763c609719bSwdenk time on others. This setting #define's the initial 764c609719bSwdenk value of the "loads_echo" environment variable. 765c609719bSwdenk 766602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined) 767c609719bSwdenk CONFIG_KGDB_BAUDRATE 768c609719bSwdenk Select one of the baudrates listed in 7696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BAUDRATE_TABLE, see below. 770c609719bSwdenk 771c609719bSwdenk- Monitor Functions: 772602ad3b3SJon Loeliger Monitor commands can be included or excluded 773602ad3b3SJon Loeliger from the build by using the #include files 774c6c621bdSStephen Warren <config_cmd_all.h> and #undef'ing unwanted 775c6c621bdSStephen Warren commands, or using <config_cmd_default.h> 776602ad3b3SJon Loeliger and augmenting with additional #define's 777602ad3b3SJon Loeliger for wanted commands. 778c609719bSwdenk 779602ad3b3SJon Loeliger The default command configuration includes all commands 780602ad3b3SJon Loeliger except those marked below with a "*". 781602ad3b3SJon Loeliger 782602ad3b3SJon Loeliger CONFIG_CMD_ASKENV * ask for env variable 783602ad3b3SJon Loeliger CONFIG_CMD_BDI bdinfo 784602ad3b3SJon Loeliger CONFIG_CMD_BEDBUG * Include BedBug Debugger 785602ad3b3SJon Loeliger CONFIG_CMD_BMP * BMP support 786602ad3b3SJon Loeliger CONFIG_CMD_BSP * Board specific commands 787602ad3b3SJon Loeliger CONFIG_CMD_BOOTD bootd 788602ad3b3SJon Loeliger CONFIG_CMD_CACHE * icache, dcache 789602ad3b3SJon Loeliger CONFIG_CMD_CONSOLE coninfo 790710b9938SMike Frysinger CONFIG_CMD_CRC32 * crc32 791602ad3b3SJon Loeliger CONFIG_CMD_DATE * support for RTC, date/time... 792602ad3b3SJon Loeliger CONFIG_CMD_DHCP * DHCP support 793602ad3b3SJon Loeliger CONFIG_CMD_DIAG * Diagnostics 794a7c93104SPeter Tyser CONFIG_CMD_DS4510 * ds4510 I2C gpio commands 795a7c93104SPeter Tyser CONFIG_CMD_DS4510_INFO * ds4510 I2C info command 796a7c93104SPeter Tyser CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd 797a7c93104SPeter Tyser CONFIG_CMD_DS4510_RST * ds4510 I2C rst command 798602ad3b3SJon Loeliger CONFIG_CMD_DTT * Digital Therm and Thermostat 799602ad3b3SJon Loeliger CONFIG_CMD_ECHO echo arguments 800246c6922SPeter Tyser CONFIG_CMD_EDITENV edit env variable 801602ad3b3SJon Loeliger CONFIG_CMD_EEPROM * EEPROM read/write support 802602ad3b3SJon Loeliger CONFIG_CMD_ELF * bootelf, bootvx 8030c79cda0SMike Frysinger CONFIG_CMD_EXPORTENV * export the environment 804bdab39d3SMike Frysinger CONFIG_CMD_SAVEENV saveenv 805602ad3b3SJon Loeliger CONFIG_CMD_FDC * Floppy Disk Support 806602ad3b3SJon Loeliger CONFIG_CMD_FAT * FAT partition support 807602ad3b3SJon Loeliger CONFIG_CMD_FDOS * Dos diskette Support 808602ad3b3SJon Loeliger CONFIG_CMD_FLASH flinfo, erase, protect 809602ad3b3SJon Loeliger CONFIG_CMD_FPGA FPGA device initialization support 810a641b979SMike Frysinger CONFIG_CMD_GO * the 'go' command (exec code) 811a000b795SKim Phillips CONFIG_CMD_GREPENV * search environment 812602ad3b3SJon Loeliger CONFIG_CMD_HWFLOW * RTS/CTS hw flow control 813602ad3b3SJon Loeliger CONFIG_CMD_I2C * I2C serial bus support 814602ad3b3SJon Loeliger CONFIG_CMD_IDE * IDE harddisk support 815602ad3b3SJon Loeliger CONFIG_CMD_IMI iminfo 816602ad3b3SJon Loeliger CONFIG_CMD_IMLS List all found images 817602ad3b3SJon Loeliger CONFIG_CMD_IMMAP * IMMR dump support 8180c79cda0SMike Frysinger CONFIG_CMD_IMPORTENV * import an environment 819c167cc02SJoe Hershberger CONFIG_CMD_INI * import data from an ini file into the env 820602ad3b3SJon Loeliger CONFIG_CMD_IRQ * irqinfo 821602ad3b3SJon Loeliger CONFIG_CMD_ITEST Integer/string test of 2 values 822602ad3b3SJon Loeliger CONFIG_CMD_JFFS2 * JFFS2 Support 823602ad3b3SJon Loeliger CONFIG_CMD_KGDB * kgdb 8241ba7fd25SMike Frysinger CONFIG_CMD_LDRINFO ldrinfo (display Blackfin loader) 825d22c338eSJoe Hershberger CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration 826d22c338eSJoe Hershberger (169.254.*.*) 827602ad3b3SJon Loeliger CONFIG_CMD_LOADB loadb 828602ad3b3SJon Loeliger CONFIG_CMD_LOADS loads 82902c9aa1dSRobin Getz CONFIG_CMD_MD5SUM print md5 message digest 83002c9aa1dSRobin Getz (requires CONFIG_CMD_MEMORY and CONFIG_MD5) 831602ad3b3SJon Loeliger CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base, 83256523f12Swdenk loop, loopw, mtest 833602ad3b3SJon Loeliger CONFIG_CMD_MISC Misc functions like sleep etc 834602ad3b3SJon Loeliger CONFIG_CMD_MMC * MMC memory mapped support 835602ad3b3SJon Loeliger CONFIG_CMD_MII * MII utility commands 83668d7d651SStefan Roese CONFIG_CMD_MTDPARTS * MTD partition support 837602ad3b3SJon Loeliger CONFIG_CMD_NAND * NAND support 838602ad3b3SJon Loeliger CONFIG_CMD_NET bootp, tftpboot, rarpboot 839e92739d3SPeter Tyser CONFIG_CMD_PCA953X * PCA953x I2C gpio commands 840e92739d3SPeter Tyser CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command 841602ad3b3SJon Loeliger CONFIG_CMD_PCI * pciinfo 842602ad3b3SJon Loeliger CONFIG_CMD_PCMCIA * PCMCIA support 843602ad3b3SJon Loeliger CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network 844602ad3b3SJon Loeliger host 845602ad3b3SJon Loeliger CONFIG_CMD_PORTIO * Port I/O 846602ad3b3SJon Loeliger CONFIG_CMD_REGINFO * Register dump 847602ad3b3SJon Loeliger CONFIG_CMD_RUN run command in env variable 848602ad3b3SJon Loeliger CONFIG_CMD_SAVES * save S record dump 849602ad3b3SJon Loeliger CONFIG_CMD_SCSI * SCSI Support 850602ad3b3SJon Loeliger CONFIG_CMD_SDRAM * print SDRAM configuration information 851602ad3b3SJon Loeliger (requires CONFIG_CMD_I2C) 852602ad3b3SJon Loeliger CONFIG_CMD_SETGETDCR Support for DCR Register access 853602ad3b3SJon Loeliger (4xx only) 854f61ec45eSEric Nelson CONFIG_CMD_SF * Read/write/erase SPI NOR flash 855c6b1ee66SAlexander Holler CONFIG_CMD_SHA1SUM print sha1 memory digest 85602c9aa1dSRobin Getz (requires CONFIG_CMD_MEMORY) 85774de7aefSWolfgang Denk CONFIG_CMD_SOURCE "source" command Support 858602ad3b3SJon Loeliger CONFIG_CMD_SPI * SPI serial bus support 8597a83af07SLuca Ceresoli CONFIG_CMD_TFTPSRV * TFTP transfer in server mode 8601fb7cd49SSimon Glass CONFIG_CMD_TFTPPUT * TFTP put command (upload) 861da83bcd7SJoe Hershberger CONFIG_CMD_TIME * run command and report execution time (ARM specific) 862da83bcd7SJoe Hershberger CONFIG_CMD_TIMER * access to the system tick timer 863602ad3b3SJon Loeliger CONFIG_CMD_USB * USB support 864602ad3b3SJon Loeliger CONFIG_CMD_CDP * Cisco Discover Protocol support 865c8339f51SMarek Vasut CONFIG_CMD_MFSL * Microblaze FSL support 866c609719bSwdenk 867c609719bSwdenk 868c609719bSwdenk EXAMPLE: If you want all functions except of network 869c609719bSwdenk support you can write: 870c609719bSwdenk 871602ad3b3SJon Loeliger #include "config_cmd_all.h" 872602ad3b3SJon Loeliger #undef CONFIG_CMD_NET 873c609719bSwdenk 874213bf8c8SGerald Van Baren Other Commands: 875213bf8c8SGerald Van Baren fdt (flattened device tree) command: CONFIG_OF_LIBFDT 876c609719bSwdenk 877c609719bSwdenk Note: Don't enable the "icache" and "dcache" commands 878602ad3b3SJon Loeliger (configuration option CONFIG_CMD_CACHE) unless you know 879c609719bSwdenk what you (and your U-Boot users) are doing. Data 880c609719bSwdenk cache cannot be enabled on systems like the 8xx or 881c609719bSwdenk 8260 (where accesses to the IMMR region must be 882c609719bSwdenk uncached), and it cannot be disabled on all other 883c609719bSwdenk systems where we (mis-) use the data cache to hold an 884c609719bSwdenk initial stack and some data. 885c609719bSwdenk 886c609719bSwdenk 887c609719bSwdenk XXX - this list needs to get updated! 888c609719bSwdenk 88945ba8077SSimon Glass- Device tree: 89045ba8077SSimon Glass CONFIG_OF_CONTROL 89145ba8077SSimon Glass If this variable is defined, U-Boot will use a device tree 89245ba8077SSimon Glass to configure its devices, instead of relying on statically 89345ba8077SSimon Glass compiled #defines in the board file. This option is 89445ba8077SSimon Glass experimental and only available on a few boards. The device 89545ba8077SSimon Glass tree is available in the global data as gd->fdt_blob. 89645ba8077SSimon Glass 8972c0f79e4SSimon Glass U-Boot needs to get its device tree from somewhere. This can 8982c0f79e4SSimon Glass be done using one of the two options below: 899bbb0b128SSimon Glass 900bbb0b128SSimon Glass CONFIG_OF_EMBED 901bbb0b128SSimon Glass If this variable is defined, U-Boot will embed a device tree 902bbb0b128SSimon Glass binary in its image. This device tree file should be in the 903bbb0b128SSimon Glass board directory and called <soc>-<board>.dts. The binary file 904bbb0b128SSimon Glass is then picked up in board_init_f() and made available through 905bbb0b128SSimon Glass the global data structure as gd->blob. 90645ba8077SSimon Glass 9072c0f79e4SSimon Glass CONFIG_OF_SEPARATE 9082c0f79e4SSimon Glass If this variable is defined, U-Boot will build a device tree 9092c0f79e4SSimon Glass binary. It will be called u-boot.dtb. Architecture-specific 9102c0f79e4SSimon Glass code will locate it at run-time. Generally this works by: 9112c0f79e4SSimon Glass 9122c0f79e4SSimon Glass cat u-boot.bin u-boot.dtb >image.bin 9132c0f79e4SSimon Glass 9142c0f79e4SSimon Glass and in fact, U-Boot does this for you, creating a file called 9152c0f79e4SSimon Glass u-boot-dtb.bin which is useful in the common case. You can 9162c0f79e4SSimon Glass still use the individual files if you need something more 9172c0f79e4SSimon Glass exotic. 9182c0f79e4SSimon Glass 919c609719bSwdenk- Watchdog: 920c609719bSwdenk CONFIG_WATCHDOG 921c609719bSwdenk If this variable is defined, it enables watchdog 9226abe6fb6SDetlev Zundel support for the SoC. There must be support in the SoC 9236abe6fb6SDetlev Zundel specific code for a watchdog. For the 8xx and 8260 9246abe6fb6SDetlev Zundel CPUs, the SIU Watchdog feature is enabled in the SYPCR 9256abe6fb6SDetlev Zundel register. When supported for a specific SoC is 9266abe6fb6SDetlev Zundel available, then no further board specific code should 9276abe6fb6SDetlev Zundel be needed to use it. 9286abe6fb6SDetlev Zundel 9296abe6fb6SDetlev Zundel CONFIG_HW_WATCHDOG 9306abe6fb6SDetlev Zundel When using a watchdog circuitry external to the used 9316abe6fb6SDetlev Zundel SoC, then define this variable and provide board 9326abe6fb6SDetlev Zundel specific code for the "hw_watchdog_reset" function. 933c609719bSwdenk 934c1551ea8Sstroese- U-Boot Version: 935c1551ea8Sstroese CONFIG_VERSION_VARIABLE 936c1551ea8Sstroese If this variable is defined, an environment variable 937c1551ea8Sstroese named "ver" is created by U-Boot showing the U-Boot 938c1551ea8Sstroese version as printed by the "version" command. 939a1ea8e51SBenoît Thébaudeau Any change to this variable will be reverted at the 940a1ea8e51SBenoît Thébaudeau next reset. 941c1551ea8Sstroese 942c609719bSwdenk- Real-Time Clock: 943c609719bSwdenk 944602ad3b3SJon Loeliger When CONFIG_CMD_DATE is selected, the type of the RTC 945c609719bSwdenk has to be selected, too. Define exactly one of the 946c609719bSwdenk following options: 947c609719bSwdenk 948c609719bSwdenk CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx 949c609719bSwdenk CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC 9504e8b7544SFabio Estevam CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC 951c609719bSwdenk CONFIG_RTC_MC146818 - use MC146818 RTC 9521cb8e980Swdenk CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC 953c609719bSwdenk CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC 9547f70e853Swdenk CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC 9553bac3513Swdenk CONFIG_RTC_DS164x - use Dallas DS164x RTC 9569536dfccSTor Krill CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC 9574c0d4c3bSwdenk CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC 9586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337 95971d19f30SHeiko Schocher CONFIG_SYS_RV3029_TCR - enable trickle charger on 96071d19f30SHeiko Schocher RV3029 RTC. 961c609719bSwdenk 962b37c7e5eSwdenk Note that if the RTC uses I2C, then the I2C interface 963b37c7e5eSwdenk must also be configured. See I2C Support, below. 964b37c7e5eSwdenk 965e92739d3SPeter Tyser- GPIO Support: 966e92739d3SPeter Tyser CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO 967e92739d3SPeter Tyser CONFIG_PCA953X_INFO - enable pca953x info command 968e92739d3SPeter Tyser 9695dec49caSChris Packham The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of 9705dec49caSChris Packham chip-ngpio pairs that tell the PCA953X driver the number of 9715dec49caSChris Packham pins supported by a particular chip. 9725dec49caSChris Packham 973e92739d3SPeter Tyser Note that if the GPIO device uses I2C, then the I2C interface 974e92739d3SPeter Tyser must also be configured. See I2C Support, below. 975e92739d3SPeter Tyser 976c609719bSwdenk- Timestamp Support: 977c609719bSwdenk 978c609719bSwdenk When CONFIG_TIMESTAMP is selected, the timestamp 979c609719bSwdenk (date and time) of an image is printed by image 980c609719bSwdenk commands like bootm or iminfo. This option is 981602ad3b3SJon Loeliger automatically enabled when you select CONFIG_CMD_DATE . 982c609719bSwdenk 983923c46f9SKarl O. Pinc- Partition Labels (disklabels) Supported: 984923c46f9SKarl O. Pinc Zero or more of the following: 985923c46f9SKarl O. Pinc CONFIG_MAC_PARTITION Apple's MacOS partition table. 986923c46f9SKarl O. Pinc CONFIG_DOS_PARTITION MS Dos partition table, traditional on the 987923c46f9SKarl O. Pinc Intel architecture, USB sticks, etc. 988923c46f9SKarl O. Pinc CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc. 989923c46f9SKarl O. Pinc CONFIG_EFI_PARTITION GPT partition table, common when EFI is the 990923c46f9SKarl O. Pinc bootloader. Note 2TB partition limit; see 991923c46f9SKarl O. Pinc disk/part_efi.c 992923c46f9SKarl O. Pinc CONFIG_MTD_PARTITIONS Memory Technology Device partition table. 993c609719bSwdenk 994602ad3b3SJon Loeliger If IDE or SCSI support is enabled (CONFIG_CMD_IDE or 995218ca724SWolfgang Denk CONFIG_CMD_SCSI) you must configure support for at 996923c46f9SKarl O. Pinc least one non-MTD partition type as well. 997c609719bSwdenk 998c609719bSwdenk- IDE Reset method: 9994d13cbadSwdenk CONFIG_IDE_RESET_ROUTINE - this is defined in several 10004d13cbadSwdenk board configurations files but used nowhere! 1001c609719bSwdenk 10024d13cbadSwdenk CONFIG_IDE_RESET - is this is defined, IDE Reset will 10034d13cbadSwdenk be performed by calling the function 10044d13cbadSwdenk ide_set_reset(int reset) 10054d13cbadSwdenk which has to be defined in a board specific file 1006c609719bSwdenk 1007c609719bSwdenk- ATAPI Support: 1008c609719bSwdenk CONFIG_ATAPI 1009c609719bSwdenk 1010c609719bSwdenk Set this to enable ATAPI support. 1011c609719bSwdenk 1012c40b2956Swdenk- LBA48 Support 1013c40b2956Swdenk CONFIG_LBA48 1014c40b2956Swdenk 1015c40b2956Swdenk Set this to enable support for disks larger than 137GB 10164b142febSHeiko Schocher Also look at CONFIG_SYS_64BIT_LBA. 1017c40b2956Swdenk Whithout these , LBA48 support uses 32bit variables and will 'only' 1018c40b2956Swdenk support disks up to 2.1TB. 1019c40b2956Swdenk 10206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_64BIT_LBA: 1021c40b2956Swdenk When enabled, makes the IDE subsystem use 64bit sector addresses. 1022c40b2956Swdenk Default is 32bit. 1023c40b2956Swdenk 1024c609719bSwdenk- SCSI Support: 1025c609719bSwdenk At the moment only there is only support for the 1026c609719bSwdenk SYM53C8XX SCSI controller; define 1027c609719bSwdenk CONFIG_SCSI_SYM53C8XX to enable it. 1028c609719bSwdenk 10296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and 10306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID * 10316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the 1032c609719bSwdenk maximum numbers of LUNs, SCSI ID's and target 1033c609719bSwdenk devices. 10346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz) 1035c609719bSwdenk 1036c609719bSwdenk- NETWORK Support (PCI): 1037682011ffSwdenk CONFIG_E1000 1038ce5207e1SKyle Moffett Support for Intel 8254x/8257x gigabit chips. 1039ce5207e1SKyle Moffett 1040ce5207e1SKyle Moffett CONFIG_E1000_SPI 1041ce5207e1SKyle Moffett Utility code for direct access to the SPI bus on Intel 8257x. 1042ce5207e1SKyle Moffett This does not do anything useful unless you set at least one 1043ce5207e1SKyle Moffett of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC. 1044ce5207e1SKyle Moffett 1045ce5207e1SKyle Moffett CONFIG_E1000_SPI_GENERIC 1046ce5207e1SKyle Moffett Allow generic access to the SPI bus on the Intel 8257x, for 1047ce5207e1SKyle Moffett example with the "sspi" command. 1048ce5207e1SKyle Moffett 1049ce5207e1SKyle Moffett CONFIG_CMD_E1000 1050ce5207e1SKyle Moffett Management command for E1000 devices. When used on devices 1051ce5207e1SKyle Moffett with SPI support you can reprogram the EEPROM from U-Boot. 1052682011ffSwdenk 1053ac3315c2SAndre Schwarz CONFIG_E1000_FALLBACK_MAC 105411ccc33fSMarcel Ziswiler default MAC for empty EEPROM after production. 1055ac3315c2SAndre Schwarz 1056c609719bSwdenk CONFIG_EEPRO100 1057c609719bSwdenk Support for Intel 82557/82559/82559ER chips. 105811ccc33fSMarcel Ziswiler Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM 1059c609719bSwdenk write routine for first time initialisation. 1060c609719bSwdenk 1061c609719bSwdenk CONFIG_TULIP 1062c609719bSwdenk Support for Digital 2114x chips. 1063c609719bSwdenk Optional CONFIG_TULIP_SELECT_MEDIA for board specific 1064c609719bSwdenk modem chip initialisation (KS8761/QS6611). 1065c609719bSwdenk 1066c609719bSwdenk CONFIG_NATSEMI 1067c609719bSwdenk Support for National dp83815 chips. 1068c609719bSwdenk 1069c609719bSwdenk CONFIG_NS8382X 1070c609719bSwdenk Support for National dp8382[01] gigabit chips. 1071c609719bSwdenk 107245219c46Swdenk- NETWORK Support (other): 107345219c46Swdenk 1074c041e9d2SJens Scharsig CONFIG_DRIVER_AT91EMAC 1075c041e9d2SJens Scharsig Support for AT91RM9200 EMAC. 1076c041e9d2SJens Scharsig 1077c041e9d2SJens Scharsig CONFIG_RMII 1078c041e9d2SJens Scharsig Define this to use reduced MII inteface 1079c041e9d2SJens Scharsig 1080c041e9d2SJens Scharsig CONFIG_DRIVER_AT91EMAC_QUIET 1081c041e9d2SJens Scharsig If this defined, the driver is quiet. 1082c041e9d2SJens Scharsig The driver doen't show link status messages. 1083c041e9d2SJens Scharsig 1084efdd7319SRob Herring CONFIG_CALXEDA_XGMAC 1085efdd7319SRob Herring Support for the Calxeda XGMAC device 1086efdd7319SRob Herring 108745219c46Swdenk CONFIG_DRIVER_LAN91C96 108845219c46Swdenk Support for SMSC's LAN91C96 chips. 108945219c46Swdenk 109045219c46Swdenk CONFIG_LAN91C96_BASE 109145219c46Swdenk Define this to hold the physical address 109245219c46Swdenk of the LAN91C96's I/O space 109345219c46Swdenk 109445219c46Swdenk CONFIG_LAN91C96_USE_32_BIT 109545219c46Swdenk Define this to enable 32 bit addressing 109645219c46Swdenk 1097f39748aeSwdenk CONFIG_DRIVER_SMC91111 1098f39748aeSwdenk Support for SMSC's LAN91C111 chip 1099f39748aeSwdenk 1100f39748aeSwdenk CONFIG_SMC91111_BASE 1101f39748aeSwdenk Define this to hold the physical address 1102f39748aeSwdenk of the device (I/O space) 1103f39748aeSwdenk 1104f39748aeSwdenk CONFIG_SMC_USE_32_BIT 1105f39748aeSwdenk Define this if data bus is 32 bits 1106f39748aeSwdenk 1107f39748aeSwdenk CONFIG_SMC_USE_IOFUNCS 1108f39748aeSwdenk Define this to use i/o functions instead of macros 1109f39748aeSwdenk (some hardware wont work with macros) 1110f39748aeSwdenk 1111dc02badaSHeiko Schocher CONFIG_DRIVER_TI_EMAC 1112dc02badaSHeiko Schocher Support for davinci emac 1113dc02badaSHeiko Schocher 1114dc02badaSHeiko Schocher CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT 1115dc02badaSHeiko Schocher Define this if you have more then 3 PHYs. 1116dc02badaSHeiko Schocher 1117b3dbf4a5SMacpaul Lin CONFIG_FTGMAC100 1118b3dbf4a5SMacpaul Lin Support for Faraday's FTGMAC100 Gigabit SoC Ethernet 1119b3dbf4a5SMacpaul Lin 1120b3dbf4a5SMacpaul Lin CONFIG_FTGMAC100_EGIGA 1121b3dbf4a5SMacpaul Lin Define this to use GE link update with gigabit PHY. 1122b3dbf4a5SMacpaul Lin Define this if FTGMAC100 is connected to gigabit PHY. 1123b3dbf4a5SMacpaul Lin If your system has 10/100 PHY only, it might not occur 1124b3dbf4a5SMacpaul Lin wrong behavior. Because PHY usually return timeout or 1125b3dbf4a5SMacpaul Lin useless data when polling gigabit status and gigabit 1126b3dbf4a5SMacpaul Lin control registers. This behavior won't affect the 1127b3dbf4a5SMacpaul Lin correctnessof 10/100 link speed update. 1128b3dbf4a5SMacpaul Lin 1129c2fff331SMike Rapoport CONFIG_SMC911X 1130557b377dSJens Gehrlein Support for SMSC's LAN911x and LAN921x chips 1131557b377dSJens Gehrlein 1132c2fff331SMike Rapoport CONFIG_SMC911X_BASE 1133557b377dSJens Gehrlein Define this to hold the physical address 1134557b377dSJens Gehrlein of the device (I/O space) 1135557b377dSJens Gehrlein 1136c2fff331SMike Rapoport CONFIG_SMC911X_32_BIT 1137557b377dSJens Gehrlein Define this if data bus is 32 bits 1138557b377dSJens Gehrlein 1139c2fff331SMike Rapoport CONFIG_SMC911X_16_BIT 1140557b377dSJens Gehrlein Define this if data bus is 16 bits. If your processor 1141557b377dSJens Gehrlein automatically converts one 32 bit word to two 16 bit 1142c2fff331SMike Rapoport words you may also try CONFIG_SMC911X_32_BIT. 1143557b377dSJens Gehrlein 11443d0075faSYoshihiro Shimoda CONFIG_SH_ETHER 11453d0075faSYoshihiro Shimoda Support for Renesas on-chip Ethernet controller 11463d0075faSYoshihiro Shimoda 11473d0075faSYoshihiro Shimoda CONFIG_SH_ETHER_USE_PORT 11483d0075faSYoshihiro Shimoda Define the number of ports to be used 11493d0075faSYoshihiro Shimoda 11503d0075faSYoshihiro Shimoda CONFIG_SH_ETHER_PHY_ADDR 11513d0075faSYoshihiro Shimoda Define the ETH PHY's address 11523d0075faSYoshihiro Shimoda 115368260aabSYoshihiro Shimoda CONFIG_SH_ETHER_CACHE_WRITEBACK 115468260aabSYoshihiro Shimoda If this option is set, the driver enables cache flush. 115568260aabSYoshihiro Shimoda 11565e124724SVadim Bendebury- TPM Support: 11575e124724SVadim Bendebury CONFIG_GENERIC_LPC_TPM 11585e124724SVadim Bendebury Support for generic parallel port TPM devices. Only one device 11595e124724SVadim Bendebury per system is supported at this time. 11605e124724SVadim Bendebury 11615e124724SVadim Bendebury CONFIG_TPM_TIS_BASE_ADDRESS 11625e124724SVadim Bendebury Base address where the generic TPM device is mapped 11635e124724SVadim Bendebury to. Contemporary x86 systems usually map it at 11645e124724SVadim Bendebury 0xfed40000. 11655e124724SVadim Bendebury 1166c609719bSwdenk- USB Support: 1167c609719bSwdenk At the moment only the UHCI host controller is 11684d13cbadSwdenk supported (PIP405, MIP405, MPC5200); define 1169c609719bSwdenk CONFIG_USB_UHCI to enable it. 1170c609719bSwdenk define CONFIG_USB_KEYBOARD to enable the USB Keyboard 117130d56faeSwdenk and define CONFIG_USB_STORAGE to enable the USB 1172c609719bSwdenk storage devices. 1173c609719bSwdenk Note: 1174c609719bSwdenk Supported are USB Keyboards and USB Floppy drives 1175c609719bSwdenk (TEAC FD-05PUB). 11764d13cbadSwdenk MPC5200 USB requires additional defines: 11774d13cbadSwdenk CONFIG_USB_CLOCK 11784d13cbadSwdenk for 528 MHz Clock: 0x0001bbbb 1179307ecb6dSEric Millbrandt CONFIG_PSC3_USB 1180307ecb6dSEric Millbrandt for USB on PSC3 11814d13cbadSwdenk CONFIG_USB_CONFIG 11824d13cbadSwdenk for differential drivers: 0x00001000 11834d13cbadSwdenk for single ended drivers: 0x00005000 1184307ecb6dSEric Millbrandt for differential drivers on PSC3: 0x00000100 1185307ecb6dSEric Millbrandt for single ended drivers on PSC3: 0x00004100 11866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_USB_EVENT_POLL 1187fdcfaa1bSZhang Wei May be defined to allow interrupt polling 1188fdcfaa1bSZhang Wei instead of using asynchronous interrupts 11894d13cbadSwdenk 11909ab4ce22SSimon Glass CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the 11919ab4ce22SSimon Glass txfilltuning field in the EHCI controller on reset. 11929ab4ce22SSimon Glass 119316c8d5e7SWolfgang Denk- USB Device: 119416c8d5e7SWolfgang Denk Define the below if you wish to use the USB console. 119516c8d5e7SWolfgang Denk Once firmware is rebuilt from a serial console issue the 119616c8d5e7SWolfgang Denk command "setenv stdin usbtty; setenv stdout usbtty" and 119711ccc33fSMarcel Ziswiler attach your USB cable. The Unix command "dmesg" should print 119816c8d5e7SWolfgang Denk it has found a new device. The environment variable usbtty 119916c8d5e7SWolfgang Denk can be set to gserial or cdc_acm to enable your device to 120016c8d5e7SWolfgang Denk appear to a USB host as a Linux gserial device or a 120116c8d5e7SWolfgang Denk Common Device Class Abstract Control Model serial device. 120216c8d5e7SWolfgang Denk If you select usbtty = gserial you should be able to enumerate 120316c8d5e7SWolfgang Denk a Linux host by 120416c8d5e7SWolfgang Denk # modprobe usbserial vendor=0xVendorID product=0xProductID 120516c8d5e7SWolfgang Denk else if using cdc_acm, simply setting the environment 120616c8d5e7SWolfgang Denk variable usbtty to be cdc_acm should suffice. The following 120716c8d5e7SWolfgang Denk might be defined in YourBoardName.h 120816c8d5e7SWolfgang Denk 120916c8d5e7SWolfgang Denk CONFIG_USB_DEVICE 121016c8d5e7SWolfgang Denk Define this to build a UDC device 121116c8d5e7SWolfgang Denk 121216c8d5e7SWolfgang Denk CONFIG_USB_TTY 121316c8d5e7SWolfgang Denk Define this to have a tty type of device available to 121416c8d5e7SWolfgang Denk talk to the UDC device 121516c8d5e7SWolfgang Denk 1216f9da0f89SVipin KUMAR CONFIG_USBD_HS 1217f9da0f89SVipin KUMAR Define this to enable the high speed support for usb 1218f9da0f89SVipin KUMAR device and usbtty. If this feature is enabled, a routine 1219f9da0f89SVipin KUMAR int is_usbd_high_speed(void) 1220f9da0f89SVipin KUMAR also needs to be defined by the driver to dynamically poll 1221f9da0f89SVipin KUMAR whether the enumeration has succeded at high speed or full 1222f9da0f89SVipin KUMAR speed. 1223f9da0f89SVipin KUMAR 12246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_CONSOLE_IS_IN_ENV 122516c8d5e7SWolfgang Denk Define this if you want stdin, stdout &/or stderr to 122616c8d5e7SWolfgang Denk be set to usbtty. 122716c8d5e7SWolfgang Denk 122816c8d5e7SWolfgang Denk mpc8xx: 12296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_USB_EXTC_CLK 0xBLAH 123016c8d5e7SWolfgang Denk Derive USB clock from external clock "blah" 12316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_USB_EXTC_CLK 0x02 123216c8d5e7SWolfgang Denk 12336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_USB_BRG_CLK 0xBLAH 123416c8d5e7SWolfgang Denk Derive USB clock from brgclk 12356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_USB_BRG_CLK 0x04 123616c8d5e7SWolfgang Denk 123716c8d5e7SWolfgang Denk If you have a USB-IF assigned VendorID then you may wish to 123816c8d5e7SWolfgang Denk define your own vendor specific values either in BoardName.h 123916c8d5e7SWolfgang Denk or directly in usbd_vendor_info.h. If you don't define 124016c8d5e7SWolfgang Denk CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME, 124116c8d5e7SWolfgang Denk CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot 124216c8d5e7SWolfgang Denk should pretend to be a Linux device to it's target host. 124316c8d5e7SWolfgang Denk 124416c8d5e7SWolfgang Denk CONFIG_USBD_MANUFACTURER 124516c8d5e7SWolfgang Denk Define this string as the name of your company for 124616c8d5e7SWolfgang Denk - CONFIG_USBD_MANUFACTURER "my company" 124716c8d5e7SWolfgang Denk 124816c8d5e7SWolfgang Denk CONFIG_USBD_PRODUCT_NAME 124916c8d5e7SWolfgang Denk Define this string as the name of your product 125016c8d5e7SWolfgang Denk - CONFIG_USBD_PRODUCT_NAME "acme usb device" 125116c8d5e7SWolfgang Denk 125216c8d5e7SWolfgang Denk CONFIG_USBD_VENDORID 125316c8d5e7SWolfgang Denk Define this as your assigned Vendor ID from the USB 125416c8d5e7SWolfgang Denk Implementors Forum. This *must* be a genuine Vendor ID 125516c8d5e7SWolfgang Denk to avoid polluting the USB namespace. 125616c8d5e7SWolfgang Denk - CONFIG_USBD_VENDORID 0xFFFF 125716c8d5e7SWolfgang Denk 125816c8d5e7SWolfgang Denk CONFIG_USBD_PRODUCTID 125916c8d5e7SWolfgang Denk Define this as the unique Product ID 126016c8d5e7SWolfgang Denk for your device 126116c8d5e7SWolfgang Denk - CONFIG_USBD_PRODUCTID 0xFFFF 1262c609719bSwdenk 1263d70a560fSIgor Grinberg- ULPI Layer Support: 1264d70a560fSIgor Grinberg The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via 1265d70a560fSIgor Grinberg the generic ULPI layer. The generic layer accesses the ULPI PHY 1266d70a560fSIgor Grinberg via the platform viewport, so you need both the genric layer and 1267d70a560fSIgor Grinberg the viewport enabled. Currently only Chipidea/ARC based 1268d70a560fSIgor Grinberg viewport is supported. 1269d70a560fSIgor Grinberg To enable the ULPI layer support, define CONFIG_USB_ULPI and 1270d70a560fSIgor Grinberg CONFIG_USB_ULPI_VIEWPORT in your board configuration file. 12716d365ea0SLucas Stach If your ULPI phy needs a different reference clock than the 12726d365ea0SLucas Stach standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to 12736d365ea0SLucas Stach the appropriate value in Hz. 1274c609719bSwdenk 1275c609719bSwdenk- MMC Support: 1276c609719bSwdenk The MMC controller on the Intel PXA is supported. To 1277c609719bSwdenk enable this define CONFIG_MMC. The MMC can be 1278c609719bSwdenk accessed from the boot prompt by mapping the device 1279c609719bSwdenk to physical memory similar to flash. Command line is 1280602ad3b3SJon Loeliger enabled with CONFIG_CMD_MMC. The MMC driver also works with 1281602ad3b3SJon Loeliger the FAT fs. This is enabled with CONFIG_CMD_FAT. 1282c609719bSwdenk 1283afb35666SYoshihiro Shimoda CONFIG_SH_MMCIF 1284afb35666SYoshihiro Shimoda Support for Renesas on-chip MMCIF controller 1285afb35666SYoshihiro Shimoda 1286afb35666SYoshihiro Shimoda CONFIG_SH_MMCIF_ADDR 1287afb35666SYoshihiro Shimoda Define the base address of MMCIF registers 1288afb35666SYoshihiro Shimoda 1289afb35666SYoshihiro Shimoda CONFIG_SH_MMCIF_CLK 1290afb35666SYoshihiro Shimoda Define the clock frequency for MMCIF 1291afb35666SYoshihiro Shimoda 12926705d81eSwdenk- Journaling Flash filesystem support: 12936705d81eSwdenk CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE, 12946705d81eSwdenk CONFIG_JFFS2_NAND_DEV 12956705d81eSwdenk Define these for a default partition on a NAND device 12966705d81eSwdenk 12976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS2_FIRST_SECTOR, 12986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS 12996705d81eSwdenk Define these for a default partition on a NOR device 13006705d81eSwdenk 13016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS_CUSTOM_PART 13026705d81eSwdenk Define this to create an own partition. You have to provide a 13036705d81eSwdenk function struct part_info* jffs2_part_info(int part_num) 13046705d81eSwdenk 13056705d81eSwdenk If you define only one JFFS2 partition you may also want to 13066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_JFFS_SINGLE_PART 1 13076705d81eSwdenk to disable the command chpart. This is the default when you 13086705d81eSwdenk have not defined a custom partition 13096705d81eSwdenk 1310c30a15e5SDonggeun Kim- FAT(File Allocation Table) filesystem write function support: 1311c30a15e5SDonggeun Kim CONFIG_FAT_WRITE 1312656f4c65SDonggeun Kim 1313656f4c65SDonggeun Kim Define this to enable support for saving memory data as a 1314656f4c65SDonggeun Kim file in FAT formatted partition. 1315656f4c65SDonggeun Kim 1316656f4c65SDonggeun Kim This will also enable the command "fatwrite" enabling the 1317656f4c65SDonggeun Kim user to write files to FAT. 1318c30a15e5SDonggeun Kim 1319*84cd9327SGabe BlackCBFS (Coreboot Filesystem) support 1320*84cd9327SGabe Black CONFIG_CMD_CBFS 1321*84cd9327SGabe Black 1322*84cd9327SGabe Black Define this to enable support for reading from a Coreboot 1323*84cd9327SGabe Black filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls 1324*84cd9327SGabe Black and cbfsload. 1325*84cd9327SGabe Black 1326c609719bSwdenk- Keyboard Support: 1327c609719bSwdenk CONFIG_ISA_KEYBOARD 1328c609719bSwdenk 1329c609719bSwdenk Define this to enable standard (PC-Style) keyboard 1330c609719bSwdenk support 1331c609719bSwdenk 1332c609719bSwdenk CONFIG_I8042_KBD 1333c609719bSwdenk Standard PC keyboard driver with US (is default) and 1334c609719bSwdenk GERMAN key layout (switch via environment 'keymap=de') support. 1335c609719bSwdenk Export function i8042_kbd_init, i8042_tstc and i8042_getc 1336c609719bSwdenk for cfb_console. Supports cursor blinking. 1337c609719bSwdenk 1338c609719bSwdenk- Video support: 1339c609719bSwdenk CONFIG_VIDEO 1340c609719bSwdenk 1341c609719bSwdenk Define this to enable video support (for output to 1342c609719bSwdenk video). 1343c609719bSwdenk 1344c609719bSwdenk CONFIG_VIDEO_CT69000 1345c609719bSwdenk 1346c609719bSwdenk Enable Chips & Technologies 69000 Video chip 1347c609719bSwdenk 1348c609719bSwdenk CONFIG_VIDEO_SMI_LYNXEM 1349eeb1b77bSwdenk Enable Silicon Motion SMI 712/710/810 Video chip. The 1350eeb1b77bSwdenk video output is selected via environment 'videoout' 1351eeb1b77bSwdenk (1 = LCD and 2 = CRT). If videoout is undefined, CRT is 1352eeb1b77bSwdenk assumed. 1353c609719bSwdenk 1354eeb1b77bSwdenk For the CT69000 and SMI_LYNXEM drivers, videomode is 135511ccc33fSMarcel Ziswiler selected via environment 'videomode'. Two different ways 1356eeb1b77bSwdenk are possible: 1357eeb1b77bSwdenk - "videomode=num" 'num' is a standard LiLo mode numbers. 1358eeb1b77bSwdenk Following standard modes are supported (* is default): 1359eeb1b77bSwdenk 1360eeb1b77bSwdenk Colors 640x480 800x600 1024x768 1152x864 1280x1024 1361eeb1b77bSwdenk -------------+--------------------------------------------- 1362eeb1b77bSwdenk 8 bits | 0x301* 0x303 0x305 0x161 0x307 1363eeb1b77bSwdenk 15 bits | 0x310 0x313 0x316 0x162 0x319 1364eeb1b77bSwdenk 16 bits | 0x311 0x314 0x317 0x163 0x31A 1365eeb1b77bSwdenk 24 bits | 0x312 0x315 0x318 ? 0x31B 1366eeb1b77bSwdenk -------------+--------------------------------------------- 1367c609719bSwdenk (i.e. setenv videomode 317; saveenv; reset;) 1368c609719bSwdenk 1369eeb1b77bSwdenk - "videomode=bootargs" all the video parameters are parsed 13707817cb20SMarcel Ziswiler from the bootargs. (See drivers/video/videomodes.c) 1371eeb1b77bSwdenk 1372eeb1b77bSwdenk 1373a6c7ad2fSwdenk CONFIG_VIDEO_SED13806 1374a6c7ad2fSwdenk Enable Epson SED13806 driver. This driver supports 8bpp 1375a6c7ad2fSwdenk and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP 1376a6c7ad2fSwdenk or CONFIG_VIDEO_SED13806_16BPP 1377a6c7ad2fSwdenk 13787d3053fbSTimur Tabi CONFIG_FSL_DIU_FB 13797d3053fbSTimur Tabi Enable the Freescale DIU video driver. Reference boards for 13807d3053fbSTimur Tabi SOCs that have a DIU should define this macro to enable DIU 13817d3053fbSTimur Tabi support, and should also define these other macros: 13827d3053fbSTimur Tabi 13837d3053fbSTimur Tabi CONFIG_SYS_DIU_ADDR 13847d3053fbSTimur Tabi CONFIG_VIDEO 13857d3053fbSTimur Tabi CONFIG_CMD_BMP 13867d3053fbSTimur Tabi CONFIG_CFB_CONSOLE 13877d3053fbSTimur Tabi CONFIG_VIDEO_SW_CURSOR 13887d3053fbSTimur Tabi CONFIG_VGA_AS_SINGLE_DEVICE 13897d3053fbSTimur Tabi CONFIG_VIDEO_LOGO 13907d3053fbSTimur Tabi CONFIG_VIDEO_BMP_LOGO 13917d3053fbSTimur Tabi 1392ba8e76bdSTimur Tabi The DIU driver will look for the 'video-mode' environment 1393ba8e76bdSTimur Tabi variable, and if defined, enable the DIU as a console during 1394ba8e76bdSTimur Tabi boot. See the documentation file README.video for a 1395ba8e76bdSTimur Tabi description of this variable. 13967d3053fbSTimur Tabi 1397682011ffSwdenk- Keyboard Support: 1398682011ffSwdenk CONFIG_KEYBOARD 1399682011ffSwdenk 1400682011ffSwdenk Define this to enable a custom keyboard support. 1401682011ffSwdenk This simply calls drv_keyboard_init() which must be 1402682011ffSwdenk defined in your board-specific files. 1403682011ffSwdenk The only board using this so far is RBC823. 1404a6c7ad2fSwdenk 1405c609719bSwdenk- LCD Support: CONFIG_LCD 1406c609719bSwdenk 1407c609719bSwdenk Define this to enable LCD support (for output to LCD 1408c609719bSwdenk display); also select one of the supported displays 1409c609719bSwdenk by defining one of these: 1410c609719bSwdenk 141139cf4804SStelian Pop CONFIG_ATMEL_LCD: 141239cf4804SStelian Pop 141339cf4804SStelian Pop HITACHI TX09D70VM1CCA, 3.5", 240x320. 141439cf4804SStelian Pop 1415fd3103bbSwdenk CONFIG_NEC_NL6448AC33: 1416c609719bSwdenk 1417fd3103bbSwdenk NEC NL6448AC33-18. Active, color, single scan. 1418c609719bSwdenk 1419fd3103bbSwdenk CONFIG_NEC_NL6448BC20 1420c609719bSwdenk 1421fd3103bbSwdenk NEC NL6448BC20-08. 6.5", 640x480. 1422fd3103bbSwdenk Active, color, single scan. 1423fd3103bbSwdenk 1424fd3103bbSwdenk CONFIG_NEC_NL6448BC33_54 1425fd3103bbSwdenk 1426fd3103bbSwdenk NEC NL6448BC33-54. 10.4", 640x480. 1427c609719bSwdenk Active, color, single scan. 1428c609719bSwdenk 1429c609719bSwdenk CONFIG_SHARP_16x9 1430c609719bSwdenk 1431c609719bSwdenk Sharp 320x240. Active, color, single scan. 1432c609719bSwdenk It isn't 16x9, and I am not sure what it is. 1433c609719bSwdenk 1434c609719bSwdenk CONFIG_SHARP_LQ64D341 1435c609719bSwdenk 1436c609719bSwdenk Sharp LQ64D341 display, 640x480. 1437c609719bSwdenk Active, color, single scan. 1438c609719bSwdenk 1439c609719bSwdenk CONFIG_HLD1045 1440c609719bSwdenk 1441c609719bSwdenk HLD1045 display, 640x480. 1442c609719bSwdenk Active, color, single scan. 1443c609719bSwdenk 1444c609719bSwdenk CONFIG_OPTREX_BW 1445c609719bSwdenk 1446c609719bSwdenk Optrex CBL50840-2 NF-FW 99 22 M5 1447c609719bSwdenk or 1448c609719bSwdenk Hitachi LMG6912RPFC-00T 1449c609719bSwdenk or 1450c609719bSwdenk Hitachi SP14Q002 1451c609719bSwdenk 1452c609719bSwdenk 320x240. Black & white. 1453c609719bSwdenk 1454c609719bSwdenk Normally display is black on white background; define 14556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_WHITE_ON_BLACK to get it inverted. 1456c609719bSwdenk 14577152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN 1458d791b1dcSwdenk 1459d791b1dcSwdenk If this option is set, the environment is checked for 1460d791b1dcSwdenk a variable "splashimage". If found, the usual display 1461d791b1dcSwdenk of logo, copyright and system information on the LCD 1462e94d2cd9Swdenk is suppressed and the BMP image at the address 1463d791b1dcSwdenk specified in "splashimage" is loaded instead. The 1464d791b1dcSwdenk console is redirected to the "nulldev", too. This 1465d791b1dcSwdenk allows for a "silent" boot where a splash screen is 1466d791b1dcSwdenk loaded very quickly after power-on. 1467d791b1dcSwdenk 14681ca298ceSMatthias Weisser CONFIG_SPLASH_SCREEN_ALIGN 14691ca298ceSMatthias Weisser 14701ca298ceSMatthias Weisser If this option is set the splash image can be freely positioned 14711ca298ceSMatthias Weisser on the screen. Environment variable "splashpos" specifies the 14721ca298ceSMatthias Weisser position as "x,y". If a positive number is given it is used as 14731ca298ceSMatthias Weisser number of pixel from left/top. If a negative number is given it 14741ca298ceSMatthias Weisser is used as number of pixel from right/bottom. You can also 14751ca298ceSMatthias Weisser specify 'm' for centering the image. 14761ca298ceSMatthias Weisser 14771ca298ceSMatthias Weisser Example: 14781ca298ceSMatthias Weisser setenv splashpos m,m 14791ca298ceSMatthias Weisser => image at center of screen 14801ca298ceSMatthias Weisser 14811ca298ceSMatthias Weisser setenv splashpos 30,20 14821ca298ceSMatthias Weisser => image at x = 30 and y = 20 14831ca298ceSMatthias Weisser 14841ca298ceSMatthias Weisser setenv splashpos -10,m 14851ca298ceSMatthias Weisser => vertically centered image 14861ca298ceSMatthias Weisser at x = dspWidth - bmpWidth - 9 14871ca298ceSMatthias Weisser 148898f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP 148998f4a3dfSStefan Roese 149098f4a3dfSStefan Roese If this option is set, additionally to standard BMP 149198f4a3dfSStefan Roese images, gzipped BMP images can be displayed via the 149298f4a3dfSStefan Roese splashscreen support or the bmp command. 149398f4a3dfSStefan Roese 1494d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8 1495d5011762SAnatolij Gustschin 1496d5011762SAnatolij Gustschin If this option is set, 8-bit RLE compressed BMP images 1497d5011762SAnatolij Gustschin can be displayed via the splashscreen support or the 1498d5011762SAnatolij Gustschin bmp command. 1499d5011762SAnatolij Gustschin 1500f2b96dfbSLei Wen- Do compresssing for memory range: 1501f2b96dfbSLei Wen CONFIG_CMD_ZIP 1502f2b96dfbSLei Wen 1503f2b96dfbSLei Wen If this option is set, it would use zlib deflate method 1504f2b96dfbSLei Wen to compress the specified memory at its best effort. 1505f2b96dfbSLei Wen 1506c29fdfc1Swdenk- Compression support: 1507c29fdfc1Swdenk CONFIG_BZIP2 1508c29fdfc1Swdenk 1509c29fdfc1Swdenk If this option is set, support for bzip2 compressed 1510c29fdfc1Swdenk images is included. If not, only uncompressed and gzip 1511c29fdfc1Swdenk compressed images are supported. 1512c29fdfc1Swdenk 1513c29fdfc1Swdenk NOTE: the bzip2 algorithm requires a lot of RAM, so 15146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should 1515c29fdfc1Swdenk be at least 4MB. 1516d791b1dcSwdenk 1517fc9c1727SLuigi 'Comio' Mantellini CONFIG_LZMA 1518fc9c1727SLuigi 'Comio' Mantellini 1519fc9c1727SLuigi 'Comio' Mantellini If this option is set, support for lzma compressed 1520fc9c1727SLuigi 'Comio' Mantellini images is included. 1521fc9c1727SLuigi 'Comio' Mantellini 1522fc9c1727SLuigi 'Comio' Mantellini Note: The LZMA algorithm adds between 2 and 4KB of code and it 1523fc9c1727SLuigi 'Comio' Mantellini requires an amount of dynamic memory that is given by the 1524fc9c1727SLuigi 'Comio' Mantellini formula: 1525fc9c1727SLuigi 'Comio' Mantellini 1526fc9c1727SLuigi 'Comio' Mantellini (1846 + 768 << (lc + lp)) * sizeof(uint16) 1527fc9c1727SLuigi 'Comio' Mantellini 1528fc9c1727SLuigi 'Comio' Mantellini Where lc and lp stand for, respectively, Literal context bits 1529fc9c1727SLuigi 'Comio' Mantellini and Literal pos bits. 1530fc9c1727SLuigi 'Comio' Mantellini 1531fc9c1727SLuigi 'Comio' Mantellini This value is upper-bounded by 14MB in the worst case. Anyway, 1532fc9c1727SLuigi 'Comio' Mantellini for a ~4MB large kernel image, we have lc=3 and lp=0 for a 1533fc9c1727SLuigi 'Comio' Mantellini total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is 1534fc9c1727SLuigi 'Comio' Mantellini a very small buffer. 1535fc9c1727SLuigi 'Comio' Mantellini 1536fc9c1727SLuigi 'Comio' Mantellini Use the lzmainfo tool to determinate the lc and lp values and 1537fc9c1727SLuigi 'Comio' Mantellini then calculate the amount of needed dynamic memory (ensuring 15386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD the appropriate CONFIG_SYS_MALLOC_LEN value). 1539fc9c1727SLuigi 'Comio' Mantellini 154017ea1177Swdenk- MII/PHY support: 154117ea1177Swdenk CONFIG_PHY_ADDR 154217ea1177Swdenk 154317ea1177Swdenk The address of PHY on MII bus. 154417ea1177Swdenk 154517ea1177Swdenk CONFIG_PHY_CLOCK_FREQ (ppc4xx) 154617ea1177Swdenk 154717ea1177Swdenk The clock frequency of the MII bus 154817ea1177Swdenk 154917ea1177Swdenk CONFIG_PHY_GIGE 155017ea1177Swdenk 155117ea1177Swdenk If this option is set, support for speed/duplex 155211ccc33fSMarcel Ziswiler detection of gigabit PHY is included. 155317ea1177Swdenk 155417ea1177Swdenk CONFIG_PHY_RESET_DELAY 155517ea1177Swdenk 155617ea1177Swdenk Some PHY like Intel LXT971A need extra delay after 155717ea1177Swdenk reset before any MII register access is possible. 155817ea1177Swdenk For such PHY, set this option to the usec delay 155917ea1177Swdenk required. (minimum 300usec for LXT971A) 156017ea1177Swdenk 156117ea1177Swdenk CONFIG_PHY_CMD_DELAY (ppc4xx) 156217ea1177Swdenk 156317ea1177Swdenk Some PHY like Intel LXT971A need extra delay after 156417ea1177Swdenk command issued before MII status register can be read 156517ea1177Swdenk 1566c609719bSwdenk- Ethernet address: 1567c609719bSwdenk CONFIG_ETHADDR 1568c68a05feSrichardretanubun CONFIG_ETH1ADDR 1569c609719bSwdenk CONFIG_ETH2ADDR 1570c609719bSwdenk CONFIG_ETH3ADDR 1571c68a05feSrichardretanubun CONFIG_ETH4ADDR 1572c68a05feSrichardretanubun CONFIG_ETH5ADDR 1573c609719bSwdenk 157411ccc33fSMarcel Ziswiler Define a default value for Ethernet address to use 157511ccc33fSMarcel Ziswiler for the respective Ethernet interface, in case this 1576c609719bSwdenk is not determined automatically. 1577c609719bSwdenk 1578c609719bSwdenk- IP address: 1579c609719bSwdenk CONFIG_IPADDR 1580c609719bSwdenk 1581c609719bSwdenk Define a default value for the IP address to use for 158211ccc33fSMarcel Ziswiler the default Ethernet interface, in case this is not 1583c609719bSwdenk determined through e.g. bootp. 15841ebcd654SWolfgang Denk (Environment variable "ipaddr") 1585c609719bSwdenk 1586c609719bSwdenk- Server IP address: 1587c609719bSwdenk CONFIG_SERVERIP 1588c609719bSwdenk 1589c609719bSwdenk Defines a default value for the IP address of a TFTP 1590c609719bSwdenk server to contact when using the "tftboot" command. 15911ebcd654SWolfgang Denk (Environment variable "serverip") 1592c609719bSwdenk 159397cfe861SRobin Getz CONFIG_KEEP_SERVERADDR 159497cfe861SRobin Getz 159597cfe861SRobin Getz Keeps the server's MAC address, in the env 'serveraddr' 159697cfe861SRobin Getz for passing to bootargs (like Linux's netconsole option) 159797cfe861SRobin Getz 15981ebcd654SWolfgang Denk- Gateway IP address: 15991ebcd654SWolfgang Denk CONFIG_GATEWAYIP 16001ebcd654SWolfgang Denk 16011ebcd654SWolfgang Denk Defines a default value for the IP address of the 16021ebcd654SWolfgang Denk default router where packets to other networks are 16031ebcd654SWolfgang Denk sent to. 16041ebcd654SWolfgang Denk (Environment variable "gatewayip") 16051ebcd654SWolfgang Denk 16061ebcd654SWolfgang Denk- Subnet mask: 16071ebcd654SWolfgang Denk CONFIG_NETMASK 16081ebcd654SWolfgang Denk 16091ebcd654SWolfgang Denk Defines a default value for the subnet mask (or 16101ebcd654SWolfgang Denk routing prefix) which is used to determine if an IP 16111ebcd654SWolfgang Denk address belongs to the local subnet or needs to be 16121ebcd654SWolfgang Denk forwarded through a router. 16131ebcd654SWolfgang Denk (Environment variable "netmask") 16141ebcd654SWolfgang Denk 161553a5c424SDavid Updegraff- Multicast TFTP Mode: 161653a5c424SDavid Updegraff CONFIG_MCAST_TFTP 161753a5c424SDavid Updegraff 161853a5c424SDavid Updegraff Defines whether you want to support multicast TFTP as per 161953a5c424SDavid Updegraff rfc-2090; for example to work with atftp. Lets lots of targets 162011ccc33fSMarcel Ziswiler tftp down the same boot image concurrently. Note: the Ethernet 162153a5c424SDavid Updegraff driver in use must provide a function: mcast() to join/leave a 162253a5c424SDavid Updegraff multicast group. 162353a5c424SDavid Updegraff 1624c609719bSwdenk- BOOTP Recovery Mode: 1625c609719bSwdenk CONFIG_BOOTP_RANDOM_DELAY 1626c609719bSwdenk 1627c609719bSwdenk If you have many targets in a network that try to 1628c609719bSwdenk boot using BOOTP, you may want to avoid that all 1629c609719bSwdenk systems send out BOOTP requests at precisely the same 1630c609719bSwdenk moment (which would happen for instance at recovery 1631c609719bSwdenk from a power failure, when all systems will try to 1632c609719bSwdenk boot, thus flooding the BOOTP server. Defining 1633c609719bSwdenk CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be 1634c609719bSwdenk inserted before sending out BOOTP requests. The 16356c33c785SWolfgang Denk following delays are inserted then: 1636c609719bSwdenk 1637c609719bSwdenk 1st BOOTP request: delay 0 ... 1 sec 1638c609719bSwdenk 2nd BOOTP request: delay 0 ... 2 sec 1639c609719bSwdenk 3rd BOOTP request: delay 0 ... 4 sec 1640c609719bSwdenk 4th and following 1641c609719bSwdenk BOOTP requests: delay 0 ... 8 sec 1642c609719bSwdenk 1643fe389a82Sstroese- DHCP Advanced Options: 16441fe80d79SJon Loeliger You can fine tune the DHCP functionality by defining 16451fe80d79SJon Loeliger CONFIG_BOOTP_* symbols: 1646fe389a82Sstroese 16471fe80d79SJon Loeliger CONFIG_BOOTP_SUBNETMASK 16481fe80d79SJon Loeliger CONFIG_BOOTP_GATEWAY 16491fe80d79SJon Loeliger CONFIG_BOOTP_HOSTNAME 16501fe80d79SJon Loeliger CONFIG_BOOTP_NISDOMAIN 16511fe80d79SJon Loeliger CONFIG_BOOTP_BOOTPATH 16521fe80d79SJon Loeliger CONFIG_BOOTP_BOOTFILESIZE 16531fe80d79SJon Loeliger CONFIG_BOOTP_DNS 16541fe80d79SJon Loeliger CONFIG_BOOTP_DNS2 16551fe80d79SJon Loeliger CONFIG_BOOTP_SEND_HOSTNAME 16561fe80d79SJon Loeliger CONFIG_BOOTP_NTPSERVER 16571fe80d79SJon Loeliger CONFIG_BOOTP_TIMEOFFSET 16581fe80d79SJon Loeliger CONFIG_BOOTP_VENDOREX 16592c00e099SJoe Hershberger CONFIG_BOOTP_MAY_FAIL 1660fe389a82Sstroese 16615d110f0aSWilson Callan CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip 16625d110f0aSWilson Callan environment variable, not the BOOTP server. 1663fe389a82Sstroese 16642c00e099SJoe Hershberger CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found 16652c00e099SJoe Hershberger after the configured retry count, the call will fail 16662c00e099SJoe Hershberger instead of starting over. This can be used to fail over 16672c00e099SJoe Hershberger to Link-local IP address configuration if the DHCP server 16682c00e099SJoe Hershberger is not available. 16692c00e099SJoe Hershberger 1670fe389a82Sstroese CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS 1671fe389a82Sstroese serverip from a DHCP server, it is possible that more 1672fe389a82Sstroese than one DNS serverip is offered to the client. 1673fe389a82Sstroese If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS 1674fe389a82Sstroese serverip will be stored in the additional environment 1675fe389a82Sstroese variable "dnsip2". The first DNS serverip is always 1676fe389a82Sstroese stored in the variable "dnsip", when CONFIG_BOOTP_DNS 16771fe80d79SJon Loeliger is defined. 1678fe389a82Sstroese 1679fe389a82Sstroese CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable 1680fe389a82Sstroese to do a dynamic update of a DNS server. To do this, they 1681fe389a82Sstroese need the hostname of the DHCP requester. 16825d110f0aSWilson Callan If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content 16831fe80d79SJon Loeliger of the "hostname" environment variable is passed as 16841fe80d79SJon Loeliger option 12 to the DHCP server. 1685fe389a82Sstroese 1686d9a2f416SAras Vaichas CONFIG_BOOTP_DHCP_REQUEST_DELAY 1687d9a2f416SAras Vaichas 1688d9a2f416SAras Vaichas A 32bit value in microseconds for a delay between 1689d9a2f416SAras Vaichas receiving a "DHCP Offer" and sending the "DHCP Request". 1690d9a2f416SAras Vaichas This fixes a problem with certain DHCP servers that don't 1691d9a2f416SAras Vaichas respond 100% of the time to a "DHCP request". E.g. On an 1692d9a2f416SAras Vaichas AT91RM9200 processor running at 180MHz, this delay needed 1693d9a2f416SAras Vaichas to be *at least* 15,000 usec before a Windows Server 2003 1694d9a2f416SAras Vaichas DHCP server would reply 100% of the time. I recommend at 1695d9a2f416SAras Vaichas least 50,000 usec to be safe. The alternative is to hope 1696d9a2f416SAras Vaichas that one of the retries will be successful but note that 1697d9a2f416SAras Vaichas the DHCP timeout and retry process takes a longer than 1698d9a2f416SAras Vaichas this delay. 1699d9a2f416SAras Vaichas 1700d22c338eSJoe Hershberger - Link-local IP address negotiation: 1701d22c338eSJoe Hershberger Negotiate with other link-local clients on the local network 1702d22c338eSJoe Hershberger for an address that doesn't require explicit configuration. 1703d22c338eSJoe Hershberger This is especially useful if a DHCP server cannot be guaranteed 1704d22c338eSJoe Hershberger to exist in all environments that the device must operate. 1705d22c338eSJoe Hershberger 1706d22c338eSJoe Hershberger See doc/README.link-local for more information. 1707d22c338eSJoe Hershberger 1708a3d991bdSwdenk - CDP Options: 1709a3d991bdSwdenk CONFIG_CDP_DEVICE_ID 1710a3d991bdSwdenk 1711a3d991bdSwdenk The device id used in CDP trigger frames. 1712a3d991bdSwdenk 1713a3d991bdSwdenk CONFIG_CDP_DEVICE_ID_PREFIX 1714a3d991bdSwdenk 1715a3d991bdSwdenk A two character string which is prefixed to the MAC address 1716a3d991bdSwdenk of the device. 1717a3d991bdSwdenk 1718a3d991bdSwdenk CONFIG_CDP_PORT_ID 1719a3d991bdSwdenk 1720a3d991bdSwdenk A printf format string which contains the ascii name of 1721a3d991bdSwdenk the port. Normally is set to "eth%d" which sets 172211ccc33fSMarcel Ziswiler eth0 for the first Ethernet, eth1 for the second etc. 1723a3d991bdSwdenk 1724a3d991bdSwdenk CONFIG_CDP_CAPABILITIES 1725a3d991bdSwdenk 1726a3d991bdSwdenk A 32bit integer which indicates the device capabilities; 1727a3d991bdSwdenk 0x00000010 for a normal host which does not forwards. 1728a3d991bdSwdenk 1729a3d991bdSwdenk CONFIG_CDP_VERSION 1730a3d991bdSwdenk 1731a3d991bdSwdenk An ascii string containing the version of the software. 1732a3d991bdSwdenk 1733a3d991bdSwdenk CONFIG_CDP_PLATFORM 1734a3d991bdSwdenk 1735a3d991bdSwdenk An ascii string containing the name of the platform. 1736a3d991bdSwdenk 1737a3d991bdSwdenk CONFIG_CDP_TRIGGER 1738a3d991bdSwdenk 1739a3d991bdSwdenk A 32bit integer sent on the trigger. 1740a3d991bdSwdenk 1741a3d991bdSwdenk CONFIG_CDP_POWER_CONSUMPTION 1742a3d991bdSwdenk 1743a3d991bdSwdenk A 16bit integer containing the power consumption of the 1744a3d991bdSwdenk device in .1 of milliwatts. 1745a3d991bdSwdenk 1746a3d991bdSwdenk CONFIG_CDP_APPLIANCE_VLAN_TYPE 1747a3d991bdSwdenk 1748a3d991bdSwdenk A byte containing the id of the VLAN. 1749a3d991bdSwdenk 1750c609719bSwdenk- Status LED: CONFIG_STATUS_LED 1751c609719bSwdenk 1752c609719bSwdenk Several configurations allow to display the current 1753c609719bSwdenk status using a LED. For instance, the LED will blink 1754c609719bSwdenk fast while running U-Boot code, stop blinking as 1755c609719bSwdenk soon as a reply to a BOOTP request was received, and 1756c609719bSwdenk start blinking slow once the Linux kernel is running 1757c609719bSwdenk (supported by a status LED driver in the Linux 1758c609719bSwdenk kernel). Defining CONFIG_STATUS_LED enables this 1759c609719bSwdenk feature in U-Boot. 1760c609719bSwdenk 1761c609719bSwdenk- CAN Support: CONFIG_CAN_DRIVER 1762c609719bSwdenk 1763c609719bSwdenk Defining CONFIG_CAN_DRIVER enables CAN driver support 1764c609719bSwdenk on those systems that support this (optional) 1765c609719bSwdenk feature, like the TQM8xxL modules. 1766c609719bSwdenk 1767c609719bSwdenk- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C 1768c609719bSwdenk 1769b37c7e5eSwdenk These enable I2C serial bus commands. Defining either of 1770b37c7e5eSwdenk (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will 177111ccc33fSMarcel Ziswiler include the appropriate I2C driver for the selected CPU. 1772c609719bSwdenk 1773b37c7e5eSwdenk This will allow you to use i2c commands at the u-boot 1774602ad3b3SJon Loeliger command line (as long as you set CONFIG_CMD_I2C in 1775b37c7e5eSwdenk CONFIG_COMMANDS) and communicate with i2c based realtime 1776b37c7e5eSwdenk clock chips. See common/cmd_i2c.c for a description of the 1777c609719bSwdenk command line interface. 1778c609719bSwdenk 1779bb99ad6dSBen Warren CONFIG_HARD_I2C selects a hardware I2C controller. 1780c609719bSwdenk 1781b37c7e5eSwdenk CONFIG_SOFT_I2C configures u-boot to use a software (aka 1782b37c7e5eSwdenk bit-banging) driver instead of CPM or similar hardware 1783b37c7e5eSwdenk support for I2C. 1784c609719bSwdenk 1785b37c7e5eSwdenk There are several other quantities that must also be 1786b37c7e5eSwdenk defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C. 1787c609719bSwdenk 17886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD In both cases you will need to define CONFIG_SYS_I2C_SPEED 1789b37c7e5eSwdenk to be the frequency (in Hz) at which you wish your i2c bus 17906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie 179111ccc33fSMarcel Ziswiler the CPU's i2c node address). 1792c609719bSwdenk 17938d321b81SPeter Tyser Now, the u-boot i2c code for the mpc8xx 1794a47a12beSStefan Roese (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node 17958d321b81SPeter Tyser and so its address should therefore be cleared to 0 (See, 17968d321b81SPeter Tyser eg, MPC823e User's Manual p.16-473). So, set 17978d321b81SPeter Tyser CONFIG_SYS_I2C_SLAVE to 0. 1798b37c7e5eSwdenk 17995da71efaSEric Millbrandt CONFIG_SYS_I2C_INIT_MPC5XXX 18005da71efaSEric Millbrandt 18015da71efaSEric Millbrandt When a board is reset during an i2c bus transfer 18025da71efaSEric Millbrandt chips might think that the current transfer is still 18035da71efaSEric Millbrandt in progress. Reset the slave devices by sending start 18045da71efaSEric Millbrandt commands until the slave device responds. 18055da71efaSEric Millbrandt 1806b37c7e5eSwdenk That's all that's required for CONFIG_HARD_I2C. 1807b37c7e5eSwdenk 1808b37c7e5eSwdenk If you use the software i2c interface (CONFIG_SOFT_I2C) 1809b37c7e5eSwdenk then the following macros need to be defined (examples are 1810b37c7e5eSwdenk from include/configs/lwmon.h): 1811c609719bSwdenk 1812c609719bSwdenk I2C_INIT 1813c609719bSwdenk 1814b37c7e5eSwdenk (Optional). Any commands necessary to enable the I2C 1815c609719bSwdenk controller or configure ports. 1816c609719bSwdenk 1817b37c7e5eSwdenk eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL) 1818b37c7e5eSwdenk 1819c609719bSwdenk I2C_PORT 1820c609719bSwdenk 1821c609719bSwdenk (Only for MPC8260 CPU). The I/O port to use (the code 1822c609719bSwdenk assumes both bits are on the same port). Valid values 1823c609719bSwdenk are 0..3 for ports A..D. 1824c609719bSwdenk 1825c609719bSwdenk I2C_ACTIVE 1826c609719bSwdenk 1827c609719bSwdenk The code necessary to make the I2C data line active 1828c609719bSwdenk (driven). If the data line is open collector, this 1829c609719bSwdenk define can be null. 1830c609719bSwdenk 1831b37c7e5eSwdenk eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA) 1832b37c7e5eSwdenk 1833c609719bSwdenk I2C_TRISTATE 1834c609719bSwdenk 1835c609719bSwdenk The code necessary to make the I2C data line tri-stated 1836c609719bSwdenk (inactive). If the data line is open collector, this 1837c609719bSwdenk define can be null. 1838c609719bSwdenk 1839b37c7e5eSwdenk eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA) 1840b37c7e5eSwdenk 1841c609719bSwdenk I2C_READ 1842c609719bSwdenk 1843c609719bSwdenk Code that returns TRUE if the I2C data line is high, 1844c609719bSwdenk FALSE if it is low. 1845c609719bSwdenk 1846b37c7e5eSwdenk eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0) 1847b37c7e5eSwdenk 1848c609719bSwdenk I2C_SDA(bit) 1849c609719bSwdenk 1850c609719bSwdenk If <bit> is TRUE, sets the I2C data line high. If it 1851c609719bSwdenk is FALSE, it clears it (low). 1852c609719bSwdenk 1853b37c7e5eSwdenk eg: #define I2C_SDA(bit) \ 1854b37c7e5eSwdenk if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \ 1855b37c7e5eSwdenk else immr->im_cpm.cp_pbdat &= ~PB_SDA 1856b37c7e5eSwdenk 1857c609719bSwdenk I2C_SCL(bit) 1858c609719bSwdenk 1859c609719bSwdenk If <bit> is TRUE, sets the I2C clock line high. If it 1860c609719bSwdenk is FALSE, it clears it (low). 1861c609719bSwdenk 1862b37c7e5eSwdenk eg: #define I2C_SCL(bit) \ 1863b37c7e5eSwdenk if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \ 1864b37c7e5eSwdenk else immr->im_cpm.cp_pbdat &= ~PB_SCL 1865b37c7e5eSwdenk 1866c609719bSwdenk I2C_DELAY 1867c609719bSwdenk 1868c609719bSwdenk This delay is invoked four times per clock cycle so this 1869c609719bSwdenk controls the rate of data transfer. The data rate thus 1870b37c7e5eSwdenk is 1 / (I2C_DELAY * 4). Often defined to be something 1871b37c7e5eSwdenk like: 1872b37c7e5eSwdenk 1873b37c7e5eSwdenk #define I2C_DELAY udelay(2) 1874c609719bSwdenk 1875793b5726SMike Frysinger CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA 1876793b5726SMike Frysinger 1877793b5726SMike Frysinger If your arch supports the generic GPIO framework (asm/gpio.h), 1878793b5726SMike Frysinger then you may alternatively define the two GPIOs that are to be 1879793b5726SMike Frysinger used as SCL / SDA. Any of the previous I2C_xxx macros will 1880793b5726SMike Frysinger have GPIO-based defaults assigned to them as appropriate. 1881793b5726SMike Frysinger 1882793b5726SMike Frysinger You should define these to the GPIO value as given directly to 1883793b5726SMike Frysinger the generic GPIO functions. 1884793b5726SMike Frysinger 18856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_INIT_BOARD 188647cd00faSwdenk 188747cd00faSwdenk When a board is reset during an i2c bus transfer 188847cd00faSwdenk chips might think that the current transfer is still 188947cd00faSwdenk in progress. On some boards it is possible to access 189047cd00faSwdenk the i2c SCLK line directly, either by using the 189147cd00faSwdenk processor pin as a GPIO or by having a second pin 189247cd00faSwdenk connected to the bus. If this option is defined a 189347cd00faSwdenk custom i2c_init_board() routine in boards/xxx/board.c 189447cd00faSwdenk is run early in the boot sequence. 189547cd00faSwdenk 189626a33504SRichard Retanubun CONFIG_SYS_I2C_BOARD_LATE_INIT 189726a33504SRichard Retanubun 189826a33504SRichard Retanubun An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is 189926a33504SRichard Retanubun defined a custom i2c_board_late_init() routine in 190026a33504SRichard Retanubun boards/xxx/board.c is run AFTER the operations in i2c_init() 190126a33504SRichard Retanubun is completed. This callpoint can be used to unreset i2c bus 190226a33504SRichard Retanubun using CPU i2c controller register accesses for CPUs whose i2c 190326a33504SRichard Retanubun controller provide such a method. It is called at the end of 190426a33504SRichard Retanubun i2c_init() to allow i2c_init operations to setup the i2c bus 190526a33504SRichard Retanubun controller on the CPU (e.g. setting bus speed & slave address). 190626a33504SRichard Retanubun 190717ea1177Swdenk CONFIG_I2CFAST (PPC405GP|PPC405EP only) 190817ea1177Swdenk 190917ea1177Swdenk This option enables configuration of bi_iic_fast[] flags 191017ea1177Swdenk in u-boot bd_info structure based on u-boot environment 191117ea1177Swdenk variable "i2cfast". (see also i2cfast) 191217ea1177Swdenk 1913bb99ad6dSBen Warren CONFIG_I2C_MULTI_BUS 1914bb99ad6dSBen Warren 1915bb99ad6dSBen Warren This option allows the use of multiple I2C buses, each of which 1916bb99ad6dSBen Warren must have a controller. At any point in time, only one bus is 1917bb99ad6dSBen Warren active. To switch to a different bus, use the 'i2c dev' command. 1918bb99ad6dSBen Warren Note that bus numbering is zero-based. 1919bb99ad6dSBen Warren 19206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_NOPROBES 1921bb99ad6dSBen Warren 1922bb99ad6dSBen Warren This option specifies a list of I2C devices that will be skipped 19230f89c54bSPeter Tyser when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS 19240f89c54bSPeter Tyser is set, specify a list of bus-device pairs. Otherwise, specify 19250f89c54bSPeter Tyser a 1D array of device addresses 1926bb99ad6dSBen Warren 1927bb99ad6dSBen Warren e.g. 1928bb99ad6dSBen Warren #undef CONFIG_I2C_MULTI_BUS 19296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68} 1930bb99ad6dSBen Warren 1931bb99ad6dSBen Warren will skip addresses 0x50 and 0x68 on a board with one I2C bus 1932bb99ad6dSBen Warren 1933bb99ad6dSBen Warren #define CONFIG_I2C_MULTI_BUS 19346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}} 1935bb99ad6dSBen Warren 1936bb99ad6dSBen Warren will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1 1937bb99ad6dSBen Warren 19386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SPD_BUS_NUM 1939be5e6181STimur Tabi 1940be5e6181STimur Tabi If defined, then this indicates the I2C bus number for DDR SPD. 1941be5e6181STimur Tabi If not defined, then U-Boot assumes that SPD is on I2C bus 0. 1942be5e6181STimur Tabi 19436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_RTC_BUS_NUM 19440dc018ecSStefan Roese 19450dc018ecSStefan Roese If defined, then this indicates the I2C bus number for the RTC. 19460dc018ecSStefan Roese If not defined, then U-Boot assumes that RTC is on I2C bus 0. 19470dc018ecSStefan Roese 19486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_DTT_BUS_NUM 19490dc018ecSStefan Roese 19500dc018ecSStefan Roese If defined, then this indicates the I2C bus number for the DTT. 19510dc018ecSStefan Roese If not defined, then U-Boot assumes that DTT is on I2C bus 0. 19520dc018ecSStefan Roese 19536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_DTT_ADDR: 19549ebbb54fSVictor Gallardo 19559ebbb54fSVictor Gallardo If defined, specifies the I2C address of the DTT device. 19569ebbb54fSVictor Gallardo If not defined, then U-Boot uses predefined value for 19579ebbb54fSVictor Gallardo specified DTT device. 19589ebbb54fSVictor Gallardo 1959be5e6181STimur Tabi CONFIG_FSL_I2C 1960be5e6181STimur Tabi 1961be5e6181STimur Tabi Define this option if you want to use Freescale's I2C driver in 19627817cb20SMarcel Ziswiler drivers/i2c/fsl_i2c.c. 1963be5e6181STimur Tabi 196467b23a32SHeiko Schocher CONFIG_I2C_MUX 196567b23a32SHeiko Schocher 196667b23a32SHeiko Schocher Define this option if you have I2C devices reached over 1 .. n 196767b23a32SHeiko Schocher I2C Muxes like the pca9544a. This option addes a new I2C 196867b23a32SHeiko Schocher Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a 196967b23a32SHeiko Schocher new I2C Bus to the existing I2C Busses. If you select the 197067b23a32SHeiko Schocher new Bus with "i2c dev", u-bbot sends first the commandos for 197167b23a32SHeiko Schocher the muxes to activate this new "bus". 197267b23a32SHeiko Schocher 197367b23a32SHeiko Schocher CONFIG_I2C_MULTI_BUS must be also defined, to use this 197467b23a32SHeiko Schocher feature! 197567b23a32SHeiko Schocher 197667b23a32SHeiko Schocher Example: 197767b23a32SHeiko Schocher Adding a new I2C Bus reached over 2 pca9544a muxes 197867b23a32SHeiko Schocher The First mux with address 70 and channel 6 197967b23a32SHeiko Schocher The Second mux with address 71 and channel 4 198067b23a32SHeiko Schocher 198167b23a32SHeiko Schocher => i2c bus pca9544a:70:6:pca9544a:71:4 198267b23a32SHeiko Schocher 198367b23a32SHeiko Schocher Use the "i2c bus" command without parameter, to get a list 198467b23a32SHeiko Schocher of I2C Busses with muxes: 198567b23a32SHeiko Schocher 198667b23a32SHeiko Schocher => i2c bus 198767b23a32SHeiko Schocher Busses reached over muxes: 198867b23a32SHeiko Schocher Bus ID: 2 198967b23a32SHeiko Schocher reached over Mux(es): 199067b23a32SHeiko Schocher pca9544a@70 ch: 4 199167b23a32SHeiko Schocher Bus ID: 3 199267b23a32SHeiko Schocher reached over Mux(es): 199367b23a32SHeiko Schocher pca9544a@70 ch: 6 199467b23a32SHeiko Schocher pca9544a@71 ch: 4 199567b23a32SHeiko Schocher => 199667b23a32SHeiko Schocher 199767b23a32SHeiko Schocher If you now switch to the new I2C Bus 3 with "i2c dev 3" 1998f9a78b8dSMichael Jones u-boot first sends the command to the mux@70 to enable 1999f9a78b8dSMichael Jones channel 6, and then the command to the mux@71 to enable 200067b23a32SHeiko Schocher the channel 4. 200167b23a32SHeiko Schocher 200267b23a32SHeiko Schocher After that, you can use the "normal" i2c commands as 2003f9a78b8dSMichael Jones usual to communicate with your I2C devices behind 200467b23a32SHeiko Schocher the 2 muxes. 200567b23a32SHeiko Schocher 200667b23a32SHeiko Schocher This option is actually implemented for the bitbanging 200767b23a32SHeiko Schocher algorithm in common/soft_i2c.c and for the Hardware I2C 200867b23a32SHeiko Schocher Bus on the MPC8260. But it should be not so difficult 200967b23a32SHeiko Schocher to add this option to other architectures. 201067b23a32SHeiko Schocher 20112ac6985aSAndrew Dyer CONFIG_SOFT_I2C_READ_REPEATED_START 20122ac6985aSAndrew Dyer 20132ac6985aSAndrew Dyer defining this will force the i2c_read() function in 20142ac6985aSAndrew Dyer the soft_i2c driver to perform an I2C repeated start 20152ac6985aSAndrew Dyer between writing the address pointer and reading the 20162ac6985aSAndrew Dyer data. If this define is omitted the default behaviour 20172ac6985aSAndrew Dyer of doing a stop-start sequence will be used. Most I2C 20182ac6985aSAndrew Dyer devices can use either method, but some require one or 20192ac6985aSAndrew Dyer the other. 2020be5e6181STimur Tabi 2021c609719bSwdenk- SPI Support: CONFIG_SPI 2022c609719bSwdenk 2023c609719bSwdenk Enables SPI driver (so far only tested with 2024c609719bSwdenk SPI EEPROM, also an instance works with Crystal A/D and 2025c609719bSwdenk D/As on the SACSng board) 2026c609719bSwdenk 20276639562eSYoshihiro Shimoda CONFIG_SH_SPI 20286639562eSYoshihiro Shimoda 20296639562eSYoshihiro Shimoda Enables the driver for SPI controller on SuperH. Currently 20306639562eSYoshihiro Shimoda only SH7757 is supported. 20316639562eSYoshihiro Shimoda 2032c609719bSwdenk CONFIG_SPI_X 2033c609719bSwdenk 2034c609719bSwdenk Enables extended (16-bit) SPI EEPROM addressing. 2035c609719bSwdenk (symmetrical to CONFIG_I2C_X) 2036c609719bSwdenk 2037c609719bSwdenk CONFIG_SOFT_SPI 2038c609719bSwdenk 2039c609719bSwdenk Enables a software (bit-bang) SPI driver rather than 2040c609719bSwdenk using hardware support. This is a general purpose 2041c609719bSwdenk driver that only requires three general I/O port pins 2042c609719bSwdenk (two outputs, one input) to function. If this is 2043c609719bSwdenk defined, the board configuration must define several 2044c609719bSwdenk SPI configuration items (port pins to use, etc). For 2045c609719bSwdenk an example, see include/configs/sacsng.h. 2046c609719bSwdenk 204704a9e118SBen Warren CONFIG_HARD_SPI 204804a9e118SBen Warren 204904a9e118SBen Warren Enables a hardware SPI driver for general-purpose reads 205004a9e118SBen Warren and writes. As with CONFIG_SOFT_SPI, the board configuration 205104a9e118SBen Warren must define a list of chip-select function pointers. 205204a9e118SBen Warren Currently supported on some MPC8xxx processors. For an 205304a9e118SBen Warren example, see include/configs/mpc8349emds.h. 205404a9e118SBen Warren 205538254f45SGuennadi Liakhovetski CONFIG_MXC_SPI 205638254f45SGuennadi Liakhovetski 205738254f45SGuennadi Liakhovetski Enables the driver for the SPI controllers on i.MX and MXC 20582e3cd1cdSFabio Estevam SoCs. Currently i.MX31/35/51 are supported. 205938254f45SGuennadi Liakhovetski 20600133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA 20610133502eSMatthias Fuchs 20620133502eSMatthias Fuchs Enables FPGA subsystem. 20630133502eSMatthias Fuchs 20640133502eSMatthias Fuchs CONFIG_FPGA_<vendor> 20650133502eSMatthias Fuchs 20660133502eSMatthias Fuchs Enables support for specific chip vendors. 20670133502eSMatthias Fuchs (ALTERA, XILINX) 20680133502eSMatthias Fuchs 20690133502eSMatthias Fuchs CONFIG_FPGA_<family> 20700133502eSMatthias Fuchs 20710133502eSMatthias Fuchs Enables support for FPGA family. 20720133502eSMatthias Fuchs (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX) 20730133502eSMatthias Fuchs 20740133502eSMatthias Fuchs CONFIG_FPGA_COUNT 2075c609719bSwdenk 2076c609719bSwdenk Specify the number of FPGA devices to support. 2077c609719bSwdenk 20786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_PROG_FEEDBACK 2079c609719bSwdenk 2080c609719bSwdenk Enable printing of hash marks during FPGA configuration. 2081c609719bSwdenk 20826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_BUSY 2083c609719bSwdenk 2084c609719bSwdenk Enable checks on FPGA configuration interface busy 2085c609719bSwdenk status by the configuration function. This option 2086c609719bSwdenk will require a board or device specific function to 2087c609719bSwdenk be written. 2088c609719bSwdenk 2089c609719bSwdenk CONFIG_FPGA_DELAY 2090c609719bSwdenk 2091c609719bSwdenk If defined, a function that provides delays in the FPGA 2092c609719bSwdenk configuration driver. 2093c609719bSwdenk 20946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_CTRLC 2095c609719bSwdenk Allow Control-C to interrupt FPGA configuration 2096c609719bSwdenk 20976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_ERROR 2098c609719bSwdenk 2099c609719bSwdenk Check for configuration errors during FPGA bitfile 2100c609719bSwdenk loading. For example, abort during Virtex II 2101c609719bSwdenk configuration if the INIT_B line goes low (which 2102c609719bSwdenk indicated a CRC error). 2103c609719bSwdenk 21046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_INIT 2105c609719bSwdenk 2106c609719bSwdenk Maximum time to wait for the INIT_B line to deassert 2107c609719bSwdenk after PROB_B has been deasserted during a Virtex II 2108c609719bSwdenk FPGA configuration sequence. The default time is 500 210911ccc33fSMarcel Ziswiler ms. 2110c609719bSwdenk 21116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_BUSY 2112c609719bSwdenk 2113c609719bSwdenk Maximum time to wait for BUSY to deassert during 211411ccc33fSMarcel Ziswiler Virtex II FPGA configuration. The default is 5 ms. 2115c609719bSwdenk 21166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_CONFIG 2117c609719bSwdenk 2118c609719bSwdenk Time to wait after FPGA configuration. The default is 211911ccc33fSMarcel Ziswiler 200 ms. 2120c609719bSwdenk 2121c609719bSwdenk- Configuration Management: 2122c609719bSwdenk CONFIG_IDENT_STRING 2123c609719bSwdenk 2124c609719bSwdenk If defined, this string will be added to the U-Boot 2125c609719bSwdenk version information (U_BOOT_VERSION) 2126c609719bSwdenk 2127c609719bSwdenk- Vendor Parameter Protection: 2128c609719bSwdenk 2129c609719bSwdenk U-Boot considers the values of the environment 2130c609719bSwdenk variables "serial#" (Board Serial Number) and 21317152b1d0Swdenk "ethaddr" (Ethernet Address) to be parameters that 2132c609719bSwdenk are set once by the board vendor / manufacturer, and 2133c609719bSwdenk protects these variables from casual modification by 2134c609719bSwdenk the user. Once set, these variables are read-only, 2135c609719bSwdenk and write or delete attempts are rejected. You can 213611ccc33fSMarcel Ziswiler change this behaviour: 2137c609719bSwdenk 2138c609719bSwdenk If CONFIG_ENV_OVERWRITE is #defined in your config 2139c609719bSwdenk file, the write protection for vendor parameters is 214047cd00faSwdenk completely disabled. Anybody can change or delete 2141c609719bSwdenk these parameters. 2142c609719bSwdenk 2143c609719bSwdenk Alternatively, if you #define _both_ CONFIG_ETHADDR 2144c609719bSwdenk _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default 214511ccc33fSMarcel Ziswiler Ethernet address is installed in the environment, 2146c609719bSwdenk which can be changed exactly ONCE by the user. [The 2147c609719bSwdenk serial# is unaffected by this, i. e. it remains 2148c609719bSwdenk read-only.] 2149c609719bSwdenk 2150c609719bSwdenk- Protected RAM: 2151c609719bSwdenk CONFIG_PRAM 2152c609719bSwdenk 2153c609719bSwdenk Define this variable to enable the reservation of 2154c609719bSwdenk "protected RAM", i. e. RAM which is not overwritten 2155c609719bSwdenk by U-Boot. Define CONFIG_PRAM to hold the number of 2156c609719bSwdenk kB you want to reserve for pRAM. You can overwrite 2157c609719bSwdenk this default value by defining an environment 2158c609719bSwdenk variable "pram" to the number of kB you want to 2159c609719bSwdenk reserve. Note that the board info structure will 2160c609719bSwdenk still show the full amount of RAM. If pRAM is 2161c609719bSwdenk reserved, a new environment variable "mem" will 2162c609719bSwdenk automatically be defined to hold the amount of 2163c609719bSwdenk remaining RAM in a form that can be passed as boot 2164c609719bSwdenk argument to Linux, for instance like that: 2165c609719bSwdenk 2166fe126d8bSWolfgang Denk setenv bootargs ... mem=\${mem} 2167c609719bSwdenk saveenv 2168c609719bSwdenk 2169c609719bSwdenk This way you can tell Linux not to use this memory, 2170c609719bSwdenk either, which results in a memory region that will 2171c609719bSwdenk not be affected by reboots. 2172c609719bSwdenk 2173c609719bSwdenk *WARNING* If your board configuration uses automatic 2174c609719bSwdenk detection of the RAM size, you must make sure that 2175c609719bSwdenk this memory test is non-destructive. So far, the 2176c609719bSwdenk following board configurations are known to be 2177c609719bSwdenk "pRAM-clean": 2178c609719bSwdenk 2179c609719bSwdenk ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL, 2180c609719bSwdenk HERMES, IP860, RPXlite, LWMON, LANTEC, 2181544d97e9SWolfgang Denk FLAGADM, TQM8260 2182c609719bSwdenk 2183c609719bSwdenk- Error Recovery: 2184c609719bSwdenk CONFIG_PANIC_HANG 2185c609719bSwdenk 2186c609719bSwdenk Define this variable to stop the system in case of a 2187c609719bSwdenk fatal error, so that you have to reset it manually. 2188c609719bSwdenk This is probably NOT a good idea for an embedded 218911ccc33fSMarcel Ziswiler system where you want the system to reboot 2190c609719bSwdenk automatically as fast as possible, but it may be 2191c609719bSwdenk useful during development since you can try to debug 2192c609719bSwdenk the conditions that lead to the situation. 2193c609719bSwdenk 2194c609719bSwdenk CONFIG_NET_RETRY_COUNT 2195c609719bSwdenk 2196c609719bSwdenk This variable defines the number of retries for 2197c609719bSwdenk network operations like ARP, RARP, TFTP, or BOOTP 2198c609719bSwdenk before giving up the operation. If not defined, a 2199c609719bSwdenk default value of 5 is used. 2200c609719bSwdenk 220140cb90eeSGuennadi Liakhovetski CONFIG_ARP_TIMEOUT 220240cb90eeSGuennadi Liakhovetski 220340cb90eeSGuennadi Liakhovetski Timeout waiting for an ARP reply in milliseconds. 220440cb90eeSGuennadi Liakhovetski 220548a3e999STetsuyuki Kobayashi CONFIG_NFS_TIMEOUT 220648a3e999STetsuyuki Kobayashi 220748a3e999STetsuyuki Kobayashi Timeout in milliseconds used in NFS protocol. 220848a3e999STetsuyuki Kobayashi If you encounter "ERROR: Cannot umount" in nfs command, 220948a3e999STetsuyuki Kobayashi try longer timeout such as 221048a3e999STetsuyuki Kobayashi #define CONFIG_NFS_TIMEOUT 10000UL 221148a3e999STetsuyuki Kobayashi 2212c609719bSwdenk- Command Interpreter: 22138078f1a5SWolfgang Denk CONFIG_AUTO_COMPLETE 221404a85b3bSwdenk 221504a85b3bSwdenk Enable auto completion of commands using TAB. 221604a85b3bSwdenk 22178078f1a5SWolfgang Denk Note that this feature has NOT been implemented yet 22188078f1a5SWolfgang Denk for the "hush" shell. 22198078f1a5SWolfgang Denk 22208078f1a5SWolfgang Denk 22216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_HUSH_PARSER 2222c609719bSwdenk 2223c609719bSwdenk Define this variable to enable the "hush" shell (from 2224c609719bSwdenk Busybox) as command line interpreter, thus enabling 2225c609719bSwdenk powerful command line syntax like 2226c609719bSwdenk if...then...else...fi conditionals or `&&' and '||' 2227c609719bSwdenk constructs ("shell scripts"). 2228c609719bSwdenk 2229c609719bSwdenk If undefined, you get the old, much simpler behaviour 2230c609719bSwdenk with a somewhat smaller memory footprint. 2231c609719bSwdenk 2232c609719bSwdenk 22336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PROMPT_HUSH_PS2 2234c609719bSwdenk 2235c609719bSwdenk This defines the secondary prompt string, which is 2236c609719bSwdenk printed when the command interpreter needs more input 2237c609719bSwdenk to complete a command. Usually "> ". 2238c609719bSwdenk 2239c609719bSwdenk Note: 2240c609719bSwdenk 2241c609719bSwdenk In the current implementation, the local variables 2242c609719bSwdenk space and global environment variables space are 2243c609719bSwdenk separated. Local variables are those you define by 22443b57fe0aSwdenk simply typing `name=value'. To access a local 2245c609719bSwdenk variable later on, you have write `$name' or 22463b57fe0aSwdenk `${name}'; to execute the contents of a variable 22473b57fe0aSwdenk directly type `$name' at the command prompt. 2248c609719bSwdenk 2249c609719bSwdenk Global environment variables are those you use 2250c609719bSwdenk setenv/printenv to work with. To run a command stored 2251c609719bSwdenk in such a variable, you need to use the run command, 2252c609719bSwdenk and you must not use the '$' sign to access them. 2253c609719bSwdenk 2254c609719bSwdenk To store commands and special characters in a 2255c609719bSwdenk variable, please use double quotation marks 2256c609719bSwdenk surrounding the whole text of the variable, instead 2257c609719bSwdenk of the backslashes before semicolons and special 2258c609719bSwdenk symbols. 2259c609719bSwdenk 2260aa0c71acSWolfgang Denk- Commandline Editing and History: 2261aa0c71acSWolfgang Denk CONFIG_CMDLINE_EDITING 2262aa0c71acSWolfgang Denk 226311ccc33fSMarcel Ziswiler Enable editing and History functions for interactive 2264aa0c71acSWolfgang Denk commandline input operations 2265aa0c71acSWolfgang Denk 2266a8c7c708Swdenk- Default Environment: 2267c609719bSwdenk CONFIG_EXTRA_ENV_SETTINGS 2268c609719bSwdenk 2269c609719bSwdenk Define this to contain any number of null terminated 2270c609719bSwdenk strings (variable = value pairs) that will be part of 22717152b1d0Swdenk the default environment compiled into the boot image. 22722262cfeeSwdenk 2273c609719bSwdenk For example, place something like this in your 2274c609719bSwdenk board's config file: 2275c609719bSwdenk 2276c609719bSwdenk #define CONFIG_EXTRA_ENV_SETTINGS \ 2277c609719bSwdenk "myvar1=value1\0" \ 2278c609719bSwdenk "myvar2=value2\0" 2279c609719bSwdenk 2280c609719bSwdenk Warning: This method is based on knowledge about the 2281c609719bSwdenk internal format how the environment is stored by the 22822262cfeeSwdenk U-Boot code. This is NOT an official, exported 2283c609719bSwdenk interface! Although it is unlikely that this format 22847152b1d0Swdenk will change soon, there is no guarantee either. 2285c609719bSwdenk You better know what you are doing here. 2286c609719bSwdenk 2287c609719bSwdenk Note: overly (ab)use of the default environment is 2288c609719bSwdenk discouraged. Make sure to check other ways to preset 228974de7aefSWolfgang Denk the environment like the "source" command or the 2290c609719bSwdenk boot command first. 2291c609719bSwdenk 22925e724ca2SStephen Warren CONFIG_ENV_VARS_UBOOT_CONFIG 22935e724ca2SStephen Warren 22945e724ca2SStephen Warren Define this in order to add variables describing the 22955e724ca2SStephen Warren U-Boot build configuration to the default environment. 22965e724ca2SStephen Warren These will be named arch, cpu, board, vendor, and soc. 22975e724ca2SStephen Warren 22985e724ca2SStephen Warren Enabling this option will cause the following to be defined: 22995e724ca2SStephen Warren 23005e724ca2SStephen Warren - CONFIG_SYS_ARCH 23015e724ca2SStephen Warren - CONFIG_SYS_CPU 23025e724ca2SStephen Warren - CONFIG_SYS_BOARD 23035e724ca2SStephen Warren - CONFIG_SYS_VENDOR 23045e724ca2SStephen Warren - CONFIG_SYS_SOC 23055e724ca2SStephen Warren 2306a8c7c708Swdenk- DataFlash Support: 23072abbe075Swdenk CONFIG_HAS_DATAFLASH 23082abbe075Swdenk 23092abbe075Swdenk Defining this option enables DataFlash features and 23102abbe075Swdenk allows to read/write in Dataflash via the standard 23112abbe075Swdenk commands cp, md... 23122abbe075Swdenk 2313f61ec45eSEric Nelson- Serial Flash support 2314f61ec45eSEric Nelson CONFIG_CMD_SF 2315f61ec45eSEric Nelson 2316f61ec45eSEric Nelson Defining this option enables SPI flash commands 2317f61ec45eSEric Nelson 'sf probe/read/write/erase/update'. 2318f61ec45eSEric Nelson 2319f61ec45eSEric Nelson Usage requires an initial 'probe' to define the serial 2320f61ec45eSEric Nelson flash parameters, followed by read/write/erase/update 2321f61ec45eSEric Nelson commands. 2322f61ec45eSEric Nelson 2323f61ec45eSEric Nelson The following defaults may be provided by the platform 2324f61ec45eSEric Nelson to handle the common case when only a single serial 2325f61ec45eSEric Nelson flash is present on the system. 2326f61ec45eSEric Nelson 2327f61ec45eSEric Nelson CONFIG_SF_DEFAULT_BUS Bus identifier 2328f61ec45eSEric Nelson CONFIG_SF_DEFAULT_CS Chip-select 2329f61ec45eSEric Nelson CONFIG_SF_DEFAULT_MODE (see include/spi.h) 2330f61ec45eSEric Nelson CONFIG_SF_DEFAULT_SPEED in Hz 2331f61ec45eSEric Nelson 23323f85ce27Swdenk- SystemACE Support: 23333f85ce27Swdenk CONFIG_SYSTEMACE 23343f85ce27Swdenk 23353f85ce27Swdenk Adding this option adds support for Xilinx SystemACE 23363f85ce27Swdenk chips attached via some sort of local bus. The address 233711ccc33fSMarcel Ziswiler of the chip must also be defined in the 23386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SYSTEMACE_BASE macro. For example: 23393f85ce27Swdenk 23403f85ce27Swdenk #define CONFIG_SYSTEMACE 23416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000 23423f85ce27Swdenk 23433f85ce27Swdenk When SystemACE support is added, the "ace" device type 23443f85ce27Swdenk becomes available to the fat commands, i.e. fatls. 23453f85ce27Swdenk 2346ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port: 2347ecb0ccd9SWolfgang Denk CONFIG_TFTP_PORT 2348ecb0ccd9SWolfgang Denk 234928cb9375SWolfgang Denk If this is defined, the environment variable tftpsrcp 2350ecb0ccd9SWolfgang Denk is used to supply the TFTP UDP source port value. 235128cb9375SWolfgang Denk If tftpsrcp isn't defined, the normal pseudo-random port 2352ecb0ccd9SWolfgang Denk number generator is used. 2353ecb0ccd9SWolfgang Denk 235428cb9375SWolfgang Denk Also, the environment variable tftpdstp is used to supply 235528cb9375SWolfgang Denk the TFTP UDP destination port value. If tftpdstp isn't 235628cb9375SWolfgang Denk defined, the normal port 69 is used. 235728cb9375SWolfgang Denk 235828cb9375SWolfgang Denk The purpose for tftpsrcp is to allow a TFTP server to 2359ecb0ccd9SWolfgang Denk blindly start the TFTP transfer using the pre-configured 2360ecb0ccd9SWolfgang Denk target IP address and UDP port. This has the effect of 2361ecb0ccd9SWolfgang Denk "punching through" the (Windows XP) firewall, allowing 2362ecb0ccd9SWolfgang Denk the remainder of the TFTP transfer to proceed normally. 2363ecb0ccd9SWolfgang Denk A better solution is to properly configure the firewall, 2364ecb0ccd9SWolfgang Denk but sometimes that is not allowed. 2365ecb0ccd9SWolfgang Denk 2366a8c7c708Swdenk- Show boot progress: 2367c609719bSwdenk CONFIG_SHOW_BOOT_PROGRESS 2368c609719bSwdenk 2369c609719bSwdenk Defining this option allows to add some board- 2370c609719bSwdenk specific code (calling a user-provided function 2371c609719bSwdenk "show_boot_progress(int)") that enables you to show 2372c609719bSwdenk the system's boot progress on some display (for 2373c609719bSwdenk example, some LED's) on your board. At the moment, 2374c609719bSwdenk the following checkpoints are implemented: 2375c609719bSwdenk 23763a608ca0SSimon Glass- Detailed boot stage timing 23773a608ca0SSimon Glass CONFIG_BOOTSTAGE 23783a608ca0SSimon Glass Define this option to get detailed timing of each stage 23793a608ca0SSimon Glass of the boot process. 23803a608ca0SSimon Glass 23813a608ca0SSimon Glass CONFIG_BOOTSTAGE_USER_COUNT 23823a608ca0SSimon Glass This is the number of available user bootstage records. 23833a608ca0SSimon Glass Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...) 23843a608ca0SSimon Glass a new ID will be allocated from this stash. If you exceed 23853a608ca0SSimon Glass the limit, recording will stop. 23863a608ca0SSimon Glass 23873a608ca0SSimon Glass CONFIG_BOOTSTAGE_REPORT 23883a608ca0SSimon Glass Define this to print a report before boot, similar to this: 23893a608ca0SSimon Glass 23903a608ca0SSimon Glass Timer summary in microseconds: 23913a608ca0SSimon Glass Mark Elapsed Stage 23923a608ca0SSimon Glass 0 0 reset 23933a608ca0SSimon Glass 3,575,678 3,575,678 board_init_f start 23943a608ca0SSimon Glass 3,575,695 17 arch_cpu_init A9 23953a608ca0SSimon Glass 3,575,777 82 arch_cpu_init done 23963a608ca0SSimon Glass 3,659,598 83,821 board_init_r start 23973a608ca0SSimon Glass 3,910,375 250,777 main_loop 23983a608ca0SSimon Glass 29,916,167 26,005,792 bootm_start 23993a608ca0SSimon Glass 30,361,327 445,160 start_kernel 24003a608ca0SSimon Glass 24012eba38cfSSimon Glass CONFIG_CMD_BOOTSTAGE 24022eba38cfSSimon Glass Add a 'bootstage' command which supports printing a report 24032eba38cfSSimon Glass and un/stashing of bootstage data. 24042eba38cfSSimon Glass 240594fd1316SSimon Glass CONFIG_BOOTSTAGE_FDT 240694fd1316SSimon Glass Stash the bootstage information in the FDT. A root 'bootstage' 240794fd1316SSimon Glass node is created with each bootstage id as a child. Each child 240894fd1316SSimon Glass has a 'name' property and either 'mark' containing the 240994fd1316SSimon Glass mark time in microsecond, or 'accum' containing the 241094fd1316SSimon Glass accumulated time for that bootstage id in microseconds. 241194fd1316SSimon Glass For example: 241294fd1316SSimon Glass 241394fd1316SSimon Glass bootstage { 241494fd1316SSimon Glass 154 { 241594fd1316SSimon Glass name = "board_init_f"; 241694fd1316SSimon Glass mark = <3575678>; 241794fd1316SSimon Glass }; 241894fd1316SSimon Glass 170 { 241994fd1316SSimon Glass name = "lcd"; 242094fd1316SSimon Glass accum = <33482>; 242194fd1316SSimon Glass }; 242294fd1316SSimon Glass }; 242394fd1316SSimon Glass 242494fd1316SSimon Glass Code in the Linux kernel can find this in /proc/devicetree. 242594fd1316SSimon Glass 24261372cce2SMarian BalakowiczLegacy uImage format: 24271372cce2SMarian Balakowicz 2428c609719bSwdenk Arg Where When 2429c609719bSwdenk 1 common/cmd_bootm.c before attempting to boot an image 2430c609719bSwdenk -1 common/cmd_bootm.c Image header has bad magic number 2431c609719bSwdenk 2 common/cmd_bootm.c Image header has correct magic number 2432c609719bSwdenk -2 common/cmd_bootm.c Image header has bad checksum 2433c609719bSwdenk 3 common/cmd_bootm.c Image header has correct checksum 2434c609719bSwdenk -3 common/cmd_bootm.c Image data has bad checksum 2435c609719bSwdenk 4 common/cmd_bootm.c Image data has correct checksum 2436c609719bSwdenk -4 common/cmd_bootm.c Image is for unsupported architecture 2437c609719bSwdenk 5 common/cmd_bootm.c Architecture check OK 24381372cce2SMarian Balakowicz -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi) 2439c609719bSwdenk 6 common/cmd_bootm.c Image Type check OK 2440c609719bSwdenk -6 common/cmd_bootm.c gunzip uncompression error 2441c609719bSwdenk -7 common/cmd_bootm.c Unimplemented compression type 2442c609719bSwdenk 7 common/cmd_bootm.c Uncompression OK 24431372cce2SMarian Balakowicz 8 common/cmd_bootm.c No uncompress/copy overwrite error 2444c609719bSwdenk -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX) 24451372cce2SMarian Balakowicz 24461372cce2SMarian Balakowicz 9 common/image.c Start initial ramdisk verification 24471372cce2SMarian Balakowicz -10 common/image.c Ramdisk header has bad magic number 24481372cce2SMarian Balakowicz -11 common/image.c Ramdisk header has bad checksum 24491372cce2SMarian Balakowicz 10 common/image.c Ramdisk header is OK 24501372cce2SMarian Balakowicz -12 common/image.c Ramdisk data has bad checksum 24511372cce2SMarian Balakowicz 11 common/image.c Ramdisk data has correct checksum 24521372cce2SMarian Balakowicz 12 common/image.c Ramdisk verification complete, start loading 245311ccc33fSMarcel Ziswiler -13 common/image.c Wrong Image Type (not PPC Linux ramdisk) 24541372cce2SMarian Balakowicz 13 common/image.c Start multifile image verification 24551372cce2SMarian Balakowicz 14 common/image.c No initial ramdisk, no multifile, continue. 24561372cce2SMarian Balakowicz 2457ea0364f1SPeter Tyser 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS 2458c609719bSwdenk 2459a47a12beSStefan Roese -30 arch/powerpc/lib/board.c Fatal error, hang the system 246063e73c9aSwdenk -31 post/post.c POST test failed, detected by post_output_backlog() 246163e73c9aSwdenk -32 post/post.c POST test failed, detected by post_run_single() 246263e73c9aSwdenk 2463566a494fSHeiko Schocher 34 common/cmd_doc.c before loading a Image from a DOC device 2464566a494fSHeiko Schocher -35 common/cmd_doc.c Bad usage of "doc" command 2465566a494fSHeiko Schocher 35 common/cmd_doc.c correct usage of "doc" command 2466566a494fSHeiko Schocher -36 common/cmd_doc.c No boot device 2467566a494fSHeiko Schocher 36 common/cmd_doc.c correct boot device 2468566a494fSHeiko Schocher -37 common/cmd_doc.c Unknown Chip ID on boot device 2469566a494fSHeiko Schocher 37 common/cmd_doc.c correct chip ID found, device available 2470566a494fSHeiko Schocher -38 common/cmd_doc.c Read Error on boot device 2471566a494fSHeiko Schocher 38 common/cmd_doc.c reading Image header from DOC device OK 2472566a494fSHeiko Schocher -39 common/cmd_doc.c Image header has bad magic number 2473566a494fSHeiko Schocher 39 common/cmd_doc.c Image header has correct magic number 2474566a494fSHeiko Schocher -40 common/cmd_doc.c Error reading Image from DOC device 2475566a494fSHeiko Schocher 40 common/cmd_doc.c Image header has correct magic number 2476566a494fSHeiko Schocher 41 common/cmd_ide.c before loading a Image from a IDE device 2477566a494fSHeiko Schocher -42 common/cmd_ide.c Bad usage of "ide" command 2478566a494fSHeiko Schocher 42 common/cmd_ide.c correct usage of "ide" command 2479566a494fSHeiko Schocher -43 common/cmd_ide.c No boot device 2480566a494fSHeiko Schocher 43 common/cmd_ide.c boot device found 2481566a494fSHeiko Schocher -44 common/cmd_ide.c Device not available 2482566a494fSHeiko Schocher 44 common/cmd_ide.c Device available 2483566a494fSHeiko Schocher -45 common/cmd_ide.c wrong partition selected 2484566a494fSHeiko Schocher 45 common/cmd_ide.c partition selected 2485566a494fSHeiko Schocher -46 common/cmd_ide.c Unknown partition table 2486566a494fSHeiko Schocher 46 common/cmd_ide.c valid partition table found 2487566a494fSHeiko Schocher -47 common/cmd_ide.c Invalid partition type 2488566a494fSHeiko Schocher 47 common/cmd_ide.c correct partition type 2489566a494fSHeiko Schocher -48 common/cmd_ide.c Error reading Image Header on boot device 2490566a494fSHeiko Schocher 48 common/cmd_ide.c reading Image Header from IDE device OK 2491566a494fSHeiko Schocher -49 common/cmd_ide.c Image header has bad magic number 2492566a494fSHeiko Schocher 49 common/cmd_ide.c Image header has correct magic number 2493566a494fSHeiko Schocher -50 common/cmd_ide.c Image header has bad checksum 2494566a494fSHeiko Schocher 50 common/cmd_ide.c Image header has correct checksum 2495566a494fSHeiko Schocher -51 common/cmd_ide.c Error reading Image from IDE device 2496566a494fSHeiko Schocher 51 common/cmd_ide.c reading Image from IDE device OK 2497566a494fSHeiko Schocher 52 common/cmd_nand.c before loading a Image from a NAND device 2498566a494fSHeiko Schocher -53 common/cmd_nand.c Bad usage of "nand" command 2499566a494fSHeiko Schocher 53 common/cmd_nand.c correct usage of "nand" command 2500566a494fSHeiko Schocher -54 common/cmd_nand.c No boot device 2501566a494fSHeiko Schocher 54 common/cmd_nand.c boot device found 2502566a494fSHeiko Schocher -55 common/cmd_nand.c Unknown Chip ID on boot device 2503566a494fSHeiko Schocher 55 common/cmd_nand.c correct chip ID found, device available 2504566a494fSHeiko Schocher -56 common/cmd_nand.c Error reading Image Header on boot device 2505566a494fSHeiko Schocher 56 common/cmd_nand.c reading Image Header from NAND device OK 2506566a494fSHeiko Schocher -57 common/cmd_nand.c Image header has bad magic number 2507566a494fSHeiko Schocher 57 common/cmd_nand.c Image header has correct magic number 2508566a494fSHeiko Schocher -58 common/cmd_nand.c Error reading Image from NAND device 2509566a494fSHeiko Schocher 58 common/cmd_nand.c reading Image from NAND device OK 2510c609719bSwdenk 2511566a494fSHeiko Schocher -60 common/env_common.c Environment has a bad CRC, using default 2512c609719bSwdenk 2513566a494fSHeiko Schocher 64 net/eth.c starting with Ethernet configuration. 2514566a494fSHeiko Schocher -64 net/eth.c no Ethernet found. 2515566a494fSHeiko Schocher 65 net/eth.c Ethernet found. 2516206c60cbSwdenk 2517566a494fSHeiko Schocher -80 common/cmd_net.c usage wrong 2518566a494fSHeiko Schocher 80 common/cmd_net.c before calling NetLoop() 251911ccc33fSMarcel Ziswiler -81 common/cmd_net.c some error in NetLoop() occurred 2520566a494fSHeiko Schocher 81 common/cmd_net.c NetLoop() back without error 2521566a494fSHeiko Schocher -82 common/cmd_net.c size == 0 (File with size 0 loaded) 2522566a494fSHeiko Schocher 82 common/cmd_net.c trying automatic boot 252374de7aefSWolfgang Denk 83 common/cmd_net.c running "source" command 252474de7aefSWolfgang Denk -83 common/cmd_net.c some error in automatic boot or "source" command 2525566a494fSHeiko Schocher 84 common/cmd_net.c end without errors 2526c609719bSwdenk 25271372cce2SMarian BalakowiczFIT uImage format: 25281372cce2SMarian Balakowicz 25291372cce2SMarian Balakowicz Arg Where When 25301372cce2SMarian Balakowicz 100 common/cmd_bootm.c Kernel FIT Image has correct format 25311372cce2SMarian Balakowicz -100 common/cmd_bootm.c Kernel FIT Image has incorrect format 25321372cce2SMarian Balakowicz 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration 25331372cce2SMarian Balakowicz -101 common/cmd_bootm.c Can't get configuration for kernel subimage 25341372cce2SMarian Balakowicz 102 common/cmd_bootm.c Kernel unit name specified 25351372cce2SMarian Balakowicz -103 common/cmd_bootm.c Can't get kernel subimage node offset 2536f773bea8SMarian Balakowicz 103 common/cmd_bootm.c Found configuration node 25371372cce2SMarian Balakowicz 104 common/cmd_bootm.c Got kernel subimage node offset 25381372cce2SMarian Balakowicz -104 common/cmd_bootm.c Kernel subimage hash verification failed 25391372cce2SMarian Balakowicz 105 common/cmd_bootm.c Kernel subimage hash verification OK 25401372cce2SMarian Balakowicz -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture 25411372cce2SMarian Balakowicz 106 common/cmd_bootm.c Architecture check OK 254211ccc33fSMarcel Ziswiler -106 common/cmd_bootm.c Kernel subimage has wrong type 254311ccc33fSMarcel Ziswiler 107 common/cmd_bootm.c Kernel subimage type OK 25441372cce2SMarian Balakowicz -107 common/cmd_bootm.c Can't get kernel subimage data/size 25451372cce2SMarian Balakowicz 108 common/cmd_bootm.c Got kernel subimage data/size 25461372cce2SMarian Balakowicz -108 common/cmd_bootm.c Wrong image type (not legacy, FIT) 25471372cce2SMarian Balakowicz -109 common/cmd_bootm.c Can't get kernel subimage type 25481372cce2SMarian Balakowicz -110 common/cmd_bootm.c Can't get kernel subimage comp 25491372cce2SMarian Balakowicz -111 common/cmd_bootm.c Can't get kernel subimage os 25501372cce2SMarian Balakowicz -112 common/cmd_bootm.c Can't get kernel subimage load address 25511372cce2SMarian Balakowicz -113 common/cmd_bootm.c Image uncompress/copy overwrite error 25521372cce2SMarian Balakowicz 25531372cce2SMarian Balakowicz 120 common/image.c Start initial ramdisk verification 25541372cce2SMarian Balakowicz -120 common/image.c Ramdisk FIT image has incorrect format 25551372cce2SMarian Balakowicz 121 common/image.c Ramdisk FIT image has correct format 255611ccc33fSMarcel Ziswiler 122 common/image.c No ramdisk subimage unit name, using configuration 25571372cce2SMarian Balakowicz -122 common/image.c Can't get configuration for ramdisk subimage 25581372cce2SMarian Balakowicz 123 common/image.c Ramdisk unit name specified 25591372cce2SMarian Balakowicz -124 common/image.c Can't get ramdisk subimage node offset 25601372cce2SMarian Balakowicz 125 common/image.c Got ramdisk subimage node offset 25611372cce2SMarian Balakowicz -125 common/image.c Ramdisk subimage hash verification failed 25621372cce2SMarian Balakowicz 126 common/image.c Ramdisk subimage hash verification OK 25631372cce2SMarian Balakowicz -126 common/image.c Ramdisk subimage for unsupported architecture 25641372cce2SMarian Balakowicz 127 common/image.c Architecture check OK 25651372cce2SMarian Balakowicz -127 common/image.c Can't get ramdisk subimage data/size 25661372cce2SMarian Balakowicz 128 common/image.c Got ramdisk subimage data/size 25671372cce2SMarian Balakowicz 129 common/image.c Can't get ramdisk load address 25681372cce2SMarian Balakowicz -129 common/image.c Got ramdisk load address 25691372cce2SMarian Balakowicz 257011ccc33fSMarcel Ziswiler -130 common/cmd_doc.c Incorrect FIT image format 25711372cce2SMarian Balakowicz 131 common/cmd_doc.c FIT image format OK 25721372cce2SMarian Balakowicz 257311ccc33fSMarcel Ziswiler -140 common/cmd_ide.c Incorrect FIT image format 25741372cce2SMarian Balakowicz 141 common/cmd_ide.c FIT image format OK 25751372cce2SMarian Balakowicz 257611ccc33fSMarcel Ziswiler -150 common/cmd_nand.c Incorrect FIT image format 25771372cce2SMarian Balakowicz 151 common/cmd_nand.c FIT image format OK 25781372cce2SMarian Balakowicz 25794cf2609bSWolfgang Denk- Standalone program support: 25804cf2609bSWolfgang Denk CONFIG_STANDALONE_LOAD_ADDR 25814cf2609bSWolfgang Denk 25826feff899SWolfgang Denk This option defines a board specific value for the 25836feff899SWolfgang Denk address where standalone program gets loaded, thus 25846feff899SWolfgang Denk overwriting the architecture dependent default 25854cf2609bSWolfgang Denk settings. 25864cf2609bSWolfgang Denk 25874cf2609bSWolfgang Denk- Frame Buffer Address: 25884cf2609bSWolfgang Denk CONFIG_FB_ADDR 25894cf2609bSWolfgang Denk 25904cf2609bSWolfgang Denk Define CONFIG_FB_ADDR if you want to use specific 25914cf2609bSWolfgang Denk address for frame buffer. 25924cf2609bSWolfgang Denk Then system will reserve the frame buffer address to 25934cf2609bSWolfgang Denk defined address instead of lcd_setmem (this function 25946feff899SWolfgang Denk grabs the memory for frame buffer by panel's size). 25954cf2609bSWolfgang Denk 25964cf2609bSWolfgang Denk Please see board_init_f function. 25974cf2609bSWolfgang Denk 2598cccfc2abSDetlev Zundel- Automatic software updates via TFTP server 2599cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP 2600cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP_CNT_MAX 2601cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP_MSEC_MAX 2602cccfc2abSDetlev Zundel 2603cccfc2abSDetlev Zundel These options enable and control the auto-update feature; 2604cccfc2abSDetlev Zundel for a more detailed description refer to doc/README.update. 2605cccfc2abSDetlev Zundel 2606cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support) 2607cccfc2abSDetlev Zundel CONFIG_MTD_DEVICE 2608cccfc2abSDetlev Zundel 2609cccfc2abSDetlev Zundel Adds the MTD device infrastructure from the Linux kernel. 2610cccfc2abSDetlev Zundel Needed for mtdparts command support. 2611cccfc2abSDetlev Zundel 2612cccfc2abSDetlev Zundel CONFIG_MTD_PARTITIONS 2613cccfc2abSDetlev Zundel 2614cccfc2abSDetlev Zundel Adds the MTD partitioning infrastructure from the Linux 2615cccfc2abSDetlev Zundel kernel. Needed for UBI support. 2616cccfc2abSDetlev Zundel 26176a11cf48SDaniel Schwierzeck- SPL framework 26186a11cf48SDaniel Schwierzeck CONFIG_SPL 26196a11cf48SDaniel Schwierzeck Enable building of SPL globally. 26206a11cf48SDaniel Schwierzeck 262195579793STom Rini CONFIG_SPL_LDSCRIPT 262295579793STom Rini LDSCRIPT for linking the SPL binary. 262395579793STom Rini 262495579793STom Rini CONFIG_SPL_MAX_SIZE 262595579793STom Rini Maximum binary size (text, data and rodata) of the SPL binary. 262695579793STom Rini 26276a11cf48SDaniel Schwierzeck CONFIG_SPL_TEXT_BASE 26286a11cf48SDaniel Schwierzeck TEXT_BASE for linking the SPL binary. 26296a11cf48SDaniel Schwierzeck 263095579793STom Rini CONFIG_SPL_BSS_START_ADDR 263195579793STom Rini Link address for the BSS within the SPL binary. 263295579793STom Rini 263395579793STom Rini CONFIG_SPL_BSS_MAX_SIZE 263495579793STom Rini Maximum binary size of the BSS section of the SPL binary. 263595579793STom Rini 263695579793STom Rini CONFIG_SPL_STACK 263795579793STom Rini Adress of the start of the stack SPL will use 263895579793STom Rini 263995579793STom Rini CONFIG_SYS_SPL_MALLOC_START 264095579793STom Rini Starting address of the malloc pool used in SPL. 264195579793STom Rini 264295579793STom Rini CONFIG_SYS_SPL_MALLOC_SIZE 264395579793STom Rini The size of the malloc pool used in SPL. 26446a11cf48SDaniel Schwierzeck 264547f7bcaeSTom Rini CONFIG_SPL_FRAMEWORK 264647f7bcaeSTom Rini Enable the SPL framework under common/. This framework 264747f7bcaeSTom Rini supports MMC, NAND and YMODEM loading of U-Boot and NAND 264847f7bcaeSTom Rini NAND loading of the Linux Kernel. 264947f7bcaeSTom Rini 2650861a86f4STom Rini CONFIG_SPL_DISPLAY_PRINT 2651861a86f4STom Rini For ARM, enable an optional function to print more information 2652861a86f4STom Rini about the running system. 2653861a86f4STom Rini 26546a11cf48SDaniel Schwierzeck CONFIG_SPL_LIBCOMMON_SUPPORT 26556a11cf48SDaniel Schwierzeck Support for common/libcommon.o in SPL binary 26566a11cf48SDaniel Schwierzeck 26576a11cf48SDaniel Schwierzeck CONFIG_SPL_LIBDISK_SUPPORT 26586a11cf48SDaniel Schwierzeck Support for disk/libdisk.o in SPL binary 26596a11cf48SDaniel Schwierzeck 26606a11cf48SDaniel Schwierzeck CONFIG_SPL_I2C_SUPPORT 26616a11cf48SDaniel Schwierzeck Support for drivers/i2c/libi2c.o in SPL binary 26626a11cf48SDaniel Schwierzeck 26636a11cf48SDaniel Schwierzeck CONFIG_SPL_GPIO_SUPPORT 26646a11cf48SDaniel Schwierzeck Support for drivers/gpio/libgpio.o in SPL binary 26656a11cf48SDaniel Schwierzeck 26666a11cf48SDaniel Schwierzeck CONFIG_SPL_MMC_SUPPORT 26676a11cf48SDaniel Schwierzeck Support for drivers/mmc/libmmc.o in SPL binary 26686a11cf48SDaniel Schwierzeck 266995579793STom Rini CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR, 267095579793STom Rini CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS, 267195579793STom Rini CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION 267295579793STom Rini Address, size and partition on the MMC to load U-Boot from 267395579793STom Rini when the MMC is being used in raw mode. 267495579793STom Rini 267595579793STom Rini CONFIG_SPL_FAT_SUPPORT 267695579793STom Rini Support for fs/fat/libfat.o in SPL binary 267795579793STom Rini 267895579793STom Rini CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME 267995579793STom Rini Filename to read to load U-Boot when reading from FAT 268095579793STom Rini 268195579793STom Rini CONFIG_SPL_NAND_SIMPLE 268295579793STom Rini Support for drivers/mtd/nand/libnand.o in SPL binary 268395579793STom Rini 268495579793STom Rini CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT, 268595579793STom Rini CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE, 268695579793STom Rini CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS, 268795579793STom Rini CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE, 268895579793STom Rini CONFIG_SYS_NAND_ECCBYTES 268995579793STom Rini Defines the size and behavior of the NAND that SPL uses 269095579793STom Rini to read U-Boot with CONFIG_SPL_NAND_SIMPLE 269195579793STom Rini 269295579793STom Rini CONFIG_SYS_NAND_U_BOOT_OFFS 269395579793STom Rini Location in NAND for CONFIG_SPL_NAND_SIMPLE to read U-Boot 269495579793STom Rini from. 269595579793STom Rini 269695579793STom Rini CONFIG_SYS_NAND_U_BOOT_START 269795579793STom Rini Location in memory for CONFIG_SPL_NAND_SIMPLE to load U-Boot 269895579793STom Rini to. 269995579793STom Rini 270095579793STom Rini CONFIG_SYS_NAND_HW_ECC_OOBFIRST 270195579793STom Rini Define this if you need to first read the OOB and then the 270295579793STom Rini data. This is used for example on davinci plattforms. 270395579793STom Rini 270495579793STom Rini CONFIG_SPL_OMAP3_ID_NAND 270595579793STom Rini Support for an OMAP3-specific set of functions to return the 270695579793STom Rini ID and MFR of the first attached NAND chip, if present. 270795579793STom Rini 27086a11cf48SDaniel Schwierzeck CONFIG_SPL_SERIAL_SUPPORT 27096a11cf48SDaniel Schwierzeck Support for drivers/serial/libserial.o in SPL binary 27106a11cf48SDaniel Schwierzeck 27116a11cf48SDaniel Schwierzeck CONFIG_SPL_SPI_FLASH_SUPPORT 27126a11cf48SDaniel Schwierzeck Support for drivers/mtd/spi/libspi_flash.o in SPL binary 27136a11cf48SDaniel Schwierzeck 27146a11cf48SDaniel Schwierzeck CONFIG_SPL_SPI_SUPPORT 27156a11cf48SDaniel Schwierzeck Support for drivers/spi/libspi.o in SPL binary 27166a11cf48SDaniel Schwierzeck 2717c57b953dSPavel Machek CONFIG_SPL_RAM_DEVICE 2718c57b953dSPavel Machek Support for running image already present in ram, in SPL binary 2719c57b953dSPavel Machek 27206a11cf48SDaniel Schwierzeck CONFIG_SPL_LIBGENERIC_SUPPORT 27216a11cf48SDaniel Schwierzeck Support for lib/libgeneric.o in SPL binary 27221372cce2SMarian Balakowicz 2723c609719bSwdenkModem Support: 2724c609719bSwdenk-------------- 2725c609719bSwdenk 2726566e5cf4SWolfgang Denk[so far only for SMDK2400 boards] 2727c609719bSwdenk 272811ccc33fSMarcel Ziswiler- Modem support enable: 2729c609719bSwdenk CONFIG_MODEM_SUPPORT 2730c609719bSwdenk 2731c609719bSwdenk- RTS/CTS Flow control enable: 2732c609719bSwdenk CONFIG_HWFLOW 2733c609719bSwdenk 2734c609719bSwdenk- Modem debug support: 2735c609719bSwdenk CONFIG_MODEM_SUPPORT_DEBUG 2736c609719bSwdenk 2737c609719bSwdenk Enables debugging stuff (char screen[1024], dbg()) 2738c609719bSwdenk for modem support. Useful only with BDI2000. 2739c609719bSwdenk 2740a8c7c708Swdenk- Interrupt support (PPC): 2741a8c7c708Swdenk 2742a8c7c708Swdenk There are common interrupt_init() and timer_interrupt() 2743a8c7c708Swdenk for all PPC archs. interrupt_init() calls interrupt_init_cpu() 274411ccc33fSMarcel Ziswiler for CPU specific initialization. interrupt_init_cpu() 2745a8c7c708Swdenk should set decrementer_count to appropriate value. If 274611ccc33fSMarcel Ziswiler CPU resets decrementer automatically after interrupt 2747a8c7c708Swdenk (ppc4xx) it should set decrementer_count to zero. 274811ccc33fSMarcel Ziswiler timer_interrupt() calls timer_interrupt_cpu() for CPU 2749a8c7c708Swdenk specific handling. If board has watchdog / status_led 2750a8c7c708Swdenk / other_activity_monitor it works automatically from 2751a8c7c708Swdenk general timer_interrupt(). 2752a8c7c708Swdenk 2753c609719bSwdenk- General: 2754c609719bSwdenk 2755c609719bSwdenk In the target system modem support is enabled when a 2756c609719bSwdenk specific key (key combination) is pressed during 2757c609719bSwdenk power-on. Otherwise U-Boot will boot normally 275811ccc33fSMarcel Ziswiler (autoboot). The key_pressed() function is called from 2759c609719bSwdenk board_init(). Currently key_pressed() is a dummy 2760c609719bSwdenk function, returning 1 and thus enabling modem 2761c609719bSwdenk initialization. 2762c609719bSwdenk 2763c609719bSwdenk If there are no modem init strings in the 2764c609719bSwdenk environment, U-Boot proceed to autoboot; the 2765c609719bSwdenk previous output (banner, info printfs) will be 276611ccc33fSMarcel Ziswiler suppressed, though. 2767c609719bSwdenk 2768c609719bSwdenk See also: doc/README.Modem 2769c609719bSwdenk 27709660e442SHelmut RaigerBoard initialization settings: 27719660e442SHelmut Raiger------------------------------ 27729660e442SHelmut Raiger 27739660e442SHelmut RaigerDuring Initialization u-boot calls a number of board specific functions 27749660e442SHelmut Raigerto allow the preparation of board specific prerequisites, e.g. pin setup 27759660e442SHelmut Raigerbefore drivers are initialized. To enable these callbacks the 27769660e442SHelmut Raigerfollowing configuration macros have to be defined. Currently this is 27779660e442SHelmut Raigerarchitecture specific, so please check arch/your_architecture/lib/board.c 27789660e442SHelmut Raigertypically in board_init_f() and board_init_r(). 27799660e442SHelmut Raiger 27809660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f() 27819660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r() 27829660e442SHelmut Raiger- CONFIG_BOARD_LATE_INIT: Call board_late_init() 27839660e442SHelmut Raiger- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init() 2784c609719bSwdenk 2785c609719bSwdenkConfiguration Settings: 2786c609719bSwdenk----------------------- 2787c609719bSwdenk 27886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included; 2789c609719bSwdenk undefine this when you're short of memory. 2790c609719bSwdenk 27912fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default 27922fb2604dSPeter Tyser width of the commands listed in the 'help' command output. 27932fb2604dSPeter Tyser 27946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to 2795c609719bSwdenk prompt for user input. 2796c609719bSwdenk 27976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE: Buffer size for input from the Console 2798c609719bSwdenk 27996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE: Buffer size for Console output 2800c609719bSwdenk 28016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands 2802c609719bSwdenk 28036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to 2804c609719bSwdenk the application (usually a Linux kernel) when it is 2805c609719bSwdenk booted 2806c609719bSwdenk 28076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE: 2808c609719bSwdenk List of legal baudrate settings for this board. 2809c609719bSwdenk 28106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET 2811c609719bSwdenk Suppress display of console information at boot. 2812c609719bSwdenk 28136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV 2814c609719bSwdenk If the board specific function 2815c609719bSwdenk extern int overwrite_console (void); 2816c609719bSwdenk returns 1, the stdin, stderr and stdout are switched to the 2817c609719bSwdenk serial port, else the settings in the environment are used. 2818c609719bSwdenk 28196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE 2820c609719bSwdenk Enable the call to overwrite_console(). 2821c609719bSwdenk 28226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE 2823c609719bSwdenk Enable overwrite of previous console environment settings. 2824c609719bSwdenk 28256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END: 2826c609719bSwdenk Begin and End addresses of the area used by the 2827c609719bSwdenk simple memory test. 2828c609719bSwdenk 28296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST: 2830c609719bSwdenk Enable an alternate, more extensive memory test. 2831c609719bSwdenk 28326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH: 28335f535fe1Swdenk Scratch address used by the alternate memory test 28345f535fe1Swdenk You only need to set this if address zero isn't writeable 28355f535fe1Swdenk 28366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only): 28376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header, 283814f73ca6SStefan Roese this specified memory area will get subtracted from the top 283911ccc33fSMarcel Ziswiler (end) of RAM and won't get "touched" at all by U-Boot. By 284014f73ca6SStefan Roese fixing up gd->ram_size the Linux kernel should gets passed 284114f73ca6SStefan Roese the now "corrected" memory size and won't touch it either. 284214f73ca6SStefan Roese This should work for arch/ppc and arch/powerpc. Only Linux 28435e12e75dSStefan Roese board ports in arch/powerpc with bootwrapper support that 284414f73ca6SStefan Roese recalculate the memory size from the SDRAM controller setup 28455e12e75dSStefan Roese will have to get fixed in Linux additionally. 284614f73ca6SStefan Roese 284714f73ca6SStefan Roese This option can be used as a workaround for the 440EPx/GRx 284814f73ca6SStefan Roese CHIP 11 errata where the last 256 bytes in SDRAM shouldn't 284914f73ca6SStefan Roese be touched. 285014f73ca6SStefan Roese 285114f73ca6SStefan Roese WARNING: Please make sure that this value is a multiple of 285214f73ca6SStefan Roese the Linux page size (normally 4k). If this is not the case, 285314f73ca6SStefan Roese then the end address of the Linux memory will be located at a 285414f73ca6SStefan Roese non page size aligned address and this could cause major 285514f73ca6SStefan Roese problems. 285614f73ca6SStefan Roese 28576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TFTP_LOADADDR: 2858c609719bSwdenk Default load address for network file downloads 2859c609719bSwdenk 28606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE: 2861c609719bSwdenk Enable temporary baudrate change while serial download 2862c609719bSwdenk 28636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE: 2864c609719bSwdenk Physical start address of SDRAM. _Must_ be 0 here. 2865c609719bSwdenk 28666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE: 2867c609719bSwdenk Physical start address of Motherboard I/O (if using a 2868c609719bSwdenk Cogent motherboard) 2869c609719bSwdenk 28706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE: 2871c609719bSwdenk Physical start address of Flash memory. 2872c609719bSwdenk 28736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE: 2874c609719bSwdenk Physical start address of boot monitor code (set by 2875c609719bSwdenk make config files to be same as the text base address 287614d0a02aSWolfgang Denk (CONFIG_SYS_TEXT_BASE) used when linking) - same as 28776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FLASH_BASE when booting from flash. 2878c609719bSwdenk 28796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN: 28803b57fe0aSwdenk Size of memory reserved for monitor code, used to 28813b57fe0aSwdenk determine _at_compile_time_ (!) if the environment is 28823b57fe0aSwdenk embedded within the U-Boot image, or in a separate 28833b57fe0aSwdenk flash sector. 2884c609719bSwdenk 28856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN: 2886c609719bSwdenk Size of DRAM reserved for malloc() use. 2887c609719bSwdenk 28886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN: 288915940c9aSStefan Roese Normally compressed uImages are limited to an 289015940c9aSStefan Roese uncompressed size of 8 MBytes. If this is not enough, 28916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD you can define CONFIG_SYS_BOOTM_LEN in your board config file 289215940c9aSStefan Roese to adjust this setting to your needs. 2893c609719bSwdenk 28946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ: 2895c609719bSwdenk Maximum size of memory mapped by the startup code of 2896c609719bSwdenk the Linux kernel; all data that must be processed by 28977d721e34SBartlomiej Sieka the Linux kernel (bd_info, boot arguments, FDT blob if 28987d721e34SBartlomiej Sieka used) must be put below this limit, unless "bootm_low" 28997d721e34SBartlomiej Sieka enviroment variable is defined and non-zero. In such case 29007d721e34SBartlomiej Sieka all data for the Linux kernel must be between "bootm_low" 2901c3624e6eSGrant Likely and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment 2902c3624e6eSGrant Likely variable "bootm_mapsize" will override the value of 2903c3624e6eSGrant Likely CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined, 2904c3624e6eSGrant Likely then the value in "bootm_size" will be used instead. 2905c609719bSwdenk 2906fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH: 2907fca43cc8SJohn Rigby Enable initrd_high functionality. If defined then the 2908fca43cc8SJohn Rigby initrd_high feature is enabled and the bootm ramdisk subcommand 2909fca43cc8SJohn Rigby is enabled. 2910fca43cc8SJohn Rigby 2911fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE: 2912fca43cc8SJohn Rigby Enables allocating and saving kernel cmdline in space between 2913fca43cc8SJohn Rigby "bootm_low" and "bootm_low" + BOOTMAPSZ. 2914fca43cc8SJohn Rigby 2915fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD: 2916fca43cc8SJohn Rigby Enables allocating and saving a kernel copy of the bd_info in 2917fca43cc8SJohn Rigby space between "bootm_low" and "bootm_low" + BOOTMAPSZ. 2918fca43cc8SJohn Rigby 29196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS: 2920c609719bSwdenk Max number of Flash memory banks 2921c609719bSwdenk 29226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT: 2923c609719bSwdenk Max number of sectors on a Flash chip 2924c609719bSwdenk 29256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT: 2926c609719bSwdenk Timeout for Flash erase operations (in ms) 2927c609719bSwdenk 29286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT: 2929c609719bSwdenk Timeout for Flash write operations (in ms) 2930c609719bSwdenk 29316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT 29328564acf9Swdenk Timeout for Flash set sector lock bit operation (in ms) 29338564acf9Swdenk 29346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT 29358564acf9Swdenk Timeout for Flash clear lock bits operation (in ms) 29368564acf9Swdenk 29376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION 29388564acf9Swdenk If defined, hardware flash sectors protection is used 29398564acf9Swdenk instead of U-Boot software protection. 29408564acf9Swdenk 29416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP: 2942c609719bSwdenk 2943c609719bSwdenk Enable TFTP transfers directly to flash memory; 2944c609719bSwdenk without this option such a download has to be 2945c609719bSwdenk performed in two steps: (1) download to RAM, and (2) 2946c609719bSwdenk copy from RAM to flash. 2947c609719bSwdenk 2948c609719bSwdenk The two-step approach is usually more reliable, since 2949c609719bSwdenk you can check if the download worked before you erase 295011ccc33fSMarcel Ziswiler the flash, but in some situations (when system RAM is 295111ccc33fSMarcel Ziswiler too limited to allow for a temporary copy of the 2952c609719bSwdenk downloaded image) this option may be very useful. 2953c609719bSwdenk 29546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI: 2955c609719bSwdenk Define if the flash driver uses extra elements in the 29565653fc33Swdenk common flash structure for storing flash geometry. 29575653fc33Swdenk 295800b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER 29595653fc33Swdenk This option also enables the building of the cfi_flash driver 29605653fc33Swdenk in the drivers directory 296153cf9435Sstroese 296291809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD 296391809ed5SPiotr Ziecik This option enables the building of the cfi_mtd driver 296491809ed5SPiotr Ziecik in the drivers directory. The driver exports CFI flash 296591809ed5SPiotr Ziecik to the MTD layer. 296691809ed5SPiotr Ziecik 29676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE 296896ef831fSGuennadi Liakhovetski Use buffered writes to flash. 296996ef831fSGuennadi Liakhovetski 297096ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N 297196ef831fSGuennadi Liakhovetski s29ws-n MirrorBit flash has non-standard addresses for buffered 297296ef831fSGuennadi Liakhovetski write commands. 297396ef831fSGuennadi Liakhovetski 29746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST 29755568e613SStefan Roese If this option is defined, the common CFI flash doesn't 29765568e613SStefan Roese print it's warning upon not recognized FLASH banks. This 29775568e613SStefan Roese is useful, if some of the configured banks are only 29785568e613SStefan Roese optionally available. 29795568e613SStefan Roese 29809a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS 29819a042e9cSJerry Van Baren If defined (must be an integer), print out countdown 29829a042e9cSJerry Van Baren digits and dots. Recommended value: 45 (9..1) for 80 29839a042e9cSJerry Van Baren column displays, 15 (3..1) for 40 column displays. 29849a042e9cSJerry Van Baren 29856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER: 298611ccc33fSMarcel Ziswiler Defines the number of Ethernet receive buffers. On some 298711ccc33fSMarcel Ziswiler Ethernet controllers it is recommended to set this value 298853cf9435Sstroese to 8 or even higher (EEPRO100 or 405 EMAC), since all 298953cf9435Sstroese buffers can be full shortly after enabling the interface 299011ccc33fSMarcel Ziswiler on high Ethernet traffic. 299153cf9435Sstroese Defaults to 4 if not defined. 2992c609719bSwdenk 2993ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES 2994ea882bafSWolfgang Denk 2995ea882bafSWolfgang Denk Maximum number of entries in the hash table that is used 2996ea882bafSWolfgang Denk internally to store the environment settings. The default 2997ea882bafSWolfgang Denk setting is supposed to be generous and should work in most 2998ea882bafSWolfgang Denk cases. This setting can be used to tune behaviour; see 2999ea882bafSWolfgang Denk lib/hashtable.c for details. 3000ea882bafSWolfgang Denk 3001c609719bSwdenkThe following definitions that deal with the placement and management 3002c609719bSwdenkof environment data (variable area); in general, we support the 3003c609719bSwdenkfollowing configurations: 3004c609719bSwdenk 3005c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC: 3006c3eb3fe4SMike Frysinger 3007c3eb3fe4SMike Frysinger Builds up envcrc with the target environment so that external utils 3008c3eb3fe4SMike Frysinger may easily extract it and embed it in final U-Boot images. 3009c3eb3fe4SMike Frysinger 30105a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH: 3011c609719bSwdenk 3012c609719bSwdenk Define this if the environment is in flash memory. 3013c609719bSwdenk 3014c609719bSwdenk a) The environment occupies one whole flash sector, which is 3015c609719bSwdenk "embedded" in the text segment with the U-Boot code. This 3016c609719bSwdenk happens usually with "bottom boot sector" or "top boot 3017c609719bSwdenk sector" type flash chips, which have several smaller 3018c609719bSwdenk sectors at the start or the end. For instance, such a 3019c609719bSwdenk layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In 3020c609719bSwdenk such a case you would place the environment in one of the 3021c609719bSwdenk 4 kB sectors - with U-Boot code before and after it. With 3022c609719bSwdenk "top boot sector" type flash chips, you would put the 3023c609719bSwdenk environment in one of the last sectors, leaving a gap 3024c609719bSwdenk between U-Boot and the environment. 3025c609719bSwdenk 30260e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 3027c609719bSwdenk 3028c609719bSwdenk Offset of environment data (variable area) to the 3029c609719bSwdenk beginning of flash memory; for instance, with bottom boot 3030c609719bSwdenk type flash chips the second sector can be used: the offset 3031c609719bSwdenk for this sector is given here. 3032c609719bSwdenk 30336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE. 3034c609719bSwdenk 30350e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 3036c609719bSwdenk 3037c609719bSwdenk This is just another way to specify the start address of 3038c609719bSwdenk the flash sector containing the environment (instead of 30390e8d1586SJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_OFFSET). 3040c609719bSwdenk 30410e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SECT_SIZE: 3042c609719bSwdenk 3043c609719bSwdenk Size of the sector containing the environment. 3044c609719bSwdenk 3045c609719bSwdenk 3046c609719bSwdenk b) Sometimes flash chips have few, equal sized, BIG sectors. 3047c609719bSwdenk In such a case you don't want to spend a whole sector for 3048c609719bSwdenk the environment. 3049c609719bSwdenk 30500e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 3051c609719bSwdenk 30525a1aceb0SJean-Christophe PLAGNIOL-VILLARD If you use this in combination with CONFIG_ENV_IS_IN_FLASH 30530e8d1586SJean-Christophe PLAGNIOL-VILLARD and CONFIG_ENV_SECT_SIZE, you can specify to use only a part 3054c609719bSwdenk of this flash sector for the environment. This saves 3055c609719bSwdenk memory for the RAM copy of the environment. 3056c609719bSwdenk 3057c609719bSwdenk It may also save flash memory if you decide to use this 3058c609719bSwdenk when your environment is "embedded" within U-Boot code, 3059c609719bSwdenk since then the remainder of the flash sector could be used 3060c609719bSwdenk for U-Boot code. It should be pointed out that this is 3061c609719bSwdenk STRONGLY DISCOURAGED from a robustness point of view: 3062c609719bSwdenk updating the environment in flash makes it always 3063c609719bSwdenk necessary to erase the WHOLE sector. If something goes 3064c609719bSwdenk wrong before the contents has been restored from a copy in 3065c609719bSwdenk RAM, your target system will be dead. 3066c609719bSwdenk 30670e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR_REDUND 30680e8d1586SJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_SIZE_REDUND 3069c609719bSwdenk 3070c609719bSwdenk These settings describe a second storage area used to hold 307111ccc33fSMarcel Ziswiler a redundant copy of the environment data, so that there is 30723e38691eSwdenk a valid backup copy in case there is a power failure during 3073c609719bSwdenk a "saveenv" operation. 3074c609719bSwdenk 3075c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the 3076c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds* 3077c609719bSwdenkaccordingly! 3078c609719bSwdenk 3079c609719bSwdenk 30809314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM: 3081c609719bSwdenk 3082c609719bSwdenk Define this if you have some non-volatile memory device 3083c609719bSwdenk (NVRAM, battery buffered SRAM) which you want to use for the 3084c609719bSwdenk environment. 3085c609719bSwdenk 30860e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 30870e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 3088c609719bSwdenk 308911ccc33fSMarcel Ziswiler These two #defines are used to determine the memory area you 3090c609719bSwdenk want to use for environment. It is assumed that this memory 3091c609719bSwdenk can just be read and written to, without any special 3092c609719bSwdenk provision. 3093c609719bSwdenk 3094c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early 3095c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the 309611ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or 3097c609719bSwdenkU-Boot will hang. 3098c609719bSwdenk 3099c609719bSwdenkPlease note that even with NVRAM we still use a copy of the 3100c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to 3101c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv" 3102c609719bSwdenkto save the current settings. 3103c609719bSwdenk 3104c609719bSwdenk 3105bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM: 3106c609719bSwdenk 3107c609719bSwdenk Use this if you have an EEPROM or similar serial access 3108c609719bSwdenk device and a driver for it. 3109c609719bSwdenk 31100e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 31110e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 3112c609719bSwdenk 3113c609719bSwdenk These two #defines specify the offset and size of the 3114c609719bSwdenk environment area within the total memory of your EEPROM. 3115c609719bSwdenk 31166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR: 3117c609719bSwdenk If defined, specified the chip address of the EEPROM device. 3118c609719bSwdenk The default address is zero. 3119c609719bSwdenk 31206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS: 3121c609719bSwdenk If defined, the number of bits used to address bytes in a 3122c609719bSwdenk single page in the EEPROM device. A 64 byte page, for example 3123c609719bSwdenk would require six bits. 3124c609719bSwdenk 31256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS: 3126c609719bSwdenk If defined, the number of milliseconds to delay between 3127c609719bSwdenk page writes. The default is zero milliseconds. 3128c609719bSwdenk 31296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR_LEN: 3130c609719bSwdenk The length in bytes of the EEPROM memory array address. Note 3131c609719bSwdenk that this is NOT the chip address length! 3132c609719bSwdenk 31336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW: 31345cf91d6bSwdenk EEPROM chips that implement "address overflow" are ones 31355cf91d6bSwdenk like Catalyst 24WC04/08/16 which has 9/10/11 bits of 31365cf91d6bSwdenk address and the extra bits end up in the "chip address" bit 31375cf91d6bSwdenk slots. This makes a 24WC08 (1Kbyte) chip look like four 256 31385cf91d6bSwdenk byte chips. 31395cf91d6bSwdenk 31405cf91d6bSwdenk Note that we consider the length of the address field to 31415cf91d6bSwdenk still be one byte because the extra address bits are hidden 31425cf91d6bSwdenk in the chip address. 31435cf91d6bSwdenk 31446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_SIZE: 3145c609719bSwdenk The size in bytes of the EEPROM device. 3146c609719bSwdenk 3147548738b4SHeiko Schocher - CONFIG_ENV_EEPROM_IS_ON_I2C 3148548738b4SHeiko Schocher define this, if you have I2C and SPI activated, and your 3149548738b4SHeiko Schocher EEPROM, which holds the environment, is on the I2C bus. 3150548738b4SHeiko Schocher 3151548738b4SHeiko Schocher - CONFIG_I2C_ENV_EEPROM_BUS 3152548738b4SHeiko Schocher if you have an Environment on an EEPROM reached over 3153548738b4SHeiko Schocher I2C muxes, you can define here, how to reach this 3154548738b4SHeiko Schocher EEPROM. For example: 3155548738b4SHeiko Schocher 3156548738b4SHeiko Schocher #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0" 3157548738b4SHeiko Schocher 3158548738b4SHeiko Schocher EEPROM which holds the environment, is reached over 3159548738b4SHeiko Schocher a pca9547 i2c mux with address 0x70, channel 3. 3160c609719bSwdenk 3161057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH: 31625779d8d9Swdenk 31635779d8d9Swdenk Define this if you have a DataFlash memory device which you 31645779d8d9Swdenk want to use for the environment. 31655779d8d9Swdenk 31660e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 31670e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 31680e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 31695779d8d9Swdenk 31705779d8d9Swdenk These three #defines specify the offset and size of the 31715779d8d9Swdenk environment area within the total memory of your DataFlash placed 31725779d8d9Swdenk at the specified address. 31735779d8d9Swdenk 31740a85a9e7SLiu Gang- CONFIG_ENV_IS_IN_REMOTE: 31750a85a9e7SLiu Gang 31760a85a9e7SLiu Gang Define this if you have a remote memory space which you 31770a85a9e7SLiu Gang want to use for the local device's environment. 31780a85a9e7SLiu Gang 31790a85a9e7SLiu Gang - CONFIG_ENV_ADDR: 31800a85a9e7SLiu Gang - CONFIG_ENV_SIZE: 31810a85a9e7SLiu Gang 31820a85a9e7SLiu Gang These two #defines specify the address and size of the 31830a85a9e7SLiu Gang environment area within the remote memory space. The 31840a85a9e7SLiu Gang local device can get the environment from remote memory 3185fc54c7faSLiu Gang space by SRIO or PCIE links. 31860a85a9e7SLiu Gang 31870a85a9e7SLiu GangBE CAREFUL! For some special cases, the local device can not use 31880a85a9e7SLiu Gang"saveenv" command. For example, the local device will get the 3189fc54c7faSLiu Gangenvironment stored in a remote NOR flash by SRIO or PCIE link, 3190fc54c7faSLiu Gangbut it can not erase, write this NOR flash by SRIO or PCIE interface. 31910a85a9e7SLiu Gang 319251bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND: 319313a5695bSwdenk 319413a5695bSwdenk Define this if you have a NAND device which you want to use 319513a5695bSwdenk for the environment. 319613a5695bSwdenk 31970e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 31980e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 319913a5695bSwdenk 320013a5695bSwdenk These two #defines specify the offset and size of the environment 3201fdd813deSScott Wood area within the first NAND device. CONFIG_ENV_OFFSET must be 3202fdd813deSScott Wood aligned to an erase block boundary. 32035779d8d9Swdenk 3204fdd813deSScott Wood - CONFIG_ENV_OFFSET_REDUND (optional): 3205e443c944SMarkus Klotzbuecher 32060e8d1586SJean-Christophe PLAGNIOL-VILLARD This setting describes a second storage area of CONFIG_ENV_SIZE 3207fdd813deSScott Wood size used to hold a redundant copy of the environment data, so 3208fdd813deSScott Wood that there is a valid backup copy in case there is a power failure 3209fdd813deSScott Wood during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be 3210fdd813deSScott Wood aligned to an erase block boundary. 3211e443c944SMarkus Klotzbuecher 3212fdd813deSScott Wood - CONFIG_ENV_RANGE (optional): 3213fdd813deSScott Wood 3214fdd813deSScott Wood Specifies the length of the region in which the environment 3215fdd813deSScott Wood can be written. This should be a multiple of the NAND device's 3216fdd813deSScott Wood block size. Specifying a range with more erase blocks than 3217fdd813deSScott Wood are needed to hold CONFIG_ENV_SIZE allows bad blocks within 3218fdd813deSScott Wood the range to be avoided. 3219fdd813deSScott Wood 3220fdd813deSScott Wood - CONFIG_ENV_OFFSET_OOB (optional): 3221fdd813deSScott Wood 3222fdd813deSScott Wood Enables support for dynamically retrieving the offset of the 3223fdd813deSScott Wood environment from block zero's out-of-band data. The 3224fdd813deSScott Wood "nand env.oob" command can be used to record this offset. 3225fdd813deSScott Wood Currently, CONFIG_ENV_OFFSET_REDUND is not supported when 3226fdd813deSScott Wood using CONFIG_ENV_OFFSET_OOB. 3227e443c944SMarkus Klotzbuecher 3228b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST 3229b74ab737SGuennadi Liakhovetski 3230b74ab737SGuennadi Liakhovetski Defines address in RAM to which the nand_spl code should copy the 3231b74ab737SGuennadi Liakhovetski environment. If redundant environment is used, it will be copied to 3232b74ab737SGuennadi Liakhovetski CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE. 3233b74ab737SGuennadi Liakhovetski 32346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET 3235c609719bSwdenk 3236c609719bSwdenk Defines offset to the initial SPI buffer area in DPRAM. The 3237c609719bSwdenk area is used at an early stage (ROM part) if the environment 3238c609719bSwdenk is configured to reside in the SPI EEPROM: We need a 520 byte 3239c609719bSwdenk scratch DPRAM area. It is used between the two initialization 3240c609719bSwdenk calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems 3241c609719bSwdenk to be a good choice since it makes it far enough from the 3242c609719bSwdenk start of the data area as well as from the stack pointer. 3243c609719bSwdenk 3244e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor 3245c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been 3246cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f() 3247c609719bSwdenkuntil then to read environment variables. 3248c609719bSwdenk 324985ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor 325085ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working 325185ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is 325285ec0bccSwdenknecessary, because the first environment variable we need is the 325385ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't 325485ec0bccSwdenkhave any device yet where we could complain.] 3255c609719bSwdenk 3256c609719bSwdenkNote: once the monitor has been relocated, then it will complain if 3257c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you 325885ec0bccSwdenkuse the "saveenv" command to store a valid environment. 3259c609719bSwdenk 32606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN: 3261fc3e2165Swdenk Echo the inverted Ethernet link state to the fault LED. 3262fc3e2165Swdenk 32636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR 3264fc3e2165Swdenk also needs to be defined. 3265fc3e2165Swdenk 32666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR: 3267fc3e2165Swdenk MII address of the PHY to check for the Ethernet link state. 3268c609719bSwdenk 3269f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS: 3270f5675aa5SRon Madrid Define this if you desire to only have use of the NS16550_init 3271f5675aa5SRon Madrid and NS16550_putc functions for the serial driver located at 3272f5675aa5SRon Madrid drivers/serial/ns16550.c. This option is useful for saving 3273f5675aa5SRon Madrid space for already greatly restricted images, including but not 3274f5675aa5SRon Madrid limited to NAND_SPL configurations. 3275f5675aa5SRon Madrid 3276c609719bSwdenkLow Level (hardware related) configuration options: 3277dc7c9a1aSwdenk--------------------------------------------------- 3278c609719bSwdenk 32796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE: 3280c609719bSwdenk Cache Line Size of the CPU. 3281c609719bSwdenk 32826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR: 3283c609719bSwdenk Default address of the IMMR after system reset. 32842535d602Swdenk 32852535d602Swdenk Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU, 32862535d602Swdenk and RPXsuper) to be able to adjust the position of 32872535d602Swdenk the IMMR register after a reset. 3288c609719bSwdenk 3289e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT: 3290e46fedfeSTimur Tabi Default (power-on reset) physical address of CCSR on Freescale 3291e46fedfeSTimur Tabi PowerPC SOCs. 3292e46fedfeSTimur Tabi 3293e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR: 3294e46fedfeSTimur Tabi Virtual address of CCSR. On a 32-bit build, this is typically 3295e46fedfeSTimur Tabi the same value as CONFIG_SYS_CCSRBAR_DEFAULT. 3296e46fedfeSTimur Tabi 3297e46fedfeSTimur Tabi CONFIG_SYS_DEFAULT_IMMR must also be set to this value, 3298e46fedfeSTimur Tabi for cross-platform code that uses that macro instead. 3299e46fedfeSTimur Tabi 3300e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS: 3301e46fedfeSTimur Tabi Physical address of CCSR. CCSR can be relocated to a new 3302e46fedfeSTimur Tabi physical address, if desired. In this case, this macro should 3303e46fedfeSTimur Tabi be set to that address. Otherwise, it should be set to the 3304e46fedfeSTimur Tabi same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR 3305e46fedfeSTimur Tabi is typically relocated on 36-bit builds. It is recommended 3306e46fedfeSTimur Tabi that this macro be defined via the _HIGH and _LOW macros: 3307e46fedfeSTimur Tabi 3308e46fedfeSTimur Tabi #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH 3309e46fedfeSTimur Tabi * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW) 3310e46fedfeSTimur Tabi 3311e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH: 3312e46fedfeSTimur Tabi Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically 3313e46fedfeSTimur Tabi either 0 (32-bit build) or 0xF (36-bit build). This macro is 3314e46fedfeSTimur Tabi used in assembly code, so it must not contain typecasts or 3315e46fedfeSTimur Tabi integer size suffixes (e.g. "ULL"). 3316e46fedfeSTimur Tabi 3317e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW: 3318e46fedfeSTimur Tabi Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is 3319e46fedfeSTimur Tabi used in assembly code, so it must not contain typecasts or 3320e46fedfeSTimur Tabi integer size suffixes (e.g. "ULL"). 3321e46fedfeSTimur Tabi 3322e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE: 3323e46fedfeSTimur Tabi If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be 3324e46fedfeSTimur Tabi forced to a value that ensures that CCSR is not relocated. 3325e46fedfeSTimur Tabi 33267f6c2cbcSwdenk- Floppy Disk Support: 33276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FDC_DRIVE_NUMBER 33287f6c2cbcSwdenk 33297f6c2cbcSwdenk the default drive number (default value 0) 33307f6c2cbcSwdenk 33316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_ISA_IO_STRIDE 33327f6c2cbcSwdenk 333311ccc33fSMarcel Ziswiler defines the spacing between FDC chipset registers 33347f6c2cbcSwdenk (default value 1) 33357f6c2cbcSwdenk 33366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_ISA_IO_OFFSET 33377f6c2cbcSwdenk 33387f6c2cbcSwdenk defines the offset of register from address. It 33397f6c2cbcSwdenk depends on which part of the data bus is connected to 334011ccc33fSMarcel Ziswiler the FDC chipset. (default value 0) 33417f6c2cbcSwdenk 33426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and 33436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their 33447f6c2cbcSwdenk default value. 33457f6c2cbcSwdenk 33466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD if CONFIG_SYS_FDC_HW_INIT is defined, then the function 33477f6c2cbcSwdenk fdc_hw_init() is called at the beginning of the FDC 33487f6c2cbcSwdenk setup. fdc_hw_init() must be provided by the board 33497f6c2cbcSwdenk source code. It is used to make hardware dependant 33507f6c2cbcSwdenk initializations. 33517f6c2cbcSwdenk 33520abddf82SMacpaul Lin- CONFIG_IDE_AHB: 33530abddf82SMacpaul Lin Most IDE controllers were designed to be connected with PCI 33540abddf82SMacpaul Lin interface. Only few of them were designed for AHB interface. 33550abddf82SMacpaul Lin When software is doing ATA command and data transfer to 33560abddf82SMacpaul Lin IDE devices through IDE-AHB controller, some additional 33570abddf82SMacpaul Lin registers accessing to these kind of IDE-AHB controller 33580abddf82SMacpaul Lin is requierd. 33590abddf82SMacpaul Lin 33606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR: Physical address of the Internal Memory. 336125d6712aSwdenk DO NOT CHANGE unless you know exactly what you're 336225d6712aSwdenk doing! (11-4) [MPC8xx/82xx systems only] 3363c609719bSwdenk 33646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR: 3365c609719bSwdenk 33667152b1d0Swdenk Start address of memory area that can be used for 3367c609719bSwdenk initial data and stack; please note that this must be 3368c609719bSwdenk writable memory that is working WITHOUT special 3369c609719bSwdenk initialization, i. e. you CANNOT use normal RAM which 3370c609719bSwdenk will become available only after programming the 3371c609719bSwdenk memory controller and running certain initialization 3372c609719bSwdenk sequences. 3373c609719bSwdenk 3374c609719bSwdenk U-Boot uses the following memory types: 3375c609719bSwdenk - MPC8xx and MPC8260: IMMR (internal memory of the CPU) 3376c609719bSwdenk - MPC824X: data cache 3377c609719bSwdenk - PPC4xx: data cache 3378c609719bSwdenk 33796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET: 3380c609719bSwdenk 3381c609719bSwdenk Offset of the initial data structure in the memory 33826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually 33836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial 3384c609719bSwdenk data is located at the end of the available space 3385553f0982SWolfgang Denk (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE - 33866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just 33876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR + 33886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_GBL_DATA_OFFSET) downward. 3389c609719bSwdenk 3390c609719bSwdenk Note: 3391c609719bSwdenk On the MPC824X (or other systems that use the data 3392c609719bSwdenk cache for initial memory) the address chosen for 33936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must 3394c609719bSwdenk point to an otherwise UNUSED address space between 3395c609719bSwdenk the top of RAM and the start of the PCI space. 3396c609719bSwdenk 33976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6) 3398c609719bSwdenk 33996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR: System Protection Control (11-9) 3400c609719bSwdenk 34016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26) 3402c609719bSwdenk 34036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31) 3404c609719bSwdenk 34056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30) 3406c609719bSwdenk 34076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27) 3408c609719bSwdenk 34096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM: 3410c609719bSwdenk SDRAM timing 3411c609719bSwdenk 34126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA: 3413c609719bSwdenk periodic timer for refresh 3414c609719bSwdenk 34156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER: Debug Event Register (37-47) 3416c609719bSwdenk 34176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM, 34186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP, 34196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM, 34206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BR1_PRELIM: 3421c609719bSwdenk Memory Controller Definitions: BR0/1 and OR0/1 (FLASH) 3422c609719bSwdenk 3423c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE, 34246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM, 34256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM: 3426c609719bSwdenk Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM) 3427c609719bSwdenk 34286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K, 34296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL: 3430c609719bSwdenk Machine Mode Register and Memory Periodic Timer 3431c609719bSwdenk Prescaler definitions (SDRAM timing) 3432c609719bSwdenk 34336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]: 3434c609719bSwdenk enable I2C microcode relocation patch (MPC8xx); 3435c609719bSwdenk define relocation offset in DPRAM [DSP2] 3436c609719bSwdenk 34376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]: 3438b423d055SHeiko Schocher enable SMC microcode relocation patch (MPC8xx); 3439b423d055SHeiko Schocher define relocation offset in DPRAM [SMC1] 3440b423d055SHeiko Schocher 34416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]: 3442c609719bSwdenk enable SPI microcode relocation patch (MPC8xx); 3443c609719bSwdenk define relocation offset in DPRAM [SCC4] 3444c609719bSwdenk 34456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK: 3446c609719bSwdenk Use OSCM clock mode on MBX8xx board. Be careful, 3447c609719bSwdenk wrong setting might damage your board. Read 3448c609719bSwdenk doc/README.MBX before setting this variable! 3449c609719bSwdenk 34506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only) 3451ea909b76Swdenk Offset of the bootmode word in DPRAM used by post 3452ea909b76Swdenk (Power On Self Tests). This definition overrides 3453ea909b76Swdenk #define'd default value in commproc.h resp. 3454ea909b76Swdenk cpm_8260.h. 3455ea909b76Swdenk 34566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB, 34576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL, 34586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS, 34596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB, 34606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START, 34616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL, 34626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE, 34636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only) 3464a47a12beSStefan Roese Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set. 34655d232d0eSwdenk 34669cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE: 34679cacf4fcSDirk Eibach Disable PCI-Express on systems where it is supported but not 34689cacf4fcSDirk Eibach required. 34699cacf4fcSDirk Eibach 347069fd2d3bSAndrew Sharp- CONFIG_PCI_ENUM_ONLY 347169fd2d3bSAndrew Sharp Only scan through and get the devices on the busses. 347269fd2d3bSAndrew Sharp Don't do any setup work, presumably because someone or 347369fd2d3bSAndrew Sharp something has already done it, and we don't need to do it 347469fd2d3bSAndrew Sharp a second time. Useful for platforms that are pre-booted 347569fd2d3bSAndrew Sharp by coreboot or similar. 347669fd2d3bSAndrew Sharp 3477a09b9b68SKumar Gala- CONFIG_SYS_SRIO: 3478a09b9b68SKumar Gala Chip has SRIO or not 3479a09b9b68SKumar Gala 3480a09b9b68SKumar Gala- CONFIG_SRIO1: 3481a09b9b68SKumar Gala Board has SRIO 1 port available 3482a09b9b68SKumar Gala 3483a09b9b68SKumar Gala- CONFIG_SRIO2: 3484a09b9b68SKumar Gala Board has SRIO 2 port available 3485a09b9b68SKumar Gala 3486a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT: 3487a09b9b68SKumar Gala Virtual Address of SRIO port 'n' memory region 3488a09b9b68SKumar Gala 3489a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS: 3490a09b9b68SKumar Gala Physical Address of SRIO port 'n' memory region 3491a09b9b68SKumar Gala 3492a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE: 3493a09b9b68SKumar Gala Size of SRIO port 'n' memory region 3494a09b9b68SKumar Gala 3495eced4626SAlex Waterman- CONFIG_SYS_NDFC_16 3496eced4626SAlex Waterman Defined to tell the NDFC that the NAND chip is using a 3497eced4626SAlex Waterman 16 bit bus. 3498eced4626SAlex Waterman 3499eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG 3500eced4626SAlex Waterman Sets the EBC0_CFG register for the NDFC. If not defined 3501eced4626SAlex Waterman a default value will be used. 3502eced4626SAlex Waterman 3503bb99ad6dSBen Warren- CONFIG_SPD_EEPROM 3504218ca724SWolfgang Denk Get DDR timing information from an I2C EEPROM. Common 3505218ca724SWolfgang Denk with pluggable memory modules such as SODIMMs 3506218ca724SWolfgang Denk 3507bb99ad6dSBen Warren SPD_EEPROM_ADDRESS 3508bb99ad6dSBen Warren I2C address of the SPD EEPROM 3509bb99ad6dSBen Warren 35106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM 3511218ca724SWolfgang Denk If SPD EEPROM is on an I2C bus other than the first 3512218ca724SWolfgang Denk one, specify here. Note that the value must resolve 3513218ca724SWolfgang Denk to something your driver can deal with. 3514bb99ad6dSBen Warren 35151b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING 35161b3e3c4fSYork Sun Get DDR timing information from other than SPD. Common with 35171b3e3c4fSYork Sun soldered DDR chips onboard without SPD. DDR raw timing 35181b3e3c4fSYork Sun parameters are extracted from datasheet and hard-coded into 35191b3e3c4fSYork Sun header files or board specific files. 35201b3e3c4fSYork Sun 35216f5e1dc5SYork Sun- CONFIG_FSL_DDR_INTERACTIVE 35226f5e1dc5SYork Sun Enable interactive DDR debugging. See doc/README.fsl-ddr. 35236f5e1dc5SYork Sun 35246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0 3525218ca724SWolfgang Denk Only for 83xx systems. If specified, then DDR should 3526218ca724SWolfgang Denk be configured using CS0 and CS1 instead of CS2 and CS3. 35272ad6b513STimur Tabi 3528c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12] 3529c26e454dSwdenk Define to enable FEC[12] on a 8xx series processor. 3530c26e454dSwdenk 3531c26e454dSwdenk- CONFIG_FEC[12]_PHY 3532c26e454dSwdenk Define to the hardcoded PHY address which corresponds 35336e592385Swdenk to the given FEC; i. e. 3534c26e454dSwdenk #define CONFIG_FEC1_PHY 4 3535c26e454dSwdenk means that the PHY with address 4 is connected to FEC1 3536c26e454dSwdenk 3537c26e454dSwdenk When set to -1, means to probe for first available. 3538c26e454dSwdenk 3539c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR 3540c26e454dSwdenk The PHY does not have a RXERR line (RMII only). 3541c26e454dSwdenk (so program the FEC to ignore it). 3542c26e454dSwdenk 3543c26e454dSwdenk- CONFIG_RMII 3544c26e454dSwdenk Enable RMII mode for all FECs. 3545c26e454dSwdenk Note that this is a global option, we can't 3546c26e454dSwdenk have one FEC in standard MII mode and another in RMII mode. 3547c26e454dSwdenk 35485cf91d6bSwdenk- CONFIG_CRC32_VERIFY 35495cf91d6bSwdenk Add a verify option to the crc32 command. 35505cf91d6bSwdenk The syntax is: 35515cf91d6bSwdenk 35525cf91d6bSwdenk => crc32 -v <address> <count> <crc32> 35535cf91d6bSwdenk 35545cf91d6bSwdenk Where address/count indicate a memory area 35555cf91d6bSwdenk and crc32 is the correct crc32 which the 35565cf91d6bSwdenk area should have. 35575cf91d6bSwdenk 355856523f12Swdenk- CONFIG_LOOPW 355956523f12Swdenk Add the "loopw" memory command. This only takes effect if 3560602ad3b3SJon Loeliger the memory commands are activated globally (CONFIG_CMD_MEM). 356156523f12Swdenk 35627b466641Sstroese- CONFIG_MX_CYCLIC 35637b466641Sstroese Add the "mdc" and "mwc" memory commands. These are cyclic 35647b466641Sstroese "md/mw" commands. 35657b466641Sstroese Examples: 35667b466641Sstroese 35677b466641Sstroese => mdc.b 10 4 500 35687b466641Sstroese This command will print 4 bytes (10,11,12,13) each 500 ms. 35697b466641Sstroese 35707b466641Sstroese => mwc.l 100 12345678 10 35717b466641Sstroese This command will write 12345678 to address 100 all 10 ms. 35727b466641Sstroese 35737b466641Sstroese This only takes effect if the memory commands are activated 3574602ad3b3SJon Loeliger globally (CONFIG_CMD_MEM). 35757b466641Sstroese 35768aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT 3577afc1ce82SMacpaul Lin [ARM, NDS32, MIPS only] If this variable is defined, then certain 3578e03f3169SWolfgang Denk low level initializations (like setting up the memory 3579e03f3169SWolfgang Denk controller) are omitted and/or U-Boot does not 3580e03f3169SWolfgang Denk relocate itself into RAM. 35818aa1a2d1Swdenk 3582e03f3169SWolfgang Denk Normally this variable MUST NOT be defined. The only 3583e03f3169SWolfgang Denk exception is when U-Boot is loaded (to RAM) by some 3584e03f3169SWolfgang Denk other boot loader or by a debugger which performs 3585e03f3169SWolfgang Denk these initializations itself. 35868aa1a2d1Swdenk 3587401bb30bSAneesh V- CONFIG_SPL_BUILD 3588df81238bSMagnus Lilja Modifies the behaviour of start.S when compiling a loader 3589df81238bSMagnus Lilja that is executed before the actual U-Boot. E.g. when 3590df81238bSMagnus Lilja compiling a NAND SPL. 3591400558b5Swdenk 3592d8834a13SMatthias Weisser- CONFIG_USE_ARCH_MEMCPY 3593d8834a13SMatthias Weisser CONFIG_USE_ARCH_MEMSET 3594d8834a13SMatthias Weisser If these options are used a optimized version of memcpy/memset will 3595d8834a13SMatthias Weisser be used if available. These functions may be faster under some 3596d8834a13SMatthias Weisser conditions but may increase the binary size. 3597d8834a13SMatthias Weisser 3598f2717b47STimur TabiFreescale QE/FMAN Firmware Support: 3599f2717b47STimur Tabi----------------------------------- 3600f2717b47STimur Tabi 3601f2717b47STimur TabiThe Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the 3602f2717b47STimur Tabiloading of "firmware", which is encoded in the QE firmware binary format. 3603f2717b47STimur TabiThis firmware often needs to be loaded during U-Boot booting, so macros 3604f2717b47STimur Tabiare used to identify the storage device (NOR flash, SPI, etc) and the address 3605f2717b47STimur Tabiwithin that device. 3606f2717b47STimur Tabi 3607f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_ADDR 3608f2717b47STimur Tabi The address in the storage device where the firmware is located. The 3609f2717b47STimur Tabi meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro 3610f2717b47STimur Tabi is also specified. 3611f2717b47STimur Tabi 3612f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_LENGTH 3613f2717b47STimur Tabi The maximum possible size of the firmware. The firmware binary format 3614f2717b47STimur Tabi has a field that specifies the actual size of the firmware, but it 3615f2717b47STimur Tabi might not be possible to read any part of the firmware unless some 3616f2717b47STimur Tabi local storage is allocated to hold the entire firmware first. 3617f2717b47STimur Tabi 3618f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NOR 3619f2717b47STimur Tabi Specifies that QE/FMAN firmware is located in NOR flash, mapped as 3620f2717b47STimur Tabi normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the 3621f2717b47STimur Tabi virtual address in NOR flash. 3622f2717b47STimur Tabi 3623f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NAND 3624f2717b47STimur Tabi Specifies that QE/FMAN firmware is located in NAND flash. 3625f2717b47STimur Tabi CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash. 3626f2717b47STimur Tabi 3627f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_MMC 3628f2717b47STimur Tabi Specifies that QE/FMAN firmware is located on the primary SD/MMC 3629f2717b47STimur Tabi device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device. 3630f2717b47STimur Tabi 3631f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH 3632f2717b47STimur Tabi Specifies that QE/FMAN firmware is located on the primary SPI 3633f2717b47STimur Tabi device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device. 3634f2717b47STimur Tabi 3635292dc6c5SLiu Gang- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE 3636292dc6c5SLiu Gang Specifies that QE/FMAN firmware is located in the remote (master) 3637292dc6c5SLiu Gang memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which 3638fc54c7faSLiu Gang can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound 3639fc54c7faSLiu Gang window->master inbound window->master LAW->the ucode address in 3640fc54c7faSLiu Gang master's memory space. 3641f2717b47STimur Tabi 3642c609719bSwdenkBuilding the Software: 3643c609719bSwdenk====================== 3644c609719bSwdenk 3645218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments 3646218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support 3647218ca724SWolfgang Denkall possibly existing versions of cross development tools in all 3648218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we 3649218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK) 3650218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot. 3651c609719bSwdenk 3652218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you 3653218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case, 3654218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell. 3655218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are 3656218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter: 3657c609719bSwdenk 3658218ca724SWolfgang Denk $ CROSS_COMPILE=ppc_4xx- 3659218ca724SWolfgang Denk $ export CROSS_COMPILE 3660c609719bSwdenk 36612f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in 36622f8d396bSPeter Tyser the tools directory you can use the MinGW toolchain 36632f8d396bSPeter Tyser (http://www.mingw.org). Set your HOST tools to the MinGW 36642f8d396bSPeter Tyser toolchain and execute 'make tools'. For example: 36652f8d396bSPeter Tyser 36662f8d396bSPeter Tyser $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools 36672f8d396bSPeter Tyser 36682f8d396bSPeter Tyser Binaries such as tools/mkimage.exe will be created which can 36692f8d396bSPeter Tyser be executed on computers running Windows. 36702f8d396bSPeter Tyser 3671c609719bSwdenkU-Boot is intended to be simple to build. After installing the 3672c609719bSwdenksources you must configure U-Boot for one specific board type. This 3673c609719bSwdenkis done by typing: 3674c609719bSwdenk 3675c609719bSwdenk make NAME_config 3676c609719bSwdenk 3677218ca724SWolfgang Denkwhere "NAME_config" is the name of one of the existing configu- 36784d675ae6SMichael Jonesrations; see boards.cfg for supported names. 367954387ac9Swdenk 3680c609719bSwdenkNote: for some board special configuration names may exist; check if 3681c609719bSwdenk additional information is available from the board vendor; for 36822729af9dSwdenk instance, the TQM823L systems are available without (standard) 36832729af9dSwdenk or with LCD support. You can select such additional "features" 368411ccc33fSMarcel Ziswiler when choosing the configuration, i. e. 3685c609719bSwdenk 36862729af9dSwdenk make TQM823L_config 36872729af9dSwdenk - will configure for a plain TQM823L, i. e. no LCD support 3688c609719bSwdenk 3689c609719bSwdenk make TQM823L_LCD_config 3690c609719bSwdenk - will configure for a TQM823L with U-Boot console on LCD 3691c609719bSwdenk 3692c609719bSwdenk etc. 3693c609719bSwdenk 3694c609719bSwdenk 3695c609719bSwdenkFinally, type "make all", and you should get some working U-Boot 36967152b1d0Swdenkimages ready for download to / installation on your system: 3697c609719bSwdenk 3698c609719bSwdenk- "u-boot.bin" is a raw binary image 3699c609719bSwdenk- "u-boot" is an image in ELF binary format 3700c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format 3701c609719bSwdenk 3702baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved 3703baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change 3704baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory: 3705baf31249SMarian Balakowicz 3706baf31249SMarian Balakowicz1. Add O= to the make command line invocations: 3707baf31249SMarian Balakowicz 3708baf31249SMarian Balakowicz make O=/tmp/build distclean 3709baf31249SMarian Balakowicz make O=/tmp/build NAME_config 3710baf31249SMarian Balakowicz make O=/tmp/build all 3711baf31249SMarian Balakowicz 3712baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location: 3713baf31249SMarian Balakowicz 3714baf31249SMarian Balakowicz export BUILD_DIR=/tmp/build 3715baf31249SMarian Balakowicz make distclean 3716baf31249SMarian Balakowicz make NAME_config 3717baf31249SMarian Balakowicz make all 3718baf31249SMarian Balakowicz 3719baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment 3720baf31249SMarian Balakowiczvariable. 3721baf31249SMarian Balakowicz 3722c609719bSwdenk 3723c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so 3724c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of 3725c609719bSwdenknative "make". 3726c609719bSwdenk 3727c609719bSwdenk 3728c609719bSwdenkIf the system board that you have is not listed, then you will need 3729c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these 3730c609719bSwdenksteps: 3731c609719bSwdenk 3732c609719bSwdenk1. Add a new configuration option for your board to the toplevel 37334d675ae6SMichael Jones "boards.cfg" file, using the existing entries as examples. 37344d675ae6SMichael Jones Follow the instructions there to keep the boards in order. 3735c609719bSwdenk2. Create a new directory to hold your board specific code. Add any 373685ec0bccSwdenk files you need. In your board directory, you will need at least 373785ec0bccSwdenk the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds". 373885ec0bccSwdenk3. Create a new configuration file "include/configs/<board>.h" for 373985ec0bccSwdenk your board 3740c609719bSwdenk3. If you're porting U-Boot to a new CPU, then also create a new 3741c609719bSwdenk directory to hold your CPU specific code. Add any files you need. 374285ec0bccSwdenk4. Run "make <board>_config" with your new name. 3743c609719bSwdenk5. Type "make", and you should get a working "u-boot.srec" file 3744c609719bSwdenk to be installed on your target system. 374585ec0bccSwdenk6. Debug and solve any problems that might arise. 3746c609719bSwdenk [Of course, this last step is much harder than it sounds.] 3747c609719bSwdenk 3748c609719bSwdenk 3749c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.: 3750c609719bSwdenk============================================================== 3751c609719bSwdenk 3752c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board 3753c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to 3754c609719bSwdenkprovide feedback to the other developers. The feedback normally takes 3755c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest 3756218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources. 3757c609719bSwdenk 3758c609719bSwdenkBut before you submit such a patch, please verify that your modifi- 3759c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of 3760c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so, 3761c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot 3762c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can 37637152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE' 3764218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools 3765218ca724SWolfgang Denkyou can type 3766c609719bSwdenk 3767c609719bSwdenk CROSS_COMPILE=ppc_8xx- MAKEALL 3768c609719bSwdenk 3769c609719bSwdenkor to build on a native PowerPC system you can type 3770c609719bSwdenk 3771c609719bSwdenk CROSS_COMPILE=' ' MAKEALL 3772c609719bSwdenk 3773218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build 3774218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by 3775218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target 3776218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and 3777218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default 3778218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment 3779218ca724SWolfgang Denkvariable. For example: 3780baf31249SMarian Balakowicz 3781baf31249SMarian Balakowicz export BUILD_DIR=/tmp/build 3782baf31249SMarian Balakowicz export MAKEALL_LOGDIR=/tmp/log 3783baf31249SMarian Balakowicz CROSS_COMPILE=ppc_8xx- MAKEALL 3784baf31249SMarian Balakowicz 3785218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build, 3786218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean 3787218ca724SWolfgang Denkduring the whole build process. 3788baf31249SMarian Balakowicz 3789baf31249SMarian Balakowicz 3790c609719bSwdenkSee also "U-Boot Porting Guide" below. 3791c609719bSwdenk 3792c609719bSwdenk 3793c609719bSwdenkMonitor Commands - Overview: 3794c609719bSwdenk============================ 3795c609719bSwdenk 3796c609719bSwdenkgo - start application at address 'addr' 3797c609719bSwdenkrun - run commands in an environment variable 3798c609719bSwdenkbootm - boot application image from memory 3799c609719bSwdenkbootp - boot image via network using BootP/TFTP protocol 380044f074c7SMarek Vasutbootz - boot zImage from memory 3801c609719bSwdenktftpboot- boot image via network using TFTP protocol 3802c609719bSwdenk and env variables "ipaddr" and "serverip" 3803c609719bSwdenk (and eventually "gatewayip") 38041fb7cd49SSimon Glasstftpput - upload a file via network using TFTP protocol 3805c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol 3806c609719bSwdenkdiskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd' 3807c609719bSwdenkloads - load S-Record file over serial line 3808c609719bSwdenkloadb - load binary file over serial line (kermit mode) 3809c609719bSwdenkmd - memory display 3810c609719bSwdenkmm - memory modify (auto-incrementing) 3811c609719bSwdenknm - memory modify (constant address) 3812c609719bSwdenkmw - memory write (fill) 3813c609719bSwdenkcp - memory copy 3814c609719bSwdenkcmp - memory compare 3815c609719bSwdenkcrc32 - checksum calculation 38160f89c54bSPeter Tyseri2c - I2C sub-system 3817c609719bSwdenksspi - SPI utility commands 3818c609719bSwdenkbase - print or set address offset 3819c609719bSwdenkprintenv- print environment variables 3820c609719bSwdenksetenv - set environment variables 3821c609719bSwdenksaveenv - save environment variables to persistent storage 3822c609719bSwdenkprotect - enable or disable FLASH write protection 3823c609719bSwdenkerase - erase FLASH memory 3824c609719bSwdenkflinfo - print FLASH memory information 3825c609719bSwdenkbdinfo - print Board Info structure 3826c609719bSwdenkiminfo - print header information for application image 3827c609719bSwdenkconinfo - print console devices and informations 3828c609719bSwdenkide - IDE sub-system 3829c609719bSwdenkloop - infinite loop on address range 383056523f12Swdenkloopw - infinite write loop on address range 3831c609719bSwdenkmtest - simple RAM test 3832c609719bSwdenkicache - enable or disable instruction cache 3833c609719bSwdenkdcache - enable or disable data cache 3834c609719bSwdenkreset - Perform RESET of the CPU 3835c609719bSwdenkecho - echo args to console 3836c609719bSwdenkversion - print monitor version 3837c609719bSwdenkhelp - print online help 3838c609719bSwdenk? - alias for 'help' 3839c609719bSwdenk 3840c609719bSwdenk 3841c609719bSwdenkMonitor Commands - Detailed Description: 3842c609719bSwdenk======================================== 3843c609719bSwdenk 3844c609719bSwdenkTODO. 3845c609719bSwdenk 3846c609719bSwdenkFor now: just type "help <command>". 3847c609719bSwdenk 3848c609719bSwdenk 3849c609719bSwdenkEnvironment Variables: 3850c609719bSwdenk====================== 3851c609719bSwdenk 3852c609719bSwdenkU-Boot supports user configuration using Environment Variables which 3853c609719bSwdenkcan be made persistent by saving to Flash memory. 3854c609719bSwdenk 3855c609719bSwdenkEnvironment Variables are set using "setenv", printed using 3856c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv" 3857c609719bSwdenkwithout a value can be used to delete a variable from the 3858c609719bSwdenkenvironment. As long as you don't save the environment you are 3859c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the 3860c609719bSwdenkenvironment is erased by accident, a default environment is provided. 3861c609719bSwdenk 3862c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables. 3863c96f86eeSWolfgang Denk 3864c96f86eeSWolfgang DenkList of environment variables (most likely not complete): 3865c609719bSwdenk 3866c609719bSwdenk baudrate - see CONFIG_BAUDRATE 3867c609719bSwdenk 3868c609719bSwdenk bootdelay - see CONFIG_BOOTDELAY 3869c609719bSwdenk 3870c609719bSwdenk bootcmd - see CONFIG_BOOTCOMMAND 3871c609719bSwdenk 3872c609719bSwdenk bootargs - Boot arguments when booting an RTOS image 3873c609719bSwdenk 3874c609719bSwdenk bootfile - Name of the image to load with TFTP 3875c609719bSwdenk 38767d721e34SBartlomiej Sieka bootm_low - Memory range available for image processing in the bootm 38777d721e34SBartlomiej Sieka command can be restricted. This variable is given as 38787d721e34SBartlomiej Sieka a hexadecimal number and defines lowest address allowed 38797d721e34SBartlomiej Sieka for use by the bootm command. See also "bootm_size" 38807d721e34SBartlomiej Sieka environment variable. Address defined by "bootm_low" is 38817d721e34SBartlomiej Sieka also the base of the initial memory mapping for the Linux 3882c3624e6eSGrant Likely kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and 3883c3624e6eSGrant Likely bootm_mapsize. 3884c3624e6eSGrant Likely 3885c3624e6eSGrant Likely bootm_mapsize - Size of the initial memory mapping for the Linux kernel. 3886c3624e6eSGrant Likely This variable is given as a hexadecimal number and it 3887c3624e6eSGrant Likely defines the size of the memory region starting at base 3888c3624e6eSGrant Likely address bootm_low that is accessible by the Linux kernel 3889c3624e6eSGrant Likely during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used 3890c3624e6eSGrant Likely as the default value if it is defined, and bootm_size is 3891c3624e6eSGrant Likely used otherwise. 38927d721e34SBartlomiej Sieka 38937d721e34SBartlomiej Sieka bootm_size - Memory range available for image processing in the bootm 38947d721e34SBartlomiej Sieka command can be restricted. This variable is given as 38957d721e34SBartlomiej Sieka a hexadecimal number and defines the size of the region 38967d721e34SBartlomiej Sieka allowed for use by the bootm command. See also "bootm_low" 38977d721e34SBartlomiej Sieka environment variable. 38987d721e34SBartlomiej Sieka 38994bae9090SBartlomiej Sieka updatefile - Location of the software update file on a TFTP server, used 39004bae9090SBartlomiej Sieka by the automatic software update feature. Please refer to 39014bae9090SBartlomiej Sieka documentation in doc/README.update for more details. 39024bae9090SBartlomiej Sieka 3903c609719bSwdenk autoload - if set to "no" (any string beginning with 'n'), 3904c609719bSwdenk "bootp" will just load perform a lookup of the 3905c609719bSwdenk configuration from the BOOTP server, but not try to 3906c609719bSwdenk load any image using TFTP 3907c609719bSwdenk 3908c609719bSwdenk autostart - if set to "yes", an image loaded using the "bootp", 3909c609719bSwdenk "rarpboot", "tftpboot" or "diskboot" commands will 3910c609719bSwdenk be automatically started (by internally calling 3911c609719bSwdenk "bootm") 3912c609719bSwdenk 39134a6fd34bSwdenk If set to "no", a standalone image passed to the 39144a6fd34bSwdenk "bootm" command will be copied to the load address 39154a6fd34bSwdenk (and eventually uncompressed), but NOT be started. 39164a6fd34bSwdenk This can be used to load and uncompress arbitrary 39174a6fd34bSwdenk data. 39184a6fd34bSwdenk 3919a28afca5SDavid A. Long fdt_high - if set this restricts the maximum address that the 3920a28afca5SDavid A. Long flattened device tree will be copied into upon boot. 3921fa34f6b2SShawn Guo For example, if you have a system with 1 GB memory 3922fa34f6b2SShawn Guo at physical address 0x10000000, while Linux kernel 3923fa34f6b2SShawn Guo only recognizes the first 704 MB as low memory, you 3924fa34f6b2SShawn Guo may need to set fdt_high as 0x3C000000 to have the 3925fa34f6b2SShawn Guo device tree blob be copied to the maximum address 3926fa34f6b2SShawn Guo of the 704 MB low memory, so that Linux kernel can 3927fa34f6b2SShawn Guo access it during the boot procedure. 3928fa34f6b2SShawn Guo 3929a28afca5SDavid A. Long If this is set to the special value 0xFFFFFFFF then 3930a28afca5SDavid A. Long the fdt will not be copied at all on boot. For this 3931a28afca5SDavid A. Long to work it must reside in writable memory, have 3932a28afca5SDavid A. Long sufficient padding on the end of it for u-boot to 3933a28afca5SDavid A. Long add the information it needs into it, and the memory 3934a28afca5SDavid A. Long must be accessible by the kernel. 3935a28afca5SDavid A. Long 3936eea63e05SSimon Glass fdtcontroladdr- if set this is the address of the control flattened 3937eea63e05SSimon Glass device tree used by U-Boot when CONFIG_OF_CONTROL is 3938eea63e05SSimon Glass defined. 3939eea63e05SSimon Glass 394017ea1177Swdenk i2cfast - (PPC405GP|PPC405EP only) 394117ea1177Swdenk if set to 'y' configures Linux I2C driver for fast 394217ea1177Swdenk mode (400kHZ). This environment variable is used in 394317ea1177Swdenk initialization code. So, for changes to be effective 394417ea1177Swdenk it must be saved and board must be reset. 394517ea1177Swdenk 3946c609719bSwdenk initrd_high - restrict positioning of initrd images: 3947c609719bSwdenk If this variable is not set, initrd images will be 3948c609719bSwdenk copied to the highest possible address in RAM; this 3949c609719bSwdenk is usually what you want since it allows for 3950c609719bSwdenk maximum initrd size. If for some reason you want to 3951c609719bSwdenk make sure that the initrd image is loaded below the 39526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BOOTMAPSZ limit, you can set this environment 3953c609719bSwdenk variable to a value of "no" or "off" or "0". 3954c609719bSwdenk Alternatively, you can set it to a maximum upper 3955c609719bSwdenk address to use (U-Boot will still check that it 3956c609719bSwdenk does not overwrite the U-Boot stack and data). 3957c609719bSwdenk 3958c609719bSwdenk For instance, when you have a system with 16 MB 39597152b1d0Swdenk RAM, and want to reserve 4 MB from use by Linux, 3960c609719bSwdenk you can do this by adding "mem=12M" to the value of 3961c609719bSwdenk the "bootargs" variable. However, now you must make 39627152b1d0Swdenk sure that the initrd image is placed in the first 3963c609719bSwdenk 12 MB as well - this can be done with 3964c609719bSwdenk 3965c609719bSwdenk setenv initrd_high 00c00000 3966c609719bSwdenk 396738b99261Swdenk If you set initrd_high to 0xFFFFFFFF, this is an 396838b99261Swdenk indication to U-Boot that all addresses are legal 396938b99261Swdenk for the Linux kernel, including addresses in flash 397038b99261Swdenk memory. In this case U-Boot will NOT COPY the 397138b99261Swdenk ramdisk at all. This may be useful to reduce the 397238b99261Swdenk boot time on your system, but requires that this 397338b99261Swdenk feature is supported by your Linux kernel. 397438b99261Swdenk 3975c609719bSwdenk ipaddr - IP address; needed for tftpboot command 3976c609719bSwdenk 3977c609719bSwdenk loadaddr - Default load address for commands like "bootp", 3978dc7c9a1aSwdenk "rarpboot", "tftpboot", "loadb" or "diskboot" 3979c609719bSwdenk 3980c609719bSwdenk loads_echo - see CONFIG_LOADS_ECHO 3981c609719bSwdenk 3982c609719bSwdenk serverip - TFTP server IP address; needed for tftpboot command 3983c609719bSwdenk 3984c609719bSwdenk bootretry - see CONFIG_BOOT_RETRY_TIME 3985c609719bSwdenk 3986c609719bSwdenk bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR 3987c609719bSwdenk 3988c609719bSwdenk bootstopkey - see CONFIG_AUTOBOOT_STOP_STR 3989c609719bSwdenk 3990e2a53458SMike Frysinger ethprime - controls which interface is used first. 3991a3d991bdSwdenk 3992e2a53458SMike Frysinger ethact - controls which interface is currently active. 3993e2a53458SMike Frysinger For example you can do the following 3994a3d991bdSwdenk 399548690d80SHeiko Schocher => setenv ethact FEC 399648690d80SHeiko Schocher => ping 192.168.0.1 # traffic sent on FEC 399748690d80SHeiko Schocher => setenv ethact SCC 399848690d80SHeiko Schocher => ping 10.0.0.1 # traffic sent on SCC 3999a3d991bdSwdenk 4000e1692577SMatthias Fuchs ethrotate - When set to "no" U-Boot does not go through all 4001e1692577SMatthias Fuchs available network interfaces. 4002e1692577SMatthias Fuchs It just stays at the currently selected interface. 4003e1692577SMatthias Fuchs 4004a3d991bdSwdenk netretry - When set to "no" each network operation will 4005a3d991bdSwdenk either succeed or fail without retrying. 40066e592385Swdenk When set to "once" the network operation will 40076e592385Swdenk fail when all the available network interfaces 40086e592385Swdenk are tried once without success. 4009a3d991bdSwdenk Useful on scripts which control the retry operation 4010a3d991bdSwdenk themselves. 4011a3d991bdSwdenk 4012b4e2f89dSJean-Christophe PLAGNIOL-VILLARD npe_ucode - set load address for the NPE microcode 4013a1cf027aSJean-Christophe PLAGNIOL-VILLARD 401428cb9375SWolfgang Denk tftpsrcport - If this is set, the value is used for TFTP's 4015ecb0ccd9SWolfgang Denk UDP source port. 4016ecb0ccd9SWolfgang Denk 401728cb9375SWolfgang Denk tftpdstport - If this is set, the value is used for TFTP's UDP 401828cb9375SWolfgang Denk destination port instead of the Well Know Port 69. 401928cb9375SWolfgang Denk 4020c96f86eeSWolfgang Denk tftpblocksize - Block size to use for TFTP transfers; if not set, 4021c96f86eeSWolfgang Denk we use the TFTP server's default block size 4022c96f86eeSWolfgang Denk 4023c96f86eeSWolfgang Denk tftptimeout - Retransmission timeout for TFTP packets (in milli- 4024c96f86eeSWolfgang Denk seconds, minimum value is 1000 = 1 second). Defines 4025c96f86eeSWolfgang Denk when a packet is considered to be lost so it has to 4026c96f86eeSWolfgang Denk be retransmitted. The default is 5000 = 5 seconds. 4027c96f86eeSWolfgang Denk Lowering this value may make downloads succeed 4028c96f86eeSWolfgang Denk faster in networks with high packet loss rates or 4029c96f86eeSWolfgang Denk with unreliable TFTP servers. 4030c96f86eeSWolfgang Denk 4031a3d991bdSwdenk vlan - When set to a value < 4095 the traffic over 403211ccc33fSMarcel Ziswiler Ethernet is encapsulated/received over 802.1q 4033a3d991bdSwdenk VLAN tagged frames. 4034c609719bSwdenk 4035dc0b7b0eSJason HobbsThe following image location variables contain the location of images 4036dc0b7b0eSJason Hobbsused in booting. The "Image" column gives the role of the image and is 4037dc0b7b0eSJason Hobbsnot an environment variable name. The other columns are environment 4038dc0b7b0eSJason Hobbsvariable names. "File Name" gives the name of the file on a TFTP 4039dc0b7b0eSJason Hobbsserver, "RAM Address" gives the location in RAM the image will be 4040dc0b7b0eSJason Hobbsloaded to, and "Flash Location" gives the image's address in NOR 4041dc0b7b0eSJason Hobbsflash or offset in NAND flash. 4042dc0b7b0eSJason Hobbs 4043dc0b7b0eSJason Hobbs*Note* - these variables don't have to be defined for all boards, some 4044dc0b7b0eSJason Hobbsboards currenlty use other variables for these purposes, and some 4045dc0b7b0eSJason Hobbsboards use these variables for other purposes. 4046dc0b7b0eSJason Hobbs 4047dc0b7b0eSJason HobbsImage File Name RAM Address Flash Location 4048dc0b7b0eSJason Hobbs----- --------- ----------- -------------- 4049dc0b7b0eSJason Hobbsu-boot u-boot u-boot_addr_r u-boot_addr 4050dc0b7b0eSJason HobbsLinux kernel bootfile kernel_addr_r kernel_addr 4051dc0b7b0eSJason Hobbsdevice tree blob fdtfile fdt_addr_r fdt_addr 4052dc0b7b0eSJason Hobbsramdisk ramdiskfile ramdisk_addr_r ramdisk_addr 4053dc0b7b0eSJason Hobbs 4054c609719bSwdenkThe following environment variables may be used and automatically 4055c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"), 4056c609719bSwdenkdepending the information provided by your boot server: 4057c609719bSwdenk 4058c609719bSwdenk bootfile - see above 4059c609719bSwdenk dnsip - IP address of your Domain Name Server 4060fe389a82Sstroese dnsip2 - IP address of your secondary Domain Name Server 4061c609719bSwdenk gatewayip - IP address of the Gateway (Router) to use 4062c609719bSwdenk hostname - Target hostname 4063c609719bSwdenk ipaddr - see above 4064c609719bSwdenk netmask - Subnet Mask 4065c609719bSwdenk rootpath - Pathname of the root filesystem on the NFS server 4066c609719bSwdenk serverip - see above 4067c609719bSwdenk 4068c609719bSwdenk 4069c609719bSwdenkThere are two special Environment Variables: 4070c609719bSwdenk 4071c609719bSwdenk serial# - contains hardware identification information such 4072c609719bSwdenk as type string and/or serial number 4073c609719bSwdenk ethaddr - Ethernet address 4074c609719bSwdenk 4075c609719bSwdenkThese variables can be set only once (usually during manufacturing of 4076c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables 4077c609719bSwdenkonce they have been set once. 4078c609719bSwdenk 4079c609719bSwdenk 4080c1551ea8SstroeseFurther special Environment Variables: 4081c1551ea8Sstroese 4082c1551ea8Sstroese ver - Contains the U-Boot version string as printed 4083c1551ea8Sstroese with the "version" command. This variable is 4084c1551ea8Sstroese readonly (see CONFIG_VERSION_VARIABLE). 4085c1551ea8Sstroese 4086c1551ea8Sstroese 4087c609719bSwdenkPlease note that changes to some configuration parameters may take 4088c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-). 4089c609719bSwdenk 4090c609719bSwdenk 4091f07771ccSwdenkCommand Line Parsing: 4092f07771ccSwdenk===================== 4093f07771ccSwdenk 4094f07771ccSwdenkThere are two different command line parsers available with U-Boot: 40957152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell: 4096f07771ccSwdenk 4097f07771ccSwdenkOld, simple command line parser: 4098f07771ccSwdenk-------------------------------- 4099f07771ccSwdenk 4100f07771ccSwdenk- supports environment variables (through setenv / saveenv commands) 4101f07771ccSwdenk- several commands on one line, separated by ';' 4102fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax 4103f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\', 4104f07771ccSwdenk for example: 4105fe126d8bSWolfgang Denk setenv bootcmd bootm \${address} 4106f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example: 4107f07771ccSwdenk setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off' 4108f07771ccSwdenk 4109f07771ccSwdenkHush shell: 4110f07771ccSwdenk----------- 4111f07771ccSwdenk 4112f07771ccSwdenk- similar to Bourne shell, with control structures like 4113f07771ccSwdenk if...then...else...fi, for...do...done; while...do...done, 4114f07771ccSwdenk until...do...done, ... 4115f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv 4116f07771ccSwdenk commands) and local shell variables (through standard shell syntax 4117f07771ccSwdenk "name=value"); only environment variables can be used with "run" 4118f07771ccSwdenk command 4119f07771ccSwdenk 4120f07771ccSwdenkGeneral rules: 4121f07771ccSwdenk-------------- 4122f07771ccSwdenk 4123f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run" 4124f07771ccSwdenk command) contains several commands separated by semicolon, and 4125f07771ccSwdenk one of these commands fails, then the remaining commands will be 4126f07771ccSwdenk executed anyway. 4127f07771ccSwdenk 4128f07771ccSwdenk(2) If you execute several variables with one call to run (i. e. 412911ccc33fSMarcel Ziswiler calling run with a list of variables as arguments), any failing 4130f07771ccSwdenk command will cause "run" to terminate, i. e. the remaining 4131f07771ccSwdenk variables are not executed. 4132f07771ccSwdenk 4133c609719bSwdenkNote for Redundant Ethernet Interfaces: 4134c609719bSwdenk======================================= 4135c609719bSwdenk 413611ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports 4137c609719bSwdenksuch configurations and is capable of automatic selection of a 41387152b1d0Swdenk"working" interface when needed. MAC assignment works as follows: 4139c609719bSwdenk 4140c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding 4141c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0), 4142c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ... 4143c609719bSwdenk 4144c609719bSwdenkIf the network interface stores some valid MAC address (for instance 4145c609719bSwdenkin SROM), this is used as default address if there is NO correspon- 4146c609719bSwdenkding setting in the environment; if the corresponding environment 4147c609719bSwdenkvariable is set, this overrides the settings in the card; that means: 4148c609719bSwdenk 4149c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the 4150c609719bSwdenk environment, the SROM's address is used. 4151c609719bSwdenk 4152c609719bSwdenko If there is no valid address in the SROM, and a definition in the 4153c609719bSwdenk environment exists, then the value from the environment variable is 4154c609719bSwdenk used. 4155c609719bSwdenk 4156c609719bSwdenko If both the SROM and the environment contain a MAC address, and 4157c609719bSwdenk both addresses are the same, this MAC address is used. 4158c609719bSwdenk 4159c609719bSwdenko If both the SROM and the environment contain a MAC address, and the 4160c609719bSwdenk addresses differ, the value from the environment is used and a 4161c609719bSwdenk warning is printed. 4162c609719bSwdenk 4163c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error 4164c609719bSwdenk is raised. 4165c609719bSwdenk 4166ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses 4167ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process. This 4168ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable. 4169ecee9324SBen WarrenThe naming convention is as follows: 4170ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc. 4171c609719bSwdenk 4172c609719bSwdenkImage Formats: 4173c609719bSwdenk============== 4174c609719bSwdenk 41753310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on) 41763310c549SMarian Balakowiczimages in two formats: 41773310c549SMarian Balakowicz 41783310c549SMarian BalakowiczNew uImage format (FIT) 41793310c549SMarian Balakowicz----------------------- 41803310c549SMarian Balakowicz 41813310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar 41823310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple 41833310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by 41843310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory. 41853310c549SMarian Balakowicz 41863310c549SMarian Balakowicz 41873310c549SMarian BalakowiczOld uImage format 41883310c549SMarian Balakowicz----------------- 41893310c549SMarian Balakowicz 41903310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything, 41913310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for 41923310c549SMarian Balakowiczdetails; basically, the header defines the following image properties: 4193c609719bSwdenk 4194c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD, 4195c609719bSwdenk 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks, 4196f5ed9e39SPeter Tyser LynxOS, pSOS, QNX, RTEMS, INTEGRITY; 4197f5ed9e39SPeter Tyser Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS, 4198f5ed9e39SPeter Tyser INTEGRITY). 41997b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86, 4200afc1ce82SMacpaul Lin IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit; 4201afc1ce82SMacpaul Lin Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC). 4202c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2) 4203c609719bSwdenk* Load Address 4204c609719bSwdenk* Entry Point 4205c609719bSwdenk* Image Name 4206c609719bSwdenk* Image Timestamp 4207c609719bSwdenk 4208c609719bSwdenkThe header is marked by a special Magic Number, and both the header 4209c609719bSwdenkand the data portions of the image are secured against corruption by 4210c609719bSwdenkCRC32 checksums. 4211c609719bSwdenk 4212c609719bSwdenk 4213c609719bSwdenkLinux Support: 4214c609719bSwdenk============== 4215c609719bSwdenk 4216c609719bSwdenkAlthough U-Boot should support any OS or standalone application 42177152b1d0Swdenkeasily, the main focus has always been on Linux during the design of 4218c609719bSwdenkU-Boot. 4219c609719bSwdenk 4220c609719bSwdenkU-Boot includes many features that so far have been part of some 4221c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any 4222c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image; 4223c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation 42247152b1d0Swdenkserves several purposes: 4225c609719bSwdenk 4226c609719bSwdenk- the same features can be used for other OS or standalone 4227c609719bSwdenk applications (for instance: using compressed images to reduce the 4228c609719bSwdenk Flash memory footprint) 4229c609719bSwdenk 4230c609719bSwdenk- it becomes much easier to port new Linux kernel versions because 42317152b1d0Swdenk lots of low-level, hardware dependent stuff are done by U-Boot 4232c609719bSwdenk 4233c609719bSwdenk- the same Linux kernel image can now be used with different "initrd" 4234c609719bSwdenk images; of course this also means that different kernel images can 4235c609719bSwdenk be run with the same "initrd". This makes testing easier (you don't 4236c609719bSwdenk have to build a new "zImage.initrd" Linux image when you just 4237c609719bSwdenk change a file in your "initrd"). Also, a field-upgrade of the 4238c609719bSwdenk software is easier now. 4239c609719bSwdenk 4240c609719bSwdenk 4241c609719bSwdenkLinux HOWTO: 4242c609719bSwdenk============ 4243c609719bSwdenk 4244c609719bSwdenkPorting Linux to U-Boot based systems: 4245c609719bSwdenk--------------------------------------- 4246c609719bSwdenk 4247c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to 4248c609719bSwdenkconfigure the Linux device drivers for use with your target hardware 4249c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to 4250c609719bSwdenkLinux :-). 4251c609719bSwdenk 4252a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot). 4253c609719bSwdenk 4254c609719bSwdenkJust make sure your machine specific header file (for instance 4255c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board 42561dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h, 42571dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value 42586d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR. 4259c609719bSwdenk 4260c609719bSwdenk 4261c609719bSwdenkConfiguring the Linux kernel: 4262c609719bSwdenk----------------------------- 4263c609719bSwdenk 4264c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root 4265c609719bSwdenkdevice (initial ramdisk, NFS) for your target system. 4266c609719bSwdenk 4267c609719bSwdenk 4268c609719bSwdenkBuilding a Linux Image: 4269c609719bSwdenk----------------------- 4270c609719bSwdenk 427124ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are 427224ee89b9Swdenknot used. If you use recent kernel source, a new build target 427324ee89b9Swdenk"uImage" will exist which automatically builds an image usable by 427424ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target, 427524ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a 427624ee89b9Swdenk100% compatible format. 4277c609719bSwdenk 4278c609719bSwdenkExample: 4279c609719bSwdenk 4280c609719bSwdenk make TQM850L_config 4281c609719bSwdenk make oldconfig 4282c609719bSwdenk make dep 428324ee89b9Swdenk make uImage 4284c609719bSwdenk 428524ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to 428624ee89b9Swdenkencapsulate a compressed Linux kernel image with header information, 428724ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing: 4288c609719bSwdenk 428924ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format): 429024ee89b9Swdenk 429124ee89b9Swdenk* convert the kernel into a raw binary image: 429224ee89b9Swdenk 429324ee89b9Swdenk ${CROSS_COMPILE}-objcopy -O binary \ 429424ee89b9Swdenk -R .note -R .comment \ 429524ee89b9Swdenk -S vmlinux linux.bin 429624ee89b9Swdenk 429724ee89b9Swdenk* compress the binary image: 429824ee89b9Swdenk 429924ee89b9Swdenk gzip -9 linux.bin 430024ee89b9Swdenk 430124ee89b9Swdenk* package compressed binary image for U-Boot: 430224ee89b9Swdenk 430324ee89b9Swdenk mkimage -A ppc -O linux -T kernel -C gzip \ 430424ee89b9Swdenk -a 0 -e 0 -n "Linux Kernel Image" \ 430524ee89b9Swdenk -d linux.bin.gz uImage 430624ee89b9Swdenk 430724ee89b9Swdenk 430824ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use 430924ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or 431024ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64 431124ee89b9Swdenkbyte header containing information about target architecture, 431224ee89b9Swdenkoperating system, image type, compression method, entry points, time 431324ee89b9Swdenkstamp, CRC32 checksums, etc. 431424ee89b9Swdenk 431524ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and 431624ee89b9Swdenkprint the header information, or to build new images. 4317c609719bSwdenk 4318c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information 4319c609719bSwdenkcontained in the header of an existing U-Boot image; this includes 4320c609719bSwdenkchecksum verification: 4321c609719bSwdenk 4322c609719bSwdenk tools/mkimage -l image 4323c609719bSwdenk -l ==> list image header information 4324c609719bSwdenk 4325c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image 4326c609719bSwdenkfrom a "data file" which is used as image payload: 4327c609719bSwdenk 4328c609719bSwdenk tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \ 4329c609719bSwdenk -n name -d data_file image 4330c609719bSwdenk -A ==> set architecture to 'arch' 4331c609719bSwdenk -O ==> set operating system to 'os' 4332c609719bSwdenk -T ==> set image type to 'type' 4333c609719bSwdenk -C ==> set compression type 'comp' 4334c609719bSwdenk -a ==> set load address to 'addr' (hex) 4335c609719bSwdenk -e ==> set entry point to 'ep' (hex) 4336c609719bSwdenk -n ==> set image name to 'name' 4337c609719bSwdenk -d ==> use image data from 'datafile' 4338c609719bSwdenk 433969459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load 434069459791Swdenkaddress (0x00000000), but the entry point address depends on the 434169459791Swdenkkernel version: 4342c609719bSwdenk 4343c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C, 434424ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000. 4345c609719bSwdenk 4346c609719bSwdenkSo a typical call to build a U-Boot image would read: 4347c609719bSwdenk 434824ee89b9Swdenk -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 434924ee89b9Swdenk > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \ 4350a47a12beSStefan Roese > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \ 435124ee89b9Swdenk > examples/uImage.TQM850L 435224ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 4353c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 4354c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 4355c609719bSwdenk Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 4356c609719bSwdenk Load Address: 0x00000000 435724ee89b9Swdenk Entry Point: 0x00000000 4358c609719bSwdenk 4359c609719bSwdenkTo verify the contents of the image (or check for corruption): 4360c609719bSwdenk 436124ee89b9Swdenk -> tools/mkimage -l examples/uImage.TQM850L 436224ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 4363c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 4364c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 4365c609719bSwdenk Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 4366c609719bSwdenk Load Address: 0x00000000 436724ee89b9Swdenk Entry Point: 0x00000000 4368c609719bSwdenk 4369c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade 4370c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this 4371c609719bSwdenkneeds more space in Flash, but boots much faster since it does not 4372c609719bSwdenkneed to be uncompressed: 4373c609719bSwdenk 4374a47a12beSStefan Roese -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz 437524ee89b9Swdenk -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 437624ee89b9Swdenk > -A ppc -O linux -T kernel -C none -a 0 -e 0 \ 4377a47a12beSStefan Roese > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \ 437824ee89b9Swdenk > examples/uImage.TQM850L-uncompressed 437924ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 4380c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 4381c609719bSwdenk Image Type: PowerPC Linux Kernel Image (uncompressed) 4382c609719bSwdenk Data Size: 792160 Bytes = 773.59 kB = 0.76 MB 4383c609719bSwdenk Load Address: 0x00000000 438424ee89b9Swdenk Entry Point: 0x00000000 4385c609719bSwdenk 4386c609719bSwdenk 4387c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file 4388c609719bSwdenkwhen your kernel is intended to use an initial ramdisk: 4389c609719bSwdenk 4390c609719bSwdenk -> tools/mkimage -n 'Simple Ramdisk Image' \ 4391c609719bSwdenk > -A ppc -O linux -T ramdisk -C gzip \ 4392c609719bSwdenk > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd 4393c609719bSwdenk Image Name: Simple Ramdisk Image 4394c609719bSwdenk Created: Wed Jan 12 14:01:50 2000 4395c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 4396c609719bSwdenk Data Size: 566530 Bytes = 553.25 kB = 0.54 MB 4397c609719bSwdenk Load Address: 0x00000000 4398c609719bSwdenk Entry Point: 0x00000000 4399c609719bSwdenk 4400c609719bSwdenk 4401c609719bSwdenkInstalling a Linux Image: 4402c609719bSwdenk------------------------- 4403c609719bSwdenk 4404c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface, 4405c609719bSwdenkyou must convert the image to S-Record format: 4406c609719bSwdenk 4407c609719bSwdenk objcopy -I binary -O srec examples/image examples/image.srec 4408c609719bSwdenk 4409c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot 4410c609719bSwdenkimage header, so the resulting S-Record file will be relative to 4411c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to 4412c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads' 4413c609719bSwdenkcommand. 4414c609719bSwdenk 4415c609719bSwdenkExample: install the image to address 0x40100000 (which on the 4416c609719bSwdenkTQM8xxL is in the first Flash bank): 4417c609719bSwdenk 4418c609719bSwdenk => erase 40100000 401FFFFF 4419c609719bSwdenk 4420c609719bSwdenk .......... done 4421c609719bSwdenk Erased 8 sectors 4422c609719bSwdenk 4423c609719bSwdenk => loads 40100000 4424c609719bSwdenk ## Ready for S-Record download ... 4425c609719bSwdenk ~>examples/image.srec 4426c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 12 13 ... 4427c609719bSwdenk ... 4428c609719bSwdenk 15989 15990 15991 15992 4429c609719bSwdenk [file transfer complete] 4430c609719bSwdenk [connected] 4431c609719bSwdenk ## Start Addr = 0x00000000 4432c609719bSwdenk 4433c609719bSwdenk 4434c609719bSwdenkYou can check the success of the download using the 'iminfo' command; 4435c609719bSwdenkthis includes a checksum verification so you can be sure no data 4436c609719bSwdenkcorruption happened: 4437c609719bSwdenk 4438c609719bSwdenk => imi 40100000 4439c609719bSwdenk 4440c609719bSwdenk ## Checking Image at 40100000 ... 4441c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 4442c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 4443c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 4444c609719bSwdenk Load Address: 00000000 4445c609719bSwdenk Entry Point: 0000000c 4446c609719bSwdenk Verifying Checksum ... OK 4447c609719bSwdenk 4448c609719bSwdenk 4449c609719bSwdenkBoot Linux: 4450c609719bSwdenk----------- 4451c609719bSwdenk 4452c609719bSwdenkThe "bootm" command is used to boot an application that is stored in 4453c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents 4454c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as 4455c609719bSwdenkparameters. You can check and modify this variable using the 4456c609719bSwdenk"printenv" and "setenv" commands: 4457c609719bSwdenk 4458c609719bSwdenk 4459c609719bSwdenk => printenv bootargs 4460c609719bSwdenk bootargs=root=/dev/ram 4461c609719bSwdenk 4462c609719bSwdenk => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 4463c609719bSwdenk 4464c609719bSwdenk => printenv bootargs 4465c609719bSwdenk bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 4466c609719bSwdenk 4467c609719bSwdenk => bootm 40020000 4468c609719bSwdenk ## Booting Linux kernel at 40020000 ... 4469c609719bSwdenk Image Name: 2.2.13 for NFS on TQM850L 4470c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 4471c609719bSwdenk Data Size: 381681 Bytes = 372 kB = 0 MB 4472c609719bSwdenk Load Address: 00000000 4473c609719bSwdenk Entry Point: 0000000c 4474c609719bSwdenk Verifying Checksum ... OK 4475c609719bSwdenk Uncompressing Kernel Image ... OK 4476c609719bSwdenk 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 4477c609719bSwdenk Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 4478c609719bSwdenk time_init: decrementer frequency = 187500000/60 4479c609719bSwdenk Calibrating delay loop... 49.77 BogoMIPS 4480c609719bSwdenk Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000] 4481c609719bSwdenk ... 4482c609719bSwdenk 448311ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass 44847152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT 4485c609719bSwdenkformat!) to the "bootm" command: 4486c609719bSwdenk 4487c609719bSwdenk => imi 40100000 40200000 4488c609719bSwdenk 4489c609719bSwdenk ## Checking Image at 40100000 ... 4490c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 4491c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 4492c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 4493c609719bSwdenk Load Address: 00000000 4494c609719bSwdenk Entry Point: 0000000c 4495c609719bSwdenk Verifying Checksum ... OK 4496c609719bSwdenk 4497c609719bSwdenk ## Checking Image at 40200000 ... 4498c609719bSwdenk Image Name: Simple Ramdisk Image 4499c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 4500c609719bSwdenk Data Size: 566530 Bytes = 553 kB = 0 MB 4501c609719bSwdenk Load Address: 00000000 4502c609719bSwdenk Entry Point: 00000000 4503c609719bSwdenk Verifying Checksum ... OK 4504c609719bSwdenk 4505c609719bSwdenk => bootm 40100000 40200000 4506c609719bSwdenk ## Booting Linux kernel at 40100000 ... 4507c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 4508c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 4509c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 4510c609719bSwdenk Load Address: 00000000 4511c609719bSwdenk Entry Point: 0000000c 4512c609719bSwdenk Verifying Checksum ... OK 4513c609719bSwdenk Uncompressing Kernel Image ... OK 4514c609719bSwdenk ## Loading RAMDisk Image at 40200000 ... 4515c609719bSwdenk Image Name: Simple Ramdisk Image 4516c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 4517c609719bSwdenk Data Size: 566530 Bytes = 553 kB = 0 MB 4518c609719bSwdenk Load Address: 00000000 4519c609719bSwdenk Entry Point: 00000000 4520c609719bSwdenk Verifying Checksum ... OK 4521c609719bSwdenk Loading Ramdisk ... OK 4522c609719bSwdenk 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 4523c609719bSwdenk Boot arguments: root=/dev/ram 4524c609719bSwdenk time_init: decrementer frequency = 187500000/60 4525c609719bSwdenk Calibrating delay loop... 49.77 BogoMIPS 4526c609719bSwdenk ... 4527c609719bSwdenk RAMDISK: Compressed image found at block 0 4528c609719bSwdenk VFS: Mounted root (ext2 filesystem). 4529c609719bSwdenk 4530c609719bSwdenk bash# 4531c609719bSwdenk 45320267768eSMatthew McClintockBoot Linux and pass a flat device tree: 45330267768eSMatthew McClintock----------- 45340267768eSMatthew McClintock 45350267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section 45360267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The 45370267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated 45380267768eSMatthew McClintockflat device tree: 45390267768eSMatthew McClintock 45400267768eSMatthew McClintock=> print oftaddr 45410267768eSMatthew McClintockoftaddr=0x300000 45420267768eSMatthew McClintock=> print oft 45430267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb 45440267768eSMatthew McClintock=> tftp $oftaddr $oft 45450267768eSMatthew McClintockSpeed: 1000, full duplex 45460267768eSMatthew McClintockUsing TSEC0 device 45470267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101 45480267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'. 45490267768eSMatthew McClintockLoad address: 0x300000 45500267768eSMatthew McClintockLoading: # 45510267768eSMatthew McClintockdone 45520267768eSMatthew McClintockBytes transferred = 4106 (100a hex) 45530267768eSMatthew McClintock=> tftp $loadaddr $bootfile 45540267768eSMatthew McClintockSpeed: 1000, full duplex 45550267768eSMatthew McClintockUsing TSEC0 device 45560267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2 45570267768eSMatthew McClintockFilename 'uImage'. 45580267768eSMatthew McClintockLoad address: 0x200000 45590267768eSMatthew McClintockLoading:############ 45600267768eSMatthew McClintockdone 45610267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex) 45620267768eSMatthew McClintock=> print loadaddr 45630267768eSMatthew McClintockloadaddr=200000 45640267768eSMatthew McClintock=> print oftaddr 45650267768eSMatthew McClintockoftaddr=0x300000 45660267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr 45670267768eSMatthew McClintock## Booting image at 00200000 ... 45680267768eSMatthew McClintock Image Name: Linux-2.6.17-dirty 45690267768eSMatthew McClintock Image Type: PowerPC Linux Kernel Image (gzip compressed) 45700267768eSMatthew McClintock Data Size: 1029343 Bytes = 1005.2 kB 45710267768eSMatthew McClintock Load Address: 00000000 45720267768eSMatthew McClintock Entry Point: 00000000 45730267768eSMatthew McClintock Verifying Checksum ... OK 45740267768eSMatthew McClintock Uncompressing Kernel Image ... OK 45750267768eSMatthew McClintockBooting using flat device tree at 0x300000 45760267768eSMatthew McClintockUsing MPC85xx ADS machine description 45770267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb 45780267768eSMatthew McClintock[snip] 45790267768eSMatthew McClintock 45800267768eSMatthew McClintock 45816069ff26SwdenkMore About U-Boot Image Types: 45826069ff26Swdenk------------------------------ 45836069ff26Swdenk 45846069ff26SwdenkU-Boot supports the following image types: 45856069ff26Swdenk 45866069ff26Swdenk "Standalone Programs" are directly runnable in the environment 45876069ff26Swdenk provided by U-Boot; it is expected that (if they behave 45886069ff26Swdenk well) you can continue to work in U-Boot after return from 45896069ff26Swdenk the Standalone Program. 45906069ff26Swdenk "OS Kernel Images" are usually images of some Embedded OS which 45916069ff26Swdenk will take over control completely. Usually these programs 45926069ff26Swdenk will install their own set of exception handlers, device 45936069ff26Swdenk drivers, set up the MMU, etc. - this means, that you cannot 45946069ff26Swdenk expect to re-enter U-Boot except by resetting the CPU. 45956069ff26Swdenk "RAMDisk Images" are more or less just data blocks, and their 45966069ff26Swdenk parameters (address, size) are passed to an OS kernel that is 45976069ff26Swdenk being started. 45986069ff26Swdenk "Multi-File Images" contain several images, typically an OS 45996069ff26Swdenk (Linux) kernel image and one or more data images like 46006069ff26Swdenk RAMDisks. This construct is useful for instance when you want 46016069ff26Swdenk to boot over the network using BOOTP etc., where the boot 46026069ff26Swdenk server provides just a single image file, but you want to get 46036069ff26Swdenk for instance an OS kernel and a RAMDisk image. 46046069ff26Swdenk 46056069ff26Swdenk "Multi-File Images" start with a list of image sizes, each 46066069ff26Swdenk image size (in bytes) specified by an "uint32_t" in network 46076069ff26Swdenk byte order. This list is terminated by an "(uint32_t)0". 46086069ff26Swdenk Immediately after the terminating 0 follow the images, one by 46096069ff26Swdenk one, all aligned on "uint32_t" boundaries (size rounded up to 46106069ff26Swdenk a multiple of 4 bytes). 46116069ff26Swdenk 46126069ff26Swdenk "Firmware Images" are binary images containing firmware (like 46136069ff26Swdenk U-Boot or FPGA images) which usually will be programmed to 46146069ff26Swdenk flash memory. 46156069ff26Swdenk 46166069ff26Swdenk "Script files" are command sequences that will be executed by 46176069ff26Swdenk U-Boot's command interpreter; this feature is especially 46186069ff26Swdenk useful when you configure U-Boot to use a real shell (hush) 46196069ff26Swdenk as command interpreter. 46206069ff26Swdenk 462144f074c7SMarek VasutBooting the Linux zImage: 462244f074c7SMarek Vasut------------------------- 462344f074c7SMarek Vasut 462444f074c7SMarek VasutOn some platforms, it's possible to boot Linux zImage. This is done 462544f074c7SMarek Vasutusing the "bootz" command. The syntax of "bootz" command is the same 462644f074c7SMarek Vasutas the syntax of "bootm" command. 462744f074c7SMarek Vasut 4628017e1f3fSMarek VasutNote, defining the CONFIG_SUPPORT_INITRD_RAW allows user to supply 4629017e1f3fSMarek Vasutkernel with raw initrd images. The syntax is slightly different, the 4630017e1f3fSMarek Vasutaddress of the initrd must be augmented by it's size, in the following 4631017e1f3fSMarek Vasutformat: "<initrd addres>:<initrd size>". 4632017e1f3fSMarek Vasut 4633c609719bSwdenk 4634c609719bSwdenkStandalone HOWTO: 4635c609719bSwdenk================= 4636c609719bSwdenk 4637c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and 4638c609719bSwdenkrun "standalone" applications, which can use some resources of 4639c609719bSwdenkU-Boot like console I/O functions or interrupt services. 4640c609719bSwdenk 4641c609719bSwdenkTwo simple examples are included with the sources: 4642c609719bSwdenk 4643c609719bSwdenk"Hello World" Demo: 4644c609719bSwdenk------------------- 4645c609719bSwdenk 4646c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo 4647c609719bSwdenkapplication; it is automatically compiled when you build U-Boot. 4648c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it 4649c609719bSwdenklike that: 4650c609719bSwdenk 4651c609719bSwdenk => loads 4652c609719bSwdenk ## Ready for S-Record download ... 4653c609719bSwdenk ~>examples/hello_world.srec 4654c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 ... 4655c609719bSwdenk [file transfer complete] 4656c609719bSwdenk [connected] 4657c609719bSwdenk ## Start Addr = 0x00040004 4658c609719bSwdenk 4659c609719bSwdenk => go 40004 Hello World! This is a test. 4660c609719bSwdenk ## Starting application at 0x00040004 ... 4661c609719bSwdenk Hello World 4662c609719bSwdenk argc = 7 4663c609719bSwdenk argv[0] = "40004" 4664c609719bSwdenk argv[1] = "Hello" 4665c609719bSwdenk argv[2] = "World!" 4666c609719bSwdenk argv[3] = "This" 4667c609719bSwdenk argv[4] = "is" 4668c609719bSwdenk argv[5] = "a" 4669c609719bSwdenk argv[6] = "test." 4670c609719bSwdenk argv[7] = "<NULL>" 4671c609719bSwdenk Hit any key to exit ... 4672c609719bSwdenk 4673c609719bSwdenk ## Application terminated, rc = 0x0 4674c609719bSwdenk 4675c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt 4676c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'. 4677c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second. 4678c609719bSwdenkThe interrupt service routine is trivial, just printing a '.' 4679c609719bSwdenkcharacter, but this is just a demo program. The application can be 4680c609719bSwdenkcontrolled by the following keys: 4681c609719bSwdenk 4682c609719bSwdenk ? - print current values og the CPM Timer registers 4683c609719bSwdenk b - enable interrupts and start timer 4684c609719bSwdenk e - stop timer and disable interrupts 4685c609719bSwdenk q - quit application 4686c609719bSwdenk 4687c609719bSwdenk => loads 4688c609719bSwdenk ## Ready for S-Record download ... 4689c609719bSwdenk ~>examples/timer.srec 4690c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 ... 4691c609719bSwdenk [file transfer complete] 4692c609719bSwdenk [connected] 4693c609719bSwdenk ## Start Addr = 0x00040004 4694c609719bSwdenk 4695c609719bSwdenk => go 40004 4696c609719bSwdenk ## Starting application at 0x00040004 ... 4697c609719bSwdenk TIMERS=0xfff00980 4698c609719bSwdenk Using timer 1 4699c609719bSwdenk tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0 4700c609719bSwdenk 4701c609719bSwdenkHit 'b': 4702c609719bSwdenk [q, b, e, ?] Set interval 1000000 us 4703c609719bSwdenk Enabling timer 4704c609719bSwdenkHit '?': 4705c609719bSwdenk [q, b, e, ?] ........ 4706c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0 4707c609719bSwdenkHit '?': 4708c609719bSwdenk [q, b, e, ?] . 4709c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0 4710c609719bSwdenkHit '?': 4711c609719bSwdenk [q, b, e, ?] . 4712c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0 4713c609719bSwdenkHit '?': 4714c609719bSwdenk [q, b, e, ?] . 4715c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0 4716c609719bSwdenkHit 'e': 4717c609719bSwdenk [q, b, e, ?] ...Stopping timer 4718c609719bSwdenkHit 'q': 4719c609719bSwdenk [q, b, e, ?] ## Application terminated, rc = 0x0 4720c609719bSwdenk 4721c609719bSwdenk 472285ec0bccSwdenkMinicom warning: 472385ec0bccSwdenk================ 472485ec0bccSwdenk 47257152b1d0SwdenkOver time, many people have reported problems when trying to use the 472685ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd) 472785ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under 4728f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and 472985ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and 4730e53515a2SKarl O. Pincuse "cu" for S-Record download ("loads" command). See 4731e53515a2SKarl O. Pinchttp://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3. 4732e53515a2SKarl O. Pincfor help with kermit. 4733e53515a2SKarl O. Pinc 473485ec0bccSwdenk 473552f52c14SwdenkNevertheless, if you absolutely want to use it try adding this 473652f52c14Swdenkconfiguration to your "File transfer protocols" section: 473752f52c14Swdenk 473852f52c14Swdenk Name Program Name U/D FullScr IO-Red. Multi 473952f52c14Swdenk X kermit /usr/bin/kermit -i -l %l -s Y U Y N N 474052f52c14Swdenk Y kermit /usr/bin/kermit -i -l %l -r N D Y N N 474152f52c14Swdenk 474252f52c14Swdenk 4743c609719bSwdenkNetBSD Notes: 4744c609719bSwdenk============= 4745c609719bSwdenk 4746c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host 4747c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx). 4748c609719bSwdenk 4749c609719bSwdenkBuilding requires a cross environment; it is known to work on 4750c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also 4751c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make). 4752c609719bSwdenkNote that the cross-powerpc package does not install include files; 4753c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is 4754c609719bSwdenkmissing. This file has to be installed and patched manually: 4755c609719bSwdenk 4756c609719bSwdenk # cd /usr/pkg/cross/powerpc-netbsd/include 4757c609719bSwdenk # mkdir powerpc 4758c609719bSwdenk # ln -s powerpc machine 4759c609719bSwdenk # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h 4760c609719bSwdenk # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST 4761c609719bSwdenk 4762c609719bSwdenkNative builds *don't* work due to incompatibilities between native 4763c609719bSwdenkand U-Boot include files. 4764c609719bSwdenk 4765c609719bSwdenkBooting assumes that (the first part of) the image booted is a 4766c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel 4767c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source 4768c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the 47692a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz 4770c609719bSwdenk 4771c609719bSwdenk 4772c609719bSwdenkImplementation Internals: 4773c609719bSwdenk========================= 4774c609719bSwdenk 4775c609719bSwdenkThe following is not intended to be a complete description of every 4776c609719bSwdenkimplementation detail. However, it should help to understand the 4777c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom 4778c609719bSwdenkhardware. 4779c609719bSwdenk 4780c609719bSwdenk 4781c609719bSwdenkInitial Stack, Global Data: 4782c609719bSwdenk--------------------------- 4783c609719bSwdenk 4784c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot 4785c609719bSwdenkstarts running out of ROM (flash memory), usually without access to 4786c609719bSwdenksystem RAM (because the memory controller is not initialized yet). 4787c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS 4788c609719bSwdenkis not initialized as zero. To be able to get a C environment working 4789c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation 4790c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU 4791c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and 4792c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be 4793c609719bSwdenklocked as (mis-) used as memory, etc. 4794c609719bSwdenk 47957152b1d0Swdenk Chris Hallinan posted a good summary of these issues to the 47960668236bSWolfgang Denk U-Boot mailing list: 479743d9616cSwdenk 479843d9616cSwdenk Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)? 479943d9616cSwdenk From: "Chris Hallinan" <clh@net1plus.com> 480043d9616cSwdenk Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET) 480143d9616cSwdenk ... 480243d9616cSwdenk 480343d9616cSwdenk Correct me if I'm wrong, folks, but the way I understand it 480443d9616cSwdenk is this: Using DCACHE as initial RAM for Stack, etc, does not 480543d9616cSwdenk require any physical RAM backing up the cache. The cleverness 480643d9616cSwdenk is that the cache is being used as a temporary supply of 480743d9616cSwdenk necessary storage before the SDRAM controller is setup. It's 480811ccc33fSMarcel Ziswiler beyond the scope of this list to explain the details, but you 480943d9616cSwdenk can see how this works by studying the cache architecture and 481043d9616cSwdenk operation in the architecture and processor-specific manuals. 481143d9616cSwdenk 481243d9616cSwdenk OCM is On Chip Memory, which I believe the 405GP has 4K. It 481343d9616cSwdenk is another option for the system designer to use as an 481411ccc33fSMarcel Ziswiler initial stack/RAM area prior to SDRAM being available. Either 481543d9616cSwdenk option should work for you. Using CS 4 should be fine if your 481643d9616cSwdenk board designers haven't used it for something that would 481743d9616cSwdenk cause you grief during the initial boot! It is frequently not 481843d9616cSwdenk used. 481943d9616cSwdenk 48206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere 482143d9616cSwdenk with your processor/board/system design. The default value 482243d9616cSwdenk you will find in any recent u-boot distribution in 48238a316c9bSStefan Roese walnut.h should work for you. I'd set it to a value larger 482443d9616cSwdenk than your SDRAM module. If you have a 64MB SDRAM module, set 482543d9616cSwdenk it above 400_0000. Just make sure your board has no resources 482643d9616cSwdenk that are supposed to respond to that address! That code in 482743d9616cSwdenk start.S has been around a while and should work as is when 482843d9616cSwdenk you get the config right. 482943d9616cSwdenk 483043d9616cSwdenk -Chris Hallinan 483143d9616cSwdenk DS4.COM, Inc. 483243d9616cSwdenk 4833c609719bSwdenkIt is essential to remember this, since it has some impact on the C 4834c609719bSwdenkcode for the initialization procedures: 4835c609719bSwdenk 4836c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt 4837c609719bSwdenk to write it. 4838c609719bSwdenk 483911ccc33fSMarcel Ziswiler* Do not use any uninitialized global data (or implicitely initialized 4840c609719bSwdenk as zero data - BSS segment) at all - this is undefined, initiali- 48417152b1d0Swdenk zation is performed later (when relocating to RAM). 4842c609719bSwdenk 4843c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like 4844c609719bSwdenk that. 4845c609719bSwdenk 4846c609719bSwdenkHaving only the stack as writable memory limits means we cannot use 4847c609719bSwdenknormal global data to share information beween the code. But it 4848c609719bSwdenkturned out that the implementation of U-Boot can be greatly 4849c609719bSwdenksimplified by making a global data structure (gd_t) available to all 4850c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_ 4851c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of 4852c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we 4853c609719bSwdenkplace a pointer (gd) to the global data into a register which we 4854c609719bSwdenkreserve for this purpose. 4855c609719bSwdenk 48567152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the 4857c609719bSwdenkrelevant (E)ABI specifications for the current architecture, and by 4858c609719bSwdenkGCC's implementation. 4859c609719bSwdenk 4860c609719bSwdenkFor PowerPC, the following registers have specific use: 4861c609719bSwdenk R1: stack pointer 4862e7670f6cSWolfgang Denk R2: reserved for system use 4863c609719bSwdenk R3-R4: parameter passing and return values 4864c609719bSwdenk R5-R10: parameter passing 4865c609719bSwdenk R13: small data area pointer 4866c609719bSwdenk R30: GOT pointer 4867c609719bSwdenk R31: frame pointer 4868c609719bSwdenk 4869e6bee808SJoakim Tjernlund (U-Boot also uses R12 as internal GOT pointer. r12 4870e6bee808SJoakim Tjernlund is a volatile register so r12 needs to be reset when 4871e6bee808SJoakim Tjernlund going back and forth between asm and C) 4872c609719bSwdenk 4873e7670f6cSWolfgang Denk ==> U-Boot will use R2 to hold a pointer to the global data 4874c609719bSwdenk 4875c609719bSwdenk Note: on PPC, we could use a static initializer (since the 4876c609719bSwdenk address of the global data structure is known at compile time), 4877c609719bSwdenk but it turned out that reserving a register results in somewhat 4878c609719bSwdenk smaller code - although the code savings are not that big (on 4879c609719bSwdenk average for all boards 752 bytes for the whole U-Boot image, 4880c609719bSwdenk 624 text + 127 data). 4881c609719bSwdenk 4882c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here: 48834c58eb55SMike Frysinger http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface 48844c58eb55SMike Frysinger 4885c4db335cSRobin Getz ==> U-Boot will use P3 to hold a pointer to the global data 48864c58eb55SMike Frysinger 4887c609719bSwdenkOn ARM, the following registers are used: 4888c609719bSwdenk 4889c609719bSwdenk R0: function argument word/integer result 4890c609719bSwdenk R1-R3: function argument word 4891c609719bSwdenk R9: GOT pointer 4892c609719bSwdenk R10: stack limit (used only if stack checking if enabled) 4893c609719bSwdenk R11: argument (frame) pointer 4894c609719bSwdenk R12: temporary workspace 4895c609719bSwdenk R13: stack pointer 4896c609719bSwdenk R14: link register 4897c609719bSwdenk R15: program counter 4898c609719bSwdenk 4899c609719bSwdenk ==> U-Boot will use R8 to hold a pointer to the global data 4900c609719bSwdenk 49010df01fd3SThomas ChouOn Nios II, the ABI is documented here: 49020df01fd3SThomas Chou http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf 49030df01fd3SThomas Chou 49040df01fd3SThomas Chou ==> U-Boot will use gp to hold a pointer to the global data 49050df01fd3SThomas Chou 49060df01fd3SThomas Chou Note: on Nios II, we give "-G0" option to gcc and don't use gp 49070df01fd3SThomas Chou to access small data sections, so gp is free. 49080df01fd3SThomas Chou 4909afc1ce82SMacpaul LinOn NDS32, the following registers are used: 4910afc1ce82SMacpaul Lin 4911afc1ce82SMacpaul Lin R0-R1: argument/return 4912afc1ce82SMacpaul Lin R2-R5: argument 4913afc1ce82SMacpaul Lin R15: temporary register for assembler 4914afc1ce82SMacpaul Lin R16: trampoline register 4915afc1ce82SMacpaul Lin R28: frame pointer (FP) 4916afc1ce82SMacpaul Lin R29: global pointer (GP) 4917afc1ce82SMacpaul Lin R30: link register (LP) 4918afc1ce82SMacpaul Lin R31: stack pointer (SP) 4919afc1ce82SMacpaul Lin PC: program counter (PC) 4920afc1ce82SMacpaul Lin 4921afc1ce82SMacpaul Lin ==> U-Boot will use R10 to hold a pointer to the global data 4922afc1ce82SMacpaul Lin 4923d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope, 4924d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much. 4925c609719bSwdenk 4926c609719bSwdenkMemory Management: 4927c609719bSwdenk------------------ 4928c609719bSwdenk 4929c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the 4930c609719bSwdenkMMU is not used either for address mapping nor for memory protection. 4931c609719bSwdenk 4932c609719bSwdenkThe available memory is mapped to fixed addresses using the memory 4933c609719bSwdenkcontroller. In this process, a contiguous block is formed for each 4934c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several 4935c609719bSwdenkphysical memory banks. 4936c609719bSwdenk 4937c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on 4938c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After 4939c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself 4940c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some 49416d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN 4942c609719bSwdenkconfiguration setting]. Below that, a structure with global Board 4943c609719bSwdenkInfo data is placed, followed by the stack (growing downward). 4944c609719bSwdenk 4945c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB 4946c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF). 4947c609719bSwdenk 4948c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like 4949c609719bSwdenkthis: 4950c609719bSwdenk 4951c609719bSwdenk 0x0000 0000 Exception Vector code 4952c609719bSwdenk : 4953c609719bSwdenk 0x0000 1FFF 4954c609719bSwdenk 0x0000 2000 Free for Application Use 4955c609719bSwdenk : 4956c609719bSwdenk : 4957c609719bSwdenk 4958c609719bSwdenk : 4959c609719bSwdenk : 4960c609719bSwdenk 0x00FB FF20 Monitor Stack (Growing downward) 4961c609719bSwdenk 0x00FB FFAC Board Info Data and permanent copy of global data 4962c609719bSwdenk 0x00FC 0000 Malloc Arena 4963c609719bSwdenk : 4964c609719bSwdenk 0x00FD FFFF 4965c609719bSwdenk 0x00FE 0000 RAM Copy of Monitor Code 4966c609719bSwdenk ... eventually: LCD or video framebuffer 4967c609719bSwdenk ... eventually: pRAM (Protected RAM - unchanged by reset) 4968c609719bSwdenk 0x00FF FFFF [End of RAM] 4969c609719bSwdenk 4970c609719bSwdenk 4971c609719bSwdenkSystem Initialization: 4972c609719bSwdenk---------------------- 4973c609719bSwdenk 4974c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point 497511ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset 4976c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory. 49777152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address. 4978c609719bSwdenkTo be able to implement the initialization code in C, a (small!) 4979c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs 4980c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked 4981c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core, 4982c609719bSwdenkthe caches and the SIU. 4983c609719bSwdenk 4984c609719bSwdenkNext, all (potentially) available memory banks are mapped using a 4985c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries 4986c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash 4987c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is 4988c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a 4989c609719bSwdenksimple memory test is run that determines the size of the SDRAM 4990c609719bSwdenkbanks. 4991c609719bSwdenk 4992c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of 49937152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first 4994c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address 4995c609719bSwdenk0x00000000, with any additional banks following immediately to create 4996c609719bSwdenkcontiguous memory starting from 0. 4997c609719bSwdenk 4998c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area 4999c609719bSwdenkand allocates memory for use by malloc() and for the global Board 5000c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM 5001c609719bSwdenkpages, and the final stack is set up. 5002c609719bSwdenk 5003c609719bSwdenkOnly after this relocation will you have a "normal" C environment; 5004c609719bSwdenkuntil that you are restricted in several ways, mostly because you are 5005c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a 5006c609719bSwdenknew address in RAM. 5007c609719bSwdenk 5008c609719bSwdenk 5009c609719bSwdenkU-Boot Porting Guide: 5010c609719bSwdenk---------------------- 5011c609719bSwdenk 5012c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing 50136aff3115Swdenklist, October 2002] 5014c609719bSwdenk 5015c609719bSwdenk 5016c609719bSwdenkint main(int argc, char *argv[]) 5017c609719bSwdenk{ 5018c609719bSwdenk sighandler_t no_more_time; 5019c609719bSwdenk 5020c609719bSwdenk signal(SIGALRM, no_more_time); 5021c609719bSwdenk alarm(PROJECT_DEADLINE - toSec (3 * WEEK)); 5022c609719bSwdenk 5023c609719bSwdenk if (available_money > available_manpower) { 50246c3fef28SJerry Van Baren Pay consultant to port U-Boot; 5025c609719bSwdenk return 0; 5026c609719bSwdenk } 5027c609719bSwdenk 5028c609719bSwdenk Download latest U-Boot source; 5029c609719bSwdenk 50300668236bSWolfgang Denk Subscribe to u-boot mailing list; 50316aff3115Swdenk 50326c3fef28SJerry Van Baren if (clueless) 5033c609719bSwdenk email("Hi, I am new to U-Boot, how do I get started?"); 5034c609719bSwdenk 5035c609719bSwdenk while (learning) { 5036c609719bSwdenk Read the README file in the top level directory; 50377cb22f97Swdenk Read http://www.denx.de/twiki/bin/view/DULG/Manual; 50386c3fef28SJerry Van Baren Read applicable doc/*.README; 5039c609719bSwdenk Read the source, Luke; 50406c3fef28SJerry Van Baren /* find . -name "*.[chS]" | xargs grep -i <keyword> */ 5041c609719bSwdenk } 5042c609719bSwdenk 50436c3fef28SJerry Van Baren if (available_money > toLocalCurrency ($2500)) 50446c3fef28SJerry Van Baren Buy a BDI3000; 50456c3fef28SJerry Van Baren else 5046c609719bSwdenk Add a lot of aggravation and time; 5047c609719bSwdenk 50486c3fef28SJerry Van Baren if (a similar board exists) { /* hopefully... */ 50496c3fef28SJerry Van Baren cp -a board/<similar> board/<myboard> 50506c3fef28SJerry Van Baren cp include/configs/<similar>.h include/configs/<myboard>.h 50516c3fef28SJerry Van Baren } else { 5052c609719bSwdenk Create your own board support subdirectory; 50536c3fef28SJerry Van Baren Create your own board include/configs/<myboard>.h file; 50546c3fef28SJerry Van Baren } 50556c3fef28SJerry Van Baren Edit new board/<myboard> files 50566c3fef28SJerry Van Baren Edit new include/configs/<myboard>.h 5057c609719bSwdenk 50586c3fef28SJerry Van Baren while (!accepted) { 5059c609719bSwdenk while (!running) { 5060c609719bSwdenk do { 5061c609719bSwdenk Add / modify source code; 5062c609719bSwdenk } until (compiles); 5063c609719bSwdenk Debug; 5064c609719bSwdenk if (clueless) 5065c609719bSwdenk email("Hi, I am having problems..."); 5066c609719bSwdenk } 50676c3fef28SJerry Van Baren Send patch file to the U-Boot email list; 50686c3fef28SJerry Van Baren if (reasonable critiques) 50696c3fef28SJerry Van Baren Incorporate improvements from email list code review; 50706c3fef28SJerry Van Baren else 50716c3fef28SJerry Van Baren Defend code as written; 50726c3fef28SJerry Van Baren } 5073c609719bSwdenk 5074c609719bSwdenk return 0; 5075c609719bSwdenk} 5076c609719bSwdenk 5077c609719bSwdenkvoid no_more_time (int sig) 5078c609719bSwdenk{ 5079c609719bSwdenk hire_a_guru(); 5080c609719bSwdenk} 5081c609719bSwdenk 5082c609719bSwdenk 5083c609719bSwdenkCoding Standards: 5084c609719bSwdenk----------------- 5085c609719bSwdenk 5086c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel 50872c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script 50887ca9296eSWolfgang Denk"scripts/Lindent" in your Linux kernel source directory. 5089c609719bSwdenk 50902c051651SDetlev ZundelSource files originating from a different project (for example the 50912c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not 50922c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those 50932c051651SDetlev Zundelsources. 50942c051651SDetlev Zundel 50952c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in 50962c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//) 50972c051651SDetlev Zundelin your code. 5098c609719bSwdenk 5099c178d3daSwdenkPlease also stick to the following formatting rules: 5100180d3f74Swdenk- remove any trailing white space 51017ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces 5102180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds 51037ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files 5104180d3f74Swdenk- do not add trailing empty lines to source files 5105180d3f74Swdenk 5106c609719bSwdenkSubmissions which do not conform to the standards may be returned 5107c609719bSwdenkwith a request to reformat the changes. 5108c609719bSwdenk 5109c609719bSwdenk 5110c609719bSwdenkSubmitting Patches: 5111c609719bSwdenk------------------- 5112c609719bSwdenk 5113c609719bSwdenkSince the number of patches for U-Boot is growing, we need to 5114c609719bSwdenkestablish some rules. Submissions which do not conform to these rules 5115c609719bSwdenkmay be rejected, even when they contain important and valuable stuff. 5116c609719bSwdenk 51170d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details. 5118218ca724SWolfgang Denk 51190668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>; 51200668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot 51210668236bSWolfgang Denk 5122c609719bSwdenkWhen you send a patch, please include the following information with 5123c609719bSwdenkit: 5124c609719bSwdenk 5125c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes 5126c609719bSwdenk this bug. Please try to include a way of demonstrating that the 5127c609719bSwdenk patch actually fixes something. 5128c609719bSwdenk 5129c609719bSwdenk* For new features: a description of the feature and your 5130c609719bSwdenk implementation. 5131c609719bSwdenk 5132c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch) 5133c609719bSwdenk 5134c609719bSwdenk* For major contributions, your entry to the CREDITS file 5135c609719bSwdenk 5136c609719bSwdenk* When you add support for a new board, don't forget to add this 51377ca9296eSWolfgang Denk board to the MAINTAINERS file, too. 5138c609719bSwdenk 5139c609719bSwdenk* If your patch adds new configuration options, don't forget to 5140c609719bSwdenk document these in the README file. 5141c609719bSwdenk 5142218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly* 5143218ca724SWolfgang Denk recommended) you can easily generate the patch using the 51447ca9296eSWolfgang Denk "git format-patch". If you then use "git send-email" to send it to 5145218ca724SWolfgang Denk the U-Boot mailing list, you will avoid most of the common problems 5146218ca724SWolfgang Denk with some other mail clients. 5147c609719bSwdenk 5148218ca724SWolfgang Denk If you cannot use git, use "diff -purN OLD NEW". If your version of 5149218ca724SWolfgang Denk diff does not support these options, then get the latest version of 5150218ca724SWolfgang Denk GNU diff. 51516dff5529Swdenk 5152218ca724SWolfgang Denk The current directory when running this command shall be the parent 5153218ca724SWolfgang Denk directory of the U-Boot source tree (i. e. please make sure that 5154218ca724SWolfgang Denk your patch includes sufficient directory information for the 5155218ca724SWolfgang Denk affected files). 5156218ca724SWolfgang Denk 5157218ca724SWolfgang Denk We prefer patches as plain text. MIME attachments are discouraged, 5158218ca724SWolfgang Denk and compressed attachments must not be used. 5159c609719bSwdenk 516052f52c14Swdenk* If one logical set of modifications affects or creates several 516152f52c14Swdenk files, all these changes shall be submitted in a SINGLE patch file. 516252f52c14Swdenk 516352f52c14Swdenk* Changesets that contain different, unrelated modifications shall be 516452f52c14Swdenk submitted as SEPARATE patches, one patch per changeset. 516552f52c14Swdenk 516652f52c14Swdenk 5167c609719bSwdenkNotes: 5168c609719bSwdenk 5169c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched 5170c609719bSwdenk source tree and make sure that no errors or warnings are reported 5171c609719bSwdenk for any of the boards. 5172c609719bSwdenk 5173c609719bSwdenk* Keep your modifications to the necessary minimum: A patch 5174c609719bSwdenk containing several unrelated changes or arbitrary reformats will be 5175c609719bSwdenk returned with a request to re-formatting / split it. 5176c609719bSwdenk 5177c609719bSwdenk* If you modify existing code, make sure that your new code does not 5178c609719bSwdenk add to the memory footprint of the code ;-) Small is beautiful! 5179c609719bSwdenk When adding new features, these should compile conditionally only 5180c609719bSwdenk (using #ifdef), and the resulting code with the new feature 5181c609719bSwdenk disabled must not need more memory than the old code without your 5182c609719bSwdenk modification. 518390dc6704Swdenk 51840668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the 51850668236bSWolfgang Denk u-boot mailing list. Bigger patches will be moderated. If they are 51860668236bSWolfgang Denk reasonable and not too big, they will be acknowledged. But patches 51870668236bSWolfgang Denk bigger than the size limit should be avoided. 5188