1c609719bSwdenk# 2b75190deSWolfgang Denk# (C) Copyright 2000 - 2012 3c609719bSwdenk# Wolfgang Denk, DENX Software Engineering, wd@denx.de. 4c609719bSwdenk# 5c609719bSwdenk# See file CREDITS for list of people who contributed to this 6c609719bSwdenk# project. 7c609719bSwdenk# 8c609719bSwdenk# This program is free software; you can redistribute it and/or 9c609719bSwdenk# modify it under the terms of the GNU General Public License as 10c609719bSwdenk# published by the Free Software Foundation; either version 2 of 11c609719bSwdenk# the License, or (at your option) any later version. 12c609719bSwdenk# 13c609719bSwdenk# This program is distributed in the hope that it will be useful, 14c609719bSwdenk# but WITHOUT ANY WARRANTY; without even the implied warranty of 15c609719bSwdenk# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16c609719bSwdenk# GNU General Public License for more details. 17c609719bSwdenk# 18c609719bSwdenk# You should have received a copy of the GNU General Public License 19c609719bSwdenk# along with this program; if not, write to the Free Software 20c609719bSwdenk# Foundation, Inc., 59 Temple Place, Suite 330, Boston, 21c609719bSwdenk# MA 02111-1307 USA 22c609719bSwdenk# 23c609719bSwdenk 24c609719bSwdenkSummary: 25c609719bSwdenk======== 26c609719bSwdenk 2724ee89b9SwdenkThis directory contains the source code for U-Boot, a boot loader for 28e86e5a07SwdenkEmbedded boards based on PowerPC, ARM, MIPS and several other 29e86e5a07Swdenkprocessors, which can be installed in a boot ROM and used to 30e86e5a07Swdenkinitialize and test the hardware or to download and run application 31e86e5a07Swdenkcode. 32c609719bSwdenk 33c609719bSwdenkThe development of U-Boot is closely related to Linux: some parts of 3424ee89b9Swdenkthe source code originate in the Linux source tree, we have some 3524ee89b9Swdenkheader files in common, and special provision has been made to 36c609719bSwdenksupport booting of Linux images. 37c609719bSwdenk 38c609719bSwdenkSome attention has been paid to make this software easily 39c609719bSwdenkconfigurable and extendable. For instance, all monitor commands are 40c609719bSwdenkimplemented with the same call interface, so that it's very easy to 41c609719bSwdenkadd new commands. Also, instead of permanently adding rarely used 42c609719bSwdenkcode (for instance hardware test utilities) to the monitor, you can 43c609719bSwdenkload and run it dynamically. 44c609719bSwdenk 45c609719bSwdenk 46c609719bSwdenkStatus: 47c609719bSwdenk======= 48c609719bSwdenk 49c609719bSwdenkIn general, all boards for which a configuration option exists in the 50c609719bSwdenkMakefile have been tested to some extent and can be considered 51c609719bSwdenk"working". In fact, many of them are used in production systems. 52c609719bSwdenk 53c609719bSwdenkIn case of problems see the CHANGELOG and CREDITS files to find out 54218ca724SWolfgang Denkwho contributed the specific port. The MAINTAINERS file lists board 55218ca724SWolfgang Denkmaintainers. 56c609719bSwdenk 57adb9d851SRobert P. J. DayNote: There is no CHANGELOG file in the actual U-Boot source tree; 58adb9d851SRobert P. J. Dayit can be created dynamically from the Git log using: 59adb9d851SRobert P. J. Day 60adb9d851SRobert P. J. Day make CHANGELOG 61adb9d851SRobert P. J. Day 62c609719bSwdenk 63c609719bSwdenkWhere to get help: 64c609719bSwdenk================== 65c609719bSwdenk 66c609719bSwdenkIn case you have questions about, problems with or contributions for 67c609719bSwdenkU-Boot you should send a message to the U-Boot mailing list at 680c32565fSPeter Tyser<u-boot@lists.denx.de>. There is also an archive of previous traffic 690c32565fSPeter Tyseron the mailing list - please search the archive before asking FAQ's. 700c32565fSPeter TyserPlease see http://lists.denx.de/pipermail/u-boot and 710c32565fSPeter Tyserhttp://dir.gmane.org/gmane.comp.boot-loaders.u-boot 72c609719bSwdenk 73c609719bSwdenk 74218ca724SWolfgang DenkWhere to get source code: 75218ca724SWolfgang Denk========================= 76218ca724SWolfgang Denk 77218ca724SWolfgang DenkThe U-Boot source code is maintained in the git repository at 78218ca724SWolfgang Denkgit://www.denx.de/git/u-boot.git ; you can browse it online at 79218ca724SWolfgang Denkhttp://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary 80218ca724SWolfgang Denk 81218ca724SWolfgang DenkThe "snapshot" links on this page allow you to download tarballs of 8211ccc33fSMarcel Ziswilerany version you might be interested in. Official releases are also 83218ca724SWolfgang Denkavailable for FTP download from the ftp://ftp.denx.de/pub/u-boot/ 84218ca724SWolfgang Denkdirectory. 85218ca724SWolfgang Denk 86d4ee711dSAnatolij GustschinPre-built (and tested) images are available from 87218ca724SWolfgang Denkftp://ftp.denx.de/pub/u-boot/images/ 88218ca724SWolfgang Denk 89218ca724SWolfgang Denk 90c609719bSwdenkWhere we come from: 91c609719bSwdenk=================== 92c609719bSwdenk 93c609719bSwdenk- start from 8xxrom sources 9424ee89b9Swdenk- create PPCBoot project (http://sourceforge.net/projects/ppcboot) 95c609719bSwdenk- clean up code 96c609719bSwdenk- make it easier to add custom boards 97c609719bSwdenk- make it possible to add other [PowerPC] CPUs 98c609719bSwdenk- extend functions, especially: 99c609719bSwdenk * Provide extended interface to Linux boot loader 100c609719bSwdenk * S-Record download 101c609719bSwdenk * network boot 10211ccc33fSMarcel Ziswiler * PCMCIA / CompactFlash / ATA disk / SCSI ... boot 10324ee89b9Swdenk- create ARMBoot project (http://sourceforge.net/projects/armboot) 104c609719bSwdenk- add other CPU families (starting with ARM) 10524ee89b9Swdenk- create U-Boot project (http://sourceforge.net/projects/u-boot) 1060d28f34bSMagnus Lilja- current project page: see http://www.denx.de/wiki/U-Boot 10724ee89b9Swdenk 10824ee89b9Swdenk 10924ee89b9SwdenkNames and Spelling: 11024ee89b9Swdenk=================== 11124ee89b9Swdenk 11224ee89b9SwdenkThe "official" name of this project is "Das U-Boot". The spelling 11324ee89b9Swdenk"U-Boot" shall be used in all written text (documentation, comments 11424ee89b9Swdenkin source files etc.). Example: 11524ee89b9Swdenk 11624ee89b9Swdenk This is the README file for the U-Boot project. 11724ee89b9Swdenk 11824ee89b9SwdenkFile names etc. shall be based on the string "u-boot". Examples: 11924ee89b9Swdenk 12024ee89b9Swdenk include/asm-ppc/u-boot.h 12124ee89b9Swdenk 12224ee89b9Swdenk #include <asm/u-boot.h> 12324ee89b9Swdenk 12424ee89b9SwdenkVariable names, preprocessor constants etc. shall be either based on 12524ee89b9Swdenkthe string "u_boot" or on "U_BOOT". Example: 12624ee89b9Swdenk 12724ee89b9Swdenk U_BOOT_VERSION u_boot_logo 12824ee89b9Swdenk IH_OS_U_BOOT u_boot_hush_start 129c609719bSwdenk 130c609719bSwdenk 13193f19cc0SwdenkVersioning: 13293f19cc0Swdenk=========== 13393f19cc0Swdenk 134360d883aSThomas WeberStarting with the release in October 2008, the names of the releases 135360d883aSThomas Weberwere changed from numerical release numbers without deeper meaning 136360d883aSThomas Weberinto a time stamp based numbering. Regular releases are identified by 137360d883aSThomas Webernames consisting of the calendar year and month of the release date. 138360d883aSThomas WeberAdditional fields (if present) indicate release candidates or bug fix 139360d883aSThomas Weberreleases in "stable" maintenance trees. 14093f19cc0Swdenk 141360d883aSThomas WeberExamples: 142360d883aSThomas Weber U-Boot v2009.11 - Release November 2009 143360d883aSThomas Weber U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree 144360d883aSThomas Weber U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release 14593f19cc0Swdenk 14693f19cc0Swdenk 147c609719bSwdenkDirectory Hierarchy: 148c609719bSwdenk==================== 149c609719bSwdenk 1508d321b81SPeter Tyser/arch Architecture specific files 1518d321b81SPeter Tyser /arm Files generic to ARM architecture 1528d321b81SPeter Tyser /cpu CPU specific files 1538d321b81SPeter Tyser /arm720t Files specific to ARM 720 CPUs 1548d321b81SPeter Tyser /arm920t Files specific to ARM 920 CPUs 1556eb0921aSAndreas Bießmann /at91 Files specific to Atmel AT91RM9200 CPU 1568d321b81SPeter Tyser /imx Files specific to Freescale MC9328 i.MX CPUs 1578d321b81SPeter Tyser /s3c24x0 Files specific to Samsung S3C24X0 CPUs 1588d321b81SPeter Tyser /arm925t Files specific to ARM 925 CPUs 1598d321b81SPeter Tyser /arm926ejs Files specific to ARM 926 CPUs 1608d321b81SPeter Tyser /arm1136 Files specific to ARM 1136 CPUs 1618d321b81SPeter Tyser /ixp Files specific to Intel XScale IXP CPUs 1628d321b81SPeter Tyser /pxa Files specific to Intel XScale PXA CPUs 1638d321b81SPeter Tyser /s3c44b0 Files specific to Samsung S3C44B0 CPUs 1648d321b81SPeter Tyser /sa1100 Files specific to Intel StrongARM SA1100 CPUs 1658d321b81SPeter Tyser /lib Architecture specific library files 1668d321b81SPeter Tyser /avr32 Files generic to AVR32 architecture 1678d321b81SPeter Tyser /cpu CPU specific files 1688d321b81SPeter Tyser /lib Architecture specific library files 1698d321b81SPeter Tyser /blackfin Files generic to Analog Devices Blackfin architecture 1708d321b81SPeter Tyser /cpu CPU specific files 1718d321b81SPeter Tyser /lib Architecture specific library files 172fea25720SGraeme Russ /x86 Files generic to x86 architecture 1738d321b81SPeter Tyser /cpu CPU specific files 1748d321b81SPeter Tyser /lib Architecture specific library files 1758d321b81SPeter Tyser /m68k Files generic to m68k architecture 1768d321b81SPeter Tyser /cpu CPU specific files 1778d321b81SPeter Tyser /mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs 1788d321b81SPeter Tyser /mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs 1798d321b81SPeter Tyser /mcf532x Files specific to Freescale ColdFire MCF5329 CPUs 1808d321b81SPeter Tyser /mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs 1818d321b81SPeter Tyser /mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs 1828d321b81SPeter Tyser /lib Architecture specific library files 1838d321b81SPeter Tyser /microblaze Files generic to microblaze architecture 1848d321b81SPeter Tyser /cpu CPU specific files 1858d321b81SPeter Tyser /lib Architecture specific library files 1868d321b81SPeter Tyser /mips Files generic to MIPS architecture 1878d321b81SPeter Tyser /cpu CPU specific files 18892bbd64eSDaniel Schwierzeck /mips32 Files specific to MIPS32 CPUs 18980421fccSXiangfu Liu /xburst Files specific to Ingenic XBurst CPUs 1908d321b81SPeter Tyser /lib Architecture specific library files 191afc1ce82SMacpaul Lin /nds32 Files generic to NDS32 architecture 192afc1ce82SMacpaul Lin /cpu CPU specific files 193afc1ce82SMacpaul Lin /n1213 Files specific to Andes Technology N1213 CPUs 194afc1ce82SMacpaul Lin /lib Architecture specific library files 1958d321b81SPeter Tyser /nios2 Files generic to Altera NIOS2 architecture 1968d321b81SPeter Tyser /cpu CPU specific files 1978d321b81SPeter Tyser /lib Architecture specific library files 198a47a12beSStefan Roese /powerpc Files generic to PowerPC architecture 1998d321b81SPeter Tyser /cpu CPU specific files 2008d321b81SPeter Tyser /74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs 2018d321b81SPeter Tyser /mpc5xx Files specific to Freescale MPC5xx CPUs 2028d321b81SPeter Tyser /mpc5xxx Files specific to Freescale MPC5xxx CPUs 2038d321b81SPeter Tyser /mpc8xx Files specific to Freescale MPC8xx CPUs 2048d321b81SPeter Tyser /mpc824x Files specific to Freescale MPC824x CPUs 2058d321b81SPeter Tyser /mpc8260 Files specific to Freescale MPC8260 CPUs 2068d321b81SPeter Tyser /mpc85xx Files specific to Freescale MPC85xx CPUs 2078d321b81SPeter Tyser /ppc4xx Files specific to AMCC PowerPC 4xx CPUs 2088d321b81SPeter Tyser /lib Architecture specific library files 2098d321b81SPeter Tyser /sh Files generic to SH architecture 2108d321b81SPeter Tyser /cpu CPU specific files 2118d321b81SPeter Tyser /sh2 Files specific to sh2 CPUs 2128d321b81SPeter Tyser /sh3 Files specific to sh3 CPUs 2138d321b81SPeter Tyser /sh4 Files specific to sh4 CPUs 2148d321b81SPeter Tyser /lib Architecture specific library files 2158d321b81SPeter Tyser /sparc Files generic to SPARC architecture 2168d321b81SPeter Tyser /cpu CPU specific files 2178d321b81SPeter Tyser /leon2 Files specific to Gaisler LEON2 SPARC CPU 2188d321b81SPeter Tyser /leon3 Files specific to Gaisler LEON3 SPARC CPU 2198d321b81SPeter Tyser /lib Architecture specific library files 2208d321b81SPeter Tyser/api Machine/arch independent API for external apps 2218d321b81SPeter Tyser/board Board dependent files 2228d321b81SPeter Tyser/common Misc architecture independent functions 2238d321b81SPeter Tyser/disk Code for disk drive partition handling 2248d321b81SPeter Tyser/doc Documentation (don't expect too much) 2258d321b81SPeter Tyser/drivers Commonly used device drivers 2268d321b81SPeter Tyser/examples Example code for standalone applications, etc. 2278d321b81SPeter Tyser/fs Filesystem code (cramfs, ext2, jffs2, etc.) 2288d321b81SPeter Tyser/include Header Files 2298d321b81SPeter Tyser/lib Files generic to all architectures 2308d321b81SPeter Tyser /libfdt Library files to support flattened device trees 2318d321b81SPeter Tyser /lzma Library files to support LZMA decompression 2328d321b81SPeter Tyser /lzo Library files to support LZO decompression 2338d321b81SPeter Tyser/net Networking code 2348d321b81SPeter Tyser/post Power On Self Test 2358d321b81SPeter Tyser/rtc Real Time Clock drivers 2368d321b81SPeter Tyser/tools Tools to build S-Record or U-Boot images, etc. 237c609719bSwdenk 238c609719bSwdenkSoftware Configuration: 239c609719bSwdenk======================= 240c609719bSwdenk 241c609719bSwdenkConfiguration is usually done using C preprocessor defines; the 242c609719bSwdenkrationale behind that is to avoid dead code whenever possible. 243c609719bSwdenk 244c609719bSwdenkThere are two classes of configuration variables: 245c609719bSwdenk 246c609719bSwdenk* Configuration _OPTIONS_: 247c609719bSwdenk These are selectable by the user and have names beginning with 248c609719bSwdenk "CONFIG_". 249c609719bSwdenk 250c609719bSwdenk* Configuration _SETTINGS_: 251c609719bSwdenk These depend on the hardware etc. and should not be meddled with if 252c609719bSwdenk you don't know what you're doing; they have names beginning with 2536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD "CONFIG_SYS_". 254c609719bSwdenk 255c609719bSwdenkLater we will add a configuration tool - probably similar to or even 256c609719bSwdenkidentical to what's used for the Linux kernel. Right now, we have to 257c609719bSwdenkdo the configuration by hand, which means creating some symbolic 258c609719bSwdenklinks and editing some configuration files. We use the TQM8xxL boards 259c609719bSwdenkas an example here. 260c609719bSwdenk 261c609719bSwdenk 262c609719bSwdenkSelection of Processor Architecture and Board Type: 263c609719bSwdenk--------------------------------------------------- 264c609719bSwdenk 265c609719bSwdenkFor all supported boards there are ready-to-use default 266c609719bSwdenkconfigurations available; just type "make <board_name>_config". 267c609719bSwdenk 268c609719bSwdenkExample: For a TQM823L module type: 269c609719bSwdenk 270c609719bSwdenk cd u-boot 271c609719bSwdenk make TQM823L_config 272c609719bSwdenk 27311ccc33fSMarcel ZiswilerFor the Cogent platform, you need to specify the CPU type as well; 274c609719bSwdenke.g. "make cogent_mpc8xx_config". And also configure the cogent 275c609719bSwdenkdirectory according to the instructions in cogent/README. 276c609719bSwdenk 277c609719bSwdenk 278c609719bSwdenkConfiguration Options: 279c609719bSwdenk---------------------- 280c609719bSwdenk 281c609719bSwdenkConfiguration depends on the combination of board and CPU type; all 282c609719bSwdenksuch information is kept in a configuration file 283c609719bSwdenk"include/configs/<board_name>.h". 284c609719bSwdenk 285c609719bSwdenkExample: For a TQM823L module, all configuration settings are in 286c609719bSwdenk"include/configs/TQM823L.h". 287c609719bSwdenk 288c609719bSwdenk 2897f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux 2907f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to 2917f6c2cbcSwdenkbuild a config tool - later. 2927f6c2cbcSwdenk 2937f6c2cbcSwdenk 294c609719bSwdenkThe following options need to be configured: 295c609719bSwdenk 2962628114eSKim Phillips- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX. 297c609719bSwdenk 2982628114eSKim Phillips- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS. 2996ccec449SWolfgang Denk 3006ccec449SWolfgang Denk- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined) 30109ea0de0SHaavard Skinnemoen Define exactly one, e.g. CONFIG_ATSTK1002 302c609719bSwdenk 303c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined) 304c609719bSwdenk Define exactly one of 305c609719bSwdenk CONFIG_CMA286_60_OLD 306c609719bSwdenk--- FIXME --- not tested yet: 307c609719bSwdenk CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P, 308c609719bSwdenk CONFIG_CMA287_23, CONFIG_CMA287_50 309c609719bSwdenk 310c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined) 311c609719bSwdenk Define exactly one of 312c609719bSwdenk CONFIG_CMA101, CONFIG_CMA102 313c609719bSwdenk 314c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined) 315c609719bSwdenk Define one or more of 316c609719bSwdenk CONFIG_CMA302 317c609719bSwdenk 318c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined) 319c609719bSwdenk Define one or more of 320c609719bSwdenk CONFIG_LCD_HEARTBEAT - update a character position on 32111ccc33fSMarcel Ziswiler the LCD display every second with 322c609719bSwdenk a "rotator" |\-/|\-/ 323c609719bSwdenk 3242535d602Swdenk- Board flavour: (if CONFIG_MPC8260ADS is defined) 3252535d602Swdenk CONFIG_ADSTYPE 3262535d602Swdenk Possible values are: 3276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8260ADS - original MPC8260ADS 3286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8266ADS - MPC8266ADS 3296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR 3306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8272ADS - MPC8272ADS 3312535d602Swdenk 332cf946c6dSLei Wen- Marvell Family Member 333cf946c6dSLei Wen CONFIG_SYS_MVFS - define it if you want to enable 334cf946c6dSLei Wen multiple fs option at one time 335cf946c6dSLei Wen for marvell soc family 336cf946c6dSLei Wen 337c609719bSwdenk- MPC824X Family Member (if CONFIG_MPC824X is defined) 338c609719bSwdenk Define exactly one of 339c609719bSwdenk CONFIG_MPC8240, CONFIG_MPC8245 340c609719bSwdenk 34111ccc33fSMarcel Ziswiler- 8xx CPU Options: (if using an MPC8xx CPU) 34266ca92a5Swdenk CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if 34366ca92a5Swdenk get_gclk_freq() cannot work 3445da627a4Swdenk e.g. if there is no 32KHz 3455da627a4Swdenk reference PIT/RTC clock 34666ca92a5Swdenk CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK 34766ca92a5Swdenk or XTAL/EXTAL) 348c609719bSwdenk 34966ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU): 3506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8xx_CPUCLK_MIN 3516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8xx_CPUCLK_MAX 35266ca92a5Swdenk CONFIG_8xx_CPUCLK_DEFAULT 35375d1ea7fSwdenk See doc/README.MPC866 35475d1ea7fSwdenk 3556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MEASURE_CPUCLK 35675d1ea7fSwdenk 35775d1ea7fSwdenk Define this to measure the actual CPU clock instead 35875d1ea7fSwdenk of relying on the correctness of the configured 35975d1ea7fSwdenk values. Mostly useful for board bringup to make sure 36075d1ea7fSwdenk the PLL is locked at the intended frequency. Note 36175d1ea7fSwdenk that this requires a (stable) reference clock (32 kHz 3626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD RTC clock or CONFIG_SYS_8XX_XIN) 36375d1ea7fSwdenk 364506f3918SHeiko Schocher CONFIG_SYS_DELAYED_ICACHE 365506f3918SHeiko Schocher 366506f3918SHeiko Schocher Define this option if you want to enable the 367506f3918SHeiko Schocher ICache only when Code runs from RAM. 368506f3918SHeiko Schocher 36966412c63SKumar Gala- 85xx CPU Options: 370ffd06e02SYork Sun CONFIG_SYS_PPC64 371ffd06e02SYork Sun 372ffd06e02SYork Sun Specifies that the core is a 64-bit PowerPC implementation (implements 373ffd06e02SYork Sun the "64" category of the Power ISA). This is necessary for ePAPR 374ffd06e02SYork Sun compliance, among other possible reasons. 375ffd06e02SYork Sun 37666412c63SKumar Gala CONFIG_SYS_FSL_TBCLK_DIV 37766412c63SKumar Gala 37866412c63SKumar Gala Defines the core time base clock divider ratio compared to the 37966412c63SKumar Gala system clock. On most PQ3 devices this is 8, on newer QorIQ 38066412c63SKumar Gala devices it can be 16 or 32. The ratio varies from SoC to Soc. 38166412c63SKumar Gala 3828f29084aSKumar Gala CONFIG_SYS_FSL_PCIE_COMPAT 3838f29084aSKumar Gala 3848f29084aSKumar Gala Defines the string to utilize when trying to match PCIe device 3858f29084aSKumar Gala tree nodes for the given platform. 3868f29084aSKumar Gala 387afa6b551SPrabhakar Kushwaha CONFIG_SYS_PPC_E500_DEBUG_TLB 388afa6b551SPrabhakar Kushwaha 389afa6b551SPrabhakar Kushwaha Enables a temporary TLB entry to be used during boot to work 390afa6b551SPrabhakar Kushwaha around limitations in e500v1 and e500v2 external debugger 391afa6b551SPrabhakar Kushwaha support. This reduces the portions of the boot code where 392afa6b551SPrabhakar Kushwaha breakpoints and single stepping do not work. The value of this 393afa6b551SPrabhakar Kushwaha symbol should be set to the TLB1 entry to be used for this 394afa6b551SPrabhakar Kushwaha purpose. 395afa6b551SPrabhakar Kushwaha 39633eee330SScott Wood CONFIG_SYS_FSL_ERRATUM_A004510 39733eee330SScott Wood 39833eee330SScott Wood Enables a workaround for erratum A004510. If set, 39933eee330SScott Wood then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and 40033eee330SScott Wood CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set. 40133eee330SScott Wood 40233eee330SScott Wood CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV 40333eee330SScott Wood CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional) 40433eee330SScott Wood 40533eee330SScott Wood Defines one or two SoC revisions (low 8 bits of SVR) 40633eee330SScott Wood for which the A004510 workaround should be applied. 40733eee330SScott Wood 40833eee330SScott Wood The rest of SVR is either not relevant to the decision 40933eee330SScott Wood of whether the erratum is present (e.g. p2040 versus 41033eee330SScott Wood p2041) or is implied by the build target, which controls 41133eee330SScott Wood whether CONFIG_SYS_FSL_ERRATUM_A004510 is set. 41233eee330SScott Wood 41333eee330SScott Wood See Freescale App Note 4493 for more information about 41433eee330SScott Wood this erratum. 41533eee330SScott Wood 41674fa22edSPrabhakar Kushwaha CONFIG_A003399_NOR_WORKAROUND 41774fa22edSPrabhakar Kushwaha Enables a workaround for IFC erratum A003399. It is only 41874fa22edSPrabhakar Kushwaha requred during NOR boot. 41974fa22edSPrabhakar Kushwaha 42033eee330SScott Wood CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY 42133eee330SScott Wood 42233eee330SScott Wood This is the value to write into CCSR offset 0x18600 42333eee330SScott Wood according to the A004510 workaround. 42433eee330SScott Wood 425765b0bdbSPriyanka Jain CONFIG_SYS_FSL_DSP_M2_RAM_ADDR 426765b0bdbSPriyanka Jain This value denotes start offset of M2 memory 427765b0bdbSPriyanka Jain which is directly connected to the DSP core. 428765b0bdbSPriyanka Jain 429765b0bdbSPriyanka Jain CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT 430765b0bdbSPriyanka Jain This value denotes start offset of DSP CCSR space. 431765b0bdbSPriyanka Jain 4326cb461b4SDaniel Schwierzeck- Generic CPU options: 4336cb461b4SDaniel Schwierzeck CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN 4346cb461b4SDaniel Schwierzeck 4356cb461b4SDaniel Schwierzeck Defines the endianess of the CPU. Implementation of those 4366cb461b4SDaniel Schwierzeck values is arch specific. 4376cb461b4SDaniel Schwierzeck 4380b953ffcSMarkus Klotzbuecher- Intel Monahans options: 4396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO 4400b953ffcSMarkus Klotzbuecher 4410b953ffcSMarkus Klotzbuecher Defines the Monahans run mode to oscillator 4420b953ffcSMarkus Klotzbuecher ratio. Valid values are 8, 16, 24, 31. The core 4430b953ffcSMarkus Klotzbuecher frequency is this value multiplied by 13 MHz. 4440b953ffcSMarkus Klotzbuecher 4456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO 4460b953ffcSMarkus Klotzbuecher 4470b953ffcSMarkus Klotzbuecher Defines the Monahans turbo mode to oscillator 4480b953ffcSMarkus Klotzbuecher ratio. Valid values are 1 (default if undefined) and 4490b953ffcSMarkus Klotzbuecher 2. The core frequency as calculated above is multiplied 4500b953ffcSMarkus Klotzbuecher by this value. 4510b953ffcSMarkus Klotzbuecher 45292bbd64eSDaniel Schwierzeck- MIPS CPU options: 45392bbd64eSDaniel Schwierzeck CONFIG_SYS_INIT_SP_OFFSET 45492bbd64eSDaniel Schwierzeck 45592bbd64eSDaniel Schwierzeck Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack 45692bbd64eSDaniel Schwierzeck pointer. This is needed for the temporary stack before 45792bbd64eSDaniel Schwierzeck relocation. 45892bbd64eSDaniel Schwierzeck 45992bbd64eSDaniel Schwierzeck CONFIG_SYS_MIPS_CACHE_MODE 46092bbd64eSDaniel Schwierzeck 46192bbd64eSDaniel Schwierzeck Cache operation mode for the MIPS CPU. 46292bbd64eSDaniel Schwierzeck See also arch/mips/include/asm/mipsregs.h. 46392bbd64eSDaniel Schwierzeck Possible values are: 46492bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_NO_WA 46592bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_WA 46692bbd64eSDaniel Schwierzeck CONF_CM_UNCACHED 46792bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_NONCOHERENT 46892bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_CE 46992bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_COW 47092bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_CUW 47192bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_ACCELERATED 47292bbd64eSDaniel Schwierzeck 47392bbd64eSDaniel Schwierzeck CONFIG_SYS_XWAY_EBU_BOOTCFG 47492bbd64eSDaniel Schwierzeck 47592bbd64eSDaniel Schwierzeck Special option for Lantiq XWAY SoCs for booting from NOR flash. 47692bbd64eSDaniel Schwierzeck See also arch/mips/cpu/mips32/start.S. 47792bbd64eSDaniel Schwierzeck 47892bbd64eSDaniel Schwierzeck CONFIG_XWAY_SWAP_BYTES 47992bbd64eSDaniel Schwierzeck 48092bbd64eSDaniel Schwierzeck Enable compilation of tools/xway-swap-bytes needed for Lantiq 48192bbd64eSDaniel Schwierzeck XWAY SoCs for booting from NOR flash. The U-Boot image needs to 48292bbd64eSDaniel Schwierzeck be swapped if a flash programmer is used. 48392bbd64eSDaniel Schwierzeck 484b67d8816SChristian Riesch- ARM options: 485b67d8816SChristian Riesch CONFIG_SYS_EXCEPTION_VECTORS_HIGH 486b67d8816SChristian Riesch 487b67d8816SChristian Riesch Select high exception vectors of the ARM core, e.g., do not 488b67d8816SChristian Riesch clear the V bit of the c1 register of CP15. 489b67d8816SChristian Riesch 4905356f545SAneesh V CONFIG_SYS_THUMB_BUILD 4915356f545SAneesh V 4925356f545SAneesh V Use this flag to build U-Boot using the Thumb instruction 4935356f545SAneesh V set for ARM architectures. Thumb instruction set provides 4945356f545SAneesh V better code density. For ARM architectures that support 4955356f545SAneesh V Thumb2 this flag will result in Thumb2 code generated by 4965356f545SAneesh V GCC. 4975356f545SAneesh V 498c5d4752cSStephen Warren CONFIG_ARM_ERRATA_716044 4990678587fSStephen Warren CONFIG_ARM_ERRATA_742230 5000678587fSStephen Warren CONFIG_ARM_ERRATA_743622 5010678587fSStephen Warren CONFIG_ARM_ERRATA_751472 5020678587fSStephen Warren 5030678587fSStephen Warren If set, the workarounds for these ARM errata are applied early 5040678587fSStephen Warren during U-Boot startup. Note that these options force the 5050678587fSStephen Warren workarounds to be applied; no CPU-type/version detection 5060678587fSStephen Warren exists, unlike the similar options in the Linux kernel. Do not 5070678587fSStephen Warren set these options unless they apply! 5080678587fSStephen Warren 509795659dcSStephen Warren- CPU timer options: 510795659dcSStephen Warren CONFIG_SYS_HZ 511795659dcSStephen Warren 512795659dcSStephen Warren The frequency of the timer returned by get_timer(). 513795659dcSStephen Warren get_timer() must operate in milliseconds and this CONFIG 514795659dcSStephen Warren option must be set to 1000. 515795659dcSStephen Warren 5165da627a4Swdenk- Linux Kernel Interface: 517c609719bSwdenk CONFIG_CLOCKS_IN_MHZ 518c609719bSwdenk 519c609719bSwdenk U-Boot stores all clock information in Hz 520c609719bSwdenk internally. For binary compatibility with older Linux 521c609719bSwdenk kernels (which expect the clocks passed in the 522c609719bSwdenk bd_info data to be in MHz) the environment variable 523c609719bSwdenk "clocks_in_mhz" can be defined so that U-Boot 524c609719bSwdenk converts clock data to MHZ before passing it to the 525c609719bSwdenk Linux kernel. 526c609719bSwdenk When CONFIG_CLOCKS_IN_MHZ is defined, a definition of 527c609719bSwdenk "clocks_in_mhz=1" is automatically included in the 528c609719bSwdenk default environment. 529c609719bSwdenk 5305da627a4Swdenk CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only] 5315da627a4Swdenk 53211ccc33fSMarcel Ziswiler When transferring memsize parameter to linux, some versions 5335da627a4Swdenk expect it to be in bytes, others in MB. 5345da627a4Swdenk Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes. 5355da627a4Swdenk 536fec6d9eeSGerald Van Baren CONFIG_OF_LIBFDT 537f57f70aaSWolfgang Denk 538f57f70aaSWolfgang Denk New kernel versions are expecting firmware settings to be 539213bf8c8SGerald Van Baren passed using flattened device trees (based on open firmware 540213bf8c8SGerald Van Baren concepts). 541213bf8c8SGerald Van Baren 542213bf8c8SGerald Van Baren CONFIG_OF_LIBFDT 543213bf8c8SGerald Van Baren * New libfdt-based support 544213bf8c8SGerald Van Baren * Adds the "fdt" command 5453bb342fcSKim Phillips * The bootm command automatically updates the fdt 546213bf8c8SGerald Van Baren 547b55ae402SMarcel Ziswiler OF_CPU - The proper name of the cpus node (only required for 548b55ae402SMarcel Ziswiler MPC512X and MPC5xxx based boards). 549b55ae402SMarcel Ziswiler OF_SOC - The proper name of the soc node (only required for 550b55ae402SMarcel Ziswiler MPC512X and MPC5xxx based boards). 551f57f70aaSWolfgang Denk OF_TBCLK - The timebase frequency. 552c2871f03SKumar Gala OF_STDOUT_PATH - The path to the console device 553f57f70aaSWolfgang Denk 55411ccc33fSMarcel Ziswiler boards with QUICC Engines require OF_QE to set UCC MAC 55511ccc33fSMarcel Ziswiler addresses 5563bb342fcSKim Phillips 5574e253137SKumar Gala CONFIG_OF_BOARD_SETUP 5584e253137SKumar Gala 5594e253137SKumar Gala Board code has addition modification that it wants to make 5604e253137SKumar Gala to the flat device tree before handing it off to the kernel 5616705d81eSwdenk 5620267768eSMatthew McClintock CONFIG_OF_BOOT_CPU 5630267768eSMatthew McClintock 56411ccc33fSMarcel Ziswiler This define fills in the correct boot CPU in the boot 5650267768eSMatthew McClintock param header, the default value is zero if undefined. 5660267768eSMatthew McClintock 5673887c3fbSHeiko Schocher CONFIG_OF_IDE_FIXUP 5683887c3fbSHeiko Schocher 5693887c3fbSHeiko Schocher U-Boot can detect if an IDE device is present or not. 5703887c3fbSHeiko Schocher If not, and this new config option is activated, U-Boot 5713887c3fbSHeiko Schocher removes the ATA node from the DTS before booting Linux, 5723887c3fbSHeiko Schocher so the Linux IDE driver does not probe the device and 5733887c3fbSHeiko Schocher crash. This is needed for buggy hardware (uc101) where 5743887c3fbSHeiko Schocher no pull down resistor is connected to the signal IDE5V_DD7. 5753887c3fbSHeiko Schocher 5767eb29398SIgor Grinberg CONFIG_MACH_TYPE [relevant for ARM only][mandatory] 5777eb29398SIgor Grinberg 5787eb29398SIgor Grinberg This setting is mandatory for all boards that have only one 5797eb29398SIgor Grinberg machine type and must be used to specify the machine type 5807eb29398SIgor Grinberg number as it appears in the ARM machine registry 5817eb29398SIgor Grinberg (see http://www.arm.linux.org.uk/developer/machines/). 5827eb29398SIgor Grinberg Only boards that have multiple machine types supported 5837eb29398SIgor Grinberg in a single configuration file and the machine type is 5847eb29398SIgor Grinberg runtime discoverable, do not have to use this setting. 5857eb29398SIgor Grinberg 5860b2f4ecaSNiklaus Giger- vxWorks boot parameters: 5870b2f4ecaSNiklaus Giger 5880b2f4ecaSNiklaus Giger bootvx constructs a valid bootline using the following 5890b2f4ecaSNiklaus Giger environments variables: bootfile, ipaddr, serverip, hostname. 5900b2f4ecaSNiklaus Giger It loads the vxWorks image pointed bootfile. 5910b2f4ecaSNiklaus Giger 5920b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name 5930b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address 5940b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server 5950b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters 5960b2f4ecaSNiklaus Giger 5970b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_ADD_PARAMS 5980b2f4ecaSNiklaus Giger 5990b2f4ecaSNiklaus Giger Add it at the end of the bootline. E.g "u=username pw=secret" 6000b2f4ecaSNiklaus Giger 6010b2f4ecaSNiklaus Giger Note: If a "bootargs" environment is defined, it will overwride 6020b2f4ecaSNiklaus Giger the defaults discussed just above. 6030b2f4ecaSNiklaus Giger 6042c451f78SAneesh V- Cache Configuration: 6052c451f78SAneesh V CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot 6062c451f78SAneesh V CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot 6072c451f78SAneesh V CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot 6082c451f78SAneesh V 60993bc2193SAneesh V- Cache Configuration for ARM: 61093bc2193SAneesh V CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache 61193bc2193SAneesh V controller 61293bc2193SAneesh V CONFIG_SYS_PL310_BASE - Physical base address of PL310 61393bc2193SAneesh V controller register space 61493bc2193SAneesh V 6156705d81eSwdenk- Serial Ports: 61648d0192fSAndreas Engel CONFIG_PL010_SERIAL 6176705d81eSwdenk 6186705d81eSwdenk Define this if you want support for Amba PrimeCell PL010 UARTs. 6196705d81eSwdenk 62048d0192fSAndreas Engel CONFIG_PL011_SERIAL 6216705d81eSwdenk 6226705d81eSwdenk Define this if you want support for Amba PrimeCell PL011 UARTs. 6236705d81eSwdenk 6246705d81eSwdenk CONFIG_PL011_CLOCK 6256705d81eSwdenk 6266705d81eSwdenk If you have Amba PrimeCell PL011 UARTs, set this variable to 6276705d81eSwdenk the clock speed of the UARTs. 6286705d81eSwdenk 6296705d81eSwdenk CONFIG_PL01x_PORTS 6306705d81eSwdenk 6316705d81eSwdenk If you have Amba PrimeCell PL010 or PL011 UARTs on your board, 6326705d81eSwdenk define this to a list of base addresses for each (supported) 6336705d81eSwdenk port. See e.g. include/configs/versatile.h 6346705d81eSwdenk 635910f1ae3SJohn Rigby CONFIG_PL011_SERIAL_RLCR 636910f1ae3SJohn Rigby 637910f1ae3SJohn Rigby Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500) 638910f1ae3SJohn Rigby have separate receive and transmit line control registers. Set 639910f1ae3SJohn Rigby this variable to initialize the extra register. 640910f1ae3SJohn Rigby 641910f1ae3SJohn Rigby CONFIG_PL011_SERIAL_FLUSH_ON_INIT 642910f1ae3SJohn Rigby 643910f1ae3SJohn Rigby On some platforms (e.g. U8500) U-Boot is loaded by a second stage 644910f1ae3SJohn Rigby boot loader that has already initialized the UART. Define this 645910f1ae3SJohn Rigby variable to flush the UART at init time. 646910f1ae3SJohn Rigby 6476705d81eSwdenk 648c609719bSwdenk- Console Interface: 649c609719bSwdenk Depending on board, define exactly one serial port 650c609719bSwdenk (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2, 651c609719bSwdenk CONFIG_8xx_CONS_SCC1, ...), or switch off the serial 652c609719bSwdenk console by defining CONFIG_8xx_CONS_NONE 653c609719bSwdenk 654c609719bSwdenk Note: if CONFIG_8xx_CONS_NONE is defined, the serial 655c609719bSwdenk port routines must be defined elsewhere 656c609719bSwdenk (i.e. serial_init(), serial_getc(), ...) 657c609719bSwdenk 658c609719bSwdenk CONFIG_CFB_CONSOLE 659c609719bSwdenk Enables console device for a color framebuffer. Needs following 660c53043b7SWolfgang Denk defines (cf. smiLynxEM, i8042) 661c609719bSwdenk VIDEO_FB_LITTLE_ENDIAN graphic memory organisation 662c609719bSwdenk (default big endian) 663c609719bSwdenk VIDEO_HW_RECTFILL graphic chip supports 664c609719bSwdenk rectangle fill 665c609719bSwdenk (cf. smiLynxEM) 666c609719bSwdenk VIDEO_HW_BITBLT graphic chip supports 667c609719bSwdenk bit-blit (cf. smiLynxEM) 668c609719bSwdenk VIDEO_VISIBLE_COLS visible pixel columns 669c609719bSwdenk (cols=pitch) 670c609719bSwdenk VIDEO_VISIBLE_ROWS visible pixel rows 671c609719bSwdenk VIDEO_PIXEL_SIZE bytes per pixel 672c609719bSwdenk VIDEO_DATA_FORMAT graphic data format 673c609719bSwdenk (0-5, cf. cfb_console.c) 674c609719bSwdenk VIDEO_FB_ADRS framebuffer address 675c609719bSwdenk VIDEO_KBD_INIT_FCT keyboard int fct 676c609719bSwdenk (i.e. i8042_kbd_init()) 677c609719bSwdenk VIDEO_TSTC_FCT test char fct 678c609719bSwdenk (i.e. i8042_tstc) 679c609719bSwdenk VIDEO_GETC_FCT get char fct 680c609719bSwdenk (i.e. i8042_getc) 681c609719bSwdenk CONFIG_CONSOLE_CURSOR cursor drawing on/off 682c609719bSwdenk (requires blink timer 683c609719bSwdenk cf. i8042.c) 6846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c) 685c609719bSwdenk CONFIG_CONSOLE_TIME display time/date info in 686c609719bSwdenk upper right corner 687602ad3b3SJon Loeliger (requires CONFIG_CMD_DATE) 688c609719bSwdenk CONFIG_VIDEO_LOGO display Linux logo in 689c609719bSwdenk upper left corner 690a6c7ad2fSwdenk CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of 691a6c7ad2fSwdenk linux_logo.h for logo. 692a6c7ad2fSwdenk Requires CONFIG_VIDEO_LOGO 693c609719bSwdenk CONFIG_CONSOLE_EXTRA_INFO 69411ccc33fSMarcel Ziswiler additional board info beside 695c609719bSwdenk the logo 696c609719bSwdenk 69733a35bbbSPali Rohár When CONFIG_CFB_CONSOLE_ANSI is defined, console will support 69833a35bbbSPali Rohár a limited number of ANSI escape sequences (cursor control, 69933a35bbbSPali Rohár erase functions and limited graphics rendition control). 70033a35bbbSPali Rohár 701c609719bSwdenk When CONFIG_CFB_CONSOLE is defined, video console is 702c609719bSwdenk default i/o. Serial console can be forced with 703c609719bSwdenk environment 'console=serial'. 704c609719bSwdenk 705a3ad8e26Swdenk When CONFIG_SILENT_CONSOLE is defined, all console 706a3ad8e26Swdenk messages (by U-Boot and Linux!) can be silenced with 707a3ad8e26Swdenk the "silent" environment variable. See 708a3ad8e26Swdenk doc/README.silent for more information. 709a3ad8e26Swdenk 710c609719bSwdenk- Console Baudrate: 711c609719bSwdenk CONFIG_BAUDRATE - in bps 712c609719bSwdenk Select one of the baudrates listed in 7136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BAUDRATE_TABLE, see below. 7146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale 715c609719bSwdenk 716c92fac91SHeiko Schocher- Console Rx buffer length 717c92fac91SHeiko Schocher With CONFIG_SYS_SMC_RXBUFLEN it is possible to define 718c92fac91SHeiko Schocher the maximum receive buffer length for the SMC. 7192b3f12c2SHeiko Schocher This option is actual only for 82xx and 8xx possible. 720c92fac91SHeiko Schocher If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE 721c92fac91SHeiko Schocher must be defined, to setup the maximum idle timeout for 722c92fac91SHeiko Schocher the SMC. 723c92fac91SHeiko Schocher 7249558b48aSGraeme Russ- Pre-Console Buffer: 7259558b48aSGraeme Russ Prior to the console being initialised (i.e. serial UART 7269558b48aSGraeme Russ initialised etc) all console output is silently discarded. 7279558b48aSGraeme Russ Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to 7289558b48aSGraeme Russ buffer any console messages prior to the console being 7299558b48aSGraeme Russ initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ 7309558b48aSGraeme Russ bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is 7319558b48aSGraeme Russ a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ 7329558b48aSGraeme Russ bytes are output before the console is initialised, the 7339558b48aSGraeme Russ earlier bytes are discarded. 7349558b48aSGraeme Russ 7359558b48aSGraeme Russ 'Sane' compilers will generate smaller code if 7369558b48aSGraeme Russ CONFIG_PRE_CON_BUF_SZ is a power of 2 7379558b48aSGraeme Russ 738046a37bdSSonny Rao- Safe printf() functions 739046a37bdSSonny Rao Define CONFIG_SYS_VSNPRINTF to compile in safe versions of 740046a37bdSSonny Rao the printf() functions. These are defined in 741046a37bdSSonny Rao include/vsprintf.h and include snprintf(), vsnprintf() and 742046a37bdSSonny Rao so on. Code size increase is approximately 300-500 bytes. 743046a37bdSSonny Rao If this option is not given then these functions will 744046a37bdSSonny Rao silently discard their buffer size argument - this means 745046a37bdSSonny Rao you are not getting any overflow checking in this case. 746046a37bdSSonny Rao 747c609719bSwdenk- Boot Delay: CONFIG_BOOTDELAY - in seconds 748c609719bSwdenk Delay before automatically booting the default image; 749c609719bSwdenk set to -1 to disable autoboot. 75093d7212fSJoe Hershberger set to -2 to autoboot with no delay and not check for abort 75193d7212fSJoe Hershberger (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined). 752c609719bSwdenk 753c609719bSwdenk See doc/README.autoboot for these options that 754c609719bSwdenk work with CONFIG_BOOTDELAY. None are required. 755c609719bSwdenk CONFIG_BOOT_RETRY_TIME 756c609719bSwdenk CONFIG_BOOT_RETRY_MIN 757c609719bSwdenk CONFIG_AUTOBOOT_KEYED 758c609719bSwdenk CONFIG_AUTOBOOT_PROMPT 759c609719bSwdenk CONFIG_AUTOBOOT_DELAY_STR 760c609719bSwdenk CONFIG_AUTOBOOT_STOP_STR 761c609719bSwdenk CONFIG_AUTOBOOT_DELAY_STR2 762c609719bSwdenk CONFIG_AUTOBOOT_STOP_STR2 763c609719bSwdenk CONFIG_ZERO_BOOTDELAY_CHECK 764c609719bSwdenk CONFIG_RESET_TO_RETRY 765c609719bSwdenk 766c609719bSwdenk- Autoboot Command: 767c609719bSwdenk CONFIG_BOOTCOMMAND 768c609719bSwdenk Only needed when CONFIG_BOOTDELAY is enabled; 769c609719bSwdenk define a command string that is automatically executed 770c609719bSwdenk when no character is read on the console interface 771c609719bSwdenk within "Boot Delay" after reset. 772c609719bSwdenk 773c609719bSwdenk CONFIG_BOOTARGS 774c609719bSwdenk This can be used to pass arguments to the bootm 775c609719bSwdenk command. The value of CONFIG_BOOTARGS goes into the 776c609719bSwdenk environment value "bootargs". 777c609719bSwdenk 778c609719bSwdenk CONFIG_RAMBOOT and CONFIG_NFSBOOT 779c609719bSwdenk The value of these goes into the environment as 780c609719bSwdenk "ramboot" and "nfsboot" respectively, and can be used 781c609719bSwdenk as a convenience, when switching between booting from 78211ccc33fSMarcel Ziswiler RAM and NFS. 783c609719bSwdenk 784c609719bSwdenk- Pre-Boot Commands: 785c609719bSwdenk CONFIG_PREBOOT 786c609719bSwdenk 787c609719bSwdenk When this option is #defined, the existence of the 788c609719bSwdenk environment variable "preboot" will be checked 789c609719bSwdenk immediately before starting the CONFIG_BOOTDELAY 790c609719bSwdenk countdown and/or running the auto-boot command resp. 791c609719bSwdenk entering interactive mode. 792c609719bSwdenk 793c609719bSwdenk This feature is especially useful when "preboot" is 794c609719bSwdenk automatically generated or modified. For an example 795c609719bSwdenk see the LWMON board specific code: here "preboot" is 796c609719bSwdenk modified when the user holds down a certain 797c609719bSwdenk combination of keys on the (special) keyboard when 798c609719bSwdenk booting the systems 799c609719bSwdenk 800c609719bSwdenk- Serial Download Echo Mode: 801c609719bSwdenk CONFIG_LOADS_ECHO 802c609719bSwdenk If defined to 1, all characters received during a 803c609719bSwdenk serial download (using the "loads" command) are 804c609719bSwdenk echoed back. This might be needed by some terminal 805c609719bSwdenk emulations (like "cu"), but may as well just take 806c609719bSwdenk time on others. This setting #define's the initial 807c609719bSwdenk value of the "loads_echo" environment variable. 808c609719bSwdenk 809602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined) 810c609719bSwdenk CONFIG_KGDB_BAUDRATE 811c609719bSwdenk Select one of the baudrates listed in 8126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BAUDRATE_TABLE, see below. 813c609719bSwdenk 814c609719bSwdenk- Monitor Functions: 815602ad3b3SJon Loeliger Monitor commands can be included or excluded 816602ad3b3SJon Loeliger from the build by using the #include files 817c6c621bdSStephen Warren <config_cmd_all.h> and #undef'ing unwanted 818c6c621bdSStephen Warren commands, or using <config_cmd_default.h> 819602ad3b3SJon Loeliger and augmenting with additional #define's 820602ad3b3SJon Loeliger for wanted commands. 821c609719bSwdenk 822602ad3b3SJon Loeliger The default command configuration includes all commands 823602ad3b3SJon Loeliger except those marked below with a "*". 824602ad3b3SJon Loeliger 825602ad3b3SJon Loeliger CONFIG_CMD_ASKENV * ask for env variable 826602ad3b3SJon Loeliger CONFIG_CMD_BDI bdinfo 827602ad3b3SJon Loeliger CONFIG_CMD_BEDBUG * Include BedBug Debugger 828602ad3b3SJon Loeliger CONFIG_CMD_BMP * BMP support 829602ad3b3SJon Loeliger CONFIG_CMD_BSP * Board specific commands 830602ad3b3SJon Loeliger CONFIG_CMD_BOOTD bootd 831602ad3b3SJon Loeliger CONFIG_CMD_CACHE * icache, dcache 832602ad3b3SJon Loeliger CONFIG_CMD_CONSOLE coninfo 833710b9938SMike Frysinger CONFIG_CMD_CRC32 * crc32 834602ad3b3SJon Loeliger CONFIG_CMD_DATE * support for RTC, date/time... 835602ad3b3SJon Loeliger CONFIG_CMD_DHCP * DHCP support 836602ad3b3SJon Loeliger CONFIG_CMD_DIAG * Diagnostics 837a7c93104SPeter Tyser CONFIG_CMD_DS4510 * ds4510 I2C gpio commands 838a7c93104SPeter Tyser CONFIG_CMD_DS4510_INFO * ds4510 I2C info command 839a7c93104SPeter Tyser CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd 840a7c93104SPeter Tyser CONFIG_CMD_DS4510_RST * ds4510 I2C rst command 841602ad3b3SJon Loeliger CONFIG_CMD_DTT * Digital Therm and Thermostat 842602ad3b3SJon Loeliger CONFIG_CMD_ECHO echo arguments 843246c6922SPeter Tyser CONFIG_CMD_EDITENV edit env variable 844602ad3b3SJon Loeliger CONFIG_CMD_EEPROM * EEPROM read/write support 845602ad3b3SJon Loeliger CONFIG_CMD_ELF * bootelf, bootvx 8465e2b3e0cSJoe Hershberger CONFIG_CMD_ENV_CALLBACK * display details about env callbacks 847fffad71bSJoe Hershberger CONFIG_CMD_ENV_FLAGS * display details about env flags 8480c79cda0SMike Frysinger CONFIG_CMD_EXPORTENV * export the environment 84903e2ecf6SStephen Warren CONFIG_CMD_EXT2 * ext2 command support 85003e2ecf6SStephen Warren CONFIG_CMD_EXT4 * ext4 command support 851bdab39d3SMike Frysinger CONFIG_CMD_SAVEENV saveenv 852602ad3b3SJon Loeliger CONFIG_CMD_FDC * Floppy Disk Support 85303e2ecf6SStephen Warren CONFIG_CMD_FAT * FAT command support 854602ad3b3SJon Loeliger CONFIG_CMD_FDOS * Dos diskette Support 855602ad3b3SJon Loeliger CONFIG_CMD_FLASH flinfo, erase, protect 856602ad3b3SJon Loeliger CONFIG_CMD_FPGA FPGA device initialization support 8574d98b5c8SVincent Stehlé CONFIG_CMD_FUSE * Device fuse support 85853fdc7efSAnton Staaf CONFIG_CMD_GETTIME * Get time since boot 859a641b979SMike Frysinger CONFIG_CMD_GO * the 'go' command (exec code) 860a000b795SKim Phillips CONFIG_CMD_GREPENV * search environment 861bf36c5d5SSimon Glass CONFIG_CMD_HASH * calculate hash / digest 862602ad3b3SJon Loeliger CONFIG_CMD_HWFLOW * RTS/CTS hw flow control 863602ad3b3SJon Loeliger CONFIG_CMD_I2C * I2C serial bus support 864602ad3b3SJon Loeliger CONFIG_CMD_IDE * IDE harddisk support 865602ad3b3SJon Loeliger CONFIG_CMD_IMI iminfo 8668fdf1e0fSVipin Kumar CONFIG_CMD_IMLS List all images found in NOR flash 8674d98b5c8SVincent Stehlé CONFIG_CMD_IMLS_NAND * List all images found in NAND flash 868602ad3b3SJon Loeliger CONFIG_CMD_IMMAP * IMMR dump support 8690c79cda0SMike Frysinger CONFIG_CMD_IMPORTENV * import an environment 870c167cc02SJoe Hershberger CONFIG_CMD_INI * import data from an ini file into the env 871602ad3b3SJon Loeliger CONFIG_CMD_IRQ * irqinfo 872602ad3b3SJon Loeliger CONFIG_CMD_ITEST Integer/string test of 2 values 873602ad3b3SJon Loeliger CONFIG_CMD_JFFS2 * JFFS2 Support 874602ad3b3SJon Loeliger CONFIG_CMD_KGDB * kgdb 8754d98b5c8SVincent Stehlé CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader) 876d22c338eSJoe Hershberger CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration 877d22c338eSJoe Hershberger (169.254.*.*) 878602ad3b3SJon Loeliger CONFIG_CMD_LOADB loadb 879602ad3b3SJon Loeliger CONFIG_CMD_LOADS loads 8804d98b5c8SVincent Stehlé CONFIG_CMD_MD5SUM * print md5 message digest 88102c9aa1dSRobin Getz (requires CONFIG_CMD_MEMORY and CONFIG_MD5) 88215a33e49SSimon Glass CONFIG_CMD_MEMINFO * Display detailed memory information 883602ad3b3SJon Loeliger CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base, 884a2681707SWolfgang Denk loop, loopw 8854d98b5c8SVincent Stehlé CONFIG_CMD_MEMTEST * mtest 886602ad3b3SJon Loeliger CONFIG_CMD_MISC Misc functions like sleep etc 887602ad3b3SJon Loeliger CONFIG_CMD_MMC * MMC memory mapped support 888602ad3b3SJon Loeliger CONFIG_CMD_MII * MII utility commands 88968d7d651SStefan Roese CONFIG_CMD_MTDPARTS * MTD partition support 890602ad3b3SJon Loeliger CONFIG_CMD_NAND * NAND support 891602ad3b3SJon Loeliger CONFIG_CMD_NET bootp, tftpboot, rarpboot 8924d98b5c8SVincent Stehlé CONFIG_CMD_NFS NFS support 893e92739d3SPeter Tyser CONFIG_CMD_PCA953X * PCA953x I2C gpio commands 894e92739d3SPeter Tyser CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command 895602ad3b3SJon Loeliger CONFIG_CMD_PCI * pciinfo 896602ad3b3SJon Loeliger CONFIG_CMD_PCMCIA * PCMCIA support 897602ad3b3SJon Loeliger CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network 898602ad3b3SJon Loeliger host 899602ad3b3SJon Loeliger CONFIG_CMD_PORTIO * Port I/O 900ff048ea9SKenneth Waters CONFIG_CMD_READ * Read raw data from partition 901602ad3b3SJon Loeliger CONFIG_CMD_REGINFO * Register dump 902602ad3b3SJon Loeliger CONFIG_CMD_RUN run command in env variable 903d304931fSSimon Glass CONFIG_CMD_SANDBOX * sb command to access sandbox features 904602ad3b3SJon Loeliger CONFIG_CMD_SAVES * save S record dump 905602ad3b3SJon Loeliger CONFIG_CMD_SCSI * SCSI Support 906602ad3b3SJon Loeliger CONFIG_CMD_SDRAM * print SDRAM configuration information 907602ad3b3SJon Loeliger (requires CONFIG_CMD_I2C) 908602ad3b3SJon Loeliger CONFIG_CMD_SETGETDCR Support for DCR Register access 909602ad3b3SJon Loeliger (4xx only) 910f61ec45eSEric Nelson CONFIG_CMD_SF * Read/write/erase SPI NOR flash 9114d98b5c8SVincent Stehlé CONFIG_CMD_SHA1SUM * print sha1 memory digest 91202c9aa1dSRobin Getz (requires CONFIG_CMD_MEMORY) 9137d861d95SBob Liu CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x 91474de7aefSWolfgang Denk CONFIG_CMD_SOURCE "source" command Support 915602ad3b3SJon Loeliger CONFIG_CMD_SPI * SPI serial bus support 9167a83af07SLuca Ceresoli CONFIG_CMD_TFTPSRV * TFTP transfer in server mode 9171fb7cd49SSimon Glass CONFIG_CMD_TFTPPUT * TFTP put command (upload) 918da83bcd7SJoe Hershberger CONFIG_CMD_TIME * run command and report execution time (ARM specific) 919da83bcd7SJoe Hershberger CONFIG_CMD_TIMER * access to the system tick timer 920602ad3b3SJon Loeliger CONFIG_CMD_USB * USB support 921602ad3b3SJon Loeliger CONFIG_CMD_CDP * Cisco Discover Protocol support 922c8339f51SMarek Vasut CONFIG_CMD_MFSL * Microblaze FSL support 9234d98b5c8SVincent Stehlé CONFIG_CMD_XIMG Load part of Multi Image 924c609719bSwdenk 925c609719bSwdenk 926c609719bSwdenk EXAMPLE: If you want all functions except of network 927c609719bSwdenk support you can write: 928c609719bSwdenk 929602ad3b3SJon Loeliger #include "config_cmd_all.h" 930602ad3b3SJon Loeliger #undef CONFIG_CMD_NET 931c609719bSwdenk 932213bf8c8SGerald Van Baren Other Commands: 933213bf8c8SGerald Van Baren fdt (flattened device tree) command: CONFIG_OF_LIBFDT 934c609719bSwdenk 935c609719bSwdenk Note: Don't enable the "icache" and "dcache" commands 936602ad3b3SJon Loeliger (configuration option CONFIG_CMD_CACHE) unless you know 937c609719bSwdenk what you (and your U-Boot users) are doing. Data 938c609719bSwdenk cache cannot be enabled on systems like the 8xx or 939c609719bSwdenk 8260 (where accesses to the IMMR region must be 940c609719bSwdenk uncached), and it cannot be disabled on all other 941c609719bSwdenk systems where we (mis-) use the data cache to hold an 942c609719bSwdenk initial stack and some data. 943c609719bSwdenk 944c609719bSwdenk 945c609719bSwdenk XXX - this list needs to get updated! 946c609719bSwdenk 947a5ecbe62SWolfgang Denk- Regular expression support: 948a5ecbe62SWolfgang Denk CONFIG_REGEX 949a5ecbe62SWolfgang Denk If this variable is defined, U-Boot is linked against 950a5ecbe62SWolfgang Denk the SLRE (Super Light Regular Expression) library, 951a5ecbe62SWolfgang Denk which adds regex support to some commands, as for 952a5ecbe62SWolfgang Denk example "env grep" and "setexpr". 953a5ecbe62SWolfgang Denk 95445ba8077SSimon Glass- Device tree: 95545ba8077SSimon Glass CONFIG_OF_CONTROL 95645ba8077SSimon Glass If this variable is defined, U-Boot will use a device tree 95745ba8077SSimon Glass to configure its devices, instead of relying on statically 95845ba8077SSimon Glass compiled #defines in the board file. This option is 95945ba8077SSimon Glass experimental and only available on a few boards. The device 96045ba8077SSimon Glass tree is available in the global data as gd->fdt_blob. 96145ba8077SSimon Glass 9622c0f79e4SSimon Glass U-Boot needs to get its device tree from somewhere. This can 9632c0f79e4SSimon Glass be done using one of the two options below: 964bbb0b128SSimon Glass 965bbb0b128SSimon Glass CONFIG_OF_EMBED 966bbb0b128SSimon Glass If this variable is defined, U-Boot will embed a device tree 967bbb0b128SSimon Glass binary in its image. This device tree file should be in the 968bbb0b128SSimon Glass board directory and called <soc>-<board>.dts. The binary file 969bbb0b128SSimon Glass is then picked up in board_init_f() and made available through 970bbb0b128SSimon Glass the global data structure as gd->blob. 97145ba8077SSimon Glass 9722c0f79e4SSimon Glass CONFIG_OF_SEPARATE 9732c0f79e4SSimon Glass If this variable is defined, U-Boot will build a device tree 9742c0f79e4SSimon Glass binary. It will be called u-boot.dtb. Architecture-specific 9752c0f79e4SSimon Glass code will locate it at run-time. Generally this works by: 9762c0f79e4SSimon Glass 9772c0f79e4SSimon Glass cat u-boot.bin u-boot.dtb >image.bin 9782c0f79e4SSimon Glass 9792c0f79e4SSimon Glass and in fact, U-Boot does this for you, creating a file called 9802c0f79e4SSimon Glass u-boot-dtb.bin which is useful in the common case. You can 9812c0f79e4SSimon Glass still use the individual files if you need something more 9822c0f79e4SSimon Glass exotic. 9832c0f79e4SSimon Glass 984c609719bSwdenk- Watchdog: 985c609719bSwdenk CONFIG_WATCHDOG 986c609719bSwdenk If this variable is defined, it enables watchdog 9876abe6fb6SDetlev Zundel support for the SoC. There must be support in the SoC 9886abe6fb6SDetlev Zundel specific code for a watchdog. For the 8xx and 8260 9896abe6fb6SDetlev Zundel CPUs, the SIU Watchdog feature is enabled in the SYPCR 9906abe6fb6SDetlev Zundel register. When supported for a specific SoC is 9916abe6fb6SDetlev Zundel available, then no further board specific code should 9926abe6fb6SDetlev Zundel be needed to use it. 9936abe6fb6SDetlev Zundel 9946abe6fb6SDetlev Zundel CONFIG_HW_WATCHDOG 9956abe6fb6SDetlev Zundel When using a watchdog circuitry external to the used 9966abe6fb6SDetlev Zundel SoC, then define this variable and provide board 9976abe6fb6SDetlev Zundel specific code for the "hw_watchdog_reset" function. 998c609719bSwdenk 999c1551ea8Sstroese- U-Boot Version: 1000c1551ea8Sstroese CONFIG_VERSION_VARIABLE 1001c1551ea8Sstroese If this variable is defined, an environment variable 1002c1551ea8Sstroese named "ver" is created by U-Boot showing the U-Boot 1003c1551ea8Sstroese version as printed by the "version" command. 1004a1ea8e51SBenoît Thébaudeau Any change to this variable will be reverted at the 1005a1ea8e51SBenoît Thébaudeau next reset. 1006c1551ea8Sstroese 1007c609719bSwdenk- Real-Time Clock: 1008c609719bSwdenk 1009602ad3b3SJon Loeliger When CONFIG_CMD_DATE is selected, the type of the RTC 1010c609719bSwdenk has to be selected, too. Define exactly one of the 1011c609719bSwdenk following options: 1012c609719bSwdenk 1013c609719bSwdenk CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx 1014c609719bSwdenk CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC 10154e8b7544SFabio Estevam CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC 1016c609719bSwdenk CONFIG_RTC_MC146818 - use MC146818 RTC 10171cb8e980Swdenk CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC 1018c609719bSwdenk CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC 10197f70e853Swdenk CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC 10203bac3513Swdenk CONFIG_RTC_DS164x - use Dallas DS164x RTC 10219536dfccSTor Krill CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC 10224c0d4c3bSwdenk CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC 10236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337 102471d19f30SHeiko Schocher CONFIG_SYS_RV3029_TCR - enable trickle charger on 102571d19f30SHeiko Schocher RV3029 RTC. 1026c609719bSwdenk 1027b37c7e5eSwdenk Note that if the RTC uses I2C, then the I2C interface 1028b37c7e5eSwdenk must also be configured. See I2C Support, below. 1029b37c7e5eSwdenk 1030e92739d3SPeter Tyser- GPIO Support: 1031e92739d3SPeter Tyser CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO 1032e92739d3SPeter Tyser CONFIG_PCA953X_INFO - enable pca953x info command 1033e92739d3SPeter Tyser 10345dec49caSChris Packham The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of 10355dec49caSChris Packham chip-ngpio pairs that tell the PCA953X driver the number of 10365dec49caSChris Packham pins supported by a particular chip. 10375dec49caSChris Packham 1038e92739d3SPeter Tyser Note that if the GPIO device uses I2C, then the I2C interface 1039e92739d3SPeter Tyser must also be configured. See I2C Support, below. 1040e92739d3SPeter Tyser 1041c609719bSwdenk- Timestamp Support: 1042c609719bSwdenk 1043c609719bSwdenk When CONFIG_TIMESTAMP is selected, the timestamp 1044c609719bSwdenk (date and time) of an image is printed by image 1045c609719bSwdenk commands like bootm or iminfo. This option is 1046602ad3b3SJon Loeliger automatically enabled when you select CONFIG_CMD_DATE . 1047c609719bSwdenk 1048923c46f9SKarl O. Pinc- Partition Labels (disklabels) Supported: 1049923c46f9SKarl O. Pinc Zero or more of the following: 1050923c46f9SKarl O. Pinc CONFIG_MAC_PARTITION Apple's MacOS partition table. 1051923c46f9SKarl O. Pinc CONFIG_DOS_PARTITION MS Dos partition table, traditional on the 1052923c46f9SKarl O. Pinc Intel architecture, USB sticks, etc. 1053923c46f9SKarl O. Pinc CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc. 1054923c46f9SKarl O. Pinc CONFIG_EFI_PARTITION GPT partition table, common when EFI is the 1055923c46f9SKarl O. Pinc bootloader. Note 2TB partition limit; see 1056923c46f9SKarl O. Pinc disk/part_efi.c 1057923c46f9SKarl O. Pinc CONFIG_MTD_PARTITIONS Memory Technology Device partition table. 1058c609719bSwdenk 1059602ad3b3SJon Loeliger If IDE or SCSI support is enabled (CONFIG_CMD_IDE or 1060218ca724SWolfgang Denk CONFIG_CMD_SCSI) you must configure support for at 1061923c46f9SKarl O. Pinc least one non-MTD partition type as well. 1062c609719bSwdenk 1063c609719bSwdenk- IDE Reset method: 10644d13cbadSwdenk CONFIG_IDE_RESET_ROUTINE - this is defined in several 10654d13cbadSwdenk board configurations files but used nowhere! 1066c609719bSwdenk 10674d13cbadSwdenk CONFIG_IDE_RESET - is this is defined, IDE Reset will 10684d13cbadSwdenk be performed by calling the function 10694d13cbadSwdenk ide_set_reset(int reset) 10704d13cbadSwdenk which has to be defined in a board specific file 1071c609719bSwdenk 1072c609719bSwdenk- ATAPI Support: 1073c609719bSwdenk CONFIG_ATAPI 1074c609719bSwdenk 1075c609719bSwdenk Set this to enable ATAPI support. 1076c609719bSwdenk 1077c40b2956Swdenk- LBA48 Support 1078c40b2956Swdenk CONFIG_LBA48 1079c40b2956Swdenk 1080c40b2956Swdenk Set this to enable support for disks larger than 137GB 10814b142febSHeiko Schocher Also look at CONFIG_SYS_64BIT_LBA. 1082c40b2956Swdenk Whithout these , LBA48 support uses 32bit variables and will 'only' 1083c40b2956Swdenk support disks up to 2.1TB. 1084c40b2956Swdenk 10856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_64BIT_LBA: 1086c40b2956Swdenk When enabled, makes the IDE subsystem use 64bit sector addresses. 1087c40b2956Swdenk Default is 32bit. 1088c40b2956Swdenk 1089c609719bSwdenk- SCSI Support: 1090c609719bSwdenk At the moment only there is only support for the 1091c609719bSwdenk SYM53C8XX SCSI controller; define 1092c609719bSwdenk CONFIG_SCSI_SYM53C8XX to enable it. 1093c609719bSwdenk 10946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and 10956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID * 10966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the 1097c609719bSwdenk maximum numbers of LUNs, SCSI ID's and target 1098c609719bSwdenk devices. 10996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz) 1100c609719bSwdenk 1101447c031bSStefan Reinauer The environment variable 'scsidevs' is set to the number of 1102447c031bSStefan Reinauer SCSI devices found during the last scan. 1103447c031bSStefan Reinauer 1104c609719bSwdenk- NETWORK Support (PCI): 1105682011ffSwdenk CONFIG_E1000 1106ce5207e1SKyle Moffett Support for Intel 8254x/8257x gigabit chips. 1107ce5207e1SKyle Moffett 1108ce5207e1SKyle Moffett CONFIG_E1000_SPI 1109ce5207e1SKyle Moffett Utility code for direct access to the SPI bus on Intel 8257x. 1110ce5207e1SKyle Moffett This does not do anything useful unless you set at least one 1111ce5207e1SKyle Moffett of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC. 1112ce5207e1SKyle Moffett 1113ce5207e1SKyle Moffett CONFIG_E1000_SPI_GENERIC 1114ce5207e1SKyle Moffett Allow generic access to the SPI bus on the Intel 8257x, for 1115ce5207e1SKyle Moffett example with the "sspi" command. 1116ce5207e1SKyle Moffett 1117ce5207e1SKyle Moffett CONFIG_CMD_E1000 1118ce5207e1SKyle Moffett Management command for E1000 devices. When used on devices 1119ce5207e1SKyle Moffett with SPI support you can reprogram the EEPROM from U-Boot. 1120682011ffSwdenk 1121ac3315c2SAndre Schwarz CONFIG_E1000_FALLBACK_MAC 112211ccc33fSMarcel Ziswiler default MAC for empty EEPROM after production. 1123ac3315c2SAndre Schwarz 1124c609719bSwdenk CONFIG_EEPRO100 1125c609719bSwdenk Support for Intel 82557/82559/82559ER chips. 112611ccc33fSMarcel Ziswiler Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM 1127c609719bSwdenk write routine for first time initialisation. 1128c609719bSwdenk 1129c609719bSwdenk CONFIG_TULIP 1130c609719bSwdenk Support for Digital 2114x chips. 1131c609719bSwdenk Optional CONFIG_TULIP_SELECT_MEDIA for board specific 1132c609719bSwdenk modem chip initialisation (KS8761/QS6611). 1133c609719bSwdenk 1134c609719bSwdenk CONFIG_NATSEMI 1135c609719bSwdenk Support for National dp83815 chips. 1136c609719bSwdenk 1137c609719bSwdenk CONFIG_NS8382X 1138c609719bSwdenk Support for National dp8382[01] gigabit chips. 1139c609719bSwdenk 114045219c46Swdenk- NETWORK Support (other): 114145219c46Swdenk 1142c041e9d2SJens Scharsig CONFIG_DRIVER_AT91EMAC 1143c041e9d2SJens Scharsig Support for AT91RM9200 EMAC. 1144c041e9d2SJens Scharsig 1145c041e9d2SJens Scharsig CONFIG_RMII 1146c041e9d2SJens Scharsig Define this to use reduced MII inteface 1147c041e9d2SJens Scharsig 1148c041e9d2SJens Scharsig CONFIG_DRIVER_AT91EMAC_QUIET 1149c041e9d2SJens Scharsig If this defined, the driver is quiet. 1150c041e9d2SJens Scharsig The driver doen't show link status messages. 1151c041e9d2SJens Scharsig 1152efdd7319SRob Herring CONFIG_CALXEDA_XGMAC 1153efdd7319SRob Herring Support for the Calxeda XGMAC device 1154efdd7319SRob Herring 11553bb46d23SAshok CONFIG_LAN91C96 115645219c46Swdenk Support for SMSC's LAN91C96 chips. 115745219c46Swdenk 115845219c46Swdenk CONFIG_LAN91C96_BASE 115945219c46Swdenk Define this to hold the physical address 116045219c46Swdenk of the LAN91C96's I/O space 116145219c46Swdenk 116245219c46Swdenk CONFIG_LAN91C96_USE_32_BIT 116345219c46Swdenk Define this to enable 32 bit addressing 116445219c46Swdenk 11653bb46d23SAshok CONFIG_SMC91111 1166f39748aeSwdenk Support for SMSC's LAN91C111 chip 1167f39748aeSwdenk 1168f39748aeSwdenk CONFIG_SMC91111_BASE 1169f39748aeSwdenk Define this to hold the physical address 1170f39748aeSwdenk of the device (I/O space) 1171f39748aeSwdenk 1172f39748aeSwdenk CONFIG_SMC_USE_32_BIT 1173f39748aeSwdenk Define this if data bus is 32 bits 1174f39748aeSwdenk 1175f39748aeSwdenk CONFIG_SMC_USE_IOFUNCS 1176f39748aeSwdenk Define this to use i/o functions instead of macros 1177f39748aeSwdenk (some hardware wont work with macros) 1178f39748aeSwdenk 1179dc02badaSHeiko Schocher CONFIG_DRIVER_TI_EMAC 1180dc02badaSHeiko Schocher Support for davinci emac 1181dc02badaSHeiko Schocher 1182dc02badaSHeiko Schocher CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT 1183dc02badaSHeiko Schocher Define this if you have more then 3 PHYs. 1184dc02badaSHeiko Schocher 1185b3dbf4a5SMacpaul Lin CONFIG_FTGMAC100 1186b3dbf4a5SMacpaul Lin Support for Faraday's FTGMAC100 Gigabit SoC Ethernet 1187b3dbf4a5SMacpaul Lin 1188b3dbf4a5SMacpaul Lin CONFIG_FTGMAC100_EGIGA 1189b3dbf4a5SMacpaul Lin Define this to use GE link update with gigabit PHY. 1190b3dbf4a5SMacpaul Lin Define this if FTGMAC100 is connected to gigabit PHY. 1191b3dbf4a5SMacpaul Lin If your system has 10/100 PHY only, it might not occur 1192b3dbf4a5SMacpaul Lin wrong behavior. Because PHY usually return timeout or 1193b3dbf4a5SMacpaul Lin useless data when polling gigabit status and gigabit 1194b3dbf4a5SMacpaul Lin control registers. This behavior won't affect the 1195b3dbf4a5SMacpaul Lin correctnessof 10/100 link speed update. 1196b3dbf4a5SMacpaul Lin 1197c2fff331SMike Rapoport CONFIG_SMC911X 1198557b377dSJens Gehrlein Support for SMSC's LAN911x and LAN921x chips 1199557b377dSJens Gehrlein 1200c2fff331SMike Rapoport CONFIG_SMC911X_BASE 1201557b377dSJens Gehrlein Define this to hold the physical address 1202557b377dSJens Gehrlein of the device (I/O space) 1203557b377dSJens Gehrlein 1204c2fff331SMike Rapoport CONFIG_SMC911X_32_BIT 1205557b377dSJens Gehrlein Define this if data bus is 32 bits 1206557b377dSJens Gehrlein 1207c2fff331SMike Rapoport CONFIG_SMC911X_16_BIT 1208557b377dSJens Gehrlein Define this if data bus is 16 bits. If your processor 1209557b377dSJens Gehrlein automatically converts one 32 bit word to two 16 bit 1210c2fff331SMike Rapoport words you may also try CONFIG_SMC911X_32_BIT. 1211557b377dSJens Gehrlein 12123d0075faSYoshihiro Shimoda CONFIG_SH_ETHER 12133d0075faSYoshihiro Shimoda Support for Renesas on-chip Ethernet controller 12143d0075faSYoshihiro Shimoda 12153d0075faSYoshihiro Shimoda CONFIG_SH_ETHER_USE_PORT 12163d0075faSYoshihiro Shimoda Define the number of ports to be used 12173d0075faSYoshihiro Shimoda 12183d0075faSYoshihiro Shimoda CONFIG_SH_ETHER_PHY_ADDR 12193d0075faSYoshihiro Shimoda Define the ETH PHY's address 12203d0075faSYoshihiro Shimoda 122168260aabSYoshihiro Shimoda CONFIG_SH_ETHER_CACHE_WRITEBACK 122268260aabSYoshihiro Shimoda If this option is set, the driver enables cache flush. 122368260aabSYoshihiro Shimoda 12245e124724SVadim Bendebury- TPM Support: 122590899cc0SChe-liang Chiou CONFIG_TPM 122690899cc0SChe-liang Chiou Support TPM devices. 122790899cc0SChe-liang Chiou 12281b393db5STom Wai-Hong Tam CONFIG_TPM_TIS_I2C 12291b393db5STom Wai-Hong Tam Support for i2c bus TPM devices. Only one device 12301b393db5STom Wai-Hong Tam per system is supported at this time. 12311b393db5STom Wai-Hong Tam 12321b393db5STom Wai-Hong Tam CONFIG_TPM_TIS_I2C_BUS_NUMBER 12331b393db5STom Wai-Hong Tam Define the the i2c bus number for the TPM device 12341b393db5STom Wai-Hong Tam 12351b393db5STom Wai-Hong Tam CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS 12361b393db5STom Wai-Hong Tam Define the TPM's address on the i2c bus 12371b393db5STom Wai-Hong Tam 12381b393db5STom Wai-Hong Tam CONFIG_TPM_TIS_I2C_BURST_LIMITATION 12391b393db5STom Wai-Hong Tam Define the burst count bytes upper limit 12401b393db5STom Wai-Hong Tam 1241c01939c7SDirk Eibach CONFIG_TPM_ATMEL_TWI 1242c01939c7SDirk Eibach Support for Atmel TWI TPM device. Requires I2C support. 1243c01939c7SDirk Eibach 124490899cc0SChe-liang Chiou CONFIG_TPM_TIS_LPC 12455e124724SVadim Bendebury Support for generic parallel port TPM devices. Only one device 12465e124724SVadim Bendebury per system is supported at this time. 12475e124724SVadim Bendebury 12485e124724SVadim Bendebury CONFIG_TPM_TIS_BASE_ADDRESS 12495e124724SVadim Bendebury Base address where the generic TPM device is mapped 12505e124724SVadim Bendebury to. Contemporary x86 systems usually map it at 12515e124724SVadim Bendebury 0xfed40000. 12525e124724SVadim Bendebury 1253be6c1529SReinhard Pfau CONFIG_CMD_TPM 1254be6c1529SReinhard Pfau Add tpm monitor functions. 1255be6c1529SReinhard Pfau Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also 1256be6c1529SReinhard Pfau provides monitor access to authorized functions. 1257be6c1529SReinhard Pfau 1258be6c1529SReinhard Pfau CONFIG_TPM 1259be6c1529SReinhard Pfau Define this to enable the TPM support library which provides 1260be6c1529SReinhard Pfau functional interfaces to some TPM commands. 1261be6c1529SReinhard Pfau Requires support for a TPM device. 1262be6c1529SReinhard Pfau 1263be6c1529SReinhard Pfau CONFIG_TPM_AUTH_SESSIONS 1264be6c1529SReinhard Pfau Define this to enable authorized functions in the TPM library. 1265be6c1529SReinhard Pfau Requires CONFIG_TPM and CONFIG_SHA1. 1266be6c1529SReinhard Pfau 1267c609719bSwdenk- USB Support: 1268c609719bSwdenk At the moment only the UHCI host controller is 12694d13cbadSwdenk supported (PIP405, MIP405, MPC5200); define 1270c609719bSwdenk CONFIG_USB_UHCI to enable it. 1271c609719bSwdenk define CONFIG_USB_KEYBOARD to enable the USB Keyboard 127230d56faeSwdenk and define CONFIG_USB_STORAGE to enable the USB 1273c609719bSwdenk storage devices. 1274c609719bSwdenk Note: 1275c609719bSwdenk Supported are USB Keyboards and USB Floppy drives 1276c609719bSwdenk (TEAC FD-05PUB). 12774d13cbadSwdenk MPC5200 USB requires additional defines: 12784d13cbadSwdenk CONFIG_USB_CLOCK 12794d13cbadSwdenk for 528 MHz Clock: 0x0001bbbb 1280307ecb6dSEric Millbrandt CONFIG_PSC3_USB 1281307ecb6dSEric Millbrandt for USB on PSC3 12824d13cbadSwdenk CONFIG_USB_CONFIG 12834d13cbadSwdenk for differential drivers: 0x00001000 12844d13cbadSwdenk for single ended drivers: 0x00005000 1285307ecb6dSEric Millbrandt for differential drivers on PSC3: 0x00000100 1286307ecb6dSEric Millbrandt for single ended drivers on PSC3: 0x00004100 12876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_USB_EVENT_POLL 1288fdcfaa1bSZhang Wei May be defined to allow interrupt polling 1289fdcfaa1bSZhang Wei instead of using asynchronous interrupts 12904d13cbadSwdenk 12919ab4ce22SSimon Glass CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the 12929ab4ce22SSimon Glass txfilltuning field in the EHCI controller on reset. 12939ab4ce22SSimon Glass 1294aa155058SKuo-Jung Su CONFIG_USB_HUB_MIN_POWER_ON_DELAY defines the minimum 1295aa155058SKuo-Jung Su interval for usb hub power-on delay.(minimum 100msec) 1296aa155058SKuo-Jung Su 129716c8d5e7SWolfgang Denk- USB Device: 129816c8d5e7SWolfgang Denk Define the below if you wish to use the USB console. 129916c8d5e7SWolfgang Denk Once firmware is rebuilt from a serial console issue the 130016c8d5e7SWolfgang Denk command "setenv stdin usbtty; setenv stdout usbtty" and 130111ccc33fSMarcel Ziswiler attach your USB cable. The Unix command "dmesg" should print 130216c8d5e7SWolfgang Denk it has found a new device. The environment variable usbtty 130316c8d5e7SWolfgang Denk can be set to gserial or cdc_acm to enable your device to 130416c8d5e7SWolfgang Denk appear to a USB host as a Linux gserial device or a 130516c8d5e7SWolfgang Denk Common Device Class Abstract Control Model serial device. 130616c8d5e7SWolfgang Denk If you select usbtty = gserial you should be able to enumerate 130716c8d5e7SWolfgang Denk a Linux host by 130816c8d5e7SWolfgang Denk # modprobe usbserial vendor=0xVendorID product=0xProductID 130916c8d5e7SWolfgang Denk else if using cdc_acm, simply setting the environment 131016c8d5e7SWolfgang Denk variable usbtty to be cdc_acm should suffice. The following 131116c8d5e7SWolfgang Denk might be defined in YourBoardName.h 131216c8d5e7SWolfgang Denk 131316c8d5e7SWolfgang Denk CONFIG_USB_DEVICE 131416c8d5e7SWolfgang Denk Define this to build a UDC device 131516c8d5e7SWolfgang Denk 131616c8d5e7SWolfgang Denk CONFIG_USB_TTY 131716c8d5e7SWolfgang Denk Define this to have a tty type of device available to 131816c8d5e7SWolfgang Denk talk to the UDC device 131916c8d5e7SWolfgang Denk 1320f9da0f89SVipin KUMAR CONFIG_USBD_HS 1321f9da0f89SVipin KUMAR Define this to enable the high speed support for usb 1322f9da0f89SVipin KUMAR device and usbtty. If this feature is enabled, a routine 1323f9da0f89SVipin KUMAR int is_usbd_high_speed(void) 1324f9da0f89SVipin KUMAR also needs to be defined by the driver to dynamically poll 1325f9da0f89SVipin KUMAR whether the enumeration has succeded at high speed or full 1326f9da0f89SVipin KUMAR speed. 1327f9da0f89SVipin KUMAR 13286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_CONSOLE_IS_IN_ENV 132916c8d5e7SWolfgang Denk Define this if you want stdin, stdout &/or stderr to 133016c8d5e7SWolfgang Denk be set to usbtty. 133116c8d5e7SWolfgang Denk 133216c8d5e7SWolfgang Denk mpc8xx: 13336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_USB_EXTC_CLK 0xBLAH 133416c8d5e7SWolfgang Denk Derive USB clock from external clock "blah" 13356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_USB_EXTC_CLK 0x02 133616c8d5e7SWolfgang Denk 13376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_USB_BRG_CLK 0xBLAH 133816c8d5e7SWolfgang Denk Derive USB clock from brgclk 13396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_USB_BRG_CLK 0x04 134016c8d5e7SWolfgang Denk 134116c8d5e7SWolfgang Denk If you have a USB-IF assigned VendorID then you may wish to 134216c8d5e7SWolfgang Denk define your own vendor specific values either in BoardName.h 134316c8d5e7SWolfgang Denk or directly in usbd_vendor_info.h. If you don't define 134416c8d5e7SWolfgang Denk CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME, 134516c8d5e7SWolfgang Denk CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot 134616c8d5e7SWolfgang Denk should pretend to be a Linux device to it's target host. 134716c8d5e7SWolfgang Denk 134816c8d5e7SWolfgang Denk CONFIG_USBD_MANUFACTURER 134916c8d5e7SWolfgang Denk Define this string as the name of your company for 135016c8d5e7SWolfgang Denk - CONFIG_USBD_MANUFACTURER "my company" 135116c8d5e7SWolfgang Denk 135216c8d5e7SWolfgang Denk CONFIG_USBD_PRODUCT_NAME 135316c8d5e7SWolfgang Denk Define this string as the name of your product 135416c8d5e7SWolfgang Denk - CONFIG_USBD_PRODUCT_NAME "acme usb device" 135516c8d5e7SWolfgang Denk 135616c8d5e7SWolfgang Denk CONFIG_USBD_VENDORID 135716c8d5e7SWolfgang Denk Define this as your assigned Vendor ID from the USB 135816c8d5e7SWolfgang Denk Implementors Forum. This *must* be a genuine Vendor ID 135916c8d5e7SWolfgang Denk to avoid polluting the USB namespace. 136016c8d5e7SWolfgang Denk - CONFIG_USBD_VENDORID 0xFFFF 136116c8d5e7SWolfgang Denk 136216c8d5e7SWolfgang Denk CONFIG_USBD_PRODUCTID 136316c8d5e7SWolfgang Denk Define this as the unique Product ID 136416c8d5e7SWolfgang Denk for your device 136516c8d5e7SWolfgang Denk - CONFIG_USBD_PRODUCTID 0xFFFF 1366c609719bSwdenk 1367d70a560fSIgor Grinberg- ULPI Layer Support: 1368d70a560fSIgor Grinberg The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via 1369d70a560fSIgor Grinberg the generic ULPI layer. The generic layer accesses the ULPI PHY 1370d70a560fSIgor Grinberg via the platform viewport, so you need both the genric layer and 1371d70a560fSIgor Grinberg the viewport enabled. Currently only Chipidea/ARC based 1372d70a560fSIgor Grinberg viewport is supported. 1373d70a560fSIgor Grinberg To enable the ULPI layer support, define CONFIG_USB_ULPI and 1374d70a560fSIgor Grinberg CONFIG_USB_ULPI_VIEWPORT in your board configuration file. 13756d365ea0SLucas Stach If your ULPI phy needs a different reference clock than the 13766d365ea0SLucas Stach standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to 13776d365ea0SLucas Stach the appropriate value in Hz. 1378c609719bSwdenk 1379c609719bSwdenk- MMC Support: 1380c609719bSwdenk The MMC controller on the Intel PXA is supported. To 1381c609719bSwdenk enable this define CONFIG_MMC. The MMC can be 1382c609719bSwdenk accessed from the boot prompt by mapping the device 1383c609719bSwdenk to physical memory similar to flash. Command line is 1384602ad3b3SJon Loeliger enabled with CONFIG_CMD_MMC. The MMC driver also works with 1385602ad3b3SJon Loeliger the FAT fs. This is enabled with CONFIG_CMD_FAT. 1386c609719bSwdenk 1387afb35666SYoshihiro Shimoda CONFIG_SH_MMCIF 1388afb35666SYoshihiro Shimoda Support for Renesas on-chip MMCIF controller 1389afb35666SYoshihiro Shimoda 1390afb35666SYoshihiro Shimoda CONFIG_SH_MMCIF_ADDR 1391afb35666SYoshihiro Shimoda Define the base address of MMCIF registers 1392afb35666SYoshihiro Shimoda 1393afb35666SYoshihiro Shimoda CONFIG_SH_MMCIF_CLK 1394afb35666SYoshihiro Shimoda Define the clock frequency for MMCIF 1395afb35666SYoshihiro Shimoda 1396b3ba6e94STom Rini- USB Device Firmware Update (DFU) class support: 1397b3ba6e94STom Rini CONFIG_DFU_FUNCTION 1398b3ba6e94STom Rini This enables the USB portion of the DFU USB class 1399b3ba6e94STom Rini 1400b3ba6e94STom Rini CONFIG_CMD_DFU 1401b3ba6e94STom Rini This enables the command "dfu" which is used to have 1402b3ba6e94STom Rini U-Boot create a DFU class device via USB. This command 1403b3ba6e94STom Rini requires that the "dfu_alt_info" environment variable be 1404b3ba6e94STom Rini set and define the alt settings to expose to the host. 1405b3ba6e94STom Rini 1406b3ba6e94STom Rini CONFIG_DFU_MMC 1407b3ba6e94STom Rini This enables support for exposing (e)MMC devices via DFU. 1408b3ba6e94STom Rini 1409c6631764SPantelis Antoniou CONFIG_DFU_NAND 1410c6631764SPantelis Antoniou This enables support for exposing NAND devices via DFU. 1411c6631764SPantelis Antoniou 1412e7e75c70SHeiko Schocher CONFIG_SYS_DFU_DATA_BUF_SIZE 1413e7e75c70SHeiko Schocher Dfu transfer uses a buffer before writing data to the 1414e7e75c70SHeiko Schocher raw storage device. Make the size (in bytes) of this buffer 1415e7e75c70SHeiko Schocher configurable. The size of this buffer is also configurable 1416e7e75c70SHeiko Schocher through the "dfu_bufsiz" environment variable. 1417e7e75c70SHeiko Schocher 1418ea2453d5SPantelis Antoniou CONFIG_SYS_DFU_MAX_FILE_SIZE 1419ea2453d5SPantelis Antoniou When updating files rather than the raw storage device, 1420ea2453d5SPantelis Antoniou we use a static buffer to copy the file into and then write 1421ea2453d5SPantelis Antoniou the buffer once we've been given the whole file. Define 1422ea2453d5SPantelis Antoniou this to the maximum filesize (in bytes) for the buffer. 1423ea2453d5SPantelis Antoniou Default is 4 MiB if undefined. 1424ea2453d5SPantelis Antoniou 14256705d81eSwdenk- Journaling Flash filesystem support: 14266705d81eSwdenk CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE, 14276705d81eSwdenk CONFIG_JFFS2_NAND_DEV 14286705d81eSwdenk Define these for a default partition on a NAND device 14296705d81eSwdenk 14306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS2_FIRST_SECTOR, 14316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS 14326705d81eSwdenk Define these for a default partition on a NOR device 14336705d81eSwdenk 14346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS_CUSTOM_PART 14356705d81eSwdenk Define this to create an own partition. You have to provide a 14366705d81eSwdenk function struct part_info* jffs2_part_info(int part_num) 14376705d81eSwdenk 14386705d81eSwdenk If you define only one JFFS2 partition you may also want to 14396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_JFFS_SINGLE_PART 1 14406705d81eSwdenk to disable the command chpart. This is the default when you 14416705d81eSwdenk have not defined a custom partition 14426705d81eSwdenk 1443c30a15e5SDonggeun Kim- FAT(File Allocation Table) filesystem write function support: 1444c30a15e5SDonggeun Kim CONFIG_FAT_WRITE 1445656f4c65SDonggeun Kim 1446656f4c65SDonggeun Kim Define this to enable support for saving memory data as a 1447656f4c65SDonggeun Kim file in FAT formatted partition. 1448656f4c65SDonggeun Kim 1449656f4c65SDonggeun Kim This will also enable the command "fatwrite" enabling the 1450656f4c65SDonggeun Kim user to write files to FAT. 1451c30a15e5SDonggeun Kim 145284cd9327SGabe BlackCBFS (Coreboot Filesystem) support 145384cd9327SGabe Black CONFIG_CMD_CBFS 145484cd9327SGabe Black 145584cd9327SGabe Black Define this to enable support for reading from a Coreboot 145684cd9327SGabe Black filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls 145784cd9327SGabe Black and cbfsload. 145884cd9327SGabe Black 1459c609719bSwdenk- Keyboard Support: 1460c609719bSwdenk CONFIG_ISA_KEYBOARD 1461c609719bSwdenk 1462c609719bSwdenk Define this to enable standard (PC-Style) keyboard 1463c609719bSwdenk support 1464c609719bSwdenk 1465c609719bSwdenk CONFIG_I8042_KBD 1466c609719bSwdenk Standard PC keyboard driver with US (is default) and 1467c609719bSwdenk GERMAN key layout (switch via environment 'keymap=de') support. 1468c609719bSwdenk Export function i8042_kbd_init, i8042_tstc and i8042_getc 1469c609719bSwdenk for cfb_console. Supports cursor blinking. 1470c609719bSwdenk 1471713cb680SHung-ying Tyan CONFIG_CROS_EC_KEYB 1472713cb680SHung-ying Tyan Enables a Chrome OS keyboard using the CROS_EC interface. 1473713cb680SHung-ying Tyan This uses CROS_EC to communicate with a second microcontroller 1474713cb680SHung-ying Tyan which provides key scans on request. 1475713cb680SHung-ying Tyan 1476c609719bSwdenk- Video support: 1477c609719bSwdenk CONFIG_VIDEO 1478c609719bSwdenk 1479c609719bSwdenk Define this to enable video support (for output to 1480c609719bSwdenk video). 1481c609719bSwdenk 1482c609719bSwdenk CONFIG_VIDEO_CT69000 1483c609719bSwdenk 1484c609719bSwdenk Enable Chips & Technologies 69000 Video chip 1485c609719bSwdenk 1486c609719bSwdenk CONFIG_VIDEO_SMI_LYNXEM 1487eeb1b77bSwdenk Enable Silicon Motion SMI 712/710/810 Video chip. The 1488eeb1b77bSwdenk video output is selected via environment 'videoout' 1489eeb1b77bSwdenk (1 = LCD and 2 = CRT). If videoout is undefined, CRT is 1490eeb1b77bSwdenk assumed. 1491c609719bSwdenk 1492eeb1b77bSwdenk For the CT69000 and SMI_LYNXEM drivers, videomode is 149311ccc33fSMarcel Ziswiler selected via environment 'videomode'. Two different ways 1494eeb1b77bSwdenk are possible: 1495eeb1b77bSwdenk - "videomode=num" 'num' is a standard LiLo mode numbers. 1496eeb1b77bSwdenk Following standard modes are supported (* is default): 1497eeb1b77bSwdenk 1498eeb1b77bSwdenk Colors 640x480 800x600 1024x768 1152x864 1280x1024 1499eeb1b77bSwdenk -------------+--------------------------------------------- 1500eeb1b77bSwdenk 8 bits | 0x301* 0x303 0x305 0x161 0x307 1501eeb1b77bSwdenk 15 bits | 0x310 0x313 0x316 0x162 0x319 1502eeb1b77bSwdenk 16 bits | 0x311 0x314 0x317 0x163 0x31A 1503eeb1b77bSwdenk 24 bits | 0x312 0x315 0x318 ? 0x31B 1504eeb1b77bSwdenk -------------+--------------------------------------------- 1505c609719bSwdenk (i.e. setenv videomode 317; saveenv; reset;) 1506c609719bSwdenk 1507eeb1b77bSwdenk - "videomode=bootargs" all the video parameters are parsed 15087817cb20SMarcel Ziswiler from the bootargs. (See drivers/video/videomodes.c) 1509eeb1b77bSwdenk 1510eeb1b77bSwdenk 1511a6c7ad2fSwdenk CONFIG_VIDEO_SED13806 1512a6c7ad2fSwdenk Enable Epson SED13806 driver. This driver supports 8bpp 1513a6c7ad2fSwdenk and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP 1514a6c7ad2fSwdenk or CONFIG_VIDEO_SED13806_16BPP 1515a6c7ad2fSwdenk 15167d3053fbSTimur Tabi CONFIG_FSL_DIU_FB 15177d3053fbSTimur Tabi Enable the Freescale DIU video driver. Reference boards for 15187d3053fbSTimur Tabi SOCs that have a DIU should define this macro to enable DIU 15197d3053fbSTimur Tabi support, and should also define these other macros: 15207d3053fbSTimur Tabi 15217d3053fbSTimur Tabi CONFIG_SYS_DIU_ADDR 15227d3053fbSTimur Tabi CONFIG_VIDEO 15237d3053fbSTimur Tabi CONFIG_CMD_BMP 15247d3053fbSTimur Tabi CONFIG_CFB_CONSOLE 15257d3053fbSTimur Tabi CONFIG_VIDEO_SW_CURSOR 15267d3053fbSTimur Tabi CONFIG_VGA_AS_SINGLE_DEVICE 15277d3053fbSTimur Tabi CONFIG_VIDEO_LOGO 15287d3053fbSTimur Tabi CONFIG_VIDEO_BMP_LOGO 15297d3053fbSTimur Tabi 1530ba8e76bdSTimur Tabi The DIU driver will look for the 'video-mode' environment 1531ba8e76bdSTimur Tabi variable, and if defined, enable the DIU as a console during 1532ba8e76bdSTimur Tabi boot. See the documentation file README.video for a 1533ba8e76bdSTimur Tabi description of this variable. 15347d3053fbSTimur Tabi 1535058d59b0SSimon Glass CONFIG_VIDEO_VGA 1536058d59b0SSimon Glass 1537058d59b0SSimon Glass Enable the VGA video / BIOS for x86. The alternative if you 1538058d59b0SSimon Glass are using coreboot is to use the coreboot frame buffer 1539058d59b0SSimon Glass driver. 1540058d59b0SSimon Glass 1541058d59b0SSimon Glass 1542682011ffSwdenk- Keyboard Support: 1543682011ffSwdenk CONFIG_KEYBOARD 1544682011ffSwdenk 1545682011ffSwdenk Define this to enable a custom keyboard support. 1546682011ffSwdenk This simply calls drv_keyboard_init() which must be 1547682011ffSwdenk defined in your board-specific files. 1548682011ffSwdenk The only board using this so far is RBC823. 1549a6c7ad2fSwdenk 1550c609719bSwdenk- LCD Support: CONFIG_LCD 1551c609719bSwdenk 1552c609719bSwdenk Define this to enable LCD support (for output to LCD 1553c609719bSwdenk display); also select one of the supported displays 1554c609719bSwdenk by defining one of these: 1555c609719bSwdenk 155639cf4804SStelian Pop CONFIG_ATMEL_LCD: 155739cf4804SStelian Pop 155839cf4804SStelian Pop HITACHI TX09D70VM1CCA, 3.5", 240x320. 155939cf4804SStelian Pop 1560fd3103bbSwdenk CONFIG_NEC_NL6448AC33: 1561c609719bSwdenk 1562fd3103bbSwdenk NEC NL6448AC33-18. Active, color, single scan. 1563c609719bSwdenk 1564fd3103bbSwdenk CONFIG_NEC_NL6448BC20 1565c609719bSwdenk 1566fd3103bbSwdenk NEC NL6448BC20-08. 6.5", 640x480. 1567fd3103bbSwdenk Active, color, single scan. 1568fd3103bbSwdenk 1569fd3103bbSwdenk CONFIG_NEC_NL6448BC33_54 1570fd3103bbSwdenk 1571fd3103bbSwdenk NEC NL6448BC33-54. 10.4", 640x480. 1572c609719bSwdenk Active, color, single scan. 1573c609719bSwdenk 1574c609719bSwdenk CONFIG_SHARP_16x9 1575c609719bSwdenk 1576c609719bSwdenk Sharp 320x240. Active, color, single scan. 1577c609719bSwdenk It isn't 16x9, and I am not sure what it is. 1578c609719bSwdenk 1579c609719bSwdenk CONFIG_SHARP_LQ64D341 1580c609719bSwdenk 1581c609719bSwdenk Sharp LQ64D341 display, 640x480. 1582c609719bSwdenk Active, color, single scan. 1583c609719bSwdenk 1584c609719bSwdenk CONFIG_HLD1045 1585c609719bSwdenk 1586c609719bSwdenk HLD1045 display, 640x480. 1587c609719bSwdenk Active, color, single scan. 1588c609719bSwdenk 1589c609719bSwdenk CONFIG_OPTREX_BW 1590c609719bSwdenk 1591c609719bSwdenk Optrex CBL50840-2 NF-FW 99 22 M5 1592c609719bSwdenk or 1593c609719bSwdenk Hitachi LMG6912RPFC-00T 1594c609719bSwdenk or 1595c609719bSwdenk Hitachi SP14Q002 1596c609719bSwdenk 1597c609719bSwdenk 320x240. Black & white. 1598c609719bSwdenk 1599c609719bSwdenk Normally display is black on white background; define 16006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_WHITE_ON_BLACK to get it inverted. 1601c609719bSwdenk 1602676d319eSSimon Glass CONFIG_LCD_ALIGNMENT 1603676d319eSSimon Glass 1604676d319eSSimon Glass Normally the LCD is page-aligned (tyically 4KB). If this is 1605676d319eSSimon Glass defined then the LCD will be aligned to this value instead. 1606676d319eSSimon Glass For ARM it is sometimes useful to use MMU_SECTION_SIZE 1607676d319eSSimon Glass here, since it is cheaper to change data cache settings on 1608676d319eSSimon Glass a per-section basis. 1609676d319eSSimon Glass 16100d89efefSSimon Glass CONFIG_CONSOLE_SCROLL_LINES 16110d89efefSSimon Glass 16120d89efefSSimon Glass When the console need to be scrolled, this is the number of 16130d89efefSSimon Glass lines to scroll by. It defaults to 1. Increasing this makes 16140d89efefSSimon Glass the console jump but can help speed up operation when scrolling 16150d89efefSSimon Glass is slow. 1616676d319eSSimon Glass 161745d7f525STom Wai-Hong Tam CONFIG_LCD_BMP_RLE8 161845d7f525STom Wai-Hong Tam 161945d7f525STom Wai-Hong Tam Support drawing of RLE8-compressed bitmaps on the LCD. 162045d7f525STom Wai-Hong Tam 1621735987c5STom Wai-Hong Tam CONFIG_I2C_EDID 1622735987c5STom Wai-Hong Tam 1623735987c5STom Wai-Hong Tam Enables an 'i2c edid' command which can read EDID 1624735987c5STom Wai-Hong Tam information over I2C from an attached LCD display. 1625735987c5STom Wai-Hong Tam 16267152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN 1627d791b1dcSwdenk 1628d791b1dcSwdenk If this option is set, the environment is checked for 1629d791b1dcSwdenk a variable "splashimage". If found, the usual display 1630d791b1dcSwdenk of logo, copyright and system information on the LCD 1631e94d2cd9Swdenk is suppressed and the BMP image at the address 1632d791b1dcSwdenk specified in "splashimage" is loaded instead. The 1633d791b1dcSwdenk console is redirected to the "nulldev", too. This 1634d791b1dcSwdenk allows for a "silent" boot where a splash screen is 1635d791b1dcSwdenk loaded very quickly after power-on. 1636d791b1dcSwdenk 1637c0880485SNikita Kiryanov CONFIG_SPLASHIMAGE_GUARD 1638c0880485SNikita Kiryanov 1639c0880485SNikita Kiryanov If this option is set, then U-Boot will prevent the environment 1640c0880485SNikita Kiryanov variable "splashimage" from being set to a problematic address 1641c0880485SNikita Kiryanov (see README.displaying-bmps and README.arm-unaligned-accesses). 1642c0880485SNikita Kiryanov This option is useful for targets where, due to alignment 1643c0880485SNikita Kiryanov restrictions, an improperly aligned BMP image will cause a data 1644c0880485SNikita Kiryanov abort. If you think you will not have problems with unaligned 1645c0880485SNikita Kiryanov accesses (for example because your toolchain prevents them) 1646c0880485SNikita Kiryanov there is no need to set this option. 1647c0880485SNikita Kiryanov 16481ca298ceSMatthias Weisser CONFIG_SPLASH_SCREEN_ALIGN 16491ca298ceSMatthias Weisser 16501ca298ceSMatthias Weisser If this option is set the splash image can be freely positioned 16511ca298ceSMatthias Weisser on the screen. Environment variable "splashpos" specifies the 16521ca298ceSMatthias Weisser position as "x,y". If a positive number is given it is used as 16531ca298ceSMatthias Weisser number of pixel from left/top. If a negative number is given it 16541ca298ceSMatthias Weisser is used as number of pixel from right/bottom. You can also 16551ca298ceSMatthias Weisser specify 'm' for centering the image. 16561ca298ceSMatthias Weisser 16571ca298ceSMatthias Weisser Example: 16581ca298ceSMatthias Weisser setenv splashpos m,m 16591ca298ceSMatthias Weisser => image at center of screen 16601ca298ceSMatthias Weisser 16611ca298ceSMatthias Weisser setenv splashpos 30,20 16621ca298ceSMatthias Weisser => image at x = 30 and y = 20 16631ca298ceSMatthias Weisser 16641ca298ceSMatthias Weisser setenv splashpos -10,m 16651ca298ceSMatthias Weisser => vertically centered image 16661ca298ceSMatthias Weisser at x = dspWidth - bmpWidth - 9 16671ca298ceSMatthias Weisser 166898f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP 166998f4a3dfSStefan Roese 167098f4a3dfSStefan Roese If this option is set, additionally to standard BMP 167198f4a3dfSStefan Roese images, gzipped BMP images can be displayed via the 167298f4a3dfSStefan Roese splashscreen support or the bmp command. 167398f4a3dfSStefan Roese 1674d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8 1675d5011762SAnatolij Gustschin 1676d5011762SAnatolij Gustschin If this option is set, 8-bit RLE compressed BMP images 1677d5011762SAnatolij Gustschin can be displayed via the splashscreen support or the 1678d5011762SAnatolij Gustschin bmp command. 1679d5011762SAnatolij Gustschin 1680f2b96dfbSLei Wen- Do compresssing for memory range: 1681f2b96dfbSLei Wen CONFIG_CMD_ZIP 1682f2b96dfbSLei Wen 1683f2b96dfbSLei Wen If this option is set, it would use zlib deflate method 1684f2b96dfbSLei Wen to compress the specified memory at its best effort. 1685f2b96dfbSLei Wen 1686c29fdfc1Swdenk- Compression support: 1687c29fdfc1Swdenk CONFIG_BZIP2 1688c29fdfc1Swdenk 1689c29fdfc1Swdenk If this option is set, support for bzip2 compressed 1690c29fdfc1Swdenk images is included. If not, only uncompressed and gzip 1691c29fdfc1Swdenk compressed images are supported. 1692c29fdfc1Swdenk 1693c29fdfc1Swdenk NOTE: the bzip2 algorithm requires a lot of RAM, so 16946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should 1695c29fdfc1Swdenk be at least 4MB. 1696d791b1dcSwdenk 1697fc9c1727SLuigi 'Comio' Mantellini CONFIG_LZMA 1698fc9c1727SLuigi 'Comio' Mantellini 1699fc9c1727SLuigi 'Comio' Mantellini If this option is set, support for lzma compressed 1700fc9c1727SLuigi 'Comio' Mantellini images is included. 1701fc9c1727SLuigi 'Comio' Mantellini 1702fc9c1727SLuigi 'Comio' Mantellini Note: The LZMA algorithm adds between 2 and 4KB of code and it 1703fc9c1727SLuigi 'Comio' Mantellini requires an amount of dynamic memory that is given by the 1704fc9c1727SLuigi 'Comio' Mantellini formula: 1705fc9c1727SLuigi 'Comio' Mantellini 1706fc9c1727SLuigi 'Comio' Mantellini (1846 + 768 << (lc + lp)) * sizeof(uint16) 1707fc9c1727SLuigi 'Comio' Mantellini 1708fc9c1727SLuigi 'Comio' Mantellini Where lc and lp stand for, respectively, Literal context bits 1709fc9c1727SLuigi 'Comio' Mantellini and Literal pos bits. 1710fc9c1727SLuigi 'Comio' Mantellini 1711fc9c1727SLuigi 'Comio' Mantellini This value is upper-bounded by 14MB in the worst case. Anyway, 1712fc9c1727SLuigi 'Comio' Mantellini for a ~4MB large kernel image, we have lc=3 and lp=0 for a 1713fc9c1727SLuigi 'Comio' Mantellini total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is 1714fc9c1727SLuigi 'Comio' Mantellini a very small buffer. 1715fc9c1727SLuigi 'Comio' Mantellini 1716fc9c1727SLuigi 'Comio' Mantellini Use the lzmainfo tool to determinate the lc and lp values and 1717fc9c1727SLuigi 'Comio' Mantellini then calculate the amount of needed dynamic memory (ensuring 17186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD the appropriate CONFIG_SYS_MALLOC_LEN value). 1719fc9c1727SLuigi 'Comio' Mantellini 172017ea1177Swdenk- MII/PHY support: 172117ea1177Swdenk CONFIG_PHY_ADDR 172217ea1177Swdenk 172317ea1177Swdenk The address of PHY on MII bus. 172417ea1177Swdenk 172517ea1177Swdenk CONFIG_PHY_CLOCK_FREQ (ppc4xx) 172617ea1177Swdenk 172717ea1177Swdenk The clock frequency of the MII bus 172817ea1177Swdenk 172917ea1177Swdenk CONFIG_PHY_GIGE 173017ea1177Swdenk 173117ea1177Swdenk If this option is set, support for speed/duplex 173211ccc33fSMarcel Ziswiler detection of gigabit PHY is included. 173317ea1177Swdenk 173417ea1177Swdenk CONFIG_PHY_RESET_DELAY 173517ea1177Swdenk 173617ea1177Swdenk Some PHY like Intel LXT971A need extra delay after 173717ea1177Swdenk reset before any MII register access is possible. 173817ea1177Swdenk For such PHY, set this option to the usec delay 173917ea1177Swdenk required. (minimum 300usec for LXT971A) 174017ea1177Swdenk 174117ea1177Swdenk CONFIG_PHY_CMD_DELAY (ppc4xx) 174217ea1177Swdenk 174317ea1177Swdenk Some PHY like Intel LXT971A need extra delay after 174417ea1177Swdenk command issued before MII status register can be read 174517ea1177Swdenk 1746c609719bSwdenk- Ethernet address: 1747c609719bSwdenk CONFIG_ETHADDR 1748c68a05feSrichardretanubun CONFIG_ETH1ADDR 1749c609719bSwdenk CONFIG_ETH2ADDR 1750c609719bSwdenk CONFIG_ETH3ADDR 1751c68a05feSrichardretanubun CONFIG_ETH4ADDR 1752c68a05feSrichardretanubun CONFIG_ETH5ADDR 1753c609719bSwdenk 175411ccc33fSMarcel Ziswiler Define a default value for Ethernet address to use 175511ccc33fSMarcel Ziswiler for the respective Ethernet interface, in case this 1756c609719bSwdenk is not determined automatically. 1757c609719bSwdenk 1758c609719bSwdenk- IP address: 1759c609719bSwdenk CONFIG_IPADDR 1760c609719bSwdenk 1761c609719bSwdenk Define a default value for the IP address to use for 176211ccc33fSMarcel Ziswiler the default Ethernet interface, in case this is not 1763c609719bSwdenk determined through e.g. bootp. 17641ebcd654SWolfgang Denk (Environment variable "ipaddr") 1765c609719bSwdenk 1766c609719bSwdenk- Server IP address: 1767c609719bSwdenk CONFIG_SERVERIP 1768c609719bSwdenk 1769c609719bSwdenk Defines a default value for the IP address of a TFTP 1770c609719bSwdenk server to contact when using the "tftboot" command. 17711ebcd654SWolfgang Denk (Environment variable "serverip") 1772c609719bSwdenk 177397cfe861SRobin Getz CONFIG_KEEP_SERVERADDR 177497cfe861SRobin Getz 177597cfe861SRobin Getz Keeps the server's MAC address, in the env 'serveraddr' 177697cfe861SRobin Getz for passing to bootargs (like Linux's netconsole option) 177797cfe861SRobin Getz 17781ebcd654SWolfgang Denk- Gateway IP address: 17791ebcd654SWolfgang Denk CONFIG_GATEWAYIP 17801ebcd654SWolfgang Denk 17811ebcd654SWolfgang Denk Defines a default value for the IP address of the 17821ebcd654SWolfgang Denk default router where packets to other networks are 17831ebcd654SWolfgang Denk sent to. 17841ebcd654SWolfgang Denk (Environment variable "gatewayip") 17851ebcd654SWolfgang Denk 17861ebcd654SWolfgang Denk- Subnet mask: 17871ebcd654SWolfgang Denk CONFIG_NETMASK 17881ebcd654SWolfgang Denk 17891ebcd654SWolfgang Denk Defines a default value for the subnet mask (or 17901ebcd654SWolfgang Denk routing prefix) which is used to determine if an IP 17911ebcd654SWolfgang Denk address belongs to the local subnet or needs to be 17921ebcd654SWolfgang Denk forwarded through a router. 17931ebcd654SWolfgang Denk (Environment variable "netmask") 17941ebcd654SWolfgang Denk 179553a5c424SDavid Updegraff- Multicast TFTP Mode: 179653a5c424SDavid Updegraff CONFIG_MCAST_TFTP 179753a5c424SDavid Updegraff 179853a5c424SDavid Updegraff Defines whether you want to support multicast TFTP as per 179953a5c424SDavid Updegraff rfc-2090; for example to work with atftp. Lets lots of targets 180011ccc33fSMarcel Ziswiler tftp down the same boot image concurrently. Note: the Ethernet 180153a5c424SDavid Updegraff driver in use must provide a function: mcast() to join/leave a 180253a5c424SDavid Updegraff multicast group. 180353a5c424SDavid Updegraff 1804c609719bSwdenk- BOOTP Recovery Mode: 1805c609719bSwdenk CONFIG_BOOTP_RANDOM_DELAY 1806c609719bSwdenk 1807c609719bSwdenk If you have many targets in a network that try to 1808c609719bSwdenk boot using BOOTP, you may want to avoid that all 1809c609719bSwdenk systems send out BOOTP requests at precisely the same 1810c609719bSwdenk moment (which would happen for instance at recovery 1811c609719bSwdenk from a power failure, when all systems will try to 1812c609719bSwdenk boot, thus flooding the BOOTP server. Defining 1813c609719bSwdenk CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be 1814c609719bSwdenk inserted before sending out BOOTP requests. The 18156c33c785SWolfgang Denk following delays are inserted then: 1816c609719bSwdenk 1817c609719bSwdenk 1st BOOTP request: delay 0 ... 1 sec 1818c609719bSwdenk 2nd BOOTP request: delay 0 ... 2 sec 1819c609719bSwdenk 3rd BOOTP request: delay 0 ... 4 sec 1820c609719bSwdenk 4th and following 1821c609719bSwdenk BOOTP requests: delay 0 ... 8 sec 1822c609719bSwdenk 1823fe389a82Sstroese- DHCP Advanced Options: 18241fe80d79SJon Loeliger You can fine tune the DHCP functionality by defining 18251fe80d79SJon Loeliger CONFIG_BOOTP_* symbols: 1826fe389a82Sstroese 18271fe80d79SJon Loeliger CONFIG_BOOTP_SUBNETMASK 18281fe80d79SJon Loeliger CONFIG_BOOTP_GATEWAY 18291fe80d79SJon Loeliger CONFIG_BOOTP_HOSTNAME 18301fe80d79SJon Loeliger CONFIG_BOOTP_NISDOMAIN 18311fe80d79SJon Loeliger CONFIG_BOOTP_BOOTPATH 18321fe80d79SJon Loeliger CONFIG_BOOTP_BOOTFILESIZE 18331fe80d79SJon Loeliger CONFIG_BOOTP_DNS 18341fe80d79SJon Loeliger CONFIG_BOOTP_DNS2 18351fe80d79SJon Loeliger CONFIG_BOOTP_SEND_HOSTNAME 18361fe80d79SJon Loeliger CONFIG_BOOTP_NTPSERVER 18371fe80d79SJon Loeliger CONFIG_BOOTP_TIMEOFFSET 18381fe80d79SJon Loeliger CONFIG_BOOTP_VENDOREX 18392c00e099SJoe Hershberger CONFIG_BOOTP_MAY_FAIL 1840fe389a82Sstroese 18415d110f0aSWilson Callan CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip 18425d110f0aSWilson Callan environment variable, not the BOOTP server. 1843fe389a82Sstroese 18442c00e099SJoe Hershberger CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found 18452c00e099SJoe Hershberger after the configured retry count, the call will fail 18462c00e099SJoe Hershberger instead of starting over. This can be used to fail over 18472c00e099SJoe Hershberger to Link-local IP address configuration if the DHCP server 18482c00e099SJoe Hershberger is not available. 18492c00e099SJoe Hershberger 1850fe389a82Sstroese CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS 1851fe389a82Sstroese serverip from a DHCP server, it is possible that more 1852fe389a82Sstroese than one DNS serverip is offered to the client. 1853fe389a82Sstroese If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS 1854fe389a82Sstroese serverip will be stored in the additional environment 1855fe389a82Sstroese variable "dnsip2". The first DNS serverip is always 1856fe389a82Sstroese stored in the variable "dnsip", when CONFIG_BOOTP_DNS 18571fe80d79SJon Loeliger is defined. 1858fe389a82Sstroese 1859fe389a82Sstroese CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable 1860fe389a82Sstroese to do a dynamic update of a DNS server. To do this, they 1861fe389a82Sstroese need the hostname of the DHCP requester. 18625d110f0aSWilson Callan If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content 18631fe80d79SJon Loeliger of the "hostname" environment variable is passed as 18641fe80d79SJon Loeliger option 12 to the DHCP server. 1865fe389a82Sstroese 1866d9a2f416SAras Vaichas CONFIG_BOOTP_DHCP_REQUEST_DELAY 1867d9a2f416SAras Vaichas 1868d9a2f416SAras Vaichas A 32bit value in microseconds for a delay between 1869d9a2f416SAras Vaichas receiving a "DHCP Offer" and sending the "DHCP Request". 1870d9a2f416SAras Vaichas This fixes a problem with certain DHCP servers that don't 1871d9a2f416SAras Vaichas respond 100% of the time to a "DHCP request". E.g. On an 1872d9a2f416SAras Vaichas AT91RM9200 processor running at 180MHz, this delay needed 1873d9a2f416SAras Vaichas to be *at least* 15,000 usec before a Windows Server 2003 1874d9a2f416SAras Vaichas DHCP server would reply 100% of the time. I recommend at 1875d9a2f416SAras Vaichas least 50,000 usec to be safe. The alternative is to hope 1876d9a2f416SAras Vaichas that one of the retries will be successful but note that 1877d9a2f416SAras Vaichas the DHCP timeout and retry process takes a longer than 1878d9a2f416SAras Vaichas this delay. 1879d9a2f416SAras Vaichas 1880d22c338eSJoe Hershberger - Link-local IP address negotiation: 1881d22c338eSJoe Hershberger Negotiate with other link-local clients on the local network 1882d22c338eSJoe Hershberger for an address that doesn't require explicit configuration. 1883d22c338eSJoe Hershberger This is especially useful if a DHCP server cannot be guaranteed 1884d22c338eSJoe Hershberger to exist in all environments that the device must operate. 1885d22c338eSJoe Hershberger 1886d22c338eSJoe Hershberger See doc/README.link-local for more information. 1887d22c338eSJoe Hershberger 1888a3d991bdSwdenk - CDP Options: 1889a3d991bdSwdenk CONFIG_CDP_DEVICE_ID 1890a3d991bdSwdenk 1891a3d991bdSwdenk The device id used in CDP trigger frames. 1892a3d991bdSwdenk 1893a3d991bdSwdenk CONFIG_CDP_DEVICE_ID_PREFIX 1894a3d991bdSwdenk 1895a3d991bdSwdenk A two character string which is prefixed to the MAC address 1896a3d991bdSwdenk of the device. 1897a3d991bdSwdenk 1898a3d991bdSwdenk CONFIG_CDP_PORT_ID 1899a3d991bdSwdenk 1900a3d991bdSwdenk A printf format string which contains the ascii name of 1901a3d991bdSwdenk the port. Normally is set to "eth%d" which sets 190211ccc33fSMarcel Ziswiler eth0 for the first Ethernet, eth1 for the second etc. 1903a3d991bdSwdenk 1904a3d991bdSwdenk CONFIG_CDP_CAPABILITIES 1905a3d991bdSwdenk 1906a3d991bdSwdenk A 32bit integer which indicates the device capabilities; 1907a3d991bdSwdenk 0x00000010 for a normal host which does not forwards. 1908a3d991bdSwdenk 1909a3d991bdSwdenk CONFIG_CDP_VERSION 1910a3d991bdSwdenk 1911a3d991bdSwdenk An ascii string containing the version of the software. 1912a3d991bdSwdenk 1913a3d991bdSwdenk CONFIG_CDP_PLATFORM 1914a3d991bdSwdenk 1915a3d991bdSwdenk An ascii string containing the name of the platform. 1916a3d991bdSwdenk 1917a3d991bdSwdenk CONFIG_CDP_TRIGGER 1918a3d991bdSwdenk 1919a3d991bdSwdenk A 32bit integer sent on the trigger. 1920a3d991bdSwdenk 1921a3d991bdSwdenk CONFIG_CDP_POWER_CONSUMPTION 1922a3d991bdSwdenk 1923a3d991bdSwdenk A 16bit integer containing the power consumption of the 1924a3d991bdSwdenk device in .1 of milliwatts. 1925a3d991bdSwdenk 1926a3d991bdSwdenk CONFIG_CDP_APPLIANCE_VLAN_TYPE 1927a3d991bdSwdenk 1928a3d991bdSwdenk A byte containing the id of the VLAN. 1929a3d991bdSwdenk 1930c609719bSwdenk- Status LED: CONFIG_STATUS_LED 1931c609719bSwdenk 1932c609719bSwdenk Several configurations allow to display the current 1933c609719bSwdenk status using a LED. For instance, the LED will blink 1934c609719bSwdenk fast while running U-Boot code, stop blinking as 1935c609719bSwdenk soon as a reply to a BOOTP request was received, and 1936c609719bSwdenk start blinking slow once the Linux kernel is running 1937c609719bSwdenk (supported by a status LED driver in the Linux 1938c609719bSwdenk kernel). Defining CONFIG_STATUS_LED enables this 1939c609719bSwdenk feature in U-Boot. 1940c609719bSwdenk 1941c609719bSwdenk- CAN Support: CONFIG_CAN_DRIVER 1942c609719bSwdenk 1943c609719bSwdenk Defining CONFIG_CAN_DRIVER enables CAN driver support 1944c609719bSwdenk on those systems that support this (optional) 1945c609719bSwdenk feature, like the TQM8xxL modules. 1946c609719bSwdenk 19473f4978c7SHeiko Schocher- I2C Support: CONFIG_SYS_I2C 1948c609719bSwdenk 19493f4978c7SHeiko Schocher This enable the NEW i2c subsystem, and will allow you to use 19503f4978c7SHeiko Schocher i2c commands at the u-boot command line (as long as you set 19513f4978c7SHeiko Schocher CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c 19523f4978c7SHeiko Schocher based realtime clock chips or other i2c devices. See 19533f4978c7SHeiko Schocher common/cmd_i2c.c for a description of the command line 19543f4978c7SHeiko Schocher interface. 19553f4978c7SHeiko Schocher 19563f4978c7SHeiko Schocher ported i2c driver to the new framework: 1957ea818dbbSHeiko Schocher - drivers/i2c/soft_i2c.c: 1958ea818dbbSHeiko Schocher - activate first bus with CONFIG_SYS_I2C_SOFT define 1959ea818dbbSHeiko Schocher CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE 1960ea818dbbSHeiko Schocher for defining speed and slave address 1961ea818dbbSHeiko Schocher - activate second bus with I2C_SOFT_DECLARATIONS2 define 1962ea818dbbSHeiko Schocher CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2 1963ea818dbbSHeiko Schocher for defining speed and slave address 1964ea818dbbSHeiko Schocher - activate third bus with I2C_SOFT_DECLARATIONS3 define 1965ea818dbbSHeiko Schocher CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3 1966ea818dbbSHeiko Schocher for defining speed and slave address 1967ea818dbbSHeiko Schocher - activate fourth bus with I2C_SOFT_DECLARATIONS4 define 1968ea818dbbSHeiko Schocher CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4 1969ea818dbbSHeiko Schocher for defining speed and slave address 19703f4978c7SHeiko Schocher 197100f792e0SHeiko Schocher - drivers/i2c/fsl_i2c.c: 197200f792e0SHeiko Schocher - activate i2c driver with CONFIG_SYS_I2C_FSL 197300f792e0SHeiko Schocher define CONFIG_SYS_FSL_I2C_OFFSET for setting the register 197400f792e0SHeiko Schocher offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and 197500f792e0SHeiko Schocher CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first 197600f792e0SHeiko Schocher bus. 197700f792e0SHeiko Schocher - If your board supports a second fsl i2c bus, define 197800f792e0SHeiko Schocher CONFIG_SYS_FSL_I2C2_OFFSET for the register offset 197900f792e0SHeiko Schocher CONFIG_SYS_FSL_I2C2_SPEED for the speed and 198000f792e0SHeiko Schocher CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the 198100f792e0SHeiko Schocher second bus. 198200f792e0SHeiko Schocher 19831f2ba722SSimon Glass - drivers/i2c/tegra_i2c.c: 19841f2ba722SSimon Glass - activate this driver with CONFIG_SYS_I2C_TEGRA 19851f2ba722SSimon Glass - This driver adds 4 i2c buses with a fix speed from 19861f2ba722SSimon Glass 100000 and the slave addr 0! 19871f2ba722SSimon Glass 1988*880540deSDirk Eibach - drivers/i2c/ppc4xx_i2c.c 1989*880540deSDirk Eibach - activate this driver with CONFIG_SYS_I2C_PPC4XX 1990*880540deSDirk Eibach - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0 1991*880540deSDirk Eibach - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1 1992*880540deSDirk Eibach 19933f4978c7SHeiko Schocher additional defines: 19943f4978c7SHeiko Schocher 19953f4978c7SHeiko Schocher CONFIG_SYS_NUM_I2C_BUSES 19963f4978c7SHeiko Schocher Hold the number of i2c busses you want to use. If you 19973f4978c7SHeiko Schocher don't use/have i2c muxes on your i2c bus, this 19983f4978c7SHeiko Schocher is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can 19993f4978c7SHeiko Schocher omit this define. 20003f4978c7SHeiko Schocher 20013f4978c7SHeiko Schocher CONFIG_SYS_I2C_DIRECT_BUS 20023f4978c7SHeiko Schocher define this, if you don't use i2c muxes on your hardware. 20033f4978c7SHeiko Schocher if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can 20043f4978c7SHeiko Schocher omit this define. 20053f4978c7SHeiko Schocher 20063f4978c7SHeiko Schocher CONFIG_SYS_I2C_MAX_HOPS 20073f4978c7SHeiko Schocher define how many muxes are maximal consecutively connected 20083f4978c7SHeiko Schocher on one i2c bus. If you not use i2c muxes, omit this 20093f4978c7SHeiko Schocher define. 20103f4978c7SHeiko Schocher 20113f4978c7SHeiko Schocher CONFIG_SYS_I2C_BUSES 20123f4978c7SHeiko Schocher hold a list of busses you want to use, only used if 20133f4978c7SHeiko Schocher CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example 20143f4978c7SHeiko Schocher a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and 20153f4978c7SHeiko Schocher CONFIG_SYS_NUM_I2C_BUSES = 9: 20163f4978c7SHeiko Schocher 20173f4978c7SHeiko Schocher CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \ 20183f4978c7SHeiko Schocher {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \ 20193f4978c7SHeiko Schocher {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \ 20203f4978c7SHeiko Schocher {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \ 20213f4978c7SHeiko Schocher {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \ 20223f4978c7SHeiko Schocher {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \ 20233f4978c7SHeiko Schocher {1, {I2C_NULL_HOP}}, \ 20243f4978c7SHeiko Schocher {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \ 20253f4978c7SHeiko Schocher {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \ 20263f4978c7SHeiko Schocher } 20273f4978c7SHeiko Schocher 20283f4978c7SHeiko Schocher which defines 20293f4978c7SHeiko Schocher bus 0 on adapter 0 without a mux 2030ea818dbbSHeiko Schocher bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1 2031ea818dbbSHeiko Schocher bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2 2032ea818dbbSHeiko Schocher bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3 2033ea818dbbSHeiko Schocher bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4 2034ea818dbbSHeiko Schocher bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5 20353f4978c7SHeiko Schocher bus 6 on adapter 1 without a mux 2036ea818dbbSHeiko Schocher bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1 2037ea818dbbSHeiko Schocher bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2 20383f4978c7SHeiko Schocher 20393f4978c7SHeiko Schocher If you do not have i2c muxes on your board, omit this define. 20403f4978c7SHeiko Schocher 2041ea818dbbSHeiko Schocher- Legacy I2C Support: CONFIG_HARD_I2C 20423f4978c7SHeiko Schocher 20433f4978c7SHeiko Schocher NOTE: It is intended to move drivers to CONFIG_SYS_I2C which 20443f4978c7SHeiko Schocher provides the following compelling advantages: 20453f4978c7SHeiko Schocher 20463f4978c7SHeiko Schocher - more than one i2c adapter is usable 20473f4978c7SHeiko Schocher - approved multibus support 20483f4978c7SHeiko Schocher - better i2c mux support 20493f4978c7SHeiko Schocher 20503f4978c7SHeiko Schocher ** Please consider updating your I2C driver now. ** 20513f4978c7SHeiko Schocher 2052ea818dbbSHeiko Schocher These enable legacy I2C serial bus commands. Defining 2053ea818dbbSHeiko Schocher CONFIG_HARD_I2C will include the appropriate I2C driver 2054ea818dbbSHeiko Schocher for the selected CPU. 2055c609719bSwdenk 2056b37c7e5eSwdenk This will allow you to use i2c commands at the u-boot 2057602ad3b3SJon Loeliger command line (as long as you set CONFIG_CMD_I2C in 2058b37c7e5eSwdenk CONFIG_COMMANDS) and communicate with i2c based realtime 2059b37c7e5eSwdenk clock chips. See common/cmd_i2c.c for a description of the 2060c609719bSwdenk command line interface. 2061c609719bSwdenk 2062bb99ad6dSBen Warren CONFIG_HARD_I2C selects a hardware I2C controller. 2063c609719bSwdenk 2064b37c7e5eSwdenk There are several other quantities that must also be 2065ea818dbbSHeiko Schocher defined when you define CONFIG_HARD_I2C. 2066c609719bSwdenk 20676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD In both cases you will need to define CONFIG_SYS_I2C_SPEED 2068b37c7e5eSwdenk to be the frequency (in Hz) at which you wish your i2c bus 20696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie 207011ccc33fSMarcel Ziswiler the CPU's i2c node address). 2071c609719bSwdenk 20728d321b81SPeter Tyser Now, the u-boot i2c code for the mpc8xx 2073a47a12beSStefan Roese (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node 20748d321b81SPeter Tyser and so its address should therefore be cleared to 0 (See, 20758d321b81SPeter Tyser eg, MPC823e User's Manual p.16-473). So, set 20768d321b81SPeter Tyser CONFIG_SYS_I2C_SLAVE to 0. 2077b37c7e5eSwdenk 20785da71efaSEric Millbrandt CONFIG_SYS_I2C_INIT_MPC5XXX 20795da71efaSEric Millbrandt 20805da71efaSEric Millbrandt When a board is reset during an i2c bus transfer 20815da71efaSEric Millbrandt chips might think that the current transfer is still 20825da71efaSEric Millbrandt in progress. Reset the slave devices by sending start 20835da71efaSEric Millbrandt commands until the slave device responds. 20845da71efaSEric Millbrandt 2085b37c7e5eSwdenk That's all that's required for CONFIG_HARD_I2C. 2086b37c7e5eSwdenk 2087ea818dbbSHeiko Schocher If you use the software i2c interface (CONFIG_SYS_I2C_SOFT) 2088b37c7e5eSwdenk then the following macros need to be defined (examples are 2089b37c7e5eSwdenk from include/configs/lwmon.h): 2090c609719bSwdenk 2091c609719bSwdenk I2C_INIT 2092c609719bSwdenk 2093b37c7e5eSwdenk (Optional). Any commands necessary to enable the I2C 2094c609719bSwdenk controller or configure ports. 2095c609719bSwdenk 2096b37c7e5eSwdenk eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL) 2097b37c7e5eSwdenk 2098c609719bSwdenk I2C_PORT 2099c609719bSwdenk 2100c609719bSwdenk (Only for MPC8260 CPU). The I/O port to use (the code 2101c609719bSwdenk assumes both bits are on the same port). Valid values 2102c609719bSwdenk are 0..3 for ports A..D. 2103c609719bSwdenk 2104c609719bSwdenk I2C_ACTIVE 2105c609719bSwdenk 2106c609719bSwdenk The code necessary to make the I2C data line active 2107c609719bSwdenk (driven). If the data line is open collector, this 2108c609719bSwdenk define can be null. 2109c609719bSwdenk 2110b37c7e5eSwdenk eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA) 2111b37c7e5eSwdenk 2112c609719bSwdenk I2C_TRISTATE 2113c609719bSwdenk 2114c609719bSwdenk The code necessary to make the I2C data line tri-stated 2115c609719bSwdenk (inactive). If the data line is open collector, this 2116c609719bSwdenk define can be null. 2117c609719bSwdenk 2118b37c7e5eSwdenk eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA) 2119b37c7e5eSwdenk 2120c609719bSwdenk I2C_READ 2121c609719bSwdenk 2122472d5460SYork Sun Code that returns true if the I2C data line is high, 2123472d5460SYork Sun false if it is low. 2124c609719bSwdenk 2125b37c7e5eSwdenk eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0) 2126b37c7e5eSwdenk 2127c609719bSwdenk I2C_SDA(bit) 2128c609719bSwdenk 2129472d5460SYork Sun If <bit> is true, sets the I2C data line high. If it 2130472d5460SYork Sun is false, it clears it (low). 2131c609719bSwdenk 2132b37c7e5eSwdenk eg: #define I2C_SDA(bit) \ 2133b37c7e5eSwdenk if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \ 2134b37c7e5eSwdenk else immr->im_cpm.cp_pbdat &= ~PB_SDA 2135b37c7e5eSwdenk 2136c609719bSwdenk I2C_SCL(bit) 2137c609719bSwdenk 2138472d5460SYork Sun If <bit> is true, sets the I2C clock line high. If it 2139472d5460SYork Sun is false, it clears it (low). 2140c609719bSwdenk 2141b37c7e5eSwdenk eg: #define I2C_SCL(bit) \ 2142b37c7e5eSwdenk if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \ 2143b37c7e5eSwdenk else immr->im_cpm.cp_pbdat &= ~PB_SCL 2144b37c7e5eSwdenk 2145c609719bSwdenk I2C_DELAY 2146c609719bSwdenk 2147c609719bSwdenk This delay is invoked four times per clock cycle so this 2148c609719bSwdenk controls the rate of data transfer. The data rate thus 2149b37c7e5eSwdenk is 1 / (I2C_DELAY * 4). Often defined to be something 2150b37c7e5eSwdenk like: 2151b37c7e5eSwdenk 2152b37c7e5eSwdenk #define I2C_DELAY udelay(2) 2153c609719bSwdenk 2154793b5726SMike Frysinger CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA 2155793b5726SMike Frysinger 2156793b5726SMike Frysinger If your arch supports the generic GPIO framework (asm/gpio.h), 2157793b5726SMike Frysinger then you may alternatively define the two GPIOs that are to be 2158793b5726SMike Frysinger used as SCL / SDA. Any of the previous I2C_xxx macros will 2159793b5726SMike Frysinger have GPIO-based defaults assigned to them as appropriate. 2160793b5726SMike Frysinger 2161793b5726SMike Frysinger You should define these to the GPIO value as given directly to 2162793b5726SMike Frysinger the generic GPIO functions. 2163793b5726SMike Frysinger 21646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_INIT_BOARD 216547cd00faSwdenk 216647cd00faSwdenk When a board is reset during an i2c bus transfer 216747cd00faSwdenk chips might think that the current transfer is still 216847cd00faSwdenk in progress. On some boards it is possible to access 216947cd00faSwdenk the i2c SCLK line directly, either by using the 217047cd00faSwdenk processor pin as a GPIO or by having a second pin 217147cd00faSwdenk connected to the bus. If this option is defined a 217247cd00faSwdenk custom i2c_init_board() routine in boards/xxx/board.c 217347cd00faSwdenk is run early in the boot sequence. 217447cd00faSwdenk 217526a33504SRichard Retanubun CONFIG_SYS_I2C_BOARD_LATE_INIT 217626a33504SRichard Retanubun 217726a33504SRichard Retanubun An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is 217826a33504SRichard Retanubun defined a custom i2c_board_late_init() routine in 217926a33504SRichard Retanubun boards/xxx/board.c is run AFTER the operations in i2c_init() 218026a33504SRichard Retanubun is completed. This callpoint can be used to unreset i2c bus 218126a33504SRichard Retanubun using CPU i2c controller register accesses for CPUs whose i2c 218226a33504SRichard Retanubun controller provide such a method. It is called at the end of 218326a33504SRichard Retanubun i2c_init() to allow i2c_init operations to setup the i2c bus 218426a33504SRichard Retanubun controller on the CPU (e.g. setting bus speed & slave address). 218526a33504SRichard Retanubun 218617ea1177Swdenk CONFIG_I2CFAST (PPC405GP|PPC405EP only) 218717ea1177Swdenk 218817ea1177Swdenk This option enables configuration of bi_iic_fast[] flags 218917ea1177Swdenk in u-boot bd_info structure based on u-boot environment 219017ea1177Swdenk variable "i2cfast". (see also i2cfast) 219117ea1177Swdenk 2192bb99ad6dSBen Warren CONFIG_I2C_MULTI_BUS 2193bb99ad6dSBen Warren 2194bb99ad6dSBen Warren This option allows the use of multiple I2C buses, each of which 2195bb99ad6dSBen Warren must have a controller. At any point in time, only one bus is 2196bb99ad6dSBen Warren active. To switch to a different bus, use the 'i2c dev' command. 2197bb99ad6dSBen Warren Note that bus numbering is zero-based. 2198bb99ad6dSBen Warren 21996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_NOPROBES 2200bb99ad6dSBen Warren 2201bb99ad6dSBen Warren This option specifies a list of I2C devices that will be skipped 22020f89c54bSPeter Tyser when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS 22030f89c54bSPeter Tyser is set, specify a list of bus-device pairs. Otherwise, specify 22040f89c54bSPeter Tyser a 1D array of device addresses 2205bb99ad6dSBen Warren 2206bb99ad6dSBen Warren e.g. 2207bb99ad6dSBen Warren #undef CONFIG_I2C_MULTI_BUS 22086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68} 2209bb99ad6dSBen Warren 2210bb99ad6dSBen Warren will skip addresses 0x50 and 0x68 on a board with one I2C bus 2211bb99ad6dSBen Warren 2212bb99ad6dSBen Warren #define CONFIG_I2C_MULTI_BUS 22136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}} 2214bb99ad6dSBen Warren 2215bb99ad6dSBen Warren will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1 2216bb99ad6dSBen Warren 22176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SPD_BUS_NUM 2218be5e6181STimur Tabi 2219be5e6181STimur Tabi If defined, then this indicates the I2C bus number for DDR SPD. 2220be5e6181STimur Tabi If not defined, then U-Boot assumes that SPD is on I2C bus 0. 2221be5e6181STimur Tabi 22226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_RTC_BUS_NUM 22230dc018ecSStefan Roese 22240dc018ecSStefan Roese If defined, then this indicates the I2C bus number for the RTC. 22250dc018ecSStefan Roese If not defined, then U-Boot assumes that RTC is on I2C bus 0. 22260dc018ecSStefan Roese 22276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_DTT_BUS_NUM 22280dc018ecSStefan Roese 22290dc018ecSStefan Roese If defined, then this indicates the I2C bus number for the DTT. 22300dc018ecSStefan Roese If not defined, then U-Boot assumes that DTT is on I2C bus 0. 22310dc018ecSStefan Roese 22326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_DTT_ADDR: 22339ebbb54fSVictor Gallardo 22349ebbb54fSVictor Gallardo If defined, specifies the I2C address of the DTT device. 22359ebbb54fSVictor Gallardo If not defined, then U-Boot uses predefined value for 22369ebbb54fSVictor Gallardo specified DTT device. 22379ebbb54fSVictor Gallardo 22382ac6985aSAndrew Dyer CONFIG_SOFT_I2C_READ_REPEATED_START 22392ac6985aSAndrew Dyer 22402ac6985aSAndrew Dyer defining this will force the i2c_read() function in 22412ac6985aSAndrew Dyer the soft_i2c driver to perform an I2C repeated start 22422ac6985aSAndrew Dyer between writing the address pointer and reading the 22432ac6985aSAndrew Dyer data. If this define is omitted the default behaviour 22442ac6985aSAndrew Dyer of doing a stop-start sequence will be used. Most I2C 22452ac6985aSAndrew Dyer devices can use either method, but some require one or 22462ac6985aSAndrew Dyer the other. 2247be5e6181STimur Tabi 2248c609719bSwdenk- SPI Support: CONFIG_SPI 2249c609719bSwdenk 2250c609719bSwdenk Enables SPI driver (so far only tested with 2251c609719bSwdenk SPI EEPROM, also an instance works with Crystal A/D and 2252c609719bSwdenk D/As on the SACSng board) 2253c609719bSwdenk 22546639562eSYoshihiro Shimoda CONFIG_SH_SPI 22556639562eSYoshihiro Shimoda 22566639562eSYoshihiro Shimoda Enables the driver for SPI controller on SuperH. Currently 22576639562eSYoshihiro Shimoda only SH7757 is supported. 22586639562eSYoshihiro Shimoda 2259c609719bSwdenk CONFIG_SPI_X 2260c609719bSwdenk 2261c609719bSwdenk Enables extended (16-bit) SPI EEPROM addressing. 2262c609719bSwdenk (symmetrical to CONFIG_I2C_X) 2263c609719bSwdenk 2264c609719bSwdenk CONFIG_SOFT_SPI 2265c609719bSwdenk 2266c609719bSwdenk Enables a software (bit-bang) SPI driver rather than 2267c609719bSwdenk using hardware support. This is a general purpose 2268c609719bSwdenk driver that only requires three general I/O port pins 2269c609719bSwdenk (two outputs, one input) to function. If this is 2270c609719bSwdenk defined, the board configuration must define several 2271c609719bSwdenk SPI configuration items (port pins to use, etc). For 2272c609719bSwdenk an example, see include/configs/sacsng.h. 2273c609719bSwdenk 227404a9e118SBen Warren CONFIG_HARD_SPI 227504a9e118SBen Warren 227604a9e118SBen Warren Enables a hardware SPI driver for general-purpose reads 227704a9e118SBen Warren and writes. As with CONFIG_SOFT_SPI, the board configuration 227804a9e118SBen Warren must define a list of chip-select function pointers. 227904a9e118SBen Warren Currently supported on some MPC8xxx processors. For an 228004a9e118SBen Warren example, see include/configs/mpc8349emds.h. 228104a9e118SBen Warren 228238254f45SGuennadi Liakhovetski CONFIG_MXC_SPI 228338254f45SGuennadi Liakhovetski 228438254f45SGuennadi Liakhovetski Enables the driver for the SPI controllers on i.MX and MXC 22852e3cd1cdSFabio Estevam SoCs. Currently i.MX31/35/51 are supported. 228638254f45SGuennadi Liakhovetski 22870133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA 22880133502eSMatthias Fuchs 22890133502eSMatthias Fuchs Enables FPGA subsystem. 22900133502eSMatthias Fuchs 22910133502eSMatthias Fuchs CONFIG_FPGA_<vendor> 22920133502eSMatthias Fuchs 22930133502eSMatthias Fuchs Enables support for specific chip vendors. 22940133502eSMatthias Fuchs (ALTERA, XILINX) 22950133502eSMatthias Fuchs 22960133502eSMatthias Fuchs CONFIG_FPGA_<family> 22970133502eSMatthias Fuchs 22980133502eSMatthias Fuchs Enables support for FPGA family. 22990133502eSMatthias Fuchs (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX) 23000133502eSMatthias Fuchs 23010133502eSMatthias Fuchs CONFIG_FPGA_COUNT 2302c609719bSwdenk 2303c609719bSwdenk Specify the number of FPGA devices to support. 2304c609719bSwdenk 23056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_PROG_FEEDBACK 2306c609719bSwdenk 2307c609719bSwdenk Enable printing of hash marks during FPGA configuration. 2308c609719bSwdenk 23096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_BUSY 2310c609719bSwdenk 2311c609719bSwdenk Enable checks on FPGA configuration interface busy 2312c609719bSwdenk status by the configuration function. This option 2313c609719bSwdenk will require a board or device specific function to 2314c609719bSwdenk be written. 2315c609719bSwdenk 2316c609719bSwdenk CONFIG_FPGA_DELAY 2317c609719bSwdenk 2318c609719bSwdenk If defined, a function that provides delays in the FPGA 2319c609719bSwdenk configuration driver. 2320c609719bSwdenk 23216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_CTRLC 2322c609719bSwdenk Allow Control-C to interrupt FPGA configuration 2323c609719bSwdenk 23246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_ERROR 2325c609719bSwdenk 2326c609719bSwdenk Check for configuration errors during FPGA bitfile 2327c609719bSwdenk loading. For example, abort during Virtex II 2328c609719bSwdenk configuration if the INIT_B line goes low (which 2329c609719bSwdenk indicated a CRC error). 2330c609719bSwdenk 23316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_INIT 2332c609719bSwdenk 2333c609719bSwdenk Maximum time to wait for the INIT_B line to deassert 2334c609719bSwdenk after PROB_B has been deasserted during a Virtex II 2335c609719bSwdenk FPGA configuration sequence. The default time is 500 233611ccc33fSMarcel Ziswiler ms. 2337c609719bSwdenk 23386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_BUSY 2339c609719bSwdenk 2340c609719bSwdenk Maximum time to wait for BUSY to deassert during 234111ccc33fSMarcel Ziswiler Virtex II FPGA configuration. The default is 5 ms. 2342c609719bSwdenk 23436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_CONFIG 2344c609719bSwdenk 2345c609719bSwdenk Time to wait after FPGA configuration. The default is 234611ccc33fSMarcel Ziswiler 200 ms. 2347c609719bSwdenk 2348c609719bSwdenk- Configuration Management: 2349c609719bSwdenk CONFIG_IDENT_STRING 2350c609719bSwdenk 2351c609719bSwdenk If defined, this string will be added to the U-Boot 2352c609719bSwdenk version information (U_BOOT_VERSION) 2353c609719bSwdenk 2354c609719bSwdenk- Vendor Parameter Protection: 2355c609719bSwdenk 2356c609719bSwdenk U-Boot considers the values of the environment 2357c609719bSwdenk variables "serial#" (Board Serial Number) and 23587152b1d0Swdenk "ethaddr" (Ethernet Address) to be parameters that 2359c609719bSwdenk are set once by the board vendor / manufacturer, and 2360c609719bSwdenk protects these variables from casual modification by 2361c609719bSwdenk the user. Once set, these variables are read-only, 2362c609719bSwdenk and write or delete attempts are rejected. You can 236311ccc33fSMarcel Ziswiler change this behaviour: 2364c609719bSwdenk 2365c609719bSwdenk If CONFIG_ENV_OVERWRITE is #defined in your config 2366c609719bSwdenk file, the write protection for vendor parameters is 236747cd00faSwdenk completely disabled. Anybody can change or delete 2368c609719bSwdenk these parameters. 2369c609719bSwdenk 2370c609719bSwdenk Alternatively, if you #define _both_ CONFIG_ETHADDR 2371c609719bSwdenk _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default 237211ccc33fSMarcel Ziswiler Ethernet address is installed in the environment, 2373c609719bSwdenk which can be changed exactly ONCE by the user. [The 2374c609719bSwdenk serial# is unaffected by this, i. e. it remains 2375c609719bSwdenk read-only.] 2376c609719bSwdenk 23772598090bSJoe Hershberger The same can be accomplished in a more flexible way 23782598090bSJoe Hershberger for any variable by configuring the type of access 23792598090bSJoe Hershberger to allow for those variables in the ".flags" variable 23802598090bSJoe Hershberger or define CONFIG_ENV_FLAGS_LIST_STATIC. 23812598090bSJoe Hershberger 2382c609719bSwdenk- Protected RAM: 2383c609719bSwdenk CONFIG_PRAM 2384c609719bSwdenk 2385c609719bSwdenk Define this variable to enable the reservation of 2386c609719bSwdenk "protected RAM", i. e. RAM which is not overwritten 2387c609719bSwdenk by U-Boot. Define CONFIG_PRAM to hold the number of 2388c609719bSwdenk kB you want to reserve for pRAM. You can overwrite 2389c609719bSwdenk this default value by defining an environment 2390c609719bSwdenk variable "pram" to the number of kB you want to 2391c609719bSwdenk reserve. Note that the board info structure will 2392c609719bSwdenk still show the full amount of RAM. If pRAM is 2393c609719bSwdenk reserved, a new environment variable "mem" will 2394c609719bSwdenk automatically be defined to hold the amount of 2395c609719bSwdenk remaining RAM in a form that can be passed as boot 2396c609719bSwdenk argument to Linux, for instance like that: 2397c609719bSwdenk 2398fe126d8bSWolfgang Denk setenv bootargs ... mem=\${mem} 2399c609719bSwdenk saveenv 2400c609719bSwdenk 2401c609719bSwdenk This way you can tell Linux not to use this memory, 2402c609719bSwdenk either, which results in a memory region that will 2403c609719bSwdenk not be affected by reboots. 2404c609719bSwdenk 2405c609719bSwdenk *WARNING* If your board configuration uses automatic 2406c609719bSwdenk detection of the RAM size, you must make sure that 2407c609719bSwdenk this memory test is non-destructive. So far, the 2408c609719bSwdenk following board configurations are known to be 2409c609719bSwdenk "pRAM-clean": 2410c609719bSwdenk 24111b0757ecSWolfgang Denk IVMS8, IVML24, SPD8xx, TQM8xxL, 24121b0757ecSWolfgang Denk HERMES, IP860, RPXlite, LWMON, 2413544d97e9SWolfgang Denk FLAGADM, TQM8260 2414c609719bSwdenk 241540fef049SGabe Black- Access to physical memory region (> 4GB) 241640fef049SGabe Black Some basic support is provided for operations on memory not 241740fef049SGabe Black normally accessible to U-Boot - e.g. some architectures 241840fef049SGabe Black support access to more than 4GB of memory on 32-bit 241940fef049SGabe Black machines using physical address extension or similar. 242040fef049SGabe Black Define CONFIG_PHYSMEM to access this basic support, which 242140fef049SGabe Black currently only supports clearing the memory. 242240fef049SGabe Black 2423c609719bSwdenk- Error Recovery: 2424c609719bSwdenk CONFIG_PANIC_HANG 2425c609719bSwdenk 2426c609719bSwdenk Define this variable to stop the system in case of a 2427c609719bSwdenk fatal error, so that you have to reset it manually. 2428c609719bSwdenk This is probably NOT a good idea for an embedded 242911ccc33fSMarcel Ziswiler system where you want the system to reboot 2430c609719bSwdenk automatically as fast as possible, but it may be 2431c609719bSwdenk useful during development since you can try to debug 2432c609719bSwdenk the conditions that lead to the situation. 2433c609719bSwdenk 2434c609719bSwdenk CONFIG_NET_RETRY_COUNT 2435c609719bSwdenk 2436c609719bSwdenk This variable defines the number of retries for 2437c609719bSwdenk network operations like ARP, RARP, TFTP, or BOOTP 2438c609719bSwdenk before giving up the operation. If not defined, a 2439c609719bSwdenk default value of 5 is used. 2440c609719bSwdenk 244140cb90eeSGuennadi Liakhovetski CONFIG_ARP_TIMEOUT 244240cb90eeSGuennadi Liakhovetski 244340cb90eeSGuennadi Liakhovetski Timeout waiting for an ARP reply in milliseconds. 244440cb90eeSGuennadi Liakhovetski 244548a3e999STetsuyuki Kobayashi CONFIG_NFS_TIMEOUT 244648a3e999STetsuyuki Kobayashi 244748a3e999STetsuyuki Kobayashi Timeout in milliseconds used in NFS protocol. 244848a3e999STetsuyuki Kobayashi If you encounter "ERROR: Cannot umount" in nfs command, 244948a3e999STetsuyuki Kobayashi try longer timeout such as 245048a3e999STetsuyuki Kobayashi #define CONFIG_NFS_TIMEOUT 10000UL 245148a3e999STetsuyuki Kobayashi 2452c609719bSwdenk- Command Interpreter: 24538078f1a5SWolfgang Denk CONFIG_AUTO_COMPLETE 245404a85b3bSwdenk 245504a85b3bSwdenk Enable auto completion of commands using TAB. 245604a85b3bSwdenk 24578078f1a5SWolfgang Denk Note that this feature has NOT been implemented yet 24588078f1a5SWolfgang Denk for the "hush" shell. 24598078f1a5SWolfgang Denk 24608078f1a5SWolfgang Denk 24616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_HUSH_PARSER 2462c609719bSwdenk 2463c609719bSwdenk Define this variable to enable the "hush" shell (from 2464c609719bSwdenk Busybox) as command line interpreter, thus enabling 2465c609719bSwdenk powerful command line syntax like 2466c609719bSwdenk if...then...else...fi conditionals or `&&' and '||' 2467c609719bSwdenk constructs ("shell scripts"). 2468c609719bSwdenk 2469c609719bSwdenk If undefined, you get the old, much simpler behaviour 2470c609719bSwdenk with a somewhat smaller memory footprint. 2471c609719bSwdenk 2472c609719bSwdenk 24736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PROMPT_HUSH_PS2 2474c609719bSwdenk 2475c609719bSwdenk This defines the secondary prompt string, which is 2476c609719bSwdenk printed when the command interpreter needs more input 2477c609719bSwdenk to complete a command. Usually "> ". 2478c609719bSwdenk 2479c609719bSwdenk Note: 2480c609719bSwdenk 2481c609719bSwdenk In the current implementation, the local variables 2482c609719bSwdenk space and global environment variables space are 2483c609719bSwdenk separated. Local variables are those you define by 24843b57fe0aSwdenk simply typing `name=value'. To access a local 2485c609719bSwdenk variable later on, you have write `$name' or 24863b57fe0aSwdenk `${name}'; to execute the contents of a variable 24873b57fe0aSwdenk directly type `$name' at the command prompt. 2488c609719bSwdenk 2489c609719bSwdenk Global environment variables are those you use 2490c609719bSwdenk setenv/printenv to work with. To run a command stored 2491c609719bSwdenk in such a variable, you need to use the run command, 2492c609719bSwdenk and you must not use the '$' sign to access them. 2493c609719bSwdenk 2494c609719bSwdenk To store commands and special characters in a 2495c609719bSwdenk variable, please use double quotation marks 2496c609719bSwdenk surrounding the whole text of the variable, instead 2497c609719bSwdenk of the backslashes before semicolons and special 2498c609719bSwdenk symbols. 2499c609719bSwdenk 2500aa0c71acSWolfgang Denk- Commandline Editing and History: 2501aa0c71acSWolfgang Denk CONFIG_CMDLINE_EDITING 2502aa0c71acSWolfgang Denk 250311ccc33fSMarcel Ziswiler Enable editing and History functions for interactive 2504aa0c71acSWolfgang Denk commandline input operations 2505aa0c71acSWolfgang Denk 2506a8c7c708Swdenk- Default Environment: 2507c609719bSwdenk CONFIG_EXTRA_ENV_SETTINGS 2508c609719bSwdenk 2509c609719bSwdenk Define this to contain any number of null terminated 2510c609719bSwdenk strings (variable = value pairs) that will be part of 25117152b1d0Swdenk the default environment compiled into the boot image. 25122262cfeeSwdenk 2513c609719bSwdenk For example, place something like this in your 2514c609719bSwdenk board's config file: 2515c609719bSwdenk 2516c609719bSwdenk #define CONFIG_EXTRA_ENV_SETTINGS \ 2517c609719bSwdenk "myvar1=value1\0" \ 2518c609719bSwdenk "myvar2=value2\0" 2519c609719bSwdenk 2520c609719bSwdenk Warning: This method is based on knowledge about the 2521c609719bSwdenk internal format how the environment is stored by the 25222262cfeeSwdenk U-Boot code. This is NOT an official, exported 2523c609719bSwdenk interface! Although it is unlikely that this format 25247152b1d0Swdenk will change soon, there is no guarantee either. 2525c609719bSwdenk You better know what you are doing here. 2526c609719bSwdenk 2527c609719bSwdenk Note: overly (ab)use of the default environment is 2528c609719bSwdenk discouraged. Make sure to check other ways to preset 252974de7aefSWolfgang Denk the environment like the "source" command or the 2530c609719bSwdenk boot command first. 2531c609719bSwdenk 25325e724ca2SStephen Warren CONFIG_ENV_VARS_UBOOT_CONFIG 25335e724ca2SStephen Warren 25345e724ca2SStephen Warren Define this in order to add variables describing the 25355e724ca2SStephen Warren U-Boot build configuration to the default environment. 25365e724ca2SStephen Warren These will be named arch, cpu, board, vendor, and soc. 25375e724ca2SStephen Warren 25385e724ca2SStephen Warren Enabling this option will cause the following to be defined: 25395e724ca2SStephen Warren 25405e724ca2SStephen Warren - CONFIG_SYS_ARCH 25415e724ca2SStephen Warren - CONFIG_SYS_CPU 25425e724ca2SStephen Warren - CONFIG_SYS_BOARD 25435e724ca2SStephen Warren - CONFIG_SYS_VENDOR 25445e724ca2SStephen Warren - CONFIG_SYS_SOC 25455e724ca2SStephen Warren 25467e27f89fSTom Rini CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG 25477e27f89fSTom Rini 25487e27f89fSTom Rini Define this in order to add variables describing certain 25497e27f89fSTom Rini run-time determined information about the hardware to the 25507e27f89fSTom Rini environment. These will be named board_name, board_rev. 25517e27f89fSTom Rini 255206fd8538SSimon Glass CONFIG_DELAY_ENVIRONMENT 255306fd8538SSimon Glass 255406fd8538SSimon Glass Normally the environment is loaded when the board is 255506fd8538SSimon Glass intialised so that it is available to U-Boot. This inhibits 255606fd8538SSimon Glass that so that the environment is not available until 255706fd8538SSimon Glass explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL 255806fd8538SSimon Glass this is instead controlled by the value of 255906fd8538SSimon Glass /config/load-environment. 256006fd8538SSimon Glass 2561a8c7c708Swdenk- DataFlash Support: 25622abbe075Swdenk CONFIG_HAS_DATAFLASH 25632abbe075Swdenk 25642abbe075Swdenk Defining this option enables DataFlash features and 25652abbe075Swdenk allows to read/write in Dataflash via the standard 25662abbe075Swdenk commands cp, md... 25672abbe075Swdenk 2568f61ec45eSEric Nelson- Serial Flash support 2569f61ec45eSEric Nelson CONFIG_CMD_SF 2570f61ec45eSEric Nelson 2571f61ec45eSEric Nelson Defining this option enables SPI flash commands 2572f61ec45eSEric Nelson 'sf probe/read/write/erase/update'. 2573f61ec45eSEric Nelson 2574f61ec45eSEric Nelson Usage requires an initial 'probe' to define the serial 2575f61ec45eSEric Nelson flash parameters, followed by read/write/erase/update 2576f61ec45eSEric Nelson commands. 2577f61ec45eSEric Nelson 2578f61ec45eSEric Nelson The following defaults may be provided by the platform 2579f61ec45eSEric Nelson to handle the common case when only a single serial 2580f61ec45eSEric Nelson flash is present on the system. 2581f61ec45eSEric Nelson 2582f61ec45eSEric Nelson CONFIG_SF_DEFAULT_BUS Bus identifier 2583f61ec45eSEric Nelson CONFIG_SF_DEFAULT_CS Chip-select 2584f61ec45eSEric Nelson CONFIG_SF_DEFAULT_MODE (see include/spi.h) 2585f61ec45eSEric Nelson CONFIG_SF_DEFAULT_SPEED in Hz 2586f61ec45eSEric Nelson 258724007273SSimon Glass CONFIG_CMD_SF_TEST 258824007273SSimon Glass 258924007273SSimon Glass Define this option to include a destructive SPI flash 259024007273SSimon Glass test ('sf test'). 259124007273SSimon Glass 25921dcd6d03SJagannadha Sutradharudu Teki CONFIG_SPI_FLASH_BAR Ban/Extended Addr Reg 25931dcd6d03SJagannadha Sutradharudu Teki 25941dcd6d03SJagannadha Sutradharudu Teki Define this option to use the Bank addr/Extended addr 25951dcd6d03SJagannadha Sutradharudu Teki support on SPI flashes which has size > 16Mbytes. 25961dcd6d03SJagannadha Sutradharudu Teki 25973f85ce27Swdenk- SystemACE Support: 25983f85ce27Swdenk CONFIG_SYSTEMACE 25993f85ce27Swdenk 26003f85ce27Swdenk Adding this option adds support for Xilinx SystemACE 26013f85ce27Swdenk chips attached via some sort of local bus. The address 260211ccc33fSMarcel Ziswiler of the chip must also be defined in the 26036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SYSTEMACE_BASE macro. For example: 26043f85ce27Swdenk 26053f85ce27Swdenk #define CONFIG_SYSTEMACE 26066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000 26073f85ce27Swdenk 26083f85ce27Swdenk When SystemACE support is added, the "ace" device type 26093f85ce27Swdenk becomes available to the fat commands, i.e. fatls. 26103f85ce27Swdenk 2611ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port: 2612ecb0ccd9SWolfgang Denk CONFIG_TFTP_PORT 2613ecb0ccd9SWolfgang Denk 261428cb9375SWolfgang Denk If this is defined, the environment variable tftpsrcp 2615ecb0ccd9SWolfgang Denk is used to supply the TFTP UDP source port value. 261628cb9375SWolfgang Denk If tftpsrcp isn't defined, the normal pseudo-random port 2617ecb0ccd9SWolfgang Denk number generator is used. 2618ecb0ccd9SWolfgang Denk 261928cb9375SWolfgang Denk Also, the environment variable tftpdstp is used to supply 262028cb9375SWolfgang Denk the TFTP UDP destination port value. If tftpdstp isn't 262128cb9375SWolfgang Denk defined, the normal port 69 is used. 262228cb9375SWolfgang Denk 262328cb9375SWolfgang Denk The purpose for tftpsrcp is to allow a TFTP server to 2624ecb0ccd9SWolfgang Denk blindly start the TFTP transfer using the pre-configured 2625ecb0ccd9SWolfgang Denk target IP address and UDP port. This has the effect of 2626ecb0ccd9SWolfgang Denk "punching through" the (Windows XP) firewall, allowing 2627ecb0ccd9SWolfgang Denk the remainder of the TFTP transfer to proceed normally. 2628ecb0ccd9SWolfgang Denk A better solution is to properly configure the firewall, 2629ecb0ccd9SWolfgang Denk but sometimes that is not allowed. 2630ecb0ccd9SWolfgang Denk 2631bf36c5d5SSimon Glass- Hashing support: 2632bf36c5d5SSimon Glass CONFIG_CMD_HASH 2633bf36c5d5SSimon Glass 2634bf36c5d5SSimon Glass This enables a generic 'hash' command which can produce 2635bf36c5d5SSimon Glass hashes / digests from a few algorithms (e.g. SHA1, SHA256). 2636bf36c5d5SSimon Glass 2637bf36c5d5SSimon Glass CONFIG_HASH_VERIFY 2638bf36c5d5SSimon Glass 2639bf36c5d5SSimon Glass Enable the hash verify command (hash -v). This adds to code 2640bf36c5d5SSimon Glass size a little. 2641bf36c5d5SSimon Glass 2642bf36c5d5SSimon Glass CONFIG_SHA1 - support SHA1 hashing 2643bf36c5d5SSimon Glass CONFIG_SHA256 - support SHA256 hashing 2644bf36c5d5SSimon Glass 2645bf36c5d5SSimon Glass Note: There is also a sha1sum command, which should perhaps 2646bf36c5d5SSimon Glass be deprecated in favour of 'hash sha1'. 2647bf36c5d5SSimon Glass 264819c402afSSimon Glass- Signing support: 264919c402afSSimon Glass CONFIG_RSA 265019c402afSSimon Glass 265119c402afSSimon Glass This enables the RSA algorithm used for FIT image verification 265219c402afSSimon Glass in U-Boot. See doc/uImage/signature for more information. 265319c402afSSimon Glass 265419c402afSSimon Glass The signing part is build into mkimage regardless of this 265519c402afSSimon Glass option. 265619c402afSSimon Glass 265719c402afSSimon Glass 2658a8c7c708Swdenk- Show boot progress: 2659c609719bSwdenk CONFIG_SHOW_BOOT_PROGRESS 2660c609719bSwdenk 2661c609719bSwdenk Defining this option allows to add some board- 2662c609719bSwdenk specific code (calling a user-provided function 2663c609719bSwdenk "show_boot_progress(int)") that enables you to show 2664c609719bSwdenk the system's boot progress on some display (for 2665c609719bSwdenk example, some LED's) on your board. At the moment, 2666c609719bSwdenk the following checkpoints are implemented: 2667c609719bSwdenk 26683a608ca0SSimon Glass- Detailed boot stage timing 26693a608ca0SSimon Glass CONFIG_BOOTSTAGE 26703a608ca0SSimon Glass Define this option to get detailed timing of each stage 26713a608ca0SSimon Glass of the boot process. 26723a608ca0SSimon Glass 26733a608ca0SSimon Glass CONFIG_BOOTSTAGE_USER_COUNT 26743a608ca0SSimon Glass This is the number of available user bootstage records. 26753a608ca0SSimon Glass Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...) 26763a608ca0SSimon Glass a new ID will be allocated from this stash. If you exceed 26773a608ca0SSimon Glass the limit, recording will stop. 26783a608ca0SSimon Glass 26793a608ca0SSimon Glass CONFIG_BOOTSTAGE_REPORT 26803a608ca0SSimon Glass Define this to print a report before boot, similar to this: 26813a608ca0SSimon Glass 26823a608ca0SSimon Glass Timer summary in microseconds: 26833a608ca0SSimon Glass Mark Elapsed Stage 26843a608ca0SSimon Glass 0 0 reset 26853a608ca0SSimon Glass 3,575,678 3,575,678 board_init_f start 26863a608ca0SSimon Glass 3,575,695 17 arch_cpu_init A9 26873a608ca0SSimon Glass 3,575,777 82 arch_cpu_init done 26883a608ca0SSimon Glass 3,659,598 83,821 board_init_r start 26893a608ca0SSimon Glass 3,910,375 250,777 main_loop 26903a608ca0SSimon Glass 29,916,167 26,005,792 bootm_start 26913a608ca0SSimon Glass 30,361,327 445,160 start_kernel 26923a608ca0SSimon Glass 26932eba38cfSSimon Glass CONFIG_CMD_BOOTSTAGE 26942eba38cfSSimon Glass Add a 'bootstage' command which supports printing a report 26952eba38cfSSimon Glass and un/stashing of bootstage data. 26962eba38cfSSimon Glass 269794fd1316SSimon Glass CONFIG_BOOTSTAGE_FDT 269894fd1316SSimon Glass Stash the bootstage information in the FDT. A root 'bootstage' 269994fd1316SSimon Glass node is created with each bootstage id as a child. Each child 270094fd1316SSimon Glass has a 'name' property and either 'mark' containing the 270194fd1316SSimon Glass mark time in microsecond, or 'accum' containing the 270294fd1316SSimon Glass accumulated time for that bootstage id in microseconds. 270394fd1316SSimon Glass For example: 270494fd1316SSimon Glass 270594fd1316SSimon Glass bootstage { 270694fd1316SSimon Glass 154 { 270794fd1316SSimon Glass name = "board_init_f"; 270894fd1316SSimon Glass mark = <3575678>; 270994fd1316SSimon Glass }; 271094fd1316SSimon Glass 170 { 271194fd1316SSimon Glass name = "lcd"; 271294fd1316SSimon Glass accum = <33482>; 271394fd1316SSimon Glass }; 271494fd1316SSimon Glass }; 271594fd1316SSimon Glass 271694fd1316SSimon Glass Code in the Linux kernel can find this in /proc/devicetree. 271794fd1316SSimon Glass 27181372cce2SMarian BalakowiczLegacy uImage format: 27191372cce2SMarian Balakowicz 2720c609719bSwdenk Arg Where When 2721c609719bSwdenk 1 common/cmd_bootm.c before attempting to boot an image 2722c609719bSwdenk -1 common/cmd_bootm.c Image header has bad magic number 2723c609719bSwdenk 2 common/cmd_bootm.c Image header has correct magic number 2724c609719bSwdenk -2 common/cmd_bootm.c Image header has bad checksum 2725c609719bSwdenk 3 common/cmd_bootm.c Image header has correct checksum 2726c609719bSwdenk -3 common/cmd_bootm.c Image data has bad checksum 2727c609719bSwdenk 4 common/cmd_bootm.c Image data has correct checksum 2728c609719bSwdenk -4 common/cmd_bootm.c Image is for unsupported architecture 2729c609719bSwdenk 5 common/cmd_bootm.c Architecture check OK 27301372cce2SMarian Balakowicz -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi) 2731c609719bSwdenk 6 common/cmd_bootm.c Image Type check OK 2732c609719bSwdenk -6 common/cmd_bootm.c gunzip uncompression error 2733c609719bSwdenk -7 common/cmd_bootm.c Unimplemented compression type 2734c609719bSwdenk 7 common/cmd_bootm.c Uncompression OK 27351372cce2SMarian Balakowicz 8 common/cmd_bootm.c No uncompress/copy overwrite error 2736c609719bSwdenk -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX) 27371372cce2SMarian Balakowicz 27381372cce2SMarian Balakowicz 9 common/image.c Start initial ramdisk verification 27391372cce2SMarian Balakowicz -10 common/image.c Ramdisk header has bad magic number 27401372cce2SMarian Balakowicz -11 common/image.c Ramdisk header has bad checksum 27411372cce2SMarian Balakowicz 10 common/image.c Ramdisk header is OK 27421372cce2SMarian Balakowicz -12 common/image.c Ramdisk data has bad checksum 27431372cce2SMarian Balakowicz 11 common/image.c Ramdisk data has correct checksum 27441372cce2SMarian Balakowicz 12 common/image.c Ramdisk verification complete, start loading 274511ccc33fSMarcel Ziswiler -13 common/image.c Wrong Image Type (not PPC Linux ramdisk) 27461372cce2SMarian Balakowicz 13 common/image.c Start multifile image verification 27471372cce2SMarian Balakowicz 14 common/image.c No initial ramdisk, no multifile, continue. 27481372cce2SMarian Balakowicz 2749ea0364f1SPeter Tyser 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS 2750c609719bSwdenk 2751a47a12beSStefan Roese -30 arch/powerpc/lib/board.c Fatal error, hang the system 275263e73c9aSwdenk -31 post/post.c POST test failed, detected by post_output_backlog() 275363e73c9aSwdenk -32 post/post.c POST test failed, detected by post_run_single() 275463e73c9aSwdenk 2755566a494fSHeiko Schocher 34 common/cmd_doc.c before loading a Image from a DOC device 2756566a494fSHeiko Schocher -35 common/cmd_doc.c Bad usage of "doc" command 2757566a494fSHeiko Schocher 35 common/cmd_doc.c correct usage of "doc" command 2758566a494fSHeiko Schocher -36 common/cmd_doc.c No boot device 2759566a494fSHeiko Schocher 36 common/cmd_doc.c correct boot device 2760566a494fSHeiko Schocher -37 common/cmd_doc.c Unknown Chip ID on boot device 2761566a494fSHeiko Schocher 37 common/cmd_doc.c correct chip ID found, device available 2762566a494fSHeiko Schocher -38 common/cmd_doc.c Read Error on boot device 2763566a494fSHeiko Schocher 38 common/cmd_doc.c reading Image header from DOC device OK 2764566a494fSHeiko Schocher -39 common/cmd_doc.c Image header has bad magic number 2765566a494fSHeiko Schocher 39 common/cmd_doc.c Image header has correct magic number 2766566a494fSHeiko Schocher -40 common/cmd_doc.c Error reading Image from DOC device 2767566a494fSHeiko Schocher 40 common/cmd_doc.c Image header has correct magic number 2768566a494fSHeiko Schocher 41 common/cmd_ide.c before loading a Image from a IDE device 2769566a494fSHeiko Schocher -42 common/cmd_ide.c Bad usage of "ide" command 2770566a494fSHeiko Schocher 42 common/cmd_ide.c correct usage of "ide" command 2771566a494fSHeiko Schocher -43 common/cmd_ide.c No boot device 2772566a494fSHeiko Schocher 43 common/cmd_ide.c boot device found 2773566a494fSHeiko Schocher -44 common/cmd_ide.c Device not available 2774566a494fSHeiko Schocher 44 common/cmd_ide.c Device available 2775566a494fSHeiko Schocher -45 common/cmd_ide.c wrong partition selected 2776566a494fSHeiko Schocher 45 common/cmd_ide.c partition selected 2777566a494fSHeiko Schocher -46 common/cmd_ide.c Unknown partition table 2778566a494fSHeiko Schocher 46 common/cmd_ide.c valid partition table found 2779566a494fSHeiko Schocher -47 common/cmd_ide.c Invalid partition type 2780566a494fSHeiko Schocher 47 common/cmd_ide.c correct partition type 2781566a494fSHeiko Schocher -48 common/cmd_ide.c Error reading Image Header on boot device 2782566a494fSHeiko Schocher 48 common/cmd_ide.c reading Image Header from IDE device OK 2783566a494fSHeiko Schocher -49 common/cmd_ide.c Image header has bad magic number 2784566a494fSHeiko Schocher 49 common/cmd_ide.c Image header has correct magic number 2785566a494fSHeiko Schocher -50 common/cmd_ide.c Image header has bad checksum 2786566a494fSHeiko Schocher 50 common/cmd_ide.c Image header has correct checksum 2787566a494fSHeiko Schocher -51 common/cmd_ide.c Error reading Image from IDE device 2788566a494fSHeiko Schocher 51 common/cmd_ide.c reading Image from IDE device OK 2789566a494fSHeiko Schocher 52 common/cmd_nand.c before loading a Image from a NAND device 2790566a494fSHeiko Schocher -53 common/cmd_nand.c Bad usage of "nand" command 2791566a494fSHeiko Schocher 53 common/cmd_nand.c correct usage of "nand" command 2792566a494fSHeiko Schocher -54 common/cmd_nand.c No boot device 2793566a494fSHeiko Schocher 54 common/cmd_nand.c boot device found 2794566a494fSHeiko Schocher -55 common/cmd_nand.c Unknown Chip ID on boot device 2795566a494fSHeiko Schocher 55 common/cmd_nand.c correct chip ID found, device available 2796566a494fSHeiko Schocher -56 common/cmd_nand.c Error reading Image Header on boot device 2797566a494fSHeiko Schocher 56 common/cmd_nand.c reading Image Header from NAND device OK 2798566a494fSHeiko Schocher -57 common/cmd_nand.c Image header has bad magic number 2799566a494fSHeiko Schocher 57 common/cmd_nand.c Image header has correct magic number 2800566a494fSHeiko Schocher -58 common/cmd_nand.c Error reading Image from NAND device 2801566a494fSHeiko Schocher 58 common/cmd_nand.c reading Image from NAND device OK 2802c609719bSwdenk 2803566a494fSHeiko Schocher -60 common/env_common.c Environment has a bad CRC, using default 2804c609719bSwdenk 2805566a494fSHeiko Schocher 64 net/eth.c starting with Ethernet configuration. 2806566a494fSHeiko Schocher -64 net/eth.c no Ethernet found. 2807566a494fSHeiko Schocher 65 net/eth.c Ethernet found. 2808206c60cbSwdenk 2809566a494fSHeiko Schocher -80 common/cmd_net.c usage wrong 2810566a494fSHeiko Schocher 80 common/cmd_net.c before calling NetLoop() 281111ccc33fSMarcel Ziswiler -81 common/cmd_net.c some error in NetLoop() occurred 2812566a494fSHeiko Schocher 81 common/cmd_net.c NetLoop() back without error 2813566a494fSHeiko Schocher -82 common/cmd_net.c size == 0 (File with size 0 loaded) 2814566a494fSHeiko Schocher 82 common/cmd_net.c trying automatic boot 281574de7aefSWolfgang Denk 83 common/cmd_net.c running "source" command 281674de7aefSWolfgang Denk -83 common/cmd_net.c some error in automatic boot or "source" command 2817566a494fSHeiko Schocher 84 common/cmd_net.c end without errors 2818c609719bSwdenk 28191372cce2SMarian BalakowiczFIT uImage format: 28201372cce2SMarian Balakowicz 28211372cce2SMarian Balakowicz Arg Where When 28221372cce2SMarian Balakowicz 100 common/cmd_bootm.c Kernel FIT Image has correct format 28231372cce2SMarian Balakowicz -100 common/cmd_bootm.c Kernel FIT Image has incorrect format 28241372cce2SMarian Balakowicz 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration 28251372cce2SMarian Balakowicz -101 common/cmd_bootm.c Can't get configuration for kernel subimage 28261372cce2SMarian Balakowicz 102 common/cmd_bootm.c Kernel unit name specified 28271372cce2SMarian Balakowicz -103 common/cmd_bootm.c Can't get kernel subimage node offset 2828f773bea8SMarian Balakowicz 103 common/cmd_bootm.c Found configuration node 28291372cce2SMarian Balakowicz 104 common/cmd_bootm.c Got kernel subimage node offset 28301372cce2SMarian Balakowicz -104 common/cmd_bootm.c Kernel subimage hash verification failed 28311372cce2SMarian Balakowicz 105 common/cmd_bootm.c Kernel subimage hash verification OK 28321372cce2SMarian Balakowicz -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture 28331372cce2SMarian Balakowicz 106 common/cmd_bootm.c Architecture check OK 283411ccc33fSMarcel Ziswiler -106 common/cmd_bootm.c Kernel subimage has wrong type 283511ccc33fSMarcel Ziswiler 107 common/cmd_bootm.c Kernel subimage type OK 28361372cce2SMarian Balakowicz -107 common/cmd_bootm.c Can't get kernel subimage data/size 28371372cce2SMarian Balakowicz 108 common/cmd_bootm.c Got kernel subimage data/size 28381372cce2SMarian Balakowicz -108 common/cmd_bootm.c Wrong image type (not legacy, FIT) 28391372cce2SMarian Balakowicz -109 common/cmd_bootm.c Can't get kernel subimage type 28401372cce2SMarian Balakowicz -110 common/cmd_bootm.c Can't get kernel subimage comp 28411372cce2SMarian Balakowicz -111 common/cmd_bootm.c Can't get kernel subimage os 28421372cce2SMarian Balakowicz -112 common/cmd_bootm.c Can't get kernel subimage load address 28431372cce2SMarian Balakowicz -113 common/cmd_bootm.c Image uncompress/copy overwrite error 28441372cce2SMarian Balakowicz 28451372cce2SMarian Balakowicz 120 common/image.c Start initial ramdisk verification 28461372cce2SMarian Balakowicz -120 common/image.c Ramdisk FIT image has incorrect format 28471372cce2SMarian Balakowicz 121 common/image.c Ramdisk FIT image has correct format 284811ccc33fSMarcel Ziswiler 122 common/image.c No ramdisk subimage unit name, using configuration 28491372cce2SMarian Balakowicz -122 common/image.c Can't get configuration for ramdisk subimage 28501372cce2SMarian Balakowicz 123 common/image.c Ramdisk unit name specified 28511372cce2SMarian Balakowicz -124 common/image.c Can't get ramdisk subimage node offset 28521372cce2SMarian Balakowicz 125 common/image.c Got ramdisk subimage node offset 28531372cce2SMarian Balakowicz -125 common/image.c Ramdisk subimage hash verification failed 28541372cce2SMarian Balakowicz 126 common/image.c Ramdisk subimage hash verification OK 28551372cce2SMarian Balakowicz -126 common/image.c Ramdisk subimage for unsupported architecture 28561372cce2SMarian Balakowicz 127 common/image.c Architecture check OK 28571372cce2SMarian Balakowicz -127 common/image.c Can't get ramdisk subimage data/size 28581372cce2SMarian Balakowicz 128 common/image.c Got ramdisk subimage data/size 28591372cce2SMarian Balakowicz 129 common/image.c Can't get ramdisk load address 28601372cce2SMarian Balakowicz -129 common/image.c Got ramdisk load address 28611372cce2SMarian Balakowicz 286211ccc33fSMarcel Ziswiler -130 common/cmd_doc.c Incorrect FIT image format 28631372cce2SMarian Balakowicz 131 common/cmd_doc.c FIT image format OK 28641372cce2SMarian Balakowicz 286511ccc33fSMarcel Ziswiler -140 common/cmd_ide.c Incorrect FIT image format 28661372cce2SMarian Balakowicz 141 common/cmd_ide.c FIT image format OK 28671372cce2SMarian Balakowicz 286811ccc33fSMarcel Ziswiler -150 common/cmd_nand.c Incorrect FIT image format 28691372cce2SMarian Balakowicz 151 common/cmd_nand.c FIT image format OK 28701372cce2SMarian Balakowicz 2871d95f6ec7SGabe Black- FIT image support: 2872d95f6ec7SGabe Black CONFIG_FIT 2873d95f6ec7SGabe Black Enable support for the FIT uImage format. 2874d95f6ec7SGabe Black 2875d95f6ec7SGabe Black CONFIG_FIT_BEST_MATCH 2876d95f6ec7SGabe Black When no configuration is explicitly selected, default to the 2877d95f6ec7SGabe Black one whose fdt's compatibility field best matches that of 2878d95f6ec7SGabe Black U-Boot itself. A match is considered "best" if it matches the 2879d95f6ec7SGabe Black most specific compatibility entry of U-Boot's fdt's root node. 2880d95f6ec7SGabe Black The order of entries in the configuration's fdt is ignored. 2881d95f6ec7SGabe Black 28823e569a6bSSimon Glass CONFIG_FIT_SIGNATURE 28833e569a6bSSimon Glass This option enables signature verification of FIT uImages, 28843e569a6bSSimon Glass using a hash signed and verified using RSA. See 28853e569a6bSSimon Glass doc/uImage.FIT/signature.txt for more details. 28863e569a6bSSimon Glass 28874cf2609bSWolfgang Denk- Standalone program support: 28884cf2609bSWolfgang Denk CONFIG_STANDALONE_LOAD_ADDR 28894cf2609bSWolfgang Denk 28906feff899SWolfgang Denk This option defines a board specific value for the 28916feff899SWolfgang Denk address where standalone program gets loaded, thus 28926feff899SWolfgang Denk overwriting the architecture dependent default 28934cf2609bSWolfgang Denk settings. 28944cf2609bSWolfgang Denk 28954cf2609bSWolfgang Denk- Frame Buffer Address: 28964cf2609bSWolfgang Denk CONFIG_FB_ADDR 28974cf2609bSWolfgang Denk 28984cf2609bSWolfgang Denk Define CONFIG_FB_ADDR if you want to use specific 289944a53b57SWolfgang Denk address for frame buffer. This is typically the case 290044a53b57SWolfgang Denk when using a graphics controller has separate video 290144a53b57SWolfgang Denk memory. U-Boot will then place the frame buffer at 290244a53b57SWolfgang Denk the given address instead of dynamically reserving it 290344a53b57SWolfgang Denk in system RAM by calling lcd_setmem(), which grabs 290444a53b57SWolfgang Denk the memory for the frame buffer depending on the 290544a53b57SWolfgang Denk configured panel size. 29064cf2609bSWolfgang Denk 29074cf2609bSWolfgang Denk Please see board_init_f function. 29084cf2609bSWolfgang Denk 2909cccfc2abSDetlev Zundel- Automatic software updates via TFTP server 2910cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP 2911cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP_CNT_MAX 2912cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP_MSEC_MAX 2913cccfc2abSDetlev Zundel 2914cccfc2abSDetlev Zundel These options enable and control the auto-update feature; 2915cccfc2abSDetlev Zundel for a more detailed description refer to doc/README.update. 2916cccfc2abSDetlev Zundel 2917cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support) 2918cccfc2abSDetlev Zundel CONFIG_MTD_DEVICE 2919cccfc2abSDetlev Zundel 2920cccfc2abSDetlev Zundel Adds the MTD device infrastructure from the Linux kernel. 2921cccfc2abSDetlev Zundel Needed for mtdparts command support. 2922cccfc2abSDetlev Zundel 2923cccfc2abSDetlev Zundel CONFIG_MTD_PARTITIONS 2924cccfc2abSDetlev Zundel 2925cccfc2abSDetlev Zundel Adds the MTD partitioning infrastructure from the Linux 2926cccfc2abSDetlev Zundel kernel. Needed for UBI support. 2927cccfc2abSDetlev Zundel 292870c219cdSJoe Hershberger- UBI support 292970c219cdSJoe Hershberger CONFIG_CMD_UBI 293070c219cdSJoe Hershberger 293170c219cdSJoe Hershberger Adds commands for interacting with MTD partitions formatted 293270c219cdSJoe Hershberger with the UBI flash translation layer 293370c219cdSJoe Hershberger 293470c219cdSJoe Hershberger Requires also defining CONFIG_RBTREE 293570c219cdSJoe Hershberger 2936147162daSJoe Hershberger CONFIG_UBI_SILENCE_MSG 2937147162daSJoe Hershberger 2938147162daSJoe Hershberger Make the verbose messages from UBI stop printing. This leaves 2939147162daSJoe Hershberger warnings and errors enabled. 2940147162daSJoe Hershberger 294170c219cdSJoe Hershberger- UBIFS support 294270c219cdSJoe Hershberger CONFIG_CMD_UBIFS 294370c219cdSJoe Hershberger 294470c219cdSJoe Hershberger Adds commands for interacting with UBI volumes formatted as 294570c219cdSJoe Hershberger UBIFS. UBIFS is read-only in u-boot. 294670c219cdSJoe Hershberger 294770c219cdSJoe Hershberger Requires UBI support as well as CONFIG_LZO 294870c219cdSJoe Hershberger 2949147162daSJoe Hershberger CONFIG_UBIFS_SILENCE_MSG 2950147162daSJoe Hershberger 2951147162daSJoe Hershberger Make the verbose messages from UBIFS stop printing. This leaves 2952147162daSJoe Hershberger warnings and errors enabled. 2953147162daSJoe Hershberger 29546a11cf48SDaniel Schwierzeck- SPL framework 29556a11cf48SDaniel Schwierzeck CONFIG_SPL 29566a11cf48SDaniel Schwierzeck Enable building of SPL globally. 29576a11cf48SDaniel Schwierzeck 295895579793STom Rini CONFIG_SPL_LDSCRIPT 295995579793STom Rini LDSCRIPT for linking the SPL binary. 296095579793STom Rini 29616ebc3461SAlbert ARIBAUD CONFIG_SPL_MAX_FOOTPRINT 29626ebc3461SAlbert ARIBAUD Maximum size in memory allocated to the SPL, BSS included. 29636ebc3461SAlbert ARIBAUD When defined, the linker checks that the actual memory 29646ebc3461SAlbert ARIBAUD used by SPL from _start to __bss_end does not exceed it. 29658960af8bSAlbert ARIBAUD CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE 29666ebc3461SAlbert ARIBAUD must not be both defined at the same time. 29676ebc3461SAlbert ARIBAUD 296895579793STom Rini CONFIG_SPL_MAX_SIZE 29696ebc3461SAlbert ARIBAUD Maximum size of the SPL image (text, data, rodata, and 29706ebc3461SAlbert ARIBAUD linker lists sections), BSS excluded. 29716ebc3461SAlbert ARIBAUD When defined, the linker checks that the actual size does 29726ebc3461SAlbert ARIBAUD not exceed it. 297395579793STom Rini 29746a11cf48SDaniel Schwierzeck CONFIG_SPL_TEXT_BASE 29756a11cf48SDaniel Schwierzeck TEXT_BASE for linking the SPL binary. 29766a11cf48SDaniel Schwierzeck 297794a45bb1SScott Wood CONFIG_SPL_RELOC_TEXT_BASE 297894a45bb1SScott Wood Address to relocate to. If unspecified, this is equal to 297994a45bb1SScott Wood CONFIG_SPL_TEXT_BASE (i.e. no relocation is done). 298094a45bb1SScott Wood 298195579793STom Rini CONFIG_SPL_BSS_START_ADDR 298295579793STom Rini Link address for the BSS within the SPL binary. 298395579793STom Rini 298495579793STom Rini CONFIG_SPL_BSS_MAX_SIZE 29856ebc3461SAlbert ARIBAUD Maximum size in memory allocated to the SPL BSS. 29866ebc3461SAlbert ARIBAUD When defined, the linker checks that the actual memory used 29876ebc3461SAlbert ARIBAUD by SPL from __bss_start to __bss_end does not exceed it. 29888960af8bSAlbert ARIBAUD CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE 29896ebc3461SAlbert ARIBAUD must not be both defined at the same time. 299095579793STom Rini 299195579793STom Rini CONFIG_SPL_STACK 299295579793STom Rini Adress of the start of the stack SPL will use 299395579793STom Rini 299494a45bb1SScott Wood CONFIG_SPL_RELOC_STACK 299594a45bb1SScott Wood Adress of the start of the stack SPL will use after 299694a45bb1SScott Wood relocation. If unspecified, this is equal to 299794a45bb1SScott Wood CONFIG_SPL_STACK. 299894a45bb1SScott Wood 299995579793STom Rini CONFIG_SYS_SPL_MALLOC_START 300095579793STom Rini Starting address of the malloc pool used in SPL. 300195579793STom Rini 300295579793STom Rini CONFIG_SYS_SPL_MALLOC_SIZE 300395579793STom Rini The size of the malloc pool used in SPL. 30046a11cf48SDaniel Schwierzeck 300547f7bcaeSTom Rini CONFIG_SPL_FRAMEWORK 300647f7bcaeSTom Rini Enable the SPL framework under common/. This framework 300747f7bcaeSTom Rini supports MMC, NAND and YMODEM loading of U-Boot and NAND 300847f7bcaeSTom Rini NAND loading of the Linux Kernel. 300947f7bcaeSTom Rini 3010861a86f4STom Rini CONFIG_SPL_DISPLAY_PRINT 3011861a86f4STom Rini For ARM, enable an optional function to print more information 3012861a86f4STom Rini about the running system. 3013861a86f4STom Rini 30144b919725SScott Wood CONFIG_SPL_INIT_MINIMAL 30154b919725SScott Wood Arch init code should be built for a very small image 30164b919725SScott Wood 30176a11cf48SDaniel Schwierzeck CONFIG_SPL_LIBCOMMON_SUPPORT 30186a11cf48SDaniel Schwierzeck Support for common/libcommon.o in SPL binary 30196a11cf48SDaniel Schwierzeck 30206a11cf48SDaniel Schwierzeck CONFIG_SPL_LIBDISK_SUPPORT 30216a11cf48SDaniel Schwierzeck Support for disk/libdisk.o in SPL binary 30226a11cf48SDaniel Schwierzeck 30236a11cf48SDaniel Schwierzeck CONFIG_SPL_I2C_SUPPORT 30246a11cf48SDaniel Schwierzeck Support for drivers/i2c/libi2c.o in SPL binary 30256a11cf48SDaniel Schwierzeck 30266a11cf48SDaniel Schwierzeck CONFIG_SPL_GPIO_SUPPORT 30276a11cf48SDaniel Schwierzeck Support for drivers/gpio/libgpio.o in SPL binary 30286a11cf48SDaniel Schwierzeck 30296a11cf48SDaniel Schwierzeck CONFIG_SPL_MMC_SUPPORT 30306a11cf48SDaniel Schwierzeck Support for drivers/mmc/libmmc.o in SPL binary 30316a11cf48SDaniel Schwierzeck 303295579793STom Rini CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR, 303395579793STom Rini CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS, 303495579793STom Rini CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION 303595579793STom Rini Address, size and partition on the MMC to load U-Boot from 303695579793STom Rini when the MMC is being used in raw mode. 303795579793STom Rini 30382b75b0adSPeter Korsgaard CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR 30392b75b0adSPeter Korsgaard Sector to load kernel uImage from when MMC is being 30402b75b0adSPeter Korsgaard used in raw mode (for Falcon mode) 30412b75b0adSPeter Korsgaard 30422b75b0adSPeter Korsgaard CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR, 30432b75b0adSPeter Korsgaard CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS 30442b75b0adSPeter Korsgaard Sector and number of sectors to load kernel argument 30452b75b0adSPeter Korsgaard parameters from when MMC is being used in raw mode 30462b75b0adSPeter Korsgaard (for falcon mode) 30472b75b0adSPeter Korsgaard 304895579793STom Rini CONFIG_SPL_FAT_SUPPORT 304995579793STom Rini Support for fs/fat/libfat.o in SPL binary 305095579793STom Rini 305195579793STom Rini CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME 305295579793STom Rini Filename to read to load U-Boot when reading from FAT 305395579793STom Rini 30547ad2cc79SPeter Korsgaard CONFIG_SPL_FAT_LOAD_KERNEL_NAME 30557ad2cc79SPeter Korsgaard Filename to read to load kernel uImage when reading 30567ad2cc79SPeter Korsgaard from FAT (for Falcon mode) 30577ad2cc79SPeter Korsgaard 30587ad2cc79SPeter Korsgaard CONFIG_SPL_FAT_LOAD_ARGS_NAME 30597ad2cc79SPeter Korsgaard Filename to read to load kernel argument parameters 30607ad2cc79SPeter Korsgaard when reading from FAT (for Falcon mode) 30617ad2cc79SPeter Korsgaard 306206f60ae3SScott Wood CONFIG_SPL_MPC83XX_WAIT_FOR_NAND 306306f60ae3SScott Wood Set this for NAND SPL on PPC mpc83xx targets, so that 306406f60ae3SScott Wood start.S waits for the rest of the SPL to load before 306506f60ae3SScott Wood continuing (the hardware starts execution after just 306606f60ae3SScott Wood loading the first page rather than the full 4K). 306706f60ae3SScott Wood 30686f2f01b9SScott Wood CONFIG_SPL_NAND_BASE 30696f2f01b9SScott Wood Include nand_base.c in the SPL. Requires 30706f2f01b9SScott Wood CONFIG_SPL_NAND_DRIVERS. 30716f2f01b9SScott Wood 30726f2f01b9SScott Wood CONFIG_SPL_NAND_DRIVERS 30736f2f01b9SScott Wood SPL uses normal NAND drivers, not minimal drivers. 30746f2f01b9SScott Wood 30756f2f01b9SScott Wood CONFIG_SPL_NAND_ECC 30766f2f01b9SScott Wood Include standard software ECC in the SPL 30776f2f01b9SScott Wood 307895579793STom Rini CONFIG_SPL_NAND_SIMPLE 30797d4b7955SScott Wood Support for NAND boot using simple NAND drivers that 30807d4b7955SScott Wood expose the cmd_ctrl() interface. 308195579793STom Rini 308295579793STom Rini CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT, 308395579793STom Rini CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE, 308495579793STom Rini CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS, 308595579793STom Rini CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE, 308695579793STom Rini CONFIG_SYS_NAND_ECCBYTES 308795579793STom Rini Defines the size and behavior of the NAND that SPL uses 30887d4b7955SScott Wood to read U-Boot 308995579793STom Rini 309095579793STom Rini CONFIG_SYS_NAND_U_BOOT_OFFS 30917d4b7955SScott Wood Location in NAND to read U-Boot from 30927d4b7955SScott Wood 30937d4b7955SScott Wood CONFIG_SYS_NAND_U_BOOT_DST 30947d4b7955SScott Wood Location in memory to load U-Boot to 30957d4b7955SScott Wood 30967d4b7955SScott Wood CONFIG_SYS_NAND_U_BOOT_SIZE 30977d4b7955SScott Wood Size of image to load 309895579793STom Rini 309995579793STom Rini CONFIG_SYS_NAND_U_BOOT_START 31007d4b7955SScott Wood Entry point in loaded image to jump to 310195579793STom Rini 310295579793STom Rini CONFIG_SYS_NAND_HW_ECC_OOBFIRST 310395579793STom Rini Define this if you need to first read the OOB and then the 310495579793STom Rini data. This is used for example on davinci plattforms. 310595579793STom Rini 310695579793STom Rini CONFIG_SPL_OMAP3_ID_NAND 310795579793STom Rini Support for an OMAP3-specific set of functions to return the 310895579793STom Rini ID and MFR of the first attached NAND chip, if present. 310995579793STom Rini 31106a11cf48SDaniel Schwierzeck CONFIG_SPL_SERIAL_SUPPORT 31116a11cf48SDaniel Schwierzeck Support for drivers/serial/libserial.o in SPL binary 31126a11cf48SDaniel Schwierzeck 31136a11cf48SDaniel Schwierzeck CONFIG_SPL_SPI_FLASH_SUPPORT 31146a11cf48SDaniel Schwierzeck Support for drivers/mtd/spi/libspi_flash.o in SPL binary 31156a11cf48SDaniel Schwierzeck 31166a11cf48SDaniel Schwierzeck CONFIG_SPL_SPI_SUPPORT 31176a11cf48SDaniel Schwierzeck Support for drivers/spi/libspi.o in SPL binary 31186a11cf48SDaniel Schwierzeck 3119c57b953dSPavel Machek CONFIG_SPL_RAM_DEVICE 3120c57b953dSPavel Machek Support for running image already present in ram, in SPL binary 3121c57b953dSPavel Machek 31226a11cf48SDaniel Schwierzeck CONFIG_SPL_LIBGENERIC_SUPPORT 31236a11cf48SDaniel Schwierzeck Support for lib/libgeneric.o in SPL binary 31241372cce2SMarian Balakowicz 3125ba1bee43SYing Zhang CONFIG_SPL_ENV_SUPPORT 3126ba1bee43SYing Zhang Support for the environment operating in SPL binary 3127ba1bee43SYing Zhang 3128ba1bee43SYing Zhang CONFIG_SPL_NET_SUPPORT 3129ba1bee43SYing Zhang Support for the net/libnet.o in SPL binary. 3130ba1bee43SYing Zhang It conflicts with SPL env from storage medium specified by 3131ba1bee43SYing Zhang CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE 3132ba1bee43SYing Zhang 313374752baaSScott Wood CONFIG_SPL_PAD_TO 31346113d3f2SBenoît Thébaudeau Image offset to which the SPL should be padded before appending 31356113d3f2SBenoît Thébaudeau the SPL payload. By default, this is defined as 31366113d3f2SBenoît Thébaudeau CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined. 31376113d3f2SBenoît Thébaudeau CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL 31386113d3f2SBenoît Thébaudeau payload without any padding, or >= CONFIG_SPL_MAX_SIZE. 313974752baaSScott Wood 3140ca2fca22SScott Wood CONFIG_SPL_TARGET 3141ca2fca22SScott Wood Final target image containing SPL and payload. Some SPLs 3142ca2fca22SScott Wood use an arch-specific makefile fragment instead, for 3143ca2fca22SScott Wood example if more than one image needs to be produced. 3144ca2fca22SScott Wood 314587ebee39SSimon Glass CONFIG_FIT_SPL_PRINT 314687ebee39SSimon Glass Printing information about a FIT image adds quite a bit of 314787ebee39SSimon Glass code to SPL. So this is normally disabled in SPL. Use this 314887ebee39SSimon Glass option to re-enable it. This will affect the output of the 314987ebee39SSimon Glass bootm command when booting a FIT image. 315087ebee39SSimon Glass 3151c609719bSwdenkModem Support: 3152c609719bSwdenk-------------- 3153c609719bSwdenk 3154566e5cf4SWolfgang Denk[so far only for SMDK2400 boards] 3155c609719bSwdenk 315611ccc33fSMarcel Ziswiler- Modem support enable: 3157c609719bSwdenk CONFIG_MODEM_SUPPORT 3158c609719bSwdenk 3159c609719bSwdenk- RTS/CTS Flow control enable: 3160c609719bSwdenk CONFIG_HWFLOW 3161c609719bSwdenk 3162c609719bSwdenk- Modem debug support: 3163c609719bSwdenk CONFIG_MODEM_SUPPORT_DEBUG 3164c609719bSwdenk 3165c609719bSwdenk Enables debugging stuff (char screen[1024], dbg()) 3166c609719bSwdenk for modem support. Useful only with BDI2000. 3167c609719bSwdenk 3168a8c7c708Swdenk- Interrupt support (PPC): 3169a8c7c708Swdenk 3170a8c7c708Swdenk There are common interrupt_init() and timer_interrupt() 3171a8c7c708Swdenk for all PPC archs. interrupt_init() calls interrupt_init_cpu() 317211ccc33fSMarcel Ziswiler for CPU specific initialization. interrupt_init_cpu() 3173a8c7c708Swdenk should set decrementer_count to appropriate value. If 317411ccc33fSMarcel Ziswiler CPU resets decrementer automatically after interrupt 3175a8c7c708Swdenk (ppc4xx) it should set decrementer_count to zero. 317611ccc33fSMarcel Ziswiler timer_interrupt() calls timer_interrupt_cpu() for CPU 3177a8c7c708Swdenk specific handling. If board has watchdog / status_led 3178a8c7c708Swdenk / other_activity_monitor it works automatically from 3179a8c7c708Swdenk general timer_interrupt(). 3180a8c7c708Swdenk 3181c609719bSwdenk- General: 3182c609719bSwdenk 3183c609719bSwdenk In the target system modem support is enabled when a 3184c609719bSwdenk specific key (key combination) is pressed during 3185c609719bSwdenk power-on. Otherwise U-Boot will boot normally 318611ccc33fSMarcel Ziswiler (autoboot). The key_pressed() function is called from 3187c609719bSwdenk board_init(). Currently key_pressed() is a dummy 3188c609719bSwdenk function, returning 1 and thus enabling modem 3189c609719bSwdenk initialization. 3190c609719bSwdenk 3191c609719bSwdenk If there are no modem init strings in the 3192c609719bSwdenk environment, U-Boot proceed to autoboot; the 3193c609719bSwdenk previous output (banner, info printfs) will be 319411ccc33fSMarcel Ziswiler suppressed, though. 3195c609719bSwdenk 3196c609719bSwdenk See also: doc/README.Modem 3197c609719bSwdenk 31989660e442SHelmut RaigerBoard initialization settings: 31999660e442SHelmut Raiger------------------------------ 32009660e442SHelmut Raiger 32019660e442SHelmut RaigerDuring Initialization u-boot calls a number of board specific functions 32029660e442SHelmut Raigerto allow the preparation of board specific prerequisites, e.g. pin setup 32039660e442SHelmut Raigerbefore drivers are initialized. To enable these callbacks the 32049660e442SHelmut Raigerfollowing configuration macros have to be defined. Currently this is 32059660e442SHelmut Raigerarchitecture specific, so please check arch/your_architecture/lib/board.c 32069660e442SHelmut Raigertypically in board_init_f() and board_init_r(). 32079660e442SHelmut Raiger 32089660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f() 32099660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r() 32109660e442SHelmut Raiger- CONFIG_BOARD_LATE_INIT: Call board_late_init() 32119660e442SHelmut Raiger- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init() 3212c609719bSwdenk 3213c609719bSwdenkConfiguration Settings: 3214c609719bSwdenk----------------------- 3215c609719bSwdenk 32166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included; 3217c609719bSwdenk undefine this when you're short of memory. 3218c609719bSwdenk 32192fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default 32202fb2604dSPeter Tyser width of the commands listed in the 'help' command output. 32212fb2604dSPeter Tyser 32226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to 3223c609719bSwdenk prompt for user input. 3224c609719bSwdenk 32256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE: Buffer size for input from the Console 3226c609719bSwdenk 32276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE: Buffer size for Console output 3228c609719bSwdenk 32296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands 3230c609719bSwdenk 32316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to 3232c609719bSwdenk the application (usually a Linux kernel) when it is 3233c609719bSwdenk booted 3234c609719bSwdenk 32356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE: 3236c609719bSwdenk List of legal baudrate settings for this board. 3237c609719bSwdenk 32386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET 3239c609719bSwdenk Suppress display of console information at boot. 3240c609719bSwdenk 32416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV 3242c609719bSwdenk If the board specific function 3243c609719bSwdenk extern int overwrite_console (void); 3244c609719bSwdenk returns 1, the stdin, stderr and stdout are switched to the 3245c609719bSwdenk serial port, else the settings in the environment are used. 3246c609719bSwdenk 32476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE 3248c609719bSwdenk Enable the call to overwrite_console(). 3249c609719bSwdenk 32506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE 3251c609719bSwdenk Enable overwrite of previous console environment settings. 3252c609719bSwdenk 32536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END: 3254c609719bSwdenk Begin and End addresses of the area used by the 3255c609719bSwdenk simple memory test. 3256c609719bSwdenk 32576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST: 3258c609719bSwdenk Enable an alternate, more extensive memory test. 3259c609719bSwdenk 32606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH: 32615f535fe1Swdenk Scratch address used by the alternate memory test 32625f535fe1Swdenk You only need to set this if address zero isn't writeable 32635f535fe1Swdenk 32646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only): 32656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header, 326614f73ca6SStefan Roese this specified memory area will get subtracted from the top 326711ccc33fSMarcel Ziswiler (end) of RAM and won't get "touched" at all by U-Boot. By 326814f73ca6SStefan Roese fixing up gd->ram_size the Linux kernel should gets passed 326914f73ca6SStefan Roese the now "corrected" memory size and won't touch it either. 327014f73ca6SStefan Roese This should work for arch/ppc and arch/powerpc. Only Linux 32715e12e75dSStefan Roese board ports in arch/powerpc with bootwrapper support that 327214f73ca6SStefan Roese recalculate the memory size from the SDRAM controller setup 32735e12e75dSStefan Roese will have to get fixed in Linux additionally. 327414f73ca6SStefan Roese 327514f73ca6SStefan Roese This option can be used as a workaround for the 440EPx/GRx 327614f73ca6SStefan Roese CHIP 11 errata where the last 256 bytes in SDRAM shouldn't 327714f73ca6SStefan Roese be touched. 327814f73ca6SStefan Roese 327914f73ca6SStefan Roese WARNING: Please make sure that this value is a multiple of 328014f73ca6SStefan Roese the Linux page size (normally 4k). If this is not the case, 328114f73ca6SStefan Roese then the end address of the Linux memory will be located at a 328214f73ca6SStefan Roese non page size aligned address and this could cause major 328314f73ca6SStefan Roese problems. 328414f73ca6SStefan Roese 32856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE: 3286c609719bSwdenk Enable temporary baudrate change while serial download 3287c609719bSwdenk 32886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE: 3289c609719bSwdenk Physical start address of SDRAM. _Must_ be 0 here. 3290c609719bSwdenk 32916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE: 3292c609719bSwdenk Physical start address of Motherboard I/O (if using a 3293c609719bSwdenk Cogent motherboard) 3294c609719bSwdenk 32956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE: 3296c609719bSwdenk Physical start address of Flash memory. 3297c609719bSwdenk 32986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE: 3299c609719bSwdenk Physical start address of boot monitor code (set by 3300c609719bSwdenk make config files to be same as the text base address 330114d0a02aSWolfgang Denk (CONFIG_SYS_TEXT_BASE) used when linking) - same as 33026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FLASH_BASE when booting from flash. 3303c609719bSwdenk 33046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN: 33053b57fe0aSwdenk Size of memory reserved for monitor code, used to 33063b57fe0aSwdenk determine _at_compile_time_ (!) if the environment is 33073b57fe0aSwdenk embedded within the U-Boot image, or in a separate 33083b57fe0aSwdenk flash sector. 3309c609719bSwdenk 33106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN: 3311c609719bSwdenk Size of DRAM reserved for malloc() use. 3312c609719bSwdenk 33136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN: 331415940c9aSStefan Roese Normally compressed uImages are limited to an 331515940c9aSStefan Roese uncompressed size of 8 MBytes. If this is not enough, 33166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD you can define CONFIG_SYS_BOOTM_LEN in your board config file 331715940c9aSStefan Roese to adjust this setting to your needs. 3318c609719bSwdenk 33196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ: 3320c609719bSwdenk Maximum size of memory mapped by the startup code of 3321c609719bSwdenk the Linux kernel; all data that must be processed by 33227d721e34SBartlomiej Sieka the Linux kernel (bd_info, boot arguments, FDT blob if 33237d721e34SBartlomiej Sieka used) must be put below this limit, unless "bootm_low" 33247d721e34SBartlomiej Sieka enviroment variable is defined and non-zero. In such case 33257d721e34SBartlomiej Sieka all data for the Linux kernel must be between "bootm_low" 3326c3624e6eSGrant Likely and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment 3327c3624e6eSGrant Likely variable "bootm_mapsize" will override the value of 3328c3624e6eSGrant Likely CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined, 3329c3624e6eSGrant Likely then the value in "bootm_size" will be used instead. 3330c609719bSwdenk 3331fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH: 3332fca43cc8SJohn Rigby Enable initrd_high functionality. If defined then the 3333fca43cc8SJohn Rigby initrd_high feature is enabled and the bootm ramdisk subcommand 3334fca43cc8SJohn Rigby is enabled. 3335fca43cc8SJohn Rigby 3336fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE: 3337fca43cc8SJohn Rigby Enables allocating and saving kernel cmdline in space between 3338fca43cc8SJohn Rigby "bootm_low" and "bootm_low" + BOOTMAPSZ. 3339fca43cc8SJohn Rigby 3340fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD: 3341fca43cc8SJohn Rigby Enables allocating and saving a kernel copy of the bd_info in 3342fca43cc8SJohn Rigby space between "bootm_low" and "bootm_low" + BOOTMAPSZ. 3343fca43cc8SJohn Rigby 33446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS: 3345c609719bSwdenk Max number of Flash memory banks 3346c609719bSwdenk 33476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT: 3348c609719bSwdenk Max number of sectors on a Flash chip 3349c609719bSwdenk 33506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT: 3351c609719bSwdenk Timeout for Flash erase operations (in ms) 3352c609719bSwdenk 33536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT: 3354c609719bSwdenk Timeout for Flash write operations (in ms) 3355c609719bSwdenk 33566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT 33578564acf9Swdenk Timeout for Flash set sector lock bit operation (in ms) 33588564acf9Swdenk 33596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT 33608564acf9Swdenk Timeout for Flash clear lock bits operation (in ms) 33618564acf9Swdenk 33626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION 33638564acf9Swdenk If defined, hardware flash sectors protection is used 33648564acf9Swdenk instead of U-Boot software protection. 33658564acf9Swdenk 33666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP: 3367c609719bSwdenk 3368c609719bSwdenk Enable TFTP transfers directly to flash memory; 3369c609719bSwdenk without this option such a download has to be 3370c609719bSwdenk performed in two steps: (1) download to RAM, and (2) 3371c609719bSwdenk copy from RAM to flash. 3372c609719bSwdenk 3373c609719bSwdenk The two-step approach is usually more reliable, since 3374c609719bSwdenk you can check if the download worked before you erase 337511ccc33fSMarcel Ziswiler the flash, but in some situations (when system RAM is 337611ccc33fSMarcel Ziswiler too limited to allow for a temporary copy of the 3377c609719bSwdenk downloaded image) this option may be very useful. 3378c609719bSwdenk 33796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI: 3380c609719bSwdenk Define if the flash driver uses extra elements in the 33815653fc33Swdenk common flash structure for storing flash geometry. 33825653fc33Swdenk 338300b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER 33845653fc33Swdenk This option also enables the building of the cfi_flash driver 33855653fc33Swdenk in the drivers directory 338653cf9435Sstroese 338791809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD 338891809ed5SPiotr Ziecik This option enables the building of the cfi_mtd driver 338991809ed5SPiotr Ziecik in the drivers directory. The driver exports CFI flash 339091809ed5SPiotr Ziecik to the MTD layer. 339191809ed5SPiotr Ziecik 33926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE 339396ef831fSGuennadi Liakhovetski Use buffered writes to flash. 339496ef831fSGuennadi Liakhovetski 339596ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N 339696ef831fSGuennadi Liakhovetski s29ws-n MirrorBit flash has non-standard addresses for buffered 339796ef831fSGuennadi Liakhovetski write commands. 339896ef831fSGuennadi Liakhovetski 33996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST 34005568e613SStefan Roese If this option is defined, the common CFI flash doesn't 34015568e613SStefan Roese print it's warning upon not recognized FLASH banks. This 34025568e613SStefan Roese is useful, if some of the configured banks are only 34035568e613SStefan Roese optionally available. 34045568e613SStefan Roese 34059a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS 34069a042e9cSJerry Van Baren If defined (must be an integer), print out countdown 34079a042e9cSJerry Van Baren digits and dots. Recommended value: 45 (9..1) for 80 34089a042e9cSJerry Van Baren column displays, 15 (3..1) for 40 column displays. 34099a042e9cSJerry Van Baren 3410352ef3f1SStefan Roese- CONFIG_FLASH_VERIFY 3411352ef3f1SStefan Roese If defined, the content of the flash (destination) is compared 3412352ef3f1SStefan Roese against the source after the write operation. An error message 3413352ef3f1SStefan Roese will be printed when the contents are not identical. 3414352ef3f1SStefan Roese Please note that this option is useless in nearly all cases, 3415352ef3f1SStefan Roese since such flash programming errors usually are detected earlier 3416352ef3f1SStefan Roese while unprotecting/erasing/programming. Please only enable 3417352ef3f1SStefan Roese this option if you really know what you are doing. 3418352ef3f1SStefan Roese 34196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER: 342011ccc33fSMarcel Ziswiler Defines the number of Ethernet receive buffers. On some 342111ccc33fSMarcel Ziswiler Ethernet controllers it is recommended to set this value 342253cf9435Sstroese to 8 or even higher (EEPRO100 or 405 EMAC), since all 342353cf9435Sstroese buffers can be full shortly after enabling the interface 342411ccc33fSMarcel Ziswiler on high Ethernet traffic. 342553cf9435Sstroese Defaults to 4 if not defined. 3426c609719bSwdenk 3427ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES 3428ea882bafSWolfgang Denk 3429ea882bafSWolfgang Denk Maximum number of entries in the hash table that is used 3430ea882bafSWolfgang Denk internally to store the environment settings. The default 3431ea882bafSWolfgang Denk setting is supposed to be generous and should work in most 3432ea882bafSWolfgang Denk cases. This setting can be used to tune behaviour; see 3433ea882bafSWolfgang Denk lib/hashtable.c for details. 3434ea882bafSWolfgang Denk 34352598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_DEFAULT 34362598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_STATIC 34372598090bSJoe Hershberger Enable validation of the values given to enviroment variables when 34382598090bSJoe Hershberger calling env set. Variables can be restricted to only decimal, 34392598090bSJoe Hershberger hexadecimal, or boolean. If CONFIG_CMD_NET is also defined, 34402598090bSJoe Hershberger the variables can also be restricted to IP address or MAC address. 34412598090bSJoe Hershberger 34422598090bSJoe Hershberger The format of the list is: 34432598090bSJoe Hershberger type_attribute = [s|d|x|b|i|m] 3444267541f7SJoe Hershberger access_atribute = [a|r|o|c] 3445267541f7SJoe Hershberger attributes = type_attribute[access_atribute] 34462598090bSJoe Hershberger entry = variable_name[:attributes] 34472598090bSJoe Hershberger list = entry[,list] 34482598090bSJoe Hershberger 34492598090bSJoe Hershberger The type attributes are: 34502598090bSJoe Hershberger s - String (default) 34512598090bSJoe Hershberger d - Decimal 34522598090bSJoe Hershberger x - Hexadecimal 34532598090bSJoe Hershberger b - Boolean ([1yYtT|0nNfF]) 34542598090bSJoe Hershberger i - IP address 34552598090bSJoe Hershberger m - MAC address 34562598090bSJoe Hershberger 3457267541f7SJoe Hershberger The access attributes are: 3458267541f7SJoe Hershberger a - Any (default) 3459267541f7SJoe Hershberger r - Read-only 3460267541f7SJoe Hershberger o - Write-once 3461267541f7SJoe Hershberger c - Change-default 3462267541f7SJoe Hershberger 34632598090bSJoe Hershberger - CONFIG_ENV_FLAGS_LIST_DEFAULT 34642598090bSJoe Hershberger Define this to a list (string) to define the ".flags" 34652598090bSJoe Hershberger envirnoment variable in the default or embedded environment. 34662598090bSJoe Hershberger 34672598090bSJoe Hershberger - CONFIG_ENV_FLAGS_LIST_STATIC 34682598090bSJoe Hershberger Define this to a list (string) to define validation that 34692598090bSJoe Hershberger should be done if an entry is not found in the ".flags" 34702598090bSJoe Hershberger environment variable. To override a setting in the static 34712598090bSJoe Hershberger list, simply add an entry for the same variable name to the 34722598090bSJoe Hershberger ".flags" variable. 34732598090bSJoe Hershberger 3474267541f7SJoe Hershberger- CONFIG_ENV_ACCESS_IGNORE_FORCE 3475267541f7SJoe Hershberger If defined, don't allow the -f switch to env set override variable 3476267541f7SJoe Hershberger access flags. 3477267541f7SJoe Hershberger 34785c1a7ea6SSimon Glass- CONFIG_SYS_GENERIC_BOARD 34795c1a7ea6SSimon Glass This selects the architecture-generic board system instead of the 34805c1a7ea6SSimon Glass architecture-specific board files. It is intended to move boards 34815c1a7ea6SSimon Glass to this new framework over time. Defining this will disable the 34825c1a7ea6SSimon Glass arch/foo/lib/board.c file and use common/board_f.c and 34835c1a7ea6SSimon Glass common/board_r.c instead. To use this option your architecture 34845c1a7ea6SSimon Glass must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in 34855c1a7ea6SSimon Glass its config.mk file). If you find problems enabling this option on 34865c1a7ea6SSimon Glass your board please report the problem and send patches! 34875c1a7ea6SSimon Glass 3488632efa74SSimon Glass- CONFIG_SYS_SYM_OFFSETS 3489632efa74SSimon Glass This is set by architectures that use offsets for link symbols 3490632efa74SSimon Glass instead of absolute values. So bss_start is obtained using an 3491632efa74SSimon Glass offset _bss_start_ofs from CONFIG_SYS_TEXT_BASE, rather than 3492632efa74SSimon Glass directly. You should not need to touch this setting. 3493632efa74SSimon Glass 34940b1b60c7SLokesh Vutla- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only) 34950b1b60c7SLokesh Vutla This is set by OMAP boards for the max time that reset should 34960b1b60c7SLokesh Vutla be asserted. See doc/README.omap-reset-time for details on how 34970b1b60c7SLokesh Vutla the value can be calulated on a given board. 3498632efa74SSimon Glass 3499c609719bSwdenkThe following definitions that deal with the placement and management 3500c609719bSwdenkof environment data (variable area); in general, we support the 3501c609719bSwdenkfollowing configurations: 3502c609719bSwdenk 3503c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC: 3504c3eb3fe4SMike Frysinger 3505c3eb3fe4SMike Frysinger Builds up envcrc with the target environment so that external utils 3506c3eb3fe4SMike Frysinger may easily extract it and embed it in final U-Boot images. 3507c3eb3fe4SMike Frysinger 35085a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH: 3509c609719bSwdenk 3510c609719bSwdenk Define this if the environment is in flash memory. 3511c609719bSwdenk 3512c609719bSwdenk a) The environment occupies one whole flash sector, which is 3513c609719bSwdenk "embedded" in the text segment with the U-Boot code. This 3514c609719bSwdenk happens usually with "bottom boot sector" or "top boot 3515c609719bSwdenk sector" type flash chips, which have several smaller 3516c609719bSwdenk sectors at the start or the end. For instance, such a 3517c609719bSwdenk layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In 3518c609719bSwdenk such a case you would place the environment in one of the 3519c609719bSwdenk 4 kB sectors - with U-Boot code before and after it. With 3520c609719bSwdenk "top boot sector" type flash chips, you would put the 3521c609719bSwdenk environment in one of the last sectors, leaving a gap 3522c609719bSwdenk between U-Boot and the environment. 3523c609719bSwdenk 35240e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 3525c609719bSwdenk 3526c609719bSwdenk Offset of environment data (variable area) to the 3527c609719bSwdenk beginning of flash memory; for instance, with bottom boot 3528c609719bSwdenk type flash chips the second sector can be used: the offset 3529c609719bSwdenk for this sector is given here. 3530c609719bSwdenk 35316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE. 3532c609719bSwdenk 35330e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 3534c609719bSwdenk 3535c609719bSwdenk This is just another way to specify the start address of 3536c609719bSwdenk the flash sector containing the environment (instead of 35370e8d1586SJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_OFFSET). 3538c609719bSwdenk 35390e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SECT_SIZE: 3540c609719bSwdenk 3541c609719bSwdenk Size of the sector containing the environment. 3542c609719bSwdenk 3543c609719bSwdenk 3544c609719bSwdenk b) Sometimes flash chips have few, equal sized, BIG sectors. 3545c609719bSwdenk In such a case you don't want to spend a whole sector for 3546c609719bSwdenk the environment. 3547c609719bSwdenk 35480e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 3549c609719bSwdenk 35505a1aceb0SJean-Christophe PLAGNIOL-VILLARD If you use this in combination with CONFIG_ENV_IS_IN_FLASH 35510e8d1586SJean-Christophe PLAGNIOL-VILLARD and CONFIG_ENV_SECT_SIZE, you can specify to use only a part 3552c609719bSwdenk of this flash sector for the environment. This saves 3553c609719bSwdenk memory for the RAM copy of the environment. 3554c609719bSwdenk 3555c609719bSwdenk It may also save flash memory if you decide to use this 3556c609719bSwdenk when your environment is "embedded" within U-Boot code, 3557c609719bSwdenk since then the remainder of the flash sector could be used 3558c609719bSwdenk for U-Boot code. It should be pointed out that this is 3559c609719bSwdenk STRONGLY DISCOURAGED from a robustness point of view: 3560c609719bSwdenk updating the environment in flash makes it always 3561c609719bSwdenk necessary to erase the WHOLE sector. If something goes 3562c609719bSwdenk wrong before the contents has been restored from a copy in 3563c609719bSwdenk RAM, your target system will be dead. 3564c609719bSwdenk 35650e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR_REDUND 35660e8d1586SJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_SIZE_REDUND 3567c609719bSwdenk 3568c609719bSwdenk These settings describe a second storage area used to hold 356911ccc33fSMarcel Ziswiler a redundant copy of the environment data, so that there is 35703e38691eSwdenk a valid backup copy in case there is a power failure during 3571c609719bSwdenk a "saveenv" operation. 3572c609719bSwdenk 3573c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the 3574c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds* 3575c609719bSwdenkaccordingly! 3576c609719bSwdenk 3577c609719bSwdenk 35789314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM: 3579c609719bSwdenk 3580c609719bSwdenk Define this if you have some non-volatile memory device 3581c609719bSwdenk (NVRAM, battery buffered SRAM) which you want to use for the 3582c609719bSwdenk environment. 3583c609719bSwdenk 35840e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 35850e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 3586c609719bSwdenk 358711ccc33fSMarcel Ziswiler These two #defines are used to determine the memory area you 3588c609719bSwdenk want to use for environment. It is assumed that this memory 3589c609719bSwdenk can just be read and written to, without any special 3590c609719bSwdenk provision. 3591c609719bSwdenk 3592c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early 3593c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the 359411ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or 3595c609719bSwdenkU-Boot will hang. 3596c609719bSwdenk 3597c609719bSwdenkPlease note that even with NVRAM we still use a copy of the 3598c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to 3599c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv" 3600c609719bSwdenkto save the current settings. 3601c609719bSwdenk 3602c609719bSwdenk 3603bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM: 3604c609719bSwdenk 3605c609719bSwdenk Use this if you have an EEPROM or similar serial access 3606c609719bSwdenk device and a driver for it. 3607c609719bSwdenk 36080e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 36090e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 3610c609719bSwdenk 3611c609719bSwdenk These two #defines specify the offset and size of the 3612c609719bSwdenk environment area within the total memory of your EEPROM. 3613c609719bSwdenk 36146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR: 3615c609719bSwdenk If defined, specified the chip address of the EEPROM device. 3616c609719bSwdenk The default address is zero. 3617c609719bSwdenk 36186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS: 3619c609719bSwdenk If defined, the number of bits used to address bytes in a 3620c609719bSwdenk single page in the EEPROM device. A 64 byte page, for example 3621c609719bSwdenk would require six bits. 3622c609719bSwdenk 36236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS: 3624c609719bSwdenk If defined, the number of milliseconds to delay between 3625c609719bSwdenk page writes. The default is zero milliseconds. 3626c609719bSwdenk 36276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR_LEN: 3628c609719bSwdenk The length in bytes of the EEPROM memory array address. Note 3629c609719bSwdenk that this is NOT the chip address length! 3630c609719bSwdenk 36316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW: 36325cf91d6bSwdenk EEPROM chips that implement "address overflow" are ones 36335cf91d6bSwdenk like Catalyst 24WC04/08/16 which has 9/10/11 bits of 36345cf91d6bSwdenk address and the extra bits end up in the "chip address" bit 36355cf91d6bSwdenk slots. This makes a 24WC08 (1Kbyte) chip look like four 256 36365cf91d6bSwdenk byte chips. 36375cf91d6bSwdenk 36385cf91d6bSwdenk Note that we consider the length of the address field to 36395cf91d6bSwdenk still be one byte because the extra address bits are hidden 36405cf91d6bSwdenk in the chip address. 36415cf91d6bSwdenk 36426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_SIZE: 3643c609719bSwdenk The size in bytes of the EEPROM device. 3644c609719bSwdenk 3645548738b4SHeiko Schocher - CONFIG_ENV_EEPROM_IS_ON_I2C 3646548738b4SHeiko Schocher define this, if you have I2C and SPI activated, and your 3647548738b4SHeiko Schocher EEPROM, which holds the environment, is on the I2C bus. 3648548738b4SHeiko Schocher 3649548738b4SHeiko Schocher - CONFIG_I2C_ENV_EEPROM_BUS 3650548738b4SHeiko Schocher if you have an Environment on an EEPROM reached over 3651548738b4SHeiko Schocher I2C muxes, you can define here, how to reach this 3652548738b4SHeiko Schocher EEPROM. For example: 3653548738b4SHeiko Schocher 3654ea818dbbSHeiko Schocher #define CONFIG_I2C_ENV_EEPROM_BUS 1 3655548738b4SHeiko Schocher 3656548738b4SHeiko Schocher EEPROM which holds the environment, is reached over 3657548738b4SHeiko Schocher a pca9547 i2c mux with address 0x70, channel 3. 3658c609719bSwdenk 3659057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH: 36605779d8d9Swdenk 36615779d8d9Swdenk Define this if you have a DataFlash memory device which you 36625779d8d9Swdenk want to use for the environment. 36635779d8d9Swdenk 36640e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 36650e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 36660e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 36675779d8d9Swdenk 36685779d8d9Swdenk These three #defines specify the offset and size of the 36695779d8d9Swdenk environment area within the total memory of your DataFlash placed 36705779d8d9Swdenk at the specified address. 36715779d8d9Swdenk 36720a85a9e7SLiu Gang- CONFIG_ENV_IS_IN_REMOTE: 36730a85a9e7SLiu Gang 36740a85a9e7SLiu Gang Define this if you have a remote memory space which you 36750a85a9e7SLiu Gang want to use for the local device's environment. 36760a85a9e7SLiu Gang 36770a85a9e7SLiu Gang - CONFIG_ENV_ADDR: 36780a85a9e7SLiu Gang - CONFIG_ENV_SIZE: 36790a85a9e7SLiu Gang 36800a85a9e7SLiu Gang These two #defines specify the address and size of the 36810a85a9e7SLiu Gang environment area within the remote memory space. The 36820a85a9e7SLiu Gang local device can get the environment from remote memory 3683fc54c7faSLiu Gang space by SRIO or PCIE links. 36840a85a9e7SLiu Gang 36850a85a9e7SLiu GangBE CAREFUL! For some special cases, the local device can not use 36860a85a9e7SLiu Gang"saveenv" command. For example, the local device will get the 3687fc54c7faSLiu Gangenvironment stored in a remote NOR flash by SRIO or PCIE link, 3688fc54c7faSLiu Gangbut it can not erase, write this NOR flash by SRIO or PCIE interface. 36890a85a9e7SLiu Gang 369051bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND: 369113a5695bSwdenk 369213a5695bSwdenk Define this if you have a NAND device which you want to use 369313a5695bSwdenk for the environment. 369413a5695bSwdenk 36950e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 36960e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 369713a5695bSwdenk 369813a5695bSwdenk These two #defines specify the offset and size of the environment 3699fdd813deSScott Wood area within the first NAND device. CONFIG_ENV_OFFSET must be 3700fdd813deSScott Wood aligned to an erase block boundary. 37015779d8d9Swdenk 3702fdd813deSScott Wood - CONFIG_ENV_OFFSET_REDUND (optional): 3703e443c944SMarkus Klotzbuecher 37040e8d1586SJean-Christophe PLAGNIOL-VILLARD This setting describes a second storage area of CONFIG_ENV_SIZE 3705fdd813deSScott Wood size used to hold a redundant copy of the environment data, so 3706fdd813deSScott Wood that there is a valid backup copy in case there is a power failure 3707fdd813deSScott Wood during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be 3708fdd813deSScott Wood aligned to an erase block boundary. 3709e443c944SMarkus Klotzbuecher 3710fdd813deSScott Wood - CONFIG_ENV_RANGE (optional): 3711fdd813deSScott Wood 3712fdd813deSScott Wood Specifies the length of the region in which the environment 3713fdd813deSScott Wood can be written. This should be a multiple of the NAND device's 3714fdd813deSScott Wood block size. Specifying a range with more erase blocks than 3715fdd813deSScott Wood are needed to hold CONFIG_ENV_SIZE allows bad blocks within 3716fdd813deSScott Wood the range to be avoided. 3717fdd813deSScott Wood 3718fdd813deSScott Wood - CONFIG_ENV_OFFSET_OOB (optional): 3719fdd813deSScott Wood 3720fdd813deSScott Wood Enables support for dynamically retrieving the offset of the 3721fdd813deSScott Wood environment from block zero's out-of-band data. The 3722fdd813deSScott Wood "nand env.oob" command can be used to record this offset. 3723fdd813deSScott Wood Currently, CONFIG_ENV_OFFSET_REDUND is not supported when 3724fdd813deSScott Wood using CONFIG_ENV_OFFSET_OOB. 3725e443c944SMarkus Klotzbuecher 3726b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST 3727b74ab737SGuennadi Liakhovetski 3728b74ab737SGuennadi Liakhovetski Defines address in RAM to which the nand_spl code should copy the 3729b74ab737SGuennadi Liakhovetski environment. If redundant environment is used, it will be copied to 3730b74ab737SGuennadi Liakhovetski CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE. 3731b74ab737SGuennadi Liakhovetski 37322b74433fSJoe Hershberger- CONFIG_ENV_IS_IN_UBI: 37332b74433fSJoe Hershberger 37342b74433fSJoe Hershberger Define this if you have an UBI volume that you want to use for the 37352b74433fSJoe Hershberger environment. This has the benefit of wear-leveling the environment 37362b74433fSJoe Hershberger accesses, which is important on NAND. 37372b74433fSJoe Hershberger 37382b74433fSJoe Hershberger - CONFIG_ENV_UBI_PART: 37392b74433fSJoe Hershberger 37402b74433fSJoe Hershberger Define this to a string that is the mtd partition containing the UBI. 37412b74433fSJoe Hershberger 37422b74433fSJoe Hershberger - CONFIG_ENV_UBI_VOLUME: 37432b74433fSJoe Hershberger 37442b74433fSJoe Hershberger Define this to the name of the volume that you want to store the 37452b74433fSJoe Hershberger environment in. 37462b74433fSJoe Hershberger 3747785881f7SJoe Hershberger - CONFIG_ENV_UBI_VOLUME_REDUND: 3748785881f7SJoe Hershberger 3749785881f7SJoe Hershberger Define this to the name of another volume to store a second copy of 3750785881f7SJoe Hershberger the environment in. This will enable redundant environments in UBI. 3751785881f7SJoe Hershberger It is assumed that both volumes are in the same MTD partition. 3752785881f7SJoe Hershberger 37532b74433fSJoe Hershberger - CONFIG_UBI_SILENCE_MSG 37542b74433fSJoe Hershberger - CONFIG_UBIFS_SILENCE_MSG 37552b74433fSJoe Hershberger 37562b74433fSJoe Hershberger You will probably want to define these to avoid a really noisy system 37572b74433fSJoe Hershberger when storing the env in UBI. 37582b74433fSJoe Hershberger 375906e4ae5fSStephen Warren- CONFIG_ENV_IS_IN_MMC: 376006e4ae5fSStephen Warren 376106e4ae5fSStephen Warren Define this if you have an MMC device which you want to use for the 376206e4ae5fSStephen Warren environment. 376306e4ae5fSStephen Warren 376406e4ae5fSStephen Warren - CONFIG_SYS_MMC_ENV_DEV: 376506e4ae5fSStephen Warren 376606e4ae5fSStephen Warren Specifies which MMC device the environment is stored in. 376706e4ae5fSStephen Warren 376806e4ae5fSStephen Warren - CONFIG_SYS_MMC_ENV_PART (optional): 376906e4ae5fSStephen Warren 377006e4ae5fSStephen Warren Specifies which MMC partition the environment is stored in. If not 377106e4ae5fSStephen Warren set, defaults to partition 0, the user area. Common values might be 377206e4ae5fSStephen Warren 1 (first MMC boot partition), 2 (second MMC boot partition). 377306e4ae5fSStephen Warren 377406e4ae5fSStephen Warren - CONFIG_ENV_OFFSET: 377506e4ae5fSStephen Warren - CONFIG_ENV_SIZE: 377606e4ae5fSStephen Warren 377706e4ae5fSStephen Warren These two #defines specify the offset and size of the environment 377806e4ae5fSStephen Warren area within the specified MMC device. 377906e4ae5fSStephen Warren 37805c088ee8SStephen Warren If offset is positive (the usual case), it is treated as relative to 37815c088ee8SStephen Warren the start of the MMC partition. If offset is negative, it is treated 37825c088ee8SStephen Warren as relative to the end of the MMC partition. This can be useful if 37835c088ee8SStephen Warren your board may be fitted with different MMC devices, which have 37845c088ee8SStephen Warren different sizes for the MMC partitions, and you always want the 37855c088ee8SStephen Warren environment placed at the very end of the partition, to leave the 37865c088ee8SStephen Warren maximum possible space before it, to store other data. 37875c088ee8SStephen Warren 378806e4ae5fSStephen Warren These two values are in units of bytes, but must be aligned to an 378906e4ae5fSStephen Warren MMC sector boundary. 379006e4ae5fSStephen Warren 379106e4ae5fSStephen Warren - CONFIG_ENV_OFFSET_REDUND (optional): 379206e4ae5fSStephen Warren 379306e4ae5fSStephen Warren Specifies a second storage area, of CONFIG_ENV_SIZE size, used to 379406e4ae5fSStephen Warren hold a redundant copy of the environment data. This provides a 379506e4ae5fSStephen Warren valid backup copy in case the other copy is corrupted, e.g. due 379606e4ae5fSStephen Warren to a power failure during a "saveenv" operation. 379706e4ae5fSStephen Warren 37985c088ee8SStephen Warren This value may also be positive or negative; this is handled in the 37995c088ee8SStephen Warren same way as CONFIG_ENV_OFFSET. 38005c088ee8SStephen Warren 380106e4ae5fSStephen Warren This value is also in units of bytes, but must also be aligned to 380206e4ae5fSStephen Warren an MMC sector boundary. 380306e4ae5fSStephen Warren 380406e4ae5fSStephen Warren - CONFIG_ENV_SIZE_REDUND (optional): 380506e4ae5fSStephen Warren 380606e4ae5fSStephen Warren This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is 380706e4ae5fSStephen Warren set. If this value is set, it must be set to the same value as 380806e4ae5fSStephen Warren CONFIG_ENV_SIZE. 380906e4ae5fSStephen Warren 38106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET 3811c609719bSwdenk 3812c609719bSwdenk Defines offset to the initial SPI buffer area in DPRAM. The 3813c609719bSwdenk area is used at an early stage (ROM part) if the environment 3814c609719bSwdenk is configured to reside in the SPI EEPROM: We need a 520 byte 3815c609719bSwdenk scratch DPRAM area. It is used between the two initialization 3816c609719bSwdenk calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems 3817c609719bSwdenk to be a good choice since it makes it far enough from the 3818c609719bSwdenk start of the data area as well as from the stack pointer. 3819c609719bSwdenk 3820e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor 3821c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been 3822cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f() 3823c609719bSwdenkuntil then to read environment variables. 3824c609719bSwdenk 382585ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor 382685ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working 382785ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is 382885ec0bccSwdenknecessary, because the first environment variable we need is the 382985ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't 383085ec0bccSwdenkhave any device yet where we could complain.] 3831c609719bSwdenk 3832c609719bSwdenkNote: once the monitor has been relocated, then it will complain if 3833c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you 383485ec0bccSwdenkuse the "saveenv" command to store a valid environment. 3835c609719bSwdenk 38366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN: 3837fc3e2165Swdenk Echo the inverted Ethernet link state to the fault LED. 3838fc3e2165Swdenk 38396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR 3840fc3e2165Swdenk also needs to be defined. 3841fc3e2165Swdenk 38426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR: 3843fc3e2165Swdenk MII address of the PHY to check for the Ethernet link state. 3844c609719bSwdenk 3845f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS: 3846f5675aa5SRon Madrid Define this if you desire to only have use of the NS16550_init 3847f5675aa5SRon Madrid and NS16550_putc functions for the serial driver located at 3848f5675aa5SRon Madrid drivers/serial/ns16550.c. This option is useful for saving 3849f5675aa5SRon Madrid space for already greatly restricted images, including but not 3850f5675aa5SRon Madrid limited to NAND_SPL configurations. 3851f5675aa5SRon Madrid 3852b2b92f53SSimon Glass- CONFIG_DISPLAY_BOARDINFO 3853b2b92f53SSimon Glass Display information about the board that U-Boot is running on 3854b2b92f53SSimon Glass when U-Boot starts up. The board function checkboard() is called 3855b2b92f53SSimon Glass to do this. 3856b2b92f53SSimon Glass 3857e2e3e2b1SSimon Glass- CONFIG_DISPLAY_BOARDINFO_LATE 3858e2e3e2b1SSimon Glass Similar to the previous option, but display this information 3859e2e3e2b1SSimon Glass later, once stdio is running and output goes to the LCD, if 3860e2e3e2b1SSimon Glass present. 3861e2e3e2b1SSimon Glass 3862c609719bSwdenkLow Level (hardware related) configuration options: 3863dc7c9a1aSwdenk--------------------------------------------------- 3864c609719bSwdenk 38656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE: 3866c609719bSwdenk Cache Line Size of the CPU. 3867c609719bSwdenk 38686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR: 3869c609719bSwdenk Default address of the IMMR after system reset. 38702535d602Swdenk 38712535d602Swdenk Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU, 38722535d602Swdenk and RPXsuper) to be able to adjust the position of 38732535d602Swdenk the IMMR register after a reset. 3874c609719bSwdenk 3875e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT: 3876e46fedfeSTimur Tabi Default (power-on reset) physical address of CCSR on Freescale 3877e46fedfeSTimur Tabi PowerPC SOCs. 3878e46fedfeSTimur Tabi 3879e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR: 3880e46fedfeSTimur Tabi Virtual address of CCSR. On a 32-bit build, this is typically 3881e46fedfeSTimur Tabi the same value as CONFIG_SYS_CCSRBAR_DEFAULT. 3882e46fedfeSTimur Tabi 3883e46fedfeSTimur Tabi CONFIG_SYS_DEFAULT_IMMR must also be set to this value, 3884e46fedfeSTimur Tabi for cross-platform code that uses that macro instead. 3885e46fedfeSTimur Tabi 3886e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS: 3887e46fedfeSTimur Tabi Physical address of CCSR. CCSR can be relocated to a new 3888e46fedfeSTimur Tabi physical address, if desired. In this case, this macro should 3889e46fedfeSTimur Tabi be set to that address. Otherwise, it should be set to the 3890e46fedfeSTimur Tabi same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR 3891e46fedfeSTimur Tabi is typically relocated on 36-bit builds. It is recommended 3892e46fedfeSTimur Tabi that this macro be defined via the _HIGH and _LOW macros: 3893e46fedfeSTimur Tabi 3894e46fedfeSTimur Tabi #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH 3895e46fedfeSTimur Tabi * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW) 3896e46fedfeSTimur Tabi 3897e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH: 3898e46fedfeSTimur Tabi Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically 3899e46fedfeSTimur Tabi either 0 (32-bit build) or 0xF (36-bit build). This macro is 3900e46fedfeSTimur Tabi used in assembly code, so it must not contain typecasts or 3901e46fedfeSTimur Tabi integer size suffixes (e.g. "ULL"). 3902e46fedfeSTimur Tabi 3903e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW: 3904e46fedfeSTimur Tabi Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is 3905e46fedfeSTimur Tabi used in assembly code, so it must not contain typecasts or 3906e46fedfeSTimur Tabi integer size suffixes (e.g. "ULL"). 3907e46fedfeSTimur Tabi 3908e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE: 3909e46fedfeSTimur Tabi If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be 3910e46fedfeSTimur Tabi forced to a value that ensures that CCSR is not relocated. 3911e46fedfeSTimur Tabi 39127f6c2cbcSwdenk- Floppy Disk Support: 39136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FDC_DRIVE_NUMBER 39147f6c2cbcSwdenk 39157f6c2cbcSwdenk the default drive number (default value 0) 39167f6c2cbcSwdenk 39176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_ISA_IO_STRIDE 39187f6c2cbcSwdenk 391911ccc33fSMarcel Ziswiler defines the spacing between FDC chipset registers 39207f6c2cbcSwdenk (default value 1) 39217f6c2cbcSwdenk 39226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_ISA_IO_OFFSET 39237f6c2cbcSwdenk 39247f6c2cbcSwdenk defines the offset of register from address. It 39257f6c2cbcSwdenk depends on which part of the data bus is connected to 392611ccc33fSMarcel Ziswiler the FDC chipset. (default value 0) 39277f6c2cbcSwdenk 39286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and 39296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their 39307f6c2cbcSwdenk default value. 39317f6c2cbcSwdenk 39326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD if CONFIG_SYS_FDC_HW_INIT is defined, then the function 39337f6c2cbcSwdenk fdc_hw_init() is called at the beginning of the FDC 39347f6c2cbcSwdenk setup. fdc_hw_init() must be provided by the board 39357f6c2cbcSwdenk source code. It is used to make hardware dependant 39367f6c2cbcSwdenk initializations. 39377f6c2cbcSwdenk 39380abddf82SMacpaul Lin- CONFIG_IDE_AHB: 39390abddf82SMacpaul Lin Most IDE controllers were designed to be connected with PCI 39400abddf82SMacpaul Lin interface. Only few of them were designed for AHB interface. 39410abddf82SMacpaul Lin When software is doing ATA command and data transfer to 39420abddf82SMacpaul Lin IDE devices through IDE-AHB controller, some additional 39430abddf82SMacpaul Lin registers accessing to these kind of IDE-AHB controller 39440abddf82SMacpaul Lin is requierd. 39450abddf82SMacpaul Lin 39466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR: Physical address of the Internal Memory. 394725d6712aSwdenk DO NOT CHANGE unless you know exactly what you're 394825d6712aSwdenk doing! (11-4) [MPC8xx/82xx systems only] 3949c609719bSwdenk 39506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR: 3951c609719bSwdenk 39527152b1d0Swdenk Start address of memory area that can be used for 3953c609719bSwdenk initial data and stack; please note that this must be 3954c609719bSwdenk writable memory that is working WITHOUT special 3955c609719bSwdenk initialization, i. e. you CANNOT use normal RAM which 3956c609719bSwdenk will become available only after programming the 3957c609719bSwdenk memory controller and running certain initialization 3958c609719bSwdenk sequences. 3959c609719bSwdenk 3960c609719bSwdenk U-Boot uses the following memory types: 3961c609719bSwdenk - MPC8xx and MPC8260: IMMR (internal memory of the CPU) 3962c609719bSwdenk - MPC824X: data cache 3963c609719bSwdenk - PPC4xx: data cache 3964c609719bSwdenk 39656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET: 3966c609719bSwdenk 3967c609719bSwdenk Offset of the initial data structure in the memory 39686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually 39696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial 3970c609719bSwdenk data is located at the end of the available space 3971553f0982SWolfgang Denk (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE - 39726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just 39736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR + 39746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_GBL_DATA_OFFSET) downward. 3975c609719bSwdenk 3976c609719bSwdenk Note: 3977c609719bSwdenk On the MPC824X (or other systems that use the data 3978c609719bSwdenk cache for initial memory) the address chosen for 39796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must 3980c609719bSwdenk point to an otherwise UNUSED address space between 3981c609719bSwdenk the top of RAM and the start of the PCI space. 3982c609719bSwdenk 39836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6) 3984c609719bSwdenk 39856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR: System Protection Control (11-9) 3986c609719bSwdenk 39876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26) 3988c609719bSwdenk 39896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31) 3990c609719bSwdenk 39916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30) 3992c609719bSwdenk 39936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27) 3994c609719bSwdenk 39956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM: 3996c609719bSwdenk SDRAM timing 3997c609719bSwdenk 39986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA: 3999c609719bSwdenk periodic timer for refresh 4000c609719bSwdenk 40016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER: Debug Event Register (37-47) 4002c609719bSwdenk 40036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM, 40046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP, 40056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM, 40066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BR1_PRELIM: 4007c609719bSwdenk Memory Controller Definitions: BR0/1 and OR0/1 (FLASH) 4008c609719bSwdenk 4009c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE, 40106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM, 40116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM: 4012c609719bSwdenk Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM) 4013c609719bSwdenk 40146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K, 40156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL: 4016c609719bSwdenk Machine Mode Register and Memory Periodic Timer 4017c609719bSwdenk Prescaler definitions (SDRAM timing) 4018c609719bSwdenk 40196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]: 4020c609719bSwdenk enable I2C microcode relocation patch (MPC8xx); 4021c609719bSwdenk define relocation offset in DPRAM [DSP2] 4022c609719bSwdenk 40236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]: 4024b423d055SHeiko Schocher enable SMC microcode relocation patch (MPC8xx); 4025b423d055SHeiko Schocher define relocation offset in DPRAM [SMC1] 4026b423d055SHeiko Schocher 40276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]: 4028c609719bSwdenk enable SPI microcode relocation patch (MPC8xx); 4029c609719bSwdenk define relocation offset in DPRAM [SCC4] 4030c609719bSwdenk 40316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK: 4032c609719bSwdenk Use OSCM clock mode on MBX8xx board. Be careful, 4033c609719bSwdenk wrong setting might damage your board. Read 4034c609719bSwdenk doc/README.MBX before setting this variable! 4035c609719bSwdenk 40366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only) 4037ea909b76Swdenk Offset of the bootmode word in DPRAM used by post 4038ea909b76Swdenk (Power On Self Tests). This definition overrides 4039ea909b76Swdenk #define'd default value in commproc.h resp. 4040ea909b76Swdenk cpm_8260.h. 4041ea909b76Swdenk 40426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB, 40436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL, 40446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS, 40456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB, 40466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START, 40476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL, 40486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE, 40496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only) 4050a47a12beSStefan Roese Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set. 40515d232d0eSwdenk 40529cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE: 40539cacf4fcSDirk Eibach Disable PCI-Express on systems where it is supported but not 40549cacf4fcSDirk Eibach required. 40559cacf4fcSDirk Eibach 405669fd2d3bSAndrew Sharp- CONFIG_PCI_ENUM_ONLY 405769fd2d3bSAndrew Sharp Only scan through and get the devices on the busses. 405869fd2d3bSAndrew Sharp Don't do any setup work, presumably because someone or 405969fd2d3bSAndrew Sharp something has already done it, and we don't need to do it 406069fd2d3bSAndrew Sharp a second time. Useful for platforms that are pre-booted 406169fd2d3bSAndrew Sharp by coreboot or similar. 406269fd2d3bSAndrew Sharp 4063842033e6SGabor Juhos- CONFIG_PCI_INDIRECT_BRIDGE: 4064842033e6SGabor Juhos Enable support for indirect PCI bridges. 4065842033e6SGabor Juhos 4066a09b9b68SKumar Gala- CONFIG_SYS_SRIO: 4067a09b9b68SKumar Gala Chip has SRIO or not 4068a09b9b68SKumar Gala 4069a09b9b68SKumar Gala- CONFIG_SRIO1: 4070a09b9b68SKumar Gala Board has SRIO 1 port available 4071a09b9b68SKumar Gala 4072a09b9b68SKumar Gala- CONFIG_SRIO2: 4073a09b9b68SKumar Gala Board has SRIO 2 port available 4074a09b9b68SKumar Gala 4075c8b28152SLiu Gang- CONFIG_SRIO_PCIE_BOOT_MASTER 4076c8b28152SLiu Gang Board can support master function for Boot from SRIO and PCIE 4077c8b28152SLiu Gang 4078a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT: 4079a09b9b68SKumar Gala Virtual Address of SRIO port 'n' memory region 4080a09b9b68SKumar Gala 4081a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS: 4082a09b9b68SKumar Gala Physical Address of SRIO port 'n' memory region 4083a09b9b68SKumar Gala 4084a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE: 4085a09b9b68SKumar Gala Size of SRIO port 'n' memory region 4086a09b9b68SKumar Gala 408766bd1846SFabio Estevam- CONFIG_SYS_NAND_BUSWIDTH_16BIT 408866bd1846SFabio Estevam Defined to tell the NAND controller that the NAND chip is using 408966bd1846SFabio Estevam a 16 bit bus. 409066bd1846SFabio Estevam Not all NAND drivers use this symbol. 4091a430e916SFabio Estevam Example of drivers that use it: 409266bd1846SFabio Estevam - drivers/mtd/nand/ndfc.c 4093a430e916SFabio Estevam - drivers/mtd/nand/mxc_nand.c 4094eced4626SAlex Waterman 4095eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG 4096eced4626SAlex Waterman Sets the EBC0_CFG register for the NDFC. If not defined 4097eced4626SAlex Waterman a default value will be used. 4098eced4626SAlex Waterman 4099bb99ad6dSBen Warren- CONFIG_SPD_EEPROM 4100218ca724SWolfgang Denk Get DDR timing information from an I2C EEPROM. Common 4101218ca724SWolfgang Denk with pluggable memory modules such as SODIMMs 4102218ca724SWolfgang Denk 4103bb99ad6dSBen Warren SPD_EEPROM_ADDRESS 4104bb99ad6dSBen Warren I2C address of the SPD EEPROM 4105bb99ad6dSBen Warren 41066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM 4107218ca724SWolfgang Denk If SPD EEPROM is on an I2C bus other than the first 4108218ca724SWolfgang Denk one, specify here. Note that the value must resolve 4109218ca724SWolfgang Denk to something your driver can deal with. 4110bb99ad6dSBen Warren 41111b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING 41121b3e3c4fSYork Sun Get DDR timing information from other than SPD. Common with 41131b3e3c4fSYork Sun soldered DDR chips onboard without SPD. DDR raw timing 41141b3e3c4fSYork Sun parameters are extracted from datasheet and hard-coded into 41151b3e3c4fSYork Sun header files or board specific files. 41161b3e3c4fSYork Sun 41176f5e1dc5SYork Sun- CONFIG_FSL_DDR_INTERACTIVE 41186f5e1dc5SYork Sun Enable interactive DDR debugging. See doc/README.fsl-ddr. 41196f5e1dc5SYork Sun 41206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0 4121218ca724SWolfgang Denk Only for 83xx systems. If specified, then DDR should 4122218ca724SWolfgang Denk be configured using CS0 and CS1 instead of CS2 and CS3. 41232ad6b513STimur Tabi 4124c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12] 4125c26e454dSwdenk Define to enable FEC[12] on a 8xx series processor. 4126c26e454dSwdenk 4127c26e454dSwdenk- CONFIG_FEC[12]_PHY 4128c26e454dSwdenk Define to the hardcoded PHY address which corresponds 41296e592385Swdenk to the given FEC; i. e. 4130c26e454dSwdenk #define CONFIG_FEC1_PHY 4 4131c26e454dSwdenk means that the PHY with address 4 is connected to FEC1 4132c26e454dSwdenk 4133c26e454dSwdenk When set to -1, means to probe for first available. 4134c26e454dSwdenk 4135c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR 4136c26e454dSwdenk The PHY does not have a RXERR line (RMII only). 4137c26e454dSwdenk (so program the FEC to ignore it). 4138c26e454dSwdenk 4139c26e454dSwdenk- CONFIG_RMII 4140c26e454dSwdenk Enable RMII mode for all FECs. 4141c26e454dSwdenk Note that this is a global option, we can't 4142c26e454dSwdenk have one FEC in standard MII mode and another in RMII mode. 4143c26e454dSwdenk 41445cf91d6bSwdenk- CONFIG_CRC32_VERIFY 41455cf91d6bSwdenk Add a verify option to the crc32 command. 41465cf91d6bSwdenk The syntax is: 41475cf91d6bSwdenk 41485cf91d6bSwdenk => crc32 -v <address> <count> <crc32> 41495cf91d6bSwdenk 41505cf91d6bSwdenk Where address/count indicate a memory area 41515cf91d6bSwdenk and crc32 is the correct crc32 which the 41525cf91d6bSwdenk area should have. 41535cf91d6bSwdenk 415456523f12Swdenk- CONFIG_LOOPW 415556523f12Swdenk Add the "loopw" memory command. This only takes effect if 4156602ad3b3SJon Loeliger the memory commands are activated globally (CONFIG_CMD_MEM). 415756523f12Swdenk 41587b466641Sstroese- CONFIG_MX_CYCLIC 41597b466641Sstroese Add the "mdc" and "mwc" memory commands. These are cyclic 41607b466641Sstroese "md/mw" commands. 41617b466641Sstroese Examples: 41627b466641Sstroese 41637b466641Sstroese => mdc.b 10 4 500 41647b466641Sstroese This command will print 4 bytes (10,11,12,13) each 500 ms. 41657b466641Sstroese 41667b466641Sstroese => mwc.l 100 12345678 10 41677b466641Sstroese This command will write 12345678 to address 100 all 10 ms. 41687b466641Sstroese 41697b466641Sstroese This only takes effect if the memory commands are activated 4170602ad3b3SJon Loeliger globally (CONFIG_CMD_MEM). 41717b466641Sstroese 41728aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT 4173afc1ce82SMacpaul Lin [ARM, NDS32, MIPS only] If this variable is defined, then certain 4174e03f3169SWolfgang Denk low level initializations (like setting up the memory 4175e03f3169SWolfgang Denk controller) are omitted and/or U-Boot does not 4176e03f3169SWolfgang Denk relocate itself into RAM. 41778aa1a2d1Swdenk 4178e03f3169SWolfgang Denk Normally this variable MUST NOT be defined. The only 4179e03f3169SWolfgang Denk exception is when U-Boot is loaded (to RAM) by some 4180e03f3169SWolfgang Denk other boot loader or by a debugger which performs 4181e03f3169SWolfgang Denk these initializations itself. 41828aa1a2d1Swdenk 4183401bb30bSAneesh V- CONFIG_SPL_BUILD 4184df81238bSMagnus Lilja Modifies the behaviour of start.S when compiling a loader 4185df81238bSMagnus Lilja that is executed before the actual U-Boot. E.g. when 4186df81238bSMagnus Lilja compiling a NAND SPL. 4187400558b5Swdenk 41885df572f0SYing Zhang- CONFIG_SYS_MPC85XX_NO_RESETVEC 41895df572f0SYing Zhang Only for 85xx systems. If this variable is specified, the section 41905df572f0SYing Zhang .resetvec is not kept and the section .bootpg is placed in the 41915df572f0SYing Zhang previous 4k of the .text section. 41925df572f0SYing Zhang 41934213fc29SSimon Glass- CONFIG_ARCH_MAP_SYSMEM 41944213fc29SSimon Glass Generally U-Boot (and in particular the md command) uses 41954213fc29SSimon Glass effective address. It is therefore not necessary to regard 41964213fc29SSimon Glass U-Boot address as virtual addresses that need to be translated 41974213fc29SSimon Glass to physical addresses. However, sandbox requires this, since 41984213fc29SSimon Glass it maintains its own little RAM buffer which contains all 41994213fc29SSimon Glass addressable memory. This option causes some memory accesses 42004213fc29SSimon Glass to be mapped through map_sysmem() / unmap_sysmem(). 42014213fc29SSimon Glass 4202d8834a13SMatthias Weisser- CONFIG_USE_ARCH_MEMCPY 4203d8834a13SMatthias Weisser CONFIG_USE_ARCH_MEMSET 4204d8834a13SMatthias Weisser If these options are used a optimized version of memcpy/memset will 4205d8834a13SMatthias Weisser be used if available. These functions may be faster under some 4206d8834a13SMatthias Weisser conditions but may increase the binary size. 4207d8834a13SMatthias Weisser 4208588a13f7SSimon Glass- CONFIG_X86_RESET_VECTOR 4209588a13f7SSimon Glass If defined, the x86 reset vector code is included. This is not 4210588a13f7SSimon Glass needed when U-Boot is running from Coreboot. 4211b16f521aSGabe Black 4212fc33705eSMark Jackson- CONFIG_SYS_MPUCLK 4213fc33705eSMark Jackson Defines the MPU clock speed (in MHz). 4214fc33705eSMark Jackson 4215fc33705eSMark Jackson NOTE : currently only supported on AM335x platforms. 42165b5ece9eSGabe Black 4217f2717b47STimur TabiFreescale QE/FMAN Firmware Support: 4218f2717b47STimur Tabi----------------------------------- 4219f2717b47STimur Tabi 4220f2717b47STimur TabiThe Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the 4221f2717b47STimur Tabiloading of "firmware", which is encoded in the QE firmware binary format. 4222f2717b47STimur TabiThis firmware often needs to be loaded during U-Boot booting, so macros 4223f2717b47STimur Tabiare used to identify the storage device (NOR flash, SPI, etc) and the address 4224f2717b47STimur Tabiwithin that device. 4225f2717b47STimur Tabi 4226f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_ADDR 4227f2717b47STimur Tabi The address in the storage device where the firmware is located. The 4228f2717b47STimur Tabi meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro 4229f2717b47STimur Tabi is also specified. 4230f2717b47STimur Tabi 4231f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_LENGTH 4232f2717b47STimur Tabi The maximum possible size of the firmware. The firmware binary format 4233f2717b47STimur Tabi has a field that specifies the actual size of the firmware, but it 4234f2717b47STimur Tabi might not be possible to read any part of the firmware unless some 4235f2717b47STimur Tabi local storage is allocated to hold the entire firmware first. 4236f2717b47STimur Tabi 4237f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NOR 4238f2717b47STimur Tabi Specifies that QE/FMAN firmware is located in NOR flash, mapped as 4239f2717b47STimur Tabi normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the 4240f2717b47STimur Tabi virtual address in NOR flash. 4241f2717b47STimur Tabi 4242f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NAND 4243f2717b47STimur Tabi Specifies that QE/FMAN firmware is located in NAND flash. 4244f2717b47STimur Tabi CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash. 4245f2717b47STimur Tabi 4246f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_MMC 4247f2717b47STimur Tabi Specifies that QE/FMAN firmware is located on the primary SD/MMC 4248f2717b47STimur Tabi device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device. 4249f2717b47STimur Tabi 4250f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH 4251f2717b47STimur Tabi Specifies that QE/FMAN firmware is located on the primary SPI 4252f2717b47STimur Tabi device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device. 4253f2717b47STimur Tabi 4254292dc6c5SLiu Gang- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE 4255292dc6c5SLiu Gang Specifies that QE/FMAN firmware is located in the remote (master) 4256292dc6c5SLiu Gang memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which 4257fc54c7faSLiu Gang can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound 4258fc54c7faSLiu Gang window->master inbound window->master LAW->the ucode address in 4259fc54c7faSLiu Gang master's memory space. 4260f2717b47STimur Tabi 4261c609719bSwdenkBuilding the Software: 4262c609719bSwdenk====================== 4263c609719bSwdenk 4264218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments 4265218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support 4266218ca724SWolfgang Denkall possibly existing versions of cross development tools in all 4267218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we 4268218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK) 4269218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot. 4270c609719bSwdenk 4271218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you 4272218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case, 4273218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell. 4274218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are 4275218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter: 4276c609719bSwdenk 4277218ca724SWolfgang Denk $ CROSS_COMPILE=ppc_4xx- 4278218ca724SWolfgang Denk $ export CROSS_COMPILE 4279c609719bSwdenk 42802f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in 42812f8d396bSPeter Tyser the tools directory you can use the MinGW toolchain 42822f8d396bSPeter Tyser (http://www.mingw.org). Set your HOST tools to the MinGW 42832f8d396bSPeter Tyser toolchain and execute 'make tools'. For example: 42842f8d396bSPeter Tyser 42852f8d396bSPeter Tyser $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools 42862f8d396bSPeter Tyser 42872f8d396bSPeter Tyser Binaries such as tools/mkimage.exe will be created which can 42882f8d396bSPeter Tyser be executed on computers running Windows. 42892f8d396bSPeter Tyser 4290c609719bSwdenkU-Boot is intended to be simple to build. After installing the 4291c609719bSwdenksources you must configure U-Boot for one specific board type. This 4292c609719bSwdenkis done by typing: 4293c609719bSwdenk 4294c609719bSwdenk make NAME_config 4295c609719bSwdenk 4296218ca724SWolfgang Denkwhere "NAME_config" is the name of one of the existing configu- 42974d675ae6SMichael Jonesrations; see boards.cfg for supported names. 429854387ac9Swdenk 4299c609719bSwdenkNote: for some board special configuration names may exist; check if 4300c609719bSwdenk additional information is available from the board vendor; for 43012729af9dSwdenk instance, the TQM823L systems are available without (standard) 43022729af9dSwdenk or with LCD support. You can select such additional "features" 430311ccc33fSMarcel Ziswiler when choosing the configuration, i. e. 4304c609719bSwdenk 43052729af9dSwdenk make TQM823L_config 43062729af9dSwdenk - will configure for a plain TQM823L, i. e. no LCD support 4307c609719bSwdenk 4308c609719bSwdenk make TQM823L_LCD_config 4309c609719bSwdenk - will configure for a TQM823L with U-Boot console on LCD 4310c609719bSwdenk 4311c609719bSwdenk etc. 4312c609719bSwdenk 4313c609719bSwdenk 4314c609719bSwdenkFinally, type "make all", and you should get some working U-Boot 43157152b1d0Swdenkimages ready for download to / installation on your system: 4316c609719bSwdenk 4317c609719bSwdenk- "u-boot.bin" is a raw binary image 4318c609719bSwdenk- "u-boot" is an image in ELF binary format 4319c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format 4320c609719bSwdenk 4321baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved 4322baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change 4323baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory: 4324baf31249SMarian Balakowicz 4325baf31249SMarian Balakowicz1. Add O= to the make command line invocations: 4326baf31249SMarian Balakowicz 4327baf31249SMarian Balakowicz make O=/tmp/build distclean 4328baf31249SMarian Balakowicz make O=/tmp/build NAME_config 4329baf31249SMarian Balakowicz make O=/tmp/build all 4330baf31249SMarian Balakowicz 4331baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location: 4332baf31249SMarian Balakowicz 4333baf31249SMarian Balakowicz export BUILD_DIR=/tmp/build 4334baf31249SMarian Balakowicz make distclean 4335baf31249SMarian Balakowicz make NAME_config 4336baf31249SMarian Balakowicz make all 4337baf31249SMarian Balakowicz 4338baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment 4339baf31249SMarian Balakowiczvariable. 4340baf31249SMarian Balakowicz 4341c609719bSwdenk 4342c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so 4343c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of 4344c609719bSwdenknative "make". 4345c609719bSwdenk 4346c609719bSwdenk 4347c609719bSwdenkIf the system board that you have is not listed, then you will need 4348c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these 4349c609719bSwdenksteps: 4350c609719bSwdenk 4351c609719bSwdenk1. Add a new configuration option for your board to the toplevel 43524d675ae6SMichael Jones "boards.cfg" file, using the existing entries as examples. 43534d675ae6SMichael Jones Follow the instructions there to keep the boards in order. 4354c609719bSwdenk2. Create a new directory to hold your board specific code. Add any 435585ec0bccSwdenk files you need. In your board directory, you will need at least 435685ec0bccSwdenk the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds". 435785ec0bccSwdenk3. Create a new configuration file "include/configs/<board>.h" for 435885ec0bccSwdenk your board 4359c609719bSwdenk3. If you're porting U-Boot to a new CPU, then also create a new 4360c609719bSwdenk directory to hold your CPU specific code. Add any files you need. 436185ec0bccSwdenk4. Run "make <board>_config" with your new name. 4362c609719bSwdenk5. Type "make", and you should get a working "u-boot.srec" file 4363c609719bSwdenk to be installed on your target system. 436485ec0bccSwdenk6. Debug and solve any problems that might arise. 4365c609719bSwdenk [Of course, this last step is much harder than it sounds.] 4366c609719bSwdenk 4367c609719bSwdenk 4368c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.: 4369c609719bSwdenk============================================================== 4370c609719bSwdenk 4371c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board 4372c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to 4373c609719bSwdenkprovide feedback to the other developers. The feedback normally takes 4374c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest 4375218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources. 4376c609719bSwdenk 4377c609719bSwdenkBut before you submit such a patch, please verify that your modifi- 4378c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of 4379c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so, 4380c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot 4381c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can 43827152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE' 4383218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools 4384218ca724SWolfgang Denkyou can type 4385c609719bSwdenk 4386c609719bSwdenk CROSS_COMPILE=ppc_8xx- MAKEALL 4387c609719bSwdenk 4388c609719bSwdenkor to build on a native PowerPC system you can type 4389c609719bSwdenk 4390c609719bSwdenk CROSS_COMPILE=' ' MAKEALL 4391c609719bSwdenk 4392218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build 4393218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by 4394218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target 4395218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and 4396218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default 4397218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment 4398218ca724SWolfgang Denkvariable. For example: 4399baf31249SMarian Balakowicz 4400baf31249SMarian Balakowicz export BUILD_DIR=/tmp/build 4401baf31249SMarian Balakowicz export MAKEALL_LOGDIR=/tmp/log 4402baf31249SMarian Balakowicz CROSS_COMPILE=ppc_8xx- MAKEALL 4403baf31249SMarian Balakowicz 4404218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build, 4405218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean 4406218ca724SWolfgang Denkduring the whole build process. 4407baf31249SMarian Balakowicz 4408baf31249SMarian Balakowicz 4409c609719bSwdenkSee also "U-Boot Porting Guide" below. 4410c609719bSwdenk 4411c609719bSwdenk 4412c609719bSwdenkMonitor Commands - Overview: 4413c609719bSwdenk============================ 4414c609719bSwdenk 4415c609719bSwdenkgo - start application at address 'addr' 4416c609719bSwdenkrun - run commands in an environment variable 4417c609719bSwdenkbootm - boot application image from memory 4418c609719bSwdenkbootp - boot image via network using BootP/TFTP protocol 441944f074c7SMarek Vasutbootz - boot zImage from memory 4420c609719bSwdenktftpboot- boot image via network using TFTP protocol 4421c609719bSwdenk and env variables "ipaddr" and "serverip" 4422c609719bSwdenk (and eventually "gatewayip") 44231fb7cd49SSimon Glasstftpput - upload a file via network using TFTP protocol 4424c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol 4425c609719bSwdenkdiskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd' 4426c609719bSwdenkloads - load S-Record file over serial line 4427c609719bSwdenkloadb - load binary file over serial line (kermit mode) 4428c609719bSwdenkmd - memory display 4429c609719bSwdenkmm - memory modify (auto-incrementing) 4430c609719bSwdenknm - memory modify (constant address) 4431c609719bSwdenkmw - memory write (fill) 4432c609719bSwdenkcp - memory copy 4433c609719bSwdenkcmp - memory compare 4434c609719bSwdenkcrc32 - checksum calculation 44350f89c54bSPeter Tyseri2c - I2C sub-system 4436c609719bSwdenksspi - SPI utility commands 4437c609719bSwdenkbase - print or set address offset 4438c609719bSwdenkprintenv- print environment variables 4439c609719bSwdenksetenv - set environment variables 4440c609719bSwdenksaveenv - save environment variables to persistent storage 4441c609719bSwdenkprotect - enable or disable FLASH write protection 4442c609719bSwdenkerase - erase FLASH memory 4443c609719bSwdenkflinfo - print FLASH memory information 444410635afaSKarl O. Pincnand - NAND memory operations (see doc/README.nand) 4445c609719bSwdenkbdinfo - print Board Info structure 4446c609719bSwdenkiminfo - print header information for application image 4447c609719bSwdenkconinfo - print console devices and informations 4448c609719bSwdenkide - IDE sub-system 4449c609719bSwdenkloop - infinite loop on address range 445056523f12Swdenkloopw - infinite write loop on address range 4451c609719bSwdenkmtest - simple RAM test 4452c609719bSwdenkicache - enable or disable instruction cache 4453c609719bSwdenkdcache - enable or disable data cache 4454c609719bSwdenkreset - Perform RESET of the CPU 4455c609719bSwdenkecho - echo args to console 4456c609719bSwdenkversion - print monitor version 4457c609719bSwdenkhelp - print online help 4458c609719bSwdenk? - alias for 'help' 4459c609719bSwdenk 4460c609719bSwdenk 4461c609719bSwdenkMonitor Commands - Detailed Description: 4462c609719bSwdenk======================================== 4463c609719bSwdenk 4464c609719bSwdenkTODO. 4465c609719bSwdenk 4466c609719bSwdenkFor now: just type "help <command>". 4467c609719bSwdenk 4468c609719bSwdenk 4469c609719bSwdenkEnvironment Variables: 4470c609719bSwdenk====================== 4471c609719bSwdenk 4472c609719bSwdenkU-Boot supports user configuration using Environment Variables which 4473c609719bSwdenkcan be made persistent by saving to Flash memory. 4474c609719bSwdenk 4475c609719bSwdenkEnvironment Variables are set using "setenv", printed using 4476c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv" 4477c609719bSwdenkwithout a value can be used to delete a variable from the 4478c609719bSwdenkenvironment. As long as you don't save the environment you are 4479c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the 4480c609719bSwdenkenvironment is erased by accident, a default environment is provided. 4481c609719bSwdenk 4482c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables. 4483c96f86eeSWolfgang Denk 4484c96f86eeSWolfgang DenkList of environment variables (most likely not complete): 4485c609719bSwdenk 4486c609719bSwdenk baudrate - see CONFIG_BAUDRATE 4487c609719bSwdenk 4488c609719bSwdenk bootdelay - see CONFIG_BOOTDELAY 4489c609719bSwdenk 4490c609719bSwdenk bootcmd - see CONFIG_BOOTCOMMAND 4491c609719bSwdenk 4492c609719bSwdenk bootargs - Boot arguments when booting an RTOS image 4493c609719bSwdenk 4494c609719bSwdenk bootfile - Name of the image to load with TFTP 4495c609719bSwdenk 44967d721e34SBartlomiej Sieka bootm_low - Memory range available for image processing in the bootm 44977d721e34SBartlomiej Sieka command can be restricted. This variable is given as 44987d721e34SBartlomiej Sieka a hexadecimal number and defines lowest address allowed 44997d721e34SBartlomiej Sieka for use by the bootm command. See also "bootm_size" 45007d721e34SBartlomiej Sieka environment variable. Address defined by "bootm_low" is 45017d721e34SBartlomiej Sieka also the base of the initial memory mapping for the Linux 4502c3624e6eSGrant Likely kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and 4503c3624e6eSGrant Likely bootm_mapsize. 4504c3624e6eSGrant Likely 4505c3624e6eSGrant Likely bootm_mapsize - Size of the initial memory mapping for the Linux kernel. 4506c3624e6eSGrant Likely This variable is given as a hexadecimal number and it 4507c3624e6eSGrant Likely defines the size of the memory region starting at base 4508c3624e6eSGrant Likely address bootm_low that is accessible by the Linux kernel 4509c3624e6eSGrant Likely during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used 4510c3624e6eSGrant Likely as the default value if it is defined, and bootm_size is 4511c3624e6eSGrant Likely used otherwise. 45127d721e34SBartlomiej Sieka 45137d721e34SBartlomiej Sieka bootm_size - Memory range available for image processing in the bootm 45147d721e34SBartlomiej Sieka command can be restricted. This variable is given as 45157d721e34SBartlomiej Sieka a hexadecimal number and defines the size of the region 45167d721e34SBartlomiej Sieka allowed for use by the bootm command. See also "bootm_low" 45177d721e34SBartlomiej Sieka environment variable. 45187d721e34SBartlomiej Sieka 45194bae9090SBartlomiej Sieka updatefile - Location of the software update file on a TFTP server, used 45204bae9090SBartlomiej Sieka by the automatic software update feature. Please refer to 45214bae9090SBartlomiej Sieka documentation in doc/README.update for more details. 45224bae9090SBartlomiej Sieka 4523c609719bSwdenk autoload - if set to "no" (any string beginning with 'n'), 4524c609719bSwdenk "bootp" will just load perform a lookup of the 4525c609719bSwdenk configuration from the BOOTP server, but not try to 4526c609719bSwdenk load any image using TFTP 4527c609719bSwdenk 4528c609719bSwdenk autostart - if set to "yes", an image loaded using the "bootp", 4529c609719bSwdenk "rarpboot", "tftpboot" or "diskboot" commands will 4530c609719bSwdenk be automatically started (by internally calling 4531c609719bSwdenk "bootm") 4532c609719bSwdenk 45334a6fd34bSwdenk If set to "no", a standalone image passed to the 45344a6fd34bSwdenk "bootm" command will be copied to the load address 45354a6fd34bSwdenk (and eventually uncompressed), but NOT be started. 45364a6fd34bSwdenk This can be used to load and uncompress arbitrary 45374a6fd34bSwdenk data. 45384a6fd34bSwdenk 4539a28afca5SDavid A. Long fdt_high - if set this restricts the maximum address that the 4540a28afca5SDavid A. Long flattened device tree will be copied into upon boot. 4541fa34f6b2SShawn Guo For example, if you have a system with 1 GB memory 4542fa34f6b2SShawn Guo at physical address 0x10000000, while Linux kernel 4543fa34f6b2SShawn Guo only recognizes the first 704 MB as low memory, you 4544fa34f6b2SShawn Guo may need to set fdt_high as 0x3C000000 to have the 4545fa34f6b2SShawn Guo device tree blob be copied to the maximum address 4546fa34f6b2SShawn Guo of the 704 MB low memory, so that Linux kernel can 4547fa34f6b2SShawn Guo access it during the boot procedure. 4548fa34f6b2SShawn Guo 4549a28afca5SDavid A. Long If this is set to the special value 0xFFFFFFFF then 4550a28afca5SDavid A. Long the fdt will not be copied at all on boot. For this 4551a28afca5SDavid A. Long to work it must reside in writable memory, have 4552a28afca5SDavid A. Long sufficient padding on the end of it for u-boot to 4553a28afca5SDavid A. Long add the information it needs into it, and the memory 4554a28afca5SDavid A. Long must be accessible by the kernel. 4555a28afca5SDavid A. Long 4556eea63e05SSimon Glass fdtcontroladdr- if set this is the address of the control flattened 4557eea63e05SSimon Glass device tree used by U-Boot when CONFIG_OF_CONTROL is 4558eea63e05SSimon Glass defined. 4559eea63e05SSimon Glass 456017ea1177Swdenk i2cfast - (PPC405GP|PPC405EP only) 456117ea1177Swdenk if set to 'y' configures Linux I2C driver for fast 456217ea1177Swdenk mode (400kHZ). This environment variable is used in 456317ea1177Swdenk initialization code. So, for changes to be effective 456417ea1177Swdenk it must be saved and board must be reset. 456517ea1177Swdenk 4566c609719bSwdenk initrd_high - restrict positioning of initrd images: 4567c609719bSwdenk If this variable is not set, initrd images will be 4568c609719bSwdenk copied to the highest possible address in RAM; this 4569c609719bSwdenk is usually what you want since it allows for 4570c609719bSwdenk maximum initrd size. If for some reason you want to 4571c609719bSwdenk make sure that the initrd image is loaded below the 45726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BOOTMAPSZ limit, you can set this environment 4573c609719bSwdenk variable to a value of "no" or "off" or "0". 4574c609719bSwdenk Alternatively, you can set it to a maximum upper 4575c609719bSwdenk address to use (U-Boot will still check that it 4576c609719bSwdenk does not overwrite the U-Boot stack and data). 4577c609719bSwdenk 4578c609719bSwdenk For instance, when you have a system with 16 MB 45797152b1d0Swdenk RAM, and want to reserve 4 MB from use by Linux, 4580c609719bSwdenk you can do this by adding "mem=12M" to the value of 4581c609719bSwdenk the "bootargs" variable. However, now you must make 45827152b1d0Swdenk sure that the initrd image is placed in the first 4583c609719bSwdenk 12 MB as well - this can be done with 4584c609719bSwdenk 4585c609719bSwdenk setenv initrd_high 00c00000 4586c609719bSwdenk 458738b99261Swdenk If you set initrd_high to 0xFFFFFFFF, this is an 458838b99261Swdenk indication to U-Boot that all addresses are legal 458938b99261Swdenk for the Linux kernel, including addresses in flash 459038b99261Swdenk memory. In this case U-Boot will NOT COPY the 459138b99261Swdenk ramdisk at all. This may be useful to reduce the 459238b99261Swdenk boot time on your system, but requires that this 459338b99261Swdenk feature is supported by your Linux kernel. 459438b99261Swdenk 4595c609719bSwdenk ipaddr - IP address; needed for tftpboot command 4596c609719bSwdenk 4597c609719bSwdenk loadaddr - Default load address for commands like "bootp", 4598dc7c9a1aSwdenk "rarpboot", "tftpboot", "loadb" or "diskboot" 4599c609719bSwdenk 4600c609719bSwdenk loads_echo - see CONFIG_LOADS_ECHO 4601c609719bSwdenk 4602c609719bSwdenk serverip - TFTP server IP address; needed for tftpboot command 4603c609719bSwdenk 4604c609719bSwdenk bootretry - see CONFIG_BOOT_RETRY_TIME 4605c609719bSwdenk 4606c609719bSwdenk bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR 4607c609719bSwdenk 4608c609719bSwdenk bootstopkey - see CONFIG_AUTOBOOT_STOP_STR 4609c609719bSwdenk 4610e2a53458SMike Frysinger ethprime - controls which interface is used first. 4611a3d991bdSwdenk 4612e2a53458SMike Frysinger ethact - controls which interface is currently active. 4613e2a53458SMike Frysinger For example you can do the following 4614a3d991bdSwdenk 461548690d80SHeiko Schocher => setenv ethact FEC 461648690d80SHeiko Schocher => ping 192.168.0.1 # traffic sent on FEC 461748690d80SHeiko Schocher => setenv ethact SCC 461848690d80SHeiko Schocher => ping 10.0.0.1 # traffic sent on SCC 4619a3d991bdSwdenk 4620e1692577SMatthias Fuchs ethrotate - When set to "no" U-Boot does not go through all 4621e1692577SMatthias Fuchs available network interfaces. 4622e1692577SMatthias Fuchs It just stays at the currently selected interface. 4623e1692577SMatthias Fuchs 4624a3d991bdSwdenk netretry - When set to "no" each network operation will 4625a3d991bdSwdenk either succeed or fail without retrying. 46266e592385Swdenk When set to "once" the network operation will 46276e592385Swdenk fail when all the available network interfaces 46286e592385Swdenk are tried once without success. 4629a3d991bdSwdenk Useful on scripts which control the retry operation 4630a3d991bdSwdenk themselves. 4631a3d991bdSwdenk 4632b4e2f89dSJean-Christophe PLAGNIOL-VILLARD npe_ucode - set load address for the NPE microcode 4633a1cf027aSJean-Christophe PLAGNIOL-VILLARD 463428cb9375SWolfgang Denk tftpsrcport - If this is set, the value is used for TFTP's 4635ecb0ccd9SWolfgang Denk UDP source port. 4636ecb0ccd9SWolfgang Denk 463728cb9375SWolfgang Denk tftpdstport - If this is set, the value is used for TFTP's UDP 463828cb9375SWolfgang Denk destination port instead of the Well Know Port 69. 463928cb9375SWolfgang Denk 4640c96f86eeSWolfgang Denk tftpblocksize - Block size to use for TFTP transfers; if not set, 4641c96f86eeSWolfgang Denk we use the TFTP server's default block size 4642c96f86eeSWolfgang Denk 4643c96f86eeSWolfgang Denk tftptimeout - Retransmission timeout for TFTP packets (in milli- 4644c96f86eeSWolfgang Denk seconds, minimum value is 1000 = 1 second). Defines 4645c96f86eeSWolfgang Denk when a packet is considered to be lost so it has to 4646c96f86eeSWolfgang Denk be retransmitted. The default is 5000 = 5 seconds. 4647c96f86eeSWolfgang Denk Lowering this value may make downloads succeed 4648c96f86eeSWolfgang Denk faster in networks with high packet loss rates or 4649c96f86eeSWolfgang Denk with unreliable TFTP servers. 4650c96f86eeSWolfgang Denk 4651a3d991bdSwdenk vlan - When set to a value < 4095 the traffic over 465211ccc33fSMarcel Ziswiler Ethernet is encapsulated/received over 802.1q 4653a3d991bdSwdenk VLAN tagged frames. 4654c609719bSwdenk 4655dc0b7b0eSJason HobbsThe following image location variables contain the location of images 4656dc0b7b0eSJason Hobbsused in booting. The "Image" column gives the role of the image and is 4657dc0b7b0eSJason Hobbsnot an environment variable name. The other columns are environment 4658dc0b7b0eSJason Hobbsvariable names. "File Name" gives the name of the file on a TFTP 4659dc0b7b0eSJason Hobbsserver, "RAM Address" gives the location in RAM the image will be 4660dc0b7b0eSJason Hobbsloaded to, and "Flash Location" gives the image's address in NOR 4661dc0b7b0eSJason Hobbsflash or offset in NAND flash. 4662dc0b7b0eSJason Hobbs 4663dc0b7b0eSJason Hobbs*Note* - these variables don't have to be defined for all boards, some 4664dc0b7b0eSJason Hobbsboards currenlty use other variables for these purposes, and some 4665dc0b7b0eSJason Hobbsboards use these variables for other purposes. 4666dc0b7b0eSJason Hobbs 4667dc0b7b0eSJason HobbsImage File Name RAM Address Flash Location 4668dc0b7b0eSJason Hobbs----- --------- ----------- -------------- 4669dc0b7b0eSJason Hobbsu-boot u-boot u-boot_addr_r u-boot_addr 4670dc0b7b0eSJason HobbsLinux kernel bootfile kernel_addr_r kernel_addr 4671dc0b7b0eSJason Hobbsdevice tree blob fdtfile fdt_addr_r fdt_addr 4672dc0b7b0eSJason Hobbsramdisk ramdiskfile ramdisk_addr_r ramdisk_addr 4673dc0b7b0eSJason Hobbs 4674c609719bSwdenkThe following environment variables may be used and automatically 4675c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"), 4676c609719bSwdenkdepending the information provided by your boot server: 4677c609719bSwdenk 4678c609719bSwdenk bootfile - see above 4679c609719bSwdenk dnsip - IP address of your Domain Name Server 4680fe389a82Sstroese dnsip2 - IP address of your secondary Domain Name Server 4681c609719bSwdenk gatewayip - IP address of the Gateway (Router) to use 4682c609719bSwdenk hostname - Target hostname 4683c609719bSwdenk ipaddr - see above 4684c609719bSwdenk netmask - Subnet Mask 4685c609719bSwdenk rootpath - Pathname of the root filesystem on the NFS server 4686c609719bSwdenk serverip - see above 4687c609719bSwdenk 4688c609719bSwdenk 4689c609719bSwdenkThere are two special Environment Variables: 4690c609719bSwdenk 4691c609719bSwdenk serial# - contains hardware identification information such 4692c609719bSwdenk as type string and/or serial number 4693c609719bSwdenk ethaddr - Ethernet address 4694c609719bSwdenk 4695c609719bSwdenkThese variables can be set only once (usually during manufacturing of 4696c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables 4697c609719bSwdenkonce they have been set once. 4698c609719bSwdenk 4699c609719bSwdenk 4700c1551ea8SstroeseFurther special Environment Variables: 4701c1551ea8Sstroese 4702c1551ea8Sstroese ver - Contains the U-Boot version string as printed 4703c1551ea8Sstroese with the "version" command. This variable is 4704c1551ea8Sstroese readonly (see CONFIG_VERSION_VARIABLE). 4705c1551ea8Sstroese 4706c1551ea8Sstroese 4707c609719bSwdenkPlease note that changes to some configuration parameters may take 4708c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-). 4709c609719bSwdenk 4710c609719bSwdenk 4711170ab110SJoe HershbergerCallback functions for environment variables: 4712170ab110SJoe Hershberger--------------------------------------------- 4713170ab110SJoe Hershberger 4714170ab110SJoe HershbergerFor some environment variables, the behavior of u-boot needs to change 4715170ab110SJoe Hershbergerwhen their values are changed. This functionailty allows functions to 4716170ab110SJoe Hershbergerbe associated with arbitrary variables. On creation, overwrite, or 4717170ab110SJoe Hershbergerdeletion, the callback will provide the opportunity for some side 4718170ab110SJoe Hershbergereffect to happen or for the change to be rejected. 4719170ab110SJoe Hershberger 4720170ab110SJoe HershbergerThe callbacks are named and associated with a function using the 4721170ab110SJoe HershbergerU_BOOT_ENV_CALLBACK macro in your board or driver code. 4722170ab110SJoe Hershberger 4723170ab110SJoe HershbergerThese callbacks are associated with variables in one of two ways. The 4724170ab110SJoe Hershbergerstatic list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC 4725170ab110SJoe Hershbergerin the board configuration to a string that defines a list of 4726170ab110SJoe Hershbergerassociations. The list must be in the following format: 4727170ab110SJoe Hershberger 4728170ab110SJoe Hershberger entry = variable_name[:callback_name] 4729170ab110SJoe Hershberger list = entry[,list] 4730170ab110SJoe Hershberger 4731170ab110SJoe HershbergerIf the callback name is not specified, then the callback is deleted. 4732170ab110SJoe HershbergerSpaces are also allowed anywhere in the list. 4733170ab110SJoe Hershberger 4734170ab110SJoe HershbergerCallbacks can also be associated by defining the ".callbacks" variable 4735170ab110SJoe Hershbergerwith the same list format above. Any association in ".callbacks" will 4736170ab110SJoe Hershbergeroverride any association in the static list. You can define 4737170ab110SJoe HershbergerCONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the 4738170ab110SJoe Hershberger".callbacks" envirnoment variable in the default or embedded environment. 4739170ab110SJoe Hershberger 4740170ab110SJoe Hershberger 4741f07771ccSwdenkCommand Line Parsing: 4742f07771ccSwdenk===================== 4743f07771ccSwdenk 4744f07771ccSwdenkThere are two different command line parsers available with U-Boot: 47457152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell: 4746f07771ccSwdenk 4747f07771ccSwdenkOld, simple command line parser: 4748f07771ccSwdenk-------------------------------- 4749f07771ccSwdenk 4750f07771ccSwdenk- supports environment variables (through setenv / saveenv commands) 4751f07771ccSwdenk- several commands on one line, separated by ';' 4752fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax 4753f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\', 4754f07771ccSwdenk for example: 4755fe126d8bSWolfgang Denk setenv bootcmd bootm \${address} 4756f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example: 4757f07771ccSwdenk setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off' 4758f07771ccSwdenk 4759f07771ccSwdenkHush shell: 4760f07771ccSwdenk----------- 4761f07771ccSwdenk 4762f07771ccSwdenk- similar to Bourne shell, with control structures like 4763f07771ccSwdenk if...then...else...fi, for...do...done; while...do...done, 4764f07771ccSwdenk until...do...done, ... 4765f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv 4766f07771ccSwdenk commands) and local shell variables (through standard shell syntax 4767f07771ccSwdenk "name=value"); only environment variables can be used with "run" 4768f07771ccSwdenk command 4769f07771ccSwdenk 4770f07771ccSwdenkGeneral rules: 4771f07771ccSwdenk-------------- 4772f07771ccSwdenk 4773f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run" 4774f07771ccSwdenk command) contains several commands separated by semicolon, and 4775f07771ccSwdenk one of these commands fails, then the remaining commands will be 4776f07771ccSwdenk executed anyway. 4777f07771ccSwdenk 4778f07771ccSwdenk(2) If you execute several variables with one call to run (i. e. 477911ccc33fSMarcel Ziswiler calling run with a list of variables as arguments), any failing 4780f07771ccSwdenk command will cause "run" to terminate, i. e. the remaining 4781f07771ccSwdenk variables are not executed. 4782f07771ccSwdenk 4783c609719bSwdenkNote for Redundant Ethernet Interfaces: 4784c609719bSwdenk======================================= 4785c609719bSwdenk 478611ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports 4787c609719bSwdenksuch configurations and is capable of automatic selection of a 47887152b1d0Swdenk"working" interface when needed. MAC assignment works as follows: 4789c609719bSwdenk 4790c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding 4791c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0), 4792c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ... 4793c609719bSwdenk 4794c609719bSwdenkIf the network interface stores some valid MAC address (for instance 4795c609719bSwdenkin SROM), this is used as default address if there is NO correspon- 4796c609719bSwdenkding setting in the environment; if the corresponding environment 4797c609719bSwdenkvariable is set, this overrides the settings in the card; that means: 4798c609719bSwdenk 4799c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the 4800c609719bSwdenk environment, the SROM's address is used. 4801c609719bSwdenk 4802c609719bSwdenko If there is no valid address in the SROM, and a definition in the 4803c609719bSwdenk environment exists, then the value from the environment variable is 4804c609719bSwdenk used. 4805c609719bSwdenk 4806c609719bSwdenko If both the SROM and the environment contain a MAC address, and 4807c609719bSwdenk both addresses are the same, this MAC address is used. 4808c609719bSwdenk 4809c609719bSwdenko If both the SROM and the environment contain a MAC address, and the 4810c609719bSwdenk addresses differ, the value from the environment is used and a 4811c609719bSwdenk warning is printed. 4812c609719bSwdenk 4813c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error 4814c609719bSwdenk is raised. 4815c609719bSwdenk 4816ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses 4817ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process. This 4818ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable. 4819ecee9324SBen WarrenThe naming convention is as follows: 4820ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc. 4821c609719bSwdenk 4822c609719bSwdenkImage Formats: 4823c609719bSwdenk============== 4824c609719bSwdenk 48253310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on) 48263310c549SMarian Balakowiczimages in two formats: 48273310c549SMarian Balakowicz 48283310c549SMarian BalakowiczNew uImage format (FIT) 48293310c549SMarian Balakowicz----------------------- 48303310c549SMarian Balakowicz 48313310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar 48323310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple 48333310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by 48343310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory. 48353310c549SMarian Balakowicz 48363310c549SMarian Balakowicz 48373310c549SMarian BalakowiczOld uImage format 48383310c549SMarian Balakowicz----------------- 48393310c549SMarian Balakowicz 48403310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything, 48413310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for 48423310c549SMarian Balakowiczdetails; basically, the header defines the following image properties: 4843c609719bSwdenk 4844c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD, 4845c609719bSwdenk 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks, 4846f5ed9e39SPeter Tyser LynxOS, pSOS, QNX, RTEMS, INTEGRITY; 4847f5ed9e39SPeter Tyser Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS, 4848f5ed9e39SPeter Tyser INTEGRITY). 48497b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86, 4850afc1ce82SMacpaul Lin IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit; 4851afc1ce82SMacpaul Lin Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC). 4852c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2) 4853c609719bSwdenk* Load Address 4854c609719bSwdenk* Entry Point 4855c609719bSwdenk* Image Name 4856c609719bSwdenk* Image Timestamp 4857c609719bSwdenk 4858c609719bSwdenkThe header is marked by a special Magic Number, and both the header 4859c609719bSwdenkand the data portions of the image are secured against corruption by 4860c609719bSwdenkCRC32 checksums. 4861c609719bSwdenk 4862c609719bSwdenk 4863c609719bSwdenkLinux Support: 4864c609719bSwdenk============== 4865c609719bSwdenk 4866c609719bSwdenkAlthough U-Boot should support any OS or standalone application 48677152b1d0Swdenkeasily, the main focus has always been on Linux during the design of 4868c609719bSwdenkU-Boot. 4869c609719bSwdenk 4870c609719bSwdenkU-Boot includes many features that so far have been part of some 4871c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any 4872c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image; 4873c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation 48747152b1d0Swdenkserves several purposes: 4875c609719bSwdenk 4876c609719bSwdenk- the same features can be used for other OS or standalone 4877c609719bSwdenk applications (for instance: using compressed images to reduce the 4878c609719bSwdenk Flash memory footprint) 4879c609719bSwdenk 4880c609719bSwdenk- it becomes much easier to port new Linux kernel versions because 48817152b1d0Swdenk lots of low-level, hardware dependent stuff are done by U-Boot 4882c609719bSwdenk 4883c609719bSwdenk- the same Linux kernel image can now be used with different "initrd" 4884c609719bSwdenk images; of course this also means that different kernel images can 4885c609719bSwdenk be run with the same "initrd". This makes testing easier (you don't 4886c609719bSwdenk have to build a new "zImage.initrd" Linux image when you just 4887c609719bSwdenk change a file in your "initrd"). Also, a field-upgrade of the 4888c609719bSwdenk software is easier now. 4889c609719bSwdenk 4890c609719bSwdenk 4891c609719bSwdenkLinux HOWTO: 4892c609719bSwdenk============ 4893c609719bSwdenk 4894c609719bSwdenkPorting Linux to U-Boot based systems: 4895c609719bSwdenk--------------------------------------- 4896c609719bSwdenk 4897c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to 4898c609719bSwdenkconfigure the Linux device drivers for use with your target hardware 4899c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to 4900c609719bSwdenkLinux :-). 4901c609719bSwdenk 4902a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot). 4903c609719bSwdenk 4904c609719bSwdenkJust make sure your machine specific header file (for instance 4905c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board 49061dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h, 49071dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value 49086d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR. 4909c609719bSwdenk 4910c609719bSwdenk 4911c609719bSwdenkConfiguring the Linux kernel: 4912c609719bSwdenk----------------------------- 4913c609719bSwdenk 4914c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root 4915c609719bSwdenkdevice (initial ramdisk, NFS) for your target system. 4916c609719bSwdenk 4917c609719bSwdenk 4918c609719bSwdenkBuilding a Linux Image: 4919c609719bSwdenk----------------------- 4920c609719bSwdenk 492124ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are 492224ee89b9Swdenknot used. If you use recent kernel source, a new build target 492324ee89b9Swdenk"uImage" will exist which automatically builds an image usable by 492424ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target, 492524ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a 492624ee89b9Swdenk100% compatible format. 4927c609719bSwdenk 4928c609719bSwdenkExample: 4929c609719bSwdenk 4930c609719bSwdenk make TQM850L_config 4931c609719bSwdenk make oldconfig 4932c609719bSwdenk make dep 493324ee89b9Swdenk make uImage 4934c609719bSwdenk 493524ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to 493624ee89b9Swdenkencapsulate a compressed Linux kernel image with header information, 493724ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing: 4938c609719bSwdenk 493924ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format): 494024ee89b9Swdenk 494124ee89b9Swdenk* convert the kernel into a raw binary image: 494224ee89b9Swdenk 494324ee89b9Swdenk ${CROSS_COMPILE}-objcopy -O binary \ 494424ee89b9Swdenk -R .note -R .comment \ 494524ee89b9Swdenk -S vmlinux linux.bin 494624ee89b9Swdenk 494724ee89b9Swdenk* compress the binary image: 494824ee89b9Swdenk 494924ee89b9Swdenk gzip -9 linux.bin 495024ee89b9Swdenk 495124ee89b9Swdenk* package compressed binary image for U-Boot: 495224ee89b9Swdenk 495324ee89b9Swdenk mkimage -A ppc -O linux -T kernel -C gzip \ 495424ee89b9Swdenk -a 0 -e 0 -n "Linux Kernel Image" \ 495524ee89b9Swdenk -d linux.bin.gz uImage 495624ee89b9Swdenk 495724ee89b9Swdenk 495824ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use 495924ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or 496024ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64 496124ee89b9Swdenkbyte header containing information about target architecture, 496224ee89b9Swdenkoperating system, image type, compression method, entry points, time 496324ee89b9Swdenkstamp, CRC32 checksums, etc. 496424ee89b9Swdenk 496524ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and 496624ee89b9Swdenkprint the header information, or to build new images. 4967c609719bSwdenk 4968c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information 4969c609719bSwdenkcontained in the header of an existing U-Boot image; this includes 4970c609719bSwdenkchecksum verification: 4971c609719bSwdenk 4972c609719bSwdenk tools/mkimage -l image 4973c609719bSwdenk -l ==> list image header information 4974c609719bSwdenk 4975c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image 4976c609719bSwdenkfrom a "data file" which is used as image payload: 4977c609719bSwdenk 4978c609719bSwdenk tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \ 4979c609719bSwdenk -n name -d data_file image 4980c609719bSwdenk -A ==> set architecture to 'arch' 4981c609719bSwdenk -O ==> set operating system to 'os' 4982c609719bSwdenk -T ==> set image type to 'type' 4983c609719bSwdenk -C ==> set compression type 'comp' 4984c609719bSwdenk -a ==> set load address to 'addr' (hex) 4985c609719bSwdenk -e ==> set entry point to 'ep' (hex) 4986c609719bSwdenk -n ==> set image name to 'name' 4987c609719bSwdenk -d ==> use image data from 'datafile' 4988c609719bSwdenk 498969459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load 499069459791Swdenkaddress (0x00000000), but the entry point address depends on the 499169459791Swdenkkernel version: 4992c609719bSwdenk 4993c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C, 499424ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000. 4995c609719bSwdenk 4996c609719bSwdenkSo a typical call to build a U-Boot image would read: 4997c609719bSwdenk 499824ee89b9Swdenk -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 499924ee89b9Swdenk > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \ 5000a47a12beSStefan Roese > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \ 500124ee89b9Swdenk > examples/uImage.TQM850L 500224ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 5003c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 5004c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 5005c609719bSwdenk Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 5006c609719bSwdenk Load Address: 0x00000000 500724ee89b9Swdenk Entry Point: 0x00000000 5008c609719bSwdenk 5009c609719bSwdenkTo verify the contents of the image (or check for corruption): 5010c609719bSwdenk 501124ee89b9Swdenk -> tools/mkimage -l examples/uImage.TQM850L 501224ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 5013c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 5014c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 5015c609719bSwdenk Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 5016c609719bSwdenk Load Address: 0x00000000 501724ee89b9Swdenk Entry Point: 0x00000000 5018c609719bSwdenk 5019c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade 5020c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this 5021c609719bSwdenkneeds more space in Flash, but boots much faster since it does not 5022c609719bSwdenkneed to be uncompressed: 5023c609719bSwdenk 5024a47a12beSStefan Roese -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz 502524ee89b9Swdenk -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 502624ee89b9Swdenk > -A ppc -O linux -T kernel -C none -a 0 -e 0 \ 5027a47a12beSStefan Roese > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \ 502824ee89b9Swdenk > examples/uImage.TQM850L-uncompressed 502924ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 5030c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 5031c609719bSwdenk Image Type: PowerPC Linux Kernel Image (uncompressed) 5032c609719bSwdenk Data Size: 792160 Bytes = 773.59 kB = 0.76 MB 5033c609719bSwdenk Load Address: 0x00000000 503424ee89b9Swdenk Entry Point: 0x00000000 5035c609719bSwdenk 5036c609719bSwdenk 5037c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file 5038c609719bSwdenkwhen your kernel is intended to use an initial ramdisk: 5039c609719bSwdenk 5040c609719bSwdenk -> tools/mkimage -n 'Simple Ramdisk Image' \ 5041c609719bSwdenk > -A ppc -O linux -T ramdisk -C gzip \ 5042c609719bSwdenk > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd 5043c609719bSwdenk Image Name: Simple Ramdisk Image 5044c609719bSwdenk Created: Wed Jan 12 14:01:50 2000 5045c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 5046c609719bSwdenk Data Size: 566530 Bytes = 553.25 kB = 0.54 MB 5047c609719bSwdenk Load Address: 0x00000000 5048c609719bSwdenk Entry Point: 0x00000000 5049c609719bSwdenk 5050c609719bSwdenk 5051c609719bSwdenkInstalling a Linux Image: 5052c609719bSwdenk------------------------- 5053c609719bSwdenk 5054c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface, 5055c609719bSwdenkyou must convert the image to S-Record format: 5056c609719bSwdenk 5057c609719bSwdenk objcopy -I binary -O srec examples/image examples/image.srec 5058c609719bSwdenk 5059c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot 5060c609719bSwdenkimage header, so the resulting S-Record file will be relative to 5061c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to 5062c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads' 5063c609719bSwdenkcommand. 5064c609719bSwdenk 5065c609719bSwdenkExample: install the image to address 0x40100000 (which on the 5066c609719bSwdenkTQM8xxL is in the first Flash bank): 5067c609719bSwdenk 5068c609719bSwdenk => erase 40100000 401FFFFF 5069c609719bSwdenk 5070c609719bSwdenk .......... done 5071c609719bSwdenk Erased 8 sectors 5072c609719bSwdenk 5073c609719bSwdenk => loads 40100000 5074c609719bSwdenk ## Ready for S-Record download ... 5075c609719bSwdenk ~>examples/image.srec 5076c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 12 13 ... 5077c609719bSwdenk ... 5078c609719bSwdenk 15989 15990 15991 15992 5079c609719bSwdenk [file transfer complete] 5080c609719bSwdenk [connected] 5081c609719bSwdenk ## Start Addr = 0x00000000 5082c609719bSwdenk 5083c609719bSwdenk 5084c609719bSwdenkYou can check the success of the download using the 'iminfo' command; 5085c609719bSwdenkthis includes a checksum verification so you can be sure no data 5086c609719bSwdenkcorruption happened: 5087c609719bSwdenk 5088c609719bSwdenk => imi 40100000 5089c609719bSwdenk 5090c609719bSwdenk ## Checking Image at 40100000 ... 5091c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 5092c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 5093c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 5094c609719bSwdenk Load Address: 00000000 5095c609719bSwdenk Entry Point: 0000000c 5096c609719bSwdenk Verifying Checksum ... OK 5097c609719bSwdenk 5098c609719bSwdenk 5099c609719bSwdenkBoot Linux: 5100c609719bSwdenk----------- 5101c609719bSwdenk 5102c609719bSwdenkThe "bootm" command is used to boot an application that is stored in 5103c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents 5104c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as 5105c609719bSwdenkparameters. You can check and modify this variable using the 5106c609719bSwdenk"printenv" and "setenv" commands: 5107c609719bSwdenk 5108c609719bSwdenk 5109c609719bSwdenk => printenv bootargs 5110c609719bSwdenk bootargs=root=/dev/ram 5111c609719bSwdenk 5112c609719bSwdenk => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 5113c609719bSwdenk 5114c609719bSwdenk => printenv bootargs 5115c609719bSwdenk bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 5116c609719bSwdenk 5117c609719bSwdenk => bootm 40020000 5118c609719bSwdenk ## Booting Linux kernel at 40020000 ... 5119c609719bSwdenk Image Name: 2.2.13 for NFS on TQM850L 5120c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 5121c609719bSwdenk Data Size: 381681 Bytes = 372 kB = 0 MB 5122c609719bSwdenk Load Address: 00000000 5123c609719bSwdenk Entry Point: 0000000c 5124c609719bSwdenk Verifying Checksum ... OK 5125c609719bSwdenk Uncompressing Kernel Image ... OK 5126c609719bSwdenk 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 5127c609719bSwdenk Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 5128c609719bSwdenk time_init: decrementer frequency = 187500000/60 5129c609719bSwdenk Calibrating delay loop... 49.77 BogoMIPS 5130c609719bSwdenk Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000] 5131c609719bSwdenk ... 5132c609719bSwdenk 513311ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass 51347152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT 5135c609719bSwdenkformat!) to the "bootm" command: 5136c609719bSwdenk 5137c609719bSwdenk => imi 40100000 40200000 5138c609719bSwdenk 5139c609719bSwdenk ## Checking Image at 40100000 ... 5140c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 5141c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 5142c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 5143c609719bSwdenk Load Address: 00000000 5144c609719bSwdenk Entry Point: 0000000c 5145c609719bSwdenk Verifying Checksum ... OK 5146c609719bSwdenk 5147c609719bSwdenk ## Checking Image at 40200000 ... 5148c609719bSwdenk Image Name: Simple Ramdisk Image 5149c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 5150c609719bSwdenk Data Size: 566530 Bytes = 553 kB = 0 MB 5151c609719bSwdenk Load Address: 00000000 5152c609719bSwdenk Entry Point: 00000000 5153c609719bSwdenk Verifying Checksum ... OK 5154c609719bSwdenk 5155c609719bSwdenk => bootm 40100000 40200000 5156c609719bSwdenk ## Booting Linux kernel at 40100000 ... 5157c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 5158c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 5159c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 5160c609719bSwdenk Load Address: 00000000 5161c609719bSwdenk Entry Point: 0000000c 5162c609719bSwdenk Verifying Checksum ... OK 5163c609719bSwdenk Uncompressing Kernel Image ... OK 5164c609719bSwdenk ## Loading RAMDisk Image at 40200000 ... 5165c609719bSwdenk Image Name: Simple Ramdisk Image 5166c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 5167c609719bSwdenk Data Size: 566530 Bytes = 553 kB = 0 MB 5168c609719bSwdenk Load Address: 00000000 5169c609719bSwdenk Entry Point: 00000000 5170c609719bSwdenk Verifying Checksum ... OK 5171c609719bSwdenk Loading Ramdisk ... OK 5172c609719bSwdenk 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 5173c609719bSwdenk Boot arguments: root=/dev/ram 5174c609719bSwdenk time_init: decrementer frequency = 187500000/60 5175c609719bSwdenk Calibrating delay loop... 49.77 BogoMIPS 5176c609719bSwdenk ... 5177c609719bSwdenk RAMDISK: Compressed image found at block 0 5178c609719bSwdenk VFS: Mounted root (ext2 filesystem). 5179c609719bSwdenk 5180c609719bSwdenk bash# 5181c609719bSwdenk 51820267768eSMatthew McClintockBoot Linux and pass a flat device tree: 51830267768eSMatthew McClintock----------- 51840267768eSMatthew McClintock 51850267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section 51860267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The 51870267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated 51880267768eSMatthew McClintockflat device tree: 51890267768eSMatthew McClintock 51900267768eSMatthew McClintock=> print oftaddr 51910267768eSMatthew McClintockoftaddr=0x300000 51920267768eSMatthew McClintock=> print oft 51930267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb 51940267768eSMatthew McClintock=> tftp $oftaddr $oft 51950267768eSMatthew McClintockSpeed: 1000, full duplex 51960267768eSMatthew McClintockUsing TSEC0 device 51970267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101 51980267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'. 51990267768eSMatthew McClintockLoad address: 0x300000 52000267768eSMatthew McClintockLoading: # 52010267768eSMatthew McClintockdone 52020267768eSMatthew McClintockBytes transferred = 4106 (100a hex) 52030267768eSMatthew McClintock=> tftp $loadaddr $bootfile 52040267768eSMatthew McClintockSpeed: 1000, full duplex 52050267768eSMatthew McClintockUsing TSEC0 device 52060267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2 52070267768eSMatthew McClintockFilename 'uImage'. 52080267768eSMatthew McClintockLoad address: 0x200000 52090267768eSMatthew McClintockLoading:############ 52100267768eSMatthew McClintockdone 52110267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex) 52120267768eSMatthew McClintock=> print loadaddr 52130267768eSMatthew McClintockloadaddr=200000 52140267768eSMatthew McClintock=> print oftaddr 52150267768eSMatthew McClintockoftaddr=0x300000 52160267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr 52170267768eSMatthew McClintock## Booting image at 00200000 ... 52180267768eSMatthew McClintock Image Name: Linux-2.6.17-dirty 52190267768eSMatthew McClintock Image Type: PowerPC Linux Kernel Image (gzip compressed) 52200267768eSMatthew McClintock Data Size: 1029343 Bytes = 1005.2 kB 52210267768eSMatthew McClintock Load Address: 00000000 52220267768eSMatthew McClintock Entry Point: 00000000 52230267768eSMatthew McClintock Verifying Checksum ... OK 52240267768eSMatthew McClintock Uncompressing Kernel Image ... OK 52250267768eSMatthew McClintockBooting using flat device tree at 0x300000 52260267768eSMatthew McClintockUsing MPC85xx ADS machine description 52270267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb 52280267768eSMatthew McClintock[snip] 52290267768eSMatthew McClintock 52300267768eSMatthew McClintock 52316069ff26SwdenkMore About U-Boot Image Types: 52326069ff26Swdenk------------------------------ 52336069ff26Swdenk 52346069ff26SwdenkU-Boot supports the following image types: 52356069ff26Swdenk 52366069ff26Swdenk "Standalone Programs" are directly runnable in the environment 52376069ff26Swdenk provided by U-Boot; it is expected that (if they behave 52386069ff26Swdenk well) you can continue to work in U-Boot after return from 52396069ff26Swdenk the Standalone Program. 52406069ff26Swdenk "OS Kernel Images" are usually images of some Embedded OS which 52416069ff26Swdenk will take over control completely. Usually these programs 52426069ff26Swdenk will install their own set of exception handlers, device 52436069ff26Swdenk drivers, set up the MMU, etc. - this means, that you cannot 52446069ff26Swdenk expect to re-enter U-Boot except by resetting the CPU. 52456069ff26Swdenk "RAMDisk Images" are more or less just data blocks, and their 52466069ff26Swdenk parameters (address, size) are passed to an OS kernel that is 52476069ff26Swdenk being started. 52486069ff26Swdenk "Multi-File Images" contain several images, typically an OS 52496069ff26Swdenk (Linux) kernel image and one or more data images like 52506069ff26Swdenk RAMDisks. This construct is useful for instance when you want 52516069ff26Swdenk to boot over the network using BOOTP etc., where the boot 52526069ff26Swdenk server provides just a single image file, but you want to get 52536069ff26Swdenk for instance an OS kernel and a RAMDisk image. 52546069ff26Swdenk 52556069ff26Swdenk "Multi-File Images" start with a list of image sizes, each 52566069ff26Swdenk image size (in bytes) specified by an "uint32_t" in network 52576069ff26Swdenk byte order. This list is terminated by an "(uint32_t)0". 52586069ff26Swdenk Immediately after the terminating 0 follow the images, one by 52596069ff26Swdenk one, all aligned on "uint32_t" boundaries (size rounded up to 52606069ff26Swdenk a multiple of 4 bytes). 52616069ff26Swdenk 52626069ff26Swdenk "Firmware Images" are binary images containing firmware (like 52636069ff26Swdenk U-Boot or FPGA images) which usually will be programmed to 52646069ff26Swdenk flash memory. 52656069ff26Swdenk 52666069ff26Swdenk "Script files" are command sequences that will be executed by 52676069ff26Swdenk U-Boot's command interpreter; this feature is especially 52686069ff26Swdenk useful when you configure U-Boot to use a real shell (hush) 52696069ff26Swdenk as command interpreter. 52706069ff26Swdenk 527144f074c7SMarek VasutBooting the Linux zImage: 527244f074c7SMarek Vasut------------------------- 527344f074c7SMarek Vasut 527444f074c7SMarek VasutOn some platforms, it's possible to boot Linux zImage. This is done 527544f074c7SMarek Vasutusing the "bootz" command. The syntax of "bootz" command is the same 527644f074c7SMarek Vasutas the syntax of "bootm" command. 527744f074c7SMarek Vasut 52788ac28563STom RiniNote, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply 5279017e1f3fSMarek Vasutkernel with raw initrd images. The syntax is slightly different, the 5280017e1f3fSMarek Vasutaddress of the initrd must be augmented by it's size, in the following 5281017e1f3fSMarek Vasutformat: "<initrd addres>:<initrd size>". 5282017e1f3fSMarek Vasut 5283c609719bSwdenk 5284c609719bSwdenkStandalone HOWTO: 5285c609719bSwdenk================= 5286c609719bSwdenk 5287c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and 5288c609719bSwdenkrun "standalone" applications, which can use some resources of 5289c609719bSwdenkU-Boot like console I/O functions or interrupt services. 5290c609719bSwdenk 5291c609719bSwdenkTwo simple examples are included with the sources: 5292c609719bSwdenk 5293c609719bSwdenk"Hello World" Demo: 5294c609719bSwdenk------------------- 5295c609719bSwdenk 5296c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo 5297c609719bSwdenkapplication; it is automatically compiled when you build U-Boot. 5298c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it 5299c609719bSwdenklike that: 5300c609719bSwdenk 5301c609719bSwdenk => loads 5302c609719bSwdenk ## Ready for S-Record download ... 5303c609719bSwdenk ~>examples/hello_world.srec 5304c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 ... 5305c609719bSwdenk [file transfer complete] 5306c609719bSwdenk [connected] 5307c609719bSwdenk ## Start Addr = 0x00040004 5308c609719bSwdenk 5309c609719bSwdenk => go 40004 Hello World! This is a test. 5310c609719bSwdenk ## Starting application at 0x00040004 ... 5311c609719bSwdenk Hello World 5312c609719bSwdenk argc = 7 5313c609719bSwdenk argv[0] = "40004" 5314c609719bSwdenk argv[1] = "Hello" 5315c609719bSwdenk argv[2] = "World!" 5316c609719bSwdenk argv[3] = "This" 5317c609719bSwdenk argv[4] = "is" 5318c609719bSwdenk argv[5] = "a" 5319c609719bSwdenk argv[6] = "test." 5320c609719bSwdenk argv[7] = "<NULL>" 5321c609719bSwdenk Hit any key to exit ... 5322c609719bSwdenk 5323c609719bSwdenk ## Application terminated, rc = 0x0 5324c609719bSwdenk 5325c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt 5326c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'. 5327c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second. 5328c609719bSwdenkThe interrupt service routine is trivial, just printing a '.' 5329c609719bSwdenkcharacter, but this is just a demo program. The application can be 5330c609719bSwdenkcontrolled by the following keys: 5331c609719bSwdenk 5332c609719bSwdenk ? - print current values og the CPM Timer registers 5333c609719bSwdenk b - enable interrupts and start timer 5334c609719bSwdenk e - stop timer and disable interrupts 5335c609719bSwdenk q - quit application 5336c609719bSwdenk 5337c609719bSwdenk => loads 5338c609719bSwdenk ## Ready for S-Record download ... 5339c609719bSwdenk ~>examples/timer.srec 5340c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 ... 5341c609719bSwdenk [file transfer complete] 5342c609719bSwdenk [connected] 5343c609719bSwdenk ## Start Addr = 0x00040004 5344c609719bSwdenk 5345c609719bSwdenk => go 40004 5346c609719bSwdenk ## Starting application at 0x00040004 ... 5347c609719bSwdenk TIMERS=0xfff00980 5348c609719bSwdenk Using timer 1 5349c609719bSwdenk tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0 5350c609719bSwdenk 5351c609719bSwdenkHit 'b': 5352c609719bSwdenk [q, b, e, ?] Set interval 1000000 us 5353c609719bSwdenk Enabling timer 5354c609719bSwdenkHit '?': 5355c609719bSwdenk [q, b, e, ?] ........ 5356c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0 5357c609719bSwdenkHit '?': 5358c609719bSwdenk [q, b, e, ?] . 5359c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0 5360c609719bSwdenkHit '?': 5361c609719bSwdenk [q, b, e, ?] . 5362c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0 5363c609719bSwdenkHit '?': 5364c609719bSwdenk [q, b, e, ?] . 5365c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0 5366c609719bSwdenkHit 'e': 5367c609719bSwdenk [q, b, e, ?] ...Stopping timer 5368c609719bSwdenkHit 'q': 5369c609719bSwdenk [q, b, e, ?] ## Application terminated, rc = 0x0 5370c609719bSwdenk 5371c609719bSwdenk 537285ec0bccSwdenkMinicom warning: 537385ec0bccSwdenk================ 537485ec0bccSwdenk 53757152b1d0SwdenkOver time, many people have reported problems when trying to use the 537685ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd) 537785ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under 5378f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and 537985ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and 5380e53515a2SKarl O. Pincuse "cu" for S-Record download ("loads" command). See 5381e53515a2SKarl O. Pinchttp://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3. 5382e53515a2SKarl O. Pincfor help with kermit. 5383e53515a2SKarl O. Pinc 538485ec0bccSwdenk 538552f52c14SwdenkNevertheless, if you absolutely want to use it try adding this 538652f52c14Swdenkconfiguration to your "File transfer protocols" section: 538752f52c14Swdenk 538852f52c14Swdenk Name Program Name U/D FullScr IO-Red. Multi 538952f52c14Swdenk X kermit /usr/bin/kermit -i -l %l -s Y U Y N N 539052f52c14Swdenk Y kermit /usr/bin/kermit -i -l %l -r N D Y N N 539152f52c14Swdenk 539252f52c14Swdenk 5393c609719bSwdenkNetBSD Notes: 5394c609719bSwdenk============= 5395c609719bSwdenk 5396c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host 5397c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx). 5398c609719bSwdenk 5399c609719bSwdenkBuilding requires a cross environment; it is known to work on 5400c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also 5401c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make). 5402c609719bSwdenkNote that the cross-powerpc package does not install include files; 5403c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is 5404c609719bSwdenkmissing. This file has to be installed and patched manually: 5405c609719bSwdenk 5406c609719bSwdenk # cd /usr/pkg/cross/powerpc-netbsd/include 5407c609719bSwdenk # mkdir powerpc 5408c609719bSwdenk # ln -s powerpc machine 5409c609719bSwdenk # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h 5410c609719bSwdenk # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST 5411c609719bSwdenk 5412c609719bSwdenkNative builds *don't* work due to incompatibilities between native 5413c609719bSwdenkand U-Boot include files. 5414c609719bSwdenk 5415c609719bSwdenkBooting assumes that (the first part of) the image booted is a 5416c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel 5417c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source 5418c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the 54192a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz 5420c609719bSwdenk 5421c609719bSwdenk 5422c609719bSwdenkImplementation Internals: 5423c609719bSwdenk========================= 5424c609719bSwdenk 5425c609719bSwdenkThe following is not intended to be a complete description of every 5426c609719bSwdenkimplementation detail. However, it should help to understand the 5427c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom 5428c609719bSwdenkhardware. 5429c609719bSwdenk 5430c609719bSwdenk 5431c609719bSwdenkInitial Stack, Global Data: 5432c609719bSwdenk--------------------------- 5433c609719bSwdenk 5434c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot 5435c609719bSwdenkstarts running out of ROM (flash memory), usually without access to 5436c609719bSwdenksystem RAM (because the memory controller is not initialized yet). 5437c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS 5438c609719bSwdenkis not initialized as zero. To be able to get a C environment working 5439c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation 5440c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU 5441c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and 5442c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be 5443c609719bSwdenklocked as (mis-) used as memory, etc. 5444c609719bSwdenk 54457152b1d0Swdenk Chris Hallinan posted a good summary of these issues to the 54460668236bSWolfgang Denk U-Boot mailing list: 544743d9616cSwdenk 544843d9616cSwdenk Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)? 544943d9616cSwdenk From: "Chris Hallinan" <clh@net1plus.com> 545043d9616cSwdenk Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET) 545143d9616cSwdenk ... 545243d9616cSwdenk 545343d9616cSwdenk Correct me if I'm wrong, folks, but the way I understand it 545443d9616cSwdenk is this: Using DCACHE as initial RAM for Stack, etc, does not 545543d9616cSwdenk require any physical RAM backing up the cache. The cleverness 545643d9616cSwdenk is that the cache is being used as a temporary supply of 545743d9616cSwdenk necessary storage before the SDRAM controller is setup. It's 545811ccc33fSMarcel Ziswiler beyond the scope of this list to explain the details, but you 545943d9616cSwdenk can see how this works by studying the cache architecture and 546043d9616cSwdenk operation in the architecture and processor-specific manuals. 546143d9616cSwdenk 546243d9616cSwdenk OCM is On Chip Memory, which I believe the 405GP has 4K. It 546343d9616cSwdenk is another option for the system designer to use as an 546411ccc33fSMarcel Ziswiler initial stack/RAM area prior to SDRAM being available. Either 546543d9616cSwdenk option should work for you. Using CS 4 should be fine if your 546643d9616cSwdenk board designers haven't used it for something that would 546743d9616cSwdenk cause you grief during the initial boot! It is frequently not 546843d9616cSwdenk used. 546943d9616cSwdenk 54706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere 547143d9616cSwdenk with your processor/board/system design. The default value 547243d9616cSwdenk you will find in any recent u-boot distribution in 54738a316c9bSStefan Roese walnut.h should work for you. I'd set it to a value larger 547443d9616cSwdenk than your SDRAM module. If you have a 64MB SDRAM module, set 547543d9616cSwdenk it above 400_0000. Just make sure your board has no resources 547643d9616cSwdenk that are supposed to respond to that address! That code in 547743d9616cSwdenk start.S has been around a while and should work as is when 547843d9616cSwdenk you get the config right. 547943d9616cSwdenk 548043d9616cSwdenk -Chris Hallinan 548143d9616cSwdenk DS4.COM, Inc. 548243d9616cSwdenk 5483c609719bSwdenkIt is essential to remember this, since it has some impact on the C 5484c609719bSwdenkcode for the initialization procedures: 5485c609719bSwdenk 5486c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt 5487c609719bSwdenk to write it. 5488c609719bSwdenk 548911ccc33fSMarcel Ziswiler* Do not use any uninitialized global data (or implicitely initialized 5490c609719bSwdenk as zero data - BSS segment) at all - this is undefined, initiali- 54917152b1d0Swdenk zation is performed later (when relocating to RAM). 5492c609719bSwdenk 5493c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like 5494c609719bSwdenk that. 5495c609719bSwdenk 5496c609719bSwdenkHaving only the stack as writable memory limits means we cannot use 5497c609719bSwdenknormal global data to share information beween the code. But it 5498c609719bSwdenkturned out that the implementation of U-Boot can be greatly 5499c609719bSwdenksimplified by making a global data structure (gd_t) available to all 5500c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_ 5501c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of 5502c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we 5503c609719bSwdenkplace a pointer (gd) to the global data into a register which we 5504c609719bSwdenkreserve for this purpose. 5505c609719bSwdenk 55067152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the 5507c609719bSwdenkrelevant (E)ABI specifications for the current architecture, and by 5508c609719bSwdenkGCC's implementation. 5509c609719bSwdenk 5510c609719bSwdenkFor PowerPC, the following registers have specific use: 5511c609719bSwdenk R1: stack pointer 5512e7670f6cSWolfgang Denk R2: reserved for system use 5513c609719bSwdenk R3-R4: parameter passing and return values 5514c609719bSwdenk R5-R10: parameter passing 5515c609719bSwdenk R13: small data area pointer 5516c609719bSwdenk R30: GOT pointer 5517c609719bSwdenk R31: frame pointer 5518c609719bSwdenk 5519e6bee808SJoakim Tjernlund (U-Boot also uses R12 as internal GOT pointer. r12 5520e6bee808SJoakim Tjernlund is a volatile register so r12 needs to be reset when 5521e6bee808SJoakim Tjernlund going back and forth between asm and C) 5522c609719bSwdenk 5523e7670f6cSWolfgang Denk ==> U-Boot will use R2 to hold a pointer to the global data 5524c609719bSwdenk 5525c609719bSwdenk Note: on PPC, we could use a static initializer (since the 5526c609719bSwdenk address of the global data structure is known at compile time), 5527c609719bSwdenk but it turned out that reserving a register results in somewhat 5528c609719bSwdenk smaller code - although the code savings are not that big (on 5529c609719bSwdenk average for all boards 752 bytes for the whole U-Boot image, 5530c609719bSwdenk 624 text + 127 data). 5531c609719bSwdenk 5532c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here: 55334c58eb55SMike Frysinger http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface 55344c58eb55SMike Frysinger 5535c4db335cSRobin Getz ==> U-Boot will use P3 to hold a pointer to the global data 55364c58eb55SMike Frysinger 5537c609719bSwdenkOn ARM, the following registers are used: 5538c609719bSwdenk 5539c609719bSwdenk R0: function argument word/integer result 5540c609719bSwdenk R1-R3: function argument word 5541c609719bSwdenk R9: GOT pointer 5542c609719bSwdenk R10: stack limit (used only if stack checking if enabled) 5543c609719bSwdenk R11: argument (frame) pointer 5544c609719bSwdenk R12: temporary workspace 5545c609719bSwdenk R13: stack pointer 5546c609719bSwdenk R14: link register 5547c609719bSwdenk R15: program counter 5548c609719bSwdenk 5549c609719bSwdenk ==> U-Boot will use R8 to hold a pointer to the global data 5550c609719bSwdenk 55510df01fd3SThomas ChouOn Nios II, the ABI is documented here: 55520df01fd3SThomas Chou http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf 55530df01fd3SThomas Chou 55540df01fd3SThomas Chou ==> U-Boot will use gp to hold a pointer to the global data 55550df01fd3SThomas Chou 55560df01fd3SThomas Chou Note: on Nios II, we give "-G0" option to gcc and don't use gp 55570df01fd3SThomas Chou to access small data sections, so gp is free. 55580df01fd3SThomas Chou 5559afc1ce82SMacpaul LinOn NDS32, the following registers are used: 5560afc1ce82SMacpaul Lin 5561afc1ce82SMacpaul Lin R0-R1: argument/return 5562afc1ce82SMacpaul Lin R2-R5: argument 5563afc1ce82SMacpaul Lin R15: temporary register for assembler 5564afc1ce82SMacpaul Lin R16: trampoline register 5565afc1ce82SMacpaul Lin R28: frame pointer (FP) 5566afc1ce82SMacpaul Lin R29: global pointer (GP) 5567afc1ce82SMacpaul Lin R30: link register (LP) 5568afc1ce82SMacpaul Lin R31: stack pointer (SP) 5569afc1ce82SMacpaul Lin PC: program counter (PC) 5570afc1ce82SMacpaul Lin 5571afc1ce82SMacpaul Lin ==> U-Boot will use R10 to hold a pointer to the global data 5572afc1ce82SMacpaul Lin 5573d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope, 5574d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much. 5575c609719bSwdenk 5576c609719bSwdenkMemory Management: 5577c609719bSwdenk------------------ 5578c609719bSwdenk 5579c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the 5580c609719bSwdenkMMU is not used either for address mapping nor for memory protection. 5581c609719bSwdenk 5582c609719bSwdenkThe available memory is mapped to fixed addresses using the memory 5583c609719bSwdenkcontroller. In this process, a contiguous block is formed for each 5584c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several 5585c609719bSwdenkphysical memory banks. 5586c609719bSwdenk 5587c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on 5588c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After 5589c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself 5590c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some 55916d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN 5592c609719bSwdenkconfiguration setting]. Below that, a structure with global Board 5593c609719bSwdenkInfo data is placed, followed by the stack (growing downward). 5594c609719bSwdenk 5595c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB 5596c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF). 5597c609719bSwdenk 5598c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like 5599c609719bSwdenkthis: 5600c609719bSwdenk 5601c609719bSwdenk 0x0000 0000 Exception Vector code 5602c609719bSwdenk : 5603c609719bSwdenk 0x0000 1FFF 5604c609719bSwdenk 0x0000 2000 Free for Application Use 5605c609719bSwdenk : 5606c609719bSwdenk : 5607c609719bSwdenk 5608c609719bSwdenk : 5609c609719bSwdenk : 5610c609719bSwdenk 0x00FB FF20 Monitor Stack (Growing downward) 5611c609719bSwdenk 0x00FB FFAC Board Info Data and permanent copy of global data 5612c609719bSwdenk 0x00FC 0000 Malloc Arena 5613c609719bSwdenk : 5614c609719bSwdenk 0x00FD FFFF 5615c609719bSwdenk 0x00FE 0000 RAM Copy of Monitor Code 5616c609719bSwdenk ... eventually: LCD or video framebuffer 5617c609719bSwdenk ... eventually: pRAM (Protected RAM - unchanged by reset) 5618c609719bSwdenk 0x00FF FFFF [End of RAM] 5619c609719bSwdenk 5620c609719bSwdenk 5621c609719bSwdenkSystem Initialization: 5622c609719bSwdenk---------------------- 5623c609719bSwdenk 5624c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point 562511ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset 5626c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory. 56277152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address. 5628c609719bSwdenkTo be able to implement the initialization code in C, a (small!) 5629c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs 5630c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked 5631c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core, 5632c609719bSwdenkthe caches and the SIU. 5633c609719bSwdenk 5634c609719bSwdenkNext, all (potentially) available memory banks are mapped using a 5635c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries 5636c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash 5637c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is 5638c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a 5639c609719bSwdenksimple memory test is run that determines the size of the SDRAM 5640c609719bSwdenkbanks. 5641c609719bSwdenk 5642c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of 56437152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first 5644c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address 5645c609719bSwdenk0x00000000, with any additional banks following immediately to create 5646c609719bSwdenkcontiguous memory starting from 0. 5647c609719bSwdenk 5648c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area 5649c609719bSwdenkand allocates memory for use by malloc() and for the global Board 5650c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM 5651c609719bSwdenkpages, and the final stack is set up. 5652c609719bSwdenk 5653c609719bSwdenkOnly after this relocation will you have a "normal" C environment; 5654c609719bSwdenkuntil that you are restricted in several ways, mostly because you are 5655c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a 5656c609719bSwdenknew address in RAM. 5657c609719bSwdenk 5658c609719bSwdenk 5659c609719bSwdenkU-Boot Porting Guide: 5660c609719bSwdenk---------------------- 5661c609719bSwdenk 5662c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing 56636aff3115Swdenklist, October 2002] 5664c609719bSwdenk 5665c609719bSwdenk 5666c609719bSwdenkint main(int argc, char *argv[]) 5667c609719bSwdenk{ 5668c609719bSwdenk sighandler_t no_more_time; 5669c609719bSwdenk 5670c609719bSwdenk signal(SIGALRM, no_more_time); 5671c609719bSwdenk alarm(PROJECT_DEADLINE - toSec (3 * WEEK)); 5672c609719bSwdenk 5673c609719bSwdenk if (available_money > available_manpower) { 56746c3fef28SJerry Van Baren Pay consultant to port U-Boot; 5675c609719bSwdenk return 0; 5676c609719bSwdenk } 5677c609719bSwdenk 5678c609719bSwdenk Download latest U-Boot source; 5679c609719bSwdenk 56800668236bSWolfgang Denk Subscribe to u-boot mailing list; 56816aff3115Swdenk 56826c3fef28SJerry Van Baren if (clueless) 5683c609719bSwdenk email("Hi, I am new to U-Boot, how do I get started?"); 5684c609719bSwdenk 5685c609719bSwdenk while (learning) { 5686c609719bSwdenk Read the README file in the top level directory; 56877cb22f97Swdenk Read http://www.denx.de/twiki/bin/view/DULG/Manual; 56886c3fef28SJerry Van Baren Read applicable doc/*.README; 5689c609719bSwdenk Read the source, Luke; 56906c3fef28SJerry Van Baren /* find . -name "*.[chS]" | xargs grep -i <keyword> */ 5691c609719bSwdenk } 5692c609719bSwdenk 56936c3fef28SJerry Van Baren if (available_money > toLocalCurrency ($2500)) 56946c3fef28SJerry Van Baren Buy a BDI3000; 56956c3fef28SJerry Van Baren else 5696c609719bSwdenk Add a lot of aggravation and time; 5697c609719bSwdenk 56986c3fef28SJerry Van Baren if (a similar board exists) { /* hopefully... */ 56996c3fef28SJerry Van Baren cp -a board/<similar> board/<myboard> 57006c3fef28SJerry Van Baren cp include/configs/<similar>.h include/configs/<myboard>.h 57016c3fef28SJerry Van Baren } else { 5702c609719bSwdenk Create your own board support subdirectory; 57036c3fef28SJerry Van Baren Create your own board include/configs/<myboard>.h file; 57046c3fef28SJerry Van Baren } 57056c3fef28SJerry Van Baren Edit new board/<myboard> files 57066c3fef28SJerry Van Baren Edit new include/configs/<myboard>.h 5707c609719bSwdenk 57086c3fef28SJerry Van Baren while (!accepted) { 5709c609719bSwdenk while (!running) { 5710c609719bSwdenk do { 5711c609719bSwdenk Add / modify source code; 5712c609719bSwdenk } until (compiles); 5713c609719bSwdenk Debug; 5714c609719bSwdenk if (clueless) 5715c609719bSwdenk email("Hi, I am having problems..."); 5716c609719bSwdenk } 57176c3fef28SJerry Van Baren Send patch file to the U-Boot email list; 57186c3fef28SJerry Van Baren if (reasonable critiques) 57196c3fef28SJerry Van Baren Incorporate improvements from email list code review; 57206c3fef28SJerry Van Baren else 57216c3fef28SJerry Van Baren Defend code as written; 57226c3fef28SJerry Van Baren } 5723c609719bSwdenk 5724c609719bSwdenk return 0; 5725c609719bSwdenk} 5726c609719bSwdenk 5727c609719bSwdenkvoid no_more_time (int sig) 5728c609719bSwdenk{ 5729c609719bSwdenk hire_a_guru(); 5730c609719bSwdenk} 5731c609719bSwdenk 5732c609719bSwdenk 5733c609719bSwdenkCoding Standards: 5734c609719bSwdenk----------------- 5735c609719bSwdenk 5736c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel 57372c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script 57387ca9296eSWolfgang Denk"scripts/Lindent" in your Linux kernel source directory. 5739c609719bSwdenk 57402c051651SDetlev ZundelSource files originating from a different project (for example the 57412c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not 57422c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those 57432c051651SDetlev Zundelsources. 57442c051651SDetlev Zundel 57452c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in 57462c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//) 57472c051651SDetlev Zundelin your code. 5748c609719bSwdenk 5749c178d3daSwdenkPlease also stick to the following formatting rules: 5750180d3f74Swdenk- remove any trailing white space 57517ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces 5752180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds 57537ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files 5754180d3f74Swdenk- do not add trailing empty lines to source files 5755180d3f74Swdenk 5756c609719bSwdenkSubmissions which do not conform to the standards may be returned 5757c609719bSwdenkwith a request to reformat the changes. 5758c609719bSwdenk 5759c609719bSwdenk 5760c609719bSwdenkSubmitting Patches: 5761c609719bSwdenk------------------- 5762c609719bSwdenk 5763c609719bSwdenkSince the number of patches for U-Boot is growing, we need to 5764c609719bSwdenkestablish some rules. Submissions which do not conform to these rules 5765c609719bSwdenkmay be rejected, even when they contain important and valuable stuff. 5766c609719bSwdenk 57670d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details. 5768218ca724SWolfgang Denk 57690668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>; 57700668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot 57710668236bSWolfgang Denk 5772c609719bSwdenkWhen you send a patch, please include the following information with 5773c609719bSwdenkit: 5774c609719bSwdenk 5775c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes 5776c609719bSwdenk this bug. Please try to include a way of demonstrating that the 5777c609719bSwdenk patch actually fixes something. 5778c609719bSwdenk 5779c609719bSwdenk* For new features: a description of the feature and your 5780c609719bSwdenk implementation. 5781c609719bSwdenk 5782c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch) 5783c609719bSwdenk 5784c609719bSwdenk* For major contributions, your entry to the CREDITS file 5785c609719bSwdenk 5786c609719bSwdenk* When you add support for a new board, don't forget to add this 57877ca9296eSWolfgang Denk board to the MAINTAINERS file, too. 5788c609719bSwdenk 5789c609719bSwdenk* If your patch adds new configuration options, don't forget to 5790c609719bSwdenk document these in the README file. 5791c609719bSwdenk 5792218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly* 5793218ca724SWolfgang Denk recommended) you can easily generate the patch using the 57947ca9296eSWolfgang Denk "git format-patch". If you then use "git send-email" to send it to 5795218ca724SWolfgang Denk the U-Boot mailing list, you will avoid most of the common problems 5796218ca724SWolfgang Denk with some other mail clients. 5797c609719bSwdenk 5798218ca724SWolfgang Denk If you cannot use git, use "diff -purN OLD NEW". If your version of 5799218ca724SWolfgang Denk diff does not support these options, then get the latest version of 5800218ca724SWolfgang Denk GNU diff. 58016dff5529Swdenk 5802218ca724SWolfgang Denk The current directory when running this command shall be the parent 5803218ca724SWolfgang Denk directory of the U-Boot source tree (i. e. please make sure that 5804218ca724SWolfgang Denk your patch includes sufficient directory information for the 5805218ca724SWolfgang Denk affected files). 5806218ca724SWolfgang Denk 5807218ca724SWolfgang Denk We prefer patches as plain text. MIME attachments are discouraged, 5808218ca724SWolfgang Denk and compressed attachments must not be used. 5809c609719bSwdenk 581052f52c14Swdenk* If one logical set of modifications affects or creates several 581152f52c14Swdenk files, all these changes shall be submitted in a SINGLE patch file. 581252f52c14Swdenk 581352f52c14Swdenk* Changesets that contain different, unrelated modifications shall be 581452f52c14Swdenk submitted as SEPARATE patches, one patch per changeset. 581552f52c14Swdenk 581652f52c14Swdenk 5817c609719bSwdenkNotes: 5818c609719bSwdenk 5819c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched 5820c609719bSwdenk source tree and make sure that no errors or warnings are reported 5821c609719bSwdenk for any of the boards. 5822c609719bSwdenk 5823c609719bSwdenk* Keep your modifications to the necessary minimum: A patch 5824c609719bSwdenk containing several unrelated changes or arbitrary reformats will be 5825c609719bSwdenk returned with a request to re-formatting / split it. 5826c609719bSwdenk 5827c609719bSwdenk* If you modify existing code, make sure that your new code does not 5828c609719bSwdenk add to the memory footprint of the code ;-) Small is beautiful! 5829c609719bSwdenk When adding new features, these should compile conditionally only 5830c609719bSwdenk (using #ifdef), and the resulting code with the new feature 5831c609719bSwdenk disabled must not need more memory than the old code without your 5832c609719bSwdenk modification. 583390dc6704Swdenk 58340668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the 58350668236bSWolfgang Denk u-boot mailing list. Bigger patches will be moderated. If they are 58360668236bSWolfgang Denk reasonable and not too big, they will be acknowledged. But patches 58370668236bSWolfgang Denk bigger than the size limit should be avoided. 5838