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 /mpc8220 Files specific to Freescale MPC8220 CPUs 2058d321b81SPeter Tyser /mpc824x Files specific to Freescale MPC824x CPUs 2068d321b81SPeter Tyser /mpc8260 Files specific to Freescale MPC8260 CPUs 2078d321b81SPeter Tyser /mpc85xx Files specific to Freescale MPC85xx CPUs 2088d321b81SPeter Tyser /ppc4xx Files specific to AMCC PowerPC 4xx CPUs 2098d321b81SPeter Tyser /lib Architecture specific library files 2108d321b81SPeter Tyser /sh Files generic to SH architecture 2118d321b81SPeter Tyser /cpu CPU specific files 2128d321b81SPeter Tyser /sh2 Files specific to sh2 CPUs 2138d321b81SPeter Tyser /sh3 Files specific to sh3 CPUs 2148d321b81SPeter Tyser /sh4 Files specific to sh4 CPUs 2158d321b81SPeter Tyser /lib Architecture specific library files 2168d321b81SPeter Tyser /sparc Files generic to SPARC architecture 2178d321b81SPeter Tyser /cpu CPU specific files 2188d321b81SPeter Tyser /leon2 Files specific to Gaisler LEON2 SPARC CPU 2198d321b81SPeter Tyser /leon3 Files specific to Gaisler LEON3 SPARC CPU 2208d321b81SPeter Tyser /lib Architecture specific library files 2218d321b81SPeter Tyser/api Machine/arch independent API for external apps 2228d321b81SPeter Tyser/board Board dependent files 2238d321b81SPeter Tyser/common Misc architecture independent functions 2248d321b81SPeter Tyser/disk Code for disk drive partition handling 2258d321b81SPeter Tyser/doc Documentation (don't expect too much) 2268d321b81SPeter Tyser/drivers Commonly used device drivers 2278d321b81SPeter Tyser/examples Example code for standalone applications, etc. 2288d321b81SPeter Tyser/fs Filesystem code (cramfs, ext2, jffs2, etc.) 2298d321b81SPeter Tyser/include Header Files 2308d321b81SPeter Tyser/lib Files generic to all architectures 2318d321b81SPeter Tyser /libfdt Library files to support flattened device trees 2328d321b81SPeter Tyser /lzma Library files to support LZMA decompression 2338d321b81SPeter Tyser /lzo Library files to support LZO decompression 2348d321b81SPeter Tyser/net Networking code 2358d321b81SPeter Tyser/post Power On Self Test 2368d321b81SPeter Tyser/rtc Real Time Clock drivers 2378d321b81SPeter Tyser/tools Tools to build S-Record or U-Boot images, etc. 238c609719bSwdenk 239c609719bSwdenkSoftware Configuration: 240c609719bSwdenk======================= 241c609719bSwdenk 242c609719bSwdenkConfiguration is usually done using C preprocessor defines; the 243c609719bSwdenkrationale behind that is to avoid dead code whenever possible. 244c609719bSwdenk 245c609719bSwdenkThere are two classes of configuration variables: 246c609719bSwdenk 247c609719bSwdenk* Configuration _OPTIONS_: 248c609719bSwdenk These are selectable by the user and have names beginning with 249c609719bSwdenk "CONFIG_". 250c609719bSwdenk 251c609719bSwdenk* Configuration _SETTINGS_: 252c609719bSwdenk These depend on the hardware etc. and should not be meddled with if 253c609719bSwdenk you don't know what you're doing; they have names beginning with 2546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD "CONFIG_SYS_". 255c609719bSwdenk 256c609719bSwdenkLater we will add a configuration tool - probably similar to or even 257c609719bSwdenkidentical to what's used for the Linux kernel. Right now, we have to 258c609719bSwdenkdo the configuration by hand, which means creating some symbolic 259c609719bSwdenklinks and editing some configuration files. We use the TQM8xxL boards 260c609719bSwdenkas an example here. 261c609719bSwdenk 262c609719bSwdenk 263c609719bSwdenkSelection of Processor Architecture and Board Type: 264c609719bSwdenk--------------------------------------------------- 265c609719bSwdenk 266c609719bSwdenkFor all supported boards there are ready-to-use default 267c609719bSwdenkconfigurations available; just type "make <board_name>_config". 268c609719bSwdenk 269c609719bSwdenkExample: For a TQM823L module type: 270c609719bSwdenk 271c609719bSwdenk cd u-boot 272c609719bSwdenk make TQM823L_config 273c609719bSwdenk 27411ccc33fSMarcel ZiswilerFor the Cogent platform, you need to specify the CPU type as well; 275c609719bSwdenke.g. "make cogent_mpc8xx_config". And also configure the cogent 276c609719bSwdenkdirectory according to the instructions in cogent/README. 277c609719bSwdenk 278c609719bSwdenk 279c609719bSwdenkConfiguration Options: 280c609719bSwdenk---------------------- 281c609719bSwdenk 282c609719bSwdenkConfiguration depends on the combination of board and CPU type; all 283c609719bSwdenksuch information is kept in a configuration file 284c609719bSwdenk"include/configs/<board_name>.h". 285c609719bSwdenk 286c609719bSwdenkExample: For a TQM823L module, all configuration settings are in 287c609719bSwdenk"include/configs/TQM823L.h". 288c609719bSwdenk 289c609719bSwdenk 2907f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux 2917f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to 2927f6c2cbcSwdenkbuild a config tool - later. 2937f6c2cbcSwdenk 2947f6c2cbcSwdenk 295c609719bSwdenkThe following options need to be configured: 296c609719bSwdenk 2972628114eSKim Phillips- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX. 298c609719bSwdenk 2992628114eSKim Phillips- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS. 3006ccec449SWolfgang Denk 3016ccec449SWolfgang Denk- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined) 30209ea0de0SHaavard Skinnemoen Define exactly one, e.g. CONFIG_ATSTK1002 303c609719bSwdenk 304c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined) 305c609719bSwdenk Define exactly one of 306c609719bSwdenk CONFIG_CMA286_60_OLD 307c609719bSwdenk--- FIXME --- not tested yet: 308c609719bSwdenk CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P, 309c609719bSwdenk CONFIG_CMA287_23, CONFIG_CMA287_50 310c609719bSwdenk 311c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined) 312c609719bSwdenk Define exactly one of 313c609719bSwdenk CONFIG_CMA101, CONFIG_CMA102 314c609719bSwdenk 315c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined) 316c609719bSwdenk Define one or more of 317c609719bSwdenk CONFIG_CMA302 318c609719bSwdenk 319c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined) 320c609719bSwdenk Define one or more of 321c609719bSwdenk CONFIG_LCD_HEARTBEAT - update a character position on 32211ccc33fSMarcel Ziswiler the LCD display every second with 323c609719bSwdenk a "rotator" |\-/|\-/ 324c609719bSwdenk 3252535d602Swdenk- Board flavour: (if CONFIG_MPC8260ADS is defined) 3262535d602Swdenk CONFIG_ADSTYPE 3272535d602Swdenk Possible values are: 3286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8260ADS - original MPC8260ADS 3296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8266ADS - MPC8266ADS 3306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR 3316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8272ADS - MPC8272ADS 3322535d602Swdenk 333cf946c6dSLei Wen- Marvell Family Member 334cf946c6dSLei Wen CONFIG_SYS_MVFS - define it if you want to enable 335cf946c6dSLei Wen multiple fs option at one time 336cf946c6dSLei Wen for marvell soc family 337cf946c6dSLei Wen 338c609719bSwdenk- MPC824X Family Member (if CONFIG_MPC824X is defined) 339c609719bSwdenk Define exactly one of 340c609719bSwdenk CONFIG_MPC8240, CONFIG_MPC8245 341c609719bSwdenk 34211ccc33fSMarcel Ziswiler- 8xx CPU Options: (if using an MPC8xx CPU) 34366ca92a5Swdenk CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if 34466ca92a5Swdenk get_gclk_freq() cannot work 3455da627a4Swdenk e.g. if there is no 32KHz 3465da627a4Swdenk reference PIT/RTC clock 34766ca92a5Swdenk CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK 34866ca92a5Swdenk or XTAL/EXTAL) 349c609719bSwdenk 35066ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU): 3516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8xx_CPUCLK_MIN 3526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8xx_CPUCLK_MAX 35366ca92a5Swdenk CONFIG_8xx_CPUCLK_DEFAULT 35475d1ea7fSwdenk See doc/README.MPC866 35575d1ea7fSwdenk 3566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MEASURE_CPUCLK 35775d1ea7fSwdenk 35875d1ea7fSwdenk Define this to measure the actual CPU clock instead 35975d1ea7fSwdenk of relying on the correctness of the configured 36075d1ea7fSwdenk values. Mostly useful for board bringup to make sure 36175d1ea7fSwdenk the PLL is locked at the intended frequency. Note 36275d1ea7fSwdenk that this requires a (stable) reference clock (32 kHz 3636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD RTC clock or CONFIG_SYS_8XX_XIN) 36475d1ea7fSwdenk 365506f3918SHeiko Schocher CONFIG_SYS_DELAYED_ICACHE 366506f3918SHeiko Schocher 367506f3918SHeiko Schocher Define this option if you want to enable the 368506f3918SHeiko Schocher ICache only when Code runs from RAM. 369506f3918SHeiko Schocher 37066412c63SKumar Gala- 85xx CPU Options: 371ffd06e02SYork Sun CONFIG_SYS_PPC64 372ffd06e02SYork Sun 373ffd06e02SYork Sun Specifies that the core is a 64-bit PowerPC implementation (implements 374ffd06e02SYork Sun the "64" category of the Power ISA). This is necessary for ePAPR 375ffd06e02SYork Sun compliance, among other possible reasons. 376ffd06e02SYork Sun 37766412c63SKumar Gala CONFIG_SYS_FSL_TBCLK_DIV 37866412c63SKumar Gala 37966412c63SKumar Gala Defines the core time base clock divider ratio compared to the 38066412c63SKumar Gala system clock. On most PQ3 devices this is 8, on newer QorIQ 38166412c63SKumar Gala devices it can be 16 or 32. The ratio varies from SoC to Soc. 38266412c63SKumar Gala 3838f29084aSKumar Gala CONFIG_SYS_FSL_PCIE_COMPAT 3848f29084aSKumar Gala 3858f29084aSKumar Gala Defines the string to utilize when trying to match PCIe device 3868f29084aSKumar Gala tree nodes for the given platform. 3878f29084aSKumar Gala 388afa6b551SPrabhakar Kushwaha CONFIG_SYS_PPC_E500_DEBUG_TLB 389afa6b551SPrabhakar Kushwaha 390afa6b551SPrabhakar Kushwaha Enables a temporary TLB entry to be used during boot to work 391afa6b551SPrabhakar Kushwaha around limitations in e500v1 and e500v2 external debugger 392afa6b551SPrabhakar Kushwaha support. This reduces the portions of the boot code where 393afa6b551SPrabhakar Kushwaha breakpoints and single stepping do not work. The value of this 394afa6b551SPrabhakar Kushwaha symbol should be set to the TLB1 entry to be used for this 395afa6b551SPrabhakar Kushwaha purpose. 396afa6b551SPrabhakar Kushwaha 39733eee330SScott Wood CONFIG_SYS_FSL_ERRATUM_A004510 39833eee330SScott Wood 39933eee330SScott Wood Enables a workaround for erratum A004510. If set, 40033eee330SScott Wood then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and 40133eee330SScott Wood CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set. 40233eee330SScott Wood 40333eee330SScott Wood CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV 40433eee330SScott Wood CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional) 40533eee330SScott Wood 40633eee330SScott Wood Defines one or two SoC revisions (low 8 bits of SVR) 40733eee330SScott Wood for which the A004510 workaround should be applied. 40833eee330SScott Wood 40933eee330SScott Wood The rest of SVR is either not relevant to the decision 41033eee330SScott Wood of whether the erratum is present (e.g. p2040 versus 41133eee330SScott Wood p2041) or is implied by the build target, which controls 41233eee330SScott Wood whether CONFIG_SYS_FSL_ERRATUM_A004510 is set. 41333eee330SScott Wood 41433eee330SScott Wood See Freescale App Note 4493 for more information about 41533eee330SScott Wood this erratum. 41633eee330SScott Wood 41733eee330SScott Wood CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY 41833eee330SScott Wood 41933eee330SScott Wood This is the value to write into CCSR offset 0x18600 42033eee330SScott Wood according to the A004510 workaround. 42133eee330SScott Wood 4226cb461b4SDaniel Schwierzeck- Generic CPU options: 4236cb461b4SDaniel Schwierzeck CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN 4246cb461b4SDaniel Schwierzeck 4256cb461b4SDaniel Schwierzeck Defines the endianess of the CPU. Implementation of those 4266cb461b4SDaniel Schwierzeck values is arch specific. 4276cb461b4SDaniel Schwierzeck 4280b953ffcSMarkus Klotzbuecher- Intel Monahans options: 4296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO 4300b953ffcSMarkus Klotzbuecher 4310b953ffcSMarkus Klotzbuecher Defines the Monahans run mode to oscillator 4320b953ffcSMarkus Klotzbuecher ratio. Valid values are 8, 16, 24, 31. The core 4330b953ffcSMarkus Klotzbuecher frequency is this value multiplied by 13 MHz. 4340b953ffcSMarkus Klotzbuecher 4356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO 4360b953ffcSMarkus Klotzbuecher 4370b953ffcSMarkus Klotzbuecher Defines the Monahans turbo mode to oscillator 4380b953ffcSMarkus Klotzbuecher ratio. Valid values are 1 (default if undefined) and 4390b953ffcSMarkus Klotzbuecher 2. The core frequency as calculated above is multiplied 4400b953ffcSMarkus Klotzbuecher by this value. 4410b953ffcSMarkus Klotzbuecher 44292bbd64eSDaniel Schwierzeck- MIPS CPU options: 44392bbd64eSDaniel Schwierzeck CONFIG_SYS_INIT_SP_OFFSET 44492bbd64eSDaniel Schwierzeck 44592bbd64eSDaniel Schwierzeck Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack 44692bbd64eSDaniel Schwierzeck pointer. This is needed for the temporary stack before 44792bbd64eSDaniel Schwierzeck relocation. 44892bbd64eSDaniel Schwierzeck 44992bbd64eSDaniel Schwierzeck CONFIG_SYS_MIPS_CACHE_MODE 45092bbd64eSDaniel Schwierzeck 45192bbd64eSDaniel Schwierzeck Cache operation mode for the MIPS CPU. 45292bbd64eSDaniel Schwierzeck See also arch/mips/include/asm/mipsregs.h. 45392bbd64eSDaniel Schwierzeck Possible values are: 45492bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_NO_WA 45592bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_WA 45692bbd64eSDaniel Schwierzeck CONF_CM_UNCACHED 45792bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_NONCOHERENT 45892bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_CE 45992bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_COW 46092bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_CUW 46192bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_ACCELERATED 46292bbd64eSDaniel Schwierzeck 46392bbd64eSDaniel Schwierzeck CONFIG_SYS_XWAY_EBU_BOOTCFG 46492bbd64eSDaniel Schwierzeck 46592bbd64eSDaniel Schwierzeck Special option for Lantiq XWAY SoCs for booting from NOR flash. 46692bbd64eSDaniel Schwierzeck See also arch/mips/cpu/mips32/start.S. 46792bbd64eSDaniel Schwierzeck 46892bbd64eSDaniel Schwierzeck CONFIG_XWAY_SWAP_BYTES 46992bbd64eSDaniel Schwierzeck 47092bbd64eSDaniel Schwierzeck Enable compilation of tools/xway-swap-bytes needed for Lantiq 47192bbd64eSDaniel Schwierzeck XWAY SoCs for booting from NOR flash. The U-Boot image needs to 47292bbd64eSDaniel Schwierzeck be swapped if a flash programmer is used. 47392bbd64eSDaniel Schwierzeck 474b67d8816SChristian Riesch- ARM options: 475b67d8816SChristian Riesch CONFIG_SYS_EXCEPTION_VECTORS_HIGH 476b67d8816SChristian Riesch 477b67d8816SChristian Riesch Select high exception vectors of the ARM core, e.g., do not 478b67d8816SChristian Riesch clear the V bit of the c1 register of CP15. 479b67d8816SChristian Riesch 4805356f545SAneesh V CONFIG_SYS_THUMB_BUILD 4815356f545SAneesh V 4825356f545SAneesh V Use this flag to build U-Boot using the Thumb instruction 4835356f545SAneesh V set for ARM architectures. Thumb instruction set provides 4845356f545SAneesh V better code density. For ARM architectures that support 4855356f545SAneesh V Thumb2 this flag will result in Thumb2 code generated by 4865356f545SAneesh V GCC. 4875356f545SAneesh V 4885da627a4Swdenk- Linux Kernel Interface: 489c609719bSwdenk CONFIG_CLOCKS_IN_MHZ 490c609719bSwdenk 491c609719bSwdenk U-Boot stores all clock information in Hz 492c609719bSwdenk internally. For binary compatibility with older Linux 493c609719bSwdenk kernels (which expect the clocks passed in the 494c609719bSwdenk bd_info data to be in MHz) the environment variable 495c609719bSwdenk "clocks_in_mhz" can be defined so that U-Boot 496c609719bSwdenk converts clock data to MHZ before passing it to the 497c609719bSwdenk Linux kernel. 498c609719bSwdenk When CONFIG_CLOCKS_IN_MHZ is defined, a definition of 499c609719bSwdenk "clocks_in_mhz=1" is automatically included in the 500c609719bSwdenk default environment. 501c609719bSwdenk 5025da627a4Swdenk CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only] 5035da627a4Swdenk 50411ccc33fSMarcel Ziswiler When transferring memsize parameter to linux, some versions 5055da627a4Swdenk expect it to be in bytes, others in MB. 5065da627a4Swdenk Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes. 5075da627a4Swdenk 508fec6d9eeSGerald Van Baren CONFIG_OF_LIBFDT 509f57f70aaSWolfgang Denk 510f57f70aaSWolfgang Denk New kernel versions are expecting firmware settings to be 511213bf8c8SGerald Van Baren passed using flattened device trees (based on open firmware 512213bf8c8SGerald Van Baren concepts). 513213bf8c8SGerald Van Baren 514213bf8c8SGerald Van Baren CONFIG_OF_LIBFDT 515213bf8c8SGerald Van Baren * New libfdt-based support 516213bf8c8SGerald Van Baren * Adds the "fdt" command 5173bb342fcSKim Phillips * The bootm command automatically updates the fdt 518213bf8c8SGerald Van Baren 519b55ae402SMarcel Ziswiler OF_CPU - The proper name of the cpus node (only required for 520b55ae402SMarcel Ziswiler MPC512X and MPC5xxx based boards). 521b55ae402SMarcel Ziswiler OF_SOC - The proper name of the soc node (only required for 522b55ae402SMarcel Ziswiler MPC512X and MPC5xxx based boards). 523f57f70aaSWolfgang Denk OF_TBCLK - The timebase frequency. 524c2871f03SKumar Gala OF_STDOUT_PATH - The path to the console device 525f57f70aaSWolfgang Denk 52611ccc33fSMarcel Ziswiler boards with QUICC Engines require OF_QE to set UCC MAC 52711ccc33fSMarcel Ziswiler addresses 5283bb342fcSKim Phillips 5294e253137SKumar Gala CONFIG_OF_BOARD_SETUP 5304e253137SKumar Gala 5314e253137SKumar Gala Board code has addition modification that it wants to make 5324e253137SKumar Gala to the flat device tree before handing it off to the kernel 5336705d81eSwdenk 5340267768eSMatthew McClintock CONFIG_OF_BOOT_CPU 5350267768eSMatthew McClintock 53611ccc33fSMarcel Ziswiler This define fills in the correct boot CPU in the boot 5370267768eSMatthew McClintock param header, the default value is zero if undefined. 5380267768eSMatthew McClintock 5393887c3fbSHeiko Schocher CONFIG_OF_IDE_FIXUP 5403887c3fbSHeiko Schocher 5413887c3fbSHeiko Schocher U-Boot can detect if an IDE device is present or not. 5423887c3fbSHeiko Schocher If not, and this new config option is activated, U-Boot 5433887c3fbSHeiko Schocher removes the ATA node from the DTS before booting Linux, 5443887c3fbSHeiko Schocher so the Linux IDE driver does not probe the device and 5453887c3fbSHeiko Schocher crash. This is needed for buggy hardware (uc101) where 5463887c3fbSHeiko Schocher no pull down resistor is connected to the signal IDE5V_DD7. 5473887c3fbSHeiko Schocher 5487eb29398SIgor Grinberg CONFIG_MACH_TYPE [relevant for ARM only][mandatory] 5497eb29398SIgor Grinberg 5507eb29398SIgor Grinberg This setting is mandatory for all boards that have only one 5517eb29398SIgor Grinberg machine type and must be used to specify the machine type 5527eb29398SIgor Grinberg number as it appears in the ARM machine registry 5537eb29398SIgor Grinberg (see http://www.arm.linux.org.uk/developer/machines/). 5547eb29398SIgor Grinberg Only boards that have multiple machine types supported 5557eb29398SIgor Grinberg in a single configuration file and the machine type is 5567eb29398SIgor Grinberg runtime discoverable, do not have to use this setting. 5577eb29398SIgor Grinberg 5580b2f4ecaSNiklaus Giger- vxWorks boot parameters: 5590b2f4ecaSNiklaus Giger 5600b2f4ecaSNiklaus Giger bootvx constructs a valid bootline using the following 5610b2f4ecaSNiklaus Giger environments variables: bootfile, ipaddr, serverip, hostname. 5620b2f4ecaSNiklaus Giger It loads the vxWorks image pointed bootfile. 5630b2f4ecaSNiklaus Giger 5640b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name 5650b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address 5660b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server 5670b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters 5680b2f4ecaSNiklaus Giger 5690b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_ADD_PARAMS 5700b2f4ecaSNiklaus Giger 5710b2f4ecaSNiklaus Giger Add it at the end of the bootline. E.g "u=username pw=secret" 5720b2f4ecaSNiklaus Giger 5730b2f4ecaSNiklaus Giger Note: If a "bootargs" environment is defined, it will overwride 5740b2f4ecaSNiklaus Giger the defaults discussed just above. 5750b2f4ecaSNiklaus Giger 5762c451f78SAneesh V- Cache Configuration: 5772c451f78SAneesh V CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot 5782c451f78SAneesh V CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot 5792c451f78SAneesh V CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot 5802c451f78SAneesh V 58193bc2193SAneesh V- Cache Configuration for ARM: 58293bc2193SAneesh V CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache 58393bc2193SAneesh V controller 58493bc2193SAneesh V CONFIG_SYS_PL310_BASE - Physical base address of PL310 58593bc2193SAneesh V controller register space 58693bc2193SAneesh V 5876705d81eSwdenk- Serial Ports: 58848d0192fSAndreas Engel CONFIG_PL010_SERIAL 5896705d81eSwdenk 5906705d81eSwdenk Define this if you want support for Amba PrimeCell PL010 UARTs. 5916705d81eSwdenk 59248d0192fSAndreas Engel CONFIG_PL011_SERIAL 5936705d81eSwdenk 5946705d81eSwdenk Define this if you want support for Amba PrimeCell PL011 UARTs. 5956705d81eSwdenk 5966705d81eSwdenk CONFIG_PL011_CLOCK 5976705d81eSwdenk 5986705d81eSwdenk If you have Amba PrimeCell PL011 UARTs, set this variable to 5996705d81eSwdenk the clock speed of the UARTs. 6006705d81eSwdenk 6016705d81eSwdenk CONFIG_PL01x_PORTS 6026705d81eSwdenk 6036705d81eSwdenk If you have Amba PrimeCell PL010 or PL011 UARTs on your board, 6046705d81eSwdenk define this to a list of base addresses for each (supported) 6056705d81eSwdenk port. See e.g. include/configs/versatile.h 6066705d81eSwdenk 607910f1ae3SJohn Rigby CONFIG_PL011_SERIAL_RLCR 608910f1ae3SJohn Rigby 609910f1ae3SJohn Rigby Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500) 610910f1ae3SJohn Rigby have separate receive and transmit line control registers. Set 611910f1ae3SJohn Rigby this variable to initialize the extra register. 612910f1ae3SJohn Rigby 613910f1ae3SJohn Rigby CONFIG_PL011_SERIAL_FLUSH_ON_INIT 614910f1ae3SJohn Rigby 615910f1ae3SJohn Rigby On some platforms (e.g. U8500) U-Boot is loaded by a second stage 616910f1ae3SJohn Rigby boot loader that has already initialized the UART. Define this 617910f1ae3SJohn Rigby variable to flush the UART at init time. 618910f1ae3SJohn Rigby 6196705d81eSwdenk 620c609719bSwdenk- Console Interface: 621c609719bSwdenk Depending on board, define exactly one serial port 622c609719bSwdenk (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2, 623c609719bSwdenk CONFIG_8xx_CONS_SCC1, ...), or switch off the serial 624c609719bSwdenk console by defining CONFIG_8xx_CONS_NONE 625c609719bSwdenk 626c609719bSwdenk Note: if CONFIG_8xx_CONS_NONE is defined, the serial 627c609719bSwdenk port routines must be defined elsewhere 628c609719bSwdenk (i.e. serial_init(), serial_getc(), ...) 629c609719bSwdenk 630c609719bSwdenk CONFIG_CFB_CONSOLE 631c609719bSwdenk Enables console device for a color framebuffer. Needs following 632c53043b7SWolfgang Denk defines (cf. smiLynxEM, i8042) 633c609719bSwdenk VIDEO_FB_LITTLE_ENDIAN graphic memory organisation 634c609719bSwdenk (default big endian) 635c609719bSwdenk VIDEO_HW_RECTFILL graphic chip supports 636c609719bSwdenk rectangle fill 637c609719bSwdenk (cf. smiLynxEM) 638c609719bSwdenk VIDEO_HW_BITBLT graphic chip supports 639c609719bSwdenk bit-blit (cf. smiLynxEM) 640c609719bSwdenk VIDEO_VISIBLE_COLS visible pixel columns 641c609719bSwdenk (cols=pitch) 642c609719bSwdenk VIDEO_VISIBLE_ROWS visible pixel rows 643c609719bSwdenk VIDEO_PIXEL_SIZE bytes per pixel 644c609719bSwdenk VIDEO_DATA_FORMAT graphic data format 645c609719bSwdenk (0-5, cf. cfb_console.c) 646c609719bSwdenk VIDEO_FB_ADRS framebuffer address 647c609719bSwdenk VIDEO_KBD_INIT_FCT keyboard int fct 648c609719bSwdenk (i.e. i8042_kbd_init()) 649c609719bSwdenk VIDEO_TSTC_FCT test char fct 650c609719bSwdenk (i.e. i8042_tstc) 651c609719bSwdenk VIDEO_GETC_FCT get char fct 652c609719bSwdenk (i.e. i8042_getc) 653c609719bSwdenk CONFIG_CONSOLE_CURSOR cursor drawing on/off 654c609719bSwdenk (requires blink timer 655c609719bSwdenk cf. i8042.c) 6566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c) 657c609719bSwdenk CONFIG_CONSOLE_TIME display time/date info in 658c609719bSwdenk upper right corner 659602ad3b3SJon Loeliger (requires CONFIG_CMD_DATE) 660c609719bSwdenk CONFIG_VIDEO_LOGO display Linux logo in 661c609719bSwdenk upper left corner 662a6c7ad2fSwdenk CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of 663a6c7ad2fSwdenk linux_logo.h for logo. 664a6c7ad2fSwdenk Requires CONFIG_VIDEO_LOGO 665c609719bSwdenk CONFIG_CONSOLE_EXTRA_INFO 66611ccc33fSMarcel Ziswiler additional board info beside 667c609719bSwdenk the logo 668c609719bSwdenk 66933a35bbbSPali Rohár When CONFIG_CFB_CONSOLE_ANSI is defined, console will support 67033a35bbbSPali Rohár a limited number of ANSI escape sequences (cursor control, 67133a35bbbSPali Rohár erase functions and limited graphics rendition control). 67233a35bbbSPali Rohár 673c609719bSwdenk When CONFIG_CFB_CONSOLE is defined, video console is 674c609719bSwdenk default i/o. Serial console can be forced with 675c609719bSwdenk environment 'console=serial'. 676c609719bSwdenk 677a3ad8e26Swdenk When CONFIG_SILENT_CONSOLE is defined, all console 678a3ad8e26Swdenk messages (by U-Boot and Linux!) can be silenced with 679a3ad8e26Swdenk the "silent" environment variable. See 680a3ad8e26Swdenk doc/README.silent for more information. 681a3ad8e26Swdenk 682c609719bSwdenk- Console Baudrate: 683c609719bSwdenk CONFIG_BAUDRATE - in bps 684c609719bSwdenk Select one of the baudrates listed in 6856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BAUDRATE_TABLE, see below. 6866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale 687c609719bSwdenk 688c92fac91SHeiko Schocher- Console Rx buffer length 689c92fac91SHeiko Schocher With CONFIG_SYS_SMC_RXBUFLEN it is possible to define 690c92fac91SHeiko Schocher the maximum receive buffer length for the SMC. 6912b3f12c2SHeiko Schocher This option is actual only for 82xx and 8xx possible. 692c92fac91SHeiko Schocher If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE 693c92fac91SHeiko Schocher must be defined, to setup the maximum idle timeout for 694c92fac91SHeiko Schocher the SMC. 695c92fac91SHeiko Schocher 6969558b48aSGraeme Russ- Pre-Console Buffer: 6979558b48aSGraeme Russ Prior to the console being initialised (i.e. serial UART 6989558b48aSGraeme Russ initialised etc) all console output is silently discarded. 6999558b48aSGraeme Russ Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to 7009558b48aSGraeme Russ buffer any console messages prior to the console being 7019558b48aSGraeme Russ initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ 7029558b48aSGraeme Russ bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is 7039558b48aSGraeme Russ a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ 7049558b48aSGraeme Russ bytes are output before the console is initialised, the 7059558b48aSGraeme Russ earlier bytes are discarded. 7069558b48aSGraeme Russ 7079558b48aSGraeme Russ 'Sane' compilers will generate smaller code if 7089558b48aSGraeme Russ CONFIG_PRE_CON_BUF_SZ is a power of 2 7099558b48aSGraeme Russ 710046a37bdSSonny Rao- Safe printf() functions 711046a37bdSSonny Rao Define CONFIG_SYS_VSNPRINTF to compile in safe versions of 712046a37bdSSonny Rao the printf() functions. These are defined in 713046a37bdSSonny Rao include/vsprintf.h and include snprintf(), vsnprintf() and 714046a37bdSSonny Rao so on. Code size increase is approximately 300-500 bytes. 715046a37bdSSonny Rao If this option is not given then these functions will 716046a37bdSSonny Rao silently discard their buffer size argument - this means 717046a37bdSSonny Rao you are not getting any overflow checking in this case. 718046a37bdSSonny Rao 719c609719bSwdenk- Boot Delay: CONFIG_BOOTDELAY - in seconds 720c609719bSwdenk Delay before automatically booting the default image; 721c609719bSwdenk set to -1 to disable autoboot. 72293d7212fSJoe Hershberger set to -2 to autoboot with no delay and not check for abort 72393d7212fSJoe Hershberger (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined). 724c609719bSwdenk 725c609719bSwdenk See doc/README.autoboot for these options that 726c609719bSwdenk work with CONFIG_BOOTDELAY. None are required. 727c609719bSwdenk CONFIG_BOOT_RETRY_TIME 728c609719bSwdenk CONFIG_BOOT_RETRY_MIN 729c609719bSwdenk CONFIG_AUTOBOOT_KEYED 730c609719bSwdenk CONFIG_AUTOBOOT_PROMPT 731c609719bSwdenk CONFIG_AUTOBOOT_DELAY_STR 732c609719bSwdenk CONFIG_AUTOBOOT_STOP_STR 733c609719bSwdenk CONFIG_AUTOBOOT_DELAY_STR2 734c609719bSwdenk CONFIG_AUTOBOOT_STOP_STR2 735c609719bSwdenk CONFIG_ZERO_BOOTDELAY_CHECK 736c609719bSwdenk CONFIG_RESET_TO_RETRY 737c609719bSwdenk 738c609719bSwdenk- Autoboot Command: 739c609719bSwdenk CONFIG_BOOTCOMMAND 740c609719bSwdenk Only needed when CONFIG_BOOTDELAY is enabled; 741c609719bSwdenk define a command string that is automatically executed 742c609719bSwdenk when no character is read on the console interface 743c609719bSwdenk within "Boot Delay" after reset. 744c609719bSwdenk 745c609719bSwdenk CONFIG_BOOTARGS 746c609719bSwdenk This can be used to pass arguments to the bootm 747c609719bSwdenk command. The value of CONFIG_BOOTARGS goes into the 748c609719bSwdenk environment value "bootargs". 749c609719bSwdenk 750c609719bSwdenk CONFIG_RAMBOOT and CONFIG_NFSBOOT 751c609719bSwdenk The value of these goes into the environment as 752c609719bSwdenk "ramboot" and "nfsboot" respectively, and can be used 753c609719bSwdenk as a convenience, when switching between booting from 75411ccc33fSMarcel Ziswiler RAM and NFS. 755c609719bSwdenk 756c609719bSwdenk- Pre-Boot Commands: 757c609719bSwdenk CONFIG_PREBOOT 758c609719bSwdenk 759c609719bSwdenk When this option is #defined, the existence of the 760c609719bSwdenk environment variable "preboot" will be checked 761c609719bSwdenk immediately before starting the CONFIG_BOOTDELAY 762c609719bSwdenk countdown and/or running the auto-boot command resp. 763c609719bSwdenk entering interactive mode. 764c609719bSwdenk 765c609719bSwdenk This feature is especially useful when "preboot" is 766c609719bSwdenk automatically generated or modified. For an example 767c609719bSwdenk see the LWMON board specific code: here "preboot" is 768c609719bSwdenk modified when the user holds down a certain 769c609719bSwdenk combination of keys on the (special) keyboard when 770c609719bSwdenk booting the systems 771c609719bSwdenk 772c609719bSwdenk- Serial Download Echo Mode: 773c609719bSwdenk CONFIG_LOADS_ECHO 774c609719bSwdenk If defined to 1, all characters received during a 775c609719bSwdenk serial download (using the "loads" command) are 776c609719bSwdenk echoed back. This might be needed by some terminal 777c609719bSwdenk emulations (like "cu"), but may as well just take 778c609719bSwdenk time on others. This setting #define's the initial 779c609719bSwdenk value of the "loads_echo" environment variable. 780c609719bSwdenk 781602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined) 782c609719bSwdenk CONFIG_KGDB_BAUDRATE 783c609719bSwdenk Select one of the baudrates listed in 7846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BAUDRATE_TABLE, see below. 785c609719bSwdenk 786c609719bSwdenk- Monitor Functions: 787602ad3b3SJon Loeliger Monitor commands can be included or excluded 788602ad3b3SJon Loeliger from the build by using the #include files 789c6c621bdSStephen Warren <config_cmd_all.h> and #undef'ing unwanted 790c6c621bdSStephen Warren commands, or using <config_cmd_default.h> 791602ad3b3SJon Loeliger and augmenting with additional #define's 792602ad3b3SJon Loeliger for wanted commands. 793c609719bSwdenk 794602ad3b3SJon Loeliger The default command configuration includes all commands 795602ad3b3SJon Loeliger except those marked below with a "*". 796602ad3b3SJon Loeliger 797602ad3b3SJon Loeliger CONFIG_CMD_ASKENV * ask for env variable 798602ad3b3SJon Loeliger CONFIG_CMD_BDI bdinfo 799602ad3b3SJon Loeliger CONFIG_CMD_BEDBUG * Include BedBug Debugger 800602ad3b3SJon Loeliger CONFIG_CMD_BMP * BMP support 801602ad3b3SJon Loeliger CONFIG_CMD_BSP * Board specific commands 802602ad3b3SJon Loeliger CONFIG_CMD_BOOTD bootd 803602ad3b3SJon Loeliger CONFIG_CMD_CACHE * icache, dcache 804602ad3b3SJon Loeliger CONFIG_CMD_CONSOLE coninfo 805710b9938SMike Frysinger CONFIG_CMD_CRC32 * crc32 806602ad3b3SJon Loeliger CONFIG_CMD_DATE * support for RTC, date/time... 807602ad3b3SJon Loeliger CONFIG_CMD_DHCP * DHCP support 808602ad3b3SJon Loeliger CONFIG_CMD_DIAG * Diagnostics 809a7c93104SPeter Tyser CONFIG_CMD_DS4510 * ds4510 I2C gpio commands 810a7c93104SPeter Tyser CONFIG_CMD_DS4510_INFO * ds4510 I2C info command 811a7c93104SPeter Tyser CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd 812a7c93104SPeter Tyser CONFIG_CMD_DS4510_RST * ds4510 I2C rst command 813602ad3b3SJon Loeliger CONFIG_CMD_DTT * Digital Therm and Thermostat 814602ad3b3SJon Loeliger CONFIG_CMD_ECHO echo arguments 815246c6922SPeter Tyser CONFIG_CMD_EDITENV edit env variable 816602ad3b3SJon Loeliger CONFIG_CMD_EEPROM * EEPROM read/write support 817602ad3b3SJon Loeliger CONFIG_CMD_ELF * bootelf, bootvx 818*5e2b3e0cSJoe Hershberger CONFIG_CMD_ENV_CALLBACK * display details about env callbacks 8190c79cda0SMike Frysinger CONFIG_CMD_EXPORTENV * export the environment 82003e2ecf6SStephen Warren CONFIG_CMD_EXT2 * ext2 command support 82103e2ecf6SStephen Warren CONFIG_CMD_EXT4 * ext4 command support 822bdab39d3SMike Frysinger CONFIG_CMD_SAVEENV saveenv 823602ad3b3SJon Loeliger CONFIG_CMD_FDC * Floppy Disk Support 82403e2ecf6SStephen Warren CONFIG_CMD_FAT * FAT command support 825602ad3b3SJon Loeliger CONFIG_CMD_FDOS * Dos diskette Support 826602ad3b3SJon Loeliger CONFIG_CMD_FLASH flinfo, erase, protect 827602ad3b3SJon Loeliger CONFIG_CMD_FPGA FPGA device initialization support 82853fdc7efSAnton Staaf CONFIG_CMD_GETTIME * Get time since boot 829a641b979SMike Frysinger CONFIG_CMD_GO * the 'go' command (exec code) 830a000b795SKim Phillips CONFIG_CMD_GREPENV * search environment 831bf36c5d5SSimon Glass CONFIG_CMD_HASH * calculate hash / digest 832602ad3b3SJon Loeliger CONFIG_CMD_HWFLOW * RTS/CTS hw flow control 833602ad3b3SJon Loeliger CONFIG_CMD_I2C * I2C serial bus support 834602ad3b3SJon Loeliger CONFIG_CMD_IDE * IDE harddisk support 835602ad3b3SJon Loeliger CONFIG_CMD_IMI iminfo 836602ad3b3SJon Loeliger CONFIG_CMD_IMLS List all found images 837602ad3b3SJon Loeliger CONFIG_CMD_IMMAP * IMMR dump support 8380c79cda0SMike Frysinger CONFIG_CMD_IMPORTENV * import an environment 839c167cc02SJoe Hershberger CONFIG_CMD_INI * import data from an ini file into the env 840602ad3b3SJon Loeliger CONFIG_CMD_IRQ * irqinfo 841602ad3b3SJon Loeliger CONFIG_CMD_ITEST Integer/string test of 2 values 842602ad3b3SJon Loeliger CONFIG_CMD_JFFS2 * JFFS2 Support 843602ad3b3SJon Loeliger CONFIG_CMD_KGDB * kgdb 8441ba7fd25SMike Frysinger CONFIG_CMD_LDRINFO ldrinfo (display Blackfin loader) 845d22c338eSJoe Hershberger CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration 846d22c338eSJoe Hershberger (169.254.*.*) 847602ad3b3SJon Loeliger CONFIG_CMD_LOADB loadb 848602ad3b3SJon Loeliger CONFIG_CMD_LOADS loads 84902c9aa1dSRobin Getz CONFIG_CMD_MD5SUM print md5 message digest 85002c9aa1dSRobin Getz (requires CONFIG_CMD_MEMORY and CONFIG_MD5) 851602ad3b3SJon Loeliger CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base, 85256523f12Swdenk loop, loopw, mtest 853602ad3b3SJon Loeliger CONFIG_CMD_MISC Misc functions like sleep etc 854602ad3b3SJon Loeliger CONFIG_CMD_MMC * MMC memory mapped support 855602ad3b3SJon Loeliger CONFIG_CMD_MII * MII utility commands 85668d7d651SStefan Roese CONFIG_CMD_MTDPARTS * MTD partition support 857602ad3b3SJon Loeliger CONFIG_CMD_NAND * NAND support 858602ad3b3SJon Loeliger CONFIG_CMD_NET bootp, tftpboot, rarpboot 859e92739d3SPeter Tyser CONFIG_CMD_PCA953X * PCA953x I2C gpio commands 860e92739d3SPeter Tyser CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command 861602ad3b3SJon Loeliger CONFIG_CMD_PCI * pciinfo 862602ad3b3SJon Loeliger CONFIG_CMD_PCMCIA * PCMCIA support 863602ad3b3SJon Loeliger CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network 864602ad3b3SJon Loeliger host 865602ad3b3SJon Loeliger CONFIG_CMD_PORTIO * Port I/O 866ff048ea9SKenneth Waters CONFIG_CMD_READ * Read raw data from partition 867602ad3b3SJon Loeliger CONFIG_CMD_REGINFO * Register dump 868602ad3b3SJon Loeliger CONFIG_CMD_RUN run command in env variable 869602ad3b3SJon Loeliger CONFIG_CMD_SAVES * save S record dump 870602ad3b3SJon Loeliger CONFIG_CMD_SCSI * SCSI Support 871602ad3b3SJon Loeliger CONFIG_CMD_SDRAM * print SDRAM configuration information 872602ad3b3SJon Loeliger (requires CONFIG_CMD_I2C) 873602ad3b3SJon Loeliger CONFIG_CMD_SETGETDCR Support for DCR Register access 874602ad3b3SJon Loeliger (4xx only) 875f61ec45eSEric Nelson CONFIG_CMD_SF * Read/write/erase SPI NOR flash 876c6b1ee66SAlexander Holler CONFIG_CMD_SHA1SUM print sha1 memory digest 87702c9aa1dSRobin Getz (requires CONFIG_CMD_MEMORY) 87874de7aefSWolfgang Denk CONFIG_CMD_SOURCE "source" command Support 879602ad3b3SJon Loeliger CONFIG_CMD_SPI * SPI serial bus support 8807a83af07SLuca Ceresoli CONFIG_CMD_TFTPSRV * TFTP transfer in server mode 8811fb7cd49SSimon Glass CONFIG_CMD_TFTPPUT * TFTP put command (upload) 882da83bcd7SJoe Hershberger CONFIG_CMD_TIME * run command and report execution time (ARM specific) 883da83bcd7SJoe Hershberger CONFIG_CMD_TIMER * access to the system tick timer 884602ad3b3SJon Loeliger CONFIG_CMD_USB * USB support 885602ad3b3SJon Loeliger CONFIG_CMD_CDP * Cisco Discover Protocol support 886c8339f51SMarek Vasut CONFIG_CMD_MFSL * Microblaze FSL support 887c609719bSwdenk 888c609719bSwdenk 889c609719bSwdenk EXAMPLE: If you want all functions except of network 890c609719bSwdenk support you can write: 891c609719bSwdenk 892602ad3b3SJon Loeliger #include "config_cmd_all.h" 893602ad3b3SJon Loeliger #undef CONFIG_CMD_NET 894c609719bSwdenk 895213bf8c8SGerald Van Baren Other Commands: 896213bf8c8SGerald Van Baren fdt (flattened device tree) command: CONFIG_OF_LIBFDT 897c609719bSwdenk 898c609719bSwdenk Note: Don't enable the "icache" and "dcache" commands 899602ad3b3SJon Loeliger (configuration option CONFIG_CMD_CACHE) unless you know 900c609719bSwdenk what you (and your U-Boot users) are doing. Data 901c609719bSwdenk cache cannot be enabled on systems like the 8xx or 902c609719bSwdenk 8260 (where accesses to the IMMR region must be 903c609719bSwdenk uncached), and it cannot be disabled on all other 904c609719bSwdenk systems where we (mis-) use the data cache to hold an 905c609719bSwdenk initial stack and some data. 906c609719bSwdenk 907c609719bSwdenk 908c609719bSwdenk XXX - this list needs to get updated! 909c609719bSwdenk 91045ba8077SSimon Glass- Device tree: 91145ba8077SSimon Glass CONFIG_OF_CONTROL 91245ba8077SSimon Glass If this variable is defined, U-Boot will use a device tree 91345ba8077SSimon Glass to configure its devices, instead of relying on statically 91445ba8077SSimon Glass compiled #defines in the board file. This option is 91545ba8077SSimon Glass experimental and only available on a few boards. The device 91645ba8077SSimon Glass tree is available in the global data as gd->fdt_blob. 91745ba8077SSimon Glass 9182c0f79e4SSimon Glass U-Boot needs to get its device tree from somewhere. This can 9192c0f79e4SSimon Glass be done using one of the two options below: 920bbb0b128SSimon Glass 921bbb0b128SSimon Glass CONFIG_OF_EMBED 922bbb0b128SSimon Glass If this variable is defined, U-Boot will embed a device tree 923bbb0b128SSimon Glass binary in its image. This device tree file should be in the 924bbb0b128SSimon Glass board directory and called <soc>-<board>.dts. The binary file 925bbb0b128SSimon Glass is then picked up in board_init_f() and made available through 926bbb0b128SSimon Glass the global data structure as gd->blob. 92745ba8077SSimon Glass 9282c0f79e4SSimon Glass CONFIG_OF_SEPARATE 9292c0f79e4SSimon Glass If this variable is defined, U-Boot will build a device tree 9302c0f79e4SSimon Glass binary. It will be called u-boot.dtb. Architecture-specific 9312c0f79e4SSimon Glass code will locate it at run-time. Generally this works by: 9322c0f79e4SSimon Glass 9332c0f79e4SSimon Glass cat u-boot.bin u-boot.dtb >image.bin 9342c0f79e4SSimon Glass 9352c0f79e4SSimon Glass and in fact, U-Boot does this for you, creating a file called 9362c0f79e4SSimon Glass u-boot-dtb.bin which is useful in the common case. You can 9372c0f79e4SSimon Glass still use the individual files if you need something more 9382c0f79e4SSimon Glass exotic. 9392c0f79e4SSimon Glass 940c609719bSwdenk- Watchdog: 941c609719bSwdenk CONFIG_WATCHDOG 942c609719bSwdenk If this variable is defined, it enables watchdog 9436abe6fb6SDetlev Zundel support for the SoC. There must be support in the SoC 9446abe6fb6SDetlev Zundel specific code for a watchdog. For the 8xx and 8260 9456abe6fb6SDetlev Zundel CPUs, the SIU Watchdog feature is enabled in the SYPCR 9466abe6fb6SDetlev Zundel register. When supported for a specific SoC is 9476abe6fb6SDetlev Zundel available, then no further board specific code should 9486abe6fb6SDetlev Zundel be needed to use it. 9496abe6fb6SDetlev Zundel 9506abe6fb6SDetlev Zundel CONFIG_HW_WATCHDOG 9516abe6fb6SDetlev Zundel When using a watchdog circuitry external to the used 9526abe6fb6SDetlev Zundel SoC, then define this variable and provide board 9536abe6fb6SDetlev Zundel specific code for the "hw_watchdog_reset" function. 954c609719bSwdenk 955c1551ea8Sstroese- U-Boot Version: 956c1551ea8Sstroese CONFIG_VERSION_VARIABLE 957c1551ea8Sstroese If this variable is defined, an environment variable 958c1551ea8Sstroese named "ver" is created by U-Boot showing the U-Boot 959c1551ea8Sstroese version as printed by the "version" command. 960a1ea8e51SBenoît Thébaudeau Any change to this variable will be reverted at the 961a1ea8e51SBenoît Thébaudeau next reset. 962c1551ea8Sstroese 963c609719bSwdenk- Real-Time Clock: 964c609719bSwdenk 965602ad3b3SJon Loeliger When CONFIG_CMD_DATE is selected, the type of the RTC 966c609719bSwdenk has to be selected, too. Define exactly one of the 967c609719bSwdenk following options: 968c609719bSwdenk 969c609719bSwdenk CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx 970c609719bSwdenk CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC 9714e8b7544SFabio Estevam CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC 972c609719bSwdenk CONFIG_RTC_MC146818 - use MC146818 RTC 9731cb8e980Swdenk CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC 974c609719bSwdenk CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC 9757f70e853Swdenk CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC 9763bac3513Swdenk CONFIG_RTC_DS164x - use Dallas DS164x RTC 9779536dfccSTor Krill CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC 9784c0d4c3bSwdenk CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC 9796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337 98071d19f30SHeiko Schocher CONFIG_SYS_RV3029_TCR - enable trickle charger on 98171d19f30SHeiko Schocher RV3029 RTC. 982c609719bSwdenk 983b37c7e5eSwdenk Note that if the RTC uses I2C, then the I2C interface 984b37c7e5eSwdenk must also be configured. See I2C Support, below. 985b37c7e5eSwdenk 986e92739d3SPeter Tyser- GPIO Support: 987e92739d3SPeter Tyser CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO 988e92739d3SPeter Tyser CONFIG_PCA953X_INFO - enable pca953x info command 989e92739d3SPeter Tyser 9905dec49caSChris Packham The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of 9915dec49caSChris Packham chip-ngpio pairs that tell the PCA953X driver the number of 9925dec49caSChris Packham pins supported by a particular chip. 9935dec49caSChris Packham 994e92739d3SPeter Tyser Note that if the GPIO device uses I2C, then the I2C interface 995e92739d3SPeter Tyser must also be configured. See I2C Support, below. 996e92739d3SPeter Tyser 997c609719bSwdenk- Timestamp Support: 998c609719bSwdenk 999c609719bSwdenk When CONFIG_TIMESTAMP is selected, the timestamp 1000c609719bSwdenk (date and time) of an image is printed by image 1001c609719bSwdenk commands like bootm or iminfo. This option is 1002602ad3b3SJon Loeliger automatically enabled when you select CONFIG_CMD_DATE . 1003c609719bSwdenk 1004923c46f9SKarl O. Pinc- Partition Labels (disklabels) Supported: 1005923c46f9SKarl O. Pinc Zero or more of the following: 1006923c46f9SKarl O. Pinc CONFIG_MAC_PARTITION Apple's MacOS partition table. 1007923c46f9SKarl O. Pinc CONFIG_DOS_PARTITION MS Dos partition table, traditional on the 1008923c46f9SKarl O. Pinc Intel architecture, USB sticks, etc. 1009923c46f9SKarl O. Pinc CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc. 1010923c46f9SKarl O. Pinc CONFIG_EFI_PARTITION GPT partition table, common when EFI is the 1011923c46f9SKarl O. Pinc bootloader. Note 2TB partition limit; see 1012923c46f9SKarl O. Pinc disk/part_efi.c 1013923c46f9SKarl O. Pinc CONFIG_MTD_PARTITIONS Memory Technology Device partition table. 1014c609719bSwdenk 1015602ad3b3SJon Loeliger If IDE or SCSI support is enabled (CONFIG_CMD_IDE or 1016218ca724SWolfgang Denk CONFIG_CMD_SCSI) you must configure support for at 1017923c46f9SKarl O. Pinc least one non-MTD partition type as well. 1018c609719bSwdenk 1019c609719bSwdenk- IDE Reset method: 10204d13cbadSwdenk CONFIG_IDE_RESET_ROUTINE - this is defined in several 10214d13cbadSwdenk board configurations files but used nowhere! 1022c609719bSwdenk 10234d13cbadSwdenk CONFIG_IDE_RESET - is this is defined, IDE Reset will 10244d13cbadSwdenk be performed by calling the function 10254d13cbadSwdenk ide_set_reset(int reset) 10264d13cbadSwdenk which has to be defined in a board specific file 1027c609719bSwdenk 1028c609719bSwdenk- ATAPI Support: 1029c609719bSwdenk CONFIG_ATAPI 1030c609719bSwdenk 1031c609719bSwdenk Set this to enable ATAPI support. 1032c609719bSwdenk 1033c40b2956Swdenk- LBA48 Support 1034c40b2956Swdenk CONFIG_LBA48 1035c40b2956Swdenk 1036c40b2956Swdenk Set this to enable support for disks larger than 137GB 10374b142febSHeiko Schocher Also look at CONFIG_SYS_64BIT_LBA. 1038c40b2956Swdenk Whithout these , LBA48 support uses 32bit variables and will 'only' 1039c40b2956Swdenk support disks up to 2.1TB. 1040c40b2956Swdenk 10416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_64BIT_LBA: 1042c40b2956Swdenk When enabled, makes the IDE subsystem use 64bit sector addresses. 1043c40b2956Swdenk Default is 32bit. 1044c40b2956Swdenk 1045c609719bSwdenk- SCSI Support: 1046c609719bSwdenk At the moment only there is only support for the 1047c609719bSwdenk SYM53C8XX SCSI controller; define 1048c609719bSwdenk CONFIG_SCSI_SYM53C8XX to enable it. 1049c609719bSwdenk 10506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and 10516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID * 10526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the 1053c609719bSwdenk maximum numbers of LUNs, SCSI ID's and target 1054c609719bSwdenk devices. 10556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz) 1056c609719bSwdenk 1057447c031bSStefan Reinauer The environment variable 'scsidevs' is set to the number of 1058447c031bSStefan Reinauer SCSI devices found during the last scan. 1059447c031bSStefan Reinauer 1060c609719bSwdenk- NETWORK Support (PCI): 1061682011ffSwdenk CONFIG_E1000 1062ce5207e1SKyle Moffett Support for Intel 8254x/8257x gigabit chips. 1063ce5207e1SKyle Moffett 1064ce5207e1SKyle Moffett CONFIG_E1000_SPI 1065ce5207e1SKyle Moffett Utility code for direct access to the SPI bus on Intel 8257x. 1066ce5207e1SKyle Moffett This does not do anything useful unless you set at least one 1067ce5207e1SKyle Moffett of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC. 1068ce5207e1SKyle Moffett 1069ce5207e1SKyle Moffett CONFIG_E1000_SPI_GENERIC 1070ce5207e1SKyle Moffett Allow generic access to the SPI bus on the Intel 8257x, for 1071ce5207e1SKyle Moffett example with the "sspi" command. 1072ce5207e1SKyle Moffett 1073ce5207e1SKyle Moffett CONFIG_CMD_E1000 1074ce5207e1SKyle Moffett Management command for E1000 devices. When used on devices 1075ce5207e1SKyle Moffett with SPI support you can reprogram the EEPROM from U-Boot. 1076682011ffSwdenk 1077ac3315c2SAndre Schwarz CONFIG_E1000_FALLBACK_MAC 107811ccc33fSMarcel Ziswiler default MAC for empty EEPROM after production. 1079ac3315c2SAndre Schwarz 1080c609719bSwdenk CONFIG_EEPRO100 1081c609719bSwdenk Support for Intel 82557/82559/82559ER chips. 108211ccc33fSMarcel Ziswiler Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM 1083c609719bSwdenk write routine for first time initialisation. 1084c609719bSwdenk 1085c609719bSwdenk CONFIG_TULIP 1086c609719bSwdenk Support for Digital 2114x chips. 1087c609719bSwdenk Optional CONFIG_TULIP_SELECT_MEDIA for board specific 1088c609719bSwdenk modem chip initialisation (KS8761/QS6611). 1089c609719bSwdenk 1090c609719bSwdenk CONFIG_NATSEMI 1091c609719bSwdenk Support for National dp83815 chips. 1092c609719bSwdenk 1093c609719bSwdenk CONFIG_NS8382X 1094c609719bSwdenk Support for National dp8382[01] gigabit chips. 1095c609719bSwdenk 109645219c46Swdenk- NETWORK Support (other): 109745219c46Swdenk 1098c041e9d2SJens Scharsig CONFIG_DRIVER_AT91EMAC 1099c041e9d2SJens Scharsig Support for AT91RM9200 EMAC. 1100c041e9d2SJens Scharsig 1101c041e9d2SJens Scharsig CONFIG_RMII 1102c041e9d2SJens Scharsig Define this to use reduced MII inteface 1103c041e9d2SJens Scharsig 1104c041e9d2SJens Scharsig CONFIG_DRIVER_AT91EMAC_QUIET 1105c041e9d2SJens Scharsig If this defined, the driver is quiet. 1106c041e9d2SJens Scharsig The driver doen't show link status messages. 1107c041e9d2SJens Scharsig 1108efdd7319SRob Herring CONFIG_CALXEDA_XGMAC 1109efdd7319SRob Herring Support for the Calxeda XGMAC device 1110efdd7319SRob Herring 11113bb46d23SAshok CONFIG_LAN91C96 111245219c46Swdenk Support for SMSC's LAN91C96 chips. 111345219c46Swdenk 111445219c46Swdenk CONFIG_LAN91C96_BASE 111545219c46Swdenk Define this to hold the physical address 111645219c46Swdenk of the LAN91C96's I/O space 111745219c46Swdenk 111845219c46Swdenk CONFIG_LAN91C96_USE_32_BIT 111945219c46Swdenk Define this to enable 32 bit addressing 112045219c46Swdenk 11213bb46d23SAshok CONFIG_SMC91111 1122f39748aeSwdenk Support for SMSC's LAN91C111 chip 1123f39748aeSwdenk 1124f39748aeSwdenk CONFIG_SMC91111_BASE 1125f39748aeSwdenk Define this to hold the physical address 1126f39748aeSwdenk of the device (I/O space) 1127f39748aeSwdenk 1128f39748aeSwdenk CONFIG_SMC_USE_32_BIT 1129f39748aeSwdenk Define this if data bus is 32 bits 1130f39748aeSwdenk 1131f39748aeSwdenk CONFIG_SMC_USE_IOFUNCS 1132f39748aeSwdenk Define this to use i/o functions instead of macros 1133f39748aeSwdenk (some hardware wont work with macros) 1134f39748aeSwdenk 1135dc02badaSHeiko Schocher CONFIG_DRIVER_TI_EMAC 1136dc02badaSHeiko Schocher Support for davinci emac 1137dc02badaSHeiko Schocher 1138dc02badaSHeiko Schocher CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT 1139dc02badaSHeiko Schocher Define this if you have more then 3 PHYs. 1140dc02badaSHeiko Schocher 1141b3dbf4a5SMacpaul Lin CONFIG_FTGMAC100 1142b3dbf4a5SMacpaul Lin Support for Faraday's FTGMAC100 Gigabit SoC Ethernet 1143b3dbf4a5SMacpaul Lin 1144b3dbf4a5SMacpaul Lin CONFIG_FTGMAC100_EGIGA 1145b3dbf4a5SMacpaul Lin Define this to use GE link update with gigabit PHY. 1146b3dbf4a5SMacpaul Lin Define this if FTGMAC100 is connected to gigabit PHY. 1147b3dbf4a5SMacpaul Lin If your system has 10/100 PHY only, it might not occur 1148b3dbf4a5SMacpaul Lin wrong behavior. Because PHY usually return timeout or 1149b3dbf4a5SMacpaul Lin useless data when polling gigabit status and gigabit 1150b3dbf4a5SMacpaul Lin control registers. This behavior won't affect the 1151b3dbf4a5SMacpaul Lin correctnessof 10/100 link speed update. 1152b3dbf4a5SMacpaul Lin 1153c2fff331SMike Rapoport CONFIG_SMC911X 1154557b377dSJens Gehrlein Support for SMSC's LAN911x and LAN921x chips 1155557b377dSJens Gehrlein 1156c2fff331SMike Rapoport CONFIG_SMC911X_BASE 1157557b377dSJens Gehrlein Define this to hold the physical address 1158557b377dSJens Gehrlein of the device (I/O space) 1159557b377dSJens Gehrlein 1160c2fff331SMike Rapoport CONFIG_SMC911X_32_BIT 1161557b377dSJens Gehrlein Define this if data bus is 32 bits 1162557b377dSJens Gehrlein 1163c2fff331SMike Rapoport CONFIG_SMC911X_16_BIT 1164557b377dSJens Gehrlein Define this if data bus is 16 bits. If your processor 1165557b377dSJens Gehrlein automatically converts one 32 bit word to two 16 bit 1166c2fff331SMike Rapoport words you may also try CONFIG_SMC911X_32_BIT. 1167557b377dSJens Gehrlein 11683d0075faSYoshihiro Shimoda CONFIG_SH_ETHER 11693d0075faSYoshihiro Shimoda Support for Renesas on-chip Ethernet controller 11703d0075faSYoshihiro Shimoda 11713d0075faSYoshihiro Shimoda CONFIG_SH_ETHER_USE_PORT 11723d0075faSYoshihiro Shimoda Define the number of ports to be used 11733d0075faSYoshihiro Shimoda 11743d0075faSYoshihiro Shimoda CONFIG_SH_ETHER_PHY_ADDR 11753d0075faSYoshihiro Shimoda Define the ETH PHY's address 11763d0075faSYoshihiro Shimoda 117768260aabSYoshihiro Shimoda CONFIG_SH_ETHER_CACHE_WRITEBACK 117868260aabSYoshihiro Shimoda If this option is set, the driver enables cache flush. 117968260aabSYoshihiro Shimoda 11805e124724SVadim Bendebury- TPM Support: 11815e124724SVadim Bendebury CONFIG_GENERIC_LPC_TPM 11825e124724SVadim Bendebury Support for generic parallel port TPM devices. Only one device 11835e124724SVadim Bendebury per system is supported at this time. 11845e124724SVadim Bendebury 11855e124724SVadim Bendebury CONFIG_TPM_TIS_BASE_ADDRESS 11865e124724SVadim Bendebury Base address where the generic TPM device is mapped 11875e124724SVadim Bendebury to. Contemporary x86 systems usually map it at 11885e124724SVadim Bendebury 0xfed40000. 11895e124724SVadim Bendebury 1190c609719bSwdenk- USB Support: 1191c609719bSwdenk At the moment only the UHCI host controller is 11924d13cbadSwdenk supported (PIP405, MIP405, MPC5200); define 1193c609719bSwdenk CONFIG_USB_UHCI to enable it. 1194c609719bSwdenk define CONFIG_USB_KEYBOARD to enable the USB Keyboard 119530d56faeSwdenk and define CONFIG_USB_STORAGE to enable the USB 1196c609719bSwdenk storage devices. 1197c609719bSwdenk Note: 1198c609719bSwdenk Supported are USB Keyboards and USB Floppy drives 1199c609719bSwdenk (TEAC FD-05PUB). 12004d13cbadSwdenk MPC5200 USB requires additional defines: 12014d13cbadSwdenk CONFIG_USB_CLOCK 12024d13cbadSwdenk for 528 MHz Clock: 0x0001bbbb 1203307ecb6dSEric Millbrandt CONFIG_PSC3_USB 1204307ecb6dSEric Millbrandt for USB on PSC3 12054d13cbadSwdenk CONFIG_USB_CONFIG 12064d13cbadSwdenk for differential drivers: 0x00001000 12074d13cbadSwdenk for single ended drivers: 0x00005000 1208307ecb6dSEric Millbrandt for differential drivers on PSC3: 0x00000100 1209307ecb6dSEric Millbrandt for single ended drivers on PSC3: 0x00004100 12106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_USB_EVENT_POLL 1211fdcfaa1bSZhang Wei May be defined to allow interrupt polling 1212fdcfaa1bSZhang Wei instead of using asynchronous interrupts 12134d13cbadSwdenk 12149ab4ce22SSimon Glass CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the 12159ab4ce22SSimon Glass txfilltuning field in the EHCI controller on reset. 12169ab4ce22SSimon Glass 121716c8d5e7SWolfgang Denk- USB Device: 121816c8d5e7SWolfgang Denk Define the below if you wish to use the USB console. 121916c8d5e7SWolfgang Denk Once firmware is rebuilt from a serial console issue the 122016c8d5e7SWolfgang Denk command "setenv stdin usbtty; setenv stdout usbtty" and 122111ccc33fSMarcel Ziswiler attach your USB cable. The Unix command "dmesg" should print 122216c8d5e7SWolfgang Denk it has found a new device. The environment variable usbtty 122316c8d5e7SWolfgang Denk can be set to gserial or cdc_acm to enable your device to 122416c8d5e7SWolfgang Denk appear to a USB host as a Linux gserial device or a 122516c8d5e7SWolfgang Denk Common Device Class Abstract Control Model serial device. 122616c8d5e7SWolfgang Denk If you select usbtty = gserial you should be able to enumerate 122716c8d5e7SWolfgang Denk a Linux host by 122816c8d5e7SWolfgang Denk # modprobe usbserial vendor=0xVendorID product=0xProductID 122916c8d5e7SWolfgang Denk else if using cdc_acm, simply setting the environment 123016c8d5e7SWolfgang Denk variable usbtty to be cdc_acm should suffice. The following 123116c8d5e7SWolfgang Denk might be defined in YourBoardName.h 123216c8d5e7SWolfgang Denk 123316c8d5e7SWolfgang Denk CONFIG_USB_DEVICE 123416c8d5e7SWolfgang Denk Define this to build a UDC device 123516c8d5e7SWolfgang Denk 123616c8d5e7SWolfgang Denk CONFIG_USB_TTY 123716c8d5e7SWolfgang Denk Define this to have a tty type of device available to 123816c8d5e7SWolfgang Denk talk to the UDC device 123916c8d5e7SWolfgang Denk 1240f9da0f89SVipin KUMAR CONFIG_USBD_HS 1241f9da0f89SVipin KUMAR Define this to enable the high speed support for usb 1242f9da0f89SVipin KUMAR device and usbtty. If this feature is enabled, a routine 1243f9da0f89SVipin KUMAR int is_usbd_high_speed(void) 1244f9da0f89SVipin KUMAR also needs to be defined by the driver to dynamically poll 1245f9da0f89SVipin KUMAR whether the enumeration has succeded at high speed or full 1246f9da0f89SVipin KUMAR speed. 1247f9da0f89SVipin KUMAR 12486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_CONSOLE_IS_IN_ENV 124916c8d5e7SWolfgang Denk Define this if you want stdin, stdout &/or stderr to 125016c8d5e7SWolfgang Denk be set to usbtty. 125116c8d5e7SWolfgang Denk 125216c8d5e7SWolfgang Denk mpc8xx: 12536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_USB_EXTC_CLK 0xBLAH 125416c8d5e7SWolfgang Denk Derive USB clock from external clock "blah" 12556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_USB_EXTC_CLK 0x02 125616c8d5e7SWolfgang Denk 12576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_USB_BRG_CLK 0xBLAH 125816c8d5e7SWolfgang Denk Derive USB clock from brgclk 12596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_USB_BRG_CLK 0x04 126016c8d5e7SWolfgang Denk 126116c8d5e7SWolfgang Denk If you have a USB-IF assigned VendorID then you may wish to 126216c8d5e7SWolfgang Denk define your own vendor specific values either in BoardName.h 126316c8d5e7SWolfgang Denk or directly in usbd_vendor_info.h. If you don't define 126416c8d5e7SWolfgang Denk CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME, 126516c8d5e7SWolfgang Denk CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot 126616c8d5e7SWolfgang Denk should pretend to be a Linux device to it's target host. 126716c8d5e7SWolfgang Denk 126816c8d5e7SWolfgang Denk CONFIG_USBD_MANUFACTURER 126916c8d5e7SWolfgang Denk Define this string as the name of your company for 127016c8d5e7SWolfgang Denk - CONFIG_USBD_MANUFACTURER "my company" 127116c8d5e7SWolfgang Denk 127216c8d5e7SWolfgang Denk CONFIG_USBD_PRODUCT_NAME 127316c8d5e7SWolfgang Denk Define this string as the name of your product 127416c8d5e7SWolfgang Denk - CONFIG_USBD_PRODUCT_NAME "acme usb device" 127516c8d5e7SWolfgang Denk 127616c8d5e7SWolfgang Denk CONFIG_USBD_VENDORID 127716c8d5e7SWolfgang Denk Define this as your assigned Vendor ID from the USB 127816c8d5e7SWolfgang Denk Implementors Forum. This *must* be a genuine Vendor ID 127916c8d5e7SWolfgang Denk to avoid polluting the USB namespace. 128016c8d5e7SWolfgang Denk - CONFIG_USBD_VENDORID 0xFFFF 128116c8d5e7SWolfgang Denk 128216c8d5e7SWolfgang Denk CONFIG_USBD_PRODUCTID 128316c8d5e7SWolfgang Denk Define this as the unique Product ID 128416c8d5e7SWolfgang Denk for your device 128516c8d5e7SWolfgang Denk - CONFIG_USBD_PRODUCTID 0xFFFF 1286c609719bSwdenk 1287d70a560fSIgor Grinberg- ULPI Layer Support: 1288d70a560fSIgor Grinberg The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via 1289d70a560fSIgor Grinberg the generic ULPI layer. The generic layer accesses the ULPI PHY 1290d70a560fSIgor Grinberg via the platform viewport, so you need both the genric layer and 1291d70a560fSIgor Grinberg the viewport enabled. Currently only Chipidea/ARC based 1292d70a560fSIgor Grinberg viewport is supported. 1293d70a560fSIgor Grinberg To enable the ULPI layer support, define CONFIG_USB_ULPI and 1294d70a560fSIgor Grinberg CONFIG_USB_ULPI_VIEWPORT in your board configuration file. 12956d365ea0SLucas Stach If your ULPI phy needs a different reference clock than the 12966d365ea0SLucas Stach standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to 12976d365ea0SLucas Stach the appropriate value in Hz. 1298c609719bSwdenk 1299c609719bSwdenk- MMC Support: 1300c609719bSwdenk The MMC controller on the Intel PXA is supported. To 1301c609719bSwdenk enable this define CONFIG_MMC. The MMC can be 1302c609719bSwdenk accessed from the boot prompt by mapping the device 1303c609719bSwdenk to physical memory similar to flash. Command line is 1304602ad3b3SJon Loeliger enabled with CONFIG_CMD_MMC. The MMC driver also works with 1305602ad3b3SJon Loeliger the FAT fs. This is enabled with CONFIG_CMD_FAT. 1306c609719bSwdenk 1307afb35666SYoshihiro Shimoda CONFIG_SH_MMCIF 1308afb35666SYoshihiro Shimoda Support for Renesas on-chip MMCIF controller 1309afb35666SYoshihiro Shimoda 1310afb35666SYoshihiro Shimoda CONFIG_SH_MMCIF_ADDR 1311afb35666SYoshihiro Shimoda Define the base address of MMCIF registers 1312afb35666SYoshihiro Shimoda 1313afb35666SYoshihiro Shimoda CONFIG_SH_MMCIF_CLK 1314afb35666SYoshihiro Shimoda Define the clock frequency for MMCIF 1315afb35666SYoshihiro Shimoda 13166705d81eSwdenk- Journaling Flash filesystem support: 13176705d81eSwdenk CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE, 13186705d81eSwdenk CONFIG_JFFS2_NAND_DEV 13196705d81eSwdenk Define these for a default partition on a NAND device 13206705d81eSwdenk 13216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS2_FIRST_SECTOR, 13226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS 13236705d81eSwdenk Define these for a default partition on a NOR device 13246705d81eSwdenk 13256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS_CUSTOM_PART 13266705d81eSwdenk Define this to create an own partition. You have to provide a 13276705d81eSwdenk function struct part_info* jffs2_part_info(int part_num) 13286705d81eSwdenk 13296705d81eSwdenk If you define only one JFFS2 partition you may also want to 13306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_JFFS_SINGLE_PART 1 13316705d81eSwdenk to disable the command chpart. This is the default when you 13326705d81eSwdenk have not defined a custom partition 13336705d81eSwdenk 1334c30a15e5SDonggeun Kim- FAT(File Allocation Table) filesystem write function support: 1335c30a15e5SDonggeun Kim CONFIG_FAT_WRITE 1336656f4c65SDonggeun Kim 1337656f4c65SDonggeun Kim Define this to enable support for saving memory data as a 1338656f4c65SDonggeun Kim file in FAT formatted partition. 1339656f4c65SDonggeun Kim 1340656f4c65SDonggeun Kim This will also enable the command "fatwrite" enabling the 1341656f4c65SDonggeun Kim user to write files to FAT. 1342c30a15e5SDonggeun Kim 134384cd9327SGabe BlackCBFS (Coreboot Filesystem) support 134484cd9327SGabe Black CONFIG_CMD_CBFS 134584cd9327SGabe Black 134684cd9327SGabe Black Define this to enable support for reading from a Coreboot 134784cd9327SGabe Black filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls 134884cd9327SGabe Black and cbfsload. 134984cd9327SGabe Black 1350c609719bSwdenk- Keyboard Support: 1351c609719bSwdenk CONFIG_ISA_KEYBOARD 1352c609719bSwdenk 1353c609719bSwdenk Define this to enable standard (PC-Style) keyboard 1354c609719bSwdenk support 1355c609719bSwdenk 1356c609719bSwdenk CONFIG_I8042_KBD 1357c609719bSwdenk Standard PC keyboard driver with US (is default) and 1358c609719bSwdenk GERMAN key layout (switch via environment 'keymap=de') support. 1359c609719bSwdenk Export function i8042_kbd_init, i8042_tstc and i8042_getc 1360c609719bSwdenk for cfb_console. Supports cursor blinking. 1361c609719bSwdenk 1362c609719bSwdenk- Video support: 1363c609719bSwdenk CONFIG_VIDEO 1364c609719bSwdenk 1365c609719bSwdenk Define this to enable video support (for output to 1366c609719bSwdenk video). 1367c609719bSwdenk 1368c609719bSwdenk CONFIG_VIDEO_CT69000 1369c609719bSwdenk 1370c609719bSwdenk Enable Chips & Technologies 69000 Video chip 1371c609719bSwdenk 1372c609719bSwdenk CONFIG_VIDEO_SMI_LYNXEM 1373eeb1b77bSwdenk Enable Silicon Motion SMI 712/710/810 Video chip. The 1374eeb1b77bSwdenk video output is selected via environment 'videoout' 1375eeb1b77bSwdenk (1 = LCD and 2 = CRT). If videoout is undefined, CRT is 1376eeb1b77bSwdenk assumed. 1377c609719bSwdenk 1378eeb1b77bSwdenk For the CT69000 and SMI_LYNXEM drivers, videomode is 137911ccc33fSMarcel Ziswiler selected via environment 'videomode'. Two different ways 1380eeb1b77bSwdenk are possible: 1381eeb1b77bSwdenk - "videomode=num" 'num' is a standard LiLo mode numbers. 1382eeb1b77bSwdenk Following standard modes are supported (* is default): 1383eeb1b77bSwdenk 1384eeb1b77bSwdenk Colors 640x480 800x600 1024x768 1152x864 1280x1024 1385eeb1b77bSwdenk -------------+--------------------------------------------- 1386eeb1b77bSwdenk 8 bits | 0x301* 0x303 0x305 0x161 0x307 1387eeb1b77bSwdenk 15 bits | 0x310 0x313 0x316 0x162 0x319 1388eeb1b77bSwdenk 16 bits | 0x311 0x314 0x317 0x163 0x31A 1389eeb1b77bSwdenk 24 bits | 0x312 0x315 0x318 ? 0x31B 1390eeb1b77bSwdenk -------------+--------------------------------------------- 1391c609719bSwdenk (i.e. setenv videomode 317; saveenv; reset;) 1392c609719bSwdenk 1393eeb1b77bSwdenk - "videomode=bootargs" all the video parameters are parsed 13947817cb20SMarcel Ziswiler from the bootargs. (See drivers/video/videomodes.c) 1395eeb1b77bSwdenk 1396eeb1b77bSwdenk 1397a6c7ad2fSwdenk CONFIG_VIDEO_SED13806 1398a6c7ad2fSwdenk Enable Epson SED13806 driver. This driver supports 8bpp 1399a6c7ad2fSwdenk and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP 1400a6c7ad2fSwdenk or CONFIG_VIDEO_SED13806_16BPP 1401a6c7ad2fSwdenk 14027d3053fbSTimur Tabi CONFIG_FSL_DIU_FB 14037d3053fbSTimur Tabi Enable the Freescale DIU video driver. Reference boards for 14047d3053fbSTimur Tabi SOCs that have a DIU should define this macro to enable DIU 14057d3053fbSTimur Tabi support, and should also define these other macros: 14067d3053fbSTimur Tabi 14077d3053fbSTimur Tabi CONFIG_SYS_DIU_ADDR 14087d3053fbSTimur Tabi CONFIG_VIDEO 14097d3053fbSTimur Tabi CONFIG_CMD_BMP 14107d3053fbSTimur Tabi CONFIG_CFB_CONSOLE 14117d3053fbSTimur Tabi CONFIG_VIDEO_SW_CURSOR 14127d3053fbSTimur Tabi CONFIG_VGA_AS_SINGLE_DEVICE 14137d3053fbSTimur Tabi CONFIG_VIDEO_LOGO 14147d3053fbSTimur Tabi CONFIG_VIDEO_BMP_LOGO 14157d3053fbSTimur Tabi 1416ba8e76bdSTimur Tabi The DIU driver will look for the 'video-mode' environment 1417ba8e76bdSTimur Tabi variable, and if defined, enable the DIU as a console during 1418ba8e76bdSTimur Tabi boot. See the documentation file README.video for a 1419ba8e76bdSTimur Tabi description of this variable. 14207d3053fbSTimur Tabi 1421058d59b0SSimon Glass CONFIG_VIDEO_VGA 1422058d59b0SSimon Glass 1423058d59b0SSimon Glass Enable the VGA video / BIOS for x86. The alternative if you 1424058d59b0SSimon Glass are using coreboot is to use the coreboot frame buffer 1425058d59b0SSimon Glass driver. 1426058d59b0SSimon Glass 1427058d59b0SSimon Glass 1428682011ffSwdenk- Keyboard Support: 1429682011ffSwdenk CONFIG_KEYBOARD 1430682011ffSwdenk 1431682011ffSwdenk Define this to enable a custom keyboard support. 1432682011ffSwdenk This simply calls drv_keyboard_init() which must be 1433682011ffSwdenk defined in your board-specific files. 1434682011ffSwdenk The only board using this so far is RBC823. 1435a6c7ad2fSwdenk 1436c609719bSwdenk- LCD Support: CONFIG_LCD 1437c609719bSwdenk 1438c609719bSwdenk Define this to enable LCD support (for output to LCD 1439c609719bSwdenk display); also select one of the supported displays 1440c609719bSwdenk by defining one of these: 1441c609719bSwdenk 144239cf4804SStelian Pop CONFIG_ATMEL_LCD: 144339cf4804SStelian Pop 144439cf4804SStelian Pop HITACHI TX09D70VM1CCA, 3.5", 240x320. 144539cf4804SStelian Pop 1446fd3103bbSwdenk CONFIG_NEC_NL6448AC33: 1447c609719bSwdenk 1448fd3103bbSwdenk NEC NL6448AC33-18. Active, color, single scan. 1449c609719bSwdenk 1450fd3103bbSwdenk CONFIG_NEC_NL6448BC20 1451c609719bSwdenk 1452fd3103bbSwdenk NEC NL6448BC20-08. 6.5", 640x480. 1453fd3103bbSwdenk Active, color, single scan. 1454fd3103bbSwdenk 1455fd3103bbSwdenk CONFIG_NEC_NL6448BC33_54 1456fd3103bbSwdenk 1457fd3103bbSwdenk NEC NL6448BC33-54. 10.4", 640x480. 1458c609719bSwdenk Active, color, single scan. 1459c609719bSwdenk 1460c609719bSwdenk CONFIG_SHARP_16x9 1461c609719bSwdenk 1462c609719bSwdenk Sharp 320x240. Active, color, single scan. 1463c609719bSwdenk It isn't 16x9, and I am not sure what it is. 1464c609719bSwdenk 1465c609719bSwdenk CONFIG_SHARP_LQ64D341 1466c609719bSwdenk 1467c609719bSwdenk Sharp LQ64D341 display, 640x480. 1468c609719bSwdenk Active, color, single scan. 1469c609719bSwdenk 1470c609719bSwdenk CONFIG_HLD1045 1471c609719bSwdenk 1472c609719bSwdenk HLD1045 display, 640x480. 1473c609719bSwdenk Active, color, single scan. 1474c609719bSwdenk 1475c609719bSwdenk CONFIG_OPTREX_BW 1476c609719bSwdenk 1477c609719bSwdenk Optrex CBL50840-2 NF-FW 99 22 M5 1478c609719bSwdenk or 1479c609719bSwdenk Hitachi LMG6912RPFC-00T 1480c609719bSwdenk or 1481c609719bSwdenk Hitachi SP14Q002 1482c609719bSwdenk 1483c609719bSwdenk 320x240. Black & white. 1484c609719bSwdenk 1485c609719bSwdenk Normally display is black on white background; define 14866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_WHITE_ON_BLACK to get it inverted. 1487c609719bSwdenk 148845d7f525STom Wai-Hong Tam CONFIG_LCD_BMP_RLE8 148945d7f525STom Wai-Hong Tam 149045d7f525STom Wai-Hong Tam Support drawing of RLE8-compressed bitmaps on the LCD. 149145d7f525STom Wai-Hong Tam 1492735987c5STom Wai-Hong Tam CONFIG_I2C_EDID 1493735987c5STom Wai-Hong Tam 1494735987c5STom Wai-Hong Tam Enables an 'i2c edid' command which can read EDID 1495735987c5STom Wai-Hong Tam information over I2C from an attached LCD display. 1496735987c5STom Wai-Hong Tam 149745d7f525STom Wai-Hong Tam 14987152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN 1499d791b1dcSwdenk 1500d791b1dcSwdenk If this option is set, the environment is checked for 1501d791b1dcSwdenk a variable "splashimage". If found, the usual display 1502d791b1dcSwdenk of logo, copyright and system information on the LCD 1503e94d2cd9Swdenk is suppressed and the BMP image at the address 1504d791b1dcSwdenk specified in "splashimage" is loaded instead. The 1505d791b1dcSwdenk console is redirected to the "nulldev", too. This 1506d791b1dcSwdenk allows for a "silent" boot where a splash screen is 1507d791b1dcSwdenk loaded very quickly after power-on. 1508d791b1dcSwdenk 15091ca298ceSMatthias Weisser CONFIG_SPLASH_SCREEN_ALIGN 15101ca298ceSMatthias Weisser 15111ca298ceSMatthias Weisser If this option is set the splash image can be freely positioned 15121ca298ceSMatthias Weisser on the screen. Environment variable "splashpos" specifies the 15131ca298ceSMatthias Weisser position as "x,y". If a positive number is given it is used as 15141ca298ceSMatthias Weisser number of pixel from left/top. If a negative number is given it 15151ca298ceSMatthias Weisser is used as number of pixel from right/bottom. You can also 15161ca298ceSMatthias Weisser specify 'm' for centering the image. 15171ca298ceSMatthias Weisser 15181ca298ceSMatthias Weisser Example: 15191ca298ceSMatthias Weisser setenv splashpos m,m 15201ca298ceSMatthias Weisser => image at center of screen 15211ca298ceSMatthias Weisser 15221ca298ceSMatthias Weisser setenv splashpos 30,20 15231ca298ceSMatthias Weisser => image at x = 30 and y = 20 15241ca298ceSMatthias Weisser 15251ca298ceSMatthias Weisser setenv splashpos -10,m 15261ca298ceSMatthias Weisser => vertically centered image 15271ca298ceSMatthias Weisser at x = dspWidth - bmpWidth - 9 15281ca298ceSMatthias Weisser 152998f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP 153098f4a3dfSStefan Roese 153198f4a3dfSStefan Roese If this option is set, additionally to standard BMP 153298f4a3dfSStefan Roese images, gzipped BMP images can be displayed via the 153398f4a3dfSStefan Roese splashscreen support or the bmp command. 153498f4a3dfSStefan Roese 1535d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8 1536d5011762SAnatolij Gustschin 1537d5011762SAnatolij Gustschin If this option is set, 8-bit RLE compressed BMP images 1538d5011762SAnatolij Gustschin can be displayed via the splashscreen support or the 1539d5011762SAnatolij Gustschin bmp command. 1540d5011762SAnatolij Gustschin 1541f2b96dfbSLei Wen- Do compresssing for memory range: 1542f2b96dfbSLei Wen CONFIG_CMD_ZIP 1543f2b96dfbSLei Wen 1544f2b96dfbSLei Wen If this option is set, it would use zlib deflate method 1545f2b96dfbSLei Wen to compress the specified memory at its best effort. 1546f2b96dfbSLei Wen 1547c29fdfc1Swdenk- Compression support: 1548c29fdfc1Swdenk CONFIG_BZIP2 1549c29fdfc1Swdenk 1550c29fdfc1Swdenk If this option is set, support for bzip2 compressed 1551c29fdfc1Swdenk images is included. If not, only uncompressed and gzip 1552c29fdfc1Swdenk compressed images are supported. 1553c29fdfc1Swdenk 1554c29fdfc1Swdenk NOTE: the bzip2 algorithm requires a lot of RAM, so 15556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should 1556c29fdfc1Swdenk be at least 4MB. 1557d791b1dcSwdenk 1558fc9c1727SLuigi 'Comio' Mantellini CONFIG_LZMA 1559fc9c1727SLuigi 'Comio' Mantellini 1560fc9c1727SLuigi 'Comio' Mantellini If this option is set, support for lzma compressed 1561fc9c1727SLuigi 'Comio' Mantellini images is included. 1562fc9c1727SLuigi 'Comio' Mantellini 1563fc9c1727SLuigi 'Comio' Mantellini Note: The LZMA algorithm adds between 2 and 4KB of code and it 1564fc9c1727SLuigi 'Comio' Mantellini requires an amount of dynamic memory that is given by the 1565fc9c1727SLuigi 'Comio' Mantellini formula: 1566fc9c1727SLuigi 'Comio' Mantellini 1567fc9c1727SLuigi 'Comio' Mantellini (1846 + 768 << (lc + lp)) * sizeof(uint16) 1568fc9c1727SLuigi 'Comio' Mantellini 1569fc9c1727SLuigi 'Comio' Mantellini Where lc and lp stand for, respectively, Literal context bits 1570fc9c1727SLuigi 'Comio' Mantellini and Literal pos bits. 1571fc9c1727SLuigi 'Comio' Mantellini 1572fc9c1727SLuigi 'Comio' Mantellini This value is upper-bounded by 14MB in the worst case. Anyway, 1573fc9c1727SLuigi 'Comio' Mantellini for a ~4MB large kernel image, we have lc=3 and lp=0 for a 1574fc9c1727SLuigi 'Comio' Mantellini total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is 1575fc9c1727SLuigi 'Comio' Mantellini a very small buffer. 1576fc9c1727SLuigi 'Comio' Mantellini 1577fc9c1727SLuigi 'Comio' Mantellini Use the lzmainfo tool to determinate the lc and lp values and 1578fc9c1727SLuigi 'Comio' Mantellini then calculate the amount of needed dynamic memory (ensuring 15796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD the appropriate CONFIG_SYS_MALLOC_LEN value). 1580fc9c1727SLuigi 'Comio' Mantellini 158117ea1177Swdenk- MII/PHY support: 158217ea1177Swdenk CONFIG_PHY_ADDR 158317ea1177Swdenk 158417ea1177Swdenk The address of PHY on MII bus. 158517ea1177Swdenk 158617ea1177Swdenk CONFIG_PHY_CLOCK_FREQ (ppc4xx) 158717ea1177Swdenk 158817ea1177Swdenk The clock frequency of the MII bus 158917ea1177Swdenk 159017ea1177Swdenk CONFIG_PHY_GIGE 159117ea1177Swdenk 159217ea1177Swdenk If this option is set, support for speed/duplex 159311ccc33fSMarcel Ziswiler detection of gigabit PHY is included. 159417ea1177Swdenk 159517ea1177Swdenk CONFIG_PHY_RESET_DELAY 159617ea1177Swdenk 159717ea1177Swdenk Some PHY like Intel LXT971A need extra delay after 159817ea1177Swdenk reset before any MII register access is possible. 159917ea1177Swdenk For such PHY, set this option to the usec delay 160017ea1177Swdenk required. (minimum 300usec for LXT971A) 160117ea1177Swdenk 160217ea1177Swdenk CONFIG_PHY_CMD_DELAY (ppc4xx) 160317ea1177Swdenk 160417ea1177Swdenk Some PHY like Intel LXT971A need extra delay after 160517ea1177Swdenk command issued before MII status register can be read 160617ea1177Swdenk 1607c609719bSwdenk- Ethernet address: 1608c609719bSwdenk CONFIG_ETHADDR 1609c68a05feSrichardretanubun CONFIG_ETH1ADDR 1610c609719bSwdenk CONFIG_ETH2ADDR 1611c609719bSwdenk CONFIG_ETH3ADDR 1612c68a05feSrichardretanubun CONFIG_ETH4ADDR 1613c68a05feSrichardretanubun CONFIG_ETH5ADDR 1614c609719bSwdenk 161511ccc33fSMarcel Ziswiler Define a default value for Ethernet address to use 161611ccc33fSMarcel Ziswiler for the respective Ethernet interface, in case this 1617c609719bSwdenk is not determined automatically. 1618c609719bSwdenk 1619c609719bSwdenk- IP address: 1620c609719bSwdenk CONFIG_IPADDR 1621c609719bSwdenk 1622c609719bSwdenk Define a default value for the IP address to use for 162311ccc33fSMarcel Ziswiler the default Ethernet interface, in case this is not 1624c609719bSwdenk determined through e.g. bootp. 16251ebcd654SWolfgang Denk (Environment variable "ipaddr") 1626c609719bSwdenk 1627c609719bSwdenk- Server IP address: 1628c609719bSwdenk CONFIG_SERVERIP 1629c609719bSwdenk 1630c609719bSwdenk Defines a default value for the IP address of a TFTP 1631c609719bSwdenk server to contact when using the "tftboot" command. 16321ebcd654SWolfgang Denk (Environment variable "serverip") 1633c609719bSwdenk 163497cfe861SRobin Getz CONFIG_KEEP_SERVERADDR 163597cfe861SRobin Getz 163697cfe861SRobin Getz Keeps the server's MAC address, in the env 'serveraddr' 163797cfe861SRobin Getz for passing to bootargs (like Linux's netconsole option) 163897cfe861SRobin Getz 16391ebcd654SWolfgang Denk- Gateway IP address: 16401ebcd654SWolfgang Denk CONFIG_GATEWAYIP 16411ebcd654SWolfgang Denk 16421ebcd654SWolfgang Denk Defines a default value for the IP address of the 16431ebcd654SWolfgang Denk default router where packets to other networks are 16441ebcd654SWolfgang Denk sent to. 16451ebcd654SWolfgang Denk (Environment variable "gatewayip") 16461ebcd654SWolfgang Denk 16471ebcd654SWolfgang Denk- Subnet mask: 16481ebcd654SWolfgang Denk CONFIG_NETMASK 16491ebcd654SWolfgang Denk 16501ebcd654SWolfgang Denk Defines a default value for the subnet mask (or 16511ebcd654SWolfgang Denk routing prefix) which is used to determine if an IP 16521ebcd654SWolfgang Denk address belongs to the local subnet or needs to be 16531ebcd654SWolfgang Denk forwarded through a router. 16541ebcd654SWolfgang Denk (Environment variable "netmask") 16551ebcd654SWolfgang Denk 165653a5c424SDavid Updegraff- Multicast TFTP Mode: 165753a5c424SDavid Updegraff CONFIG_MCAST_TFTP 165853a5c424SDavid Updegraff 165953a5c424SDavid Updegraff Defines whether you want to support multicast TFTP as per 166053a5c424SDavid Updegraff rfc-2090; for example to work with atftp. Lets lots of targets 166111ccc33fSMarcel Ziswiler tftp down the same boot image concurrently. Note: the Ethernet 166253a5c424SDavid Updegraff driver in use must provide a function: mcast() to join/leave a 166353a5c424SDavid Updegraff multicast group. 166453a5c424SDavid Updegraff 1665c609719bSwdenk- BOOTP Recovery Mode: 1666c609719bSwdenk CONFIG_BOOTP_RANDOM_DELAY 1667c609719bSwdenk 1668c609719bSwdenk If you have many targets in a network that try to 1669c609719bSwdenk boot using BOOTP, you may want to avoid that all 1670c609719bSwdenk systems send out BOOTP requests at precisely the same 1671c609719bSwdenk moment (which would happen for instance at recovery 1672c609719bSwdenk from a power failure, when all systems will try to 1673c609719bSwdenk boot, thus flooding the BOOTP server. Defining 1674c609719bSwdenk CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be 1675c609719bSwdenk inserted before sending out BOOTP requests. The 16766c33c785SWolfgang Denk following delays are inserted then: 1677c609719bSwdenk 1678c609719bSwdenk 1st BOOTP request: delay 0 ... 1 sec 1679c609719bSwdenk 2nd BOOTP request: delay 0 ... 2 sec 1680c609719bSwdenk 3rd BOOTP request: delay 0 ... 4 sec 1681c609719bSwdenk 4th and following 1682c609719bSwdenk BOOTP requests: delay 0 ... 8 sec 1683c609719bSwdenk 1684fe389a82Sstroese- DHCP Advanced Options: 16851fe80d79SJon Loeliger You can fine tune the DHCP functionality by defining 16861fe80d79SJon Loeliger CONFIG_BOOTP_* symbols: 1687fe389a82Sstroese 16881fe80d79SJon Loeliger CONFIG_BOOTP_SUBNETMASK 16891fe80d79SJon Loeliger CONFIG_BOOTP_GATEWAY 16901fe80d79SJon Loeliger CONFIG_BOOTP_HOSTNAME 16911fe80d79SJon Loeliger CONFIG_BOOTP_NISDOMAIN 16921fe80d79SJon Loeliger CONFIG_BOOTP_BOOTPATH 16931fe80d79SJon Loeliger CONFIG_BOOTP_BOOTFILESIZE 16941fe80d79SJon Loeliger CONFIG_BOOTP_DNS 16951fe80d79SJon Loeliger CONFIG_BOOTP_DNS2 16961fe80d79SJon Loeliger CONFIG_BOOTP_SEND_HOSTNAME 16971fe80d79SJon Loeliger CONFIG_BOOTP_NTPSERVER 16981fe80d79SJon Loeliger CONFIG_BOOTP_TIMEOFFSET 16991fe80d79SJon Loeliger CONFIG_BOOTP_VENDOREX 17002c00e099SJoe Hershberger CONFIG_BOOTP_MAY_FAIL 1701fe389a82Sstroese 17025d110f0aSWilson Callan CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip 17035d110f0aSWilson Callan environment variable, not the BOOTP server. 1704fe389a82Sstroese 17052c00e099SJoe Hershberger CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found 17062c00e099SJoe Hershberger after the configured retry count, the call will fail 17072c00e099SJoe Hershberger instead of starting over. This can be used to fail over 17082c00e099SJoe Hershberger to Link-local IP address configuration if the DHCP server 17092c00e099SJoe Hershberger is not available. 17102c00e099SJoe Hershberger 1711fe389a82Sstroese CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS 1712fe389a82Sstroese serverip from a DHCP server, it is possible that more 1713fe389a82Sstroese than one DNS serverip is offered to the client. 1714fe389a82Sstroese If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS 1715fe389a82Sstroese serverip will be stored in the additional environment 1716fe389a82Sstroese variable "dnsip2". The first DNS serverip is always 1717fe389a82Sstroese stored in the variable "dnsip", when CONFIG_BOOTP_DNS 17181fe80d79SJon Loeliger is defined. 1719fe389a82Sstroese 1720fe389a82Sstroese CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable 1721fe389a82Sstroese to do a dynamic update of a DNS server. To do this, they 1722fe389a82Sstroese need the hostname of the DHCP requester. 17235d110f0aSWilson Callan If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content 17241fe80d79SJon Loeliger of the "hostname" environment variable is passed as 17251fe80d79SJon Loeliger option 12 to the DHCP server. 1726fe389a82Sstroese 1727d9a2f416SAras Vaichas CONFIG_BOOTP_DHCP_REQUEST_DELAY 1728d9a2f416SAras Vaichas 1729d9a2f416SAras Vaichas A 32bit value in microseconds for a delay between 1730d9a2f416SAras Vaichas receiving a "DHCP Offer" and sending the "DHCP Request". 1731d9a2f416SAras Vaichas This fixes a problem with certain DHCP servers that don't 1732d9a2f416SAras Vaichas respond 100% of the time to a "DHCP request". E.g. On an 1733d9a2f416SAras Vaichas AT91RM9200 processor running at 180MHz, this delay needed 1734d9a2f416SAras Vaichas to be *at least* 15,000 usec before a Windows Server 2003 1735d9a2f416SAras Vaichas DHCP server would reply 100% of the time. I recommend at 1736d9a2f416SAras Vaichas least 50,000 usec to be safe. The alternative is to hope 1737d9a2f416SAras Vaichas that one of the retries will be successful but note that 1738d9a2f416SAras Vaichas the DHCP timeout and retry process takes a longer than 1739d9a2f416SAras Vaichas this delay. 1740d9a2f416SAras Vaichas 1741d22c338eSJoe Hershberger - Link-local IP address negotiation: 1742d22c338eSJoe Hershberger Negotiate with other link-local clients on the local network 1743d22c338eSJoe Hershberger for an address that doesn't require explicit configuration. 1744d22c338eSJoe Hershberger This is especially useful if a DHCP server cannot be guaranteed 1745d22c338eSJoe Hershberger to exist in all environments that the device must operate. 1746d22c338eSJoe Hershberger 1747d22c338eSJoe Hershberger See doc/README.link-local for more information. 1748d22c338eSJoe Hershberger 1749a3d991bdSwdenk - CDP Options: 1750a3d991bdSwdenk CONFIG_CDP_DEVICE_ID 1751a3d991bdSwdenk 1752a3d991bdSwdenk The device id used in CDP trigger frames. 1753a3d991bdSwdenk 1754a3d991bdSwdenk CONFIG_CDP_DEVICE_ID_PREFIX 1755a3d991bdSwdenk 1756a3d991bdSwdenk A two character string which is prefixed to the MAC address 1757a3d991bdSwdenk of the device. 1758a3d991bdSwdenk 1759a3d991bdSwdenk CONFIG_CDP_PORT_ID 1760a3d991bdSwdenk 1761a3d991bdSwdenk A printf format string which contains the ascii name of 1762a3d991bdSwdenk the port. Normally is set to "eth%d" which sets 176311ccc33fSMarcel Ziswiler eth0 for the first Ethernet, eth1 for the second etc. 1764a3d991bdSwdenk 1765a3d991bdSwdenk CONFIG_CDP_CAPABILITIES 1766a3d991bdSwdenk 1767a3d991bdSwdenk A 32bit integer which indicates the device capabilities; 1768a3d991bdSwdenk 0x00000010 for a normal host which does not forwards. 1769a3d991bdSwdenk 1770a3d991bdSwdenk CONFIG_CDP_VERSION 1771a3d991bdSwdenk 1772a3d991bdSwdenk An ascii string containing the version of the software. 1773a3d991bdSwdenk 1774a3d991bdSwdenk CONFIG_CDP_PLATFORM 1775a3d991bdSwdenk 1776a3d991bdSwdenk An ascii string containing the name of the platform. 1777a3d991bdSwdenk 1778a3d991bdSwdenk CONFIG_CDP_TRIGGER 1779a3d991bdSwdenk 1780a3d991bdSwdenk A 32bit integer sent on the trigger. 1781a3d991bdSwdenk 1782a3d991bdSwdenk CONFIG_CDP_POWER_CONSUMPTION 1783a3d991bdSwdenk 1784a3d991bdSwdenk A 16bit integer containing the power consumption of the 1785a3d991bdSwdenk device in .1 of milliwatts. 1786a3d991bdSwdenk 1787a3d991bdSwdenk CONFIG_CDP_APPLIANCE_VLAN_TYPE 1788a3d991bdSwdenk 1789a3d991bdSwdenk A byte containing the id of the VLAN. 1790a3d991bdSwdenk 1791c609719bSwdenk- Status LED: CONFIG_STATUS_LED 1792c609719bSwdenk 1793c609719bSwdenk Several configurations allow to display the current 1794c609719bSwdenk status using a LED. For instance, the LED will blink 1795c609719bSwdenk fast while running U-Boot code, stop blinking as 1796c609719bSwdenk soon as a reply to a BOOTP request was received, and 1797c609719bSwdenk start blinking slow once the Linux kernel is running 1798c609719bSwdenk (supported by a status LED driver in the Linux 1799c609719bSwdenk kernel). Defining CONFIG_STATUS_LED enables this 1800c609719bSwdenk feature in U-Boot. 1801c609719bSwdenk 1802c609719bSwdenk- CAN Support: CONFIG_CAN_DRIVER 1803c609719bSwdenk 1804c609719bSwdenk Defining CONFIG_CAN_DRIVER enables CAN driver support 1805c609719bSwdenk on those systems that support this (optional) 1806c609719bSwdenk feature, like the TQM8xxL modules. 1807c609719bSwdenk 1808c609719bSwdenk- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C 1809c609719bSwdenk 1810b37c7e5eSwdenk These enable I2C serial bus commands. Defining either of 1811b37c7e5eSwdenk (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will 181211ccc33fSMarcel Ziswiler include the appropriate I2C driver for the selected CPU. 1813c609719bSwdenk 1814b37c7e5eSwdenk This will allow you to use i2c commands at the u-boot 1815602ad3b3SJon Loeliger command line (as long as you set CONFIG_CMD_I2C in 1816b37c7e5eSwdenk CONFIG_COMMANDS) and communicate with i2c based realtime 1817b37c7e5eSwdenk clock chips. See common/cmd_i2c.c for a description of the 1818c609719bSwdenk command line interface. 1819c609719bSwdenk 1820bb99ad6dSBen Warren CONFIG_HARD_I2C selects a hardware I2C controller. 1821c609719bSwdenk 1822b37c7e5eSwdenk CONFIG_SOFT_I2C configures u-boot to use a software (aka 1823b37c7e5eSwdenk bit-banging) driver instead of CPM or similar hardware 1824b37c7e5eSwdenk support for I2C. 1825c609719bSwdenk 1826b37c7e5eSwdenk There are several other quantities that must also be 1827b37c7e5eSwdenk defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C. 1828c609719bSwdenk 18296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD In both cases you will need to define CONFIG_SYS_I2C_SPEED 1830b37c7e5eSwdenk to be the frequency (in Hz) at which you wish your i2c bus 18316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie 183211ccc33fSMarcel Ziswiler the CPU's i2c node address). 1833c609719bSwdenk 18348d321b81SPeter Tyser Now, the u-boot i2c code for the mpc8xx 1835a47a12beSStefan Roese (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node 18368d321b81SPeter Tyser and so its address should therefore be cleared to 0 (See, 18378d321b81SPeter Tyser eg, MPC823e User's Manual p.16-473). So, set 18388d321b81SPeter Tyser CONFIG_SYS_I2C_SLAVE to 0. 1839b37c7e5eSwdenk 18405da71efaSEric Millbrandt CONFIG_SYS_I2C_INIT_MPC5XXX 18415da71efaSEric Millbrandt 18425da71efaSEric Millbrandt When a board is reset during an i2c bus transfer 18435da71efaSEric Millbrandt chips might think that the current transfer is still 18445da71efaSEric Millbrandt in progress. Reset the slave devices by sending start 18455da71efaSEric Millbrandt commands until the slave device responds. 18465da71efaSEric Millbrandt 1847b37c7e5eSwdenk That's all that's required for CONFIG_HARD_I2C. 1848b37c7e5eSwdenk 1849b37c7e5eSwdenk If you use the software i2c interface (CONFIG_SOFT_I2C) 1850b37c7e5eSwdenk then the following macros need to be defined (examples are 1851b37c7e5eSwdenk from include/configs/lwmon.h): 1852c609719bSwdenk 1853c609719bSwdenk I2C_INIT 1854c609719bSwdenk 1855b37c7e5eSwdenk (Optional). Any commands necessary to enable the I2C 1856c609719bSwdenk controller or configure ports. 1857c609719bSwdenk 1858b37c7e5eSwdenk eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL) 1859b37c7e5eSwdenk 1860c609719bSwdenk I2C_PORT 1861c609719bSwdenk 1862c609719bSwdenk (Only for MPC8260 CPU). The I/O port to use (the code 1863c609719bSwdenk assumes both bits are on the same port). Valid values 1864c609719bSwdenk are 0..3 for ports A..D. 1865c609719bSwdenk 1866c609719bSwdenk I2C_ACTIVE 1867c609719bSwdenk 1868c609719bSwdenk The code necessary to make the I2C data line active 1869c609719bSwdenk (driven). If the data line is open collector, this 1870c609719bSwdenk define can be null. 1871c609719bSwdenk 1872b37c7e5eSwdenk eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA) 1873b37c7e5eSwdenk 1874c609719bSwdenk I2C_TRISTATE 1875c609719bSwdenk 1876c609719bSwdenk The code necessary to make the I2C data line tri-stated 1877c609719bSwdenk (inactive). If the data line is open collector, this 1878c609719bSwdenk define can be null. 1879c609719bSwdenk 1880b37c7e5eSwdenk eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA) 1881b37c7e5eSwdenk 1882c609719bSwdenk I2C_READ 1883c609719bSwdenk 1884c609719bSwdenk Code that returns TRUE if the I2C data line is high, 1885c609719bSwdenk FALSE if it is low. 1886c609719bSwdenk 1887b37c7e5eSwdenk eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0) 1888b37c7e5eSwdenk 1889c609719bSwdenk I2C_SDA(bit) 1890c609719bSwdenk 1891c609719bSwdenk If <bit> is TRUE, sets the I2C data line high. If it 1892c609719bSwdenk is FALSE, it clears it (low). 1893c609719bSwdenk 1894b37c7e5eSwdenk eg: #define I2C_SDA(bit) \ 1895b37c7e5eSwdenk if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \ 1896b37c7e5eSwdenk else immr->im_cpm.cp_pbdat &= ~PB_SDA 1897b37c7e5eSwdenk 1898c609719bSwdenk I2C_SCL(bit) 1899c609719bSwdenk 1900c609719bSwdenk If <bit> is TRUE, sets the I2C clock line high. If it 1901c609719bSwdenk is FALSE, it clears it (low). 1902c609719bSwdenk 1903b37c7e5eSwdenk eg: #define I2C_SCL(bit) \ 1904b37c7e5eSwdenk if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \ 1905b37c7e5eSwdenk else immr->im_cpm.cp_pbdat &= ~PB_SCL 1906b37c7e5eSwdenk 1907c609719bSwdenk I2C_DELAY 1908c609719bSwdenk 1909c609719bSwdenk This delay is invoked four times per clock cycle so this 1910c609719bSwdenk controls the rate of data transfer. The data rate thus 1911b37c7e5eSwdenk is 1 / (I2C_DELAY * 4). Often defined to be something 1912b37c7e5eSwdenk like: 1913b37c7e5eSwdenk 1914b37c7e5eSwdenk #define I2C_DELAY udelay(2) 1915c609719bSwdenk 1916793b5726SMike Frysinger CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA 1917793b5726SMike Frysinger 1918793b5726SMike Frysinger If your arch supports the generic GPIO framework (asm/gpio.h), 1919793b5726SMike Frysinger then you may alternatively define the two GPIOs that are to be 1920793b5726SMike Frysinger used as SCL / SDA. Any of the previous I2C_xxx macros will 1921793b5726SMike Frysinger have GPIO-based defaults assigned to them as appropriate. 1922793b5726SMike Frysinger 1923793b5726SMike Frysinger You should define these to the GPIO value as given directly to 1924793b5726SMike Frysinger the generic GPIO functions. 1925793b5726SMike Frysinger 19266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_INIT_BOARD 192747cd00faSwdenk 192847cd00faSwdenk When a board is reset during an i2c bus transfer 192947cd00faSwdenk chips might think that the current transfer is still 193047cd00faSwdenk in progress. On some boards it is possible to access 193147cd00faSwdenk the i2c SCLK line directly, either by using the 193247cd00faSwdenk processor pin as a GPIO or by having a second pin 193347cd00faSwdenk connected to the bus. If this option is defined a 193447cd00faSwdenk custom i2c_init_board() routine in boards/xxx/board.c 193547cd00faSwdenk is run early in the boot sequence. 193647cd00faSwdenk 193726a33504SRichard Retanubun CONFIG_SYS_I2C_BOARD_LATE_INIT 193826a33504SRichard Retanubun 193926a33504SRichard Retanubun An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is 194026a33504SRichard Retanubun defined a custom i2c_board_late_init() routine in 194126a33504SRichard Retanubun boards/xxx/board.c is run AFTER the operations in i2c_init() 194226a33504SRichard Retanubun is completed. This callpoint can be used to unreset i2c bus 194326a33504SRichard Retanubun using CPU i2c controller register accesses for CPUs whose i2c 194426a33504SRichard Retanubun controller provide such a method. It is called at the end of 194526a33504SRichard Retanubun i2c_init() to allow i2c_init operations to setup the i2c bus 194626a33504SRichard Retanubun controller on the CPU (e.g. setting bus speed & slave address). 194726a33504SRichard Retanubun 194817ea1177Swdenk CONFIG_I2CFAST (PPC405GP|PPC405EP only) 194917ea1177Swdenk 195017ea1177Swdenk This option enables configuration of bi_iic_fast[] flags 195117ea1177Swdenk in u-boot bd_info structure based on u-boot environment 195217ea1177Swdenk variable "i2cfast". (see also i2cfast) 195317ea1177Swdenk 1954bb99ad6dSBen Warren CONFIG_I2C_MULTI_BUS 1955bb99ad6dSBen Warren 1956bb99ad6dSBen Warren This option allows the use of multiple I2C buses, each of which 1957bb99ad6dSBen Warren must have a controller. At any point in time, only one bus is 1958bb99ad6dSBen Warren active. To switch to a different bus, use the 'i2c dev' command. 1959bb99ad6dSBen Warren Note that bus numbering is zero-based. 1960bb99ad6dSBen Warren 19616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_NOPROBES 1962bb99ad6dSBen Warren 1963bb99ad6dSBen Warren This option specifies a list of I2C devices that will be skipped 19640f89c54bSPeter Tyser when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS 19650f89c54bSPeter Tyser is set, specify a list of bus-device pairs. Otherwise, specify 19660f89c54bSPeter Tyser a 1D array of device addresses 1967bb99ad6dSBen Warren 1968bb99ad6dSBen Warren e.g. 1969bb99ad6dSBen Warren #undef CONFIG_I2C_MULTI_BUS 19706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68} 1971bb99ad6dSBen Warren 1972bb99ad6dSBen Warren will skip addresses 0x50 and 0x68 on a board with one I2C bus 1973bb99ad6dSBen Warren 1974bb99ad6dSBen Warren #define CONFIG_I2C_MULTI_BUS 19756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}} 1976bb99ad6dSBen Warren 1977bb99ad6dSBen Warren will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1 1978bb99ad6dSBen Warren 19796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SPD_BUS_NUM 1980be5e6181STimur Tabi 1981be5e6181STimur Tabi If defined, then this indicates the I2C bus number for DDR SPD. 1982be5e6181STimur Tabi If not defined, then U-Boot assumes that SPD is on I2C bus 0. 1983be5e6181STimur Tabi 19846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_RTC_BUS_NUM 19850dc018ecSStefan Roese 19860dc018ecSStefan Roese If defined, then this indicates the I2C bus number for the RTC. 19870dc018ecSStefan Roese If not defined, then U-Boot assumes that RTC is on I2C bus 0. 19880dc018ecSStefan Roese 19896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_DTT_BUS_NUM 19900dc018ecSStefan Roese 19910dc018ecSStefan Roese If defined, then this indicates the I2C bus number for the DTT. 19920dc018ecSStefan Roese If not defined, then U-Boot assumes that DTT is on I2C bus 0. 19930dc018ecSStefan Roese 19946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_DTT_ADDR: 19959ebbb54fSVictor Gallardo 19969ebbb54fSVictor Gallardo If defined, specifies the I2C address of the DTT device. 19979ebbb54fSVictor Gallardo If not defined, then U-Boot uses predefined value for 19989ebbb54fSVictor Gallardo specified DTT device. 19999ebbb54fSVictor Gallardo 2000be5e6181STimur Tabi CONFIG_FSL_I2C 2001be5e6181STimur Tabi 2002be5e6181STimur Tabi Define this option if you want to use Freescale's I2C driver in 20037817cb20SMarcel Ziswiler drivers/i2c/fsl_i2c.c. 2004be5e6181STimur Tabi 200567b23a32SHeiko Schocher CONFIG_I2C_MUX 200667b23a32SHeiko Schocher 200767b23a32SHeiko Schocher Define this option if you have I2C devices reached over 1 .. n 200867b23a32SHeiko Schocher I2C Muxes like the pca9544a. This option addes a new I2C 200967b23a32SHeiko Schocher Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a 201067b23a32SHeiko Schocher new I2C Bus to the existing I2C Busses. If you select the 201167b23a32SHeiko Schocher new Bus with "i2c dev", u-bbot sends first the commandos for 201267b23a32SHeiko Schocher the muxes to activate this new "bus". 201367b23a32SHeiko Schocher 201467b23a32SHeiko Schocher CONFIG_I2C_MULTI_BUS must be also defined, to use this 201567b23a32SHeiko Schocher feature! 201667b23a32SHeiko Schocher 201767b23a32SHeiko Schocher Example: 201867b23a32SHeiko Schocher Adding a new I2C Bus reached over 2 pca9544a muxes 201967b23a32SHeiko Schocher The First mux with address 70 and channel 6 202067b23a32SHeiko Schocher The Second mux with address 71 and channel 4 202167b23a32SHeiko Schocher 202267b23a32SHeiko Schocher => i2c bus pca9544a:70:6:pca9544a:71:4 202367b23a32SHeiko Schocher 202467b23a32SHeiko Schocher Use the "i2c bus" command without parameter, to get a list 202567b23a32SHeiko Schocher of I2C Busses with muxes: 202667b23a32SHeiko Schocher 202767b23a32SHeiko Schocher => i2c bus 202867b23a32SHeiko Schocher Busses reached over muxes: 202967b23a32SHeiko Schocher Bus ID: 2 203067b23a32SHeiko Schocher reached over Mux(es): 203167b23a32SHeiko Schocher pca9544a@70 ch: 4 203267b23a32SHeiko Schocher Bus ID: 3 203367b23a32SHeiko Schocher reached over Mux(es): 203467b23a32SHeiko Schocher pca9544a@70 ch: 6 203567b23a32SHeiko Schocher pca9544a@71 ch: 4 203667b23a32SHeiko Schocher => 203767b23a32SHeiko Schocher 203867b23a32SHeiko Schocher If you now switch to the new I2C Bus 3 with "i2c dev 3" 2039f9a78b8dSMichael Jones u-boot first sends the command to the mux@70 to enable 2040f9a78b8dSMichael Jones channel 6, and then the command to the mux@71 to enable 204167b23a32SHeiko Schocher the channel 4. 204267b23a32SHeiko Schocher 204367b23a32SHeiko Schocher After that, you can use the "normal" i2c commands as 2044f9a78b8dSMichael Jones usual to communicate with your I2C devices behind 204567b23a32SHeiko Schocher the 2 muxes. 204667b23a32SHeiko Schocher 204767b23a32SHeiko Schocher This option is actually implemented for the bitbanging 204867b23a32SHeiko Schocher algorithm in common/soft_i2c.c and for the Hardware I2C 204967b23a32SHeiko Schocher Bus on the MPC8260. But it should be not so difficult 205067b23a32SHeiko Schocher to add this option to other architectures. 205167b23a32SHeiko Schocher 20522ac6985aSAndrew Dyer CONFIG_SOFT_I2C_READ_REPEATED_START 20532ac6985aSAndrew Dyer 20542ac6985aSAndrew Dyer defining this will force the i2c_read() function in 20552ac6985aSAndrew Dyer the soft_i2c driver to perform an I2C repeated start 20562ac6985aSAndrew Dyer between writing the address pointer and reading the 20572ac6985aSAndrew Dyer data. If this define is omitted the default behaviour 20582ac6985aSAndrew Dyer of doing a stop-start sequence will be used. Most I2C 20592ac6985aSAndrew Dyer devices can use either method, but some require one or 20602ac6985aSAndrew Dyer the other. 2061be5e6181STimur Tabi 2062c609719bSwdenk- SPI Support: CONFIG_SPI 2063c609719bSwdenk 2064c609719bSwdenk Enables SPI driver (so far only tested with 2065c609719bSwdenk SPI EEPROM, also an instance works with Crystal A/D and 2066c609719bSwdenk D/As on the SACSng board) 2067c609719bSwdenk 20686639562eSYoshihiro Shimoda CONFIG_SH_SPI 20696639562eSYoshihiro Shimoda 20706639562eSYoshihiro Shimoda Enables the driver for SPI controller on SuperH. Currently 20716639562eSYoshihiro Shimoda only SH7757 is supported. 20726639562eSYoshihiro Shimoda 2073c609719bSwdenk CONFIG_SPI_X 2074c609719bSwdenk 2075c609719bSwdenk Enables extended (16-bit) SPI EEPROM addressing. 2076c609719bSwdenk (symmetrical to CONFIG_I2C_X) 2077c609719bSwdenk 2078c609719bSwdenk CONFIG_SOFT_SPI 2079c609719bSwdenk 2080c609719bSwdenk Enables a software (bit-bang) SPI driver rather than 2081c609719bSwdenk using hardware support. This is a general purpose 2082c609719bSwdenk driver that only requires three general I/O port pins 2083c609719bSwdenk (two outputs, one input) to function. If this is 2084c609719bSwdenk defined, the board configuration must define several 2085c609719bSwdenk SPI configuration items (port pins to use, etc). For 2086c609719bSwdenk an example, see include/configs/sacsng.h. 2087c609719bSwdenk 208804a9e118SBen Warren CONFIG_HARD_SPI 208904a9e118SBen Warren 209004a9e118SBen Warren Enables a hardware SPI driver for general-purpose reads 209104a9e118SBen Warren and writes. As with CONFIG_SOFT_SPI, the board configuration 209204a9e118SBen Warren must define a list of chip-select function pointers. 209304a9e118SBen Warren Currently supported on some MPC8xxx processors. For an 209404a9e118SBen Warren example, see include/configs/mpc8349emds.h. 209504a9e118SBen Warren 209638254f45SGuennadi Liakhovetski CONFIG_MXC_SPI 209738254f45SGuennadi Liakhovetski 209838254f45SGuennadi Liakhovetski Enables the driver for the SPI controllers on i.MX and MXC 20992e3cd1cdSFabio Estevam SoCs. Currently i.MX31/35/51 are supported. 210038254f45SGuennadi Liakhovetski 21010133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA 21020133502eSMatthias Fuchs 21030133502eSMatthias Fuchs Enables FPGA subsystem. 21040133502eSMatthias Fuchs 21050133502eSMatthias Fuchs CONFIG_FPGA_<vendor> 21060133502eSMatthias Fuchs 21070133502eSMatthias Fuchs Enables support for specific chip vendors. 21080133502eSMatthias Fuchs (ALTERA, XILINX) 21090133502eSMatthias Fuchs 21100133502eSMatthias Fuchs CONFIG_FPGA_<family> 21110133502eSMatthias Fuchs 21120133502eSMatthias Fuchs Enables support for FPGA family. 21130133502eSMatthias Fuchs (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX) 21140133502eSMatthias Fuchs 21150133502eSMatthias Fuchs CONFIG_FPGA_COUNT 2116c609719bSwdenk 2117c609719bSwdenk Specify the number of FPGA devices to support. 2118c609719bSwdenk 21196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_PROG_FEEDBACK 2120c609719bSwdenk 2121c609719bSwdenk Enable printing of hash marks during FPGA configuration. 2122c609719bSwdenk 21236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_BUSY 2124c609719bSwdenk 2125c609719bSwdenk Enable checks on FPGA configuration interface busy 2126c609719bSwdenk status by the configuration function. This option 2127c609719bSwdenk will require a board or device specific function to 2128c609719bSwdenk be written. 2129c609719bSwdenk 2130c609719bSwdenk CONFIG_FPGA_DELAY 2131c609719bSwdenk 2132c609719bSwdenk If defined, a function that provides delays in the FPGA 2133c609719bSwdenk configuration driver. 2134c609719bSwdenk 21356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_CTRLC 2136c609719bSwdenk Allow Control-C to interrupt FPGA configuration 2137c609719bSwdenk 21386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_ERROR 2139c609719bSwdenk 2140c609719bSwdenk Check for configuration errors during FPGA bitfile 2141c609719bSwdenk loading. For example, abort during Virtex II 2142c609719bSwdenk configuration if the INIT_B line goes low (which 2143c609719bSwdenk indicated a CRC error). 2144c609719bSwdenk 21456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_INIT 2146c609719bSwdenk 2147c609719bSwdenk Maximum time to wait for the INIT_B line to deassert 2148c609719bSwdenk after PROB_B has been deasserted during a Virtex II 2149c609719bSwdenk FPGA configuration sequence. The default time is 500 215011ccc33fSMarcel Ziswiler ms. 2151c609719bSwdenk 21526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_BUSY 2153c609719bSwdenk 2154c609719bSwdenk Maximum time to wait for BUSY to deassert during 215511ccc33fSMarcel Ziswiler Virtex II FPGA configuration. The default is 5 ms. 2156c609719bSwdenk 21576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_CONFIG 2158c609719bSwdenk 2159c609719bSwdenk Time to wait after FPGA configuration. The default is 216011ccc33fSMarcel Ziswiler 200 ms. 2161c609719bSwdenk 2162c609719bSwdenk- Configuration Management: 2163c609719bSwdenk CONFIG_IDENT_STRING 2164c609719bSwdenk 2165c609719bSwdenk If defined, this string will be added to the U-Boot 2166c609719bSwdenk version information (U_BOOT_VERSION) 2167c609719bSwdenk 2168c609719bSwdenk- Vendor Parameter Protection: 2169c609719bSwdenk 2170c609719bSwdenk U-Boot considers the values of the environment 2171c609719bSwdenk variables "serial#" (Board Serial Number) and 21727152b1d0Swdenk "ethaddr" (Ethernet Address) to be parameters that 2173c609719bSwdenk are set once by the board vendor / manufacturer, and 2174c609719bSwdenk protects these variables from casual modification by 2175c609719bSwdenk the user. Once set, these variables are read-only, 2176c609719bSwdenk and write or delete attempts are rejected. You can 217711ccc33fSMarcel Ziswiler change this behaviour: 2178c609719bSwdenk 2179c609719bSwdenk If CONFIG_ENV_OVERWRITE is #defined in your config 2180c609719bSwdenk file, the write protection for vendor parameters is 218147cd00faSwdenk completely disabled. Anybody can change or delete 2182c609719bSwdenk these parameters. 2183c609719bSwdenk 2184c609719bSwdenk Alternatively, if you #define _both_ CONFIG_ETHADDR 2185c609719bSwdenk _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default 218611ccc33fSMarcel Ziswiler Ethernet address is installed in the environment, 2187c609719bSwdenk which can be changed exactly ONCE by the user. [The 2188c609719bSwdenk serial# is unaffected by this, i. e. it remains 2189c609719bSwdenk read-only.] 2190c609719bSwdenk 2191c609719bSwdenk- Protected RAM: 2192c609719bSwdenk CONFIG_PRAM 2193c609719bSwdenk 2194c609719bSwdenk Define this variable to enable the reservation of 2195c609719bSwdenk "protected RAM", i. e. RAM which is not overwritten 2196c609719bSwdenk by U-Boot. Define CONFIG_PRAM to hold the number of 2197c609719bSwdenk kB you want to reserve for pRAM. You can overwrite 2198c609719bSwdenk this default value by defining an environment 2199c609719bSwdenk variable "pram" to the number of kB you want to 2200c609719bSwdenk reserve. Note that the board info structure will 2201c609719bSwdenk still show the full amount of RAM. If pRAM is 2202c609719bSwdenk reserved, a new environment variable "mem" will 2203c609719bSwdenk automatically be defined to hold the amount of 2204c609719bSwdenk remaining RAM in a form that can be passed as boot 2205c609719bSwdenk argument to Linux, for instance like that: 2206c609719bSwdenk 2207fe126d8bSWolfgang Denk setenv bootargs ... mem=\${mem} 2208c609719bSwdenk saveenv 2209c609719bSwdenk 2210c609719bSwdenk This way you can tell Linux not to use this memory, 2211c609719bSwdenk either, which results in a memory region that will 2212c609719bSwdenk not be affected by reboots. 2213c609719bSwdenk 2214c609719bSwdenk *WARNING* If your board configuration uses automatic 2215c609719bSwdenk detection of the RAM size, you must make sure that 2216c609719bSwdenk this memory test is non-destructive. So far, the 2217c609719bSwdenk following board configurations are known to be 2218c609719bSwdenk "pRAM-clean": 2219c609719bSwdenk 22201b0757ecSWolfgang Denk IVMS8, IVML24, SPD8xx, TQM8xxL, 22211b0757ecSWolfgang Denk HERMES, IP860, RPXlite, LWMON, 2222544d97e9SWolfgang Denk FLAGADM, TQM8260 2223c609719bSwdenk 222440fef049SGabe Black- Access to physical memory region (> 4GB) 222540fef049SGabe Black Some basic support is provided for operations on memory not 222640fef049SGabe Black normally accessible to U-Boot - e.g. some architectures 222740fef049SGabe Black support access to more than 4GB of memory on 32-bit 222840fef049SGabe Black machines using physical address extension or similar. 222940fef049SGabe Black Define CONFIG_PHYSMEM to access this basic support, which 223040fef049SGabe Black currently only supports clearing the memory. 223140fef049SGabe Black 2232c609719bSwdenk- Error Recovery: 2233c609719bSwdenk CONFIG_PANIC_HANG 2234c609719bSwdenk 2235c609719bSwdenk Define this variable to stop the system in case of a 2236c609719bSwdenk fatal error, so that you have to reset it manually. 2237c609719bSwdenk This is probably NOT a good idea for an embedded 223811ccc33fSMarcel Ziswiler system where you want the system to reboot 2239c609719bSwdenk automatically as fast as possible, but it may be 2240c609719bSwdenk useful during development since you can try to debug 2241c609719bSwdenk the conditions that lead to the situation. 2242c609719bSwdenk 2243c609719bSwdenk CONFIG_NET_RETRY_COUNT 2244c609719bSwdenk 2245c609719bSwdenk This variable defines the number of retries for 2246c609719bSwdenk network operations like ARP, RARP, TFTP, or BOOTP 2247c609719bSwdenk before giving up the operation. If not defined, a 2248c609719bSwdenk default value of 5 is used. 2249c609719bSwdenk 225040cb90eeSGuennadi Liakhovetski CONFIG_ARP_TIMEOUT 225140cb90eeSGuennadi Liakhovetski 225240cb90eeSGuennadi Liakhovetski Timeout waiting for an ARP reply in milliseconds. 225340cb90eeSGuennadi Liakhovetski 225448a3e999STetsuyuki Kobayashi CONFIG_NFS_TIMEOUT 225548a3e999STetsuyuki Kobayashi 225648a3e999STetsuyuki Kobayashi Timeout in milliseconds used in NFS protocol. 225748a3e999STetsuyuki Kobayashi If you encounter "ERROR: Cannot umount" in nfs command, 225848a3e999STetsuyuki Kobayashi try longer timeout such as 225948a3e999STetsuyuki Kobayashi #define CONFIG_NFS_TIMEOUT 10000UL 226048a3e999STetsuyuki Kobayashi 2261c609719bSwdenk- Command Interpreter: 22628078f1a5SWolfgang Denk CONFIG_AUTO_COMPLETE 226304a85b3bSwdenk 226404a85b3bSwdenk Enable auto completion of commands using TAB. 226504a85b3bSwdenk 22668078f1a5SWolfgang Denk Note that this feature has NOT been implemented yet 22678078f1a5SWolfgang Denk for the "hush" shell. 22688078f1a5SWolfgang Denk 22698078f1a5SWolfgang Denk 22706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_HUSH_PARSER 2271c609719bSwdenk 2272c609719bSwdenk Define this variable to enable the "hush" shell (from 2273c609719bSwdenk Busybox) as command line interpreter, thus enabling 2274c609719bSwdenk powerful command line syntax like 2275c609719bSwdenk if...then...else...fi conditionals or `&&' and '||' 2276c609719bSwdenk constructs ("shell scripts"). 2277c609719bSwdenk 2278c609719bSwdenk If undefined, you get the old, much simpler behaviour 2279c609719bSwdenk with a somewhat smaller memory footprint. 2280c609719bSwdenk 2281c609719bSwdenk 22826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PROMPT_HUSH_PS2 2283c609719bSwdenk 2284c609719bSwdenk This defines the secondary prompt string, which is 2285c609719bSwdenk printed when the command interpreter needs more input 2286c609719bSwdenk to complete a command. Usually "> ". 2287c609719bSwdenk 2288c609719bSwdenk Note: 2289c609719bSwdenk 2290c609719bSwdenk In the current implementation, the local variables 2291c609719bSwdenk space and global environment variables space are 2292c609719bSwdenk separated. Local variables are those you define by 22933b57fe0aSwdenk simply typing `name=value'. To access a local 2294c609719bSwdenk variable later on, you have write `$name' or 22953b57fe0aSwdenk `${name}'; to execute the contents of a variable 22963b57fe0aSwdenk directly type `$name' at the command prompt. 2297c609719bSwdenk 2298c609719bSwdenk Global environment variables are those you use 2299c609719bSwdenk setenv/printenv to work with. To run a command stored 2300c609719bSwdenk in such a variable, you need to use the run command, 2301c609719bSwdenk and you must not use the '$' sign to access them. 2302c609719bSwdenk 2303c609719bSwdenk To store commands and special characters in a 2304c609719bSwdenk variable, please use double quotation marks 2305c609719bSwdenk surrounding the whole text of the variable, instead 2306c609719bSwdenk of the backslashes before semicolons and special 2307c609719bSwdenk symbols. 2308c609719bSwdenk 2309aa0c71acSWolfgang Denk- Commandline Editing and History: 2310aa0c71acSWolfgang Denk CONFIG_CMDLINE_EDITING 2311aa0c71acSWolfgang Denk 231211ccc33fSMarcel Ziswiler Enable editing and History functions for interactive 2313aa0c71acSWolfgang Denk commandline input operations 2314aa0c71acSWolfgang Denk 2315a8c7c708Swdenk- Default Environment: 2316c609719bSwdenk CONFIG_EXTRA_ENV_SETTINGS 2317c609719bSwdenk 2318c609719bSwdenk Define this to contain any number of null terminated 2319c609719bSwdenk strings (variable = value pairs) that will be part of 23207152b1d0Swdenk the default environment compiled into the boot image. 23212262cfeeSwdenk 2322c609719bSwdenk For example, place something like this in your 2323c609719bSwdenk board's config file: 2324c609719bSwdenk 2325c609719bSwdenk #define CONFIG_EXTRA_ENV_SETTINGS \ 2326c609719bSwdenk "myvar1=value1\0" \ 2327c609719bSwdenk "myvar2=value2\0" 2328c609719bSwdenk 2329c609719bSwdenk Warning: This method is based on knowledge about the 2330c609719bSwdenk internal format how the environment is stored by the 23312262cfeeSwdenk U-Boot code. This is NOT an official, exported 2332c609719bSwdenk interface! Although it is unlikely that this format 23337152b1d0Swdenk will change soon, there is no guarantee either. 2334c609719bSwdenk You better know what you are doing here. 2335c609719bSwdenk 2336c609719bSwdenk Note: overly (ab)use of the default environment is 2337c609719bSwdenk discouraged. Make sure to check other ways to preset 233874de7aefSWolfgang Denk the environment like the "source" command or the 2339c609719bSwdenk boot command first. 2340c609719bSwdenk 23415e724ca2SStephen Warren CONFIG_ENV_VARS_UBOOT_CONFIG 23425e724ca2SStephen Warren 23435e724ca2SStephen Warren Define this in order to add variables describing the 23445e724ca2SStephen Warren U-Boot build configuration to the default environment. 23455e724ca2SStephen Warren These will be named arch, cpu, board, vendor, and soc. 23465e724ca2SStephen Warren 23475e724ca2SStephen Warren Enabling this option will cause the following to be defined: 23485e724ca2SStephen Warren 23495e724ca2SStephen Warren - CONFIG_SYS_ARCH 23505e724ca2SStephen Warren - CONFIG_SYS_CPU 23515e724ca2SStephen Warren - CONFIG_SYS_BOARD 23525e724ca2SStephen Warren - CONFIG_SYS_VENDOR 23535e724ca2SStephen Warren - CONFIG_SYS_SOC 23545e724ca2SStephen Warren 23557e27f89fSTom Rini CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG 23567e27f89fSTom Rini 23577e27f89fSTom Rini Define this in order to add variables describing certain 23587e27f89fSTom Rini run-time determined information about the hardware to the 23597e27f89fSTom Rini environment. These will be named board_name, board_rev. 23607e27f89fSTom Rini 2361a8c7c708Swdenk- DataFlash Support: 23622abbe075Swdenk CONFIG_HAS_DATAFLASH 23632abbe075Swdenk 23642abbe075Swdenk Defining this option enables DataFlash features and 23652abbe075Swdenk allows to read/write in Dataflash via the standard 23662abbe075Swdenk commands cp, md... 23672abbe075Swdenk 2368f61ec45eSEric Nelson- Serial Flash support 2369f61ec45eSEric Nelson CONFIG_CMD_SF 2370f61ec45eSEric Nelson 2371f61ec45eSEric Nelson Defining this option enables SPI flash commands 2372f61ec45eSEric Nelson 'sf probe/read/write/erase/update'. 2373f61ec45eSEric Nelson 2374f61ec45eSEric Nelson Usage requires an initial 'probe' to define the serial 2375f61ec45eSEric Nelson flash parameters, followed by read/write/erase/update 2376f61ec45eSEric Nelson commands. 2377f61ec45eSEric Nelson 2378f61ec45eSEric Nelson The following defaults may be provided by the platform 2379f61ec45eSEric Nelson to handle the common case when only a single serial 2380f61ec45eSEric Nelson flash is present on the system. 2381f61ec45eSEric Nelson 2382f61ec45eSEric Nelson CONFIG_SF_DEFAULT_BUS Bus identifier 2383f61ec45eSEric Nelson CONFIG_SF_DEFAULT_CS Chip-select 2384f61ec45eSEric Nelson CONFIG_SF_DEFAULT_MODE (see include/spi.h) 2385f61ec45eSEric Nelson CONFIG_SF_DEFAULT_SPEED in Hz 2386f61ec45eSEric Nelson 23873f85ce27Swdenk- SystemACE Support: 23883f85ce27Swdenk CONFIG_SYSTEMACE 23893f85ce27Swdenk 23903f85ce27Swdenk Adding this option adds support for Xilinx SystemACE 23913f85ce27Swdenk chips attached via some sort of local bus. The address 239211ccc33fSMarcel Ziswiler of the chip must also be defined in the 23936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SYSTEMACE_BASE macro. For example: 23943f85ce27Swdenk 23953f85ce27Swdenk #define CONFIG_SYSTEMACE 23966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000 23973f85ce27Swdenk 23983f85ce27Swdenk When SystemACE support is added, the "ace" device type 23993f85ce27Swdenk becomes available to the fat commands, i.e. fatls. 24003f85ce27Swdenk 2401ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port: 2402ecb0ccd9SWolfgang Denk CONFIG_TFTP_PORT 2403ecb0ccd9SWolfgang Denk 240428cb9375SWolfgang Denk If this is defined, the environment variable tftpsrcp 2405ecb0ccd9SWolfgang Denk is used to supply the TFTP UDP source port value. 240628cb9375SWolfgang Denk If tftpsrcp isn't defined, the normal pseudo-random port 2407ecb0ccd9SWolfgang Denk number generator is used. 2408ecb0ccd9SWolfgang Denk 240928cb9375SWolfgang Denk Also, the environment variable tftpdstp is used to supply 241028cb9375SWolfgang Denk the TFTP UDP destination port value. If tftpdstp isn't 241128cb9375SWolfgang Denk defined, the normal port 69 is used. 241228cb9375SWolfgang Denk 241328cb9375SWolfgang Denk The purpose for tftpsrcp is to allow a TFTP server to 2414ecb0ccd9SWolfgang Denk blindly start the TFTP transfer using the pre-configured 2415ecb0ccd9SWolfgang Denk target IP address and UDP port. This has the effect of 2416ecb0ccd9SWolfgang Denk "punching through" the (Windows XP) firewall, allowing 2417ecb0ccd9SWolfgang Denk the remainder of the TFTP transfer to proceed normally. 2418ecb0ccd9SWolfgang Denk A better solution is to properly configure the firewall, 2419ecb0ccd9SWolfgang Denk but sometimes that is not allowed. 2420ecb0ccd9SWolfgang Denk 2421bf36c5d5SSimon Glass- Hashing support: 2422bf36c5d5SSimon Glass CONFIG_CMD_HASH 2423bf36c5d5SSimon Glass 2424bf36c5d5SSimon Glass This enables a generic 'hash' command which can produce 2425bf36c5d5SSimon Glass hashes / digests from a few algorithms (e.g. SHA1, SHA256). 2426bf36c5d5SSimon Glass 2427bf36c5d5SSimon Glass CONFIG_HASH_VERIFY 2428bf36c5d5SSimon Glass 2429bf36c5d5SSimon Glass Enable the hash verify command (hash -v). This adds to code 2430bf36c5d5SSimon Glass size a little. 2431bf36c5d5SSimon Glass 2432bf36c5d5SSimon Glass CONFIG_SHA1 - support SHA1 hashing 2433bf36c5d5SSimon Glass CONFIG_SHA256 - support SHA256 hashing 2434bf36c5d5SSimon Glass 2435bf36c5d5SSimon Glass Note: There is also a sha1sum command, which should perhaps 2436bf36c5d5SSimon Glass be deprecated in favour of 'hash sha1'. 2437bf36c5d5SSimon Glass 2438a8c7c708Swdenk- Show boot progress: 2439c609719bSwdenk CONFIG_SHOW_BOOT_PROGRESS 2440c609719bSwdenk 2441c609719bSwdenk Defining this option allows to add some board- 2442c609719bSwdenk specific code (calling a user-provided function 2443c609719bSwdenk "show_boot_progress(int)") that enables you to show 2444c609719bSwdenk the system's boot progress on some display (for 2445c609719bSwdenk example, some LED's) on your board. At the moment, 2446c609719bSwdenk the following checkpoints are implemented: 2447c609719bSwdenk 24483a608ca0SSimon Glass- Detailed boot stage timing 24493a608ca0SSimon Glass CONFIG_BOOTSTAGE 24503a608ca0SSimon Glass Define this option to get detailed timing of each stage 24513a608ca0SSimon Glass of the boot process. 24523a608ca0SSimon Glass 24533a608ca0SSimon Glass CONFIG_BOOTSTAGE_USER_COUNT 24543a608ca0SSimon Glass This is the number of available user bootstage records. 24553a608ca0SSimon Glass Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...) 24563a608ca0SSimon Glass a new ID will be allocated from this stash. If you exceed 24573a608ca0SSimon Glass the limit, recording will stop. 24583a608ca0SSimon Glass 24593a608ca0SSimon Glass CONFIG_BOOTSTAGE_REPORT 24603a608ca0SSimon Glass Define this to print a report before boot, similar to this: 24613a608ca0SSimon Glass 24623a608ca0SSimon Glass Timer summary in microseconds: 24633a608ca0SSimon Glass Mark Elapsed Stage 24643a608ca0SSimon Glass 0 0 reset 24653a608ca0SSimon Glass 3,575,678 3,575,678 board_init_f start 24663a608ca0SSimon Glass 3,575,695 17 arch_cpu_init A9 24673a608ca0SSimon Glass 3,575,777 82 arch_cpu_init done 24683a608ca0SSimon Glass 3,659,598 83,821 board_init_r start 24693a608ca0SSimon Glass 3,910,375 250,777 main_loop 24703a608ca0SSimon Glass 29,916,167 26,005,792 bootm_start 24713a608ca0SSimon Glass 30,361,327 445,160 start_kernel 24723a608ca0SSimon Glass 24732eba38cfSSimon Glass CONFIG_CMD_BOOTSTAGE 24742eba38cfSSimon Glass Add a 'bootstage' command which supports printing a report 24752eba38cfSSimon Glass and un/stashing of bootstage data. 24762eba38cfSSimon Glass 247794fd1316SSimon Glass CONFIG_BOOTSTAGE_FDT 247894fd1316SSimon Glass Stash the bootstage information in the FDT. A root 'bootstage' 247994fd1316SSimon Glass node is created with each bootstage id as a child. Each child 248094fd1316SSimon Glass has a 'name' property and either 'mark' containing the 248194fd1316SSimon Glass mark time in microsecond, or 'accum' containing the 248294fd1316SSimon Glass accumulated time for that bootstage id in microseconds. 248394fd1316SSimon Glass For example: 248494fd1316SSimon Glass 248594fd1316SSimon Glass bootstage { 248694fd1316SSimon Glass 154 { 248794fd1316SSimon Glass name = "board_init_f"; 248894fd1316SSimon Glass mark = <3575678>; 248994fd1316SSimon Glass }; 249094fd1316SSimon Glass 170 { 249194fd1316SSimon Glass name = "lcd"; 249294fd1316SSimon Glass accum = <33482>; 249394fd1316SSimon Glass }; 249494fd1316SSimon Glass }; 249594fd1316SSimon Glass 249694fd1316SSimon Glass Code in the Linux kernel can find this in /proc/devicetree. 249794fd1316SSimon Glass 24981372cce2SMarian BalakowiczLegacy uImage format: 24991372cce2SMarian Balakowicz 2500c609719bSwdenk Arg Where When 2501c609719bSwdenk 1 common/cmd_bootm.c before attempting to boot an image 2502c609719bSwdenk -1 common/cmd_bootm.c Image header has bad magic number 2503c609719bSwdenk 2 common/cmd_bootm.c Image header has correct magic number 2504c609719bSwdenk -2 common/cmd_bootm.c Image header has bad checksum 2505c609719bSwdenk 3 common/cmd_bootm.c Image header has correct checksum 2506c609719bSwdenk -3 common/cmd_bootm.c Image data has bad checksum 2507c609719bSwdenk 4 common/cmd_bootm.c Image data has correct checksum 2508c609719bSwdenk -4 common/cmd_bootm.c Image is for unsupported architecture 2509c609719bSwdenk 5 common/cmd_bootm.c Architecture check OK 25101372cce2SMarian Balakowicz -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi) 2511c609719bSwdenk 6 common/cmd_bootm.c Image Type check OK 2512c609719bSwdenk -6 common/cmd_bootm.c gunzip uncompression error 2513c609719bSwdenk -7 common/cmd_bootm.c Unimplemented compression type 2514c609719bSwdenk 7 common/cmd_bootm.c Uncompression OK 25151372cce2SMarian Balakowicz 8 common/cmd_bootm.c No uncompress/copy overwrite error 2516c609719bSwdenk -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX) 25171372cce2SMarian Balakowicz 25181372cce2SMarian Balakowicz 9 common/image.c Start initial ramdisk verification 25191372cce2SMarian Balakowicz -10 common/image.c Ramdisk header has bad magic number 25201372cce2SMarian Balakowicz -11 common/image.c Ramdisk header has bad checksum 25211372cce2SMarian Balakowicz 10 common/image.c Ramdisk header is OK 25221372cce2SMarian Balakowicz -12 common/image.c Ramdisk data has bad checksum 25231372cce2SMarian Balakowicz 11 common/image.c Ramdisk data has correct checksum 25241372cce2SMarian Balakowicz 12 common/image.c Ramdisk verification complete, start loading 252511ccc33fSMarcel Ziswiler -13 common/image.c Wrong Image Type (not PPC Linux ramdisk) 25261372cce2SMarian Balakowicz 13 common/image.c Start multifile image verification 25271372cce2SMarian Balakowicz 14 common/image.c No initial ramdisk, no multifile, continue. 25281372cce2SMarian Balakowicz 2529ea0364f1SPeter Tyser 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS 2530c609719bSwdenk 2531a47a12beSStefan Roese -30 arch/powerpc/lib/board.c Fatal error, hang the system 253263e73c9aSwdenk -31 post/post.c POST test failed, detected by post_output_backlog() 253363e73c9aSwdenk -32 post/post.c POST test failed, detected by post_run_single() 253463e73c9aSwdenk 2535566a494fSHeiko Schocher 34 common/cmd_doc.c before loading a Image from a DOC device 2536566a494fSHeiko Schocher -35 common/cmd_doc.c Bad usage of "doc" command 2537566a494fSHeiko Schocher 35 common/cmd_doc.c correct usage of "doc" command 2538566a494fSHeiko Schocher -36 common/cmd_doc.c No boot device 2539566a494fSHeiko Schocher 36 common/cmd_doc.c correct boot device 2540566a494fSHeiko Schocher -37 common/cmd_doc.c Unknown Chip ID on boot device 2541566a494fSHeiko Schocher 37 common/cmd_doc.c correct chip ID found, device available 2542566a494fSHeiko Schocher -38 common/cmd_doc.c Read Error on boot device 2543566a494fSHeiko Schocher 38 common/cmd_doc.c reading Image header from DOC device OK 2544566a494fSHeiko Schocher -39 common/cmd_doc.c Image header has bad magic number 2545566a494fSHeiko Schocher 39 common/cmd_doc.c Image header has correct magic number 2546566a494fSHeiko Schocher -40 common/cmd_doc.c Error reading Image from DOC device 2547566a494fSHeiko Schocher 40 common/cmd_doc.c Image header has correct magic number 2548566a494fSHeiko Schocher 41 common/cmd_ide.c before loading a Image from a IDE device 2549566a494fSHeiko Schocher -42 common/cmd_ide.c Bad usage of "ide" command 2550566a494fSHeiko Schocher 42 common/cmd_ide.c correct usage of "ide" command 2551566a494fSHeiko Schocher -43 common/cmd_ide.c No boot device 2552566a494fSHeiko Schocher 43 common/cmd_ide.c boot device found 2553566a494fSHeiko Schocher -44 common/cmd_ide.c Device not available 2554566a494fSHeiko Schocher 44 common/cmd_ide.c Device available 2555566a494fSHeiko Schocher -45 common/cmd_ide.c wrong partition selected 2556566a494fSHeiko Schocher 45 common/cmd_ide.c partition selected 2557566a494fSHeiko Schocher -46 common/cmd_ide.c Unknown partition table 2558566a494fSHeiko Schocher 46 common/cmd_ide.c valid partition table found 2559566a494fSHeiko Schocher -47 common/cmd_ide.c Invalid partition type 2560566a494fSHeiko Schocher 47 common/cmd_ide.c correct partition type 2561566a494fSHeiko Schocher -48 common/cmd_ide.c Error reading Image Header on boot device 2562566a494fSHeiko Schocher 48 common/cmd_ide.c reading Image Header from IDE device OK 2563566a494fSHeiko Schocher -49 common/cmd_ide.c Image header has bad magic number 2564566a494fSHeiko Schocher 49 common/cmd_ide.c Image header has correct magic number 2565566a494fSHeiko Schocher -50 common/cmd_ide.c Image header has bad checksum 2566566a494fSHeiko Schocher 50 common/cmd_ide.c Image header has correct checksum 2567566a494fSHeiko Schocher -51 common/cmd_ide.c Error reading Image from IDE device 2568566a494fSHeiko Schocher 51 common/cmd_ide.c reading Image from IDE device OK 2569566a494fSHeiko Schocher 52 common/cmd_nand.c before loading a Image from a NAND device 2570566a494fSHeiko Schocher -53 common/cmd_nand.c Bad usage of "nand" command 2571566a494fSHeiko Schocher 53 common/cmd_nand.c correct usage of "nand" command 2572566a494fSHeiko Schocher -54 common/cmd_nand.c No boot device 2573566a494fSHeiko Schocher 54 common/cmd_nand.c boot device found 2574566a494fSHeiko Schocher -55 common/cmd_nand.c Unknown Chip ID on boot device 2575566a494fSHeiko Schocher 55 common/cmd_nand.c correct chip ID found, device available 2576566a494fSHeiko Schocher -56 common/cmd_nand.c Error reading Image Header on boot device 2577566a494fSHeiko Schocher 56 common/cmd_nand.c reading Image Header from NAND device OK 2578566a494fSHeiko Schocher -57 common/cmd_nand.c Image header has bad magic number 2579566a494fSHeiko Schocher 57 common/cmd_nand.c Image header has correct magic number 2580566a494fSHeiko Schocher -58 common/cmd_nand.c Error reading Image from NAND device 2581566a494fSHeiko Schocher 58 common/cmd_nand.c reading Image from NAND device OK 2582c609719bSwdenk 2583566a494fSHeiko Schocher -60 common/env_common.c Environment has a bad CRC, using default 2584c609719bSwdenk 2585566a494fSHeiko Schocher 64 net/eth.c starting with Ethernet configuration. 2586566a494fSHeiko Schocher -64 net/eth.c no Ethernet found. 2587566a494fSHeiko Schocher 65 net/eth.c Ethernet found. 2588206c60cbSwdenk 2589566a494fSHeiko Schocher -80 common/cmd_net.c usage wrong 2590566a494fSHeiko Schocher 80 common/cmd_net.c before calling NetLoop() 259111ccc33fSMarcel Ziswiler -81 common/cmd_net.c some error in NetLoop() occurred 2592566a494fSHeiko Schocher 81 common/cmd_net.c NetLoop() back without error 2593566a494fSHeiko Schocher -82 common/cmd_net.c size == 0 (File with size 0 loaded) 2594566a494fSHeiko Schocher 82 common/cmd_net.c trying automatic boot 259574de7aefSWolfgang Denk 83 common/cmd_net.c running "source" command 259674de7aefSWolfgang Denk -83 common/cmd_net.c some error in automatic boot or "source" command 2597566a494fSHeiko Schocher 84 common/cmd_net.c end without errors 2598c609719bSwdenk 25991372cce2SMarian BalakowiczFIT uImage format: 26001372cce2SMarian Balakowicz 26011372cce2SMarian Balakowicz Arg Where When 26021372cce2SMarian Balakowicz 100 common/cmd_bootm.c Kernel FIT Image has correct format 26031372cce2SMarian Balakowicz -100 common/cmd_bootm.c Kernel FIT Image has incorrect format 26041372cce2SMarian Balakowicz 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration 26051372cce2SMarian Balakowicz -101 common/cmd_bootm.c Can't get configuration for kernel subimage 26061372cce2SMarian Balakowicz 102 common/cmd_bootm.c Kernel unit name specified 26071372cce2SMarian Balakowicz -103 common/cmd_bootm.c Can't get kernel subimage node offset 2608f773bea8SMarian Balakowicz 103 common/cmd_bootm.c Found configuration node 26091372cce2SMarian Balakowicz 104 common/cmd_bootm.c Got kernel subimage node offset 26101372cce2SMarian Balakowicz -104 common/cmd_bootm.c Kernel subimage hash verification failed 26111372cce2SMarian Balakowicz 105 common/cmd_bootm.c Kernel subimage hash verification OK 26121372cce2SMarian Balakowicz -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture 26131372cce2SMarian Balakowicz 106 common/cmd_bootm.c Architecture check OK 261411ccc33fSMarcel Ziswiler -106 common/cmd_bootm.c Kernel subimage has wrong type 261511ccc33fSMarcel Ziswiler 107 common/cmd_bootm.c Kernel subimage type OK 26161372cce2SMarian Balakowicz -107 common/cmd_bootm.c Can't get kernel subimage data/size 26171372cce2SMarian Balakowicz 108 common/cmd_bootm.c Got kernel subimage data/size 26181372cce2SMarian Balakowicz -108 common/cmd_bootm.c Wrong image type (not legacy, FIT) 26191372cce2SMarian Balakowicz -109 common/cmd_bootm.c Can't get kernel subimage type 26201372cce2SMarian Balakowicz -110 common/cmd_bootm.c Can't get kernel subimage comp 26211372cce2SMarian Balakowicz -111 common/cmd_bootm.c Can't get kernel subimage os 26221372cce2SMarian Balakowicz -112 common/cmd_bootm.c Can't get kernel subimage load address 26231372cce2SMarian Balakowicz -113 common/cmd_bootm.c Image uncompress/copy overwrite error 26241372cce2SMarian Balakowicz 26251372cce2SMarian Balakowicz 120 common/image.c Start initial ramdisk verification 26261372cce2SMarian Balakowicz -120 common/image.c Ramdisk FIT image has incorrect format 26271372cce2SMarian Balakowicz 121 common/image.c Ramdisk FIT image has correct format 262811ccc33fSMarcel Ziswiler 122 common/image.c No ramdisk subimage unit name, using configuration 26291372cce2SMarian Balakowicz -122 common/image.c Can't get configuration for ramdisk subimage 26301372cce2SMarian Balakowicz 123 common/image.c Ramdisk unit name specified 26311372cce2SMarian Balakowicz -124 common/image.c Can't get ramdisk subimage node offset 26321372cce2SMarian Balakowicz 125 common/image.c Got ramdisk subimage node offset 26331372cce2SMarian Balakowicz -125 common/image.c Ramdisk subimage hash verification failed 26341372cce2SMarian Balakowicz 126 common/image.c Ramdisk subimage hash verification OK 26351372cce2SMarian Balakowicz -126 common/image.c Ramdisk subimage for unsupported architecture 26361372cce2SMarian Balakowicz 127 common/image.c Architecture check OK 26371372cce2SMarian Balakowicz -127 common/image.c Can't get ramdisk subimage data/size 26381372cce2SMarian Balakowicz 128 common/image.c Got ramdisk subimage data/size 26391372cce2SMarian Balakowicz 129 common/image.c Can't get ramdisk load address 26401372cce2SMarian Balakowicz -129 common/image.c Got ramdisk load address 26411372cce2SMarian Balakowicz 264211ccc33fSMarcel Ziswiler -130 common/cmd_doc.c Incorrect FIT image format 26431372cce2SMarian Balakowicz 131 common/cmd_doc.c FIT image format OK 26441372cce2SMarian Balakowicz 264511ccc33fSMarcel Ziswiler -140 common/cmd_ide.c Incorrect FIT image format 26461372cce2SMarian Balakowicz 141 common/cmd_ide.c FIT image format OK 26471372cce2SMarian Balakowicz 264811ccc33fSMarcel Ziswiler -150 common/cmd_nand.c Incorrect FIT image format 26491372cce2SMarian Balakowicz 151 common/cmd_nand.c FIT image format OK 26501372cce2SMarian Balakowicz 2651d95f6ec7SGabe Black- FIT image support: 2652d95f6ec7SGabe Black CONFIG_FIT 2653d95f6ec7SGabe Black Enable support for the FIT uImage format. 2654d95f6ec7SGabe Black 2655d95f6ec7SGabe Black CONFIG_FIT_BEST_MATCH 2656d95f6ec7SGabe Black When no configuration is explicitly selected, default to the 2657d95f6ec7SGabe Black one whose fdt's compatibility field best matches that of 2658d95f6ec7SGabe Black U-Boot itself. A match is considered "best" if it matches the 2659d95f6ec7SGabe Black most specific compatibility entry of U-Boot's fdt's root node. 2660d95f6ec7SGabe Black The order of entries in the configuration's fdt is ignored. 2661d95f6ec7SGabe Black 26624cf2609bSWolfgang Denk- Standalone program support: 26634cf2609bSWolfgang Denk CONFIG_STANDALONE_LOAD_ADDR 26644cf2609bSWolfgang Denk 26656feff899SWolfgang Denk This option defines a board specific value for the 26666feff899SWolfgang Denk address where standalone program gets loaded, thus 26676feff899SWolfgang Denk overwriting the architecture dependent default 26684cf2609bSWolfgang Denk settings. 26694cf2609bSWolfgang Denk 26704cf2609bSWolfgang Denk- Frame Buffer Address: 26714cf2609bSWolfgang Denk CONFIG_FB_ADDR 26724cf2609bSWolfgang Denk 26734cf2609bSWolfgang Denk Define CONFIG_FB_ADDR if you want to use specific 26744cf2609bSWolfgang Denk address for frame buffer. 26754cf2609bSWolfgang Denk Then system will reserve the frame buffer address to 26764cf2609bSWolfgang Denk defined address instead of lcd_setmem (this function 26776feff899SWolfgang Denk grabs the memory for frame buffer by panel's size). 26784cf2609bSWolfgang Denk 26794cf2609bSWolfgang Denk Please see board_init_f function. 26804cf2609bSWolfgang Denk 2681cccfc2abSDetlev Zundel- Automatic software updates via TFTP server 2682cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP 2683cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP_CNT_MAX 2684cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP_MSEC_MAX 2685cccfc2abSDetlev Zundel 2686cccfc2abSDetlev Zundel These options enable and control the auto-update feature; 2687cccfc2abSDetlev Zundel for a more detailed description refer to doc/README.update. 2688cccfc2abSDetlev Zundel 2689cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support) 2690cccfc2abSDetlev Zundel CONFIG_MTD_DEVICE 2691cccfc2abSDetlev Zundel 2692cccfc2abSDetlev Zundel Adds the MTD device infrastructure from the Linux kernel. 2693cccfc2abSDetlev Zundel Needed for mtdparts command support. 2694cccfc2abSDetlev Zundel 2695cccfc2abSDetlev Zundel CONFIG_MTD_PARTITIONS 2696cccfc2abSDetlev Zundel 2697cccfc2abSDetlev Zundel Adds the MTD partitioning infrastructure from the Linux 2698cccfc2abSDetlev Zundel kernel. Needed for UBI support. 2699cccfc2abSDetlev Zundel 27006a11cf48SDaniel Schwierzeck- SPL framework 27016a11cf48SDaniel Schwierzeck CONFIG_SPL 27026a11cf48SDaniel Schwierzeck Enable building of SPL globally. 27036a11cf48SDaniel Schwierzeck 270495579793STom Rini CONFIG_SPL_LDSCRIPT 270595579793STom Rini LDSCRIPT for linking the SPL binary. 270695579793STom Rini 270795579793STom Rini CONFIG_SPL_MAX_SIZE 270895579793STom Rini Maximum binary size (text, data and rodata) of the SPL binary. 270995579793STom Rini 27106a11cf48SDaniel Schwierzeck CONFIG_SPL_TEXT_BASE 27116a11cf48SDaniel Schwierzeck TEXT_BASE for linking the SPL binary. 27126a11cf48SDaniel Schwierzeck 271394a45bb1SScott Wood CONFIG_SPL_RELOC_TEXT_BASE 271494a45bb1SScott Wood Address to relocate to. If unspecified, this is equal to 271594a45bb1SScott Wood CONFIG_SPL_TEXT_BASE (i.e. no relocation is done). 271694a45bb1SScott Wood 271795579793STom Rini CONFIG_SPL_BSS_START_ADDR 271895579793STom Rini Link address for the BSS within the SPL binary. 271995579793STom Rini 272095579793STom Rini CONFIG_SPL_BSS_MAX_SIZE 272195579793STom Rini Maximum binary size of the BSS section of the SPL binary. 272295579793STom Rini 272395579793STom Rini CONFIG_SPL_STACK 272495579793STom Rini Adress of the start of the stack SPL will use 272595579793STom Rini 272694a45bb1SScott Wood CONFIG_SPL_RELOC_STACK 272794a45bb1SScott Wood Adress of the start of the stack SPL will use after 272894a45bb1SScott Wood relocation. If unspecified, this is equal to 272994a45bb1SScott Wood CONFIG_SPL_STACK. 273094a45bb1SScott Wood 273195579793STom Rini CONFIG_SYS_SPL_MALLOC_START 273295579793STom Rini Starting address of the malloc pool used in SPL. 273395579793STom Rini 273495579793STom Rini CONFIG_SYS_SPL_MALLOC_SIZE 273595579793STom Rini The size of the malloc pool used in SPL. 27366a11cf48SDaniel Schwierzeck 273747f7bcaeSTom Rini CONFIG_SPL_FRAMEWORK 273847f7bcaeSTom Rini Enable the SPL framework under common/. This framework 273947f7bcaeSTom Rini supports MMC, NAND and YMODEM loading of U-Boot and NAND 274047f7bcaeSTom Rini NAND loading of the Linux Kernel. 274147f7bcaeSTom Rini 2742861a86f4STom Rini CONFIG_SPL_DISPLAY_PRINT 2743861a86f4STom Rini For ARM, enable an optional function to print more information 2744861a86f4STom Rini about the running system. 2745861a86f4STom Rini 27464b919725SScott Wood CONFIG_SPL_INIT_MINIMAL 27474b919725SScott Wood Arch init code should be built for a very small image 27484b919725SScott Wood 27496a11cf48SDaniel Schwierzeck CONFIG_SPL_LIBCOMMON_SUPPORT 27506a11cf48SDaniel Schwierzeck Support for common/libcommon.o in SPL binary 27516a11cf48SDaniel Schwierzeck 27526a11cf48SDaniel Schwierzeck CONFIG_SPL_LIBDISK_SUPPORT 27536a11cf48SDaniel Schwierzeck Support for disk/libdisk.o in SPL binary 27546a11cf48SDaniel Schwierzeck 27556a11cf48SDaniel Schwierzeck CONFIG_SPL_I2C_SUPPORT 27566a11cf48SDaniel Schwierzeck Support for drivers/i2c/libi2c.o in SPL binary 27576a11cf48SDaniel Schwierzeck 27586a11cf48SDaniel Schwierzeck CONFIG_SPL_GPIO_SUPPORT 27596a11cf48SDaniel Schwierzeck Support for drivers/gpio/libgpio.o in SPL binary 27606a11cf48SDaniel Schwierzeck 27616a11cf48SDaniel Schwierzeck CONFIG_SPL_MMC_SUPPORT 27626a11cf48SDaniel Schwierzeck Support for drivers/mmc/libmmc.o in SPL binary 27636a11cf48SDaniel Schwierzeck 276495579793STom Rini CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR, 276595579793STom Rini CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS, 276695579793STom Rini CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION 276795579793STom Rini Address, size and partition on the MMC to load U-Boot from 276895579793STom Rini when the MMC is being used in raw mode. 276995579793STom Rini 277095579793STom Rini CONFIG_SPL_FAT_SUPPORT 277195579793STom Rini Support for fs/fat/libfat.o in SPL binary 277295579793STom Rini 277395579793STom Rini CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME 277495579793STom Rini Filename to read to load U-Boot when reading from FAT 277595579793STom Rini 27766f2f01b9SScott Wood CONFIG_SPL_NAND_BASE 27776f2f01b9SScott Wood Include nand_base.c in the SPL. Requires 27786f2f01b9SScott Wood CONFIG_SPL_NAND_DRIVERS. 27796f2f01b9SScott Wood 27806f2f01b9SScott Wood CONFIG_SPL_NAND_DRIVERS 27816f2f01b9SScott Wood SPL uses normal NAND drivers, not minimal drivers. 27826f2f01b9SScott Wood 27836f2f01b9SScott Wood CONFIG_SPL_NAND_ECC 27846f2f01b9SScott Wood Include standard software ECC in the SPL 27856f2f01b9SScott Wood 278695579793STom Rini CONFIG_SPL_NAND_SIMPLE 27877d4b7955SScott Wood Support for NAND boot using simple NAND drivers that 27887d4b7955SScott Wood expose the cmd_ctrl() interface. 278995579793STom Rini 279095579793STom Rini CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT, 279195579793STom Rini CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE, 279295579793STom Rini CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS, 279395579793STom Rini CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE, 279495579793STom Rini CONFIG_SYS_NAND_ECCBYTES 279595579793STom Rini Defines the size and behavior of the NAND that SPL uses 27967d4b7955SScott Wood to read U-Boot 279795579793STom Rini 279895579793STom Rini CONFIG_SYS_NAND_U_BOOT_OFFS 27997d4b7955SScott Wood Location in NAND to read U-Boot from 28007d4b7955SScott Wood 28017d4b7955SScott Wood CONFIG_SYS_NAND_U_BOOT_DST 28027d4b7955SScott Wood Location in memory to load U-Boot to 28037d4b7955SScott Wood 28047d4b7955SScott Wood CONFIG_SYS_NAND_U_BOOT_SIZE 28057d4b7955SScott Wood Size of image to load 280695579793STom Rini 280795579793STom Rini CONFIG_SYS_NAND_U_BOOT_START 28087d4b7955SScott Wood Entry point in loaded image to jump to 280995579793STom Rini 281095579793STom Rini CONFIG_SYS_NAND_HW_ECC_OOBFIRST 281195579793STom Rini Define this if you need to first read the OOB and then the 281295579793STom Rini data. This is used for example on davinci plattforms. 281395579793STom Rini 281495579793STom Rini CONFIG_SPL_OMAP3_ID_NAND 281595579793STom Rini Support for an OMAP3-specific set of functions to return the 281695579793STom Rini ID and MFR of the first attached NAND chip, if present. 281795579793STom Rini 28186a11cf48SDaniel Schwierzeck CONFIG_SPL_SERIAL_SUPPORT 28196a11cf48SDaniel Schwierzeck Support for drivers/serial/libserial.o in SPL binary 28206a11cf48SDaniel Schwierzeck 28216a11cf48SDaniel Schwierzeck CONFIG_SPL_SPI_FLASH_SUPPORT 28226a11cf48SDaniel Schwierzeck Support for drivers/mtd/spi/libspi_flash.o in SPL binary 28236a11cf48SDaniel Schwierzeck 28246a11cf48SDaniel Schwierzeck CONFIG_SPL_SPI_SUPPORT 28256a11cf48SDaniel Schwierzeck Support for drivers/spi/libspi.o in SPL binary 28266a11cf48SDaniel Schwierzeck 2827c57b953dSPavel Machek CONFIG_SPL_RAM_DEVICE 2828c57b953dSPavel Machek Support for running image already present in ram, in SPL binary 2829c57b953dSPavel Machek 28306a11cf48SDaniel Schwierzeck CONFIG_SPL_LIBGENERIC_SUPPORT 28316a11cf48SDaniel Schwierzeck Support for lib/libgeneric.o in SPL binary 28321372cce2SMarian Balakowicz 2833ca2fca22SScott Wood CONFIG_SPL_TARGET 2834ca2fca22SScott Wood Final target image containing SPL and payload. Some SPLs 2835ca2fca22SScott Wood use an arch-specific makefile fragment instead, for 2836ca2fca22SScott Wood example if more than one image needs to be produced. 2837ca2fca22SScott Wood 2838c609719bSwdenkModem Support: 2839c609719bSwdenk-------------- 2840c609719bSwdenk 2841566e5cf4SWolfgang Denk[so far only for SMDK2400 boards] 2842c609719bSwdenk 284311ccc33fSMarcel Ziswiler- Modem support enable: 2844c609719bSwdenk CONFIG_MODEM_SUPPORT 2845c609719bSwdenk 2846c609719bSwdenk- RTS/CTS Flow control enable: 2847c609719bSwdenk CONFIG_HWFLOW 2848c609719bSwdenk 2849c609719bSwdenk- Modem debug support: 2850c609719bSwdenk CONFIG_MODEM_SUPPORT_DEBUG 2851c609719bSwdenk 2852c609719bSwdenk Enables debugging stuff (char screen[1024], dbg()) 2853c609719bSwdenk for modem support. Useful only with BDI2000. 2854c609719bSwdenk 2855a8c7c708Swdenk- Interrupt support (PPC): 2856a8c7c708Swdenk 2857a8c7c708Swdenk There are common interrupt_init() and timer_interrupt() 2858a8c7c708Swdenk for all PPC archs. interrupt_init() calls interrupt_init_cpu() 285911ccc33fSMarcel Ziswiler for CPU specific initialization. interrupt_init_cpu() 2860a8c7c708Swdenk should set decrementer_count to appropriate value. If 286111ccc33fSMarcel Ziswiler CPU resets decrementer automatically after interrupt 2862a8c7c708Swdenk (ppc4xx) it should set decrementer_count to zero. 286311ccc33fSMarcel Ziswiler timer_interrupt() calls timer_interrupt_cpu() for CPU 2864a8c7c708Swdenk specific handling. If board has watchdog / status_led 2865a8c7c708Swdenk / other_activity_monitor it works automatically from 2866a8c7c708Swdenk general timer_interrupt(). 2867a8c7c708Swdenk 2868c609719bSwdenk- General: 2869c609719bSwdenk 2870c609719bSwdenk In the target system modem support is enabled when a 2871c609719bSwdenk specific key (key combination) is pressed during 2872c609719bSwdenk power-on. Otherwise U-Boot will boot normally 287311ccc33fSMarcel Ziswiler (autoboot). The key_pressed() function is called from 2874c609719bSwdenk board_init(). Currently key_pressed() is a dummy 2875c609719bSwdenk function, returning 1 and thus enabling modem 2876c609719bSwdenk initialization. 2877c609719bSwdenk 2878c609719bSwdenk If there are no modem init strings in the 2879c609719bSwdenk environment, U-Boot proceed to autoboot; the 2880c609719bSwdenk previous output (banner, info printfs) will be 288111ccc33fSMarcel Ziswiler suppressed, though. 2882c609719bSwdenk 2883c609719bSwdenk See also: doc/README.Modem 2884c609719bSwdenk 28859660e442SHelmut RaigerBoard initialization settings: 28869660e442SHelmut Raiger------------------------------ 28879660e442SHelmut Raiger 28889660e442SHelmut RaigerDuring Initialization u-boot calls a number of board specific functions 28899660e442SHelmut Raigerto allow the preparation of board specific prerequisites, e.g. pin setup 28909660e442SHelmut Raigerbefore drivers are initialized. To enable these callbacks the 28919660e442SHelmut Raigerfollowing configuration macros have to be defined. Currently this is 28929660e442SHelmut Raigerarchitecture specific, so please check arch/your_architecture/lib/board.c 28939660e442SHelmut Raigertypically in board_init_f() and board_init_r(). 28949660e442SHelmut Raiger 28959660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f() 28969660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r() 28979660e442SHelmut Raiger- CONFIG_BOARD_LATE_INIT: Call board_late_init() 28989660e442SHelmut Raiger- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init() 2899c609719bSwdenk 2900c609719bSwdenkConfiguration Settings: 2901c609719bSwdenk----------------------- 2902c609719bSwdenk 29036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included; 2904c609719bSwdenk undefine this when you're short of memory. 2905c609719bSwdenk 29062fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default 29072fb2604dSPeter Tyser width of the commands listed in the 'help' command output. 29082fb2604dSPeter Tyser 29096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to 2910c609719bSwdenk prompt for user input. 2911c609719bSwdenk 29126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE: Buffer size for input from the Console 2913c609719bSwdenk 29146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE: Buffer size for Console output 2915c609719bSwdenk 29166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands 2917c609719bSwdenk 29186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to 2919c609719bSwdenk the application (usually a Linux kernel) when it is 2920c609719bSwdenk booted 2921c609719bSwdenk 29226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE: 2923c609719bSwdenk List of legal baudrate settings for this board. 2924c609719bSwdenk 29256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET 2926c609719bSwdenk Suppress display of console information at boot. 2927c609719bSwdenk 29286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV 2929c609719bSwdenk If the board specific function 2930c609719bSwdenk extern int overwrite_console (void); 2931c609719bSwdenk returns 1, the stdin, stderr and stdout are switched to the 2932c609719bSwdenk serial port, else the settings in the environment are used. 2933c609719bSwdenk 29346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE 2935c609719bSwdenk Enable the call to overwrite_console(). 2936c609719bSwdenk 29376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE 2938c609719bSwdenk Enable overwrite of previous console environment settings. 2939c609719bSwdenk 29406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END: 2941c609719bSwdenk Begin and End addresses of the area used by the 2942c609719bSwdenk simple memory test. 2943c609719bSwdenk 29446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST: 2945c609719bSwdenk Enable an alternate, more extensive memory test. 2946c609719bSwdenk 29476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH: 29485f535fe1Swdenk Scratch address used by the alternate memory test 29495f535fe1Swdenk You only need to set this if address zero isn't writeable 29505f535fe1Swdenk 29516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only): 29526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header, 295314f73ca6SStefan Roese this specified memory area will get subtracted from the top 295411ccc33fSMarcel Ziswiler (end) of RAM and won't get "touched" at all by U-Boot. By 295514f73ca6SStefan Roese fixing up gd->ram_size the Linux kernel should gets passed 295614f73ca6SStefan Roese the now "corrected" memory size and won't touch it either. 295714f73ca6SStefan Roese This should work for arch/ppc and arch/powerpc. Only Linux 29585e12e75dSStefan Roese board ports in arch/powerpc with bootwrapper support that 295914f73ca6SStefan Roese recalculate the memory size from the SDRAM controller setup 29605e12e75dSStefan Roese will have to get fixed in Linux additionally. 296114f73ca6SStefan Roese 296214f73ca6SStefan Roese This option can be used as a workaround for the 440EPx/GRx 296314f73ca6SStefan Roese CHIP 11 errata where the last 256 bytes in SDRAM shouldn't 296414f73ca6SStefan Roese be touched. 296514f73ca6SStefan Roese 296614f73ca6SStefan Roese WARNING: Please make sure that this value is a multiple of 296714f73ca6SStefan Roese the Linux page size (normally 4k). If this is not the case, 296814f73ca6SStefan Roese then the end address of the Linux memory will be located at a 296914f73ca6SStefan Roese non page size aligned address and this could cause major 297014f73ca6SStefan Roese problems. 297114f73ca6SStefan Roese 29726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TFTP_LOADADDR: 2973c609719bSwdenk Default load address for network file downloads 2974c609719bSwdenk 29756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE: 2976c609719bSwdenk Enable temporary baudrate change while serial download 2977c609719bSwdenk 29786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE: 2979c609719bSwdenk Physical start address of SDRAM. _Must_ be 0 here. 2980c609719bSwdenk 29816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE: 2982c609719bSwdenk Physical start address of Motherboard I/O (if using a 2983c609719bSwdenk Cogent motherboard) 2984c609719bSwdenk 29856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE: 2986c609719bSwdenk Physical start address of Flash memory. 2987c609719bSwdenk 29886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE: 2989c609719bSwdenk Physical start address of boot monitor code (set by 2990c609719bSwdenk make config files to be same as the text base address 299114d0a02aSWolfgang Denk (CONFIG_SYS_TEXT_BASE) used when linking) - same as 29926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FLASH_BASE when booting from flash. 2993c609719bSwdenk 29946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN: 29953b57fe0aSwdenk Size of memory reserved for monitor code, used to 29963b57fe0aSwdenk determine _at_compile_time_ (!) if the environment is 29973b57fe0aSwdenk embedded within the U-Boot image, or in a separate 29983b57fe0aSwdenk flash sector. 2999c609719bSwdenk 30006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN: 3001c609719bSwdenk Size of DRAM reserved for malloc() use. 3002c609719bSwdenk 30036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN: 300415940c9aSStefan Roese Normally compressed uImages are limited to an 300515940c9aSStefan Roese uncompressed size of 8 MBytes. If this is not enough, 30066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD you can define CONFIG_SYS_BOOTM_LEN in your board config file 300715940c9aSStefan Roese to adjust this setting to your needs. 3008c609719bSwdenk 30096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ: 3010c609719bSwdenk Maximum size of memory mapped by the startup code of 3011c609719bSwdenk the Linux kernel; all data that must be processed by 30127d721e34SBartlomiej Sieka the Linux kernel (bd_info, boot arguments, FDT blob if 30137d721e34SBartlomiej Sieka used) must be put below this limit, unless "bootm_low" 30147d721e34SBartlomiej Sieka enviroment variable is defined and non-zero. In such case 30157d721e34SBartlomiej Sieka all data for the Linux kernel must be between "bootm_low" 3016c3624e6eSGrant Likely and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment 3017c3624e6eSGrant Likely variable "bootm_mapsize" will override the value of 3018c3624e6eSGrant Likely CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined, 3019c3624e6eSGrant Likely then the value in "bootm_size" will be used instead. 3020c609719bSwdenk 3021fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH: 3022fca43cc8SJohn Rigby Enable initrd_high functionality. If defined then the 3023fca43cc8SJohn Rigby initrd_high feature is enabled and the bootm ramdisk subcommand 3024fca43cc8SJohn Rigby is enabled. 3025fca43cc8SJohn Rigby 3026fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE: 3027fca43cc8SJohn Rigby Enables allocating and saving kernel cmdline in space between 3028fca43cc8SJohn Rigby "bootm_low" and "bootm_low" + BOOTMAPSZ. 3029fca43cc8SJohn Rigby 3030fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD: 3031fca43cc8SJohn Rigby Enables allocating and saving a kernel copy of the bd_info in 3032fca43cc8SJohn Rigby space between "bootm_low" and "bootm_low" + BOOTMAPSZ. 3033fca43cc8SJohn Rigby 30346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS: 3035c609719bSwdenk Max number of Flash memory banks 3036c609719bSwdenk 30376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT: 3038c609719bSwdenk Max number of sectors on a Flash chip 3039c609719bSwdenk 30406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT: 3041c609719bSwdenk Timeout for Flash erase operations (in ms) 3042c609719bSwdenk 30436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT: 3044c609719bSwdenk Timeout for Flash write operations (in ms) 3045c609719bSwdenk 30466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT 30478564acf9Swdenk Timeout for Flash set sector lock bit operation (in ms) 30488564acf9Swdenk 30496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT 30508564acf9Swdenk Timeout for Flash clear lock bits operation (in ms) 30518564acf9Swdenk 30526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION 30538564acf9Swdenk If defined, hardware flash sectors protection is used 30548564acf9Swdenk instead of U-Boot software protection. 30558564acf9Swdenk 30566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP: 3057c609719bSwdenk 3058c609719bSwdenk Enable TFTP transfers directly to flash memory; 3059c609719bSwdenk without this option such a download has to be 3060c609719bSwdenk performed in two steps: (1) download to RAM, and (2) 3061c609719bSwdenk copy from RAM to flash. 3062c609719bSwdenk 3063c609719bSwdenk The two-step approach is usually more reliable, since 3064c609719bSwdenk you can check if the download worked before you erase 306511ccc33fSMarcel Ziswiler the flash, but in some situations (when system RAM is 306611ccc33fSMarcel Ziswiler too limited to allow for a temporary copy of the 3067c609719bSwdenk downloaded image) this option may be very useful. 3068c609719bSwdenk 30696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI: 3070c609719bSwdenk Define if the flash driver uses extra elements in the 30715653fc33Swdenk common flash structure for storing flash geometry. 30725653fc33Swdenk 307300b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER 30745653fc33Swdenk This option also enables the building of the cfi_flash driver 30755653fc33Swdenk in the drivers directory 307653cf9435Sstroese 307791809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD 307891809ed5SPiotr Ziecik This option enables the building of the cfi_mtd driver 307991809ed5SPiotr Ziecik in the drivers directory. The driver exports CFI flash 308091809ed5SPiotr Ziecik to the MTD layer. 308191809ed5SPiotr Ziecik 30826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE 308396ef831fSGuennadi Liakhovetski Use buffered writes to flash. 308496ef831fSGuennadi Liakhovetski 308596ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N 308696ef831fSGuennadi Liakhovetski s29ws-n MirrorBit flash has non-standard addresses for buffered 308796ef831fSGuennadi Liakhovetski write commands. 308896ef831fSGuennadi Liakhovetski 30896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST 30905568e613SStefan Roese If this option is defined, the common CFI flash doesn't 30915568e613SStefan Roese print it's warning upon not recognized FLASH banks. This 30925568e613SStefan Roese is useful, if some of the configured banks are only 30935568e613SStefan Roese optionally available. 30945568e613SStefan Roese 30959a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS 30969a042e9cSJerry Van Baren If defined (must be an integer), print out countdown 30979a042e9cSJerry Van Baren digits and dots. Recommended value: 45 (9..1) for 80 30989a042e9cSJerry Van Baren column displays, 15 (3..1) for 40 column displays. 30999a042e9cSJerry Van Baren 31006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER: 310111ccc33fSMarcel Ziswiler Defines the number of Ethernet receive buffers. On some 310211ccc33fSMarcel Ziswiler Ethernet controllers it is recommended to set this value 310353cf9435Sstroese to 8 or even higher (EEPRO100 or 405 EMAC), since all 310453cf9435Sstroese buffers can be full shortly after enabling the interface 310511ccc33fSMarcel Ziswiler on high Ethernet traffic. 310653cf9435Sstroese Defaults to 4 if not defined. 3107c609719bSwdenk 3108ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES 3109ea882bafSWolfgang Denk 3110ea882bafSWolfgang Denk Maximum number of entries in the hash table that is used 3111ea882bafSWolfgang Denk internally to store the environment settings. The default 3112ea882bafSWolfgang Denk setting is supposed to be generous and should work in most 3113ea882bafSWolfgang Denk cases. This setting can be used to tune behaviour; see 3114ea882bafSWolfgang Denk lib/hashtable.c for details. 3115ea882bafSWolfgang Denk 3116c609719bSwdenkThe following definitions that deal with the placement and management 3117c609719bSwdenkof environment data (variable area); in general, we support the 3118c609719bSwdenkfollowing configurations: 3119c609719bSwdenk 3120c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC: 3121c3eb3fe4SMike Frysinger 3122c3eb3fe4SMike Frysinger Builds up envcrc with the target environment so that external utils 3123c3eb3fe4SMike Frysinger may easily extract it and embed it in final U-Boot images. 3124c3eb3fe4SMike Frysinger 31255a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH: 3126c609719bSwdenk 3127c609719bSwdenk Define this if the environment is in flash memory. 3128c609719bSwdenk 3129c609719bSwdenk a) The environment occupies one whole flash sector, which is 3130c609719bSwdenk "embedded" in the text segment with the U-Boot code. This 3131c609719bSwdenk happens usually with "bottom boot sector" or "top boot 3132c609719bSwdenk sector" type flash chips, which have several smaller 3133c609719bSwdenk sectors at the start or the end. For instance, such a 3134c609719bSwdenk layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In 3135c609719bSwdenk such a case you would place the environment in one of the 3136c609719bSwdenk 4 kB sectors - with U-Boot code before and after it. With 3137c609719bSwdenk "top boot sector" type flash chips, you would put the 3138c609719bSwdenk environment in one of the last sectors, leaving a gap 3139c609719bSwdenk between U-Boot and the environment. 3140c609719bSwdenk 31410e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 3142c609719bSwdenk 3143c609719bSwdenk Offset of environment data (variable area) to the 3144c609719bSwdenk beginning of flash memory; for instance, with bottom boot 3145c609719bSwdenk type flash chips the second sector can be used: the offset 3146c609719bSwdenk for this sector is given here. 3147c609719bSwdenk 31486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE. 3149c609719bSwdenk 31500e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 3151c609719bSwdenk 3152c609719bSwdenk This is just another way to specify the start address of 3153c609719bSwdenk the flash sector containing the environment (instead of 31540e8d1586SJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_OFFSET). 3155c609719bSwdenk 31560e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SECT_SIZE: 3157c609719bSwdenk 3158c609719bSwdenk Size of the sector containing the environment. 3159c609719bSwdenk 3160c609719bSwdenk 3161c609719bSwdenk b) Sometimes flash chips have few, equal sized, BIG sectors. 3162c609719bSwdenk In such a case you don't want to spend a whole sector for 3163c609719bSwdenk the environment. 3164c609719bSwdenk 31650e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 3166c609719bSwdenk 31675a1aceb0SJean-Christophe PLAGNIOL-VILLARD If you use this in combination with CONFIG_ENV_IS_IN_FLASH 31680e8d1586SJean-Christophe PLAGNIOL-VILLARD and CONFIG_ENV_SECT_SIZE, you can specify to use only a part 3169c609719bSwdenk of this flash sector for the environment. This saves 3170c609719bSwdenk memory for the RAM copy of the environment. 3171c609719bSwdenk 3172c609719bSwdenk It may also save flash memory if you decide to use this 3173c609719bSwdenk when your environment is "embedded" within U-Boot code, 3174c609719bSwdenk since then the remainder of the flash sector could be used 3175c609719bSwdenk for U-Boot code. It should be pointed out that this is 3176c609719bSwdenk STRONGLY DISCOURAGED from a robustness point of view: 3177c609719bSwdenk updating the environment in flash makes it always 3178c609719bSwdenk necessary to erase the WHOLE sector. If something goes 3179c609719bSwdenk wrong before the contents has been restored from a copy in 3180c609719bSwdenk RAM, your target system will be dead. 3181c609719bSwdenk 31820e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR_REDUND 31830e8d1586SJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_SIZE_REDUND 3184c609719bSwdenk 3185c609719bSwdenk These settings describe a second storage area used to hold 318611ccc33fSMarcel Ziswiler a redundant copy of the environment data, so that there is 31873e38691eSwdenk a valid backup copy in case there is a power failure during 3188c609719bSwdenk a "saveenv" operation. 3189c609719bSwdenk 3190c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the 3191c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds* 3192c609719bSwdenkaccordingly! 3193c609719bSwdenk 3194c609719bSwdenk 31959314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM: 3196c609719bSwdenk 3197c609719bSwdenk Define this if you have some non-volatile memory device 3198c609719bSwdenk (NVRAM, battery buffered SRAM) which you want to use for the 3199c609719bSwdenk environment. 3200c609719bSwdenk 32010e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 32020e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 3203c609719bSwdenk 320411ccc33fSMarcel Ziswiler These two #defines are used to determine the memory area you 3205c609719bSwdenk want to use for environment. It is assumed that this memory 3206c609719bSwdenk can just be read and written to, without any special 3207c609719bSwdenk provision. 3208c609719bSwdenk 3209c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early 3210c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the 321111ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or 3212c609719bSwdenkU-Boot will hang. 3213c609719bSwdenk 3214c609719bSwdenkPlease note that even with NVRAM we still use a copy of the 3215c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to 3216c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv" 3217c609719bSwdenkto save the current settings. 3218c609719bSwdenk 3219c609719bSwdenk 3220bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM: 3221c609719bSwdenk 3222c609719bSwdenk Use this if you have an EEPROM or similar serial access 3223c609719bSwdenk device and a driver for it. 3224c609719bSwdenk 32250e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 32260e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 3227c609719bSwdenk 3228c609719bSwdenk These two #defines specify the offset and size of the 3229c609719bSwdenk environment area within the total memory of your EEPROM. 3230c609719bSwdenk 32316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR: 3232c609719bSwdenk If defined, specified the chip address of the EEPROM device. 3233c609719bSwdenk The default address is zero. 3234c609719bSwdenk 32356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS: 3236c609719bSwdenk If defined, the number of bits used to address bytes in a 3237c609719bSwdenk single page in the EEPROM device. A 64 byte page, for example 3238c609719bSwdenk would require six bits. 3239c609719bSwdenk 32406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS: 3241c609719bSwdenk If defined, the number of milliseconds to delay between 3242c609719bSwdenk page writes. The default is zero milliseconds. 3243c609719bSwdenk 32446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR_LEN: 3245c609719bSwdenk The length in bytes of the EEPROM memory array address. Note 3246c609719bSwdenk that this is NOT the chip address length! 3247c609719bSwdenk 32486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW: 32495cf91d6bSwdenk EEPROM chips that implement "address overflow" are ones 32505cf91d6bSwdenk like Catalyst 24WC04/08/16 which has 9/10/11 bits of 32515cf91d6bSwdenk address and the extra bits end up in the "chip address" bit 32525cf91d6bSwdenk slots. This makes a 24WC08 (1Kbyte) chip look like four 256 32535cf91d6bSwdenk byte chips. 32545cf91d6bSwdenk 32555cf91d6bSwdenk Note that we consider the length of the address field to 32565cf91d6bSwdenk still be one byte because the extra address bits are hidden 32575cf91d6bSwdenk in the chip address. 32585cf91d6bSwdenk 32596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_SIZE: 3260c609719bSwdenk The size in bytes of the EEPROM device. 3261c609719bSwdenk 3262548738b4SHeiko Schocher - CONFIG_ENV_EEPROM_IS_ON_I2C 3263548738b4SHeiko Schocher define this, if you have I2C and SPI activated, and your 3264548738b4SHeiko Schocher EEPROM, which holds the environment, is on the I2C bus. 3265548738b4SHeiko Schocher 3266548738b4SHeiko Schocher - CONFIG_I2C_ENV_EEPROM_BUS 3267548738b4SHeiko Schocher if you have an Environment on an EEPROM reached over 3268548738b4SHeiko Schocher I2C muxes, you can define here, how to reach this 3269548738b4SHeiko Schocher EEPROM. For example: 3270548738b4SHeiko Schocher 3271548738b4SHeiko Schocher #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0" 3272548738b4SHeiko Schocher 3273548738b4SHeiko Schocher EEPROM which holds the environment, is reached over 3274548738b4SHeiko Schocher a pca9547 i2c mux with address 0x70, channel 3. 3275c609719bSwdenk 3276057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH: 32775779d8d9Swdenk 32785779d8d9Swdenk Define this if you have a DataFlash memory device which you 32795779d8d9Swdenk want to use for the environment. 32805779d8d9Swdenk 32810e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 32820e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 32830e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 32845779d8d9Swdenk 32855779d8d9Swdenk These three #defines specify the offset and size of the 32865779d8d9Swdenk environment area within the total memory of your DataFlash placed 32875779d8d9Swdenk at the specified address. 32885779d8d9Swdenk 32890a85a9e7SLiu Gang- CONFIG_ENV_IS_IN_REMOTE: 32900a85a9e7SLiu Gang 32910a85a9e7SLiu Gang Define this if you have a remote memory space which you 32920a85a9e7SLiu Gang want to use for the local device's environment. 32930a85a9e7SLiu Gang 32940a85a9e7SLiu Gang - CONFIG_ENV_ADDR: 32950a85a9e7SLiu Gang - CONFIG_ENV_SIZE: 32960a85a9e7SLiu Gang 32970a85a9e7SLiu Gang These two #defines specify the address and size of the 32980a85a9e7SLiu Gang environment area within the remote memory space. The 32990a85a9e7SLiu Gang local device can get the environment from remote memory 3300fc54c7faSLiu Gang space by SRIO or PCIE links. 33010a85a9e7SLiu Gang 33020a85a9e7SLiu GangBE CAREFUL! For some special cases, the local device can not use 33030a85a9e7SLiu Gang"saveenv" command. For example, the local device will get the 3304fc54c7faSLiu Gangenvironment stored in a remote NOR flash by SRIO or PCIE link, 3305fc54c7faSLiu Gangbut it can not erase, write this NOR flash by SRIO or PCIE interface. 33060a85a9e7SLiu Gang 330751bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND: 330813a5695bSwdenk 330913a5695bSwdenk Define this if you have a NAND device which you want to use 331013a5695bSwdenk for the environment. 331113a5695bSwdenk 33120e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 33130e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 331413a5695bSwdenk 331513a5695bSwdenk These two #defines specify the offset and size of the environment 3316fdd813deSScott Wood area within the first NAND device. CONFIG_ENV_OFFSET must be 3317fdd813deSScott Wood aligned to an erase block boundary. 33185779d8d9Swdenk 3319fdd813deSScott Wood - CONFIG_ENV_OFFSET_REDUND (optional): 3320e443c944SMarkus Klotzbuecher 33210e8d1586SJean-Christophe PLAGNIOL-VILLARD This setting describes a second storage area of CONFIG_ENV_SIZE 3322fdd813deSScott Wood size used to hold a redundant copy of the environment data, so 3323fdd813deSScott Wood that there is a valid backup copy in case there is a power failure 3324fdd813deSScott Wood during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be 3325fdd813deSScott Wood aligned to an erase block boundary. 3326e443c944SMarkus Klotzbuecher 3327fdd813deSScott Wood - CONFIG_ENV_RANGE (optional): 3328fdd813deSScott Wood 3329fdd813deSScott Wood Specifies the length of the region in which the environment 3330fdd813deSScott Wood can be written. This should be a multiple of the NAND device's 3331fdd813deSScott Wood block size. Specifying a range with more erase blocks than 3332fdd813deSScott Wood are needed to hold CONFIG_ENV_SIZE allows bad blocks within 3333fdd813deSScott Wood the range to be avoided. 3334fdd813deSScott Wood 3335fdd813deSScott Wood - CONFIG_ENV_OFFSET_OOB (optional): 3336fdd813deSScott Wood 3337fdd813deSScott Wood Enables support for dynamically retrieving the offset of the 3338fdd813deSScott Wood environment from block zero's out-of-band data. The 3339fdd813deSScott Wood "nand env.oob" command can be used to record this offset. 3340fdd813deSScott Wood Currently, CONFIG_ENV_OFFSET_REDUND is not supported when 3341fdd813deSScott Wood using CONFIG_ENV_OFFSET_OOB. 3342e443c944SMarkus Klotzbuecher 3343b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST 3344b74ab737SGuennadi Liakhovetski 3345b74ab737SGuennadi Liakhovetski Defines address in RAM to which the nand_spl code should copy the 3346b74ab737SGuennadi Liakhovetski environment. If redundant environment is used, it will be copied to 3347b74ab737SGuennadi Liakhovetski CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE. 3348b74ab737SGuennadi Liakhovetski 33496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET 3350c609719bSwdenk 3351c609719bSwdenk Defines offset to the initial SPI buffer area in DPRAM. The 3352c609719bSwdenk area is used at an early stage (ROM part) if the environment 3353c609719bSwdenk is configured to reside in the SPI EEPROM: We need a 520 byte 3354c609719bSwdenk scratch DPRAM area. It is used between the two initialization 3355c609719bSwdenk calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems 3356c609719bSwdenk to be a good choice since it makes it far enough from the 3357c609719bSwdenk start of the data area as well as from the stack pointer. 3358c609719bSwdenk 3359e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor 3360c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been 3361cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f() 3362c609719bSwdenkuntil then to read environment variables. 3363c609719bSwdenk 336485ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor 336585ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working 336685ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is 336785ec0bccSwdenknecessary, because the first environment variable we need is the 336885ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't 336985ec0bccSwdenkhave any device yet where we could complain.] 3370c609719bSwdenk 3371c609719bSwdenkNote: once the monitor has been relocated, then it will complain if 3372c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you 337385ec0bccSwdenkuse the "saveenv" command to store a valid environment. 3374c609719bSwdenk 33756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN: 3376fc3e2165Swdenk Echo the inverted Ethernet link state to the fault LED. 3377fc3e2165Swdenk 33786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR 3379fc3e2165Swdenk also needs to be defined. 3380fc3e2165Swdenk 33816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR: 3382fc3e2165Swdenk MII address of the PHY to check for the Ethernet link state. 3383c609719bSwdenk 3384f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS: 3385f5675aa5SRon Madrid Define this if you desire to only have use of the NS16550_init 3386f5675aa5SRon Madrid and NS16550_putc functions for the serial driver located at 3387f5675aa5SRon Madrid drivers/serial/ns16550.c. This option is useful for saving 3388f5675aa5SRon Madrid space for already greatly restricted images, including but not 3389f5675aa5SRon Madrid limited to NAND_SPL configurations. 3390f5675aa5SRon Madrid 3391c609719bSwdenkLow Level (hardware related) configuration options: 3392dc7c9a1aSwdenk--------------------------------------------------- 3393c609719bSwdenk 33946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE: 3395c609719bSwdenk Cache Line Size of the CPU. 3396c609719bSwdenk 33976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR: 3398c609719bSwdenk Default address of the IMMR after system reset. 33992535d602Swdenk 34002535d602Swdenk Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU, 34012535d602Swdenk and RPXsuper) to be able to adjust the position of 34022535d602Swdenk the IMMR register after a reset. 3403c609719bSwdenk 3404e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT: 3405e46fedfeSTimur Tabi Default (power-on reset) physical address of CCSR on Freescale 3406e46fedfeSTimur Tabi PowerPC SOCs. 3407e46fedfeSTimur Tabi 3408e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR: 3409e46fedfeSTimur Tabi Virtual address of CCSR. On a 32-bit build, this is typically 3410e46fedfeSTimur Tabi the same value as CONFIG_SYS_CCSRBAR_DEFAULT. 3411e46fedfeSTimur Tabi 3412e46fedfeSTimur Tabi CONFIG_SYS_DEFAULT_IMMR must also be set to this value, 3413e46fedfeSTimur Tabi for cross-platform code that uses that macro instead. 3414e46fedfeSTimur Tabi 3415e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS: 3416e46fedfeSTimur Tabi Physical address of CCSR. CCSR can be relocated to a new 3417e46fedfeSTimur Tabi physical address, if desired. In this case, this macro should 3418e46fedfeSTimur Tabi be set to that address. Otherwise, it should be set to the 3419e46fedfeSTimur Tabi same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR 3420e46fedfeSTimur Tabi is typically relocated on 36-bit builds. It is recommended 3421e46fedfeSTimur Tabi that this macro be defined via the _HIGH and _LOW macros: 3422e46fedfeSTimur Tabi 3423e46fedfeSTimur Tabi #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH 3424e46fedfeSTimur Tabi * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW) 3425e46fedfeSTimur Tabi 3426e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH: 3427e46fedfeSTimur Tabi Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically 3428e46fedfeSTimur Tabi either 0 (32-bit build) or 0xF (36-bit build). This macro is 3429e46fedfeSTimur Tabi used in assembly code, so it must not contain typecasts or 3430e46fedfeSTimur Tabi integer size suffixes (e.g. "ULL"). 3431e46fedfeSTimur Tabi 3432e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW: 3433e46fedfeSTimur Tabi Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is 3434e46fedfeSTimur Tabi used in assembly code, so it must not contain typecasts or 3435e46fedfeSTimur Tabi integer size suffixes (e.g. "ULL"). 3436e46fedfeSTimur Tabi 3437e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE: 3438e46fedfeSTimur Tabi If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be 3439e46fedfeSTimur Tabi forced to a value that ensures that CCSR is not relocated. 3440e46fedfeSTimur Tabi 34417f6c2cbcSwdenk- Floppy Disk Support: 34426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FDC_DRIVE_NUMBER 34437f6c2cbcSwdenk 34447f6c2cbcSwdenk the default drive number (default value 0) 34457f6c2cbcSwdenk 34466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_ISA_IO_STRIDE 34477f6c2cbcSwdenk 344811ccc33fSMarcel Ziswiler defines the spacing between FDC chipset registers 34497f6c2cbcSwdenk (default value 1) 34507f6c2cbcSwdenk 34516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_ISA_IO_OFFSET 34527f6c2cbcSwdenk 34537f6c2cbcSwdenk defines the offset of register from address. It 34547f6c2cbcSwdenk depends on which part of the data bus is connected to 345511ccc33fSMarcel Ziswiler the FDC chipset. (default value 0) 34567f6c2cbcSwdenk 34576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and 34586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their 34597f6c2cbcSwdenk default value. 34607f6c2cbcSwdenk 34616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD if CONFIG_SYS_FDC_HW_INIT is defined, then the function 34627f6c2cbcSwdenk fdc_hw_init() is called at the beginning of the FDC 34637f6c2cbcSwdenk setup. fdc_hw_init() must be provided by the board 34647f6c2cbcSwdenk source code. It is used to make hardware dependant 34657f6c2cbcSwdenk initializations. 34667f6c2cbcSwdenk 34670abddf82SMacpaul Lin- CONFIG_IDE_AHB: 34680abddf82SMacpaul Lin Most IDE controllers were designed to be connected with PCI 34690abddf82SMacpaul Lin interface. Only few of them were designed for AHB interface. 34700abddf82SMacpaul Lin When software is doing ATA command and data transfer to 34710abddf82SMacpaul Lin IDE devices through IDE-AHB controller, some additional 34720abddf82SMacpaul Lin registers accessing to these kind of IDE-AHB controller 34730abddf82SMacpaul Lin is requierd. 34740abddf82SMacpaul Lin 34756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR: Physical address of the Internal Memory. 347625d6712aSwdenk DO NOT CHANGE unless you know exactly what you're 347725d6712aSwdenk doing! (11-4) [MPC8xx/82xx systems only] 3478c609719bSwdenk 34796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR: 3480c609719bSwdenk 34817152b1d0Swdenk Start address of memory area that can be used for 3482c609719bSwdenk initial data and stack; please note that this must be 3483c609719bSwdenk writable memory that is working WITHOUT special 3484c609719bSwdenk initialization, i. e. you CANNOT use normal RAM which 3485c609719bSwdenk will become available only after programming the 3486c609719bSwdenk memory controller and running certain initialization 3487c609719bSwdenk sequences. 3488c609719bSwdenk 3489c609719bSwdenk U-Boot uses the following memory types: 3490c609719bSwdenk - MPC8xx and MPC8260: IMMR (internal memory of the CPU) 3491c609719bSwdenk - MPC824X: data cache 3492c609719bSwdenk - PPC4xx: data cache 3493c609719bSwdenk 34946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET: 3495c609719bSwdenk 3496c609719bSwdenk Offset of the initial data structure in the memory 34976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually 34986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial 3499c609719bSwdenk data is located at the end of the available space 3500553f0982SWolfgang Denk (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE - 35016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just 35026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR + 35036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_GBL_DATA_OFFSET) downward. 3504c609719bSwdenk 3505c609719bSwdenk Note: 3506c609719bSwdenk On the MPC824X (or other systems that use the data 3507c609719bSwdenk cache for initial memory) the address chosen for 35086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must 3509c609719bSwdenk point to an otherwise UNUSED address space between 3510c609719bSwdenk the top of RAM and the start of the PCI space. 3511c609719bSwdenk 35126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6) 3513c609719bSwdenk 35146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR: System Protection Control (11-9) 3515c609719bSwdenk 35166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26) 3517c609719bSwdenk 35186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31) 3519c609719bSwdenk 35206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30) 3521c609719bSwdenk 35226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27) 3523c609719bSwdenk 35246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM: 3525c609719bSwdenk SDRAM timing 3526c609719bSwdenk 35276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA: 3528c609719bSwdenk periodic timer for refresh 3529c609719bSwdenk 35306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER: Debug Event Register (37-47) 3531c609719bSwdenk 35326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM, 35336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP, 35346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM, 35356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BR1_PRELIM: 3536c609719bSwdenk Memory Controller Definitions: BR0/1 and OR0/1 (FLASH) 3537c609719bSwdenk 3538c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE, 35396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM, 35406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM: 3541c609719bSwdenk Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM) 3542c609719bSwdenk 35436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K, 35446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL: 3545c609719bSwdenk Machine Mode Register and Memory Periodic Timer 3546c609719bSwdenk Prescaler definitions (SDRAM timing) 3547c609719bSwdenk 35486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]: 3549c609719bSwdenk enable I2C microcode relocation patch (MPC8xx); 3550c609719bSwdenk define relocation offset in DPRAM [DSP2] 3551c609719bSwdenk 35526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]: 3553b423d055SHeiko Schocher enable SMC microcode relocation patch (MPC8xx); 3554b423d055SHeiko Schocher define relocation offset in DPRAM [SMC1] 3555b423d055SHeiko Schocher 35566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]: 3557c609719bSwdenk enable SPI microcode relocation patch (MPC8xx); 3558c609719bSwdenk define relocation offset in DPRAM [SCC4] 3559c609719bSwdenk 35606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK: 3561c609719bSwdenk Use OSCM clock mode on MBX8xx board. Be careful, 3562c609719bSwdenk wrong setting might damage your board. Read 3563c609719bSwdenk doc/README.MBX before setting this variable! 3564c609719bSwdenk 35656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only) 3566ea909b76Swdenk Offset of the bootmode word in DPRAM used by post 3567ea909b76Swdenk (Power On Self Tests). This definition overrides 3568ea909b76Swdenk #define'd default value in commproc.h resp. 3569ea909b76Swdenk cpm_8260.h. 3570ea909b76Swdenk 35716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB, 35726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL, 35736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS, 35746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB, 35756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START, 35766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL, 35776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE, 35786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only) 3579a47a12beSStefan Roese Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set. 35805d232d0eSwdenk 35819cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE: 35829cacf4fcSDirk Eibach Disable PCI-Express on systems where it is supported but not 35839cacf4fcSDirk Eibach required. 35849cacf4fcSDirk Eibach 358569fd2d3bSAndrew Sharp- CONFIG_PCI_ENUM_ONLY 358669fd2d3bSAndrew Sharp Only scan through and get the devices on the busses. 358769fd2d3bSAndrew Sharp Don't do any setup work, presumably because someone or 358869fd2d3bSAndrew Sharp something has already done it, and we don't need to do it 358969fd2d3bSAndrew Sharp a second time. Useful for platforms that are pre-booted 359069fd2d3bSAndrew Sharp by coreboot or similar. 359169fd2d3bSAndrew Sharp 3592a09b9b68SKumar Gala- CONFIG_SYS_SRIO: 3593a09b9b68SKumar Gala Chip has SRIO or not 3594a09b9b68SKumar Gala 3595a09b9b68SKumar Gala- CONFIG_SRIO1: 3596a09b9b68SKumar Gala Board has SRIO 1 port available 3597a09b9b68SKumar Gala 3598a09b9b68SKumar Gala- CONFIG_SRIO2: 3599a09b9b68SKumar Gala Board has SRIO 2 port available 3600a09b9b68SKumar Gala 3601a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT: 3602a09b9b68SKumar Gala Virtual Address of SRIO port 'n' memory region 3603a09b9b68SKumar Gala 3604a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS: 3605a09b9b68SKumar Gala Physical Address of SRIO port 'n' memory region 3606a09b9b68SKumar Gala 3607a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE: 3608a09b9b68SKumar Gala Size of SRIO port 'n' memory region 3609a09b9b68SKumar Gala 3610eced4626SAlex Waterman- CONFIG_SYS_NDFC_16 3611eced4626SAlex Waterman Defined to tell the NDFC that the NAND chip is using a 3612eced4626SAlex Waterman 16 bit bus. 3613eced4626SAlex Waterman 3614eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG 3615eced4626SAlex Waterman Sets the EBC0_CFG register for the NDFC. If not defined 3616eced4626SAlex Waterman a default value will be used. 3617eced4626SAlex Waterman 3618bb99ad6dSBen Warren- CONFIG_SPD_EEPROM 3619218ca724SWolfgang Denk Get DDR timing information from an I2C EEPROM. Common 3620218ca724SWolfgang Denk with pluggable memory modules such as SODIMMs 3621218ca724SWolfgang Denk 3622bb99ad6dSBen Warren SPD_EEPROM_ADDRESS 3623bb99ad6dSBen Warren I2C address of the SPD EEPROM 3624bb99ad6dSBen Warren 36256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM 3626218ca724SWolfgang Denk If SPD EEPROM is on an I2C bus other than the first 3627218ca724SWolfgang Denk one, specify here. Note that the value must resolve 3628218ca724SWolfgang Denk to something your driver can deal with. 3629bb99ad6dSBen Warren 36301b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING 36311b3e3c4fSYork Sun Get DDR timing information from other than SPD. Common with 36321b3e3c4fSYork Sun soldered DDR chips onboard without SPD. DDR raw timing 36331b3e3c4fSYork Sun parameters are extracted from datasheet and hard-coded into 36341b3e3c4fSYork Sun header files or board specific files. 36351b3e3c4fSYork Sun 36366f5e1dc5SYork Sun- CONFIG_FSL_DDR_INTERACTIVE 36376f5e1dc5SYork Sun Enable interactive DDR debugging. See doc/README.fsl-ddr. 36386f5e1dc5SYork Sun 36396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0 3640218ca724SWolfgang Denk Only for 83xx systems. If specified, then DDR should 3641218ca724SWolfgang Denk be configured using CS0 and CS1 instead of CS2 and CS3. 36422ad6b513STimur Tabi 3643c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12] 3644c26e454dSwdenk Define to enable FEC[12] on a 8xx series processor. 3645c26e454dSwdenk 3646c26e454dSwdenk- CONFIG_FEC[12]_PHY 3647c26e454dSwdenk Define to the hardcoded PHY address which corresponds 36486e592385Swdenk to the given FEC; i. e. 3649c26e454dSwdenk #define CONFIG_FEC1_PHY 4 3650c26e454dSwdenk means that the PHY with address 4 is connected to FEC1 3651c26e454dSwdenk 3652c26e454dSwdenk When set to -1, means to probe for first available. 3653c26e454dSwdenk 3654c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR 3655c26e454dSwdenk The PHY does not have a RXERR line (RMII only). 3656c26e454dSwdenk (so program the FEC to ignore it). 3657c26e454dSwdenk 3658c26e454dSwdenk- CONFIG_RMII 3659c26e454dSwdenk Enable RMII mode for all FECs. 3660c26e454dSwdenk Note that this is a global option, we can't 3661c26e454dSwdenk have one FEC in standard MII mode and another in RMII mode. 3662c26e454dSwdenk 36635cf91d6bSwdenk- CONFIG_CRC32_VERIFY 36645cf91d6bSwdenk Add a verify option to the crc32 command. 36655cf91d6bSwdenk The syntax is: 36665cf91d6bSwdenk 36675cf91d6bSwdenk => crc32 -v <address> <count> <crc32> 36685cf91d6bSwdenk 36695cf91d6bSwdenk Where address/count indicate a memory area 36705cf91d6bSwdenk and crc32 is the correct crc32 which the 36715cf91d6bSwdenk area should have. 36725cf91d6bSwdenk 367356523f12Swdenk- CONFIG_LOOPW 367456523f12Swdenk Add the "loopw" memory command. This only takes effect if 3675602ad3b3SJon Loeliger the memory commands are activated globally (CONFIG_CMD_MEM). 367656523f12Swdenk 36777b466641Sstroese- CONFIG_MX_CYCLIC 36787b466641Sstroese Add the "mdc" and "mwc" memory commands. These are cyclic 36797b466641Sstroese "md/mw" commands. 36807b466641Sstroese Examples: 36817b466641Sstroese 36827b466641Sstroese => mdc.b 10 4 500 36837b466641Sstroese This command will print 4 bytes (10,11,12,13) each 500 ms. 36847b466641Sstroese 36857b466641Sstroese => mwc.l 100 12345678 10 36867b466641Sstroese This command will write 12345678 to address 100 all 10 ms. 36877b466641Sstroese 36887b466641Sstroese This only takes effect if the memory commands are activated 3689602ad3b3SJon Loeliger globally (CONFIG_CMD_MEM). 36907b466641Sstroese 36918aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT 3692afc1ce82SMacpaul Lin [ARM, NDS32, MIPS only] If this variable is defined, then certain 3693e03f3169SWolfgang Denk low level initializations (like setting up the memory 3694e03f3169SWolfgang Denk controller) are omitted and/or U-Boot does not 3695e03f3169SWolfgang Denk relocate itself into RAM. 36968aa1a2d1Swdenk 3697e03f3169SWolfgang Denk Normally this variable MUST NOT be defined. The only 3698e03f3169SWolfgang Denk exception is when U-Boot is loaded (to RAM) by some 3699e03f3169SWolfgang Denk other boot loader or by a debugger which performs 3700e03f3169SWolfgang Denk these initializations itself. 37018aa1a2d1Swdenk 3702401bb30bSAneesh V- CONFIG_SPL_BUILD 3703df81238bSMagnus Lilja Modifies the behaviour of start.S when compiling a loader 3704df81238bSMagnus Lilja that is executed before the actual U-Boot. E.g. when 3705df81238bSMagnus Lilja compiling a NAND SPL. 3706400558b5Swdenk 3707d8834a13SMatthias Weisser- CONFIG_USE_ARCH_MEMCPY 3708d8834a13SMatthias Weisser CONFIG_USE_ARCH_MEMSET 3709d8834a13SMatthias Weisser If these options are used a optimized version of memcpy/memset will 3710d8834a13SMatthias Weisser be used if available. These functions may be faster under some 3711d8834a13SMatthias Weisser conditions but may increase the binary size. 3712d8834a13SMatthias Weisser 3713b16f521aSGabe Black- CONFIG_X86_NO_RESET_VECTOR 3714b16f521aSGabe Black If defined, the x86 reset vector code is excluded. You will need 3715b16f521aSGabe Black to do this when U-Boot is running from Coreboot. 3716b16f521aSGabe Black 37175b5ece9eSGabe Black- CONFIG_X86_NO_REAL_MODE 37185b5ece9eSGabe Black If defined, x86 real mode code is omitted. This assumes a 37195b5ece9eSGabe Black 32-bit environment where such code is not needed. You will 37205b5ece9eSGabe Black need to do this when U-Boot is running from Coreboot. 37215b5ece9eSGabe Black 37225b5ece9eSGabe Black 3723f2717b47STimur TabiFreescale QE/FMAN Firmware Support: 3724f2717b47STimur Tabi----------------------------------- 3725f2717b47STimur Tabi 3726f2717b47STimur TabiThe Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the 3727f2717b47STimur Tabiloading of "firmware", which is encoded in the QE firmware binary format. 3728f2717b47STimur TabiThis firmware often needs to be loaded during U-Boot booting, so macros 3729f2717b47STimur Tabiare used to identify the storage device (NOR flash, SPI, etc) and the address 3730f2717b47STimur Tabiwithin that device. 3731f2717b47STimur Tabi 3732f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_ADDR 3733f2717b47STimur Tabi The address in the storage device where the firmware is located. The 3734f2717b47STimur Tabi meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro 3735f2717b47STimur Tabi is also specified. 3736f2717b47STimur Tabi 3737f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_LENGTH 3738f2717b47STimur Tabi The maximum possible size of the firmware. The firmware binary format 3739f2717b47STimur Tabi has a field that specifies the actual size of the firmware, but it 3740f2717b47STimur Tabi might not be possible to read any part of the firmware unless some 3741f2717b47STimur Tabi local storage is allocated to hold the entire firmware first. 3742f2717b47STimur Tabi 3743f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NOR 3744f2717b47STimur Tabi Specifies that QE/FMAN firmware is located in NOR flash, mapped as 3745f2717b47STimur Tabi normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the 3746f2717b47STimur Tabi virtual address in NOR flash. 3747f2717b47STimur Tabi 3748f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NAND 3749f2717b47STimur Tabi Specifies that QE/FMAN firmware is located in NAND flash. 3750f2717b47STimur Tabi CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash. 3751f2717b47STimur Tabi 3752f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_MMC 3753f2717b47STimur Tabi Specifies that QE/FMAN firmware is located on the primary SD/MMC 3754f2717b47STimur Tabi device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device. 3755f2717b47STimur Tabi 3756f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH 3757f2717b47STimur Tabi Specifies that QE/FMAN firmware is located on the primary SPI 3758f2717b47STimur Tabi device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device. 3759f2717b47STimur Tabi 3760292dc6c5SLiu Gang- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE 3761292dc6c5SLiu Gang Specifies that QE/FMAN firmware is located in the remote (master) 3762292dc6c5SLiu Gang memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which 3763fc54c7faSLiu Gang can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound 3764fc54c7faSLiu Gang window->master inbound window->master LAW->the ucode address in 3765fc54c7faSLiu Gang master's memory space. 3766f2717b47STimur Tabi 3767c609719bSwdenkBuilding the Software: 3768c609719bSwdenk====================== 3769c609719bSwdenk 3770218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments 3771218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support 3772218ca724SWolfgang Denkall possibly existing versions of cross development tools in all 3773218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we 3774218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK) 3775218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot. 3776c609719bSwdenk 3777218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you 3778218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case, 3779218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell. 3780218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are 3781218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter: 3782c609719bSwdenk 3783218ca724SWolfgang Denk $ CROSS_COMPILE=ppc_4xx- 3784218ca724SWolfgang Denk $ export CROSS_COMPILE 3785c609719bSwdenk 37862f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in 37872f8d396bSPeter Tyser the tools directory you can use the MinGW toolchain 37882f8d396bSPeter Tyser (http://www.mingw.org). Set your HOST tools to the MinGW 37892f8d396bSPeter Tyser toolchain and execute 'make tools'. For example: 37902f8d396bSPeter Tyser 37912f8d396bSPeter Tyser $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools 37922f8d396bSPeter Tyser 37932f8d396bSPeter Tyser Binaries such as tools/mkimage.exe will be created which can 37942f8d396bSPeter Tyser be executed on computers running Windows. 37952f8d396bSPeter Tyser 3796c609719bSwdenkU-Boot is intended to be simple to build. After installing the 3797c609719bSwdenksources you must configure U-Boot for one specific board type. This 3798c609719bSwdenkis done by typing: 3799c609719bSwdenk 3800c609719bSwdenk make NAME_config 3801c609719bSwdenk 3802218ca724SWolfgang Denkwhere "NAME_config" is the name of one of the existing configu- 38034d675ae6SMichael Jonesrations; see boards.cfg for supported names. 380454387ac9Swdenk 3805c609719bSwdenkNote: for some board special configuration names may exist; check if 3806c609719bSwdenk additional information is available from the board vendor; for 38072729af9dSwdenk instance, the TQM823L systems are available without (standard) 38082729af9dSwdenk or with LCD support. You can select such additional "features" 380911ccc33fSMarcel Ziswiler when choosing the configuration, i. e. 3810c609719bSwdenk 38112729af9dSwdenk make TQM823L_config 38122729af9dSwdenk - will configure for a plain TQM823L, i. e. no LCD support 3813c609719bSwdenk 3814c609719bSwdenk make TQM823L_LCD_config 3815c609719bSwdenk - will configure for a TQM823L with U-Boot console on LCD 3816c609719bSwdenk 3817c609719bSwdenk etc. 3818c609719bSwdenk 3819c609719bSwdenk 3820c609719bSwdenkFinally, type "make all", and you should get some working U-Boot 38217152b1d0Swdenkimages ready for download to / installation on your system: 3822c609719bSwdenk 3823c609719bSwdenk- "u-boot.bin" is a raw binary image 3824c609719bSwdenk- "u-boot" is an image in ELF binary format 3825c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format 3826c609719bSwdenk 3827baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved 3828baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change 3829baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory: 3830baf31249SMarian Balakowicz 3831baf31249SMarian Balakowicz1. Add O= to the make command line invocations: 3832baf31249SMarian Balakowicz 3833baf31249SMarian Balakowicz make O=/tmp/build distclean 3834baf31249SMarian Balakowicz make O=/tmp/build NAME_config 3835baf31249SMarian Balakowicz make O=/tmp/build all 3836baf31249SMarian Balakowicz 3837baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location: 3838baf31249SMarian Balakowicz 3839baf31249SMarian Balakowicz export BUILD_DIR=/tmp/build 3840baf31249SMarian Balakowicz make distclean 3841baf31249SMarian Balakowicz make NAME_config 3842baf31249SMarian Balakowicz make all 3843baf31249SMarian Balakowicz 3844baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment 3845baf31249SMarian Balakowiczvariable. 3846baf31249SMarian Balakowicz 3847c609719bSwdenk 3848c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so 3849c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of 3850c609719bSwdenknative "make". 3851c609719bSwdenk 3852c609719bSwdenk 3853c609719bSwdenkIf the system board that you have is not listed, then you will need 3854c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these 3855c609719bSwdenksteps: 3856c609719bSwdenk 3857c609719bSwdenk1. Add a new configuration option for your board to the toplevel 38584d675ae6SMichael Jones "boards.cfg" file, using the existing entries as examples. 38594d675ae6SMichael Jones Follow the instructions there to keep the boards in order. 3860c609719bSwdenk2. Create a new directory to hold your board specific code. Add any 386185ec0bccSwdenk files you need. In your board directory, you will need at least 386285ec0bccSwdenk the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds". 386385ec0bccSwdenk3. Create a new configuration file "include/configs/<board>.h" for 386485ec0bccSwdenk your board 3865c609719bSwdenk3. If you're porting U-Boot to a new CPU, then also create a new 3866c609719bSwdenk directory to hold your CPU specific code. Add any files you need. 386785ec0bccSwdenk4. Run "make <board>_config" with your new name. 3868c609719bSwdenk5. Type "make", and you should get a working "u-boot.srec" file 3869c609719bSwdenk to be installed on your target system. 387085ec0bccSwdenk6. Debug and solve any problems that might arise. 3871c609719bSwdenk [Of course, this last step is much harder than it sounds.] 3872c609719bSwdenk 3873c609719bSwdenk 3874c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.: 3875c609719bSwdenk============================================================== 3876c609719bSwdenk 3877c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board 3878c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to 3879c609719bSwdenkprovide feedback to the other developers. The feedback normally takes 3880c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest 3881218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources. 3882c609719bSwdenk 3883c609719bSwdenkBut before you submit such a patch, please verify that your modifi- 3884c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of 3885c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so, 3886c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot 3887c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can 38887152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE' 3889218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools 3890218ca724SWolfgang Denkyou can type 3891c609719bSwdenk 3892c609719bSwdenk CROSS_COMPILE=ppc_8xx- MAKEALL 3893c609719bSwdenk 3894c609719bSwdenkor to build on a native PowerPC system you can type 3895c609719bSwdenk 3896c609719bSwdenk CROSS_COMPILE=' ' MAKEALL 3897c609719bSwdenk 3898218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build 3899218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by 3900218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target 3901218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and 3902218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default 3903218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment 3904218ca724SWolfgang Denkvariable. For example: 3905baf31249SMarian Balakowicz 3906baf31249SMarian Balakowicz export BUILD_DIR=/tmp/build 3907baf31249SMarian Balakowicz export MAKEALL_LOGDIR=/tmp/log 3908baf31249SMarian Balakowicz CROSS_COMPILE=ppc_8xx- MAKEALL 3909baf31249SMarian Balakowicz 3910218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build, 3911218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean 3912218ca724SWolfgang Denkduring the whole build process. 3913baf31249SMarian Balakowicz 3914baf31249SMarian Balakowicz 3915c609719bSwdenkSee also "U-Boot Porting Guide" below. 3916c609719bSwdenk 3917c609719bSwdenk 3918c609719bSwdenkMonitor Commands - Overview: 3919c609719bSwdenk============================ 3920c609719bSwdenk 3921c609719bSwdenkgo - start application at address 'addr' 3922c609719bSwdenkrun - run commands in an environment variable 3923c609719bSwdenkbootm - boot application image from memory 3924c609719bSwdenkbootp - boot image via network using BootP/TFTP protocol 392544f074c7SMarek Vasutbootz - boot zImage from memory 3926c609719bSwdenktftpboot- boot image via network using TFTP protocol 3927c609719bSwdenk and env variables "ipaddr" and "serverip" 3928c609719bSwdenk (and eventually "gatewayip") 39291fb7cd49SSimon Glasstftpput - upload a file via network using TFTP protocol 3930c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol 3931c609719bSwdenkdiskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd' 3932c609719bSwdenkloads - load S-Record file over serial line 3933c609719bSwdenkloadb - load binary file over serial line (kermit mode) 3934c609719bSwdenkmd - memory display 3935c609719bSwdenkmm - memory modify (auto-incrementing) 3936c609719bSwdenknm - memory modify (constant address) 3937c609719bSwdenkmw - memory write (fill) 3938c609719bSwdenkcp - memory copy 3939c609719bSwdenkcmp - memory compare 3940c609719bSwdenkcrc32 - checksum calculation 39410f89c54bSPeter Tyseri2c - I2C sub-system 3942c609719bSwdenksspi - SPI utility commands 3943c609719bSwdenkbase - print or set address offset 3944c609719bSwdenkprintenv- print environment variables 3945c609719bSwdenksetenv - set environment variables 3946c609719bSwdenksaveenv - save environment variables to persistent storage 3947c609719bSwdenkprotect - enable or disable FLASH write protection 3948c609719bSwdenkerase - erase FLASH memory 3949c609719bSwdenkflinfo - print FLASH memory information 395010635afaSKarl O. Pincnand - NAND memory operations (see doc/README.nand) 3951c609719bSwdenkbdinfo - print Board Info structure 3952c609719bSwdenkiminfo - print header information for application image 3953c609719bSwdenkconinfo - print console devices and informations 3954c609719bSwdenkide - IDE sub-system 3955c609719bSwdenkloop - infinite loop on address range 395656523f12Swdenkloopw - infinite write loop on address range 3957c609719bSwdenkmtest - simple RAM test 3958c609719bSwdenkicache - enable or disable instruction cache 3959c609719bSwdenkdcache - enable or disable data cache 3960c609719bSwdenkreset - Perform RESET of the CPU 3961c609719bSwdenkecho - echo args to console 3962c609719bSwdenkversion - print monitor version 3963c609719bSwdenkhelp - print online help 3964c609719bSwdenk? - alias for 'help' 3965c609719bSwdenk 3966c609719bSwdenk 3967c609719bSwdenkMonitor Commands - Detailed Description: 3968c609719bSwdenk======================================== 3969c609719bSwdenk 3970c609719bSwdenkTODO. 3971c609719bSwdenk 3972c609719bSwdenkFor now: just type "help <command>". 3973c609719bSwdenk 3974c609719bSwdenk 3975c609719bSwdenkEnvironment Variables: 3976c609719bSwdenk====================== 3977c609719bSwdenk 3978c609719bSwdenkU-Boot supports user configuration using Environment Variables which 3979c609719bSwdenkcan be made persistent by saving to Flash memory. 3980c609719bSwdenk 3981c609719bSwdenkEnvironment Variables are set using "setenv", printed using 3982c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv" 3983c609719bSwdenkwithout a value can be used to delete a variable from the 3984c609719bSwdenkenvironment. As long as you don't save the environment you are 3985c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the 3986c609719bSwdenkenvironment is erased by accident, a default environment is provided. 3987c609719bSwdenk 3988c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables. 3989c96f86eeSWolfgang Denk 3990c96f86eeSWolfgang DenkList of environment variables (most likely not complete): 3991c609719bSwdenk 3992c609719bSwdenk baudrate - see CONFIG_BAUDRATE 3993c609719bSwdenk 3994c609719bSwdenk bootdelay - see CONFIG_BOOTDELAY 3995c609719bSwdenk 3996c609719bSwdenk bootcmd - see CONFIG_BOOTCOMMAND 3997c609719bSwdenk 3998c609719bSwdenk bootargs - Boot arguments when booting an RTOS image 3999c609719bSwdenk 4000c609719bSwdenk bootfile - Name of the image to load with TFTP 4001c609719bSwdenk 40027d721e34SBartlomiej Sieka bootm_low - Memory range available for image processing in the bootm 40037d721e34SBartlomiej Sieka command can be restricted. This variable is given as 40047d721e34SBartlomiej Sieka a hexadecimal number and defines lowest address allowed 40057d721e34SBartlomiej Sieka for use by the bootm command. See also "bootm_size" 40067d721e34SBartlomiej Sieka environment variable. Address defined by "bootm_low" is 40077d721e34SBartlomiej Sieka also the base of the initial memory mapping for the Linux 4008c3624e6eSGrant Likely kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and 4009c3624e6eSGrant Likely bootm_mapsize. 4010c3624e6eSGrant Likely 4011c3624e6eSGrant Likely bootm_mapsize - Size of the initial memory mapping for the Linux kernel. 4012c3624e6eSGrant Likely This variable is given as a hexadecimal number and it 4013c3624e6eSGrant Likely defines the size of the memory region starting at base 4014c3624e6eSGrant Likely address bootm_low that is accessible by the Linux kernel 4015c3624e6eSGrant Likely during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used 4016c3624e6eSGrant Likely as the default value if it is defined, and bootm_size is 4017c3624e6eSGrant Likely used otherwise. 40187d721e34SBartlomiej Sieka 40197d721e34SBartlomiej Sieka bootm_size - Memory range available for image processing in the bootm 40207d721e34SBartlomiej Sieka command can be restricted. This variable is given as 40217d721e34SBartlomiej Sieka a hexadecimal number and defines the size of the region 40227d721e34SBartlomiej Sieka allowed for use by the bootm command. See also "bootm_low" 40237d721e34SBartlomiej Sieka environment variable. 40247d721e34SBartlomiej Sieka 40254bae9090SBartlomiej Sieka updatefile - Location of the software update file on a TFTP server, used 40264bae9090SBartlomiej Sieka by the automatic software update feature. Please refer to 40274bae9090SBartlomiej Sieka documentation in doc/README.update for more details. 40284bae9090SBartlomiej Sieka 4029c609719bSwdenk autoload - if set to "no" (any string beginning with 'n'), 4030c609719bSwdenk "bootp" will just load perform a lookup of the 4031c609719bSwdenk configuration from the BOOTP server, but not try to 4032c609719bSwdenk load any image using TFTP 4033c609719bSwdenk 4034c609719bSwdenk autostart - if set to "yes", an image loaded using the "bootp", 4035c609719bSwdenk "rarpboot", "tftpboot" or "diskboot" commands will 4036c609719bSwdenk be automatically started (by internally calling 4037c609719bSwdenk "bootm") 4038c609719bSwdenk 40394a6fd34bSwdenk If set to "no", a standalone image passed to the 40404a6fd34bSwdenk "bootm" command will be copied to the load address 40414a6fd34bSwdenk (and eventually uncompressed), but NOT be started. 40424a6fd34bSwdenk This can be used to load and uncompress arbitrary 40434a6fd34bSwdenk data. 40444a6fd34bSwdenk 4045a28afca5SDavid A. Long fdt_high - if set this restricts the maximum address that the 4046a28afca5SDavid A. Long flattened device tree will be copied into upon boot. 4047fa34f6b2SShawn Guo For example, if you have a system with 1 GB memory 4048fa34f6b2SShawn Guo at physical address 0x10000000, while Linux kernel 4049fa34f6b2SShawn Guo only recognizes the first 704 MB as low memory, you 4050fa34f6b2SShawn Guo may need to set fdt_high as 0x3C000000 to have the 4051fa34f6b2SShawn Guo device tree blob be copied to the maximum address 4052fa34f6b2SShawn Guo of the 704 MB low memory, so that Linux kernel can 4053fa34f6b2SShawn Guo access it during the boot procedure. 4054fa34f6b2SShawn Guo 4055a28afca5SDavid A. Long If this is set to the special value 0xFFFFFFFF then 4056a28afca5SDavid A. Long the fdt will not be copied at all on boot. For this 4057a28afca5SDavid A. Long to work it must reside in writable memory, have 4058a28afca5SDavid A. Long sufficient padding on the end of it for u-boot to 4059a28afca5SDavid A. Long add the information it needs into it, and the memory 4060a28afca5SDavid A. Long must be accessible by the kernel. 4061a28afca5SDavid A. Long 4062eea63e05SSimon Glass fdtcontroladdr- if set this is the address of the control flattened 4063eea63e05SSimon Glass device tree used by U-Boot when CONFIG_OF_CONTROL is 4064eea63e05SSimon Glass defined. 4065eea63e05SSimon Glass 406617ea1177Swdenk i2cfast - (PPC405GP|PPC405EP only) 406717ea1177Swdenk if set to 'y' configures Linux I2C driver for fast 406817ea1177Swdenk mode (400kHZ). This environment variable is used in 406917ea1177Swdenk initialization code. So, for changes to be effective 407017ea1177Swdenk it must be saved and board must be reset. 407117ea1177Swdenk 4072c609719bSwdenk initrd_high - restrict positioning of initrd images: 4073c609719bSwdenk If this variable is not set, initrd images will be 4074c609719bSwdenk copied to the highest possible address in RAM; this 4075c609719bSwdenk is usually what you want since it allows for 4076c609719bSwdenk maximum initrd size. If for some reason you want to 4077c609719bSwdenk make sure that the initrd image is loaded below the 40786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BOOTMAPSZ limit, you can set this environment 4079c609719bSwdenk variable to a value of "no" or "off" or "0". 4080c609719bSwdenk Alternatively, you can set it to a maximum upper 4081c609719bSwdenk address to use (U-Boot will still check that it 4082c609719bSwdenk does not overwrite the U-Boot stack and data). 4083c609719bSwdenk 4084c609719bSwdenk For instance, when you have a system with 16 MB 40857152b1d0Swdenk RAM, and want to reserve 4 MB from use by Linux, 4086c609719bSwdenk you can do this by adding "mem=12M" to the value of 4087c609719bSwdenk the "bootargs" variable. However, now you must make 40887152b1d0Swdenk sure that the initrd image is placed in the first 4089c609719bSwdenk 12 MB as well - this can be done with 4090c609719bSwdenk 4091c609719bSwdenk setenv initrd_high 00c00000 4092c609719bSwdenk 409338b99261Swdenk If you set initrd_high to 0xFFFFFFFF, this is an 409438b99261Swdenk indication to U-Boot that all addresses are legal 409538b99261Swdenk for the Linux kernel, including addresses in flash 409638b99261Swdenk memory. In this case U-Boot will NOT COPY the 409738b99261Swdenk ramdisk at all. This may be useful to reduce the 409838b99261Swdenk boot time on your system, but requires that this 409938b99261Swdenk feature is supported by your Linux kernel. 410038b99261Swdenk 4101c609719bSwdenk ipaddr - IP address; needed for tftpboot command 4102c609719bSwdenk 4103c609719bSwdenk loadaddr - Default load address for commands like "bootp", 4104dc7c9a1aSwdenk "rarpboot", "tftpboot", "loadb" or "diskboot" 4105c609719bSwdenk 4106c609719bSwdenk loads_echo - see CONFIG_LOADS_ECHO 4107c609719bSwdenk 4108c609719bSwdenk serverip - TFTP server IP address; needed for tftpboot command 4109c609719bSwdenk 4110c609719bSwdenk bootretry - see CONFIG_BOOT_RETRY_TIME 4111c609719bSwdenk 4112c609719bSwdenk bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR 4113c609719bSwdenk 4114c609719bSwdenk bootstopkey - see CONFIG_AUTOBOOT_STOP_STR 4115c609719bSwdenk 4116e2a53458SMike Frysinger ethprime - controls which interface is used first. 4117a3d991bdSwdenk 4118e2a53458SMike Frysinger ethact - controls which interface is currently active. 4119e2a53458SMike Frysinger For example you can do the following 4120a3d991bdSwdenk 412148690d80SHeiko Schocher => setenv ethact FEC 412248690d80SHeiko Schocher => ping 192.168.0.1 # traffic sent on FEC 412348690d80SHeiko Schocher => setenv ethact SCC 412448690d80SHeiko Schocher => ping 10.0.0.1 # traffic sent on SCC 4125a3d991bdSwdenk 4126e1692577SMatthias Fuchs ethrotate - When set to "no" U-Boot does not go through all 4127e1692577SMatthias Fuchs available network interfaces. 4128e1692577SMatthias Fuchs It just stays at the currently selected interface. 4129e1692577SMatthias Fuchs 4130a3d991bdSwdenk netretry - When set to "no" each network operation will 4131a3d991bdSwdenk either succeed or fail without retrying. 41326e592385Swdenk When set to "once" the network operation will 41336e592385Swdenk fail when all the available network interfaces 41346e592385Swdenk are tried once without success. 4135a3d991bdSwdenk Useful on scripts which control the retry operation 4136a3d991bdSwdenk themselves. 4137a3d991bdSwdenk 4138b4e2f89dSJean-Christophe PLAGNIOL-VILLARD npe_ucode - set load address for the NPE microcode 4139a1cf027aSJean-Christophe PLAGNIOL-VILLARD 414028cb9375SWolfgang Denk tftpsrcport - If this is set, the value is used for TFTP's 4141ecb0ccd9SWolfgang Denk UDP source port. 4142ecb0ccd9SWolfgang Denk 414328cb9375SWolfgang Denk tftpdstport - If this is set, the value is used for TFTP's UDP 414428cb9375SWolfgang Denk destination port instead of the Well Know Port 69. 414528cb9375SWolfgang Denk 4146c96f86eeSWolfgang Denk tftpblocksize - Block size to use for TFTP transfers; if not set, 4147c96f86eeSWolfgang Denk we use the TFTP server's default block size 4148c96f86eeSWolfgang Denk 4149c96f86eeSWolfgang Denk tftptimeout - Retransmission timeout for TFTP packets (in milli- 4150c96f86eeSWolfgang Denk seconds, minimum value is 1000 = 1 second). Defines 4151c96f86eeSWolfgang Denk when a packet is considered to be lost so it has to 4152c96f86eeSWolfgang Denk be retransmitted. The default is 5000 = 5 seconds. 4153c96f86eeSWolfgang Denk Lowering this value may make downloads succeed 4154c96f86eeSWolfgang Denk faster in networks with high packet loss rates or 4155c96f86eeSWolfgang Denk with unreliable TFTP servers. 4156c96f86eeSWolfgang Denk 4157a3d991bdSwdenk vlan - When set to a value < 4095 the traffic over 415811ccc33fSMarcel Ziswiler Ethernet is encapsulated/received over 802.1q 4159a3d991bdSwdenk VLAN tagged frames. 4160c609719bSwdenk 4161dc0b7b0eSJason HobbsThe following image location variables contain the location of images 4162dc0b7b0eSJason Hobbsused in booting. The "Image" column gives the role of the image and is 4163dc0b7b0eSJason Hobbsnot an environment variable name. The other columns are environment 4164dc0b7b0eSJason Hobbsvariable names. "File Name" gives the name of the file on a TFTP 4165dc0b7b0eSJason Hobbsserver, "RAM Address" gives the location in RAM the image will be 4166dc0b7b0eSJason Hobbsloaded to, and "Flash Location" gives the image's address in NOR 4167dc0b7b0eSJason Hobbsflash or offset in NAND flash. 4168dc0b7b0eSJason Hobbs 4169dc0b7b0eSJason Hobbs*Note* - these variables don't have to be defined for all boards, some 4170dc0b7b0eSJason Hobbsboards currenlty use other variables for these purposes, and some 4171dc0b7b0eSJason Hobbsboards use these variables for other purposes. 4172dc0b7b0eSJason Hobbs 4173dc0b7b0eSJason HobbsImage File Name RAM Address Flash Location 4174dc0b7b0eSJason Hobbs----- --------- ----------- -------------- 4175dc0b7b0eSJason Hobbsu-boot u-boot u-boot_addr_r u-boot_addr 4176dc0b7b0eSJason HobbsLinux kernel bootfile kernel_addr_r kernel_addr 4177dc0b7b0eSJason Hobbsdevice tree blob fdtfile fdt_addr_r fdt_addr 4178dc0b7b0eSJason Hobbsramdisk ramdiskfile ramdisk_addr_r ramdisk_addr 4179dc0b7b0eSJason Hobbs 4180c609719bSwdenkThe following environment variables may be used and automatically 4181c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"), 4182c609719bSwdenkdepending the information provided by your boot server: 4183c609719bSwdenk 4184c609719bSwdenk bootfile - see above 4185c609719bSwdenk dnsip - IP address of your Domain Name Server 4186fe389a82Sstroese dnsip2 - IP address of your secondary Domain Name Server 4187c609719bSwdenk gatewayip - IP address of the Gateway (Router) to use 4188c609719bSwdenk hostname - Target hostname 4189c609719bSwdenk ipaddr - see above 4190c609719bSwdenk netmask - Subnet Mask 4191c609719bSwdenk rootpath - Pathname of the root filesystem on the NFS server 4192c609719bSwdenk serverip - see above 4193c609719bSwdenk 4194c609719bSwdenk 4195c609719bSwdenkThere are two special Environment Variables: 4196c609719bSwdenk 4197c609719bSwdenk serial# - contains hardware identification information such 4198c609719bSwdenk as type string and/or serial number 4199c609719bSwdenk ethaddr - Ethernet address 4200c609719bSwdenk 4201c609719bSwdenkThese variables can be set only once (usually during manufacturing of 4202c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables 4203c609719bSwdenkonce they have been set once. 4204c609719bSwdenk 4205c609719bSwdenk 4206c1551ea8SstroeseFurther special Environment Variables: 4207c1551ea8Sstroese 4208c1551ea8Sstroese ver - Contains the U-Boot version string as printed 4209c1551ea8Sstroese with the "version" command. This variable is 4210c1551ea8Sstroese readonly (see CONFIG_VERSION_VARIABLE). 4211c1551ea8Sstroese 4212c1551ea8Sstroese 4213c609719bSwdenkPlease note that changes to some configuration parameters may take 4214c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-). 4215c609719bSwdenk 4216c609719bSwdenk 4217170ab110SJoe HershbergerCallback functions for environment variables: 4218170ab110SJoe Hershberger--------------------------------------------- 4219170ab110SJoe Hershberger 4220170ab110SJoe HershbergerFor some environment variables, the behavior of u-boot needs to change 4221170ab110SJoe Hershbergerwhen their values are changed. This functionailty allows functions to 4222170ab110SJoe Hershbergerbe associated with arbitrary variables. On creation, overwrite, or 4223170ab110SJoe Hershbergerdeletion, the callback will provide the opportunity for some side 4224170ab110SJoe Hershbergereffect to happen or for the change to be rejected. 4225170ab110SJoe Hershberger 4226170ab110SJoe HershbergerThe callbacks are named and associated with a function using the 4227170ab110SJoe HershbergerU_BOOT_ENV_CALLBACK macro in your board or driver code. 4228170ab110SJoe Hershberger 4229170ab110SJoe HershbergerThese callbacks are associated with variables in one of two ways. The 4230170ab110SJoe Hershbergerstatic list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC 4231170ab110SJoe Hershbergerin the board configuration to a string that defines a list of 4232170ab110SJoe Hershbergerassociations. The list must be in the following format: 4233170ab110SJoe Hershberger 4234170ab110SJoe Hershberger entry = variable_name[:callback_name] 4235170ab110SJoe Hershberger list = entry[,list] 4236170ab110SJoe Hershberger 4237170ab110SJoe HershbergerIf the callback name is not specified, then the callback is deleted. 4238170ab110SJoe HershbergerSpaces are also allowed anywhere in the list. 4239170ab110SJoe Hershberger 4240170ab110SJoe HershbergerCallbacks can also be associated by defining the ".callbacks" variable 4241170ab110SJoe Hershbergerwith the same list format above. Any association in ".callbacks" will 4242170ab110SJoe Hershbergeroverride any association in the static list. You can define 4243170ab110SJoe HershbergerCONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the 4244170ab110SJoe Hershberger".callbacks" envirnoment variable in the default or embedded environment. 4245170ab110SJoe Hershberger 4246170ab110SJoe Hershberger 4247f07771ccSwdenkCommand Line Parsing: 4248f07771ccSwdenk===================== 4249f07771ccSwdenk 4250f07771ccSwdenkThere are two different command line parsers available with U-Boot: 42517152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell: 4252f07771ccSwdenk 4253f07771ccSwdenkOld, simple command line parser: 4254f07771ccSwdenk-------------------------------- 4255f07771ccSwdenk 4256f07771ccSwdenk- supports environment variables (through setenv / saveenv commands) 4257f07771ccSwdenk- several commands on one line, separated by ';' 4258fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax 4259f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\', 4260f07771ccSwdenk for example: 4261fe126d8bSWolfgang Denk setenv bootcmd bootm \${address} 4262f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example: 4263f07771ccSwdenk setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off' 4264f07771ccSwdenk 4265f07771ccSwdenkHush shell: 4266f07771ccSwdenk----------- 4267f07771ccSwdenk 4268f07771ccSwdenk- similar to Bourne shell, with control structures like 4269f07771ccSwdenk if...then...else...fi, for...do...done; while...do...done, 4270f07771ccSwdenk until...do...done, ... 4271f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv 4272f07771ccSwdenk commands) and local shell variables (through standard shell syntax 4273f07771ccSwdenk "name=value"); only environment variables can be used with "run" 4274f07771ccSwdenk command 4275f07771ccSwdenk 4276f07771ccSwdenkGeneral rules: 4277f07771ccSwdenk-------------- 4278f07771ccSwdenk 4279f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run" 4280f07771ccSwdenk command) contains several commands separated by semicolon, and 4281f07771ccSwdenk one of these commands fails, then the remaining commands will be 4282f07771ccSwdenk executed anyway. 4283f07771ccSwdenk 4284f07771ccSwdenk(2) If you execute several variables with one call to run (i. e. 428511ccc33fSMarcel Ziswiler calling run with a list of variables as arguments), any failing 4286f07771ccSwdenk command will cause "run" to terminate, i. e. the remaining 4287f07771ccSwdenk variables are not executed. 4288f07771ccSwdenk 4289c609719bSwdenkNote for Redundant Ethernet Interfaces: 4290c609719bSwdenk======================================= 4291c609719bSwdenk 429211ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports 4293c609719bSwdenksuch configurations and is capable of automatic selection of a 42947152b1d0Swdenk"working" interface when needed. MAC assignment works as follows: 4295c609719bSwdenk 4296c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding 4297c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0), 4298c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ... 4299c609719bSwdenk 4300c609719bSwdenkIf the network interface stores some valid MAC address (for instance 4301c609719bSwdenkin SROM), this is used as default address if there is NO correspon- 4302c609719bSwdenkding setting in the environment; if the corresponding environment 4303c609719bSwdenkvariable is set, this overrides the settings in the card; that means: 4304c609719bSwdenk 4305c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the 4306c609719bSwdenk environment, the SROM's address is used. 4307c609719bSwdenk 4308c609719bSwdenko If there is no valid address in the SROM, and a definition in the 4309c609719bSwdenk environment exists, then the value from the environment variable is 4310c609719bSwdenk used. 4311c609719bSwdenk 4312c609719bSwdenko If both the SROM and the environment contain a MAC address, and 4313c609719bSwdenk both addresses are the same, this MAC address is used. 4314c609719bSwdenk 4315c609719bSwdenko If both the SROM and the environment contain a MAC address, and the 4316c609719bSwdenk addresses differ, the value from the environment is used and a 4317c609719bSwdenk warning is printed. 4318c609719bSwdenk 4319c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error 4320c609719bSwdenk is raised. 4321c609719bSwdenk 4322ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses 4323ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process. This 4324ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable. 4325ecee9324SBen WarrenThe naming convention is as follows: 4326ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc. 4327c609719bSwdenk 4328c609719bSwdenkImage Formats: 4329c609719bSwdenk============== 4330c609719bSwdenk 43313310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on) 43323310c549SMarian Balakowiczimages in two formats: 43333310c549SMarian Balakowicz 43343310c549SMarian BalakowiczNew uImage format (FIT) 43353310c549SMarian Balakowicz----------------------- 43363310c549SMarian Balakowicz 43373310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar 43383310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple 43393310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by 43403310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory. 43413310c549SMarian Balakowicz 43423310c549SMarian Balakowicz 43433310c549SMarian BalakowiczOld uImage format 43443310c549SMarian Balakowicz----------------- 43453310c549SMarian Balakowicz 43463310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything, 43473310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for 43483310c549SMarian Balakowiczdetails; basically, the header defines the following image properties: 4349c609719bSwdenk 4350c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD, 4351c609719bSwdenk 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks, 4352f5ed9e39SPeter Tyser LynxOS, pSOS, QNX, RTEMS, INTEGRITY; 4353f5ed9e39SPeter Tyser Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS, 4354f5ed9e39SPeter Tyser INTEGRITY). 43557b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86, 4356afc1ce82SMacpaul Lin IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit; 4357afc1ce82SMacpaul Lin Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC). 4358c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2) 4359c609719bSwdenk* Load Address 4360c609719bSwdenk* Entry Point 4361c609719bSwdenk* Image Name 4362c609719bSwdenk* Image Timestamp 4363c609719bSwdenk 4364c609719bSwdenkThe header is marked by a special Magic Number, and both the header 4365c609719bSwdenkand the data portions of the image are secured against corruption by 4366c609719bSwdenkCRC32 checksums. 4367c609719bSwdenk 4368c609719bSwdenk 4369c609719bSwdenkLinux Support: 4370c609719bSwdenk============== 4371c609719bSwdenk 4372c609719bSwdenkAlthough U-Boot should support any OS or standalone application 43737152b1d0Swdenkeasily, the main focus has always been on Linux during the design of 4374c609719bSwdenkU-Boot. 4375c609719bSwdenk 4376c609719bSwdenkU-Boot includes many features that so far have been part of some 4377c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any 4378c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image; 4379c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation 43807152b1d0Swdenkserves several purposes: 4381c609719bSwdenk 4382c609719bSwdenk- the same features can be used for other OS or standalone 4383c609719bSwdenk applications (for instance: using compressed images to reduce the 4384c609719bSwdenk Flash memory footprint) 4385c609719bSwdenk 4386c609719bSwdenk- it becomes much easier to port new Linux kernel versions because 43877152b1d0Swdenk lots of low-level, hardware dependent stuff are done by U-Boot 4388c609719bSwdenk 4389c609719bSwdenk- the same Linux kernel image can now be used with different "initrd" 4390c609719bSwdenk images; of course this also means that different kernel images can 4391c609719bSwdenk be run with the same "initrd". This makes testing easier (you don't 4392c609719bSwdenk have to build a new "zImage.initrd" Linux image when you just 4393c609719bSwdenk change a file in your "initrd"). Also, a field-upgrade of the 4394c609719bSwdenk software is easier now. 4395c609719bSwdenk 4396c609719bSwdenk 4397c609719bSwdenkLinux HOWTO: 4398c609719bSwdenk============ 4399c609719bSwdenk 4400c609719bSwdenkPorting Linux to U-Boot based systems: 4401c609719bSwdenk--------------------------------------- 4402c609719bSwdenk 4403c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to 4404c609719bSwdenkconfigure the Linux device drivers for use with your target hardware 4405c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to 4406c609719bSwdenkLinux :-). 4407c609719bSwdenk 4408a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot). 4409c609719bSwdenk 4410c609719bSwdenkJust make sure your machine specific header file (for instance 4411c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board 44121dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h, 44131dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value 44146d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR. 4415c609719bSwdenk 4416c609719bSwdenk 4417c609719bSwdenkConfiguring the Linux kernel: 4418c609719bSwdenk----------------------------- 4419c609719bSwdenk 4420c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root 4421c609719bSwdenkdevice (initial ramdisk, NFS) for your target system. 4422c609719bSwdenk 4423c609719bSwdenk 4424c609719bSwdenkBuilding a Linux Image: 4425c609719bSwdenk----------------------- 4426c609719bSwdenk 442724ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are 442824ee89b9Swdenknot used. If you use recent kernel source, a new build target 442924ee89b9Swdenk"uImage" will exist which automatically builds an image usable by 443024ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target, 443124ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a 443224ee89b9Swdenk100% compatible format. 4433c609719bSwdenk 4434c609719bSwdenkExample: 4435c609719bSwdenk 4436c609719bSwdenk make TQM850L_config 4437c609719bSwdenk make oldconfig 4438c609719bSwdenk make dep 443924ee89b9Swdenk make uImage 4440c609719bSwdenk 444124ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to 444224ee89b9Swdenkencapsulate a compressed Linux kernel image with header information, 444324ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing: 4444c609719bSwdenk 444524ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format): 444624ee89b9Swdenk 444724ee89b9Swdenk* convert the kernel into a raw binary image: 444824ee89b9Swdenk 444924ee89b9Swdenk ${CROSS_COMPILE}-objcopy -O binary \ 445024ee89b9Swdenk -R .note -R .comment \ 445124ee89b9Swdenk -S vmlinux linux.bin 445224ee89b9Swdenk 445324ee89b9Swdenk* compress the binary image: 445424ee89b9Swdenk 445524ee89b9Swdenk gzip -9 linux.bin 445624ee89b9Swdenk 445724ee89b9Swdenk* package compressed binary image for U-Boot: 445824ee89b9Swdenk 445924ee89b9Swdenk mkimage -A ppc -O linux -T kernel -C gzip \ 446024ee89b9Swdenk -a 0 -e 0 -n "Linux Kernel Image" \ 446124ee89b9Swdenk -d linux.bin.gz uImage 446224ee89b9Swdenk 446324ee89b9Swdenk 446424ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use 446524ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or 446624ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64 446724ee89b9Swdenkbyte header containing information about target architecture, 446824ee89b9Swdenkoperating system, image type, compression method, entry points, time 446924ee89b9Swdenkstamp, CRC32 checksums, etc. 447024ee89b9Swdenk 447124ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and 447224ee89b9Swdenkprint the header information, or to build new images. 4473c609719bSwdenk 4474c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information 4475c609719bSwdenkcontained in the header of an existing U-Boot image; this includes 4476c609719bSwdenkchecksum verification: 4477c609719bSwdenk 4478c609719bSwdenk tools/mkimage -l image 4479c609719bSwdenk -l ==> list image header information 4480c609719bSwdenk 4481c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image 4482c609719bSwdenkfrom a "data file" which is used as image payload: 4483c609719bSwdenk 4484c609719bSwdenk tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \ 4485c609719bSwdenk -n name -d data_file image 4486c609719bSwdenk -A ==> set architecture to 'arch' 4487c609719bSwdenk -O ==> set operating system to 'os' 4488c609719bSwdenk -T ==> set image type to 'type' 4489c609719bSwdenk -C ==> set compression type 'comp' 4490c609719bSwdenk -a ==> set load address to 'addr' (hex) 4491c609719bSwdenk -e ==> set entry point to 'ep' (hex) 4492c609719bSwdenk -n ==> set image name to 'name' 4493c609719bSwdenk -d ==> use image data from 'datafile' 4494c609719bSwdenk 449569459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load 449669459791Swdenkaddress (0x00000000), but the entry point address depends on the 449769459791Swdenkkernel version: 4498c609719bSwdenk 4499c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C, 450024ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000. 4501c609719bSwdenk 4502c609719bSwdenkSo a typical call to build a U-Boot image would read: 4503c609719bSwdenk 450424ee89b9Swdenk -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 450524ee89b9Swdenk > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \ 4506a47a12beSStefan Roese > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \ 450724ee89b9Swdenk > examples/uImage.TQM850L 450824ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 4509c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 4510c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 4511c609719bSwdenk Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 4512c609719bSwdenk Load Address: 0x00000000 451324ee89b9Swdenk Entry Point: 0x00000000 4514c609719bSwdenk 4515c609719bSwdenkTo verify the contents of the image (or check for corruption): 4516c609719bSwdenk 451724ee89b9Swdenk -> tools/mkimage -l examples/uImage.TQM850L 451824ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 4519c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 4520c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 4521c609719bSwdenk Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 4522c609719bSwdenk Load Address: 0x00000000 452324ee89b9Swdenk Entry Point: 0x00000000 4524c609719bSwdenk 4525c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade 4526c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this 4527c609719bSwdenkneeds more space in Flash, but boots much faster since it does not 4528c609719bSwdenkneed to be uncompressed: 4529c609719bSwdenk 4530a47a12beSStefan Roese -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz 453124ee89b9Swdenk -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 453224ee89b9Swdenk > -A ppc -O linux -T kernel -C none -a 0 -e 0 \ 4533a47a12beSStefan Roese > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \ 453424ee89b9Swdenk > examples/uImage.TQM850L-uncompressed 453524ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 4536c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 4537c609719bSwdenk Image Type: PowerPC Linux Kernel Image (uncompressed) 4538c609719bSwdenk Data Size: 792160 Bytes = 773.59 kB = 0.76 MB 4539c609719bSwdenk Load Address: 0x00000000 454024ee89b9Swdenk Entry Point: 0x00000000 4541c609719bSwdenk 4542c609719bSwdenk 4543c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file 4544c609719bSwdenkwhen your kernel is intended to use an initial ramdisk: 4545c609719bSwdenk 4546c609719bSwdenk -> tools/mkimage -n 'Simple Ramdisk Image' \ 4547c609719bSwdenk > -A ppc -O linux -T ramdisk -C gzip \ 4548c609719bSwdenk > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd 4549c609719bSwdenk Image Name: Simple Ramdisk Image 4550c609719bSwdenk Created: Wed Jan 12 14:01:50 2000 4551c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 4552c609719bSwdenk Data Size: 566530 Bytes = 553.25 kB = 0.54 MB 4553c609719bSwdenk Load Address: 0x00000000 4554c609719bSwdenk Entry Point: 0x00000000 4555c609719bSwdenk 4556c609719bSwdenk 4557c609719bSwdenkInstalling a Linux Image: 4558c609719bSwdenk------------------------- 4559c609719bSwdenk 4560c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface, 4561c609719bSwdenkyou must convert the image to S-Record format: 4562c609719bSwdenk 4563c609719bSwdenk objcopy -I binary -O srec examples/image examples/image.srec 4564c609719bSwdenk 4565c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot 4566c609719bSwdenkimage header, so the resulting S-Record file will be relative to 4567c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to 4568c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads' 4569c609719bSwdenkcommand. 4570c609719bSwdenk 4571c609719bSwdenkExample: install the image to address 0x40100000 (which on the 4572c609719bSwdenkTQM8xxL is in the first Flash bank): 4573c609719bSwdenk 4574c609719bSwdenk => erase 40100000 401FFFFF 4575c609719bSwdenk 4576c609719bSwdenk .......... done 4577c609719bSwdenk Erased 8 sectors 4578c609719bSwdenk 4579c609719bSwdenk => loads 40100000 4580c609719bSwdenk ## Ready for S-Record download ... 4581c609719bSwdenk ~>examples/image.srec 4582c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 12 13 ... 4583c609719bSwdenk ... 4584c609719bSwdenk 15989 15990 15991 15992 4585c609719bSwdenk [file transfer complete] 4586c609719bSwdenk [connected] 4587c609719bSwdenk ## Start Addr = 0x00000000 4588c609719bSwdenk 4589c609719bSwdenk 4590c609719bSwdenkYou can check the success of the download using the 'iminfo' command; 4591c609719bSwdenkthis includes a checksum verification so you can be sure no data 4592c609719bSwdenkcorruption happened: 4593c609719bSwdenk 4594c609719bSwdenk => imi 40100000 4595c609719bSwdenk 4596c609719bSwdenk ## Checking Image at 40100000 ... 4597c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 4598c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 4599c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 4600c609719bSwdenk Load Address: 00000000 4601c609719bSwdenk Entry Point: 0000000c 4602c609719bSwdenk Verifying Checksum ... OK 4603c609719bSwdenk 4604c609719bSwdenk 4605c609719bSwdenkBoot Linux: 4606c609719bSwdenk----------- 4607c609719bSwdenk 4608c609719bSwdenkThe "bootm" command is used to boot an application that is stored in 4609c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents 4610c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as 4611c609719bSwdenkparameters. You can check and modify this variable using the 4612c609719bSwdenk"printenv" and "setenv" commands: 4613c609719bSwdenk 4614c609719bSwdenk 4615c609719bSwdenk => printenv bootargs 4616c609719bSwdenk bootargs=root=/dev/ram 4617c609719bSwdenk 4618c609719bSwdenk => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 4619c609719bSwdenk 4620c609719bSwdenk => printenv bootargs 4621c609719bSwdenk bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 4622c609719bSwdenk 4623c609719bSwdenk => bootm 40020000 4624c609719bSwdenk ## Booting Linux kernel at 40020000 ... 4625c609719bSwdenk Image Name: 2.2.13 for NFS on TQM850L 4626c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 4627c609719bSwdenk Data Size: 381681 Bytes = 372 kB = 0 MB 4628c609719bSwdenk Load Address: 00000000 4629c609719bSwdenk Entry Point: 0000000c 4630c609719bSwdenk Verifying Checksum ... OK 4631c609719bSwdenk Uncompressing Kernel Image ... OK 4632c609719bSwdenk 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 4633c609719bSwdenk Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 4634c609719bSwdenk time_init: decrementer frequency = 187500000/60 4635c609719bSwdenk Calibrating delay loop... 49.77 BogoMIPS 4636c609719bSwdenk Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000] 4637c609719bSwdenk ... 4638c609719bSwdenk 463911ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass 46407152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT 4641c609719bSwdenkformat!) to the "bootm" command: 4642c609719bSwdenk 4643c609719bSwdenk => imi 40100000 40200000 4644c609719bSwdenk 4645c609719bSwdenk ## Checking Image at 40100000 ... 4646c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 4647c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 4648c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 4649c609719bSwdenk Load Address: 00000000 4650c609719bSwdenk Entry Point: 0000000c 4651c609719bSwdenk Verifying Checksum ... OK 4652c609719bSwdenk 4653c609719bSwdenk ## Checking Image at 40200000 ... 4654c609719bSwdenk Image Name: Simple Ramdisk Image 4655c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 4656c609719bSwdenk Data Size: 566530 Bytes = 553 kB = 0 MB 4657c609719bSwdenk Load Address: 00000000 4658c609719bSwdenk Entry Point: 00000000 4659c609719bSwdenk Verifying Checksum ... OK 4660c609719bSwdenk 4661c609719bSwdenk => bootm 40100000 40200000 4662c609719bSwdenk ## Booting Linux kernel at 40100000 ... 4663c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 4664c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 4665c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 4666c609719bSwdenk Load Address: 00000000 4667c609719bSwdenk Entry Point: 0000000c 4668c609719bSwdenk Verifying Checksum ... OK 4669c609719bSwdenk Uncompressing Kernel Image ... OK 4670c609719bSwdenk ## Loading RAMDisk Image at 40200000 ... 4671c609719bSwdenk Image Name: Simple Ramdisk Image 4672c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 4673c609719bSwdenk Data Size: 566530 Bytes = 553 kB = 0 MB 4674c609719bSwdenk Load Address: 00000000 4675c609719bSwdenk Entry Point: 00000000 4676c609719bSwdenk Verifying Checksum ... OK 4677c609719bSwdenk Loading Ramdisk ... OK 4678c609719bSwdenk 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 4679c609719bSwdenk Boot arguments: root=/dev/ram 4680c609719bSwdenk time_init: decrementer frequency = 187500000/60 4681c609719bSwdenk Calibrating delay loop... 49.77 BogoMIPS 4682c609719bSwdenk ... 4683c609719bSwdenk RAMDISK: Compressed image found at block 0 4684c609719bSwdenk VFS: Mounted root (ext2 filesystem). 4685c609719bSwdenk 4686c609719bSwdenk bash# 4687c609719bSwdenk 46880267768eSMatthew McClintockBoot Linux and pass a flat device tree: 46890267768eSMatthew McClintock----------- 46900267768eSMatthew McClintock 46910267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section 46920267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The 46930267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated 46940267768eSMatthew McClintockflat device tree: 46950267768eSMatthew McClintock 46960267768eSMatthew McClintock=> print oftaddr 46970267768eSMatthew McClintockoftaddr=0x300000 46980267768eSMatthew McClintock=> print oft 46990267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb 47000267768eSMatthew McClintock=> tftp $oftaddr $oft 47010267768eSMatthew McClintockSpeed: 1000, full duplex 47020267768eSMatthew McClintockUsing TSEC0 device 47030267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101 47040267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'. 47050267768eSMatthew McClintockLoad address: 0x300000 47060267768eSMatthew McClintockLoading: # 47070267768eSMatthew McClintockdone 47080267768eSMatthew McClintockBytes transferred = 4106 (100a hex) 47090267768eSMatthew McClintock=> tftp $loadaddr $bootfile 47100267768eSMatthew McClintockSpeed: 1000, full duplex 47110267768eSMatthew McClintockUsing TSEC0 device 47120267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2 47130267768eSMatthew McClintockFilename 'uImage'. 47140267768eSMatthew McClintockLoad address: 0x200000 47150267768eSMatthew McClintockLoading:############ 47160267768eSMatthew McClintockdone 47170267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex) 47180267768eSMatthew McClintock=> print loadaddr 47190267768eSMatthew McClintockloadaddr=200000 47200267768eSMatthew McClintock=> print oftaddr 47210267768eSMatthew McClintockoftaddr=0x300000 47220267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr 47230267768eSMatthew McClintock## Booting image at 00200000 ... 47240267768eSMatthew McClintock Image Name: Linux-2.6.17-dirty 47250267768eSMatthew McClintock Image Type: PowerPC Linux Kernel Image (gzip compressed) 47260267768eSMatthew McClintock Data Size: 1029343 Bytes = 1005.2 kB 47270267768eSMatthew McClintock Load Address: 00000000 47280267768eSMatthew McClintock Entry Point: 00000000 47290267768eSMatthew McClintock Verifying Checksum ... OK 47300267768eSMatthew McClintock Uncompressing Kernel Image ... OK 47310267768eSMatthew McClintockBooting using flat device tree at 0x300000 47320267768eSMatthew McClintockUsing MPC85xx ADS machine description 47330267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb 47340267768eSMatthew McClintock[snip] 47350267768eSMatthew McClintock 47360267768eSMatthew McClintock 47376069ff26SwdenkMore About U-Boot Image Types: 47386069ff26Swdenk------------------------------ 47396069ff26Swdenk 47406069ff26SwdenkU-Boot supports the following image types: 47416069ff26Swdenk 47426069ff26Swdenk "Standalone Programs" are directly runnable in the environment 47436069ff26Swdenk provided by U-Boot; it is expected that (if they behave 47446069ff26Swdenk well) you can continue to work in U-Boot after return from 47456069ff26Swdenk the Standalone Program. 47466069ff26Swdenk "OS Kernel Images" are usually images of some Embedded OS which 47476069ff26Swdenk will take over control completely. Usually these programs 47486069ff26Swdenk will install their own set of exception handlers, device 47496069ff26Swdenk drivers, set up the MMU, etc. - this means, that you cannot 47506069ff26Swdenk expect to re-enter U-Boot except by resetting the CPU. 47516069ff26Swdenk "RAMDisk Images" are more or less just data blocks, and their 47526069ff26Swdenk parameters (address, size) are passed to an OS kernel that is 47536069ff26Swdenk being started. 47546069ff26Swdenk "Multi-File Images" contain several images, typically an OS 47556069ff26Swdenk (Linux) kernel image and one or more data images like 47566069ff26Swdenk RAMDisks. This construct is useful for instance when you want 47576069ff26Swdenk to boot over the network using BOOTP etc., where the boot 47586069ff26Swdenk server provides just a single image file, but you want to get 47596069ff26Swdenk for instance an OS kernel and a RAMDisk image. 47606069ff26Swdenk 47616069ff26Swdenk "Multi-File Images" start with a list of image sizes, each 47626069ff26Swdenk image size (in bytes) specified by an "uint32_t" in network 47636069ff26Swdenk byte order. This list is terminated by an "(uint32_t)0". 47646069ff26Swdenk Immediately after the terminating 0 follow the images, one by 47656069ff26Swdenk one, all aligned on "uint32_t" boundaries (size rounded up to 47666069ff26Swdenk a multiple of 4 bytes). 47676069ff26Swdenk 47686069ff26Swdenk "Firmware Images" are binary images containing firmware (like 47696069ff26Swdenk U-Boot or FPGA images) which usually will be programmed to 47706069ff26Swdenk flash memory. 47716069ff26Swdenk 47726069ff26Swdenk "Script files" are command sequences that will be executed by 47736069ff26Swdenk U-Boot's command interpreter; this feature is especially 47746069ff26Swdenk useful when you configure U-Boot to use a real shell (hush) 47756069ff26Swdenk as command interpreter. 47766069ff26Swdenk 477744f074c7SMarek VasutBooting the Linux zImage: 477844f074c7SMarek Vasut------------------------- 477944f074c7SMarek Vasut 478044f074c7SMarek VasutOn some platforms, it's possible to boot Linux zImage. This is done 478144f074c7SMarek Vasutusing the "bootz" command. The syntax of "bootz" command is the same 478244f074c7SMarek Vasutas the syntax of "bootm" command. 478344f074c7SMarek Vasut 4784017e1f3fSMarek VasutNote, defining the CONFIG_SUPPORT_INITRD_RAW allows user to supply 4785017e1f3fSMarek Vasutkernel with raw initrd images. The syntax is slightly different, the 4786017e1f3fSMarek Vasutaddress of the initrd must be augmented by it's size, in the following 4787017e1f3fSMarek Vasutformat: "<initrd addres>:<initrd size>". 4788017e1f3fSMarek Vasut 4789c609719bSwdenk 4790c609719bSwdenkStandalone HOWTO: 4791c609719bSwdenk================= 4792c609719bSwdenk 4793c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and 4794c609719bSwdenkrun "standalone" applications, which can use some resources of 4795c609719bSwdenkU-Boot like console I/O functions or interrupt services. 4796c609719bSwdenk 4797c609719bSwdenkTwo simple examples are included with the sources: 4798c609719bSwdenk 4799c609719bSwdenk"Hello World" Demo: 4800c609719bSwdenk------------------- 4801c609719bSwdenk 4802c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo 4803c609719bSwdenkapplication; it is automatically compiled when you build U-Boot. 4804c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it 4805c609719bSwdenklike that: 4806c609719bSwdenk 4807c609719bSwdenk => loads 4808c609719bSwdenk ## Ready for S-Record download ... 4809c609719bSwdenk ~>examples/hello_world.srec 4810c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 ... 4811c609719bSwdenk [file transfer complete] 4812c609719bSwdenk [connected] 4813c609719bSwdenk ## Start Addr = 0x00040004 4814c609719bSwdenk 4815c609719bSwdenk => go 40004 Hello World! This is a test. 4816c609719bSwdenk ## Starting application at 0x00040004 ... 4817c609719bSwdenk Hello World 4818c609719bSwdenk argc = 7 4819c609719bSwdenk argv[0] = "40004" 4820c609719bSwdenk argv[1] = "Hello" 4821c609719bSwdenk argv[2] = "World!" 4822c609719bSwdenk argv[3] = "This" 4823c609719bSwdenk argv[4] = "is" 4824c609719bSwdenk argv[5] = "a" 4825c609719bSwdenk argv[6] = "test." 4826c609719bSwdenk argv[7] = "<NULL>" 4827c609719bSwdenk Hit any key to exit ... 4828c609719bSwdenk 4829c609719bSwdenk ## Application terminated, rc = 0x0 4830c609719bSwdenk 4831c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt 4832c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'. 4833c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second. 4834c609719bSwdenkThe interrupt service routine is trivial, just printing a '.' 4835c609719bSwdenkcharacter, but this is just a demo program. The application can be 4836c609719bSwdenkcontrolled by the following keys: 4837c609719bSwdenk 4838c609719bSwdenk ? - print current values og the CPM Timer registers 4839c609719bSwdenk b - enable interrupts and start timer 4840c609719bSwdenk e - stop timer and disable interrupts 4841c609719bSwdenk q - quit application 4842c609719bSwdenk 4843c609719bSwdenk => loads 4844c609719bSwdenk ## Ready for S-Record download ... 4845c609719bSwdenk ~>examples/timer.srec 4846c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 ... 4847c609719bSwdenk [file transfer complete] 4848c609719bSwdenk [connected] 4849c609719bSwdenk ## Start Addr = 0x00040004 4850c609719bSwdenk 4851c609719bSwdenk => go 40004 4852c609719bSwdenk ## Starting application at 0x00040004 ... 4853c609719bSwdenk TIMERS=0xfff00980 4854c609719bSwdenk Using timer 1 4855c609719bSwdenk tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0 4856c609719bSwdenk 4857c609719bSwdenkHit 'b': 4858c609719bSwdenk [q, b, e, ?] Set interval 1000000 us 4859c609719bSwdenk Enabling timer 4860c609719bSwdenkHit '?': 4861c609719bSwdenk [q, b, e, ?] ........ 4862c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0 4863c609719bSwdenkHit '?': 4864c609719bSwdenk [q, b, e, ?] . 4865c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0 4866c609719bSwdenkHit '?': 4867c609719bSwdenk [q, b, e, ?] . 4868c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0 4869c609719bSwdenkHit '?': 4870c609719bSwdenk [q, b, e, ?] . 4871c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0 4872c609719bSwdenkHit 'e': 4873c609719bSwdenk [q, b, e, ?] ...Stopping timer 4874c609719bSwdenkHit 'q': 4875c609719bSwdenk [q, b, e, ?] ## Application terminated, rc = 0x0 4876c609719bSwdenk 4877c609719bSwdenk 487885ec0bccSwdenkMinicom warning: 487985ec0bccSwdenk================ 488085ec0bccSwdenk 48817152b1d0SwdenkOver time, many people have reported problems when trying to use the 488285ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd) 488385ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under 4884f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and 488585ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and 4886e53515a2SKarl O. Pincuse "cu" for S-Record download ("loads" command). See 4887e53515a2SKarl O. Pinchttp://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3. 4888e53515a2SKarl O. Pincfor help with kermit. 4889e53515a2SKarl O. Pinc 489085ec0bccSwdenk 489152f52c14SwdenkNevertheless, if you absolutely want to use it try adding this 489252f52c14Swdenkconfiguration to your "File transfer protocols" section: 489352f52c14Swdenk 489452f52c14Swdenk Name Program Name U/D FullScr IO-Red. Multi 489552f52c14Swdenk X kermit /usr/bin/kermit -i -l %l -s Y U Y N N 489652f52c14Swdenk Y kermit /usr/bin/kermit -i -l %l -r N D Y N N 489752f52c14Swdenk 489852f52c14Swdenk 4899c609719bSwdenkNetBSD Notes: 4900c609719bSwdenk============= 4901c609719bSwdenk 4902c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host 4903c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx). 4904c609719bSwdenk 4905c609719bSwdenkBuilding requires a cross environment; it is known to work on 4906c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also 4907c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make). 4908c609719bSwdenkNote that the cross-powerpc package does not install include files; 4909c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is 4910c609719bSwdenkmissing. This file has to be installed and patched manually: 4911c609719bSwdenk 4912c609719bSwdenk # cd /usr/pkg/cross/powerpc-netbsd/include 4913c609719bSwdenk # mkdir powerpc 4914c609719bSwdenk # ln -s powerpc machine 4915c609719bSwdenk # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h 4916c609719bSwdenk # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST 4917c609719bSwdenk 4918c609719bSwdenkNative builds *don't* work due to incompatibilities between native 4919c609719bSwdenkand U-Boot include files. 4920c609719bSwdenk 4921c609719bSwdenkBooting assumes that (the first part of) the image booted is a 4922c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel 4923c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source 4924c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the 49252a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz 4926c609719bSwdenk 4927c609719bSwdenk 4928c609719bSwdenkImplementation Internals: 4929c609719bSwdenk========================= 4930c609719bSwdenk 4931c609719bSwdenkThe following is not intended to be a complete description of every 4932c609719bSwdenkimplementation detail. However, it should help to understand the 4933c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom 4934c609719bSwdenkhardware. 4935c609719bSwdenk 4936c609719bSwdenk 4937c609719bSwdenkInitial Stack, Global Data: 4938c609719bSwdenk--------------------------- 4939c609719bSwdenk 4940c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot 4941c609719bSwdenkstarts running out of ROM (flash memory), usually without access to 4942c609719bSwdenksystem RAM (because the memory controller is not initialized yet). 4943c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS 4944c609719bSwdenkis not initialized as zero. To be able to get a C environment working 4945c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation 4946c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU 4947c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and 4948c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be 4949c609719bSwdenklocked as (mis-) used as memory, etc. 4950c609719bSwdenk 49517152b1d0Swdenk Chris Hallinan posted a good summary of these issues to the 49520668236bSWolfgang Denk U-Boot mailing list: 495343d9616cSwdenk 495443d9616cSwdenk Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)? 495543d9616cSwdenk From: "Chris Hallinan" <clh@net1plus.com> 495643d9616cSwdenk Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET) 495743d9616cSwdenk ... 495843d9616cSwdenk 495943d9616cSwdenk Correct me if I'm wrong, folks, but the way I understand it 496043d9616cSwdenk is this: Using DCACHE as initial RAM for Stack, etc, does not 496143d9616cSwdenk require any physical RAM backing up the cache. The cleverness 496243d9616cSwdenk is that the cache is being used as a temporary supply of 496343d9616cSwdenk necessary storage before the SDRAM controller is setup. It's 496411ccc33fSMarcel Ziswiler beyond the scope of this list to explain the details, but you 496543d9616cSwdenk can see how this works by studying the cache architecture and 496643d9616cSwdenk operation in the architecture and processor-specific manuals. 496743d9616cSwdenk 496843d9616cSwdenk OCM is On Chip Memory, which I believe the 405GP has 4K. It 496943d9616cSwdenk is another option for the system designer to use as an 497011ccc33fSMarcel Ziswiler initial stack/RAM area prior to SDRAM being available. Either 497143d9616cSwdenk option should work for you. Using CS 4 should be fine if your 497243d9616cSwdenk board designers haven't used it for something that would 497343d9616cSwdenk cause you grief during the initial boot! It is frequently not 497443d9616cSwdenk used. 497543d9616cSwdenk 49766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere 497743d9616cSwdenk with your processor/board/system design. The default value 497843d9616cSwdenk you will find in any recent u-boot distribution in 49798a316c9bSStefan Roese walnut.h should work for you. I'd set it to a value larger 498043d9616cSwdenk than your SDRAM module. If you have a 64MB SDRAM module, set 498143d9616cSwdenk it above 400_0000. Just make sure your board has no resources 498243d9616cSwdenk that are supposed to respond to that address! That code in 498343d9616cSwdenk start.S has been around a while and should work as is when 498443d9616cSwdenk you get the config right. 498543d9616cSwdenk 498643d9616cSwdenk -Chris Hallinan 498743d9616cSwdenk DS4.COM, Inc. 498843d9616cSwdenk 4989c609719bSwdenkIt is essential to remember this, since it has some impact on the C 4990c609719bSwdenkcode for the initialization procedures: 4991c609719bSwdenk 4992c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt 4993c609719bSwdenk to write it. 4994c609719bSwdenk 499511ccc33fSMarcel Ziswiler* Do not use any uninitialized global data (or implicitely initialized 4996c609719bSwdenk as zero data - BSS segment) at all - this is undefined, initiali- 49977152b1d0Swdenk zation is performed later (when relocating to RAM). 4998c609719bSwdenk 4999c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like 5000c609719bSwdenk that. 5001c609719bSwdenk 5002c609719bSwdenkHaving only the stack as writable memory limits means we cannot use 5003c609719bSwdenknormal global data to share information beween the code. But it 5004c609719bSwdenkturned out that the implementation of U-Boot can be greatly 5005c609719bSwdenksimplified by making a global data structure (gd_t) available to all 5006c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_ 5007c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of 5008c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we 5009c609719bSwdenkplace a pointer (gd) to the global data into a register which we 5010c609719bSwdenkreserve for this purpose. 5011c609719bSwdenk 50127152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the 5013c609719bSwdenkrelevant (E)ABI specifications for the current architecture, and by 5014c609719bSwdenkGCC's implementation. 5015c609719bSwdenk 5016c609719bSwdenkFor PowerPC, the following registers have specific use: 5017c609719bSwdenk R1: stack pointer 5018e7670f6cSWolfgang Denk R2: reserved for system use 5019c609719bSwdenk R3-R4: parameter passing and return values 5020c609719bSwdenk R5-R10: parameter passing 5021c609719bSwdenk R13: small data area pointer 5022c609719bSwdenk R30: GOT pointer 5023c609719bSwdenk R31: frame pointer 5024c609719bSwdenk 5025e6bee808SJoakim Tjernlund (U-Boot also uses R12 as internal GOT pointer. r12 5026e6bee808SJoakim Tjernlund is a volatile register so r12 needs to be reset when 5027e6bee808SJoakim Tjernlund going back and forth between asm and C) 5028c609719bSwdenk 5029e7670f6cSWolfgang Denk ==> U-Boot will use R2 to hold a pointer to the global data 5030c609719bSwdenk 5031c609719bSwdenk Note: on PPC, we could use a static initializer (since the 5032c609719bSwdenk address of the global data structure is known at compile time), 5033c609719bSwdenk but it turned out that reserving a register results in somewhat 5034c609719bSwdenk smaller code - although the code savings are not that big (on 5035c609719bSwdenk average for all boards 752 bytes for the whole U-Boot image, 5036c609719bSwdenk 624 text + 127 data). 5037c609719bSwdenk 5038c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here: 50394c58eb55SMike Frysinger http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface 50404c58eb55SMike Frysinger 5041c4db335cSRobin Getz ==> U-Boot will use P3 to hold a pointer to the global data 50424c58eb55SMike Frysinger 5043c609719bSwdenkOn ARM, the following registers are used: 5044c609719bSwdenk 5045c609719bSwdenk R0: function argument word/integer result 5046c609719bSwdenk R1-R3: function argument word 5047c609719bSwdenk R9: GOT pointer 5048c609719bSwdenk R10: stack limit (used only if stack checking if enabled) 5049c609719bSwdenk R11: argument (frame) pointer 5050c609719bSwdenk R12: temporary workspace 5051c609719bSwdenk R13: stack pointer 5052c609719bSwdenk R14: link register 5053c609719bSwdenk R15: program counter 5054c609719bSwdenk 5055c609719bSwdenk ==> U-Boot will use R8 to hold a pointer to the global data 5056c609719bSwdenk 50570df01fd3SThomas ChouOn Nios II, the ABI is documented here: 50580df01fd3SThomas Chou http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf 50590df01fd3SThomas Chou 50600df01fd3SThomas Chou ==> U-Boot will use gp to hold a pointer to the global data 50610df01fd3SThomas Chou 50620df01fd3SThomas Chou Note: on Nios II, we give "-G0" option to gcc and don't use gp 50630df01fd3SThomas Chou to access small data sections, so gp is free. 50640df01fd3SThomas Chou 5065afc1ce82SMacpaul LinOn NDS32, the following registers are used: 5066afc1ce82SMacpaul Lin 5067afc1ce82SMacpaul Lin R0-R1: argument/return 5068afc1ce82SMacpaul Lin R2-R5: argument 5069afc1ce82SMacpaul Lin R15: temporary register for assembler 5070afc1ce82SMacpaul Lin R16: trampoline register 5071afc1ce82SMacpaul Lin R28: frame pointer (FP) 5072afc1ce82SMacpaul Lin R29: global pointer (GP) 5073afc1ce82SMacpaul Lin R30: link register (LP) 5074afc1ce82SMacpaul Lin R31: stack pointer (SP) 5075afc1ce82SMacpaul Lin PC: program counter (PC) 5076afc1ce82SMacpaul Lin 5077afc1ce82SMacpaul Lin ==> U-Boot will use R10 to hold a pointer to the global data 5078afc1ce82SMacpaul Lin 5079d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope, 5080d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much. 5081c609719bSwdenk 5082c609719bSwdenkMemory Management: 5083c609719bSwdenk------------------ 5084c609719bSwdenk 5085c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the 5086c609719bSwdenkMMU is not used either for address mapping nor for memory protection. 5087c609719bSwdenk 5088c609719bSwdenkThe available memory is mapped to fixed addresses using the memory 5089c609719bSwdenkcontroller. In this process, a contiguous block is formed for each 5090c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several 5091c609719bSwdenkphysical memory banks. 5092c609719bSwdenk 5093c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on 5094c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After 5095c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself 5096c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some 50976d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN 5098c609719bSwdenkconfiguration setting]. Below that, a structure with global Board 5099c609719bSwdenkInfo data is placed, followed by the stack (growing downward). 5100c609719bSwdenk 5101c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB 5102c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF). 5103c609719bSwdenk 5104c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like 5105c609719bSwdenkthis: 5106c609719bSwdenk 5107c609719bSwdenk 0x0000 0000 Exception Vector code 5108c609719bSwdenk : 5109c609719bSwdenk 0x0000 1FFF 5110c609719bSwdenk 0x0000 2000 Free for Application Use 5111c609719bSwdenk : 5112c609719bSwdenk : 5113c609719bSwdenk 5114c609719bSwdenk : 5115c609719bSwdenk : 5116c609719bSwdenk 0x00FB FF20 Monitor Stack (Growing downward) 5117c609719bSwdenk 0x00FB FFAC Board Info Data and permanent copy of global data 5118c609719bSwdenk 0x00FC 0000 Malloc Arena 5119c609719bSwdenk : 5120c609719bSwdenk 0x00FD FFFF 5121c609719bSwdenk 0x00FE 0000 RAM Copy of Monitor Code 5122c609719bSwdenk ... eventually: LCD or video framebuffer 5123c609719bSwdenk ... eventually: pRAM (Protected RAM - unchanged by reset) 5124c609719bSwdenk 0x00FF FFFF [End of RAM] 5125c609719bSwdenk 5126c609719bSwdenk 5127c609719bSwdenkSystem Initialization: 5128c609719bSwdenk---------------------- 5129c609719bSwdenk 5130c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point 513111ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset 5132c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory. 51337152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address. 5134c609719bSwdenkTo be able to implement the initialization code in C, a (small!) 5135c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs 5136c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked 5137c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core, 5138c609719bSwdenkthe caches and the SIU. 5139c609719bSwdenk 5140c609719bSwdenkNext, all (potentially) available memory banks are mapped using a 5141c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries 5142c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash 5143c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is 5144c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a 5145c609719bSwdenksimple memory test is run that determines the size of the SDRAM 5146c609719bSwdenkbanks. 5147c609719bSwdenk 5148c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of 51497152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first 5150c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address 5151c609719bSwdenk0x00000000, with any additional banks following immediately to create 5152c609719bSwdenkcontiguous memory starting from 0. 5153c609719bSwdenk 5154c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area 5155c609719bSwdenkand allocates memory for use by malloc() and for the global Board 5156c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM 5157c609719bSwdenkpages, and the final stack is set up. 5158c609719bSwdenk 5159c609719bSwdenkOnly after this relocation will you have a "normal" C environment; 5160c609719bSwdenkuntil that you are restricted in several ways, mostly because you are 5161c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a 5162c609719bSwdenknew address in RAM. 5163c609719bSwdenk 5164c609719bSwdenk 5165c609719bSwdenkU-Boot Porting Guide: 5166c609719bSwdenk---------------------- 5167c609719bSwdenk 5168c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing 51696aff3115Swdenklist, October 2002] 5170c609719bSwdenk 5171c609719bSwdenk 5172c609719bSwdenkint main(int argc, char *argv[]) 5173c609719bSwdenk{ 5174c609719bSwdenk sighandler_t no_more_time; 5175c609719bSwdenk 5176c609719bSwdenk signal(SIGALRM, no_more_time); 5177c609719bSwdenk alarm(PROJECT_DEADLINE - toSec (3 * WEEK)); 5178c609719bSwdenk 5179c609719bSwdenk if (available_money > available_manpower) { 51806c3fef28SJerry Van Baren Pay consultant to port U-Boot; 5181c609719bSwdenk return 0; 5182c609719bSwdenk } 5183c609719bSwdenk 5184c609719bSwdenk Download latest U-Boot source; 5185c609719bSwdenk 51860668236bSWolfgang Denk Subscribe to u-boot mailing list; 51876aff3115Swdenk 51886c3fef28SJerry Van Baren if (clueless) 5189c609719bSwdenk email("Hi, I am new to U-Boot, how do I get started?"); 5190c609719bSwdenk 5191c609719bSwdenk while (learning) { 5192c609719bSwdenk Read the README file in the top level directory; 51937cb22f97Swdenk Read http://www.denx.de/twiki/bin/view/DULG/Manual; 51946c3fef28SJerry Van Baren Read applicable doc/*.README; 5195c609719bSwdenk Read the source, Luke; 51966c3fef28SJerry Van Baren /* find . -name "*.[chS]" | xargs grep -i <keyword> */ 5197c609719bSwdenk } 5198c609719bSwdenk 51996c3fef28SJerry Van Baren if (available_money > toLocalCurrency ($2500)) 52006c3fef28SJerry Van Baren Buy a BDI3000; 52016c3fef28SJerry Van Baren else 5202c609719bSwdenk Add a lot of aggravation and time; 5203c609719bSwdenk 52046c3fef28SJerry Van Baren if (a similar board exists) { /* hopefully... */ 52056c3fef28SJerry Van Baren cp -a board/<similar> board/<myboard> 52066c3fef28SJerry Van Baren cp include/configs/<similar>.h include/configs/<myboard>.h 52076c3fef28SJerry Van Baren } else { 5208c609719bSwdenk Create your own board support subdirectory; 52096c3fef28SJerry Van Baren Create your own board include/configs/<myboard>.h file; 52106c3fef28SJerry Van Baren } 52116c3fef28SJerry Van Baren Edit new board/<myboard> files 52126c3fef28SJerry Van Baren Edit new include/configs/<myboard>.h 5213c609719bSwdenk 52146c3fef28SJerry Van Baren while (!accepted) { 5215c609719bSwdenk while (!running) { 5216c609719bSwdenk do { 5217c609719bSwdenk Add / modify source code; 5218c609719bSwdenk } until (compiles); 5219c609719bSwdenk Debug; 5220c609719bSwdenk if (clueless) 5221c609719bSwdenk email("Hi, I am having problems..."); 5222c609719bSwdenk } 52236c3fef28SJerry Van Baren Send patch file to the U-Boot email list; 52246c3fef28SJerry Van Baren if (reasonable critiques) 52256c3fef28SJerry Van Baren Incorporate improvements from email list code review; 52266c3fef28SJerry Van Baren else 52276c3fef28SJerry Van Baren Defend code as written; 52286c3fef28SJerry Van Baren } 5229c609719bSwdenk 5230c609719bSwdenk return 0; 5231c609719bSwdenk} 5232c609719bSwdenk 5233c609719bSwdenkvoid no_more_time (int sig) 5234c609719bSwdenk{ 5235c609719bSwdenk hire_a_guru(); 5236c609719bSwdenk} 5237c609719bSwdenk 5238c609719bSwdenk 5239c609719bSwdenkCoding Standards: 5240c609719bSwdenk----------------- 5241c609719bSwdenk 5242c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel 52432c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script 52447ca9296eSWolfgang Denk"scripts/Lindent" in your Linux kernel source directory. 5245c609719bSwdenk 52462c051651SDetlev ZundelSource files originating from a different project (for example the 52472c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not 52482c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those 52492c051651SDetlev Zundelsources. 52502c051651SDetlev Zundel 52512c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in 52522c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//) 52532c051651SDetlev Zundelin your code. 5254c609719bSwdenk 5255c178d3daSwdenkPlease also stick to the following formatting rules: 5256180d3f74Swdenk- remove any trailing white space 52577ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces 5258180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds 52597ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files 5260180d3f74Swdenk- do not add trailing empty lines to source files 5261180d3f74Swdenk 5262c609719bSwdenkSubmissions which do not conform to the standards may be returned 5263c609719bSwdenkwith a request to reformat the changes. 5264c609719bSwdenk 5265c609719bSwdenk 5266c609719bSwdenkSubmitting Patches: 5267c609719bSwdenk------------------- 5268c609719bSwdenk 5269c609719bSwdenkSince the number of patches for U-Boot is growing, we need to 5270c609719bSwdenkestablish some rules. Submissions which do not conform to these rules 5271c609719bSwdenkmay be rejected, even when they contain important and valuable stuff. 5272c609719bSwdenk 52730d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details. 5274218ca724SWolfgang Denk 52750668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>; 52760668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot 52770668236bSWolfgang Denk 5278c609719bSwdenkWhen you send a patch, please include the following information with 5279c609719bSwdenkit: 5280c609719bSwdenk 5281c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes 5282c609719bSwdenk this bug. Please try to include a way of demonstrating that the 5283c609719bSwdenk patch actually fixes something. 5284c609719bSwdenk 5285c609719bSwdenk* For new features: a description of the feature and your 5286c609719bSwdenk implementation. 5287c609719bSwdenk 5288c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch) 5289c609719bSwdenk 5290c609719bSwdenk* For major contributions, your entry to the CREDITS file 5291c609719bSwdenk 5292c609719bSwdenk* When you add support for a new board, don't forget to add this 52937ca9296eSWolfgang Denk board to the MAINTAINERS file, too. 5294c609719bSwdenk 5295c609719bSwdenk* If your patch adds new configuration options, don't forget to 5296c609719bSwdenk document these in the README file. 5297c609719bSwdenk 5298218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly* 5299218ca724SWolfgang Denk recommended) you can easily generate the patch using the 53007ca9296eSWolfgang Denk "git format-patch". If you then use "git send-email" to send it to 5301218ca724SWolfgang Denk the U-Boot mailing list, you will avoid most of the common problems 5302218ca724SWolfgang Denk with some other mail clients. 5303c609719bSwdenk 5304218ca724SWolfgang Denk If you cannot use git, use "diff -purN OLD NEW". If your version of 5305218ca724SWolfgang Denk diff does not support these options, then get the latest version of 5306218ca724SWolfgang Denk GNU diff. 53076dff5529Swdenk 5308218ca724SWolfgang Denk The current directory when running this command shall be the parent 5309218ca724SWolfgang Denk directory of the U-Boot source tree (i. e. please make sure that 5310218ca724SWolfgang Denk your patch includes sufficient directory information for the 5311218ca724SWolfgang Denk affected files). 5312218ca724SWolfgang Denk 5313218ca724SWolfgang Denk We prefer patches as plain text. MIME attachments are discouraged, 5314218ca724SWolfgang Denk and compressed attachments must not be used. 5315c609719bSwdenk 531652f52c14Swdenk* If one logical set of modifications affects or creates several 531752f52c14Swdenk files, all these changes shall be submitted in a SINGLE patch file. 531852f52c14Swdenk 531952f52c14Swdenk* Changesets that contain different, unrelated modifications shall be 532052f52c14Swdenk submitted as SEPARATE patches, one patch per changeset. 532152f52c14Swdenk 532252f52c14Swdenk 5323c609719bSwdenkNotes: 5324c609719bSwdenk 5325c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched 5326c609719bSwdenk source tree and make sure that no errors or warnings are reported 5327c609719bSwdenk for any of the boards. 5328c609719bSwdenk 5329c609719bSwdenk* Keep your modifications to the necessary minimum: A patch 5330c609719bSwdenk containing several unrelated changes or arbitrary reformats will be 5331c609719bSwdenk returned with a request to re-formatting / split it. 5332c609719bSwdenk 5333c609719bSwdenk* If you modify existing code, make sure that your new code does not 5334c609719bSwdenk add to the memory footprint of the code ;-) Small is beautiful! 5335c609719bSwdenk When adding new features, these should compile conditionally only 5336c609719bSwdenk (using #ifdef), and the resulting code with the new feature 5337c609719bSwdenk disabled must not need more memory than the old code without your 5338c609719bSwdenk modification. 533990dc6704Swdenk 53400668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the 53410668236bSWolfgang Denk u-boot mailing list. Bigger patches will be moderated. If they are 53420668236bSWolfgang Denk reasonable and not too big, they will be acknowledged. But patches 53430668236bSWolfgang Denk bigger than the size limit should be avoided. 5344