1c609719bSwdenk# 2b75190deSWolfgang Denk# (C) Copyright 2000 - 2012 3c609719bSwdenk# Wolfgang Denk, DENX Software Engineering, wd@denx.de. 4c609719bSwdenk# 5c609719bSwdenk# See file CREDITS for list of people who contributed to this 6c609719bSwdenk# project. 7c609719bSwdenk# 8c609719bSwdenk# This program is free software; you can redistribute it and/or 9c609719bSwdenk# modify it under the terms of the GNU General Public License as 10c609719bSwdenk# published by the Free Software Foundation; either version 2 of 11c609719bSwdenk# the License, or (at your option) any later version. 12c609719bSwdenk# 13c609719bSwdenk# This program is distributed in the hope that it will be useful, 14c609719bSwdenk# but WITHOUT ANY WARRANTY; without even the implied warranty of 15c609719bSwdenk# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16c609719bSwdenk# GNU General Public License for more details. 17c609719bSwdenk# 18c609719bSwdenk# You should have received a copy of the GNU General Public License 19c609719bSwdenk# along with this program; if not, write to the Free Software 20c609719bSwdenk# Foundation, Inc., 59 Temple Place, Suite 330, Boston, 21c609719bSwdenk# MA 02111-1307 USA 22c609719bSwdenk# 23c609719bSwdenk 24c609719bSwdenkSummary: 25c609719bSwdenk======== 26c609719bSwdenk 2724ee89b9SwdenkThis directory contains the source code for U-Boot, a boot loader for 28e86e5a07SwdenkEmbedded boards based on PowerPC, ARM, MIPS and several other 29e86e5a07Swdenkprocessors, which can be installed in a boot ROM and used to 30e86e5a07Swdenkinitialize and test the hardware or to download and run application 31e86e5a07Swdenkcode. 32c609719bSwdenk 33c609719bSwdenkThe development of U-Boot is closely related to Linux: some parts of 3424ee89b9Swdenkthe source code originate in the Linux source tree, we have some 3524ee89b9Swdenkheader files in common, and special provision has been made to 36c609719bSwdenksupport booting of Linux images. 37c609719bSwdenk 38c609719bSwdenkSome attention has been paid to make this software easily 39c609719bSwdenkconfigurable and extendable. For instance, all monitor commands are 40c609719bSwdenkimplemented with the same call interface, so that it's very easy to 41c609719bSwdenkadd new commands. Also, instead of permanently adding rarely used 42c609719bSwdenkcode (for instance hardware test utilities) to the monitor, you can 43c609719bSwdenkload and run it dynamically. 44c609719bSwdenk 45c609719bSwdenk 46c609719bSwdenkStatus: 47c609719bSwdenk======= 48c609719bSwdenk 49c609719bSwdenkIn general, all boards for which a configuration option exists in the 50c609719bSwdenkMakefile have been tested to some extent and can be considered 51c609719bSwdenk"working". In fact, many of them are used in production systems. 52c609719bSwdenk 53c609719bSwdenkIn case of problems see the CHANGELOG and CREDITS files to find out 54218ca724SWolfgang Denkwho contributed the specific port. The MAINTAINERS file lists board 55218ca724SWolfgang Denkmaintainers. 56c609719bSwdenk 57c609719bSwdenk 58c609719bSwdenkWhere to get help: 59c609719bSwdenk================== 60c609719bSwdenk 61c609719bSwdenkIn case you have questions about, problems with or contributions for 62c609719bSwdenkU-Boot you should send a message to the U-Boot mailing list at 630c32565fSPeter Tyser<u-boot@lists.denx.de>. There is also an archive of previous traffic 640c32565fSPeter Tyseron the mailing list - please search the archive before asking FAQ's. 650c32565fSPeter TyserPlease see http://lists.denx.de/pipermail/u-boot and 660c32565fSPeter Tyserhttp://dir.gmane.org/gmane.comp.boot-loaders.u-boot 67c609719bSwdenk 68c609719bSwdenk 69218ca724SWolfgang DenkWhere to get source code: 70218ca724SWolfgang Denk========================= 71218ca724SWolfgang Denk 72218ca724SWolfgang DenkThe U-Boot source code is maintained in the git repository at 73218ca724SWolfgang Denkgit://www.denx.de/git/u-boot.git ; you can browse it online at 74218ca724SWolfgang Denkhttp://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary 75218ca724SWolfgang Denk 76218ca724SWolfgang DenkThe "snapshot" links on this page allow you to download tarballs of 7711ccc33fSMarcel Ziswilerany version you might be interested in. Official releases are also 78218ca724SWolfgang Denkavailable for FTP download from the ftp://ftp.denx.de/pub/u-boot/ 79218ca724SWolfgang Denkdirectory. 80218ca724SWolfgang Denk 81d4ee711dSAnatolij GustschinPre-built (and tested) images are available from 82218ca724SWolfgang Denkftp://ftp.denx.de/pub/u-boot/images/ 83218ca724SWolfgang Denk 84218ca724SWolfgang Denk 85c609719bSwdenkWhere we come from: 86c609719bSwdenk=================== 87c609719bSwdenk 88c609719bSwdenk- start from 8xxrom sources 8924ee89b9Swdenk- create PPCBoot project (http://sourceforge.net/projects/ppcboot) 90c609719bSwdenk- clean up code 91c609719bSwdenk- make it easier to add custom boards 92c609719bSwdenk- make it possible to add other [PowerPC] CPUs 93c609719bSwdenk- extend functions, especially: 94c609719bSwdenk * Provide extended interface to Linux boot loader 95c609719bSwdenk * S-Record download 96c609719bSwdenk * network boot 9711ccc33fSMarcel Ziswiler * PCMCIA / CompactFlash / ATA disk / SCSI ... boot 9824ee89b9Swdenk- create ARMBoot project (http://sourceforge.net/projects/armboot) 99c609719bSwdenk- add other CPU families (starting with ARM) 10024ee89b9Swdenk- create U-Boot project (http://sourceforge.net/projects/u-boot) 1010d28f34bSMagnus Lilja- current project page: see http://www.denx.de/wiki/U-Boot 10224ee89b9Swdenk 10324ee89b9Swdenk 10424ee89b9SwdenkNames and Spelling: 10524ee89b9Swdenk=================== 10624ee89b9Swdenk 10724ee89b9SwdenkThe "official" name of this project is "Das U-Boot". The spelling 10824ee89b9Swdenk"U-Boot" shall be used in all written text (documentation, comments 10924ee89b9Swdenkin source files etc.). Example: 11024ee89b9Swdenk 11124ee89b9Swdenk This is the README file for the U-Boot project. 11224ee89b9Swdenk 11324ee89b9SwdenkFile names etc. shall be based on the string "u-boot". Examples: 11424ee89b9Swdenk 11524ee89b9Swdenk include/asm-ppc/u-boot.h 11624ee89b9Swdenk 11724ee89b9Swdenk #include <asm/u-boot.h> 11824ee89b9Swdenk 11924ee89b9SwdenkVariable names, preprocessor constants etc. shall be either based on 12024ee89b9Swdenkthe string "u_boot" or on "U_BOOT". Example: 12124ee89b9Swdenk 12224ee89b9Swdenk U_BOOT_VERSION u_boot_logo 12324ee89b9Swdenk IH_OS_U_BOOT u_boot_hush_start 124c609719bSwdenk 125c609719bSwdenk 12693f19cc0SwdenkVersioning: 12793f19cc0Swdenk=========== 12893f19cc0Swdenk 129360d883aSThomas WeberStarting with the release in October 2008, the names of the releases 130360d883aSThomas Weberwere changed from numerical release numbers without deeper meaning 131360d883aSThomas Weberinto a time stamp based numbering. Regular releases are identified by 132360d883aSThomas Webernames consisting of the calendar year and month of the release date. 133360d883aSThomas WeberAdditional fields (if present) indicate release candidates or bug fix 134360d883aSThomas Weberreleases in "stable" maintenance trees. 13593f19cc0Swdenk 136360d883aSThomas WeberExamples: 137360d883aSThomas Weber U-Boot v2009.11 - Release November 2009 138360d883aSThomas Weber U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree 139360d883aSThomas Weber U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release 14093f19cc0Swdenk 14193f19cc0Swdenk 142c609719bSwdenkDirectory Hierarchy: 143c609719bSwdenk==================== 144c609719bSwdenk 1458d321b81SPeter Tyser/arch Architecture specific files 1468d321b81SPeter Tyser /arm Files generic to ARM architecture 1478d321b81SPeter Tyser /cpu CPU specific files 1488d321b81SPeter Tyser /arm720t Files specific to ARM 720 CPUs 1498d321b81SPeter Tyser /arm920t Files specific to ARM 920 CPUs 1506eb0921aSAndreas Bießmann /at91 Files specific to Atmel AT91RM9200 CPU 1518d321b81SPeter Tyser /imx Files specific to Freescale MC9328 i.MX CPUs 1528d321b81SPeter Tyser /s3c24x0 Files specific to Samsung S3C24X0 CPUs 1538d321b81SPeter Tyser /arm925t Files specific to ARM 925 CPUs 1548d321b81SPeter Tyser /arm926ejs Files specific to ARM 926 CPUs 1558d321b81SPeter Tyser /arm1136 Files specific to ARM 1136 CPUs 1568d321b81SPeter Tyser /ixp Files specific to Intel XScale IXP CPUs 1578d321b81SPeter Tyser /pxa Files specific to Intel XScale PXA CPUs 1588d321b81SPeter Tyser /s3c44b0 Files specific to Samsung S3C44B0 CPUs 1598d321b81SPeter Tyser /sa1100 Files specific to Intel StrongARM SA1100 CPUs 1608d321b81SPeter Tyser /lib Architecture specific library files 1618d321b81SPeter Tyser /avr32 Files generic to AVR32 architecture 1628d321b81SPeter Tyser /cpu CPU specific files 1638d321b81SPeter Tyser /lib Architecture specific library files 1648d321b81SPeter Tyser /blackfin Files generic to Analog Devices Blackfin architecture 1658d321b81SPeter Tyser /cpu CPU specific files 1668d321b81SPeter Tyser /lib Architecture specific library files 167fea25720SGraeme Russ /x86 Files generic to x86 architecture 1688d321b81SPeter Tyser /cpu CPU specific files 1698d321b81SPeter Tyser /lib Architecture specific library files 1708d321b81SPeter Tyser /m68k Files generic to m68k architecture 1718d321b81SPeter Tyser /cpu CPU specific files 1728d321b81SPeter Tyser /mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs 1738d321b81SPeter Tyser /mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs 1748d321b81SPeter Tyser /mcf532x Files specific to Freescale ColdFire MCF5329 CPUs 1758d321b81SPeter Tyser /mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs 1768d321b81SPeter Tyser /mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs 1778d321b81SPeter Tyser /lib Architecture specific library files 1788d321b81SPeter Tyser /microblaze Files generic to microblaze architecture 1798d321b81SPeter Tyser /cpu CPU specific files 1808d321b81SPeter Tyser /lib Architecture specific library files 1818d321b81SPeter Tyser /mips Files generic to MIPS architecture 1828d321b81SPeter Tyser /cpu CPU specific files 18392bbd64eSDaniel Schwierzeck /mips32 Files specific to MIPS32 CPUs 18480421fccSXiangfu Liu /xburst Files specific to Ingenic XBurst CPUs 1858d321b81SPeter Tyser /lib Architecture specific library files 186afc1ce82SMacpaul Lin /nds32 Files generic to NDS32 architecture 187afc1ce82SMacpaul Lin /cpu CPU specific files 188afc1ce82SMacpaul Lin /n1213 Files specific to Andes Technology N1213 CPUs 189afc1ce82SMacpaul Lin /lib Architecture specific library files 1908d321b81SPeter Tyser /nios2 Files generic to Altera NIOS2 architecture 1918d321b81SPeter Tyser /cpu CPU specific files 1928d321b81SPeter Tyser /lib Architecture specific library files 193a47a12beSStefan Roese /powerpc Files generic to PowerPC architecture 1948d321b81SPeter Tyser /cpu CPU specific files 1958d321b81SPeter Tyser /74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs 1968d321b81SPeter Tyser /mpc5xx Files specific to Freescale MPC5xx CPUs 1978d321b81SPeter Tyser /mpc5xxx Files specific to Freescale MPC5xxx CPUs 1988d321b81SPeter Tyser /mpc8xx Files specific to Freescale MPC8xx CPUs 1998d321b81SPeter Tyser /mpc8220 Files specific to Freescale MPC8220 CPUs 2008d321b81SPeter Tyser /mpc824x Files specific to Freescale MPC824x CPUs 2018d321b81SPeter Tyser /mpc8260 Files specific to Freescale MPC8260 CPUs 2028d321b81SPeter Tyser /mpc85xx Files specific to Freescale MPC85xx CPUs 2038d321b81SPeter Tyser /ppc4xx Files specific to AMCC PowerPC 4xx CPUs 2048d321b81SPeter Tyser /lib Architecture specific library files 2058d321b81SPeter Tyser /sh Files generic to SH architecture 2068d321b81SPeter Tyser /cpu CPU specific files 2078d321b81SPeter Tyser /sh2 Files specific to sh2 CPUs 2088d321b81SPeter Tyser /sh3 Files specific to sh3 CPUs 2098d321b81SPeter Tyser /sh4 Files specific to sh4 CPUs 2108d321b81SPeter Tyser /lib Architecture specific library files 2118d321b81SPeter Tyser /sparc Files generic to SPARC architecture 2128d321b81SPeter Tyser /cpu CPU specific files 2138d321b81SPeter Tyser /leon2 Files specific to Gaisler LEON2 SPARC CPU 2148d321b81SPeter Tyser /leon3 Files specific to Gaisler LEON3 SPARC CPU 2158d321b81SPeter Tyser /lib Architecture specific library files 2168d321b81SPeter Tyser/api Machine/arch independent API for external apps 2178d321b81SPeter Tyser/board Board dependent files 2188d321b81SPeter Tyser/common Misc architecture independent functions 2198d321b81SPeter Tyser/disk Code for disk drive partition handling 2208d321b81SPeter Tyser/doc Documentation (don't expect too much) 2218d321b81SPeter Tyser/drivers Commonly used device drivers 2228d321b81SPeter Tyser/examples Example code for standalone applications, etc. 2238d321b81SPeter Tyser/fs Filesystem code (cramfs, ext2, jffs2, etc.) 2248d321b81SPeter Tyser/include Header Files 2258d321b81SPeter Tyser/lib Files generic to all architectures 2268d321b81SPeter Tyser /libfdt Library files to support flattened device trees 2278d321b81SPeter Tyser /lzma Library files to support LZMA decompression 2288d321b81SPeter Tyser /lzo Library files to support LZO decompression 2298d321b81SPeter Tyser/net Networking code 2308d321b81SPeter Tyser/post Power On Self Test 2318d321b81SPeter Tyser/rtc Real Time Clock drivers 2328d321b81SPeter Tyser/tools Tools to build S-Record or U-Boot images, etc. 233c609719bSwdenk 234c609719bSwdenkSoftware Configuration: 235c609719bSwdenk======================= 236c609719bSwdenk 237c609719bSwdenkConfiguration is usually done using C preprocessor defines; the 238c609719bSwdenkrationale behind that is to avoid dead code whenever possible. 239c609719bSwdenk 240c609719bSwdenkThere are two classes of configuration variables: 241c609719bSwdenk 242c609719bSwdenk* Configuration _OPTIONS_: 243c609719bSwdenk These are selectable by the user and have names beginning with 244c609719bSwdenk "CONFIG_". 245c609719bSwdenk 246c609719bSwdenk* Configuration _SETTINGS_: 247c609719bSwdenk These depend on the hardware etc. and should not be meddled with if 248c609719bSwdenk you don't know what you're doing; they have names beginning with 2496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD "CONFIG_SYS_". 250c609719bSwdenk 251c609719bSwdenkLater we will add a configuration tool - probably similar to or even 252c609719bSwdenkidentical to what's used for the Linux kernel. Right now, we have to 253c609719bSwdenkdo the configuration by hand, which means creating some symbolic 254c609719bSwdenklinks and editing some configuration files. We use the TQM8xxL boards 255c609719bSwdenkas an example here. 256c609719bSwdenk 257c609719bSwdenk 258c609719bSwdenkSelection of Processor Architecture and Board Type: 259c609719bSwdenk--------------------------------------------------- 260c609719bSwdenk 261c609719bSwdenkFor all supported boards there are ready-to-use default 262c609719bSwdenkconfigurations available; just type "make <board_name>_config". 263c609719bSwdenk 264c609719bSwdenkExample: For a TQM823L module type: 265c609719bSwdenk 266c609719bSwdenk cd u-boot 267c609719bSwdenk make TQM823L_config 268c609719bSwdenk 26911ccc33fSMarcel ZiswilerFor the Cogent platform, you need to specify the CPU type as well; 270c609719bSwdenke.g. "make cogent_mpc8xx_config". And also configure the cogent 271c609719bSwdenkdirectory according to the instructions in cogent/README. 272c609719bSwdenk 273c609719bSwdenk 274c609719bSwdenkConfiguration Options: 275c609719bSwdenk---------------------- 276c609719bSwdenk 277c609719bSwdenkConfiguration depends on the combination of board and CPU type; all 278c609719bSwdenksuch information is kept in a configuration file 279c609719bSwdenk"include/configs/<board_name>.h". 280c609719bSwdenk 281c609719bSwdenkExample: For a TQM823L module, all configuration settings are in 282c609719bSwdenk"include/configs/TQM823L.h". 283c609719bSwdenk 284c609719bSwdenk 2857f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux 2867f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to 2877f6c2cbcSwdenkbuild a config tool - later. 2887f6c2cbcSwdenk 2897f6c2cbcSwdenk 290c609719bSwdenkThe following options need to be configured: 291c609719bSwdenk 2922628114eSKim Phillips- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX. 293c609719bSwdenk 2942628114eSKim Phillips- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS. 2956ccec449SWolfgang Denk 2966ccec449SWolfgang Denk- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined) 29709ea0de0SHaavard Skinnemoen Define exactly one, e.g. CONFIG_ATSTK1002 298c609719bSwdenk 299c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined) 300c609719bSwdenk Define exactly one of 301c609719bSwdenk CONFIG_CMA286_60_OLD 302c609719bSwdenk--- FIXME --- not tested yet: 303c609719bSwdenk CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P, 304c609719bSwdenk CONFIG_CMA287_23, CONFIG_CMA287_50 305c609719bSwdenk 306c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined) 307c609719bSwdenk Define exactly one of 308c609719bSwdenk CONFIG_CMA101, CONFIG_CMA102 309c609719bSwdenk 310c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined) 311c609719bSwdenk Define one or more of 312c609719bSwdenk CONFIG_CMA302 313c609719bSwdenk 314c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined) 315c609719bSwdenk Define one or more of 316c609719bSwdenk CONFIG_LCD_HEARTBEAT - update a character position on 31711ccc33fSMarcel Ziswiler the LCD display every second with 318c609719bSwdenk a "rotator" |\-/|\-/ 319c609719bSwdenk 3202535d602Swdenk- Board flavour: (if CONFIG_MPC8260ADS is defined) 3212535d602Swdenk CONFIG_ADSTYPE 3222535d602Swdenk Possible values are: 3236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8260ADS - original MPC8260ADS 3246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8266ADS - MPC8266ADS 3256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR 3266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8272ADS - MPC8272ADS 3272535d602Swdenk 328cf946c6dSLei Wen- Marvell Family Member 329cf946c6dSLei Wen CONFIG_SYS_MVFS - define it if you want to enable 330cf946c6dSLei Wen multiple fs option at one time 331cf946c6dSLei Wen for marvell soc family 332cf946c6dSLei Wen 333c609719bSwdenk- MPC824X Family Member (if CONFIG_MPC824X is defined) 334c609719bSwdenk Define exactly one of 335c609719bSwdenk CONFIG_MPC8240, CONFIG_MPC8245 336c609719bSwdenk 33711ccc33fSMarcel Ziswiler- 8xx CPU Options: (if using an MPC8xx CPU) 33866ca92a5Swdenk CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if 33966ca92a5Swdenk get_gclk_freq() cannot work 3405da627a4Swdenk e.g. if there is no 32KHz 3415da627a4Swdenk reference PIT/RTC clock 34266ca92a5Swdenk CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK 34366ca92a5Swdenk or XTAL/EXTAL) 344c609719bSwdenk 34566ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU): 3466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8xx_CPUCLK_MIN 3476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8xx_CPUCLK_MAX 34866ca92a5Swdenk CONFIG_8xx_CPUCLK_DEFAULT 34975d1ea7fSwdenk See doc/README.MPC866 35075d1ea7fSwdenk 3516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MEASURE_CPUCLK 35275d1ea7fSwdenk 35375d1ea7fSwdenk Define this to measure the actual CPU clock instead 35475d1ea7fSwdenk of relying on the correctness of the configured 35575d1ea7fSwdenk values. Mostly useful for board bringup to make sure 35675d1ea7fSwdenk the PLL is locked at the intended frequency. Note 35775d1ea7fSwdenk that this requires a (stable) reference clock (32 kHz 3586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD RTC clock or CONFIG_SYS_8XX_XIN) 35975d1ea7fSwdenk 360506f3918SHeiko Schocher CONFIG_SYS_DELAYED_ICACHE 361506f3918SHeiko Schocher 362506f3918SHeiko Schocher Define this option if you want to enable the 363506f3918SHeiko Schocher ICache only when Code runs from RAM. 364506f3918SHeiko Schocher 36566412c63SKumar Gala- 85xx CPU Options: 36666412c63SKumar Gala CONFIG_SYS_FSL_TBCLK_DIV 36766412c63SKumar Gala 36866412c63SKumar Gala Defines the core time base clock divider ratio compared to the 36966412c63SKumar Gala system clock. On most PQ3 devices this is 8, on newer QorIQ 37066412c63SKumar Gala devices it can be 16 or 32. The ratio varies from SoC to Soc. 37166412c63SKumar Gala 3728f29084aSKumar Gala CONFIG_SYS_FSL_PCIE_COMPAT 3738f29084aSKumar Gala 3748f29084aSKumar Gala Defines the string to utilize when trying to match PCIe device 3758f29084aSKumar Gala tree nodes for the given platform. 3768f29084aSKumar Gala 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 423b67d8816SChristian Riesch- ARM options: 424b67d8816SChristian Riesch CONFIG_SYS_EXCEPTION_VECTORS_HIGH 425b67d8816SChristian Riesch 426b67d8816SChristian Riesch Select high exception vectors of the ARM core, e.g., do not 427b67d8816SChristian Riesch clear the V bit of the c1 register of CP15. 428b67d8816SChristian Riesch 4295da627a4Swdenk- Linux Kernel Interface: 430c609719bSwdenk CONFIG_CLOCKS_IN_MHZ 431c609719bSwdenk 432c609719bSwdenk U-Boot stores all clock information in Hz 433c609719bSwdenk internally. For binary compatibility with older Linux 434c609719bSwdenk kernels (which expect the clocks passed in the 435c609719bSwdenk bd_info data to be in MHz) the environment variable 436c609719bSwdenk "clocks_in_mhz" can be defined so that U-Boot 437c609719bSwdenk converts clock data to MHZ before passing it to the 438c609719bSwdenk Linux kernel. 439c609719bSwdenk When CONFIG_CLOCKS_IN_MHZ is defined, a definition of 440c609719bSwdenk "clocks_in_mhz=1" is automatically included in the 441c609719bSwdenk default environment. 442c609719bSwdenk 4435da627a4Swdenk CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only] 4445da627a4Swdenk 44511ccc33fSMarcel Ziswiler When transferring memsize parameter to linux, some versions 4465da627a4Swdenk expect it to be in bytes, others in MB. 4475da627a4Swdenk Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes. 4485da627a4Swdenk 449fec6d9eeSGerald Van Baren CONFIG_OF_LIBFDT 450f57f70aaSWolfgang Denk 451f57f70aaSWolfgang Denk New kernel versions are expecting firmware settings to be 452213bf8c8SGerald Van Baren passed using flattened device trees (based on open firmware 453213bf8c8SGerald Van Baren concepts). 454213bf8c8SGerald Van Baren 455213bf8c8SGerald Van Baren CONFIG_OF_LIBFDT 456213bf8c8SGerald Van Baren * New libfdt-based support 457213bf8c8SGerald Van Baren * Adds the "fdt" command 4583bb342fcSKim Phillips * The bootm command automatically updates the fdt 459213bf8c8SGerald Van Baren 460b55ae402SMarcel Ziswiler OF_CPU - The proper name of the cpus node (only required for 461b55ae402SMarcel Ziswiler MPC512X and MPC5xxx based boards). 462b55ae402SMarcel Ziswiler OF_SOC - The proper name of the soc node (only required for 463b55ae402SMarcel Ziswiler MPC512X and MPC5xxx based boards). 464f57f70aaSWolfgang Denk OF_TBCLK - The timebase frequency. 465c2871f03SKumar Gala OF_STDOUT_PATH - The path to the console device 466f57f70aaSWolfgang Denk 46711ccc33fSMarcel Ziswiler boards with QUICC Engines require OF_QE to set UCC MAC 46811ccc33fSMarcel Ziswiler addresses 4693bb342fcSKim Phillips 4704e253137SKumar Gala CONFIG_OF_BOARD_SETUP 4714e253137SKumar Gala 4724e253137SKumar Gala Board code has addition modification that it wants to make 4734e253137SKumar Gala to the flat device tree before handing it off to the kernel 4746705d81eSwdenk 4750267768eSMatthew McClintock CONFIG_OF_BOOT_CPU 4760267768eSMatthew McClintock 47711ccc33fSMarcel Ziswiler This define fills in the correct boot CPU in the boot 4780267768eSMatthew McClintock param header, the default value is zero if undefined. 4790267768eSMatthew McClintock 4803887c3fbSHeiko Schocher CONFIG_OF_IDE_FIXUP 4813887c3fbSHeiko Schocher 4823887c3fbSHeiko Schocher U-Boot can detect if an IDE device is present or not. 4833887c3fbSHeiko Schocher If not, and this new config option is activated, U-Boot 4843887c3fbSHeiko Schocher removes the ATA node from the DTS before booting Linux, 4853887c3fbSHeiko Schocher so the Linux IDE driver does not probe the device and 4863887c3fbSHeiko Schocher crash. This is needed for buggy hardware (uc101) where 4873887c3fbSHeiko Schocher no pull down resistor is connected to the signal IDE5V_DD7. 4883887c3fbSHeiko Schocher 4897eb29398SIgor Grinberg CONFIG_MACH_TYPE [relevant for ARM only][mandatory] 4907eb29398SIgor Grinberg 4917eb29398SIgor Grinberg This setting is mandatory for all boards that have only one 4927eb29398SIgor Grinberg machine type and must be used to specify the machine type 4937eb29398SIgor Grinberg number as it appears in the ARM machine registry 4947eb29398SIgor Grinberg (see http://www.arm.linux.org.uk/developer/machines/). 4957eb29398SIgor Grinberg Only boards that have multiple machine types supported 4967eb29398SIgor Grinberg in a single configuration file and the machine type is 4977eb29398SIgor Grinberg runtime discoverable, do not have to use this setting. 4987eb29398SIgor Grinberg 4990b2f4ecaSNiklaus Giger- vxWorks boot parameters: 5000b2f4ecaSNiklaus Giger 5010b2f4ecaSNiklaus Giger bootvx constructs a valid bootline using the following 5020b2f4ecaSNiklaus Giger environments variables: bootfile, ipaddr, serverip, hostname. 5030b2f4ecaSNiklaus Giger It loads the vxWorks image pointed bootfile. 5040b2f4ecaSNiklaus Giger 5050b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name 5060b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address 5070b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server 5080b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters 5090b2f4ecaSNiklaus Giger 5100b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_ADD_PARAMS 5110b2f4ecaSNiklaus Giger 5120b2f4ecaSNiklaus Giger Add it at the end of the bootline. E.g "u=username pw=secret" 5130b2f4ecaSNiklaus Giger 5140b2f4ecaSNiklaus Giger Note: If a "bootargs" environment is defined, it will overwride 5150b2f4ecaSNiklaus Giger the defaults discussed just above. 5160b2f4ecaSNiklaus Giger 5172c451f78SAneesh V- Cache Configuration: 5182c451f78SAneesh V CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot 5192c451f78SAneesh V CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot 5202c451f78SAneesh V CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot 5212c451f78SAneesh V 52293bc2193SAneesh V- Cache Configuration for ARM: 52393bc2193SAneesh V CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache 52493bc2193SAneesh V controller 52593bc2193SAneesh V CONFIG_SYS_PL310_BASE - Physical base address of PL310 52693bc2193SAneesh V controller register space 52793bc2193SAneesh V 5286705d81eSwdenk- Serial Ports: 52948d0192fSAndreas Engel CONFIG_PL010_SERIAL 5306705d81eSwdenk 5316705d81eSwdenk Define this if you want support for Amba PrimeCell PL010 UARTs. 5326705d81eSwdenk 53348d0192fSAndreas Engel CONFIG_PL011_SERIAL 5346705d81eSwdenk 5356705d81eSwdenk Define this if you want support for Amba PrimeCell PL011 UARTs. 5366705d81eSwdenk 5376705d81eSwdenk CONFIG_PL011_CLOCK 5386705d81eSwdenk 5396705d81eSwdenk If you have Amba PrimeCell PL011 UARTs, set this variable to 5406705d81eSwdenk the clock speed of the UARTs. 5416705d81eSwdenk 5426705d81eSwdenk CONFIG_PL01x_PORTS 5436705d81eSwdenk 5446705d81eSwdenk If you have Amba PrimeCell PL010 or PL011 UARTs on your board, 5456705d81eSwdenk define this to a list of base addresses for each (supported) 5466705d81eSwdenk port. See e.g. include/configs/versatile.h 5476705d81eSwdenk 548910f1ae3SJohn Rigby CONFIG_PL011_SERIAL_RLCR 549910f1ae3SJohn Rigby 550910f1ae3SJohn Rigby Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500) 551910f1ae3SJohn Rigby have separate receive and transmit line control registers. Set 552910f1ae3SJohn Rigby this variable to initialize the extra register. 553910f1ae3SJohn Rigby 554910f1ae3SJohn Rigby CONFIG_PL011_SERIAL_FLUSH_ON_INIT 555910f1ae3SJohn Rigby 556910f1ae3SJohn Rigby On some platforms (e.g. U8500) U-Boot is loaded by a second stage 557910f1ae3SJohn Rigby boot loader that has already initialized the UART. Define this 558910f1ae3SJohn Rigby variable to flush the UART at init time. 559910f1ae3SJohn Rigby 5606705d81eSwdenk 561c609719bSwdenk- Console Interface: 562c609719bSwdenk Depending on board, define exactly one serial port 563c609719bSwdenk (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2, 564c609719bSwdenk CONFIG_8xx_CONS_SCC1, ...), or switch off the serial 565c609719bSwdenk console by defining CONFIG_8xx_CONS_NONE 566c609719bSwdenk 567c609719bSwdenk Note: if CONFIG_8xx_CONS_NONE is defined, the serial 568c609719bSwdenk port routines must be defined elsewhere 569c609719bSwdenk (i.e. serial_init(), serial_getc(), ...) 570c609719bSwdenk 571c609719bSwdenk CONFIG_CFB_CONSOLE 572c609719bSwdenk Enables console device for a color framebuffer. Needs following 573c53043b7SWolfgang Denk defines (cf. smiLynxEM, i8042) 574c609719bSwdenk VIDEO_FB_LITTLE_ENDIAN graphic memory organisation 575c609719bSwdenk (default big endian) 576c609719bSwdenk VIDEO_HW_RECTFILL graphic chip supports 577c609719bSwdenk rectangle fill 578c609719bSwdenk (cf. smiLynxEM) 579c609719bSwdenk VIDEO_HW_BITBLT graphic chip supports 580c609719bSwdenk bit-blit (cf. smiLynxEM) 581c609719bSwdenk VIDEO_VISIBLE_COLS visible pixel columns 582c609719bSwdenk (cols=pitch) 583c609719bSwdenk VIDEO_VISIBLE_ROWS visible pixel rows 584c609719bSwdenk VIDEO_PIXEL_SIZE bytes per pixel 585c609719bSwdenk VIDEO_DATA_FORMAT graphic data format 586c609719bSwdenk (0-5, cf. cfb_console.c) 587c609719bSwdenk VIDEO_FB_ADRS framebuffer address 588c609719bSwdenk VIDEO_KBD_INIT_FCT keyboard int fct 589c609719bSwdenk (i.e. i8042_kbd_init()) 590c609719bSwdenk VIDEO_TSTC_FCT test char fct 591c609719bSwdenk (i.e. i8042_tstc) 592c609719bSwdenk VIDEO_GETC_FCT get char fct 593c609719bSwdenk (i.e. i8042_getc) 594c609719bSwdenk CONFIG_CONSOLE_CURSOR cursor drawing on/off 595c609719bSwdenk (requires blink timer 596c609719bSwdenk cf. i8042.c) 5976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c) 598c609719bSwdenk CONFIG_CONSOLE_TIME display time/date info in 599c609719bSwdenk upper right corner 600602ad3b3SJon Loeliger (requires CONFIG_CMD_DATE) 601c609719bSwdenk CONFIG_VIDEO_LOGO display Linux logo in 602c609719bSwdenk upper left corner 603a6c7ad2fSwdenk CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of 604a6c7ad2fSwdenk linux_logo.h for logo. 605a6c7ad2fSwdenk Requires CONFIG_VIDEO_LOGO 606c609719bSwdenk CONFIG_CONSOLE_EXTRA_INFO 60711ccc33fSMarcel Ziswiler additional board info beside 608c609719bSwdenk the logo 609c609719bSwdenk 610c609719bSwdenk When CONFIG_CFB_CONSOLE is defined, video console is 611c609719bSwdenk default i/o. Serial console can be forced with 612c609719bSwdenk environment 'console=serial'. 613c609719bSwdenk 614a3ad8e26Swdenk When CONFIG_SILENT_CONSOLE is defined, all console 615a3ad8e26Swdenk messages (by U-Boot and Linux!) can be silenced with 616a3ad8e26Swdenk the "silent" environment variable. See 617a3ad8e26Swdenk doc/README.silent for more information. 618a3ad8e26Swdenk 619c609719bSwdenk- Console Baudrate: 620c609719bSwdenk CONFIG_BAUDRATE - in bps 621c609719bSwdenk Select one of the baudrates listed in 6226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BAUDRATE_TABLE, see below. 6236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale 624c609719bSwdenk 625c92fac91SHeiko Schocher- Console Rx buffer length 626c92fac91SHeiko Schocher With CONFIG_SYS_SMC_RXBUFLEN it is possible to define 627c92fac91SHeiko Schocher the maximum receive buffer length for the SMC. 6282b3f12c2SHeiko Schocher This option is actual only for 82xx and 8xx possible. 629c92fac91SHeiko Schocher If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE 630c92fac91SHeiko Schocher must be defined, to setup the maximum idle timeout for 631c92fac91SHeiko Schocher the SMC. 632c92fac91SHeiko Schocher 6339558b48aSGraeme Russ- Pre-Console Buffer: 6349558b48aSGraeme Russ Prior to the console being initialised (i.e. serial UART 6359558b48aSGraeme Russ initialised etc) all console output is silently discarded. 6369558b48aSGraeme Russ Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to 6379558b48aSGraeme Russ buffer any console messages prior to the console being 6389558b48aSGraeme Russ initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ 6399558b48aSGraeme Russ bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is 6409558b48aSGraeme Russ a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ 6419558b48aSGraeme Russ bytes are output before the console is initialised, the 6429558b48aSGraeme Russ earlier bytes are discarded. 6439558b48aSGraeme Russ 6449558b48aSGraeme Russ 'Sane' compilers will generate smaller code if 6459558b48aSGraeme Russ CONFIG_PRE_CON_BUF_SZ is a power of 2 6469558b48aSGraeme Russ 647046a37bdSSonny Rao- Safe printf() functions 648046a37bdSSonny Rao Define CONFIG_SYS_VSNPRINTF to compile in safe versions of 649046a37bdSSonny Rao the printf() functions. These are defined in 650046a37bdSSonny Rao include/vsprintf.h and include snprintf(), vsnprintf() and 651046a37bdSSonny Rao so on. Code size increase is approximately 300-500 bytes. 652046a37bdSSonny Rao If this option is not given then these functions will 653046a37bdSSonny Rao silently discard their buffer size argument - this means 654046a37bdSSonny Rao you are not getting any overflow checking in this case. 655046a37bdSSonny Rao 656c609719bSwdenk- Boot Delay: CONFIG_BOOTDELAY - in seconds 657c609719bSwdenk Delay before automatically booting the default image; 658c609719bSwdenk set to -1 to disable autoboot. 659c609719bSwdenk 660c609719bSwdenk See doc/README.autoboot for these options that 661c609719bSwdenk work with CONFIG_BOOTDELAY. None are required. 662c609719bSwdenk CONFIG_BOOT_RETRY_TIME 663c609719bSwdenk CONFIG_BOOT_RETRY_MIN 664c609719bSwdenk CONFIG_AUTOBOOT_KEYED 665c609719bSwdenk CONFIG_AUTOBOOT_PROMPT 666c609719bSwdenk CONFIG_AUTOBOOT_DELAY_STR 667c609719bSwdenk CONFIG_AUTOBOOT_STOP_STR 668c609719bSwdenk CONFIG_AUTOBOOT_DELAY_STR2 669c609719bSwdenk CONFIG_AUTOBOOT_STOP_STR2 670c609719bSwdenk CONFIG_ZERO_BOOTDELAY_CHECK 671c609719bSwdenk CONFIG_RESET_TO_RETRY 672c609719bSwdenk 673c609719bSwdenk- Autoboot Command: 674c609719bSwdenk CONFIG_BOOTCOMMAND 675c609719bSwdenk Only needed when CONFIG_BOOTDELAY is enabled; 676c609719bSwdenk define a command string that is automatically executed 677c609719bSwdenk when no character is read on the console interface 678c609719bSwdenk within "Boot Delay" after reset. 679c609719bSwdenk 680c609719bSwdenk CONFIG_BOOTARGS 681c609719bSwdenk This can be used to pass arguments to the bootm 682c609719bSwdenk command. The value of CONFIG_BOOTARGS goes into the 683c609719bSwdenk environment value "bootargs". 684c609719bSwdenk 685c609719bSwdenk CONFIG_RAMBOOT and CONFIG_NFSBOOT 686c609719bSwdenk The value of these goes into the environment as 687c609719bSwdenk "ramboot" and "nfsboot" respectively, and can be used 688c609719bSwdenk as a convenience, when switching between booting from 68911ccc33fSMarcel Ziswiler RAM and NFS. 690c609719bSwdenk 691c609719bSwdenk- Pre-Boot Commands: 692c609719bSwdenk CONFIG_PREBOOT 693c609719bSwdenk 694c609719bSwdenk When this option is #defined, the existence of the 695c609719bSwdenk environment variable "preboot" will be checked 696c609719bSwdenk immediately before starting the CONFIG_BOOTDELAY 697c609719bSwdenk countdown and/or running the auto-boot command resp. 698c609719bSwdenk entering interactive mode. 699c609719bSwdenk 700c609719bSwdenk This feature is especially useful when "preboot" is 701c609719bSwdenk automatically generated or modified. For an example 702c609719bSwdenk see the LWMON board specific code: here "preboot" is 703c609719bSwdenk modified when the user holds down a certain 704c609719bSwdenk combination of keys on the (special) keyboard when 705c609719bSwdenk booting the systems 706c609719bSwdenk 707c609719bSwdenk- Serial Download Echo Mode: 708c609719bSwdenk CONFIG_LOADS_ECHO 709c609719bSwdenk If defined to 1, all characters received during a 710c609719bSwdenk serial download (using the "loads" command) are 711c609719bSwdenk echoed back. This might be needed by some terminal 712c609719bSwdenk emulations (like "cu"), but may as well just take 713c609719bSwdenk time on others. This setting #define's the initial 714c609719bSwdenk value of the "loads_echo" environment variable. 715c609719bSwdenk 716602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined) 717c609719bSwdenk CONFIG_KGDB_BAUDRATE 718c609719bSwdenk Select one of the baudrates listed in 7196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BAUDRATE_TABLE, see below. 720c609719bSwdenk 721c609719bSwdenk- Monitor Functions: 722602ad3b3SJon Loeliger Monitor commands can be included or excluded 723602ad3b3SJon Loeliger from the build by using the #include files 724602ad3b3SJon Loeliger "config_cmd_all.h" and #undef'ing unwanted 725602ad3b3SJon Loeliger commands, or using "config_cmd_default.h" 726602ad3b3SJon Loeliger and augmenting with additional #define's 727602ad3b3SJon Loeliger for wanted commands. 728c609719bSwdenk 729602ad3b3SJon Loeliger The default command configuration includes all commands 730602ad3b3SJon Loeliger except those marked below with a "*". 731602ad3b3SJon Loeliger 732602ad3b3SJon Loeliger CONFIG_CMD_ASKENV * ask for env variable 733602ad3b3SJon Loeliger CONFIG_CMD_BDI bdinfo 734602ad3b3SJon Loeliger CONFIG_CMD_BEDBUG * Include BedBug Debugger 735602ad3b3SJon Loeliger CONFIG_CMD_BMP * BMP support 736602ad3b3SJon Loeliger CONFIG_CMD_BSP * Board specific commands 737602ad3b3SJon Loeliger CONFIG_CMD_BOOTD bootd 738602ad3b3SJon Loeliger CONFIG_CMD_CACHE * icache, dcache 739602ad3b3SJon Loeliger CONFIG_CMD_CONSOLE coninfo 740710b9938SMike Frysinger CONFIG_CMD_CRC32 * crc32 741602ad3b3SJon Loeliger CONFIG_CMD_DATE * support for RTC, date/time... 742602ad3b3SJon Loeliger CONFIG_CMD_DHCP * DHCP support 743602ad3b3SJon Loeliger CONFIG_CMD_DIAG * Diagnostics 744a7c93104SPeter Tyser CONFIG_CMD_DS4510 * ds4510 I2C gpio commands 745a7c93104SPeter Tyser CONFIG_CMD_DS4510_INFO * ds4510 I2C info command 746a7c93104SPeter Tyser CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd 747a7c93104SPeter Tyser CONFIG_CMD_DS4510_RST * ds4510 I2C rst command 748602ad3b3SJon Loeliger CONFIG_CMD_DTT * Digital Therm and Thermostat 749602ad3b3SJon Loeliger CONFIG_CMD_ECHO echo arguments 750246c6922SPeter Tyser CONFIG_CMD_EDITENV edit env variable 751602ad3b3SJon Loeliger CONFIG_CMD_EEPROM * EEPROM read/write support 752602ad3b3SJon Loeliger CONFIG_CMD_ELF * bootelf, bootvx 7530c79cda0SMike Frysinger CONFIG_CMD_EXPORTENV * export the environment 754bdab39d3SMike Frysinger CONFIG_CMD_SAVEENV saveenv 755602ad3b3SJon Loeliger CONFIG_CMD_FDC * Floppy Disk Support 756602ad3b3SJon Loeliger CONFIG_CMD_FAT * FAT partition support 757602ad3b3SJon Loeliger CONFIG_CMD_FDOS * Dos diskette Support 758602ad3b3SJon Loeliger CONFIG_CMD_FLASH flinfo, erase, protect 759602ad3b3SJon Loeliger CONFIG_CMD_FPGA FPGA device initialization support 760a641b979SMike Frysinger CONFIG_CMD_GO * the 'go' command (exec code) 761a000b795SKim Phillips CONFIG_CMD_GREPENV * search environment 762602ad3b3SJon Loeliger CONFIG_CMD_HWFLOW * RTS/CTS hw flow control 763602ad3b3SJon Loeliger CONFIG_CMD_I2C * I2C serial bus support 764602ad3b3SJon Loeliger CONFIG_CMD_IDE * IDE harddisk support 765602ad3b3SJon Loeliger CONFIG_CMD_IMI iminfo 766602ad3b3SJon Loeliger CONFIG_CMD_IMLS List all found images 767602ad3b3SJon Loeliger CONFIG_CMD_IMMAP * IMMR dump support 7680c79cda0SMike Frysinger CONFIG_CMD_IMPORTENV * import an environment 769602ad3b3SJon Loeliger CONFIG_CMD_IRQ * irqinfo 770602ad3b3SJon Loeliger CONFIG_CMD_ITEST Integer/string test of 2 values 771602ad3b3SJon Loeliger CONFIG_CMD_JFFS2 * JFFS2 Support 772602ad3b3SJon Loeliger CONFIG_CMD_KGDB * kgdb 7731ba7fd25SMike Frysinger CONFIG_CMD_LDRINFO ldrinfo (display Blackfin loader) 774602ad3b3SJon Loeliger CONFIG_CMD_LOADB loadb 775602ad3b3SJon Loeliger CONFIG_CMD_LOADS loads 77602c9aa1dSRobin Getz CONFIG_CMD_MD5SUM print md5 message digest 77702c9aa1dSRobin Getz (requires CONFIG_CMD_MEMORY and CONFIG_MD5) 778602ad3b3SJon Loeliger CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base, 77956523f12Swdenk loop, loopw, mtest 780602ad3b3SJon Loeliger CONFIG_CMD_MISC Misc functions like sleep etc 781602ad3b3SJon Loeliger CONFIG_CMD_MMC * MMC memory mapped support 782602ad3b3SJon Loeliger CONFIG_CMD_MII * MII utility commands 78368d7d651SStefan Roese CONFIG_CMD_MTDPARTS * MTD partition support 784602ad3b3SJon Loeliger CONFIG_CMD_NAND * NAND support 785602ad3b3SJon Loeliger CONFIG_CMD_NET bootp, tftpboot, rarpboot 786e92739d3SPeter Tyser CONFIG_CMD_PCA953X * PCA953x I2C gpio commands 787e92739d3SPeter Tyser CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command 788602ad3b3SJon Loeliger CONFIG_CMD_PCI * pciinfo 789602ad3b3SJon Loeliger CONFIG_CMD_PCMCIA * PCMCIA support 790602ad3b3SJon Loeliger CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network 791602ad3b3SJon Loeliger host 792602ad3b3SJon Loeliger CONFIG_CMD_PORTIO * Port I/O 793602ad3b3SJon Loeliger CONFIG_CMD_REGINFO * Register dump 794602ad3b3SJon Loeliger CONFIG_CMD_RUN run command in env variable 795602ad3b3SJon Loeliger CONFIG_CMD_SAVES * save S record dump 796602ad3b3SJon Loeliger CONFIG_CMD_SCSI * SCSI Support 797602ad3b3SJon Loeliger CONFIG_CMD_SDRAM * print SDRAM configuration information 798602ad3b3SJon Loeliger (requires CONFIG_CMD_I2C) 799602ad3b3SJon Loeliger CONFIG_CMD_SETGETDCR Support for DCR Register access 800602ad3b3SJon Loeliger (4xx only) 801f61ec45eSEric Nelson CONFIG_CMD_SF * Read/write/erase SPI NOR flash 802c6b1ee66SAlexander Holler CONFIG_CMD_SHA1SUM print sha1 memory digest 80302c9aa1dSRobin Getz (requires CONFIG_CMD_MEMORY) 80474de7aefSWolfgang Denk CONFIG_CMD_SOURCE "source" command Support 805602ad3b3SJon Loeliger CONFIG_CMD_SPI * SPI serial bus support 8067a83af07SLuca Ceresoli CONFIG_CMD_TFTPSRV * TFTP transfer in server mode 8071fb7cd49SSimon Glass CONFIG_CMD_TFTPPUT * TFTP put command (upload) 808ca366d0eSChe-liang Chiou CONFIG_CMD_TIME * run command and report execution time 809602ad3b3SJon Loeliger CONFIG_CMD_USB * USB support 810602ad3b3SJon Loeliger CONFIG_CMD_CDP * Cisco Discover Protocol support 811602ad3b3SJon Loeliger CONFIG_CMD_FSL * Microblaze FSL support 812c609719bSwdenk 813c609719bSwdenk 814c609719bSwdenk EXAMPLE: If you want all functions except of network 815c609719bSwdenk support you can write: 816c609719bSwdenk 817602ad3b3SJon Loeliger #include "config_cmd_all.h" 818602ad3b3SJon Loeliger #undef CONFIG_CMD_NET 819c609719bSwdenk 820213bf8c8SGerald Van Baren Other Commands: 821213bf8c8SGerald Van Baren fdt (flattened device tree) command: CONFIG_OF_LIBFDT 822c609719bSwdenk 823c609719bSwdenk Note: Don't enable the "icache" and "dcache" commands 824602ad3b3SJon Loeliger (configuration option CONFIG_CMD_CACHE) unless you know 825c609719bSwdenk what you (and your U-Boot users) are doing. Data 826c609719bSwdenk cache cannot be enabled on systems like the 8xx or 827c609719bSwdenk 8260 (where accesses to the IMMR region must be 828c609719bSwdenk uncached), and it cannot be disabled on all other 829c609719bSwdenk systems where we (mis-) use the data cache to hold an 830c609719bSwdenk initial stack and some data. 831c609719bSwdenk 832c609719bSwdenk 833c609719bSwdenk XXX - this list needs to get updated! 834c609719bSwdenk 83545ba8077SSimon Glass- Device tree: 83645ba8077SSimon Glass CONFIG_OF_CONTROL 83745ba8077SSimon Glass If this variable is defined, U-Boot will use a device tree 83845ba8077SSimon Glass to configure its devices, instead of relying on statically 83945ba8077SSimon Glass compiled #defines in the board file. This option is 84045ba8077SSimon Glass experimental and only available on a few boards. The device 84145ba8077SSimon Glass tree is available in the global data as gd->fdt_blob. 84245ba8077SSimon Glass 8432c0f79e4SSimon Glass U-Boot needs to get its device tree from somewhere. This can 8442c0f79e4SSimon Glass be done using one of the two options below: 845bbb0b128SSimon Glass 846bbb0b128SSimon Glass CONFIG_OF_EMBED 847bbb0b128SSimon Glass If this variable is defined, U-Boot will embed a device tree 848bbb0b128SSimon Glass binary in its image. This device tree file should be in the 849bbb0b128SSimon Glass board directory and called <soc>-<board>.dts. The binary file 850bbb0b128SSimon Glass is then picked up in board_init_f() and made available through 851bbb0b128SSimon Glass the global data structure as gd->blob. 85245ba8077SSimon Glass 8532c0f79e4SSimon Glass CONFIG_OF_SEPARATE 8542c0f79e4SSimon Glass If this variable is defined, U-Boot will build a device tree 8552c0f79e4SSimon Glass binary. It will be called u-boot.dtb. Architecture-specific 8562c0f79e4SSimon Glass code will locate it at run-time. Generally this works by: 8572c0f79e4SSimon Glass 8582c0f79e4SSimon Glass cat u-boot.bin u-boot.dtb >image.bin 8592c0f79e4SSimon Glass 8602c0f79e4SSimon Glass and in fact, U-Boot does this for you, creating a file called 8612c0f79e4SSimon Glass u-boot-dtb.bin which is useful in the common case. You can 8622c0f79e4SSimon Glass still use the individual files if you need something more 8632c0f79e4SSimon Glass exotic. 8642c0f79e4SSimon Glass 865c609719bSwdenk- Watchdog: 866c609719bSwdenk CONFIG_WATCHDOG 867c609719bSwdenk If this variable is defined, it enables watchdog 8686abe6fb6SDetlev Zundel support for the SoC. There must be support in the SoC 8696abe6fb6SDetlev Zundel specific code for a watchdog. For the 8xx and 8260 8706abe6fb6SDetlev Zundel CPUs, the SIU Watchdog feature is enabled in the SYPCR 8716abe6fb6SDetlev Zundel register. When supported for a specific SoC is 8726abe6fb6SDetlev Zundel available, then no further board specific code should 8736abe6fb6SDetlev Zundel be needed to use it. 8746abe6fb6SDetlev Zundel 8756abe6fb6SDetlev Zundel CONFIG_HW_WATCHDOG 8766abe6fb6SDetlev Zundel When using a watchdog circuitry external to the used 8776abe6fb6SDetlev Zundel SoC, then define this variable and provide board 8786abe6fb6SDetlev Zundel specific code for the "hw_watchdog_reset" function. 879c609719bSwdenk 880c1551ea8Sstroese- U-Boot Version: 881c1551ea8Sstroese CONFIG_VERSION_VARIABLE 882c1551ea8Sstroese If this variable is defined, an environment variable 883c1551ea8Sstroese named "ver" is created by U-Boot showing the U-Boot 884c1551ea8Sstroese version as printed by the "version" command. 885c1551ea8Sstroese This variable is readonly. 886c1551ea8Sstroese 887c609719bSwdenk- Real-Time Clock: 888c609719bSwdenk 889602ad3b3SJon Loeliger When CONFIG_CMD_DATE is selected, the type of the RTC 890c609719bSwdenk has to be selected, too. Define exactly one of the 891c609719bSwdenk following options: 892c609719bSwdenk 893c609719bSwdenk CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx 894c609719bSwdenk CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC 8954e8b7544SFabio Estevam CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC 896c609719bSwdenk CONFIG_RTC_MC146818 - use MC146818 RTC 8971cb8e980Swdenk CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC 898c609719bSwdenk CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC 8997f70e853Swdenk CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC 9003bac3513Swdenk CONFIG_RTC_DS164x - use Dallas DS164x RTC 9019536dfccSTor Krill CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC 9024c0d4c3bSwdenk CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC 9036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337 90471d19f30SHeiko Schocher CONFIG_SYS_RV3029_TCR - enable trickle charger on 90571d19f30SHeiko Schocher RV3029 RTC. 906c609719bSwdenk 907b37c7e5eSwdenk Note that if the RTC uses I2C, then the I2C interface 908b37c7e5eSwdenk must also be configured. See I2C Support, below. 909b37c7e5eSwdenk 910e92739d3SPeter Tyser- GPIO Support: 911e92739d3SPeter Tyser CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO 912e92739d3SPeter Tyser CONFIG_PCA953X_INFO - enable pca953x info command 913e92739d3SPeter Tyser 9145dec49caSChris Packham The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of 9155dec49caSChris Packham chip-ngpio pairs that tell the PCA953X driver the number of 9165dec49caSChris Packham pins supported by a particular chip. 9175dec49caSChris Packham 918e92739d3SPeter Tyser Note that if the GPIO device uses I2C, then the I2C interface 919e92739d3SPeter Tyser must also be configured. See I2C Support, below. 920e92739d3SPeter Tyser 921c609719bSwdenk- Timestamp Support: 922c609719bSwdenk 923c609719bSwdenk When CONFIG_TIMESTAMP is selected, the timestamp 924c609719bSwdenk (date and time) of an image is printed by image 925c609719bSwdenk commands like bootm or iminfo. This option is 926602ad3b3SJon Loeliger automatically enabled when you select CONFIG_CMD_DATE . 927c609719bSwdenk 928c609719bSwdenk- Partition Support: 929c609719bSwdenk CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION 93007f3d789Srichardretanubun and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION 931c609719bSwdenk 932602ad3b3SJon Loeliger If IDE or SCSI support is enabled (CONFIG_CMD_IDE or 933218ca724SWolfgang Denk CONFIG_CMD_SCSI) you must configure support for at 934218ca724SWolfgang Denk least one partition type as well. 935c609719bSwdenk 936c609719bSwdenk- IDE Reset method: 9374d13cbadSwdenk CONFIG_IDE_RESET_ROUTINE - this is defined in several 9384d13cbadSwdenk board configurations files but used nowhere! 939c609719bSwdenk 9404d13cbadSwdenk CONFIG_IDE_RESET - is this is defined, IDE Reset will 9414d13cbadSwdenk be performed by calling the function 9424d13cbadSwdenk ide_set_reset(int reset) 9434d13cbadSwdenk which has to be defined in a board specific file 944c609719bSwdenk 945c609719bSwdenk- ATAPI Support: 946c609719bSwdenk CONFIG_ATAPI 947c609719bSwdenk 948c609719bSwdenk Set this to enable ATAPI support. 949c609719bSwdenk 950c40b2956Swdenk- LBA48 Support 951c40b2956Swdenk CONFIG_LBA48 952c40b2956Swdenk 953c40b2956Swdenk Set this to enable support for disks larger than 137GB 9544b142febSHeiko Schocher Also look at CONFIG_SYS_64BIT_LBA. 955c40b2956Swdenk Whithout these , LBA48 support uses 32bit variables and will 'only' 956c40b2956Swdenk support disks up to 2.1TB. 957c40b2956Swdenk 9586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_64BIT_LBA: 959c40b2956Swdenk When enabled, makes the IDE subsystem use 64bit sector addresses. 960c40b2956Swdenk Default is 32bit. 961c40b2956Swdenk 962c609719bSwdenk- SCSI Support: 963c609719bSwdenk At the moment only there is only support for the 964c609719bSwdenk SYM53C8XX SCSI controller; define 965c609719bSwdenk CONFIG_SCSI_SYM53C8XX to enable it. 966c609719bSwdenk 9676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and 9686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID * 9696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the 970c609719bSwdenk maximum numbers of LUNs, SCSI ID's and target 971c609719bSwdenk devices. 9726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz) 973c609719bSwdenk 974c609719bSwdenk- NETWORK Support (PCI): 975682011ffSwdenk CONFIG_E1000 976ce5207e1SKyle Moffett Support for Intel 8254x/8257x gigabit chips. 977ce5207e1SKyle Moffett 978ce5207e1SKyle Moffett CONFIG_E1000_SPI 979ce5207e1SKyle Moffett Utility code for direct access to the SPI bus on Intel 8257x. 980ce5207e1SKyle Moffett This does not do anything useful unless you set at least one 981ce5207e1SKyle Moffett of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC. 982ce5207e1SKyle Moffett 983ce5207e1SKyle Moffett CONFIG_E1000_SPI_GENERIC 984ce5207e1SKyle Moffett Allow generic access to the SPI bus on the Intel 8257x, for 985ce5207e1SKyle Moffett example with the "sspi" command. 986ce5207e1SKyle Moffett 987ce5207e1SKyle Moffett CONFIG_CMD_E1000 988ce5207e1SKyle Moffett Management command for E1000 devices. When used on devices 989ce5207e1SKyle Moffett with SPI support you can reprogram the EEPROM from U-Boot. 990682011ffSwdenk 991ac3315c2SAndre Schwarz CONFIG_E1000_FALLBACK_MAC 99211ccc33fSMarcel Ziswiler default MAC for empty EEPROM after production. 993ac3315c2SAndre Schwarz 994c609719bSwdenk CONFIG_EEPRO100 995c609719bSwdenk Support for Intel 82557/82559/82559ER chips. 99611ccc33fSMarcel Ziswiler Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM 997c609719bSwdenk write routine for first time initialisation. 998c609719bSwdenk 999c609719bSwdenk CONFIG_TULIP 1000c609719bSwdenk Support for Digital 2114x chips. 1001c609719bSwdenk Optional CONFIG_TULIP_SELECT_MEDIA for board specific 1002c609719bSwdenk modem chip initialisation (KS8761/QS6611). 1003c609719bSwdenk 1004c609719bSwdenk CONFIG_NATSEMI 1005c609719bSwdenk Support for National dp83815 chips. 1006c609719bSwdenk 1007c609719bSwdenk CONFIG_NS8382X 1008c609719bSwdenk Support for National dp8382[01] gigabit chips. 1009c609719bSwdenk 101045219c46Swdenk- NETWORK Support (other): 101145219c46Swdenk 1012c041e9d2SJens Scharsig CONFIG_DRIVER_AT91EMAC 1013c041e9d2SJens Scharsig Support for AT91RM9200 EMAC. 1014c041e9d2SJens Scharsig 1015c041e9d2SJens Scharsig CONFIG_RMII 1016c041e9d2SJens Scharsig Define this to use reduced MII inteface 1017c041e9d2SJens Scharsig 1018c041e9d2SJens Scharsig CONFIG_DRIVER_AT91EMAC_QUIET 1019c041e9d2SJens Scharsig If this defined, the driver is quiet. 1020c041e9d2SJens Scharsig The driver doen't show link status messages. 1021c041e9d2SJens Scharsig 1022efdd7319SRob Herring CONFIG_CALXEDA_XGMAC 1023efdd7319SRob Herring Support for the Calxeda XGMAC device 1024efdd7319SRob Herring 102545219c46Swdenk CONFIG_DRIVER_LAN91C96 102645219c46Swdenk Support for SMSC's LAN91C96 chips. 102745219c46Swdenk 102845219c46Swdenk CONFIG_LAN91C96_BASE 102945219c46Swdenk Define this to hold the physical address 103045219c46Swdenk of the LAN91C96's I/O space 103145219c46Swdenk 103245219c46Swdenk CONFIG_LAN91C96_USE_32_BIT 103345219c46Swdenk Define this to enable 32 bit addressing 103445219c46Swdenk 1035f39748aeSwdenk CONFIG_DRIVER_SMC91111 1036f39748aeSwdenk Support for SMSC's LAN91C111 chip 1037f39748aeSwdenk 1038f39748aeSwdenk CONFIG_SMC91111_BASE 1039f39748aeSwdenk Define this to hold the physical address 1040f39748aeSwdenk of the device (I/O space) 1041f39748aeSwdenk 1042f39748aeSwdenk CONFIG_SMC_USE_32_BIT 1043f39748aeSwdenk Define this if data bus is 32 bits 1044f39748aeSwdenk 1045f39748aeSwdenk CONFIG_SMC_USE_IOFUNCS 1046f39748aeSwdenk Define this to use i/o functions instead of macros 1047f39748aeSwdenk (some hardware wont work with macros) 1048f39748aeSwdenk 1049dc02badaSHeiko Schocher CONFIG_DRIVER_TI_EMAC 1050dc02badaSHeiko Schocher Support for davinci emac 1051dc02badaSHeiko Schocher 1052dc02badaSHeiko Schocher CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT 1053dc02badaSHeiko Schocher Define this if you have more then 3 PHYs. 1054dc02badaSHeiko Schocher 1055b3dbf4a5SMacpaul Lin CONFIG_FTGMAC100 1056b3dbf4a5SMacpaul Lin Support for Faraday's FTGMAC100 Gigabit SoC Ethernet 1057b3dbf4a5SMacpaul Lin 1058b3dbf4a5SMacpaul Lin CONFIG_FTGMAC100_EGIGA 1059b3dbf4a5SMacpaul Lin Define this to use GE link update with gigabit PHY. 1060b3dbf4a5SMacpaul Lin Define this if FTGMAC100 is connected to gigabit PHY. 1061b3dbf4a5SMacpaul Lin If your system has 10/100 PHY only, it might not occur 1062b3dbf4a5SMacpaul Lin wrong behavior. Because PHY usually return timeout or 1063b3dbf4a5SMacpaul Lin useless data when polling gigabit status and gigabit 1064b3dbf4a5SMacpaul Lin control registers. This behavior won't affect the 1065b3dbf4a5SMacpaul Lin correctnessof 10/100 link speed update. 1066b3dbf4a5SMacpaul Lin 1067c2fff331SMike Rapoport CONFIG_SMC911X 1068557b377dSJens Gehrlein Support for SMSC's LAN911x and LAN921x chips 1069557b377dSJens Gehrlein 1070c2fff331SMike Rapoport CONFIG_SMC911X_BASE 1071557b377dSJens Gehrlein Define this to hold the physical address 1072557b377dSJens Gehrlein of the device (I/O space) 1073557b377dSJens Gehrlein 1074c2fff331SMike Rapoport CONFIG_SMC911X_32_BIT 1075557b377dSJens Gehrlein Define this if data bus is 32 bits 1076557b377dSJens Gehrlein 1077c2fff331SMike Rapoport CONFIG_SMC911X_16_BIT 1078557b377dSJens Gehrlein Define this if data bus is 16 bits. If your processor 1079557b377dSJens Gehrlein automatically converts one 32 bit word to two 16 bit 1080c2fff331SMike Rapoport words you may also try CONFIG_SMC911X_32_BIT. 1081557b377dSJens Gehrlein 10823d0075faSYoshihiro Shimoda CONFIG_SH_ETHER 10833d0075faSYoshihiro Shimoda Support for Renesas on-chip Ethernet controller 10843d0075faSYoshihiro Shimoda 10853d0075faSYoshihiro Shimoda CONFIG_SH_ETHER_USE_PORT 10863d0075faSYoshihiro Shimoda Define the number of ports to be used 10873d0075faSYoshihiro Shimoda 10883d0075faSYoshihiro Shimoda CONFIG_SH_ETHER_PHY_ADDR 10893d0075faSYoshihiro Shimoda Define the ETH PHY's address 10903d0075faSYoshihiro Shimoda 109168260aabSYoshihiro Shimoda CONFIG_SH_ETHER_CACHE_WRITEBACK 109268260aabSYoshihiro Shimoda If this option is set, the driver enables cache flush. 109368260aabSYoshihiro Shimoda 10945e124724SVadim Bendebury- TPM Support: 10955e124724SVadim Bendebury CONFIG_GENERIC_LPC_TPM 10965e124724SVadim Bendebury Support for generic parallel port TPM devices. Only one device 10975e124724SVadim Bendebury per system is supported at this time. 10985e124724SVadim Bendebury 10995e124724SVadim Bendebury CONFIG_TPM_TIS_BASE_ADDRESS 11005e124724SVadim Bendebury Base address where the generic TPM device is mapped 11015e124724SVadim Bendebury to. Contemporary x86 systems usually map it at 11025e124724SVadim Bendebury 0xfed40000. 11035e124724SVadim Bendebury 1104c609719bSwdenk- USB Support: 1105c609719bSwdenk At the moment only the UHCI host controller is 11064d13cbadSwdenk supported (PIP405, MIP405, MPC5200); define 1107c609719bSwdenk CONFIG_USB_UHCI to enable it. 1108c609719bSwdenk define CONFIG_USB_KEYBOARD to enable the USB Keyboard 110930d56faeSwdenk and define CONFIG_USB_STORAGE to enable the USB 1110c609719bSwdenk storage devices. 1111c609719bSwdenk Note: 1112c609719bSwdenk Supported are USB Keyboards and USB Floppy drives 1113c609719bSwdenk (TEAC FD-05PUB). 11144d13cbadSwdenk MPC5200 USB requires additional defines: 11154d13cbadSwdenk CONFIG_USB_CLOCK 11164d13cbadSwdenk for 528 MHz Clock: 0x0001bbbb 1117307ecb6dSEric Millbrandt CONFIG_PSC3_USB 1118307ecb6dSEric Millbrandt for USB on PSC3 11194d13cbadSwdenk CONFIG_USB_CONFIG 11204d13cbadSwdenk for differential drivers: 0x00001000 11214d13cbadSwdenk for single ended drivers: 0x00005000 1122307ecb6dSEric Millbrandt for differential drivers on PSC3: 0x00000100 1123307ecb6dSEric Millbrandt for single ended drivers on PSC3: 0x00004100 11246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_USB_EVENT_POLL 1125fdcfaa1bSZhang Wei May be defined to allow interrupt polling 1126fdcfaa1bSZhang Wei instead of using asynchronous interrupts 11274d13cbadSwdenk 112816c8d5e7SWolfgang Denk- USB Device: 112916c8d5e7SWolfgang Denk Define the below if you wish to use the USB console. 113016c8d5e7SWolfgang Denk Once firmware is rebuilt from a serial console issue the 113116c8d5e7SWolfgang Denk command "setenv stdin usbtty; setenv stdout usbtty" and 113211ccc33fSMarcel Ziswiler attach your USB cable. The Unix command "dmesg" should print 113316c8d5e7SWolfgang Denk it has found a new device. The environment variable usbtty 113416c8d5e7SWolfgang Denk can be set to gserial or cdc_acm to enable your device to 113516c8d5e7SWolfgang Denk appear to a USB host as a Linux gserial device or a 113616c8d5e7SWolfgang Denk Common Device Class Abstract Control Model serial device. 113716c8d5e7SWolfgang Denk If you select usbtty = gserial you should be able to enumerate 113816c8d5e7SWolfgang Denk a Linux host by 113916c8d5e7SWolfgang Denk # modprobe usbserial vendor=0xVendorID product=0xProductID 114016c8d5e7SWolfgang Denk else if using cdc_acm, simply setting the environment 114116c8d5e7SWolfgang Denk variable usbtty to be cdc_acm should suffice. The following 114216c8d5e7SWolfgang Denk might be defined in YourBoardName.h 114316c8d5e7SWolfgang Denk 114416c8d5e7SWolfgang Denk CONFIG_USB_DEVICE 114516c8d5e7SWolfgang Denk Define this to build a UDC device 114616c8d5e7SWolfgang Denk 114716c8d5e7SWolfgang Denk CONFIG_USB_TTY 114816c8d5e7SWolfgang Denk Define this to have a tty type of device available to 114916c8d5e7SWolfgang Denk talk to the UDC device 115016c8d5e7SWolfgang Denk 11516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_CONSOLE_IS_IN_ENV 115216c8d5e7SWolfgang Denk Define this if you want stdin, stdout &/or stderr to 115316c8d5e7SWolfgang Denk be set to usbtty. 115416c8d5e7SWolfgang Denk 115516c8d5e7SWolfgang Denk mpc8xx: 11566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_USB_EXTC_CLK 0xBLAH 115716c8d5e7SWolfgang Denk Derive USB clock from external clock "blah" 11586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_USB_EXTC_CLK 0x02 115916c8d5e7SWolfgang Denk 11606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_USB_BRG_CLK 0xBLAH 116116c8d5e7SWolfgang Denk Derive USB clock from brgclk 11626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_USB_BRG_CLK 0x04 116316c8d5e7SWolfgang Denk 116416c8d5e7SWolfgang Denk If you have a USB-IF assigned VendorID then you may wish to 116516c8d5e7SWolfgang Denk define your own vendor specific values either in BoardName.h 116616c8d5e7SWolfgang Denk or directly in usbd_vendor_info.h. If you don't define 116716c8d5e7SWolfgang Denk CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME, 116816c8d5e7SWolfgang Denk CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot 116916c8d5e7SWolfgang Denk should pretend to be a Linux device to it's target host. 117016c8d5e7SWolfgang Denk 117116c8d5e7SWolfgang Denk CONFIG_USBD_MANUFACTURER 117216c8d5e7SWolfgang Denk Define this string as the name of your company for 117316c8d5e7SWolfgang Denk - CONFIG_USBD_MANUFACTURER "my company" 117416c8d5e7SWolfgang Denk 117516c8d5e7SWolfgang Denk CONFIG_USBD_PRODUCT_NAME 117616c8d5e7SWolfgang Denk Define this string as the name of your product 117716c8d5e7SWolfgang Denk - CONFIG_USBD_PRODUCT_NAME "acme usb device" 117816c8d5e7SWolfgang Denk 117916c8d5e7SWolfgang Denk CONFIG_USBD_VENDORID 118016c8d5e7SWolfgang Denk Define this as your assigned Vendor ID from the USB 118116c8d5e7SWolfgang Denk Implementors Forum. This *must* be a genuine Vendor ID 118216c8d5e7SWolfgang Denk to avoid polluting the USB namespace. 118316c8d5e7SWolfgang Denk - CONFIG_USBD_VENDORID 0xFFFF 118416c8d5e7SWolfgang Denk 118516c8d5e7SWolfgang Denk CONFIG_USBD_PRODUCTID 118616c8d5e7SWolfgang Denk Define this as the unique Product ID 118716c8d5e7SWolfgang Denk for your device 118816c8d5e7SWolfgang Denk - CONFIG_USBD_PRODUCTID 0xFFFF 1189c609719bSwdenk 1190d70a560fSIgor Grinberg- ULPI Layer Support: 1191d70a560fSIgor Grinberg The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via 1192d70a560fSIgor Grinberg the generic ULPI layer. The generic layer accesses the ULPI PHY 1193d70a560fSIgor Grinberg via the platform viewport, so you need both the genric layer and 1194d70a560fSIgor Grinberg the viewport enabled. Currently only Chipidea/ARC based 1195d70a560fSIgor Grinberg viewport is supported. 1196d70a560fSIgor Grinberg To enable the ULPI layer support, define CONFIG_USB_ULPI and 1197d70a560fSIgor Grinberg CONFIG_USB_ULPI_VIEWPORT in your board configuration file. 1198c609719bSwdenk 1199c609719bSwdenk- MMC Support: 1200c609719bSwdenk The MMC controller on the Intel PXA is supported. To 1201c609719bSwdenk enable this define CONFIG_MMC. The MMC can be 1202c609719bSwdenk accessed from the boot prompt by mapping the device 1203c609719bSwdenk to physical memory similar to flash. Command line is 1204602ad3b3SJon Loeliger enabled with CONFIG_CMD_MMC. The MMC driver also works with 1205602ad3b3SJon Loeliger the FAT fs. This is enabled with CONFIG_CMD_FAT. 1206c609719bSwdenk 1207afb35666SYoshihiro Shimoda CONFIG_SH_MMCIF 1208afb35666SYoshihiro Shimoda Support for Renesas on-chip MMCIF controller 1209afb35666SYoshihiro Shimoda 1210afb35666SYoshihiro Shimoda CONFIG_SH_MMCIF_ADDR 1211afb35666SYoshihiro Shimoda Define the base address of MMCIF registers 1212afb35666SYoshihiro Shimoda 1213afb35666SYoshihiro Shimoda CONFIG_SH_MMCIF_CLK 1214afb35666SYoshihiro Shimoda Define the clock frequency for MMCIF 1215afb35666SYoshihiro Shimoda 12166705d81eSwdenk- Journaling Flash filesystem support: 12176705d81eSwdenk CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE, 12186705d81eSwdenk CONFIG_JFFS2_NAND_DEV 12196705d81eSwdenk Define these for a default partition on a NAND device 12206705d81eSwdenk 12216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS2_FIRST_SECTOR, 12226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS 12236705d81eSwdenk Define these for a default partition on a NOR device 12246705d81eSwdenk 12256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS_CUSTOM_PART 12266705d81eSwdenk Define this to create an own partition. You have to provide a 12276705d81eSwdenk function struct part_info* jffs2_part_info(int part_num) 12286705d81eSwdenk 12296705d81eSwdenk If you define only one JFFS2 partition you may also want to 12306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_JFFS_SINGLE_PART 1 12316705d81eSwdenk to disable the command chpart. This is the default when you 12326705d81eSwdenk have not defined a custom partition 12336705d81eSwdenk 1234c30a15e5SDonggeun Kim- FAT(File Allocation Table) filesystem write function support: 1235c30a15e5SDonggeun Kim CONFIG_FAT_WRITE 1236*656f4c65SDonggeun Kim 1237*656f4c65SDonggeun Kim Define this to enable support for saving memory data as a 1238*656f4c65SDonggeun Kim file in FAT formatted partition. 1239*656f4c65SDonggeun Kim 1240*656f4c65SDonggeun Kim This will also enable the command "fatwrite" enabling the 1241*656f4c65SDonggeun Kim user to write files to FAT. 1242c30a15e5SDonggeun Kim 1243c609719bSwdenk- Keyboard Support: 1244c609719bSwdenk CONFIG_ISA_KEYBOARD 1245c609719bSwdenk 1246c609719bSwdenk Define this to enable standard (PC-Style) keyboard 1247c609719bSwdenk support 1248c609719bSwdenk 1249c609719bSwdenk CONFIG_I8042_KBD 1250c609719bSwdenk Standard PC keyboard driver with US (is default) and 1251c609719bSwdenk GERMAN key layout (switch via environment 'keymap=de') support. 1252c609719bSwdenk Export function i8042_kbd_init, i8042_tstc and i8042_getc 1253c609719bSwdenk for cfb_console. Supports cursor blinking. 1254c609719bSwdenk 1255c609719bSwdenk- Video support: 1256c609719bSwdenk CONFIG_VIDEO 1257c609719bSwdenk 1258c609719bSwdenk Define this to enable video support (for output to 1259c609719bSwdenk video). 1260c609719bSwdenk 1261c609719bSwdenk CONFIG_VIDEO_CT69000 1262c609719bSwdenk 1263c609719bSwdenk Enable Chips & Technologies 69000 Video chip 1264c609719bSwdenk 1265c609719bSwdenk CONFIG_VIDEO_SMI_LYNXEM 1266eeb1b77bSwdenk Enable Silicon Motion SMI 712/710/810 Video chip. The 1267eeb1b77bSwdenk video output is selected via environment 'videoout' 1268eeb1b77bSwdenk (1 = LCD and 2 = CRT). If videoout is undefined, CRT is 1269eeb1b77bSwdenk assumed. 1270c609719bSwdenk 1271eeb1b77bSwdenk For the CT69000 and SMI_LYNXEM drivers, videomode is 127211ccc33fSMarcel Ziswiler selected via environment 'videomode'. Two different ways 1273eeb1b77bSwdenk are possible: 1274eeb1b77bSwdenk - "videomode=num" 'num' is a standard LiLo mode numbers. 1275eeb1b77bSwdenk Following standard modes are supported (* is default): 1276eeb1b77bSwdenk 1277eeb1b77bSwdenk Colors 640x480 800x600 1024x768 1152x864 1280x1024 1278eeb1b77bSwdenk -------------+--------------------------------------------- 1279eeb1b77bSwdenk 8 bits | 0x301* 0x303 0x305 0x161 0x307 1280eeb1b77bSwdenk 15 bits | 0x310 0x313 0x316 0x162 0x319 1281eeb1b77bSwdenk 16 bits | 0x311 0x314 0x317 0x163 0x31A 1282eeb1b77bSwdenk 24 bits | 0x312 0x315 0x318 ? 0x31B 1283eeb1b77bSwdenk -------------+--------------------------------------------- 1284c609719bSwdenk (i.e. setenv videomode 317; saveenv; reset;) 1285c609719bSwdenk 1286eeb1b77bSwdenk - "videomode=bootargs" all the video parameters are parsed 12877817cb20SMarcel Ziswiler from the bootargs. (See drivers/video/videomodes.c) 1288eeb1b77bSwdenk 1289eeb1b77bSwdenk 1290a6c7ad2fSwdenk CONFIG_VIDEO_SED13806 1291a6c7ad2fSwdenk Enable Epson SED13806 driver. This driver supports 8bpp 1292a6c7ad2fSwdenk and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP 1293a6c7ad2fSwdenk or CONFIG_VIDEO_SED13806_16BPP 1294a6c7ad2fSwdenk 12957d3053fbSTimur Tabi CONFIG_FSL_DIU_FB 12967d3053fbSTimur Tabi Enable the Freescale DIU video driver. Reference boards for 12977d3053fbSTimur Tabi SOCs that have a DIU should define this macro to enable DIU 12987d3053fbSTimur Tabi support, and should also define these other macros: 12997d3053fbSTimur Tabi 13007d3053fbSTimur Tabi CONFIG_SYS_DIU_ADDR 13017d3053fbSTimur Tabi CONFIG_VIDEO 13027d3053fbSTimur Tabi CONFIG_CMD_BMP 13037d3053fbSTimur Tabi CONFIG_CFB_CONSOLE 13047d3053fbSTimur Tabi CONFIG_VIDEO_SW_CURSOR 13057d3053fbSTimur Tabi CONFIG_VGA_AS_SINGLE_DEVICE 13067d3053fbSTimur Tabi CONFIG_VIDEO_LOGO 13077d3053fbSTimur Tabi CONFIG_VIDEO_BMP_LOGO 13087d3053fbSTimur Tabi 1309ba8e76bdSTimur Tabi The DIU driver will look for the 'video-mode' environment 1310ba8e76bdSTimur Tabi variable, and if defined, enable the DIU as a console during 1311ba8e76bdSTimur Tabi boot. See the documentation file README.video for a 1312ba8e76bdSTimur Tabi description of this variable. 13137d3053fbSTimur Tabi 1314682011ffSwdenk- Keyboard Support: 1315682011ffSwdenk CONFIG_KEYBOARD 1316682011ffSwdenk 1317682011ffSwdenk Define this to enable a custom keyboard support. 1318682011ffSwdenk This simply calls drv_keyboard_init() which must be 1319682011ffSwdenk defined in your board-specific files. 1320682011ffSwdenk The only board using this so far is RBC823. 1321a6c7ad2fSwdenk 1322c609719bSwdenk- LCD Support: CONFIG_LCD 1323c609719bSwdenk 1324c609719bSwdenk Define this to enable LCD support (for output to LCD 1325c609719bSwdenk display); also select one of the supported displays 1326c609719bSwdenk by defining one of these: 1327c609719bSwdenk 132839cf4804SStelian Pop CONFIG_ATMEL_LCD: 132939cf4804SStelian Pop 133039cf4804SStelian Pop HITACHI TX09D70VM1CCA, 3.5", 240x320. 133139cf4804SStelian Pop 1332fd3103bbSwdenk CONFIG_NEC_NL6448AC33: 1333c609719bSwdenk 1334fd3103bbSwdenk NEC NL6448AC33-18. Active, color, single scan. 1335c609719bSwdenk 1336fd3103bbSwdenk CONFIG_NEC_NL6448BC20 1337c609719bSwdenk 1338fd3103bbSwdenk NEC NL6448BC20-08. 6.5", 640x480. 1339fd3103bbSwdenk Active, color, single scan. 1340fd3103bbSwdenk 1341fd3103bbSwdenk CONFIG_NEC_NL6448BC33_54 1342fd3103bbSwdenk 1343fd3103bbSwdenk NEC NL6448BC33-54. 10.4", 640x480. 1344c609719bSwdenk Active, color, single scan. 1345c609719bSwdenk 1346c609719bSwdenk CONFIG_SHARP_16x9 1347c609719bSwdenk 1348c609719bSwdenk Sharp 320x240. Active, color, single scan. 1349c609719bSwdenk It isn't 16x9, and I am not sure what it is. 1350c609719bSwdenk 1351c609719bSwdenk CONFIG_SHARP_LQ64D341 1352c609719bSwdenk 1353c609719bSwdenk Sharp LQ64D341 display, 640x480. 1354c609719bSwdenk Active, color, single scan. 1355c609719bSwdenk 1356c609719bSwdenk CONFIG_HLD1045 1357c609719bSwdenk 1358c609719bSwdenk HLD1045 display, 640x480. 1359c609719bSwdenk Active, color, single scan. 1360c609719bSwdenk 1361c609719bSwdenk CONFIG_OPTREX_BW 1362c609719bSwdenk 1363c609719bSwdenk Optrex CBL50840-2 NF-FW 99 22 M5 1364c609719bSwdenk or 1365c609719bSwdenk Hitachi LMG6912RPFC-00T 1366c609719bSwdenk or 1367c609719bSwdenk Hitachi SP14Q002 1368c609719bSwdenk 1369c609719bSwdenk 320x240. Black & white. 1370c609719bSwdenk 1371c609719bSwdenk Normally display is black on white background; define 13726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_WHITE_ON_BLACK to get it inverted. 1373c609719bSwdenk 13747152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN 1375d791b1dcSwdenk 1376d791b1dcSwdenk If this option is set, the environment is checked for 1377d791b1dcSwdenk a variable "splashimage". If found, the usual display 1378d791b1dcSwdenk of logo, copyright and system information on the LCD 1379e94d2cd9Swdenk is suppressed and the BMP image at the address 1380d791b1dcSwdenk specified in "splashimage" is loaded instead. The 1381d791b1dcSwdenk console is redirected to the "nulldev", too. This 1382d791b1dcSwdenk allows for a "silent" boot where a splash screen is 1383d791b1dcSwdenk loaded very quickly after power-on. 1384d791b1dcSwdenk 13851ca298ceSMatthias Weisser CONFIG_SPLASH_SCREEN_ALIGN 13861ca298ceSMatthias Weisser 13871ca298ceSMatthias Weisser If this option is set the splash image can be freely positioned 13881ca298ceSMatthias Weisser on the screen. Environment variable "splashpos" specifies the 13891ca298ceSMatthias Weisser position as "x,y". If a positive number is given it is used as 13901ca298ceSMatthias Weisser number of pixel from left/top. If a negative number is given it 13911ca298ceSMatthias Weisser is used as number of pixel from right/bottom. You can also 13921ca298ceSMatthias Weisser specify 'm' for centering the image. 13931ca298ceSMatthias Weisser 13941ca298ceSMatthias Weisser Example: 13951ca298ceSMatthias Weisser setenv splashpos m,m 13961ca298ceSMatthias Weisser => image at center of screen 13971ca298ceSMatthias Weisser 13981ca298ceSMatthias Weisser setenv splashpos 30,20 13991ca298ceSMatthias Weisser => image at x = 30 and y = 20 14001ca298ceSMatthias Weisser 14011ca298ceSMatthias Weisser setenv splashpos -10,m 14021ca298ceSMatthias Weisser => vertically centered image 14031ca298ceSMatthias Weisser at x = dspWidth - bmpWidth - 9 14041ca298ceSMatthias Weisser 140598f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP 140698f4a3dfSStefan Roese 140798f4a3dfSStefan Roese If this option is set, additionally to standard BMP 140898f4a3dfSStefan Roese images, gzipped BMP images can be displayed via the 140998f4a3dfSStefan Roese splashscreen support or the bmp command. 141098f4a3dfSStefan Roese 1411d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8 1412d5011762SAnatolij Gustschin 1413d5011762SAnatolij Gustschin If this option is set, 8-bit RLE compressed BMP images 1414d5011762SAnatolij Gustschin can be displayed via the splashscreen support or the 1415d5011762SAnatolij Gustschin bmp command. 1416d5011762SAnatolij Gustschin 1417c29fdfc1Swdenk- Compression support: 1418c29fdfc1Swdenk CONFIG_BZIP2 1419c29fdfc1Swdenk 1420c29fdfc1Swdenk If this option is set, support for bzip2 compressed 1421c29fdfc1Swdenk images is included. If not, only uncompressed and gzip 1422c29fdfc1Swdenk compressed images are supported. 1423c29fdfc1Swdenk 1424c29fdfc1Swdenk NOTE: the bzip2 algorithm requires a lot of RAM, so 14256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should 1426c29fdfc1Swdenk be at least 4MB. 1427d791b1dcSwdenk 1428fc9c1727SLuigi 'Comio' Mantellini CONFIG_LZMA 1429fc9c1727SLuigi 'Comio' Mantellini 1430fc9c1727SLuigi 'Comio' Mantellini If this option is set, support for lzma compressed 1431fc9c1727SLuigi 'Comio' Mantellini images is included. 1432fc9c1727SLuigi 'Comio' Mantellini 1433fc9c1727SLuigi 'Comio' Mantellini Note: The LZMA algorithm adds between 2 and 4KB of code and it 1434fc9c1727SLuigi 'Comio' Mantellini requires an amount of dynamic memory that is given by the 1435fc9c1727SLuigi 'Comio' Mantellini formula: 1436fc9c1727SLuigi 'Comio' Mantellini 1437fc9c1727SLuigi 'Comio' Mantellini (1846 + 768 << (lc + lp)) * sizeof(uint16) 1438fc9c1727SLuigi 'Comio' Mantellini 1439fc9c1727SLuigi 'Comio' Mantellini Where lc and lp stand for, respectively, Literal context bits 1440fc9c1727SLuigi 'Comio' Mantellini and Literal pos bits. 1441fc9c1727SLuigi 'Comio' Mantellini 1442fc9c1727SLuigi 'Comio' Mantellini This value is upper-bounded by 14MB in the worst case. Anyway, 1443fc9c1727SLuigi 'Comio' Mantellini for a ~4MB large kernel image, we have lc=3 and lp=0 for a 1444fc9c1727SLuigi 'Comio' Mantellini total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is 1445fc9c1727SLuigi 'Comio' Mantellini a very small buffer. 1446fc9c1727SLuigi 'Comio' Mantellini 1447fc9c1727SLuigi 'Comio' Mantellini Use the lzmainfo tool to determinate the lc and lp values and 1448fc9c1727SLuigi 'Comio' Mantellini then calculate the amount of needed dynamic memory (ensuring 14496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD the appropriate CONFIG_SYS_MALLOC_LEN value). 1450fc9c1727SLuigi 'Comio' Mantellini 145117ea1177Swdenk- MII/PHY support: 145217ea1177Swdenk CONFIG_PHY_ADDR 145317ea1177Swdenk 145417ea1177Swdenk The address of PHY on MII bus. 145517ea1177Swdenk 145617ea1177Swdenk CONFIG_PHY_CLOCK_FREQ (ppc4xx) 145717ea1177Swdenk 145817ea1177Swdenk The clock frequency of the MII bus 145917ea1177Swdenk 146017ea1177Swdenk CONFIG_PHY_GIGE 146117ea1177Swdenk 146217ea1177Swdenk If this option is set, support for speed/duplex 146311ccc33fSMarcel Ziswiler detection of gigabit PHY is included. 146417ea1177Swdenk 146517ea1177Swdenk CONFIG_PHY_RESET_DELAY 146617ea1177Swdenk 146717ea1177Swdenk Some PHY like Intel LXT971A need extra delay after 146817ea1177Swdenk reset before any MII register access is possible. 146917ea1177Swdenk For such PHY, set this option to the usec delay 147017ea1177Swdenk required. (minimum 300usec for LXT971A) 147117ea1177Swdenk 147217ea1177Swdenk CONFIG_PHY_CMD_DELAY (ppc4xx) 147317ea1177Swdenk 147417ea1177Swdenk Some PHY like Intel LXT971A need extra delay after 147517ea1177Swdenk command issued before MII status register can be read 147617ea1177Swdenk 1477c609719bSwdenk- Ethernet address: 1478c609719bSwdenk CONFIG_ETHADDR 1479c68a05feSrichardretanubun CONFIG_ETH1ADDR 1480c609719bSwdenk CONFIG_ETH2ADDR 1481c609719bSwdenk CONFIG_ETH3ADDR 1482c68a05feSrichardretanubun CONFIG_ETH4ADDR 1483c68a05feSrichardretanubun CONFIG_ETH5ADDR 1484c609719bSwdenk 148511ccc33fSMarcel Ziswiler Define a default value for Ethernet address to use 148611ccc33fSMarcel Ziswiler for the respective Ethernet interface, in case this 1487c609719bSwdenk is not determined automatically. 1488c609719bSwdenk 1489c609719bSwdenk- IP address: 1490c609719bSwdenk CONFIG_IPADDR 1491c609719bSwdenk 1492c609719bSwdenk Define a default value for the IP address to use for 149311ccc33fSMarcel Ziswiler the default Ethernet interface, in case this is not 1494c609719bSwdenk determined through e.g. bootp. 14951ebcd654SWolfgang Denk (Environment variable "ipaddr") 1496c609719bSwdenk 1497c609719bSwdenk- Server IP address: 1498c609719bSwdenk CONFIG_SERVERIP 1499c609719bSwdenk 1500c609719bSwdenk Defines a default value for the IP address of a TFTP 1501c609719bSwdenk server to contact when using the "tftboot" command. 15021ebcd654SWolfgang Denk (Environment variable "serverip") 1503c609719bSwdenk 150497cfe861SRobin Getz CONFIG_KEEP_SERVERADDR 150597cfe861SRobin Getz 150697cfe861SRobin Getz Keeps the server's MAC address, in the env 'serveraddr' 150797cfe861SRobin Getz for passing to bootargs (like Linux's netconsole option) 150897cfe861SRobin Getz 15091ebcd654SWolfgang Denk- Gateway IP address: 15101ebcd654SWolfgang Denk CONFIG_GATEWAYIP 15111ebcd654SWolfgang Denk 15121ebcd654SWolfgang Denk Defines a default value for the IP address of the 15131ebcd654SWolfgang Denk default router where packets to other networks are 15141ebcd654SWolfgang Denk sent to. 15151ebcd654SWolfgang Denk (Environment variable "gatewayip") 15161ebcd654SWolfgang Denk 15171ebcd654SWolfgang Denk- Subnet mask: 15181ebcd654SWolfgang Denk CONFIG_NETMASK 15191ebcd654SWolfgang Denk 15201ebcd654SWolfgang Denk Defines a default value for the subnet mask (or 15211ebcd654SWolfgang Denk routing prefix) which is used to determine if an IP 15221ebcd654SWolfgang Denk address belongs to the local subnet or needs to be 15231ebcd654SWolfgang Denk forwarded through a router. 15241ebcd654SWolfgang Denk (Environment variable "netmask") 15251ebcd654SWolfgang Denk 152653a5c424SDavid Updegraff- Multicast TFTP Mode: 152753a5c424SDavid Updegraff CONFIG_MCAST_TFTP 152853a5c424SDavid Updegraff 152953a5c424SDavid Updegraff Defines whether you want to support multicast TFTP as per 153053a5c424SDavid Updegraff rfc-2090; for example to work with atftp. Lets lots of targets 153111ccc33fSMarcel Ziswiler tftp down the same boot image concurrently. Note: the Ethernet 153253a5c424SDavid Updegraff driver in use must provide a function: mcast() to join/leave a 153353a5c424SDavid Updegraff multicast group. 153453a5c424SDavid Updegraff 1535c609719bSwdenk- BOOTP Recovery Mode: 1536c609719bSwdenk CONFIG_BOOTP_RANDOM_DELAY 1537c609719bSwdenk 1538c609719bSwdenk If you have many targets in a network that try to 1539c609719bSwdenk boot using BOOTP, you may want to avoid that all 1540c609719bSwdenk systems send out BOOTP requests at precisely the same 1541c609719bSwdenk moment (which would happen for instance at recovery 1542c609719bSwdenk from a power failure, when all systems will try to 1543c609719bSwdenk boot, thus flooding the BOOTP server. Defining 1544c609719bSwdenk CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be 1545c609719bSwdenk inserted before sending out BOOTP requests. The 15466c33c785SWolfgang Denk following delays are inserted then: 1547c609719bSwdenk 1548c609719bSwdenk 1st BOOTP request: delay 0 ... 1 sec 1549c609719bSwdenk 2nd BOOTP request: delay 0 ... 2 sec 1550c609719bSwdenk 3rd BOOTP request: delay 0 ... 4 sec 1551c609719bSwdenk 4th and following 1552c609719bSwdenk BOOTP requests: delay 0 ... 8 sec 1553c609719bSwdenk 1554fe389a82Sstroese- DHCP Advanced Options: 15551fe80d79SJon Loeliger You can fine tune the DHCP functionality by defining 15561fe80d79SJon Loeliger CONFIG_BOOTP_* symbols: 1557fe389a82Sstroese 15581fe80d79SJon Loeliger CONFIG_BOOTP_SUBNETMASK 15591fe80d79SJon Loeliger CONFIG_BOOTP_GATEWAY 15601fe80d79SJon Loeliger CONFIG_BOOTP_HOSTNAME 15611fe80d79SJon Loeliger CONFIG_BOOTP_NISDOMAIN 15621fe80d79SJon Loeliger CONFIG_BOOTP_BOOTPATH 15631fe80d79SJon Loeliger CONFIG_BOOTP_BOOTFILESIZE 15641fe80d79SJon Loeliger CONFIG_BOOTP_DNS 15651fe80d79SJon Loeliger CONFIG_BOOTP_DNS2 15661fe80d79SJon Loeliger CONFIG_BOOTP_SEND_HOSTNAME 15671fe80d79SJon Loeliger CONFIG_BOOTP_NTPSERVER 15681fe80d79SJon Loeliger CONFIG_BOOTP_TIMEOFFSET 15691fe80d79SJon Loeliger CONFIG_BOOTP_VENDOREX 1570fe389a82Sstroese 15715d110f0aSWilson Callan CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip 15725d110f0aSWilson Callan environment variable, not the BOOTP server. 1573fe389a82Sstroese 1574fe389a82Sstroese CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS 1575fe389a82Sstroese serverip from a DHCP server, it is possible that more 1576fe389a82Sstroese than one DNS serverip is offered to the client. 1577fe389a82Sstroese If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS 1578fe389a82Sstroese serverip will be stored in the additional environment 1579fe389a82Sstroese variable "dnsip2". The first DNS serverip is always 1580fe389a82Sstroese stored in the variable "dnsip", when CONFIG_BOOTP_DNS 15811fe80d79SJon Loeliger is defined. 1582fe389a82Sstroese 1583fe389a82Sstroese CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable 1584fe389a82Sstroese to do a dynamic update of a DNS server. To do this, they 1585fe389a82Sstroese need the hostname of the DHCP requester. 15865d110f0aSWilson Callan If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content 15871fe80d79SJon Loeliger of the "hostname" environment variable is passed as 15881fe80d79SJon Loeliger option 12 to the DHCP server. 1589fe389a82Sstroese 1590d9a2f416SAras Vaichas CONFIG_BOOTP_DHCP_REQUEST_DELAY 1591d9a2f416SAras Vaichas 1592d9a2f416SAras Vaichas A 32bit value in microseconds for a delay between 1593d9a2f416SAras Vaichas receiving a "DHCP Offer" and sending the "DHCP Request". 1594d9a2f416SAras Vaichas This fixes a problem with certain DHCP servers that don't 1595d9a2f416SAras Vaichas respond 100% of the time to a "DHCP request". E.g. On an 1596d9a2f416SAras Vaichas AT91RM9200 processor running at 180MHz, this delay needed 1597d9a2f416SAras Vaichas to be *at least* 15,000 usec before a Windows Server 2003 1598d9a2f416SAras Vaichas DHCP server would reply 100% of the time. I recommend at 1599d9a2f416SAras Vaichas least 50,000 usec to be safe. The alternative is to hope 1600d9a2f416SAras Vaichas that one of the retries will be successful but note that 1601d9a2f416SAras Vaichas the DHCP timeout and retry process takes a longer than 1602d9a2f416SAras Vaichas this delay. 1603d9a2f416SAras Vaichas 1604a3d991bdSwdenk - CDP Options: 1605a3d991bdSwdenk CONFIG_CDP_DEVICE_ID 1606a3d991bdSwdenk 1607a3d991bdSwdenk The device id used in CDP trigger frames. 1608a3d991bdSwdenk 1609a3d991bdSwdenk CONFIG_CDP_DEVICE_ID_PREFIX 1610a3d991bdSwdenk 1611a3d991bdSwdenk A two character string which is prefixed to the MAC address 1612a3d991bdSwdenk of the device. 1613a3d991bdSwdenk 1614a3d991bdSwdenk CONFIG_CDP_PORT_ID 1615a3d991bdSwdenk 1616a3d991bdSwdenk A printf format string which contains the ascii name of 1617a3d991bdSwdenk the port. Normally is set to "eth%d" which sets 161811ccc33fSMarcel Ziswiler eth0 for the first Ethernet, eth1 for the second etc. 1619a3d991bdSwdenk 1620a3d991bdSwdenk CONFIG_CDP_CAPABILITIES 1621a3d991bdSwdenk 1622a3d991bdSwdenk A 32bit integer which indicates the device capabilities; 1623a3d991bdSwdenk 0x00000010 for a normal host which does not forwards. 1624a3d991bdSwdenk 1625a3d991bdSwdenk CONFIG_CDP_VERSION 1626a3d991bdSwdenk 1627a3d991bdSwdenk An ascii string containing the version of the software. 1628a3d991bdSwdenk 1629a3d991bdSwdenk CONFIG_CDP_PLATFORM 1630a3d991bdSwdenk 1631a3d991bdSwdenk An ascii string containing the name of the platform. 1632a3d991bdSwdenk 1633a3d991bdSwdenk CONFIG_CDP_TRIGGER 1634a3d991bdSwdenk 1635a3d991bdSwdenk A 32bit integer sent on the trigger. 1636a3d991bdSwdenk 1637a3d991bdSwdenk CONFIG_CDP_POWER_CONSUMPTION 1638a3d991bdSwdenk 1639a3d991bdSwdenk A 16bit integer containing the power consumption of the 1640a3d991bdSwdenk device in .1 of milliwatts. 1641a3d991bdSwdenk 1642a3d991bdSwdenk CONFIG_CDP_APPLIANCE_VLAN_TYPE 1643a3d991bdSwdenk 1644a3d991bdSwdenk A byte containing the id of the VLAN. 1645a3d991bdSwdenk 1646c609719bSwdenk- Status LED: CONFIG_STATUS_LED 1647c609719bSwdenk 1648c609719bSwdenk Several configurations allow to display the current 1649c609719bSwdenk status using a LED. For instance, the LED will blink 1650c609719bSwdenk fast while running U-Boot code, stop blinking as 1651c609719bSwdenk soon as a reply to a BOOTP request was received, and 1652c609719bSwdenk start blinking slow once the Linux kernel is running 1653c609719bSwdenk (supported by a status LED driver in the Linux 1654c609719bSwdenk kernel). Defining CONFIG_STATUS_LED enables this 1655c609719bSwdenk feature in U-Boot. 1656c609719bSwdenk 1657c609719bSwdenk- CAN Support: CONFIG_CAN_DRIVER 1658c609719bSwdenk 1659c609719bSwdenk Defining CONFIG_CAN_DRIVER enables CAN driver support 1660c609719bSwdenk on those systems that support this (optional) 1661c609719bSwdenk feature, like the TQM8xxL modules. 1662c609719bSwdenk 1663c609719bSwdenk- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C 1664c609719bSwdenk 1665b37c7e5eSwdenk These enable I2C serial bus commands. Defining either of 1666b37c7e5eSwdenk (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will 166711ccc33fSMarcel Ziswiler include the appropriate I2C driver for the selected CPU. 1668c609719bSwdenk 1669b37c7e5eSwdenk This will allow you to use i2c commands at the u-boot 1670602ad3b3SJon Loeliger command line (as long as you set CONFIG_CMD_I2C in 1671b37c7e5eSwdenk CONFIG_COMMANDS) and communicate with i2c based realtime 1672b37c7e5eSwdenk clock chips. See common/cmd_i2c.c for a description of the 1673c609719bSwdenk command line interface. 1674c609719bSwdenk 1675bb99ad6dSBen Warren CONFIG_HARD_I2C selects a hardware I2C controller. 1676c609719bSwdenk 1677b37c7e5eSwdenk CONFIG_SOFT_I2C configures u-boot to use a software (aka 1678b37c7e5eSwdenk bit-banging) driver instead of CPM or similar hardware 1679b37c7e5eSwdenk support for I2C. 1680c609719bSwdenk 1681b37c7e5eSwdenk There are several other quantities that must also be 1682b37c7e5eSwdenk defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C. 1683c609719bSwdenk 16846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD In both cases you will need to define CONFIG_SYS_I2C_SPEED 1685b37c7e5eSwdenk to be the frequency (in Hz) at which you wish your i2c bus 16866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie 168711ccc33fSMarcel Ziswiler the CPU's i2c node address). 1688c609719bSwdenk 16898d321b81SPeter Tyser Now, the u-boot i2c code for the mpc8xx 1690a47a12beSStefan Roese (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node 16918d321b81SPeter Tyser and so its address should therefore be cleared to 0 (See, 16928d321b81SPeter Tyser eg, MPC823e User's Manual p.16-473). So, set 16938d321b81SPeter Tyser CONFIG_SYS_I2C_SLAVE to 0. 1694b37c7e5eSwdenk 16955da71efaSEric Millbrandt CONFIG_SYS_I2C_INIT_MPC5XXX 16965da71efaSEric Millbrandt 16975da71efaSEric Millbrandt When a board is reset during an i2c bus transfer 16985da71efaSEric Millbrandt chips might think that the current transfer is still 16995da71efaSEric Millbrandt in progress. Reset the slave devices by sending start 17005da71efaSEric Millbrandt commands until the slave device responds. 17015da71efaSEric Millbrandt 1702b37c7e5eSwdenk That's all that's required for CONFIG_HARD_I2C. 1703b37c7e5eSwdenk 1704b37c7e5eSwdenk If you use the software i2c interface (CONFIG_SOFT_I2C) 1705b37c7e5eSwdenk then the following macros need to be defined (examples are 1706b37c7e5eSwdenk from include/configs/lwmon.h): 1707c609719bSwdenk 1708c609719bSwdenk I2C_INIT 1709c609719bSwdenk 1710b37c7e5eSwdenk (Optional). Any commands necessary to enable the I2C 1711c609719bSwdenk controller or configure ports. 1712c609719bSwdenk 1713b37c7e5eSwdenk eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL) 1714b37c7e5eSwdenk 1715c609719bSwdenk I2C_PORT 1716c609719bSwdenk 1717c609719bSwdenk (Only for MPC8260 CPU). The I/O port to use (the code 1718c609719bSwdenk assumes both bits are on the same port). Valid values 1719c609719bSwdenk are 0..3 for ports A..D. 1720c609719bSwdenk 1721c609719bSwdenk I2C_ACTIVE 1722c609719bSwdenk 1723c609719bSwdenk The code necessary to make the I2C data line active 1724c609719bSwdenk (driven). If the data line is open collector, this 1725c609719bSwdenk define can be null. 1726c609719bSwdenk 1727b37c7e5eSwdenk eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA) 1728b37c7e5eSwdenk 1729c609719bSwdenk I2C_TRISTATE 1730c609719bSwdenk 1731c609719bSwdenk The code necessary to make the I2C data line tri-stated 1732c609719bSwdenk (inactive). If the data line is open collector, this 1733c609719bSwdenk define can be null. 1734c609719bSwdenk 1735b37c7e5eSwdenk eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA) 1736b37c7e5eSwdenk 1737c609719bSwdenk I2C_READ 1738c609719bSwdenk 1739c609719bSwdenk Code that returns TRUE if the I2C data line is high, 1740c609719bSwdenk FALSE if it is low. 1741c609719bSwdenk 1742b37c7e5eSwdenk eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0) 1743b37c7e5eSwdenk 1744c609719bSwdenk I2C_SDA(bit) 1745c609719bSwdenk 1746c609719bSwdenk If <bit> is TRUE, sets the I2C data line high. If it 1747c609719bSwdenk is FALSE, it clears it (low). 1748c609719bSwdenk 1749b37c7e5eSwdenk eg: #define I2C_SDA(bit) \ 1750b37c7e5eSwdenk if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \ 1751b37c7e5eSwdenk else immr->im_cpm.cp_pbdat &= ~PB_SDA 1752b37c7e5eSwdenk 1753c609719bSwdenk I2C_SCL(bit) 1754c609719bSwdenk 1755c609719bSwdenk If <bit> is TRUE, sets the I2C clock line high. If it 1756c609719bSwdenk is FALSE, it clears it (low). 1757c609719bSwdenk 1758b37c7e5eSwdenk eg: #define I2C_SCL(bit) \ 1759b37c7e5eSwdenk if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \ 1760b37c7e5eSwdenk else immr->im_cpm.cp_pbdat &= ~PB_SCL 1761b37c7e5eSwdenk 1762c609719bSwdenk I2C_DELAY 1763c609719bSwdenk 1764c609719bSwdenk This delay is invoked four times per clock cycle so this 1765c609719bSwdenk controls the rate of data transfer. The data rate thus 1766b37c7e5eSwdenk is 1 / (I2C_DELAY * 4). Often defined to be something 1767b37c7e5eSwdenk like: 1768b37c7e5eSwdenk 1769b37c7e5eSwdenk #define I2C_DELAY udelay(2) 1770c609719bSwdenk 1771793b5726SMike Frysinger CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA 1772793b5726SMike Frysinger 1773793b5726SMike Frysinger If your arch supports the generic GPIO framework (asm/gpio.h), 1774793b5726SMike Frysinger then you may alternatively define the two GPIOs that are to be 1775793b5726SMike Frysinger used as SCL / SDA. Any of the previous I2C_xxx macros will 1776793b5726SMike Frysinger have GPIO-based defaults assigned to them as appropriate. 1777793b5726SMike Frysinger 1778793b5726SMike Frysinger You should define these to the GPIO value as given directly to 1779793b5726SMike Frysinger the generic GPIO functions. 1780793b5726SMike Frysinger 17816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_INIT_BOARD 178247cd00faSwdenk 178347cd00faSwdenk When a board is reset during an i2c bus transfer 178447cd00faSwdenk chips might think that the current transfer is still 178547cd00faSwdenk in progress. On some boards it is possible to access 178647cd00faSwdenk the i2c SCLK line directly, either by using the 178747cd00faSwdenk processor pin as a GPIO or by having a second pin 178847cd00faSwdenk connected to the bus. If this option is defined a 178947cd00faSwdenk custom i2c_init_board() routine in boards/xxx/board.c 179047cd00faSwdenk is run early in the boot sequence. 179147cd00faSwdenk 179226a33504SRichard Retanubun CONFIG_SYS_I2C_BOARD_LATE_INIT 179326a33504SRichard Retanubun 179426a33504SRichard Retanubun An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is 179526a33504SRichard Retanubun defined a custom i2c_board_late_init() routine in 179626a33504SRichard Retanubun boards/xxx/board.c is run AFTER the operations in i2c_init() 179726a33504SRichard Retanubun is completed. This callpoint can be used to unreset i2c bus 179826a33504SRichard Retanubun using CPU i2c controller register accesses for CPUs whose i2c 179926a33504SRichard Retanubun controller provide such a method. It is called at the end of 180026a33504SRichard Retanubun i2c_init() to allow i2c_init operations to setup the i2c bus 180126a33504SRichard Retanubun controller on the CPU (e.g. setting bus speed & slave address). 180226a33504SRichard Retanubun 180317ea1177Swdenk CONFIG_I2CFAST (PPC405GP|PPC405EP only) 180417ea1177Swdenk 180517ea1177Swdenk This option enables configuration of bi_iic_fast[] flags 180617ea1177Swdenk in u-boot bd_info structure based on u-boot environment 180717ea1177Swdenk variable "i2cfast". (see also i2cfast) 180817ea1177Swdenk 1809bb99ad6dSBen Warren CONFIG_I2C_MULTI_BUS 1810bb99ad6dSBen Warren 1811bb99ad6dSBen Warren This option allows the use of multiple I2C buses, each of which 1812bb99ad6dSBen Warren must have a controller. At any point in time, only one bus is 1813bb99ad6dSBen Warren active. To switch to a different bus, use the 'i2c dev' command. 1814bb99ad6dSBen Warren Note that bus numbering is zero-based. 1815bb99ad6dSBen Warren 18166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_NOPROBES 1817bb99ad6dSBen Warren 1818bb99ad6dSBen Warren This option specifies a list of I2C devices that will be skipped 18190f89c54bSPeter Tyser when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS 18200f89c54bSPeter Tyser is set, specify a list of bus-device pairs. Otherwise, specify 18210f89c54bSPeter Tyser a 1D array of device addresses 1822bb99ad6dSBen Warren 1823bb99ad6dSBen Warren e.g. 1824bb99ad6dSBen Warren #undef CONFIG_I2C_MULTI_BUS 18256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68} 1826bb99ad6dSBen Warren 1827bb99ad6dSBen Warren will skip addresses 0x50 and 0x68 on a board with one I2C bus 1828bb99ad6dSBen Warren 1829bb99ad6dSBen Warren #define CONFIG_I2C_MULTI_BUS 18306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}} 1831bb99ad6dSBen Warren 1832bb99ad6dSBen Warren will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1 1833bb99ad6dSBen Warren 18346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SPD_BUS_NUM 1835be5e6181STimur Tabi 1836be5e6181STimur Tabi If defined, then this indicates the I2C bus number for DDR SPD. 1837be5e6181STimur Tabi If not defined, then U-Boot assumes that SPD is on I2C bus 0. 1838be5e6181STimur Tabi 18396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_RTC_BUS_NUM 18400dc018ecSStefan Roese 18410dc018ecSStefan Roese If defined, then this indicates the I2C bus number for the RTC. 18420dc018ecSStefan Roese If not defined, then U-Boot assumes that RTC is on I2C bus 0. 18430dc018ecSStefan Roese 18446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_DTT_BUS_NUM 18450dc018ecSStefan Roese 18460dc018ecSStefan Roese If defined, then this indicates the I2C bus number for the DTT. 18470dc018ecSStefan Roese If not defined, then U-Boot assumes that DTT is on I2C bus 0. 18480dc018ecSStefan Roese 18496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_DTT_ADDR: 18509ebbb54fSVictor Gallardo 18519ebbb54fSVictor Gallardo If defined, specifies the I2C address of the DTT device. 18529ebbb54fSVictor Gallardo If not defined, then U-Boot uses predefined value for 18539ebbb54fSVictor Gallardo specified DTT device. 18549ebbb54fSVictor Gallardo 1855be5e6181STimur Tabi CONFIG_FSL_I2C 1856be5e6181STimur Tabi 1857be5e6181STimur Tabi Define this option if you want to use Freescale's I2C driver in 18587817cb20SMarcel Ziswiler drivers/i2c/fsl_i2c.c. 1859be5e6181STimur Tabi 186067b23a32SHeiko Schocher CONFIG_I2C_MUX 186167b23a32SHeiko Schocher 186267b23a32SHeiko Schocher Define this option if you have I2C devices reached over 1 .. n 186367b23a32SHeiko Schocher I2C Muxes like the pca9544a. This option addes a new I2C 186467b23a32SHeiko Schocher Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a 186567b23a32SHeiko Schocher new I2C Bus to the existing I2C Busses. If you select the 186667b23a32SHeiko Schocher new Bus with "i2c dev", u-bbot sends first the commandos for 186767b23a32SHeiko Schocher the muxes to activate this new "bus". 186867b23a32SHeiko Schocher 186967b23a32SHeiko Schocher CONFIG_I2C_MULTI_BUS must be also defined, to use this 187067b23a32SHeiko Schocher feature! 187167b23a32SHeiko Schocher 187267b23a32SHeiko Schocher Example: 187367b23a32SHeiko Schocher Adding a new I2C Bus reached over 2 pca9544a muxes 187467b23a32SHeiko Schocher The First mux with address 70 and channel 6 187567b23a32SHeiko Schocher The Second mux with address 71 and channel 4 187667b23a32SHeiko Schocher 187767b23a32SHeiko Schocher => i2c bus pca9544a:70:6:pca9544a:71:4 187867b23a32SHeiko Schocher 187967b23a32SHeiko Schocher Use the "i2c bus" command without parameter, to get a list 188067b23a32SHeiko Schocher of I2C Busses with muxes: 188167b23a32SHeiko Schocher 188267b23a32SHeiko Schocher => i2c bus 188367b23a32SHeiko Schocher Busses reached over muxes: 188467b23a32SHeiko Schocher Bus ID: 2 188567b23a32SHeiko Schocher reached over Mux(es): 188667b23a32SHeiko Schocher pca9544a@70 ch: 4 188767b23a32SHeiko Schocher Bus ID: 3 188867b23a32SHeiko Schocher reached over Mux(es): 188967b23a32SHeiko Schocher pca9544a@70 ch: 6 189067b23a32SHeiko Schocher pca9544a@71 ch: 4 189167b23a32SHeiko Schocher => 189267b23a32SHeiko Schocher 189367b23a32SHeiko Schocher If you now switch to the new I2C Bus 3 with "i2c dev 3" 1894f9a78b8dSMichael Jones u-boot first sends the command to the mux@70 to enable 1895f9a78b8dSMichael Jones channel 6, and then the command to the mux@71 to enable 189667b23a32SHeiko Schocher the channel 4. 189767b23a32SHeiko Schocher 189867b23a32SHeiko Schocher After that, you can use the "normal" i2c commands as 1899f9a78b8dSMichael Jones usual to communicate with your I2C devices behind 190067b23a32SHeiko Schocher the 2 muxes. 190167b23a32SHeiko Schocher 190267b23a32SHeiko Schocher This option is actually implemented for the bitbanging 190367b23a32SHeiko Schocher algorithm in common/soft_i2c.c and for the Hardware I2C 190467b23a32SHeiko Schocher Bus on the MPC8260. But it should be not so difficult 190567b23a32SHeiko Schocher to add this option to other architectures. 190667b23a32SHeiko Schocher 19072ac6985aSAndrew Dyer CONFIG_SOFT_I2C_READ_REPEATED_START 19082ac6985aSAndrew Dyer 19092ac6985aSAndrew Dyer defining this will force the i2c_read() function in 19102ac6985aSAndrew Dyer the soft_i2c driver to perform an I2C repeated start 19112ac6985aSAndrew Dyer between writing the address pointer and reading the 19122ac6985aSAndrew Dyer data. If this define is omitted the default behaviour 19132ac6985aSAndrew Dyer of doing a stop-start sequence will be used. Most I2C 19142ac6985aSAndrew Dyer devices can use either method, but some require one or 19152ac6985aSAndrew Dyer the other. 1916be5e6181STimur Tabi 1917c609719bSwdenk- SPI Support: CONFIG_SPI 1918c609719bSwdenk 1919c609719bSwdenk Enables SPI driver (so far only tested with 1920c609719bSwdenk SPI EEPROM, also an instance works with Crystal A/D and 1921c609719bSwdenk D/As on the SACSng board) 1922c609719bSwdenk 19236639562eSYoshihiro Shimoda CONFIG_SH_SPI 19246639562eSYoshihiro Shimoda 19256639562eSYoshihiro Shimoda Enables the driver for SPI controller on SuperH. Currently 19266639562eSYoshihiro Shimoda only SH7757 is supported. 19276639562eSYoshihiro Shimoda 1928c609719bSwdenk CONFIG_SPI_X 1929c609719bSwdenk 1930c609719bSwdenk Enables extended (16-bit) SPI EEPROM addressing. 1931c609719bSwdenk (symmetrical to CONFIG_I2C_X) 1932c609719bSwdenk 1933c609719bSwdenk CONFIG_SOFT_SPI 1934c609719bSwdenk 1935c609719bSwdenk Enables a software (bit-bang) SPI driver rather than 1936c609719bSwdenk using hardware support. This is a general purpose 1937c609719bSwdenk driver that only requires three general I/O port pins 1938c609719bSwdenk (two outputs, one input) to function. If this is 1939c609719bSwdenk defined, the board configuration must define several 1940c609719bSwdenk SPI configuration items (port pins to use, etc). For 1941c609719bSwdenk an example, see include/configs/sacsng.h. 1942c609719bSwdenk 194304a9e118SBen Warren CONFIG_HARD_SPI 194404a9e118SBen Warren 194504a9e118SBen Warren Enables a hardware SPI driver for general-purpose reads 194604a9e118SBen Warren and writes. As with CONFIG_SOFT_SPI, the board configuration 194704a9e118SBen Warren must define a list of chip-select function pointers. 194804a9e118SBen Warren Currently supported on some MPC8xxx processors. For an 194904a9e118SBen Warren example, see include/configs/mpc8349emds.h. 195004a9e118SBen Warren 195138254f45SGuennadi Liakhovetski CONFIG_MXC_SPI 195238254f45SGuennadi Liakhovetski 195338254f45SGuennadi Liakhovetski Enables the driver for the SPI controllers on i.MX and MXC 19542e3cd1cdSFabio Estevam SoCs. Currently i.MX31/35/51 are supported. 195538254f45SGuennadi Liakhovetski 19560133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA 19570133502eSMatthias Fuchs 19580133502eSMatthias Fuchs Enables FPGA subsystem. 19590133502eSMatthias Fuchs 19600133502eSMatthias Fuchs CONFIG_FPGA_<vendor> 19610133502eSMatthias Fuchs 19620133502eSMatthias Fuchs Enables support for specific chip vendors. 19630133502eSMatthias Fuchs (ALTERA, XILINX) 19640133502eSMatthias Fuchs 19650133502eSMatthias Fuchs CONFIG_FPGA_<family> 19660133502eSMatthias Fuchs 19670133502eSMatthias Fuchs Enables support for FPGA family. 19680133502eSMatthias Fuchs (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX) 19690133502eSMatthias Fuchs 19700133502eSMatthias Fuchs CONFIG_FPGA_COUNT 1971c609719bSwdenk 1972c609719bSwdenk Specify the number of FPGA devices to support. 1973c609719bSwdenk 19746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_PROG_FEEDBACK 1975c609719bSwdenk 1976c609719bSwdenk Enable printing of hash marks during FPGA configuration. 1977c609719bSwdenk 19786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_BUSY 1979c609719bSwdenk 1980c609719bSwdenk Enable checks on FPGA configuration interface busy 1981c609719bSwdenk status by the configuration function. This option 1982c609719bSwdenk will require a board or device specific function to 1983c609719bSwdenk be written. 1984c609719bSwdenk 1985c609719bSwdenk CONFIG_FPGA_DELAY 1986c609719bSwdenk 1987c609719bSwdenk If defined, a function that provides delays in the FPGA 1988c609719bSwdenk configuration driver. 1989c609719bSwdenk 19906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_CTRLC 1991c609719bSwdenk Allow Control-C to interrupt FPGA configuration 1992c609719bSwdenk 19936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_ERROR 1994c609719bSwdenk 1995c609719bSwdenk Check for configuration errors during FPGA bitfile 1996c609719bSwdenk loading. For example, abort during Virtex II 1997c609719bSwdenk configuration if the INIT_B line goes low (which 1998c609719bSwdenk indicated a CRC error). 1999c609719bSwdenk 20006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_INIT 2001c609719bSwdenk 2002c609719bSwdenk Maximum time to wait for the INIT_B line to deassert 2003c609719bSwdenk after PROB_B has been deasserted during a Virtex II 2004c609719bSwdenk FPGA configuration sequence. The default time is 500 200511ccc33fSMarcel Ziswiler ms. 2006c609719bSwdenk 20076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_BUSY 2008c609719bSwdenk 2009c609719bSwdenk Maximum time to wait for BUSY to deassert during 201011ccc33fSMarcel Ziswiler Virtex II FPGA configuration. The default is 5 ms. 2011c609719bSwdenk 20126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_CONFIG 2013c609719bSwdenk 2014c609719bSwdenk Time to wait after FPGA configuration. The default is 201511ccc33fSMarcel Ziswiler 200 ms. 2016c609719bSwdenk 2017c609719bSwdenk- Configuration Management: 2018c609719bSwdenk CONFIG_IDENT_STRING 2019c609719bSwdenk 2020c609719bSwdenk If defined, this string will be added to the U-Boot 2021c609719bSwdenk version information (U_BOOT_VERSION) 2022c609719bSwdenk 2023c609719bSwdenk- Vendor Parameter Protection: 2024c609719bSwdenk 2025c609719bSwdenk U-Boot considers the values of the environment 2026c609719bSwdenk variables "serial#" (Board Serial Number) and 20277152b1d0Swdenk "ethaddr" (Ethernet Address) to be parameters that 2028c609719bSwdenk are set once by the board vendor / manufacturer, and 2029c609719bSwdenk protects these variables from casual modification by 2030c609719bSwdenk the user. Once set, these variables are read-only, 2031c609719bSwdenk and write or delete attempts are rejected. You can 203211ccc33fSMarcel Ziswiler change this behaviour: 2033c609719bSwdenk 2034c609719bSwdenk If CONFIG_ENV_OVERWRITE is #defined in your config 2035c609719bSwdenk file, the write protection for vendor parameters is 203647cd00faSwdenk completely disabled. Anybody can change or delete 2037c609719bSwdenk these parameters. 2038c609719bSwdenk 2039c609719bSwdenk Alternatively, if you #define _both_ CONFIG_ETHADDR 2040c609719bSwdenk _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default 204111ccc33fSMarcel Ziswiler Ethernet address is installed in the environment, 2042c609719bSwdenk which can be changed exactly ONCE by the user. [The 2043c609719bSwdenk serial# is unaffected by this, i. e. it remains 2044c609719bSwdenk read-only.] 2045c609719bSwdenk 2046c609719bSwdenk- Protected RAM: 2047c609719bSwdenk CONFIG_PRAM 2048c609719bSwdenk 2049c609719bSwdenk Define this variable to enable the reservation of 2050c609719bSwdenk "protected RAM", i. e. RAM which is not overwritten 2051c609719bSwdenk by U-Boot. Define CONFIG_PRAM to hold the number of 2052c609719bSwdenk kB you want to reserve for pRAM. You can overwrite 2053c609719bSwdenk this default value by defining an environment 2054c609719bSwdenk variable "pram" to the number of kB you want to 2055c609719bSwdenk reserve. Note that the board info structure will 2056c609719bSwdenk still show the full amount of RAM. If pRAM is 2057c609719bSwdenk reserved, a new environment variable "mem" will 2058c609719bSwdenk automatically be defined to hold the amount of 2059c609719bSwdenk remaining RAM in a form that can be passed as boot 2060c609719bSwdenk argument to Linux, for instance like that: 2061c609719bSwdenk 2062fe126d8bSWolfgang Denk setenv bootargs ... mem=\${mem} 2063c609719bSwdenk saveenv 2064c609719bSwdenk 2065c609719bSwdenk This way you can tell Linux not to use this memory, 2066c609719bSwdenk either, which results in a memory region that will 2067c609719bSwdenk not be affected by reboots. 2068c609719bSwdenk 2069c609719bSwdenk *WARNING* If your board configuration uses automatic 2070c609719bSwdenk detection of the RAM size, you must make sure that 2071c609719bSwdenk this memory test is non-destructive. So far, the 2072c609719bSwdenk following board configurations are known to be 2073c609719bSwdenk "pRAM-clean": 2074c609719bSwdenk 2075c609719bSwdenk ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL, 2076c609719bSwdenk HERMES, IP860, RPXlite, LWMON, LANTEC, 2077544d97e9SWolfgang Denk FLAGADM, TQM8260 2078c609719bSwdenk 2079c609719bSwdenk- Error Recovery: 2080c609719bSwdenk CONFIG_PANIC_HANG 2081c609719bSwdenk 2082c609719bSwdenk Define this variable to stop the system in case of a 2083c609719bSwdenk fatal error, so that you have to reset it manually. 2084c609719bSwdenk This is probably NOT a good idea for an embedded 208511ccc33fSMarcel Ziswiler system where you want the system to reboot 2086c609719bSwdenk automatically as fast as possible, but it may be 2087c609719bSwdenk useful during development since you can try to debug 2088c609719bSwdenk the conditions that lead to the situation. 2089c609719bSwdenk 2090c609719bSwdenk CONFIG_NET_RETRY_COUNT 2091c609719bSwdenk 2092c609719bSwdenk This variable defines the number of retries for 2093c609719bSwdenk network operations like ARP, RARP, TFTP, or BOOTP 2094c609719bSwdenk before giving up the operation. If not defined, a 2095c609719bSwdenk default value of 5 is used. 2096c609719bSwdenk 209740cb90eeSGuennadi Liakhovetski CONFIG_ARP_TIMEOUT 209840cb90eeSGuennadi Liakhovetski 209940cb90eeSGuennadi Liakhovetski Timeout waiting for an ARP reply in milliseconds. 210040cb90eeSGuennadi Liakhovetski 2101c609719bSwdenk- Command Interpreter: 21028078f1a5SWolfgang Denk CONFIG_AUTO_COMPLETE 210304a85b3bSwdenk 210404a85b3bSwdenk Enable auto completion of commands using TAB. 210504a85b3bSwdenk 21068078f1a5SWolfgang Denk Note that this feature has NOT been implemented yet 21078078f1a5SWolfgang Denk for the "hush" shell. 21088078f1a5SWolfgang Denk 21098078f1a5SWolfgang Denk 21106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_HUSH_PARSER 2111c609719bSwdenk 2112c609719bSwdenk Define this variable to enable the "hush" shell (from 2113c609719bSwdenk Busybox) as command line interpreter, thus enabling 2114c609719bSwdenk powerful command line syntax like 2115c609719bSwdenk if...then...else...fi conditionals or `&&' and '||' 2116c609719bSwdenk constructs ("shell scripts"). 2117c609719bSwdenk 2118c609719bSwdenk If undefined, you get the old, much simpler behaviour 2119c609719bSwdenk with a somewhat smaller memory footprint. 2120c609719bSwdenk 2121c609719bSwdenk 21226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PROMPT_HUSH_PS2 2123c609719bSwdenk 2124c609719bSwdenk This defines the secondary prompt string, which is 2125c609719bSwdenk printed when the command interpreter needs more input 2126c609719bSwdenk to complete a command. Usually "> ". 2127c609719bSwdenk 2128c609719bSwdenk Note: 2129c609719bSwdenk 2130c609719bSwdenk In the current implementation, the local variables 2131c609719bSwdenk space and global environment variables space are 2132c609719bSwdenk separated. Local variables are those you define by 21333b57fe0aSwdenk simply typing `name=value'. To access a local 2134c609719bSwdenk variable later on, you have write `$name' or 21353b57fe0aSwdenk `${name}'; to execute the contents of a variable 21363b57fe0aSwdenk directly type `$name' at the command prompt. 2137c609719bSwdenk 2138c609719bSwdenk Global environment variables are those you use 2139c609719bSwdenk setenv/printenv to work with. To run a command stored 2140c609719bSwdenk in such a variable, you need to use the run command, 2141c609719bSwdenk and you must not use the '$' sign to access them. 2142c609719bSwdenk 2143c609719bSwdenk To store commands and special characters in a 2144c609719bSwdenk variable, please use double quotation marks 2145c609719bSwdenk surrounding the whole text of the variable, instead 2146c609719bSwdenk of the backslashes before semicolons and special 2147c609719bSwdenk symbols. 2148c609719bSwdenk 2149aa0c71acSWolfgang Denk- Commandline Editing and History: 2150aa0c71acSWolfgang Denk CONFIG_CMDLINE_EDITING 2151aa0c71acSWolfgang Denk 215211ccc33fSMarcel Ziswiler Enable editing and History functions for interactive 2153aa0c71acSWolfgang Denk commandline input operations 2154aa0c71acSWolfgang Denk 2155a8c7c708Swdenk- Default Environment: 2156c609719bSwdenk CONFIG_EXTRA_ENV_SETTINGS 2157c609719bSwdenk 2158c609719bSwdenk Define this to contain any number of null terminated 2159c609719bSwdenk strings (variable = value pairs) that will be part of 21607152b1d0Swdenk the default environment compiled into the boot image. 21612262cfeeSwdenk 2162c609719bSwdenk For example, place something like this in your 2163c609719bSwdenk board's config file: 2164c609719bSwdenk 2165c609719bSwdenk #define CONFIG_EXTRA_ENV_SETTINGS \ 2166c609719bSwdenk "myvar1=value1\0" \ 2167c609719bSwdenk "myvar2=value2\0" 2168c609719bSwdenk 2169c609719bSwdenk Warning: This method is based on knowledge about the 2170c609719bSwdenk internal format how the environment is stored by the 21712262cfeeSwdenk U-Boot code. This is NOT an official, exported 2172c609719bSwdenk interface! Although it is unlikely that this format 21737152b1d0Swdenk will change soon, there is no guarantee either. 2174c609719bSwdenk You better know what you are doing here. 2175c609719bSwdenk 2176c609719bSwdenk Note: overly (ab)use of the default environment is 2177c609719bSwdenk discouraged. Make sure to check other ways to preset 217874de7aefSWolfgang Denk the environment like the "source" command or the 2179c609719bSwdenk boot command first. 2180c609719bSwdenk 2181a8c7c708Swdenk- DataFlash Support: 21822abbe075Swdenk CONFIG_HAS_DATAFLASH 21832abbe075Swdenk 21842abbe075Swdenk Defining this option enables DataFlash features and 21852abbe075Swdenk allows to read/write in Dataflash via the standard 21862abbe075Swdenk commands cp, md... 21872abbe075Swdenk 2188f61ec45eSEric Nelson- Serial Flash support 2189f61ec45eSEric Nelson CONFIG_CMD_SF 2190f61ec45eSEric Nelson 2191f61ec45eSEric Nelson Defining this option enables SPI flash commands 2192f61ec45eSEric Nelson 'sf probe/read/write/erase/update'. 2193f61ec45eSEric Nelson 2194f61ec45eSEric Nelson Usage requires an initial 'probe' to define the serial 2195f61ec45eSEric Nelson flash parameters, followed by read/write/erase/update 2196f61ec45eSEric Nelson commands. 2197f61ec45eSEric Nelson 2198f61ec45eSEric Nelson The following defaults may be provided by the platform 2199f61ec45eSEric Nelson to handle the common case when only a single serial 2200f61ec45eSEric Nelson flash is present on the system. 2201f61ec45eSEric Nelson 2202f61ec45eSEric Nelson CONFIG_SF_DEFAULT_BUS Bus identifier 2203f61ec45eSEric Nelson CONFIG_SF_DEFAULT_CS Chip-select 2204f61ec45eSEric Nelson CONFIG_SF_DEFAULT_MODE (see include/spi.h) 2205f61ec45eSEric Nelson CONFIG_SF_DEFAULT_SPEED in Hz 2206f61ec45eSEric Nelson 22073f85ce27Swdenk- SystemACE Support: 22083f85ce27Swdenk CONFIG_SYSTEMACE 22093f85ce27Swdenk 22103f85ce27Swdenk Adding this option adds support for Xilinx SystemACE 22113f85ce27Swdenk chips attached via some sort of local bus. The address 221211ccc33fSMarcel Ziswiler of the chip must also be defined in the 22136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SYSTEMACE_BASE macro. For example: 22143f85ce27Swdenk 22153f85ce27Swdenk #define CONFIG_SYSTEMACE 22166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000 22173f85ce27Swdenk 22183f85ce27Swdenk When SystemACE support is added, the "ace" device type 22193f85ce27Swdenk becomes available to the fat commands, i.e. fatls. 22203f85ce27Swdenk 2221ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port: 2222ecb0ccd9SWolfgang Denk CONFIG_TFTP_PORT 2223ecb0ccd9SWolfgang Denk 222428cb9375SWolfgang Denk If this is defined, the environment variable tftpsrcp 2225ecb0ccd9SWolfgang Denk is used to supply the TFTP UDP source port value. 222628cb9375SWolfgang Denk If tftpsrcp isn't defined, the normal pseudo-random port 2227ecb0ccd9SWolfgang Denk number generator is used. 2228ecb0ccd9SWolfgang Denk 222928cb9375SWolfgang Denk Also, the environment variable tftpdstp is used to supply 223028cb9375SWolfgang Denk the TFTP UDP destination port value. If tftpdstp isn't 223128cb9375SWolfgang Denk defined, the normal port 69 is used. 223228cb9375SWolfgang Denk 223328cb9375SWolfgang Denk The purpose for tftpsrcp is to allow a TFTP server to 2234ecb0ccd9SWolfgang Denk blindly start the TFTP transfer using the pre-configured 2235ecb0ccd9SWolfgang Denk target IP address and UDP port. This has the effect of 2236ecb0ccd9SWolfgang Denk "punching through" the (Windows XP) firewall, allowing 2237ecb0ccd9SWolfgang Denk the remainder of the TFTP transfer to proceed normally. 2238ecb0ccd9SWolfgang Denk A better solution is to properly configure the firewall, 2239ecb0ccd9SWolfgang Denk but sometimes that is not allowed. 2240ecb0ccd9SWolfgang Denk 2241a8c7c708Swdenk- Show boot progress: 2242c609719bSwdenk CONFIG_SHOW_BOOT_PROGRESS 2243c609719bSwdenk 2244c609719bSwdenk Defining this option allows to add some board- 2245c609719bSwdenk specific code (calling a user-provided function 2246c609719bSwdenk "show_boot_progress(int)") that enables you to show 2247c609719bSwdenk the system's boot progress on some display (for 2248c609719bSwdenk example, some LED's) on your board. At the moment, 2249c609719bSwdenk the following checkpoints are implemented: 2250c609719bSwdenk 22513a608ca0SSimon Glass- Detailed boot stage timing 22523a608ca0SSimon Glass CONFIG_BOOTSTAGE 22533a608ca0SSimon Glass Define this option to get detailed timing of each stage 22543a608ca0SSimon Glass of the boot process. 22553a608ca0SSimon Glass 22563a608ca0SSimon Glass CONFIG_BOOTSTAGE_USER_COUNT 22573a608ca0SSimon Glass This is the number of available user bootstage records. 22583a608ca0SSimon Glass Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...) 22593a608ca0SSimon Glass a new ID will be allocated from this stash. If you exceed 22603a608ca0SSimon Glass the limit, recording will stop. 22613a608ca0SSimon Glass 22623a608ca0SSimon Glass CONFIG_BOOTSTAGE_REPORT 22633a608ca0SSimon Glass Define this to print a report before boot, similar to this: 22643a608ca0SSimon Glass 22653a608ca0SSimon Glass Timer summary in microseconds: 22663a608ca0SSimon Glass Mark Elapsed Stage 22673a608ca0SSimon Glass 0 0 reset 22683a608ca0SSimon Glass 3,575,678 3,575,678 board_init_f start 22693a608ca0SSimon Glass 3,575,695 17 arch_cpu_init A9 22703a608ca0SSimon Glass 3,575,777 82 arch_cpu_init done 22713a608ca0SSimon Glass 3,659,598 83,821 board_init_r start 22723a608ca0SSimon Glass 3,910,375 250,777 main_loop 22733a608ca0SSimon Glass 29,916,167 26,005,792 bootm_start 22743a608ca0SSimon Glass 30,361,327 445,160 start_kernel 22753a608ca0SSimon Glass 22761372cce2SMarian BalakowiczLegacy uImage format: 22771372cce2SMarian Balakowicz 2278c609719bSwdenk Arg Where When 2279c609719bSwdenk 1 common/cmd_bootm.c before attempting to boot an image 2280c609719bSwdenk -1 common/cmd_bootm.c Image header has bad magic number 2281c609719bSwdenk 2 common/cmd_bootm.c Image header has correct magic number 2282c609719bSwdenk -2 common/cmd_bootm.c Image header has bad checksum 2283c609719bSwdenk 3 common/cmd_bootm.c Image header has correct checksum 2284c609719bSwdenk -3 common/cmd_bootm.c Image data has bad checksum 2285c609719bSwdenk 4 common/cmd_bootm.c Image data has correct checksum 2286c609719bSwdenk -4 common/cmd_bootm.c Image is for unsupported architecture 2287c609719bSwdenk 5 common/cmd_bootm.c Architecture check OK 22881372cce2SMarian Balakowicz -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi) 2289c609719bSwdenk 6 common/cmd_bootm.c Image Type check OK 2290c609719bSwdenk -6 common/cmd_bootm.c gunzip uncompression error 2291c609719bSwdenk -7 common/cmd_bootm.c Unimplemented compression type 2292c609719bSwdenk 7 common/cmd_bootm.c Uncompression OK 22931372cce2SMarian Balakowicz 8 common/cmd_bootm.c No uncompress/copy overwrite error 2294c609719bSwdenk -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX) 22951372cce2SMarian Balakowicz 22961372cce2SMarian Balakowicz 9 common/image.c Start initial ramdisk verification 22971372cce2SMarian Balakowicz -10 common/image.c Ramdisk header has bad magic number 22981372cce2SMarian Balakowicz -11 common/image.c Ramdisk header has bad checksum 22991372cce2SMarian Balakowicz 10 common/image.c Ramdisk header is OK 23001372cce2SMarian Balakowicz -12 common/image.c Ramdisk data has bad checksum 23011372cce2SMarian Balakowicz 11 common/image.c Ramdisk data has correct checksum 23021372cce2SMarian Balakowicz 12 common/image.c Ramdisk verification complete, start loading 230311ccc33fSMarcel Ziswiler -13 common/image.c Wrong Image Type (not PPC Linux ramdisk) 23041372cce2SMarian Balakowicz 13 common/image.c Start multifile image verification 23051372cce2SMarian Balakowicz 14 common/image.c No initial ramdisk, no multifile, continue. 23061372cce2SMarian Balakowicz 2307ea0364f1SPeter Tyser 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS 2308c609719bSwdenk 2309a47a12beSStefan Roese -30 arch/powerpc/lib/board.c Fatal error, hang the system 231063e73c9aSwdenk -31 post/post.c POST test failed, detected by post_output_backlog() 231163e73c9aSwdenk -32 post/post.c POST test failed, detected by post_run_single() 231263e73c9aSwdenk 2313566a494fSHeiko Schocher 34 common/cmd_doc.c before loading a Image from a DOC device 2314566a494fSHeiko Schocher -35 common/cmd_doc.c Bad usage of "doc" command 2315566a494fSHeiko Schocher 35 common/cmd_doc.c correct usage of "doc" command 2316566a494fSHeiko Schocher -36 common/cmd_doc.c No boot device 2317566a494fSHeiko Schocher 36 common/cmd_doc.c correct boot device 2318566a494fSHeiko Schocher -37 common/cmd_doc.c Unknown Chip ID on boot device 2319566a494fSHeiko Schocher 37 common/cmd_doc.c correct chip ID found, device available 2320566a494fSHeiko Schocher -38 common/cmd_doc.c Read Error on boot device 2321566a494fSHeiko Schocher 38 common/cmd_doc.c reading Image header from DOC device OK 2322566a494fSHeiko Schocher -39 common/cmd_doc.c Image header has bad magic number 2323566a494fSHeiko Schocher 39 common/cmd_doc.c Image header has correct magic number 2324566a494fSHeiko Schocher -40 common/cmd_doc.c Error reading Image from DOC device 2325566a494fSHeiko Schocher 40 common/cmd_doc.c Image header has correct magic number 2326566a494fSHeiko Schocher 41 common/cmd_ide.c before loading a Image from a IDE device 2327566a494fSHeiko Schocher -42 common/cmd_ide.c Bad usage of "ide" command 2328566a494fSHeiko Schocher 42 common/cmd_ide.c correct usage of "ide" command 2329566a494fSHeiko Schocher -43 common/cmd_ide.c No boot device 2330566a494fSHeiko Schocher 43 common/cmd_ide.c boot device found 2331566a494fSHeiko Schocher -44 common/cmd_ide.c Device not available 2332566a494fSHeiko Schocher 44 common/cmd_ide.c Device available 2333566a494fSHeiko Schocher -45 common/cmd_ide.c wrong partition selected 2334566a494fSHeiko Schocher 45 common/cmd_ide.c partition selected 2335566a494fSHeiko Schocher -46 common/cmd_ide.c Unknown partition table 2336566a494fSHeiko Schocher 46 common/cmd_ide.c valid partition table found 2337566a494fSHeiko Schocher -47 common/cmd_ide.c Invalid partition type 2338566a494fSHeiko Schocher 47 common/cmd_ide.c correct partition type 2339566a494fSHeiko Schocher -48 common/cmd_ide.c Error reading Image Header on boot device 2340566a494fSHeiko Schocher 48 common/cmd_ide.c reading Image Header from IDE device OK 2341566a494fSHeiko Schocher -49 common/cmd_ide.c Image header has bad magic number 2342566a494fSHeiko Schocher 49 common/cmd_ide.c Image header has correct magic number 2343566a494fSHeiko Schocher -50 common/cmd_ide.c Image header has bad checksum 2344566a494fSHeiko Schocher 50 common/cmd_ide.c Image header has correct checksum 2345566a494fSHeiko Schocher -51 common/cmd_ide.c Error reading Image from IDE device 2346566a494fSHeiko Schocher 51 common/cmd_ide.c reading Image from IDE device OK 2347566a494fSHeiko Schocher 52 common/cmd_nand.c before loading a Image from a NAND device 2348566a494fSHeiko Schocher -53 common/cmd_nand.c Bad usage of "nand" command 2349566a494fSHeiko Schocher 53 common/cmd_nand.c correct usage of "nand" command 2350566a494fSHeiko Schocher -54 common/cmd_nand.c No boot device 2351566a494fSHeiko Schocher 54 common/cmd_nand.c boot device found 2352566a494fSHeiko Schocher -55 common/cmd_nand.c Unknown Chip ID on boot device 2353566a494fSHeiko Schocher 55 common/cmd_nand.c correct chip ID found, device available 2354566a494fSHeiko Schocher -56 common/cmd_nand.c Error reading Image Header on boot device 2355566a494fSHeiko Schocher 56 common/cmd_nand.c reading Image Header from NAND device OK 2356566a494fSHeiko Schocher -57 common/cmd_nand.c Image header has bad magic number 2357566a494fSHeiko Schocher 57 common/cmd_nand.c Image header has correct magic number 2358566a494fSHeiko Schocher -58 common/cmd_nand.c Error reading Image from NAND device 2359566a494fSHeiko Schocher 58 common/cmd_nand.c reading Image from NAND device OK 2360c609719bSwdenk 2361566a494fSHeiko Schocher -60 common/env_common.c Environment has a bad CRC, using default 2362c609719bSwdenk 2363566a494fSHeiko Schocher 64 net/eth.c starting with Ethernet configuration. 2364566a494fSHeiko Schocher -64 net/eth.c no Ethernet found. 2365566a494fSHeiko Schocher 65 net/eth.c Ethernet found. 2366206c60cbSwdenk 2367566a494fSHeiko Schocher -80 common/cmd_net.c usage wrong 2368566a494fSHeiko Schocher 80 common/cmd_net.c before calling NetLoop() 236911ccc33fSMarcel Ziswiler -81 common/cmd_net.c some error in NetLoop() occurred 2370566a494fSHeiko Schocher 81 common/cmd_net.c NetLoop() back without error 2371566a494fSHeiko Schocher -82 common/cmd_net.c size == 0 (File with size 0 loaded) 2372566a494fSHeiko Schocher 82 common/cmd_net.c trying automatic boot 237374de7aefSWolfgang Denk 83 common/cmd_net.c running "source" command 237474de7aefSWolfgang Denk -83 common/cmd_net.c some error in automatic boot or "source" command 2375566a494fSHeiko Schocher 84 common/cmd_net.c end without errors 2376c609719bSwdenk 23771372cce2SMarian BalakowiczFIT uImage format: 23781372cce2SMarian Balakowicz 23791372cce2SMarian Balakowicz Arg Where When 23801372cce2SMarian Balakowicz 100 common/cmd_bootm.c Kernel FIT Image has correct format 23811372cce2SMarian Balakowicz -100 common/cmd_bootm.c Kernel FIT Image has incorrect format 23821372cce2SMarian Balakowicz 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration 23831372cce2SMarian Balakowicz -101 common/cmd_bootm.c Can't get configuration for kernel subimage 23841372cce2SMarian Balakowicz 102 common/cmd_bootm.c Kernel unit name specified 23851372cce2SMarian Balakowicz -103 common/cmd_bootm.c Can't get kernel subimage node offset 2386f773bea8SMarian Balakowicz 103 common/cmd_bootm.c Found configuration node 23871372cce2SMarian Balakowicz 104 common/cmd_bootm.c Got kernel subimage node offset 23881372cce2SMarian Balakowicz -104 common/cmd_bootm.c Kernel subimage hash verification failed 23891372cce2SMarian Balakowicz 105 common/cmd_bootm.c Kernel subimage hash verification OK 23901372cce2SMarian Balakowicz -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture 23911372cce2SMarian Balakowicz 106 common/cmd_bootm.c Architecture check OK 239211ccc33fSMarcel Ziswiler -106 common/cmd_bootm.c Kernel subimage has wrong type 239311ccc33fSMarcel Ziswiler 107 common/cmd_bootm.c Kernel subimage type OK 23941372cce2SMarian Balakowicz -107 common/cmd_bootm.c Can't get kernel subimage data/size 23951372cce2SMarian Balakowicz 108 common/cmd_bootm.c Got kernel subimage data/size 23961372cce2SMarian Balakowicz -108 common/cmd_bootm.c Wrong image type (not legacy, FIT) 23971372cce2SMarian Balakowicz -109 common/cmd_bootm.c Can't get kernel subimage type 23981372cce2SMarian Balakowicz -110 common/cmd_bootm.c Can't get kernel subimage comp 23991372cce2SMarian Balakowicz -111 common/cmd_bootm.c Can't get kernel subimage os 24001372cce2SMarian Balakowicz -112 common/cmd_bootm.c Can't get kernel subimage load address 24011372cce2SMarian Balakowicz -113 common/cmd_bootm.c Image uncompress/copy overwrite error 24021372cce2SMarian Balakowicz 24031372cce2SMarian Balakowicz 120 common/image.c Start initial ramdisk verification 24041372cce2SMarian Balakowicz -120 common/image.c Ramdisk FIT image has incorrect format 24051372cce2SMarian Balakowicz 121 common/image.c Ramdisk FIT image has correct format 240611ccc33fSMarcel Ziswiler 122 common/image.c No ramdisk subimage unit name, using configuration 24071372cce2SMarian Balakowicz -122 common/image.c Can't get configuration for ramdisk subimage 24081372cce2SMarian Balakowicz 123 common/image.c Ramdisk unit name specified 24091372cce2SMarian Balakowicz -124 common/image.c Can't get ramdisk subimage node offset 24101372cce2SMarian Balakowicz 125 common/image.c Got ramdisk subimage node offset 24111372cce2SMarian Balakowicz -125 common/image.c Ramdisk subimage hash verification failed 24121372cce2SMarian Balakowicz 126 common/image.c Ramdisk subimage hash verification OK 24131372cce2SMarian Balakowicz -126 common/image.c Ramdisk subimage for unsupported architecture 24141372cce2SMarian Balakowicz 127 common/image.c Architecture check OK 24151372cce2SMarian Balakowicz -127 common/image.c Can't get ramdisk subimage data/size 24161372cce2SMarian Balakowicz 128 common/image.c Got ramdisk subimage data/size 24171372cce2SMarian Balakowicz 129 common/image.c Can't get ramdisk load address 24181372cce2SMarian Balakowicz -129 common/image.c Got ramdisk load address 24191372cce2SMarian Balakowicz 242011ccc33fSMarcel Ziswiler -130 common/cmd_doc.c Incorrect FIT image format 24211372cce2SMarian Balakowicz 131 common/cmd_doc.c FIT image format OK 24221372cce2SMarian Balakowicz 242311ccc33fSMarcel Ziswiler -140 common/cmd_ide.c Incorrect FIT image format 24241372cce2SMarian Balakowicz 141 common/cmd_ide.c FIT image format OK 24251372cce2SMarian Balakowicz 242611ccc33fSMarcel Ziswiler -150 common/cmd_nand.c Incorrect FIT image format 24271372cce2SMarian Balakowicz 151 common/cmd_nand.c FIT image format OK 24281372cce2SMarian Balakowicz 24294cf2609bSWolfgang Denk- Standalone program support: 24304cf2609bSWolfgang Denk CONFIG_STANDALONE_LOAD_ADDR 24314cf2609bSWolfgang Denk 24326feff899SWolfgang Denk This option defines a board specific value for the 24336feff899SWolfgang Denk address where standalone program gets loaded, thus 24346feff899SWolfgang Denk overwriting the architecture dependent default 24354cf2609bSWolfgang Denk settings. 24364cf2609bSWolfgang Denk 24374cf2609bSWolfgang Denk- Frame Buffer Address: 24384cf2609bSWolfgang Denk CONFIG_FB_ADDR 24394cf2609bSWolfgang Denk 24404cf2609bSWolfgang Denk Define CONFIG_FB_ADDR if you want to use specific 24414cf2609bSWolfgang Denk address for frame buffer. 24424cf2609bSWolfgang Denk Then system will reserve the frame buffer address to 24434cf2609bSWolfgang Denk defined address instead of lcd_setmem (this function 24446feff899SWolfgang Denk grabs the memory for frame buffer by panel's size). 24454cf2609bSWolfgang Denk 24464cf2609bSWolfgang Denk Please see board_init_f function. 24474cf2609bSWolfgang Denk 2448cccfc2abSDetlev Zundel- Automatic software updates via TFTP server 2449cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP 2450cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP_CNT_MAX 2451cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP_MSEC_MAX 2452cccfc2abSDetlev Zundel 2453cccfc2abSDetlev Zundel These options enable and control the auto-update feature; 2454cccfc2abSDetlev Zundel for a more detailed description refer to doc/README.update. 2455cccfc2abSDetlev Zundel 2456cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support) 2457cccfc2abSDetlev Zundel CONFIG_MTD_DEVICE 2458cccfc2abSDetlev Zundel 2459cccfc2abSDetlev Zundel Adds the MTD device infrastructure from the Linux kernel. 2460cccfc2abSDetlev Zundel Needed for mtdparts command support. 2461cccfc2abSDetlev Zundel 2462cccfc2abSDetlev Zundel CONFIG_MTD_PARTITIONS 2463cccfc2abSDetlev Zundel 2464cccfc2abSDetlev Zundel Adds the MTD partitioning infrastructure from the Linux 2465cccfc2abSDetlev Zundel kernel. Needed for UBI support. 2466cccfc2abSDetlev Zundel 24676a11cf48SDaniel Schwierzeck- SPL framework 24686a11cf48SDaniel Schwierzeck CONFIG_SPL 24696a11cf48SDaniel Schwierzeck Enable building of SPL globally. 24706a11cf48SDaniel Schwierzeck 24716a11cf48SDaniel Schwierzeck CONFIG_SPL_TEXT_BASE 24726a11cf48SDaniel Schwierzeck TEXT_BASE for linking the SPL binary. 24736a11cf48SDaniel Schwierzeck 24746a11cf48SDaniel Schwierzeck CONFIG_SPL_LDSCRIPT 24756a11cf48SDaniel Schwierzeck LDSCRIPT for linking the SPL binary. 24766a11cf48SDaniel Schwierzeck 24776a11cf48SDaniel Schwierzeck CONFIG_SPL_LIBCOMMON_SUPPORT 24786a11cf48SDaniel Schwierzeck Support for common/libcommon.o in SPL binary 24796a11cf48SDaniel Schwierzeck 24806a11cf48SDaniel Schwierzeck CONFIG_SPL_LIBDISK_SUPPORT 24816a11cf48SDaniel Schwierzeck Support for disk/libdisk.o in SPL binary 24826a11cf48SDaniel Schwierzeck 24836a11cf48SDaniel Schwierzeck CONFIG_SPL_I2C_SUPPORT 24846a11cf48SDaniel Schwierzeck Support for drivers/i2c/libi2c.o in SPL binary 24856a11cf48SDaniel Schwierzeck 24866a11cf48SDaniel Schwierzeck CONFIG_SPL_GPIO_SUPPORT 24876a11cf48SDaniel Schwierzeck Support for drivers/gpio/libgpio.o in SPL binary 24886a11cf48SDaniel Schwierzeck 24896a11cf48SDaniel Schwierzeck CONFIG_SPL_MMC_SUPPORT 24906a11cf48SDaniel Schwierzeck Support for drivers/mmc/libmmc.o in SPL binary 24916a11cf48SDaniel Schwierzeck 24926a11cf48SDaniel Schwierzeck CONFIG_SPL_SERIAL_SUPPORT 24936a11cf48SDaniel Schwierzeck Support for drivers/serial/libserial.o in SPL binary 24946a11cf48SDaniel Schwierzeck 24956a11cf48SDaniel Schwierzeck CONFIG_SPL_SPI_FLASH_SUPPORT 24966a11cf48SDaniel Schwierzeck Support for drivers/mtd/spi/libspi_flash.o in SPL binary 24976a11cf48SDaniel Schwierzeck 24986a11cf48SDaniel Schwierzeck CONFIG_SPL_SPI_SUPPORT 24996a11cf48SDaniel Schwierzeck Support for drivers/spi/libspi.o in SPL binary 25006a11cf48SDaniel Schwierzeck 25016a11cf48SDaniel Schwierzeck CONFIG_SPL_FAT_SUPPORT 25026a11cf48SDaniel Schwierzeck Support for fs/fat/libfat.o in SPL binary 25036a11cf48SDaniel Schwierzeck 25046a11cf48SDaniel Schwierzeck CONFIG_SPL_LIBGENERIC_SUPPORT 25056a11cf48SDaniel Schwierzeck Support for lib/libgeneric.o in SPL binary 25061372cce2SMarian Balakowicz 2507c609719bSwdenkModem Support: 2508c609719bSwdenk-------------- 2509c609719bSwdenk 2510566e5cf4SWolfgang Denk[so far only for SMDK2400 boards] 2511c609719bSwdenk 251211ccc33fSMarcel Ziswiler- Modem support enable: 2513c609719bSwdenk CONFIG_MODEM_SUPPORT 2514c609719bSwdenk 2515c609719bSwdenk- RTS/CTS Flow control enable: 2516c609719bSwdenk CONFIG_HWFLOW 2517c609719bSwdenk 2518c609719bSwdenk- Modem debug support: 2519c609719bSwdenk CONFIG_MODEM_SUPPORT_DEBUG 2520c609719bSwdenk 2521c609719bSwdenk Enables debugging stuff (char screen[1024], dbg()) 2522c609719bSwdenk for modem support. Useful only with BDI2000. 2523c609719bSwdenk 2524a8c7c708Swdenk- Interrupt support (PPC): 2525a8c7c708Swdenk 2526a8c7c708Swdenk There are common interrupt_init() and timer_interrupt() 2527a8c7c708Swdenk for all PPC archs. interrupt_init() calls interrupt_init_cpu() 252811ccc33fSMarcel Ziswiler for CPU specific initialization. interrupt_init_cpu() 2529a8c7c708Swdenk should set decrementer_count to appropriate value. If 253011ccc33fSMarcel Ziswiler CPU resets decrementer automatically after interrupt 2531a8c7c708Swdenk (ppc4xx) it should set decrementer_count to zero. 253211ccc33fSMarcel Ziswiler timer_interrupt() calls timer_interrupt_cpu() for CPU 2533a8c7c708Swdenk specific handling. If board has watchdog / status_led 2534a8c7c708Swdenk / other_activity_monitor it works automatically from 2535a8c7c708Swdenk general timer_interrupt(). 2536a8c7c708Swdenk 2537c609719bSwdenk- General: 2538c609719bSwdenk 2539c609719bSwdenk In the target system modem support is enabled when a 2540c609719bSwdenk specific key (key combination) is pressed during 2541c609719bSwdenk power-on. Otherwise U-Boot will boot normally 254211ccc33fSMarcel Ziswiler (autoboot). The key_pressed() function is called from 2543c609719bSwdenk board_init(). Currently key_pressed() is a dummy 2544c609719bSwdenk function, returning 1 and thus enabling modem 2545c609719bSwdenk initialization. 2546c609719bSwdenk 2547c609719bSwdenk If there are no modem init strings in the 2548c609719bSwdenk environment, U-Boot proceed to autoboot; the 2549c609719bSwdenk previous output (banner, info printfs) will be 255011ccc33fSMarcel Ziswiler suppressed, though. 2551c609719bSwdenk 2552c609719bSwdenk See also: doc/README.Modem 2553c609719bSwdenk 25549660e442SHelmut RaigerBoard initialization settings: 25559660e442SHelmut Raiger------------------------------ 25569660e442SHelmut Raiger 25579660e442SHelmut RaigerDuring Initialization u-boot calls a number of board specific functions 25589660e442SHelmut Raigerto allow the preparation of board specific prerequisites, e.g. pin setup 25599660e442SHelmut Raigerbefore drivers are initialized. To enable these callbacks the 25609660e442SHelmut Raigerfollowing configuration macros have to be defined. Currently this is 25619660e442SHelmut Raigerarchitecture specific, so please check arch/your_architecture/lib/board.c 25629660e442SHelmut Raigertypically in board_init_f() and board_init_r(). 25639660e442SHelmut Raiger 25649660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f() 25659660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r() 25669660e442SHelmut Raiger- CONFIG_BOARD_LATE_INIT: Call board_late_init() 25679660e442SHelmut Raiger- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init() 2568c609719bSwdenk 2569c609719bSwdenkConfiguration Settings: 2570c609719bSwdenk----------------------- 2571c609719bSwdenk 25726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included; 2573c609719bSwdenk undefine this when you're short of memory. 2574c609719bSwdenk 25752fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default 25762fb2604dSPeter Tyser width of the commands listed in the 'help' command output. 25772fb2604dSPeter Tyser 25786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to 2579c609719bSwdenk prompt for user input. 2580c609719bSwdenk 25816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE: Buffer size for input from the Console 2582c609719bSwdenk 25836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE: Buffer size for Console output 2584c609719bSwdenk 25856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands 2586c609719bSwdenk 25876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to 2588c609719bSwdenk the application (usually a Linux kernel) when it is 2589c609719bSwdenk booted 2590c609719bSwdenk 25916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE: 2592c609719bSwdenk List of legal baudrate settings for this board. 2593c609719bSwdenk 25946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET 2595c609719bSwdenk Suppress display of console information at boot. 2596c609719bSwdenk 25976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV 2598c609719bSwdenk If the board specific function 2599c609719bSwdenk extern int overwrite_console (void); 2600c609719bSwdenk returns 1, the stdin, stderr and stdout are switched to the 2601c609719bSwdenk serial port, else the settings in the environment are used. 2602c609719bSwdenk 26036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE 2604c609719bSwdenk Enable the call to overwrite_console(). 2605c609719bSwdenk 26066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE 2607c609719bSwdenk Enable overwrite of previous console environment settings. 2608c609719bSwdenk 26096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END: 2610c609719bSwdenk Begin and End addresses of the area used by the 2611c609719bSwdenk simple memory test. 2612c609719bSwdenk 26136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST: 2614c609719bSwdenk Enable an alternate, more extensive memory test. 2615c609719bSwdenk 26166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH: 26175f535fe1Swdenk Scratch address used by the alternate memory test 26185f535fe1Swdenk You only need to set this if address zero isn't writeable 26195f535fe1Swdenk 26206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only): 26216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header, 262214f73ca6SStefan Roese this specified memory area will get subtracted from the top 262311ccc33fSMarcel Ziswiler (end) of RAM and won't get "touched" at all by U-Boot. By 262414f73ca6SStefan Roese fixing up gd->ram_size the Linux kernel should gets passed 262514f73ca6SStefan Roese the now "corrected" memory size and won't touch it either. 262614f73ca6SStefan Roese This should work for arch/ppc and arch/powerpc. Only Linux 26275e12e75dSStefan Roese board ports in arch/powerpc with bootwrapper support that 262814f73ca6SStefan Roese recalculate the memory size from the SDRAM controller setup 26295e12e75dSStefan Roese will have to get fixed in Linux additionally. 263014f73ca6SStefan Roese 263114f73ca6SStefan Roese This option can be used as a workaround for the 440EPx/GRx 263214f73ca6SStefan Roese CHIP 11 errata where the last 256 bytes in SDRAM shouldn't 263314f73ca6SStefan Roese be touched. 263414f73ca6SStefan Roese 263514f73ca6SStefan Roese WARNING: Please make sure that this value is a multiple of 263614f73ca6SStefan Roese the Linux page size (normally 4k). If this is not the case, 263714f73ca6SStefan Roese then the end address of the Linux memory will be located at a 263814f73ca6SStefan Roese non page size aligned address and this could cause major 263914f73ca6SStefan Roese problems. 264014f73ca6SStefan Roese 26416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TFTP_LOADADDR: 2642c609719bSwdenk Default load address for network file downloads 2643c609719bSwdenk 26446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE: 2645c609719bSwdenk Enable temporary baudrate change while serial download 2646c609719bSwdenk 26476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE: 2648c609719bSwdenk Physical start address of SDRAM. _Must_ be 0 here. 2649c609719bSwdenk 26506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE: 2651c609719bSwdenk Physical start address of Motherboard I/O (if using a 2652c609719bSwdenk Cogent motherboard) 2653c609719bSwdenk 26546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE: 2655c609719bSwdenk Physical start address of Flash memory. 2656c609719bSwdenk 26576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE: 2658c609719bSwdenk Physical start address of boot monitor code (set by 2659c609719bSwdenk make config files to be same as the text base address 266014d0a02aSWolfgang Denk (CONFIG_SYS_TEXT_BASE) used when linking) - same as 26616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FLASH_BASE when booting from flash. 2662c609719bSwdenk 26636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN: 26643b57fe0aSwdenk Size of memory reserved for monitor code, used to 26653b57fe0aSwdenk determine _at_compile_time_ (!) if the environment is 26663b57fe0aSwdenk embedded within the U-Boot image, or in a separate 26673b57fe0aSwdenk flash sector. 2668c609719bSwdenk 26696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN: 2670c609719bSwdenk Size of DRAM reserved for malloc() use. 2671c609719bSwdenk 26726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN: 267315940c9aSStefan Roese Normally compressed uImages are limited to an 267415940c9aSStefan Roese uncompressed size of 8 MBytes. If this is not enough, 26756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD you can define CONFIG_SYS_BOOTM_LEN in your board config file 267615940c9aSStefan Roese to adjust this setting to your needs. 2677c609719bSwdenk 26786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ: 2679c609719bSwdenk Maximum size of memory mapped by the startup code of 2680c609719bSwdenk the Linux kernel; all data that must be processed by 26817d721e34SBartlomiej Sieka the Linux kernel (bd_info, boot arguments, FDT blob if 26827d721e34SBartlomiej Sieka used) must be put below this limit, unless "bootm_low" 26837d721e34SBartlomiej Sieka enviroment variable is defined and non-zero. In such case 26847d721e34SBartlomiej Sieka all data for the Linux kernel must be between "bootm_low" 2685c3624e6eSGrant Likely and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment 2686c3624e6eSGrant Likely variable "bootm_mapsize" will override the value of 2687c3624e6eSGrant Likely CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined, 2688c3624e6eSGrant Likely then the value in "bootm_size" will be used instead. 2689c609719bSwdenk 2690fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH: 2691fca43cc8SJohn Rigby Enable initrd_high functionality. If defined then the 2692fca43cc8SJohn Rigby initrd_high feature is enabled and the bootm ramdisk subcommand 2693fca43cc8SJohn Rigby is enabled. 2694fca43cc8SJohn Rigby 2695fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE: 2696fca43cc8SJohn Rigby Enables allocating and saving kernel cmdline in space between 2697fca43cc8SJohn Rigby "bootm_low" and "bootm_low" + BOOTMAPSZ. 2698fca43cc8SJohn Rigby 2699fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD: 2700fca43cc8SJohn Rigby Enables allocating and saving a kernel copy of the bd_info in 2701fca43cc8SJohn Rigby space between "bootm_low" and "bootm_low" + BOOTMAPSZ. 2702fca43cc8SJohn Rigby 27036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS: 2704c609719bSwdenk Max number of Flash memory banks 2705c609719bSwdenk 27066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT: 2707c609719bSwdenk Max number of sectors on a Flash chip 2708c609719bSwdenk 27096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT: 2710c609719bSwdenk Timeout for Flash erase operations (in ms) 2711c609719bSwdenk 27126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT: 2713c609719bSwdenk Timeout for Flash write operations (in ms) 2714c609719bSwdenk 27156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT 27168564acf9Swdenk Timeout for Flash set sector lock bit operation (in ms) 27178564acf9Swdenk 27186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT 27198564acf9Swdenk Timeout for Flash clear lock bits operation (in ms) 27208564acf9Swdenk 27216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION 27228564acf9Swdenk If defined, hardware flash sectors protection is used 27238564acf9Swdenk instead of U-Boot software protection. 27248564acf9Swdenk 27256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP: 2726c609719bSwdenk 2727c609719bSwdenk Enable TFTP transfers directly to flash memory; 2728c609719bSwdenk without this option such a download has to be 2729c609719bSwdenk performed in two steps: (1) download to RAM, and (2) 2730c609719bSwdenk copy from RAM to flash. 2731c609719bSwdenk 2732c609719bSwdenk The two-step approach is usually more reliable, since 2733c609719bSwdenk you can check if the download worked before you erase 273411ccc33fSMarcel Ziswiler the flash, but in some situations (when system RAM is 273511ccc33fSMarcel Ziswiler too limited to allow for a temporary copy of the 2736c609719bSwdenk downloaded image) this option may be very useful. 2737c609719bSwdenk 27386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI: 2739c609719bSwdenk Define if the flash driver uses extra elements in the 27405653fc33Swdenk common flash structure for storing flash geometry. 27415653fc33Swdenk 274200b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER 27435653fc33Swdenk This option also enables the building of the cfi_flash driver 27445653fc33Swdenk in the drivers directory 274553cf9435Sstroese 274691809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD 274791809ed5SPiotr Ziecik This option enables the building of the cfi_mtd driver 274891809ed5SPiotr Ziecik in the drivers directory. The driver exports CFI flash 274991809ed5SPiotr Ziecik to the MTD layer. 275091809ed5SPiotr Ziecik 27516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE 275296ef831fSGuennadi Liakhovetski Use buffered writes to flash. 275396ef831fSGuennadi Liakhovetski 275496ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N 275596ef831fSGuennadi Liakhovetski s29ws-n MirrorBit flash has non-standard addresses for buffered 275696ef831fSGuennadi Liakhovetski write commands. 275796ef831fSGuennadi Liakhovetski 27586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST 27595568e613SStefan Roese If this option is defined, the common CFI flash doesn't 27605568e613SStefan Roese print it's warning upon not recognized FLASH banks. This 27615568e613SStefan Roese is useful, if some of the configured banks are only 27625568e613SStefan Roese optionally available. 27635568e613SStefan Roese 27649a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS 27659a042e9cSJerry Van Baren If defined (must be an integer), print out countdown 27669a042e9cSJerry Van Baren digits and dots. Recommended value: 45 (9..1) for 80 27679a042e9cSJerry Van Baren column displays, 15 (3..1) for 40 column displays. 27689a042e9cSJerry Van Baren 27696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER: 277011ccc33fSMarcel Ziswiler Defines the number of Ethernet receive buffers. On some 277111ccc33fSMarcel Ziswiler Ethernet controllers it is recommended to set this value 277253cf9435Sstroese to 8 or even higher (EEPRO100 or 405 EMAC), since all 277353cf9435Sstroese buffers can be full shortly after enabling the interface 277411ccc33fSMarcel Ziswiler on high Ethernet traffic. 277553cf9435Sstroese Defaults to 4 if not defined. 2776c609719bSwdenk 2777ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES 2778ea882bafSWolfgang Denk 2779ea882bafSWolfgang Denk Maximum number of entries in the hash table that is used 2780ea882bafSWolfgang Denk internally to store the environment settings. The default 2781ea882bafSWolfgang Denk setting is supposed to be generous and should work in most 2782ea882bafSWolfgang Denk cases. This setting can be used to tune behaviour; see 2783ea882bafSWolfgang Denk lib/hashtable.c for details. 2784ea882bafSWolfgang Denk 2785c609719bSwdenkThe following definitions that deal with the placement and management 2786c609719bSwdenkof environment data (variable area); in general, we support the 2787c609719bSwdenkfollowing configurations: 2788c609719bSwdenk 2789c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC: 2790c3eb3fe4SMike Frysinger 2791c3eb3fe4SMike Frysinger Builds up envcrc with the target environment so that external utils 2792c3eb3fe4SMike Frysinger may easily extract it and embed it in final U-Boot images. 2793c3eb3fe4SMike Frysinger 27945a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH: 2795c609719bSwdenk 2796c609719bSwdenk Define this if the environment is in flash memory. 2797c609719bSwdenk 2798c609719bSwdenk a) The environment occupies one whole flash sector, which is 2799c609719bSwdenk "embedded" in the text segment with the U-Boot code. This 2800c609719bSwdenk happens usually with "bottom boot sector" or "top boot 2801c609719bSwdenk sector" type flash chips, which have several smaller 2802c609719bSwdenk sectors at the start or the end. For instance, such a 2803c609719bSwdenk layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In 2804c609719bSwdenk such a case you would place the environment in one of the 2805c609719bSwdenk 4 kB sectors - with U-Boot code before and after it. With 2806c609719bSwdenk "top boot sector" type flash chips, you would put the 2807c609719bSwdenk environment in one of the last sectors, leaving a gap 2808c609719bSwdenk between U-Boot and the environment. 2809c609719bSwdenk 28100e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 2811c609719bSwdenk 2812c609719bSwdenk Offset of environment data (variable area) to the 2813c609719bSwdenk beginning of flash memory; for instance, with bottom boot 2814c609719bSwdenk type flash chips the second sector can be used: the offset 2815c609719bSwdenk for this sector is given here. 2816c609719bSwdenk 28176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE. 2818c609719bSwdenk 28190e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 2820c609719bSwdenk 2821c609719bSwdenk This is just another way to specify the start address of 2822c609719bSwdenk the flash sector containing the environment (instead of 28230e8d1586SJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_OFFSET). 2824c609719bSwdenk 28250e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SECT_SIZE: 2826c609719bSwdenk 2827c609719bSwdenk Size of the sector containing the environment. 2828c609719bSwdenk 2829c609719bSwdenk 2830c609719bSwdenk b) Sometimes flash chips have few, equal sized, BIG sectors. 2831c609719bSwdenk In such a case you don't want to spend a whole sector for 2832c609719bSwdenk the environment. 2833c609719bSwdenk 28340e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 2835c609719bSwdenk 28365a1aceb0SJean-Christophe PLAGNIOL-VILLARD If you use this in combination with CONFIG_ENV_IS_IN_FLASH 28370e8d1586SJean-Christophe PLAGNIOL-VILLARD and CONFIG_ENV_SECT_SIZE, you can specify to use only a part 2838c609719bSwdenk of this flash sector for the environment. This saves 2839c609719bSwdenk memory for the RAM copy of the environment. 2840c609719bSwdenk 2841c609719bSwdenk It may also save flash memory if you decide to use this 2842c609719bSwdenk when your environment is "embedded" within U-Boot code, 2843c609719bSwdenk since then the remainder of the flash sector could be used 2844c609719bSwdenk for U-Boot code. It should be pointed out that this is 2845c609719bSwdenk STRONGLY DISCOURAGED from a robustness point of view: 2846c609719bSwdenk updating the environment in flash makes it always 2847c609719bSwdenk necessary to erase the WHOLE sector. If something goes 2848c609719bSwdenk wrong before the contents has been restored from a copy in 2849c609719bSwdenk RAM, your target system will be dead. 2850c609719bSwdenk 28510e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR_REDUND 28520e8d1586SJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_SIZE_REDUND 2853c609719bSwdenk 2854c609719bSwdenk These settings describe a second storage area used to hold 285511ccc33fSMarcel Ziswiler a redundant copy of the environment data, so that there is 28563e38691eSwdenk a valid backup copy in case there is a power failure during 2857c609719bSwdenk a "saveenv" operation. 2858c609719bSwdenk 2859c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the 2860c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds* 2861c609719bSwdenkaccordingly! 2862c609719bSwdenk 2863c609719bSwdenk 28649314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM: 2865c609719bSwdenk 2866c609719bSwdenk Define this if you have some non-volatile memory device 2867c609719bSwdenk (NVRAM, battery buffered SRAM) which you want to use for the 2868c609719bSwdenk environment. 2869c609719bSwdenk 28700e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 28710e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 2872c609719bSwdenk 287311ccc33fSMarcel Ziswiler These two #defines are used to determine the memory area you 2874c609719bSwdenk want to use for environment. It is assumed that this memory 2875c609719bSwdenk can just be read and written to, without any special 2876c609719bSwdenk provision. 2877c609719bSwdenk 2878c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early 2879c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the 288011ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or 2881c609719bSwdenkU-Boot will hang. 2882c609719bSwdenk 2883c609719bSwdenkPlease note that even with NVRAM we still use a copy of the 2884c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to 2885c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv" 2886c609719bSwdenkto save the current settings. 2887c609719bSwdenk 2888c609719bSwdenk 2889bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM: 2890c609719bSwdenk 2891c609719bSwdenk Use this if you have an EEPROM or similar serial access 2892c609719bSwdenk device and a driver for it. 2893c609719bSwdenk 28940e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 28950e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 2896c609719bSwdenk 2897c609719bSwdenk These two #defines specify the offset and size of the 2898c609719bSwdenk environment area within the total memory of your EEPROM. 2899c609719bSwdenk 29006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR: 2901c609719bSwdenk If defined, specified the chip address of the EEPROM device. 2902c609719bSwdenk The default address is zero. 2903c609719bSwdenk 29046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS: 2905c609719bSwdenk If defined, the number of bits used to address bytes in a 2906c609719bSwdenk single page in the EEPROM device. A 64 byte page, for example 2907c609719bSwdenk would require six bits. 2908c609719bSwdenk 29096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS: 2910c609719bSwdenk If defined, the number of milliseconds to delay between 2911c609719bSwdenk page writes. The default is zero milliseconds. 2912c609719bSwdenk 29136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR_LEN: 2914c609719bSwdenk The length in bytes of the EEPROM memory array address. Note 2915c609719bSwdenk that this is NOT the chip address length! 2916c609719bSwdenk 29176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW: 29185cf91d6bSwdenk EEPROM chips that implement "address overflow" are ones 29195cf91d6bSwdenk like Catalyst 24WC04/08/16 which has 9/10/11 bits of 29205cf91d6bSwdenk address and the extra bits end up in the "chip address" bit 29215cf91d6bSwdenk slots. This makes a 24WC08 (1Kbyte) chip look like four 256 29225cf91d6bSwdenk byte chips. 29235cf91d6bSwdenk 29245cf91d6bSwdenk Note that we consider the length of the address field to 29255cf91d6bSwdenk still be one byte because the extra address bits are hidden 29265cf91d6bSwdenk in the chip address. 29275cf91d6bSwdenk 29286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_SIZE: 2929c609719bSwdenk The size in bytes of the EEPROM device. 2930c609719bSwdenk 2931548738b4SHeiko Schocher - CONFIG_ENV_EEPROM_IS_ON_I2C 2932548738b4SHeiko Schocher define this, if you have I2C and SPI activated, and your 2933548738b4SHeiko Schocher EEPROM, which holds the environment, is on the I2C bus. 2934548738b4SHeiko Schocher 2935548738b4SHeiko Schocher - CONFIG_I2C_ENV_EEPROM_BUS 2936548738b4SHeiko Schocher if you have an Environment on an EEPROM reached over 2937548738b4SHeiko Schocher I2C muxes, you can define here, how to reach this 2938548738b4SHeiko Schocher EEPROM. For example: 2939548738b4SHeiko Schocher 2940548738b4SHeiko Schocher #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0" 2941548738b4SHeiko Schocher 2942548738b4SHeiko Schocher EEPROM which holds the environment, is reached over 2943548738b4SHeiko Schocher a pca9547 i2c mux with address 0x70, channel 3. 2944c609719bSwdenk 2945057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH: 29465779d8d9Swdenk 29475779d8d9Swdenk Define this if you have a DataFlash memory device which you 29485779d8d9Swdenk want to use for the environment. 29495779d8d9Swdenk 29500e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 29510e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 29520e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 29535779d8d9Swdenk 29545779d8d9Swdenk These three #defines specify the offset and size of the 29555779d8d9Swdenk environment area within the total memory of your DataFlash placed 29565779d8d9Swdenk at the specified address. 29575779d8d9Swdenk 295851bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND: 295913a5695bSwdenk 296013a5695bSwdenk Define this if you have a NAND device which you want to use 296113a5695bSwdenk for the environment. 296213a5695bSwdenk 29630e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 29640e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 296513a5695bSwdenk 296613a5695bSwdenk These two #defines specify the offset and size of the environment 2967fdd813deSScott Wood area within the first NAND device. CONFIG_ENV_OFFSET must be 2968fdd813deSScott Wood aligned to an erase block boundary. 29695779d8d9Swdenk 2970fdd813deSScott Wood - CONFIG_ENV_OFFSET_REDUND (optional): 2971e443c944SMarkus Klotzbuecher 29720e8d1586SJean-Christophe PLAGNIOL-VILLARD This setting describes a second storage area of CONFIG_ENV_SIZE 2973fdd813deSScott Wood size used to hold a redundant copy of the environment data, so 2974fdd813deSScott Wood that there is a valid backup copy in case there is a power failure 2975fdd813deSScott Wood during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be 2976fdd813deSScott Wood aligned to an erase block boundary. 2977e443c944SMarkus Klotzbuecher 2978fdd813deSScott Wood - CONFIG_ENV_RANGE (optional): 2979fdd813deSScott Wood 2980fdd813deSScott Wood Specifies the length of the region in which the environment 2981fdd813deSScott Wood can be written. This should be a multiple of the NAND device's 2982fdd813deSScott Wood block size. Specifying a range with more erase blocks than 2983fdd813deSScott Wood are needed to hold CONFIG_ENV_SIZE allows bad blocks within 2984fdd813deSScott Wood the range to be avoided. 2985fdd813deSScott Wood 2986fdd813deSScott Wood - CONFIG_ENV_OFFSET_OOB (optional): 2987fdd813deSScott Wood 2988fdd813deSScott Wood Enables support for dynamically retrieving the offset of the 2989fdd813deSScott Wood environment from block zero's out-of-band data. The 2990fdd813deSScott Wood "nand env.oob" command can be used to record this offset. 2991fdd813deSScott Wood Currently, CONFIG_ENV_OFFSET_REDUND is not supported when 2992fdd813deSScott Wood using CONFIG_ENV_OFFSET_OOB. 2993e443c944SMarkus Klotzbuecher 2994b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST 2995b74ab737SGuennadi Liakhovetski 2996b74ab737SGuennadi Liakhovetski Defines address in RAM to which the nand_spl code should copy the 2997b74ab737SGuennadi Liakhovetski environment. If redundant environment is used, it will be copied to 2998b74ab737SGuennadi Liakhovetski CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE. 2999b74ab737SGuennadi Liakhovetski 30006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET 3001c609719bSwdenk 3002c609719bSwdenk Defines offset to the initial SPI buffer area in DPRAM. The 3003c609719bSwdenk area is used at an early stage (ROM part) if the environment 3004c609719bSwdenk is configured to reside in the SPI EEPROM: We need a 520 byte 3005c609719bSwdenk scratch DPRAM area. It is used between the two initialization 3006c609719bSwdenk calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems 3007c609719bSwdenk to be a good choice since it makes it far enough from the 3008c609719bSwdenk start of the data area as well as from the stack pointer. 3009c609719bSwdenk 3010e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor 3011c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been 3012cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f() 3013c609719bSwdenkuntil then to read environment variables. 3014c609719bSwdenk 301585ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor 301685ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working 301785ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is 301885ec0bccSwdenknecessary, because the first environment variable we need is the 301985ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't 302085ec0bccSwdenkhave any device yet where we could complain.] 3021c609719bSwdenk 3022c609719bSwdenkNote: once the monitor has been relocated, then it will complain if 3023c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you 302485ec0bccSwdenkuse the "saveenv" command to store a valid environment. 3025c609719bSwdenk 30266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN: 3027fc3e2165Swdenk Echo the inverted Ethernet link state to the fault LED. 3028fc3e2165Swdenk 30296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR 3030fc3e2165Swdenk also needs to be defined. 3031fc3e2165Swdenk 30326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR: 3033fc3e2165Swdenk MII address of the PHY to check for the Ethernet link state. 3034c609719bSwdenk 3035f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS: 3036f5675aa5SRon Madrid Define this if you desire to only have use of the NS16550_init 3037f5675aa5SRon Madrid and NS16550_putc functions for the serial driver located at 3038f5675aa5SRon Madrid drivers/serial/ns16550.c. This option is useful for saving 3039f5675aa5SRon Madrid space for already greatly restricted images, including but not 3040f5675aa5SRon Madrid limited to NAND_SPL configurations. 3041f5675aa5SRon Madrid 3042c609719bSwdenkLow Level (hardware related) configuration options: 3043dc7c9a1aSwdenk--------------------------------------------------- 3044c609719bSwdenk 30456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE: 3046c609719bSwdenk Cache Line Size of the CPU. 3047c609719bSwdenk 30486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR: 3049c609719bSwdenk Default address of the IMMR after system reset. 30502535d602Swdenk 30512535d602Swdenk Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU, 30522535d602Swdenk and RPXsuper) to be able to adjust the position of 30532535d602Swdenk the IMMR register after a reset. 3054c609719bSwdenk 3055e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT: 3056e46fedfeSTimur Tabi Default (power-on reset) physical address of CCSR on Freescale 3057e46fedfeSTimur Tabi PowerPC SOCs. 3058e46fedfeSTimur Tabi 3059e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR: 3060e46fedfeSTimur Tabi Virtual address of CCSR. On a 32-bit build, this is typically 3061e46fedfeSTimur Tabi the same value as CONFIG_SYS_CCSRBAR_DEFAULT. 3062e46fedfeSTimur Tabi 3063e46fedfeSTimur Tabi CONFIG_SYS_DEFAULT_IMMR must also be set to this value, 3064e46fedfeSTimur Tabi for cross-platform code that uses that macro instead. 3065e46fedfeSTimur Tabi 3066e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS: 3067e46fedfeSTimur Tabi Physical address of CCSR. CCSR can be relocated to a new 3068e46fedfeSTimur Tabi physical address, if desired. In this case, this macro should 3069e46fedfeSTimur Tabi be set to that address. Otherwise, it should be set to the 3070e46fedfeSTimur Tabi same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR 3071e46fedfeSTimur Tabi is typically relocated on 36-bit builds. It is recommended 3072e46fedfeSTimur Tabi that this macro be defined via the _HIGH and _LOW macros: 3073e46fedfeSTimur Tabi 3074e46fedfeSTimur Tabi #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH 3075e46fedfeSTimur Tabi * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW) 3076e46fedfeSTimur Tabi 3077e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH: 3078e46fedfeSTimur Tabi Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically 3079e46fedfeSTimur Tabi either 0 (32-bit build) or 0xF (36-bit build). This macro is 3080e46fedfeSTimur Tabi used in assembly code, so it must not contain typecasts or 3081e46fedfeSTimur Tabi integer size suffixes (e.g. "ULL"). 3082e46fedfeSTimur Tabi 3083e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW: 3084e46fedfeSTimur Tabi Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is 3085e46fedfeSTimur Tabi used in assembly code, so it must not contain typecasts or 3086e46fedfeSTimur Tabi integer size suffixes (e.g. "ULL"). 3087e46fedfeSTimur Tabi 3088e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE: 3089e46fedfeSTimur Tabi If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be 3090e46fedfeSTimur Tabi forced to a value that ensures that CCSR is not relocated. 3091e46fedfeSTimur Tabi 30927f6c2cbcSwdenk- Floppy Disk Support: 30936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FDC_DRIVE_NUMBER 30947f6c2cbcSwdenk 30957f6c2cbcSwdenk the default drive number (default value 0) 30967f6c2cbcSwdenk 30976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_ISA_IO_STRIDE 30987f6c2cbcSwdenk 309911ccc33fSMarcel Ziswiler defines the spacing between FDC chipset registers 31007f6c2cbcSwdenk (default value 1) 31017f6c2cbcSwdenk 31026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_ISA_IO_OFFSET 31037f6c2cbcSwdenk 31047f6c2cbcSwdenk defines the offset of register from address. It 31057f6c2cbcSwdenk depends on which part of the data bus is connected to 310611ccc33fSMarcel Ziswiler the FDC chipset. (default value 0) 31077f6c2cbcSwdenk 31086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and 31096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their 31107f6c2cbcSwdenk default value. 31117f6c2cbcSwdenk 31126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD if CONFIG_SYS_FDC_HW_INIT is defined, then the function 31137f6c2cbcSwdenk fdc_hw_init() is called at the beginning of the FDC 31147f6c2cbcSwdenk setup. fdc_hw_init() must be provided by the board 31157f6c2cbcSwdenk source code. It is used to make hardware dependant 31167f6c2cbcSwdenk initializations. 31177f6c2cbcSwdenk 31180abddf82SMacpaul Lin- CONFIG_IDE_AHB: 31190abddf82SMacpaul Lin Most IDE controllers were designed to be connected with PCI 31200abddf82SMacpaul Lin interface. Only few of them were designed for AHB interface. 31210abddf82SMacpaul Lin When software is doing ATA command and data transfer to 31220abddf82SMacpaul Lin IDE devices through IDE-AHB controller, some additional 31230abddf82SMacpaul Lin registers accessing to these kind of IDE-AHB controller 31240abddf82SMacpaul Lin is requierd. 31250abddf82SMacpaul Lin 31266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR: Physical address of the Internal Memory. 312725d6712aSwdenk DO NOT CHANGE unless you know exactly what you're 312825d6712aSwdenk doing! (11-4) [MPC8xx/82xx systems only] 3129c609719bSwdenk 31306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR: 3131c609719bSwdenk 31327152b1d0Swdenk Start address of memory area that can be used for 3133c609719bSwdenk initial data and stack; please note that this must be 3134c609719bSwdenk writable memory that is working WITHOUT special 3135c609719bSwdenk initialization, i. e. you CANNOT use normal RAM which 3136c609719bSwdenk will become available only after programming the 3137c609719bSwdenk memory controller and running certain initialization 3138c609719bSwdenk sequences. 3139c609719bSwdenk 3140c609719bSwdenk U-Boot uses the following memory types: 3141c609719bSwdenk - MPC8xx and MPC8260: IMMR (internal memory of the CPU) 3142c609719bSwdenk - MPC824X: data cache 3143c609719bSwdenk - PPC4xx: data cache 3144c609719bSwdenk 31456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET: 3146c609719bSwdenk 3147c609719bSwdenk Offset of the initial data structure in the memory 31486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually 31496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial 3150c609719bSwdenk data is located at the end of the available space 3151553f0982SWolfgang Denk (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE - 31526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just 31536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR + 31546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_GBL_DATA_OFFSET) downward. 3155c609719bSwdenk 3156c609719bSwdenk Note: 3157c609719bSwdenk On the MPC824X (or other systems that use the data 3158c609719bSwdenk cache for initial memory) the address chosen for 31596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must 3160c609719bSwdenk point to an otherwise UNUSED address space between 3161c609719bSwdenk the top of RAM and the start of the PCI space. 3162c609719bSwdenk 31636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6) 3164c609719bSwdenk 31656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR: System Protection Control (11-9) 3166c609719bSwdenk 31676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26) 3168c609719bSwdenk 31696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31) 3170c609719bSwdenk 31716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30) 3172c609719bSwdenk 31736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27) 3174c609719bSwdenk 31756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM: 3176c609719bSwdenk SDRAM timing 3177c609719bSwdenk 31786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA: 3179c609719bSwdenk periodic timer for refresh 3180c609719bSwdenk 31816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER: Debug Event Register (37-47) 3182c609719bSwdenk 31836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM, 31846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP, 31856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM, 31866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BR1_PRELIM: 3187c609719bSwdenk Memory Controller Definitions: BR0/1 and OR0/1 (FLASH) 3188c609719bSwdenk 3189c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE, 31906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM, 31916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM: 3192c609719bSwdenk Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM) 3193c609719bSwdenk 31946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K, 31956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL: 3196c609719bSwdenk Machine Mode Register and Memory Periodic Timer 3197c609719bSwdenk Prescaler definitions (SDRAM timing) 3198c609719bSwdenk 31996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]: 3200c609719bSwdenk enable I2C microcode relocation patch (MPC8xx); 3201c609719bSwdenk define relocation offset in DPRAM [DSP2] 3202c609719bSwdenk 32036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]: 3204b423d055SHeiko Schocher enable SMC microcode relocation patch (MPC8xx); 3205b423d055SHeiko Schocher define relocation offset in DPRAM [SMC1] 3206b423d055SHeiko Schocher 32076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]: 3208c609719bSwdenk enable SPI microcode relocation patch (MPC8xx); 3209c609719bSwdenk define relocation offset in DPRAM [SCC4] 3210c609719bSwdenk 32116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK: 3212c609719bSwdenk Use OSCM clock mode on MBX8xx board. Be careful, 3213c609719bSwdenk wrong setting might damage your board. Read 3214c609719bSwdenk doc/README.MBX before setting this variable! 3215c609719bSwdenk 32166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only) 3217ea909b76Swdenk Offset of the bootmode word in DPRAM used by post 3218ea909b76Swdenk (Power On Self Tests). This definition overrides 3219ea909b76Swdenk #define'd default value in commproc.h resp. 3220ea909b76Swdenk cpm_8260.h. 3221ea909b76Swdenk 32226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB, 32236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL, 32246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS, 32256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB, 32266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START, 32276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL, 32286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE, 32296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only) 3230a47a12beSStefan Roese Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set. 32315d232d0eSwdenk 32329cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE: 32339cacf4fcSDirk Eibach Disable PCI-Express on systems where it is supported but not 32349cacf4fcSDirk Eibach required. 32359cacf4fcSDirk Eibach 3236a09b9b68SKumar Gala- CONFIG_SYS_SRIO: 3237a09b9b68SKumar Gala Chip has SRIO or not 3238a09b9b68SKumar Gala 3239a09b9b68SKumar Gala- CONFIG_SRIO1: 3240a09b9b68SKumar Gala Board has SRIO 1 port available 3241a09b9b68SKumar Gala 3242a09b9b68SKumar Gala- CONFIG_SRIO2: 3243a09b9b68SKumar Gala Board has SRIO 2 port available 3244a09b9b68SKumar Gala 3245a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT: 3246a09b9b68SKumar Gala Virtual Address of SRIO port 'n' memory region 3247a09b9b68SKumar Gala 3248a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS: 3249a09b9b68SKumar Gala Physical Address of SRIO port 'n' memory region 3250a09b9b68SKumar Gala 3251a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE: 3252a09b9b68SKumar Gala Size of SRIO port 'n' memory region 3253a09b9b68SKumar Gala 3254eced4626SAlex Waterman- CONFIG_SYS_NDFC_16 3255eced4626SAlex Waterman Defined to tell the NDFC that the NAND chip is using a 3256eced4626SAlex Waterman 16 bit bus. 3257eced4626SAlex Waterman 3258eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG 3259eced4626SAlex Waterman Sets the EBC0_CFG register for the NDFC. If not defined 3260eced4626SAlex Waterman a default value will be used. 3261eced4626SAlex Waterman 3262bb99ad6dSBen Warren- CONFIG_SPD_EEPROM 3263218ca724SWolfgang Denk Get DDR timing information from an I2C EEPROM. Common 3264218ca724SWolfgang Denk with pluggable memory modules such as SODIMMs 3265218ca724SWolfgang Denk 3266bb99ad6dSBen Warren SPD_EEPROM_ADDRESS 3267bb99ad6dSBen Warren I2C address of the SPD EEPROM 3268bb99ad6dSBen Warren 32696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM 3270218ca724SWolfgang Denk If SPD EEPROM is on an I2C bus other than the first 3271218ca724SWolfgang Denk one, specify here. Note that the value must resolve 3272218ca724SWolfgang Denk to something your driver can deal with. 3273bb99ad6dSBen Warren 32741b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING 32751b3e3c4fSYork Sun Get DDR timing information from other than SPD. Common with 32761b3e3c4fSYork Sun soldered DDR chips onboard without SPD. DDR raw timing 32771b3e3c4fSYork Sun parameters are extracted from datasheet and hard-coded into 32781b3e3c4fSYork Sun header files or board specific files. 32791b3e3c4fSYork Sun 32806f5e1dc5SYork Sun- CONFIG_FSL_DDR_INTERACTIVE 32816f5e1dc5SYork Sun Enable interactive DDR debugging. See doc/README.fsl-ddr. 32826f5e1dc5SYork Sun 32836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0 3284218ca724SWolfgang Denk Only for 83xx systems. If specified, then DDR should 3285218ca724SWolfgang Denk be configured using CS0 and CS1 instead of CS2 and CS3. 32862ad6b513STimur Tabi 3287c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12] 3288c26e454dSwdenk Define to enable FEC[12] on a 8xx series processor. 3289c26e454dSwdenk 3290c26e454dSwdenk- CONFIG_FEC[12]_PHY 3291c26e454dSwdenk Define to the hardcoded PHY address which corresponds 32926e592385Swdenk to the given FEC; i. e. 3293c26e454dSwdenk #define CONFIG_FEC1_PHY 4 3294c26e454dSwdenk means that the PHY with address 4 is connected to FEC1 3295c26e454dSwdenk 3296c26e454dSwdenk When set to -1, means to probe for first available. 3297c26e454dSwdenk 3298c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR 3299c26e454dSwdenk The PHY does not have a RXERR line (RMII only). 3300c26e454dSwdenk (so program the FEC to ignore it). 3301c26e454dSwdenk 3302c26e454dSwdenk- CONFIG_RMII 3303c26e454dSwdenk Enable RMII mode for all FECs. 3304c26e454dSwdenk Note that this is a global option, we can't 3305c26e454dSwdenk have one FEC in standard MII mode and another in RMII mode. 3306c26e454dSwdenk 33075cf91d6bSwdenk- CONFIG_CRC32_VERIFY 33085cf91d6bSwdenk Add a verify option to the crc32 command. 33095cf91d6bSwdenk The syntax is: 33105cf91d6bSwdenk 33115cf91d6bSwdenk => crc32 -v <address> <count> <crc32> 33125cf91d6bSwdenk 33135cf91d6bSwdenk Where address/count indicate a memory area 33145cf91d6bSwdenk and crc32 is the correct crc32 which the 33155cf91d6bSwdenk area should have. 33165cf91d6bSwdenk 331756523f12Swdenk- CONFIG_LOOPW 331856523f12Swdenk Add the "loopw" memory command. This only takes effect if 3319602ad3b3SJon Loeliger the memory commands are activated globally (CONFIG_CMD_MEM). 332056523f12Swdenk 33217b466641Sstroese- CONFIG_MX_CYCLIC 33227b466641Sstroese Add the "mdc" and "mwc" memory commands. These are cyclic 33237b466641Sstroese "md/mw" commands. 33247b466641Sstroese Examples: 33257b466641Sstroese 33267b466641Sstroese => mdc.b 10 4 500 33277b466641Sstroese This command will print 4 bytes (10,11,12,13) each 500 ms. 33287b466641Sstroese 33297b466641Sstroese => mwc.l 100 12345678 10 33307b466641Sstroese This command will write 12345678 to address 100 all 10 ms. 33317b466641Sstroese 33327b466641Sstroese This only takes effect if the memory commands are activated 3333602ad3b3SJon Loeliger globally (CONFIG_CMD_MEM). 33347b466641Sstroese 33358aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT 3336afc1ce82SMacpaul Lin [ARM, NDS32, MIPS only] If this variable is defined, then certain 3337e03f3169SWolfgang Denk low level initializations (like setting up the memory 3338e03f3169SWolfgang Denk controller) are omitted and/or U-Boot does not 3339e03f3169SWolfgang Denk relocate itself into RAM. 33408aa1a2d1Swdenk 3341e03f3169SWolfgang Denk Normally this variable MUST NOT be defined. The only 3342e03f3169SWolfgang Denk exception is when U-Boot is loaded (to RAM) by some 3343e03f3169SWolfgang Denk other boot loader or by a debugger which performs 3344e03f3169SWolfgang Denk these initializations itself. 33458aa1a2d1Swdenk 3346401bb30bSAneesh V- CONFIG_SPL_BUILD 3347df81238bSMagnus Lilja Modifies the behaviour of start.S when compiling a loader 3348df81238bSMagnus Lilja that is executed before the actual U-Boot. E.g. when 3349df81238bSMagnus Lilja compiling a NAND SPL. 3350400558b5Swdenk 335168bb8295SHeiko Schocher- CONFIG_SYS_NAND_HW_ECC_OOBFIRST 335268bb8295SHeiko Schocher define this, if you want to read first the oob data 335368bb8295SHeiko Schocher and then the data. This is used for example on 335468bb8295SHeiko Schocher davinci plattforms. 335568bb8295SHeiko Schocher 3356d8834a13SMatthias Weisser- CONFIG_USE_ARCH_MEMCPY 3357d8834a13SMatthias Weisser CONFIG_USE_ARCH_MEMSET 3358d8834a13SMatthias Weisser If these options are used a optimized version of memcpy/memset will 3359d8834a13SMatthias Weisser be used if available. These functions may be faster under some 3360d8834a13SMatthias Weisser conditions but may increase the binary size. 3361d8834a13SMatthias Weisser 3362f2717b47STimur TabiFreescale QE/FMAN Firmware Support: 3363f2717b47STimur Tabi----------------------------------- 3364f2717b47STimur Tabi 3365f2717b47STimur TabiThe Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the 3366f2717b47STimur Tabiloading of "firmware", which is encoded in the QE firmware binary format. 3367f2717b47STimur TabiThis firmware often needs to be loaded during U-Boot booting, so macros 3368f2717b47STimur Tabiare used to identify the storage device (NOR flash, SPI, etc) and the address 3369f2717b47STimur Tabiwithin that device. 3370f2717b47STimur Tabi 3371f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_ADDR 3372f2717b47STimur Tabi The address in the storage device where the firmware is located. The 3373f2717b47STimur Tabi meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro 3374f2717b47STimur Tabi is also specified. 3375f2717b47STimur Tabi 3376f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_LENGTH 3377f2717b47STimur Tabi The maximum possible size of the firmware. The firmware binary format 3378f2717b47STimur Tabi has a field that specifies the actual size of the firmware, but it 3379f2717b47STimur Tabi might not be possible to read any part of the firmware unless some 3380f2717b47STimur Tabi local storage is allocated to hold the entire firmware first. 3381f2717b47STimur Tabi 3382f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NOR 3383f2717b47STimur Tabi Specifies that QE/FMAN firmware is located in NOR flash, mapped as 3384f2717b47STimur Tabi normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the 3385f2717b47STimur Tabi virtual address in NOR flash. 3386f2717b47STimur Tabi 3387f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NAND 3388f2717b47STimur Tabi Specifies that QE/FMAN firmware is located in NAND flash. 3389f2717b47STimur Tabi CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash. 3390f2717b47STimur Tabi 3391f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_MMC 3392f2717b47STimur Tabi Specifies that QE/FMAN firmware is located on the primary SD/MMC 3393f2717b47STimur Tabi device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device. 3394f2717b47STimur Tabi 3395f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH 3396f2717b47STimur Tabi Specifies that QE/FMAN firmware is located on the primary SPI 3397f2717b47STimur Tabi device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device. 3398f2717b47STimur Tabi 3399f2717b47STimur Tabi 3400c609719bSwdenkBuilding the Software: 3401c609719bSwdenk====================== 3402c609719bSwdenk 3403218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments 3404218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support 3405218ca724SWolfgang Denkall possibly existing versions of cross development tools in all 3406218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we 3407218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK) 3408218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot. 3409c609719bSwdenk 3410218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you 3411218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case, 3412218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell. 3413218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are 3414218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter: 3415c609719bSwdenk 3416218ca724SWolfgang Denk $ CROSS_COMPILE=ppc_4xx- 3417218ca724SWolfgang Denk $ export CROSS_COMPILE 3418c609719bSwdenk 34192f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in 34202f8d396bSPeter Tyser the tools directory you can use the MinGW toolchain 34212f8d396bSPeter Tyser (http://www.mingw.org). Set your HOST tools to the MinGW 34222f8d396bSPeter Tyser toolchain and execute 'make tools'. For example: 34232f8d396bSPeter Tyser 34242f8d396bSPeter Tyser $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools 34252f8d396bSPeter Tyser 34262f8d396bSPeter Tyser Binaries such as tools/mkimage.exe will be created which can 34272f8d396bSPeter Tyser be executed on computers running Windows. 34282f8d396bSPeter Tyser 3429c609719bSwdenkU-Boot is intended to be simple to build. After installing the 3430c609719bSwdenksources you must configure U-Boot for one specific board type. This 3431c609719bSwdenkis done by typing: 3432c609719bSwdenk 3433c609719bSwdenk make NAME_config 3434c609719bSwdenk 3435218ca724SWolfgang Denkwhere "NAME_config" is the name of one of the existing configu- 3436218ca724SWolfgang Denkrations; see the main Makefile for supported names. 343754387ac9Swdenk 3438c609719bSwdenkNote: for some board special configuration names may exist; check if 3439c609719bSwdenk additional information is available from the board vendor; for 34402729af9dSwdenk instance, the TQM823L systems are available without (standard) 34412729af9dSwdenk or with LCD support. You can select such additional "features" 344211ccc33fSMarcel Ziswiler when choosing the configuration, i. e. 3443c609719bSwdenk 34442729af9dSwdenk make TQM823L_config 34452729af9dSwdenk - will configure for a plain TQM823L, i. e. no LCD support 3446c609719bSwdenk 3447c609719bSwdenk make TQM823L_LCD_config 3448c609719bSwdenk - will configure for a TQM823L with U-Boot console on LCD 3449c609719bSwdenk 3450c609719bSwdenk etc. 3451c609719bSwdenk 3452c609719bSwdenk 3453c609719bSwdenkFinally, type "make all", and you should get some working U-Boot 34547152b1d0Swdenkimages ready for download to / installation on your system: 3455c609719bSwdenk 3456c609719bSwdenk- "u-boot.bin" is a raw binary image 3457c609719bSwdenk- "u-boot" is an image in ELF binary format 3458c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format 3459c609719bSwdenk 3460baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved 3461baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change 3462baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory: 3463baf31249SMarian Balakowicz 3464baf31249SMarian Balakowicz1. Add O= to the make command line invocations: 3465baf31249SMarian Balakowicz 3466baf31249SMarian Balakowicz make O=/tmp/build distclean 3467baf31249SMarian Balakowicz make O=/tmp/build NAME_config 3468baf31249SMarian Balakowicz make O=/tmp/build all 3469baf31249SMarian Balakowicz 3470baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location: 3471baf31249SMarian Balakowicz 3472baf31249SMarian Balakowicz export BUILD_DIR=/tmp/build 3473baf31249SMarian Balakowicz make distclean 3474baf31249SMarian Balakowicz make NAME_config 3475baf31249SMarian Balakowicz make all 3476baf31249SMarian Balakowicz 3477baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment 3478baf31249SMarian Balakowiczvariable. 3479baf31249SMarian Balakowicz 3480c609719bSwdenk 3481c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so 3482c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of 3483c609719bSwdenknative "make". 3484c609719bSwdenk 3485c609719bSwdenk 3486c609719bSwdenkIf the system board that you have is not listed, then you will need 3487c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these 3488c609719bSwdenksteps: 3489c609719bSwdenk 3490c609719bSwdenk1. Add a new configuration option for your board to the toplevel 349185ec0bccSwdenk "Makefile" and to the "MAKEALL" script, using the existing 349285ec0bccSwdenk entries as examples. Note that here and at many other places 34937152b1d0Swdenk boards and other names are listed in alphabetical sort order. Please 349485ec0bccSwdenk keep this order. 3495c609719bSwdenk2. Create a new directory to hold your board specific code. Add any 349685ec0bccSwdenk files you need. In your board directory, you will need at least 349785ec0bccSwdenk the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds". 349885ec0bccSwdenk3. Create a new configuration file "include/configs/<board>.h" for 349985ec0bccSwdenk your board 3500c609719bSwdenk3. If you're porting U-Boot to a new CPU, then also create a new 3501c609719bSwdenk directory to hold your CPU specific code. Add any files you need. 350285ec0bccSwdenk4. Run "make <board>_config" with your new name. 3503c609719bSwdenk5. Type "make", and you should get a working "u-boot.srec" file 3504c609719bSwdenk to be installed on your target system. 350585ec0bccSwdenk6. Debug and solve any problems that might arise. 3506c609719bSwdenk [Of course, this last step is much harder than it sounds.] 3507c609719bSwdenk 3508c609719bSwdenk 3509c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.: 3510c609719bSwdenk============================================================== 3511c609719bSwdenk 3512c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board 3513c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to 3514c609719bSwdenkprovide feedback to the other developers. The feedback normally takes 3515c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest 3516218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources. 3517c609719bSwdenk 3518c609719bSwdenkBut before you submit such a patch, please verify that your modifi- 3519c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of 3520c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so, 3521c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot 3522c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can 35237152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE' 3524218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools 3525218ca724SWolfgang Denkyou can type 3526c609719bSwdenk 3527c609719bSwdenk CROSS_COMPILE=ppc_8xx- MAKEALL 3528c609719bSwdenk 3529c609719bSwdenkor to build on a native PowerPC system you can type 3530c609719bSwdenk 3531c609719bSwdenk CROSS_COMPILE=' ' MAKEALL 3532c609719bSwdenk 3533218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build 3534218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by 3535218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target 3536218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and 3537218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default 3538218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment 3539218ca724SWolfgang Denkvariable. For example: 3540baf31249SMarian Balakowicz 3541baf31249SMarian Balakowicz export BUILD_DIR=/tmp/build 3542baf31249SMarian Balakowicz export MAKEALL_LOGDIR=/tmp/log 3543baf31249SMarian Balakowicz CROSS_COMPILE=ppc_8xx- MAKEALL 3544baf31249SMarian Balakowicz 3545218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build, 3546218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean 3547218ca724SWolfgang Denkduring the whole build process. 3548baf31249SMarian Balakowicz 3549baf31249SMarian Balakowicz 3550c609719bSwdenkSee also "U-Boot Porting Guide" below. 3551c609719bSwdenk 3552c609719bSwdenk 3553c609719bSwdenkMonitor Commands - Overview: 3554c609719bSwdenk============================ 3555c609719bSwdenk 3556c609719bSwdenkgo - start application at address 'addr' 3557c609719bSwdenkrun - run commands in an environment variable 3558c609719bSwdenkbootm - boot application image from memory 3559c609719bSwdenkbootp - boot image via network using BootP/TFTP protocol 3560c609719bSwdenktftpboot- boot image via network using TFTP protocol 3561c609719bSwdenk and env variables "ipaddr" and "serverip" 3562c609719bSwdenk (and eventually "gatewayip") 35631fb7cd49SSimon Glasstftpput - upload a file via network using TFTP protocol 3564c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol 3565c609719bSwdenkdiskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd' 3566c609719bSwdenkloads - load S-Record file over serial line 3567c609719bSwdenkloadb - load binary file over serial line (kermit mode) 3568c609719bSwdenkmd - memory display 3569c609719bSwdenkmm - memory modify (auto-incrementing) 3570c609719bSwdenknm - memory modify (constant address) 3571c609719bSwdenkmw - memory write (fill) 3572c609719bSwdenkcp - memory copy 3573c609719bSwdenkcmp - memory compare 3574c609719bSwdenkcrc32 - checksum calculation 35750f89c54bSPeter Tyseri2c - I2C sub-system 3576c609719bSwdenksspi - SPI utility commands 3577c609719bSwdenkbase - print or set address offset 3578c609719bSwdenkprintenv- print environment variables 3579c609719bSwdenksetenv - set environment variables 3580c609719bSwdenksaveenv - save environment variables to persistent storage 3581c609719bSwdenkprotect - enable or disable FLASH write protection 3582c609719bSwdenkerase - erase FLASH memory 3583c609719bSwdenkflinfo - print FLASH memory information 3584c609719bSwdenkbdinfo - print Board Info structure 3585c609719bSwdenkiminfo - print header information for application image 3586c609719bSwdenkconinfo - print console devices and informations 3587c609719bSwdenkide - IDE sub-system 3588c609719bSwdenkloop - infinite loop on address range 358956523f12Swdenkloopw - infinite write loop on address range 3590c609719bSwdenkmtest - simple RAM test 3591c609719bSwdenkicache - enable or disable instruction cache 3592c609719bSwdenkdcache - enable or disable data cache 3593c609719bSwdenkreset - Perform RESET of the CPU 3594c609719bSwdenkecho - echo args to console 3595c609719bSwdenkversion - print monitor version 3596c609719bSwdenkhelp - print online help 3597c609719bSwdenk? - alias for 'help' 3598c609719bSwdenk 3599c609719bSwdenk 3600c609719bSwdenkMonitor Commands - Detailed Description: 3601c609719bSwdenk======================================== 3602c609719bSwdenk 3603c609719bSwdenkTODO. 3604c609719bSwdenk 3605c609719bSwdenkFor now: just type "help <command>". 3606c609719bSwdenk 3607c609719bSwdenk 3608c609719bSwdenkEnvironment Variables: 3609c609719bSwdenk====================== 3610c609719bSwdenk 3611c609719bSwdenkU-Boot supports user configuration using Environment Variables which 3612c609719bSwdenkcan be made persistent by saving to Flash memory. 3613c609719bSwdenk 3614c609719bSwdenkEnvironment Variables are set using "setenv", printed using 3615c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv" 3616c609719bSwdenkwithout a value can be used to delete a variable from the 3617c609719bSwdenkenvironment. As long as you don't save the environment you are 3618c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the 3619c609719bSwdenkenvironment is erased by accident, a default environment is provided. 3620c609719bSwdenk 3621c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables. 3622c96f86eeSWolfgang Denk 3623c96f86eeSWolfgang DenkList of environment variables (most likely not complete): 3624c609719bSwdenk 3625c609719bSwdenk baudrate - see CONFIG_BAUDRATE 3626c609719bSwdenk 3627c609719bSwdenk bootdelay - see CONFIG_BOOTDELAY 3628c609719bSwdenk 3629c609719bSwdenk bootcmd - see CONFIG_BOOTCOMMAND 3630c609719bSwdenk 3631c609719bSwdenk bootargs - Boot arguments when booting an RTOS image 3632c609719bSwdenk 3633c609719bSwdenk bootfile - Name of the image to load with TFTP 3634c609719bSwdenk 36357d721e34SBartlomiej Sieka bootm_low - Memory range available for image processing in the bootm 36367d721e34SBartlomiej Sieka command can be restricted. This variable is given as 36377d721e34SBartlomiej Sieka a hexadecimal number and defines lowest address allowed 36387d721e34SBartlomiej Sieka for use by the bootm command. See also "bootm_size" 36397d721e34SBartlomiej Sieka environment variable. Address defined by "bootm_low" is 36407d721e34SBartlomiej Sieka also the base of the initial memory mapping for the Linux 3641c3624e6eSGrant Likely kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and 3642c3624e6eSGrant Likely bootm_mapsize. 3643c3624e6eSGrant Likely 3644c3624e6eSGrant Likely bootm_mapsize - Size of the initial memory mapping for the Linux kernel. 3645c3624e6eSGrant Likely This variable is given as a hexadecimal number and it 3646c3624e6eSGrant Likely defines the size of the memory region starting at base 3647c3624e6eSGrant Likely address bootm_low that is accessible by the Linux kernel 3648c3624e6eSGrant Likely during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used 3649c3624e6eSGrant Likely as the default value if it is defined, and bootm_size is 3650c3624e6eSGrant Likely used otherwise. 36517d721e34SBartlomiej Sieka 36527d721e34SBartlomiej Sieka bootm_size - Memory range available for image processing in the bootm 36537d721e34SBartlomiej Sieka command can be restricted. This variable is given as 36547d721e34SBartlomiej Sieka a hexadecimal number and defines the size of the region 36557d721e34SBartlomiej Sieka allowed for use by the bootm command. See also "bootm_low" 36567d721e34SBartlomiej Sieka environment variable. 36577d721e34SBartlomiej Sieka 36584bae9090SBartlomiej Sieka updatefile - Location of the software update file on a TFTP server, used 36594bae9090SBartlomiej Sieka by the automatic software update feature. Please refer to 36604bae9090SBartlomiej Sieka documentation in doc/README.update for more details. 36614bae9090SBartlomiej Sieka 3662c609719bSwdenk autoload - if set to "no" (any string beginning with 'n'), 3663c609719bSwdenk "bootp" will just load perform a lookup of the 3664c609719bSwdenk configuration from the BOOTP server, but not try to 3665c609719bSwdenk load any image using TFTP 3666c609719bSwdenk 3667c609719bSwdenk autostart - if set to "yes", an image loaded using the "bootp", 3668c609719bSwdenk "rarpboot", "tftpboot" or "diskboot" commands will 3669c609719bSwdenk be automatically started (by internally calling 3670c609719bSwdenk "bootm") 3671c609719bSwdenk 36724a6fd34bSwdenk If set to "no", a standalone image passed to the 36734a6fd34bSwdenk "bootm" command will be copied to the load address 36744a6fd34bSwdenk (and eventually uncompressed), but NOT be started. 36754a6fd34bSwdenk This can be used to load and uncompress arbitrary 36764a6fd34bSwdenk data. 36774a6fd34bSwdenk 3678a28afca5SDavid A. Long fdt_high - if set this restricts the maximum address that the 3679a28afca5SDavid A. Long flattened device tree will be copied into upon boot. 3680fa34f6b2SShawn Guo For example, if you have a system with 1 GB memory 3681fa34f6b2SShawn Guo at physical address 0x10000000, while Linux kernel 3682fa34f6b2SShawn Guo only recognizes the first 704 MB as low memory, you 3683fa34f6b2SShawn Guo may need to set fdt_high as 0x3C000000 to have the 3684fa34f6b2SShawn Guo device tree blob be copied to the maximum address 3685fa34f6b2SShawn Guo of the 704 MB low memory, so that Linux kernel can 3686fa34f6b2SShawn Guo access it during the boot procedure. 3687fa34f6b2SShawn Guo 3688a28afca5SDavid A. Long If this is set to the special value 0xFFFFFFFF then 3689a28afca5SDavid A. Long the fdt will not be copied at all on boot. For this 3690a28afca5SDavid A. Long to work it must reside in writable memory, have 3691a28afca5SDavid A. Long sufficient padding on the end of it for u-boot to 3692a28afca5SDavid A. Long add the information it needs into it, and the memory 3693a28afca5SDavid A. Long must be accessible by the kernel. 3694a28afca5SDavid A. Long 3695eea63e05SSimon Glass fdtcontroladdr- if set this is the address of the control flattened 3696eea63e05SSimon Glass device tree used by U-Boot when CONFIG_OF_CONTROL is 3697eea63e05SSimon Glass defined. 3698eea63e05SSimon Glass 369917ea1177Swdenk i2cfast - (PPC405GP|PPC405EP only) 370017ea1177Swdenk if set to 'y' configures Linux I2C driver for fast 370117ea1177Swdenk mode (400kHZ). This environment variable is used in 370217ea1177Swdenk initialization code. So, for changes to be effective 370317ea1177Swdenk it must be saved and board must be reset. 370417ea1177Swdenk 3705c609719bSwdenk initrd_high - restrict positioning of initrd images: 3706c609719bSwdenk If this variable is not set, initrd images will be 3707c609719bSwdenk copied to the highest possible address in RAM; this 3708c609719bSwdenk is usually what you want since it allows for 3709c609719bSwdenk maximum initrd size. If for some reason you want to 3710c609719bSwdenk make sure that the initrd image is loaded below the 37116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BOOTMAPSZ limit, you can set this environment 3712c609719bSwdenk variable to a value of "no" or "off" or "0". 3713c609719bSwdenk Alternatively, you can set it to a maximum upper 3714c609719bSwdenk address to use (U-Boot will still check that it 3715c609719bSwdenk does not overwrite the U-Boot stack and data). 3716c609719bSwdenk 3717c609719bSwdenk For instance, when you have a system with 16 MB 37187152b1d0Swdenk RAM, and want to reserve 4 MB from use by Linux, 3719c609719bSwdenk you can do this by adding "mem=12M" to the value of 3720c609719bSwdenk the "bootargs" variable. However, now you must make 37217152b1d0Swdenk sure that the initrd image is placed in the first 3722c609719bSwdenk 12 MB as well - this can be done with 3723c609719bSwdenk 3724c609719bSwdenk setenv initrd_high 00c00000 3725c609719bSwdenk 372638b99261Swdenk If you set initrd_high to 0xFFFFFFFF, this is an 372738b99261Swdenk indication to U-Boot that all addresses are legal 372838b99261Swdenk for the Linux kernel, including addresses in flash 372938b99261Swdenk memory. In this case U-Boot will NOT COPY the 373038b99261Swdenk ramdisk at all. This may be useful to reduce the 373138b99261Swdenk boot time on your system, but requires that this 373238b99261Swdenk feature is supported by your Linux kernel. 373338b99261Swdenk 3734c609719bSwdenk ipaddr - IP address; needed for tftpboot command 3735c609719bSwdenk 3736c609719bSwdenk loadaddr - Default load address for commands like "bootp", 3737dc7c9a1aSwdenk "rarpboot", "tftpboot", "loadb" or "diskboot" 3738c609719bSwdenk 3739c609719bSwdenk loads_echo - see CONFIG_LOADS_ECHO 3740c609719bSwdenk 3741c609719bSwdenk serverip - TFTP server IP address; needed for tftpboot command 3742c609719bSwdenk 3743c609719bSwdenk bootretry - see CONFIG_BOOT_RETRY_TIME 3744c609719bSwdenk 3745c609719bSwdenk bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR 3746c609719bSwdenk 3747c609719bSwdenk bootstopkey - see CONFIG_AUTOBOOT_STOP_STR 3748c609719bSwdenk 3749e2a53458SMike Frysinger ethprime - controls which interface is used first. 3750a3d991bdSwdenk 3751e2a53458SMike Frysinger ethact - controls which interface is currently active. 3752e2a53458SMike Frysinger For example you can do the following 3753a3d991bdSwdenk 375448690d80SHeiko Schocher => setenv ethact FEC 375548690d80SHeiko Schocher => ping 192.168.0.1 # traffic sent on FEC 375648690d80SHeiko Schocher => setenv ethact SCC 375748690d80SHeiko Schocher => ping 10.0.0.1 # traffic sent on SCC 3758a3d991bdSwdenk 3759e1692577SMatthias Fuchs ethrotate - When set to "no" U-Boot does not go through all 3760e1692577SMatthias Fuchs available network interfaces. 3761e1692577SMatthias Fuchs It just stays at the currently selected interface. 3762e1692577SMatthias Fuchs 3763a3d991bdSwdenk netretry - When set to "no" each network operation will 3764a3d991bdSwdenk either succeed or fail without retrying. 37656e592385Swdenk When set to "once" the network operation will 37666e592385Swdenk fail when all the available network interfaces 37676e592385Swdenk are tried once without success. 3768a3d991bdSwdenk Useful on scripts which control the retry operation 3769a3d991bdSwdenk themselves. 3770a3d991bdSwdenk 3771b4e2f89dSJean-Christophe PLAGNIOL-VILLARD npe_ucode - set load address for the NPE microcode 3772a1cf027aSJean-Christophe PLAGNIOL-VILLARD 377328cb9375SWolfgang Denk tftpsrcport - If this is set, the value is used for TFTP's 3774ecb0ccd9SWolfgang Denk UDP source port. 3775ecb0ccd9SWolfgang Denk 377628cb9375SWolfgang Denk tftpdstport - If this is set, the value is used for TFTP's UDP 377728cb9375SWolfgang Denk destination port instead of the Well Know Port 69. 377828cb9375SWolfgang Denk 3779c96f86eeSWolfgang Denk tftpblocksize - Block size to use for TFTP transfers; if not set, 3780c96f86eeSWolfgang Denk we use the TFTP server's default block size 3781c96f86eeSWolfgang Denk 3782c96f86eeSWolfgang Denk tftptimeout - Retransmission timeout for TFTP packets (in milli- 3783c96f86eeSWolfgang Denk seconds, minimum value is 1000 = 1 second). Defines 3784c96f86eeSWolfgang Denk when a packet is considered to be lost so it has to 3785c96f86eeSWolfgang Denk be retransmitted. The default is 5000 = 5 seconds. 3786c96f86eeSWolfgang Denk Lowering this value may make downloads succeed 3787c96f86eeSWolfgang Denk faster in networks with high packet loss rates or 3788c96f86eeSWolfgang Denk with unreliable TFTP servers. 3789c96f86eeSWolfgang Denk 3790a3d991bdSwdenk vlan - When set to a value < 4095 the traffic over 379111ccc33fSMarcel Ziswiler Ethernet is encapsulated/received over 802.1q 3792a3d991bdSwdenk VLAN tagged frames. 3793c609719bSwdenk 3794dc0b7b0eSJason HobbsThe following image location variables contain the location of images 3795dc0b7b0eSJason Hobbsused in booting. The "Image" column gives the role of the image and is 3796dc0b7b0eSJason Hobbsnot an environment variable name. The other columns are environment 3797dc0b7b0eSJason Hobbsvariable names. "File Name" gives the name of the file on a TFTP 3798dc0b7b0eSJason Hobbsserver, "RAM Address" gives the location in RAM the image will be 3799dc0b7b0eSJason Hobbsloaded to, and "Flash Location" gives the image's address in NOR 3800dc0b7b0eSJason Hobbsflash or offset in NAND flash. 3801dc0b7b0eSJason Hobbs 3802dc0b7b0eSJason Hobbs*Note* - these variables don't have to be defined for all boards, some 3803dc0b7b0eSJason Hobbsboards currenlty use other variables for these purposes, and some 3804dc0b7b0eSJason Hobbsboards use these variables for other purposes. 3805dc0b7b0eSJason Hobbs 3806dc0b7b0eSJason HobbsImage File Name RAM Address Flash Location 3807dc0b7b0eSJason Hobbs----- --------- ----------- -------------- 3808dc0b7b0eSJason Hobbsu-boot u-boot u-boot_addr_r u-boot_addr 3809dc0b7b0eSJason HobbsLinux kernel bootfile kernel_addr_r kernel_addr 3810dc0b7b0eSJason Hobbsdevice tree blob fdtfile fdt_addr_r fdt_addr 3811dc0b7b0eSJason Hobbsramdisk ramdiskfile ramdisk_addr_r ramdisk_addr 3812dc0b7b0eSJason Hobbs 3813c609719bSwdenkThe following environment variables may be used and automatically 3814c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"), 3815c609719bSwdenkdepending the information provided by your boot server: 3816c609719bSwdenk 3817c609719bSwdenk bootfile - see above 3818c609719bSwdenk dnsip - IP address of your Domain Name Server 3819fe389a82Sstroese dnsip2 - IP address of your secondary Domain Name Server 3820c609719bSwdenk gatewayip - IP address of the Gateway (Router) to use 3821c609719bSwdenk hostname - Target hostname 3822c609719bSwdenk ipaddr - see above 3823c609719bSwdenk netmask - Subnet Mask 3824c609719bSwdenk rootpath - Pathname of the root filesystem on the NFS server 3825c609719bSwdenk serverip - see above 3826c609719bSwdenk 3827c609719bSwdenk 3828c609719bSwdenkThere are two special Environment Variables: 3829c609719bSwdenk 3830c609719bSwdenk serial# - contains hardware identification information such 3831c609719bSwdenk as type string and/or serial number 3832c609719bSwdenk ethaddr - Ethernet address 3833c609719bSwdenk 3834c609719bSwdenkThese variables can be set only once (usually during manufacturing of 3835c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables 3836c609719bSwdenkonce they have been set once. 3837c609719bSwdenk 3838c609719bSwdenk 3839c1551ea8SstroeseFurther special Environment Variables: 3840c1551ea8Sstroese 3841c1551ea8Sstroese ver - Contains the U-Boot version string as printed 3842c1551ea8Sstroese with the "version" command. This variable is 3843c1551ea8Sstroese readonly (see CONFIG_VERSION_VARIABLE). 3844c1551ea8Sstroese 3845c1551ea8Sstroese 3846c609719bSwdenkPlease note that changes to some configuration parameters may take 3847c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-). 3848c609719bSwdenk 3849c609719bSwdenk 3850f07771ccSwdenkCommand Line Parsing: 3851f07771ccSwdenk===================== 3852f07771ccSwdenk 3853f07771ccSwdenkThere are two different command line parsers available with U-Boot: 38547152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell: 3855f07771ccSwdenk 3856f07771ccSwdenkOld, simple command line parser: 3857f07771ccSwdenk-------------------------------- 3858f07771ccSwdenk 3859f07771ccSwdenk- supports environment variables (through setenv / saveenv commands) 3860f07771ccSwdenk- several commands on one line, separated by ';' 3861fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax 3862f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\', 3863f07771ccSwdenk for example: 3864fe126d8bSWolfgang Denk setenv bootcmd bootm \${address} 3865f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example: 3866f07771ccSwdenk setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off' 3867f07771ccSwdenk 3868f07771ccSwdenkHush shell: 3869f07771ccSwdenk----------- 3870f07771ccSwdenk 3871f07771ccSwdenk- similar to Bourne shell, with control structures like 3872f07771ccSwdenk if...then...else...fi, for...do...done; while...do...done, 3873f07771ccSwdenk until...do...done, ... 3874f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv 3875f07771ccSwdenk commands) and local shell variables (through standard shell syntax 3876f07771ccSwdenk "name=value"); only environment variables can be used with "run" 3877f07771ccSwdenk command 3878f07771ccSwdenk 3879f07771ccSwdenkGeneral rules: 3880f07771ccSwdenk-------------- 3881f07771ccSwdenk 3882f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run" 3883f07771ccSwdenk command) contains several commands separated by semicolon, and 3884f07771ccSwdenk one of these commands fails, then the remaining commands will be 3885f07771ccSwdenk executed anyway. 3886f07771ccSwdenk 3887f07771ccSwdenk(2) If you execute several variables with one call to run (i. e. 388811ccc33fSMarcel Ziswiler calling run with a list of variables as arguments), any failing 3889f07771ccSwdenk command will cause "run" to terminate, i. e. the remaining 3890f07771ccSwdenk variables are not executed. 3891f07771ccSwdenk 3892c609719bSwdenkNote for Redundant Ethernet Interfaces: 3893c609719bSwdenk======================================= 3894c609719bSwdenk 389511ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports 3896c609719bSwdenksuch configurations and is capable of automatic selection of a 38977152b1d0Swdenk"working" interface when needed. MAC assignment works as follows: 3898c609719bSwdenk 3899c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding 3900c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0), 3901c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ... 3902c609719bSwdenk 3903c609719bSwdenkIf the network interface stores some valid MAC address (for instance 3904c609719bSwdenkin SROM), this is used as default address if there is NO correspon- 3905c609719bSwdenkding setting in the environment; if the corresponding environment 3906c609719bSwdenkvariable is set, this overrides the settings in the card; that means: 3907c609719bSwdenk 3908c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the 3909c609719bSwdenk environment, the SROM's address is used. 3910c609719bSwdenk 3911c609719bSwdenko If there is no valid address in the SROM, and a definition in the 3912c609719bSwdenk environment exists, then the value from the environment variable is 3913c609719bSwdenk used. 3914c609719bSwdenk 3915c609719bSwdenko If both the SROM and the environment contain a MAC address, and 3916c609719bSwdenk both addresses are the same, this MAC address is used. 3917c609719bSwdenk 3918c609719bSwdenko If both the SROM and the environment contain a MAC address, and the 3919c609719bSwdenk addresses differ, the value from the environment is used and a 3920c609719bSwdenk warning is printed. 3921c609719bSwdenk 3922c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error 3923c609719bSwdenk is raised. 3924c609719bSwdenk 3925ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses 3926ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process. This 3927ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable. 3928ecee9324SBen WarrenThe naming convention is as follows: 3929ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc. 3930c609719bSwdenk 3931c609719bSwdenkImage Formats: 3932c609719bSwdenk============== 3933c609719bSwdenk 39343310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on) 39353310c549SMarian Balakowiczimages in two formats: 39363310c549SMarian Balakowicz 39373310c549SMarian BalakowiczNew uImage format (FIT) 39383310c549SMarian Balakowicz----------------------- 39393310c549SMarian Balakowicz 39403310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar 39413310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple 39423310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by 39433310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory. 39443310c549SMarian Balakowicz 39453310c549SMarian Balakowicz 39463310c549SMarian BalakowiczOld uImage format 39473310c549SMarian Balakowicz----------------- 39483310c549SMarian Balakowicz 39493310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything, 39503310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for 39513310c549SMarian Balakowiczdetails; basically, the header defines the following image properties: 3952c609719bSwdenk 3953c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD, 3954c609719bSwdenk 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks, 3955f5ed9e39SPeter Tyser LynxOS, pSOS, QNX, RTEMS, INTEGRITY; 3956f5ed9e39SPeter Tyser Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS, 3957f5ed9e39SPeter Tyser INTEGRITY). 39587b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86, 3959afc1ce82SMacpaul Lin IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit; 3960afc1ce82SMacpaul Lin Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC). 3961c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2) 3962c609719bSwdenk* Load Address 3963c609719bSwdenk* Entry Point 3964c609719bSwdenk* Image Name 3965c609719bSwdenk* Image Timestamp 3966c609719bSwdenk 3967c609719bSwdenkThe header is marked by a special Magic Number, and both the header 3968c609719bSwdenkand the data portions of the image are secured against corruption by 3969c609719bSwdenkCRC32 checksums. 3970c609719bSwdenk 3971c609719bSwdenk 3972c609719bSwdenkLinux Support: 3973c609719bSwdenk============== 3974c609719bSwdenk 3975c609719bSwdenkAlthough U-Boot should support any OS or standalone application 39767152b1d0Swdenkeasily, the main focus has always been on Linux during the design of 3977c609719bSwdenkU-Boot. 3978c609719bSwdenk 3979c609719bSwdenkU-Boot includes many features that so far have been part of some 3980c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any 3981c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image; 3982c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation 39837152b1d0Swdenkserves several purposes: 3984c609719bSwdenk 3985c609719bSwdenk- the same features can be used for other OS or standalone 3986c609719bSwdenk applications (for instance: using compressed images to reduce the 3987c609719bSwdenk Flash memory footprint) 3988c609719bSwdenk 3989c609719bSwdenk- it becomes much easier to port new Linux kernel versions because 39907152b1d0Swdenk lots of low-level, hardware dependent stuff are done by U-Boot 3991c609719bSwdenk 3992c609719bSwdenk- the same Linux kernel image can now be used with different "initrd" 3993c609719bSwdenk images; of course this also means that different kernel images can 3994c609719bSwdenk be run with the same "initrd". This makes testing easier (you don't 3995c609719bSwdenk have to build a new "zImage.initrd" Linux image when you just 3996c609719bSwdenk change a file in your "initrd"). Also, a field-upgrade of the 3997c609719bSwdenk software is easier now. 3998c609719bSwdenk 3999c609719bSwdenk 4000c609719bSwdenkLinux HOWTO: 4001c609719bSwdenk============ 4002c609719bSwdenk 4003c609719bSwdenkPorting Linux to U-Boot based systems: 4004c609719bSwdenk--------------------------------------- 4005c609719bSwdenk 4006c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to 4007c609719bSwdenkconfigure the Linux device drivers for use with your target hardware 4008c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to 4009c609719bSwdenkLinux :-). 4010c609719bSwdenk 4011a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot). 4012c609719bSwdenk 4013c609719bSwdenkJust make sure your machine specific header file (for instance 4014c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board 40151dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h, 40161dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value 40176d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR. 4018c609719bSwdenk 4019c609719bSwdenk 4020c609719bSwdenkConfiguring the Linux kernel: 4021c609719bSwdenk----------------------------- 4022c609719bSwdenk 4023c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root 4024c609719bSwdenkdevice (initial ramdisk, NFS) for your target system. 4025c609719bSwdenk 4026c609719bSwdenk 4027c609719bSwdenkBuilding a Linux Image: 4028c609719bSwdenk----------------------- 4029c609719bSwdenk 403024ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are 403124ee89b9Swdenknot used. If you use recent kernel source, a new build target 403224ee89b9Swdenk"uImage" will exist which automatically builds an image usable by 403324ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target, 403424ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a 403524ee89b9Swdenk100% compatible format. 4036c609719bSwdenk 4037c609719bSwdenkExample: 4038c609719bSwdenk 4039c609719bSwdenk make TQM850L_config 4040c609719bSwdenk make oldconfig 4041c609719bSwdenk make dep 404224ee89b9Swdenk make uImage 4043c609719bSwdenk 404424ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to 404524ee89b9Swdenkencapsulate a compressed Linux kernel image with header information, 404624ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing: 4047c609719bSwdenk 404824ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format): 404924ee89b9Swdenk 405024ee89b9Swdenk* convert the kernel into a raw binary image: 405124ee89b9Swdenk 405224ee89b9Swdenk ${CROSS_COMPILE}-objcopy -O binary \ 405324ee89b9Swdenk -R .note -R .comment \ 405424ee89b9Swdenk -S vmlinux linux.bin 405524ee89b9Swdenk 405624ee89b9Swdenk* compress the binary image: 405724ee89b9Swdenk 405824ee89b9Swdenk gzip -9 linux.bin 405924ee89b9Swdenk 406024ee89b9Swdenk* package compressed binary image for U-Boot: 406124ee89b9Swdenk 406224ee89b9Swdenk mkimage -A ppc -O linux -T kernel -C gzip \ 406324ee89b9Swdenk -a 0 -e 0 -n "Linux Kernel Image" \ 406424ee89b9Swdenk -d linux.bin.gz uImage 406524ee89b9Swdenk 406624ee89b9Swdenk 406724ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use 406824ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or 406924ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64 407024ee89b9Swdenkbyte header containing information about target architecture, 407124ee89b9Swdenkoperating system, image type, compression method, entry points, time 407224ee89b9Swdenkstamp, CRC32 checksums, etc. 407324ee89b9Swdenk 407424ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and 407524ee89b9Swdenkprint the header information, or to build new images. 4076c609719bSwdenk 4077c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information 4078c609719bSwdenkcontained in the header of an existing U-Boot image; this includes 4079c609719bSwdenkchecksum verification: 4080c609719bSwdenk 4081c609719bSwdenk tools/mkimage -l image 4082c609719bSwdenk -l ==> list image header information 4083c609719bSwdenk 4084c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image 4085c609719bSwdenkfrom a "data file" which is used as image payload: 4086c609719bSwdenk 4087c609719bSwdenk tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \ 4088c609719bSwdenk -n name -d data_file image 4089c609719bSwdenk -A ==> set architecture to 'arch' 4090c609719bSwdenk -O ==> set operating system to 'os' 4091c609719bSwdenk -T ==> set image type to 'type' 4092c609719bSwdenk -C ==> set compression type 'comp' 4093c609719bSwdenk -a ==> set load address to 'addr' (hex) 4094c609719bSwdenk -e ==> set entry point to 'ep' (hex) 4095c609719bSwdenk -n ==> set image name to 'name' 4096c609719bSwdenk -d ==> use image data from 'datafile' 4097c609719bSwdenk 409869459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load 409969459791Swdenkaddress (0x00000000), but the entry point address depends on the 410069459791Swdenkkernel version: 4101c609719bSwdenk 4102c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C, 410324ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000. 4104c609719bSwdenk 4105c609719bSwdenkSo a typical call to build a U-Boot image would read: 4106c609719bSwdenk 410724ee89b9Swdenk -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 410824ee89b9Swdenk > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \ 4109a47a12beSStefan Roese > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \ 411024ee89b9Swdenk > examples/uImage.TQM850L 411124ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 4112c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 4113c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 4114c609719bSwdenk Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 4115c609719bSwdenk Load Address: 0x00000000 411624ee89b9Swdenk Entry Point: 0x00000000 4117c609719bSwdenk 4118c609719bSwdenkTo verify the contents of the image (or check for corruption): 4119c609719bSwdenk 412024ee89b9Swdenk -> tools/mkimage -l examples/uImage.TQM850L 412124ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 4122c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 4123c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 4124c609719bSwdenk Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 4125c609719bSwdenk Load Address: 0x00000000 412624ee89b9Swdenk Entry Point: 0x00000000 4127c609719bSwdenk 4128c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade 4129c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this 4130c609719bSwdenkneeds more space in Flash, but boots much faster since it does not 4131c609719bSwdenkneed to be uncompressed: 4132c609719bSwdenk 4133a47a12beSStefan Roese -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz 413424ee89b9Swdenk -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 413524ee89b9Swdenk > -A ppc -O linux -T kernel -C none -a 0 -e 0 \ 4136a47a12beSStefan Roese > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \ 413724ee89b9Swdenk > examples/uImage.TQM850L-uncompressed 413824ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 4139c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 4140c609719bSwdenk Image Type: PowerPC Linux Kernel Image (uncompressed) 4141c609719bSwdenk Data Size: 792160 Bytes = 773.59 kB = 0.76 MB 4142c609719bSwdenk Load Address: 0x00000000 414324ee89b9Swdenk Entry Point: 0x00000000 4144c609719bSwdenk 4145c609719bSwdenk 4146c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file 4147c609719bSwdenkwhen your kernel is intended to use an initial ramdisk: 4148c609719bSwdenk 4149c609719bSwdenk -> tools/mkimage -n 'Simple Ramdisk Image' \ 4150c609719bSwdenk > -A ppc -O linux -T ramdisk -C gzip \ 4151c609719bSwdenk > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd 4152c609719bSwdenk Image Name: Simple Ramdisk Image 4153c609719bSwdenk Created: Wed Jan 12 14:01:50 2000 4154c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 4155c609719bSwdenk Data Size: 566530 Bytes = 553.25 kB = 0.54 MB 4156c609719bSwdenk Load Address: 0x00000000 4157c609719bSwdenk Entry Point: 0x00000000 4158c609719bSwdenk 4159c609719bSwdenk 4160c609719bSwdenkInstalling a Linux Image: 4161c609719bSwdenk------------------------- 4162c609719bSwdenk 4163c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface, 4164c609719bSwdenkyou must convert the image to S-Record format: 4165c609719bSwdenk 4166c609719bSwdenk objcopy -I binary -O srec examples/image examples/image.srec 4167c609719bSwdenk 4168c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot 4169c609719bSwdenkimage header, so the resulting S-Record file will be relative to 4170c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to 4171c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads' 4172c609719bSwdenkcommand. 4173c609719bSwdenk 4174c609719bSwdenkExample: install the image to address 0x40100000 (which on the 4175c609719bSwdenkTQM8xxL is in the first Flash bank): 4176c609719bSwdenk 4177c609719bSwdenk => erase 40100000 401FFFFF 4178c609719bSwdenk 4179c609719bSwdenk .......... done 4180c609719bSwdenk Erased 8 sectors 4181c609719bSwdenk 4182c609719bSwdenk => loads 40100000 4183c609719bSwdenk ## Ready for S-Record download ... 4184c609719bSwdenk ~>examples/image.srec 4185c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 12 13 ... 4186c609719bSwdenk ... 4187c609719bSwdenk 15989 15990 15991 15992 4188c609719bSwdenk [file transfer complete] 4189c609719bSwdenk [connected] 4190c609719bSwdenk ## Start Addr = 0x00000000 4191c609719bSwdenk 4192c609719bSwdenk 4193c609719bSwdenkYou can check the success of the download using the 'iminfo' command; 4194c609719bSwdenkthis includes a checksum verification so you can be sure no data 4195c609719bSwdenkcorruption happened: 4196c609719bSwdenk 4197c609719bSwdenk => imi 40100000 4198c609719bSwdenk 4199c609719bSwdenk ## Checking Image at 40100000 ... 4200c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 4201c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 4202c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 4203c609719bSwdenk Load Address: 00000000 4204c609719bSwdenk Entry Point: 0000000c 4205c609719bSwdenk Verifying Checksum ... OK 4206c609719bSwdenk 4207c609719bSwdenk 4208c609719bSwdenkBoot Linux: 4209c609719bSwdenk----------- 4210c609719bSwdenk 4211c609719bSwdenkThe "bootm" command is used to boot an application that is stored in 4212c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents 4213c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as 4214c609719bSwdenkparameters. You can check and modify this variable using the 4215c609719bSwdenk"printenv" and "setenv" commands: 4216c609719bSwdenk 4217c609719bSwdenk 4218c609719bSwdenk => printenv bootargs 4219c609719bSwdenk bootargs=root=/dev/ram 4220c609719bSwdenk 4221c609719bSwdenk => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 4222c609719bSwdenk 4223c609719bSwdenk => printenv bootargs 4224c609719bSwdenk bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 4225c609719bSwdenk 4226c609719bSwdenk => bootm 40020000 4227c609719bSwdenk ## Booting Linux kernel at 40020000 ... 4228c609719bSwdenk Image Name: 2.2.13 for NFS on TQM850L 4229c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 4230c609719bSwdenk Data Size: 381681 Bytes = 372 kB = 0 MB 4231c609719bSwdenk Load Address: 00000000 4232c609719bSwdenk Entry Point: 0000000c 4233c609719bSwdenk Verifying Checksum ... OK 4234c609719bSwdenk Uncompressing Kernel Image ... OK 4235c609719bSwdenk 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 4236c609719bSwdenk Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 4237c609719bSwdenk time_init: decrementer frequency = 187500000/60 4238c609719bSwdenk Calibrating delay loop... 49.77 BogoMIPS 4239c609719bSwdenk Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000] 4240c609719bSwdenk ... 4241c609719bSwdenk 424211ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass 42437152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT 4244c609719bSwdenkformat!) to the "bootm" command: 4245c609719bSwdenk 4246c609719bSwdenk => imi 40100000 40200000 4247c609719bSwdenk 4248c609719bSwdenk ## Checking Image at 40100000 ... 4249c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 4250c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 4251c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 4252c609719bSwdenk Load Address: 00000000 4253c609719bSwdenk Entry Point: 0000000c 4254c609719bSwdenk Verifying Checksum ... OK 4255c609719bSwdenk 4256c609719bSwdenk ## Checking Image at 40200000 ... 4257c609719bSwdenk Image Name: Simple Ramdisk Image 4258c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 4259c609719bSwdenk Data Size: 566530 Bytes = 553 kB = 0 MB 4260c609719bSwdenk Load Address: 00000000 4261c609719bSwdenk Entry Point: 00000000 4262c609719bSwdenk Verifying Checksum ... OK 4263c609719bSwdenk 4264c609719bSwdenk => bootm 40100000 40200000 4265c609719bSwdenk ## Booting Linux kernel at 40100000 ... 4266c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 4267c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 4268c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 4269c609719bSwdenk Load Address: 00000000 4270c609719bSwdenk Entry Point: 0000000c 4271c609719bSwdenk Verifying Checksum ... OK 4272c609719bSwdenk Uncompressing Kernel Image ... OK 4273c609719bSwdenk ## Loading RAMDisk Image at 40200000 ... 4274c609719bSwdenk Image Name: Simple Ramdisk Image 4275c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 4276c609719bSwdenk Data Size: 566530 Bytes = 553 kB = 0 MB 4277c609719bSwdenk Load Address: 00000000 4278c609719bSwdenk Entry Point: 00000000 4279c609719bSwdenk Verifying Checksum ... OK 4280c609719bSwdenk Loading Ramdisk ... OK 4281c609719bSwdenk 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 4282c609719bSwdenk Boot arguments: root=/dev/ram 4283c609719bSwdenk time_init: decrementer frequency = 187500000/60 4284c609719bSwdenk Calibrating delay loop... 49.77 BogoMIPS 4285c609719bSwdenk ... 4286c609719bSwdenk RAMDISK: Compressed image found at block 0 4287c609719bSwdenk VFS: Mounted root (ext2 filesystem). 4288c609719bSwdenk 4289c609719bSwdenk bash# 4290c609719bSwdenk 42910267768eSMatthew McClintockBoot Linux and pass a flat device tree: 42920267768eSMatthew McClintock----------- 42930267768eSMatthew McClintock 42940267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section 42950267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The 42960267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated 42970267768eSMatthew McClintockflat device tree: 42980267768eSMatthew McClintock 42990267768eSMatthew McClintock=> print oftaddr 43000267768eSMatthew McClintockoftaddr=0x300000 43010267768eSMatthew McClintock=> print oft 43020267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb 43030267768eSMatthew McClintock=> tftp $oftaddr $oft 43040267768eSMatthew McClintockSpeed: 1000, full duplex 43050267768eSMatthew McClintockUsing TSEC0 device 43060267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101 43070267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'. 43080267768eSMatthew McClintockLoad address: 0x300000 43090267768eSMatthew McClintockLoading: # 43100267768eSMatthew McClintockdone 43110267768eSMatthew McClintockBytes transferred = 4106 (100a hex) 43120267768eSMatthew McClintock=> tftp $loadaddr $bootfile 43130267768eSMatthew McClintockSpeed: 1000, full duplex 43140267768eSMatthew McClintockUsing TSEC0 device 43150267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2 43160267768eSMatthew McClintockFilename 'uImage'. 43170267768eSMatthew McClintockLoad address: 0x200000 43180267768eSMatthew McClintockLoading:############ 43190267768eSMatthew McClintockdone 43200267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex) 43210267768eSMatthew McClintock=> print loadaddr 43220267768eSMatthew McClintockloadaddr=200000 43230267768eSMatthew McClintock=> print oftaddr 43240267768eSMatthew McClintockoftaddr=0x300000 43250267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr 43260267768eSMatthew McClintock## Booting image at 00200000 ... 43270267768eSMatthew McClintock Image Name: Linux-2.6.17-dirty 43280267768eSMatthew McClintock Image Type: PowerPC Linux Kernel Image (gzip compressed) 43290267768eSMatthew McClintock Data Size: 1029343 Bytes = 1005.2 kB 43300267768eSMatthew McClintock Load Address: 00000000 43310267768eSMatthew McClintock Entry Point: 00000000 43320267768eSMatthew McClintock Verifying Checksum ... OK 43330267768eSMatthew McClintock Uncompressing Kernel Image ... OK 43340267768eSMatthew McClintockBooting using flat device tree at 0x300000 43350267768eSMatthew McClintockUsing MPC85xx ADS machine description 43360267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb 43370267768eSMatthew McClintock[snip] 43380267768eSMatthew McClintock 43390267768eSMatthew McClintock 43406069ff26SwdenkMore About U-Boot Image Types: 43416069ff26Swdenk------------------------------ 43426069ff26Swdenk 43436069ff26SwdenkU-Boot supports the following image types: 43446069ff26Swdenk 43456069ff26Swdenk "Standalone Programs" are directly runnable in the environment 43466069ff26Swdenk provided by U-Boot; it is expected that (if they behave 43476069ff26Swdenk well) you can continue to work in U-Boot after return from 43486069ff26Swdenk the Standalone Program. 43496069ff26Swdenk "OS Kernel Images" are usually images of some Embedded OS which 43506069ff26Swdenk will take over control completely. Usually these programs 43516069ff26Swdenk will install their own set of exception handlers, device 43526069ff26Swdenk drivers, set up the MMU, etc. - this means, that you cannot 43536069ff26Swdenk expect to re-enter U-Boot except by resetting the CPU. 43546069ff26Swdenk "RAMDisk Images" are more or less just data blocks, and their 43556069ff26Swdenk parameters (address, size) are passed to an OS kernel that is 43566069ff26Swdenk being started. 43576069ff26Swdenk "Multi-File Images" contain several images, typically an OS 43586069ff26Swdenk (Linux) kernel image and one or more data images like 43596069ff26Swdenk RAMDisks. This construct is useful for instance when you want 43606069ff26Swdenk to boot over the network using BOOTP etc., where the boot 43616069ff26Swdenk server provides just a single image file, but you want to get 43626069ff26Swdenk for instance an OS kernel and a RAMDisk image. 43636069ff26Swdenk 43646069ff26Swdenk "Multi-File Images" start with a list of image sizes, each 43656069ff26Swdenk image size (in bytes) specified by an "uint32_t" in network 43666069ff26Swdenk byte order. This list is terminated by an "(uint32_t)0". 43676069ff26Swdenk Immediately after the terminating 0 follow the images, one by 43686069ff26Swdenk one, all aligned on "uint32_t" boundaries (size rounded up to 43696069ff26Swdenk a multiple of 4 bytes). 43706069ff26Swdenk 43716069ff26Swdenk "Firmware Images" are binary images containing firmware (like 43726069ff26Swdenk U-Boot or FPGA images) which usually will be programmed to 43736069ff26Swdenk flash memory. 43746069ff26Swdenk 43756069ff26Swdenk "Script files" are command sequences that will be executed by 43766069ff26Swdenk U-Boot's command interpreter; this feature is especially 43776069ff26Swdenk useful when you configure U-Boot to use a real shell (hush) 43786069ff26Swdenk as command interpreter. 43796069ff26Swdenk 4380c609719bSwdenk 4381c609719bSwdenkStandalone HOWTO: 4382c609719bSwdenk================= 4383c609719bSwdenk 4384c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and 4385c609719bSwdenkrun "standalone" applications, which can use some resources of 4386c609719bSwdenkU-Boot like console I/O functions or interrupt services. 4387c609719bSwdenk 4388c609719bSwdenkTwo simple examples are included with the sources: 4389c609719bSwdenk 4390c609719bSwdenk"Hello World" Demo: 4391c609719bSwdenk------------------- 4392c609719bSwdenk 4393c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo 4394c609719bSwdenkapplication; it is automatically compiled when you build U-Boot. 4395c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it 4396c609719bSwdenklike that: 4397c609719bSwdenk 4398c609719bSwdenk => loads 4399c609719bSwdenk ## Ready for S-Record download ... 4400c609719bSwdenk ~>examples/hello_world.srec 4401c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 ... 4402c609719bSwdenk [file transfer complete] 4403c609719bSwdenk [connected] 4404c609719bSwdenk ## Start Addr = 0x00040004 4405c609719bSwdenk 4406c609719bSwdenk => go 40004 Hello World! This is a test. 4407c609719bSwdenk ## Starting application at 0x00040004 ... 4408c609719bSwdenk Hello World 4409c609719bSwdenk argc = 7 4410c609719bSwdenk argv[0] = "40004" 4411c609719bSwdenk argv[1] = "Hello" 4412c609719bSwdenk argv[2] = "World!" 4413c609719bSwdenk argv[3] = "This" 4414c609719bSwdenk argv[4] = "is" 4415c609719bSwdenk argv[5] = "a" 4416c609719bSwdenk argv[6] = "test." 4417c609719bSwdenk argv[7] = "<NULL>" 4418c609719bSwdenk Hit any key to exit ... 4419c609719bSwdenk 4420c609719bSwdenk ## Application terminated, rc = 0x0 4421c609719bSwdenk 4422c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt 4423c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'. 4424c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second. 4425c609719bSwdenkThe interrupt service routine is trivial, just printing a '.' 4426c609719bSwdenkcharacter, but this is just a demo program. The application can be 4427c609719bSwdenkcontrolled by the following keys: 4428c609719bSwdenk 4429c609719bSwdenk ? - print current values og the CPM Timer registers 4430c609719bSwdenk b - enable interrupts and start timer 4431c609719bSwdenk e - stop timer and disable interrupts 4432c609719bSwdenk q - quit application 4433c609719bSwdenk 4434c609719bSwdenk => loads 4435c609719bSwdenk ## Ready for S-Record download ... 4436c609719bSwdenk ~>examples/timer.srec 4437c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 ... 4438c609719bSwdenk [file transfer complete] 4439c609719bSwdenk [connected] 4440c609719bSwdenk ## Start Addr = 0x00040004 4441c609719bSwdenk 4442c609719bSwdenk => go 40004 4443c609719bSwdenk ## Starting application at 0x00040004 ... 4444c609719bSwdenk TIMERS=0xfff00980 4445c609719bSwdenk Using timer 1 4446c609719bSwdenk tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0 4447c609719bSwdenk 4448c609719bSwdenkHit 'b': 4449c609719bSwdenk [q, b, e, ?] Set interval 1000000 us 4450c609719bSwdenk Enabling timer 4451c609719bSwdenkHit '?': 4452c609719bSwdenk [q, b, e, ?] ........ 4453c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0 4454c609719bSwdenkHit '?': 4455c609719bSwdenk [q, b, e, ?] . 4456c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0 4457c609719bSwdenkHit '?': 4458c609719bSwdenk [q, b, e, ?] . 4459c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0 4460c609719bSwdenkHit '?': 4461c609719bSwdenk [q, b, e, ?] . 4462c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0 4463c609719bSwdenkHit 'e': 4464c609719bSwdenk [q, b, e, ?] ...Stopping timer 4465c609719bSwdenkHit 'q': 4466c609719bSwdenk [q, b, e, ?] ## Application terminated, rc = 0x0 4467c609719bSwdenk 4468c609719bSwdenk 446985ec0bccSwdenkMinicom warning: 447085ec0bccSwdenk================ 447185ec0bccSwdenk 44727152b1d0SwdenkOver time, many people have reported problems when trying to use the 447385ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd) 447485ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under 4475f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and 447685ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and 447785ec0bccSwdenkuse "cu" for S-Record download ("loads" command). 447885ec0bccSwdenk 447952f52c14SwdenkNevertheless, if you absolutely want to use it try adding this 448052f52c14Swdenkconfiguration to your "File transfer protocols" section: 448152f52c14Swdenk 448252f52c14Swdenk Name Program Name U/D FullScr IO-Red. Multi 448352f52c14Swdenk X kermit /usr/bin/kermit -i -l %l -s Y U Y N N 448452f52c14Swdenk Y kermit /usr/bin/kermit -i -l %l -r N D Y N N 448552f52c14Swdenk 448652f52c14Swdenk 4487c609719bSwdenkNetBSD Notes: 4488c609719bSwdenk============= 4489c609719bSwdenk 4490c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host 4491c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx). 4492c609719bSwdenk 4493c609719bSwdenkBuilding requires a cross environment; it is known to work on 4494c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also 4495c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make). 4496c609719bSwdenkNote that the cross-powerpc package does not install include files; 4497c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is 4498c609719bSwdenkmissing. This file has to be installed and patched manually: 4499c609719bSwdenk 4500c609719bSwdenk # cd /usr/pkg/cross/powerpc-netbsd/include 4501c609719bSwdenk # mkdir powerpc 4502c609719bSwdenk # ln -s powerpc machine 4503c609719bSwdenk # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h 4504c609719bSwdenk # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST 4505c609719bSwdenk 4506c609719bSwdenkNative builds *don't* work due to incompatibilities between native 4507c609719bSwdenkand U-Boot include files. 4508c609719bSwdenk 4509c609719bSwdenkBooting assumes that (the first part of) the image booted is a 4510c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel 4511c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source 4512c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the 45132a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz 4514c609719bSwdenk 4515c609719bSwdenk 4516c609719bSwdenkImplementation Internals: 4517c609719bSwdenk========================= 4518c609719bSwdenk 4519c609719bSwdenkThe following is not intended to be a complete description of every 4520c609719bSwdenkimplementation detail. However, it should help to understand the 4521c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom 4522c609719bSwdenkhardware. 4523c609719bSwdenk 4524c609719bSwdenk 4525c609719bSwdenkInitial Stack, Global Data: 4526c609719bSwdenk--------------------------- 4527c609719bSwdenk 4528c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot 4529c609719bSwdenkstarts running out of ROM (flash memory), usually without access to 4530c609719bSwdenksystem RAM (because the memory controller is not initialized yet). 4531c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS 4532c609719bSwdenkis not initialized as zero. To be able to get a C environment working 4533c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation 4534c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU 4535c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and 4536c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be 4537c609719bSwdenklocked as (mis-) used as memory, etc. 4538c609719bSwdenk 45397152b1d0Swdenk Chris Hallinan posted a good summary of these issues to the 45400668236bSWolfgang Denk U-Boot mailing list: 454143d9616cSwdenk 454243d9616cSwdenk Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)? 454343d9616cSwdenk From: "Chris Hallinan" <clh@net1plus.com> 454443d9616cSwdenk Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET) 454543d9616cSwdenk ... 454643d9616cSwdenk 454743d9616cSwdenk Correct me if I'm wrong, folks, but the way I understand it 454843d9616cSwdenk is this: Using DCACHE as initial RAM for Stack, etc, does not 454943d9616cSwdenk require any physical RAM backing up the cache. The cleverness 455043d9616cSwdenk is that the cache is being used as a temporary supply of 455143d9616cSwdenk necessary storage before the SDRAM controller is setup. It's 455211ccc33fSMarcel Ziswiler beyond the scope of this list to explain the details, but you 455343d9616cSwdenk can see how this works by studying the cache architecture and 455443d9616cSwdenk operation in the architecture and processor-specific manuals. 455543d9616cSwdenk 455643d9616cSwdenk OCM is On Chip Memory, which I believe the 405GP has 4K. It 455743d9616cSwdenk is another option for the system designer to use as an 455811ccc33fSMarcel Ziswiler initial stack/RAM area prior to SDRAM being available. Either 455943d9616cSwdenk option should work for you. Using CS 4 should be fine if your 456043d9616cSwdenk board designers haven't used it for something that would 456143d9616cSwdenk cause you grief during the initial boot! It is frequently not 456243d9616cSwdenk used. 456343d9616cSwdenk 45646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere 456543d9616cSwdenk with your processor/board/system design. The default value 456643d9616cSwdenk you will find in any recent u-boot distribution in 45678a316c9bSStefan Roese walnut.h should work for you. I'd set it to a value larger 456843d9616cSwdenk than your SDRAM module. If you have a 64MB SDRAM module, set 456943d9616cSwdenk it above 400_0000. Just make sure your board has no resources 457043d9616cSwdenk that are supposed to respond to that address! That code in 457143d9616cSwdenk start.S has been around a while and should work as is when 457243d9616cSwdenk you get the config right. 457343d9616cSwdenk 457443d9616cSwdenk -Chris Hallinan 457543d9616cSwdenk DS4.COM, Inc. 457643d9616cSwdenk 4577c609719bSwdenkIt is essential to remember this, since it has some impact on the C 4578c609719bSwdenkcode for the initialization procedures: 4579c609719bSwdenk 4580c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt 4581c609719bSwdenk to write it. 4582c609719bSwdenk 458311ccc33fSMarcel Ziswiler* Do not use any uninitialized global data (or implicitely initialized 4584c609719bSwdenk as zero data - BSS segment) at all - this is undefined, initiali- 45857152b1d0Swdenk zation is performed later (when relocating to RAM). 4586c609719bSwdenk 4587c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like 4588c609719bSwdenk that. 4589c609719bSwdenk 4590c609719bSwdenkHaving only the stack as writable memory limits means we cannot use 4591c609719bSwdenknormal global data to share information beween the code. But it 4592c609719bSwdenkturned out that the implementation of U-Boot can be greatly 4593c609719bSwdenksimplified by making a global data structure (gd_t) available to all 4594c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_ 4595c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of 4596c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we 4597c609719bSwdenkplace a pointer (gd) to the global data into a register which we 4598c609719bSwdenkreserve for this purpose. 4599c609719bSwdenk 46007152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the 4601c609719bSwdenkrelevant (E)ABI specifications for the current architecture, and by 4602c609719bSwdenkGCC's implementation. 4603c609719bSwdenk 4604c609719bSwdenkFor PowerPC, the following registers have specific use: 4605c609719bSwdenk R1: stack pointer 4606e7670f6cSWolfgang Denk R2: reserved for system use 4607c609719bSwdenk R3-R4: parameter passing and return values 4608c609719bSwdenk R5-R10: parameter passing 4609c609719bSwdenk R13: small data area pointer 4610c609719bSwdenk R30: GOT pointer 4611c609719bSwdenk R31: frame pointer 4612c609719bSwdenk 4613e6bee808SJoakim Tjernlund (U-Boot also uses R12 as internal GOT pointer. r12 4614e6bee808SJoakim Tjernlund is a volatile register so r12 needs to be reset when 4615e6bee808SJoakim Tjernlund going back and forth between asm and C) 4616c609719bSwdenk 4617e7670f6cSWolfgang Denk ==> U-Boot will use R2 to hold a pointer to the global data 4618c609719bSwdenk 4619c609719bSwdenk Note: on PPC, we could use a static initializer (since the 4620c609719bSwdenk address of the global data structure is known at compile time), 4621c609719bSwdenk but it turned out that reserving a register results in somewhat 4622c609719bSwdenk smaller code - although the code savings are not that big (on 4623c609719bSwdenk average for all boards 752 bytes for the whole U-Boot image, 4624c609719bSwdenk 624 text + 127 data). 4625c609719bSwdenk 4626c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here: 46274c58eb55SMike Frysinger http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface 46284c58eb55SMike Frysinger 4629c4db335cSRobin Getz ==> U-Boot will use P3 to hold a pointer to the global data 46304c58eb55SMike Frysinger 4631c609719bSwdenkOn ARM, the following registers are used: 4632c609719bSwdenk 4633c609719bSwdenk R0: function argument word/integer result 4634c609719bSwdenk R1-R3: function argument word 4635c609719bSwdenk R9: GOT pointer 4636c609719bSwdenk R10: stack limit (used only if stack checking if enabled) 4637c609719bSwdenk R11: argument (frame) pointer 4638c609719bSwdenk R12: temporary workspace 4639c609719bSwdenk R13: stack pointer 4640c609719bSwdenk R14: link register 4641c609719bSwdenk R15: program counter 4642c609719bSwdenk 4643c609719bSwdenk ==> U-Boot will use R8 to hold a pointer to the global data 4644c609719bSwdenk 46450df01fd3SThomas ChouOn Nios II, the ABI is documented here: 46460df01fd3SThomas Chou http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf 46470df01fd3SThomas Chou 46480df01fd3SThomas Chou ==> U-Boot will use gp to hold a pointer to the global data 46490df01fd3SThomas Chou 46500df01fd3SThomas Chou Note: on Nios II, we give "-G0" option to gcc and don't use gp 46510df01fd3SThomas Chou to access small data sections, so gp is free. 46520df01fd3SThomas Chou 4653afc1ce82SMacpaul LinOn NDS32, the following registers are used: 4654afc1ce82SMacpaul Lin 4655afc1ce82SMacpaul Lin R0-R1: argument/return 4656afc1ce82SMacpaul Lin R2-R5: argument 4657afc1ce82SMacpaul Lin R15: temporary register for assembler 4658afc1ce82SMacpaul Lin R16: trampoline register 4659afc1ce82SMacpaul Lin R28: frame pointer (FP) 4660afc1ce82SMacpaul Lin R29: global pointer (GP) 4661afc1ce82SMacpaul Lin R30: link register (LP) 4662afc1ce82SMacpaul Lin R31: stack pointer (SP) 4663afc1ce82SMacpaul Lin PC: program counter (PC) 4664afc1ce82SMacpaul Lin 4665afc1ce82SMacpaul Lin ==> U-Boot will use R10 to hold a pointer to the global data 4666afc1ce82SMacpaul Lin 4667d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope, 4668d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much. 4669c609719bSwdenk 4670c609719bSwdenkMemory Management: 4671c609719bSwdenk------------------ 4672c609719bSwdenk 4673c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the 4674c609719bSwdenkMMU is not used either for address mapping nor for memory protection. 4675c609719bSwdenk 4676c609719bSwdenkThe available memory is mapped to fixed addresses using the memory 4677c609719bSwdenkcontroller. In this process, a contiguous block is formed for each 4678c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several 4679c609719bSwdenkphysical memory banks. 4680c609719bSwdenk 4681c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on 4682c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After 4683c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself 4684c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some 46856d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN 4686c609719bSwdenkconfiguration setting]. Below that, a structure with global Board 4687c609719bSwdenkInfo data is placed, followed by the stack (growing downward). 4688c609719bSwdenk 4689c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB 4690c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF). 4691c609719bSwdenk 4692c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like 4693c609719bSwdenkthis: 4694c609719bSwdenk 4695c609719bSwdenk 0x0000 0000 Exception Vector code 4696c609719bSwdenk : 4697c609719bSwdenk 0x0000 1FFF 4698c609719bSwdenk 0x0000 2000 Free for Application Use 4699c609719bSwdenk : 4700c609719bSwdenk : 4701c609719bSwdenk 4702c609719bSwdenk : 4703c609719bSwdenk : 4704c609719bSwdenk 0x00FB FF20 Monitor Stack (Growing downward) 4705c609719bSwdenk 0x00FB FFAC Board Info Data and permanent copy of global data 4706c609719bSwdenk 0x00FC 0000 Malloc Arena 4707c609719bSwdenk : 4708c609719bSwdenk 0x00FD FFFF 4709c609719bSwdenk 0x00FE 0000 RAM Copy of Monitor Code 4710c609719bSwdenk ... eventually: LCD or video framebuffer 4711c609719bSwdenk ... eventually: pRAM (Protected RAM - unchanged by reset) 4712c609719bSwdenk 0x00FF FFFF [End of RAM] 4713c609719bSwdenk 4714c609719bSwdenk 4715c609719bSwdenkSystem Initialization: 4716c609719bSwdenk---------------------- 4717c609719bSwdenk 4718c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point 471911ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset 4720c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory. 47217152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address. 4722c609719bSwdenkTo be able to implement the initialization code in C, a (small!) 4723c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs 4724c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked 4725c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core, 4726c609719bSwdenkthe caches and the SIU. 4727c609719bSwdenk 4728c609719bSwdenkNext, all (potentially) available memory banks are mapped using a 4729c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries 4730c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash 4731c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is 4732c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a 4733c609719bSwdenksimple memory test is run that determines the size of the SDRAM 4734c609719bSwdenkbanks. 4735c609719bSwdenk 4736c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of 47377152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first 4738c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address 4739c609719bSwdenk0x00000000, with any additional banks following immediately to create 4740c609719bSwdenkcontiguous memory starting from 0. 4741c609719bSwdenk 4742c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area 4743c609719bSwdenkand allocates memory for use by malloc() and for the global Board 4744c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM 4745c609719bSwdenkpages, and the final stack is set up. 4746c609719bSwdenk 4747c609719bSwdenkOnly after this relocation will you have a "normal" C environment; 4748c609719bSwdenkuntil that you are restricted in several ways, mostly because you are 4749c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a 4750c609719bSwdenknew address in RAM. 4751c609719bSwdenk 4752c609719bSwdenk 4753c609719bSwdenkU-Boot Porting Guide: 4754c609719bSwdenk---------------------- 4755c609719bSwdenk 4756c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing 47576aff3115Swdenklist, October 2002] 4758c609719bSwdenk 4759c609719bSwdenk 4760c609719bSwdenkint main(int argc, char *argv[]) 4761c609719bSwdenk{ 4762c609719bSwdenk sighandler_t no_more_time; 4763c609719bSwdenk 4764c609719bSwdenk signal(SIGALRM, no_more_time); 4765c609719bSwdenk alarm(PROJECT_DEADLINE - toSec (3 * WEEK)); 4766c609719bSwdenk 4767c609719bSwdenk if (available_money > available_manpower) { 47686c3fef28SJerry Van Baren Pay consultant to port U-Boot; 4769c609719bSwdenk return 0; 4770c609719bSwdenk } 4771c609719bSwdenk 4772c609719bSwdenk Download latest U-Boot source; 4773c609719bSwdenk 47740668236bSWolfgang Denk Subscribe to u-boot mailing list; 47756aff3115Swdenk 47766c3fef28SJerry Van Baren if (clueless) 4777c609719bSwdenk email("Hi, I am new to U-Boot, how do I get started?"); 4778c609719bSwdenk 4779c609719bSwdenk while (learning) { 4780c609719bSwdenk Read the README file in the top level directory; 47817cb22f97Swdenk Read http://www.denx.de/twiki/bin/view/DULG/Manual; 47826c3fef28SJerry Van Baren Read applicable doc/*.README; 4783c609719bSwdenk Read the source, Luke; 47846c3fef28SJerry Van Baren /* find . -name "*.[chS]" | xargs grep -i <keyword> */ 4785c609719bSwdenk } 4786c609719bSwdenk 47876c3fef28SJerry Van Baren if (available_money > toLocalCurrency ($2500)) 47886c3fef28SJerry Van Baren Buy a BDI3000; 47896c3fef28SJerry Van Baren else 4790c609719bSwdenk Add a lot of aggravation and time; 4791c609719bSwdenk 47926c3fef28SJerry Van Baren if (a similar board exists) { /* hopefully... */ 47936c3fef28SJerry Van Baren cp -a board/<similar> board/<myboard> 47946c3fef28SJerry Van Baren cp include/configs/<similar>.h include/configs/<myboard>.h 47956c3fef28SJerry Van Baren } else { 4796c609719bSwdenk Create your own board support subdirectory; 47976c3fef28SJerry Van Baren Create your own board include/configs/<myboard>.h file; 47986c3fef28SJerry Van Baren } 47996c3fef28SJerry Van Baren Edit new board/<myboard> files 48006c3fef28SJerry Van Baren Edit new include/configs/<myboard>.h 4801c609719bSwdenk 48026c3fef28SJerry Van Baren while (!accepted) { 4803c609719bSwdenk while (!running) { 4804c609719bSwdenk do { 4805c609719bSwdenk Add / modify source code; 4806c609719bSwdenk } until (compiles); 4807c609719bSwdenk Debug; 4808c609719bSwdenk if (clueless) 4809c609719bSwdenk email("Hi, I am having problems..."); 4810c609719bSwdenk } 48116c3fef28SJerry Van Baren Send patch file to the U-Boot email list; 48126c3fef28SJerry Van Baren if (reasonable critiques) 48136c3fef28SJerry Van Baren Incorporate improvements from email list code review; 48146c3fef28SJerry Van Baren else 48156c3fef28SJerry Van Baren Defend code as written; 48166c3fef28SJerry Van Baren } 4817c609719bSwdenk 4818c609719bSwdenk return 0; 4819c609719bSwdenk} 4820c609719bSwdenk 4821c609719bSwdenkvoid no_more_time (int sig) 4822c609719bSwdenk{ 4823c609719bSwdenk hire_a_guru(); 4824c609719bSwdenk} 4825c609719bSwdenk 4826c609719bSwdenk 4827c609719bSwdenkCoding Standards: 4828c609719bSwdenk----------------- 4829c609719bSwdenk 4830c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel 48312c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script 48327ca9296eSWolfgang Denk"scripts/Lindent" in your Linux kernel source directory. 4833c609719bSwdenk 48342c051651SDetlev ZundelSource files originating from a different project (for example the 48352c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not 48362c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those 48372c051651SDetlev Zundelsources. 48382c051651SDetlev Zundel 48392c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in 48402c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//) 48412c051651SDetlev Zundelin your code. 4842c609719bSwdenk 4843c178d3daSwdenkPlease also stick to the following formatting rules: 4844180d3f74Swdenk- remove any trailing white space 48457ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces 4846180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds 48477ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files 4848180d3f74Swdenk- do not add trailing empty lines to source files 4849180d3f74Swdenk 4850c609719bSwdenkSubmissions which do not conform to the standards may be returned 4851c609719bSwdenkwith a request to reformat the changes. 4852c609719bSwdenk 4853c609719bSwdenk 4854c609719bSwdenkSubmitting Patches: 4855c609719bSwdenk------------------- 4856c609719bSwdenk 4857c609719bSwdenkSince the number of patches for U-Boot is growing, we need to 4858c609719bSwdenkestablish some rules. Submissions which do not conform to these rules 4859c609719bSwdenkmay be rejected, even when they contain important and valuable stuff. 4860c609719bSwdenk 48610d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details. 4862218ca724SWolfgang Denk 48630668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>; 48640668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot 48650668236bSWolfgang Denk 4866c609719bSwdenkWhen you send a patch, please include the following information with 4867c609719bSwdenkit: 4868c609719bSwdenk 4869c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes 4870c609719bSwdenk this bug. Please try to include a way of demonstrating that the 4871c609719bSwdenk patch actually fixes something. 4872c609719bSwdenk 4873c609719bSwdenk* For new features: a description of the feature and your 4874c609719bSwdenk implementation. 4875c609719bSwdenk 4876c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch) 4877c609719bSwdenk 4878c609719bSwdenk* For major contributions, your entry to the CREDITS file 4879c609719bSwdenk 4880c609719bSwdenk* When you add support for a new board, don't forget to add this 48817ca9296eSWolfgang Denk board to the MAINTAINERS file, too. 4882c609719bSwdenk 4883c609719bSwdenk* If your patch adds new configuration options, don't forget to 4884c609719bSwdenk document these in the README file. 4885c609719bSwdenk 4886218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly* 4887218ca724SWolfgang Denk recommended) you can easily generate the patch using the 48887ca9296eSWolfgang Denk "git format-patch". If you then use "git send-email" to send it to 4889218ca724SWolfgang Denk the U-Boot mailing list, you will avoid most of the common problems 4890218ca724SWolfgang Denk with some other mail clients. 4891c609719bSwdenk 4892218ca724SWolfgang Denk If you cannot use git, use "diff -purN OLD NEW". If your version of 4893218ca724SWolfgang Denk diff does not support these options, then get the latest version of 4894218ca724SWolfgang Denk GNU diff. 48956dff5529Swdenk 4896218ca724SWolfgang Denk The current directory when running this command shall be the parent 4897218ca724SWolfgang Denk directory of the U-Boot source tree (i. e. please make sure that 4898218ca724SWolfgang Denk your patch includes sufficient directory information for the 4899218ca724SWolfgang Denk affected files). 4900218ca724SWolfgang Denk 4901218ca724SWolfgang Denk We prefer patches as plain text. MIME attachments are discouraged, 4902218ca724SWolfgang Denk and compressed attachments must not be used. 4903c609719bSwdenk 490452f52c14Swdenk* If one logical set of modifications affects or creates several 490552f52c14Swdenk files, all these changes shall be submitted in a SINGLE patch file. 490652f52c14Swdenk 490752f52c14Swdenk* Changesets that contain different, unrelated modifications shall be 490852f52c14Swdenk submitted as SEPARATE patches, one patch per changeset. 490952f52c14Swdenk 491052f52c14Swdenk 4911c609719bSwdenkNotes: 4912c609719bSwdenk 4913c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched 4914c609719bSwdenk source tree and make sure that no errors or warnings are reported 4915c609719bSwdenk for any of the boards. 4916c609719bSwdenk 4917c609719bSwdenk* Keep your modifications to the necessary minimum: A patch 4918c609719bSwdenk containing several unrelated changes or arbitrary reformats will be 4919c609719bSwdenk returned with a request to re-formatting / split it. 4920c609719bSwdenk 4921c609719bSwdenk* If you modify existing code, make sure that your new code does not 4922c609719bSwdenk add to the memory footprint of the code ;-) Small is beautiful! 4923c609719bSwdenk When adding new features, these should compile conditionally only 4924c609719bSwdenk (using #ifdef), and the resulting code with the new feature 4925c609719bSwdenk disabled must not need more memory than the old code without your 4926c609719bSwdenk modification. 492790dc6704Swdenk 49280668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the 49290668236bSWolfgang Denk u-boot mailing list. Bigger patches will be moderated. If they are 49300668236bSWolfgang Denk reasonable and not too big, they will be acknowledged. But patches 49310668236bSWolfgang Denk bigger than the size limit should be avoided. 4932