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 3210b953ffcSMarkus Klotzbuecher- Intel Monahans options: 3226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO 3230b953ffcSMarkus Klotzbuecher 3240b953ffcSMarkus Klotzbuecher Defines the Monahans run mode to oscillator 3250b953ffcSMarkus Klotzbuecher ratio. Valid values are 8, 16, 24, 31. The core 3260b953ffcSMarkus Klotzbuecher frequency is this value multiplied by 13 MHz. 3270b953ffcSMarkus Klotzbuecher 3286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO 3290b953ffcSMarkus Klotzbuecher 3300b953ffcSMarkus Klotzbuecher Defines the Monahans turbo mode to oscillator 3310b953ffcSMarkus Klotzbuecher ratio. Valid values are 1 (default if undefined) and 3320b953ffcSMarkus Klotzbuecher 2. The core frequency as calculated above is multiplied 3330b953ffcSMarkus Klotzbuecher by this value. 3340b953ffcSMarkus Klotzbuecher 3355da627a4Swdenk- Linux Kernel Interface: 336c609719bSwdenk CONFIG_CLOCKS_IN_MHZ 337c609719bSwdenk 338c609719bSwdenk U-Boot stores all clock information in Hz 339c609719bSwdenk internally. For binary compatibility with older Linux 340c609719bSwdenk kernels (which expect the clocks passed in the 341c609719bSwdenk bd_info data to be in MHz) the environment variable 342c609719bSwdenk "clocks_in_mhz" can be defined so that U-Boot 343c609719bSwdenk converts clock data to MHZ before passing it to the 344c609719bSwdenk Linux kernel. 345c609719bSwdenk When CONFIG_CLOCKS_IN_MHZ is defined, a definition of 346c609719bSwdenk "clocks_in_mhz=1" is automatically included in the 347c609719bSwdenk default environment. 348c609719bSwdenk 3495da627a4Swdenk CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only] 3505da627a4Swdenk 35111ccc33fSMarcel Ziswiler When transferring memsize parameter to linux, some versions 3525da627a4Swdenk expect it to be in bytes, others in MB. 3535da627a4Swdenk Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes. 3545da627a4Swdenk 355fec6d9eeSGerald Van Baren CONFIG_OF_LIBFDT 356f57f70aaSWolfgang Denk 357f57f70aaSWolfgang Denk New kernel versions are expecting firmware settings to be 358213bf8c8SGerald Van Baren passed using flattened device trees (based on open firmware 359213bf8c8SGerald Van Baren concepts). 360213bf8c8SGerald Van Baren 361213bf8c8SGerald Van Baren CONFIG_OF_LIBFDT 362213bf8c8SGerald Van Baren * New libfdt-based support 363213bf8c8SGerald Van Baren * Adds the "fdt" command 3643bb342fcSKim Phillips * The bootm command automatically updates the fdt 365213bf8c8SGerald Van Baren 366f57f70aaSWolfgang Denk OF_CPU - The proper name of the cpus node. 367c2871f03SKumar Gala OF_SOC - The proper name of the soc node. 368f57f70aaSWolfgang Denk OF_TBCLK - The timebase frequency. 369c2871f03SKumar Gala OF_STDOUT_PATH - The path to the console device 370f57f70aaSWolfgang Denk 37111ccc33fSMarcel Ziswiler boards with QUICC Engines require OF_QE to set UCC MAC 37211ccc33fSMarcel Ziswiler addresses 3733bb342fcSKim Phillips 3744e253137SKumar Gala CONFIG_OF_BOARD_SETUP 3754e253137SKumar Gala 3764e253137SKumar Gala Board code has addition modification that it wants to make 3774e253137SKumar Gala to the flat device tree before handing it off to the kernel 3786705d81eSwdenk 3790267768eSMatthew McClintock CONFIG_OF_BOOT_CPU 3800267768eSMatthew McClintock 38111ccc33fSMarcel Ziswiler This define fills in the correct boot CPU in the boot 3820267768eSMatthew McClintock param header, the default value is zero if undefined. 3830267768eSMatthew McClintock 3840b2f4ecaSNiklaus Giger- vxWorks boot parameters: 3850b2f4ecaSNiklaus Giger 3860b2f4ecaSNiklaus Giger bootvx constructs a valid bootline using the following 3870b2f4ecaSNiklaus Giger environments variables: bootfile, ipaddr, serverip, hostname. 3880b2f4ecaSNiklaus Giger It loads the vxWorks image pointed bootfile. 3890b2f4ecaSNiklaus Giger 3900b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name 3910b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address 3920b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server 3930b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters 3940b2f4ecaSNiklaus Giger 3950b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_ADD_PARAMS 3960b2f4ecaSNiklaus Giger 3970b2f4ecaSNiklaus Giger Add it at the end of the bootline. E.g "u=username pw=secret" 3980b2f4ecaSNiklaus Giger 3990b2f4ecaSNiklaus Giger Note: If a "bootargs" environment is defined, it will overwride 4000b2f4ecaSNiklaus Giger the defaults discussed just above. 4010b2f4ecaSNiklaus Giger 4026705d81eSwdenk- Serial Ports: 40348d0192fSAndreas Engel CONFIG_PL010_SERIAL 4046705d81eSwdenk 4056705d81eSwdenk Define this if you want support for Amba PrimeCell PL010 UARTs. 4066705d81eSwdenk 40748d0192fSAndreas Engel CONFIG_PL011_SERIAL 4086705d81eSwdenk 4096705d81eSwdenk Define this if you want support for Amba PrimeCell PL011 UARTs. 4106705d81eSwdenk 4116705d81eSwdenk CONFIG_PL011_CLOCK 4126705d81eSwdenk 4136705d81eSwdenk If you have Amba PrimeCell PL011 UARTs, set this variable to 4146705d81eSwdenk the clock speed of the UARTs. 4156705d81eSwdenk 4166705d81eSwdenk CONFIG_PL01x_PORTS 4176705d81eSwdenk 4186705d81eSwdenk If you have Amba PrimeCell PL010 or PL011 UARTs on your board, 4196705d81eSwdenk define this to a list of base addresses for each (supported) 4206705d81eSwdenk port. See e.g. include/configs/versatile.h 4216705d81eSwdenk 4226705d81eSwdenk 423c609719bSwdenk- Console Interface: 424c609719bSwdenk Depending on board, define exactly one serial port 425c609719bSwdenk (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2, 426c609719bSwdenk CONFIG_8xx_CONS_SCC1, ...), or switch off the serial 427c609719bSwdenk console by defining CONFIG_8xx_CONS_NONE 428c609719bSwdenk 429c609719bSwdenk Note: if CONFIG_8xx_CONS_NONE is defined, the serial 430c609719bSwdenk port routines must be defined elsewhere 431c609719bSwdenk (i.e. serial_init(), serial_getc(), ...) 432c609719bSwdenk 433c609719bSwdenk CONFIG_CFB_CONSOLE 434c609719bSwdenk Enables console device for a color framebuffer. Needs following 435c609719bSwdenk defines (cf. smiLynxEM, i8042, board/eltec/bab7xx) 436c609719bSwdenk VIDEO_FB_LITTLE_ENDIAN graphic memory organisation 437c609719bSwdenk (default big endian) 438c609719bSwdenk VIDEO_HW_RECTFILL graphic chip supports 439c609719bSwdenk rectangle fill 440c609719bSwdenk (cf. smiLynxEM) 441c609719bSwdenk VIDEO_HW_BITBLT graphic chip supports 442c609719bSwdenk bit-blit (cf. smiLynxEM) 443c609719bSwdenk VIDEO_VISIBLE_COLS visible pixel columns 444c609719bSwdenk (cols=pitch) 445c609719bSwdenk VIDEO_VISIBLE_ROWS visible pixel rows 446c609719bSwdenk VIDEO_PIXEL_SIZE bytes per pixel 447c609719bSwdenk VIDEO_DATA_FORMAT graphic data format 448c609719bSwdenk (0-5, cf. cfb_console.c) 449c609719bSwdenk VIDEO_FB_ADRS framebuffer address 450c609719bSwdenk VIDEO_KBD_INIT_FCT keyboard int fct 451c609719bSwdenk (i.e. i8042_kbd_init()) 452c609719bSwdenk VIDEO_TSTC_FCT test char fct 453c609719bSwdenk (i.e. i8042_tstc) 454c609719bSwdenk VIDEO_GETC_FCT get char fct 455c609719bSwdenk (i.e. i8042_getc) 456c609719bSwdenk CONFIG_CONSOLE_CURSOR cursor drawing on/off 457c609719bSwdenk (requires blink timer 458c609719bSwdenk cf. i8042.c) 4596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c) 460c609719bSwdenk CONFIG_CONSOLE_TIME display time/date info in 461c609719bSwdenk upper right corner 462602ad3b3SJon Loeliger (requires CONFIG_CMD_DATE) 463c609719bSwdenk CONFIG_VIDEO_LOGO display Linux logo in 464c609719bSwdenk upper left corner 465a6c7ad2fSwdenk CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of 466a6c7ad2fSwdenk linux_logo.h for logo. 467a6c7ad2fSwdenk Requires CONFIG_VIDEO_LOGO 468c609719bSwdenk CONFIG_CONSOLE_EXTRA_INFO 46911ccc33fSMarcel Ziswiler additional board info beside 470c609719bSwdenk the logo 471c609719bSwdenk 472c609719bSwdenk When CONFIG_CFB_CONSOLE is defined, video console is 473c609719bSwdenk default i/o. Serial console can be forced with 474c609719bSwdenk environment 'console=serial'. 475c609719bSwdenk 476a3ad8e26Swdenk When CONFIG_SILENT_CONSOLE is defined, all console 477a3ad8e26Swdenk messages (by U-Boot and Linux!) can be silenced with 478a3ad8e26Swdenk the "silent" environment variable. See 479a3ad8e26Swdenk doc/README.silent for more information. 480a3ad8e26Swdenk 481c609719bSwdenk- Console Baudrate: 482c609719bSwdenk CONFIG_BAUDRATE - in bps 483c609719bSwdenk Select one of the baudrates listed in 4846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BAUDRATE_TABLE, see below. 4856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale 486c609719bSwdenk 487c609719bSwdenk- Interrupt driven serial port input: 488c609719bSwdenk CONFIG_SERIAL_SOFTWARE_FIFO 489c609719bSwdenk 490c609719bSwdenk PPC405GP only. 491c609719bSwdenk Use an interrupt handler for receiving data on the 492c609719bSwdenk serial port. It also enables using hardware handshake 493c609719bSwdenk (RTS/CTS) and UART's built-in FIFO. Set the number of 494c609719bSwdenk bytes the interrupt driven input buffer should have. 495c609719bSwdenk 496109c0e3aSwdenk Leave undefined to disable this feature, including 497109c0e3aSwdenk disable the buffer and hardware handshake. 498c609719bSwdenk 4991d49b1f3Sstroese- Console UART Number: 5001d49b1f3Sstroese CONFIG_UART1_CONSOLE 5011d49b1f3Sstroese 5020c8721a4SWolfgang Denk AMCC PPC4xx only. 5031d49b1f3Sstroese If defined internal UART1 (and not UART0) is used 5041d49b1f3Sstroese as default U-Boot console. 5051d49b1f3Sstroese 506c609719bSwdenk- Boot Delay: CONFIG_BOOTDELAY - in seconds 507c609719bSwdenk Delay before automatically booting the default image; 508c609719bSwdenk set to -1 to disable autoboot. 509c609719bSwdenk 510c609719bSwdenk See doc/README.autoboot for these options that 511c609719bSwdenk work with CONFIG_BOOTDELAY. None are required. 512c609719bSwdenk CONFIG_BOOT_RETRY_TIME 513c609719bSwdenk CONFIG_BOOT_RETRY_MIN 514c609719bSwdenk CONFIG_AUTOBOOT_KEYED 515c609719bSwdenk CONFIG_AUTOBOOT_PROMPT 516c609719bSwdenk CONFIG_AUTOBOOT_DELAY_STR 517c609719bSwdenk CONFIG_AUTOBOOT_STOP_STR 518c609719bSwdenk CONFIG_AUTOBOOT_DELAY_STR2 519c609719bSwdenk CONFIG_AUTOBOOT_STOP_STR2 520c609719bSwdenk CONFIG_ZERO_BOOTDELAY_CHECK 521c609719bSwdenk CONFIG_RESET_TO_RETRY 522c609719bSwdenk 523c609719bSwdenk- Autoboot Command: 524c609719bSwdenk CONFIG_BOOTCOMMAND 525c609719bSwdenk Only needed when CONFIG_BOOTDELAY is enabled; 526c609719bSwdenk define a command string that is automatically executed 527c609719bSwdenk when no character is read on the console interface 528c609719bSwdenk within "Boot Delay" after reset. 529c609719bSwdenk 530c609719bSwdenk CONFIG_BOOTARGS 531c609719bSwdenk This can be used to pass arguments to the bootm 532c609719bSwdenk command. The value of CONFIG_BOOTARGS goes into the 533c609719bSwdenk environment value "bootargs". 534c609719bSwdenk 535c609719bSwdenk CONFIG_RAMBOOT and CONFIG_NFSBOOT 536c609719bSwdenk The value of these goes into the environment as 537c609719bSwdenk "ramboot" and "nfsboot" respectively, and can be used 538c609719bSwdenk as a convenience, when switching between booting from 53911ccc33fSMarcel Ziswiler RAM and NFS. 540c609719bSwdenk 541c609719bSwdenk- Pre-Boot Commands: 542c609719bSwdenk CONFIG_PREBOOT 543c609719bSwdenk 544c609719bSwdenk When this option is #defined, the existence of the 545c609719bSwdenk environment variable "preboot" will be checked 546c609719bSwdenk immediately before starting the CONFIG_BOOTDELAY 547c609719bSwdenk countdown and/or running the auto-boot command resp. 548c609719bSwdenk entering interactive mode. 549c609719bSwdenk 550c609719bSwdenk This feature is especially useful when "preboot" is 551c609719bSwdenk automatically generated or modified. For an example 552c609719bSwdenk see the LWMON board specific code: here "preboot" is 553c609719bSwdenk modified when the user holds down a certain 554c609719bSwdenk combination of keys on the (special) keyboard when 555c609719bSwdenk booting the systems 556c609719bSwdenk 557c609719bSwdenk- Serial Download Echo Mode: 558c609719bSwdenk CONFIG_LOADS_ECHO 559c609719bSwdenk If defined to 1, all characters received during a 560c609719bSwdenk serial download (using the "loads" command) are 561c609719bSwdenk echoed back. This might be needed by some terminal 562c609719bSwdenk emulations (like "cu"), but may as well just take 563c609719bSwdenk time on others. This setting #define's the initial 564c609719bSwdenk value of the "loads_echo" environment variable. 565c609719bSwdenk 566602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined) 567c609719bSwdenk CONFIG_KGDB_BAUDRATE 568c609719bSwdenk Select one of the baudrates listed in 5696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BAUDRATE_TABLE, see below. 570c609719bSwdenk 571c609719bSwdenk- Monitor Functions: 572602ad3b3SJon Loeliger Monitor commands can be included or excluded 573602ad3b3SJon Loeliger from the build by using the #include files 574602ad3b3SJon Loeliger "config_cmd_all.h" and #undef'ing unwanted 575602ad3b3SJon Loeliger commands, or using "config_cmd_default.h" 576602ad3b3SJon Loeliger and augmenting with additional #define's 577602ad3b3SJon Loeliger for wanted commands. 578c609719bSwdenk 579602ad3b3SJon Loeliger The default command configuration includes all commands 580602ad3b3SJon Loeliger except those marked below with a "*". 581602ad3b3SJon Loeliger 582602ad3b3SJon Loeliger CONFIG_CMD_ASKENV * ask for env variable 583602ad3b3SJon Loeliger CONFIG_CMD_AUTOSCRIPT Autoscript Support 584602ad3b3SJon Loeliger CONFIG_CMD_BDI bdinfo 585602ad3b3SJon Loeliger CONFIG_CMD_BEDBUG * Include BedBug Debugger 586602ad3b3SJon Loeliger CONFIG_CMD_BMP * BMP support 587602ad3b3SJon Loeliger CONFIG_CMD_BSP * Board specific commands 588602ad3b3SJon Loeliger CONFIG_CMD_BOOTD bootd 589602ad3b3SJon Loeliger CONFIG_CMD_CACHE * icache, dcache 590602ad3b3SJon Loeliger CONFIG_CMD_CONSOLE coninfo 591602ad3b3SJon Loeliger CONFIG_CMD_DATE * support for RTC, date/time... 592602ad3b3SJon Loeliger CONFIG_CMD_DHCP * DHCP support 593602ad3b3SJon Loeliger CONFIG_CMD_DIAG * Diagnostics 594602ad3b3SJon Loeliger CONFIG_CMD_DOC * Disk-On-Chip Support 595602ad3b3SJon Loeliger CONFIG_CMD_DTT * Digital Therm and Thermostat 596602ad3b3SJon Loeliger CONFIG_CMD_ECHO echo arguments 597602ad3b3SJon Loeliger CONFIG_CMD_EEPROM * EEPROM read/write support 598602ad3b3SJon Loeliger CONFIG_CMD_ELF * bootelf, bootvx 599602ad3b3SJon Loeliger CONFIG_CMD_ENV saveenv 600602ad3b3SJon Loeliger CONFIG_CMD_FDC * Floppy Disk Support 601602ad3b3SJon Loeliger CONFIG_CMD_FAT * FAT partition support 602602ad3b3SJon Loeliger CONFIG_CMD_FDOS * Dos diskette Support 603602ad3b3SJon Loeliger CONFIG_CMD_FLASH flinfo, erase, protect 604602ad3b3SJon Loeliger CONFIG_CMD_FPGA FPGA device initialization support 605602ad3b3SJon Loeliger CONFIG_CMD_HWFLOW * RTS/CTS hw flow control 606602ad3b3SJon Loeliger CONFIG_CMD_I2C * I2C serial bus support 607602ad3b3SJon Loeliger CONFIG_CMD_IDE * IDE harddisk support 608602ad3b3SJon Loeliger CONFIG_CMD_IMI iminfo 609602ad3b3SJon Loeliger CONFIG_CMD_IMLS List all found images 610602ad3b3SJon Loeliger CONFIG_CMD_IMMAP * IMMR dump support 611602ad3b3SJon Loeliger CONFIG_CMD_IRQ * irqinfo 612602ad3b3SJon Loeliger CONFIG_CMD_ITEST Integer/string test of 2 values 613602ad3b3SJon Loeliger CONFIG_CMD_JFFS2 * JFFS2 Support 614602ad3b3SJon Loeliger CONFIG_CMD_KGDB * kgdb 615602ad3b3SJon Loeliger CONFIG_CMD_LOADB loadb 616602ad3b3SJon Loeliger CONFIG_CMD_LOADS loads 617602ad3b3SJon Loeliger CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base, 61856523f12Swdenk loop, loopw, mtest 619602ad3b3SJon Loeliger CONFIG_CMD_MISC Misc functions like sleep etc 620602ad3b3SJon Loeliger CONFIG_CMD_MMC * MMC memory mapped support 621602ad3b3SJon Loeliger CONFIG_CMD_MII * MII utility commands 622602ad3b3SJon Loeliger CONFIG_CMD_NAND * NAND support 623602ad3b3SJon Loeliger CONFIG_CMD_NET bootp, tftpboot, rarpboot 624*e92739d3SPeter Tyser CONFIG_CMD_PCA953X * PCA953x I2C gpio commands 625*e92739d3SPeter Tyser CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command 626602ad3b3SJon Loeliger CONFIG_CMD_PCI * pciinfo 627602ad3b3SJon Loeliger CONFIG_CMD_PCMCIA * PCMCIA support 628602ad3b3SJon Loeliger CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network 629602ad3b3SJon Loeliger host 630602ad3b3SJon Loeliger CONFIG_CMD_PORTIO * Port I/O 631602ad3b3SJon Loeliger CONFIG_CMD_REGINFO * Register dump 632602ad3b3SJon Loeliger CONFIG_CMD_RUN run command in env variable 633602ad3b3SJon Loeliger CONFIG_CMD_SAVES * save S record dump 634602ad3b3SJon Loeliger CONFIG_CMD_SCSI * SCSI Support 635602ad3b3SJon Loeliger CONFIG_CMD_SDRAM * print SDRAM configuration information 636602ad3b3SJon Loeliger (requires CONFIG_CMD_I2C) 637602ad3b3SJon Loeliger CONFIG_CMD_SETGETDCR Support for DCR Register access 638602ad3b3SJon Loeliger (4xx only) 639602ad3b3SJon Loeliger CONFIG_CMD_SPI * SPI serial bus support 640602ad3b3SJon Loeliger CONFIG_CMD_USB * USB support 641602ad3b3SJon Loeliger CONFIG_CMD_VFD * VFD support (TRAB) 642602ad3b3SJon Loeliger CONFIG_CMD_CDP * Cisco Discover Protocol support 643602ad3b3SJon Loeliger CONFIG_CMD_FSL * Microblaze FSL support 644c609719bSwdenk 645c609719bSwdenk 646c609719bSwdenk EXAMPLE: If you want all functions except of network 647c609719bSwdenk support you can write: 648c609719bSwdenk 649602ad3b3SJon Loeliger #include "config_cmd_all.h" 650602ad3b3SJon Loeliger #undef CONFIG_CMD_NET 651c609719bSwdenk 652213bf8c8SGerald Van Baren Other Commands: 653213bf8c8SGerald Van Baren fdt (flattened device tree) command: CONFIG_OF_LIBFDT 654c609719bSwdenk 655c609719bSwdenk Note: Don't enable the "icache" and "dcache" commands 656602ad3b3SJon Loeliger (configuration option CONFIG_CMD_CACHE) unless you know 657c609719bSwdenk what you (and your U-Boot users) are doing. Data 658c609719bSwdenk cache cannot be enabled on systems like the 8xx or 659c609719bSwdenk 8260 (where accesses to the IMMR region must be 660c609719bSwdenk uncached), and it cannot be disabled on all other 661c609719bSwdenk systems where we (mis-) use the data cache to hold an 662c609719bSwdenk initial stack and some data. 663c609719bSwdenk 664c609719bSwdenk 665c609719bSwdenk XXX - this list needs to get updated! 666c609719bSwdenk 667c609719bSwdenk- Watchdog: 668c609719bSwdenk CONFIG_WATCHDOG 669c609719bSwdenk If this variable is defined, it enables watchdog 6707152b1d0Swdenk support. There must be support in the platform specific 671c609719bSwdenk code for a watchdog. For the 8xx and 8260 CPUs, the 672c609719bSwdenk SIU Watchdog feature is enabled in the SYPCR 673c609719bSwdenk register. 674c609719bSwdenk 675c1551ea8Sstroese- U-Boot Version: 676c1551ea8Sstroese CONFIG_VERSION_VARIABLE 677c1551ea8Sstroese If this variable is defined, an environment variable 678c1551ea8Sstroese named "ver" is created by U-Boot showing the U-Boot 679c1551ea8Sstroese version as printed by the "version" command. 680c1551ea8Sstroese This variable is readonly. 681c1551ea8Sstroese 682c609719bSwdenk- Real-Time Clock: 683c609719bSwdenk 684602ad3b3SJon Loeliger When CONFIG_CMD_DATE is selected, the type of the RTC 685c609719bSwdenk has to be selected, too. Define exactly one of the 686c609719bSwdenk following options: 687c609719bSwdenk 688c609719bSwdenk CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx 689c609719bSwdenk CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC 6907ce63709SGuennadi Liakhovetski CONFIG_RTC_MC13783 - use MC13783 RTC 691c609719bSwdenk CONFIG_RTC_MC146818 - use MC146818 RTC 6921cb8e980Swdenk CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC 693c609719bSwdenk CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC 6947f70e853Swdenk CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC 6953bac3513Swdenk CONFIG_RTC_DS164x - use Dallas DS164x RTC 6969536dfccSTor Krill CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC 6974c0d4c3bSwdenk CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC 6986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337 699c609719bSwdenk 700b37c7e5eSwdenk Note that if the RTC uses I2C, then the I2C interface 701b37c7e5eSwdenk must also be configured. See I2C Support, below. 702b37c7e5eSwdenk 703*e92739d3SPeter Tyser- GPIO Support: 704*e92739d3SPeter Tyser CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO 705*e92739d3SPeter Tyser CONFIG_PCA953X_INFO - enable pca953x info command 706*e92739d3SPeter Tyser 707*e92739d3SPeter Tyser Note that if the GPIO device uses I2C, then the I2C interface 708*e92739d3SPeter Tyser must also be configured. See I2C Support, below. 709*e92739d3SPeter Tyser 710c609719bSwdenk- Timestamp Support: 711c609719bSwdenk 712c609719bSwdenk When CONFIG_TIMESTAMP is selected, the timestamp 713c609719bSwdenk (date and time) of an image is printed by image 714c609719bSwdenk commands like bootm or iminfo. This option is 715602ad3b3SJon Loeliger automatically enabled when you select CONFIG_CMD_DATE . 716c609719bSwdenk 717c609719bSwdenk- Partition Support: 718c609719bSwdenk CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION 71907f3d789Srichardretanubun and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION 720c609719bSwdenk 721602ad3b3SJon Loeliger If IDE or SCSI support is enabled (CONFIG_CMD_IDE or 722218ca724SWolfgang Denk CONFIG_CMD_SCSI) you must configure support for at 723218ca724SWolfgang Denk least one partition type as well. 724c609719bSwdenk 725c609719bSwdenk- IDE Reset method: 7264d13cbadSwdenk CONFIG_IDE_RESET_ROUTINE - this is defined in several 7274d13cbadSwdenk board configurations files but used nowhere! 728c609719bSwdenk 7294d13cbadSwdenk CONFIG_IDE_RESET - is this is defined, IDE Reset will 7304d13cbadSwdenk be performed by calling the function 7314d13cbadSwdenk ide_set_reset(int reset) 7324d13cbadSwdenk which has to be defined in a board specific file 733c609719bSwdenk 734c609719bSwdenk- ATAPI Support: 735c609719bSwdenk CONFIG_ATAPI 736c609719bSwdenk 737c609719bSwdenk Set this to enable ATAPI support. 738c609719bSwdenk 739c40b2956Swdenk- LBA48 Support 740c40b2956Swdenk CONFIG_LBA48 741c40b2956Swdenk 742c40b2956Swdenk Set this to enable support for disks larger than 137GB 7436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD Also look at CONFIG_SYS_64BIT_LBA ,CONFIG_SYS_64BIT_VSPRINTF and CONFIG_SYS_64BIT_STRTOUL 744c40b2956Swdenk Whithout these , LBA48 support uses 32bit variables and will 'only' 745c40b2956Swdenk support disks up to 2.1TB. 746c40b2956Swdenk 7476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_64BIT_LBA: 748c40b2956Swdenk When enabled, makes the IDE subsystem use 64bit sector addresses. 749c40b2956Swdenk Default is 32bit. 750c40b2956Swdenk 751c609719bSwdenk- SCSI Support: 752c609719bSwdenk At the moment only there is only support for the 753c609719bSwdenk SYM53C8XX SCSI controller; define 754c609719bSwdenk CONFIG_SCSI_SYM53C8XX to enable it. 755c609719bSwdenk 7566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and 7576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID * 7586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the 759c609719bSwdenk maximum numbers of LUNs, SCSI ID's and target 760c609719bSwdenk devices. 7616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz) 762c609719bSwdenk 763c609719bSwdenk- NETWORK Support (PCI): 764682011ffSwdenk CONFIG_E1000 765682011ffSwdenk Support for Intel 8254x gigabit chips. 766682011ffSwdenk 767ac3315c2SAndre Schwarz CONFIG_E1000_FALLBACK_MAC 76811ccc33fSMarcel Ziswiler default MAC for empty EEPROM after production. 769ac3315c2SAndre Schwarz 770c609719bSwdenk CONFIG_EEPRO100 771c609719bSwdenk Support for Intel 82557/82559/82559ER chips. 77211ccc33fSMarcel Ziswiler Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM 773c609719bSwdenk write routine for first time initialisation. 774c609719bSwdenk 775c609719bSwdenk CONFIG_TULIP 776c609719bSwdenk Support for Digital 2114x chips. 777c609719bSwdenk Optional CONFIG_TULIP_SELECT_MEDIA for board specific 778c609719bSwdenk modem chip initialisation (KS8761/QS6611). 779c609719bSwdenk 780c609719bSwdenk CONFIG_NATSEMI 781c609719bSwdenk Support for National dp83815 chips. 782c609719bSwdenk 783c609719bSwdenk CONFIG_NS8382X 784c609719bSwdenk Support for National dp8382[01] gigabit chips. 785c609719bSwdenk 78645219c46Swdenk- NETWORK Support (other): 78745219c46Swdenk 78845219c46Swdenk CONFIG_DRIVER_LAN91C96 78945219c46Swdenk Support for SMSC's LAN91C96 chips. 79045219c46Swdenk 79145219c46Swdenk CONFIG_LAN91C96_BASE 79245219c46Swdenk Define this to hold the physical address 79345219c46Swdenk of the LAN91C96's I/O space 79445219c46Swdenk 79545219c46Swdenk CONFIG_LAN91C96_USE_32_BIT 79645219c46Swdenk Define this to enable 32 bit addressing 79745219c46Swdenk 798f39748aeSwdenk CONFIG_DRIVER_SMC91111 799f39748aeSwdenk Support for SMSC's LAN91C111 chip 800f39748aeSwdenk 801f39748aeSwdenk CONFIG_SMC91111_BASE 802f39748aeSwdenk Define this to hold the physical address 803f39748aeSwdenk of the device (I/O space) 804f39748aeSwdenk 805f39748aeSwdenk CONFIG_SMC_USE_32_BIT 806f39748aeSwdenk Define this if data bus is 32 bits 807f39748aeSwdenk 808f39748aeSwdenk CONFIG_SMC_USE_IOFUNCS 809f39748aeSwdenk Define this to use i/o functions instead of macros 810f39748aeSwdenk (some hardware wont work with macros) 811f39748aeSwdenk 812557b377dSJens Gehrlein CONFIG_DRIVER_SMC911X 813557b377dSJens Gehrlein Support for SMSC's LAN911x and LAN921x chips 814557b377dSJens Gehrlein 815557b377dSJens Gehrlein CONFIG_DRIVER_SMC911X_BASE 816557b377dSJens Gehrlein Define this to hold the physical address 817557b377dSJens Gehrlein of the device (I/O space) 818557b377dSJens Gehrlein 819557b377dSJens Gehrlein CONFIG_DRIVER_SMC911X_32_BIT 820557b377dSJens Gehrlein Define this if data bus is 32 bits 821557b377dSJens Gehrlein 822557b377dSJens Gehrlein CONFIG_DRIVER_SMC911X_16_BIT 823557b377dSJens Gehrlein Define this if data bus is 16 bits. If your processor 824557b377dSJens Gehrlein automatically converts one 32 bit word to two 16 bit 825557b377dSJens Gehrlein words you may also try CONFIG_DRIVER_SMC911X_32_BIT. 826557b377dSJens Gehrlein 827c609719bSwdenk- USB Support: 828c609719bSwdenk At the moment only the UHCI host controller is 8294d13cbadSwdenk supported (PIP405, MIP405, MPC5200); define 830c609719bSwdenk CONFIG_USB_UHCI to enable it. 831c609719bSwdenk define CONFIG_USB_KEYBOARD to enable the USB Keyboard 83230d56faeSwdenk and define CONFIG_USB_STORAGE to enable the USB 833c609719bSwdenk storage devices. 834c609719bSwdenk Note: 835c609719bSwdenk Supported are USB Keyboards and USB Floppy drives 836c609719bSwdenk (TEAC FD-05PUB). 8374d13cbadSwdenk MPC5200 USB requires additional defines: 8384d13cbadSwdenk CONFIG_USB_CLOCK 8394d13cbadSwdenk for 528 MHz Clock: 0x0001bbbb 8404d13cbadSwdenk CONFIG_USB_CONFIG 8414d13cbadSwdenk for differential drivers: 0x00001000 8424d13cbadSwdenk for single ended drivers: 0x00005000 8436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_USB_EVENT_POLL 844fdcfaa1bSZhang Wei May be defined to allow interrupt polling 845fdcfaa1bSZhang Wei instead of using asynchronous interrupts 8464d13cbadSwdenk 84716c8d5e7SWolfgang Denk- USB Device: 84816c8d5e7SWolfgang Denk Define the below if you wish to use the USB console. 84916c8d5e7SWolfgang Denk Once firmware is rebuilt from a serial console issue the 85016c8d5e7SWolfgang Denk command "setenv stdin usbtty; setenv stdout usbtty" and 85111ccc33fSMarcel Ziswiler attach your USB cable. The Unix command "dmesg" should print 85216c8d5e7SWolfgang Denk it has found a new device. The environment variable usbtty 85316c8d5e7SWolfgang Denk can be set to gserial or cdc_acm to enable your device to 85416c8d5e7SWolfgang Denk appear to a USB host as a Linux gserial device or a 85516c8d5e7SWolfgang Denk Common Device Class Abstract Control Model serial device. 85616c8d5e7SWolfgang Denk If you select usbtty = gserial you should be able to enumerate 85716c8d5e7SWolfgang Denk a Linux host by 85816c8d5e7SWolfgang Denk # modprobe usbserial vendor=0xVendorID product=0xProductID 85916c8d5e7SWolfgang Denk else if using cdc_acm, simply setting the environment 86016c8d5e7SWolfgang Denk variable usbtty to be cdc_acm should suffice. The following 86116c8d5e7SWolfgang Denk might be defined in YourBoardName.h 86216c8d5e7SWolfgang Denk 86316c8d5e7SWolfgang Denk CONFIG_USB_DEVICE 86416c8d5e7SWolfgang Denk Define this to build a UDC device 86516c8d5e7SWolfgang Denk 86616c8d5e7SWolfgang Denk CONFIG_USB_TTY 86716c8d5e7SWolfgang Denk Define this to have a tty type of device available to 86816c8d5e7SWolfgang Denk talk to the UDC device 86916c8d5e7SWolfgang Denk 8706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_CONSOLE_IS_IN_ENV 87116c8d5e7SWolfgang Denk Define this if you want stdin, stdout &/or stderr to 87216c8d5e7SWolfgang Denk be set to usbtty. 87316c8d5e7SWolfgang Denk 87416c8d5e7SWolfgang Denk mpc8xx: 8756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_USB_EXTC_CLK 0xBLAH 87616c8d5e7SWolfgang Denk Derive USB clock from external clock "blah" 8776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_USB_EXTC_CLK 0x02 87816c8d5e7SWolfgang Denk 8796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_USB_BRG_CLK 0xBLAH 88016c8d5e7SWolfgang Denk Derive USB clock from brgclk 8816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_USB_BRG_CLK 0x04 88216c8d5e7SWolfgang Denk 88316c8d5e7SWolfgang Denk If you have a USB-IF assigned VendorID then you may wish to 88416c8d5e7SWolfgang Denk define your own vendor specific values either in BoardName.h 88516c8d5e7SWolfgang Denk or directly in usbd_vendor_info.h. If you don't define 88616c8d5e7SWolfgang Denk CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME, 88716c8d5e7SWolfgang Denk CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot 88816c8d5e7SWolfgang Denk should pretend to be a Linux device to it's target host. 88916c8d5e7SWolfgang Denk 89016c8d5e7SWolfgang Denk CONFIG_USBD_MANUFACTURER 89116c8d5e7SWolfgang Denk Define this string as the name of your company for 89216c8d5e7SWolfgang Denk - CONFIG_USBD_MANUFACTURER "my company" 89316c8d5e7SWolfgang Denk 89416c8d5e7SWolfgang Denk CONFIG_USBD_PRODUCT_NAME 89516c8d5e7SWolfgang Denk Define this string as the name of your product 89616c8d5e7SWolfgang Denk - CONFIG_USBD_PRODUCT_NAME "acme usb device" 89716c8d5e7SWolfgang Denk 89816c8d5e7SWolfgang Denk CONFIG_USBD_VENDORID 89916c8d5e7SWolfgang Denk Define this as your assigned Vendor ID from the USB 90016c8d5e7SWolfgang Denk Implementors Forum. This *must* be a genuine Vendor ID 90116c8d5e7SWolfgang Denk to avoid polluting the USB namespace. 90216c8d5e7SWolfgang Denk - CONFIG_USBD_VENDORID 0xFFFF 90316c8d5e7SWolfgang Denk 90416c8d5e7SWolfgang Denk CONFIG_USBD_PRODUCTID 90516c8d5e7SWolfgang Denk Define this as the unique Product ID 90616c8d5e7SWolfgang Denk for your device 90716c8d5e7SWolfgang Denk - CONFIG_USBD_PRODUCTID 0xFFFF 908c609719bSwdenk 909c609719bSwdenk 910c609719bSwdenk- MMC Support: 911c609719bSwdenk The MMC controller on the Intel PXA is supported. To 912c609719bSwdenk enable this define CONFIG_MMC. The MMC can be 913c609719bSwdenk accessed from the boot prompt by mapping the device 914c609719bSwdenk to physical memory similar to flash. Command line is 915602ad3b3SJon Loeliger enabled with CONFIG_CMD_MMC. The MMC driver also works with 916602ad3b3SJon Loeliger the FAT fs. This is enabled with CONFIG_CMD_FAT. 917c609719bSwdenk 9186705d81eSwdenk- Journaling Flash filesystem support: 9196705d81eSwdenk CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE, 9206705d81eSwdenk CONFIG_JFFS2_NAND_DEV 9216705d81eSwdenk Define these for a default partition on a NAND device 9226705d81eSwdenk 9236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS2_FIRST_SECTOR, 9246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS 9256705d81eSwdenk Define these for a default partition on a NOR device 9266705d81eSwdenk 9276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS_CUSTOM_PART 9286705d81eSwdenk Define this to create an own partition. You have to provide a 9296705d81eSwdenk function struct part_info* jffs2_part_info(int part_num) 9306705d81eSwdenk 9316705d81eSwdenk If you define only one JFFS2 partition you may also want to 9326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_JFFS_SINGLE_PART 1 9336705d81eSwdenk to disable the command chpart. This is the default when you 9346705d81eSwdenk have not defined a custom partition 9356705d81eSwdenk 936c609719bSwdenk- Keyboard Support: 937c609719bSwdenk CONFIG_ISA_KEYBOARD 938c609719bSwdenk 939c609719bSwdenk Define this to enable standard (PC-Style) keyboard 940c609719bSwdenk support 941c609719bSwdenk 942c609719bSwdenk CONFIG_I8042_KBD 943c609719bSwdenk Standard PC keyboard driver with US (is default) and 944c609719bSwdenk GERMAN key layout (switch via environment 'keymap=de') support. 945c609719bSwdenk Export function i8042_kbd_init, i8042_tstc and i8042_getc 946c609719bSwdenk for cfb_console. Supports cursor blinking. 947c609719bSwdenk 948c609719bSwdenk- Video support: 949c609719bSwdenk CONFIG_VIDEO 950c609719bSwdenk 951c609719bSwdenk Define this to enable video support (for output to 952c609719bSwdenk video). 953c609719bSwdenk 954c609719bSwdenk CONFIG_VIDEO_CT69000 955c609719bSwdenk 956c609719bSwdenk Enable Chips & Technologies 69000 Video chip 957c609719bSwdenk 958c609719bSwdenk CONFIG_VIDEO_SMI_LYNXEM 959eeb1b77bSwdenk Enable Silicon Motion SMI 712/710/810 Video chip. The 960eeb1b77bSwdenk video output is selected via environment 'videoout' 961eeb1b77bSwdenk (1 = LCD and 2 = CRT). If videoout is undefined, CRT is 962eeb1b77bSwdenk assumed. 963c609719bSwdenk 964eeb1b77bSwdenk For the CT69000 and SMI_LYNXEM drivers, videomode is 96511ccc33fSMarcel Ziswiler selected via environment 'videomode'. Two different ways 966eeb1b77bSwdenk are possible: 967eeb1b77bSwdenk - "videomode=num" 'num' is a standard LiLo mode numbers. 968eeb1b77bSwdenk Following standard modes are supported (* is default): 969eeb1b77bSwdenk 970eeb1b77bSwdenk Colors 640x480 800x600 1024x768 1152x864 1280x1024 971eeb1b77bSwdenk -------------+--------------------------------------------- 972eeb1b77bSwdenk 8 bits | 0x301* 0x303 0x305 0x161 0x307 973eeb1b77bSwdenk 15 bits | 0x310 0x313 0x316 0x162 0x319 974eeb1b77bSwdenk 16 bits | 0x311 0x314 0x317 0x163 0x31A 975eeb1b77bSwdenk 24 bits | 0x312 0x315 0x318 ? 0x31B 976eeb1b77bSwdenk -------------+--------------------------------------------- 977c609719bSwdenk (i.e. setenv videomode 317; saveenv; reset;) 978c609719bSwdenk 979eeb1b77bSwdenk - "videomode=bootargs" all the video parameters are parsed 9807817cb20SMarcel Ziswiler from the bootargs. (See drivers/video/videomodes.c) 981eeb1b77bSwdenk 982eeb1b77bSwdenk 983a6c7ad2fSwdenk CONFIG_VIDEO_SED13806 984a6c7ad2fSwdenk Enable Epson SED13806 driver. This driver supports 8bpp 985a6c7ad2fSwdenk and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP 986a6c7ad2fSwdenk or CONFIG_VIDEO_SED13806_16BPP 987a6c7ad2fSwdenk 988682011ffSwdenk- Keyboard Support: 989682011ffSwdenk CONFIG_KEYBOARD 990682011ffSwdenk 991682011ffSwdenk Define this to enable a custom keyboard support. 992682011ffSwdenk This simply calls drv_keyboard_init() which must be 993682011ffSwdenk defined in your board-specific files. 994682011ffSwdenk The only board using this so far is RBC823. 995a6c7ad2fSwdenk 996c609719bSwdenk- LCD Support: CONFIG_LCD 997c609719bSwdenk 998c609719bSwdenk Define this to enable LCD support (for output to LCD 999c609719bSwdenk display); also select one of the supported displays 1000c609719bSwdenk by defining one of these: 1001c609719bSwdenk 100239cf4804SStelian Pop CONFIG_ATMEL_LCD: 100339cf4804SStelian Pop 100439cf4804SStelian Pop HITACHI TX09D70VM1CCA, 3.5", 240x320. 100539cf4804SStelian Pop 1006fd3103bbSwdenk CONFIG_NEC_NL6448AC33: 1007c609719bSwdenk 1008fd3103bbSwdenk NEC NL6448AC33-18. Active, color, single scan. 1009c609719bSwdenk 1010fd3103bbSwdenk CONFIG_NEC_NL6448BC20 1011c609719bSwdenk 1012fd3103bbSwdenk NEC NL6448BC20-08. 6.5", 640x480. 1013fd3103bbSwdenk Active, color, single scan. 1014fd3103bbSwdenk 1015fd3103bbSwdenk CONFIG_NEC_NL6448BC33_54 1016fd3103bbSwdenk 1017fd3103bbSwdenk NEC NL6448BC33-54. 10.4", 640x480. 1018c609719bSwdenk Active, color, single scan. 1019c609719bSwdenk 1020c609719bSwdenk CONFIG_SHARP_16x9 1021c609719bSwdenk 1022c609719bSwdenk Sharp 320x240. Active, color, single scan. 1023c609719bSwdenk It isn't 16x9, and I am not sure what it is. 1024c609719bSwdenk 1025c609719bSwdenk CONFIG_SHARP_LQ64D341 1026c609719bSwdenk 1027c609719bSwdenk Sharp LQ64D341 display, 640x480. 1028c609719bSwdenk Active, color, single scan. 1029c609719bSwdenk 1030c609719bSwdenk CONFIG_HLD1045 1031c609719bSwdenk 1032c609719bSwdenk HLD1045 display, 640x480. 1033c609719bSwdenk Active, color, single scan. 1034c609719bSwdenk 1035c609719bSwdenk CONFIG_OPTREX_BW 1036c609719bSwdenk 1037c609719bSwdenk Optrex CBL50840-2 NF-FW 99 22 M5 1038c609719bSwdenk or 1039c609719bSwdenk Hitachi LMG6912RPFC-00T 1040c609719bSwdenk or 1041c609719bSwdenk Hitachi SP14Q002 1042c609719bSwdenk 1043c609719bSwdenk 320x240. Black & white. 1044c609719bSwdenk 1045c609719bSwdenk Normally display is black on white background; define 10466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_WHITE_ON_BLACK to get it inverted. 1047c609719bSwdenk 10487152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN 1049d791b1dcSwdenk 1050d791b1dcSwdenk If this option is set, the environment is checked for 1051d791b1dcSwdenk a variable "splashimage". If found, the usual display 1052d791b1dcSwdenk of logo, copyright and system information on the LCD 1053e94d2cd9Swdenk is suppressed and the BMP image at the address 1054d791b1dcSwdenk specified in "splashimage" is loaded instead. The 1055d791b1dcSwdenk console is redirected to the "nulldev", too. This 1056d791b1dcSwdenk allows for a "silent" boot where a splash screen is 1057d791b1dcSwdenk loaded very quickly after power-on. 1058d791b1dcSwdenk 105998f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP 106098f4a3dfSStefan Roese 106198f4a3dfSStefan Roese If this option is set, additionally to standard BMP 106298f4a3dfSStefan Roese images, gzipped BMP images can be displayed via the 106398f4a3dfSStefan Roese splashscreen support or the bmp command. 106498f4a3dfSStefan Roese 1065c29fdfc1Swdenk- Compression support: 1066c29fdfc1Swdenk CONFIG_BZIP2 1067c29fdfc1Swdenk 1068c29fdfc1Swdenk If this option is set, support for bzip2 compressed 1069c29fdfc1Swdenk images is included. If not, only uncompressed and gzip 1070c29fdfc1Swdenk compressed images are supported. 1071c29fdfc1Swdenk 1072c29fdfc1Swdenk NOTE: the bzip2 algorithm requires a lot of RAM, so 10736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should 1074c29fdfc1Swdenk be at least 4MB. 1075d791b1dcSwdenk 1076fc9c1727SLuigi 'Comio' Mantellini CONFIG_LZMA 1077fc9c1727SLuigi 'Comio' Mantellini 1078fc9c1727SLuigi 'Comio' Mantellini If this option is set, support for lzma compressed 1079fc9c1727SLuigi 'Comio' Mantellini images is included. 1080fc9c1727SLuigi 'Comio' Mantellini 1081fc9c1727SLuigi 'Comio' Mantellini Note: The LZMA algorithm adds between 2 and 4KB of code and it 1082fc9c1727SLuigi 'Comio' Mantellini requires an amount of dynamic memory that is given by the 1083fc9c1727SLuigi 'Comio' Mantellini formula: 1084fc9c1727SLuigi 'Comio' Mantellini 1085fc9c1727SLuigi 'Comio' Mantellini (1846 + 768 << (lc + lp)) * sizeof(uint16) 1086fc9c1727SLuigi 'Comio' Mantellini 1087fc9c1727SLuigi 'Comio' Mantellini Where lc and lp stand for, respectively, Literal context bits 1088fc9c1727SLuigi 'Comio' Mantellini and Literal pos bits. 1089fc9c1727SLuigi 'Comio' Mantellini 1090fc9c1727SLuigi 'Comio' Mantellini This value is upper-bounded by 14MB in the worst case. Anyway, 1091fc9c1727SLuigi 'Comio' Mantellini for a ~4MB large kernel image, we have lc=3 and lp=0 for a 1092fc9c1727SLuigi 'Comio' Mantellini total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is 1093fc9c1727SLuigi 'Comio' Mantellini a very small buffer. 1094fc9c1727SLuigi 'Comio' Mantellini 1095fc9c1727SLuigi 'Comio' Mantellini Use the lzmainfo tool to determinate the lc and lp values and 1096fc9c1727SLuigi 'Comio' Mantellini then calculate the amount of needed dynamic memory (ensuring 10976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD the appropriate CONFIG_SYS_MALLOC_LEN value). 1098fc9c1727SLuigi 'Comio' Mantellini 109917ea1177Swdenk- MII/PHY support: 110017ea1177Swdenk CONFIG_PHY_ADDR 110117ea1177Swdenk 110217ea1177Swdenk The address of PHY on MII bus. 110317ea1177Swdenk 110417ea1177Swdenk CONFIG_PHY_CLOCK_FREQ (ppc4xx) 110517ea1177Swdenk 110617ea1177Swdenk The clock frequency of the MII bus 110717ea1177Swdenk 110817ea1177Swdenk CONFIG_PHY_GIGE 110917ea1177Swdenk 111017ea1177Swdenk If this option is set, support for speed/duplex 111111ccc33fSMarcel Ziswiler detection of gigabit PHY is included. 111217ea1177Swdenk 111317ea1177Swdenk CONFIG_PHY_RESET_DELAY 111417ea1177Swdenk 111517ea1177Swdenk Some PHY like Intel LXT971A need extra delay after 111617ea1177Swdenk reset before any MII register access is possible. 111717ea1177Swdenk For such PHY, set this option to the usec delay 111817ea1177Swdenk required. (minimum 300usec for LXT971A) 111917ea1177Swdenk 112017ea1177Swdenk CONFIG_PHY_CMD_DELAY (ppc4xx) 112117ea1177Swdenk 112217ea1177Swdenk Some PHY like Intel LXT971A need extra delay after 112317ea1177Swdenk command issued before MII status register can be read 112417ea1177Swdenk 1125c609719bSwdenk- Ethernet address: 1126c609719bSwdenk CONFIG_ETHADDR 1127c68a05feSrichardretanubun CONFIG_ETH1ADDR 1128c609719bSwdenk CONFIG_ETH2ADDR 1129c609719bSwdenk CONFIG_ETH3ADDR 1130c68a05feSrichardretanubun CONFIG_ETH4ADDR 1131c68a05feSrichardretanubun CONFIG_ETH5ADDR 1132c609719bSwdenk 113311ccc33fSMarcel Ziswiler Define a default value for Ethernet address to use 113411ccc33fSMarcel Ziswiler for the respective Ethernet interface, in case this 1135c609719bSwdenk is not determined automatically. 1136c609719bSwdenk 1137c609719bSwdenk- IP address: 1138c609719bSwdenk CONFIG_IPADDR 1139c609719bSwdenk 1140c609719bSwdenk Define a default value for the IP address to use for 114111ccc33fSMarcel Ziswiler the default Ethernet interface, in case this is not 1142c609719bSwdenk determined through e.g. bootp. 1143c609719bSwdenk 1144c609719bSwdenk- Server IP address: 1145c609719bSwdenk CONFIG_SERVERIP 1146c609719bSwdenk 1147c609719bSwdenk Defines a default value for the IP address of a TFTP 1148c609719bSwdenk server to contact when using the "tftboot" command. 1149c609719bSwdenk 115053a5c424SDavid Updegraff- Multicast TFTP Mode: 115153a5c424SDavid Updegraff CONFIG_MCAST_TFTP 115253a5c424SDavid Updegraff 115353a5c424SDavid Updegraff Defines whether you want to support multicast TFTP as per 115453a5c424SDavid Updegraff rfc-2090; for example to work with atftp. Lets lots of targets 115511ccc33fSMarcel Ziswiler tftp down the same boot image concurrently. Note: the Ethernet 115653a5c424SDavid Updegraff driver in use must provide a function: mcast() to join/leave a 115753a5c424SDavid Updegraff multicast group. 115853a5c424SDavid Updegraff 115953a5c424SDavid Updegraff CONFIG_BOOTP_RANDOM_DELAY 1160c609719bSwdenk- BOOTP Recovery Mode: 1161c609719bSwdenk CONFIG_BOOTP_RANDOM_DELAY 1162c609719bSwdenk 1163c609719bSwdenk If you have many targets in a network that try to 1164c609719bSwdenk boot using BOOTP, you may want to avoid that all 1165c609719bSwdenk systems send out BOOTP requests at precisely the same 1166c609719bSwdenk moment (which would happen for instance at recovery 1167c609719bSwdenk from a power failure, when all systems will try to 1168c609719bSwdenk boot, thus flooding the BOOTP server. Defining 1169c609719bSwdenk CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be 1170c609719bSwdenk inserted before sending out BOOTP requests. The 11716c33c785SWolfgang Denk following delays are inserted then: 1172c609719bSwdenk 1173c609719bSwdenk 1st BOOTP request: delay 0 ... 1 sec 1174c609719bSwdenk 2nd BOOTP request: delay 0 ... 2 sec 1175c609719bSwdenk 3rd BOOTP request: delay 0 ... 4 sec 1176c609719bSwdenk 4th and following 1177c609719bSwdenk BOOTP requests: delay 0 ... 8 sec 1178c609719bSwdenk 1179fe389a82Sstroese- DHCP Advanced Options: 11801fe80d79SJon Loeliger You can fine tune the DHCP functionality by defining 11811fe80d79SJon Loeliger CONFIG_BOOTP_* symbols: 1182fe389a82Sstroese 11831fe80d79SJon Loeliger CONFIG_BOOTP_SUBNETMASK 11841fe80d79SJon Loeliger CONFIG_BOOTP_GATEWAY 11851fe80d79SJon Loeliger CONFIG_BOOTP_HOSTNAME 11861fe80d79SJon Loeliger CONFIG_BOOTP_NISDOMAIN 11871fe80d79SJon Loeliger CONFIG_BOOTP_BOOTPATH 11881fe80d79SJon Loeliger CONFIG_BOOTP_BOOTFILESIZE 11891fe80d79SJon Loeliger CONFIG_BOOTP_DNS 11901fe80d79SJon Loeliger CONFIG_BOOTP_DNS2 11911fe80d79SJon Loeliger CONFIG_BOOTP_SEND_HOSTNAME 11921fe80d79SJon Loeliger CONFIG_BOOTP_NTPSERVER 11931fe80d79SJon Loeliger CONFIG_BOOTP_TIMEOFFSET 11941fe80d79SJon Loeliger CONFIG_BOOTP_VENDOREX 1195fe389a82Sstroese 11965d110f0aSWilson Callan CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip 11975d110f0aSWilson Callan environment variable, not the BOOTP server. 1198fe389a82Sstroese 1199fe389a82Sstroese CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS 1200fe389a82Sstroese serverip from a DHCP server, it is possible that more 1201fe389a82Sstroese than one DNS serverip is offered to the client. 1202fe389a82Sstroese If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS 1203fe389a82Sstroese serverip will be stored in the additional environment 1204fe389a82Sstroese variable "dnsip2". The first DNS serverip is always 1205fe389a82Sstroese stored in the variable "dnsip", when CONFIG_BOOTP_DNS 12061fe80d79SJon Loeliger is defined. 1207fe389a82Sstroese 1208fe389a82Sstroese CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable 1209fe389a82Sstroese to do a dynamic update of a DNS server. To do this, they 1210fe389a82Sstroese need the hostname of the DHCP requester. 12115d110f0aSWilson Callan If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content 12121fe80d79SJon Loeliger of the "hostname" environment variable is passed as 12131fe80d79SJon Loeliger option 12 to the DHCP server. 1214fe389a82Sstroese 1215d9a2f416SAras Vaichas CONFIG_BOOTP_DHCP_REQUEST_DELAY 1216d9a2f416SAras Vaichas 1217d9a2f416SAras Vaichas A 32bit value in microseconds for a delay between 1218d9a2f416SAras Vaichas receiving a "DHCP Offer" and sending the "DHCP Request". 1219d9a2f416SAras Vaichas This fixes a problem with certain DHCP servers that don't 1220d9a2f416SAras Vaichas respond 100% of the time to a "DHCP request". E.g. On an 1221d9a2f416SAras Vaichas AT91RM9200 processor running at 180MHz, this delay needed 1222d9a2f416SAras Vaichas to be *at least* 15,000 usec before a Windows Server 2003 1223d9a2f416SAras Vaichas DHCP server would reply 100% of the time. I recommend at 1224d9a2f416SAras Vaichas least 50,000 usec to be safe. The alternative is to hope 1225d9a2f416SAras Vaichas that one of the retries will be successful but note that 1226d9a2f416SAras Vaichas the DHCP timeout and retry process takes a longer than 1227d9a2f416SAras Vaichas this delay. 1228d9a2f416SAras Vaichas 1229a3d991bdSwdenk - CDP Options: 1230a3d991bdSwdenk CONFIG_CDP_DEVICE_ID 1231a3d991bdSwdenk 1232a3d991bdSwdenk The device id used in CDP trigger frames. 1233a3d991bdSwdenk 1234a3d991bdSwdenk CONFIG_CDP_DEVICE_ID_PREFIX 1235a3d991bdSwdenk 1236a3d991bdSwdenk A two character string which is prefixed to the MAC address 1237a3d991bdSwdenk of the device. 1238a3d991bdSwdenk 1239a3d991bdSwdenk CONFIG_CDP_PORT_ID 1240a3d991bdSwdenk 1241a3d991bdSwdenk A printf format string which contains the ascii name of 1242a3d991bdSwdenk the port. Normally is set to "eth%d" which sets 124311ccc33fSMarcel Ziswiler eth0 for the first Ethernet, eth1 for the second etc. 1244a3d991bdSwdenk 1245a3d991bdSwdenk CONFIG_CDP_CAPABILITIES 1246a3d991bdSwdenk 1247a3d991bdSwdenk A 32bit integer which indicates the device capabilities; 1248a3d991bdSwdenk 0x00000010 for a normal host which does not forwards. 1249a3d991bdSwdenk 1250a3d991bdSwdenk CONFIG_CDP_VERSION 1251a3d991bdSwdenk 1252a3d991bdSwdenk An ascii string containing the version of the software. 1253a3d991bdSwdenk 1254a3d991bdSwdenk CONFIG_CDP_PLATFORM 1255a3d991bdSwdenk 1256a3d991bdSwdenk An ascii string containing the name of the platform. 1257a3d991bdSwdenk 1258a3d991bdSwdenk CONFIG_CDP_TRIGGER 1259a3d991bdSwdenk 1260a3d991bdSwdenk A 32bit integer sent on the trigger. 1261a3d991bdSwdenk 1262a3d991bdSwdenk CONFIG_CDP_POWER_CONSUMPTION 1263a3d991bdSwdenk 1264a3d991bdSwdenk A 16bit integer containing the power consumption of the 1265a3d991bdSwdenk device in .1 of milliwatts. 1266a3d991bdSwdenk 1267a3d991bdSwdenk CONFIG_CDP_APPLIANCE_VLAN_TYPE 1268a3d991bdSwdenk 1269a3d991bdSwdenk A byte containing the id of the VLAN. 1270a3d991bdSwdenk 1271c609719bSwdenk- Status LED: CONFIG_STATUS_LED 1272c609719bSwdenk 1273c609719bSwdenk Several configurations allow to display the current 1274c609719bSwdenk status using a LED. For instance, the LED will blink 1275c609719bSwdenk fast while running U-Boot code, stop blinking as 1276c609719bSwdenk soon as a reply to a BOOTP request was received, and 1277c609719bSwdenk start blinking slow once the Linux kernel is running 1278c609719bSwdenk (supported by a status LED driver in the Linux 1279c609719bSwdenk kernel). Defining CONFIG_STATUS_LED enables this 1280c609719bSwdenk feature in U-Boot. 1281c609719bSwdenk 1282c609719bSwdenk- CAN Support: CONFIG_CAN_DRIVER 1283c609719bSwdenk 1284c609719bSwdenk Defining CONFIG_CAN_DRIVER enables CAN driver support 1285c609719bSwdenk on those systems that support this (optional) 1286c609719bSwdenk feature, like the TQM8xxL modules. 1287c609719bSwdenk 1288c609719bSwdenk- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C 1289c609719bSwdenk 1290b37c7e5eSwdenk These enable I2C serial bus commands. Defining either of 1291b37c7e5eSwdenk (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will 129211ccc33fSMarcel Ziswiler include the appropriate I2C driver for the selected CPU. 1293c609719bSwdenk 1294b37c7e5eSwdenk This will allow you to use i2c commands at the u-boot 1295602ad3b3SJon Loeliger command line (as long as you set CONFIG_CMD_I2C in 1296b37c7e5eSwdenk CONFIG_COMMANDS) and communicate with i2c based realtime 1297b37c7e5eSwdenk clock chips. See common/cmd_i2c.c for a description of the 1298c609719bSwdenk command line interface. 1299c609719bSwdenk 1300bb99ad6dSBen Warren CONFIG_I2C_CMD_TREE is a recommended option that places 1301bb99ad6dSBen Warren all I2C commands under a single 'i2c' root command. The 1302bb99ad6dSBen Warren older 'imm', 'imd', 'iprobe' etc. commands are considered 1303bb99ad6dSBen Warren deprecated and may disappear in the future. 1304bb99ad6dSBen Warren 1305bb99ad6dSBen Warren CONFIG_HARD_I2C selects a hardware I2C controller. 1306c609719bSwdenk 1307b37c7e5eSwdenk CONFIG_SOFT_I2C configures u-boot to use a software (aka 1308b37c7e5eSwdenk bit-banging) driver instead of CPM or similar hardware 1309b37c7e5eSwdenk support for I2C. 1310c609719bSwdenk 1311b37c7e5eSwdenk There are several other quantities that must also be 1312b37c7e5eSwdenk defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C. 1313c609719bSwdenk 13146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD In both cases you will need to define CONFIG_SYS_I2C_SPEED 1315b37c7e5eSwdenk to be the frequency (in Hz) at which you wish your i2c bus 13166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie 131711ccc33fSMarcel Ziswiler the CPU's i2c node address). 1318c609719bSwdenk 1319b37c7e5eSwdenk Now, the u-boot i2c code for the mpc8xx (cpu/mpc8xx/i2c.c) 132011ccc33fSMarcel Ziswiler sets the CPU up as a master node and so its address should 1321b37c7e5eSwdenk therefore be cleared to 0 (See, eg, MPC823e User's Manual 13226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD p.16-473). So, set CONFIG_SYS_I2C_SLAVE to 0. 1323b37c7e5eSwdenk 1324b37c7e5eSwdenk That's all that's required for CONFIG_HARD_I2C. 1325b37c7e5eSwdenk 1326b37c7e5eSwdenk If you use the software i2c interface (CONFIG_SOFT_I2C) 1327b37c7e5eSwdenk then the following macros need to be defined (examples are 1328b37c7e5eSwdenk from include/configs/lwmon.h): 1329c609719bSwdenk 1330c609719bSwdenk I2C_INIT 1331c609719bSwdenk 1332b37c7e5eSwdenk (Optional). Any commands necessary to enable the I2C 1333c609719bSwdenk controller or configure ports. 1334c609719bSwdenk 1335b37c7e5eSwdenk eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL) 1336b37c7e5eSwdenk 1337c609719bSwdenk I2C_PORT 1338c609719bSwdenk 1339c609719bSwdenk (Only for MPC8260 CPU). The I/O port to use (the code 1340c609719bSwdenk assumes both bits are on the same port). Valid values 1341c609719bSwdenk are 0..3 for ports A..D. 1342c609719bSwdenk 1343c609719bSwdenk I2C_ACTIVE 1344c609719bSwdenk 1345c609719bSwdenk The code necessary to make the I2C data line active 1346c609719bSwdenk (driven). If the data line is open collector, this 1347c609719bSwdenk define can be null. 1348c609719bSwdenk 1349b37c7e5eSwdenk eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA) 1350b37c7e5eSwdenk 1351c609719bSwdenk I2C_TRISTATE 1352c609719bSwdenk 1353c609719bSwdenk The code necessary to make the I2C data line tri-stated 1354c609719bSwdenk (inactive). If the data line is open collector, this 1355c609719bSwdenk define can be null. 1356c609719bSwdenk 1357b37c7e5eSwdenk eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA) 1358b37c7e5eSwdenk 1359c609719bSwdenk I2C_READ 1360c609719bSwdenk 1361c609719bSwdenk Code that returns TRUE if the I2C data line is high, 1362c609719bSwdenk FALSE if it is low. 1363c609719bSwdenk 1364b37c7e5eSwdenk eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0) 1365b37c7e5eSwdenk 1366c609719bSwdenk I2C_SDA(bit) 1367c609719bSwdenk 1368c609719bSwdenk If <bit> is TRUE, sets the I2C data line high. If it 1369c609719bSwdenk is FALSE, it clears it (low). 1370c609719bSwdenk 1371b37c7e5eSwdenk eg: #define I2C_SDA(bit) \ 1372b37c7e5eSwdenk if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \ 1373b37c7e5eSwdenk else immr->im_cpm.cp_pbdat &= ~PB_SDA 1374b37c7e5eSwdenk 1375c609719bSwdenk I2C_SCL(bit) 1376c609719bSwdenk 1377c609719bSwdenk If <bit> is TRUE, sets the I2C clock line high. If it 1378c609719bSwdenk is FALSE, it clears it (low). 1379c609719bSwdenk 1380b37c7e5eSwdenk eg: #define I2C_SCL(bit) \ 1381b37c7e5eSwdenk if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \ 1382b37c7e5eSwdenk else immr->im_cpm.cp_pbdat &= ~PB_SCL 1383b37c7e5eSwdenk 1384c609719bSwdenk I2C_DELAY 1385c609719bSwdenk 1386c609719bSwdenk This delay is invoked four times per clock cycle so this 1387c609719bSwdenk controls the rate of data transfer. The data rate thus 1388b37c7e5eSwdenk is 1 / (I2C_DELAY * 4). Often defined to be something 1389b37c7e5eSwdenk like: 1390b37c7e5eSwdenk 1391b37c7e5eSwdenk #define I2C_DELAY udelay(2) 1392c609719bSwdenk 13936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_INIT_BOARD 139447cd00faSwdenk 139547cd00faSwdenk When a board is reset during an i2c bus transfer 139647cd00faSwdenk chips might think that the current transfer is still 139747cd00faSwdenk in progress. On some boards it is possible to access 139847cd00faSwdenk the i2c SCLK line directly, either by using the 139947cd00faSwdenk processor pin as a GPIO or by having a second pin 140047cd00faSwdenk connected to the bus. If this option is defined a 140147cd00faSwdenk custom i2c_init_board() routine in boards/xxx/board.c 140247cd00faSwdenk is run early in the boot sequence. 140347cd00faSwdenk 140417ea1177Swdenk CONFIG_I2CFAST (PPC405GP|PPC405EP only) 140517ea1177Swdenk 140617ea1177Swdenk This option enables configuration of bi_iic_fast[] flags 140717ea1177Swdenk in u-boot bd_info structure based on u-boot environment 140817ea1177Swdenk variable "i2cfast". (see also i2cfast) 140917ea1177Swdenk 1410bb99ad6dSBen Warren CONFIG_I2C_MULTI_BUS 1411bb99ad6dSBen Warren 1412bb99ad6dSBen Warren This option allows the use of multiple I2C buses, each of which 1413bb99ad6dSBen Warren must have a controller. At any point in time, only one bus is 1414bb99ad6dSBen Warren active. To switch to a different bus, use the 'i2c dev' command. 1415bb99ad6dSBen Warren Note that bus numbering is zero-based. 1416bb99ad6dSBen Warren 14176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_NOPROBES 1418bb99ad6dSBen Warren 1419bb99ad6dSBen Warren This option specifies a list of I2C devices that will be skipped 1420bb99ad6dSBen Warren when the 'i2c probe' command is issued (or 'iprobe' using the legacy 1421bb99ad6dSBen Warren command). If CONFIG_I2C_MULTI_BUS is set, specify a list of bus-device 1422bb99ad6dSBen Warren pairs. Otherwise, specify a 1D array of device addresses 1423bb99ad6dSBen Warren 1424bb99ad6dSBen Warren e.g. 1425bb99ad6dSBen Warren #undef CONFIG_I2C_MULTI_BUS 14266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68} 1427bb99ad6dSBen Warren 1428bb99ad6dSBen Warren will skip addresses 0x50 and 0x68 on a board with one I2C bus 1429bb99ad6dSBen Warren 1430bb99ad6dSBen Warren #define CONFIG_I2C_MULTI_BUS 14316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}} 1432bb99ad6dSBen Warren 1433bb99ad6dSBen Warren will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1 1434bb99ad6dSBen Warren 14356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SPD_BUS_NUM 1436be5e6181STimur Tabi 1437be5e6181STimur Tabi If defined, then this indicates the I2C bus number for DDR SPD. 1438be5e6181STimur Tabi If not defined, then U-Boot assumes that SPD is on I2C bus 0. 1439be5e6181STimur Tabi 14406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_RTC_BUS_NUM 14410dc018ecSStefan Roese 14420dc018ecSStefan Roese If defined, then this indicates the I2C bus number for the RTC. 14430dc018ecSStefan Roese If not defined, then U-Boot assumes that RTC is on I2C bus 0. 14440dc018ecSStefan Roese 14456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_DTT_BUS_NUM 14460dc018ecSStefan Roese 14470dc018ecSStefan Roese If defined, then this indicates the I2C bus number for the DTT. 14480dc018ecSStefan Roese If not defined, then U-Boot assumes that DTT is on I2C bus 0. 14490dc018ecSStefan Roese 14506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_DTT_ADDR: 14519ebbb54fSVictor Gallardo 14529ebbb54fSVictor Gallardo If defined, specifies the I2C address of the DTT device. 14539ebbb54fSVictor Gallardo If not defined, then U-Boot uses predefined value for 14549ebbb54fSVictor Gallardo specified DTT device. 14559ebbb54fSVictor Gallardo 1456be5e6181STimur Tabi CONFIG_FSL_I2C 1457be5e6181STimur Tabi 1458be5e6181STimur Tabi Define this option if you want to use Freescale's I2C driver in 14597817cb20SMarcel Ziswiler drivers/i2c/fsl_i2c.c. 1460be5e6181STimur Tabi 146167b23a32SHeiko Schocher CONFIG_I2C_MUX 146267b23a32SHeiko Schocher 146367b23a32SHeiko Schocher Define this option if you have I2C devices reached over 1 .. n 146467b23a32SHeiko Schocher I2C Muxes like the pca9544a. This option addes a new I2C 146567b23a32SHeiko Schocher Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a 146667b23a32SHeiko Schocher new I2C Bus to the existing I2C Busses. If you select the 146767b23a32SHeiko Schocher new Bus with "i2c dev", u-bbot sends first the commandos for 146867b23a32SHeiko Schocher the muxes to activate this new "bus". 146967b23a32SHeiko Schocher 147067b23a32SHeiko Schocher CONFIG_I2C_MULTI_BUS must be also defined, to use this 147167b23a32SHeiko Schocher feature! 147267b23a32SHeiko Schocher 147367b23a32SHeiko Schocher Example: 147467b23a32SHeiko Schocher Adding a new I2C Bus reached over 2 pca9544a muxes 147567b23a32SHeiko Schocher The First mux with address 70 and channel 6 147667b23a32SHeiko Schocher The Second mux with address 71 and channel 4 147767b23a32SHeiko Schocher 147867b23a32SHeiko Schocher => i2c bus pca9544a:70:6:pca9544a:71:4 147967b23a32SHeiko Schocher 148067b23a32SHeiko Schocher Use the "i2c bus" command without parameter, to get a list 148167b23a32SHeiko Schocher of I2C Busses with muxes: 148267b23a32SHeiko Schocher 148367b23a32SHeiko Schocher => i2c bus 148467b23a32SHeiko Schocher Busses reached over muxes: 148567b23a32SHeiko Schocher Bus ID: 2 148667b23a32SHeiko Schocher reached over Mux(es): 148767b23a32SHeiko Schocher pca9544a@70 ch: 4 148867b23a32SHeiko Schocher Bus ID: 3 148967b23a32SHeiko Schocher reached over Mux(es): 149067b23a32SHeiko Schocher pca9544a@70 ch: 6 149167b23a32SHeiko Schocher pca9544a@71 ch: 4 149267b23a32SHeiko Schocher => 149367b23a32SHeiko Schocher 149467b23a32SHeiko Schocher If you now switch to the new I2C Bus 3 with "i2c dev 3" 149567b23a32SHeiko Schocher u-boot sends First the Commando to the mux@70 to enable 149667b23a32SHeiko Schocher channel 6, and then the Commando to the mux@71 to enable 149767b23a32SHeiko Schocher the channel 4. 149867b23a32SHeiko Schocher 149967b23a32SHeiko Schocher After that, you can use the "normal" i2c commands as 150067b23a32SHeiko Schocher usual, to communicate with your I2C devices behind 150167b23a32SHeiko Schocher the 2 muxes. 150267b23a32SHeiko Schocher 150367b23a32SHeiko Schocher This option is actually implemented for the bitbanging 150467b23a32SHeiko Schocher algorithm in common/soft_i2c.c and for the Hardware I2C 150567b23a32SHeiko Schocher Bus on the MPC8260. But it should be not so difficult 150667b23a32SHeiko Schocher to add this option to other architectures. 150767b23a32SHeiko Schocher 1508be5e6181STimur Tabi 1509c609719bSwdenk- SPI Support: CONFIG_SPI 1510c609719bSwdenk 1511c609719bSwdenk Enables SPI driver (so far only tested with 1512c609719bSwdenk SPI EEPROM, also an instance works with Crystal A/D and 1513c609719bSwdenk D/As on the SACSng board) 1514c609719bSwdenk 1515c609719bSwdenk CONFIG_SPI_X 1516c609719bSwdenk 1517c609719bSwdenk Enables extended (16-bit) SPI EEPROM addressing. 1518c609719bSwdenk (symmetrical to CONFIG_I2C_X) 1519c609719bSwdenk 1520c609719bSwdenk CONFIG_SOFT_SPI 1521c609719bSwdenk 1522c609719bSwdenk Enables a software (bit-bang) SPI driver rather than 1523c609719bSwdenk using hardware support. This is a general purpose 1524c609719bSwdenk driver that only requires three general I/O port pins 1525c609719bSwdenk (two outputs, one input) to function. If this is 1526c609719bSwdenk defined, the board configuration must define several 1527c609719bSwdenk SPI configuration items (port pins to use, etc). For 1528c609719bSwdenk an example, see include/configs/sacsng.h. 1529c609719bSwdenk 153004a9e118SBen Warren CONFIG_HARD_SPI 153104a9e118SBen Warren 153204a9e118SBen Warren Enables a hardware SPI driver for general-purpose reads 153304a9e118SBen Warren and writes. As with CONFIG_SOFT_SPI, the board configuration 153404a9e118SBen Warren must define a list of chip-select function pointers. 153504a9e118SBen Warren Currently supported on some MPC8xxx processors. For an 153604a9e118SBen Warren example, see include/configs/mpc8349emds.h. 153704a9e118SBen Warren 153838254f45SGuennadi Liakhovetski CONFIG_MXC_SPI 153938254f45SGuennadi Liakhovetski 154038254f45SGuennadi Liakhovetski Enables the driver for the SPI controllers on i.MX and MXC 154138254f45SGuennadi Liakhovetski SoCs. Currently only i.MX31 is supported. 154238254f45SGuennadi Liakhovetski 15430133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA 15440133502eSMatthias Fuchs 15450133502eSMatthias Fuchs Enables FPGA subsystem. 15460133502eSMatthias Fuchs 15470133502eSMatthias Fuchs CONFIG_FPGA_<vendor> 15480133502eSMatthias Fuchs 15490133502eSMatthias Fuchs Enables support for specific chip vendors. 15500133502eSMatthias Fuchs (ALTERA, XILINX) 15510133502eSMatthias Fuchs 15520133502eSMatthias Fuchs CONFIG_FPGA_<family> 15530133502eSMatthias Fuchs 15540133502eSMatthias Fuchs Enables support for FPGA family. 15550133502eSMatthias Fuchs (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX) 15560133502eSMatthias Fuchs 15570133502eSMatthias Fuchs CONFIG_FPGA_COUNT 1558c609719bSwdenk 1559c609719bSwdenk Specify the number of FPGA devices to support. 1560c609719bSwdenk 15616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_PROG_FEEDBACK 1562c609719bSwdenk 1563c609719bSwdenk Enable printing of hash marks during FPGA configuration. 1564c609719bSwdenk 15656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_BUSY 1566c609719bSwdenk 1567c609719bSwdenk Enable checks on FPGA configuration interface busy 1568c609719bSwdenk status by the configuration function. This option 1569c609719bSwdenk will require a board or device specific function to 1570c609719bSwdenk be written. 1571c609719bSwdenk 1572c609719bSwdenk CONFIG_FPGA_DELAY 1573c609719bSwdenk 1574c609719bSwdenk If defined, a function that provides delays in the FPGA 1575c609719bSwdenk configuration driver. 1576c609719bSwdenk 15776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_CTRLC 1578c609719bSwdenk Allow Control-C to interrupt FPGA configuration 1579c609719bSwdenk 15806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_ERROR 1581c609719bSwdenk 1582c609719bSwdenk Check for configuration errors during FPGA bitfile 1583c609719bSwdenk loading. For example, abort during Virtex II 1584c609719bSwdenk configuration if the INIT_B line goes low (which 1585c609719bSwdenk indicated a CRC error). 1586c609719bSwdenk 15876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_INIT 1588c609719bSwdenk 1589c609719bSwdenk Maximum time to wait for the INIT_B line to deassert 1590c609719bSwdenk after PROB_B has been deasserted during a Virtex II 1591c609719bSwdenk FPGA configuration sequence. The default time is 500 159211ccc33fSMarcel Ziswiler ms. 1593c609719bSwdenk 15946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_BUSY 1595c609719bSwdenk 1596c609719bSwdenk Maximum time to wait for BUSY to deassert during 159711ccc33fSMarcel Ziswiler Virtex II FPGA configuration. The default is 5 ms. 1598c609719bSwdenk 15996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_CONFIG 1600c609719bSwdenk 1601c609719bSwdenk Time to wait after FPGA configuration. The default is 160211ccc33fSMarcel Ziswiler 200 ms. 1603c609719bSwdenk 1604c609719bSwdenk- Configuration Management: 1605c609719bSwdenk CONFIG_IDENT_STRING 1606c609719bSwdenk 1607c609719bSwdenk If defined, this string will be added to the U-Boot 1608c609719bSwdenk version information (U_BOOT_VERSION) 1609c609719bSwdenk 1610c609719bSwdenk- Vendor Parameter Protection: 1611c609719bSwdenk 1612c609719bSwdenk U-Boot considers the values of the environment 1613c609719bSwdenk variables "serial#" (Board Serial Number) and 16147152b1d0Swdenk "ethaddr" (Ethernet Address) to be parameters that 1615c609719bSwdenk are set once by the board vendor / manufacturer, and 1616c609719bSwdenk protects these variables from casual modification by 1617c609719bSwdenk the user. Once set, these variables are read-only, 1618c609719bSwdenk and write or delete attempts are rejected. You can 161911ccc33fSMarcel Ziswiler change this behaviour: 1620c609719bSwdenk 1621c609719bSwdenk If CONFIG_ENV_OVERWRITE is #defined in your config 1622c609719bSwdenk file, the write protection for vendor parameters is 162347cd00faSwdenk completely disabled. Anybody can change or delete 1624c609719bSwdenk these parameters. 1625c609719bSwdenk 1626c609719bSwdenk Alternatively, if you #define _both_ CONFIG_ETHADDR 1627c609719bSwdenk _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default 162811ccc33fSMarcel Ziswiler Ethernet address is installed in the environment, 1629c609719bSwdenk which can be changed exactly ONCE by the user. [The 1630c609719bSwdenk serial# is unaffected by this, i. e. it remains 1631c609719bSwdenk read-only.] 1632c609719bSwdenk 1633c609719bSwdenk- Protected RAM: 1634c609719bSwdenk CONFIG_PRAM 1635c609719bSwdenk 1636c609719bSwdenk Define this variable to enable the reservation of 1637c609719bSwdenk "protected RAM", i. e. RAM which is not overwritten 1638c609719bSwdenk by U-Boot. Define CONFIG_PRAM to hold the number of 1639c609719bSwdenk kB you want to reserve for pRAM. You can overwrite 1640c609719bSwdenk this default value by defining an environment 1641c609719bSwdenk variable "pram" to the number of kB you want to 1642c609719bSwdenk reserve. Note that the board info structure will 1643c609719bSwdenk still show the full amount of RAM. If pRAM is 1644c609719bSwdenk reserved, a new environment variable "mem" will 1645c609719bSwdenk automatically be defined to hold the amount of 1646c609719bSwdenk remaining RAM in a form that can be passed as boot 1647c609719bSwdenk argument to Linux, for instance like that: 1648c609719bSwdenk 1649fe126d8bSWolfgang Denk setenv bootargs ... mem=\${mem} 1650c609719bSwdenk saveenv 1651c609719bSwdenk 1652c609719bSwdenk This way you can tell Linux not to use this memory, 1653c609719bSwdenk either, which results in a memory region that will 1654c609719bSwdenk not be affected by reboots. 1655c609719bSwdenk 1656c609719bSwdenk *WARNING* If your board configuration uses automatic 1657c609719bSwdenk detection of the RAM size, you must make sure that 1658c609719bSwdenk this memory test is non-destructive. So far, the 1659c609719bSwdenk following board configurations are known to be 1660c609719bSwdenk "pRAM-clean": 1661c609719bSwdenk 1662c609719bSwdenk ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL, 1663c609719bSwdenk HERMES, IP860, RPXlite, LWMON, LANTEC, 1664c609719bSwdenk PCU_E, FLAGADM, TQM8260 1665c609719bSwdenk 1666c609719bSwdenk- Error Recovery: 1667c609719bSwdenk CONFIG_PANIC_HANG 1668c609719bSwdenk 1669c609719bSwdenk Define this variable to stop the system in case of a 1670c609719bSwdenk fatal error, so that you have to reset it manually. 1671c609719bSwdenk This is probably NOT a good idea for an embedded 167211ccc33fSMarcel Ziswiler system where you want the system to reboot 1673c609719bSwdenk automatically as fast as possible, but it may be 1674c609719bSwdenk useful during development since you can try to debug 1675c609719bSwdenk the conditions that lead to the situation. 1676c609719bSwdenk 1677c609719bSwdenk CONFIG_NET_RETRY_COUNT 1678c609719bSwdenk 1679c609719bSwdenk This variable defines the number of retries for 1680c609719bSwdenk network operations like ARP, RARP, TFTP, or BOOTP 1681c609719bSwdenk before giving up the operation. If not defined, a 1682c609719bSwdenk default value of 5 is used. 1683c609719bSwdenk 168440cb90eeSGuennadi Liakhovetski CONFIG_ARP_TIMEOUT 168540cb90eeSGuennadi Liakhovetski 168640cb90eeSGuennadi Liakhovetski Timeout waiting for an ARP reply in milliseconds. 168740cb90eeSGuennadi Liakhovetski 1688c609719bSwdenk- Command Interpreter: 16898078f1a5SWolfgang Denk CONFIG_AUTO_COMPLETE 169004a85b3bSwdenk 169104a85b3bSwdenk Enable auto completion of commands using TAB. 169204a85b3bSwdenk 16938078f1a5SWolfgang Denk Note that this feature has NOT been implemented yet 16948078f1a5SWolfgang Denk for the "hush" shell. 16958078f1a5SWolfgang Denk 16968078f1a5SWolfgang Denk 16976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_HUSH_PARSER 1698c609719bSwdenk 1699c609719bSwdenk Define this variable to enable the "hush" shell (from 1700c609719bSwdenk Busybox) as command line interpreter, thus enabling 1701c609719bSwdenk powerful command line syntax like 1702c609719bSwdenk if...then...else...fi conditionals or `&&' and '||' 1703c609719bSwdenk constructs ("shell scripts"). 1704c609719bSwdenk 1705c609719bSwdenk If undefined, you get the old, much simpler behaviour 1706c609719bSwdenk with a somewhat smaller memory footprint. 1707c609719bSwdenk 1708c609719bSwdenk 17096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PROMPT_HUSH_PS2 1710c609719bSwdenk 1711c609719bSwdenk This defines the secondary prompt string, which is 1712c609719bSwdenk printed when the command interpreter needs more input 1713c609719bSwdenk to complete a command. Usually "> ". 1714c609719bSwdenk 1715c609719bSwdenk Note: 1716c609719bSwdenk 1717c609719bSwdenk In the current implementation, the local variables 1718c609719bSwdenk space and global environment variables space are 1719c609719bSwdenk separated. Local variables are those you define by 17203b57fe0aSwdenk simply typing `name=value'. To access a local 1721c609719bSwdenk variable later on, you have write `$name' or 17223b57fe0aSwdenk `${name}'; to execute the contents of a variable 17233b57fe0aSwdenk directly type `$name' at the command prompt. 1724c609719bSwdenk 1725c609719bSwdenk Global environment variables are those you use 1726c609719bSwdenk setenv/printenv to work with. To run a command stored 1727c609719bSwdenk in such a variable, you need to use the run command, 1728c609719bSwdenk and you must not use the '$' sign to access them. 1729c609719bSwdenk 1730c609719bSwdenk To store commands and special characters in a 1731c609719bSwdenk variable, please use double quotation marks 1732c609719bSwdenk surrounding the whole text of the variable, instead 1733c609719bSwdenk of the backslashes before semicolons and special 1734c609719bSwdenk symbols. 1735c609719bSwdenk 1736aa0c71acSWolfgang Denk- Commandline Editing and History: 1737aa0c71acSWolfgang Denk CONFIG_CMDLINE_EDITING 1738aa0c71acSWolfgang Denk 173911ccc33fSMarcel Ziswiler Enable editing and History functions for interactive 1740aa0c71acSWolfgang Denk commandline input operations 1741aa0c71acSWolfgang Denk 1742a8c7c708Swdenk- Default Environment: 1743c609719bSwdenk CONFIG_EXTRA_ENV_SETTINGS 1744c609719bSwdenk 1745c609719bSwdenk Define this to contain any number of null terminated 1746c609719bSwdenk strings (variable = value pairs) that will be part of 17477152b1d0Swdenk the default environment compiled into the boot image. 17482262cfeeSwdenk 1749c609719bSwdenk For example, place something like this in your 1750c609719bSwdenk board's config file: 1751c609719bSwdenk 1752c609719bSwdenk #define CONFIG_EXTRA_ENV_SETTINGS \ 1753c609719bSwdenk "myvar1=value1\0" \ 1754c609719bSwdenk "myvar2=value2\0" 1755c609719bSwdenk 1756c609719bSwdenk Warning: This method is based on knowledge about the 1757c609719bSwdenk internal format how the environment is stored by the 17582262cfeeSwdenk U-Boot code. This is NOT an official, exported 1759c609719bSwdenk interface! Although it is unlikely that this format 17607152b1d0Swdenk will change soon, there is no guarantee either. 1761c609719bSwdenk You better know what you are doing here. 1762c609719bSwdenk 1763c609719bSwdenk Note: overly (ab)use of the default environment is 1764c609719bSwdenk discouraged. Make sure to check other ways to preset 1765c609719bSwdenk the environment like the autoscript function or the 1766c609719bSwdenk boot command first. 1767c609719bSwdenk 1768a8c7c708Swdenk- DataFlash Support: 17692abbe075Swdenk CONFIG_HAS_DATAFLASH 17702abbe075Swdenk 17712abbe075Swdenk Defining this option enables DataFlash features and 17722abbe075Swdenk allows to read/write in Dataflash via the standard 17732abbe075Swdenk commands cp, md... 17742abbe075Swdenk 17753f85ce27Swdenk- SystemACE Support: 17763f85ce27Swdenk CONFIG_SYSTEMACE 17773f85ce27Swdenk 17783f85ce27Swdenk Adding this option adds support for Xilinx SystemACE 17793f85ce27Swdenk chips attached via some sort of local bus. The address 178011ccc33fSMarcel Ziswiler of the chip must also be defined in the 17816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SYSTEMACE_BASE macro. For example: 17823f85ce27Swdenk 17833f85ce27Swdenk #define CONFIG_SYSTEMACE 17846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000 17853f85ce27Swdenk 17863f85ce27Swdenk When SystemACE support is added, the "ace" device type 17873f85ce27Swdenk becomes available to the fat commands, i.e. fatls. 17883f85ce27Swdenk 1789ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port: 1790ecb0ccd9SWolfgang Denk CONFIG_TFTP_PORT 1791ecb0ccd9SWolfgang Denk 179228cb9375SWolfgang Denk If this is defined, the environment variable tftpsrcp 1793ecb0ccd9SWolfgang Denk is used to supply the TFTP UDP source port value. 179428cb9375SWolfgang Denk If tftpsrcp isn't defined, the normal pseudo-random port 1795ecb0ccd9SWolfgang Denk number generator is used. 1796ecb0ccd9SWolfgang Denk 179728cb9375SWolfgang Denk Also, the environment variable tftpdstp is used to supply 179828cb9375SWolfgang Denk the TFTP UDP destination port value. If tftpdstp isn't 179928cb9375SWolfgang Denk defined, the normal port 69 is used. 180028cb9375SWolfgang Denk 180128cb9375SWolfgang Denk The purpose for tftpsrcp is to allow a TFTP server to 1802ecb0ccd9SWolfgang Denk blindly start the TFTP transfer using the pre-configured 1803ecb0ccd9SWolfgang Denk target IP address and UDP port. This has the effect of 1804ecb0ccd9SWolfgang Denk "punching through" the (Windows XP) firewall, allowing 1805ecb0ccd9SWolfgang Denk the remainder of the TFTP transfer to proceed normally. 1806ecb0ccd9SWolfgang Denk A better solution is to properly configure the firewall, 1807ecb0ccd9SWolfgang Denk but sometimes that is not allowed. 1808ecb0ccd9SWolfgang Denk 1809a8c7c708Swdenk- Show boot progress: 1810c609719bSwdenk CONFIG_SHOW_BOOT_PROGRESS 1811c609719bSwdenk 1812c609719bSwdenk Defining this option allows to add some board- 1813c609719bSwdenk specific code (calling a user-provided function 1814c609719bSwdenk "show_boot_progress(int)") that enables you to show 1815c609719bSwdenk the system's boot progress on some display (for 1816c609719bSwdenk example, some LED's) on your board. At the moment, 1817c609719bSwdenk the following checkpoints are implemented: 1818c609719bSwdenk 18194bae9090SBartlomiej Sieka- Automatic software updates via TFTP server 18204bae9090SBartlomiej Sieka CONFIG_UPDATE_TFTP 18214bae9090SBartlomiej Sieka CONFIG_UPDATE_TFTP_CNT_MAX 18224bae9090SBartlomiej Sieka CONFIG_UPDATE_TFTP_MSEC_MAX 18234bae9090SBartlomiej Sieka 18244bae9090SBartlomiej Sieka These options enable and control the auto-update feature; 18254bae9090SBartlomiej Sieka for a more detailed description refer to doc/README.update. 18264bae9090SBartlomiej Sieka 18271372cce2SMarian BalakowiczLegacy uImage format: 18281372cce2SMarian Balakowicz 1829c609719bSwdenk Arg Where When 1830c609719bSwdenk 1 common/cmd_bootm.c before attempting to boot an image 1831c609719bSwdenk -1 common/cmd_bootm.c Image header has bad magic number 1832c609719bSwdenk 2 common/cmd_bootm.c Image header has correct magic number 1833c609719bSwdenk -2 common/cmd_bootm.c Image header has bad checksum 1834c609719bSwdenk 3 common/cmd_bootm.c Image header has correct checksum 1835c609719bSwdenk -3 common/cmd_bootm.c Image data has bad checksum 1836c609719bSwdenk 4 common/cmd_bootm.c Image data has correct checksum 1837c609719bSwdenk -4 common/cmd_bootm.c Image is for unsupported architecture 1838c609719bSwdenk 5 common/cmd_bootm.c Architecture check OK 18391372cce2SMarian Balakowicz -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi) 1840c609719bSwdenk 6 common/cmd_bootm.c Image Type check OK 1841c609719bSwdenk -6 common/cmd_bootm.c gunzip uncompression error 1842c609719bSwdenk -7 common/cmd_bootm.c Unimplemented compression type 1843c609719bSwdenk 7 common/cmd_bootm.c Uncompression OK 18441372cce2SMarian Balakowicz 8 common/cmd_bootm.c No uncompress/copy overwrite error 1845c609719bSwdenk -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX) 18461372cce2SMarian Balakowicz 18471372cce2SMarian Balakowicz 9 common/image.c Start initial ramdisk verification 18481372cce2SMarian Balakowicz -10 common/image.c Ramdisk header has bad magic number 18491372cce2SMarian Balakowicz -11 common/image.c Ramdisk header has bad checksum 18501372cce2SMarian Balakowicz 10 common/image.c Ramdisk header is OK 18511372cce2SMarian Balakowicz -12 common/image.c Ramdisk data has bad checksum 18521372cce2SMarian Balakowicz 11 common/image.c Ramdisk data has correct checksum 18531372cce2SMarian Balakowicz 12 common/image.c Ramdisk verification complete, start loading 185411ccc33fSMarcel Ziswiler -13 common/image.c Wrong Image Type (not PPC Linux ramdisk) 18551372cce2SMarian Balakowicz 13 common/image.c Start multifile image verification 18561372cce2SMarian Balakowicz 14 common/image.c No initial ramdisk, no multifile, continue. 18571372cce2SMarian Balakowicz 18581372cce2SMarian Balakowicz 15 lib_<arch>/bootm.c All preparation done, transferring control to OS 1859c609719bSwdenk 186063e73c9aSwdenk -30 lib_ppc/board.c Fatal error, hang the system 186163e73c9aSwdenk -31 post/post.c POST test failed, detected by post_output_backlog() 186263e73c9aSwdenk -32 post/post.c POST test failed, detected by post_run_single() 186363e73c9aSwdenk 1864566a494fSHeiko Schocher 34 common/cmd_doc.c before loading a Image from a DOC device 1865566a494fSHeiko Schocher -35 common/cmd_doc.c Bad usage of "doc" command 1866566a494fSHeiko Schocher 35 common/cmd_doc.c correct usage of "doc" command 1867566a494fSHeiko Schocher -36 common/cmd_doc.c No boot device 1868566a494fSHeiko Schocher 36 common/cmd_doc.c correct boot device 1869566a494fSHeiko Schocher -37 common/cmd_doc.c Unknown Chip ID on boot device 1870566a494fSHeiko Schocher 37 common/cmd_doc.c correct chip ID found, device available 1871566a494fSHeiko Schocher -38 common/cmd_doc.c Read Error on boot device 1872566a494fSHeiko Schocher 38 common/cmd_doc.c reading Image header from DOC device OK 1873566a494fSHeiko Schocher -39 common/cmd_doc.c Image header has bad magic number 1874566a494fSHeiko Schocher 39 common/cmd_doc.c Image header has correct magic number 1875566a494fSHeiko Schocher -40 common/cmd_doc.c Error reading Image from DOC device 1876566a494fSHeiko Schocher 40 common/cmd_doc.c Image header has correct magic number 1877566a494fSHeiko Schocher 41 common/cmd_ide.c before loading a Image from a IDE device 1878566a494fSHeiko Schocher -42 common/cmd_ide.c Bad usage of "ide" command 1879566a494fSHeiko Schocher 42 common/cmd_ide.c correct usage of "ide" command 1880566a494fSHeiko Schocher -43 common/cmd_ide.c No boot device 1881566a494fSHeiko Schocher 43 common/cmd_ide.c boot device found 1882566a494fSHeiko Schocher -44 common/cmd_ide.c Device not available 1883566a494fSHeiko Schocher 44 common/cmd_ide.c Device available 1884566a494fSHeiko Schocher -45 common/cmd_ide.c wrong partition selected 1885566a494fSHeiko Schocher 45 common/cmd_ide.c partition selected 1886566a494fSHeiko Schocher -46 common/cmd_ide.c Unknown partition table 1887566a494fSHeiko Schocher 46 common/cmd_ide.c valid partition table found 1888566a494fSHeiko Schocher -47 common/cmd_ide.c Invalid partition type 1889566a494fSHeiko Schocher 47 common/cmd_ide.c correct partition type 1890566a494fSHeiko Schocher -48 common/cmd_ide.c Error reading Image Header on boot device 1891566a494fSHeiko Schocher 48 common/cmd_ide.c reading Image Header from IDE device OK 1892566a494fSHeiko Schocher -49 common/cmd_ide.c Image header has bad magic number 1893566a494fSHeiko Schocher 49 common/cmd_ide.c Image header has correct magic number 1894566a494fSHeiko Schocher -50 common/cmd_ide.c Image header has bad checksum 1895566a494fSHeiko Schocher 50 common/cmd_ide.c Image header has correct checksum 1896566a494fSHeiko Schocher -51 common/cmd_ide.c Error reading Image from IDE device 1897566a494fSHeiko Schocher 51 common/cmd_ide.c reading Image from IDE device OK 1898566a494fSHeiko Schocher 52 common/cmd_nand.c before loading a Image from a NAND device 1899566a494fSHeiko Schocher -53 common/cmd_nand.c Bad usage of "nand" command 1900566a494fSHeiko Schocher 53 common/cmd_nand.c correct usage of "nand" command 1901566a494fSHeiko Schocher -54 common/cmd_nand.c No boot device 1902566a494fSHeiko Schocher 54 common/cmd_nand.c boot device found 1903566a494fSHeiko Schocher -55 common/cmd_nand.c Unknown Chip ID on boot device 1904566a494fSHeiko Schocher 55 common/cmd_nand.c correct chip ID found, device available 1905566a494fSHeiko Schocher -56 common/cmd_nand.c Error reading Image Header on boot device 1906566a494fSHeiko Schocher 56 common/cmd_nand.c reading Image Header from NAND device OK 1907566a494fSHeiko Schocher -57 common/cmd_nand.c Image header has bad magic number 1908566a494fSHeiko Schocher 57 common/cmd_nand.c Image header has correct magic number 1909566a494fSHeiko Schocher -58 common/cmd_nand.c Error reading Image from NAND device 1910566a494fSHeiko Schocher 58 common/cmd_nand.c reading Image from NAND device OK 1911c609719bSwdenk 1912566a494fSHeiko Schocher -60 common/env_common.c Environment has a bad CRC, using default 1913c609719bSwdenk 1914566a494fSHeiko Schocher 64 net/eth.c starting with Ethernet configuration. 1915566a494fSHeiko Schocher -64 net/eth.c no Ethernet found. 1916566a494fSHeiko Schocher 65 net/eth.c Ethernet found. 1917206c60cbSwdenk 1918566a494fSHeiko Schocher -80 common/cmd_net.c usage wrong 1919566a494fSHeiko Schocher 80 common/cmd_net.c before calling NetLoop() 192011ccc33fSMarcel Ziswiler -81 common/cmd_net.c some error in NetLoop() occurred 1921566a494fSHeiko Schocher 81 common/cmd_net.c NetLoop() back without error 1922566a494fSHeiko Schocher -82 common/cmd_net.c size == 0 (File with size 0 loaded) 1923566a494fSHeiko Schocher 82 common/cmd_net.c trying automatic boot 1924566a494fSHeiko Schocher 83 common/cmd_net.c running autoscript 1925566a494fSHeiko Schocher -83 common/cmd_net.c some error in automatic boot or autoscript 1926566a494fSHeiko Schocher 84 common/cmd_net.c end without errors 1927c609719bSwdenk 19281372cce2SMarian BalakowiczFIT uImage format: 19291372cce2SMarian Balakowicz 19301372cce2SMarian Balakowicz Arg Where When 19311372cce2SMarian Balakowicz 100 common/cmd_bootm.c Kernel FIT Image has correct format 19321372cce2SMarian Balakowicz -100 common/cmd_bootm.c Kernel FIT Image has incorrect format 19331372cce2SMarian Balakowicz 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration 19341372cce2SMarian Balakowicz -101 common/cmd_bootm.c Can't get configuration for kernel subimage 19351372cce2SMarian Balakowicz 102 common/cmd_bootm.c Kernel unit name specified 19361372cce2SMarian Balakowicz -103 common/cmd_bootm.c Can't get kernel subimage node offset 1937f773bea8SMarian Balakowicz 103 common/cmd_bootm.c Found configuration node 19381372cce2SMarian Balakowicz 104 common/cmd_bootm.c Got kernel subimage node offset 19391372cce2SMarian Balakowicz -104 common/cmd_bootm.c Kernel subimage hash verification failed 19401372cce2SMarian Balakowicz 105 common/cmd_bootm.c Kernel subimage hash verification OK 19411372cce2SMarian Balakowicz -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture 19421372cce2SMarian Balakowicz 106 common/cmd_bootm.c Architecture check OK 194311ccc33fSMarcel Ziswiler -106 common/cmd_bootm.c Kernel subimage has wrong type 194411ccc33fSMarcel Ziswiler 107 common/cmd_bootm.c Kernel subimage type OK 19451372cce2SMarian Balakowicz -107 common/cmd_bootm.c Can't get kernel subimage data/size 19461372cce2SMarian Balakowicz 108 common/cmd_bootm.c Got kernel subimage data/size 19471372cce2SMarian Balakowicz -108 common/cmd_bootm.c Wrong image type (not legacy, FIT) 19481372cce2SMarian Balakowicz -109 common/cmd_bootm.c Can't get kernel subimage type 19491372cce2SMarian Balakowicz -110 common/cmd_bootm.c Can't get kernel subimage comp 19501372cce2SMarian Balakowicz -111 common/cmd_bootm.c Can't get kernel subimage os 19511372cce2SMarian Balakowicz -112 common/cmd_bootm.c Can't get kernel subimage load address 19521372cce2SMarian Balakowicz -113 common/cmd_bootm.c Image uncompress/copy overwrite error 19531372cce2SMarian Balakowicz 19541372cce2SMarian Balakowicz 120 common/image.c Start initial ramdisk verification 19551372cce2SMarian Balakowicz -120 common/image.c Ramdisk FIT image has incorrect format 19561372cce2SMarian Balakowicz 121 common/image.c Ramdisk FIT image has correct format 195711ccc33fSMarcel Ziswiler 122 common/image.c No ramdisk subimage unit name, using configuration 19581372cce2SMarian Balakowicz -122 common/image.c Can't get configuration for ramdisk subimage 19591372cce2SMarian Balakowicz 123 common/image.c Ramdisk unit name specified 19601372cce2SMarian Balakowicz -124 common/image.c Can't get ramdisk subimage node offset 19611372cce2SMarian Balakowicz 125 common/image.c Got ramdisk subimage node offset 19621372cce2SMarian Balakowicz -125 common/image.c Ramdisk subimage hash verification failed 19631372cce2SMarian Balakowicz 126 common/image.c Ramdisk subimage hash verification OK 19641372cce2SMarian Balakowicz -126 common/image.c Ramdisk subimage for unsupported architecture 19651372cce2SMarian Balakowicz 127 common/image.c Architecture check OK 19661372cce2SMarian Balakowicz -127 common/image.c Can't get ramdisk subimage data/size 19671372cce2SMarian Balakowicz 128 common/image.c Got ramdisk subimage data/size 19681372cce2SMarian Balakowicz 129 common/image.c Can't get ramdisk load address 19691372cce2SMarian Balakowicz -129 common/image.c Got ramdisk load address 19701372cce2SMarian Balakowicz 197111ccc33fSMarcel Ziswiler -130 common/cmd_doc.c Incorrect FIT image format 19721372cce2SMarian Balakowicz 131 common/cmd_doc.c FIT image format OK 19731372cce2SMarian Balakowicz 197411ccc33fSMarcel Ziswiler -140 common/cmd_ide.c Incorrect FIT image format 19751372cce2SMarian Balakowicz 141 common/cmd_ide.c FIT image format OK 19761372cce2SMarian Balakowicz 197711ccc33fSMarcel Ziswiler -150 common/cmd_nand.c Incorrect FIT image format 19781372cce2SMarian Balakowicz 151 common/cmd_nand.c FIT image format OK 19791372cce2SMarian Balakowicz 19801372cce2SMarian Balakowicz 1981c609719bSwdenkModem Support: 1982c609719bSwdenk-------------- 1983c609719bSwdenk 198485ec0bccSwdenk[so far only for SMDK2400 and TRAB boards] 1985c609719bSwdenk 198611ccc33fSMarcel Ziswiler- Modem support enable: 1987c609719bSwdenk CONFIG_MODEM_SUPPORT 1988c609719bSwdenk 1989c609719bSwdenk- RTS/CTS Flow control enable: 1990c609719bSwdenk CONFIG_HWFLOW 1991c609719bSwdenk 1992c609719bSwdenk- Modem debug support: 1993c609719bSwdenk CONFIG_MODEM_SUPPORT_DEBUG 1994c609719bSwdenk 1995c609719bSwdenk Enables debugging stuff (char screen[1024], dbg()) 1996c609719bSwdenk for modem support. Useful only with BDI2000. 1997c609719bSwdenk 1998a8c7c708Swdenk- Interrupt support (PPC): 1999a8c7c708Swdenk 2000a8c7c708Swdenk There are common interrupt_init() and timer_interrupt() 2001a8c7c708Swdenk for all PPC archs. interrupt_init() calls interrupt_init_cpu() 200211ccc33fSMarcel Ziswiler for CPU specific initialization. interrupt_init_cpu() 2003a8c7c708Swdenk should set decrementer_count to appropriate value. If 200411ccc33fSMarcel Ziswiler CPU resets decrementer automatically after interrupt 2005a8c7c708Swdenk (ppc4xx) it should set decrementer_count to zero. 200611ccc33fSMarcel Ziswiler timer_interrupt() calls timer_interrupt_cpu() for CPU 2007a8c7c708Swdenk specific handling. If board has watchdog / status_led 2008a8c7c708Swdenk / other_activity_monitor it works automatically from 2009a8c7c708Swdenk general timer_interrupt(). 2010a8c7c708Swdenk 2011c609719bSwdenk- General: 2012c609719bSwdenk 2013c609719bSwdenk In the target system modem support is enabled when a 2014c609719bSwdenk specific key (key combination) is pressed during 2015c609719bSwdenk power-on. Otherwise U-Boot will boot normally 201611ccc33fSMarcel Ziswiler (autoboot). The key_pressed() function is called from 2017c609719bSwdenk board_init(). Currently key_pressed() is a dummy 2018c609719bSwdenk function, returning 1 and thus enabling modem 2019c609719bSwdenk initialization. 2020c609719bSwdenk 2021c609719bSwdenk If there are no modem init strings in the 2022c609719bSwdenk environment, U-Boot proceed to autoboot; the 2023c609719bSwdenk previous output (banner, info printfs) will be 202411ccc33fSMarcel Ziswiler suppressed, though. 2025c609719bSwdenk 2026c609719bSwdenk See also: doc/README.Modem 2027c609719bSwdenk 2028c609719bSwdenk 2029c609719bSwdenkConfiguration Settings: 2030c609719bSwdenk----------------------- 2031c609719bSwdenk 20326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included; 2033c609719bSwdenk undefine this when you're short of memory. 2034c609719bSwdenk 20356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to 2036c609719bSwdenk prompt for user input. 2037c609719bSwdenk 20386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE: Buffer size for input from the Console 2039c609719bSwdenk 20406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE: Buffer size for Console output 2041c609719bSwdenk 20426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands 2043c609719bSwdenk 20446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to 2045c609719bSwdenk the application (usually a Linux kernel) when it is 2046c609719bSwdenk booted 2047c609719bSwdenk 20486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE: 2049c609719bSwdenk List of legal baudrate settings for this board. 2050c609719bSwdenk 20516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET 2052c609719bSwdenk Suppress display of console information at boot. 2053c609719bSwdenk 20546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV 2055c609719bSwdenk If the board specific function 2056c609719bSwdenk extern int overwrite_console (void); 2057c609719bSwdenk returns 1, the stdin, stderr and stdout are switched to the 2058c609719bSwdenk serial port, else the settings in the environment are used. 2059c609719bSwdenk 20606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE 2061c609719bSwdenk Enable the call to overwrite_console(). 2062c609719bSwdenk 20636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE 2064c609719bSwdenk Enable overwrite of previous console environment settings. 2065c609719bSwdenk 20666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END: 2067c609719bSwdenk Begin and End addresses of the area used by the 2068c609719bSwdenk simple memory test. 2069c609719bSwdenk 20706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST: 2071c609719bSwdenk Enable an alternate, more extensive memory test. 2072c609719bSwdenk 20736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH: 20745f535fe1Swdenk Scratch address used by the alternate memory test 20755f535fe1Swdenk You only need to set this if address zero isn't writeable 20765f535fe1Swdenk 20776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only): 20786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header, 207914f73ca6SStefan Roese this specified memory area will get subtracted from the top 208011ccc33fSMarcel Ziswiler (end) of RAM and won't get "touched" at all by U-Boot. By 208114f73ca6SStefan Roese fixing up gd->ram_size the Linux kernel should gets passed 208214f73ca6SStefan Roese the now "corrected" memory size and won't touch it either. 208314f73ca6SStefan Roese This should work for arch/ppc and arch/powerpc. Only Linux 20845e12e75dSStefan Roese board ports in arch/powerpc with bootwrapper support that 208514f73ca6SStefan Roese recalculate the memory size from the SDRAM controller setup 20865e12e75dSStefan Roese will have to get fixed in Linux additionally. 208714f73ca6SStefan Roese 208814f73ca6SStefan Roese This option can be used as a workaround for the 440EPx/GRx 208914f73ca6SStefan Roese CHIP 11 errata where the last 256 bytes in SDRAM shouldn't 209014f73ca6SStefan Roese be touched. 209114f73ca6SStefan Roese 209214f73ca6SStefan Roese WARNING: Please make sure that this value is a multiple of 209314f73ca6SStefan Roese the Linux page size (normally 4k). If this is not the case, 209414f73ca6SStefan Roese then the end address of the Linux memory will be located at a 209514f73ca6SStefan Roese non page size aligned address and this could cause major 209614f73ca6SStefan Roese problems. 209714f73ca6SStefan Roese 20986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TFTP_LOADADDR: 2099c609719bSwdenk Default load address for network file downloads 2100c609719bSwdenk 21016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE: 2102c609719bSwdenk Enable temporary baudrate change while serial download 2103c609719bSwdenk 21046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE: 2105c609719bSwdenk Physical start address of SDRAM. _Must_ be 0 here. 2106c609719bSwdenk 21076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE: 2108c609719bSwdenk Physical start address of Motherboard I/O (if using a 2109c609719bSwdenk Cogent motherboard) 2110c609719bSwdenk 21116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE: 2112c609719bSwdenk Physical start address of Flash memory. 2113c609719bSwdenk 21146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE: 2115c609719bSwdenk Physical start address of boot monitor code (set by 2116c609719bSwdenk make config files to be same as the text base address 2117c609719bSwdenk (TEXT_BASE) used when linking) - same as 21186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FLASH_BASE when booting from flash. 2119c609719bSwdenk 21206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN: 21213b57fe0aSwdenk Size of memory reserved for monitor code, used to 21223b57fe0aSwdenk determine _at_compile_time_ (!) if the environment is 21233b57fe0aSwdenk embedded within the U-Boot image, or in a separate 21243b57fe0aSwdenk flash sector. 2125c609719bSwdenk 21266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN: 2127c609719bSwdenk Size of DRAM reserved for malloc() use. 2128c609719bSwdenk 21296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN: 213015940c9aSStefan Roese Normally compressed uImages are limited to an 213115940c9aSStefan Roese uncompressed size of 8 MBytes. If this is not enough, 21326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD you can define CONFIG_SYS_BOOTM_LEN in your board config file 213315940c9aSStefan Roese to adjust this setting to your needs. 2134c609719bSwdenk 21356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ: 2136c609719bSwdenk Maximum size of memory mapped by the startup code of 2137c609719bSwdenk the Linux kernel; all data that must be processed by 21387d721e34SBartlomiej Sieka the Linux kernel (bd_info, boot arguments, FDT blob if 21397d721e34SBartlomiej Sieka used) must be put below this limit, unless "bootm_low" 21407d721e34SBartlomiej Sieka enviroment variable is defined and non-zero. In such case 21417d721e34SBartlomiej Sieka all data for the Linux kernel must be between "bootm_low" 21426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. 2143c609719bSwdenk 21446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS: 2145c609719bSwdenk Max number of Flash memory banks 2146c609719bSwdenk 21476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT: 2148c609719bSwdenk Max number of sectors on a Flash chip 2149c609719bSwdenk 21506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT: 2151c609719bSwdenk Timeout for Flash erase operations (in ms) 2152c609719bSwdenk 21536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT: 2154c609719bSwdenk Timeout for Flash write operations (in ms) 2155c609719bSwdenk 21566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT 21578564acf9Swdenk Timeout for Flash set sector lock bit operation (in ms) 21588564acf9Swdenk 21596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT 21608564acf9Swdenk Timeout for Flash clear lock bits operation (in ms) 21618564acf9Swdenk 21626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION 21638564acf9Swdenk If defined, hardware flash sectors protection is used 21648564acf9Swdenk instead of U-Boot software protection. 21658564acf9Swdenk 21666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP: 2167c609719bSwdenk 2168c609719bSwdenk Enable TFTP transfers directly to flash memory; 2169c609719bSwdenk without this option such a download has to be 2170c609719bSwdenk performed in two steps: (1) download to RAM, and (2) 2171c609719bSwdenk copy from RAM to flash. 2172c609719bSwdenk 2173c609719bSwdenk The two-step approach is usually more reliable, since 2174c609719bSwdenk you can check if the download worked before you erase 217511ccc33fSMarcel Ziswiler the flash, but in some situations (when system RAM is 217611ccc33fSMarcel Ziswiler too limited to allow for a temporary copy of the 2177c609719bSwdenk downloaded image) this option may be very useful. 2178c609719bSwdenk 21796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI: 2180c609719bSwdenk Define if the flash driver uses extra elements in the 21815653fc33Swdenk common flash structure for storing flash geometry. 21825653fc33Swdenk 218300b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER 21845653fc33Swdenk This option also enables the building of the cfi_flash driver 21855653fc33Swdenk in the drivers directory 218653cf9435Sstroese 218791809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD 218891809ed5SPiotr Ziecik This option enables the building of the cfi_mtd driver 218991809ed5SPiotr Ziecik in the drivers directory. The driver exports CFI flash 219091809ed5SPiotr Ziecik to the MTD layer. 219191809ed5SPiotr Ziecik 21926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE 219396ef831fSGuennadi Liakhovetski Use buffered writes to flash. 219496ef831fSGuennadi Liakhovetski 219596ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N 219696ef831fSGuennadi Liakhovetski s29ws-n MirrorBit flash has non-standard addresses for buffered 219796ef831fSGuennadi Liakhovetski write commands. 219896ef831fSGuennadi Liakhovetski 21996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST 22005568e613SStefan Roese If this option is defined, the common CFI flash doesn't 22015568e613SStefan Roese print it's warning upon not recognized FLASH banks. This 22025568e613SStefan Roese is useful, if some of the configured banks are only 22035568e613SStefan Roese optionally available. 22045568e613SStefan Roese 22059a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS 22069a042e9cSJerry Van Baren If defined (must be an integer), print out countdown 22079a042e9cSJerry Van Baren digits and dots. Recommended value: 45 (9..1) for 80 22089a042e9cSJerry Van Baren column displays, 15 (3..1) for 40 column displays. 22099a042e9cSJerry Van Baren 22106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER: 221111ccc33fSMarcel Ziswiler Defines the number of Ethernet receive buffers. On some 221211ccc33fSMarcel Ziswiler Ethernet controllers it is recommended to set this value 221353cf9435Sstroese to 8 or even higher (EEPRO100 or 405 EMAC), since all 221453cf9435Sstroese buffers can be full shortly after enabling the interface 221511ccc33fSMarcel Ziswiler on high Ethernet traffic. 221653cf9435Sstroese Defaults to 4 if not defined. 2217c609719bSwdenk 2218c609719bSwdenkThe following definitions that deal with the placement and management 2219c609719bSwdenkof environment data (variable area); in general, we support the 2220c609719bSwdenkfollowing configurations: 2221c609719bSwdenk 22225a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH: 2223c609719bSwdenk 2224c609719bSwdenk Define this if the environment is in flash memory. 2225c609719bSwdenk 2226c609719bSwdenk a) The environment occupies one whole flash sector, which is 2227c609719bSwdenk "embedded" in the text segment with the U-Boot code. This 2228c609719bSwdenk happens usually with "bottom boot sector" or "top boot 2229c609719bSwdenk sector" type flash chips, which have several smaller 2230c609719bSwdenk sectors at the start or the end. For instance, such a 2231c609719bSwdenk layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In 2232c609719bSwdenk such a case you would place the environment in one of the 2233c609719bSwdenk 4 kB sectors - with U-Boot code before and after it. With 2234c609719bSwdenk "top boot sector" type flash chips, you would put the 2235c609719bSwdenk environment in one of the last sectors, leaving a gap 2236c609719bSwdenk between U-Boot and the environment. 2237c609719bSwdenk 22380e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 2239c609719bSwdenk 2240c609719bSwdenk Offset of environment data (variable area) to the 2241c609719bSwdenk beginning of flash memory; for instance, with bottom boot 2242c609719bSwdenk type flash chips the second sector can be used: the offset 2243c609719bSwdenk for this sector is given here. 2244c609719bSwdenk 22456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE. 2246c609719bSwdenk 22470e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 2248c609719bSwdenk 2249c609719bSwdenk This is just another way to specify the start address of 2250c609719bSwdenk the flash sector containing the environment (instead of 22510e8d1586SJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_OFFSET). 2252c609719bSwdenk 22530e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SECT_SIZE: 2254c609719bSwdenk 2255c609719bSwdenk Size of the sector containing the environment. 2256c609719bSwdenk 2257c609719bSwdenk 2258c609719bSwdenk b) Sometimes flash chips have few, equal sized, BIG sectors. 2259c609719bSwdenk In such a case you don't want to spend a whole sector for 2260c609719bSwdenk the environment. 2261c609719bSwdenk 22620e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 2263c609719bSwdenk 22645a1aceb0SJean-Christophe PLAGNIOL-VILLARD If you use this in combination with CONFIG_ENV_IS_IN_FLASH 22650e8d1586SJean-Christophe PLAGNIOL-VILLARD and CONFIG_ENV_SECT_SIZE, you can specify to use only a part 2266c609719bSwdenk of this flash sector for the environment. This saves 2267c609719bSwdenk memory for the RAM copy of the environment. 2268c609719bSwdenk 2269c609719bSwdenk It may also save flash memory if you decide to use this 2270c609719bSwdenk when your environment is "embedded" within U-Boot code, 2271c609719bSwdenk since then the remainder of the flash sector could be used 2272c609719bSwdenk for U-Boot code. It should be pointed out that this is 2273c609719bSwdenk STRONGLY DISCOURAGED from a robustness point of view: 2274c609719bSwdenk updating the environment in flash makes it always 2275c609719bSwdenk necessary to erase the WHOLE sector. If something goes 2276c609719bSwdenk wrong before the contents has been restored from a copy in 2277c609719bSwdenk RAM, your target system will be dead. 2278c609719bSwdenk 22790e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR_REDUND 22800e8d1586SJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_SIZE_REDUND 2281c609719bSwdenk 2282c609719bSwdenk These settings describe a second storage area used to hold 228311ccc33fSMarcel Ziswiler a redundant copy of the environment data, so that there is 22843e38691eSwdenk a valid backup copy in case there is a power failure during 2285c609719bSwdenk a "saveenv" operation. 2286c609719bSwdenk 2287c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the 2288c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds* 2289c609719bSwdenkaccordingly! 2290c609719bSwdenk 2291c609719bSwdenk 22929314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM: 2293c609719bSwdenk 2294c609719bSwdenk Define this if you have some non-volatile memory device 2295c609719bSwdenk (NVRAM, battery buffered SRAM) which you want to use for the 2296c609719bSwdenk environment. 2297c609719bSwdenk 22980e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 22990e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 2300c609719bSwdenk 230111ccc33fSMarcel Ziswiler These two #defines are used to determine the memory area you 2302c609719bSwdenk want to use for environment. It is assumed that this memory 2303c609719bSwdenk can just be read and written to, without any special 2304c609719bSwdenk provision. 2305c609719bSwdenk 2306c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early 2307c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the 230811ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or 2309c609719bSwdenkU-Boot will hang. 2310c609719bSwdenk 2311c609719bSwdenkPlease note that even with NVRAM we still use a copy of the 2312c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to 2313c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv" 2314c609719bSwdenkto save the current settings. 2315c609719bSwdenk 2316c609719bSwdenk 2317bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM: 2318c609719bSwdenk 2319c609719bSwdenk Use this if you have an EEPROM or similar serial access 2320c609719bSwdenk device and a driver for it. 2321c609719bSwdenk 23220e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 23230e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 2324c609719bSwdenk 2325c609719bSwdenk These two #defines specify the offset and size of the 2326c609719bSwdenk environment area within the total memory of your EEPROM. 2327c609719bSwdenk 23286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR: 2329c609719bSwdenk If defined, specified the chip address of the EEPROM device. 2330c609719bSwdenk The default address is zero. 2331c609719bSwdenk 23326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS: 2333c609719bSwdenk If defined, the number of bits used to address bytes in a 2334c609719bSwdenk single page in the EEPROM device. A 64 byte page, for example 2335c609719bSwdenk would require six bits. 2336c609719bSwdenk 23376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS: 2338c609719bSwdenk If defined, the number of milliseconds to delay between 2339c609719bSwdenk page writes. The default is zero milliseconds. 2340c609719bSwdenk 23416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR_LEN: 2342c609719bSwdenk The length in bytes of the EEPROM memory array address. Note 2343c609719bSwdenk that this is NOT the chip address length! 2344c609719bSwdenk 23456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW: 23465cf91d6bSwdenk EEPROM chips that implement "address overflow" are ones 23475cf91d6bSwdenk like Catalyst 24WC04/08/16 which has 9/10/11 bits of 23485cf91d6bSwdenk address and the extra bits end up in the "chip address" bit 23495cf91d6bSwdenk slots. This makes a 24WC08 (1Kbyte) chip look like four 256 23505cf91d6bSwdenk byte chips. 23515cf91d6bSwdenk 23525cf91d6bSwdenk Note that we consider the length of the address field to 23535cf91d6bSwdenk still be one byte because the extra address bits are hidden 23545cf91d6bSwdenk in the chip address. 23555cf91d6bSwdenk 23566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_SIZE: 2357c609719bSwdenk The size in bytes of the EEPROM device. 2358c609719bSwdenk 2359c609719bSwdenk 2360057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH: 23615779d8d9Swdenk 23625779d8d9Swdenk Define this if you have a DataFlash memory device which you 23635779d8d9Swdenk want to use for the environment. 23645779d8d9Swdenk 23650e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 23660e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 23670e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 23685779d8d9Swdenk 23695779d8d9Swdenk These three #defines specify the offset and size of the 23705779d8d9Swdenk environment area within the total memory of your DataFlash placed 23715779d8d9Swdenk at the specified address. 23725779d8d9Swdenk 237351bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND: 237413a5695bSwdenk 237513a5695bSwdenk Define this if you have a NAND device which you want to use 237613a5695bSwdenk for the environment. 237713a5695bSwdenk 23780e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 23790e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 238013a5695bSwdenk 238113a5695bSwdenk These two #defines specify the offset and size of the environment 238213a5695bSwdenk area within the first NAND device. 23835779d8d9Swdenk 23840e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET_REDUND 2385e443c944SMarkus Klotzbuecher 23860e8d1586SJean-Christophe PLAGNIOL-VILLARD This setting describes a second storage area of CONFIG_ENV_SIZE 2387e443c944SMarkus Klotzbuecher size used to hold a redundant copy of the environment data, 2388e443c944SMarkus Klotzbuecher so that there is a valid backup copy in case there is a 2389e443c944SMarkus Klotzbuecher power failure during a "saveenv" operation. 2390e443c944SMarkus Klotzbuecher 23910e8d1586SJean-Christophe PLAGNIOL-VILLARD Note: CONFIG_ENV_OFFSET and CONFIG_ENV_OFFSET_REDUND must be aligned 23920e8d1586SJean-Christophe PLAGNIOL-VILLARD to a block boundary, and CONFIG_ENV_SIZE must be a multiple of 2393e443c944SMarkus Klotzbuecher the NAND devices block size. 2394e443c944SMarkus Klotzbuecher 23956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET 2396c609719bSwdenk 2397c609719bSwdenk Defines offset to the initial SPI buffer area in DPRAM. The 2398c609719bSwdenk area is used at an early stage (ROM part) if the environment 2399c609719bSwdenk is configured to reside in the SPI EEPROM: We need a 520 byte 2400c609719bSwdenk scratch DPRAM area. It is used between the two initialization 2401c609719bSwdenk calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems 2402c609719bSwdenk to be a good choice since it makes it far enough from the 2403c609719bSwdenk start of the data area as well as from the stack pointer. 2404c609719bSwdenk 2405e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor 2406c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been 2407c609719bSwdenkcreated; also, when using EEPROM you will have to use getenv_r() 2408c609719bSwdenkuntil then to read environment variables. 2409c609719bSwdenk 241085ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor 241185ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working 241285ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is 241385ec0bccSwdenknecessary, because the first environment variable we need is the 241485ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't 241585ec0bccSwdenkhave any device yet where we could complain.] 2416c609719bSwdenk 2417c609719bSwdenkNote: once the monitor has been relocated, then it will complain if 2418c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you 241985ec0bccSwdenkuse the "saveenv" command to store a valid environment. 2420c609719bSwdenk 24216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN: 2422fc3e2165Swdenk Echo the inverted Ethernet link state to the fault LED. 2423fc3e2165Swdenk 24246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR 2425fc3e2165Swdenk also needs to be defined. 2426fc3e2165Swdenk 24276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR: 2428fc3e2165Swdenk MII address of the PHY to check for the Ethernet link state. 2429c609719bSwdenk 24306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_64BIT_VSPRINTF: 2431c40b2956Swdenk Makes vsprintf (and all *printf functions) support printing 2432c40b2956Swdenk of 64bit values by using the L quantifier 2433c40b2956Swdenk 24346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_64BIT_STRTOUL: 2435c40b2956Swdenk Adds simple_strtoull that returns a 64bit value 2436c40b2956Swdenk 2437c609719bSwdenkLow Level (hardware related) configuration options: 2438dc7c9a1aSwdenk--------------------------------------------------- 2439c609719bSwdenk 24406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE: 2441c609719bSwdenk Cache Line Size of the CPU. 2442c609719bSwdenk 24436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR: 2444c609719bSwdenk Default address of the IMMR after system reset. 24452535d602Swdenk 24462535d602Swdenk Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU, 24472535d602Swdenk and RPXsuper) to be able to adjust the position of 24482535d602Swdenk the IMMR register after a reset. 2449c609719bSwdenk 24507f6c2cbcSwdenk- Floppy Disk Support: 24516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FDC_DRIVE_NUMBER 24527f6c2cbcSwdenk 24537f6c2cbcSwdenk the default drive number (default value 0) 24547f6c2cbcSwdenk 24556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_ISA_IO_STRIDE 24567f6c2cbcSwdenk 245711ccc33fSMarcel Ziswiler defines the spacing between FDC chipset registers 24587f6c2cbcSwdenk (default value 1) 24597f6c2cbcSwdenk 24606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_ISA_IO_OFFSET 24617f6c2cbcSwdenk 24627f6c2cbcSwdenk defines the offset of register from address. It 24637f6c2cbcSwdenk depends on which part of the data bus is connected to 246411ccc33fSMarcel Ziswiler the FDC chipset. (default value 0) 24657f6c2cbcSwdenk 24666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and 24676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their 24687f6c2cbcSwdenk default value. 24697f6c2cbcSwdenk 24706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD if CONFIG_SYS_FDC_HW_INIT is defined, then the function 24717f6c2cbcSwdenk fdc_hw_init() is called at the beginning of the FDC 24727f6c2cbcSwdenk setup. fdc_hw_init() must be provided by the board 24737f6c2cbcSwdenk source code. It is used to make hardware dependant 24747f6c2cbcSwdenk initializations. 24757f6c2cbcSwdenk 24766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR: Physical address of the Internal Memory. 247725d6712aSwdenk DO NOT CHANGE unless you know exactly what you're 247825d6712aSwdenk doing! (11-4) [MPC8xx/82xx systems only] 2479c609719bSwdenk 24806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR: 2481c609719bSwdenk 24827152b1d0Swdenk Start address of memory area that can be used for 2483c609719bSwdenk initial data and stack; please note that this must be 2484c609719bSwdenk writable memory that is working WITHOUT special 2485c609719bSwdenk initialization, i. e. you CANNOT use normal RAM which 2486c609719bSwdenk will become available only after programming the 2487c609719bSwdenk memory controller and running certain initialization 2488c609719bSwdenk sequences. 2489c609719bSwdenk 2490c609719bSwdenk U-Boot uses the following memory types: 2491c609719bSwdenk - MPC8xx and MPC8260: IMMR (internal memory of the CPU) 2492c609719bSwdenk - MPC824X: data cache 2493c609719bSwdenk - PPC4xx: data cache 2494c609719bSwdenk 24956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET: 2496c609719bSwdenk 2497c609719bSwdenk Offset of the initial data structure in the memory 24986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually 24996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial 2500c609719bSwdenk data is located at the end of the available space 25016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD (sometimes written as (CONFIG_SYS_INIT_RAM_END - 25026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just 25036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR + 25046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_GBL_DATA_OFFSET) downward. 2505c609719bSwdenk 2506c609719bSwdenk Note: 2507c609719bSwdenk On the MPC824X (or other systems that use the data 2508c609719bSwdenk cache for initial memory) the address chosen for 25096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must 2510c609719bSwdenk point to an otherwise UNUSED address space between 2511c609719bSwdenk the top of RAM and the start of the PCI space. 2512c609719bSwdenk 25136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6) 2514c609719bSwdenk 25156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR: System Protection Control (11-9) 2516c609719bSwdenk 25176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26) 2518c609719bSwdenk 25196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31) 2520c609719bSwdenk 25216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30) 2522c609719bSwdenk 25236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27) 2524c609719bSwdenk 25256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM: 2526c609719bSwdenk SDRAM timing 2527c609719bSwdenk 25286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA: 2529c609719bSwdenk periodic timer for refresh 2530c609719bSwdenk 25316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER: Debug Event Register (37-47) 2532c609719bSwdenk 25336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM, 25346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP, 25356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM, 25366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BR1_PRELIM: 2537c609719bSwdenk Memory Controller Definitions: BR0/1 and OR0/1 (FLASH) 2538c609719bSwdenk 2539c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE, 25406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM, 25416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM: 2542c609719bSwdenk Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM) 2543c609719bSwdenk 25446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K, 25456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL: 2546c609719bSwdenk Machine Mode Register and Memory Periodic Timer 2547c609719bSwdenk Prescaler definitions (SDRAM timing) 2548c609719bSwdenk 25496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]: 2550c609719bSwdenk enable I2C microcode relocation patch (MPC8xx); 2551c609719bSwdenk define relocation offset in DPRAM [DSP2] 2552c609719bSwdenk 25536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]: 2554b423d055SHeiko Schocher enable SMC microcode relocation patch (MPC8xx); 2555b423d055SHeiko Schocher define relocation offset in DPRAM [SMC1] 2556b423d055SHeiko Schocher 25576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]: 2558c609719bSwdenk enable SPI microcode relocation patch (MPC8xx); 2559c609719bSwdenk define relocation offset in DPRAM [SCC4] 2560c609719bSwdenk 25616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK: 2562c609719bSwdenk Use OSCM clock mode on MBX8xx board. Be careful, 2563c609719bSwdenk wrong setting might damage your board. Read 2564c609719bSwdenk doc/README.MBX before setting this variable! 2565c609719bSwdenk 25666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only) 2567ea909b76Swdenk Offset of the bootmode word in DPRAM used by post 2568ea909b76Swdenk (Power On Self Tests). This definition overrides 2569ea909b76Swdenk #define'd default value in commproc.h resp. 2570ea909b76Swdenk cpm_8260.h. 2571ea909b76Swdenk 25726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB, 25736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL, 25746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS, 25756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB, 25766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START, 25776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL, 25786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE, 25796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only) 25805d232d0eSwdenk Overrides the default PCI memory map in cpu/mpc8260/pci.c if set. 25815d232d0eSwdenk 2582bb99ad6dSBen Warren- CONFIG_SPD_EEPROM 2583218ca724SWolfgang Denk Get DDR timing information from an I2C EEPROM. Common 2584218ca724SWolfgang Denk with pluggable memory modules such as SODIMMs 2585218ca724SWolfgang Denk 2586bb99ad6dSBen Warren SPD_EEPROM_ADDRESS 2587bb99ad6dSBen Warren I2C address of the SPD EEPROM 2588bb99ad6dSBen Warren 25896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM 2590218ca724SWolfgang Denk If SPD EEPROM is on an I2C bus other than the first 2591218ca724SWolfgang Denk one, specify here. Note that the value must resolve 2592218ca724SWolfgang Denk to something your driver can deal with. 2593bb99ad6dSBen Warren 25946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0 2595218ca724SWolfgang Denk Only for 83xx systems. If specified, then DDR should 2596218ca724SWolfgang Denk be configured using CS0 and CS1 instead of CS2 and CS3. 25972ad6b513STimur Tabi 25986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0 2599218ca724SWolfgang Denk Only for 83xx systems. If specified, then DDR should 2600218ca724SWolfgang Denk be configured using CS0 and CS1 instead of CS2 and CS3. 26012ad6b513STimur Tabi 2602c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12] 2603c26e454dSwdenk Define to enable FEC[12] on a 8xx series processor. 2604c26e454dSwdenk 2605c26e454dSwdenk- CONFIG_FEC[12]_PHY 2606c26e454dSwdenk Define to the hardcoded PHY address which corresponds 26076e592385Swdenk to the given FEC; i. e. 2608c26e454dSwdenk #define CONFIG_FEC1_PHY 4 2609c26e454dSwdenk means that the PHY with address 4 is connected to FEC1 2610c26e454dSwdenk 2611c26e454dSwdenk When set to -1, means to probe for first available. 2612c26e454dSwdenk 2613c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR 2614c26e454dSwdenk The PHY does not have a RXERR line (RMII only). 2615c26e454dSwdenk (so program the FEC to ignore it). 2616c26e454dSwdenk 2617c26e454dSwdenk- CONFIG_RMII 2618c26e454dSwdenk Enable RMII mode for all FECs. 2619c26e454dSwdenk Note that this is a global option, we can't 2620c26e454dSwdenk have one FEC in standard MII mode and another in RMII mode. 2621c26e454dSwdenk 26225cf91d6bSwdenk- CONFIG_CRC32_VERIFY 26235cf91d6bSwdenk Add a verify option to the crc32 command. 26245cf91d6bSwdenk The syntax is: 26255cf91d6bSwdenk 26265cf91d6bSwdenk => crc32 -v <address> <count> <crc32> 26275cf91d6bSwdenk 26285cf91d6bSwdenk Where address/count indicate a memory area 26295cf91d6bSwdenk and crc32 is the correct crc32 which the 26305cf91d6bSwdenk area should have. 26315cf91d6bSwdenk 263256523f12Swdenk- CONFIG_LOOPW 263356523f12Swdenk Add the "loopw" memory command. This only takes effect if 2634602ad3b3SJon Loeliger the memory commands are activated globally (CONFIG_CMD_MEM). 263556523f12Swdenk 26367b466641Sstroese- CONFIG_MX_CYCLIC 26377b466641Sstroese Add the "mdc" and "mwc" memory commands. These are cyclic 26387b466641Sstroese "md/mw" commands. 26397b466641Sstroese Examples: 26407b466641Sstroese 26417b466641Sstroese => mdc.b 10 4 500 26427b466641Sstroese This command will print 4 bytes (10,11,12,13) each 500 ms. 26437b466641Sstroese 26447b466641Sstroese => mwc.l 100 12345678 10 26457b466641Sstroese This command will write 12345678 to address 100 all 10 ms. 26467b466641Sstroese 26477b466641Sstroese This only takes effect if the memory commands are activated 2648602ad3b3SJon Loeliger globally (CONFIG_CMD_MEM). 26497b466641Sstroese 26508aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT 26518aa1a2d1Swdenk- CONFIG_SKIP_RELOCATE_UBOOT 26528aa1a2d1Swdenk 26538aa1a2d1Swdenk [ARM only] If these variables are defined, then 26548aa1a2d1Swdenk certain low level initializations (like setting up 26558aa1a2d1Swdenk the memory controller) are omitted and/or U-Boot does 26568aa1a2d1Swdenk not relocate itself into RAM. 26578aa1a2d1Swdenk Normally these variables MUST NOT be defined. The 26588aa1a2d1Swdenk only exception is when U-Boot is loaded (to RAM) by 26598aa1a2d1Swdenk some other boot loader or by a debugger which 266011ccc33fSMarcel Ziswiler performs these initializations itself. 26618aa1a2d1Swdenk 2662400558b5Swdenk 2663c609719bSwdenkBuilding the Software: 2664c609719bSwdenk====================== 2665c609719bSwdenk 2666218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments 2667218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support 2668218ca724SWolfgang Denkall possibly existing versions of cross development tools in all 2669218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we 2670218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK) 2671218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot. 2672c609719bSwdenk 2673218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you 2674218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case, 2675218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell. 2676218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are 2677218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter: 2678c609719bSwdenk 2679218ca724SWolfgang Denk $ CROSS_COMPILE=ppc_4xx- 2680218ca724SWolfgang Denk $ export CROSS_COMPILE 2681c609719bSwdenk 2682c609719bSwdenkU-Boot is intended to be simple to build. After installing the 2683c609719bSwdenksources you must configure U-Boot for one specific board type. This 2684c609719bSwdenkis done by typing: 2685c609719bSwdenk 2686c609719bSwdenk make NAME_config 2687c609719bSwdenk 2688218ca724SWolfgang Denkwhere "NAME_config" is the name of one of the existing configu- 2689218ca724SWolfgang Denkrations; see the main Makefile for supported names. 269054387ac9Swdenk 2691c609719bSwdenkNote: for some board special configuration names may exist; check if 2692c609719bSwdenk additional information is available from the board vendor; for 26932729af9dSwdenk instance, the TQM823L systems are available without (standard) 26942729af9dSwdenk or with LCD support. You can select such additional "features" 269511ccc33fSMarcel Ziswiler when choosing the configuration, i. e. 2696c609719bSwdenk 26972729af9dSwdenk make TQM823L_config 26982729af9dSwdenk - will configure for a plain TQM823L, i. e. no LCD support 2699c609719bSwdenk 2700c609719bSwdenk make TQM823L_LCD_config 2701c609719bSwdenk - will configure for a TQM823L with U-Boot console on LCD 2702c609719bSwdenk 2703c609719bSwdenk etc. 2704c609719bSwdenk 2705c609719bSwdenk 2706c609719bSwdenkFinally, type "make all", and you should get some working U-Boot 27077152b1d0Swdenkimages ready for download to / installation on your system: 2708c609719bSwdenk 2709c609719bSwdenk- "u-boot.bin" is a raw binary image 2710c609719bSwdenk- "u-boot" is an image in ELF binary format 2711c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format 2712c609719bSwdenk 2713baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved 2714baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change 2715baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory: 2716baf31249SMarian Balakowicz 2717baf31249SMarian Balakowicz1. Add O= to the make command line invocations: 2718baf31249SMarian Balakowicz 2719baf31249SMarian Balakowicz make O=/tmp/build distclean 2720baf31249SMarian Balakowicz make O=/tmp/build NAME_config 2721baf31249SMarian Balakowicz make O=/tmp/build all 2722baf31249SMarian Balakowicz 2723baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location: 2724baf31249SMarian Balakowicz 2725baf31249SMarian Balakowicz export BUILD_DIR=/tmp/build 2726baf31249SMarian Balakowicz make distclean 2727baf31249SMarian Balakowicz make NAME_config 2728baf31249SMarian Balakowicz make all 2729baf31249SMarian Balakowicz 2730baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment 2731baf31249SMarian Balakowiczvariable. 2732baf31249SMarian Balakowicz 2733c609719bSwdenk 2734c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so 2735c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of 2736c609719bSwdenknative "make". 2737c609719bSwdenk 2738c609719bSwdenk 2739c609719bSwdenkIf the system board that you have is not listed, then you will need 2740c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these 2741c609719bSwdenksteps: 2742c609719bSwdenk 2743c609719bSwdenk1. Add a new configuration option for your board to the toplevel 274485ec0bccSwdenk "Makefile" and to the "MAKEALL" script, using the existing 274585ec0bccSwdenk entries as examples. Note that here and at many other places 27467152b1d0Swdenk boards and other names are listed in alphabetical sort order. Please 274785ec0bccSwdenk keep this order. 2748c609719bSwdenk2. Create a new directory to hold your board specific code. Add any 274985ec0bccSwdenk files you need. In your board directory, you will need at least 275085ec0bccSwdenk the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds". 275185ec0bccSwdenk3. Create a new configuration file "include/configs/<board>.h" for 275285ec0bccSwdenk your board 2753c609719bSwdenk3. If you're porting U-Boot to a new CPU, then also create a new 2754c609719bSwdenk directory to hold your CPU specific code. Add any files you need. 275585ec0bccSwdenk4. Run "make <board>_config" with your new name. 2756c609719bSwdenk5. Type "make", and you should get a working "u-boot.srec" file 2757c609719bSwdenk to be installed on your target system. 275885ec0bccSwdenk6. Debug and solve any problems that might arise. 2759c609719bSwdenk [Of course, this last step is much harder than it sounds.] 2760c609719bSwdenk 2761c609719bSwdenk 2762c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.: 2763c609719bSwdenk============================================================== 2764c609719bSwdenk 2765c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board 2766c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to 2767c609719bSwdenkprovide feedback to the other developers. The feedback normally takes 2768c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest 2769218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources. 2770c609719bSwdenk 2771c609719bSwdenkBut before you submit such a patch, please verify that your modifi- 2772c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of 2773c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so, 2774c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot 2775c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can 27767152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE' 2777218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools 2778218ca724SWolfgang Denkyou can type 2779c609719bSwdenk 2780c609719bSwdenk CROSS_COMPILE=ppc_8xx- MAKEALL 2781c609719bSwdenk 2782c609719bSwdenkor to build on a native PowerPC system you can type 2783c609719bSwdenk 2784c609719bSwdenk CROSS_COMPILE=' ' MAKEALL 2785c609719bSwdenk 2786218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build 2787218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by 2788218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target 2789218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and 2790218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default 2791218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment 2792218ca724SWolfgang Denkvariable. For example: 2793baf31249SMarian Balakowicz 2794baf31249SMarian Balakowicz export BUILD_DIR=/tmp/build 2795baf31249SMarian Balakowicz export MAKEALL_LOGDIR=/tmp/log 2796baf31249SMarian Balakowicz CROSS_COMPILE=ppc_8xx- MAKEALL 2797baf31249SMarian Balakowicz 2798218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build, 2799218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean 2800218ca724SWolfgang Denkduring the whole build process. 2801baf31249SMarian Balakowicz 2802baf31249SMarian Balakowicz 2803c609719bSwdenkSee also "U-Boot Porting Guide" below. 2804c609719bSwdenk 2805c609719bSwdenk 2806c609719bSwdenkMonitor Commands - Overview: 2807c609719bSwdenk============================ 2808c609719bSwdenk 2809c609719bSwdenkgo - start application at address 'addr' 2810c609719bSwdenkrun - run commands in an environment variable 2811c609719bSwdenkbootm - boot application image from memory 2812c609719bSwdenkbootp - boot image via network using BootP/TFTP protocol 2813c609719bSwdenktftpboot- boot image via network using TFTP protocol 2814c609719bSwdenk and env variables "ipaddr" and "serverip" 2815c609719bSwdenk (and eventually "gatewayip") 2816c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol 2817c609719bSwdenkdiskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd' 2818c609719bSwdenkloads - load S-Record file over serial line 2819c609719bSwdenkloadb - load binary file over serial line (kermit mode) 2820c609719bSwdenkmd - memory display 2821c609719bSwdenkmm - memory modify (auto-incrementing) 2822c609719bSwdenknm - memory modify (constant address) 2823c609719bSwdenkmw - memory write (fill) 2824c609719bSwdenkcp - memory copy 2825c609719bSwdenkcmp - memory compare 2826c609719bSwdenkcrc32 - checksum calculation 2827c609719bSwdenkimd - i2c memory display 2828c609719bSwdenkimm - i2c memory modify (auto-incrementing) 2829c609719bSwdenkinm - i2c memory modify (constant address) 2830c609719bSwdenkimw - i2c memory write (fill) 2831c609719bSwdenkicrc32 - i2c checksum calculation 2832c609719bSwdenkiprobe - probe to discover valid I2C chip addresses 2833c609719bSwdenkiloop - infinite loop on address range 2834c609719bSwdenkisdram - print SDRAM configuration information 2835c609719bSwdenksspi - SPI utility commands 2836c609719bSwdenkbase - print or set address offset 2837c609719bSwdenkprintenv- print environment variables 2838c609719bSwdenksetenv - set environment variables 2839c609719bSwdenksaveenv - save environment variables to persistent storage 2840c609719bSwdenkprotect - enable or disable FLASH write protection 2841c609719bSwdenkerase - erase FLASH memory 2842c609719bSwdenkflinfo - print FLASH memory information 2843c609719bSwdenkbdinfo - print Board Info structure 2844c609719bSwdenkiminfo - print header information for application image 2845c609719bSwdenkconinfo - print console devices and informations 2846c609719bSwdenkide - IDE sub-system 2847c609719bSwdenkloop - infinite loop on address range 284856523f12Swdenkloopw - infinite write loop on address range 2849c609719bSwdenkmtest - simple RAM test 2850c609719bSwdenkicache - enable or disable instruction cache 2851c609719bSwdenkdcache - enable or disable data cache 2852c609719bSwdenkreset - Perform RESET of the CPU 2853c609719bSwdenkecho - echo args to console 2854c609719bSwdenkversion - print monitor version 2855c609719bSwdenkhelp - print online help 2856c609719bSwdenk? - alias for 'help' 2857c609719bSwdenk 2858c609719bSwdenk 2859c609719bSwdenkMonitor Commands - Detailed Description: 2860c609719bSwdenk======================================== 2861c609719bSwdenk 2862c609719bSwdenkTODO. 2863c609719bSwdenk 2864c609719bSwdenkFor now: just type "help <command>". 2865c609719bSwdenk 2866c609719bSwdenk 2867c609719bSwdenkEnvironment Variables: 2868c609719bSwdenk====================== 2869c609719bSwdenk 2870c609719bSwdenkU-Boot supports user configuration using Environment Variables which 2871c609719bSwdenkcan be made persistent by saving to Flash memory. 2872c609719bSwdenk 2873c609719bSwdenkEnvironment Variables are set using "setenv", printed using 2874c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv" 2875c609719bSwdenkwithout a value can be used to delete a variable from the 2876c609719bSwdenkenvironment. As long as you don't save the environment you are 2877c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the 2878c609719bSwdenkenvironment is erased by accident, a default environment is provided. 2879c609719bSwdenk 2880c609719bSwdenkSome configuration options can be set using Environment Variables: 2881c609719bSwdenk 2882c609719bSwdenk baudrate - see CONFIG_BAUDRATE 2883c609719bSwdenk 2884c609719bSwdenk bootdelay - see CONFIG_BOOTDELAY 2885c609719bSwdenk 2886c609719bSwdenk bootcmd - see CONFIG_BOOTCOMMAND 2887c609719bSwdenk 2888c609719bSwdenk bootargs - Boot arguments when booting an RTOS image 2889c609719bSwdenk 2890c609719bSwdenk bootfile - Name of the image to load with TFTP 2891c609719bSwdenk 28927d721e34SBartlomiej Sieka bootm_low - Memory range available for image processing in the bootm 28937d721e34SBartlomiej Sieka command can be restricted. This variable is given as 28947d721e34SBartlomiej Sieka a hexadecimal number and defines lowest address allowed 28957d721e34SBartlomiej Sieka for use by the bootm command. See also "bootm_size" 28967d721e34SBartlomiej Sieka environment variable. Address defined by "bootm_low" is 28977d721e34SBartlomiej Sieka also the base of the initial memory mapping for the Linux 28986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD kernel -- see the description of CONFIG_SYS_BOOTMAPSZ. 28997d721e34SBartlomiej Sieka 29007d721e34SBartlomiej Sieka bootm_size - Memory range available for image processing in the bootm 29017d721e34SBartlomiej Sieka command can be restricted. This variable is given as 29027d721e34SBartlomiej Sieka a hexadecimal number and defines the size of the region 29037d721e34SBartlomiej Sieka allowed for use by the bootm command. See also "bootm_low" 29047d721e34SBartlomiej Sieka environment variable. 29057d721e34SBartlomiej Sieka 29064bae9090SBartlomiej Sieka updatefile - Location of the software update file on a TFTP server, used 29074bae9090SBartlomiej Sieka by the automatic software update feature. Please refer to 29084bae9090SBartlomiej Sieka documentation in doc/README.update for more details. 29094bae9090SBartlomiej Sieka 2910c609719bSwdenk autoload - if set to "no" (any string beginning with 'n'), 2911c609719bSwdenk "bootp" will just load perform a lookup of the 2912c609719bSwdenk configuration from the BOOTP server, but not try to 2913c609719bSwdenk load any image using TFTP 2914c609719bSwdenk 29153310c549SMarian Balakowicz autoscript - if set to "yes" commands like "loadb", "loady", 29163310c549SMarian Balakowicz "bootp", "tftpb", "rarpboot" and "nfs" will attempt 29173310c549SMarian Balakowicz to automatically run script images (by internally 29183310c549SMarian Balakowicz calling "autoscript"). 29193310c549SMarian Balakowicz 29203310c549SMarian Balakowicz autoscript_uname - if script image is in a format (FIT) this 29213310c549SMarian Balakowicz variable is used to get script subimage unit name. 29223310c549SMarian Balakowicz 2923c609719bSwdenk autostart - if set to "yes", an image loaded using the "bootp", 2924c609719bSwdenk "rarpboot", "tftpboot" or "diskboot" commands will 2925c609719bSwdenk be automatically started (by internally calling 2926c609719bSwdenk "bootm") 2927c609719bSwdenk 29284a6fd34bSwdenk If set to "no", a standalone image passed to the 29294a6fd34bSwdenk "bootm" command will be copied to the load address 29304a6fd34bSwdenk (and eventually uncompressed), but NOT be started. 29314a6fd34bSwdenk This can be used to load and uncompress arbitrary 29324a6fd34bSwdenk data. 29334a6fd34bSwdenk 293417ea1177Swdenk i2cfast - (PPC405GP|PPC405EP only) 293517ea1177Swdenk if set to 'y' configures Linux I2C driver for fast 293617ea1177Swdenk mode (400kHZ). This environment variable is used in 293717ea1177Swdenk initialization code. So, for changes to be effective 293817ea1177Swdenk it must be saved and board must be reset. 293917ea1177Swdenk 2940c609719bSwdenk initrd_high - restrict positioning of initrd images: 2941c609719bSwdenk If this variable is not set, initrd images will be 2942c609719bSwdenk copied to the highest possible address in RAM; this 2943c609719bSwdenk is usually what you want since it allows for 2944c609719bSwdenk maximum initrd size. If for some reason you want to 2945c609719bSwdenk make sure that the initrd image is loaded below the 29466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BOOTMAPSZ limit, you can set this environment 2947c609719bSwdenk variable to a value of "no" or "off" or "0". 2948c609719bSwdenk Alternatively, you can set it to a maximum upper 2949c609719bSwdenk address to use (U-Boot will still check that it 2950c609719bSwdenk does not overwrite the U-Boot stack and data). 2951c609719bSwdenk 2952c609719bSwdenk For instance, when you have a system with 16 MB 29537152b1d0Swdenk RAM, and want to reserve 4 MB from use by Linux, 2954c609719bSwdenk you can do this by adding "mem=12M" to the value of 2955c609719bSwdenk the "bootargs" variable. However, now you must make 29567152b1d0Swdenk sure that the initrd image is placed in the first 2957c609719bSwdenk 12 MB as well - this can be done with 2958c609719bSwdenk 2959c609719bSwdenk setenv initrd_high 00c00000 2960c609719bSwdenk 296138b99261Swdenk If you set initrd_high to 0xFFFFFFFF, this is an 296238b99261Swdenk indication to U-Boot that all addresses are legal 296338b99261Swdenk for the Linux kernel, including addresses in flash 296438b99261Swdenk memory. In this case U-Boot will NOT COPY the 296538b99261Swdenk ramdisk at all. This may be useful to reduce the 296638b99261Swdenk boot time on your system, but requires that this 296738b99261Swdenk feature is supported by your Linux kernel. 296838b99261Swdenk 2969c609719bSwdenk ipaddr - IP address; needed for tftpboot command 2970c609719bSwdenk 2971c609719bSwdenk loadaddr - Default load address for commands like "bootp", 2972dc7c9a1aSwdenk "rarpboot", "tftpboot", "loadb" or "diskboot" 2973c609719bSwdenk 2974c609719bSwdenk loads_echo - see CONFIG_LOADS_ECHO 2975c609719bSwdenk 2976c609719bSwdenk serverip - TFTP server IP address; needed for tftpboot command 2977c609719bSwdenk 2978c609719bSwdenk bootretry - see CONFIG_BOOT_RETRY_TIME 2979c609719bSwdenk 2980c609719bSwdenk bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR 2981c609719bSwdenk 2982c609719bSwdenk bootstopkey - see CONFIG_AUTOBOOT_STOP_STR 2983c609719bSwdenk 2984a3d991bdSwdenk ethprime - When CONFIG_NET_MULTI is enabled controls which 2985a3d991bdSwdenk interface is used first. 2986a3d991bdSwdenk 2987a3d991bdSwdenk ethact - When CONFIG_NET_MULTI is enabled controls which 2988a3d991bdSwdenk interface is currently active. For example you 2989a3d991bdSwdenk can do the following 2990a3d991bdSwdenk 2991a3d991bdSwdenk => setenv ethact FEC ETHERNET 2992a3d991bdSwdenk => ping 192.168.0.1 # traffic sent on FEC ETHERNET 2993a3d991bdSwdenk => setenv ethact SCC ETHERNET 2994a3d991bdSwdenk => ping 10.0.0.1 # traffic sent on SCC ETHERNET 2995a3d991bdSwdenk 2996e1692577SMatthias Fuchs ethrotate - When set to "no" U-Boot does not go through all 2997e1692577SMatthias Fuchs available network interfaces. 2998e1692577SMatthias Fuchs It just stays at the currently selected interface. 2999e1692577SMatthias Fuchs 3000a3d991bdSwdenk netretry - When set to "no" each network operation will 3001a3d991bdSwdenk either succeed or fail without retrying. 30026e592385Swdenk When set to "once" the network operation will 30036e592385Swdenk fail when all the available network interfaces 30046e592385Swdenk are tried once without success. 3005a3d991bdSwdenk Useful on scripts which control the retry operation 3006a3d991bdSwdenk themselves. 3007a3d991bdSwdenk 3008a1cf027aSJean-Christophe PLAGNIOL-VILLARD npe_ucode - see CONFIG_IXP4XX_NPE_EXT_UCOD 300911ccc33fSMarcel Ziswiler if set load address for the NPE microcode 3010a1cf027aSJean-Christophe PLAGNIOL-VILLARD 301128cb9375SWolfgang Denk tftpsrcport - If this is set, the value is used for TFTP's 3012ecb0ccd9SWolfgang Denk UDP source port. 3013ecb0ccd9SWolfgang Denk 301428cb9375SWolfgang Denk tftpdstport - If this is set, the value is used for TFTP's UDP 301528cb9375SWolfgang Denk destination port instead of the Well Know Port 69. 301628cb9375SWolfgang Denk 3017a3d991bdSwdenk vlan - When set to a value < 4095 the traffic over 301811ccc33fSMarcel Ziswiler Ethernet is encapsulated/received over 802.1q 3019a3d991bdSwdenk VLAN tagged frames. 3020c609719bSwdenk 3021c609719bSwdenkThe following environment variables may be used and automatically 3022c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"), 3023c609719bSwdenkdepending the information provided by your boot server: 3024c609719bSwdenk 3025c609719bSwdenk bootfile - see above 3026c609719bSwdenk dnsip - IP address of your Domain Name Server 3027fe389a82Sstroese dnsip2 - IP address of your secondary Domain Name Server 3028c609719bSwdenk gatewayip - IP address of the Gateway (Router) to use 3029c609719bSwdenk hostname - Target hostname 3030c609719bSwdenk ipaddr - see above 3031c609719bSwdenk netmask - Subnet Mask 3032c609719bSwdenk rootpath - Pathname of the root filesystem on the NFS server 3033c609719bSwdenk serverip - see above 3034c609719bSwdenk 3035c609719bSwdenk 3036c609719bSwdenkThere are two special Environment Variables: 3037c609719bSwdenk 3038c609719bSwdenk serial# - contains hardware identification information such 3039c609719bSwdenk as type string and/or serial number 3040c609719bSwdenk ethaddr - Ethernet address 3041c609719bSwdenk 3042c609719bSwdenkThese variables can be set only once (usually during manufacturing of 3043c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables 3044c609719bSwdenkonce they have been set once. 3045c609719bSwdenk 3046c609719bSwdenk 3047c1551ea8SstroeseFurther special Environment Variables: 3048c1551ea8Sstroese 3049c1551ea8Sstroese ver - Contains the U-Boot version string as printed 3050c1551ea8Sstroese with the "version" command. This variable is 3051c1551ea8Sstroese readonly (see CONFIG_VERSION_VARIABLE). 3052c1551ea8Sstroese 3053c1551ea8Sstroese 3054c609719bSwdenkPlease note that changes to some configuration parameters may take 3055c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-). 3056c609719bSwdenk 3057c609719bSwdenk 3058f07771ccSwdenkCommand Line Parsing: 3059f07771ccSwdenk===================== 3060f07771ccSwdenk 3061f07771ccSwdenkThere are two different command line parsers available with U-Boot: 30627152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell: 3063f07771ccSwdenk 3064f07771ccSwdenkOld, simple command line parser: 3065f07771ccSwdenk-------------------------------- 3066f07771ccSwdenk 3067f07771ccSwdenk- supports environment variables (through setenv / saveenv commands) 3068f07771ccSwdenk- several commands on one line, separated by ';' 3069fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax 3070f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\', 3071f07771ccSwdenk for example: 3072fe126d8bSWolfgang Denk setenv bootcmd bootm \${address} 3073f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example: 3074f07771ccSwdenk setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off' 3075f07771ccSwdenk 3076f07771ccSwdenkHush shell: 3077f07771ccSwdenk----------- 3078f07771ccSwdenk 3079f07771ccSwdenk- similar to Bourne shell, with control structures like 3080f07771ccSwdenk if...then...else...fi, for...do...done; while...do...done, 3081f07771ccSwdenk until...do...done, ... 3082f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv 3083f07771ccSwdenk commands) and local shell variables (through standard shell syntax 3084f07771ccSwdenk "name=value"); only environment variables can be used with "run" 3085f07771ccSwdenk command 3086f07771ccSwdenk 3087f07771ccSwdenkGeneral rules: 3088f07771ccSwdenk-------------- 3089f07771ccSwdenk 3090f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run" 3091f07771ccSwdenk command) contains several commands separated by semicolon, and 3092f07771ccSwdenk one of these commands fails, then the remaining commands will be 3093f07771ccSwdenk executed anyway. 3094f07771ccSwdenk 3095f07771ccSwdenk(2) If you execute several variables with one call to run (i. e. 309611ccc33fSMarcel Ziswiler calling run with a list of variables as arguments), any failing 3097f07771ccSwdenk command will cause "run" to terminate, i. e. the remaining 3098f07771ccSwdenk variables are not executed. 3099f07771ccSwdenk 3100c609719bSwdenkNote for Redundant Ethernet Interfaces: 3101c609719bSwdenk======================================= 3102c609719bSwdenk 310311ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports 3104c609719bSwdenksuch configurations and is capable of automatic selection of a 31057152b1d0Swdenk"working" interface when needed. MAC assignment works as follows: 3106c609719bSwdenk 3107c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding 3108c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0), 3109c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ... 3110c609719bSwdenk 3111c609719bSwdenkIf the network interface stores some valid MAC address (for instance 3112c609719bSwdenkin SROM), this is used as default address if there is NO correspon- 3113c609719bSwdenkding setting in the environment; if the corresponding environment 3114c609719bSwdenkvariable is set, this overrides the settings in the card; that means: 3115c609719bSwdenk 3116c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the 3117c609719bSwdenk environment, the SROM's address is used. 3118c609719bSwdenk 3119c609719bSwdenko If there is no valid address in the SROM, and a definition in the 3120c609719bSwdenk environment exists, then the value from the environment variable is 3121c609719bSwdenk used. 3122c609719bSwdenk 3123c609719bSwdenko If both the SROM and the environment contain a MAC address, and 3124c609719bSwdenk both addresses are the same, this MAC address is used. 3125c609719bSwdenk 3126c609719bSwdenko If both the SROM and the environment contain a MAC address, and the 3127c609719bSwdenk addresses differ, the value from the environment is used and a 3128c609719bSwdenk warning is printed. 3129c609719bSwdenk 3130c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error 3131c609719bSwdenk is raised. 3132c609719bSwdenk 3133c609719bSwdenk 3134c609719bSwdenkImage Formats: 3135c609719bSwdenk============== 3136c609719bSwdenk 31373310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on) 31383310c549SMarian Balakowiczimages in two formats: 31393310c549SMarian Balakowicz 31403310c549SMarian BalakowiczNew uImage format (FIT) 31413310c549SMarian Balakowicz----------------------- 31423310c549SMarian Balakowicz 31433310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar 31443310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple 31453310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by 31463310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory. 31473310c549SMarian Balakowicz 31483310c549SMarian Balakowicz 31493310c549SMarian BalakowiczOld uImage format 31503310c549SMarian Balakowicz----------------- 31513310c549SMarian Balakowicz 31523310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything, 31533310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for 31543310c549SMarian Balakowiczdetails; basically, the header defines the following image properties: 3155c609719bSwdenk 3156c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD, 3157c609719bSwdenk 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks, 3158f5ed9e39SPeter Tyser LynxOS, pSOS, QNX, RTEMS, INTEGRITY; 3159f5ed9e39SPeter Tyser Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS, 3160f5ed9e39SPeter Tyser INTEGRITY). 31617b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86, 31623d1e8a9dSwdenk IA64, MIPS, NIOS, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit; 31637b64fef3SWolfgang Denk Currently supported: ARM, AVR32, Intel x86, MIPS, NIOS, PowerPC). 3164c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2) 3165c609719bSwdenk* Load Address 3166c609719bSwdenk* Entry Point 3167c609719bSwdenk* Image Name 3168c609719bSwdenk* Image Timestamp 3169c609719bSwdenk 3170c609719bSwdenkThe header is marked by a special Magic Number, and both the header 3171c609719bSwdenkand the data portions of the image are secured against corruption by 3172c609719bSwdenkCRC32 checksums. 3173c609719bSwdenk 3174c609719bSwdenk 3175c609719bSwdenkLinux Support: 3176c609719bSwdenk============== 3177c609719bSwdenk 3178c609719bSwdenkAlthough U-Boot should support any OS or standalone application 31797152b1d0Swdenkeasily, the main focus has always been on Linux during the design of 3180c609719bSwdenkU-Boot. 3181c609719bSwdenk 3182c609719bSwdenkU-Boot includes many features that so far have been part of some 3183c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any 3184c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image; 3185c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation 31867152b1d0Swdenkserves several purposes: 3187c609719bSwdenk 3188c609719bSwdenk- the same features can be used for other OS or standalone 3189c609719bSwdenk applications (for instance: using compressed images to reduce the 3190c609719bSwdenk Flash memory footprint) 3191c609719bSwdenk 3192c609719bSwdenk- it becomes much easier to port new Linux kernel versions because 31937152b1d0Swdenk lots of low-level, hardware dependent stuff are done by U-Boot 3194c609719bSwdenk 3195c609719bSwdenk- the same Linux kernel image can now be used with different "initrd" 3196c609719bSwdenk images; of course this also means that different kernel images can 3197c609719bSwdenk be run with the same "initrd". This makes testing easier (you don't 3198c609719bSwdenk have to build a new "zImage.initrd" Linux image when you just 3199c609719bSwdenk change a file in your "initrd"). Also, a field-upgrade of the 3200c609719bSwdenk software is easier now. 3201c609719bSwdenk 3202c609719bSwdenk 3203c609719bSwdenkLinux HOWTO: 3204c609719bSwdenk============ 3205c609719bSwdenk 3206c609719bSwdenkPorting Linux to U-Boot based systems: 3207c609719bSwdenk--------------------------------------- 3208c609719bSwdenk 3209c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to 3210c609719bSwdenkconfigure the Linux device drivers for use with your target hardware 3211c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to 3212c609719bSwdenkLinux :-). 3213c609719bSwdenk 3214c609719bSwdenkBut now you can ignore ALL boot loader code (in arch/ppc/mbxboot). 3215c609719bSwdenk 3216c609719bSwdenkJust make sure your machine specific header file (for instance 3217c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board 32181dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h, 32191dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value 32206d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR. 3221c609719bSwdenk 3222c609719bSwdenk 3223c609719bSwdenkConfiguring the Linux kernel: 3224c609719bSwdenk----------------------------- 3225c609719bSwdenk 3226c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root 3227c609719bSwdenkdevice (initial ramdisk, NFS) for your target system. 3228c609719bSwdenk 3229c609719bSwdenk 3230c609719bSwdenkBuilding a Linux Image: 3231c609719bSwdenk----------------------- 3232c609719bSwdenk 323324ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are 323424ee89b9Swdenknot used. If you use recent kernel source, a new build target 323524ee89b9Swdenk"uImage" will exist which automatically builds an image usable by 323624ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target, 323724ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a 323824ee89b9Swdenk100% compatible format. 3239c609719bSwdenk 3240c609719bSwdenkExample: 3241c609719bSwdenk 3242c609719bSwdenk make TQM850L_config 3243c609719bSwdenk make oldconfig 3244c609719bSwdenk make dep 324524ee89b9Swdenk make uImage 3246c609719bSwdenk 324724ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to 324824ee89b9Swdenkencapsulate a compressed Linux kernel image with header information, 324924ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing: 3250c609719bSwdenk 325124ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format): 325224ee89b9Swdenk 325324ee89b9Swdenk* convert the kernel into a raw binary image: 325424ee89b9Swdenk 325524ee89b9Swdenk ${CROSS_COMPILE}-objcopy -O binary \ 325624ee89b9Swdenk -R .note -R .comment \ 325724ee89b9Swdenk -S vmlinux linux.bin 325824ee89b9Swdenk 325924ee89b9Swdenk* compress the binary image: 326024ee89b9Swdenk 326124ee89b9Swdenk gzip -9 linux.bin 326224ee89b9Swdenk 326324ee89b9Swdenk* package compressed binary image for U-Boot: 326424ee89b9Swdenk 326524ee89b9Swdenk mkimage -A ppc -O linux -T kernel -C gzip \ 326624ee89b9Swdenk -a 0 -e 0 -n "Linux Kernel Image" \ 326724ee89b9Swdenk -d linux.bin.gz uImage 326824ee89b9Swdenk 326924ee89b9Swdenk 327024ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use 327124ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or 327224ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64 327324ee89b9Swdenkbyte header containing information about target architecture, 327424ee89b9Swdenkoperating system, image type, compression method, entry points, time 327524ee89b9Swdenkstamp, CRC32 checksums, etc. 327624ee89b9Swdenk 327724ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and 327824ee89b9Swdenkprint the header information, or to build new images. 3279c609719bSwdenk 3280c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information 3281c609719bSwdenkcontained in the header of an existing U-Boot image; this includes 3282c609719bSwdenkchecksum verification: 3283c609719bSwdenk 3284c609719bSwdenk tools/mkimage -l image 3285c609719bSwdenk -l ==> list image header information 3286c609719bSwdenk 3287c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image 3288c609719bSwdenkfrom a "data file" which is used as image payload: 3289c609719bSwdenk 3290c609719bSwdenk tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \ 3291c609719bSwdenk -n name -d data_file image 3292c609719bSwdenk -A ==> set architecture to 'arch' 3293c609719bSwdenk -O ==> set operating system to 'os' 3294c609719bSwdenk -T ==> set image type to 'type' 3295c609719bSwdenk -C ==> set compression type 'comp' 3296c609719bSwdenk -a ==> set load address to 'addr' (hex) 3297c609719bSwdenk -e ==> set entry point to 'ep' (hex) 3298c609719bSwdenk -n ==> set image name to 'name' 3299c609719bSwdenk -d ==> use image data from 'datafile' 3300c609719bSwdenk 330169459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load 330269459791Swdenkaddress (0x00000000), but the entry point address depends on the 330369459791Swdenkkernel version: 3304c609719bSwdenk 3305c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C, 330624ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000. 3307c609719bSwdenk 3308c609719bSwdenkSo a typical call to build a U-Boot image would read: 3309c609719bSwdenk 331024ee89b9Swdenk -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 331124ee89b9Swdenk > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \ 331224ee89b9Swdenk > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz \ 331324ee89b9Swdenk > examples/uImage.TQM850L 331424ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 3315c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 3316c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 3317c609719bSwdenk Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 3318c609719bSwdenk Load Address: 0x00000000 331924ee89b9Swdenk Entry Point: 0x00000000 3320c609719bSwdenk 3321c609719bSwdenkTo verify the contents of the image (or check for corruption): 3322c609719bSwdenk 332324ee89b9Swdenk -> tools/mkimage -l examples/uImage.TQM850L 332424ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 3325c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 3326c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 3327c609719bSwdenk Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 3328c609719bSwdenk Load Address: 0x00000000 332924ee89b9Swdenk Entry Point: 0x00000000 3330c609719bSwdenk 3331c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade 3332c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this 3333c609719bSwdenkneeds more space in Flash, but boots much faster since it does not 3334c609719bSwdenkneed to be uncompressed: 3335c609719bSwdenk 333624ee89b9Swdenk -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz 333724ee89b9Swdenk -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 333824ee89b9Swdenk > -A ppc -O linux -T kernel -C none -a 0 -e 0 \ 333924ee89b9Swdenk > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux \ 334024ee89b9Swdenk > examples/uImage.TQM850L-uncompressed 334124ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 3342c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 3343c609719bSwdenk Image Type: PowerPC Linux Kernel Image (uncompressed) 3344c609719bSwdenk Data Size: 792160 Bytes = 773.59 kB = 0.76 MB 3345c609719bSwdenk Load Address: 0x00000000 334624ee89b9Swdenk Entry Point: 0x00000000 3347c609719bSwdenk 3348c609719bSwdenk 3349c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file 3350c609719bSwdenkwhen your kernel is intended to use an initial ramdisk: 3351c609719bSwdenk 3352c609719bSwdenk -> tools/mkimage -n 'Simple Ramdisk Image' \ 3353c609719bSwdenk > -A ppc -O linux -T ramdisk -C gzip \ 3354c609719bSwdenk > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd 3355c609719bSwdenk Image Name: Simple Ramdisk Image 3356c609719bSwdenk Created: Wed Jan 12 14:01:50 2000 3357c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 3358c609719bSwdenk Data Size: 566530 Bytes = 553.25 kB = 0.54 MB 3359c609719bSwdenk Load Address: 0x00000000 3360c609719bSwdenk Entry Point: 0x00000000 3361c609719bSwdenk 3362c609719bSwdenk 3363c609719bSwdenkInstalling a Linux Image: 3364c609719bSwdenk------------------------- 3365c609719bSwdenk 3366c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface, 3367c609719bSwdenkyou must convert the image to S-Record format: 3368c609719bSwdenk 3369c609719bSwdenk objcopy -I binary -O srec examples/image examples/image.srec 3370c609719bSwdenk 3371c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot 3372c609719bSwdenkimage header, so the resulting S-Record file will be relative to 3373c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to 3374c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads' 3375c609719bSwdenkcommand. 3376c609719bSwdenk 3377c609719bSwdenkExample: install the image to address 0x40100000 (which on the 3378c609719bSwdenkTQM8xxL is in the first Flash bank): 3379c609719bSwdenk 3380c609719bSwdenk => erase 40100000 401FFFFF 3381c609719bSwdenk 3382c609719bSwdenk .......... done 3383c609719bSwdenk Erased 8 sectors 3384c609719bSwdenk 3385c609719bSwdenk => loads 40100000 3386c609719bSwdenk ## Ready for S-Record download ... 3387c609719bSwdenk ~>examples/image.srec 3388c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 12 13 ... 3389c609719bSwdenk ... 3390c609719bSwdenk 15989 15990 15991 15992 3391c609719bSwdenk [file transfer complete] 3392c609719bSwdenk [connected] 3393c609719bSwdenk ## Start Addr = 0x00000000 3394c609719bSwdenk 3395c609719bSwdenk 3396c609719bSwdenkYou can check the success of the download using the 'iminfo' command; 3397c609719bSwdenkthis includes a checksum verification so you can be sure no data 3398c609719bSwdenkcorruption happened: 3399c609719bSwdenk 3400c609719bSwdenk => imi 40100000 3401c609719bSwdenk 3402c609719bSwdenk ## Checking Image at 40100000 ... 3403c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 3404c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 3405c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 3406c609719bSwdenk Load Address: 00000000 3407c609719bSwdenk Entry Point: 0000000c 3408c609719bSwdenk Verifying Checksum ... OK 3409c609719bSwdenk 3410c609719bSwdenk 3411c609719bSwdenkBoot Linux: 3412c609719bSwdenk----------- 3413c609719bSwdenk 3414c609719bSwdenkThe "bootm" command is used to boot an application that is stored in 3415c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents 3416c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as 3417c609719bSwdenkparameters. You can check and modify this variable using the 3418c609719bSwdenk"printenv" and "setenv" commands: 3419c609719bSwdenk 3420c609719bSwdenk 3421c609719bSwdenk => printenv bootargs 3422c609719bSwdenk bootargs=root=/dev/ram 3423c609719bSwdenk 3424c609719bSwdenk => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 3425c609719bSwdenk 3426c609719bSwdenk => printenv bootargs 3427c609719bSwdenk bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 3428c609719bSwdenk 3429c609719bSwdenk => bootm 40020000 3430c609719bSwdenk ## Booting Linux kernel at 40020000 ... 3431c609719bSwdenk Image Name: 2.2.13 for NFS on TQM850L 3432c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 3433c609719bSwdenk Data Size: 381681 Bytes = 372 kB = 0 MB 3434c609719bSwdenk Load Address: 00000000 3435c609719bSwdenk Entry Point: 0000000c 3436c609719bSwdenk Verifying Checksum ... OK 3437c609719bSwdenk Uncompressing Kernel Image ... OK 3438c609719bSwdenk 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 3439c609719bSwdenk Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 3440c609719bSwdenk time_init: decrementer frequency = 187500000/60 3441c609719bSwdenk Calibrating delay loop... 49.77 BogoMIPS 3442c609719bSwdenk Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000] 3443c609719bSwdenk ... 3444c609719bSwdenk 344511ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass 34467152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT 3447c609719bSwdenkformat!) to the "bootm" command: 3448c609719bSwdenk 3449c609719bSwdenk => imi 40100000 40200000 3450c609719bSwdenk 3451c609719bSwdenk ## Checking Image at 40100000 ... 3452c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 3453c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 3454c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 3455c609719bSwdenk Load Address: 00000000 3456c609719bSwdenk Entry Point: 0000000c 3457c609719bSwdenk Verifying Checksum ... OK 3458c609719bSwdenk 3459c609719bSwdenk ## Checking Image at 40200000 ... 3460c609719bSwdenk Image Name: Simple Ramdisk Image 3461c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 3462c609719bSwdenk Data Size: 566530 Bytes = 553 kB = 0 MB 3463c609719bSwdenk Load Address: 00000000 3464c609719bSwdenk Entry Point: 00000000 3465c609719bSwdenk Verifying Checksum ... OK 3466c609719bSwdenk 3467c609719bSwdenk => bootm 40100000 40200000 3468c609719bSwdenk ## Booting Linux kernel at 40100000 ... 3469c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 3470c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 3471c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 3472c609719bSwdenk Load Address: 00000000 3473c609719bSwdenk Entry Point: 0000000c 3474c609719bSwdenk Verifying Checksum ... OK 3475c609719bSwdenk Uncompressing Kernel Image ... OK 3476c609719bSwdenk ## Loading RAMDisk Image at 40200000 ... 3477c609719bSwdenk Image Name: Simple Ramdisk Image 3478c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 3479c609719bSwdenk Data Size: 566530 Bytes = 553 kB = 0 MB 3480c609719bSwdenk Load Address: 00000000 3481c609719bSwdenk Entry Point: 00000000 3482c609719bSwdenk Verifying Checksum ... OK 3483c609719bSwdenk Loading Ramdisk ... OK 3484c609719bSwdenk 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 3485c609719bSwdenk Boot arguments: root=/dev/ram 3486c609719bSwdenk time_init: decrementer frequency = 187500000/60 3487c609719bSwdenk Calibrating delay loop... 49.77 BogoMIPS 3488c609719bSwdenk ... 3489c609719bSwdenk RAMDISK: Compressed image found at block 0 3490c609719bSwdenk VFS: Mounted root (ext2 filesystem). 3491c609719bSwdenk 3492c609719bSwdenk bash# 3493c609719bSwdenk 34940267768eSMatthew McClintockBoot Linux and pass a flat device tree: 34950267768eSMatthew McClintock----------- 34960267768eSMatthew McClintock 34970267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section 34980267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The 34990267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated 35000267768eSMatthew McClintockflat device tree: 35010267768eSMatthew McClintock 35020267768eSMatthew McClintock=> print oftaddr 35030267768eSMatthew McClintockoftaddr=0x300000 35040267768eSMatthew McClintock=> print oft 35050267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb 35060267768eSMatthew McClintock=> tftp $oftaddr $oft 35070267768eSMatthew McClintockSpeed: 1000, full duplex 35080267768eSMatthew McClintockUsing TSEC0 device 35090267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101 35100267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'. 35110267768eSMatthew McClintockLoad address: 0x300000 35120267768eSMatthew McClintockLoading: # 35130267768eSMatthew McClintockdone 35140267768eSMatthew McClintockBytes transferred = 4106 (100a hex) 35150267768eSMatthew McClintock=> tftp $loadaddr $bootfile 35160267768eSMatthew McClintockSpeed: 1000, full duplex 35170267768eSMatthew McClintockUsing TSEC0 device 35180267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2 35190267768eSMatthew McClintockFilename 'uImage'. 35200267768eSMatthew McClintockLoad address: 0x200000 35210267768eSMatthew McClintockLoading:############ 35220267768eSMatthew McClintockdone 35230267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex) 35240267768eSMatthew McClintock=> print loadaddr 35250267768eSMatthew McClintockloadaddr=200000 35260267768eSMatthew McClintock=> print oftaddr 35270267768eSMatthew McClintockoftaddr=0x300000 35280267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr 35290267768eSMatthew McClintock## Booting image at 00200000 ... 35300267768eSMatthew McClintock Image Name: Linux-2.6.17-dirty 35310267768eSMatthew McClintock Image Type: PowerPC Linux Kernel Image (gzip compressed) 35320267768eSMatthew McClintock Data Size: 1029343 Bytes = 1005.2 kB 35330267768eSMatthew McClintock Load Address: 00000000 35340267768eSMatthew McClintock Entry Point: 00000000 35350267768eSMatthew McClintock Verifying Checksum ... OK 35360267768eSMatthew McClintock Uncompressing Kernel Image ... OK 35370267768eSMatthew McClintockBooting using flat device tree at 0x300000 35380267768eSMatthew McClintockUsing MPC85xx ADS machine description 35390267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb 35400267768eSMatthew McClintock[snip] 35410267768eSMatthew McClintock 35420267768eSMatthew McClintock 35436069ff26SwdenkMore About U-Boot Image Types: 35446069ff26Swdenk------------------------------ 35456069ff26Swdenk 35466069ff26SwdenkU-Boot supports the following image types: 35476069ff26Swdenk 35486069ff26Swdenk "Standalone Programs" are directly runnable in the environment 35496069ff26Swdenk provided by U-Boot; it is expected that (if they behave 35506069ff26Swdenk well) you can continue to work in U-Boot after return from 35516069ff26Swdenk the Standalone Program. 35526069ff26Swdenk "OS Kernel Images" are usually images of some Embedded OS which 35536069ff26Swdenk will take over control completely. Usually these programs 35546069ff26Swdenk will install their own set of exception handlers, device 35556069ff26Swdenk drivers, set up the MMU, etc. - this means, that you cannot 35566069ff26Swdenk expect to re-enter U-Boot except by resetting the CPU. 35576069ff26Swdenk "RAMDisk Images" are more or less just data blocks, and their 35586069ff26Swdenk parameters (address, size) are passed to an OS kernel that is 35596069ff26Swdenk being started. 35606069ff26Swdenk "Multi-File Images" contain several images, typically an OS 35616069ff26Swdenk (Linux) kernel image and one or more data images like 35626069ff26Swdenk RAMDisks. This construct is useful for instance when you want 35636069ff26Swdenk to boot over the network using BOOTP etc., where the boot 35646069ff26Swdenk server provides just a single image file, but you want to get 35656069ff26Swdenk for instance an OS kernel and a RAMDisk image. 35666069ff26Swdenk 35676069ff26Swdenk "Multi-File Images" start with a list of image sizes, each 35686069ff26Swdenk image size (in bytes) specified by an "uint32_t" in network 35696069ff26Swdenk byte order. This list is terminated by an "(uint32_t)0". 35706069ff26Swdenk Immediately after the terminating 0 follow the images, one by 35716069ff26Swdenk one, all aligned on "uint32_t" boundaries (size rounded up to 35726069ff26Swdenk a multiple of 4 bytes). 35736069ff26Swdenk 35746069ff26Swdenk "Firmware Images" are binary images containing firmware (like 35756069ff26Swdenk U-Boot or FPGA images) which usually will be programmed to 35766069ff26Swdenk flash memory. 35776069ff26Swdenk 35786069ff26Swdenk "Script files" are command sequences that will be executed by 35796069ff26Swdenk U-Boot's command interpreter; this feature is especially 35806069ff26Swdenk useful when you configure U-Boot to use a real shell (hush) 35816069ff26Swdenk as command interpreter. 35826069ff26Swdenk 3583c609719bSwdenk 3584c609719bSwdenkStandalone HOWTO: 3585c609719bSwdenk================= 3586c609719bSwdenk 3587c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and 3588c609719bSwdenkrun "standalone" applications, which can use some resources of 3589c609719bSwdenkU-Boot like console I/O functions or interrupt services. 3590c609719bSwdenk 3591c609719bSwdenkTwo simple examples are included with the sources: 3592c609719bSwdenk 3593c609719bSwdenk"Hello World" Demo: 3594c609719bSwdenk------------------- 3595c609719bSwdenk 3596c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo 3597c609719bSwdenkapplication; it is automatically compiled when you build U-Boot. 3598c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it 3599c609719bSwdenklike that: 3600c609719bSwdenk 3601c609719bSwdenk => loads 3602c609719bSwdenk ## Ready for S-Record download ... 3603c609719bSwdenk ~>examples/hello_world.srec 3604c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 ... 3605c609719bSwdenk [file transfer complete] 3606c609719bSwdenk [connected] 3607c609719bSwdenk ## Start Addr = 0x00040004 3608c609719bSwdenk 3609c609719bSwdenk => go 40004 Hello World! This is a test. 3610c609719bSwdenk ## Starting application at 0x00040004 ... 3611c609719bSwdenk Hello World 3612c609719bSwdenk argc = 7 3613c609719bSwdenk argv[0] = "40004" 3614c609719bSwdenk argv[1] = "Hello" 3615c609719bSwdenk argv[2] = "World!" 3616c609719bSwdenk argv[3] = "This" 3617c609719bSwdenk argv[4] = "is" 3618c609719bSwdenk argv[5] = "a" 3619c609719bSwdenk argv[6] = "test." 3620c609719bSwdenk argv[7] = "<NULL>" 3621c609719bSwdenk Hit any key to exit ... 3622c609719bSwdenk 3623c609719bSwdenk ## Application terminated, rc = 0x0 3624c609719bSwdenk 3625c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt 3626c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'. 3627c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second. 3628c609719bSwdenkThe interrupt service routine is trivial, just printing a '.' 3629c609719bSwdenkcharacter, but this is just a demo program. The application can be 3630c609719bSwdenkcontrolled by the following keys: 3631c609719bSwdenk 3632c609719bSwdenk ? - print current values og the CPM Timer registers 3633c609719bSwdenk b - enable interrupts and start timer 3634c609719bSwdenk e - stop timer and disable interrupts 3635c609719bSwdenk q - quit application 3636c609719bSwdenk 3637c609719bSwdenk => loads 3638c609719bSwdenk ## Ready for S-Record download ... 3639c609719bSwdenk ~>examples/timer.srec 3640c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 ... 3641c609719bSwdenk [file transfer complete] 3642c609719bSwdenk [connected] 3643c609719bSwdenk ## Start Addr = 0x00040004 3644c609719bSwdenk 3645c609719bSwdenk => go 40004 3646c609719bSwdenk ## Starting application at 0x00040004 ... 3647c609719bSwdenk TIMERS=0xfff00980 3648c609719bSwdenk Using timer 1 3649c609719bSwdenk tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0 3650c609719bSwdenk 3651c609719bSwdenkHit 'b': 3652c609719bSwdenk [q, b, e, ?] Set interval 1000000 us 3653c609719bSwdenk Enabling timer 3654c609719bSwdenkHit '?': 3655c609719bSwdenk [q, b, e, ?] ........ 3656c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0 3657c609719bSwdenkHit '?': 3658c609719bSwdenk [q, b, e, ?] . 3659c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0 3660c609719bSwdenkHit '?': 3661c609719bSwdenk [q, b, e, ?] . 3662c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0 3663c609719bSwdenkHit '?': 3664c609719bSwdenk [q, b, e, ?] . 3665c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0 3666c609719bSwdenkHit 'e': 3667c609719bSwdenk [q, b, e, ?] ...Stopping timer 3668c609719bSwdenkHit 'q': 3669c609719bSwdenk [q, b, e, ?] ## Application terminated, rc = 0x0 3670c609719bSwdenk 3671c609719bSwdenk 367285ec0bccSwdenkMinicom warning: 367385ec0bccSwdenk================ 367485ec0bccSwdenk 36757152b1d0SwdenkOver time, many people have reported problems when trying to use the 367685ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd) 367785ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under 3678f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and 367985ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and 368085ec0bccSwdenkuse "cu" for S-Record download ("loads" command). 368185ec0bccSwdenk 368252f52c14SwdenkNevertheless, if you absolutely want to use it try adding this 368352f52c14Swdenkconfiguration to your "File transfer protocols" section: 368452f52c14Swdenk 368552f52c14Swdenk Name Program Name U/D FullScr IO-Red. Multi 368652f52c14Swdenk X kermit /usr/bin/kermit -i -l %l -s Y U Y N N 368752f52c14Swdenk Y kermit /usr/bin/kermit -i -l %l -r N D Y N N 368852f52c14Swdenk 368952f52c14Swdenk 3690c609719bSwdenkNetBSD Notes: 3691c609719bSwdenk============= 3692c609719bSwdenk 3693c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host 3694c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx). 3695c609719bSwdenk 3696c609719bSwdenkBuilding requires a cross environment; it is known to work on 3697c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also 3698c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make). 3699c609719bSwdenkNote that the cross-powerpc package does not install include files; 3700c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is 3701c609719bSwdenkmissing. This file has to be installed and patched manually: 3702c609719bSwdenk 3703c609719bSwdenk # cd /usr/pkg/cross/powerpc-netbsd/include 3704c609719bSwdenk # mkdir powerpc 3705c609719bSwdenk # ln -s powerpc machine 3706c609719bSwdenk # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h 3707c609719bSwdenk # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST 3708c609719bSwdenk 3709c609719bSwdenkNative builds *don't* work due to incompatibilities between native 3710c609719bSwdenkand U-Boot include files. 3711c609719bSwdenk 3712c609719bSwdenkBooting assumes that (the first part of) the image booted is a 3713c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel 3714c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source 3715c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the 37162a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz 3717c609719bSwdenk 3718c609719bSwdenk 3719c609719bSwdenkImplementation Internals: 3720c609719bSwdenk========================= 3721c609719bSwdenk 3722c609719bSwdenkThe following is not intended to be a complete description of every 3723c609719bSwdenkimplementation detail. However, it should help to understand the 3724c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom 3725c609719bSwdenkhardware. 3726c609719bSwdenk 3727c609719bSwdenk 3728c609719bSwdenkInitial Stack, Global Data: 3729c609719bSwdenk--------------------------- 3730c609719bSwdenk 3731c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot 3732c609719bSwdenkstarts running out of ROM (flash memory), usually without access to 3733c609719bSwdenksystem RAM (because the memory controller is not initialized yet). 3734c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS 3735c609719bSwdenkis not initialized as zero. To be able to get a C environment working 3736c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation 3737c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU 3738c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and 3739c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be 3740c609719bSwdenklocked as (mis-) used as memory, etc. 3741c609719bSwdenk 37427152b1d0Swdenk Chris Hallinan posted a good summary of these issues to the 374343d9616cSwdenk u-boot-users mailing list: 374443d9616cSwdenk 374543d9616cSwdenk Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)? 374643d9616cSwdenk From: "Chris Hallinan" <clh@net1plus.com> 374743d9616cSwdenk Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET) 374843d9616cSwdenk ... 374943d9616cSwdenk 375043d9616cSwdenk Correct me if I'm wrong, folks, but the way I understand it 375143d9616cSwdenk is this: Using DCACHE as initial RAM for Stack, etc, does not 375243d9616cSwdenk require any physical RAM backing up the cache. The cleverness 375343d9616cSwdenk is that the cache is being used as a temporary supply of 375443d9616cSwdenk necessary storage before the SDRAM controller is setup. It's 375511ccc33fSMarcel Ziswiler beyond the scope of this list to explain the details, but you 375643d9616cSwdenk can see how this works by studying the cache architecture and 375743d9616cSwdenk operation in the architecture and processor-specific manuals. 375843d9616cSwdenk 375943d9616cSwdenk OCM is On Chip Memory, which I believe the 405GP has 4K. It 376043d9616cSwdenk is another option for the system designer to use as an 376111ccc33fSMarcel Ziswiler initial stack/RAM area prior to SDRAM being available. Either 376243d9616cSwdenk option should work for you. Using CS 4 should be fine if your 376343d9616cSwdenk board designers haven't used it for something that would 376443d9616cSwdenk cause you grief during the initial boot! It is frequently not 376543d9616cSwdenk used. 376643d9616cSwdenk 37676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere 376843d9616cSwdenk with your processor/board/system design. The default value 376943d9616cSwdenk you will find in any recent u-boot distribution in 37708a316c9bSStefan Roese walnut.h should work for you. I'd set it to a value larger 377143d9616cSwdenk than your SDRAM module. If you have a 64MB SDRAM module, set 377243d9616cSwdenk it above 400_0000. Just make sure your board has no resources 377343d9616cSwdenk that are supposed to respond to that address! That code in 377443d9616cSwdenk start.S has been around a while and should work as is when 377543d9616cSwdenk you get the config right. 377643d9616cSwdenk 377743d9616cSwdenk -Chris Hallinan 377843d9616cSwdenk DS4.COM, Inc. 377943d9616cSwdenk 3780c609719bSwdenkIt is essential to remember this, since it has some impact on the C 3781c609719bSwdenkcode for the initialization procedures: 3782c609719bSwdenk 3783c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt 3784c609719bSwdenk to write it. 3785c609719bSwdenk 378611ccc33fSMarcel Ziswiler* Do not use any uninitialized global data (or implicitely initialized 3787c609719bSwdenk as zero data - BSS segment) at all - this is undefined, initiali- 37887152b1d0Swdenk zation is performed later (when relocating to RAM). 3789c609719bSwdenk 3790c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like 3791c609719bSwdenk that. 3792c609719bSwdenk 3793c609719bSwdenkHaving only the stack as writable memory limits means we cannot use 3794c609719bSwdenknormal global data to share information beween the code. But it 3795c609719bSwdenkturned out that the implementation of U-Boot can be greatly 3796c609719bSwdenksimplified by making a global data structure (gd_t) available to all 3797c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_ 3798c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of 3799c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we 3800c609719bSwdenkplace a pointer (gd) to the global data into a register which we 3801c609719bSwdenkreserve for this purpose. 3802c609719bSwdenk 38037152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the 3804c609719bSwdenkrelevant (E)ABI specifications for the current architecture, and by 3805c609719bSwdenkGCC's implementation. 3806c609719bSwdenk 3807c609719bSwdenkFor PowerPC, the following registers have specific use: 3808c609719bSwdenk R1: stack pointer 3809e7670f6cSWolfgang Denk R2: reserved for system use 3810c609719bSwdenk R3-R4: parameter passing and return values 3811c609719bSwdenk R5-R10: parameter passing 3812c609719bSwdenk R13: small data area pointer 3813c609719bSwdenk R30: GOT pointer 3814c609719bSwdenk R31: frame pointer 3815c609719bSwdenk 3816c609719bSwdenk (U-Boot also uses R14 as internal GOT pointer.) 3817c609719bSwdenk 3818e7670f6cSWolfgang Denk ==> U-Boot will use R2 to hold a pointer to the global data 3819c609719bSwdenk 3820c609719bSwdenk Note: on PPC, we could use a static initializer (since the 3821c609719bSwdenk address of the global data structure is known at compile time), 3822c609719bSwdenk but it turned out that reserving a register results in somewhat 3823c609719bSwdenk smaller code - although the code savings are not that big (on 3824c609719bSwdenk average for all boards 752 bytes for the whole U-Boot image, 3825c609719bSwdenk 624 text + 127 data). 3826c609719bSwdenk 38274c58eb55SMike FrysingerOn Blackfin, the normal C ABI (except for P5) is followed as documented here: 38284c58eb55SMike Frysinger http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface 38294c58eb55SMike Frysinger 38304c58eb55SMike Frysinger ==> U-Boot will use P5 to hold a pointer to the global data 38314c58eb55SMike Frysinger 3832c609719bSwdenkOn ARM, the following registers are used: 3833c609719bSwdenk 3834c609719bSwdenk R0: function argument word/integer result 3835c609719bSwdenk R1-R3: function argument word 3836c609719bSwdenk R9: GOT pointer 3837c609719bSwdenk R10: stack limit (used only if stack checking if enabled) 3838c609719bSwdenk R11: argument (frame) pointer 3839c609719bSwdenk R12: temporary workspace 3840c609719bSwdenk R13: stack pointer 3841c609719bSwdenk R14: link register 3842c609719bSwdenk R15: program counter 3843c609719bSwdenk 3844c609719bSwdenk ==> U-Boot will use R8 to hold a pointer to the global data 3845c609719bSwdenk 3846d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope, 3847d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much. 3848c609719bSwdenk 3849c609719bSwdenkMemory Management: 3850c609719bSwdenk------------------ 3851c609719bSwdenk 3852c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the 3853c609719bSwdenkMMU is not used either for address mapping nor for memory protection. 3854c609719bSwdenk 3855c609719bSwdenkThe available memory is mapped to fixed addresses using the memory 3856c609719bSwdenkcontroller. In this process, a contiguous block is formed for each 3857c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several 3858c609719bSwdenkphysical memory banks. 3859c609719bSwdenk 3860c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on 3861c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After 3862c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself 3863c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some 38646d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN 3865c609719bSwdenkconfiguration setting]. Below that, a structure with global Board 3866c609719bSwdenkInfo data is placed, followed by the stack (growing downward). 3867c609719bSwdenk 3868c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB 3869c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF). 3870c609719bSwdenk 3871c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like 3872c609719bSwdenkthis: 3873c609719bSwdenk 3874c609719bSwdenk 0x0000 0000 Exception Vector code 3875c609719bSwdenk : 3876c609719bSwdenk 0x0000 1FFF 3877c609719bSwdenk 0x0000 2000 Free for Application Use 3878c609719bSwdenk : 3879c609719bSwdenk : 3880c609719bSwdenk 3881c609719bSwdenk : 3882c609719bSwdenk : 3883c609719bSwdenk 0x00FB FF20 Monitor Stack (Growing downward) 3884c609719bSwdenk 0x00FB FFAC Board Info Data and permanent copy of global data 3885c609719bSwdenk 0x00FC 0000 Malloc Arena 3886c609719bSwdenk : 3887c609719bSwdenk 0x00FD FFFF 3888c609719bSwdenk 0x00FE 0000 RAM Copy of Monitor Code 3889c609719bSwdenk ... eventually: LCD or video framebuffer 3890c609719bSwdenk ... eventually: pRAM (Protected RAM - unchanged by reset) 3891c609719bSwdenk 0x00FF FFFF [End of RAM] 3892c609719bSwdenk 3893c609719bSwdenk 3894c609719bSwdenkSystem Initialization: 3895c609719bSwdenk---------------------- 3896c609719bSwdenk 3897c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point 389811ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset 3899c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory. 39007152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address. 3901c609719bSwdenkTo be able to implement the initialization code in C, a (small!) 3902c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs 3903c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked 3904c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core, 3905c609719bSwdenkthe caches and the SIU. 3906c609719bSwdenk 3907c609719bSwdenkNext, all (potentially) available memory banks are mapped using a 3908c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries 3909c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash 3910c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is 3911c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a 3912c609719bSwdenksimple memory test is run that determines the size of the SDRAM 3913c609719bSwdenkbanks. 3914c609719bSwdenk 3915c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of 39167152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first 3917c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address 3918c609719bSwdenk0x00000000, with any additional banks following immediately to create 3919c609719bSwdenkcontiguous memory starting from 0. 3920c609719bSwdenk 3921c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area 3922c609719bSwdenkand allocates memory for use by malloc() and for the global Board 3923c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM 3924c609719bSwdenkpages, and the final stack is set up. 3925c609719bSwdenk 3926c609719bSwdenkOnly after this relocation will you have a "normal" C environment; 3927c609719bSwdenkuntil that you are restricted in several ways, mostly because you are 3928c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a 3929c609719bSwdenknew address in RAM. 3930c609719bSwdenk 3931c609719bSwdenk 3932c609719bSwdenkU-Boot Porting Guide: 3933c609719bSwdenk---------------------- 3934c609719bSwdenk 3935c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing 39366aff3115Swdenklist, October 2002] 3937c609719bSwdenk 3938c609719bSwdenk 3939c609719bSwdenkint main (int argc, char *argv[]) 3940c609719bSwdenk{ 3941c609719bSwdenk sighandler_t no_more_time; 3942c609719bSwdenk 3943c609719bSwdenk signal (SIGALRM, no_more_time); 3944c609719bSwdenk alarm (PROJECT_DEADLINE - toSec (3 * WEEK)); 3945c609719bSwdenk 3946c609719bSwdenk if (available_money > available_manpower) { 3947c609719bSwdenk pay consultant to port U-Boot; 3948c609719bSwdenk return 0; 3949c609719bSwdenk } 3950c609719bSwdenk 3951c609719bSwdenk Download latest U-Boot source; 3952c609719bSwdenk 39536aff3115Swdenk Subscribe to u-boot-users mailing list; 39546aff3115Swdenk 3955c609719bSwdenk if (clueless) { 3956c609719bSwdenk email ("Hi, I am new to U-Boot, how do I get started?"); 3957c609719bSwdenk } 3958c609719bSwdenk 3959c609719bSwdenk while (learning) { 3960c609719bSwdenk Read the README file in the top level directory; 39617cb22f97Swdenk Read http://www.denx.de/twiki/bin/view/DULG/Manual ; 3962c609719bSwdenk Read the source, Luke; 3963c609719bSwdenk } 3964c609719bSwdenk 3965c609719bSwdenk if (available_money > toLocalCurrency ($2500)) { 3966c609719bSwdenk Buy a BDI2000; 3967c609719bSwdenk } else { 3968c609719bSwdenk Add a lot of aggravation and time; 3969c609719bSwdenk } 3970c609719bSwdenk 3971c609719bSwdenk Create your own board support subdirectory; 3972c609719bSwdenk 39736aff3115Swdenk Create your own board config file; 39746aff3115Swdenk 3975c609719bSwdenk while (!running) { 3976c609719bSwdenk do { 3977c609719bSwdenk Add / modify source code; 3978c609719bSwdenk } until (compiles); 3979c609719bSwdenk Debug; 3980c609719bSwdenk if (clueless) 3981c609719bSwdenk email ("Hi, I am having problems..."); 3982c609719bSwdenk } 3983c609719bSwdenk Send patch file to Wolfgang; 3984c609719bSwdenk 3985c609719bSwdenk return 0; 3986c609719bSwdenk} 3987c609719bSwdenk 3988c609719bSwdenkvoid no_more_time (int sig) 3989c609719bSwdenk{ 3990c609719bSwdenk hire_a_guru(); 3991c609719bSwdenk} 3992c609719bSwdenk 3993c609719bSwdenk 3994c609719bSwdenkCoding Standards: 3995c609719bSwdenk----------------- 3996c609719bSwdenk 3997c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel 39982c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script 39992c051651SDetlev Zundel"scripts/Lindent" in your Linux kernel source directory. In sources 40002c051651SDetlev Zundeloriginating from U-Boot a style corresponding to "Lindent -pcs" (adding 40012c051651SDetlev Zundelspaces before parameters to function calls) is actually used. 4002c609719bSwdenk 40032c051651SDetlev ZundelSource files originating from a different project (for example the 40042c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not 40052c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those 40062c051651SDetlev Zundelsources. 40072c051651SDetlev Zundel 40082c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in 40092c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//) 40102c051651SDetlev Zundelin your code. 4011c609719bSwdenk 4012c178d3daSwdenkPlease also stick to the following formatting rules: 4013180d3f74Swdenk- remove any trailing white space 4014180d3f74Swdenk- use TAB characters for indentation, not spaces 4015180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds 4016180d3f74Swdenk- do not add more than 2 empty lines to source files 4017180d3f74Swdenk- do not add trailing empty lines to source files 4018180d3f74Swdenk 4019c609719bSwdenkSubmissions which do not conform to the standards may be returned 4020c609719bSwdenkwith a request to reformat the changes. 4021c609719bSwdenk 4022c609719bSwdenk 4023c609719bSwdenkSubmitting Patches: 4024c609719bSwdenk------------------- 4025c609719bSwdenk 4026c609719bSwdenkSince the number of patches for U-Boot is growing, we need to 4027c609719bSwdenkestablish some rules. Submissions which do not conform to these rules 4028c609719bSwdenkmay be rejected, even when they contain important and valuable stuff. 4029c609719bSwdenk 403090dc6704SwdenkPatches shall be sent to the u-boot-users mailing list. 4031c609719bSwdenk 40320d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details. 4033218ca724SWolfgang Denk 4034c609719bSwdenkWhen you send a patch, please include the following information with 4035c609719bSwdenkit: 4036c609719bSwdenk 4037c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes 4038c609719bSwdenk this bug. Please try to include a way of demonstrating that the 4039c609719bSwdenk patch actually fixes something. 4040c609719bSwdenk 4041c609719bSwdenk* For new features: a description of the feature and your 4042c609719bSwdenk implementation. 4043c609719bSwdenk 4044c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch) 4045c609719bSwdenk 4046c609719bSwdenk* For major contributions, your entry to the CREDITS file 4047c609719bSwdenk 4048c609719bSwdenk* When you add support for a new board, don't forget to add this 4049c609719bSwdenk board to the MAKEALL script, too. 4050c609719bSwdenk 4051c609719bSwdenk* If your patch adds new configuration options, don't forget to 4052c609719bSwdenk document these in the README file. 4053c609719bSwdenk 4054218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly* 4055218ca724SWolfgang Denk recommended) you can easily generate the patch using the 4056218ca724SWolfgang Denk "git-format-patch". If you then use "git-send-email" to send it to 4057218ca724SWolfgang Denk the U-Boot mailing list, you will avoid most of the common problems 4058218ca724SWolfgang Denk with some other mail clients. 4059c609719bSwdenk 4060218ca724SWolfgang Denk If you cannot use git, use "diff -purN OLD NEW". If your version of 4061218ca724SWolfgang Denk diff does not support these options, then get the latest version of 4062218ca724SWolfgang Denk GNU diff. 40636dff5529Swdenk 4064218ca724SWolfgang Denk The current directory when running this command shall be the parent 4065218ca724SWolfgang Denk directory of the U-Boot source tree (i. e. please make sure that 4066218ca724SWolfgang Denk your patch includes sufficient directory information for the 4067218ca724SWolfgang Denk affected files). 4068218ca724SWolfgang Denk 4069218ca724SWolfgang Denk We prefer patches as plain text. MIME attachments are discouraged, 4070218ca724SWolfgang Denk and compressed attachments must not be used. 4071c609719bSwdenk 407252f52c14Swdenk* If one logical set of modifications affects or creates several 407352f52c14Swdenk files, all these changes shall be submitted in a SINGLE patch file. 407452f52c14Swdenk 407552f52c14Swdenk* Changesets that contain different, unrelated modifications shall be 407652f52c14Swdenk submitted as SEPARATE patches, one patch per changeset. 407752f52c14Swdenk 407852f52c14Swdenk 4079c609719bSwdenkNotes: 4080c609719bSwdenk 4081c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched 4082c609719bSwdenk source tree and make sure that no errors or warnings are reported 4083c609719bSwdenk for any of the boards. 4084c609719bSwdenk 4085c609719bSwdenk* Keep your modifications to the necessary minimum: A patch 4086c609719bSwdenk containing several unrelated changes or arbitrary reformats will be 4087c609719bSwdenk returned with a request to re-formatting / split it. 4088c609719bSwdenk 4089c609719bSwdenk* If you modify existing code, make sure that your new code does not 4090c609719bSwdenk add to the memory footprint of the code ;-) Small is beautiful! 4091c609719bSwdenk When adding new features, these should compile conditionally only 4092c609719bSwdenk (using #ifdef), and the resulting code with the new feature 4093c609719bSwdenk disabled must not need more memory than the old code without your 4094c609719bSwdenk modification. 409590dc6704Swdenk 409690dc6704Swdenk* Remember that there is a size limit of 40 kB per message on the 4097218ca724SWolfgang Denk u-boot-users mailing list. Bigger patches will be moderated. If 4098218ca724SWolfgang Denk they are reasonable and not bigger than 100 kB, they will be 4099218ca724SWolfgang Denk acknowledged. Even bigger patches should be avoided. 4100