1c609719bSwdenk# 26abe6fb6SDetlev Zundel# (C) Copyright 2000 - 2011 3c609719bSwdenk# Wolfgang Denk, DENX Software Engineering, wd@denx.de. 4c609719bSwdenk# 5c609719bSwdenk# See file CREDITS for list of people who contributed to this 6c609719bSwdenk# project. 7c609719bSwdenk# 8c609719bSwdenk# This program is free software; you can redistribute it and/or 9c609719bSwdenk# modify it under the terms of the GNU General Public License as 10c609719bSwdenk# published by the Free Software Foundation; either version 2 of 11c609719bSwdenk# the License, or (at your option) any later version. 12c609719bSwdenk# 13c609719bSwdenk# This program is distributed in the hope that it will be useful, 14c609719bSwdenk# but WITHOUT ANY WARRANTY; without even the implied warranty of 15c609719bSwdenk# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16c609719bSwdenk# GNU General Public License for more details. 17c609719bSwdenk# 18c609719bSwdenk# You should have received a copy of the GNU General Public License 19c609719bSwdenk# along with this program; if not, write to the Free Software 20c609719bSwdenk# Foundation, Inc., 59 Temple Place, Suite 330, Boston, 21c609719bSwdenk# MA 02111-1307 USA 22c609719bSwdenk# 23c609719bSwdenk 24c609719bSwdenkSummary: 25c609719bSwdenk======== 26c609719bSwdenk 2724ee89b9SwdenkThis directory contains the source code for U-Boot, a boot loader for 28e86e5a07SwdenkEmbedded boards based on PowerPC, ARM, MIPS and several other 29e86e5a07Swdenkprocessors, which can be installed in a boot ROM and used to 30e86e5a07Swdenkinitialize and test the hardware or to download and run application 31e86e5a07Swdenkcode. 32c609719bSwdenk 33c609719bSwdenkThe development of U-Boot is closely related to Linux: some parts of 3424ee89b9Swdenkthe source code originate in the Linux source tree, we have some 3524ee89b9Swdenkheader files in common, and special provision has been made to 36c609719bSwdenksupport booting of Linux images. 37c609719bSwdenk 38c609719bSwdenkSome attention has been paid to make this software easily 39c609719bSwdenkconfigurable and extendable. For instance, all monitor commands are 40c609719bSwdenkimplemented with the same call interface, so that it's very easy to 41c609719bSwdenkadd new commands. Also, instead of permanently adding rarely used 42c609719bSwdenkcode (for instance hardware test utilities) to the monitor, you can 43c609719bSwdenkload and run it dynamically. 44c609719bSwdenk 45c609719bSwdenk 46c609719bSwdenkStatus: 47c609719bSwdenk======= 48c609719bSwdenk 49c609719bSwdenkIn general, all boards for which a configuration option exists in the 50c609719bSwdenkMakefile have been tested to some extent and can be considered 51c609719bSwdenk"working". In fact, many of them are used in production systems. 52c609719bSwdenk 53c609719bSwdenkIn case of problems see the CHANGELOG and CREDITS files to find out 54218ca724SWolfgang Denkwho contributed the specific port. The MAINTAINERS file lists board 55218ca724SWolfgang Denkmaintainers. 56c609719bSwdenk 57c609719bSwdenk 58c609719bSwdenkWhere to get help: 59c609719bSwdenk================== 60c609719bSwdenk 61c609719bSwdenkIn case you have questions about, problems with or contributions for 62c609719bSwdenkU-Boot you should send a message to the U-Boot mailing list at 630c32565fSPeter Tyser<u-boot@lists.denx.de>. There is also an archive of previous traffic 640c32565fSPeter Tyseron the mailing list - please search the archive before asking FAQ's. 650c32565fSPeter TyserPlease see http://lists.denx.de/pipermail/u-boot and 660c32565fSPeter Tyserhttp://dir.gmane.org/gmane.comp.boot-loaders.u-boot 67c609719bSwdenk 68c609719bSwdenk 69218ca724SWolfgang DenkWhere to get source code: 70218ca724SWolfgang Denk========================= 71218ca724SWolfgang Denk 72218ca724SWolfgang DenkThe U-Boot source code is maintained in the git repository at 73218ca724SWolfgang Denkgit://www.denx.de/git/u-boot.git ; you can browse it online at 74218ca724SWolfgang Denkhttp://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary 75218ca724SWolfgang Denk 76218ca724SWolfgang DenkThe "snapshot" links on this page allow you to download tarballs of 7711ccc33fSMarcel Ziswilerany version you might be interested in. Official releases are also 78218ca724SWolfgang Denkavailable for FTP download from the ftp://ftp.denx.de/pub/u-boot/ 79218ca724SWolfgang Denkdirectory. 80218ca724SWolfgang Denk 81d4ee711dSAnatolij GustschinPre-built (and tested) images are available from 82218ca724SWolfgang Denkftp://ftp.denx.de/pub/u-boot/images/ 83218ca724SWolfgang Denk 84218ca724SWolfgang Denk 85c609719bSwdenkWhere we come from: 86c609719bSwdenk=================== 87c609719bSwdenk 88c609719bSwdenk- start from 8xxrom sources 8924ee89b9Swdenk- create PPCBoot project (http://sourceforge.net/projects/ppcboot) 90c609719bSwdenk- clean up code 91c609719bSwdenk- make it easier to add custom boards 92c609719bSwdenk- make it possible to add other [PowerPC] CPUs 93c609719bSwdenk- extend functions, especially: 94c609719bSwdenk * Provide extended interface to Linux boot loader 95c609719bSwdenk * S-Record download 96c609719bSwdenk * network boot 9711ccc33fSMarcel Ziswiler * PCMCIA / CompactFlash / ATA disk / SCSI ... boot 9824ee89b9Swdenk- create ARMBoot project (http://sourceforge.net/projects/armboot) 99c609719bSwdenk- add other CPU families (starting with ARM) 10024ee89b9Swdenk- create U-Boot project (http://sourceforge.net/projects/u-boot) 1010d28f34bSMagnus Lilja- current project page: see http://www.denx.de/wiki/U-Boot 10224ee89b9Swdenk 10324ee89b9Swdenk 10424ee89b9SwdenkNames and Spelling: 10524ee89b9Swdenk=================== 10624ee89b9Swdenk 10724ee89b9SwdenkThe "official" name of this project is "Das U-Boot". The spelling 10824ee89b9Swdenk"U-Boot" shall be used in all written text (documentation, comments 10924ee89b9Swdenkin source files etc.). Example: 11024ee89b9Swdenk 11124ee89b9Swdenk This is the README file for the U-Boot project. 11224ee89b9Swdenk 11324ee89b9SwdenkFile names etc. shall be based on the string "u-boot". Examples: 11424ee89b9Swdenk 11524ee89b9Swdenk include/asm-ppc/u-boot.h 11624ee89b9Swdenk 11724ee89b9Swdenk #include <asm/u-boot.h> 11824ee89b9Swdenk 11924ee89b9SwdenkVariable names, preprocessor constants etc. shall be either based on 12024ee89b9Swdenkthe string "u_boot" or on "U_BOOT". Example: 12124ee89b9Swdenk 12224ee89b9Swdenk U_BOOT_VERSION u_boot_logo 12324ee89b9Swdenk IH_OS_U_BOOT u_boot_hush_start 124c609719bSwdenk 125c609719bSwdenk 12693f19cc0SwdenkVersioning: 12793f19cc0Swdenk=========== 12893f19cc0Swdenk 129360d883aSThomas WeberStarting with the release in October 2008, the names of the releases 130360d883aSThomas Weberwere changed from numerical release numbers without deeper meaning 131360d883aSThomas Weberinto a time stamp based numbering. Regular releases are identified by 132360d883aSThomas Webernames consisting of the calendar year and month of the release date. 133360d883aSThomas WeberAdditional fields (if present) indicate release candidates or bug fix 134360d883aSThomas Weberreleases in "stable" maintenance trees. 13593f19cc0Swdenk 136360d883aSThomas WeberExamples: 137360d883aSThomas Weber U-Boot v2009.11 - Release November 2009 138360d883aSThomas Weber U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree 139360d883aSThomas Weber U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release 14093f19cc0Swdenk 14193f19cc0Swdenk 142c609719bSwdenkDirectory Hierarchy: 143c609719bSwdenk==================== 144c609719bSwdenk 1458d321b81SPeter Tyser/arch Architecture specific files 1468d321b81SPeter Tyser /arm Files generic to ARM architecture 1478d321b81SPeter Tyser /cpu CPU specific files 1488d321b81SPeter Tyser /arm720t Files specific to ARM 720 CPUs 1498d321b81SPeter Tyser /arm920t Files specific to ARM 920 CPUs 1506eb0921aSAndreas Bießmann /at91 Files specific to Atmel AT91RM9200 CPU 1518d321b81SPeter Tyser /imx Files specific to Freescale MC9328 i.MX CPUs 1528d321b81SPeter Tyser /s3c24x0 Files specific to Samsung S3C24X0 CPUs 1538d321b81SPeter Tyser /arm925t Files specific to ARM 925 CPUs 1548d321b81SPeter Tyser /arm926ejs Files specific to ARM 926 CPUs 1558d321b81SPeter Tyser /arm1136 Files specific to ARM 1136 CPUs 1568d321b81SPeter Tyser /ixp Files specific to Intel XScale IXP CPUs 1578d321b81SPeter Tyser /pxa Files specific to Intel XScale PXA CPUs 1588d321b81SPeter Tyser /s3c44b0 Files specific to Samsung S3C44B0 CPUs 1598d321b81SPeter Tyser /sa1100 Files specific to Intel StrongARM SA1100 CPUs 1608d321b81SPeter Tyser /lib Architecture specific library files 1618d321b81SPeter Tyser /avr32 Files generic to AVR32 architecture 1628d321b81SPeter Tyser /cpu CPU specific files 1638d321b81SPeter Tyser /lib Architecture specific library files 1648d321b81SPeter Tyser /blackfin Files generic to Analog Devices Blackfin architecture 1658d321b81SPeter Tyser /cpu CPU specific files 1668d321b81SPeter Tyser /lib Architecture specific library files 167fea25720SGraeme Russ /x86 Files generic to x86 architecture 1688d321b81SPeter Tyser /cpu CPU specific files 1698d321b81SPeter Tyser /lib Architecture specific library files 1708d321b81SPeter Tyser /m68k Files generic to m68k architecture 1718d321b81SPeter Tyser /cpu CPU specific files 1728d321b81SPeter Tyser /mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs 1738d321b81SPeter Tyser /mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs 1748d321b81SPeter Tyser /mcf532x Files specific to Freescale ColdFire MCF5329 CPUs 1758d321b81SPeter Tyser /mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs 1768d321b81SPeter Tyser /mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs 1778d321b81SPeter Tyser /lib Architecture specific library files 1788d321b81SPeter Tyser /microblaze Files generic to microblaze architecture 1798d321b81SPeter Tyser /cpu CPU specific files 1808d321b81SPeter Tyser /lib Architecture specific library files 1818d321b81SPeter Tyser /mips Files generic to MIPS architecture 1828d321b81SPeter Tyser /cpu CPU specific files 18392bbd64eSDaniel Schwierzeck /mips32 Files specific to MIPS32 CPUs 18480421fccSXiangfu Liu /xburst Files specific to Ingenic XBurst CPUs 1858d321b81SPeter Tyser /lib Architecture specific library files 186afc1ce82SMacpaul Lin /nds32 Files generic to NDS32 architecture 187afc1ce82SMacpaul Lin /cpu CPU specific files 188afc1ce82SMacpaul Lin /n1213 Files specific to Andes Technology N1213 CPUs 189afc1ce82SMacpaul Lin /lib Architecture specific library files 1908d321b81SPeter Tyser /nios2 Files generic to Altera NIOS2 architecture 1918d321b81SPeter Tyser /cpu CPU specific files 1928d321b81SPeter Tyser /lib Architecture specific library files 193a47a12beSStefan Roese /powerpc Files generic to PowerPC architecture 1948d321b81SPeter Tyser /cpu CPU specific files 1958d321b81SPeter Tyser /74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs 1968d321b81SPeter Tyser /mpc5xx Files specific to Freescale MPC5xx CPUs 1978d321b81SPeter Tyser /mpc5xxx Files specific to Freescale MPC5xxx CPUs 1988d321b81SPeter Tyser /mpc8xx Files specific to Freescale MPC8xx CPUs 1998d321b81SPeter Tyser /mpc8220 Files specific to Freescale MPC8220 CPUs 2008d321b81SPeter Tyser /mpc824x Files specific to Freescale MPC824x CPUs 2018d321b81SPeter Tyser /mpc8260 Files specific to Freescale MPC8260 CPUs 2028d321b81SPeter Tyser /mpc85xx Files specific to Freescale MPC85xx CPUs 2038d321b81SPeter Tyser /ppc4xx Files specific to AMCC PowerPC 4xx CPUs 2048d321b81SPeter Tyser /lib Architecture specific library files 2058d321b81SPeter Tyser /sh Files generic to SH architecture 2068d321b81SPeter Tyser /cpu CPU specific files 2078d321b81SPeter Tyser /sh2 Files specific to sh2 CPUs 2088d321b81SPeter Tyser /sh3 Files specific to sh3 CPUs 2098d321b81SPeter Tyser /sh4 Files specific to sh4 CPUs 2108d321b81SPeter Tyser /lib Architecture specific library files 2118d321b81SPeter Tyser /sparc Files generic to SPARC architecture 2128d321b81SPeter Tyser /cpu CPU specific files 2138d321b81SPeter Tyser /leon2 Files specific to Gaisler LEON2 SPARC CPU 2148d321b81SPeter Tyser /leon3 Files specific to Gaisler LEON3 SPARC CPU 2158d321b81SPeter Tyser /lib Architecture specific library files 2168d321b81SPeter Tyser/api Machine/arch independent API for external apps 2178d321b81SPeter Tyser/board Board dependent files 2188d321b81SPeter Tyser/common Misc architecture independent functions 2198d321b81SPeter Tyser/disk Code for disk drive partition handling 2208d321b81SPeter Tyser/doc Documentation (don't expect too much) 2218d321b81SPeter Tyser/drivers Commonly used device drivers 2228d321b81SPeter Tyser/examples Example code for standalone applications, etc. 2238d321b81SPeter Tyser/fs Filesystem code (cramfs, ext2, jffs2, etc.) 2248d321b81SPeter Tyser/include Header Files 2258d321b81SPeter Tyser/lib Files generic to all architectures 2268d321b81SPeter Tyser /libfdt Library files to support flattened device trees 2278d321b81SPeter Tyser /lzma Library files to support LZMA decompression 2288d321b81SPeter Tyser /lzo Library files to support LZO decompression 2298d321b81SPeter Tyser/net Networking code 2308d321b81SPeter Tyser/post Power On Self Test 2318d321b81SPeter Tyser/rtc Real Time Clock drivers 2328d321b81SPeter Tyser/tools Tools to build S-Record or U-Boot images, etc. 233c609719bSwdenk 234c609719bSwdenkSoftware Configuration: 235c609719bSwdenk======================= 236c609719bSwdenk 237c609719bSwdenkConfiguration is usually done using C preprocessor defines; the 238c609719bSwdenkrationale behind that is to avoid dead code whenever possible. 239c609719bSwdenk 240c609719bSwdenkThere are two classes of configuration variables: 241c609719bSwdenk 242c609719bSwdenk* Configuration _OPTIONS_: 243c609719bSwdenk These are selectable by the user and have names beginning with 244c609719bSwdenk "CONFIG_". 245c609719bSwdenk 246c609719bSwdenk* Configuration _SETTINGS_: 247c609719bSwdenk These depend on the hardware etc. and should not be meddled with if 248c609719bSwdenk you don't know what you're doing; they have names beginning with 2496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD "CONFIG_SYS_". 250c609719bSwdenk 251c609719bSwdenkLater we will add a configuration tool - probably similar to or even 252c609719bSwdenkidentical to what's used for the Linux kernel. Right now, we have to 253c609719bSwdenkdo the configuration by hand, which means creating some symbolic 254c609719bSwdenklinks and editing some configuration files. We use the TQM8xxL boards 255c609719bSwdenkas an example here. 256c609719bSwdenk 257c609719bSwdenk 258c609719bSwdenkSelection of Processor Architecture and Board Type: 259c609719bSwdenk--------------------------------------------------- 260c609719bSwdenk 261c609719bSwdenkFor all supported boards there are ready-to-use default 262c609719bSwdenkconfigurations available; just type "make <board_name>_config". 263c609719bSwdenk 264c609719bSwdenkExample: For a TQM823L module type: 265c609719bSwdenk 266c609719bSwdenk cd u-boot 267c609719bSwdenk make TQM823L_config 268c609719bSwdenk 26911ccc33fSMarcel ZiswilerFor the Cogent platform, you need to specify the CPU type as well; 270c609719bSwdenke.g. "make cogent_mpc8xx_config". And also configure the cogent 271c609719bSwdenkdirectory according to the instructions in cogent/README. 272c609719bSwdenk 273c609719bSwdenk 274c609719bSwdenkConfiguration Options: 275c609719bSwdenk---------------------- 276c609719bSwdenk 277c609719bSwdenkConfiguration depends on the combination of board and CPU type; all 278c609719bSwdenksuch information is kept in a configuration file 279c609719bSwdenk"include/configs/<board_name>.h". 280c609719bSwdenk 281c609719bSwdenkExample: For a TQM823L module, all configuration settings are in 282c609719bSwdenk"include/configs/TQM823L.h". 283c609719bSwdenk 284c609719bSwdenk 2857f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux 2867f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to 2877f6c2cbcSwdenkbuild a config tool - later. 2887f6c2cbcSwdenk 2897f6c2cbcSwdenk 290c609719bSwdenkThe following options need to be configured: 291c609719bSwdenk 2922628114eSKim Phillips- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX. 293c609719bSwdenk 2942628114eSKim Phillips- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS. 2956ccec449SWolfgang Denk 2966ccec449SWolfgang Denk- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined) 29709ea0de0SHaavard Skinnemoen Define exactly one, e.g. CONFIG_ATSTK1002 298c609719bSwdenk 299c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined) 300c609719bSwdenk Define exactly one of 301c609719bSwdenk CONFIG_CMA286_60_OLD 302c609719bSwdenk--- FIXME --- not tested yet: 303c609719bSwdenk CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P, 304c609719bSwdenk CONFIG_CMA287_23, CONFIG_CMA287_50 305c609719bSwdenk 306c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined) 307c609719bSwdenk Define exactly one of 308c609719bSwdenk CONFIG_CMA101, CONFIG_CMA102 309c609719bSwdenk 310c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined) 311c609719bSwdenk Define one or more of 312c609719bSwdenk CONFIG_CMA302 313c609719bSwdenk 314c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined) 315c609719bSwdenk Define one or more of 316c609719bSwdenk CONFIG_LCD_HEARTBEAT - update a character position on 31711ccc33fSMarcel Ziswiler the LCD display every second with 318c609719bSwdenk a "rotator" |\-/|\-/ 319c609719bSwdenk 3202535d602Swdenk- Board flavour: (if CONFIG_MPC8260ADS is defined) 3212535d602Swdenk CONFIG_ADSTYPE 3222535d602Swdenk Possible values are: 3236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8260ADS - original MPC8260ADS 3246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8266ADS - MPC8266ADS 3256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR 3266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8272ADS - MPC8272ADS 3272535d602Swdenk 328cf946c6dSLei Wen- Marvell Family Member 329cf946c6dSLei Wen CONFIG_SYS_MVFS - define it if you want to enable 330cf946c6dSLei Wen multiple fs option at one time 331cf946c6dSLei Wen for marvell soc family 332cf946c6dSLei Wen 333c609719bSwdenk- MPC824X Family Member (if CONFIG_MPC824X is defined) 334c609719bSwdenk Define exactly one of 335c609719bSwdenk CONFIG_MPC8240, CONFIG_MPC8245 336c609719bSwdenk 33711ccc33fSMarcel Ziswiler- 8xx CPU Options: (if using an MPC8xx CPU) 33866ca92a5Swdenk CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if 33966ca92a5Swdenk get_gclk_freq() cannot work 3405da627a4Swdenk e.g. if there is no 32KHz 3415da627a4Swdenk reference PIT/RTC clock 34266ca92a5Swdenk CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK 34366ca92a5Swdenk or XTAL/EXTAL) 344c609719bSwdenk 34566ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU): 3466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8xx_CPUCLK_MIN 3476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8xx_CPUCLK_MAX 34866ca92a5Swdenk CONFIG_8xx_CPUCLK_DEFAULT 34975d1ea7fSwdenk See doc/README.MPC866 35075d1ea7fSwdenk 3516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MEASURE_CPUCLK 35275d1ea7fSwdenk 35375d1ea7fSwdenk Define this to measure the actual CPU clock instead 35475d1ea7fSwdenk of relying on the correctness of the configured 35575d1ea7fSwdenk values. Mostly useful for board bringup to make sure 35675d1ea7fSwdenk the PLL is locked at the intended frequency. Note 35775d1ea7fSwdenk that this requires a (stable) reference clock (32 kHz 3586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD RTC clock or CONFIG_SYS_8XX_XIN) 35975d1ea7fSwdenk 360506f3918SHeiko Schocher CONFIG_SYS_DELAYED_ICACHE 361506f3918SHeiko Schocher 362506f3918SHeiko Schocher Define this option if you want to enable the 363506f3918SHeiko Schocher ICache only when Code runs from RAM. 364506f3918SHeiko Schocher 36566412c63SKumar Gala- 85xx CPU Options: 36666412c63SKumar Gala CONFIG_SYS_FSL_TBCLK_DIV 36766412c63SKumar Gala 36866412c63SKumar Gala Defines the core time base clock divider ratio compared to the 36966412c63SKumar Gala system clock. On most PQ3 devices this is 8, on newer QorIQ 37066412c63SKumar Gala devices it can be 16 or 32. The ratio varies from SoC to Soc. 37166412c63SKumar Gala 3728f29084aSKumar Gala CONFIG_SYS_FSL_PCIE_COMPAT 3738f29084aSKumar Gala 3748f29084aSKumar Gala Defines the string to utilize when trying to match PCIe device 3758f29084aSKumar Gala tree nodes for the given platform. 3768f29084aSKumar Gala 3770b953ffcSMarkus Klotzbuecher- Intel Monahans options: 3786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO 3790b953ffcSMarkus Klotzbuecher 3800b953ffcSMarkus Klotzbuecher Defines the Monahans run mode to oscillator 3810b953ffcSMarkus Klotzbuecher ratio. Valid values are 8, 16, 24, 31. The core 3820b953ffcSMarkus Klotzbuecher frequency is this value multiplied by 13 MHz. 3830b953ffcSMarkus Klotzbuecher 3846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO 3850b953ffcSMarkus Klotzbuecher 3860b953ffcSMarkus Klotzbuecher Defines the Monahans turbo mode to oscillator 3870b953ffcSMarkus Klotzbuecher ratio. Valid values are 1 (default if undefined) and 3880b953ffcSMarkus Klotzbuecher 2. The core frequency as calculated above is multiplied 3890b953ffcSMarkus Klotzbuecher by this value. 3900b953ffcSMarkus Klotzbuecher 39192bbd64eSDaniel Schwierzeck- MIPS CPU options: 39292bbd64eSDaniel Schwierzeck CONFIG_SYS_INIT_SP_OFFSET 39392bbd64eSDaniel Schwierzeck 39492bbd64eSDaniel Schwierzeck Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack 39592bbd64eSDaniel Schwierzeck pointer. This is needed for the temporary stack before 39692bbd64eSDaniel Schwierzeck relocation. 39792bbd64eSDaniel Schwierzeck 39892bbd64eSDaniel Schwierzeck CONFIG_SYS_MIPS_CACHE_MODE 39992bbd64eSDaniel Schwierzeck 40092bbd64eSDaniel Schwierzeck Cache operation mode for the MIPS CPU. 40192bbd64eSDaniel Schwierzeck See also arch/mips/include/asm/mipsregs.h. 40292bbd64eSDaniel Schwierzeck Possible values are: 40392bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_NO_WA 40492bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_WA 40592bbd64eSDaniel Schwierzeck CONF_CM_UNCACHED 40692bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_NONCOHERENT 40792bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_CE 40892bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_COW 40992bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_CUW 41092bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_ACCELERATED 41192bbd64eSDaniel Schwierzeck 41292bbd64eSDaniel Schwierzeck CONFIG_SYS_XWAY_EBU_BOOTCFG 41392bbd64eSDaniel Schwierzeck 41492bbd64eSDaniel Schwierzeck Special option for Lantiq XWAY SoCs for booting from NOR flash. 41592bbd64eSDaniel Schwierzeck See also arch/mips/cpu/mips32/start.S. 41692bbd64eSDaniel Schwierzeck 41792bbd64eSDaniel Schwierzeck CONFIG_XWAY_SWAP_BYTES 41892bbd64eSDaniel Schwierzeck 41992bbd64eSDaniel Schwierzeck Enable compilation of tools/xway-swap-bytes needed for Lantiq 42092bbd64eSDaniel Schwierzeck XWAY SoCs for booting from NOR flash. The U-Boot image needs to 42192bbd64eSDaniel Schwierzeck be swapped if a flash programmer is used. 42292bbd64eSDaniel Schwierzeck 4235da627a4Swdenk- Linux Kernel Interface: 424c609719bSwdenk CONFIG_CLOCKS_IN_MHZ 425c609719bSwdenk 426c609719bSwdenk U-Boot stores all clock information in Hz 427c609719bSwdenk internally. For binary compatibility with older Linux 428c609719bSwdenk kernels (which expect the clocks passed in the 429c609719bSwdenk bd_info data to be in MHz) the environment variable 430c609719bSwdenk "clocks_in_mhz" can be defined so that U-Boot 431c609719bSwdenk converts clock data to MHZ before passing it to the 432c609719bSwdenk Linux kernel. 433c609719bSwdenk When CONFIG_CLOCKS_IN_MHZ is defined, a definition of 434c609719bSwdenk "clocks_in_mhz=1" is automatically included in the 435c609719bSwdenk default environment. 436c609719bSwdenk 4375da627a4Swdenk CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only] 4385da627a4Swdenk 43911ccc33fSMarcel Ziswiler When transferring memsize parameter to linux, some versions 4405da627a4Swdenk expect it to be in bytes, others in MB. 4415da627a4Swdenk Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes. 4425da627a4Swdenk 443fec6d9eeSGerald Van Baren CONFIG_OF_LIBFDT 444f57f70aaSWolfgang Denk 445f57f70aaSWolfgang Denk New kernel versions are expecting firmware settings to be 446213bf8c8SGerald Van Baren passed using flattened device trees (based on open firmware 447213bf8c8SGerald Van Baren concepts). 448213bf8c8SGerald Van Baren 449213bf8c8SGerald Van Baren CONFIG_OF_LIBFDT 450213bf8c8SGerald Van Baren * New libfdt-based support 451213bf8c8SGerald Van Baren * Adds the "fdt" command 4523bb342fcSKim Phillips * The bootm command automatically updates the fdt 453213bf8c8SGerald Van Baren 454b55ae402SMarcel Ziswiler OF_CPU - The proper name of the cpus node (only required for 455b55ae402SMarcel Ziswiler MPC512X and MPC5xxx based boards). 456b55ae402SMarcel Ziswiler OF_SOC - The proper name of the soc node (only required for 457b55ae402SMarcel Ziswiler MPC512X and MPC5xxx based boards). 458f57f70aaSWolfgang Denk OF_TBCLK - The timebase frequency. 459c2871f03SKumar Gala OF_STDOUT_PATH - The path to the console device 460f57f70aaSWolfgang Denk 46111ccc33fSMarcel Ziswiler boards with QUICC Engines require OF_QE to set UCC MAC 46211ccc33fSMarcel Ziswiler addresses 4633bb342fcSKim Phillips 4644e253137SKumar Gala CONFIG_OF_BOARD_SETUP 4654e253137SKumar Gala 4664e253137SKumar Gala Board code has addition modification that it wants to make 4674e253137SKumar Gala to the flat device tree before handing it off to the kernel 4686705d81eSwdenk 4690267768eSMatthew McClintock CONFIG_OF_BOOT_CPU 4700267768eSMatthew McClintock 47111ccc33fSMarcel Ziswiler This define fills in the correct boot CPU in the boot 4720267768eSMatthew McClintock param header, the default value is zero if undefined. 4730267768eSMatthew McClintock 4743887c3fbSHeiko Schocher CONFIG_OF_IDE_FIXUP 4753887c3fbSHeiko Schocher 4763887c3fbSHeiko Schocher U-Boot can detect if an IDE device is present or not. 4773887c3fbSHeiko Schocher If not, and this new config option is activated, U-Boot 4783887c3fbSHeiko Schocher removes the ATA node from the DTS before booting Linux, 4793887c3fbSHeiko Schocher so the Linux IDE driver does not probe the device and 4803887c3fbSHeiko Schocher crash. This is needed for buggy hardware (uc101) where 4813887c3fbSHeiko Schocher no pull down resistor is connected to the signal IDE5V_DD7. 4823887c3fbSHeiko Schocher 4837eb29398SIgor Grinberg CONFIG_MACH_TYPE [relevant for ARM only][mandatory] 4847eb29398SIgor Grinberg 4857eb29398SIgor Grinberg This setting is mandatory for all boards that have only one 4867eb29398SIgor Grinberg machine type and must be used to specify the machine type 4877eb29398SIgor Grinberg number as it appears in the ARM machine registry 4887eb29398SIgor Grinberg (see http://www.arm.linux.org.uk/developer/machines/). 4897eb29398SIgor Grinberg Only boards that have multiple machine types supported 4907eb29398SIgor Grinberg in a single configuration file and the machine type is 4917eb29398SIgor Grinberg runtime discoverable, do not have to use this setting. 4927eb29398SIgor Grinberg 4930b2f4ecaSNiklaus Giger- vxWorks boot parameters: 4940b2f4ecaSNiklaus Giger 4950b2f4ecaSNiklaus Giger bootvx constructs a valid bootline using the following 4960b2f4ecaSNiklaus Giger environments variables: bootfile, ipaddr, serverip, hostname. 4970b2f4ecaSNiklaus Giger It loads the vxWorks image pointed bootfile. 4980b2f4ecaSNiklaus Giger 4990b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name 5000b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address 5010b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server 5020b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters 5030b2f4ecaSNiklaus Giger 5040b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_ADD_PARAMS 5050b2f4ecaSNiklaus Giger 5060b2f4ecaSNiklaus Giger Add it at the end of the bootline. E.g "u=username pw=secret" 5070b2f4ecaSNiklaus Giger 5080b2f4ecaSNiklaus Giger Note: If a "bootargs" environment is defined, it will overwride 5090b2f4ecaSNiklaus Giger the defaults discussed just above. 5100b2f4ecaSNiklaus Giger 5112c451f78SAneesh V- Cache Configuration: 5122c451f78SAneesh V CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot 5132c451f78SAneesh V CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot 5142c451f78SAneesh V CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot 5152c451f78SAneesh V 51693bc2193SAneesh V- Cache Configuration for ARM: 51793bc2193SAneesh V CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache 51893bc2193SAneesh V controller 51993bc2193SAneesh V CONFIG_SYS_PL310_BASE - Physical base address of PL310 52093bc2193SAneesh V controller register space 52193bc2193SAneesh V 5226705d81eSwdenk- Serial Ports: 52348d0192fSAndreas Engel CONFIG_PL010_SERIAL 5246705d81eSwdenk 5256705d81eSwdenk Define this if you want support for Amba PrimeCell PL010 UARTs. 5266705d81eSwdenk 52748d0192fSAndreas Engel CONFIG_PL011_SERIAL 5286705d81eSwdenk 5296705d81eSwdenk Define this if you want support for Amba PrimeCell PL011 UARTs. 5306705d81eSwdenk 5316705d81eSwdenk CONFIG_PL011_CLOCK 5326705d81eSwdenk 5336705d81eSwdenk If you have Amba PrimeCell PL011 UARTs, set this variable to 5346705d81eSwdenk the clock speed of the UARTs. 5356705d81eSwdenk 5366705d81eSwdenk CONFIG_PL01x_PORTS 5376705d81eSwdenk 5386705d81eSwdenk If you have Amba PrimeCell PL010 or PL011 UARTs on your board, 5396705d81eSwdenk define this to a list of base addresses for each (supported) 5406705d81eSwdenk port. See e.g. include/configs/versatile.h 5416705d81eSwdenk 542910f1ae3SJohn Rigby CONFIG_PL011_SERIAL_RLCR 543910f1ae3SJohn Rigby 544910f1ae3SJohn Rigby Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500) 545910f1ae3SJohn Rigby have separate receive and transmit line control registers. Set 546910f1ae3SJohn Rigby this variable to initialize the extra register. 547910f1ae3SJohn Rigby 548910f1ae3SJohn Rigby CONFIG_PL011_SERIAL_FLUSH_ON_INIT 549910f1ae3SJohn Rigby 550910f1ae3SJohn Rigby On some platforms (e.g. U8500) U-Boot is loaded by a second stage 551910f1ae3SJohn Rigby boot loader that has already initialized the UART. Define this 552910f1ae3SJohn Rigby variable to flush the UART at init time. 553910f1ae3SJohn Rigby 5546705d81eSwdenk 555c609719bSwdenk- Console Interface: 556c609719bSwdenk Depending on board, define exactly one serial port 557c609719bSwdenk (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2, 558c609719bSwdenk CONFIG_8xx_CONS_SCC1, ...), or switch off the serial 559c609719bSwdenk console by defining CONFIG_8xx_CONS_NONE 560c609719bSwdenk 561c609719bSwdenk Note: if CONFIG_8xx_CONS_NONE is defined, the serial 562c609719bSwdenk port routines must be defined elsewhere 563c609719bSwdenk (i.e. serial_init(), serial_getc(), ...) 564c609719bSwdenk 565c609719bSwdenk CONFIG_CFB_CONSOLE 566c609719bSwdenk Enables console device for a color framebuffer. Needs following 567c53043b7SWolfgang Denk defines (cf. smiLynxEM, i8042) 568c609719bSwdenk VIDEO_FB_LITTLE_ENDIAN graphic memory organisation 569c609719bSwdenk (default big endian) 570c609719bSwdenk VIDEO_HW_RECTFILL graphic chip supports 571c609719bSwdenk rectangle fill 572c609719bSwdenk (cf. smiLynxEM) 573c609719bSwdenk VIDEO_HW_BITBLT graphic chip supports 574c609719bSwdenk bit-blit (cf. smiLynxEM) 575c609719bSwdenk VIDEO_VISIBLE_COLS visible pixel columns 576c609719bSwdenk (cols=pitch) 577c609719bSwdenk VIDEO_VISIBLE_ROWS visible pixel rows 578c609719bSwdenk VIDEO_PIXEL_SIZE bytes per pixel 579c609719bSwdenk VIDEO_DATA_FORMAT graphic data format 580c609719bSwdenk (0-5, cf. cfb_console.c) 581c609719bSwdenk VIDEO_FB_ADRS framebuffer address 582c609719bSwdenk VIDEO_KBD_INIT_FCT keyboard int fct 583c609719bSwdenk (i.e. i8042_kbd_init()) 584c609719bSwdenk VIDEO_TSTC_FCT test char fct 585c609719bSwdenk (i.e. i8042_tstc) 586c609719bSwdenk VIDEO_GETC_FCT get char fct 587c609719bSwdenk (i.e. i8042_getc) 588c609719bSwdenk CONFIG_CONSOLE_CURSOR cursor drawing on/off 589c609719bSwdenk (requires blink timer 590c609719bSwdenk cf. i8042.c) 5916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c) 592c609719bSwdenk CONFIG_CONSOLE_TIME display time/date info in 593c609719bSwdenk upper right corner 594602ad3b3SJon Loeliger (requires CONFIG_CMD_DATE) 595c609719bSwdenk CONFIG_VIDEO_LOGO display Linux logo in 596c609719bSwdenk upper left corner 597a6c7ad2fSwdenk CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of 598a6c7ad2fSwdenk linux_logo.h for logo. 599a6c7ad2fSwdenk Requires CONFIG_VIDEO_LOGO 600c609719bSwdenk CONFIG_CONSOLE_EXTRA_INFO 60111ccc33fSMarcel Ziswiler additional board info beside 602c609719bSwdenk the logo 603c609719bSwdenk 604c609719bSwdenk When CONFIG_CFB_CONSOLE is defined, video console is 605c609719bSwdenk default i/o. Serial console can be forced with 606c609719bSwdenk environment 'console=serial'. 607c609719bSwdenk 608a3ad8e26Swdenk When CONFIG_SILENT_CONSOLE is defined, all console 609a3ad8e26Swdenk messages (by U-Boot and Linux!) can be silenced with 610a3ad8e26Swdenk the "silent" environment variable. See 611a3ad8e26Swdenk doc/README.silent for more information. 612a3ad8e26Swdenk 613c609719bSwdenk- Console Baudrate: 614c609719bSwdenk CONFIG_BAUDRATE - in bps 615c609719bSwdenk Select one of the baudrates listed in 6166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BAUDRATE_TABLE, see below. 6176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale 618c609719bSwdenk 619c92fac91SHeiko Schocher- Console Rx buffer length 620c92fac91SHeiko Schocher With CONFIG_SYS_SMC_RXBUFLEN it is possible to define 621c92fac91SHeiko Schocher the maximum receive buffer length for the SMC. 6222b3f12c2SHeiko Schocher This option is actual only for 82xx and 8xx possible. 623c92fac91SHeiko Schocher If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE 624c92fac91SHeiko Schocher must be defined, to setup the maximum idle timeout for 625c92fac91SHeiko Schocher the SMC. 626c92fac91SHeiko Schocher 6279558b48aSGraeme Russ- Pre-Console Buffer: 6289558b48aSGraeme Russ Prior to the console being initialised (i.e. serial UART 6299558b48aSGraeme Russ initialised etc) all console output is silently discarded. 6309558b48aSGraeme Russ Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to 6319558b48aSGraeme Russ buffer any console messages prior to the console being 6329558b48aSGraeme Russ initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ 6339558b48aSGraeme Russ bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is 6349558b48aSGraeme Russ a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ 6359558b48aSGraeme Russ bytes are output before the console is initialised, the 6369558b48aSGraeme Russ earlier bytes are discarded. 6379558b48aSGraeme Russ 6389558b48aSGraeme Russ 'Sane' compilers will generate smaller code if 6399558b48aSGraeme Russ CONFIG_PRE_CON_BUF_SZ is a power of 2 6409558b48aSGraeme Russ 641*295d3942SSimon Glass- Pre-console putc(): 642*295d3942SSimon Glass Prior to the console being initialised, console output is 643*295d3942SSimon Glass normally silently discarded. This can be annoying if a 644*295d3942SSimon Glass panic() happens in this time. 645*295d3942SSimon Glass 646*295d3942SSimon Glass If the CONFIG_PRE_CONSOLE_PUTC option is defined, then 647*295d3942SSimon Glass U-Boot will call board_pre_console_putc() for each output 648*295d3942SSimon Glass character in this case, This function should try to output 649*295d3942SSimon Glass the character if possible, perhaps on all available UARTs 650*295d3942SSimon Glass (it will need to do this directly, since the console code 651*295d3942SSimon Glass is not functional yet). Note that if the panic happens 652*295d3942SSimon Glass early enough, then it is possible that board_init_f() 653*295d3942SSimon Glass (or even arch_cpu_init() on ARM) has not been called yet. 654*295d3942SSimon Glass You should init all clocks, GPIOs, etc. that are needed 655*295d3942SSimon Glass to get the character out. Baud rates will need to default 656*295d3942SSimon Glass to something sensible. 657*295d3942SSimon Glass 658c609719bSwdenk- Boot Delay: CONFIG_BOOTDELAY - in seconds 659c609719bSwdenk Delay before automatically booting the default image; 660c609719bSwdenk set to -1 to disable autoboot. 661c609719bSwdenk 662c609719bSwdenk See doc/README.autoboot for these options that 663c609719bSwdenk work with CONFIG_BOOTDELAY. None are required. 664c609719bSwdenk CONFIG_BOOT_RETRY_TIME 665c609719bSwdenk CONFIG_BOOT_RETRY_MIN 666c609719bSwdenk CONFIG_AUTOBOOT_KEYED 667c609719bSwdenk CONFIG_AUTOBOOT_PROMPT 668c609719bSwdenk CONFIG_AUTOBOOT_DELAY_STR 669c609719bSwdenk CONFIG_AUTOBOOT_STOP_STR 670c609719bSwdenk CONFIG_AUTOBOOT_DELAY_STR2 671c609719bSwdenk CONFIG_AUTOBOOT_STOP_STR2 672c609719bSwdenk CONFIG_ZERO_BOOTDELAY_CHECK 673c609719bSwdenk CONFIG_RESET_TO_RETRY 674c609719bSwdenk 675c609719bSwdenk- Autoboot Command: 676c609719bSwdenk CONFIG_BOOTCOMMAND 677c609719bSwdenk Only needed when CONFIG_BOOTDELAY is enabled; 678c609719bSwdenk define a command string that is automatically executed 679c609719bSwdenk when no character is read on the console interface 680c609719bSwdenk within "Boot Delay" after reset. 681c609719bSwdenk 682c609719bSwdenk CONFIG_BOOTARGS 683c609719bSwdenk This can be used to pass arguments to the bootm 684c609719bSwdenk command. The value of CONFIG_BOOTARGS goes into the 685c609719bSwdenk environment value "bootargs". 686c609719bSwdenk 687c609719bSwdenk CONFIG_RAMBOOT and CONFIG_NFSBOOT 688c609719bSwdenk The value of these goes into the environment as 689c609719bSwdenk "ramboot" and "nfsboot" respectively, and can be used 690c609719bSwdenk as a convenience, when switching between booting from 69111ccc33fSMarcel Ziswiler RAM and NFS. 692c609719bSwdenk 693c609719bSwdenk- Pre-Boot Commands: 694c609719bSwdenk CONFIG_PREBOOT 695c609719bSwdenk 696c609719bSwdenk When this option is #defined, the existence of the 697c609719bSwdenk environment variable "preboot" will be checked 698c609719bSwdenk immediately before starting the CONFIG_BOOTDELAY 699c609719bSwdenk countdown and/or running the auto-boot command resp. 700c609719bSwdenk entering interactive mode. 701c609719bSwdenk 702c609719bSwdenk This feature is especially useful when "preboot" is 703c609719bSwdenk automatically generated or modified. For an example 704c609719bSwdenk see the LWMON board specific code: here "preboot" is 705c609719bSwdenk modified when the user holds down a certain 706c609719bSwdenk combination of keys on the (special) keyboard when 707c609719bSwdenk booting the systems 708c609719bSwdenk 709c609719bSwdenk- Serial Download Echo Mode: 710c609719bSwdenk CONFIG_LOADS_ECHO 711c609719bSwdenk If defined to 1, all characters received during a 712c609719bSwdenk serial download (using the "loads" command) are 713c609719bSwdenk echoed back. This might be needed by some terminal 714c609719bSwdenk emulations (like "cu"), but may as well just take 715c609719bSwdenk time on others. This setting #define's the initial 716c609719bSwdenk value of the "loads_echo" environment variable. 717c609719bSwdenk 718602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined) 719c609719bSwdenk CONFIG_KGDB_BAUDRATE 720c609719bSwdenk Select one of the baudrates listed in 7216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BAUDRATE_TABLE, see below. 722c609719bSwdenk 723c609719bSwdenk- Monitor Functions: 724602ad3b3SJon Loeliger Monitor commands can be included or excluded 725602ad3b3SJon Loeliger from the build by using the #include files 726602ad3b3SJon Loeliger "config_cmd_all.h" and #undef'ing unwanted 727602ad3b3SJon Loeliger commands, or using "config_cmd_default.h" 728602ad3b3SJon Loeliger and augmenting with additional #define's 729602ad3b3SJon Loeliger for wanted commands. 730c609719bSwdenk 731602ad3b3SJon Loeliger The default command configuration includes all commands 732602ad3b3SJon Loeliger except those marked below with a "*". 733602ad3b3SJon Loeliger 734602ad3b3SJon Loeliger CONFIG_CMD_ASKENV * ask for env variable 735602ad3b3SJon Loeliger CONFIG_CMD_BDI bdinfo 736602ad3b3SJon Loeliger CONFIG_CMD_BEDBUG * Include BedBug Debugger 737602ad3b3SJon Loeliger CONFIG_CMD_BMP * BMP support 738602ad3b3SJon Loeliger CONFIG_CMD_BSP * Board specific commands 739602ad3b3SJon Loeliger CONFIG_CMD_BOOTD bootd 740602ad3b3SJon Loeliger CONFIG_CMD_CACHE * icache, dcache 741602ad3b3SJon Loeliger CONFIG_CMD_CONSOLE coninfo 742710b9938SMike Frysinger CONFIG_CMD_CRC32 * crc32 743602ad3b3SJon Loeliger CONFIG_CMD_DATE * support for RTC, date/time... 744602ad3b3SJon Loeliger CONFIG_CMD_DHCP * DHCP support 745602ad3b3SJon Loeliger CONFIG_CMD_DIAG * Diagnostics 746a7c93104SPeter Tyser CONFIG_CMD_DS4510 * ds4510 I2C gpio commands 747a7c93104SPeter Tyser CONFIG_CMD_DS4510_INFO * ds4510 I2C info command 748a7c93104SPeter Tyser CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd 749a7c93104SPeter Tyser CONFIG_CMD_DS4510_RST * ds4510 I2C rst command 750602ad3b3SJon Loeliger CONFIG_CMD_DTT * Digital Therm and Thermostat 751602ad3b3SJon Loeliger CONFIG_CMD_ECHO echo arguments 752246c6922SPeter Tyser CONFIG_CMD_EDITENV edit env variable 753602ad3b3SJon Loeliger CONFIG_CMD_EEPROM * EEPROM read/write support 754602ad3b3SJon Loeliger CONFIG_CMD_ELF * bootelf, bootvx 7550c79cda0SMike Frysinger CONFIG_CMD_EXPORTENV * export the environment 756bdab39d3SMike Frysinger CONFIG_CMD_SAVEENV saveenv 757602ad3b3SJon Loeliger CONFIG_CMD_FDC * Floppy Disk Support 758602ad3b3SJon Loeliger CONFIG_CMD_FAT * FAT partition support 759602ad3b3SJon Loeliger CONFIG_CMD_FDOS * Dos diskette Support 760602ad3b3SJon Loeliger CONFIG_CMD_FLASH flinfo, erase, protect 761602ad3b3SJon Loeliger CONFIG_CMD_FPGA FPGA device initialization support 762a641b979SMike Frysinger CONFIG_CMD_GO * the 'go' command (exec code) 763a000b795SKim Phillips CONFIG_CMD_GREPENV * search environment 764602ad3b3SJon Loeliger CONFIG_CMD_HWFLOW * RTS/CTS hw flow control 765602ad3b3SJon Loeliger CONFIG_CMD_I2C * I2C serial bus support 766602ad3b3SJon Loeliger CONFIG_CMD_IDE * IDE harddisk support 767602ad3b3SJon Loeliger CONFIG_CMD_IMI iminfo 768602ad3b3SJon Loeliger CONFIG_CMD_IMLS List all found images 769602ad3b3SJon Loeliger CONFIG_CMD_IMMAP * IMMR dump support 7700c79cda0SMike Frysinger CONFIG_CMD_IMPORTENV * import an environment 771602ad3b3SJon Loeliger CONFIG_CMD_IRQ * irqinfo 772602ad3b3SJon Loeliger CONFIG_CMD_ITEST Integer/string test of 2 values 773602ad3b3SJon Loeliger CONFIG_CMD_JFFS2 * JFFS2 Support 774602ad3b3SJon Loeliger CONFIG_CMD_KGDB * kgdb 7751ba7fd25SMike Frysinger CONFIG_CMD_LDRINFO ldrinfo (display Blackfin loader) 776602ad3b3SJon Loeliger CONFIG_CMD_LOADB loadb 777602ad3b3SJon Loeliger CONFIG_CMD_LOADS loads 77802c9aa1dSRobin Getz CONFIG_CMD_MD5SUM print md5 message digest 77902c9aa1dSRobin Getz (requires CONFIG_CMD_MEMORY and CONFIG_MD5) 780602ad3b3SJon Loeliger CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base, 78156523f12Swdenk loop, loopw, mtest 782602ad3b3SJon Loeliger CONFIG_CMD_MISC Misc functions like sleep etc 783602ad3b3SJon Loeliger CONFIG_CMD_MMC * MMC memory mapped support 784602ad3b3SJon Loeliger CONFIG_CMD_MII * MII utility commands 78568d7d651SStefan Roese CONFIG_CMD_MTDPARTS * MTD partition support 786602ad3b3SJon Loeliger CONFIG_CMD_NAND * NAND support 787602ad3b3SJon Loeliger CONFIG_CMD_NET bootp, tftpboot, rarpboot 788e92739d3SPeter Tyser CONFIG_CMD_PCA953X * PCA953x I2C gpio commands 789e92739d3SPeter Tyser CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command 790602ad3b3SJon Loeliger CONFIG_CMD_PCI * pciinfo 791602ad3b3SJon Loeliger CONFIG_CMD_PCMCIA * PCMCIA support 792602ad3b3SJon Loeliger CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network 793602ad3b3SJon Loeliger host 794602ad3b3SJon Loeliger CONFIG_CMD_PORTIO * Port I/O 795602ad3b3SJon Loeliger CONFIG_CMD_REGINFO * Register dump 796602ad3b3SJon Loeliger CONFIG_CMD_RUN run command in env variable 797602ad3b3SJon Loeliger CONFIG_CMD_SAVES * save S record dump 798602ad3b3SJon Loeliger CONFIG_CMD_SCSI * SCSI Support 799602ad3b3SJon Loeliger CONFIG_CMD_SDRAM * print SDRAM configuration information 800602ad3b3SJon Loeliger (requires CONFIG_CMD_I2C) 801602ad3b3SJon Loeliger CONFIG_CMD_SETGETDCR Support for DCR Register access 802602ad3b3SJon Loeliger (4xx only) 803c6b1ee66SAlexander Holler CONFIG_CMD_SHA1SUM print sha1 memory digest 80402c9aa1dSRobin Getz (requires CONFIG_CMD_MEMORY) 80574de7aefSWolfgang Denk CONFIG_CMD_SOURCE "source" command Support 806602ad3b3SJon Loeliger CONFIG_CMD_SPI * SPI serial bus support 8077a83af07SLuca Ceresoli CONFIG_CMD_TFTPSRV * TFTP transfer in server mode 8081fb7cd49SSimon Glass CONFIG_CMD_TFTPPUT * TFTP put command (upload) 809ca366d0eSChe-liang Chiou CONFIG_CMD_TIME * run command and report execution time 810602ad3b3SJon Loeliger CONFIG_CMD_USB * USB support 811602ad3b3SJon Loeliger CONFIG_CMD_CDP * Cisco Discover Protocol support 812602ad3b3SJon Loeliger CONFIG_CMD_FSL * Microblaze FSL support 813c609719bSwdenk 814c609719bSwdenk 815c609719bSwdenk EXAMPLE: If you want all functions except of network 816c609719bSwdenk support you can write: 817c609719bSwdenk 818602ad3b3SJon Loeliger #include "config_cmd_all.h" 819602ad3b3SJon Loeliger #undef CONFIG_CMD_NET 820c609719bSwdenk 821213bf8c8SGerald Van Baren Other Commands: 822213bf8c8SGerald Van Baren fdt (flattened device tree) command: CONFIG_OF_LIBFDT 823c609719bSwdenk 824c609719bSwdenk Note: Don't enable the "icache" and "dcache" commands 825602ad3b3SJon Loeliger (configuration option CONFIG_CMD_CACHE) unless you know 826c609719bSwdenk what you (and your U-Boot users) are doing. Data 827c609719bSwdenk cache cannot be enabled on systems like the 8xx or 828c609719bSwdenk 8260 (where accesses to the IMMR region must be 829c609719bSwdenk uncached), and it cannot be disabled on all other 830c609719bSwdenk systems where we (mis-) use the data cache to hold an 831c609719bSwdenk initial stack and some data. 832c609719bSwdenk 833c609719bSwdenk 834c609719bSwdenk XXX - this list needs to get updated! 835c609719bSwdenk 83645ba8077SSimon Glass- Device tree: 83745ba8077SSimon Glass CONFIG_OF_CONTROL 83845ba8077SSimon Glass If this variable is defined, U-Boot will use a device tree 83945ba8077SSimon Glass to configure its devices, instead of relying on statically 84045ba8077SSimon Glass compiled #defines in the board file. This option is 84145ba8077SSimon Glass experimental and only available on a few boards. The device 84245ba8077SSimon Glass tree is available in the global data as gd->fdt_blob. 84345ba8077SSimon Glass 8442c0f79e4SSimon Glass U-Boot needs to get its device tree from somewhere. This can 8452c0f79e4SSimon Glass be done using one of the two options below: 846bbb0b128SSimon Glass 847bbb0b128SSimon Glass CONFIG_OF_EMBED 848bbb0b128SSimon Glass If this variable is defined, U-Boot will embed a device tree 849bbb0b128SSimon Glass binary in its image. This device tree file should be in the 850bbb0b128SSimon Glass board directory and called <soc>-<board>.dts. The binary file 851bbb0b128SSimon Glass is then picked up in board_init_f() and made available through 852bbb0b128SSimon Glass the global data structure as gd->blob. 85345ba8077SSimon Glass 8542c0f79e4SSimon Glass CONFIG_OF_SEPARATE 8552c0f79e4SSimon Glass If this variable is defined, U-Boot will build a device tree 8562c0f79e4SSimon Glass binary. It will be called u-boot.dtb. Architecture-specific 8572c0f79e4SSimon Glass code will locate it at run-time. Generally this works by: 8582c0f79e4SSimon Glass 8592c0f79e4SSimon Glass cat u-boot.bin u-boot.dtb >image.bin 8602c0f79e4SSimon Glass 8612c0f79e4SSimon Glass and in fact, U-Boot does this for you, creating a file called 8622c0f79e4SSimon Glass u-boot-dtb.bin which is useful in the common case. You can 8632c0f79e4SSimon Glass still use the individual files if you need something more 8642c0f79e4SSimon Glass exotic. 8652c0f79e4SSimon Glass 866c609719bSwdenk- Watchdog: 867c609719bSwdenk CONFIG_WATCHDOG 868c609719bSwdenk If this variable is defined, it enables watchdog 8696abe6fb6SDetlev Zundel support for the SoC. There must be support in the SoC 8706abe6fb6SDetlev Zundel specific code for a watchdog. For the 8xx and 8260 8716abe6fb6SDetlev Zundel CPUs, the SIU Watchdog feature is enabled in the SYPCR 8726abe6fb6SDetlev Zundel register. When supported for a specific SoC is 8736abe6fb6SDetlev Zundel available, then no further board specific code should 8746abe6fb6SDetlev Zundel be needed to use it. 8756abe6fb6SDetlev Zundel 8766abe6fb6SDetlev Zundel CONFIG_HW_WATCHDOG 8776abe6fb6SDetlev Zundel When using a watchdog circuitry external to the used 8786abe6fb6SDetlev Zundel SoC, then define this variable and provide board 8796abe6fb6SDetlev Zundel specific code for the "hw_watchdog_reset" function. 880c609719bSwdenk 881c1551ea8Sstroese- U-Boot Version: 882c1551ea8Sstroese CONFIG_VERSION_VARIABLE 883c1551ea8Sstroese If this variable is defined, an environment variable 884c1551ea8Sstroese named "ver" is created by U-Boot showing the U-Boot 885c1551ea8Sstroese version as printed by the "version" command. 886c1551ea8Sstroese This variable is readonly. 887c1551ea8Sstroese 888c609719bSwdenk- Real-Time Clock: 889c609719bSwdenk 890602ad3b3SJon Loeliger When CONFIG_CMD_DATE is selected, the type of the RTC 891c609719bSwdenk has to be selected, too. Define exactly one of the 892c609719bSwdenk following options: 893c609719bSwdenk 894c609719bSwdenk CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx 895c609719bSwdenk CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC 8964e8b7544SFabio Estevam CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC 897c609719bSwdenk CONFIG_RTC_MC146818 - use MC146818 RTC 8981cb8e980Swdenk CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC 899c609719bSwdenk CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC 9007f70e853Swdenk CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC 9013bac3513Swdenk CONFIG_RTC_DS164x - use Dallas DS164x RTC 9029536dfccSTor Krill CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC 9034c0d4c3bSwdenk CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC 9046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337 90571d19f30SHeiko Schocher CONFIG_SYS_RV3029_TCR - enable trickle charger on 90671d19f30SHeiko Schocher RV3029 RTC. 907c609719bSwdenk 908b37c7e5eSwdenk Note that if the RTC uses I2C, then the I2C interface 909b37c7e5eSwdenk must also be configured. See I2C Support, below. 910b37c7e5eSwdenk 911e92739d3SPeter Tyser- GPIO Support: 912e92739d3SPeter Tyser CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO 913e92739d3SPeter Tyser CONFIG_PCA953X_INFO - enable pca953x info command 914e92739d3SPeter Tyser 9155dec49caSChris Packham The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of 9165dec49caSChris Packham chip-ngpio pairs that tell the PCA953X driver the number of 9175dec49caSChris Packham pins supported by a particular chip. 9185dec49caSChris Packham 919e92739d3SPeter Tyser Note that if the GPIO device uses I2C, then the I2C interface 920e92739d3SPeter Tyser must also be configured. See I2C Support, below. 921e92739d3SPeter Tyser 922c609719bSwdenk- Timestamp Support: 923c609719bSwdenk 924c609719bSwdenk When CONFIG_TIMESTAMP is selected, the timestamp 925c609719bSwdenk (date and time) of an image is printed by image 926c609719bSwdenk commands like bootm or iminfo. This option is 927602ad3b3SJon Loeliger automatically enabled when you select CONFIG_CMD_DATE . 928c609719bSwdenk 929c609719bSwdenk- Partition Support: 930c609719bSwdenk CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION 93107f3d789Srichardretanubun and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION 932c609719bSwdenk 933602ad3b3SJon Loeliger If IDE or SCSI support is enabled (CONFIG_CMD_IDE or 934218ca724SWolfgang Denk CONFIG_CMD_SCSI) you must configure support for at 935218ca724SWolfgang Denk least one partition type as well. 936c609719bSwdenk 937c609719bSwdenk- IDE Reset method: 9384d13cbadSwdenk CONFIG_IDE_RESET_ROUTINE - this is defined in several 9394d13cbadSwdenk board configurations files but used nowhere! 940c609719bSwdenk 9414d13cbadSwdenk CONFIG_IDE_RESET - is this is defined, IDE Reset will 9424d13cbadSwdenk be performed by calling the function 9434d13cbadSwdenk ide_set_reset(int reset) 9444d13cbadSwdenk which has to be defined in a board specific file 945c609719bSwdenk 946c609719bSwdenk- ATAPI Support: 947c609719bSwdenk CONFIG_ATAPI 948c609719bSwdenk 949c609719bSwdenk Set this to enable ATAPI support. 950c609719bSwdenk 951c40b2956Swdenk- LBA48 Support 952c40b2956Swdenk CONFIG_LBA48 953c40b2956Swdenk 954c40b2956Swdenk Set this to enable support for disks larger than 137GB 9554b142febSHeiko Schocher Also look at CONFIG_SYS_64BIT_LBA. 956c40b2956Swdenk Whithout these , LBA48 support uses 32bit variables and will 'only' 957c40b2956Swdenk support disks up to 2.1TB. 958c40b2956Swdenk 9596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_64BIT_LBA: 960c40b2956Swdenk When enabled, makes the IDE subsystem use 64bit sector addresses. 961c40b2956Swdenk Default is 32bit. 962c40b2956Swdenk 963c609719bSwdenk- SCSI Support: 964c609719bSwdenk At the moment only there is only support for the 965c609719bSwdenk SYM53C8XX SCSI controller; define 966c609719bSwdenk CONFIG_SCSI_SYM53C8XX to enable it. 967c609719bSwdenk 9686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and 9696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID * 9706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the 971c609719bSwdenk maximum numbers of LUNs, SCSI ID's and target 972c609719bSwdenk devices. 9736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz) 974c609719bSwdenk 975c609719bSwdenk- NETWORK Support (PCI): 976682011ffSwdenk CONFIG_E1000 977ce5207e1SKyle Moffett Support for Intel 8254x/8257x gigabit chips. 978ce5207e1SKyle Moffett 979ce5207e1SKyle Moffett CONFIG_E1000_SPI 980ce5207e1SKyle Moffett Utility code for direct access to the SPI bus on Intel 8257x. 981ce5207e1SKyle Moffett This does not do anything useful unless you set at least one 982ce5207e1SKyle Moffett of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC. 983ce5207e1SKyle Moffett 984ce5207e1SKyle Moffett CONFIG_E1000_SPI_GENERIC 985ce5207e1SKyle Moffett Allow generic access to the SPI bus on the Intel 8257x, for 986ce5207e1SKyle Moffett example with the "sspi" command. 987ce5207e1SKyle Moffett 988ce5207e1SKyle Moffett CONFIG_CMD_E1000 989ce5207e1SKyle Moffett Management command for E1000 devices. When used on devices 990ce5207e1SKyle Moffett with SPI support you can reprogram the EEPROM from U-Boot. 991682011ffSwdenk 992ac3315c2SAndre Schwarz CONFIG_E1000_FALLBACK_MAC 99311ccc33fSMarcel Ziswiler default MAC for empty EEPROM after production. 994ac3315c2SAndre Schwarz 995c609719bSwdenk CONFIG_EEPRO100 996c609719bSwdenk Support for Intel 82557/82559/82559ER chips. 99711ccc33fSMarcel Ziswiler Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM 998c609719bSwdenk write routine for first time initialisation. 999c609719bSwdenk 1000c609719bSwdenk CONFIG_TULIP 1001c609719bSwdenk Support for Digital 2114x chips. 1002c609719bSwdenk Optional CONFIG_TULIP_SELECT_MEDIA for board specific 1003c609719bSwdenk modem chip initialisation (KS8761/QS6611). 1004c609719bSwdenk 1005c609719bSwdenk CONFIG_NATSEMI 1006c609719bSwdenk Support for National dp83815 chips. 1007c609719bSwdenk 1008c609719bSwdenk CONFIG_NS8382X 1009c609719bSwdenk Support for National dp8382[01] gigabit chips. 1010c609719bSwdenk 101145219c46Swdenk- NETWORK Support (other): 101245219c46Swdenk 1013c041e9d2SJens Scharsig CONFIG_DRIVER_AT91EMAC 1014c041e9d2SJens Scharsig Support for AT91RM9200 EMAC. 1015c041e9d2SJens Scharsig 1016c041e9d2SJens Scharsig CONFIG_RMII 1017c041e9d2SJens Scharsig Define this to use reduced MII inteface 1018c041e9d2SJens Scharsig 1019c041e9d2SJens Scharsig CONFIG_DRIVER_AT91EMAC_QUIET 1020c041e9d2SJens Scharsig If this defined, the driver is quiet. 1021c041e9d2SJens Scharsig The driver doen't show link status messages. 1022c041e9d2SJens Scharsig 102345219c46Swdenk CONFIG_DRIVER_LAN91C96 102445219c46Swdenk Support for SMSC's LAN91C96 chips. 102545219c46Swdenk 102645219c46Swdenk CONFIG_LAN91C96_BASE 102745219c46Swdenk Define this to hold the physical address 102845219c46Swdenk of the LAN91C96's I/O space 102945219c46Swdenk 103045219c46Swdenk CONFIG_LAN91C96_USE_32_BIT 103145219c46Swdenk Define this to enable 32 bit addressing 103245219c46Swdenk 1033f39748aeSwdenk CONFIG_DRIVER_SMC91111 1034f39748aeSwdenk Support for SMSC's LAN91C111 chip 1035f39748aeSwdenk 1036f39748aeSwdenk CONFIG_SMC91111_BASE 1037f39748aeSwdenk Define this to hold the physical address 1038f39748aeSwdenk of the device (I/O space) 1039f39748aeSwdenk 1040f39748aeSwdenk CONFIG_SMC_USE_32_BIT 1041f39748aeSwdenk Define this if data bus is 32 bits 1042f39748aeSwdenk 1043f39748aeSwdenk CONFIG_SMC_USE_IOFUNCS 1044f39748aeSwdenk Define this to use i/o functions instead of macros 1045f39748aeSwdenk (some hardware wont work with macros) 1046f39748aeSwdenk 1047dc02badaSHeiko Schocher CONFIG_DRIVER_TI_EMAC 1048dc02badaSHeiko Schocher Support for davinci emac 1049dc02badaSHeiko Schocher 1050dc02badaSHeiko Schocher CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT 1051dc02badaSHeiko Schocher Define this if you have more then 3 PHYs. 1052dc02badaSHeiko Schocher 1053b3dbf4a5SMacpaul Lin CONFIG_FTGMAC100 1054b3dbf4a5SMacpaul Lin Support for Faraday's FTGMAC100 Gigabit SoC Ethernet 1055b3dbf4a5SMacpaul Lin 1056b3dbf4a5SMacpaul Lin CONFIG_FTGMAC100_EGIGA 1057b3dbf4a5SMacpaul Lin Define this to use GE link update with gigabit PHY. 1058b3dbf4a5SMacpaul Lin Define this if FTGMAC100 is connected to gigabit PHY. 1059b3dbf4a5SMacpaul Lin If your system has 10/100 PHY only, it might not occur 1060b3dbf4a5SMacpaul Lin wrong behavior. Because PHY usually return timeout or 1061b3dbf4a5SMacpaul Lin useless data when polling gigabit status and gigabit 1062b3dbf4a5SMacpaul Lin control registers. This behavior won't affect the 1063b3dbf4a5SMacpaul Lin correctnessof 10/100 link speed update. 1064b3dbf4a5SMacpaul Lin 1065c2fff331SMike Rapoport CONFIG_SMC911X 1066557b377dSJens Gehrlein Support for SMSC's LAN911x and LAN921x chips 1067557b377dSJens Gehrlein 1068c2fff331SMike Rapoport CONFIG_SMC911X_BASE 1069557b377dSJens Gehrlein Define this to hold the physical address 1070557b377dSJens Gehrlein of the device (I/O space) 1071557b377dSJens Gehrlein 1072c2fff331SMike Rapoport CONFIG_SMC911X_32_BIT 1073557b377dSJens Gehrlein Define this if data bus is 32 bits 1074557b377dSJens Gehrlein 1075c2fff331SMike Rapoport CONFIG_SMC911X_16_BIT 1076557b377dSJens Gehrlein Define this if data bus is 16 bits. If your processor 1077557b377dSJens Gehrlein automatically converts one 32 bit word to two 16 bit 1078c2fff331SMike Rapoport words you may also try CONFIG_SMC911X_32_BIT. 1079557b377dSJens Gehrlein 10803d0075faSYoshihiro Shimoda CONFIG_SH_ETHER 10813d0075faSYoshihiro Shimoda Support for Renesas on-chip Ethernet controller 10823d0075faSYoshihiro Shimoda 10833d0075faSYoshihiro Shimoda CONFIG_SH_ETHER_USE_PORT 10843d0075faSYoshihiro Shimoda Define the number of ports to be used 10853d0075faSYoshihiro Shimoda 10863d0075faSYoshihiro Shimoda CONFIG_SH_ETHER_PHY_ADDR 10873d0075faSYoshihiro Shimoda Define the ETH PHY's address 10883d0075faSYoshihiro Shimoda 108968260aabSYoshihiro Shimoda CONFIG_SH_ETHER_CACHE_WRITEBACK 109068260aabSYoshihiro Shimoda If this option is set, the driver enables cache flush. 109168260aabSYoshihiro Shimoda 10925e124724SVadim Bendebury- TPM Support: 10935e124724SVadim Bendebury CONFIG_GENERIC_LPC_TPM 10945e124724SVadim Bendebury Support for generic parallel port TPM devices. Only one device 10955e124724SVadim Bendebury per system is supported at this time. 10965e124724SVadim Bendebury 10975e124724SVadim Bendebury CONFIG_TPM_TIS_BASE_ADDRESS 10985e124724SVadim Bendebury Base address where the generic TPM device is mapped 10995e124724SVadim Bendebury to. Contemporary x86 systems usually map it at 11005e124724SVadim Bendebury 0xfed40000. 11015e124724SVadim Bendebury 1102c609719bSwdenk- USB Support: 1103c609719bSwdenk At the moment only the UHCI host controller is 11044d13cbadSwdenk supported (PIP405, MIP405, MPC5200); define 1105c609719bSwdenk CONFIG_USB_UHCI to enable it. 1106c609719bSwdenk define CONFIG_USB_KEYBOARD to enable the USB Keyboard 110730d56faeSwdenk and define CONFIG_USB_STORAGE to enable the USB 1108c609719bSwdenk storage devices. 1109c609719bSwdenk Note: 1110c609719bSwdenk Supported are USB Keyboards and USB Floppy drives 1111c609719bSwdenk (TEAC FD-05PUB). 11124d13cbadSwdenk MPC5200 USB requires additional defines: 11134d13cbadSwdenk CONFIG_USB_CLOCK 11144d13cbadSwdenk for 528 MHz Clock: 0x0001bbbb 1115307ecb6dSEric Millbrandt CONFIG_PSC3_USB 1116307ecb6dSEric Millbrandt for USB on PSC3 11174d13cbadSwdenk CONFIG_USB_CONFIG 11184d13cbadSwdenk for differential drivers: 0x00001000 11194d13cbadSwdenk for single ended drivers: 0x00005000 1120307ecb6dSEric Millbrandt for differential drivers on PSC3: 0x00000100 1121307ecb6dSEric Millbrandt for single ended drivers on PSC3: 0x00004100 11226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_USB_EVENT_POLL 1123fdcfaa1bSZhang Wei May be defined to allow interrupt polling 1124fdcfaa1bSZhang Wei instead of using asynchronous interrupts 11254d13cbadSwdenk 112616c8d5e7SWolfgang Denk- USB Device: 112716c8d5e7SWolfgang Denk Define the below if you wish to use the USB console. 112816c8d5e7SWolfgang Denk Once firmware is rebuilt from a serial console issue the 112916c8d5e7SWolfgang Denk command "setenv stdin usbtty; setenv stdout usbtty" and 113011ccc33fSMarcel Ziswiler attach your USB cable. The Unix command "dmesg" should print 113116c8d5e7SWolfgang Denk it has found a new device. The environment variable usbtty 113216c8d5e7SWolfgang Denk can be set to gserial or cdc_acm to enable your device to 113316c8d5e7SWolfgang Denk appear to a USB host as a Linux gserial device or a 113416c8d5e7SWolfgang Denk Common Device Class Abstract Control Model serial device. 113516c8d5e7SWolfgang Denk If you select usbtty = gserial you should be able to enumerate 113616c8d5e7SWolfgang Denk a Linux host by 113716c8d5e7SWolfgang Denk # modprobe usbserial vendor=0xVendorID product=0xProductID 113816c8d5e7SWolfgang Denk else if using cdc_acm, simply setting the environment 113916c8d5e7SWolfgang Denk variable usbtty to be cdc_acm should suffice. The following 114016c8d5e7SWolfgang Denk might be defined in YourBoardName.h 114116c8d5e7SWolfgang Denk 114216c8d5e7SWolfgang Denk CONFIG_USB_DEVICE 114316c8d5e7SWolfgang Denk Define this to build a UDC device 114416c8d5e7SWolfgang Denk 114516c8d5e7SWolfgang Denk CONFIG_USB_TTY 114616c8d5e7SWolfgang Denk Define this to have a tty type of device available to 114716c8d5e7SWolfgang Denk talk to the UDC device 114816c8d5e7SWolfgang Denk 11496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_CONSOLE_IS_IN_ENV 115016c8d5e7SWolfgang Denk Define this if you want stdin, stdout &/or stderr to 115116c8d5e7SWolfgang Denk be set to usbtty. 115216c8d5e7SWolfgang Denk 115316c8d5e7SWolfgang Denk mpc8xx: 11546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_USB_EXTC_CLK 0xBLAH 115516c8d5e7SWolfgang Denk Derive USB clock from external clock "blah" 11566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_USB_EXTC_CLK 0x02 115716c8d5e7SWolfgang Denk 11586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_USB_BRG_CLK 0xBLAH 115916c8d5e7SWolfgang Denk Derive USB clock from brgclk 11606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_USB_BRG_CLK 0x04 116116c8d5e7SWolfgang Denk 116216c8d5e7SWolfgang Denk If you have a USB-IF assigned VendorID then you may wish to 116316c8d5e7SWolfgang Denk define your own vendor specific values either in BoardName.h 116416c8d5e7SWolfgang Denk or directly in usbd_vendor_info.h. If you don't define 116516c8d5e7SWolfgang Denk CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME, 116616c8d5e7SWolfgang Denk CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot 116716c8d5e7SWolfgang Denk should pretend to be a Linux device to it's target host. 116816c8d5e7SWolfgang Denk 116916c8d5e7SWolfgang Denk CONFIG_USBD_MANUFACTURER 117016c8d5e7SWolfgang Denk Define this string as the name of your company for 117116c8d5e7SWolfgang Denk - CONFIG_USBD_MANUFACTURER "my company" 117216c8d5e7SWolfgang Denk 117316c8d5e7SWolfgang Denk CONFIG_USBD_PRODUCT_NAME 117416c8d5e7SWolfgang Denk Define this string as the name of your product 117516c8d5e7SWolfgang Denk - CONFIG_USBD_PRODUCT_NAME "acme usb device" 117616c8d5e7SWolfgang Denk 117716c8d5e7SWolfgang Denk CONFIG_USBD_VENDORID 117816c8d5e7SWolfgang Denk Define this as your assigned Vendor ID from the USB 117916c8d5e7SWolfgang Denk Implementors Forum. This *must* be a genuine Vendor ID 118016c8d5e7SWolfgang Denk to avoid polluting the USB namespace. 118116c8d5e7SWolfgang Denk - CONFIG_USBD_VENDORID 0xFFFF 118216c8d5e7SWolfgang Denk 118316c8d5e7SWolfgang Denk CONFIG_USBD_PRODUCTID 118416c8d5e7SWolfgang Denk Define this as the unique Product ID 118516c8d5e7SWolfgang Denk for your device 118616c8d5e7SWolfgang Denk - CONFIG_USBD_PRODUCTID 0xFFFF 1187c609719bSwdenk 1188c609719bSwdenk 1189c609719bSwdenk- MMC Support: 1190c609719bSwdenk The MMC controller on the Intel PXA is supported. To 1191c609719bSwdenk enable this define CONFIG_MMC. The MMC can be 1192c609719bSwdenk accessed from the boot prompt by mapping the device 1193c609719bSwdenk to physical memory similar to flash. Command line is 1194602ad3b3SJon Loeliger enabled with CONFIG_CMD_MMC. The MMC driver also works with 1195602ad3b3SJon Loeliger the FAT fs. This is enabled with CONFIG_CMD_FAT. 1196c609719bSwdenk 1197afb35666SYoshihiro Shimoda CONFIG_SH_MMCIF 1198afb35666SYoshihiro Shimoda Support for Renesas on-chip MMCIF controller 1199afb35666SYoshihiro Shimoda 1200afb35666SYoshihiro Shimoda CONFIG_SH_MMCIF_ADDR 1201afb35666SYoshihiro Shimoda Define the base address of MMCIF registers 1202afb35666SYoshihiro Shimoda 1203afb35666SYoshihiro Shimoda CONFIG_SH_MMCIF_CLK 1204afb35666SYoshihiro Shimoda Define the clock frequency for MMCIF 1205afb35666SYoshihiro Shimoda 12066705d81eSwdenk- Journaling Flash filesystem support: 12076705d81eSwdenk CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE, 12086705d81eSwdenk CONFIG_JFFS2_NAND_DEV 12096705d81eSwdenk Define these for a default partition on a NAND device 12106705d81eSwdenk 12116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS2_FIRST_SECTOR, 12126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS 12136705d81eSwdenk Define these for a default partition on a NOR device 12146705d81eSwdenk 12156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS_CUSTOM_PART 12166705d81eSwdenk Define this to create an own partition. You have to provide a 12176705d81eSwdenk function struct part_info* jffs2_part_info(int part_num) 12186705d81eSwdenk 12196705d81eSwdenk If you define only one JFFS2 partition you may also want to 12206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_JFFS_SINGLE_PART 1 12216705d81eSwdenk to disable the command chpart. This is the default when you 12226705d81eSwdenk have not defined a custom partition 12236705d81eSwdenk 1224c30a15e5SDonggeun Kim- FAT(File Allocation Table) filesystem write function support: 1225c30a15e5SDonggeun Kim CONFIG_FAT_WRITE 1226c30a15e5SDonggeun Kim Support for saving memory data as a file 1227c30a15e5SDonggeun Kim in FAT formatted partition 1228c30a15e5SDonggeun Kim 1229c609719bSwdenk- Keyboard Support: 1230c609719bSwdenk CONFIG_ISA_KEYBOARD 1231c609719bSwdenk 1232c609719bSwdenk Define this to enable standard (PC-Style) keyboard 1233c609719bSwdenk support 1234c609719bSwdenk 1235c609719bSwdenk CONFIG_I8042_KBD 1236c609719bSwdenk Standard PC keyboard driver with US (is default) and 1237c609719bSwdenk GERMAN key layout (switch via environment 'keymap=de') support. 1238c609719bSwdenk Export function i8042_kbd_init, i8042_tstc and i8042_getc 1239c609719bSwdenk for cfb_console. Supports cursor blinking. 1240c609719bSwdenk 1241c609719bSwdenk- Video support: 1242c609719bSwdenk CONFIG_VIDEO 1243c609719bSwdenk 1244c609719bSwdenk Define this to enable video support (for output to 1245c609719bSwdenk video). 1246c609719bSwdenk 1247c609719bSwdenk CONFIG_VIDEO_CT69000 1248c609719bSwdenk 1249c609719bSwdenk Enable Chips & Technologies 69000 Video chip 1250c609719bSwdenk 1251c609719bSwdenk CONFIG_VIDEO_SMI_LYNXEM 1252eeb1b77bSwdenk Enable Silicon Motion SMI 712/710/810 Video chip. The 1253eeb1b77bSwdenk video output is selected via environment 'videoout' 1254eeb1b77bSwdenk (1 = LCD and 2 = CRT). If videoout is undefined, CRT is 1255eeb1b77bSwdenk assumed. 1256c609719bSwdenk 1257eeb1b77bSwdenk For the CT69000 and SMI_LYNXEM drivers, videomode is 125811ccc33fSMarcel Ziswiler selected via environment 'videomode'. Two different ways 1259eeb1b77bSwdenk are possible: 1260eeb1b77bSwdenk - "videomode=num" 'num' is a standard LiLo mode numbers. 1261eeb1b77bSwdenk Following standard modes are supported (* is default): 1262eeb1b77bSwdenk 1263eeb1b77bSwdenk Colors 640x480 800x600 1024x768 1152x864 1280x1024 1264eeb1b77bSwdenk -------------+--------------------------------------------- 1265eeb1b77bSwdenk 8 bits | 0x301* 0x303 0x305 0x161 0x307 1266eeb1b77bSwdenk 15 bits | 0x310 0x313 0x316 0x162 0x319 1267eeb1b77bSwdenk 16 bits | 0x311 0x314 0x317 0x163 0x31A 1268eeb1b77bSwdenk 24 bits | 0x312 0x315 0x318 ? 0x31B 1269eeb1b77bSwdenk -------------+--------------------------------------------- 1270c609719bSwdenk (i.e. setenv videomode 317; saveenv; reset;) 1271c609719bSwdenk 1272eeb1b77bSwdenk - "videomode=bootargs" all the video parameters are parsed 12737817cb20SMarcel Ziswiler from the bootargs. (See drivers/video/videomodes.c) 1274eeb1b77bSwdenk 1275eeb1b77bSwdenk 1276a6c7ad2fSwdenk CONFIG_VIDEO_SED13806 1277a6c7ad2fSwdenk Enable Epson SED13806 driver. This driver supports 8bpp 1278a6c7ad2fSwdenk and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP 1279a6c7ad2fSwdenk or CONFIG_VIDEO_SED13806_16BPP 1280a6c7ad2fSwdenk 12817d3053fbSTimur Tabi CONFIG_FSL_DIU_FB 12827d3053fbSTimur Tabi Enable the Freescale DIU video driver. Reference boards for 12837d3053fbSTimur Tabi SOCs that have a DIU should define this macro to enable DIU 12847d3053fbSTimur Tabi support, and should also define these other macros: 12857d3053fbSTimur Tabi 12867d3053fbSTimur Tabi CONFIG_SYS_DIU_ADDR 12877d3053fbSTimur Tabi CONFIG_VIDEO 12887d3053fbSTimur Tabi CONFIG_CMD_BMP 12897d3053fbSTimur Tabi CONFIG_CFB_CONSOLE 12907d3053fbSTimur Tabi CONFIG_VIDEO_SW_CURSOR 12917d3053fbSTimur Tabi CONFIG_VGA_AS_SINGLE_DEVICE 12927d3053fbSTimur Tabi CONFIG_VIDEO_LOGO 12937d3053fbSTimur Tabi CONFIG_VIDEO_BMP_LOGO 12947d3053fbSTimur Tabi 1295ba8e76bdSTimur Tabi The DIU driver will look for the 'video-mode' environment 1296ba8e76bdSTimur Tabi variable, and if defined, enable the DIU as a console during 1297ba8e76bdSTimur Tabi boot. See the documentation file README.video for a 1298ba8e76bdSTimur Tabi description of this variable. 12997d3053fbSTimur Tabi 1300682011ffSwdenk- Keyboard Support: 1301682011ffSwdenk CONFIG_KEYBOARD 1302682011ffSwdenk 1303682011ffSwdenk Define this to enable a custom keyboard support. 1304682011ffSwdenk This simply calls drv_keyboard_init() which must be 1305682011ffSwdenk defined in your board-specific files. 1306682011ffSwdenk The only board using this so far is RBC823. 1307a6c7ad2fSwdenk 1308c609719bSwdenk- LCD Support: CONFIG_LCD 1309c609719bSwdenk 1310c609719bSwdenk Define this to enable LCD support (for output to LCD 1311c609719bSwdenk display); also select one of the supported displays 1312c609719bSwdenk by defining one of these: 1313c609719bSwdenk 131439cf4804SStelian Pop CONFIG_ATMEL_LCD: 131539cf4804SStelian Pop 131639cf4804SStelian Pop HITACHI TX09D70VM1CCA, 3.5", 240x320. 131739cf4804SStelian Pop 1318fd3103bbSwdenk CONFIG_NEC_NL6448AC33: 1319c609719bSwdenk 1320fd3103bbSwdenk NEC NL6448AC33-18. Active, color, single scan. 1321c609719bSwdenk 1322fd3103bbSwdenk CONFIG_NEC_NL6448BC20 1323c609719bSwdenk 1324fd3103bbSwdenk NEC NL6448BC20-08. 6.5", 640x480. 1325fd3103bbSwdenk Active, color, single scan. 1326fd3103bbSwdenk 1327fd3103bbSwdenk CONFIG_NEC_NL6448BC33_54 1328fd3103bbSwdenk 1329fd3103bbSwdenk NEC NL6448BC33-54. 10.4", 640x480. 1330c609719bSwdenk Active, color, single scan. 1331c609719bSwdenk 1332c609719bSwdenk CONFIG_SHARP_16x9 1333c609719bSwdenk 1334c609719bSwdenk Sharp 320x240. Active, color, single scan. 1335c609719bSwdenk It isn't 16x9, and I am not sure what it is. 1336c609719bSwdenk 1337c609719bSwdenk CONFIG_SHARP_LQ64D341 1338c609719bSwdenk 1339c609719bSwdenk Sharp LQ64D341 display, 640x480. 1340c609719bSwdenk Active, color, single scan. 1341c609719bSwdenk 1342c609719bSwdenk CONFIG_HLD1045 1343c609719bSwdenk 1344c609719bSwdenk HLD1045 display, 640x480. 1345c609719bSwdenk Active, color, single scan. 1346c609719bSwdenk 1347c609719bSwdenk CONFIG_OPTREX_BW 1348c609719bSwdenk 1349c609719bSwdenk Optrex CBL50840-2 NF-FW 99 22 M5 1350c609719bSwdenk or 1351c609719bSwdenk Hitachi LMG6912RPFC-00T 1352c609719bSwdenk or 1353c609719bSwdenk Hitachi SP14Q002 1354c609719bSwdenk 1355c609719bSwdenk 320x240. Black & white. 1356c609719bSwdenk 1357c609719bSwdenk Normally display is black on white background; define 13586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_WHITE_ON_BLACK to get it inverted. 1359c609719bSwdenk 13607152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN 1361d791b1dcSwdenk 1362d791b1dcSwdenk If this option is set, the environment is checked for 1363d791b1dcSwdenk a variable "splashimage". If found, the usual display 1364d791b1dcSwdenk of logo, copyright and system information on the LCD 1365e94d2cd9Swdenk is suppressed and the BMP image at the address 1366d791b1dcSwdenk specified in "splashimage" is loaded instead. The 1367d791b1dcSwdenk console is redirected to the "nulldev", too. This 1368d791b1dcSwdenk allows for a "silent" boot where a splash screen is 1369d791b1dcSwdenk loaded very quickly after power-on. 1370d791b1dcSwdenk 13711ca298ceSMatthias Weisser CONFIG_SPLASH_SCREEN_ALIGN 13721ca298ceSMatthias Weisser 13731ca298ceSMatthias Weisser If this option is set the splash image can be freely positioned 13741ca298ceSMatthias Weisser on the screen. Environment variable "splashpos" specifies the 13751ca298ceSMatthias Weisser position as "x,y". If a positive number is given it is used as 13761ca298ceSMatthias Weisser number of pixel from left/top. If a negative number is given it 13771ca298ceSMatthias Weisser is used as number of pixel from right/bottom. You can also 13781ca298ceSMatthias Weisser specify 'm' for centering the image. 13791ca298ceSMatthias Weisser 13801ca298ceSMatthias Weisser Example: 13811ca298ceSMatthias Weisser setenv splashpos m,m 13821ca298ceSMatthias Weisser => image at center of screen 13831ca298ceSMatthias Weisser 13841ca298ceSMatthias Weisser setenv splashpos 30,20 13851ca298ceSMatthias Weisser => image at x = 30 and y = 20 13861ca298ceSMatthias Weisser 13871ca298ceSMatthias Weisser setenv splashpos -10,m 13881ca298ceSMatthias Weisser => vertically centered image 13891ca298ceSMatthias Weisser at x = dspWidth - bmpWidth - 9 13901ca298ceSMatthias Weisser 139198f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP 139298f4a3dfSStefan Roese 139398f4a3dfSStefan Roese If this option is set, additionally to standard BMP 139498f4a3dfSStefan Roese images, gzipped BMP images can be displayed via the 139598f4a3dfSStefan Roese splashscreen support or the bmp command. 139698f4a3dfSStefan Roese 1397d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8 1398d5011762SAnatolij Gustschin 1399d5011762SAnatolij Gustschin If this option is set, 8-bit RLE compressed BMP images 1400d5011762SAnatolij Gustschin can be displayed via the splashscreen support or the 1401d5011762SAnatolij Gustschin bmp command. 1402d5011762SAnatolij Gustschin 1403c29fdfc1Swdenk- Compression support: 1404c29fdfc1Swdenk CONFIG_BZIP2 1405c29fdfc1Swdenk 1406c29fdfc1Swdenk If this option is set, support for bzip2 compressed 1407c29fdfc1Swdenk images is included. If not, only uncompressed and gzip 1408c29fdfc1Swdenk compressed images are supported. 1409c29fdfc1Swdenk 1410c29fdfc1Swdenk NOTE: the bzip2 algorithm requires a lot of RAM, so 14116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should 1412c29fdfc1Swdenk be at least 4MB. 1413d791b1dcSwdenk 1414fc9c1727SLuigi 'Comio' Mantellini CONFIG_LZMA 1415fc9c1727SLuigi 'Comio' Mantellini 1416fc9c1727SLuigi 'Comio' Mantellini If this option is set, support for lzma compressed 1417fc9c1727SLuigi 'Comio' Mantellini images is included. 1418fc9c1727SLuigi 'Comio' Mantellini 1419fc9c1727SLuigi 'Comio' Mantellini Note: The LZMA algorithm adds between 2 and 4KB of code and it 1420fc9c1727SLuigi 'Comio' Mantellini requires an amount of dynamic memory that is given by the 1421fc9c1727SLuigi 'Comio' Mantellini formula: 1422fc9c1727SLuigi 'Comio' Mantellini 1423fc9c1727SLuigi 'Comio' Mantellini (1846 + 768 << (lc + lp)) * sizeof(uint16) 1424fc9c1727SLuigi 'Comio' Mantellini 1425fc9c1727SLuigi 'Comio' Mantellini Where lc and lp stand for, respectively, Literal context bits 1426fc9c1727SLuigi 'Comio' Mantellini and Literal pos bits. 1427fc9c1727SLuigi 'Comio' Mantellini 1428fc9c1727SLuigi 'Comio' Mantellini This value is upper-bounded by 14MB in the worst case. Anyway, 1429fc9c1727SLuigi 'Comio' Mantellini for a ~4MB large kernel image, we have lc=3 and lp=0 for a 1430fc9c1727SLuigi 'Comio' Mantellini total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is 1431fc9c1727SLuigi 'Comio' Mantellini a very small buffer. 1432fc9c1727SLuigi 'Comio' Mantellini 1433fc9c1727SLuigi 'Comio' Mantellini Use the lzmainfo tool to determinate the lc and lp values and 1434fc9c1727SLuigi 'Comio' Mantellini then calculate the amount of needed dynamic memory (ensuring 14356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD the appropriate CONFIG_SYS_MALLOC_LEN value). 1436fc9c1727SLuigi 'Comio' Mantellini 143717ea1177Swdenk- MII/PHY support: 143817ea1177Swdenk CONFIG_PHY_ADDR 143917ea1177Swdenk 144017ea1177Swdenk The address of PHY on MII bus. 144117ea1177Swdenk 144217ea1177Swdenk CONFIG_PHY_CLOCK_FREQ (ppc4xx) 144317ea1177Swdenk 144417ea1177Swdenk The clock frequency of the MII bus 144517ea1177Swdenk 144617ea1177Swdenk CONFIG_PHY_GIGE 144717ea1177Swdenk 144817ea1177Swdenk If this option is set, support for speed/duplex 144911ccc33fSMarcel Ziswiler detection of gigabit PHY is included. 145017ea1177Swdenk 145117ea1177Swdenk CONFIG_PHY_RESET_DELAY 145217ea1177Swdenk 145317ea1177Swdenk Some PHY like Intel LXT971A need extra delay after 145417ea1177Swdenk reset before any MII register access is possible. 145517ea1177Swdenk For such PHY, set this option to the usec delay 145617ea1177Swdenk required. (minimum 300usec for LXT971A) 145717ea1177Swdenk 145817ea1177Swdenk CONFIG_PHY_CMD_DELAY (ppc4xx) 145917ea1177Swdenk 146017ea1177Swdenk Some PHY like Intel LXT971A need extra delay after 146117ea1177Swdenk command issued before MII status register can be read 146217ea1177Swdenk 1463c609719bSwdenk- Ethernet address: 1464c609719bSwdenk CONFIG_ETHADDR 1465c68a05feSrichardretanubun CONFIG_ETH1ADDR 1466c609719bSwdenk CONFIG_ETH2ADDR 1467c609719bSwdenk CONFIG_ETH3ADDR 1468c68a05feSrichardretanubun CONFIG_ETH4ADDR 1469c68a05feSrichardretanubun CONFIG_ETH5ADDR 1470c609719bSwdenk 147111ccc33fSMarcel Ziswiler Define a default value for Ethernet address to use 147211ccc33fSMarcel Ziswiler for the respective Ethernet interface, in case this 1473c609719bSwdenk is not determined automatically. 1474c609719bSwdenk 1475c609719bSwdenk- IP address: 1476c609719bSwdenk CONFIG_IPADDR 1477c609719bSwdenk 1478c609719bSwdenk Define a default value for the IP address to use for 147911ccc33fSMarcel Ziswiler the default Ethernet interface, in case this is not 1480c609719bSwdenk determined through e.g. bootp. 14811ebcd654SWolfgang Denk (Environment variable "ipaddr") 1482c609719bSwdenk 1483c609719bSwdenk- Server IP address: 1484c609719bSwdenk CONFIG_SERVERIP 1485c609719bSwdenk 1486c609719bSwdenk Defines a default value for the IP address of a TFTP 1487c609719bSwdenk server to contact when using the "tftboot" command. 14881ebcd654SWolfgang Denk (Environment variable "serverip") 1489c609719bSwdenk 149097cfe861SRobin Getz CONFIG_KEEP_SERVERADDR 149197cfe861SRobin Getz 149297cfe861SRobin Getz Keeps the server's MAC address, in the env 'serveraddr' 149397cfe861SRobin Getz for passing to bootargs (like Linux's netconsole option) 149497cfe861SRobin Getz 14951ebcd654SWolfgang Denk- Gateway IP address: 14961ebcd654SWolfgang Denk CONFIG_GATEWAYIP 14971ebcd654SWolfgang Denk 14981ebcd654SWolfgang Denk Defines a default value for the IP address of the 14991ebcd654SWolfgang Denk default router where packets to other networks are 15001ebcd654SWolfgang Denk sent to. 15011ebcd654SWolfgang Denk (Environment variable "gatewayip") 15021ebcd654SWolfgang Denk 15031ebcd654SWolfgang Denk- Subnet mask: 15041ebcd654SWolfgang Denk CONFIG_NETMASK 15051ebcd654SWolfgang Denk 15061ebcd654SWolfgang Denk Defines a default value for the subnet mask (or 15071ebcd654SWolfgang Denk routing prefix) which is used to determine if an IP 15081ebcd654SWolfgang Denk address belongs to the local subnet or needs to be 15091ebcd654SWolfgang Denk forwarded through a router. 15101ebcd654SWolfgang Denk (Environment variable "netmask") 15111ebcd654SWolfgang Denk 151253a5c424SDavid Updegraff- Multicast TFTP Mode: 151353a5c424SDavid Updegraff CONFIG_MCAST_TFTP 151453a5c424SDavid Updegraff 151553a5c424SDavid Updegraff Defines whether you want to support multicast TFTP as per 151653a5c424SDavid Updegraff rfc-2090; for example to work with atftp. Lets lots of targets 151711ccc33fSMarcel Ziswiler tftp down the same boot image concurrently. Note: the Ethernet 151853a5c424SDavid Updegraff driver in use must provide a function: mcast() to join/leave a 151953a5c424SDavid Updegraff multicast group. 152053a5c424SDavid Updegraff 1521c609719bSwdenk- BOOTP Recovery Mode: 1522c609719bSwdenk CONFIG_BOOTP_RANDOM_DELAY 1523c609719bSwdenk 1524c609719bSwdenk If you have many targets in a network that try to 1525c609719bSwdenk boot using BOOTP, you may want to avoid that all 1526c609719bSwdenk systems send out BOOTP requests at precisely the same 1527c609719bSwdenk moment (which would happen for instance at recovery 1528c609719bSwdenk from a power failure, when all systems will try to 1529c609719bSwdenk boot, thus flooding the BOOTP server. Defining 1530c609719bSwdenk CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be 1531c609719bSwdenk inserted before sending out BOOTP requests. The 15326c33c785SWolfgang Denk following delays are inserted then: 1533c609719bSwdenk 1534c609719bSwdenk 1st BOOTP request: delay 0 ... 1 sec 1535c609719bSwdenk 2nd BOOTP request: delay 0 ... 2 sec 1536c609719bSwdenk 3rd BOOTP request: delay 0 ... 4 sec 1537c609719bSwdenk 4th and following 1538c609719bSwdenk BOOTP requests: delay 0 ... 8 sec 1539c609719bSwdenk 1540fe389a82Sstroese- DHCP Advanced Options: 15411fe80d79SJon Loeliger You can fine tune the DHCP functionality by defining 15421fe80d79SJon Loeliger CONFIG_BOOTP_* symbols: 1543fe389a82Sstroese 15441fe80d79SJon Loeliger CONFIG_BOOTP_SUBNETMASK 15451fe80d79SJon Loeliger CONFIG_BOOTP_GATEWAY 15461fe80d79SJon Loeliger CONFIG_BOOTP_HOSTNAME 15471fe80d79SJon Loeliger CONFIG_BOOTP_NISDOMAIN 15481fe80d79SJon Loeliger CONFIG_BOOTP_BOOTPATH 15491fe80d79SJon Loeliger CONFIG_BOOTP_BOOTFILESIZE 15501fe80d79SJon Loeliger CONFIG_BOOTP_DNS 15511fe80d79SJon Loeliger CONFIG_BOOTP_DNS2 15521fe80d79SJon Loeliger CONFIG_BOOTP_SEND_HOSTNAME 15531fe80d79SJon Loeliger CONFIG_BOOTP_NTPSERVER 15541fe80d79SJon Loeliger CONFIG_BOOTP_TIMEOFFSET 15551fe80d79SJon Loeliger CONFIG_BOOTP_VENDOREX 1556fe389a82Sstroese 15575d110f0aSWilson Callan CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip 15585d110f0aSWilson Callan environment variable, not the BOOTP server. 1559fe389a82Sstroese 1560fe389a82Sstroese CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS 1561fe389a82Sstroese serverip from a DHCP server, it is possible that more 1562fe389a82Sstroese than one DNS serverip is offered to the client. 1563fe389a82Sstroese If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS 1564fe389a82Sstroese serverip will be stored in the additional environment 1565fe389a82Sstroese variable "dnsip2". The first DNS serverip is always 1566fe389a82Sstroese stored in the variable "dnsip", when CONFIG_BOOTP_DNS 15671fe80d79SJon Loeliger is defined. 1568fe389a82Sstroese 1569fe389a82Sstroese CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable 1570fe389a82Sstroese to do a dynamic update of a DNS server. To do this, they 1571fe389a82Sstroese need the hostname of the DHCP requester. 15725d110f0aSWilson Callan If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content 15731fe80d79SJon Loeliger of the "hostname" environment variable is passed as 15741fe80d79SJon Loeliger option 12 to the DHCP server. 1575fe389a82Sstroese 1576d9a2f416SAras Vaichas CONFIG_BOOTP_DHCP_REQUEST_DELAY 1577d9a2f416SAras Vaichas 1578d9a2f416SAras Vaichas A 32bit value in microseconds for a delay between 1579d9a2f416SAras Vaichas receiving a "DHCP Offer" and sending the "DHCP Request". 1580d9a2f416SAras Vaichas This fixes a problem with certain DHCP servers that don't 1581d9a2f416SAras Vaichas respond 100% of the time to a "DHCP request". E.g. On an 1582d9a2f416SAras Vaichas AT91RM9200 processor running at 180MHz, this delay needed 1583d9a2f416SAras Vaichas to be *at least* 15,000 usec before a Windows Server 2003 1584d9a2f416SAras Vaichas DHCP server would reply 100% of the time. I recommend at 1585d9a2f416SAras Vaichas least 50,000 usec to be safe. The alternative is to hope 1586d9a2f416SAras Vaichas that one of the retries will be successful but note that 1587d9a2f416SAras Vaichas the DHCP timeout and retry process takes a longer than 1588d9a2f416SAras Vaichas this delay. 1589d9a2f416SAras Vaichas 1590a3d991bdSwdenk - CDP Options: 1591a3d991bdSwdenk CONFIG_CDP_DEVICE_ID 1592a3d991bdSwdenk 1593a3d991bdSwdenk The device id used in CDP trigger frames. 1594a3d991bdSwdenk 1595a3d991bdSwdenk CONFIG_CDP_DEVICE_ID_PREFIX 1596a3d991bdSwdenk 1597a3d991bdSwdenk A two character string which is prefixed to the MAC address 1598a3d991bdSwdenk of the device. 1599a3d991bdSwdenk 1600a3d991bdSwdenk CONFIG_CDP_PORT_ID 1601a3d991bdSwdenk 1602a3d991bdSwdenk A printf format string which contains the ascii name of 1603a3d991bdSwdenk the port. Normally is set to "eth%d" which sets 160411ccc33fSMarcel Ziswiler eth0 for the first Ethernet, eth1 for the second etc. 1605a3d991bdSwdenk 1606a3d991bdSwdenk CONFIG_CDP_CAPABILITIES 1607a3d991bdSwdenk 1608a3d991bdSwdenk A 32bit integer which indicates the device capabilities; 1609a3d991bdSwdenk 0x00000010 for a normal host which does not forwards. 1610a3d991bdSwdenk 1611a3d991bdSwdenk CONFIG_CDP_VERSION 1612a3d991bdSwdenk 1613a3d991bdSwdenk An ascii string containing the version of the software. 1614a3d991bdSwdenk 1615a3d991bdSwdenk CONFIG_CDP_PLATFORM 1616a3d991bdSwdenk 1617a3d991bdSwdenk An ascii string containing the name of the platform. 1618a3d991bdSwdenk 1619a3d991bdSwdenk CONFIG_CDP_TRIGGER 1620a3d991bdSwdenk 1621a3d991bdSwdenk A 32bit integer sent on the trigger. 1622a3d991bdSwdenk 1623a3d991bdSwdenk CONFIG_CDP_POWER_CONSUMPTION 1624a3d991bdSwdenk 1625a3d991bdSwdenk A 16bit integer containing the power consumption of the 1626a3d991bdSwdenk device in .1 of milliwatts. 1627a3d991bdSwdenk 1628a3d991bdSwdenk CONFIG_CDP_APPLIANCE_VLAN_TYPE 1629a3d991bdSwdenk 1630a3d991bdSwdenk A byte containing the id of the VLAN. 1631a3d991bdSwdenk 1632c609719bSwdenk- Status LED: CONFIG_STATUS_LED 1633c609719bSwdenk 1634c609719bSwdenk Several configurations allow to display the current 1635c609719bSwdenk status using a LED. For instance, the LED will blink 1636c609719bSwdenk fast while running U-Boot code, stop blinking as 1637c609719bSwdenk soon as a reply to a BOOTP request was received, and 1638c609719bSwdenk start blinking slow once the Linux kernel is running 1639c609719bSwdenk (supported by a status LED driver in the Linux 1640c609719bSwdenk kernel). Defining CONFIG_STATUS_LED enables this 1641c609719bSwdenk feature in U-Boot. 1642c609719bSwdenk 1643c609719bSwdenk- CAN Support: CONFIG_CAN_DRIVER 1644c609719bSwdenk 1645c609719bSwdenk Defining CONFIG_CAN_DRIVER enables CAN driver support 1646c609719bSwdenk on those systems that support this (optional) 1647c609719bSwdenk feature, like the TQM8xxL modules. 1648c609719bSwdenk 1649c609719bSwdenk- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C 1650c609719bSwdenk 1651b37c7e5eSwdenk These enable I2C serial bus commands. Defining either of 1652b37c7e5eSwdenk (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will 165311ccc33fSMarcel Ziswiler include the appropriate I2C driver for the selected CPU. 1654c609719bSwdenk 1655b37c7e5eSwdenk This will allow you to use i2c commands at the u-boot 1656602ad3b3SJon Loeliger command line (as long as you set CONFIG_CMD_I2C in 1657b37c7e5eSwdenk CONFIG_COMMANDS) and communicate with i2c based realtime 1658b37c7e5eSwdenk clock chips. See common/cmd_i2c.c for a description of the 1659c609719bSwdenk command line interface. 1660c609719bSwdenk 1661bb99ad6dSBen Warren CONFIG_HARD_I2C selects a hardware I2C controller. 1662c609719bSwdenk 1663b37c7e5eSwdenk CONFIG_SOFT_I2C configures u-boot to use a software (aka 1664b37c7e5eSwdenk bit-banging) driver instead of CPM or similar hardware 1665b37c7e5eSwdenk support for I2C. 1666c609719bSwdenk 1667b37c7e5eSwdenk There are several other quantities that must also be 1668b37c7e5eSwdenk defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C. 1669c609719bSwdenk 16706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD In both cases you will need to define CONFIG_SYS_I2C_SPEED 1671b37c7e5eSwdenk to be the frequency (in Hz) at which you wish your i2c bus 16726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie 167311ccc33fSMarcel Ziswiler the CPU's i2c node address). 1674c609719bSwdenk 16758d321b81SPeter Tyser Now, the u-boot i2c code for the mpc8xx 1676a47a12beSStefan Roese (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node 16778d321b81SPeter Tyser and so its address should therefore be cleared to 0 (See, 16788d321b81SPeter Tyser eg, MPC823e User's Manual p.16-473). So, set 16798d321b81SPeter Tyser CONFIG_SYS_I2C_SLAVE to 0. 1680b37c7e5eSwdenk 16815da71efaSEric Millbrandt CONFIG_SYS_I2C_INIT_MPC5XXX 16825da71efaSEric Millbrandt 16835da71efaSEric Millbrandt When a board is reset during an i2c bus transfer 16845da71efaSEric Millbrandt chips might think that the current transfer is still 16855da71efaSEric Millbrandt in progress. Reset the slave devices by sending start 16865da71efaSEric Millbrandt commands until the slave device responds. 16875da71efaSEric Millbrandt 1688b37c7e5eSwdenk That's all that's required for CONFIG_HARD_I2C. 1689b37c7e5eSwdenk 1690b37c7e5eSwdenk If you use the software i2c interface (CONFIG_SOFT_I2C) 1691b37c7e5eSwdenk then the following macros need to be defined (examples are 1692b37c7e5eSwdenk from include/configs/lwmon.h): 1693c609719bSwdenk 1694c609719bSwdenk I2C_INIT 1695c609719bSwdenk 1696b37c7e5eSwdenk (Optional). Any commands necessary to enable the I2C 1697c609719bSwdenk controller or configure ports. 1698c609719bSwdenk 1699b37c7e5eSwdenk eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL) 1700b37c7e5eSwdenk 1701c609719bSwdenk I2C_PORT 1702c609719bSwdenk 1703c609719bSwdenk (Only for MPC8260 CPU). The I/O port to use (the code 1704c609719bSwdenk assumes both bits are on the same port). Valid values 1705c609719bSwdenk are 0..3 for ports A..D. 1706c609719bSwdenk 1707c609719bSwdenk I2C_ACTIVE 1708c609719bSwdenk 1709c609719bSwdenk The code necessary to make the I2C data line active 1710c609719bSwdenk (driven). If the data line is open collector, this 1711c609719bSwdenk define can be null. 1712c609719bSwdenk 1713b37c7e5eSwdenk eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA) 1714b37c7e5eSwdenk 1715c609719bSwdenk I2C_TRISTATE 1716c609719bSwdenk 1717c609719bSwdenk The code necessary to make the I2C data line tri-stated 1718c609719bSwdenk (inactive). If the data line is open collector, this 1719c609719bSwdenk define can be null. 1720c609719bSwdenk 1721b37c7e5eSwdenk eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA) 1722b37c7e5eSwdenk 1723c609719bSwdenk I2C_READ 1724c609719bSwdenk 1725c609719bSwdenk Code that returns TRUE if the I2C data line is high, 1726c609719bSwdenk FALSE if it is low. 1727c609719bSwdenk 1728b37c7e5eSwdenk eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0) 1729b37c7e5eSwdenk 1730c609719bSwdenk I2C_SDA(bit) 1731c609719bSwdenk 1732c609719bSwdenk If <bit> is TRUE, sets the I2C data line high. If it 1733c609719bSwdenk is FALSE, it clears it (low). 1734c609719bSwdenk 1735b37c7e5eSwdenk eg: #define I2C_SDA(bit) \ 1736b37c7e5eSwdenk if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \ 1737b37c7e5eSwdenk else immr->im_cpm.cp_pbdat &= ~PB_SDA 1738b37c7e5eSwdenk 1739c609719bSwdenk I2C_SCL(bit) 1740c609719bSwdenk 1741c609719bSwdenk If <bit> is TRUE, sets the I2C clock line high. If it 1742c609719bSwdenk is FALSE, it clears it (low). 1743c609719bSwdenk 1744b37c7e5eSwdenk eg: #define I2C_SCL(bit) \ 1745b37c7e5eSwdenk if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \ 1746b37c7e5eSwdenk else immr->im_cpm.cp_pbdat &= ~PB_SCL 1747b37c7e5eSwdenk 1748c609719bSwdenk I2C_DELAY 1749c609719bSwdenk 1750c609719bSwdenk This delay is invoked four times per clock cycle so this 1751c609719bSwdenk controls the rate of data transfer. The data rate thus 1752b37c7e5eSwdenk is 1 / (I2C_DELAY * 4). Often defined to be something 1753b37c7e5eSwdenk like: 1754b37c7e5eSwdenk 1755b37c7e5eSwdenk #define I2C_DELAY udelay(2) 1756c609719bSwdenk 1757793b5726SMike Frysinger CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA 1758793b5726SMike Frysinger 1759793b5726SMike Frysinger If your arch supports the generic GPIO framework (asm/gpio.h), 1760793b5726SMike Frysinger then you may alternatively define the two GPIOs that are to be 1761793b5726SMike Frysinger used as SCL / SDA. Any of the previous I2C_xxx macros will 1762793b5726SMike Frysinger have GPIO-based defaults assigned to them as appropriate. 1763793b5726SMike Frysinger 1764793b5726SMike Frysinger You should define these to the GPIO value as given directly to 1765793b5726SMike Frysinger the generic GPIO functions. 1766793b5726SMike Frysinger 17676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_INIT_BOARD 176847cd00faSwdenk 176947cd00faSwdenk When a board is reset during an i2c bus transfer 177047cd00faSwdenk chips might think that the current transfer is still 177147cd00faSwdenk in progress. On some boards it is possible to access 177247cd00faSwdenk the i2c SCLK line directly, either by using the 177347cd00faSwdenk processor pin as a GPIO or by having a second pin 177447cd00faSwdenk connected to the bus. If this option is defined a 177547cd00faSwdenk custom i2c_init_board() routine in boards/xxx/board.c 177647cd00faSwdenk is run early in the boot sequence. 177747cd00faSwdenk 177826a33504SRichard Retanubun CONFIG_SYS_I2C_BOARD_LATE_INIT 177926a33504SRichard Retanubun 178026a33504SRichard Retanubun An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is 178126a33504SRichard Retanubun defined a custom i2c_board_late_init() routine in 178226a33504SRichard Retanubun boards/xxx/board.c is run AFTER the operations in i2c_init() 178326a33504SRichard Retanubun is completed. This callpoint can be used to unreset i2c bus 178426a33504SRichard Retanubun using CPU i2c controller register accesses for CPUs whose i2c 178526a33504SRichard Retanubun controller provide such a method. It is called at the end of 178626a33504SRichard Retanubun i2c_init() to allow i2c_init operations to setup the i2c bus 178726a33504SRichard Retanubun controller on the CPU (e.g. setting bus speed & slave address). 178826a33504SRichard Retanubun 178917ea1177Swdenk CONFIG_I2CFAST (PPC405GP|PPC405EP only) 179017ea1177Swdenk 179117ea1177Swdenk This option enables configuration of bi_iic_fast[] flags 179217ea1177Swdenk in u-boot bd_info structure based on u-boot environment 179317ea1177Swdenk variable "i2cfast". (see also i2cfast) 179417ea1177Swdenk 1795bb99ad6dSBen Warren CONFIG_I2C_MULTI_BUS 1796bb99ad6dSBen Warren 1797bb99ad6dSBen Warren This option allows the use of multiple I2C buses, each of which 1798bb99ad6dSBen Warren must have a controller. At any point in time, only one bus is 1799bb99ad6dSBen Warren active. To switch to a different bus, use the 'i2c dev' command. 1800bb99ad6dSBen Warren Note that bus numbering is zero-based. 1801bb99ad6dSBen Warren 18026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_NOPROBES 1803bb99ad6dSBen Warren 1804bb99ad6dSBen Warren This option specifies a list of I2C devices that will be skipped 18050f89c54bSPeter Tyser when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS 18060f89c54bSPeter Tyser is set, specify a list of bus-device pairs. Otherwise, specify 18070f89c54bSPeter Tyser a 1D array of device addresses 1808bb99ad6dSBen Warren 1809bb99ad6dSBen Warren e.g. 1810bb99ad6dSBen Warren #undef CONFIG_I2C_MULTI_BUS 18116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68} 1812bb99ad6dSBen Warren 1813bb99ad6dSBen Warren will skip addresses 0x50 and 0x68 on a board with one I2C bus 1814bb99ad6dSBen Warren 1815bb99ad6dSBen Warren #define CONFIG_I2C_MULTI_BUS 18166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}} 1817bb99ad6dSBen Warren 1818bb99ad6dSBen Warren will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1 1819bb99ad6dSBen Warren 18206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SPD_BUS_NUM 1821be5e6181STimur Tabi 1822be5e6181STimur Tabi If defined, then this indicates the I2C bus number for DDR SPD. 1823be5e6181STimur Tabi If not defined, then U-Boot assumes that SPD is on I2C bus 0. 1824be5e6181STimur Tabi 18256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_RTC_BUS_NUM 18260dc018ecSStefan Roese 18270dc018ecSStefan Roese If defined, then this indicates the I2C bus number for the RTC. 18280dc018ecSStefan Roese If not defined, then U-Boot assumes that RTC is on I2C bus 0. 18290dc018ecSStefan Roese 18306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_DTT_BUS_NUM 18310dc018ecSStefan Roese 18320dc018ecSStefan Roese If defined, then this indicates the I2C bus number for the DTT. 18330dc018ecSStefan Roese If not defined, then U-Boot assumes that DTT is on I2C bus 0. 18340dc018ecSStefan Roese 18356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_DTT_ADDR: 18369ebbb54fSVictor Gallardo 18379ebbb54fSVictor Gallardo If defined, specifies the I2C address of the DTT device. 18389ebbb54fSVictor Gallardo If not defined, then U-Boot uses predefined value for 18399ebbb54fSVictor Gallardo specified DTT device. 18409ebbb54fSVictor Gallardo 1841be5e6181STimur Tabi CONFIG_FSL_I2C 1842be5e6181STimur Tabi 1843be5e6181STimur Tabi Define this option if you want to use Freescale's I2C driver in 18447817cb20SMarcel Ziswiler drivers/i2c/fsl_i2c.c. 1845be5e6181STimur Tabi 184667b23a32SHeiko Schocher CONFIG_I2C_MUX 184767b23a32SHeiko Schocher 184867b23a32SHeiko Schocher Define this option if you have I2C devices reached over 1 .. n 184967b23a32SHeiko Schocher I2C Muxes like the pca9544a. This option addes a new I2C 185067b23a32SHeiko Schocher Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a 185167b23a32SHeiko Schocher new I2C Bus to the existing I2C Busses. If you select the 185267b23a32SHeiko Schocher new Bus with "i2c dev", u-bbot sends first the commandos for 185367b23a32SHeiko Schocher the muxes to activate this new "bus". 185467b23a32SHeiko Schocher 185567b23a32SHeiko Schocher CONFIG_I2C_MULTI_BUS must be also defined, to use this 185667b23a32SHeiko Schocher feature! 185767b23a32SHeiko Schocher 185867b23a32SHeiko Schocher Example: 185967b23a32SHeiko Schocher Adding a new I2C Bus reached over 2 pca9544a muxes 186067b23a32SHeiko Schocher The First mux with address 70 and channel 6 186167b23a32SHeiko Schocher The Second mux with address 71 and channel 4 186267b23a32SHeiko Schocher 186367b23a32SHeiko Schocher => i2c bus pca9544a:70:6:pca9544a:71:4 186467b23a32SHeiko Schocher 186567b23a32SHeiko Schocher Use the "i2c bus" command without parameter, to get a list 186667b23a32SHeiko Schocher of I2C Busses with muxes: 186767b23a32SHeiko Schocher 186867b23a32SHeiko Schocher => i2c bus 186967b23a32SHeiko Schocher Busses reached over muxes: 187067b23a32SHeiko Schocher Bus ID: 2 187167b23a32SHeiko Schocher reached over Mux(es): 187267b23a32SHeiko Schocher pca9544a@70 ch: 4 187367b23a32SHeiko Schocher Bus ID: 3 187467b23a32SHeiko Schocher reached over Mux(es): 187567b23a32SHeiko Schocher pca9544a@70 ch: 6 187667b23a32SHeiko Schocher pca9544a@71 ch: 4 187767b23a32SHeiko Schocher => 187867b23a32SHeiko Schocher 187967b23a32SHeiko Schocher If you now switch to the new I2C Bus 3 with "i2c dev 3" 1880f9a78b8dSMichael Jones u-boot first sends the command to the mux@70 to enable 1881f9a78b8dSMichael Jones channel 6, and then the command to the mux@71 to enable 188267b23a32SHeiko Schocher the channel 4. 188367b23a32SHeiko Schocher 188467b23a32SHeiko Schocher After that, you can use the "normal" i2c commands as 1885f9a78b8dSMichael Jones usual to communicate with your I2C devices behind 188667b23a32SHeiko Schocher the 2 muxes. 188767b23a32SHeiko Schocher 188867b23a32SHeiko Schocher This option is actually implemented for the bitbanging 188967b23a32SHeiko Schocher algorithm in common/soft_i2c.c and for the Hardware I2C 189067b23a32SHeiko Schocher Bus on the MPC8260. But it should be not so difficult 189167b23a32SHeiko Schocher to add this option to other architectures. 189267b23a32SHeiko Schocher 18932ac6985aSAndrew Dyer CONFIG_SOFT_I2C_READ_REPEATED_START 18942ac6985aSAndrew Dyer 18952ac6985aSAndrew Dyer defining this will force the i2c_read() function in 18962ac6985aSAndrew Dyer the soft_i2c driver to perform an I2C repeated start 18972ac6985aSAndrew Dyer between writing the address pointer and reading the 18982ac6985aSAndrew Dyer data. If this define is omitted the default behaviour 18992ac6985aSAndrew Dyer of doing a stop-start sequence will be used. Most I2C 19002ac6985aSAndrew Dyer devices can use either method, but some require one or 19012ac6985aSAndrew Dyer the other. 1902be5e6181STimur Tabi 1903c609719bSwdenk- SPI Support: CONFIG_SPI 1904c609719bSwdenk 1905c609719bSwdenk Enables SPI driver (so far only tested with 1906c609719bSwdenk SPI EEPROM, also an instance works with Crystal A/D and 1907c609719bSwdenk D/As on the SACSng board) 1908c609719bSwdenk 19096639562eSYoshihiro Shimoda CONFIG_SH_SPI 19106639562eSYoshihiro Shimoda 19116639562eSYoshihiro Shimoda Enables the driver for SPI controller on SuperH. Currently 19126639562eSYoshihiro Shimoda only SH7757 is supported. 19136639562eSYoshihiro Shimoda 1914c609719bSwdenk CONFIG_SPI_X 1915c609719bSwdenk 1916c609719bSwdenk Enables extended (16-bit) SPI EEPROM addressing. 1917c609719bSwdenk (symmetrical to CONFIG_I2C_X) 1918c609719bSwdenk 1919c609719bSwdenk CONFIG_SOFT_SPI 1920c609719bSwdenk 1921c609719bSwdenk Enables a software (bit-bang) SPI driver rather than 1922c609719bSwdenk using hardware support. This is a general purpose 1923c609719bSwdenk driver that only requires three general I/O port pins 1924c609719bSwdenk (two outputs, one input) to function. If this is 1925c609719bSwdenk defined, the board configuration must define several 1926c609719bSwdenk SPI configuration items (port pins to use, etc). For 1927c609719bSwdenk an example, see include/configs/sacsng.h. 1928c609719bSwdenk 192904a9e118SBen Warren CONFIG_HARD_SPI 193004a9e118SBen Warren 193104a9e118SBen Warren Enables a hardware SPI driver for general-purpose reads 193204a9e118SBen Warren and writes. As with CONFIG_SOFT_SPI, the board configuration 193304a9e118SBen Warren must define a list of chip-select function pointers. 193404a9e118SBen Warren Currently supported on some MPC8xxx processors. For an 193504a9e118SBen Warren example, see include/configs/mpc8349emds.h. 193604a9e118SBen Warren 193738254f45SGuennadi Liakhovetski CONFIG_MXC_SPI 193838254f45SGuennadi Liakhovetski 193938254f45SGuennadi Liakhovetski Enables the driver for the SPI controllers on i.MX and MXC 19402e3cd1cdSFabio Estevam SoCs. Currently i.MX31/35/51 are supported. 194138254f45SGuennadi Liakhovetski 19420133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA 19430133502eSMatthias Fuchs 19440133502eSMatthias Fuchs Enables FPGA subsystem. 19450133502eSMatthias Fuchs 19460133502eSMatthias Fuchs CONFIG_FPGA_<vendor> 19470133502eSMatthias Fuchs 19480133502eSMatthias Fuchs Enables support for specific chip vendors. 19490133502eSMatthias Fuchs (ALTERA, XILINX) 19500133502eSMatthias Fuchs 19510133502eSMatthias Fuchs CONFIG_FPGA_<family> 19520133502eSMatthias Fuchs 19530133502eSMatthias Fuchs Enables support for FPGA family. 19540133502eSMatthias Fuchs (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX) 19550133502eSMatthias Fuchs 19560133502eSMatthias Fuchs CONFIG_FPGA_COUNT 1957c609719bSwdenk 1958c609719bSwdenk Specify the number of FPGA devices to support. 1959c609719bSwdenk 19606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_PROG_FEEDBACK 1961c609719bSwdenk 1962c609719bSwdenk Enable printing of hash marks during FPGA configuration. 1963c609719bSwdenk 19646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_BUSY 1965c609719bSwdenk 1966c609719bSwdenk Enable checks on FPGA configuration interface busy 1967c609719bSwdenk status by the configuration function. This option 1968c609719bSwdenk will require a board or device specific function to 1969c609719bSwdenk be written. 1970c609719bSwdenk 1971c609719bSwdenk CONFIG_FPGA_DELAY 1972c609719bSwdenk 1973c609719bSwdenk If defined, a function that provides delays in the FPGA 1974c609719bSwdenk configuration driver. 1975c609719bSwdenk 19766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_CTRLC 1977c609719bSwdenk Allow Control-C to interrupt FPGA configuration 1978c609719bSwdenk 19796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_ERROR 1980c609719bSwdenk 1981c609719bSwdenk Check for configuration errors during FPGA bitfile 1982c609719bSwdenk loading. For example, abort during Virtex II 1983c609719bSwdenk configuration if the INIT_B line goes low (which 1984c609719bSwdenk indicated a CRC error). 1985c609719bSwdenk 19866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_INIT 1987c609719bSwdenk 1988c609719bSwdenk Maximum time to wait for the INIT_B line to deassert 1989c609719bSwdenk after PROB_B has been deasserted during a Virtex II 1990c609719bSwdenk FPGA configuration sequence. The default time is 500 199111ccc33fSMarcel Ziswiler ms. 1992c609719bSwdenk 19936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_BUSY 1994c609719bSwdenk 1995c609719bSwdenk Maximum time to wait for BUSY to deassert during 199611ccc33fSMarcel Ziswiler Virtex II FPGA configuration. The default is 5 ms. 1997c609719bSwdenk 19986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_CONFIG 1999c609719bSwdenk 2000c609719bSwdenk Time to wait after FPGA configuration. The default is 200111ccc33fSMarcel Ziswiler 200 ms. 2002c609719bSwdenk 2003c609719bSwdenk- Configuration Management: 2004c609719bSwdenk CONFIG_IDENT_STRING 2005c609719bSwdenk 2006c609719bSwdenk If defined, this string will be added to the U-Boot 2007c609719bSwdenk version information (U_BOOT_VERSION) 2008c609719bSwdenk 2009c609719bSwdenk- Vendor Parameter Protection: 2010c609719bSwdenk 2011c609719bSwdenk U-Boot considers the values of the environment 2012c609719bSwdenk variables "serial#" (Board Serial Number) and 20137152b1d0Swdenk "ethaddr" (Ethernet Address) to be parameters that 2014c609719bSwdenk are set once by the board vendor / manufacturer, and 2015c609719bSwdenk protects these variables from casual modification by 2016c609719bSwdenk the user. Once set, these variables are read-only, 2017c609719bSwdenk and write or delete attempts are rejected. You can 201811ccc33fSMarcel Ziswiler change this behaviour: 2019c609719bSwdenk 2020c609719bSwdenk If CONFIG_ENV_OVERWRITE is #defined in your config 2021c609719bSwdenk file, the write protection for vendor parameters is 202247cd00faSwdenk completely disabled. Anybody can change or delete 2023c609719bSwdenk these parameters. 2024c609719bSwdenk 2025c609719bSwdenk Alternatively, if you #define _both_ CONFIG_ETHADDR 2026c609719bSwdenk _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default 202711ccc33fSMarcel Ziswiler Ethernet address is installed in the environment, 2028c609719bSwdenk which can be changed exactly ONCE by the user. [The 2029c609719bSwdenk serial# is unaffected by this, i. e. it remains 2030c609719bSwdenk read-only.] 2031c609719bSwdenk 2032c609719bSwdenk- Protected RAM: 2033c609719bSwdenk CONFIG_PRAM 2034c609719bSwdenk 2035c609719bSwdenk Define this variable to enable the reservation of 2036c609719bSwdenk "protected RAM", i. e. RAM which is not overwritten 2037c609719bSwdenk by U-Boot. Define CONFIG_PRAM to hold the number of 2038c609719bSwdenk kB you want to reserve for pRAM. You can overwrite 2039c609719bSwdenk this default value by defining an environment 2040c609719bSwdenk variable "pram" to the number of kB you want to 2041c609719bSwdenk reserve. Note that the board info structure will 2042c609719bSwdenk still show the full amount of RAM. If pRAM is 2043c609719bSwdenk reserved, a new environment variable "mem" will 2044c609719bSwdenk automatically be defined to hold the amount of 2045c609719bSwdenk remaining RAM in a form that can be passed as boot 2046c609719bSwdenk argument to Linux, for instance like that: 2047c609719bSwdenk 2048fe126d8bSWolfgang Denk setenv bootargs ... mem=\${mem} 2049c609719bSwdenk saveenv 2050c609719bSwdenk 2051c609719bSwdenk This way you can tell Linux not to use this memory, 2052c609719bSwdenk either, which results in a memory region that will 2053c609719bSwdenk not be affected by reboots. 2054c609719bSwdenk 2055c609719bSwdenk *WARNING* If your board configuration uses automatic 2056c609719bSwdenk detection of the RAM size, you must make sure that 2057c609719bSwdenk this memory test is non-destructive. So far, the 2058c609719bSwdenk following board configurations are known to be 2059c609719bSwdenk "pRAM-clean": 2060c609719bSwdenk 2061c609719bSwdenk ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL, 2062c609719bSwdenk HERMES, IP860, RPXlite, LWMON, LANTEC, 2063544d97e9SWolfgang Denk FLAGADM, TQM8260 2064c609719bSwdenk 2065c609719bSwdenk- Error Recovery: 2066c609719bSwdenk CONFIG_PANIC_HANG 2067c609719bSwdenk 2068c609719bSwdenk Define this variable to stop the system in case of a 2069c609719bSwdenk fatal error, so that you have to reset it manually. 2070c609719bSwdenk This is probably NOT a good idea for an embedded 207111ccc33fSMarcel Ziswiler system where you want the system to reboot 2072c609719bSwdenk automatically as fast as possible, but it may be 2073c609719bSwdenk useful during development since you can try to debug 2074c609719bSwdenk the conditions that lead to the situation. 2075c609719bSwdenk 2076c609719bSwdenk CONFIG_NET_RETRY_COUNT 2077c609719bSwdenk 2078c609719bSwdenk This variable defines the number of retries for 2079c609719bSwdenk network operations like ARP, RARP, TFTP, or BOOTP 2080c609719bSwdenk before giving up the operation. If not defined, a 2081c609719bSwdenk default value of 5 is used. 2082c609719bSwdenk 208340cb90eeSGuennadi Liakhovetski CONFIG_ARP_TIMEOUT 208440cb90eeSGuennadi Liakhovetski 208540cb90eeSGuennadi Liakhovetski Timeout waiting for an ARP reply in milliseconds. 208640cb90eeSGuennadi Liakhovetski 2087c609719bSwdenk- Command Interpreter: 20888078f1a5SWolfgang Denk CONFIG_AUTO_COMPLETE 208904a85b3bSwdenk 209004a85b3bSwdenk Enable auto completion of commands using TAB. 209104a85b3bSwdenk 20928078f1a5SWolfgang Denk Note that this feature has NOT been implemented yet 20938078f1a5SWolfgang Denk for the "hush" shell. 20948078f1a5SWolfgang Denk 20958078f1a5SWolfgang Denk 20966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_HUSH_PARSER 2097c609719bSwdenk 2098c609719bSwdenk Define this variable to enable the "hush" shell (from 2099c609719bSwdenk Busybox) as command line interpreter, thus enabling 2100c609719bSwdenk powerful command line syntax like 2101c609719bSwdenk if...then...else...fi conditionals or `&&' and '||' 2102c609719bSwdenk constructs ("shell scripts"). 2103c609719bSwdenk 2104c609719bSwdenk If undefined, you get the old, much simpler behaviour 2105c609719bSwdenk with a somewhat smaller memory footprint. 2106c609719bSwdenk 2107c609719bSwdenk 21086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PROMPT_HUSH_PS2 2109c609719bSwdenk 2110c609719bSwdenk This defines the secondary prompt string, which is 2111c609719bSwdenk printed when the command interpreter needs more input 2112c609719bSwdenk to complete a command. Usually "> ". 2113c609719bSwdenk 2114c609719bSwdenk Note: 2115c609719bSwdenk 2116c609719bSwdenk In the current implementation, the local variables 2117c609719bSwdenk space and global environment variables space are 2118c609719bSwdenk separated. Local variables are those you define by 21193b57fe0aSwdenk simply typing `name=value'. To access a local 2120c609719bSwdenk variable later on, you have write `$name' or 21213b57fe0aSwdenk `${name}'; to execute the contents of a variable 21223b57fe0aSwdenk directly type `$name' at the command prompt. 2123c609719bSwdenk 2124c609719bSwdenk Global environment variables are those you use 2125c609719bSwdenk setenv/printenv to work with. To run a command stored 2126c609719bSwdenk in such a variable, you need to use the run command, 2127c609719bSwdenk and you must not use the '$' sign to access them. 2128c609719bSwdenk 2129c609719bSwdenk To store commands and special characters in a 2130c609719bSwdenk variable, please use double quotation marks 2131c609719bSwdenk surrounding the whole text of the variable, instead 2132c609719bSwdenk of the backslashes before semicolons and special 2133c609719bSwdenk symbols. 2134c609719bSwdenk 2135aa0c71acSWolfgang Denk- Commandline Editing and History: 2136aa0c71acSWolfgang Denk CONFIG_CMDLINE_EDITING 2137aa0c71acSWolfgang Denk 213811ccc33fSMarcel Ziswiler Enable editing and History functions for interactive 2139aa0c71acSWolfgang Denk commandline input operations 2140aa0c71acSWolfgang Denk 2141a8c7c708Swdenk- Default Environment: 2142c609719bSwdenk CONFIG_EXTRA_ENV_SETTINGS 2143c609719bSwdenk 2144c609719bSwdenk Define this to contain any number of null terminated 2145c609719bSwdenk strings (variable = value pairs) that will be part of 21467152b1d0Swdenk the default environment compiled into the boot image. 21472262cfeeSwdenk 2148c609719bSwdenk For example, place something like this in your 2149c609719bSwdenk board's config file: 2150c609719bSwdenk 2151c609719bSwdenk #define CONFIG_EXTRA_ENV_SETTINGS \ 2152c609719bSwdenk "myvar1=value1\0" \ 2153c609719bSwdenk "myvar2=value2\0" 2154c609719bSwdenk 2155c609719bSwdenk Warning: This method is based on knowledge about the 2156c609719bSwdenk internal format how the environment is stored by the 21572262cfeeSwdenk U-Boot code. This is NOT an official, exported 2158c609719bSwdenk interface! Although it is unlikely that this format 21597152b1d0Swdenk will change soon, there is no guarantee either. 2160c609719bSwdenk You better know what you are doing here. 2161c609719bSwdenk 2162c609719bSwdenk Note: overly (ab)use of the default environment is 2163c609719bSwdenk discouraged. Make sure to check other ways to preset 216474de7aefSWolfgang Denk the environment like the "source" command or the 2165c609719bSwdenk boot command first. 2166c609719bSwdenk 2167a8c7c708Swdenk- DataFlash Support: 21682abbe075Swdenk CONFIG_HAS_DATAFLASH 21692abbe075Swdenk 21702abbe075Swdenk Defining this option enables DataFlash features and 21712abbe075Swdenk allows to read/write in Dataflash via the standard 21722abbe075Swdenk commands cp, md... 21732abbe075Swdenk 21743f85ce27Swdenk- SystemACE Support: 21753f85ce27Swdenk CONFIG_SYSTEMACE 21763f85ce27Swdenk 21773f85ce27Swdenk Adding this option adds support for Xilinx SystemACE 21783f85ce27Swdenk chips attached via some sort of local bus. The address 217911ccc33fSMarcel Ziswiler of the chip must also be defined in the 21806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SYSTEMACE_BASE macro. For example: 21813f85ce27Swdenk 21823f85ce27Swdenk #define CONFIG_SYSTEMACE 21836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000 21843f85ce27Swdenk 21853f85ce27Swdenk When SystemACE support is added, the "ace" device type 21863f85ce27Swdenk becomes available to the fat commands, i.e. fatls. 21873f85ce27Swdenk 2188ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port: 2189ecb0ccd9SWolfgang Denk CONFIG_TFTP_PORT 2190ecb0ccd9SWolfgang Denk 219128cb9375SWolfgang Denk If this is defined, the environment variable tftpsrcp 2192ecb0ccd9SWolfgang Denk is used to supply the TFTP UDP source port value. 219328cb9375SWolfgang Denk If tftpsrcp isn't defined, the normal pseudo-random port 2194ecb0ccd9SWolfgang Denk number generator is used. 2195ecb0ccd9SWolfgang Denk 219628cb9375SWolfgang Denk Also, the environment variable tftpdstp is used to supply 219728cb9375SWolfgang Denk the TFTP UDP destination port value. If tftpdstp isn't 219828cb9375SWolfgang Denk defined, the normal port 69 is used. 219928cb9375SWolfgang Denk 220028cb9375SWolfgang Denk The purpose for tftpsrcp is to allow a TFTP server to 2201ecb0ccd9SWolfgang Denk blindly start the TFTP transfer using the pre-configured 2202ecb0ccd9SWolfgang Denk target IP address and UDP port. This has the effect of 2203ecb0ccd9SWolfgang Denk "punching through" the (Windows XP) firewall, allowing 2204ecb0ccd9SWolfgang Denk the remainder of the TFTP transfer to proceed normally. 2205ecb0ccd9SWolfgang Denk A better solution is to properly configure the firewall, 2206ecb0ccd9SWolfgang Denk but sometimes that is not allowed. 2207ecb0ccd9SWolfgang Denk 2208a8c7c708Swdenk- Show boot progress: 2209c609719bSwdenk CONFIG_SHOW_BOOT_PROGRESS 2210c609719bSwdenk 2211c609719bSwdenk Defining this option allows to add some board- 2212c609719bSwdenk specific code (calling a user-provided function 2213c609719bSwdenk "show_boot_progress(int)") that enables you to show 2214c609719bSwdenk the system's boot progress on some display (for 2215c609719bSwdenk example, some LED's) on your board. At the moment, 2216c609719bSwdenk the following checkpoints are implemented: 2217c609719bSwdenk 22181372cce2SMarian BalakowiczLegacy uImage format: 22191372cce2SMarian Balakowicz 2220c609719bSwdenk Arg Where When 2221c609719bSwdenk 1 common/cmd_bootm.c before attempting to boot an image 2222c609719bSwdenk -1 common/cmd_bootm.c Image header has bad magic number 2223c609719bSwdenk 2 common/cmd_bootm.c Image header has correct magic number 2224c609719bSwdenk -2 common/cmd_bootm.c Image header has bad checksum 2225c609719bSwdenk 3 common/cmd_bootm.c Image header has correct checksum 2226c609719bSwdenk -3 common/cmd_bootm.c Image data has bad checksum 2227c609719bSwdenk 4 common/cmd_bootm.c Image data has correct checksum 2228c609719bSwdenk -4 common/cmd_bootm.c Image is for unsupported architecture 2229c609719bSwdenk 5 common/cmd_bootm.c Architecture check OK 22301372cce2SMarian Balakowicz -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi) 2231c609719bSwdenk 6 common/cmd_bootm.c Image Type check OK 2232c609719bSwdenk -6 common/cmd_bootm.c gunzip uncompression error 2233c609719bSwdenk -7 common/cmd_bootm.c Unimplemented compression type 2234c609719bSwdenk 7 common/cmd_bootm.c Uncompression OK 22351372cce2SMarian Balakowicz 8 common/cmd_bootm.c No uncompress/copy overwrite error 2236c609719bSwdenk -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX) 22371372cce2SMarian Balakowicz 22381372cce2SMarian Balakowicz 9 common/image.c Start initial ramdisk verification 22391372cce2SMarian Balakowicz -10 common/image.c Ramdisk header has bad magic number 22401372cce2SMarian Balakowicz -11 common/image.c Ramdisk header has bad checksum 22411372cce2SMarian Balakowicz 10 common/image.c Ramdisk header is OK 22421372cce2SMarian Balakowicz -12 common/image.c Ramdisk data has bad checksum 22431372cce2SMarian Balakowicz 11 common/image.c Ramdisk data has correct checksum 22441372cce2SMarian Balakowicz 12 common/image.c Ramdisk verification complete, start loading 224511ccc33fSMarcel Ziswiler -13 common/image.c Wrong Image Type (not PPC Linux ramdisk) 22461372cce2SMarian Balakowicz 13 common/image.c Start multifile image verification 22471372cce2SMarian Balakowicz 14 common/image.c No initial ramdisk, no multifile, continue. 22481372cce2SMarian Balakowicz 2249ea0364f1SPeter Tyser 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS 2250c609719bSwdenk 2251a47a12beSStefan Roese -30 arch/powerpc/lib/board.c Fatal error, hang the system 225263e73c9aSwdenk -31 post/post.c POST test failed, detected by post_output_backlog() 225363e73c9aSwdenk -32 post/post.c POST test failed, detected by post_run_single() 225463e73c9aSwdenk 2255566a494fSHeiko Schocher 34 common/cmd_doc.c before loading a Image from a DOC device 2256566a494fSHeiko Schocher -35 common/cmd_doc.c Bad usage of "doc" command 2257566a494fSHeiko Schocher 35 common/cmd_doc.c correct usage of "doc" command 2258566a494fSHeiko Schocher -36 common/cmd_doc.c No boot device 2259566a494fSHeiko Schocher 36 common/cmd_doc.c correct boot device 2260566a494fSHeiko Schocher -37 common/cmd_doc.c Unknown Chip ID on boot device 2261566a494fSHeiko Schocher 37 common/cmd_doc.c correct chip ID found, device available 2262566a494fSHeiko Schocher -38 common/cmd_doc.c Read Error on boot device 2263566a494fSHeiko Schocher 38 common/cmd_doc.c reading Image header from DOC device OK 2264566a494fSHeiko Schocher -39 common/cmd_doc.c Image header has bad magic number 2265566a494fSHeiko Schocher 39 common/cmd_doc.c Image header has correct magic number 2266566a494fSHeiko Schocher -40 common/cmd_doc.c Error reading Image from DOC device 2267566a494fSHeiko Schocher 40 common/cmd_doc.c Image header has correct magic number 2268566a494fSHeiko Schocher 41 common/cmd_ide.c before loading a Image from a IDE device 2269566a494fSHeiko Schocher -42 common/cmd_ide.c Bad usage of "ide" command 2270566a494fSHeiko Schocher 42 common/cmd_ide.c correct usage of "ide" command 2271566a494fSHeiko Schocher -43 common/cmd_ide.c No boot device 2272566a494fSHeiko Schocher 43 common/cmd_ide.c boot device found 2273566a494fSHeiko Schocher -44 common/cmd_ide.c Device not available 2274566a494fSHeiko Schocher 44 common/cmd_ide.c Device available 2275566a494fSHeiko Schocher -45 common/cmd_ide.c wrong partition selected 2276566a494fSHeiko Schocher 45 common/cmd_ide.c partition selected 2277566a494fSHeiko Schocher -46 common/cmd_ide.c Unknown partition table 2278566a494fSHeiko Schocher 46 common/cmd_ide.c valid partition table found 2279566a494fSHeiko Schocher -47 common/cmd_ide.c Invalid partition type 2280566a494fSHeiko Schocher 47 common/cmd_ide.c correct partition type 2281566a494fSHeiko Schocher -48 common/cmd_ide.c Error reading Image Header on boot device 2282566a494fSHeiko Schocher 48 common/cmd_ide.c reading Image Header from IDE device OK 2283566a494fSHeiko Schocher -49 common/cmd_ide.c Image header has bad magic number 2284566a494fSHeiko Schocher 49 common/cmd_ide.c Image header has correct magic number 2285566a494fSHeiko Schocher -50 common/cmd_ide.c Image header has bad checksum 2286566a494fSHeiko Schocher 50 common/cmd_ide.c Image header has correct checksum 2287566a494fSHeiko Schocher -51 common/cmd_ide.c Error reading Image from IDE device 2288566a494fSHeiko Schocher 51 common/cmd_ide.c reading Image from IDE device OK 2289566a494fSHeiko Schocher 52 common/cmd_nand.c before loading a Image from a NAND device 2290566a494fSHeiko Schocher -53 common/cmd_nand.c Bad usage of "nand" command 2291566a494fSHeiko Schocher 53 common/cmd_nand.c correct usage of "nand" command 2292566a494fSHeiko Schocher -54 common/cmd_nand.c No boot device 2293566a494fSHeiko Schocher 54 common/cmd_nand.c boot device found 2294566a494fSHeiko Schocher -55 common/cmd_nand.c Unknown Chip ID on boot device 2295566a494fSHeiko Schocher 55 common/cmd_nand.c correct chip ID found, device available 2296566a494fSHeiko Schocher -56 common/cmd_nand.c Error reading Image Header on boot device 2297566a494fSHeiko Schocher 56 common/cmd_nand.c reading Image Header from NAND device OK 2298566a494fSHeiko Schocher -57 common/cmd_nand.c Image header has bad magic number 2299566a494fSHeiko Schocher 57 common/cmd_nand.c Image header has correct magic number 2300566a494fSHeiko Schocher -58 common/cmd_nand.c Error reading Image from NAND device 2301566a494fSHeiko Schocher 58 common/cmd_nand.c reading Image from NAND device OK 2302c609719bSwdenk 2303566a494fSHeiko Schocher -60 common/env_common.c Environment has a bad CRC, using default 2304c609719bSwdenk 2305566a494fSHeiko Schocher 64 net/eth.c starting with Ethernet configuration. 2306566a494fSHeiko Schocher -64 net/eth.c no Ethernet found. 2307566a494fSHeiko Schocher 65 net/eth.c Ethernet found. 2308206c60cbSwdenk 2309566a494fSHeiko Schocher -80 common/cmd_net.c usage wrong 2310566a494fSHeiko Schocher 80 common/cmd_net.c before calling NetLoop() 231111ccc33fSMarcel Ziswiler -81 common/cmd_net.c some error in NetLoop() occurred 2312566a494fSHeiko Schocher 81 common/cmd_net.c NetLoop() back without error 2313566a494fSHeiko Schocher -82 common/cmd_net.c size == 0 (File with size 0 loaded) 2314566a494fSHeiko Schocher 82 common/cmd_net.c trying automatic boot 231574de7aefSWolfgang Denk 83 common/cmd_net.c running "source" command 231674de7aefSWolfgang Denk -83 common/cmd_net.c some error in automatic boot or "source" command 2317566a494fSHeiko Schocher 84 common/cmd_net.c end without errors 2318c609719bSwdenk 23191372cce2SMarian BalakowiczFIT uImage format: 23201372cce2SMarian Balakowicz 23211372cce2SMarian Balakowicz Arg Where When 23221372cce2SMarian Balakowicz 100 common/cmd_bootm.c Kernel FIT Image has correct format 23231372cce2SMarian Balakowicz -100 common/cmd_bootm.c Kernel FIT Image has incorrect format 23241372cce2SMarian Balakowicz 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration 23251372cce2SMarian Balakowicz -101 common/cmd_bootm.c Can't get configuration for kernel subimage 23261372cce2SMarian Balakowicz 102 common/cmd_bootm.c Kernel unit name specified 23271372cce2SMarian Balakowicz -103 common/cmd_bootm.c Can't get kernel subimage node offset 2328f773bea8SMarian Balakowicz 103 common/cmd_bootm.c Found configuration node 23291372cce2SMarian Balakowicz 104 common/cmd_bootm.c Got kernel subimage node offset 23301372cce2SMarian Balakowicz -104 common/cmd_bootm.c Kernel subimage hash verification failed 23311372cce2SMarian Balakowicz 105 common/cmd_bootm.c Kernel subimage hash verification OK 23321372cce2SMarian Balakowicz -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture 23331372cce2SMarian Balakowicz 106 common/cmd_bootm.c Architecture check OK 233411ccc33fSMarcel Ziswiler -106 common/cmd_bootm.c Kernel subimage has wrong type 233511ccc33fSMarcel Ziswiler 107 common/cmd_bootm.c Kernel subimage type OK 23361372cce2SMarian Balakowicz -107 common/cmd_bootm.c Can't get kernel subimage data/size 23371372cce2SMarian Balakowicz 108 common/cmd_bootm.c Got kernel subimage data/size 23381372cce2SMarian Balakowicz -108 common/cmd_bootm.c Wrong image type (not legacy, FIT) 23391372cce2SMarian Balakowicz -109 common/cmd_bootm.c Can't get kernel subimage type 23401372cce2SMarian Balakowicz -110 common/cmd_bootm.c Can't get kernel subimage comp 23411372cce2SMarian Balakowicz -111 common/cmd_bootm.c Can't get kernel subimage os 23421372cce2SMarian Balakowicz -112 common/cmd_bootm.c Can't get kernel subimage load address 23431372cce2SMarian Balakowicz -113 common/cmd_bootm.c Image uncompress/copy overwrite error 23441372cce2SMarian Balakowicz 23451372cce2SMarian Balakowicz 120 common/image.c Start initial ramdisk verification 23461372cce2SMarian Balakowicz -120 common/image.c Ramdisk FIT image has incorrect format 23471372cce2SMarian Balakowicz 121 common/image.c Ramdisk FIT image has correct format 234811ccc33fSMarcel Ziswiler 122 common/image.c No ramdisk subimage unit name, using configuration 23491372cce2SMarian Balakowicz -122 common/image.c Can't get configuration for ramdisk subimage 23501372cce2SMarian Balakowicz 123 common/image.c Ramdisk unit name specified 23511372cce2SMarian Balakowicz -124 common/image.c Can't get ramdisk subimage node offset 23521372cce2SMarian Balakowicz 125 common/image.c Got ramdisk subimage node offset 23531372cce2SMarian Balakowicz -125 common/image.c Ramdisk subimage hash verification failed 23541372cce2SMarian Balakowicz 126 common/image.c Ramdisk subimage hash verification OK 23551372cce2SMarian Balakowicz -126 common/image.c Ramdisk subimage for unsupported architecture 23561372cce2SMarian Balakowicz 127 common/image.c Architecture check OK 23571372cce2SMarian Balakowicz -127 common/image.c Can't get ramdisk subimage data/size 23581372cce2SMarian Balakowicz 128 common/image.c Got ramdisk subimage data/size 23591372cce2SMarian Balakowicz 129 common/image.c Can't get ramdisk load address 23601372cce2SMarian Balakowicz -129 common/image.c Got ramdisk load address 23611372cce2SMarian Balakowicz 236211ccc33fSMarcel Ziswiler -130 common/cmd_doc.c Incorrect FIT image format 23631372cce2SMarian Balakowicz 131 common/cmd_doc.c FIT image format OK 23641372cce2SMarian Balakowicz 236511ccc33fSMarcel Ziswiler -140 common/cmd_ide.c Incorrect FIT image format 23661372cce2SMarian Balakowicz 141 common/cmd_ide.c FIT image format OK 23671372cce2SMarian Balakowicz 236811ccc33fSMarcel Ziswiler -150 common/cmd_nand.c Incorrect FIT image format 23691372cce2SMarian Balakowicz 151 common/cmd_nand.c FIT image format OK 23701372cce2SMarian Balakowicz 23714cf2609bSWolfgang Denk- Standalone program support: 23724cf2609bSWolfgang Denk CONFIG_STANDALONE_LOAD_ADDR 23734cf2609bSWolfgang Denk 23746feff899SWolfgang Denk This option defines a board specific value for the 23756feff899SWolfgang Denk address where standalone program gets loaded, thus 23766feff899SWolfgang Denk overwriting the architecture dependent default 23774cf2609bSWolfgang Denk settings. 23784cf2609bSWolfgang Denk 23794cf2609bSWolfgang Denk- Frame Buffer Address: 23804cf2609bSWolfgang Denk CONFIG_FB_ADDR 23814cf2609bSWolfgang Denk 23824cf2609bSWolfgang Denk Define CONFIG_FB_ADDR if you want to use specific 23834cf2609bSWolfgang Denk address for frame buffer. 23844cf2609bSWolfgang Denk Then system will reserve the frame buffer address to 23854cf2609bSWolfgang Denk defined address instead of lcd_setmem (this function 23866feff899SWolfgang Denk grabs the memory for frame buffer by panel's size). 23874cf2609bSWolfgang Denk 23884cf2609bSWolfgang Denk Please see board_init_f function. 23894cf2609bSWolfgang Denk 2390cccfc2abSDetlev Zundel- Automatic software updates via TFTP server 2391cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP 2392cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP_CNT_MAX 2393cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP_MSEC_MAX 2394cccfc2abSDetlev Zundel 2395cccfc2abSDetlev Zundel These options enable and control the auto-update feature; 2396cccfc2abSDetlev Zundel for a more detailed description refer to doc/README.update. 2397cccfc2abSDetlev Zundel 2398cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support) 2399cccfc2abSDetlev Zundel CONFIG_MTD_DEVICE 2400cccfc2abSDetlev Zundel 2401cccfc2abSDetlev Zundel Adds the MTD device infrastructure from the Linux kernel. 2402cccfc2abSDetlev Zundel Needed for mtdparts command support. 2403cccfc2abSDetlev Zundel 2404cccfc2abSDetlev Zundel CONFIG_MTD_PARTITIONS 2405cccfc2abSDetlev Zundel 2406cccfc2abSDetlev Zundel Adds the MTD partitioning infrastructure from the Linux 2407cccfc2abSDetlev Zundel kernel. Needed for UBI support. 2408cccfc2abSDetlev Zundel 24096a11cf48SDaniel Schwierzeck- SPL framework 24106a11cf48SDaniel Schwierzeck CONFIG_SPL 24116a11cf48SDaniel Schwierzeck Enable building of SPL globally. 24126a11cf48SDaniel Schwierzeck 24136a11cf48SDaniel Schwierzeck CONFIG_SPL_TEXT_BASE 24146a11cf48SDaniel Schwierzeck TEXT_BASE for linking the SPL binary. 24156a11cf48SDaniel Schwierzeck 24166a11cf48SDaniel Schwierzeck CONFIG_SPL_LDSCRIPT 24176a11cf48SDaniel Schwierzeck LDSCRIPT for linking the SPL binary. 24186a11cf48SDaniel Schwierzeck 24196a11cf48SDaniel Schwierzeck CONFIG_SPL_LIBCOMMON_SUPPORT 24206a11cf48SDaniel Schwierzeck Support for common/libcommon.o in SPL binary 24216a11cf48SDaniel Schwierzeck 24226a11cf48SDaniel Schwierzeck CONFIG_SPL_LIBDISK_SUPPORT 24236a11cf48SDaniel Schwierzeck Support for disk/libdisk.o in SPL binary 24246a11cf48SDaniel Schwierzeck 24256a11cf48SDaniel Schwierzeck CONFIG_SPL_I2C_SUPPORT 24266a11cf48SDaniel Schwierzeck Support for drivers/i2c/libi2c.o in SPL binary 24276a11cf48SDaniel Schwierzeck 24286a11cf48SDaniel Schwierzeck CONFIG_SPL_GPIO_SUPPORT 24296a11cf48SDaniel Schwierzeck Support for drivers/gpio/libgpio.o in SPL binary 24306a11cf48SDaniel Schwierzeck 24316a11cf48SDaniel Schwierzeck CONFIG_SPL_MMC_SUPPORT 24326a11cf48SDaniel Schwierzeck Support for drivers/mmc/libmmc.o in SPL binary 24336a11cf48SDaniel Schwierzeck 24346a11cf48SDaniel Schwierzeck CONFIG_SPL_SERIAL_SUPPORT 24356a11cf48SDaniel Schwierzeck Support for drivers/serial/libserial.o in SPL binary 24366a11cf48SDaniel Schwierzeck 24376a11cf48SDaniel Schwierzeck CONFIG_SPL_SPI_FLASH_SUPPORT 24386a11cf48SDaniel Schwierzeck Support for drivers/mtd/spi/libspi_flash.o in SPL binary 24396a11cf48SDaniel Schwierzeck 24406a11cf48SDaniel Schwierzeck CONFIG_SPL_SPI_SUPPORT 24416a11cf48SDaniel Schwierzeck Support for drivers/spi/libspi.o in SPL binary 24426a11cf48SDaniel Schwierzeck 24436a11cf48SDaniel Schwierzeck CONFIG_SPL_FAT_SUPPORT 24446a11cf48SDaniel Schwierzeck Support for fs/fat/libfat.o in SPL binary 24456a11cf48SDaniel Schwierzeck 24466a11cf48SDaniel Schwierzeck CONFIG_SPL_LIBGENERIC_SUPPORT 24476a11cf48SDaniel Schwierzeck Support for lib/libgeneric.o in SPL binary 24481372cce2SMarian Balakowicz 2449c609719bSwdenkModem Support: 2450c609719bSwdenk-------------- 2451c609719bSwdenk 2452566e5cf4SWolfgang Denk[so far only for SMDK2400 boards] 2453c609719bSwdenk 245411ccc33fSMarcel Ziswiler- Modem support enable: 2455c609719bSwdenk CONFIG_MODEM_SUPPORT 2456c609719bSwdenk 2457c609719bSwdenk- RTS/CTS Flow control enable: 2458c609719bSwdenk CONFIG_HWFLOW 2459c609719bSwdenk 2460c609719bSwdenk- Modem debug support: 2461c609719bSwdenk CONFIG_MODEM_SUPPORT_DEBUG 2462c609719bSwdenk 2463c609719bSwdenk Enables debugging stuff (char screen[1024], dbg()) 2464c609719bSwdenk for modem support. Useful only with BDI2000. 2465c609719bSwdenk 2466a8c7c708Swdenk- Interrupt support (PPC): 2467a8c7c708Swdenk 2468a8c7c708Swdenk There are common interrupt_init() and timer_interrupt() 2469a8c7c708Swdenk for all PPC archs. interrupt_init() calls interrupt_init_cpu() 247011ccc33fSMarcel Ziswiler for CPU specific initialization. interrupt_init_cpu() 2471a8c7c708Swdenk should set decrementer_count to appropriate value. If 247211ccc33fSMarcel Ziswiler CPU resets decrementer automatically after interrupt 2473a8c7c708Swdenk (ppc4xx) it should set decrementer_count to zero. 247411ccc33fSMarcel Ziswiler timer_interrupt() calls timer_interrupt_cpu() for CPU 2475a8c7c708Swdenk specific handling. If board has watchdog / status_led 2476a8c7c708Swdenk / other_activity_monitor it works automatically from 2477a8c7c708Swdenk general timer_interrupt(). 2478a8c7c708Swdenk 2479c609719bSwdenk- General: 2480c609719bSwdenk 2481c609719bSwdenk In the target system modem support is enabled when a 2482c609719bSwdenk specific key (key combination) is pressed during 2483c609719bSwdenk power-on. Otherwise U-Boot will boot normally 248411ccc33fSMarcel Ziswiler (autoboot). The key_pressed() function is called from 2485c609719bSwdenk board_init(). Currently key_pressed() is a dummy 2486c609719bSwdenk function, returning 1 and thus enabling modem 2487c609719bSwdenk initialization. 2488c609719bSwdenk 2489c609719bSwdenk If there are no modem init strings in the 2490c609719bSwdenk environment, U-Boot proceed to autoboot; the 2491c609719bSwdenk previous output (banner, info printfs) will be 249211ccc33fSMarcel Ziswiler suppressed, though. 2493c609719bSwdenk 2494c609719bSwdenk See also: doc/README.Modem 2495c609719bSwdenk 24969660e442SHelmut RaigerBoard initialization settings: 24979660e442SHelmut Raiger------------------------------ 24989660e442SHelmut Raiger 24999660e442SHelmut RaigerDuring Initialization u-boot calls a number of board specific functions 25009660e442SHelmut Raigerto allow the preparation of board specific prerequisites, e.g. pin setup 25019660e442SHelmut Raigerbefore drivers are initialized. To enable these callbacks the 25029660e442SHelmut Raigerfollowing configuration macros have to be defined. Currently this is 25039660e442SHelmut Raigerarchitecture specific, so please check arch/your_architecture/lib/board.c 25049660e442SHelmut Raigertypically in board_init_f() and board_init_r(). 25059660e442SHelmut Raiger 25069660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f() 25079660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r() 25089660e442SHelmut Raiger- CONFIG_BOARD_LATE_INIT: Call board_late_init() 25099660e442SHelmut Raiger- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init() 2510c609719bSwdenk 2511c609719bSwdenkConfiguration Settings: 2512c609719bSwdenk----------------------- 2513c609719bSwdenk 25146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included; 2515c609719bSwdenk undefine this when you're short of memory. 2516c609719bSwdenk 25172fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default 25182fb2604dSPeter Tyser width of the commands listed in the 'help' command output. 25192fb2604dSPeter Tyser 25206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to 2521c609719bSwdenk prompt for user input. 2522c609719bSwdenk 25236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE: Buffer size for input from the Console 2524c609719bSwdenk 25256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE: Buffer size for Console output 2526c609719bSwdenk 25276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands 2528c609719bSwdenk 25296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to 2530c609719bSwdenk the application (usually a Linux kernel) when it is 2531c609719bSwdenk booted 2532c609719bSwdenk 25336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE: 2534c609719bSwdenk List of legal baudrate settings for this board. 2535c609719bSwdenk 25366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET 2537c609719bSwdenk Suppress display of console information at boot. 2538c609719bSwdenk 25396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV 2540c609719bSwdenk If the board specific function 2541c609719bSwdenk extern int overwrite_console (void); 2542c609719bSwdenk returns 1, the stdin, stderr and stdout are switched to the 2543c609719bSwdenk serial port, else the settings in the environment are used. 2544c609719bSwdenk 25456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE 2546c609719bSwdenk Enable the call to overwrite_console(). 2547c609719bSwdenk 25486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE 2549c609719bSwdenk Enable overwrite of previous console environment settings. 2550c609719bSwdenk 25516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END: 2552c609719bSwdenk Begin and End addresses of the area used by the 2553c609719bSwdenk simple memory test. 2554c609719bSwdenk 25556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST: 2556c609719bSwdenk Enable an alternate, more extensive memory test. 2557c609719bSwdenk 25586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH: 25595f535fe1Swdenk Scratch address used by the alternate memory test 25605f535fe1Swdenk You only need to set this if address zero isn't writeable 25615f535fe1Swdenk 25626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only): 25636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header, 256414f73ca6SStefan Roese this specified memory area will get subtracted from the top 256511ccc33fSMarcel Ziswiler (end) of RAM and won't get "touched" at all by U-Boot. By 256614f73ca6SStefan Roese fixing up gd->ram_size the Linux kernel should gets passed 256714f73ca6SStefan Roese the now "corrected" memory size and won't touch it either. 256814f73ca6SStefan Roese This should work for arch/ppc and arch/powerpc. Only Linux 25695e12e75dSStefan Roese board ports in arch/powerpc with bootwrapper support that 257014f73ca6SStefan Roese recalculate the memory size from the SDRAM controller setup 25715e12e75dSStefan Roese will have to get fixed in Linux additionally. 257214f73ca6SStefan Roese 257314f73ca6SStefan Roese This option can be used as a workaround for the 440EPx/GRx 257414f73ca6SStefan Roese CHIP 11 errata where the last 256 bytes in SDRAM shouldn't 257514f73ca6SStefan Roese be touched. 257614f73ca6SStefan Roese 257714f73ca6SStefan Roese WARNING: Please make sure that this value is a multiple of 257814f73ca6SStefan Roese the Linux page size (normally 4k). If this is not the case, 257914f73ca6SStefan Roese then the end address of the Linux memory will be located at a 258014f73ca6SStefan Roese non page size aligned address and this could cause major 258114f73ca6SStefan Roese problems. 258214f73ca6SStefan Roese 25836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TFTP_LOADADDR: 2584c609719bSwdenk Default load address for network file downloads 2585c609719bSwdenk 25866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE: 2587c609719bSwdenk Enable temporary baudrate change while serial download 2588c609719bSwdenk 25896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE: 2590c609719bSwdenk Physical start address of SDRAM. _Must_ be 0 here. 2591c609719bSwdenk 25926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE: 2593c609719bSwdenk Physical start address of Motherboard I/O (if using a 2594c609719bSwdenk Cogent motherboard) 2595c609719bSwdenk 25966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE: 2597c609719bSwdenk Physical start address of Flash memory. 2598c609719bSwdenk 25996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE: 2600c609719bSwdenk Physical start address of boot monitor code (set by 2601c609719bSwdenk make config files to be same as the text base address 260214d0a02aSWolfgang Denk (CONFIG_SYS_TEXT_BASE) used when linking) - same as 26036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FLASH_BASE when booting from flash. 2604c609719bSwdenk 26056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN: 26063b57fe0aSwdenk Size of memory reserved for monitor code, used to 26073b57fe0aSwdenk determine _at_compile_time_ (!) if the environment is 26083b57fe0aSwdenk embedded within the U-Boot image, or in a separate 26093b57fe0aSwdenk flash sector. 2610c609719bSwdenk 26116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN: 2612c609719bSwdenk Size of DRAM reserved for malloc() use. 2613c609719bSwdenk 26146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN: 261515940c9aSStefan Roese Normally compressed uImages are limited to an 261615940c9aSStefan Roese uncompressed size of 8 MBytes. If this is not enough, 26176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD you can define CONFIG_SYS_BOOTM_LEN in your board config file 261815940c9aSStefan Roese to adjust this setting to your needs. 2619c609719bSwdenk 26206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ: 2621c609719bSwdenk Maximum size of memory mapped by the startup code of 2622c609719bSwdenk the Linux kernel; all data that must be processed by 26237d721e34SBartlomiej Sieka the Linux kernel (bd_info, boot arguments, FDT blob if 26247d721e34SBartlomiej Sieka used) must be put below this limit, unless "bootm_low" 26257d721e34SBartlomiej Sieka enviroment variable is defined and non-zero. In such case 26267d721e34SBartlomiej Sieka all data for the Linux kernel must be between "bootm_low" 2627c3624e6eSGrant Likely and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment 2628c3624e6eSGrant Likely variable "bootm_mapsize" will override the value of 2629c3624e6eSGrant Likely CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined, 2630c3624e6eSGrant Likely then the value in "bootm_size" will be used instead. 2631c609719bSwdenk 2632fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH: 2633fca43cc8SJohn Rigby Enable initrd_high functionality. If defined then the 2634fca43cc8SJohn Rigby initrd_high feature is enabled and the bootm ramdisk subcommand 2635fca43cc8SJohn Rigby is enabled. 2636fca43cc8SJohn Rigby 2637fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE: 2638fca43cc8SJohn Rigby Enables allocating and saving kernel cmdline in space between 2639fca43cc8SJohn Rigby "bootm_low" and "bootm_low" + BOOTMAPSZ. 2640fca43cc8SJohn Rigby 2641fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD: 2642fca43cc8SJohn Rigby Enables allocating and saving a kernel copy of the bd_info in 2643fca43cc8SJohn Rigby space between "bootm_low" and "bootm_low" + BOOTMAPSZ. 2644fca43cc8SJohn Rigby 26456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS: 2646c609719bSwdenk Max number of Flash memory banks 2647c609719bSwdenk 26486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT: 2649c609719bSwdenk Max number of sectors on a Flash chip 2650c609719bSwdenk 26516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT: 2652c609719bSwdenk Timeout for Flash erase operations (in ms) 2653c609719bSwdenk 26546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT: 2655c609719bSwdenk Timeout for Flash write operations (in ms) 2656c609719bSwdenk 26576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT 26588564acf9Swdenk Timeout for Flash set sector lock bit operation (in ms) 26598564acf9Swdenk 26606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT 26618564acf9Swdenk Timeout for Flash clear lock bits operation (in ms) 26628564acf9Swdenk 26636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION 26648564acf9Swdenk If defined, hardware flash sectors protection is used 26658564acf9Swdenk instead of U-Boot software protection. 26668564acf9Swdenk 26676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP: 2668c609719bSwdenk 2669c609719bSwdenk Enable TFTP transfers directly to flash memory; 2670c609719bSwdenk without this option such a download has to be 2671c609719bSwdenk performed in two steps: (1) download to RAM, and (2) 2672c609719bSwdenk copy from RAM to flash. 2673c609719bSwdenk 2674c609719bSwdenk The two-step approach is usually more reliable, since 2675c609719bSwdenk you can check if the download worked before you erase 267611ccc33fSMarcel Ziswiler the flash, but in some situations (when system RAM is 267711ccc33fSMarcel Ziswiler too limited to allow for a temporary copy of the 2678c609719bSwdenk downloaded image) this option may be very useful. 2679c609719bSwdenk 26806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI: 2681c609719bSwdenk Define if the flash driver uses extra elements in the 26825653fc33Swdenk common flash structure for storing flash geometry. 26835653fc33Swdenk 268400b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER 26855653fc33Swdenk This option also enables the building of the cfi_flash driver 26865653fc33Swdenk in the drivers directory 268753cf9435Sstroese 268891809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD 268991809ed5SPiotr Ziecik This option enables the building of the cfi_mtd driver 269091809ed5SPiotr Ziecik in the drivers directory. The driver exports CFI flash 269191809ed5SPiotr Ziecik to the MTD layer. 269291809ed5SPiotr Ziecik 26936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE 269496ef831fSGuennadi Liakhovetski Use buffered writes to flash. 269596ef831fSGuennadi Liakhovetski 269696ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N 269796ef831fSGuennadi Liakhovetski s29ws-n MirrorBit flash has non-standard addresses for buffered 269896ef831fSGuennadi Liakhovetski write commands. 269996ef831fSGuennadi Liakhovetski 27006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST 27015568e613SStefan Roese If this option is defined, the common CFI flash doesn't 27025568e613SStefan Roese print it's warning upon not recognized FLASH banks. This 27035568e613SStefan Roese is useful, if some of the configured banks are only 27045568e613SStefan Roese optionally available. 27055568e613SStefan Roese 27069a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS 27079a042e9cSJerry Van Baren If defined (must be an integer), print out countdown 27089a042e9cSJerry Van Baren digits and dots. Recommended value: 45 (9..1) for 80 27099a042e9cSJerry Van Baren column displays, 15 (3..1) for 40 column displays. 27109a042e9cSJerry Van Baren 27116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER: 271211ccc33fSMarcel Ziswiler Defines the number of Ethernet receive buffers. On some 271311ccc33fSMarcel Ziswiler Ethernet controllers it is recommended to set this value 271453cf9435Sstroese to 8 or even higher (EEPRO100 or 405 EMAC), since all 271553cf9435Sstroese buffers can be full shortly after enabling the interface 271611ccc33fSMarcel Ziswiler on high Ethernet traffic. 271753cf9435Sstroese Defaults to 4 if not defined. 2718c609719bSwdenk 2719ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES 2720ea882bafSWolfgang Denk 2721ea882bafSWolfgang Denk Maximum number of entries in the hash table that is used 2722ea882bafSWolfgang Denk internally to store the environment settings. The default 2723ea882bafSWolfgang Denk setting is supposed to be generous and should work in most 2724ea882bafSWolfgang Denk cases. This setting can be used to tune behaviour; see 2725ea882bafSWolfgang Denk lib/hashtable.c for details. 2726ea882bafSWolfgang Denk 2727c609719bSwdenkThe following definitions that deal with the placement and management 2728c609719bSwdenkof environment data (variable area); in general, we support the 2729c609719bSwdenkfollowing configurations: 2730c609719bSwdenk 2731c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC: 2732c3eb3fe4SMike Frysinger 2733c3eb3fe4SMike Frysinger Builds up envcrc with the target environment so that external utils 2734c3eb3fe4SMike Frysinger may easily extract it and embed it in final U-Boot images. 2735c3eb3fe4SMike Frysinger 27365a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH: 2737c609719bSwdenk 2738c609719bSwdenk Define this if the environment is in flash memory. 2739c609719bSwdenk 2740c609719bSwdenk a) The environment occupies one whole flash sector, which is 2741c609719bSwdenk "embedded" in the text segment with the U-Boot code. This 2742c609719bSwdenk happens usually with "bottom boot sector" or "top boot 2743c609719bSwdenk sector" type flash chips, which have several smaller 2744c609719bSwdenk sectors at the start or the end. For instance, such a 2745c609719bSwdenk layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In 2746c609719bSwdenk such a case you would place the environment in one of the 2747c609719bSwdenk 4 kB sectors - with U-Boot code before and after it. With 2748c609719bSwdenk "top boot sector" type flash chips, you would put the 2749c609719bSwdenk environment in one of the last sectors, leaving a gap 2750c609719bSwdenk between U-Boot and the environment. 2751c609719bSwdenk 27520e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 2753c609719bSwdenk 2754c609719bSwdenk Offset of environment data (variable area) to the 2755c609719bSwdenk beginning of flash memory; for instance, with bottom boot 2756c609719bSwdenk type flash chips the second sector can be used: the offset 2757c609719bSwdenk for this sector is given here. 2758c609719bSwdenk 27596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE. 2760c609719bSwdenk 27610e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 2762c609719bSwdenk 2763c609719bSwdenk This is just another way to specify the start address of 2764c609719bSwdenk the flash sector containing the environment (instead of 27650e8d1586SJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_OFFSET). 2766c609719bSwdenk 27670e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SECT_SIZE: 2768c609719bSwdenk 2769c609719bSwdenk Size of the sector containing the environment. 2770c609719bSwdenk 2771c609719bSwdenk 2772c609719bSwdenk b) Sometimes flash chips have few, equal sized, BIG sectors. 2773c609719bSwdenk In such a case you don't want to spend a whole sector for 2774c609719bSwdenk the environment. 2775c609719bSwdenk 27760e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 2777c609719bSwdenk 27785a1aceb0SJean-Christophe PLAGNIOL-VILLARD If you use this in combination with CONFIG_ENV_IS_IN_FLASH 27790e8d1586SJean-Christophe PLAGNIOL-VILLARD and CONFIG_ENV_SECT_SIZE, you can specify to use only a part 2780c609719bSwdenk of this flash sector for the environment. This saves 2781c609719bSwdenk memory for the RAM copy of the environment. 2782c609719bSwdenk 2783c609719bSwdenk It may also save flash memory if you decide to use this 2784c609719bSwdenk when your environment is "embedded" within U-Boot code, 2785c609719bSwdenk since then the remainder of the flash sector could be used 2786c609719bSwdenk for U-Boot code. It should be pointed out that this is 2787c609719bSwdenk STRONGLY DISCOURAGED from a robustness point of view: 2788c609719bSwdenk updating the environment in flash makes it always 2789c609719bSwdenk necessary to erase the WHOLE sector. If something goes 2790c609719bSwdenk wrong before the contents has been restored from a copy in 2791c609719bSwdenk RAM, your target system will be dead. 2792c609719bSwdenk 27930e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR_REDUND 27940e8d1586SJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_SIZE_REDUND 2795c609719bSwdenk 2796c609719bSwdenk These settings describe a second storage area used to hold 279711ccc33fSMarcel Ziswiler a redundant copy of the environment data, so that there is 27983e38691eSwdenk a valid backup copy in case there is a power failure during 2799c609719bSwdenk a "saveenv" operation. 2800c609719bSwdenk 2801c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the 2802c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds* 2803c609719bSwdenkaccordingly! 2804c609719bSwdenk 2805c609719bSwdenk 28069314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM: 2807c609719bSwdenk 2808c609719bSwdenk Define this if you have some non-volatile memory device 2809c609719bSwdenk (NVRAM, battery buffered SRAM) which you want to use for the 2810c609719bSwdenk environment. 2811c609719bSwdenk 28120e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 28130e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 2814c609719bSwdenk 281511ccc33fSMarcel Ziswiler These two #defines are used to determine the memory area you 2816c609719bSwdenk want to use for environment. It is assumed that this memory 2817c609719bSwdenk can just be read and written to, without any special 2818c609719bSwdenk provision. 2819c609719bSwdenk 2820c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early 2821c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the 282211ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or 2823c609719bSwdenkU-Boot will hang. 2824c609719bSwdenk 2825c609719bSwdenkPlease note that even with NVRAM we still use a copy of the 2826c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to 2827c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv" 2828c609719bSwdenkto save the current settings. 2829c609719bSwdenk 2830c609719bSwdenk 2831bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM: 2832c609719bSwdenk 2833c609719bSwdenk Use this if you have an EEPROM or similar serial access 2834c609719bSwdenk device and a driver for it. 2835c609719bSwdenk 28360e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 28370e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 2838c609719bSwdenk 2839c609719bSwdenk These two #defines specify the offset and size of the 2840c609719bSwdenk environment area within the total memory of your EEPROM. 2841c609719bSwdenk 28426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR: 2843c609719bSwdenk If defined, specified the chip address of the EEPROM device. 2844c609719bSwdenk The default address is zero. 2845c609719bSwdenk 28466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS: 2847c609719bSwdenk If defined, the number of bits used to address bytes in a 2848c609719bSwdenk single page in the EEPROM device. A 64 byte page, for example 2849c609719bSwdenk would require six bits. 2850c609719bSwdenk 28516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS: 2852c609719bSwdenk If defined, the number of milliseconds to delay between 2853c609719bSwdenk page writes. The default is zero milliseconds. 2854c609719bSwdenk 28556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR_LEN: 2856c609719bSwdenk The length in bytes of the EEPROM memory array address. Note 2857c609719bSwdenk that this is NOT the chip address length! 2858c609719bSwdenk 28596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW: 28605cf91d6bSwdenk EEPROM chips that implement "address overflow" are ones 28615cf91d6bSwdenk like Catalyst 24WC04/08/16 which has 9/10/11 bits of 28625cf91d6bSwdenk address and the extra bits end up in the "chip address" bit 28635cf91d6bSwdenk slots. This makes a 24WC08 (1Kbyte) chip look like four 256 28645cf91d6bSwdenk byte chips. 28655cf91d6bSwdenk 28665cf91d6bSwdenk Note that we consider the length of the address field to 28675cf91d6bSwdenk still be one byte because the extra address bits are hidden 28685cf91d6bSwdenk in the chip address. 28695cf91d6bSwdenk 28706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_SIZE: 2871c609719bSwdenk The size in bytes of the EEPROM device. 2872c609719bSwdenk 2873548738b4SHeiko Schocher - CONFIG_ENV_EEPROM_IS_ON_I2C 2874548738b4SHeiko Schocher define this, if you have I2C and SPI activated, and your 2875548738b4SHeiko Schocher EEPROM, which holds the environment, is on the I2C bus. 2876548738b4SHeiko Schocher 2877548738b4SHeiko Schocher - CONFIG_I2C_ENV_EEPROM_BUS 2878548738b4SHeiko Schocher if you have an Environment on an EEPROM reached over 2879548738b4SHeiko Schocher I2C muxes, you can define here, how to reach this 2880548738b4SHeiko Schocher EEPROM. For example: 2881548738b4SHeiko Schocher 2882548738b4SHeiko Schocher #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0" 2883548738b4SHeiko Schocher 2884548738b4SHeiko Schocher EEPROM which holds the environment, is reached over 2885548738b4SHeiko Schocher a pca9547 i2c mux with address 0x70, channel 3. 2886c609719bSwdenk 2887057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH: 28885779d8d9Swdenk 28895779d8d9Swdenk Define this if you have a DataFlash memory device which you 28905779d8d9Swdenk want to use for the environment. 28915779d8d9Swdenk 28920e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 28930e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 28940e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 28955779d8d9Swdenk 28965779d8d9Swdenk These three #defines specify the offset and size of the 28975779d8d9Swdenk environment area within the total memory of your DataFlash placed 28985779d8d9Swdenk at the specified address. 28995779d8d9Swdenk 290051bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND: 290113a5695bSwdenk 290213a5695bSwdenk Define this if you have a NAND device which you want to use 290313a5695bSwdenk for the environment. 290413a5695bSwdenk 29050e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 29060e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 290713a5695bSwdenk 290813a5695bSwdenk These two #defines specify the offset and size of the environment 2909fdd813deSScott Wood area within the first NAND device. CONFIG_ENV_OFFSET must be 2910fdd813deSScott Wood aligned to an erase block boundary. 29115779d8d9Swdenk 2912fdd813deSScott Wood - CONFIG_ENV_OFFSET_REDUND (optional): 2913e443c944SMarkus Klotzbuecher 29140e8d1586SJean-Christophe PLAGNIOL-VILLARD This setting describes a second storage area of CONFIG_ENV_SIZE 2915fdd813deSScott Wood size used to hold a redundant copy of the environment data, so 2916fdd813deSScott Wood that there is a valid backup copy in case there is a power failure 2917fdd813deSScott Wood during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be 2918fdd813deSScott Wood aligned to an erase block boundary. 2919e443c944SMarkus Klotzbuecher 2920fdd813deSScott Wood - CONFIG_ENV_RANGE (optional): 2921fdd813deSScott Wood 2922fdd813deSScott Wood Specifies the length of the region in which the environment 2923fdd813deSScott Wood can be written. This should be a multiple of the NAND device's 2924fdd813deSScott Wood block size. Specifying a range with more erase blocks than 2925fdd813deSScott Wood are needed to hold CONFIG_ENV_SIZE allows bad blocks within 2926fdd813deSScott Wood the range to be avoided. 2927fdd813deSScott Wood 2928fdd813deSScott Wood - CONFIG_ENV_OFFSET_OOB (optional): 2929fdd813deSScott Wood 2930fdd813deSScott Wood Enables support for dynamically retrieving the offset of the 2931fdd813deSScott Wood environment from block zero's out-of-band data. The 2932fdd813deSScott Wood "nand env.oob" command can be used to record this offset. 2933fdd813deSScott Wood Currently, CONFIG_ENV_OFFSET_REDUND is not supported when 2934fdd813deSScott Wood using CONFIG_ENV_OFFSET_OOB. 2935e443c944SMarkus Klotzbuecher 2936b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST 2937b74ab737SGuennadi Liakhovetski 2938b74ab737SGuennadi Liakhovetski Defines address in RAM to which the nand_spl code should copy the 2939b74ab737SGuennadi Liakhovetski environment. If redundant environment is used, it will be copied to 2940b74ab737SGuennadi Liakhovetski CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE. 2941b74ab737SGuennadi Liakhovetski 29426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET 2943c609719bSwdenk 2944c609719bSwdenk Defines offset to the initial SPI buffer area in DPRAM. The 2945c609719bSwdenk area is used at an early stage (ROM part) if the environment 2946c609719bSwdenk is configured to reside in the SPI EEPROM: We need a 520 byte 2947c609719bSwdenk scratch DPRAM area. It is used between the two initialization 2948c609719bSwdenk calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems 2949c609719bSwdenk to be a good choice since it makes it far enough from the 2950c609719bSwdenk start of the data area as well as from the stack pointer. 2951c609719bSwdenk 2952e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor 2953c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been 2954cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f() 2955c609719bSwdenkuntil then to read environment variables. 2956c609719bSwdenk 295785ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor 295885ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working 295985ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is 296085ec0bccSwdenknecessary, because the first environment variable we need is the 296185ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't 296285ec0bccSwdenkhave any device yet where we could complain.] 2963c609719bSwdenk 2964c609719bSwdenkNote: once the monitor has been relocated, then it will complain if 2965c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you 296685ec0bccSwdenkuse the "saveenv" command to store a valid environment. 2967c609719bSwdenk 29686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN: 2969fc3e2165Swdenk Echo the inverted Ethernet link state to the fault LED. 2970fc3e2165Swdenk 29716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR 2972fc3e2165Swdenk also needs to be defined. 2973fc3e2165Swdenk 29746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR: 2975fc3e2165Swdenk MII address of the PHY to check for the Ethernet link state. 2976c609719bSwdenk 2977f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS: 2978f5675aa5SRon Madrid Define this if you desire to only have use of the NS16550_init 2979f5675aa5SRon Madrid and NS16550_putc functions for the serial driver located at 2980f5675aa5SRon Madrid drivers/serial/ns16550.c. This option is useful for saving 2981f5675aa5SRon Madrid space for already greatly restricted images, including but not 2982f5675aa5SRon Madrid limited to NAND_SPL configurations. 2983f5675aa5SRon Madrid 2984c609719bSwdenkLow Level (hardware related) configuration options: 2985dc7c9a1aSwdenk--------------------------------------------------- 2986c609719bSwdenk 29876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE: 2988c609719bSwdenk Cache Line Size of the CPU. 2989c609719bSwdenk 29906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR: 2991c609719bSwdenk Default address of the IMMR after system reset. 29922535d602Swdenk 29932535d602Swdenk Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU, 29942535d602Swdenk and RPXsuper) to be able to adjust the position of 29952535d602Swdenk the IMMR register after a reset. 2996c609719bSwdenk 2997e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT: 2998e46fedfeSTimur Tabi Default (power-on reset) physical address of CCSR on Freescale 2999e46fedfeSTimur Tabi PowerPC SOCs. 3000e46fedfeSTimur Tabi 3001e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR: 3002e46fedfeSTimur Tabi Virtual address of CCSR. On a 32-bit build, this is typically 3003e46fedfeSTimur Tabi the same value as CONFIG_SYS_CCSRBAR_DEFAULT. 3004e46fedfeSTimur Tabi 3005e46fedfeSTimur Tabi CONFIG_SYS_DEFAULT_IMMR must also be set to this value, 3006e46fedfeSTimur Tabi for cross-platform code that uses that macro instead. 3007e46fedfeSTimur Tabi 3008e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS: 3009e46fedfeSTimur Tabi Physical address of CCSR. CCSR can be relocated to a new 3010e46fedfeSTimur Tabi physical address, if desired. In this case, this macro should 3011e46fedfeSTimur Tabi be set to that address. Otherwise, it should be set to the 3012e46fedfeSTimur Tabi same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR 3013e46fedfeSTimur Tabi is typically relocated on 36-bit builds. It is recommended 3014e46fedfeSTimur Tabi that this macro be defined via the _HIGH and _LOW macros: 3015e46fedfeSTimur Tabi 3016e46fedfeSTimur Tabi #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH 3017e46fedfeSTimur Tabi * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW) 3018e46fedfeSTimur Tabi 3019e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH: 3020e46fedfeSTimur Tabi Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically 3021e46fedfeSTimur Tabi either 0 (32-bit build) or 0xF (36-bit build). This macro is 3022e46fedfeSTimur Tabi used in assembly code, so it must not contain typecasts or 3023e46fedfeSTimur Tabi integer size suffixes (e.g. "ULL"). 3024e46fedfeSTimur Tabi 3025e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW: 3026e46fedfeSTimur Tabi Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is 3027e46fedfeSTimur Tabi used in assembly code, so it must not contain typecasts or 3028e46fedfeSTimur Tabi integer size suffixes (e.g. "ULL"). 3029e46fedfeSTimur Tabi 3030e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE: 3031e46fedfeSTimur Tabi If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be 3032e46fedfeSTimur Tabi forced to a value that ensures that CCSR is not relocated. 3033e46fedfeSTimur Tabi 30347f6c2cbcSwdenk- Floppy Disk Support: 30356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FDC_DRIVE_NUMBER 30367f6c2cbcSwdenk 30377f6c2cbcSwdenk the default drive number (default value 0) 30387f6c2cbcSwdenk 30396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_ISA_IO_STRIDE 30407f6c2cbcSwdenk 304111ccc33fSMarcel Ziswiler defines the spacing between FDC chipset registers 30427f6c2cbcSwdenk (default value 1) 30437f6c2cbcSwdenk 30446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_ISA_IO_OFFSET 30457f6c2cbcSwdenk 30467f6c2cbcSwdenk defines the offset of register from address. It 30477f6c2cbcSwdenk depends on which part of the data bus is connected to 304811ccc33fSMarcel Ziswiler the FDC chipset. (default value 0) 30497f6c2cbcSwdenk 30506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and 30516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their 30527f6c2cbcSwdenk default value. 30537f6c2cbcSwdenk 30546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD if CONFIG_SYS_FDC_HW_INIT is defined, then the function 30557f6c2cbcSwdenk fdc_hw_init() is called at the beginning of the FDC 30567f6c2cbcSwdenk setup. fdc_hw_init() must be provided by the board 30577f6c2cbcSwdenk source code. It is used to make hardware dependant 30587f6c2cbcSwdenk initializations. 30597f6c2cbcSwdenk 30600abddf82SMacpaul Lin- CONFIG_IDE_AHB: 30610abddf82SMacpaul Lin Most IDE controllers were designed to be connected with PCI 30620abddf82SMacpaul Lin interface. Only few of them were designed for AHB interface. 30630abddf82SMacpaul Lin When software is doing ATA command and data transfer to 30640abddf82SMacpaul Lin IDE devices through IDE-AHB controller, some additional 30650abddf82SMacpaul Lin registers accessing to these kind of IDE-AHB controller 30660abddf82SMacpaul Lin is requierd. 30670abddf82SMacpaul Lin 30686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR: Physical address of the Internal Memory. 306925d6712aSwdenk DO NOT CHANGE unless you know exactly what you're 307025d6712aSwdenk doing! (11-4) [MPC8xx/82xx systems only] 3071c609719bSwdenk 30726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR: 3073c609719bSwdenk 30747152b1d0Swdenk Start address of memory area that can be used for 3075c609719bSwdenk initial data and stack; please note that this must be 3076c609719bSwdenk writable memory that is working WITHOUT special 3077c609719bSwdenk initialization, i. e. you CANNOT use normal RAM which 3078c609719bSwdenk will become available only after programming the 3079c609719bSwdenk memory controller and running certain initialization 3080c609719bSwdenk sequences. 3081c609719bSwdenk 3082c609719bSwdenk U-Boot uses the following memory types: 3083c609719bSwdenk - MPC8xx and MPC8260: IMMR (internal memory of the CPU) 3084c609719bSwdenk - MPC824X: data cache 3085c609719bSwdenk - PPC4xx: data cache 3086c609719bSwdenk 30876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET: 3088c609719bSwdenk 3089c609719bSwdenk Offset of the initial data structure in the memory 30906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually 30916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial 3092c609719bSwdenk data is located at the end of the available space 3093553f0982SWolfgang Denk (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE - 30946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just 30956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR + 30966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_GBL_DATA_OFFSET) downward. 3097c609719bSwdenk 3098c609719bSwdenk Note: 3099c609719bSwdenk On the MPC824X (or other systems that use the data 3100c609719bSwdenk cache for initial memory) the address chosen for 31016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must 3102c609719bSwdenk point to an otherwise UNUSED address space between 3103c609719bSwdenk the top of RAM and the start of the PCI space. 3104c609719bSwdenk 31056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6) 3106c609719bSwdenk 31076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR: System Protection Control (11-9) 3108c609719bSwdenk 31096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26) 3110c609719bSwdenk 31116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31) 3112c609719bSwdenk 31136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30) 3114c609719bSwdenk 31156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27) 3116c609719bSwdenk 31176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM: 3118c609719bSwdenk SDRAM timing 3119c609719bSwdenk 31206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA: 3121c609719bSwdenk periodic timer for refresh 3122c609719bSwdenk 31236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER: Debug Event Register (37-47) 3124c609719bSwdenk 31256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM, 31266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP, 31276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM, 31286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BR1_PRELIM: 3129c609719bSwdenk Memory Controller Definitions: BR0/1 and OR0/1 (FLASH) 3130c609719bSwdenk 3131c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE, 31326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM, 31336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM: 3134c609719bSwdenk Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM) 3135c609719bSwdenk 31366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K, 31376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL: 3138c609719bSwdenk Machine Mode Register and Memory Periodic Timer 3139c609719bSwdenk Prescaler definitions (SDRAM timing) 3140c609719bSwdenk 31416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]: 3142c609719bSwdenk enable I2C microcode relocation patch (MPC8xx); 3143c609719bSwdenk define relocation offset in DPRAM [DSP2] 3144c609719bSwdenk 31456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]: 3146b423d055SHeiko Schocher enable SMC microcode relocation patch (MPC8xx); 3147b423d055SHeiko Schocher define relocation offset in DPRAM [SMC1] 3148b423d055SHeiko Schocher 31496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]: 3150c609719bSwdenk enable SPI microcode relocation patch (MPC8xx); 3151c609719bSwdenk define relocation offset in DPRAM [SCC4] 3152c609719bSwdenk 31536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK: 3154c609719bSwdenk Use OSCM clock mode on MBX8xx board. Be careful, 3155c609719bSwdenk wrong setting might damage your board. Read 3156c609719bSwdenk doc/README.MBX before setting this variable! 3157c609719bSwdenk 31586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only) 3159ea909b76Swdenk Offset of the bootmode word in DPRAM used by post 3160ea909b76Swdenk (Power On Self Tests). This definition overrides 3161ea909b76Swdenk #define'd default value in commproc.h resp. 3162ea909b76Swdenk cpm_8260.h. 3163ea909b76Swdenk 31646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB, 31656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL, 31666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS, 31676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB, 31686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START, 31696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL, 31706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE, 31716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only) 3172a47a12beSStefan Roese Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set. 31735d232d0eSwdenk 31749cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE: 31759cacf4fcSDirk Eibach Disable PCI-Express on systems where it is supported but not 31769cacf4fcSDirk Eibach required. 31779cacf4fcSDirk Eibach 3178a09b9b68SKumar Gala- CONFIG_SYS_SRIO: 3179a09b9b68SKumar Gala Chip has SRIO or not 3180a09b9b68SKumar Gala 3181a09b9b68SKumar Gala- CONFIG_SRIO1: 3182a09b9b68SKumar Gala Board has SRIO 1 port available 3183a09b9b68SKumar Gala 3184a09b9b68SKumar Gala- CONFIG_SRIO2: 3185a09b9b68SKumar Gala Board has SRIO 2 port available 3186a09b9b68SKumar Gala 3187a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT: 3188a09b9b68SKumar Gala Virtual Address of SRIO port 'n' memory region 3189a09b9b68SKumar Gala 3190a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS: 3191a09b9b68SKumar Gala Physical Address of SRIO port 'n' memory region 3192a09b9b68SKumar Gala 3193a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE: 3194a09b9b68SKumar Gala Size of SRIO port 'n' memory region 3195a09b9b68SKumar Gala 3196eced4626SAlex Waterman- CONFIG_SYS_NDFC_16 3197eced4626SAlex Waterman Defined to tell the NDFC that the NAND chip is using a 3198eced4626SAlex Waterman 16 bit bus. 3199eced4626SAlex Waterman 3200eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG 3201eced4626SAlex Waterman Sets the EBC0_CFG register for the NDFC. If not defined 3202eced4626SAlex Waterman a default value will be used. 3203eced4626SAlex Waterman 3204bb99ad6dSBen Warren- CONFIG_SPD_EEPROM 3205218ca724SWolfgang Denk Get DDR timing information from an I2C EEPROM. Common 3206218ca724SWolfgang Denk with pluggable memory modules such as SODIMMs 3207218ca724SWolfgang Denk 3208bb99ad6dSBen Warren SPD_EEPROM_ADDRESS 3209bb99ad6dSBen Warren I2C address of the SPD EEPROM 3210bb99ad6dSBen Warren 32116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM 3212218ca724SWolfgang Denk If SPD EEPROM is on an I2C bus other than the first 3213218ca724SWolfgang Denk one, specify here. Note that the value must resolve 3214218ca724SWolfgang Denk to something your driver can deal with. 3215bb99ad6dSBen Warren 32161b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING 32171b3e3c4fSYork Sun Get DDR timing information from other than SPD. Common with 32181b3e3c4fSYork Sun soldered DDR chips onboard without SPD. DDR raw timing 32191b3e3c4fSYork Sun parameters are extracted from datasheet and hard-coded into 32201b3e3c4fSYork Sun header files or board specific files. 32211b3e3c4fSYork Sun 32226f5e1dc5SYork Sun- CONFIG_FSL_DDR_INTERACTIVE 32236f5e1dc5SYork Sun Enable interactive DDR debugging. See doc/README.fsl-ddr. 32246f5e1dc5SYork Sun 32256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0 3226218ca724SWolfgang Denk Only for 83xx systems. If specified, then DDR should 3227218ca724SWolfgang Denk be configured using CS0 and CS1 instead of CS2 and CS3. 32282ad6b513STimur Tabi 3229c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12] 3230c26e454dSwdenk Define to enable FEC[12] on a 8xx series processor. 3231c26e454dSwdenk 3232c26e454dSwdenk- CONFIG_FEC[12]_PHY 3233c26e454dSwdenk Define to the hardcoded PHY address which corresponds 32346e592385Swdenk to the given FEC; i. e. 3235c26e454dSwdenk #define CONFIG_FEC1_PHY 4 3236c26e454dSwdenk means that the PHY with address 4 is connected to FEC1 3237c26e454dSwdenk 3238c26e454dSwdenk When set to -1, means to probe for first available. 3239c26e454dSwdenk 3240c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR 3241c26e454dSwdenk The PHY does not have a RXERR line (RMII only). 3242c26e454dSwdenk (so program the FEC to ignore it). 3243c26e454dSwdenk 3244c26e454dSwdenk- CONFIG_RMII 3245c26e454dSwdenk Enable RMII mode for all FECs. 3246c26e454dSwdenk Note that this is a global option, we can't 3247c26e454dSwdenk have one FEC in standard MII mode and another in RMII mode. 3248c26e454dSwdenk 32495cf91d6bSwdenk- CONFIG_CRC32_VERIFY 32505cf91d6bSwdenk Add a verify option to the crc32 command. 32515cf91d6bSwdenk The syntax is: 32525cf91d6bSwdenk 32535cf91d6bSwdenk => crc32 -v <address> <count> <crc32> 32545cf91d6bSwdenk 32555cf91d6bSwdenk Where address/count indicate a memory area 32565cf91d6bSwdenk and crc32 is the correct crc32 which the 32575cf91d6bSwdenk area should have. 32585cf91d6bSwdenk 325956523f12Swdenk- CONFIG_LOOPW 326056523f12Swdenk Add the "loopw" memory command. This only takes effect if 3261602ad3b3SJon Loeliger the memory commands are activated globally (CONFIG_CMD_MEM). 326256523f12Swdenk 32637b466641Sstroese- CONFIG_MX_CYCLIC 32647b466641Sstroese Add the "mdc" and "mwc" memory commands. These are cyclic 32657b466641Sstroese "md/mw" commands. 32667b466641Sstroese Examples: 32677b466641Sstroese 32687b466641Sstroese => mdc.b 10 4 500 32697b466641Sstroese This command will print 4 bytes (10,11,12,13) each 500 ms. 32707b466641Sstroese 32717b466641Sstroese => mwc.l 100 12345678 10 32727b466641Sstroese This command will write 12345678 to address 100 all 10 ms. 32737b466641Sstroese 32747b466641Sstroese This only takes effect if the memory commands are activated 3275602ad3b3SJon Loeliger globally (CONFIG_CMD_MEM). 32767b466641Sstroese 32778aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT 3278afc1ce82SMacpaul Lin [ARM, NDS32, MIPS only] If this variable is defined, then certain 3279e03f3169SWolfgang Denk low level initializations (like setting up the memory 3280e03f3169SWolfgang Denk controller) are omitted and/or U-Boot does not 3281e03f3169SWolfgang Denk relocate itself into RAM. 32828aa1a2d1Swdenk 3283e03f3169SWolfgang Denk Normally this variable MUST NOT be defined. The only 3284e03f3169SWolfgang Denk exception is when U-Boot is loaded (to RAM) by some 3285e03f3169SWolfgang Denk other boot loader or by a debugger which performs 3286e03f3169SWolfgang Denk these initializations itself. 32878aa1a2d1Swdenk 3288401bb30bSAneesh V- CONFIG_SPL_BUILD 3289df81238bSMagnus Lilja Modifies the behaviour of start.S when compiling a loader 3290df81238bSMagnus Lilja that is executed before the actual U-Boot. E.g. when 3291df81238bSMagnus Lilja compiling a NAND SPL. 3292400558b5Swdenk 329368bb8295SHeiko Schocher- CONFIG_SYS_NAND_HW_ECC_OOBFIRST 329468bb8295SHeiko Schocher define this, if you want to read first the oob data 329568bb8295SHeiko Schocher and then the data. This is used for example on 329668bb8295SHeiko Schocher davinci plattforms. 329768bb8295SHeiko Schocher 3298d8834a13SMatthias Weisser- CONFIG_USE_ARCH_MEMCPY 3299d8834a13SMatthias Weisser CONFIG_USE_ARCH_MEMSET 3300d8834a13SMatthias Weisser If these options are used a optimized version of memcpy/memset will 3301d8834a13SMatthias Weisser be used if available. These functions may be faster under some 3302d8834a13SMatthias Weisser conditions but may increase the binary size. 3303d8834a13SMatthias Weisser 3304f2717b47STimur TabiFreescale QE/FMAN Firmware Support: 3305f2717b47STimur Tabi----------------------------------- 3306f2717b47STimur Tabi 3307f2717b47STimur TabiThe Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the 3308f2717b47STimur Tabiloading of "firmware", which is encoded in the QE firmware binary format. 3309f2717b47STimur TabiThis firmware often needs to be loaded during U-Boot booting, so macros 3310f2717b47STimur Tabiare used to identify the storage device (NOR flash, SPI, etc) and the address 3311f2717b47STimur Tabiwithin that device. 3312f2717b47STimur Tabi 3313f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_ADDR 3314f2717b47STimur Tabi The address in the storage device where the firmware is located. The 3315f2717b47STimur Tabi meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro 3316f2717b47STimur Tabi is also specified. 3317f2717b47STimur Tabi 3318f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_LENGTH 3319f2717b47STimur Tabi The maximum possible size of the firmware. The firmware binary format 3320f2717b47STimur Tabi has a field that specifies the actual size of the firmware, but it 3321f2717b47STimur Tabi might not be possible to read any part of the firmware unless some 3322f2717b47STimur Tabi local storage is allocated to hold the entire firmware first. 3323f2717b47STimur Tabi 3324f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NOR 3325f2717b47STimur Tabi Specifies that QE/FMAN firmware is located in NOR flash, mapped as 3326f2717b47STimur Tabi normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the 3327f2717b47STimur Tabi virtual address in NOR flash. 3328f2717b47STimur Tabi 3329f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NAND 3330f2717b47STimur Tabi Specifies that QE/FMAN firmware is located in NAND flash. 3331f2717b47STimur Tabi CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash. 3332f2717b47STimur Tabi 3333f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_MMC 3334f2717b47STimur Tabi Specifies that QE/FMAN firmware is located on the primary SD/MMC 3335f2717b47STimur Tabi device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device. 3336f2717b47STimur Tabi 3337f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH 3338f2717b47STimur Tabi Specifies that QE/FMAN firmware is located on the primary SPI 3339f2717b47STimur Tabi device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device. 3340f2717b47STimur Tabi 3341f2717b47STimur Tabi 3342c609719bSwdenkBuilding the Software: 3343c609719bSwdenk====================== 3344c609719bSwdenk 3345218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments 3346218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support 3347218ca724SWolfgang Denkall possibly existing versions of cross development tools in all 3348218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we 3349218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK) 3350218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot. 3351c609719bSwdenk 3352218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you 3353218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case, 3354218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell. 3355218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are 3356218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter: 3357c609719bSwdenk 3358218ca724SWolfgang Denk $ CROSS_COMPILE=ppc_4xx- 3359218ca724SWolfgang Denk $ export CROSS_COMPILE 3360c609719bSwdenk 33612f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in 33622f8d396bSPeter Tyser the tools directory you can use the MinGW toolchain 33632f8d396bSPeter Tyser (http://www.mingw.org). Set your HOST tools to the MinGW 33642f8d396bSPeter Tyser toolchain and execute 'make tools'. For example: 33652f8d396bSPeter Tyser 33662f8d396bSPeter Tyser $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools 33672f8d396bSPeter Tyser 33682f8d396bSPeter Tyser Binaries such as tools/mkimage.exe will be created which can 33692f8d396bSPeter Tyser be executed on computers running Windows. 33702f8d396bSPeter Tyser 3371c609719bSwdenkU-Boot is intended to be simple to build. After installing the 3372c609719bSwdenksources you must configure U-Boot for one specific board type. This 3373c609719bSwdenkis done by typing: 3374c609719bSwdenk 3375c609719bSwdenk make NAME_config 3376c609719bSwdenk 3377218ca724SWolfgang Denkwhere "NAME_config" is the name of one of the existing configu- 3378218ca724SWolfgang Denkrations; see the main Makefile for supported names. 337954387ac9Swdenk 3380c609719bSwdenkNote: for some board special configuration names may exist; check if 3381c609719bSwdenk additional information is available from the board vendor; for 33822729af9dSwdenk instance, the TQM823L systems are available without (standard) 33832729af9dSwdenk or with LCD support. You can select such additional "features" 338411ccc33fSMarcel Ziswiler when choosing the configuration, i. e. 3385c609719bSwdenk 33862729af9dSwdenk make TQM823L_config 33872729af9dSwdenk - will configure for a plain TQM823L, i. e. no LCD support 3388c609719bSwdenk 3389c609719bSwdenk make TQM823L_LCD_config 3390c609719bSwdenk - will configure for a TQM823L with U-Boot console on LCD 3391c609719bSwdenk 3392c609719bSwdenk etc. 3393c609719bSwdenk 3394c609719bSwdenk 3395c609719bSwdenkFinally, type "make all", and you should get some working U-Boot 33967152b1d0Swdenkimages ready for download to / installation on your system: 3397c609719bSwdenk 3398c609719bSwdenk- "u-boot.bin" is a raw binary image 3399c609719bSwdenk- "u-boot" is an image in ELF binary format 3400c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format 3401c609719bSwdenk 3402baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved 3403baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change 3404baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory: 3405baf31249SMarian Balakowicz 3406baf31249SMarian Balakowicz1. Add O= to the make command line invocations: 3407baf31249SMarian Balakowicz 3408baf31249SMarian Balakowicz make O=/tmp/build distclean 3409baf31249SMarian Balakowicz make O=/tmp/build NAME_config 3410baf31249SMarian Balakowicz make O=/tmp/build all 3411baf31249SMarian Balakowicz 3412baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location: 3413baf31249SMarian Balakowicz 3414baf31249SMarian Balakowicz export BUILD_DIR=/tmp/build 3415baf31249SMarian Balakowicz make distclean 3416baf31249SMarian Balakowicz make NAME_config 3417baf31249SMarian Balakowicz make all 3418baf31249SMarian Balakowicz 3419baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment 3420baf31249SMarian Balakowiczvariable. 3421baf31249SMarian Balakowicz 3422c609719bSwdenk 3423c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so 3424c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of 3425c609719bSwdenknative "make". 3426c609719bSwdenk 3427c609719bSwdenk 3428c609719bSwdenkIf the system board that you have is not listed, then you will need 3429c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these 3430c609719bSwdenksteps: 3431c609719bSwdenk 3432c609719bSwdenk1. Add a new configuration option for your board to the toplevel 343385ec0bccSwdenk "Makefile" and to the "MAKEALL" script, using the existing 343485ec0bccSwdenk entries as examples. Note that here and at many other places 34357152b1d0Swdenk boards and other names are listed in alphabetical sort order. Please 343685ec0bccSwdenk keep this order. 3437c609719bSwdenk2. Create a new directory to hold your board specific code. Add any 343885ec0bccSwdenk files you need. In your board directory, you will need at least 343985ec0bccSwdenk the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds". 344085ec0bccSwdenk3. Create a new configuration file "include/configs/<board>.h" for 344185ec0bccSwdenk your board 3442c609719bSwdenk3. If you're porting U-Boot to a new CPU, then also create a new 3443c609719bSwdenk directory to hold your CPU specific code. Add any files you need. 344485ec0bccSwdenk4. Run "make <board>_config" with your new name. 3445c609719bSwdenk5. Type "make", and you should get a working "u-boot.srec" file 3446c609719bSwdenk to be installed on your target system. 344785ec0bccSwdenk6. Debug and solve any problems that might arise. 3448c609719bSwdenk [Of course, this last step is much harder than it sounds.] 3449c609719bSwdenk 3450c609719bSwdenk 3451c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.: 3452c609719bSwdenk============================================================== 3453c609719bSwdenk 3454c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board 3455c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to 3456c609719bSwdenkprovide feedback to the other developers. The feedback normally takes 3457c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest 3458218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources. 3459c609719bSwdenk 3460c609719bSwdenkBut before you submit such a patch, please verify that your modifi- 3461c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of 3462c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so, 3463c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot 3464c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can 34657152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE' 3466218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools 3467218ca724SWolfgang Denkyou can type 3468c609719bSwdenk 3469c609719bSwdenk CROSS_COMPILE=ppc_8xx- MAKEALL 3470c609719bSwdenk 3471c609719bSwdenkor to build on a native PowerPC system you can type 3472c609719bSwdenk 3473c609719bSwdenk CROSS_COMPILE=' ' MAKEALL 3474c609719bSwdenk 3475218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build 3476218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by 3477218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target 3478218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and 3479218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default 3480218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment 3481218ca724SWolfgang Denkvariable. For example: 3482baf31249SMarian Balakowicz 3483baf31249SMarian Balakowicz export BUILD_DIR=/tmp/build 3484baf31249SMarian Balakowicz export MAKEALL_LOGDIR=/tmp/log 3485baf31249SMarian Balakowicz CROSS_COMPILE=ppc_8xx- MAKEALL 3486baf31249SMarian Balakowicz 3487218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build, 3488218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean 3489218ca724SWolfgang Denkduring the whole build process. 3490baf31249SMarian Balakowicz 3491baf31249SMarian Balakowicz 3492c609719bSwdenkSee also "U-Boot Porting Guide" below. 3493c609719bSwdenk 3494c609719bSwdenk 3495c609719bSwdenkMonitor Commands - Overview: 3496c609719bSwdenk============================ 3497c609719bSwdenk 3498c609719bSwdenkgo - start application at address 'addr' 3499c609719bSwdenkrun - run commands in an environment variable 3500c609719bSwdenkbootm - boot application image from memory 3501c609719bSwdenkbootp - boot image via network using BootP/TFTP protocol 3502c609719bSwdenktftpboot- boot image via network using TFTP protocol 3503c609719bSwdenk and env variables "ipaddr" and "serverip" 3504c609719bSwdenk (and eventually "gatewayip") 35051fb7cd49SSimon Glasstftpput - upload a file via network using TFTP protocol 3506c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol 3507c609719bSwdenkdiskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd' 3508c609719bSwdenkloads - load S-Record file over serial line 3509c609719bSwdenkloadb - load binary file over serial line (kermit mode) 3510c609719bSwdenkmd - memory display 3511c609719bSwdenkmm - memory modify (auto-incrementing) 3512c609719bSwdenknm - memory modify (constant address) 3513c609719bSwdenkmw - memory write (fill) 3514c609719bSwdenkcp - memory copy 3515c609719bSwdenkcmp - memory compare 3516c609719bSwdenkcrc32 - checksum calculation 35170f89c54bSPeter Tyseri2c - I2C sub-system 3518c609719bSwdenksspi - SPI utility commands 3519c609719bSwdenkbase - print or set address offset 3520c609719bSwdenkprintenv- print environment variables 3521c609719bSwdenksetenv - set environment variables 3522c609719bSwdenksaveenv - save environment variables to persistent storage 3523c609719bSwdenkprotect - enable or disable FLASH write protection 3524c609719bSwdenkerase - erase FLASH memory 3525c609719bSwdenkflinfo - print FLASH memory information 3526c609719bSwdenkbdinfo - print Board Info structure 3527c609719bSwdenkiminfo - print header information for application image 3528c609719bSwdenkconinfo - print console devices and informations 3529c609719bSwdenkide - IDE sub-system 3530c609719bSwdenkloop - infinite loop on address range 353156523f12Swdenkloopw - infinite write loop on address range 3532c609719bSwdenkmtest - simple RAM test 3533c609719bSwdenkicache - enable or disable instruction cache 3534c609719bSwdenkdcache - enable or disable data cache 3535c609719bSwdenkreset - Perform RESET of the CPU 3536c609719bSwdenkecho - echo args to console 3537c609719bSwdenkversion - print monitor version 3538c609719bSwdenkhelp - print online help 3539c609719bSwdenk? - alias for 'help' 3540c609719bSwdenk 3541c609719bSwdenk 3542c609719bSwdenkMonitor Commands - Detailed Description: 3543c609719bSwdenk======================================== 3544c609719bSwdenk 3545c609719bSwdenkTODO. 3546c609719bSwdenk 3547c609719bSwdenkFor now: just type "help <command>". 3548c609719bSwdenk 3549c609719bSwdenk 3550c609719bSwdenkEnvironment Variables: 3551c609719bSwdenk====================== 3552c609719bSwdenk 3553c609719bSwdenkU-Boot supports user configuration using Environment Variables which 3554c609719bSwdenkcan be made persistent by saving to Flash memory. 3555c609719bSwdenk 3556c609719bSwdenkEnvironment Variables are set using "setenv", printed using 3557c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv" 3558c609719bSwdenkwithout a value can be used to delete a variable from the 3559c609719bSwdenkenvironment. As long as you don't save the environment you are 3560c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the 3561c609719bSwdenkenvironment is erased by accident, a default environment is provided. 3562c609719bSwdenk 3563c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables. 3564c96f86eeSWolfgang Denk 3565c96f86eeSWolfgang DenkList of environment variables (most likely not complete): 3566c609719bSwdenk 3567c609719bSwdenk baudrate - see CONFIG_BAUDRATE 3568c609719bSwdenk 3569c609719bSwdenk bootdelay - see CONFIG_BOOTDELAY 3570c609719bSwdenk 3571c609719bSwdenk bootcmd - see CONFIG_BOOTCOMMAND 3572c609719bSwdenk 3573c609719bSwdenk bootargs - Boot arguments when booting an RTOS image 3574c609719bSwdenk 3575c609719bSwdenk bootfile - Name of the image to load with TFTP 3576c609719bSwdenk 35777d721e34SBartlomiej Sieka bootm_low - Memory range available for image processing in the bootm 35787d721e34SBartlomiej Sieka command can be restricted. This variable is given as 35797d721e34SBartlomiej Sieka a hexadecimal number and defines lowest address allowed 35807d721e34SBartlomiej Sieka for use by the bootm command. See also "bootm_size" 35817d721e34SBartlomiej Sieka environment variable. Address defined by "bootm_low" is 35827d721e34SBartlomiej Sieka also the base of the initial memory mapping for the Linux 3583c3624e6eSGrant Likely kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and 3584c3624e6eSGrant Likely bootm_mapsize. 3585c3624e6eSGrant Likely 3586c3624e6eSGrant Likely bootm_mapsize - Size of the initial memory mapping for the Linux kernel. 3587c3624e6eSGrant Likely This variable is given as a hexadecimal number and it 3588c3624e6eSGrant Likely defines the size of the memory region starting at base 3589c3624e6eSGrant Likely address bootm_low that is accessible by the Linux kernel 3590c3624e6eSGrant Likely during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used 3591c3624e6eSGrant Likely as the default value if it is defined, and bootm_size is 3592c3624e6eSGrant Likely used otherwise. 35937d721e34SBartlomiej Sieka 35947d721e34SBartlomiej Sieka bootm_size - Memory range available for image processing in the bootm 35957d721e34SBartlomiej Sieka command can be restricted. This variable is given as 35967d721e34SBartlomiej Sieka a hexadecimal number and defines the size of the region 35977d721e34SBartlomiej Sieka allowed for use by the bootm command. See also "bootm_low" 35987d721e34SBartlomiej Sieka environment variable. 35997d721e34SBartlomiej Sieka 36004bae9090SBartlomiej Sieka updatefile - Location of the software update file on a TFTP server, used 36014bae9090SBartlomiej Sieka by the automatic software update feature. Please refer to 36024bae9090SBartlomiej Sieka documentation in doc/README.update for more details. 36034bae9090SBartlomiej Sieka 3604c609719bSwdenk autoload - if set to "no" (any string beginning with 'n'), 3605c609719bSwdenk "bootp" will just load perform a lookup of the 3606c609719bSwdenk configuration from the BOOTP server, but not try to 3607c609719bSwdenk load any image using TFTP 3608c609719bSwdenk 3609c609719bSwdenk autostart - if set to "yes", an image loaded using the "bootp", 3610c609719bSwdenk "rarpboot", "tftpboot" or "diskboot" commands will 3611c609719bSwdenk be automatically started (by internally calling 3612c609719bSwdenk "bootm") 3613c609719bSwdenk 36144a6fd34bSwdenk If set to "no", a standalone image passed to the 36154a6fd34bSwdenk "bootm" command will be copied to the load address 36164a6fd34bSwdenk (and eventually uncompressed), but NOT be started. 36174a6fd34bSwdenk This can be used to load and uncompress arbitrary 36184a6fd34bSwdenk data. 36194a6fd34bSwdenk 3620a28afca5SDavid A. Long fdt_high - if set this restricts the maximum address that the 3621a28afca5SDavid A. Long flattened device tree will be copied into upon boot. 3622a28afca5SDavid A. Long If this is set to the special value 0xFFFFFFFF then 3623a28afca5SDavid A. Long the fdt will not be copied at all on boot. For this 3624a28afca5SDavid A. Long to work it must reside in writable memory, have 3625a28afca5SDavid A. Long sufficient padding on the end of it for u-boot to 3626a28afca5SDavid A. Long add the information it needs into it, and the memory 3627a28afca5SDavid A. Long must be accessible by the kernel. 3628a28afca5SDavid A. Long 3629eea63e05SSimon Glass fdtcontroladdr- if set this is the address of the control flattened 3630eea63e05SSimon Glass device tree used by U-Boot when CONFIG_OF_CONTROL is 3631eea63e05SSimon Glass defined. 3632eea63e05SSimon Glass 363317ea1177Swdenk i2cfast - (PPC405GP|PPC405EP only) 363417ea1177Swdenk if set to 'y' configures Linux I2C driver for fast 363517ea1177Swdenk mode (400kHZ). This environment variable is used in 363617ea1177Swdenk initialization code. So, for changes to be effective 363717ea1177Swdenk it must be saved and board must be reset. 363817ea1177Swdenk 3639c609719bSwdenk initrd_high - restrict positioning of initrd images: 3640c609719bSwdenk If this variable is not set, initrd images will be 3641c609719bSwdenk copied to the highest possible address in RAM; this 3642c609719bSwdenk is usually what you want since it allows for 3643c609719bSwdenk maximum initrd size. If for some reason you want to 3644c609719bSwdenk make sure that the initrd image is loaded below the 36456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BOOTMAPSZ limit, you can set this environment 3646c609719bSwdenk variable to a value of "no" or "off" or "0". 3647c609719bSwdenk Alternatively, you can set it to a maximum upper 3648c609719bSwdenk address to use (U-Boot will still check that it 3649c609719bSwdenk does not overwrite the U-Boot stack and data). 3650c609719bSwdenk 3651c609719bSwdenk For instance, when you have a system with 16 MB 36527152b1d0Swdenk RAM, and want to reserve 4 MB from use by Linux, 3653c609719bSwdenk you can do this by adding "mem=12M" to the value of 3654c609719bSwdenk the "bootargs" variable. However, now you must make 36557152b1d0Swdenk sure that the initrd image is placed in the first 3656c609719bSwdenk 12 MB as well - this can be done with 3657c609719bSwdenk 3658c609719bSwdenk setenv initrd_high 00c00000 3659c609719bSwdenk 366038b99261Swdenk If you set initrd_high to 0xFFFFFFFF, this is an 366138b99261Swdenk indication to U-Boot that all addresses are legal 366238b99261Swdenk for the Linux kernel, including addresses in flash 366338b99261Swdenk memory. In this case U-Boot will NOT COPY the 366438b99261Swdenk ramdisk at all. This may be useful to reduce the 366538b99261Swdenk boot time on your system, but requires that this 366638b99261Swdenk feature is supported by your Linux kernel. 366738b99261Swdenk 3668c609719bSwdenk ipaddr - IP address; needed for tftpboot command 3669c609719bSwdenk 3670c609719bSwdenk loadaddr - Default load address for commands like "bootp", 3671dc7c9a1aSwdenk "rarpboot", "tftpboot", "loadb" or "diskboot" 3672c609719bSwdenk 3673c609719bSwdenk loads_echo - see CONFIG_LOADS_ECHO 3674c609719bSwdenk 3675c609719bSwdenk serverip - TFTP server IP address; needed for tftpboot command 3676c609719bSwdenk 3677c609719bSwdenk bootretry - see CONFIG_BOOT_RETRY_TIME 3678c609719bSwdenk 3679c609719bSwdenk bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR 3680c609719bSwdenk 3681c609719bSwdenk bootstopkey - see CONFIG_AUTOBOOT_STOP_STR 3682c609719bSwdenk 3683e2a53458SMike Frysinger ethprime - controls which interface is used first. 3684a3d991bdSwdenk 3685e2a53458SMike Frysinger ethact - controls which interface is currently active. 3686e2a53458SMike Frysinger For example you can do the following 3687a3d991bdSwdenk 368848690d80SHeiko Schocher => setenv ethact FEC 368948690d80SHeiko Schocher => ping 192.168.0.1 # traffic sent on FEC 369048690d80SHeiko Schocher => setenv ethact SCC 369148690d80SHeiko Schocher => ping 10.0.0.1 # traffic sent on SCC 3692a3d991bdSwdenk 3693e1692577SMatthias Fuchs ethrotate - When set to "no" U-Boot does not go through all 3694e1692577SMatthias Fuchs available network interfaces. 3695e1692577SMatthias Fuchs It just stays at the currently selected interface. 3696e1692577SMatthias Fuchs 3697a3d991bdSwdenk netretry - When set to "no" each network operation will 3698a3d991bdSwdenk either succeed or fail without retrying. 36996e592385Swdenk When set to "once" the network operation will 37006e592385Swdenk fail when all the available network interfaces 37016e592385Swdenk are tried once without success. 3702a3d991bdSwdenk Useful on scripts which control the retry operation 3703a3d991bdSwdenk themselves. 3704a3d991bdSwdenk 3705b4e2f89dSJean-Christophe PLAGNIOL-VILLARD npe_ucode - set load address for the NPE microcode 3706a1cf027aSJean-Christophe PLAGNIOL-VILLARD 370728cb9375SWolfgang Denk tftpsrcport - If this is set, the value is used for TFTP's 3708ecb0ccd9SWolfgang Denk UDP source port. 3709ecb0ccd9SWolfgang Denk 371028cb9375SWolfgang Denk tftpdstport - If this is set, the value is used for TFTP's UDP 371128cb9375SWolfgang Denk destination port instead of the Well Know Port 69. 371228cb9375SWolfgang Denk 3713c96f86eeSWolfgang Denk tftpblocksize - Block size to use for TFTP transfers; if not set, 3714c96f86eeSWolfgang Denk we use the TFTP server's default block size 3715c96f86eeSWolfgang Denk 3716c96f86eeSWolfgang Denk tftptimeout - Retransmission timeout for TFTP packets (in milli- 3717c96f86eeSWolfgang Denk seconds, minimum value is 1000 = 1 second). Defines 3718c96f86eeSWolfgang Denk when a packet is considered to be lost so it has to 3719c96f86eeSWolfgang Denk be retransmitted. The default is 5000 = 5 seconds. 3720c96f86eeSWolfgang Denk Lowering this value may make downloads succeed 3721c96f86eeSWolfgang Denk faster in networks with high packet loss rates or 3722c96f86eeSWolfgang Denk with unreliable TFTP servers. 3723c96f86eeSWolfgang Denk 3724a3d991bdSwdenk vlan - When set to a value < 4095 the traffic over 372511ccc33fSMarcel Ziswiler Ethernet is encapsulated/received over 802.1q 3726a3d991bdSwdenk VLAN tagged frames. 3727c609719bSwdenk 3728dc0b7b0eSJason HobbsThe following image location variables contain the location of images 3729dc0b7b0eSJason Hobbsused in booting. The "Image" column gives the role of the image and is 3730dc0b7b0eSJason Hobbsnot an environment variable name. The other columns are environment 3731dc0b7b0eSJason Hobbsvariable names. "File Name" gives the name of the file on a TFTP 3732dc0b7b0eSJason Hobbsserver, "RAM Address" gives the location in RAM the image will be 3733dc0b7b0eSJason Hobbsloaded to, and "Flash Location" gives the image's address in NOR 3734dc0b7b0eSJason Hobbsflash or offset in NAND flash. 3735dc0b7b0eSJason Hobbs 3736dc0b7b0eSJason Hobbs*Note* - these variables don't have to be defined for all boards, some 3737dc0b7b0eSJason Hobbsboards currenlty use other variables for these purposes, and some 3738dc0b7b0eSJason Hobbsboards use these variables for other purposes. 3739dc0b7b0eSJason Hobbs 3740dc0b7b0eSJason HobbsImage File Name RAM Address Flash Location 3741dc0b7b0eSJason Hobbs----- --------- ----------- -------------- 3742dc0b7b0eSJason Hobbsu-boot u-boot u-boot_addr_r u-boot_addr 3743dc0b7b0eSJason HobbsLinux kernel bootfile kernel_addr_r kernel_addr 3744dc0b7b0eSJason Hobbsdevice tree blob fdtfile fdt_addr_r fdt_addr 3745dc0b7b0eSJason Hobbsramdisk ramdiskfile ramdisk_addr_r ramdisk_addr 3746dc0b7b0eSJason Hobbs 3747c609719bSwdenkThe following environment variables may be used and automatically 3748c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"), 3749c609719bSwdenkdepending the information provided by your boot server: 3750c609719bSwdenk 3751c609719bSwdenk bootfile - see above 3752c609719bSwdenk dnsip - IP address of your Domain Name Server 3753fe389a82Sstroese dnsip2 - IP address of your secondary Domain Name Server 3754c609719bSwdenk gatewayip - IP address of the Gateway (Router) to use 3755c609719bSwdenk hostname - Target hostname 3756c609719bSwdenk ipaddr - see above 3757c609719bSwdenk netmask - Subnet Mask 3758c609719bSwdenk rootpath - Pathname of the root filesystem on the NFS server 3759c609719bSwdenk serverip - see above 3760c609719bSwdenk 3761c609719bSwdenk 3762c609719bSwdenkThere are two special Environment Variables: 3763c609719bSwdenk 3764c609719bSwdenk serial# - contains hardware identification information such 3765c609719bSwdenk as type string and/or serial number 3766c609719bSwdenk ethaddr - Ethernet address 3767c609719bSwdenk 3768c609719bSwdenkThese variables can be set only once (usually during manufacturing of 3769c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables 3770c609719bSwdenkonce they have been set once. 3771c609719bSwdenk 3772c609719bSwdenk 3773c1551ea8SstroeseFurther special Environment Variables: 3774c1551ea8Sstroese 3775c1551ea8Sstroese ver - Contains the U-Boot version string as printed 3776c1551ea8Sstroese with the "version" command. This variable is 3777c1551ea8Sstroese readonly (see CONFIG_VERSION_VARIABLE). 3778c1551ea8Sstroese 3779c1551ea8Sstroese 3780c609719bSwdenkPlease note that changes to some configuration parameters may take 3781c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-). 3782c609719bSwdenk 3783c609719bSwdenk 3784f07771ccSwdenkCommand Line Parsing: 3785f07771ccSwdenk===================== 3786f07771ccSwdenk 3787f07771ccSwdenkThere are two different command line parsers available with U-Boot: 37887152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell: 3789f07771ccSwdenk 3790f07771ccSwdenkOld, simple command line parser: 3791f07771ccSwdenk-------------------------------- 3792f07771ccSwdenk 3793f07771ccSwdenk- supports environment variables (through setenv / saveenv commands) 3794f07771ccSwdenk- several commands on one line, separated by ';' 3795fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax 3796f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\', 3797f07771ccSwdenk for example: 3798fe126d8bSWolfgang Denk setenv bootcmd bootm \${address} 3799f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example: 3800f07771ccSwdenk setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off' 3801f07771ccSwdenk 3802f07771ccSwdenkHush shell: 3803f07771ccSwdenk----------- 3804f07771ccSwdenk 3805f07771ccSwdenk- similar to Bourne shell, with control structures like 3806f07771ccSwdenk if...then...else...fi, for...do...done; while...do...done, 3807f07771ccSwdenk until...do...done, ... 3808f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv 3809f07771ccSwdenk commands) and local shell variables (through standard shell syntax 3810f07771ccSwdenk "name=value"); only environment variables can be used with "run" 3811f07771ccSwdenk command 3812f07771ccSwdenk 3813f07771ccSwdenkGeneral rules: 3814f07771ccSwdenk-------------- 3815f07771ccSwdenk 3816f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run" 3817f07771ccSwdenk command) contains several commands separated by semicolon, and 3818f07771ccSwdenk one of these commands fails, then the remaining commands will be 3819f07771ccSwdenk executed anyway. 3820f07771ccSwdenk 3821f07771ccSwdenk(2) If you execute several variables with one call to run (i. e. 382211ccc33fSMarcel Ziswiler calling run with a list of variables as arguments), any failing 3823f07771ccSwdenk command will cause "run" to terminate, i. e. the remaining 3824f07771ccSwdenk variables are not executed. 3825f07771ccSwdenk 3826c609719bSwdenkNote for Redundant Ethernet Interfaces: 3827c609719bSwdenk======================================= 3828c609719bSwdenk 382911ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports 3830c609719bSwdenksuch configurations and is capable of automatic selection of a 38317152b1d0Swdenk"working" interface when needed. MAC assignment works as follows: 3832c609719bSwdenk 3833c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding 3834c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0), 3835c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ... 3836c609719bSwdenk 3837c609719bSwdenkIf the network interface stores some valid MAC address (for instance 3838c609719bSwdenkin SROM), this is used as default address if there is NO correspon- 3839c609719bSwdenkding setting in the environment; if the corresponding environment 3840c609719bSwdenkvariable is set, this overrides the settings in the card; that means: 3841c609719bSwdenk 3842c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the 3843c609719bSwdenk environment, the SROM's address is used. 3844c609719bSwdenk 3845c609719bSwdenko If there is no valid address in the SROM, and a definition in the 3846c609719bSwdenk environment exists, then the value from the environment variable is 3847c609719bSwdenk used. 3848c609719bSwdenk 3849c609719bSwdenko If both the SROM and the environment contain a MAC address, and 3850c609719bSwdenk both addresses are the same, this MAC address is used. 3851c609719bSwdenk 3852c609719bSwdenko If both the SROM and the environment contain a MAC address, and the 3853c609719bSwdenk addresses differ, the value from the environment is used and a 3854c609719bSwdenk warning is printed. 3855c609719bSwdenk 3856c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error 3857c609719bSwdenk is raised. 3858c609719bSwdenk 3859ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses 3860ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process. This 3861ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable. 3862ecee9324SBen WarrenThe naming convention is as follows: 3863ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc. 3864c609719bSwdenk 3865c609719bSwdenkImage Formats: 3866c609719bSwdenk============== 3867c609719bSwdenk 38683310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on) 38693310c549SMarian Balakowiczimages in two formats: 38703310c549SMarian Balakowicz 38713310c549SMarian BalakowiczNew uImage format (FIT) 38723310c549SMarian Balakowicz----------------------- 38733310c549SMarian Balakowicz 38743310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar 38753310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple 38763310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by 38773310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory. 38783310c549SMarian Balakowicz 38793310c549SMarian Balakowicz 38803310c549SMarian BalakowiczOld uImage format 38813310c549SMarian Balakowicz----------------- 38823310c549SMarian Balakowicz 38833310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything, 38843310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for 38853310c549SMarian Balakowiczdetails; basically, the header defines the following image properties: 3886c609719bSwdenk 3887c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD, 3888c609719bSwdenk 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks, 3889f5ed9e39SPeter Tyser LynxOS, pSOS, QNX, RTEMS, INTEGRITY; 3890f5ed9e39SPeter Tyser Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS, 3891f5ed9e39SPeter Tyser INTEGRITY). 38927b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86, 3893afc1ce82SMacpaul Lin IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit; 3894afc1ce82SMacpaul Lin Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC). 3895c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2) 3896c609719bSwdenk* Load Address 3897c609719bSwdenk* Entry Point 3898c609719bSwdenk* Image Name 3899c609719bSwdenk* Image Timestamp 3900c609719bSwdenk 3901c609719bSwdenkThe header is marked by a special Magic Number, and both the header 3902c609719bSwdenkand the data portions of the image are secured against corruption by 3903c609719bSwdenkCRC32 checksums. 3904c609719bSwdenk 3905c609719bSwdenk 3906c609719bSwdenkLinux Support: 3907c609719bSwdenk============== 3908c609719bSwdenk 3909c609719bSwdenkAlthough U-Boot should support any OS or standalone application 39107152b1d0Swdenkeasily, the main focus has always been on Linux during the design of 3911c609719bSwdenkU-Boot. 3912c609719bSwdenk 3913c609719bSwdenkU-Boot includes many features that so far have been part of some 3914c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any 3915c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image; 3916c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation 39177152b1d0Swdenkserves several purposes: 3918c609719bSwdenk 3919c609719bSwdenk- the same features can be used for other OS or standalone 3920c609719bSwdenk applications (for instance: using compressed images to reduce the 3921c609719bSwdenk Flash memory footprint) 3922c609719bSwdenk 3923c609719bSwdenk- it becomes much easier to port new Linux kernel versions because 39247152b1d0Swdenk lots of low-level, hardware dependent stuff are done by U-Boot 3925c609719bSwdenk 3926c609719bSwdenk- the same Linux kernel image can now be used with different "initrd" 3927c609719bSwdenk images; of course this also means that different kernel images can 3928c609719bSwdenk be run with the same "initrd". This makes testing easier (you don't 3929c609719bSwdenk have to build a new "zImage.initrd" Linux image when you just 3930c609719bSwdenk change a file in your "initrd"). Also, a field-upgrade of the 3931c609719bSwdenk software is easier now. 3932c609719bSwdenk 3933c609719bSwdenk 3934c609719bSwdenkLinux HOWTO: 3935c609719bSwdenk============ 3936c609719bSwdenk 3937c609719bSwdenkPorting Linux to U-Boot based systems: 3938c609719bSwdenk--------------------------------------- 3939c609719bSwdenk 3940c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to 3941c609719bSwdenkconfigure the Linux device drivers for use with your target hardware 3942c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to 3943c609719bSwdenkLinux :-). 3944c609719bSwdenk 3945a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot). 3946c609719bSwdenk 3947c609719bSwdenkJust make sure your machine specific header file (for instance 3948c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board 39491dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h, 39501dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value 39516d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR. 3952c609719bSwdenk 3953c609719bSwdenk 3954c609719bSwdenkConfiguring the Linux kernel: 3955c609719bSwdenk----------------------------- 3956c609719bSwdenk 3957c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root 3958c609719bSwdenkdevice (initial ramdisk, NFS) for your target system. 3959c609719bSwdenk 3960c609719bSwdenk 3961c609719bSwdenkBuilding a Linux Image: 3962c609719bSwdenk----------------------- 3963c609719bSwdenk 396424ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are 396524ee89b9Swdenknot used. If you use recent kernel source, a new build target 396624ee89b9Swdenk"uImage" will exist which automatically builds an image usable by 396724ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target, 396824ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a 396924ee89b9Swdenk100% compatible format. 3970c609719bSwdenk 3971c609719bSwdenkExample: 3972c609719bSwdenk 3973c609719bSwdenk make TQM850L_config 3974c609719bSwdenk make oldconfig 3975c609719bSwdenk make dep 397624ee89b9Swdenk make uImage 3977c609719bSwdenk 397824ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to 397924ee89b9Swdenkencapsulate a compressed Linux kernel image with header information, 398024ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing: 3981c609719bSwdenk 398224ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format): 398324ee89b9Swdenk 398424ee89b9Swdenk* convert the kernel into a raw binary image: 398524ee89b9Swdenk 398624ee89b9Swdenk ${CROSS_COMPILE}-objcopy -O binary \ 398724ee89b9Swdenk -R .note -R .comment \ 398824ee89b9Swdenk -S vmlinux linux.bin 398924ee89b9Swdenk 399024ee89b9Swdenk* compress the binary image: 399124ee89b9Swdenk 399224ee89b9Swdenk gzip -9 linux.bin 399324ee89b9Swdenk 399424ee89b9Swdenk* package compressed binary image for U-Boot: 399524ee89b9Swdenk 399624ee89b9Swdenk mkimage -A ppc -O linux -T kernel -C gzip \ 399724ee89b9Swdenk -a 0 -e 0 -n "Linux Kernel Image" \ 399824ee89b9Swdenk -d linux.bin.gz uImage 399924ee89b9Swdenk 400024ee89b9Swdenk 400124ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use 400224ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or 400324ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64 400424ee89b9Swdenkbyte header containing information about target architecture, 400524ee89b9Swdenkoperating system, image type, compression method, entry points, time 400624ee89b9Swdenkstamp, CRC32 checksums, etc. 400724ee89b9Swdenk 400824ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and 400924ee89b9Swdenkprint the header information, or to build new images. 4010c609719bSwdenk 4011c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information 4012c609719bSwdenkcontained in the header of an existing U-Boot image; this includes 4013c609719bSwdenkchecksum verification: 4014c609719bSwdenk 4015c609719bSwdenk tools/mkimage -l image 4016c609719bSwdenk -l ==> list image header information 4017c609719bSwdenk 4018c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image 4019c609719bSwdenkfrom a "data file" which is used as image payload: 4020c609719bSwdenk 4021c609719bSwdenk tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \ 4022c609719bSwdenk -n name -d data_file image 4023c609719bSwdenk -A ==> set architecture to 'arch' 4024c609719bSwdenk -O ==> set operating system to 'os' 4025c609719bSwdenk -T ==> set image type to 'type' 4026c609719bSwdenk -C ==> set compression type 'comp' 4027c609719bSwdenk -a ==> set load address to 'addr' (hex) 4028c609719bSwdenk -e ==> set entry point to 'ep' (hex) 4029c609719bSwdenk -n ==> set image name to 'name' 4030c609719bSwdenk -d ==> use image data from 'datafile' 4031c609719bSwdenk 403269459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load 403369459791Swdenkaddress (0x00000000), but the entry point address depends on the 403469459791Swdenkkernel version: 4035c609719bSwdenk 4036c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C, 403724ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000. 4038c609719bSwdenk 4039c609719bSwdenkSo a typical call to build a U-Boot image would read: 4040c609719bSwdenk 404124ee89b9Swdenk -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 404224ee89b9Swdenk > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \ 4043a47a12beSStefan Roese > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \ 404424ee89b9Swdenk > examples/uImage.TQM850L 404524ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 4046c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 4047c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 4048c609719bSwdenk Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 4049c609719bSwdenk Load Address: 0x00000000 405024ee89b9Swdenk Entry Point: 0x00000000 4051c609719bSwdenk 4052c609719bSwdenkTo verify the contents of the image (or check for corruption): 4053c609719bSwdenk 405424ee89b9Swdenk -> tools/mkimage -l examples/uImage.TQM850L 405524ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 4056c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 4057c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 4058c609719bSwdenk Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 4059c609719bSwdenk Load Address: 0x00000000 406024ee89b9Swdenk Entry Point: 0x00000000 4061c609719bSwdenk 4062c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade 4063c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this 4064c609719bSwdenkneeds more space in Flash, but boots much faster since it does not 4065c609719bSwdenkneed to be uncompressed: 4066c609719bSwdenk 4067a47a12beSStefan Roese -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz 406824ee89b9Swdenk -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 406924ee89b9Swdenk > -A ppc -O linux -T kernel -C none -a 0 -e 0 \ 4070a47a12beSStefan Roese > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \ 407124ee89b9Swdenk > examples/uImage.TQM850L-uncompressed 407224ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 4073c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 4074c609719bSwdenk Image Type: PowerPC Linux Kernel Image (uncompressed) 4075c609719bSwdenk Data Size: 792160 Bytes = 773.59 kB = 0.76 MB 4076c609719bSwdenk Load Address: 0x00000000 407724ee89b9Swdenk Entry Point: 0x00000000 4078c609719bSwdenk 4079c609719bSwdenk 4080c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file 4081c609719bSwdenkwhen your kernel is intended to use an initial ramdisk: 4082c609719bSwdenk 4083c609719bSwdenk -> tools/mkimage -n 'Simple Ramdisk Image' \ 4084c609719bSwdenk > -A ppc -O linux -T ramdisk -C gzip \ 4085c609719bSwdenk > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd 4086c609719bSwdenk Image Name: Simple Ramdisk Image 4087c609719bSwdenk Created: Wed Jan 12 14:01:50 2000 4088c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 4089c609719bSwdenk Data Size: 566530 Bytes = 553.25 kB = 0.54 MB 4090c609719bSwdenk Load Address: 0x00000000 4091c609719bSwdenk Entry Point: 0x00000000 4092c609719bSwdenk 4093c609719bSwdenk 4094c609719bSwdenkInstalling a Linux Image: 4095c609719bSwdenk------------------------- 4096c609719bSwdenk 4097c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface, 4098c609719bSwdenkyou must convert the image to S-Record format: 4099c609719bSwdenk 4100c609719bSwdenk objcopy -I binary -O srec examples/image examples/image.srec 4101c609719bSwdenk 4102c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot 4103c609719bSwdenkimage header, so the resulting S-Record file will be relative to 4104c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to 4105c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads' 4106c609719bSwdenkcommand. 4107c609719bSwdenk 4108c609719bSwdenkExample: install the image to address 0x40100000 (which on the 4109c609719bSwdenkTQM8xxL is in the first Flash bank): 4110c609719bSwdenk 4111c609719bSwdenk => erase 40100000 401FFFFF 4112c609719bSwdenk 4113c609719bSwdenk .......... done 4114c609719bSwdenk Erased 8 sectors 4115c609719bSwdenk 4116c609719bSwdenk => loads 40100000 4117c609719bSwdenk ## Ready for S-Record download ... 4118c609719bSwdenk ~>examples/image.srec 4119c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 12 13 ... 4120c609719bSwdenk ... 4121c609719bSwdenk 15989 15990 15991 15992 4122c609719bSwdenk [file transfer complete] 4123c609719bSwdenk [connected] 4124c609719bSwdenk ## Start Addr = 0x00000000 4125c609719bSwdenk 4126c609719bSwdenk 4127c609719bSwdenkYou can check the success of the download using the 'iminfo' command; 4128c609719bSwdenkthis includes a checksum verification so you can be sure no data 4129c609719bSwdenkcorruption happened: 4130c609719bSwdenk 4131c609719bSwdenk => imi 40100000 4132c609719bSwdenk 4133c609719bSwdenk ## Checking Image at 40100000 ... 4134c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 4135c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 4136c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 4137c609719bSwdenk Load Address: 00000000 4138c609719bSwdenk Entry Point: 0000000c 4139c609719bSwdenk Verifying Checksum ... OK 4140c609719bSwdenk 4141c609719bSwdenk 4142c609719bSwdenkBoot Linux: 4143c609719bSwdenk----------- 4144c609719bSwdenk 4145c609719bSwdenkThe "bootm" command is used to boot an application that is stored in 4146c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents 4147c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as 4148c609719bSwdenkparameters. You can check and modify this variable using the 4149c609719bSwdenk"printenv" and "setenv" commands: 4150c609719bSwdenk 4151c609719bSwdenk 4152c609719bSwdenk => printenv bootargs 4153c609719bSwdenk bootargs=root=/dev/ram 4154c609719bSwdenk 4155c609719bSwdenk => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 4156c609719bSwdenk 4157c609719bSwdenk => printenv bootargs 4158c609719bSwdenk bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 4159c609719bSwdenk 4160c609719bSwdenk => bootm 40020000 4161c609719bSwdenk ## Booting Linux kernel at 40020000 ... 4162c609719bSwdenk Image Name: 2.2.13 for NFS on TQM850L 4163c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 4164c609719bSwdenk Data Size: 381681 Bytes = 372 kB = 0 MB 4165c609719bSwdenk Load Address: 00000000 4166c609719bSwdenk Entry Point: 0000000c 4167c609719bSwdenk Verifying Checksum ... OK 4168c609719bSwdenk Uncompressing Kernel Image ... OK 4169c609719bSwdenk 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 4170c609719bSwdenk Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 4171c609719bSwdenk time_init: decrementer frequency = 187500000/60 4172c609719bSwdenk Calibrating delay loop... 49.77 BogoMIPS 4173c609719bSwdenk Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000] 4174c609719bSwdenk ... 4175c609719bSwdenk 417611ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass 41777152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT 4178c609719bSwdenkformat!) to the "bootm" command: 4179c609719bSwdenk 4180c609719bSwdenk => imi 40100000 40200000 4181c609719bSwdenk 4182c609719bSwdenk ## Checking Image at 40100000 ... 4183c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 4184c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 4185c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 4186c609719bSwdenk Load Address: 00000000 4187c609719bSwdenk Entry Point: 0000000c 4188c609719bSwdenk Verifying Checksum ... OK 4189c609719bSwdenk 4190c609719bSwdenk ## Checking Image at 40200000 ... 4191c609719bSwdenk Image Name: Simple Ramdisk Image 4192c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 4193c609719bSwdenk Data Size: 566530 Bytes = 553 kB = 0 MB 4194c609719bSwdenk Load Address: 00000000 4195c609719bSwdenk Entry Point: 00000000 4196c609719bSwdenk Verifying Checksum ... OK 4197c609719bSwdenk 4198c609719bSwdenk => bootm 40100000 40200000 4199c609719bSwdenk ## Booting Linux kernel at 40100000 ... 4200c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 4201c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 4202c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 4203c609719bSwdenk Load Address: 00000000 4204c609719bSwdenk Entry Point: 0000000c 4205c609719bSwdenk Verifying Checksum ... OK 4206c609719bSwdenk Uncompressing Kernel Image ... OK 4207c609719bSwdenk ## Loading RAMDisk Image at 40200000 ... 4208c609719bSwdenk Image Name: Simple Ramdisk Image 4209c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 4210c609719bSwdenk Data Size: 566530 Bytes = 553 kB = 0 MB 4211c609719bSwdenk Load Address: 00000000 4212c609719bSwdenk Entry Point: 00000000 4213c609719bSwdenk Verifying Checksum ... OK 4214c609719bSwdenk Loading Ramdisk ... OK 4215c609719bSwdenk 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 4216c609719bSwdenk Boot arguments: root=/dev/ram 4217c609719bSwdenk time_init: decrementer frequency = 187500000/60 4218c609719bSwdenk Calibrating delay loop... 49.77 BogoMIPS 4219c609719bSwdenk ... 4220c609719bSwdenk RAMDISK: Compressed image found at block 0 4221c609719bSwdenk VFS: Mounted root (ext2 filesystem). 4222c609719bSwdenk 4223c609719bSwdenk bash# 4224c609719bSwdenk 42250267768eSMatthew McClintockBoot Linux and pass a flat device tree: 42260267768eSMatthew McClintock----------- 42270267768eSMatthew McClintock 42280267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section 42290267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The 42300267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated 42310267768eSMatthew McClintockflat device tree: 42320267768eSMatthew McClintock 42330267768eSMatthew McClintock=> print oftaddr 42340267768eSMatthew McClintockoftaddr=0x300000 42350267768eSMatthew McClintock=> print oft 42360267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb 42370267768eSMatthew McClintock=> tftp $oftaddr $oft 42380267768eSMatthew McClintockSpeed: 1000, full duplex 42390267768eSMatthew McClintockUsing TSEC0 device 42400267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101 42410267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'. 42420267768eSMatthew McClintockLoad address: 0x300000 42430267768eSMatthew McClintockLoading: # 42440267768eSMatthew McClintockdone 42450267768eSMatthew McClintockBytes transferred = 4106 (100a hex) 42460267768eSMatthew McClintock=> tftp $loadaddr $bootfile 42470267768eSMatthew McClintockSpeed: 1000, full duplex 42480267768eSMatthew McClintockUsing TSEC0 device 42490267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2 42500267768eSMatthew McClintockFilename 'uImage'. 42510267768eSMatthew McClintockLoad address: 0x200000 42520267768eSMatthew McClintockLoading:############ 42530267768eSMatthew McClintockdone 42540267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex) 42550267768eSMatthew McClintock=> print loadaddr 42560267768eSMatthew McClintockloadaddr=200000 42570267768eSMatthew McClintock=> print oftaddr 42580267768eSMatthew McClintockoftaddr=0x300000 42590267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr 42600267768eSMatthew McClintock## Booting image at 00200000 ... 42610267768eSMatthew McClintock Image Name: Linux-2.6.17-dirty 42620267768eSMatthew McClintock Image Type: PowerPC Linux Kernel Image (gzip compressed) 42630267768eSMatthew McClintock Data Size: 1029343 Bytes = 1005.2 kB 42640267768eSMatthew McClintock Load Address: 00000000 42650267768eSMatthew McClintock Entry Point: 00000000 42660267768eSMatthew McClintock Verifying Checksum ... OK 42670267768eSMatthew McClintock Uncompressing Kernel Image ... OK 42680267768eSMatthew McClintockBooting using flat device tree at 0x300000 42690267768eSMatthew McClintockUsing MPC85xx ADS machine description 42700267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb 42710267768eSMatthew McClintock[snip] 42720267768eSMatthew McClintock 42730267768eSMatthew McClintock 42746069ff26SwdenkMore About U-Boot Image Types: 42756069ff26Swdenk------------------------------ 42766069ff26Swdenk 42776069ff26SwdenkU-Boot supports the following image types: 42786069ff26Swdenk 42796069ff26Swdenk "Standalone Programs" are directly runnable in the environment 42806069ff26Swdenk provided by U-Boot; it is expected that (if they behave 42816069ff26Swdenk well) you can continue to work in U-Boot after return from 42826069ff26Swdenk the Standalone Program. 42836069ff26Swdenk "OS Kernel Images" are usually images of some Embedded OS which 42846069ff26Swdenk will take over control completely. Usually these programs 42856069ff26Swdenk will install their own set of exception handlers, device 42866069ff26Swdenk drivers, set up the MMU, etc. - this means, that you cannot 42876069ff26Swdenk expect to re-enter U-Boot except by resetting the CPU. 42886069ff26Swdenk "RAMDisk Images" are more or less just data blocks, and their 42896069ff26Swdenk parameters (address, size) are passed to an OS kernel that is 42906069ff26Swdenk being started. 42916069ff26Swdenk "Multi-File Images" contain several images, typically an OS 42926069ff26Swdenk (Linux) kernel image and one or more data images like 42936069ff26Swdenk RAMDisks. This construct is useful for instance when you want 42946069ff26Swdenk to boot over the network using BOOTP etc., where the boot 42956069ff26Swdenk server provides just a single image file, but you want to get 42966069ff26Swdenk for instance an OS kernel and a RAMDisk image. 42976069ff26Swdenk 42986069ff26Swdenk "Multi-File Images" start with a list of image sizes, each 42996069ff26Swdenk image size (in bytes) specified by an "uint32_t" in network 43006069ff26Swdenk byte order. This list is terminated by an "(uint32_t)0". 43016069ff26Swdenk Immediately after the terminating 0 follow the images, one by 43026069ff26Swdenk one, all aligned on "uint32_t" boundaries (size rounded up to 43036069ff26Swdenk a multiple of 4 bytes). 43046069ff26Swdenk 43056069ff26Swdenk "Firmware Images" are binary images containing firmware (like 43066069ff26Swdenk U-Boot or FPGA images) which usually will be programmed to 43076069ff26Swdenk flash memory. 43086069ff26Swdenk 43096069ff26Swdenk "Script files" are command sequences that will be executed by 43106069ff26Swdenk U-Boot's command interpreter; this feature is especially 43116069ff26Swdenk useful when you configure U-Boot to use a real shell (hush) 43126069ff26Swdenk as command interpreter. 43136069ff26Swdenk 4314c609719bSwdenk 4315c609719bSwdenkStandalone HOWTO: 4316c609719bSwdenk================= 4317c609719bSwdenk 4318c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and 4319c609719bSwdenkrun "standalone" applications, which can use some resources of 4320c609719bSwdenkU-Boot like console I/O functions or interrupt services. 4321c609719bSwdenk 4322c609719bSwdenkTwo simple examples are included with the sources: 4323c609719bSwdenk 4324c609719bSwdenk"Hello World" Demo: 4325c609719bSwdenk------------------- 4326c609719bSwdenk 4327c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo 4328c609719bSwdenkapplication; it is automatically compiled when you build U-Boot. 4329c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it 4330c609719bSwdenklike that: 4331c609719bSwdenk 4332c609719bSwdenk => loads 4333c609719bSwdenk ## Ready for S-Record download ... 4334c609719bSwdenk ~>examples/hello_world.srec 4335c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 ... 4336c609719bSwdenk [file transfer complete] 4337c609719bSwdenk [connected] 4338c609719bSwdenk ## Start Addr = 0x00040004 4339c609719bSwdenk 4340c609719bSwdenk => go 40004 Hello World! This is a test. 4341c609719bSwdenk ## Starting application at 0x00040004 ... 4342c609719bSwdenk Hello World 4343c609719bSwdenk argc = 7 4344c609719bSwdenk argv[0] = "40004" 4345c609719bSwdenk argv[1] = "Hello" 4346c609719bSwdenk argv[2] = "World!" 4347c609719bSwdenk argv[3] = "This" 4348c609719bSwdenk argv[4] = "is" 4349c609719bSwdenk argv[5] = "a" 4350c609719bSwdenk argv[6] = "test." 4351c609719bSwdenk argv[7] = "<NULL>" 4352c609719bSwdenk Hit any key to exit ... 4353c609719bSwdenk 4354c609719bSwdenk ## Application terminated, rc = 0x0 4355c609719bSwdenk 4356c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt 4357c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'. 4358c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second. 4359c609719bSwdenkThe interrupt service routine is trivial, just printing a '.' 4360c609719bSwdenkcharacter, but this is just a demo program. The application can be 4361c609719bSwdenkcontrolled by the following keys: 4362c609719bSwdenk 4363c609719bSwdenk ? - print current values og the CPM Timer registers 4364c609719bSwdenk b - enable interrupts and start timer 4365c609719bSwdenk e - stop timer and disable interrupts 4366c609719bSwdenk q - quit application 4367c609719bSwdenk 4368c609719bSwdenk => loads 4369c609719bSwdenk ## Ready for S-Record download ... 4370c609719bSwdenk ~>examples/timer.srec 4371c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 ... 4372c609719bSwdenk [file transfer complete] 4373c609719bSwdenk [connected] 4374c609719bSwdenk ## Start Addr = 0x00040004 4375c609719bSwdenk 4376c609719bSwdenk => go 40004 4377c609719bSwdenk ## Starting application at 0x00040004 ... 4378c609719bSwdenk TIMERS=0xfff00980 4379c609719bSwdenk Using timer 1 4380c609719bSwdenk tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0 4381c609719bSwdenk 4382c609719bSwdenkHit 'b': 4383c609719bSwdenk [q, b, e, ?] Set interval 1000000 us 4384c609719bSwdenk Enabling timer 4385c609719bSwdenkHit '?': 4386c609719bSwdenk [q, b, e, ?] ........ 4387c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0 4388c609719bSwdenkHit '?': 4389c609719bSwdenk [q, b, e, ?] . 4390c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0 4391c609719bSwdenkHit '?': 4392c609719bSwdenk [q, b, e, ?] . 4393c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0 4394c609719bSwdenkHit '?': 4395c609719bSwdenk [q, b, e, ?] . 4396c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0 4397c609719bSwdenkHit 'e': 4398c609719bSwdenk [q, b, e, ?] ...Stopping timer 4399c609719bSwdenkHit 'q': 4400c609719bSwdenk [q, b, e, ?] ## Application terminated, rc = 0x0 4401c609719bSwdenk 4402c609719bSwdenk 440385ec0bccSwdenkMinicom warning: 440485ec0bccSwdenk================ 440585ec0bccSwdenk 44067152b1d0SwdenkOver time, many people have reported problems when trying to use the 440785ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd) 440885ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under 4409f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and 441085ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and 441185ec0bccSwdenkuse "cu" for S-Record download ("loads" command). 441285ec0bccSwdenk 441352f52c14SwdenkNevertheless, if you absolutely want to use it try adding this 441452f52c14Swdenkconfiguration to your "File transfer protocols" section: 441552f52c14Swdenk 441652f52c14Swdenk Name Program Name U/D FullScr IO-Red. Multi 441752f52c14Swdenk X kermit /usr/bin/kermit -i -l %l -s Y U Y N N 441852f52c14Swdenk Y kermit /usr/bin/kermit -i -l %l -r N D Y N N 441952f52c14Swdenk 442052f52c14Swdenk 4421c609719bSwdenkNetBSD Notes: 4422c609719bSwdenk============= 4423c609719bSwdenk 4424c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host 4425c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx). 4426c609719bSwdenk 4427c609719bSwdenkBuilding requires a cross environment; it is known to work on 4428c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also 4429c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make). 4430c609719bSwdenkNote that the cross-powerpc package does not install include files; 4431c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is 4432c609719bSwdenkmissing. This file has to be installed and patched manually: 4433c609719bSwdenk 4434c609719bSwdenk # cd /usr/pkg/cross/powerpc-netbsd/include 4435c609719bSwdenk # mkdir powerpc 4436c609719bSwdenk # ln -s powerpc machine 4437c609719bSwdenk # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h 4438c609719bSwdenk # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST 4439c609719bSwdenk 4440c609719bSwdenkNative builds *don't* work due to incompatibilities between native 4441c609719bSwdenkand U-Boot include files. 4442c609719bSwdenk 4443c609719bSwdenkBooting assumes that (the first part of) the image booted is a 4444c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel 4445c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source 4446c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the 44472a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz 4448c609719bSwdenk 4449c609719bSwdenk 4450c609719bSwdenkImplementation Internals: 4451c609719bSwdenk========================= 4452c609719bSwdenk 4453c609719bSwdenkThe following is not intended to be a complete description of every 4454c609719bSwdenkimplementation detail. However, it should help to understand the 4455c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom 4456c609719bSwdenkhardware. 4457c609719bSwdenk 4458c609719bSwdenk 4459c609719bSwdenkInitial Stack, Global Data: 4460c609719bSwdenk--------------------------- 4461c609719bSwdenk 4462c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot 4463c609719bSwdenkstarts running out of ROM (flash memory), usually without access to 4464c609719bSwdenksystem RAM (because the memory controller is not initialized yet). 4465c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS 4466c609719bSwdenkis not initialized as zero. To be able to get a C environment working 4467c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation 4468c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU 4469c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and 4470c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be 4471c609719bSwdenklocked as (mis-) used as memory, etc. 4472c609719bSwdenk 44737152b1d0Swdenk Chris Hallinan posted a good summary of these issues to the 44740668236bSWolfgang Denk U-Boot mailing list: 447543d9616cSwdenk 447643d9616cSwdenk Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)? 447743d9616cSwdenk From: "Chris Hallinan" <clh@net1plus.com> 447843d9616cSwdenk Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET) 447943d9616cSwdenk ... 448043d9616cSwdenk 448143d9616cSwdenk Correct me if I'm wrong, folks, but the way I understand it 448243d9616cSwdenk is this: Using DCACHE as initial RAM for Stack, etc, does not 448343d9616cSwdenk require any physical RAM backing up the cache. The cleverness 448443d9616cSwdenk is that the cache is being used as a temporary supply of 448543d9616cSwdenk necessary storage before the SDRAM controller is setup. It's 448611ccc33fSMarcel Ziswiler beyond the scope of this list to explain the details, but you 448743d9616cSwdenk can see how this works by studying the cache architecture and 448843d9616cSwdenk operation in the architecture and processor-specific manuals. 448943d9616cSwdenk 449043d9616cSwdenk OCM is On Chip Memory, which I believe the 405GP has 4K. It 449143d9616cSwdenk is another option for the system designer to use as an 449211ccc33fSMarcel Ziswiler initial stack/RAM area prior to SDRAM being available. Either 449343d9616cSwdenk option should work for you. Using CS 4 should be fine if your 449443d9616cSwdenk board designers haven't used it for something that would 449543d9616cSwdenk cause you grief during the initial boot! It is frequently not 449643d9616cSwdenk used. 449743d9616cSwdenk 44986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere 449943d9616cSwdenk with your processor/board/system design. The default value 450043d9616cSwdenk you will find in any recent u-boot distribution in 45018a316c9bSStefan Roese walnut.h should work for you. I'd set it to a value larger 450243d9616cSwdenk than your SDRAM module. If you have a 64MB SDRAM module, set 450343d9616cSwdenk it above 400_0000. Just make sure your board has no resources 450443d9616cSwdenk that are supposed to respond to that address! That code in 450543d9616cSwdenk start.S has been around a while and should work as is when 450643d9616cSwdenk you get the config right. 450743d9616cSwdenk 450843d9616cSwdenk -Chris Hallinan 450943d9616cSwdenk DS4.COM, Inc. 451043d9616cSwdenk 4511c609719bSwdenkIt is essential to remember this, since it has some impact on the C 4512c609719bSwdenkcode for the initialization procedures: 4513c609719bSwdenk 4514c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt 4515c609719bSwdenk to write it. 4516c609719bSwdenk 451711ccc33fSMarcel Ziswiler* Do not use any uninitialized global data (or implicitely initialized 4518c609719bSwdenk as zero data - BSS segment) at all - this is undefined, initiali- 45197152b1d0Swdenk zation is performed later (when relocating to RAM). 4520c609719bSwdenk 4521c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like 4522c609719bSwdenk that. 4523c609719bSwdenk 4524c609719bSwdenkHaving only the stack as writable memory limits means we cannot use 4525c609719bSwdenknormal global data to share information beween the code. But it 4526c609719bSwdenkturned out that the implementation of U-Boot can be greatly 4527c609719bSwdenksimplified by making a global data structure (gd_t) available to all 4528c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_ 4529c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of 4530c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we 4531c609719bSwdenkplace a pointer (gd) to the global data into a register which we 4532c609719bSwdenkreserve for this purpose. 4533c609719bSwdenk 45347152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the 4535c609719bSwdenkrelevant (E)ABI specifications for the current architecture, and by 4536c609719bSwdenkGCC's implementation. 4537c609719bSwdenk 4538c609719bSwdenkFor PowerPC, the following registers have specific use: 4539c609719bSwdenk R1: stack pointer 4540e7670f6cSWolfgang Denk R2: reserved for system use 4541c609719bSwdenk R3-R4: parameter passing and return values 4542c609719bSwdenk R5-R10: parameter passing 4543c609719bSwdenk R13: small data area pointer 4544c609719bSwdenk R30: GOT pointer 4545c609719bSwdenk R31: frame pointer 4546c609719bSwdenk 4547e6bee808SJoakim Tjernlund (U-Boot also uses R12 as internal GOT pointer. r12 4548e6bee808SJoakim Tjernlund is a volatile register so r12 needs to be reset when 4549e6bee808SJoakim Tjernlund going back and forth between asm and C) 4550c609719bSwdenk 4551e7670f6cSWolfgang Denk ==> U-Boot will use R2 to hold a pointer to the global data 4552c609719bSwdenk 4553c609719bSwdenk Note: on PPC, we could use a static initializer (since the 4554c609719bSwdenk address of the global data structure is known at compile time), 4555c609719bSwdenk but it turned out that reserving a register results in somewhat 4556c609719bSwdenk smaller code - although the code savings are not that big (on 4557c609719bSwdenk average for all boards 752 bytes for the whole U-Boot image, 4558c609719bSwdenk 624 text + 127 data). 4559c609719bSwdenk 4560c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here: 45614c58eb55SMike Frysinger http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface 45624c58eb55SMike Frysinger 4563c4db335cSRobin Getz ==> U-Boot will use P3 to hold a pointer to the global data 45644c58eb55SMike Frysinger 4565c609719bSwdenkOn ARM, the following registers are used: 4566c609719bSwdenk 4567c609719bSwdenk R0: function argument word/integer result 4568c609719bSwdenk R1-R3: function argument word 4569c609719bSwdenk R9: GOT pointer 4570c609719bSwdenk R10: stack limit (used only if stack checking if enabled) 4571c609719bSwdenk R11: argument (frame) pointer 4572c609719bSwdenk R12: temporary workspace 4573c609719bSwdenk R13: stack pointer 4574c609719bSwdenk R14: link register 4575c609719bSwdenk R15: program counter 4576c609719bSwdenk 4577c609719bSwdenk ==> U-Boot will use R8 to hold a pointer to the global data 4578c609719bSwdenk 45790df01fd3SThomas ChouOn Nios II, the ABI is documented here: 45800df01fd3SThomas Chou http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf 45810df01fd3SThomas Chou 45820df01fd3SThomas Chou ==> U-Boot will use gp to hold a pointer to the global data 45830df01fd3SThomas Chou 45840df01fd3SThomas Chou Note: on Nios II, we give "-G0" option to gcc and don't use gp 45850df01fd3SThomas Chou to access small data sections, so gp is free. 45860df01fd3SThomas Chou 4587afc1ce82SMacpaul LinOn NDS32, the following registers are used: 4588afc1ce82SMacpaul Lin 4589afc1ce82SMacpaul Lin R0-R1: argument/return 4590afc1ce82SMacpaul Lin R2-R5: argument 4591afc1ce82SMacpaul Lin R15: temporary register for assembler 4592afc1ce82SMacpaul Lin R16: trampoline register 4593afc1ce82SMacpaul Lin R28: frame pointer (FP) 4594afc1ce82SMacpaul Lin R29: global pointer (GP) 4595afc1ce82SMacpaul Lin R30: link register (LP) 4596afc1ce82SMacpaul Lin R31: stack pointer (SP) 4597afc1ce82SMacpaul Lin PC: program counter (PC) 4598afc1ce82SMacpaul Lin 4599afc1ce82SMacpaul Lin ==> U-Boot will use R10 to hold a pointer to the global data 4600afc1ce82SMacpaul Lin 4601d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope, 4602d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much. 4603c609719bSwdenk 4604c609719bSwdenkMemory Management: 4605c609719bSwdenk------------------ 4606c609719bSwdenk 4607c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the 4608c609719bSwdenkMMU is not used either for address mapping nor for memory protection. 4609c609719bSwdenk 4610c609719bSwdenkThe available memory is mapped to fixed addresses using the memory 4611c609719bSwdenkcontroller. In this process, a contiguous block is formed for each 4612c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several 4613c609719bSwdenkphysical memory banks. 4614c609719bSwdenk 4615c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on 4616c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After 4617c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself 4618c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some 46196d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN 4620c609719bSwdenkconfiguration setting]. Below that, a structure with global Board 4621c609719bSwdenkInfo data is placed, followed by the stack (growing downward). 4622c609719bSwdenk 4623c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB 4624c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF). 4625c609719bSwdenk 4626c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like 4627c609719bSwdenkthis: 4628c609719bSwdenk 4629c609719bSwdenk 0x0000 0000 Exception Vector code 4630c609719bSwdenk : 4631c609719bSwdenk 0x0000 1FFF 4632c609719bSwdenk 0x0000 2000 Free for Application Use 4633c609719bSwdenk : 4634c609719bSwdenk : 4635c609719bSwdenk 4636c609719bSwdenk : 4637c609719bSwdenk : 4638c609719bSwdenk 0x00FB FF20 Monitor Stack (Growing downward) 4639c609719bSwdenk 0x00FB FFAC Board Info Data and permanent copy of global data 4640c609719bSwdenk 0x00FC 0000 Malloc Arena 4641c609719bSwdenk : 4642c609719bSwdenk 0x00FD FFFF 4643c609719bSwdenk 0x00FE 0000 RAM Copy of Monitor Code 4644c609719bSwdenk ... eventually: LCD or video framebuffer 4645c609719bSwdenk ... eventually: pRAM (Protected RAM - unchanged by reset) 4646c609719bSwdenk 0x00FF FFFF [End of RAM] 4647c609719bSwdenk 4648c609719bSwdenk 4649c609719bSwdenkSystem Initialization: 4650c609719bSwdenk---------------------- 4651c609719bSwdenk 4652c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point 465311ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset 4654c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory. 46557152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address. 4656c609719bSwdenkTo be able to implement the initialization code in C, a (small!) 4657c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs 4658c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked 4659c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core, 4660c609719bSwdenkthe caches and the SIU. 4661c609719bSwdenk 4662c609719bSwdenkNext, all (potentially) available memory banks are mapped using a 4663c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries 4664c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash 4665c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is 4666c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a 4667c609719bSwdenksimple memory test is run that determines the size of the SDRAM 4668c609719bSwdenkbanks. 4669c609719bSwdenk 4670c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of 46717152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first 4672c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address 4673c609719bSwdenk0x00000000, with any additional banks following immediately to create 4674c609719bSwdenkcontiguous memory starting from 0. 4675c609719bSwdenk 4676c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area 4677c609719bSwdenkand allocates memory for use by malloc() and for the global Board 4678c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM 4679c609719bSwdenkpages, and the final stack is set up. 4680c609719bSwdenk 4681c609719bSwdenkOnly after this relocation will you have a "normal" C environment; 4682c609719bSwdenkuntil that you are restricted in several ways, mostly because you are 4683c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a 4684c609719bSwdenknew address in RAM. 4685c609719bSwdenk 4686c609719bSwdenk 4687c609719bSwdenkU-Boot Porting Guide: 4688c609719bSwdenk---------------------- 4689c609719bSwdenk 4690c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing 46916aff3115Swdenklist, October 2002] 4692c609719bSwdenk 4693c609719bSwdenk 4694c609719bSwdenkint main(int argc, char *argv[]) 4695c609719bSwdenk{ 4696c609719bSwdenk sighandler_t no_more_time; 4697c609719bSwdenk 4698c609719bSwdenk signal(SIGALRM, no_more_time); 4699c609719bSwdenk alarm(PROJECT_DEADLINE - toSec (3 * WEEK)); 4700c609719bSwdenk 4701c609719bSwdenk if (available_money > available_manpower) { 47026c3fef28SJerry Van Baren Pay consultant to port U-Boot; 4703c609719bSwdenk return 0; 4704c609719bSwdenk } 4705c609719bSwdenk 4706c609719bSwdenk Download latest U-Boot source; 4707c609719bSwdenk 47080668236bSWolfgang Denk Subscribe to u-boot mailing list; 47096aff3115Swdenk 47106c3fef28SJerry Van Baren if (clueless) 4711c609719bSwdenk email("Hi, I am new to U-Boot, how do I get started?"); 4712c609719bSwdenk 4713c609719bSwdenk while (learning) { 4714c609719bSwdenk Read the README file in the top level directory; 47157cb22f97Swdenk Read http://www.denx.de/twiki/bin/view/DULG/Manual; 47166c3fef28SJerry Van Baren Read applicable doc/*.README; 4717c609719bSwdenk Read the source, Luke; 47186c3fef28SJerry Van Baren /* find . -name "*.[chS]" | xargs grep -i <keyword> */ 4719c609719bSwdenk } 4720c609719bSwdenk 47216c3fef28SJerry Van Baren if (available_money > toLocalCurrency ($2500)) 47226c3fef28SJerry Van Baren Buy a BDI3000; 47236c3fef28SJerry Van Baren else 4724c609719bSwdenk Add a lot of aggravation and time; 4725c609719bSwdenk 47266c3fef28SJerry Van Baren if (a similar board exists) { /* hopefully... */ 47276c3fef28SJerry Van Baren cp -a board/<similar> board/<myboard> 47286c3fef28SJerry Van Baren cp include/configs/<similar>.h include/configs/<myboard>.h 47296c3fef28SJerry Van Baren } else { 4730c609719bSwdenk Create your own board support subdirectory; 47316c3fef28SJerry Van Baren Create your own board include/configs/<myboard>.h file; 47326c3fef28SJerry Van Baren } 47336c3fef28SJerry Van Baren Edit new board/<myboard> files 47346c3fef28SJerry Van Baren Edit new include/configs/<myboard>.h 4735c609719bSwdenk 47366c3fef28SJerry Van Baren while (!accepted) { 4737c609719bSwdenk while (!running) { 4738c609719bSwdenk do { 4739c609719bSwdenk Add / modify source code; 4740c609719bSwdenk } until (compiles); 4741c609719bSwdenk Debug; 4742c609719bSwdenk if (clueless) 4743c609719bSwdenk email("Hi, I am having problems..."); 4744c609719bSwdenk } 47456c3fef28SJerry Van Baren Send patch file to the U-Boot email list; 47466c3fef28SJerry Van Baren if (reasonable critiques) 47476c3fef28SJerry Van Baren Incorporate improvements from email list code review; 47486c3fef28SJerry Van Baren else 47496c3fef28SJerry Van Baren Defend code as written; 47506c3fef28SJerry Van Baren } 4751c609719bSwdenk 4752c609719bSwdenk return 0; 4753c609719bSwdenk} 4754c609719bSwdenk 4755c609719bSwdenkvoid no_more_time (int sig) 4756c609719bSwdenk{ 4757c609719bSwdenk hire_a_guru(); 4758c609719bSwdenk} 4759c609719bSwdenk 4760c609719bSwdenk 4761c609719bSwdenkCoding Standards: 4762c609719bSwdenk----------------- 4763c609719bSwdenk 4764c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel 47652c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script 47667ca9296eSWolfgang Denk"scripts/Lindent" in your Linux kernel source directory. 4767c609719bSwdenk 47682c051651SDetlev ZundelSource files originating from a different project (for example the 47692c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not 47702c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those 47712c051651SDetlev Zundelsources. 47722c051651SDetlev Zundel 47732c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in 47742c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//) 47752c051651SDetlev Zundelin your code. 4776c609719bSwdenk 4777c178d3daSwdenkPlease also stick to the following formatting rules: 4778180d3f74Swdenk- remove any trailing white space 47797ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces 4780180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds 47817ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files 4782180d3f74Swdenk- do not add trailing empty lines to source files 4783180d3f74Swdenk 4784c609719bSwdenkSubmissions which do not conform to the standards may be returned 4785c609719bSwdenkwith a request to reformat the changes. 4786c609719bSwdenk 4787c609719bSwdenk 4788c609719bSwdenkSubmitting Patches: 4789c609719bSwdenk------------------- 4790c609719bSwdenk 4791c609719bSwdenkSince the number of patches for U-Boot is growing, we need to 4792c609719bSwdenkestablish some rules. Submissions which do not conform to these rules 4793c609719bSwdenkmay be rejected, even when they contain important and valuable stuff. 4794c609719bSwdenk 47950d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details. 4796218ca724SWolfgang Denk 47970668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>; 47980668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot 47990668236bSWolfgang Denk 4800c609719bSwdenkWhen you send a patch, please include the following information with 4801c609719bSwdenkit: 4802c609719bSwdenk 4803c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes 4804c609719bSwdenk this bug. Please try to include a way of demonstrating that the 4805c609719bSwdenk patch actually fixes something. 4806c609719bSwdenk 4807c609719bSwdenk* For new features: a description of the feature and your 4808c609719bSwdenk implementation. 4809c609719bSwdenk 4810c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch) 4811c609719bSwdenk 4812c609719bSwdenk* For major contributions, your entry to the CREDITS file 4813c609719bSwdenk 4814c609719bSwdenk* When you add support for a new board, don't forget to add this 48157ca9296eSWolfgang Denk board to the MAINTAINERS file, too. 4816c609719bSwdenk 4817c609719bSwdenk* If your patch adds new configuration options, don't forget to 4818c609719bSwdenk document these in the README file. 4819c609719bSwdenk 4820218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly* 4821218ca724SWolfgang Denk recommended) you can easily generate the patch using the 48227ca9296eSWolfgang Denk "git format-patch". If you then use "git send-email" to send it to 4823218ca724SWolfgang Denk the U-Boot mailing list, you will avoid most of the common problems 4824218ca724SWolfgang Denk with some other mail clients. 4825c609719bSwdenk 4826218ca724SWolfgang Denk If you cannot use git, use "diff -purN OLD NEW". If your version of 4827218ca724SWolfgang Denk diff does not support these options, then get the latest version of 4828218ca724SWolfgang Denk GNU diff. 48296dff5529Swdenk 4830218ca724SWolfgang Denk The current directory when running this command shall be the parent 4831218ca724SWolfgang Denk directory of the U-Boot source tree (i. e. please make sure that 4832218ca724SWolfgang Denk your patch includes sufficient directory information for the 4833218ca724SWolfgang Denk affected files). 4834218ca724SWolfgang Denk 4835218ca724SWolfgang Denk We prefer patches as plain text. MIME attachments are discouraged, 4836218ca724SWolfgang Denk and compressed attachments must not be used. 4837c609719bSwdenk 483852f52c14Swdenk* If one logical set of modifications affects or creates several 483952f52c14Swdenk files, all these changes shall be submitted in a SINGLE patch file. 484052f52c14Swdenk 484152f52c14Swdenk* Changesets that contain different, unrelated modifications shall be 484252f52c14Swdenk submitted as SEPARATE patches, one patch per changeset. 484352f52c14Swdenk 484452f52c14Swdenk 4845c609719bSwdenkNotes: 4846c609719bSwdenk 4847c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched 4848c609719bSwdenk source tree and make sure that no errors or warnings are reported 4849c609719bSwdenk for any of the boards. 4850c609719bSwdenk 4851c609719bSwdenk* Keep your modifications to the necessary minimum: A patch 4852c609719bSwdenk containing several unrelated changes or arbitrary reformats will be 4853c609719bSwdenk returned with a request to re-formatting / split it. 4854c609719bSwdenk 4855c609719bSwdenk* If you modify existing code, make sure that your new code does not 4856c609719bSwdenk add to the memory footprint of the code ;-) Small is beautiful! 4857c609719bSwdenk When adding new features, these should compile conditionally only 4858c609719bSwdenk (using #ifdef), and the resulting code with the new feature 4859c609719bSwdenk disabled must not need more memory than the old code without your 4860c609719bSwdenk modification. 486190dc6704Swdenk 48620668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the 48630668236bSWolfgang Denk u-boot mailing list. Bigger patches will be moderated. If they are 48640668236bSWolfgang Denk reasonable and not too big, they will be acknowledged. But patches 48650668236bSWolfgang Denk bigger than the size limit should be avoided. 4866