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 1678d321b81SPeter Tyser /i386 Files generic to i386 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 3590b953ffcSMarkus Klotzbuecher- Intel Monahans options: 3606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO 3610b953ffcSMarkus Klotzbuecher 3620b953ffcSMarkus Klotzbuecher Defines the Monahans run mode to oscillator 3630b953ffcSMarkus Klotzbuecher ratio. Valid values are 8, 16, 24, 31. The core 3640b953ffcSMarkus Klotzbuecher frequency is this value multiplied by 13 MHz. 3650b953ffcSMarkus Klotzbuecher 3666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO 3670b953ffcSMarkus Klotzbuecher 3680b953ffcSMarkus Klotzbuecher Defines the Monahans turbo mode to oscillator 3690b953ffcSMarkus Klotzbuecher ratio. Valid values are 1 (default if undefined) and 3700b953ffcSMarkus Klotzbuecher 2. The core frequency as calculated above is multiplied 3710b953ffcSMarkus Klotzbuecher by this value. 3720b953ffcSMarkus Klotzbuecher 3735da627a4Swdenk- Linux Kernel Interface: 374c609719bSwdenk CONFIG_CLOCKS_IN_MHZ 375c609719bSwdenk 376c609719bSwdenk U-Boot stores all clock information in Hz 377c609719bSwdenk internally. For binary compatibility with older Linux 378c609719bSwdenk kernels (which expect the clocks passed in the 379c609719bSwdenk bd_info data to be in MHz) the environment variable 380c609719bSwdenk "clocks_in_mhz" can be defined so that U-Boot 381c609719bSwdenk converts clock data to MHZ before passing it to the 382c609719bSwdenk Linux kernel. 383c609719bSwdenk When CONFIG_CLOCKS_IN_MHZ is defined, a definition of 384c609719bSwdenk "clocks_in_mhz=1" is automatically included in the 385c609719bSwdenk default environment. 386c609719bSwdenk 3875da627a4Swdenk CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only] 3885da627a4Swdenk 38911ccc33fSMarcel Ziswiler When transferring memsize parameter to linux, some versions 3905da627a4Swdenk expect it to be in bytes, others in MB. 3915da627a4Swdenk Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes. 3925da627a4Swdenk 393fec6d9eeSGerald Van Baren CONFIG_OF_LIBFDT 394f57f70aaSWolfgang Denk 395f57f70aaSWolfgang Denk New kernel versions are expecting firmware settings to be 396213bf8c8SGerald Van Baren passed using flattened device trees (based on open firmware 397213bf8c8SGerald Van Baren concepts). 398213bf8c8SGerald Van Baren 399213bf8c8SGerald Van Baren CONFIG_OF_LIBFDT 400213bf8c8SGerald Van Baren * New libfdt-based support 401213bf8c8SGerald Van Baren * Adds the "fdt" command 4023bb342fcSKim Phillips * The bootm command automatically updates the fdt 403213bf8c8SGerald Van Baren 404b55ae402SMarcel Ziswiler OF_CPU - The proper name of the cpus node (only required for 405b55ae402SMarcel Ziswiler MPC512X and MPC5xxx based boards). 406b55ae402SMarcel Ziswiler OF_SOC - The proper name of the soc node (only required for 407b55ae402SMarcel Ziswiler MPC512X and MPC5xxx based boards). 408f57f70aaSWolfgang Denk OF_TBCLK - The timebase frequency. 409c2871f03SKumar Gala OF_STDOUT_PATH - The path to the console device 410f57f70aaSWolfgang Denk 41111ccc33fSMarcel Ziswiler boards with QUICC Engines require OF_QE to set UCC MAC 41211ccc33fSMarcel Ziswiler addresses 4133bb342fcSKim Phillips 4144e253137SKumar Gala CONFIG_OF_BOARD_SETUP 4154e253137SKumar Gala 4164e253137SKumar Gala Board code has addition modification that it wants to make 4174e253137SKumar Gala to the flat device tree before handing it off to the kernel 4186705d81eSwdenk 4190267768eSMatthew McClintock CONFIG_OF_BOOT_CPU 4200267768eSMatthew McClintock 42111ccc33fSMarcel Ziswiler This define fills in the correct boot CPU in the boot 4220267768eSMatthew McClintock param header, the default value is zero if undefined. 4230267768eSMatthew McClintock 4243887c3fbSHeiko Schocher CONFIG_OF_IDE_FIXUP 4253887c3fbSHeiko Schocher 4263887c3fbSHeiko Schocher U-Boot can detect if an IDE device is present or not. 4273887c3fbSHeiko Schocher If not, and this new config option is activated, U-Boot 4283887c3fbSHeiko Schocher removes the ATA node from the DTS before booting Linux, 4293887c3fbSHeiko Schocher so the Linux IDE driver does not probe the device and 4303887c3fbSHeiko Schocher crash. This is needed for buggy hardware (uc101) where 4313887c3fbSHeiko Schocher no pull down resistor is connected to the signal IDE5V_DD7. 4323887c3fbSHeiko Schocher 4330b2f4ecaSNiklaus Giger- vxWorks boot parameters: 4340b2f4ecaSNiklaus Giger 4350b2f4ecaSNiklaus Giger bootvx constructs a valid bootline using the following 4360b2f4ecaSNiklaus Giger environments variables: bootfile, ipaddr, serverip, hostname. 4370b2f4ecaSNiklaus Giger It loads the vxWorks image pointed bootfile. 4380b2f4ecaSNiklaus Giger 4390b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name 4400b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address 4410b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server 4420b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters 4430b2f4ecaSNiklaus Giger 4440b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_ADD_PARAMS 4450b2f4ecaSNiklaus Giger 4460b2f4ecaSNiklaus Giger Add it at the end of the bootline. E.g "u=username pw=secret" 4470b2f4ecaSNiklaus Giger 4480b2f4ecaSNiklaus Giger Note: If a "bootargs" environment is defined, it will overwride 4490b2f4ecaSNiklaus Giger the defaults discussed just above. 4500b2f4ecaSNiklaus Giger 4516705d81eSwdenk- Serial Ports: 45248d0192fSAndreas Engel CONFIG_PL010_SERIAL 4536705d81eSwdenk 4546705d81eSwdenk Define this if you want support for Amba PrimeCell PL010 UARTs. 4556705d81eSwdenk 45648d0192fSAndreas Engel CONFIG_PL011_SERIAL 4576705d81eSwdenk 4586705d81eSwdenk Define this if you want support for Amba PrimeCell PL011 UARTs. 4596705d81eSwdenk 4606705d81eSwdenk CONFIG_PL011_CLOCK 4616705d81eSwdenk 4626705d81eSwdenk If you have Amba PrimeCell PL011 UARTs, set this variable to 4636705d81eSwdenk the clock speed of the UARTs. 4646705d81eSwdenk 4656705d81eSwdenk CONFIG_PL01x_PORTS 4666705d81eSwdenk 4676705d81eSwdenk If you have Amba PrimeCell PL010 or PL011 UARTs on your board, 4686705d81eSwdenk define this to a list of base addresses for each (supported) 4696705d81eSwdenk port. See e.g. include/configs/versatile.h 4706705d81eSwdenk 4716705d81eSwdenk 472c609719bSwdenk- Console Interface: 473c609719bSwdenk Depending on board, define exactly one serial port 474c609719bSwdenk (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2, 475c609719bSwdenk CONFIG_8xx_CONS_SCC1, ...), or switch off the serial 476c609719bSwdenk console by defining CONFIG_8xx_CONS_NONE 477c609719bSwdenk 478c609719bSwdenk Note: if CONFIG_8xx_CONS_NONE is defined, the serial 479c609719bSwdenk port routines must be defined elsewhere 480c609719bSwdenk (i.e. serial_init(), serial_getc(), ...) 481c609719bSwdenk 482c609719bSwdenk CONFIG_CFB_CONSOLE 483c609719bSwdenk Enables console device for a color framebuffer. Needs following 484c609719bSwdenk defines (cf. smiLynxEM, i8042, board/eltec/bab7xx) 485c609719bSwdenk VIDEO_FB_LITTLE_ENDIAN graphic memory organisation 486c609719bSwdenk (default big endian) 487c609719bSwdenk VIDEO_HW_RECTFILL graphic chip supports 488c609719bSwdenk rectangle fill 489c609719bSwdenk (cf. smiLynxEM) 490c609719bSwdenk VIDEO_HW_BITBLT graphic chip supports 491c609719bSwdenk bit-blit (cf. smiLynxEM) 492c609719bSwdenk VIDEO_VISIBLE_COLS visible pixel columns 493c609719bSwdenk (cols=pitch) 494c609719bSwdenk VIDEO_VISIBLE_ROWS visible pixel rows 495c609719bSwdenk VIDEO_PIXEL_SIZE bytes per pixel 496c609719bSwdenk VIDEO_DATA_FORMAT graphic data format 497c609719bSwdenk (0-5, cf. cfb_console.c) 498c609719bSwdenk VIDEO_FB_ADRS framebuffer address 499c609719bSwdenk VIDEO_KBD_INIT_FCT keyboard int fct 500c609719bSwdenk (i.e. i8042_kbd_init()) 501c609719bSwdenk VIDEO_TSTC_FCT test char fct 502c609719bSwdenk (i.e. i8042_tstc) 503c609719bSwdenk VIDEO_GETC_FCT get char fct 504c609719bSwdenk (i.e. i8042_getc) 505c609719bSwdenk CONFIG_CONSOLE_CURSOR cursor drawing on/off 506c609719bSwdenk (requires blink timer 507c609719bSwdenk cf. i8042.c) 5086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c) 509c609719bSwdenk CONFIG_CONSOLE_TIME display time/date info in 510c609719bSwdenk upper right corner 511602ad3b3SJon Loeliger (requires CONFIG_CMD_DATE) 512c609719bSwdenk CONFIG_VIDEO_LOGO display Linux logo in 513c609719bSwdenk upper left corner 514a6c7ad2fSwdenk CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of 515a6c7ad2fSwdenk linux_logo.h for logo. 516a6c7ad2fSwdenk Requires CONFIG_VIDEO_LOGO 517c609719bSwdenk CONFIG_CONSOLE_EXTRA_INFO 51811ccc33fSMarcel Ziswiler additional board info beside 519c609719bSwdenk the logo 520c609719bSwdenk 521c609719bSwdenk When CONFIG_CFB_CONSOLE is defined, video console is 522c609719bSwdenk default i/o. Serial console can be forced with 523c609719bSwdenk environment 'console=serial'. 524c609719bSwdenk 525a3ad8e26Swdenk When CONFIG_SILENT_CONSOLE is defined, all console 526a3ad8e26Swdenk messages (by U-Boot and Linux!) can be silenced with 527a3ad8e26Swdenk the "silent" environment variable. See 528a3ad8e26Swdenk doc/README.silent for more information. 529a3ad8e26Swdenk 530c609719bSwdenk- Console Baudrate: 531c609719bSwdenk CONFIG_BAUDRATE - in bps 532c609719bSwdenk Select one of the baudrates listed in 5336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BAUDRATE_TABLE, see below. 5346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale 535c609719bSwdenk 536c92fac91SHeiko Schocher- Console Rx buffer length 537c92fac91SHeiko Schocher With CONFIG_SYS_SMC_RXBUFLEN it is possible to define 538c92fac91SHeiko Schocher the maximum receive buffer length for the SMC. 5392b3f12c2SHeiko Schocher This option is actual only for 82xx and 8xx possible. 540c92fac91SHeiko Schocher If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE 541c92fac91SHeiko Schocher must be defined, to setup the maximum idle timeout for 542c92fac91SHeiko Schocher the SMC. 543c92fac91SHeiko Schocher 544c609719bSwdenk- Boot Delay: CONFIG_BOOTDELAY - in seconds 545c609719bSwdenk Delay before automatically booting the default image; 546c609719bSwdenk set to -1 to disable autoboot. 547c609719bSwdenk 548c609719bSwdenk See doc/README.autoboot for these options that 549c609719bSwdenk work with CONFIG_BOOTDELAY. None are required. 550c609719bSwdenk CONFIG_BOOT_RETRY_TIME 551c609719bSwdenk CONFIG_BOOT_RETRY_MIN 552c609719bSwdenk CONFIG_AUTOBOOT_KEYED 553c609719bSwdenk CONFIG_AUTOBOOT_PROMPT 554c609719bSwdenk CONFIG_AUTOBOOT_DELAY_STR 555c609719bSwdenk CONFIG_AUTOBOOT_STOP_STR 556c609719bSwdenk CONFIG_AUTOBOOT_DELAY_STR2 557c609719bSwdenk CONFIG_AUTOBOOT_STOP_STR2 558c609719bSwdenk CONFIG_ZERO_BOOTDELAY_CHECK 559c609719bSwdenk CONFIG_RESET_TO_RETRY 560c609719bSwdenk 561c609719bSwdenk- Autoboot Command: 562c609719bSwdenk CONFIG_BOOTCOMMAND 563c609719bSwdenk Only needed when CONFIG_BOOTDELAY is enabled; 564c609719bSwdenk define a command string that is automatically executed 565c609719bSwdenk when no character is read on the console interface 566c609719bSwdenk within "Boot Delay" after reset. 567c609719bSwdenk 568c609719bSwdenk CONFIG_BOOTARGS 569c609719bSwdenk This can be used to pass arguments to the bootm 570c609719bSwdenk command. The value of CONFIG_BOOTARGS goes into the 571c609719bSwdenk environment value "bootargs". 572c609719bSwdenk 573c609719bSwdenk CONFIG_RAMBOOT and CONFIG_NFSBOOT 574c609719bSwdenk The value of these goes into the environment as 575c609719bSwdenk "ramboot" and "nfsboot" respectively, and can be used 576c609719bSwdenk as a convenience, when switching between booting from 57711ccc33fSMarcel Ziswiler RAM and NFS. 578c609719bSwdenk 579c609719bSwdenk- Pre-Boot Commands: 580c609719bSwdenk CONFIG_PREBOOT 581c609719bSwdenk 582c609719bSwdenk When this option is #defined, the existence of the 583c609719bSwdenk environment variable "preboot" will be checked 584c609719bSwdenk immediately before starting the CONFIG_BOOTDELAY 585c609719bSwdenk countdown and/or running the auto-boot command resp. 586c609719bSwdenk entering interactive mode. 587c609719bSwdenk 588c609719bSwdenk This feature is especially useful when "preboot" is 589c609719bSwdenk automatically generated or modified. For an example 590c609719bSwdenk see the LWMON board specific code: here "preboot" is 591c609719bSwdenk modified when the user holds down a certain 592c609719bSwdenk combination of keys on the (special) keyboard when 593c609719bSwdenk booting the systems 594c609719bSwdenk 595c609719bSwdenk- Serial Download Echo Mode: 596c609719bSwdenk CONFIG_LOADS_ECHO 597c609719bSwdenk If defined to 1, all characters received during a 598c609719bSwdenk serial download (using the "loads" command) are 599c609719bSwdenk echoed back. This might be needed by some terminal 600c609719bSwdenk emulations (like "cu"), but may as well just take 601c609719bSwdenk time on others. This setting #define's the initial 602c609719bSwdenk value of the "loads_echo" environment variable. 603c609719bSwdenk 604602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined) 605c609719bSwdenk CONFIG_KGDB_BAUDRATE 606c609719bSwdenk Select one of the baudrates listed in 6076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BAUDRATE_TABLE, see below. 608c609719bSwdenk 609c609719bSwdenk- Monitor Functions: 610602ad3b3SJon Loeliger Monitor commands can be included or excluded 611602ad3b3SJon Loeliger from the build by using the #include files 612602ad3b3SJon Loeliger "config_cmd_all.h" and #undef'ing unwanted 613602ad3b3SJon Loeliger commands, or using "config_cmd_default.h" 614602ad3b3SJon Loeliger and augmenting with additional #define's 615602ad3b3SJon Loeliger for wanted commands. 616c609719bSwdenk 617602ad3b3SJon Loeliger The default command configuration includes all commands 618602ad3b3SJon Loeliger except those marked below with a "*". 619602ad3b3SJon Loeliger 620602ad3b3SJon Loeliger CONFIG_CMD_ASKENV * ask for env variable 621602ad3b3SJon Loeliger CONFIG_CMD_BDI bdinfo 622602ad3b3SJon Loeliger CONFIG_CMD_BEDBUG * Include BedBug Debugger 623602ad3b3SJon Loeliger CONFIG_CMD_BMP * BMP support 624602ad3b3SJon Loeliger CONFIG_CMD_BSP * Board specific commands 625602ad3b3SJon Loeliger CONFIG_CMD_BOOTD bootd 626602ad3b3SJon Loeliger CONFIG_CMD_CACHE * icache, dcache 627602ad3b3SJon Loeliger CONFIG_CMD_CONSOLE coninfo 628602ad3b3SJon Loeliger CONFIG_CMD_DATE * support for RTC, date/time... 629602ad3b3SJon Loeliger CONFIG_CMD_DHCP * DHCP support 630602ad3b3SJon Loeliger CONFIG_CMD_DIAG * Diagnostics 631a7c93104SPeter Tyser CONFIG_CMD_DS4510 * ds4510 I2C gpio commands 632a7c93104SPeter Tyser CONFIG_CMD_DS4510_INFO * ds4510 I2C info command 633a7c93104SPeter Tyser CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd 634a7c93104SPeter Tyser CONFIG_CMD_DS4510_RST * ds4510 I2C rst command 635602ad3b3SJon Loeliger CONFIG_CMD_DTT * Digital Therm and Thermostat 636602ad3b3SJon Loeliger CONFIG_CMD_ECHO echo arguments 637246c6922SPeter Tyser CONFIG_CMD_EDITENV edit env variable 638602ad3b3SJon Loeliger CONFIG_CMD_EEPROM * EEPROM read/write support 639602ad3b3SJon Loeliger CONFIG_CMD_ELF * bootelf, bootvx 6400c79cda0SMike Frysinger CONFIG_CMD_EXPORTENV * export the environment 641bdab39d3SMike Frysinger CONFIG_CMD_SAVEENV saveenv 642602ad3b3SJon Loeliger CONFIG_CMD_FDC * Floppy Disk Support 643602ad3b3SJon Loeliger CONFIG_CMD_FAT * FAT partition support 644602ad3b3SJon Loeliger CONFIG_CMD_FDOS * Dos diskette Support 645602ad3b3SJon Loeliger CONFIG_CMD_FLASH flinfo, erase, protect 646602ad3b3SJon Loeliger CONFIG_CMD_FPGA FPGA device initialization support 647*a641b979SMike Frysinger CONFIG_CMD_GO * the 'go' command (exec code) 648602ad3b3SJon Loeliger CONFIG_CMD_HWFLOW * RTS/CTS hw flow control 649602ad3b3SJon Loeliger CONFIG_CMD_I2C * I2C serial bus support 650602ad3b3SJon Loeliger CONFIG_CMD_IDE * IDE harddisk support 651602ad3b3SJon Loeliger CONFIG_CMD_IMI iminfo 652602ad3b3SJon Loeliger CONFIG_CMD_IMLS List all found images 653602ad3b3SJon Loeliger CONFIG_CMD_IMMAP * IMMR dump support 6540c79cda0SMike Frysinger CONFIG_CMD_IMPORTENV * import an environment 655602ad3b3SJon Loeliger CONFIG_CMD_IRQ * irqinfo 656602ad3b3SJon Loeliger CONFIG_CMD_ITEST Integer/string test of 2 values 657602ad3b3SJon Loeliger CONFIG_CMD_JFFS2 * JFFS2 Support 658602ad3b3SJon Loeliger CONFIG_CMD_KGDB * kgdb 6591ba7fd25SMike Frysinger CONFIG_CMD_LDRINFO ldrinfo (display Blackfin loader) 660602ad3b3SJon Loeliger CONFIG_CMD_LOADB loadb 661602ad3b3SJon Loeliger CONFIG_CMD_LOADS loads 66202c9aa1dSRobin Getz CONFIG_CMD_MD5SUM print md5 message digest 66302c9aa1dSRobin Getz (requires CONFIG_CMD_MEMORY and CONFIG_MD5) 664602ad3b3SJon Loeliger CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base, 66556523f12Swdenk loop, loopw, mtest 666602ad3b3SJon Loeliger CONFIG_CMD_MISC Misc functions like sleep etc 667602ad3b3SJon Loeliger CONFIG_CMD_MMC * MMC memory mapped support 668602ad3b3SJon Loeliger CONFIG_CMD_MII * MII utility commands 66968d7d651SStefan Roese CONFIG_CMD_MTDPARTS * MTD partition support 670602ad3b3SJon Loeliger CONFIG_CMD_NAND * NAND support 671602ad3b3SJon Loeliger CONFIG_CMD_NET bootp, tftpboot, rarpboot 672e92739d3SPeter Tyser CONFIG_CMD_PCA953X * PCA953x I2C gpio commands 673e92739d3SPeter Tyser CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command 674602ad3b3SJon Loeliger CONFIG_CMD_PCI * pciinfo 675602ad3b3SJon Loeliger CONFIG_CMD_PCMCIA * PCMCIA support 676602ad3b3SJon Loeliger CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network 677602ad3b3SJon Loeliger host 678602ad3b3SJon Loeliger CONFIG_CMD_PORTIO * Port I/O 679602ad3b3SJon Loeliger CONFIG_CMD_REGINFO * Register dump 680602ad3b3SJon Loeliger CONFIG_CMD_RUN run command in env variable 681602ad3b3SJon Loeliger CONFIG_CMD_SAVES * save S record dump 682602ad3b3SJon Loeliger CONFIG_CMD_SCSI * SCSI Support 683602ad3b3SJon Loeliger CONFIG_CMD_SDRAM * print SDRAM configuration information 684602ad3b3SJon Loeliger (requires CONFIG_CMD_I2C) 685602ad3b3SJon Loeliger CONFIG_CMD_SETGETDCR Support for DCR Register access 686602ad3b3SJon Loeliger (4xx only) 687c6b1ee66SAlexander Holler CONFIG_CMD_SHA1SUM print sha1 memory digest 68802c9aa1dSRobin Getz (requires CONFIG_CMD_MEMORY) 68974de7aefSWolfgang Denk CONFIG_CMD_SOURCE "source" command Support 690602ad3b3SJon Loeliger CONFIG_CMD_SPI * SPI serial bus support 691602ad3b3SJon Loeliger CONFIG_CMD_USB * USB support 692602ad3b3SJon Loeliger CONFIG_CMD_VFD * VFD support (TRAB) 693602ad3b3SJon Loeliger CONFIG_CMD_CDP * Cisco Discover Protocol support 694602ad3b3SJon Loeliger CONFIG_CMD_FSL * Microblaze FSL support 695c609719bSwdenk 696c609719bSwdenk 697c609719bSwdenk EXAMPLE: If you want all functions except of network 698c609719bSwdenk support you can write: 699c609719bSwdenk 700602ad3b3SJon Loeliger #include "config_cmd_all.h" 701602ad3b3SJon Loeliger #undef CONFIG_CMD_NET 702c609719bSwdenk 703213bf8c8SGerald Van Baren Other Commands: 704213bf8c8SGerald Van Baren fdt (flattened device tree) command: CONFIG_OF_LIBFDT 705c609719bSwdenk 706c609719bSwdenk Note: Don't enable the "icache" and "dcache" commands 707602ad3b3SJon Loeliger (configuration option CONFIG_CMD_CACHE) unless you know 708c609719bSwdenk what you (and your U-Boot users) are doing. Data 709c609719bSwdenk cache cannot be enabled on systems like the 8xx or 710c609719bSwdenk 8260 (where accesses to the IMMR region must be 711c609719bSwdenk uncached), and it cannot be disabled on all other 712c609719bSwdenk systems where we (mis-) use the data cache to hold an 713c609719bSwdenk initial stack and some data. 714c609719bSwdenk 715c609719bSwdenk 716c609719bSwdenk XXX - this list needs to get updated! 717c609719bSwdenk 718c609719bSwdenk- Watchdog: 719c609719bSwdenk CONFIG_WATCHDOG 720c609719bSwdenk If this variable is defined, it enables watchdog 7217152b1d0Swdenk support. There must be support in the platform specific 722c609719bSwdenk code for a watchdog. For the 8xx and 8260 CPUs, the 723c609719bSwdenk SIU Watchdog feature is enabled in the SYPCR 724c609719bSwdenk register. 725c609719bSwdenk 726c1551ea8Sstroese- U-Boot Version: 727c1551ea8Sstroese CONFIG_VERSION_VARIABLE 728c1551ea8Sstroese If this variable is defined, an environment variable 729c1551ea8Sstroese named "ver" is created by U-Boot showing the U-Boot 730c1551ea8Sstroese version as printed by the "version" command. 731c1551ea8Sstroese This variable is readonly. 732c1551ea8Sstroese 733c609719bSwdenk- Real-Time Clock: 734c609719bSwdenk 735602ad3b3SJon Loeliger When CONFIG_CMD_DATE is selected, the type of the RTC 736c609719bSwdenk has to be selected, too. Define exactly one of the 737c609719bSwdenk following options: 738c609719bSwdenk 739c609719bSwdenk CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx 740c609719bSwdenk CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC 7417ce63709SGuennadi Liakhovetski CONFIG_RTC_MC13783 - use MC13783 RTC 742c609719bSwdenk CONFIG_RTC_MC146818 - use MC146818 RTC 7431cb8e980Swdenk CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC 744c609719bSwdenk CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC 7457f70e853Swdenk CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC 7463bac3513Swdenk CONFIG_RTC_DS164x - use Dallas DS164x RTC 7479536dfccSTor Krill CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC 7484c0d4c3bSwdenk CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC 7496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337 750c609719bSwdenk 751b37c7e5eSwdenk Note that if the RTC uses I2C, then the I2C interface 752b37c7e5eSwdenk must also be configured. See I2C Support, below. 753b37c7e5eSwdenk 754e92739d3SPeter Tyser- GPIO Support: 755e92739d3SPeter Tyser CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO 756e92739d3SPeter Tyser CONFIG_PCA953X_INFO - enable pca953x info command 757e92739d3SPeter Tyser 7585dec49caSChris Packham The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of 7595dec49caSChris Packham chip-ngpio pairs that tell the PCA953X driver the number of 7605dec49caSChris Packham pins supported by a particular chip. 7615dec49caSChris Packham 762e92739d3SPeter Tyser Note that if the GPIO device uses I2C, then the I2C interface 763e92739d3SPeter Tyser must also be configured. See I2C Support, below. 764e92739d3SPeter Tyser 765c609719bSwdenk- Timestamp Support: 766c609719bSwdenk 767c609719bSwdenk When CONFIG_TIMESTAMP is selected, the timestamp 768c609719bSwdenk (date and time) of an image is printed by image 769c609719bSwdenk commands like bootm or iminfo. This option is 770602ad3b3SJon Loeliger automatically enabled when you select CONFIG_CMD_DATE . 771c609719bSwdenk 772c609719bSwdenk- Partition Support: 773c609719bSwdenk CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION 77407f3d789Srichardretanubun and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION 775c609719bSwdenk 776602ad3b3SJon Loeliger If IDE or SCSI support is enabled (CONFIG_CMD_IDE or 777218ca724SWolfgang Denk CONFIG_CMD_SCSI) you must configure support for at 778218ca724SWolfgang Denk least one partition type as well. 779c609719bSwdenk 780c609719bSwdenk- IDE Reset method: 7814d13cbadSwdenk CONFIG_IDE_RESET_ROUTINE - this is defined in several 7824d13cbadSwdenk board configurations files but used nowhere! 783c609719bSwdenk 7844d13cbadSwdenk CONFIG_IDE_RESET - is this is defined, IDE Reset will 7854d13cbadSwdenk be performed by calling the function 7864d13cbadSwdenk ide_set_reset(int reset) 7874d13cbadSwdenk which has to be defined in a board specific file 788c609719bSwdenk 789c609719bSwdenk- ATAPI Support: 790c609719bSwdenk CONFIG_ATAPI 791c609719bSwdenk 792c609719bSwdenk Set this to enable ATAPI support. 793c609719bSwdenk 794c40b2956Swdenk- LBA48 Support 795c40b2956Swdenk CONFIG_LBA48 796c40b2956Swdenk 797c40b2956Swdenk Set this to enable support for disks larger than 137GB 7984b142febSHeiko Schocher Also look at CONFIG_SYS_64BIT_LBA. 799c40b2956Swdenk Whithout these , LBA48 support uses 32bit variables and will 'only' 800c40b2956Swdenk support disks up to 2.1TB. 801c40b2956Swdenk 8026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_64BIT_LBA: 803c40b2956Swdenk When enabled, makes the IDE subsystem use 64bit sector addresses. 804c40b2956Swdenk Default is 32bit. 805c40b2956Swdenk 806c609719bSwdenk- SCSI Support: 807c609719bSwdenk At the moment only there is only support for the 808c609719bSwdenk SYM53C8XX SCSI controller; define 809c609719bSwdenk CONFIG_SCSI_SYM53C8XX to enable it. 810c609719bSwdenk 8116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and 8126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID * 8136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the 814c609719bSwdenk maximum numbers of LUNs, SCSI ID's and target 815c609719bSwdenk devices. 8166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz) 817c609719bSwdenk 818c609719bSwdenk- NETWORK Support (PCI): 819682011ffSwdenk CONFIG_E1000 820682011ffSwdenk Support for Intel 8254x gigabit chips. 821682011ffSwdenk 822ac3315c2SAndre Schwarz CONFIG_E1000_FALLBACK_MAC 82311ccc33fSMarcel Ziswiler default MAC for empty EEPROM after production. 824ac3315c2SAndre Schwarz 825c609719bSwdenk CONFIG_EEPRO100 826c609719bSwdenk Support for Intel 82557/82559/82559ER chips. 82711ccc33fSMarcel Ziswiler Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM 828c609719bSwdenk write routine for first time initialisation. 829c609719bSwdenk 830c609719bSwdenk CONFIG_TULIP 831c609719bSwdenk Support for Digital 2114x chips. 832c609719bSwdenk Optional CONFIG_TULIP_SELECT_MEDIA for board specific 833c609719bSwdenk modem chip initialisation (KS8761/QS6611). 834c609719bSwdenk 835c609719bSwdenk CONFIG_NATSEMI 836c609719bSwdenk Support for National dp83815 chips. 837c609719bSwdenk 838c609719bSwdenk CONFIG_NS8382X 839c609719bSwdenk Support for National dp8382[01] gigabit chips. 840c609719bSwdenk 84145219c46Swdenk- NETWORK Support (other): 84245219c46Swdenk 843c041e9d2SJens Scharsig CONFIG_DRIVER_AT91EMAC 844c041e9d2SJens Scharsig Support for AT91RM9200 EMAC. 845c041e9d2SJens Scharsig 846c041e9d2SJens Scharsig CONFIG_RMII 847c041e9d2SJens Scharsig Define this to use reduced MII inteface 848c041e9d2SJens Scharsig 849c041e9d2SJens Scharsig CONFIG_DRIVER_AT91EMAC_QUIET 850c041e9d2SJens Scharsig If this defined, the driver is quiet. 851c041e9d2SJens Scharsig The driver doen't show link status messages. 852c041e9d2SJens Scharsig 85345219c46Swdenk CONFIG_DRIVER_LAN91C96 85445219c46Swdenk Support for SMSC's LAN91C96 chips. 85545219c46Swdenk 85645219c46Swdenk CONFIG_LAN91C96_BASE 85745219c46Swdenk Define this to hold the physical address 85845219c46Swdenk of the LAN91C96's I/O space 85945219c46Swdenk 86045219c46Swdenk CONFIG_LAN91C96_USE_32_BIT 86145219c46Swdenk Define this to enable 32 bit addressing 86245219c46Swdenk 863f39748aeSwdenk CONFIG_DRIVER_SMC91111 864f39748aeSwdenk Support for SMSC's LAN91C111 chip 865f39748aeSwdenk 866f39748aeSwdenk CONFIG_SMC91111_BASE 867f39748aeSwdenk Define this to hold the physical address 868f39748aeSwdenk of the device (I/O space) 869f39748aeSwdenk 870f39748aeSwdenk CONFIG_SMC_USE_32_BIT 871f39748aeSwdenk Define this if data bus is 32 bits 872f39748aeSwdenk 873f39748aeSwdenk CONFIG_SMC_USE_IOFUNCS 874f39748aeSwdenk Define this to use i/o functions instead of macros 875f39748aeSwdenk (some hardware wont work with macros) 876f39748aeSwdenk 877b3dbf4a5SMacpaul Lin CONFIG_FTGMAC100 878b3dbf4a5SMacpaul Lin Support for Faraday's FTGMAC100 Gigabit SoC Ethernet 879b3dbf4a5SMacpaul Lin 880b3dbf4a5SMacpaul Lin CONFIG_FTGMAC100_EGIGA 881b3dbf4a5SMacpaul Lin Define this to use GE link update with gigabit PHY. 882b3dbf4a5SMacpaul Lin Define this if FTGMAC100 is connected to gigabit PHY. 883b3dbf4a5SMacpaul Lin If your system has 10/100 PHY only, it might not occur 884b3dbf4a5SMacpaul Lin wrong behavior. Because PHY usually return timeout or 885b3dbf4a5SMacpaul Lin useless data when polling gigabit status and gigabit 886b3dbf4a5SMacpaul Lin control registers. This behavior won't affect the 887b3dbf4a5SMacpaul Lin correctnessof 10/100 link speed update. 888b3dbf4a5SMacpaul Lin 889c2fff331SMike Rapoport CONFIG_SMC911X 890557b377dSJens Gehrlein Support for SMSC's LAN911x and LAN921x chips 891557b377dSJens Gehrlein 892c2fff331SMike Rapoport CONFIG_SMC911X_BASE 893557b377dSJens Gehrlein Define this to hold the physical address 894557b377dSJens Gehrlein of the device (I/O space) 895557b377dSJens Gehrlein 896c2fff331SMike Rapoport CONFIG_SMC911X_32_BIT 897557b377dSJens Gehrlein Define this if data bus is 32 bits 898557b377dSJens Gehrlein 899c2fff331SMike Rapoport CONFIG_SMC911X_16_BIT 900557b377dSJens Gehrlein Define this if data bus is 16 bits. If your processor 901557b377dSJens Gehrlein automatically converts one 32 bit word to two 16 bit 902c2fff331SMike Rapoport words you may also try CONFIG_SMC911X_32_BIT. 903557b377dSJens Gehrlein 9043d0075faSYoshihiro Shimoda CONFIG_SH_ETHER 9053d0075faSYoshihiro Shimoda Support for Renesas on-chip Ethernet controller 9063d0075faSYoshihiro Shimoda 9073d0075faSYoshihiro Shimoda CONFIG_SH_ETHER_USE_PORT 9083d0075faSYoshihiro Shimoda Define the number of ports to be used 9093d0075faSYoshihiro Shimoda 9103d0075faSYoshihiro Shimoda CONFIG_SH_ETHER_PHY_ADDR 9113d0075faSYoshihiro Shimoda Define the ETH PHY's address 9123d0075faSYoshihiro Shimoda 91368260aabSYoshihiro Shimoda CONFIG_SH_ETHER_CACHE_WRITEBACK 91468260aabSYoshihiro Shimoda If this option is set, the driver enables cache flush. 91568260aabSYoshihiro Shimoda 916c609719bSwdenk- USB Support: 917c609719bSwdenk At the moment only the UHCI host controller is 9184d13cbadSwdenk supported (PIP405, MIP405, MPC5200); define 919c609719bSwdenk CONFIG_USB_UHCI to enable it. 920c609719bSwdenk define CONFIG_USB_KEYBOARD to enable the USB Keyboard 92130d56faeSwdenk and define CONFIG_USB_STORAGE to enable the USB 922c609719bSwdenk storage devices. 923c609719bSwdenk Note: 924c609719bSwdenk Supported are USB Keyboards and USB Floppy drives 925c609719bSwdenk (TEAC FD-05PUB). 9264d13cbadSwdenk MPC5200 USB requires additional defines: 9274d13cbadSwdenk CONFIG_USB_CLOCK 9284d13cbadSwdenk for 528 MHz Clock: 0x0001bbbb 929307ecb6dSEric Millbrandt CONFIG_PSC3_USB 930307ecb6dSEric Millbrandt for USB on PSC3 9314d13cbadSwdenk CONFIG_USB_CONFIG 9324d13cbadSwdenk for differential drivers: 0x00001000 9334d13cbadSwdenk for single ended drivers: 0x00005000 934307ecb6dSEric Millbrandt for differential drivers on PSC3: 0x00000100 935307ecb6dSEric Millbrandt for single ended drivers on PSC3: 0x00004100 9366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_USB_EVENT_POLL 937fdcfaa1bSZhang Wei May be defined to allow interrupt polling 938fdcfaa1bSZhang Wei instead of using asynchronous interrupts 9394d13cbadSwdenk 94016c8d5e7SWolfgang Denk- USB Device: 94116c8d5e7SWolfgang Denk Define the below if you wish to use the USB console. 94216c8d5e7SWolfgang Denk Once firmware is rebuilt from a serial console issue the 94316c8d5e7SWolfgang Denk command "setenv stdin usbtty; setenv stdout usbtty" and 94411ccc33fSMarcel Ziswiler attach your USB cable. The Unix command "dmesg" should print 94516c8d5e7SWolfgang Denk it has found a new device. The environment variable usbtty 94616c8d5e7SWolfgang Denk can be set to gserial or cdc_acm to enable your device to 94716c8d5e7SWolfgang Denk appear to a USB host as a Linux gserial device or a 94816c8d5e7SWolfgang Denk Common Device Class Abstract Control Model serial device. 94916c8d5e7SWolfgang Denk If you select usbtty = gserial you should be able to enumerate 95016c8d5e7SWolfgang Denk a Linux host by 95116c8d5e7SWolfgang Denk # modprobe usbserial vendor=0xVendorID product=0xProductID 95216c8d5e7SWolfgang Denk else if using cdc_acm, simply setting the environment 95316c8d5e7SWolfgang Denk variable usbtty to be cdc_acm should suffice. The following 95416c8d5e7SWolfgang Denk might be defined in YourBoardName.h 95516c8d5e7SWolfgang Denk 95616c8d5e7SWolfgang Denk CONFIG_USB_DEVICE 95716c8d5e7SWolfgang Denk Define this to build a UDC device 95816c8d5e7SWolfgang Denk 95916c8d5e7SWolfgang Denk CONFIG_USB_TTY 96016c8d5e7SWolfgang Denk Define this to have a tty type of device available to 96116c8d5e7SWolfgang Denk talk to the UDC device 96216c8d5e7SWolfgang Denk 9636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_CONSOLE_IS_IN_ENV 96416c8d5e7SWolfgang Denk Define this if you want stdin, stdout &/or stderr to 96516c8d5e7SWolfgang Denk be set to usbtty. 96616c8d5e7SWolfgang Denk 96716c8d5e7SWolfgang Denk mpc8xx: 9686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_USB_EXTC_CLK 0xBLAH 96916c8d5e7SWolfgang Denk Derive USB clock from external clock "blah" 9706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_USB_EXTC_CLK 0x02 97116c8d5e7SWolfgang Denk 9726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_USB_BRG_CLK 0xBLAH 97316c8d5e7SWolfgang Denk Derive USB clock from brgclk 9746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_USB_BRG_CLK 0x04 97516c8d5e7SWolfgang Denk 97616c8d5e7SWolfgang Denk If you have a USB-IF assigned VendorID then you may wish to 97716c8d5e7SWolfgang Denk define your own vendor specific values either in BoardName.h 97816c8d5e7SWolfgang Denk or directly in usbd_vendor_info.h. If you don't define 97916c8d5e7SWolfgang Denk CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME, 98016c8d5e7SWolfgang Denk CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot 98116c8d5e7SWolfgang Denk should pretend to be a Linux device to it's target host. 98216c8d5e7SWolfgang Denk 98316c8d5e7SWolfgang Denk CONFIG_USBD_MANUFACTURER 98416c8d5e7SWolfgang Denk Define this string as the name of your company for 98516c8d5e7SWolfgang Denk - CONFIG_USBD_MANUFACTURER "my company" 98616c8d5e7SWolfgang Denk 98716c8d5e7SWolfgang Denk CONFIG_USBD_PRODUCT_NAME 98816c8d5e7SWolfgang Denk Define this string as the name of your product 98916c8d5e7SWolfgang Denk - CONFIG_USBD_PRODUCT_NAME "acme usb device" 99016c8d5e7SWolfgang Denk 99116c8d5e7SWolfgang Denk CONFIG_USBD_VENDORID 99216c8d5e7SWolfgang Denk Define this as your assigned Vendor ID from the USB 99316c8d5e7SWolfgang Denk Implementors Forum. This *must* be a genuine Vendor ID 99416c8d5e7SWolfgang Denk to avoid polluting the USB namespace. 99516c8d5e7SWolfgang Denk - CONFIG_USBD_VENDORID 0xFFFF 99616c8d5e7SWolfgang Denk 99716c8d5e7SWolfgang Denk CONFIG_USBD_PRODUCTID 99816c8d5e7SWolfgang Denk Define this as the unique Product ID 99916c8d5e7SWolfgang Denk for your device 100016c8d5e7SWolfgang Denk - CONFIG_USBD_PRODUCTID 0xFFFF 1001c609719bSwdenk 1002c609719bSwdenk 1003c609719bSwdenk- MMC Support: 1004c609719bSwdenk The MMC controller on the Intel PXA is supported. To 1005c609719bSwdenk enable this define CONFIG_MMC. The MMC can be 1006c609719bSwdenk accessed from the boot prompt by mapping the device 1007c609719bSwdenk to physical memory similar to flash. Command line is 1008602ad3b3SJon Loeliger enabled with CONFIG_CMD_MMC. The MMC driver also works with 1009602ad3b3SJon Loeliger the FAT fs. This is enabled with CONFIG_CMD_FAT. 1010c609719bSwdenk 10116705d81eSwdenk- Journaling Flash filesystem support: 10126705d81eSwdenk CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE, 10136705d81eSwdenk CONFIG_JFFS2_NAND_DEV 10146705d81eSwdenk Define these for a default partition on a NAND device 10156705d81eSwdenk 10166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS2_FIRST_SECTOR, 10176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS 10186705d81eSwdenk Define these for a default partition on a NOR device 10196705d81eSwdenk 10206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS_CUSTOM_PART 10216705d81eSwdenk Define this to create an own partition. You have to provide a 10226705d81eSwdenk function struct part_info* jffs2_part_info(int part_num) 10236705d81eSwdenk 10246705d81eSwdenk If you define only one JFFS2 partition you may also want to 10256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_JFFS_SINGLE_PART 1 10266705d81eSwdenk to disable the command chpart. This is the default when you 10276705d81eSwdenk have not defined a custom partition 10286705d81eSwdenk 1029c609719bSwdenk- Keyboard Support: 1030c609719bSwdenk CONFIG_ISA_KEYBOARD 1031c609719bSwdenk 1032c609719bSwdenk Define this to enable standard (PC-Style) keyboard 1033c609719bSwdenk support 1034c609719bSwdenk 1035c609719bSwdenk CONFIG_I8042_KBD 1036c609719bSwdenk Standard PC keyboard driver with US (is default) and 1037c609719bSwdenk GERMAN key layout (switch via environment 'keymap=de') support. 1038c609719bSwdenk Export function i8042_kbd_init, i8042_tstc and i8042_getc 1039c609719bSwdenk for cfb_console. Supports cursor blinking. 1040c609719bSwdenk 1041c609719bSwdenk- Video support: 1042c609719bSwdenk CONFIG_VIDEO 1043c609719bSwdenk 1044c609719bSwdenk Define this to enable video support (for output to 1045c609719bSwdenk video). 1046c609719bSwdenk 1047c609719bSwdenk CONFIG_VIDEO_CT69000 1048c609719bSwdenk 1049c609719bSwdenk Enable Chips & Technologies 69000 Video chip 1050c609719bSwdenk 1051c609719bSwdenk CONFIG_VIDEO_SMI_LYNXEM 1052eeb1b77bSwdenk Enable Silicon Motion SMI 712/710/810 Video chip. The 1053eeb1b77bSwdenk video output is selected via environment 'videoout' 1054eeb1b77bSwdenk (1 = LCD and 2 = CRT). If videoout is undefined, CRT is 1055eeb1b77bSwdenk assumed. 1056c609719bSwdenk 1057eeb1b77bSwdenk For the CT69000 and SMI_LYNXEM drivers, videomode is 105811ccc33fSMarcel Ziswiler selected via environment 'videomode'. Two different ways 1059eeb1b77bSwdenk are possible: 1060eeb1b77bSwdenk - "videomode=num" 'num' is a standard LiLo mode numbers. 1061eeb1b77bSwdenk Following standard modes are supported (* is default): 1062eeb1b77bSwdenk 1063eeb1b77bSwdenk Colors 640x480 800x600 1024x768 1152x864 1280x1024 1064eeb1b77bSwdenk -------------+--------------------------------------------- 1065eeb1b77bSwdenk 8 bits | 0x301* 0x303 0x305 0x161 0x307 1066eeb1b77bSwdenk 15 bits | 0x310 0x313 0x316 0x162 0x319 1067eeb1b77bSwdenk 16 bits | 0x311 0x314 0x317 0x163 0x31A 1068eeb1b77bSwdenk 24 bits | 0x312 0x315 0x318 ? 0x31B 1069eeb1b77bSwdenk -------------+--------------------------------------------- 1070c609719bSwdenk (i.e. setenv videomode 317; saveenv; reset;) 1071c609719bSwdenk 1072eeb1b77bSwdenk - "videomode=bootargs" all the video parameters are parsed 10737817cb20SMarcel Ziswiler from the bootargs. (See drivers/video/videomodes.c) 1074eeb1b77bSwdenk 1075eeb1b77bSwdenk 1076a6c7ad2fSwdenk CONFIG_VIDEO_SED13806 1077a6c7ad2fSwdenk Enable Epson SED13806 driver. This driver supports 8bpp 1078a6c7ad2fSwdenk and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP 1079a6c7ad2fSwdenk or CONFIG_VIDEO_SED13806_16BPP 1080a6c7ad2fSwdenk 10817d3053fbSTimur Tabi CONFIG_FSL_DIU_FB 10827d3053fbSTimur Tabi Enable the Freescale DIU video driver. Reference boards for 10837d3053fbSTimur Tabi SOCs that have a DIU should define this macro to enable DIU 10847d3053fbSTimur Tabi support, and should also define these other macros: 10857d3053fbSTimur Tabi 10867d3053fbSTimur Tabi CONFIG_SYS_DIU_ADDR 10877d3053fbSTimur Tabi CONFIG_VIDEO 10887d3053fbSTimur Tabi CONFIG_CMD_BMP 10897d3053fbSTimur Tabi CONFIG_CFB_CONSOLE 10907d3053fbSTimur Tabi CONFIG_VIDEO_SW_CURSOR 10917d3053fbSTimur Tabi CONFIG_VGA_AS_SINGLE_DEVICE 10927d3053fbSTimur Tabi CONFIG_VIDEO_LOGO 10937d3053fbSTimur Tabi CONFIG_VIDEO_BMP_LOGO 10947d3053fbSTimur Tabi 10957d3053fbSTimur Tabi The DIU driver will look for the 'monitor' environment variable, 10967d3053fbSTimur Tabi and if defined, enable the DIU as a console during boot. This 10977d3053fbSTimur Tabi variable should be set to one of these values: 10987d3053fbSTimur Tabi 10997d3053fbSTimur Tabi '0' Output video to the DVI connector 11007d3053fbSTimur Tabi '1' Output video to the LVDS connector 11017d3053fbSTimur Tabi '2' Output video to the Dual-Link LVDS connector 11027d3053fbSTimur Tabi 1103682011ffSwdenk- Keyboard Support: 1104682011ffSwdenk CONFIG_KEYBOARD 1105682011ffSwdenk 1106682011ffSwdenk Define this to enable a custom keyboard support. 1107682011ffSwdenk This simply calls drv_keyboard_init() which must be 1108682011ffSwdenk defined in your board-specific files. 1109682011ffSwdenk The only board using this so far is RBC823. 1110a6c7ad2fSwdenk 1111c609719bSwdenk- LCD Support: CONFIG_LCD 1112c609719bSwdenk 1113c609719bSwdenk Define this to enable LCD support (for output to LCD 1114c609719bSwdenk display); also select one of the supported displays 1115c609719bSwdenk by defining one of these: 1116c609719bSwdenk 111739cf4804SStelian Pop CONFIG_ATMEL_LCD: 111839cf4804SStelian Pop 111939cf4804SStelian Pop HITACHI TX09D70VM1CCA, 3.5", 240x320. 112039cf4804SStelian Pop 1121fd3103bbSwdenk CONFIG_NEC_NL6448AC33: 1122c609719bSwdenk 1123fd3103bbSwdenk NEC NL6448AC33-18. Active, color, single scan. 1124c609719bSwdenk 1125fd3103bbSwdenk CONFIG_NEC_NL6448BC20 1126c609719bSwdenk 1127fd3103bbSwdenk NEC NL6448BC20-08. 6.5", 640x480. 1128fd3103bbSwdenk Active, color, single scan. 1129fd3103bbSwdenk 1130fd3103bbSwdenk CONFIG_NEC_NL6448BC33_54 1131fd3103bbSwdenk 1132fd3103bbSwdenk NEC NL6448BC33-54. 10.4", 640x480. 1133c609719bSwdenk Active, color, single scan. 1134c609719bSwdenk 1135c609719bSwdenk CONFIG_SHARP_16x9 1136c609719bSwdenk 1137c609719bSwdenk Sharp 320x240. Active, color, single scan. 1138c609719bSwdenk It isn't 16x9, and I am not sure what it is. 1139c609719bSwdenk 1140c609719bSwdenk CONFIG_SHARP_LQ64D341 1141c609719bSwdenk 1142c609719bSwdenk Sharp LQ64D341 display, 640x480. 1143c609719bSwdenk Active, color, single scan. 1144c609719bSwdenk 1145c609719bSwdenk CONFIG_HLD1045 1146c609719bSwdenk 1147c609719bSwdenk HLD1045 display, 640x480. 1148c609719bSwdenk Active, color, single scan. 1149c609719bSwdenk 1150c609719bSwdenk CONFIG_OPTREX_BW 1151c609719bSwdenk 1152c609719bSwdenk Optrex CBL50840-2 NF-FW 99 22 M5 1153c609719bSwdenk or 1154c609719bSwdenk Hitachi LMG6912RPFC-00T 1155c609719bSwdenk or 1156c609719bSwdenk Hitachi SP14Q002 1157c609719bSwdenk 1158c609719bSwdenk 320x240. Black & white. 1159c609719bSwdenk 1160c609719bSwdenk Normally display is black on white background; define 11616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_WHITE_ON_BLACK to get it inverted. 1162c609719bSwdenk 11637152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN 1164d791b1dcSwdenk 1165d791b1dcSwdenk If this option is set, the environment is checked for 1166d791b1dcSwdenk a variable "splashimage". If found, the usual display 1167d791b1dcSwdenk of logo, copyright and system information on the LCD 1168e94d2cd9Swdenk is suppressed and the BMP image at the address 1169d791b1dcSwdenk specified in "splashimage" is loaded instead. The 1170d791b1dcSwdenk console is redirected to the "nulldev", too. This 1171d791b1dcSwdenk allows for a "silent" boot where a splash screen is 1172d791b1dcSwdenk loaded very quickly after power-on. 1173d791b1dcSwdenk 11741ca298ceSMatthias Weisser CONFIG_SPLASH_SCREEN_ALIGN 11751ca298ceSMatthias Weisser 11761ca298ceSMatthias Weisser If this option is set the splash image can be freely positioned 11771ca298ceSMatthias Weisser on the screen. Environment variable "splashpos" specifies the 11781ca298ceSMatthias Weisser position as "x,y". If a positive number is given it is used as 11791ca298ceSMatthias Weisser number of pixel from left/top. If a negative number is given it 11801ca298ceSMatthias Weisser is used as number of pixel from right/bottom. You can also 11811ca298ceSMatthias Weisser specify 'm' for centering the image. 11821ca298ceSMatthias Weisser 11831ca298ceSMatthias Weisser Example: 11841ca298ceSMatthias Weisser setenv splashpos m,m 11851ca298ceSMatthias Weisser => image at center of screen 11861ca298ceSMatthias Weisser 11871ca298ceSMatthias Weisser setenv splashpos 30,20 11881ca298ceSMatthias Weisser => image at x = 30 and y = 20 11891ca298ceSMatthias Weisser 11901ca298ceSMatthias Weisser setenv splashpos -10,m 11911ca298ceSMatthias Weisser => vertically centered image 11921ca298ceSMatthias Weisser at x = dspWidth - bmpWidth - 9 11931ca298ceSMatthias Weisser 119498f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP 119598f4a3dfSStefan Roese 119698f4a3dfSStefan Roese If this option is set, additionally to standard BMP 119798f4a3dfSStefan Roese images, gzipped BMP images can be displayed via the 119898f4a3dfSStefan Roese splashscreen support or the bmp command. 119998f4a3dfSStefan Roese 1200d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8 1201d5011762SAnatolij Gustschin 1202d5011762SAnatolij Gustschin If this option is set, 8-bit RLE compressed BMP images 1203d5011762SAnatolij Gustschin can be displayed via the splashscreen support or the 1204d5011762SAnatolij Gustschin bmp command. 1205d5011762SAnatolij Gustschin 1206c29fdfc1Swdenk- Compression support: 1207c29fdfc1Swdenk CONFIG_BZIP2 1208c29fdfc1Swdenk 1209c29fdfc1Swdenk If this option is set, support for bzip2 compressed 1210c29fdfc1Swdenk images is included. If not, only uncompressed and gzip 1211c29fdfc1Swdenk compressed images are supported. 1212c29fdfc1Swdenk 1213c29fdfc1Swdenk NOTE: the bzip2 algorithm requires a lot of RAM, so 12146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should 1215c29fdfc1Swdenk be at least 4MB. 1216d791b1dcSwdenk 1217fc9c1727SLuigi 'Comio' Mantellini CONFIG_LZMA 1218fc9c1727SLuigi 'Comio' Mantellini 1219fc9c1727SLuigi 'Comio' Mantellini If this option is set, support for lzma compressed 1220fc9c1727SLuigi 'Comio' Mantellini images is included. 1221fc9c1727SLuigi 'Comio' Mantellini 1222fc9c1727SLuigi 'Comio' Mantellini Note: The LZMA algorithm adds between 2 and 4KB of code and it 1223fc9c1727SLuigi 'Comio' Mantellini requires an amount of dynamic memory that is given by the 1224fc9c1727SLuigi 'Comio' Mantellini formula: 1225fc9c1727SLuigi 'Comio' Mantellini 1226fc9c1727SLuigi 'Comio' Mantellini (1846 + 768 << (lc + lp)) * sizeof(uint16) 1227fc9c1727SLuigi 'Comio' Mantellini 1228fc9c1727SLuigi 'Comio' Mantellini Where lc and lp stand for, respectively, Literal context bits 1229fc9c1727SLuigi 'Comio' Mantellini and Literal pos bits. 1230fc9c1727SLuigi 'Comio' Mantellini 1231fc9c1727SLuigi 'Comio' Mantellini This value is upper-bounded by 14MB in the worst case. Anyway, 1232fc9c1727SLuigi 'Comio' Mantellini for a ~4MB large kernel image, we have lc=3 and lp=0 for a 1233fc9c1727SLuigi 'Comio' Mantellini total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is 1234fc9c1727SLuigi 'Comio' Mantellini a very small buffer. 1235fc9c1727SLuigi 'Comio' Mantellini 1236fc9c1727SLuigi 'Comio' Mantellini Use the lzmainfo tool to determinate the lc and lp values and 1237fc9c1727SLuigi 'Comio' Mantellini then calculate the amount of needed dynamic memory (ensuring 12386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD the appropriate CONFIG_SYS_MALLOC_LEN value). 1239fc9c1727SLuigi 'Comio' Mantellini 124017ea1177Swdenk- MII/PHY support: 124117ea1177Swdenk CONFIG_PHY_ADDR 124217ea1177Swdenk 124317ea1177Swdenk The address of PHY on MII bus. 124417ea1177Swdenk 124517ea1177Swdenk CONFIG_PHY_CLOCK_FREQ (ppc4xx) 124617ea1177Swdenk 124717ea1177Swdenk The clock frequency of the MII bus 124817ea1177Swdenk 124917ea1177Swdenk CONFIG_PHY_GIGE 125017ea1177Swdenk 125117ea1177Swdenk If this option is set, support for speed/duplex 125211ccc33fSMarcel Ziswiler detection of gigabit PHY is included. 125317ea1177Swdenk 125417ea1177Swdenk CONFIG_PHY_RESET_DELAY 125517ea1177Swdenk 125617ea1177Swdenk Some PHY like Intel LXT971A need extra delay after 125717ea1177Swdenk reset before any MII register access is possible. 125817ea1177Swdenk For such PHY, set this option to the usec delay 125917ea1177Swdenk required. (minimum 300usec for LXT971A) 126017ea1177Swdenk 126117ea1177Swdenk CONFIG_PHY_CMD_DELAY (ppc4xx) 126217ea1177Swdenk 126317ea1177Swdenk Some PHY like Intel LXT971A need extra delay after 126417ea1177Swdenk command issued before MII status register can be read 126517ea1177Swdenk 1266c609719bSwdenk- Ethernet address: 1267c609719bSwdenk CONFIG_ETHADDR 1268c68a05feSrichardretanubun CONFIG_ETH1ADDR 1269c609719bSwdenk CONFIG_ETH2ADDR 1270c609719bSwdenk CONFIG_ETH3ADDR 1271c68a05feSrichardretanubun CONFIG_ETH4ADDR 1272c68a05feSrichardretanubun CONFIG_ETH5ADDR 1273c609719bSwdenk 127411ccc33fSMarcel Ziswiler Define a default value for Ethernet address to use 127511ccc33fSMarcel Ziswiler for the respective Ethernet interface, in case this 1276c609719bSwdenk is not determined automatically. 1277c609719bSwdenk 1278c609719bSwdenk- IP address: 1279c609719bSwdenk CONFIG_IPADDR 1280c609719bSwdenk 1281c609719bSwdenk Define a default value for the IP address to use for 128211ccc33fSMarcel Ziswiler the default Ethernet interface, in case this is not 1283c609719bSwdenk determined through e.g. bootp. 1284c609719bSwdenk 1285c609719bSwdenk- Server IP address: 1286c609719bSwdenk CONFIG_SERVERIP 1287c609719bSwdenk 1288c609719bSwdenk Defines a default value for the IP address of a TFTP 1289c609719bSwdenk server to contact when using the "tftboot" command. 1290c609719bSwdenk 129197cfe861SRobin Getz CONFIG_KEEP_SERVERADDR 129297cfe861SRobin Getz 129397cfe861SRobin Getz Keeps the server's MAC address, in the env 'serveraddr' 129497cfe861SRobin Getz for passing to bootargs (like Linux's netconsole option) 129597cfe861SRobin Getz 129653a5c424SDavid Updegraff- Multicast TFTP Mode: 129753a5c424SDavid Updegraff CONFIG_MCAST_TFTP 129853a5c424SDavid Updegraff 129953a5c424SDavid Updegraff Defines whether you want to support multicast TFTP as per 130053a5c424SDavid Updegraff rfc-2090; for example to work with atftp. Lets lots of targets 130111ccc33fSMarcel Ziswiler tftp down the same boot image concurrently. Note: the Ethernet 130253a5c424SDavid Updegraff driver in use must provide a function: mcast() to join/leave a 130353a5c424SDavid Updegraff multicast group. 130453a5c424SDavid Updegraff 130553a5c424SDavid Updegraff CONFIG_BOOTP_RANDOM_DELAY 1306c609719bSwdenk- BOOTP Recovery Mode: 1307c609719bSwdenk CONFIG_BOOTP_RANDOM_DELAY 1308c609719bSwdenk 1309c609719bSwdenk If you have many targets in a network that try to 1310c609719bSwdenk boot using BOOTP, you may want to avoid that all 1311c609719bSwdenk systems send out BOOTP requests at precisely the same 1312c609719bSwdenk moment (which would happen for instance at recovery 1313c609719bSwdenk from a power failure, when all systems will try to 1314c609719bSwdenk boot, thus flooding the BOOTP server. Defining 1315c609719bSwdenk CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be 1316c609719bSwdenk inserted before sending out BOOTP requests. The 13176c33c785SWolfgang Denk following delays are inserted then: 1318c609719bSwdenk 1319c609719bSwdenk 1st BOOTP request: delay 0 ... 1 sec 1320c609719bSwdenk 2nd BOOTP request: delay 0 ... 2 sec 1321c609719bSwdenk 3rd BOOTP request: delay 0 ... 4 sec 1322c609719bSwdenk 4th and following 1323c609719bSwdenk BOOTP requests: delay 0 ... 8 sec 1324c609719bSwdenk 1325fe389a82Sstroese- DHCP Advanced Options: 13261fe80d79SJon Loeliger You can fine tune the DHCP functionality by defining 13271fe80d79SJon Loeliger CONFIG_BOOTP_* symbols: 1328fe389a82Sstroese 13291fe80d79SJon Loeliger CONFIG_BOOTP_SUBNETMASK 13301fe80d79SJon Loeliger CONFIG_BOOTP_GATEWAY 13311fe80d79SJon Loeliger CONFIG_BOOTP_HOSTNAME 13321fe80d79SJon Loeliger CONFIG_BOOTP_NISDOMAIN 13331fe80d79SJon Loeliger CONFIG_BOOTP_BOOTPATH 13341fe80d79SJon Loeliger CONFIG_BOOTP_BOOTFILESIZE 13351fe80d79SJon Loeliger CONFIG_BOOTP_DNS 13361fe80d79SJon Loeliger CONFIG_BOOTP_DNS2 13371fe80d79SJon Loeliger CONFIG_BOOTP_SEND_HOSTNAME 13381fe80d79SJon Loeliger CONFIG_BOOTP_NTPSERVER 13391fe80d79SJon Loeliger CONFIG_BOOTP_TIMEOFFSET 13401fe80d79SJon Loeliger CONFIG_BOOTP_VENDOREX 1341fe389a82Sstroese 13425d110f0aSWilson Callan CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip 13435d110f0aSWilson Callan environment variable, not the BOOTP server. 1344fe389a82Sstroese 1345fe389a82Sstroese CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS 1346fe389a82Sstroese serverip from a DHCP server, it is possible that more 1347fe389a82Sstroese than one DNS serverip is offered to the client. 1348fe389a82Sstroese If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS 1349fe389a82Sstroese serverip will be stored in the additional environment 1350fe389a82Sstroese variable "dnsip2". The first DNS serverip is always 1351fe389a82Sstroese stored in the variable "dnsip", when CONFIG_BOOTP_DNS 13521fe80d79SJon Loeliger is defined. 1353fe389a82Sstroese 1354fe389a82Sstroese CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable 1355fe389a82Sstroese to do a dynamic update of a DNS server. To do this, they 1356fe389a82Sstroese need the hostname of the DHCP requester. 13575d110f0aSWilson Callan If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content 13581fe80d79SJon Loeliger of the "hostname" environment variable is passed as 13591fe80d79SJon Loeliger option 12 to the DHCP server. 1360fe389a82Sstroese 1361d9a2f416SAras Vaichas CONFIG_BOOTP_DHCP_REQUEST_DELAY 1362d9a2f416SAras Vaichas 1363d9a2f416SAras Vaichas A 32bit value in microseconds for a delay between 1364d9a2f416SAras Vaichas receiving a "DHCP Offer" and sending the "DHCP Request". 1365d9a2f416SAras Vaichas This fixes a problem with certain DHCP servers that don't 1366d9a2f416SAras Vaichas respond 100% of the time to a "DHCP request". E.g. On an 1367d9a2f416SAras Vaichas AT91RM9200 processor running at 180MHz, this delay needed 1368d9a2f416SAras Vaichas to be *at least* 15,000 usec before a Windows Server 2003 1369d9a2f416SAras Vaichas DHCP server would reply 100% of the time. I recommend at 1370d9a2f416SAras Vaichas least 50,000 usec to be safe. The alternative is to hope 1371d9a2f416SAras Vaichas that one of the retries will be successful but note that 1372d9a2f416SAras Vaichas the DHCP timeout and retry process takes a longer than 1373d9a2f416SAras Vaichas this delay. 1374d9a2f416SAras Vaichas 1375a3d991bdSwdenk - CDP Options: 1376a3d991bdSwdenk CONFIG_CDP_DEVICE_ID 1377a3d991bdSwdenk 1378a3d991bdSwdenk The device id used in CDP trigger frames. 1379a3d991bdSwdenk 1380a3d991bdSwdenk CONFIG_CDP_DEVICE_ID_PREFIX 1381a3d991bdSwdenk 1382a3d991bdSwdenk A two character string which is prefixed to the MAC address 1383a3d991bdSwdenk of the device. 1384a3d991bdSwdenk 1385a3d991bdSwdenk CONFIG_CDP_PORT_ID 1386a3d991bdSwdenk 1387a3d991bdSwdenk A printf format string which contains the ascii name of 1388a3d991bdSwdenk the port. Normally is set to "eth%d" which sets 138911ccc33fSMarcel Ziswiler eth0 for the first Ethernet, eth1 for the second etc. 1390a3d991bdSwdenk 1391a3d991bdSwdenk CONFIG_CDP_CAPABILITIES 1392a3d991bdSwdenk 1393a3d991bdSwdenk A 32bit integer which indicates the device capabilities; 1394a3d991bdSwdenk 0x00000010 for a normal host which does not forwards. 1395a3d991bdSwdenk 1396a3d991bdSwdenk CONFIG_CDP_VERSION 1397a3d991bdSwdenk 1398a3d991bdSwdenk An ascii string containing the version of the software. 1399a3d991bdSwdenk 1400a3d991bdSwdenk CONFIG_CDP_PLATFORM 1401a3d991bdSwdenk 1402a3d991bdSwdenk An ascii string containing the name of the platform. 1403a3d991bdSwdenk 1404a3d991bdSwdenk CONFIG_CDP_TRIGGER 1405a3d991bdSwdenk 1406a3d991bdSwdenk A 32bit integer sent on the trigger. 1407a3d991bdSwdenk 1408a3d991bdSwdenk CONFIG_CDP_POWER_CONSUMPTION 1409a3d991bdSwdenk 1410a3d991bdSwdenk A 16bit integer containing the power consumption of the 1411a3d991bdSwdenk device in .1 of milliwatts. 1412a3d991bdSwdenk 1413a3d991bdSwdenk CONFIG_CDP_APPLIANCE_VLAN_TYPE 1414a3d991bdSwdenk 1415a3d991bdSwdenk A byte containing the id of the VLAN. 1416a3d991bdSwdenk 1417c609719bSwdenk- Status LED: CONFIG_STATUS_LED 1418c609719bSwdenk 1419c609719bSwdenk Several configurations allow to display the current 1420c609719bSwdenk status using a LED. For instance, the LED will blink 1421c609719bSwdenk fast while running U-Boot code, stop blinking as 1422c609719bSwdenk soon as a reply to a BOOTP request was received, and 1423c609719bSwdenk start blinking slow once the Linux kernel is running 1424c609719bSwdenk (supported by a status LED driver in the Linux 1425c609719bSwdenk kernel). Defining CONFIG_STATUS_LED enables this 1426c609719bSwdenk feature in U-Boot. 1427c609719bSwdenk 1428c609719bSwdenk- CAN Support: CONFIG_CAN_DRIVER 1429c609719bSwdenk 1430c609719bSwdenk Defining CONFIG_CAN_DRIVER enables CAN driver support 1431c609719bSwdenk on those systems that support this (optional) 1432c609719bSwdenk feature, like the TQM8xxL modules. 1433c609719bSwdenk 1434c609719bSwdenk- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C 1435c609719bSwdenk 1436b37c7e5eSwdenk These enable I2C serial bus commands. Defining either of 1437b37c7e5eSwdenk (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will 143811ccc33fSMarcel Ziswiler include the appropriate I2C driver for the selected CPU. 1439c609719bSwdenk 1440b37c7e5eSwdenk This will allow you to use i2c commands at the u-boot 1441602ad3b3SJon Loeliger command line (as long as you set CONFIG_CMD_I2C in 1442b37c7e5eSwdenk CONFIG_COMMANDS) and communicate with i2c based realtime 1443b37c7e5eSwdenk clock chips. See common/cmd_i2c.c for a description of the 1444c609719bSwdenk command line interface. 1445c609719bSwdenk 1446bb99ad6dSBen Warren CONFIG_HARD_I2C selects a hardware I2C controller. 1447c609719bSwdenk 1448b37c7e5eSwdenk CONFIG_SOFT_I2C configures u-boot to use a software (aka 1449b37c7e5eSwdenk bit-banging) driver instead of CPM or similar hardware 1450b37c7e5eSwdenk support for I2C. 1451c609719bSwdenk 1452b37c7e5eSwdenk There are several other quantities that must also be 1453b37c7e5eSwdenk defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C. 1454c609719bSwdenk 14556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD In both cases you will need to define CONFIG_SYS_I2C_SPEED 1456b37c7e5eSwdenk to be the frequency (in Hz) at which you wish your i2c bus 14576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie 145811ccc33fSMarcel Ziswiler the CPU's i2c node address). 1459c609719bSwdenk 14608d321b81SPeter Tyser Now, the u-boot i2c code for the mpc8xx 1461a47a12beSStefan Roese (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node 14628d321b81SPeter Tyser and so its address should therefore be cleared to 0 (See, 14638d321b81SPeter Tyser eg, MPC823e User's Manual p.16-473). So, set 14648d321b81SPeter Tyser CONFIG_SYS_I2C_SLAVE to 0. 1465b37c7e5eSwdenk 14665da71efaSEric Millbrandt CONFIG_SYS_I2C_INIT_MPC5XXX 14675da71efaSEric Millbrandt 14685da71efaSEric Millbrandt When a board is reset during an i2c bus transfer 14695da71efaSEric Millbrandt chips might think that the current transfer is still 14705da71efaSEric Millbrandt in progress. Reset the slave devices by sending start 14715da71efaSEric Millbrandt commands until the slave device responds. 14725da71efaSEric Millbrandt 1473b37c7e5eSwdenk That's all that's required for CONFIG_HARD_I2C. 1474b37c7e5eSwdenk 1475b37c7e5eSwdenk If you use the software i2c interface (CONFIG_SOFT_I2C) 1476b37c7e5eSwdenk then the following macros need to be defined (examples are 1477b37c7e5eSwdenk from include/configs/lwmon.h): 1478c609719bSwdenk 1479c609719bSwdenk I2C_INIT 1480c609719bSwdenk 1481b37c7e5eSwdenk (Optional). Any commands necessary to enable the I2C 1482c609719bSwdenk controller or configure ports. 1483c609719bSwdenk 1484b37c7e5eSwdenk eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL) 1485b37c7e5eSwdenk 1486c609719bSwdenk I2C_PORT 1487c609719bSwdenk 1488c609719bSwdenk (Only for MPC8260 CPU). The I/O port to use (the code 1489c609719bSwdenk assumes both bits are on the same port). Valid values 1490c609719bSwdenk are 0..3 for ports A..D. 1491c609719bSwdenk 1492c609719bSwdenk I2C_ACTIVE 1493c609719bSwdenk 1494c609719bSwdenk The code necessary to make the I2C data line active 1495c609719bSwdenk (driven). If the data line is open collector, this 1496c609719bSwdenk define can be null. 1497c609719bSwdenk 1498b37c7e5eSwdenk eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA) 1499b37c7e5eSwdenk 1500c609719bSwdenk I2C_TRISTATE 1501c609719bSwdenk 1502c609719bSwdenk The code necessary to make the I2C data line tri-stated 1503c609719bSwdenk (inactive). If the data line is open collector, this 1504c609719bSwdenk define can be null. 1505c609719bSwdenk 1506b37c7e5eSwdenk eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA) 1507b37c7e5eSwdenk 1508c609719bSwdenk I2C_READ 1509c609719bSwdenk 1510c609719bSwdenk Code that returns TRUE if the I2C data line is high, 1511c609719bSwdenk FALSE if it is low. 1512c609719bSwdenk 1513b37c7e5eSwdenk eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0) 1514b37c7e5eSwdenk 1515c609719bSwdenk I2C_SDA(bit) 1516c609719bSwdenk 1517c609719bSwdenk If <bit> is TRUE, sets the I2C data line high. If it 1518c609719bSwdenk is FALSE, it clears it (low). 1519c609719bSwdenk 1520b37c7e5eSwdenk eg: #define I2C_SDA(bit) \ 1521b37c7e5eSwdenk if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \ 1522b37c7e5eSwdenk else immr->im_cpm.cp_pbdat &= ~PB_SDA 1523b37c7e5eSwdenk 1524c609719bSwdenk I2C_SCL(bit) 1525c609719bSwdenk 1526c609719bSwdenk If <bit> is TRUE, sets the I2C clock line high. If it 1527c609719bSwdenk is FALSE, it clears it (low). 1528c609719bSwdenk 1529b37c7e5eSwdenk eg: #define I2C_SCL(bit) \ 1530b37c7e5eSwdenk if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \ 1531b37c7e5eSwdenk else immr->im_cpm.cp_pbdat &= ~PB_SCL 1532b37c7e5eSwdenk 1533c609719bSwdenk I2C_DELAY 1534c609719bSwdenk 1535c609719bSwdenk This delay is invoked four times per clock cycle so this 1536c609719bSwdenk controls the rate of data transfer. The data rate thus 1537b37c7e5eSwdenk is 1 / (I2C_DELAY * 4). Often defined to be something 1538b37c7e5eSwdenk like: 1539b37c7e5eSwdenk 1540b37c7e5eSwdenk #define I2C_DELAY udelay(2) 1541c609719bSwdenk 1542793b5726SMike Frysinger CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA 1543793b5726SMike Frysinger 1544793b5726SMike Frysinger If your arch supports the generic GPIO framework (asm/gpio.h), 1545793b5726SMike Frysinger then you may alternatively define the two GPIOs that are to be 1546793b5726SMike Frysinger used as SCL / SDA. Any of the previous I2C_xxx macros will 1547793b5726SMike Frysinger have GPIO-based defaults assigned to them as appropriate. 1548793b5726SMike Frysinger 1549793b5726SMike Frysinger You should define these to the GPIO value as given directly to 1550793b5726SMike Frysinger the generic GPIO functions. 1551793b5726SMike Frysinger 15526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_INIT_BOARD 155347cd00faSwdenk 155447cd00faSwdenk When a board is reset during an i2c bus transfer 155547cd00faSwdenk chips might think that the current transfer is still 155647cd00faSwdenk in progress. On some boards it is possible to access 155747cd00faSwdenk the i2c SCLK line directly, either by using the 155847cd00faSwdenk processor pin as a GPIO or by having a second pin 155947cd00faSwdenk connected to the bus. If this option is defined a 156047cd00faSwdenk custom i2c_init_board() routine in boards/xxx/board.c 156147cd00faSwdenk is run early in the boot sequence. 156247cd00faSwdenk 156326a33504SRichard Retanubun CONFIG_SYS_I2C_BOARD_LATE_INIT 156426a33504SRichard Retanubun 156526a33504SRichard Retanubun An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is 156626a33504SRichard Retanubun defined a custom i2c_board_late_init() routine in 156726a33504SRichard Retanubun boards/xxx/board.c is run AFTER the operations in i2c_init() 156826a33504SRichard Retanubun is completed. This callpoint can be used to unreset i2c bus 156926a33504SRichard Retanubun using CPU i2c controller register accesses for CPUs whose i2c 157026a33504SRichard Retanubun controller provide such a method. It is called at the end of 157126a33504SRichard Retanubun i2c_init() to allow i2c_init operations to setup the i2c bus 157226a33504SRichard Retanubun controller on the CPU (e.g. setting bus speed & slave address). 157326a33504SRichard Retanubun 157417ea1177Swdenk CONFIG_I2CFAST (PPC405GP|PPC405EP only) 157517ea1177Swdenk 157617ea1177Swdenk This option enables configuration of bi_iic_fast[] flags 157717ea1177Swdenk in u-boot bd_info structure based on u-boot environment 157817ea1177Swdenk variable "i2cfast". (see also i2cfast) 157917ea1177Swdenk 1580bb99ad6dSBen Warren CONFIG_I2C_MULTI_BUS 1581bb99ad6dSBen Warren 1582bb99ad6dSBen Warren This option allows the use of multiple I2C buses, each of which 1583bb99ad6dSBen Warren must have a controller. At any point in time, only one bus is 1584bb99ad6dSBen Warren active. To switch to a different bus, use the 'i2c dev' command. 1585bb99ad6dSBen Warren Note that bus numbering is zero-based. 1586bb99ad6dSBen Warren 15876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_NOPROBES 1588bb99ad6dSBen Warren 1589bb99ad6dSBen Warren This option specifies a list of I2C devices that will be skipped 15900f89c54bSPeter Tyser when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS 15910f89c54bSPeter Tyser is set, specify a list of bus-device pairs. Otherwise, specify 15920f89c54bSPeter Tyser a 1D array of device addresses 1593bb99ad6dSBen Warren 1594bb99ad6dSBen Warren e.g. 1595bb99ad6dSBen Warren #undef CONFIG_I2C_MULTI_BUS 15966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68} 1597bb99ad6dSBen Warren 1598bb99ad6dSBen Warren will skip addresses 0x50 and 0x68 on a board with one I2C bus 1599bb99ad6dSBen Warren 1600bb99ad6dSBen Warren #define CONFIG_I2C_MULTI_BUS 16016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}} 1602bb99ad6dSBen Warren 1603bb99ad6dSBen Warren will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1 1604bb99ad6dSBen Warren 16056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SPD_BUS_NUM 1606be5e6181STimur Tabi 1607be5e6181STimur Tabi If defined, then this indicates the I2C bus number for DDR SPD. 1608be5e6181STimur Tabi If not defined, then U-Boot assumes that SPD is on I2C bus 0. 1609be5e6181STimur Tabi 16106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_RTC_BUS_NUM 16110dc018ecSStefan Roese 16120dc018ecSStefan Roese If defined, then this indicates the I2C bus number for the RTC. 16130dc018ecSStefan Roese If not defined, then U-Boot assumes that RTC is on I2C bus 0. 16140dc018ecSStefan Roese 16156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_DTT_BUS_NUM 16160dc018ecSStefan Roese 16170dc018ecSStefan Roese If defined, then this indicates the I2C bus number for the DTT. 16180dc018ecSStefan Roese If not defined, then U-Boot assumes that DTT is on I2C bus 0. 16190dc018ecSStefan Roese 16206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_DTT_ADDR: 16219ebbb54fSVictor Gallardo 16229ebbb54fSVictor Gallardo If defined, specifies the I2C address of the DTT device. 16239ebbb54fSVictor Gallardo If not defined, then U-Boot uses predefined value for 16249ebbb54fSVictor Gallardo specified DTT device. 16259ebbb54fSVictor Gallardo 1626be5e6181STimur Tabi CONFIG_FSL_I2C 1627be5e6181STimur Tabi 1628be5e6181STimur Tabi Define this option if you want to use Freescale's I2C driver in 16297817cb20SMarcel Ziswiler drivers/i2c/fsl_i2c.c. 1630be5e6181STimur Tabi 163167b23a32SHeiko Schocher CONFIG_I2C_MUX 163267b23a32SHeiko Schocher 163367b23a32SHeiko Schocher Define this option if you have I2C devices reached over 1 .. n 163467b23a32SHeiko Schocher I2C Muxes like the pca9544a. This option addes a new I2C 163567b23a32SHeiko Schocher Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a 163667b23a32SHeiko Schocher new I2C Bus to the existing I2C Busses. If you select the 163767b23a32SHeiko Schocher new Bus with "i2c dev", u-bbot sends first the commandos for 163867b23a32SHeiko Schocher the muxes to activate this new "bus". 163967b23a32SHeiko Schocher 164067b23a32SHeiko Schocher CONFIG_I2C_MULTI_BUS must be also defined, to use this 164167b23a32SHeiko Schocher feature! 164267b23a32SHeiko Schocher 164367b23a32SHeiko Schocher Example: 164467b23a32SHeiko Schocher Adding a new I2C Bus reached over 2 pca9544a muxes 164567b23a32SHeiko Schocher The First mux with address 70 and channel 6 164667b23a32SHeiko Schocher The Second mux with address 71 and channel 4 164767b23a32SHeiko Schocher 164867b23a32SHeiko Schocher => i2c bus pca9544a:70:6:pca9544a:71:4 164967b23a32SHeiko Schocher 165067b23a32SHeiko Schocher Use the "i2c bus" command without parameter, to get a list 165167b23a32SHeiko Schocher of I2C Busses with muxes: 165267b23a32SHeiko Schocher 165367b23a32SHeiko Schocher => i2c bus 165467b23a32SHeiko Schocher Busses reached over muxes: 165567b23a32SHeiko Schocher Bus ID: 2 165667b23a32SHeiko Schocher reached over Mux(es): 165767b23a32SHeiko Schocher pca9544a@70 ch: 4 165867b23a32SHeiko Schocher Bus ID: 3 165967b23a32SHeiko Schocher reached over Mux(es): 166067b23a32SHeiko Schocher pca9544a@70 ch: 6 166167b23a32SHeiko Schocher pca9544a@71 ch: 4 166267b23a32SHeiko Schocher => 166367b23a32SHeiko Schocher 166467b23a32SHeiko Schocher If you now switch to the new I2C Bus 3 with "i2c dev 3" 166567b23a32SHeiko Schocher u-boot sends First the Commando to the mux@70 to enable 166667b23a32SHeiko Schocher channel 6, and then the Commando to the mux@71 to enable 166767b23a32SHeiko Schocher the channel 4. 166867b23a32SHeiko Schocher 166967b23a32SHeiko Schocher After that, you can use the "normal" i2c commands as 167067b23a32SHeiko Schocher usual, to communicate with your I2C devices behind 167167b23a32SHeiko Schocher the 2 muxes. 167267b23a32SHeiko Schocher 167367b23a32SHeiko Schocher This option is actually implemented for the bitbanging 167467b23a32SHeiko Schocher algorithm in common/soft_i2c.c and for the Hardware I2C 167567b23a32SHeiko Schocher Bus on the MPC8260. But it should be not so difficult 167667b23a32SHeiko Schocher to add this option to other architectures. 167767b23a32SHeiko Schocher 16782ac6985aSAndrew Dyer CONFIG_SOFT_I2C_READ_REPEATED_START 16792ac6985aSAndrew Dyer 16802ac6985aSAndrew Dyer defining this will force the i2c_read() function in 16812ac6985aSAndrew Dyer the soft_i2c driver to perform an I2C repeated start 16822ac6985aSAndrew Dyer between writing the address pointer and reading the 16832ac6985aSAndrew Dyer data. If this define is omitted the default behaviour 16842ac6985aSAndrew Dyer of doing a stop-start sequence will be used. Most I2C 16852ac6985aSAndrew Dyer devices can use either method, but some require one or 16862ac6985aSAndrew Dyer the other. 1687be5e6181STimur Tabi 1688c609719bSwdenk- SPI Support: CONFIG_SPI 1689c609719bSwdenk 1690c609719bSwdenk Enables SPI driver (so far only tested with 1691c609719bSwdenk SPI EEPROM, also an instance works with Crystal A/D and 1692c609719bSwdenk D/As on the SACSng board) 1693c609719bSwdenk 16946639562eSYoshihiro Shimoda CONFIG_SH_SPI 16956639562eSYoshihiro Shimoda 16966639562eSYoshihiro Shimoda Enables the driver for SPI controller on SuperH. Currently 16976639562eSYoshihiro Shimoda only SH7757 is supported. 16986639562eSYoshihiro Shimoda 1699c609719bSwdenk CONFIG_SPI_X 1700c609719bSwdenk 1701c609719bSwdenk Enables extended (16-bit) SPI EEPROM addressing. 1702c609719bSwdenk (symmetrical to CONFIG_I2C_X) 1703c609719bSwdenk 1704c609719bSwdenk CONFIG_SOFT_SPI 1705c609719bSwdenk 1706c609719bSwdenk Enables a software (bit-bang) SPI driver rather than 1707c609719bSwdenk using hardware support. This is a general purpose 1708c609719bSwdenk driver that only requires three general I/O port pins 1709c609719bSwdenk (two outputs, one input) to function. If this is 1710c609719bSwdenk defined, the board configuration must define several 1711c609719bSwdenk SPI configuration items (port pins to use, etc). For 1712c609719bSwdenk an example, see include/configs/sacsng.h. 1713c609719bSwdenk 171404a9e118SBen Warren CONFIG_HARD_SPI 171504a9e118SBen Warren 171604a9e118SBen Warren Enables a hardware SPI driver for general-purpose reads 171704a9e118SBen Warren and writes. As with CONFIG_SOFT_SPI, the board configuration 171804a9e118SBen Warren must define a list of chip-select function pointers. 171904a9e118SBen Warren Currently supported on some MPC8xxx processors. For an 172004a9e118SBen Warren example, see include/configs/mpc8349emds.h. 172104a9e118SBen Warren 172238254f45SGuennadi Liakhovetski CONFIG_MXC_SPI 172338254f45SGuennadi Liakhovetski 172438254f45SGuennadi Liakhovetski Enables the driver for the SPI controllers on i.MX and MXC 172538254f45SGuennadi Liakhovetski SoCs. Currently only i.MX31 is supported. 172638254f45SGuennadi Liakhovetski 17270133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA 17280133502eSMatthias Fuchs 17290133502eSMatthias Fuchs Enables FPGA subsystem. 17300133502eSMatthias Fuchs 17310133502eSMatthias Fuchs CONFIG_FPGA_<vendor> 17320133502eSMatthias Fuchs 17330133502eSMatthias Fuchs Enables support for specific chip vendors. 17340133502eSMatthias Fuchs (ALTERA, XILINX) 17350133502eSMatthias Fuchs 17360133502eSMatthias Fuchs CONFIG_FPGA_<family> 17370133502eSMatthias Fuchs 17380133502eSMatthias Fuchs Enables support for FPGA family. 17390133502eSMatthias Fuchs (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX) 17400133502eSMatthias Fuchs 17410133502eSMatthias Fuchs CONFIG_FPGA_COUNT 1742c609719bSwdenk 1743c609719bSwdenk Specify the number of FPGA devices to support. 1744c609719bSwdenk 17456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_PROG_FEEDBACK 1746c609719bSwdenk 1747c609719bSwdenk Enable printing of hash marks during FPGA configuration. 1748c609719bSwdenk 17496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_BUSY 1750c609719bSwdenk 1751c609719bSwdenk Enable checks on FPGA configuration interface busy 1752c609719bSwdenk status by the configuration function. This option 1753c609719bSwdenk will require a board or device specific function to 1754c609719bSwdenk be written. 1755c609719bSwdenk 1756c609719bSwdenk CONFIG_FPGA_DELAY 1757c609719bSwdenk 1758c609719bSwdenk If defined, a function that provides delays in the FPGA 1759c609719bSwdenk configuration driver. 1760c609719bSwdenk 17616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_CTRLC 1762c609719bSwdenk Allow Control-C to interrupt FPGA configuration 1763c609719bSwdenk 17646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_ERROR 1765c609719bSwdenk 1766c609719bSwdenk Check for configuration errors during FPGA bitfile 1767c609719bSwdenk loading. For example, abort during Virtex II 1768c609719bSwdenk configuration if the INIT_B line goes low (which 1769c609719bSwdenk indicated a CRC error). 1770c609719bSwdenk 17716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_INIT 1772c609719bSwdenk 1773c609719bSwdenk Maximum time to wait for the INIT_B line to deassert 1774c609719bSwdenk after PROB_B has been deasserted during a Virtex II 1775c609719bSwdenk FPGA configuration sequence. The default time is 500 177611ccc33fSMarcel Ziswiler ms. 1777c609719bSwdenk 17786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_BUSY 1779c609719bSwdenk 1780c609719bSwdenk Maximum time to wait for BUSY to deassert during 178111ccc33fSMarcel Ziswiler Virtex II FPGA configuration. The default is 5 ms. 1782c609719bSwdenk 17836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_CONFIG 1784c609719bSwdenk 1785c609719bSwdenk Time to wait after FPGA configuration. The default is 178611ccc33fSMarcel Ziswiler 200 ms. 1787c609719bSwdenk 1788c609719bSwdenk- Configuration Management: 1789c609719bSwdenk CONFIG_IDENT_STRING 1790c609719bSwdenk 1791c609719bSwdenk If defined, this string will be added to the U-Boot 1792c609719bSwdenk version information (U_BOOT_VERSION) 1793c609719bSwdenk 1794c609719bSwdenk- Vendor Parameter Protection: 1795c609719bSwdenk 1796c609719bSwdenk U-Boot considers the values of the environment 1797c609719bSwdenk variables "serial#" (Board Serial Number) and 17987152b1d0Swdenk "ethaddr" (Ethernet Address) to be parameters that 1799c609719bSwdenk are set once by the board vendor / manufacturer, and 1800c609719bSwdenk protects these variables from casual modification by 1801c609719bSwdenk the user. Once set, these variables are read-only, 1802c609719bSwdenk and write or delete attempts are rejected. You can 180311ccc33fSMarcel Ziswiler change this behaviour: 1804c609719bSwdenk 1805c609719bSwdenk If CONFIG_ENV_OVERWRITE is #defined in your config 1806c609719bSwdenk file, the write protection for vendor parameters is 180747cd00faSwdenk completely disabled. Anybody can change or delete 1808c609719bSwdenk these parameters. 1809c609719bSwdenk 1810c609719bSwdenk Alternatively, if you #define _both_ CONFIG_ETHADDR 1811c609719bSwdenk _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default 181211ccc33fSMarcel Ziswiler Ethernet address is installed in the environment, 1813c609719bSwdenk which can be changed exactly ONCE by the user. [The 1814c609719bSwdenk serial# is unaffected by this, i. e. it remains 1815c609719bSwdenk read-only.] 1816c609719bSwdenk 1817c609719bSwdenk- Protected RAM: 1818c609719bSwdenk CONFIG_PRAM 1819c609719bSwdenk 1820c609719bSwdenk Define this variable to enable the reservation of 1821c609719bSwdenk "protected RAM", i. e. RAM which is not overwritten 1822c609719bSwdenk by U-Boot. Define CONFIG_PRAM to hold the number of 1823c609719bSwdenk kB you want to reserve for pRAM. You can overwrite 1824c609719bSwdenk this default value by defining an environment 1825c609719bSwdenk variable "pram" to the number of kB you want to 1826c609719bSwdenk reserve. Note that the board info structure will 1827c609719bSwdenk still show the full amount of RAM. If pRAM is 1828c609719bSwdenk reserved, a new environment variable "mem" will 1829c609719bSwdenk automatically be defined to hold the amount of 1830c609719bSwdenk remaining RAM in a form that can be passed as boot 1831c609719bSwdenk argument to Linux, for instance like that: 1832c609719bSwdenk 1833fe126d8bSWolfgang Denk setenv bootargs ... mem=\${mem} 1834c609719bSwdenk saveenv 1835c609719bSwdenk 1836c609719bSwdenk This way you can tell Linux not to use this memory, 1837c609719bSwdenk either, which results in a memory region that will 1838c609719bSwdenk not be affected by reboots. 1839c609719bSwdenk 1840c609719bSwdenk *WARNING* If your board configuration uses automatic 1841c609719bSwdenk detection of the RAM size, you must make sure that 1842c609719bSwdenk this memory test is non-destructive. So far, the 1843c609719bSwdenk following board configurations are known to be 1844c609719bSwdenk "pRAM-clean": 1845c609719bSwdenk 1846c609719bSwdenk ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL, 1847c609719bSwdenk HERMES, IP860, RPXlite, LWMON, LANTEC, 1848544d97e9SWolfgang Denk FLAGADM, TQM8260 1849c609719bSwdenk 1850c609719bSwdenk- Error Recovery: 1851c609719bSwdenk CONFIG_PANIC_HANG 1852c609719bSwdenk 1853c609719bSwdenk Define this variable to stop the system in case of a 1854c609719bSwdenk fatal error, so that you have to reset it manually. 1855c609719bSwdenk This is probably NOT a good idea for an embedded 185611ccc33fSMarcel Ziswiler system where you want the system to reboot 1857c609719bSwdenk automatically as fast as possible, but it may be 1858c609719bSwdenk useful during development since you can try to debug 1859c609719bSwdenk the conditions that lead to the situation. 1860c609719bSwdenk 1861c609719bSwdenk CONFIG_NET_RETRY_COUNT 1862c609719bSwdenk 1863c609719bSwdenk This variable defines the number of retries for 1864c609719bSwdenk network operations like ARP, RARP, TFTP, or BOOTP 1865c609719bSwdenk before giving up the operation. If not defined, a 1866c609719bSwdenk default value of 5 is used. 1867c609719bSwdenk 186840cb90eeSGuennadi Liakhovetski CONFIG_ARP_TIMEOUT 186940cb90eeSGuennadi Liakhovetski 187040cb90eeSGuennadi Liakhovetski Timeout waiting for an ARP reply in milliseconds. 187140cb90eeSGuennadi Liakhovetski 1872c609719bSwdenk- Command Interpreter: 18738078f1a5SWolfgang Denk CONFIG_AUTO_COMPLETE 187404a85b3bSwdenk 187504a85b3bSwdenk Enable auto completion of commands using TAB. 187604a85b3bSwdenk 18778078f1a5SWolfgang Denk Note that this feature has NOT been implemented yet 18788078f1a5SWolfgang Denk for the "hush" shell. 18798078f1a5SWolfgang Denk 18808078f1a5SWolfgang Denk 18816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_HUSH_PARSER 1882c609719bSwdenk 1883c609719bSwdenk Define this variable to enable the "hush" shell (from 1884c609719bSwdenk Busybox) as command line interpreter, thus enabling 1885c609719bSwdenk powerful command line syntax like 1886c609719bSwdenk if...then...else...fi conditionals or `&&' and '||' 1887c609719bSwdenk constructs ("shell scripts"). 1888c609719bSwdenk 1889c609719bSwdenk If undefined, you get the old, much simpler behaviour 1890c609719bSwdenk with a somewhat smaller memory footprint. 1891c609719bSwdenk 1892c609719bSwdenk 18936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PROMPT_HUSH_PS2 1894c609719bSwdenk 1895c609719bSwdenk This defines the secondary prompt string, which is 1896c609719bSwdenk printed when the command interpreter needs more input 1897c609719bSwdenk to complete a command. Usually "> ". 1898c609719bSwdenk 1899c609719bSwdenk Note: 1900c609719bSwdenk 1901c609719bSwdenk In the current implementation, the local variables 1902c609719bSwdenk space and global environment variables space are 1903c609719bSwdenk separated. Local variables are those you define by 19043b57fe0aSwdenk simply typing `name=value'. To access a local 1905c609719bSwdenk variable later on, you have write `$name' or 19063b57fe0aSwdenk `${name}'; to execute the contents of a variable 19073b57fe0aSwdenk directly type `$name' at the command prompt. 1908c609719bSwdenk 1909c609719bSwdenk Global environment variables are those you use 1910c609719bSwdenk setenv/printenv to work with. To run a command stored 1911c609719bSwdenk in such a variable, you need to use the run command, 1912c609719bSwdenk and you must not use the '$' sign to access them. 1913c609719bSwdenk 1914c609719bSwdenk To store commands and special characters in a 1915c609719bSwdenk variable, please use double quotation marks 1916c609719bSwdenk surrounding the whole text of the variable, instead 1917c609719bSwdenk of the backslashes before semicolons and special 1918c609719bSwdenk symbols. 1919c609719bSwdenk 1920aa0c71acSWolfgang Denk- Commandline Editing and History: 1921aa0c71acSWolfgang Denk CONFIG_CMDLINE_EDITING 1922aa0c71acSWolfgang Denk 192311ccc33fSMarcel Ziswiler Enable editing and History functions for interactive 1924aa0c71acSWolfgang Denk commandline input operations 1925aa0c71acSWolfgang Denk 1926a8c7c708Swdenk- Default Environment: 1927c609719bSwdenk CONFIG_EXTRA_ENV_SETTINGS 1928c609719bSwdenk 1929c609719bSwdenk Define this to contain any number of null terminated 1930c609719bSwdenk strings (variable = value pairs) that will be part of 19317152b1d0Swdenk the default environment compiled into the boot image. 19322262cfeeSwdenk 1933c609719bSwdenk For example, place something like this in your 1934c609719bSwdenk board's config file: 1935c609719bSwdenk 1936c609719bSwdenk #define CONFIG_EXTRA_ENV_SETTINGS \ 1937c609719bSwdenk "myvar1=value1\0" \ 1938c609719bSwdenk "myvar2=value2\0" 1939c609719bSwdenk 1940c609719bSwdenk Warning: This method is based on knowledge about the 1941c609719bSwdenk internal format how the environment is stored by the 19422262cfeeSwdenk U-Boot code. This is NOT an official, exported 1943c609719bSwdenk interface! Although it is unlikely that this format 19447152b1d0Swdenk will change soon, there is no guarantee either. 1945c609719bSwdenk You better know what you are doing here. 1946c609719bSwdenk 1947c609719bSwdenk Note: overly (ab)use of the default environment is 1948c609719bSwdenk discouraged. Make sure to check other ways to preset 194974de7aefSWolfgang Denk the environment like the "source" command or the 1950c609719bSwdenk boot command first. 1951c609719bSwdenk 1952a8c7c708Swdenk- DataFlash Support: 19532abbe075Swdenk CONFIG_HAS_DATAFLASH 19542abbe075Swdenk 19552abbe075Swdenk Defining this option enables DataFlash features and 19562abbe075Swdenk allows to read/write in Dataflash via the standard 19572abbe075Swdenk commands cp, md... 19582abbe075Swdenk 19593f85ce27Swdenk- SystemACE Support: 19603f85ce27Swdenk CONFIG_SYSTEMACE 19613f85ce27Swdenk 19623f85ce27Swdenk Adding this option adds support for Xilinx SystemACE 19633f85ce27Swdenk chips attached via some sort of local bus. The address 196411ccc33fSMarcel Ziswiler of the chip must also be defined in the 19656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SYSTEMACE_BASE macro. For example: 19663f85ce27Swdenk 19673f85ce27Swdenk #define CONFIG_SYSTEMACE 19686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000 19693f85ce27Swdenk 19703f85ce27Swdenk When SystemACE support is added, the "ace" device type 19713f85ce27Swdenk becomes available to the fat commands, i.e. fatls. 19723f85ce27Swdenk 1973ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port: 1974ecb0ccd9SWolfgang Denk CONFIG_TFTP_PORT 1975ecb0ccd9SWolfgang Denk 197628cb9375SWolfgang Denk If this is defined, the environment variable tftpsrcp 1977ecb0ccd9SWolfgang Denk is used to supply the TFTP UDP source port value. 197828cb9375SWolfgang Denk If tftpsrcp isn't defined, the normal pseudo-random port 1979ecb0ccd9SWolfgang Denk number generator is used. 1980ecb0ccd9SWolfgang Denk 198128cb9375SWolfgang Denk Also, the environment variable tftpdstp is used to supply 198228cb9375SWolfgang Denk the TFTP UDP destination port value. If tftpdstp isn't 198328cb9375SWolfgang Denk defined, the normal port 69 is used. 198428cb9375SWolfgang Denk 198528cb9375SWolfgang Denk The purpose for tftpsrcp is to allow a TFTP server to 1986ecb0ccd9SWolfgang Denk blindly start the TFTP transfer using the pre-configured 1987ecb0ccd9SWolfgang Denk target IP address and UDP port. This has the effect of 1988ecb0ccd9SWolfgang Denk "punching through" the (Windows XP) firewall, allowing 1989ecb0ccd9SWolfgang Denk the remainder of the TFTP transfer to proceed normally. 1990ecb0ccd9SWolfgang Denk A better solution is to properly configure the firewall, 1991ecb0ccd9SWolfgang Denk but sometimes that is not allowed. 1992ecb0ccd9SWolfgang Denk 1993a8c7c708Swdenk- Show boot progress: 1994c609719bSwdenk CONFIG_SHOW_BOOT_PROGRESS 1995c609719bSwdenk 1996c609719bSwdenk Defining this option allows to add some board- 1997c609719bSwdenk specific code (calling a user-provided function 1998c609719bSwdenk "show_boot_progress(int)") that enables you to show 1999c609719bSwdenk the system's boot progress on some display (for 2000c609719bSwdenk example, some LED's) on your board. At the moment, 2001c609719bSwdenk the following checkpoints are implemented: 2002c609719bSwdenk 20038ae86b76SWolfgang Denk- Standalone program support: 20048ae86b76SWolfgang Denk CONFIG_STANDALONE_LOAD_ADDR 20058ae86b76SWolfgang Denk 20068ae86b76SWolfgang Denk This option allows to define board specific values 20078ae86b76SWolfgang Denk for the address where standalone program gets loaded, 20088ae86b76SWolfgang Denk thus overwriting the architecutre dependent default 20098ae86b76SWolfgang Denk settings. 20108ae86b76SWolfgang Denk 20111372cce2SMarian BalakowiczLegacy uImage format: 20121372cce2SMarian Balakowicz 2013c609719bSwdenk Arg Where When 2014c609719bSwdenk 1 common/cmd_bootm.c before attempting to boot an image 2015c609719bSwdenk -1 common/cmd_bootm.c Image header has bad magic number 2016c609719bSwdenk 2 common/cmd_bootm.c Image header has correct magic number 2017c609719bSwdenk -2 common/cmd_bootm.c Image header has bad checksum 2018c609719bSwdenk 3 common/cmd_bootm.c Image header has correct checksum 2019c609719bSwdenk -3 common/cmd_bootm.c Image data has bad checksum 2020c609719bSwdenk 4 common/cmd_bootm.c Image data has correct checksum 2021c609719bSwdenk -4 common/cmd_bootm.c Image is for unsupported architecture 2022c609719bSwdenk 5 common/cmd_bootm.c Architecture check OK 20231372cce2SMarian Balakowicz -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi) 2024c609719bSwdenk 6 common/cmd_bootm.c Image Type check OK 2025c609719bSwdenk -6 common/cmd_bootm.c gunzip uncompression error 2026c609719bSwdenk -7 common/cmd_bootm.c Unimplemented compression type 2027c609719bSwdenk 7 common/cmd_bootm.c Uncompression OK 20281372cce2SMarian Balakowicz 8 common/cmd_bootm.c No uncompress/copy overwrite error 2029c609719bSwdenk -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX) 20301372cce2SMarian Balakowicz 20311372cce2SMarian Balakowicz 9 common/image.c Start initial ramdisk verification 20321372cce2SMarian Balakowicz -10 common/image.c Ramdisk header has bad magic number 20331372cce2SMarian Balakowicz -11 common/image.c Ramdisk header has bad checksum 20341372cce2SMarian Balakowicz 10 common/image.c Ramdisk header is OK 20351372cce2SMarian Balakowicz -12 common/image.c Ramdisk data has bad checksum 20361372cce2SMarian Balakowicz 11 common/image.c Ramdisk data has correct checksum 20371372cce2SMarian Balakowicz 12 common/image.c Ramdisk verification complete, start loading 203811ccc33fSMarcel Ziswiler -13 common/image.c Wrong Image Type (not PPC Linux ramdisk) 20391372cce2SMarian Balakowicz 13 common/image.c Start multifile image verification 20401372cce2SMarian Balakowicz 14 common/image.c No initial ramdisk, no multifile, continue. 20411372cce2SMarian Balakowicz 2042ea0364f1SPeter Tyser 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS 2043c609719bSwdenk 2044a47a12beSStefan Roese -30 arch/powerpc/lib/board.c Fatal error, hang the system 204563e73c9aSwdenk -31 post/post.c POST test failed, detected by post_output_backlog() 204663e73c9aSwdenk -32 post/post.c POST test failed, detected by post_run_single() 204763e73c9aSwdenk 2048566a494fSHeiko Schocher 34 common/cmd_doc.c before loading a Image from a DOC device 2049566a494fSHeiko Schocher -35 common/cmd_doc.c Bad usage of "doc" command 2050566a494fSHeiko Schocher 35 common/cmd_doc.c correct usage of "doc" command 2051566a494fSHeiko Schocher -36 common/cmd_doc.c No boot device 2052566a494fSHeiko Schocher 36 common/cmd_doc.c correct boot device 2053566a494fSHeiko Schocher -37 common/cmd_doc.c Unknown Chip ID on boot device 2054566a494fSHeiko Schocher 37 common/cmd_doc.c correct chip ID found, device available 2055566a494fSHeiko Schocher -38 common/cmd_doc.c Read Error on boot device 2056566a494fSHeiko Schocher 38 common/cmd_doc.c reading Image header from DOC device OK 2057566a494fSHeiko Schocher -39 common/cmd_doc.c Image header has bad magic number 2058566a494fSHeiko Schocher 39 common/cmd_doc.c Image header has correct magic number 2059566a494fSHeiko Schocher -40 common/cmd_doc.c Error reading Image from DOC device 2060566a494fSHeiko Schocher 40 common/cmd_doc.c Image header has correct magic number 2061566a494fSHeiko Schocher 41 common/cmd_ide.c before loading a Image from a IDE device 2062566a494fSHeiko Schocher -42 common/cmd_ide.c Bad usage of "ide" command 2063566a494fSHeiko Schocher 42 common/cmd_ide.c correct usage of "ide" command 2064566a494fSHeiko Schocher -43 common/cmd_ide.c No boot device 2065566a494fSHeiko Schocher 43 common/cmd_ide.c boot device found 2066566a494fSHeiko Schocher -44 common/cmd_ide.c Device not available 2067566a494fSHeiko Schocher 44 common/cmd_ide.c Device available 2068566a494fSHeiko Schocher -45 common/cmd_ide.c wrong partition selected 2069566a494fSHeiko Schocher 45 common/cmd_ide.c partition selected 2070566a494fSHeiko Schocher -46 common/cmd_ide.c Unknown partition table 2071566a494fSHeiko Schocher 46 common/cmd_ide.c valid partition table found 2072566a494fSHeiko Schocher -47 common/cmd_ide.c Invalid partition type 2073566a494fSHeiko Schocher 47 common/cmd_ide.c correct partition type 2074566a494fSHeiko Schocher -48 common/cmd_ide.c Error reading Image Header on boot device 2075566a494fSHeiko Schocher 48 common/cmd_ide.c reading Image Header from IDE device OK 2076566a494fSHeiko Schocher -49 common/cmd_ide.c Image header has bad magic number 2077566a494fSHeiko Schocher 49 common/cmd_ide.c Image header has correct magic number 2078566a494fSHeiko Schocher -50 common/cmd_ide.c Image header has bad checksum 2079566a494fSHeiko Schocher 50 common/cmd_ide.c Image header has correct checksum 2080566a494fSHeiko Schocher -51 common/cmd_ide.c Error reading Image from IDE device 2081566a494fSHeiko Schocher 51 common/cmd_ide.c reading Image from IDE device OK 2082566a494fSHeiko Schocher 52 common/cmd_nand.c before loading a Image from a NAND device 2083566a494fSHeiko Schocher -53 common/cmd_nand.c Bad usage of "nand" command 2084566a494fSHeiko Schocher 53 common/cmd_nand.c correct usage of "nand" command 2085566a494fSHeiko Schocher -54 common/cmd_nand.c No boot device 2086566a494fSHeiko Schocher 54 common/cmd_nand.c boot device found 2087566a494fSHeiko Schocher -55 common/cmd_nand.c Unknown Chip ID on boot device 2088566a494fSHeiko Schocher 55 common/cmd_nand.c correct chip ID found, device available 2089566a494fSHeiko Schocher -56 common/cmd_nand.c Error reading Image Header on boot device 2090566a494fSHeiko Schocher 56 common/cmd_nand.c reading Image Header from NAND device OK 2091566a494fSHeiko Schocher -57 common/cmd_nand.c Image header has bad magic number 2092566a494fSHeiko Schocher 57 common/cmd_nand.c Image header has correct magic number 2093566a494fSHeiko Schocher -58 common/cmd_nand.c Error reading Image from NAND device 2094566a494fSHeiko Schocher 58 common/cmd_nand.c reading Image from NAND device OK 2095c609719bSwdenk 2096566a494fSHeiko Schocher -60 common/env_common.c Environment has a bad CRC, using default 2097c609719bSwdenk 2098566a494fSHeiko Schocher 64 net/eth.c starting with Ethernet configuration. 2099566a494fSHeiko Schocher -64 net/eth.c no Ethernet found. 2100566a494fSHeiko Schocher 65 net/eth.c Ethernet found. 2101206c60cbSwdenk 2102566a494fSHeiko Schocher -80 common/cmd_net.c usage wrong 2103566a494fSHeiko Schocher 80 common/cmd_net.c before calling NetLoop() 210411ccc33fSMarcel Ziswiler -81 common/cmd_net.c some error in NetLoop() occurred 2105566a494fSHeiko Schocher 81 common/cmd_net.c NetLoop() back without error 2106566a494fSHeiko Schocher -82 common/cmd_net.c size == 0 (File with size 0 loaded) 2107566a494fSHeiko Schocher 82 common/cmd_net.c trying automatic boot 210874de7aefSWolfgang Denk 83 common/cmd_net.c running "source" command 210974de7aefSWolfgang Denk -83 common/cmd_net.c some error in automatic boot or "source" command 2110566a494fSHeiko Schocher 84 common/cmd_net.c end without errors 2111c609719bSwdenk 21121372cce2SMarian BalakowiczFIT uImage format: 21131372cce2SMarian Balakowicz 21141372cce2SMarian Balakowicz Arg Where When 21151372cce2SMarian Balakowicz 100 common/cmd_bootm.c Kernel FIT Image has correct format 21161372cce2SMarian Balakowicz -100 common/cmd_bootm.c Kernel FIT Image has incorrect format 21171372cce2SMarian Balakowicz 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration 21181372cce2SMarian Balakowicz -101 common/cmd_bootm.c Can't get configuration for kernel subimage 21191372cce2SMarian Balakowicz 102 common/cmd_bootm.c Kernel unit name specified 21201372cce2SMarian Balakowicz -103 common/cmd_bootm.c Can't get kernel subimage node offset 2121f773bea8SMarian Balakowicz 103 common/cmd_bootm.c Found configuration node 21221372cce2SMarian Balakowicz 104 common/cmd_bootm.c Got kernel subimage node offset 21231372cce2SMarian Balakowicz -104 common/cmd_bootm.c Kernel subimage hash verification failed 21241372cce2SMarian Balakowicz 105 common/cmd_bootm.c Kernel subimage hash verification OK 21251372cce2SMarian Balakowicz -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture 21261372cce2SMarian Balakowicz 106 common/cmd_bootm.c Architecture check OK 212711ccc33fSMarcel Ziswiler -106 common/cmd_bootm.c Kernel subimage has wrong type 212811ccc33fSMarcel Ziswiler 107 common/cmd_bootm.c Kernel subimage type OK 21291372cce2SMarian Balakowicz -107 common/cmd_bootm.c Can't get kernel subimage data/size 21301372cce2SMarian Balakowicz 108 common/cmd_bootm.c Got kernel subimage data/size 21311372cce2SMarian Balakowicz -108 common/cmd_bootm.c Wrong image type (not legacy, FIT) 21321372cce2SMarian Balakowicz -109 common/cmd_bootm.c Can't get kernel subimage type 21331372cce2SMarian Balakowicz -110 common/cmd_bootm.c Can't get kernel subimage comp 21341372cce2SMarian Balakowicz -111 common/cmd_bootm.c Can't get kernel subimage os 21351372cce2SMarian Balakowicz -112 common/cmd_bootm.c Can't get kernel subimage load address 21361372cce2SMarian Balakowicz -113 common/cmd_bootm.c Image uncompress/copy overwrite error 21371372cce2SMarian Balakowicz 21381372cce2SMarian Balakowicz 120 common/image.c Start initial ramdisk verification 21391372cce2SMarian Balakowicz -120 common/image.c Ramdisk FIT image has incorrect format 21401372cce2SMarian Balakowicz 121 common/image.c Ramdisk FIT image has correct format 214111ccc33fSMarcel Ziswiler 122 common/image.c No ramdisk subimage unit name, using configuration 21421372cce2SMarian Balakowicz -122 common/image.c Can't get configuration for ramdisk subimage 21431372cce2SMarian Balakowicz 123 common/image.c Ramdisk unit name specified 21441372cce2SMarian Balakowicz -124 common/image.c Can't get ramdisk subimage node offset 21451372cce2SMarian Balakowicz 125 common/image.c Got ramdisk subimage node offset 21461372cce2SMarian Balakowicz -125 common/image.c Ramdisk subimage hash verification failed 21471372cce2SMarian Balakowicz 126 common/image.c Ramdisk subimage hash verification OK 21481372cce2SMarian Balakowicz -126 common/image.c Ramdisk subimage for unsupported architecture 21491372cce2SMarian Balakowicz 127 common/image.c Architecture check OK 21501372cce2SMarian Balakowicz -127 common/image.c Can't get ramdisk subimage data/size 21511372cce2SMarian Balakowicz 128 common/image.c Got ramdisk subimage data/size 21521372cce2SMarian Balakowicz 129 common/image.c Can't get ramdisk load address 21531372cce2SMarian Balakowicz -129 common/image.c Got ramdisk load address 21541372cce2SMarian Balakowicz 215511ccc33fSMarcel Ziswiler -130 common/cmd_doc.c Incorrect FIT image format 21561372cce2SMarian Balakowicz 131 common/cmd_doc.c FIT image format OK 21571372cce2SMarian Balakowicz 215811ccc33fSMarcel Ziswiler -140 common/cmd_ide.c Incorrect FIT image format 21591372cce2SMarian Balakowicz 141 common/cmd_ide.c FIT image format OK 21601372cce2SMarian Balakowicz 216111ccc33fSMarcel Ziswiler -150 common/cmd_nand.c Incorrect FIT image format 21621372cce2SMarian Balakowicz 151 common/cmd_nand.c FIT image format OK 21631372cce2SMarian Balakowicz 2164cccfc2abSDetlev Zundel- Automatic software updates via TFTP server 2165cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP 2166cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP_CNT_MAX 2167cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP_MSEC_MAX 2168cccfc2abSDetlev Zundel 2169cccfc2abSDetlev Zundel These options enable and control the auto-update feature; 2170cccfc2abSDetlev Zundel for a more detailed description refer to doc/README.update. 2171cccfc2abSDetlev Zundel 2172cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support) 2173cccfc2abSDetlev Zundel CONFIG_MTD_DEVICE 2174cccfc2abSDetlev Zundel 2175cccfc2abSDetlev Zundel Adds the MTD device infrastructure from the Linux kernel. 2176cccfc2abSDetlev Zundel Needed for mtdparts command support. 2177cccfc2abSDetlev Zundel 2178cccfc2abSDetlev Zundel CONFIG_MTD_PARTITIONS 2179cccfc2abSDetlev Zundel 2180cccfc2abSDetlev Zundel Adds the MTD partitioning infrastructure from the Linux 2181cccfc2abSDetlev Zundel kernel. Needed for UBI support. 2182cccfc2abSDetlev Zundel 21831372cce2SMarian Balakowicz 2184c609719bSwdenkModem Support: 2185c609719bSwdenk-------------- 2186c609719bSwdenk 218785ec0bccSwdenk[so far only for SMDK2400 and TRAB boards] 2188c609719bSwdenk 218911ccc33fSMarcel Ziswiler- Modem support enable: 2190c609719bSwdenk CONFIG_MODEM_SUPPORT 2191c609719bSwdenk 2192c609719bSwdenk- RTS/CTS Flow control enable: 2193c609719bSwdenk CONFIG_HWFLOW 2194c609719bSwdenk 2195c609719bSwdenk- Modem debug support: 2196c609719bSwdenk CONFIG_MODEM_SUPPORT_DEBUG 2197c609719bSwdenk 2198c609719bSwdenk Enables debugging stuff (char screen[1024], dbg()) 2199c609719bSwdenk for modem support. Useful only with BDI2000. 2200c609719bSwdenk 2201a8c7c708Swdenk- Interrupt support (PPC): 2202a8c7c708Swdenk 2203a8c7c708Swdenk There are common interrupt_init() and timer_interrupt() 2204a8c7c708Swdenk for all PPC archs. interrupt_init() calls interrupt_init_cpu() 220511ccc33fSMarcel Ziswiler for CPU specific initialization. interrupt_init_cpu() 2206a8c7c708Swdenk should set decrementer_count to appropriate value. If 220711ccc33fSMarcel Ziswiler CPU resets decrementer automatically after interrupt 2208a8c7c708Swdenk (ppc4xx) it should set decrementer_count to zero. 220911ccc33fSMarcel Ziswiler timer_interrupt() calls timer_interrupt_cpu() for CPU 2210a8c7c708Swdenk specific handling. If board has watchdog / status_led 2211a8c7c708Swdenk / other_activity_monitor it works automatically from 2212a8c7c708Swdenk general timer_interrupt(). 2213a8c7c708Swdenk 2214c609719bSwdenk- General: 2215c609719bSwdenk 2216c609719bSwdenk In the target system modem support is enabled when a 2217c609719bSwdenk specific key (key combination) is pressed during 2218c609719bSwdenk power-on. Otherwise U-Boot will boot normally 221911ccc33fSMarcel Ziswiler (autoboot). The key_pressed() function is called from 2220c609719bSwdenk board_init(). Currently key_pressed() is a dummy 2221c609719bSwdenk function, returning 1 and thus enabling modem 2222c609719bSwdenk initialization. 2223c609719bSwdenk 2224c609719bSwdenk If there are no modem init strings in the 2225c609719bSwdenk environment, U-Boot proceed to autoboot; the 2226c609719bSwdenk previous output (banner, info printfs) will be 222711ccc33fSMarcel Ziswiler suppressed, though. 2228c609719bSwdenk 2229c609719bSwdenk See also: doc/README.Modem 2230c609719bSwdenk 2231c609719bSwdenk 2232c609719bSwdenkConfiguration Settings: 2233c609719bSwdenk----------------------- 2234c609719bSwdenk 22356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included; 2236c609719bSwdenk undefine this when you're short of memory. 2237c609719bSwdenk 22382fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default 22392fb2604dSPeter Tyser width of the commands listed in the 'help' command output. 22402fb2604dSPeter Tyser 22416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to 2242c609719bSwdenk prompt for user input. 2243c609719bSwdenk 22446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE: Buffer size for input from the Console 2245c609719bSwdenk 22466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE: Buffer size for Console output 2247c609719bSwdenk 22486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands 2249c609719bSwdenk 22506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to 2251c609719bSwdenk the application (usually a Linux kernel) when it is 2252c609719bSwdenk booted 2253c609719bSwdenk 22546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE: 2255c609719bSwdenk List of legal baudrate settings for this board. 2256c609719bSwdenk 22576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET 2258c609719bSwdenk Suppress display of console information at boot. 2259c609719bSwdenk 22606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV 2261c609719bSwdenk If the board specific function 2262c609719bSwdenk extern int overwrite_console (void); 2263c609719bSwdenk returns 1, the stdin, stderr and stdout are switched to the 2264c609719bSwdenk serial port, else the settings in the environment are used. 2265c609719bSwdenk 22666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE 2267c609719bSwdenk Enable the call to overwrite_console(). 2268c609719bSwdenk 22696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE 2270c609719bSwdenk Enable overwrite of previous console environment settings. 2271c609719bSwdenk 22726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END: 2273c609719bSwdenk Begin and End addresses of the area used by the 2274c609719bSwdenk simple memory test. 2275c609719bSwdenk 22766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST: 2277c609719bSwdenk Enable an alternate, more extensive memory test. 2278c609719bSwdenk 22796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH: 22805f535fe1Swdenk Scratch address used by the alternate memory test 22815f535fe1Swdenk You only need to set this if address zero isn't writeable 22825f535fe1Swdenk 22836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only): 22846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header, 228514f73ca6SStefan Roese this specified memory area will get subtracted from the top 228611ccc33fSMarcel Ziswiler (end) of RAM and won't get "touched" at all by U-Boot. By 228714f73ca6SStefan Roese fixing up gd->ram_size the Linux kernel should gets passed 228814f73ca6SStefan Roese the now "corrected" memory size and won't touch it either. 228914f73ca6SStefan Roese This should work for arch/ppc and arch/powerpc. Only Linux 22905e12e75dSStefan Roese board ports in arch/powerpc with bootwrapper support that 229114f73ca6SStefan Roese recalculate the memory size from the SDRAM controller setup 22925e12e75dSStefan Roese will have to get fixed in Linux additionally. 229314f73ca6SStefan Roese 229414f73ca6SStefan Roese This option can be used as a workaround for the 440EPx/GRx 229514f73ca6SStefan Roese CHIP 11 errata where the last 256 bytes in SDRAM shouldn't 229614f73ca6SStefan Roese be touched. 229714f73ca6SStefan Roese 229814f73ca6SStefan Roese WARNING: Please make sure that this value is a multiple of 229914f73ca6SStefan Roese the Linux page size (normally 4k). If this is not the case, 230014f73ca6SStefan Roese then the end address of the Linux memory will be located at a 230114f73ca6SStefan Roese non page size aligned address and this could cause major 230214f73ca6SStefan Roese problems. 230314f73ca6SStefan Roese 23046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TFTP_LOADADDR: 2305c609719bSwdenk Default load address for network file downloads 2306c609719bSwdenk 23076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE: 2308c609719bSwdenk Enable temporary baudrate change while serial download 2309c609719bSwdenk 23106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE: 2311c609719bSwdenk Physical start address of SDRAM. _Must_ be 0 here. 2312c609719bSwdenk 23136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE: 2314c609719bSwdenk Physical start address of Motherboard I/O (if using a 2315c609719bSwdenk Cogent motherboard) 2316c609719bSwdenk 23176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE: 2318c609719bSwdenk Physical start address of Flash memory. 2319c609719bSwdenk 23206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE: 2321c609719bSwdenk Physical start address of boot monitor code (set by 2322c609719bSwdenk make config files to be same as the text base address 232314d0a02aSWolfgang Denk (CONFIG_SYS_TEXT_BASE) used when linking) - same as 23246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FLASH_BASE when booting from flash. 2325c609719bSwdenk 23266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN: 23273b57fe0aSwdenk Size of memory reserved for monitor code, used to 23283b57fe0aSwdenk determine _at_compile_time_ (!) if the environment is 23293b57fe0aSwdenk embedded within the U-Boot image, or in a separate 23303b57fe0aSwdenk flash sector. 2331c609719bSwdenk 23326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN: 2333c609719bSwdenk Size of DRAM reserved for malloc() use. 2334c609719bSwdenk 23356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN: 233615940c9aSStefan Roese Normally compressed uImages are limited to an 233715940c9aSStefan Roese uncompressed size of 8 MBytes. If this is not enough, 23386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD you can define CONFIG_SYS_BOOTM_LEN in your board config file 233915940c9aSStefan Roese to adjust this setting to your needs. 2340c609719bSwdenk 23416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ: 2342c609719bSwdenk Maximum size of memory mapped by the startup code of 2343c609719bSwdenk the Linux kernel; all data that must be processed by 23447d721e34SBartlomiej Sieka the Linux kernel (bd_info, boot arguments, FDT blob if 23457d721e34SBartlomiej Sieka used) must be put below this limit, unless "bootm_low" 23467d721e34SBartlomiej Sieka enviroment variable is defined and non-zero. In such case 23477d721e34SBartlomiej Sieka all data for the Linux kernel must be between "bootm_low" 23486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. 2349c609719bSwdenk 2350fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH: 2351fca43cc8SJohn Rigby Enable initrd_high functionality. If defined then the 2352fca43cc8SJohn Rigby initrd_high feature is enabled and the bootm ramdisk subcommand 2353fca43cc8SJohn Rigby is enabled. 2354fca43cc8SJohn Rigby 2355fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE: 2356fca43cc8SJohn Rigby Enables allocating and saving kernel cmdline in space between 2357fca43cc8SJohn Rigby "bootm_low" and "bootm_low" + BOOTMAPSZ. 2358fca43cc8SJohn Rigby 2359fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD: 2360fca43cc8SJohn Rigby Enables allocating and saving a kernel copy of the bd_info in 2361fca43cc8SJohn Rigby space between "bootm_low" and "bootm_low" + BOOTMAPSZ. 2362fca43cc8SJohn Rigby 23636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS: 2364c609719bSwdenk Max number of Flash memory banks 2365c609719bSwdenk 23666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT: 2367c609719bSwdenk Max number of sectors on a Flash chip 2368c609719bSwdenk 23696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT: 2370c609719bSwdenk Timeout for Flash erase operations (in ms) 2371c609719bSwdenk 23726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT: 2373c609719bSwdenk Timeout for Flash write operations (in ms) 2374c609719bSwdenk 23756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT 23768564acf9Swdenk Timeout for Flash set sector lock bit operation (in ms) 23778564acf9Swdenk 23786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT 23798564acf9Swdenk Timeout for Flash clear lock bits operation (in ms) 23808564acf9Swdenk 23816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION 23828564acf9Swdenk If defined, hardware flash sectors protection is used 23838564acf9Swdenk instead of U-Boot software protection. 23848564acf9Swdenk 23856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP: 2386c609719bSwdenk 2387c609719bSwdenk Enable TFTP transfers directly to flash memory; 2388c609719bSwdenk without this option such a download has to be 2389c609719bSwdenk performed in two steps: (1) download to RAM, and (2) 2390c609719bSwdenk copy from RAM to flash. 2391c609719bSwdenk 2392c609719bSwdenk The two-step approach is usually more reliable, since 2393c609719bSwdenk you can check if the download worked before you erase 239411ccc33fSMarcel Ziswiler the flash, but in some situations (when system RAM is 239511ccc33fSMarcel Ziswiler too limited to allow for a temporary copy of the 2396c609719bSwdenk downloaded image) this option may be very useful. 2397c609719bSwdenk 23986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI: 2399c609719bSwdenk Define if the flash driver uses extra elements in the 24005653fc33Swdenk common flash structure for storing flash geometry. 24015653fc33Swdenk 240200b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER 24035653fc33Swdenk This option also enables the building of the cfi_flash driver 24045653fc33Swdenk in the drivers directory 240553cf9435Sstroese 240691809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD 240791809ed5SPiotr Ziecik This option enables the building of the cfi_mtd driver 240891809ed5SPiotr Ziecik in the drivers directory. The driver exports CFI flash 240991809ed5SPiotr Ziecik to the MTD layer. 241091809ed5SPiotr Ziecik 24116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE 241296ef831fSGuennadi Liakhovetski Use buffered writes to flash. 241396ef831fSGuennadi Liakhovetski 241496ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N 241596ef831fSGuennadi Liakhovetski s29ws-n MirrorBit flash has non-standard addresses for buffered 241696ef831fSGuennadi Liakhovetski write commands. 241796ef831fSGuennadi Liakhovetski 24186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST 24195568e613SStefan Roese If this option is defined, the common CFI flash doesn't 24205568e613SStefan Roese print it's warning upon not recognized FLASH banks. This 24215568e613SStefan Roese is useful, if some of the configured banks are only 24225568e613SStefan Roese optionally available. 24235568e613SStefan Roese 24249a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS 24259a042e9cSJerry Van Baren If defined (must be an integer), print out countdown 24269a042e9cSJerry Van Baren digits and dots. Recommended value: 45 (9..1) for 80 24279a042e9cSJerry Van Baren column displays, 15 (3..1) for 40 column displays. 24289a042e9cSJerry Van Baren 24296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER: 243011ccc33fSMarcel Ziswiler Defines the number of Ethernet receive buffers. On some 243111ccc33fSMarcel Ziswiler Ethernet controllers it is recommended to set this value 243253cf9435Sstroese to 8 or even higher (EEPRO100 or 405 EMAC), since all 243353cf9435Sstroese buffers can be full shortly after enabling the interface 243411ccc33fSMarcel Ziswiler on high Ethernet traffic. 243553cf9435Sstroese Defaults to 4 if not defined. 2436c609719bSwdenk 2437ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES 2438ea882bafSWolfgang Denk 2439ea882bafSWolfgang Denk Maximum number of entries in the hash table that is used 2440ea882bafSWolfgang Denk internally to store the environment settings. The default 2441ea882bafSWolfgang Denk setting is supposed to be generous and should work in most 2442ea882bafSWolfgang Denk cases. This setting can be used to tune behaviour; see 2443ea882bafSWolfgang Denk lib/hashtable.c for details. 2444ea882bafSWolfgang Denk 2445c609719bSwdenkThe following definitions that deal with the placement and management 2446c609719bSwdenkof environment data (variable area); in general, we support the 2447c609719bSwdenkfollowing configurations: 2448c609719bSwdenk 24495a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH: 2450c609719bSwdenk 2451c609719bSwdenk Define this if the environment is in flash memory. 2452c609719bSwdenk 2453c609719bSwdenk a) The environment occupies one whole flash sector, which is 2454c609719bSwdenk "embedded" in the text segment with the U-Boot code. This 2455c609719bSwdenk happens usually with "bottom boot sector" or "top boot 2456c609719bSwdenk sector" type flash chips, which have several smaller 2457c609719bSwdenk sectors at the start or the end. For instance, such a 2458c609719bSwdenk layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In 2459c609719bSwdenk such a case you would place the environment in one of the 2460c609719bSwdenk 4 kB sectors - with U-Boot code before and after it. With 2461c609719bSwdenk "top boot sector" type flash chips, you would put the 2462c609719bSwdenk environment in one of the last sectors, leaving a gap 2463c609719bSwdenk between U-Boot and the environment. 2464c609719bSwdenk 24650e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 2466c609719bSwdenk 2467c609719bSwdenk Offset of environment data (variable area) to the 2468c609719bSwdenk beginning of flash memory; for instance, with bottom boot 2469c609719bSwdenk type flash chips the second sector can be used: the offset 2470c609719bSwdenk for this sector is given here. 2471c609719bSwdenk 24726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE. 2473c609719bSwdenk 24740e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 2475c609719bSwdenk 2476c609719bSwdenk This is just another way to specify the start address of 2477c609719bSwdenk the flash sector containing the environment (instead of 24780e8d1586SJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_OFFSET). 2479c609719bSwdenk 24800e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SECT_SIZE: 2481c609719bSwdenk 2482c609719bSwdenk Size of the sector containing the environment. 2483c609719bSwdenk 2484c609719bSwdenk 2485c609719bSwdenk b) Sometimes flash chips have few, equal sized, BIG sectors. 2486c609719bSwdenk In such a case you don't want to spend a whole sector for 2487c609719bSwdenk the environment. 2488c609719bSwdenk 24890e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 2490c609719bSwdenk 24915a1aceb0SJean-Christophe PLAGNIOL-VILLARD If you use this in combination with CONFIG_ENV_IS_IN_FLASH 24920e8d1586SJean-Christophe PLAGNIOL-VILLARD and CONFIG_ENV_SECT_SIZE, you can specify to use only a part 2493c609719bSwdenk of this flash sector for the environment. This saves 2494c609719bSwdenk memory for the RAM copy of the environment. 2495c609719bSwdenk 2496c609719bSwdenk It may also save flash memory if you decide to use this 2497c609719bSwdenk when your environment is "embedded" within U-Boot code, 2498c609719bSwdenk since then the remainder of the flash sector could be used 2499c609719bSwdenk for U-Boot code. It should be pointed out that this is 2500c609719bSwdenk STRONGLY DISCOURAGED from a robustness point of view: 2501c609719bSwdenk updating the environment in flash makes it always 2502c609719bSwdenk necessary to erase the WHOLE sector. If something goes 2503c609719bSwdenk wrong before the contents has been restored from a copy in 2504c609719bSwdenk RAM, your target system will be dead. 2505c609719bSwdenk 25060e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR_REDUND 25070e8d1586SJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_SIZE_REDUND 2508c609719bSwdenk 2509c609719bSwdenk These settings describe a second storage area used to hold 251011ccc33fSMarcel Ziswiler a redundant copy of the environment data, so that there is 25113e38691eSwdenk a valid backup copy in case there is a power failure during 2512c609719bSwdenk a "saveenv" operation. 2513c609719bSwdenk 2514c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the 2515c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds* 2516c609719bSwdenkaccordingly! 2517c609719bSwdenk 2518c609719bSwdenk 25199314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM: 2520c609719bSwdenk 2521c609719bSwdenk Define this if you have some non-volatile memory device 2522c609719bSwdenk (NVRAM, battery buffered SRAM) which you want to use for the 2523c609719bSwdenk environment. 2524c609719bSwdenk 25250e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 25260e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 2527c609719bSwdenk 252811ccc33fSMarcel Ziswiler These two #defines are used to determine the memory area you 2529c609719bSwdenk want to use for environment. It is assumed that this memory 2530c609719bSwdenk can just be read and written to, without any special 2531c609719bSwdenk provision. 2532c609719bSwdenk 2533c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early 2534c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the 253511ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or 2536c609719bSwdenkU-Boot will hang. 2537c609719bSwdenk 2538c609719bSwdenkPlease note that even with NVRAM we still use a copy of the 2539c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to 2540c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv" 2541c609719bSwdenkto save the current settings. 2542c609719bSwdenk 2543c609719bSwdenk 2544bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM: 2545c609719bSwdenk 2546c609719bSwdenk Use this if you have an EEPROM or similar serial access 2547c609719bSwdenk device and a driver for it. 2548c609719bSwdenk 25490e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 25500e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 2551c609719bSwdenk 2552c609719bSwdenk These two #defines specify the offset and size of the 2553c609719bSwdenk environment area within the total memory of your EEPROM. 2554c609719bSwdenk 25556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR: 2556c609719bSwdenk If defined, specified the chip address of the EEPROM device. 2557c609719bSwdenk The default address is zero. 2558c609719bSwdenk 25596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS: 2560c609719bSwdenk If defined, the number of bits used to address bytes in a 2561c609719bSwdenk single page in the EEPROM device. A 64 byte page, for example 2562c609719bSwdenk would require six bits. 2563c609719bSwdenk 25646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS: 2565c609719bSwdenk If defined, the number of milliseconds to delay between 2566c609719bSwdenk page writes. The default is zero milliseconds. 2567c609719bSwdenk 25686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR_LEN: 2569c609719bSwdenk The length in bytes of the EEPROM memory array address. Note 2570c609719bSwdenk that this is NOT the chip address length! 2571c609719bSwdenk 25726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW: 25735cf91d6bSwdenk EEPROM chips that implement "address overflow" are ones 25745cf91d6bSwdenk like Catalyst 24WC04/08/16 which has 9/10/11 bits of 25755cf91d6bSwdenk address and the extra bits end up in the "chip address" bit 25765cf91d6bSwdenk slots. This makes a 24WC08 (1Kbyte) chip look like four 256 25775cf91d6bSwdenk byte chips. 25785cf91d6bSwdenk 25795cf91d6bSwdenk Note that we consider the length of the address field to 25805cf91d6bSwdenk still be one byte because the extra address bits are hidden 25815cf91d6bSwdenk in the chip address. 25825cf91d6bSwdenk 25836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_SIZE: 2584c609719bSwdenk The size in bytes of the EEPROM device. 2585c609719bSwdenk 2586548738b4SHeiko Schocher - CONFIG_ENV_EEPROM_IS_ON_I2C 2587548738b4SHeiko Schocher define this, if you have I2C and SPI activated, and your 2588548738b4SHeiko Schocher EEPROM, which holds the environment, is on the I2C bus. 2589548738b4SHeiko Schocher 2590548738b4SHeiko Schocher - CONFIG_I2C_ENV_EEPROM_BUS 2591548738b4SHeiko Schocher if you have an Environment on an EEPROM reached over 2592548738b4SHeiko Schocher I2C muxes, you can define here, how to reach this 2593548738b4SHeiko Schocher EEPROM. For example: 2594548738b4SHeiko Schocher 2595548738b4SHeiko Schocher #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0" 2596548738b4SHeiko Schocher 2597548738b4SHeiko Schocher EEPROM which holds the environment, is reached over 2598548738b4SHeiko Schocher a pca9547 i2c mux with address 0x70, channel 3. 2599c609719bSwdenk 2600057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH: 26015779d8d9Swdenk 26025779d8d9Swdenk Define this if you have a DataFlash memory device which you 26035779d8d9Swdenk want to use for the environment. 26045779d8d9Swdenk 26050e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 26060e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 26070e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 26085779d8d9Swdenk 26095779d8d9Swdenk These three #defines specify the offset and size of the 26105779d8d9Swdenk environment area within the total memory of your DataFlash placed 26115779d8d9Swdenk at the specified address. 26125779d8d9Swdenk 261351bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND: 261413a5695bSwdenk 261513a5695bSwdenk Define this if you have a NAND device which you want to use 261613a5695bSwdenk for the environment. 261713a5695bSwdenk 26180e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 26190e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 262013a5695bSwdenk 262113a5695bSwdenk These two #defines specify the offset and size of the environment 2622fdd813deSScott Wood area within the first NAND device. CONFIG_ENV_OFFSET must be 2623fdd813deSScott Wood aligned to an erase block boundary. 26245779d8d9Swdenk 2625fdd813deSScott Wood - CONFIG_ENV_OFFSET_REDUND (optional): 2626e443c944SMarkus Klotzbuecher 26270e8d1586SJean-Christophe PLAGNIOL-VILLARD This setting describes a second storage area of CONFIG_ENV_SIZE 2628fdd813deSScott Wood size used to hold a redundant copy of the environment data, so 2629fdd813deSScott Wood that there is a valid backup copy in case there is a power failure 2630fdd813deSScott Wood during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be 2631fdd813deSScott Wood aligned to an erase block boundary. 2632e443c944SMarkus Klotzbuecher 2633fdd813deSScott Wood - CONFIG_ENV_RANGE (optional): 2634fdd813deSScott Wood 2635fdd813deSScott Wood Specifies the length of the region in which the environment 2636fdd813deSScott Wood can be written. This should be a multiple of the NAND device's 2637fdd813deSScott Wood block size. Specifying a range with more erase blocks than 2638fdd813deSScott Wood are needed to hold CONFIG_ENV_SIZE allows bad blocks within 2639fdd813deSScott Wood the range to be avoided. 2640fdd813deSScott Wood 2641fdd813deSScott Wood - CONFIG_ENV_OFFSET_OOB (optional): 2642fdd813deSScott Wood 2643fdd813deSScott Wood Enables support for dynamically retrieving the offset of the 2644fdd813deSScott Wood environment from block zero's out-of-band data. The 2645fdd813deSScott Wood "nand env.oob" command can be used to record this offset. 2646fdd813deSScott Wood Currently, CONFIG_ENV_OFFSET_REDUND is not supported when 2647fdd813deSScott Wood using CONFIG_ENV_OFFSET_OOB. 2648e443c944SMarkus Klotzbuecher 2649b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST 2650b74ab737SGuennadi Liakhovetski 2651b74ab737SGuennadi Liakhovetski Defines address in RAM to which the nand_spl code should copy the 2652b74ab737SGuennadi Liakhovetski environment. If redundant environment is used, it will be copied to 2653b74ab737SGuennadi Liakhovetski CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE. 2654b74ab737SGuennadi Liakhovetski 26556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET 2656c609719bSwdenk 2657c609719bSwdenk Defines offset to the initial SPI buffer area in DPRAM. The 2658c609719bSwdenk area is used at an early stage (ROM part) if the environment 2659c609719bSwdenk is configured to reside in the SPI EEPROM: We need a 520 byte 2660c609719bSwdenk scratch DPRAM area. It is used between the two initialization 2661c609719bSwdenk calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems 2662c609719bSwdenk to be a good choice since it makes it far enough from the 2663c609719bSwdenk start of the data area as well as from the stack pointer. 2664c609719bSwdenk 2665e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor 2666c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been 2667cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f() 2668c609719bSwdenkuntil then to read environment variables. 2669c609719bSwdenk 267085ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor 267185ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working 267285ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is 267385ec0bccSwdenknecessary, because the first environment variable we need is the 267485ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't 267585ec0bccSwdenkhave any device yet where we could complain.] 2676c609719bSwdenk 2677c609719bSwdenkNote: once the monitor has been relocated, then it will complain if 2678c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you 267985ec0bccSwdenkuse the "saveenv" command to store a valid environment. 2680c609719bSwdenk 26816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN: 2682fc3e2165Swdenk Echo the inverted Ethernet link state to the fault LED. 2683fc3e2165Swdenk 26846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR 2685fc3e2165Swdenk also needs to be defined. 2686fc3e2165Swdenk 26876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR: 2688fc3e2165Swdenk MII address of the PHY to check for the Ethernet link state. 2689c609719bSwdenk 2690f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS: 2691f5675aa5SRon Madrid Define this if you desire to only have use of the NS16550_init 2692f5675aa5SRon Madrid and NS16550_putc functions for the serial driver located at 2693f5675aa5SRon Madrid drivers/serial/ns16550.c. This option is useful for saving 2694f5675aa5SRon Madrid space for already greatly restricted images, including but not 2695f5675aa5SRon Madrid limited to NAND_SPL configurations. 2696f5675aa5SRon Madrid 2697c609719bSwdenkLow Level (hardware related) configuration options: 2698dc7c9a1aSwdenk--------------------------------------------------- 2699c609719bSwdenk 27006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE: 2701c609719bSwdenk Cache Line Size of the CPU. 2702c609719bSwdenk 27036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR: 2704c609719bSwdenk Default address of the IMMR after system reset. 27052535d602Swdenk 27062535d602Swdenk Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU, 27072535d602Swdenk and RPXsuper) to be able to adjust the position of 27082535d602Swdenk the IMMR register after a reset. 2709c609719bSwdenk 27107f6c2cbcSwdenk- Floppy Disk Support: 27116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FDC_DRIVE_NUMBER 27127f6c2cbcSwdenk 27137f6c2cbcSwdenk the default drive number (default value 0) 27147f6c2cbcSwdenk 27156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_ISA_IO_STRIDE 27167f6c2cbcSwdenk 271711ccc33fSMarcel Ziswiler defines the spacing between FDC chipset registers 27187f6c2cbcSwdenk (default value 1) 27197f6c2cbcSwdenk 27206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_ISA_IO_OFFSET 27217f6c2cbcSwdenk 27227f6c2cbcSwdenk defines the offset of register from address. It 27237f6c2cbcSwdenk depends on which part of the data bus is connected to 272411ccc33fSMarcel Ziswiler the FDC chipset. (default value 0) 27257f6c2cbcSwdenk 27266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and 27276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their 27287f6c2cbcSwdenk default value. 27297f6c2cbcSwdenk 27306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD if CONFIG_SYS_FDC_HW_INIT is defined, then the function 27317f6c2cbcSwdenk fdc_hw_init() is called at the beginning of the FDC 27327f6c2cbcSwdenk setup. fdc_hw_init() must be provided by the board 27337f6c2cbcSwdenk source code. It is used to make hardware dependant 27347f6c2cbcSwdenk initializations. 27357f6c2cbcSwdenk 27366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR: Physical address of the Internal Memory. 273725d6712aSwdenk DO NOT CHANGE unless you know exactly what you're 273825d6712aSwdenk doing! (11-4) [MPC8xx/82xx systems only] 2739c609719bSwdenk 27406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR: 2741c609719bSwdenk 27427152b1d0Swdenk Start address of memory area that can be used for 2743c609719bSwdenk initial data and stack; please note that this must be 2744c609719bSwdenk writable memory that is working WITHOUT special 2745c609719bSwdenk initialization, i. e. you CANNOT use normal RAM which 2746c609719bSwdenk will become available only after programming the 2747c609719bSwdenk memory controller and running certain initialization 2748c609719bSwdenk sequences. 2749c609719bSwdenk 2750c609719bSwdenk U-Boot uses the following memory types: 2751c609719bSwdenk - MPC8xx and MPC8260: IMMR (internal memory of the CPU) 2752c609719bSwdenk - MPC824X: data cache 2753c609719bSwdenk - PPC4xx: data cache 2754c609719bSwdenk 27556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET: 2756c609719bSwdenk 2757c609719bSwdenk Offset of the initial data structure in the memory 27586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually 27596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial 2760c609719bSwdenk data is located at the end of the available space 2761553f0982SWolfgang Denk (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE - 27626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just 27636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR + 27646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_GBL_DATA_OFFSET) downward. 2765c609719bSwdenk 2766c609719bSwdenk Note: 2767c609719bSwdenk On the MPC824X (or other systems that use the data 2768c609719bSwdenk cache for initial memory) the address chosen for 27696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must 2770c609719bSwdenk point to an otherwise UNUSED address space between 2771c609719bSwdenk the top of RAM and the start of the PCI space. 2772c609719bSwdenk 27736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6) 2774c609719bSwdenk 27756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR: System Protection Control (11-9) 2776c609719bSwdenk 27776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26) 2778c609719bSwdenk 27796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31) 2780c609719bSwdenk 27816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30) 2782c609719bSwdenk 27836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27) 2784c609719bSwdenk 27856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM: 2786c609719bSwdenk SDRAM timing 2787c609719bSwdenk 27886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA: 2789c609719bSwdenk periodic timer for refresh 2790c609719bSwdenk 27916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER: Debug Event Register (37-47) 2792c609719bSwdenk 27936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM, 27946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP, 27956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM, 27966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BR1_PRELIM: 2797c609719bSwdenk Memory Controller Definitions: BR0/1 and OR0/1 (FLASH) 2798c609719bSwdenk 2799c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE, 28006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM, 28016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM: 2802c609719bSwdenk Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM) 2803c609719bSwdenk 28046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K, 28056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL: 2806c609719bSwdenk Machine Mode Register and Memory Periodic Timer 2807c609719bSwdenk Prescaler definitions (SDRAM timing) 2808c609719bSwdenk 28096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]: 2810c609719bSwdenk enable I2C microcode relocation patch (MPC8xx); 2811c609719bSwdenk define relocation offset in DPRAM [DSP2] 2812c609719bSwdenk 28136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]: 2814b423d055SHeiko Schocher enable SMC microcode relocation patch (MPC8xx); 2815b423d055SHeiko Schocher define relocation offset in DPRAM [SMC1] 2816b423d055SHeiko Schocher 28176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]: 2818c609719bSwdenk enable SPI microcode relocation patch (MPC8xx); 2819c609719bSwdenk define relocation offset in DPRAM [SCC4] 2820c609719bSwdenk 28216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK: 2822c609719bSwdenk Use OSCM clock mode on MBX8xx board. Be careful, 2823c609719bSwdenk wrong setting might damage your board. Read 2824c609719bSwdenk doc/README.MBX before setting this variable! 2825c609719bSwdenk 28266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only) 2827ea909b76Swdenk Offset of the bootmode word in DPRAM used by post 2828ea909b76Swdenk (Power On Self Tests). This definition overrides 2829ea909b76Swdenk #define'd default value in commproc.h resp. 2830ea909b76Swdenk cpm_8260.h. 2831ea909b76Swdenk 28326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB, 28336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL, 28346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS, 28356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB, 28366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START, 28376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL, 28386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE, 28396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only) 2840a47a12beSStefan Roese Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set. 28415d232d0eSwdenk 28429cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE: 28439cacf4fcSDirk Eibach Disable PCI-Express on systems where it is supported but not 28449cacf4fcSDirk Eibach required. 28459cacf4fcSDirk Eibach 2846a09b9b68SKumar Gala- CONFIG_SYS_SRIO: 2847a09b9b68SKumar Gala Chip has SRIO or not 2848a09b9b68SKumar Gala 2849a09b9b68SKumar Gala- CONFIG_SRIO1: 2850a09b9b68SKumar Gala Board has SRIO 1 port available 2851a09b9b68SKumar Gala 2852a09b9b68SKumar Gala- CONFIG_SRIO2: 2853a09b9b68SKumar Gala Board has SRIO 2 port available 2854a09b9b68SKumar Gala 2855a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT: 2856a09b9b68SKumar Gala Virtual Address of SRIO port 'n' memory region 2857a09b9b68SKumar Gala 2858a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS: 2859a09b9b68SKumar Gala Physical Address of SRIO port 'n' memory region 2860a09b9b68SKumar Gala 2861a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE: 2862a09b9b68SKumar Gala Size of SRIO port 'n' memory region 2863a09b9b68SKumar Gala 2864bb99ad6dSBen Warren- CONFIG_SPD_EEPROM 2865218ca724SWolfgang Denk Get DDR timing information from an I2C EEPROM. Common 2866218ca724SWolfgang Denk with pluggable memory modules such as SODIMMs 2867218ca724SWolfgang Denk 2868bb99ad6dSBen Warren SPD_EEPROM_ADDRESS 2869bb99ad6dSBen Warren I2C address of the SPD EEPROM 2870bb99ad6dSBen Warren 28716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM 2872218ca724SWolfgang Denk If SPD EEPROM is on an I2C bus other than the first 2873218ca724SWolfgang Denk one, specify here. Note that the value must resolve 2874218ca724SWolfgang Denk to something your driver can deal with. 2875bb99ad6dSBen Warren 28766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0 2877218ca724SWolfgang Denk Only for 83xx systems. If specified, then DDR should 2878218ca724SWolfgang Denk be configured using CS0 and CS1 instead of CS2 and CS3. 28792ad6b513STimur Tabi 2880c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12] 2881c26e454dSwdenk Define to enable FEC[12] on a 8xx series processor. 2882c26e454dSwdenk 2883c26e454dSwdenk- CONFIG_FEC[12]_PHY 2884c26e454dSwdenk Define to the hardcoded PHY address which corresponds 28856e592385Swdenk to the given FEC; i. e. 2886c26e454dSwdenk #define CONFIG_FEC1_PHY 4 2887c26e454dSwdenk means that the PHY with address 4 is connected to FEC1 2888c26e454dSwdenk 2889c26e454dSwdenk When set to -1, means to probe for first available. 2890c26e454dSwdenk 2891c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR 2892c26e454dSwdenk The PHY does not have a RXERR line (RMII only). 2893c26e454dSwdenk (so program the FEC to ignore it). 2894c26e454dSwdenk 2895c26e454dSwdenk- CONFIG_RMII 2896c26e454dSwdenk Enable RMII mode for all FECs. 2897c26e454dSwdenk Note that this is a global option, we can't 2898c26e454dSwdenk have one FEC in standard MII mode and another in RMII mode. 2899c26e454dSwdenk 29005cf91d6bSwdenk- CONFIG_CRC32_VERIFY 29015cf91d6bSwdenk Add a verify option to the crc32 command. 29025cf91d6bSwdenk The syntax is: 29035cf91d6bSwdenk 29045cf91d6bSwdenk => crc32 -v <address> <count> <crc32> 29055cf91d6bSwdenk 29065cf91d6bSwdenk Where address/count indicate a memory area 29075cf91d6bSwdenk and crc32 is the correct crc32 which the 29085cf91d6bSwdenk area should have. 29095cf91d6bSwdenk 291056523f12Swdenk- CONFIG_LOOPW 291156523f12Swdenk Add the "loopw" memory command. This only takes effect if 2912602ad3b3SJon Loeliger the memory commands are activated globally (CONFIG_CMD_MEM). 291356523f12Swdenk 29147b466641Sstroese- CONFIG_MX_CYCLIC 29157b466641Sstroese Add the "mdc" and "mwc" memory commands. These are cyclic 29167b466641Sstroese "md/mw" commands. 29177b466641Sstroese Examples: 29187b466641Sstroese 29197b466641Sstroese => mdc.b 10 4 500 29207b466641Sstroese This command will print 4 bytes (10,11,12,13) each 500 ms. 29217b466641Sstroese 29227b466641Sstroese => mwc.l 100 12345678 10 29237b466641Sstroese This command will write 12345678 to address 100 all 10 ms. 29247b466641Sstroese 29257b466641Sstroese This only takes effect if the memory commands are activated 2926602ad3b3SJon Loeliger globally (CONFIG_CMD_MEM). 29277b466641Sstroese 29288aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT 2929e03f3169SWolfgang Denk [ARM only] If this variable is defined, then certain 2930e03f3169SWolfgang Denk low level initializations (like setting up the memory 2931e03f3169SWolfgang Denk controller) are omitted and/or U-Boot does not 2932e03f3169SWolfgang Denk relocate itself into RAM. 29338aa1a2d1Swdenk 2934e03f3169SWolfgang Denk Normally this variable MUST NOT be defined. The only 2935e03f3169SWolfgang Denk exception is when U-Boot is loaded (to RAM) by some 2936e03f3169SWolfgang Denk other boot loader or by a debugger which performs 2937e03f3169SWolfgang Denk these initializations itself. 29388aa1a2d1Swdenk 2939df81238bSMagnus Lilja- CONFIG_PRELOADER 2940df81238bSMagnus Lilja Modifies the behaviour of start.S when compiling a loader 2941df81238bSMagnus Lilja that is executed before the actual U-Boot. E.g. when 2942df81238bSMagnus Lilja compiling a NAND SPL. 2943400558b5Swdenk 2944c609719bSwdenkBuilding the Software: 2945c609719bSwdenk====================== 2946c609719bSwdenk 2947218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments 2948218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support 2949218ca724SWolfgang Denkall possibly existing versions of cross development tools in all 2950218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we 2951218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK) 2952218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot. 2953c609719bSwdenk 2954218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you 2955218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case, 2956218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell. 2957218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are 2958218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter: 2959c609719bSwdenk 2960218ca724SWolfgang Denk $ CROSS_COMPILE=ppc_4xx- 2961218ca724SWolfgang Denk $ export CROSS_COMPILE 2962c609719bSwdenk 29632f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in 29642f8d396bSPeter Tyser the tools directory you can use the MinGW toolchain 29652f8d396bSPeter Tyser (http://www.mingw.org). Set your HOST tools to the MinGW 29662f8d396bSPeter Tyser toolchain and execute 'make tools'. For example: 29672f8d396bSPeter Tyser 29682f8d396bSPeter Tyser $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools 29692f8d396bSPeter Tyser 29702f8d396bSPeter Tyser Binaries such as tools/mkimage.exe will be created which can 29712f8d396bSPeter Tyser be executed on computers running Windows. 29722f8d396bSPeter Tyser 2973c609719bSwdenkU-Boot is intended to be simple to build. After installing the 2974c609719bSwdenksources you must configure U-Boot for one specific board type. This 2975c609719bSwdenkis done by typing: 2976c609719bSwdenk 2977c609719bSwdenk make NAME_config 2978c609719bSwdenk 2979218ca724SWolfgang Denkwhere "NAME_config" is the name of one of the existing configu- 2980218ca724SWolfgang Denkrations; see the main Makefile for supported names. 298154387ac9Swdenk 2982c609719bSwdenkNote: for some board special configuration names may exist; check if 2983c609719bSwdenk additional information is available from the board vendor; for 29842729af9dSwdenk instance, the TQM823L systems are available without (standard) 29852729af9dSwdenk or with LCD support. You can select such additional "features" 298611ccc33fSMarcel Ziswiler when choosing the configuration, i. e. 2987c609719bSwdenk 29882729af9dSwdenk make TQM823L_config 29892729af9dSwdenk - will configure for a plain TQM823L, i. e. no LCD support 2990c609719bSwdenk 2991c609719bSwdenk make TQM823L_LCD_config 2992c609719bSwdenk - will configure for a TQM823L with U-Boot console on LCD 2993c609719bSwdenk 2994c609719bSwdenk etc. 2995c609719bSwdenk 2996c609719bSwdenk 2997c609719bSwdenkFinally, type "make all", and you should get some working U-Boot 29987152b1d0Swdenkimages ready for download to / installation on your system: 2999c609719bSwdenk 3000c609719bSwdenk- "u-boot.bin" is a raw binary image 3001c609719bSwdenk- "u-boot" is an image in ELF binary format 3002c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format 3003c609719bSwdenk 3004baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved 3005baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change 3006baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory: 3007baf31249SMarian Balakowicz 3008baf31249SMarian Balakowicz1. Add O= to the make command line invocations: 3009baf31249SMarian Balakowicz 3010baf31249SMarian Balakowicz make O=/tmp/build distclean 3011baf31249SMarian Balakowicz make O=/tmp/build NAME_config 3012baf31249SMarian Balakowicz make O=/tmp/build all 3013baf31249SMarian Balakowicz 3014baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location: 3015baf31249SMarian Balakowicz 3016baf31249SMarian Balakowicz export BUILD_DIR=/tmp/build 3017baf31249SMarian Balakowicz make distclean 3018baf31249SMarian Balakowicz make NAME_config 3019baf31249SMarian Balakowicz make all 3020baf31249SMarian Balakowicz 3021baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment 3022baf31249SMarian Balakowiczvariable. 3023baf31249SMarian Balakowicz 3024c609719bSwdenk 3025c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so 3026c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of 3027c609719bSwdenknative "make". 3028c609719bSwdenk 3029c609719bSwdenk 3030c609719bSwdenkIf the system board that you have is not listed, then you will need 3031c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these 3032c609719bSwdenksteps: 3033c609719bSwdenk 3034c609719bSwdenk1. Add a new configuration option for your board to the toplevel 303585ec0bccSwdenk "Makefile" and to the "MAKEALL" script, using the existing 303685ec0bccSwdenk entries as examples. Note that here and at many other places 30377152b1d0Swdenk boards and other names are listed in alphabetical sort order. Please 303885ec0bccSwdenk keep this order. 3039c609719bSwdenk2. Create a new directory to hold your board specific code. Add any 304085ec0bccSwdenk files you need. In your board directory, you will need at least 304185ec0bccSwdenk the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds". 304285ec0bccSwdenk3. Create a new configuration file "include/configs/<board>.h" for 304385ec0bccSwdenk your board 3044c609719bSwdenk3. If you're porting U-Boot to a new CPU, then also create a new 3045c609719bSwdenk directory to hold your CPU specific code. Add any files you need. 304685ec0bccSwdenk4. Run "make <board>_config" with your new name. 3047c609719bSwdenk5. Type "make", and you should get a working "u-boot.srec" file 3048c609719bSwdenk to be installed on your target system. 304985ec0bccSwdenk6. Debug and solve any problems that might arise. 3050c609719bSwdenk [Of course, this last step is much harder than it sounds.] 3051c609719bSwdenk 3052c609719bSwdenk 3053c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.: 3054c609719bSwdenk============================================================== 3055c609719bSwdenk 3056c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board 3057c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to 3058c609719bSwdenkprovide feedback to the other developers. The feedback normally takes 3059c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest 3060218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources. 3061c609719bSwdenk 3062c609719bSwdenkBut before you submit such a patch, please verify that your modifi- 3063c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of 3064c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so, 3065c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot 3066c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can 30677152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE' 3068218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools 3069218ca724SWolfgang Denkyou can type 3070c609719bSwdenk 3071c609719bSwdenk CROSS_COMPILE=ppc_8xx- MAKEALL 3072c609719bSwdenk 3073c609719bSwdenkor to build on a native PowerPC system you can type 3074c609719bSwdenk 3075c609719bSwdenk CROSS_COMPILE=' ' MAKEALL 3076c609719bSwdenk 3077218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build 3078218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by 3079218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target 3080218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and 3081218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default 3082218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment 3083218ca724SWolfgang Denkvariable. For example: 3084baf31249SMarian Balakowicz 3085baf31249SMarian Balakowicz export BUILD_DIR=/tmp/build 3086baf31249SMarian Balakowicz export MAKEALL_LOGDIR=/tmp/log 3087baf31249SMarian Balakowicz CROSS_COMPILE=ppc_8xx- MAKEALL 3088baf31249SMarian Balakowicz 3089218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build, 3090218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean 3091218ca724SWolfgang Denkduring the whole build process. 3092baf31249SMarian Balakowicz 3093baf31249SMarian Balakowicz 3094c609719bSwdenkSee also "U-Boot Porting Guide" below. 3095c609719bSwdenk 3096c609719bSwdenk 3097c609719bSwdenkMonitor Commands - Overview: 3098c609719bSwdenk============================ 3099c609719bSwdenk 3100c609719bSwdenkgo - start application at address 'addr' 3101c609719bSwdenkrun - run commands in an environment variable 3102c609719bSwdenkbootm - boot application image from memory 3103c609719bSwdenkbootp - boot image via network using BootP/TFTP protocol 3104c609719bSwdenktftpboot- boot image via network using TFTP protocol 3105c609719bSwdenk and env variables "ipaddr" and "serverip" 3106c609719bSwdenk (and eventually "gatewayip") 3107c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol 3108c609719bSwdenkdiskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd' 3109c609719bSwdenkloads - load S-Record file over serial line 3110c609719bSwdenkloadb - load binary file over serial line (kermit mode) 3111c609719bSwdenkmd - memory display 3112c609719bSwdenkmm - memory modify (auto-incrementing) 3113c609719bSwdenknm - memory modify (constant address) 3114c609719bSwdenkmw - memory write (fill) 3115c609719bSwdenkcp - memory copy 3116c609719bSwdenkcmp - memory compare 3117c609719bSwdenkcrc32 - checksum calculation 31180f89c54bSPeter Tyseri2c - I2C sub-system 3119c609719bSwdenksspi - SPI utility commands 3120c609719bSwdenkbase - print or set address offset 3121c609719bSwdenkprintenv- print environment variables 3122c609719bSwdenksetenv - set environment variables 3123c609719bSwdenksaveenv - save environment variables to persistent storage 3124c609719bSwdenkprotect - enable or disable FLASH write protection 3125c609719bSwdenkerase - erase FLASH memory 3126c609719bSwdenkflinfo - print FLASH memory information 3127c609719bSwdenkbdinfo - print Board Info structure 3128c609719bSwdenkiminfo - print header information for application image 3129c609719bSwdenkconinfo - print console devices and informations 3130c609719bSwdenkide - IDE sub-system 3131c609719bSwdenkloop - infinite loop on address range 313256523f12Swdenkloopw - infinite write loop on address range 3133c609719bSwdenkmtest - simple RAM test 3134c609719bSwdenkicache - enable or disable instruction cache 3135c609719bSwdenkdcache - enable or disable data cache 3136c609719bSwdenkreset - Perform RESET of the CPU 3137c609719bSwdenkecho - echo args to console 3138c609719bSwdenkversion - print monitor version 3139c609719bSwdenkhelp - print online help 3140c609719bSwdenk? - alias for 'help' 3141c609719bSwdenk 3142c609719bSwdenk 3143c609719bSwdenkMonitor Commands - Detailed Description: 3144c609719bSwdenk======================================== 3145c609719bSwdenk 3146c609719bSwdenkTODO. 3147c609719bSwdenk 3148c609719bSwdenkFor now: just type "help <command>". 3149c609719bSwdenk 3150c609719bSwdenk 3151c609719bSwdenkEnvironment Variables: 3152c609719bSwdenk====================== 3153c609719bSwdenk 3154c609719bSwdenkU-Boot supports user configuration using Environment Variables which 3155c609719bSwdenkcan be made persistent by saving to Flash memory. 3156c609719bSwdenk 3157c609719bSwdenkEnvironment Variables are set using "setenv", printed using 3158c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv" 3159c609719bSwdenkwithout a value can be used to delete a variable from the 3160c609719bSwdenkenvironment. As long as you don't save the environment you are 3161c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the 3162c609719bSwdenkenvironment is erased by accident, a default environment is provided. 3163c609719bSwdenk 3164c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables. 3165c96f86eeSWolfgang Denk 3166c96f86eeSWolfgang DenkList of environment variables (most likely not complete): 3167c609719bSwdenk 3168c609719bSwdenk baudrate - see CONFIG_BAUDRATE 3169c609719bSwdenk 3170c609719bSwdenk bootdelay - see CONFIG_BOOTDELAY 3171c609719bSwdenk 3172c609719bSwdenk bootcmd - see CONFIG_BOOTCOMMAND 3173c609719bSwdenk 3174c609719bSwdenk bootargs - Boot arguments when booting an RTOS image 3175c609719bSwdenk 3176c609719bSwdenk bootfile - Name of the image to load with TFTP 3177c609719bSwdenk 31787d721e34SBartlomiej Sieka bootm_low - Memory range available for image processing in the bootm 31797d721e34SBartlomiej Sieka command can be restricted. This variable is given as 31807d721e34SBartlomiej Sieka a hexadecimal number and defines lowest address allowed 31817d721e34SBartlomiej Sieka for use by the bootm command. See also "bootm_size" 31827d721e34SBartlomiej Sieka environment variable. Address defined by "bootm_low" is 31837d721e34SBartlomiej Sieka also the base of the initial memory mapping for the Linux 31846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD kernel -- see the description of CONFIG_SYS_BOOTMAPSZ. 31857d721e34SBartlomiej Sieka 31867d721e34SBartlomiej Sieka bootm_size - Memory range available for image processing in the bootm 31877d721e34SBartlomiej Sieka command can be restricted. This variable is given as 31887d721e34SBartlomiej Sieka a hexadecimal number and defines the size of the region 31897d721e34SBartlomiej Sieka allowed for use by the bootm command. See also "bootm_low" 31907d721e34SBartlomiej Sieka environment variable. 31917d721e34SBartlomiej Sieka 31924bae9090SBartlomiej Sieka updatefile - Location of the software update file on a TFTP server, used 31934bae9090SBartlomiej Sieka by the automatic software update feature. Please refer to 31944bae9090SBartlomiej Sieka documentation in doc/README.update for more details. 31954bae9090SBartlomiej Sieka 3196c609719bSwdenk autoload - if set to "no" (any string beginning with 'n'), 3197c609719bSwdenk "bootp" will just load perform a lookup of the 3198c609719bSwdenk configuration from the BOOTP server, but not try to 3199c609719bSwdenk load any image using TFTP 3200c609719bSwdenk 3201c609719bSwdenk autostart - if set to "yes", an image loaded using the "bootp", 3202c609719bSwdenk "rarpboot", "tftpboot" or "diskboot" commands will 3203c609719bSwdenk be automatically started (by internally calling 3204c609719bSwdenk "bootm") 3205c609719bSwdenk 32064a6fd34bSwdenk If set to "no", a standalone image passed to the 32074a6fd34bSwdenk "bootm" command will be copied to the load address 32084a6fd34bSwdenk (and eventually uncompressed), but NOT be started. 32094a6fd34bSwdenk This can be used to load and uncompress arbitrary 32104a6fd34bSwdenk data. 32114a6fd34bSwdenk 321217ea1177Swdenk i2cfast - (PPC405GP|PPC405EP only) 321317ea1177Swdenk if set to 'y' configures Linux I2C driver for fast 321417ea1177Swdenk mode (400kHZ). This environment variable is used in 321517ea1177Swdenk initialization code. So, for changes to be effective 321617ea1177Swdenk it must be saved and board must be reset. 321717ea1177Swdenk 3218c609719bSwdenk initrd_high - restrict positioning of initrd images: 3219c609719bSwdenk If this variable is not set, initrd images will be 3220c609719bSwdenk copied to the highest possible address in RAM; this 3221c609719bSwdenk is usually what you want since it allows for 3222c609719bSwdenk maximum initrd size. If for some reason you want to 3223c609719bSwdenk make sure that the initrd image is loaded below the 32246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BOOTMAPSZ limit, you can set this environment 3225c609719bSwdenk variable to a value of "no" or "off" or "0". 3226c609719bSwdenk Alternatively, you can set it to a maximum upper 3227c609719bSwdenk address to use (U-Boot will still check that it 3228c609719bSwdenk does not overwrite the U-Boot stack and data). 3229c609719bSwdenk 3230c609719bSwdenk For instance, when you have a system with 16 MB 32317152b1d0Swdenk RAM, and want to reserve 4 MB from use by Linux, 3232c609719bSwdenk you can do this by adding "mem=12M" to the value of 3233c609719bSwdenk the "bootargs" variable. However, now you must make 32347152b1d0Swdenk sure that the initrd image is placed in the first 3235c609719bSwdenk 12 MB as well - this can be done with 3236c609719bSwdenk 3237c609719bSwdenk setenv initrd_high 00c00000 3238c609719bSwdenk 323938b99261Swdenk If you set initrd_high to 0xFFFFFFFF, this is an 324038b99261Swdenk indication to U-Boot that all addresses are legal 324138b99261Swdenk for the Linux kernel, including addresses in flash 324238b99261Swdenk memory. In this case U-Boot will NOT COPY the 324338b99261Swdenk ramdisk at all. This may be useful to reduce the 324438b99261Swdenk boot time on your system, but requires that this 324538b99261Swdenk feature is supported by your Linux kernel. 324638b99261Swdenk 3247c609719bSwdenk ipaddr - IP address; needed for tftpboot command 3248c609719bSwdenk 3249c609719bSwdenk loadaddr - Default load address for commands like "bootp", 3250dc7c9a1aSwdenk "rarpboot", "tftpboot", "loadb" or "diskboot" 3251c609719bSwdenk 3252c609719bSwdenk loads_echo - see CONFIG_LOADS_ECHO 3253c609719bSwdenk 3254c609719bSwdenk serverip - TFTP server IP address; needed for tftpboot command 3255c609719bSwdenk 3256c609719bSwdenk bootretry - see CONFIG_BOOT_RETRY_TIME 3257c609719bSwdenk 3258c609719bSwdenk bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR 3259c609719bSwdenk 3260c609719bSwdenk bootstopkey - see CONFIG_AUTOBOOT_STOP_STR 3261c609719bSwdenk 3262a3d991bdSwdenk ethprime - When CONFIG_NET_MULTI is enabled controls which 3263a3d991bdSwdenk interface is used first. 3264a3d991bdSwdenk 3265a3d991bdSwdenk ethact - When CONFIG_NET_MULTI is enabled controls which 3266a3d991bdSwdenk interface is currently active. For example you 3267a3d991bdSwdenk can do the following 3268a3d991bdSwdenk 326948690d80SHeiko Schocher => setenv ethact FEC 327048690d80SHeiko Schocher => ping 192.168.0.1 # traffic sent on FEC 327148690d80SHeiko Schocher => setenv ethact SCC 327248690d80SHeiko Schocher => ping 10.0.0.1 # traffic sent on SCC 3273a3d991bdSwdenk 3274e1692577SMatthias Fuchs ethrotate - When set to "no" U-Boot does not go through all 3275e1692577SMatthias Fuchs available network interfaces. 3276e1692577SMatthias Fuchs It just stays at the currently selected interface. 3277e1692577SMatthias Fuchs 3278a3d991bdSwdenk netretry - When set to "no" each network operation will 3279a3d991bdSwdenk either succeed or fail without retrying. 32806e592385Swdenk When set to "once" the network operation will 32816e592385Swdenk fail when all the available network interfaces 32826e592385Swdenk are tried once without success. 3283a3d991bdSwdenk Useful on scripts which control the retry operation 3284a3d991bdSwdenk themselves. 3285a3d991bdSwdenk 3286b4e2f89dSJean-Christophe PLAGNIOL-VILLARD npe_ucode - set load address for the NPE microcode 3287a1cf027aSJean-Christophe PLAGNIOL-VILLARD 328828cb9375SWolfgang Denk tftpsrcport - If this is set, the value is used for TFTP's 3289ecb0ccd9SWolfgang Denk UDP source port. 3290ecb0ccd9SWolfgang Denk 329128cb9375SWolfgang Denk tftpdstport - If this is set, the value is used for TFTP's UDP 329228cb9375SWolfgang Denk destination port instead of the Well Know Port 69. 329328cb9375SWolfgang Denk 3294c96f86eeSWolfgang Denk tftpblocksize - Block size to use for TFTP transfers; if not set, 3295c96f86eeSWolfgang Denk we use the TFTP server's default block size 3296c96f86eeSWolfgang Denk 3297c96f86eeSWolfgang Denk tftptimeout - Retransmission timeout for TFTP packets (in milli- 3298c96f86eeSWolfgang Denk seconds, minimum value is 1000 = 1 second). Defines 3299c96f86eeSWolfgang Denk when a packet is considered to be lost so it has to 3300c96f86eeSWolfgang Denk be retransmitted. The default is 5000 = 5 seconds. 3301c96f86eeSWolfgang Denk Lowering this value may make downloads succeed 3302c96f86eeSWolfgang Denk faster in networks with high packet loss rates or 3303c96f86eeSWolfgang Denk with unreliable TFTP servers. 3304c96f86eeSWolfgang Denk 3305a3d991bdSwdenk vlan - When set to a value < 4095 the traffic over 330611ccc33fSMarcel Ziswiler Ethernet is encapsulated/received over 802.1q 3307a3d991bdSwdenk VLAN tagged frames. 3308c609719bSwdenk 3309c609719bSwdenkThe following environment variables may be used and automatically 3310c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"), 3311c609719bSwdenkdepending the information provided by your boot server: 3312c609719bSwdenk 3313c609719bSwdenk bootfile - see above 3314c609719bSwdenk dnsip - IP address of your Domain Name Server 3315fe389a82Sstroese dnsip2 - IP address of your secondary Domain Name Server 3316c609719bSwdenk gatewayip - IP address of the Gateway (Router) to use 3317c609719bSwdenk hostname - Target hostname 3318c609719bSwdenk ipaddr - see above 3319c609719bSwdenk netmask - Subnet Mask 3320c609719bSwdenk rootpath - Pathname of the root filesystem on the NFS server 3321c609719bSwdenk serverip - see above 3322c609719bSwdenk 3323c609719bSwdenk 3324c609719bSwdenkThere are two special Environment Variables: 3325c609719bSwdenk 3326c609719bSwdenk serial# - contains hardware identification information such 3327c609719bSwdenk as type string and/or serial number 3328c609719bSwdenk ethaddr - Ethernet address 3329c609719bSwdenk 3330c609719bSwdenkThese variables can be set only once (usually during manufacturing of 3331c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables 3332c609719bSwdenkonce they have been set once. 3333c609719bSwdenk 3334c609719bSwdenk 3335c1551ea8SstroeseFurther special Environment Variables: 3336c1551ea8Sstroese 3337c1551ea8Sstroese ver - Contains the U-Boot version string as printed 3338c1551ea8Sstroese with the "version" command. This variable is 3339c1551ea8Sstroese readonly (see CONFIG_VERSION_VARIABLE). 3340c1551ea8Sstroese 3341c1551ea8Sstroese 3342c609719bSwdenkPlease note that changes to some configuration parameters may take 3343c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-). 3344c609719bSwdenk 3345c609719bSwdenk 3346f07771ccSwdenkCommand Line Parsing: 3347f07771ccSwdenk===================== 3348f07771ccSwdenk 3349f07771ccSwdenkThere are two different command line parsers available with U-Boot: 33507152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell: 3351f07771ccSwdenk 3352f07771ccSwdenkOld, simple command line parser: 3353f07771ccSwdenk-------------------------------- 3354f07771ccSwdenk 3355f07771ccSwdenk- supports environment variables (through setenv / saveenv commands) 3356f07771ccSwdenk- several commands on one line, separated by ';' 3357fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax 3358f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\', 3359f07771ccSwdenk for example: 3360fe126d8bSWolfgang Denk setenv bootcmd bootm \${address} 3361f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example: 3362f07771ccSwdenk setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off' 3363f07771ccSwdenk 3364f07771ccSwdenkHush shell: 3365f07771ccSwdenk----------- 3366f07771ccSwdenk 3367f07771ccSwdenk- similar to Bourne shell, with control structures like 3368f07771ccSwdenk if...then...else...fi, for...do...done; while...do...done, 3369f07771ccSwdenk until...do...done, ... 3370f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv 3371f07771ccSwdenk commands) and local shell variables (through standard shell syntax 3372f07771ccSwdenk "name=value"); only environment variables can be used with "run" 3373f07771ccSwdenk command 3374f07771ccSwdenk 3375f07771ccSwdenkGeneral rules: 3376f07771ccSwdenk-------------- 3377f07771ccSwdenk 3378f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run" 3379f07771ccSwdenk command) contains several commands separated by semicolon, and 3380f07771ccSwdenk one of these commands fails, then the remaining commands will be 3381f07771ccSwdenk executed anyway. 3382f07771ccSwdenk 3383f07771ccSwdenk(2) If you execute several variables with one call to run (i. e. 338411ccc33fSMarcel Ziswiler calling run with a list of variables as arguments), any failing 3385f07771ccSwdenk command will cause "run" to terminate, i. e. the remaining 3386f07771ccSwdenk variables are not executed. 3387f07771ccSwdenk 3388c609719bSwdenkNote for Redundant Ethernet Interfaces: 3389c609719bSwdenk======================================= 3390c609719bSwdenk 339111ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports 3392c609719bSwdenksuch configurations and is capable of automatic selection of a 33937152b1d0Swdenk"working" interface when needed. MAC assignment works as follows: 3394c609719bSwdenk 3395c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding 3396c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0), 3397c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ... 3398c609719bSwdenk 3399c609719bSwdenkIf the network interface stores some valid MAC address (for instance 3400c609719bSwdenkin SROM), this is used as default address if there is NO correspon- 3401c609719bSwdenkding setting in the environment; if the corresponding environment 3402c609719bSwdenkvariable is set, this overrides the settings in the card; that means: 3403c609719bSwdenk 3404c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the 3405c609719bSwdenk environment, the SROM's address is used. 3406c609719bSwdenk 3407c609719bSwdenko If there is no valid address in the SROM, and a definition in the 3408c609719bSwdenk environment exists, then the value from the environment variable is 3409c609719bSwdenk used. 3410c609719bSwdenk 3411c609719bSwdenko If both the SROM and the environment contain a MAC address, and 3412c609719bSwdenk both addresses are the same, this MAC address is used. 3413c609719bSwdenk 3414c609719bSwdenko If both the SROM and the environment contain a MAC address, and the 3415c609719bSwdenk addresses differ, the value from the environment is used and a 3416c609719bSwdenk warning is printed. 3417c609719bSwdenk 3418c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error 3419c609719bSwdenk is raised. 3420c609719bSwdenk 3421ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses 3422ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process. This 3423ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable. 3424ecee9324SBen WarrenThe naming convention is as follows: 3425ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc. 3426c609719bSwdenk 3427c609719bSwdenkImage Formats: 3428c609719bSwdenk============== 3429c609719bSwdenk 34303310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on) 34313310c549SMarian Balakowiczimages in two formats: 34323310c549SMarian Balakowicz 34333310c549SMarian BalakowiczNew uImage format (FIT) 34343310c549SMarian Balakowicz----------------------- 34353310c549SMarian Balakowicz 34363310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar 34373310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple 34383310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by 34393310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory. 34403310c549SMarian Balakowicz 34413310c549SMarian Balakowicz 34423310c549SMarian BalakowiczOld uImage format 34433310c549SMarian Balakowicz----------------- 34443310c549SMarian Balakowicz 34453310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything, 34463310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for 34473310c549SMarian Balakowiczdetails; basically, the header defines the following image properties: 3448c609719bSwdenk 3449c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD, 3450c609719bSwdenk 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks, 3451f5ed9e39SPeter Tyser LynxOS, pSOS, QNX, RTEMS, INTEGRITY; 3452f5ed9e39SPeter Tyser Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS, 3453f5ed9e39SPeter Tyser INTEGRITY). 34547b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86, 34551117cbf2SThomas Chou IA64, MIPS, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit; 34561117cbf2SThomas Chou Currently supported: ARM, AVR32, Intel x86, MIPS, Nios II, PowerPC). 3457c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2) 3458c609719bSwdenk* Load Address 3459c609719bSwdenk* Entry Point 3460c609719bSwdenk* Image Name 3461c609719bSwdenk* Image Timestamp 3462c609719bSwdenk 3463c609719bSwdenkThe header is marked by a special Magic Number, and both the header 3464c609719bSwdenkand the data portions of the image are secured against corruption by 3465c609719bSwdenkCRC32 checksums. 3466c609719bSwdenk 3467c609719bSwdenk 3468c609719bSwdenkLinux Support: 3469c609719bSwdenk============== 3470c609719bSwdenk 3471c609719bSwdenkAlthough U-Boot should support any OS or standalone application 34727152b1d0Swdenkeasily, the main focus has always been on Linux during the design of 3473c609719bSwdenkU-Boot. 3474c609719bSwdenk 3475c609719bSwdenkU-Boot includes many features that so far have been part of some 3476c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any 3477c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image; 3478c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation 34797152b1d0Swdenkserves several purposes: 3480c609719bSwdenk 3481c609719bSwdenk- the same features can be used for other OS or standalone 3482c609719bSwdenk applications (for instance: using compressed images to reduce the 3483c609719bSwdenk Flash memory footprint) 3484c609719bSwdenk 3485c609719bSwdenk- it becomes much easier to port new Linux kernel versions because 34867152b1d0Swdenk lots of low-level, hardware dependent stuff are done by U-Boot 3487c609719bSwdenk 3488c609719bSwdenk- the same Linux kernel image can now be used with different "initrd" 3489c609719bSwdenk images; of course this also means that different kernel images can 3490c609719bSwdenk be run with the same "initrd". This makes testing easier (you don't 3491c609719bSwdenk have to build a new "zImage.initrd" Linux image when you just 3492c609719bSwdenk change a file in your "initrd"). Also, a field-upgrade of the 3493c609719bSwdenk software is easier now. 3494c609719bSwdenk 3495c609719bSwdenk 3496c609719bSwdenkLinux HOWTO: 3497c609719bSwdenk============ 3498c609719bSwdenk 3499c609719bSwdenkPorting Linux to U-Boot based systems: 3500c609719bSwdenk--------------------------------------- 3501c609719bSwdenk 3502c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to 3503c609719bSwdenkconfigure the Linux device drivers for use with your target hardware 3504c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to 3505c609719bSwdenkLinux :-). 3506c609719bSwdenk 3507a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot). 3508c609719bSwdenk 3509c609719bSwdenkJust make sure your machine specific header file (for instance 3510c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board 35111dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h, 35121dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value 35136d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR. 3514c609719bSwdenk 3515c609719bSwdenk 3516c609719bSwdenkConfiguring the Linux kernel: 3517c609719bSwdenk----------------------------- 3518c609719bSwdenk 3519c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root 3520c609719bSwdenkdevice (initial ramdisk, NFS) for your target system. 3521c609719bSwdenk 3522c609719bSwdenk 3523c609719bSwdenkBuilding a Linux Image: 3524c609719bSwdenk----------------------- 3525c609719bSwdenk 352624ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are 352724ee89b9Swdenknot used. If you use recent kernel source, a new build target 352824ee89b9Swdenk"uImage" will exist which automatically builds an image usable by 352924ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target, 353024ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a 353124ee89b9Swdenk100% compatible format. 3532c609719bSwdenk 3533c609719bSwdenkExample: 3534c609719bSwdenk 3535c609719bSwdenk make TQM850L_config 3536c609719bSwdenk make oldconfig 3537c609719bSwdenk make dep 353824ee89b9Swdenk make uImage 3539c609719bSwdenk 354024ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to 354124ee89b9Swdenkencapsulate a compressed Linux kernel image with header information, 354224ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing: 3543c609719bSwdenk 354424ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format): 354524ee89b9Swdenk 354624ee89b9Swdenk* convert the kernel into a raw binary image: 354724ee89b9Swdenk 354824ee89b9Swdenk ${CROSS_COMPILE}-objcopy -O binary \ 354924ee89b9Swdenk -R .note -R .comment \ 355024ee89b9Swdenk -S vmlinux linux.bin 355124ee89b9Swdenk 355224ee89b9Swdenk* compress the binary image: 355324ee89b9Swdenk 355424ee89b9Swdenk gzip -9 linux.bin 355524ee89b9Swdenk 355624ee89b9Swdenk* package compressed binary image for U-Boot: 355724ee89b9Swdenk 355824ee89b9Swdenk mkimage -A ppc -O linux -T kernel -C gzip \ 355924ee89b9Swdenk -a 0 -e 0 -n "Linux Kernel Image" \ 356024ee89b9Swdenk -d linux.bin.gz uImage 356124ee89b9Swdenk 356224ee89b9Swdenk 356324ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use 356424ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or 356524ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64 356624ee89b9Swdenkbyte header containing information about target architecture, 356724ee89b9Swdenkoperating system, image type, compression method, entry points, time 356824ee89b9Swdenkstamp, CRC32 checksums, etc. 356924ee89b9Swdenk 357024ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and 357124ee89b9Swdenkprint the header information, or to build new images. 3572c609719bSwdenk 3573c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information 3574c609719bSwdenkcontained in the header of an existing U-Boot image; this includes 3575c609719bSwdenkchecksum verification: 3576c609719bSwdenk 3577c609719bSwdenk tools/mkimage -l image 3578c609719bSwdenk -l ==> list image header information 3579c609719bSwdenk 3580c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image 3581c609719bSwdenkfrom a "data file" which is used as image payload: 3582c609719bSwdenk 3583c609719bSwdenk tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \ 3584c609719bSwdenk -n name -d data_file image 3585c609719bSwdenk -A ==> set architecture to 'arch' 3586c609719bSwdenk -O ==> set operating system to 'os' 3587c609719bSwdenk -T ==> set image type to 'type' 3588c609719bSwdenk -C ==> set compression type 'comp' 3589c609719bSwdenk -a ==> set load address to 'addr' (hex) 3590c609719bSwdenk -e ==> set entry point to 'ep' (hex) 3591c609719bSwdenk -n ==> set image name to 'name' 3592c609719bSwdenk -d ==> use image data from 'datafile' 3593c609719bSwdenk 359469459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load 359569459791Swdenkaddress (0x00000000), but the entry point address depends on the 359669459791Swdenkkernel version: 3597c609719bSwdenk 3598c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C, 359924ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000. 3600c609719bSwdenk 3601c609719bSwdenkSo a typical call to build a U-Boot image would read: 3602c609719bSwdenk 360324ee89b9Swdenk -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 360424ee89b9Swdenk > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \ 3605a47a12beSStefan Roese > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \ 360624ee89b9Swdenk > examples/uImage.TQM850L 360724ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 3608c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 3609c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 3610c609719bSwdenk Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 3611c609719bSwdenk Load Address: 0x00000000 361224ee89b9Swdenk Entry Point: 0x00000000 3613c609719bSwdenk 3614c609719bSwdenkTo verify the contents of the image (or check for corruption): 3615c609719bSwdenk 361624ee89b9Swdenk -> tools/mkimage -l examples/uImage.TQM850L 361724ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 3618c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 3619c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 3620c609719bSwdenk Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 3621c609719bSwdenk Load Address: 0x00000000 362224ee89b9Swdenk Entry Point: 0x00000000 3623c609719bSwdenk 3624c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade 3625c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this 3626c609719bSwdenkneeds more space in Flash, but boots much faster since it does not 3627c609719bSwdenkneed to be uncompressed: 3628c609719bSwdenk 3629a47a12beSStefan Roese -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz 363024ee89b9Swdenk -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 363124ee89b9Swdenk > -A ppc -O linux -T kernel -C none -a 0 -e 0 \ 3632a47a12beSStefan Roese > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \ 363324ee89b9Swdenk > examples/uImage.TQM850L-uncompressed 363424ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 3635c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 3636c609719bSwdenk Image Type: PowerPC Linux Kernel Image (uncompressed) 3637c609719bSwdenk Data Size: 792160 Bytes = 773.59 kB = 0.76 MB 3638c609719bSwdenk Load Address: 0x00000000 363924ee89b9Swdenk Entry Point: 0x00000000 3640c609719bSwdenk 3641c609719bSwdenk 3642c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file 3643c609719bSwdenkwhen your kernel is intended to use an initial ramdisk: 3644c609719bSwdenk 3645c609719bSwdenk -> tools/mkimage -n 'Simple Ramdisk Image' \ 3646c609719bSwdenk > -A ppc -O linux -T ramdisk -C gzip \ 3647c609719bSwdenk > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd 3648c609719bSwdenk Image Name: Simple Ramdisk Image 3649c609719bSwdenk Created: Wed Jan 12 14:01:50 2000 3650c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 3651c609719bSwdenk Data Size: 566530 Bytes = 553.25 kB = 0.54 MB 3652c609719bSwdenk Load Address: 0x00000000 3653c609719bSwdenk Entry Point: 0x00000000 3654c609719bSwdenk 3655c609719bSwdenk 3656c609719bSwdenkInstalling a Linux Image: 3657c609719bSwdenk------------------------- 3658c609719bSwdenk 3659c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface, 3660c609719bSwdenkyou must convert the image to S-Record format: 3661c609719bSwdenk 3662c609719bSwdenk objcopy -I binary -O srec examples/image examples/image.srec 3663c609719bSwdenk 3664c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot 3665c609719bSwdenkimage header, so the resulting S-Record file will be relative to 3666c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to 3667c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads' 3668c609719bSwdenkcommand. 3669c609719bSwdenk 3670c609719bSwdenkExample: install the image to address 0x40100000 (which on the 3671c609719bSwdenkTQM8xxL is in the first Flash bank): 3672c609719bSwdenk 3673c609719bSwdenk => erase 40100000 401FFFFF 3674c609719bSwdenk 3675c609719bSwdenk .......... done 3676c609719bSwdenk Erased 8 sectors 3677c609719bSwdenk 3678c609719bSwdenk => loads 40100000 3679c609719bSwdenk ## Ready for S-Record download ... 3680c609719bSwdenk ~>examples/image.srec 3681c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 12 13 ... 3682c609719bSwdenk ... 3683c609719bSwdenk 15989 15990 15991 15992 3684c609719bSwdenk [file transfer complete] 3685c609719bSwdenk [connected] 3686c609719bSwdenk ## Start Addr = 0x00000000 3687c609719bSwdenk 3688c609719bSwdenk 3689c609719bSwdenkYou can check the success of the download using the 'iminfo' command; 3690c609719bSwdenkthis includes a checksum verification so you can be sure no data 3691c609719bSwdenkcorruption happened: 3692c609719bSwdenk 3693c609719bSwdenk => imi 40100000 3694c609719bSwdenk 3695c609719bSwdenk ## Checking Image at 40100000 ... 3696c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 3697c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 3698c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 3699c609719bSwdenk Load Address: 00000000 3700c609719bSwdenk Entry Point: 0000000c 3701c609719bSwdenk Verifying Checksum ... OK 3702c609719bSwdenk 3703c609719bSwdenk 3704c609719bSwdenkBoot Linux: 3705c609719bSwdenk----------- 3706c609719bSwdenk 3707c609719bSwdenkThe "bootm" command is used to boot an application that is stored in 3708c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents 3709c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as 3710c609719bSwdenkparameters. You can check and modify this variable using the 3711c609719bSwdenk"printenv" and "setenv" commands: 3712c609719bSwdenk 3713c609719bSwdenk 3714c609719bSwdenk => printenv bootargs 3715c609719bSwdenk bootargs=root=/dev/ram 3716c609719bSwdenk 3717c609719bSwdenk => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 3718c609719bSwdenk 3719c609719bSwdenk => printenv bootargs 3720c609719bSwdenk bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 3721c609719bSwdenk 3722c609719bSwdenk => bootm 40020000 3723c609719bSwdenk ## Booting Linux kernel at 40020000 ... 3724c609719bSwdenk Image Name: 2.2.13 for NFS on TQM850L 3725c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 3726c609719bSwdenk Data Size: 381681 Bytes = 372 kB = 0 MB 3727c609719bSwdenk Load Address: 00000000 3728c609719bSwdenk Entry Point: 0000000c 3729c609719bSwdenk Verifying Checksum ... OK 3730c609719bSwdenk Uncompressing Kernel Image ... OK 3731c609719bSwdenk 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 3732c609719bSwdenk Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 3733c609719bSwdenk time_init: decrementer frequency = 187500000/60 3734c609719bSwdenk Calibrating delay loop... 49.77 BogoMIPS 3735c609719bSwdenk Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000] 3736c609719bSwdenk ... 3737c609719bSwdenk 373811ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass 37397152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT 3740c609719bSwdenkformat!) to the "bootm" command: 3741c609719bSwdenk 3742c609719bSwdenk => imi 40100000 40200000 3743c609719bSwdenk 3744c609719bSwdenk ## Checking Image at 40100000 ... 3745c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 3746c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 3747c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 3748c609719bSwdenk Load Address: 00000000 3749c609719bSwdenk Entry Point: 0000000c 3750c609719bSwdenk Verifying Checksum ... OK 3751c609719bSwdenk 3752c609719bSwdenk ## Checking Image at 40200000 ... 3753c609719bSwdenk Image Name: Simple Ramdisk Image 3754c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 3755c609719bSwdenk Data Size: 566530 Bytes = 553 kB = 0 MB 3756c609719bSwdenk Load Address: 00000000 3757c609719bSwdenk Entry Point: 00000000 3758c609719bSwdenk Verifying Checksum ... OK 3759c609719bSwdenk 3760c609719bSwdenk => bootm 40100000 40200000 3761c609719bSwdenk ## Booting Linux kernel at 40100000 ... 3762c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 3763c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 3764c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 3765c609719bSwdenk Load Address: 00000000 3766c609719bSwdenk Entry Point: 0000000c 3767c609719bSwdenk Verifying Checksum ... OK 3768c609719bSwdenk Uncompressing Kernel Image ... OK 3769c609719bSwdenk ## Loading RAMDisk Image at 40200000 ... 3770c609719bSwdenk Image Name: Simple Ramdisk Image 3771c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 3772c609719bSwdenk Data Size: 566530 Bytes = 553 kB = 0 MB 3773c609719bSwdenk Load Address: 00000000 3774c609719bSwdenk Entry Point: 00000000 3775c609719bSwdenk Verifying Checksum ... OK 3776c609719bSwdenk Loading Ramdisk ... OK 3777c609719bSwdenk 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 3778c609719bSwdenk Boot arguments: root=/dev/ram 3779c609719bSwdenk time_init: decrementer frequency = 187500000/60 3780c609719bSwdenk Calibrating delay loop... 49.77 BogoMIPS 3781c609719bSwdenk ... 3782c609719bSwdenk RAMDISK: Compressed image found at block 0 3783c609719bSwdenk VFS: Mounted root (ext2 filesystem). 3784c609719bSwdenk 3785c609719bSwdenk bash# 3786c609719bSwdenk 37870267768eSMatthew McClintockBoot Linux and pass a flat device tree: 37880267768eSMatthew McClintock----------- 37890267768eSMatthew McClintock 37900267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section 37910267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The 37920267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated 37930267768eSMatthew McClintockflat device tree: 37940267768eSMatthew McClintock 37950267768eSMatthew McClintock=> print oftaddr 37960267768eSMatthew McClintockoftaddr=0x300000 37970267768eSMatthew McClintock=> print oft 37980267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb 37990267768eSMatthew McClintock=> tftp $oftaddr $oft 38000267768eSMatthew McClintockSpeed: 1000, full duplex 38010267768eSMatthew McClintockUsing TSEC0 device 38020267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101 38030267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'. 38040267768eSMatthew McClintockLoad address: 0x300000 38050267768eSMatthew McClintockLoading: # 38060267768eSMatthew McClintockdone 38070267768eSMatthew McClintockBytes transferred = 4106 (100a hex) 38080267768eSMatthew McClintock=> tftp $loadaddr $bootfile 38090267768eSMatthew McClintockSpeed: 1000, full duplex 38100267768eSMatthew McClintockUsing TSEC0 device 38110267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2 38120267768eSMatthew McClintockFilename 'uImage'. 38130267768eSMatthew McClintockLoad address: 0x200000 38140267768eSMatthew McClintockLoading:############ 38150267768eSMatthew McClintockdone 38160267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex) 38170267768eSMatthew McClintock=> print loadaddr 38180267768eSMatthew McClintockloadaddr=200000 38190267768eSMatthew McClintock=> print oftaddr 38200267768eSMatthew McClintockoftaddr=0x300000 38210267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr 38220267768eSMatthew McClintock## Booting image at 00200000 ... 38230267768eSMatthew McClintock Image Name: Linux-2.6.17-dirty 38240267768eSMatthew McClintock Image Type: PowerPC Linux Kernel Image (gzip compressed) 38250267768eSMatthew McClintock Data Size: 1029343 Bytes = 1005.2 kB 38260267768eSMatthew McClintock Load Address: 00000000 38270267768eSMatthew McClintock Entry Point: 00000000 38280267768eSMatthew McClintock Verifying Checksum ... OK 38290267768eSMatthew McClintock Uncompressing Kernel Image ... OK 38300267768eSMatthew McClintockBooting using flat device tree at 0x300000 38310267768eSMatthew McClintockUsing MPC85xx ADS machine description 38320267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb 38330267768eSMatthew McClintock[snip] 38340267768eSMatthew McClintock 38350267768eSMatthew McClintock 38366069ff26SwdenkMore About U-Boot Image Types: 38376069ff26Swdenk------------------------------ 38386069ff26Swdenk 38396069ff26SwdenkU-Boot supports the following image types: 38406069ff26Swdenk 38416069ff26Swdenk "Standalone Programs" are directly runnable in the environment 38426069ff26Swdenk provided by U-Boot; it is expected that (if they behave 38436069ff26Swdenk well) you can continue to work in U-Boot after return from 38446069ff26Swdenk the Standalone Program. 38456069ff26Swdenk "OS Kernel Images" are usually images of some Embedded OS which 38466069ff26Swdenk will take over control completely. Usually these programs 38476069ff26Swdenk will install their own set of exception handlers, device 38486069ff26Swdenk drivers, set up the MMU, etc. - this means, that you cannot 38496069ff26Swdenk expect to re-enter U-Boot except by resetting the CPU. 38506069ff26Swdenk "RAMDisk Images" are more or less just data blocks, and their 38516069ff26Swdenk parameters (address, size) are passed to an OS kernel that is 38526069ff26Swdenk being started. 38536069ff26Swdenk "Multi-File Images" contain several images, typically an OS 38546069ff26Swdenk (Linux) kernel image and one or more data images like 38556069ff26Swdenk RAMDisks. This construct is useful for instance when you want 38566069ff26Swdenk to boot over the network using BOOTP etc., where the boot 38576069ff26Swdenk server provides just a single image file, but you want to get 38586069ff26Swdenk for instance an OS kernel and a RAMDisk image. 38596069ff26Swdenk 38606069ff26Swdenk "Multi-File Images" start with a list of image sizes, each 38616069ff26Swdenk image size (in bytes) specified by an "uint32_t" in network 38626069ff26Swdenk byte order. This list is terminated by an "(uint32_t)0". 38636069ff26Swdenk Immediately after the terminating 0 follow the images, one by 38646069ff26Swdenk one, all aligned on "uint32_t" boundaries (size rounded up to 38656069ff26Swdenk a multiple of 4 bytes). 38666069ff26Swdenk 38676069ff26Swdenk "Firmware Images" are binary images containing firmware (like 38686069ff26Swdenk U-Boot or FPGA images) which usually will be programmed to 38696069ff26Swdenk flash memory. 38706069ff26Swdenk 38716069ff26Swdenk "Script files" are command sequences that will be executed by 38726069ff26Swdenk U-Boot's command interpreter; this feature is especially 38736069ff26Swdenk useful when you configure U-Boot to use a real shell (hush) 38746069ff26Swdenk as command interpreter. 38756069ff26Swdenk 3876c609719bSwdenk 3877c609719bSwdenkStandalone HOWTO: 3878c609719bSwdenk================= 3879c609719bSwdenk 3880c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and 3881c609719bSwdenkrun "standalone" applications, which can use some resources of 3882c609719bSwdenkU-Boot like console I/O functions or interrupt services. 3883c609719bSwdenk 3884c609719bSwdenkTwo simple examples are included with the sources: 3885c609719bSwdenk 3886c609719bSwdenk"Hello World" Demo: 3887c609719bSwdenk------------------- 3888c609719bSwdenk 3889c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo 3890c609719bSwdenkapplication; it is automatically compiled when you build U-Boot. 3891c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it 3892c609719bSwdenklike that: 3893c609719bSwdenk 3894c609719bSwdenk => loads 3895c609719bSwdenk ## Ready for S-Record download ... 3896c609719bSwdenk ~>examples/hello_world.srec 3897c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 ... 3898c609719bSwdenk [file transfer complete] 3899c609719bSwdenk [connected] 3900c609719bSwdenk ## Start Addr = 0x00040004 3901c609719bSwdenk 3902c609719bSwdenk => go 40004 Hello World! This is a test. 3903c609719bSwdenk ## Starting application at 0x00040004 ... 3904c609719bSwdenk Hello World 3905c609719bSwdenk argc = 7 3906c609719bSwdenk argv[0] = "40004" 3907c609719bSwdenk argv[1] = "Hello" 3908c609719bSwdenk argv[2] = "World!" 3909c609719bSwdenk argv[3] = "This" 3910c609719bSwdenk argv[4] = "is" 3911c609719bSwdenk argv[5] = "a" 3912c609719bSwdenk argv[6] = "test." 3913c609719bSwdenk argv[7] = "<NULL>" 3914c609719bSwdenk Hit any key to exit ... 3915c609719bSwdenk 3916c609719bSwdenk ## Application terminated, rc = 0x0 3917c609719bSwdenk 3918c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt 3919c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'. 3920c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second. 3921c609719bSwdenkThe interrupt service routine is trivial, just printing a '.' 3922c609719bSwdenkcharacter, but this is just a demo program. The application can be 3923c609719bSwdenkcontrolled by the following keys: 3924c609719bSwdenk 3925c609719bSwdenk ? - print current values og the CPM Timer registers 3926c609719bSwdenk b - enable interrupts and start timer 3927c609719bSwdenk e - stop timer and disable interrupts 3928c609719bSwdenk q - quit application 3929c609719bSwdenk 3930c609719bSwdenk => loads 3931c609719bSwdenk ## Ready for S-Record download ... 3932c609719bSwdenk ~>examples/timer.srec 3933c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 ... 3934c609719bSwdenk [file transfer complete] 3935c609719bSwdenk [connected] 3936c609719bSwdenk ## Start Addr = 0x00040004 3937c609719bSwdenk 3938c609719bSwdenk => go 40004 3939c609719bSwdenk ## Starting application at 0x00040004 ... 3940c609719bSwdenk TIMERS=0xfff00980 3941c609719bSwdenk Using timer 1 3942c609719bSwdenk tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0 3943c609719bSwdenk 3944c609719bSwdenkHit 'b': 3945c609719bSwdenk [q, b, e, ?] Set interval 1000000 us 3946c609719bSwdenk Enabling timer 3947c609719bSwdenkHit '?': 3948c609719bSwdenk [q, b, e, ?] ........ 3949c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0 3950c609719bSwdenkHit '?': 3951c609719bSwdenk [q, b, e, ?] . 3952c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0 3953c609719bSwdenkHit '?': 3954c609719bSwdenk [q, b, e, ?] . 3955c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0 3956c609719bSwdenkHit '?': 3957c609719bSwdenk [q, b, e, ?] . 3958c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0 3959c609719bSwdenkHit 'e': 3960c609719bSwdenk [q, b, e, ?] ...Stopping timer 3961c609719bSwdenkHit 'q': 3962c609719bSwdenk [q, b, e, ?] ## Application terminated, rc = 0x0 3963c609719bSwdenk 3964c609719bSwdenk 396585ec0bccSwdenkMinicom warning: 396685ec0bccSwdenk================ 396785ec0bccSwdenk 39687152b1d0SwdenkOver time, many people have reported problems when trying to use the 396985ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd) 397085ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under 3971f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and 397285ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and 397385ec0bccSwdenkuse "cu" for S-Record download ("loads" command). 397485ec0bccSwdenk 397552f52c14SwdenkNevertheless, if you absolutely want to use it try adding this 397652f52c14Swdenkconfiguration to your "File transfer protocols" section: 397752f52c14Swdenk 397852f52c14Swdenk Name Program Name U/D FullScr IO-Red. Multi 397952f52c14Swdenk X kermit /usr/bin/kermit -i -l %l -s Y U Y N N 398052f52c14Swdenk Y kermit /usr/bin/kermit -i -l %l -r N D Y N N 398152f52c14Swdenk 398252f52c14Swdenk 3983c609719bSwdenkNetBSD Notes: 3984c609719bSwdenk============= 3985c609719bSwdenk 3986c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host 3987c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx). 3988c609719bSwdenk 3989c609719bSwdenkBuilding requires a cross environment; it is known to work on 3990c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also 3991c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make). 3992c609719bSwdenkNote that the cross-powerpc package does not install include files; 3993c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is 3994c609719bSwdenkmissing. This file has to be installed and patched manually: 3995c609719bSwdenk 3996c609719bSwdenk # cd /usr/pkg/cross/powerpc-netbsd/include 3997c609719bSwdenk # mkdir powerpc 3998c609719bSwdenk # ln -s powerpc machine 3999c609719bSwdenk # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h 4000c609719bSwdenk # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST 4001c609719bSwdenk 4002c609719bSwdenkNative builds *don't* work due to incompatibilities between native 4003c609719bSwdenkand U-Boot include files. 4004c609719bSwdenk 4005c609719bSwdenkBooting assumes that (the first part of) the image booted is a 4006c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel 4007c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source 4008c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the 40092a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz 4010c609719bSwdenk 4011c609719bSwdenk 4012c609719bSwdenkImplementation Internals: 4013c609719bSwdenk========================= 4014c609719bSwdenk 4015c609719bSwdenkThe following is not intended to be a complete description of every 4016c609719bSwdenkimplementation detail. However, it should help to understand the 4017c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom 4018c609719bSwdenkhardware. 4019c609719bSwdenk 4020c609719bSwdenk 4021c609719bSwdenkInitial Stack, Global Data: 4022c609719bSwdenk--------------------------- 4023c609719bSwdenk 4024c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot 4025c609719bSwdenkstarts running out of ROM (flash memory), usually without access to 4026c609719bSwdenksystem RAM (because the memory controller is not initialized yet). 4027c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS 4028c609719bSwdenkis not initialized as zero. To be able to get a C environment working 4029c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation 4030c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU 4031c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and 4032c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be 4033c609719bSwdenklocked as (mis-) used as memory, etc. 4034c609719bSwdenk 40357152b1d0Swdenk Chris Hallinan posted a good summary of these issues to the 40360668236bSWolfgang Denk U-Boot mailing list: 403743d9616cSwdenk 403843d9616cSwdenk Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)? 403943d9616cSwdenk From: "Chris Hallinan" <clh@net1plus.com> 404043d9616cSwdenk Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET) 404143d9616cSwdenk ... 404243d9616cSwdenk 404343d9616cSwdenk Correct me if I'm wrong, folks, but the way I understand it 404443d9616cSwdenk is this: Using DCACHE as initial RAM for Stack, etc, does not 404543d9616cSwdenk require any physical RAM backing up the cache. The cleverness 404643d9616cSwdenk is that the cache is being used as a temporary supply of 404743d9616cSwdenk necessary storage before the SDRAM controller is setup. It's 404811ccc33fSMarcel Ziswiler beyond the scope of this list to explain the details, but you 404943d9616cSwdenk can see how this works by studying the cache architecture and 405043d9616cSwdenk operation in the architecture and processor-specific manuals. 405143d9616cSwdenk 405243d9616cSwdenk OCM is On Chip Memory, which I believe the 405GP has 4K. It 405343d9616cSwdenk is another option for the system designer to use as an 405411ccc33fSMarcel Ziswiler initial stack/RAM area prior to SDRAM being available. Either 405543d9616cSwdenk option should work for you. Using CS 4 should be fine if your 405643d9616cSwdenk board designers haven't used it for something that would 405743d9616cSwdenk cause you grief during the initial boot! It is frequently not 405843d9616cSwdenk used. 405943d9616cSwdenk 40606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere 406143d9616cSwdenk with your processor/board/system design. The default value 406243d9616cSwdenk you will find in any recent u-boot distribution in 40638a316c9bSStefan Roese walnut.h should work for you. I'd set it to a value larger 406443d9616cSwdenk than your SDRAM module. If you have a 64MB SDRAM module, set 406543d9616cSwdenk it above 400_0000. Just make sure your board has no resources 406643d9616cSwdenk that are supposed to respond to that address! That code in 406743d9616cSwdenk start.S has been around a while and should work as is when 406843d9616cSwdenk you get the config right. 406943d9616cSwdenk 407043d9616cSwdenk -Chris Hallinan 407143d9616cSwdenk DS4.COM, Inc. 407243d9616cSwdenk 4073c609719bSwdenkIt is essential to remember this, since it has some impact on the C 4074c609719bSwdenkcode for the initialization procedures: 4075c609719bSwdenk 4076c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt 4077c609719bSwdenk to write it. 4078c609719bSwdenk 407911ccc33fSMarcel Ziswiler* Do not use any uninitialized global data (or implicitely initialized 4080c609719bSwdenk as zero data - BSS segment) at all - this is undefined, initiali- 40817152b1d0Swdenk zation is performed later (when relocating to RAM). 4082c609719bSwdenk 4083c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like 4084c609719bSwdenk that. 4085c609719bSwdenk 4086c609719bSwdenkHaving only the stack as writable memory limits means we cannot use 4087c609719bSwdenknormal global data to share information beween the code. But it 4088c609719bSwdenkturned out that the implementation of U-Boot can be greatly 4089c609719bSwdenksimplified by making a global data structure (gd_t) available to all 4090c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_ 4091c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of 4092c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we 4093c609719bSwdenkplace a pointer (gd) to the global data into a register which we 4094c609719bSwdenkreserve for this purpose. 4095c609719bSwdenk 40967152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the 4097c609719bSwdenkrelevant (E)ABI specifications for the current architecture, and by 4098c609719bSwdenkGCC's implementation. 4099c609719bSwdenk 4100c609719bSwdenkFor PowerPC, the following registers have specific use: 4101c609719bSwdenk R1: stack pointer 4102e7670f6cSWolfgang Denk R2: reserved for system use 4103c609719bSwdenk R3-R4: parameter passing and return values 4104c609719bSwdenk R5-R10: parameter passing 4105c609719bSwdenk R13: small data area pointer 4106c609719bSwdenk R30: GOT pointer 4107c609719bSwdenk R31: frame pointer 4108c609719bSwdenk 4109e6bee808SJoakim Tjernlund (U-Boot also uses R12 as internal GOT pointer. r12 4110e6bee808SJoakim Tjernlund is a volatile register so r12 needs to be reset when 4111e6bee808SJoakim Tjernlund going back and forth between asm and C) 4112c609719bSwdenk 4113e7670f6cSWolfgang Denk ==> U-Boot will use R2 to hold a pointer to the global data 4114c609719bSwdenk 4115c609719bSwdenk Note: on PPC, we could use a static initializer (since the 4116c609719bSwdenk address of the global data structure is known at compile time), 4117c609719bSwdenk but it turned out that reserving a register results in somewhat 4118c609719bSwdenk smaller code - although the code savings are not that big (on 4119c609719bSwdenk average for all boards 752 bytes for the whole U-Boot image, 4120c609719bSwdenk 624 text + 127 data). 4121c609719bSwdenk 4122c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here: 41234c58eb55SMike Frysinger http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface 41244c58eb55SMike Frysinger 4125c4db335cSRobin Getz ==> U-Boot will use P3 to hold a pointer to the global data 41264c58eb55SMike Frysinger 4127c609719bSwdenkOn ARM, the following registers are used: 4128c609719bSwdenk 4129c609719bSwdenk R0: function argument word/integer result 4130c609719bSwdenk R1-R3: function argument word 4131c609719bSwdenk R9: GOT pointer 4132c609719bSwdenk R10: stack limit (used only if stack checking if enabled) 4133c609719bSwdenk R11: argument (frame) pointer 4134c609719bSwdenk R12: temporary workspace 4135c609719bSwdenk R13: stack pointer 4136c609719bSwdenk R14: link register 4137c609719bSwdenk R15: program counter 4138c609719bSwdenk 4139c609719bSwdenk ==> U-Boot will use R8 to hold a pointer to the global data 4140c609719bSwdenk 41410df01fd3SThomas ChouOn Nios II, the ABI is documented here: 41420df01fd3SThomas Chou http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf 41430df01fd3SThomas Chou 41440df01fd3SThomas Chou ==> U-Boot will use gp to hold a pointer to the global data 41450df01fd3SThomas Chou 41460df01fd3SThomas Chou Note: on Nios II, we give "-G0" option to gcc and don't use gp 41470df01fd3SThomas Chou to access small data sections, so gp is free. 41480df01fd3SThomas Chou 4149d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope, 4150d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much. 4151c609719bSwdenk 4152c609719bSwdenkMemory Management: 4153c609719bSwdenk------------------ 4154c609719bSwdenk 4155c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the 4156c609719bSwdenkMMU is not used either for address mapping nor for memory protection. 4157c609719bSwdenk 4158c609719bSwdenkThe available memory is mapped to fixed addresses using the memory 4159c609719bSwdenkcontroller. In this process, a contiguous block is formed for each 4160c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several 4161c609719bSwdenkphysical memory banks. 4162c609719bSwdenk 4163c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on 4164c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After 4165c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself 4166c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some 41676d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN 4168c609719bSwdenkconfiguration setting]. Below that, a structure with global Board 4169c609719bSwdenkInfo data is placed, followed by the stack (growing downward). 4170c609719bSwdenk 4171c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB 4172c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF). 4173c609719bSwdenk 4174c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like 4175c609719bSwdenkthis: 4176c609719bSwdenk 4177c609719bSwdenk 0x0000 0000 Exception Vector code 4178c609719bSwdenk : 4179c609719bSwdenk 0x0000 1FFF 4180c609719bSwdenk 0x0000 2000 Free for Application Use 4181c609719bSwdenk : 4182c609719bSwdenk : 4183c609719bSwdenk 4184c609719bSwdenk : 4185c609719bSwdenk : 4186c609719bSwdenk 0x00FB FF20 Monitor Stack (Growing downward) 4187c609719bSwdenk 0x00FB FFAC Board Info Data and permanent copy of global data 4188c609719bSwdenk 0x00FC 0000 Malloc Arena 4189c609719bSwdenk : 4190c609719bSwdenk 0x00FD FFFF 4191c609719bSwdenk 0x00FE 0000 RAM Copy of Monitor Code 4192c609719bSwdenk ... eventually: LCD or video framebuffer 4193c609719bSwdenk ... eventually: pRAM (Protected RAM - unchanged by reset) 4194c609719bSwdenk 0x00FF FFFF [End of RAM] 4195c609719bSwdenk 4196c609719bSwdenk 4197c609719bSwdenkSystem Initialization: 4198c609719bSwdenk---------------------- 4199c609719bSwdenk 4200c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point 420111ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset 4202c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory. 42037152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address. 4204c609719bSwdenkTo be able to implement the initialization code in C, a (small!) 4205c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs 4206c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked 4207c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core, 4208c609719bSwdenkthe caches and the SIU. 4209c609719bSwdenk 4210c609719bSwdenkNext, all (potentially) available memory banks are mapped using a 4211c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries 4212c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash 4213c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is 4214c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a 4215c609719bSwdenksimple memory test is run that determines the size of the SDRAM 4216c609719bSwdenkbanks. 4217c609719bSwdenk 4218c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of 42197152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first 4220c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address 4221c609719bSwdenk0x00000000, with any additional banks following immediately to create 4222c609719bSwdenkcontiguous memory starting from 0. 4223c609719bSwdenk 4224c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area 4225c609719bSwdenkand allocates memory for use by malloc() and for the global Board 4226c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM 4227c609719bSwdenkpages, and the final stack is set up. 4228c609719bSwdenk 4229c609719bSwdenkOnly after this relocation will you have a "normal" C environment; 4230c609719bSwdenkuntil that you are restricted in several ways, mostly because you are 4231c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a 4232c609719bSwdenknew address in RAM. 4233c609719bSwdenk 4234c609719bSwdenk 4235c609719bSwdenkU-Boot Porting Guide: 4236c609719bSwdenk---------------------- 4237c609719bSwdenk 4238c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing 42396aff3115Swdenklist, October 2002] 4240c609719bSwdenk 4241c609719bSwdenk 4242c609719bSwdenkint main(int argc, char *argv[]) 4243c609719bSwdenk{ 4244c609719bSwdenk sighandler_t no_more_time; 4245c609719bSwdenk 4246c609719bSwdenk signal(SIGALRM, no_more_time); 4247c609719bSwdenk alarm(PROJECT_DEADLINE - toSec (3 * WEEK)); 4248c609719bSwdenk 4249c609719bSwdenk if (available_money > available_manpower) { 42506c3fef28SJerry Van Baren Pay consultant to port U-Boot; 4251c609719bSwdenk return 0; 4252c609719bSwdenk } 4253c609719bSwdenk 4254c609719bSwdenk Download latest U-Boot source; 4255c609719bSwdenk 42560668236bSWolfgang Denk Subscribe to u-boot mailing list; 42576aff3115Swdenk 42586c3fef28SJerry Van Baren if (clueless) 4259c609719bSwdenk email("Hi, I am new to U-Boot, how do I get started?"); 4260c609719bSwdenk 4261c609719bSwdenk while (learning) { 4262c609719bSwdenk Read the README file in the top level directory; 42637cb22f97Swdenk Read http://www.denx.de/twiki/bin/view/DULG/Manual; 42646c3fef28SJerry Van Baren Read applicable doc/*.README; 4265c609719bSwdenk Read the source, Luke; 42666c3fef28SJerry Van Baren /* find . -name "*.[chS]" | xargs grep -i <keyword> */ 4267c609719bSwdenk } 4268c609719bSwdenk 42696c3fef28SJerry Van Baren if (available_money > toLocalCurrency ($2500)) 42706c3fef28SJerry Van Baren Buy a BDI3000; 42716c3fef28SJerry Van Baren else 4272c609719bSwdenk Add a lot of aggravation and time; 4273c609719bSwdenk 42746c3fef28SJerry Van Baren if (a similar board exists) { /* hopefully... */ 42756c3fef28SJerry Van Baren cp -a board/<similar> board/<myboard> 42766c3fef28SJerry Van Baren cp include/configs/<similar>.h include/configs/<myboard>.h 42776c3fef28SJerry Van Baren } else { 4278c609719bSwdenk Create your own board support subdirectory; 42796c3fef28SJerry Van Baren Create your own board include/configs/<myboard>.h file; 42806c3fef28SJerry Van Baren } 42816c3fef28SJerry Van Baren Edit new board/<myboard> files 42826c3fef28SJerry Van Baren Edit new include/configs/<myboard>.h 4283c609719bSwdenk 42846c3fef28SJerry Van Baren while (!accepted) { 4285c609719bSwdenk while (!running) { 4286c609719bSwdenk do { 4287c609719bSwdenk Add / modify source code; 4288c609719bSwdenk } until (compiles); 4289c609719bSwdenk Debug; 4290c609719bSwdenk if (clueless) 4291c609719bSwdenk email("Hi, I am having problems..."); 4292c609719bSwdenk } 42936c3fef28SJerry Van Baren Send patch file to the U-Boot email list; 42946c3fef28SJerry Van Baren if (reasonable critiques) 42956c3fef28SJerry Van Baren Incorporate improvements from email list code review; 42966c3fef28SJerry Van Baren else 42976c3fef28SJerry Van Baren Defend code as written; 42986c3fef28SJerry Van Baren } 4299c609719bSwdenk 4300c609719bSwdenk return 0; 4301c609719bSwdenk} 4302c609719bSwdenk 4303c609719bSwdenkvoid no_more_time (int sig) 4304c609719bSwdenk{ 4305c609719bSwdenk hire_a_guru(); 4306c609719bSwdenk} 4307c609719bSwdenk 4308c609719bSwdenk 4309c609719bSwdenkCoding Standards: 4310c609719bSwdenk----------------- 4311c609719bSwdenk 4312c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel 43132c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script 43142c051651SDetlev Zundel"scripts/Lindent" in your Linux kernel source directory. In sources 43152c051651SDetlev Zundeloriginating from U-Boot a style corresponding to "Lindent -pcs" (adding 43162c051651SDetlev Zundelspaces before parameters to function calls) is actually used. 4317c609719bSwdenk 43182c051651SDetlev ZundelSource files originating from a different project (for example the 43192c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not 43202c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those 43212c051651SDetlev Zundelsources. 43222c051651SDetlev Zundel 43232c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in 43242c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//) 43252c051651SDetlev Zundelin your code. 4326c609719bSwdenk 4327c178d3daSwdenkPlease also stick to the following formatting rules: 4328180d3f74Swdenk- remove any trailing white space 4329180d3f74Swdenk- use TAB characters for indentation, not spaces 4330180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds 4331180d3f74Swdenk- do not add more than 2 empty lines to source files 4332180d3f74Swdenk- do not add trailing empty lines to source files 4333180d3f74Swdenk 4334c609719bSwdenkSubmissions which do not conform to the standards may be returned 4335c609719bSwdenkwith a request to reformat the changes. 4336c609719bSwdenk 4337c609719bSwdenk 4338c609719bSwdenkSubmitting Patches: 4339c609719bSwdenk------------------- 4340c609719bSwdenk 4341c609719bSwdenkSince the number of patches for U-Boot is growing, we need to 4342c609719bSwdenkestablish some rules. Submissions which do not conform to these rules 4343c609719bSwdenkmay be rejected, even when they contain important and valuable stuff. 4344c609719bSwdenk 43450d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details. 4346218ca724SWolfgang Denk 43470668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>; 43480668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot 43490668236bSWolfgang Denk 4350c609719bSwdenkWhen you send a patch, please include the following information with 4351c609719bSwdenkit: 4352c609719bSwdenk 4353c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes 4354c609719bSwdenk this bug. Please try to include a way of demonstrating that the 4355c609719bSwdenk patch actually fixes something. 4356c609719bSwdenk 4357c609719bSwdenk* For new features: a description of the feature and your 4358c609719bSwdenk implementation. 4359c609719bSwdenk 4360c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch) 4361c609719bSwdenk 4362c609719bSwdenk* For major contributions, your entry to the CREDITS file 4363c609719bSwdenk 4364c609719bSwdenk* When you add support for a new board, don't forget to add this 4365c609719bSwdenk board to the MAKEALL script, too. 4366c609719bSwdenk 4367c609719bSwdenk* If your patch adds new configuration options, don't forget to 4368c609719bSwdenk document these in the README file. 4369c609719bSwdenk 4370218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly* 4371218ca724SWolfgang Denk recommended) you can easily generate the patch using the 4372218ca724SWolfgang Denk "git-format-patch". If you then use "git-send-email" to send it to 4373218ca724SWolfgang Denk the U-Boot mailing list, you will avoid most of the common problems 4374218ca724SWolfgang Denk with some other mail clients. 4375c609719bSwdenk 4376218ca724SWolfgang Denk If you cannot use git, use "diff -purN OLD NEW". If your version of 4377218ca724SWolfgang Denk diff does not support these options, then get the latest version of 4378218ca724SWolfgang Denk GNU diff. 43796dff5529Swdenk 4380218ca724SWolfgang Denk The current directory when running this command shall be the parent 4381218ca724SWolfgang Denk directory of the U-Boot source tree (i. e. please make sure that 4382218ca724SWolfgang Denk your patch includes sufficient directory information for the 4383218ca724SWolfgang Denk affected files). 4384218ca724SWolfgang Denk 4385218ca724SWolfgang Denk We prefer patches as plain text. MIME attachments are discouraged, 4386218ca724SWolfgang Denk and compressed attachments must not be used. 4387c609719bSwdenk 438852f52c14Swdenk* If one logical set of modifications affects or creates several 438952f52c14Swdenk files, all these changes shall be submitted in a SINGLE patch file. 439052f52c14Swdenk 439152f52c14Swdenk* Changesets that contain different, unrelated modifications shall be 439252f52c14Swdenk submitted as SEPARATE patches, one patch per changeset. 439352f52c14Swdenk 439452f52c14Swdenk 4395c609719bSwdenkNotes: 4396c609719bSwdenk 4397c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched 4398c609719bSwdenk source tree and make sure that no errors or warnings are reported 4399c609719bSwdenk for any of the boards. 4400c609719bSwdenk 4401c609719bSwdenk* Keep your modifications to the necessary minimum: A patch 4402c609719bSwdenk containing several unrelated changes or arbitrary reformats will be 4403c609719bSwdenk returned with a request to re-formatting / split it. 4404c609719bSwdenk 4405c609719bSwdenk* If you modify existing code, make sure that your new code does not 4406c609719bSwdenk add to the memory footprint of the code ;-) Small is beautiful! 4407c609719bSwdenk When adding new features, these should compile conditionally only 4408c609719bSwdenk (using #ifdef), and the resulting code with the new feature 4409c609719bSwdenk disabled must not need more memory than the old code without your 4410c609719bSwdenk modification. 441190dc6704Swdenk 44120668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the 44130668236bSWolfgang Denk u-boot mailing list. Bigger patches will be moderated. If they are 44140668236bSWolfgang Denk reasonable and not too big, they will be acknowledged. But patches 44150668236bSWolfgang Denk bigger than the size limit should be avoided. 4416