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 15411dadd54Swdenk - i386 Files specific to i386 CPUs 15511dadd54Swdenk - ixp Files specific to Intel XScale IXP CPUs 156b330990cSDaniel Hellstrom - leon2 Files specific to Gaisler LEON2 SPARC CPU 1571e9a164eSDaniel Hellstrom - leon3 Files specific to Gaisler LEON3 SPARC CPU 158983fda83Swdenk - mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs 1591552af70STsiChungLiew - mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs 1608e585f02STsiChung Liew - mcf532x Files specific to Freescale ColdFire MCF5329 CPUs 1618ae158cdSTsiChungLiew - mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs 16257a12720STsiChungLiew - mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs 16311dadd54Swdenk - mips Files specific to MIPS CPUs 164983fda83Swdenk - mpc5xx Files specific to Freescale MPC5xx CPUs 165983fda83Swdenk - mpc5xxx Files specific to Freescale MPC5xxx CPUs 166983fda83Swdenk - mpc8xx Files specific to Freescale MPC8xx CPUs 167983fda83Swdenk - mpc8220 Files specific to Freescale MPC8220 CPUs 168983fda83Swdenk - mpc824x Files specific to Freescale MPC824x CPUs 169983fda83Swdenk - mpc8260 Files specific to Freescale MPC8260 CPUs 170983fda83Swdenk - mpc85xx Files specific to Freescale MPC85xx CPUs 17111dadd54Swdenk - nios Files specific to Altera NIOS CPUs 1725c952cf0Swdenk - nios2 Files specific to Altera Nios-II CPUs 1730c8721a4SWolfgang Denk - ppc4xx Files specific to AMCC PowerPC 4xx CPUs 17411dadd54Swdenk - pxa Files specific to Intel XScale PXA CPUs 17511dadd54Swdenk - s3c44b0 Files specific to Samsung S3C44B0 CPUs 17611dadd54Swdenk - sa1100 Files specific to Intel StrongARM SA1100 CPUs 177c609719bSwdenk- disk Code for disk drive partition handling 178c609719bSwdenk- doc Documentation (don't expect too much) 1797152b1d0Swdenk- drivers Commonly used device drivers 180c609719bSwdenk- dtt Digital Thermometer and Thermostat drivers 181c609719bSwdenk- examples Example code for standalone applications, etc. 182c609719bSwdenk- include Header Files 18311dadd54Swdenk- lib_arm Files generic to ARM architecture 1847b64fef3SWolfgang Denk- lib_avr32 Files generic to AVR32 architecture 18511dadd54Swdenk- lib_generic Files generic to all architectures 18611dadd54Swdenk- lib_i386 Files generic to i386 architecture 18711dadd54Swdenk- lib_m68k Files generic to m68k architecture 18811dadd54Swdenk- lib_mips Files generic to MIPS architecture 18911dadd54Swdenk- lib_nios Files generic to NIOS architecture 19011dadd54Swdenk- lib_ppc Files generic to PowerPC architecture 191c2f02da2SDaniel Hellstrom- lib_sparc Files generic to SPARC architecture 192213bf8c8SGerald Van Baren- libfdt Library files to support flattened device trees 193c609719bSwdenk- net Networking code 194c609719bSwdenk- post Power On Self Test 195c609719bSwdenk- rtc Real Time Clock drivers 196c609719bSwdenk- tools Tools to build S-Record or U-Boot images, etc. 197c609719bSwdenk 198c609719bSwdenkSoftware Configuration: 199c609719bSwdenk======================= 200c609719bSwdenk 201c609719bSwdenkConfiguration is usually done using C preprocessor defines; the 202c609719bSwdenkrationale behind that is to avoid dead code whenever possible. 203c609719bSwdenk 204c609719bSwdenkThere are two classes of configuration variables: 205c609719bSwdenk 206c609719bSwdenk* Configuration _OPTIONS_: 207c609719bSwdenk These are selectable by the user and have names beginning with 208c609719bSwdenk "CONFIG_". 209c609719bSwdenk 210c609719bSwdenk* Configuration _SETTINGS_: 211c609719bSwdenk These depend on the hardware etc. and should not be meddled with if 212c609719bSwdenk you don't know what you're doing; they have names beginning with 213c609719bSwdenk "CFG_". 214c609719bSwdenk 215c609719bSwdenkLater we will add a configuration tool - probably similar to or even 216c609719bSwdenkidentical to what's used for the Linux kernel. Right now, we have to 217c609719bSwdenkdo the configuration by hand, which means creating some symbolic 218c609719bSwdenklinks and editing some configuration files. We use the TQM8xxL boards 219c609719bSwdenkas an example here. 220c609719bSwdenk 221c609719bSwdenk 222c609719bSwdenkSelection of Processor Architecture and Board Type: 223c609719bSwdenk--------------------------------------------------- 224c609719bSwdenk 225c609719bSwdenkFor all supported boards there are ready-to-use default 226c609719bSwdenkconfigurations available; just type "make <board_name>_config". 227c609719bSwdenk 228c609719bSwdenkExample: For a TQM823L module type: 229c609719bSwdenk 230c609719bSwdenk cd u-boot 231c609719bSwdenk make TQM823L_config 232c609719bSwdenk 23311ccc33fSMarcel ZiswilerFor the Cogent platform, you need to specify the CPU type as well; 234c609719bSwdenke.g. "make cogent_mpc8xx_config". And also configure the cogent 235c609719bSwdenkdirectory according to the instructions in cogent/README. 236c609719bSwdenk 237c609719bSwdenk 238c609719bSwdenkConfiguration Options: 239c609719bSwdenk---------------------- 240c609719bSwdenk 241c609719bSwdenkConfiguration depends on the combination of board and CPU type; all 242c609719bSwdenksuch information is kept in a configuration file 243c609719bSwdenk"include/configs/<board_name>.h". 244c609719bSwdenk 245c609719bSwdenkExample: For a TQM823L module, all configuration settings are in 246c609719bSwdenk"include/configs/TQM823L.h". 247c609719bSwdenk 248c609719bSwdenk 2497f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux 2507f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to 2517f6c2cbcSwdenkbuild a config tool - later. 2527f6c2cbcSwdenk 2537f6c2cbcSwdenk 254c609719bSwdenkThe following options need to be configured: 255c609719bSwdenk 2562628114eSKim Phillips- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX. 257c609719bSwdenk 2582628114eSKim Phillips- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS. 2596ccec449SWolfgang Denk 2606ccec449SWolfgang Denk- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined) 26109ea0de0SHaavard Skinnemoen Define exactly one, e.g. CONFIG_ATSTK1002 262c609719bSwdenk 263c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined) 264c609719bSwdenk Define exactly one of 265c609719bSwdenk CONFIG_CMA286_60_OLD 266c609719bSwdenk--- FIXME --- not tested yet: 267c609719bSwdenk CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P, 268c609719bSwdenk CONFIG_CMA287_23, CONFIG_CMA287_50 269c609719bSwdenk 270c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined) 271c609719bSwdenk Define exactly one of 272c609719bSwdenk CONFIG_CMA101, CONFIG_CMA102 273c609719bSwdenk 274c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined) 275c609719bSwdenk Define one or more of 276c609719bSwdenk CONFIG_CMA302 277c609719bSwdenk 278c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined) 279c609719bSwdenk Define one or more of 280c609719bSwdenk CONFIG_LCD_HEARTBEAT - update a character position on 28111ccc33fSMarcel Ziswiler the LCD display every second with 282c609719bSwdenk a "rotator" |\-/|\-/ 283c609719bSwdenk 2842535d602Swdenk- Board flavour: (if CONFIG_MPC8260ADS is defined) 2852535d602Swdenk CONFIG_ADSTYPE 2862535d602Swdenk Possible values are: 2872535d602Swdenk CFG_8260ADS - original MPC8260ADS 288180d3f74Swdenk CFG_8266ADS - MPC8266ADS 28954387ac9Swdenk CFG_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR 29004a85b3bSwdenk CFG_8272ADS - MPC8272ADS 2912535d602Swdenk 292c609719bSwdenk- MPC824X Family Member (if CONFIG_MPC824X is defined) 293c609719bSwdenk Define exactly one of 294c609719bSwdenk CONFIG_MPC8240, CONFIG_MPC8245 295c609719bSwdenk 29611ccc33fSMarcel Ziswiler- 8xx CPU Options: (if using an MPC8xx CPU) 29766ca92a5Swdenk CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if 29866ca92a5Swdenk get_gclk_freq() cannot work 2995da627a4Swdenk e.g. if there is no 32KHz 3005da627a4Swdenk reference PIT/RTC clock 30166ca92a5Swdenk CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK 30266ca92a5Swdenk or XTAL/EXTAL) 303c609719bSwdenk 30466ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU): 30566ca92a5Swdenk CFG_8xx_CPUCLK_MIN 30666ca92a5Swdenk CFG_8xx_CPUCLK_MAX 30766ca92a5Swdenk CONFIG_8xx_CPUCLK_DEFAULT 30875d1ea7fSwdenk See doc/README.MPC866 30975d1ea7fSwdenk 31075d1ea7fSwdenk CFG_MEASURE_CPUCLK 31175d1ea7fSwdenk 31275d1ea7fSwdenk Define this to measure the actual CPU clock instead 31375d1ea7fSwdenk of relying on the correctness of the configured 31475d1ea7fSwdenk values. Mostly useful for board bringup to make sure 31575d1ea7fSwdenk the PLL is locked at the intended frequency. Note 31675d1ea7fSwdenk that this requires a (stable) reference clock (32 kHz 31766ca92a5Swdenk RTC clock or CFG_8XX_XIN) 31875d1ea7fSwdenk 3190b953ffcSMarkus Klotzbuecher- Intel Monahans options: 3200b953ffcSMarkus Klotzbuecher CFG_MONAHANS_RUN_MODE_OSC_RATIO 3210b953ffcSMarkus Klotzbuecher 3220b953ffcSMarkus Klotzbuecher Defines the Monahans run mode to oscillator 3230b953ffcSMarkus Klotzbuecher ratio. Valid values are 8, 16, 24, 31. The core 3240b953ffcSMarkus Klotzbuecher frequency is this value multiplied by 13 MHz. 3250b953ffcSMarkus Klotzbuecher 3260b953ffcSMarkus Klotzbuecher CFG_MONAHANS_TURBO_RUN_MODE_RATIO 3270b953ffcSMarkus Klotzbuecher 3280b953ffcSMarkus Klotzbuecher Defines the Monahans turbo mode to oscillator 3290b953ffcSMarkus Klotzbuecher ratio. Valid values are 1 (default if undefined) and 3300b953ffcSMarkus Klotzbuecher 2. The core frequency as calculated above is multiplied 3310b953ffcSMarkus Klotzbuecher by this value. 3320b953ffcSMarkus Klotzbuecher 3335da627a4Swdenk- Linux Kernel Interface: 334c609719bSwdenk CONFIG_CLOCKS_IN_MHZ 335c609719bSwdenk 336c609719bSwdenk U-Boot stores all clock information in Hz 337c609719bSwdenk internally. For binary compatibility with older Linux 338c609719bSwdenk kernels (which expect the clocks passed in the 339c609719bSwdenk bd_info data to be in MHz) the environment variable 340c609719bSwdenk "clocks_in_mhz" can be defined so that U-Boot 341c609719bSwdenk converts clock data to MHZ before passing it to the 342c609719bSwdenk Linux kernel. 343c609719bSwdenk When CONFIG_CLOCKS_IN_MHZ is defined, a definition of 344c609719bSwdenk "clocks_in_mhz=1" is automatically included in the 345c609719bSwdenk default environment. 346c609719bSwdenk 3475da627a4Swdenk CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only] 3485da627a4Swdenk 34911ccc33fSMarcel Ziswiler When transferring memsize parameter to linux, some versions 3505da627a4Swdenk expect it to be in bytes, others in MB. 3515da627a4Swdenk Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes. 3525da627a4Swdenk 353fec6d9eeSGerald Van Baren CONFIG_OF_LIBFDT 354f57f70aaSWolfgang Denk 355f57f70aaSWolfgang Denk New kernel versions are expecting firmware settings to be 356213bf8c8SGerald Van Baren passed using flattened device trees (based on open firmware 357213bf8c8SGerald Van Baren concepts). 358213bf8c8SGerald Van Baren 359213bf8c8SGerald Van Baren CONFIG_OF_LIBFDT 360213bf8c8SGerald Van Baren * New libfdt-based support 361213bf8c8SGerald Van Baren * Adds the "fdt" command 3623bb342fcSKim Phillips * The bootm command automatically updates the fdt 363213bf8c8SGerald Van Baren 364f57f70aaSWolfgang Denk OF_CPU - The proper name of the cpus node. 365c2871f03SKumar Gala OF_SOC - The proper name of the soc node. 366f57f70aaSWolfgang Denk OF_TBCLK - The timebase frequency. 367c2871f03SKumar Gala OF_STDOUT_PATH - The path to the console device 368f57f70aaSWolfgang Denk 36911ccc33fSMarcel Ziswiler boards with QUICC Engines require OF_QE to set UCC MAC 37011ccc33fSMarcel Ziswiler addresses 3713bb342fcSKim Phillips 3724e253137SKumar Gala CONFIG_OF_BOARD_SETUP 3734e253137SKumar Gala 3744e253137SKumar Gala Board code has addition modification that it wants to make 3754e253137SKumar Gala to the flat device tree before handing it off to the kernel 3766705d81eSwdenk 3770267768eSMatthew McClintock CONFIG_OF_BOOT_CPU 3780267768eSMatthew McClintock 37911ccc33fSMarcel Ziswiler This define fills in the correct boot CPU in the boot 3800267768eSMatthew McClintock param header, the default value is zero if undefined. 3810267768eSMatthew McClintock 3826705d81eSwdenk- Serial Ports: 38348d0192fSAndreas Engel CONFIG_PL010_SERIAL 3846705d81eSwdenk 3856705d81eSwdenk Define this if you want support for Amba PrimeCell PL010 UARTs. 3866705d81eSwdenk 38748d0192fSAndreas Engel CONFIG_PL011_SERIAL 3886705d81eSwdenk 3896705d81eSwdenk Define this if you want support for Amba PrimeCell PL011 UARTs. 3906705d81eSwdenk 3916705d81eSwdenk CONFIG_PL011_CLOCK 3926705d81eSwdenk 3936705d81eSwdenk If you have Amba PrimeCell PL011 UARTs, set this variable to 3946705d81eSwdenk the clock speed of the UARTs. 3956705d81eSwdenk 3966705d81eSwdenk CONFIG_PL01x_PORTS 3976705d81eSwdenk 3986705d81eSwdenk If you have Amba PrimeCell PL010 or PL011 UARTs on your board, 3996705d81eSwdenk define this to a list of base addresses for each (supported) 4006705d81eSwdenk port. See e.g. include/configs/versatile.h 4016705d81eSwdenk 4026705d81eSwdenk 403c609719bSwdenk- Console Interface: 404c609719bSwdenk Depending on board, define exactly one serial port 405c609719bSwdenk (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2, 406c609719bSwdenk CONFIG_8xx_CONS_SCC1, ...), or switch off the serial 407c609719bSwdenk console by defining CONFIG_8xx_CONS_NONE 408c609719bSwdenk 409c609719bSwdenk Note: if CONFIG_8xx_CONS_NONE is defined, the serial 410c609719bSwdenk port routines must be defined elsewhere 411c609719bSwdenk (i.e. serial_init(), serial_getc(), ...) 412c609719bSwdenk 413c609719bSwdenk CONFIG_CFB_CONSOLE 414c609719bSwdenk Enables console device for a color framebuffer. Needs following 415c609719bSwdenk defines (cf. smiLynxEM, i8042, board/eltec/bab7xx) 416c609719bSwdenk VIDEO_FB_LITTLE_ENDIAN graphic memory organisation 417c609719bSwdenk (default big endian) 418c609719bSwdenk VIDEO_HW_RECTFILL graphic chip supports 419c609719bSwdenk rectangle fill 420c609719bSwdenk (cf. smiLynxEM) 421c609719bSwdenk VIDEO_HW_BITBLT graphic chip supports 422c609719bSwdenk bit-blit (cf. smiLynxEM) 423c609719bSwdenk VIDEO_VISIBLE_COLS visible pixel columns 424c609719bSwdenk (cols=pitch) 425c609719bSwdenk VIDEO_VISIBLE_ROWS visible pixel rows 426c609719bSwdenk VIDEO_PIXEL_SIZE bytes per pixel 427c609719bSwdenk VIDEO_DATA_FORMAT graphic data format 428c609719bSwdenk (0-5, cf. cfb_console.c) 429c609719bSwdenk VIDEO_FB_ADRS framebuffer address 430c609719bSwdenk VIDEO_KBD_INIT_FCT keyboard int fct 431c609719bSwdenk (i.e. i8042_kbd_init()) 432c609719bSwdenk VIDEO_TSTC_FCT test char fct 433c609719bSwdenk (i.e. i8042_tstc) 434c609719bSwdenk VIDEO_GETC_FCT get char fct 435c609719bSwdenk (i.e. i8042_getc) 436c609719bSwdenk CONFIG_CONSOLE_CURSOR cursor drawing on/off 437c609719bSwdenk (requires blink timer 438c609719bSwdenk cf. i8042.c) 439c609719bSwdenk CFG_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c) 440c609719bSwdenk CONFIG_CONSOLE_TIME display time/date info in 441c609719bSwdenk upper right corner 442602ad3b3SJon Loeliger (requires CONFIG_CMD_DATE) 443c609719bSwdenk CONFIG_VIDEO_LOGO display Linux logo in 444c609719bSwdenk upper left corner 445a6c7ad2fSwdenk CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of 446a6c7ad2fSwdenk linux_logo.h for logo. 447a6c7ad2fSwdenk Requires CONFIG_VIDEO_LOGO 448c609719bSwdenk CONFIG_CONSOLE_EXTRA_INFO 44911ccc33fSMarcel Ziswiler additional board info beside 450c609719bSwdenk the logo 451c609719bSwdenk 452c609719bSwdenk When CONFIG_CFB_CONSOLE is defined, video console is 453c609719bSwdenk default i/o. Serial console can be forced with 454c609719bSwdenk environment 'console=serial'. 455c609719bSwdenk 456a3ad8e26Swdenk When CONFIG_SILENT_CONSOLE is defined, all console 457a3ad8e26Swdenk messages (by U-Boot and Linux!) can be silenced with 458a3ad8e26Swdenk the "silent" environment variable. See 459a3ad8e26Swdenk doc/README.silent for more information. 460a3ad8e26Swdenk 461c609719bSwdenk- Console Baudrate: 462c609719bSwdenk CONFIG_BAUDRATE - in bps 463c609719bSwdenk Select one of the baudrates listed in 464c609719bSwdenk CFG_BAUDRATE_TABLE, see below. 4653bbc899fSwdenk CFG_BRGCLK_PRESCALE, baudrate prescale 466c609719bSwdenk 467c609719bSwdenk- Interrupt driven serial port input: 468c609719bSwdenk CONFIG_SERIAL_SOFTWARE_FIFO 469c609719bSwdenk 470c609719bSwdenk PPC405GP only. 471c609719bSwdenk Use an interrupt handler for receiving data on the 472c609719bSwdenk serial port. It also enables using hardware handshake 473c609719bSwdenk (RTS/CTS) and UART's built-in FIFO. Set the number of 474c609719bSwdenk bytes the interrupt driven input buffer should have. 475c609719bSwdenk 476109c0e3aSwdenk Leave undefined to disable this feature, including 477109c0e3aSwdenk disable the buffer and hardware handshake. 478c609719bSwdenk 4791d49b1f3Sstroese- Console UART Number: 4801d49b1f3Sstroese CONFIG_UART1_CONSOLE 4811d49b1f3Sstroese 4820c8721a4SWolfgang Denk AMCC PPC4xx only. 4831d49b1f3Sstroese If defined internal UART1 (and not UART0) is used 4841d49b1f3Sstroese as default U-Boot console. 4851d49b1f3Sstroese 486c609719bSwdenk- Boot Delay: CONFIG_BOOTDELAY - in seconds 487c609719bSwdenk Delay before automatically booting the default image; 488c609719bSwdenk set to -1 to disable autoboot. 489c609719bSwdenk 490c609719bSwdenk See doc/README.autoboot for these options that 491c609719bSwdenk work with CONFIG_BOOTDELAY. None are required. 492c609719bSwdenk CONFIG_BOOT_RETRY_TIME 493c609719bSwdenk CONFIG_BOOT_RETRY_MIN 494c609719bSwdenk CONFIG_AUTOBOOT_KEYED 495c609719bSwdenk CONFIG_AUTOBOOT_PROMPT 496c609719bSwdenk CONFIG_AUTOBOOT_DELAY_STR 497c609719bSwdenk CONFIG_AUTOBOOT_STOP_STR 498c609719bSwdenk CONFIG_AUTOBOOT_DELAY_STR2 499c609719bSwdenk CONFIG_AUTOBOOT_STOP_STR2 500c609719bSwdenk CONFIG_ZERO_BOOTDELAY_CHECK 501c609719bSwdenk CONFIG_RESET_TO_RETRY 502c609719bSwdenk 503c609719bSwdenk- Autoboot Command: 504c609719bSwdenk CONFIG_BOOTCOMMAND 505c609719bSwdenk Only needed when CONFIG_BOOTDELAY is enabled; 506c609719bSwdenk define a command string that is automatically executed 507c609719bSwdenk when no character is read on the console interface 508c609719bSwdenk within "Boot Delay" after reset. 509c609719bSwdenk 510c609719bSwdenk CONFIG_BOOTARGS 511c609719bSwdenk This can be used to pass arguments to the bootm 512c609719bSwdenk command. The value of CONFIG_BOOTARGS goes into the 513c609719bSwdenk environment value "bootargs". 514c609719bSwdenk 515c609719bSwdenk CONFIG_RAMBOOT and CONFIG_NFSBOOT 516c609719bSwdenk The value of these goes into the environment as 517c609719bSwdenk "ramboot" and "nfsboot" respectively, and can be used 518c609719bSwdenk as a convenience, when switching between booting from 51911ccc33fSMarcel Ziswiler RAM and NFS. 520c609719bSwdenk 521c609719bSwdenk- Pre-Boot Commands: 522c609719bSwdenk CONFIG_PREBOOT 523c609719bSwdenk 524c609719bSwdenk When this option is #defined, the existence of the 525c609719bSwdenk environment variable "preboot" will be checked 526c609719bSwdenk immediately before starting the CONFIG_BOOTDELAY 527c609719bSwdenk countdown and/or running the auto-boot command resp. 528c609719bSwdenk entering interactive mode. 529c609719bSwdenk 530c609719bSwdenk This feature is especially useful when "preboot" is 531c609719bSwdenk automatically generated or modified. For an example 532c609719bSwdenk see the LWMON board specific code: here "preboot" is 533c609719bSwdenk modified when the user holds down a certain 534c609719bSwdenk combination of keys on the (special) keyboard when 535c609719bSwdenk booting the systems 536c609719bSwdenk 537c609719bSwdenk- Serial Download Echo Mode: 538c609719bSwdenk CONFIG_LOADS_ECHO 539c609719bSwdenk If defined to 1, all characters received during a 540c609719bSwdenk serial download (using the "loads" command) are 541c609719bSwdenk echoed back. This might be needed by some terminal 542c609719bSwdenk emulations (like "cu"), but may as well just take 543c609719bSwdenk time on others. This setting #define's the initial 544c609719bSwdenk value of the "loads_echo" environment variable. 545c609719bSwdenk 546602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined) 547c609719bSwdenk CONFIG_KGDB_BAUDRATE 548c609719bSwdenk Select one of the baudrates listed in 549c609719bSwdenk CFG_BAUDRATE_TABLE, see below. 550c609719bSwdenk 551c609719bSwdenk- Monitor Functions: 552602ad3b3SJon Loeliger Monitor commands can be included or excluded 553602ad3b3SJon Loeliger from the build by using the #include files 554602ad3b3SJon Loeliger "config_cmd_all.h" and #undef'ing unwanted 555602ad3b3SJon Loeliger commands, or using "config_cmd_default.h" 556602ad3b3SJon Loeliger and augmenting with additional #define's 557602ad3b3SJon Loeliger for wanted commands. 558c609719bSwdenk 559602ad3b3SJon Loeliger The default command configuration includes all commands 560602ad3b3SJon Loeliger except those marked below with a "*". 561602ad3b3SJon Loeliger 562602ad3b3SJon Loeliger CONFIG_CMD_ASKENV * ask for env variable 563602ad3b3SJon Loeliger CONFIG_CMD_AUTOSCRIPT Autoscript Support 564602ad3b3SJon Loeliger CONFIG_CMD_BDI bdinfo 565602ad3b3SJon Loeliger CONFIG_CMD_BEDBUG * Include BedBug Debugger 566602ad3b3SJon Loeliger CONFIG_CMD_BMP * BMP support 567602ad3b3SJon Loeliger CONFIG_CMD_BSP * Board specific commands 568602ad3b3SJon Loeliger CONFIG_CMD_BOOTD bootd 569602ad3b3SJon Loeliger CONFIG_CMD_CACHE * icache, dcache 570602ad3b3SJon Loeliger CONFIG_CMD_CONSOLE coninfo 571602ad3b3SJon Loeliger CONFIG_CMD_DATE * support for RTC, date/time... 572602ad3b3SJon Loeliger CONFIG_CMD_DHCP * DHCP support 573602ad3b3SJon Loeliger CONFIG_CMD_DIAG * Diagnostics 574602ad3b3SJon Loeliger CONFIG_CMD_DOC * Disk-On-Chip Support 575602ad3b3SJon Loeliger CONFIG_CMD_DTT * Digital Therm and Thermostat 576602ad3b3SJon Loeliger CONFIG_CMD_ECHO echo arguments 577602ad3b3SJon Loeliger CONFIG_CMD_EEPROM * EEPROM read/write support 578602ad3b3SJon Loeliger CONFIG_CMD_ELF * bootelf, bootvx 579602ad3b3SJon Loeliger CONFIG_CMD_ENV saveenv 580602ad3b3SJon Loeliger CONFIG_CMD_FDC * Floppy Disk Support 581602ad3b3SJon Loeliger CONFIG_CMD_FAT * FAT partition support 582602ad3b3SJon Loeliger CONFIG_CMD_FDOS * Dos diskette Support 583602ad3b3SJon Loeliger CONFIG_CMD_FLASH flinfo, erase, protect 584602ad3b3SJon Loeliger CONFIG_CMD_FPGA FPGA device initialization support 585602ad3b3SJon Loeliger CONFIG_CMD_HWFLOW * RTS/CTS hw flow control 586602ad3b3SJon Loeliger CONFIG_CMD_I2C * I2C serial bus support 587602ad3b3SJon Loeliger CONFIG_CMD_IDE * IDE harddisk support 588602ad3b3SJon Loeliger CONFIG_CMD_IMI iminfo 589602ad3b3SJon Loeliger CONFIG_CMD_IMLS List all found images 590602ad3b3SJon Loeliger CONFIG_CMD_IMMAP * IMMR dump support 591602ad3b3SJon Loeliger CONFIG_CMD_IRQ * irqinfo 592602ad3b3SJon Loeliger CONFIG_CMD_ITEST Integer/string test of 2 values 593602ad3b3SJon Loeliger CONFIG_CMD_JFFS2 * JFFS2 Support 594602ad3b3SJon Loeliger CONFIG_CMD_KGDB * kgdb 595602ad3b3SJon Loeliger CONFIG_CMD_LOADB loadb 596602ad3b3SJon Loeliger CONFIG_CMD_LOADS loads 597602ad3b3SJon Loeliger CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base, 59856523f12Swdenk loop, loopw, mtest 599602ad3b3SJon Loeliger CONFIG_CMD_MISC Misc functions like sleep etc 600602ad3b3SJon Loeliger CONFIG_CMD_MMC * MMC memory mapped support 601602ad3b3SJon Loeliger CONFIG_CMD_MII * MII utility commands 602602ad3b3SJon Loeliger CONFIG_CMD_NAND * NAND support 603602ad3b3SJon Loeliger CONFIG_CMD_NET bootp, tftpboot, rarpboot 604602ad3b3SJon Loeliger CONFIG_CMD_PCI * pciinfo 605602ad3b3SJon Loeliger CONFIG_CMD_PCMCIA * PCMCIA support 606602ad3b3SJon Loeliger CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network 607602ad3b3SJon Loeliger host 608602ad3b3SJon Loeliger CONFIG_CMD_PORTIO * Port I/O 609602ad3b3SJon Loeliger CONFIG_CMD_REGINFO * Register dump 610602ad3b3SJon Loeliger CONFIG_CMD_RUN run command in env variable 611602ad3b3SJon Loeliger CONFIG_CMD_SAVES * save S record dump 612602ad3b3SJon Loeliger CONFIG_CMD_SCSI * SCSI Support 613602ad3b3SJon Loeliger CONFIG_CMD_SDRAM * print SDRAM configuration information 614602ad3b3SJon Loeliger (requires CONFIG_CMD_I2C) 615602ad3b3SJon Loeliger CONFIG_CMD_SETGETDCR Support for DCR Register access 616602ad3b3SJon Loeliger (4xx only) 617602ad3b3SJon Loeliger CONFIG_CMD_SPI * SPI serial bus support 618602ad3b3SJon Loeliger CONFIG_CMD_USB * USB support 619602ad3b3SJon Loeliger CONFIG_CMD_VFD * VFD support (TRAB) 620602ad3b3SJon Loeliger CONFIG_CMD_CDP * Cisco Discover Protocol support 621602ad3b3SJon Loeliger CONFIG_CMD_FSL * Microblaze FSL support 622c609719bSwdenk 623c609719bSwdenk 624c609719bSwdenk EXAMPLE: If you want all functions except of network 625c609719bSwdenk support you can write: 626c609719bSwdenk 627602ad3b3SJon Loeliger #include "config_cmd_all.h" 628602ad3b3SJon Loeliger #undef CONFIG_CMD_NET 629c609719bSwdenk 630213bf8c8SGerald Van Baren Other Commands: 631213bf8c8SGerald Van Baren fdt (flattened device tree) command: CONFIG_OF_LIBFDT 632c609719bSwdenk 633c609719bSwdenk Note: Don't enable the "icache" and "dcache" commands 634602ad3b3SJon Loeliger (configuration option CONFIG_CMD_CACHE) unless you know 635c609719bSwdenk what you (and your U-Boot users) are doing. Data 636c609719bSwdenk cache cannot be enabled on systems like the 8xx or 637c609719bSwdenk 8260 (where accesses to the IMMR region must be 638c609719bSwdenk uncached), and it cannot be disabled on all other 639c609719bSwdenk systems where we (mis-) use the data cache to hold an 640c609719bSwdenk initial stack and some data. 641c609719bSwdenk 642c609719bSwdenk 643c609719bSwdenk XXX - this list needs to get updated! 644c609719bSwdenk 645c609719bSwdenk- Watchdog: 646c609719bSwdenk CONFIG_WATCHDOG 647c609719bSwdenk If this variable is defined, it enables watchdog 6487152b1d0Swdenk support. There must be support in the platform specific 649c609719bSwdenk code for a watchdog. For the 8xx and 8260 CPUs, the 650c609719bSwdenk SIU Watchdog feature is enabled in the SYPCR 651c609719bSwdenk register. 652c609719bSwdenk 653c1551ea8Sstroese- U-Boot Version: 654c1551ea8Sstroese CONFIG_VERSION_VARIABLE 655c1551ea8Sstroese If this variable is defined, an environment variable 656c1551ea8Sstroese named "ver" is created by U-Boot showing the U-Boot 657c1551ea8Sstroese version as printed by the "version" command. 658c1551ea8Sstroese This variable is readonly. 659c1551ea8Sstroese 660c609719bSwdenk- Real-Time Clock: 661c609719bSwdenk 662602ad3b3SJon Loeliger When CONFIG_CMD_DATE is selected, the type of the RTC 663c609719bSwdenk has to be selected, too. Define exactly one of the 664c609719bSwdenk following options: 665c609719bSwdenk 666c609719bSwdenk CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx 667c609719bSwdenk CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC 6687ce63709SGuennadi Liakhovetski CONFIG_RTC_MC13783 - use MC13783 RTC 669c609719bSwdenk CONFIG_RTC_MC146818 - use MC146818 RTC 6701cb8e980Swdenk CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC 671c609719bSwdenk CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC 6727f70e853Swdenk CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC 6733bac3513Swdenk CONFIG_RTC_DS164x - use Dallas DS164x RTC 6749536dfccSTor Krill CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC 6754c0d4c3bSwdenk CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC 676da8808dfSJoakim Tjernlund CFG_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337 677c609719bSwdenk 678b37c7e5eSwdenk Note that if the RTC uses I2C, then the I2C interface 679b37c7e5eSwdenk must also be configured. See I2C Support, below. 680b37c7e5eSwdenk 681c609719bSwdenk- Timestamp Support: 682c609719bSwdenk 683c609719bSwdenk When CONFIG_TIMESTAMP is selected, the timestamp 684c609719bSwdenk (date and time) of an image is printed by image 685c609719bSwdenk commands like bootm or iminfo. This option is 686602ad3b3SJon Loeliger automatically enabled when you select CONFIG_CMD_DATE . 687c609719bSwdenk 688c609719bSwdenk- Partition Support: 689c609719bSwdenk CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION 69007f3d789Srichardretanubun and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION 691c609719bSwdenk 692602ad3b3SJon Loeliger If IDE or SCSI support is enabled (CONFIG_CMD_IDE or 693218ca724SWolfgang Denk CONFIG_CMD_SCSI) you must configure support for at 694218ca724SWolfgang Denk least one partition type as well. 695c609719bSwdenk 696c609719bSwdenk- IDE Reset method: 6974d13cbadSwdenk CONFIG_IDE_RESET_ROUTINE - this is defined in several 6984d13cbadSwdenk board configurations files but used nowhere! 699c609719bSwdenk 7004d13cbadSwdenk CONFIG_IDE_RESET - is this is defined, IDE Reset will 7014d13cbadSwdenk be performed by calling the function 7024d13cbadSwdenk ide_set_reset(int reset) 7034d13cbadSwdenk which has to be defined in a board specific file 704c609719bSwdenk 705c609719bSwdenk- ATAPI Support: 706c609719bSwdenk CONFIG_ATAPI 707c609719bSwdenk 708c609719bSwdenk Set this to enable ATAPI support. 709c609719bSwdenk 710c40b2956Swdenk- LBA48 Support 711c40b2956Swdenk CONFIG_LBA48 712c40b2956Swdenk 713c40b2956Swdenk Set this to enable support for disks larger than 137GB 714c40b2956Swdenk Also look at CFG_64BIT_LBA ,CFG_64BIT_VSPRINTF and CFG_64BIT_STRTOUL 715c40b2956Swdenk Whithout these , LBA48 support uses 32bit variables and will 'only' 716c40b2956Swdenk support disks up to 2.1TB. 717c40b2956Swdenk 718c40b2956Swdenk CFG_64BIT_LBA: 719c40b2956Swdenk When enabled, makes the IDE subsystem use 64bit sector addresses. 720c40b2956Swdenk Default is 32bit. 721c40b2956Swdenk 722c609719bSwdenk- SCSI Support: 723c609719bSwdenk At the moment only there is only support for the 724c609719bSwdenk SYM53C8XX SCSI controller; define 725c609719bSwdenk CONFIG_SCSI_SYM53C8XX to enable it. 726c609719bSwdenk 727c609719bSwdenk CFG_SCSI_MAX_LUN [8], CFG_SCSI_MAX_SCSI_ID [7] and 728c609719bSwdenk CFG_SCSI_MAX_DEVICE [CFG_SCSI_MAX_SCSI_ID * 729c609719bSwdenk CFG_SCSI_MAX_LUN] can be adjusted to define the 730c609719bSwdenk maximum numbers of LUNs, SCSI ID's and target 731c609719bSwdenk devices. 732c609719bSwdenk CFG_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz) 733c609719bSwdenk 734c609719bSwdenk- NETWORK Support (PCI): 735682011ffSwdenk CONFIG_E1000 736682011ffSwdenk Support for Intel 8254x gigabit chips. 737682011ffSwdenk 738ac3315c2SAndre Schwarz CONFIG_E1000_FALLBACK_MAC 73911ccc33fSMarcel Ziswiler default MAC for empty EEPROM after production. 740ac3315c2SAndre Schwarz 741c609719bSwdenk CONFIG_EEPRO100 742c609719bSwdenk Support for Intel 82557/82559/82559ER chips. 74311ccc33fSMarcel Ziswiler Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM 744c609719bSwdenk write routine for first time initialisation. 745c609719bSwdenk 746c609719bSwdenk CONFIG_TULIP 747c609719bSwdenk Support for Digital 2114x chips. 748c609719bSwdenk Optional CONFIG_TULIP_SELECT_MEDIA for board specific 749c609719bSwdenk modem chip initialisation (KS8761/QS6611). 750c609719bSwdenk 751c609719bSwdenk CONFIG_NATSEMI 752c609719bSwdenk Support for National dp83815 chips. 753c609719bSwdenk 754c609719bSwdenk CONFIG_NS8382X 755c609719bSwdenk Support for National dp8382[01] gigabit chips. 756c609719bSwdenk 75745219c46Swdenk- NETWORK Support (other): 75845219c46Swdenk 75945219c46Swdenk CONFIG_DRIVER_LAN91C96 76045219c46Swdenk Support for SMSC's LAN91C96 chips. 76145219c46Swdenk 76245219c46Swdenk CONFIG_LAN91C96_BASE 76345219c46Swdenk Define this to hold the physical address 76445219c46Swdenk of the LAN91C96's I/O space 76545219c46Swdenk 76645219c46Swdenk CONFIG_LAN91C96_USE_32_BIT 76745219c46Swdenk Define this to enable 32 bit addressing 76845219c46Swdenk 769f39748aeSwdenk CONFIG_DRIVER_SMC91111 770f39748aeSwdenk Support for SMSC's LAN91C111 chip 771f39748aeSwdenk 772f39748aeSwdenk CONFIG_SMC91111_BASE 773f39748aeSwdenk Define this to hold the physical address 774f39748aeSwdenk of the device (I/O space) 775f39748aeSwdenk 776f39748aeSwdenk CONFIG_SMC_USE_32_BIT 777f39748aeSwdenk Define this if data bus is 32 bits 778f39748aeSwdenk 779f39748aeSwdenk CONFIG_SMC_USE_IOFUNCS 780f39748aeSwdenk Define this to use i/o functions instead of macros 781f39748aeSwdenk (some hardware wont work with macros) 782f39748aeSwdenk 783557b377dSJens Gehrlein CONFIG_DRIVER_SMC911X 784557b377dSJens Gehrlein Support for SMSC's LAN911x and LAN921x chips 785557b377dSJens Gehrlein 786557b377dSJens Gehrlein CONFIG_DRIVER_SMC911X_BASE 787557b377dSJens Gehrlein Define this to hold the physical address 788557b377dSJens Gehrlein of the device (I/O space) 789557b377dSJens Gehrlein 790557b377dSJens Gehrlein CONFIG_DRIVER_SMC911X_32_BIT 791557b377dSJens Gehrlein Define this if data bus is 32 bits 792557b377dSJens Gehrlein 793557b377dSJens Gehrlein CONFIG_DRIVER_SMC911X_16_BIT 794557b377dSJens Gehrlein Define this if data bus is 16 bits. If your processor 795557b377dSJens Gehrlein automatically converts one 32 bit word to two 16 bit 796557b377dSJens Gehrlein words you may also try CONFIG_DRIVER_SMC911X_32_BIT. 797557b377dSJens Gehrlein 798c609719bSwdenk- USB Support: 799c609719bSwdenk At the moment only the UHCI host controller is 8004d13cbadSwdenk supported (PIP405, MIP405, MPC5200); define 801c609719bSwdenk CONFIG_USB_UHCI to enable it. 802c609719bSwdenk define CONFIG_USB_KEYBOARD to enable the USB Keyboard 80330d56faeSwdenk and define CONFIG_USB_STORAGE to enable the USB 804c609719bSwdenk storage devices. 805c609719bSwdenk Note: 806c609719bSwdenk Supported are USB Keyboards and USB Floppy drives 807c609719bSwdenk (TEAC FD-05PUB). 8084d13cbadSwdenk MPC5200 USB requires additional defines: 8094d13cbadSwdenk CONFIG_USB_CLOCK 8104d13cbadSwdenk for 528 MHz Clock: 0x0001bbbb 8114d13cbadSwdenk CONFIG_USB_CONFIG 8124d13cbadSwdenk for differential drivers: 0x00001000 8134d13cbadSwdenk for single ended drivers: 0x00005000 814fdcfaa1bSZhang Wei CFG_USB_EVENT_POLL 815fdcfaa1bSZhang Wei May be defined to allow interrupt polling 816fdcfaa1bSZhang Wei instead of using asynchronous interrupts 8174d13cbadSwdenk 81816c8d5e7SWolfgang Denk- USB Device: 81916c8d5e7SWolfgang Denk Define the below if you wish to use the USB console. 82016c8d5e7SWolfgang Denk Once firmware is rebuilt from a serial console issue the 82116c8d5e7SWolfgang Denk command "setenv stdin usbtty; setenv stdout usbtty" and 82211ccc33fSMarcel Ziswiler attach your USB cable. The Unix command "dmesg" should print 82316c8d5e7SWolfgang Denk it has found a new device. The environment variable usbtty 82416c8d5e7SWolfgang Denk can be set to gserial or cdc_acm to enable your device to 82516c8d5e7SWolfgang Denk appear to a USB host as a Linux gserial device or a 82616c8d5e7SWolfgang Denk Common Device Class Abstract Control Model serial device. 82716c8d5e7SWolfgang Denk If you select usbtty = gserial you should be able to enumerate 82816c8d5e7SWolfgang Denk a Linux host by 82916c8d5e7SWolfgang Denk # modprobe usbserial vendor=0xVendorID product=0xProductID 83016c8d5e7SWolfgang Denk else if using cdc_acm, simply setting the environment 83116c8d5e7SWolfgang Denk variable usbtty to be cdc_acm should suffice. The following 83216c8d5e7SWolfgang Denk might be defined in YourBoardName.h 83316c8d5e7SWolfgang Denk 83416c8d5e7SWolfgang Denk CONFIG_USB_DEVICE 83516c8d5e7SWolfgang Denk Define this to build a UDC device 83616c8d5e7SWolfgang Denk 83716c8d5e7SWolfgang Denk CONFIG_USB_TTY 83816c8d5e7SWolfgang Denk Define this to have a tty type of device available to 83916c8d5e7SWolfgang Denk talk to the UDC device 84016c8d5e7SWolfgang Denk 84116c8d5e7SWolfgang Denk CFG_CONSOLE_IS_IN_ENV 84216c8d5e7SWolfgang Denk Define this if you want stdin, stdout &/or stderr to 84316c8d5e7SWolfgang Denk be set to usbtty. 84416c8d5e7SWolfgang Denk 84516c8d5e7SWolfgang Denk mpc8xx: 84616c8d5e7SWolfgang Denk CFG_USB_EXTC_CLK 0xBLAH 84716c8d5e7SWolfgang Denk Derive USB clock from external clock "blah" 84816c8d5e7SWolfgang Denk - CFG_USB_EXTC_CLK 0x02 84916c8d5e7SWolfgang Denk 85016c8d5e7SWolfgang Denk CFG_USB_BRG_CLK 0xBLAH 85116c8d5e7SWolfgang Denk Derive USB clock from brgclk 85216c8d5e7SWolfgang Denk - CFG_USB_BRG_CLK 0x04 85316c8d5e7SWolfgang Denk 85416c8d5e7SWolfgang Denk If you have a USB-IF assigned VendorID then you may wish to 85516c8d5e7SWolfgang Denk define your own vendor specific values either in BoardName.h 85616c8d5e7SWolfgang Denk or directly in usbd_vendor_info.h. If you don't define 85716c8d5e7SWolfgang Denk CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME, 85816c8d5e7SWolfgang Denk CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot 85916c8d5e7SWolfgang Denk should pretend to be a Linux device to it's target host. 86016c8d5e7SWolfgang Denk 86116c8d5e7SWolfgang Denk CONFIG_USBD_MANUFACTURER 86216c8d5e7SWolfgang Denk Define this string as the name of your company for 86316c8d5e7SWolfgang Denk - CONFIG_USBD_MANUFACTURER "my company" 86416c8d5e7SWolfgang Denk 86516c8d5e7SWolfgang Denk CONFIG_USBD_PRODUCT_NAME 86616c8d5e7SWolfgang Denk Define this string as the name of your product 86716c8d5e7SWolfgang Denk - CONFIG_USBD_PRODUCT_NAME "acme usb device" 86816c8d5e7SWolfgang Denk 86916c8d5e7SWolfgang Denk CONFIG_USBD_VENDORID 87016c8d5e7SWolfgang Denk Define this as your assigned Vendor ID from the USB 87116c8d5e7SWolfgang Denk Implementors Forum. This *must* be a genuine Vendor ID 87216c8d5e7SWolfgang Denk to avoid polluting the USB namespace. 87316c8d5e7SWolfgang Denk - CONFIG_USBD_VENDORID 0xFFFF 87416c8d5e7SWolfgang Denk 87516c8d5e7SWolfgang Denk CONFIG_USBD_PRODUCTID 87616c8d5e7SWolfgang Denk Define this as the unique Product ID 87716c8d5e7SWolfgang Denk for your device 87816c8d5e7SWolfgang Denk - CONFIG_USBD_PRODUCTID 0xFFFF 879c609719bSwdenk 880c609719bSwdenk 881c609719bSwdenk- MMC Support: 882c609719bSwdenk The MMC controller on the Intel PXA is supported. To 883c609719bSwdenk enable this define CONFIG_MMC. The MMC can be 884c609719bSwdenk accessed from the boot prompt by mapping the device 885c609719bSwdenk to physical memory similar to flash. Command line is 886602ad3b3SJon Loeliger enabled with CONFIG_CMD_MMC. The MMC driver also works with 887602ad3b3SJon Loeliger the FAT fs. This is enabled with CONFIG_CMD_FAT. 888c609719bSwdenk 8896705d81eSwdenk- Journaling Flash filesystem support: 8906705d81eSwdenk CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE, 8916705d81eSwdenk CONFIG_JFFS2_NAND_DEV 8926705d81eSwdenk Define these for a default partition on a NAND device 8936705d81eSwdenk 8946705d81eSwdenk CFG_JFFS2_FIRST_SECTOR, 8956705d81eSwdenk CFG_JFFS2_FIRST_BANK, CFG_JFFS2_NUM_BANKS 8966705d81eSwdenk Define these for a default partition on a NOR device 8976705d81eSwdenk 8986705d81eSwdenk CFG_JFFS_CUSTOM_PART 8996705d81eSwdenk Define this to create an own partition. You have to provide a 9006705d81eSwdenk function struct part_info* jffs2_part_info(int part_num) 9016705d81eSwdenk 9026705d81eSwdenk If you define only one JFFS2 partition you may also want to 9036705d81eSwdenk #define CFG_JFFS_SINGLE_PART 1 9046705d81eSwdenk to disable the command chpart. This is the default when you 9056705d81eSwdenk have not defined a custom partition 9066705d81eSwdenk 907c609719bSwdenk- Keyboard Support: 908c609719bSwdenk CONFIG_ISA_KEYBOARD 909c609719bSwdenk 910c609719bSwdenk Define this to enable standard (PC-Style) keyboard 911c609719bSwdenk support 912c609719bSwdenk 913c609719bSwdenk CONFIG_I8042_KBD 914c609719bSwdenk Standard PC keyboard driver with US (is default) and 915c609719bSwdenk GERMAN key layout (switch via environment 'keymap=de') support. 916c609719bSwdenk Export function i8042_kbd_init, i8042_tstc and i8042_getc 917c609719bSwdenk for cfb_console. Supports cursor blinking. 918c609719bSwdenk 919c609719bSwdenk- Video support: 920c609719bSwdenk CONFIG_VIDEO 921c609719bSwdenk 922c609719bSwdenk Define this to enable video support (for output to 923c609719bSwdenk video). 924c609719bSwdenk 925c609719bSwdenk CONFIG_VIDEO_CT69000 926c609719bSwdenk 927c609719bSwdenk Enable Chips & Technologies 69000 Video chip 928c609719bSwdenk 929c609719bSwdenk CONFIG_VIDEO_SMI_LYNXEM 930eeb1b77bSwdenk Enable Silicon Motion SMI 712/710/810 Video chip. The 931eeb1b77bSwdenk video output is selected via environment 'videoout' 932eeb1b77bSwdenk (1 = LCD and 2 = CRT). If videoout is undefined, CRT is 933eeb1b77bSwdenk assumed. 934c609719bSwdenk 935eeb1b77bSwdenk For the CT69000 and SMI_LYNXEM drivers, videomode is 93611ccc33fSMarcel Ziswiler selected via environment 'videomode'. Two different ways 937eeb1b77bSwdenk are possible: 938eeb1b77bSwdenk - "videomode=num" 'num' is a standard LiLo mode numbers. 939eeb1b77bSwdenk Following standard modes are supported (* is default): 940eeb1b77bSwdenk 941eeb1b77bSwdenk Colors 640x480 800x600 1024x768 1152x864 1280x1024 942eeb1b77bSwdenk -------------+--------------------------------------------- 943eeb1b77bSwdenk 8 bits | 0x301* 0x303 0x305 0x161 0x307 944eeb1b77bSwdenk 15 bits | 0x310 0x313 0x316 0x162 0x319 945eeb1b77bSwdenk 16 bits | 0x311 0x314 0x317 0x163 0x31A 946eeb1b77bSwdenk 24 bits | 0x312 0x315 0x318 ? 0x31B 947eeb1b77bSwdenk -------------+--------------------------------------------- 948c609719bSwdenk (i.e. setenv videomode 317; saveenv; reset;) 949c609719bSwdenk 950eeb1b77bSwdenk - "videomode=bootargs" all the video parameters are parsed 9517817cb20SMarcel Ziswiler from the bootargs. (See drivers/video/videomodes.c) 952eeb1b77bSwdenk 953eeb1b77bSwdenk 954a6c7ad2fSwdenk CONFIG_VIDEO_SED13806 955a6c7ad2fSwdenk Enable Epson SED13806 driver. This driver supports 8bpp 956a6c7ad2fSwdenk and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP 957a6c7ad2fSwdenk or CONFIG_VIDEO_SED13806_16BPP 958a6c7ad2fSwdenk 959682011ffSwdenk- Keyboard Support: 960682011ffSwdenk CONFIG_KEYBOARD 961682011ffSwdenk 962682011ffSwdenk Define this to enable a custom keyboard support. 963682011ffSwdenk This simply calls drv_keyboard_init() which must be 964682011ffSwdenk defined in your board-specific files. 965682011ffSwdenk The only board using this so far is RBC823. 966a6c7ad2fSwdenk 967c609719bSwdenk- LCD Support: CONFIG_LCD 968c609719bSwdenk 969c609719bSwdenk Define this to enable LCD support (for output to LCD 970c609719bSwdenk display); also select one of the supported displays 971c609719bSwdenk by defining one of these: 972c609719bSwdenk 97339cf4804SStelian Pop CONFIG_ATMEL_LCD: 97439cf4804SStelian Pop 97539cf4804SStelian Pop HITACHI TX09D70VM1CCA, 3.5", 240x320. 97639cf4804SStelian Pop 977fd3103bbSwdenk CONFIG_NEC_NL6448AC33: 978c609719bSwdenk 979fd3103bbSwdenk NEC NL6448AC33-18. Active, color, single scan. 980c609719bSwdenk 981fd3103bbSwdenk CONFIG_NEC_NL6448BC20 982c609719bSwdenk 983fd3103bbSwdenk NEC NL6448BC20-08. 6.5", 640x480. 984fd3103bbSwdenk Active, color, single scan. 985fd3103bbSwdenk 986fd3103bbSwdenk CONFIG_NEC_NL6448BC33_54 987fd3103bbSwdenk 988fd3103bbSwdenk NEC NL6448BC33-54. 10.4", 640x480. 989c609719bSwdenk Active, color, single scan. 990c609719bSwdenk 991c609719bSwdenk CONFIG_SHARP_16x9 992c609719bSwdenk 993c609719bSwdenk Sharp 320x240. Active, color, single scan. 994c609719bSwdenk It isn't 16x9, and I am not sure what it is. 995c609719bSwdenk 996c609719bSwdenk CONFIG_SHARP_LQ64D341 997c609719bSwdenk 998c609719bSwdenk Sharp LQ64D341 display, 640x480. 999c609719bSwdenk Active, color, single scan. 1000c609719bSwdenk 1001c609719bSwdenk CONFIG_HLD1045 1002c609719bSwdenk 1003c609719bSwdenk HLD1045 display, 640x480. 1004c609719bSwdenk Active, color, single scan. 1005c609719bSwdenk 1006c609719bSwdenk CONFIG_OPTREX_BW 1007c609719bSwdenk 1008c609719bSwdenk Optrex CBL50840-2 NF-FW 99 22 M5 1009c609719bSwdenk or 1010c609719bSwdenk Hitachi LMG6912RPFC-00T 1011c609719bSwdenk or 1012c609719bSwdenk Hitachi SP14Q002 1013c609719bSwdenk 1014c609719bSwdenk 320x240. Black & white. 1015c609719bSwdenk 1016c609719bSwdenk Normally display is black on white background; define 1017c609719bSwdenk CFG_WHITE_ON_BLACK to get it inverted. 1018c609719bSwdenk 10197152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN 1020d791b1dcSwdenk 1021d791b1dcSwdenk If this option is set, the environment is checked for 1022d791b1dcSwdenk a variable "splashimage". If found, the usual display 1023d791b1dcSwdenk of logo, copyright and system information on the LCD 1024e94d2cd9Swdenk is suppressed and the BMP image at the address 1025d791b1dcSwdenk specified in "splashimage" is loaded instead. The 1026d791b1dcSwdenk console is redirected to the "nulldev", too. This 1027d791b1dcSwdenk allows for a "silent" boot where a splash screen is 1028d791b1dcSwdenk loaded very quickly after power-on. 1029d791b1dcSwdenk 103098f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP 103198f4a3dfSStefan Roese 103298f4a3dfSStefan Roese If this option is set, additionally to standard BMP 103398f4a3dfSStefan Roese images, gzipped BMP images can be displayed via the 103498f4a3dfSStefan Roese splashscreen support or the bmp command. 103598f4a3dfSStefan Roese 1036c29fdfc1Swdenk- Compression support: 1037c29fdfc1Swdenk CONFIG_BZIP2 1038c29fdfc1Swdenk 1039c29fdfc1Swdenk If this option is set, support for bzip2 compressed 1040c29fdfc1Swdenk images is included. If not, only uncompressed and gzip 1041c29fdfc1Swdenk compressed images are supported. 1042c29fdfc1Swdenk 1043c29fdfc1Swdenk NOTE: the bzip2 algorithm requires a lot of RAM, so 1044c29fdfc1Swdenk the malloc area (as defined by CFG_MALLOC_LEN) should 1045c29fdfc1Swdenk be at least 4MB. 1046d791b1dcSwdenk 1047fc9c1727SLuigi 'Comio' Mantellini CONFIG_LZMA 1048fc9c1727SLuigi 'Comio' Mantellini 1049fc9c1727SLuigi 'Comio' Mantellini If this option is set, support for lzma compressed 1050fc9c1727SLuigi 'Comio' Mantellini images is included. 1051fc9c1727SLuigi 'Comio' Mantellini 1052fc9c1727SLuigi 'Comio' Mantellini Note: The LZMA algorithm adds between 2 and 4KB of code and it 1053fc9c1727SLuigi 'Comio' Mantellini requires an amount of dynamic memory that is given by the 1054fc9c1727SLuigi 'Comio' Mantellini formula: 1055fc9c1727SLuigi 'Comio' Mantellini 1056fc9c1727SLuigi 'Comio' Mantellini (1846 + 768 << (lc + lp)) * sizeof(uint16) 1057fc9c1727SLuigi 'Comio' Mantellini 1058fc9c1727SLuigi 'Comio' Mantellini Where lc and lp stand for, respectively, Literal context bits 1059fc9c1727SLuigi 'Comio' Mantellini and Literal pos bits. 1060fc9c1727SLuigi 'Comio' Mantellini 1061fc9c1727SLuigi 'Comio' Mantellini This value is upper-bounded by 14MB in the worst case. Anyway, 1062fc9c1727SLuigi 'Comio' Mantellini for a ~4MB large kernel image, we have lc=3 and lp=0 for a 1063fc9c1727SLuigi 'Comio' Mantellini total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is 1064fc9c1727SLuigi 'Comio' Mantellini a very small buffer. 1065fc9c1727SLuigi 'Comio' Mantellini 1066fc9c1727SLuigi 'Comio' Mantellini Use the lzmainfo tool to determinate the lc and lp values and 1067fc9c1727SLuigi 'Comio' Mantellini then calculate the amount of needed dynamic memory (ensuring 1068fc9c1727SLuigi 'Comio' Mantellini the appropriate CFG_MALLOC_LEN value). 1069fc9c1727SLuigi 'Comio' Mantellini 107017ea1177Swdenk- MII/PHY support: 107117ea1177Swdenk CONFIG_PHY_ADDR 107217ea1177Swdenk 107317ea1177Swdenk The address of PHY on MII bus. 107417ea1177Swdenk 107517ea1177Swdenk CONFIG_PHY_CLOCK_FREQ (ppc4xx) 107617ea1177Swdenk 107717ea1177Swdenk The clock frequency of the MII bus 107817ea1177Swdenk 107917ea1177Swdenk CONFIG_PHY_GIGE 108017ea1177Swdenk 108117ea1177Swdenk If this option is set, support for speed/duplex 108211ccc33fSMarcel Ziswiler detection of gigabit PHY is included. 108317ea1177Swdenk 108417ea1177Swdenk CONFIG_PHY_RESET_DELAY 108517ea1177Swdenk 108617ea1177Swdenk Some PHY like Intel LXT971A need extra delay after 108717ea1177Swdenk reset before any MII register access is possible. 108817ea1177Swdenk For such PHY, set this option to the usec delay 108917ea1177Swdenk required. (minimum 300usec for LXT971A) 109017ea1177Swdenk 109117ea1177Swdenk CONFIG_PHY_CMD_DELAY (ppc4xx) 109217ea1177Swdenk 109317ea1177Swdenk Some PHY like Intel LXT971A need extra delay after 109417ea1177Swdenk command issued before MII status register can be read 109517ea1177Swdenk 1096c609719bSwdenk- Ethernet address: 1097c609719bSwdenk CONFIG_ETHADDR 1098c68a05feSrichardretanubun CONFIG_ETH1ADDR 1099c609719bSwdenk CONFIG_ETH2ADDR 1100c609719bSwdenk CONFIG_ETH3ADDR 1101c68a05feSrichardretanubun CONFIG_ETH4ADDR 1102c68a05feSrichardretanubun CONFIG_ETH5ADDR 1103c609719bSwdenk 110411ccc33fSMarcel Ziswiler Define a default value for Ethernet address to use 110511ccc33fSMarcel Ziswiler for the respective Ethernet interface, in case this 1106c609719bSwdenk is not determined automatically. 1107c609719bSwdenk 1108c609719bSwdenk- IP address: 1109c609719bSwdenk CONFIG_IPADDR 1110c609719bSwdenk 1111c609719bSwdenk Define a default value for the IP address to use for 111211ccc33fSMarcel Ziswiler the default Ethernet interface, in case this is not 1113c609719bSwdenk determined through e.g. bootp. 1114c609719bSwdenk 1115c609719bSwdenk- Server IP address: 1116c609719bSwdenk CONFIG_SERVERIP 1117c609719bSwdenk 1118c609719bSwdenk Defines a default value for the IP address of a TFTP 1119c609719bSwdenk server to contact when using the "tftboot" command. 1120c609719bSwdenk 112153a5c424SDavid Updegraff- Multicast TFTP Mode: 112253a5c424SDavid Updegraff CONFIG_MCAST_TFTP 112353a5c424SDavid Updegraff 112453a5c424SDavid Updegraff Defines whether you want to support multicast TFTP as per 112553a5c424SDavid Updegraff rfc-2090; for example to work with atftp. Lets lots of targets 112611ccc33fSMarcel Ziswiler tftp down the same boot image concurrently. Note: the Ethernet 112753a5c424SDavid Updegraff driver in use must provide a function: mcast() to join/leave a 112853a5c424SDavid Updegraff multicast group. 112953a5c424SDavid Updegraff 113053a5c424SDavid Updegraff CONFIG_BOOTP_RANDOM_DELAY 1131c609719bSwdenk- BOOTP Recovery Mode: 1132c609719bSwdenk CONFIG_BOOTP_RANDOM_DELAY 1133c609719bSwdenk 1134c609719bSwdenk If you have many targets in a network that try to 1135c609719bSwdenk boot using BOOTP, you may want to avoid that all 1136c609719bSwdenk systems send out BOOTP requests at precisely the same 1137c609719bSwdenk moment (which would happen for instance at recovery 1138c609719bSwdenk from a power failure, when all systems will try to 1139c609719bSwdenk boot, thus flooding the BOOTP server. Defining 1140c609719bSwdenk CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be 1141c609719bSwdenk inserted before sending out BOOTP requests. The 11426c33c785SWolfgang Denk following delays are inserted then: 1143c609719bSwdenk 1144c609719bSwdenk 1st BOOTP request: delay 0 ... 1 sec 1145c609719bSwdenk 2nd BOOTP request: delay 0 ... 2 sec 1146c609719bSwdenk 3rd BOOTP request: delay 0 ... 4 sec 1147c609719bSwdenk 4th and following 1148c609719bSwdenk BOOTP requests: delay 0 ... 8 sec 1149c609719bSwdenk 1150fe389a82Sstroese- DHCP Advanced Options: 11511fe80d79SJon Loeliger You can fine tune the DHCP functionality by defining 11521fe80d79SJon Loeliger CONFIG_BOOTP_* symbols: 1153fe389a82Sstroese 11541fe80d79SJon Loeliger CONFIG_BOOTP_SUBNETMASK 11551fe80d79SJon Loeliger CONFIG_BOOTP_GATEWAY 11561fe80d79SJon Loeliger CONFIG_BOOTP_HOSTNAME 11571fe80d79SJon Loeliger CONFIG_BOOTP_NISDOMAIN 11581fe80d79SJon Loeliger CONFIG_BOOTP_BOOTPATH 11591fe80d79SJon Loeliger CONFIG_BOOTP_BOOTFILESIZE 11601fe80d79SJon Loeliger CONFIG_BOOTP_DNS 11611fe80d79SJon Loeliger CONFIG_BOOTP_DNS2 11621fe80d79SJon Loeliger CONFIG_BOOTP_SEND_HOSTNAME 11631fe80d79SJon Loeliger CONFIG_BOOTP_NTPSERVER 11641fe80d79SJon Loeliger CONFIG_BOOTP_TIMEOFFSET 11651fe80d79SJon Loeliger CONFIG_BOOTP_VENDOREX 1166fe389a82Sstroese 11675d110f0aSWilson Callan CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip 11685d110f0aSWilson Callan environment variable, not the BOOTP server. 1169fe389a82Sstroese 1170fe389a82Sstroese CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS 1171fe389a82Sstroese serverip from a DHCP server, it is possible that more 1172fe389a82Sstroese than one DNS serverip is offered to the client. 1173fe389a82Sstroese If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS 1174fe389a82Sstroese serverip will be stored in the additional environment 1175fe389a82Sstroese variable "dnsip2". The first DNS serverip is always 1176fe389a82Sstroese stored in the variable "dnsip", when CONFIG_BOOTP_DNS 11771fe80d79SJon Loeliger is defined. 1178fe389a82Sstroese 1179fe389a82Sstroese CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable 1180fe389a82Sstroese to do a dynamic update of a DNS server. To do this, they 1181fe389a82Sstroese need the hostname of the DHCP requester. 11825d110f0aSWilson Callan If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content 11831fe80d79SJon Loeliger of the "hostname" environment variable is passed as 11841fe80d79SJon Loeliger option 12 to the DHCP server. 1185fe389a82Sstroese 1186d9a2f416SAras Vaichas CONFIG_BOOTP_DHCP_REQUEST_DELAY 1187d9a2f416SAras Vaichas 1188d9a2f416SAras Vaichas A 32bit value in microseconds for a delay between 1189d9a2f416SAras Vaichas receiving a "DHCP Offer" and sending the "DHCP Request". 1190d9a2f416SAras Vaichas This fixes a problem with certain DHCP servers that don't 1191d9a2f416SAras Vaichas respond 100% of the time to a "DHCP request". E.g. On an 1192d9a2f416SAras Vaichas AT91RM9200 processor running at 180MHz, this delay needed 1193d9a2f416SAras Vaichas to be *at least* 15,000 usec before a Windows Server 2003 1194d9a2f416SAras Vaichas DHCP server would reply 100% of the time. I recommend at 1195d9a2f416SAras Vaichas least 50,000 usec to be safe. The alternative is to hope 1196d9a2f416SAras Vaichas that one of the retries will be successful but note that 1197d9a2f416SAras Vaichas the DHCP timeout and retry process takes a longer than 1198d9a2f416SAras Vaichas this delay. 1199d9a2f416SAras Vaichas 1200a3d991bdSwdenk - CDP Options: 1201a3d991bdSwdenk CONFIG_CDP_DEVICE_ID 1202a3d991bdSwdenk 1203a3d991bdSwdenk The device id used in CDP trigger frames. 1204a3d991bdSwdenk 1205a3d991bdSwdenk CONFIG_CDP_DEVICE_ID_PREFIX 1206a3d991bdSwdenk 1207a3d991bdSwdenk A two character string which is prefixed to the MAC address 1208a3d991bdSwdenk of the device. 1209a3d991bdSwdenk 1210a3d991bdSwdenk CONFIG_CDP_PORT_ID 1211a3d991bdSwdenk 1212a3d991bdSwdenk A printf format string which contains the ascii name of 1213a3d991bdSwdenk the port. Normally is set to "eth%d" which sets 121411ccc33fSMarcel Ziswiler eth0 for the first Ethernet, eth1 for the second etc. 1215a3d991bdSwdenk 1216a3d991bdSwdenk CONFIG_CDP_CAPABILITIES 1217a3d991bdSwdenk 1218a3d991bdSwdenk A 32bit integer which indicates the device capabilities; 1219a3d991bdSwdenk 0x00000010 for a normal host which does not forwards. 1220a3d991bdSwdenk 1221a3d991bdSwdenk CONFIG_CDP_VERSION 1222a3d991bdSwdenk 1223a3d991bdSwdenk An ascii string containing the version of the software. 1224a3d991bdSwdenk 1225a3d991bdSwdenk CONFIG_CDP_PLATFORM 1226a3d991bdSwdenk 1227a3d991bdSwdenk An ascii string containing the name of the platform. 1228a3d991bdSwdenk 1229a3d991bdSwdenk CONFIG_CDP_TRIGGER 1230a3d991bdSwdenk 1231a3d991bdSwdenk A 32bit integer sent on the trigger. 1232a3d991bdSwdenk 1233a3d991bdSwdenk CONFIG_CDP_POWER_CONSUMPTION 1234a3d991bdSwdenk 1235a3d991bdSwdenk A 16bit integer containing the power consumption of the 1236a3d991bdSwdenk device in .1 of milliwatts. 1237a3d991bdSwdenk 1238a3d991bdSwdenk CONFIG_CDP_APPLIANCE_VLAN_TYPE 1239a3d991bdSwdenk 1240a3d991bdSwdenk A byte containing the id of the VLAN. 1241a3d991bdSwdenk 1242c609719bSwdenk- Status LED: CONFIG_STATUS_LED 1243c609719bSwdenk 1244c609719bSwdenk Several configurations allow to display the current 1245c609719bSwdenk status using a LED. For instance, the LED will blink 1246c609719bSwdenk fast while running U-Boot code, stop blinking as 1247c609719bSwdenk soon as a reply to a BOOTP request was received, and 1248c609719bSwdenk start blinking slow once the Linux kernel is running 1249c609719bSwdenk (supported by a status LED driver in the Linux 1250c609719bSwdenk kernel). Defining CONFIG_STATUS_LED enables this 1251c609719bSwdenk feature in U-Boot. 1252c609719bSwdenk 1253c609719bSwdenk- CAN Support: CONFIG_CAN_DRIVER 1254c609719bSwdenk 1255c609719bSwdenk Defining CONFIG_CAN_DRIVER enables CAN driver support 1256c609719bSwdenk on those systems that support this (optional) 1257c609719bSwdenk feature, like the TQM8xxL modules. 1258c609719bSwdenk 1259c609719bSwdenk- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C 1260c609719bSwdenk 1261b37c7e5eSwdenk These enable I2C serial bus commands. Defining either of 1262b37c7e5eSwdenk (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will 126311ccc33fSMarcel Ziswiler include the appropriate I2C driver for the selected CPU. 1264c609719bSwdenk 1265b37c7e5eSwdenk This will allow you to use i2c commands at the u-boot 1266602ad3b3SJon Loeliger command line (as long as you set CONFIG_CMD_I2C in 1267b37c7e5eSwdenk CONFIG_COMMANDS) and communicate with i2c based realtime 1268b37c7e5eSwdenk clock chips. See common/cmd_i2c.c for a description of the 1269c609719bSwdenk command line interface. 1270c609719bSwdenk 1271bb99ad6dSBen Warren CONFIG_I2C_CMD_TREE is a recommended option that places 1272bb99ad6dSBen Warren all I2C commands under a single 'i2c' root command. The 1273bb99ad6dSBen Warren older 'imm', 'imd', 'iprobe' etc. commands are considered 1274bb99ad6dSBen Warren deprecated and may disappear in the future. 1275bb99ad6dSBen Warren 1276bb99ad6dSBen Warren CONFIG_HARD_I2C selects a hardware I2C controller. 1277c609719bSwdenk 1278b37c7e5eSwdenk CONFIG_SOFT_I2C configures u-boot to use a software (aka 1279b37c7e5eSwdenk bit-banging) driver instead of CPM or similar hardware 1280b37c7e5eSwdenk support for I2C. 1281c609719bSwdenk 1282b37c7e5eSwdenk There are several other quantities that must also be 1283b37c7e5eSwdenk defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C. 1284c609719bSwdenk 1285b37c7e5eSwdenk In both cases you will need to define CFG_I2C_SPEED 1286b37c7e5eSwdenk to be the frequency (in Hz) at which you wish your i2c bus 1287b37c7e5eSwdenk to run and CFG_I2C_SLAVE to be the address of this node (ie 128811ccc33fSMarcel Ziswiler the CPU's i2c node address). 1289c609719bSwdenk 1290b37c7e5eSwdenk Now, the u-boot i2c code for the mpc8xx (cpu/mpc8xx/i2c.c) 129111ccc33fSMarcel Ziswiler sets the CPU up as a master node and so its address should 1292b37c7e5eSwdenk therefore be cleared to 0 (See, eg, MPC823e User's Manual 1293b37c7e5eSwdenk p.16-473). So, set CFG_I2C_SLAVE to 0. 1294b37c7e5eSwdenk 1295b37c7e5eSwdenk That's all that's required for CONFIG_HARD_I2C. 1296b37c7e5eSwdenk 1297b37c7e5eSwdenk If you use the software i2c interface (CONFIG_SOFT_I2C) 1298b37c7e5eSwdenk then the following macros need to be defined (examples are 1299b37c7e5eSwdenk from include/configs/lwmon.h): 1300c609719bSwdenk 1301c609719bSwdenk I2C_INIT 1302c609719bSwdenk 1303b37c7e5eSwdenk (Optional). Any commands necessary to enable the I2C 1304c609719bSwdenk controller or configure ports. 1305c609719bSwdenk 1306b37c7e5eSwdenk eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL) 1307b37c7e5eSwdenk 1308c609719bSwdenk I2C_PORT 1309c609719bSwdenk 1310c609719bSwdenk (Only for MPC8260 CPU). The I/O port to use (the code 1311c609719bSwdenk assumes both bits are on the same port). Valid values 1312c609719bSwdenk are 0..3 for ports A..D. 1313c609719bSwdenk 1314c609719bSwdenk I2C_ACTIVE 1315c609719bSwdenk 1316c609719bSwdenk The code necessary to make the I2C data line active 1317c609719bSwdenk (driven). If the data line is open collector, this 1318c609719bSwdenk define can be null. 1319c609719bSwdenk 1320b37c7e5eSwdenk eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA) 1321b37c7e5eSwdenk 1322c609719bSwdenk I2C_TRISTATE 1323c609719bSwdenk 1324c609719bSwdenk The code necessary to make the I2C data line tri-stated 1325c609719bSwdenk (inactive). If the data line is open collector, this 1326c609719bSwdenk define can be null. 1327c609719bSwdenk 1328b37c7e5eSwdenk eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA) 1329b37c7e5eSwdenk 1330c609719bSwdenk I2C_READ 1331c609719bSwdenk 1332c609719bSwdenk Code that returns TRUE if the I2C data line is high, 1333c609719bSwdenk FALSE if it is low. 1334c609719bSwdenk 1335b37c7e5eSwdenk eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0) 1336b37c7e5eSwdenk 1337c609719bSwdenk I2C_SDA(bit) 1338c609719bSwdenk 1339c609719bSwdenk If <bit> is TRUE, sets the I2C data line high. If it 1340c609719bSwdenk is FALSE, it clears it (low). 1341c609719bSwdenk 1342b37c7e5eSwdenk eg: #define I2C_SDA(bit) \ 1343b37c7e5eSwdenk if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \ 1344b37c7e5eSwdenk else immr->im_cpm.cp_pbdat &= ~PB_SDA 1345b37c7e5eSwdenk 1346c609719bSwdenk I2C_SCL(bit) 1347c609719bSwdenk 1348c609719bSwdenk If <bit> is TRUE, sets the I2C clock line high. If it 1349c609719bSwdenk is FALSE, it clears it (low). 1350c609719bSwdenk 1351b37c7e5eSwdenk eg: #define I2C_SCL(bit) \ 1352b37c7e5eSwdenk if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \ 1353b37c7e5eSwdenk else immr->im_cpm.cp_pbdat &= ~PB_SCL 1354b37c7e5eSwdenk 1355c609719bSwdenk I2C_DELAY 1356c609719bSwdenk 1357c609719bSwdenk This delay is invoked four times per clock cycle so this 1358c609719bSwdenk controls the rate of data transfer. The data rate thus 1359b37c7e5eSwdenk is 1 / (I2C_DELAY * 4). Often defined to be something 1360b37c7e5eSwdenk like: 1361b37c7e5eSwdenk 1362b37c7e5eSwdenk #define I2C_DELAY udelay(2) 1363c609719bSwdenk 136447cd00faSwdenk CFG_I2C_INIT_BOARD 136547cd00faSwdenk 136647cd00faSwdenk When a board is reset during an i2c bus transfer 136747cd00faSwdenk chips might think that the current transfer is still 136847cd00faSwdenk in progress. On some boards it is possible to access 136947cd00faSwdenk the i2c SCLK line directly, either by using the 137047cd00faSwdenk processor pin as a GPIO or by having a second pin 137147cd00faSwdenk connected to the bus. If this option is defined a 137247cd00faSwdenk custom i2c_init_board() routine in boards/xxx/board.c 137347cd00faSwdenk is run early in the boot sequence. 137447cd00faSwdenk 137517ea1177Swdenk CONFIG_I2CFAST (PPC405GP|PPC405EP only) 137617ea1177Swdenk 137717ea1177Swdenk This option enables configuration of bi_iic_fast[] flags 137817ea1177Swdenk in u-boot bd_info structure based on u-boot environment 137917ea1177Swdenk variable "i2cfast". (see also i2cfast) 138017ea1177Swdenk 1381bb99ad6dSBen Warren CONFIG_I2C_MULTI_BUS 1382bb99ad6dSBen Warren 1383bb99ad6dSBen Warren This option allows the use of multiple I2C buses, each of which 1384bb99ad6dSBen Warren must have a controller. At any point in time, only one bus is 1385bb99ad6dSBen Warren active. To switch to a different bus, use the 'i2c dev' command. 1386bb99ad6dSBen Warren Note that bus numbering is zero-based. 1387bb99ad6dSBen Warren 1388bb99ad6dSBen Warren CFG_I2C_NOPROBES 1389bb99ad6dSBen Warren 1390bb99ad6dSBen Warren This option specifies a list of I2C devices that will be skipped 1391bb99ad6dSBen Warren when the 'i2c probe' command is issued (or 'iprobe' using the legacy 1392bb99ad6dSBen Warren command). If CONFIG_I2C_MULTI_BUS is set, specify a list of bus-device 1393bb99ad6dSBen Warren pairs. Otherwise, specify a 1D array of device addresses 1394bb99ad6dSBen Warren 1395bb99ad6dSBen Warren e.g. 1396bb99ad6dSBen Warren #undef CONFIG_I2C_MULTI_BUS 1397bb99ad6dSBen Warren #define CFG_I2C_NOPROBES {0x50,0x68} 1398bb99ad6dSBen Warren 1399bb99ad6dSBen Warren will skip addresses 0x50 and 0x68 on a board with one I2C bus 1400bb99ad6dSBen Warren 1401bb99ad6dSBen Warren #define CONFIG_I2C_MULTI_BUS 1402bb99ad6dSBen Warren #define CFG_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}} 1403bb99ad6dSBen Warren 1404bb99ad6dSBen Warren will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1 1405bb99ad6dSBen Warren 1406be5e6181STimur Tabi CFG_SPD_BUS_NUM 1407be5e6181STimur Tabi 1408be5e6181STimur Tabi If defined, then this indicates the I2C bus number for DDR SPD. 1409be5e6181STimur Tabi If not defined, then U-Boot assumes that SPD is on I2C bus 0. 1410be5e6181STimur Tabi 14110dc018ecSStefan Roese CFG_RTC_BUS_NUM 14120dc018ecSStefan Roese 14130dc018ecSStefan Roese If defined, then this indicates the I2C bus number for the RTC. 14140dc018ecSStefan Roese If not defined, then U-Boot assumes that RTC is on I2C bus 0. 14150dc018ecSStefan Roese 14160dc018ecSStefan Roese CFG_DTT_BUS_NUM 14170dc018ecSStefan Roese 14180dc018ecSStefan Roese If defined, then this indicates the I2C bus number for the DTT. 14190dc018ecSStefan Roese If not defined, then U-Boot assumes that DTT is on I2C bus 0. 14200dc018ecSStefan Roese 14219ebbb54fSVictor Gallardo CFG_I2C_DTT_ADDR: 14229ebbb54fSVictor Gallardo 14239ebbb54fSVictor Gallardo If defined, specifies the I2C address of the DTT device. 14249ebbb54fSVictor Gallardo If not defined, then U-Boot uses predefined value for 14259ebbb54fSVictor Gallardo specified DTT device. 14269ebbb54fSVictor Gallardo 1427be5e6181STimur Tabi CONFIG_FSL_I2C 1428be5e6181STimur Tabi 1429be5e6181STimur Tabi Define this option if you want to use Freescale's I2C driver in 14307817cb20SMarcel Ziswiler drivers/i2c/fsl_i2c.c. 1431be5e6181STimur Tabi 1432*67b23a32SHeiko Schocher CONFIG_I2C_MUX 1433*67b23a32SHeiko Schocher 1434*67b23a32SHeiko Schocher Define this option if you have I2C devices reached over 1 .. n 1435*67b23a32SHeiko Schocher I2C Muxes like the pca9544a. This option addes a new I2C 1436*67b23a32SHeiko Schocher Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a 1437*67b23a32SHeiko Schocher new I2C Bus to the existing I2C Busses. If you select the 1438*67b23a32SHeiko Schocher new Bus with "i2c dev", u-bbot sends first the commandos for 1439*67b23a32SHeiko Schocher the muxes to activate this new "bus". 1440*67b23a32SHeiko Schocher 1441*67b23a32SHeiko Schocher CONFIG_I2C_MULTI_BUS must be also defined, to use this 1442*67b23a32SHeiko Schocher feature! 1443*67b23a32SHeiko Schocher 1444*67b23a32SHeiko Schocher Example: 1445*67b23a32SHeiko Schocher Adding a new I2C Bus reached over 2 pca9544a muxes 1446*67b23a32SHeiko Schocher The First mux with address 70 and channel 6 1447*67b23a32SHeiko Schocher The Second mux with address 71 and channel 4 1448*67b23a32SHeiko Schocher 1449*67b23a32SHeiko Schocher => i2c bus pca9544a:70:6:pca9544a:71:4 1450*67b23a32SHeiko Schocher 1451*67b23a32SHeiko Schocher Use the "i2c bus" command without parameter, to get a list 1452*67b23a32SHeiko Schocher of I2C Busses with muxes: 1453*67b23a32SHeiko Schocher 1454*67b23a32SHeiko Schocher => i2c bus 1455*67b23a32SHeiko Schocher Busses reached over muxes: 1456*67b23a32SHeiko Schocher Bus ID: 2 1457*67b23a32SHeiko Schocher reached over Mux(es): 1458*67b23a32SHeiko Schocher pca9544a@70 ch: 4 1459*67b23a32SHeiko Schocher Bus ID: 3 1460*67b23a32SHeiko Schocher reached over Mux(es): 1461*67b23a32SHeiko Schocher pca9544a@70 ch: 6 1462*67b23a32SHeiko Schocher pca9544a@71 ch: 4 1463*67b23a32SHeiko Schocher => 1464*67b23a32SHeiko Schocher 1465*67b23a32SHeiko Schocher If you now switch to the new I2C Bus 3 with "i2c dev 3" 1466*67b23a32SHeiko Schocher u-boot sends First the Commando to the mux@70 to enable 1467*67b23a32SHeiko Schocher channel 6, and then the Commando to the mux@71 to enable 1468*67b23a32SHeiko Schocher the channel 4. 1469*67b23a32SHeiko Schocher 1470*67b23a32SHeiko Schocher After that, you can use the "normal" i2c commands as 1471*67b23a32SHeiko Schocher usual, to communicate with your I2C devices behind 1472*67b23a32SHeiko Schocher the 2 muxes. 1473*67b23a32SHeiko Schocher 1474*67b23a32SHeiko Schocher This option is actually implemented for the bitbanging 1475*67b23a32SHeiko Schocher algorithm in common/soft_i2c.c and for the Hardware I2C 1476*67b23a32SHeiko Schocher Bus on the MPC8260. But it should be not so difficult 1477*67b23a32SHeiko Schocher to add this option to other architectures. 1478*67b23a32SHeiko Schocher 1479be5e6181STimur Tabi 1480c609719bSwdenk- SPI Support: CONFIG_SPI 1481c609719bSwdenk 1482c609719bSwdenk Enables SPI driver (so far only tested with 1483c609719bSwdenk SPI EEPROM, also an instance works with Crystal A/D and 1484c609719bSwdenk D/As on the SACSng board) 1485c609719bSwdenk 1486c609719bSwdenk CONFIG_SPI_X 1487c609719bSwdenk 1488c609719bSwdenk Enables extended (16-bit) SPI EEPROM addressing. 1489c609719bSwdenk (symmetrical to CONFIG_I2C_X) 1490c609719bSwdenk 1491c609719bSwdenk CONFIG_SOFT_SPI 1492c609719bSwdenk 1493c609719bSwdenk Enables a software (bit-bang) SPI driver rather than 1494c609719bSwdenk using hardware support. This is a general purpose 1495c609719bSwdenk driver that only requires three general I/O port pins 1496c609719bSwdenk (two outputs, one input) to function. If this is 1497c609719bSwdenk defined, the board configuration must define several 1498c609719bSwdenk SPI configuration items (port pins to use, etc). For 1499c609719bSwdenk an example, see include/configs/sacsng.h. 1500c609719bSwdenk 150104a9e118SBen Warren CONFIG_HARD_SPI 150204a9e118SBen Warren 150304a9e118SBen Warren Enables a hardware SPI driver for general-purpose reads 150404a9e118SBen Warren and writes. As with CONFIG_SOFT_SPI, the board configuration 150504a9e118SBen Warren must define a list of chip-select function pointers. 150604a9e118SBen Warren Currently supported on some MPC8xxx processors. For an 150704a9e118SBen Warren example, see include/configs/mpc8349emds.h. 150804a9e118SBen Warren 150938254f45SGuennadi Liakhovetski CONFIG_MXC_SPI 151038254f45SGuennadi Liakhovetski 151138254f45SGuennadi Liakhovetski Enables the driver for the SPI controllers on i.MX and MXC 151238254f45SGuennadi Liakhovetski SoCs. Currently only i.MX31 is supported. 151338254f45SGuennadi Liakhovetski 15140133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA 15150133502eSMatthias Fuchs 15160133502eSMatthias Fuchs Enables FPGA subsystem. 15170133502eSMatthias Fuchs 15180133502eSMatthias Fuchs CONFIG_FPGA_<vendor> 15190133502eSMatthias Fuchs 15200133502eSMatthias Fuchs Enables support for specific chip vendors. 15210133502eSMatthias Fuchs (ALTERA, XILINX) 15220133502eSMatthias Fuchs 15230133502eSMatthias Fuchs CONFIG_FPGA_<family> 15240133502eSMatthias Fuchs 15250133502eSMatthias Fuchs Enables support for FPGA family. 15260133502eSMatthias Fuchs (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX) 15270133502eSMatthias Fuchs 15280133502eSMatthias Fuchs CONFIG_FPGA_COUNT 1529c609719bSwdenk 1530c609719bSwdenk Specify the number of FPGA devices to support. 1531c609719bSwdenk 1532c609719bSwdenk CFG_FPGA_PROG_FEEDBACK 1533c609719bSwdenk 1534c609719bSwdenk Enable printing of hash marks during FPGA configuration. 1535c609719bSwdenk 1536c609719bSwdenk CFG_FPGA_CHECK_BUSY 1537c609719bSwdenk 1538c609719bSwdenk Enable checks on FPGA configuration interface busy 1539c609719bSwdenk status by the configuration function. This option 1540c609719bSwdenk will require a board or device specific function to 1541c609719bSwdenk be written. 1542c609719bSwdenk 1543c609719bSwdenk CONFIG_FPGA_DELAY 1544c609719bSwdenk 1545c609719bSwdenk If defined, a function that provides delays in the FPGA 1546c609719bSwdenk configuration driver. 1547c609719bSwdenk 1548c609719bSwdenk CFG_FPGA_CHECK_CTRLC 1549c609719bSwdenk Allow Control-C to interrupt FPGA configuration 1550c609719bSwdenk 1551c609719bSwdenk CFG_FPGA_CHECK_ERROR 1552c609719bSwdenk 1553c609719bSwdenk Check for configuration errors during FPGA bitfile 1554c609719bSwdenk loading. For example, abort during Virtex II 1555c609719bSwdenk configuration if the INIT_B line goes low (which 1556c609719bSwdenk indicated a CRC error). 1557c609719bSwdenk 1558c609719bSwdenk CFG_FPGA_WAIT_INIT 1559c609719bSwdenk 1560c609719bSwdenk Maximum time to wait for the INIT_B line to deassert 1561c609719bSwdenk after PROB_B has been deasserted during a Virtex II 1562c609719bSwdenk FPGA configuration sequence. The default time is 500 156311ccc33fSMarcel Ziswiler ms. 1564c609719bSwdenk 1565c609719bSwdenk CFG_FPGA_WAIT_BUSY 1566c609719bSwdenk 1567c609719bSwdenk Maximum time to wait for BUSY to deassert during 156811ccc33fSMarcel Ziswiler Virtex II FPGA configuration. The default is 5 ms. 1569c609719bSwdenk 1570c609719bSwdenk CFG_FPGA_WAIT_CONFIG 1571c609719bSwdenk 1572c609719bSwdenk Time to wait after FPGA configuration. The default is 157311ccc33fSMarcel Ziswiler 200 ms. 1574c609719bSwdenk 1575c609719bSwdenk- Configuration Management: 1576c609719bSwdenk CONFIG_IDENT_STRING 1577c609719bSwdenk 1578c609719bSwdenk If defined, this string will be added to the U-Boot 1579c609719bSwdenk version information (U_BOOT_VERSION) 1580c609719bSwdenk 1581c609719bSwdenk- Vendor Parameter Protection: 1582c609719bSwdenk 1583c609719bSwdenk U-Boot considers the values of the environment 1584c609719bSwdenk variables "serial#" (Board Serial Number) and 15857152b1d0Swdenk "ethaddr" (Ethernet Address) to be parameters that 1586c609719bSwdenk are set once by the board vendor / manufacturer, and 1587c609719bSwdenk protects these variables from casual modification by 1588c609719bSwdenk the user. Once set, these variables are read-only, 1589c609719bSwdenk and write or delete attempts are rejected. You can 159011ccc33fSMarcel Ziswiler change this behaviour: 1591c609719bSwdenk 1592c609719bSwdenk If CONFIG_ENV_OVERWRITE is #defined in your config 1593c609719bSwdenk file, the write protection for vendor parameters is 159447cd00faSwdenk completely disabled. Anybody can change or delete 1595c609719bSwdenk these parameters. 1596c609719bSwdenk 1597c609719bSwdenk Alternatively, if you #define _both_ CONFIG_ETHADDR 1598c609719bSwdenk _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default 159911ccc33fSMarcel Ziswiler Ethernet address is installed in the environment, 1600c609719bSwdenk which can be changed exactly ONCE by the user. [The 1601c609719bSwdenk serial# is unaffected by this, i. e. it remains 1602c609719bSwdenk read-only.] 1603c609719bSwdenk 1604c609719bSwdenk- Protected RAM: 1605c609719bSwdenk CONFIG_PRAM 1606c609719bSwdenk 1607c609719bSwdenk Define this variable to enable the reservation of 1608c609719bSwdenk "protected RAM", i. e. RAM which is not overwritten 1609c609719bSwdenk by U-Boot. Define CONFIG_PRAM to hold the number of 1610c609719bSwdenk kB you want to reserve for pRAM. You can overwrite 1611c609719bSwdenk this default value by defining an environment 1612c609719bSwdenk variable "pram" to the number of kB you want to 1613c609719bSwdenk reserve. Note that the board info structure will 1614c609719bSwdenk still show the full amount of RAM. If pRAM is 1615c609719bSwdenk reserved, a new environment variable "mem" will 1616c609719bSwdenk automatically be defined to hold the amount of 1617c609719bSwdenk remaining RAM in a form that can be passed as boot 1618c609719bSwdenk argument to Linux, for instance like that: 1619c609719bSwdenk 1620fe126d8bSWolfgang Denk setenv bootargs ... mem=\${mem} 1621c609719bSwdenk saveenv 1622c609719bSwdenk 1623c609719bSwdenk This way you can tell Linux not to use this memory, 1624c609719bSwdenk either, which results in a memory region that will 1625c609719bSwdenk not be affected by reboots. 1626c609719bSwdenk 1627c609719bSwdenk *WARNING* If your board configuration uses automatic 1628c609719bSwdenk detection of the RAM size, you must make sure that 1629c609719bSwdenk this memory test is non-destructive. So far, the 1630c609719bSwdenk following board configurations are known to be 1631c609719bSwdenk "pRAM-clean": 1632c609719bSwdenk 1633c609719bSwdenk ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL, 1634c609719bSwdenk HERMES, IP860, RPXlite, LWMON, LANTEC, 1635c609719bSwdenk PCU_E, FLAGADM, TQM8260 1636c609719bSwdenk 1637c609719bSwdenk- Error Recovery: 1638c609719bSwdenk CONFIG_PANIC_HANG 1639c609719bSwdenk 1640c609719bSwdenk Define this variable to stop the system in case of a 1641c609719bSwdenk fatal error, so that you have to reset it manually. 1642c609719bSwdenk This is probably NOT a good idea for an embedded 164311ccc33fSMarcel Ziswiler system where you want the system to reboot 1644c609719bSwdenk automatically as fast as possible, but it may be 1645c609719bSwdenk useful during development since you can try to debug 1646c609719bSwdenk the conditions that lead to the situation. 1647c609719bSwdenk 1648c609719bSwdenk CONFIG_NET_RETRY_COUNT 1649c609719bSwdenk 1650c609719bSwdenk This variable defines the number of retries for 1651c609719bSwdenk network operations like ARP, RARP, TFTP, or BOOTP 1652c609719bSwdenk before giving up the operation. If not defined, a 1653c609719bSwdenk default value of 5 is used. 1654c609719bSwdenk 165540cb90eeSGuennadi Liakhovetski CONFIG_ARP_TIMEOUT 165640cb90eeSGuennadi Liakhovetski 165740cb90eeSGuennadi Liakhovetski Timeout waiting for an ARP reply in milliseconds. 165840cb90eeSGuennadi Liakhovetski 1659c609719bSwdenk- Command Interpreter: 16608078f1a5SWolfgang Denk CONFIG_AUTO_COMPLETE 166104a85b3bSwdenk 166204a85b3bSwdenk Enable auto completion of commands using TAB. 166304a85b3bSwdenk 16648078f1a5SWolfgang Denk Note that this feature has NOT been implemented yet 16658078f1a5SWolfgang Denk for the "hush" shell. 16668078f1a5SWolfgang Denk 16678078f1a5SWolfgang Denk 1668c609719bSwdenk CFG_HUSH_PARSER 1669c609719bSwdenk 1670c609719bSwdenk Define this variable to enable the "hush" shell (from 1671c609719bSwdenk Busybox) as command line interpreter, thus enabling 1672c609719bSwdenk powerful command line syntax like 1673c609719bSwdenk if...then...else...fi conditionals or `&&' and '||' 1674c609719bSwdenk constructs ("shell scripts"). 1675c609719bSwdenk 1676c609719bSwdenk If undefined, you get the old, much simpler behaviour 1677c609719bSwdenk with a somewhat smaller memory footprint. 1678c609719bSwdenk 1679c609719bSwdenk 1680c609719bSwdenk CFG_PROMPT_HUSH_PS2 1681c609719bSwdenk 1682c609719bSwdenk This defines the secondary prompt string, which is 1683c609719bSwdenk printed when the command interpreter needs more input 1684c609719bSwdenk to complete a command. Usually "> ". 1685c609719bSwdenk 1686c609719bSwdenk Note: 1687c609719bSwdenk 1688c609719bSwdenk In the current implementation, the local variables 1689c609719bSwdenk space and global environment variables space are 1690c609719bSwdenk separated. Local variables are those you define by 16913b57fe0aSwdenk simply typing `name=value'. To access a local 1692c609719bSwdenk variable later on, you have write `$name' or 16933b57fe0aSwdenk `${name}'; to execute the contents of a variable 16943b57fe0aSwdenk directly type `$name' at the command prompt. 1695c609719bSwdenk 1696c609719bSwdenk Global environment variables are those you use 1697c609719bSwdenk setenv/printenv to work with. To run a command stored 1698c609719bSwdenk in such a variable, you need to use the run command, 1699c609719bSwdenk and you must not use the '$' sign to access them. 1700c609719bSwdenk 1701c609719bSwdenk To store commands and special characters in a 1702c609719bSwdenk variable, please use double quotation marks 1703c609719bSwdenk surrounding the whole text of the variable, instead 1704c609719bSwdenk of the backslashes before semicolons and special 1705c609719bSwdenk symbols. 1706c609719bSwdenk 1707aa0c71acSWolfgang Denk- Commandline Editing and History: 1708aa0c71acSWolfgang Denk CONFIG_CMDLINE_EDITING 1709aa0c71acSWolfgang Denk 171011ccc33fSMarcel Ziswiler Enable editing and History functions for interactive 1711aa0c71acSWolfgang Denk commandline input operations 1712aa0c71acSWolfgang Denk 1713a8c7c708Swdenk- Default Environment: 1714c609719bSwdenk CONFIG_EXTRA_ENV_SETTINGS 1715c609719bSwdenk 1716c609719bSwdenk Define this to contain any number of null terminated 1717c609719bSwdenk strings (variable = value pairs) that will be part of 17187152b1d0Swdenk the default environment compiled into the boot image. 17192262cfeeSwdenk 1720c609719bSwdenk For example, place something like this in your 1721c609719bSwdenk board's config file: 1722c609719bSwdenk 1723c609719bSwdenk #define CONFIG_EXTRA_ENV_SETTINGS \ 1724c609719bSwdenk "myvar1=value1\0" \ 1725c609719bSwdenk "myvar2=value2\0" 1726c609719bSwdenk 1727c609719bSwdenk Warning: This method is based on knowledge about the 1728c609719bSwdenk internal format how the environment is stored by the 17292262cfeeSwdenk U-Boot code. This is NOT an official, exported 1730c609719bSwdenk interface! Although it is unlikely that this format 17317152b1d0Swdenk will change soon, there is no guarantee either. 1732c609719bSwdenk You better know what you are doing here. 1733c609719bSwdenk 1734c609719bSwdenk Note: overly (ab)use of the default environment is 1735c609719bSwdenk discouraged. Make sure to check other ways to preset 1736c609719bSwdenk the environment like the autoscript function or the 1737c609719bSwdenk boot command first. 1738c609719bSwdenk 1739a8c7c708Swdenk- DataFlash Support: 17402abbe075Swdenk CONFIG_HAS_DATAFLASH 17412abbe075Swdenk 17422abbe075Swdenk Defining this option enables DataFlash features and 17432abbe075Swdenk allows to read/write in Dataflash via the standard 17442abbe075Swdenk commands cp, md... 17452abbe075Swdenk 17463f85ce27Swdenk- SystemACE Support: 17473f85ce27Swdenk CONFIG_SYSTEMACE 17483f85ce27Swdenk 17493f85ce27Swdenk Adding this option adds support for Xilinx SystemACE 17503f85ce27Swdenk chips attached via some sort of local bus. The address 175111ccc33fSMarcel Ziswiler of the chip must also be defined in the 17523f85ce27Swdenk CFG_SYSTEMACE_BASE macro. For example: 17533f85ce27Swdenk 17543f85ce27Swdenk #define CONFIG_SYSTEMACE 17553f85ce27Swdenk #define CFG_SYSTEMACE_BASE 0xf0000000 17563f85ce27Swdenk 17573f85ce27Swdenk When SystemACE support is added, the "ace" device type 17583f85ce27Swdenk becomes available to the fat commands, i.e. fatls. 17593f85ce27Swdenk 1760ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port: 1761ecb0ccd9SWolfgang Denk CONFIG_TFTP_PORT 1762ecb0ccd9SWolfgang Denk 176328cb9375SWolfgang Denk If this is defined, the environment variable tftpsrcp 1764ecb0ccd9SWolfgang Denk is used to supply the TFTP UDP source port value. 176528cb9375SWolfgang Denk If tftpsrcp isn't defined, the normal pseudo-random port 1766ecb0ccd9SWolfgang Denk number generator is used. 1767ecb0ccd9SWolfgang Denk 176828cb9375SWolfgang Denk Also, the environment variable tftpdstp is used to supply 176928cb9375SWolfgang Denk the TFTP UDP destination port value. If tftpdstp isn't 177028cb9375SWolfgang Denk defined, the normal port 69 is used. 177128cb9375SWolfgang Denk 177228cb9375SWolfgang Denk The purpose for tftpsrcp is to allow a TFTP server to 1773ecb0ccd9SWolfgang Denk blindly start the TFTP transfer using the pre-configured 1774ecb0ccd9SWolfgang Denk target IP address and UDP port. This has the effect of 1775ecb0ccd9SWolfgang Denk "punching through" the (Windows XP) firewall, allowing 1776ecb0ccd9SWolfgang Denk the remainder of the TFTP transfer to proceed normally. 1777ecb0ccd9SWolfgang Denk A better solution is to properly configure the firewall, 1778ecb0ccd9SWolfgang Denk but sometimes that is not allowed. 1779ecb0ccd9SWolfgang Denk 1780a8c7c708Swdenk- Show boot progress: 1781c609719bSwdenk CONFIG_SHOW_BOOT_PROGRESS 1782c609719bSwdenk 1783c609719bSwdenk Defining this option allows to add some board- 1784c609719bSwdenk specific code (calling a user-provided function 1785c609719bSwdenk "show_boot_progress(int)") that enables you to show 1786c609719bSwdenk the system's boot progress on some display (for 1787c609719bSwdenk example, some LED's) on your board. At the moment, 1788c609719bSwdenk the following checkpoints are implemented: 1789c609719bSwdenk 17904bae9090SBartlomiej Sieka- Automatic software updates via TFTP server 17914bae9090SBartlomiej Sieka CONFIG_UPDATE_TFTP 17924bae9090SBartlomiej Sieka CONFIG_UPDATE_TFTP_CNT_MAX 17934bae9090SBartlomiej Sieka CONFIG_UPDATE_TFTP_MSEC_MAX 17944bae9090SBartlomiej Sieka 17954bae9090SBartlomiej Sieka These options enable and control the auto-update feature; 17964bae9090SBartlomiej Sieka for a more detailed description refer to doc/README.update. 17974bae9090SBartlomiej Sieka 17981372cce2SMarian BalakowiczLegacy uImage format: 17991372cce2SMarian Balakowicz 1800c609719bSwdenk Arg Where When 1801c609719bSwdenk 1 common/cmd_bootm.c before attempting to boot an image 1802c609719bSwdenk -1 common/cmd_bootm.c Image header has bad magic number 1803c609719bSwdenk 2 common/cmd_bootm.c Image header has correct magic number 1804c609719bSwdenk -2 common/cmd_bootm.c Image header has bad checksum 1805c609719bSwdenk 3 common/cmd_bootm.c Image header has correct checksum 1806c609719bSwdenk -3 common/cmd_bootm.c Image data has bad checksum 1807c609719bSwdenk 4 common/cmd_bootm.c Image data has correct checksum 1808c609719bSwdenk -4 common/cmd_bootm.c Image is for unsupported architecture 1809c609719bSwdenk 5 common/cmd_bootm.c Architecture check OK 18101372cce2SMarian Balakowicz -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi) 1811c609719bSwdenk 6 common/cmd_bootm.c Image Type check OK 1812c609719bSwdenk -6 common/cmd_bootm.c gunzip uncompression error 1813c609719bSwdenk -7 common/cmd_bootm.c Unimplemented compression type 1814c609719bSwdenk 7 common/cmd_bootm.c Uncompression OK 18151372cce2SMarian Balakowicz 8 common/cmd_bootm.c No uncompress/copy overwrite error 1816c609719bSwdenk -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX) 18171372cce2SMarian Balakowicz 18181372cce2SMarian Balakowicz 9 common/image.c Start initial ramdisk verification 18191372cce2SMarian Balakowicz -10 common/image.c Ramdisk header has bad magic number 18201372cce2SMarian Balakowicz -11 common/image.c Ramdisk header has bad checksum 18211372cce2SMarian Balakowicz 10 common/image.c Ramdisk header is OK 18221372cce2SMarian Balakowicz -12 common/image.c Ramdisk data has bad checksum 18231372cce2SMarian Balakowicz 11 common/image.c Ramdisk data has correct checksum 18241372cce2SMarian Balakowicz 12 common/image.c Ramdisk verification complete, start loading 182511ccc33fSMarcel Ziswiler -13 common/image.c Wrong Image Type (not PPC Linux ramdisk) 18261372cce2SMarian Balakowicz 13 common/image.c Start multifile image verification 18271372cce2SMarian Balakowicz 14 common/image.c No initial ramdisk, no multifile, continue. 18281372cce2SMarian Balakowicz 18291372cce2SMarian Balakowicz 15 lib_<arch>/bootm.c All preparation done, transferring control to OS 1830c609719bSwdenk 183163e73c9aSwdenk -30 lib_ppc/board.c Fatal error, hang the system 183263e73c9aSwdenk -31 post/post.c POST test failed, detected by post_output_backlog() 183363e73c9aSwdenk -32 post/post.c POST test failed, detected by post_run_single() 183463e73c9aSwdenk 1835566a494fSHeiko Schocher 34 common/cmd_doc.c before loading a Image from a DOC device 1836566a494fSHeiko Schocher -35 common/cmd_doc.c Bad usage of "doc" command 1837566a494fSHeiko Schocher 35 common/cmd_doc.c correct usage of "doc" command 1838566a494fSHeiko Schocher -36 common/cmd_doc.c No boot device 1839566a494fSHeiko Schocher 36 common/cmd_doc.c correct boot device 1840566a494fSHeiko Schocher -37 common/cmd_doc.c Unknown Chip ID on boot device 1841566a494fSHeiko Schocher 37 common/cmd_doc.c correct chip ID found, device available 1842566a494fSHeiko Schocher -38 common/cmd_doc.c Read Error on boot device 1843566a494fSHeiko Schocher 38 common/cmd_doc.c reading Image header from DOC device OK 1844566a494fSHeiko Schocher -39 common/cmd_doc.c Image header has bad magic number 1845566a494fSHeiko Schocher 39 common/cmd_doc.c Image header has correct magic number 1846566a494fSHeiko Schocher -40 common/cmd_doc.c Error reading Image from DOC device 1847566a494fSHeiko Schocher 40 common/cmd_doc.c Image header has correct magic number 1848566a494fSHeiko Schocher 41 common/cmd_ide.c before loading a Image from a IDE device 1849566a494fSHeiko Schocher -42 common/cmd_ide.c Bad usage of "ide" command 1850566a494fSHeiko Schocher 42 common/cmd_ide.c correct usage of "ide" command 1851566a494fSHeiko Schocher -43 common/cmd_ide.c No boot device 1852566a494fSHeiko Schocher 43 common/cmd_ide.c boot device found 1853566a494fSHeiko Schocher -44 common/cmd_ide.c Device not available 1854566a494fSHeiko Schocher 44 common/cmd_ide.c Device available 1855566a494fSHeiko Schocher -45 common/cmd_ide.c wrong partition selected 1856566a494fSHeiko Schocher 45 common/cmd_ide.c partition selected 1857566a494fSHeiko Schocher -46 common/cmd_ide.c Unknown partition table 1858566a494fSHeiko Schocher 46 common/cmd_ide.c valid partition table found 1859566a494fSHeiko Schocher -47 common/cmd_ide.c Invalid partition type 1860566a494fSHeiko Schocher 47 common/cmd_ide.c correct partition type 1861566a494fSHeiko Schocher -48 common/cmd_ide.c Error reading Image Header on boot device 1862566a494fSHeiko Schocher 48 common/cmd_ide.c reading Image Header from IDE device OK 1863566a494fSHeiko Schocher -49 common/cmd_ide.c Image header has bad magic number 1864566a494fSHeiko Schocher 49 common/cmd_ide.c Image header has correct magic number 1865566a494fSHeiko Schocher -50 common/cmd_ide.c Image header has bad checksum 1866566a494fSHeiko Schocher 50 common/cmd_ide.c Image header has correct checksum 1867566a494fSHeiko Schocher -51 common/cmd_ide.c Error reading Image from IDE device 1868566a494fSHeiko Schocher 51 common/cmd_ide.c reading Image from IDE device OK 1869566a494fSHeiko Schocher 52 common/cmd_nand.c before loading a Image from a NAND device 1870566a494fSHeiko Schocher -53 common/cmd_nand.c Bad usage of "nand" command 1871566a494fSHeiko Schocher 53 common/cmd_nand.c correct usage of "nand" command 1872566a494fSHeiko Schocher -54 common/cmd_nand.c No boot device 1873566a494fSHeiko Schocher 54 common/cmd_nand.c boot device found 1874566a494fSHeiko Schocher -55 common/cmd_nand.c Unknown Chip ID on boot device 1875566a494fSHeiko Schocher 55 common/cmd_nand.c correct chip ID found, device available 1876566a494fSHeiko Schocher -56 common/cmd_nand.c Error reading Image Header on boot device 1877566a494fSHeiko Schocher 56 common/cmd_nand.c reading Image Header from NAND device OK 1878566a494fSHeiko Schocher -57 common/cmd_nand.c Image header has bad magic number 1879566a494fSHeiko Schocher 57 common/cmd_nand.c Image header has correct magic number 1880566a494fSHeiko Schocher -58 common/cmd_nand.c Error reading Image from NAND device 1881566a494fSHeiko Schocher 58 common/cmd_nand.c reading Image from NAND device OK 1882c609719bSwdenk 1883566a494fSHeiko Schocher -60 common/env_common.c Environment has a bad CRC, using default 1884c609719bSwdenk 1885566a494fSHeiko Schocher 64 net/eth.c starting with Ethernet configuration. 1886566a494fSHeiko Schocher -64 net/eth.c no Ethernet found. 1887566a494fSHeiko Schocher 65 net/eth.c Ethernet found. 1888206c60cbSwdenk 1889566a494fSHeiko Schocher -80 common/cmd_net.c usage wrong 1890566a494fSHeiko Schocher 80 common/cmd_net.c before calling NetLoop() 189111ccc33fSMarcel Ziswiler -81 common/cmd_net.c some error in NetLoop() occurred 1892566a494fSHeiko Schocher 81 common/cmd_net.c NetLoop() back without error 1893566a494fSHeiko Schocher -82 common/cmd_net.c size == 0 (File with size 0 loaded) 1894566a494fSHeiko Schocher 82 common/cmd_net.c trying automatic boot 1895566a494fSHeiko Schocher 83 common/cmd_net.c running autoscript 1896566a494fSHeiko Schocher -83 common/cmd_net.c some error in automatic boot or autoscript 1897566a494fSHeiko Schocher 84 common/cmd_net.c end without errors 1898c609719bSwdenk 18991372cce2SMarian BalakowiczFIT uImage format: 19001372cce2SMarian Balakowicz 19011372cce2SMarian Balakowicz Arg Where When 19021372cce2SMarian Balakowicz 100 common/cmd_bootm.c Kernel FIT Image has correct format 19031372cce2SMarian Balakowicz -100 common/cmd_bootm.c Kernel FIT Image has incorrect format 19041372cce2SMarian Balakowicz 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration 19051372cce2SMarian Balakowicz -101 common/cmd_bootm.c Can't get configuration for kernel subimage 19061372cce2SMarian Balakowicz 102 common/cmd_bootm.c Kernel unit name specified 19071372cce2SMarian Balakowicz -103 common/cmd_bootm.c Can't get kernel subimage node offset 1908f773bea8SMarian Balakowicz 103 common/cmd_bootm.c Found configuration node 19091372cce2SMarian Balakowicz 104 common/cmd_bootm.c Got kernel subimage node offset 19101372cce2SMarian Balakowicz -104 common/cmd_bootm.c Kernel subimage hash verification failed 19111372cce2SMarian Balakowicz 105 common/cmd_bootm.c Kernel subimage hash verification OK 19121372cce2SMarian Balakowicz -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture 19131372cce2SMarian Balakowicz 106 common/cmd_bootm.c Architecture check OK 191411ccc33fSMarcel Ziswiler -106 common/cmd_bootm.c Kernel subimage has wrong type 191511ccc33fSMarcel Ziswiler 107 common/cmd_bootm.c Kernel subimage type OK 19161372cce2SMarian Balakowicz -107 common/cmd_bootm.c Can't get kernel subimage data/size 19171372cce2SMarian Balakowicz 108 common/cmd_bootm.c Got kernel subimage data/size 19181372cce2SMarian Balakowicz -108 common/cmd_bootm.c Wrong image type (not legacy, FIT) 19191372cce2SMarian Balakowicz -109 common/cmd_bootm.c Can't get kernel subimage type 19201372cce2SMarian Balakowicz -110 common/cmd_bootm.c Can't get kernel subimage comp 19211372cce2SMarian Balakowicz -111 common/cmd_bootm.c Can't get kernel subimage os 19221372cce2SMarian Balakowicz -112 common/cmd_bootm.c Can't get kernel subimage load address 19231372cce2SMarian Balakowicz -113 common/cmd_bootm.c Image uncompress/copy overwrite error 19241372cce2SMarian Balakowicz 19251372cce2SMarian Balakowicz 120 common/image.c Start initial ramdisk verification 19261372cce2SMarian Balakowicz -120 common/image.c Ramdisk FIT image has incorrect format 19271372cce2SMarian Balakowicz 121 common/image.c Ramdisk FIT image has correct format 192811ccc33fSMarcel Ziswiler 122 common/image.c No ramdisk subimage unit name, using configuration 19291372cce2SMarian Balakowicz -122 common/image.c Can't get configuration for ramdisk subimage 19301372cce2SMarian Balakowicz 123 common/image.c Ramdisk unit name specified 19311372cce2SMarian Balakowicz -124 common/image.c Can't get ramdisk subimage node offset 19321372cce2SMarian Balakowicz 125 common/image.c Got ramdisk subimage node offset 19331372cce2SMarian Balakowicz -125 common/image.c Ramdisk subimage hash verification failed 19341372cce2SMarian Balakowicz 126 common/image.c Ramdisk subimage hash verification OK 19351372cce2SMarian Balakowicz -126 common/image.c Ramdisk subimage for unsupported architecture 19361372cce2SMarian Balakowicz 127 common/image.c Architecture check OK 19371372cce2SMarian Balakowicz -127 common/image.c Can't get ramdisk subimage data/size 19381372cce2SMarian Balakowicz 128 common/image.c Got ramdisk subimage data/size 19391372cce2SMarian Balakowicz 129 common/image.c Can't get ramdisk load address 19401372cce2SMarian Balakowicz -129 common/image.c Got ramdisk load address 19411372cce2SMarian Balakowicz 194211ccc33fSMarcel Ziswiler -130 common/cmd_doc.c Incorrect FIT image format 19431372cce2SMarian Balakowicz 131 common/cmd_doc.c FIT image format OK 19441372cce2SMarian Balakowicz 194511ccc33fSMarcel Ziswiler -140 common/cmd_ide.c Incorrect FIT image format 19461372cce2SMarian Balakowicz 141 common/cmd_ide.c FIT image format OK 19471372cce2SMarian Balakowicz 194811ccc33fSMarcel Ziswiler -150 common/cmd_nand.c Incorrect FIT image format 19491372cce2SMarian Balakowicz 151 common/cmd_nand.c FIT image format OK 19501372cce2SMarian Balakowicz 19511372cce2SMarian Balakowicz 1952c609719bSwdenkModem Support: 1953c609719bSwdenk-------------- 1954c609719bSwdenk 195585ec0bccSwdenk[so far only for SMDK2400 and TRAB boards] 1956c609719bSwdenk 195711ccc33fSMarcel Ziswiler- Modem support enable: 1958c609719bSwdenk CONFIG_MODEM_SUPPORT 1959c609719bSwdenk 1960c609719bSwdenk- RTS/CTS Flow control enable: 1961c609719bSwdenk CONFIG_HWFLOW 1962c609719bSwdenk 1963c609719bSwdenk- Modem debug support: 1964c609719bSwdenk CONFIG_MODEM_SUPPORT_DEBUG 1965c609719bSwdenk 1966c609719bSwdenk Enables debugging stuff (char screen[1024], dbg()) 1967c609719bSwdenk for modem support. Useful only with BDI2000. 1968c609719bSwdenk 1969a8c7c708Swdenk- Interrupt support (PPC): 1970a8c7c708Swdenk 1971a8c7c708Swdenk There are common interrupt_init() and timer_interrupt() 1972a8c7c708Swdenk for all PPC archs. interrupt_init() calls interrupt_init_cpu() 197311ccc33fSMarcel Ziswiler for CPU specific initialization. interrupt_init_cpu() 1974a8c7c708Swdenk should set decrementer_count to appropriate value. If 197511ccc33fSMarcel Ziswiler CPU resets decrementer automatically after interrupt 1976a8c7c708Swdenk (ppc4xx) it should set decrementer_count to zero. 197711ccc33fSMarcel Ziswiler timer_interrupt() calls timer_interrupt_cpu() for CPU 1978a8c7c708Swdenk specific handling. If board has watchdog / status_led 1979a8c7c708Swdenk / other_activity_monitor it works automatically from 1980a8c7c708Swdenk general timer_interrupt(). 1981a8c7c708Swdenk 1982c609719bSwdenk- General: 1983c609719bSwdenk 1984c609719bSwdenk In the target system modem support is enabled when a 1985c609719bSwdenk specific key (key combination) is pressed during 1986c609719bSwdenk power-on. Otherwise U-Boot will boot normally 198711ccc33fSMarcel Ziswiler (autoboot). The key_pressed() function is called from 1988c609719bSwdenk board_init(). Currently key_pressed() is a dummy 1989c609719bSwdenk function, returning 1 and thus enabling modem 1990c609719bSwdenk initialization. 1991c609719bSwdenk 1992c609719bSwdenk If there are no modem init strings in the 1993c609719bSwdenk environment, U-Boot proceed to autoboot; the 1994c609719bSwdenk previous output (banner, info printfs) will be 199511ccc33fSMarcel Ziswiler suppressed, though. 1996c609719bSwdenk 1997c609719bSwdenk See also: doc/README.Modem 1998c609719bSwdenk 1999c609719bSwdenk 2000c609719bSwdenkConfiguration Settings: 2001c609719bSwdenk----------------------- 2002c609719bSwdenk 2003c609719bSwdenk- CFG_LONGHELP: Defined when you want long help messages included; 2004c609719bSwdenk undefine this when you're short of memory. 2005c609719bSwdenk 2006c609719bSwdenk- CFG_PROMPT: This is what U-Boot prints on the console to 2007c609719bSwdenk prompt for user input. 2008c609719bSwdenk 2009c609719bSwdenk- CFG_CBSIZE: Buffer size for input from the Console 2010c609719bSwdenk 2011c609719bSwdenk- CFG_PBSIZE: Buffer size for Console output 2012c609719bSwdenk 2013c609719bSwdenk- CFG_MAXARGS: max. Number of arguments accepted for monitor commands 2014c609719bSwdenk 2015c609719bSwdenk- CFG_BARGSIZE: Buffer size for Boot Arguments which are passed to 2016c609719bSwdenk the application (usually a Linux kernel) when it is 2017c609719bSwdenk booted 2018c609719bSwdenk 2019c609719bSwdenk- CFG_BAUDRATE_TABLE: 2020c609719bSwdenk List of legal baudrate settings for this board. 2021c609719bSwdenk 2022c609719bSwdenk- CFG_CONSOLE_INFO_QUIET 2023c609719bSwdenk Suppress display of console information at boot. 2024c609719bSwdenk 2025c609719bSwdenk- CFG_CONSOLE_IS_IN_ENV 2026c609719bSwdenk If the board specific function 2027c609719bSwdenk extern int overwrite_console (void); 2028c609719bSwdenk returns 1, the stdin, stderr and stdout are switched to the 2029c609719bSwdenk serial port, else the settings in the environment are used. 2030c609719bSwdenk 2031c609719bSwdenk- CFG_CONSOLE_OVERWRITE_ROUTINE 2032c609719bSwdenk Enable the call to overwrite_console(). 2033c609719bSwdenk 2034c609719bSwdenk- CFG_CONSOLE_ENV_OVERWRITE 2035c609719bSwdenk Enable overwrite of previous console environment settings. 2036c609719bSwdenk 2037c609719bSwdenk- CFG_MEMTEST_START, CFG_MEMTEST_END: 2038c609719bSwdenk Begin and End addresses of the area used by the 2039c609719bSwdenk simple memory test. 2040c609719bSwdenk 2041c609719bSwdenk- CFG_ALT_MEMTEST: 2042c609719bSwdenk Enable an alternate, more extensive memory test. 2043c609719bSwdenk 20445f535fe1Swdenk- CFG_MEMTEST_SCRATCH: 20455f535fe1Swdenk Scratch address used by the alternate memory test 20465f535fe1Swdenk You only need to set this if address zero isn't writeable 20475f535fe1Swdenk 204814f73ca6SStefan Roese- CFG_MEM_TOP_HIDE (PPC only): 204914f73ca6SStefan Roese If CFG_MEM_TOP_HIDE is defined in the board config header, 205014f73ca6SStefan Roese this specified memory area will get subtracted from the top 205111ccc33fSMarcel Ziswiler (end) of RAM and won't get "touched" at all by U-Boot. By 205214f73ca6SStefan Roese fixing up gd->ram_size the Linux kernel should gets passed 205314f73ca6SStefan Roese the now "corrected" memory size and won't touch it either. 205414f73ca6SStefan Roese This should work for arch/ppc and arch/powerpc. Only Linux 20555e12e75dSStefan Roese board ports in arch/powerpc with bootwrapper support that 205614f73ca6SStefan Roese recalculate the memory size from the SDRAM controller setup 20575e12e75dSStefan Roese will have to get fixed in Linux additionally. 205814f73ca6SStefan Roese 205914f73ca6SStefan Roese This option can be used as a workaround for the 440EPx/GRx 206014f73ca6SStefan Roese CHIP 11 errata where the last 256 bytes in SDRAM shouldn't 206114f73ca6SStefan Roese be touched. 206214f73ca6SStefan Roese 206314f73ca6SStefan Roese WARNING: Please make sure that this value is a multiple of 206414f73ca6SStefan Roese the Linux page size (normally 4k). If this is not the case, 206514f73ca6SStefan Roese then the end address of the Linux memory will be located at a 206614f73ca6SStefan Roese non page size aligned address and this could cause major 206714f73ca6SStefan Roese problems. 206814f73ca6SStefan Roese 2069c609719bSwdenk- CFG_TFTP_LOADADDR: 2070c609719bSwdenk Default load address for network file downloads 2071c609719bSwdenk 2072c609719bSwdenk- CFG_LOADS_BAUD_CHANGE: 2073c609719bSwdenk Enable temporary baudrate change while serial download 2074c609719bSwdenk 2075c609719bSwdenk- CFG_SDRAM_BASE: 2076c609719bSwdenk Physical start address of SDRAM. _Must_ be 0 here. 2077c609719bSwdenk 2078c609719bSwdenk- CFG_MBIO_BASE: 2079c609719bSwdenk Physical start address of Motherboard I/O (if using a 2080c609719bSwdenk Cogent motherboard) 2081c609719bSwdenk 2082c609719bSwdenk- CFG_FLASH_BASE: 2083c609719bSwdenk Physical start address of Flash memory. 2084c609719bSwdenk 2085c609719bSwdenk- CFG_MONITOR_BASE: 2086c609719bSwdenk Physical start address of boot monitor code (set by 2087c609719bSwdenk make config files to be same as the text base address 2088c609719bSwdenk (TEXT_BASE) used when linking) - same as 2089c609719bSwdenk CFG_FLASH_BASE when booting from flash. 2090c609719bSwdenk 2091c609719bSwdenk- CFG_MONITOR_LEN: 20923b57fe0aSwdenk Size of memory reserved for monitor code, used to 20933b57fe0aSwdenk determine _at_compile_time_ (!) if the environment is 20943b57fe0aSwdenk embedded within the U-Boot image, or in a separate 20953b57fe0aSwdenk flash sector. 2096c609719bSwdenk 2097c609719bSwdenk- CFG_MALLOC_LEN: 2098c609719bSwdenk Size of DRAM reserved for malloc() use. 2099c609719bSwdenk 210015940c9aSStefan Roese- CFG_BOOTM_LEN: 210115940c9aSStefan Roese Normally compressed uImages are limited to an 210215940c9aSStefan Roese uncompressed size of 8 MBytes. If this is not enough, 210315940c9aSStefan Roese you can define CFG_BOOTM_LEN in your board config file 210415940c9aSStefan Roese to adjust this setting to your needs. 2105c609719bSwdenk 2106c609719bSwdenk- CFG_BOOTMAPSZ: 2107c609719bSwdenk Maximum size of memory mapped by the startup code of 2108c609719bSwdenk the Linux kernel; all data that must be processed by 21097d721e34SBartlomiej Sieka the Linux kernel (bd_info, boot arguments, FDT blob if 21107d721e34SBartlomiej Sieka used) must be put below this limit, unless "bootm_low" 21117d721e34SBartlomiej Sieka enviroment variable is defined and non-zero. In such case 21127d721e34SBartlomiej Sieka all data for the Linux kernel must be between "bootm_low" 21137d721e34SBartlomiej Sieka and "bootm_low" + CFG_BOOTMAPSZ. 2114c609719bSwdenk 2115c609719bSwdenk- CFG_MAX_FLASH_BANKS: 2116c609719bSwdenk Max number of Flash memory banks 2117c609719bSwdenk 2118c609719bSwdenk- CFG_MAX_FLASH_SECT: 2119c609719bSwdenk Max number of sectors on a Flash chip 2120c609719bSwdenk 2121c609719bSwdenk- CFG_FLASH_ERASE_TOUT: 2122c609719bSwdenk Timeout for Flash erase operations (in ms) 2123c609719bSwdenk 2124c609719bSwdenk- CFG_FLASH_WRITE_TOUT: 2125c609719bSwdenk Timeout for Flash write operations (in ms) 2126c609719bSwdenk 21278564acf9Swdenk- CFG_FLASH_LOCK_TOUT 21288564acf9Swdenk Timeout for Flash set sector lock bit operation (in ms) 21298564acf9Swdenk 21308564acf9Swdenk- CFG_FLASH_UNLOCK_TOUT 21318564acf9Swdenk Timeout for Flash clear lock bits operation (in ms) 21328564acf9Swdenk 21338564acf9Swdenk- CFG_FLASH_PROTECTION 21348564acf9Swdenk If defined, hardware flash sectors protection is used 21358564acf9Swdenk instead of U-Boot software protection. 21368564acf9Swdenk 2137c609719bSwdenk- CFG_DIRECT_FLASH_TFTP: 2138c609719bSwdenk 2139c609719bSwdenk Enable TFTP transfers directly to flash memory; 2140c609719bSwdenk without this option such a download has to be 2141c609719bSwdenk performed in two steps: (1) download to RAM, and (2) 2142c609719bSwdenk copy from RAM to flash. 2143c609719bSwdenk 2144c609719bSwdenk The two-step approach is usually more reliable, since 2145c609719bSwdenk you can check if the download worked before you erase 214611ccc33fSMarcel Ziswiler the flash, but in some situations (when system RAM is 214711ccc33fSMarcel Ziswiler too limited to allow for a temporary copy of the 2148c609719bSwdenk downloaded image) this option may be very useful. 2149c609719bSwdenk 2150c609719bSwdenk- CFG_FLASH_CFI: 2151c609719bSwdenk Define if the flash driver uses extra elements in the 21525653fc33Swdenk common flash structure for storing flash geometry. 21535653fc33Swdenk 215400b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER 21555653fc33Swdenk This option also enables the building of the cfi_flash driver 21565653fc33Swdenk in the drivers directory 215753cf9435Sstroese 215896ef831fSGuennadi Liakhovetski- CFG_FLASH_USE_BUFFER_WRITE 215996ef831fSGuennadi Liakhovetski Use buffered writes to flash. 216096ef831fSGuennadi Liakhovetski 216196ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N 216296ef831fSGuennadi Liakhovetski s29ws-n MirrorBit flash has non-standard addresses for buffered 216396ef831fSGuennadi Liakhovetski write commands. 216496ef831fSGuennadi Liakhovetski 21655568e613SStefan Roese- CFG_FLASH_QUIET_TEST 21665568e613SStefan Roese If this option is defined, the common CFI flash doesn't 21675568e613SStefan Roese print it's warning upon not recognized FLASH banks. This 21685568e613SStefan Roese is useful, if some of the configured banks are only 21695568e613SStefan Roese optionally available. 21705568e613SStefan Roese 21719a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS 21729a042e9cSJerry Van Baren If defined (must be an integer), print out countdown 21739a042e9cSJerry Van Baren digits and dots. Recommended value: 45 (9..1) for 80 21749a042e9cSJerry Van Baren column displays, 15 (3..1) for 40 column displays. 21759a042e9cSJerry Van Baren 217653cf9435Sstroese- CFG_RX_ETH_BUFFER: 217711ccc33fSMarcel Ziswiler Defines the number of Ethernet receive buffers. On some 217811ccc33fSMarcel Ziswiler Ethernet controllers it is recommended to set this value 217953cf9435Sstroese to 8 or even higher (EEPRO100 or 405 EMAC), since all 218053cf9435Sstroese buffers can be full shortly after enabling the interface 218111ccc33fSMarcel Ziswiler on high Ethernet traffic. 218253cf9435Sstroese Defaults to 4 if not defined. 2183c609719bSwdenk 2184c609719bSwdenkThe following definitions that deal with the placement and management 2185c609719bSwdenkof environment data (variable area); in general, we support the 2186c609719bSwdenkfollowing configurations: 2187c609719bSwdenk 21885a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH: 2189c609719bSwdenk 2190c609719bSwdenk Define this if the environment is in flash memory. 2191c609719bSwdenk 2192c609719bSwdenk a) The environment occupies one whole flash sector, which is 2193c609719bSwdenk "embedded" in the text segment with the U-Boot code. This 2194c609719bSwdenk happens usually with "bottom boot sector" or "top boot 2195c609719bSwdenk sector" type flash chips, which have several smaller 2196c609719bSwdenk sectors at the start or the end. For instance, such a 2197c609719bSwdenk layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In 2198c609719bSwdenk such a case you would place the environment in one of the 2199c609719bSwdenk 4 kB sectors - with U-Boot code before and after it. With 2200c609719bSwdenk "top boot sector" type flash chips, you would put the 2201c609719bSwdenk environment in one of the last sectors, leaving a gap 2202c609719bSwdenk between U-Boot and the environment. 2203c609719bSwdenk 22040e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 2205c609719bSwdenk 2206c609719bSwdenk Offset of environment data (variable area) to the 2207c609719bSwdenk beginning of flash memory; for instance, with bottom boot 2208c609719bSwdenk type flash chips the second sector can be used: the offset 2209c609719bSwdenk for this sector is given here. 2210c609719bSwdenk 22110e8d1586SJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_OFFSET is used relative to CFG_FLASH_BASE. 2212c609719bSwdenk 22130e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 2214c609719bSwdenk 2215c609719bSwdenk This is just another way to specify the start address of 2216c609719bSwdenk the flash sector containing the environment (instead of 22170e8d1586SJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_OFFSET). 2218c609719bSwdenk 22190e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SECT_SIZE: 2220c609719bSwdenk 2221c609719bSwdenk Size of the sector containing the environment. 2222c609719bSwdenk 2223c609719bSwdenk 2224c609719bSwdenk b) Sometimes flash chips have few, equal sized, BIG sectors. 2225c609719bSwdenk In such a case you don't want to spend a whole sector for 2226c609719bSwdenk the environment. 2227c609719bSwdenk 22280e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 2229c609719bSwdenk 22305a1aceb0SJean-Christophe PLAGNIOL-VILLARD If you use this in combination with CONFIG_ENV_IS_IN_FLASH 22310e8d1586SJean-Christophe PLAGNIOL-VILLARD and CONFIG_ENV_SECT_SIZE, you can specify to use only a part 2232c609719bSwdenk of this flash sector for the environment. This saves 2233c609719bSwdenk memory for the RAM copy of the environment. 2234c609719bSwdenk 2235c609719bSwdenk It may also save flash memory if you decide to use this 2236c609719bSwdenk when your environment is "embedded" within U-Boot code, 2237c609719bSwdenk since then the remainder of the flash sector could be used 2238c609719bSwdenk for U-Boot code. It should be pointed out that this is 2239c609719bSwdenk STRONGLY DISCOURAGED from a robustness point of view: 2240c609719bSwdenk updating the environment in flash makes it always 2241c609719bSwdenk necessary to erase the WHOLE sector. If something goes 2242c609719bSwdenk wrong before the contents has been restored from a copy in 2243c609719bSwdenk RAM, your target system will be dead. 2244c609719bSwdenk 22450e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR_REDUND 22460e8d1586SJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_SIZE_REDUND 2247c609719bSwdenk 2248c609719bSwdenk These settings describe a second storage area used to hold 224911ccc33fSMarcel Ziswiler a redundant copy of the environment data, so that there is 22503e38691eSwdenk a valid backup copy in case there is a power failure during 2251c609719bSwdenk a "saveenv" operation. 2252c609719bSwdenk 2253c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the 2254c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds* 2255c609719bSwdenkaccordingly! 2256c609719bSwdenk 2257c609719bSwdenk 22589314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM: 2259c609719bSwdenk 2260c609719bSwdenk Define this if you have some non-volatile memory device 2261c609719bSwdenk (NVRAM, battery buffered SRAM) which you want to use for the 2262c609719bSwdenk environment. 2263c609719bSwdenk 22640e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 22650e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 2266c609719bSwdenk 226711ccc33fSMarcel Ziswiler These two #defines are used to determine the memory area you 2268c609719bSwdenk want to use for environment. It is assumed that this memory 2269c609719bSwdenk can just be read and written to, without any special 2270c609719bSwdenk provision. 2271c609719bSwdenk 2272c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early 2273c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the 227411ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or 2275c609719bSwdenkU-Boot will hang. 2276c609719bSwdenk 2277c609719bSwdenkPlease note that even with NVRAM we still use a copy of the 2278c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to 2279c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv" 2280c609719bSwdenkto save the current settings. 2281c609719bSwdenk 2282c609719bSwdenk 2283bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM: 2284c609719bSwdenk 2285c609719bSwdenk Use this if you have an EEPROM or similar serial access 2286c609719bSwdenk device and a driver for it. 2287c609719bSwdenk 22880e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 22890e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 2290c609719bSwdenk 2291c609719bSwdenk These two #defines specify the offset and size of the 2292c609719bSwdenk environment area within the total memory of your EEPROM. 2293c609719bSwdenk 2294c609719bSwdenk - CFG_I2C_EEPROM_ADDR: 2295c609719bSwdenk If defined, specified the chip address of the EEPROM device. 2296c609719bSwdenk The default address is zero. 2297c609719bSwdenk 2298c609719bSwdenk - CFG_EEPROM_PAGE_WRITE_BITS: 2299c609719bSwdenk If defined, the number of bits used to address bytes in a 2300c609719bSwdenk single page in the EEPROM device. A 64 byte page, for example 2301c609719bSwdenk would require six bits. 2302c609719bSwdenk 2303c609719bSwdenk - CFG_EEPROM_PAGE_WRITE_DELAY_MS: 2304c609719bSwdenk If defined, the number of milliseconds to delay between 2305c609719bSwdenk page writes. The default is zero milliseconds. 2306c609719bSwdenk 2307c609719bSwdenk - CFG_I2C_EEPROM_ADDR_LEN: 2308c609719bSwdenk The length in bytes of the EEPROM memory array address. Note 2309c609719bSwdenk that this is NOT the chip address length! 2310c609719bSwdenk 23115cf91d6bSwdenk - CFG_I2C_EEPROM_ADDR_OVERFLOW: 23125cf91d6bSwdenk EEPROM chips that implement "address overflow" are ones 23135cf91d6bSwdenk like Catalyst 24WC04/08/16 which has 9/10/11 bits of 23145cf91d6bSwdenk address and the extra bits end up in the "chip address" bit 23155cf91d6bSwdenk slots. This makes a 24WC08 (1Kbyte) chip look like four 256 23165cf91d6bSwdenk byte chips. 23175cf91d6bSwdenk 23185cf91d6bSwdenk Note that we consider the length of the address field to 23195cf91d6bSwdenk still be one byte because the extra address bits are hidden 23205cf91d6bSwdenk in the chip address. 23215cf91d6bSwdenk 2322c609719bSwdenk - CFG_EEPROM_SIZE: 2323c609719bSwdenk The size in bytes of the EEPROM device. 2324c609719bSwdenk 2325c609719bSwdenk 2326057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH: 23275779d8d9Swdenk 23285779d8d9Swdenk Define this if you have a DataFlash memory device which you 23295779d8d9Swdenk want to use for the environment. 23305779d8d9Swdenk 23310e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 23320e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 23330e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 23345779d8d9Swdenk 23355779d8d9Swdenk These three #defines specify the offset and size of the 23365779d8d9Swdenk environment area within the total memory of your DataFlash placed 23375779d8d9Swdenk at the specified address. 23385779d8d9Swdenk 233951bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND: 234013a5695bSwdenk 234113a5695bSwdenk Define this if you have a NAND device which you want to use 234213a5695bSwdenk for the environment. 234313a5695bSwdenk 23440e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 23450e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 234613a5695bSwdenk 234713a5695bSwdenk These two #defines specify the offset and size of the environment 234813a5695bSwdenk area within the first NAND device. 23495779d8d9Swdenk 23500e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET_REDUND 2351e443c944SMarkus Klotzbuecher 23520e8d1586SJean-Christophe PLAGNIOL-VILLARD This setting describes a second storage area of CONFIG_ENV_SIZE 2353e443c944SMarkus Klotzbuecher size used to hold a redundant copy of the environment data, 2354e443c944SMarkus Klotzbuecher so that there is a valid backup copy in case there is a 2355e443c944SMarkus Klotzbuecher power failure during a "saveenv" operation. 2356e443c944SMarkus Klotzbuecher 23570e8d1586SJean-Christophe PLAGNIOL-VILLARD Note: CONFIG_ENV_OFFSET and CONFIG_ENV_OFFSET_REDUND must be aligned 23580e8d1586SJean-Christophe PLAGNIOL-VILLARD to a block boundary, and CONFIG_ENV_SIZE must be a multiple of 2359e443c944SMarkus Klotzbuecher the NAND devices block size. 2360e443c944SMarkus Klotzbuecher 2361c609719bSwdenk- CFG_SPI_INIT_OFFSET 2362c609719bSwdenk 2363c609719bSwdenk Defines offset to the initial SPI buffer area in DPRAM. The 2364c609719bSwdenk area is used at an early stage (ROM part) if the environment 2365c609719bSwdenk is configured to reside in the SPI EEPROM: We need a 520 byte 2366c609719bSwdenk scratch DPRAM area. It is used between the two initialization 2367c609719bSwdenk calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems 2368c609719bSwdenk to be a good choice since it makes it far enough from the 2369c609719bSwdenk start of the data area as well as from the stack pointer. 2370c609719bSwdenk 2371e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor 2372c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been 2373c609719bSwdenkcreated; also, when using EEPROM you will have to use getenv_r() 2374c609719bSwdenkuntil then to read environment variables. 2375c609719bSwdenk 237685ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor 237785ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working 237885ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is 237985ec0bccSwdenknecessary, because the first environment variable we need is the 238085ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't 238185ec0bccSwdenkhave any device yet where we could complain.] 2382c609719bSwdenk 2383c609719bSwdenkNote: once the monitor has been relocated, then it will complain if 2384c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you 238585ec0bccSwdenkuse the "saveenv" command to store a valid environment. 2386c609719bSwdenk 2387fc3e2165Swdenk- CFG_FAULT_ECHO_LINK_DOWN: 2388fc3e2165Swdenk Echo the inverted Ethernet link state to the fault LED. 2389fc3e2165Swdenk 2390fc3e2165Swdenk Note: If this option is active, then CFG_FAULT_MII_ADDR 2391fc3e2165Swdenk also needs to be defined. 2392fc3e2165Swdenk 2393fc3e2165Swdenk- CFG_FAULT_MII_ADDR: 2394fc3e2165Swdenk MII address of the PHY to check for the Ethernet link state. 2395c609719bSwdenk 2396c40b2956Swdenk- CFG_64BIT_VSPRINTF: 2397c40b2956Swdenk Makes vsprintf (and all *printf functions) support printing 2398c40b2956Swdenk of 64bit values by using the L quantifier 2399c40b2956Swdenk 2400c40b2956Swdenk- CFG_64BIT_STRTOUL: 2401c40b2956Swdenk Adds simple_strtoull that returns a 64bit value 2402c40b2956Swdenk 2403c609719bSwdenkLow Level (hardware related) configuration options: 2404dc7c9a1aSwdenk--------------------------------------------------- 2405c609719bSwdenk 2406c609719bSwdenk- CFG_CACHELINE_SIZE: 2407c609719bSwdenk Cache Line Size of the CPU. 2408c609719bSwdenk 2409c609719bSwdenk- CFG_DEFAULT_IMMR: 2410c609719bSwdenk Default address of the IMMR after system reset. 24112535d602Swdenk 24122535d602Swdenk Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU, 24132535d602Swdenk and RPXsuper) to be able to adjust the position of 24142535d602Swdenk the IMMR register after a reset. 2415c609719bSwdenk 24167f6c2cbcSwdenk- Floppy Disk Support: 24177f6c2cbcSwdenk CFG_FDC_DRIVE_NUMBER 24187f6c2cbcSwdenk 24197f6c2cbcSwdenk the default drive number (default value 0) 24207f6c2cbcSwdenk 24217f6c2cbcSwdenk CFG_ISA_IO_STRIDE 24227f6c2cbcSwdenk 242311ccc33fSMarcel Ziswiler defines the spacing between FDC chipset registers 24247f6c2cbcSwdenk (default value 1) 24257f6c2cbcSwdenk 24267f6c2cbcSwdenk CFG_ISA_IO_OFFSET 24277f6c2cbcSwdenk 24287f6c2cbcSwdenk defines the offset of register from address. It 24297f6c2cbcSwdenk depends on which part of the data bus is connected to 243011ccc33fSMarcel Ziswiler the FDC chipset. (default value 0) 24317f6c2cbcSwdenk 24327f6c2cbcSwdenk If CFG_ISA_IO_STRIDE CFG_ISA_IO_OFFSET and 24337f6c2cbcSwdenk CFG_FDC_DRIVE_NUMBER are undefined, they take their 24347f6c2cbcSwdenk default value. 24357f6c2cbcSwdenk 24367f6c2cbcSwdenk if CFG_FDC_HW_INIT is defined, then the function 24377f6c2cbcSwdenk fdc_hw_init() is called at the beginning of the FDC 24387f6c2cbcSwdenk setup. fdc_hw_init() must be provided by the board 24397f6c2cbcSwdenk source code. It is used to make hardware dependant 24407f6c2cbcSwdenk initializations. 24417f6c2cbcSwdenk 244225d6712aSwdenk- CFG_IMMR: Physical address of the Internal Memory. 244325d6712aSwdenk DO NOT CHANGE unless you know exactly what you're 244425d6712aSwdenk doing! (11-4) [MPC8xx/82xx systems only] 2445c609719bSwdenk 2446c609719bSwdenk- CFG_INIT_RAM_ADDR: 2447c609719bSwdenk 24487152b1d0Swdenk Start address of memory area that can be used for 2449c609719bSwdenk initial data and stack; please note that this must be 2450c609719bSwdenk writable memory that is working WITHOUT special 2451c609719bSwdenk initialization, i. e. you CANNOT use normal RAM which 2452c609719bSwdenk will become available only after programming the 2453c609719bSwdenk memory controller and running certain initialization 2454c609719bSwdenk sequences. 2455c609719bSwdenk 2456c609719bSwdenk U-Boot uses the following memory types: 2457c609719bSwdenk - MPC8xx and MPC8260: IMMR (internal memory of the CPU) 2458c609719bSwdenk - MPC824X: data cache 2459c609719bSwdenk - PPC4xx: data cache 2460c609719bSwdenk 246185ec0bccSwdenk- CFG_GBL_DATA_OFFSET: 2462c609719bSwdenk 2463c609719bSwdenk Offset of the initial data structure in the memory 2464c609719bSwdenk area defined by CFG_INIT_RAM_ADDR. Usually 246585ec0bccSwdenk CFG_GBL_DATA_OFFSET is chosen such that the initial 2466c609719bSwdenk data is located at the end of the available space 2467c609719bSwdenk (sometimes written as (CFG_INIT_RAM_END - 2468c609719bSwdenk CFG_INIT_DATA_SIZE), and the initial stack is just 2469c609719bSwdenk below that area (growing from (CFG_INIT_RAM_ADDR + 247085ec0bccSwdenk CFG_GBL_DATA_OFFSET) downward. 2471c609719bSwdenk 2472c609719bSwdenk Note: 2473c609719bSwdenk On the MPC824X (or other systems that use the data 2474c609719bSwdenk cache for initial memory) the address chosen for 2475c609719bSwdenk CFG_INIT_RAM_ADDR is basically arbitrary - it must 2476c609719bSwdenk point to an otherwise UNUSED address space between 2477c609719bSwdenk the top of RAM and the start of the PCI space. 2478c609719bSwdenk 2479c609719bSwdenk- CFG_SIUMCR: SIU Module Configuration (11-6) 2480c609719bSwdenk 2481c609719bSwdenk- CFG_SYPCR: System Protection Control (11-9) 2482c609719bSwdenk 2483c609719bSwdenk- CFG_TBSCR: Time Base Status and Control (11-26) 2484c609719bSwdenk 2485c609719bSwdenk- CFG_PISCR: Periodic Interrupt Status and Control (11-31) 2486c609719bSwdenk 2487c609719bSwdenk- CFG_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30) 2488c609719bSwdenk 2489c609719bSwdenk- CFG_SCCR: System Clock and reset Control Register (15-27) 2490c609719bSwdenk 2491c609719bSwdenk- CFG_OR_TIMING_SDRAM: 2492c609719bSwdenk SDRAM timing 2493c609719bSwdenk 2494c609719bSwdenk- CFG_MAMR_PTA: 2495c609719bSwdenk periodic timer for refresh 2496c609719bSwdenk 2497c609719bSwdenk- CFG_DER: Debug Event Register (37-47) 2498c609719bSwdenk 2499c609719bSwdenk- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CFG_REMAP_OR_AM, 2500c609719bSwdenk CFG_PRELIM_OR_AM, CFG_OR_TIMING_FLASH, CFG_OR0_REMAP, 2501c609719bSwdenk CFG_OR0_PRELIM, CFG_BR0_PRELIM, CFG_OR1_REMAP, CFG_OR1_PRELIM, 2502c609719bSwdenk CFG_BR1_PRELIM: 2503c609719bSwdenk Memory Controller Definitions: BR0/1 and OR0/1 (FLASH) 2504c609719bSwdenk 2505c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE, 2506c609719bSwdenk CFG_OR_TIMING_SDRAM, CFG_OR2_PRELIM, CFG_BR2_PRELIM, 2507c609719bSwdenk CFG_OR3_PRELIM, CFG_BR3_PRELIM: 2508c609719bSwdenk Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM) 2509c609719bSwdenk 2510c609719bSwdenk- CFG_MAMR_PTA, CFG_MPTPR_2BK_4K, CFG_MPTPR_1BK_4K, CFG_MPTPR_2BK_8K, 2511c609719bSwdenk CFG_MPTPR_1BK_8K, CFG_MAMR_8COL, CFG_MAMR_9COL: 2512c609719bSwdenk Machine Mode Register and Memory Periodic Timer 2513c609719bSwdenk Prescaler definitions (SDRAM timing) 2514c609719bSwdenk 2515c609719bSwdenk- CFG_I2C_UCODE_PATCH, CFG_I2C_DPMEM_OFFSET [0x1FC0]: 2516c609719bSwdenk enable I2C microcode relocation patch (MPC8xx); 2517c609719bSwdenk define relocation offset in DPRAM [DSP2] 2518c609719bSwdenk 2519b423d055SHeiko Schocher- CFG_SMC_UCODE_PATCH, CFG_SMC_DPMEM_OFFSET [0x1FC0]: 2520b423d055SHeiko Schocher enable SMC microcode relocation patch (MPC8xx); 2521b423d055SHeiko Schocher define relocation offset in DPRAM [SMC1] 2522b423d055SHeiko Schocher 2523c609719bSwdenk- CFG_SPI_UCODE_PATCH, CFG_SPI_DPMEM_OFFSET [0x1FC0]: 2524c609719bSwdenk enable SPI microcode relocation patch (MPC8xx); 2525c609719bSwdenk define relocation offset in DPRAM [SCC4] 2526c609719bSwdenk 2527c609719bSwdenk- CFG_USE_OSCCLK: 2528c609719bSwdenk Use OSCM clock mode on MBX8xx board. Be careful, 2529c609719bSwdenk wrong setting might damage your board. Read 2530c609719bSwdenk doc/README.MBX before setting this variable! 2531c609719bSwdenk 2532ea909b76Swdenk- CFG_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only) 2533ea909b76Swdenk Offset of the bootmode word in DPRAM used by post 2534ea909b76Swdenk (Power On Self Tests). This definition overrides 2535ea909b76Swdenk #define'd default value in commproc.h resp. 2536ea909b76Swdenk cpm_8260.h. 2537ea909b76Swdenk 25385d232d0eSwdenk- CFG_PCI_SLV_MEM_LOCAL, CFG_PCI_SLV_MEM_BUS, CFG_PICMR0_MASK_ATTRIB, 25395d232d0eSwdenk CFG_PCI_MSTR0_LOCAL, CFG_PCIMSK0_MASK, CFG_PCI_MSTR1_LOCAL, 25405d232d0eSwdenk CFG_PCIMSK1_MASK, CFG_PCI_MSTR_MEM_LOCAL, CFG_PCI_MSTR_MEM_BUS, 25415d232d0eSwdenk CFG_CPU_PCI_MEM_START, CFG_PCI_MSTR_MEM_SIZE, CFG_POCMR0_MASK_ATTRIB, 25425d232d0eSwdenk CFG_PCI_MSTR_MEMIO_LOCAL, CFG_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START, 25435d232d0eSwdenk CFG_PCI_MSTR_MEMIO_SIZE, CFG_POCMR1_MASK_ATTRIB, CFG_PCI_MSTR_IO_LOCAL, 25445d232d0eSwdenk CFG_PCI_MSTR_IO_BUS, CFG_CPU_PCI_IO_START, CFG_PCI_MSTR_IO_SIZE, 25455d232d0eSwdenk CFG_POCMR2_MASK_ATTRIB: (MPC826x only) 25465d232d0eSwdenk Overrides the default PCI memory map in cpu/mpc8260/pci.c if set. 25475d232d0eSwdenk 2548bb99ad6dSBen Warren- CONFIG_SPD_EEPROM 2549218ca724SWolfgang Denk Get DDR timing information from an I2C EEPROM. Common 2550218ca724SWolfgang Denk with pluggable memory modules such as SODIMMs 2551218ca724SWolfgang Denk 2552bb99ad6dSBen Warren SPD_EEPROM_ADDRESS 2553bb99ad6dSBen Warren I2C address of the SPD EEPROM 2554bb99ad6dSBen Warren 2555bb99ad6dSBen Warren- CFG_SPD_BUS_NUM 2556218ca724SWolfgang Denk If SPD EEPROM is on an I2C bus other than the first 2557218ca724SWolfgang Denk one, specify here. Note that the value must resolve 2558218ca724SWolfgang Denk to something your driver can deal with. 2559bb99ad6dSBen Warren 25602ad6b513STimur Tabi- CFG_83XX_DDR_USES_CS0 2561218ca724SWolfgang Denk Only for 83xx systems. If specified, then DDR should 2562218ca724SWolfgang Denk be configured using CS0 and CS1 instead of CS2 and CS3. 25632ad6b513STimur Tabi 25642ad6b513STimur Tabi- CFG_83XX_DDR_USES_CS0 2565218ca724SWolfgang Denk Only for 83xx systems. If specified, then DDR should 2566218ca724SWolfgang Denk be configured using CS0 and CS1 instead of CS2 and CS3. 25672ad6b513STimur Tabi 2568c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12] 2569c26e454dSwdenk Define to enable FEC[12] on a 8xx series processor. 2570c26e454dSwdenk 2571c26e454dSwdenk- CONFIG_FEC[12]_PHY 2572c26e454dSwdenk Define to the hardcoded PHY address which corresponds 25736e592385Swdenk to the given FEC; i. e. 2574c26e454dSwdenk #define CONFIG_FEC1_PHY 4 2575c26e454dSwdenk means that the PHY with address 4 is connected to FEC1 2576c26e454dSwdenk 2577c26e454dSwdenk When set to -1, means to probe for first available. 2578c26e454dSwdenk 2579c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR 2580c26e454dSwdenk The PHY does not have a RXERR line (RMII only). 2581c26e454dSwdenk (so program the FEC to ignore it). 2582c26e454dSwdenk 2583c26e454dSwdenk- CONFIG_RMII 2584c26e454dSwdenk Enable RMII mode for all FECs. 2585c26e454dSwdenk Note that this is a global option, we can't 2586c26e454dSwdenk have one FEC in standard MII mode and another in RMII mode. 2587c26e454dSwdenk 25885cf91d6bSwdenk- CONFIG_CRC32_VERIFY 25895cf91d6bSwdenk Add a verify option to the crc32 command. 25905cf91d6bSwdenk The syntax is: 25915cf91d6bSwdenk 25925cf91d6bSwdenk => crc32 -v <address> <count> <crc32> 25935cf91d6bSwdenk 25945cf91d6bSwdenk Where address/count indicate a memory area 25955cf91d6bSwdenk and crc32 is the correct crc32 which the 25965cf91d6bSwdenk area should have. 25975cf91d6bSwdenk 259856523f12Swdenk- CONFIG_LOOPW 259956523f12Swdenk Add the "loopw" memory command. This only takes effect if 2600602ad3b3SJon Loeliger the memory commands are activated globally (CONFIG_CMD_MEM). 260156523f12Swdenk 26027b466641Sstroese- CONFIG_MX_CYCLIC 26037b466641Sstroese Add the "mdc" and "mwc" memory commands. These are cyclic 26047b466641Sstroese "md/mw" commands. 26057b466641Sstroese Examples: 26067b466641Sstroese 26077b466641Sstroese => mdc.b 10 4 500 26087b466641Sstroese This command will print 4 bytes (10,11,12,13) each 500 ms. 26097b466641Sstroese 26107b466641Sstroese => mwc.l 100 12345678 10 26117b466641Sstroese This command will write 12345678 to address 100 all 10 ms. 26127b466641Sstroese 26137b466641Sstroese This only takes effect if the memory commands are activated 2614602ad3b3SJon Loeliger globally (CONFIG_CMD_MEM). 26157b466641Sstroese 26168aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT 26178aa1a2d1Swdenk- CONFIG_SKIP_RELOCATE_UBOOT 26188aa1a2d1Swdenk 26198aa1a2d1Swdenk [ARM only] If these variables are defined, then 26208aa1a2d1Swdenk certain low level initializations (like setting up 26218aa1a2d1Swdenk the memory controller) are omitted and/or U-Boot does 26228aa1a2d1Swdenk not relocate itself into RAM. 26238aa1a2d1Swdenk Normally these variables MUST NOT be defined. The 26248aa1a2d1Swdenk only exception is when U-Boot is loaded (to RAM) by 26258aa1a2d1Swdenk some other boot loader or by a debugger which 262611ccc33fSMarcel Ziswiler performs these initializations itself. 26278aa1a2d1Swdenk 2628400558b5Swdenk 2629c609719bSwdenkBuilding the Software: 2630c609719bSwdenk====================== 2631c609719bSwdenk 2632218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments 2633218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support 2634218ca724SWolfgang Denkall possibly existing versions of cross development tools in all 2635218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we 2636218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK) 2637218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot. 2638c609719bSwdenk 2639218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you 2640218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case, 2641218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell. 2642218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are 2643218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter: 2644c609719bSwdenk 2645218ca724SWolfgang Denk $ CROSS_COMPILE=ppc_4xx- 2646218ca724SWolfgang Denk $ export CROSS_COMPILE 2647c609719bSwdenk 2648c609719bSwdenkU-Boot is intended to be simple to build. After installing the 2649c609719bSwdenksources you must configure U-Boot for one specific board type. This 2650c609719bSwdenkis done by typing: 2651c609719bSwdenk 2652c609719bSwdenk make NAME_config 2653c609719bSwdenk 2654218ca724SWolfgang Denkwhere "NAME_config" is the name of one of the existing configu- 2655218ca724SWolfgang Denkrations; see the main Makefile for supported names. 265654387ac9Swdenk 2657c609719bSwdenkNote: for some board special configuration names may exist; check if 2658c609719bSwdenk additional information is available from the board vendor; for 26592729af9dSwdenk instance, the TQM823L systems are available without (standard) 26602729af9dSwdenk or with LCD support. You can select such additional "features" 266111ccc33fSMarcel Ziswiler when choosing the configuration, i. e. 2662c609719bSwdenk 26632729af9dSwdenk make TQM823L_config 26642729af9dSwdenk - will configure for a plain TQM823L, i. e. no LCD support 2665c609719bSwdenk 2666c609719bSwdenk make TQM823L_LCD_config 2667c609719bSwdenk - will configure for a TQM823L with U-Boot console on LCD 2668c609719bSwdenk 2669c609719bSwdenk etc. 2670c609719bSwdenk 2671c609719bSwdenk 2672c609719bSwdenkFinally, type "make all", and you should get some working U-Boot 26737152b1d0Swdenkimages ready for download to / installation on your system: 2674c609719bSwdenk 2675c609719bSwdenk- "u-boot.bin" is a raw binary image 2676c609719bSwdenk- "u-boot" is an image in ELF binary format 2677c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format 2678c609719bSwdenk 2679baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved 2680baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change 2681baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory: 2682baf31249SMarian Balakowicz 2683baf31249SMarian Balakowicz1. Add O= to the make command line invocations: 2684baf31249SMarian Balakowicz 2685baf31249SMarian Balakowicz make O=/tmp/build distclean 2686baf31249SMarian Balakowicz make O=/tmp/build NAME_config 2687baf31249SMarian Balakowicz make O=/tmp/build all 2688baf31249SMarian Balakowicz 2689baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location: 2690baf31249SMarian Balakowicz 2691baf31249SMarian Balakowicz export BUILD_DIR=/tmp/build 2692baf31249SMarian Balakowicz make distclean 2693baf31249SMarian Balakowicz make NAME_config 2694baf31249SMarian Balakowicz make all 2695baf31249SMarian Balakowicz 2696baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment 2697baf31249SMarian Balakowiczvariable. 2698baf31249SMarian Balakowicz 2699c609719bSwdenk 2700c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so 2701c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of 2702c609719bSwdenknative "make". 2703c609719bSwdenk 2704c609719bSwdenk 2705c609719bSwdenkIf the system board that you have is not listed, then you will need 2706c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these 2707c609719bSwdenksteps: 2708c609719bSwdenk 2709c609719bSwdenk1. Add a new configuration option for your board to the toplevel 271085ec0bccSwdenk "Makefile" and to the "MAKEALL" script, using the existing 271185ec0bccSwdenk entries as examples. Note that here and at many other places 27127152b1d0Swdenk boards and other names are listed in alphabetical sort order. Please 271385ec0bccSwdenk keep this order. 2714c609719bSwdenk2. Create a new directory to hold your board specific code. Add any 271585ec0bccSwdenk files you need. In your board directory, you will need at least 271685ec0bccSwdenk the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds". 271785ec0bccSwdenk3. Create a new configuration file "include/configs/<board>.h" for 271885ec0bccSwdenk your board 2719c609719bSwdenk3. If you're porting U-Boot to a new CPU, then also create a new 2720c609719bSwdenk directory to hold your CPU specific code. Add any files you need. 272185ec0bccSwdenk4. Run "make <board>_config" with your new name. 2722c609719bSwdenk5. Type "make", and you should get a working "u-boot.srec" file 2723c609719bSwdenk to be installed on your target system. 272485ec0bccSwdenk6. Debug and solve any problems that might arise. 2725c609719bSwdenk [Of course, this last step is much harder than it sounds.] 2726c609719bSwdenk 2727c609719bSwdenk 2728c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.: 2729c609719bSwdenk============================================================== 2730c609719bSwdenk 2731c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board 2732c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to 2733c609719bSwdenkprovide feedback to the other developers. The feedback normally takes 2734c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest 2735218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources. 2736c609719bSwdenk 2737c609719bSwdenkBut before you submit such a patch, please verify that your modifi- 2738c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of 2739c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so, 2740c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot 2741c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can 27427152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE' 2743218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools 2744218ca724SWolfgang Denkyou can type 2745c609719bSwdenk 2746c609719bSwdenk CROSS_COMPILE=ppc_8xx- MAKEALL 2747c609719bSwdenk 2748c609719bSwdenkor to build on a native PowerPC system you can type 2749c609719bSwdenk 2750c609719bSwdenk CROSS_COMPILE=' ' MAKEALL 2751c609719bSwdenk 2752218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build 2753218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by 2754218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target 2755218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and 2756218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default 2757218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment 2758218ca724SWolfgang Denkvariable. For example: 2759baf31249SMarian Balakowicz 2760baf31249SMarian Balakowicz export BUILD_DIR=/tmp/build 2761baf31249SMarian Balakowicz export MAKEALL_LOGDIR=/tmp/log 2762baf31249SMarian Balakowicz CROSS_COMPILE=ppc_8xx- MAKEALL 2763baf31249SMarian Balakowicz 2764218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build, 2765218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean 2766218ca724SWolfgang Denkduring the whole build process. 2767baf31249SMarian Balakowicz 2768baf31249SMarian Balakowicz 2769c609719bSwdenkSee also "U-Boot Porting Guide" below. 2770c609719bSwdenk 2771c609719bSwdenk 2772c609719bSwdenkMonitor Commands - Overview: 2773c609719bSwdenk============================ 2774c609719bSwdenk 2775c609719bSwdenkgo - start application at address 'addr' 2776c609719bSwdenkrun - run commands in an environment variable 2777c609719bSwdenkbootm - boot application image from memory 2778c609719bSwdenkbootp - boot image via network using BootP/TFTP protocol 2779c609719bSwdenktftpboot- boot image via network using TFTP protocol 2780c609719bSwdenk and env variables "ipaddr" and "serverip" 2781c609719bSwdenk (and eventually "gatewayip") 2782c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol 2783c609719bSwdenkdiskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd' 2784c609719bSwdenkloads - load S-Record file over serial line 2785c609719bSwdenkloadb - load binary file over serial line (kermit mode) 2786c609719bSwdenkmd - memory display 2787c609719bSwdenkmm - memory modify (auto-incrementing) 2788c609719bSwdenknm - memory modify (constant address) 2789c609719bSwdenkmw - memory write (fill) 2790c609719bSwdenkcp - memory copy 2791c609719bSwdenkcmp - memory compare 2792c609719bSwdenkcrc32 - checksum calculation 2793c609719bSwdenkimd - i2c memory display 2794c609719bSwdenkimm - i2c memory modify (auto-incrementing) 2795c609719bSwdenkinm - i2c memory modify (constant address) 2796c609719bSwdenkimw - i2c memory write (fill) 2797c609719bSwdenkicrc32 - i2c checksum calculation 2798c609719bSwdenkiprobe - probe to discover valid I2C chip addresses 2799c609719bSwdenkiloop - infinite loop on address range 2800c609719bSwdenkisdram - print SDRAM configuration information 2801c609719bSwdenksspi - SPI utility commands 2802c609719bSwdenkbase - print or set address offset 2803c609719bSwdenkprintenv- print environment variables 2804c609719bSwdenksetenv - set environment variables 2805c609719bSwdenksaveenv - save environment variables to persistent storage 2806c609719bSwdenkprotect - enable or disable FLASH write protection 2807c609719bSwdenkerase - erase FLASH memory 2808c609719bSwdenkflinfo - print FLASH memory information 2809c609719bSwdenkbdinfo - print Board Info structure 2810c609719bSwdenkiminfo - print header information for application image 2811c609719bSwdenkconinfo - print console devices and informations 2812c609719bSwdenkide - IDE sub-system 2813c609719bSwdenkloop - infinite loop on address range 281456523f12Swdenkloopw - infinite write loop on address range 2815c609719bSwdenkmtest - simple RAM test 2816c609719bSwdenkicache - enable or disable instruction cache 2817c609719bSwdenkdcache - enable or disable data cache 2818c609719bSwdenkreset - Perform RESET of the CPU 2819c609719bSwdenkecho - echo args to console 2820c609719bSwdenkversion - print monitor version 2821c609719bSwdenkhelp - print online help 2822c609719bSwdenk? - alias for 'help' 2823c609719bSwdenk 2824c609719bSwdenk 2825c609719bSwdenkMonitor Commands - Detailed Description: 2826c609719bSwdenk======================================== 2827c609719bSwdenk 2828c609719bSwdenkTODO. 2829c609719bSwdenk 2830c609719bSwdenkFor now: just type "help <command>". 2831c609719bSwdenk 2832c609719bSwdenk 2833c609719bSwdenkEnvironment Variables: 2834c609719bSwdenk====================== 2835c609719bSwdenk 2836c609719bSwdenkU-Boot supports user configuration using Environment Variables which 2837c609719bSwdenkcan be made persistent by saving to Flash memory. 2838c609719bSwdenk 2839c609719bSwdenkEnvironment Variables are set using "setenv", printed using 2840c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv" 2841c609719bSwdenkwithout a value can be used to delete a variable from the 2842c609719bSwdenkenvironment. As long as you don't save the environment you are 2843c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the 2844c609719bSwdenkenvironment is erased by accident, a default environment is provided. 2845c609719bSwdenk 2846c609719bSwdenkSome configuration options can be set using Environment Variables: 2847c609719bSwdenk 2848c609719bSwdenk baudrate - see CONFIG_BAUDRATE 2849c609719bSwdenk 2850c609719bSwdenk bootdelay - see CONFIG_BOOTDELAY 2851c609719bSwdenk 2852c609719bSwdenk bootcmd - see CONFIG_BOOTCOMMAND 2853c609719bSwdenk 2854c609719bSwdenk bootargs - Boot arguments when booting an RTOS image 2855c609719bSwdenk 2856c609719bSwdenk bootfile - Name of the image to load with TFTP 2857c609719bSwdenk 28587d721e34SBartlomiej Sieka bootm_low - Memory range available for image processing in the bootm 28597d721e34SBartlomiej Sieka command can be restricted. This variable is given as 28607d721e34SBartlomiej Sieka a hexadecimal number and defines lowest address allowed 28617d721e34SBartlomiej Sieka for use by the bootm command. See also "bootm_size" 28627d721e34SBartlomiej Sieka environment variable. Address defined by "bootm_low" is 28637d721e34SBartlomiej Sieka also the base of the initial memory mapping for the Linux 286411ccc33fSMarcel Ziswiler kernel -- see the description of CFG_BOOTMAPSZ. 28657d721e34SBartlomiej Sieka 28667d721e34SBartlomiej Sieka bootm_size - Memory range available for image processing in the bootm 28677d721e34SBartlomiej Sieka command can be restricted. This variable is given as 28687d721e34SBartlomiej Sieka a hexadecimal number and defines the size of the region 28697d721e34SBartlomiej Sieka allowed for use by the bootm command. See also "bootm_low" 28707d721e34SBartlomiej Sieka environment variable. 28717d721e34SBartlomiej Sieka 28724bae9090SBartlomiej Sieka updatefile - Location of the software update file on a TFTP server, used 28734bae9090SBartlomiej Sieka by the automatic software update feature. Please refer to 28744bae9090SBartlomiej Sieka documentation in doc/README.update for more details. 28754bae9090SBartlomiej Sieka 2876c609719bSwdenk autoload - if set to "no" (any string beginning with 'n'), 2877c609719bSwdenk "bootp" will just load perform a lookup of the 2878c609719bSwdenk configuration from the BOOTP server, but not try to 2879c609719bSwdenk load any image using TFTP 2880c609719bSwdenk 28813310c549SMarian Balakowicz autoscript - if set to "yes" commands like "loadb", "loady", 28823310c549SMarian Balakowicz "bootp", "tftpb", "rarpboot" and "nfs" will attempt 28833310c549SMarian Balakowicz to automatically run script images (by internally 28843310c549SMarian Balakowicz calling "autoscript"). 28853310c549SMarian Balakowicz 28863310c549SMarian Balakowicz autoscript_uname - if script image is in a format (FIT) this 28873310c549SMarian Balakowicz variable is used to get script subimage unit name. 28883310c549SMarian Balakowicz 2889c609719bSwdenk autostart - if set to "yes", an image loaded using the "bootp", 2890c609719bSwdenk "rarpboot", "tftpboot" or "diskboot" commands will 2891c609719bSwdenk be automatically started (by internally calling 2892c609719bSwdenk "bootm") 2893c609719bSwdenk 28944a6fd34bSwdenk If set to "no", a standalone image passed to the 28954a6fd34bSwdenk "bootm" command will be copied to the load address 28964a6fd34bSwdenk (and eventually uncompressed), but NOT be started. 28974a6fd34bSwdenk This can be used to load and uncompress arbitrary 28984a6fd34bSwdenk data. 28994a6fd34bSwdenk 290017ea1177Swdenk i2cfast - (PPC405GP|PPC405EP only) 290117ea1177Swdenk if set to 'y' configures Linux I2C driver for fast 290217ea1177Swdenk mode (400kHZ). This environment variable is used in 290317ea1177Swdenk initialization code. So, for changes to be effective 290417ea1177Swdenk it must be saved and board must be reset. 290517ea1177Swdenk 2906c609719bSwdenk initrd_high - restrict positioning of initrd images: 2907c609719bSwdenk If this variable is not set, initrd images will be 2908c609719bSwdenk copied to the highest possible address in RAM; this 2909c609719bSwdenk is usually what you want since it allows for 2910c609719bSwdenk maximum initrd size. If for some reason you want to 2911c609719bSwdenk make sure that the initrd image is loaded below the 2912c609719bSwdenk CFG_BOOTMAPSZ limit, you can set this environment 2913c609719bSwdenk variable to a value of "no" or "off" or "0". 2914c609719bSwdenk Alternatively, you can set it to a maximum upper 2915c609719bSwdenk address to use (U-Boot will still check that it 2916c609719bSwdenk does not overwrite the U-Boot stack and data). 2917c609719bSwdenk 2918c609719bSwdenk For instance, when you have a system with 16 MB 29197152b1d0Swdenk RAM, and want to reserve 4 MB from use by Linux, 2920c609719bSwdenk you can do this by adding "mem=12M" to the value of 2921c609719bSwdenk the "bootargs" variable. However, now you must make 29227152b1d0Swdenk sure that the initrd image is placed in the first 2923c609719bSwdenk 12 MB as well - this can be done with 2924c609719bSwdenk 2925c609719bSwdenk setenv initrd_high 00c00000 2926c609719bSwdenk 292738b99261Swdenk If you set initrd_high to 0xFFFFFFFF, this is an 292838b99261Swdenk indication to U-Boot that all addresses are legal 292938b99261Swdenk for the Linux kernel, including addresses in flash 293038b99261Swdenk memory. In this case U-Boot will NOT COPY the 293138b99261Swdenk ramdisk at all. This may be useful to reduce the 293238b99261Swdenk boot time on your system, but requires that this 293338b99261Swdenk feature is supported by your Linux kernel. 293438b99261Swdenk 2935c609719bSwdenk ipaddr - IP address; needed for tftpboot command 2936c609719bSwdenk 2937c609719bSwdenk loadaddr - Default load address for commands like "bootp", 2938dc7c9a1aSwdenk "rarpboot", "tftpboot", "loadb" or "diskboot" 2939c609719bSwdenk 2940c609719bSwdenk loads_echo - see CONFIG_LOADS_ECHO 2941c609719bSwdenk 2942c609719bSwdenk serverip - TFTP server IP address; needed for tftpboot command 2943c609719bSwdenk 2944c609719bSwdenk bootretry - see CONFIG_BOOT_RETRY_TIME 2945c609719bSwdenk 2946c609719bSwdenk bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR 2947c609719bSwdenk 2948c609719bSwdenk bootstopkey - see CONFIG_AUTOBOOT_STOP_STR 2949c609719bSwdenk 2950a3d991bdSwdenk ethprime - When CONFIG_NET_MULTI is enabled controls which 2951a3d991bdSwdenk interface is used first. 2952a3d991bdSwdenk 2953a3d991bdSwdenk ethact - When CONFIG_NET_MULTI is enabled controls which 2954a3d991bdSwdenk interface is currently active. For example you 2955a3d991bdSwdenk can do the following 2956a3d991bdSwdenk 2957a3d991bdSwdenk => setenv ethact FEC ETHERNET 2958a3d991bdSwdenk => ping 192.168.0.1 # traffic sent on FEC ETHERNET 2959a3d991bdSwdenk => setenv ethact SCC ETHERNET 2960a3d991bdSwdenk => ping 10.0.0.1 # traffic sent on SCC ETHERNET 2961a3d991bdSwdenk 2962e1692577SMatthias Fuchs ethrotate - When set to "no" U-Boot does not go through all 2963e1692577SMatthias Fuchs available network interfaces. 2964e1692577SMatthias Fuchs It just stays at the currently selected interface. 2965e1692577SMatthias Fuchs 2966a3d991bdSwdenk netretry - When set to "no" each network operation will 2967a3d991bdSwdenk either succeed or fail without retrying. 29686e592385Swdenk When set to "once" the network operation will 29696e592385Swdenk fail when all the available network interfaces 29706e592385Swdenk are tried once without success. 2971a3d991bdSwdenk Useful on scripts which control the retry operation 2972a3d991bdSwdenk themselves. 2973a3d991bdSwdenk 2974a1cf027aSJean-Christophe PLAGNIOL-VILLARD npe_ucode - see CONFIG_IXP4XX_NPE_EXT_UCOD 297511ccc33fSMarcel Ziswiler if set load address for the NPE microcode 2976a1cf027aSJean-Christophe PLAGNIOL-VILLARD 297728cb9375SWolfgang Denk tftpsrcport - If this is set, the value is used for TFTP's 2978ecb0ccd9SWolfgang Denk UDP source port. 2979ecb0ccd9SWolfgang Denk 298028cb9375SWolfgang Denk tftpdstport - If this is set, the value is used for TFTP's UDP 298128cb9375SWolfgang Denk destination port instead of the Well Know Port 69. 298228cb9375SWolfgang Denk 2983a3d991bdSwdenk vlan - When set to a value < 4095 the traffic over 298411ccc33fSMarcel Ziswiler Ethernet is encapsulated/received over 802.1q 2985a3d991bdSwdenk VLAN tagged frames. 2986c609719bSwdenk 2987c609719bSwdenkThe following environment variables may be used and automatically 2988c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"), 2989c609719bSwdenkdepending the information provided by your boot server: 2990c609719bSwdenk 2991c609719bSwdenk bootfile - see above 2992c609719bSwdenk dnsip - IP address of your Domain Name Server 2993fe389a82Sstroese dnsip2 - IP address of your secondary Domain Name Server 2994c609719bSwdenk gatewayip - IP address of the Gateway (Router) to use 2995c609719bSwdenk hostname - Target hostname 2996c609719bSwdenk ipaddr - see above 2997c609719bSwdenk netmask - Subnet Mask 2998c609719bSwdenk rootpath - Pathname of the root filesystem on the NFS server 2999c609719bSwdenk serverip - see above 3000c609719bSwdenk 3001c609719bSwdenk 3002c609719bSwdenkThere are two special Environment Variables: 3003c609719bSwdenk 3004c609719bSwdenk serial# - contains hardware identification information such 3005c609719bSwdenk as type string and/or serial number 3006c609719bSwdenk ethaddr - Ethernet address 3007c609719bSwdenk 3008c609719bSwdenkThese variables can be set only once (usually during manufacturing of 3009c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables 3010c609719bSwdenkonce they have been set once. 3011c609719bSwdenk 3012c609719bSwdenk 3013c1551ea8SstroeseFurther special Environment Variables: 3014c1551ea8Sstroese 3015c1551ea8Sstroese ver - Contains the U-Boot version string as printed 3016c1551ea8Sstroese with the "version" command. This variable is 3017c1551ea8Sstroese readonly (see CONFIG_VERSION_VARIABLE). 3018c1551ea8Sstroese 3019c1551ea8Sstroese 3020c609719bSwdenkPlease note that changes to some configuration parameters may take 3021c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-). 3022c609719bSwdenk 3023c609719bSwdenk 3024f07771ccSwdenkCommand Line Parsing: 3025f07771ccSwdenk===================== 3026f07771ccSwdenk 3027f07771ccSwdenkThere are two different command line parsers available with U-Boot: 30287152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell: 3029f07771ccSwdenk 3030f07771ccSwdenkOld, simple command line parser: 3031f07771ccSwdenk-------------------------------- 3032f07771ccSwdenk 3033f07771ccSwdenk- supports environment variables (through setenv / saveenv commands) 3034f07771ccSwdenk- several commands on one line, separated by ';' 3035fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax 3036f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\', 3037f07771ccSwdenk for example: 3038fe126d8bSWolfgang Denk setenv bootcmd bootm \${address} 3039f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example: 3040f07771ccSwdenk setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off' 3041f07771ccSwdenk 3042f07771ccSwdenkHush shell: 3043f07771ccSwdenk----------- 3044f07771ccSwdenk 3045f07771ccSwdenk- similar to Bourne shell, with control structures like 3046f07771ccSwdenk if...then...else...fi, for...do...done; while...do...done, 3047f07771ccSwdenk until...do...done, ... 3048f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv 3049f07771ccSwdenk commands) and local shell variables (through standard shell syntax 3050f07771ccSwdenk "name=value"); only environment variables can be used with "run" 3051f07771ccSwdenk command 3052f07771ccSwdenk 3053f07771ccSwdenkGeneral rules: 3054f07771ccSwdenk-------------- 3055f07771ccSwdenk 3056f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run" 3057f07771ccSwdenk command) contains several commands separated by semicolon, and 3058f07771ccSwdenk one of these commands fails, then the remaining commands will be 3059f07771ccSwdenk executed anyway. 3060f07771ccSwdenk 3061f07771ccSwdenk(2) If you execute several variables with one call to run (i. e. 306211ccc33fSMarcel Ziswiler calling run with a list of variables as arguments), any failing 3063f07771ccSwdenk command will cause "run" to terminate, i. e. the remaining 3064f07771ccSwdenk variables are not executed. 3065f07771ccSwdenk 3066c609719bSwdenkNote for Redundant Ethernet Interfaces: 3067c609719bSwdenk======================================= 3068c609719bSwdenk 306911ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports 3070c609719bSwdenksuch configurations and is capable of automatic selection of a 30717152b1d0Swdenk"working" interface when needed. MAC assignment works as follows: 3072c609719bSwdenk 3073c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding 3074c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0), 3075c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ... 3076c609719bSwdenk 3077c609719bSwdenkIf the network interface stores some valid MAC address (for instance 3078c609719bSwdenkin SROM), this is used as default address if there is NO correspon- 3079c609719bSwdenkding setting in the environment; if the corresponding environment 3080c609719bSwdenkvariable is set, this overrides the settings in the card; that means: 3081c609719bSwdenk 3082c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the 3083c609719bSwdenk environment, the SROM's address is used. 3084c609719bSwdenk 3085c609719bSwdenko If there is no valid address in the SROM, and a definition in the 3086c609719bSwdenk environment exists, then the value from the environment variable is 3087c609719bSwdenk used. 3088c609719bSwdenk 3089c609719bSwdenko If both the SROM and the environment contain a MAC address, and 3090c609719bSwdenk both addresses are the same, this MAC address is used. 3091c609719bSwdenk 3092c609719bSwdenko If both the SROM and the environment contain a MAC address, and the 3093c609719bSwdenk addresses differ, the value from the environment is used and a 3094c609719bSwdenk warning is printed. 3095c609719bSwdenk 3096c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error 3097c609719bSwdenk is raised. 3098c609719bSwdenk 3099c609719bSwdenk 3100c609719bSwdenkImage Formats: 3101c609719bSwdenk============== 3102c609719bSwdenk 31033310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on) 31043310c549SMarian Balakowiczimages in two formats: 31053310c549SMarian Balakowicz 31063310c549SMarian BalakowiczNew uImage format (FIT) 31073310c549SMarian Balakowicz----------------------- 31083310c549SMarian Balakowicz 31093310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar 31103310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple 31113310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by 31123310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory. 31133310c549SMarian Balakowicz 31143310c549SMarian Balakowicz 31153310c549SMarian BalakowiczOld uImage format 31163310c549SMarian Balakowicz----------------- 31173310c549SMarian Balakowicz 31183310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything, 31193310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for 31203310c549SMarian Balakowiczdetails; basically, the header defines the following image properties: 3121c609719bSwdenk 3122c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD, 3123c609719bSwdenk 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks, 3124f5ed9e39SPeter Tyser LynxOS, pSOS, QNX, RTEMS, INTEGRITY; 3125f5ed9e39SPeter Tyser Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS, 3126f5ed9e39SPeter Tyser INTEGRITY). 31277b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86, 31283d1e8a9dSwdenk IA64, MIPS, NIOS, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit; 31297b64fef3SWolfgang Denk Currently supported: ARM, AVR32, Intel x86, MIPS, NIOS, PowerPC). 3130c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2) 3131c609719bSwdenk* Load Address 3132c609719bSwdenk* Entry Point 3133c609719bSwdenk* Image Name 3134c609719bSwdenk* Image Timestamp 3135c609719bSwdenk 3136c609719bSwdenkThe header is marked by a special Magic Number, and both the header 3137c609719bSwdenkand the data portions of the image are secured against corruption by 3138c609719bSwdenkCRC32 checksums. 3139c609719bSwdenk 3140c609719bSwdenk 3141c609719bSwdenkLinux Support: 3142c609719bSwdenk============== 3143c609719bSwdenk 3144c609719bSwdenkAlthough U-Boot should support any OS or standalone application 31457152b1d0Swdenkeasily, the main focus has always been on Linux during the design of 3146c609719bSwdenkU-Boot. 3147c609719bSwdenk 3148c609719bSwdenkU-Boot includes many features that so far have been part of some 3149c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any 3150c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image; 3151c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation 31527152b1d0Swdenkserves several purposes: 3153c609719bSwdenk 3154c609719bSwdenk- the same features can be used for other OS or standalone 3155c609719bSwdenk applications (for instance: using compressed images to reduce the 3156c609719bSwdenk Flash memory footprint) 3157c609719bSwdenk 3158c609719bSwdenk- it becomes much easier to port new Linux kernel versions because 31597152b1d0Swdenk lots of low-level, hardware dependent stuff are done by U-Boot 3160c609719bSwdenk 3161c609719bSwdenk- the same Linux kernel image can now be used with different "initrd" 3162c609719bSwdenk images; of course this also means that different kernel images can 3163c609719bSwdenk be run with the same "initrd". This makes testing easier (you don't 3164c609719bSwdenk have to build a new "zImage.initrd" Linux image when you just 3165c609719bSwdenk change a file in your "initrd"). Also, a field-upgrade of the 3166c609719bSwdenk software is easier now. 3167c609719bSwdenk 3168c609719bSwdenk 3169c609719bSwdenkLinux HOWTO: 3170c609719bSwdenk============ 3171c609719bSwdenk 3172c609719bSwdenkPorting Linux to U-Boot based systems: 3173c609719bSwdenk--------------------------------------- 3174c609719bSwdenk 3175c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to 3176c609719bSwdenkconfigure the Linux device drivers for use with your target hardware 3177c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to 3178c609719bSwdenkLinux :-). 3179c609719bSwdenk 3180c609719bSwdenkBut now you can ignore ALL boot loader code (in arch/ppc/mbxboot). 3181c609719bSwdenk 3182c609719bSwdenkJust make sure your machine specific header file (for instance 3183c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board 31841dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h, 31851dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value 31861dc30693SMarkus Heidelbergas your U-Boot configuration in CFG_IMMR. 3187c609719bSwdenk 3188c609719bSwdenk 3189c609719bSwdenkConfiguring the Linux kernel: 3190c609719bSwdenk----------------------------- 3191c609719bSwdenk 3192c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root 3193c609719bSwdenkdevice (initial ramdisk, NFS) for your target system. 3194c609719bSwdenk 3195c609719bSwdenk 3196c609719bSwdenkBuilding a Linux Image: 3197c609719bSwdenk----------------------- 3198c609719bSwdenk 319924ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are 320024ee89b9Swdenknot used. If you use recent kernel source, a new build target 320124ee89b9Swdenk"uImage" will exist which automatically builds an image usable by 320224ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target, 320324ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a 320424ee89b9Swdenk100% compatible format. 3205c609719bSwdenk 3206c609719bSwdenkExample: 3207c609719bSwdenk 3208c609719bSwdenk make TQM850L_config 3209c609719bSwdenk make oldconfig 3210c609719bSwdenk make dep 321124ee89b9Swdenk make uImage 3212c609719bSwdenk 321324ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to 321424ee89b9Swdenkencapsulate a compressed Linux kernel image with header information, 321524ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing: 3216c609719bSwdenk 321724ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format): 321824ee89b9Swdenk 321924ee89b9Swdenk* convert the kernel into a raw binary image: 322024ee89b9Swdenk 322124ee89b9Swdenk ${CROSS_COMPILE}-objcopy -O binary \ 322224ee89b9Swdenk -R .note -R .comment \ 322324ee89b9Swdenk -S vmlinux linux.bin 322424ee89b9Swdenk 322524ee89b9Swdenk* compress the binary image: 322624ee89b9Swdenk 322724ee89b9Swdenk gzip -9 linux.bin 322824ee89b9Swdenk 322924ee89b9Swdenk* package compressed binary image for U-Boot: 323024ee89b9Swdenk 323124ee89b9Swdenk mkimage -A ppc -O linux -T kernel -C gzip \ 323224ee89b9Swdenk -a 0 -e 0 -n "Linux Kernel Image" \ 323324ee89b9Swdenk -d linux.bin.gz uImage 323424ee89b9Swdenk 323524ee89b9Swdenk 323624ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use 323724ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or 323824ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64 323924ee89b9Swdenkbyte header containing information about target architecture, 324024ee89b9Swdenkoperating system, image type, compression method, entry points, time 324124ee89b9Swdenkstamp, CRC32 checksums, etc. 324224ee89b9Swdenk 324324ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and 324424ee89b9Swdenkprint the header information, or to build new images. 3245c609719bSwdenk 3246c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information 3247c609719bSwdenkcontained in the header of an existing U-Boot image; this includes 3248c609719bSwdenkchecksum verification: 3249c609719bSwdenk 3250c609719bSwdenk tools/mkimage -l image 3251c609719bSwdenk -l ==> list image header information 3252c609719bSwdenk 3253c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image 3254c609719bSwdenkfrom a "data file" which is used as image payload: 3255c609719bSwdenk 3256c609719bSwdenk tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \ 3257c609719bSwdenk -n name -d data_file image 3258c609719bSwdenk -A ==> set architecture to 'arch' 3259c609719bSwdenk -O ==> set operating system to 'os' 3260c609719bSwdenk -T ==> set image type to 'type' 3261c609719bSwdenk -C ==> set compression type 'comp' 3262c609719bSwdenk -a ==> set load address to 'addr' (hex) 3263c609719bSwdenk -e ==> set entry point to 'ep' (hex) 3264c609719bSwdenk -n ==> set image name to 'name' 3265c609719bSwdenk -d ==> use image data from 'datafile' 3266c609719bSwdenk 326769459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load 326869459791Swdenkaddress (0x00000000), but the entry point address depends on the 326969459791Swdenkkernel version: 3270c609719bSwdenk 3271c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C, 327224ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000. 3273c609719bSwdenk 3274c609719bSwdenkSo a typical call to build a U-Boot image would read: 3275c609719bSwdenk 327624ee89b9Swdenk -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 327724ee89b9Swdenk > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \ 327824ee89b9Swdenk > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz \ 327924ee89b9Swdenk > examples/uImage.TQM850L 328024ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 3281c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 3282c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 3283c609719bSwdenk Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 3284c609719bSwdenk Load Address: 0x00000000 328524ee89b9Swdenk Entry Point: 0x00000000 3286c609719bSwdenk 3287c609719bSwdenkTo verify the contents of the image (or check for corruption): 3288c609719bSwdenk 328924ee89b9Swdenk -> tools/mkimage -l examples/uImage.TQM850L 329024ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 3291c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 3292c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 3293c609719bSwdenk Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 3294c609719bSwdenk Load Address: 0x00000000 329524ee89b9Swdenk Entry Point: 0x00000000 3296c609719bSwdenk 3297c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade 3298c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this 3299c609719bSwdenkneeds more space in Flash, but boots much faster since it does not 3300c609719bSwdenkneed to be uncompressed: 3301c609719bSwdenk 330224ee89b9Swdenk -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz 330324ee89b9Swdenk -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 330424ee89b9Swdenk > -A ppc -O linux -T kernel -C none -a 0 -e 0 \ 330524ee89b9Swdenk > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux \ 330624ee89b9Swdenk > examples/uImage.TQM850L-uncompressed 330724ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 3308c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 3309c609719bSwdenk Image Type: PowerPC Linux Kernel Image (uncompressed) 3310c609719bSwdenk Data Size: 792160 Bytes = 773.59 kB = 0.76 MB 3311c609719bSwdenk Load Address: 0x00000000 331224ee89b9Swdenk Entry Point: 0x00000000 3313c609719bSwdenk 3314c609719bSwdenk 3315c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file 3316c609719bSwdenkwhen your kernel is intended to use an initial ramdisk: 3317c609719bSwdenk 3318c609719bSwdenk -> tools/mkimage -n 'Simple Ramdisk Image' \ 3319c609719bSwdenk > -A ppc -O linux -T ramdisk -C gzip \ 3320c609719bSwdenk > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd 3321c609719bSwdenk Image Name: Simple Ramdisk Image 3322c609719bSwdenk Created: Wed Jan 12 14:01:50 2000 3323c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 3324c609719bSwdenk Data Size: 566530 Bytes = 553.25 kB = 0.54 MB 3325c609719bSwdenk Load Address: 0x00000000 3326c609719bSwdenk Entry Point: 0x00000000 3327c609719bSwdenk 3328c609719bSwdenk 3329c609719bSwdenkInstalling a Linux Image: 3330c609719bSwdenk------------------------- 3331c609719bSwdenk 3332c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface, 3333c609719bSwdenkyou must convert the image to S-Record format: 3334c609719bSwdenk 3335c609719bSwdenk objcopy -I binary -O srec examples/image examples/image.srec 3336c609719bSwdenk 3337c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot 3338c609719bSwdenkimage header, so the resulting S-Record file will be relative to 3339c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to 3340c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads' 3341c609719bSwdenkcommand. 3342c609719bSwdenk 3343c609719bSwdenkExample: install the image to address 0x40100000 (which on the 3344c609719bSwdenkTQM8xxL is in the first Flash bank): 3345c609719bSwdenk 3346c609719bSwdenk => erase 40100000 401FFFFF 3347c609719bSwdenk 3348c609719bSwdenk .......... done 3349c609719bSwdenk Erased 8 sectors 3350c609719bSwdenk 3351c609719bSwdenk => loads 40100000 3352c609719bSwdenk ## Ready for S-Record download ... 3353c609719bSwdenk ~>examples/image.srec 3354c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 12 13 ... 3355c609719bSwdenk ... 3356c609719bSwdenk 15989 15990 15991 15992 3357c609719bSwdenk [file transfer complete] 3358c609719bSwdenk [connected] 3359c609719bSwdenk ## Start Addr = 0x00000000 3360c609719bSwdenk 3361c609719bSwdenk 3362c609719bSwdenkYou can check the success of the download using the 'iminfo' command; 3363c609719bSwdenkthis includes a checksum verification so you can be sure no data 3364c609719bSwdenkcorruption happened: 3365c609719bSwdenk 3366c609719bSwdenk => imi 40100000 3367c609719bSwdenk 3368c609719bSwdenk ## Checking Image at 40100000 ... 3369c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 3370c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 3371c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 3372c609719bSwdenk Load Address: 00000000 3373c609719bSwdenk Entry Point: 0000000c 3374c609719bSwdenk Verifying Checksum ... OK 3375c609719bSwdenk 3376c609719bSwdenk 3377c609719bSwdenkBoot Linux: 3378c609719bSwdenk----------- 3379c609719bSwdenk 3380c609719bSwdenkThe "bootm" command is used to boot an application that is stored in 3381c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents 3382c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as 3383c609719bSwdenkparameters. You can check and modify this variable using the 3384c609719bSwdenk"printenv" and "setenv" commands: 3385c609719bSwdenk 3386c609719bSwdenk 3387c609719bSwdenk => printenv bootargs 3388c609719bSwdenk bootargs=root=/dev/ram 3389c609719bSwdenk 3390c609719bSwdenk => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 3391c609719bSwdenk 3392c609719bSwdenk => printenv bootargs 3393c609719bSwdenk bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 3394c609719bSwdenk 3395c609719bSwdenk => bootm 40020000 3396c609719bSwdenk ## Booting Linux kernel at 40020000 ... 3397c609719bSwdenk Image Name: 2.2.13 for NFS on TQM850L 3398c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 3399c609719bSwdenk Data Size: 381681 Bytes = 372 kB = 0 MB 3400c609719bSwdenk Load Address: 00000000 3401c609719bSwdenk Entry Point: 0000000c 3402c609719bSwdenk Verifying Checksum ... OK 3403c609719bSwdenk Uncompressing Kernel Image ... OK 3404c609719bSwdenk 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 3405c609719bSwdenk Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 3406c609719bSwdenk time_init: decrementer frequency = 187500000/60 3407c609719bSwdenk Calibrating delay loop... 49.77 BogoMIPS 3408c609719bSwdenk Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000] 3409c609719bSwdenk ... 3410c609719bSwdenk 341111ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass 34127152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT 3413c609719bSwdenkformat!) to the "bootm" command: 3414c609719bSwdenk 3415c609719bSwdenk => imi 40100000 40200000 3416c609719bSwdenk 3417c609719bSwdenk ## Checking Image at 40100000 ... 3418c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 3419c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 3420c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 3421c609719bSwdenk Load Address: 00000000 3422c609719bSwdenk Entry Point: 0000000c 3423c609719bSwdenk Verifying Checksum ... OK 3424c609719bSwdenk 3425c609719bSwdenk ## Checking Image at 40200000 ... 3426c609719bSwdenk Image Name: Simple Ramdisk Image 3427c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 3428c609719bSwdenk Data Size: 566530 Bytes = 553 kB = 0 MB 3429c609719bSwdenk Load Address: 00000000 3430c609719bSwdenk Entry Point: 00000000 3431c609719bSwdenk Verifying Checksum ... OK 3432c609719bSwdenk 3433c609719bSwdenk => bootm 40100000 40200000 3434c609719bSwdenk ## Booting Linux kernel at 40100000 ... 3435c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 3436c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 3437c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 3438c609719bSwdenk Load Address: 00000000 3439c609719bSwdenk Entry Point: 0000000c 3440c609719bSwdenk Verifying Checksum ... OK 3441c609719bSwdenk Uncompressing Kernel Image ... OK 3442c609719bSwdenk ## Loading RAMDisk Image at 40200000 ... 3443c609719bSwdenk Image Name: Simple Ramdisk Image 3444c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 3445c609719bSwdenk Data Size: 566530 Bytes = 553 kB = 0 MB 3446c609719bSwdenk Load Address: 00000000 3447c609719bSwdenk Entry Point: 00000000 3448c609719bSwdenk Verifying Checksum ... OK 3449c609719bSwdenk Loading Ramdisk ... OK 3450c609719bSwdenk 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 3451c609719bSwdenk Boot arguments: root=/dev/ram 3452c609719bSwdenk time_init: decrementer frequency = 187500000/60 3453c609719bSwdenk Calibrating delay loop... 49.77 BogoMIPS 3454c609719bSwdenk ... 3455c609719bSwdenk RAMDISK: Compressed image found at block 0 3456c609719bSwdenk VFS: Mounted root (ext2 filesystem). 3457c609719bSwdenk 3458c609719bSwdenk bash# 3459c609719bSwdenk 34600267768eSMatthew McClintockBoot Linux and pass a flat device tree: 34610267768eSMatthew McClintock----------- 34620267768eSMatthew McClintock 34630267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section 34640267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The 34650267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated 34660267768eSMatthew McClintockflat device tree: 34670267768eSMatthew McClintock 34680267768eSMatthew McClintock=> print oftaddr 34690267768eSMatthew McClintockoftaddr=0x300000 34700267768eSMatthew McClintock=> print oft 34710267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb 34720267768eSMatthew McClintock=> tftp $oftaddr $oft 34730267768eSMatthew McClintockSpeed: 1000, full duplex 34740267768eSMatthew McClintockUsing TSEC0 device 34750267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101 34760267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'. 34770267768eSMatthew McClintockLoad address: 0x300000 34780267768eSMatthew McClintockLoading: # 34790267768eSMatthew McClintockdone 34800267768eSMatthew McClintockBytes transferred = 4106 (100a hex) 34810267768eSMatthew McClintock=> tftp $loadaddr $bootfile 34820267768eSMatthew McClintockSpeed: 1000, full duplex 34830267768eSMatthew McClintockUsing TSEC0 device 34840267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2 34850267768eSMatthew McClintockFilename 'uImage'. 34860267768eSMatthew McClintockLoad address: 0x200000 34870267768eSMatthew McClintockLoading:############ 34880267768eSMatthew McClintockdone 34890267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex) 34900267768eSMatthew McClintock=> print loadaddr 34910267768eSMatthew McClintockloadaddr=200000 34920267768eSMatthew McClintock=> print oftaddr 34930267768eSMatthew McClintockoftaddr=0x300000 34940267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr 34950267768eSMatthew McClintock## Booting image at 00200000 ... 34960267768eSMatthew McClintock Image Name: Linux-2.6.17-dirty 34970267768eSMatthew McClintock Image Type: PowerPC Linux Kernel Image (gzip compressed) 34980267768eSMatthew McClintock Data Size: 1029343 Bytes = 1005.2 kB 34990267768eSMatthew McClintock Load Address: 00000000 35000267768eSMatthew McClintock Entry Point: 00000000 35010267768eSMatthew McClintock Verifying Checksum ... OK 35020267768eSMatthew McClintock Uncompressing Kernel Image ... OK 35030267768eSMatthew McClintockBooting using flat device tree at 0x300000 35040267768eSMatthew McClintockUsing MPC85xx ADS machine description 35050267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb 35060267768eSMatthew McClintock[snip] 35070267768eSMatthew McClintock 35080267768eSMatthew McClintock 35096069ff26SwdenkMore About U-Boot Image Types: 35106069ff26Swdenk------------------------------ 35116069ff26Swdenk 35126069ff26SwdenkU-Boot supports the following image types: 35136069ff26Swdenk 35146069ff26Swdenk "Standalone Programs" are directly runnable in the environment 35156069ff26Swdenk provided by U-Boot; it is expected that (if they behave 35166069ff26Swdenk well) you can continue to work in U-Boot after return from 35176069ff26Swdenk the Standalone Program. 35186069ff26Swdenk "OS Kernel Images" are usually images of some Embedded OS which 35196069ff26Swdenk will take over control completely. Usually these programs 35206069ff26Swdenk will install their own set of exception handlers, device 35216069ff26Swdenk drivers, set up the MMU, etc. - this means, that you cannot 35226069ff26Swdenk expect to re-enter U-Boot except by resetting the CPU. 35236069ff26Swdenk "RAMDisk Images" are more or less just data blocks, and their 35246069ff26Swdenk parameters (address, size) are passed to an OS kernel that is 35256069ff26Swdenk being started. 35266069ff26Swdenk "Multi-File Images" contain several images, typically an OS 35276069ff26Swdenk (Linux) kernel image and one or more data images like 35286069ff26Swdenk RAMDisks. This construct is useful for instance when you want 35296069ff26Swdenk to boot over the network using BOOTP etc., where the boot 35306069ff26Swdenk server provides just a single image file, but you want to get 35316069ff26Swdenk for instance an OS kernel and a RAMDisk image. 35326069ff26Swdenk 35336069ff26Swdenk "Multi-File Images" start with a list of image sizes, each 35346069ff26Swdenk image size (in bytes) specified by an "uint32_t" in network 35356069ff26Swdenk byte order. This list is terminated by an "(uint32_t)0". 35366069ff26Swdenk Immediately after the terminating 0 follow the images, one by 35376069ff26Swdenk one, all aligned on "uint32_t" boundaries (size rounded up to 35386069ff26Swdenk a multiple of 4 bytes). 35396069ff26Swdenk 35406069ff26Swdenk "Firmware Images" are binary images containing firmware (like 35416069ff26Swdenk U-Boot or FPGA images) which usually will be programmed to 35426069ff26Swdenk flash memory. 35436069ff26Swdenk 35446069ff26Swdenk "Script files" are command sequences that will be executed by 35456069ff26Swdenk U-Boot's command interpreter; this feature is especially 35466069ff26Swdenk useful when you configure U-Boot to use a real shell (hush) 35476069ff26Swdenk as command interpreter. 35486069ff26Swdenk 3549c609719bSwdenk 3550c609719bSwdenkStandalone HOWTO: 3551c609719bSwdenk================= 3552c609719bSwdenk 3553c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and 3554c609719bSwdenkrun "standalone" applications, which can use some resources of 3555c609719bSwdenkU-Boot like console I/O functions or interrupt services. 3556c609719bSwdenk 3557c609719bSwdenkTwo simple examples are included with the sources: 3558c609719bSwdenk 3559c609719bSwdenk"Hello World" Demo: 3560c609719bSwdenk------------------- 3561c609719bSwdenk 3562c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo 3563c609719bSwdenkapplication; it is automatically compiled when you build U-Boot. 3564c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it 3565c609719bSwdenklike that: 3566c609719bSwdenk 3567c609719bSwdenk => loads 3568c609719bSwdenk ## Ready for S-Record download ... 3569c609719bSwdenk ~>examples/hello_world.srec 3570c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 ... 3571c609719bSwdenk [file transfer complete] 3572c609719bSwdenk [connected] 3573c609719bSwdenk ## Start Addr = 0x00040004 3574c609719bSwdenk 3575c609719bSwdenk => go 40004 Hello World! This is a test. 3576c609719bSwdenk ## Starting application at 0x00040004 ... 3577c609719bSwdenk Hello World 3578c609719bSwdenk argc = 7 3579c609719bSwdenk argv[0] = "40004" 3580c609719bSwdenk argv[1] = "Hello" 3581c609719bSwdenk argv[2] = "World!" 3582c609719bSwdenk argv[3] = "This" 3583c609719bSwdenk argv[4] = "is" 3584c609719bSwdenk argv[5] = "a" 3585c609719bSwdenk argv[6] = "test." 3586c609719bSwdenk argv[7] = "<NULL>" 3587c609719bSwdenk Hit any key to exit ... 3588c609719bSwdenk 3589c609719bSwdenk ## Application terminated, rc = 0x0 3590c609719bSwdenk 3591c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt 3592c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'. 3593c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second. 3594c609719bSwdenkThe interrupt service routine is trivial, just printing a '.' 3595c609719bSwdenkcharacter, but this is just a demo program. The application can be 3596c609719bSwdenkcontrolled by the following keys: 3597c609719bSwdenk 3598c609719bSwdenk ? - print current values og the CPM Timer registers 3599c609719bSwdenk b - enable interrupts and start timer 3600c609719bSwdenk e - stop timer and disable interrupts 3601c609719bSwdenk q - quit application 3602c609719bSwdenk 3603c609719bSwdenk => loads 3604c609719bSwdenk ## Ready for S-Record download ... 3605c609719bSwdenk ~>examples/timer.srec 3606c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 ... 3607c609719bSwdenk [file transfer complete] 3608c609719bSwdenk [connected] 3609c609719bSwdenk ## Start Addr = 0x00040004 3610c609719bSwdenk 3611c609719bSwdenk => go 40004 3612c609719bSwdenk ## Starting application at 0x00040004 ... 3613c609719bSwdenk TIMERS=0xfff00980 3614c609719bSwdenk Using timer 1 3615c609719bSwdenk tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0 3616c609719bSwdenk 3617c609719bSwdenkHit 'b': 3618c609719bSwdenk [q, b, e, ?] Set interval 1000000 us 3619c609719bSwdenk Enabling timer 3620c609719bSwdenkHit '?': 3621c609719bSwdenk [q, b, e, ?] ........ 3622c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0 3623c609719bSwdenkHit '?': 3624c609719bSwdenk [q, b, e, ?] . 3625c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0 3626c609719bSwdenkHit '?': 3627c609719bSwdenk [q, b, e, ?] . 3628c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0 3629c609719bSwdenkHit '?': 3630c609719bSwdenk [q, b, e, ?] . 3631c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0 3632c609719bSwdenkHit 'e': 3633c609719bSwdenk [q, b, e, ?] ...Stopping timer 3634c609719bSwdenkHit 'q': 3635c609719bSwdenk [q, b, e, ?] ## Application terminated, rc = 0x0 3636c609719bSwdenk 3637c609719bSwdenk 363885ec0bccSwdenkMinicom warning: 363985ec0bccSwdenk================ 364085ec0bccSwdenk 36417152b1d0SwdenkOver time, many people have reported problems when trying to use the 364285ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd) 364385ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under 3644f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and 364585ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and 364685ec0bccSwdenkuse "cu" for S-Record download ("loads" command). 364785ec0bccSwdenk 364852f52c14SwdenkNevertheless, if you absolutely want to use it try adding this 364952f52c14Swdenkconfiguration to your "File transfer protocols" section: 365052f52c14Swdenk 365152f52c14Swdenk Name Program Name U/D FullScr IO-Red. Multi 365252f52c14Swdenk X kermit /usr/bin/kermit -i -l %l -s Y U Y N N 365352f52c14Swdenk Y kermit /usr/bin/kermit -i -l %l -r N D Y N N 365452f52c14Swdenk 365552f52c14Swdenk 3656c609719bSwdenkNetBSD Notes: 3657c609719bSwdenk============= 3658c609719bSwdenk 3659c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host 3660c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx). 3661c609719bSwdenk 3662c609719bSwdenkBuilding requires a cross environment; it is known to work on 3663c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also 3664c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make). 3665c609719bSwdenkNote that the cross-powerpc package does not install include files; 3666c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is 3667c609719bSwdenkmissing. This file has to be installed and patched manually: 3668c609719bSwdenk 3669c609719bSwdenk # cd /usr/pkg/cross/powerpc-netbsd/include 3670c609719bSwdenk # mkdir powerpc 3671c609719bSwdenk # ln -s powerpc machine 3672c609719bSwdenk # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h 3673c609719bSwdenk # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST 3674c609719bSwdenk 3675c609719bSwdenkNative builds *don't* work due to incompatibilities between native 3676c609719bSwdenkand U-Boot include files. 3677c609719bSwdenk 3678c609719bSwdenkBooting assumes that (the first part of) the image booted is a 3679c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel 3680c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source 3681c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the 36822a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz 3683c609719bSwdenk 3684c609719bSwdenk 3685c609719bSwdenkImplementation Internals: 3686c609719bSwdenk========================= 3687c609719bSwdenk 3688c609719bSwdenkThe following is not intended to be a complete description of every 3689c609719bSwdenkimplementation detail. However, it should help to understand the 3690c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom 3691c609719bSwdenkhardware. 3692c609719bSwdenk 3693c609719bSwdenk 3694c609719bSwdenkInitial Stack, Global Data: 3695c609719bSwdenk--------------------------- 3696c609719bSwdenk 3697c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot 3698c609719bSwdenkstarts running out of ROM (flash memory), usually without access to 3699c609719bSwdenksystem RAM (because the memory controller is not initialized yet). 3700c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS 3701c609719bSwdenkis not initialized as zero. To be able to get a C environment working 3702c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation 3703c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU 3704c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and 3705c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be 3706c609719bSwdenklocked as (mis-) used as memory, etc. 3707c609719bSwdenk 37087152b1d0Swdenk Chris Hallinan posted a good summary of these issues to the 370943d9616cSwdenk u-boot-users mailing list: 371043d9616cSwdenk 371143d9616cSwdenk Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)? 371243d9616cSwdenk From: "Chris Hallinan" <clh@net1plus.com> 371343d9616cSwdenk Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET) 371443d9616cSwdenk ... 371543d9616cSwdenk 371643d9616cSwdenk Correct me if I'm wrong, folks, but the way I understand it 371743d9616cSwdenk is this: Using DCACHE as initial RAM for Stack, etc, does not 371843d9616cSwdenk require any physical RAM backing up the cache. The cleverness 371943d9616cSwdenk is that the cache is being used as a temporary supply of 372043d9616cSwdenk necessary storage before the SDRAM controller is setup. It's 372111ccc33fSMarcel Ziswiler beyond the scope of this list to explain the details, but you 372243d9616cSwdenk can see how this works by studying the cache architecture and 372343d9616cSwdenk operation in the architecture and processor-specific manuals. 372443d9616cSwdenk 372543d9616cSwdenk OCM is On Chip Memory, which I believe the 405GP has 4K. It 372643d9616cSwdenk is another option for the system designer to use as an 372711ccc33fSMarcel Ziswiler initial stack/RAM area prior to SDRAM being available. Either 372843d9616cSwdenk option should work for you. Using CS 4 should be fine if your 372943d9616cSwdenk board designers haven't used it for something that would 373043d9616cSwdenk cause you grief during the initial boot! It is frequently not 373143d9616cSwdenk used. 373243d9616cSwdenk 373343d9616cSwdenk CFG_INIT_RAM_ADDR should be somewhere that won't interfere 373443d9616cSwdenk with your processor/board/system design. The default value 373543d9616cSwdenk you will find in any recent u-boot distribution in 37368a316c9bSStefan Roese walnut.h should work for you. I'd set it to a value larger 373743d9616cSwdenk than your SDRAM module. If you have a 64MB SDRAM module, set 373843d9616cSwdenk it above 400_0000. Just make sure your board has no resources 373943d9616cSwdenk that are supposed to respond to that address! That code in 374043d9616cSwdenk start.S has been around a while and should work as is when 374143d9616cSwdenk you get the config right. 374243d9616cSwdenk 374343d9616cSwdenk -Chris Hallinan 374443d9616cSwdenk DS4.COM, Inc. 374543d9616cSwdenk 3746c609719bSwdenkIt is essential to remember this, since it has some impact on the C 3747c609719bSwdenkcode for the initialization procedures: 3748c609719bSwdenk 3749c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt 3750c609719bSwdenk to write it. 3751c609719bSwdenk 375211ccc33fSMarcel Ziswiler* Do not use any uninitialized global data (or implicitely initialized 3753c609719bSwdenk as zero data - BSS segment) at all - this is undefined, initiali- 37547152b1d0Swdenk zation is performed later (when relocating to RAM). 3755c609719bSwdenk 3756c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like 3757c609719bSwdenk that. 3758c609719bSwdenk 3759c609719bSwdenkHaving only the stack as writable memory limits means we cannot use 3760c609719bSwdenknormal global data to share information beween the code. But it 3761c609719bSwdenkturned out that the implementation of U-Boot can be greatly 3762c609719bSwdenksimplified by making a global data structure (gd_t) available to all 3763c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_ 3764c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of 3765c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we 3766c609719bSwdenkplace a pointer (gd) to the global data into a register which we 3767c609719bSwdenkreserve for this purpose. 3768c609719bSwdenk 37697152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the 3770c609719bSwdenkrelevant (E)ABI specifications for the current architecture, and by 3771c609719bSwdenkGCC's implementation. 3772c609719bSwdenk 3773c609719bSwdenkFor PowerPC, the following registers have specific use: 3774c609719bSwdenk R1: stack pointer 3775e7670f6cSWolfgang Denk R2: reserved for system use 3776c609719bSwdenk R3-R4: parameter passing and return values 3777c609719bSwdenk R5-R10: parameter passing 3778c609719bSwdenk R13: small data area pointer 3779c609719bSwdenk R30: GOT pointer 3780c609719bSwdenk R31: frame pointer 3781c609719bSwdenk 3782c609719bSwdenk (U-Boot also uses R14 as internal GOT pointer.) 3783c609719bSwdenk 3784e7670f6cSWolfgang Denk ==> U-Boot will use R2 to hold a pointer to the global data 3785c609719bSwdenk 3786c609719bSwdenk Note: on PPC, we could use a static initializer (since the 3787c609719bSwdenk address of the global data structure is known at compile time), 3788c609719bSwdenk but it turned out that reserving a register results in somewhat 3789c609719bSwdenk smaller code - although the code savings are not that big (on 3790c609719bSwdenk average for all boards 752 bytes for the whole U-Boot image, 3791c609719bSwdenk 624 text + 127 data). 3792c609719bSwdenk 37934c58eb55SMike FrysingerOn Blackfin, the normal C ABI (except for P5) is followed as documented here: 37944c58eb55SMike Frysinger http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface 37954c58eb55SMike Frysinger 37964c58eb55SMike Frysinger ==> U-Boot will use P5 to hold a pointer to the global data 37974c58eb55SMike Frysinger 3798c609719bSwdenkOn ARM, the following registers are used: 3799c609719bSwdenk 3800c609719bSwdenk R0: function argument word/integer result 3801c609719bSwdenk R1-R3: function argument word 3802c609719bSwdenk R9: GOT pointer 3803c609719bSwdenk R10: stack limit (used only if stack checking if enabled) 3804c609719bSwdenk R11: argument (frame) pointer 3805c609719bSwdenk R12: temporary workspace 3806c609719bSwdenk R13: stack pointer 3807c609719bSwdenk R14: link register 3808c609719bSwdenk R15: program counter 3809c609719bSwdenk 3810c609719bSwdenk ==> U-Boot will use R8 to hold a pointer to the global data 3811c609719bSwdenk 3812d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope, 3813d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much. 3814c609719bSwdenk 3815c609719bSwdenkMemory Management: 3816c609719bSwdenk------------------ 3817c609719bSwdenk 3818c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the 3819c609719bSwdenkMMU is not used either for address mapping nor for memory protection. 3820c609719bSwdenk 3821c609719bSwdenkThe available memory is mapped to fixed addresses using the memory 3822c609719bSwdenkcontroller. In this process, a contiguous block is formed for each 3823c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several 3824c609719bSwdenkphysical memory banks. 3825c609719bSwdenk 3826c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on 3827c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After 3828c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself 3829c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some 3830c609719bSwdenkmemory is reserved for use by malloc() [see CFG_MALLOC_LEN 3831c609719bSwdenkconfiguration setting]. Below that, a structure with global Board 3832c609719bSwdenkInfo data is placed, followed by the stack (growing downward). 3833c609719bSwdenk 3834c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB 3835c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF). 3836c609719bSwdenk 3837c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like 3838c609719bSwdenkthis: 3839c609719bSwdenk 3840c609719bSwdenk 0x0000 0000 Exception Vector code 3841c609719bSwdenk : 3842c609719bSwdenk 0x0000 1FFF 3843c609719bSwdenk 0x0000 2000 Free for Application Use 3844c609719bSwdenk : 3845c609719bSwdenk : 3846c609719bSwdenk 3847c609719bSwdenk : 3848c609719bSwdenk : 3849c609719bSwdenk 0x00FB FF20 Monitor Stack (Growing downward) 3850c609719bSwdenk 0x00FB FFAC Board Info Data and permanent copy of global data 3851c609719bSwdenk 0x00FC 0000 Malloc Arena 3852c609719bSwdenk : 3853c609719bSwdenk 0x00FD FFFF 3854c609719bSwdenk 0x00FE 0000 RAM Copy of Monitor Code 3855c609719bSwdenk ... eventually: LCD or video framebuffer 3856c609719bSwdenk ... eventually: pRAM (Protected RAM - unchanged by reset) 3857c609719bSwdenk 0x00FF FFFF [End of RAM] 3858c609719bSwdenk 3859c609719bSwdenk 3860c609719bSwdenkSystem Initialization: 3861c609719bSwdenk---------------------- 3862c609719bSwdenk 3863c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point 386411ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset 3865c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory. 38667152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address. 3867c609719bSwdenkTo be able to implement the initialization code in C, a (small!) 3868c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs 3869c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked 3870c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core, 3871c609719bSwdenkthe caches and the SIU. 3872c609719bSwdenk 3873c609719bSwdenkNext, all (potentially) available memory banks are mapped using a 3874c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries 3875c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash 3876c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is 3877c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a 3878c609719bSwdenksimple memory test is run that determines the size of the SDRAM 3879c609719bSwdenkbanks. 3880c609719bSwdenk 3881c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of 38827152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first 3883c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address 3884c609719bSwdenk0x00000000, with any additional banks following immediately to create 3885c609719bSwdenkcontiguous memory starting from 0. 3886c609719bSwdenk 3887c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area 3888c609719bSwdenkand allocates memory for use by malloc() and for the global Board 3889c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM 3890c609719bSwdenkpages, and the final stack is set up. 3891c609719bSwdenk 3892c609719bSwdenkOnly after this relocation will you have a "normal" C environment; 3893c609719bSwdenkuntil that you are restricted in several ways, mostly because you are 3894c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a 3895c609719bSwdenknew address in RAM. 3896c609719bSwdenk 3897c609719bSwdenk 3898c609719bSwdenkU-Boot Porting Guide: 3899c609719bSwdenk---------------------- 3900c609719bSwdenk 3901c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing 39026aff3115Swdenklist, October 2002] 3903c609719bSwdenk 3904c609719bSwdenk 3905c609719bSwdenkint main (int argc, char *argv[]) 3906c609719bSwdenk{ 3907c609719bSwdenk sighandler_t no_more_time; 3908c609719bSwdenk 3909c609719bSwdenk signal (SIGALRM, no_more_time); 3910c609719bSwdenk alarm (PROJECT_DEADLINE - toSec (3 * WEEK)); 3911c609719bSwdenk 3912c609719bSwdenk if (available_money > available_manpower) { 3913c609719bSwdenk pay consultant to port U-Boot; 3914c609719bSwdenk return 0; 3915c609719bSwdenk } 3916c609719bSwdenk 3917c609719bSwdenk Download latest U-Boot source; 3918c609719bSwdenk 39196aff3115Swdenk Subscribe to u-boot-users mailing list; 39206aff3115Swdenk 3921c609719bSwdenk if (clueless) { 3922c609719bSwdenk email ("Hi, I am new to U-Boot, how do I get started?"); 3923c609719bSwdenk } 3924c609719bSwdenk 3925c609719bSwdenk while (learning) { 3926c609719bSwdenk Read the README file in the top level directory; 39277cb22f97Swdenk Read http://www.denx.de/twiki/bin/view/DULG/Manual ; 3928c609719bSwdenk Read the source, Luke; 3929c609719bSwdenk } 3930c609719bSwdenk 3931c609719bSwdenk if (available_money > toLocalCurrency ($2500)) { 3932c609719bSwdenk Buy a BDI2000; 3933c609719bSwdenk } else { 3934c609719bSwdenk Add a lot of aggravation and time; 3935c609719bSwdenk } 3936c609719bSwdenk 3937c609719bSwdenk Create your own board support subdirectory; 3938c609719bSwdenk 39396aff3115Swdenk Create your own board config file; 39406aff3115Swdenk 3941c609719bSwdenk while (!running) { 3942c609719bSwdenk do { 3943c609719bSwdenk Add / modify source code; 3944c609719bSwdenk } until (compiles); 3945c609719bSwdenk Debug; 3946c609719bSwdenk if (clueless) 3947c609719bSwdenk email ("Hi, I am having problems..."); 3948c609719bSwdenk } 3949c609719bSwdenk Send patch file to Wolfgang; 3950c609719bSwdenk 3951c609719bSwdenk return 0; 3952c609719bSwdenk} 3953c609719bSwdenk 3954c609719bSwdenkvoid no_more_time (int sig) 3955c609719bSwdenk{ 3956c609719bSwdenk hire_a_guru(); 3957c609719bSwdenk} 3958c609719bSwdenk 3959c609719bSwdenk 3960c609719bSwdenkCoding Standards: 3961c609719bSwdenk----------------- 3962c609719bSwdenk 3963c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel 39642c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script 39652c051651SDetlev Zundel"scripts/Lindent" in your Linux kernel source directory. In sources 39662c051651SDetlev Zundeloriginating from U-Boot a style corresponding to "Lindent -pcs" (adding 39672c051651SDetlev Zundelspaces before parameters to function calls) is actually used. 3968c609719bSwdenk 39692c051651SDetlev ZundelSource files originating from a different project (for example the 39702c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not 39712c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those 39722c051651SDetlev Zundelsources. 39732c051651SDetlev Zundel 39742c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in 39752c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//) 39762c051651SDetlev Zundelin your code. 3977c609719bSwdenk 3978c178d3daSwdenkPlease also stick to the following formatting rules: 3979180d3f74Swdenk- remove any trailing white space 3980180d3f74Swdenk- use TAB characters for indentation, not spaces 3981180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds 3982180d3f74Swdenk- do not add more than 2 empty lines to source files 3983180d3f74Swdenk- do not add trailing empty lines to source files 3984180d3f74Swdenk 3985c609719bSwdenkSubmissions which do not conform to the standards may be returned 3986c609719bSwdenkwith a request to reformat the changes. 3987c609719bSwdenk 3988c609719bSwdenk 3989c609719bSwdenkSubmitting Patches: 3990c609719bSwdenk------------------- 3991c609719bSwdenk 3992c609719bSwdenkSince the number of patches for U-Boot is growing, we need to 3993c609719bSwdenkestablish some rules. Submissions which do not conform to these rules 3994c609719bSwdenkmay be rejected, even when they contain important and valuable stuff. 3995c609719bSwdenk 399690dc6704SwdenkPatches shall be sent to the u-boot-users mailing list. 3997c609719bSwdenk 39980d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details. 3999218ca724SWolfgang Denk 4000c609719bSwdenkWhen you send a patch, please include the following information with 4001c609719bSwdenkit: 4002c609719bSwdenk 4003c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes 4004c609719bSwdenk this bug. Please try to include a way of demonstrating that the 4005c609719bSwdenk patch actually fixes something. 4006c609719bSwdenk 4007c609719bSwdenk* For new features: a description of the feature and your 4008c609719bSwdenk implementation. 4009c609719bSwdenk 4010c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch) 4011c609719bSwdenk 4012c609719bSwdenk* For major contributions, your entry to the CREDITS file 4013c609719bSwdenk 4014c609719bSwdenk* When you add support for a new board, don't forget to add this 4015c609719bSwdenk board to the MAKEALL script, too. 4016c609719bSwdenk 4017c609719bSwdenk* If your patch adds new configuration options, don't forget to 4018c609719bSwdenk document these in the README file. 4019c609719bSwdenk 4020218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly* 4021218ca724SWolfgang Denk recommended) you can easily generate the patch using the 4022218ca724SWolfgang Denk "git-format-patch". If you then use "git-send-email" to send it to 4023218ca724SWolfgang Denk the U-Boot mailing list, you will avoid most of the common problems 4024218ca724SWolfgang Denk with some other mail clients. 4025c609719bSwdenk 4026218ca724SWolfgang Denk If you cannot use git, use "diff -purN OLD NEW". If your version of 4027218ca724SWolfgang Denk diff does not support these options, then get the latest version of 4028218ca724SWolfgang Denk GNU diff. 40296dff5529Swdenk 4030218ca724SWolfgang Denk The current directory when running this command shall be the parent 4031218ca724SWolfgang Denk directory of the U-Boot source tree (i. e. please make sure that 4032218ca724SWolfgang Denk your patch includes sufficient directory information for the 4033218ca724SWolfgang Denk affected files). 4034218ca724SWolfgang Denk 4035218ca724SWolfgang Denk We prefer patches as plain text. MIME attachments are discouraged, 4036218ca724SWolfgang Denk and compressed attachments must not be used. 4037c609719bSwdenk 403852f52c14Swdenk* If one logical set of modifications affects or creates several 403952f52c14Swdenk files, all these changes shall be submitted in a SINGLE patch file. 404052f52c14Swdenk 404152f52c14Swdenk* Changesets that contain different, unrelated modifications shall be 404252f52c14Swdenk submitted as SEPARATE patches, one patch per changeset. 404352f52c14Swdenk 404452f52c14Swdenk 4045c609719bSwdenkNotes: 4046c609719bSwdenk 4047c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched 4048c609719bSwdenk source tree and make sure that no errors or warnings are reported 4049c609719bSwdenk for any of the boards. 4050c609719bSwdenk 4051c609719bSwdenk* Keep your modifications to the necessary minimum: A patch 4052c609719bSwdenk containing several unrelated changes or arbitrary reformats will be 4053c609719bSwdenk returned with a request to re-formatting / split it. 4054c609719bSwdenk 4055c609719bSwdenk* If you modify existing code, make sure that your new code does not 4056c609719bSwdenk add to the memory footprint of the code ;-) Small is beautiful! 4057c609719bSwdenk When adding new features, these should compile conditionally only 4058c609719bSwdenk (using #ifdef), and the resulting code with the new feature 4059c609719bSwdenk disabled must not need more memory than the old code without your 4060c609719bSwdenk modification. 406190dc6704Swdenk 406290dc6704Swdenk* Remember that there is a size limit of 40 kB per message on the 4063218ca724SWolfgang Denk u-boot-users mailing list. Bigger patches will be moderated. If 4064218ca724SWolfgang Denk they are reasonable and not bigger than 100 kB, they will be 4065218ca724SWolfgang Denk acknowledged. Even bigger patches should be avoided. 4066