1c609719bSwdenk# 2218ca724SWolfgang Denk# (C) Copyright 2000 - 2008 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 12993f19cc0SwdenkU-Boot uses a 3 level version number containing a version, a 13093f19cc0Swdenksub-version, and a patchlevel: "U-Boot-2.34.5" means version "2", 13193f19cc0Swdenksub-version "34", and patchlevel "4". 13293f19cc0Swdenk 13393f19cc0SwdenkThe patchlevel is used to indicate certain stages of development 13493f19cc0Swdenkbetween released versions, i. e. officially released versions of 13593f19cc0SwdenkU-Boot will always have a patchlevel of "0". 13693f19cc0Swdenk 13793f19cc0Swdenk 138c609719bSwdenkDirectory Hierarchy: 139c609719bSwdenk==================== 140c609719bSwdenk 1417152b1d0Swdenk- board Board dependent files 1427152b1d0Swdenk- common Misc architecture independent functions 143c609719bSwdenk- cpu CPU specific files 144983fda83Swdenk - 74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs 14511dadd54Swdenk - arm720t Files specific to ARM 720 CPUs 14611dadd54Swdenk - arm920t Files specific to ARM 920 CPUs 147a85f9f21Swdenk - at91rm9200 Files specific to Atmel AT91RM9200 CPU 148983fda83Swdenk - imx Files specific to Freescale MC9328 i.MX CPUs 1491d9f4105Swdenk - s3c24x0 Files specific to Samsung S3C24X0 CPUs 15011dadd54Swdenk - arm925t Files specific to ARM 925 CPUs 15111dadd54Swdenk - arm926ejs Files specific to ARM 926 CPUs 1528ed96046Swdenk - arm1136 Files specific to ARM 1136 CPUs 15372a087e0SWolfgang Denk - at32ap Files specific to Atmel AVR32 AP CPUs 154adbfeeb7SMike Frysinger - blackfin Files specific to Analog Devices Blackfin CPUs 15511dadd54Swdenk - i386 Files specific to i386 CPUs 15611dadd54Swdenk - ixp Files specific to Intel XScale IXP CPUs 157b330990cSDaniel Hellstrom - leon2 Files specific to Gaisler LEON2 SPARC CPU 1581e9a164eSDaniel Hellstrom - leon3 Files specific to Gaisler LEON3 SPARC CPU 159983fda83Swdenk - mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs 1601552af70STsiChungLiew - mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs 1618e585f02STsiChung Liew - mcf532x Files specific to Freescale ColdFire MCF5329 CPUs 1628ae158cdSTsiChungLiew - mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs 16357a12720STsiChungLiew - mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs 16411dadd54Swdenk - mips Files specific to MIPS CPUs 165983fda83Swdenk - mpc5xx Files specific to Freescale MPC5xx CPUs 166983fda83Swdenk - mpc5xxx Files specific to Freescale MPC5xxx CPUs 167983fda83Swdenk - mpc8xx Files specific to Freescale MPC8xx CPUs 168983fda83Swdenk - mpc8220 Files specific to Freescale MPC8220 CPUs 169983fda83Swdenk - mpc824x Files specific to Freescale MPC824x CPUs 170983fda83Swdenk - mpc8260 Files specific to Freescale MPC8260 CPUs 171983fda83Swdenk - mpc85xx Files specific to Freescale MPC85xx CPUs 17211dadd54Swdenk - nios Files specific to Altera NIOS CPUs 1735c952cf0Swdenk - nios2 Files specific to Altera Nios-II CPUs 1740c8721a4SWolfgang Denk - ppc4xx Files specific to AMCC PowerPC 4xx CPUs 17511dadd54Swdenk - pxa Files specific to Intel XScale PXA CPUs 17611dadd54Swdenk - s3c44b0 Files specific to Samsung S3C44B0 CPUs 17711dadd54Swdenk - sa1100 Files specific to Intel StrongARM SA1100 CPUs 178c609719bSwdenk- disk Code for disk drive partition handling 179c609719bSwdenk- doc Documentation (don't expect too much) 1807152b1d0Swdenk- drivers Commonly used device drivers 181c609719bSwdenk- dtt Digital Thermometer and Thermostat drivers 182c609719bSwdenk- examples Example code for standalone applications, etc. 183c609719bSwdenk- include Header Files 18411dadd54Swdenk- lib_arm Files generic to ARM architecture 1857b64fef3SWolfgang Denk- lib_avr32 Files generic to AVR32 architecture 186adbfeeb7SMike Frysinger- lib_blackfin Files generic to Blackfin architecture 18711dadd54Swdenk- lib_generic Files generic to all architectures 18811dadd54Swdenk- lib_i386 Files generic to i386 architecture 18911dadd54Swdenk- lib_m68k Files generic to m68k architecture 19011dadd54Swdenk- lib_mips Files generic to MIPS architecture 19111dadd54Swdenk- lib_nios Files generic to NIOS architecture 19211dadd54Swdenk- lib_ppc Files generic to PowerPC architecture 193c2f02da2SDaniel Hellstrom- lib_sparc Files generic to SPARC architecture 194213bf8c8SGerald Van Baren- libfdt Library files to support flattened device trees 195c609719bSwdenk- net Networking code 196c609719bSwdenk- post Power On Self Test 197c609719bSwdenk- rtc Real Time Clock drivers 198c609719bSwdenk- tools Tools to build S-Record or U-Boot images, etc. 199c609719bSwdenk 200c609719bSwdenkSoftware Configuration: 201c609719bSwdenk======================= 202c609719bSwdenk 203c609719bSwdenkConfiguration is usually done using C preprocessor defines; the 204c609719bSwdenkrationale behind that is to avoid dead code whenever possible. 205c609719bSwdenk 206c609719bSwdenkThere are two classes of configuration variables: 207c609719bSwdenk 208c609719bSwdenk* Configuration _OPTIONS_: 209c609719bSwdenk These are selectable by the user and have names beginning with 210c609719bSwdenk "CONFIG_". 211c609719bSwdenk 212c609719bSwdenk* Configuration _SETTINGS_: 213c609719bSwdenk These depend on the hardware etc. and should not be meddled with if 214c609719bSwdenk you don't know what you're doing; they have names beginning with 2156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD "CONFIG_SYS_". 216c609719bSwdenk 217c609719bSwdenkLater we will add a configuration tool - probably similar to or even 218c609719bSwdenkidentical to what's used for the Linux kernel. Right now, we have to 219c609719bSwdenkdo the configuration by hand, which means creating some symbolic 220c609719bSwdenklinks and editing some configuration files. We use the TQM8xxL boards 221c609719bSwdenkas an example here. 222c609719bSwdenk 223c609719bSwdenk 224c609719bSwdenkSelection of Processor Architecture and Board Type: 225c609719bSwdenk--------------------------------------------------- 226c609719bSwdenk 227c609719bSwdenkFor all supported boards there are ready-to-use default 228c609719bSwdenkconfigurations available; just type "make <board_name>_config". 229c609719bSwdenk 230c609719bSwdenkExample: For a TQM823L module type: 231c609719bSwdenk 232c609719bSwdenk cd u-boot 233c609719bSwdenk make TQM823L_config 234c609719bSwdenk 23511ccc33fSMarcel ZiswilerFor the Cogent platform, you need to specify the CPU type as well; 236c609719bSwdenke.g. "make cogent_mpc8xx_config". And also configure the cogent 237c609719bSwdenkdirectory according to the instructions in cogent/README. 238c609719bSwdenk 239c609719bSwdenk 240c609719bSwdenkConfiguration Options: 241c609719bSwdenk---------------------- 242c609719bSwdenk 243c609719bSwdenkConfiguration depends on the combination of board and CPU type; all 244c609719bSwdenksuch information is kept in a configuration file 245c609719bSwdenk"include/configs/<board_name>.h". 246c609719bSwdenk 247c609719bSwdenkExample: For a TQM823L module, all configuration settings are in 248c609719bSwdenk"include/configs/TQM823L.h". 249c609719bSwdenk 250c609719bSwdenk 2517f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux 2527f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to 2537f6c2cbcSwdenkbuild a config tool - later. 2547f6c2cbcSwdenk 2557f6c2cbcSwdenk 256c609719bSwdenkThe following options need to be configured: 257c609719bSwdenk 2582628114eSKim Phillips- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX. 259c609719bSwdenk 2602628114eSKim Phillips- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS. 2616ccec449SWolfgang Denk 2626ccec449SWolfgang Denk- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined) 26309ea0de0SHaavard Skinnemoen Define exactly one, e.g. CONFIG_ATSTK1002 264c609719bSwdenk 265c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined) 266c609719bSwdenk Define exactly one of 267c609719bSwdenk CONFIG_CMA286_60_OLD 268c609719bSwdenk--- FIXME --- not tested yet: 269c609719bSwdenk CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P, 270c609719bSwdenk CONFIG_CMA287_23, CONFIG_CMA287_50 271c609719bSwdenk 272c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined) 273c609719bSwdenk Define exactly one of 274c609719bSwdenk CONFIG_CMA101, CONFIG_CMA102 275c609719bSwdenk 276c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined) 277c609719bSwdenk Define one or more of 278c609719bSwdenk CONFIG_CMA302 279c609719bSwdenk 280c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined) 281c609719bSwdenk Define one or more of 282c609719bSwdenk CONFIG_LCD_HEARTBEAT - update a character position on 28311ccc33fSMarcel Ziswiler the LCD display every second with 284c609719bSwdenk a "rotator" |\-/|\-/ 285c609719bSwdenk 2862535d602Swdenk- Board flavour: (if CONFIG_MPC8260ADS is defined) 2872535d602Swdenk CONFIG_ADSTYPE 2882535d602Swdenk Possible values are: 2896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8260ADS - original MPC8260ADS 2906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8266ADS - MPC8266ADS 2916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR 2926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8272ADS - MPC8272ADS 2932535d602Swdenk 294c609719bSwdenk- MPC824X Family Member (if CONFIG_MPC824X is defined) 295c609719bSwdenk Define exactly one of 296c609719bSwdenk CONFIG_MPC8240, CONFIG_MPC8245 297c609719bSwdenk 29811ccc33fSMarcel Ziswiler- 8xx CPU Options: (if using an MPC8xx CPU) 29966ca92a5Swdenk CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if 30066ca92a5Swdenk get_gclk_freq() cannot work 3015da627a4Swdenk e.g. if there is no 32KHz 3025da627a4Swdenk reference PIT/RTC clock 30366ca92a5Swdenk CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK 30466ca92a5Swdenk or XTAL/EXTAL) 305c609719bSwdenk 30666ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU): 3076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8xx_CPUCLK_MIN 3086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8xx_CPUCLK_MAX 30966ca92a5Swdenk CONFIG_8xx_CPUCLK_DEFAULT 31075d1ea7fSwdenk See doc/README.MPC866 31175d1ea7fSwdenk 3126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MEASURE_CPUCLK 31375d1ea7fSwdenk 31475d1ea7fSwdenk Define this to measure the actual CPU clock instead 31575d1ea7fSwdenk of relying on the correctness of the configured 31675d1ea7fSwdenk values. Mostly useful for board bringup to make sure 31775d1ea7fSwdenk the PLL is locked at the intended frequency. Note 31875d1ea7fSwdenk that this requires a (stable) reference clock (32 kHz 3196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD RTC clock or CONFIG_SYS_8XX_XIN) 32075d1ea7fSwdenk 321506f3918SHeiko Schocher CONFIG_SYS_DELAYED_ICACHE 322506f3918SHeiko Schocher 323506f3918SHeiko Schocher Define this option if you want to enable the 324506f3918SHeiko Schocher ICache only when Code runs from RAM. 325506f3918SHeiko Schocher 3260b953ffcSMarkus Klotzbuecher- Intel Monahans options: 3276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO 3280b953ffcSMarkus Klotzbuecher 3290b953ffcSMarkus Klotzbuecher Defines the Monahans run mode to oscillator 3300b953ffcSMarkus Klotzbuecher ratio. Valid values are 8, 16, 24, 31. The core 3310b953ffcSMarkus Klotzbuecher frequency is this value multiplied by 13 MHz. 3320b953ffcSMarkus Klotzbuecher 3336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO 3340b953ffcSMarkus Klotzbuecher 3350b953ffcSMarkus Klotzbuecher Defines the Monahans turbo mode to oscillator 3360b953ffcSMarkus Klotzbuecher ratio. Valid values are 1 (default if undefined) and 3370b953ffcSMarkus Klotzbuecher 2. The core frequency as calculated above is multiplied 3380b953ffcSMarkus Klotzbuecher by this value. 3390b953ffcSMarkus Klotzbuecher 3405da627a4Swdenk- Linux Kernel Interface: 341c609719bSwdenk CONFIG_CLOCKS_IN_MHZ 342c609719bSwdenk 343c609719bSwdenk U-Boot stores all clock information in Hz 344c609719bSwdenk internally. For binary compatibility with older Linux 345c609719bSwdenk kernels (which expect the clocks passed in the 346c609719bSwdenk bd_info data to be in MHz) the environment variable 347c609719bSwdenk "clocks_in_mhz" can be defined so that U-Boot 348c609719bSwdenk converts clock data to MHZ before passing it to the 349c609719bSwdenk Linux kernel. 350c609719bSwdenk When CONFIG_CLOCKS_IN_MHZ is defined, a definition of 351c609719bSwdenk "clocks_in_mhz=1" is automatically included in the 352c609719bSwdenk default environment. 353c609719bSwdenk 3545da627a4Swdenk CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only] 3555da627a4Swdenk 35611ccc33fSMarcel Ziswiler When transferring memsize parameter to linux, some versions 3575da627a4Swdenk expect it to be in bytes, others in MB. 3585da627a4Swdenk Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes. 3595da627a4Swdenk 360fec6d9eeSGerald Van Baren CONFIG_OF_LIBFDT 361f57f70aaSWolfgang Denk 362f57f70aaSWolfgang Denk New kernel versions are expecting firmware settings to be 363213bf8c8SGerald Van Baren passed using flattened device trees (based on open firmware 364213bf8c8SGerald Van Baren concepts). 365213bf8c8SGerald Van Baren 366213bf8c8SGerald Van Baren CONFIG_OF_LIBFDT 367213bf8c8SGerald Van Baren * New libfdt-based support 368213bf8c8SGerald Van Baren * Adds the "fdt" command 3693bb342fcSKim Phillips * The bootm command automatically updates the fdt 370213bf8c8SGerald Van Baren 371f57f70aaSWolfgang Denk OF_CPU - The proper name of the cpus node. 372c2871f03SKumar Gala OF_SOC - The proper name of the soc node. 373f57f70aaSWolfgang Denk OF_TBCLK - The timebase frequency. 374c2871f03SKumar Gala OF_STDOUT_PATH - The path to the console device 375f57f70aaSWolfgang Denk 37611ccc33fSMarcel Ziswiler boards with QUICC Engines require OF_QE to set UCC MAC 37711ccc33fSMarcel Ziswiler addresses 3783bb342fcSKim Phillips 3794e253137SKumar Gala CONFIG_OF_BOARD_SETUP 3804e253137SKumar Gala 3814e253137SKumar Gala Board code has addition modification that it wants to make 3824e253137SKumar Gala to the flat device tree before handing it off to the kernel 3836705d81eSwdenk 3840267768eSMatthew McClintock CONFIG_OF_BOOT_CPU 3850267768eSMatthew McClintock 38611ccc33fSMarcel Ziswiler This define fills in the correct boot CPU in the boot 3870267768eSMatthew McClintock param header, the default value is zero if undefined. 3880267768eSMatthew McClintock 3890b2f4ecaSNiklaus Giger- vxWorks boot parameters: 3900b2f4ecaSNiklaus Giger 3910b2f4ecaSNiklaus Giger bootvx constructs a valid bootline using the following 3920b2f4ecaSNiklaus Giger environments variables: bootfile, ipaddr, serverip, hostname. 3930b2f4ecaSNiklaus Giger It loads the vxWorks image pointed bootfile. 3940b2f4ecaSNiklaus Giger 3950b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name 3960b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address 3970b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server 3980b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters 3990b2f4ecaSNiklaus Giger 4000b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_ADD_PARAMS 4010b2f4ecaSNiklaus Giger 4020b2f4ecaSNiklaus Giger Add it at the end of the bootline. E.g "u=username pw=secret" 4030b2f4ecaSNiklaus Giger 4040b2f4ecaSNiklaus Giger Note: If a "bootargs" environment is defined, it will overwride 4050b2f4ecaSNiklaus Giger the defaults discussed just above. 4060b2f4ecaSNiklaus Giger 4076705d81eSwdenk- Serial Ports: 40848d0192fSAndreas Engel CONFIG_PL010_SERIAL 4096705d81eSwdenk 4106705d81eSwdenk Define this if you want support for Amba PrimeCell PL010 UARTs. 4116705d81eSwdenk 41248d0192fSAndreas Engel CONFIG_PL011_SERIAL 4136705d81eSwdenk 4146705d81eSwdenk Define this if you want support for Amba PrimeCell PL011 UARTs. 4156705d81eSwdenk 4166705d81eSwdenk CONFIG_PL011_CLOCK 4176705d81eSwdenk 4186705d81eSwdenk If you have Amba PrimeCell PL011 UARTs, set this variable to 4196705d81eSwdenk the clock speed of the UARTs. 4206705d81eSwdenk 4216705d81eSwdenk CONFIG_PL01x_PORTS 4226705d81eSwdenk 4236705d81eSwdenk If you have Amba PrimeCell PL010 or PL011 UARTs on your board, 4246705d81eSwdenk define this to a list of base addresses for each (supported) 4256705d81eSwdenk port. See e.g. include/configs/versatile.h 4266705d81eSwdenk 4276705d81eSwdenk 428c609719bSwdenk- Console Interface: 429c609719bSwdenk Depending on board, define exactly one serial port 430c609719bSwdenk (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2, 431c609719bSwdenk CONFIG_8xx_CONS_SCC1, ...), or switch off the serial 432c609719bSwdenk console by defining CONFIG_8xx_CONS_NONE 433c609719bSwdenk 434c609719bSwdenk Note: if CONFIG_8xx_CONS_NONE is defined, the serial 435c609719bSwdenk port routines must be defined elsewhere 436c609719bSwdenk (i.e. serial_init(), serial_getc(), ...) 437c609719bSwdenk 438c609719bSwdenk CONFIG_CFB_CONSOLE 439c609719bSwdenk Enables console device for a color framebuffer. Needs following 440c609719bSwdenk defines (cf. smiLynxEM, i8042, board/eltec/bab7xx) 441c609719bSwdenk VIDEO_FB_LITTLE_ENDIAN graphic memory organisation 442c609719bSwdenk (default big endian) 443c609719bSwdenk VIDEO_HW_RECTFILL graphic chip supports 444c609719bSwdenk rectangle fill 445c609719bSwdenk (cf. smiLynxEM) 446c609719bSwdenk VIDEO_HW_BITBLT graphic chip supports 447c609719bSwdenk bit-blit (cf. smiLynxEM) 448c609719bSwdenk VIDEO_VISIBLE_COLS visible pixel columns 449c609719bSwdenk (cols=pitch) 450c609719bSwdenk VIDEO_VISIBLE_ROWS visible pixel rows 451c609719bSwdenk VIDEO_PIXEL_SIZE bytes per pixel 452c609719bSwdenk VIDEO_DATA_FORMAT graphic data format 453c609719bSwdenk (0-5, cf. cfb_console.c) 454c609719bSwdenk VIDEO_FB_ADRS framebuffer address 455c609719bSwdenk VIDEO_KBD_INIT_FCT keyboard int fct 456c609719bSwdenk (i.e. i8042_kbd_init()) 457c609719bSwdenk VIDEO_TSTC_FCT test char fct 458c609719bSwdenk (i.e. i8042_tstc) 459c609719bSwdenk VIDEO_GETC_FCT get char fct 460c609719bSwdenk (i.e. i8042_getc) 461c609719bSwdenk CONFIG_CONSOLE_CURSOR cursor drawing on/off 462c609719bSwdenk (requires blink timer 463c609719bSwdenk cf. i8042.c) 4646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c) 465c609719bSwdenk CONFIG_CONSOLE_TIME display time/date info in 466c609719bSwdenk upper right corner 467602ad3b3SJon Loeliger (requires CONFIG_CMD_DATE) 468c609719bSwdenk CONFIG_VIDEO_LOGO display Linux logo in 469c609719bSwdenk upper left corner 470a6c7ad2fSwdenk CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of 471a6c7ad2fSwdenk linux_logo.h for logo. 472a6c7ad2fSwdenk Requires CONFIG_VIDEO_LOGO 473c609719bSwdenk CONFIG_CONSOLE_EXTRA_INFO 47411ccc33fSMarcel Ziswiler additional board info beside 475c609719bSwdenk the logo 476c609719bSwdenk 477c609719bSwdenk When CONFIG_CFB_CONSOLE is defined, video console is 478c609719bSwdenk default i/o. Serial console can be forced with 479c609719bSwdenk environment 'console=serial'. 480c609719bSwdenk 481a3ad8e26Swdenk When CONFIG_SILENT_CONSOLE is defined, all console 482a3ad8e26Swdenk messages (by U-Boot and Linux!) can be silenced with 483a3ad8e26Swdenk the "silent" environment variable. See 484a3ad8e26Swdenk doc/README.silent for more information. 485a3ad8e26Swdenk 486c609719bSwdenk- Console Baudrate: 487c609719bSwdenk CONFIG_BAUDRATE - in bps 488c609719bSwdenk Select one of the baudrates listed in 4896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BAUDRATE_TABLE, see below. 4906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale 491c609719bSwdenk 492c92fac91SHeiko Schocher- Console Rx buffer length 493c92fac91SHeiko Schocher With CONFIG_SYS_SMC_RXBUFLEN it is possible to define 494c92fac91SHeiko Schocher the maximum receive buffer length for the SMC. 4952b3f12c2SHeiko Schocher This option is actual only for 82xx and 8xx possible. 496c92fac91SHeiko Schocher If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE 497c92fac91SHeiko Schocher must be defined, to setup the maximum idle timeout for 498c92fac91SHeiko Schocher the SMC. 499c92fac91SHeiko Schocher 500c609719bSwdenk- Interrupt driven serial port input: 501c609719bSwdenk CONFIG_SERIAL_SOFTWARE_FIFO 502c609719bSwdenk 503c609719bSwdenk PPC405GP only. 504c609719bSwdenk Use an interrupt handler for receiving data on the 505c609719bSwdenk serial port. It also enables using hardware handshake 506c609719bSwdenk (RTS/CTS) and UART's built-in FIFO. Set the number of 507c609719bSwdenk bytes the interrupt driven input buffer should have. 508c609719bSwdenk 509109c0e3aSwdenk Leave undefined to disable this feature, including 510109c0e3aSwdenk disable the buffer and hardware handshake. 511c609719bSwdenk 5121d49b1f3Sstroese- Console UART Number: 5131d49b1f3Sstroese CONFIG_UART1_CONSOLE 5141d49b1f3Sstroese 5150c8721a4SWolfgang Denk AMCC PPC4xx only. 5161d49b1f3Sstroese If defined internal UART1 (and not UART0) is used 5171d49b1f3Sstroese as default U-Boot console. 5181d49b1f3Sstroese 519c609719bSwdenk- Boot Delay: CONFIG_BOOTDELAY - in seconds 520c609719bSwdenk Delay before automatically booting the default image; 521c609719bSwdenk set to -1 to disable autoboot. 522c609719bSwdenk 523c609719bSwdenk See doc/README.autoboot for these options that 524c609719bSwdenk work with CONFIG_BOOTDELAY. None are required. 525c609719bSwdenk CONFIG_BOOT_RETRY_TIME 526c609719bSwdenk CONFIG_BOOT_RETRY_MIN 527c609719bSwdenk CONFIG_AUTOBOOT_KEYED 528c609719bSwdenk CONFIG_AUTOBOOT_PROMPT 529c609719bSwdenk CONFIG_AUTOBOOT_DELAY_STR 530c609719bSwdenk CONFIG_AUTOBOOT_STOP_STR 531c609719bSwdenk CONFIG_AUTOBOOT_DELAY_STR2 532c609719bSwdenk CONFIG_AUTOBOOT_STOP_STR2 533c609719bSwdenk CONFIG_ZERO_BOOTDELAY_CHECK 534c609719bSwdenk CONFIG_RESET_TO_RETRY 535c609719bSwdenk 536c609719bSwdenk- Autoboot Command: 537c609719bSwdenk CONFIG_BOOTCOMMAND 538c609719bSwdenk Only needed when CONFIG_BOOTDELAY is enabled; 539c609719bSwdenk define a command string that is automatically executed 540c609719bSwdenk when no character is read on the console interface 541c609719bSwdenk within "Boot Delay" after reset. 542c609719bSwdenk 543c609719bSwdenk CONFIG_BOOTARGS 544c609719bSwdenk This can be used to pass arguments to the bootm 545c609719bSwdenk command. The value of CONFIG_BOOTARGS goes into the 546c609719bSwdenk environment value "bootargs". 547c609719bSwdenk 548c609719bSwdenk CONFIG_RAMBOOT and CONFIG_NFSBOOT 549c609719bSwdenk The value of these goes into the environment as 550c609719bSwdenk "ramboot" and "nfsboot" respectively, and can be used 551c609719bSwdenk as a convenience, when switching between booting from 55211ccc33fSMarcel Ziswiler RAM and NFS. 553c609719bSwdenk 554c609719bSwdenk- Pre-Boot Commands: 555c609719bSwdenk CONFIG_PREBOOT 556c609719bSwdenk 557c609719bSwdenk When this option is #defined, the existence of the 558c609719bSwdenk environment variable "preboot" will be checked 559c609719bSwdenk immediately before starting the CONFIG_BOOTDELAY 560c609719bSwdenk countdown and/or running the auto-boot command resp. 561c609719bSwdenk entering interactive mode. 562c609719bSwdenk 563c609719bSwdenk This feature is especially useful when "preboot" is 564c609719bSwdenk automatically generated or modified. For an example 565c609719bSwdenk see the LWMON board specific code: here "preboot" is 566c609719bSwdenk modified when the user holds down a certain 567c609719bSwdenk combination of keys on the (special) keyboard when 568c609719bSwdenk booting the systems 569c609719bSwdenk 570c609719bSwdenk- Serial Download Echo Mode: 571c609719bSwdenk CONFIG_LOADS_ECHO 572c609719bSwdenk If defined to 1, all characters received during a 573c609719bSwdenk serial download (using the "loads" command) are 574c609719bSwdenk echoed back. This might be needed by some terminal 575c609719bSwdenk emulations (like "cu"), but may as well just take 576c609719bSwdenk time on others. This setting #define's the initial 577c609719bSwdenk value of the "loads_echo" environment variable. 578c609719bSwdenk 579602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined) 580c609719bSwdenk CONFIG_KGDB_BAUDRATE 581c609719bSwdenk Select one of the baudrates listed in 5826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BAUDRATE_TABLE, see below. 583c609719bSwdenk 584c609719bSwdenk- Monitor Functions: 585602ad3b3SJon Loeliger Monitor commands can be included or excluded 586602ad3b3SJon Loeliger from the build by using the #include files 587602ad3b3SJon Loeliger "config_cmd_all.h" and #undef'ing unwanted 588602ad3b3SJon Loeliger commands, or using "config_cmd_default.h" 589602ad3b3SJon Loeliger and augmenting with additional #define's 590602ad3b3SJon Loeliger for wanted commands. 591c609719bSwdenk 592602ad3b3SJon Loeliger The default command configuration includes all commands 593602ad3b3SJon Loeliger except those marked below with a "*". 594602ad3b3SJon Loeliger 595602ad3b3SJon Loeliger CONFIG_CMD_ASKENV * ask for env variable 596602ad3b3SJon Loeliger CONFIG_CMD_BDI bdinfo 597602ad3b3SJon Loeliger CONFIG_CMD_BEDBUG * Include BedBug Debugger 598602ad3b3SJon Loeliger CONFIG_CMD_BMP * BMP support 599602ad3b3SJon Loeliger CONFIG_CMD_BSP * Board specific commands 600602ad3b3SJon Loeliger CONFIG_CMD_BOOTD bootd 601602ad3b3SJon Loeliger CONFIG_CMD_CACHE * icache, dcache 602602ad3b3SJon Loeliger CONFIG_CMD_CONSOLE coninfo 603602ad3b3SJon Loeliger CONFIG_CMD_DATE * support for RTC, date/time... 604602ad3b3SJon Loeliger CONFIG_CMD_DHCP * DHCP support 605602ad3b3SJon Loeliger CONFIG_CMD_DIAG * Diagnostics 606a7c93104SPeter Tyser CONFIG_CMD_DS4510 * ds4510 I2C gpio commands 607a7c93104SPeter Tyser CONFIG_CMD_DS4510_INFO * ds4510 I2C info command 608a7c93104SPeter Tyser CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd 609a7c93104SPeter Tyser CONFIG_CMD_DS4510_RST * ds4510 I2C rst command 610602ad3b3SJon Loeliger CONFIG_CMD_DTT * Digital Therm and Thermostat 611602ad3b3SJon Loeliger CONFIG_CMD_ECHO echo arguments 612602ad3b3SJon Loeliger CONFIG_CMD_EEPROM * EEPROM read/write support 613602ad3b3SJon Loeliger CONFIG_CMD_ELF * bootelf, bootvx 614bdab39d3SMike Frysinger CONFIG_CMD_SAVEENV saveenv 615602ad3b3SJon Loeliger CONFIG_CMD_FDC * Floppy Disk Support 616602ad3b3SJon Loeliger CONFIG_CMD_FAT * FAT partition support 617602ad3b3SJon Loeliger CONFIG_CMD_FDOS * Dos diskette Support 618602ad3b3SJon Loeliger CONFIG_CMD_FLASH flinfo, erase, protect 619602ad3b3SJon Loeliger CONFIG_CMD_FPGA FPGA device initialization support 620602ad3b3SJon Loeliger CONFIG_CMD_HWFLOW * RTS/CTS hw flow control 621602ad3b3SJon Loeliger CONFIG_CMD_I2C * I2C serial bus support 622602ad3b3SJon Loeliger CONFIG_CMD_IDE * IDE harddisk support 623602ad3b3SJon Loeliger CONFIG_CMD_IMI iminfo 624602ad3b3SJon Loeliger CONFIG_CMD_IMLS List all found images 625602ad3b3SJon Loeliger CONFIG_CMD_IMMAP * IMMR dump support 626602ad3b3SJon Loeliger CONFIG_CMD_IRQ * irqinfo 627602ad3b3SJon Loeliger CONFIG_CMD_ITEST Integer/string test of 2 values 628602ad3b3SJon Loeliger CONFIG_CMD_JFFS2 * JFFS2 Support 629602ad3b3SJon Loeliger CONFIG_CMD_KGDB * kgdb 630602ad3b3SJon Loeliger CONFIG_CMD_LOADB loadb 631602ad3b3SJon Loeliger CONFIG_CMD_LOADS loads 632602ad3b3SJon Loeliger CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base, 63356523f12Swdenk loop, loopw, mtest 634602ad3b3SJon Loeliger CONFIG_CMD_MISC Misc functions like sleep etc 635602ad3b3SJon Loeliger CONFIG_CMD_MMC * MMC memory mapped support 636602ad3b3SJon Loeliger CONFIG_CMD_MII * MII utility commands 63768d7d651SStefan Roese CONFIG_CMD_MTDPARTS * MTD partition support 638602ad3b3SJon Loeliger CONFIG_CMD_NAND * NAND support 639602ad3b3SJon Loeliger CONFIG_CMD_NET bootp, tftpboot, rarpboot 640e92739d3SPeter Tyser CONFIG_CMD_PCA953X * PCA953x I2C gpio commands 641e92739d3SPeter Tyser CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command 642602ad3b3SJon Loeliger CONFIG_CMD_PCI * pciinfo 643602ad3b3SJon Loeliger CONFIG_CMD_PCMCIA * PCMCIA support 644602ad3b3SJon Loeliger CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network 645602ad3b3SJon Loeliger host 646602ad3b3SJon Loeliger CONFIG_CMD_PORTIO * Port I/O 647602ad3b3SJon Loeliger CONFIG_CMD_REGINFO * Register dump 648602ad3b3SJon Loeliger CONFIG_CMD_RUN run command in env variable 649602ad3b3SJon Loeliger CONFIG_CMD_SAVES * save S record dump 650602ad3b3SJon Loeliger CONFIG_CMD_SCSI * SCSI Support 651602ad3b3SJon Loeliger CONFIG_CMD_SDRAM * print SDRAM configuration information 652602ad3b3SJon Loeliger (requires CONFIG_CMD_I2C) 653602ad3b3SJon Loeliger CONFIG_CMD_SETGETDCR Support for DCR Register access 654602ad3b3SJon Loeliger (4xx only) 65574de7aefSWolfgang Denk CONFIG_CMD_SOURCE "source" command Support 656602ad3b3SJon Loeliger CONFIG_CMD_SPI * SPI serial bus support 657602ad3b3SJon Loeliger CONFIG_CMD_USB * USB support 658602ad3b3SJon Loeliger CONFIG_CMD_VFD * VFD support (TRAB) 659602ad3b3SJon Loeliger CONFIG_CMD_CDP * Cisco Discover Protocol support 660602ad3b3SJon Loeliger CONFIG_CMD_FSL * Microblaze FSL support 661c609719bSwdenk 662c609719bSwdenk 663c609719bSwdenk EXAMPLE: If you want all functions except of network 664c609719bSwdenk support you can write: 665c609719bSwdenk 666602ad3b3SJon Loeliger #include "config_cmd_all.h" 667602ad3b3SJon Loeliger #undef CONFIG_CMD_NET 668c609719bSwdenk 669213bf8c8SGerald Van Baren Other Commands: 670213bf8c8SGerald Van Baren fdt (flattened device tree) command: CONFIG_OF_LIBFDT 671c609719bSwdenk 672c609719bSwdenk Note: Don't enable the "icache" and "dcache" commands 673602ad3b3SJon Loeliger (configuration option CONFIG_CMD_CACHE) unless you know 674c609719bSwdenk what you (and your U-Boot users) are doing. Data 675c609719bSwdenk cache cannot be enabled on systems like the 8xx or 676c609719bSwdenk 8260 (where accesses to the IMMR region must be 677c609719bSwdenk uncached), and it cannot be disabled on all other 678c609719bSwdenk systems where we (mis-) use the data cache to hold an 679c609719bSwdenk initial stack and some data. 680c609719bSwdenk 681c609719bSwdenk 682c609719bSwdenk XXX - this list needs to get updated! 683c609719bSwdenk 684c609719bSwdenk- Watchdog: 685c609719bSwdenk CONFIG_WATCHDOG 686c609719bSwdenk If this variable is defined, it enables watchdog 6877152b1d0Swdenk support. There must be support in the platform specific 688c609719bSwdenk code for a watchdog. For the 8xx and 8260 CPUs, the 689c609719bSwdenk SIU Watchdog feature is enabled in the SYPCR 690c609719bSwdenk register. 691c609719bSwdenk 692c1551ea8Sstroese- U-Boot Version: 693c1551ea8Sstroese CONFIG_VERSION_VARIABLE 694c1551ea8Sstroese If this variable is defined, an environment variable 695c1551ea8Sstroese named "ver" is created by U-Boot showing the U-Boot 696c1551ea8Sstroese version as printed by the "version" command. 697c1551ea8Sstroese This variable is readonly. 698c1551ea8Sstroese 699c609719bSwdenk- Real-Time Clock: 700c609719bSwdenk 701602ad3b3SJon Loeliger When CONFIG_CMD_DATE is selected, the type of the RTC 702c609719bSwdenk has to be selected, too. Define exactly one of the 703c609719bSwdenk following options: 704c609719bSwdenk 705c609719bSwdenk CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx 706c609719bSwdenk CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC 7077ce63709SGuennadi Liakhovetski CONFIG_RTC_MC13783 - use MC13783 RTC 708c609719bSwdenk CONFIG_RTC_MC146818 - use MC146818 RTC 7091cb8e980Swdenk CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC 710c609719bSwdenk CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC 7117f70e853Swdenk CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC 7123bac3513Swdenk CONFIG_RTC_DS164x - use Dallas DS164x RTC 7139536dfccSTor Krill CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC 7144c0d4c3bSwdenk CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC 7156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337 716c609719bSwdenk 717b37c7e5eSwdenk Note that if the RTC uses I2C, then the I2C interface 718b37c7e5eSwdenk must also be configured. See I2C Support, below. 719b37c7e5eSwdenk 720e92739d3SPeter Tyser- GPIO Support: 721e92739d3SPeter Tyser CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO 722e92739d3SPeter Tyser CONFIG_PCA953X_INFO - enable pca953x info command 723e92739d3SPeter Tyser 724e92739d3SPeter Tyser Note that if the GPIO device uses I2C, then the I2C interface 725e92739d3SPeter Tyser must also be configured. See I2C Support, below. 726e92739d3SPeter Tyser 727c609719bSwdenk- Timestamp Support: 728c609719bSwdenk 729c609719bSwdenk When CONFIG_TIMESTAMP is selected, the timestamp 730c609719bSwdenk (date and time) of an image is printed by image 731c609719bSwdenk commands like bootm or iminfo. This option is 732602ad3b3SJon Loeliger automatically enabled when you select CONFIG_CMD_DATE . 733c609719bSwdenk 734c609719bSwdenk- Partition Support: 735c609719bSwdenk CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION 73607f3d789Srichardretanubun and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION 737c609719bSwdenk 738602ad3b3SJon Loeliger If IDE or SCSI support is enabled (CONFIG_CMD_IDE or 739218ca724SWolfgang Denk CONFIG_CMD_SCSI) you must configure support for at 740218ca724SWolfgang Denk least one partition type as well. 741c609719bSwdenk 742c609719bSwdenk- IDE Reset method: 7434d13cbadSwdenk CONFIG_IDE_RESET_ROUTINE - this is defined in several 7444d13cbadSwdenk board configurations files but used nowhere! 745c609719bSwdenk 7464d13cbadSwdenk CONFIG_IDE_RESET - is this is defined, IDE Reset will 7474d13cbadSwdenk be performed by calling the function 7484d13cbadSwdenk ide_set_reset(int reset) 7494d13cbadSwdenk which has to be defined in a board specific file 750c609719bSwdenk 751c609719bSwdenk- ATAPI Support: 752c609719bSwdenk CONFIG_ATAPI 753c609719bSwdenk 754c609719bSwdenk Set this to enable ATAPI support. 755c609719bSwdenk 756c40b2956Swdenk- LBA48 Support 757c40b2956Swdenk CONFIG_LBA48 758c40b2956Swdenk 759c40b2956Swdenk Set this to enable support for disks larger than 137GB 7606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD Also look at CONFIG_SYS_64BIT_LBA ,CONFIG_SYS_64BIT_VSPRINTF and CONFIG_SYS_64BIT_STRTOUL 761c40b2956Swdenk Whithout these , LBA48 support uses 32bit variables and will 'only' 762c40b2956Swdenk support disks up to 2.1TB. 763c40b2956Swdenk 7646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_64BIT_LBA: 765c40b2956Swdenk When enabled, makes the IDE subsystem use 64bit sector addresses. 766c40b2956Swdenk Default is 32bit. 767c40b2956Swdenk 768c609719bSwdenk- SCSI Support: 769c609719bSwdenk At the moment only there is only support for the 770c609719bSwdenk SYM53C8XX SCSI controller; define 771c609719bSwdenk CONFIG_SCSI_SYM53C8XX to enable it. 772c609719bSwdenk 7736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and 7746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID * 7756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the 776c609719bSwdenk maximum numbers of LUNs, SCSI ID's and target 777c609719bSwdenk devices. 7786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz) 779c609719bSwdenk 780c609719bSwdenk- NETWORK Support (PCI): 781682011ffSwdenk CONFIG_E1000 782682011ffSwdenk Support for Intel 8254x gigabit chips. 783682011ffSwdenk 784ac3315c2SAndre Schwarz CONFIG_E1000_FALLBACK_MAC 78511ccc33fSMarcel Ziswiler default MAC for empty EEPROM after production. 786ac3315c2SAndre Schwarz 787c609719bSwdenk CONFIG_EEPRO100 788c609719bSwdenk Support for Intel 82557/82559/82559ER chips. 78911ccc33fSMarcel Ziswiler Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM 790c609719bSwdenk write routine for first time initialisation. 791c609719bSwdenk 792c609719bSwdenk CONFIG_TULIP 793c609719bSwdenk Support for Digital 2114x chips. 794c609719bSwdenk Optional CONFIG_TULIP_SELECT_MEDIA for board specific 795c609719bSwdenk modem chip initialisation (KS8761/QS6611). 796c609719bSwdenk 797c609719bSwdenk CONFIG_NATSEMI 798c609719bSwdenk Support for National dp83815 chips. 799c609719bSwdenk 800c609719bSwdenk CONFIG_NS8382X 801c609719bSwdenk Support for National dp8382[01] gigabit chips. 802c609719bSwdenk 80345219c46Swdenk- NETWORK Support (other): 80445219c46Swdenk 80545219c46Swdenk CONFIG_DRIVER_LAN91C96 80645219c46Swdenk Support for SMSC's LAN91C96 chips. 80745219c46Swdenk 80845219c46Swdenk CONFIG_LAN91C96_BASE 80945219c46Swdenk Define this to hold the physical address 81045219c46Swdenk of the LAN91C96's I/O space 81145219c46Swdenk 81245219c46Swdenk CONFIG_LAN91C96_USE_32_BIT 81345219c46Swdenk Define this to enable 32 bit addressing 81445219c46Swdenk 815f39748aeSwdenk CONFIG_DRIVER_SMC91111 816f39748aeSwdenk Support for SMSC's LAN91C111 chip 817f39748aeSwdenk 818f39748aeSwdenk CONFIG_SMC91111_BASE 819f39748aeSwdenk Define this to hold the physical address 820f39748aeSwdenk of the device (I/O space) 821f39748aeSwdenk 822f39748aeSwdenk CONFIG_SMC_USE_32_BIT 823f39748aeSwdenk Define this if data bus is 32 bits 824f39748aeSwdenk 825f39748aeSwdenk CONFIG_SMC_USE_IOFUNCS 826f39748aeSwdenk Define this to use i/o functions instead of macros 827f39748aeSwdenk (some hardware wont work with macros) 828f39748aeSwdenk 829557b377dSJens Gehrlein CONFIG_DRIVER_SMC911X 830557b377dSJens Gehrlein Support for SMSC's LAN911x and LAN921x chips 831557b377dSJens Gehrlein 832557b377dSJens Gehrlein CONFIG_DRIVER_SMC911X_BASE 833557b377dSJens Gehrlein Define this to hold the physical address 834557b377dSJens Gehrlein of the device (I/O space) 835557b377dSJens Gehrlein 836557b377dSJens Gehrlein CONFIG_DRIVER_SMC911X_32_BIT 837557b377dSJens Gehrlein Define this if data bus is 32 bits 838557b377dSJens Gehrlein 839557b377dSJens Gehrlein CONFIG_DRIVER_SMC911X_16_BIT 840557b377dSJens Gehrlein Define this if data bus is 16 bits. If your processor 841557b377dSJens Gehrlein automatically converts one 32 bit word to two 16 bit 842557b377dSJens Gehrlein words you may also try CONFIG_DRIVER_SMC911X_32_BIT. 843557b377dSJens Gehrlein 844c609719bSwdenk- USB Support: 845c609719bSwdenk At the moment only the UHCI host controller is 8464d13cbadSwdenk supported (PIP405, MIP405, MPC5200); define 847c609719bSwdenk CONFIG_USB_UHCI to enable it. 848c609719bSwdenk define CONFIG_USB_KEYBOARD to enable the USB Keyboard 84930d56faeSwdenk and define CONFIG_USB_STORAGE to enable the USB 850c609719bSwdenk storage devices. 851c609719bSwdenk Note: 852c609719bSwdenk Supported are USB Keyboards and USB Floppy drives 853c609719bSwdenk (TEAC FD-05PUB). 8544d13cbadSwdenk MPC5200 USB requires additional defines: 8554d13cbadSwdenk CONFIG_USB_CLOCK 8564d13cbadSwdenk for 528 MHz Clock: 0x0001bbbb 8574d13cbadSwdenk CONFIG_USB_CONFIG 8584d13cbadSwdenk for differential drivers: 0x00001000 8594d13cbadSwdenk for single ended drivers: 0x00005000 8606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_USB_EVENT_POLL 861fdcfaa1bSZhang Wei May be defined to allow interrupt polling 862fdcfaa1bSZhang Wei instead of using asynchronous interrupts 8634d13cbadSwdenk 86416c8d5e7SWolfgang Denk- USB Device: 86516c8d5e7SWolfgang Denk Define the below if you wish to use the USB console. 86616c8d5e7SWolfgang Denk Once firmware is rebuilt from a serial console issue the 86716c8d5e7SWolfgang Denk command "setenv stdin usbtty; setenv stdout usbtty" and 86811ccc33fSMarcel Ziswiler attach your USB cable. The Unix command "dmesg" should print 86916c8d5e7SWolfgang Denk it has found a new device. The environment variable usbtty 87016c8d5e7SWolfgang Denk can be set to gserial or cdc_acm to enable your device to 87116c8d5e7SWolfgang Denk appear to a USB host as a Linux gserial device or a 87216c8d5e7SWolfgang Denk Common Device Class Abstract Control Model serial device. 87316c8d5e7SWolfgang Denk If you select usbtty = gserial you should be able to enumerate 87416c8d5e7SWolfgang Denk a Linux host by 87516c8d5e7SWolfgang Denk # modprobe usbserial vendor=0xVendorID product=0xProductID 87616c8d5e7SWolfgang Denk else if using cdc_acm, simply setting the environment 87716c8d5e7SWolfgang Denk variable usbtty to be cdc_acm should suffice. The following 87816c8d5e7SWolfgang Denk might be defined in YourBoardName.h 87916c8d5e7SWolfgang Denk 88016c8d5e7SWolfgang Denk CONFIG_USB_DEVICE 88116c8d5e7SWolfgang Denk Define this to build a UDC device 88216c8d5e7SWolfgang Denk 88316c8d5e7SWolfgang Denk CONFIG_USB_TTY 88416c8d5e7SWolfgang Denk Define this to have a tty type of device available to 88516c8d5e7SWolfgang Denk talk to the UDC device 88616c8d5e7SWolfgang Denk 8876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_CONSOLE_IS_IN_ENV 88816c8d5e7SWolfgang Denk Define this if you want stdin, stdout &/or stderr to 88916c8d5e7SWolfgang Denk be set to usbtty. 89016c8d5e7SWolfgang Denk 89116c8d5e7SWolfgang Denk mpc8xx: 8926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_USB_EXTC_CLK 0xBLAH 89316c8d5e7SWolfgang Denk Derive USB clock from external clock "blah" 8946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_USB_EXTC_CLK 0x02 89516c8d5e7SWolfgang Denk 8966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_USB_BRG_CLK 0xBLAH 89716c8d5e7SWolfgang Denk Derive USB clock from brgclk 8986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_USB_BRG_CLK 0x04 89916c8d5e7SWolfgang Denk 90016c8d5e7SWolfgang Denk If you have a USB-IF assigned VendorID then you may wish to 90116c8d5e7SWolfgang Denk define your own vendor specific values either in BoardName.h 90216c8d5e7SWolfgang Denk or directly in usbd_vendor_info.h. If you don't define 90316c8d5e7SWolfgang Denk CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME, 90416c8d5e7SWolfgang Denk CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot 90516c8d5e7SWolfgang Denk should pretend to be a Linux device to it's target host. 90616c8d5e7SWolfgang Denk 90716c8d5e7SWolfgang Denk CONFIG_USBD_MANUFACTURER 90816c8d5e7SWolfgang Denk Define this string as the name of your company for 90916c8d5e7SWolfgang Denk - CONFIG_USBD_MANUFACTURER "my company" 91016c8d5e7SWolfgang Denk 91116c8d5e7SWolfgang Denk CONFIG_USBD_PRODUCT_NAME 91216c8d5e7SWolfgang Denk Define this string as the name of your product 91316c8d5e7SWolfgang Denk - CONFIG_USBD_PRODUCT_NAME "acme usb device" 91416c8d5e7SWolfgang Denk 91516c8d5e7SWolfgang Denk CONFIG_USBD_VENDORID 91616c8d5e7SWolfgang Denk Define this as your assigned Vendor ID from the USB 91716c8d5e7SWolfgang Denk Implementors Forum. This *must* be a genuine Vendor ID 91816c8d5e7SWolfgang Denk to avoid polluting the USB namespace. 91916c8d5e7SWolfgang Denk - CONFIG_USBD_VENDORID 0xFFFF 92016c8d5e7SWolfgang Denk 92116c8d5e7SWolfgang Denk CONFIG_USBD_PRODUCTID 92216c8d5e7SWolfgang Denk Define this as the unique Product ID 92316c8d5e7SWolfgang Denk for your device 92416c8d5e7SWolfgang Denk - CONFIG_USBD_PRODUCTID 0xFFFF 925c609719bSwdenk 926c609719bSwdenk 927c609719bSwdenk- MMC Support: 928c609719bSwdenk The MMC controller on the Intel PXA is supported. To 929c609719bSwdenk enable this define CONFIG_MMC. The MMC can be 930c609719bSwdenk accessed from the boot prompt by mapping the device 931c609719bSwdenk to physical memory similar to flash. Command line is 932602ad3b3SJon Loeliger enabled with CONFIG_CMD_MMC. The MMC driver also works with 933602ad3b3SJon Loeliger the FAT fs. This is enabled with CONFIG_CMD_FAT. 934c609719bSwdenk 9356705d81eSwdenk- Journaling Flash filesystem support: 9366705d81eSwdenk CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE, 9376705d81eSwdenk CONFIG_JFFS2_NAND_DEV 9386705d81eSwdenk Define these for a default partition on a NAND device 9396705d81eSwdenk 9406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS2_FIRST_SECTOR, 9416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS 9426705d81eSwdenk Define these for a default partition on a NOR device 9436705d81eSwdenk 9446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS_CUSTOM_PART 9456705d81eSwdenk Define this to create an own partition. You have to provide a 9466705d81eSwdenk function struct part_info* jffs2_part_info(int part_num) 9476705d81eSwdenk 9486705d81eSwdenk If you define only one JFFS2 partition you may also want to 9496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_JFFS_SINGLE_PART 1 9506705d81eSwdenk to disable the command chpart. This is the default when you 9516705d81eSwdenk have not defined a custom partition 9526705d81eSwdenk 953c609719bSwdenk- Keyboard Support: 954c609719bSwdenk CONFIG_ISA_KEYBOARD 955c609719bSwdenk 956c609719bSwdenk Define this to enable standard (PC-Style) keyboard 957c609719bSwdenk support 958c609719bSwdenk 959c609719bSwdenk CONFIG_I8042_KBD 960c609719bSwdenk Standard PC keyboard driver with US (is default) and 961c609719bSwdenk GERMAN key layout (switch via environment 'keymap=de') support. 962c609719bSwdenk Export function i8042_kbd_init, i8042_tstc and i8042_getc 963c609719bSwdenk for cfb_console. Supports cursor blinking. 964c609719bSwdenk 965c609719bSwdenk- Video support: 966c609719bSwdenk CONFIG_VIDEO 967c609719bSwdenk 968c609719bSwdenk Define this to enable video support (for output to 969c609719bSwdenk video). 970c609719bSwdenk 971c609719bSwdenk CONFIG_VIDEO_CT69000 972c609719bSwdenk 973c609719bSwdenk Enable Chips & Technologies 69000 Video chip 974c609719bSwdenk 975c609719bSwdenk CONFIG_VIDEO_SMI_LYNXEM 976eeb1b77bSwdenk Enable Silicon Motion SMI 712/710/810 Video chip. The 977eeb1b77bSwdenk video output is selected via environment 'videoout' 978eeb1b77bSwdenk (1 = LCD and 2 = CRT). If videoout is undefined, CRT is 979eeb1b77bSwdenk assumed. 980c609719bSwdenk 981eeb1b77bSwdenk For the CT69000 and SMI_LYNXEM drivers, videomode is 98211ccc33fSMarcel Ziswiler selected via environment 'videomode'. Two different ways 983eeb1b77bSwdenk are possible: 984eeb1b77bSwdenk - "videomode=num" 'num' is a standard LiLo mode numbers. 985eeb1b77bSwdenk Following standard modes are supported (* is default): 986eeb1b77bSwdenk 987eeb1b77bSwdenk Colors 640x480 800x600 1024x768 1152x864 1280x1024 988eeb1b77bSwdenk -------------+--------------------------------------------- 989eeb1b77bSwdenk 8 bits | 0x301* 0x303 0x305 0x161 0x307 990eeb1b77bSwdenk 15 bits | 0x310 0x313 0x316 0x162 0x319 991eeb1b77bSwdenk 16 bits | 0x311 0x314 0x317 0x163 0x31A 992eeb1b77bSwdenk 24 bits | 0x312 0x315 0x318 ? 0x31B 993eeb1b77bSwdenk -------------+--------------------------------------------- 994c609719bSwdenk (i.e. setenv videomode 317; saveenv; reset;) 995c609719bSwdenk 996eeb1b77bSwdenk - "videomode=bootargs" all the video parameters are parsed 9977817cb20SMarcel Ziswiler from the bootargs. (See drivers/video/videomodes.c) 998eeb1b77bSwdenk 999eeb1b77bSwdenk 1000a6c7ad2fSwdenk CONFIG_VIDEO_SED13806 1001a6c7ad2fSwdenk Enable Epson SED13806 driver. This driver supports 8bpp 1002a6c7ad2fSwdenk and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP 1003a6c7ad2fSwdenk or CONFIG_VIDEO_SED13806_16BPP 1004a6c7ad2fSwdenk 1005682011ffSwdenk- Keyboard Support: 1006682011ffSwdenk CONFIG_KEYBOARD 1007682011ffSwdenk 1008682011ffSwdenk Define this to enable a custom keyboard support. 1009682011ffSwdenk This simply calls drv_keyboard_init() which must be 1010682011ffSwdenk defined in your board-specific files. 1011682011ffSwdenk The only board using this so far is RBC823. 1012a6c7ad2fSwdenk 1013c609719bSwdenk- LCD Support: CONFIG_LCD 1014c609719bSwdenk 1015c609719bSwdenk Define this to enable LCD support (for output to LCD 1016c609719bSwdenk display); also select one of the supported displays 1017c609719bSwdenk by defining one of these: 1018c609719bSwdenk 101939cf4804SStelian Pop CONFIG_ATMEL_LCD: 102039cf4804SStelian Pop 102139cf4804SStelian Pop HITACHI TX09D70VM1CCA, 3.5", 240x320. 102239cf4804SStelian Pop 1023fd3103bbSwdenk CONFIG_NEC_NL6448AC33: 1024c609719bSwdenk 1025fd3103bbSwdenk NEC NL6448AC33-18. Active, color, single scan. 1026c609719bSwdenk 1027fd3103bbSwdenk CONFIG_NEC_NL6448BC20 1028c609719bSwdenk 1029fd3103bbSwdenk NEC NL6448BC20-08. 6.5", 640x480. 1030fd3103bbSwdenk Active, color, single scan. 1031fd3103bbSwdenk 1032fd3103bbSwdenk CONFIG_NEC_NL6448BC33_54 1033fd3103bbSwdenk 1034fd3103bbSwdenk NEC NL6448BC33-54. 10.4", 640x480. 1035c609719bSwdenk Active, color, single scan. 1036c609719bSwdenk 1037c609719bSwdenk CONFIG_SHARP_16x9 1038c609719bSwdenk 1039c609719bSwdenk Sharp 320x240. Active, color, single scan. 1040c609719bSwdenk It isn't 16x9, and I am not sure what it is. 1041c609719bSwdenk 1042c609719bSwdenk CONFIG_SHARP_LQ64D341 1043c609719bSwdenk 1044c609719bSwdenk Sharp LQ64D341 display, 640x480. 1045c609719bSwdenk Active, color, single scan. 1046c609719bSwdenk 1047c609719bSwdenk CONFIG_HLD1045 1048c609719bSwdenk 1049c609719bSwdenk HLD1045 display, 640x480. 1050c609719bSwdenk Active, color, single scan. 1051c609719bSwdenk 1052c609719bSwdenk CONFIG_OPTREX_BW 1053c609719bSwdenk 1054c609719bSwdenk Optrex CBL50840-2 NF-FW 99 22 M5 1055c609719bSwdenk or 1056c609719bSwdenk Hitachi LMG6912RPFC-00T 1057c609719bSwdenk or 1058c609719bSwdenk Hitachi SP14Q002 1059c609719bSwdenk 1060c609719bSwdenk 320x240. Black & white. 1061c609719bSwdenk 1062c609719bSwdenk Normally display is black on white background; define 10636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_WHITE_ON_BLACK to get it inverted. 1064c609719bSwdenk 10657152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN 1066d791b1dcSwdenk 1067d791b1dcSwdenk If this option is set, the environment is checked for 1068d791b1dcSwdenk a variable "splashimage". If found, the usual display 1069d791b1dcSwdenk of logo, copyright and system information on the LCD 1070e94d2cd9Swdenk is suppressed and the BMP image at the address 1071d791b1dcSwdenk specified in "splashimage" is loaded instead. The 1072d791b1dcSwdenk console is redirected to the "nulldev", too. This 1073d791b1dcSwdenk allows for a "silent" boot where a splash screen is 1074d791b1dcSwdenk loaded very quickly after power-on. 1075d791b1dcSwdenk 10761ca298ceSMatthias Weisser CONFIG_SPLASH_SCREEN_ALIGN 10771ca298ceSMatthias Weisser 10781ca298ceSMatthias Weisser If this option is set the splash image can be freely positioned 10791ca298ceSMatthias Weisser on the screen. Environment variable "splashpos" specifies the 10801ca298ceSMatthias Weisser position as "x,y". If a positive number is given it is used as 10811ca298ceSMatthias Weisser number of pixel from left/top. If a negative number is given it 10821ca298ceSMatthias Weisser is used as number of pixel from right/bottom. You can also 10831ca298ceSMatthias Weisser specify 'm' for centering the image. 10841ca298ceSMatthias Weisser 10851ca298ceSMatthias Weisser Example: 10861ca298ceSMatthias Weisser setenv splashpos m,m 10871ca298ceSMatthias Weisser => image at center of screen 10881ca298ceSMatthias Weisser 10891ca298ceSMatthias Weisser setenv splashpos 30,20 10901ca298ceSMatthias Weisser => image at x = 30 and y = 20 10911ca298ceSMatthias Weisser 10921ca298ceSMatthias Weisser setenv splashpos -10,m 10931ca298ceSMatthias Weisser => vertically centered image 10941ca298ceSMatthias Weisser at x = dspWidth - bmpWidth - 9 10951ca298ceSMatthias Weisser 109698f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP 109798f4a3dfSStefan Roese 109898f4a3dfSStefan Roese If this option is set, additionally to standard BMP 109998f4a3dfSStefan Roese images, gzipped BMP images can be displayed via the 110098f4a3dfSStefan Roese splashscreen support or the bmp command. 110198f4a3dfSStefan Roese 1102c29fdfc1Swdenk- Compression support: 1103c29fdfc1Swdenk CONFIG_BZIP2 1104c29fdfc1Swdenk 1105c29fdfc1Swdenk If this option is set, support for bzip2 compressed 1106c29fdfc1Swdenk images is included. If not, only uncompressed and gzip 1107c29fdfc1Swdenk compressed images are supported. 1108c29fdfc1Swdenk 1109c29fdfc1Swdenk NOTE: the bzip2 algorithm requires a lot of RAM, so 11106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should 1111c29fdfc1Swdenk be at least 4MB. 1112d791b1dcSwdenk 1113fc9c1727SLuigi 'Comio' Mantellini CONFIG_LZMA 1114fc9c1727SLuigi 'Comio' Mantellini 1115fc9c1727SLuigi 'Comio' Mantellini If this option is set, support for lzma compressed 1116fc9c1727SLuigi 'Comio' Mantellini images is included. 1117fc9c1727SLuigi 'Comio' Mantellini 1118fc9c1727SLuigi 'Comio' Mantellini Note: The LZMA algorithm adds between 2 and 4KB of code and it 1119fc9c1727SLuigi 'Comio' Mantellini requires an amount of dynamic memory that is given by the 1120fc9c1727SLuigi 'Comio' Mantellini formula: 1121fc9c1727SLuigi 'Comio' Mantellini 1122fc9c1727SLuigi 'Comio' Mantellini (1846 + 768 << (lc + lp)) * sizeof(uint16) 1123fc9c1727SLuigi 'Comio' Mantellini 1124fc9c1727SLuigi 'Comio' Mantellini Where lc and lp stand for, respectively, Literal context bits 1125fc9c1727SLuigi 'Comio' Mantellini and Literal pos bits. 1126fc9c1727SLuigi 'Comio' Mantellini 1127fc9c1727SLuigi 'Comio' Mantellini This value is upper-bounded by 14MB in the worst case. Anyway, 1128fc9c1727SLuigi 'Comio' Mantellini for a ~4MB large kernel image, we have lc=3 and lp=0 for a 1129fc9c1727SLuigi 'Comio' Mantellini total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is 1130fc9c1727SLuigi 'Comio' Mantellini a very small buffer. 1131fc9c1727SLuigi 'Comio' Mantellini 1132fc9c1727SLuigi 'Comio' Mantellini Use the lzmainfo tool to determinate the lc and lp values and 1133fc9c1727SLuigi 'Comio' Mantellini then calculate the amount of needed dynamic memory (ensuring 11346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD the appropriate CONFIG_SYS_MALLOC_LEN value). 1135fc9c1727SLuigi 'Comio' Mantellini 113617ea1177Swdenk- MII/PHY support: 113717ea1177Swdenk CONFIG_PHY_ADDR 113817ea1177Swdenk 113917ea1177Swdenk The address of PHY on MII bus. 114017ea1177Swdenk 114117ea1177Swdenk CONFIG_PHY_CLOCK_FREQ (ppc4xx) 114217ea1177Swdenk 114317ea1177Swdenk The clock frequency of the MII bus 114417ea1177Swdenk 114517ea1177Swdenk CONFIG_PHY_GIGE 114617ea1177Swdenk 114717ea1177Swdenk If this option is set, support for speed/duplex 114811ccc33fSMarcel Ziswiler detection of gigabit PHY is included. 114917ea1177Swdenk 115017ea1177Swdenk CONFIG_PHY_RESET_DELAY 115117ea1177Swdenk 115217ea1177Swdenk Some PHY like Intel LXT971A need extra delay after 115317ea1177Swdenk reset before any MII register access is possible. 115417ea1177Swdenk For such PHY, set this option to the usec delay 115517ea1177Swdenk required. (minimum 300usec for LXT971A) 115617ea1177Swdenk 115717ea1177Swdenk CONFIG_PHY_CMD_DELAY (ppc4xx) 115817ea1177Swdenk 115917ea1177Swdenk Some PHY like Intel LXT971A need extra delay after 116017ea1177Swdenk command issued before MII status register can be read 116117ea1177Swdenk 1162c609719bSwdenk- Ethernet address: 1163c609719bSwdenk CONFIG_ETHADDR 1164c68a05feSrichardretanubun CONFIG_ETH1ADDR 1165c609719bSwdenk CONFIG_ETH2ADDR 1166c609719bSwdenk CONFIG_ETH3ADDR 1167c68a05feSrichardretanubun CONFIG_ETH4ADDR 1168c68a05feSrichardretanubun CONFIG_ETH5ADDR 1169c609719bSwdenk 117011ccc33fSMarcel Ziswiler Define a default value for Ethernet address to use 117111ccc33fSMarcel Ziswiler for the respective Ethernet interface, in case this 1172c609719bSwdenk is not determined automatically. 1173c609719bSwdenk 1174c609719bSwdenk- IP address: 1175c609719bSwdenk CONFIG_IPADDR 1176c609719bSwdenk 1177c609719bSwdenk Define a default value for the IP address to use for 117811ccc33fSMarcel Ziswiler the default Ethernet interface, in case this is not 1179c609719bSwdenk determined through e.g. bootp. 1180c609719bSwdenk 1181c609719bSwdenk- Server IP address: 1182c609719bSwdenk CONFIG_SERVERIP 1183c609719bSwdenk 1184c609719bSwdenk Defines a default value for the IP address of a TFTP 1185c609719bSwdenk server to contact when using the "tftboot" command. 1186c609719bSwdenk 1187*97cfe861SRobin Getz CONFIG_KEEP_SERVERADDR 1188*97cfe861SRobin Getz 1189*97cfe861SRobin Getz Keeps the server's MAC address, in the env 'serveraddr' 1190*97cfe861SRobin Getz for passing to bootargs (like Linux's netconsole option) 1191*97cfe861SRobin Getz 119253a5c424SDavid Updegraff- Multicast TFTP Mode: 119353a5c424SDavid Updegraff CONFIG_MCAST_TFTP 119453a5c424SDavid Updegraff 119553a5c424SDavid Updegraff Defines whether you want to support multicast TFTP as per 119653a5c424SDavid Updegraff rfc-2090; for example to work with atftp. Lets lots of targets 119711ccc33fSMarcel Ziswiler tftp down the same boot image concurrently. Note: the Ethernet 119853a5c424SDavid Updegraff driver in use must provide a function: mcast() to join/leave a 119953a5c424SDavid Updegraff multicast group. 120053a5c424SDavid Updegraff 120153a5c424SDavid Updegraff CONFIG_BOOTP_RANDOM_DELAY 1202c609719bSwdenk- BOOTP Recovery Mode: 1203c609719bSwdenk CONFIG_BOOTP_RANDOM_DELAY 1204c609719bSwdenk 1205c609719bSwdenk If you have many targets in a network that try to 1206c609719bSwdenk boot using BOOTP, you may want to avoid that all 1207c609719bSwdenk systems send out BOOTP requests at precisely the same 1208c609719bSwdenk moment (which would happen for instance at recovery 1209c609719bSwdenk from a power failure, when all systems will try to 1210c609719bSwdenk boot, thus flooding the BOOTP server. Defining 1211c609719bSwdenk CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be 1212c609719bSwdenk inserted before sending out BOOTP requests. The 12136c33c785SWolfgang Denk following delays are inserted then: 1214c609719bSwdenk 1215c609719bSwdenk 1st BOOTP request: delay 0 ... 1 sec 1216c609719bSwdenk 2nd BOOTP request: delay 0 ... 2 sec 1217c609719bSwdenk 3rd BOOTP request: delay 0 ... 4 sec 1218c609719bSwdenk 4th and following 1219c609719bSwdenk BOOTP requests: delay 0 ... 8 sec 1220c609719bSwdenk 1221fe389a82Sstroese- DHCP Advanced Options: 12221fe80d79SJon Loeliger You can fine tune the DHCP functionality by defining 12231fe80d79SJon Loeliger CONFIG_BOOTP_* symbols: 1224fe389a82Sstroese 12251fe80d79SJon Loeliger CONFIG_BOOTP_SUBNETMASK 12261fe80d79SJon Loeliger CONFIG_BOOTP_GATEWAY 12271fe80d79SJon Loeliger CONFIG_BOOTP_HOSTNAME 12281fe80d79SJon Loeliger CONFIG_BOOTP_NISDOMAIN 12291fe80d79SJon Loeliger CONFIG_BOOTP_BOOTPATH 12301fe80d79SJon Loeliger CONFIG_BOOTP_BOOTFILESIZE 12311fe80d79SJon Loeliger CONFIG_BOOTP_DNS 12321fe80d79SJon Loeliger CONFIG_BOOTP_DNS2 12331fe80d79SJon Loeliger CONFIG_BOOTP_SEND_HOSTNAME 12341fe80d79SJon Loeliger CONFIG_BOOTP_NTPSERVER 12351fe80d79SJon Loeliger CONFIG_BOOTP_TIMEOFFSET 12361fe80d79SJon Loeliger CONFIG_BOOTP_VENDOREX 1237fe389a82Sstroese 12385d110f0aSWilson Callan CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip 12395d110f0aSWilson Callan environment variable, not the BOOTP server. 1240fe389a82Sstroese 1241fe389a82Sstroese CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS 1242fe389a82Sstroese serverip from a DHCP server, it is possible that more 1243fe389a82Sstroese than one DNS serverip is offered to the client. 1244fe389a82Sstroese If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS 1245fe389a82Sstroese serverip will be stored in the additional environment 1246fe389a82Sstroese variable "dnsip2". The first DNS serverip is always 1247fe389a82Sstroese stored in the variable "dnsip", when CONFIG_BOOTP_DNS 12481fe80d79SJon Loeliger is defined. 1249fe389a82Sstroese 1250fe389a82Sstroese CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable 1251fe389a82Sstroese to do a dynamic update of a DNS server. To do this, they 1252fe389a82Sstroese need the hostname of the DHCP requester. 12535d110f0aSWilson Callan If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content 12541fe80d79SJon Loeliger of the "hostname" environment variable is passed as 12551fe80d79SJon Loeliger option 12 to the DHCP server. 1256fe389a82Sstroese 1257d9a2f416SAras Vaichas CONFIG_BOOTP_DHCP_REQUEST_DELAY 1258d9a2f416SAras Vaichas 1259d9a2f416SAras Vaichas A 32bit value in microseconds for a delay between 1260d9a2f416SAras Vaichas receiving a "DHCP Offer" and sending the "DHCP Request". 1261d9a2f416SAras Vaichas This fixes a problem with certain DHCP servers that don't 1262d9a2f416SAras Vaichas respond 100% of the time to a "DHCP request". E.g. On an 1263d9a2f416SAras Vaichas AT91RM9200 processor running at 180MHz, this delay needed 1264d9a2f416SAras Vaichas to be *at least* 15,000 usec before a Windows Server 2003 1265d9a2f416SAras Vaichas DHCP server would reply 100% of the time. I recommend at 1266d9a2f416SAras Vaichas least 50,000 usec to be safe. The alternative is to hope 1267d9a2f416SAras Vaichas that one of the retries will be successful but note that 1268d9a2f416SAras Vaichas the DHCP timeout and retry process takes a longer than 1269d9a2f416SAras Vaichas this delay. 1270d9a2f416SAras Vaichas 1271a3d991bdSwdenk - CDP Options: 1272a3d991bdSwdenk CONFIG_CDP_DEVICE_ID 1273a3d991bdSwdenk 1274a3d991bdSwdenk The device id used in CDP trigger frames. 1275a3d991bdSwdenk 1276a3d991bdSwdenk CONFIG_CDP_DEVICE_ID_PREFIX 1277a3d991bdSwdenk 1278a3d991bdSwdenk A two character string which is prefixed to the MAC address 1279a3d991bdSwdenk of the device. 1280a3d991bdSwdenk 1281a3d991bdSwdenk CONFIG_CDP_PORT_ID 1282a3d991bdSwdenk 1283a3d991bdSwdenk A printf format string which contains the ascii name of 1284a3d991bdSwdenk the port. Normally is set to "eth%d" which sets 128511ccc33fSMarcel Ziswiler eth0 for the first Ethernet, eth1 for the second etc. 1286a3d991bdSwdenk 1287a3d991bdSwdenk CONFIG_CDP_CAPABILITIES 1288a3d991bdSwdenk 1289a3d991bdSwdenk A 32bit integer which indicates the device capabilities; 1290a3d991bdSwdenk 0x00000010 for a normal host which does not forwards. 1291a3d991bdSwdenk 1292a3d991bdSwdenk CONFIG_CDP_VERSION 1293a3d991bdSwdenk 1294a3d991bdSwdenk An ascii string containing the version of the software. 1295a3d991bdSwdenk 1296a3d991bdSwdenk CONFIG_CDP_PLATFORM 1297a3d991bdSwdenk 1298a3d991bdSwdenk An ascii string containing the name of the platform. 1299a3d991bdSwdenk 1300a3d991bdSwdenk CONFIG_CDP_TRIGGER 1301a3d991bdSwdenk 1302a3d991bdSwdenk A 32bit integer sent on the trigger. 1303a3d991bdSwdenk 1304a3d991bdSwdenk CONFIG_CDP_POWER_CONSUMPTION 1305a3d991bdSwdenk 1306a3d991bdSwdenk A 16bit integer containing the power consumption of the 1307a3d991bdSwdenk device in .1 of milliwatts. 1308a3d991bdSwdenk 1309a3d991bdSwdenk CONFIG_CDP_APPLIANCE_VLAN_TYPE 1310a3d991bdSwdenk 1311a3d991bdSwdenk A byte containing the id of the VLAN. 1312a3d991bdSwdenk 1313c609719bSwdenk- Status LED: CONFIG_STATUS_LED 1314c609719bSwdenk 1315c609719bSwdenk Several configurations allow to display the current 1316c609719bSwdenk status using a LED. For instance, the LED will blink 1317c609719bSwdenk fast while running U-Boot code, stop blinking as 1318c609719bSwdenk soon as a reply to a BOOTP request was received, and 1319c609719bSwdenk start blinking slow once the Linux kernel is running 1320c609719bSwdenk (supported by a status LED driver in the Linux 1321c609719bSwdenk kernel). Defining CONFIG_STATUS_LED enables this 1322c609719bSwdenk feature in U-Boot. 1323c609719bSwdenk 1324c609719bSwdenk- CAN Support: CONFIG_CAN_DRIVER 1325c609719bSwdenk 1326c609719bSwdenk Defining CONFIG_CAN_DRIVER enables CAN driver support 1327c609719bSwdenk on those systems that support this (optional) 1328c609719bSwdenk feature, like the TQM8xxL modules. 1329c609719bSwdenk 1330c609719bSwdenk- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C 1331c609719bSwdenk 1332b37c7e5eSwdenk These enable I2C serial bus commands. Defining either of 1333b37c7e5eSwdenk (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will 133411ccc33fSMarcel Ziswiler include the appropriate I2C driver for the selected CPU. 1335c609719bSwdenk 1336b37c7e5eSwdenk This will allow you to use i2c commands at the u-boot 1337602ad3b3SJon Loeliger command line (as long as you set CONFIG_CMD_I2C in 1338b37c7e5eSwdenk CONFIG_COMMANDS) and communicate with i2c based realtime 1339b37c7e5eSwdenk clock chips. See common/cmd_i2c.c for a description of the 1340c609719bSwdenk command line interface. 1341c609719bSwdenk 1342bb99ad6dSBen Warren CONFIG_HARD_I2C selects a hardware I2C controller. 1343c609719bSwdenk 1344b37c7e5eSwdenk CONFIG_SOFT_I2C configures u-boot to use a software (aka 1345b37c7e5eSwdenk bit-banging) driver instead of CPM or similar hardware 1346b37c7e5eSwdenk support for I2C. 1347c609719bSwdenk 1348b37c7e5eSwdenk There are several other quantities that must also be 1349b37c7e5eSwdenk defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C. 1350c609719bSwdenk 13516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD In both cases you will need to define CONFIG_SYS_I2C_SPEED 1352b37c7e5eSwdenk to be the frequency (in Hz) at which you wish your i2c bus 13536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie 135411ccc33fSMarcel Ziswiler the CPU's i2c node address). 1355c609719bSwdenk 1356b37c7e5eSwdenk Now, the u-boot i2c code for the mpc8xx (cpu/mpc8xx/i2c.c) 135711ccc33fSMarcel Ziswiler sets the CPU up as a master node and so its address should 1358b37c7e5eSwdenk therefore be cleared to 0 (See, eg, MPC823e User's Manual 13596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD p.16-473). So, set CONFIG_SYS_I2C_SLAVE to 0. 1360b37c7e5eSwdenk 1361b37c7e5eSwdenk That's all that's required for CONFIG_HARD_I2C. 1362b37c7e5eSwdenk 1363b37c7e5eSwdenk If you use the software i2c interface (CONFIG_SOFT_I2C) 1364b37c7e5eSwdenk then the following macros need to be defined (examples are 1365b37c7e5eSwdenk from include/configs/lwmon.h): 1366c609719bSwdenk 1367c609719bSwdenk I2C_INIT 1368c609719bSwdenk 1369b37c7e5eSwdenk (Optional). Any commands necessary to enable the I2C 1370c609719bSwdenk controller or configure ports. 1371c609719bSwdenk 1372b37c7e5eSwdenk eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL) 1373b37c7e5eSwdenk 1374c609719bSwdenk I2C_PORT 1375c609719bSwdenk 1376c609719bSwdenk (Only for MPC8260 CPU). The I/O port to use (the code 1377c609719bSwdenk assumes both bits are on the same port). Valid values 1378c609719bSwdenk are 0..3 for ports A..D. 1379c609719bSwdenk 1380c609719bSwdenk I2C_ACTIVE 1381c609719bSwdenk 1382c609719bSwdenk The code necessary to make the I2C data line active 1383c609719bSwdenk (driven). If the data line is open collector, this 1384c609719bSwdenk define can be null. 1385c609719bSwdenk 1386b37c7e5eSwdenk eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA) 1387b37c7e5eSwdenk 1388c609719bSwdenk I2C_TRISTATE 1389c609719bSwdenk 1390c609719bSwdenk The code necessary to make the I2C data line tri-stated 1391c609719bSwdenk (inactive). If the data line is open collector, this 1392c609719bSwdenk define can be null. 1393c609719bSwdenk 1394b37c7e5eSwdenk eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA) 1395b37c7e5eSwdenk 1396c609719bSwdenk I2C_READ 1397c609719bSwdenk 1398c609719bSwdenk Code that returns TRUE if the I2C data line is high, 1399c609719bSwdenk FALSE if it is low. 1400c609719bSwdenk 1401b37c7e5eSwdenk eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0) 1402b37c7e5eSwdenk 1403c609719bSwdenk I2C_SDA(bit) 1404c609719bSwdenk 1405c609719bSwdenk If <bit> is TRUE, sets the I2C data line high. If it 1406c609719bSwdenk is FALSE, it clears it (low). 1407c609719bSwdenk 1408b37c7e5eSwdenk eg: #define I2C_SDA(bit) \ 1409b37c7e5eSwdenk if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \ 1410b37c7e5eSwdenk else immr->im_cpm.cp_pbdat &= ~PB_SDA 1411b37c7e5eSwdenk 1412c609719bSwdenk I2C_SCL(bit) 1413c609719bSwdenk 1414c609719bSwdenk If <bit> is TRUE, sets the I2C clock line high. If it 1415c609719bSwdenk is FALSE, it clears it (low). 1416c609719bSwdenk 1417b37c7e5eSwdenk eg: #define I2C_SCL(bit) \ 1418b37c7e5eSwdenk if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \ 1419b37c7e5eSwdenk else immr->im_cpm.cp_pbdat &= ~PB_SCL 1420b37c7e5eSwdenk 1421c609719bSwdenk I2C_DELAY 1422c609719bSwdenk 1423c609719bSwdenk This delay is invoked four times per clock cycle so this 1424c609719bSwdenk controls the rate of data transfer. The data rate thus 1425b37c7e5eSwdenk is 1 / (I2C_DELAY * 4). Often defined to be something 1426b37c7e5eSwdenk like: 1427b37c7e5eSwdenk 1428b37c7e5eSwdenk #define I2C_DELAY udelay(2) 1429c609719bSwdenk 14306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_INIT_BOARD 143147cd00faSwdenk 143247cd00faSwdenk When a board is reset during an i2c bus transfer 143347cd00faSwdenk chips might think that the current transfer is still 143447cd00faSwdenk in progress. On some boards it is possible to access 143547cd00faSwdenk the i2c SCLK line directly, either by using the 143647cd00faSwdenk processor pin as a GPIO or by having a second pin 143747cd00faSwdenk connected to the bus. If this option is defined a 143847cd00faSwdenk custom i2c_init_board() routine in boards/xxx/board.c 143947cd00faSwdenk is run early in the boot sequence. 144047cd00faSwdenk 144117ea1177Swdenk CONFIG_I2CFAST (PPC405GP|PPC405EP only) 144217ea1177Swdenk 144317ea1177Swdenk This option enables configuration of bi_iic_fast[] flags 144417ea1177Swdenk in u-boot bd_info structure based on u-boot environment 144517ea1177Swdenk variable "i2cfast". (see also i2cfast) 144617ea1177Swdenk 1447bb99ad6dSBen Warren CONFIG_I2C_MULTI_BUS 1448bb99ad6dSBen Warren 1449bb99ad6dSBen Warren This option allows the use of multiple I2C buses, each of which 1450bb99ad6dSBen Warren must have a controller. At any point in time, only one bus is 1451bb99ad6dSBen Warren active. To switch to a different bus, use the 'i2c dev' command. 1452bb99ad6dSBen Warren Note that bus numbering is zero-based. 1453bb99ad6dSBen Warren 14546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_NOPROBES 1455bb99ad6dSBen Warren 1456bb99ad6dSBen Warren This option specifies a list of I2C devices that will be skipped 14570f89c54bSPeter Tyser when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS 14580f89c54bSPeter Tyser is set, specify a list of bus-device pairs. Otherwise, specify 14590f89c54bSPeter Tyser a 1D array of device addresses 1460bb99ad6dSBen Warren 1461bb99ad6dSBen Warren e.g. 1462bb99ad6dSBen Warren #undef CONFIG_I2C_MULTI_BUS 14636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68} 1464bb99ad6dSBen Warren 1465bb99ad6dSBen Warren will skip addresses 0x50 and 0x68 on a board with one I2C bus 1466bb99ad6dSBen Warren 1467bb99ad6dSBen Warren #define CONFIG_I2C_MULTI_BUS 14686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}} 1469bb99ad6dSBen Warren 1470bb99ad6dSBen Warren will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1 1471bb99ad6dSBen Warren 14726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SPD_BUS_NUM 1473be5e6181STimur Tabi 1474be5e6181STimur Tabi If defined, then this indicates the I2C bus number for DDR SPD. 1475be5e6181STimur Tabi If not defined, then U-Boot assumes that SPD is on I2C bus 0. 1476be5e6181STimur Tabi 14776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_RTC_BUS_NUM 14780dc018ecSStefan Roese 14790dc018ecSStefan Roese If defined, then this indicates the I2C bus number for the RTC. 14800dc018ecSStefan Roese If not defined, then U-Boot assumes that RTC is on I2C bus 0. 14810dc018ecSStefan Roese 14826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_DTT_BUS_NUM 14830dc018ecSStefan Roese 14840dc018ecSStefan Roese If defined, then this indicates the I2C bus number for the DTT. 14850dc018ecSStefan Roese If not defined, then U-Boot assumes that DTT is on I2C bus 0. 14860dc018ecSStefan Roese 14876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_DTT_ADDR: 14889ebbb54fSVictor Gallardo 14899ebbb54fSVictor Gallardo If defined, specifies the I2C address of the DTT device. 14909ebbb54fSVictor Gallardo If not defined, then U-Boot uses predefined value for 14919ebbb54fSVictor Gallardo specified DTT device. 14929ebbb54fSVictor Gallardo 1493be5e6181STimur Tabi CONFIG_FSL_I2C 1494be5e6181STimur Tabi 1495be5e6181STimur Tabi Define this option if you want to use Freescale's I2C driver in 14967817cb20SMarcel Ziswiler drivers/i2c/fsl_i2c.c. 1497be5e6181STimur Tabi 149867b23a32SHeiko Schocher CONFIG_I2C_MUX 149967b23a32SHeiko Schocher 150067b23a32SHeiko Schocher Define this option if you have I2C devices reached over 1 .. n 150167b23a32SHeiko Schocher I2C Muxes like the pca9544a. This option addes a new I2C 150267b23a32SHeiko Schocher Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a 150367b23a32SHeiko Schocher new I2C Bus to the existing I2C Busses. If you select the 150467b23a32SHeiko Schocher new Bus with "i2c dev", u-bbot sends first the commandos for 150567b23a32SHeiko Schocher the muxes to activate this new "bus". 150667b23a32SHeiko Schocher 150767b23a32SHeiko Schocher CONFIG_I2C_MULTI_BUS must be also defined, to use this 150867b23a32SHeiko Schocher feature! 150967b23a32SHeiko Schocher 151067b23a32SHeiko Schocher Example: 151167b23a32SHeiko Schocher Adding a new I2C Bus reached over 2 pca9544a muxes 151267b23a32SHeiko Schocher The First mux with address 70 and channel 6 151367b23a32SHeiko Schocher The Second mux with address 71 and channel 4 151467b23a32SHeiko Schocher 151567b23a32SHeiko Schocher => i2c bus pca9544a:70:6:pca9544a:71:4 151667b23a32SHeiko Schocher 151767b23a32SHeiko Schocher Use the "i2c bus" command without parameter, to get a list 151867b23a32SHeiko Schocher of I2C Busses with muxes: 151967b23a32SHeiko Schocher 152067b23a32SHeiko Schocher => i2c bus 152167b23a32SHeiko Schocher Busses reached over muxes: 152267b23a32SHeiko Schocher Bus ID: 2 152367b23a32SHeiko Schocher reached over Mux(es): 152467b23a32SHeiko Schocher pca9544a@70 ch: 4 152567b23a32SHeiko Schocher Bus ID: 3 152667b23a32SHeiko Schocher reached over Mux(es): 152767b23a32SHeiko Schocher pca9544a@70 ch: 6 152867b23a32SHeiko Schocher pca9544a@71 ch: 4 152967b23a32SHeiko Schocher => 153067b23a32SHeiko Schocher 153167b23a32SHeiko Schocher If you now switch to the new I2C Bus 3 with "i2c dev 3" 153267b23a32SHeiko Schocher u-boot sends First the Commando to the mux@70 to enable 153367b23a32SHeiko Schocher channel 6, and then the Commando to the mux@71 to enable 153467b23a32SHeiko Schocher the channel 4. 153567b23a32SHeiko Schocher 153667b23a32SHeiko Schocher After that, you can use the "normal" i2c commands as 153767b23a32SHeiko Schocher usual, to communicate with your I2C devices behind 153867b23a32SHeiko Schocher the 2 muxes. 153967b23a32SHeiko Schocher 154067b23a32SHeiko Schocher This option is actually implemented for the bitbanging 154167b23a32SHeiko Schocher algorithm in common/soft_i2c.c and for the Hardware I2C 154267b23a32SHeiko Schocher Bus on the MPC8260. But it should be not so difficult 154367b23a32SHeiko Schocher to add this option to other architectures. 154467b23a32SHeiko Schocher 15452ac6985aSAndrew Dyer CONFIG_SOFT_I2C_READ_REPEATED_START 15462ac6985aSAndrew Dyer 15472ac6985aSAndrew Dyer defining this will force the i2c_read() function in 15482ac6985aSAndrew Dyer the soft_i2c driver to perform an I2C repeated start 15492ac6985aSAndrew Dyer between writing the address pointer and reading the 15502ac6985aSAndrew Dyer data. If this define is omitted the default behaviour 15512ac6985aSAndrew Dyer of doing a stop-start sequence will be used. Most I2C 15522ac6985aSAndrew Dyer devices can use either method, but some require one or 15532ac6985aSAndrew Dyer the other. 1554be5e6181STimur Tabi 1555c609719bSwdenk- SPI Support: CONFIG_SPI 1556c609719bSwdenk 1557c609719bSwdenk Enables SPI driver (so far only tested with 1558c609719bSwdenk SPI EEPROM, also an instance works with Crystal A/D and 1559c609719bSwdenk D/As on the SACSng board) 1560c609719bSwdenk 1561c609719bSwdenk CONFIG_SPI_X 1562c609719bSwdenk 1563c609719bSwdenk Enables extended (16-bit) SPI EEPROM addressing. 1564c609719bSwdenk (symmetrical to CONFIG_I2C_X) 1565c609719bSwdenk 1566c609719bSwdenk CONFIG_SOFT_SPI 1567c609719bSwdenk 1568c609719bSwdenk Enables a software (bit-bang) SPI driver rather than 1569c609719bSwdenk using hardware support. This is a general purpose 1570c609719bSwdenk driver that only requires three general I/O port pins 1571c609719bSwdenk (two outputs, one input) to function. If this is 1572c609719bSwdenk defined, the board configuration must define several 1573c609719bSwdenk SPI configuration items (port pins to use, etc). For 1574c609719bSwdenk an example, see include/configs/sacsng.h. 1575c609719bSwdenk 157604a9e118SBen Warren CONFIG_HARD_SPI 157704a9e118SBen Warren 157804a9e118SBen Warren Enables a hardware SPI driver for general-purpose reads 157904a9e118SBen Warren and writes. As with CONFIG_SOFT_SPI, the board configuration 158004a9e118SBen Warren must define a list of chip-select function pointers. 158104a9e118SBen Warren Currently supported on some MPC8xxx processors. For an 158204a9e118SBen Warren example, see include/configs/mpc8349emds.h. 158304a9e118SBen Warren 158438254f45SGuennadi Liakhovetski CONFIG_MXC_SPI 158538254f45SGuennadi Liakhovetski 158638254f45SGuennadi Liakhovetski Enables the driver for the SPI controllers on i.MX and MXC 158738254f45SGuennadi Liakhovetski SoCs. Currently only i.MX31 is supported. 158838254f45SGuennadi Liakhovetski 15890133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA 15900133502eSMatthias Fuchs 15910133502eSMatthias Fuchs Enables FPGA subsystem. 15920133502eSMatthias Fuchs 15930133502eSMatthias Fuchs CONFIG_FPGA_<vendor> 15940133502eSMatthias Fuchs 15950133502eSMatthias Fuchs Enables support for specific chip vendors. 15960133502eSMatthias Fuchs (ALTERA, XILINX) 15970133502eSMatthias Fuchs 15980133502eSMatthias Fuchs CONFIG_FPGA_<family> 15990133502eSMatthias Fuchs 16000133502eSMatthias Fuchs Enables support for FPGA family. 16010133502eSMatthias Fuchs (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX) 16020133502eSMatthias Fuchs 16030133502eSMatthias Fuchs CONFIG_FPGA_COUNT 1604c609719bSwdenk 1605c609719bSwdenk Specify the number of FPGA devices to support. 1606c609719bSwdenk 16076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_PROG_FEEDBACK 1608c609719bSwdenk 1609c609719bSwdenk Enable printing of hash marks during FPGA configuration. 1610c609719bSwdenk 16116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_BUSY 1612c609719bSwdenk 1613c609719bSwdenk Enable checks on FPGA configuration interface busy 1614c609719bSwdenk status by the configuration function. This option 1615c609719bSwdenk will require a board or device specific function to 1616c609719bSwdenk be written. 1617c609719bSwdenk 1618c609719bSwdenk CONFIG_FPGA_DELAY 1619c609719bSwdenk 1620c609719bSwdenk If defined, a function that provides delays in the FPGA 1621c609719bSwdenk configuration driver. 1622c609719bSwdenk 16236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_CTRLC 1624c609719bSwdenk Allow Control-C to interrupt FPGA configuration 1625c609719bSwdenk 16266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_ERROR 1627c609719bSwdenk 1628c609719bSwdenk Check for configuration errors during FPGA bitfile 1629c609719bSwdenk loading. For example, abort during Virtex II 1630c609719bSwdenk configuration if the INIT_B line goes low (which 1631c609719bSwdenk indicated a CRC error). 1632c609719bSwdenk 16336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_INIT 1634c609719bSwdenk 1635c609719bSwdenk Maximum time to wait for the INIT_B line to deassert 1636c609719bSwdenk after PROB_B has been deasserted during a Virtex II 1637c609719bSwdenk FPGA configuration sequence. The default time is 500 163811ccc33fSMarcel Ziswiler ms. 1639c609719bSwdenk 16406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_BUSY 1641c609719bSwdenk 1642c609719bSwdenk Maximum time to wait for BUSY to deassert during 164311ccc33fSMarcel Ziswiler Virtex II FPGA configuration. The default is 5 ms. 1644c609719bSwdenk 16456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_CONFIG 1646c609719bSwdenk 1647c609719bSwdenk Time to wait after FPGA configuration. The default is 164811ccc33fSMarcel Ziswiler 200 ms. 1649c609719bSwdenk 1650c609719bSwdenk- Configuration Management: 1651c609719bSwdenk CONFIG_IDENT_STRING 1652c609719bSwdenk 1653c609719bSwdenk If defined, this string will be added to the U-Boot 1654c609719bSwdenk version information (U_BOOT_VERSION) 1655c609719bSwdenk 1656c609719bSwdenk- Vendor Parameter Protection: 1657c609719bSwdenk 1658c609719bSwdenk U-Boot considers the values of the environment 1659c609719bSwdenk variables "serial#" (Board Serial Number) and 16607152b1d0Swdenk "ethaddr" (Ethernet Address) to be parameters that 1661c609719bSwdenk are set once by the board vendor / manufacturer, and 1662c609719bSwdenk protects these variables from casual modification by 1663c609719bSwdenk the user. Once set, these variables are read-only, 1664c609719bSwdenk and write or delete attempts are rejected. You can 166511ccc33fSMarcel Ziswiler change this behaviour: 1666c609719bSwdenk 1667c609719bSwdenk If CONFIG_ENV_OVERWRITE is #defined in your config 1668c609719bSwdenk file, the write protection for vendor parameters is 166947cd00faSwdenk completely disabled. Anybody can change or delete 1670c609719bSwdenk these parameters. 1671c609719bSwdenk 1672c609719bSwdenk Alternatively, if you #define _both_ CONFIG_ETHADDR 1673c609719bSwdenk _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default 167411ccc33fSMarcel Ziswiler Ethernet address is installed in the environment, 1675c609719bSwdenk which can be changed exactly ONCE by the user. [The 1676c609719bSwdenk serial# is unaffected by this, i. e. it remains 1677c609719bSwdenk read-only.] 1678c609719bSwdenk 1679c609719bSwdenk- Protected RAM: 1680c609719bSwdenk CONFIG_PRAM 1681c609719bSwdenk 1682c609719bSwdenk Define this variable to enable the reservation of 1683c609719bSwdenk "protected RAM", i. e. RAM which is not overwritten 1684c609719bSwdenk by U-Boot. Define CONFIG_PRAM to hold the number of 1685c609719bSwdenk kB you want to reserve for pRAM. You can overwrite 1686c609719bSwdenk this default value by defining an environment 1687c609719bSwdenk variable "pram" to the number of kB you want to 1688c609719bSwdenk reserve. Note that the board info structure will 1689c609719bSwdenk still show the full amount of RAM. If pRAM is 1690c609719bSwdenk reserved, a new environment variable "mem" will 1691c609719bSwdenk automatically be defined to hold the amount of 1692c609719bSwdenk remaining RAM in a form that can be passed as boot 1693c609719bSwdenk argument to Linux, for instance like that: 1694c609719bSwdenk 1695fe126d8bSWolfgang Denk setenv bootargs ... mem=\${mem} 1696c609719bSwdenk saveenv 1697c609719bSwdenk 1698c609719bSwdenk This way you can tell Linux not to use this memory, 1699c609719bSwdenk either, which results in a memory region that will 1700c609719bSwdenk not be affected by reboots. 1701c609719bSwdenk 1702c609719bSwdenk *WARNING* If your board configuration uses automatic 1703c609719bSwdenk detection of the RAM size, you must make sure that 1704c609719bSwdenk this memory test is non-destructive. So far, the 1705c609719bSwdenk following board configurations are known to be 1706c609719bSwdenk "pRAM-clean": 1707c609719bSwdenk 1708c609719bSwdenk ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL, 1709c609719bSwdenk HERMES, IP860, RPXlite, LWMON, LANTEC, 1710c609719bSwdenk PCU_E, FLAGADM, TQM8260 1711c609719bSwdenk 1712c609719bSwdenk- Error Recovery: 1713c609719bSwdenk CONFIG_PANIC_HANG 1714c609719bSwdenk 1715c609719bSwdenk Define this variable to stop the system in case of a 1716c609719bSwdenk fatal error, so that you have to reset it manually. 1717c609719bSwdenk This is probably NOT a good idea for an embedded 171811ccc33fSMarcel Ziswiler system where you want the system to reboot 1719c609719bSwdenk automatically as fast as possible, but it may be 1720c609719bSwdenk useful during development since you can try to debug 1721c609719bSwdenk the conditions that lead to the situation. 1722c609719bSwdenk 1723c609719bSwdenk CONFIG_NET_RETRY_COUNT 1724c609719bSwdenk 1725c609719bSwdenk This variable defines the number of retries for 1726c609719bSwdenk network operations like ARP, RARP, TFTP, or BOOTP 1727c609719bSwdenk before giving up the operation. If not defined, a 1728c609719bSwdenk default value of 5 is used. 1729c609719bSwdenk 173040cb90eeSGuennadi Liakhovetski CONFIG_ARP_TIMEOUT 173140cb90eeSGuennadi Liakhovetski 173240cb90eeSGuennadi Liakhovetski Timeout waiting for an ARP reply in milliseconds. 173340cb90eeSGuennadi Liakhovetski 1734c609719bSwdenk- Command Interpreter: 17358078f1a5SWolfgang Denk CONFIG_AUTO_COMPLETE 173604a85b3bSwdenk 173704a85b3bSwdenk Enable auto completion of commands using TAB. 173804a85b3bSwdenk 17398078f1a5SWolfgang Denk Note that this feature has NOT been implemented yet 17408078f1a5SWolfgang Denk for the "hush" shell. 17418078f1a5SWolfgang Denk 17428078f1a5SWolfgang Denk 17436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_HUSH_PARSER 1744c609719bSwdenk 1745c609719bSwdenk Define this variable to enable the "hush" shell (from 1746c609719bSwdenk Busybox) as command line interpreter, thus enabling 1747c609719bSwdenk powerful command line syntax like 1748c609719bSwdenk if...then...else...fi conditionals or `&&' and '||' 1749c609719bSwdenk constructs ("shell scripts"). 1750c609719bSwdenk 1751c609719bSwdenk If undefined, you get the old, much simpler behaviour 1752c609719bSwdenk with a somewhat smaller memory footprint. 1753c609719bSwdenk 1754c609719bSwdenk 17556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PROMPT_HUSH_PS2 1756c609719bSwdenk 1757c609719bSwdenk This defines the secondary prompt string, which is 1758c609719bSwdenk printed when the command interpreter needs more input 1759c609719bSwdenk to complete a command. Usually "> ". 1760c609719bSwdenk 1761c609719bSwdenk Note: 1762c609719bSwdenk 1763c609719bSwdenk In the current implementation, the local variables 1764c609719bSwdenk space and global environment variables space are 1765c609719bSwdenk separated. Local variables are those you define by 17663b57fe0aSwdenk simply typing `name=value'. To access a local 1767c609719bSwdenk variable later on, you have write `$name' or 17683b57fe0aSwdenk `${name}'; to execute the contents of a variable 17693b57fe0aSwdenk directly type `$name' at the command prompt. 1770c609719bSwdenk 1771c609719bSwdenk Global environment variables are those you use 1772c609719bSwdenk setenv/printenv to work with. To run a command stored 1773c609719bSwdenk in such a variable, you need to use the run command, 1774c609719bSwdenk and you must not use the '$' sign to access them. 1775c609719bSwdenk 1776c609719bSwdenk To store commands and special characters in a 1777c609719bSwdenk variable, please use double quotation marks 1778c609719bSwdenk surrounding the whole text of the variable, instead 1779c609719bSwdenk of the backslashes before semicolons and special 1780c609719bSwdenk symbols. 1781c609719bSwdenk 1782aa0c71acSWolfgang Denk- Commandline Editing and History: 1783aa0c71acSWolfgang Denk CONFIG_CMDLINE_EDITING 1784aa0c71acSWolfgang Denk 178511ccc33fSMarcel Ziswiler Enable editing and History functions for interactive 1786aa0c71acSWolfgang Denk commandline input operations 1787aa0c71acSWolfgang Denk 1788a8c7c708Swdenk- Default Environment: 1789c609719bSwdenk CONFIG_EXTRA_ENV_SETTINGS 1790c609719bSwdenk 1791c609719bSwdenk Define this to contain any number of null terminated 1792c609719bSwdenk strings (variable = value pairs) that will be part of 17937152b1d0Swdenk the default environment compiled into the boot image. 17942262cfeeSwdenk 1795c609719bSwdenk For example, place something like this in your 1796c609719bSwdenk board's config file: 1797c609719bSwdenk 1798c609719bSwdenk #define CONFIG_EXTRA_ENV_SETTINGS \ 1799c609719bSwdenk "myvar1=value1\0" \ 1800c609719bSwdenk "myvar2=value2\0" 1801c609719bSwdenk 1802c609719bSwdenk Warning: This method is based on knowledge about the 1803c609719bSwdenk internal format how the environment is stored by the 18042262cfeeSwdenk U-Boot code. This is NOT an official, exported 1805c609719bSwdenk interface! Although it is unlikely that this format 18067152b1d0Swdenk will change soon, there is no guarantee either. 1807c609719bSwdenk You better know what you are doing here. 1808c609719bSwdenk 1809c609719bSwdenk Note: overly (ab)use of the default environment is 1810c609719bSwdenk discouraged. Make sure to check other ways to preset 181174de7aefSWolfgang Denk the environment like the "source" command or the 1812c609719bSwdenk boot command first. 1813c609719bSwdenk 1814a8c7c708Swdenk- DataFlash Support: 18152abbe075Swdenk CONFIG_HAS_DATAFLASH 18162abbe075Swdenk 18172abbe075Swdenk Defining this option enables DataFlash features and 18182abbe075Swdenk allows to read/write in Dataflash via the standard 18192abbe075Swdenk commands cp, md... 18202abbe075Swdenk 18213f85ce27Swdenk- SystemACE Support: 18223f85ce27Swdenk CONFIG_SYSTEMACE 18233f85ce27Swdenk 18243f85ce27Swdenk Adding this option adds support for Xilinx SystemACE 18253f85ce27Swdenk chips attached via some sort of local bus. The address 182611ccc33fSMarcel Ziswiler of the chip must also be defined in the 18276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SYSTEMACE_BASE macro. For example: 18283f85ce27Swdenk 18293f85ce27Swdenk #define CONFIG_SYSTEMACE 18306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000 18313f85ce27Swdenk 18323f85ce27Swdenk When SystemACE support is added, the "ace" device type 18333f85ce27Swdenk becomes available to the fat commands, i.e. fatls. 18343f85ce27Swdenk 1835ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port: 1836ecb0ccd9SWolfgang Denk CONFIG_TFTP_PORT 1837ecb0ccd9SWolfgang Denk 183828cb9375SWolfgang Denk If this is defined, the environment variable tftpsrcp 1839ecb0ccd9SWolfgang Denk is used to supply the TFTP UDP source port value. 184028cb9375SWolfgang Denk If tftpsrcp isn't defined, the normal pseudo-random port 1841ecb0ccd9SWolfgang Denk number generator is used. 1842ecb0ccd9SWolfgang Denk 184328cb9375SWolfgang Denk Also, the environment variable tftpdstp is used to supply 184428cb9375SWolfgang Denk the TFTP UDP destination port value. If tftpdstp isn't 184528cb9375SWolfgang Denk defined, the normal port 69 is used. 184628cb9375SWolfgang Denk 184728cb9375SWolfgang Denk The purpose for tftpsrcp is to allow a TFTP server to 1848ecb0ccd9SWolfgang Denk blindly start the TFTP transfer using the pre-configured 1849ecb0ccd9SWolfgang Denk target IP address and UDP port. This has the effect of 1850ecb0ccd9SWolfgang Denk "punching through" the (Windows XP) firewall, allowing 1851ecb0ccd9SWolfgang Denk the remainder of the TFTP transfer to proceed normally. 1852ecb0ccd9SWolfgang Denk A better solution is to properly configure the firewall, 1853ecb0ccd9SWolfgang Denk but sometimes that is not allowed. 1854ecb0ccd9SWolfgang Denk 1855a8c7c708Swdenk- Show boot progress: 1856c609719bSwdenk CONFIG_SHOW_BOOT_PROGRESS 1857c609719bSwdenk 1858c609719bSwdenk Defining this option allows to add some board- 1859c609719bSwdenk specific code (calling a user-provided function 1860c609719bSwdenk "show_boot_progress(int)") that enables you to show 1861c609719bSwdenk the system's boot progress on some display (for 1862c609719bSwdenk example, some LED's) on your board. At the moment, 1863c609719bSwdenk the following checkpoints are implemented: 1864c609719bSwdenk 18654bae9090SBartlomiej Sieka- Automatic software updates via TFTP server 18664bae9090SBartlomiej Sieka CONFIG_UPDATE_TFTP 18674bae9090SBartlomiej Sieka CONFIG_UPDATE_TFTP_CNT_MAX 18684bae9090SBartlomiej Sieka CONFIG_UPDATE_TFTP_MSEC_MAX 18694bae9090SBartlomiej Sieka 18704bae9090SBartlomiej Sieka These options enable and control the auto-update feature; 18714bae9090SBartlomiej Sieka for a more detailed description refer to doc/README.update. 18724bae9090SBartlomiej Sieka 1873d558107cSStefan Roese- MTD Support (mtdparts command, UBI support) 1874d558107cSStefan Roese CONFIG_MTD_DEVICE 1875d558107cSStefan Roese 1876d558107cSStefan Roese Adds the MTD device infrastructure from the Linux kernel. 1877d558107cSStefan Roese Needed for mtdparts command support. 1878d558107cSStefan Roese 1879d558107cSStefan Roese CONFIG_MTD_PARTITIONS 1880d558107cSStefan Roese 1881d558107cSStefan Roese Adds the MTD partitioning infrastructure from the Linux 1882d558107cSStefan Roese kernel. Needed for UBI support. 1883d558107cSStefan Roese 18841372cce2SMarian BalakowiczLegacy uImage format: 18851372cce2SMarian Balakowicz 1886c609719bSwdenk Arg Where When 1887c609719bSwdenk 1 common/cmd_bootm.c before attempting to boot an image 1888c609719bSwdenk -1 common/cmd_bootm.c Image header has bad magic number 1889c609719bSwdenk 2 common/cmd_bootm.c Image header has correct magic number 1890c609719bSwdenk -2 common/cmd_bootm.c Image header has bad checksum 1891c609719bSwdenk 3 common/cmd_bootm.c Image header has correct checksum 1892c609719bSwdenk -3 common/cmd_bootm.c Image data has bad checksum 1893c609719bSwdenk 4 common/cmd_bootm.c Image data has correct checksum 1894c609719bSwdenk -4 common/cmd_bootm.c Image is for unsupported architecture 1895c609719bSwdenk 5 common/cmd_bootm.c Architecture check OK 18961372cce2SMarian Balakowicz -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi) 1897c609719bSwdenk 6 common/cmd_bootm.c Image Type check OK 1898c609719bSwdenk -6 common/cmd_bootm.c gunzip uncompression error 1899c609719bSwdenk -7 common/cmd_bootm.c Unimplemented compression type 1900c609719bSwdenk 7 common/cmd_bootm.c Uncompression OK 19011372cce2SMarian Balakowicz 8 common/cmd_bootm.c No uncompress/copy overwrite error 1902c609719bSwdenk -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX) 19031372cce2SMarian Balakowicz 19041372cce2SMarian Balakowicz 9 common/image.c Start initial ramdisk verification 19051372cce2SMarian Balakowicz -10 common/image.c Ramdisk header has bad magic number 19061372cce2SMarian Balakowicz -11 common/image.c Ramdisk header has bad checksum 19071372cce2SMarian Balakowicz 10 common/image.c Ramdisk header is OK 19081372cce2SMarian Balakowicz -12 common/image.c Ramdisk data has bad checksum 19091372cce2SMarian Balakowicz 11 common/image.c Ramdisk data has correct checksum 19101372cce2SMarian Balakowicz 12 common/image.c Ramdisk verification complete, start loading 191111ccc33fSMarcel Ziswiler -13 common/image.c Wrong Image Type (not PPC Linux ramdisk) 19121372cce2SMarian Balakowicz 13 common/image.c Start multifile image verification 19131372cce2SMarian Balakowicz 14 common/image.c No initial ramdisk, no multifile, continue. 19141372cce2SMarian Balakowicz 19151372cce2SMarian Balakowicz 15 lib_<arch>/bootm.c All preparation done, transferring control to OS 1916c609719bSwdenk 191763e73c9aSwdenk -30 lib_ppc/board.c Fatal error, hang the system 191863e73c9aSwdenk -31 post/post.c POST test failed, detected by post_output_backlog() 191963e73c9aSwdenk -32 post/post.c POST test failed, detected by post_run_single() 192063e73c9aSwdenk 1921566a494fSHeiko Schocher 34 common/cmd_doc.c before loading a Image from a DOC device 1922566a494fSHeiko Schocher -35 common/cmd_doc.c Bad usage of "doc" command 1923566a494fSHeiko Schocher 35 common/cmd_doc.c correct usage of "doc" command 1924566a494fSHeiko Schocher -36 common/cmd_doc.c No boot device 1925566a494fSHeiko Schocher 36 common/cmd_doc.c correct boot device 1926566a494fSHeiko Schocher -37 common/cmd_doc.c Unknown Chip ID on boot device 1927566a494fSHeiko Schocher 37 common/cmd_doc.c correct chip ID found, device available 1928566a494fSHeiko Schocher -38 common/cmd_doc.c Read Error on boot device 1929566a494fSHeiko Schocher 38 common/cmd_doc.c reading Image header from DOC device OK 1930566a494fSHeiko Schocher -39 common/cmd_doc.c Image header has bad magic number 1931566a494fSHeiko Schocher 39 common/cmd_doc.c Image header has correct magic number 1932566a494fSHeiko Schocher -40 common/cmd_doc.c Error reading Image from DOC device 1933566a494fSHeiko Schocher 40 common/cmd_doc.c Image header has correct magic number 1934566a494fSHeiko Schocher 41 common/cmd_ide.c before loading a Image from a IDE device 1935566a494fSHeiko Schocher -42 common/cmd_ide.c Bad usage of "ide" command 1936566a494fSHeiko Schocher 42 common/cmd_ide.c correct usage of "ide" command 1937566a494fSHeiko Schocher -43 common/cmd_ide.c No boot device 1938566a494fSHeiko Schocher 43 common/cmd_ide.c boot device found 1939566a494fSHeiko Schocher -44 common/cmd_ide.c Device not available 1940566a494fSHeiko Schocher 44 common/cmd_ide.c Device available 1941566a494fSHeiko Schocher -45 common/cmd_ide.c wrong partition selected 1942566a494fSHeiko Schocher 45 common/cmd_ide.c partition selected 1943566a494fSHeiko Schocher -46 common/cmd_ide.c Unknown partition table 1944566a494fSHeiko Schocher 46 common/cmd_ide.c valid partition table found 1945566a494fSHeiko Schocher -47 common/cmd_ide.c Invalid partition type 1946566a494fSHeiko Schocher 47 common/cmd_ide.c correct partition type 1947566a494fSHeiko Schocher -48 common/cmd_ide.c Error reading Image Header on boot device 1948566a494fSHeiko Schocher 48 common/cmd_ide.c reading Image Header from IDE device OK 1949566a494fSHeiko Schocher -49 common/cmd_ide.c Image header has bad magic number 1950566a494fSHeiko Schocher 49 common/cmd_ide.c Image header has correct magic number 1951566a494fSHeiko Schocher -50 common/cmd_ide.c Image header has bad checksum 1952566a494fSHeiko Schocher 50 common/cmd_ide.c Image header has correct checksum 1953566a494fSHeiko Schocher -51 common/cmd_ide.c Error reading Image from IDE device 1954566a494fSHeiko Schocher 51 common/cmd_ide.c reading Image from IDE device OK 1955566a494fSHeiko Schocher 52 common/cmd_nand.c before loading a Image from a NAND device 1956566a494fSHeiko Schocher -53 common/cmd_nand.c Bad usage of "nand" command 1957566a494fSHeiko Schocher 53 common/cmd_nand.c correct usage of "nand" command 1958566a494fSHeiko Schocher -54 common/cmd_nand.c No boot device 1959566a494fSHeiko Schocher 54 common/cmd_nand.c boot device found 1960566a494fSHeiko Schocher -55 common/cmd_nand.c Unknown Chip ID on boot device 1961566a494fSHeiko Schocher 55 common/cmd_nand.c correct chip ID found, device available 1962566a494fSHeiko Schocher -56 common/cmd_nand.c Error reading Image Header on boot device 1963566a494fSHeiko Schocher 56 common/cmd_nand.c reading Image Header from NAND device OK 1964566a494fSHeiko Schocher -57 common/cmd_nand.c Image header has bad magic number 1965566a494fSHeiko Schocher 57 common/cmd_nand.c Image header has correct magic number 1966566a494fSHeiko Schocher -58 common/cmd_nand.c Error reading Image from NAND device 1967566a494fSHeiko Schocher 58 common/cmd_nand.c reading Image from NAND device OK 1968c609719bSwdenk 1969566a494fSHeiko Schocher -60 common/env_common.c Environment has a bad CRC, using default 1970c609719bSwdenk 1971566a494fSHeiko Schocher 64 net/eth.c starting with Ethernet configuration. 1972566a494fSHeiko Schocher -64 net/eth.c no Ethernet found. 1973566a494fSHeiko Schocher 65 net/eth.c Ethernet found. 1974206c60cbSwdenk 1975566a494fSHeiko Schocher -80 common/cmd_net.c usage wrong 1976566a494fSHeiko Schocher 80 common/cmd_net.c before calling NetLoop() 197711ccc33fSMarcel Ziswiler -81 common/cmd_net.c some error in NetLoop() occurred 1978566a494fSHeiko Schocher 81 common/cmd_net.c NetLoop() back without error 1979566a494fSHeiko Schocher -82 common/cmd_net.c size == 0 (File with size 0 loaded) 1980566a494fSHeiko Schocher 82 common/cmd_net.c trying automatic boot 198174de7aefSWolfgang Denk 83 common/cmd_net.c running "source" command 198274de7aefSWolfgang Denk -83 common/cmd_net.c some error in automatic boot or "source" command 1983566a494fSHeiko Schocher 84 common/cmd_net.c end without errors 1984c609719bSwdenk 19851372cce2SMarian BalakowiczFIT uImage format: 19861372cce2SMarian Balakowicz 19871372cce2SMarian Balakowicz Arg Where When 19881372cce2SMarian Balakowicz 100 common/cmd_bootm.c Kernel FIT Image has correct format 19891372cce2SMarian Balakowicz -100 common/cmd_bootm.c Kernel FIT Image has incorrect format 19901372cce2SMarian Balakowicz 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration 19911372cce2SMarian Balakowicz -101 common/cmd_bootm.c Can't get configuration for kernel subimage 19921372cce2SMarian Balakowicz 102 common/cmd_bootm.c Kernel unit name specified 19931372cce2SMarian Balakowicz -103 common/cmd_bootm.c Can't get kernel subimage node offset 1994f773bea8SMarian Balakowicz 103 common/cmd_bootm.c Found configuration node 19951372cce2SMarian Balakowicz 104 common/cmd_bootm.c Got kernel subimage node offset 19961372cce2SMarian Balakowicz -104 common/cmd_bootm.c Kernel subimage hash verification failed 19971372cce2SMarian Balakowicz 105 common/cmd_bootm.c Kernel subimage hash verification OK 19981372cce2SMarian Balakowicz -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture 19991372cce2SMarian Balakowicz 106 common/cmd_bootm.c Architecture check OK 200011ccc33fSMarcel Ziswiler -106 common/cmd_bootm.c Kernel subimage has wrong type 200111ccc33fSMarcel Ziswiler 107 common/cmd_bootm.c Kernel subimage type OK 20021372cce2SMarian Balakowicz -107 common/cmd_bootm.c Can't get kernel subimage data/size 20031372cce2SMarian Balakowicz 108 common/cmd_bootm.c Got kernel subimage data/size 20041372cce2SMarian Balakowicz -108 common/cmd_bootm.c Wrong image type (not legacy, FIT) 20051372cce2SMarian Balakowicz -109 common/cmd_bootm.c Can't get kernel subimage type 20061372cce2SMarian Balakowicz -110 common/cmd_bootm.c Can't get kernel subimage comp 20071372cce2SMarian Balakowicz -111 common/cmd_bootm.c Can't get kernel subimage os 20081372cce2SMarian Balakowicz -112 common/cmd_bootm.c Can't get kernel subimage load address 20091372cce2SMarian Balakowicz -113 common/cmd_bootm.c Image uncompress/copy overwrite error 20101372cce2SMarian Balakowicz 20111372cce2SMarian Balakowicz 120 common/image.c Start initial ramdisk verification 20121372cce2SMarian Balakowicz -120 common/image.c Ramdisk FIT image has incorrect format 20131372cce2SMarian Balakowicz 121 common/image.c Ramdisk FIT image has correct format 201411ccc33fSMarcel Ziswiler 122 common/image.c No ramdisk subimage unit name, using configuration 20151372cce2SMarian Balakowicz -122 common/image.c Can't get configuration for ramdisk subimage 20161372cce2SMarian Balakowicz 123 common/image.c Ramdisk unit name specified 20171372cce2SMarian Balakowicz -124 common/image.c Can't get ramdisk subimage node offset 20181372cce2SMarian Balakowicz 125 common/image.c Got ramdisk subimage node offset 20191372cce2SMarian Balakowicz -125 common/image.c Ramdisk subimage hash verification failed 20201372cce2SMarian Balakowicz 126 common/image.c Ramdisk subimage hash verification OK 20211372cce2SMarian Balakowicz -126 common/image.c Ramdisk subimage for unsupported architecture 20221372cce2SMarian Balakowicz 127 common/image.c Architecture check OK 20231372cce2SMarian Balakowicz -127 common/image.c Can't get ramdisk subimage data/size 20241372cce2SMarian Balakowicz 128 common/image.c Got ramdisk subimage data/size 20251372cce2SMarian Balakowicz 129 common/image.c Can't get ramdisk load address 20261372cce2SMarian Balakowicz -129 common/image.c Got ramdisk load address 20271372cce2SMarian Balakowicz 202811ccc33fSMarcel Ziswiler -130 common/cmd_doc.c Incorrect FIT image format 20291372cce2SMarian Balakowicz 131 common/cmd_doc.c FIT image format OK 20301372cce2SMarian Balakowicz 203111ccc33fSMarcel Ziswiler -140 common/cmd_ide.c Incorrect FIT image format 20321372cce2SMarian Balakowicz 141 common/cmd_ide.c FIT image format OK 20331372cce2SMarian Balakowicz 203411ccc33fSMarcel Ziswiler -150 common/cmd_nand.c Incorrect FIT image format 20351372cce2SMarian Balakowicz 151 common/cmd_nand.c FIT image format OK 20361372cce2SMarian Balakowicz 20371372cce2SMarian Balakowicz 2038c609719bSwdenkModem Support: 2039c609719bSwdenk-------------- 2040c609719bSwdenk 204185ec0bccSwdenk[so far only for SMDK2400 and TRAB boards] 2042c609719bSwdenk 204311ccc33fSMarcel Ziswiler- Modem support enable: 2044c609719bSwdenk CONFIG_MODEM_SUPPORT 2045c609719bSwdenk 2046c609719bSwdenk- RTS/CTS Flow control enable: 2047c609719bSwdenk CONFIG_HWFLOW 2048c609719bSwdenk 2049c609719bSwdenk- Modem debug support: 2050c609719bSwdenk CONFIG_MODEM_SUPPORT_DEBUG 2051c609719bSwdenk 2052c609719bSwdenk Enables debugging stuff (char screen[1024], dbg()) 2053c609719bSwdenk for modem support. Useful only with BDI2000. 2054c609719bSwdenk 2055a8c7c708Swdenk- Interrupt support (PPC): 2056a8c7c708Swdenk 2057a8c7c708Swdenk There are common interrupt_init() and timer_interrupt() 2058a8c7c708Swdenk for all PPC archs. interrupt_init() calls interrupt_init_cpu() 205911ccc33fSMarcel Ziswiler for CPU specific initialization. interrupt_init_cpu() 2060a8c7c708Swdenk should set decrementer_count to appropriate value. If 206111ccc33fSMarcel Ziswiler CPU resets decrementer automatically after interrupt 2062a8c7c708Swdenk (ppc4xx) it should set decrementer_count to zero. 206311ccc33fSMarcel Ziswiler timer_interrupt() calls timer_interrupt_cpu() for CPU 2064a8c7c708Swdenk specific handling. If board has watchdog / status_led 2065a8c7c708Swdenk / other_activity_monitor it works automatically from 2066a8c7c708Swdenk general timer_interrupt(). 2067a8c7c708Swdenk 2068c609719bSwdenk- General: 2069c609719bSwdenk 2070c609719bSwdenk In the target system modem support is enabled when a 2071c609719bSwdenk specific key (key combination) is pressed during 2072c609719bSwdenk power-on. Otherwise U-Boot will boot normally 207311ccc33fSMarcel Ziswiler (autoboot). The key_pressed() function is called from 2074c609719bSwdenk board_init(). Currently key_pressed() is a dummy 2075c609719bSwdenk function, returning 1 and thus enabling modem 2076c609719bSwdenk initialization. 2077c609719bSwdenk 2078c609719bSwdenk If there are no modem init strings in the 2079c609719bSwdenk environment, U-Boot proceed to autoboot; the 2080c609719bSwdenk previous output (banner, info printfs) will be 208111ccc33fSMarcel Ziswiler suppressed, though. 2082c609719bSwdenk 2083c609719bSwdenk See also: doc/README.Modem 2084c609719bSwdenk 2085c609719bSwdenk 2086c609719bSwdenkConfiguration Settings: 2087c609719bSwdenk----------------------- 2088c609719bSwdenk 20896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included; 2090c609719bSwdenk undefine this when you're short of memory. 2091c609719bSwdenk 20922fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default 20932fb2604dSPeter Tyser width of the commands listed in the 'help' command output. 20942fb2604dSPeter Tyser 20956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to 2096c609719bSwdenk prompt for user input. 2097c609719bSwdenk 20986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE: Buffer size for input from the Console 2099c609719bSwdenk 21006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE: Buffer size for Console output 2101c609719bSwdenk 21026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands 2103c609719bSwdenk 21046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to 2105c609719bSwdenk the application (usually a Linux kernel) when it is 2106c609719bSwdenk booted 2107c609719bSwdenk 21086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE: 2109c609719bSwdenk List of legal baudrate settings for this board. 2110c609719bSwdenk 21116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET 2112c609719bSwdenk Suppress display of console information at boot. 2113c609719bSwdenk 21146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV 2115c609719bSwdenk If the board specific function 2116c609719bSwdenk extern int overwrite_console (void); 2117c609719bSwdenk returns 1, the stdin, stderr and stdout are switched to the 2118c609719bSwdenk serial port, else the settings in the environment are used. 2119c609719bSwdenk 21206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE 2121c609719bSwdenk Enable the call to overwrite_console(). 2122c609719bSwdenk 21236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE 2124c609719bSwdenk Enable overwrite of previous console environment settings. 2125c609719bSwdenk 21266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END: 2127c609719bSwdenk Begin and End addresses of the area used by the 2128c609719bSwdenk simple memory test. 2129c609719bSwdenk 21306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST: 2131c609719bSwdenk Enable an alternate, more extensive memory test. 2132c609719bSwdenk 21336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH: 21345f535fe1Swdenk Scratch address used by the alternate memory test 21355f535fe1Swdenk You only need to set this if address zero isn't writeable 21365f535fe1Swdenk 21376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only): 21386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header, 213914f73ca6SStefan Roese this specified memory area will get subtracted from the top 214011ccc33fSMarcel Ziswiler (end) of RAM and won't get "touched" at all by U-Boot. By 214114f73ca6SStefan Roese fixing up gd->ram_size the Linux kernel should gets passed 214214f73ca6SStefan Roese the now "corrected" memory size and won't touch it either. 214314f73ca6SStefan Roese This should work for arch/ppc and arch/powerpc. Only Linux 21445e12e75dSStefan Roese board ports in arch/powerpc with bootwrapper support that 214514f73ca6SStefan Roese recalculate the memory size from the SDRAM controller setup 21465e12e75dSStefan Roese will have to get fixed in Linux additionally. 214714f73ca6SStefan Roese 214814f73ca6SStefan Roese This option can be used as a workaround for the 440EPx/GRx 214914f73ca6SStefan Roese CHIP 11 errata where the last 256 bytes in SDRAM shouldn't 215014f73ca6SStefan Roese be touched. 215114f73ca6SStefan Roese 215214f73ca6SStefan Roese WARNING: Please make sure that this value is a multiple of 215314f73ca6SStefan Roese the Linux page size (normally 4k). If this is not the case, 215414f73ca6SStefan Roese then the end address of the Linux memory will be located at a 215514f73ca6SStefan Roese non page size aligned address and this could cause major 215614f73ca6SStefan Roese problems. 215714f73ca6SStefan Roese 21586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TFTP_LOADADDR: 2159c609719bSwdenk Default load address for network file downloads 2160c609719bSwdenk 21616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE: 2162c609719bSwdenk Enable temporary baudrate change while serial download 2163c609719bSwdenk 21646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE: 2165c609719bSwdenk Physical start address of SDRAM. _Must_ be 0 here. 2166c609719bSwdenk 21676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE: 2168c609719bSwdenk Physical start address of Motherboard I/O (if using a 2169c609719bSwdenk Cogent motherboard) 2170c609719bSwdenk 21716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE: 2172c609719bSwdenk Physical start address of Flash memory. 2173c609719bSwdenk 21746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE: 2175c609719bSwdenk Physical start address of boot monitor code (set by 2176c609719bSwdenk make config files to be same as the text base address 2177c609719bSwdenk (TEXT_BASE) used when linking) - same as 21786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FLASH_BASE when booting from flash. 2179c609719bSwdenk 21806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN: 21813b57fe0aSwdenk Size of memory reserved for monitor code, used to 21823b57fe0aSwdenk determine _at_compile_time_ (!) if the environment is 21833b57fe0aSwdenk embedded within the U-Boot image, or in a separate 21843b57fe0aSwdenk flash sector. 2185c609719bSwdenk 21866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN: 2187c609719bSwdenk Size of DRAM reserved for malloc() use. 2188c609719bSwdenk 21896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN: 219015940c9aSStefan Roese Normally compressed uImages are limited to an 219115940c9aSStefan Roese uncompressed size of 8 MBytes. If this is not enough, 21926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD you can define CONFIG_SYS_BOOTM_LEN in your board config file 219315940c9aSStefan Roese to adjust this setting to your needs. 2194c609719bSwdenk 21956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ: 2196c609719bSwdenk Maximum size of memory mapped by the startup code of 2197c609719bSwdenk the Linux kernel; all data that must be processed by 21987d721e34SBartlomiej Sieka the Linux kernel (bd_info, boot arguments, FDT blob if 21997d721e34SBartlomiej Sieka used) must be put below this limit, unless "bootm_low" 22007d721e34SBartlomiej Sieka enviroment variable is defined and non-zero. In such case 22017d721e34SBartlomiej Sieka all data for the Linux kernel must be between "bootm_low" 22026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. 2203c609719bSwdenk 22046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS: 2205c609719bSwdenk Max number of Flash memory banks 2206c609719bSwdenk 22076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT: 2208c609719bSwdenk Max number of sectors on a Flash chip 2209c609719bSwdenk 22106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT: 2211c609719bSwdenk Timeout for Flash erase operations (in ms) 2212c609719bSwdenk 22136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT: 2214c609719bSwdenk Timeout for Flash write operations (in ms) 2215c609719bSwdenk 22166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT 22178564acf9Swdenk Timeout for Flash set sector lock bit operation (in ms) 22188564acf9Swdenk 22196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT 22208564acf9Swdenk Timeout for Flash clear lock bits operation (in ms) 22218564acf9Swdenk 22226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION 22238564acf9Swdenk If defined, hardware flash sectors protection is used 22248564acf9Swdenk instead of U-Boot software protection. 22258564acf9Swdenk 22266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP: 2227c609719bSwdenk 2228c609719bSwdenk Enable TFTP transfers directly to flash memory; 2229c609719bSwdenk without this option such a download has to be 2230c609719bSwdenk performed in two steps: (1) download to RAM, and (2) 2231c609719bSwdenk copy from RAM to flash. 2232c609719bSwdenk 2233c609719bSwdenk The two-step approach is usually more reliable, since 2234c609719bSwdenk you can check if the download worked before you erase 223511ccc33fSMarcel Ziswiler the flash, but in some situations (when system RAM is 223611ccc33fSMarcel Ziswiler too limited to allow for a temporary copy of the 2237c609719bSwdenk downloaded image) this option may be very useful. 2238c609719bSwdenk 22396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI: 2240c609719bSwdenk Define if the flash driver uses extra elements in the 22415653fc33Swdenk common flash structure for storing flash geometry. 22425653fc33Swdenk 224300b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER 22445653fc33Swdenk This option also enables the building of the cfi_flash driver 22455653fc33Swdenk in the drivers directory 224653cf9435Sstroese 224791809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD 224891809ed5SPiotr Ziecik This option enables the building of the cfi_mtd driver 224991809ed5SPiotr Ziecik in the drivers directory. The driver exports CFI flash 225091809ed5SPiotr Ziecik to the MTD layer. 225191809ed5SPiotr Ziecik 22526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE 225396ef831fSGuennadi Liakhovetski Use buffered writes to flash. 225496ef831fSGuennadi Liakhovetski 225596ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N 225696ef831fSGuennadi Liakhovetski s29ws-n MirrorBit flash has non-standard addresses for buffered 225796ef831fSGuennadi Liakhovetski write commands. 225896ef831fSGuennadi Liakhovetski 22596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST 22605568e613SStefan Roese If this option is defined, the common CFI flash doesn't 22615568e613SStefan Roese print it's warning upon not recognized FLASH banks. This 22625568e613SStefan Roese is useful, if some of the configured banks are only 22635568e613SStefan Roese optionally available. 22645568e613SStefan Roese 22659a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS 22669a042e9cSJerry Van Baren If defined (must be an integer), print out countdown 22679a042e9cSJerry Van Baren digits and dots. Recommended value: 45 (9..1) for 80 22689a042e9cSJerry Van Baren column displays, 15 (3..1) for 40 column displays. 22699a042e9cSJerry Van Baren 22706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER: 227111ccc33fSMarcel Ziswiler Defines the number of Ethernet receive buffers. On some 227211ccc33fSMarcel Ziswiler Ethernet controllers it is recommended to set this value 227353cf9435Sstroese to 8 or even higher (EEPRO100 or 405 EMAC), since all 227453cf9435Sstroese buffers can be full shortly after enabling the interface 227511ccc33fSMarcel Ziswiler on high Ethernet traffic. 227653cf9435Sstroese Defaults to 4 if not defined. 2277c609719bSwdenk 2278c609719bSwdenkThe following definitions that deal with the placement and management 2279c609719bSwdenkof environment data (variable area); in general, we support the 2280c609719bSwdenkfollowing configurations: 2281c609719bSwdenk 22825a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH: 2283c609719bSwdenk 2284c609719bSwdenk Define this if the environment is in flash memory. 2285c609719bSwdenk 2286c609719bSwdenk a) The environment occupies one whole flash sector, which is 2287c609719bSwdenk "embedded" in the text segment with the U-Boot code. This 2288c609719bSwdenk happens usually with "bottom boot sector" or "top boot 2289c609719bSwdenk sector" type flash chips, which have several smaller 2290c609719bSwdenk sectors at the start or the end. For instance, such a 2291c609719bSwdenk layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In 2292c609719bSwdenk such a case you would place the environment in one of the 2293c609719bSwdenk 4 kB sectors - with U-Boot code before and after it. With 2294c609719bSwdenk "top boot sector" type flash chips, you would put the 2295c609719bSwdenk environment in one of the last sectors, leaving a gap 2296c609719bSwdenk between U-Boot and the environment. 2297c609719bSwdenk 22980e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 2299c609719bSwdenk 2300c609719bSwdenk Offset of environment data (variable area) to the 2301c609719bSwdenk beginning of flash memory; for instance, with bottom boot 2302c609719bSwdenk type flash chips the second sector can be used: the offset 2303c609719bSwdenk for this sector is given here. 2304c609719bSwdenk 23056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE. 2306c609719bSwdenk 23070e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 2308c609719bSwdenk 2309c609719bSwdenk This is just another way to specify the start address of 2310c609719bSwdenk the flash sector containing the environment (instead of 23110e8d1586SJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_OFFSET). 2312c609719bSwdenk 23130e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SECT_SIZE: 2314c609719bSwdenk 2315c609719bSwdenk Size of the sector containing the environment. 2316c609719bSwdenk 2317c609719bSwdenk 2318c609719bSwdenk b) Sometimes flash chips have few, equal sized, BIG sectors. 2319c609719bSwdenk In such a case you don't want to spend a whole sector for 2320c609719bSwdenk the environment. 2321c609719bSwdenk 23220e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 2323c609719bSwdenk 23245a1aceb0SJean-Christophe PLAGNIOL-VILLARD If you use this in combination with CONFIG_ENV_IS_IN_FLASH 23250e8d1586SJean-Christophe PLAGNIOL-VILLARD and CONFIG_ENV_SECT_SIZE, you can specify to use only a part 2326c609719bSwdenk of this flash sector for the environment. This saves 2327c609719bSwdenk memory for the RAM copy of the environment. 2328c609719bSwdenk 2329c609719bSwdenk It may also save flash memory if you decide to use this 2330c609719bSwdenk when your environment is "embedded" within U-Boot code, 2331c609719bSwdenk since then the remainder of the flash sector could be used 2332c609719bSwdenk for U-Boot code. It should be pointed out that this is 2333c609719bSwdenk STRONGLY DISCOURAGED from a robustness point of view: 2334c609719bSwdenk updating the environment in flash makes it always 2335c609719bSwdenk necessary to erase the WHOLE sector. If something goes 2336c609719bSwdenk wrong before the contents has been restored from a copy in 2337c609719bSwdenk RAM, your target system will be dead. 2338c609719bSwdenk 23390e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR_REDUND 23400e8d1586SJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_SIZE_REDUND 2341c609719bSwdenk 2342c609719bSwdenk These settings describe a second storage area used to hold 234311ccc33fSMarcel Ziswiler a redundant copy of the environment data, so that there is 23443e38691eSwdenk a valid backup copy in case there is a power failure during 2345c609719bSwdenk a "saveenv" operation. 2346c609719bSwdenk 2347c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the 2348c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds* 2349c609719bSwdenkaccordingly! 2350c609719bSwdenk 2351c609719bSwdenk 23529314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM: 2353c609719bSwdenk 2354c609719bSwdenk Define this if you have some non-volatile memory device 2355c609719bSwdenk (NVRAM, battery buffered SRAM) which you want to use for the 2356c609719bSwdenk environment. 2357c609719bSwdenk 23580e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 23590e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 2360c609719bSwdenk 236111ccc33fSMarcel Ziswiler These two #defines are used to determine the memory area you 2362c609719bSwdenk want to use for environment. It is assumed that this memory 2363c609719bSwdenk can just be read and written to, without any special 2364c609719bSwdenk provision. 2365c609719bSwdenk 2366c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early 2367c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the 236811ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or 2369c609719bSwdenkU-Boot will hang. 2370c609719bSwdenk 2371c609719bSwdenkPlease note that even with NVRAM we still use a copy of the 2372c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to 2373c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv" 2374c609719bSwdenkto save the current settings. 2375c609719bSwdenk 2376c609719bSwdenk 2377bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM: 2378c609719bSwdenk 2379c609719bSwdenk Use this if you have an EEPROM or similar serial access 2380c609719bSwdenk device and a driver for it. 2381c609719bSwdenk 23820e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 23830e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 2384c609719bSwdenk 2385c609719bSwdenk These two #defines specify the offset and size of the 2386c609719bSwdenk environment area within the total memory of your EEPROM. 2387c609719bSwdenk 23886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR: 2389c609719bSwdenk If defined, specified the chip address of the EEPROM device. 2390c609719bSwdenk The default address is zero. 2391c609719bSwdenk 23926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS: 2393c609719bSwdenk If defined, the number of bits used to address bytes in a 2394c609719bSwdenk single page in the EEPROM device. A 64 byte page, for example 2395c609719bSwdenk would require six bits. 2396c609719bSwdenk 23976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS: 2398c609719bSwdenk If defined, the number of milliseconds to delay between 2399c609719bSwdenk page writes. The default is zero milliseconds. 2400c609719bSwdenk 24016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR_LEN: 2402c609719bSwdenk The length in bytes of the EEPROM memory array address. Note 2403c609719bSwdenk that this is NOT the chip address length! 2404c609719bSwdenk 24056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW: 24065cf91d6bSwdenk EEPROM chips that implement "address overflow" are ones 24075cf91d6bSwdenk like Catalyst 24WC04/08/16 which has 9/10/11 bits of 24085cf91d6bSwdenk address and the extra bits end up in the "chip address" bit 24095cf91d6bSwdenk slots. This makes a 24WC08 (1Kbyte) chip look like four 256 24105cf91d6bSwdenk byte chips. 24115cf91d6bSwdenk 24125cf91d6bSwdenk Note that we consider the length of the address field to 24135cf91d6bSwdenk still be one byte because the extra address bits are hidden 24145cf91d6bSwdenk in the chip address. 24155cf91d6bSwdenk 24166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_SIZE: 2417c609719bSwdenk The size in bytes of the EEPROM device. 2418c609719bSwdenk 2419c609719bSwdenk 2420057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH: 24215779d8d9Swdenk 24225779d8d9Swdenk Define this if you have a DataFlash memory device which you 24235779d8d9Swdenk want to use for the environment. 24245779d8d9Swdenk 24250e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 24260e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 24270e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 24285779d8d9Swdenk 24295779d8d9Swdenk These three #defines specify the offset and size of the 24305779d8d9Swdenk environment area within the total memory of your DataFlash placed 24315779d8d9Swdenk at the specified address. 24325779d8d9Swdenk 243351bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND: 243413a5695bSwdenk 243513a5695bSwdenk Define this if you have a NAND device which you want to use 243613a5695bSwdenk for the environment. 243713a5695bSwdenk 24380e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 24390e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 244013a5695bSwdenk 244113a5695bSwdenk These two #defines specify the offset and size of the environment 244213a5695bSwdenk area within the first NAND device. 24435779d8d9Swdenk 24440e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET_REDUND 2445e443c944SMarkus Klotzbuecher 24460e8d1586SJean-Christophe PLAGNIOL-VILLARD This setting describes a second storage area of CONFIG_ENV_SIZE 2447e443c944SMarkus Klotzbuecher size used to hold a redundant copy of the environment data, 2448e443c944SMarkus Klotzbuecher so that there is a valid backup copy in case there is a 2449e443c944SMarkus Klotzbuecher power failure during a "saveenv" operation. 2450e443c944SMarkus Klotzbuecher 24510e8d1586SJean-Christophe PLAGNIOL-VILLARD Note: CONFIG_ENV_OFFSET and CONFIG_ENV_OFFSET_REDUND must be aligned 24520e8d1586SJean-Christophe PLAGNIOL-VILLARD to a block boundary, and CONFIG_ENV_SIZE must be a multiple of 2453e443c944SMarkus Klotzbuecher the NAND devices block size. 2454e443c944SMarkus Klotzbuecher 2455b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST 2456b74ab737SGuennadi Liakhovetski 2457b74ab737SGuennadi Liakhovetski Defines address in RAM to which the nand_spl code should copy the 2458b74ab737SGuennadi Liakhovetski environment. If redundant environment is used, it will be copied to 2459b74ab737SGuennadi Liakhovetski CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE. 2460b74ab737SGuennadi Liakhovetski 24616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET 2462c609719bSwdenk 2463c609719bSwdenk Defines offset to the initial SPI buffer area in DPRAM. The 2464c609719bSwdenk area is used at an early stage (ROM part) if the environment 2465c609719bSwdenk is configured to reside in the SPI EEPROM: We need a 520 byte 2466c609719bSwdenk scratch DPRAM area. It is used between the two initialization 2467c609719bSwdenk calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems 2468c609719bSwdenk to be a good choice since it makes it far enough from the 2469c609719bSwdenk start of the data area as well as from the stack pointer. 2470c609719bSwdenk 2471e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor 2472c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been 2473c609719bSwdenkcreated; also, when using EEPROM you will have to use getenv_r() 2474c609719bSwdenkuntil then to read environment variables. 2475c609719bSwdenk 247685ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor 247785ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working 247885ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is 247985ec0bccSwdenknecessary, because the first environment variable we need is the 248085ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't 248185ec0bccSwdenkhave any device yet where we could complain.] 2482c609719bSwdenk 2483c609719bSwdenkNote: once the monitor has been relocated, then it will complain if 2484c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you 248585ec0bccSwdenkuse the "saveenv" command to store a valid environment. 2486c609719bSwdenk 24876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN: 2488fc3e2165Swdenk Echo the inverted Ethernet link state to the fault LED. 2489fc3e2165Swdenk 24906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR 2491fc3e2165Swdenk also needs to be defined. 2492fc3e2165Swdenk 24936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR: 2494fc3e2165Swdenk MII address of the PHY to check for the Ethernet link state. 2495c609719bSwdenk 24966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_64BIT_VSPRINTF: 2497c40b2956Swdenk Makes vsprintf (and all *printf functions) support printing 2498c40b2956Swdenk of 64bit values by using the L quantifier 2499c40b2956Swdenk 25006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_64BIT_STRTOUL: 2501c40b2956Swdenk Adds simple_strtoull that returns a 64bit value 2502c40b2956Swdenk 2503f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS: 2504f5675aa5SRon Madrid Define this if you desire to only have use of the NS16550_init 2505f5675aa5SRon Madrid and NS16550_putc functions for the serial driver located at 2506f5675aa5SRon Madrid drivers/serial/ns16550.c. This option is useful for saving 2507f5675aa5SRon Madrid space for already greatly restricted images, including but not 2508f5675aa5SRon Madrid limited to NAND_SPL configurations. 2509f5675aa5SRon Madrid 2510c609719bSwdenkLow Level (hardware related) configuration options: 2511dc7c9a1aSwdenk--------------------------------------------------- 2512c609719bSwdenk 25136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE: 2514c609719bSwdenk Cache Line Size of the CPU. 2515c609719bSwdenk 25166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR: 2517c609719bSwdenk Default address of the IMMR after system reset. 25182535d602Swdenk 25192535d602Swdenk Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU, 25202535d602Swdenk and RPXsuper) to be able to adjust the position of 25212535d602Swdenk the IMMR register after a reset. 2522c609719bSwdenk 25237f6c2cbcSwdenk- Floppy Disk Support: 25246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FDC_DRIVE_NUMBER 25257f6c2cbcSwdenk 25267f6c2cbcSwdenk the default drive number (default value 0) 25277f6c2cbcSwdenk 25286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_ISA_IO_STRIDE 25297f6c2cbcSwdenk 253011ccc33fSMarcel Ziswiler defines the spacing between FDC chipset registers 25317f6c2cbcSwdenk (default value 1) 25327f6c2cbcSwdenk 25336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_ISA_IO_OFFSET 25347f6c2cbcSwdenk 25357f6c2cbcSwdenk defines the offset of register from address. It 25367f6c2cbcSwdenk depends on which part of the data bus is connected to 253711ccc33fSMarcel Ziswiler the FDC chipset. (default value 0) 25387f6c2cbcSwdenk 25396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and 25406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their 25417f6c2cbcSwdenk default value. 25427f6c2cbcSwdenk 25436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD if CONFIG_SYS_FDC_HW_INIT is defined, then the function 25447f6c2cbcSwdenk fdc_hw_init() is called at the beginning of the FDC 25457f6c2cbcSwdenk setup. fdc_hw_init() must be provided by the board 25467f6c2cbcSwdenk source code. It is used to make hardware dependant 25477f6c2cbcSwdenk initializations. 25487f6c2cbcSwdenk 25496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR: Physical address of the Internal Memory. 255025d6712aSwdenk DO NOT CHANGE unless you know exactly what you're 255125d6712aSwdenk doing! (11-4) [MPC8xx/82xx systems only] 2552c609719bSwdenk 25536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR: 2554c609719bSwdenk 25557152b1d0Swdenk Start address of memory area that can be used for 2556c609719bSwdenk initial data and stack; please note that this must be 2557c609719bSwdenk writable memory that is working WITHOUT special 2558c609719bSwdenk initialization, i. e. you CANNOT use normal RAM which 2559c609719bSwdenk will become available only after programming the 2560c609719bSwdenk memory controller and running certain initialization 2561c609719bSwdenk sequences. 2562c609719bSwdenk 2563c609719bSwdenk U-Boot uses the following memory types: 2564c609719bSwdenk - MPC8xx and MPC8260: IMMR (internal memory of the CPU) 2565c609719bSwdenk - MPC824X: data cache 2566c609719bSwdenk - PPC4xx: data cache 2567c609719bSwdenk 25686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET: 2569c609719bSwdenk 2570c609719bSwdenk Offset of the initial data structure in the memory 25716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually 25726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial 2573c609719bSwdenk data is located at the end of the available space 25746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD (sometimes written as (CONFIG_SYS_INIT_RAM_END - 25756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just 25766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR + 25776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_GBL_DATA_OFFSET) downward. 2578c609719bSwdenk 2579c609719bSwdenk Note: 2580c609719bSwdenk On the MPC824X (or other systems that use the data 2581c609719bSwdenk cache for initial memory) the address chosen for 25826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must 2583c609719bSwdenk point to an otherwise UNUSED address space between 2584c609719bSwdenk the top of RAM and the start of the PCI space. 2585c609719bSwdenk 25866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6) 2587c609719bSwdenk 25886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR: System Protection Control (11-9) 2589c609719bSwdenk 25906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26) 2591c609719bSwdenk 25926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31) 2593c609719bSwdenk 25946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30) 2595c609719bSwdenk 25966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27) 2597c609719bSwdenk 25986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM: 2599c609719bSwdenk SDRAM timing 2600c609719bSwdenk 26016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA: 2602c609719bSwdenk periodic timer for refresh 2603c609719bSwdenk 26046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER: Debug Event Register (37-47) 2605c609719bSwdenk 26066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM, 26076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP, 26086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM, 26096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BR1_PRELIM: 2610c609719bSwdenk Memory Controller Definitions: BR0/1 and OR0/1 (FLASH) 2611c609719bSwdenk 2612c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE, 26136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM, 26146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM: 2615c609719bSwdenk Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM) 2616c609719bSwdenk 26176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K, 26186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL: 2619c609719bSwdenk Machine Mode Register and Memory Periodic Timer 2620c609719bSwdenk Prescaler definitions (SDRAM timing) 2621c609719bSwdenk 26226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]: 2623c609719bSwdenk enable I2C microcode relocation patch (MPC8xx); 2624c609719bSwdenk define relocation offset in DPRAM [DSP2] 2625c609719bSwdenk 26266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]: 2627b423d055SHeiko Schocher enable SMC microcode relocation patch (MPC8xx); 2628b423d055SHeiko Schocher define relocation offset in DPRAM [SMC1] 2629b423d055SHeiko Schocher 26306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]: 2631c609719bSwdenk enable SPI microcode relocation patch (MPC8xx); 2632c609719bSwdenk define relocation offset in DPRAM [SCC4] 2633c609719bSwdenk 26346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK: 2635c609719bSwdenk Use OSCM clock mode on MBX8xx board. Be careful, 2636c609719bSwdenk wrong setting might damage your board. Read 2637c609719bSwdenk doc/README.MBX before setting this variable! 2638c609719bSwdenk 26396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only) 2640ea909b76Swdenk Offset of the bootmode word in DPRAM used by post 2641ea909b76Swdenk (Power On Self Tests). This definition overrides 2642ea909b76Swdenk #define'd default value in commproc.h resp. 2643ea909b76Swdenk cpm_8260.h. 2644ea909b76Swdenk 26456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB, 26466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL, 26476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS, 26486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB, 26496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START, 26506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL, 26516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE, 26526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only) 26535d232d0eSwdenk Overrides the default PCI memory map in cpu/mpc8260/pci.c if set. 26545d232d0eSwdenk 26559cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE: 26569cacf4fcSDirk Eibach Disable PCI-Express on systems where it is supported but not 26579cacf4fcSDirk Eibach required. 26589cacf4fcSDirk Eibach 2659bb99ad6dSBen Warren- CONFIG_SPD_EEPROM 2660218ca724SWolfgang Denk Get DDR timing information from an I2C EEPROM. Common 2661218ca724SWolfgang Denk with pluggable memory modules such as SODIMMs 2662218ca724SWolfgang Denk 2663bb99ad6dSBen Warren SPD_EEPROM_ADDRESS 2664bb99ad6dSBen Warren I2C address of the SPD EEPROM 2665bb99ad6dSBen Warren 26666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM 2667218ca724SWolfgang Denk If SPD EEPROM is on an I2C bus other than the first 2668218ca724SWolfgang Denk one, specify here. Note that the value must resolve 2669218ca724SWolfgang Denk to something your driver can deal with. 2670bb99ad6dSBen Warren 26716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0 2672218ca724SWolfgang Denk Only for 83xx systems. If specified, then DDR should 2673218ca724SWolfgang Denk be configured using CS0 and CS1 instead of CS2 and CS3. 26742ad6b513STimur Tabi 2675c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12] 2676c26e454dSwdenk Define to enable FEC[12] on a 8xx series processor. 2677c26e454dSwdenk 2678c26e454dSwdenk- CONFIG_FEC[12]_PHY 2679c26e454dSwdenk Define to the hardcoded PHY address which corresponds 26806e592385Swdenk to the given FEC; i. e. 2681c26e454dSwdenk #define CONFIG_FEC1_PHY 4 2682c26e454dSwdenk means that the PHY with address 4 is connected to FEC1 2683c26e454dSwdenk 2684c26e454dSwdenk When set to -1, means to probe for first available. 2685c26e454dSwdenk 2686c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR 2687c26e454dSwdenk The PHY does not have a RXERR line (RMII only). 2688c26e454dSwdenk (so program the FEC to ignore it). 2689c26e454dSwdenk 2690c26e454dSwdenk- CONFIG_RMII 2691c26e454dSwdenk Enable RMII mode for all FECs. 2692c26e454dSwdenk Note that this is a global option, we can't 2693c26e454dSwdenk have one FEC in standard MII mode and another in RMII mode. 2694c26e454dSwdenk 26955cf91d6bSwdenk- CONFIG_CRC32_VERIFY 26965cf91d6bSwdenk Add a verify option to the crc32 command. 26975cf91d6bSwdenk The syntax is: 26985cf91d6bSwdenk 26995cf91d6bSwdenk => crc32 -v <address> <count> <crc32> 27005cf91d6bSwdenk 27015cf91d6bSwdenk Where address/count indicate a memory area 27025cf91d6bSwdenk and crc32 is the correct crc32 which the 27035cf91d6bSwdenk area should have. 27045cf91d6bSwdenk 270556523f12Swdenk- CONFIG_LOOPW 270656523f12Swdenk Add the "loopw" memory command. This only takes effect if 2707602ad3b3SJon Loeliger the memory commands are activated globally (CONFIG_CMD_MEM). 270856523f12Swdenk 27097b466641Sstroese- CONFIG_MX_CYCLIC 27107b466641Sstroese Add the "mdc" and "mwc" memory commands. These are cyclic 27117b466641Sstroese "md/mw" commands. 27127b466641Sstroese Examples: 27137b466641Sstroese 27147b466641Sstroese => mdc.b 10 4 500 27157b466641Sstroese This command will print 4 bytes (10,11,12,13) each 500 ms. 27167b466641Sstroese 27177b466641Sstroese => mwc.l 100 12345678 10 27187b466641Sstroese This command will write 12345678 to address 100 all 10 ms. 27197b466641Sstroese 27207b466641Sstroese This only takes effect if the memory commands are activated 2721602ad3b3SJon Loeliger globally (CONFIG_CMD_MEM). 27227b466641Sstroese 27238aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT 27248aa1a2d1Swdenk- CONFIG_SKIP_RELOCATE_UBOOT 27258aa1a2d1Swdenk 27268aa1a2d1Swdenk [ARM only] If these variables are defined, then 27278aa1a2d1Swdenk certain low level initializations (like setting up 27288aa1a2d1Swdenk the memory controller) are omitted and/or U-Boot does 27298aa1a2d1Swdenk not relocate itself into RAM. 27308aa1a2d1Swdenk Normally these variables MUST NOT be defined. The 27318aa1a2d1Swdenk only exception is when U-Boot is loaded (to RAM) by 27328aa1a2d1Swdenk some other boot loader or by a debugger which 273311ccc33fSMarcel Ziswiler performs these initializations itself. 27348aa1a2d1Swdenk 2735df81238bSMagnus Lilja- CONFIG_PRELOADER 2736df81238bSMagnus Lilja 2737df81238bSMagnus Lilja Modifies the behaviour of start.S when compiling a loader 2738df81238bSMagnus Lilja that is executed before the actual U-Boot. E.g. when 2739df81238bSMagnus Lilja compiling a NAND SPL. 2740400558b5Swdenk 2741c609719bSwdenkBuilding the Software: 2742c609719bSwdenk====================== 2743c609719bSwdenk 2744218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments 2745218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support 2746218ca724SWolfgang Denkall possibly existing versions of cross development tools in all 2747218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we 2748218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK) 2749218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot. 2750c609719bSwdenk 2751218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you 2752218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case, 2753218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell. 2754218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are 2755218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter: 2756c609719bSwdenk 2757218ca724SWolfgang Denk $ CROSS_COMPILE=ppc_4xx- 2758218ca724SWolfgang Denk $ export CROSS_COMPILE 2759c609719bSwdenk 27602f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in 27612f8d396bSPeter Tyser the tools directory you can use the MinGW toolchain 27622f8d396bSPeter Tyser (http://www.mingw.org). Set your HOST tools to the MinGW 27632f8d396bSPeter Tyser toolchain and execute 'make tools'. For example: 27642f8d396bSPeter Tyser 27652f8d396bSPeter Tyser $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools 27662f8d396bSPeter Tyser 27672f8d396bSPeter Tyser Binaries such as tools/mkimage.exe will be created which can 27682f8d396bSPeter Tyser be executed on computers running Windows. 27692f8d396bSPeter Tyser 2770c609719bSwdenkU-Boot is intended to be simple to build. After installing the 2771c609719bSwdenksources you must configure U-Boot for one specific board type. This 2772c609719bSwdenkis done by typing: 2773c609719bSwdenk 2774c609719bSwdenk make NAME_config 2775c609719bSwdenk 2776218ca724SWolfgang Denkwhere "NAME_config" is the name of one of the existing configu- 2777218ca724SWolfgang Denkrations; see the main Makefile for supported names. 277854387ac9Swdenk 2779c609719bSwdenkNote: for some board special configuration names may exist; check if 2780c609719bSwdenk additional information is available from the board vendor; for 27812729af9dSwdenk instance, the TQM823L systems are available without (standard) 27822729af9dSwdenk or with LCD support. You can select such additional "features" 278311ccc33fSMarcel Ziswiler when choosing the configuration, i. e. 2784c609719bSwdenk 27852729af9dSwdenk make TQM823L_config 27862729af9dSwdenk - will configure for a plain TQM823L, i. e. no LCD support 2787c609719bSwdenk 2788c609719bSwdenk make TQM823L_LCD_config 2789c609719bSwdenk - will configure for a TQM823L with U-Boot console on LCD 2790c609719bSwdenk 2791c609719bSwdenk etc. 2792c609719bSwdenk 2793c609719bSwdenk 2794c609719bSwdenkFinally, type "make all", and you should get some working U-Boot 27957152b1d0Swdenkimages ready for download to / installation on your system: 2796c609719bSwdenk 2797c609719bSwdenk- "u-boot.bin" is a raw binary image 2798c609719bSwdenk- "u-boot" is an image in ELF binary format 2799c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format 2800c609719bSwdenk 2801baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved 2802baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change 2803baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory: 2804baf31249SMarian Balakowicz 2805baf31249SMarian Balakowicz1. Add O= to the make command line invocations: 2806baf31249SMarian Balakowicz 2807baf31249SMarian Balakowicz make O=/tmp/build distclean 2808baf31249SMarian Balakowicz make O=/tmp/build NAME_config 2809baf31249SMarian Balakowicz make O=/tmp/build all 2810baf31249SMarian Balakowicz 2811baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location: 2812baf31249SMarian Balakowicz 2813baf31249SMarian Balakowicz export BUILD_DIR=/tmp/build 2814baf31249SMarian Balakowicz make distclean 2815baf31249SMarian Balakowicz make NAME_config 2816baf31249SMarian Balakowicz make all 2817baf31249SMarian Balakowicz 2818baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment 2819baf31249SMarian Balakowiczvariable. 2820baf31249SMarian Balakowicz 2821c609719bSwdenk 2822c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so 2823c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of 2824c609719bSwdenknative "make". 2825c609719bSwdenk 2826c609719bSwdenk 2827c609719bSwdenkIf the system board that you have is not listed, then you will need 2828c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these 2829c609719bSwdenksteps: 2830c609719bSwdenk 2831c609719bSwdenk1. Add a new configuration option for your board to the toplevel 283285ec0bccSwdenk "Makefile" and to the "MAKEALL" script, using the existing 283385ec0bccSwdenk entries as examples. Note that here and at many other places 28347152b1d0Swdenk boards and other names are listed in alphabetical sort order. Please 283585ec0bccSwdenk keep this order. 2836c609719bSwdenk2. Create a new directory to hold your board specific code. Add any 283785ec0bccSwdenk files you need. In your board directory, you will need at least 283885ec0bccSwdenk the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds". 283985ec0bccSwdenk3. Create a new configuration file "include/configs/<board>.h" for 284085ec0bccSwdenk your board 2841c609719bSwdenk3. If you're porting U-Boot to a new CPU, then also create a new 2842c609719bSwdenk directory to hold your CPU specific code. Add any files you need. 284385ec0bccSwdenk4. Run "make <board>_config" with your new name. 2844c609719bSwdenk5. Type "make", and you should get a working "u-boot.srec" file 2845c609719bSwdenk to be installed on your target system. 284685ec0bccSwdenk6. Debug and solve any problems that might arise. 2847c609719bSwdenk [Of course, this last step is much harder than it sounds.] 2848c609719bSwdenk 2849c609719bSwdenk 2850c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.: 2851c609719bSwdenk============================================================== 2852c609719bSwdenk 2853c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board 2854c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to 2855c609719bSwdenkprovide feedback to the other developers. The feedback normally takes 2856c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest 2857218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources. 2858c609719bSwdenk 2859c609719bSwdenkBut before you submit such a patch, please verify that your modifi- 2860c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of 2861c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so, 2862c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot 2863c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can 28647152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE' 2865218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools 2866218ca724SWolfgang Denkyou can type 2867c609719bSwdenk 2868c609719bSwdenk CROSS_COMPILE=ppc_8xx- MAKEALL 2869c609719bSwdenk 2870c609719bSwdenkor to build on a native PowerPC system you can type 2871c609719bSwdenk 2872c609719bSwdenk CROSS_COMPILE=' ' MAKEALL 2873c609719bSwdenk 2874218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build 2875218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by 2876218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target 2877218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and 2878218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default 2879218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment 2880218ca724SWolfgang Denkvariable. For example: 2881baf31249SMarian Balakowicz 2882baf31249SMarian Balakowicz export BUILD_DIR=/tmp/build 2883baf31249SMarian Balakowicz export MAKEALL_LOGDIR=/tmp/log 2884baf31249SMarian Balakowicz CROSS_COMPILE=ppc_8xx- MAKEALL 2885baf31249SMarian Balakowicz 2886218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build, 2887218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean 2888218ca724SWolfgang Denkduring the whole build process. 2889baf31249SMarian Balakowicz 2890baf31249SMarian Balakowicz 2891c609719bSwdenkSee also "U-Boot Porting Guide" below. 2892c609719bSwdenk 2893c609719bSwdenk 2894c609719bSwdenkMonitor Commands - Overview: 2895c609719bSwdenk============================ 2896c609719bSwdenk 2897c609719bSwdenkgo - start application at address 'addr' 2898c609719bSwdenkrun - run commands in an environment variable 2899c609719bSwdenkbootm - boot application image from memory 2900c609719bSwdenkbootp - boot image via network using BootP/TFTP protocol 2901c609719bSwdenktftpboot- boot image via network using TFTP protocol 2902c609719bSwdenk and env variables "ipaddr" and "serverip" 2903c609719bSwdenk (and eventually "gatewayip") 2904c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol 2905c609719bSwdenkdiskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd' 2906c609719bSwdenkloads - load S-Record file over serial line 2907c609719bSwdenkloadb - load binary file over serial line (kermit mode) 2908c609719bSwdenkmd - memory display 2909c609719bSwdenkmm - memory modify (auto-incrementing) 2910c609719bSwdenknm - memory modify (constant address) 2911c609719bSwdenkmw - memory write (fill) 2912c609719bSwdenkcp - memory copy 2913c609719bSwdenkcmp - memory compare 2914c609719bSwdenkcrc32 - checksum calculation 29150f89c54bSPeter Tyseri2c - I2C sub-system 2916c609719bSwdenksspi - SPI utility commands 2917c609719bSwdenkbase - print or set address offset 2918c609719bSwdenkprintenv- print environment variables 2919c609719bSwdenksetenv - set environment variables 2920c609719bSwdenksaveenv - save environment variables to persistent storage 2921c609719bSwdenkprotect - enable or disable FLASH write protection 2922c609719bSwdenkerase - erase FLASH memory 2923c609719bSwdenkflinfo - print FLASH memory information 2924c609719bSwdenkbdinfo - print Board Info structure 2925c609719bSwdenkiminfo - print header information for application image 2926c609719bSwdenkconinfo - print console devices and informations 2927c609719bSwdenkide - IDE sub-system 2928c609719bSwdenkloop - infinite loop on address range 292956523f12Swdenkloopw - infinite write loop on address range 2930c609719bSwdenkmtest - simple RAM test 2931c609719bSwdenkicache - enable or disable instruction cache 2932c609719bSwdenkdcache - enable or disable data cache 2933c609719bSwdenkreset - Perform RESET of the CPU 2934c609719bSwdenkecho - echo args to console 2935c609719bSwdenkversion - print monitor version 2936c609719bSwdenkhelp - print online help 2937c609719bSwdenk? - alias for 'help' 2938c609719bSwdenk 2939c609719bSwdenk 2940c609719bSwdenkMonitor Commands - Detailed Description: 2941c609719bSwdenk======================================== 2942c609719bSwdenk 2943c609719bSwdenkTODO. 2944c609719bSwdenk 2945c609719bSwdenkFor now: just type "help <command>". 2946c609719bSwdenk 2947c609719bSwdenk 2948c609719bSwdenkEnvironment Variables: 2949c609719bSwdenk====================== 2950c609719bSwdenk 2951c609719bSwdenkU-Boot supports user configuration using Environment Variables which 2952c609719bSwdenkcan be made persistent by saving to Flash memory. 2953c609719bSwdenk 2954c609719bSwdenkEnvironment Variables are set using "setenv", printed using 2955c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv" 2956c609719bSwdenkwithout a value can be used to delete a variable from the 2957c609719bSwdenkenvironment. As long as you don't save the environment you are 2958c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the 2959c609719bSwdenkenvironment is erased by accident, a default environment is provided. 2960c609719bSwdenk 2961c609719bSwdenkSome configuration options can be set using Environment Variables: 2962c609719bSwdenk 2963c609719bSwdenk baudrate - see CONFIG_BAUDRATE 2964c609719bSwdenk 2965c609719bSwdenk bootdelay - see CONFIG_BOOTDELAY 2966c609719bSwdenk 2967c609719bSwdenk bootcmd - see CONFIG_BOOTCOMMAND 2968c609719bSwdenk 2969c609719bSwdenk bootargs - Boot arguments when booting an RTOS image 2970c609719bSwdenk 2971c609719bSwdenk bootfile - Name of the image to load with TFTP 2972c609719bSwdenk 29737d721e34SBartlomiej Sieka bootm_low - Memory range available for image processing in the bootm 29747d721e34SBartlomiej Sieka command can be restricted. This variable is given as 29757d721e34SBartlomiej Sieka a hexadecimal number and defines lowest address allowed 29767d721e34SBartlomiej Sieka for use by the bootm command. See also "bootm_size" 29777d721e34SBartlomiej Sieka environment variable. Address defined by "bootm_low" is 29787d721e34SBartlomiej Sieka also the base of the initial memory mapping for the Linux 29796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD kernel -- see the description of CONFIG_SYS_BOOTMAPSZ. 29807d721e34SBartlomiej Sieka 29817d721e34SBartlomiej Sieka bootm_size - Memory range available for image processing in the bootm 29827d721e34SBartlomiej Sieka command can be restricted. This variable is given as 29837d721e34SBartlomiej Sieka a hexadecimal number and defines the size of the region 29847d721e34SBartlomiej Sieka allowed for use by the bootm command. See also "bootm_low" 29857d721e34SBartlomiej Sieka environment variable. 29867d721e34SBartlomiej Sieka 29874bae9090SBartlomiej Sieka updatefile - Location of the software update file on a TFTP server, used 29884bae9090SBartlomiej Sieka by the automatic software update feature. Please refer to 29894bae9090SBartlomiej Sieka documentation in doc/README.update for more details. 29904bae9090SBartlomiej Sieka 2991c609719bSwdenk autoload - if set to "no" (any string beginning with 'n'), 2992c609719bSwdenk "bootp" will just load perform a lookup of the 2993c609719bSwdenk configuration from the BOOTP server, but not try to 2994c609719bSwdenk load any image using TFTP 2995c609719bSwdenk 29963310c549SMarian Balakowicz autoscript - if set to "yes" commands like "loadb", "loady", 29973310c549SMarian Balakowicz "bootp", "tftpb", "rarpboot" and "nfs" will attempt 29983310c549SMarian Balakowicz to automatically run script images (by internally 299974de7aefSWolfgang Denk calling "source"). 30003310c549SMarian Balakowicz 30013310c549SMarian Balakowicz autoscript_uname - if script image is in a format (FIT) this 30023310c549SMarian Balakowicz variable is used to get script subimage unit name. 30033310c549SMarian Balakowicz 3004c609719bSwdenk autostart - if set to "yes", an image loaded using the "bootp", 3005c609719bSwdenk "rarpboot", "tftpboot" or "diskboot" commands will 3006c609719bSwdenk be automatically started (by internally calling 3007c609719bSwdenk "bootm") 3008c609719bSwdenk 30094a6fd34bSwdenk If set to "no", a standalone image passed to the 30104a6fd34bSwdenk "bootm" command will be copied to the load address 30114a6fd34bSwdenk (and eventually uncompressed), but NOT be started. 30124a6fd34bSwdenk This can be used to load and uncompress arbitrary 30134a6fd34bSwdenk data. 30144a6fd34bSwdenk 301517ea1177Swdenk i2cfast - (PPC405GP|PPC405EP only) 301617ea1177Swdenk if set to 'y' configures Linux I2C driver for fast 301717ea1177Swdenk mode (400kHZ). This environment variable is used in 301817ea1177Swdenk initialization code. So, for changes to be effective 301917ea1177Swdenk it must be saved and board must be reset. 302017ea1177Swdenk 3021c609719bSwdenk initrd_high - restrict positioning of initrd images: 3022c609719bSwdenk If this variable is not set, initrd images will be 3023c609719bSwdenk copied to the highest possible address in RAM; this 3024c609719bSwdenk is usually what you want since it allows for 3025c609719bSwdenk maximum initrd size. If for some reason you want to 3026c609719bSwdenk make sure that the initrd image is loaded below the 30276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BOOTMAPSZ limit, you can set this environment 3028c609719bSwdenk variable to a value of "no" or "off" or "0". 3029c609719bSwdenk Alternatively, you can set it to a maximum upper 3030c609719bSwdenk address to use (U-Boot will still check that it 3031c609719bSwdenk does not overwrite the U-Boot stack and data). 3032c609719bSwdenk 3033c609719bSwdenk For instance, when you have a system with 16 MB 30347152b1d0Swdenk RAM, and want to reserve 4 MB from use by Linux, 3035c609719bSwdenk you can do this by adding "mem=12M" to the value of 3036c609719bSwdenk the "bootargs" variable. However, now you must make 30377152b1d0Swdenk sure that the initrd image is placed in the first 3038c609719bSwdenk 12 MB as well - this can be done with 3039c609719bSwdenk 3040c609719bSwdenk setenv initrd_high 00c00000 3041c609719bSwdenk 304238b99261Swdenk If you set initrd_high to 0xFFFFFFFF, this is an 304338b99261Swdenk indication to U-Boot that all addresses are legal 304438b99261Swdenk for the Linux kernel, including addresses in flash 304538b99261Swdenk memory. In this case U-Boot will NOT COPY the 304638b99261Swdenk ramdisk at all. This may be useful to reduce the 304738b99261Swdenk boot time on your system, but requires that this 304838b99261Swdenk feature is supported by your Linux kernel. 304938b99261Swdenk 3050c609719bSwdenk ipaddr - IP address; needed for tftpboot command 3051c609719bSwdenk 3052c609719bSwdenk loadaddr - Default load address for commands like "bootp", 3053dc7c9a1aSwdenk "rarpboot", "tftpboot", "loadb" or "diskboot" 3054c609719bSwdenk 3055c609719bSwdenk loads_echo - see CONFIG_LOADS_ECHO 3056c609719bSwdenk 3057c609719bSwdenk serverip - TFTP server IP address; needed for tftpboot command 3058c609719bSwdenk 3059c609719bSwdenk bootretry - see CONFIG_BOOT_RETRY_TIME 3060c609719bSwdenk 3061c609719bSwdenk bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR 3062c609719bSwdenk 3063c609719bSwdenk bootstopkey - see CONFIG_AUTOBOOT_STOP_STR 3064c609719bSwdenk 3065a3d991bdSwdenk ethprime - When CONFIG_NET_MULTI is enabled controls which 3066a3d991bdSwdenk interface is used first. 3067a3d991bdSwdenk 3068a3d991bdSwdenk ethact - When CONFIG_NET_MULTI is enabled controls which 3069a3d991bdSwdenk interface is currently active. For example you 3070a3d991bdSwdenk can do the following 3071a3d991bdSwdenk 3072a3d991bdSwdenk => setenv ethact FEC ETHERNET 3073a3d991bdSwdenk => ping 192.168.0.1 # traffic sent on FEC ETHERNET 3074a3d991bdSwdenk => setenv ethact SCC ETHERNET 3075a3d991bdSwdenk => ping 10.0.0.1 # traffic sent on SCC ETHERNET 3076a3d991bdSwdenk 3077e1692577SMatthias Fuchs ethrotate - When set to "no" U-Boot does not go through all 3078e1692577SMatthias Fuchs available network interfaces. 3079e1692577SMatthias Fuchs It just stays at the currently selected interface. 3080e1692577SMatthias Fuchs 3081a3d991bdSwdenk netretry - When set to "no" each network operation will 3082a3d991bdSwdenk either succeed or fail without retrying. 30836e592385Swdenk When set to "once" the network operation will 30846e592385Swdenk fail when all the available network interfaces 30856e592385Swdenk are tried once without success. 3086a3d991bdSwdenk Useful on scripts which control the retry operation 3087a3d991bdSwdenk themselves. 3088a3d991bdSwdenk 3089b4e2f89dSJean-Christophe PLAGNIOL-VILLARD npe_ucode - set load address for the NPE microcode 3090a1cf027aSJean-Christophe PLAGNIOL-VILLARD 309128cb9375SWolfgang Denk tftpsrcport - If this is set, the value is used for TFTP's 3092ecb0ccd9SWolfgang Denk UDP source port. 3093ecb0ccd9SWolfgang Denk 309428cb9375SWolfgang Denk tftpdstport - If this is set, the value is used for TFTP's UDP 309528cb9375SWolfgang Denk destination port instead of the Well Know Port 69. 309628cb9375SWolfgang Denk 3097a3d991bdSwdenk vlan - When set to a value < 4095 the traffic over 309811ccc33fSMarcel Ziswiler Ethernet is encapsulated/received over 802.1q 3099a3d991bdSwdenk VLAN tagged frames. 3100c609719bSwdenk 3101c609719bSwdenkThe following environment variables may be used and automatically 3102c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"), 3103c609719bSwdenkdepending the information provided by your boot server: 3104c609719bSwdenk 3105c609719bSwdenk bootfile - see above 3106c609719bSwdenk dnsip - IP address of your Domain Name Server 3107fe389a82Sstroese dnsip2 - IP address of your secondary Domain Name Server 3108c609719bSwdenk gatewayip - IP address of the Gateway (Router) to use 3109c609719bSwdenk hostname - Target hostname 3110c609719bSwdenk ipaddr - see above 3111c609719bSwdenk netmask - Subnet Mask 3112c609719bSwdenk rootpath - Pathname of the root filesystem on the NFS server 3113c609719bSwdenk serverip - see above 3114c609719bSwdenk 3115c609719bSwdenk 3116c609719bSwdenkThere are two special Environment Variables: 3117c609719bSwdenk 3118c609719bSwdenk serial# - contains hardware identification information such 3119c609719bSwdenk as type string and/or serial number 3120c609719bSwdenk ethaddr - Ethernet address 3121c609719bSwdenk 3122c609719bSwdenkThese variables can be set only once (usually during manufacturing of 3123c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables 3124c609719bSwdenkonce they have been set once. 3125c609719bSwdenk 3126c609719bSwdenk 3127c1551ea8SstroeseFurther special Environment Variables: 3128c1551ea8Sstroese 3129c1551ea8Sstroese ver - Contains the U-Boot version string as printed 3130c1551ea8Sstroese with the "version" command. This variable is 3131c1551ea8Sstroese readonly (see CONFIG_VERSION_VARIABLE). 3132c1551ea8Sstroese 3133c1551ea8Sstroese 3134c609719bSwdenkPlease note that changes to some configuration parameters may take 3135c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-). 3136c609719bSwdenk 3137c609719bSwdenk 3138f07771ccSwdenkCommand Line Parsing: 3139f07771ccSwdenk===================== 3140f07771ccSwdenk 3141f07771ccSwdenkThere are two different command line parsers available with U-Boot: 31427152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell: 3143f07771ccSwdenk 3144f07771ccSwdenkOld, simple command line parser: 3145f07771ccSwdenk-------------------------------- 3146f07771ccSwdenk 3147f07771ccSwdenk- supports environment variables (through setenv / saveenv commands) 3148f07771ccSwdenk- several commands on one line, separated by ';' 3149fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax 3150f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\', 3151f07771ccSwdenk for example: 3152fe126d8bSWolfgang Denk setenv bootcmd bootm \${address} 3153f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example: 3154f07771ccSwdenk setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off' 3155f07771ccSwdenk 3156f07771ccSwdenkHush shell: 3157f07771ccSwdenk----------- 3158f07771ccSwdenk 3159f07771ccSwdenk- similar to Bourne shell, with control structures like 3160f07771ccSwdenk if...then...else...fi, for...do...done; while...do...done, 3161f07771ccSwdenk until...do...done, ... 3162f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv 3163f07771ccSwdenk commands) and local shell variables (through standard shell syntax 3164f07771ccSwdenk "name=value"); only environment variables can be used with "run" 3165f07771ccSwdenk command 3166f07771ccSwdenk 3167f07771ccSwdenkGeneral rules: 3168f07771ccSwdenk-------------- 3169f07771ccSwdenk 3170f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run" 3171f07771ccSwdenk command) contains several commands separated by semicolon, and 3172f07771ccSwdenk one of these commands fails, then the remaining commands will be 3173f07771ccSwdenk executed anyway. 3174f07771ccSwdenk 3175f07771ccSwdenk(2) If you execute several variables with one call to run (i. e. 317611ccc33fSMarcel Ziswiler calling run with a list of variables as arguments), any failing 3177f07771ccSwdenk command will cause "run" to terminate, i. e. the remaining 3178f07771ccSwdenk variables are not executed. 3179f07771ccSwdenk 3180c609719bSwdenkNote for Redundant Ethernet Interfaces: 3181c609719bSwdenk======================================= 3182c609719bSwdenk 318311ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports 3184c609719bSwdenksuch configurations and is capable of automatic selection of a 31857152b1d0Swdenk"working" interface when needed. MAC assignment works as follows: 3186c609719bSwdenk 3187c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding 3188c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0), 3189c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ... 3190c609719bSwdenk 3191c609719bSwdenkIf the network interface stores some valid MAC address (for instance 3192c609719bSwdenkin SROM), this is used as default address if there is NO correspon- 3193c609719bSwdenkding setting in the environment; if the corresponding environment 3194c609719bSwdenkvariable is set, this overrides the settings in the card; that means: 3195c609719bSwdenk 3196c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the 3197c609719bSwdenk environment, the SROM's address is used. 3198c609719bSwdenk 3199c609719bSwdenko If there is no valid address in the SROM, and a definition in the 3200c609719bSwdenk environment exists, then the value from the environment variable is 3201c609719bSwdenk used. 3202c609719bSwdenk 3203c609719bSwdenko If both the SROM and the environment contain a MAC address, and 3204c609719bSwdenk both addresses are the same, this MAC address is used. 3205c609719bSwdenk 3206c609719bSwdenko If both the SROM and the environment contain a MAC address, and the 3207c609719bSwdenk addresses differ, the value from the environment is used and a 3208c609719bSwdenk warning is printed. 3209c609719bSwdenk 3210c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error 3211c609719bSwdenk is raised. 3212c609719bSwdenk 3213c609719bSwdenk 3214c609719bSwdenkImage Formats: 3215c609719bSwdenk============== 3216c609719bSwdenk 32173310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on) 32183310c549SMarian Balakowiczimages in two formats: 32193310c549SMarian Balakowicz 32203310c549SMarian BalakowiczNew uImage format (FIT) 32213310c549SMarian Balakowicz----------------------- 32223310c549SMarian Balakowicz 32233310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar 32243310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple 32253310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by 32263310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory. 32273310c549SMarian Balakowicz 32283310c549SMarian Balakowicz 32293310c549SMarian BalakowiczOld uImage format 32303310c549SMarian Balakowicz----------------- 32313310c549SMarian Balakowicz 32323310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything, 32333310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for 32343310c549SMarian Balakowiczdetails; basically, the header defines the following image properties: 3235c609719bSwdenk 3236c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD, 3237c609719bSwdenk 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks, 3238f5ed9e39SPeter Tyser LynxOS, pSOS, QNX, RTEMS, INTEGRITY; 3239f5ed9e39SPeter Tyser Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS, 3240f5ed9e39SPeter Tyser INTEGRITY). 32417b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86, 32423d1e8a9dSwdenk IA64, MIPS, NIOS, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit; 32437b64fef3SWolfgang Denk Currently supported: ARM, AVR32, Intel x86, MIPS, NIOS, PowerPC). 3244c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2) 3245c609719bSwdenk* Load Address 3246c609719bSwdenk* Entry Point 3247c609719bSwdenk* Image Name 3248c609719bSwdenk* Image Timestamp 3249c609719bSwdenk 3250c609719bSwdenkThe header is marked by a special Magic Number, and both the header 3251c609719bSwdenkand the data portions of the image are secured against corruption by 3252c609719bSwdenkCRC32 checksums. 3253c609719bSwdenk 3254c609719bSwdenk 3255c609719bSwdenkLinux Support: 3256c609719bSwdenk============== 3257c609719bSwdenk 3258c609719bSwdenkAlthough U-Boot should support any OS or standalone application 32597152b1d0Swdenkeasily, the main focus has always been on Linux during the design of 3260c609719bSwdenkU-Boot. 3261c609719bSwdenk 3262c609719bSwdenkU-Boot includes many features that so far have been part of some 3263c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any 3264c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image; 3265c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation 32667152b1d0Swdenkserves several purposes: 3267c609719bSwdenk 3268c609719bSwdenk- the same features can be used for other OS or standalone 3269c609719bSwdenk applications (for instance: using compressed images to reduce the 3270c609719bSwdenk Flash memory footprint) 3271c609719bSwdenk 3272c609719bSwdenk- it becomes much easier to port new Linux kernel versions because 32737152b1d0Swdenk lots of low-level, hardware dependent stuff are done by U-Boot 3274c609719bSwdenk 3275c609719bSwdenk- the same Linux kernel image can now be used with different "initrd" 3276c609719bSwdenk images; of course this also means that different kernel images can 3277c609719bSwdenk be run with the same "initrd". This makes testing easier (you don't 3278c609719bSwdenk have to build a new "zImage.initrd" Linux image when you just 3279c609719bSwdenk change a file in your "initrd"). Also, a field-upgrade of the 3280c609719bSwdenk software is easier now. 3281c609719bSwdenk 3282c609719bSwdenk 3283c609719bSwdenkLinux HOWTO: 3284c609719bSwdenk============ 3285c609719bSwdenk 3286c609719bSwdenkPorting Linux to U-Boot based systems: 3287c609719bSwdenk--------------------------------------- 3288c609719bSwdenk 3289c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to 3290c609719bSwdenkconfigure the Linux device drivers for use with your target hardware 3291c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to 3292c609719bSwdenkLinux :-). 3293c609719bSwdenk 3294c609719bSwdenkBut now you can ignore ALL boot loader code (in arch/ppc/mbxboot). 3295c609719bSwdenk 3296c609719bSwdenkJust make sure your machine specific header file (for instance 3297c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board 32981dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h, 32991dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value 33006d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR. 3301c609719bSwdenk 3302c609719bSwdenk 3303c609719bSwdenkConfiguring the Linux kernel: 3304c609719bSwdenk----------------------------- 3305c609719bSwdenk 3306c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root 3307c609719bSwdenkdevice (initial ramdisk, NFS) for your target system. 3308c609719bSwdenk 3309c609719bSwdenk 3310c609719bSwdenkBuilding a Linux Image: 3311c609719bSwdenk----------------------- 3312c609719bSwdenk 331324ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are 331424ee89b9Swdenknot used. If you use recent kernel source, a new build target 331524ee89b9Swdenk"uImage" will exist which automatically builds an image usable by 331624ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target, 331724ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a 331824ee89b9Swdenk100% compatible format. 3319c609719bSwdenk 3320c609719bSwdenkExample: 3321c609719bSwdenk 3322c609719bSwdenk make TQM850L_config 3323c609719bSwdenk make oldconfig 3324c609719bSwdenk make dep 332524ee89b9Swdenk make uImage 3326c609719bSwdenk 332724ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to 332824ee89b9Swdenkencapsulate a compressed Linux kernel image with header information, 332924ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing: 3330c609719bSwdenk 333124ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format): 333224ee89b9Swdenk 333324ee89b9Swdenk* convert the kernel into a raw binary image: 333424ee89b9Swdenk 333524ee89b9Swdenk ${CROSS_COMPILE}-objcopy -O binary \ 333624ee89b9Swdenk -R .note -R .comment \ 333724ee89b9Swdenk -S vmlinux linux.bin 333824ee89b9Swdenk 333924ee89b9Swdenk* compress the binary image: 334024ee89b9Swdenk 334124ee89b9Swdenk gzip -9 linux.bin 334224ee89b9Swdenk 334324ee89b9Swdenk* package compressed binary image for U-Boot: 334424ee89b9Swdenk 334524ee89b9Swdenk mkimage -A ppc -O linux -T kernel -C gzip \ 334624ee89b9Swdenk -a 0 -e 0 -n "Linux Kernel Image" \ 334724ee89b9Swdenk -d linux.bin.gz uImage 334824ee89b9Swdenk 334924ee89b9Swdenk 335024ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use 335124ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or 335224ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64 335324ee89b9Swdenkbyte header containing information about target architecture, 335424ee89b9Swdenkoperating system, image type, compression method, entry points, time 335524ee89b9Swdenkstamp, CRC32 checksums, etc. 335624ee89b9Swdenk 335724ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and 335824ee89b9Swdenkprint the header information, or to build new images. 3359c609719bSwdenk 3360c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information 3361c609719bSwdenkcontained in the header of an existing U-Boot image; this includes 3362c609719bSwdenkchecksum verification: 3363c609719bSwdenk 3364c609719bSwdenk tools/mkimage -l image 3365c609719bSwdenk -l ==> list image header information 3366c609719bSwdenk 3367c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image 3368c609719bSwdenkfrom a "data file" which is used as image payload: 3369c609719bSwdenk 3370c609719bSwdenk tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \ 3371c609719bSwdenk -n name -d data_file image 3372c609719bSwdenk -A ==> set architecture to 'arch' 3373c609719bSwdenk -O ==> set operating system to 'os' 3374c609719bSwdenk -T ==> set image type to 'type' 3375c609719bSwdenk -C ==> set compression type 'comp' 3376c609719bSwdenk -a ==> set load address to 'addr' (hex) 3377c609719bSwdenk -e ==> set entry point to 'ep' (hex) 3378c609719bSwdenk -n ==> set image name to 'name' 3379c609719bSwdenk -d ==> use image data from 'datafile' 3380c609719bSwdenk 338169459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load 338269459791Swdenkaddress (0x00000000), but the entry point address depends on the 338369459791Swdenkkernel version: 3384c609719bSwdenk 3385c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C, 338624ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000. 3387c609719bSwdenk 3388c609719bSwdenkSo a typical call to build a U-Boot image would read: 3389c609719bSwdenk 339024ee89b9Swdenk -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 339124ee89b9Swdenk > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \ 339224ee89b9Swdenk > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz \ 339324ee89b9Swdenk > examples/uImage.TQM850L 339424ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 3395c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 3396c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 3397c609719bSwdenk Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 3398c609719bSwdenk Load Address: 0x00000000 339924ee89b9Swdenk Entry Point: 0x00000000 3400c609719bSwdenk 3401c609719bSwdenkTo verify the contents of the image (or check for corruption): 3402c609719bSwdenk 340324ee89b9Swdenk -> tools/mkimage -l examples/uImage.TQM850L 340424ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 3405c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 3406c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 3407c609719bSwdenk Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 3408c609719bSwdenk Load Address: 0x00000000 340924ee89b9Swdenk Entry Point: 0x00000000 3410c609719bSwdenk 3411c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade 3412c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this 3413c609719bSwdenkneeds more space in Flash, but boots much faster since it does not 3414c609719bSwdenkneed to be uncompressed: 3415c609719bSwdenk 341624ee89b9Swdenk -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz 341724ee89b9Swdenk -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 341824ee89b9Swdenk > -A ppc -O linux -T kernel -C none -a 0 -e 0 \ 341924ee89b9Swdenk > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux \ 342024ee89b9Swdenk > examples/uImage.TQM850L-uncompressed 342124ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 3422c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 3423c609719bSwdenk Image Type: PowerPC Linux Kernel Image (uncompressed) 3424c609719bSwdenk Data Size: 792160 Bytes = 773.59 kB = 0.76 MB 3425c609719bSwdenk Load Address: 0x00000000 342624ee89b9Swdenk Entry Point: 0x00000000 3427c609719bSwdenk 3428c609719bSwdenk 3429c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file 3430c609719bSwdenkwhen your kernel is intended to use an initial ramdisk: 3431c609719bSwdenk 3432c609719bSwdenk -> tools/mkimage -n 'Simple Ramdisk Image' \ 3433c609719bSwdenk > -A ppc -O linux -T ramdisk -C gzip \ 3434c609719bSwdenk > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd 3435c609719bSwdenk Image Name: Simple Ramdisk Image 3436c609719bSwdenk Created: Wed Jan 12 14:01:50 2000 3437c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 3438c609719bSwdenk Data Size: 566530 Bytes = 553.25 kB = 0.54 MB 3439c609719bSwdenk Load Address: 0x00000000 3440c609719bSwdenk Entry Point: 0x00000000 3441c609719bSwdenk 3442c609719bSwdenk 3443c609719bSwdenkInstalling a Linux Image: 3444c609719bSwdenk------------------------- 3445c609719bSwdenk 3446c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface, 3447c609719bSwdenkyou must convert the image to S-Record format: 3448c609719bSwdenk 3449c609719bSwdenk objcopy -I binary -O srec examples/image examples/image.srec 3450c609719bSwdenk 3451c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot 3452c609719bSwdenkimage header, so the resulting S-Record file will be relative to 3453c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to 3454c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads' 3455c609719bSwdenkcommand. 3456c609719bSwdenk 3457c609719bSwdenkExample: install the image to address 0x40100000 (which on the 3458c609719bSwdenkTQM8xxL is in the first Flash bank): 3459c609719bSwdenk 3460c609719bSwdenk => erase 40100000 401FFFFF 3461c609719bSwdenk 3462c609719bSwdenk .......... done 3463c609719bSwdenk Erased 8 sectors 3464c609719bSwdenk 3465c609719bSwdenk => loads 40100000 3466c609719bSwdenk ## Ready for S-Record download ... 3467c609719bSwdenk ~>examples/image.srec 3468c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 12 13 ... 3469c609719bSwdenk ... 3470c609719bSwdenk 15989 15990 15991 15992 3471c609719bSwdenk [file transfer complete] 3472c609719bSwdenk [connected] 3473c609719bSwdenk ## Start Addr = 0x00000000 3474c609719bSwdenk 3475c609719bSwdenk 3476c609719bSwdenkYou can check the success of the download using the 'iminfo' command; 3477c609719bSwdenkthis includes a checksum verification so you can be sure no data 3478c609719bSwdenkcorruption happened: 3479c609719bSwdenk 3480c609719bSwdenk => imi 40100000 3481c609719bSwdenk 3482c609719bSwdenk ## Checking Image at 40100000 ... 3483c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 3484c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 3485c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 3486c609719bSwdenk Load Address: 00000000 3487c609719bSwdenk Entry Point: 0000000c 3488c609719bSwdenk Verifying Checksum ... OK 3489c609719bSwdenk 3490c609719bSwdenk 3491c609719bSwdenkBoot Linux: 3492c609719bSwdenk----------- 3493c609719bSwdenk 3494c609719bSwdenkThe "bootm" command is used to boot an application that is stored in 3495c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents 3496c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as 3497c609719bSwdenkparameters. You can check and modify this variable using the 3498c609719bSwdenk"printenv" and "setenv" commands: 3499c609719bSwdenk 3500c609719bSwdenk 3501c609719bSwdenk => printenv bootargs 3502c609719bSwdenk bootargs=root=/dev/ram 3503c609719bSwdenk 3504c609719bSwdenk => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 3505c609719bSwdenk 3506c609719bSwdenk => printenv bootargs 3507c609719bSwdenk bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 3508c609719bSwdenk 3509c609719bSwdenk => bootm 40020000 3510c609719bSwdenk ## Booting Linux kernel at 40020000 ... 3511c609719bSwdenk Image Name: 2.2.13 for NFS on TQM850L 3512c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 3513c609719bSwdenk Data Size: 381681 Bytes = 372 kB = 0 MB 3514c609719bSwdenk Load Address: 00000000 3515c609719bSwdenk Entry Point: 0000000c 3516c609719bSwdenk Verifying Checksum ... OK 3517c609719bSwdenk Uncompressing Kernel Image ... OK 3518c609719bSwdenk 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 3519c609719bSwdenk Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 3520c609719bSwdenk time_init: decrementer frequency = 187500000/60 3521c609719bSwdenk Calibrating delay loop... 49.77 BogoMIPS 3522c609719bSwdenk Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000] 3523c609719bSwdenk ... 3524c609719bSwdenk 352511ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass 35267152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT 3527c609719bSwdenkformat!) to the "bootm" command: 3528c609719bSwdenk 3529c609719bSwdenk => imi 40100000 40200000 3530c609719bSwdenk 3531c609719bSwdenk ## Checking Image at 40100000 ... 3532c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 3533c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 3534c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 3535c609719bSwdenk Load Address: 00000000 3536c609719bSwdenk Entry Point: 0000000c 3537c609719bSwdenk Verifying Checksum ... OK 3538c609719bSwdenk 3539c609719bSwdenk ## Checking Image at 40200000 ... 3540c609719bSwdenk Image Name: Simple Ramdisk Image 3541c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 3542c609719bSwdenk Data Size: 566530 Bytes = 553 kB = 0 MB 3543c609719bSwdenk Load Address: 00000000 3544c609719bSwdenk Entry Point: 00000000 3545c609719bSwdenk Verifying Checksum ... OK 3546c609719bSwdenk 3547c609719bSwdenk => bootm 40100000 40200000 3548c609719bSwdenk ## Booting Linux kernel at 40100000 ... 3549c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 3550c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 3551c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 3552c609719bSwdenk Load Address: 00000000 3553c609719bSwdenk Entry Point: 0000000c 3554c609719bSwdenk Verifying Checksum ... OK 3555c609719bSwdenk Uncompressing Kernel Image ... OK 3556c609719bSwdenk ## Loading RAMDisk Image at 40200000 ... 3557c609719bSwdenk Image Name: Simple Ramdisk Image 3558c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 3559c609719bSwdenk Data Size: 566530 Bytes = 553 kB = 0 MB 3560c609719bSwdenk Load Address: 00000000 3561c609719bSwdenk Entry Point: 00000000 3562c609719bSwdenk Verifying Checksum ... OK 3563c609719bSwdenk Loading Ramdisk ... OK 3564c609719bSwdenk 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 3565c609719bSwdenk Boot arguments: root=/dev/ram 3566c609719bSwdenk time_init: decrementer frequency = 187500000/60 3567c609719bSwdenk Calibrating delay loop... 49.77 BogoMIPS 3568c609719bSwdenk ... 3569c609719bSwdenk RAMDISK: Compressed image found at block 0 3570c609719bSwdenk VFS: Mounted root (ext2 filesystem). 3571c609719bSwdenk 3572c609719bSwdenk bash# 3573c609719bSwdenk 35740267768eSMatthew McClintockBoot Linux and pass a flat device tree: 35750267768eSMatthew McClintock----------- 35760267768eSMatthew McClintock 35770267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section 35780267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The 35790267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated 35800267768eSMatthew McClintockflat device tree: 35810267768eSMatthew McClintock 35820267768eSMatthew McClintock=> print oftaddr 35830267768eSMatthew McClintockoftaddr=0x300000 35840267768eSMatthew McClintock=> print oft 35850267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb 35860267768eSMatthew McClintock=> tftp $oftaddr $oft 35870267768eSMatthew McClintockSpeed: 1000, full duplex 35880267768eSMatthew McClintockUsing TSEC0 device 35890267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101 35900267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'. 35910267768eSMatthew McClintockLoad address: 0x300000 35920267768eSMatthew McClintockLoading: # 35930267768eSMatthew McClintockdone 35940267768eSMatthew McClintockBytes transferred = 4106 (100a hex) 35950267768eSMatthew McClintock=> tftp $loadaddr $bootfile 35960267768eSMatthew McClintockSpeed: 1000, full duplex 35970267768eSMatthew McClintockUsing TSEC0 device 35980267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2 35990267768eSMatthew McClintockFilename 'uImage'. 36000267768eSMatthew McClintockLoad address: 0x200000 36010267768eSMatthew McClintockLoading:############ 36020267768eSMatthew McClintockdone 36030267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex) 36040267768eSMatthew McClintock=> print loadaddr 36050267768eSMatthew McClintockloadaddr=200000 36060267768eSMatthew McClintock=> print oftaddr 36070267768eSMatthew McClintockoftaddr=0x300000 36080267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr 36090267768eSMatthew McClintock## Booting image at 00200000 ... 36100267768eSMatthew McClintock Image Name: Linux-2.6.17-dirty 36110267768eSMatthew McClintock Image Type: PowerPC Linux Kernel Image (gzip compressed) 36120267768eSMatthew McClintock Data Size: 1029343 Bytes = 1005.2 kB 36130267768eSMatthew McClintock Load Address: 00000000 36140267768eSMatthew McClintock Entry Point: 00000000 36150267768eSMatthew McClintock Verifying Checksum ... OK 36160267768eSMatthew McClintock Uncompressing Kernel Image ... OK 36170267768eSMatthew McClintockBooting using flat device tree at 0x300000 36180267768eSMatthew McClintockUsing MPC85xx ADS machine description 36190267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb 36200267768eSMatthew McClintock[snip] 36210267768eSMatthew McClintock 36220267768eSMatthew McClintock 36236069ff26SwdenkMore About U-Boot Image Types: 36246069ff26Swdenk------------------------------ 36256069ff26Swdenk 36266069ff26SwdenkU-Boot supports the following image types: 36276069ff26Swdenk 36286069ff26Swdenk "Standalone Programs" are directly runnable in the environment 36296069ff26Swdenk provided by U-Boot; it is expected that (if they behave 36306069ff26Swdenk well) you can continue to work in U-Boot after return from 36316069ff26Swdenk the Standalone Program. 36326069ff26Swdenk "OS Kernel Images" are usually images of some Embedded OS which 36336069ff26Swdenk will take over control completely. Usually these programs 36346069ff26Swdenk will install their own set of exception handlers, device 36356069ff26Swdenk drivers, set up the MMU, etc. - this means, that you cannot 36366069ff26Swdenk expect to re-enter U-Boot except by resetting the CPU. 36376069ff26Swdenk "RAMDisk Images" are more or less just data blocks, and their 36386069ff26Swdenk parameters (address, size) are passed to an OS kernel that is 36396069ff26Swdenk being started. 36406069ff26Swdenk "Multi-File Images" contain several images, typically an OS 36416069ff26Swdenk (Linux) kernel image and one or more data images like 36426069ff26Swdenk RAMDisks. This construct is useful for instance when you want 36436069ff26Swdenk to boot over the network using BOOTP etc., where the boot 36446069ff26Swdenk server provides just a single image file, but you want to get 36456069ff26Swdenk for instance an OS kernel and a RAMDisk image. 36466069ff26Swdenk 36476069ff26Swdenk "Multi-File Images" start with a list of image sizes, each 36486069ff26Swdenk image size (in bytes) specified by an "uint32_t" in network 36496069ff26Swdenk byte order. This list is terminated by an "(uint32_t)0". 36506069ff26Swdenk Immediately after the terminating 0 follow the images, one by 36516069ff26Swdenk one, all aligned on "uint32_t" boundaries (size rounded up to 36526069ff26Swdenk a multiple of 4 bytes). 36536069ff26Swdenk 36546069ff26Swdenk "Firmware Images" are binary images containing firmware (like 36556069ff26Swdenk U-Boot or FPGA images) which usually will be programmed to 36566069ff26Swdenk flash memory. 36576069ff26Swdenk 36586069ff26Swdenk "Script files" are command sequences that will be executed by 36596069ff26Swdenk U-Boot's command interpreter; this feature is especially 36606069ff26Swdenk useful when you configure U-Boot to use a real shell (hush) 36616069ff26Swdenk as command interpreter. 36626069ff26Swdenk 3663c609719bSwdenk 3664c609719bSwdenkStandalone HOWTO: 3665c609719bSwdenk================= 3666c609719bSwdenk 3667c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and 3668c609719bSwdenkrun "standalone" applications, which can use some resources of 3669c609719bSwdenkU-Boot like console I/O functions or interrupt services. 3670c609719bSwdenk 3671c609719bSwdenkTwo simple examples are included with the sources: 3672c609719bSwdenk 3673c609719bSwdenk"Hello World" Demo: 3674c609719bSwdenk------------------- 3675c609719bSwdenk 3676c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo 3677c609719bSwdenkapplication; it is automatically compiled when you build U-Boot. 3678c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it 3679c609719bSwdenklike that: 3680c609719bSwdenk 3681c609719bSwdenk => loads 3682c609719bSwdenk ## Ready for S-Record download ... 3683c609719bSwdenk ~>examples/hello_world.srec 3684c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 ... 3685c609719bSwdenk [file transfer complete] 3686c609719bSwdenk [connected] 3687c609719bSwdenk ## Start Addr = 0x00040004 3688c609719bSwdenk 3689c609719bSwdenk => go 40004 Hello World! This is a test. 3690c609719bSwdenk ## Starting application at 0x00040004 ... 3691c609719bSwdenk Hello World 3692c609719bSwdenk argc = 7 3693c609719bSwdenk argv[0] = "40004" 3694c609719bSwdenk argv[1] = "Hello" 3695c609719bSwdenk argv[2] = "World!" 3696c609719bSwdenk argv[3] = "This" 3697c609719bSwdenk argv[4] = "is" 3698c609719bSwdenk argv[5] = "a" 3699c609719bSwdenk argv[6] = "test." 3700c609719bSwdenk argv[7] = "<NULL>" 3701c609719bSwdenk Hit any key to exit ... 3702c609719bSwdenk 3703c609719bSwdenk ## Application terminated, rc = 0x0 3704c609719bSwdenk 3705c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt 3706c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'. 3707c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second. 3708c609719bSwdenkThe interrupt service routine is trivial, just printing a '.' 3709c609719bSwdenkcharacter, but this is just a demo program. The application can be 3710c609719bSwdenkcontrolled by the following keys: 3711c609719bSwdenk 3712c609719bSwdenk ? - print current values og the CPM Timer registers 3713c609719bSwdenk b - enable interrupts and start timer 3714c609719bSwdenk e - stop timer and disable interrupts 3715c609719bSwdenk q - quit application 3716c609719bSwdenk 3717c609719bSwdenk => loads 3718c609719bSwdenk ## Ready for S-Record download ... 3719c609719bSwdenk ~>examples/timer.srec 3720c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 ... 3721c609719bSwdenk [file transfer complete] 3722c609719bSwdenk [connected] 3723c609719bSwdenk ## Start Addr = 0x00040004 3724c609719bSwdenk 3725c609719bSwdenk => go 40004 3726c609719bSwdenk ## Starting application at 0x00040004 ... 3727c609719bSwdenk TIMERS=0xfff00980 3728c609719bSwdenk Using timer 1 3729c609719bSwdenk tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0 3730c609719bSwdenk 3731c609719bSwdenkHit 'b': 3732c609719bSwdenk [q, b, e, ?] Set interval 1000000 us 3733c609719bSwdenk Enabling timer 3734c609719bSwdenkHit '?': 3735c609719bSwdenk [q, b, e, ?] ........ 3736c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0 3737c609719bSwdenkHit '?': 3738c609719bSwdenk [q, b, e, ?] . 3739c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0 3740c609719bSwdenkHit '?': 3741c609719bSwdenk [q, b, e, ?] . 3742c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0 3743c609719bSwdenkHit '?': 3744c609719bSwdenk [q, b, e, ?] . 3745c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0 3746c609719bSwdenkHit 'e': 3747c609719bSwdenk [q, b, e, ?] ...Stopping timer 3748c609719bSwdenkHit 'q': 3749c609719bSwdenk [q, b, e, ?] ## Application terminated, rc = 0x0 3750c609719bSwdenk 3751c609719bSwdenk 375285ec0bccSwdenkMinicom warning: 375385ec0bccSwdenk================ 375485ec0bccSwdenk 37557152b1d0SwdenkOver time, many people have reported problems when trying to use the 375685ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd) 375785ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under 3758f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and 375985ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and 376085ec0bccSwdenkuse "cu" for S-Record download ("loads" command). 376185ec0bccSwdenk 376252f52c14SwdenkNevertheless, if you absolutely want to use it try adding this 376352f52c14Swdenkconfiguration to your "File transfer protocols" section: 376452f52c14Swdenk 376552f52c14Swdenk Name Program Name U/D FullScr IO-Red. Multi 376652f52c14Swdenk X kermit /usr/bin/kermit -i -l %l -s Y U Y N N 376752f52c14Swdenk Y kermit /usr/bin/kermit -i -l %l -r N D Y N N 376852f52c14Swdenk 376952f52c14Swdenk 3770c609719bSwdenkNetBSD Notes: 3771c609719bSwdenk============= 3772c609719bSwdenk 3773c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host 3774c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx). 3775c609719bSwdenk 3776c609719bSwdenkBuilding requires a cross environment; it is known to work on 3777c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also 3778c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make). 3779c609719bSwdenkNote that the cross-powerpc package does not install include files; 3780c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is 3781c609719bSwdenkmissing. This file has to be installed and patched manually: 3782c609719bSwdenk 3783c609719bSwdenk # cd /usr/pkg/cross/powerpc-netbsd/include 3784c609719bSwdenk # mkdir powerpc 3785c609719bSwdenk # ln -s powerpc machine 3786c609719bSwdenk # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h 3787c609719bSwdenk # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST 3788c609719bSwdenk 3789c609719bSwdenkNative builds *don't* work due to incompatibilities between native 3790c609719bSwdenkand U-Boot include files. 3791c609719bSwdenk 3792c609719bSwdenkBooting assumes that (the first part of) the image booted is a 3793c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel 3794c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source 3795c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the 37962a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz 3797c609719bSwdenk 3798c609719bSwdenk 3799c609719bSwdenkImplementation Internals: 3800c609719bSwdenk========================= 3801c609719bSwdenk 3802c609719bSwdenkThe following is not intended to be a complete description of every 3803c609719bSwdenkimplementation detail. However, it should help to understand the 3804c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom 3805c609719bSwdenkhardware. 3806c609719bSwdenk 3807c609719bSwdenk 3808c609719bSwdenkInitial Stack, Global Data: 3809c609719bSwdenk--------------------------- 3810c609719bSwdenk 3811c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot 3812c609719bSwdenkstarts running out of ROM (flash memory), usually without access to 3813c609719bSwdenksystem RAM (because the memory controller is not initialized yet). 3814c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS 3815c609719bSwdenkis not initialized as zero. To be able to get a C environment working 3816c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation 3817c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU 3818c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and 3819c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be 3820c609719bSwdenklocked as (mis-) used as memory, etc. 3821c609719bSwdenk 38227152b1d0Swdenk Chris Hallinan posted a good summary of these issues to the 38230668236bSWolfgang Denk U-Boot mailing list: 382443d9616cSwdenk 382543d9616cSwdenk Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)? 382643d9616cSwdenk From: "Chris Hallinan" <clh@net1plus.com> 382743d9616cSwdenk Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET) 382843d9616cSwdenk ... 382943d9616cSwdenk 383043d9616cSwdenk Correct me if I'm wrong, folks, but the way I understand it 383143d9616cSwdenk is this: Using DCACHE as initial RAM for Stack, etc, does not 383243d9616cSwdenk require any physical RAM backing up the cache. The cleverness 383343d9616cSwdenk is that the cache is being used as a temporary supply of 383443d9616cSwdenk necessary storage before the SDRAM controller is setup. It's 383511ccc33fSMarcel Ziswiler beyond the scope of this list to explain the details, but you 383643d9616cSwdenk can see how this works by studying the cache architecture and 383743d9616cSwdenk operation in the architecture and processor-specific manuals. 383843d9616cSwdenk 383943d9616cSwdenk OCM is On Chip Memory, which I believe the 405GP has 4K. It 384043d9616cSwdenk is another option for the system designer to use as an 384111ccc33fSMarcel Ziswiler initial stack/RAM area prior to SDRAM being available. Either 384243d9616cSwdenk option should work for you. Using CS 4 should be fine if your 384343d9616cSwdenk board designers haven't used it for something that would 384443d9616cSwdenk cause you grief during the initial boot! It is frequently not 384543d9616cSwdenk used. 384643d9616cSwdenk 38476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere 384843d9616cSwdenk with your processor/board/system design. The default value 384943d9616cSwdenk you will find in any recent u-boot distribution in 38508a316c9bSStefan Roese walnut.h should work for you. I'd set it to a value larger 385143d9616cSwdenk than your SDRAM module. If you have a 64MB SDRAM module, set 385243d9616cSwdenk it above 400_0000. Just make sure your board has no resources 385343d9616cSwdenk that are supposed to respond to that address! That code in 385443d9616cSwdenk start.S has been around a while and should work as is when 385543d9616cSwdenk you get the config right. 385643d9616cSwdenk 385743d9616cSwdenk -Chris Hallinan 385843d9616cSwdenk DS4.COM, Inc. 385943d9616cSwdenk 3860c609719bSwdenkIt is essential to remember this, since it has some impact on the C 3861c609719bSwdenkcode for the initialization procedures: 3862c609719bSwdenk 3863c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt 3864c609719bSwdenk to write it. 3865c609719bSwdenk 386611ccc33fSMarcel Ziswiler* Do not use any uninitialized global data (or implicitely initialized 3867c609719bSwdenk as zero data - BSS segment) at all - this is undefined, initiali- 38687152b1d0Swdenk zation is performed later (when relocating to RAM). 3869c609719bSwdenk 3870c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like 3871c609719bSwdenk that. 3872c609719bSwdenk 3873c609719bSwdenkHaving only the stack as writable memory limits means we cannot use 3874c609719bSwdenknormal global data to share information beween the code. But it 3875c609719bSwdenkturned out that the implementation of U-Boot can be greatly 3876c609719bSwdenksimplified by making a global data structure (gd_t) available to all 3877c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_ 3878c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of 3879c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we 3880c609719bSwdenkplace a pointer (gd) to the global data into a register which we 3881c609719bSwdenkreserve for this purpose. 3882c609719bSwdenk 38837152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the 3884c609719bSwdenkrelevant (E)ABI specifications for the current architecture, and by 3885c609719bSwdenkGCC's implementation. 3886c609719bSwdenk 3887c609719bSwdenkFor PowerPC, the following registers have specific use: 3888c609719bSwdenk R1: stack pointer 3889e7670f6cSWolfgang Denk R2: reserved for system use 3890c609719bSwdenk R3-R4: parameter passing and return values 3891c609719bSwdenk R5-R10: parameter passing 3892c609719bSwdenk R13: small data area pointer 3893c609719bSwdenk R30: GOT pointer 3894c609719bSwdenk R31: frame pointer 3895c609719bSwdenk 3896c609719bSwdenk (U-Boot also uses R14 as internal GOT pointer.) 3897c609719bSwdenk 3898e7670f6cSWolfgang Denk ==> U-Boot will use R2 to hold a pointer to the global data 3899c609719bSwdenk 3900c609719bSwdenk Note: on PPC, we could use a static initializer (since the 3901c609719bSwdenk address of the global data structure is known at compile time), 3902c609719bSwdenk but it turned out that reserving a register results in somewhat 3903c609719bSwdenk smaller code - although the code savings are not that big (on 3904c609719bSwdenk average for all boards 752 bytes for the whole U-Boot image, 3905c609719bSwdenk 624 text + 127 data). 3906c609719bSwdenk 39074c58eb55SMike FrysingerOn Blackfin, the normal C ABI (except for P5) is followed as documented here: 39084c58eb55SMike Frysinger http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface 39094c58eb55SMike Frysinger 39104c58eb55SMike Frysinger ==> U-Boot will use P5 to hold a pointer to the global data 39114c58eb55SMike Frysinger 3912c609719bSwdenkOn ARM, the following registers are used: 3913c609719bSwdenk 3914c609719bSwdenk R0: function argument word/integer result 3915c609719bSwdenk R1-R3: function argument word 3916c609719bSwdenk R9: GOT pointer 3917c609719bSwdenk R10: stack limit (used only if stack checking if enabled) 3918c609719bSwdenk R11: argument (frame) pointer 3919c609719bSwdenk R12: temporary workspace 3920c609719bSwdenk R13: stack pointer 3921c609719bSwdenk R14: link register 3922c609719bSwdenk R15: program counter 3923c609719bSwdenk 3924c609719bSwdenk ==> U-Boot will use R8 to hold a pointer to the global data 3925c609719bSwdenk 3926d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope, 3927d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much. 3928c609719bSwdenk 3929c609719bSwdenkMemory Management: 3930c609719bSwdenk------------------ 3931c609719bSwdenk 3932c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the 3933c609719bSwdenkMMU is not used either for address mapping nor for memory protection. 3934c609719bSwdenk 3935c609719bSwdenkThe available memory is mapped to fixed addresses using the memory 3936c609719bSwdenkcontroller. In this process, a contiguous block is formed for each 3937c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several 3938c609719bSwdenkphysical memory banks. 3939c609719bSwdenk 3940c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on 3941c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After 3942c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself 3943c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some 39446d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN 3945c609719bSwdenkconfiguration setting]. Below that, a structure with global Board 3946c609719bSwdenkInfo data is placed, followed by the stack (growing downward). 3947c609719bSwdenk 3948c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB 3949c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF). 3950c609719bSwdenk 3951c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like 3952c609719bSwdenkthis: 3953c609719bSwdenk 3954c609719bSwdenk 0x0000 0000 Exception Vector code 3955c609719bSwdenk : 3956c609719bSwdenk 0x0000 1FFF 3957c609719bSwdenk 0x0000 2000 Free for Application Use 3958c609719bSwdenk : 3959c609719bSwdenk : 3960c609719bSwdenk 3961c609719bSwdenk : 3962c609719bSwdenk : 3963c609719bSwdenk 0x00FB FF20 Monitor Stack (Growing downward) 3964c609719bSwdenk 0x00FB FFAC Board Info Data and permanent copy of global data 3965c609719bSwdenk 0x00FC 0000 Malloc Arena 3966c609719bSwdenk : 3967c609719bSwdenk 0x00FD FFFF 3968c609719bSwdenk 0x00FE 0000 RAM Copy of Monitor Code 3969c609719bSwdenk ... eventually: LCD or video framebuffer 3970c609719bSwdenk ... eventually: pRAM (Protected RAM - unchanged by reset) 3971c609719bSwdenk 0x00FF FFFF [End of RAM] 3972c609719bSwdenk 3973c609719bSwdenk 3974c609719bSwdenkSystem Initialization: 3975c609719bSwdenk---------------------- 3976c609719bSwdenk 3977c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point 397811ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset 3979c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory. 39807152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address. 3981c609719bSwdenkTo be able to implement the initialization code in C, a (small!) 3982c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs 3983c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked 3984c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core, 3985c609719bSwdenkthe caches and the SIU. 3986c609719bSwdenk 3987c609719bSwdenkNext, all (potentially) available memory banks are mapped using a 3988c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries 3989c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash 3990c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is 3991c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a 3992c609719bSwdenksimple memory test is run that determines the size of the SDRAM 3993c609719bSwdenkbanks. 3994c609719bSwdenk 3995c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of 39967152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first 3997c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address 3998c609719bSwdenk0x00000000, with any additional banks following immediately to create 3999c609719bSwdenkcontiguous memory starting from 0. 4000c609719bSwdenk 4001c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area 4002c609719bSwdenkand allocates memory for use by malloc() and for the global Board 4003c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM 4004c609719bSwdenkpages, and the final stack is set up. 4005c609719bSwdenk 4006c609719bSwdenkOnly after this relocation will you have a "normal" C environment; 4007c609719bSwdenkuntil that you are restricted in several ways, mostly because you are 4008c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a 4009c609719bSwdenknew address in RAM. 4010c609719bSwdenk 4011c609719bSwdenk 4012c609719bSwdenkU-Boot Porting Guide: 4013c609719bSwdenk---------------------- 4014c609719bSwdenk 4015c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing 40166aff3115Swdenklist, October 2002] 4017c609719bSwdenk 4018c609719bSwdenk 4019c609719bSwdenkint main(int argc, char *argv[]) 4020c609719bSwdenk{ 4021c609719bSwdenk sighandler_t no_more_time; 4022c609719bSwdenk 4023c609719bSwdenk signal(SIGALRM, no_more_time); 4024c609719bSwdenk alarm(PROJECT_DEADLINE - toSec (3 * WEEK)); 4025c609719bSwdenk 4026c609719bSwdenk if (available_money > available_manpower) { 40276c3fef28SJerry Van Baren Pay consultant to port U-Boot; 4028c609719bSwdenk return 0; 4029c609719bSwdenk } 4030c609719bSwdenk 4031c609719bSwdenk Download latest U-Boot source; 4032c609719bSwdenk 40330668236bSWolfgang Denk Subscribe to u-boot mailing list; 40346aff3115Swdenk 40356c3fef28SJerry Van Baren if (clueless) 4036c609719bSwdenk email("Hi, I am new to U-Boot, how do I get started?"); 4037c609719bSwdenk 4038c609719bSwdenk while (learning) { 4039c609719bSwdenk Read the README file in the top level directory; 40407cb22f97Swdenk Read http://www.denx.de/twiki/bin/view/DULG/Manual; 40416c3fef28SJerry Van Baren Read applicable doc/*.README; 4042c609719bSwdenk Read the source, Luke; 40436c3fef28SJerry Van Baren /* find . -name "*.[chS]" | xargs grep -i <keyword> */ 4044c609719bSwdenk } 4045c609719bSwdenk 40466c3fef28SJerry Van Baren if (available_money > toLocalCurrency ($2500)) 40476c3fef28SJerry Van Baren Buy a BDI3000; 40486c3fef28SJerry Van Baren else 4049c609719bSwdenk Add a lot of aggravation and time; 4050c609719bSwdenk 40516c3fef28SJerry Van Baren if (a similar board exists) { /* hopefully... */ 40526c3fef28SJerry Van Baren cp -a board/<similar> board/<myboard> 40536c3fef28SJerry Van Baren cp include/configs/<similar>.h include/configs/<myboard>.h 40546c3fef28SJerry Van Baren } else { 4055c609719bSwdenk Create your own board support subdirectory; 40566c3fef28SJerry Van Baren Create your own board include/configs/<myboard>.h file; 40576c3fef28SJerry Van Baren } 40586c3fef28SJerry Van Baren Edit new board/<myboard> files 40596c3fef28SJerry Van Baren Edit new include/configs/<myboard>.h 4060c609719bSwdenk 40616c3fef28SJerry Van Baren while (!accepted) { 4062c609719bSwdenk while (!running) { 4063c609719bSwdenk do { 4064c609719bSwdenk Add / modify source code; 4065c609719bSwdenk } until (compiles); 4066c609719bSwdenk Debug; 4067c609719bSwdenk if (clueless) 4068c609719bSwdenk email("Hi, I am having problems..."); 4069c609719bSwdenk } 40706c3fef28SJerry Van Baren Send patch file to the U-Boot email list; 40716c3fef28SJerry Van Baren if (reasonable critiques) 40726c3fef28SJerry Van Baren Incorporate improvements from email list code review; 40736c3fef28SJerry Van Baren else 40746c3fef28SJerry Van Baren Defend code as written; 40756c3fef28SJerry Van Baren } 4076c609719bSwdenk 4077c609719bSwdenk return 0; 4078c609719bSwdenk} 4079c609719bSwdenk 4080c609719bSwdenkvoid no_more_time (int sig) 4081c609719bSwdenk{ 4082c609719bSwdenk hire_a_guru(); 4083c609719bSwdenk} 4084c609719bSwdenk 4085c609719bSwdenk 4086c609719bSwdenkCoding Standards: 4087c609719bSwdenk----------------- 4088c609719bSwdenk 4089c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel 40902c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script 40912c051651SDetlev Zundel"scripts/Lindent" in your Linux kernel source directory. In sources 40922c051651SDetlev Zundeloriginating from U-Boot a style corresponding to "Lindent -pcs" (adding 40932c051651SDetlev Zundelspaces before parameters to function calls) is actually used. 4094c609719bSwdenk 40952c051651SDetlev ZundelSource files originating from a different project (for example the 40962c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not 40972c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those 40982c051651SDetlev Zundelsources. 40992c051651SDetlev Zundel 41002c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in 41012c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//) 41022c051651SDetlev Zundelin your code. 4103c609719bSwdenk 4104c178d3daSwdenkPlease also stick to the following formatting rules: 4105180d3f74Swdenk- remove any trailing white space 4106180d3f74Swdenk- use TAB characters for indentation, not spaces 4107180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds 4108180d3f74Swdenk- do not add more than 2 empty lines to source files 4109180d3f74Swdenk- do not add trailing empty lines to source files 4110180d3f74Swdenk 4111c609719bSwdenkSubmissions which do not conform to the standards may be returned 4112c609719bSwdenkwith a request to reformat the changes. 4113c609719bSwdenk 4114c609719bSwdenk 4115c609719bSwdenkSubmitting Patches: 4116c609719bSwdenk------------------- 4117c609719bSwdenk 4118c609719bSwdenkSince the number of patches for U-Boot is growing, we need to 4119c609719bSwdenkestablish some rules. Submissions which do not conform to these rules 4120c609719bSwdenkmay be rejected, even when they contain important and valuable stuff. 4121c609719bSwdenk 41220d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details. 4123218ca724SWolfgang Denk 41240668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>; 41250668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot 41260668236bSWolfgang Denk 4127c609719bSwdenkWhen you send a patch, please include the following information with 4128c609719bSwdenkit: 4129c609719bSwdenk 4130c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes 4131c609719bSwdenk this bug. Please try to include a way of demonstrating that the 4132c609719bSwdenk patch actually fixes something. 4133c609719bSwdenk 4134c609719bSwdenk* For new features: a description of the feature and your 4135c609719bSwdenk implementation. 4136c609719bSwdenk 4137c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch) 4138c609719bSwdenk 4139c609719bSwdenk* For major contributions, your entry to the CREDITS file 4140c609719bSwdenk 4141c609719bSwdenk* When you add support for a new board, don't forget to add this 4142c609719bSwdenk board to the MAKEALL script, too. 4143c609719bSwdenk 4144c609719bSwdenk* If your patch adds new configuration options, don't forget to 4145c609719bSwdenk document these in the README file. 4146c609719bSwdenk 4147218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly* 4148218ca724SWolfgang Denk recommended) you can easily generate the patch using the 4149218ca724SWolfgang Denk "git-format-patch". If you then use "git-send-email" to send it to 4150218ca724SWolfgang Denk the U-Boot mailing list, you will avoid most of the common problems 4151218ca724SWolfgang Denk with some other mail clients. 4152c609719bSwdenk 4153218ca724SWolfgang Denk If you cannot use git, use "diff -purN OLD NEW". If your version of 4154218ca724SWolfgang Denk diff does not support these options, then get the latest version of 4155218ca724SWolfgang Denk GNU diff. 41566dff5529Swdenk 4157218ca724SWolfgang Denk The current directory when running this command shall be the parent 4158218ca724SWolfgang Denk directory of the U-Boot source tree (i. e. please make sure that 4159218ca724SWolfgang Denk your patch includes sufficient directory information for the 4160218ca724SWolfgang Denk affected files). 4161218ca724SWolfgang Denk 4162218ca724SWolfgang Denk We prefer patches as plain text. MIME attachments are discouraged, 4163218ca724SWolfgang Denk and compressed attachments must not be used. 4164c609719bSwdenk 416552f52c14Swdenk* If one logical set of modifications affects or creates several 416652f52c14Swdenk files, all these changes shall be submitted in a SINGLE patch file. 416752f52c14Swdenk 416852f52c14Swdenk* Changesets that contain different, unrelated modifications shall be 416952f52c14Swdenk submitted as SEPARATE patches, one patch per changeset. 417052f52c14Swdenk 417152f52c14Swdenk 4172c609719bSwdenkNotes: 4173c609719bSwdenk 4174c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched 4175c609719bSwdenk source tree and make sure that no errors or warnings are reported 4176c609719bSwdenk for any of the boards. 4177c609719bSwdenk 4178c609719bSwdenk* Keep your modifications to the necessary minimum: A patch 4179c609719bSwdenk containing several unrelated changes or arbitrary reformats will be 4180c609719bSwdenk returned with a request to re-formatting / split it. 4181c609719bSwdenk 4182c609719bSwdenk* If you modify existing code, make sure that your new code does not 4183c609719bSwdenk add to the memory footprint of the code ;-) Small is beautiful! 4184c609719bSwdenk When adding new features, these should compile conditionally only 4185c609719bSwdenk (using #ifdef), and the resulting code with the new feature 4186c609719bSwdenk disabled must not need more memory than the old code without your 4187c609719bSwdenk modification. 418890dc6704Swdenk 41890668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the 41900668236bSWolfgang Denk u-boot mailing list. Bigger patches will be moderated. If they are 41910668236bSWolfgang Denk reasonable and not too big, they will be acknowledged. But patches 41920668236bSWolfgang Denk bigger than the size limit should be avoided. 4193