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 567c609719bSwdenk defines (cf. smiLynxEM, i8042, board/eltec/bab7xx) 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 641c609719bSwdenk- Boot Delay: CONFIG_BOOTDELAY - in seconds 642c609719bSwdenk Delay before automatically booting the default image; 643c609719bSwdenk set to -1 to disable autoboot. 644c609719bSwdenk 645c609719bSwdenk See doc/README.autoboot for these options that 646c609719bSwdenk work with CONFIG_BOOTDELAY. None are required. 647c609719bSwdenk CONFIG_BOOT_RETRY_TIME 648c609719bSwdenk CONFIG_BOOT_RETRY_MIN 649c609719bSwdenk CONFIG_AUTOBOOT_KEYED 650c609719bSwdenk CONFIG_AUTOBOOT_PROMPT 651c609719bSwdenk CONFIG_AUTOBOOT_DELAY_STR 652c609719bSwdenk CONFIG_AUTOBOOT_STOP_STR 653c609719bSwdenk CONFIG_AUTOBOOT_DELAY_STR2 654c609719bSwdenk CONFIG_AUTOBOOT_STOP_STR2 655c609719bSwdenk CONFIG_ZERO_BOOTDELAY_CHECK 656c609719bSwdenk CONFIG_RESET_TO_RETRY 657c609719bSwdenk 658c609719bSwdenk- Autoboot Command: 659c609719bSwdenk CONFIG_BOOTCOMMAND 660c609719bSwdenk Only needed when CONFIG_BOOTDELAY is enabled; 661c609719bSwdenk define a command string that is automatically executed 662c609719bSwdenk when no character is read on the console interface 663c609719bSwdenk within "Boot Delay" after reset. 664c609719bSwdenk 665c609719bSwdenk CONFIG_BOOTARGS 666c609719bSwdenk This can be used to pass arguments to the bootm 667c609719bSwdenk command. The value of CONFIG_BOOTARGS goes into the 668c609719bSwdenk environment value "bootargs". 669c609719bSwdenk 670c609719bSwdenk CONFIG_RAMBOOT and CONFIG_NFSBOOT 671c609719bSwdenk The value of these goes into the environment as 672c609719bSwdenk "ramboot" and "nfsboot" respectively, and can be used 673c609719bSwdenk as a convenience, when switching between booting from 67411ccc33fSMarcel Ziswiler RAM and NFS. 675c609719bSwdenk 676c609719bSwdenk- Pre-Boot Commands: 677c609719bSwdenk CONFIG_PREBOOT 678c609719bSwdenk 679c609719bSwdenk When this option is #defined, the existence of the 680c609719bSwdenk environment variable "preboot" will be checked 681c609719bSwdenk immediately before starting the CONFIG_BOOTDELAY 682c609719bSwdenk countdown and/or running the auto-boot command resp. 683c609719bSwdenk entering interactive mode. 684c609719bSwdenk 685c609719bSwdenk This feature is especially useful when "preboot" is 686c609719bSwdenk automatically generated or modified. For an example 687c609719bSwdenk see the LWMON board specific code: here "preboot" is 688c609719bSwdenk modified when the user holds down a certain 689c609719bSwdenk combination of keys on the (special) keyboard when 690c609719bSwdenk booting the systems 691c609719bSwdenk 692c609719bSwdenk- Serial Download Echo Mode: 693c609719bSwdenk CONFIG_LOADS_ECHO 694c609719bSwdenk If defined to 1, all characters received during a 695c609719bSwdenk serial download (using the "loads" command) are 696c609719bSwdenk echoed back. This might be needed by some terminal 697c609719bSwdenk emulations (like "cu"), but may as well just take 698c609719bSwdenk time on others. This setting #define's the initial 699c609719bSwdenk value of the "loads_echo" environment variable. 700c609719bSwdenk 701602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined) 702c609719bSwdenk CONFIG_KGDB_BAUDRATE 703c609719bSwdenk Select one of the baudrates listed in 7046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BAUDRATE_TABLE, see below. 705c609719bSwdenk 706c609719bSwdenk- Monitor Functions: 707602ad3b3SJon Loeliger Monitor commands can be included or excluded 708602ad3b3SJon Loeliger from the build by using the #include files 709602ad3b3SJon Loeliger "config_cmd_all.h" and #undef'ing unwanted 710602ad3b3SJon Loeliger commands, or using "config_cmd_default.h" 711602ad3b3SJon Loeliger and augmenting with additional #define's 712602ad3b3SJon Loeliger for wanted commands. 713c609719bSwdenk 714602ad3b3SJon Loeliger The default command configuration includes all commands 715602ad3b3SJon Loeliger except those marked below with a "*". 716602ad3b3SJon Loeliger 717602ad3b3SJon Loeliger CONFIG_CMD_ASKENV * ask for env variable 718602ad3b3SJon Loeliger CONFIG_CMD_BDI bdinfo 719602ad3b3SJon Loeliger CONFIG_CMD_BEDBUG * Include BedBug Debugger 720602ad3b3SJon Loeliger CONFIG_CMD_BMP * BMP support 721602ad3b3SJon Loeliger CONFIG_CMD_BSP * Board specific commands 722602ad3b3SJon Loeliger CONFIG_CMD_BOOTD bootd 723602ad3b3SJon Loeliger CONFIG_CMD_CACHE * icache, dcache 724602ad3b3SJon Loeliger CONFIG_CMD_CONSOLE coninfo 725710b9938SMike Frysinger CONFIG_CMD_CRC32 * crc32 726602ad3b3SJon Loeliger CONFIG_CMD_DATE * support for RTC, date/time... 727602ad3b3SJon Loeliger CONFIG_CMD_DHCP * DHCP support 728602ad3b3SJon Loeliger CONFIG_CMD_DIAG * Diagnostics 729a7c93104SPeter Tyser CONFIG_CMD_DS4510 * ds4510 I2C gpio commands 730a7c93104SPeter Tyser CONFIG_CMD_DS4510_INFO * ds4510 I2C info command 731a7c93104SPeter Tyser CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd 732a7c93104SPeter Tyser CONFIG_CMD_DS4510_RST * ds4510 I2C rst command 733602ad3b3SJon Loeliger CONFIG_CMD_DTT * Digital Therm and Thermostat 734602ad3b3SJon Loeliger CONFIG_CMD_ECHO echo arguments 735246c6922SPeter Tyser CONFIG_CMD_EDITENV edit env variable 736602ad3b3SJon Loeliger CONFIG_CMD_EEPROM * EEPROM read/write support 737602ad3b3SJon Loeliger CONFIG_CMD_ELF * bootelf, bootvx 7380c79cda0SMike Frysinger CONFIG_CMD_EXPORTENV * export the environment 739bdab39d3SMike Frysinger CONFIG_CMD_SAVEENV saveenv 740602ad3b3SJon Loeliger CONFIG_CMD_FDC * Floppy Disk Support 741602ad3b3SJon Loeliger CONFIG_CMD_FAT * FAT partition support 742602ad3b3SJon Loeliger CONFIG_CMD_FDOS * Dos diskette Support 743602ad3b3SJon Loeliger CONFIG_CMD_FLASH flinfo, erase, protect 744602ad3b3SJon Loeliger CONFIG_CMD_FPGA FPGA device initialization support 745a641b979SMike Frysinger CONFIG_CMD_GO * the 'go' command (exec code) 746a000b795SKim Phillips CONFIG_CMD_GREPENV * search environment 747602ad3b3SJon Loeliger CONFIG_CMD_HWFLOW * RTS/CTS hw flow control 748602ad3b3SJon Loeliger CONFIG_CMD_I2C * I2C serial bus support 749602ad3b3SJon Loeliger CONFIG_CMD_IDE * IDE harddisk support 750602ad3b3SJon Loeliger CONFIG_CMD_IMI iminfo 751602ad3b3SJon Loeliger CONFIG_CMD_IMLS List all found images 752602ad3b3SJon Loeliger CONFIG_CMD_IMMAP * IMMR dump support 7530c79cda0SMike Frysinger CONFIG_CMD_IMPORTENV * import an environment 754602ad3b3SJon Loeliger CONFIG_CMD_IRQ * irqinfo 755602ad3b3SJon Loeliger CONFIG_CMD_ITEST Integer/string test of 2 values 756602ad3b3SJon Loeliger CONFIG_CMD_JFFS2 * JFFS2 Support 757602ad3b3SJon Loeliger CONFIG_CMD_KGDB * kgdb 7581ba7fd25SMike Frysinger CONFIG_CMD_LDRINFO ldrinfo (display Blackfin loader) 759602ad3b3SJon Loeliger CONFIG_CMD_LOADB loadb 760602ad3b3SJon Loeliger CONFIG_CMD_LOADS loads 76102c9aa1dSRobin Getz CONFIG_CMD_MD5SUM print md5 message digest 76202c9aa1dSRobin Getz (requires CONFIG_CMD_MEMORY and CONFIG_MD5) 763602ad3b3SJon Loeliger CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base, 76456523f12Swdenk loop, loopw, mtest 765602ad3b3SJon Loeliger CONFIG_CMD_MISC Misc functions like sleep etc 766602ad3b3SJon Loeliger CONFIG_CMD_MMC * MMC memory mapped support 767602ad3b3SJon Loeliger CONFIG_CMD_MII * MII utility commands 76868d7d651SStefan Roese CONFIG_CMD_MTDPARTS * MTD partition support 769602ad3b3SJon Loeliger CONFIG_CMD_NAND * NAND support 770602ad3b3SJon Loeliger CONFIG_CMD_NET bootp, tftpboot, rarpboot 771e92739d3SPeter Tyser CONFIG_CMD_PCA953X * PCA953x I2C gpio commands 772e92739d3SPeter Tyser CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command 773602ad3b3SJon Loeliger CONFIG_CMD_PCI * pciinfo 774602ad3b3SJon Loeliger CONFIG_CMD_PCMCIA * PCMCIA support 775602ad3b3SJon Loeliger CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network 776602ad3b3SJon Loeliger host 777602ad3b3SJon Loeliger CONFIG_CMD_PORTIO * Port I/O 778602ad3b3SJon Loeliger CONFIG_CMD_REGINFO * Register dump 779602ad3b3SJon Loeliger CONFIG_CMD_RUN run command in env variable 780602ad3b3SJon Loeliger CONFIG_CMD_SAVES * save S record dump 781602ad3b3SJon Loeliger CONFIG_CMD_SCSI * SCSI Support 782602ad3b3SJon Loeliger CONFIG_CMD_SDRAM * print SDRAM configuration information 783602ad3b3SJon Loeliger (requires CONFIG_CMD_I2C) 784602ad3b3SJon Loeliger CONFIG_CMD_SETGETDCR Support for DCR Register access 785602ad3b3SJon Loeliger (4xx only) 786c6b1ee66SAlexander Holler CONFIG_CMD_SHA1SUM print sha1 memory digest 78702c9aa1dSRobin Getz (requires CONFIG_CMD_MEMORY) 78874de7aefSWolfgang Denk CONFIG_CMD_SOURCE "source" command Support 789602ad3b3SJon Loeliger CONFIG_CMD_SPI * SPI serial bus support 7907a83af07SLuca Ceresoli CONFIG_CMD_TFTPSRV * TFTP transfer in server mode 7911fb7cd49SSimon Glass CONFIG_CMD_TFTPPUT * TFTP put command (upload) 792ca366d0eSChe-liang Chiou CONFIG_CMD_TIME * run command and report execution time 793602ad3b3SJon Loeliger CONFIG_CMD_USB * USB support 794602ad3b3SJon Loeliger CONFIG_CMD_CDP * Cisco Discover Protocol support 795602ad3b3SJon Loeliger CONFIG_CMD_FSL * Microblaze FSL support 796c609719bSwdenk 797c609719bSwdenk 798c609719bSwdenk EXAMPLE: If you want all functions except of network 799c609719bSwdenk support you can write: 800c609719bSwdenk 801602ad3b3SJon Loeliger #include "config_cmd_all.h" 802602ad3b3SJon Loeliger #undef CONFIG_CMD_NET 803c609719bSwdenk 804213bf8c8SGerald Van Baren Other Commands: 805213bf8c8SGerald Van Baren fdt (flattened device tree) command: CONFIG_OF_LIBFDT 806c609719bSwdenk 807c609719bSwdenk Note: Don't enable the "icache" and "dcache" commands 808602ad3b3SJon Loeliger (configuration option CONFIG_CMD_CACHE) unless you know 809c609719bSwdenk what you (and your U-Boot users) are doing. Data 810c609719bSwdenk cache cannot be enabled on systems like the 8xx or 811c609719bSwdenk 8260 (where accesses to the IMMR region must be 812c609719bSwdenk uncached), and it cannot be disabled on all other 813c609719bSwdenk systems where we (mis-) use the data cache to hold an 814c609719bSwdenk initial stack and some data. 815c609719bSwdenk 816c609719bSwdenk 817c609719bSwdenk XXX - this list needs to get updated! 818c609719bSwdenk 81945ba8077SSimon Glass- Device tree: 82045ba8077SSimon Glass CONFIG_OF_CONTROL 82145ba8077SSimon Glass If this variable is defined, U-Boot will use a device tree 82245ba8077SSimon Glass to configure its devices, instead of relying on statically 82345ba8077SSimon Glass compiled #defines in the board file. This option is 82445ba8077SSimon Glass experimental and only available on a few boards. The device 82545ba8077SSimon Glass tree is available in the global data as gd->fdt_blob. 82645ba8077SSimon Glass 8272c0f79e4SSimon Glass U-Boot needs to get its device tree from somewhere. This can 8282c0f79e4SSimon Glass be done using one of the two options below: 829bbb0b128SSimon Glass 830bbb0b128SSimon Glass CONFIG_OF_EMBED 831bbb0b128SSimon Glass If this variable is defined, U-Boot will embed a device tree 832bbb0b128SSimon Glass binary in its image. This device tree file should be in the 833bbb0b128SSimon Glass board directory and called <soc>-<board>.dts. The binary file 834bbb0b128SSimon Glass is then picked up in board_init_f() and made available through 835bbb0b128SSimon Glass the global data structure as gd->blob. 83645ba8077SSimon Glass 8372c0f79e4SSimon Glass CONFIG_OF_SEPARATE 8382c0f79e4SSimon Glass If this variable is defined, U-Boot will build a device tree 8392c0f79e4SSimon Glass binary. It will be called u-boot.dtb. Architecture-specific 8402c0f79e4SSimon Glass code will locate it at run-time. Generally this works by: 8412c0f79e4SSimon Glass 8422c0f79e4SSimon Glass cat u-boot.bin u-boot.dtb >image.bin 8432c0f79e4SSimon Glass 8442c0f79e4SSimon Glass and in fact, U-Boot does this for you, creating a file called 8452c0f79e4SSimon Glass u-boot-dtb.bin which is useful in the common case. You can 8462c0f79e4SSimon Glass still use the individual files if you need something more 8472c0f79e4SSimon Glass exotic. 8482c0f79e4SSimon Glass 849c609719bSwdenk- Watchdog: 850c609719bSwdenk CONFIG_WATCHDOG 851c609719bSwdenk If this variable is defined, it enables watchdog 8526abe6fb6SDetlev Zundel support for the SoC. There must be support in the SoC 8536abe6fb6SDetlev Zundel specific code for a watchdog. For the 8xx and 8260 8546abe6fb6SDetlev Zundel CPUs, the SIU Watchdog feature is enabled in the SYPCR 8556abe6fb6SDetlev Zundel register. When supported for a specific SoC is 8566abe6fb6SDetlev Zundel available, then no further board specific code should 8576abe6fb6SDetlev Zundel be needed to use it. 8586abe6fb6SDetlev Zundel 8596abe6fb6SDetlev Zundel CONFIG_HW_WATCHDOG 8606abe6fb6SDetlev Zundel When using a watchdog circuitry external to the used 8616abe6fb6SDetlev Zundel SoC, then define this variable and provide board 8626abe6fb6SDetlev Zundel specific code for the "hw_watchdog_reset" function. 863c609719bSwdenk 864c1551ea8Sstroese- U-Boot Version: 865c1551ea8Sstroese CONFIG_VERSION_VARIABLE 866c1551ea8Sstroese If this variable is defined, an environment variable 867c1551ea8Sstroese named "ver" is created by U-Boot showing the U-Boot 868c1551ea8Sstroese version as printed by the "version" command. 869c1551ea8Sstroese This variable is readonly. 870c1551ea8Sstroese 871c609719bSwdenk- Real-Time Clock: 872c609719bSwdenk 873602ad3b3SJon Loeliger When CONFIG_CMD_DATE is selected, the type of the RTC 874c609719bSwdenk has to be selected, too. Define exactly one of the 875c609719bSwdenk following options: 876c609719bSwdenk 877c609719bSwdenk CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx 878c609719bSwdenk CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC 8794e8b7544SFabio Estevam CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC 880c609719bSwdenk CONFIG_RTC_MC146818 - use MC146818 RTC 8811cb8e980Swdenk CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC 882c609719bSwdenk CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC 8837f70e853Swdenk CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC 8843bac3513Swdenk CONFIG_RTC_DS164x - use Dallas DS164x RTC 8859536dfccSTor Krill CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC 8864c0d4c3bSwdenk CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC 8876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337 88871d19f30SHeiko Schocher CONFIG_SYS_RV3029_TCR - enable trickle charger on 88971d19f30SHeiko Schocher RV3029 RTC. 890c609719bSwdenk 891b37c7e5eSwdenk Note that if the RTC uses I2C, then the I2C interface 892b37c7e5eSwdenk must also be configured. See I2C Support, below. 893b37c7e5eSwdenk 894e92739d3SPeter Tyser- GPIO Support: 895e92739d3SPeter Tyser CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO 896e92739d3SPeter Tyser CONFIG_PCA953X_INFO - enable pca953x info command 897e92739d3SPeter Tyser 8985dec49caSChris Packham The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of 8995dec49caSChris Packham chip-ngpio pairs that tell the PCA953X driver the number of 9005dec49caSChris Packham pins supported by a particular chip. 9015dec49caSChris Packham 902e92739d3SPeter Tyser Note that if the GPIO device uses I2C, then the I2C interface 903e92739d3SPeter Tyser must also be configured. See I2C Support, below. 904e92739d3SPeter Tyser 905c609719bSwdenk- Timestamp Support: 906c609719bSwdenk 907c609719bSwdenk When CONFIG_TIMESTAMP is selected, the timestamp 908c609719bSwdenk (date and time) of an image is printed by image 909c609719bSwdenk commands like bootm or iminfo. This option is 910602ad3b3SJon Loeliger automatically enabled when you select CONFIG_CMD_DATE . 911c609719bSwdenk 912c609719bSwdenk- Partition Support: 913c609719bSwdenk CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION 91407f3d789Srichardretanubun and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION 915c609719bSwdenk 916602ad3b3SJon Loeliger If IDE or SCSI support is enabled (CONFIG_CMD_IDE or 917218ca724SWolfgang Denk CONFIG_CMD_SCSI) you must configure support for at 918218ca724SWolfgang Denk least one partition type as well. 919c609719bSwdenk 920c609719bSwdenk- IDE Reset method: 9214d13cbadSwdenk CONFIG_IDE_RESET_ROUTINE - this is defined in several 9224d13cbadSwdenk board configurations files but used nowhere! 923c609719bSwdenk 9244d13cbadSwdenk CONFIG_IDE_RESET - is this is defined, IDE Reset will 9254d13cbadSwdenk be performed by calling the function 9264d13cbadSwdenk ide_set_reset(int reset) 9274d13cbadSwdenk which has to be defined in a board specific file 928c609719bSwdenk 929c609719bSwdenk- ATAPI Support: 930c609719bSwdenk CONFIG_ATAPI 931c609719bSwdenk 932c609719bSwdenk Set this to enable ATAPI support. 933c609719bSwdenk 934c40b2956Swdenk- LBA48 Support 935c40b2956Swdenk CONFIG_LBA48 936c40b2956Swdenk 937c40b2956Swdenk Set this to enable support for disks larger than 137GB 9384b142febSHeiko Schocher Also look at CONFIG_SYS_64BIT_LBA. 939c40b2956Swdenk Whithout these , LBA48 support uses 32bit variables and will 'only' 940c40b2956Swdenk support disks up to 2.1TB. 941c40b2956Swdenk 9426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_64BIT_LBA: 943c40b2956Swdenk When enabled, makes the IDE subsystem use 64bit sector addresses. 944c40b2956Swdenk Default is 32bit. 945c40b2956Swdenk 946c609719bSwdenk- SCSI Support: 947c609719bSwdenk At the moment only there is only support for the 948c609719bSwdenk SYM53C8XX SCSI controller; define 949c609719bSwdenk CONFIG_SCSI_SYM53C8XX to enable it. 950c609719bSwdenk 9516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and 9526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID * 9536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the 954c609719bSwdenk maximum numbers of LUNs, SCSI ID's and target 955c609719bSwdenk devices. 9566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz) 957c609719bSwdenk 958c609719bSwdenk- NETWORK Support (PCI): 959682011ffSwdenk CONFIG_E1000 960ce5207e1SKyle Moffett Support for Intel 8254x/8257x gigabit chips. 961ce5207e1SKyle Moffett 962ce5207e1SKyle Moffett CONFIG_E1000_SPI 963ce5207e1SKyle Moffett Utility code for direct access to the SPI bus on Intel 8257x. 964ce5207e1SKyle Moffett This does not do anything useful unless you set at least one 965ce5207e1SKyle Moffett of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC. 966ce5207e1SKyle Moffett 967ce5207e1SKyle Moffett CONFIG_E1000_SPI_GENERIC 968ce5207e1SKyle Moffett Allow generic access to the SPI bus on the Intel 8257x, for 969ce5207e1SKyle Moffett example with the "sspi" command. 970ce5207e1SKyle Moffett 971ce5207e1SKyle Moffett CONFIG_CMD_E1000 972ce5207e1SKyle Moffett Management command for E1000 devices. When used on devices 973ce5207e1SKyle Moffett with SPI support you can reprogram the EEPROM from U-Boot. 974682011ffSwdenk 975ac3315c2SAndre Schwarz CONFIG_E1000_FALLBACK_MAC 97611ccc33fSMarcel Ziswiler default MAC for empty EEPROM after production. 977ac3315c2SAndre Schwarz 978c609719bSwdenk CONFIG_EEPRO100 979c609719bSwdenk Support for Intel 82557/82559/82559ER chips. 98011ccc33fSMarcel Ziswiler Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM 981c609719bSwdenk write routine for first time initialisation. 982c609719bSwdenk 983c609719bSwdenk CONFIG_TULIP 984c609719bSwdenk Support for Digital 2114x chips. 985c609719bSwdenk Optional CONFIG_TULIP_SELECT_MEDIA for board specific 986c609719bSwdenk modem chip initialisation (KS8761/QS6611). 987c609719bSwdenk 988c609719bSwdenk CONFIG_NATSEMI 989c609719bSwdenk Support for National dp83815 chips. 990c609719bSwdenk 991c609719bSwdenk CONFIG_NS8382X 992c609719bSwdenk Support for National dp8382[01] gigabit chips. 993c609719bSwdenk 99445219c46Swdenk- NETWORK Support (other): 99545219c46Swdenk 996c041e9d2SJens Scharsig CONFIG_DRIVER_AT91EMAC 997c041e9d2SJens Scharsig Support for AT91RM9200 EMAC. 998c041e9d2SJens Scharsig 999c041e9d2SJens Scharsig CONFIG_RMII 1000c041e9d2SJens Scharsig Define this to use reduced MII inteface 1001c041e9d2SJens Scharsig 1002c041e9d2SJens Scharsig CONFIG_DRIVER_AT91EMAC_QUIET 1003c041e9d2SJens Scharsig If this defined, the driver is quiet. 1004c041e9d2SJens Scharsig The driver doen't show link status messages. 1005c041e9d2SJens Scharsig 100645219c46Swdenk CONFIG_DRIVER_LAN91C96 100745219c46Swdenk Support for SMSC's LAN91C96 chips. 100845219c46Swdenk 100945219c46Swdenk CONFIG_LAN91C96_BASE 101045219c46Swdenk Define this to hold the physical address 101145219c46Swdenk of the LAN91C96's I/O space 101245219c46Swdenk 101345219c46Swdenk CONFIG_LAN91C96_USE_32_BIT 101445219c46Swdenk Define this to enable 32 bit addressing 101545219c46Swdenk 1016f39748aeSwdenk CONFIG_DRIVER_SMC91111 1017f39748aeSwdenk Support for SMSC's LAN91C111 chip 1018f39748aeSwdenk 1019f39748aeSwdenk CONFIG_SMC91111_BASE 1020f39748aeSwdenk Define this to hold the physical address 1021f39748aeSwdenk of the device (I/O space) 1022f39748aeSwdenk 1023f39748aeSwdenk CONFIG_SMC_USE_32_BIT 1024f39748aeSwdenk Define this if data bus is 32 bits 1025f39748aeSwdenk 1026f39748aeSwdenk CONFIG_SMC_USE_IOFUNCS 1027f39748aeSwdenk Define this to use i/o functions instead of macros 1028f39748aeSwdenk (some hardware wont work with macros) 1029f39748aeSwdenk 1030b3dbf4a5SMacpaul Lin CONFIG_FTGMAC100 1031b3dbf4a5SMacpaul Lin Support for Faraday's FTGMAC100 Gigabit SoC Ethernet 1032b3dbf4a5SMacpaul Lin 1033b3dbf4a5SMacpaul Lin CONFIG_FTGMAC100_EGIGA 1034b3dbf4a5SMacpaul Lin Define this to use GE link update with gigabit PHY. 1035b3dbf4a5SMacpaul Lin Define this if FTGMAC100 is connected to gigabit PHY. 1036b3dbf4a5SMacpaul Lin If your system has 10/100 PHY only, it might not occur 1037b3dbf4a5SMacpaul Lin wrong behavior. Because PHY usually return timeout or 1038b3dbf4a5SMacpaul Lin useless data when polling gigabit status and gigabit 1039b3dbf4a5SMacpaul Lin control registers. This behavior won't affect the 1040b3dbf4a5SMacpaul Lin correctnessof 10/100 link speed update. 1041b3dbf4a5SMacpaul Lin 1042c2fff331SMike Rapoport CONFIG_SMC911X 1043557b377dSJens Gehrlein Support for SMSC's LAN911x and LAN921x chips 1044557b377dSJens Gehrlein 1045c2fff331SMike Rapoport CONFIG_SMC911X_BASE 1046557b377dSJens Gehrlein Define this to hold the physical address 1047557b377dSJens Gehrlein of the device (I/O space) 1048557b377dSJens Gehrlein 1049c2fff331SMike Rapoport CONFIG_SMC911X_32_BIT 1050557b377dSJens Gehrlein Define this if data bus is 32 bits 1051557b377dSJens Gehrlein 1052c2fff331SMike Rapoport CONFIG_SMC911X_16_BIT 1053557b377dSJens Gehrlein Define this if data bus is 16 bits. If your processor 1054557b377dSJens Gehrlein automatically converts one 32 bit word to two 16 bit 1055c2fff331SMike Rapoport words you may also try CONFIG_SMC911X_32_BIT. 1056557b377dSJens Gehrlein 10573d0075faSYoshihiro Shimoda CONFIG_SH_ETHER 10583d0075faSYoshihiro Shimoda Support for Renesas on-chip Ethernet controller 10593d0075faSYoshihiro Shimoda 10603d0075faSYoshihiro Shimoda CONFIG_SH_ETHER_USE_PORT 10613d0075faSYoshihiro Shimoda Define the number of ports to be used 10623d0075faSYoshihiro Shimoda 10633d0075faSYoshihiro Shimoda CONFIG_SH_ETHER_PHY_ADDR 10643d0075faSYoshihiro Shimoda Define the ETH PHY's address 10653d0075faSYoshihiro Shimoda 106668260aabSYoshihiro Shimoda CONFIG_SH_ETHER_CACHE_WRITEBACK 106768260aabSYoshihiro Shimoda If this option is set, the driver enables cache flush. 106868260aabSYoshihiro Shimoda 1069c609719bSwdenk- USB Support: 1070c609719bSwdenk At the moment only the UHCI host controller is 10714d13cbadSwdenk supported (PIP405, MIP405, MPC5200); define 1072c609719bSwdenk CONFIG_USB_UHCI to enable it. 1073c609719bSwdenk define CONFIG_USB_KEYBOARD to enable the USB Keyboard 107430d56faeSwdenk and define CONFIG_USB_STORAGE to enable the USB 1075c609719bSwdenk storage devices. 1076c609719bSwdenk Note: 1077c609719bSwdenk Supported are USB Keyboards and USB Floppy drives 1078c609719bSwdenk (TEAC FD-05PUB). 10794d13cbadSwdenk MPC5200 USB requires additional defines: 10804d13cbadSwdenk CONFIG_USB_CLOCK 10814d13cbadSwdenk for 528 MHz Clock: 0x0001bbbb 1082307ecb6dSEric Millbrandt CONFIG_PSC3_USB 1083307ecb6dSEric Millbrandt for USB on PSC3 10844d13cbadSwdenk CONFIG_USB_CONFIG 10854d13cbadSwdenk for differential drivers: 0x00001000 10864d13cbadSwdenk for single ended drivers: 0x00005000 1087307ecb6dSEric Millbrandt for differential drivers on PSC3: 0x00000100 1088307ecb6dSEric Millbrandt for single ended drivers on PSC3: 0x00004100 10896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_USB_EVENT_POLL 1090fdcfaa1bSZhang Wei May be defined to allow interrupt polling 1091fdcfaa1bSZhang Wei instead of using asynchronous interrupts 10924d13cbadSwdenk 109316c8d5e7SWolfgang Denk- USB Device: 109416c8d5e7SWolfgang Denk Define the below if you wish to use the USB console. 109516c8d5e7SWolfgang Denk Once firmware is rebuilt from a serial console issue the 109616c8d5e7SWolfgang Denk command "setenv stdin usbtty; setenv stdout usbtty" and 109711ccc33fSMarcel Ziswiler attach your USB cable. The Unix command "dmesg" should print 109816c8d5e7SWolfgang Denk it has found a new device. The environment variable usbtty 109916c8d5e7SWolfgang Denk can be set to gserial or cdc_acm to enable your device to 110016c8d5e7SWolfgang Denk appear to a USB host as a Linux gserial device or a 110116c8d5e7SWolfgang Denk Common Device Class Abstract Control Model serial device. 110216c8d5e7SWolfgang Denk If you select usbtty = gserial you should be able to enumerate 110316c8d5e7SWolfgang Denk a Linux host by 110416c8d5e7SWolfgang Denk # modprobe usbserial vendor=0xVendorID product=0xProductID 110516c8d5e7SWolfgang Denk else if using cdc_acm, simply setting the environment 110616c8d5e7SWolfgang Denk variable usbtty to be cdc_acm should suffice. The following 110716c8d5e7SWolfgang Denk might be defined in YourBoardName.h 110816c8d5e7SWolfgang Denk 110916c8d5e7SWolfgang Denk CONFIG_USB_DEVICE 111016c8d5e7SWolfgang Denk Define this to build a UDC device 111116c8d5e7SWolfgang Denk 111216c8d5e7SWolfgang Denk CONFIG_USB_TTY 111316c8d5e7SWolfgang Denk Define this to have a tty type of device available to 111416c8d5e7SWolfgang Denk talk to the UDC device 111516c8d5e7SWolfgang Denk 11166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_CONSOLE_IS_IN_ENV 111716c8d5e7SWolfgang Denk Define this if you want stdin, stdout &/or stderr to 111816c8d5e7SWolfgang Denk be set to usbtty. 111916c8d5e7SWolfgang Denk 112016c8d5e7SWolfgang Denk mpc8xx: 11216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_USB_EXTC_CLK 0xBLAH 112216c8d5e7SWolfgang Denk Derive USB clock from external clock "blah" 11236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_USB_EXTC_CLK 0x02 112416c8d5e7SWolfgang Denk 11256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_USB_BRG_CLK 0xBLAH 112616c8d5e7SWolfgang Denk Derive USB clock from brgclk 11276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_USB_BRG_CLK 0x04 112816c8d5e7SWolfgang Denk 112916c8d5e7SWolfgang Denk If you have a USB-IF assigned VendorID then you may wish to 113016c8d5e7SWolfgang Denk define your own vendor specific values either in BoardName.h 113116c8d5e7SWolfgang Denk or directly in usbd_vendor_info.h. If you don't define 113216c8d5e7SWolfgang Denk CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME, 113316c8d5e7SWolfgang Denk CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot 113416c8d5e7SWolfgang Denk should pretend to be a Linux device to it's target host. 113516c8d5e7SWolfgang Denk 113616c8d5e7SWolfgang Denk CONFIG_USBD_MANUFACTURER 113716c8d5e7SWolfgang Denk Define this string as the name of your company for 113816c8d5e7SWolfgang Denk - CONFIG_USBD_MANUFACTURER "my company" 113916c8d5e7SWolfgang Denk 114016c8d5e7SWolfgang Denk CONFIG_USBD_PRODUCT_NAME 114116c8d5e7SWolfgang Denk Define this string as the name of your product 114216c8d5e7SWolfgang Denk - CONFIG_USBD_PRODUCT_NAME "acme usb device" 114316c8d5e7SWolfgang Denk 114416c8d5e7SWolfgang Denk CONFIG_USBD_VENDORID 114516c8d5e7SWolfgang Denk Define this as your assigned Vendor ID from the USB 114616c8d5e7SWolfgang Denk Implementors Forum. This *must* be a genuine Vendor ID 114716c8d5e7SWolfgang Denk to avoid polluting the USB namespace. 114816c8d5e7SWolfgang Denk - CONFIG_USBD_VENDORID 0xFFFF 114916c8d5e7SWolfgang Denk 115016c8d5e7SWolfgang Denk CONFIG_USBD_PRODUCTID 115116c8d5e7SWolfgang Denk Define this as the unique Product ID 115216c8d5e7SWolfgang Denk for your device 115316c8d5e7SWolfgang Denk - CONFIG_USBD_PRODUCTID 0xFFFF 1154c609719bSwdenk 1155c609719bSwdenk 1156c609719bSwdenk- MMC Support: 1157c609719bSwdenk The MMC controller on the Intel PXA is supported. To 1158c609719bSwdenk enable this define CONFIG_MMC. The MMC can be 1159c609719bSwdenk accessed from the boot prompt by mapping the device 1160c609719bSwdenk to physical memory similar to flash. Command line is 1161602ad3b3SJon Loeliger enabled with CONFIG_CMD_MMC. The MMC driver also works with 1162602ad3b3SJon Loeliger the FAT fs. This is enabled with CONFIG_CMD_FAT. 1163c609719bSwdenk 1164afb35666SYoshihiro Shimoda CONFIG_SH_MMCIF 1165afb35666SYoshihiro Shimoda Support for Renesas on-chip MMCIF controller 1166afb35666SYoshihiro Shimoda 1167afb35666SYoshihiro Shimoda CONFIG_SH_MMCIF_ADDR 1168afb35666SYoshihiro Shimoda Define the base address of MMCIF registers 1169afb35666SYoshihiro Shimoda 1170afb35666SYoshihiro Shimoda CONFIG_SH_MMCIF_CLK 1171afb35666SYoshihiro Shimoda Define the clock frequency for MMCIF 1172afb35666SYoshihiro Shimoda 11736705d81eSwdenk- Journaling Flash filesystem support: 11746705d81eSwdenk CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE, 11756705d81eSwdenk CONFIG_JFFS2_NAND_DEV 11766705d81eSwdenk Define these for a default partition on a NAND device 11776705d81eSwdenk 11786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS2_FIRST_SECTOR, 11796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS 11806705d81eSwdenk Define these for a default partition on a NOR device 11816705d81eSwdenk 11826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS_CUSTOM_PART 11836705d81eSwdenk Define this to create an own partition. You have to provide a 11846705d81eSwdenk function struct part_info* jffs2_part_info(int part_num) 11856705d81eSwdenk 11866705d81eSwdenk If you define only one JFFS2 partition you may also want to 11876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_JFFS_SINGLE_PART 1 11886705d81eSwdenk to disable the command chpart. This is the default when you 11896705d81eSwdenk have not defined a custom partition 11906705d81eSwdenk 1191c30a15e5SDonggeun Kim- FAT(File Allocation Table) filesystem write function support: 1192c30a15e5SDonggeun Kim CONFIG_FAT_WRITE 1193c30a15e5SDonggeun Kim Support for saving memory data as a file 1194c30a15e5SDonggeun Kim in FAT formatted partition 1195c30a15e5SDonggeun Kim 1196c609719bSwdenk- Keyboard Support: 1197c609719bSwdenk CONFIG_ISA_KEYBOARD 1198c609719bSwdenk 1199c609719bSwdenk Define this to enable standard (PC-Style) keyboard 1200c609719bSwdenk support 1201c609719bSwdenk 1202c609719bSwdenk CONFIG_I8042_KBD 1203c609719bSwdenk Standard PC keyboard driver with US (is default) and 1204c609719bSwdenk GERMAN key layout (switch via environment 'keymap=de') support. 1205c609719bSwdenk Export function i8042_kbd_init, i8042_tstc and i8042_getc 1206c609719bSwdenk for cfb_console. Supports cursor blinking. 1207c609719bSwdenk 1208c609719bSwdenk- Video support: 1209c609719bSwdenk CONFIG_VIDEO 1210c609719bSwdenk 1211c609719bSwdenk Define this to enable video support (for output to 1212c609719bSwdenk video). 1213c609719bSwdenk 1214c609719bSwdenk CONFIG_VIDEO_CT69000 1215c609719bSwdenk 1216c609719bSwdenk Enable Chips & Technologies 69000 Video chip 1217c609719bSwdenk 1218c609719bSwdenk CONFIG_VIDEO_SMI_LYNXEM 1219eeb1b77bSwdenk Enable Silicon Motion SMI 712/710/810 Video chip. The 1220eeb1b77bSwdenk video output is selected via environment 'videoout' 1221eeb1b77bSwdenk (1 = LCD and 2 = CRT). If videoout is undefined, CRT is 1222eeb1b77bSwdenk assumed. 1223c609719bSwdenk 1224eeb1b77bSwdenk For the CT69000 and SMI_LYNXEM drivers, videomode is 122511ccc33fSMarcel Ziswiler selected via environment 'videomode'. Two different ways 1226eeb1b77bSwdenk are possible: 1227eeb1b77bSwdenk - "videomode=num" 'num' is a standard LiLo mode numbers. 1228eeb1b77bSwdenk Following standard modes are supported (* is default): 1229eeb1b77bSwdenk 1230eeb1b77bSwdenk Colors 640x480 800x600 1024x768 1152x864 1280x1024 1231eeb1b77bSwdenk -------------+--------------------------------------------- 1232eeb1b77bSwdenk 8 bits | 0x301* 0x303 0x305 0x161 0x307 1233eeb1b77bSwdenk 15 bits | 0x310 0x313 0x316 0x162 0x319 1234eeb1b77bSwdenk 16 bits | 0x311 0x314 0x317 0x163 0x31A 1235eeb1b77bSwdenk 24 bits | 0x312 0x315 0x318 ? 0x31B 1236eeb1b77bSwdenk -------------+--------------------------------------------- 1237c609719bSwdenk (i.e. setenv videomode 317; saveenv; reset;) 1238c609719bSwdenk 1239eeb1b77bSwdenk - "videomode=bootargs" all the video parameters are parsed 12407817cb20SMarcel Ziswiler from the bootargs. (See drivers/video/videomodes.c) 1241eeb1b77bSwdenk 1242eeb1b77bSwdenk 1243a6c7ad2fSwdenk CONFIG_VIDEO_SED13806 1244a6c7ad2fSwdenk Enable Epson SED13806 driver. This driver supports 8bpp 1245a6c7ad2fSwdenk and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP 1246a6c7ad2fSwdenk or CONFIG_VIDEO_SED13806_16BPP 1247a6c7ad2fSwdenk 12487d3053fbSTimur Tabi CONFIG_FSL_DIU_FB 12497d3053fbSTimur Tabi Enable the Freescale DIU video driver. Reference boards for 12507d3053fbSTimur Tabi SOCs that have a DIU should define this macro to enable DIU 12517d3053fbSTimur Tabi support, and should also define these other macros: 12527d3053fbSTimur Tabi 12537d3053fbSTimur Tabi CONFIG_SYS_DIU_ADDR 12547d3053fbSTimur Tabi CONFIG_VIDEO 12557d3053fbSTimur Tabi CONFIG_CMD_BMP 12567d3053fbSTimur Tabi CONFIG_CFB_CONSOLE 12577d3053fbSTimur Tabi CONFIG_VIDEO_SW_CURSOR 12587d3053fbSTimur Tabi CONFIG_VGA_AS_SINGLE_DEVICE 12597d3053fbSTimur Tabi CONFIG_VIDEO_LOGO 12607d3053fbSTimur Tabi CONFIG_VIDEO_BMP_LOGO 12617d3053fbSTimur Tabi 1262ba8e76bdSTimur Tabi The DIU driver will look for the 'video-mode' environment 1263ba8e76bdSTimur Tabi variable, and if defined, enable the DIU as a console during 1264ba8e76bdSTimur Tabi boot. See the documentation file README.video for a 1265ba8e76bdSTimur Tabi description of this variable. 12667d3053fbSTimur Tabi 1267682011ffSwdenk- Keyboard Support: 1268682011ffSwdenk CONFIG_KEYBOARD 1269682011ffSwdenk 1270682011ffSwdenk Define this to enable a custom keyboard support. 1271682011ffSwdenk This simply calls drv_keyboard_init() which must be 1272682011ffSwdenk defined in your board-specific files. 1273682011ffSwdenk The only board using this so far is RBC823. 1274a6c7ad2fSwdenk 1275c609719bSwdenk- LCD Support: CONFIG_LCD 1276c609719bSwdenk 1277c609719bSwdenk Define this to enable LCD support (for output to LCD 1278c609719bSwdenk display); also select one of the supported displays 1279c609719bSwdenk by defining one of these: 1280c609719bSwdenk 128139cf4804SStelian Pop CONFIG_ATMEL_LCD: 128239cf4804SStelian Pop 128339cf4804SStelian Pop HITACHI TX09D70VM1CCA, 3.5", 240x320. 128439cf4804SStelian Pop 1285fd3103bbSwdenk CONFIG_NEC_NL6448AC33: 1286c609719bSwdenk 1287fd3103bbSwdenk NEC NL6448AC33-18. Active, color, single scan. 1288c609719bSwdenk 1289fd3103bbSwdenk CONFIG_NEC_NL6448BC20 1290c609719bSwdenk 1291fd3103bbSwdenk NEC NL6448BC20-08. 6.5", 640x480. 1292fd3103bbSwdenk Active, color, single scan. 1293fd3103bbSwdenk 1294fd3103bbSwdenk CONFIG_NEC_NL6448BC33_54 1295fd3103bbSwdenk 1296fd3103bbSwdenk NEC NL6448BC33-54. 10.4", 640x480. 1297c609719bSwdenk Active, color, single scan. 1298c609719bSwdenk 1299c609719bSwdenk CONFIG_SHARP_16x9 1300c609719bSwdenk 1301c609719bSwdenk Sharp 320x240. Active, color, single scan. 1302c609719bSwdenk It isn't 16x9, and I am not sure what it is. 1303c609719bSwdenk 1304c609719bSwdenk CONFIG_SHARP_LQ64D341 1305c609719bSwdenk 1306c609719bSwdenk Sharp LQ64D341 display, 640x480. 1307c609719bSwdenk Active, color, single scan. 1308c609719bSwdenk 1309c609719bSwdenk CONFIG_HLD1045 1310c609719bSwdenk 1311c609719bSwdenk HLD1045 display, 640x480. 1312c609719bSwdenk Active, color, single scan. 1313c609719bSwdenk 1314c609719bSwdenk CONFIG_OPTREX_BW 1315c609719bSwdenk 1316c609719bSwdenk Optrex CBL50840-2 NF-FW 99 22 M5 1317c609719bSwdenk or 1318c609719bSwdenk Hitachi LMG6912RPFC-00T 1319c609719bSwdenk or 1320c609719bSwdenk Hitachi SP14Q002 1321c609719bSwdenk 1322c609719bSwdenk 320x240. Black & white. 1323c609719bSwdenk 1324c609719bSwdenk Normally display is black on white background; define 13256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_WHITE_ON_BLACK to get it inverted. 1326c609719bSwdenk 13277152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN 1328d791b1dcSwdenk 1329d791b1dcSwdenk If this option is set, the environment is checked for 1330d791b1dcSwdenk a variable "splashimage". If found, the usual display 1331d791b1dcSwdenk of logo, copyright and system information on the LCD 1332e94d2cd9Swdenk is suppressed and the BMP image at the address 1333d791b1dcSwdenk specified in "splashimage" is loaded instead. The 1334d791b1dcSwdenk console is redirected to the "nulldev", too. This 1335d791b1dcSwdenk allows for a "silent" boot where a splash screen is 1336d791b1dcSwdenk loaded very quickly after power-on. 1337d791b1dcSwdenk 13381ca298ceSMatthias Weisser CONFIG_SPLASH_SCREEN_ALIGN 13391ca298ceSMatthias Weisser 13401ca298ceSMatthias Weisser If this option is set the splash image can be freely positioned 13411ca298ceSMatthias Weisser on the screen. Environment variable "splashpos" specifies the 13421ca298ceSMatthias Weisser position as "x,y". If a positive number is given it is used as 13431ca298ceSMatthias Weisser number of pixel from left/top. If a negative number is given it 13441ca298ceSMatthias Weisser is used as number of pixel from right/bottom. You can also 13451ca298ceSMatthias Weisser specify 'm' for centering the image. 13461ca298ceSMatthias Weisser 13471ca298ceSMatthias Weisser Example: 13481ca298ceSMatthias Weisser setenv splashpos m,m 13491ca298ceSMatthias Weisser => image at center of screen 13501ca298ceSMatthias Weisser 13511ca298ceSMatthias Weisser setenv splashpos 30,20 13521ca298ceSMatthias Weisser => image at x = 30 and y = 20 13531ca298ceSMatthias Weisser 13541ca298ceSMatthias Weisser setenv splashpos -10,m 13551ca298ceSMatthias Weisser => vertically centered image 13561ca298ceSMatthias Weisser at x = dspWidth - bmpWidth - 9 13571ca298ceSMatthias Weisser 135898f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP 135998f4a3dfSStefan Roese 136098f4a3dfSStefan Roese If this option is set, additionally to standard BMP 136198f4a3dfSStefan Roese images, gzipped BMP images can be displayed via the 136298f4a3dfSStefan Roese splashscreen support or the bmp command. 136398f4a3dfSStefan Roese 1364d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8 1365d5011762SAnatolij Gustschin 1366d5011762SAnatolij Gustschin If this option is set, 8-bit RLE compressed BMP images 1367d5011762SAnatolij Gustschin can be displayed via the splashscreen support or the 1368d5011762SAnatolij Gustschin bmp command. 1369d5011762SAnatolij Gustschin 1370c29fdfc1Swdenk- Compression support: 1371c29fdfc1Swdenk CONFIG_BZIP2 1372c29fdfc1Swdenk 1373c29fdfc1Swdenk If this option is set, support for bzip2 compressed 1374c29fdfc1Swdenk images is included. If not, only uncompressed and gzip 1375c29fdfc1Swdenk compressed images are supported. 1376c29fdfc1Swdenk 1377c29fdfc1Swdenk NOTE: the bzip2 algorithm requires a lot of RAM, so 13786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should 1379c29fdfc1Swdenk be at least 4MB. 1380d791b1dcSwdenk 1381fc9c1727SLuigi 'Comio' Mantellini CONFIG_LZMA 1382fc9c1727SLuigi 'Comio' Mantellini 1383fc9c1727SLuigi 'Comio' Mantellini If this option is set, support for lzma compressed 1384fc9c1727SLuigi 'Comio' Mantellini images is included. 1385fc9c1727SLuigi 'Comio' Mantellini 1386fc9c1727SLuigi 'Comio' Mantellini Note: The LZMA algorithm adds between 2 and 4KB of code and it 1387fc9c1727SLuigi 'Comio' Mantellini requires an amount of dynamic memory that is given by the 1388fc9c1727SLuigi 'Comio' Mantellini formula: 1389fc9c1727SLuigi 'Comio' Mantellini 1390fc9c1727SLuigi 'Comio' Mantellini (1846 + 768 << (lc + lp)) * sizeof(uint16) 1391fc9c1727SLuigi 'Comio' Mantellini 1392fc9c1727SLuigi 'Comio' Mantellini Where lc and lp stand for, respectively, Literal context bits 1393fc9c1727SLuigi 'Comio' Mantellini and Literal pos bits. 1394fc9c1727SLuigi 'Comio' Mantellini 1395fc9c1727SLuigi 'Comio' Mantellini This value is upper-bounded by 14MB in the worst case. Anyway, 1396fc9c1727SLuigi 'Comio' Mantellini for a ~4MB large kernel image, we have lc=3 and lp=0 for a 1397fc9c1727SLuigi 'Comio' Mantellini total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is 1398fc9c1727SLuigi 'Comio' Mantellini a very small buffer. 1399fc9c1727SLuigi 'Comio' Mantellini 1400fc9c1727SLuigi 'Comio' Mantellini Use the lzmainfo tool to determinate the lc and lp values and 1401fc9c1727SLuigi 'Comio' Mantellini then calculate the amount of needed dynamic memory (ensuring 14026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD the appropriate CONFIG_SYS_MALLOC_LEN value). 1403fc9c1727SLuigi 'Comio' Mantellini 140417ea1177Swdenk- MII/PHY support: 140517ea1177Swdenk CONFIG_PHY_ADDR 140617ea1177Swdenk 140717ea1177Swdenk The address of PHY on MII bus. 140817ea1177Swdenk 140917ea1177Swdenk CONFIG_PHY_CLOCK_FREQ (ppc4xx) 141017ea1177Swdenk 141117ea1177Swdenk The clock frequency of the MII bus 141217ea1177Swdenk 141317ea1177Swdenk CONFIG_PHY_GIGE 141417ea1177Swdenk 141517ea1177Swdenk If this option is set, support for speed/duplex 141611ccc33fSMarcel Ziswiler detection of gigabit PHY is included. 141717ea1177Swdenk 141817ea1177Swdenk CONFIG_PHY_RESET_DELAY 141917ea1177Swdenk 142017ea1177Swdenk Some PHY like Intel LXT971A need extra delay after 142117ea1177Swdenk reset before any MII register access is possible. 142217ea1177Swdenk For such PHY, set this option to the usec delay 142317ea1177Swdenk required. (minimum 300usec for LXT971A) 142417ea1177Swdenk 142517ea1177Swdenk CONFIG_PHY_CMD_DELAY (ppc4xx) 142617ea1177Swdenk 142717ea1177Swdenk Some PHY like Intel LXT971A need extra delay after 142817ea1177Swdenk command issued before MII status register can be read 142917ea1177Swdenk 1430c609719bSwdenk- Ethernet address: 1431c609719bSwdenk CONFIG_ETHADDR 1432c68a05feSrichardretanubun CONFIG_ETH1ADDR 1433c609719bSwdenk CONFIG_ETH2ADDR 1434c609719bSwdenk CONFIG_ETH3ADDR 1435c68a05feSrichardretanubun CONFIG_ETH4ADDR 1436c68a05feSrichardretanubun CONFIG_ETH5ADDR 1437c609719bSwdenk 143811ccc33fSMarcel Ziswiler Define a default value for Ethernet address to use 143911ccc33fSMarcel Ziswiler for the respective Ethernet interface, in case this 1440c609719bSwdenk is not determined automatically. 1441c609719bSwdenk 1442c609719bSwdenk- IP address: 1443c609719bSwdenk CONFIG_IPADDR 1444c609719bSwdenk 1445c609719bSwdenk Define a default value for the IP address to use for 144611ccc33fSMarcel Ziswiler the default Ethernet interface, in case this is not 1447c609719bSwdenk determined through e.g. bootp. 14481ebcd654SWolfgang Denk (Environment variable "ipaddr") 1449c609719bSwdenk 1450c609719bSwdenk- Server IP address: 1451c609719bSwdenk CONFIG_SERVERIP 1452c609719bSwdenk 1453c609719bSwdenk Defines a default value for the IP address of a TFTP 1454c609719bSwdenk server to contact when using the "tftboot" command. 14551ebcd654SWolfgang Denk (Environment variable "serverip") 1456c609719bSwdenk 145797cfe861SRobin Getz CONFIG_KEEP_SERVERADDR 145897cfe861SRobin Getz 145997cfe861SRobin Getz Keeps the server's MAC address, in the env 'serveraddr' 146097cfe861SRobin Getz for passing to bootargs (like Linux's netconsole option) 146197cfe861SRobin Getz 14621ebcd654SWolfgang Denk- Gateway IP address: 14631ebcd654SWolfgang Denk CONFIG_GATEWAYIP 14641ebcd654SWolfgang Denk 14651ebcd654SWolfgang Denk Defines a default value for the IP address of the 14661ebcd654SWolfgang Denk default router where packets to other networks are 14671ebcd654SWolfgang Denk sent to. 14681ebcd654SWolfgang Denk (Environment variable "gatewayip") 14691ebcd654SWolfgang Denk 14701ebcd654SWolfgang Denk- Subnet mask: 14711ebcd654SWolfgang Denk CONFIG_NETMASK 14721ebcd654SWolfgang Denk 14731ebcd654SWolfgang Denk Defines a default value for the subnet mask (or 14741ebcd654SWolfgang Denk routing prefix) which is used to determine if an IP 14751ebcd654SWolfgang Denk address belongs to the local subnet or needs to be 14761ebcd654SWolfgang Denk forwarded through a router. 14771ebcd654SWolfgang Denk (Environment variable "netmask") 14781ebcd654SWolfgang Denk 147953a5c424SDavid Updegraff- Multicast TFTP Mode: 148053a5c424SDavid Updegraff CONFIG_MCAST_TFTP 148153a5c424SDavid Updegraff 148253a5c424SDavid Updegraff Defines whether you want to support multicast TFTP as per 148353a5c424SDavid Updegraff rfc-2090; for example to work with atftp. Lets lots of targets 148411ccc33fSMarcel Ziswiler tftp down the same boot image concurrently. Note: the Ethernet 148553a5c424SDavid Updegraff driver in use must provide a function: mcast() to join/leave a 148653a5c424SDavid Updegraff multicast group. 148753a5c424SDavid Updegraff 1488c609719bSwdenk- BOOTP Recovery Mode: 1489c609719bSwdenk CONFIG_BOOTP_RANDOM_DELAY 1490c609719bSwdenk 1491c609719bSwdenk If you have many targets in a network that try to 1492c609719bSwdenk boot using BOOTP, you may want to avoid that all 1493c609719bSwdenk systems send out BOOTP requests at precisely the same 1494c609719bSwdenk moment (which would happen for instance at recovery 1495c609719bSwdenk from a power failure, when all systems will try to 1496c609719bSwdenk boot, thus flooding the BOOTP server. Defining 1497c609719bSwdenk CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be 1498c609719bSwdenk inserted before sending out BOOTP requests. The 14996c33c785SWolfgang Denk following delays are inserted then: 1500c609719bSwdenk 1501c609719bSwdenk 1st BOOTP request: delay 0 ... 1 sec 1502c609719bSwdenk 2nd BOOTP request: delay 0 ... 2 sec 1503c609719bSwdenk 3rd BOOTP request: delay 0 ... 4 sec 1504c609719bSwdenk 4th and following 1505c609719bSwdenk BOOTP requests: delay 0 ... 8 sec 1506c609719bSwdenk 1507fe389a82Sstroese- DHCP Advanced Options: 15081fe80d79SJon Loeliger You can fine tune the DHCP functionality by defining 15091fe80d79SJon Loeliger CONFIG_BOOTP_* symbols: 1510fe389a82Sstroese 15111fe80d79SJon Loeliger CONFIG_BOOTP_SUBNETMASK 15121fe80d79SJon Loeliger CONFIG_BOOTP_GATEWAY 15131fe80d79SJon Loeliger CONFIG_BOOTP_HOSTNAME 15141fe80d79SJon Loeliger CONFIG_BOOTP_NISDOMAIN 15151fe80d79SJon Loeliger CONFIG_BOOTP_BOOTPATH 15161fe80d79SJon Loeliger CONFIG_BOOTP_BOOTFILESIZE 15171fe80d79SJon Loeliger CONFIG_BOOTP_DNS 15181fe80d79SJon Loeliger CONFIG_BOOTP_DNS2 15191fe80d79SJon Loeliger CONFIG_BOOTP_SEND_HOSTNAME 15201fe80d79SJon Loeliger CONFIG_BOOTP_NTPSERVER 15211fe80d79SJon Loeliger CONFIG_BOOTP_TIMEOFFSET 15221fe80d79SJon Loeliger CONFIG_BOOTP_VENDOREX 1523fe389a82Sstroese 15245d110f0aSWilson Callan CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip 15255d110f0aSWilson Callan environment variable, not the BOOTP server. 1526fe389a82Sstroese 1527fe389a82Sstroese CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS 1528fe389a82Sstroese serverip from a DHCP server, it is possible that more 1529fe389a82Sstroese than one DNS serverip is offered to the client. 1530fe389a82Sstroese If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS 1531fe389a82Sstroese serverip will be stored in the additional environment 1532fe389a82Sstroese variable "dnsip2". The first DNS serverip is always 1533fe389a82Sstroese stored in the variable "dnsip", when CONFIG_BOOTP_DNS 15341fe80d79SJon Loeliger is defined. 1535fe389a82Sstroese 1536fe389a82Sstroese CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable 1537fe389a82Sstroese to do a dynamic update of a DNS server. To do this, they 1538fe389a82Sstroese need the hostname of the DHCP requester. 15395d110f0aSWilson Callan If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content 15401fe80d79SJon Loeliger of the "hostname" environment variable is passed as 15411fe80d79SJon Loeliger option 12 to the DHCP server. 1542fe389a82Sstroese 1543d9a2f416SAras Vaichas CONFIG_BOOTP_DHCP_REQUEST_DELAY 1544d9a2f416SAras Vaichas 1545d9a2f416SAras Vaichas A 32bit value in microseconds for a delay between 1546d9a2f416SAras Vaichas receiving a "DHCP Offer" and sending the "DHCP Request". 1547d9a2f416SAras Vaichas This fixes a problem with certain DHCP servers that don't 1548d9a2f416SAras Vaichas respond 100% of the time to a "DHCP request". E.g. On an 1549d9a2f416SAras Vaichas AT91RM9200 processor running at 180MHz, this delay needed 1550d9a2f416SAras Vaichas to be *at least* 15,000 usec before a Windows Server 2003 1551d9a2f416SAras Vaichas DHCP server would reply 100% of the time. I recommend at 1552d9a2f416SAras Vaichas least 50,000 usec to be safe. The alternative is to hope 1553d9a2f416SAras Vaichas that one of the retries will be successful but note that 1554d9a2f416SAras Vaichas the DHCP timeout and retry process takes a longer than 1555d9a2f416SAras Vaichas this delay. 1556d9a2f416SAras Vaichas 1557a3d991bdSwdenk - CDP Options: 1558a3d991bdSwdenk CONFIG_CDP_DEVICE_ID 1559a3d991bdSwdenk 1560a3d991bdSwdenk The device id used in CDP trigger frames. 1561a3d991bdSwdenk 1562a3d991bdSwdenk CONFIG_CDP_DEVICE_ID_PREFIX 1563a3d991bdSwdenk 1564a3d991bdSwdenk A two character string which is prefixed to the MAC address 1565a3d991bdSwdenk of the device. 1566a3d991bdSwdenk 1567a3d991bdSwdenk CONFIG_CDP_PORT_ID 1568a3d991bdSwdenk 1569a3d991bdSwdenk A printf format string which contains the ascii name of 1570a3d991bdSwdenk the port. Normally is set to "eth%d" which sets 157111ccc33fSMarcel Ziswiler eth0 for the first Ethernet, eth1 for the second etc. 1572a3d991bdSwdenk 1573a3d991bdSwdenk CONFIG_CDP_CAPABILITIES 1574a3d991bdSwdenk 1575a3d991bdSwdenk A 32bit integer which indicates the device capabilities; 1576a3d991bdSwdenk 0x00000010 for a normal host which does not forwards. 1577a3d991bdSwdenk 1578a3d991bdSwdenk CONFIG_CDP_VERSION 1579a3d991bdSwdenk 1580a3d991bdSwdenk An ascii string containing the version of the software. 1581a3d991bdSwdenk 1582a3d991bdSwdenk CONFIG_CDP_PLATFORM 1583a3d991bdSwdenk 1584a3d991bdSwdenk An ascii string containing the name of the platform. 1585a3d991bdSwdenk 1586a3d991bdSwdenk CONFIG_CDP_TRIGGER 1587a3d991bdSwdenk 1588a3d991bdSwdenk A 32bit integer sent on the trigger. 1589a3d991bdSwdenk 1590a3d991bdSwdenk CONFIG_CDP_POWER_CONSUMPTION 1591a3d991bdSwdenk 1592a3d991bdSwdenk A 16bit integer containing the power consumption of the 1593a3d991bdSwdenk device in .1 of milliwatts. 1594a3d991bdSwdenk 1595a3d991bdSwdenk CONFIG_CDP_APPLIANCE_VLAN_TYPE 1596a3d991bdSwdenk 1597a3d991bdSwdenk A byte containing the id of the VLAN. 1598a3d991bdSwdenk 1599c609719bSwdenk- Status LED: CONFIG_STATUS_LED 1600c609719bSwdenk 1601c609719bSwdenk Several configurations allow to display the current 1602c609719bSwdenk status using a LED. For instance, the LED will blink 1603c609719bSwdenk fast while running U-Boot code, stop blinking as 1604c609719bSwdenk soon as a reply to a BOOTP request was received, and 1605c609719bSwdenk start blinking slow once the Linux kernel is running 1606c609719bSwdenk (supported by a status LED driver in the Linux 1607c609719bSwdenk kernel). Defining CONFIG_STATUS_LED enables this 1608c609719bSwdenk feature in U-Boot. 1609c609719bSwdenk 1610c609719bSwdenk- CAN Support: CONFIG_CAN_DRIVER 1611c609719bSwdenk 1612c609719bSwdenk Defining CONFIG_CAN_DRIVER enables CAN driver support 1613c609719bSwdenk on those systems that support this (optional) 1614c609719bSwdenk feature, like the TQM8xxL modules. 1615c609719bSwdenk 1616c609719bSwdenk- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C 1617c609719bSwdenk 1618b37c7e5eSwdenk These enable I2C serial bus commands. Defining either of 1619b37c7e5eSwdenk (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will 162011ccc33fSMarcel Ziswiler include the appropriate I2C driver for the selected CPU. 1621c609719bSwdenk 1622b37c7e5eSwdenk This will allow you to use i2c commands at the u-boot 1623602ad3b3SJon Loeliger command line (as long as you set CONFIG_CMD_I2C in 1624b37c7e5eSwdenk CONFIG_COMMANDS) and communicate with i2c based realtime 1625b37c7e5eSwdenk clock chips. See common/cmd_i2c.c for a description of the 1626c609719bSwdenk command line interface. 1627c609719bSwdenk 1628bb99ad6dSBen Warren CONFIG_HARD_I2C selects a hardware I2C controller. 1629c609719bSwdenk 1630b37c7e5eSwdenk CONFIG_SOFT_I2C configures u-boot to use a software (aka 1631b37c7e5eSwdenk bit-banging) driver instead of CPM or similar hardware 1632b37c7e5eSwdenk support for I2C. 1633c609719bSwdenk 1634b37c7e5eSwdenk There are several other quantities that must also be 1635b37c7e5eSwdenk defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C. 1636c609719bSwdenk 16376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD In both cases you will need to define CONFIG_SYS_I2C_SPEED 1638b37c7e5eSwdenk to be the frequency (in Hz) at which you wish your i2c bus 16396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie 164011ccc33fSMarcel Ziswiler the CPU's i2c node address). 1641c609719bSwdenk 16428d321b81SPeter Tyser Now, the u-boot i2c code for the mpc8xx 1643a47a12beSStefan Roese (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node 16448d321b81SPeter Tyser and so its address should therefore be cleared to 0 (See, 16458d321b81SPeter Tyser eg, MPC823e User's Manual p.16-473). So, set 16468d321b81SPeter Tyser CONFIG_SYS_I2C_SLAVE to 0. 1647b37c7e5eSwdenk 16485da71efaSEric Millbrandt CONFIG_SYS_I2C_INIT_MPC5XXX 16495da71efaSEric Millbrandt 16505da71efaSEric Millbrandt When a board is reset during an i2c bus transfer 16515da71efaSEric Millbrandt chips might think that the current transfer is still 16525da71efaSEric Millbrandt in progress. Reset the slave devices by sending start 16535da71efaSEric Millbrandt commands until the slave device responds. 16545da71efaSEric Millbrandt 1655b37c7e5eSwdenk That's all that's required for CONFIG_HARD_I2C. 1656b37c7e5eSwdenk 1657b37c7e5eSwdenk If you use the software i2c interface (CONFIG_SOFT_I2C) 1658b37c7e5eSwdenk then the following macros need to be defined (examples are 1659b37c7e5eSwdenk from include/configs/lwmon.h): 1660c609719bSwdenk 1661c609719bSwdenk I2C_INIT 1662c609719bSwdenk 1663b37c7e5eSwdenk (Optional). Any commands necessary to enable the I2C 1664c609719bSwdenk controller or configure ports. 1665c609719bSwdenk 1666b37c7e5eSwdenk eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL) 1667b37c7e5eSwdenk 1668c609719bSwdenk I2C_PORT 1669c609719bSwdenk 1670c609719bSwdenk (Only for MPC8260 CPU). The I/O port to use (the code 1671c609719bSwdenk assumes both bits are on the same port). Valid values 1672c609719bSwdenk are 0..3 for ports A..D. 1673c609719bSwdenk 1674c609719bSwdenk I2C_ACTIVE 1675c609719bSwdenk 1676c609719bSwdenk The code necessary to make the I2C data line active 1677c609719bSwdenk (driven). If the data line is open collector, this 1678c609719bSwdenk define can be null. 1679c609719bSwdenk 1680b37c7e5eSwdenk eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA) 1681b37c7e5eSwdenk 1682c609719bSwdenk I2C_TRISTATE 1683c609719bSwdenk 1684c609719bSwdenk The code necessary to make the I2C data line tri-stated 1685c609719bSwdenk (inactive). If the data line is open collector, this 1686c609719bSwdenk define can be null. 1687c609719bSwdenk 1688b37c7e5eSwdenk eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA) 1689b37c7e5eSwdenk 1690c609719bSwdenk I2C_READ 1691c609719bSwdenk 1692c609719bSwdenk Code that returns TRUE if the I2C data line is high, 1693c609719bSwdenk FALSE if it is low. 1694c609719bSwdenk 1695b37c7e5eSwdenk eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0) 1696b37c7e5eSwdenk 1697c609719bSwdenk I2C_SDA(bit) 1698c609719bSwdenk 1699c609719bSwdenk If <bit> is TRUE, sets the I2C data line high. If it 1700c609719bSwdenk is FALSE, it clears it (low). 1701c609719bSwdenk 1702b37c7e5eSwdenk eg: #define I2C_SDA(bit) \ 1703b37c7e5eSwdenk if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \ 1704b37c7e5eSwdenk else immr->im_cpm.cp_pbdat &= ~PB_SDA 1705b37c7e5eSwdenk 1706c609719bSwdenk I2C_SCL(bit) 1707c609719bSwdenk 1708c609719bSwdenk If <bit> is TRUE, sets the I2C clock line high. If it 1709c609719bSwdenk is FALSE, it clears it (low). 1710c609719bSwdenk 1711b37c7e5eSwdenk eg: #define I2C_SCL(bit) \ 1712b37c7e5eSwdenk if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \ 1713b37c7e5eSwdenk else immr->im_cpm.cp_pbdat &= ~PB_SCL 1714b37c7e5eSwdenk 1715c609719bSwdenk I2C_DELAY 1716c609719bSwdenk 1717c609719bSwdenk This delay is invoked four times per clock cycle so this 1718c609719bSwdenk controls the rate of data transfer. The data rate thus 1719b37c7e5eSwdenk is 1 / (I2C_DELAY * 4). Often defined to be something 1720b37c7e5eSwdenk like: 1721b37c7e5eSwdenk 1722b37c7e5eSwdenk #define I2C_DELAY udelay(2) 1723c609719bSwdenk 1724793b5726SMike Frysinger CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA 1725793b5726SMike Frysinger 1726793b5726SMike Frysinger If your arch supports the generic GPIO framework (asm/gpio.h), 1727793b5726SMike Frysinger then you may alternatively define the two GPIOs that are to be 1728793b5726SMike Frysinger used as SCL / SDA. Any of the previous I2C_xxx macros will 1729793b5726SMike Frysinger have GPIO-based defaults assigned to them as appropriate. 1730793b5726SMike Frysinger 1731793b5726SMike Frysinger You should define these to the GPIO value as given directly to 1732793b5726SMike Frysinger the generic GPIO functions. 1733793b5726SMike Frysinger 17346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_INIT_BOARD 173547cd00faSwdenk 173647cd00faSwdenk When a board is reset during an i2c bus transfer 173747cd00faSwdenk chips might think that the current transfer is still 173847cd00faSwdenk in progress. On some boards it is possible to access 173947cd00faSwdenk the i2c SCLK line directly, either by using the 174047cd00faSwdenk processor pin as a GPIO or by having a second pin 174147cd00faSwdenk connected to the bus. If this option is defined a 174247cd00faSwdenk custom i2c_init_board() routine in boards/xxx/board.c 174347cd00faSwdenk is run early in the boot sequence. 174447cd00faSwdenk 174526a33504SRichard Retanubun CONFIG_SYS_I2C_BOARD_LATE_INIT 174626a33504SRichard Retanubun 174726a33504SRichard Retanubun An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is 174826a33504SRichard Retanubun defined a custom i2c_board_late_init() routine in 174926a33504SRichard Retanubun boards/xxx/board.c is run AFTER the operations in i2c_init() 175026a33504SRichard Retanubun is completed. This callpoint can be used to unreset i2c bus 175126a33504SRichard Retanubun using CPU i2c controller register accesses for CPUs whose i2c 175226a33504SRichard Retanubun controller provide such a method. It is called at the end of 175326a33504SRichard Retanubun i2c_init() to allow i2c_init operations to setup the i2c bus 175426a33504SRichard Retanubun controller on the CPU (e.g. setting bus speed & slave address). 175526a33504SRichard Retanubun 175617ea1177Swdenk CONFIG_I2CFAST (PPC405GP|PPC405EP only) 175717ea1177Swdenk 175817ea1177Swdenk This option enables configuration of bi_iic_fast[] flags 175917ea1177Swdenk in u-boot bd_info structure based on u-boot environment 176017ea1177Swdenk variable "i2cfast". (see also i2cfast) 176117ea1177Swdenk 1762bb99ad6dSBen Warren CONFIG_I2C_MULTI_BUS 1763bb99ad6dSBen Warren 1764bb99ad6dSBen Warren This option allows the use of multiple I2C buses, each of which 1765bb99ad6dSBen Warren must have a controller. At any point in time, only one bus is 1766bb99ad6dSBen Warren active. To switch to a different bus, use the 'i2c dev' command. 1767bb99ad6dSBen Warren Note that bus numbering is zero-based. 1768bb99ad6dSBen Warren 17696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_NOPROBES 1770bb99ad6dSBen Warren 1771bb99ad6dSBen Warren This option specifies a list of I2C devices that will be skipped 17720f89c54bSPeter Tyser when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS 17730f89c54bSPeter Tyser is set, specify a list of bus-device pairs. Otherwise, specify 17740f89c54bSPeter Tyser a 1D array of device addresses 1775bb99ad6dSBen Warren 1776bb99ad6dSBen Warren e.g. 1777bb99ad6dSBen Warren #undef CONFIG_I2C_MULTI_BUS 17786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68} 1779bb99ad6dSBen Warren 1780bb99ad6dSBen Warren will skip addresses 0x50 and 0x68 on a board with one I2C bus 1781bb99ad6dSBen Warren 1782bb99ad6dSBen Warren #define CONFIG_I2C_MULTI_BUS 17836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}} 1784bb99ad6dSBen Warren 1785bb99ad6dSBen Warren will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1 1786bb99ad6dSBen Warren 17876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SPD_BUS_NUM 1788be5e6181STimur Tabi 1789be5e6181STimur Tabi If defined, then this indicates the I2C bus number for DDR SPD. 1790be5e6181STimur Tabi If not defined, then U-Boot assumes that SPD is on I2C bus 0. 1791be5e6181STimur Tabi 17926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_RTC_BUS_NUM 17930dc018ecSStefan Roese 17940dc018ecSStefan Roese If defined, then this indicates the I2C bus number for the RTC. 17950dc018ecSStefan Roese If not defined, then U-Boot assumes that RTC is on I2C bus 0. 17960dc018ecSStefan Roese 17976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_DTT_BUS_NUM 17980dc018ecSStefan Roese 17990dc018ecSStefan Roese If defined, then this indicates the I2C bus number for the DTT. 18000dc018ecSStefan Roese If not defined, then U-Boot assumes that DTT is on I2C bus 0. 18010dc018ecSStefan Roese 18026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_DTT_ADDR: 18039ebbb54fSVictor Gallardo 18049ebbb54fSVictor Gallardo If defined, specifies the I2C address of the DTT device. 18059ebbb54fSVictor Gallardo If not defined, then U-Boot uses predefined value for 18069ebbb54fSVictor Gallardo specified DTT device. 18079ebbb54fSVictor Gallardo 1808be5e6181STimur Tabi CONFIG_FSL_I2C 1809be5e6181STimur Tabi 1810be5e6181STimur Tabi Define this option if you want to use Freescale's I2C driver in 18117817cb20SMarcel Ziswiler drivers/i2c/fsl_i2c.c. 1812be5e6181STimur Tabi 181367b23a32SHeiko Schocher CONFIG_I2C_MUX 181467b23a32SHeiko Schocher 181567b23a32SHeiko Schocher Define this option if you have I2C devices reached over 1 .. n 181667b23a32SHeiko Schocher I2C Muxes like the pca9544a. This option addes a new I2C 181767b23a32SHeiko Schocher Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a 181867b23a32SHeiko Schocher new I2C Bus to the existing I2C Busses. If you select the 181967b23a32SHeiko Schocher new Bus with "i2c dev", u-bbot sends first the commandos for 182067b23a32SHeiko Schocher the muxes to activate this new "bus". 182167b23a32SHeiko Schocher 182267b23a32SHeiko Schocher CONFIG_I2C_MULTI_BUS must be also defined, to use this 182367b23a32SHeiko Schocher feature! 182467b23a32SHeiko Schocher 182567b23a32SHeiko Schocher Example: 182667b23a32SHeiko Schocher Adding a new I2C Bus reached over 2 pca9544a muxes 182767b23a32SHeiko Schocher The First mux with address 70 and channel 6 182867b23a32SHeiko Schocher The Second mux with address 71 and channel 4 182967b23a32SHeiko Schocher 183067b23a32SHeiko Schocher => i2c bus pca9544a:70:6:pca9544a:71:4 183167b23a32SHeiko Schocher 183267b23a32SHeiko Schocher Use the "i2c bus" command without parameter, to get a list 183367b23a32SHeiko Schocher of I2C Busses with muxes: 183467b23a32SHeiko Schocher 183567b23a32SHeiko Schocher => i2c bus 183667b23a32SHeiko Schocher Busses reached over muxes: 183767b23a32SHeiko Schocher Bus ID: 2 183867b23a32SHeiko Schocher reached over Mux(es): 183967b23a32SHeiko Schocher pca9544a@70 ch: 4 184067b23a32SHeiko Schocher Bus ID: 3 184167b23a32SHeiko Schocher reached over Mux(es): 184267b23a32SHeiko Schocher pca9544a@70 ch: 6 184367b23a32SHeiko Schocher pca9544a@71 ch: 4 184467b23a32SHeiko Schocher => 184567b23a32SHeiko Schocher 184667b23a32SHeiko Schocher If you now switch to the new I2C Bus 3 with "i2c dev 3" 1847f9a78b8dSMichael Jones u-boot first sends the command to the mux@70 to enable 1848f9a78b8dSMichael Jones channel 6, and then the command to the mux@71 to enable 184967b23a32SHeiko Schocher the channel 4. 185067b23a32SHeiko Schocher 185167b23a32SHeiko Schocher After that, you can use the "normal" i2c commands as 1852f9a78b8dSMichael Jones usual to communicate with your I2C devices behind 185367b23a32SHeiko Schocher the 2 muxes. 185467b23a32SHeiko Schocher 185567b23a32SHeiko Schocher This option is actually implemented for the bitbanging 185667b23a32SHeiko Schocher algorithm in common/soft_i2c.c and for the Hardware I2C 185767b23a32SHeiko Schocher Bus on the MPC8260. But it should be not so difficult 185867b23a32SHeiko Schocher to add this option to other architectures. 185967b23a32SHeiko Schocher 18602ac6985aSAndrew Dyer CONFIG_SOFT_I2C_READ_REPEATED_START 18612ac6985aSAndrew Dyer 18622ac6985aSAndrew Dyer defining this will force the i2c_read() function in 18632ac6985aSAndrew Dyer the soft_i2c driver to perform an I2C repeated start 18642ac6985aSAndrew Dyer between writing the address pointer and reading the 18652ac6985aSAndrew Dyer data. If this define is omitted the default behaviour 18662ac6985aSAndrew Dyer of doing a stop-start sequence will be used. Most I2C 18672ac6985aSAndrew Dyer devices can use either method, but some require one or 18682ac6985aSAndrew Dyer the other. 1869be5e6181STimur Tabi 1870c609719bSwdenk- SPI Support: CONFIG_SPI 1871c609719bSwdenk 1872c609719bSwdenk Enables SPI driver (so far only tested with 1873c609719bSwdenk SPI EEPROM, also an instance works with Crystal A/D and 1874c609719bSwdenk D/As on the SACSng board) 1875c609719bSwdenk 18766639562eSYoshihiro Shimoda CONFIG_SH_SPI 18776639562eSYoshihiro Shimoda 18786639562eSYoshihiro Shimoda Enables the driver for SPI controller on SuperH. Currently 18796639562eSYoshihiro Shimoda only SH7757 is supported. 18806639562eSYoshihiro Shimoda 1881c609719bSwdenk CONFIG_SPI_X 1882c609719bSwdenk 1883c609719bSwdenk Enables extended (16-bit) SPI EEPROM addressing. 1884c609719bSwdenk (symmetrical to CONFIG_I2C_X) 1885c609719bSwdenk 1886c609719bSwdenk CONFIG_SOFT_SPI 1887c609719bSwdenk 1888c609719bSwdenk Enables a software (bit-bang) SPI driver rather than 1889c609719bSwdenk using hardware support. This is a general purpose 1890c609719bSwdenk driver that only requires three general I/O port pins 1891c609719bSwdenk (two outputs, one input) to function. If this is 1892c609719bSwdenk defined, the board configuration must define several 1893c609719bSwdenk SPI configuration items (port pins to use, etc). For 1894c609719bSwdenk an example, see include/configs/sacsng.h. 1895c609719bSwdenk 189604a9e118SBen Warren CONFIG_HARD_SPI 189704a9e118SBen Warren 189804a9e118SBen Warren Enables a hardware SPI driver for general-purpose reads 189904a9e118SBen Warren and writes. As with CONFIG_SOFT_SPI, the board configuration 190004a9e118SBen Warren must define a list of chip-select function pointers. 190104a9e118SBen Warren Currently supported on some MPC8xxx processors. For an 190204a9e118SBen Warren example, see include/configs/mpc8349emds.h. 190304a9e118SBen Warren 190438254f45SGuennadi Liakhovetski CONFIG_MXC_SPI 190538254f45SGuennadi Liakhovetski 190638254f45SGuennadi Liakhovetski Enables the driver for the SPI controllers on i.MX and MXC 1907*2e3cd1cdSFabio Estevam SoCs. Currently i.MX31/35/51 are supported. 190838254f45SGuennadi Liakhovetski 19090133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA 19100133502eSMatthias Fuchs 19110133502eSMatthias Fuchs Enables FPGA subsystem. 19120133502eSMatthias Fuchs 19130133502eSMatthias Fuchs CONFIG_FPGA_<vendor> 19140133502eSMatthias Fuchs 19150133502eSMatthias Fuchs Enables support for specific chip vendors. 19160133502eSMatthias Fuchs (ALTERA, XILINX) 19170133502eSMatthias Fuchs 19180133502eSMatthias Fuchs CONFIG_FPGA_<family> 19190133502eSMatthias Fuchs 19200133502eSMatthias Fuchs Enables support for FPGA family. 19210133502eSMatthias Fuchs (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX) 19220133502eSMatthias Fuchs 19230133502eSMatthias Fuchs CONFIG_FPGA_COUNT 1924c609719bSwdenk 1925c609719bSwdenk Specify the number of FPGA devices to support. 1926c609719bSwdenk 19276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_PROG_FEEDBACK 1928c609719bSwdenk 1929c609719bSwdenk Enable printing of hash marks during FPGA configuration. 1930c609719bSwdenk 19316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_BUSY 1932c609719bSwdenk 1933c609719bSwdenk Enable checks on FPGA configuration interface busy 1934c609719bSwdenk status by the configuration function. This option 1935c609719bSwdenk will require a board or device specific function to 1936c609719bSwdenk be written. 1937c609719bSwdenk 1938c609719bSwdenk CONFIG_FPGA_DELAY 1939c609719bSwdenk 1940c609719bSwdenk If defined, a function that provides delays in the FPGA 1941c609719bSwdenk configuration driver. 1942c609719bSwdenk 19436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_CTRLC 1944c609719bSwdenk Allow Control-C to interrupt FPGA configuration 1945c609719bSwdenk 19466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_ERROR 1947c609719bSwdenk 1948c609719bSwdenk Check for configuration errors during FPGA bitfile 1949c609719bSwdenk loading. For example, abort during Virtex II 1950c609719bSwdenk configuration if the INIT_B line goes low (which 1951c609719bSwdenk indicated a CRC error). 1952c609719bSwdenk 19536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_INIT 1954c609719bSwdenk 1955c609719bSwdenk Maximum time to wait for the INIT_B line to deassert 1956c609719bSwdenk after PROB_B has been deasserted during a Virtex II 1957c609719bSwdenk FPGA configuration sequence. The default time is 500 195811ccc33fSMarcel Ziswiler ms. 1959c609719bSwdenk 19606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_BUSY 1961c609719bSwdenk 1962c609719bSwdenk Maximum time to wait for BUSY to deassert during 196311ccc33fSMarcel Ziswiler Virtex II FPGA configuration. The default is 5 ms. 1964c609719bSwdenk 19656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_CONFIG 1966c609719bSwdenk 1967c609719bSwdenk Time to wait after FPGA configuration. The default is 196811ccc33fSMarcel Ziswiler 200 ms. 1969c609719bSwdenk 1970c609719bSwdenk- Configuration Management: 1971c609719bSwdenk CONFIG_IDENT_STRING 1972c609719bSwdenk 1973c609719bSwdenk If defined, this string will be added to the U-Boot 1974c609719bSwdenk version information (U_BOOT_VERSION) 1975c609719bSwdenk 1976c609719bSwdenk- Vendor Parameter Protection: 1977c609719bSwdenk 1978c609719bSwdenk U-Boot considers the values of the environment 1979c609719bSwdenk variables "serial#" (Board Serial Number) and 19807152b1d0Swdenk "ethaddr" (Ethernet Address) to be parameters that 1981c609719bSwdenk are set once by the board vendor / manufacturer, and 1982c609719bSwdenk protects these variables from casual modification by 1983c609719bSwdenk the user. Once set, these variables are read-only, 1984c609719bSwdenk and write or delete attempts are rejected. You can 198511ccc33fSMarcel Ziswiler change this behaviour: 1986c609719bSwdenk 1987c609719bSwdenk If CONFIG_ENV_OVERWRITE is #defined in your config 1988c609719bSwdenk file, the write protection for vendor parameters is 198947cd00faSwdenk completely disabled. Anybody can change or delete 1990c609719bSwdenk these parameters. 1991c609719bSwdenk 1992c609719bSwdenk Alternatively, if you #define _both_ CONFIG_ETHADDR 1993c609719bSwdenk _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default 199411ccc33fSMarcel Ziswiler Ethernet address is installed in the environment, 1995c609719bSwdenk which can be changed exactly ONCE by the user. [The 1996c609719bSwdenk serial# is unaffected by this, i. e. it remains 1997c609719bSwdenk read-only.] 1998c609719bSwdenk 1999c609719bSwdenk- Protected RAM: 2000c609719bSwdenk CONFIG_PRAM 2001c609719bSwdenk 2002c609719bSwdenk Define this variable to enable the reservation of 2003c609719bSwdenk "protected RAM", i. e. RAM which is not overwritten 2004c609719bSwdenk by U-Boot. Define CONFIG_PRAM to hold the number of 2005c609719bSwdenk kB you want to reserve for pRAM. You can overwrite 2006c609719bSwdenk this default value by defining an environment 2007c609719bSwdenk variable "pram" to the number of kB you want to 2008c609719bSwdenk reserve. Note that the board info structure will 2009c609719bSwdenk still show the full amount of RAM. If pRAM is 2010c609719bSwdenk reserved, a new environment variable "mem" will 2011c609719bSwdenk automatically be defined to hold the amount of 2012c609719bSwdenk remaining RAM in a form that can be passed as boot 2013c609719bSwdenk argument to Linux, for instance like that: 2014c609719bSwdenk 2015fe126d8bSWolfgang Denk setenv bootargs ... mem=\${mem} 2016c609719bSwdenk saveenv 2017c609719bSwdenk 2018c609719bSwdenk This way you can tell Linux not to use this memory, 2019c609719bSwdenk either, which results in a memory region that will 2020c609719bSwdenk not be affected by reboots. 2021c609719bSwdenk 2022c609719bSwdenk *WARNING* If your board configuration uses automatic 2023c609719bSwdenk detection of the RAM size, you must make sure that 2024c609719bSwdenk this memory test is non-destructive. So far, the 2025c609719bSwdenk following board configurations are known to be 2026c609719bSwdenk "pRAM-clean": 2027c609719bSwdenk 2028c609719bSwdenk ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL, 2029c609719bSwdenk HERMES, IP860, RPXlite, LWMON, LANTEC, 2030544d97e9SWolfgang Denk FLAGADM, TQM8260 2031c609719bSwdenk 2032c609719bSwdenk- Error Recovery: 2033c609719bSwdenk CONFIG_PANIC_HANG 2034c609719bSwdenk 2035c609719bSwdenk Define this variable to stop the system in case of a 2036c609719bSwdenk fatal error, so that you have to reset it manually. 2037c609719bSwdenk This is probably NOT a good idea for an embedded 203811ccc33fSMarcel Ziswiler system where you want the system to reboot 2039c609719bSwdenk automatically as fast as possible, but it may be 2040c609719bSwdenk useful during development since you can try to debug 2041c609719bSwdenk the conditions that lead to the situation. 2042c609719bSwdenk 2043c609719bSwdenk CONFIG_NET_RETRY_COUNT 2044c609719bSwdenk 2045c609719bSwdenk This variable defines the number of retries for 2046c609719bSwdenk network operations like ARP, RARP, TFTP, or BOOTP 2047c609719bSwdenk before giving up the operation. If not defined, a 2048c609719bSwdenk default value of 5 is used. 2049c609719bSwdenk 205040cb90eeSGuennadi Liakhovetski CONFIG_ARP_TIMEOUT 205140cb90eeSGuennadi Liakhovetski 205240cb90eeSGuennadi Liakhovetski Timeout waiting for an ARP reply in milliseconds. 205340cb90eeSGuennadi Liakhovetski 2054c609719bSwdenk- Command Interpreter: 20558078f1a5SWolfgang Denk CONFIG_AUTO_COMPLETE 205604a85b3bSwdenk 205704a85b3bSwdenk Enable auto completion of commands using TAB. 205804a85b3bSwdenk 20598078f1a5SWolfgang Denk Note that this feature has NOT been implemented yet 20608078f1a5SWolfgang Denk for the "hush" shell. 20618078f1a5SWolfgang Denk 20628078f1a5SWolfgang Denk 20636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_HUSH_PARSER 2064c609719bSwdenk 2065c609719bSwdenk Define this variable to enable the "hush" shell (from 2066c609719bSwdenk Busybox) as command line interpreter, thus enabling 2067c609719bSwdenk powerful command line syntax like 2068c609719bSwdenk if...then...else...fi conditionals or `&&' and '||' 2069c609719bSwdenk constructs ("shell scripts"). 2070c609719bSwdenk 2071c609719bSwdenk If undefined, you get the old, much simpler behaviour 2072c609719bSwdenk with a somewhat smaller memory footprint. 2073c609719bSwdenk 2074c609719bSwdenk 20756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PROMPT_HUSH_PS2 2076c609719bSwdenk 2077c609719bSwdenk This defines the secondary prompt string, which is 2078c609719bSwdenk printed when the command interpreter needs more input 2079c609719bSwdenk to complete a command. Usually "> ". 2080c609719bSwdenk 2081c609719bSwdenk Note: 2082c609719bSwdenk 2083c609719bSwdenk In the current implementation, the local variables 2084c609719bSwdenk space and global environment variables space are 2085c609719bSwdenk separated. Local variables are those you define by 20863b57fe0aSwdenk simply typing `name=value'. To access a local 2087c609719bSwdenk variable later on, you have write `$name' or 20883b57fe0aSwdenk `${name}'; to execute the contents of a variable 20893b57fe0aSwdenk directly type `$name' at the command prompt. 2090c609719bSwdenk 2091c609719bSwdenk Global environment variables are those you use 2092c609719bSwdenk setenv/printenv to work with. To run a command stored 2093c609719bSwdenk in such a variable, you need to use the run command, 2094c609719bSwdenk and you must not use the '$' sign to access them. 2095c609719bSwdenk 2096c609719bSwdenk To store commands and special characters in a 2097c609719bSwdenk variable, please use double quotation marks 2098c609719bSwdenk surrounding the whole text of the variable, instead 2099c609719bSwdenk of the backslashes before semicolons and special 2100c609719bSwdenk symbols. 2101c609719bSwdenk 2102aa0c71acSWolfgang Denk- Commandline Editing and History: 2103aa0c71acSWolfgang Denk CONFIG_CMDLINE_EDITING 2104aa0c71acSWolfgang Denk 210511ccc33fSMarcel Ziswiler Enable editing and History functions for interactive 2106aa0c71acSWolfgang Denk commandline input operations 2107aa0c71acSWolfgang Denk 2108a8c7c708Swdenk- Default Environment: 2109c609719bSwdenk CONFIG_EXTRA_ENV_SETTINGS 2110c609719bSwdenk 2111c609719bSwdenk Define this to contain any number of null terminated 2112c609719bSwdenk strings (variable = value pairs) that will be part of 21137152b1d0Swdenk the default environment compiled into the boot image. 21142262cfeeSwdenk 2115c609719bSwdenk For example, place something like this in your 2116c609719bSwdenk board's config file: 2117c609719bSwdenk 2118c609719bSwdenk #define CONFIG_EXTRA_ENV_SETTINGS \ 2119c609719bSwdenk "myvar1=value1\0" \ 2120c609719bSwdenk "myvar2=value2\0" 2121c609719bSwdenk 2122c609719bSwdenk Warning: This method is based on knowledge about the 2123c609719bSwdenk internal format how the environment is stored by the 21242262cfeeSwdenk U-Boot code. This is NOT an official, exported 2125c609719bSwdenk interface! Although it is unlikely that this format 21267152b1d0Swdenk will change soon, there is no guarantee either. 2127c609719bSwdenk You better know what you are doing here. 2128c609719bSwdenk 2129c609719bSwdenk Note: overly (ab)use of the default environment is 2130c609719bSwdenk discouraged. Make sure to check other ways to preset 213174de7aefSWolfgang Denk the environment like the "source" command or the 2132c609719bSwdenk boot command first. 2133c609719bSwdenk 2134a8c7c708Swdenk- DataFlash Support: 21352abbe075Swdenk CONFIG_HAS_DATAFLASH 21362abbe075Swdenk 21372abbe075Swdenk Defining this option enables DataFlash features and 21382abbe075Swdenk allows to read/write in Dataflash via the standard 21392abbe075Swdenk commands cp, md... 21402abbe075Swdenk 21413f85ce27Swdenk- SystemACE Support: 21423f85ce27Swdenk CONFIG_SYSTEMACE 21433f85ce27Swdenk 21443f85ce27Swdenk Adding this option adds support for Xilinx SystemACE 21453f85ce27Swdenk chips attached via some sort of local bus. The address 214611ccc33fSMarcel Ziswiler of the chip must also be defined in the 21476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SYSTEMACE_BASE macro. For example: 21483f85ce27Swdenk 21493f85ce27Swdenk #define CONFIG_SYSTEMACE 21506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000 21513f85ce27Swdenk 21523f85ce27Swdenk When SystemACE support is added, the "ace" device type 21533f85ce27Swdenk becomes available to the fat commands, i.e. fatls. 21543f85ce27Swdenk 2155ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port: 2156ecb0ccd9SWolfgang Denk CONFIG_TFTP_PORT 2157ecb0ccd9SWolfgang Denk 215828cb9375SWolfgang Denk If this is defined, the environment variable tftpsrcp 2159ecb0ccd9SWolfgang Denk is used to supply the TFTP UDP source port value. 216028cb9375SWolfgang Denk If tftpsrcp isn't defined, the normal pseudo-random port 2161ecb0ccd9SWolfgang Denk number generator is used. 2162ecb0ccd9SWolfgang Denk 216328cb9375SWolfgang Denk Also, the environment variable tftpdstp is used to supply 216428cb9375SWolfgang Denk the TFTP UDP destination port value. If tftpdstp isn't 216528cb9375SWolfgang Denk defined, the normal port 69 is used. 216628cb9375SWolfgang Denk 216728cb9375SWolfgang Denk The purpose for tftpsrcp is to allow a TFTP server to 2168ecb0ccd9SWolfgang Denk blindly start the TFTP transfer using the pre-configured 2169ecb0ccd9SWolfgang Denk target IP address and UDP port. This has the effect of 2170ecb0ccd9SWolfgang Denk "punching through" the (Windows XP) firewall, allowing 2171ecb0ccd9SWolfgang Denk the remainder of the TFTP transfer to proceed normally. 2172ecb0ccd9SWolfgang Denk A better solution is to properly configure the firewall, 2173ecb0ccd9SWolfgang Denk but sometimes that is not allowed. 2174ecb0ccd9SWolfgang Denk 2175a8c7c708Swdenk- Show boot progress: 2176c609719bSwdenk CONFIG_SHOW_BOOT_PROGRESS 2177c609719bSwdenk 2178c609719bSwdenk Defining this option allows to add some board- 2179c609719bSwdenk specific code (calling a user-provided function 2180c609719bSwdenk "show_boot_progress(int)") that enables you to show 2181c609719bSwdenk the system's boot progress on some display (for 2182c609719bSwdenk example, some LED's) on your board. At the moment, 2183c609719bSwdenk the following checkpoints are implemented: 2184c609719bSwdenk 21851372cce2SMarian BalakowiczLegacy uImage format: 21861372cce2SMarian Balakowicz 2187c609719bSwdenk Arg Where When 2188c609719bSwdenk 1 common/cmd_bootm.c before attempting to boot an image 2189c609719bSwdenk -1 common/cmd_bootm.c Image header has bad magic number 2190c609719bSwdenk 2 common/cmd_bootm.c Image header has correct magic number 2191c609719bSwdenk -2 common/cmd_bootm.c Image header has bad checksum 2192c609719bSwdenk 3 common/cmd_bootm.c Image header has correct checksum 2193c609719bSwdenk -3 common/cmd_bootm.c Image data has bad checksum 2194c609719bSwdenk 4 common/cmd_bootm.c Image data has correct checksum 2195c609719bSwdenk -4 common/cmd_bootm.c Image is for unsupported architecture 2196c609719bSwdenk 5 common/cmd_bootm.c Architecture check OK 21971372cce2SMarian Balakowicz -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi) 2198c609719bSwdenk 6 common/cmd_bootm.c Image Type check OK 2199c609719bSwdenk -6 common/cmd_bootm.c gunzip uncompression error 2200c609719bSwdenk -7 common/cmd_bootm.c Unimplemented compression type 2201c609719bSwdenk 7 common/cmd_bootm.c Uncompression OK 22021372cce2SMarian Balakowicz 8 common/cmd_bootm.c No uncompress/copy overwrite error 2203c609719bSwdenk -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX) 22041372cce2SMarian Balakowicz 22051372cce2SMarian Balakowicz 9 common/image.c Start initial ramdisk verification 22061372cce2SMarian Balakowicz -10 common/image.c Ramdisk header has bad magic number 22071372cce2SMarian Balakowicz -11 common/image.c Ramdisk header has bad checksum 22081372cce2SMarian Balakowicz 10 common/image.c Ramdisk header is OK 22091372cce2SMarian Balakowicz -12 common/image.c Ramdisk data has bad checksum 22101372cce2SMarian Balakowicz 11 common/image.c Ramdisk data has correct checksum 22111372cce2SMarian Balakowicz 12 common/image.c Ramdisk verification complete, start loading 221211ccc33fSMarcel Ziswiler -13 common/image.c Wrong Image Type (not PPC Linux ramdisk) 22131372cce2SMarian Balakowicz 13 common/image.c Start multifile image verification 22141372cce2SMarian Balakowicz 14 common/image.c No initial ramdisk, no multifile, continue. 22151372cce2SMarian Balakowicz 2216ea0364f1SPeter Tyser 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS 2217c609719bSwdenk 2218a47a12beSStefan Roese -30 arch/powerpc/lib/board.c Fatal error, hang the system 221963e73c9aSwdenk -31 post/post.c POST test failed, detected by post_output_backlog() 222063e73c9aSwdenk -32 post/post.c POST test failed, detected by post_run_single() 222163e73c9aSwdenk 2222566a494fSHeiko Schocher 34 common/cmd_doc.c before loading a Image from a DOC device 2223566a494fSHeiko Schocher -35 common/cmd_doc.c Bad usage of "doc" command 2224566a494fSHeiko Schocher 35 common/cmd_doc.c correct usage of "doc" command 2225566a494fSHeiko Schocher -36 common/cmd_doc.c No boot device 2226566a494fSHeiko Schocher 36 common/cmd_doc.c correct boot device 2227566a494fSHeiko Schocher -37 common/cmd_doc.c Unknown Chip ID on boot device 2228566a494fSHeiko Schocher 37 common/cmd_doc.c correct chip ID found, device available 2229566a494fSHeiko Schocher -38 common/cmd_doc.c Read Error on boot device 2230566a494fSHeiko Schocher 38 common/cmd_doc.c reading Image header from DOC device OK 2231566a494fSHeiko Schocher -39 common/cmd_doc.c Image header has bad magic number 2232566a494fSHeiko Schocher 39 common/cmd_doc.c Image header has correct magic number 2233566a494fSHeiko Schocher -40 common/cmd_doc.c Error reading Image from DOC device 2234566a494fSHeiko Schocher 40 common/cmd_doc.c Image header has correct magic number 2235566a494fSHeiko Schocher 41 common/cmd_ide.c before loading a Image from a IDE device 2236566a494fSHeiko Schocher -42 common/cmd_ide.c Bad usage of "ide" command 2237566a494fSHeiko Schocher 42 common/cmd_ide.c correct usage of "ide" command 2238566a494fSHeiko Schocher -43 common/cmd_ide.c No boot device 2239566a494fSHeiko Schocher 43 common/cmd_ide.c boot device found 2240566a494fSHeiko Schocher -44 common/cmd_ide.c Device not available 2241566a494fSHeiko Schocher 44 common/cmd_ide.c Device available 2242566a494fSHeiko Schocher -45 common/cmd_ide.c wrong partition selected 2243566a494fSHeiko Schocher 45 common/cmd_ide.c partition selected 2244566a494fSHeiko Schocher -46 common/cmd_ide.c Unknown partition table 2245566a494fSHeiko Schocher 46 common/cmd_ide.c valid partition table found 2246566a494fSHeiko Schocher -47 common/cmd_ide.c Invalid partition type 2247566a494fSHeiko Schocher 47 common/cmd_ide.c correct partition type 2248566a494fSHeiko Schocher -48 common/cmd_ide.c Error reading Image Header on boot device 2249566a494fSHeiko Schocher 48 common/cmd_ide.c reading Image Header from IDE device OK 2250566a494fSHeiko Schocher -49 common/cmd_ide.c Image header has bad magic number 2251566a494fSHeiko Schocher 49 common/cmd_ide.c Image header has correct magic number 2252566a494fSHeiko Schocher -50 common/cmd_ide.c Image header has bad checksum 2253566a494fSHeiko Schocher 50 common/cmd_ide.c Image header has correct checksum 2254566a494fSHeiko Schocher -51 common/cmd_ide.c Error reading Image from IDE device 2255566a494fSHeiko Schocher 51 common/cmd_ide.c reading Image from IDE device OK 2256566a494fSHeiko Schocher 52 common/cmd_nand.c before loading a Image from a NAND device 2257566a494fSHeiko Schocher -53 common/cmd_nand.c Bad usage of "nand" command 2258566a494fSHeiko Schocher 53 common/cmd_nand.c correct usage of "nand" command 2259566a494fSHeiko Schocher -54 common/cmd_nand.c No boot device 2260566a494fSHeiko Schocher 54 common/cmd_nand.c boot device found 2261566a494fSHeiko Schocher -55 common/cmd_nand.c Unknown Chip ID on boot device 2262566a494fSHeiko Schocher 55 common/cmd_nand.c correct chip ID found, device available 2263566a494fSHeiko Schocher -56 common/cmd_nand.c Error reading Image Header on boot device 2264566a494fSHeiko Schocher 56 common/cmd_nand.c reading Image Header from NAND device OK 2265566a494fSHeiko Schocher -57 common/cmd_nand.c Image header has bad magic number 2266566a494fSHeiko Schocher 57 common/cmd_nand.c Image header has correct magic number 2267566a494fSHeiko Schocher -58 common/cmd_nand.c Error reading Image from NAND device 2268566a494fSHeiko Schocher 58 common/cmd_nand.c reading Image from NAND device OK 2269c609719bSwdenk 2270566a494fSHeiko Schocher -60 common/env_common.c Environment has a bad CRC, using default 2271c609719bSwdenk 2272566a494fSHeiko Schocher 64 net/eth.c starting with Ethernet configuration. 2273566a494fSHeiko Schocher -64 net/eth.c no Ethernet found. 2274566a494fSHeiko Schocher 65 net/eth.c Ethernet found. 2275206c60cbSwdenk 2276566a494fSHeiko Schocher -80 common/cmd_net.c usage wrong 2277566a494fSHeiko Schocher 80 common/cmd_net.c before calling NetLoop() 227811ccc33fSMarcel Ziswiler -81 common/cmd_net.c some error in NetLoop() occurred 2279566a494fSHeiko Schocher 81 common/cmd_net.c NetLoop() back without error 2280566a494fSHeiko Schocher -82 common/cmd_net.c size == 0 (File with size 0 loaded) 2281566a494fSHeiko Schocher 82 common/cmd_net.c trying automatic boot 228274de7aefSWolfgang Denk 83 common/cmd_net.c running "source" command 228374de7aefSWolfgang Denk -83 common/cmd_net.c some error in automatic boot or "source" command 2284566a494fSHeiko Schocher 84 common/cmd_net.c end without errors 2285c609719bSwdenk 22861372cce2SMarian BalakowiczFIT uImage format: 22871372cce2SMarian Balakowicz 22881372cce2SMarian Balakowicz Arg Where When 22891372cce2SMarian Balakowicz 100 common/cmd_bootm.c Kernel FIT Image has correct format 22901372cce2SMarian Balakowicz -100 common/cmd_bootm.c Kernel FIT Image has incorrect format 22911372cce2SMarian Balakowicz 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration 22921372cce2SMarian Balakowicz -101 common/cmd_bootm.c Can't get configuration for kernel subimage 22931372cce2SMarian Balakowicz 102 common/cmd_bootm.c Kernel unit name specified 22941372cce2SMarian Balakowicz -103 common/cmd_bootm.c Can't get kernel subimage node offset 2295f773bea8SMarian Balakowicz 103 common/cmd_bootm.c Found configuration node 22961372cce2SMarian Balakowicz 104 common/cmd_bootm.c Got kernel subimage node offset 22971372cce2SMarian Balakowicz -104 common/cmd_bootm.c Kernel subimage hash verification failed 22981372cce2SMarian Balakowicz 105 common/cmd_bootm.c Kernel subimage hash verification OK 22991372cce2SMarian Balakowicz -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture 23001372cce2SMarian Balakowicz 106 common/cmd_bootm.c Architecture check OK 230111ccc33fSMarcel Ziswiler -106 common/cmd_bootm.c Kernel subimage has wrong type 230211ccc33fSMarcel Ziswiler 107 common/cmd_bootm.c Kernel subimage type OK 23031372cce2SMarian Balakowicz -107 common/cmd_bootm.c Can't get kernel subimage data/size 23041372cce2SMarian Balakowicz 108 common/cmd_bootm.c Got kernel subimage data/size 23051372cce2SMarian Balakowicz -108 common/cmd_bootm.c Wrong image type (not legacy, FIT) 23061372cce2SMarian Balakowicz -109 common/cmd_bootm.c Can't get kernel subimage type 23071372cce2SMarian Balakowicz -110 common/cmd_bootm.c Can't get kernel subimage comp 23081372cce2SMarian Balakowicz -111 common/cmd_bootm.c Can't get kernel subimage os 23091372cce2SMarian Balakowicz -112 common/cmd_bootm.c Can't get kernel subimage load address 23101372cce2SMarian Balakowicz -113 common/cmd_bootm.c Image uncompress/copy overwrite error 23111372cce2SMarian Balakowicz 23121372cce2SMarian Balakowicz 120 common/image.c Start initial ramdisk verification 23131372cce2SMarian Balakowicz -120 common/image.c Ramdisk FIT image has incorrect format 23141372cce2SMarian Balakowicz 121 common/image.c Ramdisk FIT image has correct format 231511ccc33fSMarcel Ziswiler 122 common/image.c No ramdisk subimage unit name, using configuration 23161372cce2SMarian Balakowicz -122 common/image.c Can't get configuration for ramdisk subimage 23171372cce2SMarian Balakowicz 123 common/image.c Ramdisk unit name specified 23181372cce2SMarian Balakowicz -124 common/image.c Can't get ramdisk subimage node offset 23191372cce2SMarian Balakowicz 125 common/image.c Got ramdisk subimage node offset 23201372cce2SMarian Balakowicz -125 common/image.c Ramdisk subimage hash verification failed 23211372cce2SMarian Balakowicz 126 common/image.c Ramdisk subimage hash verification OK 23221372cce2SMarian Balakowicz -126 common/image.c Ramdisk subimage for unsupported architecture 23231372cce2SMarian Balakowicz 127 common/image.c Architecture check OK 23241372cce2SMarian Balakowicz -127 common/image.c Can't get ramdisk subimage data/size 23251372cce2SMarian Balakowicz 128 common/image.c Got ramdisk subimage data/size 23261372cce2SMarian Balakowicz 129 common/image.c Can't get ramdisk load address 23271372cce2SMarian Balakowicz -129 common/image.c Got ramdisk load address 23281372cce2SMarian Balakowicz 232911ccc33fSMarcel Ziswiler -130 common/cmd_doc.c Incorrect FIT image format 23301372cce2SMarian Balakowicz 131 common/cmd_doc.c FIT image format OK 23311372cce2SMarian Balakowicz 233211ccc33fSMarcel Ziswiler -140 common/cmd_ide.c Incorrect FIT image format 23331372cce2SMarian Balakowicz 141 common/cmd_ide.c FIT image format OK 23341372cce2SMarian Balakowicz 233511ccc33fSMarcel Ziswiler -150 common/cmd_nand.c Incorrect FIT image format 23361372cce2SMarian Balakowicz 151 common/cmd_nand.c FIT image format OK 23371372cce2SMarian Balakowicz 23384cf2609bSWolfgang Denk- Standalone program support: 23394cf2609bSWolfgang Denk CONFIG_STANDALONE_LOAD_ADDR 23404cf2609bSWolfgang Denk 23416feff899SWolfgang Denk This option defines a board specific value for the 23426feff899SWolfgang Denk address where standalone program gets loaded, thus 23436feff899SWolfgang Denk overwriting the architecture dependent default 23444cf2609bSWolfgang Denk settings. 23454cf2609bSWolfgang Denk 23464cf2609bSWolfgang Denk- Frame Buffer Address: 23474cf2609bSWolfgang Denk CONFIG_FB_ADDR 23484cf2609bSWolfgang Denk 23494cf2609bSWolfgang Denk Define CONFIG_FB_ADDR if you want to use specific 23504cf2609bSWolfgang Denk address for frame buffer. 23514cf2609bSWolfgang Denk Then system will reserve the frame buffer address to 23524cf2609bSWolfgang Denk defined address instead of lcd_setmem (this function 23536feff899SWolfgang Denk grabs the memory for frame buffer by panel's size). 23544cf2609bSWolfgang Denk 23554cf2609bSWolfgang Denk Please see board_init_f function. 23564cf2609bSWolfgang Denk 2357cccfc2abSDetlev Zundel- Automatic software updates via TFTP server 2358cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP 2359cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP_CNT_MAX 2360cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP_MSEC_MAX 2361cccfc2abSDetlev Zundel 2362cccfc2abSDetlev Zundel These options enable and control the auto-update feature; 2363cccfc2abSDetlev Zundel for a more detailed description refer to doc/README.update. 2364cccfc2abSDetlev Zundel 2365cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support) 2366cccfc2abSDetlev Zundel CONFIG_MTD_DEVICE 2367cccfc2abSDetlev Zundel 2368cccfc2abSDetlev Zundel Adds the MTD device infrastructure from the Linux kernel. 2369cccfc2abSDetlev Zundel Needed for mtdparts command support. 2370cccfc2abSDetlev Zundel 2371cccfc2abSDetlev Zundel CONFIG_MTD_PARTITIONS 2372cccfc2abSDetlev Zundel 2373cccfc2abSDetlev Zundel Adds the MTD partitioning infrastructure from the Linux 2374cccfc2abSDetlev Zundel kernel. Needed for UBI support. 2375cccfc2abSDetlev Zundel 23766a11cf48SDaniel Schwierzeck- SPL framework 23776a11cf48SDaniel Schwierzeck CONFIG_SPL 23786a11cf48SDaniel Schwierzeck Enable building of SPL globally. 23796a11cf48SDaniel Schwierzeck 23806a11cf48SDaniel Schwierzeck CONFIG_SPL_TEXT_BASE 23816a11cf48SDaniel Schwierzeck TEXT_BASE for linking the SPL binary. 23826a11cf48SDaniel Schwierzeck 23836a11cf48SDaniel Schwierzeck CONFIG_SPL_LDSCRIPT 23846a11cf48SDaniel Schwierzeck LDSCRIPT for linking the SPL binary. 23856a11cf48SDaniel Schwierzeck 23866a11cf48SDaniel Schwierzeck CONFIG_SPL_LIBCOMMON_SUPPORT 23876a11cf48SDaniel Schwierzeck Support for common/libcommon.o in SPL binary 23886a11cf48SDaniel Schwierzeck 23896a11cf48SDaniel Schwierzeck CONFIG_SPL_LIBDISK_SUPPORT 23906a11cf48SDaniel Schwierzeck Support for disk/libdisk.o in SPL binary 23916a11cf48SDaniel Schwierzeck 23926a11cf48SDaniel Schwierzeck CONFIG_SPL_I2C_SUPPORT 23936a11cf48SDaniel Schwierzeck Support for drivers/i2c/libi2c.o in SPL binary 23946a11cf48SDaniel Schwierzeck 23956a11cf48SDaniel Schwierzeck CONFIG_SPL_GPIO_SUPPORT 23966a11cf48SDaniel Schwierzeck Support for drivers/gpio/libgpio.o in SPL binary 23976a11cf48SDaniel Schwierzeck 23986a11cf48SDaniel Schwierzeck CONFIG_SPL_MMC_SUPPORT 23996a11cf48SDaniel Schwierzeck Support for drivers/mmc/libmmc.o in SPL binary 24006a11cf48SDaniel Schwierzeck 24016a11cf48SDaniel Schwierzeck CONFIG_SPL_SERIAL_SUPPORT 24026a11cf48SDaniel Schwierzeck Support for drivers/serial/libserial.o in SPL binary 24036a11cf48SDaniel Schwierzeck 24046a11cf48SDaniel Schwierzeck CONFIG_SPL_SPI_FLASH_SUPPORT 24056a11cf48SDaniel Schwierzeck Support for drivers/mtd/spi/libspi_flash.o in SPL binary 24066a11cf48SDaniel Schwierzeck 24076a11cf48SDaniel Schwierzeck CONFIG_SPL_SPI_SUPPORT 24086a11cf48SDaniel Schwierzeck Support for drivers/spi/libspi.o in SPL binary 24096a11cf48SDaniel Schwierzeck 24106a11cf48SDaniel Schwierzeck CONFIG_SPL_FAT_SUPPORT 24116a11cf48SDaniel Schwierzeck Support for fs/fat/libfat.o in SPL binary 24126a11cf48SDaniel Schwierzeck 24136a11cf48SDaniel Schwierzeck CONFIG_SPL_LIBGENERIC_SUPPORT 24146a11cf48SDaniel Schwierzeck Support for lib/libgeneric.o in SPL binary 24151372cce2SMarian Balakowicz 2416c609719bSwdenkModem Support: 2417c609719bSwdenk-------------- 2418c609719bSwdenk 2419566e5cf4SWolfgang Denk[so far only for SMDK2400 boards] 2420c609719bSwdenk 242111ccc33fSMarcel Ziswiler- Modem support enable: 2422c609719bSwdenk CONFIG_MODEM_SUPPORT 2423c609719bSwdenk 2424c609719bSwdenk- RTS/CTS Flow control enable: 2425c609719bSwdenk CONFIG_HWFLOW 2426c609719bSwdenk 2427c609719bSwdenk- Modem debug support: 2428c609719bSwdenk CONFIG_MODEM_SUPPORT_DEBUG 2429c609719bSwdenk 2430c609719bSwdenk Enables debugging stuff (char screen[1024], dbg()) 2431c609719bSwdenk for modem support. Useful only with BDI2000. 2432c609719bSwdenk 2433a8c7c708Swdenk- Interrupt support (PPC): 2434a8c7c708Swdenk 2435a8c7c708Swdenk There are common interrupt_init() and timer_interrupt() 2436a8c7c708Swdenk for all PPC archs. interrupt_init() calls interrupt_init_cpu() 243711ccc33fSMarcel Ziswiler for CPU specific initialization. interrupt_init_cpu() 2438a8c7c708Swdenk should set decrementer_count to appropriate value. If 243911ccc33fSMarcel Ziswiler CPU resets decrementer automatically after interrupt 2440a8c7c708Swdenk (ppc4xx) it should set decrementer_count to zero. 244111ccc33fSMarcel Ziswiler timer_interrupt() calls timer_interrupt_cpu() for CPU 2442a8c7c708Swdenk specific handling. If board has watchdog / status_led 2443a8c7c708Swdenk / other_activity_monitor it works automatically from 2444a8c7c708Swdenk general timer_interrupt(). 2445a8c7c708Swdenk 2446c609719bSwdenk- General: 2447c609719bSwdenk 2448c609719bSwdenk In the target system modem support is enabled when a 2449c609719bSwdenk specific key (key combination) is pressed during 2450c609719bSwdenk power-on. Otherwise U-Boot will boot normally 245111ccc33fSMarcel Ziswiler (autoboot). The key_pressed() function is called from 2452c609719bSwdenk board_init(). Currently key_pressed() is a dummy 2453c609719bSwdenk function, returning 1 and thus enabling modem 2454c609719bSwdenk initialization. 2455c609719bSwdenk 2456c609719bSwdenk If there are no modem init strings in the 2457c609719bSwdenk environment, U-Boot proceed to autoboot; the 2458c609719bSwdenk previous output (banner, info printfs) will be 245911ccc33fSMarcel Ziswiler suppressed, though. 2460c609719bSwdenk 2461c609719bSwdenk See also: doc/README.Modem 2462c609719bSwdenk 24639660e442SHelmut RaigerBoard initialization settings: 24649660e442SHelmut Raiger------------------------------ 24659660e442SHelmut Raiger 24669660e442SHelmut RaigerDuring Initialization u-boot calls a number of board specific functions 24679660e442SHelmut Raigerto allow the preparation of board specific prerequisites, e.g. pin setup 24689660e442SHelmut Raigerbefore drivers are initialized. To enable these callbacks the 24699660e442SHelmut Raigerfollowing configuration macros have to be defined. Currently this is 24709660e442SHelmut Raigerarchitecture specific, so please check arch/your_architecture/lib/board.c 24719660e442SHelmut Raigertypically in board_init_f() and board_init_r(). 24729660e442SHelmut Raiger 24739660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f() 24749660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r() 24759660e442SHelmut Raiger- CONFIG_BOARD_LATE_INIT: Call board_late_init() 24769660e442SHelmut Raiger- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init() 2477c609719bSwdenk 2478c609719bSwdenkConfiguration Settings: 2479c609719bSwdenk----------------------- 2480c609719bSwdenk 24816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included; 2482c609719bSwdenk undefine this when you're short of memory. 2483c609719bSwdenk 24842fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default 24852fb2604dSPeter Tyser width of the commands listed in the 'help' command output. 24862fb2604dSPeter Tyser 24876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to 2488c609719bSwdenk prompt for user input. 2489c609719bSwdenk 24906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE: Buffer size for input from the Console 2491c609719bSwdenk 24926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE: Buffer size for Console output 2493c609719bSwdenk 24946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands 2495c609719bSwdenk 24966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to 2497c609719bSwdenk the application (usually a Linux kernel) when it is 2498c609719bSwdenk booted 2499c609719bSwdenk 25006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE: 2501c609719bSwdenk List of legal baudrate settings for this board. 2502c609719bSwdenk 25036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET 2504c609719bSwdenk Suppress display of console information at boot. 2505c609719bSwdenk 25066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV 2507c609719bSwdenk If the board specific function 2508c609719bSwdenk extern int overwrite_console (void); 2509c609719bSwdenk returns 1, the stdin, stderr and stdout are switched to the 2510c609719bSwdenk serial port, else the settings in the environment are used. 2511c609719bSwdenk 25126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE 2513c609719bSwdenk Enable the call to overwrite_console(). 2514c609719bSwdenk 25156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE 2516c609719bSwdenk Enable overwrite of previous console environment settings. 2517c609719bSwdenk 25186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END: 2519c609719bSwdenk Begin and End addresses of the area used by the 2520c609719bSwdenk simple memory test. 2521c609719bSwdenk 25226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST: 2523c609719bSwdenk Enable an alternate, more extensive memory test. 2524c609719bSwdenk 25256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH: 25265f535fe1Swdenk Scratch address used by the alternate memory test 25275f535fe1Swdenk You only need to set this if address zero isn't writeable 25285f535fe1Swdenk 25296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only): 25306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header, 253114f73ca6SStefan Roese this specified memory area will get subtracted from the top 253211ccc33fSMarcel Ziswiler (end) of RAM and won't get "touched" at all by U-Boot. By 253314f73ca6SStefan Roese fixing up gd->ram_size the Linux kernel should gets passed 253414f73ca6SStefan Roese the now "corrected" memory size and won't touch it either. 253514f73ca6SStefan Roese This should work for arch/ppc and arch/powerpc. Only Linux 25365e12e75dSStefan Roese board ports in arch/powerpc with bootwrapper support that 253714f73ca6SStefan Roese recalculate the memory size from the SDRAM controller setup 25385e12e75dSStefan Roese will have to get fixed in Linux additionally. 253914f73ca6SStefan Roese 254014f73ca6SStefan Roese This option can be used as a workaround for the 440EPx/GRx 254114f73ca6SStefan Roese CHIP 11 errata where the last 256 bytes in SDRAM shouldn't 254214f73ca6SStefan Roese be touched. 254314f73ca6SStefan Roese 254414f73ca6SStefan Roese WARNING: Please make sure that this value is a multiple of 254514f73ca6SStefan Roese the Linux page size (normally 4k). If this is not the case, 254614f73ca6SStefan Roese then the end address of the Linux memory will be located at a 254714f73ca6SStefan Roese non page size aligned address and this could cause major 254814f73ca6SStefan Roese problems. 254914f73ca6SStefan Roese 25506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TFTP_LOADADDR: 2551c609719bSwdenk Default load address for network file downloads 2552c609719bSwdenk 25536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE: 2554c609719bSwdenk Enable temporary baudrate change while serial download 2555c609719bSwdenk 25566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE: 2557c609719bSwdenk Physical start address of SDRAM. _Must_ be 0 here. 2558c609719bSwdenk 25596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE: 2560c609719bSwdenk Physical start address of Motherboard I/O (if using a 2561c609719bSwdenk Cogent motherboard) 2562c609719bSwdenk 25636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE: 2564c609719bSwdenk Physical start address of Flash memory. 2565c609719bSwdenk 25666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE: 2567c609719bSwdenk Physical start address of boot monitor code (set by 2568c609719bSwdenk make config files to be same as the text base address 256914d0a02aSWolfgang Denk (CONFIG_SYS_TEXT_BASE) used when linking) - same as 25706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FLASH_BASE when booting from flash. 2571c609719bSwdenk 25726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN: 25733b57fe0aSwdenk Size of memory reserved for monitor code, used to 25743b57fe0aSwdenk determine _at_compile_time_ (!) if the environment is 25753b57fe0aSwdenk embedded within the U-Boot image, or in a separate 25763b57fe0aSwdenk flash sector. 2577c609719bSwdenk 25786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN: 2579c609719bSwdenk Size of DRAM reserved for malloc() use. 2580c609719bSwdenk 25816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN: 258215940c9aSStefan Roese Normally compressed uImages are limited to an 258315940c9aSStefan Roese uncompressed size of 8 MBytes. If this is not enough, 25846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD you can define CONFIG_SYS_BOOTM_LEN in your board config file 258515940c9aSStefan Roese to adjust this setting to your needs. 2586c609719bSwdenk 25876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ: 2588c609719bSwdenk Maximum size of memory mapped by the startup code of 2589c609719bSwdenk the Linux kernel; all data that must be processed by 25907d721e34SBartlomiej Sieka the Linux kernel (bd_info, boot arguments, FDT blob if 25917d721e34SBartlomiej Sieka used) must be put below this limit, unless "bootm_low" 25927d721e34SBartlomiej Sieka enviroment variable is defined and non-zero. In such case 25937d721e34SBartlomiej Sieka all data for the Linux kernel must be between "bootm_low" 2594c3624e6eSGrant Likely and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment 2595c3624e6eSGrant Likely variable "bootm_mapsize" will override the value of 2596c3624e6eSGrant Likely CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined, 2597c3624e6eSGrant Likely then the value in "bootm_size" will be used instead. 2598c609719bSwdenk 2599fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH: 2600fca43cc8SJohn Rigby Enable initrd_high functionality. If defined then the 2601fca43cc8SJohn Rigby initrd_high feature is enabled and the bootm ramdisk subcommand 2602fca43cc8SJohn Rigby is enabled. 2603fca43cc8SJohn Rigby 2604fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE: 2605fca43cc8SJohn Rigby Enables allocating and saving kernel cmdline in space between 2606fca43cc8SJohn Rigby "bootm_low" and "bootm_low" + BOOTMAPSZ. 2607fca43cc8SJohn Rigby 2608fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD: 2609fca43cc8SJohn Rigby Enables allocating and saving a kernel copy of the bd_info in 2610fca43cc8SJohn Rigby space between "bootm_low" and "bootm_low" + BOOTMAPSZ. 2611fca43cc8SJohn Rigby 26126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS: 2613c609719bSwdenk Max number of Flash memory banks 2614c609719bSwdenk 26156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT: 2616c609719bSwdenk Max number of sectors on a Flash chip 2617c609719bSwdenk 26186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT: 2619c609719bSwdenk Timeout for Flash erase operations (in ms) 2620c609719bSwdenk 26216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT: 2622c609719bSwdenk Timeout for Flash write operations (in ms) 2623c609719bSwdenk 26246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT 26258564acf9Swdenk Timeout for Flash set sector lock bit operation (in ms) 26268564acf9Swdenk 26276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT 26288564acf9Swdenk Timeout for Flash clear lock bits operation (in ms) 26298564acf9Swdenk 26306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION 26318564acf9Swdenk If defined, hardware flash sectors protection is used 26328564acf9Swdenk instead of U-Boot software protection. 26338564acf9Swdenk 26346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP: 2635c609719bSwdenk 2636c609719bSwdenk Enable TFTP transfers directly to flash memory; 2637c609719bSwdenk without this option such a download has to be 2638c609719bSwdenk performed in two steps: (1) download to RAM, and (2) 2639c609719bSwdenk copy from RAM to flash. 2640c609719bSwdenk 2641c609719bSwdenk The two-step approach is usually more reliable, since 2642c609719bSwdenk you can check if the download worked before you erase 264311ccc33fSMarcel Ziswiler the flash, but in some situations (when system RAM is 264411ccc33fSMarcel Ziswiler too limited to allow for a temporary copy of the 2645c609719bSwdenk downloaded image) this option may be very useful. 2646c609719bSwdenk 26476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI: 2648c609719bSwdenk Define if the flash driver uses extra elements in the 26495653fc33Swdenk common flash structure for storing flash geometry. 26505653fc33Swdenk 265100b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER 26525653fc33Swdenk This option also enables the building of the cfi_flash driver 26535653fc33Swdenk in the drivers directory 265453cf9435Sstroese 265591809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD 265691809ed5SPiotr Ziecik This option enables the building of the cfi_mtd driver 265791809ed5SPiotr Ziecik in the drivers directory. The driver exports CFI flash 265891809ed5SPiotr Ziecik to the MTD layer. 265991809ed5SPiotr Ziecik 26606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE 266196ef831fSGuennadi Liakhovetski Use buffered writes to flash. 266296ef831fSGuennadi Liakhovetski 266396ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N 266496ef831fSGuennadi Liakhovetski s29ws-n MirrorBit flash has non-standard addresses for buffered 266596ef831fSGuennadi Liakhovetski write commands. 266696ef831fSGuennadi Liakhovetski 26676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST 26685568e613SStefan Roese If this option is defined, the common CFI flash doesn't 26695568e613SStefan Roese print it's warning upon not recognized FLASH banks. This 26705568e613SStefan Roese is useful, if some of the configured banks are only 26715568e613SStefan Roese optionally available. 26725568e613SStefan Roese 26739a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS 26749a042e9cSJerry Van Baren If defined (must be an integer), print out countdown 26759a042e9cSJerry Van Baren digits and dots. Recommended value: 45 (9..1) for 80 26769a042e9cSJerry Van Baren column displays, 15 (3..1) for 40 column displays. 26779a042e9cSJerry Van Baren 26786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER: 267911ccc33fSMarcel Ziswiler Defines the number of Ethernet receive buffers. On some 268011ccc33fSMarcel Ziswiler Ethernet controllers it is recommended to set this value 268153cf9435Sstroese to 8 or even higher (EEPRO100 or 405 EMAC), since all 268253cf9435Sstroese buffers can be full shortly after enabling the interface 268311ccc33fSMarcel Ziswiler on high Ethernet traffic. 268453cf9435Sstroese Defaults to 4 if not defined. 2685c609719bSwdenk 2686ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES 2687ea882bafSWolfgang Denk 2688ea882bafSWolfgang Denk Maximum number of entries in the hash table that is used 2689ea882bafSWolfgang Denk internally to store the environment settings. The default 2690ea882bafSWolfgang Denk setting is supposed to be generous and should work in most 2691ea882bafSWolfgang Denk cases. This setting can be used to tune behaviour; see 2692ea882bafSWolfgang Denk lib/hashtable.c for details. 2693ea882bafSWolfgang Denk 2694c609719bSwdenkThe following definitions that deal with the placement and management 2695c609719bSwdenkof environment data (variable area); in general, we support the 2696c609719bSwdenkfollowing configurations: 2697c609719bSwdenk 2698c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC: 2699c3eb3fe4SMike Frysinger 2700c3eb3fe4SMike Frysinger Builds up envcrc with the target environment so that external utils 2701c3eb3fe4SMike Frysinger may easily extract it and embed it in final U-Boot images. 2702c3eb3fe4SMike Frysinger 27035a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH: 2704c609719bSwdenk 2705c609719bSwdenk Define this if the environment is in flash memory. 2706c609719bSwdenk 2707c609719bSwdenk a) The environment occupies one whole flash sector, which is 2708c609719bSwdenk "embedded" in the text segment with the U-Boot code. This 2709c609719bSwdenk happens usually with "bottom boot sector" or "top boot 2710c609719bSwdenk sector" type flash chips, which have several smaller 2711c609719bSwdenk sectors at the start or the end. For instance, such a 2712c609719bSwdenk layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In 2713c609719bSwdenk such a case you would place the environment in one of the 2714c609719bSwdenk 4 kB sectors - with U-Boot code before and after it. With 2715c609719bSwdenk "top boot sector" type flash chips, you would put the 2716c609719bSwdenk environment in one of the last sectors, leaving a gap 2717c609719bSwdenk between U-Boot and the environment. 2718c609719bSwdenk 27190e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 2720c609719bSwdenk 2721c609719bSwdenk Offset of environment data (variable area) to the 2722c609719bSwdenk beginning of flash memory; for instance, with bottom boot 2723c609719bSwdenk type flash chips the second sector can be used: the offset 2724c609719bSwdenk for this sector is given here. 2725c609719bSwdenk 27266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE. 2727c609719bSwdenk 27280e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 2729c609719bSwdenk 2730c609719bSwdenk This is just another way to specify the start address of 2731c609719bSwdenk the flash sector containing the environment (instead of 27320e8d1586SJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_OFFSET). 2733c609719bSwdenk 27340e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SECT_SIZE: 2735c609719bSwdenk 2736c609719bSwdenk Size of the sector containing the environment. 2737c609719bSwdenk 2738c609719bSwdenk 2739c609719bSwdenk b) Sometimes flash chips have few, equal sized, BIG sectors. 2740c609719bSwdenk In such a case you don't want to spend a whole sector for 2741c609719bSwdenk the environment. 2742c609719bSwdenk 27430e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 2744c609719bSwdenk 27455a1aceb0SJean-Christophe PLAGNIOL-VILLARD If you use this in combination with CONFIG_ENV_IS_IN_FLASH 27460e8d1586SJean-Christophe PLAGNIOL-VILLARD and CONFIG_ENV_SECT_SIZE, you can specify to use only a part 2747c609719bSwdenk of this flash sector for the environment. This saves 2748c609719bSwdenk memory for the RAM copy of the environment. 2749c609719bSwdenk 2750c609719bSwdenk It may also save flash memory if you decide to use this 2751c609719bSwdenk when your environment is "embedded" within U-Boot code, 2752c609719bSwdenk since then the remainder of the flash sector could be used 2753c609719bSwdenk for U-Boot code. It should be pointed out that this is 2754c609719bSwdenk STRONGLY DISCOURAGED from a robustness point of view: 2755c609719bSwdenk updating the environment in flash makes it always 2756c609719bSwdenk necessary to erase the WHOLE sector. If something goes 2757c609719bSwdenk wrong before the contents has been restored from a copy in 2758c609719bSwdenk RAM, your target system will be dead. 2759c609719bSwdenk 27600e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR_REDUND 27610e8d1586SJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_SIZE_REDUND 2762c609719bSwdenk 2763c609719bSwdenk These settings describe a second storage area used to hold 276411ccc33fSMarcel Ziswiler a redundant copy of the environment data, so that there is 27653e38691eSwdenk a valid backup copy in case there is a power failure during 2766c609719bSwdenk a "saveenv" operation. 2767c609719bSwdenk 2768c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the 2769c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds* 2770c609719bSwdenkaccordingly! 2771c609719bSwdenk 2772c609719bSwdenk 27739314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM: 2774c609719bSwdenk 2775c609719bSwdenk Define this if you have some non-volatile memory device 2776c609719bSwdenk (NVRAM, battery buffered SRAM) which you want to use for the 2777c609719bSwdenk environment. 2778c609719bSwdenk 27790e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 27800e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 2781c609719bSwdenk 278211ccc33fSMarcel Ziswiler These two #defines are used to determine the memory area you 2783c609719bSwdenk want to use for environment. It is assumed that this memory 2784c609719bSwdenk can just be read and written to, without any special 2785c609719bSwdenk provision. 2786c609719bSwdenk 2787c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early 2788c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the 278911ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or 2790c609719bSwdenkU-Boot will hang. 2791c609719bSwdenk 2792c609719bSwdenkPlease note that even with NVRAM we still use a copy of the 2793c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to 2794c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv" 2795c609719bSwdenkto save the current settings. 2796c609719bSwdenk 2797c609719bSwdenk 2798bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM: 2799c609719bSwdenk 2800c609719bSwdenk Use this if you have an EEPROM or similar serial access 2801c609719bSwdenk device and a driver for it. 2802c609719bSwdenk 28030e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 28040e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 2805c609719bSwdenk 2806c609719bSwdenk These two #defines specify the offset and size of the 2807c609719bSwdenk environment area within the total memory of your EEPROM. 2808c609719bSwdenk 28096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR: 2810c609719bSwdenk If defined, specified the chip address of the EEPROM device. 2811c609719bSwdenk The default address is zero. 2812c609719bSwdenk 28136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS: 2814c609719bSwdenk If defined, the number of bits used to address bytes in a 2815c609719bSwdenk single page in the EEPROM device. A 64 byte page, for example 2816c609719bSwdenk would require six bits. 2817c609719bSwdenk 28186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS: 2819c609719bSwdenk If defined, the number of milliseconds to delay between 2820c609719bSwdenk page writes. The default is zero milliseconds. 2821c609719bSwdenk 28226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR_LEN: 2823c609719bSwdenk The length in bytes of the EEPROM memory array address. Note 2824c609719bSwdenk that this is NOT the chip address length! 2825c609719bSwdenk 28266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW: 28275cf91d6bSwdenk EEPROM chips that implement "address overflow" are ones 28285cf91d6bSwdenk like Catalyst 24WC04/08/16 which has 9/10/11 bits of 28295cf91d6bSwdenk address and the extra bits end up in the "chip address" bit 28305cf91d6bSwdenk slots. This makes a 24WC08 (1Kbyte) chip look like four 256 28315cf91d6bSwdenk byte chips. 28325cf91d6bSwdenk 28335cf91d6bSwdenk Note that we consider the length of the address field to 28345cf91d6bSwdenk still be one byte because the extra address bits are hidden 28355cf91d6bSwdenk in the chip address. 28365cf91d6bSwdenk 28376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_SIZE: 2838c609719bSwdenk The size in bytes of the EEPROM device. 2839c609719bSwdenk 2840548738b4SHeiko Schocher - CONFIG_ENV_EEPROM_IS_ON_I2C 2841548738b4SHeiko Schocher define this, if you have I2C and SPI activated, and your 2842548738b4SHeiko Schocher EEPROM, which holds the environment, is on the I2C bus. 2843548738b4SHeiko Schocher 2844548738b4SHeiko Schocher - CONFIG_I2C_ENV_EEPROM_BUS 2845548738b4SHeiko Schocher if you have an Environment on an EEPROM reached over 2846548738b4SHeiko Schocher I2C muxes, you can define here, how to reach this 2847548738b4SHeiko Schocher EEPROM. For example: 2848548738b4SHeiko Schocher 2849548738b4SHeiko Schocher #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0" 2850548738b4SHeiko Schocher 2851548738b4SHeiko Schocher EEPROM which holds the environment, is reached over 2852548738b4SHeiko Schocher a pca9547 i2c mux with address 0x70, channel 3. 2853c609719bSwdenk 2854057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH: 28555779d8d9Swdenk 28565779d8d9Swdenk Define this if you have a DataFlash memory device which you 28575779d8d9Swdenk want to use for the environment. 28585779d8d9Swdenk 28590e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 28600e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 28610e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 28625779d8d9Swdenk 28635779d8d9Swdenk These three #defines specify the offset and size of the 28645779d8d9Swdenk environment area within the total memory of your DataFlash placed 28655779d8d9Swdenk at the specified address. 28665779d8d9Swdenk 286751bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND: 286813a5695bSwdenk 286913a5695bSwdenk Define this if you have a NAND device which you want to use 287013a5695bSwdenk for the environment. 287113a5695bSwdenk 28720e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 28730e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 287413a5695bSwdenk 287513a5695bSwdenk These two #defines specify the offset and size of the environment 2876fdd813deSScott Wood area within the first NAND device. CONFIG_ENV_OFFSET must be 2877fdd813deSScott Wood aligned to an erase block boundary. 28785779d8d9Swdenk 2879fdd813deSScott Wood - CONFIG_ENV_OFFSET_REDUND (optional): 2880e443c944SMarkus Klotzbuecher 28810e8d1586SJean-Christophe PLAGNIOL-VILLARD This setting describes a second storage area of CONFIG_ENV_SIZE 2882fdd813deSScott Wood size used to hold a redundant copy of the environment data, so 2883fdd813deSScott Wood that there is a valid backup copy in case there is a power failure 2884fdd813deSScott Wood during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be 2885fdd813deSScott Wood aligned to an erase block boundary. 2886e443c944SMarkus Klotzbuecher 2887fdd813deSScott Wood - CONFIG_ENV_RANGE (optional): 2888fdd813deSScott Wood 2889fdd813deSScott Wood Specifies the length of the region in which the environment 2890fdd813deSScott Wood can be written. This should be a multiple of the NAND device's 2891fdd813deSScott Wood block size. Specifying a range with more erase blocks than 2892fdd813deSScott Wood are needed to hold CONFIG_ENV_SIZE allows bad blocks within 2893fdd813deSScott Wood the range to be avoided. 2894fdd813deSScott Wood 2895fdd813deSScott Wood - CONFIG_ENV_OFFSET_OOB (optional): 2896fdd813deSScott Wood 2897fdd813deSScott Wood Enables support for dynamically retrieving the offset of the 2898fdd813deSScott Wood environment from block zero's out-of-band data. The 2899fdd813deSScott Wood "nand env.oob" command can be used to record this offset. 2900fdd813deSScott Wood Currently, CONFIG_ENV_OFFSET_REDUND is not supported when 2901fdd813deSScott Wood using CONFIG_ENV_OFFSET_OOB. 2902e443c944SMarkus Klotzbuecher 2903b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST 2904b74ab737SGuennadi Liakhovetski 2905b74ab737SGuennadi Liakhovetski Defines address in RAM to which the nand_spl code should copy the 2906b74ab737SGuennadi Liakhovetski environment. If redundant environment is used, it will be copied to 2907b74ab737SGuennadi Liakhovetski CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE. 2908b74ab737SGuennadi Liakhovetski 29096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET 2910c609719bSwdenk 2911c609719bSwdenk Defines offset to the initial SPI buffer area in DPRAM. The 2912c609719bSwdenk area is used at an early stage (ROM part) if the environment 2913c609719bSwdenk is configured to reside in the SPI EEPROM: We need a 520 byte 2914c609719bSwdenk scratch DPRAM area. It is used between the two initialization 2915c609719bSwdenk calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems 2916c609719bSwdenk to be a good choice since it makes it far enough from the 2917c609719bSwdenk start of the data area as well as from the stack pointer. 2918c609719bSwdenk 2919e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor 2920c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been 2921cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f() 2922c609719bSwdenkuntil then to read environment variables. 2923c609719bSwdenk 292485ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor 292585ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working 292685ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is 292785ec0bccSwdenknecessary, because the first environment variable we need is the 292885ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't 292985ec0bccSwdenkhave any device yet where we could complain.] 2930c609719bSwdenk 2931c609719bSwdenkNote: once the monitor has been relocated, then it will complain if 2932c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you 293385ec0bccSwdenkuse the "saveenv" command to store a valid environment. 2934c609719bSwdenk 29356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN: 2936fc3e2165Swdenk Echo the inverted Ethernet link state to the fault LED. 2937fc3e2165Swdenk 29386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR 2939fc3e2165Swdenk also needs to be defined. 2940fc3e2165Swdenk 29416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR: 2942fc3e2165Swdenk MII address of the PHY to check for the Ethernet link state. 2943c609719bSwdenk 2944f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS: 2945f5675aa5SRon Madrid Define this if you desire to only have use of the NS16550_init 2946f5675aa5SRon Madrid and NS16550_putc functions for the serial driver located at 2947f5675aa5SRon Madrid drivers/serial/ns16550.c. This option is useful for saving 2948f5675aa5SRon Madrid space for already greatly restricted images, including but not 2949f5675aa5SRon Madrid limited to NAND_SPL configurations. 2950f5675aa5SRon Madrid 2951c609719bSwdenkLow Level (hardware related) configuration options: 2952dc7c9a1aSwdenk--------------------------------------------------- 2953c609719bSwdenk 29546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE: 2955c609719bSwdenk Cache Line Size of the CPU. 2956c609719bSwdenk 29576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR: 2958c609719bSwdenk Default address of the IMMR after system reset. 29592535d602Swdenk 29602535d602Swdenk Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU, 29612535d602Swdenk and RPXsuper) to be able to adjust the position of 29622535d602Swdenk the IMMR register after a reset. 2963c609719bSwdenk 2964e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT: 2965e46fedfeSTimur Tabi Default (power-on reset) physical address of CCSR on Freescale 2966e46fedfeSTimur Tabi PowerPC SOCs. 2967e46fedfeSTimur Tabi 2968e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR: 2969e46fedfeSTimur Tabi Virtual address of CCSR. On a 32-bit build, this is typically 2970e46fedfeSTimur Tabi the same value as CONFIG_SYS_CCSRBAR_DEFAULT. 2971e46fedfeSTimur Tabi 2972e46fedfeSTimur Tabi CONFIG_SYS_DEFAULT_IMMR must also be set to this value, 2973e46fedfeSTimur Tabi for cross-platform code that uses that macro instead. 2974e46fedfeSTimur Tabi 2975e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS: 2976e46fedfeSTimur Tabi Physical address of CCSR. CCSR can be relocated to a new 2977e46fedfeSTimur Tabi physical address, if desired. In this case, this macro should 2978e46fedfeSTimur Tabi be set to that address. Otherwise, it should be set to the 2979e46fedfeSTimur Tabi same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR 2980e46fedfeSTimur Tabi is typically relocated on 36-bit builds. It is recommended 2981e46fedfeSTimur Tabi that this macro be defined via the _HIGH and _LOW macros: 2982e46fedfeSTimur Tabi 2983e46fedfeSTimur Tabi #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH 2984e46fedfeSTimur Tabi * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW) 2985e46fedfeSTimur Tabi 2986e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH: 2987e46fedfeSTimur Tabi Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically 2988e46fedfeSTimur Tabi either 0 (32-bit build) or 0xF (36-bit build). This macro is 2989e46fedfeSTimur Tabi used in assembly code, so it must not contain typecasts or 2990e46fedfeSTimur Tabi integer size suffixes (e.g. "ULL"). 2991e46fedfeSTimur Tabi 2992e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW: 2993e46fedfeSTimur Tabi Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is 2994e46fedfeSTimur Tabi used in assembly code, so it must not contain typecasts or 2995e46fedfeSTimur Tabi integer size suffixes (e.g. "ULL"). 2996e46fedfeSTimur Tabi 2997e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE: 2998e46fedfeSTimur Tabi If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be 2999e46fedfeSTimur Tabi forced to a value that ensures that CCSR is not relocated. 3000e46fedfeSTimur Tabi 30017f6c2cbcSwdenk- Floppy Disk Support: 30026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FDC_DRIVE_NUMBER 30037f6c2cbcSwdenk 30047f6c2cbcSwdenk the default drive number (default value 0) 30057f6c2cbcSwdenk 30066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_ISA_IO_STRIDE 30077f6c2cbcSwdenk 300811ccc33fSMarcel Ziswiler defines the spacing between FDC chipset registers 30097f6c2cbcSwdenk (default value 1) 30107f6c2cbcSwdenk 30116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_ISA_IO_OFFSET 30127f6c2cbcSwdenk 30137f6c2cbcSwdenk defines the offset of register from address. It 30147f6c2cbcSwdenk depends on which part of the data bus is connected to 301511ccc33fSMarcel Ziswiler the FDC chipset. (default value 0) 30167f6c2cbcSwdenk 30176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and 30186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their 30197f6c2cbcSwdenk default value. 30207f6c2cbcSwdenk 30216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD if CONFIG_SYS_FDC_HW_INIT is defined, then the function 30227f6c2cbcSwdenk fdc_hw_init() is called at the beginning of the FDC 30237f6c2cbcSwdenk setup. fdc_hw_init() must be provided by the board 30247f6c2cbcSwdenk source code. It is used to make hardware dependant 30257f6c2cbcSwdenk initializations. 30267f6c2cbcSwdenk 30270abddf82SMacpaul Lin- CONFIG_IDE_AHB: 30280abddf82SMacpaul Lin Most IDE controllers were designed to be connected with PCI 30290abddf82SMacpaul Lin interface. Only few of them were designed for AHB interface. 30300abddf82SMacpaul Lin When software is doing ATA command and data transfer to 30310abddf82SMacpaul Lin IDE devices through IDE-AHB controller, some additional 30320abddf82SMacpaul Lin registers accessing to these kind of IDE-AHB controller 30330abddf82SMacpaul Lin is requierd. 30340abddf82SMacpaul Lin 30356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR: Physical address of the Internal Memory. 303625d6712aSwdenk DO NOT CHANGE unless you know exactly what you're 303725d6712aSwdenk doing! (11-4) [MPC8xx/82xx systems only] 3038c609719bSwdenk 30396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR: 3040c609719bSwdenk 30417152b1d0Swdenk Start address of memory area that can be used for 3042c609719bSwdenk initial data and stack; please note that this must be 3043c609719bSwdenk writable memory that is working WITHOUT special 3044c609719bSwdenk initialization, i. e. you CANNOT use normal RAM which 3045c609719bSwdenk will become available only after programming the 3046c609719bSwdenk memory controller and running certain initialization 3047c609719bSwdenk sequences. 3048c609719bSwdenk 3049c609719bSwdenk U-Boot uses the following memory types: 3050c609719bSwdenk - MPC8xx and MPC8260: IMMR (internal memory of the CPU) 3051c609719bSwdenk - MPC824X: data cache 3052c609719bSwdenk - PPC4xx: data cache 3053c609719bSwdenk 30546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET: 3055c609719bSwdenk 3056c609719bSwdenk Offset of the initial data structure in the memory 30576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually 30586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial 3059c609719bSwdenk data is located at the end of the available space 3060553f0982SWolfgang Denk (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE - 30616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just 30626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR + 30636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_GBL_DATA_OFFSET) downward. 3064c609719bSwdenk 3065c609719bSwdenk Note: 3066c609719bSwdenk On the MPC824X (or other systems that use the data 3067c609719bSwdenk cache for initial memory) the address chosen for 30686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must 3069c609719bSwdenk point to an otherwise UNUSED address space between 3070c609719bSwdenk the top of RAM and the start of the PCI space. 3071c609719bSwdenk 30726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6) 3073c609719bSwdenk 30746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR: System Protection Control (11-9) 3075c609719bSwdenk 30766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26) 3077c609719bSwdenk 30786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31) 3079c609719bSwdenk 30806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30) 3081c609719bSwdenk 30826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27) 3083c609719bSwdenk 30846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM: 3085c609719bSwdenk SDRAM timing 3086c609719bSwdenk 30876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA: 3088c609719bSwdenk periodic timer for refresh 3089c609719bSwdenk 30906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER: Debug Event Register (37-47) 3091c609719bSwdenk 30926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM, 30936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP, 30946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM, 30956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BR1_PRELIM: 3096c609719bSwdenk Memory Controller Definitions: BR0/1 and OR0/1 (FLASH) 3097c609719bSwdenk 3098c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE, 30996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM, 31006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM: 3101c609719bSwdenk Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM) 3102c609719bSwdenk 31036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K, 31046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL: 3105c609719bSwdenk Machine Mode Register and Memory Periodic Timer 3106c609719bSwdenk Prescaler definitions (SDRAM timing) 3107c609719bSwdenk 31086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]: 3109c609719bSwdenk enable I2C microcode relocation patch (MPC8xx); 3110c609719bSwdenk define relocation offset in DPRAM [DSP2] 3111c609719bSwdenk 31126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]: 3113b423d055SHeiko Schocher enable SMC microcode relocation patch (MPC8xx); 3114b423d055SHeiko Schocher define relocation offset in DPRAM [SMC1] 3115b423d055SHeiko Schocher 31166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]: 3117c609719bSwdenk enable SPI microcode relocation patch (MPC8xx); 3118c609719bSwdenk define relocation offset in DPRAM [SCC4] 3119c609719bSwdenk 31206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK: 3121c609719bSwdenk Use OSCM clock mode on MBX8xx board. Be careful, 3122c609719bSwdenk wrong setting might damage your board. Read 3123c609719bSwdenk doc/README.MBX before setting this variable! 3124c609719bSwdenk 31256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only) 3126ea909b76Swdenk Offset of the bootmode word in DPRAM used by post 3127ea909b76Swdenk (Power On Self Tests). This definition overrides 3128ea909b76Swdenk #define'd default value in commproc.h resp. 3129ea909b76Swdenk cpm_8260.h. 3130ea909b76Swdenk 31316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB, 31326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL, 31336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS, 31346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB, 31356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START, 31366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL, 31376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE, 31386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only) 3139a47a12beSStefan Roese Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set. 31405d232d0eSwdenk 31419cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE: 31429cacf4fcSDirk Eibach Disable PCI-Express on systems where it is supported but not 31439cacf4fcSDirk Eibach required. 31449cacf4fcSDirk Eibach 3145a09b9b68SKumar Gala- CONFIG_SYS_SRIO: 3146a09b9b68SKumar Gala Chip has SRIO or not 3147a09b9b68SKumar Gala 3148a09b9b68SKumar Gala- CONFIG_SRIO1: 3149a09b9b68SKumar Gala Board has SRIO 1 port available 3150a09b9b68SKumar Gala 3151a09b9b68SKumar Gala- CONFIG_SRIO2: 3152a09b9b68SKumar Gala Board has SRIO 2 port available 3153a09b9b68SKumar Gala 3154a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT: 3155a09b9b68SKumar Gala Virtual Address of SRIO port 'n' memory region 3156a09b9b68SKumar Gala 3157a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS: 3158a09b9b68SKumar Gala Physical Address of SRIO port 'n' memory region 3159a09b9b68SKumar Gala 3160a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE: 3161a09b9b68SKumar Gala Size of SRIO port 'n' memory region 3162a09b9b68SKumar Gala 3163eced4626SAlex Waterman- CONFIG_SYS_NDFC_16 3164eced4626SAlex Waterman Defined to tell the NDFC that the NAND chip is using a 3165eced4626SAlex Waterman 16 bit bus. 3166eced4626SAlex Waterman 3167eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG 3168eced4626SAlex Waterman Sets the EBC0_CFG register for the NDFC. If not defined 3169eced4626SAlex Waterman a default value will be used. 3170eced4626SAlex Waterman 3171bb99ad6dSBen Warren- CONFIG_SPD_EEPROM 3172218ca724SWolfgang Denk Get DDR timing information from an I2C EEPROM. Common 3173218ca724SWolfgang Denk with pluggable memory modules such as SODIMMs 3174218ca724SWolfgang Denk 3175bb99ad6dSBen Warren SPD_EEPROM_ADDRESS 3176bb99ad6dSBen Warren I2C address of the SPD EEPROM 3177bb99ad6dSBen Warren 31786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM 3179218ca724SWolfgang Denk If SPD EEPROM is on an I2C bus other than the first 3180218ca724SWolfgang Denk one, specify here. Note that the value must resolve 3181218ca724SWolfgang Denk to something your driver can deal with. 3182bb99ad6dSBen Warren 31831b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING 31841b3e3c4fSYork Sun Get DDR timing information from other than SPD. Common with 31851b3e3c4fSYork Sun soldered DDR chips onboard without SPD. DDR raw timing 31861b3e3c4fSYork Sun parameters are extracted from datasheet and hard-coded into 31871b3e3c4fSYork Sun header files or board specific files. 31881b3e3c4fSYork Sun 31896f5e1dc5SYork Sun- CONFIG_FSL_DDR_INTERACTIVE 31906f5e1dc5SYork Sun Enable interactive DDR debugging. See doc/README.fsl-ddr. 31916f5e1dc5SYork Sun 31926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0 3193218ca724SWolfgang Denk Only for 83xx systems. If specified, then DDR should 3194218ca724SWolfgang Denk be configured using CS0 and CS1 instead of CS2 and CS3. 31952ad6b513STimur Tabi 3196c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12] 3197c26e454dSwdenk Define to enable FEC[12] on a 8xx series processor. 3198c26e454dSwdenk 3199c26e454dSwdenk- CONFIG_FEC[12]_PHY 3200c26e454dSwdenk Define to the hardcoded PHY address which corresponds 32016e592385Swdenk to the given FEC; i. e. 3202c26e454dSwdenk #define CONFIG_FEC1_PHY 4 3203c26e454dSwdenk means that the PHY with address 4 is connected to FEC1 3204c26e454dSwdenk 3205c26e454dSwdenk When set to -1, means to probe for first available. 3206c26e454dSwdenk 3207c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR 3208c26e454dSwdenk The PHY does not have a RXERR line (RMII only). 3209c26e454dSwdenk (so program the FEC to ignore it). 3210c26e454dSwdenk 3211c26e454dSwdenk- CONFIG_RMII 3212c26e454dSwdenk Enable RMII mode for all FECs. 3213c26e454dSwdenk Note that this is a global option, we can't 3214c26e454dSwdenk have one FEC in standard MII mode and another in RMII mode. 3215c26e454dSwdenk 32165cf91d6bSwdenk- CONFIG_CRC32_VERIFY 32175cf91d6bSwdenk Add a verify option to the crc32 command. 32185cf91d6bSwdenk The syntax is: 32195cf91d6bSwdenk 32205cf91d6bSwdenk => crc32 -v <address> <count> <crc32> 32215cf91d6bSwdenk 32225cf91d6bSwdenk Where address/count indicate a memory area 32235cf91d6bSwdenk and crc32 is the correct crc32 which the 32245cf91d6bSwdenk area should have. 32255cf91d6bSwdenk 322656523f12Swdenk- CONFIG_LOOPW 322756523f12Swdenk Add the "loopw" memory command. This only takes effect if 3228602ad3b3SJon Loeliger the memory commands are activated globally (CONFIG_CMD_MEM). 322956523f12Swdenk 32307b466641Sstroese- CONFIG_MX_CYCLIC 32317b466641Sstroese Add the "mdc" and "mwc" memory commands. These are cyclic 32327b466641Sstroese "md/mw" commands. 32337b466641Sstroese Examples: 32347b466641Sstroese 32357b466641Sstroese => mdc.b 10 4 500 32367b466641Sstroese This command will print 4 bytes (10,11,12,13) each 500 ms. 32377b466641Sstroese 32387b466641Sstroese => mwc.l 100 12345678 10 32397b466641Sstroese This command will write 12345678 to address 100 all 10 ms. 32407b466641Sstroese 32417b466641Sstroese This only takes effect if the memory commands are activated 3242602ad3b3SJon Loeliger globally (CONFIG_CMD_MEM). 32437b466641Sstroese 32448aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT 3245afc1ce82SMacpaul Lin [ARM, NDS32, MIPS only] If this variable is defined, then certain 3246e03f3169SWolfgang Denk low level initializations (like setting up the memory 3247e03f3169SWolfgang Denk controller) are omitted and/or U-Boot does not 3248e03f3169SWolfgang Denk relocate itself into RAM. 32498aa1a2d1Swdenk 3250e03f3169SWolfgang Denk Normally this variable MUST NOT be defined. The only 3251e03f3169SWolfgang Denk exception is when U-Boot is loaded (to RAM) by some 3252e03f3169SWolfgang Denk other boot loader or by a debugger which performs 3253e03f3169SWolfgang Denk these initializations itself. 32548aa1a2d1Swdenk 3255401bb30bSAneesh V- CONFIG_SPL_BUILD 3256df81238bSMagnus Lilja Modifies the behaviour of start.S when compiling a loader 3257df81238bSMagnus Lilja that is executed before the actual U-Boot. E.g. when 3258df81238bSMagnus Lilja compiling a NAND SPL. 3259400558b5Swdenk 326068bb8295SHeiko Schocher- CONFIG_SYS_NAND_HW_ECC_OOBFIRST 326168bb8295SHeiko Schocher define this, if you want to read first the oob data 326268bb8295SHeiko Schocher and then the data. This is used for example on 326368bb8295SHeiko Schocher davinci plattforms. 326468bb8295SHeiko Schocher 3265d8834a13SMatthias Weisser- CONFIG_USE_ARCH_MEMCPY 3266d8834a13SMatthias Weisser CONFIG_USE_ARCH_MEMSET 3267d8834a13SMatthias Weisser If these options are used a optimized version of memcpy/memset will 3268d8834a13SMatthias Weisser be used if available. These functions may be faster under some 3269d8834a13SMatthias Weisser conditions but may increase the binary size. 3270d8834a13SMatthias Weisser 3271c609719bSwdenkBuilding the Software: 3272c609719bSwdenk====================== 3273c609719bSwdenk 3274218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments 3275218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support 3276218ca724SWolfgang Denkall possibly existing versions of cross development tools in all 3277218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we 3278218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK) 3279218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot. 3280c609719bSwdenk 3281218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you 3282218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case, 3283218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell. 3284218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are 3285218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter: 3286c609719bSwdenk 3287218ca724SWolfgang Denk $ CROSS_COMPILE=ppc_4xx- 3288218ca724SWolfgang Denk $ export CROSS_COMPILE 3289c609719bSwdenk 32902f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in 32912f8d396bSPeter Tyser the tools directory you can use the MinGW toolchain 32922f8d396bSPeter Tyser (http://www.mingw.org). Set your HOST tools to the MinGW 32932f8d396bSPeter Tyser toolchain and execute 'make tools'. For example: 32942f8d396bSPeter Tyser 32952f8d396bSPeter Tyser $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools 32962f8d396bSPeter Tyser 32972f8d396bSPeter Tyser Binaries such as tools/mkimage.exe will be created which can 32982f8d396bSPeter Tyser be executed on computers running Windows. 32992f8d396bSPeter Tyser 3300c609719bSwdenkU-Boot is intended to be simple to build. After installing the 3301c609719bSwdenksources you must configure U-Boot for one specific board type. This 3302c609719bSwdenkis done by typing: 3303c609719bSwdenk 3304c609719bSwdenk make NAME_config 3305c609719bSwdenk 3306218ca724SWolfgang Denkwhere "NAME_config" is the name of one of the existing configu- 3307218ca724SWolfgang Denkrations; see the main Makefile for supported names. 330854387ac9Swdenk 3309c609719bSwdenkNote: for some board special configuration names may exist; check if 3310c609719bSwdenk additional information is available from the board vendor; for 33112729af9dSwdenk instance, the TQM823L systems are available without (standard) 33122729af9dSwdenk or with LCD support. You can select such additional "features" 331311ccc33fSMarcel Ziswiler when choosing the configuration, i. e. 3314c609719bSwdenk 33152729af9dSwdenk make TQM823L_config 33162729af9dSwdenk - will configure for a plain TQM823L, i. e. no LCD support 3317c609719bSwdenk 3318c609719bSwdenk make TQM823L_LCD_config 3319c609719bSwdenk - will configure for a TQM823L with U-Boot console on LCD 3320c609719bSwdenk 3321c609719bSwdenk etc. 3322c609719bSwdenk 3323c609719bSwdenk 3324c609719bSwdenkFinally, type "make all", and you should get some working U-Boot 33257152b1d0Swdenkimages ready for download to / installation on your system: 3326c609719bSwdenk 3327c609719bSwdenk- "u-boot.bin" is a raw binary image 3328c609719bSwdenk- "u-boot" is an image in ELF binary format 3329c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format 3330c609719bSwdenk 3331baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved 3332baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change 3333baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory: 3334baf31249SMarian Balakowicz 3335baf31249SMarian Balakowicz1. Add O= to the make command line invocations: 3336baf31249SMarian Balakowicz 3337baf31249SMarian Balakowicz make O=/tmp/build distclean 3338baf31249SMarian Balakowicz make O=/tmp/build NAME_config 3339baf31249SMarian Balakowicz make O=/tmp/build all 3340baf31249SMarian Balakowicz 3341baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location: 3342baf31249SMarian Balakowicz 3343baf31249SMarian Balakowicz export BUILD_DIR=/tmp/build 3344baf31249SMarian Balakowicz make distclean 3345baf31249SMarian Balakowicz make NAME_config 3346baf31249SMarian Balakowicz make all 3347baf31249SMarian Balakowicz 3348baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment 3349baf31249SMarian Balakowiczvariable. 3350baf31249SMarian Balakowicz 3351c609719bSwdenk 3352c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so 3353c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of 3354c609719bSwdenknative "make". 3355c609719bSwdenk 3356c609719bSwdenk 3357c609719bSwdenkIf the system board that you have is not listed, then you will need 3358c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these 3359c609719bSwdenksteps: 3360c609719bSwdenk 3361c609719bSwdenk1. Add a new configuration option for your board to the toplevel 336285ec0bccSwdenk "Makefile" and to the "MAKEALL" script, using the existing 336385ec0bccSwdenk entries as examples. Note that here and at many other places 33647152b1d0Swdenk boards and other names are listed in alphabetical sort order. Please 336585ec0bccSwdenk keep this order. 3366c609719bSwdenk2. Create a new directory to hold your board specific code. Add any 336785ec0bccSwdenk files you need. In your board directory, you will need at least 336885ec0bccSwdenk the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds". 336985ec0bccSwdenk3. Create a new configuration file "include/configs/<board>.h" for 337085ec0bccSwdenk your board 3371c609719bSwdenk3. If you're porting U-Boot to a new CPU, then also create a new 3372c609719bSwdenk directory to hold your CPU specific code. Add any files you need. 337385ec0bccSwdenk4. Run "make <board>_config" with your new name. 3374c609719bSwdenk5. Type "make", and you should get a working "u-boot.srec" file 3375c609719bSwdenk to be installed on your target system. 337685ec0bccSwdenk6. Debug and solve any problems that might arise. 3377c609719bSwdenk [Of course, this last step is much harder than it sounds.] 3378c609719bSwdenk 3379c609719bSwdenk 3380c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.: 3381c609719bSwdenk============================================================== 3382c609719bSwdenk 3383c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board 3384c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to 3385c609719bSwdenkprovide feedback to the other developers. The feedback normally takes 3386c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest 3387218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources. 3388c609719bSwdenk 3389c609719bSwdenkBut before you submit such a patch, please verify that your modifi- 3390c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of 3391c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so, 3392c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot 3393c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can 33947152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE' 3395218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools 3396218ca724SWolfgang Denkyou can type 3397c609719bSwdenk 3398c609719bSwdenk CROSS_COMPILE=ppc_8xx- MAKEALL 3399c609719bSwdenk 3400c609719bSwdenkor to build on a native PowerPC system you can type 3401c609719bSwdenk 3402c609719bSwdenk CROSS_COMPILE=' ' MAKEALL 3403c609719bSwdenk 3404218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build 3405218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by 3406218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target 3407218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and 3408218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default 3409218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment 3410218ca724SWolfgang Denkvariable. For example: 3411baf31249SMarian Balakowicz 3412baf31249SMarian Balakowicz export BUILD_DIR=/tmp/build 3413baf31249SMarian Balakowicz export MAKEALL_LOGDIR=/tmp/log 3414baf31249SMarian Balakowicz CROSS_COMPILE=ppc_8xx- MAKEALL 3415baf31249SMarian Balakowicz 3416218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build, 3417218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean 3418218ca724SWolfgang Denkduring the whole build process. 3419baf31249SMarian Balakowicz 3420baf31249SMarian Balakowicz 3421c609719bSwdenkSee also "U-Boot Porting Guide" below. 3422c609719bSwdenk 3423c609719bSwdenk 3424c609719bSwdenkMonitor Commands - Overview: 3425c609719bSwdenk============================ 3426c609719bSwdenk 3427c609719bSwdenkgo - start application at address 'addr' 3428c609719bSwdenkrun - run commands in an environment variable 3429c609719bSwdenkbootm - boot application image from memory 3430c609719bSwdenkbootp - boot image via network using BootP/TFTP protocol 3431c609719bSwdenktftpboot- boot image via network using TFTP protocol 3432c609719bSwdenk and env variables "ipaddr" and "serverip" 3433c609719bSwdenk (and eventually "gatewayip") 34341fb7cd49SSimon Glasstftpput - upload a file via network using TFTP protocol 3435c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol 3436c609719bSwdenkdiskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd' 3437c609719bSwdenkloads - load S-Record file over serial line 3438c609719bSwdenkloadb - load binary file over serial line (kermit mode) 3439c609719bSwdenkmd - memory display 3440c609719bSwdenkmm - memory modify (auto-incrementing) 3441c609719bSwdenknm - memory modify (constant address) 3442c609719bSwdenkmw - memory write (fill) 3443c609719bSwdenkcp - memory copy 3444c609719bSwdenkcmp - memory compare 3445c609719bSwdenkcrc32 - checksum calculation 34460f89c54bSPeter Tyseri2c - I2C sub-system 3447c609719bSwdenksspi - SPI utility commands 3448c609719bSwdenkbase - print or set address offset 3449c609719bSwdenkprintenv- print environment variables 3450c609719bSwdenksetenv - set environment variables 3451c609719bSwdenksaveenv - save environment variables to persistent storage 3452c609719bSwdenkprotect - enable or disable FLASH write protection 3453c609719bSwdenkerase - erase FLASH memory 3454c609719bSwdenkflinfo - print FLASH memory information 3455c609719bSwdenkbdinfo - print Board Info structure 3456c609719bSwdenkiminfo - print header information for application image 3457c609719bSwdenkconinfo - print console devices and informations 3458c609719bSwdenkide - IDE sub-system 3459c609719bSwdenkloop - infinite loop on address range 346056523f12Swdenkloopw - infinite write loop on address range 3461c609719bSwdenkmtest - simple RAM test 3462c609719bSwdenkicache - enable or disable instruction cache 3463c609719bSwdenkdcache - enable or disable data cache 3464c609719bSwdenkreset - Perform RESET of the CPU 3465c609719bSwdenkecho - echo args to console 3466c609719bSwdenkversion - print monitor version 3467c609719bSwdenkhelp - print online help 3468c609719bSwdenk? - alias for 'help' 3469c609719bSwdenk 3470c609719bSwdenk 3471c609719bSwdenkMonitor Commands - Detailed Description: 3472c609719bSwdenk======================================== 3473c609719bSwdenk 3474c609719bSwdenkTODO. 3475c609719bSwdenk 3476c609719bSwdenkFor now: just type "help <command>". 3477c609719bSwdenk 3478c609719bSwdenk 3479c609719bSwdenkEnvironment Variables: 3480c609719bSwdenk====================== 3481c609719bSwdenk 3482c609719bSwdenkU-Boot supports user configuration using Environment Variables which 3483c609719bSwdenkcan be made persistent by saving to Flash memory. 3484c609719bSwdenk 3485c609719bSwdenkEnvironment Variables are set using "setenv", printed using 3486c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv" 3487c609719bSwdenkwithout a value can be used to delete a variable from the 3488c609719bSwdenkenvironment. As long as you don't save the environment you are 3489c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the 3490c609719bSwdenkenvironment is erased by accident, a default environment is provided. 3491c609719bSwdenk 3492c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables. 3493c96f86eeSWolfgang Denk 3494c96f86eeSWolfgang DenkList of environment variables (most likely not complete): 3495c609719bSwdenk 3496c609719bSwdenk baudrate - see CONFIG_BAUDRATE 3497c609719bSwdenk 3498c609719bSwdenk bootdelay - see CONFIG_BOOTDELAY 3499c609719bSwdenk 3500c609719bSwdenk bootcmd - see CONFIG_BOOTCOMMAND 3501c609719bSwdenk 3502c609719bSwdenk bootargs - Boot arguments when booting an RTOS image 3503c609719bSwdenk 3504c609719bSwdenk bootfile - Name of the image to load with TFTP 3505c609719bSwdenk 35067d721e34SBartlomiej Sieka bootm_low - Memory range available for image processing in the bootm 35077d721e34SBartlomiej Sieka command can be restricted. This variable is given as 35087d721e34SBartlomiej Sieka a hexadecimal number and defines lowest address allowed 35097d721e34SBartlomiej Sieka for use by the bootm command. See also "bootm_size" 35107d721e34SBartlomiej Sieka environment variable. Address defined by "bootm_low" is 35117d721e34SBartlomiej Sieka also the base of the initial memory mapping for the Linux 3512c3624e6eSGrant Likely kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and 3513c3624e6eSGrant Likely bootm_mapsize. 3514c3624e6eSGrant Likely 3515c3624e6eSGrant Likely bootm_mapsize - Size of the initial memory mapping for the Linux kernel. 3516c3624e6eSGrant Likely This variable is given as a hexadecimal number and it 3517c3624e6eSGrant Likely defines the size of the memory region starting at base 3518c3624e6eSGrant Likely address bootm_low that is accessible by the Linux kernel 3519c3624e6eSGrant Likely during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used 3520c3624e6eSGrant Likely as the default value if it is defined, and bootm_size is 3521c3624e6eSGrant Likely used otherwise. 35227d721e34SBartlomiej Sieka 35237d721e34SBartlomiej Sieka bootm_size - Memory range available for image processing in the bootm 35247d721e34SBartlomiej Sieka command can be restricted. This variable is given as 35257d721e34SBartlomiej Sieka a hexadecimal number and defines the size of the region 35267d721e34SBartlomiej Sieka allowed for use by the bootm command. See also "bootm_low" 35277d721e34SBartlomiej Sieka environment variable. 35287d721e34SBartlomiej Sieka 35294bae9090SBartlomiej Sieka updatefile - Location of the software update file on a TFTP server, used 35304bae9090SBartlomiej Sieka by the automatic software update feature. Please refer to 35314bae9090SBartlomiej Sieka documentation in doc/README.update for more details. 35324bae9090SBartlomiej Sieka 3533c609719bSwdenk autoload - if set to "no" (any string beginning with 'n'), 3534c609719bSwdenk "bootp" will just load perform a lookup of the 3535c609719bSwdenk configuration from the BOOTP server, but not try to 3536c609719bSwdenk load any image using TFTP 3537c609719bSwdenk 3538c609719bSwdenk autostart - if set to "yes", an image loaded using the "bootp", 3539c609719bSwdenk "rarpboot", "tftpboot" or "diskboot" commands will 3540c609719bSwdenk be automatically started (by internally calling 3541c609719bSwdenk "bootm") 3542c609719bSwdenk 35434a6fd34bSwdenk If set to "no", a standalone image passed to the 35444a6fd34bSwdenk "bootm" command will be copied to the load address 35454a6fd34bSwdenk (and eventually uncompressed), but NOT be started. 35464a6fd34bSwdenk This can be used to load and uncompress arbitrary 35474a6fd34bSwdenk data. 35484a6fd34bSwdenk 3549a28afca5SDavid A. Long fdt_high - if set this restricts the maximum address that the 3550a28afca5SDavid A. Long flattened device tree will be copied into upon boot. 3551a28afca5SDavid A. Long If this is set to the special value 0xFFFFFFFF then 3552a28afca5SDavid A. Long the fdt will not be copied at all on boot. For this 3553a28afca5SDavid A. Long to work it must reside in writable memory, have 3554a28afca5SDavid A. Long sufficient padding on the end of it for u-boot to 3555a28afca5SDavid A. Long add the information it needs into it, and the memory 3556a28afca5SDavid A. Long must be accessible by the kernel. 3557a28afca5SDavid A. Long 3558eea63e05SSimon Glass fdtcontroladdr- if set this is the address of the control flattened 3559eea63e05SSimon Glass device tree used by U-Boot when CONFIG_OF_CONTROL is 3560eea63e05SSimon Glass defined. 3561eea63e05SSimon Glass 356217ea1177Swdenk i2cfast - (PPC405GP|PPC405EP only) 356317ea1177Swdenk if set to 'y' configures Linux I2C driver for fast 356417ea1177Swdenk mode (400kHZ). This environment variable is used in 356517ea1177Swdenk initialization code. So, for changes to be effective 356617ea1177Swdenk it must be saved and board must be reset. 356717ea1177Swdenk 3568c609719bSwdenk initrd_high - restrict positioning of initrd images: 3569c609719bSwdenk If this variable is not set, initrd images will be 3570c609719bSwdenk copied to the highest possible address in RAM; this 3571c609719bSwdenk is usually what you want since it allows for 3572c609719bSwdenk maximum initrd size. If for some reason you want to 3573c609719bSwdenk make sure that the initrd image is loaded below the 35746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BOOTMAPSZ limit, you can set this environment 3575c609719bSwdenk variable to a value of "no" or "off" or "0". 3576c609719bSwdenk Alternatively, you can set it to a maximum upper 3577c609719bSwdenk address to use (U-Boot will still check that it 3578c609719bSwdenk does not overwrite the U-Boot stack and data). 3579c609719bSwdenk 3580c609719bSwdenk For instance, when you have a system with 16 MB 35817152b1d0Swdenk RAM, and want to reserve 4 MB from use by Linux, 3582c609719bSwdenk you can do this by adding "mem=12M" to the value of 3583c609719bSwdenk the "bootargs" variable. However, now you must make 35847152b1d0Swdenk sure that the initrd image is placed in the first 3585c609719bSwdenk 12 MB as well - this can be done with 3586c609719bSwdenk 3587c609719bSwdenk setenv initrd_high 00c00000 3588c609719bSwdenk 358938b99261Swdenk If you set initrd_high to 0xFFFFFFFF, this is an 359038b99261Swdenk indication to U-Boot that all addresses are legal 359138b99261Swdenk for the Linux kernel, including addresses in flash 359238b99261Swdenk memory. In this case U-Boot will NOT COPY the 359338b99261Swdenk ramdisk at all. This may be useful to reduce the 359438b99261Swdenk boot time on your system, but requires that this 359538b99261Swdenk feature is supported by your Linux kernel. 359638b99261Swdenk 3597c609719bSwdenk ipaddr - IP address; needed for tftpboot command 3598c609719bSwdenk 3599c609719bSwdenk loadaddr - Default load address for commands like "bootp", 3600dc7c9a1aSwdenk "rarpboot", "tftpboot", "loadb" or "diskboot" 3601c609719bSwdenk 3602c609719bSwdenk loads_echo - see CONFIG_LOADS_ECHO 3603c609719bSwdenk 3604c609719bSwdenk serverip - TFTP server IP address; needed for tftpboot command 3605c609719bSwdenk 3606c609719bSwdenk bootretry - see CONFIG_BOOT_RETRY_TIME 3607c609719bSwdenk 3608c609719bSwdenk bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR 3609c609719bSwdenk 3610c609719bSwdenk bootstopkey - see CONFIG_AUTOBOOT_STOP_STR 3611c609719bSwdenk 3612e2a53458SMike Frysinger ethprime - controls which interface is used first. 3613a3d991bdSwdenk 3614e2a53458SMike Frysinger ethact - controls which interface is currently active. 3615e2a53458SMike Frysinger For example you can do the following 3616a3d991bdSwdenk 361748690d80SHeiko Schocher => setenv ethact FEC 361848690d80SHeiko Schocher => ping 192.168.0.1 # traffic sent on FEC 361948690d80SHeiko Schocher => setenv ethact SCC 362048690d80SHeiko Schocher => ping 10.0.0.1 # traffic sent on SCC 3621a3d991bdSwdenk 3622e1692577SMatthias Fuchs ethrotate - When set to "no" U-Boot does not go through all 3623e1692577SMatthias Fuchs available network interfaces. 3624e1692577SMatthias Fuchs It just stays at the currently selected interface. 3625e1692577SMatthias Fuchs 3626a3d991bdSwdenk netretry - When set to "no" each network operation will 3627a3d991bdSwdenk either succeed or fail without retrying. 36286e592385Swdenk When set to "once" the network operation will 36296e592385Swdenk fail when all the available network interfaces 36306e592385Swdenk are tried once without success. 3631a3d991bdSwdenk Useful on scripts which control the retry operation 3632a3d991bdSwdenk themselves. 3633a3d991bdSwdenk 3634b4e2f89dSJean-Christophe PLAGNIOL-VILLARD npe_ucode - set load address for the NPE microcode 3635a1cf027aSJean-Christophe PLAGNIOL-VILLARD 363628cb9375SWolfgang Denk tftpsrcport - If this is set, the value is used for TFTP's 3637ecb0ccd9SWolfgang Denk UDP source port. 3638ecb0ccd9SWolfgang Denk 363928cb9375SWolfgang Denk tftpdstport - If this is set, the value is used for TFTP's UDP 364028cb9375SWolfgang Denk destination port instead of the Well Know Port 69. 364128cb9375SWolfgang Denk 3642c96f86eeSWolfgang Denk tftpblocksize - Block size to use for TFTP transfers; if not set, 3643c96f86eeSWolfgang Denk we use the TFTP server's default block size 3644c96f86eeSWolfgang Denk 3645c96f86eeSWolfgang Denk tftptimeout - Retransmission timeout for TFTP packets (in milli- 3646c96f86eeSWolfgang Denk seconds, minimum value is 1000 = 1 second). Defines 3647c96f86eeSWolfgang Denk when a packet is considered to be lost so it has to 3648c96f86eeSWolfgang Denk be retransmitted. The default is 5000 = 5 seconds. 3649c96f86eeSWolfgang Denk Lowering this value may make downloads succeed 3650c96f86eeSWolfgang Denk faster in networks with high packet loss rates or 3651c96f86eeSWolfgang Denk with unreliable TFTP servers. 3652c96f86eeSWolfgang Denk 3653a3d991bdSwdenk vlan - When set to a value < 4095 the traffic over 365411ccc33fSMarcel Ziswiler Ethernet is encapsulated/received over 802.1q 3655a3d991bdSwdenk VLAN tagged frames. 3656c609719bSwdenk 3657dc0b7b0eSJason HobbsThe following image location variables contain the location of images 3658dc0b7b0eSJason Hobbsused in booting. The "Image" column gives the role of the image and is 3659dc0b7b0eSJason Hobbsnot an environment variable name. The other columns are environment 3660dc0b7b0eSJason Hobbsvariable names. "File Name" gives the name of the file on a TFTP 3661dc0b7b0eSJason Hobbsserver, "RAM Address" gives the location in RAM the image will be 3662dc0b7b0eSJason Hobbsloaded to, and "Flash Location" gives the image's address in NOR 3663dc0b7b0eSJason Hobbsflash or offset in NAND flash. 3664dc0b7b0eSJason Hobbs 3665dc0b7b0eSJason Hobbs*Note* - these variables don't have to be defined for all boards, some 3666dc0b7b0eSJason Hobbsboards currenlty use other variables for these purposes, and some 3667dc0b7b0eSJason Hobbsboards use these variables for other purposes. 3668dc0b7b0eSJason Hobbs 3669dc0b7b0eSJason HobbsImage File Name RAM Address Flash Location 3670dc0b7b0eSJason Hobbs----- --------- ----------- -------------- 3671dc0b7b0eSJason Hobbsu-boot u-boot u-boot_addr_r u-boot_addr 3672dc0b7b0eSJason HobbsLinux kernel bootfile kernel_addr_r kernel_addr 3673dc0b7b0eSJason Hobbsdevice tree blob fdtfile fdt_addr_r fdt_addr 3674dc0b7b0eSJason Hobbsramdisk ramdiskfile ramdisk_addr_r ramdisk_addr 3675dc0b7b0eSJason Hobbs 3676c609719bSwdenkThe following environment variables may be used and automatically 3677c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"), 3678c609719bSwdenkdepending the information provided by your boot server: 3679c609719bSwdenk 3680c609719bSwdenk bootfile - see above 3681c609719bSwdenk dnsip - IP address of your Domain Name Server 3682fe389a82Sstroese dnsip2 - IP address of your secondary Domain Name Server 3683c609719bSwdenk gatewayip - IP address of the Gateway (Router) to use 3684c609719bSwdenk hostname - Target hostname 3685c609719bSwdenk ipaddr - see above 3686c609719bSwdenk netmask - Subnet Mask 3687c609719bSwdenk rootpath - Pathname of the root filesystem on the NFS server 3688c609719bSwdenk serverip - see above 3689c609719bSwdenk 3690c609719bSwdenk 3691c609719bSwdenkThere are two special Environment Variables: 3692c609719bSwdenk 3693c609719bSwdenk serial# - contains hardware identification information such 3694c609719bSwdenk as type string and/or serial number 3695c609719bSwdenk ethaddr - Ethernet address 3696c609719bSwdenk 3697c609719bSwdenkThese variables can be set only once (usually during manufacturing of 3698c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables 3699c609719bSwdenkonce they have been set once. 3700c609719bSwdenk 3701c609719bSwdenk 3702c1551ea8SstroeseFurther special Environment Variables: 3703c1551ea8Sstroese 3704c1551ea8Sstroese ver - Contains the U-Boot version string as printed 3705c1551ea8Sstroese with the "version" command. This variable is 3706c1551ea8Sstroese readonly (see CONFIG_VERSION_VARIABLE). 3707c1551ea8Sstroese 3708c1551ea8Sstroese 3709c609719bSwdenkPlease note that changes to some configuration parameters may take 3710c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-). 3711c609719bSwdenk 3712c609719bSwdenk 3713f07771ccSwdenkCommand Line Parsing: 3714f07771ccSwdenk===================== 3715f07771ccSwdenk 3716f07771ccSwdenkThere are two different command line parsers available with U-Boot: 37177152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell: 3718f07771ccSwdenk 3719f07771ccSwdenkOld, simple command line parser: 3720f07771ccSwdenk-------------------------------- 3721f07771ccSwdenk 3722f07771ccSwdenk- supports environment variables (through setenv / saveenv commands) 3723f07771ccSwdenk- several commands on one line, separated by ';' 3724fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax 3725f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\', 3726f07771ccSwdenk for example: 3727fe126d8bSWolfgang Denk setenv bootcmd bootm \${address} 3728f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example: 3729f07771ccSwdenk setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off' 3730f07771ccSwdenk 3731f07771ccSwdenkHush shell: 3732f07771ccSwdenk----------- 3733f07771ccSwdenk 3734f07771ccSwdenk- similar to Bourne shell, with control structures like 3735f07771ccSwdenk if...then...else...fi, for...do...done; while...do...done, 3736f07771ccSwdenk until...do...done, ... 3737f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv 3738f07771ccSwdenk commands) and local shell variables (through standard shell syntax 3739f07771ccSwdenk "name=value"); only environment variables can be used with "run" 3740f07771ccSwdenk command 3741f07771ccSwdenk 3742f07771ccSwdenkGeneral rules: 3743f07771ccSwdenk-------------- 3744f07771ccSwdenk 3745f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run" 3746f07771ccSwdenk command) contains several commands separated by semicolon, and 3747f07771ccSwdenk one of these commands fails, then the remaining commands will be 3748f07771ccSwdenk executed anyway. 3749f07771ccSwdenk 3750f07771ccSwdenk(2) If you execute several variables with one call to run (i. e. 375111ccc33fSMarcel Ziswiler calling run with a list of variables as arguments), any failing 3752f07771ccSwdenk command will cause "run" to terminate, i. e. the remaining 3753f07771ccSwdenk variables are not executed. 3754f07771ccSwdenk 3755c609719bSwdenkNote for Redundant Ethernet Interfaces: 3756c609719bSwdenk======================================= 3757c609719bSwdenk 375811ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports 3759c609719bSwdenksuch configurations and is capable of automatic selection of a 37607152b1d0Swdenk"working" interface when needed. MAC assignment works as follows: 3761c609719bSwdenk 3762c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding 3763c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0), 3764c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ... 3765c609719bSwdenk 3766c609719bSwdenkIf the network interface stores some valid MAC address (for instance 3767c609719bSwdenkin SROM), this is used as default address if there is NO correspon- 3768c609719bSwdenkding setting in the environment; if the corresponding environment 3769c609719bSwdenkvariable is set, this overrides the settings in the card; that means: 3770c609719bSwdenk 3771c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the 3772c609719bSwdenk environment, the SROM's address is used. 3773c609719bSwdenk 3774c609719bSwdenko If there is no valid address in the SROM, and a definition in the 3775c609719bSwdenk environment exists, then the value from the environment variable is 3776c609719bSwdenk used. 3777c609719bSwdenk 3778c609719bSwdenko If both the SROM and the environment contain a MAC address, and 3779c609719bSwdenk both addresses are the same, this MAC address is used. 3780c609719bSwdenk 3781c609719bSwdenko If both the SROM and the environment contain a MAC address, and the 3782c609719bSwdenk addresses differ, the value from the environment is used and a 3783c609719bSwdenk warning is printed. 3784c609719bSwdenk 3785c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error 3786c609719bSwdenk is raised. 3787c609719bSwdenk 3788ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses 3789ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process. This 3790ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable. 3791ecee9324SBen WarrenThe naming convention is as follows: 3792ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc. 3793c609719bSwdenk 3794c609719bSwdenkImage Formats: 3795c609719bSwdenk============== 3796c609719bSwdenk 37973310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on) 37983310c549SMarian Balakowiczimages in two formats: 37993310c549SMarian Balakowicz 38003310c549SMarian BalakowiczNew uImage format (FIT) 38013310c549SMarian Balakowicz----------------------- 38023310c549SMarian Balakowicz 38033310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar 38043310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple 38053310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by 38063310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory. 38073310c549SMarian Balakowicz 38083310c549SMarian Balakowicz 38093310c549SMarian BalakowiczOld uImage format 38103310c549SMarian Balakowicz----------------- 38113310c549SMarian Balakowicz 38123310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything, 38133310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for 38143310c549SMarian Balakowiczdetails; basically, the header defines the following image properties: 3815c609719bSwdenk 3816c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD, 3817c609719bSwdenk 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks, 3818f5ed9e39SPeter Tyser LynxOS, pSOS, QNX, RTEMS, INTEGRITY; 3819f5ed9e39SPeter Tyser Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS, 3820f5ed9e39SPeter Tyser INTEGRITY). 38217b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86, 3822afc1ce82SMacpaul Lin IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit; 3823afc1ce82SMacpaul Lin Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC). 3824c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2) 3825c609719bSwdenk* Load Address 3826c609719bSwdenk* Entry Point 3827c609719bSwdenk* Image Name 3828c609719bSwdenk* Image Timestamp 3829c609719bSwdenk 3830c609719bSwdenkThe header is marked by a special Magic Number, and both the header 3831c609719bSwdenkand the data portions of the image are secured against corruption by 3832c609719bSwdenkCRC32 checksums. 3833c609719bSwdenk 3834c609719bSwdenk 3835c609719bSwdenkLinux Support: 3836c609719bSwdenk============== 3837c609719bSwdenk 3838c609719bSwdenkAlthough U-Boot should support any OS or standalone application 38397152b1d0Swdenkeasily, the main focus has always been on Linux during the design of 3840c609719bSwdenkU-Boot. 3841c609719bSwdenk 3842c609719bSwdenkU-Boot includes many features that so far have been part of some 3843c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any 3844c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image; 3845c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation 38467152b1d0Swdenkserves several purposes: 3847c609719bSwdenk 3848c609719bSwdenk- the same features can be used for other OS or standalone 3849c609719bSwdenk applications (for instance: using compressed images to reduce the 3850c609719bSwdenk Flash memory footprint) 3851c609719bSwdenk 3852c609719bSwdenk- it becomes much easier to port new Linux kernel versions because 38537152b1d0Swdenk lots of low-level, hardware dependent stuff are done by U-Boot 3854c609719bSwdenk 3855c609719bSwdenk- the same Linux kernel image can now be used with different "initrd" 3856c609719bSwdenk images; of course this also means that different kernel images can 3857c609719bSwdenk be run with the same "initrd". This makes testing easier (you don't 3858c609719bSwdenk have to build a new "zImage.initrd" Linux image when you just 3859c609719bSwdenk change a file in your "initrd"). Also, a field-upgrade of the 3860c609719bSwdenk software is easier now. 3861c609719bSwdenk 3862c609719bSwdenk 3863c609719bSwdenkLinux HOWTO: 3864c609719bSwdenk============ 3865c609719bSwdenk 3866c609719bSwdenkPorting Linux to U-Boot based systems: 3867c609719bSwdenk--------------------------------------- 3868c609719bSwdenk 3869c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to 3870c609719bSwdenkconfigure the Linux device drivers for use with your target hardware 3871c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to 3872c609719bSwdenkLinux :-). 3873c609719bSwdenk 3874a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot). 3875c609719bSwdenk 3876c609719bSwdenkJust make sure your machine specific header file (for instance 3877c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board 38781dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h, 38791dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value 38806d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR. 3881c609719bSwdenk 3882c609719bSwdenk 3883c609719bSwdenkConfiguring the Linux kernel: 3884c609719bSwdenk----------------------------- 3885c609719bSwdenk 3886c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root 3887c609719bSwdenkdevice (initial ramdisk, NFS) for your target system. 3888c609719bSwdenk 3889c609719bSwdenk 3890c609719bSwdenkBuilding a Linux Image: 3891c609719bSwdenk----------------------- 3892c609719bSwdenk 389324ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are 389424ee89b9Swdenknot used. If you use recent kernel source, a new build target 389524ee89b9Swdenk"uImage" will exist which automatically builds an image usable by 389624ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target, 389724ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a 389824ee89b9Swdenk100% compatible format. 3899c609719bSwdenk 3900c609719bSwdenkExample: 3901c609719bSwdenk 3902c609719bSwdenk make TQM850L_config 3903c609719bSwdenk make oldconfig 3904c609719bSwdenk make dep 390524ee89b9Swdenk make uImage 3906c609719bSwdenk 390724ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to 390824ee89b9Swdenkencapsulate a compressed Linux kernel image with header information, 390924ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing: 3910c609719bSwdenk 391124ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format): 391224ee89b9Swdenk 391324ee89b9Swdenk* convert the kernel into a raw binary image: 391424ee89b9Swdenk 391524ee89b9Swdenk ${CROSS_COMPILE}-objcopy -O binary \ 391624ee89b9Swdenk -R .note -R .comment \ 391724ee89b9Swdenk -S vmlinux linux.bin 391824ee89b9Swdenk 391924ee89b9Swdenk* compress the binary image: 392024ee89b9Swdenk 392124ee89b9Swdenk gzip -9 linux.bin 392224ee89b9Swdenk 392324ee89b9Swdenk* package compressed binary image for U-Boot: 392424ee89b9Swdenk 392524ee89b9Swdenk mkimage -A ppc -O linux -T kernel -C gzip \ 392624ee89b9Swdenk -a 0 -e 0 -n "Linux Kernel Image" \ 392724ee89b9Swdenk -d linux.bin.gz uImage 392824ee89b9Swdenk 392924ee89b9Swdenk 393024ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use 393124ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or 393224ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64 393324ee89b9Swdenkbyte header containing information about target architecture, 393424ee89b9Swdenkoperating system, image type, compression method, entry points, time 393524ee89b9Swdenkstamp, CRC32 checksums, etc. 393624ee89b9Swdenk 393724ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and 393824ee89b9Swdenkprint the header information, or to build new images. 3939c609719bSwdenk 3940c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information 3941c609719bSwdenkcontained in the header of an existing U-Boot image; this includes 3942c609719bSwdenkchecksum verification: 3943c609719bSwdenk 3944c609719bSwdenk tools/mkimage -l image 3945c609719bSwdenk -l ==> list image header information 3946c609719bSwdenk 3947c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image 3948c609719bSwdenkfrom a "data file" which is used as image payload: 3949c609719bSwdenk 3950c609719bSwdenk tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \ 3951c609719bSwdenk -n name -d data_file image 3952c609719bSwdenk -A ==> set architecture to 'arch' 3953c609719bSwdenk -O ==> set operating system to 'os' 3954c609719bSwdenk -T ==> set image type to 'type' 3955c609719bSwdenk -C ==> set compression type 'comp' 3956c609719bSwdenk -a ==> set load address to 'addr' (hex) 3957c609719bSwdenk -e ==> set entry point to 'ep' (hex) 3958c609719bSwdenk -n ==> set image name to 'name' 3959c609719bSwdenk -d ==> use image data from 'datafile' 3960c609719bSwdenk 396169459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load 396269459791Swdenkaddress (0x00000000), but the entry point address depends on the 396369459791Swdenkkernel version: 3964c609719bSwdenk 3965c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C, 396624ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000. 3967c609719bSwdenk 3968c609719bSwdenkSo a typical call to build a U-Boot image would read: 3969c609719bSwdenk 397024ee89b9Swdenk -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 397124ee89b9Swdenk > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \ 3972a47a12beSStefan Roese > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \ 397324ee89b9Swdenk > examples/uImage.TQM850L 397424ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 3975c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 3976c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 3977c609719bSwdenk Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 3978c609719bSwdenk Load Address: 0x00000000 397924ee89b9Swdenk Entry Point: 0x00000000 3980c609719bSwdenk 3981c609719bSwdenkTo verify the contents of the image (or check for corruption): 3982c609719bSwdenk 398324ee89b9Swdenk -> tools/mkimage -l examples/uImage.TQM850L 398424ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 3985c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 3986c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 3987c609719bSwdenk Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 3988c609719bSwdenk Load Address: 0x00000000 398924ee89b9Swdenk Entry Point: 0x00000000 3990c609719bSwdenk 3991c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade 3992c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this 3993c609719bSwdenkneeds more space in Flash, but boots much faster since it does not 3994c609719bSwdenkneed to be uncompressed: 3995c609719bSwdenk 3996a47a12beSStefan Roese -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz 399724ee89b9Swdenk -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 399824ee89b9Swdenk > -A ppc -O linux -T kernel -C none -a 0 -e 0 \ 3999a47a12beSStefan Roese > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \ 400024ee89b9Swdenk > examples/uImage.TQM850L-uncompressed 400124ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 4002c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 4003c609719bSwdenk Image Type: PowerPC Linux Kernel Image (uncompressed) 4004c609719bSwdenk Data Size: 792160 Bytes = 773.59 kB = 0.76 MB 4005c609719bSwdenk Load Address: 0x00000000 400624ee89b9Swdenk Entry Point: 0x00000000 4007c609719bSwdenk 4008c609719bSwdenk 4009c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file 4010c609719bSwdenkwhen your kernel is intended to use an initial ramdisk: 4011c609719bSwdenk 4012c609719bSwdenk -> tools/mkimage -n 'Simple Ramdisk Image' \ 4013c609719bSwdenk > -A ppc -O linux -T ramdisk -C gzip \ 4014c609719bSwdenk > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd 4015c609719bSwdenk Image Name: Simple Ramdisk Image 4016c609719bSwdenk Created: Wed Jan 12 14:01:50 2000 4017c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 4018c609719bSwdenk Data Size: 566530 Bytes = 553.25 kB = 0.54 MB 4019c609719bSwdenk Load Address: 0x00000000 4020c609719bSwdenk Entry Point: 0x00000000 4021c609719bSwdenk 4022c609719bSwdenk 4023c609719bSwdenkInstalling a Linux Image: 4024c609719bSwdenk------------------------- 4025c609719bSwdenk 4026c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface, 4027c609719bSwdenkyou must convert the image to S-Record format: 4028c609719bSwdenk 4029c609719bSwdenk objcopy -I binary -O srec examples/image examples/image.srec 4030c609719bSwdenk 4031c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot 4032c609719bSwdenkimage header, so the resulting S-Record file will be relative to 4033c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to 4034c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads' 4035c609719bSwdenkcommand. 4036c609719bSwdenk 4037c609719bSwdenkExample: install the image to address 0x40100000 (which on the 4038c609719bSwdenkTQM8xxL is in the first Flash bank): 4039c609719bSwdenk 4040c609719bSwdenk => erase 40100000 401FFFFF 4041c609719bSwdenk 4042c609719bSwdenk .......... done 4043c609719bSwdenk Erased 8 sectors 4044c609719bSwdenk 4045c609719bSwdenk => loads 40100000 4046c609719bSwdenk ## Ready for S-Record download ... 4047c609719bSwdenk ~>examples/image.srec 4048c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 12 13 ... 4049c609719bSwdenk ... 4050c609719bSwdenk 15989 15990 15991 15992 4051c609719bSwdenk [file transfer complete] 4052c609719bSwdenk [connected] 4053c609719bSwdenk ## Start Addr = 0x00000000 4054c609719bSwdenk 4055c609719bSwdenk 4056c609719bSwdenkYou can check the success of the download using the 'iminfo' command; 4057c609719bSwdenkthis includes a checksum verification so you can be sure no data 4058c609719bSwdenkcorruption happened: 4059c609719bSwdenk 4060c609719bSwdenk => imi 40100000 4061c609719bSwdenk 4062c609719bSwdenk ## Checking Image at 40100000 ... 4063c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 4064c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 4065c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 4066c609719bSwdenk Load Address: 00000000 4067c609719bSwdenk Entry Point: 0000000c 4068c609719bSwdenk Verifying Checksum ... OK 4069c609719bSwdenk 4070c609719bSwdenk 4071c609719bSwdenkBoot Linux: 4072c609719bSwdenk----------- 4073c609719bSwdenk 4074c609719bSwdenkThe "bootm" command is used to boot an application that is stored in 4075c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents 4076c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as 4077c609719bSwdenkparameters. You can check and modify this variable using the 4078c609719bSwdenk"printenv" and "setenv" commands: 4079c609719bSwdenk 4080c609719bSwdenk 4081c609719bSwdenk => printenv bootargs 4082c609719bSwdenk bootargs=root=/dev/ram 4083c609719bSwdenk 4084c609719bSwdenk => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 4085c609719bSwdenk 4086c609719bSwdenk => printenv bootargs 4087c609719bSwdenk bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 4088c609719bSwdenk 4089c609719bSwdenk => bootm 40020000 4090c609719bSwdenk ## Booting Linux kernel at 40020000 ... 4091c609719bSwdenk Image Name: 2.2.13 for NFS on TQM850L 4092c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 4093c609719bSwdenk Data Size: 381681 Bytes = 372 kB = 0 MB 4094c609719bSwdenk Load Address: 00000000 4095c609719bSwdenk Entry Point: 0000000c 4096c609719bSwdenk Verifying Checksum ... OK 4097c609719bSwdenk Uncompressing Kernel Image ... OK 4098c609719bSwdenk 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 4099c609719bSwdenk Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 4100c609719bSwdenk time_init: decrementer frequency = 187500000/60 4101c609719bSwdenk Calibrating delay loop... 49.77 BogoMIPS 4102c609719bSwdenk Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000] 4103c609719bSwdenk ... 4104c609719bSwdenk 410511ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass 41067152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT 4107c609719bSwdenkformat!) to the "bootm" command: 4108c609719bSwdenk 4109c609719bSwdenk => imi 40100000 40200000 4110c609719bSwdenk 4111c609719bSwdenk ## Checking Image at 40100000 ... 4112c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 4113c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 4114c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 4115c609719bSwdenk Load Address: 00000000 4116c609719bSwdenk Entry Point: 0000000c 4117c609719bSwdenk Verifying Checksum ... OK 4118c609719bSwdenk 4119c609719bSwdenk ## Checking Image at 40200000 ... 4120c609719bSwdenk Image Name: Simple Ramdisk Image 4121c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 4122c609719bSwdenk Data Size: 566530 Bytes = 553 kB = 0 MB 4123c609719bSwdenk Load Address: 00000000 4124c609719bSwdenk Entry Point: 00000000 4125c609719bSwdenk Verifying Checksum ... OK 4126c609719bSwdenk 4127c609719bSwdenk => bootm 40100000 40200000 4128c609719bSwdenk ## Booting Linux kernel at 40100000 ... 4129c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 4130c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 4131c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 4132c609719bSwdenk Load Address: 00000000 4133c609719bSwdenk Entry Point: 0000000c 4134c609719bSwdenk Verifying Checksum ... OK 4135c609719bSwdenk Uncompressing Kernel Image ... OK 4136c609719bSwdenk ## Loading RAMDisk Image at 40200000 ... 4137c609719bSwdenk Image Name: Simple Ramdisk Image 4138c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 4139c609719bSwdenk Data Size: 566530 Bytes = 553 kB = 0 MB 4140c609719bSwdenk Load Address: 00000000 4141c609719bSwdenk Entry Point: 00000000 4142c609719bSwdenk Verifying Checksum ... OK 4143c609719bSwdenk Loading Ramdisk ... OK 4144c609719bSwdenk 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 4145c609719bSwdenk Boot arguments: root=/dev/ram 4146c609719bSwdenk time_init: decrementer frequency = 187500000/60 4147c609719bSwdenk Calibrating delay loop... 49.77 BogoMIPS 4148c609719bSwdenk ... 4149c609719bSwdenk RAMDISK: Compressed image found at block 0 4150c609719bSwdenk VFS: Mounted root (ext2 filesystem). 4151c609719bSwdenk 4152c609719bSwdenk bash# 4153c609719bSwdenk 41540267768eSMatthew McClintockBoot Linux and pass a flat device tree: 41550267768eSMatthew McClintock----------- 41560267768eSMatthew McClintock 41570267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section 41580267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The 41590267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated 41600267768eSMatthew McClintockflat device tree: 41610267768eSMatthew McClintock 41620267768eSMatthew McClintock=> print oftaddr 41630267768eSMatthew McClintockoftaddr=0x300000 41640267768eSMatthew McClintock=> print oft 41650267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb 41660267768eSMatthew McClintock=> tftp $oftaddr $oft 41670267768eSMatthew McClintockSpeed: 1000, full duplex 41680267768eSMatthew McClintockUsing TSEC0 device 41690267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101 41700267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'. 41710267768eSMatthew McClintockLoad address: 0x300000 41720267768eSMatthew McClintockLoading: # 41730267768eSMatthew McClintockdone 41740267768eSMatthew McClintockBytes transferred = 4106 (100a hex) 41750267768eSMatthew McClintock=> tftp $loadaddr $bootfile 41760267768eSMatthew McClintockSpeed: 1000, full duplex 41770267768eSMatthew McClintockUsing TSEC0 device 41780267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2 41790267768eSMatthew McClintockFilename 'uImage'. 41800267768eSMatthew McClintockLoad address: 0x200000 41810267768eSMatthew McClintockLoading:############ 41820267768eSMatthew McClintockdone 41830267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex) 41840267768eSMatthew McClintock=> print loadaddr 41850267768eSMatthew McClintockloadaddr=200000 41860267768eSMatthew McClintock=> print oftaddr 41870267768eSMatthew McClintockoftaddr=0x300000 41880267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr 41890267768eSMatthew McClintock## Booting image at 00200000 ... 41900267768eSMatthew McClintock Image Name: Linux-2.6.17-dirty 41910267768eSMatthew McClintock Image Type: PowerPC Linux Kernel Image (gzip compressed) 41920267768eSMatthew McClintock Data Size: 1029343 Bytes = 1005.2 kB 41930267768eSMatthew McClintock Load Address: 00000000 41940267768eSMatthew McClintock Entry Point: 00000000 41950267768eSMatthew McClintock Verifying Checksum ... OK 41960267768eSMatthew McClintock Uncompressing Kernel Image ... OK 41970267768eSMatthew McClintockBooting using flat device tree at 0x300000 41980267768eSMatthew McClintockUsing MPC85xx ADS machine description 41990267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb 42000267768eSMatthew McClintock[snip] 42010267768eSMatthew McClintock 42020267768eSMatthew McClintock 42036069ff26SwdenkMore About U-Boot Image Types: 42046069ff26Swdenk------------------------------ 42056069ff26Swdenk 42066069ff26SwdenkU-Boot supports the following image types: 42076069ff26Swdenk 42086069ff26Swdenk "Standalone Programs" are directly runnable in the environment 42096069ff26Swdenk provided by U-Boot; it is expected that (if they behave 42106069ff26Swdenk well) you can continue to work in U-Boot after return from 42116069ff26Swdenk the Standalone Program. 42126069ff26Swdenk "OS Kernel Images" are usually images of some Embedded OS which 42136069ff26Swdenk will take over control completely. Usually these programs 42146069ff26Swdenk will install their own set of exception handlers, device 42156069ff26Swdenk drivers, set up the MMU, etc. - this means, that you cannot 42166069ff26Swdenk expect to re-enter U-Boot except by resetting the CPU. 42176069ff26Swdenk "RAMDisk Images" are more or less just data blocks, and their 42186069ff26Swdenk parameters (address, size) are passed to an OS kernel that is 42196069ff26Swdenk being started. 42206069ff26Swdenk "Multi-File Images" contain several images, typically an OS 42216069ff26Swdenk (Linux) kernel image and one or more data images like 42226069ff26Swdenk RAMDisks. This construct is useful for instance when you want 42236069ff26Swdenk to boot over the network using BOOTP etc., where the boot 42246069ff26Swdenk server provides just a single image file, but you want to get 42256069ff26Swdenk for instance an OS kernel and a RAMDisk image. 42266069ff26Swdenk 42276069ff26Swdenk "Multi-File Images" start with a list of image sizes, each 42286069ff26Swdenk image size (in bytes) specified by an "uint32_t" in network 42296069ff26Swdenk byte order. This list is terminated by an "(uint32_t)0". 42306069ff26Swdenk Immediately after the terminating 0 follow the images, one by 42316069ff26Swdenk one, all aligned on "uint32_t" boundaries (size rounded up to 42326069ff26Swdenk a multiple of 4 bytes). 42336069ff26Swdenk 42346069ff26Swdenk "Firmware Images" are binary images containing firmware (like 42356069ff26Swdenk U-Boot or FPGA images) which usually will be programmed to 42366069ff26Swdenk flash memory. 42376069ff26Swdenk 42386069ff26Swdenk "Script files" are command sequences that will be executed by 42396069ff26Swdenk U-Boot's command interpreter; this feature is especially 42406069ff26Swdenk useful when you configure U-Boot to use a real shell (hush) 42416069ff26Swdenk as command interpreter. 42426069ff26Swdenk 4243c609719bSwdenk 4244c609719bSwdenkStandalone HOWTO: 4245c609719bSwdenk================= 4246c609719bSwdenk 4247c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and 4248c609719bSwdenkrun "standalone" applications, which can use some resources of 4249c609719bSwdenkU-Boot like console I/O functions or interrupt services. 4250c609719bSwdenk 4251c609719bSwdenkTwo simple examples are included with the sources: 4252c609719bSwdenk 4253c609719bSwdenk"Hello World" Demo: 4254c609719bSwdenk------------------- 4255c609719bSwdenk 4256c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo 4257c609719bSwdenkapplication; it is automatically compiled when you build U-Boot. 4258c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it 4259c609719bSwdenklike that: 4260c609719bSwdenk 4261c609719bSwdenk => loads 4262c609719bSwdenk ## Ready for S-Record download ... 4263c609719bSwdenk ~>examples/hello_world.srec 4264c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 ... 4265c609719bSwdenk [file transfer complete] 4266c609719bSwdenk [connected] 4267c609719bSwdenk ## Start Addr = 0x00040004 4268c609719bSwdenk 4269c609719bSwdenk => go 40004 Hello World! This is a test. 4270c609719bSwdenk ## Starting application at 0x00040004 ... 4271c609719bSwdenk Hello World 4272c609719bSwdenk argc = 7 4273c609719bSwdenk argv[0] = "40004" 4274c609719bSwdenk argv[1] = "Hello" 4275c609719bSwdenk argv[2] = "World!" 4276c609719bSwdenk argv[3] = "This" 4277c609719bSwdenk argv[4] = "is" 4278c609719bSwdenk argv[5] = "a" 4279c609719bSwdenk argv[6] = "test." 4280c609719bSwdenk argv[7] = "<NULL>" 4281c609719bSwdenk Hit any key to exit ... 4282c609719bSwdenk 4283c609719bSwdenk ## Application terminated, rc = 0x0 4284c609719bSwdenk 4285c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt 4286c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'. 4287c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second. 4288c609719bSwdenkThe interrupt service routine is trivial, just printing a '.' 4289c609719bSwdenkcharacter, but this is just a demo program. The application can be 4290c609719bSwdenkcontrolled by the following keys: 4291c609719bSwdenk 4292c609719bSwdenk ? - print current values og the CPM Timer registers 4293c609719bSwdenk b - enable interrupts and start timer 4294c609719bSwdenk e - stop timer and disable interrupts 4295c609719bSwdenk q - quit application 4296c609719bSwdenk 4297c609719bSwdenk => loads 4298c609719bSwdenk ## Ready for S-Record download ... 4299c609719bSwdenk ~>examples/timer.srec 4300c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 ... 4301c609719bSwdenk [file transfer complete] 4302c609719bSwdenk [connected] 4303c609719bSwdenk ## Start Addr = 0x00040004 4304c609719bSwdenk 4305c609719bSwdenk => go 40004 4306c609719bSwdenk ## Starting application at 0x00040004 ... 4307c609719bSwdenk TIMERS=0xfff00980 4308c609719bSwdenk Using timer 1 4309c609719bSwdenk tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0 4310c609719bSwdenk 4311c609719bSwdenkHit 'b': 4312c609719bSwdenk [q, b, e, ?] Set interval 1000000 us 4313c609719bSwdenk Enabling timer 4314c609719bSwdenkHit '?': 4315c609719bSwdenk [q, b, e, ?] ........ 4316c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0 4317c609719bSwdenkHit '?': 4318c609719bSwdenk [q, b, e, ?] . 4319c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0 4320c609719bSwdenkHit '?': 4321c609719bSwdenk [q, b, e, ?] . 4322c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0 4323c609719bSwdenkHit '?': 4324c609719bSwdenk [q, b, e, ?] . 4325c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0 4326c609719bSwdenkHit 'e': 4327c609719bSwdenk [q, b, e, ?] ...Stopping timer 4328c609719bSwdenkHit 'q': 4329c609719bSwdenk [q, b, e, ?] ## Application terminated, rc = 0x0 4330c609719bSwdenk 4331c609719bSwdenk 433285ec0bccSwdenkMinicom warning: 433385ec0bccSwdenk================ 433485ec0bccSwdenk 43357152b1d0SwdenkOver time, many people have reported problems when trying to use the 433685ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd) 433785ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under 4338f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and 433985ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and 434085ec0bccSwdenkuse "cu" for S-Record download ("loads" command). 434185ec0bccSwdenk 434252f52c14SwdenkNevertheless, if you absolutely want to use it try adding this 434352f52c14Swdenkconfiguration to your "File transfer protocols" section: 434452f52c14Swdenk 434552f52c14Swdenk Name Program Name U/D FullScr IO-Red. Multi 434652f52c14Swdenk X kermit /usr/bin/kermit -i -l %l -s Y U Y N N 434752f52c14Swdenk Y kermit /usr/bin/kermit -i -l %l -r N D Y N N 434852f52c14Swdenk 434952f52c14Swdenk 4350c609719bSwdenkNetBSD Notes: 4351c609719bSwdenk============= 4352c609719bSwdenk 4353c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host 4354c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx). 4355c609719bSwdenk 4356c609719bSwdenkBuilding requires a cross environment; it is known to work on 4357c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also 4358c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make). 4359c609719bSwdenkNote that the cross-powerpc package does not install include files; 4360c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is 4361c609719bSwdenkmissing. This file has to be installed and patched manually: 4362c609719bSwdenk 4363c609719bSwdenk # cd /usr/pkg/cross/powerpc-netbsd/include 4364c609719bSwdenk # mkdir powerpc 4365c609719bSwdenk # ln -s powerpc machine 4366c609719bSwdenk # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h 4367c609719bSwdenk # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST 4368c609719bSwdenk 4369c609719bSwdenkNative builds *don't* work due to incompatibilities between native 4370c609719bSwdenkand U-Boot include files. 4371c609719bSwdenk 4372c609719bSwdenkBooting assumes that (the first part of) the image booted is a 4373c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel 4374c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source 4375c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the 43762a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz 4377c609719bSwdenk 4378c609719bSwdenk 4379c609719bSwdenkImplementation Internals: 4380c609719bSwdenk========================= 4381c609719bSwdenk 4382c609719bSwdenkThe following is not intended to be a complete description of every 4383c609719bSwdenkimplementation detail. However, it should help to understand the 4384c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom 4385c609719bSwdenkhardware. 4386c609719bSwdenk 4387c609719bSwdenk 4388c609719bSwdenkInitial Stack, Global Data: 4389c609719bSwdenk--------------------------- 4390c609719bSwdenk 4391c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot 4392c609719bSwdenkstarts running out of ROM (flash memory), usually without access to 4393c609719bSwdenksystem RAM (because the memory controller is not initialized yet). 4394c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS 4395c609719bSwdenkis not initialized as zero. To be able to get a C environment working 4396c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation 4397c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU 4398c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and 4399c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be 4400c609719bSwdenklocked as (mis-) used as memory, etc. 4401c609719bSwdenk 44027152b1d0Swdenk Chris Hallinan posted a good summary of these issues to the 44030668236bSWolfgang Denk U-Boot mailing list: 440443d9616cSwdenk 440543d9616cSwdenk Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)? 440643d9616cSwdenk From: "Chris Hallinan" <clh@net1plus.com> 440743d9616cSwdenk Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET) 440843d9616cSwdenk ... 440943d9616cSwdenk 441043d9616cSwdenk Correct me if I'm wrong, folks, but the way I understand it 441143d9616cSwdenk is this: Using DCACHE as initial RAM for Stack, etc, does not 441243d9616cSwdenk require any physical RAM backing up the cache. The cleverness 441343d9616cSwdenk is that the cache is being used as a temporary supply of 441443d9616cSwdenk necessary storage before the SDRAM controller is setup. It's 441511ccc33fSMarcel Ziswiler beyond the scope of this list to explain the details, but you 441643d9616cSwdenk can see how this works by studying the cache architecture and 441743d9616cSwdenk operation in the architecture and processor-specific manuals. 441843d9616cSwdenk 441943d9616cSwdenk OCM is On Chip Memory, which I believe the 405GP has 4K. It 442043d9616cSwdenk is another option for the system designer to use as an 442111ccc33fSMarcel Ziswiler initial stack/RAM area prior to SDRAM being available. Either 442243d9616cSwdenk option should work for you. Using CS 4 should be fine if your 442343d9616cSwdenk board designers haven't used it for something that would 442443d9616cSwdenk cause you grief during the initial boot! It is frequently not 442543d9616cSwdenk used. 442643d9616cSwdenk 44276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere 442843d9616cSwdenk with your processor/board/system design. The default value 442943d9616cSwdenk you will find in any recent u-boot distribution in 44308a316c9bSStefan Roese walnut.h should work for you. I'd set it to a value larger 443143d9616cSwdenk than your SDRAM module. If you have a 64MB SDRAM module, set 443243d9616cSwdenk it above 400_0000. Just make sure your board has no resources 443343d9616cSwdenk that are supposed to respond to that address! That code in 443443d9616cSwdenk start.S has been around a while and should work as is when 443543d9616cSwdenk you get the config right. 443643d9616cSwdenk 443743d9616cSwdenk -Chris Hallinan 443843d9616cSwdenk DS4.COM, Inc. 443943d9616cSwdenk 4440c609719bSwdenkIt is essential to remember this, since it has some impact on the C 4441c609719bSwdenkcode for the initialization procedures: 4442c609719bSwdenk 4443c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt 4444c609719bSwdenk to write it. 4445c609719bSwdenk 444611ccc33fSMarcel Ziswiler* Do not use any uninitialized global data (or implicitely initialized 4447c609719bSwdenk as zero data - BSS segment) at all - this is undefined, initiali- 44487152b1d0Swdenk zation is performed later (when relocating to RAM). 4449c609719bSwdenk 4450c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like 4451c609719bSwdenk that. 4452c609719bSwdenk 4453c609719bSwdenkHaving only the stack as writable memory limits means we cannot use 4454c609719bSwdenknormal global data to share information beween the code. But it 4455c609719bSwdenkturned out that the implementation of U-Boot can be greatly 4456c609719bSwdenksimplified by making a global data structure (gd_t) available to all 4457c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_ 4458c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of 4459c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we 4460c609719bSwdenkplace a pointer (gd) to the global data into a register which we 4461c609719bSwdenkreserve for this purpose. 4462c609719bSwdenk 44637152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the 4464c609719bSwdenkrelevant (E)ABI specifications for the current architecture, and by 4465c609719bSwdenkGCC's implementation. 4466c609719bSwdenk 4467c609719bSwdenkFor PowerPC, the following registers have specific use: 4468c609719bSwdenk R1: stack pointer 4469e7670f6cSWolfgang Denk R2: reserved for system use 4470c609719bSwdenk R3-R4: parameter passing and return values 4471c609719bSwdenk R5-R10: parameter passing 4472c609719bSwdenk R13: small data area pointer 4473c609719bSwdenk R30: GOT pointer 4474c609719bSwdenk R31: frame pointer 4475c609719bSwdenk 4476e6bee808SJoakim Tjernlund (U-Boot also uses R12 as internal GOT pointer. r12 4477e6bee808SJoakim Tjernlund is a volatile register so r12 needs to be reset when 4478e6bee808SJoakim Tjernlund going back and forth between asm and C) 4479c609719bSwdenk 4480e7670f6cSWolfgang Denk ==> U-Boot will use R2 to hold a pointer to the global data 4481c609719bSwdenk 4482c609719bSwdenk Note: on PPC, we could use a static initializer (since the 4483c609719bSwdenk address of the global data structure is known at compile time), 4484c609719bSwdenk but it turned out that reserving a register results in somewhat 4485c609719bSwdenk smaller code - although the code savings are not that big (on 4486c609719bSwdenk average for all boards 752 bytes for the whole U-Boot image, 4487c609719bSwdenk 624 text + 127 data). 4488c609719bSwdenk 4489c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here: 44904c58eb55SMike Frysinger http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface 44914c58eb55SMike Frysinger 4492c4db335cSRobin Getz ==> U-Boot will use P3 to hold a pointer to the global data 44934c58eb55SMike Frysinger 4494c609719bSwdenkOn ARM, the following registers are used: 4495c609719bSwdenk 4496c609719bSwdenk R0: function argument word/integer result 4497c609719bSwdenk R1-R3: function argument word 4498c609719bSwdenk R9: GOT pointer 4499c609719bSwdenk R10: stack limit (used only if stack checking if enabled) 4500c609719bSwdenk R11: argument (frame) pointer 4501c609719bSwdenk R12: temporary workspace 4502c609719bSwdenk R13: stack pointer 4503c609719bSwdenk R14: link register 4504c609719bSwdenk R15: program counter 4505c609719bSwdenk 4506c609719bSwdenk ==> U-Boot will use R8 to hold a pointer to the global data 4507c609719bSwdenk 45080df01fd3SThomas ChouOn Nios II, the ABI is documented here: 45090df01fd3SThomas Chou http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf 45100df01fd3SThomas Chou 45110df01fd3SThomas Chou ==> U-Boot will use gp to hold a pointer to the global data 45120df01fd3SThomas Chou 45130df01fd3SThomas Chou Note: on Nios II, we give "-G0" option to gcc and don't use gp 45140df01fd3SThomas Chou to access small data sections, so gp is free. 45150df01fd3SThomas Chou 4516afc1ce82SMacpaul LinOn NDS32, the following registers are used: 4517afc1ce82SMacpaul Lin 4518afc1ce82SMacpaul Lin R0-R1: argument/return 4519afc1ce82SMacpaul Lin R2-R5: argument 4520afc1ce82SMacpaul Lin R15: temporary register for assembler 4521afc1ce82SMacpaul Lin R16: trampoline register 4522afc1ce82SMacpaul Lin R28: frame pointer (FP) 4523afc1ce82SMacpaul Lin R29: global pointer (GP) 4524afc1ce82SMacpaul Lin R30: link register (LP) 4525afc1ce82SMacpaul Lin R31: stack pointer (SP) 4526afc1ce82SMacpaul Lin PC: program counter (PC) 4527afc1ce82SMacpaul Lin 4528afc1ce82SMacpaul Lin ==> U-Boot will use R10 to hold a pointer to the global data 4529afc1ce82SMacpaul Lin 4530d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope, 4531d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much. 4532c609719bSwdenk 4533c609719bSwdenkMemory Management: 4534c609719bSwdenk------------------ 4535c609719bSwdenk 4536c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the 4537c609719bSwdenkMMU is not used either for address mapping nor for memory protection. 4538c609719bSwdenk 4539c609719bSwdenkThe available memory is mapped to fixed addresses using the memory 4540c609719bSwdenkcontroller. In this process, a contiguous block is formed for each 4541c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several 4542c609719bSwdenkphysical memory banks. 4543c609719bSwdenk 4544c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on 4545c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After 4546c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself 4547c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some 45486d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN 4549c609719bSwdenkconfiguration setting]. Below that, a structure with global Board 4550c609719bSwdenkInfo data is placed, followed by the stack (growing downward). 4551c609719bSwdenk 4552c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB 4553c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF). 4554c609719bSwdenk 4555c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like 4556c609719bSwdenkthis: 4557c609719bSwdenk 4558c609719bSwdenk 0x0000 0000 Exception Vector code 4559c609719bSwdenk : 4560c609719bSwdenk 0x0000 1FFF 4561c609719bSwdenk 0x0000 2000 Free for Application Use 4562c609719bSwdenk : 4563c609719bSwdenk : 4564c609719bSwdenk 4565c609719bSwdenk : 4566c609719bSwdenk : 4567c609719bSwdenk 0x00FB FF20 Monitor Stack (Growing downward) 4568c609719bSwdenk 0x00FB FFAC Board Info Data and permanent copy of global data 4569c609719bSwdenk 0x00FC 0000 Malloc Arena 4570c609719bSwdenk : 4571c609719bSwdenk 0x00FD FFFF 4572c609719bSwdenk 0x00FE 0000 RAM Copy of Monitor Code 4573c609719bSwdenk ... eventually: LCD or video framebuffer 4574c609719bSwdenk ... eventually: pRAM (Protected RAM - unchanged by reset) 4575c609719bSwdenk 0x00FF FFFF [End of RAM] 4576c609719bSwdenk 4577c609719bSwdenk 4578c609719bSwdenkSystem Initialization: 4579c609719bSwdenk---------------------- 4580c609719bSwdenk 4581c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point 458211ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset 4583c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory. 45847152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address. 4585c609719bSwdenkTo be able to implement the initialization code in C, a (small!) 4586c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs 4587c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked 4588c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core, 4589c609719bSwdenkthe caches and the SIU. 4590c609719bSwdenk 4591c609719bSwdenkNext, all (potentially) available memory banks are mapped using a 4592c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries 4593c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash 4594c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is 4595c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a 4596c609719bSwdenksimple memory test is run that determines the size of the SDRAM 4597c609719bSwdenkbanks. 4598c609719bSwdenk 4599c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of 46007152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first 4601c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address 4602c609719bSwdenk0x00000000, with any additional banks following immediately to create 4603c609719bSwdenkcontiguous memory starting from 0. 4604c609719bSwdenk 4605c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area 4606c609719bSwdenkand allocates memory for use by malloc() and for the global Board 4607c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM 4608c609719bSwdenkpages, and the final stack is set up. 4609c609719bSwdenk 4610c609719bSwdenkOnly after this relocation will you have a "normal" C environment; 4611c609719bSwdenkuntil that you are restricted in several ways, mostly because you are 4612c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a 4613c609719bSwdenknew address in RAM. 4614c609719bSwdenk 4615c609719bSwdenk 4616c609719bSwdenkU-Boot Porting Guide: 4617c609719bSwdenk---------------------- 4618c609719bSwdenk 4619c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing 46206aff3115Swdenklist, October 2002] 4621c609719bSwdenk 4622c609719bSwdenk 4623c609719bSwdenkint main(int argc, char *argv[]) 4624c609719bSwdenk{ 4625c609719bSwdenk sighandler_t no_more_time; 4626c609719bSwdenk 4627c609719bSwdenk signal(SIGALRM, no_more_time); 4628c609719bSwdenk alarm(PROJECT_DEADLINE - toSec (3 * WEEK)); 4629c609719bSwdenk 4630c609719bSwdenk if (available_money > available_manpower) { 46316c3fef28SJerry Van Baren Pay consultant to port U-Boot; 4632c609719bSwdenk return 0; 4633c609719bSwdenk } 4634c609719bSwdenk 4635c609719bSwdenk Download latest U-Boot source; 4636c609719bSwdenk 46370668236bSWolfgang Denk Subscribe to u-boot mailing list; 46386aff3115Swdenk 46396c3fef28SJerry Van Baren if (clueless) 4640c609719bSwdenk email("Hi, I am new to U-Boot, how do I get started?"); 4641c609719bSwdenk 4642c609719bSwdenk while (learning) { 4643c609719bSwdenk Read the README file in the top level directory; 46447cb22f97Swdenk Read http://www.denx.de/twiki/bin/view/DULG/Manual; 46456c3fef28SJerry Van Baren Read applicable doc/*.README; 4646c609719bSwdenk Read the source, Luke; 46476c3fef28SJerry Van Baren /* find . -name "*.[chS]" | xargs grep -i <keyword> */ 4648c609719bSwdenk } 4649c609719bSwdenk 46506c3fef28SJerry Van Baren if (available_money > toLocalCurrency ($2500)) 46516c3fef28SJerry Van Baren Buy a BDI3000; 46526c3fef28SJerry Van Baren else 4653c609719bSwdenk Add a lot of aggravation and time; 4654c609719bSwdenk 46556c3fef28SJerry Van Baren if (a similar board exists) { /* hopefully... */ 46566c3fef28SJerry Van Baren cp -a board/<similar> board/<myboard> 46576c3fef28SJerry Van Baren cp include/configs/<similar>.h include/configs/<myboard>.h 46586c3fef28SJerry Van Baren } else { 4659c609719bSwdenk Create your own board support subdirectory; 46606c3fef28SJerry Van Baren Create your own board include/configs/<myboard>.h file; 46616c3fef28SJerry Van Baren } 46626c3fef28SJerry Van Baren Edit new board/<myboard> files 46636c3fef28SJerry Van Baren Edit new include/configs/<myboard>.h 4664c609719bSwdenk 46656c3fef28SJerry Van Baren while (!accepted) { 4666c609719bSwdenk while (!running) { 4667c609719bSwdenk do { 4668c609719bSwdenk Add / modify source code; 4669c609719bSwdenk } until (compiles); 4670c609719bSwdenk Debug; 4671c609719bSwdenk if (clueless) 4672c609719bSwdenk email("Hi, I am having problems..."); 4673c609719bSwdenk } 46746c3fef28SJerry Van Baren Send patch file to the U-Boot email list; 46756c3fef28SJerry Van Baren if (reasonable critiques) 46766c3fef28SJerry Van Baren Incorporate improvements from email list code review; 46776c3fef28SJerry Van Baren else 46786c3fef28SJerry Van Baren Defend code as written; 46796c3fef28SJerry Van Baren } 4680c609719bSwdenk 4681c609719bSwdenk return 0; 4682c609719bSwdenk} 4683c609719bSwdenk 4684c609719bSwdenkvoid no_more_time (int sig) 4685c609719bSwdenk{ 4686c609719bSwdenk hire_a_guru(); 4687c609719bSwdenk} 4688c609719bSwdenk 4689c609719bSwdenk 4690c609719bSwdenkCoding Standards: 4691c609719bSwdenk----------------- 4692c609719bSwdenk 4693c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel 46942c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script 46957ca9296eSWolfgang Denk"scripts/Lindent" in your Linux kernel source directory. 4696c609719bSwdenk 46972c051651SDetlev ZundelSource files originating from a different project (for example the 46982c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not 46992c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those 47002c051651SDetlev Zundelsources. 47012c051651SDetlev Zundel 47022c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in 47032c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//) 47042c051651SDetlev Zundelin your code. 4705c609719bSwdenk 4706c178d3daSwdenkPlease also stick to the following formatting rules: 4707180d3f74Swdenk- remove any trailing white space 47087ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces 4709180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds 47107ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files 4711180d3f74Swdenk- do not add trailing empty lines to source files 4712180d3f74Swdenk 4713c609719bSwdenkSubmissions which do not conform to the standards may be returned 4714c609719bSwdenkwith a request to reformat the changes. 4715c609719bSwdenk 4716c609719bSwdenk 4717c609719bSwdenkSubmitting Patches: 4718c609719bSwdenk------------------- 4719c609719bSwdenk 4720c609719bSwdenkSince the number of patches for U-Boot is growing, we need to 4721c609719bSwdenkestablish some rules. Submissions which do not conform to these rules 4722c609719bSwdenkmay be rejected, even when they contain important and valuable stuff. 4723c609719bSwdenk 47240d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details. 4725218ca724SWolfgang Denk 47260668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>; 47270668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot 47280668236bSWolfgang Denk 4729c609719bSwdenkWhen you send a patch, please include the following information with 4730c609719bSwdenkit: 4731c609719bSwdenk 4732c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes 4733c609719bSwdenk this bug. Please try to include a way of demonstrating that the 4734c609719bSwdenk patch actually fixes something. 4735c609719bSwdenk 4736c609719bSwdenk* For new features: a description of the feature and your 4737c609719bSwdenk implementation. 4738c609719bSwdenk 4739c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch) 4740c609719bSwdenk 4741c609719bSwdenk* For major contributions, your entry to the CREDITS file 4742c609719bSwdenk 4743c609719bSwdenk* When you add support for a new board, don't forget to add this 47447ca9296eSWolfgang Denk board to the MAINTAINERS file, too. 4745c609719bSwdenk 4746c609719bSwdenk* If your patch adds new configuration options, don't forget to 4747c609719bSwdenk document these in the README file. 4748c609719bSwdenk 4749218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly* 4750218ca724SWolfgang Denk recommended) you can easily generate the patch using the 47517ca9296eSWolfgang Denk "git format-patch". If you then use "git send-email" to send it to 4752218ca724SWolfgang Denk the U-Boot mailing list, you will avoid most of the common problems 4753218ca724SWolfgang Denk with some other mail clients. 4754c609719bSwdenk 4755218ca724SWolfgang Denk If you cannot use git, use "diff -purN OLD NEW". If your version of 4756218ca724SWolfgang Denk diff does not support these options, then get the latest version of 4757218ca724SWolfgang Denk GNU diff. 47586dff5529Swdenk 4759218ca724SWolfgang Denk The current directory when running this command shall be the parent 4760218ca724SWolfgang Denk directory of the U-Boot source tree (i. e. please make sure that 4761218ca724SWolfgang Denk your patch includes sufficient directory information for the 4762218ca724SWolfgang Denk affected files). 4763218ca724SWolfgang Denk 4764218ca724SWolfgang Denk We prefer patches as plain text. MIME attachments are discouraged, 4765218ca724SWolfgang Denk and compressed attachments must not be used. 4766c609719bSwdenk 476752f52c14Swdenk* If one logical set of modifications affects or creates several 476852f52c14Swdenk files, all these changes shall be submitted in a SINGLE patch file. 476952f52c14Swdenk 477052f52c14Swdenk* Changesets that contain different, unrelated modifications shall be 477152f52c14Swdenk submitted as SEPARATE patches, one patch per changeset. 477252f52c14Swdenk 477352f52c14Swdenk 4774c609719bSwdenkNotes: 4775c609719bSwdenk 4776c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched 4777c609719bSwdenk source tree and make sure that no errors or warnings are reported 4778c609719bSwdenk for any of the boards. 4779c609719bSwdenk 4780c609719bSwdenk* Keep your modifications to the necessary minimum: A patch 4781c609719bSwdenk containing several unrelated changes or arbitrary reformats will be 4782c609719bSwdenk returned with a request to re-formatting / split it. 4783c609719bSwdenk 4784c609719bSwdenk* If you modify existing code, make sure that your new code does not 4785c609719bSwdenk add to the memory footprint of the code ;-) Small is beautiful! 4786c609719bSwdenk When adding new features, these should compile conditionally only 4787c609719bSwdenk (using #ifdef), and the resulting code with the new feature 4788c609719bSwdenk disabled must not need more memory than the old code without your 4789c609719bSwdenk modification. 479090dc6704Swdenk 47910668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the 47920668236bSWolfgang Denk u-boot mailing list. Bigger patches will be moderated. If they are 47930668236bSWolfgang Denk reasonable and not too big, they will be acknowledged. But patches 47940668236bSWolfgang Denk bigger than the size limit should be avoided. 4795