1c609719bSwdenk# 26abe6fb6SDetlev Zundel# (C) Copyright 2000 - 2011 3c609719bSwdenk# Wolfgang Denk, DENX Software Engineering, wd@denx.de. 4c609719bSwdenk# 5c609719bSwdenk# See file CREDITS for list of people who contributed to this 6c609719bSwdenk# project. 7c609719bSwdenk# 8c609719bSwdenk# This program is free software; you can redistribute it and/or 9c609719bSwdenk# modify it under the terms of the GNU General Public License as 10c609719bSwdenk# published by the Free Software Foundation; either version 2 of 11c609719bSwdenk# the License, or (at your option) any later version. 12c609719bSwdenk# 13c609719bSwdenk# This program is distributed in the hope that it will be useful, 14c609719bSwdenk# but WITHOUT ANY WARRANTY; without even the implied warranty of 15c609719bSwdenk# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16c609719bSwdenk# GNU General Public License for more details. 17c609719bSwdenk# 18c609719bSwdenk# You should have received a copy of the GNU General Public License 19c609719bSwdenk# along with this program; if not, write to the Free Software 20c609719bSwdenk# Foundation, Inc., 59 Temple Place, Suite 330, Boston, 21c609719bSwdenk# MA 02111-1307 USA 22c609719bSwdenk# 23c609719bSwdenk 24c609719bSwdenkSummary: 25c609719bSwdenk======== 26c609719bSwdenk 2724ee89b9SwdenkThis directory contains the source code for U-Boot, a boot loader for 28e86e5a07SwdenkEmbedded boards based on PowerPC, ARM, MIPS and several other 29e86e5a07Swdenkprocessors, which can be installed in a boot ROM and used to 30e86e5a07Swdenkinitialize and test the hardware or to download and run application 31e86e5a07Swdenkcode. 32c609719bSwdenk 33c609719bSwdenkThe development of U-Boot is closely related to Linux: some parts of 3424ee89b9Swdenkthe source code originate in the Linux source tree, we have some 3524ee89b9Swdenkheader files in common, and special provision has been made to 36c609719bSwdenksupport booting of Linux images. 37c609719bSwdenk 38c609719bSwdenkSome attention has been paid to make this software easily 39c609719bSwdenkconfigurable and extendable. For instance, all monitor commands are 40c609719bSwdenkimplemented with the same call interface, so that it's very easy to 41c609719bSwdenkadd new commands. Also, instead of permanently adding rarely used 42c609719bSwdenkcode (for instance hardware test utilities) to the monitor, you can 43c609719bSwdenkload and run it dynamically. 44c609719bSwdenk 45c609719bSwdenk 46c609719bSwdenkStatus: 47c609719bSwdenk======= 48c609719bSwdenk 49c609719bSwdenkIn general, all boards for which a configuration option exists in the 50c609719bSwdenkMakefile have been tested to some extent and can be considered 51c609719bSwdenk"working". In fact, many of them are used in production systems. 52c609719bSwdenk 53c609719bSwdenkIn case of problems see the CHANGELOG and CREDITS files to find out 54218ca724SWolfgang Denkwho contributed the specific port. The MAINTAINERS file lists board 55218ca724SWolfgang Denkmaintainers. 56c609719bSwdenk 57c609719bSwdenk 58c609719bSwdenkWhere to get help: 59c609719bSwdenk================== 60c609719bSwdenk 61c609719bSwdenkIn case you have questions about, problems with or contributions for 62c609719bSwdenkU-Boot you should send a message to the U-Boot mailing list at 630c32565fSPeter Tyser<u-boot@lists.denx.de>. There is also an archive of previous traffic 640c32565fSPeter Tyseron the mailing list - please search the archive before asking FAQ's. 650c32565fSPeter TyserPlease see http://lists.denx.de/pipermail/u-boot and 660c32565fSPeter Tyserhttp://dir.gmane.org/gmane.comp.boot-loaders.u-boot 67c609719bSwdenk 68c609719bSwdenk 69218ca724SWolfgang DenkWhere to get source code: 70218ca724SWolfgang Denk========================= 71218ca724SWolfgang Denk 72218ca724SWolfgang DenkThe U-Boot source code is maintained in the git repository at 73218ca724SWolfgang Denkgit://www.denx.de/git/u-boot.git ; you can browse it online at 74218ca724SWolfgang Denkhttp://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary 75218ca724SWolfgang Denk 76218ca724SWolfgang DenkThe "snapshot" links on this page allow you to download tarballs of 7711ccc33fSMarcel Ziswilerany version you might be interested in. Official releases are also 78218ca724SWolfgang Denkavailable for FTP download from the ftp://ftp.denx.de/pub/u-boot/ 79218ca724SWolfgang Denkdirectory. 80218ca724SWolfgang Denk 81d4ee711dSAnatolij GustschinPre-built (and tested) images are available from 82218ca724SWolfgang Denkftp://ftp.denx.de/pub/u-boot/images/ 83218ca724SWolfgang Denk 84218ca724SWolfgang Denk 85c609719bSwdenkWhere we come from: 86c609719bSwdenk=================== 87c609719bSwdenk 88c609719bSwdenk- start from 8xxrom sources 8924ee89b9Swdenk- create PPCBoot project (http://sourceforge.net/projects/ppcboot) 90c609719bSwdenk- clean up code 91c609719bSwdenk- make it easier to add custom boards 92c609719bSwdenk- make it possible to add other [PowerPC] CPUs 93c609719bSwdenk- extend functions, especially: 94c609719bSwdenk * Provide extended interface to Linux boot loader 95c609719bSwdenk * S-Record download 96c609719bSwdenk * network boot 9711ccc33fSMarcel Ziswiler * PCMCIA / CompactFlash / ATA disk / SCSI ... boot 9824ee89b9Swdenk- create ARMBoot project (http://sourceforge.net/projects/armboot) 99c609719bSwdenk- add other CPU families (starting with ARM) 10024ee89b9Swdenk- create U-Boot project (http://sourceforge.net/projects/u-boot) 1010d28f34bSMagnus Lilja- current project page: see http://www.denx.de/wiki/U-Boot 10224ee89b9Swdenk 10324ee89b9Swdenk 10424ee89b9SwdenkNames and Spelling: 10524ee89b9Swdenk=================== 10624ee89b9Swdenk 10724ee89b9SwdenkThe "official" name of this project is "Das U-Boot". The spelling 10824ee89b9Swdenk"U-Boot" shall be used in all written text (documentation, comments 10924ee89b9Swdenkin source files etc.). Example: 11024ee89b9Swdenk 11124ee89b9Swdenk This is the README file for the U-Boot project. 11224ee89b9Swdenk 11324ee89b9SwdenkFile names etc. shall be based on the string "u-boot". Examples: 11424ee89b9Swdenk 11524ee89b9Swdenk include/asm-ppc/u-boot.h 11624ee89b9Swdenk 11724ee89b9Swdenk #include <asm/u-boot.h> 11824ee89b9Swdenk 11924ee89b9SwdenkVariable names, preprocessor constants etc. shall be either based on 12024ee89b9Swdenkthe string "u_boot" or on "U_BOOT". Example: 12124ee89b9Swdenk 12224ee89b9Swdenk U_BOOT_VERSION u_boot_logo 12324ee89b9Swdenk IH_OS_U_BOOT u_boot_hush_start 124c609719bSwdenk 125c609719bSwdenk 12693f19cc0SwdenkVersioning: 12793f19cc0Swdenk=========== 12893f19cc0Swdenk 129360d883aSThomas WeberStarting with the release in October 2008, the names of the releases 130360d883aSThomas Weberwere changed from numerical release numbers without deeper meaning 131360d883aSThomas Weberinto a time stamp based numbering. Regular releases are identified by 132360d883aSThomas Webernames consisting of the calendar year and month of the release date. 133360d883aSThomas WeberAdditional fields (if present) indicate release candidates or bug fix 134360d883aSThomas Weberreleases in "stable" maintenance trees. 13593f19cc0Swdenk 136360d883aSThomas WeberExamples: 137360d883aSThomas Weber U-Boot v2009.11 - Release November 2009 138360d883aSThomas Weber U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree 139360d883aSThomas Weber U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release 14093f19cc0Swdenk 14193f19cc0Swdenk 142c609719bSwdenkDirectory Hierarchy: 143c609719bSwdenk==================== 144c609719bSwdenk 1458d321b81SPeter Tyser/arch Architecture specific files 1468d321b81SPeter Tyser /arm Files generic to ARM architecture 1478d321b81SPeter Tyser /cpu CPU specific files 1488d321b81SPeter Tyser /arm720t Files specific to ARM 720 CPUs 1498d321b81SPeter Tyser /arm920t Files specific to ARM 920 CPUs 1508d321b81SPeter Tyser /at91rm9200 Files specific to Atmel AT91RM9200 CPU 1518d321b81SPeter Tyser /imx Files specific to Freescale MC9328 i.MX CPUs 1528d321b81SPeter Tyser /s3c24x0 Files specific to Samsung S3C24X0 CPUs 1538d321b81SPeter Tyser /arm925t Files specific to ARM 925 CPUs 1548d321b81SPeter Tyser /arm926ejs Files specific to ARM 926 CPUs 1558d321b81SPeter Tyser /arm1136 Files specific to ARM 1136 CPUs 1568d321b81SPeter Tyser /ixp Files specific to Intel XScale IXP CPUs 1578d321b81SPeter Tyser /pxa Files specific to Intel XScale PXA CPUs 1588d321b81SPeter Tyser /s3c44b0 Files specific to Samsung S3C44B0 CPUs 1598d321b81SPeter Tyser /sa1100 Files specific to Intel StrongARM SA1100 CPUs 1608d321b81SPeter Tyser /lib Architecture specific library files 1618d321b81SPeter Tyser /avr32 Files generic to AVR32 architecture 1628d321b81SPeter Tyser /cpu CPU specific files 1638d321b81SPeter Tyser /lib Architecture specific library files 1648d321b81SPeter Tyser /blackfin Files generic to Analog Devices Blackfin architecture 1658d321b81SPeter Tyser /cpu CPU specific files 1668d321b81SPeter Tyser /lib Architecture specific library files 167fea25720SGraeme Russ /x86 Files generic to x86 architecture 1688d321b81SPeter Tyser /cpu CPU specific files 1698d321b81SPeter Tyser /lib Architecture specific library files 1708d321b81SPeter Tyser /m68k Files generic to m68k architecture 1718d321b81SPeter Tyser /cpu CPU specific files 1728d321b81SPeter Tyser /mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs 1738d321b81SPeter Tyser /mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs 1748d321b81SPeter Tyser /mcf532x Files specific to Freescale ColdFire MCF5329 CPUs 1758d321b81SPeter Tyser /mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs 1768d321b81SPeter Tyser /mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs 1778d321b81SPeter Tyser /lib Architecture specific library files 1788d321b81SPeter Tyser /microblaze Files generic to microblaze architecture 1798d321b81SPeter Tyser /cpu CPU specific files 1808d321b81SPeter Tyser /lib Architecture specific library files 1818d321b81SPeter Tyser /mips Files generic to MIPS architecture 1828d321b81SPeter Tyser /cpu CPU specific files 1838d321b81SPeter Tyser /lib Architecture specific library files 1848d321b81SPeter Tyser /nios2 Files generic to Altera NIOS2 architecture 1858d321b81SPeter Tyser /cpu CPU specific files 1868d321b81SPeter Tyser /lib Architecture specific library files 187a47a12beSStefan Roese /powerpc Files generic to PowerPC architecture 1888d321b81SPeter Tyser /cpu CPU specific files 1898d321b81SPeter Tyser /74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs 1908d321b81SPeter Tyser /mpc5xx Files specific to Freescale MPC5xx CPUs 1918d321b81SPeter Tyser /mpc5xxx Files specific to Freescale MPC5xxx CPUs 1928d321b81SPeter Tyser /mpc8xx Files specific to Freescale MPC8xx CPUs 1938d321b81SPeter Tyser /mpc8220 Files specific to Freescale MPC8220 CPUs 1948d321b81SPeter Tyser /mpc824x Files specific to Freescale MPC824x CPUs 1958d321b81SPeter Tyser /mpc8260 Files specific to Freescale MPC8260 CPUs 1968d321b81SPeter Tyser /mpc85xx Files specific to Freescale MPC85xx CPUs 1978d321b81SPeter Tyser /ppc4xx Files specific to AMCC PowerPC 4xx CPUs 1988d321b81SPeter Tyser /lib Architecture specific library files 1998d321b81SPeter Tyser /sh Files generic to SH architecture 2008d321b81SPeter Tyser /cpu CPU specific files 2018d321b81SPeter Tyser /sh2 Files specific to sh2 CPUs 2028d321b81SPeter Tyser /sh3 Files specific to sh3 CPUs 2038d321b81SPeter Tyser /sh4 Files specific to sh4 CPUs 2048d321b81SPeter Tyser /lib Architecture specific library files 2058d321b81SPeter Tyser /sparc Files generic to SPARC architecture 2068d321b81SPeter Tyser /cpu CPU specific files 2078d321b81SPeter Tyser /leon2 Files specific to Gaisler LEON2 SPARC CPU 2088d321b81SPeter Tyser /leon3 Files specific to Gaisler LEON3 SPARC CPU 2098d321b81SPeter Tyser /lib Architecture specific library files 2108d321b81SPeter Tyser/api Machine/arch independent API for external apps 2118d321b81SPeter Tyser/board Board dependent files 2128d321b81SPeter Tyser/common Misc architecture independent functions 2138d321b81SPeter Tyser/disk Code for disk drive partition handling 2148d321b81SPeter Tyser/doc Documentation (don't expect too much) 2158d321b81SPeter Tyser/drivers Commonly used device drivers 2168d321b81SPeter Tyser/examples Example code for standalone applications, etc. 2178d321b81SPeter Tyser/fs Filesystem code (cramfs, ext2, jffs2, etc.) 2188d321b81SPeter Tyser/include Header Files 2198d321b81SPeter Tyser/lib Files generic to all architectures 2208d321b81SPeter Tyser /libfdt Library files to support flattened device trees 2218d321b81SPeter Tyser /lzma Library files to support LZMA decompression 2228d321b81SPeter Tyser /lzo Library files to support LZO decompression 2238d321b81SPeter Tyser/net Networking code 2248d321b81SPeter Tyser/post Power On Self Test 2258d321b81SPeter Tyser/rtc Real Time Clock drivers 2268d321b81SPeter Tyser/tools Tools to build S-Record or U-Boot images, etc. 227c609719bSwdenk 228c609719bSwdenkSoftware Configuration: 229c609719bSwdenk======================= 230c609719bSwdenk 231c609719bSwdenkConfiguration is usually done using C preprocessor defines; the 232c609719bSwdenkrationale behind that is to avoid dead code whenever possible. 233c609719bSwdenk 234c609719bSwdenkThere are two classes of configuration variables: 235c609719bSwdenk 236c609719bSwdenk* Configuration _OPTIONS_: 237c609719bSwdenk These are selectable by the user and have names beginning with 238c609719bSwdenk "CONFIG_". 239c609719bSwdenk 240c609719bSwdenk* Configuration _SETTINGS_: 241c609719bSwdenk These depend on the hardware etc. and should not be meddled with if 242c609719bSwdenk you don't know what you're doing; they have names beginning with 2436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD "CONFIG_SYS_". 244c609719bSwdenk 245c609719bSwdenkLater we will add a configuration tool - probably similar to or even 246c609719bSwdenkidentical to what's used for the Linux kernel. Right now, we have to 247c609719bSwdenkdo the configuration by hand, which means creating some symbolic 248c609719bSwdenklinks and editing some configuration files. We use the TQM8xxL boards 249c609719bSwdenkas an example here. 250c609719bSwdenk 251c609719bSwdenk 252c609719bSwdenkSelection of Processor Architecture and Board Type: 253c609719bSwdenk--------------------------------------------------- 254c609719bSwdenk 255c609719bSwdenkFor all supported boards there are ready-to-use default 256c609719bSwdenkconfigurations available; just type "make <board_name>_config". 257c609719bSwdenk 258c609719bSwdenkExample: For a TQM823L module type: 259c609719bSwdenk 260c609719bSwdenk cd u-boot 261c609719bSwdenk make TQM823L_config 262c609719bSwdenk 26311ccc33fSMarcel ZiswilerFor the Cogent platform, you need to specify the CPU type as well; 264c609719bSwdenke.g. "make cogent_mpc8xx_config". And also configure the cogent 265c609719bSwdenkdirectory according to the instructions in cogent/README. 266c609719bSwdenk 267c609719bSwdenk 268c609719bSwdenkConfiguration Options: 269c609719bSwdenk---------------------- 270c609719bSwdenk 271c609719bSwdenkConfiguration depends on the combination of board and CPU type; all 272c609719bSwdenksuch information is kept in a configuration file 273c609719bSwdenk"include/configs/<board_name>.h". 274c609719bSwdenk 275c609719bSwdenkExample: For a TQM823L module, all configuration settings are in 276c609719bSwdenk"include/configs/TQM823L.h". 277c609719bSwdenk 278c609719bSwdenk 2797f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux 2807f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to 2817f6c2cbcSwdenkbuild a config tool - later. 2827f6c2cbcSwdenk 2837f6c2cbcSwdenk 284c609719bSwdenkThe following options need to be configured: 285c609719bSwdenk 2862628114eSKim Phillips- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX. 287c609719bSwdenk 2882628114eSKim Phillips- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS. 2896ccec449SWolfgang Denk 2906ccec449SWolfgang Denk- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined) 29109ea0de0SHaavard Skinnemoen Define exactly one, e.g. CONFIG_ATSTK1002 292c609719bSwdenk 293c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined) 294c609719bSwdenk Define exactly one of 295c609719bSwdenk CONFIG_CMA286_60_OLD 296c609719bSwdenk--- FIXME --- not tested yet: 297c609719bSwdenk CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P, 298c609719bSwdenk CONFIG_CMA287_23, CONFIG_CMA287_50 299c609719bSwdenk 300c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined) 301c609719bSwdenk Define exactly one of 302c609719bSwdenk CONFIG_CMA101, CONFIG_CMA102 303c609719bSwdenk 304c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined) 305c609719bSwdenk Define one or more of 306c609719bSwdenk CONFIG_CMA302 307c609719bSwdenk 308c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined) 309c609719bSwdenk Define one or more of 310c609719bSwdenk CONFIG_LCD_HEARTBEAT - update a character position on 31111ccc33fSMarcel Ziswiler the LCD display every second with 312c609719bSwdenk a "rotator" |\-/|\-/ 313c609719bSwdenk 3142535d602Swdenk- Board flavour: (if CONFIG_MPC8260ADS is defined) 3152535d602Swdenk CONFIG_ADSTYPE 3162535d602Swdenk Possible values are: 3176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8260ADS - original MPC8260ADS 3186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8266ADS - MPC8266ADS 3196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR 3206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8272ADS - MPC8272ADS 3212535d602Swdenk 322cf946c6dSLei Wen- Marvell Family Member 323cf946c6dSLei Wen CONFIG_SYS_MVFS - define it if you want to enable 324cf946c6dSLei Wen multiple fs option at one time 325cf946c6dSLei Wen for marvell soc family 326cf946c6dSLei Wen 327c609719bSwdenk- MPC824X Family Member (if CONFIG_MPC824X is defined) 328c609719bSwdenk Define exactly one of 329c609719bSwdenk CONFIG_MPC8240, CONFIG_MPC8245 330c609719bSwdenk 33111ccc33fSMarcel Ziswiler- 8xx CPU Options: (if using an MPC8xx CPU) 33266ca92a5Swdenk CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if 33366ca92a5Swdenk get_gclk_freq() cannot work 3345da627a4Swdenk e.g. if there is no 32KHz 3355da627a4Swdenk reference PIT/RTC clock 33666ca92a5Swdenk CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK 33766ca92a5Swdenk or XTAL/EXTAL) 338c609719bSwdenk 33966ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU): 3406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8xx_CPUCLK_MIN 3416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8xx_CPUCLK_MAX 34266ca92a5Swdenk CONFIG_8xx_CPUCLK_DEFAULT 34375d1ea7fSwdenk See doc/README.MPC866 34475d1ea7fSwdenk 3456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MEASURE_CPUCLK 34675d1ea7fSwdenk 34775d1ea7fSwdenk Define this to measure the actual CPU clock instead 34875d1ea7fSwdenk of relying on the correctness of the configured 34975d1ea7fSwdenk values. Mostly useful for board bringup to make sure 35075d1ea7fSwdenk the PLL is locked at the intended frequency. Note 35175d1ea7fSwdenk that this requires a (stable) reference clock (32 kHz 3526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD RTC clock or CONFIG_SYS_8XX_XIN) 35375d1ea7fSwdenk 354506f3918SHeiko Schocher CONFIG_SYS_DELAYED_ICACHE 355506f3918SHeiko Schocher 356506f3918SHeiko Schocher Define this option if you want to enable the 357506f3918SHeiko Schocher ICache only when Code runs from RAM. 358506f3918SHeiko Schocher 35966412c63SKumar Gala- 85xx CPU Options: 36066412c63SKumar Gala CONFIG_SYS_FSL_TBCLK_DIV 36166412c63SKumar Gala 36266412c63SKumar Gala Defines the core time base clock divider ratio compared to the 36366412c63SKumar Gala system clock. On most PQ3 devices this is 8, on newer QorIQ 36466412c63SKumar Gala devices it can be 16 or 32. The ratio varies from SoC to Soc. 36566412c63SKumar Gala 3668f29084aSKumar Gala CONFIG_SYS_FSL_PCIE_COMPAT 3678f29084aSKumar Gala 3688f29084aSKumar Gala Defines the string to utilize when trying to match PCIe device 3698f29084aSKumar Gala tree nodes for the given platform. 3708f29084aSKumar Gala 3710b953ffcSMarkus Klotzbuecher- Intel Monahans options: 3726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO 3730b953ffcSMarkus Klotzbuecher 3740b953ffcSMarkus Klotzbuecher Defines the Monahans run mode to oscillator 3750b953ffcSMarkus Klotzbuecher ratio. Valid values are 8, 16, 24, 31. The core 3760b953ffcSMarkus Klotzbuecher frequency is this value multiplied by 13 MHz. 3770b953ffcSMarkus Klotzbuecher 3786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO 3790b953ffcSMarkus Klotzbuecher 3800b953ffcSMarkus Klotzbuecher Defines the Monahans turbo mode to oscillator 3810b953ffcSMarkus Klotzbuecher ratio. Valid values are 1 (default if undefined) and 3820b953ffcSMarkus Klotzbuecher 2. The core frequency as calculated above is multiplied 3830b953ffcSMarkus Klotzbuecher by this value. 3840b953ffcSMarkus Klotzbuecher 3855da627a4Swdenk- Linux Kernel Interface: 386c609719bSwdenk CONFIG_CLOCKS_IN_MHZ 387c609719bSwdenk 388c609719bSwdenk U-Boot stores all clock information in Hz 389c609719bSwdenk internally. For binary compatibility with older Linux 390c609719bSwdenk kernels (which expect the clocks passed in the 391c609719bSwdenk bd_info data to be in MHz) the environment variable 392c609719bSwdenk "clocks_in_mhz" can be defined so that U-Boot 393c609719bSwdenk converts clock data to MHZ before passing it to the 394c609719bSwdenk Linux kernel. 395c609719bSwdenk When CONFIG_CLOCKS_IN_MHZ is defined, a definition of 396c609719bSwdenk "clocks_in_mhz=1" is automatically included in the 397c609719bSwdenk default environment. 398c609719bSwdenk 3995da627a4Swdenk CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only] 4005da627a4Swdenk 40111ccc33fSMarcel Ziswiler When transferring memsize parameter to linux, some versions 4025da627a4Swdenk expect it to be in bytes, others in MB. 4035da627a4Swdenk Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes. 4045da627a4Swdenk 405fec6d9eeSGerald Van Baren CONFIG_OF_LIBFDT 406f57f70aaSWolfgang Denk 407f57f70aaSWolfgang Denk New kernel versions are expecting firmware settings to be 408213bf8c8SGerald Van Baren passed using flattened device trees (based on open firmware 409213bf8c8SGerald Van Baren concepts). 410213bf8c8SGerald Van Baren 411213bf8c8SGerald Van Baren CONFIG_OF_LIBFDT 412213bf8c8SGerald Van Baren * New libfdt-based support 413213bf8c8SGerald Van Baren * Adds the "fdt" command 4143bb342fcSKim Phillips * The bootm command automatically updates the fdt 415213bf8c8SGerald Van Baren 416b55ae402SMarcel Ziswiler OF_CPU - The proper name of the cpus node (only required for 417b55ae402SMarcel Ziswiler MPC512X and MPC5xxx based boards). 418b55ae402SMarcel Ziswiler OF_SOC - The proper name of the soc node (only required for 419b55ae402SMarcel Ziswiler MPC512X and MPC5xxx based boards). 420f57f70aaSWolfgang Denk OF_TBCLK - The timebase frequency. 421c2871f03SKumar Gala OF_STDOUT_PATH - The path to the console device 422f57f70aaSWolfgang Denk 42311ccc33fSMarcel Ziswiler boards with QUICC Engines require OF_QE to set UCC MAC 42411ccc33fSMarcel Ziswiler addresses 4253bb342fcSKim Phillips 4264e253137SKumar Gala CONFIG_OF_BOARD_SETUP 4274e253137SKumar Gala 4284e253137SKumar Gala Board code has addition modification that it wants to make 4294e253137SKumar Gala to the flat device tree before handing it off to the kernel 4306705d81eSwdenk 4310267768eSMatthew McClintock CONFIG_OF_BOOT_CPU 4320267768eSMatthew McClintock 43311ccc33fSMarcel Ziswiler This define fills in the correct boot CPU in the boot 4340267768eSMatthew McClintock param header, the default value is zero if undefined. 4350267768eSMatthew McClintock 4363887c3fbSHeiko Schocher CONFIG_OF_IDE_FIXUP 4373887c3fbSHeiko Schocher 4383887c3fbSHeiko Schocher U-Boot can detect if an IDE device is present or not. 4393887c3fbSHeiko Schocher If not, and this new config option is activated, U-Boot 4403887c3fbSHeiko Schocher removes the ATA node from the DTS before booting Linux, 4413887c3fbSHeiko Schocher so the Linux IDE driver does not probe the device and 4423887c3fbSHeiko Schocher crash. This is needed for buggy hardware (uc101) where 4433887c3fbSHeiko Schocher no pull down resistor is connected to the signal IDE5V_DD7. 4443887c3fbSHeiko Schocher 4450b2f4ecaSNiklaus Giger- vxWorks boot parameters: 4460b2f4ecaSNiklaus Giger 4470b2f4ecaSNiklaus Giger bootvx constructs a valid bootline using the following 4480b2f4ecaSNiklaus Giger environments variables: bootfile, ipaddr, serverip, hostname. 4490b2f4ecaSNiklaus Giger It loads the vxWorks image pointed bootfile. 4500b2f4ecaSNiklaus Giger 4510b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name 4520b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address 4530b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server 4540b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters 4550b2f4ecaSNiklaus Giger 4560b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_ADD_PARAMS 4570b2f4ecaSNiklaus Giger 4580b2f4ecaSNiklaus Giger Add it at the end of the bootline. E.g "u=username pw=secret" 4590b2f4ecaSNiklaus Giger 4600b2f4ecaSNiklaus Giger Note: If a "bootargs" environment is defined, it will overwride 4610b2f4ecaSNiklaus Giger the defaults discussed just above. 4620b2f4ecaSNiklaus Giger 4632c451f78SAneesh V- Cache Configuration: 4642c451f78SAneesh V CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot 4652c451f78SAneesh V CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot 4662c451f78SAneesh V CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot 4672c451f78SAneesh V 468*93bc2193SAneesh V- Cache Configuration for ARM: 469*93bc2193SAneesh V CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache 470*93bc2193SAneesh V controller 471*93bc2193SAneesh V CONFIG_SYS_PL310_BASE - Physical base address of PL310 472*93bc2193SAneesh V controller register space 473*93bc2193SAneesh V 4746705d81eSwdenk- Serial Ports: 47548d0192fSAndreas Engel CONFIG_PL010_SERIAL 4766705d81eSwdenk 4776705d81eSwdenk Define this if you want support for Amba PrimeCell PL010 UARTs. 4786705d81eSwdenk 47948d0192fSAndreas Engel CONFIG_PL011_SERIAL 4806705d81eSwdenk 4816705d81eSwdenk Define this if you want support for Amba PrimeCell PL011 UARTs. 4826705d81eSwdenk 4836705d81eSwdenk CONFIG_PL011_CLOCK 4846705d81eSwdenk 4856705d81eSwdenk If you have Amba PrimeCell PL011 UARTs, set this variable to 4866705d81eSwdenk the clock speed of the UARTs. 4876705d81eSwdenk 4886705d81eSwdenk CONFIG_PL01x_PORTS 4896705d81eSwdenk 4906705d81eSwdenk If you have Amba PrimeCell PL010 or PL011 UARTs on your board, 4916705d81eSwdenk define this to a list of base addresses for each (supported) 4926705d81eSwdenk port. See e.g. include/configs/versatile.h 4936705d81eSwdenk 494910f1ae3SJohn Rigby CONFIG_PL011_SERIAL_RLCR 495910f1ae3SJohn Rigby 496910f1ae3SJohn Rigby Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500) 497910f1ae3SJohn Rigby have separate receive and transmit line control registers. Set 498910f1ae3SJohn Rigby this variable to initialize the extra register. 499910f1ae3SJohn Rigby 500910f1ae3SJohn Rigby CONFIG_PL011_SERIAL_FLUSH_ON_INIT 501910f1ae3SJohn Rigby 502910f1ae3SJohn Rigby On some platforms (e.g. U8500) U-Boot is loaded by a second stage 503910f1ae3SJohn Rigby boot loader that has already initialized the UART. Define this 504910f1ae3SJohn Rigby variable to flush the UART at init time. 505910f1ae3SJohn Rigby 5066705d81eSwdenk 507c609719bSwdenk- Console Interface: 508c609719bSwdenk Depending on board, define exactly one serial port 509c609719bSwdenk (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2, 510c609719bSwdenk CONFIG_8xx_CONS_SCC1, ...), or switch off the serial 511c609719bSwdenk console by defining CONFIG_8xx_CONS_NONE 512c609719bSwdenk 513c609719bSwdenk Note: if CONFIG_8xx_CONS_NONE is defined, the serial 514c609719bSwdenk port routines must be defined elsewhere 515c609719bSwdenk (i.e. serial_init(), serial_getc(), ...) 516c609719bSwdenk 517c609719bSwdenk CONFIG_CFB_CONSOLE 518c609719bSwdenk Enables console device for a color framebuffer. Needs following 519c609719bSwdenk defines (cf. smiLynxEM, i8042, board/eltec/bab7xx) 520c609719bSwdenk VIDEO_FB_LITTLE_ENDIAN graphic memory organisation 521c609719bSwdenk (default big endian) 522c609719bSwdenk VIDEO_HW_RECTFILL graphic chip supports 523c609719bSwdenk rectangle fill 524c609719bSwdenk (cf. smiLynxEM) 525c609719bSwdenk VIDEO_HW_BITBLT graphic chip supports 526c609719bSwdenk bit-blit (cf. smiLynxEM) 527c609719bSwdenk VIDEO_VISIBLE_COLS visible pixel columns 528c609719bSwdenk (cols=pitch) 529c609719bSwdenk VIDEO_VISIBLE_ROWS visible pixel rows 530c609719bSwdenk VIDEO_PIXEL_SIZE bytes per pixel 531c609719bSwdenk VIDEO_DATA_FORMAT graphic data format 532c609719bSwdenk (0-5, cf. cfb_console.c) 533c609719bSwdenk VIDEO_FB_ADRS framebuffer address 534c609719bSwdenk VIDEO_KBD_INIT_FCT keyboard int fct 535c609719bSwdenk (i.e. i8042_kbd_init()) 536c609719bSwdenk VIDEO_TSTC_FCT test char fct 537c609719bSwdenk (i.e. i8042_tstc) 538c609719bSwdenk VIDEO_GETC_FCT get char fct 539c609719bSwdenk (i.e. i8042_getc) 540c609719bSwdenk CONFIG_CONSOLE_CURSOR cursor drawing on/off 541c609719bSwdenk (requires blink timer 542c609719bSwdenk cf. i8042.c) 5436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c) 544c609719bSwdenk CONFIG_CONSOLE_TIME display time/date info in 545c609719bSwdenk upper right corner 546602ad3b3SJon Loeliger (requires CONFIG_CMD_DATE) 547c609719bSwdenk CONFIG_VIDEO_LOGO display Linux logo in 548c609719bSwdenk upper left corner 549a6c7ad2fSwdenk CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of 550a6c7ad2fSwdenk linux_logo.h for logo. 551a6c7ad2fSwdenk Requires CONFIG_VIDEO_LOGO 552c609719bSwdenk CONFIG_CONSOLE_EXTRA_INFO 55311ccc33fSMarcel Ziswiler additional board info beside 554c609719bSwdenk the logo 555c609719bSwdenk 556c609719bSwdenk When CONFIG_CFB_CONSOLE is defined, video console is 557c609719bSwdenk default i/o. Serial console can be forced with 558c609719bSwdenk environment 'console=serial'. 559c609719bSwdenk 560a3ad8e26Swdenk When CONFIG_SILENT_CONSOLE is defined, all console 561a3ad8e26Swdenk messages (by U-Boot and Linux!) can be silenced with 562a3ad8e26Swdenk the "silent" environment variable. See 563a3ad8e26Swdenk doc/README.silent for more information. 564a3ad8e26Swdenk 565c609719bSwdenk- Console Baudrate: 566c609719bSwdenk CONFIG_BAUDRATE - in bps 567c609719bSwdenk Select one of the baudrates listed in 5686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BAUDRATE_TABLE, see below. 5696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale 570c609719bSwdenk 571c92fac91SHeiko Schocher- Console Rx buffer length 572c92fac91SHeiko Schocher With CONFIG_SYS_SMC_RXBUFLEN it is possible to define 573c92fac91SHeiko Schocher the maximum receive buffer length for the SMC. 5742b3f12c2SHeiko Schocher This option is actual only for 82xx and 8xx possible. 575c92fac91SHeiko Schocher If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE 576c92fac91SHeiko Schocher must be defined, to setup the maximum idle timeout for 577c92fac91SHeiko Schocher the SMC. 578c92fac91SHeiko Schocher 579c609719bSwdenk- Boot Delay: CONFIG_BOOTDELAY - in seconds 580c609719bSwdenk Delay before automatically booting the default image; 581c609719bSwdenk set to -1 to disable autoboot. 582c609719bSwdenk 583c609719bSwdenk See doc/README.autoboot for these options that 584c609719bSwdenk work with CONFIG_BOOTDELAY. None are required. 585c609719bSwdenk CONFIG_BOOT_RETRY_TIME 586c609719bSwdenk CONFIG_BOOT_RETRY_MIN 587c609719bSwdenk CONFIG_AUTOBOOT_KEYED 588c609719bSwdenk CONFIG_AUTOBOOT_PROMPT 589c609719bSwdenk CONFIG_AUTOBOOT_DELAY_STR 590c609719bSwdenk CONFIG_AUTOBOOT_STOP_STR 591c609719bSwdenk CONFIG_AUTOBOOT_DELAY_STR2 592c609719bSwdenk CONFIG_AUTOBOOT_STOP_STR2 593c609719bSwdenk CONFIG_ZERO_BOOTDELAY_CHECK 594c609719bSwdenk CONFIG_RESET_TO_RETRY 595c609719bSwdenk 596c609719bSwdenk- Autoboot Command: 597c609719bSwdenk CONFIG_BOOTCOMMAND 598c609719bSwdenk Only needed when CONFIG_BOOTDELAY is enabled; 599c609719bSwdenk define a command string that is automatically executed 600c609719bSwdenk when no character is read on the console interface 601c609719bSwdenk within "Boot Delay" after reset. 602c609719bSwdenk 603c609719bSwdenk CONFIG_BOOTARGS 604c609719bSwdenk This can be used to pass arguments to the bootm 605c609719bSwdenk command. The value of CONFIG_BOOTARGS goes into the 606c609719bSwdenk environment value "bootargs". 607c609719bSwdenk 608c609719bSwdenk CONFIG_RAMBOOT and CONFIG_NFSBOOT 609c609719bSwdenk The value of these goes into the environment as 610c609719bSwdenk "ramboot" and "nfsboot" respectively, and can be used 611c609719bSwdenk as a convenience, when switching between booting from 61211ccc33fSMarcel Ziswiler RAM and NFS. 613c609719bSwdenk 614c609719bSwdenk- Pre-Boot Commands: 615c609719bSwdenk CONFIG_PREBOOT 616c609719bSwdenk 617c609719bSwdenk When this option is #defined, the existence of the 618c609719bSwdenk environment variable "preboot" will be checked 619c609719bSwdenk immediately before starting the CONFIG_BOOTDELAY 620c609719bSwdenk countdown and/or running the auto-boot command resp. 621c609719bSwdenk entering interactive mode. 622c609719bSwdenk 623c609719bSwdenk This feature is especially useful when "preboot" is 624c609719bSwdenk automatically generated or modified. For an example 625c609719bSwdenk see the LWMON board specific code: here "preboot" is 626c609719bSwdenk modified when the user holds down a certain 627c609719bSwdenk combination of keys on the (special) keyboard when 628c609719bSwdenk booting the systems 629c609719bSwdenk 630c609719bSwdenk- Serial Download Echo Mode: 631c609719bSwdenk CONFIG_LOADS_ECHO 632c609719bSwdenk If defined to 1, all characters received during a 633c609719bSwdenk serial download (using the "loads" command) are 634c609719bSwdenk echoed back. This might be needed by some terminal 635c609719bSwdenk emulations (like "cu"), but may as well just take 636c609719bSwdenk time on others. This setting #define's the initial 637c609719bSwdenk value of the "loads_echo" environment variable. 638c609719bSwdenk 639602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined) 640c609719bSwdenk CONFIG_KGDB_BAUDRATE 641c609719bSwdenk Select one of the baudrates listed in 6426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BAUDRATE_TABLE, see below. 643c609719bSwdenk 644c609719bSwdenk- Monitor Functions: 645602ad3b3SJon Loeliger Monitor commands can be included or excluded 646602ad3b3SJon Loeliger from the build by using the #include files 647602ad3b3SJon Loeliger "config_cmd_all.h" and #undef'ing unwanted 648602ad3b3SJon Loeliger commands, or using "config_cmd_default.h" 649602ad3b3SJon Loeliger and augmenting with additional #define's 650602ad3b3SJon Loeliger for wanted commands. 651c609719bSwdenk 652602ad3b3SJon Loeliger The default command configuration includes all commands 653602ad3b3SJon Loeliger except those marked below with a "*". 654602ad3b3SJon Loeliger 655602ad3b3SJon Loeliger CONFIG_CMD_ASKENV * ask for env variable 656602ad3b3SJon Loeliger CONFIG_CMD_BDI bdinfo 657602ad3b3SJon Loeliger CONFIG_CMD_BEDBUG * Include BedBug Debugger 658602ad3b3SJon Loeliger CONFIG_CMD_BMP * BMP support 659602ad3b3SJon Loeliger CONFIG_CMD_BSP * Board specific commands 660602ad3b3SJon Loeliger CONFIG_CMD_BOOTD bootd 661602ad3b3SJon Loeliger CONFIG_CMD_CACHE * icache, dcache 662602ad3b3SJon Loeliger CONFIG_CMD_CONSOLE coninfo 663710b9938SMike Frysinger CONFIG_CMD_CRC32 * crc32 664602ad3b3SJon Loeliger CONFIG_CMD_DATE * support for RTC, date/time... 665602ad3b3SJon Loeliger CONFIG_CMD_DHCP * DHCP support 666602ad3b3SJon Loeliger CONFIG_CMD_DIAG * Diagnostics 667a7c93104SPeter Tyser CONFIG_CMD_DS4510 * ds4510 I2C gpio commands 668a7c93104SPeter Tyser CONFIG_CMD_DS4510_INFO * ds4510 I2C info command 669a7c93104SPeter Tyser CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd 670a7c93104SPeter Tyser CONFIG_CMD_DS4510_RST * ds4510 I2C rst command 671602ad3b3SJon Loeliger CONFIG_CMD_DTT * Digital Therm and Thermostat 672602ad3b3SJon Loeliger CONFIG_CMD_ECHO echo arguments 673246c6922SPeter Tyser CONFIG_CMD_EDITENV edit env variable 674602ad3b3SJon Loeliger CONFIG_CMD_EEPROM * EEPROM read/write support 675602ad3b3SJon Loeliger CONFIG_CMD_ELF * bootelf, bootvx 6760c79cda0SMike Frysinger CONFIG_CMD_EXPORTENV * export the environment 677bdab39d3SMike Frysinger CONFIG_CMD_SAVEENV saveenv 678602ad3b3SJon Loeliger CONFIG_CMD_FDC * Floppy Disk Support 679602ad3b3SJon Loeliger CONFIG_CMD_FAT * FAT partition support 680602ad3b3SJon Loeliger CONFIG_CMD_FDOS * Dos diskette Support 681602ad3b3SJon Loeliger CONFIG_CMD_FLASH flinfo, erase, protect 682602ad3b3SJon Loeliger CONFIG_CMD_FPGA FPGA device initialization support 683a641b979SMike Frysinger CONFIG_CMD_GO * the 'go' command (exec code) 684a000b795SKim Phillips CONFIG_CMD_GREPENV * search environment 685602ad3b3SJon Loeliger CONFIG_CMD_HWFLOW * RTS/CTS hw flow control 686602ad3b3SJon Loeliger CONFIG_CMD_I2C * I2C serial bus support 687602ad3b3SJon Loeliger CONFIG_CMD_IDE * IDE harddisk support 688602ad3b3SJon Loeliger CONFIG_CMD_IMI iminfo 689602ad3b3SJon Loeliger CONFIG_CMD_IMLS List all found images 690602ad3b3SJon Loeliger CONFIG_CMD_IMMAP * IMMR dump support 6910c79cda0SMike Frysinger CONFIG_CMD_IMPORTENV * import an environment 692602ad3b3SJon Loeliger CONFIG_CMD_IRQ * irqinfo 693602ad3b3SJon Loeliger CONFIG_CMD_ITEST Integer/string test of 2 values 694602ad3b3SJon Loeliger CONFIG_CMD_JFFS2 * JFFS2 Support 695602ad3b3SJon Loeliger CONFIG_CMD_KGDB * kgdb 6961ba7fd25SMike Frysinger CONFIG_CMD_LDRINFO ldrinfo (display Blackfin loader) 697602ad3b3SJon Loeliger CONFIG_CMD_LOADB loadb 698602ad3b3SJon Loeliger CONFIG_CMD_LOADS loads 69902c9aa1dSRobin Getz CONFIG_CMD_MD5SUM print md5 message digest 70002c9aa1dSRobin Getz (requires CONFIG_CMD_MEMORY and CONFIG_MD5) 701602ad3b3SJon Loeliger CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base, 70256523f12Swdenk loop, loopw, mtest 703602ad3b3SJon Loeliger CONFIG_CMD_MISC Misc functions like sleep etc 704602ad3b3SJon Loeliger CONFIG_CMD_MMC * MMC memory mapped support 705602ad3b3SJon Loeliger CONFIG_CMD_MII * MII utility commands 70668d7d651SStefan Roese CONFIG_CMD_MTDPARTS * MTD partition support 707602ad3b3SJon Loeliger CONFIG_CMD_NAND * NAND support 708602ad3b3SJon Loeliger CONFIG_CMD_NET bootp, tftpboot, rarpboot 709e92739d3SPeter Tyser CONFIG_CMD_PCA953X * PCA953x I2C gpio commands 710e92739d3SPeter Tyser CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command 711602ad3b3SJon Loeliger CONFIG_CMD_PCI * pciinfo 712602ad3b3SJon Loeliger CONFIG_CMD_PCMCIA * PCMCIA support 713602ad3b3SJon Loeliger CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network 714602ad3b3SJon Loeliger host 715602ad3b3SJon Loeliger CONFIG_CMD_PORTIO * Port I/O 716602ad3b3SJon Loeliger CONFIG_CMD_REGINFO * Register dump 717602ad3b3SJon Loeliger CONFIG_CMD_RUN run command in env variable 718602ad3b3SJon Loeliger CONFIG_CMD_SAVES * save S record dump 719602ad3b3SJon Loeliger CONFIG_CMD_SCSI * SCSI Support 720602ad3b3SJon Loeliger CONFIG_CMD_SDRAM * print SDRAM configuration information 721602ad3b3SJon Loeliger (requires CONFIG_CMD_I2C) 722602ad3b3SJon Loeliger CONFIG_CMD_SETGETDCR Support for DCR Register access 723602ad3b3SJon Loeliger (4xx only) 724c6b1ee66SAlexander Holler CONFIG_CMD_SHA1SUM print sha1 memory digest 72502c9aa1dSRobin Getz (requires CONFIG_CMD_MEMORY) 72674de7aefSWolfgang Denk CONFIG_CMD_SOURCE "source" command Support 727602ad3b3SJon Loeliger CONFIG_CMD_SPI * SPI serial bus support 7287a83af07SLuca Ceresoli CONFIG_CMD_TFTPSRV * TFTP transfer in server mode 729602ad3b3SJon Loeliger CONFIG_CMD_USB * USB support 730602ad3b3SJon Loeliger CONFIG_CMD_CDP * Cisco Discover Protocol support 731602ad3b3SJon Loeliger CONFIG_CMD_FSL * Microblaze FSL support 732c609719bSwdenk 733c609719bSwdenk 734c609719bSwdenk EXAMPLE: If you want all functions except of network 735c609719bSwdenk support you can write: 736c609719bSwdenk 737602ad3b3SJon Loeliger #include "config_cmd_all.h" 738602ad3b3SJon Loeliger #undef CONFIG_CMD_NET 739c609719bSwdenk 740213bf8c8SGerald Van Baren Other Commands: 741213bf8c8SGerald Van Baren fdt (flattened device tree) command: CONFIG_OF_LIBFDT 742c609719bSwdenk 743c609719bSwdenk Note: Don't enable the "icache" and "dcache" commands 744602ad3b3SJon Loeliger (configuration option CONFIG_CMD_CACHE) unless you know 745c609719bSwdenk what you (and your U-Boot users) are doing. Data 746c609719bSwdenk cache cannot be enabled on systems like the 8xx or 747c609719bSwdenk 8260 (where accesses to the IMMR region must be 748c609719bSwdenk uncached), and it cannot be disabled on all other 749c609719bSwdenk systems where we (mis-) use the data cache to hold an 750c609719bSwdenk initial stack and some data. 751c609719bSwdenk 752c609719bSwdenk 753c609719bSwdenk XXX - this list needs to get updated! 754c609719bSwdenk 755c609719bSwdenk- Watchdog: 756c609719bSwdenk CONFIG_WATCHDOG 757c609719bSwdenk If this variable is defined, it enables watchdog 7586abe6fb6SDetlev Zundel support for the SoC. There must be support in the SoC 7596abe6fb6SDetlev Zundel specific code for a watchdog. For the 8xx and 8260 7606abe6fb6SDetlev Zundel CPUs, the SIU Watchdog feature is enabled in the SYPCR 7616abe6fb6SDetlev Zundel register. When supported for a specific SoC is 7626abe6fb6SDetlev Zundel available, then no further board specific code should 7636abe6fb6SDetlev Zundel be needed to use it. 7646abe6fb6SDetlev Zundel 7656abe6fb6SDetlev Zundel CONFIG_HW_WATCHDOG 7666abe6fb6SDetlev Zundel When using a watchdog circuitry external to the used 7676abe6fb6SDetlev Zundel SoC, then define this variable and provide board 7686abe6fb6SDetlev Zundel specific code for the "hw_watchdog_reset" function. 769c609719bSwdenk 770c1551ea8Sstroese- U-Boot Version: 771c1551ea8Sstroese CONFIG_VERSION_VARIABLE 772c1551ea8Sstroese If this variable is defined, an environment variable 773c1551ea8Sstroese named "ver" is created by U-Boot showing the U-Boot 774c1551ea8Sstroese version as printed by the "version" command. 775c1551ea8Sstroese This variable is readonly. 776c1551ea8Sstroese 777c609719bSwdenk- Real-Time Clock: 778c609719bSwdenk 779602ad3b3SJon Loeliger When CONFIG_CMD_DATE is selected, the type of the RTC 780c609719bSwdenk has to be selected, too. Define exactly one of the 781c609719bSwdenk following options: 782c609719bSwdenk 783c609719bSwdenk CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx 784c609719bSwdenk CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC 7857ce63709SGuennadi Liakhovetski CONFIG_RTC_MC13783 - use MC13783 RTC 786c609719bSwdenk CONFIG_RTC_MC146818 - use MC146818 RTC 7871cb8e980Swdenk CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC 788c609719bSwdenk CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC 7897f70e853Swdenk CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC 7903bac3513Swdenk CONFIG_RTC_DS164x - use Dallas DS164x RTC 7919536dfccSTor Krill CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC 7924c0d4c3bSwdenk CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC 7936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337 79471d19f30SHeiko Schocher CONFIG_SYS_RV3029_TCR - enable trickle charger on 79571d19f30SHeiko Schocher RV3029 RTC. 796c609719bSwdenk 797b37c7e5eSwdenk Note that if the RTC uses I2C, then the I2C interface 798b37c7e5eSwdenk must also be configured. See I2C Support, below. 799b37c7e5eSwdenk 800e92739d3SPeter Tyser- GPIO Support: 801e92739d3SPeter Tyser CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO 802e92739d3SPeter Tyser CONFIG_PCA953X_INFO - enable pca953x info command 803e92739d3SPeter Tyser 8045dec49caSChris Packham The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of 8055dec49caSChris Packham chip-ngpio pairs that tell the PCA953X driver the number of 8065dec49caSChris Packham pins supported by a particular chip. 8075dec49caSChris Packham 808e92739d3SPeter Tyser Note that if the GPIO device uses I2C, then the I2C interface 809e92739d3SPeter Tyser must also be configured. See I2C Support, below. 810e92739d3SPeter Tyser 811c609719bSwdenk- Timestamp Support: 812c609719bSwdenk 813c609719bSwdenk When CONFIG_TIMESTAMP is selected, the timestamp 814c609719bSwdenk (date and time) of an image is printed by image 815c609719bSwdenk commands like bootm or iminfo. This option is 816602ad3b3SJon Loeliger automatically enabled when you select CONFIG_CMD_DATE . 817c609719bSwdenk 818c609719bSwdenk- Partition Support: 819c609719bSwdenk CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION 82007f3d789Srichardretanubun and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION 821c609719bSwdenk 822602ad3b3SJon Loeliger If IDE or SCSI support is enabled (CONFIG_CMD_IDE or 823218ca724SWolfgang Denk CONFIG_CMD_SCSI) you must configure support for at 824218ca724SWolfgang Denk least one partition type as well. 825c609719bSwdenk 826c609719bSwdenk- IDE Reset method: 8274d13cbadSwdenk CONFIG_IDE_RESET_ROUTINE - this is defined in several 8284d13cbadSwdenk board configurations files but used nowhere! 829c609719bSwdenk 8304d13cbadSwdenk CONFIG_IDE_RESET - is this is defined, IDE Reset will 8314d13cbadSwdenk be performed by calling the function 8324d13cbadSwdenk ide_set_reset(int reset) 8334d13cbadSwdenk which has to be defined in a board specific file 834c609719bSwdenk 835c609719bSwdenk- ATAPI Support: 836c609719bSwdenk CONFIG_ATAPI 837c609719bSwdenk 838c609719bSwdenk Set this to enable ATAPI support. 839c609719bSwdenk 840c40b2956Swdenk- LBA48 Support 841c40b2956Swdenk CONFIG_LBA48 842c40b2956Swdenk 843c40b2956Swdenk Set this to enable support for disks larger than 137GB 8444b142febSHeiko Schocher Also look at CONFIG_SYS_64BIT_LBA. 845c40b2956Swdenk Whithout these , LBA48 support uses 32bit variables and will 'only' 846c40b2956Swdenk support disks up to 2.1TB. 847c40b2956Swdenk 8486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_64BIT_LBA: 849c40b2956Swdenk When enabled, makes the IDE subsystem use 64bit sector addresses. 850c40b2956Swdenk Default is 32bit. 851c40b2956Swdenk 852c609719bSwdenk- SCSI Support: 853c609719bSwdenk At the moment only there is only support for the 854c609719bSwdenk SYM53C8XX SCSI controller; define 855c609719bSwdenk CONFIG_SCSI_SYM53C8XX to enable it. 856c609719bSwdenk 8576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and 8586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID * 8596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the 860c609719bSwdenk maximum numbers of LUNs, SCSI ID's and target 861c609719bSwdenk devices. 8626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz) 863c609719bSwdenk 864c609719bSwdenk- NETWORK Support (PCI): 865682011ffSwdenk CONFIG_E1000 866682011ffSwdenk Support for Intel 8254x gigabit chips. 867682011ffSwdenk 868ac3315c2SAndre Schwarz CONFIG_E1000_FALLBACK_MAC 86911ccc33fSMarcel Ziswiler default MAC for empty EEPROM after production. 870ac3315c2SAndre Schwarz 871c609719bSwdenk CONFIG_EEPRO100 872c609719bSwdenk Support for Intel 82557/82559/82559ER chips. 87311ccc33fSMarcel Ziswiler Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM 874c609719bSwdenk write routine for first time initialisation. 875c609719bSwdenk 876c609719bSwdenk CONFIG_TULIP 877c609719bSwdenk Support for Digital 2114x chips. 878c609719bSwdenk Optional CONFIG_TULIP_SELECT_MEDIA for board specific 879c609719bSwdenk modem chip initialisation (KS8761/QS6611). 880c609719bSwdenk 881c609719bSwdenk CONFIG_NATSEMI 882c609719bSwdenk Support for National dp83815 chips. 883c609719bSwdenk 884c609719bSwdenk CONFIG_NS8382X 885c609719bSwdenk Support for National dp8382[01] gigabit chips. 886c609719bSwdenk 88745219c46Swdenk- NETWORK Support (other): 88845219c46Swdenk 889c041e9d2SJens Scharsig CONFIG_DRIVER_AT91EMAC 890c041e9d2SJens Scharsig Support for AT91RM9200 EMAC. 891c041e9d2SJens Scharsig 892c041e9d2SJens Scharsig CONFIG_RMII 893c041e9d2SJens Scharsig Define this to use reduced MII inteface 894c041e9d2SJens Scharsig 895c041e9d2SJens Scharsig CONFIG_DRIVER_AT91EMAC_QUIET 896c041e9d2SJens Scharsig If this defined, the driver is quiet. 897c041e9d2SJens Scharsig The driver doen't show link status messages. 898c041e9d2SJens Scharsig 89945219c46Swdenk CONFIG_DRIVER_LAN91C96 90045219c46Swdenk Support for SMSC's LAN91C96 chips. 90145219c46Swdenk 90245219c46Swdenk CONFIG_LAN91C96_BASE 90345219c46Swdenk Define this to hold the physical address 90445219c46Swdenk of the LAN91C96's I/O space 90545219c46Swdenk 90645219c46Swdenk CONFIG_LAN91C96_USE_32_BIT 90745219c46Swdenk Define this to enable 32 bit addressing 90845219c46Swdenk 909f39748aeSwdenk CONFIG_DRIVER_SMC91111 910f39748aeSwdenk Support for SMSC's LAN91C111 chip 911f39748aeSwdenk 912f39748aeSwdenk CONFIG_SMC91111_BASE 913f39748aeSwdenk Define this to hold the physical address 914f39748aeSwdenk of the device (I/O space) 915f39748aeSwdenk 916f39748aeSwdenk CONFIG_SMC_USE_32_BIT 917f39748aeSwdenk Define this if data bus is 32 bits 918f39748aeSwdenk 919f39748aeSwdenk CONFIG_SMC_USE_IOFUNCS 920f39748aeSwdenk Define this to use i/o functions instead of macros 921f39748aeSwdenk (some hardware wont work with macros) 922f39748aeSwdenk 923b3dbf4a5SMacpaul Lin CONFIG_FTGMAC100 924b3dbf4a5SMacpaul Lin Support for Faraday's FTGMAC100 Gigabit SoC Ethernet 925b3dbf4a5SMacpaul Lin 926b3dbf4a5SMacpaul Lin CONFIG_FTGMAC100_EGIGA 927b3dbf4a5SMacpaul Lin Define this to use GE link update with gigabit PHY. 928b3dbf4a5SMacpaul Lin Define this if FTGMAC100 is connected to gigabit PHY. 929b3dbf4a5SMacpaul Lin If your system has 10/100 PHY only, it might not occur 930b3dbf4a5SMacpaul Lin wrong behavior. Because PHY usually return timeout or 931b3dbf4a5SMacpaul Lin useless data when polling gigabit status and gigabit 932b3dbf4a5SMacpaul Lin control registers. This behavior won't affect the 933b3dbf4a5SMacpaul Lin correctnessof 10/100 link speed update. 934b3dbf4a5SMacpaul Lin 935c2fff331SMike Rapoport CONFIG_SMC911X 936557b377dSJens Gehrlein Support for SMSC's LAN911x and LAN921x chips 937557b377dSJens Gehrlein 938c2fff331SMike Rapoport CONFIG_SMC911X_BASE 939557b377dSJens Gehrlein Define this to hold the physical address 940557b377dSJens Gehrlein of the device (I/O space) 941557b377dSJens Gehrlein 942c2fff331SMike Rapoport CONFIG_SMC911X_32_BIT 943557b377dSJens Gehrlein Define this if data bus is 32 bits 944557b377dSJens Gehrlein 945c2fff331SMike Rapoport CONFIG_SMC911X_16_BIT 946557b377dSJens Gehrlein Define this if data bus is 16 bits. If your processor 947557b377dSJens Gehrlein automatically converts one 32 bit word to two 16 bit 948c2fff331SMike Rapoport words you may also try CONFIG_SMC911X_32_BIT. 949557b377dSJens Gehrlein 9503d0075faSYoshihiro Shimoda CONFIG_SH_ETHER 9513d0075faSYoshihiro Shimoda Support for Renesas on-chip Ethernet controller 9523d0075faSYoshihiro Shimoda 9533d0075faSYoshihiro Shimoda CONFIG_SH_ETHER_USE_PORT 9543d0075faSYoshihiro Shimoda Define the number of ports to be used 9553d0075faSYoshihiro Shimoda 9563d0075faSYoshihiro Shimoda CONFIG_SH_ETHER_PHY_ADDR 9573d0075faSYoshihiro Shimoda Define the ETH PHY's address 9583d0075faSYoshihiro Shimoda 95968260aabSYoshihiro Shimoda CONFIG_SH_ETHER_CACHE_WRITEBACK 96068260aabSYoshihiro Shimoda If this option is set, the driver enables cache flush. 96168260aabSYoshihiro Shimoda 962c609719bSwdenk- USB Support: 963c609719bSwdenk At the moment only the UHCI host controller is 9644d13cbadSwdenk supported (PIP405, MIP405, MPC5200); define 965c609719bSwdenk CONFIG_USB_UHCI to enable it. 966c609719bSwdenk define CONFIG_USB_KEYBOARD to enable the USB Keyboard 96730d56faeSwdenk and define CONFIG_USB_STORAGE to enable the USB 968c609719bSwdenk storage devices. 969c609719bSwdenk Note: 970c609719bSwdenk Supported are USB Keyboards and USB Floppy drives 971c609719bSwdenk (TEAC FD-05PUB). 9724d13cbadSwdenk MPC5200 USB requires additional defines: 9734d13cbadSwdenk CONFIG_USB_CLOCK 9744d13cbadSwdenk for 528 MHz Clock: 0x0001bbbb 975307ecb6dSEric Millbrandt CONFIG_PSC3_USB 976307ecb6dSEric Millbrandt for USB on PSC3 9774d13cbadSwdenk CONFIG_USB_CONFIG 9784d13cbadSwdenk for differential drivers: 0x00001000 9794d13cbadSwdenk for single ended drivers: 0x00005000 980307ecb6dSEric Millbrandt for differential drivers on PSC3: 0x00000100 981307ecb6dSEric Millbrandt for single ended drivers on PSC3: 0x00004100 9826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_USB_EVENT_POLL 983fdcfaa1bSZhang Wei May be defined to allow interrupt polling 984fdcfaa1bSZhang Wei instead of using asynchronous interrupts 9854d13cbadSwdenk 98616c8d5e7SWolfgang Denk- USB Device: 98716c8d5e7SWolfgang Denk Define the below if you wish to use the USB console. 98816c8d5e7SWolfgang Denk Once firmware is rebuilt from a serial console issue the 98916c8d5e7SWolfgang Denk command "setenv stdin usbtty; setenv stdout usbtty" and 99011ccc33fSMarcel Ziswiler attach your USB cable. The Unix command "dmesg" should print 99116c8d5e7SWolfgang Denk it has found a new device. The environment variable usbtty 99216c8d5e7SWolfgang Denk can be set to gserial or cdc_acm to enable your device to 99316c8d5e7SWolfgang Denk appear to a USB host as a Linux gserial device or a 99416c8d5e7SWolfgang Denk Common Device Class Abstract Control Model serial device. 99516c8d5e7SWolfgang Denk If you select usbtty = gserial you should be able to enumerate 99616c8d5e7SWolfgang Denk a Linux host by 99716c8d5e7SWolfgang Denk # modprobe usbserial vendor=0xVendorID product=0xProductID 99816c8d5e7SWolfgang Denk else if using cdc_acm, simply setting the environment 99916c8d5e7SWolfgang Denk variable usbtty to be cdc_acm should suffice. The following 100016c8d5e7SWolfgang Denk might be defined in YourBoardName.h 100116c8d5e7SWolfgang Denk 100216c8d5e7SWolfgang Denk CONFIG_USB_DEVICE 100316c8d5e7SWolfgang Denk Define this to build a UDC device 100416c8d5e7SWolfgang Denk 100516c8d5e7SWolfgang Denk CONFIG_USB_TTY 100616c8d5e7SWolfgang Denk Define this to have a tty type of device available to 100716c8d5e7SWolfgang Denk talk to the UDC device 100816c8d5e7SWolfgang Denk 10096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_CONSOLE_IS_IN_ENV 101016c8d5e7SWolfgang Denk Define this if you want stdin, stdout &/or stderr to 101116c8d5e7SWolfgang Denk be set to usbtty. 101216c8d5e7SWolfgang Denk 101316c8d5e7SWolfgang Denk mpc8xx: 10146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_USB_EXTC_CLK 0xBLAH 101516c8d5e7SWolfgang Denk Derive USB clock from external clock "blah" 10166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_USB_EXTC_CLK 0x02 101716c8d5e7SWolfgang Denk 10186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_USB_BRG_CLK 0xBLAH 101916c8d5e7SWolfgang Denk Derive USB clock from brgclk 10206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_USB_BRG_CLK 0x04 102116c8d5e7SWolfgang Denk 102216c8d5e7SWolfgang Denk If you have a USB-IF assigned VendorID then you may wish to 102316c8d5e7SWolfgang Denk define your own vendor specific values either in BoardName.h 102416c8d5e7SWolfgang Denk or directly in usbd_vendor_info.h. If you don't define 102516c8d5e7SWolfgang Denk CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME, 102616c8d5e7SWolfgang Denk CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot 102716c8d5e7SWolfgang Denk should pretend to be a Linux device to it's target host. 102816c8d5e7SWolfgang Denk 102916c8d5e7SWolfgang Denk CONFIG_USBD_MANUFACTURER 103016c8d5e7SWolfgang Denk Define this string as the name of your company for 103116c8d5e7SWolfgang Denk - CONFIG_USBD_MANUFACTURER "my company" 103216c8d5e7SWolfgang Denk 103316c8d5e7SWolfgang Denk CONFIG_USBD_PRODUCT_NAME 103416c8d5e7SWolfgang Denk Define this string as the name of your product 103516c8d5e7SWolfgang Denk - CONFIG_USBD_PRODUCT_NAME "acme usb device" 103616c8d5e7SWolfgang Denk 103716c8d5e7SWolfgang Denk CONFIG_USBD_VENDORID 103816c8d5e7SWolfgang Denk Define this as your assigned Vendor ID from the USB 103916c8d5e7SWolfgang Denk Implementors Forum. This *must* be a genuine Vendor ID 104016c8d5e7SWolfgang Denk to avoid polluting the USB namespace. 104116c8d5e7SWolfgang Denk - CONFIG_USBD_VENDORID 0xFFFF 104216c8d5e7SWolfgang Denk 104316c8d5e7SWolfgang Denk CONFIG_USBD_PRODUCTID 104416c8d5e7SWolfgang Denk Define this as the unique Product ID 104516c8d5e7SWolfgang Denk for your device 104616c8d5e7SWolfgang Denk - CONFIG_USBD_PRODUCTID 0xFFFF 1047c609719bSwdenk 1048c609719bSwdenk 1049c609719bSwdenk- MMC Support: 1050c609719bSwdenk The MMC controller on the Intel PXA is supported. To 1051c609719bSwdenk enable this define CONFIG_MMC. The MMC can be 1052c609719bSwdenk accessed from the boot prompt by mapping the device 1053c609719bSwdenk to physical memory similar to flash. Command line is 1054602ad3b3SJon Loeliger enabled with CONFIG_CMD_MMC. The MMC driver also works with 1055602ad3b3SJon Loeliger the FAT fs. This is enabled with CONFIG_CMD_FAT. 1056c609719bSwdenk 10576705d81eSwdenk- Journaling Flash filesystem support: 10586705d81eSwdenk CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE, 10596705d81eSwdenk CONFIG_JFFS2_NAND_DEV 10606705d81eSwdenk Define these for a default partition on a NAND device 10616705d81eSwdenk 10626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS2_FIRST_SECTOR, 10636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS 10646705d81eSwdenk Define these for a default partition on a NOR device 10656705d81eSwdenk 10666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS_CUSTOM_PART 10676705d81eSwdenk Define this to create an own partition. You have to provide a 10686705d81eSwdenk function struct part_info* jffs2_part_info(int part_num) 10696705d81eSwdenk 10706705d81eSwdenk If you define only one JFFS2 partition you may also want to 10716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_JFFS_SINGLE_PART 1 10726705d81eSwdenk to disable the command chpart. This is the default when you 10736705d81eSwdenk have not defined a custom partition 10746705d81eSwdenk 1075c609719bSwdenk- Keyboard Support: 1076c609719bSwdenk CONFIG_ISA_KEYBOARD 1077c609719bSwdenk 1078c609719bSwdenk Define this to enable standard (PC-Style) keyboard 1079c609719bSwdenk support 1080c609719bSwdenk 1081c609719bSwdenk CONFIG_I8042_KBD 1082c609719bSwdenk Standard PC keyboard driver with US (is default) and 1083c609719bSwdenk GERMAN key layout (switch via environment 'keymap=de') support. 1084c609719bSwdenk Export function i8042_kbd_init, i8042_tstc and i8042_getc 1085c609719bSwdenk for cfb_console. Supports cursor blinking. 1086c609719bSwdenk 1087c609719bSwdenk- Video support: 1088c609719bSwdenk CONFIG_VIDEO 1089c609719bSwdenk 1090c609719bSwdenk Define this to enable video support (for output to 1091c609719bSwdenk video). 1092c609719bSwdenk 1093c609719bSwdenk CONFIG_VIDEO_CT69000 1094c609719bSwdenk 1095c609719bSwdenk Enable Chips & Technologies 69000 Video chip 1096c609719bSwdenk 1097c609719bSwdenk CONFIG_VIDEO_SMI_LYNXEM 1098eeb1b77bSwdenk Enable Silicon Motion SMI 712/710/810 Video chip. The 1099eeb1b77bSwdenk video output is selected via environment 'videoout' 1100eeb1b77bSwdenk (1 = LCD and 2 = CRT). If videoout is undefined, CRT is 1101eeb1b77bSwdenk assumed. 1102c609719bSwdenk 1103eeb1b77bSwdenk For the CT69000 and SMI_LYNXEM drivers, videomode is 110411ccc33fSMarcel Ziswiler selected via environment 'videomode'. Two different ways 1105eeb1b77bSwdenk are possible: 1106eeb1b77bSwdenk - "videomode=num" 'num' is a standard LiLo mode numbers. 1107eeb1b77bSwdenk Following standard modes are supported (* is default): 1108eeb1b77bSwdenk 1109eeb1b77bSwdenk Colors 640x480 800x600 1024x768 1152x864 1280x1024 1110eeb1b77bSwdenk -------------+--------------------------------------------- 1111eeb1b77bSwdenk 8 bits | 0x301* 0x303 0x305 0x161 0x307 1112eeb1b77bSwdenk 15 bits | 0x310 0x313 0x316 0x162 0x319 1113eeb1b77bSwdenk 16 bits | 0x311 0x314 0x317 0x163 0x31A 1114eeb1b77bSwdenk 24 bits | 0x312 0x315 0x318 ? 0x31B 1115eeb1b77bSwdenk -------------+--------------------------------------------- 1116c609719bSwdenk (i.e. setenv videomode 317; saveenv; reset;) 1117c609719bSwdenk 1118eeb1b77bSwdenk - "videomode=bootargs" all the video parameters are parsed 11197817cb20SMarcel Ziswiler from the bootargs. (See drivers/video/videomodes.c) 1120eeb1b77bSwdenk 1121eeb1b77bSwdenk 1122a6c7ad2fSwdenk CONFIG_VIDEO_SED13806 1123a6c7ad2fSwdenk Enable Epson SED13806 driver. This driver supports 8bpp 1124a6c7ad2fSwdenk and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP 1125a6c7ad2fSwdenk or CONFIG_VIDEO_SED13806_16BPP 1126a6c7ad2fSwdenk 11277d3053fbSTimur Tabi CONFIG_FSL_DIU_FB 11287d3053fbSTimur Tabi Enable the Freescale DIU video driver. Reference boards for 11297d3053fbSTimur Tabi SOCs that have a DIU should define this macro to enable DIU 11307d3053fbSTimur Tabi support, and should also define these other macros: 11317d3053fbSTimur Tabi 11327d3053fbSTimur Tabi CONFIG_SYS_DIU_ADDR 11337d3053fbSTimur Tabi CONFIG_VIDEO 11347d3053fbSTimur Tabi CONFIG_CMD_BMP 11357d3053fbSTimur Tabi CONFIG_CFB_CONSOLE 11367d3053fbSTimur Tabi CONFIG_VIDEO_SW_CURSOR 11377d3053fbSTimur Tabi CONFIG_VGA_AS_SINGLE_DEVICE 11387d3053fbSTimur Tabi CONFIG_VIDEO_LOGO 11397d3053fbSTimur Tabi CONFIG_VIDEO_BMP_LOGO 11407d3053fbSTimur Tabi 1141ba8e76bdSTimur Tabi The DIU driver will look for the 'video-mode' environment 1142ba8e76bdSTimur Tabi variable, and if defined, enable the DIU as a console during 1143ba8e76bdSTimur Tabi boot. See the documentation file README.video for a 1144ba8e76bdSTimur Tabi description of this variable. 11457d3053fbSTimur Tabi 1146682011ffSwdenk- Keyboard Support: 1147682011ffSwdenk CONFIG_KEYBOARD 1148682011ffSwdenk 1149682011ffSwdenk Define this to enable a custom keyboard support. 1150682011ffSwdenk This simply calls drv_keyboard_init() which must be 1151682011ffSwdenk defined in your board-specific files. 1152682011ffSwdenk The only board using this so far is RBC823. 1153a6c7ad2fSwdenk 1154c609719bSwdenk- LCD Support: CONFIG_LCD 1155c609719bSwdenk 1156c609719bSwdenk Define this to enable LCD support (for output to LCD 1157c609719bSwdenk display); also select one of the supported displays 1158c609719bSwdenk by defining one of these: 1159c609719bSwdenk 116039cf4804SStelian Pop CONFIG_ATMEL_LCD: 116139cf4804SStelian Pop 116239cf4804SStelian Pop HITACHI TX09D70VM1CCA, 3.5", 240x320. 116339cf4804SStelian Pop 1164fd3103bbSwdenk CONFIG_NEC_NL6448AC33: 1165c609719bSwdenk 1166fd3103bbSwdenk NEC NL6448AC33-18. Active, color, single scan. 1167c609719bSwdenk 1168fd3103bbSwdenk CONFIG_NEC_NL6448BC20 1169c609719bSwdenk 1170fd3103bbSwdenk NEC NL6448BC20-08. 6.5", 640x480. 1171fd3103bbSwdenk Active, color, single scan. 1172fd3103bbSwdenk 1173fd3103bbSwdenk CONFIG_NEC_NL6448BC33_54 1174fd3103bbSwdenk 1175fd3103bbSwdenk NEC NL6448BC33-54. 10.4", 640x480. 1176c609719bSwdenk Active, color, single scan. 1177c609719bSwdenk 1178c609719bSwdenk CONFIG_SHARP_16x9 1179c609719bSwdenk 1180c609719bSwdenk Sharp 320x240. Active, color, single scan. 1181c609719bSwdenk It isn't 16x9, and I am not sure what it is. 1182c609719bSwdenk 1183c609719bSwdenk CONFIG_SHARP_LQ64D341 1184c609719bSwdenk 1185c609719bSwdenk Sharp LQ64D341 display, 640x480. 1186c609719bSwdenk Active, color, single scan. 1187c609719bSwdenk 1188c609719bSwdenk CONFIG_HLD1045 1189c609719bSwdenk 1190c609719bSwdenk HLD1045 display, 640x480. 1191c609719bSwdenk Active, color, single scan. 1192c609719bSwdenk 1193c609719bSwdenk CONFIG_OPTREX_BW 1194c609719bSwdenk 1195c609719bSwdenk Optrex CBL50840-2 NF-FW 99 22 M5 1196c609719bSwdenk or 1197c609719bSwdenk Hitachi LMG6912RPFC-00T 1198c609719bSwdenk or 1199c609719bSwdenk Hitachi SP14Q002 1200c609719bSwdenk 1201c609719bSwdenk 320x240. Black & white. 1202c609719bSwdenk 1203c609719bSwdenk Normally display is black on white background; define 12046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_WHITE_ON_BLACK to get it inverted. 1205c609719bSwdenk 12067152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN 1207d791b1dcSwdenk 1208d791b1dcSwdenk If this option is set, the environment is checked for 1209d791b1dcSwdenk a variable "splashimage". If found, the usual display 1210d791b1dcSwdenk of logo, copyright and system information on the LCD 1211e94d2cd9Swdenk is suppressed and the BMP image at the address 1212d791b1dcSwdenk specified in "splashimage" is loaded instead. The 1213d791b1dcSwdenk console is redirected to the "nulldev", too. This 1214d791b1dcSwdenk allows for a "silent" boot where a splash screen is 1215d791b1dcSwdenk loaded very quickly after power-on. 1216d791b1dcSwdenk 12171ca298ceSMatthias Weisser CONFIG_SPLASH_SCREEN_ALIGN 12181ca298ceSMatthias Weisser 12191ca298ceSMatthias Weisser If this option is set the splash image can be freely positioned 12201ca298ceSMatthias Weisser on the screen. Environment variable "splashpos" specifies the 12211ca298ceSMatthias Weisser position as "x,y". If a positive number is given it is used as 12221ca298ceSMatthias Weisser number of pixel from left/top. If a negative number is given it 12231ca298ceSMatthias Weisser is used as number of pixel from right/bottom. You can also 12241ca298ceSMatthias Weisser specify 'm' for centering the image. 12251ca298ceSMatthias Weisser 12261ca298ceSMatthias Weisser Example: 12271ca298ceSMatthias Weisser setenv splashpos m,m 12281ca298ceSMatthias Weisser => image at center of screen 12291ca298ceSMatthias Weisser 12301ca298ceSMatthias Weisser setenv splashpos 30,20 12311ca298ceSMatthias Weisser => image at x = 30 and y = 20 12321ca298ceSMatthias Weisser 12331ca298ceSMatthias Weisser setenv splashpos -10,m 12341ca298ceSMatthias Weisser => vertically centered image 12351ca298ceSMatthias Weisser at x = dspWidth - bmpWidth - 9 12361ca298ceSMatthias Weisser 123798f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP 123898f4a3dfSStefan Roese 123998f4a3dfSStefan Roese If this option is set, additionally to standard BMP 124098f4a3dfSStefan Roese images, gzipped BMP images can be displayed via the 124198f4a3dfSStefan Roese splashscreen support or the bmp command. 124298f4a3dfSStefan Roese 1243d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8 1244d5011762SAnatolij Gustschin 1245d5011762SAnatolij Gustschin If this option is set, 8-bit RLE compressed BMP images 1246d5011762SAnatolij Gustschin can be displayed via the splashscreen support or the 1247d5011762SAnatolij Gustschin bmp command. 1248d5011762SAnatolij Gustschin 1249c29fdfc1Swdenk- Compression support: 1250c29fdfc1Swdenk CONFIG_BZIP2 1251c29fdfc1Swdenk 1252c29fdfc1Swdenk If this option is set, support for bzip2 compressed 1253c29fdfc1Swdenk images is included. If not, only uncompressed and gzip 1254c29fdfc1Swdenk compressed images are supported. 1255c29fdfc1Swdenk 1256c29fdfc1Swdenk NOTE: the bzip2 algorithm requires a lot of RAM, so 12576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should 1258c29fdfc1Swdenk be at least 4MB. 1259d791b1dcSwdenk 1260fc9c1727SLuigi 'Comio' Mantellini CONFIG_LZMA 1261fc9c1727SLuigi 'Comio' Mantellini 1262fc9c1727SLuigi 'Comio' Mantellini If this option is set, support for lzma compressed 1263fc9c1727SLuigi 'Comio' Mantellini images is included. 1264fc9c1727SLuigi 'Comio' Mantellini 1265fc9c1727SLuigi 'Comio' Mantellini Note: The LZMA algorithm adds between 2 and 4KB of code and it 1266fc9c1727SLuigi 'Comio' Mantellini requires an amount of dynamic memory that is given by the 1267fc9c1727SLuigi 'Comio' Mantellini formula: 1268fc9c1727SLuigi 'Comio' Mantellini 1269fc9c1727SLuigi 'Comio' Mantellini (1846 + 768 << (lc + lp)) * sizeof(uint16) 1270fc9c1727SLuigi 'Comio' Mantellini 1271fc9c1727SLuigi 'Comio' Mantellini Where lc and lp stand for, respectively, Literal context bits 1272fc9c1727SLuigi 'Comio' Mantellini and Literal pos bits. 1273fc9c1727SLuigi 'Comio' Mantellini 1274fc9c1727SLuigi 'Comio' Mantellini This value is upper-bounded by 14MB in the worst case. Anyway, 1275fc9c1727SLuigi 'Comio' Mantellini for a ~4MB large kernel image, we have lc=3 and lp=0 for a 1276fc9c1727SLuigi 'Comio' Mantellini total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is 1277fc9c1727SLuigi 'Comio' Mantellini a very small buffer. 1278fc9c1727SLuigi 'Comio' Mantellini 1279fc9c1727SLuigi 'Comio' Mantellini Use the lzmainfo tool to determinate the lc and lp values and 1280fc9c1727SLuigi 'Comio' Mantellini then calculate the amount of needed dynamic memory (ensuring 12816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD the appropriate CONFIG_SYS_MALLOC_LEN value). 1282fc9c1727SLuigi 'Comio' Mantellini 128317ea1177Swdenk- MII/PHY support: 128417ea1177Swdenk CONFIG_PHY_ADDR 128517ea1177Swdenk 128617ea1177Swdenk The address of PHY on MII bus. 128717ea1177Swdenk 128817ea1177Swdenk CONFIG_PHY_CLOCK_FREQ (ppc4xx) 128917ea1177Swdenk 129017ea1177Swdenk The clock frequency of the MII bus 129117ea1177Swdenk 129217ea1177Swdenk CONFIG_PHY_GIGE 129317ea1177Swdenk 129417ea1177Swdenk If this option is set, support for speed/duplex 129511ccc33fSMarcel Ziswiler detection of gigabit PHY is included. 129617ea1177Swdenk 129717ea1177Swdenk CONFIG_PHY_RESET_DELAY 129817ea1177Swdenk 129917ea1177Swdenk Some PHY like Intel LXT971A need extra delay after 130017ea1177Swdenk reset before any MII register access is possible. 130117ea1177Swdenk For such PHY, set this option to the usec delay 130217ea1177Swdenk required. (minimum 300usec for LXT971A) 130317ea1177Swdenk 130417ea1177Swdenk CONFIG_PHY_CMD_DELAY (ppc4xx) 130517ea1177Swdenk 130617ea1177Swdenk Some PHY like Intel LXT971A need extra delay after 130717ea1177Swdenk command issued before MII status register can be read 130817ea1177Swdenk 1309c609719bSwdenk- Ethernet address: 1310c609719bSwdenk CONFIG_ETHADDR 1311c68a05feSrichardretanubun CONFIG_ETH1ADDR 1312c609719bSwdenk CONFIG_ETH2ADDR 1313c609719bSwdenk CONFIG_ETH3ADDR 1314c68a05feSrichardretanubun CONFIG_ETH4ADDR 1315c68a05feSrichardretanubun CONFIG_ETH5ADDR 1316c609719bSwdenk 131711ccc33fSMarcel Ziswiler Define a default value for Ethernet address to use 131811ccc33fSMarcel Ziswiler for the respective Ethernet interface, in case this 1319c609719bSwdenk is not determined automatically. 1320c609719bSwdenk 1321c609719bSwdenk- IP address: 1322c609719bSwdenk CONFIG_IPADDR 1323c609719bSwdenk 1324c609719bSwdenk Define a default value for the IP address to use for 132511ccc33fSMarcel Ziswiler the default Ethernet interface, in case this is not 1326c609719bSwdenk determined through e.g. bootp. 1327c609719bSwdenk 1328c609719bSwdenk- Server IP address: 1329c609719bSwdenk CONFIG_SERVERIP 1330c609719bSwdenk 1331c609719bSwdenk Defines a default value for the IP address of a TFTP 1332c609719bSwdenk server to contact when using the "tftboot" command. 1333c609719bSwdenk 133497cfe861SRobin Getz CONFIG_KEEP_SERVERADDR 133597cfe861SRobin Getz 133697cfe861SRobin Getz Keeps the server's MAC address, in the env 'serveraddr' 133797cfe861SRobin Getz for passing to bootargs (like Linux's netconsole option) 133897cfe861SRobin Getz 133953a5c424SDavid Updegraff- Multicast TFTP Mode: 134053a5c424SDavid Updegraff CONFIG_MCAST_TFTP 134153a5c424SDavid Updegraff 134253a5c424SDavid Updegraff Defines whether you want to support multicast TFTP as per 134353a5c424SDavid Updegraff rfc-2090; for example to work with atftp. Lets lots of targets 134411ccc33fSMarcel Ziswiler tftp down the same boot image concurrently. Note: the Ethernet 134553a5c424SDavid Updegraff driver in use must provide a function: mcast() to join/leave a 134653a5c424SDavid Updegraff multicast group. 134753a5c424SDavid Updegraff 1348c609719bSwdenk- BOOTP Recovery Mode: 1349c609719bSwdenk CONFIG_BOOTP_RANDOM_DELAY 1350c609719bSwdenk 1351c609719bSwdenk If you have many targets in a network that try to 1352c609719bSwdenk boot using BOOTP, you may want to avoid that all 1353c609719bSwdenk systems send out BOOTP requests at precisely the same 1354c609719bSwdenk moment (which would happen for instance at recovery 1355c609719bSwdenk from a power failure, when all systems will try to 1356c609719bSwdenk boot, thus flooding the BOOTP server. Defining 1357c609719bSwdenk CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be 1358c609719bSwdenk inserted before sending out BOOTP requests. The 13596c33c785SWolfgang Denk following delays are inserted then: 1360c609719bSwdenk 1361c609719bSwdenk 1st BOOTP request: delay 0 ... 1 sec 1362c609719bSwdenk 2nd BOOTP request: delay 0 ... 2 sec 1363c609719bSwdenk 3rd BOOTP request: delay 0 ... 4 sec 1364c609719bSwdenk 4th and following 1365c609719bSwdenk BOOTP requests: delay 0 ... 8 sec 1366c609719bSwdenk 1367fe389a82Sstroese- DHCP Advanced Options: 13681fe80d79SJon Loeliger You can fine tune the DHCP functionality by defining 13691fe80d79SJon Loeliger CONFIG_BOOTP_* symbols: 1370fe389a82Sstroese 13711fe80d79SJon Loeliger CONFIG_BOOTP_SUBNETMASK 13721fe80d79SJon Loeliger CONFIG_BOOTP_GATEWAY 13731fe80d79SJon Loeliger CONFIG_BOOTP_HOSTNAME 13741fe80d79SJon Loeliger CONFIG_BOOTP_NISDOMAIN 13751fe80d79SJon Loeliger CONFIG_BOOTP_BOOTPATH 13761fe80d79SJon Loeliger CONFIG_BOOTP_BOOTFILESIZE 13771fe80d79SJon Loeliger CONFIG_BOOTP_DNS 13781fe80d79SJon Loeliger CONFIG_BOOTP_DNS2 13791fe80d79SJon Loeliger CONFIG_BOOTP_SEND_HOSTNAME 13801fe80d79SJon Loeliger CONFIG_BOOTP_NTPSERVER 13811fe80d79SJon Loeliger CONFIG_BOOTP_TIMEOFFSET 13821fe80d79SJon Loeliger CONFIG_BOOTP_VENDOREX 1383fe389a82Sstroese 13845d110f0aSWilson Callan CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip 13855d110f0aSWilson Callan environment variable, not the BOOTP server. 1386fe389a82Sstroese 1387fe389a82Sstroese CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS 1388fe389a82Sstroese serverip from a DHCP server, it is possible that more 1389fe389a82Sstroese than one DNS serverip is offered to the client. 1390fe389a82Sstroese If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS 1391fe389a82Sstroese serverip will be stored in the additional environment 1392fe389a82Sstroese variable "dnsip2". The first DNS serverip is always 1393fe389a82Sstroese stored in the variable "dnsip", when CONFIG_BOOTP_DNS 13941fe80d79SJon Loeliger is defined. 1395fe389a82Sstroese 1396fe389a82Sstroese CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable 1397fe389a82Sstroese to do a dynamic update of a DNS server. To do this, they 1398fe389a82Sstroese need the hostname of the DHCP requester. 13995d110f0aSWilson Callan If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content 14001fe80d79SJon Loeliger of the "hostname" environment variable is passed as 14011fe80d79SJon Loeliger option 12 to the DHCP server. 1402fe389a82Sstroese 1403d9a2f416SAras Vaichas CONFIG_BOOTP_DHCP_REQUEST_DELAY 1404d9a2f416SAras Vaichas 1405d9a2f416SAras Vaichas A 32bit value in microseconds for a delay between 1406d9a2f416SAras Vaichas receiving a "DHCP Offer" and sending the "DHCP Request". 1407d9a2f416SAras Vaichas This fixes a problem with certain DHCP servers that don't 1408d9a2f416SAras Vaichas respond 100% of the time to a "DHCP request". E.g. On an 1409d9a2f416SAras Vaichas AT91RM9200 processor running at 180MHz, this delay needed 1410d9a2f416SAras Vaichas to be *at least* 15,000 usec before a Windows Server 2003 1411d9a2f416SAras Vaichas DHCP server would reply 100% of the time. I recommend at 1412d9a2f416SAras Vaichas least 50,000 usec to be safe. The alternative is to hope 1413d9a2f416SAras Vaichas that one of the retries will be successful but note that 1414d9a2f416SAras Vaichas the DHCP timeout and retry process takes a longer than 1415d9a2f416SAras Vaichas this delay. 1416d9a2f416SAras Vaichas 1417a3d991bdSwdenk - CDP Options: 1418a3d991bdSwdenk CONFIG_CDP_DEVICE_ID 1419a3d991bdSwdenk 1420a3d991bdSwdenk The device id used in CDP trigger frames. 1421a3d991bdSwdenk 1422a3d991bdSwdenk CONFIG_CDP_DEVICE_ID_PREFIX 1423a3d991bdSwdenk 1424a3d991bdSwdenk A two character string which is prefixed to the MAC address 1425a3d991bdSwdenk of the device. 1426a3d991bdSwdenk 1427a3d991bdSwdenk CONFIG_CDP_PORT_ID 1428a3d991bdSwdenk 1429a3d991bdSwdenk A printf format string which contains the ascii name of 1430a3d991bdSwdenk the port. Normally is set to "eth%d" which sets 143111ccc33fSMarcel Ziswiler eth0 for the first Ethernet, eth1 for the second etc. 1432a3d991bdSwdenk 1433a3d991bdSwdenk CONFIG_CDP_CAPABILITIES 1434a3d991bdSwdenk 1435a3d991bdSwdenk A 32bit integer which indicates the device capabilities; 1436a3d991bdSwdenk 0x00000010 for a normal host which does not forwards. 1437a3d991bdSwdenk 1438a3d991bdSwdenk CONFIG_CDP_VERSION 1439a3d991bdSwdenk 1440a3d991bdSwdenk An ascii string containing the version of the software. 1441a3d991bdSwdenk 1442a3d991bdSwdenk CONFIG_CDP_PLATFORM 1443a3d991bdSwdenk 1444a3d991bdSwdenk An ascii string containing the name of the platform. 1445a3d991bdSwdenk 1446a3d991bdSwdenk CONFIG_CDP_TRIGGER 1447a3d991bdSwdenk 1448a3d991bdSwdenk A 32bit integer sent on the trigger. 1449a3d991bdSwdenk 1450a3d991bdSwdenk CONFIG_CDP_POWER_CONSUMPTION 1451a3d991bdSwdenk 1452a3d991bdSwdenk A 16bit integer containing the power consumption of the 1453a3d991bdSwdenk device in .1 of milliwatts. 1454a3d991bdSwdenk 1455a3d991bdSwdenk CONFIG_CDP_APPLIANCE_VLAN_TYPE 1456a3d991bdSwdenk 1457a3d991bdSwdenk A byte containing the id of the VLAN. 1458a3d991bdSwdenk 1459c609719bSwdenk- Status LED: CONFIG_STATUS_LED 1460c609719bSwdenk 1461c609719bSwdenk Several configurations allow to display the current 1462c609719bSwdenk status using a LED. For instance, the LED will blink 1463c609719bSwdenk fast while running U-Boot code, stop blinking as 1464c609719bSwdenk soon as a reply to a BOOTP request was received, and 1465c609719bSwdenk start blinking slow once the Linux kernel is running 1466c609719bSwdenk (supported by a status LED driver in the Linux 1467c609719bSwdenk kernel). Defining CONFIG_STATUS_LED enables this 1468c609719bSwdenk feature in U-Boot. 1469c609719bSwdenk 1470c609719bSwdenk- CAN Support: CONFIG_CAN_DRIVER 1471c609719bSwdenk 1472c609719bSwdenk Defining CONFIG_CAN_DRIVER enables CAN driver support 1473c609719bSwdenk on those systems that support this (optional) 1474c609719bSwdenk feature, like the TQM8xxL modules. 1475c609719bSwdenk 1476c609719bSwdenk- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C 1477c609719bSwdenk 1478b37c7e5eSwdenk These enable I2C serial bus commands. Defining either of 1479b37c7e5eSwdenk (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will 148011ccc33fSMarcel Ziswiler include the appropriate I2C driver for the selected CPU. 1481c609719bSwdenk 1482b37c7e5eSwdenk This will allow you to use i2c commands at the u-boot 1483602ad3b3SJon Loeliger command line (as long as you set CONFIG_CMD_I2C in 1484b37c7e5eSwdenk CONFIG_COMMANDS) and communicate with i2c based realtime 1485b37c7e5eSwdenk clock chips. See common/cmd_i2c.c for a description of the 1486c609719bSwdenk command line interface. 1487c609719bSwdenk 1488bb99ad6dSBen Warren CONFIG_HARD_I2C selects a hardware I2C controller. 1489c609719bSwdenk 1490b37c7e5eSwdenk CONFIG_SOFT_I2C configures u-boot to use a software (aka 1491b37c7e5eSwdenk bit-banging) driver instead of CPM or similar hardware 1492b37c7e5eSwdenk support for I2C. 1493c609719bSwdenk 1494b37c7e5eSwdenk There are several other quantities that must also be 1495b37c7e5eSwdenk defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C. 1496c609719bSwdenk 14976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD In both cases you will need to define CONFIG_SYS_I2C_SPEED 1498b37c7e5eSwdenk to be the frequency (in Hz) at which you wish your i2c bus 14996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie 150011ccc33fSMarcel Ziswiler the CPU's i2c node address). 1501c609719bSwdenk 15028d321b81SPeter Tyser Now, the u-boot i2c code for the mpc8xx 1503a47a12beSStefan Roese (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node 15048d321b81SPeter Tyser and so its address should therefore be cleared to 0 (See, 15058d321b81SPeter Tyser eg, MPC823e User's Manual p.16-473). So, set 15068d321b81SPeter Tyser CONFIG_SYS_I2C_SLAVE to 0. 1507b37c7e5eSwdenk 15085da71efaSEric Millbrandt CONFIG_SYS_I2C_INIT_MPC5XXX 15095da71efaSEric Millbrandt 15105da71efaSEric Millbrandt When a board is reset during an i2c bus transfer 15115da71efaSEric Millbrandt chips might think that the current transfer is still 15125da71efaSEric Millbrandt in progress. Reset the slave devices by sending start 15135da71efaSEric Millbrandt commands until the slave device responds. 15145da71efaSEric Millbrandt 1515b37c7e5eSwdenk That's all that's required for CONFIG_HARD_I2C. 1516b37c7e5eSwdenk 1517b37c7e5eSwdenk If you use the software i2c interface (CONFIG_SOFT_I2C) 1518b37c7e5eSwdenk then the following macros need to be defined (examples are 1519b37c7e5eSwdenk from include/configs/lwmon.h): 1520c609719bSwdenk 1521c609719bSwdenk I2C_INIT 1522c609719bSwdenk 1523b37c7e5eSwdenk (Optional). Any commands necessary to enable the I2C 1524c609719bSwdenk controller or configure ports. 1525c609719bSwdenk 1526b37c7e5eSwdenk eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL) 1527b37c7e5eSwdenk 1528c609719bSwdenk I2C_PORT 1529c609719bSwdenk 1530c609719bSwdenk (Only for MPC8260 CPU). The I/O port to use (the code 1531c609719bSwdenk assumes both bits are on the same port). Valid values 1532c609719bSwdenk are 0..3 for ports A..D. 1533c609719bSwdenk 1534c609719bSwdenk I2C_ACTIVE 1535c609719bSwdenk 1536c609719bSwdenk The code necessary to make the I2C data line active 1537c609719bSwdenk (driven). If the data line is open collector, this 1538c609719bSwdenk define can be null. 1539c609719bSwdenk 1540b37c7e5eSwdenk eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA) 1541b37c7e5eSwdenk 1542c609719bSwdenk I2C_TRISTATE 1543c609719bSwdenk 1544c609719bSwdenk The code necessary to make the I2C data line tri-stated 1545c609719bSwdenk (inactive). If the data line is open collector, this 1546c609719bSwdenk define can be null. 1547c609719bSwdenk 1548b37c7e5eSwdenk eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA) 1549b37c7e5eSwdenk 1550c609719bSwdenk I2C_READ 1551c609719bSwdenk 1552c609719bSwdenk Code that returns TRUE if the I2C data line is high, 1553c609719bSwdenk FALSE if it is low. 1554c609719bSwdenk 1555b37c7e5eSwdenk eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0) 1556b37c7e5eSwdenk 1557c609719bSwdenk I2C_SDA(bit) 1558c609719bSwdenk 1559c609719bSwdenk If <bit> is TRUE, sets the I2C data line high. If it 1560c609719bSwdenk is FALSE, it clears it (low). 1561c609719bSwdenk 1562b37c7e5eSwdenk eg: #define I2C_SDA(bit) \ 1563b37c7e5eSwdenk if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \ 1564b37c7e5eSwdenk else immr->im_cpm.cp_pbdat &= ~PB_SDA 1565b37c7e5eSwdenk 1566c609719bSwdenk I2C_SCL(bit) 1567c609719bSwdenk 1568c609719bSwdenk If <bit> is TRUE, sets the I2C clock line high. If it 1569c609719bSwdenk is FALSE, it clears it (low). 1570c609719bSwdenk 1571b37c7e5eSwdenk eg: #define I2C_SCL(bit) \ 1572b37c7e5eSwdenk if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \ 1573b37c7e5eSwdenk else immr->im_cpm.cp_pbdat &= ~PB_SCL 1574b37c7e5eSwdenk 1575c609719bSwdenk I2C_DELAY 1576c609719bSwdenk 1577c609719bSwdenk This delay is invoked four times per clock cycle so this 1578c609719bSwdenk controls the rate of data transfer. The data rate thus 1579b37c7e5eSwdenk is 1 / (I2C_DELAY * 4). Often defined to be something 1580b37c7e5eSwdenk like: 1581b37c7e5eSwdenk 1582b37c7e5eSwdenk #define I2C_DELAY udelay(2) 1583c609719bSwdenk 1584793b5726SMike Frysinger CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA 1585793b5726SMike Frysinger 1586793b5726SMike Frysinger If your arch supports the generic GPIO framework (asm/gpio.h), 1587793b5726SMike Frysinger then you may alternatively define the two GPIOs that are to be 1588793b5726SMike Frysinger used as SCL / SDA. Any of the previous I2C_xxx macros will 1589793b5726SMike Frysinger have GPIO-based defaults assigned to them as appropriate. 1590793b5726SMike Frysinger 1591793b5726SMike Frysinger You should define these to the GPIO value as given directly to 1592793b5726SMike Frysinger the generic GPIO functions. 1593793b5726SMike Frysinger 15946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_INIT_BOARD 159547cd00faSwdenk 159647cd00faSwdenk When a board is reset during an i2c bus transfer 159747cd00faSwdenk chips might think that the current transfer is still 159847cd00faSwdenk in progress. On some boards it is possible to access 159947cd00faSwdenk the i2c SCLK line directly, either by using the 160047cd00faSwdenk processor pin as a GPIO or by having a second pin 160147cd00faSwdenk connected to the bus. If this option is defined a 160247cd00faSwdenk custom i2c_init_board() routine in boards/xxx/board.c 160347cd00faSwdenk is run early in the boot sequence. 160447cd00faSwdenk 160526a33504SRichard Retanubun CONFIG_SYS_I2C_BOARD_LATE_INIT 160626a33504SRichard Retanubun 160726a33504SRichard Retanubun An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is 160826a33504SRichard Retanubun defined a custom i2c_board_late_init() routine in 160926a33504SRichard Retanubun boards/xxx/board.c is run AFTER the operations in i2c_init() 161026a33504SRichard Retanubun is completed. This callpoint can be used to unreset i2c bus 161126a33504SRichard Retanubun using CPU i2c controller register accesses for CPUs whose i2c 161226a33504SRichard Retanubun controller provide such a method. It is called at the end of 161326a33504SRichard Retanubun i2c_init() to allow i2c_init operations to setup the i2c bus 161426a33504SRichard Retanubun controller on the CPU (e.g. setting bus speed & slave address). 161526a33504SRichard Retanubun 161617ea1177Swdenk CONFIG_I2CFAST (PPC405GP|PPC405EP only) 161717ea1177Swdenk 161817ea1177Swdenk This option enables configuration of bi_iic_fast[] flags 161917ea1177Swdenk in u-boot bd_info structure based on u-boot environment 162017ea1177Swdenk variable "i2cfast". (see also i2cfast) 162117ea1177Swdenk 1622bb99ad6dSBen Warren CONFIG_I2C_MULTI_BUS 1623bb99ad6dSBen Warren 1624bb99ad6dSBen Warren This option allows the use of multiple I2C buses, each of which 1625bb99ad6dSBen Warren must have a controller. At any point in time, only one bus is 1626bb99ad6dSBen Warren active. To switch to a different bus, use the 'i2c dev' command. 1627bb99ad6dSBen Warren Note that bus numbering is zero-based. 1628bb99ad6dSBen Warren 16296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_NOPROBES 1630bb99ad6dSBen Warren 1631bb99ad6dSBen Warren This option specifies a list of I2C devices that will be skipped 16320f89c54bSPeter Tyser when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS 16330f89c54bSPeter Tyser is set, specify a list of bus-device pairs. Otherwise, specify 16340f89c54bSPeter Tyser a 1D array of device addresses 1635bb99ad6dSBen Warren 1636bb99ad6dSBen Warren e.g. 1637bb99ad6dSBen Warren #undef CONFIG_I2C_MULTI_BUS 16386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68} 1639bb99ad6dSBen Warren 1640bb99ad6dSBen Warren will skip addresses 0x50 and 0x68 on a board with one I2C bus 1641bb99ad6dSBen Warren 1642bb99ad6dSBen Warren #define CONFIG_I2C_MULTI_BUS 16436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}} 1644bb99ad6dSBen Warren 1645bb99ad6dSBen Warren will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1 1646bb99ad6dSBen Warren 16476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SPD_BUS_NUM 1648be5e6181STimur Tabi 1649be5e6181STimur Tabi If defined, then this indicates the I2C bus number for DDR SPD. 1650be5e6181STimur Tabi If not defined, then U-Boot assumes that SPD is on I2C bus 0. 1651be5e6181STimur Tabi 16526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_RTC_BUS_NUM 16530dc018ecSStefan Roese 16540dc018ecSStefan Roese If defined, then this indicates the I2C bus number for the RTC. 16550dc018ecSStefan Roese If not defined, then U-Boot assumes that RTC is on I2C bus 0. 16560dc018ecSStefan Roese 16576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_DTT_BUS_NUM 16580dc018ecSStefan Roese 16590dc018ecSStefan Roese If defined, then this indicates the I2C bus number for the DTT. 16600dc018ecSStefan Roese If not defined, then U-Boot assumes that DTT is on I2C bus 0. 16610dc018ecSStefan Roese 16626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_DTT_ADDR: 16639ebbb54fSVictor Gallardo 16649ebbb54fSVictor Gallardo If defined, specifies the I2C address of the DTT device. 16659ebbb54fSVictor Gallardo If not defined, then U-Boot uses predefined value for 16669ebbb54fSVictor Gallardo specified DTT device. 16679ebbb54fSVictor Gallardo 1668be5e6181STimur Tabi CONFIG_FSL_I2C 1669be5e6181STimur Tabi 1670be5e6181STimur Tabi Define this option if you want to use Freescale's I2C driver in 16717817cb20SMarcel Ziswiler drivers/i2c/fsl_i2c.c. 1672be5e6181STimur Tabi 167367b23a32SHeiko Schocher CONFIG_I2C_MUX 167467b23a32SHeiko Schocher 167567b23a32SHeiko Schocher Define this option if you have I2C devices reached over 1 .. n 167667b23a32SHeiko Schocher I2C Muxes like the pca9544a. This option addes a new I2C 167767b23a32SHeiko Schocher Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a 167867b23a32SHeiko Schocher new I2C Bus to the existing I2C Busses. If you select the 167967b23a32SHeiko Schocher new Bus with "i2c dev", u-bbot sends first the commandos for 168067b23a32SHeiko Schocher the muxes to activate this new "bus". 168167b23a32SHeiko Schocher 168267b23a32SHeiko Schocher CONFIG_I2C_MULTI_BUS must be also defined, to use this 168367b23a32SHeiko Schocher feature! 168467b23a32SHeiko Schocher 168567b23a32SHeiko Schocher Example: 168667b23a32SHeiko Schocher Adding a new I2C Bus reached over 2 pca9544a muxes 168767b23a32SHeiko Schocher The First mux with address 70 and channel 6 168867b23a32SHeiko Schocher The Second mux with address 71 and channel 4 168967b23a32SHeiko Schocher 169067b23a32SHeiko Schocher => i2c bus pca9544a:70:6:pca9544a:71:4 169167b23a32SHeiko Schocher 169267b23a32SHeiko Schocher Use the "i2c bus" command without parameter, to get a list 169367b23a32SHeiko Schocher of I2C Busses with muxes: 169467b23a32SHeiko Schocher 169567b23a32SHeiko Schocher => i2c bus 169667b23a32SHeiko Schocher Busses reached over muxes: 169767b23a32SHeiko Schocher Bus ID: 2 169867b23a32SHeiko Schocher reached over Mux(es): 169967b23a32SHeiko Schocher pca9544a@70 ch: 4 170067b23a32SHeiko Schocher Bus ID: 3 170167b23a32SHeiko Schocher reached over Mux(es): 170267b23a32SHeiko Schocher pca9544a@70 ch: 6 170367b23a32SHeiko Schocher pca9544a@71 ch: 4 170467b23a32SHeiko Schocher => 170567b23a32SHeiko Schocher 170667b23a32SHeiko Schocher If you now switch to the new I2C Bus 3 with "i2c dev 3" 170767b23a32SHeiko Schocher u-boot sends First the Commando to the mux@70 to enable 170867b23a32SHeiko Schocher channel 6, and then the Commando to the mux@71 to enable 170967b23a32SHeiko Schocher the channel 4. 171067b23a32SHeiko Schocher 171167b23a32SHeiko Schocher After that, you can use the "normal" i2c commands as 171267b23a32SHeiko Schocher usual, to communicate with your I2C devices behind 171367b23a32SHeiko Schocher the 2 muxes. 171467b23a32SHeiko Schocher 171567b23a32SHeiko Schocher This option is actually implemented for the bitbanging 171667b23a32SHeiko Schocher algorithm in common/soft_i2c.c and for the Hardware I2C 171767b23a32SHeiko Schocher Bus on the MPC8260. But it should be not so difficult 171867b23a32SHeiko Schocher to add this option to other architectures. 171967b23a32SHeiko Schocher 17202ac6985aSAndrew Dyer CONFIG_SOFT_I2C_READ_REPEATED_START 17212ac6985aSAndrew Dyer 17222ac6985aSAndrew Dyer defining this will force the i2c_read() function in 17232ac6985aSAndrew Dyer the soft_i2c driver to perform an I2C repeated start 17242ac6985aSAndrew Dyer between writing the address pointer and reading the 17252ac6985aSAndrew Dyer data. If this define is omitted the default behaviour 17262ac6985aSAndrew Dyer of doing a stop-start sequence will be used. Most I2C 17272ac6985aSAndrew Dyer devices can use either method, but some require one or 17282ac6985aSAndrew Dyer the other. 1729be5e6181STimur Tabi 1730c609719bSwdenk- SPI Support: CONFIG_SPI 1731c609719bSwdenk 1732c609719bSwdenk Enables SPI driver (so far only tested with 1733c609719bSwdenk SPI EEPROM, also an instance works with Crystal A/D and 1734c609719bSwdenk D/As on the SACSng board) 1735c609719bSwdenk 17366639562eSYoshihiro Shimoda CONFIG_SH_SPI 17376639562eSYoshihiro Shimoda 17386639562eSYoshihiro Shimoda Enables the driver for SPI controller on SuperH. Currently 17396639562eSYoshihiro Shimoda only SH7757 is supported. 17406639562eSYoshihiro Shimoda 1741c609719bSwdenk CONFIG_SPI_X 1742c609719bSwdenk 1743c609719bSwdenk Enables extended (16-bit) SPI EEPROM addressing. 1744c609719bSwdenk (symmetrical to CONFIG_I2C_X) 1745c609719bSwdenk 1746c609719bSwdenk CONFIG_SOFT_SPI 1747c609719bSwdenk 1748c609719bSwdenk Enables a software (bit-bang) SPI driver rather than 1749c609719bSwdenk using hardware support. This is a general purpose 1750c609719bSwdenk driver that only requires three general I/O port pins 1751c609719bSwdenk (two outputs, one input) to function. If this is 1752c609719bSwdenk defined, the board configuration must define several 1753c609719bSwdenk SPI configuration items (port pins to use, etc). For 1754c609719bSwdenk an example, see include/configs/sacsng.h. 1755c609719bSwdenk 175604a9e118SBen Warren CONFIG_HARD_SPI 175704a9e118SBen Warren 175804a9e118SBen Warren Enables a hardware SPI driver for general-purpose reads 175904a9e118SBen Warren and writes. As with CONFIG_SOFT_SPI, the board configuration 176004a9e118SBen Warren must define a list of chip-select function pointers. 176104a9e118SBen Warren Currently supported on some MPC8xxx processors. For an 176204a9e118SBen Warren example, see include/configs/mpc8349emds.h. 176304a9e118SBen Warren 176438254f45SGuennadi Liakhovetski CONFIG_MXC_SPI 176538254f45SGuennadi Liakhovetski 176638254f45SGuennadi Liakhovetski Enables the driver for the SPI controllers on i.MX and MXC 176738254f45SGuennadi Liakhovetski SoCs. Currently only i.MX31 is supported. 176838254f45SGuennadi Liakhovetski 17690133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA 17700133502eSMatthias Fuchs 17710133502eSMatthias Fuchs Enables FPGA subsystem. 17720133502eSMatthias Fuchs 17730133502eSMatthias Fuchs CONFIG_FPGA_<vendor> 17740133502eSMatthias Fuchs 17750133502eSMatthias Fuchs Enables support for specific chip vendors. 17760133502eSMatthias Fuchs (ALTERA, XILINX) 17770133502eSMatthias Fuchs 17780133502eSMatthias Fuchs CONFIG_FPGA_<family> 17790133502eSMatthias Fuchs 17800133502eSMatthias Fuchs Enables support for FPGA family. 17810133502eSMatthias Fuchs (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX) 17820133502eSMatthias Fuchs 17830133502eSMatthias Fuchs CONFIG_FPGA_COUNT 1784c609719bSwdenk 1785c609719bSwdenk Specify the number of FPGA devices to support. 1786c609719bSwdenk 17876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_PROG_FEEDBACK 1788c609719bSwdenk 1789c609719bSwdenk Enable printing of hash marks during FPGA configuration. 1790c609719bSwdenk 17916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_BUSY 1792c609719bSwdenk 1793c609719bSwdenk Enable checks on FPGA configuration interface busy 1794c609719bSwdenk status by the configuration function. This option 1795c609719bSwdenk will require a board or device specific function to 1796c609719bSwdenk be written. 1797c609719bSwdenk 1798c609719bSwdenk CONFIG_FPGA_DELAY 1799c609719bSwdenk 1800c609719bSwdenk If defined, a function that provides delays in the FPGA 1801c609719bSwdenk configuration driver. 1802c609719bSwdenk 18036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_CTRLC 1804c609719bSwdenk Allow Control-C to interrupt FPGA configuration 1805c609719bSwdenk 18066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_ERROR 1807c609719bSwdenk 1808c609719bSwdenk Check for configuration errors during FPGA bitfile 1809c609719bSwdenk loading. For example, abort during Virtex II 1810c609719bSwdenk configuration if the INIT_B line goes low (which 1811c609719bSwdenk indicated a CRC error). 1812c609719bSwdenk 18136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_INIT 1814c609719bSwdenk 1815c609719bSwdenk Maximum time to wait for the INIT_B line to deassert 1816c609719bSwdenk after PROB_B has been deasserted during a Virtex II 1817c609719bSwdenk FPGA configuration sequence. The default time is 500 181811ccc33fSMarcel Ziswiler ms. 1819c609719bSwdenk 18206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_BUSY 1821c609719bSwdenk 1822c609719bSwdenk Maximum time to wait for BUSY to deassert during 182311ccc33fSMarcel Ziswiler Virtex II FPGA configuration. The default is 5 ms. 1824c609719bSwdenk 18256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_CONFIG 1826c609719bSwdenk 1827c609719bSwdenk Time to wait after FPGA configuration. The default is 182811ccc33fSMarcel Ziswiler 200 ms. 1829c609719bSwdenk 1830c609719bSwdenk- Configuration Management: 1831c609719bSwdenk CONFIG_IDENT_STRING 1832c609719bSwdenk 1833c609719bSwdenk If defined, this string will be added to the U-Boot 1834c609719bSwdenk version information (U_BOOT_VERSION) 1835c609719bSwdenk 1836c609719bSwdenk- Vendor Parameter Protection: 1837c609719bSwdenk 1838c609719bSwdenk U-Boot considers the values of the environment 1839c609719bSwdenk variables "serial#" (Board Serial Number) and 18407152b1d0Swdenk "ethaddr" (Ethernet Address) to be parameters that 1841c609719bSwdenk are set once by the board vendor / manufacturer, and 1842c609719bSwdenk protects these variables from casual modification by 1843c609719bSwdenk the user. Once set, these variables are read-only, 1844c609719bSwdenk and write or delete attempts are rejected. You can 184511ccc33fSMarcel Ziswiler change this behaviour: 1846c609719bSwdenk 1847c609719bSwdenk If CONFIG_ENV_OVERWRITE is #defined in your config 1848c609719bSwdenk file, the write protection for vendor parameters is 184947cd00faSwdenk completely disabled. Anybody can change or delete 1850c609719bSwdenk these parameters. 1851c609719bSwdenk 1852c609719bSwdenk Alternatively, if you #define _both_ CONFIG_ETHADDR 1853c609719bSwdenk _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default 185411ccc33fSMarcel Ziswiler Ethernet address is installed in the environment, 1855c609719bSwdenk which can be changed exactly ONCE by the user. [The 1856c609719bSwdenk serial# is unaffected by this, i. e. it remains 1857c609719bSwdenk read-only.] 1858c609719bSwdenk 1859c609719bSwdenk- Protected RAM: 1860c609719bSwdenk CONFIG_PRAM 1861c609719bSwdenk 1862c609719bSwdenk Define this variable to enable the reservation of 1863c609719bSwdenk "protected RAM", i. e. RAM which is not overwritten 1864c609719bSwdenk by U-Boot. Define CONFIG_PRAM to hold the number of 1865c609719bSwdenk kB you want to reserve for pRAM. You can overwrite 1866c609719bSwdenk this default value by defining an environment 1867c609719bSwdenk variable "pram" to the number of kB you want to 1868c609719bSwdenk reserve. Note that the board info structure will 1869c609719bSwdenk still show the full amount of RAM. If pRAM is 1870c609719bSwdenk reserved, a new environment variable "mem" will 1871c609719bSwdenk automatically be defined to hold the amount of 1872c609719bSwdenk remaining RAM in a form that can be passed as boot 1873c609719bSwdenk argument to Linux, for instance like that: 1874c609719bSwdenk 1875fe126d8bSWolfgang Denk setenv bootargs ... mem=\${mem} 1876c609719bSwdenk saveenv 1877c609719bSwdenk 1878c609719bSwdenk This way you can tell Linux not to use this memory, 1879c609719bSwdenk either, which results in a memory region that will 1880c609719bSwdenk not be affected by reboots. 1881c609719bSwdenk 1882c609719bSwdenk *WARNING* If your board configuration uses automatic 1883c609719bSwdenk detection of the RAM size, you must make sure that 1884c609719bSwdenk this memory test is non-destructive. So far, the 1885c609719bSwdenk following board configurations are known to be 1886c609719bSwdenk "pRAM-clean": 1887c609719bSwdenk 1888c609719bSwdenk ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL, 1889c609719bSwdenk HERMES, IP860, RPXlite, LWMON, LANTEC, 1890544d97e9SWolfgang Denk FLAGADM, TQM8260 1891c609719bSwdenk 1892c609719bSwdenk- Error Recovery: 1893c609719bSwdenk CONFIG_PANIC_HANG 1894c609719bSwdenk 1895c609719bSwdenk Define this variable to stop the system in case of a 1896c609719bSwdenk fatal error, so that you have to reset it manually. 1897c609719bSwdenk This is probably NOT a good idea for an embedded 189811ccc33fSMarcel Ziswiler system where you want the system to reboot 1899c609719bSwdenk automatically as fast as possible, but it may be 1900c609719bSwdenk useful during development since you can try to debug 1901c609719bSwdenk the conditions that lead to the situation. 1902c609719bSwdenk 1903c609719bSwdenk CONFIG_NET_RETRY_COUNT 1904c609719bSwdenk 1905c609719bSwdenk This variable defines the number of retries for 1906c609719bSwdenk network operations like ARP, RARP, TFTP, or BOOTP 1907c609719bSwdenk before giving up the operation. If not defined, a 1908c609719bSwdenk default value of 5 is used. 1909c609719bSwdenk 191040cb90eeSGuennadi Liakhovetski CONFIG_ARP_TIMEOUT 191140cb90eeSGuennadi Liakhovetski 191240cb90eeSGuennadi Liakhovetski Timeout waiting for an ARP reply in milliseconds. 191340cb90eeSGuennadi Liakhovetski 1914c609719bSwdenk- Command Interpreter: 19158078f1a5SWolfgang Denk CONFIG_AUTO_COMPLETE 191604a85b3bSwdenk 191704a85b3bSwdenk Enable auto completion of commands using TAB. 191804a85b3bSwdenk 19198078f1a5SWolfgang Denk Note that this feature has NOT been implemented yet 19208078f1a5SWolfgang Denk for the "hush" shell. 19218078f1a5SWolfgang Denk 19228078f1a5SWolfgang Denk 19236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_HUSH_PARSER 1924c609719bSwdenk 1925c609719bSwdenk Define this variable to enable the "hush" shell (from 1926c609719bSwdenk Busybox) as command line interpreter, thus enabling 1927c609719bSwdenk powerful command line syntax like 1928c609719bSwdenk if...then...else...fi conditionals or `&&' and '||' 1929c609719bSwdenk constructs ("shell scripts"). 1930c609719bSwdenk 1931c609719bSwdenk If undefined, you get the old, much simpler behaviour 1932c609719bSwdenk with a somewhat smaller memory footprint. 1933c609719bSwdenk 1934c609719bSwdenk 19356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PROMPT_HUSH_PS2 1936c609719bSwdenk 1937c609719bSwdenk This defines the secondary prompt string, which is 1938c609719bSwdenk printed when the command interpreter needs more input 1939c609719bSwdenk to complete a command. Usually "> ". 1940c609719bSwdenk 1941c609719bSwdenk Note: 1942c609719bSwdenk 1943c609719bSwdenk In the current implementation, the local variables 1944c609719bSwdenk space and global environment variables space are 1945c609719bSwdenk separated. Local variables are those you define by 19463b57fe0aSwdenk simply typing `name=value'. To access a local 1947c609719bSwdenk variable later on, you have write `$name' or 19483b57fe0aSwdenk `${name}'; to execute the contents of a variable 19493b57fe0aSwdenk directly type `$name' at the command prompt. 1950c609719bSwdenk 1951c609719bSwdenk Global environment variables are those you use 1952c609719bSwdenk setenv/printenv to work with. To run a command stored 1953c609719bSwdenk in such a variable, you need to use the run command, 1954c609719bSwdenk and you must not use the '$' sign to access them. 1955c609719bSwdenk 1956c609719bSwdenk To store commands and special characters in a 1957c609719bSwdenk variable, please use double quotation marks 1958c609719bSwdenk surrounding the whole text of the variable, instead 1959c609719bSwdenk of the backslashes before semicolons and special 1960c609719bSwdenk symbols. 1961c609719bSwdenk 1962aa0c71acSWolfgang Denk- Commandline Editing and History: 1963aa0c71acSWolfgang Denk CONFIG_CMDLINE_EDITING 1964aa0c71acSWolfgang Denk 196511ccc33fSMarcel Ziswiler Enable editing and History functions for interactive 1966aa0c71acSWolfgang Denk commandline input operations 1967aa0c71acSWolfgang Denk 1968a8c7c708Swdenk- Default Environment: 1969c609719bSwdenk CONFIG_EXTRA_ENV_SETTINGS 1970c609719bSwdenk 1971c609719bSwdenk Define this to contain any number of null terminated 1972c609719bSwdenk strings (variable = value pairs) that will be part of 19737152b1d0Swdenk the default environment compiled into the boot image. 19742262cfeeSwdenk 1975c609719bSwdenk For example, place something like this in your 1976c609719bSwdenk board's config file: 1977c609719bSwdenk 1978c609719bSwdenk #define CONFIG_EXTRA_ENV_SETTINGS \ 1979c609719bSwdenk "myvar1=value1\0" \ 1980c609719bSwdenk "myvar2=value2\0" 1981c609719bSwdenk 1982c609719bSwdenk Warning: This method is based on knowledge about the 1983c609719bSwdenk internal format how the environment is stored by the 19842262cfeeSwdenk U-Boot code. This is NOT an official, exported 1985c609719bSwdenk interface! Although it is unlikely that this format 19867152b1d0Swdenk will change soon, there is no guarantee either. 1987c609719bSwdenk You better know what you are doing here. 1988c609719bSwdenk 1989c609719bSwdenk Note: overly (ab)use of the default environment is 1990c609719bSwdenk discouraged. Make sure to check other ways to preset 199174de7aefSWolfgang Denk the environment like the "source" command or the 1992c609719bSwdenk boot command first. 1993c609719bSwdenk 1994a8c7c708Swdenk- DataFlash Support: 19952abbe075Swdenk CONFIG_HAS_DATAFLASH 19962abbe075Swdenk 19972abbe075Swdenk Defining this option enables DataFlash features and 19982abbe075Swdenk allows to read/write in Dataflash via the standard 19992abbe075Swdenk commands cp, md... 20002abbe075Swdenk 20013f85ce27Swdenk- SystemACE Support: 20023f85ce27Swdenk CONFIG_SYSTEMACE 20033f85ce27Swdenk 20043f85ce27Swdenk Adding this option adds support for Xilinx SystemACE 20053f85ce27Swdenk chips attached via some sort of local bus. The address 200611ccc33fSMarcel Ziswiler of the chip must also be defined in the 20076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SYSTEMACE_BASE macro. For example: 20083f85ce27Swdenk 20093f85ce27Swdenk #define CONFIG_SYSTEMACE 20106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000 20113f85ce27Swdenk 20123f85ce27Swdenk When SystemACE support is added, the "ace" device type 20133f85ce27Swdenk becomes available to the fat commands, i.e. fatls. 20143f85ce27Swdenk 2015ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port: 2016ecb0ccd9SWolfgang Denk CONFIG_TFTP_PORT 2017ecb0ccd9SWolfgang Denk 201828cb9375SWolfgang Denk If this is defined, the environment variable tftpsrcp 2019ecb0ccd9SWolfgang Denk is used to supply the TFTP UDP source port value. 202028cb9375SWolfgang Denk If tftpsrcp isn't defined, the normal pseudo-random port 2021ecb0ccd9SWolfgang Denk number generator is used. 2022ecb0ccd9SWolfgang Denk 202328cb9375SWolfgang Denk Also, the environment variable tftpdstp is used to supply 202428cb9375SWolfgang Denk the TFTP UDP destination port value. If tftpdstp isn't 202528cb9375SWolfgang Denk defined, the normal port 69 is used. 202628cb9375SWolfgang Denk 202728cb9375SWolfgang Denk The purpose for tftpsrcp is to allow a TFTP server to 2028ecb0ccd9SWolfgang Denk blindly start the TFTP transfer using the pre-configured 2029ecb0ccd9SWolfgang Denk target IP address and UDP port. This has the effect of 2030ecb0ccd9SWolfgang Denk "punching through" the (Windows XP) firewall, allowing 2031ecb0ccd9SWolfgang Denk the remainder of the TFTP transfer to proceed normally. 2032ecb0ccd9SWolfgang Denk A better solution is to properly configure the firewall, 2033ecb0ccd9SWolfgang Denk but sometimes that is not allowed. 2034ecb0ccd9SWolfgang Denk 2035a8c7c708Swdenk- Show boot progress: 2036c609719bSwdenk CONFIG_SHOW_BOOT_PROGRESS 2037c609719bSwdenk 2038c609719bSwdenk Defining this option allows to add some board- 2039c609719bSwdenk specific code (calling a user-provided function 2040c609719bSwdenk "show_boot_progress(int)") that enables you to show 2041c609719bSwdenk the system's boot progress on some display (for 2042c609719bSwdenk example, some LED's) on your board. At the moment, 2043c609719bSwdenk the following checkpoints are implemented: 2044c609719bSwdenk 20458ae86b76SWolfgang Denk- Standalone program support: 20468ae86b76SWolfgang Denk CONFIG_STANDALONE_LOAD_ADDR 20478ae86b76SWolfgang Denk 20488ae86b76SWolfgang Denk This option allows to define board specific values 20498ae86b76SWolfgang Denk for the address where standalone program gets loaded, 20508ae86b76SWolfgang Denk thus overwriting the architecutre dependent default 20518ae86b76SWolfgang Denk settings. 20528ae86b76SWolfgang Denk 2053d32a1a4cSMinkyu Kang- Frame Buffer Address: 2054d32a1a4cSMinkyu Kang CONFIG_FB_ADDR 2055d32a1a4cSMinkyu Kang 2056d32a1a4cSMinkyu Kang Define CONFIG_FB_ADDR if you want to use specific address for 2057d32a1a4cSMinkyu Kang frame buffer. 2058d32a1a4cSMinkyu Kang Then system will reserve the frame buffer address to defined address 2059d32a1a4cSMinkyu Kang instead of lcd_setmem (this function grab the memory for frame buffer 2060d32a1a4cSMinkyu Kang by panel's size). 2061d32a1a4cSMinkyu Kang 2062d32a1a4cSMinkyu Kang Please see board_init_f function. 2063d32a1a4cSMinkyu Kang 2064d32a1a4cSMinkyu Kang If you want this config option then, 2065d32a1a4cSMinkyu Kang please define it at your board config file 2066d32a1a4cSMinkyu Kang 20671372cce2SMarian BalakowiczLegacy uImage format: 20681372cce2SMarian Balakowicz 2069c609719bSwdenk Arg Where When 2070c609719bSwdenk 1 common/cmd_bootm.c before attempting to boot an image 2071c609719bSwdenk -1 common/cmd_bootm.c Image header has bad magic number 2072c609719bSwdenk 2 common/cmd_bootm.c Image header has correct magic number 2073c609719bSwdenk -2 common/cmd_bootm.c Image header has bad checksum 2074c609719bSwdenk 3 common/cmd_bootm.c Image header has correct checksum 2075c609719bSwdenk -3 common/cmd_bootm.c Image data has bad checksum 2076c609719bSwdenk 4 common/cmd_bootm.c Image data has correct checksum 2077c609719bSwdenk -4 common/cmd_bootm.c Image is for unsupported architecture 2078c609719bSwdenk 5 common/cmd_bootm.c Architecture check OK 20791372cce2SMarian Balakowicz -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi) 2080c609719bSwdenk 6 common/cmd_bootm.c Image Type check OK 2081c609719bSwdenk -6 common/cmd_bootm.c gunzip uncompression error 2082c609719bSwdenk -7 common/cmd_bootm.c Unimplemented compression type 2083c609719bSwdenk 7 common/cmd_bootm.c Uncompression OK 20841372cce2SMarian Balakowicz 8 common/cmd_bootm.c No uncompress/copy overwrite error 2085c609719bSwdenk -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX) 20861372cce2SMarian Balakowicz 20871372cce2SMarian Balakowicz 9 common/image.c Start initial ramdisk verification 20881372cce2SMarian Balakowicz -10 common/image.c Ramdisk header has bad magic number 20891372cce2SMarian Balakowicz -11 common/image.c Ramdisk header has bad checksum 20901372cce2SMarian Balakowicz 10 common/image.c Ramdisk header is OK 20911372cce2SMarian Balakowicz -12 common/image.c Ramdisk data has bad checksum 20921372cce2SMarian Balakowicz 11 common/image.c Ramdisk data has correct checksum 20931372cce2SMarian Balakowicz 12 common/image.c Ramdisk verification complete, start loading 209411ccc33fSMarcel Ziswiler -13 common/image.c Wrong Image Type (not PPC Linux ramdisk) 20951372cce2SMarian Balakowicz 13 common/image.c Start multifile image verification 20961372cce2SMarian Balakowicz 14 common/image.c No initial ramdisk, no multifile, continue. 20971372cce2SMarian Balakowicz 2098ea0364f1SPeter Tyser 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS 2099c609719bSwdenk 2100a47a12beSStefan Roese -30 arch/powerpc/lib/board.c Fatal error, hang the system 210163e73c9aSwdenk -31 post/post.c POST test failed, detected by post_output_backlog() 210263e73c9aSwdenk -32 post/post.c POST test failed, detected by post_run_single() 210363e73c9aSwdenk 2104566a494fSHeiko Schocher 34 common/cmd_doc.c before loading a Image from a DOC device 2105566a494fSHeiko Schocher -35 common/cmd_doc.c Bad usage of "doc" command 2106566a494fSHeiko Schocher 35 common/cmd_doc.c correct usage of "doc" command 2107566a494fSHeiko Schocher -36 common/cmd_doc.c No boot device 2108566a494fSHeiko Schocher 36 common/cmd_doc.c correct boot device 2109566a494fSHeiko Schocher -37 common/cmd_doc.c Unknown Chip ID on boot device 2110566a494fSHeiko Schocher 37 common/cmd_doc.c correct chip ID found, device available 2111566a494fSHeiko Schocher -38 common/cmd_doc.c Read Error on boot device 2112566a494fSHeiko Schocher 38 common/cmd_doc.c reading Image header from DOC device OK 2113566a494fSHeiko Schocher -39 common/cmd_doc.c Image header has bad magic number 2114566a494fSHeiko Schocher 39 common/cmd_doc.c Image header has correct magic number 2115566a494fSHeiko Schocher -40 common/cmd_doc.c Error reading Image from DOC device 2116566a494fSHeiko Schocher 40 common/cmd_doc.c Image header has correct magic number 2117566a494fSHeiko Schocher 41 common/cmd_ide.c before loading a Image from a IDE device 2118566a494fSHeiko Schocher -42 common/cmd_ide.c Bad usage of "ide" command 2119566a494fSHeiko Schocher 42 common/cmd_ide.c correct usage of "ide" command 2120566a494fSHeiko Schocher -43 common/cmd_ide.c No boot device 2121566a494fSHeiko Schocher 43 common/cmd_ide.c boot device found 2122566a494fSHeiko Schocher -44 common/cmd_ide.c Device not available 2123566a494fSHeiko Schocher 44 common/cmd_ide.c Device available 2124566a494fSHeiko Schocher -45 common/cmd_ide.c wrong partition selected 2125566a494fSHeiko Schocher 45 common/cmd_ide.c partition selected 2126566a494fSHeiko Schocher -46 common/cmd_ide.c Unknown partition table 2127566a494fSHeiko Schocher 46 common/cmd_ide.c valid partition table found 2128566a494fSHeiko Schocher -47 common/cmd_ide.c Invalid partition type 2129566a494fSHeiko Schocher 47 common/cmd_ide.c correct partition type 2130566a494fSHeiko Schocher -48 common/cmd_ide.c Error reading Image Header on boot device 2131566a494fSHeiko Schocher 48 common/cmd_ide.c reading Image Header from IDE device OK 2132566a494fSHeiko Schocher -49 common/cmd_ide.c Image header has bad magic number 2133566a494fSHeiko Schocher 49 common/cmd_ide.c Image header has correct magic number 2134566a494fSHeiko Schocher -50 common/cmd_ide.c Image header has bad checksum 2135566a494fSHeiko Schocher 50 common/cmd_ide.c Image header has correct checksum 2136566a494fSHeiko Schocher -51 common/cmd_ide.c Error reading Image from IDE device 2137566a494fSHeiko Schocher 51 common/cmd_ide.c reading Image from IDE device OK 2138566a494fSHeiko Schocher 52 common/cmd_nand.c before loading a Image from a NAND device 2139566a494fSHeiko Schocher -53 common/cmd_nand.c Bad usage of "nand" command 2140566a494fSHeiko Schocher 53 common/cmd_nand.c correct usage of "nand" command 2141566a494fSHeiko Schocher -54 common/cmd_nand.c No boot device 2142566a494fSHeiko Schocher 54 common/cmd_nand.c boot device found 2143566a494fSHeiko Schocher -55 common/cmd_nand.c Unknown Chip ID on boot device 2144566a494fSHeiko Schocher 55 common/cmd_nand.c correct chip ID found, device available 2145566a494fSHeiko Schocher -56 common/cmd_nand.c Error reading Image Header on boot device 2146566a494fSHeiko Schocher 56 common/cmd_nand.c reading Image Header from NAND device OK 2147566a494fSHeiko Schocher -57 common/cmd_nand.c Image header has bad magic number 2148566a494fSHeiko Schocher 57 common/cmd_nand.c Image header has correct magic number 2149566a494fSHeiko Schocher -58 common/cmd_nand.c Error reading Image from NAND device 2150566a494fSHeiko Schocher 58 common/cmd_nand.c reading Image from NAND device OK 2151c609719bSwdenk 2152566a494fSHeiko Schocher -60 common/env_common.c Environment has a bad CRC, using default 2153c609719bSwdenk 2154566a494fSHeiko Schocher 64 net/eth.c starting with Ethernet configuration. 2155566a494fSHeiko Schocher -64 net/eth.c no Ethernet found. 2156566a494fSHeiko Schocher 65 net/eth.c Ethernet found. 2157206c60cbSwdenk 2158566a494fSHeiko Schocher -80 common/cmd_net.c usage wrong 2159566a494fSHeiko Schocher 80 common/cmd_net.c before calling NetLoop() 216011ccc33fSMarcel Ziswiler -81 common/cmd_net.c some error in NetLoop() occurred 2161566a494fSHeiko Schocher 81 common/cmd_net.c NetLoop() back without error 2162566a494fSHeiko Schocher -82 common/cmd_net.c size == 0 (File with size 0 loaded) 2163566a494fSHeiko Schocher 82 common/cmd_net.c trying automatic boot 216474de7aefSWolfgang Denk 83 common/cmd_net.c running "source" command 216574de7aefSWolfgang Denk -83 common/cmd_net.c some error in automatic boot or "source" command 2166566a494fSHeiko Schocher 84 common/cmd_net.c end without errors 2167c609719bSwdenk 21681372cce2SMarian BalakowiczFIT uImage format: 21691372cce2SMarian Balakowicz 21701372cce2SMarian Balakowicz Arg Where When 21711372cce2SMarian Balakowicz 100 common/cmd_bootm.c Kernel FIT Image has correct format 21721372cce2SMarian Balakowicz -100 common/cmd_bootm.c Kernel FIT Image has incorrect format 21731372cce2SMarian Balakowicz 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration 21741372cce2SMarian Balakowicz -101 common/cmd_bootm.c Can't get configuration for kernel subimage 21751372cce2SMarian Balakowicz 102 common/cmd_bootm.c Kernel unit name specified 21761372cce2SMarian Balakowicz -103 common/cmd_bootm.c Can't get kernel subimage node offset 2177f773bea8SMarian Balakowicz 103 common/cmd_bootm.c Found configuration node 21781372cce2SMarian Balakowicz 104 common/cmd_bootm.c Got kernel subimage node offset 21791372cce2SMarian Balakowicz -104 common/cmd_bootm.c Kernel subimage hash verification failed 21801372cce2SMarian Balakowicz 105 common/cmd_bootm.c Kernel subimage hash verification OK 21811372cce2SMarian Balakowicz -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture 21821372cce2SMarian Balakowicz 106 common/cmd_bootm.c Architecture check OK 218311ccc33fSMarcel Ziswiler -106 common/cmd_bootm.c Kernel subimage has wrong type 218411ccc33fSMarcel Ziswiler 107 common/cmd_bootm.c Kernel subimage type OK 21851372cce2SMarian Balakowicz -107 common/cmd_bootm.c Can't get kernel subimage data/size 21861372cce2SMarian Balakowicz 108 common/cmd_bootm.c Got kernel subimage data/size 21871372cce2SMarian Balakowicz -108 common/cmd_bootm.c Wrong image type (not legacy, FIT) 21881372cce2SMarian Balakowicz -109 common/cmd_bootm.c Can't get kernel subimage type 21891372cce2SMarian Balakowicz -110 common/cmd_bootm.c Can't get kernel subimage comp 21901372cce2SMarian Balakowicz -111 common/cmd_bootm.c Can't get kernel subimage os 21911372cce2SMarian Balakowicz -112 common/cmd_bootm.c Can't get kernel subimage load address 21921372cce2SMarian Balakowicz -113 common/cmd_bootm.c Image uncompress/copy overwrite error 21931372cce2SMarian Balakowicz 21941372cce2SMarian Balakowicz 120 common/image.c Start initial ramdisk verification 21951372cce2SMarian Balakowicz -120 common/image.c Ramdisk FIT image has incorrect format 21961372cce2SMarian Balakowicz 121 common/image.c Ramdisk FIT image has correct format 219711ccc33fSMarcel Ziswiler 122 common/image.c No ramdisk subimage unit name, using configuration 21981372cce2SMarian Balakowicz -122 common/image.c Can't get configuration for ramdisk subimage 21991372cce2SMarian Balakowicz 123 common/image.c Ramdisk unit name specified 22001372cce2SMarian Balakowicz -124 common/image.c Can't get ramdisk subimage node offset 22011372cce2SMarian Balakowicz 125 common/image.c Got ramdisk subimage node offset 22021372cce2SMarian Balakowicz -125 common/image.c Ramdisk subimage hash verification failed 22031372cce2SMarian Balakowicz 126 common/image.c Ramdisk subimage hash verification OK 22041372cce2SMarian Balakowicz -126 common/image.c Ramdisk subimage for unsupported architecture 22051372cce2SMarian Balakowicz 127 common/image.c Architecture check OK 22061372cce2SMarian Balakowicz -127 common/image.c Can't get ramdisk subimage data/size 22071372cce2SMarian Balakowicz 128 common/image.c Got ramdisk subimage data/size 22081372cce2SMarian Balakowicz 129 common/image.c Can't get ramdisk load address 22091372cce2SMarian Balakowicz -129 common/image.c Got ramdisk load address 22101372cce2SMarian Balakowicz 221111ccc33fSMarcel Ziswiler -130 common/cmd_doc.c Incorrect FIT image format 22121372cce2SMarian Balakowicz 131 common/cmd_doc.c FIT image format OK 22131372cce2SMarian Balakowicz 221411ccc33fSMarcel Ziswiler -140 common/cmd_ide.c Incorrect FIT image format 22151372cce2SMarian Balakowicz 141 common/cmd_ide.c FIT image format OK 22161372cce2SMarian Balakowicz 221711ccc33fSMarcel Ziswiler -150 common/cmd_nand.c Incorrect FIT image format 22181372cce2SMarian Balakowicz 151 common/cmd_nand.c FIT image format OK 22191372cce2SMarian Balakowicz 2220cccfc2abSDetlev Zundel- Automatic software updates via TFTP server 2221cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP 2222cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP_CNT_MAX 2223cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP_MSEC_MAX 2224cccfc2abSDetlev Zundel 2225cccfc2abSDetlev Zundel These options enable and control the auto-update feature; 2226cccfc2abSDetlev Zundel for a more detailed description refer to doc/README.update. 2227cccfc2abSDetlev Zundel 2228cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support) 2229cccfc2abSDetlev Zundel CONFIG_MTD_DEVICE 2230cccfc2abSDetlev Zundel 2231cccfc2abSDetlev Zundel Adds the MTD device infrastructure from the Linux kernel. 2232cccfc2abSDetlev Zundel Needed for mtdparts command support. 2233cccfc2abSDetlev Zundel 2234cccfc2abSDetlev Zundel CONFIG_MTD_PARTITIONS 2235cccfc2abSDetlev Zundel 2236cccfc2abSDetlev Zundel Adds the MTD partitioning infrastructure from the Linux 2237cccfc2abSDetlev Zundel kernel. Needed for UBI support. 2238cccfc2abSDetlev Zundel 22391372cce2SMarian Balakowicz 2240c609719bSwdenkModem Support: 2241c609719bSwdenk-------------- 2242c609719bSwdenk 2243566e5cf4SWolfgang Denk[so far only for SMDK2400 boards] 2244c609719bSwdenk 224511ccc33fSMarcel Ziswiler- Modem support enable: 2246c609719bSwdenk CONFIG_MODEM_SUPPORT 2247c609719bSwdenk 2248c609719bSwdenk- RTS/CTS Flow control enable: 2249c609719bSwdenk CONFIG_HWFLOW 2250c609719bSwdenk 2251c609719bSwdenk- Modem debug support: 2252c609719bSwdenk CONFIG_MODEM_SUPPORT_DEBUG 2253c609719bSwdenk 2254c609719bSwdenk Enables debugging stuff (char screen[1024], dbg()) 2255c609719bSwdenk for modem support. Useful only with BDI2000. 2256c609719bSwdenk 2257a8c7c708Swdenk- Interrupt support (PPC): 2258a8c7c708Swdenk 2259a8c7c708Swdenk There are common interrupt_init() and timer_interrupt() 2260a8c7c708Swdenk for all PPC archs. interrupt_init() calls interrupt_init_cpu() 226111ccc33fSMarcel Ziswiler for CPU specific initialization. interrupt_init_cpu() 2262a8c7c708Swdenk should set decrementer_count to appropriate value. If 226311ccc33fSMarcel Ziswiler CPU resets decrementer automatically after interrupt 2264a8c7c708Swdenk (ppc4xx) it should set decrementer_count to zero. 226511ccc33fSMarcel Ziswiler timer_interrupt() calls timer_interrupt_cpu() for CPU 2266a8c7c708Swdenk specific handling. If board has watchdog / status_led 2267a8c7c708Swdenk / other_activity_monitor it works automatically from 2268a8c7c708Swdenk general timer_interrupt(). 2269a8c7c708Swdenk 2270c609719bSwdenk- General: 2271c609719bSwdenk 2272c609719bSwdenk In the target system modem support is enabled when a 2273c609719bSwdenk specific key (key combination) is pressed during 2274c609719bSwdenk power-on. Otherwise U-Boot will boot normally 227511ccc33fSMarcel Ziswiler (autoboot). The key_pressed() function is called from 2276c609719bSwdenk board_init(). Currently key_pressed() is a dummy 2277c609719bSwdenk function, returning 1 and thus enabling modem 2278c609719bSwdenk initialization. 2279c609719bSwdenk 2280c609719bSwdenk If there are no modem init strings in the 2281c609719bSwdenk environment, U-Boot proceed to autoboot; the 2282c609719bSwdenk previous output (banner, info printfs) will be 228311ccc33fSMarcel Ziswiler suppressed, though. 2284c609719bSwdenk 2285c609719bSwdenk See also: doc/README.Modem 2286c609719bSwdenk 2287c609719bSwdenk 2288c609719bSwdenkConfiguration Settings: 2289c609719bSwdenk----------------------- 2290c609719bSwdenk 22916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included; 2292c609719bSwdenk undefine this when you're short of memory. 2293c609719bSwdenk 22942fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default 22952fb2604dSPeter Tyser width of the commands listed in the 'help' command output. 22962fb2604dSPeter Tyser 22976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to 2298c609719bSwdenk prompt for user input. 2299c609719bSwdenk 23006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE: Buffer size for input from the Console 2301c609719bSwdenk 23026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE: Buffer size for Console output 2303c609719bSwdenk 23046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands 2305c609719bSwdenk 23066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to 2307c609719bSwdenk the application (usually a Linux kernel) when it is 2308c609719bSwdenk booted 2309c609719bSwdenk 23106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE: 2311c609719bSwdenk List of legal baudrate settings for this board. 2312c609719bSwdenk 23136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET 2314c609719bSwdenk Suppress display of console information at boot. 2315c609719bSwdenk 23166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV 2317c609719bSwdenk If the board specific function 2318c609719bSwdenk extern int overwrite_console (void); 2319c609719bSwdenk returns 1, the stdin, stderr and stdout are switched to the 2320c609719bSwdenk serial port, else the settings in the environment are used. 2321c609719bSwdenk 23226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE 2323c609719bSwdenk Enable the call to overwrite_console(). 2324c609719bSwdenk 23256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE 2326c609719bSwdenk Enable overwrite of previous console environment settings. 2327c609719bSwdenk 23286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END: 2329c609719bSwdenk Begin and End addresses of the area used by the 2330c609719bSwdenk simple memory test. 2331c609719bSwdenk 23326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST: 2333c609719bSwdenk Enable an alternate, more extensive memory test. 2334c609719bSwdenk 23356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH: 23365f535fe1Swdenk Scratch address used by the alternate memory test 23375f535fe1Swdenk You only need to set this if address zero isn't writeable 23385f535fe1Swdenk 23396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only): 23406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header, 234114f73ca6SStefan Roese this specified memory area will get subtracted from the top 234211ccc33fSMarcel Ziswiler (end) of RAM and won't get "touched" at all by U-Boot. By 234314f73ca6SStefan Roese fixing up gd->ram_size the Linux kernel should gets passed 234414f73ca6SStefan Roese the now "corrected" memory size and won't touch it either. 234514f73ca6SStefan Roese This should work for arch/ppc and arch/powerpc. Only Linux 23465e12e75dSStefan Roese board ports in arch/powerpc with bootwrapper support that 234714f73ca6SStefan Roese recalculate the memory size from the SDRAM controller setup 23485e12e75dSStefan Roese will have to get fixed in Linux additionally. 234914f73ca6SStefan Roese 235014f73ca6SStefan Roese This option can be used as a workaround for the 440EPx/GRx 235114f73ca6SStefan Roese CHIP 11 errata where the last 256 bytes in SDRAM shouldn't 235214f73ca6SStefan Roese be touched. 235314f73ca6SStefan Roese 235414f73ca6SStefan Roese WARNING: Please make sure that this value is a multiple of 235514f73ca6SStefan Roese the Linux page size (normally 4k). If this is not the case, 235614f73ca6SStefan Roese then the end address of the Linux memory will be located at a 235714f73ca6SStefan Roese non page size aligned address and this could cause major 235814f73ca6SStefan Roese problems. 235914f73ca6SStefan Roese 23606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TFTP_LOADADDR: 2361c609719bSwdenk Default load address for network file downloads 2362c609719bSwdenk 23636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE: 2364c609719bSwdenk Enable temporary baudrate change while serial download 2365c609719bSwdenk 23666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE: 2367c609719bSwdenk Physical start address of SDRAM. _Must_ be 0 here. 2368c609719bSwdenk 23696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE: 2370c609719bSwdenk Physical start address of Motherboard I/O (if using a 2371c609719bSwdenk Cogent motherboard) 2372c609719bSwdenk 23736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE: 2374c609719bSwdenk Physical start address of Flash memory. 2375c609719bSwdenk 23766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE: 2377c609719bSwdenk Physical start address of boot monitor code (set by 2378c609719bSwdenk make config files to be same as the text base address 237914d0a02aSWolfgang Denk (CONFIG_SYS_TEXT_BASE) used when linking) - same as 23806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FLASH_BASE when booting from flash. 2381c609719bSwdenk 23826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN: 23833b57fe0aSwdenk Size of memory reserved for monitor code, used to 23843b57fe0aSwdenk determine _at_compile_time_ (!) if the environment is 23853b57fe0aSwdenk embedded within the U-Boot image, or in a separate 23863b57fe0aSwdenk flash sector. 2387c609719bSwdenk 23886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN: 2389c609719bSwdenk Size of DRAM reserved for malloc() use. 2390c609719bSwdenk 23916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN: 239215940c9aSStefan Roese Normally compressed uImages are limited to an 239315940c9aSStefan Roese uncompressed size of 8 MBytes. If this is not enough, 23946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD you can define CONFIG_SYS_BOOTM_LEN in your board config file 239515940c9aSStefan Roese to adjust this setting to your needs. 2396c609719bSwdenk 23976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ: 2398c609719bSwdenk Maximum size of memory mapped by the startup code of 2399c609719bSwdenk the Linux kernel; all data that must be processed by 24007d721e34SBartlomiej Sieka the Linux kernel (bd_info, boot arguments, FDT blob if 24017d721e34SBartlomiej Sieka used) must be put below this limit, unless "bootm_low" 24027d721e34SBartlomiej Sieka enviroment variable is defined and non-zero. In such case 24037d721e34SBartlomiej Sieka all data for the Linux kernel must be between "bootm_low" 2404c3624e6eSGrant Likely and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment 2405c3624e6eSGrant Likely variable "bootm_mapsize" will override the value of 2406c3624e6eSGrant Likely CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined, 2407c3624e6eSGrant Likely then the value in "bootm_size" will be used instead. 2408c609719bSwdenk 2409fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH: 2410fca43cc8SJohn Rigby Enable initrd_high functionality. If defined then the 2411fca43cc8SJohn Rigby initrd_high feature is enabled and the bootm ramdisk subcommand 2412fca43cc8SJohn Rigby is enabled. 2413fca43cc8SJohn Rigby 2414fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE: 2415fca43cc8SJohn Rigby Enables allocating and saving kernel cmdline in space between 2416fca43cc8SJohn Rigby "bootm_low" and "bootm_low" + BOOTMAPSZ. 2417fca43cc8SJohn Rigby 2418fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD: 2419fca43cc8SJohn Rigby Enables allocating and saving a kernel copy of the bd_info in 2420fca43cc8SJohn Rigby space between "bootm_low" and "bootm_low" + BOOTMAPSZ. 2421fca43cc8SJohn Rigby 24226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS: 2423c609719bSwdenk Max number of Flash memory banks 2424c609719bSwdenk 24256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT: 2426c609719bSwdenk Max number of sectors on a Flash chip 2427c609719bSwdenk 24286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT: 2429c609719bSwdenk Timeout for Flash erase operations (in ms) 2430c609719bSwdenk 24316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT: 2432c609719bSwdenk Timeout for Flash write operations (in ms) 2433c609719bSwdenk 24346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT 24358564acf9Swdenk Timeout for Flash set sector lock bit operation (in ms) 24368564acf9Swdenk 24376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT 24388564acf9Swdenk Timeout for Flash clear lock bits operation (in ms) 24398564acf9Swdenk 24406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION 24418564acf9Swdenk If defined, hardware flash sectors protection is used 24428564acf9Swdenk instead of U-Boot software protection. 24438564acf9Swdenk 24446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP: 2445c609719bSwdenk 2446c609719bSwdenk Enable TFTP transfers directly to flash memory; 2447c609719bSwdenk without this option such a download has to be 2448c609719bSwdenk performed in two steps: (1) download to RAM, and (2) 2449c609719bSwdenk copy from RAM to flash. 2450c609719bSwdenk 2451c609719bSwdenk The two-step approach is usually more reliable, since 2452c609719bSwdenk you can check if the download worked before you erase 245311ccc33fSMarcel Ziswiler the flash, but in some situations (when system RAM is 245411ccc33fSMarcel Ziswiler too limited to allow for a temporary copy of the 2455c609719bSwdenk downloaded image) this option may be very useful. 2456c609719bSwdenk 24576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI: 2458c609719bSwdenk Define if the flash driver uses extra elements in the 24595653fc33Swdenk common flash structure for storing flash geometry. 24605653fc33Swdenk 246100b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER 24625653fc33Swdenk This option also enables the building of the cfi_flash driver 24635653fc33Swdenk in the drivers directory 246453cf9435Sstroese 246591809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD 246691809ed5SPiotr Ziecik This option enables the building of the cfi_mtd driver 246791809ed5SPiotr Ziecik in the drivers directory. The driver exports CFI flash 246891809ed5SPiotr Ziecik to the MTD layer. 246991809ed5SPiotr Ziecik 24706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE 247196ef831fSGuennadi Liakhovetski Use buffered writes to flash. 247296ef831fSGuennadi Liakhovetski 247396ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N 247496ef831fSGuennadi Liakhovetski s29ws-n MirrorBit flash has non-standard addresses for buffered 247596ef831fSGuennadi Liakhovetski write commands. 247696ef831fSGuennadi Liakhovetski 24776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST 24785568e613SStefan Roese If this option is defined, the common CFI flash doesn't 24795568e613SStefan Roese print it's warning upon not recognized FLASH banks. This 24805568e613SStefan Roese is useful, if some of the configured banks are only 24815568e613SStefan Roese optionally available. 24825568e613SStefan Roese 24839a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS 24849a042e9cSJerry Van Baren If defined (must be an integer), print out countdown 24859a042e9cSJerry Van Baren digits and dots. Recommended value: 45 (9..1) for 80 24869a042e9cSJerry Van Baren column displays, 15 (3..1) for 40 column displays. 24879a042e9cSJerry Van Baren 24886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER: 248911ccc33fSMarcel Ziswiler Defines the number of Ethernet receive buffers. On some 249011ccc33fSMarcel Ziswiler Ethernet controllers it is recommended to set this value 249153cf9435Sstroese to 8 or even higher (EEPRO100 or 405 EMAC), since all 249253cf9435Sstroese buffers can be full shortly after enabling the interface 249311ccc33fSMarcel Ziswiler on high Ethernet traffic. 249453cf9435Sstroese Defaults to 4 if not defined. 2495c609719bSwdenk 2496ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES 2497ea882bafSWolfgang Denk 2498ea882bafSWolfgang Denk Maximum number of entries in the hash table that is used 2499ea882bafSWolfgang Denk internally to store the environment settings. The default 2500ea882bafSWolfgang Denk setting is supposed to be generous and should work in most 2501ea882bafSWolfgang Denk cases. This setting can be used to tune behaviour; see 2502ea882bafSWolfgang Denk lib/hashtable.c for details. 2503ea882bafSWolfgang Denk 2504c609719bSwdenkThe following definitions that deal with the placement and management 2505c609719bSwdenkof environment data (variable area); in general, we support the 2506c609719bSwdenkfollowing configurations: 2507c609719bSwdenk 25085a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH: 2509c609719bSwdenk 2510c609719bSwdenk Define this if the environment is in flash memory. 2511c609719bSwdenk 2512c609719bSwdenk a) The environment occupies one whole flash sector, which is 2513c609719bSwdenk "embedded" in the text segment with the U-Boot code. This 2514c609719bSwdenk happens usually with "bottom boot sector" or "top boot 2515c609719bSwdenk sector" type flash chips, which have several smaller 2516c609719bSwdenk sectors at the start or the end. For instance, such a 2517c609719bSwdenk layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In 2518c609719bSwdenk such a case you would place the environment in one of the 2519c609719bSwdenk 4 kB sectors - with U-Boot code before and after it. With 2520c609719bSwdenk "top boot sector" type flash chips, you would put the 2521c609719bSwdenk environment in one of the last sectors, leaving a gap 2522c609719bSwdenk between U-Boot and the environment. 2523c609719bSwdenk 25240e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 2525c609719bSwdenk 2526c609719bSwdenk Offset of environment data (variable area) to the 2527c609719bSwdenk beginning of flash memory; for instance, with bottom boot 2528c609719bSwdenk type flash chips the second sector can be used: the offset 2529c609719bSwdenk for this sector is given here. 2530c609719bSwdenk 25316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE. 2532c609719bSwdenk 25330e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 2534c609719bSwdenk 2535c609719bSwdenk This is just another way to specify the start address of 2536c609719bSwdenk the flash sector containing the environment (instead of 25370e8d1586SJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_OFFSET). 2538c609719bSwdenk 25390e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SECT_SIZE: 2540c609719bSwdenk 2541c609719bSwdenk Size of the sector containing the environment. 2542c609719bSwdenk 2543c609719bSwdenk 2544c609719bSwdenk b) Sometimes flash chips have few, equal sized, BIG sectors. 2545c609719bSwdenk In such a case you don't want to spend a whole sector for 2546c609719bSwdenk the environment. 2547c609719bSwdenk 25480e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 2549c609719bSwdenk 25505a1aceb0SJean-Christophe PLAGNIOL-VILLARD If you use this in combination with CONFIG_ENV_IS_IN_FLASH 25510e8d1586SJean-Christophe PLAGNIOL-VILLARD and CONFIG_ENV_SECT_SIZE, you can specify to use only a part 2552c609719bSwdenk of this flash sector for the environment. This saves 2553c609719bSwdenk memory for the RAM copy of the environment. 2554c609719bSwdenk 2555c609719bSwdenk It may also save flash memory if you decide to use this 2556c609719bSwdenk when your environment is "embedded" within U-Boot code, 2557c609719bSwdenk since then the remainder of the flash sector could be used 2558c609719bSwdenk for U-Boot code. It should be pointed out that this is 2559c609719bSwdenk STRONGLY DISCOURAGED from a robustness point of view: 2560c609719bSwdenk updating the environment in flash makes it always 2561c609719bSwdenk necessary to erase the WHOLE sector. If something goes 2562c609719bSwdenk wrong before the contents has been restored from a copy in 2563c609719bSwdenk RAM, your target system will be dead. 2564c609719bSwdenk 25650e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR_REDUND 25660e8d1586SJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_SIZE_REDUND 2567c609719bSwdenk 2568c609719bSwdenk These settings describe a second storage area used to hold 256911ccc33fSMarcel Ziswiler a redundant copy of the environment data, so that there is 25703e38691eSwdenk a valid backup copy in case there is a power failure during 2571c609719bSwdenk a "saveenv" operation. 2572c609719bSwdenk 2573c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the 2574c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds* 2575c609719bSwdenkaccordingly! 2576c609719bSwdenk 2577c609719bSwdenk 25789314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM: 2579c609719bSwdenk 2580c609719bSwdenk Define this if you have some non-volatile memory device 2581c609719bSwdenk (NVRAM, battery buffered SRAM) which you want to use for the 2582c609719bSwdenk environment. 2583c609719bSwdenk 25840e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 25850e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 2586c609719bSwdenk 258711ccc33fSMarcel Ziswiler These two #defines are used to determine the memory area you 2588c609719bSwdenk want to use for environment. It is assumed that this memory 2589c609719bSwdenk can just be read and written to, without any special 2590c609719bSwdenk provision. 2591c609719bSwdenk 2592c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early 2593c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the 259411ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or 2595c609719bSwdenkU-Boot will hang. 2596c609719bSwdenk 2597c609719bSwdenkPlease note that even with NVRAM we still use a copy of the 2598c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to 2599c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv" 2600c609719bSwdenkto save the current settings. 2601c609719bSwdenk 2602c609719bSwdenk 2603bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM: 2604c609719bSwdenk 2605c609719bSwdenk Use this if you have an EEPROM or similar serial access 2606c609719bSwdenk device and a driver for it. 2607c609719bSwdenk 26080e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 26090e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 2610c609719bSwdenk 2611c609719bSwdenk These two #defines specify the offset and size of the 2612c609719bSwdenk environment area within the total memory of your EEPROM. 2613c609719bSwdenk 26146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR: 2615c609719bSwdenk If defined, specified the chip address of the EEPROM device. 2616c609719bSwdenk The default address is zero. 2617c609719bSwdenk 26186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS: 2619c609719bSwdenk If defined, the number of bits used to address bytes in a 2620c609719bSwdenk single page in the EEPROM device. A 64 byte page, for example 2621c609719bSwdenk would require six bits. 2622c609719bSwdenk 26236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS: 2624c609719bSwdenk If defined, the number of milliseconds to delay between 2625c609719bSwdenk page writes. The default is zero milliseconds. 2626c609719bSwdenk 26276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR_LEN: 2628c609719bSwdenk The length in bytes of the EEPROM memory array address. Note 2629c609719bSwdenk that this is NOT the chip address length! 2630c609719bSwdenk 26316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW: 26325cf91d6bSwdenk EEPROM chips that implement "address overflow" are ones 26335cf91d6bSwdenk like Catalyst 24WC04/08/16 which has 9/10/11 bits of 26345cf91d6bSwdenk address and the extra bits end up in the "chip address" bit 26355cf91d6bSwdenk slots. This makes a 24WC08 (1Kbyte) chip look like four 256 26365cf91d6bSwdenk byte chips. 26375cf91d6bSwdenk 26385cf91d6bSwdenk Note that we consider the length of the address field to 26395cf91d6bSwdenk still be one byte because the extra address bits are hidden 26405cf91d6bSwdenk in the chip address. 26415cf91d6bSwdenk 26426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_SIZE: 2643c609719bSwdenk The size in bytes of the EEPROM device. 2644c609719bSwdenk 2645548738b4SHeiko Schocher - CONFIG_ENV_EEPROM_IS_ON_I2C 2646548738b4SHeiko Schocher define this, if you have I2C and SPI activated, and your 2647548738b4SHeiko Schocher EEPROM, which holds the environment, is on the I2C bus. 2648548738b4SHeiko Schocher 2649548738b4SHeiko Schocher - CONFIG_I2C_ENV_EEPROM_BUS 2650548738b4SHeiko Schocher if you have an Environment on an EEPROM reached over 2651548738b4SHeiko Schocher I2C muxes, you can define here, how to reach this 2652548738b4SHeiko Schocher EEPROM. For example: 2653548738b4SHeiko Schocher 2654548738b4SHeiko Schocher #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0" 2655548738b4SHeiko Schocher 2656548738b4SHeiko Schocher EEPROM which holds the environment, is reached over 2657548738b4SHeiko Schocher a pca9547 i2c mux with address 0x70, channel 3. 2658c609719bSwdenk 2659057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH: 26605779d8d9Swdenk 26615779d8d9Swdenk Define this if you have a DataFlash memory device which you 26625779d8d9Swdenk want to use for the environment. 26635779d8d9Swdenk 26640e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 26650e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 26660e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 26675779d8d9Swdenk 26685779d8d9Swdenk These three #defines specify the offset and size of the 26695779d8d9Swdenk environment area within the total memory of your DataFlash placed 26705779d8d9Swdenk at the specified address. 26715779d8d9Swdenk 267251bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND: 267313a5695bSwdenk 267413a5695bSwdenk Define this if you have a NAND device which you want to use 267513a5695bSwdenk for the environment. 267613a5695bSwdenk 26770e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 26780e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 267913a5695bSwdenk 268013a5695bSwdenk These two #defines specify the offset and size of the environment 2681fdd813deSScott Wood area within the first NAND device. CONFIG_ENV_OFFSET must be 2682fdd813deSScott Wood aligned to an erase block boundary. 26835779d8d9Swdenk 2684fdd813deSScott Wood - CONFIG_ENV_OFFSET_REDUND (optional): 2685e443c944SMarkus Klotzbuecher 26860e8d1586SJean-Christophe PLAGNIOL-VILLARD This setting describes a second storage area of CONFIG_ENV_SIZE 2687fdd813deSScott Wood size used to hold a redundant copy of the environment data, so 2688fdd813deSScott Wood that there is a valid backup copy in case there is a power failure 2689fdd813deSScott Wood during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be 2690fdd813deSScott Wood aligned to an erase block boundary. 2691e443c944SMarkus Klotzbuecher 2692fdd813deSScott Wood - CONFIG_ENV_RANGE (optional): 2693fdd813deSScott Wood 2694fdd813deSScott Wood Specifies the length of the region in which the environment 2695fdd813deSScott Wood can be written. This should be a multiple of the NAND device's 2696fdd813deSScott Wood block size. Specifying a range with more erase blocks than 2697fdd813deSScott Wood are needed to hold CONFIG_ENV_SIZE allows bad blocks within 2698fdd813deSScott Wood the range to be avoided. 2699fdd813deSScott Wood 2700fdd813deSScott Wood - CONFIG_ENV_OFFSET_OOB (optional): 2701fdd813deSScott Wood 2702fdd813deSScott Wood Enables support for dynamically retrieving the offset of the 2703fdd813deSScott Wood environment from block zero's out-of-band data. The 2704fdd813deSScott Wood "nand env.oob" command can be used to record this offset. 2705fdd813deSScott Wood Currently, CONFIG_ENV_OFFSET_REDUND is not supported when 2706fdd813deSScott Wood using CONFIG_ENV_OFFSET_OOB. 2707e443c944SMarkus Klotzbuecher 2708b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST 2709b74ab737SGuennadi Liakhovetski 2710b74ab737SGuennadi Liakhovetski Defines address in RAM to which the nand_spl code should copy the 2711b74ab737SGuennadi Liakhovetski environment. If redundant environment is used, it will be copied to 2712b74ab737SGuennadi Liakhovetski CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE. 2713b74ab737SGuennadi Liakhovetski 27146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET 2715c609719bSwdenk 2716c609719bSwdenk Defines offset to the initial SPI buffer area in DPRAM. The 2717c609719bSwdenk area is used at an early stage (ROM part) if the environment 2718c609719bSwdenk is configured to reside in the SPI EEPROM: We need a 520 byte 2719c609719bSwdenk scratch DPRAM area. It is used between the two initialization 2720c609719bSwdenk calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems 2721c609719bSwdenk to be a good choice since it makes it far enough from the 2722c609719bSwdenk start of the data area as well as from the stack pointer. 2723c609719bSwdenk 2724e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor 2725c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been 2726cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f() 2727c609719bSwdenkuntil then to read environment variables. 2728c609719bSwdenk 272985ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor 273085ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working 273185ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is 273285ec0bccSwdenknecessary, because the first environment variable we need is the 273385ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't 273485ec0bccSwdenkhave any device yet where we could complain.] 2735c609719bSwdenk 2736c609719bSwdenkNote: once the monitor has been relocated, then it will complain if 2737c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you 273885ec0bccSwdenkuse the "saveenv" command to store a valid environment. 2739c609719bSwdenk 27406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN: 2741fc3e2165Swdenk Echo the inverted Ethernet link state to the fault LED. 2742fc3e2165Swdenk 27436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR 2744fc3e2165Swdenk also needs to be defined. 2745fc3e2165Swdenk 27466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR: 2747fc3e2165Swdenk MII address of the PHY to check for the Ethernet link state. 2748c609719bSwdenk 2749f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS: 2750f5675aa5SRon Madrid Define this if you desire to only have use of the NS16550_init 2751f5675aa5SRon Madrid and NS16550_putc functions for the serial driver located at 2752f5675aa5SRon Madrid drivers/serial/ns16550.c. This option is useful for saving 2753f5675aa5SRon Madrid space for already greatly restricted images, including but not 2754f5675aa5SRon Madrid limited to NAND_SPL configurations. 2755f5675aa5SRon Madrid 2756c609719bSwdenkLow Level (hardware related) configuration options: 2757dc7c9a1aSwdenk--------------------------------------------------- 2758c609719bSwdenk 27596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE: 2760c609719bSwdenk Cache Line Size of the CPU. 2761c609719bSwdenk 27626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR: 2763c609719bSwdenk Default address of the IMMR after system reset. 27642535d602Swdenk 27652535d602Swdenk Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU, 27662535d602Swdenk and RPXsuper) to be able to adjust the position of 27672535d602Swdenk the IMMR register after a reset. 2768c609719bSwdenk 27697f6c2cbcSwdenk- Floppy Disk Support: 27706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FDC_DRIVE_NUMBER 27717f6c2cbcSwdenk 27727f6c2cbcSwdenk the default drive number (default value 0) 27737f6c2cbcSwdenk 27746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_ISA_IO_STRIDE 27757f6c2cbcSwdenk 277611ccc33fSMarcel Ziswiler defines the spacing between FDC chipset registers 27777f6c2cbcSwdenk (default value 1) 27787f6c2cbcSwdenk 27796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_ISA_IO_OFFSET 27807f6c2cbcSwdenk 27817f6c2cbcSwdenk defines the offset of register from address. It 27827f6c2cbcSwdenk depends on which part of the data bus is connected to 278311ccc33fSMarcel Ziswiler the FDC chipset. (default value 0) 27847f6c2cbcSwdenk 27856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and 27866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their 27877f6c2cbcSwdenk default value. 27887f6c2cbcSwdenk 27896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD if CONFIG_SYS_FDC_HW_INIT is defined, then the function 27907f6c2cbcSwdenk fdc_hw_init() is called at the beginning of the FDC 27917f6c2cbcSwdenk setup. fdc_hw_init() must be provided by the board 27927f6c2cbcSwdenk source code. It is used to make hardware dependant 27937f6c2cbcSwdenk initializations. 27947f6c2cbcSwdenk 27950abddf82SMacpaul Lin- CONFIG_IDE_AHB: 27960abddf82SMacpaul Lin Most IDE controllers were designed to be connected with PCI 27970abddf82SMacpaul Lin interface. Only few of them were designed for AHB interface. 27980abddf82SMacpaul Lin When software is doing ATA command and data transfer to 27990abddf82SMacpaul Lin IDE devices through IDE-AHB controller, some additional 28000abddf82SMacpaul Lin registers accessing to these kind of IDE-AHB controller 28010abddf82SMacpaul Lin is requierd. 28020abddf82SMacpaul Lin 28036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR: Physical address of the Internal Memory. 280425d6712aSwdenk DO NOT CHANGE unless you know exactly what you're 280525d6712aSwdenk doing! (11-4) [MPC8xx/82xx systems only] 2806c609719bSwdenk 28076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR: 2808c609719bSwdenk 28097152b1d0Swdenk Start address of memory area that can be used for 2810c609719bSwdenk initial data and stack; please note that this must be 2811c609719bSwdenk writable memory that is working WITHOUT special 2812c609719bSwdenk initialization, i. e. you CANNOT use normal RAM which 2813c609719bSwdenk will become available only after programming the 2814c609719bSwdenk memory controller and running certain initialization 2815c609719bSwdenk sequences. 2816c609719bSwdenk 2817c609719bSwdenk U-Boot uses the following memory types: 2818c609719bSwdenk - MPC8xx and MPC8260: IMMR (internal memory of the CPU) 2819c609719bSwdenk - MPC824X: data cache 2820c609719bSwdenk - PPC4xx: data cache 2821c609719bSwdenk 28226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET: 2823c609719bSwdenk 2824c609719bSwdenk Offset of the initial data structure in the memory 28256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually 28266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial 2827c609719bSwdenk data is located at the end of the available space 2828553f0982SWolfgang Denk (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE - 28296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just 28306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR + 28316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_GBL_DATA_OFFSET) downward. 2832c609719bSwdenk 2833c609719bSwdenk Note: 2834c609719bSwdenk On the MPC824X (or other systems that use the data 2835c609719bSwdenk cache for initial memory) the address chosen for 28366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must 2837c609719bSwdenk point to an otherwise UNUSED address space between 2838c609719bSwdenk the top of RAM and the start of the PCI space. 2839c609719bSwdenk 28406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6) 2841c609719bSwdenk 28426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR: System Protection Control (11-9) 2843c609719bSwdenk 28446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26) 2845c609719bSwdenk 28466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31) 2847c609719bSwdenk 28486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30) 2849c609719bSwdenk 28506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27) 2851c609719bSwdenk 28526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM: 2853c609719bSwdenk SDRAM timing 2854c609719bSwdenk 28556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA: 2856c609719bSwdenk periodic timer for refresh 2857c609719bSwdenk 28586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER: Debug Event Register (37-47) 2859c609719bSwdenk 28606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM, 28616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP, 28626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM, 28636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BR1_PRELIM: 2864c609719bSwdenk Memory Controller Definitions: BR0/1 and OR0/1 (FLASH) 2865c609719bSwdenk 2866c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE, 28676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM, 28686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM: 2869c609719bSwdenk Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM) 2870c609719bSwdenk 28716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K, 28726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL: 2873c609719bSwdenk Machine Mode Register and Memory Periodic Timer 2874c609719bSwdenk Prescaler definitions (SDRAM timing) 2875c609719bSwdenk 28766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]: 2877c609719bSwdenk enable I2C microcode relocation patch (MPC8xx); 2878c609719bSwdenk define relocation offset in DPRAM [DSP2] 2879c609719bSwdenk 28806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]: 2881b423d055SHeiko Schocher enable SMC microcode relocation patch (MPC8xx); 2882b423d055SHeiko Schocher define relocation offset in DPRAM [SMC1] 2883b423d055SHeiko Schocher 28846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]: 2885c609719bSwdenk enable SPI microcode relocation patch (MPC8xx); 2886c609719bSwdenk define relocation offset in DPRAM [SCC4] 2887c609719bSwdenk 28886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK: 2889c609719bSwdenk Use OSCM clock mode on MBX8xx board. Be careful, 2890c609719bSwdenk wrong setting might damage your board. Read 2891c609719bSwdenk doc/README.MBX before setting this variable! 2892c609719bSwdenk 28936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only) 2894ea909b76Swdenk Offset of the bootmode word in DPRAM used by post 2895ea909b76Swdenk (Power On Self Tests). This definition overrides 2896ea909b76Swdenk #define'd default value in commproc.h resp. 2897ea909b76Swdenk cpm_8260.h. 2898ea909b76Swdenk 28996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB, 29006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL, 29016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS, 29026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB, 29036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START, 29046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL, 29056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE, 29066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only) 2907a47a12beSStefan Roese Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set. 29085d232d0eSwdenk 29099cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE: 29109cacf4fcSDirk Eibach Disable PCI-Express on systems where it is supported but not 29119cacf4fcSDirk Eibach required. 29129cacf4fcSDirk Eibach 2913a09b9b68SKumar Gala- CONFIG_SYS_SRIO: 2914a09b9b68SKumar Gala Chip has SRIO or not 2915a09b9b68SKumar Gala 2916a09b9b68SKumar Gala- CONFIG_SRIO1: 2917a09b9b68SKumar Gala Board has SRIO 1 port available 2918a09b9b68SKumar Gala 2919a09b9b68SKumar Gala- CONFIG_SRIO2: 2920a09b9b68SKumar Gala Board has SRIO 2 port available 2921a09b9b68SKumar Gala 2922a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT: 2923a09b9b68SKumar Gala Virtual Address of SRIO port 'n' memory region 2924a09b9b68SKumar Gala 2925a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS: 2926a09b9b68SKumar Gala Physical Address of SRIO port 'n' memory region 2927a09b9b68SKumar Gala 2928a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE: 2929a09b9b68SKumar Gala Size of SRIO port 'n' memory region 2930a09b9b68SKumar Gala 2931eced4626SAlex Waterman- CONFIG_SYS_NDFC_16 2932eced4626SAlex Waterman Defined to tell the NDFC that the NAND chip is using a 2933eced4626SAlex Waterman 16 bit bus. 2934eced4626SAlex Waterman 2935eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG 2936eced4626SAlex Waterman Sets the EBC0_CFG register for the NDFC. If not defined 2937eced4626SAlex Waterman a default value will be used. 2938eced4626SAlex Waterman 2939bb99ad6dSBen Warren- CONFIG_SPD_EEPROM 2940218ca724SWolfgang Denk Get DDR timing information from an I2C EEPROM. Common 2941218ca724SWolfgang Denk with pluggable memory modules such as SODIMMs 2942218ca724SWolfgang Denk 2943bb99ad6dSBen Warren SPD_EEPROM_ADDRESS 2944bb99ad6dSBen Warren I2C address of the SPD EEPROM 2945bb99ad6dSBen Warren 29466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM 2947218ca724SWolfgang Denk If SPD EEPROM is on an I2C bus other than the first 2948218ca724SWolfgang Denk one, specify here. Note that the value must resolve 2949218ca724SWolfgang Denk to something your driver can deal with. 2950bb99ad6dSBen Warren 29516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0 2952218ca724SWolfgang Denk Only for 83xx systems. If specified, then DDR should 2953218ca724SWolfgang Denk be configured using CS0 and CS1 instead of CS2 and CS3. 29542ad6b513STimur Tabi 2955c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12] 2956c26e454dSwdenk Define to enable FEC[12] on a 8xx series processor. 2957c26e454dSwdenk 2958c26e454dSwdenk- CONFIG_FEC[12]_PHY 2959c26e454dSwdenk Define to the hardcoded PHY address which corresponds 29606e592385Swdenk to the given FEC; i. e. 2961c26e454dSwdenk #define CONFIG_FEC1_PHY 4 2962c26e454dSwdenk means that the PHY with address 4 is connected to FEC1 2963c26e454dSwdenk 2964c26e454dSwdenk When set to -1, means to probe for first available. 2965c26e454dSwdenk 2966c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR 2967c26e454dSwdenk The PHY does not have a RXERR line (RMII only). 2968c26e454dSwdenk (so program the FEC to ignore it). 2969c26e454dSwdenk 2970c26e454dSwdenk- CONFIG_RMII 2971c26e454dSwdenk Enable RMII mode for all FECs. 2972c26e454dSwdenk Note that this is a global option, we can't 2973c26e454dSwdenk have one FEC in standard MII mode and another in RMII mode. 2974c26e454dSwdenk 29755cf91d6bSwdenk- CONFIG_CRC32_VERIFY 29765cf91d6bSwdenk Add a verify option to the crc32 command. 29775cf91d6bSwdenk The syntax is: 29785cf91d6bSwdenk 29795cf91d6bSwdenk => crc32 -v <address> <count> <crc32> 29805cf91d6bSwdenk 29815cf91d6bSwdenk Where address/count indicate a memory area 29825cf91d6bSwdenk and crc32 is the correct crc32 which the 29835cf91d6bSwdenk area should have. 29845cf91d6bSwdenk 298556523f12Swdenk- CONFIG_LOOPW 298656523f12Swdenk Add the "loopw" memory command. This only takes effect if 2987602ad3b3SJon Loeliger the memory commands are activated globally (CONFIG_CMD_MEM). 298856523f12Swdenk 29897b466641Sstroese- CONFIG_MX_CYCLIC 29907b466641Sstroese Add the "mdc" and "mwc" memory commands. These are cyclic 29917b466641Sstroese "md/mw" commands. 29927b466641Sstroese Examples: 29937b466641Sstroese 29947b466641Sstroese => mdc.b 10 4 500 29957b466641Sstroese This command will print 4 bytes (10,11,12,13) each 500 ms. 29967b466641Sstroese 29977b466641Sstroese => mwc.l 100 12345678 10 29987b466641Sstroese This command will write 12345678 to address 100 all 10 ms. 29997b466641Sstroese 30007b466641Sstroese This only takes effect if the memory commands are activated 3001602ad3b3SJon Loeliger globally (CONFIG_CMD_MEM). 30027b466641Sstroese 30038aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT 3004e03f3169SWolfgang Denk [ARM only] If this variable is defined, then certain 3005e03f3169SWolfgang Denk low level initializations (like setting up the memory 3006e03f3169SWolfgang Denk controller) are omitted and/or U-Boot does not 3007e03f3169SWolfgang Denk relocate itself into RAM. 30088aa1a2d1Swdenk 3009e03f3169SWolfgang Denk Normally this variable MUST NOT be defined. The only 3010e03f3169SWolfgang Denk exception is when U-Boot is loaded (to RAM) by some 3011e03f3169SWolfgang Denk other boot loader or by a debugger which performs 3012e03f3169SWolfgang Denk these initializations itself. 30138aa1a2d1Swdenk 3014df81238bSMagnus Lilja- CONFIG_PRELOADER 3015df81238bSMagnus Lilja Modifies the behaviour of start.S when compiling a loader 3016df81238bSMagnus Lilja that is executed before the actual U-Boot. E.g. when 3017df81238bSMagnus Lilja compiling a NAND SPL. 3018400558b5Swdenk 3019d8834a13SMatthias Weisser- CONFIG_USE_ARCH_MEMCPY 3020d8834a13SMatthias Weisser CONFIG_USE_ARCH_MEMSET 3021d8834a13SMatthias Weisser If these options are used a optimized version of memcpy/memset will 3022d8834a13SMatthias Weisser be used if available. These functions may be faster under some 3023d8834a13SMatthias Weisser conditions but may increase the binary size. 3024d8834a13SMatthias Weisser 3025c609719bSwdenkBuilding the Software: 3026c609719bSwdenk====================== 3027c609719bSwdenk 3028218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments 3029218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support 3030218ca724SWolfgang Denkall possibly existing versions of cross development tools in all 3031218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we 3032218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK) 3033218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot. 3034c609719bSwdenk 3035218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you 3036218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case, 3037218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell. 3038218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are 3039218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter: 3040c609719bSwdenk 3041218ca724SWolfgang Denk $ CROSS_COMPILE=ppc_4xx- 3042218ca724SWolfgang Denk $ export CROSS_COMPILE 3043c609719bSwdenk 30442f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in 30452f8d396bSPeter Tyser the tools directory you can use the MinGW toolchain 30462f8d396bSPeter Tyser (http://www.mingw.org). Set your HOST tools to the MinGW 30472f8d396bSPeter Tyser toolchain and execute 'make tools'. For example: 30482f8d396bSPeter Tyser 30492f8d396bSPeter Tyser $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools 30502f8d396bSPeter Tyser 30512f8d396bSPeter Tyser Binaries such as tools/mkimage.exe will be created which can 30522f8d396bSPeter Tyser be executed on computers running Windows. 30532f8d396bSPeter Tyser 3054c609719bSwdenkU-Boot is intended to be simple to build. After installing the 3055c609719bSwdenksources you must configure U-Boot for one specific board type. This 3056c609719bSwdenkis done by typing: 3057c609719bSwdenk 3058c609719bSwdenk make NAME_config 3059c609719bSwdenk 3060218ca724SWolfgang Denkwhere "NAME_config" is the name of one of the existing configu- 3061218ca724SWolfgang Denkrations; see the main Makefile for supported names. 306254387ac9Swdenk 3063c609719bSwdenkNote: for some board special configuration names may exist; check if 3064c609719bSwdenk additional information is available from the board vendor; for 30652729af9dSwdenk instance, the TQM823L systems are available without (standard) 30662729af9dSwdenk or with LCD support. You can select such additional "features" 306711ccc33fSMarcel Ziswiler when choosing the configuration, i. e. 3068c609719bSwdenk 30692729af9dSwdenk make TQM823L_config 30702729af9dSwdenk - will configure for a plain TQM823L, i. e. no LCD support 3071c609719bSwdenk 3072c609719bSwdenk make TQM823L_LCD_config 3073c609719bSwdenk - will configure for a TQM823L with U-Boot console on LCD 3074c609719bSwdenk 3075c609719bSwdenk etc. 3076c609719bSwdenk 3077c609719bSwdenk 3078c609719bSwdenkFinally, type "make all", and you should get some working U-Boot 30797152b1d0Swdenkimages ready for download to / installation on your system: 3080c609719bSwdenk 3081c609719bSwdenk- "u-boot.bin" is a raw binary image 3082c609719bSwdenk- "u-boot" is an image in ELF binary format 3083c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format 3084c609719bSwdenk 3085baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved 3086baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change 3087baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory: 3088baf31249SMarian Balakowicz 3089baf31249SMarian Balakowicz1. Add O= to the make command line invocations: 3090baf31249SMarian Balakowicz 3091baf31249SMarian Balakowicz make O=/tmp/build distclean 3092baf31249SMarian Balakowicz make O=/tmp/build NAME_config 3093baf31249SMarian Balakowicz make O=/tmp/build all 3094baf31249SMarian Balakowicz 3095baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location: 3096baf31249SMarian Balakowicz 3097baf31249SMarian Balakowicz export BUILD_DIR=/tmp/build 3098baf31249SMarian Balakowicz make distclean 3099baf31249SMarian Balakowicz make NAME_config 3100baf31249SMarian Balakowicz make all 3101baf31249SMarian Balakowicz 3102baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment 3103baf31249SMarian Balakowiczvariable. 3104baf31249SMarian Balakowicz 3105c609719bSwdenk 3106c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so 3107c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of 3108c609719bSwdenknative "make". 3109c609719bSwdenk 3110c609719bSwdenk 3111c609719bSwdenkIf the system board that you have is not listed, then you will need 3112c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these 3113c609719bSwdenksteps: 3114c609719bSwdenk 3115c609719bSwdenk1. Add a new configuration option for your board to the toplevel 311685ec0bccSwdenk "Makefile" and to the "MAKEALL" script, using the existing 311785ec0bccSwdenk entries as examples. Note that here and at many other places 31187152b1d0Swdenk boards and other names are listed in alphabetical sort order. Please 311985ec0bccSwdenk keep this order. 3120c609719bSwdenk2. Create a new directory to hold your board specific code. Add any 312185ec0bccSwdenk files you need. In your board directory, you will need at least 312285ec0bccSwdenk the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds". 312385ec0bccSwdenk3. Create a new configuration file "include/configs/<board>.h" for 312485ec0bccSwdenk your board 3125c609719bSwdenk3. If you're porting U-Boot to a new CPU, then also create a new 3126c609719bSwdenk directory to hold your CPU specific code. Add any files you need. 312785ec0bccSwdenk4. Run "make <board>_config" with your new name. 3128c609719bSwdenk5. Type "make", and you should get a working "u-boot.srec" file 3129c609719bSwdenk to be installed on your target system. 313085ec0bccSwdenk6. Debug and solve any problems that might arise. 3131c609719bSwdenk [Of course, this last step is much harder than it sounds.] 3132c609719bSwdenk 3133c609719bSwdenk 3134c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.: 3135c609719bSwdenk============================================================== 3136c609719bSwdenk 3137c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board 3138c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to 3139c609719bSwdenkprovide feedback to the other developers. The feedback normally takes 3140c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest 3141218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources. 3142c609719bSwdenk 3143c609719bSwdenkBut before you submit such a patch, please verify that your modifi- 3144c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of 3145c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so, 3146c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot 3147c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can 31487152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE' 3149218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools 3150218ca724SWolfgang Denkyou can type 3151c609719bSwdenk 3152c609719bSwdenk CROSS_COMPILE=ppc_8xx- MAKEALL 3153c609719bSwdenk 3154c609719bSwdenkor to build on a native PowerPC system you can type 3155c609719bSwdenk 3156c609719bSwdenk CROSS_COMPILE=' ' MAKEALL 3157c609719bSwdenk 3158218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build 3159218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by 3160218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target 3161218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and 3162218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default 3163218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment 3164218ca724SWolfgang Denkvariable. For example: 3165baf31249SMarian Balakowicz 3166baf31249SMarian Balakowicz export BUILD_DIR=/tmp/build 3167baf31249SMarian Balakowicz export MAKEALL_LOGDIR=/tmp/log 3168baf31249SMarian Balakowicz CROSS_COMPILE=ppc_8xx- MAKEALL 3169baf31249SMarian Balakowicz 3170218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build, 3171218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean 3172218ca724SWolfgang Denkduring the whole build process. 3173baf31249SMarian Balakowicz 3174baf31249SMarian Balakowicz 3175c609719bSwdenkSee also "U-Boot Porting Guide" below. 3176c609719bSwdenk 3177c609719bSwdenk 3178c609719bSwdenkMonitor Commands - Overview: 3179c609719bSwdenk============================ 3180c609719bSwdenk 3181c609719bSwdenkgo - start application at address 'addr' 3182c609719bSwdenkrun - run commands in an environment variable 3183c609719bSwdenkbootm - boot application image from memory 3184c609719bSwdenkbootp - boot image via network using BootP/TFTP protocol 3185c609719bSwdenktftpboot- boot image via network using TFTP protocol 3186c609719bSwdenk and env variables "ipaddr" and "serverip" 3187c609719bSwdenk (and eventually "gatewayip") 3188c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol 3189c609719bSwdenkdiskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd' 3190c609719bSwdenkloads - load S-Record file over serial line 3191c609719bSwdenkloadb - load binary file over serial line (kermit mode) 3192c609719bSwdenkmd - memory display 3193c609719bSwdenkmm - memory modify (auto-incrementing) 3194c609719bSwdenknm - memory modify (constant address) 3195c609719bSwdenkmw - memory write (fill) 3196c609719bSwdenkcp - memory copy 3197c609719bSwdenkcmp - memory compare 3198c609719bSwdenkcrc32 - checksum calculation 31990f89c54bSPeter Tyseri2c - I2C sub-system 3200c609719bSwdenksspi - SPI utility commands 3201c609719bSwdenkbase - print or set address offset 3202c609719bSwdenkprintenv- print environment variables 3203c609719bSwdenksetenv - set environment variables 3204c609719bSwdenksaveenv - save environment variables to persistent storage 3205c609719bSwdenkprotect - enable or disable FLASH write protection 3206c609719bSwdenkerase - erase FLASH memory 3207c609719bSwdenkflinfo - print FLASH memory information 3208c609719bSwdenkbdinfo - print Board Info structure 3209c609719bSwdenkiminfo - print header information for application image 3210c609719bSwdenkconinfo - print console devices and informations 3211c609719bSwdenkide - IDE sub-system 3212c609719bSwdenkloop - infinite loop on address range 321356523f12Swdenkloopw - infinite write loop on address range 3214c609719bSwdenkmtest - simple RAM test 3215c609719bSwdenkicache - enable or disable instruction cache 3216c609719bSwdenkdcache - enable or disable data cache 3217c609719bSwdenkreset - Perform RESET of the CPU 3218c609719bSwdenkecho - echo args to console 3219c609719bSwdenkversion - print monitor version 3220c609719bSwdenkhelp - print online help 3221c609719bSwdenk? - alias for 'help' 3222c609719bSwdenk 3223c609719bSwdenk 3224c609719bSwdenkMonitor Commands - Detailed Description: 3225c609719bSwdenk======================================== 3226c609719bSwdenk 3227c609719bSwdenkTODO. 3228c609719bSwdenk 3229c609719bSwdenkFor now: just type "help <command>". 3230c609719bSwdenk 3231c609719bSwdenk 3232c609719bSwdenkEnvironment Variables: 3233c609719bSwdenk====================== 3234c609719bSwdenk 3235c609719bSwdenkU-Boot supports user configuration using Environment Variables which 3236c609719bSwdenkcan be made persistent by saving to Flash memory. 3237c609719bSwdenk 3238c609719bSwdenkEnvironment Variables are set using "setenv", printed using 3239c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv" 3240c609719bSwdenkwithout a value can be used to delete a variable from the 3241c609719bSwdenkenvironment. As long as you don't save the environment you are 3242c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the 3243c609719bSwdenkenvironment is erased by accident, a default environment is provided. 3244c609719bSwdenk 3245c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables. 3246c96f86eeSWolfgang Denk 3247c96f86eeSWolfgang DenkList of environment variables (most likely not complete): 3248c609719bSwdenk 3249c609719bSwdenk baudrate - see CONFIG_BAUDRATE 3250c609719bSwdenk 3251c609719bSwdenk bootdelay - see CONFIG_BOOTDELAY 3252c609719bSwdenk 3253c609719bSwdenk bootcmd - see CONFIG_BOOTCOMMAND 3254c609719bSwdenk 3255c609719bSwdenk bootargs - Boot arguments when booting an RTOS image 3256c609719bSwdenk 3257c609719bSwdenk bootfile - Name of the image to load with TFTP 3258c609719bSwdenk 32597d721e34SBartlomiej Sieka bootm_low - Memory range available for image processing in the bootm 32607d721e34SBartlomiej Sieka command can be restricted. This variable is given as 32617d721e34SBartlomiej Sieka a hexadecimal number and defines lowest address allowed 32627d721e34SBartlomiej Sieka for use by the bootm command. See also "bootm_size" 32637d721e34SBartlomiej Sieka environment variable. Address defined by "bootm_low" is 32647d721e34SBartlomiej Sieka also the base of the initial memory mapping for the Linux 3265c3624e6eSGrant Likely kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and 3266c3624e6eSGrant Likely bootm_mapsize. 3267c3624e6eSGrant Likely 3268c3624e6eSGrant Likely bootm_mapsize - Size of the initial memory mapping for the Linux kernel. 3269c3624e6eSGrant Likely This variable is given as a hexadecimal number and it 3270c3624e6eSGrant Likely defines the size of the memory region starting at base 3271c3624e6eSGrant Likely address bootm_low that is accessible by the Linux kernel 3272c3624e6eSGrant Likely during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used 3273c3624e6eSGrant Likely as the default value if it is defined, and bootm_size is 3274c3624e6eSGrant Likely used otherwise. 32757d721e34SBartlomiej Sieka 32767d721e34SBartlomiej Sieka bootm_size - Memory range available for image processing in the bootm 32777d721e34SBartlomiej Sieka command can be restricted. This variable is given as 32787d721e34SBartlomiej Sieka a hexadecimal number and defines the size of the region 32797d721e34SBartlomiej Sieka allowed for use by the bootm command. See also "bootm_low" 32807d721e34SBartlomiej Sieka environment variable. 32817d721e34SBartlomiej Sieka 32824bae9090SBartlomiej Sieka updatefile - Location of the software update file on a TFTP server, used 32834bae9090SBartlomiej Sieka by the automatic software update feature. Please refer to 32844bae9090SBartlomiej Sieka documentation in doc/README.update for more details. 32854bae9090SBartlomiej Sieka 3286c609719bSwdenk autoload - if set to "no" (any string beginning with 'n'), 3287c609719bSwdenk "bootp" will just load perform a lookup of the 3288c609719bSwdenk configuration from the BOOTP server, but not try to 3289c609719bSwdenk load any image using TFTP 3290c609719bSwdenk 3291c609719bSwdenk autostart - if set to "yes", an image loaded using the "bootp", 3292c609719bSwdenk "rarpboot", "tftpboot" or "diskboot" commands will 3293c609719bSwdenk be automatically started (by internally calling 3294c609719bSwdenk "bootm") 3295c609719bSwdenk 32964a6fd34bSwdenk If set to "no", a standalone image passed to the 32974a6fd34bSwdenk "bootm" command will be copied to the load address 32984a6fd34bSwdenk (and eventually uncompressed), but NOT be started. 32994a6fd34bSwdenk This can be used to load and uncompress arbitrary 33004a6fd34bSwdenk data. 33014a6fd34bSwdenk 330217ea1177Swdenk i2cfast - (PPC405GP|PPC405EP only) 330317ea1177Swdenk if set to 'y' configures Linux I2C driver for fast 330417ea1177Swdenk mode (400kHZ). This environment variable is used in 330517ea1177Swdenk initialization code. So, for changes to be effective 330617ea1177Swdenk it must be saved and board must be reset. 330717ea1177Swdenk 3308c609719bSwdenk initrd_high - restrict positioning of initrd images: 3309c609719bSwdenk If this variable is not set, initrd images will be 3310c609719bSwdenk copied to the highest possible address in RAM; this 3311c609719bSwdenk is usually what you want since it allows for 3312c609719bSwdenk maximum initrd size. If for some reason you want to 3313c609719bSwdenk make sure that the initrd image is loaded below the 33146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BOOTMAPSZ limit, you can set this environment 3315c609719bSwdenk variable to a value of "no" or "off" or "0". 3316c609719bSwdenk Alternatively, you can set it to a maximum upper 3317c609719bSwdenk address to use (U-Boot will still check that it 3318c609719bSwdenk does not overwrite the U-Boot stack and data). 3319c609719bSwdenk 3320c609719bSwdenk For instance, when you have a system with 16 MB 33217152b1d0Swdenk RAM, and want to reserve 4 MB from use by Linux, 3322c609719bSwdenk you can do this by adding "mem=12M" to the value of 3323c609719bSwdenk the "bootargs" variable. However, now you must make 33247152b1d0Swdenk sure that the initrd image is placed in the first 3325c609719bSwdenk 12 MB as well - this can be done with 3326c609719bSwdenk 3327c609719bSwdenk setenv initrd_high 00c00000 3328c609719bSwdenk 332938b99261Swdenk If you set initrd_high to 0xFFFFFFFF, this is an 333038b99261Swdenk indication to U-Boot that all addresses are legal 333138b99261Swdenk for the Linux kernel, including addresses in flash 333238b99261Swdenk memory. In this case U-Boot will NOT COPY the 333338b99261Swdenk ramdisk at all. This may be useful to reduce the 333438b99261Swdenk boot time on your system, but requires that this 333538b99261Swdenk feature is supported by your Linux kernel. 333638b99261Swdenk 3337c609719bSwdenk ipaddr - IP address; needed for tftpboot command 3338c609719bSwdenk 3339c609719bSwdenk loadaddr - Default load address for commands like "bootp", 3340dc7c9a1aSwdenk "rarpboot", "tftpboot", "loadb" or "diskboot" 3341c609719bSwdenk 3342c609719bSwdenk loads_echo - see CONFIG_LOADS_ECHO 3343c609719bSwdenk 3344c609719bSwdenk serverip - TFTP server IP address; needed for tftpboot command 3345c609719bSwdenk 3346c609719bSwdenk bootretry - see CONFIG_BOOT_RETRY_TIME 3347c609719bSwdenk 3348c609719bSwdenk bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR 3349c609719bSwdenk 3350c609719bSwdenk bootstopkey - see CONFIG_AUTOBOOT_STOP_STR 3351c609719bSwdenk 3352a3d991bdSwdenk ethprime - When CONFIG_NET_MULTI is enabled controls which 3353a3d991bdSwdenk interface is used first. 3354a3d991bdSwdenk 3355a3d991bdSwdenk ethact - When CONFIG_NET_MULTI is enabled controls which 3356a3d991bdSwdenk interface is currently active. For example you 3357a3d991bdSwdenk can do the following 3358a3d991bdSwdenk 335948690d80SHeiko Schocher => setenv ethact FEC 336048690d80SHeiko Schocher => ping 192.168.0.1 # traffic sent on FEC 336148690d80SHeiko Schocher => setenv ethact SCC 336248690d80SHeiko Schocher => ping 10.0.0.1 # traffic sent on SCC 3363a3d991bdSwdenk 3364e1692577SMatthias Fuchs ethrotate - When set to "no" U-Boot does not go through all 3365e1692577SMatthias Fuchs available network interfaces. 3366e1692577SMatthias Fuchs It just stays at the currently selected interface. 3367e1692577SMatthias Fuchs 3368a3d991bdSwdenk netretry - When set to "no" each network operation will 3369a3d991bdSwdenk either succeed or fail without retrying. 33706e592385Swdenk When set to "once" the network operation will 33716e592385Swdenk fail when all the available network interfaces 33726e592385Swdenk are tried once without success. 3373a3d991bdSwdenk Useful on scripts which control the retry operation 3374a3d991bdSwdenk themselves. 3375a3d991bdSwdenk 3376b4e2f89dSJean-Christophe PLAGNIOL-VILLARD npe_ucode - set load address for the NPE microcode 3377a1cf027aSJean-Christophe PLAGNIOL-VILLARD 337828cb9375SWolfgang Denk tftpsrcport - If this is set, the value is used for TFTP's 3379ecb0ccd9SWolfgang Denk UDP source port. 3380ecb0ccd9SWolfgang Denk 338128cb9375SWolfgang Denk tftpdstport - If this is set, the value is used for TFTP's UDP 338228cb9375SWolfgang Denk destination port instead of the Well Know Port 69. 338328cb9375SWolfgang Denk 3384c96f86eeSWolfgang Denk tftpblocksize - Block size to use for TFTP transfers; if not set, 3385c96f86eeSWolfgang Denk we use the TFTP server's default block size 3386c96f86eeSWolfgang Denk 3387c96f86eeSWolfgang Denk tftptimeout - Retransmission timeout for TFTP packets (in milli- 3388c96f86eeSWolfgang Denk seconds, minimum value is 1000 = 1 second). Defines 3389c96f86eeSWolfgang Denk when a packet is considered to be lost so it has to 3390c96f86eeSWolfgang Denk be retransmitted. The default is 5000 = 5 seconds. 3391c96f86eeSWolfgang Denk Lowering this value may make downloads succeed 3392c96f86eeSWolfgang Denk faster in networks with high packet loss rates or 3393c96f86eeSWolfgang Denk with unreliable TFTP servers. 3394c96f86eeSWolfgang Denk 3395a3d991bdSwdenk vlan - When set to a value < 4095 the traffic over 339611ccc33fSMarcel Ziswiler Ethernet is encapsulated/received over 802.1q 3397a3d991bdSwdenk VLAN tagged frames. 3398c609719bSwdenk 3399c609719bSwdenkThe following environment variables may be used and automatically 3400c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"), 3401c609719bSwdenkdepending the information provided by your boot server: 3402c609719bSwdenk 3403c609719bSwdenk bootfile - see above 3404c609719bSwdenk dnsip - IP address of your Domain Name Server 3405fe389a82Sstroese dnsip2 - IP address of your secondary Domain Name Server 3406c609719bSwdenk gatewayip - IP address of the Gateway (Router) to use 3407c609719bSwdenk hostname - Target hostname 3408c609719bSwdenk ipaddr - see above 3409c609719bSwdenk netmask - Subnet Mask 3410c609719bSwdenk rootpath - Pathname of the root filesystem on the NFS server 3411c609719bSwdenk serverip - see above 3412c609719bSwdenk 3413c609719bSwdenk 3414c609719bSwdenkThere are two special Environment Variables: 3415c609719bSwdenk 3416c609719bSwdenk serial# - contains hardware identification information such 3417c609719bSwdenk as type string and/or serial number 3418c609719bSwdenk ethaddr - Ethernet address 3419c609719bSwdenk 3420c609719bSwdenkThese variables can be set only once (usually during manufacturing of 3421c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables 3422c609719bSwdenkonce they have been set once. 3423c609719bSwdenk 3424c609719bSwdenk 3425c1551ea8SstroeseFurther special Environment Variables: 3426c1551ea8Sstroese 3427c1551ea8Sstroese ver - Contains the U-Boot version string as printed 3428c1551ea8Sstroese with the "version" command. This variable is 3429c1551ea8Sstroese readonly (see CONFIG_VERSION_VARIABLE). 3430c1551ea8Sstroese 3431c1551ea8Sstroese 3432c609719bSwdenkPlease note that changes to some configuration parameters may take 3433c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-). 3434c609719bSwdenk 3435c609719bSwdenk 3436f07771ccSwdenkCommand Line Parsing: 3437f07771ccSwdenk===================== 3438f07771ccSwdenk 3439f07771ccSwdenkThere are two different command line parsers available with U-Boot: 34407152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell: 3441f07771ccSwdenk 3442f07771ccSwdenkOld, simple command line parser: 3443f07771ccSwdenk-------------------------------- 3444f07771ccSwdenk 3445f07771ccSwdenk- supports environment variables (through setenv / saveenv commands) 3446f07771ccSwdenk- several commands on one line, separated by ';' 3447fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax 3448f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\', 3449f07771ccSwdenk for example: 3450fe126d8bSWolfgang Denk setenv bootcmd bootm \${address} 3451f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example: 3452f07771ccSwdenk setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off' 3453f07771ccSwdenk 3454f07771ccSwdenkHush shell: 3455f07771ccSwdenk----------- 3456f07771ccSwdenk 3457f07771ccSwdenk- similar to Bourne shell, with control structures like 3458f07771ccSwdenk if...then...else...fi, for...do...done; while...do...done, 3459f07771ccSwdenk until...do...done, ... 3460f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv 3461f07771ccSwdenk commands) and local shell variables (through standard shell syntax 3462f07771ccSwdenk "name=value"); only environment variables can be used with "run" 3463f07771ccSwdenk command 3464f07771ccSwdenk 3465f07771ccSwdenkGeneral rules: 3466f07771ccSwdenk-------------- 3467f07771ccSwdenk 3468f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run" 3469f07771ccSwdenk command) contains several commands separated by semicolon, and 3470f07771ccSwdenk one of these commands fails, then the remaining commands will be 3471f07771ccSwdenk executed anyway. 3472f07771ccSwdenk 3473f07771ccSwdenk(2) If you execute several variables with one call to run (i. e. 347411ccc33fSMarcel Ziswiler calling run with a list of variables as arguments), any failing 3475f07771ccSwdenk command will cause "run" to terminate, i. e. the remaining 3476f07771ccSwdenk variables are not executed. 3477f07771ccSwdenk 3478c609719bSwdenkNote for Redundant Ethernet Interfaces: 3479c609719bSwdenk======================================= 3480c609719bSwdenk 348111ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports 3482c609719bSwdenksuch configurations and is capable of automatic selection of a 34837152b1d0Swdenk"working" interface when needed. MAC assignment works as follows: 3484c609719bSwdenk 3485c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding 3486c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0), 3487c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ... 3488c609719bSwdenk 3489c609719bSwdenkIf the network interface stores some valid MAC address (for instance 3490c609719bSwdenkin SROM), this is used as default address if there is NO correspon- 3491c609719bSwdenkding setting in the environment; if the corresponding environment 3492c609719bSwdenkvariable is set, this overrides the settings in the card; that means: 3493c609719bSwdenk 3494c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the 3495c609719bSwdenk environment, the SROM's address is used. 3496c609719bSwdenk 3497c609719bSwdenko If there is no valid address in the SROM, and a definition in the 3498c609719bSwdenk environment exists, then the value from the environment variable is 3499c609719bSwdenk used. 3500c609719bSwdenk 3501c609719bSwdenko If both the SROM and the environment contain a MAC address, and 3502c609719bSwdenk both addresses are the same, this MAC address is used. 3503c609719bSwdenk 3504c609719bSwdenko If both the SROM and the environment contain a MAC address, and the 3505c609719bSwdenk addresses differ, the value from the environment is used and a 3506c609719bSwdenk warning is printed. 3507c609719bSwdenk 3508c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error 3509c609719bSwdenk is raised. 3510c609719bSwdenk 3511ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses 3512ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process. This 3513ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable. 3514ecee9324SBen WarrenThe naming convention is as follows: 3515ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc. 3516c609719bSwdenk 3517c609719bSwdenkImage Formats: 3518c609719bSwdenk============== 3519c609719bSwdenk 35203310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on) 35213310c549SMarian Balakowiczimages in two formats: 35223310c549SMarian Balakowicz 35233310c549SMarian BalakowiczNew uImage format (FIT) 35243310c549SMarian Balakowicz----------------------- 35253310c549SMarian Balakowicz 35263310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar 35273310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple 35283310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by 35293310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory. 35303310c549SMarian Balakowicz 35313310c549SMarian Balakowicz 35323310c549SMarian BalakowiczOld uImage format 35333310c549SMarian Balakowicz----------------- 35343310c549SMarian Balakowicz 35353310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything, 35363310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for 35373310c549SMarian Balakowiczdetails; basically, the header defines the following image properties: 3538c609719bSwdenk 3539c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD, 3540c609719bSwdenk 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks, 3541f5ed9e39SPeter Tyser LynxOS, pSOS, QNX, RTEMS, INTEGRITY; 3542f5ed9e39SPeter Tyser Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS, 3543f5ed9e39SPeter Tyser INTEGRITY). 35447b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86, 35451117cbf2SThomas Chou IA64, MIPS, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit; 35461117cbf2SThomas Chou Currently supported: ARM, AVR32, Intel x86, MIPS, Nios II, PowerPC). 3547c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2) 3548c609719bSwdenk* Load Address 3549c609719bSwdenk* Entry Point 3550c609719bSwdenk* Image Name 3551c609719bSwdenk* Image Timestamp 3552c609719bSwdenk 3553c609719bSwdenkThe header is marked by a special Magic Number, and both the header 3554c609719bSwdenkand the data portions of the image are secured against corruption by 3555c609719bSwdenkCRC32 checksums. 3556c609719bSwdenk 3557c609719bSwdenk 3558c609719bSwdenkLinux Support: 3559c609719bSwdenk============== 3560c609719bSwdenk 3561c609719bSwdenkAlthough U-Boot should support any OS or standalone application 35627152b1d0Swdenkeasily, the main focus has always been on Linux during the design of 3563c609719bSwdenkU-Boot. 3564c609719bSwdenk 3565c609719bSwdenkU-Boot includes many features that so far have been part of some 3566c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any 3567c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image; 3568c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation 35697152b1d0Swdenkserves several purposes: 3570c609719bSwdenk 3571c609719bSwdenk- the same features can be used for other OS or standalone 3572c609719bSwdenk applications (for instance: using compressed images to reduce the 3573c609719bSwdenk Flash memory footprint) 3574c609719bSwdenk 3575c609719bSwdenk- it becomes much easier to port new Linux kernel versions because 35767152b1d0Swdenk lots of low-level, hardware dependent stuff are done by U-Boot 3577c609719bSwdenk 3578c609719bSwdenk- the same Linux kernel image can now be used with different "initrd" 3579c609719bSwdenk images; of course this also means that different kernel images can 3580c609719bSwdenk be run with the same "initrd". This makes testing easier (you don't 3581c609719bSwdenk have to build a new "zImage.initrd" Linux image when you just 3582c609719bSwdenk change a file in your "initrd"). Also, a field-upgrade of the 3583c609719bSwdenk software is easier now. 3584c609719bSwdenk 3585c609719bSwdenk 3586c609719bSwdenkLinux HOWTO: 3587c609719bSwdenk============ 3588c609719bSwdenk 3589c609719bSwdenkPorting Linux to U-Boot based systems: 3590c609719bSwdenk--------------------------------------- 3591c609719bSwdenk 3592c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to 3593c609719bSwdenkconfigure the Linux device drivers for use with your target hardware 3594c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to 3595c609719bSwdenkLinux :-). 3596c609719bSwdenk 3597a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot). 3598c609719bSwdenk 3599c609719bSwdenkJust make sure your machine specific header file (for instance 3600c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board 36011dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h, 36021dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value 36036d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR. 3604c609719bSwdenk 3605c609719bSwdenk 3606c609719bSwdenkConfiguring the Linux kernel: 3607c609719bSwdenk----------------------------- 3608c609719bSwdenk 3609c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root 3610c609719bSwdenkdevice (initial ramdisk, NFS) for your target system. 3611c609719bSwdenk 3612c609719bSwdenk 3613c609719bSwdenkBuilding a Linux Image: 3614c609719bSwdenk----------------------- 3615c609719bSwdenk 361624ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are 361724ee89b9Swdenknot used. If you use recent kernel source, a new build target 361824ee89b9Swdenk"uImage" will exist which automatically builds an image usable by 361924ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target, 362024ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a 362124ee89b9Swdenk100% compatible format. 3622c609719bSwdenk 3623c609719bSwdenkExample: 3624c609719bSwdenk 3625c609719bSwdenk make TQM850L_config 3626c609719bSwdenk make oldconfig 3627c609719bSwdenk make dep 362824ee89b9Swdenk make uImage 3629c609719bSwdenk 363024ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to 363124ee89b9Swdenkencapsulate a compressed Linux kernel image with header information, 363224ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing: 3633c609719bSwdenk 363424ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format): 363524ee89b9Swdenk 363624ee89b9Swdenk* convert the kernel into a raw binary image: 363724ee89b9Swdenk 363824ee89b9Swdenk ${CROSS_COMPILE}-objcopy -O binary \ 363924ee89b9Swdenk -R .note -R .comment \ 364024ee89b9Swdenk -S vmlinux linux.bin 364124ee89b9Swdenk 364224ee89b9Swdenk* compress the binary image: 364324ee89b9Swdenk 364424ee89b9Swdenk gzip -9 linux.bin 364524ee89b9Swdenk 364624ee89b9Swdenk* package compressed binary image for U-Boot: 364724ee89b9Swdenk 364824ee89b9Swdenk mkimage -A ppc -O linux -T kernel -C gzip \ 364924ee89b9Swdenk -a 0 -e 0 -n "Linux Kernel Image" \ 365024ee89b9Swdenk -d linux.bin.gz uImage 365124ee89b9Swdenk 365224ee89b9Swdenk 365324ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use 365424ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or 365524ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64 365624ee89b9Swdenkbyte header containing information about target architecture, 365724ee89b9Swdenkoperating system, image type, compression method, entry points, time 365824ee89b9Swdenkstamp, CRC32 checksums, etc. 365924ee89b9Swdenk 366024ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and 366124ee89b9Swdenkprint the header information, or to build new images. 3662c609719bSwdenk 3663c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information 3664c609719bSwdenkcontained in the header of an existing U-Boot image; this includes 3665c609719bSwdenkchecksum verification: 3666c609719bSwdenk 3667c609719bSwdenk tools/mkimage -l image 3668c609719bSwdenk -l ==> list image header information 3669c609719bSwdenk 3670c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image 3671c609719bSwdenkfrom a "data file" which is used as image payload: 3672c609719bSwdenk 3673c609719bSwdenk tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \ 3674c609719bSwdenk -n name -d data_file image 3675c609719bSwdenk -A ==> set architecture to 'arch' 3676c609719bSwdenk -O ==> set operating system to 'os' 3677c609719bSwdenk -T ==> set image type to 'type' 3678c609719bSwdenk -C ==> set compression type 'comp' 3679c609719bSwdenk -a ==> set load address to 'addr' (hex) 3680c609719bSwdenk -e ==> set entry point to 'ep' (hex) 3681c609719bSwdenk -n ==> set image name to 'name' 3682c609719bSwdenk -d ==> use image data from 'datafile' 3683c609719bSwdenk 368469459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load 368569459791Swdenkaddress (0x00000000), but the entry point address depends on the 368669459791Swdenkkernel version: 3687c609719bSwdenk 3688c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C, 368924ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000. 3690c609719bSwdenk 3691c609719bSwdenkSo a typical call to build a U-Boot image would read: 3692c609719bSwdenk 369324ee89b9Swdenk -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 369424ee89b9Swdenk > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \ 3695a47a12beSStefan Roese > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \ 369624ee89b9Swdenk > examples/uImage.TQM850L 369724ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 3698c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 3699c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 3700c609719bSwdenk Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 3701c609719bSwdenk Load Address: 0x00000000 370224ee89b9Swdenk Entry Point: 0x00000000 3703c609719bSwdenk 3704c609719bSwdenkTo verify the contents of the image (or check for corruption): 3705c609719bSwdenk 370624ee89b9Swdenk -> tools/mkimage -l examples/uImage.TQM850L 370724ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 3708c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 3709c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 3710c609719bSwdenk Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 3711c609719bSwdenk Load Address: 0x00000000 371224ee89b9Swdenk Entry Point: 0x00000000 3713c609719bSwdenk 3714c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade 3715c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this 3716c609719bSwdenkneeds more space in Flash, but boots much faster since it does not 3717c609719bSwdenkneed to be uncompressed: 3718c609719bSwdenk 3719a47a12beSStefan Roese -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz 372024ee89b9Swdenk -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 372124ee89b9Swdenk > -A ppc -O linux -T kernel -C none -a 0 -e 0 \ 3722a47a12beSStefan Roese > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \ 372324ee89b9Swdenk > examples/uImage.TQM850L-uncompressed 372424ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 3725c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 3726c609719bSwdenk Image Type: PowerPC Linux Kernel Image (uncompressed) 3727c609719bSwdenk Data Size: 792160 Bytes = 773.59 kB = 0.76 MB 3728c609719bSwdenk Load Address: 0x00000000 372924ee89b9Swdenk Entry Point: 0x00000000 3730c609719bSwdenk 3731c609719bSwdenk 3732c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file 3733c609719bSwdenkwhen your kernel is intended to use an initial ramdisk: 3734c609719bSwdenk 3735c609719bSwdenk -> tools/mkimage -n 'Simple Ramdisk Image' \ 3736c609719bSwdenk > -A ppc -O linux -T ramdisk -C gzip \ 3737c609719bSwdenk > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd 3738c609719bSwdenk Image Name: Simple Ramdisk Image 3739c609719bSwdenk Created: Wed Jan 12 14:01:50 2000 3740c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 3741c609719bSwdenk Data Size: 566530 Bytes = 553.25 kB = 0.54 MB 3742c609719bSwdenk Load Address: 0x00000000 3743c609719bSwdenk Entry Point: 0x00000000 3744c609719bSwdenk 3745c609719bSwdenk 3746c609719bSwdenkInstalling a Linux Image: 3747c609719bSwdenk------------------------- 3748c609719bSwdenk 3749c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface, 3750c609719bSwdenkyou must convert the image to S-Record format: 3751c609719bSwdenk 3752c609719bSwdenk objcopy -I binary -O srec examples/image examples/image.srec 3753c609719bSwdenk 3754c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot 3755c609719bSwdenkimage header, so the resulting S-Record file will be relative to 3756c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to 3757c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads' 3758c609719bSwdenkcommand. 3759c609719bSwdenk 3760c609719bSwdenkExample: install the image to address 0x40100000 (which on the 3761c609719bSwdenkTQM8xxL is in the first Flash bank): 3762c609719bSwdenk 3763c609719bSwdenk => erase 40100000 401FFFFF 3764c609719bSwdenk 3765c609719bSwdenk .......... done 3766c609719bSwdenk Erased 8 sectors 3767c609719bSwdenk 3768c609719bSwdenk => loads 40100000 3769c609719bSwdenk ## Ready for S-Record download ... 3770c609719bSwdenk ~>examples/image.srec 3771c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 12 13 ... 3772c609719bSwdenk ... 3773c609719bSwdenk 15989 15990 15991 15992 3774c609719bSwdenk [file transfer complete] 3775c609719bSwdenk [connected] 3776c609719bSwdenk ## Start Addr = 0x00000000 3777c609719bSwdenk 3778c609719bSwdenk 3779c609719bSwdenkYou can check the success of the download using the 'iminfo' command; 3780c609719bSwdenkthis includes a checksum verification so you can be sure no data 3781c609719bSwdenkcorruption happened: 3782c609719bSwdenk 3783c609719bSwdenk => imi 40100000 3784c609719bSwdenk 3785c609719bSwdenk ## Checking Image at 40100000 ... 3786c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 3787c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 3788c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 3789c609719bSwdenk Load Address: 00000000 3790c609719bSwdenk Entry Point: 0000000c 3791c609719bSwdenk Verifying Checksum ... OK 3792c609719bSwdenk 3793c609719bSwdenk 3794c609719bSwdenkBoot Linux: 3795c609719bSwdenk----------- 3796c609719bSwdenk 3797c609719bSwdenkThe "bootm" command is used to boot an application that is stored in 3798c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents 3799c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as 3800c609719bSwdenkparameters. You can check and modify this variable using the 3801c609719bSwdenk"printenv" and "setenv" commands: 3802c609719bSwdenk 3803c609719bSwdenk 3804c609719bSwdenk => printenv bootargs 3805c609719bSwdenk bootargs=root=/dev/ram 3806c609719bSwdenk 3807c609719bSwdenk => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 3808c609719bSwdenk 3809c609719bSwdenk => printenv bootargs 3810c609719bSwdenk bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 3811c609719bSwdenk 3812c609719bSwdenk => bootm 40020000 3813c609719bSwdenk ## Booting Linux kernel at 40020000 ... 3814c609719bSwdenk Image Name: 2.2.13 for NFS on TQM850L 3815c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 3816c609719bSwdenk Data Size: 381681 Bytes = 372 kB = 0 MB 3817c609719bSwdenk Load Address: 00000000 3818c609719bSwdenk Entry Point: 0000000c 3819c609719bSwdenk Verifying Checksum ... OK 3820c609719bSwdenk Uncompressing Kernel Image ... OK 3821c609719bSwdenk 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 3822c609719bSwdenk Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 3823c609719bSwdenk time_init: decrementer frequency = 187500000/60 3824c609719bSwdenk Calibrating delay loop... 49.77 BogoMIPS 3825c609719bSwdenk Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000] 3826c609719bSwdenk ... 3827c609719bSwdenk 382811ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass 38297152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT 3830c609719bSwdenkformat!) to the "bootm" command: 3831c609719bSwdenk 3832c609719bSwdenk => imi 40100000 40200000 3833c609719bSwdenk 3834c609719bSwdenk ## Checking Image at 40100000 ... 3835c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 3836c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 3837c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 3838c609719bSwdenk Load Address: 00000000 3839c609719bSwdenk Entry Point: 0000000c 3840c609719bSwdenk Verifying Checksum ... OK 3841c609719bSwdenk 3842c609719bSwdenk ## Checking Image at 40200000 ... 3843c609719bSwdenk Image Name: Simple Ramdisk Image 3844c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 3845c609719bSwdenk Data Size: 566530 Bytes = 553 kB = 0 MB 3846c609719bSwdenk Load Address: 00000000 3847c609719bSwdenk Entry Point: 00000000 3848c609719bSwdenk Verifying Checksum ... OK 3849c609719bSwdenk 3850c609719bSwdenk => bootm 40100000 40200000 3851c609719bSwdenk ## Booting Linux kernel at 40100000 ... 3852c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 3853c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 3854c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 3855c609719bSwdenk Load Address: 00000000 3856c609719bSwdenk Entry Point: 0000000c 3857c609719bSwdenk Verifying Checksum ... OK 3858c609719bSwdenk Uncompressing Kernel Image ... OK 3859c609719bSwdenk ## Loading RAMDisk Image at 40200000 ... 3860c609719bSwdenk Image Name: Simple Ramdisk Image 3861c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 3862c609719bSwdenk Data Size: 566530 Bytes = 553 kB = 0 MB 3863c609719bSwdenk Load Address: 00000000 3864c609719bSwdenk Entry Point: 00000000 3865c609719bSwdenk Verifying Checksum ... OK 3866c609719bSwdenk Loading Ramdisk ... OK 3867c609719bSwdenk 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 3868c609719bSwdenk Boot arguments: root=/dev/ram 3869c609719bSwdenk time_init: decrementer frequency = 187500000/60 3870c609719bSwdenk Calibrating delay loop... 49.77 BogoMIPS 3871c609719bSwdenk ... 3872c609719bSwdenk RAMDISK: Compressed image found at block 0 3873c609719bSwdenk VFS: Mounted root (ext2 filesystem). 3874c609719bSwdenk 3875c609719bSwdenk bash# 3876c609719bSwdenk 38770267768eSMatthew McClintockBoot Linux and pass a flat device tree: 38780267768eSMatthew McClintock----------- 38790267768eSMatthew McClintock 38800267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section 38810267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The 38820267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated 38830267768eSMatthew McClintockflat device tree: 38840267768eSMatthew McClintock 38850267768eSMatthew McClintock=> print oftaddr 38860267768eSMatthew McClintockoftaddr=0x300000 38870267768eSMatthew McClintock=> print oft 38880267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb 38890267768eSMatthew McClintock=> tftp $oftaddr $oft 38900267768eSMatthew McClintockSpeed: 1000, full duplex 38910267768eSMatthew McClintockUsing TSEC0 device 38920267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101 38930267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'. 38940267768eSMatthew McClintockLoad address: 0x300000 38950267768eSMatthew McClintockLoading: # 38960267768eSMatthew McClintockdone 38970267768eSMatthew McClintockBytes transferred = 4106 (100a hex) 38980267768eSMatthew McClintock=> tftp $loadaddr $bootfile 38990267768eSMatthew McClintockSpeed: 1000, full duplex 39000267768eSMatthew McClintockUsing TSEC0 device 39010267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2 39020267768eSMatthew McClintockFilename 'uImage'. 39030267768eSMatthew McClintockLoad address: 0x200000 39040267768eSMatthew McClintockLoading:############ 39050267768eSMatthew McClintockdone 39060267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex) 39070267768eSMatthew McClintock=> print loadaddr 39080267768eSMatthew McClintockloadaddr=200000 39090267768eSMatthew McClintock=> print oftaddr 39100267768eSMatthew McClintockoftaddr=0x300000 39110267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr 39120267768eSMatthew McClintock## Booting image at 00200000 ... 39130267768eSMatthew McClintock Image Name: Linux-2.6.17-dirty 39140267768eSMatthew McClintock Image Type: PowerPC Linux Kernel Image (gzip compressed) 39150267768eSMatthew McClintock Data Size: 1029343 Bytes = 1005.2 kB 39160267768eSMatthew McClintock Load Address: 00000000 39170267768eSMatthew McClintock Entry Point: 00000000 39180267768eSMatthew McClintock Verifying Checksum ... OK 39190267768eSMatthew McClintock Uncompressing Kernel Image ... OK 39200267768eSMatthew McClintockBooting using flat device tree at 0x300000 39210267768eSMatthew McClintockUsing MPC85xx ADS machine description 39220267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb 39230267768eSMatthew McClintock[snip] 39240267768eSMatthew McClintock 39250267768eSMatthew McClintock 39266069ff26SwdenkMore About U-Boot Image Types: 39276069ff26Swdenk------------------------------ 39286069ff26Swdenk 39296069ff26SwdenkU-Boot supports the following image types: 39306069ff26Swdenk 39316069ff26Swdenk "Standalone Programs" are directly runnable in the environment 39326069ff26Swdenk provided by U-Boot; it is expected that (if they behave 39336069ff26Swdenk well) you can continue to work in U-Boot after return from 39346069ff26Swdenk the Standalone Program. 39356069ff26Swdenk "OS Kernel Images" are usually images of some Embedded OS which 39366069ff26Swdenk will take over control completely. Usually these programs 39376069ff26Swdenk will install their own set of exception handlers, device 39386069ff26Swdenk drivers, set up the MMU, etc. - this means, that you cannot 39396069ff26Swdenk expect to re-enter U-Boot except by resetting the CPU. 39406069ff26Swdenk "RAMDisk Images" are more or less just data blocks, and their 39416069ff26Swdenk parameters (address, size) are passed to an OS kernel that is 39426069ff26Swdenk being started. 39436069ff26Swdenk "Multi-File Images" contain several images, typically an OS 39446069ff26Swdenk (Linux) kernel image and one or more data images like 39456069ff26Swdenk RAMDisks. This construct is useful for instance when you want 39466069ff26Swdenk to boot over the network using BOOTP etc., where the boot 39476069ff26Swdenk server provides just a single image file, but you want to get 39486069ff26Swdenk for instance an OS kernel and a RAMDisk image. 39496069ff26Swdenk 39506069ff26Swdenk "Multi-File Images" start with a list of image sizes, each 39516069ff26Swdenk image size (in bytes) specified by an "uint32_t" in network 39526069ff26Swdenk byte order. This list is terminated by an "(uint32_t)0". 39536069ff26Swdenk Immediately after the terminating 0 follow the images, one by 39546069ff26Swdenk one, all aligned on "uint32_t" boundaries (size rounded up to 39556069ff26Swdenk a multiple of 4 bytes). 39566069ff26Swdenk 39576069ff26Swdenk "Firmware Images" are binary images containing firmware (like 39586069ff26Swdenk U-Boot or FPGA images) which usually will be programmed to 39596069ff26Swdenk flash memory. 39606069ff26Swdenk 39616069ff26Swdenk "Script files" are command sequences that will be executed by 39626069ff26Swdenk U-Boot's command interpreter; this feature is especially 39636069ff26Swdenk useful when you configure U-Boot to use a real shell (hush) 39646069ff26Swdenk as command interpreter. 39656069ff26Swdenk 3966c609719bSwdenk 3967c609719bSwdenkStandalone HOWTO: 3968c609719bSwdenk================= 3969c609719bSwdenk 3970c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and 3971c609719bSwdenkrun "standalone" applications, which can use some resources of 3972c609719bSwdenkU-Boot like console I/O functions or interrupt services. 3973c609719bSwdenk 3974c609719bSwdenkTwo simple examples are included with the sources: 3975c609719bSwdenk 3976c609719bSwdenk"Hello World" Demo: 3977c609719bSwdenk------------------- 3978c609719bSwdenk 3979c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo 3980c609719bSwdenkapplication; it is automatically compiled when you build U-Boot. 3981c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it 3982c609719bSwdenklike that: 3983c609719bSwdenk 3984c609719bSwdenk => loads 3985c609719bSwdenk ## Ready for S-Record download ... 3986c609719bSwdenk ~>examples/hello_world.srec 3987c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 ... 3988c609719bSwdenk [file transfer complete] 3989c609719bSwdenk [connected] 3990c609719bSwdenk ## Start Addr = 0x00040004 3991c609719bSwdenk 3992c609719bSwdenk => go 40004 Hello World! This is a test. 3993c609719bSwdenk ## Starting application at 0x00040004 ... 3994c609719bSwdenk Hello World 3995c609719bSwdenk argc = 7 3996c609719bSwdenk argv[0] = "40004" 3997c609719bSwdenk argv[1] = "Hello" 3998c609719bSwdenk argv[2] = "World!" 3999c609719bSwdenk argv[3] = "This" 4000c609719bSwdenk argv[4] = "is" 4001c609719bSwdenk argv[5] = "a" 4002c609719bSwdenk argv[6] = "test." 4003c609719bSwdenk argv[7] = "<NULL>" 4004c609719bSwdenk Hit any key to exit ... 4005c609719bSwdenk 4006c609719bSwdenk ## Application terminated, rc = 0x0 4007c609719bSwdenk 4008c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt 4009c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'. 4010c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second. 4011c609719bSwdenkThe interrupt service routine is trivial, just printing a '.' 4012c609719bSwdenkcharacter, but this is just a demo program. The application can be 4013c609719bSwdenkcontrolled by the following keys: 4014c609719bSwdenk 4015c609719bSwdenk ? - print current values og the CPM Timer registers 4016c609719bSwdenk b - enable interrupts and start timer 4017c609719bSwdenk e - stop timer and disable interrupts 4018c609719bSwdenk q - quit application 4019c609719bSwdenk 4020c609719bSwdenk => loads 4021c609719bSwdenk ## Ready for S-Record download ... 4022c609719bSwdenk ~>examples/timer.srec 4023c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 ... 4024c609719bSwdenk [file transfer complete] 4025c609719bSwdenk [connected] 4026c609719bSwdenk ## Start Addr = 0x00040004 4027c609719bSwdenk 4028c609719bSwdenk => go 40004 4029c609719bSwdenk ## Starting application at 0x00040004 ... 4030c609719bSwdenk TIMERS=0xfff00980 4031c609719bSwdenk Using timer 1 4032c609719bSwdenk tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0 4033c609719bSwdenk 4034c609719bSwdenkHit 'b': 4035c609719bSwdenk [q, b, e, ?] Set interval 1000000 us 4036c609719bSwdenk Enabling timer 4037c609719bSwdenkHit '?': 4038c609719bSwdenk [q, b, e, ?] ........ 4039c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0 4040c609719bSwdenkHit '?': 4041c609719bSwdenk [q, b, e, ?] . 4042c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0 4043c609719bSwdenkHit '?': 4044c609719bSwdenk [q, b, e, ?] . 4045c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0 4046c609719bSwdenkHit '?': 4047c609719bSwdenk [q, b, e, ?] . 4048c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0 4049c609719bSwdenkHit 'e': 4050c609719bSwdenk [q, b, e, ?] ...Stopping timer 4051c609719bSwdenkHit 'q': 4052c609719bSwdenk [q, b, e, ?] ## Application terminated, rc = 0x0 4053c609719bSwdenk 4054c609719bSwdenk 405585ec0bccSwdenkMinicom warning: 405685ec0bccSwdenk================ 405785ec0bccSwdenk 40587152b1d0SwdenkOver time, many people have reported problems when trying to use the 405985ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd) 406085ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under 4061f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and 406285ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and 406385ec0bccSwdenkuse "cu" for S-Record download ("loads" command). 406485ec0bccSwdenk 406552f52c14SwdenkNevertheless, if you absolutely want to use it try adding this 406652f52c14Swdenkconfiguration to your "File transfer protocols" section: 406752f52c14Swdenk 406852f52c14Swdenk Name Program Name U/D FullScr IO-Red. Multi 406952f52c14Swdenk X kermit /usr/bin/kermit -i -l %l -s Y U Y N N 407052f52c14Swdenk Y kermit /usr/bin/kermit -i -l %l -r N D Y N N 407152f52c14Swdenk 407252f52c14Swdenk 4073c609719bSwdenkNetBSD Notes: 4074c609719bSwdenk============= 4075c609719bSwdenk 4076c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host 4077c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx). 4078c609719bSwdenk 4079c609719bSwdenkBuilding requires a cross environment; it is known to work on 4080c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also 4081c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make). 4082c609719bSwdenkNote that the cross-powerpc package does not install include files; 4083c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is 4084c609719bSwdenkmissing. This file has to be installed and patched manually: 4085c609719bSwdenk 4086c609719bSwdenk # cd /usr/pkg/cross/powerpc-netbsd/include 4087c609719bSwdenk # mkdir powerpc 4088c609719bSwdenk # ln -s powerpc machine 4089c609719bSwdenk # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h 4090c609719bSwdenk # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST 4091c609719bSwdenk 4092c609719bSwdenkNative builds *don't* work due to incompatibilities between native 4093c609719bSwdenkand U-Boot include files. 4094c609719bSwdenk 4095c609719bSwdenkBooting assumes that (the first part of) the image booted is a 4096c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel 4097c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source 4098c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the 40992a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz 4100c609719bSwdenk 4101c609719bSwdenk 4102c609719bSwdenkImplementation Internals: 4103c609719bSwdenk========================= 4104c609719bSwdenk 4105c609719bSwdenkThe following is not intended to be a complete description of every 4106c609719bSwdenkimplementation detail. However, it should help to understand the 4107c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom 4108c609719bSwdenkhardware. 4109c609719bSwdenk 4110c609719bSwdenk 4111c609719bSwdenkInitial Stack, Global Data: 4112c609719bSwdenk--------------------------- 4113c609719bSwdenk 4114c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot 4115c609719bSwdenkstarts running out of ROM (flash memory), usually without access to 4116c609719bSwdenksystem RAM (because the memory controller is not initialized yet). 4117c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS 4118c609719bSwdenkis not initialized as zero. To be able to get a C environment working 4119c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation 4120c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU 4121c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and 4122c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be 4123c609719bSwdenklocked as (mis-) used as memory, etc. 4124c609719bSwdenk 41257152b1d0Swdenk Chris Hallinan posted a good summary of these issues to the 41260668236bSWolfgang Denk U-Boot mailing list: 412743d9616cSwdenk 412843d9616cSwdenk Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)? 412943d9616cSwdenk From: "Chris Hallinan" <clh@net1plus.com> 413043d9616cSwdenk Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET) 413143d9616cSwdenk ... 413243d9616cSwdenk 413343d9616cSwdenk Correct me if I'm wrong, folks, but the way I understand it 413443d9616cSwdenk is this: Using DCACHE as initial RAM for Stack, etc, does not 413543d9616cSwdenk require any physical RAM backing up the cache. The cleverness 413643d9616cSwdenk is that the cache is being used as a temporary supply of 413743d9616cSwdenk necessary storage before the SDRAM controller is setup. It's 413811ccc33fSMarcel Ziswiler beyond the scope of this list to explain the details, but you 413943d9616cSwdenk can see how this works by studying the cache architecture and 414043d9616cSwdenk operation in the architecture and processor-specific manuals. 414143d9616cSwdenk 414243d9616cSwdenk OCM is On Chip Memory, which I believe the 405GP has 4K. It 414343d9616cSwdenk is another option for the system designer to use as an 414411ccc33fSMarcel Ziswiler initial stack/RAM area prior to SDRAM being available. Either 414543d9616cSwdenk option should work for you. Using CS 4 should be fine if your 414643d9616cSwdenk board designers haven't used it for something that would 414743d9616cSwdenk cause you grief during the initial boot! It is frequently not 414843d9616cSwdenk used. 414943d9616cSwdenk 41506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere 415143d9616cSwdenk with your processor/board/system design. The default value 415243d9616cSwdenk you will find in any recent u-boot distribution in 41538a316c9bSStefan Roese walnut.h should work for you. I'd set it to a value larger 415443d9616cSwdenk than your SDRAM module. If you have a 64MB SDRAM module, set 415543d9616cSwdenk it above 400_0000. Just make sure your board has no resources 415643d9616cSwdenk that are supposed to respond to that address! That code in 415743d9616cSwdenk start.S has been around a while and should work as is when 415843d9616cSwdenk you get the config right. 415943d9616cSwdenk 416043d9616cSwdenk -Chris Hallinan 416143d9616cSwdenk DS4.COM, Inc. 416243d9616cSwdenk 4163c609719bSwdenkIt is essential to remember this, since it has some impact on the C 4164c609719bSwdenkcode for the initialization procedures: 4165c609719bSwdenk 4166c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt 4167c609719bSwdenk to write it. 4168c609719bSwdenk 416911ccc33fSMarcel Ziswiler* Do not use any uninitialized global data (or implicitely initialized 4170c609719bSwdenk as zero data - BSS segment) at all - this is undefined, initiali- 41717152b1d0Swdenk zation is performed later (when relocating to RAM). 4172c609719bSwdenk 4173c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like 4174c609719bSwdenk that. 4175c609719bSwdenk 4176c609719bSwdenkHaving only the stack as writable memory limits means we cannot use 4177c609719bSwdenknormal global data to share information beween the code. But it 4178c609719bSwdenkturned out that the implementation of U-Boot can be greatly 4179c609719bSwdenksimplified by making a global data structure (gd_t) available to all 4180c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_ 4181c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of 4182c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we 4183c609719bSwdenkplace a pointer (gd) to the global data into a register which we 4184c609719bSwdenkreserve for this purpose. 4185c609719bSwdenk 41867152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the 4187c609719bSwdenkrelevant (E)ABI specifications for the current architecture, and by 4188c609719bSwdenkGCC's implementation. 4189c609719bSwdenk 4190c609719bSwdenkFor PowerPC, the following registers have specific use: 4191c609719bSwdenk R1: stack pointer 4192e7670f6cSWolfgang Denk R2: reserved for system use 4193c609719bSwdenk R3-R4: parameter passing and return values 4194c609719bSwdenk R5-R10: parameter passing 4195c609719bSwdenk R13: small data area pointer 4196c609719bSwdenk R30: GOT pointer 4197c609719bSwdenk R31: frame pointer 4198c609719bSwdenk 4199e6bee808SJoakim Tjernlund (U-Boot also uses R12 as internal GOT pointer. r12 4200e6bee808SJoakim Tjernlund is a volatile register so r12 needs to be reset when 4201e6bee808SJoakim Tjernlund going back and forth between asm and C) 4202c609719bSwdenk 4203e7670f6cSWolfgang Denk ==> U-Boot will use R2 to hold a pointer to the global data 4204c609719bSwdenk 4205c609719bSwdenk Note: on PPC, we could use a static initializer (since the 4206c609719bSwdenk address of the global data structure is known at compile time), 4207c609719bSwdenk but it turned out that reserving a register results in somewhat 4208c609719bSwdenk smaller code - although the code savings are not that big (on 4209c609719bSwdenk average for all boards 752 bytes for the whole U-Boot image, 4210c609719bSwdenk 624 text + 127 data). 4211c609719bSwdenk 4212c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here: 42134c58eb55SMike Frysinger http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface 42144c58eb55SMike Frysinger 4215c4db335cSRobin Getz ==> U-Boot will use P3 to hold a pointer to the global data 42164c58eb55SMike Frysinger 4217c609719bSwdenkOn ARM, the following registers are used: 4218c609719bSwdenk 4219c609719bSwdenk R0: function argument word/integer result 4220c609719bSwdenk R1-R3: function argument word 4221c609719bSwdenk R9: GOT pointer 4222c609719bSwdenk R10: stack limit (used only if stack checking if enabled) 4223c609719bSwdenk R11: argument (frame) pointer 4224c609719bSwdenk R12: temporary workspace 4225c609719bSwdenk R13: stack pointer 4226c609719bSwdenk R14: link register 4227c609719bSwdenk R15: program counter 4228c609719bSwdenk 4229c609719bSwdenk ==> U-Boot will use R8 to hold a pointer to the global data 4230c609719bSwdenk 42310df01fd3SThomas ChouOn Nios II, the ABI is documented here: 42320df01fd3SThomas Chou http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf 42330df01fd3SThomas Chou 42340df01fd3SThomas Chou ==> U-Boot will use gp to hold a pointer to the global data 42350df01fd3SThomas Chou 42360df01fd3SThomas Chou Note: on Nios II, we give "-G0" option to gcc and don't use gp 42370df01fd3SThomas Chou to access small data sections, so gp is free. 42380df01fd3SThomas Chou 4239d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope, 4240d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much. 4241c609719bSwdenk 4242c609719bSwdenkMemory Management: 4243c609719bSwdenk------------------ 4244c609719bSwdenk 4245c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the 4246c609719bSwdenkMMU is not used either for address mapping nor for memory protection. 4247c609719bSwdenk 4248c609719bSwdenkThe available memory is mapped to fixed addresses using the memory 4249c609719bSwdenkcontroller. In this process, a contiguous block is formed for each 4250c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several 4251c609719bSwdenkphysical memory banks. 4252c609719bSwdenk 4253c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on 4254c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After 4255c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself 4256c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some 42576d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN 4258c609719bSwdenkconfiguration setting]. Below that, a structure with global Board 4259c609719bSwdenkInfo data is placed, followed by the stack (growing downward). 4260c609719bSwdenk 4261c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB 4262c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF). 4263c609719bSwdenk 4264c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like 4265c609719bSwdenkthis: 4266c609719bSwdenk 4267c609719bSwdenk 0x0000 0000 Exception Vector code 4268c609719bSwdenk : 4269c609719bSwdenk 0x0000 1FFF 4270c609719bSwdenk 0x0000 2000 Free for Application Use 4271c609719bSwdenk : 4272c609719bSwdenk : 4273c609719bSwdenk 4274c609719bSwdenk : 4275c609719bSwdenk : 4276c609719bSwdenk 0x00FB FF20 Monitor Stack (Growing downward) 4277c609719bSwdenk 0x00FB FFAC Board Info Data and permanent copy of global data 4278c609719bSwdenk 0x00FC 0000 Malloc Arena 4279c609719bSwdenk : 4280c609719bSwdenk 0x00FD FFFF 4281c609719bSwdenk 0x00FE 0000 RAM Copy of Monitor Code 4282c609719bSwdenk ... eventually: LCD or video framebuffer 4283c609719bSwdenk ... eventually: pRAM (Protected RAM - unchanged by reset) 4284c609719bSwdenk 0x00FF FFFF [End of RAM] 4285c609719bSwdenk 4286c609719bSwdenk 4287c609719bSwdenkSystem Initialization: 4288c609719bSwdenk---------------------- 4289c609719bSwdenk 4290c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point 429111ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset 4292c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory. 42937152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address. 4294c609719bSwdenkTo be able to implement the initialization code in C, a (small!) 4295c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs 4296c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked 4297c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core, 4298c609719bSwdenkthe caches and the SIU. 4299c609719bSwdenk 4300c609719bSwdenkNext, all (potentially) available memory banks are mapped using a 4301c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries 4302c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash 4303c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is 4304c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a 4305c609719bSwdenksimple memory test is run that determines the size of the SDRAM 4306c609719bSwdenkbanks. 4307c609719bSwdenk 4308c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of 43097152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first 4310c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address 4311c609719bSwdenk0x00000000, with any additional banks following immediately to create 4312c609719bSwdenkcontiguous memory starting from 0. 4313c609719bSwdenk 4314c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area 4315c609719bSwdenkand allocates memory for use by malloc() and for the global Board 4316c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM 4317c609719bSwdenkpages, and the final stack is set up. 4318c609719bSwdenk 4319c609719bSwdenkOnly after this relocation will you have a "normal" C environment; 4320c609719bSwdenkuntil that you are restricted in several ways, mostly because you are 4321c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a 4322c609719bSwdenknew address in RAM. 4323c609719bSwdenk 4324c609719bSwdenk 4325c609719bSwdenkU-Boot Porting Guide: 4326c609719bSwdenk---------------------- 4327c609719bSwdenk 4328c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing 43296aff3115Swdenklist, October 2002] 4330c609719bSwdenk 4331c609719bSwdenk 4332c609719bSwdenkint main(int argc, char *argv[]) 4333c609719bSwdenk{ 4334c609719bSwdenk sighandler_t no_more_time; 4335c609719bSwdenk 4336c609719bSwdenk signal(SIGALRM, no_more_time); 4337c609719bSwdenk alarm(PROJECT_DEADLINE - toSec (3 * WEEK)); 4338c609719bSwdenk 4339c609719bSwdenk if (available_money > available_manpower) { 43406c3fef28SJerry Van Baren Pay consultant to port U-Boot; 4341c609719bSwdenk return 0; 4342c609719bSwdenk } 4343c609719bSwdenk 4344c609719bSwdenk Download latest U-Boot source; 4345c609719bSwdenk 43460668236bSWolfgang Denk Subscribe to u-boot mailing list; 43476aff3115Swdenk 43486c3fef28SJerry Van Baren if (clueless) 4349c609719bSwdenk email("Hi, I am new to U-Boot, how do I get started?"); 4350c609719bSwdenk 4351c609719bSwdenk while (learning) { 4352c609719bSwdenk Read the README file in the top level directory; 43537cb22f97Swdenk Read http://www.denx.de/twiki/bin/view/DULG/Manual; 43546c3fef28SJerry Van Baren Read applicable doc/*.README; 4355c609719bSwdenk Read the source, Luke; 43566c3fef28SJerry Van Baren /* find . -name "*.[chS]" | xargs grep -i <keyword> */ 4357c609719bSwdenk } 4358c609719bSwdenk 43596c3fef28SJerry Van Baren if (available_money > toLocalCurrency ($2500)) 43606c3fef28SJerry Van Baren Buy a BDI3000; 43616c3fef28SJerry Van Baren else 4362c609719bSwdenk Add a lot of aggravation and time; 4363c609719bSwdenk 43646c3fef28SJerry Van Baren if (a similar board exists) { /* hopefully... */ 43656c3fef28SJerry Van Baren cp -a board/<similar> board/<myboard> 43666c3fef28SJerry Van Baren cp include/configs/<similar>.h include/configs/<myboard>.h 43676c3fef28SJerry Van Baren } else { 4368c609719bSwdenk Create your own board support subdirectory; 43696c3fef28SJerry Van Baren Create your own board include/configs/<myboard>.h file; 43706c3fef28SJerry Van Baren } 43716c3fef28SJerry Van Baren Edit new board/<myboard> files 43726c3fef28SJerry Van Baren Edit new include/configs/<myboard>.h 4373c609719bSwdenk 43746c3fef28SJerry Van Baren while (!accepted) { 4375c609719bSwdenk while (!running) { 4376c609719bSwdenk do { 4377c609719bSwdenk Add / modify source code; 4378c609719bSwdenk } until (compiles); 4379c609719bSwdenk Debug; 4380c609719bSwdenk if (clueless) 4381c609719bSwdenk email("Hi, I am having problems..."); 4382c609719bSwdenk } 43836c3fef28SJerry Van Baren Send patch file to the U-Boot email list; 43846c3fef28SJerry Van Baren if (reasonable critiques) 43856c3fef28SJerry Van Baren Incorporate improvements from email list code review; 43866c3fef28SJerry Van Baren else 43876c3fef28SJerry Van Baren Defend code as written; 43886c3fef28SJerry Van Baren } 4389c609719bSwdenk 4390c609719bSwdenk return 0; 4391c609719bSwdenk} 4392c609719bSwdenk 4393c609719bSwdenkvoid no_more_time (int sig) 4394c609719bSwdenk{ 4395c609719bSwdenk hire_a_guru(); 4396c609719bSwdenk} 4397c609719bSwdenk 4398c609719bSwdenk 4399c609719bSwdenkCoding Standards: 4400c609719bSwdenk----------------- 4401c609719bSwdenk 4402c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel 44032c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script 44042c051651SDetlev Zundel"scripts/Lindent" in your Linux kernel source directory. In sources 44052c051651SDetlev Zundeloriginating from U-Boot a style corresponding to "Lindent -pcs" (adding 44062c051651SDetlev Zundelspaces before parameters to function calls) is actually used. 4407c609719bSwdenk 44082c051651SDetlev ZundelSource files originating from a different project (for example the 44092c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not 44102c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those 44112c051651SDetlev Zundelsources. 44122c051651SDetlev Zundel 44132c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in 44142c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//) 44152c051651SDetlev Zundelin your code. 4416c609719bSwdenk 4417c178d3daSwdenkPlease also stick to the following formatting rules: 4418180d3f74Swdenk- remove any trailing white space 4419180d3f74Swdenk- use TAB characters for indentation, not spaces 4420180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds 4421180d3f74Swdenk- do not add more than 2 empty lines to source files 4422180d3f74Swdenk- do not add trailing empty lines to source files 4423180d3f74Swdenk 4424c609719bSwdenkSubmissions which do not conform to the standards may be returned 4425c609719bSwdenkwith a request to reformat the changes. 4426c609719bSwdenk 4427c609719bSwdenk 4428c609719bSwdenkSubmitting Patches: 4429c609719bSwdenk------------------- 4430c609719bSwdenk 4431c609719bSwdenkSince the number of patches for U-Boot is growing, we need to 4432c609719bSwdenkestablish some rules. Submissions which do not conform to these rules 4433c609719bSwdenkmay be rejected, even when they contain important and valuable stuff. 4434c609719bSwdenk 44350d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details. 4436218ca724SWolfgang Denk 44370668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>; 44380668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot 44390668236bSWolfgang Denk 4440c609719bSwdenkWhen you send a patch, please include the following information with 4441c609719bSwdenkit: 4442c609719bSwdenk 4443c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes 4444c609719bSwdenk this bug. Please try to include a way of demonstrating that the 4445c609719bSwdenk patch actually fixes something. 4446c609719bSwdenk 4447c609719bSwdenk* For new features: a description of the feature and your 4448c609719bSwdenk implementation. 4449c609719bSwdenk 4450c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch) 4451c609719bSwdenk 4452c609719bSwdenk* For major contributions, your entry to the CREDITS file 4453c609719bSwdenk 4454c609719bSwdenk* When you add support for a new board, don't forget to add this 4455c609719bSwdenk board to the MAKEALL script, too. 4456c609719bSwdenk 4457c609719bSwdenk* If your patch adds new configuration options, don't forget to 4458c609719bSwdenk document these in the README file. 4459c609719bSwdenk 4460218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly* 4461218ca724SWolfgang Denk recommended) you can easily generate the patch using the 4462218ca724SWolfgang Denk "git-format-patch". If you then use "git-send-email" to send it to 4463218ca724SWolfgang Denk the U-Boot mailing list, you will avoid most of the common problems 4464218ca724SWolfgang Denk with some other mail clients. 4465c609719bSwdenk 4466218ca724SWolfgang Denk If you cannot use git, use "diff -purN OLD NEW". If your version of 4467218ca724SWolfgang Denk diff does not support these options, then get the latest version of 4468218ca724SWolfgang Denk GNU diff. 44696dff5529Swdenk 4470218ca724SWolfgang Denk The current directory when running this command shall be the parent 4471218ca724SWolfgang Denk directory of the U-Boot source tree (i. e. please make sure that 4472218ca724SWolfgang Denk your patch includes sufficient directory information for the 4473218ca724SWolfgang Denk affected files). 4474218ca724SWolfgang Denk 4475218ca724SWolfgang Denk We prefer patches as plain text. MIME attachments are discouraged, 4476218ca724SWolfgang Denk and compressed attachments must not be used. 4477c609719bSwdenk 447852f52c14Swdenk* If one logical set of modifications affects or creates several 447952f52c14Swdenk files, all these changes shall be submitted in a SINGLE patch file. 448052f52c14Swdenk 448152f52c14Swdenk* Changesets that contain different, unrelated modifications shall be 448252f52c14Swdenk submitted as SEPARATE patches, one patch per changeset. 448352f52c14Swdenk 448452f52c14Swdenk 4485c609719bSwdenkNotes: 4486c609719bSwdenk 4487c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched 4488c609719bSwdenk source tree and make sure that no errors or warnings are reported 4489c609719bSwdenk for any of the boards. 4490c609719bSwdenk 4491c609719bSwdenk* Keep your modifications to the necessary minimum: A patch 4492c609719bSwdenk containing several unrelated changes or arbitrary reformats will be 4493c609719bSwdenk returned with a request to re-formatting / split it. 4494c609719bSwdenk 4495c609719bSwdenk* If you modify existing code, make sure that your new code does not 4496c609719bSwdenk add to the memory footprint of the code ;-) Small is beautiful! 4497c609719bSwdenk When adding new features, these should compile conditionally only 4498c609719bSwdenk (using #ifdef), and the resulting code with the new feature 4499c609719bSwdenk disabled must not need more memory than the old code without your 4500c609719bSwdenk modification. 450190dc6704Swdenk 45020668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the 45030668236bSWolfgang Denk u-boot mailing list. Bigger patches will be moderated. If they are 45040668236bSWolfgang Denk reasonable and not too big, they will be acknowledged. But patches 45050668236bSWolfgang Denk bigger than the size limit should be avoided. 4506