1c609719bSwdenk# 2cccfc2abSDetlev Zundel# (C) Copyright 2000 - 2009 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 1508d321b81SPeter Tyser /at91rm9200 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 1838d321b81SPeter Tyser /lib Architecture specific library files 1848d321b81SPeter Tyser /nios2 Files generic to Altera NIOS2 architecture 1858d321b81SPeter Tyser /cpu CPU specific files 1868d321b81SPeter Tyser /lib Architecture specific library files 187a47a12beSStefan Roese /powerpc Files generic to PowerPC architecture 1888d321b81SPeter Tyser /cpu CPU specific files 1898d321b81SPeter Tyser /74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs 1908d321b81SPeter Tyser /mpc5xx Files specific to Freescale MPC5xx CPUs 1918d321b81SPeter Tyser /mpc5xxx Files specific to Freescale MPC5xxx CPUs 1928d321b81SPeter Tyser /mpc8xx Files specific to Freescale MPC8xx CPUs 1938d321b81SPeter Tyser /mpc8220 Files specific to Freescale MPC8220 CPUs 1948d321b81SPeter Tyser /mpc824x Files specific to Freescale MPC824x CPUs 1958d321b81SPeter Tyser /mpc8260 Files specific to Freescale MPC8260 CPUs 1968d321b81SPeter Tyser /mpc85xx Files specific to Freescale MPC85xx CPUs 1978d321b81SPeter Tyser /ppc4xx Files specific to AMCC PowerPC 4xx CPUs 1988d321b81SPeter Tyser /lib Architecture specific library files 1998d321b81SPeter Tyser /sh Files generic to SH architecture 2008d321b81SPeter Tyser /cpu CPU specific files 2018d321b81SPeter Tyser /sh2 Files specific to sh2 CPUs 2028d321b81SPeter Tyser /sh3 Files specific to sh3 CPUs 2038d321b81SPeter Tyser /sh4 Files specific to sh4 CPUs 2048d321b81SPeter Tyser /lib Architecture specific library files 2058d321b81SPeter Tyser /sparc Files generic to SPARC architecture 2068d321b81SPeter Tyser /cpu CPU specific files 2078d321b81SPeter Tyser /leon2 Files specific to Gaisler LEON2 SPARC CPU 2088d321b81SPeter Tyser /leon3 Files specific to Gaisler LEON3 SPARC CPU 2098d321b81SPeter Tyser /lib Architecture specific library files 2108d321b81SPeter Tyser/api Machine/arch independent API for external apps 2118d321b81SPeter Tyser/board Board dependent files 2128d321b81SPeter Tyser/common Misc architecture independent functions 2138d321b81SPeter Tyser/disk Code for disk drive partition handling 2148d321b81SPeter Tyser/doc Documentation (don't expect too much) 2158d321b81SPeter Tyser/drivers Commonly used device drivers 2168d321b81SPeter Tyser/examples Example code for standalone applications, etc. 2178d321b81SPeter Tyser/fs Filesystem code (cramfs, ext2, jffs2, etc.) 2188d321b81SPeter Tyser/include Header Files 2198d321b81SPeter Tyser/lib Files generic to all architectures 2208d321b81SPeter Tyser /libfdt Library files to support flattened device trees 2218d321b81SPeter Tyser /lzma Library files to support LZMA decompression 2228d321b81SPeter Tyser /lzo Library files to support LZO decompression 2238d321b81SPeter Tyser/net Networking code 2248d321b81SPeter Tyser/post Power On Self Test 2258d321b81SPeter Tyser/rtc Real Time Clock drivers 2268d321b81SPeter Tyser/tools Tools to build S-Record or U-Boot images, etc. 227c609719bSwdenk 228c609719bSwdenkSoftware Configuration: 229c609719bSwdenk======================= 230c609719bSwdenk 231c609719bSwdenkConfiguration is usually done using C preprocessor defines; the 232c609719bSwdenkrationale behind that is to avoid dead code whenever possible. 233c609719bSwdenk 234c609719bSwdenkThere are two classes of configuration variables: 235c609719bSwdenk 236c609719bSwdenk* Configuration _OPTIONS_: 237c609719bSwdenk These are selectable by the user and have names beginning with 238c609719bSwdenk "CONFIG_". 239c609719bSwdenk 240c609719bSwdenk* Configuration _SETTINGS_: 241c609719bSwdenk These depend on the hardware etc. and should not be meddled with if 242c609719bSwdenk you don't know what you're doing; they have names beginning with 2436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD "CONFIG_SYS_". 244c609719bSwdenk 245c609719bSwdenkLater we will add a configuration tool - probably similar to or even 246c609719bSwdenkidentical to what's used for the Linux kernel. Right now, we have to 247c609719bSwdenkdo the configuration by hand, which means creating some symbolic 248c609719bSwdenklinks and editing some configuration files. We use the TQM8xxL boards 249c609719bSwdenkas an example here. 250c609719bSwdenk 251c609719bSwdenk 252c609719bSwdenkSelection of Processor Architecture and Board Type: 253c609719bSwdenk--------------------------------------------------- 254c609719bSwdenk 255c609719bSwdenkFor all supported boards there are ready-to-use default 256c609719bSwdenkconfigurations available; just type "make <board_name>_config". 257c609719bSwdenk 258c609719bSwdenkExample: For a TQM823L module type: 259c609719bSwdenk 260c609719bSwdenk cd u-boot 261c609719bSwdenk make TQM823L_config 262c609719bSwdenk 26311ccc33fSMarcel ZiswilerFor the Cogent platform, you need to specify the CPU type as well; 264c609719bSwdenke.g. "make cogent_mpc8xx_config". And also configure the cogent 265c609719bSwdenkdirectory according to the instructions in cogent/README. 266c609719bSwdenk 267c609719bSwdenk 268c609719bSwdenkConfiguration Options: 269c609719bSwdenk---------------------- 270c609719bSwdenk 271c609719bSwdenkConfiguration depends on the combination of board and CPU type; all 272c609719bSwdenksuch information is kept in a configuration file 273c609719bSwdenk"include/configs/<board_name>.h". 274c609719bSwdenk 275c609719bSwdenkExample: For a TQM823L module, all configuration settings are in 276c609719bSwdenk"include/configs/TQM823L.h". 277c609719bSwdenk 278c609719bSwdenk 2797f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux 2807f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to 2817f6c2cbcSwdenkbuild a config tool - later. 2827f6c2cbcSwdenk 2837f6c2cbcSwdenk 284c609719bSwdenkThe following options need to be configured: 285c609719bSwdenk 2862628114eSKim Phillips- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX. 287c609719bSwdenk 2882628114eSKim Phillips- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS. 2896ccec449SWolfgang Denk 2906ccec449SWolfgang Denk- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined) 29109ea0de0SHaavard Skinnemoen Define exactly one, e.g. CONFIG_ATSTK1002 292c609719bSwdenk 293c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined) 294c609719bSwdenk Define exactly one of 295c609719bSwdenk CONFIG_CMA286_60_OLD 296c609719bSwdenk--- FIXME --- not tested yet: 297c609719bSwdenk CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P, 298c609719bSwdenk CONFIG_CMA287_23, CONFIG_CMA287_50 299c609719bSwdenk 300c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined) 301c609719bSwdenk Define exactly one of 302c609719bSwdenk CONFIG_CMA101, CONFIG_CMA102 303c609719bSwdenk 304c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined) 305c609719bSwdenk Define one or more of 306c609719bSwdenk CONFIG_CMA302 307c609719bSwdenk 308c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined) 309c609719bSwdenk Define one or more of 310c609719bSwdenk CONFIG_LCD_HEARTBEAT - update a character position on 31111ccc33fSMarcel Ziswiler the LCD display every second with 312c609719bSwdenk a "rotator" |\-/|\-/ 313c609719bSwdenk 3142535d602Swdenk- Board flavour: (if CONFIG_MPC8260ADS is defined) 3152535d602Swdenk CONFIG_ADSTYPE 3162535d602Swdenk Possible values are: 3176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8260ADS - original MPC8260ADS 3186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8266ADS - MPC8266ADS 3196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR 3206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8272ADS - MPC8272ADS 3212535d602Swdenk 322cf946c6dSLei Wen- Marvell Family Member 323cf946c6dSLei Wen CONFIG_SYS_MVFS - define it if you want to enable 324cf946c6dSLei Wen multiple fs option at one time 325cf946c6dSLei Wen for marvell soc family 326cf946c6dSLei Wen 327c609719bSwdenk- MPC824X Family Member (if CONFIG_MPC824X is defined) 328c609719bSwdenk Define exactly one of 329c609719bSwdenk CONFIG_MPC8240, CONFIG_MPC8245 330c609719bSwdenk 33111ccc33fSMarcel Ziswiler- 8xx CPU Options: (if using an MPC8xx CPU) 33266ca92a5Swdenk CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if 33366ca92a5Swdenk get_gclk_freq() cannot work 3345da627a4Swdenk e.g. if there is no 32KHz 3355da627a4Swdenk reference PIT/RTC clock 33666ca92a5Swdenk CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK 33766ca92a5Swdenk or XTAL/EXTAL) 338c609719bSwdenk 33966ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU): 3406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8xx_CPUCLK_MIN 3416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8xx_CPUCLK_MAX 34266ca92a5Swdenk CONFIG_8xx_CPUCLK_DEFAULT 34375d1ea7fSwdenk See doc/README.MPC866 34475d1ea7fSwdenk 3456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MEASURE_CPUCLK 34675d1ea7fSwdenk 34775d1ea7fSwdenk Define this to measure the actual CPU clock instead 34875d1ea7fSwdenk of relying on the correctness of the configured 34975d1ea7fSwdenk values. Mostly useful for board bringup to make sure 35075d1ea7fSwdenk the PLL is locked at the intended frequency. Note 35175d1ea7fSwdenk that this requires a (stable) reference clock (32 kHz 3526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD RTC clock or CONFIG_SYS_8XX_XIN) 35375d1ea7fSwdenk 354506f3918SHeiko Schocher CONFIG_SYS_DELAYED_ICACHE 355506f3918SHeiko Schocher 356506f3918SHeiko Schocher Define this option if you want to enable the 357506f3918SHeiko Schocher ICache only when Code runs from RAM. 358506f3918SHeiko Schocher 359*66412c63SKumar Gala- 85xx CPU Options: 360*66412c63SKumar Gala CONFIG_SYS_FSL_TBCLK_DIV 361*66412c63SKumar Gala 362*66412c63SKumar Gala Defines the core time base clock divider ratio compared to the 363*66412c63SKumar Gala system clock. On most PQ3 devices this is 8, on newer QorIQ 364*66412c63SKumar Gala devices it can be 16 or 32. The ratio varies from SoC to Soc. 365*66412c63SKumar Gala 3660b953ffcSMarkus Klotzbuecher- Intel Monahans options: 3676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO 3680b953ffcSMarkus Klotzbuecher 3690b953ffcSMarkus Klotzbuecher Defines the Monahans run mode to oscillator 3700b953ffcSMarkus Klotzbuecher ratio. Valid values are 8, 16, 24, 31. The core 3710b953ffcSMarkus Klotzbuecher frequency is this value multiplied by 13 MHz. 3720b953ffcSMarkus Klotzbuecher 3736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO 3740b953ffcSMarkus Klotzbuecher 3750b953ffcSMarkus Klotzbuecher Defines the Monahans turbo mode to oscillator 3760b953ffcSMarkus Klotzbuecher ratio. Valid values are 1 (default if undefined) and 3770b953ffcSMarkus Klotzbuecher 2. The core frequency as calculated above is multiplied 3780b953ffcSMarkus Klotzbuecher by this value. 3790b953ffcSMarkus Klotzbuecher 3805da627a4Swdenk- Linux Kernel Interface: 381c609719bSwdenk CONFIG_CLOCKS_IN_MHZ 382c609719bSwdenk 383c609719bSwdenk U-Boot stores all clock information in Hz 384c609719bSwdenk internally. For binary compatibility with older Linux 385c609719bSwdenk kernels (which expect the clocks passed in the 386c609719bSwdenk bd_info data to be in MHz) the environment variable 387c609719bSwdenk "clocks_in_mhz" can be defined so that U-Boot 388c609719bSwdenk converts clock data to MHZ before passing it to the 389c609719bSwdenk Linux kernel. 390c609719bSwdenk When CONFIG_CLOCKS_IN_MHZ is defined, a definition of 391c609719bSwdenk "clocks_in_mhz=1" is automatically included in the 392c609719bSwdenk default environment. 393c609719bSwdenk 3945da627a4Swdenk CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only] 3955da627a4Swdenk 39611ccc33fSMarcel Ziswiler When transferring memsize parameter to linux, some versions 3975da627a4Swdenk expect it to be in bytes, others in MB. 3985da627a4Swdenk Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes. 3995da627a4Swdenk 400fec6d9eeSGerald Van Baren CONFIG_OF_LIBFDT 401f57f70aaSWolfgang Denk 402f57f70aaSWolfgang Denk New kernel versions are expecting firmware settings to be 403213bf8c8SGerald Van Baren passed using flattened device trees (based on open firmware 404213bf8c8SGerald Van Baren concepts). 405213bf8c8SGerald Van Baren 406213bf8c8SGerald Van Baren CONFIG_OF_LIBFDT 407213bf8c8SGerald Van Baren * New libfdt-based support 408213bf8c8SGerald Van Baren * Adds the "fdt" command 4093bb342fcSKim Phillips * The bootm command automatically updates the fdt 410213bf8c8SGerald Van Baren 411b55ae402SMarcel Ziswiler OF_CPU - The proper name of the cpus node (only required for 412b55ae402SMarcel Ziswiler MPC512X and MPC5xxx based boards). 413b55ae402SMarcel Ziswiler OF_SOC - The proper name of the soc node (only required for 414b55ae402SMarcel Ziswiler MPC512X and MPC5xxx based boards). 415f57f70aaSWolfgang Denk OF_TBCLK - The timebase frequency. 416c2871f03SKumar Gala OF_STDOUT_PATH - The path to the console device 417f57f70aaSWolfgang Denk 41811ccc33fSMarcel Ziswiler boards with QUICC Engines require OF_QE to set UCC MAC 41911ccc33fSMarcel Ziswiler addresses 4203bb342fcSKim Phillips 4214e253137SKumar Gala CONFIG_OF_BOARD_SETUP 4224e253137SKumar Gala 4234e253137SKumar Gala Board code has addition modification that it wants to make 4244e253137SKumar Gala to the flat device tree before handing it off to the kernel 4256705d81eSwdenk 4260267768eSMatthew McClintock CONFIG_OF_BOOT_CPU 4270267768eSMatthew McClintock 42811ccc33fSMarcel Ziswiler This define fills in the correct boot CPU in the boot 4290267768eSMatthew McClintock param header, the default value is zero if undefined. 4300267768eSMatthew McClintock 4313887c3fbSHeiko Schocher CONFIG_OF_IDE_FIXUP 4323887c3fbSHeiko Schocher 4333887c3fbSHeiko Schocher U-Boot can detect if an IDE device is present or not. 4343887c3fbSHeiko Schocher If not, and this new config option is activated, U-Boot 4353887c3fbSHeiko Schocher removes the ATA node from the DTS before booting Linux, 4363887c3fbSHeiko Schocher so the Linux IDE driver does not probe the device and 4373887c3fbSHeiko Schocher crash. This is needed for buggy hardware (uc101) where 4383887c3fbSHeiko Schocher no pull down resistor is connected to the signal IDE5V_DD7. 4393887c3fbSHeiko Schocher 4400b2f4ecaSNiklaus Giger- vxWorks boot parameters: 4410b2f4ecaSNiklaus Giger 4420b2f4ecaSNiklaus Giger bootvx constructs a valid bootline using the following 4430b2f4ecaSNiklaus Giger environments variables: bootfile, ipaddr, serverip, hostname. 4440b2f4ecaSNiklaus Giger It loads the vxWorks image pointed bootfile. 4450b2f4ecaSNiklaus Giger 4460b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name 4470b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address 4480b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server 4490b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters 4500b2f4ecaSNiklaus Giger 4510b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_ADD_PARAMS 4520b2f4ecaSNiklaus Giger 4530b2f4ecaSNiklaus Giger Add it at the end of the bootline. E.g "u=username pw=secret" 4540b2f4ecaSNiklaus Giger 4550b2f4ecaSNiklaus Giger Note: If a "bootargs" environment is defined, it will overwride 4560b2f4ecaSNiklaus Giger the defaults discussed just above. 4570b2f4ecaSNiklaus Giger 4586705d81eSwdenk- Serial Ports: 45948d0192fSAndreas Engel CONFIG_PL010_SERIAL 4606705d81eSwdenk 4616705d81eSwdenk Define this if you want support for Amba PrimeCell PL010 UARTs. 4626705d81eSwdenk 46348d0192fSAndreas Engel CONFIG_PL011_SERIAL 4646705d81eSwdenk 4656705d81eSwdenk Define this if you want support for Amba PrimeCell PL011 UARTs. 4666705d81eSwdenk 4676705d81eSwdenk CONFIG_PL011_CLOCK 4686705d81eSwdenk 4696705d81eSwdenk If you have Amba PrimeCell PL011 UARTs, set this variable to 4706705d81eSwdenk the clock speed of the UARTs. 4716705d81eSwdenk 4726705d81eSwdenk CONFIG_PL01x_PORTS 4736705d81eSwdenk 4746705d81eSwdenk If you have Amba PrimeCell PL010 or PL011 UARTs on your board, 4756705d81eSwdenk define this to a list of base addresses for each (supported) 4766705d81eSwdenk port. See e.g. include/configs/versatile.h 4776705d81eSwdenk 4786705d81eSwdenk 479c609719bSwdenk- Console Interface: 480c609719bSwdenk Depending on board, define exactly one serial port 481c609719bSwdenk (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2, 482c609719bSwdenk CONFIG_8xx_CONS_SCC1, ...), or switch off the serial 483c609719bSwdenk console by defining CONFIG_8xx_CONS_NONE 484c609719bSwdenk 485c609719bSwdenk Note: if CONFIG_8xx_CONS_NONE is defined, the serial 486c609719bSwdenk port routines must be defined elsewhere 487c609719bSwdenk (i.e. serial_init(), serial_getc(), ...) 488c609719bSwdenk 489c609719bSwdenk CONFIG_CFB_CONSOLE 490c609719bSwdenk Enables console device for a color framebuffer. Needs following 491c609719bSwdenk defines (cf. smiLynxEM, i8042, board/eltec/bab7xx) 492c609719bSwdenk VIDEO_FB_LITTLE_ENDIAN graphic memory organisation 493c609719bSwdenk (default big endian) 494c609719bSwdenk VIDEO_HW_RECTFILL graphic chip supports 495c609719bSwdenk rectangle fill 496c609719bSwdenk (cf. smiLynxEM) 497c609719bSwdenk VIDEO_HW_BITBLT graphic chip supports 498c609719bSwdenk bit-blit (cf. smiLynxEM) 499c609719bSwdenk VIDEO_VISIBLE_COLS visible pixel columns 500c609719bSwdenk (cols=pitch) 501c609719bSwdenk VIDEO_VISIBLE_ROWS visible pixel rows 502c609719bSwdenk VIDEO_PIXEL_SIZE bytes per pixel 503c609719bSwdenk VIDEO_DATA_FORMAT graphic data format 504c609719bSwdenk (0-5, cf. cfb_console.c) 505c609719bSwdenk VIDEO_FB_ADRS framebuffer address 506c609719bSwdenk VIDEO_KBD_INIT_FCT keyboard int fct 507c609719bSwdenk (i.e. i8042_kbd_init()) 508c609719bSwdenk VIDEO_TSTC_FCT test char fct 509c609719bSwdenk (i.e. i8042_tstc) 510c609719bSwdenk VIDEO_GETC_FCT get char fct 511c609719bSwdenk (i.e. i8042_getc) 512c609719bSwdenk CONFIG_CONSOLE_CURSOR cursor drawing on/off 513c609719bSwdenk (requires blink timer 514c609719bSwdenk cf. i8042.c) 5156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c) 516c609719bSwdenk CONFIG_CONSOLE_TIME display time/date info in 517c609719bSwdenk upper right corner 518602ad3b3SJon Loeliger (requires CONFIG_CMD_DATE) 519c609719bSwdenk CONFIG_VIDEO_LOGO display Linux logo in 520c609719bSwdenk upper left corner 521a6c7ad2fSwdenk CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of 522a6c7ad2fSwdenk linux_logo.h for logo. 523a6c7ad2fSwdenk Requires CONFIG_VIDEO_LOGO 524c609719bSwdenk CONFIG_CONSOLE_EXTRA_INFO 52511ccc33fSMarcel Ziswiler additional board info beside 526c609719bSwdenk the logo 527c609719bSwdenk 528c609719bSwdenk When CONFIG_CFB_CONSOLE is defined, video console is 529c609719bSwdenk default i/o. Serial console can be forced with 530c609719bSwdenk environment 'console=serial'. 531c609719bSwdenk 532a3ad8e26Swdenk When CONFIG_SILENT_CONSOLE is defined, all console 533a3ad8e26Swdenk messages (by U-Boot and Linux!) can be silenced with 534a3ad8e26Swdenk the "silent" environment variable. See 535a3ad8e26Swdenk doc/README.silent for more information. 536a3ad8e26Swdenk 537c609719bSwdenk- Console Baudrate: 538c609719bSwdenk CONFIG_BAUDRATE - in bps 539c609719bSwdenk Select one of the baudrates listed in 5406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BAUDRATE_TABLE, see below. 5416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale 542c609719bSwdenk 543c92fac91SHeiko Schocher- Console Rx buffer length 544c92fac91SHeiko Schocher With CONFIG_SYS_SMC_RXBUFLEN it is possible to define 545c92fac91SHeiko Schocher the maximum receive buffer length for the SMC. 5462b3f12c2SHeiko Schocher This option is actual only for 82xx and 8xx possible. 547c92fac91SHeiko Schocher If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE 548c92fac91SHeiko Schocher must be defined, to setup the maximum idle timeout for 549c92fac91SHeiko Schocher the SMC. 550c92fac91SHeiko Schocher 551c609719bSwdenk- Boot Delay: CONFIG_BOOTDELAY - in seconds 552c609719bSwdenk Delay before automatically booting the default image; 553c609719bSwdenk set to -1 to disable autoboot. 554c609719bSwdenk 555c609719bSwdenk See doc/README.autoboot for these options that 556c609719bSwdenk work with CONFIG_BOOTDELAY. None are required. 557c609719bSwdenk CONFIG_BOOT_RETRY_TIME 558c609719bSwdenk CONFIG_BOOT_RETRY_MIN 559c609719bSwdenk CONFIG_AUTOBOOT_KEYED 560c609719bSwdenk CONFIG_AUTOBOOT_PROMPT 561c609719bSwdenk CONFIG_AUTOBOOT_DELAY_STR 562c609719bSwdenk CONFIG_AUTOBOOT_STOP_STR 563c609719bSwdenk CONFIG_AUTOBOOT_DELAY_STR2 564c609719bSwdenk CONFIG_AUTOBOOT_STOP_STR2 565c609719bSwdenk CONFIG_ZERO_BOOTDELAY_CHECK 566c609719bSwdenk CONFIG_RESET_TO_RETRY 567c609719bSwdenk 568c609719bSwdenk- Autoboot Command: 569c609719bSwdenk CONFIG_BOOTCOMMAND 570c609719bSwdenk Only needed when CONFIG_BOOTDELAY is enabled; 571c609719bSwdenk define a command string that is automatically executed 572c609719bSwdenk when no character is read on the console interface 573c609719bSwdenk within "Boot Delay" after reset. 574c609719bSwdenk 575c609719bSwdenk CONFIG_BOOTARGS 576c609719bSwdenk This can be used to pass arguments to the bootm 577c609719bSwdenk command. The value of CONFIG_BOOTARGS goes into the 578c609719bSwdenk environment value "bootargs". 579c609719bSwdenk 580c609719bSwdenk CONFIG_RAMBOOT and CONFIG_NFSBOOT 581c609719bSwdenk The value of these goes into the environment as 582c609719bSwdenk "ramboot" and "nfsboot" respectively, and can be used 583c609719bSwdenk as a convenience, when switching between booting from 58411ccc33fSMarcel Ziswiler RAM and NFS. 585c609719bSwdenk 586c609719bSwdenk- Pre-Boot Commands: 587c609719bSwdenk CONFIG_PREBOOT 588c609719bSwdenk 589c609719bSwdenk When this option is #defined, the existence of the 590c609719bSwdenk environment variable "preboot" will be checked 591c609719bSwdenk immediately before starting the CONFIG_BOOTDELAY 592c609719bSwdenk countdown and/or running the auto-boot command resp. 593c609719bSwdenk entering interactive mode. 594c609719bSwdenk 595c609719bSwdenk This feature is especially useful when "preboot" is 596c609719bSwdenk automatically generated or modified. For an example 597c609719bSwdenk see the LWMON board specific code: here "preboot" is 598c609719bSwdenk modified when the user holds down a certain 599c609719bSwdenk combination of keys on the (special) keyboard when 600c609719bSwdenk booting the systems 601c609719bSwdenk 602c609719bSwdenk- Serial Download Echo Mode: 603c609719bSwdenk CONFIG_LOADS_ECHO 604c609719bSwdenk If defined to 1, all characters received during a 605c609719bSwdenk serial download (using the "loads" command) are 606c609719bSwdenk echoed back. This might be needed by some terminal 607c609719bSwdenk emulations (like "cu"), but may as well just take 608c609719bSwdenk time on others. This setting #define's the initial 609c609719bSwdenk value of the "loads_echo" environment variable. 610c609719bSwdenk 611602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined) 612c609719bSwdenk CONFIG_KGDB_BAUDRATE 613c609719bSwdenk Select one of the baudrates listed in 6146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BAUDRATE_TABLE, see below. 615c609719bSwdenk 616c609719bSwdenk- Monitor Functions: 617602ad3b3SJon Loeliger Monitor commands can be included or excluded 618602ad3b3SJon Loeliger from the build by using the #include files 619602ad3b3SJon Loeliger "config_cmd_all.h" and #undef'ing unwanted 620602ad3b3SJon Loeliger commands, or using "config_cmd_default.h" 621602ad3b3SJon Loeliger and augmenting with additional #define's 622602ad3b3SJon Loeliger for wanted commands. 623c609719bSwdenk 624602ad3b3SJon Loeliger The default command configuration includes all commands 625602ad3b3SJon Loeliger except those marked below with a "*". 626602ad3b3SJon Loeliger 627602ad3b3SJon Loeliger CONFIG_CMD_ASKENV * ask for env variable 628602ad3b3SJon Loeliger CONFIG_CMD_BDI bdinfo 629602ad3b3SJon Loeliger CONFIG_CMD_BEDBUG * Include BedBug Debugger 630602ad3b3SJon Loeliger CONFIG_CMD_BMP * BMP support 631602ad3b3SJon Loeliger CONFIG_CMD_BSP * Board specific commands 632602ad3b3SJon Loeliger CONFIG_CMD_BOOTD bootd 633602ad3b3SJon Loeliger CONFIG_CMD_CACHE * icache, dcache 634602ad3b3SJon Loeliger CONFIG_CMD_CONSOLE coninfo 635710b9938SMike Frysinger CONFIG_CMD_CRC32 * crc32 636602ad3b3SJon Loeliger CONFIG_CMD_DATE * support for RTC, date/time... 637602ad3b3SJon Loeliger CONFIG_CMD_DHCP * DHCP support 638602ad3b3SJon Loeliger CONFIG_CMD_DIAG * Diagnostics 639a7c93104SPeter Tyser CONFIG_CMD_DS4510 * ds4510 I2C gpio commands 640a7c93104SPeter Tyser CONFIG_CMD_DS4510_INFO * ds4510 I2C info command 641a7c93104SPeter Tyser CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd 642a7c93104SPeter Tyser CONFIG_CMD_DS4510_RST * ds4510 I2C rst command 643602ad3b3SJon Loeliger CONFIG_CMD_DTT * Digital Therm and Thermostat 644602ad3b3SJon Loeliger CONFIG_CMD_ECHO echo arguments 645246c6922SPeter Tyser CONFIG_CMD_EDITENV edit env variable 646602ad3b3SJon Loeliger CONFIG_CMD_EEPROM * EEPROM read/write support 647602ad3b3SJon Loeliger CONFIG_CMD_ELF * bootelf, bootvx 6480c79cda0SMike Frysinger CONFIG_CMD_EXPORTENV * export the environment 649bdab39d3SMike Frysinger CONFIG_CMD_SAVEENV saveenv 650602ad3b3SJon Loeliger CONFIG_CMD_FDC * Floppy Disk Support 651602ad3b3SJon Loeliger CONFIG_CMD_FAT * FAT partition support 652602ad3b3SJon Loeliger CONFIG_CMD_FDOS * Dos diskette Support 653602ad3b3SJon Loeliger CONFIG_CMD_FLASH flinfo, erase, protect 654602ad3b3SJon Loeliger CONFIG_CMD_FPGA FPGA device initialization support 655a641b979SMike Frysinger CONFIG_CMD_GO * the 'go' command (exec code) 656a000b795SKim Phillips CONFIG_CMD_GREPENV * search environment 657602ad3b3SJon Loeliger CONFIG_CMD_HWFLOW * RTS/CTS hw flow control 658602ad3b3SJon Loeliger CONFIG_CMD_I2C * I2C serial bus support 659602ad3b3SJon Loeliger CONFIG_CMD_IDE * IDE harddisk support 660602ad3b3SJon Loeliger CONFIG_CMD_IMI iminfo 661602ad3b3SJon Loeliger CONFIG_CMD_IMLS List all found images 662602ad3b3SJon Loeliger CONFIG_CMD_IMMAP * IMMR dump support 6630c79cda0SMike Frysinger CONFIG_CMD_IMPORTENV * import an environment 664602ad3b3SJon Loeliger CONFIG_CMD_IRQ * irqinfo 665602ad3b3SJon Loeliger CONFIG_CMD_ITEST Integer/string test of 2 values 666602ad3b3SJon Loeliger CONFIG_CMD_JFFS2 * JFFS2 Support 667602ad3b3SJon Loeliger CONFIG_CMD_KGDB * kgdb 6681ba7fd25SMike Frysinger CONFIG_CMD_LDRINFO ldrinfo (display Blackfin loader) 669602ad3b3SJon Loeliger CONFIG_CMD_LOADB loadb 670602ad3b3SJon Loeliger CONFIG_CMD_LOADS loads 67102c9aa1dSRobin Getz CONFIG_CMD_MD5SUM print md5 message digest 67202c9aa1dSRobin Getz (requires CONFIG_CMD_MEMORY and CONFIG_MD5) 673602ad3b3SJon Loeliger CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base, 67456523f12Swdenk loop, loopw, mtest 675602ad3b3SJon Loeliger CONFIG_CMD_MISC Misc functions like sleep etc 676602ad3b3SJon Loeliger CONFIG_CMD_MMC * MMC memory mapped support 677602ad3b3SJon Loeliger CONFIG_CMD_MII * MII utility commands 67868d7d651SStefan Roese CONFIG_CMD_MTDPARTS * MTD partition support 679602ad3b3SJon Loeliger CONFIG_CMD_NAND * NAND support 680602ad3b3SJon Loeliger CONFIG_CMD_NET bootp, tftpboot, rarpboot 681e92739d3SPeter Tyser CONFIG_CMD_PCA953X * PCA953x I2C gpio commands 682e92739d3SPeter Tyser CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command 683602ad3b3SJon Loeliger CONFIG_CMD_PCI * pciinfo 684602ad3b3SJon Loeliger CONFIG_CMD_PCMCIA * PCMCIA support 685602ad3b3SJon Loeliger CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network 686602ad3b3SJon Loeliger host 687602ad3b3SJon Loeliger CONFIG_CMD_PORTIO * Port I/O 688602ad3b3SJon Loeliger CONFIG_CMD_REGINFO * Register dump 689602ad3b3SJon Loeliger CONFIG_CMD_RUN run command in env variable 690602ad3b3SJon Loeliger CONFIG_CMD_SAVES * save S record dump 691602ad3b3SJon Loeliger CONFIG_CMD_SCSI * SCSI Support 692602ad3b3SJon Loeliger CONFIG_CMD_SDRAM * print SDRAM configuration information 693602ad3b3SJon Loeliger (requires CONFIG_CMD_I2C) 694602ad3b3SJon Loeliger CONFIG_CMD_SETGETDCR Support for DCR Register access 695602ad3b3SJon Loeliger (4xx only) 696c6b1ee66SAlexander Holler CONFIG_CMD_SHA1SUM print sha1 memory digest 69702c9aa1dSRobin Getz (requires CONFIG_CMD_MEMORY) 69874de7aefSWolfgang Denk CONFIG_CMD_SOURCE "source" command Support 699602ad3b3SJon Loeliger CONFIG_CMD_SPI * SPI serial bus support 700602ad3b3SJon Loeliger CONFIG_CMD_USB * USB support 701602ad3b3SJon Loeliger CONFIG_CMD_VFD * VFD support (TRAB) 702602ad3b3SJon Loeliger CONFIG_CMD_CDP * Cisco Discover Protocol support 703602ad3b3SJon Loeliger CONFIG_CMD_FSL * Microblaze FSL support 704c609719bSwdenk 705c609719bSwdenk 706c609719bSwdenk EXAMPLE: If you want all functions except of network 707c609719bSwdenk support you can write: 708c609719bSwdenk 709602ad3b3SJon Loeliger #include "config_cmd_all.h" 710602ad3b3SJon Loeliger #undef CONFIG_CMD_NET 711c609719bSwdenk 712213bf8c8SGerald Van Baren Other Commands: 713213bf8c8SGerald Van Baren fdt (flattened device tree) command: CONFIG_OF_LIBFDT 714c609719bSwdenk 715c609719bSwdenk Note: Don't enable the "icache" and "dcache" commands 716602ad3b3SJon Loeliger (configuration option CONFIG_CMD_CACHE) unless you know 717c609719bSwdenk what you (and your U-Boot users) are doing. Data 718c609719bSwdenk cache cannot be enabled on systems like the 8xx or 719c609719bSwdenk 8260 (where accesses to the IMMR region must be 720c609719bSwdenk uncached), and it cannot be disabled on all other 721c609719bSwdenk systems where we (mis-) use the data cache to hold an 722c609719bSwdenk initial stack and some data. 723c609719bSwdenk 724c609719bSwdenk 725c609719bSwdenk XXX - this list needs to get updated! 726c609719bSwdenk 727c609719bSwdenk- Watchdog: 728c609719bSwdenk CONFIG_WATCHDOG 729c609719bSwdenk If this variable is defined, it enables watchdog 7307152b1d0Swdenk support. There must be support in the platform specific 731c609719bSwdenk code for a watchdog. For the 8xx and 8260 CPUs, the 732c609719bSwdenk SIU Watchdog feature is enabled in the SYPCR 733c609719bSwdenk register. 734c609719bSwdenk 735c1551ea8Sstroese- U-Boot Version: 736c1551ea8Sstroese CONFIG_VERSION_VARIABLE 737c1551ea8Sstroese If this variable is defined, an environment variable 738c1551ea8Sstroese named "ver" is created by U-Boot showing the U-Boot 739c1551ea8Sstroese version as printed by the "version" command. 740c1551ea8Sstroese This variable is readonly. 741c1551ea8Sstroese 742c609719bSwdenk- Real-Time Clock: 743c609719bSwdenk 744602ad3b3SJon Loeliger When CONFIG_CMD_DATE is selected, the type of the RTC 745c609719bSwdenk has to be selected, too. Define exactly one of the 746c609719bSwdenk following options: 747c609719bSwdenk 748c609719bSwdenk CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx 749c609719bSwdenk CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC 7507ce63709SGuennadi Liakhovetski CONFIG_RTC_MC13783 - use MC13783 RTC 751c609719bSwdenk CONFIG_RTC_MC146818 - use MC146818 RTC 7521cb8e980Swdenk CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC 753c609719bSwdenk CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC 7547f70e853Swdenk CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC 7553bac3513Swdenk CONFIG_RTC_DS164x - use Dallas DS164x RTC 7569536dfccSTor Krill CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC 7574c0d4c3bSwdenk CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC 7586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337 75971d19f30SHeiko Schocher CONFIG_SYS_RV3029_TCR - enable trickle charger on 76071d19f30SHeiko Schocher RV3029 RTC. 761c609719bSwdenk 762b37c7e5eSwdenk Note that if the RTC uses I2C, then the I2C interface 763b37c7e5eSwdenk must also be configured. See I2C Support, below. 764b37c7e5eSwdenk 765e92739d3SPeter Tyser- GPIO Support: 766e92739d3SPeter Tyser CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO 767e92739d3SPeter Tyser CONFIG_PCA953X_INFO - enable pca953x info command 768e92739d3SPeter Tyser 7695dec49caSChris Packham The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of 7705dec49caSChris Packham chip-ngpio pairs that tell the PCA953X driver the number of 7715dec49caSChris Packham pins supported by a particular chip. 7725dec49caSChris Packham 773e92739d3SPeter Tyser Note that if the GPIO device uses I2C, then the I2C interface 774e92739d3SPeter Tyser must also be configured. See I2C Support, below. 775e92739d3SPeter Tyser 776c609719bSwdenk- Timestamp Support: 777c609719bSwdenk 778c609719bSwdenk When CONFIG_TIMESTAMP is selected, the timestamp 779c609719bSwdenk (date and time) of an image is printed by image 780c609719bSwdenk commands like bootm or iminfo. This option is 781602ad3b3SJon Loeliger automatically enabled when you select CONFIG_CMD_DATE . 782c609719bSwdenk 783c609719bSwdenk- Partition Support: 784c609719bSwdenk CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION 78507f3d789Srichardretanubun and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION 786c609719bSwdenk 787602ad3b3SJon Loeliger If IDE or SCSI support is enabled (CONFIG_CMD_IDE or 788218ca724SWolfgang Denk CONFIG_CMD_SCSI) you must configure support for at 789218ca724SWolfgang Denk least one partition type as well. 790c609719bSwdenk 791c609719bSwdenk- IDE Reset method: 7924d13cbadSwdenk CONFIG_IDE_RESET_ROUTINE - this is defined in several 7934d13cbadSwdenk board configurations files but used nowhere! 794c609719bSwdenk 7954d13cbadSwdenk CONFIG_IDE_RESET - is this is defined, IDE Reset will 7964d13cbadSwdenk be performed by calling the function 7974d13cbadSwdenk ide_set_reset(int reset) 7984d13cbadSwdenk which has to be defined in a board specific file 799c609719bSwdenk 800c609719bSwdenk- ATAPI Support: 801c609719bSwdenk CONFIG_ATAPI 802c609719bSwdenk 803c609719bSwdenk Set this to enable ATAPI support. 804c609719bSwdenk 805c40b2956Swdenk- LBA48 Support 806c40b2956Swdenk CONFIG_LBA48 807c40b2956Swdenk 808c40b2956Swdenk Set this to enable support for disks larger than 137GB 8094b142febSHeiko Schocher Also look at CONFIG_SYS_64BIT_LBA. 810c40b2956Swdenk Whithout these , LBA48 support uses 32bit variables and will 'only' 811c40b2956Swdenk support disks up to 2.1TB. 812c40b2956Swdenk 8136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_64BIT_LBA: 814c40b2956Swdenk When enabled, makes the IDE subsystem use 64bit sector addresses. 815c40b2956Swdenk Default is 32bit. 816c40b2956Swdenk 817c609719bSwdenk- SCSI Support: 818c609719bSwdenk At the moment only there is only support for the 819c609719bSwdenk SYM53C8XX SCSI controller; define 820c609719bSwdenk CONFIG_SCSI_SYM53C8XX to enable it. 821c609719bSwdenk 8226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and 8236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID * 8246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the 825c609719bSwdenk maximum numbers of LUNs, SCSI ID's and target 826c609719bSwdenk devices. 8276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz) 828c609719bSwdenk 829c609719bSwdenk- NETWORK Support (PCI): 830682011ffSwdenk CONFIG_E1000 831682011ffSwdenk Support for Intel 8254x gigabit chips. 832682011ffSwdenk 833ac3315c2SAndre Schwarz CONFIG_E1000_FALLBACK_MAC 83411ccc33fSMarcel Ziswiler default MAC for empty EEPROM after production. 835ac3315c2SAndre Schwarz 836c609719bSwdenk CONFIG_EEPRO100 837c609719bSwdenk Support for Intel 82557/82559/82559ER chips. 83811ccc33fSMarcel Ziswiler Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM 839c609719bSwdenk write routine for first time initialisation. 840c609719bSwdenk 841c609719bSwdenk CONFIG_TULIP 842c609719bSwdenk Support for Digital 2114x chips. 843c609719bSwdenk Optional CONFIG_TULIP_SELECT_MEDIA for board specific 844c609719bSwdenk modem chip initialisation (KS8761/QS6611). 845c609719bSwdenk 846c609719bSwdenk CONFIG_NATSEMI 847c609719bSwdenk Support for National dp83815 chips. 848c609719bSwdenk 849c609719bSwdenk CONFIG_NS8382X 850c609719bSwdenk Support for National dp8382[01] gigabit chips. 851c609719bSwdenk 85245219c46Swdenk- NETWORK Support (other): 85345219c46Swdenk 854c041e9d2SJens Scharsig CONFIG_DRIVER_AT91EMAC 855c041e9d2SJens Scharsig Support for AT91RM9200 EMAC. 856c041e9d2SJens Scharsig 857c041e9d2SJens Scharsig CONFIG_RMII 858c041e9d2SJens Scharsig Define this to use reduced MII inteface 859c041e9d2SJens Scharsig 860c041e9d2SJens Scharsig CONFIG_DRIVER_AT91EMAC_QUIET 861c041e9d2SJens Scharsig If this defined, the driver is quiet. 862c041e9d2SJens Scharsig The driver doen't show link status messages. 863c041e9d2SJens Scharsig 86445219c46Swdenk CONFIG_DRIVER_LAN91C96 86545219c46Swdenk Support for SMSC's LAN91C96 chips. 86645219c46Swdenk 86745219c46Swdenk CONFIG_LAN91C96_BASE 86845219c46Swdenk Define this to hold the physical address 86945219c46Swdenk of the LAN91C96's I/O space 87045219c46Swdenk 87145219c46Swdenk CONFIG_LAN91C96_USE_32_BIT 87245219c46Swdenk Define this to enable 32 bit addressing 87345219c46Swdenk 874f39748aeSwdenk CONFIG_DRIVER_SMC91111 875f39748aeSwdenk Support for SMSC's LAN91C111 chip 876f39748aeSwdenk 877f39748aeSwdenk CONFIG_SMC91111_BASE 878f39748aeSwdenk Define this to hold the physical address 879f39748aeSwdenk of the device (I/O space) 880f39748aeSwdenk 881f39748aeSwdenk CONFIG_SMC_USE_32_BIT 882f39748aeSwdenk Define this if data bus is 32 bits 883f39748aeSwdenk 884f39748aeSwdenk CONFIG_SMC_USE_IOFUNCS 885f39748aeSwdenk Define this to use i/o functions instead of macros 886f39748aeSwdenk (some hardware wont work with macros) 887f39748aeSwdenk 888b3dbf4a5SMacpaul Lin CONFIG_FTGMAC100 889b3dbf4a5SMacpaul Lin Support for Faraday's FTGMAC100 Gigabit SoC Ethernet 890b3dbf4a5SMacpaul Lin 891b3dbf4a5SMacpaul Lin CONFIG_FTGMAC100_EGIGA 892b3dbf4a5SMacpaul Lin Define this to use GE link update with gigabit PHY. 893b3dbf4a5SMacpaul Lin Define this if FTGMAC100 is connected to gigabit PHY. 894b3dbf4a5SMacpaul Lin If your system has 10/100 PHY only, it might not occur 895b3dbf4a5SMacpaul Lin wrong behavior. Because PHY usually return timeout or 896b3dbf4a5SMacpaul Lin useless data when polling gigabit status and gigabit 897b3dbf4a5SMacpaul Lin control registers. This behavior won't affect the 898b3dbf4a5SMacpaul Lin correctnessof 10/100 link speed update. 899b3dbf4a5SMacpaul Lin 900c2fff331SMike Rapoport CONFIG_SMC911X 901557b377dSJens Gehrlein Support for SMSC's LAN911x and LAN921x chips 902557b377dSJens Gehrlein 903c2fff331SMike Rapoport CONFIG_SMC911X_BASE 904557b377dSJens Gehrlein Define this to hold the physical address 905557b377dSJens Gehrlein of the device (I/O space) 906557b377dSJens Gehrlein 907c2fff331SMike Rapoport CONFIG_SMC911X_32_BIT 908557b377dSJens Gehrlein Define this if data bus is 32 bits 909557b377dSJens Gehrlein 910c2fff331SMike Rapoport CONFIG_SMC911X_16_BIT 911557b377dSJens Gehrlein Define this if data bus is 16 bits. If your processor 912557b377dSJens Gehrlein automatically converts one 32 bit word to two 16 bit 913c2fff331SMike Rapoport words you may also try CONFIG_SMC911X_32_BIT. 914557b377dSJens Gehrlein 9153d0075faSYoshihiro Shimoda CONFIG_SH_ETHER 9163d0075faSYoshihiro Shimoda Support for Renesas on-chip Ethernet controller 9173d0075faSYoshihiro Shimoda 9183d0075faSYoshihiro Shimoda CONFIG_SH_ETHER_USE_PORT 9193d0075faSYoshihiro Shimoda Define the number of ports to be used 9203d0075faSYoshihiro Shimoda 9213d0075faSYoshihiro Shimoda CONFIG_SH_ETHER_PHY_ADDR 9223d0075faSYoshihiro Shimoda Define the ETH PHY's address 9233d0075faSYoshihiro Shimoda 92468260aabSYoshihiro Shimoda CONFIG_SH_ETHER_CACHE_WRITEBACK 92568260aabSYoshihiro Shimoda If this option is set, the driver enables cache flush. 92668260aabSYoshihiro Shimoda 927c609719bSwdenk- USB Support: 928c609719bSwdenk At the moment only the UHCI host controller is 9294d13cbadSwdenk supported (PIP405, MIP405, MPC5200); define 930c609719bSwdenk CONFIG_USB_UHCI to enable it. 931c609719bSwdenk define CONFIG_USB_KEYBOARD to enable the USB Keyboard 93230d56faeSwdenk and define CONFIG_USB_STORAGE to enable the USB 933c609719bSwdenk storage devices. 934c609719bSwdenk Note: 935c609719bSwdenk Supported are USB Keyboards and USB Floppy drives 936c609719bSwdenk (TEAC FD-05PUB). 9374d13cbadSwdenk MPC5200 USB requires additional defines: 9384d13cbadSwdenk CONFIG_USB_CLOCK 9394d13cbadSwdenk for 528 MHz Clock: 0x0001bbbb 940307ecb6dSEric Millbrandt CONFIG_PSC3_USB 941307ecb6dSEric Millbrandt for USB on PSC3 9424d13cbadSwdenk CONFIG_USB_CONFIG 9434d13cbadSwdenk for differential drivers: 0x00001000 9444d13cbadSwdenk for single ended drivers: 0x00005000 945307ecb6dSEric Millbrandt for differential drivers on PSC3: 0x00000100 946307ecb6dSEric Millbrandt for single ended drivers on PSC3: 0x00004100 9476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_USB_EVENT_POLL 948fdcfaa1bSZhang Wei May be defined to allow interrupt polling 949fdcfaa1bSZhang Wei instead of using asynchronous interrupts 9504d13cbadSwdenk 95116c8d5e7SWolfgang Denk- USB Device: 95216c8d5e7SWolfgang Denk Define the below if you wish to use the USB console. 95316c8d5e7SWolfgang Denk Once firmware is rebuilt from a serial console issue the 95416c8d5e7SWolfgang Denk command "setenv stdin usbtty; setenv stdout usbtty" and 95511ccc33fSMarcel Ziswiler attach your USB cable. The Unix command "dmesg" should print 95616c8d5e7SWolfgang Denk it has found a new device. The environment variable usbtty 95716c8d5e7SWolfgang Denk can be set to gserial or cdc_acm to enable your device to 95816c8d5e7SWolfgang Denk appear to a USB host as a Linux gserial device or a 95916c8d5e7SWolfgang Denk Common Device Class Abstract Control Model serial device. 96016c8d5e7SWolfgang Denk If you select usbtty = gserial you should be able to enumerate 96116c8d5e7SWolfgang Denk a Linux host by 96216c8d5e7SWolfgang Denk # modprobe usbserial vendor=0xVendorID product=0xProductID 96316c8d5e7SWolfgang Denk else if using cdc_acm, simply setting the environment 96416c8d5e7SWolfgang Denk variable usbtty to be cdc_acm should suffice. The following 96516c8d5e7SWolfgang Denk might be defined in YourBoardName.h 96616c8d5e7SWolfgang Denk 96716c8d5e7SWolfgang Denk CONFIG_USB_DEVICE 96816c8d5e7SWolfgang Denk Define this to build a UDC device 96916c8d5e7SWolfgang Denk 97016c8d5e7SWolfgang Denk CONFIG_USB_TTY 97116c8d5e7SWolfgang Denk Define this to have a tty type of device available to 97216c8d5e7SWolfgang Denk talk to the UDC device 97316c8d5e7SWolfgang Denk 9746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_CONSOLE_IS_IN_ENV 97516c8d5e7SWolfgang Denk Define this if you want stdin, stdout &/or stderr to 97616c8d5e7SWolfgang Denk be set to usbtty. 97716c8d5e7SWolfgang Denk 97816c8d5e7SWolfgang Denk mpc8xx: 9796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_USB_EXTC_CLK 0xBLAH 98016c8d5e7SWolfgang Denk Derive USB clock from external clock "blah" 9816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_USB_EXTC_CLK 0x02 98216c8d5e7SWolfgang Denk 9836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_USB_BRG_CLK 0xBLAH 98416c8d5e7SWolfgang Denk Derive USB clock from brgclk 9856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_USB_BRG_CLK 0x04 98616c8d5e7SWolfgang Denk 98716c8d5e7SWolfgang Denk If you have a USB-IF assigned VendorID then you may wish to 98816c8d5e7SWolfgang Denk define your own vendor specific values either in BoardName.h 98916c8d5e7SWolfgang Denk or directly in usbd_vendor_info.h. If you don't define 99016c8d5e7SWolfgang Denk CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME, 99116c8d5e7SWolfgang Denk CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot 99216c8d5e7SWolfgang Denk should pretend to be a Linux device to it's target host. 99316c8d5e7SWolfgang Denk 99416c8d5e7SWolfgang Denk CONFIG_USBD_MANUFACTURER 99516c8d5e7SWolfgang Denk Define this string as the name of your company for 99616c8d5e7SWolfgang Denk - CONFIG_USBD_MANUFACTURER "my company" 99716c8d5e7SWolfgang Denk 99816c8d5e7SWolfgang Denk CONFIG_USBD_PRODUCT_NAME 99916c8d5e7SWolfgang Denk Define this string as the name of your product 100016c8d5e7SWolfgang Denk - CONFIG_USBD_PRODUCT_NAME "acme usb device" 100116c8d5e7SWolfgang Denk 100216c8d5e7SWolfgang Denk CONFIG_USBD_VENDORID 100316c8d5e7SWolfgang Denk Define this as your assigned Vendor ID from the USB 100416c8d5e7SWolfgang Denk Implementors Forum. This *must* be a genuine Vendor ID 100516c8d5e7SWolfgang Denk to avoid polluting the USB namespace. 100616c8d5e7SWolfgang Denk - CONFIG_USBD_VENDORID 0xFFFF 100716c8d5e7SWolfgang Denk 100816c8d5e7SWolfgang Denk CONFIG_USBD_PRODUCTID 100916c8d5e7SWolfgang Denk Define this as the unique Product ID 101016c8d5e7SWolfgang Denk for your device 101116c8d5e7SWolfgang Denk - CONFIG_USBD_PRODUCTID 0xFFFF 1012c609719bSwdenk 1013c609719bSwdenk 1014c609719bSwdenk- MMC Support: 1015c609719bSwdenk The MMC controller on the Intel PXA is supported. To 1016c609719bSwdenk enable this define CONFIG_MMC. The MMC can be 1017c609719bSwdenk accessed from the boot prompt by mapping the device 1018c609719bSwdenk to physical memory similar to flash. Command line is 1019602ad3b3SJon Loeliger enabled with CONFIG_CMD_MMC. The MMC driver also works with 1020602ad3b3SJon Loeliger the FAT fs. This is enabled with CONFIG_CMD_FAT. 1021c609719bSwdenk 10226705d81eSwdenk- Journaling Flash filesystem support: 10236705d81eSwdenk CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE, 10246705d81eSwdenk CONFIG_JFFS2_NAND_DEV 10256705d81eSwdenk Define these for a default partition on a NAND device 10266705d81eSwdenk 10276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS2_FIRST_SECTOR, 10286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS 10296705d81eSwdenk Define these for a default partition on a NOR device 10306705d81eSwdenk 10316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS_CUSTOM_PART 10326705d81eSwdenk Define this to create an own partition. You have to provide a 10336705d81eSwdenk function struct part_info* jffs2_part_info(int part_num) 10346705d81eSwdenk 10356705d81eSwdenk If you define only one JFFS2 partition you may also want to 10366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_JFFS_SINGLE_PART 1 10376705d81eSwdenk to disable the command chpart. This is the default when you 10386705d81eSwdenk have not defined a custom partition 10396705d81eSwdenk 1040c609719bSwdenk- Keyboard Support: 1041c609719bSwdenk CONFIG_ISA_KEYBOARD 1042c609719bSwdenk 1043c609719bSwdenk Define this to enable standard (PC-Style) keyboard 1044c609719bSwdenk support 1045c609719bSwdenk 1046c609719bSwdenk CONFIG_I8042_KBD 1047c609719bSwdenk Standard PC keyboard driver with US (is default) and 1048c609719bSwdenk GERMAN key layout (switch via environment 'keymap=de') support. 1049c609719bSwdenk Export function i8042_kbd_init, i8042_tstc and i8042_getc 1050c609719bSwdenk for cfb_console. Supports cursor blinking. 1051c609719bSwdenk 1052c609719bSwdenk- Video support: 1053c609719bSwdenk CONFIG_VIDEO 1054c609719bSwdenk 1055c609719bSwdenk Define this to enable video support (for output to 1056c609719bSwdenk video). 1057c609719bSwdenk 1058c609719bSwdenk CONFIG_VIDEO_CT69000 1059c609719bSwdenk 1060c609719bSwdenk Enable Chips & Technologies 69000 Video chip 1061c609719bSwdenk 1062c609719bSwdenk CONFIG_VIDEO_SMI_LYNXEM 1063eeb1b77bSwdenk Enable Silicon Motion SMI 712/710/810 Video chip. The 1064eeb1b77bSwdenk video output is selected via environment 'videoout' 1065eeb1b77bSwdenk (1 = LCD and 2 = CRT). If videoout is undefined, CRT is 1066eeb1b77bSwdenk assumed. 1067c609719bSwdenk 1068eeb1b77bSwdenk For the CT69000 and SMI_LYNXEM drivers, videomode is 106911ccc33fSMarcel Ziswiler selected via environment 'videomode'. Two different ways 1070eeb1b77bSwdenk are possible: 1071eeb1b77bSwdenk - "videomode=num" 'num' is a standard LiLo mode numbers. 1072eeb1b77bSwdenk Following standard modes are supported (* is default): 1073eeb1b77bSwdenk 1074eeb1b77bSwdenk Colors 640x480 800x600 1024x768 1152x864 1280x1024 1075eeb1b77bSwdenk -------------+--------------------------------------------- 1076eeb1b77bSwdenk 8 bits | 0x301* 0x303 0x305 0x161 0x307 1077eeb1b77bSwdenk 15 bits | 0x310 0x313 0x316 0x162 0x319 1078eeb1b77bSwdenk 16 bits | 0x311 0x314 0x317 0x163 0x31A 1079eeb1b77bSwdenk 24 bits | 0x312 0x315 0x318 ? 0x31B 1080eeb1b77bSwdenk -------------+--------------------------------------------- 1081c609719bSwdenk (i.e. setenv videomode 317; saveenv; reset;) 1082c609719bSwdenk 1083eeb1b77bSwdenk - "videomode=bootargs" all the video parameters are parsed 10847817cb20SMarcel Ziswiler from the bootargs. (See drivers/video/videomodes.c) 1085eeb1b77bSwdenk 1086eeb1b77bSwdenk 1087a6c7ad2fSwdenk CONFIG_VIDEO_SED13806 1088a6c7ad2fSwdenk Enable Epson SED13806 driver. This driver supports 8bpp 1089a6c7ad2fSwdenk and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP 1090a6c7ad2fSwdenk or CONFIG_VIDEO_SED13806_16BPP 1091a6c7ad2fSwdenk 10927d3053fbSTimur Tabi CONFIG_FSL_DIU_FB 10937d3053fbSTimur Tabi Enable the Freescale DIU video driver. Reference boards for 10947d3053fbSTimur Tabi SOCs that have a DIU should define this macro to enable DIU 10957d3053fbSTimur Tabi support, and should also define these other macros: 10967d3053fbSTimur Tabi 10977d3053fbSTimur Tabi CONFIG_SYS_DIU_ADDR 10987d3053fbSTimur Tabi CONFIG_VIDEO 10997d3053fbSTimur Tabi CONFIG_CMD_BMP 11007d3053fbSTimur Tabi CONFIG_CFB_CONSOLE 11017d3053fbSTimur Tabi CONFIG_VIDEO_SW_CURSOR 11027d3053fbSTimur Tabi CONFIG_VGA_AS_SINGLE_DEVICE 11037d3053fbSTimur Tabi CONFIG_VIDEO_LOGO 11047d3053fbSTimur Tabi CONFIG_VIDEO_BMP_LOGO 11057d3053fbSTimur Tabi 11067d3053fbSTimur Tabi The DIU driver will look for the 'monitor' environment variable, 11077d3053fbSTimur Tabi and if defined, enable the DIU as a console during boot. This 11087d3053fbSTimur Tabi variable should be set to one of these values: 11097d3053fbSTimur Tabi 11107d3053fbSTimur Tabi '0' Output video to the DVI connector 11117d3053fbSTimur Tabi '1' Output video to the LVDS connector 11127d3053fbSTimur Tabi '2' Output video to the Dual-Link LVDS connector 11137d3053fbSTimur Tabi 1114682011ffSwdenk- Keyboard Support: 1115682011ffSwdenk CONFIG_KEYBOARD 1116682011ffSwdenk 1117682011ffSwdenk Define this to enable a custom keyboard support. 1118682011ffSwdenk This simply calls drv_keyboard_init() which must be 1119682011ffSwdenk defined in your board-specific files. 1120682011ffSwdenk The only board using this so far is RBC823. 1121a6c7ad2fSwdenk 1122c609719bSwdenk- LCD Support: CONFIG_LCD 1123c609719bSwdenk 1124c609719bSwdenk Define this to enable LCD support (for output to LCD 1125c609719bSwdenk display); also select one of the supported displays 1126c609719bSwdenk by defining one of these: 1127c609719bSwdenk 112839cf4804SStelian Pop CONFIG_ATMEL_LCD: 112939cf4804SStelian Pop 113039cf4804SStelian Pop HITACHI TX09D70VM1CCA, 3.5", 240x320. 113139cf4804SStelian Pop 1132fd3103bbSwdenk CONFIG_NEC_NL6448AC33: 1133c609719bSwdenk 1134fd3103bbSwdenk NEC NL6448AC33-18. Active, color, single scan. 1135c609719bSwdenk 1136fd3103bbSwdenk CONFIG_NEC_NL6448BC20 1137c609719bSwdenk 1138fd3103bbSwdenk NEC NL6448BC20-08. 6.5", 640x480. 1139fd3103bbSwdenk Active, color, single scan. 1140fd3103bbSwdenk 1141fd3103bbSwdenk CONFIG_NEC_NL6448BC33_54 1142fd3103bbSwdenk 1143fd3103bbSwdenk NEC NL6448BC33-54. 10.4", 640x480. 1144c609719bSwdenk Active, color, single scan. 1145c609719bSwdenk 1146c609719bSwdenk CONFIG_SHARP_16x9 1147c609719bSwdenk 1148c609719bSwdenk Sharp 320x240. Active, color, single scan. 1149c609719bSwdenk It isn't 16x9, and I am not sure what it is. 1150c609719bSwdenk 1151c609719bSwdenk CONFIG_SHARP_LQ64D341 1152c609719bSwdenk 1153c609719bSwdenk Sharp LQ64D341 display, 640x480. 1154c609719bSwdenk Active, color, single scan. 1155c609719bSwdenk 1156c609719bSwdenk CONFIG_HLD1045 1157c609719bSwdenk 1158c609719bSwdenk HLD1045 display, 640x480. 1159c609719bSwdenk Active, color, single scan. 1160c609719bSwdenk 1161c609719bSwdenk CONFIG_OPTREX_BW 1162c609719bSwdenk 1163c609719bSwdenk Optrex CBL50840-2 NF-FW 99 22 M5 1164c609719bSwdenk or 1165c609719bSwdenk Hitachi LMG6912RPFC-00T 1166c609719bSwdenk or 1167c609719bSwdenk Hitachi SP14Q002 1168c609719bSwdenk 1169c609719bSwdenk 320x240. Black & white. 1170c609719bSwdenk 1171c609719bSwdenk Normally display is black on white background; define 11726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_WHITE_ON_BLACK to get it inverted. 1173c609719bSwdenk 11747152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN 1175d791b1dcSwdenk 1176d791b1dcSwdenk If this option is set, the environment is checked for 1177d791b1dcSwdenk a variable "splashimage". If found, the usual display 1178d791b1dcSwdenk of logo, copyright and system information on the LCD 1179e94d2cd9Swdenk is suppressed and the BMP image at the address 1180d791b1dcSwdenk specified in "splashimage" is loaded instead. The 1181d791b1dcSwdenk console is redirected to the "nulldev", too. This 1182d791b1dcSwdenk allows for a "silent" boot where a splash screen is 1183d791b1dcSwdenk loaded very quickly after power-on. 1184d791b1dcSwdenk 11851ca298ceSMatthias Weisser CONFIG_SPLASH_SCREEN_ALIGN 11861ca298ceSMatthias Weisser 11871ca298ceSMatthias Weisser If this option is set the splash image can be freely positioned 11881ca298ceSMatthias Weisser on the screen. Environment variable "splashpos" specifies the 11891ca298ceSMatthias Weisser position as "x,y". If a positive number is given it is used as 11901ca298ceSMatthias Weisser number of pixel from left/top. If a negative number is given it 11911ca298ceSMatthias Weisser is used as number of pixel from right/bottom. You can also 11921ca298ceSMatthias Weisser specify 'm' for centering the image. 11931ca298ceSMatthias Weisser 11941ca298ceSMatthias Weisser Example: 11951ca298ceSMatthias Weisser setenv splashpos m,m 11961ca298ceSMatthias Weisser => image at center of screen 11971ca298ceSMatthias Weisser 11981ca298ceSMatthias Weisser setenv splashpos 30,20 11991ca298ceSMatthias Weisser => image at x = 30 and y = 20 12001ca298ceSMatthias Weisser 12011ca298ceSMatthias Weisser setenv splashpos -10,m 12021ca298ceSMatthias Weisser => vertically centered image 12031ca298ceSMatthias Weisser at x = dspWidth - bmpWidth - 9 12041ca298ceSMatthias Weisser 120598f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP 120698f4a3dfSStefan Roese 120798f4a3dfSStefan Roese If this option is set, additionally to standard BMP 120898f4a3dfSStefan Roese images, gzipped BMP images can be displayed via the 120998f4a3dfSStefan Roese splashscreen support or the bmp command. 121098f4a3dfSStefan Roese 1211d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8 1212d5011762SAnatolij Gustschin 1213d5011762SAnatolij Gustschin If this option is set, 8-bit RLE compressed BMP images 1214d5011762SAnatolij Gustschin can be displayed via the splashscreen support or the 1215d5011762SAnatolij Gustschin bmp command. 1216d5011762SAnatolij Gustschin 1217c29fdfc1Swdenk- Compression support: 1218c29fdfc1Swdenk CONFIG_BZIP2 1219c29fdfc1Swdenk 1220c29fdfc1Swdenk If this option is set, support for bzip2 compressed 1221c29fdfc1Swdenk images is included. If not, only uncompressed and gzip 1222c29fdfc1Swdenk compressed images are supported. 1223c29fdfc1Swdenk 1224c29fdfc1Swdenk NOTE: the bzip2 algorithm requires a lot of RAM, so 12256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should 1226c29fdfc1Swdenk be at least 4MB. 1227d791b1dcSwdenk 1228fc9c1727SLuigi 'Comio' Mantellini CONFIG_LZMA 1229fc9c1727SLuigi 'Comio' Mantellini 1230fc9c1727SLuigi 'Comio' Mantellini If this option is set, support for lzma compressed 1231fc9c1727SLuigi 'Comio' Mantellini images is included. 1232fc9c1727SLuigi 'Comio' Mantellini 1233fc9c1727SLuigi 'Comio' Mantellini Note: The LZMA algorithm adds between 2 and 4KB of code and it 1234fc9c1727SLuigi 'Comio' Mantellini requires an amount of dynamic memory that is given by the 1235fc9c1727SLuigi 'Comio' Mantellini formula: 1236fc9c1727SLuigi 'Comio' Mantellini 1237fc9c1727SLuigi 'Comio' Mantellini (1846 + 768 << (lc + lp)) * sizeof(uint16) 1238fc9c1727SLuigi 'Comio' Mantellini 1239fc9c1727SLuigi 'Comio' Mantellini Where lc and lp stand for, respectively, Literal context bits 1240fc9c1727SLuigi 'Comio' Mantellini and Literal pos bits. 1241fc9c1727SLuigi 'Comio' Mantellini 1242fc9c1727SLuigi 'Comio' Mantellini This value is upper-bounded by 14MB in the worst case. Anyway, 1243fc9c1727SLuigi 'Comio' Mantellini for a ~4MB large kernel image, we have lc=3 and lp=0 for a 1244fc9c1727SLuigi 'Comio' Mantellini total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is 1245fc9c1727SLuigi 'Comio' Mantellini a very small buffer. 1246fc9c1727SLuigi 'Comio' Mantellini 1247fc9c1727SLuigi 'Comio' Mantellini Use the lzmainfo tool to determinate the lc and lp values and 1248fc9c1727SLuigi 'Comio' Mantellini then calculate the amount of needed dynamic memory (ensuring 12496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD the appropriate CONFIG_SYS_MALLOC_LEN value). 1250fc9c1727SLuigi 'Comio' Mantellini 125117ea1177Swdenk- MII/PHY support: 125217ea1177Swdenk CONFIG_PHY_ADDR 125317ea1177Swdenk 125417ea1177Swdenk The address of PHY on MII bus. 125517ea1177Swdenk 125617ea1177Swdenk CONFIG_PHY_CLOCK_FREQ (ppc4xx) 125717ea1177Swdenk 125817ea1177Swdenk The clock frequency of the MII bus 125917ea1177Swdenk 126017ea1177Swdenk CONFIG_PHY_GIGE 126117ea1177Swdenk 126217ea1177Swdenk If this option is set, support for speed/duplex 126311ccc33fSMarcel Ziswiler detection of gigabit PHY is included. 126417ea1177Swdenk 126517ea1177Swdenk CONFIG_PHY_RESET_DELAY 126617ea1177Swdenk 126717ea1177Swdenk Some PHY like Intel LXT971A need extra delay after 126817ea1177Swdenk reset before any MII register access is possible. 126917ea1177Swdenk For such PHY, set this option to the usec delay 127017ea1177Swdenk required. (minimum 300usec for LXT971A) 127117ea1177Swdenk 127217ea1177Swdenk CONFIG_PHY_CMD_DELAY (ppc4xx) 127317ea1177Swdenk 127417ea1177Swdenk Some PHY like Intel LXT971A need extra delay after 127517ea1177Swdenk command issued before MII status register can be read 127617ea1177Swdenk 1277c609719bSwdenk- Ethernet address: 1278c609719bSwdenk CONFIG_ETHADDR 1279c68a05feSrichardretanubun CONFIG_ETH1ADDR 1280c609719bSwdenk CONFIG_ETH2ADDR 1281c609719bSwdenk CONFIG_ETH3ADDR 1282c68a05feSrichardretanubun CONFIG_ETH4ADDR 1283c68a05feSrichardretanubun CONFIG_ETH5ADDR 1284c609719bSwdenk 128511ccc33fSMarcel Ziswiler Define a default value for Ethernet address to use 128611ccc33fSMarcel Ziswiler for the respective Ethernet interface, in case this 1287c609719bSwdenk is not determined automatically. 1288c609719bSwdenk 1289c609719bSwdenk- IP address: 1290c609719bSwdenk CONFIG_IPADDR 1291c609719bSwdenk 1292c609719bSwdenk Define a default value for the IP address to use for 129311ccc33fSMarcel Ziswiler the default Ethernet interface, in case this is not 1294c609719bSwdenk determined through e.g. bootp. 1295c609719bSwdenk 1296c609719bSwdenk- Server IP address: 1297c609719bSwdenk CONFIG_SERVERIP 1298c609719bSwdenk 1299c609719bSwdenk Defines a default value for the IP address of a TFTP 1300c609719bSwdenk server to contact when using the "tftboot" command. 1301c609719bSwdenk 130297cfe861SRobin Getz CONFIG_KEEP_SERVERADDR 130397cfe861SRobin Getz 130497cfe861SRobin Getz Keeps the server's MAC address, in the env 'serveraddr' 130597cfe861SRobin Getz for passing to bootargs (like Linux's netconsole option) 130697cfe861SRobin Getz 130753a5c424SDavid Updegraff- Multicast TFTP Mode: 130853a5c424SDavid Updegraff CONFIG_MCAST_TFTP 130953a5c424SDavid Updegraff 131053a5c424SDavid Updegraff Defines whether you want to support multicast TFTP as per 131153a5c424SDavid Updegraff rfc-2090; for example to work with atftp. Lets lots of targets 131211ccc33fSMarcel Ziswiler tftp down the same boot image concurrently. Note: the Ethernet 131353a5c424SDavid Updegraff driver in use must provide a function: mcast() to join/leave a 131453a5c424SDavid Updegraff multicast group. 131553a5c424SDavid Updegraff 131653a5c424SDavid Updegraff CONFIG_BOOTP_RANDOM_DELAY 1317c609719bSwdenk- BOOTP Recovery Mode: 1318c609719bSwdenk CONFIG_BOOTP_RANDOM_DELAY 1319c609719bSwdenk 1320c609719bSwdenk If you have many targets in a network that try to 1321c609719bSwdenk boot using BOOTP, you may want to avoid that all 1322c609719bSwdenk systems send out BOOTP requests at precisely the same 1323c609719bSwdenk moment (which would happen for instance at recovery 1324c609719bSwdenk from a power failure, when all systems will try to 1325c609719bSwdenk boot, thus flooding the BOOTP server. Defining 1326c609719bSwdenk CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be 1327c609719bSwdenk inserted before sending out BOOTP requests. The 13286c33c785SWolfgang Denk following delays are inserted then: 1329c609719bSwdenk 1330c609719bSwdenk 1st BOOTP request: delay 0 ... 1 sec 1331c609719bSwdenk 2nd BOOTP request: delay 0 ... 2 sec 1332c609719bSwdenk 3rd BOOTP request: delay 0 ... 4 sec 1333c609719bSwdenk 4th and following 1334c609719bSwdenk BOOTP requests: delay 0 ... 8 sec 1335c609719bSwdenk 1336fe389a82Sstroese- DHCP Advanced Options: 13371fe80d79SJon Loeliger You can fine tune the DHCP functionality by defining 13381fe80d79SJon Loeliger CONFIG_BOOTP_* symbols: 1339fe389a82Sstroese 13401fe80d79SJon Loeliger CONFIG_BOOTP_SUBNETMASK 13411fe80d79SJon Loeliger CONFIG_BOOTP_GATEWAY 13421fe80d79SJon Loeliger CONFIG_BOOTP_HOSTNAME 13431fe80d79SJon Loeliger CONFIG_BOOTP_NISDOMAIN 13441fe80d79SJon Loeliger CONFIG_BOOTP_BOOTPATH 13451fe80d79SJon Loeliger CONFIG_BOOTP_BOOTFILESIZE 13461fe80d79SJon Loeliger CONFIG_BOOTP_DNS 13471fe80d79SJon Loeliger CONFIG_BOOTP_DNS2 13481fe80d79SJon Loeliger CONFIG_BOOTP_SEND_HOSTNAME 13491fe80d79SJon Loeliger CONFIG_BOOTP_NTPSERVER 13501fe80d79SJon Loeliger CONFIG_BOOTP_TIMEOFFSET 13511fe80d79SJon Loeliger CONFIG_BOOTP_VENDOREX 1352fe389a82Sstroese 13535d110f0aSWilson Callan CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip 13545d110f0aSWilson Callan environment variable, not the BOOTP server. 1355fe389a82Sstroese 1356fe389a82Sstroese CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS 1357fe389a82Sstroese serverip from a DHCP server, it is possible that more 1358fe389a82Sstroese than one DNS serverip is offered to the client. 1359fe389a82Sstroese If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS 1360fe389a82Sstroese serverip will be stored in the additional environment 1361fe389a82Sstroese variable "dnsip2". The first DNS serverip is always 1362fe389a82Sstroese stored in the variable "dnsip", when CONFIG_BOOTP_DNS 13631fe80d79SJon Loeliger is defined. 1364fe389a82Sstroese 1365fe389a82Sstroese CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable 1366fe389a82Sstroese to do a dynamic update of a DNS server. To do this, they 1367fe389a82Sstroese need the hostname of the DHCP requester. 13685d110f0aSWilson Callan If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content 13691fe80d79SJon Loeliger of the "hostname" environment variable is passed as 13701fe80d79SJon Loeliger option 12 to the DHCP server. 1371fe389a82Sstroese 1372d9a2f416SAras Vaichas CONFIG_BOOTP_DHCP_REQUEST_DELAY 1373d9a2f416SAras Vaichas 1374d9a2f416SAras Vaichas A 32bit value in microseconds for a delay between 1375d9a2f416SAras Vaichas receiving a "DHCP Offer" and sending the "DHCP Request". 1376d9a2f416SAras Vaichas This fixes a problem with certain DHCP servers that don't 1377d9a2f416SAras Vaichas respond 100% of the time to a "DHCP request". E.g. On an 1378d9a2f416SAras Vaichas AT91RM9200 processor running at 180MHz, this delay needed 1379d9a2f416SAras Vaichas to be *at least* 15,000 usec before a Windows Server 2003 1380d9a2f416SAras Vaichas DHCP server would reply 100% of the time. I recommend at 1381d9a2f416SAras Vaichas least 50,000 usec to be safe. The alternative is to hope 1382d9a2f416SAras Vaichas that one of the retries will be successful but note that 1383d9a2f416SAras Vaichas the DHCP timeout and retry process takes a longer than 1384d9a2f416SAras Vaichas this delay. 1385d9a2f416SAras Vaichas 1386a3d991bdSwdenk - CDP Options: 1387a3d991bdSwdenk CONFIG_CDP_DEVICE_ID 1388a3d991bdSwdenk 1389a3d991bdSwdenk The device id used in CDP trigger frames. 1390a3d991bdSwdenk 1391a3d991bdSwdenk CONFIG_CDP_DEVICE_ID_PREFIX 1392a3d991bdSwdenk 1393a3d991bdSwdenk A two character string which is prefixed to the MAC address 1394a3d991bdSwdenk of the device. 1395a3d991bdSwdenk 1396a3d991bdSwdenk CONFIG_CDP_PORT_ID 1397a3d991bdSwdenk 1398a3d991bdSwdenk A printf format string which contains the ascii name of 1399a3d991bdSwdenk the port. Normally is set to "eth%d" which sets 140011ccc33fSMarcel Ziswiler eth0 for the first Ethernet, eth1 for the second etc. 1401a3d991bdSwdenk 1402a3d991bdSwdenk CONFIG_CDP_CAPABILITIES 1403a3d991bdSwdenk 1404a3d991bdSwdenk A 32bit integer which indicates the device capabilities; 1405a3d991bdSwdenk 0x00000010 for a normal host which does not forwards. 1406a3d991bdSwdenk 1407a3d991bdSwdenk CONFIG_CDP_VERSION 1408a3d991bdSwdenk 1409a3d991bdSwdenk An ascii string containing the version of the software. 1410a3d991bdSwdenk 1411a3d991bdSwdenk CONFIG_CDP_PLATFORM 1412a3d991bdSwdenk 1413a3d991bdSwdenk An ascii string containing the name of the platform. 1414a3d991bdSwdenk 1415a3d991bdSwdenk CONFIG_CDP_TRIGGER 1416a3d991bdSwdenk 1417a3d991bdSwdenk A 32bit integer sent on the trigger. 1418a3d991bdSwdenk 1419a3d991bdSwdenk CONFIG_CDP_POWER_CONSUMPTION 1420a3d991bdSwdenk 1421a3d991bdSwdenk A 16bit integer containing the power consumption of the 1422a3d991bdSwdenk device in .1 of milliwatts. 1423a3d991bdSwdenk 1424a3d991bdSwdenk CONFIG_CDP_APPLIANCE_VLAN_TYPE 1425a3d991bdSwdenk 1426a3d991bdSwdenk A byte containing the id of the VLAN. 1427a3d991bdSwdenk 1428c609719bSwdenk- Status LED: CONFIG_STATUS_LED 1429c609719bSwdenk 1430c609719bSwdenk Several configurations allow to display the current 1431c609719bSwdenk status using a LED. For instance, the LED will blink 1432c609719bSwdenk fast while running U-Boot code, stop blinking as 1433c609719bSwdenk soon as a reply to a BOOTP request was received, and 1434c609719bSwdenk start blinking slow once the Linux kernel is running 1435c609719bSwdenk (supported by a status LED driver in the Linux 1436c609719bSwdenk kernel). Defining CONFIG_STATUS_LED enables this 1437c609719bSwdenk feature in U-Boot. 1438c609719bSwdenk 1439c609719bSwdenk- CAN Support: CONFIG_CAN_DRIVER 1440c609719bSwdenk 1441c609719bSwdenk Defining CONFIG_CAN_DRIVER enables CAN driver support 1442c609719bSwdenk on those systems that support this (optional) 1443c609719bSwdenk feature, like the TQM8xxL modules. 1444c609719bSwdenk 1445c609719bSwdenk- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C 1446c609719bSwdenk 1447b37c7e5eSwdenk These enable I2C serial bus commands. Defining either of 1448b37c7e5eSwdenk (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will 144911ccc33fSMarcel Ziswiler include the appropriate I2C driver for the selected CPU. 1450c609719bSwdenk 1451b37c7e5eSwdenk This will allow you to use i2c commands at the u-boot 1452602ad3b3SJon Loeliger command line (as long as you set CONFIG_CMD_I2C in 1453b37c7e5eSwdenk CONFIG_COMMANDS) and communicate with i2c based realtime 1454b37c7e5eSwdenk clock chips. See common/cmd_i2c.c for a description of the 1455c609719bSwdenk command line interface. 1456c609719bSwdenk 1457bb99ad6dSBen Warren CONFIG_HARD_I2C selects a hardware I2C controller. 1458c609719bSwdenk 1459b37c7e5eSwdenk CONFIG_SOFT_I2C configures u-boot to use a software (aka 1460b37c7e5eSwdenk bit-banging) driver instead of CPM or similar hardware 1461b37c7e5eSwdenk support for I2C. 1462c609719bSwdenk 1463b37c7e5eSwdenk There are several other quantities that must also be 1464b37c7e5eSwdenk defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C. 1465c609719bSwdenk 14666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD In both cases you will need to define CONFIG_SYS_I2C_SPEED 1467b37c7e5eSwdenk to be the frequency (in Hz) at which you wish your i2c bus 14686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie 146911ccc33fSMarcel Ziswiler the CPU's i2c node address). 1470c609719bSwdenk 14718d321b81SPeter Tyser Now, the u-boot i2c code for the mpc8xx 1472a47a12beSStefan Roese (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node 14738d321b81SPeter Tyser and so its address should therefore be cleared to 0 (See, 14748d321b81SPeter Tyser eg, MPC823e User's Manual p.16-473). So, set 14758d321b81SPeter Tyser CONFIG_SYS_I2C_SLAVE to 0. 1476b37c7e5eSwdenk 14775da71efaSEric Millbrandt CONFIG_SYS_I2C_INIT_MPC5XXX 14785da71efaSEric Millbrandt 14795da71efaSEric Millbrandt When a board is reset during an i2c bus transfer 14805da71efaSEric Millbrandt chips might think that the current transfer is still 14815da71efaSEric Millbrandt in progress. Reset the slave devices by sending start 14825da71efaSEric Millbrandt commands until the slave device responds. 14835da71efaSEric Millbrandt 1484b37c7e5eSwdenk That's all that's required for CONFIG_HARD_I2C. 1485b37c7e5eSwdenk 1486b37c7e5eSwdenk If you use the software i2c interface (CONFIG_SOFT_I2C) 1487b37c7e5eSwdenk then the following macros need to be defined (examples are 1488b37c7e5eSwdenk from include/configs/lwmon.h): 1489c609719bSwdenk 1490c609719bSwdenk I2C_INIT 1491c609719bSwdenk 1492b37c7e5eSwdenk (Optional). Any commands necessary to enable the I2C 1493c609719bSwdenk controller or configure ports. 1494c609719bSwdenk 1495b37c7e5eSwdenk eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL) 1496b37c7e5eSwdenk 1497c609719bSwdenk I2C_PORT 1498c609719bSwdenk 1499c609719bSwdenk (Only for MPC8260 CPU). The I/O port to use (the code 1500c609719bSwdenk assumes both bits are on the same port). Valid values 1501c609719bSwdenk are 0..3 for ports A..D. 1502c609719bSwdenk 1503c609719bSwdenk I2C_ACTIVE 1504c609719bSwdenk 1505c609719bSwdenk The code necessary to make the I2C data line active 1506c609719bSwdenk (driven). If the data line is open collector, this 1507c609719bSwdenk define can be null. 1508c609719bSwdenk 1509b37c7e5eSwdenk eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA) 1510b37c7e5eSwdenk 1511c609719bSwdenk I2C_TRISTATE 1512c609719bSwdenk 1513c609719bSwdenk The code necessary to make the I2C data line tri-stated 1514c609719bSwdenk (inactive). If the data line is open collector, this 1515c609719bSwdenk define can be null. 1516c609719bSwdenk 1517b37c7e5eSwdenk eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA) 1518b37c7e5eSwdenk 1519c609719bSwdenk I2C_READ 1520c609719bSwdenk 1521c609719bSwdenk Code that returns TRUE if the I2C data line is high, 1522c609719bSwdenk FALSE if it is low. 1523c609719bSwdenk 1524b37c7e5eSwdenk eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0) 1525b37c7e5eSwdenk 1526c609719bSwdenk I2C_SDA(bit) 1527c609719bSwdenk 1528c609719bSwdenk If <bit> is TRUE, sets the I2C data line high. If it 1529c609719bSwdenk is FALSE, it clears it (low). 1530c609719bSwdenk 1531b37c7e5eSwdenk eg: #define I2C_SDA(bit) \ 1532b37c7e5eSwdenk if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \ 1533b37c7e5eSwdenk else immr->im_cpm.cp_pbdat &= ~PB_SDA 1534b37c7e5eSwdenk 1535c609719bSwdenk I2C_SCL(bit) 1536c609719bSwdenk 1537c609719bSwdenk If <bit> is TRUE, sets the I2C clock line high. If it 1538c609719bSwdenk is FALSE, it clears it (low). 1539c609719bSwdenk 1540b37c7e5eSwdenk eg: #define I2C_SCL(bit) \ 1541b37c7e5eSwdenk if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \ 1542b37c7e5eSwdenk else immr->im_cpm.cp_pbdat &= ~PB_SCL 1543b37c7e5eSwdenk 1544c609719bSwdenk I2C_DELAY 1545c609719bSwdenk 1546c609719bSwdenk This delay is invoked four times per clock cycle so this 1547c609719bSwdenk controls the rate of data transfer. The data rate thus 1548b37c7e5eSwdenk is 1 / (I2C_DELAY * 4). Often defined to be something 1549b37c7e5eSwdenk like: 1550b37c7e5eSwdenk 1551b37c7e5eSwdenk #define I2C_DELAY udelay(2) 1552c609719bSwdenk 1553793b5726SMike Frysinger CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA 1554793b5726SMike Frysinger 1555793b5726SMike Frysinger If your arch supports the generic GPIO framework (asm/gpio.h), 1556793b5726SMike Frysinger then you may alternatively define the two GPIOs that are to be 1557793b5726SMike Frysinger used as SCL / SDA. Any of the previous I2C_xxx macros will 1558793b5726SMike Frysinger have GPIO-based defaults assigned to them as appropriate. 1559793b5726SMike Frysinger 1560793b5726SMike Frysinger You should define these to the GPIO value as given directly to 1561793b5726SMike Frysinger the generic GPIO functions. 1562793b5726SMike Frysinger 15636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_INIT_BOARD 156447cd00faSwdenk 156547cd00faSwdenk When a board is reset during an i2c bus transfer 156647cd00faSwdenk chips might think that the current transfer is still 156747cd00faSwdenk in progress. On some boards it is possible to access 156847cd00faSwdenk the i2c SCLK line directly, either by using the 156947cd00faSwdenk processor pin as a GPIO or by having a second pin 157047cd00faSwdenk connected to the bus. If this option is defined a 157147cd00faSwdenk custom i2c_init_board() routine in boards/xxx/board.c 157247cd00faSwdenk is run early in the boot sequence. 157347cd00faSwdenk 157426a33504SRichard Retanubun CONFIG_SYS_I2C_BOARD_LATE_INIT 157526a33504SRichard Retanubun 157626a33504SRichard Retanubun An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is 157726a33504SRichard Retanubun defined a custom i2c_board_late_init() routine in 157826a33504SRichard Retanubun boards/xxx/board.c is run AFTER the operations in i2c_init() 157926a33504SRichard Retanubun is completed. This callpoint can be used to unreset i2c bus 158026a33504SRichard Retanubun using CPU i2c controller register accesses for CPUs whose i2c 158126a33504SRichard Retanubun controller provide such a method. It is called at the end of 158226a33504SRichard Retanubun i2c_init() to allow i2c_init operations to setup the i2c bus 158326a33504SRichard Retanubun controller on the CPU (e.g. setting bus speed & slave address). 158426a33504SRichard Retanubun 158517ea1177Swdenk CONFIG_I2CFAST (PPC405GP|PPC405EP only) 158617ea1177Swdenk 158717ea1177Swdenk This option enables configuration of bi_iic_fast[] flags 158817ea1177Swdenk in u-boot bd_info structure based on u-boot environment 158917ea1177Swdenk variable "i2cfast". (see also i2cfast) 159017ea1177Swdenk 1591bb99ad6dSBen Warren CONFIG_I2C_MULTI_BUS 1592bb99ad6dSBen Warren 1593bb99ad6dSBen Warren This option allows the use of multiple I2C buses, each of which 1594bb99ad6dSBen Warren must have a controller. At any point in time, only one bus is 1595bb99ad6dSBen Warren active. To switch to a different bus, use the 'i2c dev' command. 1596bb99ad6dSBen Warren Note that bus numbering is zero-based. 1597bb99ad6dSBen Warren 15986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_NOPROBES 1599bb99ad6dSBen Warren 1600bb99ad6dSBen Warren This option specifies a list of I2C devices that will be skipped 16010f89c54bSPeter Tyser when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS 16020f89c54bSPeter Tyser is set, specify a list of bus-device pairs. Otherwise, specify 16030f89c54bSPeter Tyser a 1D array of device addresses 1604bb99ad6dSBen Warren 1605bb99ad6dSBen Warren e.g. 1606bb99ad6dSBen Warren #undef CONFIG_I2C_MULTI_BUS 16076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68} 1608bb99ad6dSBen Warren 1609bb99ad6dSBen Warren will skip addresses 0x50 and 0x68 on a board with one I2C bus 1610bb99ad6dSBen Warren 1611bb99ad6dSBen Warren #define CONFIG_I2C_MULTI_BUS 16126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}} 1613bb99ad6dSBen Warren 1614bb99ad6dSBen Warren will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1 1615bb99ad6dSBen Warren 16166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SPD_BUS_NUM 1617be5e6181STimur Tabi 1618be5e6181STimur Tabi If defined, then this indicates the I2C bus number for DDR SPD. 1619be5e6181STimur Tabi If not defined, then U-Boot assumes that SPD is on I2C bus 0. 1620be5e6181STimur Tabi 16216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_RTC_BUS_NUM 16220dc018ecSStefan Roese 16230dc018ecSStefan Roese If defined, then this indicates the I2C bus number for the RTC. 16240dc018ecSStefan Roese If not defined, then U-Boot assumes that RTC is on I2C bus 0. 16250dc018ecSStefan Roese 16266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_DTT_BUS_NUM 16270dc018ecSStefan Roese 16280dc018ecSStefan Roese If defined, then this indicates the I2C bus number for the DTT. 16290dc018ecSStefan Roese If not defined, then U-Boot assumes that DTT is on I2C bus 0. 16300dc018ecSStefan Roese 16316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_DTT_ADDR: 16329ebbb54fSVictor Gallardo 16339ebbb54fSVictor Gallardo If defined, specifies the I2C address of the DTT device. 16349ebbb54fSVictor Gallardo If not defined, then U-Boot uses predefined value for 16359ebbb54fSVictor Gallardo specified DTT device. 16369ebbb54fSVictor Gallardo 1637be5e6181STimur Tabi CONFIG_FSL_I2C 1638be5e6181STimur Tabi 1639be5e6181STimur Tabi Define this option if you want to use Freescale's I2C driver in 16407817cb20SMarcel Ziswiler drivers/i2c/fsl_i2c.c. 1641be5e6181STimur Tabi 164267b23a32SHeiko Schocher CONFIG_I2C_MUX 164367b23a32SHeiko Schocher 164467b23a32SHeiko Schocher Define this option if you have I2C devices reached over 1 .. n 164567b23a32SHeiko Schocher I2C Muxes like the pca9544a. This option addes a new I2C 164667b23a32SHeiko Schocher Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a 164767b23a32SHeiko Schocher new I2C Bus to the existing I2C Busses. If you select the 164867b23a32SHeiko Schocher new Bus with "i2c dev", u-bbot sends first the commandos for 164967b23a32SHeiko Schocher the muxes to activate this new "bus". 165067b23a32SHeiko Schocher 165167b23a32SHeiko Schocher CONFIG_I2C_MULTI_BUS must be also defined, to use this 165267b23a32SHeiko Schocher feature! 165367b23a32SHeiko Schocher 165467b23a32SHeiko Schocher Example: 165567b23a32SHeiko Schocher Adding a new I2C Bus reached over 2 pca9544a muxes 165667b23a32SHeiko Schocher The First mux with address 70 and channel 6 165767b23a32SHeiko Schocher The Second mux with address 71 and channel 4 165867b23a32SHeiko Schocher 165967b23a32SHeiko Schocher => i2c bus pca9544a:70:6:pca9544a:71:4 166067b23a32SHeiko Schocher 166167b23a32SHeiko Schocher Use the "i2c bus" command without parameter, to get a list 166267b23a32SHeiko Schocher of I2C Busses with muxes: 166367b23a32SHeiko Schocher 166467b23a32SHeiko Schocher => i2c bus 166567b23a32SHeiko Schocher Busses reached over muxes: 166667b23a32SHeiko Schocher Bus ID: 2 166767b23a32SHeiko Schocher reached over Mux(es): 166867b23a32SHeiko Schocher pca9544a@70 ch: 4 166967b23a32SHeiko Schocher Bus ID: 3 167067b23a32SHeiko Schocher reached over Mux(es): 167167b23a32SHeiko Schocher pca9544a@70 ch: 6 167267b23a32SHeiko Schocher pca9544a@71 ch: 4 167367b23a32SHeiko Schocher => 167467b23a32SHeiko Schocher 167567b23a32SHeiko Schocher If you now switch to the new I2C Bus 3 with "i2c dev 3" 167667b23a32SHeiko Schocher u-boot sends First the Commando to the mux@70 to enable 167767b23a32SHeiko Schocher channel 6, and then the Commando to the mux@71 to enable 167867b23a32SHeiko Schocher the channel 4. 167967b23a32SHeiko Schocher 168067b23a32SHeiko Schocher After that, you can use the "normal" i2c commands as 168167b23a32SHeiko Schocher usual, to communicate with your I2C devices behind 168267b23a32SHeiko Schocher the 2 muxes. 168367b23a32SHeiko Schocher 168467b23a32SHeiko Schocher This option is actually implemented for the bitbanging 168567b23a32SHeiko Schocher algorithm in common/soft_i2c.c and for the Hardware I2C 168667b23a32SHeiko Schocher Bus on the MPC8260. But it should be not so difficult 168767b23a32SHeiko Schocher to add this option to other architectures. 168867b23a32SHeiko Schocher 16892ac6985aSAndrew Dyer CONFIG_SOFT_I2C_READ_REPEATED_START 16902ac6985aSAndrew Dyer 16912ac6985aSAndrew Dyer defining this will force the i2c_read() function in 16922ac6985aSAndrew Dyer the soft_i2c driver to perform an I2C repeated start 16932ac6985aSAndrew Dyer between writing the address pointer and reading the 16942ac6985aSAndrew Dyer data. If this define is omitted the default behaviour 16952ac6985aSAndrew Dyer of doing a stop-start sequence will be used. Most I2C 16962ac6985aSAndrew Dyer devices can use either method, but some require one or 16972ac6985aSAndrew Dyer the other. 1698be5e6181STimur Tabi 1699c609719bSwdenk- SPI Support: CONFIG_SPI 1700c609719bSwdenk 1701c609719bSwdenk Enables SPI driver (so far only tested with 1702c609719bSwdenk SPI EEPROM, also an instance works with Crystal A/D and 1703c609719bSwdenk D/As on the SACSng board) 1704c609719bSwdenk 17056639562eSYoshihiro Shimoda CONFIG_SH_SPI 17066639562eSYoshihiro Shimoda 17076639562eSYoshihiro Shimoda Enables the driver for SPI controller on SuperH. Currently 17086639562eSYoshihiro Shimoda only SH7757 is supported. 17096639562eSYoshihiro Shimoda 1710c609719bSwdenk CONFIG_SPI_X 1711c609719bSwdenk 1712c609719bSwdenk Enables extended (16-bit) SPI EEPROM addressing. 1713c609719bSwdenk (symmetrical to CONFIG_I2C_X) 1714c609719bSwdenk 1715c609719bSwdenk CONFIG_SOFT_SPI 1716c609719bSwdenk 1717c609719bSwdenk Enables a software (bit-bang) SPI driver rather than 1718c609719bSwdenk using hardware support. This is a general purpose 1719c609719bSwdenk driver that only requires three general I/O port pins 1720c609719bSwdenk (two outputs, one input) to function. If this is 1721c609719bSwdenk defined, the board configuration must define several 1722c609719bSwdenk SPI configuration items (port pins to use, etc). For 1723c609719bSwdenk an example, see include/configs/sacsng.h. 1724c609719bSwdenk 172504a9e118SBen Warren CONFIG_HARD_SPI 172604a9e118SBen Warren 172704a9e118SBen Warren Enables a hardware SPI driver for general-purpose reads 172804a9e118SBen Warren and writes. As with CONFIG_SOFT_SPI, the board configuration 172904a9e118SBen Warren must define a list of chip-select function pointers. 173004a9e118SBen Warren Currently supported on some MPC8xxx processors. For an 173104a9e118SBen Warren example, see include/configs/mpc8349emds.h. 173204a9e118SBen Warren 173338254f45SGuennadi Liakhovetski CONFIG_MXC_SPI 173438254f45SGuennadi Liakhovetski 173538254f45SGuennadi Liakhovetski Enables the driver for the SPI controllers on i.MX and MXC 173638254f45SGuennadi Liakhovetski SoCs. Currently only i.MX31 is supported. 173738254f45SGuennadi Liakhovetski 17380133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA 17390133502eSMatthias Fuchs 17400133502eSMatthias Fuchs Enables FPGA subsystem. 17410133502eSMatthias Fuchs 17420133502eSMatthias Fuchs CONFIG_FPGA_<vendor> 17430133502eSMatthias Fuchs 17440133502eSMatthias Fuchs Enables support for specific chip vendors. 17450133502eSMatthias Fuchs (ALTERA, XILINX) 17460133502eSMatthias Fuchs 17470133502eSMatthias Fuchs CONFIG_FPGA_<family> 17480133502eSMatthias Fuchs 17490133502eSMatthias Fuchs Enables support for FPGA family. 17500133502eSMatthias Fuchs (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX) 17510133502eSMatthias Fuchs 17520133502eSMatthias Fuchs CONFIG_FPGA_COUNT 1753c609719bSwdenk 1754c609719bSwdenk Specify the number of FPGA devices to support. 1755c609719bSwdenk 17566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_PROG_FEEDBACK 1757c609719bSwdenk 1758c609719bSwdenk Enable printing of hash marks during FPGA configuration. 1759c609719bSwdenk 17606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_BUSY 1761c609719bSwdenk 1762c609719bSwdenk Enable checks on FPGA configuration interface busy 1763c609719bSwdenk status by the configuration function. This option 1764c609719bSwdenk will require a board or device specific function to 1765c609719bSwdenk be written. 1766c609719bSwdenk 1767c609719bSwdenk CONFIG_FPGA_DELAY 1768c609719bSwdenk 1769c609719bSwdenk If defined, a function that provides delays in the FPGA 1770c609719bSwdenk configuration driver. 1771c609719bSwdenk 17726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_CTRLC 1773c609719bSwdenk Allow Control-C to interrupt FPGA configuration 1774c609719bSwdenk 17756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_ERROR 1776c609719bSwdenk 1777c609719bSwdenk Check for configuration errors during FPGA bitfile 1778c609719bSwdenk loading. For example, abort during Virtex II 1779c609719bSwdenk configuration if the INIT_B line goes low (which 1780c609719bSwdenk indicated a CRC error). 1781c609719bSwdenk 17826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_INIT 1783c609719bSwdenk 1784c609719bSwdenk Maximum time to wait for the INIT_B line to deassert 1785c609719bSwdenk after PROB_B has been deasserted during a Virtex II 1786c609719bSwdenk FPGA configuration sequence. The default time is 500 178711ccc33fSMarcel Ziswiler ms. 1788c609719bSwdenk 17896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_BUSY 1790c609719bSwdenk 1791c609719bSwdenk Maximum time to wait for BUSY to deassert during 179211ccc33fSMarcel Ziswiler Virtex II FPGA configuration. The default is 5 ms. 1793c609719bSwdenk 17946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_CONFIG 1795c609719bSwdenk 1796c609719bSwdenk Time to wait after FPGA configuration. The default is 179711ccc33fSMarcel Ziswiler 200 ms. 1798c609719bSwdenk 1799c609719bSwdenk- Configuration Management: 1800c609719bSwdenk CONFIG_IDENT_STRING 1801c609719bSwdenk 1802c609719bSwdenk If defined, this string will be added to the U-Boot 1803c609719bSwdenk version information (U_BOOT_VERSION) 1804c609719bSwdenk 1805c609719bSwdenk- Vendor Parameter Protection: 1806c609719bSwdenk 1807c609719bSwdenk U-Boot considers the values of the environment 1808c609719bSwdenk variables "serial#" (Board Serial Number) and 18097152b1d0Swdenk "ethaddr" (Ethernet Address) to be parameters that 1810c609719bSwdenk are set once by the board vendor / manufacturer, and 1811c609719bSwdenk protects these variables from casual modification by 1812c609719bSwdenk the user. Once set, these variables are read-only, 1813c609719bSwdenk and write or delete attempts are rejected. You can 181411ccc33fSMarcel Ziswiler change this behaviour: 1815c609719bSwdenk 1816c609719bSwdenk If CONFIG_ENV_OVERWRITE is #defined in your config 1817c609719bSwdenk file, the write protection for vendor parameters is 181847cd00faSwdenk completely disabled. Anybody can change or delete 1819c609719bSwdenk these parameters. 1820c609719bSwdenk 1821c609719bSwdenk Alternatively, if you #define _both_ CONFIG_ETHADDR 1822c609719bSwdenk _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default 182311ccc33fSMarcel Ziswiler Ethernet address is installed in the environment, 1824c609719bSwdenk which can be changed exactly ONCE by the user. [The 1825c609719bSwdenk serial# is unaffected by this, i. e. it remains 1826c609719bSwdenk read-only.] 1827c609719bSwdenk 1828c609719bSwdenk- Protected RAM: 1829c609719bSwdenk CONFIG_PRAM 1830c609719bSwdenk 1831c609719bSwdenk Define this variable to enable the reservation of 1832c609719bSwdenk "protected RAM", i. e. RAM which is not overwritten 1833c609719bSwdenk by U-Boot. Define CONFIG_PRAM to hold the number of 1834c609719bSwdenk kB you want to reserve for pRAM. You can overwrite 1835c609719bSwdenk this default value by defining an environment 1836c609719bSwdenk variable "pram" to the number of kB you want to 1837c609719bSwdenk reserve. Note that the board info structure will 1838c609719bSwdenk still show the full amount of RAM. If pRAM is 1839c609719bSwdenk reserved, a new environment variable "mem" will 1840c609719bSwdenk automatically be defined to hold the amount of 1841c609719bSwdenk remaining RAM in a form that can be passed as boot 1842c609719bSwdenk argument to Linux, for instance like that: 1843c609719bSwdenk 1844fe126d8bSWolfgang Denk setenv bootargs ... mem=\${mem} 1845c609719bSwdenk saveenv 1846c609719bSwdenk 1847c609719bSwdenk This way you can tell Linux not to use this memory, 1848c609719bSwdenk either, which results in a memory region that will 1849c609719bSwdenk not be affected by reboots. 1850c609719bSwdenk 1851c609719bSwdenk *WARNING* If your board configuration uses automatic 1852c609719bSwdenk detection of the RAM size, you must make sure that 1853c609719bSwdenk this memory test is non-destructive. So far, the 1854c609719bSwdenk following board configurations are known to be 1855c609719bSwdenk "pRAM-clean": 1856c609719bSwdenk 1857c609719bSwdenk ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL, 1858c609719bSwdenk HERMES, IP860, RPXlite, LWMON, LANTEC, 1859544d97e9SWolfgang Denk FLAGADM, TQM8260 1860c609719bSwdenk 1861c609719bSwdenk- Error Recovery: 1862c609719bSwdenk CONFIG_PANIC_HANG 1863c609719bSwdenk 1864c609719bSwdenk Define this variable to stop the system in case of a 1865c609719bSwdenk fatal error, so that you have to reset it manually. 1866c609719bSwdenk This is probably NOT a good idea for an embedded 186711ccc33fSMarcel Ziswiler system where you want the system to reboot 1868c609719bSwdenk automatically as fast as possible, but it may be 1869c609719bSwdenk useful during development since you can try to debug 1870c609719bSwdenk the conditions that lead to the situation. 1871c609719bSwdenk 1872c609719bSwdenk CONFIG_NET_RETRY_COUNT 1873c609719bSwdenk 1874c609719bSwdenk This variable defines the number of retries for 1875c609719bSwdenk network operations like ARP, RARP, TFTP, or BOOTP 1876c609719bSwdenk before giving up the operation. If not defined, a 1877c609719bSwdenk default value of 5 is used. 1878c609719bSwdenk 187940cb90eeSGuennadi Liakhovetski CONFIG_ARP_TIMEOUT 188040cb90eeSGuennadi Liakhovetski 188140cb90eeSGuennadi Liakhovetski Timeout waiting for an ARP reply in milliseconds. 188240cb90eeSGuennadi Liakhovetski 1883c609719bSwdenk- Command Interpreter: 18848078f1a5SWolfgang Denk CONFIG_AUTO_COMPLETE 188504a85b3bSwdenk 188604a85b3bSwdenk Enable auto completion of commands using TAB. 188704a85b3bSwdenk 18888078f1a5SWolfgang Denk Note that this feature has NOT been implemented yet 18898078f1a5SWolfgang Denk for the "hush" shell. 18908078f1a5SWolfgang Denk 18918078f1a5SWolfgang Denk 18926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_HUSH_PARSER 1893c609719bSwdenk 1894c609719bSwdenk Define this variable to enable the "hush" shell (from 1895c609719bSwdenk Busybox) as command line interpreter, thus enabling 1896c609719bSwdenk powerful command line syntax like 1897c609719bSwdenk if...then...else...fi conditionals or `&&' and '||' 1898c609719bSwdenk constructs ("shell scripts"). 1899c609719bSwdenk 1900c609719bSwdenk If undefined, you get the old, much simpler behaviour 1901c609719bSwdenk with a somewhat smaller memory footprint. 1902c609719bSwdenk 1903c609719bSwdenk 19046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PROMPT_HUSH_PS2 1905c609719bSwdenk 1906c609719bSwdenk This defines the secondary prompt string, which is 1907c609719bSwdenk printed when the command interpreter needs more input 1908c609719bSwdenk to complete a command. Usually "> ". 1909c609719bSwdenk 1910c609719bSwdenk Note: 1911c609719bSwdenk 1912c609719bSwdenk In the current implementation, the local variables 1913c609719bSwdenk space and global environment variables space are 1914c609719bSwdenk separated. Local variables are those you define by 19153b57fe0aSwdenk simply typing `name=value'. To access a local 1916c609719bSwdenk variable later on, you have write `$name' or 19173b57fe0aSwdenk `${name}'; to execute the contents of a variable 19183b57fe0aSwdenk directly type `$name' at the command prompt. 1919c609719bSwdenk 1920c609719bSwdenk Global environment variables are those you use 1921c609719bSwdenk setenv/printenv to work with. To run a command stored 1922c609719bSwdenk in such a variable, you need to use the run command, 1923c609719bSwdenk and you must not use the '$' sign to access them. 1924c609719bSwdenk 1925c609719bSwdenk To store commands and special characters in a 1926c609719bSwdenk variable, please use double quotation marks 1927c609719bSwdenk surrounding the whole text of the variable, instead 1928c609719bSwdenk of the backslashes before semicolons and special 1929c609719bSwdenk symbols. 1930c609719bSwdenk 1931aa0c71acSWolfgang Denk- Commandline Editing and History: 1932aa0c71acSWolfgang Denk CONFIG_CMDLINE_EDITING 1933aa0c71acSWolfgang Denk 193411ccc33fSMarcel Ziswiler Enable editing and History functions for interactive 1935aa0c71acSWolfgang Denk commandline input operations 1936aa0c71acSWolfgang Denk 1937a8c7c708Swdenk- Default Environment: 1938c609719bSwdenk CONFIG_EXTRA_ENV_SETTINGS 1939c609719bSwdenk 1940c609719bSwdenk Define this to contain any number of null terminated 1941c609719bSwdenk strings (variable = value pairs) that will be part of 19427152b1d0Swdenk the default environment compiled into the boot image. 19432262cfeeSwdenk 1944c609719bSwdenk For example, place something like this in your 1945c609719bSwdenk board's config file: 1946c609719bSwdenk 1947c609719bSwdenk #define CONFIG_EXTRA_ENV_SETTINGS \ 1948c609719bSwdenk "myvar1=value1\0" \ 1949c609719bSwdenk "myvar2=value2\0" 1950c609719bSwdenk 1951c609719bSwdenk Warning: This method is based on knowledge about the 1952c609719bSwdenk internal format how the environment is stored by the 19532262cfeeSwdenk U-Boot code. This is NOT an official, exported 1954c609719bSwdenk interface! Although it is unlikely that this format 19557152b1d0Swdenk will change soon, there is no guarantee either. 1956c609719bSwdenk You better know what you are doing here. 1957c609719bSwdenk 1958c609719bSwdenk Note: overly (ab)use of the default environment is 1959c609719bSwdenk discouraged. Make sure to check other ways to preset 196074de7aefSWolfgang Denk the environment like the "source" command or the 1961c609719bSwdenk boot command first. 1962c609719bSwdenk 1963a8c7c708Swdenk- DataFlash Support: 19642abbe075Swdenk CONFIG_HAS_DATAFLASH 19652abbe075Swdenk 19662abbe075Swdenk Defining this option enables DataFlash features and 19672abbe075Swdenk allows to read/write in Dataflash via the standard 19682abbe075Swdenk commands cp, md... 19692abbe075Swdenk 19703f85ce27Swdenk- SystemACE Support: 19713f85ce27Swdenk CONFIG_SYSTEMACE 19723f85ce27Swdenk 19733f85ce27Swdenk Adding this option adds support for Xilinx SystemACE 19743f85ce27Swdenk chips attached via some sort of local bus. The address 197511ccc33fSMarcel Ziswiler of the chip must also be defined in the 19766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SYSTEMACE_BASE macro. For example: 19773f85ce27Swdenk 19783f85ce27Swdenk #define CONFIG_SYSTEMACE 19796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000 19803f85ce27Swdenk 19813f85ce27Swdenk When SystemACE support is added, the "ace" device type 19823f85ce27Swdenk becomes available to the fat commands, i.e. fatls. 19833f85ce27Swdenk 1984ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port: 1985ecb0ccd9SWolfgang Denk CONFIG_TFTP_PORT 1986ecb0ccd9SWolfgang Denk 198728cb9375SWolfgang Denk If this is defined, the environment variable tftpsrcp 1988ecb0ccd9SWolfgang Denk is used to supply the TFTP UDP source port value. 198928cb9375SWolfgang Denk If tftpsrcp isn't defined, the normal pseudo-random port 1990ecb0ccd9SWolfgang Denk number generator is used. 1991ecb0ccd9SWolfgang Denk 199228cb9375SWolfgang Denk Also, the environment variable tftpdstp is used to supply 199328cb9375SWolfgang Denk the TFTP UDP destination port value. If tftpdstp isn't 199428cb9375SWolfgang Denk defined, the normal port 69 is used. 199528cb9375SWolfgang Denk 199628cb9375SWolfgang Denk The purpose for tftpsrcp is to allow a TFTP server to 1997ecb0ccd9SWolfgang Denk blindly start the TFTP transfer using the pre-configured 1998ecb0ccd9SWolfgang Denk target IP address and UDP port. This has the effect of 1999ecb0ccd9SWolfgang Denk "punching through" the (Windows XP) firewall, allowing 2000ecb0ccd9SWolfgang Denk the remainder of the TFTP transfer to proceed normally. 2001ecb0ccd9SWolfgang Denk A better solution is to properly configure the firewall, 2002ecb0ccd9SWolfgang Denk but sometimes that is not allowed. 2003ecb0ccd9SWolfgang Denk 2004a8c7c708Swdenk- Show boot progress: 2005c609719bSwdenk CONFIG_SHOW_BOOT_PROGRESS 2006c609719bSwdenk 2007c609719bSwdenk Defining this option allows to add some board- 2008c609719bSwdenk specific code (calling a user-provided function 2009c609719bSwdenk "show_boot_progress(int)") that enables you to show 2010c609719bSwdenk the system's boot progress on some display (for 2011c609719bSwdenk example, some LED's) on your board. At the moment, 2012c609719bSwdenk the following checkpoints are implemented: 2013c609719bSwdenk 20148ae86b76SWolfgang Denk- Standalone program support: 20158ae86b76SWolfgang Denk CONFIG_STANDALONE_LOAD_ADDR 20168ae86b76SWolfgang Denk 20178ae86b76SWolfgang Denk This option allows to define board specific values 20188ae86b76SWolfgang Denk for the address where standalone program gets loaded, 20198ae86b76SWolfgang Denk thus overwriting the architecutre dependent default 20208ae86b76SWolfgang Denk settings. 20218ae86b76SWolfgang Denk 2022d32a1a4cSMinkyu Kang- Frame Buffer Address: 2023d32a1a4cSMinkyu Kang CONFIG_FB_ADDR 2024d32a1a4cSMinkyu Kang 2025d32a1a4cSMinkyu Kang Define CONFIG_FB_ADDR if you want to use specific address for 2026d32a1a4cSMinkyu Kang frame buffer. 2027d32a1a4cSMinkyu Kang Then system will reserve the frame buffer address to defined address 2028d32a1a4cSMinkyu Kang instead of lcd_setmem (this function grab the memory for frame buffer 2029d32a1a4cSMinkyu Kang by panel's size). 2030d32a1a4cSMinkyu Kang 2031d32a1a4cSMinkyu Kang Please see board_init_f function. 2032d32a1a4cSMinkyu Kang 2033d32a1a4cSMinkyu Kang If you want this config option then, 2034d32a1a4cSMinkyu Kang please define it at your board config file 2035d32a1a4cSMinkyu Kang 20361372cce2SMarian BalakowiczLegacy uImage format: 20371372cce2SMarian Balakowicz 2038c609719bSwdenk Arg Where When 2039c609719bSwdenk 1 common/cmd_bootm.c before attempting to boot an image 2040c609719bSwdenk -1 common/cmd_bootm.c Image header has bad magic number 2041c609719bSwdenk 2 common/cmd_bootm.c Image header has correct magic number 2042c609719bSwdenk -2 common/cmd_bootm.c Image header has bad checksum 2043c609719bSwdenk 3 common/cmd_bootm.c Image header has correct checksum 2044c609719bSwdenk -3 common/cmd_bootm.c Image data has bad checksum 2045c609719bSwdenk 4 common/cmd_bootm.c Image data has correct checksum 2046c609719bSwdenk -4 common/cmd_bootm.c Image is for unsupported architecture 2047c609719bSwdenk 5 common/cmd_bootm.c Architecture check OK 20481372cce2SMarian Balakowicz -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi) 2049c609719bSwdenk 6 common/cmd_bootm.c Image Type check OK 2050c609719bSwdenk -6 common/cmd_bootm.c gunzip uncompression error 2051c609719bSwdenk -7 common/cmd_bootm.c Unimplemented compression type 2052c609719bSwdenk 7 common/cmd_bootm.c Uncompression OK 20531372cce2SMarian Balakowicz 8 common/cmd_bootm.c No uncompress/copy overwrite error 2054c609719bSwdenk -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX) 20551372cce2SMarian Balakowicz 20561372cce2SMarian Balakowicz 9 common/image.c Start initial ramdisk verification 20571372cce2SMarian Balakowicz -10 common/image.c Ramdisk header has bad magic number 20581372cce2SMarian Balakowicz -11 common/image.c Ramdisk header has bad checksum 20591372cce2SMarian Balakowicz 10 common/image.c Ramdisk header is OK 20601372cce2SMarian Balakowicz -12 common/image.c Ramdisk data has bad checksum 20611372cce2SMarian Balakowicz 11 common/image.c Ramdisk data has correct checksum 20621372cce2SMarian Balakowicz 12 common/image.c Ramdisk verification complete, start loading 206311ccc33fSMarcel Ziswiler -13 common/image.c Wrong Image Type (not PPC Linux ramdisk) 20641372cce2SMarian Balakowicz 13 common/image.c Start multifile image verification 20651372cce2SMarian Balakowicz 14 common/image.c No initial ramdisk, no multifile, continue. 20661372cce2SMarian Balakowicz 2067ea0364f1SPeter Tyser 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS 2068c609719bSwdenk 2069a47a12beSStefan Roese -30 arch/powerpc/lib/board.c Fatal error, hang the system 207063e73c9aSwdenk -31 post/post.c POST test failed, detected by post_output_backlog() 207163e73c9aSwdenk -32 post/post.c POST test failed, detected by post_run_single() 207263e73c9aSwdenk 2073566a494fSHeiko Schocher 34 common/cmd_doc.c before loading a Image from a DOC device 2074566a494fSHeiko Schocher -35 common/cmd_doc.c Bad usage of "doc" command 2075566a494fSHeiko Schocher 35 common/cmd_doc.c correct usage of "doc" command 2076566a494fSHeiko Schocher -36 common/cmd_doc.c No boot device 2077566a494fSHeiko Schocher 36 common/cmd_doc.c correct boot device 2078566a494fSHeiko Schocher -37 common/cmd_doc.c Unknown Chip ID on boot device 2079566a494fSHeiko Schocher 37 common/cmd_doc.c correct chip ID found, device available 2080566a494fSHeiko Schocher -38 common/cmd_doc.c Read Error on boot device 2081566a494fSHeiko Schocher 38 common/cmd_doc.c reading Image header from DOC device OK 2082566a494fSHeiko Schocher -39 common/cmd_doc.c Image header has bad magic number 2083566a494fSHeiko Schocher 39 common/cmd_doc.c Image header has correct magic number 2084566a494fSHeiko Schocher -40 common/cmd_doc.c Error reading Image from DOC device 2085566a494fSHeiko Schocher 40 common/cmd_doc.c Image header has correct magic number 2086566a494fSHeiko Schocher 41 common/cmd_ide.c before loading a Image from a IDE device 2087566a494fSHeiko Schocher -42 common/cmd_ide.c Bad usage of "ide" command 2088566a494fSHeiko Schocher 42 common/cmd_ide.c correct usage of "ide" command 2089566a494fSHeiko Schocher -43 common/cmd_ide.c No boot device 2090566a494fSHeiko Schocher 43 common/cmd_ide.c boot device found 2091566a494fSHeiko Schocher -44 common/cmd_ide.c Device not available 2092566a494fSHeiko Schocher 44 common/cmd_ide.c Device available 2093566a494fSHeiko Schocher -45 common/cmd_ide.c wrong partition selected 2094566a494fSHeiko Schocher 45 common/cmd_ide.c partition selected 2095566a494fSHeiko Schocher -46 common/cmd_ide.c Unknown partition table 2096566a494fSHeiko Schocher 46 common/cmd_ide.c valid partition table found 2097566a494fSHeiko Schocher -47 common/cmd_ide.c Invalid partition type 2098566a494fSHeiko Schocher 47 common/cmd_ide.c correct partition type 2099566a494fSHeiko Schocher -48 common/cmd_ide.c Error reading Image Header on boot device 2100566a494fSHeiko Schocher 48 common/cmd_ide.c reading Image Header from IDE device OK 2101566a494fSHeiko Schocher -49 common/cmd_ide.c Image header has bad magic number 2102566a494fSHeiko Schocher 49 common/cmd_ide.c Image header has correct magic number 2103566a494fSHeiko Schocher -50 common/cmd_ide.c Image header has bad checksum 2104566a494fSHeiko Schocher 50 common/cmd_ide.c Image header has correct checksum 2105566a494fSHeiko Schocher -51 common/cmd_ide.c Error reading Image from IDE device 2106566a494fSHeiko Schocher 51 common/cmd_ide.c reading Image from IDE device OK 2107566a494fSHeiko Schocher 52 common/cmd_nand.c before loading a Image from a NAND device 2108566a494fSHeiko Schocher -53 common/cmd_nand.c Bad usage of "nand" command 2109566a494fSHeiko Schocher 53 common/cmd_nand.c correct usage of "nand" command 2110566a494fSHeiko Schocher -54 common/cmd_nand.c No boot device 2111566a494fSHeiko Schocher 54 common/cmd_nand.c boot device found 2112566a494fSHeiko Schocher -55 common/cmd_nand.c Unknown Chip ID on boot device 2113566a494fSHeiko Schocher 55 common/cmd_nand.c correct chip ID found, device available 2114566a494fSHeiko Schocher -56 common/cmd_nand.c Error reading Image Header on boot device 2115566a494fSHeiko Schocher 56 common/cmd_nand.c reading Image Header from NAND device OK 2116566a494fSHeiko Schocher -57 common/cmd_nand.c Image header has bad magic number 2117566a494fSHeiko Schocher 57 common/cmd_nand.c Image header has correct magic number 2118566a494fSHeiko Schocher -58 common/cmd_nand.c Error reading Image from NAND device 2119566a494fSHeiko Schocher 58 common/cmd_nand.c reading Image from NAND device OK 2120c609719bSwdenk 2121566a494fSHeiko Schocher -60 common/env_common.c Environment has a bad CRC, using default 2122c609719bSwdenk 2123566a494fSHeiko Schocher 64 net/eth.c starting with Ethernet configuration. 2124566a494fSHeiko Schocher -64 net/eth.c no Ethernet found. 2125566a494fSHeiko Schocher 65 net/eth.c Ethernet found. 2126206c60cbSwdenk 2127566a494fSHeiko Schocher -80 common/cmd_net.c usage wrong 2128566a494fSHeiko Schocher 80 common/cmd_net.c before calling NetLoop() 212911ccc33fSMarcel Ziswiler -81 common/cmd_net.c some error in NetLoop() occurred 2130566a494fSHeiko Schocher 81 common/cmd_net.c NetLoop() back without error 2131566a494fSHeiko Schocher -82 common/cmd_net.c size == 0 (File with size 0 loaded) 2132566a494fSHeiko Schocher 82 common/cmd_net.c trying automatic boot 213374de7aefSWolfgang Denk 83 common/cmd_net.c running "source" command 213474de7aefSWolfgang Denk -83 common/cmd_net.c some error in automatic boot or "source" command 2135566a494fSHeiko Schocher 84 common/cmd_net.c end without errors 2136c609719bSwdenk 21371372cce2SMarian BalakowiczFIT uImage format: 21381372cce2SMarian Balakowicz 21391372cce2SMarian Balakowicz Arg Where When 21401372cce2SMarian Balakowicz 100 common/cmd_bootm.c Kernel FIT Image has correct format 21411372cce2SMarian Balakowicz -100 common/cmd_bootm.c Kernel FIT Image has incorrect format 21421372cce2SMarian Balakowicz 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration 21431372cce2SMarian Balakowicz -101 common/cmd_bootm.c Can't get configuration for kernel subimage 21441372cce2SMarian Balakowicz 102 common/cmd_bootm.c Kernel unit name specified 21451372cce2SMarian Balakowicz -103 common/cmd_bootm.c Can't get kernel subimage node offset 2146f773bea8SMarian Balakowicz 103 common/cmd_bootm.c Found configuration node 21471372cce2SMarian Balakowicz 104 common/cmd_bootm.c Got kernel subimage node offset 21481372cce2SMarian Balakowicz -104 common/cmd_bootm.c Kernel subimage hash verification failed 21491372cce2SMarian Balakowicz 105 common/cmd_bootm.c Kernel subimage hash verification OK 21501372cce2SMarian Balakowicz -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture 21511372cce2SMarian Balakowicz 106 common/cmd_bootm.c Architecture check OK 215211ccc33fSMarcel Ziswiler -106 common/cmd_bootm.c Kernel subimage has wrong type 215311ccc33fSMarcel Ziswiler 107 common/cmd_bootm.c Kernel subimage type OK 21541372cce2SMarian Balakowicz -107 common/cmd_bootm.c Can't get kernel subimage data/size 21551372cce2SMarian Balakowicz 108 common/cmd_bootm.c Got kernel subimage data/size 21561372cce2SMarian Balakowicz -108 common/cmd_bootm.c Wrong image type (not legacy, FIT) 21571372cce2SMarian Balakowicz -109 common/cmd_bootm.c Can't get kernel subimage type 21581372cce2SMarian Balakowicz -110 common/cmd_bootm.c Can't get kernel subimage comp 21591372cce2SMarian Balakowicz -111 common/cmd_bootm.c Can't get kernel subimage os 21601372cce2SMarian Balakowicz -112 common/cmd_bootm.c Can't get kernel subimage load address 21611372cce2SMarian Balakowicz -113 common/cmd_bootm.c Image uncompress/copy overwrite error 21621372cce2SMarian Balakowicz 21631372cce2SMarian Balakowicz 120 common/image.c Start initial ramdisk verification 21641372cce2SMarian Balakowicz -120 common/image.c Ramdisk FIT image has incorrect format 21651372cce2SMarian Balakowicz 121 common/image.c Ramdisk FIT image has correct format 216611ccc33fSMarcel Ziswiler 122 common/image.c No ramdisk subimage unit name, using configuration 21671372cce2SMarian Balakowicz -122 common/image.c Can't get configuration for ramdisk subimage 21681372cce2SMarian Balakowicz 123 common/image.c Ramdisk unit name specified 21691372cce2SMarian Balakowicz -124 common/image.c Can't get ramdisk subimage node offset 21701372cce2SMarian Balakowicz 125 common/image.c Got ramdisk subimage node offset 21711372cce2SMarian Balakowicz -125 common/image.c Ramdisk subimage hash verification failed 21721372cce2SMarian Balakowicz 126 common/image.c Ramdisk subimage hash verification OK 21731372cce2SMarian Balakowicz -126 common/image.c Ramdisk subimage for unsupported architecture 21741372cce2SMarian Balakowicz 127 common/image.c Architecture check OK 21751372cce2SMarian Balakowicz -127 common/image.c Can't get ramdisk subimage data/size 21761372cce2SMarian Balakowicz 128 common/image.c Got ramdisk subimage data/size 21771372cce2SMarian Balakowicz 129 common/image.c Can't get ramdisk load address 21781372cce2SMarian Balakowicz -129 common/image.c Got ramdisk load address 21791372cce2SMarian Balakowicz 218011ccc33fSMarcel Ziswiler -130 common/cmd_doc.c Incorrect FIT image format 21811372cce2SMarian Balakowicz 131 common/cmd_doc.c FIT image format OK 21821372cce2SMarian Balakowicz 218311ccc33fSMarcel Ziswiler -140 common/cmd_ide.c Incorrect FIT image format 21841372cce2SMarian Balakowicz 141 common/cmd_ide.c FIT image format OK 21851372cce2SMarian Balakowicz 218611ccc33fSMarcel Ziswiler -150 common/cmd_nand.c Incorrect FIT image format 21871372cce2SMarian Balakowicz 151 common/cmd_nand.c FIT image format OK 21881372cce2SMarian Balakowicz 2189cccfc2abSDetlev Zundel- Automatic software updates via TFTP server 2190cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP 2191cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP_CNT_MAX 2192cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP_MSEC_MAX 2193cccfc2abSDetlev Zundel 2194cccfc2abSDetlev Zundel These options enable and control the auto-update feature; 2195cccfc2abSDetlev Zundel for a more detailed description refer to doc/README.update. 2196cccfc2abSDetlev Zundel 2197cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support) 2198cccfc2abSDetlev Zundel CONFIG_MTD_DEVICE 2199cccfc2abSDetlev Zundel 2200cccfc2abSDetlev Zundel Adds the MTD device infrastructure from the Linux kernel. 2201cccfc2abSDetlev Zundel Needed for mtdparts command support. 2202cccfc2abSDetlev Zundel 2203cccfc2abSDetlev Zundel CONFIG_MTD_PARTITIONS 2204cccfc2abSDetlev Zundel 2205cccfc2abSDetlev Zundel Adds the MTD partitioning infrastructure from the Linux 2206cccfc2abSDetlev Zundel kernel. Needed for UBI support. 2207cccfc2abSDetlev Zundel 22081372cce2SMarian Balakowicz 2209c609719bSwdenkModem Support: 2210c609719bSwdenk-------------- 2211c609719bSwdenk 221285ec0bccSwdenk[so far only for SMDK2400 and TRAB boards] 2213c609719bSwdenk 221411ccc33fSMarcel Ziswiler- Modem support enable: 2215c609719bSwdenk CONFIG_MODEM_SUPPORT 2216c609719bSwdenk 2217c609719bSwdenk- RTS/CTS Flow control enable: 2218c609719bSwdenk CONFIG_HWFLOW 2219c609719bSwdenk 2220c609719bSwdenk- Modem debug support: 2221c609719bSwdenk CONFIG_MODEM_SUPPORT_DEBUG 2222c609719bSwdenk 2223c609719bSwdenk Enables debugging stuff (char screen[1024], dbg()) 2224c609719bSwdenk for modem support. Useful only with BDI2000. 2225c609719bSwdenk 2226a8c7c708Swdenk- Interrupt support (PPC): 2227a8c7c708Swdenk 2228a8c7c708Swdenk There are common interrupt_init() and timer_interrupt() 2229a8c7c708Swdenk for all PPC archs. interrupt_init() calls interrupt_init_cpu() 223011ccc33fSMarcel Ziswiler for CPU specific initialization. interrupt_init_cpu() 2231a8c7c708Swdenk should set decrementer_count to appropriate value. If 223211ccc33fSMarcel Ziswiler CPU resets decrementer automatically after interrupt 2233a8c7c708Swdenk (ppc4xx) it should set decrementer_count to zero. 223411ccc33fSMarcel Ziswiler timer_interrupt() calls timer_interrupt_cpu() for CPU 2235a8c7c708Swdenk specific handling. If board has watchdog / status_led 2236a8c7c708Swdenk / other_activity_monitor it works automatically from 2237a8c7c708Swdenk general timer_interrupt(). 2238a8c7c708Swdenk 2239c609719bSwdenk- General: 2240c609719bSwdenk 2241c609719bSwdenk In the target system modem support is enabled when a 2242c609719bSwdenk specific key (key combination) is pressed during 2243c609719bSwdenk power-on. Otherwise U-Boot will boot normally 224411ccc33fSMarcel Ziswiler (autoboot). The key_pressed() function is called from 2245c609719bSwdenk board_init(). Currently key_pressed() is a dummy 2246c609719bSwdenk function, returning 1 and thus enabling modem 2247c609719bSwdenk initialization. 2248c609719bSwdenk 2249c609719bSwdenk If there are no modem init strings in the 2250c609719bSwdenk environment, U-Boot proceed to autoboot; the 2251c609719bSwdenk previous output (banner, info printfs) will be 225211ccc33fSMarcel Ziswiler suppressed, though. 2253c609719bSwdenk 2254c609719bSwdenk See also: doc/README.Modem 2255c609719bSwdenk 2256c609719bSwdenk 2257c609719bSwdenkConfiguration Settings: 2258c609719bSwdenk----------------------- 2259c609719bSwdenk 22606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included; 2261c609719bSwdenk undefine this when you're short of memory. 2262c609719bSwdenk 22632fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default 22642fb2604dSPeter Tyser width of the commands listed in the 'help' command output. 22652fb2604dSPeter Tyser 22666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to 2267c609719bSwdenk prompt for user input. 2268c609719bSwdenk 22696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE: Buffer size for input from the Console 2270c609719bSwdenk 22716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE: Buffer size for Console output 2272c609719bSwdenk 22736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands 2274c609719bSwdenk 22756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to 2276c609719bSwdenk the application (usually a Linux kernel) when it is 2277c609719bSwdenk booted 2278c609719bSwdenk 22796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE: 2280c609719bSwdenk List of legal baudrate settings for this board. 2281c609719bSwdenk 22826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET 2283c609719bSwdenk Suppress display of console information at boot. 2284c609719bSwdenk 22856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV 2286c609719bSwdenk If the board specific function 2287c609719bSwdenk extern int overwrite_console (void); 2288c609719bSwdenk returns 1, the stdin, stderr and stdout are switched to the 2289c609719bSwdenk serial port, else the settings in the environment are used. 2290c609719bSwdenk 22916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE 2292c609719bSwdenk Enable the call to overwrite_console(). 2293c609719bSwdenk 22946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE 2295c609719bSwdenk Enable overwrite of previous console environment settings. 2296c609719bSwdenk 22976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END: 2298c609719bSwdenk Begin and End addresses of the area used by the 2299c609719bSwdenk simple memory test. 2300c609719bSwdenk 23016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST: 2302c609719bSwdenk Enable an alternate, more extensive memory test. 2303c609719bSwdenk 23046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH: 23055f535fe1Swdenk Scratch address used by the alternate memory test 23065f535fe1Swdenk You only need to set this if address zero isn't writeable 23075f535fe1Swdenk 23086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only): 23096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header, 231014f73ca6SStefan Roese this specified memory area will get subtracted from the top 231111ccc33fSMarcel Ziswiler (end) of RAM and won't get "touched" at all by U-Boot. By 231214f73ca6SStefan Roese fixing up gd->ram_size the Linux kernel should gets passed 231314f73ca6SStefan Roese the now "corrected" memory size and won't touch it either. 231414f73ca6SStefan Roese This should work for arch/ppc and arch/powerpc. Only Linux 23155e12e75dSStefan Roese board ports in arch/powerpc with bootwrapper support that 231614f73ca6SStefan Roese recalculate the memory size from the SDRAM controller setup 23175e12e75dSStefan Roese will have to get fixed in Linux additionally. 231814f73ca6SStefan Roese 231914f73ca6SStefan Roese This option can be used as a workaround for the 440EPx/GRx 232014f73ca6SStefan Roese CHIP 11 errata where the last 256 bytes in SDRAM shouldn't 232114f73ca6SStefan Roese be touched. 232214f73ca6SStefan Roese 232314f73ca6SStefan Roese WARNING: Please make sure that this value is a multiple of 232414f73ca6SStefan Roese the Linux page size (normally 4k). If this is not the case, 232514f73ca6SStefan Roese then the end address of the Linux memory will be located at a 232614f73ca6SStefan Roese non page size aligned address and this could cause major 232714f73ca6SStefan Roese problems. 232814f73ca6SStefan Roese 23296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TFTP_LOADADDR: 2330c609719bSwdenk Default load address for network file downloads 2331c609719bSwdenk 23326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE: 2333c609719bSwdenk Enable temporary baudrate change while serial download 2334c609719bSwdenk 23356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE: 2336c609719bSwdenk Physical start address of SDRAM. _Must_ be 0 here. 2337c609719bSwdenk 23386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE: 2339c609719bSwdenk Physical start address of Motherboard I/O (if using a 2340c609719bSwdenk Cogent motherboard) 2341c609719bSwdenk 23426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE: 2343c609719bSwdenk Physical start address of Flash memory. 2344c609719bSwdenk 23456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE: 2346c609719bSwdenk Physical start address of boot monitor code (set by 2347c609719bSwdenk make config files to be same as the text base address 234814d0a02aSWolfgang Denk (CONFIG_SYS_TEXT_BASE) used when linking) - same as 23496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FLASH_BASE when booting from flash. 2350c609719bSwdenk 23516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN: 23523b57fe0aSwdenk Size of memory reserved for monitor code, used to 23533b57fe0aSwdenk determine _at_compile_time_ (!) if the environment is 23543b57fe0aSwdenk embedded within the U-Boot image, or in a separate 23553b57fe0aSwdenk flash sector. 2356c609719bSwdenk 23576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN: 2358c609719bSwdenk Size of DRAM reserved for malloc() use. 2359c609719bSwdenk 23606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN: 236115940c9aSStefan Roese Normally compressed uImages are limited to an 236215940c9aSStefan Roese uncompressed size of 8 MBytes. If this is not enough, 23636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD you can define CONFIG_SYS_BOOTM_LEN in your board config file 236415940c9aSStefan Roese to adjust this setting to your needs. 2365c609719bSwdenk 23666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ: 2367c609719bSwdenk Maximum size of memory mapped by the startup code of 2368c609719bSwdenk the Linux kernel; all data that must be processed by 23697d721e34SBartlomiej Sieka the Linux kernel (bd_info, boot arguments, FDT blob if 23707d721e34SBartlomiej Sieka used) must be put below this limit, unless "bootm_low" 23717d721e34SBartlomiej Sieka enviroment variable is defined and non-zero. In such case 23727d721e34SBartlomiej Sieka all data for the Linux kernel must be between "bootm_low" 2373c3624e6eSGrant Likely and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment 2374c3624e6eSGrant Likely variable "bootm_mapsize" will override the value of 2375c3624e6eSGrant Likely CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined, 2376c3624e6eSGrant Likely then the value in "bootm_size" will be used instead. 2377c609719bSwdenk 2378fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH: 2379fca43cc8SJohn Rigby Enable initrd_high functionality. If defined then the 2380fca43cc8SJohn Rigby initrd_high feature is enabled and the bootm ramdisk subcommand 2381fca43cc8SJohn Rigby is enabled. 2382fca43cc8SJohn Rigby 2383fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE: 2384fca43cc8SJohn Rigby Enables allocating and saving kernel cmdline in space between 2385fca43cc8SJohn Rigby "bootm_low" and "bootm_low" + BOOTMAPSZ. 2386fca43cc8SJohn Rigby 2387fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD: 2388fca43cc8SJohn Rigby Enables allocating and saving a kernel copy of the bd_info in 2389fca43cc8SJohn Rigby space between "bootm_low" and "bootm_low" + BOOTMAPSZ. 2390fca43cc8SJohn Rigby 23916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS: 2392c609719bSwdenk Max number of Flash memory banks 2393c609719bSwdenk 23946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT: 2395c609719bSwdenk Max number of sectors on a Flash chip 2396c609719bSwdenk 23976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT: 2398c609719bSwdenk Timeout for Flash erase operations (in ms) 2399c609719bSwdenk 24006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT: 2401c609719bSwdenk Timeout for Flash write operations (in ms) 2402c609719bSwdenk 24036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT 24048564acf9Swdenk Timeout for Flash set sector lock bit operation (in ms) 24058564acf9Swdenk 24066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT 24078564acf9Swdenk Timeout for Flash clear lock bits operation (in ms) 24088564acf9Swdenk 24096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION 24108564acf9Swdenk If defined, hardware flash sectors protection is used 24118564acf9Swdenk instead of U-Boot software protection. 24128564acf9Swdenk 24136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP: 2414c609719bSwdenk 2415c609719bSwdenk Enable TFTP transfers directly to flash memory; 2416c609719bSwdenk without this option such a download has to be 2417c609719bSwdenk performed in two steps: (1) download to RAM, and (2) 2418c609719bSwdenk copy from RAM to flash. 2419c609719bSwdenk 2420c609719bSwdenk The two-step approach is usually more reliable, since 2421c609719bSwdenk you can check if the download worked before you erase 242211ccc33fSMarcel Ziswiler the flash, but in some situations (when system RAM is 242311ccc33fSMarcel Ziswiler too limited to allow for a temporary copy of the 2424c609719bSwdenk downloaded image) this option may be very useful. 2425c609719bSwdenk 24266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI: 2427c609719bSwdenk Define if the flash driver uses extra elements in the 24285653fc33Swdenk common flash structure for storing flash geometry. 24295653fc33Swdenk 243000b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER 24315653fc33Swdenk This option also enables the building of the cfi_flash driver 24325653fc33Swdenk in the drivers directory 243353cf9435Sstroese 243491809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD 243591809ed5SPiotr Ziecik This option enables the building of the cfi_mtd driver 243691809ed5SPiotr Ziecik in the drivers directory. The driver exports CFI flash 243791809ed5SPiotr Ziecik to the MTD layer. 243891809ed5SPiotr Ziecik 24396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE 244096ef831fSGuennadi Liakhovetski Use buffered writes to flash. 244196ef831fSGuennadi Liakhovetski 244296ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N 244396ef831fSGuennadi Liakhovetski s29ws-n MirrorBit flash has non-standard addresses for buffered 244496ef831fSGuennadi Liakhovetski write commands. 244596ef831fSGuennadi Liakhovetski 24466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST 24475568e613SStefan Roese If this option is defined, the common CFI flash doesn't 24485568e613SStefan Roese print it's warning upon not recognized FLASH banks. This 24495568e613SStefan Roese is useful, if some of the configured banks are only 24505568e613SStefan Roese optionally available. 24515568e613SStefan Roese 24529a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS 24539a042e9cSJerry Van Baren If defined (must be an integer), print out countdown 24549a042e9cSJerry Van Baren digits and dots. Recommended value: 45 (9..1) for 80 24559a042e9cSJerry Van Baren column displays, 15 (3..1) for 40 column displays. 24569a042e9cSJerry Van Baren 24576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER: 245811ccc33fSMarcel Ziswiler Defines the number of Ethernet receive buffers. On some 245911ccc33fSMarcel Ziswiler Ethernet controllers it is recommended to set this value 246053cf9435Sstroese to 8 or even higher (EEPRO100 or 405 EMAC), since all 246153cf9435Sstroese buffers can be full shortly after enabling the interface 246211ccc33fSMarcel Ziswiler on high Ethernet traffic. 246353cf9435Sstroese Defaults to 4 if not defined. 2464c609719bSwdenk 2465ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES 2466ea882bafSWolfgang Denk 2467ea882bafSWolfgang Denk Maximum number of entries in the hash table that is used 2468ea882bafSWolfgang Denk internally to store the environment settings. The default 2469ea882bafSWolfgang Denk setting is supposed to be generous and should work in most 2470ea882bafSWolfgang Denk cases. This setting can be used to tune behaviour; see 2471ea882bafSWolfgang Denk lib/hashtable.c for details. 2472ea882bafSWolfgang Denk 2473c609719bSwdenkThe following definitions that deal with the placement and management 2474c609719bSwdenkof environment data (variable area); in general, we support the 2475c609719bSwdenkfollowing configurations: 2476c609719bSwdenk 24775a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH: 2478c609719bSwdenk 2479c609719bSwdenk Define this if the environment is in flash memory. 2480c609719bSwdenk 2481c609719bSwdenk a) The environment occupies one whole flash sector, which is 2482c609719bSwdenk "embedded" in the text segment with the U-Boot code. This 2483c609719bSwdenk happens usually with "bottom boot sector" or "top boot 2484c609719bSwdenk sector" type flash chips, which have several smaller 2485c609719bSwdenk sectors at the start or the end. For instance, such a 2486c609719bSwdenk layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In 2487c609719bSwdenk such a case you would place the environment in one of the 2488c609719bSwdenk 4 kB sectors - with U-Boot code before and after it. With 2489c609719bSwdenk "top boot sector" type flash chips, you would put the 2490c609719bSwdenk environment in one of the last sectors, leaving a gap 2491c609719bSwdenk between U-Boot and the environment. 2492c609719bSwdenk 24930e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 2494c609719bSwdenk 2495c609719bSwdenk Offset of environment data (variable area) to the 2496c609719bSwdenk beginning of flash memory; for instance, with bottom boot 2497c609719bSwdenk type flash chips the second sector can be used: the offset 2498c609719bSwdenk for this sector is given here. 2499c609719bSwdenk 25006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE. 2501c609719bSwdenk 25020e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 2503c609719bSwdenk 2504c609719bSwdenk This is just another way to specify the start address of 2505c609719bSwdenk the flash sector containing the environment (instead of 25060e8d1586SJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_OFFSET). 2507c609719bSwdenk 25080e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SECT_SIZE: 2509c609719bSwdenk 2510c609719bSwdenk Size of the sector containing the environment. 2511c609719bSwdenk 2512c609719bSwdenk 2513c609719bSwdenk b) Sometimes flash chips have few, equal sized, BIG sectors. 2514c609719bSwdenk In such a case you don't want to spend a whole sector for 2515c609719bSwdenk the environment. 2516c609719bSwdenk 25170e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 2518c609719bSwdenk 25195a1aceb0SJean-Christophe PLAGNIOL-VILLARD If you use this in combination with CONFIG_ENV_IS_IN_FLASH 25200e8d1586SJean-Christophe PLAGNIOL-VILLARD and CONFIG_ENV_SECT_SIZE, you can specify to use only a part 2521c609719bSwdenk of this flash sector for the environment. This saves 2522c609719bSwdenk memory for the RAM copy of the environment. 2523c609719bSwdenk 2524c609719bSwdenk It may also save flash memory if you decide to use this 2525c609719bSwdenk when your environment is "embedded" within U-Boot code, 2526c609719bSwdenk since then the remainder of the flash sector could be used 2527c609719bSwdenk for U-Boot code. It should be pointed out that this is 2528c609719bSwdenk STRONGLY DISCOURAGED from a robustness point of view: 2529c609719bSwdenk updating the environment in flash makes it always 2530c609719bSwdenk necessary to erase the WHOLE sector. If something goes 2531c609719bSwdenk wrong before the contents has been restored from a copy in 2532c609719bSwdenk RAM, your target system will be dead. 2533c609719bSwdenk 25340e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR_REDUND 25350e8d1586SJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_SIZE_REDUND 2536c609719bSwdenk 2537c609719bSwdenk These settings describe a second storage area used to hold 253811ccc33fSMarcel Ziswiler a redundant copy of the environment data, so that there is 25393e38691eSwdenk a valid backup copy in case there is a power failure during 2540c609719bSwdenk a "saveenv" operation. 2541c609719bSwdenk 2542c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the 2543c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds* 2544c609719bSwdenkaccordingly! 2545c609719bSwdenk 2546c609719bSwdenk 25479314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM: 2548c609719bSwdenk 2549c609719bSwdenk Define this if you have some non-volatile memory device 2550c609719bSwdenk (NVRAM, battery buffered SRAM) which you want to use for the 2551c609719bSwdenk environment. 2552c609719bSwdenk 25530e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 25540e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 2555c609719bSwdenk 255611ccc33fSMarcel Ziswiler These two #defines are used to determine the memory area you 2557c609719bSwdenk want to use for environment. It is assumed that this memory 2558c609719bSwdenk can just be read and written to, without any special 2559c609719bSwdenk provision. 2560c609719bSwdenk 2561c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early 2562c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the 256311ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or 2564c609719bSwdenkU-Boot will hang. 2565c609719bSwdenk 2566c609719bSwdenkPlease note that even with NVRAM we still use a copy of the 2567c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to 2568c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv" 2569c609719bSwdenkto save the current settings. 2570c609719bSwdenk 2571c609719bSwdenk 2572bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM: 2573c609719bSwdenk 2574c609719bSwdenk Use this if you have an EEPROM or similar serial access 2575c609719bSwdenk device and a driver for it. 2576c609719bSwdenk 25770e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 25780e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 2579c609719bSwdenk 2580c609719bSwdenk These two #defines specify the offset and size of the 2581c609719bSwdenk environment area within the total memory of your EEPROM. 2582c609719bSwdenk 25836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR: 2584c609719bSwdenk If defined, specified the chip address of the EEPROM device. 2585c609719bSwdenk The default address is zero. 2586c609719bSwdenk 25876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS: 2588c609719bSwdenk If defined, the number of bits used to address bytes in a 2589c609719bSwdenk single page in the EEPROM device. A 64 byte page, for example 2590c609719bSwdenk would require six bits. 2591c609719bSwdenk 25926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS: 2593c609719bSwdenk If defined, the number of milliseconds to delay between 2594c609719bSwdenk page writes. The default is zero milliseconds. 2595c609719bSwdenk 25966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR_LEN: 2597c609719bSwdenk The length in bytes of the EEPROM memory array address. Note 2598c609719bSwdenk that this is NOT the chip address length! 2599c609719bSwdenk 26006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW: 26015cf91d6bSwdenk EEPROM chips that implement "address overflow" are ones 26025cf91d6bSwdenk like Catalyst 24WC04/08/16 which has 9/10/11 bits of 26035cf91d6bSwdenk address and the extra bits end up in the "chip address" bit 26045cf91d6bSwdenk slots. This makes a 24WC08 (1Kbyte) chip look like four 256 26055cf91d6bSwdenk byte chips. 26065cf91d6bSwdenk 26075cf91d6bSwdenk Note that we consider the length of the address field to 26085cf91d6bSwdenk still be one byte because the extra address bits are hidden 26095cf91d6bSwdenk in the chip address. 26105cf91d6bSwdenk 26116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_SIZE: 2612c609719bSwdenk The size in bytes of the EEPROM device. 2613c609719bSwdenk 2614548738b4SHeiko Schocher - CONFIG_ENV_EEPROM_IS_ON_I2C 2615548738b4SHeiko Schocher define this, if you have I2C and SPI activated, and your 2616548738b4SHeiko Schocher EEPROM, which holds the environment, is on the I2C bus. 2617548738b4SHeiko Schocher 2618548738b4SHeiko Schocher - CONFIG_I2C_ENV_EEPROM_BUS 2619548738b4SHeiko Schocher if you have an Environment on an EEPROM reached over 2620548738b4SHeiko Schocher I2C muxes, you can define here, how to reach this 2621548738b4SHeiko Schocher EEPROM. For example: 2622548738b4SHeiko Schocher 2623548738b4SHeiko Schocher #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0" 2624548738b4SHeiko Schocher 2625548738b4SHeiko Schocher EEPROM which holds the environment, is reached over 2626548738b4SHeiko Schocher a pca9547 i2c mux with address 0x70, channel 3. 2627c609719bSwdenk 2628057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH: 26295779d8d9Swdenk 26305779d8d9Swdenk Define this if you have a DataFlash memory device which you 26315779d8d9Swdenk want to use for the environment. 26325779d8d9Swdenk 26330e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 26340e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 26350e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 26365779d8d9Swdenk 26375779d8d9Swdenk These three #defines specify the offset and size of the 26385779d8d9Swdenk environment area within the total memory of your DataFlash placed 26395779d8d9Swdenk at the specified address. 26405779d8d9Swdenk 264151bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND: 264213a5695bSwdenk 264313a5695bSwdenk Define this if you have a NAND device which you want to use 264413a5695bSwdenk for the environment. 264513a5695bSwdenk 26460e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 26470e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 264813a5695bSwdenk 264913a5695bSwdenk These two #defines specify the offset and size of the environment 2650fdd813deSScott Wood area within the first NAND device. CONFIG_ENV_OFFSET must be 2651fdd813deSScott Wood aligned to an erase block boundary. 26525779d8d9Swdenk 2653fdd813deSScott Wood - CONFIG_ENV_OFFSET_REDUND (optional): 2654e443c944SMarkus Klotzbuecher 26550e8d1586SJean-Christophe PLAGNIOL-VILLARD This setting describes a second storage area of CONFIG_ENV_SIZE 2656fdd813deSScott Wood size used to hold a redundant copy of the environment data, so 2657fdd813deSScott Wood that there is a valid backup copy in case there is a power failure 2658fdd813deSScott Wood during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be 2659fdd813deSScott Wood aligned to an erase block boundary. 2660e443c944SMarkus Klotzbuecher 2661fdd813deSScott Wood - CONFIG_ENV_RANGE (optional): 2662fdd813deSScott Wood 2663fdd813deSScott Wood Specifies the length of the region in which the environment 2664fdd813deSScott Wood can be written. This should be a multiple of the NAND device's 2665fdd813deSScott Wood block size. Specifying a range with more erase blocks than 2666fdd813deSScott Wood are needed to hold CONFIG_ENV_SIZE allows bad blocks within 2667fdd813deSScott Wood the range to be avoided. 2668fdd813deSScott Wood 2669fdd813deSScott Wood - CONFIG_ENV_OFFSET_OOB (optional): 2670fdd813deSScott Wood 2671fdd813deSScott Wood Enables support for dynamically retrieving the offset of the 2672fdd813deSScott Wood environment from block zero's out-of-band data. The 2673fdd813deSScott Wood "nand env.oob" command can be used to record this offset. 2674fdd813deSScott Wood Currently, CONFIG_ENV_OFFSET_REDUND is not supported when 2675fdd813deSScott Wood using CONFIG_ENV_OFFSET_OOB. 2676e443c944SMarkus Klotzbuecher 2677b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST 2678b74ab737SGuennadi Liakhovetski 2679b74ab737SGuennadi Liakhovetski Defines address in RAM to which the nand_spl code should copy the 2680b74ab737SGuennadi Liakhovetski environment. If redundant environment is used, it will be copied to 2681b74ab737SGuennadi Liakhovetski CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE. 2682b74ab737SGuennadi Liakhovetski 26836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET 2684c609719bSwdenk 2685c609719bSwdenk Defines offset to the initial SPI buffer area in DPRAM. The 2686c609719bSwdenk area is used at an early stage (ROM part) if the environment 2687c609719bSwdenk is configured to reside in the SPI EEPROM: We need a 520 byte 2688c609719bSwdenk scratch DPRAM area. It is used between the two initialization 2689c609719bSwdenk calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems 2690c609719bSwdenk to be a good choice since it makes it far enough from the 2691c609719bSwdenk start of the data area as well as from the stack pointer. 2692c609719bSwdenk 2693e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor 2694c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been 2695cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f() 2696c609719bSwdenkuntil then to read environment variables. 2697c609719bSwdenk 269885ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor 269985ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working 270085ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is 270185ec0bccSwdenknecessary, because the first environment variable we need is the 270285ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't 270385ec0bccSwdenkhave any device yet where we could complain.] 2704c609719bSwdenk 2705c609719bSwdenkNote: once the monitor has been relocated, then it will complain if 2706c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you 270785ec0bccSwdenkuse the "saveenv" command to store a valid environment. 2708c609719bSwdenk 27096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN: 2710fc3e2165Swdenk Echo the inverted Ethernet link state to the fault LED. 2711fc3e2165Swdenk 27126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR 2713fc3e2165Swdenk also needs to be defined. 2714fc3e2165Swdenk 27156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR: 2716fc3e2165Swdenk MII address of the PHY to check for the Ethernet link state. 2717c609719bSwdenk 2718f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS: 2719f5675aa5SRon Madrid Define this if you desire to only have use of the NS16550_init 2720f5675aa5SRon Madrid and NS16550_putc functions for the serial driver located at 2721f5675aa5SRon Madrid drivers/serial/ns16550.c. This option is useful for saving 2722f5675aa5SRon Madrid space for already greatly restricted images, including but not 2723f5675aa5SRon Madrid limited to NAND_SPL configurations. 2724f5675aa5SRon Madrid 2725c609719bSwdenkLow Level (hardware related) configuration options: 2726dc7c9a1aSwdenk--------------------------------------------------- 2727c609719bSwdenk 27286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE: 2729c609719bSwdenk Cache Line Size of the CPU. 2730c609719bSwdenk 27316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR: 2732c609719bSwdenk Default address of the IMMR after system reset. 27332535d602Swdenk 27342535d602Swdenk Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU, 27352535d602Swdenk and RPXsuper) to be able to adjust the position of 27362535d602Swdenk the IMMR register after a reset. 2737c609719bSwdenk 27387f6c2cbcSwdenk- Floppy Disk Support: 27396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FDC_DRIVE_NUMBER 27407f6c2cbcSwdenk 27417f6c2cbcSwdenk the default drive number (default value 0) 27427f6c2cbcSwdenk 27436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_ISA_IO_STRIDE 27447f6c2cbcSwdenk 274511ccc33fSMarcel Ziswiler defines the spacing between FDC chipset registers 27467f6c2cbcSwdenk (default value 1) 27477f6c2cbcSwdenk 27486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_ISA_IO_OFFSET 27497f6c2cbcSwdenk 27507f6c2cbcSwdenk defines the offset of register from address. It 27517f6c2cbcSwdenk depends on which part of the data bus is connected to 275211ccc33fSMarcel Ziswiler the FDC chipset. (default value 0) 27537f6c2cbcSwdenk 27546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and 27556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their 27567f6c2cbcSwdenk default value. 27577f6c2cbcSwdenk 27586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD if CONFIG_SYS_FDC_HW_INIT is defined, then the function 27597f6c2cbcSwdenk fdc_hw_init() is called at the beginning of the FDC 27607f6c2cbcSwdenk setup. fdc_hw_init() must be provided by the board 27617f6c2cbcSwdenk source code. It is used to make hardware dependant 27627f6c2cbcSwdenk initializations. 27637f6c2cbcSwdenk 27646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR: Physical address of the Internal Memory. 276525d6712aSwdenk DO NOT CHANGE unless you know exactly what you're 276625d6712aSwdenk doing! (11-4) [MPC8xx/82xx systems only] 2767c609719bSwdenk 27686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR: 2769c609719bSwdenk 27707152b1d0Swdenk Start address of memory area that can be used for 2771c609719bSwdenk initial data and stack; please note that this must be 2772c609719bSwdenk writable memory that is working WITHOUT special 2773c609719bSwdenk initialization, i. e. you CANNOT use normal RAM which 2774c609719bSwdenk will become available only after programming the 2775c609719bSwdenk memory controller and running certain initialization 2776c609719bSwdenk sequences. 2777c609719bSwdenk 2778c609719bSwdenk U-Boot uses the following memory types: 2779c609719bSwdenk - MPC8xx and MPC8260: IMMR (internal memory of the CPU) 2780c609719bSwdenk - MPC824X: data cache 2781c609719bSwdenk - PPC4xx: data cache 2782c609719bSwdenk 27836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET: 2784c609719bSwdenk 2785c609719bSwdenk Offset of the initial data structure in the memory 27866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually 27876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial 2788c609719bSwdenk data is located at the end of the available space 2789553f0982SWolfgang Denk (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE - 27906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just 27916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR + 27926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_GBL_DATA_OFFSET) downward. 2793c609719bSwdenk 2794c609719bSwdenk Note: 2795c609719bSwdenk On the MPC824X (or other systems that use the data 2796c609719bSwdenk cache for initial memory) the address chosen for 27976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must 2798c609719bSwdenk point to an otherwise UNUSED address space between 2799c609719bSwdenk the top of RAM and the start of the PCI space. 2800c609719bSwdenk 28016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6) 2802c609719bSwdenk 28036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR: System Protection Control (11-9) 2804c609719bSwdenk 28056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26) 2806c609719bSwdenk 28076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31) 2808c609719bSwdenk 28096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30) 2810c609719bSwdenk 28116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27) 2812c609719bSwdenk 28136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM: 2814c609719bSwdenk SDRAM timing 2815c609719bSwdenk 28166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA: 2817c609719bSwdenk periodic timer for refresh 2818c609719bSwdenk 28196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER: Debug Event Register (37-47) 2820c609719bSwdenk 28216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM, 28226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP, 28236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM, 28246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BR1_PRELIM: 2825c609719bSwdenk Memory Controller Definitions: BR0/1 and OR0/1 (FLASH) 2826c609719bSwdenk 2827c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE, 28286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM, 28296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM: 2830c609719bSwdenk Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM) 2831c609719bSwdenk 28326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K, 28336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL: 2834c609719bSwdenk Machine Mode Register and Memory Periodic Timer 2835c609719bSwdenk Prescaler definitions (SDRAM timing) 2836c609719bSwdenk 28376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]: 2838c609719bSwdenk enable I2C microcode relocation patch (MPC8xx); 2839c609719bSwdenk define relocation offset in DPRAM [DSP2] 2840c609719bSwdenk 28416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]: 2842b423d055SHeiko Schocher enable SMC microcode relocation patch (MPC8xx); 2843b423d055SHeiko Schocher define relocation offset in DPRAM [SMC1] 2844b423d055SHeiko Schocher 28456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]: 2846c609719bSwdenk enable SPI microcode relocation patch (MPC8xx); 2847c609719bSwdenk define relocation offset in DPRAM [SCC4] 2848c609719bSwdenk 28496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK: 2850c609719bSwdenk Use OSCM clock mode on MBX8xx board. Be careful, 2851c609719bSwdenk wrong setting might damage your board. Read 2852c609719bSwdenk doc/README.MBX before setting this variable! 2853c609719bSwdenk 28546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only) 2855ea909b76Swdenk Offset of the bootmode word in DPRAM used by post 2856ea909b76Swdenk (Power On Self Tests). This definition overrides 2857ea909b76Swdenk #define'd default value in commproc.h resp. 2858ea909b76Swdenk cpm_8260.h. 2859ea909b76Swdenk 28606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB, 28616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL, 28626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS, 28636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB, 28646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START, 28656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL, 28666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE, 28676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only) 2868a47a12beSStefan Roese Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set. 28695d232d0eSwdenk 28709cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE: 28719cacf4fcSDirk Eibach Disable PCI-Express on systems where it is supported but not 28729cacf4fcSDirk Eibach required. 28739cacf4fcSDirk Eibach 2874a09b9b68SKumar Gala- CONFIG_SYS_SRIO: 2875a09b9b68SKumar Gala Chip has SRIO or not 2876a09b9b68SKumar Gala 2877a09b9b68SKumar Gala- CONFIG_SRIO1: 2878a09b9b68SKumar Gala Board has SRIO 1 port available 2879a09b9b68SKumar Gala 2880a09b9b68SKumar Gala- CONFIG_SRIO2: 2881a09b9b68SKumar Gala Board has SRIO 2 port available 2882a09b9b68SKumar Gala 2883a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT: 2884a09b9b68SKumar Gala Virtual Address of SRIO port 'n' memory region 2885a09b9b68SKumar Gala 2886a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS: 2887a09b9b68SKumar Gala Physical Address of SRIO port 'n' memory region 2888a09b9b68SKumar Gala 2889a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE: 2890a09b9b68SKumar Gala Size of SRIO port 'n' memory region 2891a09b9b68SKumar Gala 2892bb99ad6dSBen Warren- CONFIG_SPD_EEPROM 2893218ca724SWolfgang Denk Get DDR timing information from an I2C EEPROM. Common 2894218ca724SWolfgang Denk with pluggable memory modules such as SODIMMs 2895218ca724SWolfgang Denk 2896bb99ad6dSBen Warren SPD_EEPROM_ADDRESS 2897bb99ad6dSBen Warren I2C address of the SPD EEPROM 2898bb99ad6dSBen Warren 28996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM 2900218ca724SWolfgang Denk If SPD EEPROM is on an I2C bus other than the first 2901218ca724SWolfgang Denk one, specify here. Note that the value must resolve 2902218ca724SWolfgang Denk to something your driver can deal with. 2903bb99ad6dSBen Warren 29046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0 2905218ca724SWolfgang Denk Only for 83xx systems. If specified, then DDR should 2906218ca724SWolfgang Denk be configured using CS0 and CS1 instead of CS2 and CS3. 29072ad6b513STimur Tabi 2908c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12] 2909c26e454dSwdenk Define to enable FEC[12] on a 8xx series processor. 2910c26e454dSwdenk 2911c26e454dSwdenk- CONFIG_FEC[12]_PHY 2912c26e454dSwdenk Define to the hardcoded PHY address which corresponds 29136e592385Swdenk to the given FEC; i. e. 2914c26e454dSwdenk #define CONFIG_FEC1_PHY 4 2915c26e454dSwdenk means that the PHY with address 4 is connected to FEC1 2916c26e454dSwdenk 2917c26e454dSwdenk When set to -1, means to probe for first available. 2918c26e454dSwdenk 2919c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR 2920c26e454dSwdenk The PHY does not have a RXERR line (RMII only). 2921c26e454dSwdenk (so program the FEC to ignore it). 2922c26e454dSwdenk 2923c26e454dSwdenk- CONFIG_RMII 2924c26e454dSwdenk Enable RMII mode for all FECs. 2925c26e454dSwdenk Note that this is a global option, we can't 2926c26e454dSwdenk have one FEC in standard MII mode and another in RMII mode. 2927c26e454dSwdenk 29285cf91d6bSwdenk- CONFIG_CRC32_VERIFY 29295cf91d6bSwdenk Add a verify option to the crc32 command. 29305cf91d6bSwdenk The syntax is: 29315cf91d6bSwdenk 29325cf91d6bSwdenk => crc32 -v <address> <count> <crc32> 29335cf91d6bSwdenk 29345cf91d6bSwdenk Where address/count indicate a memory area 29355cf91d6bSwdenk and crc32 is the correct crc32 which the 29365cf91d6bSwdenk area should have. 29375cf91d6bSwdenk 293856523f12Swdenk- CONFIG_LOOPW 293956523f12Swdenk Add the "loopw" memory command. This only takes effect if 2940602ad3b3SJon Loeliger the memory commands are activated globally (CONFIG_CMD_MEM). 294156523f12Swdenk 29427b466641Sstroese- CONFIG_MX_CYCLIC 29437b466641Sstroese Add the "mdc" and "mwc" memory commands. These are cyclic 29447b466641Sstroese "md/mw" commands. 29457b466641Sstroese Examples: 29467b466641Sstroese 29477b466641Sstroese => mdc.b 10 4 500 29487b466641Sstroese This command will print 4 bytes (10,11,12,13) each 500 ms. 29497b466641Sstroese 29507b466641Sstroese => mwc.l 100 12345678 10 29517b466641Sstroese This command will write 12345678 to address 100 all 10 ms. 29527b466641Sstroese 29537b466641Sstroese This only takes effect if the memory commands are activated 2954602ad3b3SJon Loeliger globally (CONFIG_CMD_MEM). 29557b466641Sstroese 29568aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT 2957e03f3169SWolfgang Denk [ARM only] If this variable is defined, then certain 2958e03f3169SWolfgang Denk low level initializations (like setting up the memory 2959e03f3169SWolfgang Denk controller) are omitted and/or U-Boot does not 2960e03f3169SWolfgang Denk relocate itself into RAM. 29618aa1a2d1Swdenk 2962e03f3169SWolfgang Denk Normally this variable MUST NOT be defined. The only 2963e03f3169SWolfgang Denk exception is when U-Boot is loaded (to RAM) by some 2964e03f3169SWolfgang Denk other boot loader or by a debugger which performs 2965e03f3169SWolfgang Denk these initializations itself. 29668aa1a2d1Swdenk 2967df81238bSMagnus Lilja- CONFIG_PRELOADER 2968df81238bSMagnus Lilja Modifies the behaviour of start.S when compiling a loader 2969df81238bSMagnus Lilja that is executed before the actual U-Boot. E.g. when 2970df81238bSMagnus Lilja compiling a NAND SPL. 2971400558b5Swdenk 2972d8834a13SMatthias Weisser- CONFIG_USE_ARCH_MEMCPY 2973d8834a13SMatthias Weisser CONFIG_USE_ARCH_MEMSET 2974d8834a13SMatthias Weisser If these options are used a optimized version of memcpy/memset will 2975d8834a13SMatthias Weisser be used if available. These functions may be faster under some 2976d8834a13SMatthias Weisser conditions but may increase the binary size. 2977d8834a13SMatthias Weisser 2978c609719bSwdenkBuilding the Software: 2979c609719bSwdenk====================== 2980c609719bSwdenk 2981218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments 2982218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support 2983218ca724SWolfgang Denkall possibly existing versions of cross development tools in all 2984218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we 2985218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK) 2986218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot. 2987c609719bSwdenk 2988218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you 2989218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case, 2990218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell. 2991218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are 2992218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter: 2993c609719bSwdenk 2994218ca724SWolfgang Denk $ CROSS_COMPILE=ppc_4xx- 2995218ca724SWolfgang Denk $ export CROSS_COMPILE 2996c609719bSwdenk 29972f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in 29982f8d396bSPeter Tyser the tools directory you can use the MinGW toolchain 29992f8d396bSPeter Tyser (http://www.mingw.org). Set your HOST tools to the MinGW 30002f8d396bSPeter Tyser toolchain and execute 'make tools'. For example: 30012f8d396bSPeter Tyser 30022f8d396bSPeter Tyser $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools 30032f8d396bSPeter Tyser 30042f8d396bSPeter Tyser Binaries such as tools/mkimage.exe will be created which can 30052f8d396bSPeter Tyser be executed on computers running Windows. 30062f8d396bSPeter Tyser 3007c609719bSwdenkU-Boot is intended to be simple to build. After installing the 3008c609719bSwdenksources you must configure U-Boot for one specific board type. This 3009c609719bSwdenkis done by typing: 3010c609719bSwdenk 3011c609719bSwdenk make NAME_config 3012c609719bSwdenk 3013218ca724SWolfgang Denkwhere "NAME_config" is the name of one of the existing configu- 3014218ca724SWolfgang Denkrations; see the main Makefile for supported names. 301554387ac9Swdenk 3016c609719bSwdenkNote: for some board special configuration names may exist; check if 3017c609719bSwdenk additional information is available from the board vendor; for 30182729af9dSwdenk instance, the TQM823L systems are available without (standard) 30192729af9dSwdenk or with LCD support. You can select such additional "features" 302011ccc33fSMarcel Ziswiler when choosing the configuration, i. e. 3021c609719bSwdenk 30222729af9dSwdenk make TQM823L_config 30232729af9dSwdenk - will configure for a plain TQM823L, i. e. no LCD support 3024c609719bSwdenk 3025c609719bSwdenk make TQM823L_LCD_config 3026c609719bSwdenk - will configure for a TQM823L with U-Boot console on LCD 3027c609719bSwdenk 3028c609719bSwdenk etc. 3029c609719bSwdenk 3030c609719bSwdenk 3031c609719bSwdenkFinally, type "make all", and you should get some working U-Boot 30327152b1d0Swdenkimages ready for download to / installation on your system: 3033c609719bSwdenk 3034c609719bSwdenk- "u-boot.bin" is a raw binary image 3035c609719bSwdenk- "u-boot" is an image in ELF binary format 3036c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format 3037c609719bSwdenk 3038baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved 3039baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change 3040baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory: 3041baf31249SMarian Balakowicz 3042baf31249SMarian Balakowicz1. Add O= to the make command line invocations: 3043baf31249SMarian Balakowicz 3044baf31249SMarian Balakowicz make O=/tmp/build distclean 3045baf31249SMarian Balakowicz make O=/tmp/build NAME_config 3046baf31249SMarian Balakowicz make O=/tmp/build all 3047baf31249SMarian Balakowicz 3048baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location: 3049baf31249SMarian Balakowicz 3050baf31249SMarian Balakowicz export BUILD_DIR=/tmp/build 3051baf31249SMarian Balakowicz make distclean 3052baf31249SMarian Balakowicz make NAME_config 3053baf31249SMarian Balakowicz make all 3054baf31249SMarian Balakowicz 3055baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment 3056baf31249SMarian Balakowiczvariable. 3057baf31249SMarian Balakowicz 3058c609719bSwdenk 3059c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so 3060c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of 3061c609719bSwdenknative "make". 3062c609719bSwdenk 3063c609719bSwdenk 3064c609719bSwdenkIf the system board that you have is not listed, then you will need 3065c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these 3066c609719bSwdenksteps: 3067c609719bSwdenk 3068c609719bSwdenk1. Add a new configuration option for your board to the toplevel 306985ec0bccSwdenk "Makefile" and to the "MAKEALL" script, using the existing 307085ec0bccSwdenk entries as examples. Note that here and at many other places 30717152b1d0Swdenk boards and other names are listed in alphabetical sort order. Please 307285ec0bccSwdenk keep this order. 3073c609719bSwdenk2. Create a new directory to hold your board specific code. Add any 307485ec0bccSwdenk files you need. In your board directory, you will need at least 307585ec0bccSwdenk the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds". 307685ec0bccSwdenk3. Create a new configuration file "include/configs/<board>.h" for 307785ec0bccSwdenk your board 3078c609719bSwdenk3. If you're porting U-Boot to a new CPU, then also create a new 3079c609719bSwdenk directory to hold your CPU specific code. Add any files you need. 308085ec0bccSwdenk4. Run "make <board>_config" with your new name. 3081c609719bSwdenk5. Type "make", and you should get a working "u-boot.srec" file 3082c609719bSwdenk to be installed on your target system. 308385ec0bccSwdenk6. Debug and solve any problems that might arise. 3084c609719bSwdenk [Of course, this last step is much harder than it sounds.] 3085c609719bSwdenk 3086c609719bSwdenk 3087c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.: 3088c609719bSwdenk============================================================== 3089c609719bSwdenk 3090c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board 3091c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to 3092c609719bSwdenkprovide feedback to the other developers. The feedback normally takes 3093c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest 3094218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources. 3095c609719bSwdenk 3096c609719bSwdenkBut before you submit such a patch, please verify that your modifi- 3097c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of 3098c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so, 3099c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot 3100c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can 31017152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE' 3102218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools 3103218ca724SWolfgang Denkyou can type 3104c609719bSwdenk 3105c609719bSwdenk CROSS_COMPILE=ppc_8xx- MAKEALL 3106c609719bSwdenk 3107c609719bSwdenkor to build on a native PowerPC system you can type 3108c609719bSwdenk 3109c609719bSwdenk CROSS_COMPILE=' ' MAKEALL 3110c609719bSwdenk 3111218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build 3112218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by 3113218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target 3114218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and 3115218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default 3116218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment 3117218ca724SWolfgang Denkvariable. For example: 3118baf31249SMarian Balakowicz 3119baf31249SMarian Balakowicz export BUILD_DIR=/tmp/build 3120baf31249SMarian Balakowicz export MAKEALL_LOGDIR=/tmp/log 3121baf31249SMarian Balakowicz CROSS_COMPILE=ppc_8xx- MAKEALL 3122baf31249SMarian Balakowicz 3123218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build, 3124218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean 3125218ca724SWolfgang Denkduring the whole build process. 3126baf31249SMarian Balakowicz 3127baf31249SMarian Balakowicz 3128c609719bSwdenkSee also "U-Boot Porting Guide" below. 3129c609719bSwdenk 3130c609719bSwdenk 3131c609719bSwdenkMonitor Commands - Overview: 3132c609719bSwdenk============================ 3133c609719bSwdenk 3134c609719bSwdenkgo - start application at address 'addr' 3135c609719bSwdenkrun - run commands in an environment variable 3136c609719bSwdenkbootm - boot application image from memory 3137c609719bSwdenkbootp - boot image via network using BootP/TFTP protocol 3138c609719bSwdenktftpboot- boot image via network using TFTP protocol 3139c609719bSwdenk and env variables "ipaddr" and "serverip" 3140c609719bSwdenk (and eventually "gatewayip") 3141c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol 3142c609719bSwdenkdiskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd' 3143c609719bSwdenkloads - load S-Record file over serial line 3144c609719bSwdenkloadb - load binary file over serial line (kermit mode) 3145c609719bSwdenkmd - memory display 3146c609719bSwdenkmm - memory modify (auto-incrementing) 3147c609719bSwdenknm - memory modify (constant address) 3148c609719bSwdenkmw - memory write (fill) 3149c609719bSwdenkcp - memory copy 3150c609719bSwdenkcmp - memory compare 3151c609719bSwdenkcrc32 - checksum calculation 31520f89c54bSPeter Tyseri2c - I2C sub-system 3153c609719bSwdenksspi - SPI utility commands 3154c609719bSwdenkbase - print or set address offset 3155c609719bSwdenkprintenv- print environment variables 3156c609719bSwdenksetenv - set environment variables 3157c609719bSwdenksaveenv - save environment variables to persistent storage 3158c609719bSwdenkprotect - enable or disable FLASH write protection 3159c609719bSwdenkerase - erase FLASH memory 3160c609719bSwdenkflinfo - print FLASH memory information 3161c609719bSwdenkbdinfo - print Board Info structure 3162c609719bSwdenkiminfo - print header information for application image 3163c609719bSwdenkconinfo - print console devices and informations 3164c609719bSwdenkide - IDE sub-system 3165c609719bSwdenkloop - infinite loop on address range 316656523f12Swdenkloopw - infinite write loop on address range 3167c609719bSwdenkmtest - simple RAM test 3168c609719bSwdenkicache - enable or disable instruction cache 3169c609719bSwdenkdcache - enable or disable data cache 3170c609719bSwdenkreset - Perform RESET of the CPU 3171c609719bSwdenkecho - echo args to console 3172c609719bSwdenkversion - print monitor version 3173c609719bSwdenkhelp - print online help 3174c609719bSwdenk? - alias for 'help' 3175c609719bSwdenk 3176c609719bSwdenk 3177c609719bSwdenkMonitor Commands - Detailed Description: 3178c609719bSwdenk======================================== 3179c609719bSwdenk 3180c609719bSwdenkTODO. 3181c609719bSwdenk 3182c609719bSwdenkFor now: just type "help <command>". 3183c609719bSwdenk 3184c609719bSwdenk 3185c609719bSwdenkEnvironment Variables: 3186c609719bSwdenk====================== 3187c609719bSwdenk 3188c609719bSwdenkU-Boot supports user configuration using Environment Variables which 3189c609719bSwdenkcan be made persistent by saving to Flash memory. 3190c609719bSwdenk 3191c609719bSwdenkEnvironment Variables are set using "setenv", printed using 3192c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv" 3193c609719bSwdenkwithout a value can be used to delete a variable from the 3194c609719bSwdenkenvironment. As long as you don't save the environment you are 3195c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the 3196c609719bSwdenkenvironment is erased by accident, a default environment is provided. 3197c609719bSwdenk 3198c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables. 3199c96f86eeSWolfgang Denk 3200c96f86eeSWolfgang DenkList of environment variables (most likely not complete): 3201c609719bSwdenk 3202c609719bSwdenk baudrate - see CONFIG_BAUDRATE 3203c609719bSwdenk 3204c609719bSwdenk bootdelay - see CONFIG_BOOTDELAY 3205c609719bSwdenk 3206c609719bSwdenk bootcmd - see CONFIG_BOOTCOMMAND 3207c609719bSwdenk 3208c609719bSwdenk bootargs - Boot arguments when booting an RTOS image 3209c609719bSwdenk 3210c609719bSwdenk bootfile - Name of the image to load with TFTP 3211c609719bSwdenk 32127d721e34SBartlomiej Sieka bootm_low - Memory range available for image processing in the bootm 32137d721e34SBartlomiej Sieka command can be restricted. This variable is given as 32147d721e34SBartlomiej Sieka a hexadecimal number and defines lowest address allowed 32157d721e34SBartlomiej Sieka for use by the bootm command. See also "bootm_size" 32167d721e34SBartlomiej Sieka environment variable. Address defined by "bootm_low" is 32177d721e34SBartlomiej Sieka also the base of the initial memory mapping for the Linux 3218c3624e6eSGrant Likely kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and 3219c3624e6eSGrant Likely bootm_mapsize. 3220c3624e6eSGrant Likely 3221c3624e6eSGrant Likely bootm_mapsize - Size of the initial memory mapping for the Linux kernel. 3222c3624e6eSGrant Likely This variable is given as a hexadecimal number and it 3223c3624e6eSGrant Likely defines the size of the memory region starting at base 3224c3624e6eSGrant Likely address bootm_low that is accessible by the Linux kernel 3225c3624e6eSGrant Likely during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used 3226c3624e6eSGrant Likely as the default value if it is defined, and bootm_size is 3227c3624e6eSGrant Likely used otherwise. 32287d721e34SBartlomiej Sieka 32297d721e34SBartlomiej Sieka bootm_size - Memory range available for image processing in the bootm 32307d721e34SBartlomiej Sieka command can be restricted. This variable is given as 32317d721e34SBartlomiej Sieka a hexadecimal number and defines the size of the region 32327d721e34SBartlomiej Sieka allowed for use by the bootm command. See also "bootm_low" 32337d721e34SBartlomiej Sieka environment variable. 32347d721e34SBartlomiej Sieka 32354bae9090SBartlomiej Sieka updatefile - Location of the software update file on a TFTP server, used 32364bae9090SBartlomiej Sieka by the automatic software update feature. Please refer to 32374bae9090SBartlomiej Sieka documentation in doc/README.update for more details. 32384bae9090SBartlomiej Sieka 3239c609719bSwdenk autoload - if set to "no" (any string beginning with 'n'), 3240c609719bSwdenk "bootp" will just load perform a lookup of the 3241c609719bSwdenk configuration from the BOOTP server, but not try to 3242c609719bSwdenk load any image using TFTP 3243c609719bSwdenk 3244c609719bSwdenk autostart - if set to "yes", an image loaded using the "bootp", 3245c609719bSwdenk "rarpboot", "tftpboot" or "diskboot" commands will 3246c609719bSwdenk be automatically started (by internally calling 3247c609719bSwdenk "bootm") 3248c609719bSwdenk 32494a6fd34bSwdenk If set to "no", a standalone image passed to the 32504a6fd34bSwdenk "bootm" command will be copied to the load address 32514a6fd34bSwdenk (and eventually uncompressed), but NOT be started. 32524a6fd34bSwdenk This can be used to load and uncompress arbitrary 32534a6fd34bSwdenk data. 32544a6fd34bSwdenk 325517ea1177Swdenk i2cfast - (PPC405GP|PPC405EP only) 325617ea1177Swdenk if set to 'y' configures Linux I2C driver for fast 325717ea1177Swdenk mode (400kHZ). This environment variable is used in 325817ea1177Swdenk initialization code. So, for changes to be effective 325917ea1177Swdenk it must be saved and board must be reset. 326017ea1177Swdenk 3261c609719bSwdenk initrd_high - restrict positioning of initrd images: 3262c609719bSwdenk If this variable is not set, initrd images will be 3263c609719bSwdenk copied to the highest possible address in RAM; this 3264c609719bSwdenk is usually what you want since it allows for 3265c609719bSwdenk maximum initrd size. If for some reason you want to 3266c609719bSwdenk make sure that the initrd image is loaded below the 32676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BOOTMAPSZ limit, you can set this environment 3268c609719bSwdenk variable to a value of "no" or "off" or "0". 3269c609719bSwdenk Alternatively, you can set it to a maximum upper 3270c609719bSwdenk address to use (U-Boot will still check that it 3271c609719bSwdenk does not overwrite the U-Boot stack and data). 3272c609719bSwdenk 3273c609719bSwdenk For instance, when you have a system with 16 MB 32747152b1d0Swdenk RAM, and want to reserve 4 MB from use by Linux, 3275c609719bSwdenk you can do this by adding "mem=12M" to the value of 3276c609719bSwdenk the "bootargs" variable. However, now you must make 32777152b1d0Swdenk sure that the initrd image is placed in the first 3278c609719bSwdenk 12 MB as well - this can be done with 3279c609719bSwdenk 3280c609719bSwdenk setenv initrd_high 00c00000 3281c609719bSwdenk 328238b99261Swdenk If you set initrd_high to 0xFFFFFFFF, this is an 328338b99261Swdenk indication to U-Boot that all addresses are legal 328438b99261Swdenk for the Linux kernel, including addresses in flash 328538b99261Swdenk memory. In this case U-Boot will NOT COPY the 328638b99261Swdenk ramdisk at all. This may be useful to reduce the 328738b99261Swdenk boot time on your system, but requires that this 328838b99261Swdenk feature is supported by your Linux kernel. 328938b99261Swdenk 3290c609719bSwdenk ipaddr - IP address; needed for tftpboot command 3291c609719bSwdenk 3292c609719bSwdenk loadaddr - Default load address for commands like "bootp", 3293dc7c9a1aSwdenk "rarpboot", "tftpboot", "loadb" or "diskboot" 3294c609719bSwdenk 3295c609719bSwdenk loads_echo - see CONFIG_LOADS_ECHO 3296c609719bSwdenk 3297c609719bSwdenk serverip - TFTP server IP address; needed for tftpboot command 3298c609719bSwdenk 3299c609719bSwdenk bootretry - see CONFIG_BOOT_RETRY_TIME 3300c609719bSwdenk 3301c609719bSwdenk bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR 3302c609719bSwdenk 3303c609719bSwdenk bootstopkey - see CONFIG_AUTOBOOT_STOP_STR 3304c609719bSwdenk 3305a3d991bdSwdenk ethprime - When CONFIG_NET_MULTI is enabled controls which 3306a3d991bdSwdenk interface is used first. 3307a3d991bdSwdenk 3308a3d991bdSwdenk ethact - When CONFIG_NET_MULTI is enabled controls which 3309a3d991bdSwdenk interface is currently active. For example you 3310a3d991bdSwdenk can do the following 3311a3d991bdSwdenk 331248690d80SHeiko Schocher => setenv ethact FEC 331348690d80SHeiko Schocher => ping 192.168.0.1 # traffic sent on FEC 331448690d80SHeiko Schocher => setenv ethact SCC 331548690d80SHeiko Schocher => ping 10.0.0.1 # traffic sent on SCC 3316a3d991bdSwdenk 3317e1692577SMatthias Fuchs ethrotate - When set to "no" U-Boot does not go through all 3318e1692577SMatthias Fuchs available network interfaces. 3319e1692577SMatthias Fuchs It just stays at the currently selected interface. 3320e1692577SMatthias Fuchs 3321a3d991bdSwdenk netretry - When set to "no" each network operation will 3322a3d991bdSwdenk either succeed or fail without retrying. 33236e592385Swdenk When set to "once" the network operation will 33246e592385Swdenk fail when all the available network interfaces 33256e592385Swdenk are tried once without success. 3326a3d991bdSwdenk Useful on scripts which control the retry operation 3327a3d991bdSwdenk themselves. 3328a3d991bdSwdenk 3329b4e2f89dSJean-Christophe PLAGNIOL-VILLARD npe_ucode - set load address for the NPE microcode 3330a1cf027aSJean-Christophe PLAGNIOL-VILLARD 333128cb9375SWolfgang Denk tftpsrcport - If this is set, the value is used for TFTP's 3332ecb0ccd9SWolfgang Denk UDP source port. 3333ecb0ccd9SWolfgang Denk 333428cb9375SWolfgang Denk tftpdstport - If this is set, the value is used for TFTP's UDP 333528cb9375SWolfgang Denk destination port instead of the Well Know Port 69. 333628cb9375SWolfgang Denk 3337c96f86eeSWolfgang Denk tftpblocksize - Block size to use for TFTP transfers; if not set, 3338c96f86eeSWolfgang Denk we use the TFTP server's default block size 3339c96f86eeSWolfgang Denk 3340c96f86eeSWolfgang Denk tftptimeout - Retransmission timeout for TFTP packets (in milli- 3341c96f86eeSWolfgang Denk seconds, minimum value is 1000 = 1 second). Defines 3342c96f86eeSWolfgang Denk when a packet is considered to be lost so it has to 3343c96f86eeSWolfgang Denk be retransmitted. The default is 5000 = 5 seconds. 3344c96f86eeSWolfgang Denk Lowering this value may make downloads succeed 3345c96f86eeSWolfgang Denk faster in networks with high packet loss rates or 3346c96f86eeSWolfgang Denk with unreliable TFTP servers. 3347c96f86eeSWolfgang Denk 3348a3d991bdSwdenk vlan - When set to a value < 4095 the traffic over 334911ccc33fSMarcel Ziswiler Ethernet is encapsulated/received over 802.1q 3350a3d991bdSwdenk VLAN tagged frames. 3351c609719bSwdenk 3352c609719bSwdenkThe following environment variables may be used and automatically 3353c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"), 3354c609719bSwdenkdepending the information provided by your boot server: 3355c609719bSwdenk 3356c609719bSwdenk bootfile - see above 3357c609719bSwdenk dnsip - IP address of your Domain Name Server 3358fe389a82Sstroese dnsip2 - IP address of your secondary Domain Name Server 3359c609719bSwdenk gatewayip - IP address of the Gateway (Router) to use 3360c609719bSwdenk hostname - Target hostname 3361c609719bSwdenk ipaddr - see above 3362c609719bSwdenk netmask - Subnet Mask 3363c609719bSwdenk rootpath - Pathname of the root filesystem on the NFS server 3364c609719bSwdenk serverip - see above 3365c609719bSwdenk 3366c609719bSwdenk 3367c609719bSwdenkThere are two special Environment Variables: 3368c609719bSwdenk 3369c609719bSwdenk serial# - contains hardware identification information such 3370c609719bSwdenk as type string and/or serial number 3371c609719bSwdenk ethaddr - Ethernet address 3372c609719bSwdenk 3373c609719bSwdenkThese variables can be set only once (usually during manufacturing of 3374c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables 3375c609719bSwdenkonce they have been set once. 3376c609719bSwdenk 3377c609719bSwdenk 3378c1551ea8SstroeseFurther special Environment Variables: 3379c1551ea8Sstroese 3380c1551ea8Sstroese ver - Contains the U-Boot version string as printed 3381c1551ea8Sstroese with the "version" command. This variable is 3382c1551ea8Sstroese readonly (see CONFIG_VERSION_VARIABLE). 3383c1551ea8Sstroese 3384c1551ea8Sstroese 3385c609719bSwdenkPlease note that changes to some configuration parameters may take 3386c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-). 3387c609719bSwdenk 3388c609719bSwdenk 3389f07771ccSwdenkCommand Line Parsing: 3390f07771ccSwdenk===================== 3391f07771ccSwdenk 3392f07771ccSwdenkThere are two different command line parsers available with U-Boot: 33937152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell: 3394f07771ccSwdenk 3395f07771ccSwdenkOld, simple command line parser: 3396f07771ccSwdenk-------------------------------- 3397f07771ccSwdenk 3398f07771ccSwdenk- supports environment variables (through setenv / saveenv commands) 3399f07771ccSwdenk- several commands on one line, separated by ';' 3400fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax 3401f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\', 3402f07771ccSwdenk for example: 3403fe126d8bSWolfgang Denk setenv bootcmd bootm \${address} 3404f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example: 3405f07771ccSwdenk setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off' 3406f07771ccSwdenk 3407f07771ccSwdenkHush shell: 3408f07771ccSwdenk----------- 3409f07771ccSwdenk 3410f07771ccSwdenk- similar to Bourne shell, with control structures like 3411f07771ccSwdenk if...then...else...fi, for...do...done; while...do...done, 3412f07771ccSwdenk until...do...done, ... 3413f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv 3414f07771ccSwdenk commands) and local shell variables (through standard shell syntax 3415f07771ccSwdenk "name=value"); only environment variables can be used with "run" 3416f07771ccSwdenk command 3417f07771ccSwdenk 3418f07771ccSwdenkGeneral rules: 3419f07771ccSwdenk-------------- 3420f07771ccSwdenk 3421f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run" 3422f07771ccSwdenk command) contains several commands separated by semicolon, and 3423f07771ccSwdenk one of these commands fails, then the remaining commands will be 3424f07771ccSwdenk executed anyway. 3425f07771ccSwdenk 3426f07771ccSwdenk(2) If you execute several variables with one call to run (i. e. 342711ccc33fSMarcel Ziswiler calling run with a list of variables as arguments), any failing 3428f07771ccSwdenk command will cause "run" to terminate, i. e. the remaining 3429f07771ccSwdenk variables are not executed. 3430f07771ccSwdenk 3431c609719bSwdenkNote for Redundant Ethernet Interfaces: 3432c609719bSwdenk======================================= 3433c609719bSwdenk 343411ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports 3435c609719bSwdenksuch configurations and is capable of automatic selection of a 34367152b1d0Swdenk"working" interface when needed. MAC assignment works as follows: 3437c609719bSwdenk 3438c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding 3439c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0), 3440c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ... 3441c609719bSwdenk 3442c609719bSwdenkIf the network interface stores some valid MAC address (for instance 3443c609719bSwdenkin SROM), this is used as default address if there is NO correspon- 3444c609719bSwdenkding setting in the environment; if the corresponding environment 3445c609719bSwdenkvariable is set, this overrides the settings in the card; that means: 3446c609719bSwdenk 3447c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the 3448c609719bSwdenk environment, the SROM's address is used. 3449c609719bSwdenk 3450c609719bSwdenko If there is no valid address in the SROM, and a definition in the 3451c609719bSwdenk environment exists, then the value from the environment variable is 3452c609719bSwdenk used. 3453c609719bSwdenk 3454c609719bSwdenko If both the SROM and the environment contain a MAC address, and 3455c609719bSwdenk both addresses are the same, this MAC address is used. 3456c609719bSwdenk 3457c609719bSwdenko If both the SROM and the environment contain a MAC address, and the 3458c609719bSwdenk addresses differ, the value from the environment is used and a 3459c609719bSwdenk warning is printed. 3460c609719bSwdenk 3461c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error 3462c609719bSwdenk is raised. 3463c609719bSwdenk 3464ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses 3465ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process. This 3466ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable. 3467ecee9324SBen WarrenThe naming convention is as follows: 3468ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc. 3469c609719bSwdenk 3470c609719bSwdenkImage Formats: 3471c609719bSwdenk============== 3472c609719bSwdenk 34733310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on) 34743310c549SMarian Balakowiczimages in two formats: 34753310c549SMarian Balakowicz 34763310c549SMarian BalakowiczNew uImage format (FIT) 34773310c549SMarian Balakowicz----------------------- 34783310c549SMarian Balakowicz 34793310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar 34803310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple 34813310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by 34823310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory. 34833310c549SMarian Balakowicz 34843310c549SMarian Balakowicz 34853310c549SMarian BalakowiczOld uImage format 34863310c549SMarian Balakowicz----------------- 34873310c549SMarian Balakowicz 34883310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything, 34893310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for 34903310c549SMarian Balakowiczdetails; basically, the header defines the following image properties: 3491c609719bSwdenk 3492c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD, 3493c609719bSwdenk 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks, 3494f5ed9e39SPeter Tyser LynxOS, pSOS, QNX, RTEMS, INTEGRITY; 3495f5ed9e39SPeter Tyser Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS, 3496f5ed9e39SPeter Tyser INTEGRITY). 34977b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86, 34981117cbf2SThomas Chou IA64, MIPS, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit; 34991117cbf2SThomas Chou Currently supported: ARM, AVR32, Intel x86, MIPS, Nios II, PowerPC). 3500c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2) 3501c609719bSwdenk* Load Address 3502c609719bSwdenk* Entry Point 3503c609719bSwdenk* Image Name 3504c609719bSwdenk* Image Timestamp 3505c609719bSwdenk 3506c609719bSwdenkThe header is marked by a special Magic Number, and both the header 3507c609719bSwdenkand the data portions of the image are secured against corruption by 3508c609719bSwdenkCRC32 checksums. 3509c609719bSwdenk 3510c609719bSwdenk 3511c609719bSwdenkLinux Support: 3512c609719bSwdenk============== 3513c609719bSwdenk 3514c609719bSwdenkAlthough U-Boot should support any OS or standalone application 35157152b1d0Swdenkeasily, the main focus has always been on Linux during the design of 3516c609719bSwdenkU-Boot. 3517c609719bSwdenk 3518c609719bSwdenkU-Boot includes many features that so far have been part of some 3519c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any 3520c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image; 3521c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation 35227152b1d0Swdenkserves several purposes: 3523c609719bSwdenk 3524c609719bSwdenk- the same features can be used for other OS or standalone 3525c609719bSwdenk applications (for instance: using compressed images to reduce the 3526c609719bSwdenk Flash memory footprint) 3527c609719bSwdenk 3528c609719bSwdenk- it becomes much easier to port new Linux kernel versions because 35297152b1d0Swdenk lots of low-level, hardware dependent stuff are done by U-Boot 3530c609719bSwdenk 3531c609719bSwdenk- the same Linux kernel image can now be used with different "initrd" 3532c609719bSwdenk images; of course this also means that different kernel images can 3533c609719bSwdenk be run with the same "initrd". This makes testing easier (you don't 3534c609719bSwdenk have to build a new "zImage.initrd" Linux image when you just 3535c609719bSwdenk change a file in your "initrd"). Also, a field-upgrade of the 3536c609719bSwdenk software is easier now. 3537c609719bSwdenk 3538c609719bSwdenk 3539c609719bSwdenkLinux HOWTO: 3540c609719bSwdenk============ 3541c609719bSwdenk 3542c609719bSwdenkPorting Linux to U-Boot based systems: 3543c609719bSwdenk--------------------------------------- 3544c609719bSwdenk 3545c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to 3546c609719bSwdenkconfigure the Linux device drivers for use with your target hardware 3547c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to 3548c609719bSwdenkLinux :-). 3549c609719bSwdenk 3550a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot). 3551c609719bSwdenk 3552c609719bSwdenkJust make sure your machine specific header file (for instance 3553c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board 35541dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h, 35551dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value 35566d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR. 3557c609719bSwdenk 3558c609719bSwdenk 3559c609719bSwdenkConfiguring the Linux kernel: 3560c609719bSwdenk----------------------------- 3561c609719bSwdenk 3562c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root 3563c609719bSwdenkdevice (initial ramdisk, NFS) for your target system. 3564c609719bSwdenk 3565c609719bSwdenk 3566c609719bSwdenkBuilding a Linux Image: 3567c609719bSwdenk----------------------- 3568c609719bSwdenk 356924ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are 357024ee89b9Swdenknot used. If you use recent kernel source, a new build target 357124ee89b9Swdenk"uImage" will exist which automatically builds an image usable by 357224ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target, 357324ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a 357424ee89b9Swdenk100% compatible format. 3575c609719bSwdenk 3576c609719bSwdenkExample: 3577c609719bSwdenk 3578c609719bSwdenk make TQM850L_config 3579c609719bSwdenk make oldconfig 3580c609719bSwdenk make dep 358124ee89b9Swdenk make uImage 3582c609719bSwdenk 358324ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to 358424ee89b9Swdenkencapsulate a compressed Linux kernel image with header information, 358524ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing: 3586c609719bSwdenk 358724ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format): 358824ee89b9Swdenk 358924ee89b9Swdenk* convert the kernel into a raw binary image: 359024ee89b9Swdenk 359124ee89b9Swdenk ${CROSS_COMPILE}-objcopy -O binary \ 359224ee89b9Swdenk -R .note -R .comment \ 359324ee89b9Swdenk -S vmlinux linux.bin 359424ee89b9Swdenk 359524ee89b9Swdenk* compress the binary image: 359624ee89b9Swdenk 359724ee89b9Swdenk gzip -9 linux.bin 359824ee89b9Swdenk 359924ee89b9Swdenk* package compressed binary image for U-Boot: 360024ee89b9Swdenk 360124ee89b9Swdenk mkimage -A ppc -O linux -T kernel -C gzip \ 360224ee89b9Swdenk -a 0 -e 0 -n "Linux Kernel Image" \ 360324ee89b9Swdenk -d linux.bin.gz uImage 360424ee89b9Swdenk 360524ee89b9Swdenk 360624ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use 360724ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or 360824ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64 360924ee89b9Swdenkbyte header containing information about target architecture, 361024ee89b9Swdenkoperating system, image type, compression method, entry points, time 361124ee89b9Swdenkstamp, CRC32 checksums, etc. 361224ee89b9Swdenk 361324ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and 361424ee89b9Swdenkprint the header information, or to build new images. 3615c609719bSwdenk 3616c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information 3617c609719bSwdenkcontained in the header of an existing U-Boot image; this includes 3618c609719bSwdenkchecksum verification: 3619c609719bSwdenk 3620c609719bSwdenk tools/mkimage -l image 3621c609719bSwdenk -l ==> list image header information 3622c609719bSwdenk 3623c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image 3624c609719bSwdenkfrom a "data file" which is used as image payload: 3625c609719bSwdenk 3626c609719bSwdenk tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \ 3627c609719bSwdenk -n name -d data_file image 3628c609719bSwdenk -A ==> set architecture to 'arch' 3629c609719bSwdenk -O ==> set operating system to 'os' 3630c609719bSwdenk -T ==> set image type to 'type' 3631c609719bSwdenk -C ==> set compression type 'comp' 3632c609719bSwdenk -a ==> set load address to 'addr' (hex) 3633c609719bSwdenk -e ==> set entry point to 'ep' (hex) 3634c609719bSwdenk -n ==> set image name to 'name' 3635c609719bSwdenk -d ==> use image data from 'datafile' 3636c609719bSwdenk 363769459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load 363869459791Swdenkaddress (0x00000000), but the entry point address depends on the 363969459791Swdenkkernel version: 3640c609719bSwdenk 3641c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C, 364224ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000. 3643c609719bSwdenk 3644c609719bSwdenkSo a typical call to build a U-Boot image would read: 3645c609719bSwdenk 364624ee89b9Swdenk -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 364724ee89b9Swdenk > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \ 3648a47a12beSStefan Roese > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \ 364924ee89b9Swdenk > examples/uImage.TQM850L 365024ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 3651c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 3652c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 3653c609719bSwdenk Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 3654c609719bSwdenk Load Address: 0x00000000 365524ee89b9Swdenk Entry Point: 0x00000000 3656c609719bSwdenk 3657c609719bSwdenkTo verify the contents of the image (or check for corruption): 3658c609719bSwdenk 365924ee89b9Swdenk -> tools/mkimage -l examples/uImage.TQM850L 366024ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 3661c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 3662c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 3663c609719bSwdenk Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 3664c609719bSwdenk Load Address: 0x00000000 366524ee89b9Swdenk Entry Point: 0x00000000 3666c609719bSwdenk 3667c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade 3668c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this 3669c609719bSwdenkneeds more space in Flash, but boots much faster since it does not 3670c609719bSwdenkneed to be uncompressed: 3671c609719bSwdenk 3672a47a12beSStefan Roese -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz 367324ee89b9Swdenk -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 367424ee89b9Swdenk > -A ppc -O linux -T kernel -C none -a 0 -e 0 \ 3675a47a12beSStefan Roese > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \ 367624ee89b9Swdenk > examples/uImage.TQM850L-uncompressed 367724ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 3678c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 3679c609719bSwdenk Image Type: PowerPC Linux Kernel Image (uncompressed) 3680c609719bSwdenk Data Size: 792160 Bytes = 773.59 kB = 0.76 MB 3681c609719bSwdenk Load Address: 0x00000000 368224ee89b9Swdenk Entry Point: 0x00000000 3683c609719bSwdenk 3684c609719bSwdenk 3685c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file 3686c609719bSwdenkwhen your kernel is intended to use an initial ramdisk: 3687c609719bSwdenk 3688c609719bSwdenk -> tools/mkimage -n 'Simple Ramdisk Image' \ 3689c609719bSwdenk > -A ppc -O linux -T ramdisk -C gzip \ 3690c609719bSwdenk > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd 3691c609719bSwdenk Image Name: Simple Ramdisk Image 3692c609719bSwdenk Created: Wed Jan 12 14:01:50 2000 3693c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 3694c609719bSwdenk Data Size: 566530 Bytes = 553.25 kB = 0.54 MB 3695c609719bSwdenk Load Address: 0x00000000 3696c609719bSwdenk Entry Point: 0x00000000 3697c609719bSwdenk 3698c609719bSwdenk 3699c609719bSwdenkInstalling a Linux Image: 3700c609719bSwdenk------------------------- 3701c609719bSwdenk 3702c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface, 3703c609719bSwdenkyou must convert the image to S-Record format: 3704c609719bSwdenk 3705c609719bSwdenk objcopy -I binary -O srec examples/image examples/image.srec 3706c609719bSwdenk 3707c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot 3708c609719bSwdenkimage header, so the resulting S-Record file will be relative to 3709c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to 3710c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads' 3711c609719bSwdenkcommand. 3712c609719bSwdenk 3713c609719bSwdenkExample: install the image to address 0x40100000 (which on the 3714c609719bSwdenkTQM8xxL is in the first Flash bank): 3715c609719bSwdenk 3716c609719bSwdenk => erase 40100000 401FFFFF 3717c609719bSwdenk 3718c609719bSwdenk .......... done 3719c609719bSwdenk Erased 8 sectors 3720c609719bSwdenk 3721c609719bSwdenk => loads 40100000 3722c609719bSwdenk ## Ready for S-Record download ... 3723c609719bSwdenk ~>examples/image.srec 3724c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 12 13 ... 3725c609719bSwdenk ... 3726c609719bSwdenk 15989 15990 15991 15992 3727c609719bSwdenk [file transfer complete] 3728c609719bSwdenk [connected] 3729c609719bSwdenk ## Start Addr = 0x00000000 3730c609719bSwdenk 3731c609719bSwdenk 3732c609719bSwdenkYou can check the success of the download using the 'iminfo' command; 3733c609719bSwdenkthis includes a checksum verification so you can be sure no data 3734c609719bSwdenkcorruption happened: 3735c609719bSwdenk 3736c609719bSwdenk => imi 40100000 3737c609719bSwdenk 3738c609719bSwdenk ## Checking Image at 40100000 ... 3739c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 3740c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 3741c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 3742c609719bSwdenk Load Address: 00000000 3743c609719bSwdenk Entry Point: 0000000c 3744c609719bSwdenk Verifying Checksum ... OK 3745c609719bSwdenk 3746c609719bSwdenk 3747c609719bSwdenkBoot Linux: 3748c609719bSwdenk----------- 3749c609719bSwdenk 3750c609719bSwdenkThe "bootm" command is used to boot an application that is stored in 3751c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents 3752c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as 3753c609719bSwdenkparameters. You can check and modify this variable using the 3754c609719bSwdenk"printenv" and "setenv" commands: 3755c609719bSwdenk 3756c609719bSwdenk 3757c609719bSwdenk => printenv bootargs 3758c609719bSwdenk bootargs=root=/dev/ram 3759c609719bSwdenk 3760c609719bSwdenk => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 3761c609719bSwdenk 3762c609719bSwdenk => printenv bootargs 3763c609719bSwdenk bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 3764c609719bSwdenk 3765c609719bSwdenk => bootm 40020000 3766c609719bSwdenk ## Booting Linux kernel at 40020000 ... 3767c609719bSwdenk Image Name: 2.2.13 for NFS on TQM850L 3768c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 3769c609719bSwdenk Data Size: 381681 Bytes = 372 kB = 0 MB 3770c609719bSwdenk Load Address: 00000000 3771c609719bSwdenk Entry Point: 0000000c 3772c609719bSwdenk Verifying Checksum ... OK 3773c609719bSwdenk Uncompressing Kernel Image ... OK 3774c609719bSwdenk 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 3775c609719bSwdenk Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 3776c609719bSwdenk time_init: decrementer frequency = 187500000/60 3777c609719bSwdenk Calibrating delay loop... 49.77 BogoMIPS 3778c609719bSwdenk Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000] 3779c609719bSwdenk ... 3780c609719bSwdenk 378111ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass 37827152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT 3783c609719bSwdenkformat!) to the "bootm" command: 3784c609719bSwdenk 3785c609719bSwdenk => imi 40100000 40200000 3786c609719bSwdenk 3787c609719bSwdenk ## Checking Image at 40100000 ... 3788c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 3789c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 3790c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 3791c609719bSwdenk Load Address: 00000000 3792c609719bSwdenk Entry Point: 0000000c 3793c609719bSwdenk Verifying Checksum ... OK 3794c609719bSwdenk 3795c609719bSwdenk ## Checking Image at 40200000 ... 3796c609719bSwdenk Image Name: Simple Ramdisk Image 3797c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 3798c609719bSwdenk Data Size: 566530 Bytes = 553 kB = 0 MB 3799c609719bSwdenk Load Address: 00000000 3800c609719bSwdenk Entry Point: 00000000 3801c609719bSwdenk Verifying Checksum ... OK 3802c609719bSwdenk 3803c609719bSwdenk => bootm 40100000 40200000 3804c609719bSwdenk ## Booting Linux kernel at 40100000 ... 3805c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 3806c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 3807c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 3808c609719bSwdenk Load Address: 00000000 3809c609719bSwdenk Entry Point: 0000000c 3810c609719bSwdenk Verifying Checksum ... OK 3811c609719bSwdenk Uncompressing Kernel Image ... OK 3812c609719bSwdenk ## Loading RAMDisk Image at 40200000 ... 3813c609719bSwdenk Image Name: Simple Ramdisk Image 3814c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 3815c609719bSwdenk Data Size: 566530 Bytes = 553 kB = 0 MB 3816c609719bSwdenk Load Address: 00000000 3817c609719bSwdenk Entry Point: 00000000 3818c609719bSwdenk Verifying Checksum ... OK 3819c609719bSwdenk Loading Ramdisk ... OK 3820c609719bSwdenk 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 3821c609719bSwdenk Boot arguments: root=/dev/ram 3822c609719bSwdenk time_init: decrementer frequency = 187500000/60 3823c609719bSwdenk Calibrating delay loop... 49.77 BogoMIPS 3824c609719bSwdenk ... 3825c609719bSwdenk RAMDISK: Compressed image found at block 0 3826c609719bSwdenk VFS: Mounted root (ext2 filesystem). 3827c609719bSwdenk 3828c609719bSwdenk bash# 3829c609719bSwdenk 38300267768eSMatthew McClintockBoot Linux and pass a flat device tree: 38310267768eSMatthew McClintock----------- 38320267768eSMatthew McClintock 38330267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section 38340267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The 38350267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated 38360267768eSMatthew McClintockflat device tree: 38370267768eSMatthew McClintock 38380267768eSMatthew McClintock=> print oftaddr 38390267768eSMatthew McClintockoftaddr=0x300000 38400267768eSMatthew McClintock=> print oft 38410267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb 38420267768eSMatthew McClintock=> tftp $oftaddr $oft 38430267768eSMatthew McClintockSpeed: 1000, full duplex 38440267768eSMatthew McClintockUsing TSEC0 device 38450267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101 38460267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'. 38470267768eSMatthew McClintockLoad address: 0x300000 38480267768eSMatthew McClintockLoading: # 38490267768eSMatthew McClintockdone 38500267768eSMatthew McClintockBytes transferred = 4106 (100a hex) 38510267768eSMatthew McClintock=> tftp $loadaddr $bootfile 38520267768eSMatthew McClintockSpeed: 1000, full duplex 38530267768eSMatthew McClintockUsing TSEC0 device 38540267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2 38550267768eSMatthew McClintockFilename 'uImage'. 38560267768eSMatthew McClintockLoad address: 0x200000 38570267768eSMatthew McClintockLoading:############ 38580267768eSMatthew McClintockdone 38590267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex) 38600267768eSMatthew McClintock=> print loadaddr 38610267768eSMatthew McClintockloadaddr=200000 38620267768eSMatthew McClintock=> print oftaddr 38630267768eSMatthew McClintockoftaddr=0x300000 38640267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr 38650267768eSMatthew McClintock## Booting image at 00200000 ... 38660267768eSMatthew McClintock Image Name: Linux-2.6.17-dirty 38670267768eSMatthew McClintock Image Type: PowerPC Linux Kernel Image (gzip compressed) 38680267768eSMatthew McClintock Data Size: 1029343 Bytes = 1005.2 kB 38690267768eSMatthew McClintock Load Address: 00000000 38700267768eSMatthew McClintock Entry Point: 00000000 38710267768eSMatthew McClintock Verifying Checksum ... OK 38720267768eSMatthew McClintock Uncompressing Kernel Image ... OK 38730267768eSMatthew McClintockBooting using flat device tree at 0x300000 38740267768eSMatthew McClintockUsing MPC85xx ADS machine description 38750267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb 38760267768eSMatthew McClintock[snip] 38770267768eSMatthew McClintock 38780267768eSMatthew McClintock 38796069ff26SwdenkMore About U-Boot Image Types: 38806069ff26Swdenk------------------------------ 38816069ff26Swdenk 38826069ff26SwdenkU-Boot supports the following image types: 38836069ff26Swdenk 38846069ff26Swdenk "Standalone Programs" are directly runnable in the environment 38856069ff26Swdenk provided by U-Boot; it is expected that (if they behave 38866069ff26Swdenk well) you can continue to work in U-Boot after return from 38876069ff26Swdenk the Standalone Program. 38886069ff26Swdenk "OS Kernel Images" are usually images of some Embedded OS which 38896069ff26Swdenk will take over control completely. Usually these programs 38906069ff26Swdenk will install their own set of exception handlers, device 38916069ff26Swdenk drivers, set up the MMU, etc. - this means, that you cannot 38926069ff26Swdenk expect to re-enter U-Boot except by resetting the CPU. 38936069ff26Swdenk "RAMDisk Images" are more or less just data blocks, and their 38946069ff26Swdenk parameters (address, size) are passed to an OS kernel that is 38956069ff26Swdenk being started. 38966069ff26Swdenk "Multi-File Images" contain several images, typically an OS 38976069ff26Swdenk (Linux) kernel image and one or more data images like 38986069ff26Swdenk RAMDisks. This construct is useful for instance when you want 38996069ff26Swdenk to boot over the network using BOOTP etc., where the boot 39006069ff26Swdenk server provides just a single image file, but you want to get 39016069ff26Swdenk for instance an OS kernel and a RAMDisk image. 39026069ff26Swdenk 39036069ff26Swdenk "Multi-File Images" start with a list of image sizes, each 39046069ff26Swdenk image size (in bytes) specified by an "uint32_t" in network 39056069ff26Swdenk byte order. This list is terminated by an "(uint32_t)0". 39066069ff26Swdenk Immediately after the terminating 0 follow the images, one by 39076069ff26Swdenk one, all aligned on "uint32_t" boundaries (size rounded up to 39086069ff26Swdenk a multiple of 4 bytes). 39096069ff26Swdenk 39106069ff26Swdenk "Firmware Images" are binary images containing firmware (like 39116069ff26Swdenk U-Boot or FPGA images) which usually will be programmed to 39126069ff26Swdenk flash memory. 39136069ff26Swdenk 39146069ff26Swdenk "Script files" are command sequences that will be executed by 39156069ff26Swdenk U-Boot's command interpreter; this feature is especially 39166069ff26Swdenk useful when you configure U-Boot to use a real shell (hush) 39176069ff26Swdenk as command interpreter. 39186069ff26Swdenk 3919c609719bSwdenk 3920c609719bSwdenkStandalone HOWTO: 3921c609719bSwdenk================= 3922c609719bSwdenk 3923c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and 3924c609719bSwdenkrun "standalone" applications, which can use some resources of 3925c609719bSwdenkU-Boot like console I/O functions or interrupt services. 3926c609719bSwdenk 3927c609719bSwdenkTwo simple examples are included with the sources: 3928c609719bSwdenk 3929c609719bSwdenk"Hello World" Demo: 3930c609719bSwdenk------------------- 3931c609719bSwdenk 3932c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo 3933c609719bSwdenkapplication; it is automatically compiled when you build U-Boot. 3934c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it 3935c609719bSwdenklike that: 3936c609719bSwdenk 3937c609719bSwdenk => loads 3938c609719bSwdenk ## Ready for S-Record download ... 3939c609719bSwdenk ~>examples/hello_world.srec 3940c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 ... 3941c609719bSwdenk [file transfer complete] 3942c609719bSwdenk [connected] 3943c609719bSwdenk ## Start Addr = 0x00040004 3944c609719bSwdenk 3945c609719bSwdenk => go 40004 Hello World! This is a test. 3946c609719bSwdenk ## Starting application at 0x00040004 ... 3947c609719bSwdenk Hello World 3948c609719bSwdenk argc = 7 3949c609719bSwdenk argv[0] = "40004" 3950c609719bSwdenk argv[1] = "Hello" 3951c609719bSwdenk argv[2] = "World!" 3952c609719bSwdenk argv[3] = "This" 3953c609719bSwdenk argv[4] = "is" 3954c609719bSwdenk argv[5] = "a" 3955c609719bSwdenk argv[6] = "test." 3956c609719bSwdenk argv[7] = "<NULL>" 3957c609719bSwdenk Hit any key to exit ... 3958c609719bSwdenk 3959c609719bSwdenk ## Application terminated, rc = 0x0 3960c609719bSwdenk 3961c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt 3962c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'. 3963c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second. 3964c609719bSwdenkThe interrupt service routine is trivial, just printing a '.' 3965c609719bSwdenkcharacter, but this is just a demo program. The application can be 3966c609719bSwdenkcontrolled by the following keys: 3967c609719bSwdenk 3968c609719bSwdenk ? - print current values og the CPM Timer registers 3969c609719bSwdenk b - enable interrupts and start timer 3970c609719bSwdenk e - stop timer and disable interrupts 3971c609719bSwdenk q - quit application 3972c609719bSwdenk 3973c609719bSwdenk => loads 3974c609719bSwdenk ## Ready for S-Record download ... 3975c609719bSwdenk ~>examples/timer.srec 3976c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 ... 3977c609719bSwdenk [file transfer complete] 3978c609719bSwdenk [connected] 3979c609719bSwdenk ## Start Addr = 0x00040004 3980c609719bSwdenk 3981c609719bSwdenk => go 40004 3982c609719bSwdenk ## Starting application at 0x00040004 ... 3983c609719bSwdenk TIMERS=0xfff00980 3984c609719bSwdenk Using timer 1 3985c609719bSwdenk tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0 3986c609719bSwdenk 3987c609719bSwdenkHit 'b': 3988c609719bSwdenk [q, b, e, ?] Set interval 1000000 us 3989c609719bSwdenk Enabling timer 3990c609719bSwdenkHit '?': 3991c609719bSwdenk [q, b, e, ?] ........ 3992c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0 3993c609719bSwdenkHit '?': 3994c609719bSwdenk [q, b, e, ?] . 3995c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0 3996c609719bSwdenkHit '?': 3997c609719bSwdenk [q, b, e, ?] . 3998c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0 3999c609719bSwdenkHit '?': 4000c609719bSwdenk [q, b, e, ?] . 4001c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0 4002c609719bSwdenkHit 'e': 4003c609719bSwdenk [q, b, e, ?] ...Stopping timer 4004c609719bSwdenkHit 'q': 4005c609719bSwdenk [q, b, e, ?] ## Application terminated, rc = 0x0 4006c609719bSwdenk 4007c609719bSwdenk 400885ec0bccSwdenkMinicom warning: 400985ec0bccSwdenk================ 401085ec0bccSwdenk 40117152b1d0SwdenkOver time, many people have reported problems when trying to use the 401285ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd) 401385ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under 4014f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and 401585ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and 401685ec0bccSwdenkuse "cu" for S-Record download ("loads" command). 401785ec0bccSwdenk 401852f52c14SwdenkNevertheless, if you absolutely want to use it try adding this 401952f52c14Swdenkconfiguration to your "File transfer protocols" section: 402052f52c14Swdenk 402152f52c14Swdenk Name Program Name U/D FullScr IO-Red. Multi 402252f52c14Swdenk X kermit /usr/bin/kermit -i -l %l -s Y U Y N N 402352f52c14Swdenk Y kermit /usr/bin/kermit -i -l %l -r N D Y N N 402452f52c14Swdenk 402552f52c14Swdenk 4026c609719bSwdenkNetBSD Notes: 4027c609719bSwdenk============= 4028c609719bSwdenk 4029c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host 4030c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx). 4031c609719bSwdenk 4032c609719bSwdenkBuilding requires a cross environment; it is known to work on 4033c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also 4034c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make). 4035c609719bSwdenkNote that the cross-powerpc package does not install include files; 4036c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is 4037c609719bSwdenkmissing. This file has to be installed and patched manually: 4038c609719bSwdenk 4039c609719bSwdenk # cd /usr/pkg/cross/powerpc-netbsd/include 4040c609719bSwdenk # mkdir powerpc 4041c609719bSwdenk # ln -s powerpc machine 4042c609719bSwdenk # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h 4043c609719bSwdenk # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST 4044c609719bSwdenk 4045c609719bSwdenkNative builds *don't* work due to incompatibilities between native 4046c609719bSwdenkand U-Boot include files. 4047c609719bSwdenk 4048c609719bSwdenkBooting assumes that (the first part of) the image booted is a 4049c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel 4050c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source 4051c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the 40522a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz 4053c609719bSwdenk 4054c609719bSwdenk 4055c609719bSwdenkImplementation Internals: 4056c609719bSwdenk========================= 4057c609719bSwdenk 4058c609719bSwdenkThe following is not intended to be a complete description of every 4059c609719bSwdenkimplementation detail. However, it should help to understand the 4060c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom 4061c609719bSwdenkhardware. 4062c609719bSwdenk 4063c609719bSwdenk 4064c609719bSwdenkInitial Stack, Global Data: 4065c609719bSwdenk--------------------------- 4066c609719bSwdenk 4067c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot 4068c609719bSwdenkstarts running out of ROM (flash memory), usually without access to 4069c609719bSwdenksystem RAM (because the memory controller is not initialized yet). 4070c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS 4071c609719bSwdenkis not initialized as zero. To be able to get a C environment working 4072c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation 4073c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU 4074c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and 4075c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be 4076c609719bSwdenklocked as (mis-) used as memory, etc. 4077c609719bSwdenk 40787152b1d0Swdenk Chris Hallinan posted a good summary of these issues to the 40790668236bSWolfgang Denk U-Boot mailing list: 408043d9616cSwdenk 408143d9616cSwdenk Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)? 408243d9616cSwdenk From: "Chris Hallinan" <clh@net1plus.com> 408343d9616cSwdenk Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET) 408443d9616cSwdenk ... 408543d9616cSwdenk 408643d9616cSwdenk Correct me if I'm wrong, folks, but the way I understand it 408743d9616cSwdenk is this: Using DCACHE as initial RAM for Stack, etc, does not 408843d9616cSwdenk require any physical RAM backing up the cache. The cleverness 408943d9616cSwdenk is that the cache is being used as a temporary supply of 409043d9616cSwdenk necessary storage before the SDRAM controller is setup. It's 409111ccc33fSMarcel Ziswiler beyond the scope of this list to explain the details, but you 409243d9616cSwdenk can see how this works by studying the cache architecture and 409343d9616cSwdenk operation in the architecture and processor-specific manuals. 409443d9616cSwdenk 409543d9616cSwdenk OCM is On Chip Memory, which I believe the 405GP has 4K. It 409643d9616cSwdenk is another option for the system designer to use as an 409711ccc33fSMarcel Ziswiler initial stack/RAM area prior to SDRAM being available. Either 409843d9616cSwdenk option should work for you. Using CS 4 should be fine if your 409943d9616cSwdenk board designers haven't used it for something that would 410043d9616cSwdenk cause you grief during the initial boot! It is frequently not 410143d9616cSwdenk used. 410243d9616cSwdenk 41036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere 410443d9616cSwdenk with your processor/board/system design. The default value 410543d9616cSwdenk you will find in any recent u-boot distribution in 41068a316c9bSStefan Roese walnut.h should work for you. I'd set it to a value larger 410743d9616cSwdenk than your SDRAM module. If you have a 64MB SDRAM module, set 410843d9616cSwdenk it above 400_0000. Just make sure your board has no resources 410943d9616cSwdenk that are supposed to respond to that address! That code in 411043d9616cSwdenk start.S has been around a while and should work as is when 411143d9616cSwdenk you get the config right. 411243d9616cSwdenk 411343d9616cSwdenk -Chris Hallinan 411443d9616cSwdenk DS4.COM, Inc. 411543d9616cSwdenk 4116c609719bSwdenkIt is essential to remember this, since it has some impact on the C 4117c609719bSwdenkcode for the initialization procedures: 4118c609719bSwdenk 4119c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt 4120c609719bSwdenk to write it. 4121c609719bSwdenk 412211ccc33fSMarcel Ziswiler* Do not use any uninitialized global data (or implicitely initialized 4123c609719bSwdenk as zero data - BSS segment) at all - this is undefined, initiali- 41247152b1d0Swdenk zation is performed later (when relocating to RAM). 4125c609719bSwdenk 4126c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like 4127c609719bSwdenk that. 4128c609719bSwdenk 4129c609719bSwdenkHaving only the stack as writable memory limits means we cannot use 4130c609719bSwdenknormal global data to share information beween the code. But it 4131c609719bSwdenkturned out that the implementation of U-Boot can be greatly 4132c609719bSwdenksimplified by making a global data structure (gd_t) available to all 4133c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_ 4134c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of 4135c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we 4136c609719bSwdenkplace a pointer (gd) to the global data into a register which we 4137c609719bSwdenkreserve for this purpose. 4138c609719bSwdenk 41397152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the 4140c609719bSwdenkrelevant (E)ABI specifications for the current architecture, and by 4141c609719bSwdenkGCC's implementation. 4142c609719bSwdenk 4143c609719bSwdenkFor PowerPC, the following registers have specific use: 4144c609719bSwdenk R1: stack pointer 4145e7670f6cSWolfgang Denk R2: reserved for system use 4146c609719bSwdenk R3-R4: parameter passing and return values 4147c609719bSwdenk R5-R10: parameter passing 4148c609719bSwdenk R13: small data area pointer 4149c609719bSwdenk R30: GOT pointer 4150c609719bSwdenk R31: frame pointer 4151c609719bSwdenk 4152e6bee808SJoakim Tjernlund (U-Boot also uses R12 as internal GOT pointer. r12 4153e6bee808SJoakim Tjernlund is a volatile register so r12 needs to be reset when 4154e6bee808SJoakim Tjernlund going back and forth between asm and C) 4155c609719bSwdenk 4156e7670f6cSWolfgang Denk ==> U-Boot will use R2 to hold a pointer to the global data 4157c609719bSwdenk 4158c609719bSwdenk Note: on PPC, we could use a static initializer (since the 4159c609719bSwdenk address of the global data structure is known at compile time), 4160c609719bSwdenk but it turned out that reserving a register results in somewhat 4161c609719bSwdenk smaller code - although the code savings are not that big (on 4162c609719bSwdenk average for all boards 752 bytes for the whole U-Boot image, 4163c609719bSwdenk 624 text + 127 data). 4164c609719bSwdenk 4165c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here: 41664c58eb55SMike Frysinger http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface 41674c58eb55SMike Frysinger 4168c4db335cSRobin Getz ==> U-Boot will use P3 to hold a pointer to the global data 41694c58eb55SMike Frysinger 4170c609719bSwdenkOn ARM, the following registers are used: 4171c609719bSwdenk 4172c609719bSwdenk R0: function argument word/integer result 4173c609719bSwdenk R1-R3: function argument word 4174c609719bSwdenk R9: GOT pointer 4175c609719bSwdenk R10: stack limit (used only if stack checking if enabled) 4176c609719bSwdenk R11: argument (frame) pointer 4177c609719bSwdenk R12: temporary workspace 4178c609719bSwdenk R13: stack pointer 4179c609719bSwdenk R14: link register 4180c609719bSwdenk R15: program counter 4181c609719bSwdenk 4182c609719bSwdenk ==> U-Boot will use R8 to hold a pointer to the global data 4183c609719bSwdenk 41840df01fd3SThomas ChouOn Nios II, the ABI is documented here: 41850df01fd3SThomas Chou http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf 41860df01fd3SThomas Chou 41870df01fd3SThomas Chou ==> U-Boot will use gp to hold a pointer to the global data 41880df01fd3SThomas Chou 41890df01fd3SThomas Chou Note: on Nios II, we give "-G0" option to gcc and don't use gp 41900df01fd3SThomas Chou to access small data sections, so gp is free. 41910df01fd3SThomas Chou 4192d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope, 4193d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much. 4194c609719bSwdenk 4195c609719bSwdenkMemory Management: 4196c609719bSwdenk------------------ 4197c609719bSwdenk 4198c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the 4199c609719bSwdenkMMU is not used either for address mapping nor for memory protection. 4200c609719bSwdenk 4201c609719bSwdenkThe available memory is mapped to fixed addresses using the memory 4202c609719bSwdenkcontroller. In this process, a contiguous block is formed for each 4203c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several 4204c609719bSwdenkphysical memory banks. 4205c609719bSwdenk 4206c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on 4207c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After 4208c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself 4209c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some 42106d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN 4211c609719bSwdenkconfiguration setting]. Below that, a structure with global Board 4212c609719bSwdenkInfo data is placed, followed by the stack (growing downward). 4213c609719bSwdenk 4214c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB 4215c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF). 4216c609719bSwdenk 4217c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like 4218c609719bSwdenkthis: 4219c609719bSwdenk 4220c609719bSwdenk 0x0000 0000 Exception Vector code 4221c609719bSwdenk : 4222c609719bSwdenk 0x0000 1FFF 4223c609719bSwdenk 0x0000 2000 Free for Application Use 4224c609719bSwdenk : 4225c609719bSwdenk : 4226c609719bSwdenk 4227c609719bSwdenk : 4228c609719bSwdenk : 4229c609719bSwdenk 0x00FB FF20 Monitor Stack (Growing downward) 4230c609719bSwdenk 0x00FB FFAC Board Info Data and permanent copy of global data 4231c609719bSwdenk 0x00FC 0000 Malloc Arena 4232c609719bSwdenk : 4233c609719bSwdenk 0x00FD FFFF 4234c609719bSwdenk 0x00FE 0000 RAM Copy of Monitor Code 4235c609719bSwdenk ... eventually: LCD or video framebuffer 4236c609719bSwdenk ... eventually: pRAM (Protected RAM - unchanged by reset) 4237c609719bSwdenk 0x00FF FFFF [End of RAM] 4238c609719bSwdenk 4239c609719bSwdenk 4240c609719bSwdenkSystem Initialization: 4241c609719bSwdenk---------------------- 4242c609719bSwdenk 4243c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point 424411ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset 4245c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory. 42467152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address. 4247c609719bSwdenkTo be able to implement the initialization code in C, a (small!) 4248c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs 4249c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked 4250c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core, 4251c609719bSwdenkthe caches and the SIU. 4252c609719bSwdenk 4253c609719bSwdenkNext, all (potentially) available memory banks are mapped using a 4254c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries 4255c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash 4256c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is 4257c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a 4258c609719bSwdenksimple memory test is run that determines the size of the SDRAM 4259c609719bSwdenkbanks. 4260c609719bSwdenk 4261c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of 42627152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first 4263c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address 4264c609719bSwdenk0x00000000, with any additional banks following immediately to create 4265c609719bSwdenkcontiguous memory starting from 0. 4266c609719bSwdenk 4267c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area 4268c609719bSwdenkand allocates memory for use by malloc() and for the global Board 4269c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM 4270c609719bSwdenkpages, and the final stack is set up. 4271c609719bSwdenk 4272c609719bSwdenkOnly after this relocation will you have a "normal" C environment; 4273c609719bSwdenkuntil that you are restricted in several ways, mostly because you are 4274c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a 4275c609719bSwdenknew address in RAM. 4276c609719bSwdenk 4277c609719bSwdenk 4278c609719bSwdenkU-Boot Porting Guide: 4279c609719bSwdenk---------------------- 4280c609719bSwdenk 4281c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing 42826aff3115Swdenklist, October 2002] 4283c609719bSwdenk 4284c609719bSwdenk 4285c609719bSwdenkint main(int argc, char *argv[]) 4286c609719bSwdenk{ 4287c609719bSwdenk sighandler_t no_more_time; 4288c609719bSwdenk 4289c609719bSwdenk signal(SIGALRM, no_more_time); 4290c609719bSwdenk alarm(PROJECT_DEADLINE - toSec (3 * WEEK)); 4291c609719bSwdenk 4292c609719bSwdenk if (available_money > available_manpower) { 42936c3fef28SJerry Van Baren Pay consultant to port U-Boot; 4294c609719bSwdenk return 0; 4295c609719bSwdenk } 4296c609719bSwdenk 4297c609719bSwdenk Download latest U-Boot source; 4298c609719bSwdenk 42990668236bSWolfgang Denk Subscribe to u-boot mailing list; 43006aff3115Swdenk 43016c3fef28SJerry Van Baren if (clueless) 4302c609719bSwdenk email("Hi, I am new to U-Boot, how do I get started?"); 4303c609719bSwdenk 4304c609719bSwdenk while (learning) { 4305c609719bSwdenk Read the README file in the top level directory; 43067cb22f97Swdenk Read http://www.denx.de/twiki/bin/view/DULG/Manual; 43076c3fef28SJerry Van Baren Read applicable doc/*.README; 4308c609719bSwdenk Read the source, Luke; 43096c3fef28SJerry Van Baren /* find . -name "*.[chS]" | xargs grep -i <keyword> */ 4310c609719bSwdenk } 4311c609719bSwdenk 43126c3fef28SJerry Van Baren if (available_money > toLocalCurrency ($2500)) 43136c3fef28SJerry Van Baren Buy a BDI3000; 43146c3fef28SJerry Van Baren else 4315c609719bSwdenk Add a lot of aggravation and time; 4316c609719bSwdenk 43176c3fef28SJerry Van Baren if (a similar board exists) { /* hopefully... */ 43186c3fef28SJerry Van Baren cp -a board/<similar> board/<myboard> 43196c3fef28SJerry Van Baren cp include/configs/<similar>.h include/configs/<myboard>.h 43206c3fef28SJerry Van Baren } else { 4321c609719bSwdenk Create your own board support subdirectory; 43226c3fef28SJerry Van Baren Create your own board include/configs/<myboard>.h file; 43236c3fef28SJerry Van Baren } 43246c3fef28SJerry Van Baren Edit new board/<myboard> files 43256c3fef28SJerry Van Baren Edit new include/configs/<myboard>.h 4326c609719bSwdenk 43276c3fef28SJerry Van Baren while (!accepted) { 4328c609719bSwdenk while (!running) { 4329c609719bSwdenk do { 4330c609719bSwdenk Add / modify source code; 4331c609719bSwdenk } until (compiles); 4332c609719bSwdenk Debug; 4333c609719bSwdenk if (clueless) 4334c609719bSwdenk email("Hi, I am having problems..."); 4335c609719bSwdenk } 43366c3fef28SJerry Van Baren Send patch file to the U-Boot email list; 43376c3fef28SJerry Van Baren if (reasonable critiques) 43386c3fef28SJerry Van Baren Incorporate improvements from email list code review; 43396c3fef28SJerry Van Baren else 43406c3fef28SJerry Van Baren Defend code as written; 43416c3fef28SJerry Van Baren } 4342c609719bSwdenk 4343c609719bSwdenk return 0; 4344c609719bSwdenk} 4345c609719bSwdenk 4346c609719bSwdenkvoid no_more_time (int sig) 4347c609719bSwdenk{ 4348c609719bSwdenk hire_a_guru(); 4349c609719bSwdenk} 4350c609719bSwdenk 4351c609719bSwdenk 4352c609719bSwdenkCoding Standards: 4353c609719bSwdenk----------------- 4354c609719bSwdenk 4355c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel 43562c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script 43572c051651SDetlev Zundel"scripts/Lindent" in your Linux kernel source directory. In sources 43582c051651SDetlev Zundeloriginating from U-Boot a style corresponding to "Lindent -pcs" (adding 43592c051651SDetlev Zundelspaces before parameters to function calls) is actually used. 4360c609719bSwdenk 43612c051651SDetlev ZundelSource files originating from a different project (for example the 43622c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not 43632c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those 43642c051651SDetlev Zundelsources. 43652c051651SDetlev Zundel 43662c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in 43672c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//) 43682c051651SDetlev Zundelin your code. 4369c609719bSwdenk 4370c178d3daSwdenkPlease also stick to the following formatting rules: 4371180d3f74Swdenk- remove any trailing white space 4372180d3f74Swdenk- use TAB characters for indentation, not spaces 4373180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds 4374180d3f74Swdenk- do not add more than 2 empty lines to source files 4375180d3f74Swdenk- do not add trailing empty lines to source files 4376180d3f74Swdenk 4377c609719bSwdenkSubmissions which do not conform to the standards may be returned 4378c609719bSwdenkwith a request to reformat the changes. 4379c609719bSwdenk 4380c609719bSwdenk 4381c609719bSwdenkSubmitting Patches: 4382c609719bSwdenk------------------- 4383c609719bSwdenk 4384c609719bSwdenkSince the number of patches for U-Boot is growing, we need to 4385c609719bSwdenkestablish some rules. Submissions which do not conform to these rules 4386c609719bSwdenkmay be rejected, even when they contain important and valuable stuff. 4387c609719bSwdenk 43880d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details. 4389218ca724SWolfgang Denk 43900668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>; 43910668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot 43920668236bSWolfgang Denk 4393c609719bSwdenkWhen you send a patch, please include the following information with 4394c609719bSwdenkit: 4395c609719bSwdenk 4396c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes 4397c609719bSwdenk this bug. Please try to include a way of demonstrating that the 4398c609719bSwdenk patch actually fixes something. 4399c609719bSwdenk 4400c609719bSwdenk* For new features: a description of the feature and your 4401c609719bSwdenk implementation. 4402c609719bSwdenk 4403c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch) 4404c609719bSwdenk 4405c609719bSwdenk* For major contributions, your entry to the CREDITS file 4406c609719bSwdenk 4407c609719bSwdenk* When you add support for a new board, don't forget to add this 4408c609719bSwdenk board to the MAKEALL script, too. 4409c609719bSwdenk 4410c609719bSwdenk* If your patch adds new configuration options, don't forget to 4411c609719bSwdenk document these in the README file. 4412c609719bSwdenk 4413218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly* 4414218ca724SWolfgang Denk recommended) you can easily generate the patch using the 4415218ca724SWolfgang Denk "git-format-patch". If you then use "git-send-email" to send it to 4416218ca724SWolfgang Denk the U-Boot mailing list, you will avoid most of the common problems 4417218ca724SWolfgang Denk with some other mail clients. 4418c609719bSwdenk 4419218ca724SWolfgang Denk If you cannot use git, use "diff -purN OLD NEW". If your version of 4420218ca724SWolfgang Denk diff does not support these options, then get the latest version of 4421218ca724SWolfgang Denk GNU diff. 44226dff5529Swdenk 4423218ca724SWolfgang Denk The current directory when running this command shall be the parent 4424218ca724SWolfgang Denk directory of the U-Boot source tree (i. e. please make sure that 4425218ca724SWolfgang Denk your patch includes sufficient directory information for the 4426218ca724SWolfgang Denk affected files). 4427218ca724SWolfgang Denk 4428218ca724SWolfgang Denk We prefer patches as plain text. MIME attachments are discouraged, 4429218ca724SWolfgang Denk and compressed attachments must not be used. 4430c609719bSwdenk 443152f52c14Swdenk* If one logical set of modifications affects or creates several 443252f52c14Swdenk files, all these changes shall be submitted in a SINGLE patch file. 443352f52c14Swdenk 443452f52c14Swdenk* Changesets that contain different, unrelated modifications shall be 443552f52c14Swdenk submitted as SEPARATE patches, one patch per changeset. 443652f52c14Swdenk 443752f52c14Swdenk 4438c609719bSwdenkNotes: 4439c609719bSwdenk 4440c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched 4441c609719bSwdenk source tree and make sure that no errors or warnings are reported 4442c609719bSwdenk for any of the boards. 4443c609719bSwdenk 4444c609719bSwdenk* Keep your modifications to the necessary minimum: A patch 4445c609719bSwdenk containing several unrelated changes or arbitrary reformats will be 4446c609719bSwdenk returned with a request to re-formatting / split it. 4447c609719bSwdenk 4448c609719bSwdenk* If you modify existing code, make sure that your new code does not 4449c609719bSwdenk add to the memory footprint of the code ;-) Small is beautiful! 4450c609719bSwdenk When adding new features, these should compile conditionally only 4451c609719bSwdenk (using #ifdef), and the resulting code with the new feature 4452c609719bSwdenk disabled must not need more memory than the old code without your 4453c609719bSwdenk modification. 445490dc6704Swdenk 44550668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the 44560668236bSWolfgang Denk u-boot mailing list. Bigger patches will be moderated. If they are 44570668236bSWolfgang Denk reasonable and not too big, they will be acknowledged. But patches 44580668236bSWolfgang Denk bigger than the size limit should be avoided. 4459