1c609719bSwdenk# 2eca3aeb3SWolfgang Denk# (C) Copyright 2000 - 2013 3c609719bSwdenk# Wolfgang Denk, DENX Software Engineering, wd@denx.de. 4c609719bSwdenk# 5eca3aeb3SWolfgang Denk# SPDX-License-Identifier: GPL-2.0+ 6c609719bSwdenk# 7c609719bSwdenk 8c609719bSwdenkSummary: 9c609719bSwdenk======== 10c609719bSwdenk 1124ee89b9SwdenkThis directory contains the source code for U-Boot, a boot loader for 12e86e5a07SwdenkEmbedded boards based on PowerPC, ARM, MIPS and several other 13e86e5a07Swdenkprocessors, which can be installed in a boot ROM and used to 14e86e5a07Swdenkinitialize and test the hardware or to download and run application 15e86e5a07Swdenkcode. 16c609719bSwdenk 17c609719bSwdenkThe development of U-Boot is closely related to Linux: some parts of 1824ee89b9Swdenkthe source code originate in the Linux source tree, we have some 1924ee89b9Swdenkheader files in common, and special provision has been made to 20c609719bSwdenksupport booting of Linux images. 21c609719bSwdenk 22c609719bSwdenkSome attention has been paid to make this software easily 23c609719bSwdenkconfigurable and extendable. For instance, all monitor commands are 24c609719bSwdenkimplemented with the same call interface, so that it's very easy to 25c609719bSwdenkadd new commands. Also, instead of permanently adding rarely used 26c609719bSwdenkcode (for instance hardware test utilities) to the monitor, you can 27c609719bSwdenkload and run it dynamically. 28c609719bSwdenk 29c609719bSwdenk 30c609719bSwdenkStatus: 31c609719bSwdenk======= 32c609719bSwdenk 33c609719bSwdenkIn general, all boards for which a configuration option exists in the 34c609719bSwdenkMakefile have been tested to some extent and can be considered 35c609719bSwdenk"working". In fact, many of them are used in production systems. 36c609719bSwdenk 37c609719bSwdenkIn case of problems see the CHANGELOG and CREDITS files to find out 3827af930eSAlbert ARIBAUDwho contributed the specific port. The boards.cfg file lists board 39218ca724SWolfgang Denkmaintainers. 40c609719bSwdenk 41adb9d851SRobert P. J. DayNote: There is no CHANGELOG file in the actual U-Boot source tree; 42adb9d851SRobert P. J. Dayit can be created dynamically from the Git log using: 43adb9d851SRobert P. J. Day 44adb9d851SRobert P. J. Day make CHANGELOG 45adb9d851SRobert P. J. Day 46c609719bSwdenk 47c609719bSwdenkWhere to get help: 48c609719bSwdenk================== 49c609719bSwdenk 50c609719bSwdenkIn case you have questions about, problems with or contributions for 51c609719bSwdenkU-Boot you should send a message to the U-Boot mailing list at 520c32565fSPeter Tyser<u-boot@lists.denx.de>. There is also an archive of previous traffic 530c32565fSPeter Tyseron the mailing list - please search the archive before asking FAQ's. 540c32565fSPeter TyserPlease see http://lists.denx.de/pipermail/u-boot and 550c32565fSPeter Tyserhttp://dir.gmane.org/gmane.comp.boot-loaders.u-boot 56c609719bSwdenk 57c609719bSwdenk 58218ca724SWolfgang DenkWhere to get source code: 59218ca724SWolfgang Denk========================= 60218ca724SWolfgang Denk 61218ca724SWolfgang DenkThe U-Boot source code is maintained in the git repository at 62218ca724SWolfgang Denkgit://www.denx.de/git/u-boot.git ; you can browse it online at 63218ca724SWolfgang Denkhttp://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary 64218ca724SWolfgang Denk 65218ca724SWolfgang DenkThe "snapshot" links on this page allow you to download tarballs of 6611ccc33fSMarcel Ziswilerany version you might be interested in. Official releases are also 67218ca724SWolfgang Denkavailable for FTP download from the ftp://ftp.denx.de/pub/u-boot/ 68218ca724SWolfgang Denkdirectory. 69218ca724SWolfgang Denk 70d4ee711dSAnatolij GustschinPre-built (and tested) images are available from 71218ca724SWolfgang Denkftp://ftp.denx.de/pub/u-boot/images/ 72218ca724SWolfgang Denk 73218ca724SWolfgang Denk 74c609719bSwdenkWhere we come from: 75c609719bSwdenk=================== 76c609719bSwdenk 77c609719bSwdenk- start from 8xxrom sources 7824ee89b9Swdenk- create PPCBoot project (http://sourceforge.net/projects/ppcboot) 79c609719bSwdenk- clean up code 80c609719bSwdenk- make it easier to add custom boards 81c609719bSwdenk- make it possible to add other [PowerPC] CPUs 82c609719bSwdenk- extend functions, especially: 83c609719bSwdenk * Provide extended interface to Linux boot loader 84c609719bSwdenk * S-Record download 85c609719bSwdenk * network boot 8611ccc33fSMarcel Ziswiler * PCMCIA / CompactFlash / ATA disk / SCSI ... boot 8724ee89b9Swdenk- create ARMBoot project (http://sourceforge.net/projects/armboot) 88c609719bSwdenk- add other CPU families (starting with ARM) 8924ee89b9Swdenk- create U-Boot project (http://sourceforge.net/projects/u-boot) 900d28f34bSMagnus Lilja- current project page: see http://www.denx.de/wiki/U-Boot 9124ee89b9Swdenk 9224ee89b9Swdenk 9324ee89b9SwdenkNames and Spelling: 9424ee89b9Swdenk=================== 9524ee89b9Swdenk 9624ee89b9SwdenkThe "official" name of this project is "Das U-Boot". The spelling 9724ee89b9Swdenk"U-Boot" shall be used in all written text (documentation, comments 9824ee89b9Swdenkin source files etc.). Example: 9924ee89b9Swdenk 10024ee89b9Swdenk This is the README file for the U-Boot project. 10124ee89b9Swdenk 10224ee89b9SwdenkFile names etc. shall be based on the string "u-boot". Examples: 10324ee89b9Swdenk 10424ee89b9Swdenk include/asm-ppc/u-boot.h 10524ee89b9Swdenk 10624ee89b9Swdenk #include <asm/u-boot.h> 10724ee89b9Swdenk 10824ee89b9SwdenkVariable names, preprocessor constants etc. shall be either based on 10924ee89b9Swdenkthe string "u_boot" or on "U_BOOT". Example: 11024ee89b9Swdenk 11124ee89b9Swdenk U_BOOT_VERSION u_boot_logo 11224ee89b9Swdenk IH_OS_U_BOOT u_boot_hush_start 113c609719bSwdenk 114c609719bSwdenk 11593f19cc0SwdenkVersioning: 11693f19cc0Swdenk=========== 11793f19cc0Swdenk 118360d883aSThomas WeberStarting with the release in October 2008, the names of the releases 119360d883aSThomas Weberwere changed from numerical release numbers without deeper meaning 120360d883aSThomas Weberinto a time stamp based numbering. Regular releases are identified by 121360d883aSThomas Webernames consisting of the calendar year and month of the release date. 122360d883aSThomas WeberAdditional fields (if present) indicate release candidates or bug fix 123360d883aSThomas Weberreleases in "stable" maintenance trees. 12493f19cc0Swdenk 125360d883aSThomas WeberExamples: 126360d883aSThomas Weber U-Boot v2009.11 - Release November 2009 127360d883aSThomas Weber U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree 128360d883aSThomas Weber U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release 12993f19cc0Swdenk 13093f19cc0Swdenk 131c609719bSwdenkDirectory Hierarchy: 132c609719bSwdenk==================== 133c609719bSwdenk 1348d321b81SPeter Tyser/arch Architecture specific files 1358d321b81SPeter Tyser /arm Files generic to ARM architecture 1368d321b81SPeter Tyser /cpu CPU specific files 1378d321b81SPeter Tyser /arm720t Files specific to ARM 720 CPUs 1388d321b81SPeter Tyser /arm920t Files specific to ARM 920 CPUs 1396eb0921aSAndreas Bießmann /at91 Files specific to Atmel AT91RM9200 CPU 1408d321b81SPeter Tyser /imx Files specific to Freescale MC9328 i.MX CPUs 1418d321b81SPeter Tyser /s3c24x0 Files specific to Samsung S3C24X0 CPUs 1428d321b81SPeter Tyser /arm926ejs Files specific to ARM 926 CPUs 1438d321b81SPeter Tyser /arm1136 Files specific to ARM 1136 CPUs 1448d321b81SPeter Tyser /ixp Files specific to Intel XScale IXP CPUs 1458d321b81SPeter Tyser /pxa Files specific to Intel XScale PXA CPUs 1468d321b81SPeter Tyser /sa1100 Files specific to Intel StrongARM SA1100 CPUs 1478d321b81SPeter Tyser /lib Architecture specific library files 1488d321b81SPeter Tyser /avr32 Files generic to AVR32 architecture 1498d321b81SPeter Tyser /cpu CPU specific files 1508d321b81SPeter Tyser /lib Architecture specific library files 1518d321b81SPeter Tyser /blackfin Files generic to Analog Devices Blackfin architecture 1528d321b81SPeter Tyser /cpu CPU specific files 1538d321b81SPeter Tyser /lib Architecture specific library files 1548d321b81SPeter Tyser /m68k Files generic to m68k architecture 1558d321b81SPeter Tyser /cpu CPU specific files 1568d321b81SPeter Tyser /mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs 1578d321b81SPeter Tyser /mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs 1588d321b81SPeter Tyser /mcf532x Files specific to Freescale ColdFire MCF5329 CPUs 1598d321b81SPeter Tyser /mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs 1608d321b81SPeter Tyser /mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs 1618d321b81SPeter Tyser /lib Architecture specific library files 1628d321b81SPeter Tyser /microblaze Files generic to microblaze architecture 1638d321b81SPeter Tyser /cpu CPU specific files 1648d321b81SPeter Tyser /lib Architecture specific library files 1658d321b81SPeter Tyser /mips Files generic to MIPS architecture 1668d321b81SPeter Tyser /cpu CPU specific files 16792bbd64eSDaniel Schwierzeck /mips32 Files specific to MIPS32 CPUs 16880421fccSXiangfu Liu /xburst Files specific to Ingenic XBurst CPUs 1698d321b81SPeter Tyser /lib Architecture specific library files 170afc1ce82SMacpaul Lin /nds32 Files generic to NDS32 architecture 171afc1ce82SMacpaul Lin /cpu CPU specific files 172afc1ce82SMacpaul Lin /n1213 Files specific to Andes Technology N1213 CPUs 173afc1ce82SMacpaul Lin /lib Architecture specific library files 1748d321b81SPeter Tyser /nios2 Files generic to Altera NIOS2 architecture 1758d321b81SPeter Tyser /cpu CPU specific files 1768d321b81SPeter Tyser /lib Architecture specific library files 17733c7731bSRobert P. J. Day /openrisc Files generic to OpenRISC architecture 17833c7731bSRobert P. J. Day /cpu CPU specific files 17933c7731bSRobert P. J. Day /lib Architecture specific library files 180a47a12beSStefan Roese /powerpc Files generic to PowerPC architecture 1818d321b81SPeter Tyser /cpu CPU specific files 1828d321b81SPeter Tyser /74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs 1838d321b81SPeter Tyser /mpc5xx Files specific to Freescale MPC5xx CPUs 1848d321b81SPeter Tyser /mpc5xxx Files specific to Freescale MPC5xxx CPUs 1858d321b81SPeter Tyser /mpc8xx Files specific to Freescale MPC8xx CPUs 1868d321b81SPeter Tyser /mpc824x Files specific to Freescale MPC824x CPUs 1878d321b81SPeter Tyser /mpc8260 Files specific to Freescale MPC8260 CPUs 1888d321b81SPeter Tyser /mpc85xx Files specific to Freescale MPC85xx CPUs 1898d321b81SPeter Tyser /ppc4xx Files specific to AMCC PowerPC 4xx CPUs 1908d321b81SPeter Tyser /lib Architecture specific library files 1918d321b81SPeter Tyser /sh Files generic to SH architecture 1928d321b81SPeter Tyser /cpu CPU specific files 1938d321b81SPeter Tyser /sh2 Files specific to sh2 CPUs 1948d321b81SPeter Tyser /sh3 Files specific to sh3 CPUs 1958d321b81SPeter Tyser /sh4 Files specific to sh4 CPUs 1968d321b81SPeter Tyser /lib Architecture specific library files 1978d321b81SPeter Tyser /sparc Files generic to SPARC architecture 1988d321b81SPeter Tyser /cpu CPU specific files 1998d321b81SPeter Tyser /leon2 Files specific to Gaisler LEON2 SPARC CPU 2008d321b81SPeter Tyser /leon3 Files specific to Gaisler LEON3 SPARC CPU 2018d321b81SPeter Tyser /lib Architecture specific library files 20233c7731bSRobert P. J. Day /x86 Files generic to x86 architecture 20333c7731bSRobert P. J. Day /cpu CPU specific files 20433c7731bSRobert P. J. Day /lib Architecture specific library files 2058d321b81SPeter Tyser/api Machine/arch independent API for external apps 2068d321b81SPeter Tyser/board Board dependent files 2078d321b81SPeter Tyser/common Misc architecture independent functions 2088d321b81SPeter Tyser/disk Code for disk drive partition handling 2098d321b81SPeter Tyser/doc Documentation (don't expect too much) 2108d321b81SPeter Tyser/drivers Commonly used device drivers 21133c7731bSRobert P. J. Day/dts Contains Makefile for building internal U-Boot fdt. 2128d321b81SPeter Tyser/examples Example code for standalone applications, etc. 2138d321b81SPeter Tyser/fs Filesystem code (cramfs, ext2, jffs2, etc.) 2148d321b81SPeter Tyser/include Header Files 2158d321b81SPeter Tyser/lib Files generic to all architectures 2168d321b81SPeter Tyser /libfdt Library files to support flattened device trees 2178d321b81SPeter Tyser /lzma Library files to support LZMA decompression 2188d321b81SPeter Tyser /lzo Library files to support LZO decompression 2198d321b81SPeter Tyser/net Networking code 2208d321b81SPeter Tyser/post Power On Self Test 22133c7731bSRobert P. J. Day/spl Secondary Program Loader framework 2228d321b81SPeter Tyser/tools Tools to build S-Record or U-Boot images, etc. 223c609719bSwdenk 224c609719bSwdenkSoftware Configuration: 225c609719bSwdenk======================= 226c609719bSwdenk 227c609719bSwdenkConfiguration is usually done using C preprocessor defines; the 228c609719bSwdenkrationale behind that is to avoid dead code whenever possible. 229c609719bSwdenk 230c609719bSwdenkThere are two classes of configuration variables: 231c609719bSwdenk 232c609719bSwdenk* Configuration _OPTIONS_: 233c609719bSwdenk These are selectable by the user and have names beginning with 234c609719bSwdenk "CONFIG_". 235c609719bSwdenk 236c609719bSwdenk* Configuration _SETTINGS_: 237c609719bSwdenk These depend on the hardware etc. and should not be meddled with if 238c609719bSwdenk you don't know what you're doing; they have names beginning with 2396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD "CONFIG_SYS_". 240c609719bSwdenk 241c609719bSwdenkLater we will add a configuration tool - probably similar to or even 242c609719bSwdenkidentical to what's used for the Linux kernel. Right now, we have to 243c609719bSwdenkdo the configuration by hand, which means creating some symbolic 244c609719bSwdenklinks and editing some configuration files. We use the TQM8xxL boards 245c609719bSwdenkas an example here. 246c609719bSwdenk 247c609719bSwdenk 248c609719bSwdenkSelection of Processor Architecture and Board Type: 249c609719bSwdenk--------------------------------------------------- 250c609719bSwdenk 251c609719bSwdenkFor all supported boards there are ready-to-use default 252c609719bSwdenkconfigurations available; just type "make <board_name>_config". 253c609719bSwdenk 254c609719bSwdenkExample: For a TQM823L module type: 255c609719bSwdenk 256c609719bSwdenk cd u-boot 257c609719bSwdenk make TQM823L_config 258c609719bSwdenk 25911ccc33fSMarcel ZiswilerFor the Cogent platform, you need to specify the CPU type as well; 260c609719bSwdenke.g. "make cogent_mpc8xx_config". And also configure the cogent 261c609719bSwdenkdirectory according to the instructions in cogent/README. 262c609719bSwdenk 263c609719bSwdenk 264c609719bSwdenkConfiguration Options: 265c609719bSwdenk---------------------- 266c609719bSwdenk 267c609719bSwdenkConfiguration depends on the combination of board and CPU type; all 268c609719bSwdenksuch information is kept in a configuration file 269c609719bSwdenk"include/configs/<board_name>.h". 270c609719bSwdenk 271c609719bSwdenkExample: For a TQM823L module, all configuration settings are in 272c609719bSwdenk"include/configs/TQM823L.h". 273c609719bSwdenk 274c609719bSwdenk 2757f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux 2767f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to 2777f6c2cbcSwdenkbuild a config tool - later. 2787f6c2cbcSwdenk 2797f6c2cbcSwdenk 280c609719bSwdenkThe following options need to be configured: 281c609719bSwdenk 2822628114eSKim Phillips- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX. 283c609719bSwdenk 2842628114eSKim Phillips- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS. 2856ccec449SWolfgang Denk 2866ccec449SWolfgang Denk- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined) 28709ea0de0SHaavard Skinnemoen Define exactly one, e.g. CONFIG_ATSTK1002 288c609719bSwdenk 289c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined) 290c609719bSwdenk Define exactly one of 291c609719bSwdenk CONFIG_CMA286_60_OLD 292c609719bSwdenk--- FIXME --- not tested yet: 293c609719bSwdenk CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P, 294c609719bSwdenk CONFIG_CMA287_23, CONFIG_CMA287_50 295c609719bSwdenk 296c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined) 297c609719bSwdenk Define exactly one of 298c609719bSwdenk CONFIG_CMA101, CONFIG_CMA102 299c609719bSwdenk 300c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined) 301c609719bSwdenk Define one or more of 302c609719bSwdenk CONFIG_CMA302 303c609719bSwdenk 304c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined) 305c609719bSwdenk Define one or more of 306c609719bSwdenk CONFIG_LCD_HEARTBEAT - update a character position on 30711ccc33fSMarcel Ziswiler the LCD display every second with 308c609719bSwdenk a "rotator" |\-/|\-/ 309c609719bSwdenk 3102535d602Swdenk- Board flavour: (if CONFIG_MPC8260ADS is defined) 3112535d602Swdenk CONFIG_ADSTYPE 3122535d602Swdenk Possible values are: 3136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8260ADS - original MPC8260ADS 3146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8266ADS - MPC8266ADS 3156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR 3166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8272ADS - MPC8272ADS 3172535d602Swdenk 318cf946c6dSLei Wen- Marvell Family Member 319cf946c6dSLei Wen CONFIG_SYS_MVFS - define it if you want to enable 320cf946c6dSLei Wen multiple fs option at one time 321cf946c6dSLei Wen for marvell soc family 322cf946c6dSLei Wen 323c609719bSwdenk- MPC824X Family Member (if CONFIG_MPC824X is defined) 324c609719bSwdenk Define exactly one of 325c609719bSwdenk CONFIG_MPC8240, CONFIG_MPC8245 326c609719bSwdenk 32711ccc33fSMarcel Ziswiler- 8xx CPU Options: (if using an MPC8xx CPU) 32866ca92a5Swdenk CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if 32966ca92a5Swdenk get_gclk_freq() cannot work 3305da627a4Swdenk e.g. if there is no 32KHz 3315da627a4Swdenk reference PIT/RTC clock 33266ca92a5Swdenk CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK 33366ca92a5Swdenk or XTAL/EXTAL) 334c609719bSwdenk 33566ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU): 3366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8xx_CPUCLK_MIN 3376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8xx_CPUCLK_MAX 33866ca92a5Swdenk CONFIG_8xx_CPUCLK_DEFAULT 33975d1ea7fSwdenk See doc/README.MPC866 34075d1ea7fSwdenk 3416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MEASURE_CPUCLK 34275d1ea7fSwdenk 34375d1ea7fSwdenk Define this to measure the actual CPU clock instead 34475d1ea7fSwdenk of relying on the correctness of the configured 34575d1ea7fSwdenk values. Mostly useful for board bringup to make sure 34675d1ea7fSwdenk the PLL is locked at the intended frequency. Note 34775d1ea7fSwdenk that this requires a (stable) reference clock (32 kHz 3486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD RTC clock or CONFIG_SYS_8XX_XIN) 34975d1ea7fSwdenk 350506f3918SHeiko Schocher CONFIG_SYS_DELAYED_ICACHE 351506f3918SHeiko Schocher 352506f3918SHeiko Schocher Define this option if you want to enable the 353506f3918SHeiko Schocher ICache only when Code runs from RAM. 354506f3918SHeiko Schocher 35566412c63SKumar Gala- 85xx CPU Options: 356ffd06e02SYork Sun CONFIG_SYS_PPC64 357ffd06e02SYork Sun 358ffd06e02SYork Sun Specifies that the core is a 64-bit PowerPC implementation (implements 359ffd06e02SYork Sun the "64" category of the Power ISA). This is necessary for ePAPR 360ffd06e02SYork Sun compliance, among other possible reasons. 361ffd06e02SYork Sun 36266412c63SKumar Gala CONFIG_SYS_FSL_TBCLK_DIV 36366412c63SKumar Gala 36466412c63SKumar Gala Defines the core time base clock divider ratio compared to the 36566412c63SKumar Gala system clock. On most PQ3 devices this is 8, on newer QorIQ 36666412c63SKumar Gala devices it can be 16 or 32. The ratio varies from SoC to Soc. 36766412c63SKumar Gala 3688f29084aSKumar Gala CONFIG_SYS_FSL_PCIE_COMPAT 3698f29084aSKumar Gala 3708f29084aSKumar Gala Defines the string to utilize when trying to match PCIe device 3718f29084aSKumar Gala tree nodes for the given platform. 3728f29084aSKumar Gala 373afa6b551SPrabhakar Kushwaha CONFIG_SYS_PPC_E500_DEBUG_TLB 374afa6b551SPrabhakar Kushwaha 375afa6b551SPrabhakar Kushwaha Enables a temporary TLB entry to be used during boot to work 376afa6b551SPrabhakar Kushwaha around limitations in e500v1 and e500v2 external debugger 377afa6b551SPrabhakar Kushwaha support. This reduces the portions of the boot code where 378afa6b551SPrabhakar Kushwaha breakpoints and single stepping do not work. The value of this 379afa6b551SPrabhakar Kushwaha symbol should be set to the TLB1 entry to be used for this 380afa6b551SPrabhakar Kushwaha purpose. 381afa6b551SPrabhakar Kushwaha 38233eee330SScott Wood CONFIG_SYS_FSL_ERRATUM_A004510 38333eee330SScott Wood 38433eee330SScott Wood Enables a workaround for erratum A004510. If set, 38533eee330SScott Wood then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and 38633eee330SScott Wood CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set. 38733eee330SScott Wood 38833eee330SScott Wood CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV 38933eee330SScott Wood CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional) 39033eee330SScott Wood 39133eee330SScott Wood Defines one or two SoC revisions (low 8 bits of SVR) 39233eee330SScott Wood for which the A004510 workaround should be applied. 39333eee330SScott Wood 39433eee330SScott Wood The rest of SVR is either not relevant to the decision 39533eee330SScott Wood of whether the erratum is present (e.g. p2040 versus 39633eee330SScott Wood p2041) or is implied by the build target, which controls 39733eee330SScott Wood whether CONFIG_SYS_FSL_ERRATUM_A004510 is set. 39833eee330SScott Wood 39933eee330SScott Wood See Freescale App Note 4493 for more information about 40033eee330SScott Wood this erratum. 40133eee330SScott Wood 40274fa22edSPrabhakar Kushwaha CONFIG_A003399_NOR_WORKAROUND 40374fa22edSPrabhakar Kushwaha Enables a workaround for IFC erratum A003399. It is only 40474fa22edSPrabhakar Kushwaha requred during NOR boot. 40574fa22edSPrabhakar Kushwaha 40633eee330SScott Wood CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY 40733eee330SScott Wood 40833eee330SScott Wood This is the value to write into CCSR offset 0x18600 40933eee330SScott Wood according to the A004510 workaround. 41033eee330SScott Wood 41164501c66SPriyanka Jain CONFIG_SYS_FSL_DSP_DDR_ADDR 41264501c66SPriyanka Jain This value denotes start offset of DDR memory which is 41364501c66SPriyanka Jain connected exclusively to the DSP cores. 41464501c66SPriyanka Jain 415765b0bdbSPriyanka Jain CONFIG_SYS_FSL_DSP_M2_RAM_ADDR 416765b0bdbSPriyanka Jain This value denotes start offset of M2 memory 417765b0bdbSPriyanka Jain which is directly connected to the DSP core. 418765b0bdbSPriyanka Jain 41964501c66SPriyanka Jain CONFIG_SYS_FSL_DSP_M3_RAM_ADDR 42064501c66SPriyanka Jain This value denotes start offset of M3 memory which is directly 42164501c66SPriyanka Jain connected to the DSP core. 42264501c66SPriyanka Jain 423765b0bdbSPriyanka Jain CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT 424765b0bdbSPriyanka Jain This value denotes start offset of DSP CCSR space. 425765b0bdbSPriyanka Jain 4266cb461b4SDaniel Schwierzeck- Generic CPU options: 4276cb461b4SDaniel Schwierzeck CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN 4286cb461b4SDaniel Schwierzeck 4296cb461b4SDaniel Schwierzeck Defines the endianess of the CPU. Implementation of those 4306cb461b4SDaniel Schwierzeck values is arch specific. 4316cb461b4SDaniel Schwierzeck 4325614e71bSYork Sun CONFIG_SYS_FSL_DDR 4335614e71bSYork Sun Freescale DDR driver in use. This type of DDR controller is 4345614e71bSYork Sun found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core 4355614e71bSYork Sun SoCs. 4365614e71bSYork Sun 4375614e71bSYork Sun CONFIG_SYS_FSL_DDR_ADDR 4385614e71bSYork Sun Freescale DDR memory-mapped register base. 4395614e71bSYork Sun 4405614e71bSYork Sun CONFIG_SYS_FSL_DDR_EMU 4415614e71bSYork Sun Specify emulator support for DDR. Some DDR features such as 4425614e71bSYork Sun deskew training are not available. 4435614e71bSYork Sun 4445614e71bSYork Sun CONFIG_SYS_FSL_DDRC_GEN1 4455614e71bSYork Sun Freescale DDR1 controller. 4465614e71bSYork Sun 4475614e71bSYork Sun CONFIG_SYS_FSL_DDRC_GEN2 4485614e71bSYork Sun Freescale DDR2 controller. 4495614e71bSYork Sun 4505614e71bSYork Sun CONFIG_SYS_FSL_DDRC_GEN3 4515614e71bSYork Sun Freescale DDR3 controller. 4525614e71bSYork Sun 453*9ac4ffbdSYork Sun CONFIG_SYS_FSL_DDRC_ARM_GEN3 454*9ac4ffbdSYork Sun Freescale DDR3 controller for ARM-based SoCs. 455*9ac4ffbdSYork Sun 4565614e71bSYork Sun CONFIG_SYS_FSL_DDR1 4575614e71bSYork Sun Board config to use DDR1. It can be enabled for SoCs with 4585614e71bSYork Sun Freescale DDR1 or DDR2 controllers, depending on the board 4595614e71bSYork Sun implemetation. 4605614e71bSYork Sun 4615614e71bSYork Sun CONFIG_SYS_FSL_DDR2 4625614e71bSYork Sun Board config to use DDR2. It can be eanbeld for SoCs with 4635614e71bSYork Sun Freescale DDR2 or DDR3 controllers, depending on the board 4645614e71bSYork Sun implementation. 4655614e71bSYork Sun 4665614e71bSYork Sun CONFIG_SYS_FSL_DDR3 4675614e71bSYork Sun Board config to use DDR3. It can be enabled for SoCs with 4685614e71bSYork Sun Freescale DDR3 controllers. 4695614e71bSYork Sun 4700b953ffcSMarkus Klotzbuecher- Intel Monahans options: 4716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO 4720b953ffcSMarkus Klotzbuecher 4730b953ffcSMarkus Klotzbuecher Defines the Monahans run mode to oscillator 4740b953ffcSMarkus Klotzbuecher ratio. Valid values are 8, 16, 24, 31. The core 4750b953ffcSMarkus Klotzbuecher frequency is this value multiplied by 13 MHz. 4760b953ffcSMarkus Klotzbuecher 4776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO 4780b953ffcSMarkus Klotzbuecher 4790b953ffcSMarkus Klotzbuecher Defines the Monahans turbo mode to oscillator 4800b953ffcSMarkus Klotzbuecher ratio. Valid values are 1 (default if undefined) and 4810b953ffcSMarkus Klotzbuecher 2. The core frequency as calculated above is multiplied 4820b953ffcSMarkus Klotzbuecher by this value. 4830b953ffcSMarkus Klotzbuecher 48492bbd64eSDaniel Schwierzeck- MIPS CPU options: 48592bbd64eSDaniel Schwierzeck CONFIG_SYS_INIT_SP_OFFSET 48692bbd64eSDaniel Schwierzeck 48792bbd64eSDaniel Schwierzeck Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack 48892bbd64eSDaniel Schwierzeck pointer. This is needed for the temporary stack before 48992bbd64eSDaniel Schwierzeck relocation. 49092bbd64eSDaniel Schwierzeck 49192bbd64eSDaniel Schwierzeck CONFIG_SYS_MIPS_CACHE_MODE 49292bbd64eSDaniel Schwierzeck 49392bbd64eSDaniel Schwierzeck Cache operation mode for the MIPS CPU. 49492bbd64eSDaniel Schwierzeck See also arch/mips/include/asm/mipsregs.h. 49592bbd64eSDaniel Schwierzeck Possible values are: 49692bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_NO_WA 49792bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_WA 49892bbd64eSDaniel Schwierzeck CONF_CM_UNCACHED 49992bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_NONCOHERENT 50092bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_CE 50192bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_COW 50292bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_CUW 50392bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_ACCELERATED 50492bbd64eSDaniel Schwierzeck 50592bbd64eSDaniel Schwierzeck CONFIG_SYS_XWAY_EBU_BOOTCFG 50692bbd64eSDaniel Schwierzeck 50792bbd64eSDaniel Schwierzeck Special option for Lantiq XWAY SoCs for booting from NOR flash. 50892bbd64eSDaniel Schwierzeck See also arch/mips/cpu/mips32/start.S. 50992bbd64eSDaniel Schwierzeck 51092bbd64eSDaniel Schwierzeck CONFIG_XWAY_SWAP_BYTES 51192bbd64eSDaniel Schwierzeck 51292bbd64eSDaniel Schwierzeck Enable compilation of tools/xway-swap-bytes needed for Lantiq 51392bbd64eSDaniel Schwierzeck XWAY SoCs for booting from NOR flash. The U-Boot image needs to 51492bbd64eSDaniel Schwierzeck be swapped if a flash programmer is used. 51592bbd64eSDaniel Schwierzeck 516b67d8816SChristian Riesch- ARM options: 517b67d8816SChristian Riesch CONFIG_SYS_EXCEPTION_VECTORS_HIGH 518b67d8816SChristian Riesch 519b67d8816SChristian Riesch Select high exception vectors of the ARM core, e.g., do not 520b67d8816SChristian Riesch clear the V bit of the c1 register of CP15. 521b67d8816SChristian Riesch 5225356f545SAneesh V CONFIG_SYS_THUMB_BUILD 5235356f545SAneesh V 5245356f545SAneesh V Use this flag to build U-Boot using the Thumb instruction 5255356f545SAneesh V set for ARM architectures. Thumb instruction set provides 5265356f545SAneesh V better code density. For ARM architectures that support 5275356f545SAneesh V Thumb2 this flag will result in Thumb2 code generated by 5285356f545SAneesh V GCC. 5295356f545SAneesh V 530c5d4752cSStephen Warren CONFIG_ARM_ERRATA_716044 5310678587fSStephen Warren CONFIG_ARM_ERRATA_742230 5320678587fSStephen Warren CONFIG_ARM_ERRATA_743622 5330678587fSStephen Warren CONFIG_ARM_ERRATA_751472 5340678587fSStephen Warren 5350678587fSStephen Warren If set, the workarounds for these ARM errata are applied early 5360678587fSStephen Warren during U-Boot startup. Note that these options force the 5370678587fSStephen Warren workarounds to be applied; no CPU-type/version detection 5380678587fSStephen Warren exists, unlike the similar options in the Linux kernel. Do not 5390678587fSStephen Warren set these options unless they apply! 5400678587fSStephen Warren 541795659dcSStephen Warren- CPU timer options: 542795659dcSStephen Warren CONFIG_SYS_HZ 543795659dcSStephen Warren 544795659dcSStephen Warren The frequency of the timer returned by get_timer(). 545795659dcSStephen Warren get_timer() must operate in milliseconds and this CONFIG 546795659dcSStephen Warren option must be set to 1000. 547795659dcSStephen Warren 5485da627a4Swdenk- Linux Kernel Interface: 549c609719bSwdenk CONFIG_CLOCKS_IN_MHZ 550c609719bSwdenk 551c609719bSwdenk U-Boot stores all clock information in Hz 552c609719bSwdenk internally. For binary compatibility with older Linux 553c609719bSwdenk kernels (which expect the clocks passed in the 554c609719bSwdenk bd_info data to be in MHz) the environment variable 555c609719bSwdenk "clocks_in_mhz" can be defined so that U-Boot 556c609719bSwdenk converts clock data to MHZ before passing it to the 557c609719bSwdenk Linux kernel. 558c609719bSwdenk When CONFIG_CLOCKS_IN_MHZ is defined, a definition of 559c609719bSwdenk "clocks_in_mhz=1" is automatically included in the 560c609719bSwdenk default environment. 561c609719bSwdenk 5625da627a4Swdenk CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only] 5635da627a4Swdenk 56411ccc33fSMarcel Ziswiler When transferring memsize parameter to linux, some versions 5655da627a4Swdenk expect it to be in bytes, others in MB. 5665da627a4Swdenk Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes. 5675da627a4Swdenk 568fec6d9eeSGerald Van Baren CONFIG_OF_LIBFDT 569f57f70aaSWolfgang Denk 570f57f70aaSWolfgang Denk New kernel versions are expecting firmware settings to be 571213bf8c8SGerald Van Baren passed using flattened device trees (based on open firmware 572213bf8c8SGerald Van Baren concepts). 573213bf8c8SGerald Van Baren 574213bf8c8SGerald Van Baren CONFIG_OF_LIBFDT 575213bf8c8SGerald Van Baren * New libfdt-based support 576213bf8c8SGerald Van Baren * Adds the "fdt" command 5773bb342fcSKim Phillips * The bootm command automatically updates the fdt 578213bf8c8SGerald Van Baren 579b55ae402SMarcel Ziswiler OF_CPU - The proper name of the cpus node (only required for 580b55ae402SMarcel Ziswiler MPC512X and MPC5xxx based boards). 581b55ae402SMarcel Ziswiler OF_SOC - The proper name of the soc node (only required for 582b55ae402SMarcel Ziswiler MPC512X and MPC5xxx based boards). 583f57f70aaSWolfgang Denk OF_TBCLK - The timebase frequency. 584c2871f03SKumar Gala OF_STDOUT_PATH - The path to the console device 585f57f70aaSWolfgang Denk 58611ccc33fSMarcel Ziswiler boards with QUICC Engines require OF_QE to set UCC MAC 58711ccc33fSMarcel Ziswiler addresses 5883bb342fcSKim Phillips 5894e253137SKumar Gala CONFIG_OF_BOARD_SETUP 5904e253137SKumar Gala 5914e253137SKumar Gala Board code has addition modification that it wants to make 5924e253137SKumar Gala to the flat device tree before handing it off to the kernel 5936705d81eSwdenk 5940267768eSMatthew McClintock CONFIG_OF_BOOT_CPU 5950267768eSMatthew McClintock 59611ccc33fSMarcel Ziswiler This define fills in the correct boot CPU in the boot 5970267768eSMatthew McClintock param header, the default value is zero if undefined. 5980267768eSMatthew McClintock 5993887c3fbSHeiko Schocher CONFIG_OF_IDE_FIXUP 6003887c3fbSHeiko Schocher 6013887c3fbSHeiko Schocher U-Boot can detect if an IDE device is present or not. 6023887c3fbSHeiko Schocher If not, and this new config option is activated, U-Boot 6033887c3fbSHeiko Schocher removes the ATA node from the DTS before booting Linux, 6043887c3fbSHeiko Schocher so the Linux IDE driver does not probe the device and 6053887c3fbSHeiko Schocher crash. This is needed for buggy hardware (uc101) where 6063887c3fbSHeiko Schocher no pull down resistor is connected to the signal IDE5V_DD7. 6073887c3fbSHeiko Schocher 6087eb29398SIgor Grinberg CONFIG_MACH_TYPE [relevant for ARM only][mandatory] 6097eb29398SIgor Grinberg 6107eb29398SIgor Grinberg This setting is mandatory for all boards that have only one 6117eb29398SIgor Grinberg machine type and must be used to specify the machine type 6127eb29398SIgor Grinberg number as it appears in the ARM machine registry 6137eb29398SIgor Grinberg (see http://www.arm.linux.org.uk/developer/machines/). 6147eb29398SIgor Grinberg Only boards that have multiple machine types supported 6157eb29398SIgor Grinberg in a single configuration file and the machine type is 6167eb29398SIgor Grinberg runtime discoverable, do not have to use this setting. 6177eb29398SIgor Grinberg 6180b2f4ecaSNiklaus Giger- vxWorks boot parameters: 6190b2f4ecaSNiklaus Giger 6200b2f4ecaSNiklaus Giger bootvx constructs a valid bootline using the following 6210b2f4ecaSNiklaus Giger environments variables: bootfile, ipaddr, serverip, hostname. 6220b2f4ecaSNiklaus Giger It loads the vxWorks image pointed bootfile. 6230b2f4ecaSNiklaus Giger 6240b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name 6250b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address 6260b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server 6270b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters 6280b2f4ecaSNiklaus Giger 6290b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_ADD_PARAMS 6300b2f4ecaSNiklaus Giger 6310b2f4ecaSNiklaus Giger Add it at the end of the bootline. E.g "u=username pw=secret" 6320b2f4ecaSNiklaus Giger 6330b2f4ecaSNiklaus Giger Note: If a "bootargs" environment is defined, it will overwride 6340b2f4ecaSNiklaus Giger the defaults discussed just above. 6350b2f4ecaSNiklaus Giger 6362c451f78SAneesh V- Cache Configuration: 6372c451f78SAneesh V CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot 6382c451f78SAneesh V CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot 6392c451f78SAneesh V CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot 6402c451f78SAneesh V 64193bc2193SAneesh V- Cache Configuration for ARM: 64293bc2193SAneesh V CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache 64393bc2193SAneesh V controller 64493bc2193SAneesh V CONFIG_SYS_PL310_BASE - Physical base address of PL310 64593bc2193SAneesh V controller register space 64693bc2193SAneesh V 6476705d81eSwdenk- Serial Ports: 64848d0192fSAndreas Engel CONFIG_PL010_SERIAL 6496705d81eSwdenk 6506705d81eSwdenk Define this if you want support for Amba PrimeCell PL010 UARTs. 6516705d81eSwdenk 65248d0192fSAndreas Engel CONFIG_PL011_SERIAL 6536705d81eSwdenk 6546705d81eSwdenk Define this if you want support for Amba PrimeCell PL011 UARTs. 6556705d81eSwdenk 6566705d81eSwdenk CONFIG_PL011_CLOCK 6576705d81eSwdenk 6586705d81eSwdenk If you have Amba PrimeCell PL011 UARTs, set this variable to 6596705d81eSwdenk the clock speed of the UARTs. 6606705d81eSwdenk 6616705d81eSwdenk CONFIG_PL01x_PORTS 6626705d81eSwdenk 6636705d81eSwdenk If you have Amba PrimeCell PL010 or PL011 UARTs on your board, 6646705d81eSwdenk define this to a list of base addresses for each (supported) 6656705d81eSwdenk port. See e.g. include/configs/versatile.h 6666705d81eSwdenk 667910f1ae3SJohn Rigby CONFIG_PL011_SERIAL_RLCR 668910f1ae3SJohn Rigby 669910f1ae3SJohn Rigby Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500) 670910f1ae3SJohn Rigby have separate receive and transmit line control registers. Set 671910f1ae3SJohn Rigby this variable to initialize the extra register. 672910f1ae3SJohn Rigby 673910f1ae3SJohn Rigby CONFIG_PL011_SERIAL_FLUSH_ON_INIT 674910f1ae3SJohn Rigby 675910f1ae3SJohn Rigby On some platforms (e.g. U8500) U-Boot is loaded by a second stage 676910f1ae3SJohn Rigby boot loader that has already initialized the UART. Define this 677910f1ae3SJohn Rigby variable to flush the UART at init time. 678910f1ae3SJohn Rigby 6796705d81eSwdenk 680c609719bSwdenk- Console Interface: 681c609719bSwdenk Depending on board, define exactly one serial port 682c609719bSwdenk (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2, 683c609719bSwdenk CONFIG_8xx_CONS_SCC1, ...), or switch off the serial 684c609719bSwdenk console by defining CONFIG_8xx_CONS_NONE 685c609719bSwdenk 686c609719bSwdenk Note: if CONFIG_8xx_CONS_NONE is defined, the serial 687c609719bSwdenk port routines must be defined elsewhere 688c609719bSwdenk (i.e. serial_init(), serial_getc(), ...) 689c609719bSwdenk 690c609719bSwdenk CONFIG_CFB_CONSOLE 691c609719bSwdenk Enables console device for a color framebuffer. Needs following 692c53043b7SWolfgang Denk defines (cf. smiLynxEM, i8042) 693c609719bSwdenk VIDEO_FB_LITTLE_ENDIAN graphic memory organisation 694c609719bSwdenk (default big endian) 695c609719bSwdenk VIDEO_HW_RECTFILL graphic chip supports 696c609719bSwdenk rectangle fill 697c609719bSwdenk (cf. smiLynxEM) 698c609719bSwdenk VIDEO_HW_BITBLT graphic chip supports 699c609719bSwdenk bit-blit (cf. smiLynxEM) 700c609719bSwdenk VIDEO_VISIBLE_COLS visible pixel columns 701c609719bSwdenk (cols=pitch) 702c609719bSwdenk VIDEO_VISIBLE_ROWS visible pixel rows 703c609719bSwdenk VIDEO_PIXEL_SIZE bytes per pixel 704c609719bSwdenk VIDEO_DATA_FORMAT graphic data format 705c609719bSwdenk (0-5, cf. cfb_console.c) 706c609719bSwdenk VIDEO_FB_ADRS framebuffer address 707c609719bSwdenk VIDEO_KBD_INIT_FCT keyboard int fct 708c609719bSwdenk (i.e. i8042_kbd_init()) 709c609719bSwdenk VIDEO_TSTC_FCT test char fct 710c609719bSwdenk (i.e. i8042_tstc) 711c609719bSwdenk VIDEO_GETC_FCT get char fct 712c609719bSwdenk (i.e. i8042_getc) 713c609719bSwdenk CONFIG_CONSOLE_CURSOR cursor drawing on/off 714c609719bSwdenk (requires blink timer 715c609719bSwdenk cf. i8042.c) 7166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c) 717c609719bSwdenk CONFIG_CONSOLE_TIME display time/date info in 718c609719bSwdenk upper right corner 719602ad3b3SJon Loeliger (requires CONFIG_CMD_DATE) 720c609719bSwdenk CONFIG_VIDEO_LOGO display Linux logo in 721c609719bSwdenk upper left corner 722a6c7ad2fSwdenk CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of 723a6c7ad2fSwdenk linux_logo.h for logo. 724a6c7ad2fSwdenk Requires CONFIG_VIDEO_LOGO 725c609719bSwdenk CONFIG_CONSOLE_EXTRA_INFO 72611ccc33fSMarcel Ziswiler additional board info beside 727c609719bSwdenk the logo 728c609719bSwdenk 72933a35bbbSPali Rohár When CONFIG_CFB_CONSOLE_ANSI is defined, console will support 73033a35bbbSPali Rohár a limited number of ANSI escape sequences (cursor control, 73133a35bbbSPali Rohár erase functions and limited graphics rendition control). 73233a35bbbSPali Rohár 733c609719bSwdenk When CONFIG_CFB_CONSOLE is defined, video console is 734c609719bSwdenk default i/o. Serial console can be forced with 735c609719bSwdenk environment 'console=serial'. 736c609719bSwdenk 737a3ad8e26Swdenk When CONFIG_SILENT_CONSOLE is defined, all console 738a3ad8e26Swdenk messages (by U-Boot and Linux!) can be silenced with 739a3ad8e26Swdenk the "silent" environment variable. See 740a3ad8e26Swdenk doc/README.silent for more information. 741a3ad8e26Swdenk 74245ae2546SHeiko Schocher CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default 74345ae2546SHeiko Schocher is 0x00. 74445ae2546SHeiko Schocher CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default 74545ae2546SHeiko Schocher is 0xa0. 74645ae2546SHeiko Schocher 747c609719bSwdenk- Console Baudrate: 748c609719bSwdenk CONFIG_BAUDRATE - in bps 749c609719bSwdenk Select one of the baudrates listed in 7506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BAUDRATE_TABLE, see below. 7516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale 752c609719bSwdenk 753c92fac91SHeiko Schocher- Console Rx buffer length 754c92fac91SHeiko Schocher With CONFIG_SYS_SMC_RXBUFLEN it is possible to define 755c92fac91SHeiko Schocher the maximum receive buffer length for the SMC. 7562b3f12c2SHeiko Schocher This option is actual only for 82xx and 8xx possible. 757c92fac91SHeiko Schocher If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE 758c92fac91SHeiko Schocher must be defined, to setup the maximum idle timeout for 759c92fac91SHeiko Schocher the SMC. 760c92fac91SHeiko Schocher 7619558b48aSGraeme Russ- Pre-Console Buffer: 7629558b48aSGraeme Russ Prior to the console being initialised (i.e. serial UART 7639558b48aSGraeme Russ initialised etc) all console output is silently discarded. 7649558b48aSGraeme Russ Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to 7659558b48aSGraeme Russ buffer any console messages prior to the console being 7669558b48aSGraeme Russ initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ 7679558b48aSGraeme Russ bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is 7689558b48aSGraeme Russ a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ 7699558b48aSGraeme Russ bytes are output before the console is initialised, the 7709558b48aSGraeme Russ earlier bytes are discarded. 7719558b48aSGraeme Russ 7729558b48aSGraeme Russ 'Sane' compilers will generate smaller code if 7739558b48aSGraeme Russ CONFIG_PRE_CON_BUF_SZ is a power of 2 7749558b48aSGraeme Russ 775046a37bdSSonny Rao- Safe printf() functions 776046a37bdSSonny Rao Define CONFIG_SYS_VSNPRINTF to compile in safe versions of 777046a37bdSSonny Rao the printf() functions. These are defined in 778046a37bdSSonny Rao include/vsprintf.h and include snprintf(), vsnprintf() and 779046a37bdSSonny Rao so on. Code size increase is approximately 300-500 bytes. 780046a37bdSSonny Rao If this option is not given then these functions will 781046a37bdSSonny Rao silently discard their buffer size argument - this means 782046a37bdSSonny Rao you are not getting any overflow checking in this case. 783046a37bdSSonny Rao 784c609719bSwdenk- Boot Delay: CONFIG_BOOTDELAY - in seconds 785c609719bSwdenk Delay before automatically booting the default image; 786c609719bSwdenk set to -1 to disable autoboot. 78793d7212fSJoe Hershberger set to -2 to autoboot with no delay and not check for abort 78893d7212fSJoe Hershberger (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined). 789c609719bSwdenk 790c609719bSwdenk See doc/README.autoboot for these options that 791c609719bSwdenk work with CONFIG_BOOTDELAY. None are required. 792c609719bSwdenk CONFIG_BOOT_RETRY_TIME 793c609719bSwdenk CONFIG_BOOT_RETRY_MIN 794c609719bSwdenk CONFIG_AUTOBOOT_KEYED 795c609719bSwdenk CONFIG_AUTOBOOT_PROMPT 796c609719bSwdenk CONFIG_AUTOBOOT_DELAY_STR 797c609719bSwdenk CONFIG_AUTOBOOT_STOP_STR 798c609719bSwdenk CONFIG_AUTOBOOT_DELAY_STR2 799c609719bSwdenk CONFIG_AUTOBOOT_STOP_STR2 800c609719bSwdenk CONFIG_ZERO_BOOTDELAY_CHECK 801c609719bSwdenk CONFIG_RESET_TO_RETRY 802c609719bSwdenk 803c609719bSwdenk- Autoboot Command: 804c609719bSwdenk CONFIG_BOOTCOMMAND 805c609719bSwdenk Only needed when CONFIG_BOOTDELAY is enabled; 806c609719bSwdenk define a command string that is automatically executed 807c609719bSwdenk when no character is read on the console interface 808c609719bSwdenk within "Boot Delay" after reset. 809c609719bSwdenk 810c609719bSwdenk CONFIG_BOOTARGS 811c609719bSwdenk This can be used to pass arguments to the bootm 812c609719bSwdenk command. The value of CONFIG_BOOTARGS goes into the 813c609719bSwdenk environment value "bootargs". 814c609719bSwdenk 815c609719bSwdenk CONFIG_RAMBOOT and CONFIG_NFSBOOT 816c609719bSwdenk The value of these goes into the environment as 817c609719bSwdenk "ramboot" and "nfsboot" respectively, and can be used 818c609719bSwdenk as a convenience, when switching between booting from 81911ccc33fSMarcel Ziswiler RAM and NFS. 820c609719bSwdenk 821c609719bSwdenk- Pre-Boot Commands: 822c609719bSwdenk CONFIG_PREBOOT 823c609719bSwdenk 824c609719bSwdenk When this option is #defined, the existence of the 825c609719bSwdenk environment variable "preboot" will be checked 826c609719bSwdenk immediately before starting the CONFIG_BOOTDELAY 827c609719bSwdenk countdown and/or running the auto-boot command resp. 828c609719bSwdenk entering interactive mode. 829c609719bSwdenk 830c609719bSwdenk This feature is especially useful when "preboot" is 831c609719bSwdenk automatically generated or modified. For an example 832c609719bSwdenk see the LWMON board specific code: here "preboot" is 833c609719bSwdenk modified when the user holds down a certain 834c609719bSwdenk combination of keys on the (special) keyboard when 835c609719bSwdenk booting the systems 836c609719bSwdenk 837c609719bSwdenk- Serial Download Echo Mode: 838c609719bSwdenk CONFIG_LOADS_ECHO 839c609719bSwdenk If defined to 1, all characters received during a 840c609719bSwdenk serial download (using the "loads" command) are 841c609719bSwdenk echoed back. This might be needed by some terminal 842c609719bSwdenk emulations (like "cu"), but may as well just take 843c609719bSwdenk time on others. This setting #define's the initial 844c609719bSwdenk value of the "loads_echo" environment variable. 845c609719bSwdenk 846602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined) 847c609719bSwdenk CONFIG_KGDB_BAUDRATE 848c609719bSwdenk Select one of the baudrates listed in 8496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BAUDRATE_TABLE, see below. 850c609719bSwdenk 851c609719bSwdenk- Monitor Functions: 852602ad3b3SJon Loeliger Monitor commands can be included or excluded 853602ad3b3SJon Loeliger from the build by using the #include files 854c6c621bdSStephen Warren <config_cmd_all.h> and #undef'ing unwanted 855c6c621bdSStephen Warren commands, or using <config_cmd_default.h> 856602ad3b3SJon Loeliger and augmenting with additional #define's 857602ad3b3SJon Loeliger for wanted commands. 858c609719bSwdenk 859602ad3b3SJon Loeliger The default command configuration includes all commands 860602ad3b3SJon Loeliger except those marked below with a "*". 861602ad3b3SJon Loeliger 862602ad3b3SJon Loeliger CONFIG_CMD_ASKENV * ask for env variable 863602ad3b3SJon Loeliger CONFIG_CMD_BDI bdinfo 864602ad3b3SJon Loeliger CONFIG_CMD_BEDBUG * Include BedBug Debugger 865602ad3b3SJon Loeliger CONFIG_CMD_BMP * BMP support 866602ad3b3SJon Loeliger CONFIG_CMD_BSP * Board specific commands 867602ad3b3SJon Loeliger CONFIG_CMD_BOOTD bootd 868602ad3b3SJon Loeliger CONFIG_CMD_CACHE * icache, dcache 869602ad3b3SJon Loeliger CONFIG_CMD_CONSOLE coninfo 870710b9938SMike Frysinger CONFIG_CMD_CRC32 * crc32 871602ad3b3SJon Loeliger CONFIG_CMD_DATE * support for RTC, date/time... 872602ad3b3SJon Loeliger CONFIG_CMD_DHCP * DHCP support 873602ad3b3SJon Loeliger CONFIG_CMD_DIAG * Diagnostics 874a7c93104SPeter Tyser CONFIG_CMD_DS4510 * ds4510 I2C gpio commands 875a7c93104SPeter Tyser CONFIG_CMD_DS4510_INFO * ds4510 I2C info command 876a7c93104SPeter Tyser CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd 877a7c93104SPeter Tyser CONFIG_CMD_DS4510_RST * ds4510 I2C rst command 878602ad3b3SJon Loeliger CONFIG_CMD_DTT * Digital Therm and Thermostat 879602ad3b3SJon Loeliger CONFIG_CMD_ECHO echo arguments 880246c6922SPeter Tyser CONFIG_CMD_EDITENV edit env variable 881602ad3b3SJon Loeliger CONFIG_CMD_EEPROM * EEPROM read/write support 882602ad3b3SJon Loeliger CONFIG_CMD_ELF * bootelf, bootvx 8835e2b3e0cSJoe Hershberger CONFIG_CMD_ENV_CALLBACK * display details about env callbacks 884fffad71bSJoe Hershberger CONFIG_CMD_ENV_FLAGS * display details about env flags 88588733e2cSAndrew Ruder CONFIG_CMD_ENV_EXISTS * check existence of env variable 8860c79cda0SMike Frysinger CONFIG_CMD_EXPORTENV * export the environment 88703e2ecf6SStephen Warren CONFIG_CMD_EXT2 * ext2 command support 88803e2ecf6SStephen Warren CONFIG_CMD_EXT4 * ext4 command support 889bdab39d3SMike Frysinger CONFIG_CMD_SAVEENV saveenv 890602ad3b3SJon Loeliger CONFIG_CMD_FDC * Floppy Disk Support 89103e2ecf6SStephen Warren CONFIG_CMD_FAT * FAT command support 892602ad3b3SJon Loeliger CONFIG_CMD_FDOS * Dos diskette Support 893602ad3b3SJon Loeliger CONFIG_CMD_FLASH flinfo, erase, protect 894602ad3b3SJon Loeliger CONFIG_CMD_FPGA FPGA device initialization support 8954d98b5c8SVincent Stehlé CONFIG_CMD_FUSE * Device fuse support 89653fdc7efSAnton Staaf CONFIG_CMD_GETTIME * Get time since boot 897a641b979SMike Frysinger CONFIG_CMD_GO * the 'go' command (exec code) 898a000b795SKim Phillips CONFIG_CMD_GREPENV * search environment 899bf36c5d5SSimon Glass CONFIG_CMD_HASH * calculate hash / digest 900602ad3b3SJon Loeliger CONFIG_CMD_HWFLOW * RTS/CTS hw flow control 901602ad3b3SJon Loeliger CONFIG_CMD_I2C * I2C serial bus support 902602ad3b3SJon Loeliger CONFIG_CMD_IDE * IDE harddisk support 903602ad3b3SJon Loeliger CONFIG_CMD_IMI iminfo 9048fdf1e0fSVipin Kumar CONFIG_CMD_IMLS List all images found in NOR flash 9054d98b5c8SVincent Stehlé CONFIG_CMD_IMLS_NAND * List all images found in NAND flash 906602ad3b3SJon Loeliger CONFIG_CMD_IMMAP * IMMR dump support 9070c79cda0SMike Frysinger CONFIG_CMD_IMPORTENV * import an environment 908c167cc02SJoe Hershberger CONFIG_CMD_INI * import data from an ini file into the env 909602ad3b3SJon Loeliger CONFIG_CMD_IRQ * irqinfo 910602ad3b3SJon Loeliger CONFIG_CMD_ITEST Integer/string test of 2 values 911602ad3b3SJon Loeliger CONFIG_CMD_JFFS2 * JFFS2 Support 912602ad3b3SJon Loeliger CONFIG_CMD_KGDB * kgdb 9134d98b5c8SVincent Stehlé CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader) 914d22c338eSJoe Hershberger CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration 915d22c338eSJoe Hershberger (169.254.*.*) 916602ad3b3SJon Loeliger CONFIG_CMD_LOADB loadb 917602ad3b3SJon Loeliger CONFIG_CMD_LOADS loads 9184d98b5c8SVincent Stehlé CONFIG_CMD_MD5SUM * print md5 message digest 91902c9aa1dSRobin Getz (requires CONFIG_CMD_MEMORY and CONFIG_MD5) 92015a33e49SSimon Glass CONFIG_CMD_MEMINFO * Display detailed memory information 921602ad3b3SJon Loeliger CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base, 922a2681707SWolfgang Denk loop, loopw 9234d98b5c8SVincent Stehlé CONFIG_CMD_MEMTEST * mtest 924602ad3b3SJon Loeliger CONFIG_CMD_MISC Misc functions like sleep etc 925602ad3b3SJon Loeliger CONFIG_CMD_MMC * MMC memory mapped support 926602ad3b3SJon Loeliger CONFIG_CMD_MII * MII utility commands 92768d7d651SStefan Roese CONFIG_CMD_MTDPARTS * MTD partition support 928602ad3b3SJon Loeliger CONFIG_CMD_NAND * NAND support 929602ad3b3SJon Loeliger CONFIG_CMD_NET bootp, tftpboot, rarpboot 9304d98b5c8SVincent Stehlé CONFIG_CMD_NFS NFS support 931e92739d3SPeter Tyser CONFIG_CMD_PCA953X * PCA953x I2C gpio commands 932e92739d3SPeter Tyser CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command 933602ad3b3SJon Loeliger CONFIG_CMD_PCI * pciinfo 934602ad3b3SJon Loeliger CONFIG_CMD_PCMCIA * PCMCIA support 935602ad3b3SJon Loeliger CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network 936602ad3b3SJon Loeliger host 937602ad3b3SJon Loeliger CONFIG_CMD_PORTIO * Port I/O 938ff048ea9SKenneth Waters CONFIG_CMD_READ * Read raw data from partition 939602ad3b3SJon Loeliger CONFIG_CMD_REGINFO * Register dump 940602ad3b3SJon Loeliger CONFIG_CMD_RUN run command in env variable 941d304931fSSimon Glass CONFIG_CMD_SANDBOX * sb command to access sandbox features 942602ad3b3SJon Loeliger CONFIG_CMD_SAVES * save S record dump 943602ad3b3SJon Loeliger CONFIG_CMD_SCSI * SCSI Support 944602ad3b3SJon Loeliger CONFIG_CMD_SDRAM * print SDRAM configuration information 945602ad3b3SJon Loeliger (requires CONFIG_CMD_I2C) 946602ad3b3SJon Loeliger CONFIG_CMD_SETGETDCR Support for DCR Register access 947602ad3b3SJon Loeliger (4xx only) 948f61ec45eSEric Nelson CONFIG_CMD_SF * Read/write/erase SPI NOR flash 9494d98b5c8SVincent Stehlé CONFIG_CMD_SHA1SUM * print sha1 memory digest 95002c9aa1dSRobin Getz (requires CONFIG_CMD_MEMORY) 9517d861d95SBob Liu CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x 95274de7aefSWolfgang Denk CONFIG_CMD_SOURCE "source" command Support 953602ad3b3SJon Loeliger CONFIG_CMD_SPI * SPI serial bus support 9547a83af07SLuca Ceresoli CONFIG_CMD_TFTPSRV * TFTP transfer in server mode 9551fb7cd49SSimon Glass CONFIG_CMD_TFTPPUT * TFTP put command (upload) 956da83bcd7SJoe Hershberger CONFIG_CMD_TIME * run command and report execution time (ARM specific) 957da83bcd7SJoe Hershberger CONFIG_CMD_TIMER * access to the system tick timer 958602ad3b3SJon Loeliger CONFIG_CMD_USB * USB support 959602ad3b3SJon Loeliger CONFIG_CMD_CDP * Cisco Discover Protocol support 960c8339f51SMarek Vasut CONFIG_CMD_MFSL * Microblaze FSL support 9614d98b5c8SVincent Stehlé CONFIG_CMD_XIMG Load part of Multi Image 962c609719bSwdenk 963c609719bSwdenk 964c609719bSwdenk EXAMPLE: If you want all functions except of network 965c609719bSwdenk support you can write: 966c609719bSwdenk 967602ad3b3SJon Loeliger #include "config_cmd_all.h" 968602ad3b3SJon Loeliger #undef CONFIG_CMD_NET 969c609719bSwdenk 970213bf8c8SGerald Van Baren Other Commands: 971213bf8c8SGerald Van Baren fdt (flattened device tree) command: CONFIG_OF_LIBFDT 972c609719bSwdenk 973c609719bSwdenk Note: Don't enable the "icache" and "dcache" commands 974602ad3b3SJon Loeliger (configuration option CONFIG_CMD_CACHE) unless you know 975c609719bSwdenk what you (and your U-Boot users) are doing. Data 976c609719bSwdenk cache cannot be enabled on systems like the 8xx or 977c609719bSwdenk 8260 (where accesses to the IMMR region must be 978c609719bSwdenk uncached), and it cannot be disabled on all other 979c609719bSwdenk systems where we (mis-) use the data cache to hold an 980c609719bSwdenk initial stack and some data. 981c609719bSwdenk 982c609719bSwdenk 983c609719bSwdenk XXX - this list needs to get updated! 984c609719bSwdenk 985a5ecbe62SWolfgang Denk- Regular expression support: 986a5ecbe62SWolfgang Denk CONFIG_REGEX 987a5ecbe62SWolfgang Denk If this variable is defined, U-Boot is linked against 988a5ecbe62SWolfgang Denk the SLRE (Super Light Regular Expression) library, 989a5ecbe62SWolfgang Denk which adds regex support to some commands, as for 990a5ecbe62SWolfgang Denk example "env grep" and "setexpr". 991a5ecbe62SWolfgang Denk 99245ba8077SSimon Glass- Device tree: 99345ba8077SSimon Glass CONFIG_OF_CONTROL 99445ba8077SSimon Glass If this variable is defined, U-Boot will use a device tree 99545ba8077SSimon Glass to configure its devices, instead of relying on statically 99645ba8077SSimon Glass compiled #defines in the board file. This option is 99745ba8077SSimon Glass experimental and only available on a few boards. The device 99845ba8077SSimon Glass tree is available in the global data as gd->fdt_blob. 99945ba8077SSimon Glass 10002c0f79e4SSimon Glass U-Boot needs to get its device tree from somewhere. This can 10012c0f79e4SSimon Glass be done using one of the two options below: 1002bbb0b128SSimon Glass 1003bbb0b128SSimon Glass CONFIG_OF_EMBED 1004bbb0b128SSimon Glass If this variable is defined, U-Boot will embed a device tree 1005bbb0b128SSimon Glass binary in its image. This device tree file should be in the 1006bbb0b128SSimon Glass board directory and called <soc>-<board>.dts. The binary file 1007bbb0b128SSimon Glass is then picked up in board_init_f() and made available through 1008bbb0b128SSimon Glass the global data structure as gd->blob. 100945ba8077SSimon Glass 10102c0f79e4SSimon Glass CONFIG_OF_SEPARATE 10112c0f79e4SSimon Glass If this variable is defined, U-Boot will build a device tree 10122c0f79e4SSimon Glass binary. It will be called u-boot.dtb. Architecture-specific 10132c0f79e4SSimon Glass code will locate it at run-time. Generally this works by: 10142c0f79e4SSimon Glass 10152c0f79e4SSimon Glass cat u-boot.bin u-boot.dtb >image.bin 10162c0f79e4SSimon Glass 10172c0f79e4SSimon Glass and in fact, U-Boot does this for you, creating a file called 10182c0f79e4SSimon Glass u-boot-dtb.bin which is useful in the common case. You can 10192c0f79e4SSimon Glass still use the individual files if you need something more 10202c0f79e4SSimon Glass exotic. 10212c0f79e4SSimon Glass 1022c609719bSwdenk- Watchdog: 1023c609719bSwdenk CONFIG_WATCHDOG 1024c609719bSwdenk If this variable is defined, it enables watchdog 10256abe6fb6SDetlev Zundel support for the SoC. There must be support in the SoC 10266abe6fb6SDetlev Zundel specific code for a watchdog. For the 8xx and 8260 10276abe6fb6SDetlev Zundel CPUs, the SIU Watchdog feature is enabled in the SYPCR 10286abe6fb6SDetlev Zundel register. When supported for a specific SoC is 10296abe6fb6SDetlev Zundel available, then no further board specific code should 10306abe6fb6SDetlev Zundel be needed to use it. 10316abe6fb6SDetlev Zundel 10326abe6fb6SDetlev Zundel CONFIG_HW_WATCHDOG 10336abe6fb6SDetlev Zundel When using a watchdog circuitry external to the used 10346abe6fb6SDetlev Zundel SoC, then define this variable and provide board 10356abe6fb6SDetlev Zundel specific code for the "hw_watchdog_reset" function. 1036c609719bSwdenk 1037c1551ea8Sstroese- U-Boot Version: 1038c1551ea8Sstroese CONFIG_VERSION_VARIABLE 1039c1551ea8Sstroese If this variable is defined, an environment variable 1040c1551ea8Sstroese named "ver" is created by U-Boot showing the U-Boot 1041c1551ea8Sstroese version as printed by the "version" command. 1042a1ea8e51SBenoît Thébaudeau Any change to this variable will be reverted at the 1043a1ea8e51SBenoît Thébaudeau next reset. 1044c1551ea8Sstroese 1045c609719bSwdenk- Real-Time Clock: 1046c609719bSwdenk 1047602ad3b3SJon Loeliger When CONFIG_CMD_DATE is selected, the type of the RTC 1048c609719bSwdenk has to be selected, too. Define exactly one of the 1049c609719bSwdenk following options: 1050c609719bSwdenk 1051c609719bSwdenk CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx 1052c609719bSwdenk CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC 10534e8b7544SFabio Estevam CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC 1054c609719bSwdenk CONFIG_RTC_MC146818 - use MC146818 RTC 10551cb8e980Swdenk CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC 1056c609719bSwdenk CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC 10577f70e853Swdenk CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC 10583bac3513Swdenk CONFIG_RTC_DS164x - use Dallas DS164x RTC 10599536dfccSTor Krill CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC 10604c0d4c3bSwdenk CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC 10616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337 106271d19f30SHeiko Schocher CONFIG_SYS_RV3029_TCR - enable trickle charger on 106371d19f30SHeiko Schocher RV3029 RTC. 1064c609719bSwdenk 1065b37c7e5eSwdenk Note that if the RTC uses I2C, then the I2C interface 1066b37c7e5eSwdenk must also be configured. See I2C Support, below. 1067b37c7e5eSwdenk 1068e92739d3SPeter Tyser- GPIO Support: 1069e92739d3SPeter Tyser CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO 1070e92739d3SPeter Tyser 10715dec49caSChris Packham The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of 10725dec49caSChris Packham chip-ngpio pairs that tell the PCA953X driver the number of 10735dec49caSChris Packham pins supported by a particular chip. 10745dec49caSChris Packham 1075e92739d3SPeter Tyser Note that if the GPIO device uses I2C, then the I2C interface 1076e92739d3SPeter Tyser must also be configured. See I2C Support, below. 1077e92739d3SPeter Tyser 1078c609719bSwdenk- Timestamp Support: 1079c609719bSwdenk 1080c609719bSwdenk When CONFIG_TIMESTAMP is selected, the timestamp 1081c609719bSwdenk (date and time) of an image is printed by image 1082c609719bSwdenk commands like bootm or iminfo. This option is 1083602ad3b3SJon Loeliger automatically enabled when you select CONFIG_CMD_DATE . 1084c609719bSwdenk 1085923c46f9SKarl O. Pinc- Partition Labels (disklabels) Supported: 1086923c46f9SKarl O. Pinc Zero or more of the following: 1087923c46f9SKarl O. Pinc CONFIG_MAC_PARTITION Apple's MacOS partition table. 1088923c46f9SKarl O. Pinc CONFIG_DOS_PARTITION MS Dos partition table, traditional on the 1089923c46f9SKarl O. Pinc Intel architecture, USB sticks, etc. 1090923c46f9SKarl O. Pinc CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc. 1091923c46f9SKarl O. Pinc CONFIG_EFI_PARTITION GPT partition table, common when EFI is the 1092923c46f9SKarl O. Pinc bootloader. Note 2TB partition limit; see 1093923c46f9SKarl O. Pinc disk/part_efi.c 1094923c46f9SKarl O. Pinc CONFIG_MTD_PARTITIONS Memory Technology Device partition table. 1095c609719bSwdenk 1096602ad3b3SJon Loeliger If IDE or SCSI support is enabled (CONFIG_CMD_IDE or 1097218ca724SWolfgang Denk CONFIG_CMD_SCSI) you must configure support for at 1098923c46f9SKarl O. Pinc least one non-MTD partition type as well. 1099c609719bSwdenk 1100c609719bSwdenk- IDE Reset method: 11014d13cbadSwdenk CONFIG_IDE_RESET_ROUTINE - this is defined in several 11024d13cbadSwdenk board configurations files but used nowhere! 1103c609719bSwdenk 11044d13cbadSwdenk CONFIG_IDE_RESET - is this is defined, IDE Reset will 11054d13cbadSwdenk be performed by calling the function 11064d13cbadSwdenk ide_set_reset(int reset) 11074d13cbadSwdenk which has to be defined in a board specific file 1108c609719bSwdenk 1109c609719bSwdenk- ATAPI Support: 1110c609719bSwdenk CONFIG_ATAPI 1111c609719bSwdenk 1112c609719bSwdenk Set this to enable ATAPI support. 1113c609719bSwdenk 1114c40b2956Swdenk- LBA48 Support 1115c40b2956Swdenk CONFIG_LBA48 1116c40b2956Swdenk 1117c40b2956Swdenk Set this to enable support for disks larger than 137GB 11184b142febSHeiko Schocher Also look at CONFIG_SYS_64BIT_LBA. 1119c40b2956Swdenk Whithout these , LBA48 support uses 32bit variables and will 'only' 1120c40b2956Swdenk support disks up to 2.1TB. 1121c40b2956Swdenk 11226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_64BIT_LBA: 1123c40b2956Swdenk When enabled, makes the IDE subsystem use 64bit sector addresses. 1124c40b2956Swdenk Default is 32bit. 1125c40b2956Swdenk 1126c609719bSwdenk- SCSI Support: 1127c609719bSwdenk At the moment only there is only support for the 1128c609719bSwdenk SYM53C8XX SCSI controller; define 1129c609719bSwdenk CONFIG_SCSI_SYM53C8XX to enable it. 1130c609719bSwdenk 11316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and 11326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID * 11336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the 1134c609719bSwdenk maximum numbers of LUNs, SCSI ID's and target 1135c609719bSwdenk devices. 11366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz) 1137c609719bSwdenk 1138447c031bSStefan Reinauer The environment variable 'scsidevs' is set to the number of 1139447c031bSStefan Reinauer SCSI devices found during the last scan. 1140447c031bSStefan Reinauer 1141c609719bSwdenk- NETWORK Support (PCI): 1142682011ffSwdenk CONFIG_E1000 1143ce5207e1SKyle Moffett Support for Intel 8254x/8257x gigabit chips. 1144ce5207e1SKyle Moffett 1145ce5207e1SKyle Moffett CONFIG_E1000_SPI 1146ce5207e1SKyle Moffett Utility code for direct access to the SPI bus on Intel 8257x. 1147ce5207e1SKyle Moffett This does not do anything useful unless you set at least one 1148ce5207e1SKyle Moffett of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC. 1149ce5207e1SKyle Moffett 1150ce5207e1SKyle Moffett CONFIG_E1000_SPI_GENERIC 1151ce5207e1SKyle Moffett Allow generic access to the SPI bus on the Intel 8257x, for 1152ce5207e1SKyle Moffett example with the "sspi" command. 1153ce5207e1SKyle Moffett 1154ce5207e1SKyle Moffett CONFIG_CMD_E1000 1155ce5207e1SKyle Moffett Management command for E1000 devices. When used on devices 1156ce5207e1SKyle Moffett with SPI support you can reprogram the EEPROM from U-Boot. 1157682011ffSwdenk 1158ac3315c2SAndre Schwarz CONFIG_E1000_FALLBACK_MAC 115911ccc33fSMarcel Ziswiler default MAC for empty EEPROM after production. 1160ac3315c2SAndre Schwarz 1161c609719bSwdenk CONFIG_EEPRO100 1162c609719bSwdenk Support for Intel 82557/82559/82559ER chips. 116311ccc33fSMarcel Ziswiler Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM 1164c609719bSwdenk write routine for first time initialisation. 1165c609719bSwdenk 1166c609719bSwdenk CONFIG_TULIP 1167c609719bSwdenk Support for Digital 2114x chips. 1168c609719bSwdenk Optional CONFIG_TULIP_SELECT_MEDIA for board specific 1169c609719bSwdenk modem chip initialisation (KS8761/QS6611). 1170c609719bSwdenk 1171c609719bSwdenk CONFIG_NATSEMI 1172c609719bSwdenk Support for National dp83815 chips. 1173c609719bSwdenk 1174c609719bSwdenk CONFIG_NS8382X 1175c609719bSwdenk Support for National dp8382[01] gigabit chips. 1176c609719bSwdenk 117745219c46Swdenk- NETWORK Support (other): 117845219c46Swdenk 1179c041e9d2SJens Scharsig CONFIG_DRIVER_AT91EMAC 1180c041e9d2SJens Scharsig Support for AT91RM9200 EMAC. 1181c041e9d2SJens Scharsig 1182c041e9d2SJens Scharsig CONFIG_RMII 1183c041e9d2SJens Scharsig Define this to use reduced MII inteface 1184c041e9d2SJens Scharsig 1185c041e9d2SJens Scharsig CONFIG_DRIVER_AT91EMAC_QUIET 1186c041e9d2SJens Scharsig If this defined, the driver is quiet. 1187c041e9d2SJens Scharsig The driver doen't show link status messages. 1188c041e9d2SJens Scharsig 1189efdd7319SRob Herring CONFIG_CALXEDA_XGMAC 1190efdd7319SRob Herring Support for the Calxeda XGMAC device 1191efdd7319SRob Herring 11923bb46d23SAshok CONFIG_LAN91C96 119345219c46Swdenk Support for SMSC's LAN91C96 chips. 119445219c46Swdenk 119545219c46Swdenk CONFIG_LAN91C96_BASE 119645219c46Swdenk Define this to hold the physical address 119745219c46Swdenk of the LAN91C96's I/O space 119845219c46Swdenk 119945219c46Swdenk CONFIG_LAN91C96_USE_32_BIT 120045219c46Swdenk Define this to enable 32 bit addressing 120145219c46Swdenk 12023bb46d23SAshok CONFIG_SMC91111 1203f39748aeSwdenk Support for SMSC's LAN91C111 chip 1204f39748aeSwdenk 1205f39748aeSwdenk CONFIG_SMC91111_BASE 1206f39748aeSwdenk Define this to hold the physical address 1207f39748aeSwdenk of the device (I/O space) 1208f39748aeSwdenk 1209f39748aeSwdenk CONFIG_SMC_USE_32_BIT 1210f39748aeSwdenk Define this if data bus is 32 bits 1211f39748aeSwdenk 1212f39748aeSwdenk CONFIG_SMC_USE_IOFUNCS 1213f39748aeSwdenk Define this to use i/o functions instead of macros 1214f39748aeSwdenk (some hardware wont work with macros) 1215f39748aeSwdenk 1216dc02badaSHeiko Schocher CONFIG_DRIVER_TI_EMAC 1217dc02badaSHeiko Schocher Support for davinci emac 1218dc02badaSHeiko Schocher 1219dc02badaSHeiko Schocher CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT 1220dc02badaSHeiko Schocher Define this if you have more then 3 PHYs. 1221dc02badaSHeiko Schocher 1222b3dbf4a5SMacpaul Lin CONFIG_FTGMAC100 1223b3dbf4a5SMacpaul Lin Support for Faraday's FTGMAC100 Gigabit SoC Ethernet 1224b3dbf4a5SMacpaul Lin 1225b3dbf4a5SMacpaul Lin CONFIG_FTGMAC100_EGIGA 1226b3dbf4a5SMacpaul Lin Define this to use GE link update with gigabit PHY. 1227b3dbf4a5SMacpaul Lin Define this if FTGMAC100 is connected to gigabit PHY. 1228b3dbf4a5SMacpaul Lin If your system has 10/100 PHY only, it might not occur 1229b3dbf4a5SMacpaul Lin wrong behavior. Because PHY usually return timeout or 1230b3dbf4a5SMacpaul Lin useless data when polling gigabit status and gigabit 1231b3dbf4a5SMacpaul Lin control registers. This behavior won't affect the 1232b3dbf4a5SMacpaul Lin correctnessof 10/100 link speed update. 1233b3dbf4a5SMacpaul Lin 1234c2fff331SMike Rapoport CONFIG_SMC911X 1235557b377dSJens Gehrlein Support for SMSC's LAN911x and LAN921x chips 1236557b377dSJens Gehrlein 1237c2fff331SMike Rapoport CONFIG_SMC911X_BASE 1238557b377dSJens Gehrlein Define this to hold the physical address 1239557b377dSJens Gehrlein of the device (I/O space) 1240557b377dSJens Gehrlein 1241c2fff331SMike Rapoport CONFIG_SMC911X_32_BIT 1242557b377dSJens Gehrlein Define this if data bus is 32 bits 1243557b377dSJens Gehrlein 1244c2fff331SMike Rapoport CONFIG_SMC911X_16_BIT 1245557b377dSJens Gehrlein Define this if data bus is 16 bits. If your processor 1246557b377dSJens Gehrlein automatically converts one 32 bit word to two 16 bit 1247c2fff331SMike Rapoport words you may also try CONFIG_SMC911X_32_BIT. 1248557b377dSJens Gehrlein 12493d0075faSYoshihiro Shimoda CONFIG_SH_ETHER 12503d0075faSYoshihiro Shimoda Support for Renesas on-chip Ethernet controller 12513d0075faSYoshihiro Shimoda 12523d0075faSYoshihiro Shimoda CONFIG_SH_ETHER_USE_PORT 12533d0075faSYoshihiro Shimoda Define the number of ports to be used 12543d0075faSYoshihiro Shimoda 12553d0075faSYoshihiro Shimoda CONFIG_SH_ETHER_PHY_ADDR 12563d0075faSYoshihiro Shimoda Define the ETH PHY's address 12573d0075faSYoshihiro Shimoda 125868260aabSYoshihiro Shimoda CONFIG_SH_ETHER_CACHE_WRITEBACK 125968260aabSYoshihiro Shimoda If this option is set, the driver enables cache flush. 126068260aabSYoshihiro Shimoda 12615e124724SVadim Bendebury- TPM Support: 126290899cc0SChe-liang Chiou CONFIG_TPM 126390899cc0SChe-liang Chiou Support TPM devices. 126490899cc0SChe-liang Chiou 12651b393db5STom Wai-Hong Tam CONFIG_TPM_TIS_I2C 12661b393db5STom Wai-Hong Tam Support for i2c bus TPM devices. Only one device 12671b393db5STom Wai-Hong Tam per system is supported at this time. 12681b393db5STom Wai-Hong Tam 12691b393db5STom Wai-Hong Tam CONFIG_TPM_TIS_I2C_BUS_NUMBER 12701b393db5STom Wai-Hong Tam Define the the i2c bus number for the TPM device 12711b393db5STom Wai-Hong Tam 12721b393db5STom Wai-Hong Tam CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS 12731b393db5STom Wai-Hong Tam Define the TPM's address on the i2c bus 12741b393db5STom Wai-Hong Tam 12751b393db5STom Wai-Hong Tam CONFIG_TPM_TIS_I2C_BURST_LIMITATION 12761b393db5STom Wai-Hong Tam Define the burst count bytes upper limit 12771b393db5STom Wai-Hong Tam 1278c01939c7SDirk Eibach CONFIG_TPM_ATMEL_TWI 1279c01939c7SDirk Eibach Support for Atmel TWI TPM device. Requires I2C support. 1280c01939c7SDirk Eibach 128190899cc0SChe-liang Chiou CONFIG_TPM_TIS_LPC 12825e124724SVadim Bendebury Support for generic parallel port TPM devices. Only one device 12835e124724SVadim Bendebury per system is supported at this time. 12845e124724SVadim Bendebury 12855e124724SVadim Bendebury CONFIG_TPM_TIS_BASE_ADDRESS 12865e124724SVadim Bendebury Base address where the generic TPM device is mapped 12875e124724SVadim Bendebury to. Contemporary x86 systems usually map it at 12885e124724SVadim Bendebury 0xfed40000. 12895e124724SVadim Bendebury 1290be6c1529SReinhard Pfau CONFIG_CMD_TPM 1291be6c1529SReinhard Pfau Add tpm monitor functions. 1292be6c1529SReinhard Pfau Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also 1293be6c1529SReinhard Pfau provides monitor access to authorized functions. 1294be6c1529SReinhard Pfau 1295be6c1529SReinhard Pfau CONFIG_TPM 1296be6c1529SReinhard Pfau Define this to enable the TPM support library which provides 1297be6c1529SReinhard Pfau functional interfaces to some TPM commands. 1298be6c1529SReinhard Pfau Requires support for a TPM device. 1299be6c1529SReinhard Pfau 1300be6c1529SReinhard Pfau CONFIG_TPM_AUTH_SESSIONS 1301be6c1529SReinhard Pfau Define this to enable authorized functions in the TPM library. 1302be6c1529SReinhard Pfau Requires CONFIG_TPM and CONFIG_SHA1. 1303be6c1529SReinhard Pfau 1304c609719bSwdenk- USB Support: 1305c609719bSwdenk At the moment only the UHCI host controller is 13064d13cbadSwdenk supported (PIP405, MIP405, MPC5200); define 1307c609719bSwdenk CONFIG_USB_UHCI to enable it. 1308c609719bSwdenk define CONFIG_USB_KEYBOARD to enable the USB Keyboard 130930d56faeSwdenk and define CONFIG_USB_STORAGE to enable the USB 1310c609719bSwdenk storage devices. 1311c609719bSwdenk Note: 1312c609719bSwdenk Supported are USB Keyboards and USB Floppy drives 1313c609719bSwdenk (TEAC FD-05PUB). 13144d13cbadSwdenk MPC5200 USB requires additional defines: 13154d13cbadSwdenk CONFIG_USB_CLOCK 13164d13cbadSwdenk for 528 MHz Clock: 0x0001bbbb 1317307ecb6dSEric Millbrandt CONFIG_PSC3_USB 1318307ecb6dSEric Millbrandt for USB on PSC3 13194d13cbadSwdenk CONFIG_USB_CONFIG 13204d13cbadSwdenk for differential drivers: 0x00001000 13214d13cbadSwdenk for single ended drivers: 0x00005000 1322307ecb6dSEric Millbrandt for differential drivers on PSC3: 0x00000100 1323307ecb6dSEric Millbrandt for single ended drivers on PSC3: 0x00004100 13246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_USB_EVENT_POLL 1325fdcfaa1bSZhang Wei May be defined to allow interrupt polling 1326fdcfaa1bSZhang Wei instead of using asynchronous interrupts 13274d13cbadSwdenk 13289ab4ce22SSimon Glass CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the 13299ab4ce22SSimon Glass txfilltuning field in the EHCI controller on reset. 13309ab4ce22SSimon Glass 1331aa155058SKuo-Jung Su CONFIG_USB_HUB_MIN_POWER_ON_DELAY defines the minimum 1332aa155058SKuo-Jung Su interval for usb hub power-on delay.(minimum 100msec) 1333aa155058SKuo-Jung Su 133416c8d5e7SWolfgang Denk- USB Device: 133516c8d5e7SWolfgang Denk Define the below if you wish to use the USB console. 133616c8d5e7SWolfgang Denk Once firmware is rebuilt from a serial console issue the 133716c8d5e7SWolfgang Denk command "setenv stdin usbtty; setenv stdout usbtty" and 133811ccc33fSMarcel Ziswiler attach your USB cable. The Unix command "dmesg" should print 133916c8d5e7SWolfgang Denk it has found a new device. The environment variable usbtty 134016c8d5e7SWolfgang Denk can be set to gserial or cdc_acm to enable your device to 134116c8d5e7SWolfgang Denk appear to a USB host as a Linux gserial device or a 134216c8d5e7SWolfgang Denk Common Device Class Abstract Control Model serial device. 134316c8d5e7SWolfgang Denk If you select usbtty = gserial you should be able to enumerate 134416c8d5e7SWolfgang Denk a Linux host by 134516c8d5e7SWolfgang Denk # modprobe usbserial vendor=0xVendorID product=0xProductID 134616c8d5e7SWolfgang Denk else if using cdc_acm, simply setting the environment 134716c8d5e7SWolfgang Denk variable usbtty to be cdc_acm should suffice. The following 134816c8d5e7SWolfgang Denk might be defined in YourBoardName.h 134916c8d5e7SWolfgang Denk 135016c8d5e7SWolfgang Denk CONFIG_USB_DEVICE 135116c8d5e7SWolfgang Denk Define this to build a UDC device 135216c8d5e7SWolfgang Denk 135316c8d5e7SWolfgang Denk CONFIG_USB_TTY 135416c8d5e7SWolfgang Denk Define this to have a tty type of device available to 135516c8d5e7SWolfgang Denk talk to the UDC device 135616c8d5e7SWolfgang Denk 1357f9da0f89SVipin KUMAR CONFIG_USBD_HS 1358f9da0f89SVipin KUMAR Define this to enable the high speed support for usb 1359f9da0f89SVipin KUMAR device and usbtty. If this feature is enabled, a routine 1360f9da0f89SVipin KUMAR int is_usbd_high_speed(void) 1361f9da0f89SVipin KUMAR also needs to be defined by the driver to dynamically poll 1362f9da0f89SVipin KUMAR whether the enumeration has succeded at high speed or full 1363f9da0f89SVipin KUMAR speed. 1364f9da0f89SVipin KUMAR 13656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_CONSOLE_IS_IN_ENV 136616c8d5e7SWolfgang Denk Define this if you want stdin, stdout &/or stderr to 136716c8d5e7SWolfgang Denk be set to usbtty. 136816c8d5e7SWolfgang Denk 136916c8d5e7SWolfgang Denk mpc8xx: 13706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_USB_EXTC_CLK 0xBLAH 137116c8d5e7SWolfgang Denk Derive USB clock from external clock "blah" 13726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_USB_EXTC_CLK 0x02 137316c8d5e7SWolfgang Denk 13746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_USB_BRG_CLK 0xBLAH 137516c8d5e7SWolfgang Denk Derive USB clock from brgclk 13766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_USB_BRG_CLK 0x04 137716c8d5e7SWolfgang Denk 137816c8d5e7SWolfgang Denk If you have a USB-IF assigned VendorID then you may wish to 137916c8d5e7SWolfgang Denk define your own vendor specific values either in BoardName.h 138016c8d5e7SWolfgang Denk or directly in usbd_vendor_info.h. If you don't define 138116c8d5e7SWolfgang Denk CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME, 138216c8d5e7SWolfgang Denk CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot 138316c8d5e7SWolfgang Denk should pretend to be a Linux device to it's target host. 138416c8d5e7SWolfgang Denk 138516c8d5e7SWolfgang Denk CONFIG_USBD_MANUFACTURER 138616c8d5e7SWolfgang Denk Define this string as the name of your company for 138716c8d5e7SWolfgang Denk - CONFIG_USBD_MANUFACTURER "my company" 138816c8d5e7SWolfgang Denk 138916c8d5e7SWolfgang Denk CONFIG_USBD_PRODUCT_NAME 139016c8d5e7SWolfgang Denk Define this string as the name of your product 139116c8d5e7SWolfgang Denk - CONFIG_USBD_PRODUCT_NAME "acme usb device" 139216c8d5e7SWolfgang Denk 139316c8d5e7SWolfgang Denk CONFIG_USBD_VENDORID 139416c8d5e7SWolfgang Denk Define this as your assigned Vendor ID from the USB 139516c8d5e7SWolfgang Denk Implementors Forum. This *must* be a genuine Vendor ID 139616c8d5e7SWolfgang Denk to avoid polluting the USB namespace. 139716c8d5e7SWolfgang Denk - CONFIG_USBD_VENDORID 0xFFFF 139816c8d5e7SWolfgang Denk 139916c8d5e7SWolfgang Denk CONFIG_USBD_PRODUCTID 140016c8d5e7SWolfgang Denk Define this as the unique Product ID 140116c8d5e7SWolfgang Denk for your device 140216c8d5e7SWolfgang Denk - CONFIG_USBD_PRODUCTID 0xFFFF 1403c609719bSwdenk 1404351e9b20SPrzemyslaw Marczak Some USB device drivers may need to check USB cable attachment. 1405351e9b20SPrzemyslaw Marczak In this case you can enable following config in BoardName.h: 1406351e9b20SPrzemyslaw Marczak CONFIG_USB_CABLE_CHECK 1407351e9b20SPrzemyslaw Marczak This enables function definition: 1408351e9b20SPrzemyslaw Marczak - usb_cable_connected() in include/usb.h 1409351e9b20SPrzemyslaw Marczak Implementation of this function is board-specific. 1410351e9b20SPrzemyslaw Marczak 1411d70a560fSIgor Grinberg- ULPI Layer Support: 1412d70a560fSIgor Grinberg The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via 1413d70a560fSIgor Grinberg the generic ULPI layer. The generic layer accesses the ULPI PHY 1414d70a560fSIgor Grinberg via the platform viewport, so you need both the genric layer and 1415d70a560fSIgor Grinberg the viewport enabled. Currently only Chipidea/ARC based 1416d70a560fSIgor Grinberg viewport is supported. 1417d70a560fSIgor Grinberg To enable the ULPI layer support, define CONFIG_USB_ULPI and 1418d70a560fSIgor Grinberg CONFIG_USB_ULPI_VIEWPORT in your board configuration file. 14196d365ea0SLucas Stach If your ULPI phy needs a different reference clock than the 14206d365ea0SLucas Stach standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to 14216d365ea0SLucas Stach the appropriate value in Hz. 1422c609719bSwdenk 1423c609719bSwdenk- MMC Support: 1424c609719bSwdenk The MMC controller on the Intel PXA is supported. To 1425c609719bSwdenk enable this define CONFIG_MMC. The MMC can be 1426c609719bSwdenk accessed from the boot prompt by mapping the device 1427c609719bSwdenk to physical memory similar to flash. Command line is 1428602ad3b3SJon Loeliger enabled with CONFIG_CMD_MMC. The MMC driver also works with 1429602ad3b3SJon Loeliger the FAT fs. This is enabled with CONFIG_CMD_FAT. 1430c609719bSwdenk 1431afb35666SYoshihiro Shimoda CONFIG_SH_MMCIF 1432afb35666SYoshihiro Shimoda Support for Renesas on-chip MMCIF controller 1433afb35666SYoshihiro Shimoda 1434afb35666SYoshihiro Shimoda CONFIG_SH_MMCIF_ADDR 1435afb35666SYoshihiro Shimoda Define the base address of MMCIF registers 1436afb35666SYoshihiro Shimoda 1437afb35666SYoshihiro Shimoda CONFIG_SH_MMCIF_CLK 1438afb35666SYoshihiro Shimoda Define the clock frequency for MMCIF 1439afb35666SYoshihiro Shimoda 1440b3ba6e94STom Rini- USB Device Firmware Update (DFU) class support: 1441b3ba6e94STom Rini CONFIG_DFU_FUNCTION 1442b3ba6e94STom Rini This enables the USB portion of the DFU USB class 1443b3ba6e94STom Rini 1444b3ba6e94STom Rini CONFIG_CMD_DFU 1445b3ba6e94STom Rini This enables the command "dfu" which is used to have 1446b3ba6e94STom Rini U-Boot create a DFU class device via USB. This command 1447b3ba6e94STom Rini requires that the "dfu_alt_info" environment variable be 1448b3ba6e94STom Rini set and define the alt settings to expose to the host. 1449b3ba6e94STom Rini 1450b3ba6e94STom Rini CONFIG_DFU_MMC 1451b3ba6e94STom Rini This enables support for exposing (e)MMC devices via DFU. 1452b3ba6e94STom Rini 1453c6631764SPantelis Antoniou CONFIG_DFU_NAND 1454c6631764SPantelis Antoniou This enables support for exposing NAND devices via DFU. 1455c6631764SPantelis Antoniou 1456a9479f04SAfzal Mohammed CONFIG_DFU_RAM 1457a9479f04SAfzal Mohammed This enables support for exposing RAM via DFU. 1458a9479f04SAfzal Mohammed Note: DFU spec refer to non-volatile memory usage, but 1459a9479f04SAfzal Mohammed allow usages beyond the scope of spec - here RAM usage, 1460a9479f04SAfzal Mohammed one that would help mostly the developer. 1461a9479f04SAfzal Mohammed 1462e7e75c70SHeiko Schocher CONFIG_SYS_DFU_DATA_BUF_SIZE 1463e7e75c70SHeiko Schocher Dfu transfer uses a buffer before writing data to the 1464e7e75c70SHeiko Schocher raw storage device. Make the size (in bytes) of this buffer 1465e7e75c70SHeiko Schocher configurable. The size of this buffer is also configurable 1466e7e75c70SHeiko Schocher through the "dfu_bufsiz" environment variable. 1467e7e75c70SHeiko Schocher 1468ea2453d5SPantelis Antoniou CONFIG_SYS_DFU_MAX_FILE_SIZE 1469ea2453d5SPantelis Antoniou When updating files rather than the raw storage device, 1470ea2453d5SPantelis Antoniou we use a static buffer to copy the file into and then write 1471ea2453d5SPantelis Antoniou the buffer once we've been given the whole file. Define 1472ea2453d5SPantelis Antoniou this to the maximum filesize (in bytes) for the buffer. 1473ea2453d5SPantelis Antoniou Default is 4 MiB if undefined. 1474ea2453d5SPantelis Antoniou 14756705d81eSwdenk- Journaling Flash filesystem support: 14766705d81eSwdenk CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE, 14776705d81eSwdenk CONFIG_JFFS2_NAND_DEV 14786705d81eSwdenk Define these for a default partition on a NAND device 14796705d81eSwdenk 14806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS2_FIRST_SECTOR, 14816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS 14826705d81eSwdenk Define these for a default partition on a NOR device 14836705d81eSwdenk 14846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS_CUSTOM_PART 14856705d81eSwdenk Define this to create an own partition. You have to provide a 14866705d81eSwdenk function struct part_info* jffs2_part_info(int part_num) 14876705d81eSwdenk 14886705d81eSwdenk If you define only one JFFS2 partition you may also want to 14896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_JFFS_SINGLE_PART 1 14906705d81eSwdenk to disable the command chpart. This is the default when you 14916705d81eSwdenk have not defined a custom partition 14926705d81eSwdenk 1493c30a15e5SDonggeun Kim- FAT(File Allocation Table) filesystem write function support: 1494c30a15e5SDonggeun Kim CONFIG_FAT_WRITE 1495656f4c65SDonggeun Kim 1496656f4c65SDonggeun Kim Define this to enable support for saving memory data as a 1497656f4c65SDonggeun Kim file in FAT formatted partition. 1498656f4c65SDonggeun Kim 1499656f4c65SDonggeun Kim This will also enable the command "fatwrite" enabling the 1500656f4c65SDonggeun Kim user to write files to FAT. 1501c30a15e5SDonggeun Kim 150284cd9327SGabe BlackCBFS (Coreboot Filesystem) support 150384cd9327SGabe Black CONFIG_CMD_CBFS 150484cd9327SGabe Black 150584cd9327SGabe Black Define this to enable support for reading from a Coreboot 150684cd9327SGabe Black filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls 150784cd9327SGabe Black and cbfsload. 150884cd9327SGabe Black 1509c609719bSwdenk- Keyboard Support: 1510c609719bSwdenk CONFIG_ISA_KEYBOARD 1511c609719bSwdenk 1512c609719bSwdenk Define this to enable standard (PC-Style) keyboard 1513c609719bSwdenk support 1514c609719bSwdenk 1515c609719bSwdenk CONFIG_I8042_KBD 1516c609719bSwdenk Standard PC keyboard driver with US (is default) and 1517c609719bSwdenk GERMAN key layout (switch via environment 'keymap=de') support. 1518c609719bSwdenk Export function i8042_kbd_init, i8042_tstc and i8042_getc 1519c609719bSwdenk for cfb_console. Supports cursor blinking. 1520c609719bSwdenk 1521713cb680SHung-ying Tyan CONFIG_CROS_EC_KEYB 1522713cb680SHung-ying Tyan Enables a Chrome OS keyboard using the CROS_EC interface. 1523713cb680SHung-ying Tyan This uses CROS_EC to communicate with a second microcontroller 1524713cb680SHung-ying Tyan which provides key scans on request. 1525713cb680SHung-ying Tyan 1526c609719bSwdenk- Video support: 1527c609719bSwdenk CONFIG_VIDEO 1528c609719bSwdenk 1529c609719bSwdenk Define this to enable video support (for output to 1530c609719bSwdenk video). 1531c609719bSwdenk 1532c609719bSwdenk CONFIG_VIDEO_CT69000 1533c609719bSwdenk 1534c609719bSwdenk Enable Chips & Technologies 69000 Video chip 1535c609719bSwdenk 1536c609719bSwdenk CONFIG_VIDEO_SMI_LYNXEM 1537eeb1b77bSwdenk Enable Silicon Motion SMI 712/710/810 Video chip. The 1538eeb1b77bSwdenk video output is selected via environment 'videoout' 1539eeb1b77bSwdenk (1 = LCD and 2 = CRT). If videoout is undefined, CRT is 1540eeb1b77bSwdenk assumed. 1541c609719bSwdenk 1542eeb1b77bSwdenk For the CT69000 and SMI_LYNXEM drivers, videomode is 154311ccc33fSMarcel Ziswiler selected via environment 'videomode'. Two different ways 1544eeb1b77bSwdenk are possible: 1545eeb1b77bSwdenk - "videomode=num" 'num' is a standard LiLo mode numbers. 1546eeb1b77bSwdenk Following standard modes are supported (* is default): 1547eeb1b77bSwdenk 1548eeb1b77bSwdenk Colors 640x480 800x600 1024x768 1152x864 1280x1024 1549eeb1b77bSwdenk -------------+--------------------------------------------- 1550eeb1b77bSwdenk 8 bits | 0x301* 0x303 0x305 0x161 0x307 1551eeb1b77bSwdenk 15 bits | 0x310 0x313 0x316 0x162 0x319 1552eeb1b77bSwdenk 16 bits | 0x311 0x314 0x317 0x163 0x31A 1553eeb1b77bSwdenk 24 bits | 0x312 0x315 0x318 ? 0x31B 1554eeb1b77bSwdenk -------------+--------------------------------------------- 1555c609719bSwdenk (i.e. setenv videomode 317; saveenv; reset;) 1556c609719bSwdenk 1557eeb1b77bSwdenk - "videomode=bootargs" all the video parameters are parsed 15587817cb20SMarcel Ziswiler from the bootargs. (See drivers/video/videomodes.c) 1559eeb1b77bSwdenk 1560eeb1b77bSwdenk 1561a6c7ad2fSwdenk CONFIG_VIDEO_SED13806 1562a6c7ad2fSwdenk Enable Epson SED13806 driver. This driver supports 8bpp 1563a6c7ad2fSwdenk and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP 1564a6c7ad2fSwdenk or CONFIG_VIDEO_SED13806_16BPP 1565a6c7ad2fSwdenk 15667d3053fbSTimur Tabi CONFIG_FSL_DIU_FB 15677d3053fbSTimur Tabi Enable the Freescale DIU video driver. Reference boards for 15687d3053fbSTimur Tabi SOCs that have a DIU should define this macro to enable DIU 15697d3053fbSTimur Tabi support, and should also define these other macros: 15707d3053fbSTimur Tabi 15717d3053fbSTimur Tabi CONFIG_SYS_DIU_ADDR 15727d3053fbSTimur Tabi CONFIG_VIDEO 15737d3053fbSTimur Tabi CONFIG_CMD_BMP 15747d3053fbSTimur Tabi CONFIG_CFB_CONSOLE 15757d3053fbSTimur Tabi CONFIG_VIDEO_SW_CURSOR 15767d3053fbSTimur Tabi CONFIG_VGA_AS_SINGLE_DEVICE 15777d3053fbSTimur Tabi CONFIG_VIDEO_LOGO 15787d3053fbSTimur Tabi CONFIG_VIDEO_BMP_LOGO 15797d3053fbSTimur Tabi 1580ba8e76bdSTimur Tabi The DIU driver will look for the 'video-mode' environment 1581ba8e76bdSTimur Tabi variable, and if defined, enable the DIU as a console during 1582ba8e76bdSTimur Tabi boot. See the documentation file README.video for a 1583ba8e76bdSTimur Tabi description of this variable. 15847d3053fbSTimur Tabi 1585058d59b0SSimon Glass CONFIG_VIDEO_VGA 1586058d59b0SSimon Glass 1587058d59b0SSimon Glass Enable the VGA video / BIOS for x86. The alternative if you 1588058d59b0SSimon Glass are using coreboot is to use the coreboot frame buffer 1589058d59b0SSimon Glass driver. 1590058d59b0SSimon Glass 1591058d59b0SSimon Glass 1592682011ffSwdenk- Keyboard Support: 1593682011ffSwdenk CONFIG_KEYBOARD 1594682011ffSwdenk 1595682011ffSwdenk Define this to enable a custom keyboard support. 1596682011ffSwdenk This simply calls drv_keyboard_init() which must be 1597682011ffSwdenk defined in your board-specific files. 1598682011ffSwdenk The only board using this so far is RBC823. 1599a6c7ad2fSwdenk 1600c609719bSwdenk- LCD Support: CONFIG_LCD 1601c609719bSwdenk 1602c609719bSwdenk Define this to enable LCD support (for output to LCD 1603c609719bSwdenk display); also select one of the supported displays 1604c609719bSwdenk by defining one of these: 1605c609719bSwdenk 160639cf4804SStelian Pop CONFIG_ATMEL_LCD: 160739cf4804SStelian Pop 160839cf4804SStelian Pop HITACHI TX09D70VM1CCA, 3.5", 240x320. 160939cf4804SStelian Pop 1610fd3103bbSwdenk CONFIG_NEC_NL6448AC33: 1611c609719bSwdenk 1612fd3103bbSwdenk NEC NL6448AC33-18. Active, color, single scan. 1613c609719bSwdenk 1614fd3103bbSwdenk CONFIG_NEC_NL6448BC20 1615c609719bSwdenk 1616fd3103bbSwdenk NEC NL6448BC20-08. 6.5", 640x480. 1617fd3103bbSwdenk Active, color, single scan. 1618fd3103bbSwdenk 1619fd3103bbSwdenk CONFIG_NEC_NL6448BC33_54 1620fd3103bbSwdenk 1621fd3103bbSwdenk NEC NL6448BC33-54. 10.4", 640x480. 1622c609719bSwdenk Active, color, single scan. 1623c609719bSwdenk 1624c609719bSwdenk CONFIG_SHARP_16x9 1625c609719bSwdenk 1626c609719bSwdenk Sharp 320x240. Active, color, single scan. 1627c609719bSwdenk It isn't 16x9, and I am not sure what it is. 1628c609719bSwdenk 1629c609719bSwdenk CONFIG_SHARP_LQ64D341 1630c609719bSwdenk 1631c609719bSwdenk Sharp LQ64D341 display, 640x480. 1632c609719bSwdenk Active, color, single scan. 1633c609719bSwdenk 1634c609719bSwdenk CONFIG_HLD1045 1635c609719bSwdenk 1636c609719bSwdenk HLD1045 display, 640x480. 1637c609719bSwdenk Active, color, single scan. 1638c609719bSwdenk 1639c609719bSwdenk CONFIG_OPTREX_BW 1640c609719bSwdenk 1641c609719bSwdenk Optrex CBL50840-2 NF-FW 99 22 M5 1642c609719bSwdenk or 1643c609719bSwdenk Hitachi LMG6912RPFC-00T 1644c609719bSwdenk or 1645c609719bSwdenk Hitachi SP14Q002 1646c609719bSwdenk 1647c609719bSwdenk 320x240. Black & white. 1648c609719bSwdenk 1649c609719bSwdenk Normally display is black on white background; define 16506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_WHITE_ON_BLACK to get it inverted. 1651c609719bSwdenk 1652676d319eSSimon Glass CONFIG_LCD_ALIGNMENT 1653676d319eSSimon Glass 1654676d319eSSimon Glass Normally the LCD is page-aligned (tyically 4KB). If this is 1655676d319eSSimon Glass defined then the LCD will be aligned to this value instead. 1656676d319eSSimon Glass For ARM it is sometimes useful to use MMU_SECTION_SIZE 1657676d319eSSimon Glass here, since it is cheaper to change data cache settings on 1658676d319eSSimon Glass a per-section basis. 1659676d319eSSimon Glass 16600d89efefSSimon Glass CONFIG_CONSOLE_SCROLL_LINES 16610d89efefSSimon Glass 16620d89efefSSimon Glass When the console need to be scrolled, this is the number of 16630d89efefSSimon Glass lines to scroll by. It defaults to 1. Increasing this makes 16640d89efefSSimon Glass the console jump but can help speed up operation when scrolling 16650d89efefSSimon Glass is slow. 1666676d319eSSimon Glass 166745d7f525STom Wai-Hong Tam CONFIG_LCD_BMP_RLE8 166845d7f525STom Wai-Hong Tam 166945d7f525STom Wai-Hong Tam Support drawing of RLE8-compressed bitmaps on the LCD. 167045d7f525STom Wai-Hong Tam 1671735987c5STom Wai-Hong Tam CONFIG_I2C_EDID 1672735987c5STom Wai-Hong Tam 1673735987c5STom Wai-Hong Tam Enables an 'i2c edid' command which can read EDID 1674735987c5STom Wai-Hong Tam information over I2C from an attached LCD display. 1675735987c5STom Wai-Hong Tam 16767152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN 1677d791b1dcSwdenk 1678d791b1dcSwdenk If this option is set, the environment is checked for 1679d791b1dcSwdenk a variable "splashimage". If found, the usual display 1680d791b1dcSwdenk of logo, copyright and system information on the LCD 1681e94d2cd9Swdenk is suppressed and the BMP image at the address 1682d791b1dcSwdenk specified in "splashimage" is loaded instead. The 1683d791b1dcSwdenk console is redirected to the "nulldev", too. This 1684d791b1dcSwdenk allows for a "silent" boot where a splash screen is 1685d791b1dcSwdenk loaded very quickly after power-on. 1686d791b1dcSwdenk 1687c0880485SNikita Kiryanov CONFIG_SPLASHIMAGE_GUARD 1688c0880485SNikita Kiryanov 1689c0880485SNikita Kiryanov If this option is set, then U-Boot will prevent the environment 1690c0880485SNikita Kiryanov variable "splashimage" from being set to a problematic address 1691c0880485SNikita Kiryanov (see README.displaying-bmps and README.arm-unaligned-accesses). 1692c0880485SNikita Kiryanov This option is useful for targets where, due to alignment 1693c0880485SNikita Kiryanov restrictions, an improperly aligned BMP image will cause a data 1694c0880485SNikita Kiryanov abort. If you think you will not have problems with unaligned 1695c0880485SNikita Kiryanov accesses (for example because your toolchain prevents them) 1696c0880485SNikita Kiryanov there is no need to set this option. 1697c0880485SNikita Kiryanov 16981ca298ceSMatthias Weisser CONFIG_SPLASH_SCREEN_ALIGN 16991ca298ceSMatthias Weisser 17001ca298ceSMatthias Weisser If this option is set the splash image can be freely positioned 17011ca298ceSMatthias Weisser on the screen. Environment variable "splashpos" specifies the 17021ca298ceSMatthias Weisser position as "x,y". If a positive number is given it is used as 17031ca298ceSMatthias Weisser number of pixel from left/top. If a negative number is given it 17041ca298ceSMatthias Weisser is used as number of pixel from right/bottom. You can also 17051ca298ceSMatthias Weisser specify 'm' for centering the image. 17061ca298ceSMatthias Weisser 17071ca298ceSMatthias Weisser Example: 17081ca298ceSMatthias Weisser setenv splashpos m,m 17091ca298ceSMatthias Weisser => image at center of screen 17101ca298ceSMatthias Weisser 17111ca298ceSMatthias Weisser setenv splashpos 30,20 17121ca298ceSMatthias Weisser => image at x = 30 and y = 20 17131ca298ceSMatthias Weisser 17141ca298ceSMatthias Weisser setenv splashpos -10,m 17151ca298ceSMatthias Weisser => vertically centered image 17161ca298ceSMatthias Weisser at x = dspWidth - bmpWidth - 9 17171ca298ceSMatthias Weisser 171898f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP 171998f4a3dfSStefan Roese 172098f4a3dfSStefan Roese If this option is set, additionally to standard BMP 172198f4a3dfSStefan Roese images, gzipped BMP images can be displayed via the 172298f4a3dfSStefan Roese splashscreen support or the bmp command. 172398f4a3dfSStefan Roese 1724d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8 1725d5011762SAnatolij Gustschin 1726d5011762SAnatolij Gustschin If this option is set, 8-bit RLE compressed BMP images 1727d5011762SAnatolij Gustschin can be displayed via the splashscreen support or the 1728d5011762SAnatolij Gustschin bmp command. 1729d5011762SAnatolij Gustschin 1730f2b96dfbSLei Wen- Do compresssing for memory range: 1731f2b96dfbSLei Wen CONFIG_CMD_ZIP 1732f2b96dfbSLei Wen 1733f2b96dfbSLei Wen If this option is set, it would use zlib deflate method 1734f2b96dfbSLei Wen to compress the specified memory at its best effort. 1735f2b96dfbSLei Wen 1736c29fdfc1Swdenk- Compression support: 17378ef70478SKees Cook CONFIG_GZIP 17388ef70478SKees Cook 17398ef70478SKees Cook Enabled by default to support gzip compressed images. 17408ef70478SKees Cook 1741c29fdfc1Swdenk CONFIG_BZIP2 1742c29fdfc1Swdenk 1743c29fdfc1Swdenk If this option is set, support for bzip2 compressed 1744c29fdfc1Swdenk images is included. If not, only uncompressed and gzip 1745c29fdfc1Swdenk compressed images are supported. 1746c29fdfc1Swdenk 1747c29fdfc1Swdenk NOTE: the bzip2 algorithm requires a lot of RAM, so 17486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should 1749c29fdfc1Swdenk be at least 4MB. 1750d791b1dcSwdenk 1751fc9c1727SLuigi 'Comio' Mantellini CONFIG_LZMA 1752fc9c1727SLuigi 'Comio' Mantellini 1753fc9c1727SLuigi 'Comio' Mantellini If this option is set, support for lzma compressed 1754fc9c1727SLuigi 'Comio' Mantellini images is included. 1755fc9c1727SLuigi 'Comio' Mantellini 1756fc9c1727SLuigi 'Comio' Mantellini Note: The LZMA algorithm adds between 2 and 4KB of code and it 1757fc9c1727SLuigi 'Comio' Mantellini requires an amount of dynamic memory that is given by the 1758fc9c1727SLuigi 'Comio' Mantellini formula: 1759fc9c1727SLuigi 'Comio' Mantellini 1760fc9c1727SLuigi 'Comio' Mantellini (1846 + 768 << (lc + lp)) * sizeof(uint16) 1761fc9c1727SLuigi 'Comio' Mantellini 1762fc9c1727SLuigi 'Comio' Mantellini Where lc and lp stand for, respectively, Literal context bits 1763fc9c1727SLuigi 'Comio' Mantellini and Literal pos bits. 1764fc9c1727SLuigi 'Comio' Mantellini 1765fc9c1727SLuigi 'Comio' Mantellini This value is upper-bounded by 14MB in the worst case. Anyway, 1766fc9c1727SLuigi 'Comio' Mantellini for a ~4MB large kernel image, we have lc=3 and lp=0 for a 1767fc9c1727SLuigi 'Comio' Mantellini total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is 1768fc9c1727SLuigi 'Comio' Mantellini a very small buffer. 1769fc9c1727SLuigi 'Comio' Mantellini 1770fc9c1727SLuigi 'Comio' Mantellini Use the lzmainfo tool to determinate the lc and lp values and 1771fc9c1727SLuigi 'Comio' Mantellini then calculate the amount of needed dynamic memory (ensuring 17726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD the appropriate CONFIG_SYS_MALLOC_LEN value). 1773fc9c1727SLuigi 'Comio' Mantellini 17748ef70478SKees Cook CONFIG_LZO 17758ef70478SKees Cook 17768ef70478SKees Cook If this option is set, support for LZO compressed images 17778ef70478SKees Cook is included. 17788ef70478SKees Cook 177917ea1177Swdenk- MII/PHY support: 178017ea1177Swdenk CONFIG_PHY_ADDR 178117ea1177Swdenk 178217ea1177Swdenk The address of PHY on MII bus. 178317ea1177Swdenk 178417ea1177Swdenk CONFIG_PHY_CLOCK_FREQ (ppc4xx) 178517ea1177Swdenk 178617ea1177Swdenk The clock frequency of the MII bus 178717ea1177Swdenk 178817ea1177Swdenk CONFIG_PHY_GIGE 178917ea1177Swdenk 179017ea1177Swdenk If this option is set, support for speed/duplex 179111ccc33fSMarcel Ziswiler detection of gigabit PHY is included. 179217ea1177Swdenk 179317ea1177Swdenk CONFIG_PHY_RESET_DELAY 179417ea1177Swdenk 179517ea1177Swdenk Some PHY like Intel LXT971A need extra delay after 179617ea1177Swdenk reset before any MII register access is possible. 179717ea1177Swdenk For such PHY, set this option to the usec delay 179817ea1177Swdenk required. (minimum 300usec for LXT971A) 179917ea1177Swdenk 180017ea1177Swdenk CONFIG_PHY_CMD_DELAY (ppc4xx) 180117ea1177Swdenk 180217ea1177Swdenk Some PHY like Intel LXT971A need extra delay after 180317ea1177Swdenk command issued before MII status register can be read 180417ea1177Swdenk 1805c609719bSwdenk- Ethernet address: 1806c609719bSwdenk CONFIG_ETHADDR 1807c68a05feSrichardretanubun CONFIG_ETH1ADDR 1808c609719bSwdenk CONFIG_ETH2ADDR 1809c609719bSwdenk CONFIG_ETH3ADDR 1810c68a05feSrichardretanubun CONFIG_ETH4ADDR 1811c68a05feSrichardretanubun CONFIG_ETH5ADDR 1812c609719bSwdenk 181311ccc33fSMarcel Ziswiler Define a default value for Ethernet address to use 181411ccc33fSMarcel Ziswiler for the respective Ethernet interface, in case this 1815c609719bSwdenk is not determined automatically. 1816c609719bSwdenk 1817c609719bSwdenk- IP address: 1818c609719bSwdenk CONFIG_IPADDR 1819c609719bSwdenk 1820c609719bSwdenk Define a default value for the IP address to use for 182111ccc33fSMarcel Ziswiler the default Ethernet interface, in case this is not 1822c609719bSwdenk determined through e.g. bootp. 18231ebcd654SWolfgang Denk (Environment variable "ipaddr") 1824c609719bSwdenk 1825c609719bSwdenk- Server IP address: 1826c609719bSwdenk CONFIG_SERVERIP 1827c609719bSwdenk 1828c609719bSwdenk Defines a default value for the IP address of a TFTP 1829c609719bSwdenk server to contact when using the "tftboot" command. 18301ebcd654SWolfgang Denk (Environment variable "serverip") 1831c609719bSwdenk 183297cfe861SRobin Getz CONFIG_KEEP_SERVERADDR 183397cfe861SRobin Getz 183497cfe861SRobin Getz Keeps the server's MAC address, in the env 'serveraddr' 183597cfe861SRobin Getz for passing to bootargs (like Linux's netconsole option) 183697cfe861SRobin Getz 18371ebcd654SWolfgang Denk- Gateway IP address: 18381ebcd654SWolfgang Denk CONFIG_GATEWAYIP 18391ebcd654SWolfgang Denk 18401ebcd654SWolfgang Denk Defines a default value for the IP address of the 18411ebcd654SWolfgang Denk default router where packets to other networks are 18421ebcd654SWolfgang Denk sent to. 18431ebcd654SWolfgang Denk (Environment variable "gatewayip") 18441ebcd654SWolfgang Denk 18451ebcd654SWolfgang Denk- Subnet mask: 18461ebcd654SWolfgang Denk CONFIG_NETMASK 18471ebcd654SWolfgang Denk 18481ebcd654SWolfgang Denk Defines a default value for the subnet mask (or 18491ebcd654SWolfgang Denk routing prefix) which is used to determine if an IP 18501ebcd654SWolfgang Denk address belongs to the local subnet or needs to be 18511ebcd654SWolfgang Denk forwarded through a router. 18521ebcd654SWolfgang Denk (Environment variable "netmask") 18531ebcd654SWolfgang Denk 185453a5c424SDavid Updegraff- Multicast TFTP Mode: 185553a5c424SDavid Updegraff CONFIG_MCAST_TFTP 185653a5c424SDavid Updegraff 185753a5c424SDavid Updegraff Defines whether you want to support multicast TFTP as per 185853a5c424SDavid Updegraff rfc-2090; for example to work with atftp. Lets lots of targets 185911ccc33fSMarcel Ziswiler tftp down the same boot image concurrently. Note: the Ethernet 186053a5c424SDavid Updegraff driver in use must provide a function: mcast() to join/leave a 186153a5c424SDavid Updegraff multicast group. 186253a5c424SDavid Updegraff 1863c609719bSwdenk- BOOTP Recovery Mode: 1864c609719bSwdenk CONFIG_BOOTP_RANDOM_DELAY 1865c609719bSwdenk 1866c609719bSwdenk If you have many targets in a network that try to 1867c609719bSwdenk boot using BOOTP, you may want to avoid that all 1868c609719bSwdenk systems send out BOOTP requests at precisely the same 1869c609719bSwdenk moment (which would happen for instance at recovery 1870c609719bSwdenk from a power failure, when all systems will try to 1871c609719bSwdenk boot, thus flooding the BOOTP server. Defining 1872c609719bSwdenk CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be 1873c609719bSwdenk inserted before sending out BOOTP requests. The 18746c33c785SWolfgang Denk following delays are inserted then: 1875c609719bSwdenk 1876c609719bSwdenk 1st BOOTP request: delay 0 ... 1 sec 1877c609719bSwdenk 2nd BOOTP request: delay 0 ... 2 sec 1878c609719bSwdenk 3rd BOOTP request: delay 0 ... 4 sec 1879c609719bSwdenk 4th and following 1880c609719bSwdenk BOOTP requests: delay 0 ... 8 sec 1881c609719bSwdenk 1882fe389a82Sstroese- DHCP Advanced Options: 18831fe80d79SJon Loeliger You can fine tune the DHCP functionality by defining 18841fe80d79SJon Loeliger CONFIG_BOOTP_* symbols: 1885fe389a82Sstroese 18861fe80d79SJon Loeliger CONFIG_BOOTP_SUBNETMASK 18871fe80d79SJon Loeliger CONFIG_BOOTP_GATEWAY 18881fe80d79SJon Loeliger CONFIG_BOOTP_HOSTNAME 18891fe80d79SJon Loeliger CONFIG_BOOTP_NISDOMAIN 18901fe80d79SJon Loeliger CONFIG_BOOTP_BOOTPATH 18911fe80d79SJon Loeliger CONFIG_BOOTP_BOOTFILESIZE 18921fe80d79SJon Loeliger CONFIG_BOOTP_DNS 18931fe80d79SJon Loeliger CONFIG_BOOTP_DNS2 18941fe80d79SJon Loeliger CONFIG_BOOTP_SEND_HOSTNAME 18951fe80d79SJon Loeliger CONFIG_BOOTP_NTPSERVER 18961fe80d79SJon Loeliger CONFIG_BOOTP_TIMEOFFSET 18971fe80d79SJon Loeliger CONFIG_BOOTP_VENDOREX 18982c00e099SJoe Hershberger CONFIG_BOOTP_MAY_FAIL 1899fe389a82Sstroese 19005d110f0aSWilson Callan CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip 19015d110f0aSWilson Callan environment variable, not the BOOTP server. 1902fe389a82Sstroese 19032c00e099SJoe Hershberger CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found 19042c00e099SJoe Hershberger after the configured retry count, the call will fail 19052c00e099SJoe Hershberger instead of starting over. This can be used to fail over 19062c00e099SJoe Hershberger to Link-local IP address configuration if the DHCP server 19072c00e099SJoe Hershberger is not available. 19082c00e099SJoe Hershberger 1909fe389a82Sstroese CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS 1910fe389a82Sstroese serverip from a DHCP server, it is possible that more 1911fe389a82Sstroese than one DNS serverip is offered to the client. 1912fe389a82Sstroese If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS 1913fe389a82Sstroese serverip will be stored in the additional environment 1914fe389a82Sstroese variable "dnsip2". The first DNS serverip is always 1915fe389a82Sstroese stored in the variable "dnsip", when CONFIG_BOOTP_DNS 19161fe80d79SJon Loeliger is defined. 1917fe389a82Sstroese 1918fe389a82Sstroese CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable 1919fe389a82Sstroese to do a dynamic update of a DNS server. To do this, they 1920fe389a82Sstroese need the hostname of the DHCP requester. 19215d110f0aSWilson Callan If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content 19221fe80d79SJon Loeliger of the "hostname" environment variable is passed as 19231fe80d79SJon Loeliger option 12 to the DHCP server. 1924fe389a82Sstroese 1925d9a2f416SAras Vaichas CONFIG_BOOTP_DHCP_REQUEST_DELAY 1926d9a2f416SAras Vaichas 1927d9a2f416SAras Vaichas A 32bit value in microseconds for a delay between 1928d9a2f416SAras Vaichas receiving a "DHCP Offer" and sending the "DHCP Request". 1929d9a2f416SAras Vaichas This fixes a problem with certain DHCP servers that don't 1930d9a2f416SAras Vaichas respond 100% of the time to a "DHCP request". E.g. On an 1931d9a2f416SAras Vaichas AT91RM9200 processor running at 180MHz, this delay needed 1932d9a2f416SAras Vaichas to be *at least* 15,000 usec before a Windows Server 2003 1933d9a2f416SAras Vaichas DHCP server would reply 100% of the time. I recommend at 1934d9a2f416SAras Vaichas least 50,000 usec to be safe. The alternative is to hope 1935d9a2f416SAras Vaichas that one of the retries will be successful but note that 1936d9a2f416SAras Vaichas the DHCP timeout and retry process takes a longer than 1937d9a2f416SAras Vaichas this delay. 1938d9a2f416SAras Vaichas 1939d22c338eSJoe Hershberger - Link-local IP address negotiation: 1940d22c338eSJoe Hershberger Negotiate with other link-local clients on the local network 1941d22c338eSJoe Hershberger for an address that doesn't require explicit configuration. 1942d22c338eSJoe Hershberger This is especially useful if a DHCP server cannot be guaranteed 1943d22c338eSJoe Hershberger to exist in all environments that the device must operate. 1944d22c338eSJoe Hershberger 1945d22c338eSJoe Hershberger See doc/README.link-local for more information. 1946d22c338eSJoe Hershberger 1947a3d991bdSwdenk - CDP Options: 1948a3d991bdSwdenk CONFIG_CDP_DEVICE_ID 1949a3d991bdSwdenk 1950a3d991bdSwdenk The device id used in CDP trigger frames. 1951a3d991bdSwdenk 1952a3d991bdSwdenk CONFIG_CDP_DEVICE_ID_PREFIX 1953a3d991bdSwdenk 1954a3d991bdSwdenk A two character string which is prefixed to the MAC address 1955a3d991bdSwdenk of the device. 1956a3d991bdSwdenk 1957a3d991bdSwdenk CONFIG_CDP_PORT_ID 1958a3d991bdSwdenk 1959a3d991bdSwdenk A printf format string which contains the ascii name of 1960a3d991bdSwdenk the port. Normally is set to "eth%d" which sets 196111ccc33fSMarcel Ziswiler eth0 for the first Ethernet, eth1 for the second etc. 1962a3d991bdSwdenk 1963a3d991bdSwdenk CONFIG_CDP_CAPABILITIES 1964a3d991bdSwdenk 1965a3d991bdSwdenk A 32bit integer which indicates the device capabilities; 1966a3d991bdSwdenk 0x00000010 for a normal host which does not forwards. 1967a3d991bdSwdenk 1968a3d991bdSwdenk CONFIG_CDP_VERSION 1969a3d991bdSwdenk 1970a3d991bdSwdenk An ascii string containing the version of the software. 1971a3d991bdSwdenk 1972a3d991bdSwdenk CONFIG_CDP_PLATFORM 1973a3d991bdSwdenk 1974a3d991bdSwdenk An ascii string containing the name of the platform. 1975a3d991bdSwdenk 1976a3d991bdSwdenk CONFIG_CDP_TRIGGER 1977a3d991bdSwdenk 1978a3d991bdSwdenk A 32bit integer sent on the trigger. 1979a3d991bdSwdenk 1980a3d991bdSwdenk CONFIG_CDP_POWER_CONSUMPTION 1981a3d991bdSwdenk 1982a3d991bdSwdenk A 16bit integer containing the power consumption of the 1983a3d991bdSwdenk device in .1 of milliwatts. 1984a3d991bdSwdenk 1985a3d991bdSwdenk CONFIG_CDP_APPLIANCE_VLAN_TYPE 1986a3d991bdSwdenk 1987a3d991bdSwdenk A byte containing the id of the VLAN. 1988a3d991bdSwdenk 1989c609719bSwdenk- Status LED: CONFIG_STATUS_LED 1990c609719bSwdenk 1991c609719bSwdenk Several configurations allow to display the current 1992c609719bSwdenk status using a LED. For instance, the LED will blink 1993c609719bSwdenk fast while running U-Boot code, stop blinking as 1994c609719bSwdenk soon as a reply to a BOOTP request was received, and 1995c609719bSwdenk start blinking slow once the Linux kernel is running 1996c609719bSwdenk (supported by a status LED driver in the Linux 1997c609719bSwdenk kernel). Defining CONFIG_STATUS_LED enables this 1998c609719bSwdenk feature in U-Boot. 1999c609719bSwdenk 2000c609719bSwdenk- CAN Support: CONFIG_CAN_DRIVER 2001c609719bSwdenk 2002c609719bSwdenk Defining CONFIG_CAN_DRIVER enables CAN driver support 2003c609719bSwdenk on those systems that support this (optional) 2004c609719bSwdenk feature, like the TQM8xxL modules. 2005c609719bSwdenk 20063f4978c7SHeiko Schocher- I2C Support: CONFIG_SYS_I2C 2007c609719bSwdenk 20083f4978c7SHeiko Schocher This enable the NEW i2c subsystem, and will allow you to use 20093f4978c7SHeiko Schocher i2c commands at the u-boot command line (as long as you set 20103f4978c7SHeiko Schocher CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c 20113f4978c7SHeiko Schocher based realtime clock chips or other i2c devices. See 20123f4978c7SHeiko Schocher common/cmd_i2c.c for a description of the command line 20133f4978c7SHeiko Schocher interface. 20143f4978c7SHeiko Schocher 20153f4978c7SHeiko Schocher ported i2c driver to the new framework: 2016ea818dbbSHeiko Schocher - drivers/i2c/soft_i2c.c: 2017ea818dbbSHeiko Schocher - activate first bus with CONFIG_SYS_I2C_SOFT define 2018ea818dbbSHeiko Schocher CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE 2019ea818dbbSHeiko Schocher for defining speed and slave address 2020ea818dbbSHeiko Schocher - activate second bus with I2C_SOFT_DECLARATIONS2 define 2021ea818dbbSHeiko Schocher CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2 2022ea818dbbSHeiko Schocher for defining speed and slave address 2023ea818dbbSHeiko Schocher - activate third bus with I2C_SOFT_DECLARATIONS3 define 2024ea818dbbSHeiko Schocher CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3 2025ea818dbbSHeiko Schocher for defining speed and slave address 2026ea818dbbSHeiko Schocher - activate fourth bus with I2C_SOFT_DECLARATIONS4 define 2027ea818dbbSHeiko Schocher CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4 2028ea818dbbSHeiko Schocher for defining speed and slave address 20293f4978c7SHeiko Schocher 203000f792e0SHeiko Schocher - drivers/i2c/fsl_i2c.c: 203100f792e0SHeiko Schocher - activate i2c driver with CONFIG_SYS_I2C_FSL 203200f792e0SHeiko Schocher define CONFIG_SYS_FSL_I2C_OFFSET for setting the register 203300f792e0SHeiko Schocher offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and 203400f792e0SHeiko Schocher CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first 203500f792e0SHeiko Schocher bus. 203600f792e0SHeiko Schocher - If your board supports a second fsl i2c bus, define 203700f792e0SHeiko Schocher CONFIG_SYS_FSL_I2C2_OFFSET for the register offset 203800f792e0SHeiko Schocher CONFIG_SYS_FSL_I2C2_SPEED for the speed and 203900f792e0SHeiko Schocher CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the 204000f792e0SHeiko Schocher second bus. 204100f792e0SHeiko Schocher 20421f2ba722SSimon Glass - drivers/i2c/tegra_i2c.c: 20431f2ba722SSimon Glass - activate this driver with CONFIG_SYS_I2C_TEGRA 20441f2ba722SSimon Glass - This driver adds 4 i2c buses with a fix speed from 20451f2ba722SSimon Glass 100000 and the slave addr 0! 20461f2ba722SSimon Glass 2047880540deSDirk Eibach - drivers/i2c/ppc4xx_i2c.c 2048880540deSDirk Eibach - activate this driver with CONFIG_SYS_I2C_PPC4XX 2049880540deSDirk Eibach - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0 2050880540deSDirk Eibach - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1 2051880540deSDirk Eibach 2052fac96408Strem - drivers/i2c/i2c_mxc.c 2053fac96408Strem - activate this driver with CONFIG_SYS_I2C_MXC 2054fac96408Strem - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED 2055fac96408Strem - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE 2056fac96408Strem - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED 2057fac96408Strem - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE 2058fac96408Strem - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED 2059fac96408Strem - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE 2060fac96408Strem If thoses defines are not set, default value is 100000 2061fac96408Strem for speed, and 0 for slave. 2062fac96408Strem 20631086bfa9SNobuhiro Iwamatsu - drivers/i2c/rcar_i2c.c: 20641086bfa9SNobuhiro Iwamatsu - activate this driver with CONFIG_SYS_I2C_RCAR 20651086bfa9SNobuhiro Iwamatsu - This driver adds 4 i2c buses 20661086bfa9SNobuhiro Iwamatsu 20671086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0 20681086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0 20691086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1 20701086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1 20711086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2 20721086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2 20731086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3 20741086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3 20751086bfa9SNobuhiro Iwamatsu - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses 20761086bfa9SNobuhiro Iwamatsu 20772035d77dSNobuhiro Iwamatsu - drivers/i2c/sh_i2c.c: 20782035d77dSNobuhiro Iwamatsu - activate this driver with CONFIG_SYS_I2C_SH 20792035d77dSNobuhiro Iwamatsu - This driver adds from 2 to 5 i2c buses 20802035d77dSNobuhiro Iwamatsu 20812035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0 20822035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0 20832035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1 20842035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1 20852035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2 20862035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2 20872035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3 20882035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3 20892035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4 20902035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4 20912035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5 20922035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5 20932035d77dSNobuhiro Iwamatsu - CONFIF_SYS_I2C_SH_NUM_CONTROLLERS for nummber of i2c buses 20942035d77dSNobuhiro Iwamatsu 20956789e84eSHeiko Schocher - drivers/i2c/omap24xx_i2c.c 20966789e84eSHeiko Schocher - activate this driver with CONFIG_SYS_I2C_OMAP24XX 20976789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0 20986789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0 20996789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1 21006789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1 21016789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2 21026789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2 21036789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3 21046789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3 21056789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4 21066789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4 21076789e84eSHeiko Schocher 21080bdffe71SHeiko Schocher - drivers/i2c/zynq_i2c.c 21090bdffe71SHeiko Schocher - activate this driver with CONFIG_SYS_I2C_ZYNQ 21100bdffe71SHeiko Schocher - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting 21110bdffe71SHeiko Schocher - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr 21120bdffe71SHeiko Schocher 21133f4978c7SHeiko Schocher additional defines: 21143f4978c7SHeiko Schocher 21153f4978c7SHeiko Schocher CONFIG_SYS_NUM_I2C_BUSES 21163f4978c7SHeiko Schocher Hold the number of i2c busses you want to use. If you 21173f4978c7SHeiko Schocher don't use/have i2c muxes on your i2c bus, this 21183f4978c7SHeiko Schocher is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can 21193f4978c7SHeiko Schocher omit this define. 21203f4978c7SHeiko Schocher 21213f4978c7SHeiko Schocher CONFIG_SYS_I2C_DIRECT_BUS 21223f4978c7SHeiko Schocher define this, if you don't use i2c muxes on your hardware. 21233f4978c7SHeiko Schocher if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can 21243f4978c7SHeiko Schocher omit this define. 21253f4978c7SHeiko Schocher 21263f4978c7SHeiko Schocher CONFIG_SYS_I2C_MAX_HOPS 21273f4978c7SHeiko Schocher define how many muxes are maximal consecutively connected 21283f4978c7SHeiko Schocher on one i2c bus. If you not use i2c muxes, omit this 21293f4978c7SHeiko Schocher define. 21303f4978c7SHeiko Schocher 21313f4978c7SHeiko Schocher CONFIG_SYS_I2C_BUSES 21323f4978c7SHeiko Schocher hold a list of busses you want to use, only used if 21333f4978c7SHeiko Schocher CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example 21343f4978c7SHeiko Schocher a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and 21353f4978c7SHeiko Schocher CONFIG_SYS_NUM_I2C_BUSES = 9: 21363f4978c7SHeiko Schocher 21373f4978c7SHeiko Schocher CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \ 21383f4978c7SHeiko Schocher {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \ 21393f4978c7SHeiko Schocher {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \ 21403f4978c7SHeiko Schocher {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \ 21413f4978c7SHeiko Schocher {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \ 21423f4978c7SHeiko Schocher {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \ 21433f4978c7SHeiko Schocher {1, {I2C_NULL_HOP}}, \ 21443f4978c7SHeiko Schocher {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \ 21453f4978c7SHeiko Schocher {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \ 21463f4978c7SHeiko Schocher } 21473f4978c7SHeiko Schocher 21483f4978c7SHeiko Schocher which defines 21493f4978c7SHeiko Schocher bus 0 on adapter 0 without a mux 2150ea818dbbSHeiko Schocher bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1 2151ea818dbbSHeiko Schocher bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2 2152ea818dbbSHeiko Schocher bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3 2153ea818dbbSHeiko Schocher bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4 2154ea818dbbSHeiko Schocher bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5 21553f4978c7SHeiko Schocher bus 6 on adapter 1 without a mux 2156ea818dbbSHeiko Schocher bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1 2157ea818dbbSHeiko Schocher bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2 21583f4978c7SHeiko Schocher 21593f4978c7SHeiko Schocher If you do not have i2c muxes on your board, omit this define. 21603f4978c7SHeiko Schocher 2161ea818dbbSHeiko Schocher- Legacy I2C Support: CONFIG_HARD_I2C 21623f4978c7SHeiko Schocher 21633f4978c7SHeiko Schocher NOTE: It is intended to move drivers to CONFIG_SYS_I2C which 21643f4978c7SHeiko Schocher provides the following compelling advantages: 21653f4978c7SHeiko Schocher 21663f4978c7SHeiko Schocher - more than one i2c adapter is usable 21673f4978c7SHeiko Schocher - approved multibus support 21683f4978c7SHeiko Schocher - better i2c mux support 21693f4978c7SHeiko Schocher 21703f4978c7SHeiko Schocher ** Please consider updating your I2C driver now. ** 21713f4978c7SHeiko Schocher 2172ea818dbbSHeiko Schocher These enable legacy I2C serial bus commands. Defining 2173ea818dbbSHeiko Schocher CONFIG_HARD_I2C will include the appropriate I2C driver 2174ea818dbbSHeiko Schocher for the selected CPU. 2175c609719bSwdenk 2176b37c7e5eSwdenk This will allow you to use i2c commands at the u-boot 2177602ad3b3SJon Loeliger command line (as long as you set CONFIG_CMD_I2C in 2178b37c7e5eSwdenk CONFIG_COMMANDS) and communicate with i2c based realtime 2179b37c7e5eSwdenk clock chips. See common/cmd_i2c.c for a description of the 2180c609719bSwdenk command line interface. 2181c609719bSwdenk 2182bb99ad6dSBen Warren CONFIG_HARD_I2C selects a hardware I2C controller. 2183c609719bSwdenk 2184b37c7e5eSwdenk There are several other quantities that must also be 2185ea818dbbSHeiko Schocher defined when you define CONFIG_HARD_I2C. 2186c609719bSwdenk 21876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD In both cases you will need to define CONFIG_SYS_I2C_SPEED 2188b37c7e5eSwdenk to be the frequency (in Hz) at which you wish your i2c bus 21896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie 219011ccc33fSMarcel Ziswiler the CPU's i2c node address). 2191c609719bSwdenk 21928d321b81SPeter Tyser Now, the u-boot i2c code for the mpc8xx 2193a47a12beSStefan Roese (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node 21948d321b81SPeter Tyser and so its address should therefore be cleared to 0 (See, 21958d321b81SPeter Tyser eg, MPC823e User's Manual p.16-473). So, set 21968d321b81SPeter Tyser CONFIG_SYS_I2C_SLAVE to 0. 2197b37c7e5eSwdenk 21985da71efaSEric Millbrandt CONFIG_SYS_I2C_INIT_MPC5XXX 21995da71efaSEric Millbrandt 22005da71efaSEric Millbrandt When a board is reset during an i2c bus transfer 22015da71efaSEric Millbrandt chips might think that the current transfer is still 22025da71efaSEric Millbrandt in progress. Reset the slave devices by sending start 22035da71efaSEric Millbrandt commands until the slave device responds. 22045da71efaSEric Millbrandt 2205b37c7e5eSwdenk That's all that's required for CONFIG_HARD_I2C. 2206b37c7e5eSwdenk 2207ea818dbbSHeiko Schocher If you use the software i2c interface (CONFIG_SYS_I2C_SOFT) 2208b37c7e5eSwdenk then the following macros need to be defined (examples are 2209b37c7e5eSwdenk from include/configs/lwmon.h): 2210c609719bSwdenk 2211c609719bSwdenk I2C_INIT 2212c609719bSwdenk 2213b37c7e5eSwdenk (Optional). Any commands necessary to enable the I2C 2214c609719bSwdenk controller or configure ports. 2215c609719bSwdenk 2216b37c7e5eSwdenk eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL) 2217b37c7e5eSwdenk 2218c609719bSwdenk I2C_PORT 2219c609719bSwdenk 2220c609719bSwdenk (Only for MPC8260 CPU). The I/O port to use (the code 2221c609719bSwdenk assumes both bits are on the same port). Valid values 2222c609719bSwdenk are 0..3 for ports A..D. 2223c609719bSwdenk 2224c609719bSwdenk I2C_ACTIVE 2225c609719bSwdenk 2226c609719bSwdenk The code necessary to make the I2C data line active 2227c609719bSwdenk (driven). If the data line is open collector, this 2228c609719bSwdenk define can be null. 2229c609719bSwdenk 2230b37c7e5eSwdenk eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA) 2231b37c7e5eSwdenk 2232c609719bSwdenk I2C_TRISTATE 2233c609719bSwdenk 2234c609719bSwdenk The code necessary to make the I2C data line tri-stated 2235c609719bSwdenk (inactive). If the data line is open collector, this 2236c609719bSwdenk define can be null. 2237c609719bSwdenk 2238b37c7e5eSwdenk eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA) 2239b37c7e5eSwdenk 2240c609719bSwdenk I2C_READ 2241c609719bSwdenk 2242472d5460SYork Sun Code that returns true if the I2C data line is high, 2243472d5460SYork Sun false if it is low. 2244c609719bSwdenk 2245b37c7e5eSwdenk eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0) 2246b37c7e5eSwdenk 2247c609719bSwdenk I2C_SDA(bit) 2248c609719bSwdenk 2249472d5460SYork Sun If <bit> is true, sets the I2C data line high. If it 2250472d5460SYork Sun is false, it clears it (low). 2251c609719bSwdenk 2252b37c7e5eSwdenk eg: #define I2C_SDA(bit) \ 2253b37c7e5eSwdenk if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \ 2254b37c7e5eSwdenk else immr->im_cpm.cp_pbdat &= ~PB_SDA 2255b37c7e5eSwdenk 2256c609719bSwdenk I2C_SCL(bit) 2257c609719bSwdenk 2258472d5460SYork Sun If <bit> is true, sets the I2C clock line high. If it 2259472d5460SYork Sun is false, it clears it (low). 2260c609719bSwdenk 2261b37c7e5eSwdenk eg: #define I2C_SCL(bit) \ 2262b37c7e5eSwdenk if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \ 2263b37c7e5eSwdenk else immr->im_cpm.cp_pbdat &= ~PB_SCL 2264b37c7e5eSwdenk 2265c609719bSwdenk I2C_DELAY 2266c609719bSwdenk 2267c609719bSwdenk This delay is invoked four times per clock cycle so this 2268c609719bSwdenk controls the rate of data transfer. The data rate thus 2269b37c7e5eSwdenk is 1 / (I2C_DELAY * 4). Often defined to be something 2270b37c7e5eSwdenk like: 2271b37c7e5eSwdenk 2272b37c7e5eSwdenk #define I2C_DELAY udelay(2) 2273c609719bSwdenk 2274793b5726SMike Frysinger CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA 2275793b5726SMike Frysinger 2276793b5726SMike Frysinger If your arch supports the generic GPIO framework (asm/gpio.h), 2277793b5726SMike Frysinger then you may alternatively define the two GPIOs that are to be 2278793b5726SMike Frysinger used as SCL / SDA. Any of the previous I2C_xxx macros will 2279793b5726SMike Frysinger have GPIO-based defaults assigned to them as appropriate. 2280793b5726SMike Frysinger 2281793b5726SMike Frysinger You should define these to the GPIO value as given directly to 2282793b5726SMike Frysinger the generic GPIO functions. 2283793b5726SMike Frysinger 22846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_INIT_BOARD 228547cd00faSwdenk 228647cd00faSwdenk When a board is reset during an i2c bus transfer 228747cd00faSwdenk chips might think that the current transfer is still 228847cd00faSwdenk in progress. On some boards it is possible to access 228947cd00faSwdenk the i2c SCLK line directly, either by using the 229047cd00faSwdenk processor pin as a GPIO or by having a second pin 229147cd00faSwdenk connected to the bus. If this option is defined a 229247cd00faSwdenk custom i2c_init_board() routine in boards/xxx/board.c 229347cd00faSwdenk is run early in the boot sequence. 229447cd00faSwdenk 229526a33504SRichard Retanubun CONFIG_SYS_I2C_BOARD_LATE_INIT 229626a33504SRichard Retanubun 229726a33504SRichard Retanubun An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is 229826a33504SRichard Retanubun defined a custom i2c_board_late_init() routine in 229926a33504SRichard Retanubun boards/xxx/board.c is run AFTER the operations in i2c_init() 230026a33504SRichard Retanubun is completed. This callpoint can be used to unreset i2c bus 230126a33504SRichard Retanubun using CPU i2c controller register accesses for CPUs whose i2c 230226a33504SRichard Retanubun controller provide such a method. It is called at the end of 230326a33504SRichard Retanubun i2c_init() to allow i2c_init operations to setup the i2c bus 230426a33504SRichard Retanubun controller on the CPU (e.g. setting bus speed & slave address). 230526a33504SRichard Retanubun 230617ea1177Swdenk CONFIG_I2CFAST (PPC405GP|PPC405EP only) 230717ea1177Swdenk 230817ea1177Swdenk This option enables configuration of bi_iic_fast[] flags 230917ea1177Swdenk in u-boot bd_info structure based on u-boot environment 231017ea1177Swdenk variable "i2cfast". (see also i2cfast) 231117ea1177Swdenk 2312bb99ad6dSBen Warren CONFIG_I2C_MULTI_BUS 2313bb99ad6dSBen Warren 2314bb99ad6dSBen Warren This option allows the use of multiple I2C buses, each of which 2315bb99ad6dSBen Warren must have a controller. At any point in time, only one bus is 2316bb99ad6dSBen Warren active. To switch to a different bus, use the 'i2c dev' command. 2317bb99ad6dSBen Warren Note that bus numbering is zero-based. 2318bb99ad6dSBen Warren 23196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_NOPROBES 2320bb99ad6dSBen Warren 2321bb99ad6dSBen Warren This option specifies a list of I2C devices that will be skipped 23220f89c54bSPeter Tyser when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS 23230f89c54bSPeter Tyser is set, specify a list of bus-device pairs. Otherwise, specify 23240f89c54bSPeter Tyser a 1D array of device addresses 2325bb99ad6dSBen Warren 2326bb99ad6dSBen Warren e.g. 2327bb99ad6dSBen Warren #undef CONFIG_I2C_MULTI_BUS 23286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68} 2329bb99ad6dSBen Warren 2330bb99ad6dSBen Warren will skip addresses 0x50 and 0x68 on a board with one I2C bus 2331bb99ad6dSBen Warren 2332bb99ad6dSBen Warren #define CONFIG_I2C_MULTI_BUS 23336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}} 2334bb99ad6dSBen Warren 2335bb99ad6dSBen Warren will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1 2336bb99ad6dSBen Warren 23376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SPD_BUS_NUM 2338be5e6181STimur Tabi 2339be5e6181STimur Tabi If defined, then this indicates the I2C bus number for DDR SPD. 2340be5e6181STimur Tabi If not defined, then U-Boot assumes that SPD is on I2C bus 0. 2341be5e6181STimur Tabi 23426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_RTC_BUS_NUM 23430dc018ecSStefan Roese 23440dc018ecSStefan Roese If defined, then this indicates the I2C bus number for the RTC. 23450dc018ecSStefan Roese If not defined, then U-Boot assumes that RTC is on I2C bus 0. 23460dc018ecSStefan Roese 23476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_DTT_BUS_NUM 23480dc018ecSStefan Roese 23490dc018ecSStefan Roese If defined, then this indicates the I2C bus number for the DTT. 23500dc018ecSStefan Roese If not defined, then U-Boot assumes that DTT is on I2C bus 0. 23510dc018ecSStefan Roese 23526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_DTT_ADDR: 23539ebbb54fSVictor Gallardo 23549ebbb54fSVictor Gallardo If defined, specifies the I2C address of the DTT device. 23559ebbb54fSVictor Gallardo If not defined, then U-Boot uses predefined value for 23569ebbb54fSVictor Gallardo specified DTT device. 23579ebbb54fSVictor Gallardo 23582ac6985aSAndrew Dyer CONFIG_SOFT_I2C_READ_REPEATED_START 23592ac6985aSAndrew Dyer 23602ac6985aSAndrew Dyer defining this will force the i2c_read() function in 23612ac6985aSAndrew Dyer the soft_i2c driver to perform an I2C repeated start 23622ac6985aSAndrew Dyer between writing the address pointer and reading the 23632ac6985aSAndrew Dyer data. If this define is omitted the default behaviour 23642ac6985aSAndrew Dyer of doing a stop-start sequence will be used. Most I2C 23652ac6985aSAndrew Dyer devices can use either method, but some require one or 23662ac6985aSAndrew Dyer the other. 2367be5e6181STimur Tabi 2368c609719bSwdenk- SPI Support: CONFIG_SPI 2369c609719bSwdenk 2370c609719bSwdenk Enables SPI driver (so far only tested with 2371c609719bSwdenk SPI EEPROM, also an instance works with Crystal A/D and 2372c609719bSwdenk D/As on the SACSng board) 2373c609719bSwdenk 23746639562eSYoshihiro Shimoda CONFIG_SH_SPI 23756639562eSYoshihiro Shimoda 23766639562eSYoshihiro Shimoda Enables the driver for SPI controller on SuperH. Currently 23776639562eSYoshihiro Shimoda only SH7757 is supported. 23786639562eSYoshihiro Shimoda 2379c609719bSwdenk CONFIG_SPI_X 2380c609719bSwdenk 2381c609719bSwdenk Enables extended (16-bit) SPI EEPROM addressing. 2382c609719bSwdenk (symmetrical to CONFIG_I2C_X) 2383c609719bSwdenk 2384c609719bSwdenk CONFIG_SOFT_SPI 2385c609719bSwdenk 2386c609719bSwdenk Enables a software (bit-bang) SPI driver rather than 2387c609719bSwdenk using hardware support. This is a general purpose 2388c609719bSwdenk driver that only requires three general I/O port pins 2389c609719bSwdenk (two outputs, one input) to function. If this is 2390c609719bSwdenk defined, the board configuration must define several 2391c609719bSwdenk SPI configuration items (port pins to use, etc). For 2392c609719bSwdenk an example, see include/configs/sacsng.h. 2393c609719bSwdenk 239404a9e118SBen Warren CONFIG_HARD_SPI 239504a9e118SBen Warren 239604a9e118SBen Warren Enables a hardware SPI driver for general-purpose reads 239704a9e118SBen Warren and writes. As with CONFIG_SOFT_SPI, the board configuration 239804a9e118SBen Warren must define a list of chip-select function pointers. 239904a9e118SBen Warren Currently supported on some MPC8xxx processors. For an 240004a9e118SBen Warren example, see include/configs/mpc8349emds.h. 240104a9e118SBen Warren 240238254f45SGuennadi Liakhovetski CONFIG_MXC_SPI 240338254f45SGuennadi Liakhovetski 240438254f45SGuennadi Liakhovetski Enables the driver for the SPI controllers on i.MX and MXC 24052e3cd1cdSFabio Estevam SoCs. Currently i.MX31/35/51 are supported. 240638254f45SGuennadi Liakhovetski 24070133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA 24080133502eSMatthias Fuchs 24090133502eSMatthias Fuchs Enables FPGA subsystem. 24100133502eSMatthias Fuchs 24110133502eSMatthias Fuchs CONFIG_FPGA_<vendor> 24120133502eSMatthias Fuchs 24130133502eSMatthias Fuchs Enables support for specific chip vendors. 24140133502eSMatthias Fuchs (ALTERA, XILINX) 24150133502eSMatthias Fuchs 24160133502eSMatthias Fuchs CONFIG_FPGA_<family> 24170133502eSMatthias Fuchs 24180133502eSMatthias Fuchs Enables support for FPGA family. 24190133502eSMatthias Fuchs (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX) 24200133502eSMatthias Fuchs 24210133502eSMatthias Fuchs CONFIG_FPGA_COUNT 2422c609719bSwdenk 2423c609719bSwdenk Specify the number of FPGA devices to support. 2424c609719bSwdenk 24256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_PROG_FEEDBACK 2426c609719bSwdenk 2427c609719bSwdenk Enable printing of hash marks during FPGA configuration. 2428c609719bSwdenk 24296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_BUSY 2430c609719bSwdenk 2431c609719bSwdenk Enable checks on FPGA configuration interface busy 2432c609719bSwdenk status by the configuration function. This option 2433c609719bSwdenk will require a board or device specific function to 2434c609719bSwdenk be written. 2435c609719bSwdenk 2436c609719bSwdenk CONFIG_FPGA_DELAY 2437c609719bSwdenk 2438c609719bSwdenk If defined, a function that provides delays in the FPGA 2439c609719bSwdenk configuration driver. 2440c609719bSwdenk 24416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_CTRLC 2442c609719bSwdenk Allow Control-C to interrupt FPGA configuration 2443c609719bSwdenk 24446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_ERROR 2445c609719bSwdenk 2446c609719bSwdenk Check for configuration errors during FPGA bitfile 2447c609719bSwdenk loading. For example, abort during Virtex II 2448c609719bSwdenk configuration if the INIT_B line goes low (which 2449c609719bSwdenk indicated a CRC error). 2450c609719bSwdenk 24516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_INIT 2452c609719bSwdenk 2453c609719bSwdenk Maximum time to wait for the INIT_B line to deassert 2454c609719bSwdenk after PROB_B has been deasserted during a Virtex II 2455c609719bSwdenk FPGA configuration sequence. The default time is 500 245611ccc33fSMarcel Ziswiler ms. 2457c609719bSwdenk 24586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_BUSY 2459c609719bSwdenk 2460c609719bSwdenk Maximum time to wait for BUSY to deassert during 246111ccc33fSMarcel Ziswiler Virtex II FPGA configuration. The default is 5 ms. 2462c609719bSwdenk 24636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_CONFIG 2464c609719bSwdenk 2465c609719bSwdenk Time to wait after FPGA configuration. The default is 246611ccc33fSMarcel Ziswiler 200 ms. 2467c609719bSwdenk 2468c609719bSwdenk- Configuration Management: 2469c609719bSwdenk CONFIG_IDENT_STRING 2470c609719bSwdenk 2471c609719bSwdenk If defined, this string will be added to the U-Boot 2472c609719bSwdenk version information (U_BOOT_VERSION) 2473c609719bSwdenk 2474c609719bSwdenk- Vendor Parameter Protection: 2475c609719bSwdenk 2476c609719bSwdenk U-Boot considers the values of the environment 2477c609719bSwdenk variables "serial#" (Board Serial Number) and 24787152b1d0Swdenk "ethaddr" (Ethernet Address) to be parameters that 2479c609719bSwdenk are set once by the board vendor / manufacturer, and 2480c609719bSwdenk protects these variables from casual modification by 2481c609719bSwdenk the user. Once set, these variables are read-only, 2482c609719bSwdenk and write or delete attempts are rejected. You can 248311ccc33fSMarcel Ziswiler change this behaviour: 2484c609719bSwdenk 2485c609719bSwdenk If CONFIG_ENV_OVERWRITE is #defined in your config 2486c609719bSwdenk file, the write protection for vendor parameters is 248747cd00faSwdenk completely disabled. Anybody can change or delete 2488c609719bSwdenk these parameters. 2489c609719bSwdenk 2490c609719bSwdenk Alternatively, if you #define _both_ CONFIG_ETHADDR 2491c609719bSwdenk _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default 249211ccc33fSMarcel Ziswiler Ethernet address is installed in the environment, 2493c609719bSwdenk which can be changed exactly ONCE by the user. [The 2494c609719bSwdenk serial# is unaffected by this, i. e. it remains 2495c609719bSwdenk read-only.] 2496c609719bSwdenk 24972598090bSJoe Hershberger The same can be accomplished in a more flexible way 24982598090bSJoe Hershberger for any variable by configuring the type of access 24992598090bSJoe Hershberger to allow for those variables in the ".flags" variable 25002598090bSJoe Hershberger or define CONFIG_ENV_FLAGS_LIST_STATIC. 25012598090bSJoe Hershberger 2502c609719bSwdenk- Protected RAM: 2503c609719bSwdenk CONFIG_PRAM 2504c609719bSwdenk 2505c609719bSwdenk Define this variable to enable the reservation of 2506c609719bSwdenk "protected RAM", i. e. RAM which is not overwritten 2507c609719bSwdenk by U-Boot. Define CONFIG_PRAM to hold the number of 2508c609719bSwdenk kB you want to reserve for pRAM. You can overwrite 2509c609719bSwdenk this default value by defining an environment 2510c609719bSwdenk variable "pram" to the number of kB you want to 2511c609719bSwdenk reserve. Note that the board info structure will 2512c609719bSwdenk still show the full amount of RAM. If pRAM is 2513c609719bSwdenk reserved, a new environment variable "mem" will 2514c609719bSwdenk automatically be defined to hold the amount of 2515c609719bSwdenk remaining RAM in a form that can be passed as boot 2516c609719bSwdenk argument to Linux, for instance like that: 2517c609719bSwdenk 2518fe126d8bSWolfgang Denk setenv bootargs ... mem=\${mem} 2519c609719bSwdenk saveenv 2520c609719bSwdenk 2521c609719bSwdenk This way you can tell Linux not to use this memory, 2522c609719bSwdenk either, which results in a memory region that will 2523c609719bSwdenk not be affected by reboots. 2524c609719bSwdenk 2525c609719bSwdenk *WARNING* If your board configuration uses automatic 2526c609719bSwdenk detection of the RAM size, you must make sure that 2527c609719bSwdenk this memory test is non-destructive. So far, the 2528c609719bSwdenk following board configurations are known to be 2529c609719bSwdenk "pRAM-clean": 2530c609719bSwdenk 25311b0757ecSWolfgang Denk IVMS8, IVML24, SPD8xx, TQM8xxL, 25321b0757ecSWolfgang Denk HERMES, IP860, RPXlite, LWMON, 2533544d97e9SWolfgang Denk FLAGADM, TQM8260 2534c609719bSwdenk 253540fef049SGabe Black- Access to physical memory region (> 4GB) 253640fef049SGabe Black Some basic support is provided for operations on memory not 253740fef049SGabe Black normally accessible to U-Boot - e.g. some architectures 253840fef049SGabe Black support access to more than 4GB of memory on 32-bit 253940fef049SGabe Black machines using physical address extension or similar. 254040fef049SGabe Black Define CONFIG_PHYSMEM to access this basic support, which 254140fef049SGabe Black currently only supports clearing the memory. 254240fef049SGabe Black 2543c609719bSwdenk- Error Recovery: 2544c609719bSwdenk CONFIG_PANIC_HANG 2545c609719bSwdenk 2546c609719bSwdenk Define this variable to stop the system in case of a 2547c609719bSwdenk fatal error, so that you have to reset it manually. 2548c609719bSwdenk This is probably NOT a good idea for an embedded 254911ccc33fSMarcel Ziswiler system where you want the system to reboot 2550c609719bSwdenk automatically as fast as possible, but it may be 2551c609719bSwdenk useful during development since you can try to debug 2552c609719bSwdenk the conditions that lead to the situation. 2553c609719bSwdenk 2554c609719bSwdenk CONFIG_NET_RETRY_COUNT 2555c609719bSwdenk 2556c609719bSwdenk This variable defines the number of retries for 2557c609719bSwdenk network operations like ARP, RARP, TFTP, or BOOTP 2558c609719bSwdenk before giving up the operation. If not defined, a 2559c609719bSwdenk default value of 5 is used. 2560c609719bSwdenk 256140cb90eeSGuennadi Liakhovetski CONFIG_ARP_TIMEOUT 256240cb90eeSGuennadi Liakhovetski 256340cb90eeSGuennadi Liakhovetski Timeout waiting for an ARP reply in milliseconds. 256440cb90eeSGuennadi Liakhovetski 256548a3e999STetsuyuki Kobayashi CONFIG_NFS_TIMEOUT 256648a3e999STetsuyuki Kobayashi 256748a3e999STetsuyuki Kobayashi Timeout in milliseconds used in NFS protocol. 256848a3e999STetsuyuki Kobayashi If you encounter "ERROR: Cannot umount" in nfs command, 256948a3e999STetsuyuki Kobayashi try longer timeout such as 257048a3e999STetsuyuki Kobayashi #define CONFIG_NFS_TIMEOUT 10000UL 257148a3e999STetsuyuki Kobayashi 2572c609719bSwdenk- Command Interpreter: 25738078f1a5SWolfgang Denk CONFIG_AUTO_COMPLETE 257404a85b3bSwdenk 257504a85b3bSwdenk Enable auto completion of commands using TAB. 257604a85b3bSwdenk 25778078f1a5SWolfgang Denk Note that this feature has NOT been implemented yet 25788078f1a5SWolfgang Denk for the "hush" shell. 25798078f1a5SWolfgang Denk 25808078f1a5SWolfgang Denk 25816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_HUSH_PARSER 2582c609719bSwdenk 2583c609719bSwdenk Define this variable to enable the "hush" shell (from 2584c609719bSwdenk Busybox) as command line interpreter, thus enabling 2585c609719bSwdenk powerful command line syntax like 2586c609719bSwdenk if...then...else...fi conditionals or `&&' and '||' 2587c609719bSwdenk constructs ("shell scripts"). 2588c609719bSwdenk 2589c609719bSwdenk If undefined, you get the old, much simpler behaviour 2590c609719bSwdenk with a somewhat smaller memory footprint. 2591c609719bSwdenk 2592c609719bSwdenk 25936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PROMPT_HUSH_PS2 2594c609719bSwdenk 2595c609719bSwdenk This defines the secondary prompt string, which is 2596c609719bSwdenk printed when the command interpreter needs more input 2597c609719bSwdenk to complete a command. Usually "> ". 2598c609719bSwdenk 2599c609719bSwdenk Note: 2600c609719bSwdenk 2601c609719bSwdenk In the current implementation, the local variables 2602c609719bSwdenk space and global environment variables space are 2603c609719bSwdenk separated. Local variables are those you define by 26043b57fe0aSwdenk simply typing `name=value'. To access a local 2605c609719bSwdenk variable later on, you have write `$name' or 26063b57fe0aSwdenk `${name}'; to execute the contents of a variable 26073b57fe0aSwdenk directly type `$name' at the command prompt. 2608c609719bSwdenk 2609c609719bSwdenk Global environment variables are those you use 2610c609719bSwdenk setenv/printenv to work with. To run a command stored 2611c609719bSwdenk in such a variable, you need to use the run command, 2612c609719bSwdenk and you must not use the '$' sign to access them. 2613c609719bSwdenk 2614c609719bSwdenk To store commands and special characters in a 2615c609719bSwdenk variable, please use double quotation marks 2616c609719bSwdenk surrounding the whole text of the variable, instead 2617c609719bSwdenk of the backslashes before semicolons and special 2618c609719bSwdenk symbols. 2619c609719bSwdenk 2620aa0c71acSWolfgang Denk- Commandline Editing and History: 2621aa0c71acSWolfgang Denk CONFIG_CMDLINE_EDITING 2622aa0c71acSWolfgang Denk 262311ccc33fSMarcel Ziswiler Enable editing and History functions for interactive 2624aa0c71acSWolfgang Denk commandline input operations 2625aa0c71acSWolfgang Denk 2626a8c7c708Swdenk- Default Environment: 2627c609719bSwdenk CONFIG_EXTRA_ENV_SETTINGS 2628c609719bSwdenk 2629c609719bSwdenk Define this to contain any number of null terminated 2630c609719bSwdenk strings (variable = value pairs) that will be part of 26317152b1d0Swdenk the default environment compiled into the boot image. 26322262cfeeSwdenk 2633c609719bSwdenk For example, place something like this in your 2634c609719bSwdenk board's config file: 2635c609719bSwdenk 2636c609719bSwdenk #define CONFIG_EXTRA_ENV_SETTINGS \ 2637c609719bSwdenk "myvar1=value1\0" \ 2638c609719bSwdenk "myvar2=value2\0" 2639c609719bSwdenk 2640c609719bSwdenk Warning: This method is based on knowledge about the 2641c609719bSwdenk internal format how the environment is stored by the 26422262cfeeSwdenk U-Boot code. This is NOT an official, exported 2643c609719bSwdenk interface! Although it is unlikely that this format 26447152b1d0Swdenk will change soon, there is no guarantee either. 2645c609719bSwdenk You better know what you are doing here. 2646c609719bSwdenk 2647c609719bSwdenk Note: overly (ab)use of the default environment is 2648c609719bSwdenk discouraged. Make sure to check other ways to preset 264974de7aefSWolfgang Denk the environment like the "source" command or the 2650c609719bSwdenk boot command first. 2651c609719bSwdenk 26525e724ca2SStephen Warren CONFIG_ENV_VARS_UBOOT_CONFIG 26535e724ca2SStephen Warren 26545e724ca2SStephen Warren Define this in order to add variables describing the 26555e724ca2SStephen Warren U-Boot build configuration to the default environment. 26565e724ca2SStephen Warren These will be named arch, cpu, board, vendor, and soc. 26575e724ca2SStephen Warren 26585e724ca2SStephen Warren Enabling this option will cause the following to be defined: 26595e724ca2SStephen Warren 26605e724ca2SStephen Warren - CONFIG_SYS_ARCH 26615e724ca2SStephen Warren - CONFIG_SYS_CPU 26625e724ca2SStephen Warren - CONFIG_SYS_BOARD 26635e724ca2SStephen Warren - CONFIG_SYS_VENDOR 26645e724ca2SStephen Warren - CONFIG_SYS_SOC 26655e724ca2SStephen Warren 26667e27f89fSTom Rini CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG 26677e27f89fSTom Rini 26687e27f89fSTom Rini Define this in order to add variables describing certain 26697e27f89fSTom Rini run-time determined information about the hardware to the 26707e27f89fSTom Rini environment. These will be named board_name, board_rev. 26717e27f89fSTom Rini 267206fd8538SSimon Glass CONFIG_DELAY_ENVIRONMENT 267306fd8538SSimon Glass 267406fd8538SSimon Glass Normally the environment is loaded when the board is 267506fd8538SSimon Glass intialised so that it is available to U-Boot. This inhibits 267606fd8538SSimon Glass that so that the environment is not available until 267706fd8538SSimon Glass explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL 267806fd8538SSimon Glass this is instead controlled by the value of 267906fd8538SSimon Glass /config/load-environment. 268006fd8538SSimon Glass 2681a8c7c708Swdenk- DataFlash Support: 26822abbe075Swdenk CONFIG_HAS_DATAFLASH 26832abbe075Swdenk 26842abbe075Swdenk Defining this option enables DataFlash features and 26852abbe075Swdenk allows to read/write in Dataflash via the standard 26862abbe075Swdenk commands cp, md... 26872abbe075Swdenk 2688f61ec45eSEric Nelson- Serial Flash support 2689f61ec45eSEric Nelson CONFIG_CMD_SF 2690f61ec45eSEric Nelson 2691f61ec45eSEric Nelson Defining this option enables SPI flash commands 2692f61ec45eSEric Nelson 'sf probe/read/write/erase/update'. 2693f61ec45eSEric Nelson 2694f61ec45eSEric Nelson Usage requires an initial 'probe' to define the serial 2695f61ec45eSEric Nelson flash parameters, followed by read/write/erase/update 2696f61ec45eSEric Nelson commands. 2697f61ec45eSEric Nelson 2698f61ec45eSEric Nelson The following defaults may be provided by the platform 2699f61ec45eSEric Nelson to handle the common case when only a single serial 2700f61ec45eSEric Nelson flash is present on the system. 2701f61ec45eSEric Nelson 2702f61ec45eSEric Nelson CONFIG_SF_DEFAULT_BUS Bus identifier 2703f61ec45eSEric Nelson CONFIG_SF_DEFAULT_CS Chip-select 2704f61ec45eSEric Nelson CONFIG_SF_DEFAULT_MODE (see include/spi.h) 2705f61ec45eSEric Nelson CONFIG_SF_DEFAULT_SPEED in Hz 2706f61ec45eSEric Nelson 270724007273SSimon Glass CONFIG_CMD_SF_TEST 270824007273SSimon Glass 270924007273SSimon Glass Define this option to include a destructive SPI flash 271024007273SSimon Glass test ('sf test'). 271124007273SSimon Glass 27121dcd6d03SJagannadha Sutradharudu Teki CONFIG_SPI_FLASH_BAR Ban/Extended Addr Reg 27131dcd6d03SJagannadha Sutradharudu Teki 27141dcd6d03SJagannadha Sutradharudu Teki Define this option to use the Bank addr/Extended addr 27151dcd6d03SJagannadha Sutradharudu Teki support on SPI flashes which has size > 16Mbytes. 27161dcd6d03SJagannadha Sutradharudu Teki 27173f85ce27Swdenk- SystemACE Support: 27183f85ce27Swdenk CONFIG_SYSTEMACE 27193f85ce27Swdenk 27203f85ce27Swdenk Adding this option adds support for Xilinx SystemACE 27213f85ce27Swdenk chips attached via some sort of local bus. The address 272211ccc33fSMarcel Ziswiler of the chip must also be defined in the 27236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SYSTEMACE_BASE macro. For example: 27243f85ce27Swdenk 27253f85ce27Swdenk #define CONFIG_SYSTEMACE 27266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000 27273f85ce27Swdenk 27283f85ce27Swdenk When SystemACE support is added, the "ace" device type 27293f85ce27Swdenk becomes available to the fat commands, i.e. fatls. 27303f85ce27Swdenk 2731ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port: 2732ecb0ccd9SWolfgang Denk CONFIG_TFTP_PORT 2733ecb0ccd9SWolfgang Denk 273428cb9375SWolfgang Denk If this is defined, the environment variable tftpsrcp 2735ecb0ccd9SWolfgang Denk is used to supply the TFTP UDP source port value. 273628cb9375SWolfgang Denk If tftpsrcp isn't defined, the normal pseudo-random port 2737ecb0ccd9SWolfgang Denk number generator is used. 2738ecb0ccd9SWolfgang Denk 273928cb9375SWolfgang Denk Also, the environment variable tftpdstp is used to supply 274028cb9375SWolfgang Denk the TFTP UDP destination port value. If tftpdstp isn't 274128cb9375SWolfgang Denk defined, the normal port 69 is used. 274228cb9375SWolfgang Denk 274328cb9375SWolfgang Denk The purpose for tftpsrcp is to allow a TFTP server to 2744ecb0ccd9SWolfgang Denk blindly start the TFTP transfer using the pre-configured 2745ecb0ccd9SWolfgang Denk target IP address and UDP port. This has the effect of 2746ecb0ccd9SWolfgang Denk "punching through" the (Windows XP) firewall, allowing 2747ecb0ccd9SWolfgang Denk the remainder of the TFTP transfer to proceed normally. 2748ecb0ccd9SWolfgang Denk A better solution is to properly configure the firewall, 2749ecb0ccd9SWolfgang Denk but sometimes that is not allowed. 2750ecb0ccd9SWolfgang Denk 2751bf36c5d5SSimon Glass- Hashing support: 2752bf36c5d5SSimon Glass CONFIG_CMD_HASH 2753bf36c5d5SSimon Glass 2754bf36c5d5SSimon Glass This enables a generic 'hash' command which can produce 2755bf36c5d5SSimon Glass hashes / digests from a few algorithms (e.g. SHA1, SHA256). 2756bf36c5d5SSimon Glass 2757bf36c5d5SSimon Glass CONFIG_HASH_VERIFY 2758bf36c5d5SSimon Glass 2759bf36c5d5SSimon Glass Enable the hash verify command (hash -v). This adds to code 2760bf36c5d5SSimon Glass size a little. 2761bf36c5d5SSimon Glass 2762bf36c5d5SSimon Glass CONFIG_SHA1 - support SHA1 hashing 2763bf36c5d5SSimon Glass CONFIG_SHA256 - support SHA256 hashing 2764bf36c5d5SSimon Glass 2765bf36c5d5SSimon Glass Note: There is also a sha1sum command, which should perhaps 2766bf36c5d5SSimon Glass be deprecated in favour of 'hash sha1'. 2767bf36c5d5SSimon Glass 2768a11f1873SRobert Winkler- Freescale i.MX specific commands: 2769a11f1873SRobert Winkler CONFIG_CMD_HDMIDETECT 2770a11f1873SRobert Winkler This enables 'hdmidet' command which returns true if an 2771a11f1873SRobert Winkler HDMI monitor is detected. This command is i.MX 6 specific. 2772a11f1873SRobert Winkler 2773a11f1873SRobert Winkler CONFIG_CMD_BMODE 2774a11f1873SRobert Winkler This enables the 'bmode' (bootmode) command for forcing 2775a11f1873SRobert Winkler a boot from specific media. 2776a11f1873SRobert Winkler 2777a11f1873SRobert Winkler This is useful for forcing the ROM's usb downloader to 2778a11f1873SRobert Winkler activate upon a watchdog reset which is nice when iterating 2779a11f1873SRobert Winkler on U-Boot. Using the reset button or running bmode normal 2780a11f1873SRobert Winkler will set it back to normal. This command currently 2781a11f1873SRobert Winkler supports i.MX53 and i.MX6. 2782a11f1873SRobert Winkler 278319c402afSSimon Glass- Signing support: 278419c402afSSimon Glass CONFIG_RSA 278519c402afSSimon Glass 278619c402afSSimon Glass This enables the RSA algorithm used for FIT image verification 278719c402afSSimon Glass in U-Boot. See doc/uImage/signature for more information. 278819c402afSSimon Glass 278919c402afSSimon Glass The signing part is build into mkimage regardless of this 279019c402afSSimon Glass option. 279119c402afSSimon Glass 279219c402afSSimon Glass 2793a8c7c708Swdenk- Show boot progress: 2794c609719bSwdenk CONFIG_SHOW_BOOT_PROGRESS 2795c609719bSwdenk 2796c609719bSwdenk Defining this option allows to add some board- 2797c609719bSwdenk specific code (calling a user-provided function 2798c609719bSwdenk "show_boot_progress(int)") that enables you to show 2799c609719bSwdenk the system's boot progress on some display (for 2800c609719bSwdenk example, some LED's) on your board. At the moment, 2801c609719bSwdenk the following checkpoints are implemented: 2802c609719bSwdenk 28033a608ca0SSimon Glass- Detailed boot stage timing 28043a608ca0SSimon Glass CONFIG_BOOTSTAGE 28053a608ca0SSimon Glass Define this option to get detailed timing of each stage 28063a608ca0SSimon Glass of the boot process. 28073a608ca0SSimon Glass 28083a608ca0SSimon Glass CONFIG_BOOTSTAGE_USER_COUNT 28093a608ca0SSimon Glass This is the number of available user bootstage records. 28103a608ca0SSimon Glass Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...) 28113a608ca0SSimon Glass a new ID will be allocated from this stash. If you exceed 28123a608ca0SSimon Glass the limit, recording will stop. 28133a608ca0SSimon Glass 28143a608ca0SSimon Glass CONFIG_BOOTSTAGE_REPORT 28153a608ca0SSimon Glass Define this to print a report before boot, similar to this: 28163a608ca0SSimon Glass 28173a608ca0SSimon Glass Timer summary in microseconds: 28183a608ca0SSimon Glass Mark Elapsed Stage 28193a608ca0SSimon Glass 0 0 reset 28203a608ca0SSimon Glass 3,575,678 3,575,678 board_init_f start 28213a608ca0SSimon Glass 3,575,695 17 arch_cpu_init A9 28223a608ca0SSimon Glass 3,575,777 82 arch_cpu_init done 28233a608ca0SSimon Glass 3,659,598 83,821 board_init_r start 28243a608ca0SSimon Glass 3,910,375 250,777 main_loop 28253a608ca0SSimon Glass 29,916,167 26,005,792 bootm_start 28263a608ca0SSimon Glass 30,361,327 445,160 start_kernel 28273a608ca0SSimon Glass 28282eba38cfSSimon Glass CONFIG_CMD_BOOTSTAGE 28292eba38cfSSimon Glass Add a 'bootstage' command which supports printing a report 28302eba38cfSSimon Glass and un/stashing of bootstage data. 28312eba38cfSSimon Glass 283294fd1316SSimon Glass CONFIG_BOOTSTAGE_FDT 283394fd1316SSimon Glass Stash the bootstage information in the FDT. A root 'bootstage' 283494fd1316SSimon Glass node is created with each bootstage id as a child. Each child 283594fd1316SSimon Glass has a 'name' property and either 'mark' containing the 283694fd1316SSimon Glass mark time in microsecond, or 'accum' containing the 283794fd1316SSimon Glass accumulated time for that bootstage id in microseconds. 283894fd1316SSimon Glass For example: 283994fd1316SSimon Glass 284094fd1316SSimon Glass bootstage { 284194fd1316SSimon Glass 154 { 284294fd1316SSimon Glass name = "board_init_f"; 284394fd1316SSimon Glass mark = <3575678>; 284494fd1316SSimon Glass }; 284594fd1316SSimon Glass 170 { 284694fd1316SSimon Glass name = "lcd"; 284794fd1316SSimon Glass accum = <33482>; 284894fd1316SSimon Glass }; 284994fd1316SSimon Glass }; 285094fd1316SSimon Glass 285194fd1316SSimon Glass Code in the Linux kernel can find this in /proc/devicetree. 285294fd1316SSimon Glass 28531372cce2SMarian BalakowiczLegacy uImage format: 28541372cce2SMarian Balakowicz 2855c609719bSwdenk Arg Where When 2856c609719bSwdenk 1 common/cmd_bootm.c before attempting to boot an image 2857c609719bSwdenk -1 common/cmd_bootm.c Image header has bad magic number 2858c609719bSwdenk 2 common/cmd_bootm.c Image header has correct magic number 2859c609719bSwdenk -2 common/cmd_bootm.c Image header has bad checksum 2860c609719bSwdenk 3 common/cmd_bootm.c Image header has correct checksum 2861c609719bSwdenk -3 common/cmd_bootm.c Image data has bad checksum 2862c609719bSwdenk 4 common/cmd_bootm.c Image data has correct checksum 2863c609719bSwdenk -4 common/cmd_bootm.c Image is for unsupported architecture 2864c609719bSwdenk 5 common/cmd_bootm.c Architecture check OK 28651372cce2SMarian Balakowicz -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi) 2866c609719bSwdenk 6 common/cmd_bootm.c Image Type check OK 2867c609719bSwdenk -6 common/cmd_bootm.c gunzip uncompression error 2868c609719bSwdenk -7 common/cmd_bootm.c Unimplemented compression type 2869c609719bSwdenk 7 common/cmd_bootm.c Uncompression OK 28701372cce2SMarian Balakowicz 8 common/cmd_bootm.c No uncompress/copy overwrite error 2871c609719bSwdenk -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX) 28721372cce2SMarian Balakowicz 28731372cce2SMarian Balakowicz 9 common/image.c Start initial ramdisk verification 28741372cce2SMarian Balakowicz -10 common/image.c Ramdisk header has bad magic number 28751372cce2SMarian Balakowicz -11 common/image.c Ramdisk header has bad checksum 28761372cce2SMarian Balakowicz 10 common/image.c Ramdisk header is OK 28771372cce2SMarian Balakowicz -12 common/image.c Ramdisk data has bad checksum 28781372cce2SMarian Balakowicz 11 common/image.c Ramdisk data has correct checksum 28791372cce2SMarian Balakowicz 12 common/image.c Ramdisk verification complete, start loading 288011ccc33fSMarcel Ziswiler -13 common/image.c Wrong Image Type (not PPC Linux ramdisk) 28811372cce2SMarian Balakowicz 13 common/image.c Start multifile image verification 28821372cce2SMarian Balakowicz 14 common/image.c No initial ramdisk, no multifile, continue. 28831372cce2SMarian Balakowicz 2884ea0364f1SPeter Tyser 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS 2885c609719bSwdenk 2886a47a12beSStefan Roese -30 arch/powerpc/lib/board.c Fatal error, hang the system 288763e73c9aSwdenk -31 post/post.c POST test failed, detected by post_output_backlog() 288863e73c9aSwdenk -32 post/post.c POST test failed, detected by post_run_single() 288963e73c9aSwdenk 2890566a494fSHeiko Schocher 34 common/cmd_doc.c before loading a Image from a DOC device 2891566a494fSHeiko Schocher -35 common/cmd_doc.c Bad usage of "doc" command 2892566a494fSHeiko Schocher 35 common/cmd_doc.c correct usage of "doc" command 2893566a494fSHeiko Schocher -36 common/cmd_doc.c No boot device 2894566a494fSHeiko Schocher 36 common/cmd_doc.c correct boot device 2895566a494fSHeiko Schocher -37 common/cmd_doc.c Unknown Chip ID on boot device 2896566a494fSHeiko Schocher 37 common/cmd_doc.c correct chip ID found, device available 2897566a494fSHeiko Schocher -38 common/cmd_doc.c Read Error on boot device 2898566a494fSHeiko Schocher 38 common/cmd_doc.c reading Image header from DOC device OK 2899566a494fSHeiko Schocher -39 common/cmd_doc.c Image header has bad magic number 2900566a494fSHeiko Schocher 39 common/cmd_doc.c Image header has correct magic number 2901566a494fSHeiko Schocher -40 common/cmd_doc.c Error reading Image from DOC device 2902566a494fSHeiko Schocher 40 common/cmd_doc.c Image header has correct magic number 2903566a494fSHeiko Schocher 41 common/cmd_ide.c before loading a Image from a IDE device 2904566a494fSHeiko Schocher -42 common/cmd_ide.c Bad usage of "ide" command 2905566a494fSHeiko Schocher 42 common/cmd_ide.c correct usage of "ide" command 2906566a494fSHeiko Schocher -43 common/cmd_ide.c No boot device 2907566a494fSHeiko Schocher 43 common/cmd_ide.c boot device found 2908566a494fSHeiko Schocher -44 common/cmd_ide.c Device not available 2909566a494fSHeiko Schocher 44 common/cmd_ide.c Device available 2910566a494fSHeiko Schocher -45 common/cmd_ide.c wrong partition selected 2911566a494fSHeiko Schocher 45 common/cmd_ide.c partition selected 2912566a494fSHeiko Schocher -46 common/cmd_ide.c Unknown partition table 2913566a494fSHeiko Schocher 46 common/cmd_ide.c valid partition table found 2914566a494fSHeiko Schocher -47 common/cmd_ide.c Invalid partition type 2915566a494fSHeiko Schocher 47 common/cmd_ide.c correct partition type 2916566a494fSHeiko Schocher -48 common/cmd_ide.c Error reading Image Header on boot device 2917566a494fSHeiko Schocher 48 common/cmd_ide.c reading Image Header from IDE device OK 2918566a494fSHeiko Schocher -49 common/cmd_ide.c Image header has bad magic number 2919566a494fSHeiko Schocher 49 common/cmd_ide.c Image header has correct magic number 2920566a494fSHeiko Schocher -50 common/cmd_ide.c Image header has bad checksum 2921566a494fSHeiko Schocher 50 common/cmd_ide.c Image header has correct checksum 2922566a494fSHeiko Schocher -51 common/cmd_ide.c Error reading Image from IDE device 2923566a494fSHeiko Schocher 51 common/cmd_ide.c reading Image from IDE device OK 2924566a494fSHeiko Schocher 52 common/cmd_nand.c before loading a Image from a NAND device 2925566a494fSHeiko Schocher -53 common/cmd_nand.c Bad usage of "nand" command 2926566a494fSHeiko Schocher 53 common/cmd_nand.c correct usage of "nand" command 2927566a494fSHeiko Schocher -54 common/cmd_nand.c No boot device 2928566a494fSHeiko Schocher 54 common/cmd_nand.c boot device found 2929566a494fSHeiko Schocher -55 common/cmd_nand.c Unknown Chip ID on boot device 2930566a494fSHeiko Schocher 55 common/cmd_nand.c correct chip ID found, device available 2931566a494fSHeiko Schocher -56 common/cmd_nand.c Error reading Image Header on boot device 2932566a494fSHeiko Schocher 56 common/cmd_nand.c reading Image Header from NAND device OK 2933566a494fSHeiko Schocher -57 common/cmd_nand.c Image header has bad magic number 2934566a494fSHeiko Schocher 57 common/cmd_nand.c Image header has correct magic number 2935566a494fSHeiko Schocher -58 common/cmd_nand.c Error reading Image from NAND device 2936566a494fSHeiko Schocher 58 common/cmd_nand.c reading Image from NAND device OK 2937c609719bSwdenk 2938566a494fSHeiko Schocher -60 common/env_common.c Environment has a bad CRC, using default 2939c609719bSwdenk 2940566a494fSHeiko Schocher 64 net/eth.c starting with Ethernet configuration. 2941566a494fSHeiko Schocher -64 net/eth.c no Ethernet found. 2942566a494fSHeiko Schocher 65 net/eth.c Ethernet found. 2943206c60cbSwdenk 2944566a494fSHeiko Schocher -80 common/cmd_net.c usage wrong 2945566a494fSHeiko Schocher 80 common/cmd_net.c before calling NetLoop() 294611ccc33fSMarcel Ziswiler -81 common/cmd_net.c some error in NetLoop() occurred 2947566a494fSHeiko Schocher 81 common/cmd_net.c NetLoop() back without error 2948566a494fSHeiko Schocher -82 common/cmd_net.c size == 0 (File with size 0 loaded) 2949566a494fSHeiko Schocher 82 common/cmd_net.c trying automatic boot 295074de7aefSWolfgang Denk 83 common/cmd_net.c running "source" command 295174de7aefSWolfgang Denk -83 common/cmd_net.c some error in automatic boot or "source" command 2952566a494fSHeiko Schocher 84 common/cmd_net.c end without errors 2953c609719bSwdenk 29541372cce2SMarian BalakowiczFIT uImage format: 29551372cce2SMarian Balakowicz 29561372cce2SMarian Balakowicz Arg Where When 29571372cce2SMarian Balakowicz 100 common/cmd_bootm.c Kernel FIT Image has correct format 29581372cce2SMarian Balakowicz -100 common/cmd_bootm.c Kernel FIT Image has incorrect format 29591372cce2SMarian Balakowicz 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration 29601372cce2SMarian Balakowicz -101 common/cmd_bootm.c Can't get configuration for kernel subimage 29611372cce2SMarian Balakowicz 102 common/cmd_bootm.c Kernel unit name specified 29621372cce2SMarian Balakowicz -103 common/cmd_bootm.c Can't get kernel subimage node offset 2963f773bea8SMarian Balakowicz 103 common/cmd_bootm.c Found configuration node 29641372cce2SMarian Balakowicz 104 common/cmd_bootm.c Got kernel subimage node offset 29651372cce2SMarian Balakowicz -104 common/cmd_bootm.c Kernel subimage hash verification failed 29661372cce2SMarian Balakowicz 105 common/cmd_bootm.c Kernel subimage hash verification OK 29671372cce2SMarian Balakowicz -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture 29681372cce2SMarian Balakowicz 106 common/cmd_bootm.c Architecture check OK 296911ccc33fSMarcel Ziswiler -106 common/cmd_bootm.c Kernel subimage has wrong type 297011ccc33fSMarcel Ziswiler 107 common/cmd_bootm.c Kernel subimage type OK 29711372cce2SMarian Balakowicz -107 common/cmd_bootm.c Can't get kernel subimage data/size 29721372cce2SMarian Balakowicz 108 common/cmd_bootm.c Got kernel subimage data/size 29731372cce2SMarian Balakowicz -108 common/cmd_bootm.c Wrong image type (not legacy, FIT) 29741372cce2SMarian Balakowicz -109 common/cmd_bootm.c Can't get kernel subimage type 29751372cce2SMarian Balakowicz -110 common/cmd_bootm.c Can't get kernel subimage comp 29761372cce2SMarian Balakowicz -111 common/cmd_bootm.c Can't get kernel subimage os 29771372cce2SMarian Balakowicz -112 common/cmd_bootm.c Can't get kernel subimage load address 29781372cce2SMarian Balakowicz -113 common/cmd_bootm.c Image uncompress/copy overwrite error 29791372cce2SMarian Balakowicz 29801372cce2SMarian Balakowicz 120 common/image.c Start initial ramdisk verification 29811372cce2SMarian Balakowicz -120 common/image.c Ramdisk FIT image has incorrect format 29821372cce2SMarian Balakowicz 121 common/image.c Ramdisk FIT image has correct format 298311ccc33fSMarcel Ziswiler 122 common/image.c No ramdisk subimage unit name, using configuration 29841372cce2SMarian Balakowicz -122 common/image.c Can't get configuration for ramdisk subimage 29851372cce2SMarian Balakowicz 123 common/image.c Ramdisk unit name specified 29861372cce2SMarian Balakowicz -124 common/image.c Can't get ramdisk subimage node offset 29871372cce2SMarian Balakowicz 125 common/image.c Got ramdisk subimage node offset 29881372cce2SMarian Balakowicz -125 common/image.c Ramdisk subimage hash verification failed 29891372cce2SMarian Balakowicz 126 common/image.c Ramdisk subimage hash verification OK 29901372cce2SMarian Balakowicz -126 common/image.c Ramdisk subimage for unsupported architecture 29911372cce2SMarian Balakowicz 127 common/image.c Architecture check OK 29921372cce2SMarian Balakowicz -127 common/image.c Can't get ramdisk subimage data/size 29931372cce2SMarian Balakowicz 128 common/image.c Got ramdisk subimage data/size 29941372cce2SMarian Balakowicz 129 common/image.c Can't get ramdisk load address 29951372cce2SMarian Balakowicz -129 common/image.c Got ramdisk load address 29961372cce2SMarian Balakowicz 299711ccc33fSMarcel Ziswiler -130 common/cmd_doc.c Incorrect FIT image format 29981372cce2SMarian Balakowicz 131 common/cmd_doc.c FIT image format OK 29991372cce2SMarian Balakowicz 300011ccc33fSMarcel Ziswiler -140 common/cmd_ide.c Incorrect FIT image format 30011372cce2SMarian Balakowicz 141 common/cmd_ide.c FIT image format OK 30021372cce2SMarian Balakowicz 300311ccc33fSMarcel Ziswiler -150 common/cmd_nand.c Incorrect FIT image format 30041372cce2SMarian Balakowicz 151 common/cmd_nand.c FIT image format OK 30051372cce2SMarian Balakowicz 3006d95f6ec7SGabe Black- FIT image support: 3007d95f6ec7SGabe Black CONFIG_FIT 3008d95f6ec7SGabe Black Enable support for the FIT uImage format. 3009d95f6ec7SGabe Black 3010d95f6ec7SGabe Black CONFIG_FIT_BEST_MATCH 3011d95f6ec7SGabe Black When no configuration is explicitly selected, default to the 3012d95f6ec7SGabe Black one whose fdt's compatibility field best matches that of 3013d95f6ec7SGabe Black U-Boot itself. A match is considered "best" if it matches the 3014d95f6ec7SGabe Black most specific compatibility entry of U-Boot's fdt's root node. 3015d95f6ec7SGabe Black The order of entries in the configuration's fdt is ignored. 3016d95f6ec7SGabe Black 30173e569a6bSSimon Glass CONFIG_FIT_SIGNATURE 30183e569a6bSSimon Glass This option enables signature verification of FIT uImages, 30193e569a6bSSimon Glass using a hash signed and verified using RSA. See 30203e569a6bSSimon Glass doc/uImage.FIT/signature.txt for more details. 30213e569a6bSSimon Glass 30224cf2609bSWolfgang Denk- Standalone program support: 30234cf2609bSWolfgang Denk CONFIG_STANDALONE_LOAD_ADDR 30244cf2609bSWolfgang Denk 30256feff899SWolfgang Denk This option defines a board specific value for the 30266feff899SWolfgang Denk address where standalone program gets loaded, thus 30276feff899SWolfgang Denk overwriting the architecture dependent default 30284cf2609bSWolfgang Denk settings. 30294cf2609bSWolfgang Denk 30304cf2609bSWolfgang Denk- Frame Buffer Address: 30314cf2609bSWolfgang Denk CONFIG_FB_ADDR 30324cf2609bSWolfgang Denk 30334cf2609bSWolfgang Denk Define CONFIG_FB_ADDR if you want to use specific 303444a53b57SWolfgang Denk address for frame buffer. This is typically the case 303544a53b57SWolfgang Denk when using a graphics controller has separate video 303644a53b57SWolfgang Denk memory. U-Boot will then place the frame buffer at 303744a53b57SWolfgang Denk the given address instead of dynamically reserving it 303844a53b57SWolfgang Denk in system RAM by calling lcd_setmem(), which grabs 303944a53b57SWolfgang Denk the memory for the frame buffer depending on the 304044a53b57SWolfgang Denk configured panel size. 30414cf2609bSWolfgang Denk 30424cf2609bSWolfgang Denk Please see board_init_f function. 30434cf2609bSWolfgang Denk 3044cccfc2abSDetlev Zundel- Automatic software updates via TFTP server 3045cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP 3046cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP_CNT_MAX 3047cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP_MSEC_MAX 3048cccfc2abSDetlev Zundel 3049cccfc2abSDetlev Zundel These options enable and control the auto-update feature; 3050cccfc2abSDetlev Zundel for a more detailed description refer to doc/README.update. 3051cccfc2abSDetlev Zundel 3052cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support) 3053cccfc2abSDetlev Zundel CONFIG_MTD_DEVICE 3054cccfc2abSDetlev Zundel 3055cccfc2abSDetlev Zundel Adds the MTD device infrastructure from the Linux kernel. 3056cccfc2abSDetlev Zundel Needed for mtdparts command support. 3057cccfc2abSDetlev Zundel 3058cccfc2abSDetlev Zundel CONFIG_MTD_PARTITIONS 3059cccfc2abSDetlev Zundel 3060cccfc2abSDetlev Zundel Adds the MTD partitioning infrastructure from the Linux 3061cccfc2abSDetlev Zundel kernel. Needed for UBI support. 3062cccfc2abSDetlev Zundel 306370c219cdSJoe Hershberger- UBI support 306470c219cdSJoe Hershberger CONFIG_CMD_UBI 306570c219cdSJoe Hershberger 306670c219cdSJoe Hershberger Adds commands for interacting with MTD partitions formatted 306770c219cdSJoe Hershberger with the UBI flash translation layer 306870c219cdSJoe Hershberger 306970c219cdSJoe Hershberger Requires also defining CONFIG_RBTREE 307070c219cdSJoe Hershberger 3071147162daSJoe Hershberger CONFIG_UBI_SILENCE_MSG 3072147162daSJoe Hershberger 3073147162daSJoe Hershberger Make the verbose messages from UBI stop printing. This leaves 3074147162daSJoe Hershberger warnings and errors enabled. 3075147162daSJoe Hershberger 307670c219cdSJoe Hershberger- UBIFS support 307770c219cdSJoe Hershberger CONFIG_CMD_UBIFS 307870c219cdSJoe Hershberger 307970c219cdSJoe Hershberger Adds commands for interacting with UBI volumes formatted as 308070c219cdSJoe Hershberger UBIFS. UBIFS is read-only in u-boot. 308170c219cdSJoe Hershberger 308270c219cdSJoe Hershberger Requires UBI support as well as CONFIG_LZO 308370c219cdSJoe Hershberger 3084147162daSJoe Hershberger CONFIG_UBIFS_SILENCE_MSG 3085147162daSJoe Hershberger 3086147162daSJoe Hershberger Make the verbose messages from UBIFS stop printing. This leaves 3087147162daSJoe Hershberger warnings and errors enabled. 3088147162daSJoe Hershberger 30896a11cf48SDaniel Schwierzeck- SPL framework 30906a11cf48SDaniel Schwierzeck CONFIG_SPL 30916a11cf48SDaniel Schwierzeck Enable building of SPL globally. 30926a11cf48SDaniel Schwierzeck 309395579793STom Rini CONFIG_SPL_LDSCRIPT 309495579793STom Rini LDSCRIPT for linking the SPL binary. 309595579793STom Rini 30966ebc3461SAlbert ARIBAUD CONFIG_SPL_MAX_FOOTPRINT 30976ebc3461SAlbert ARIBAUD Maximum size in memory allocated to the SPL, BSS included. 30986ebc3461SAlbert ARIBAUD When defined, the linker checks that the actual memory 30996ebc3461SAlbert ARIBAUD used by SPL from _start to __bss_end does not exceed it. 31008960af8bSAlbert ARIBAUD CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE 31016ebc3461SAlbert ARIBAUD must not be both defined at the same time. 31026ebc3461SAlbert ARIBAUD 310395579793STom Rini CONFIG_SPL_MAX_SIZE 31046ebc3461SAlbert ARIBAUD Maximum size of the SPL image (text, data, rodata, and 31056ebc3461SAlbert ARIBAUD linker lists sections), BSS excluded. 31066ebc3461SAlbert ARIBAUD When defined, the linker checks that the actual size does 31076ebc3461SAlbert ARIBAUD not exceed it. 310895579793STom Rini 31096a11cf48SDaniel Schwierzeck CONFIG_SPL_TEXT_BASE 31106a11cf48SDaniel Schwierzeck TEXT_BASE for linking the SPL binary. 31116a11cf48SDaniel Schwierzeck 311294a45bb1SScott Wood CONFIG_SPL_RELOC_TEXT_BASE 311394a45bb1SScott Wood Address to relocate to. If unspecified, this is equal to 311494a45bb1SScott Wood CONFIG_SPL_TEXT_BASE (i.e. no relocation is done). 311594a45bb1SScott Wood 311695579793STom Rini CONFIG_SPL_BSS_START_ADDR 311795579793STom Rini Link address for the BSS within the SPL binary. 311895579793STom Rini 311995579793STom Rini CONFIG_SPL_BSS_MAX_SIZE 31206ebc3461SAlbert ARIBAUD Maximum size in memory allocated to the SPL BSS. 31216ebc3461SAlbert ARIBAUD When defined, the linker checks that the actual memory used 31226ebc3461SAlbert ARIBAUD by SPL from __bss_start to __bss_end does not exceed it. 31238960af8bSAlbert ARIBAUD CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE 31246ebc3461SAlbert ARIBAUD must not be both defined at the same time. 312595579793STom Rini 312695579793STom Rini CONFIG_SPL_STACK 312795579793STom Rini Adress of the start of the stack SPL will use 312895579793STom Rini 312994a45bb1SScott Wood CONFIG_SPL_RELOC_STACK 313094a45bb1SScott Wood Adress of the start of the stack SPL will use after 313194a45bb1SScott Wood relocation. If unspecified, this is equal to 313294a45bb1SScott Wood CONFIG_SPL_STACK. 313394a45bb1SScott Wood 313495579793STom Rini CONFIG_SYS_SPL_MALLOC_START 313595579793STom Rini Starting address of the malloc pool used in SPL. 313695579793STom Rini 313795579793STom Rini CONFIG_SYS_SPL_MALLOC_SIZE 313895579793STom Rini The size of the malloc pool used in SPL. 31396a11cf48SDaniel Schwierzeck 314047f7bcaeSTom Rini CONFIG_SPL_FRAMEWORK 314147f7bcaeSTom Rini Enable the SPL framework under common/. This framework 314247f7bcaeSTom Rini supports MMC, NAND and YMODEM loading of U-Boot and NAND 314347f7bcaeSTom Rini NAND loading of the Linux Kernel. 314447f7bcaeSTom Rini 3145861a86f4STom Rini CONFIG_SPL_DISPLAY_PRINT 3146861a86f4STom Rini For ARM, enable an optional function to print more information 3147861a86f4STom Rini about the running system. 3148861a86f4STom Rini 31494b919725SScott Wood CONFIG_SPL_INIT_MINIMAL 31504b919725SScott Wood Arch init code should be built for a very small image 31514b919725SScott Wood 31526a11cf48SDaniel Schwierzeck CONFIG_SPL_LIBCOMMON_SUPPORT 31536a11cf48SDaniel Schwierzeck Support for common/libcommon.o in SPL binary 31546a11cf48SDaniel Schwierzeck 31556a11cf48SDaniel Schwierzeck CONFIG_SPL_LIBDISK_SUPPORT 31566a11cf48SDaniel Schwierzeck Support for disk/libdisk.o in SPL binary 31576a11cf48SDaniel Schwierzeck 31586a11cf48SDaniel Schwierzeck CONFIG_SPL_I2C_SUPPORT 31596a11cf48SDaniel Schwierzeck Support for drivers/i2c/libi2c.o in SPL binary 31606a11cf48SDaniel Schwierzeck 31616a11cf48SDaniel Schwierzeck CONFIG_SPL_GPIO_SUPPORT 31626a11cf48SDaniel Schwierzeck Support for drivers/gpio/libgpio.o in SPL binary 31636a11cf48SDaniel Schwierzeck 31646a11cf48SDaniel Schwierzeck CONFIG_SPL_MMC_SUPPORT 31656a11cf48SDaniel Schwierzeck Support for drivers/mmc/libmmc.o in SPL binary 31666a11cf48SDaniel Schwierzeck 316795579793STom Rini CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR, 316895579793STom Rini CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS, 316995579793STom Rini CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION 317095579793STom Rini Address, size and partition on the MMC to load U-Boot from 317195579793STom Rini when the MMC is being used in raw mode. 317295579793STom Rini 31732b75b0adSPeter Korsgaard CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR 31742b75b0adSPeter Korsgaard Sector to load kernel uImage from when MMC is being 31752b75b0adSPeter Korsgaard used in raw mode (for Falcon mode) 31762b75b0adSPeter Korsgaard 31772b75b0adSPeter Korsgaard CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR, 31782b75b0adSPeter Korsgaard CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS 31792b75b0adSPeter Korsgaard Sector and number of sectors to load kernel argument 31802b75b0adSPeter Korsgaard parameters from when MMC is being used in raw mode 31812b75b0adSPeter Korsgaard (for falcon mode) 31822b75b0adSPeter Korsgaard 318395579793STom Rini CONFIG_SPL_FAT_SUPPORT 318495579793STom Rini Support for fs/fat/libfat.o in SPL binary 318595579793STom Rini 318695579793STom Rini CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME 318795579793STom Rini Filename to read to load U-Boot when reading from FAT 318895579793STom Rini 31897ad2cc79SPeter Korsgaard CONFIG_SPL_FAT_LOAD_KERNEL_NAME 31907ad2cc79SPeter Korsgaard Filename to read to load kernel uImage when reading 31917ad2cc79SPeter Korsgaard from FAT (for Falcon mode) 31927ad2cc79SPeter Korsgaard 31937ad2cc79SPeter Korsgaard CONFIG_SPL_FAT_LOAD_ARGS_NAME 31947ad2cc79SPeter Korsgaard Filename to read to load kernel argument parameters 31957ad2cc79SPeter Korsgaard when reading from FAT (for Falcon mode) 31967ad2cc79SPeter Korsgaard 319706f60ae3SScott Wood CONFIG_SPL_MPC83XX_WAIT_FOR_NAND 319806f60ae3SScott Wood Set this for NAND SPL on PPC mpc83xx targets, so that 319906f60ae3SScott Wood start.S waits for the rest of the SPL to load before 320006f60ae3SScott Wood continuing (the hardware starts execution after just 320106f60ae3SScott Wood loading the first page rather than the full 4K). 320206f60ae3SScott Wood 32036f2f01b9SScott Wood CONFIG_SPL_NAND_BASE 32046f2f01b9SScott Wood Include nand_base.c in the SPL. Requires 32056f2f01b9SScott Wood CONFIG_SPL_NAND_DRIVERS. 32066f2f01b9SScott Wood 32076f2f01b9SScott Wood CONFIG_SPL_NAND_DRIVERS 32086f2f01b9SScott Wood SPL uses normal NAND drivers, not minimal drivers. 32096f2f01b9SScott Wood 32106f2f01b9SScott Wood CONFIG_SPL_NAND_ECC 32116f2f01b9SScott Wood Include standard software ECC in the SPL 32126f2f01b9SScott Wood 321395579793STom Rini CONFIG_SPL_NAND_SIMPLE 32147d4b7955SScott Wood Support for NAND boot using simple NAND drivers that 32157d4b7955SScott Wood expose the cmd_ctrl() interface. 321695579793STom Rini 3217bb0dc108SYing Zhang CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT 3218bb0dc108SYing Zhang Set for the SPL on PPC mpc8xxx targets, support for 32195614e71bSYork Sun drivers/ddr/fsl/libddr.o in SPL binary. 3220bb0dc108SYing Zhang 32217c8eea59SYing Zhang CONFIG_SPL_COMMON_INIT_DDR 32227c8eea59SYing Zhang Set for common ddr init with serial presence detect in 32237c8eea59SYing Zhang SPL binary. 32247c8eea59SYing Zhang 322595579793STom Rini CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT, 322695579793STom Rini CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE, 322795579793STom Rini CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS, 322895579793STom Rini CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE, 322995579793STom Rini CONFIG_SYS_NAND_ECCBYTES 323095579793STom Rini Defines the size and behavior of the NAND that SPL uses 32317d4b7955SScott Wood to read U-Boot 323295579793STom Rini 323395579793STom Rini CONFIG_SYS_NAND_U_BOOT_OFFS 32347d4b7955SScott Wood Location in NAND to read U-Boot from 32357d4b7955SScott Wood 32367d4b7955SScott Wood CONFIG_SYS_NAND_U_BOOT_DST 32377d4b7955SScott Wood Location in memory to load U-Boot to 32387d4b7955SScott Wood 32397d4b7955SScott Wood CONFIG_SYS_NAND_U_BOOT_SIZE 32407d4b7955SScott Wood Size of image to load 324195579793STom Rini 324295579793STom Rini CONFIG_SYS_NAND_U_BOOT_START 32437d4b7955SScott Wood Entry point in loaded image to jump to 324495579793STom Rini 324595579793STom Rini CONFIG_SYS_NAND_HW_ECC_OOBFIRST 324695579793STom Rini Define this if you need to first read the OOB and then the 324795579793STom Rini data. This is used for example on davinci plattforms. 324895579793STom Rini 324995579793STom Rini CONFIG_SPL_OMAP3_ID_NAND 325095579793STom Rini Support for an OMAP3-specific set of functions to return the 325195579793STom Rini ID and MFR of the first attached NAND chip, if present. 325295579793STom Rini 32536a11cf48SDaniel Schwierzeck CONFIG_SPL_SERIAL_SUPPORT 32546a11cf48SDaniel Schwierzeck Support for drivers/serial/libserial.o in SPL binary 32556a11cf48SDaniel Schwierzeck 32566a11cf48SDaniel Schwierzeck CONFIG_SPL_SPI_FLASH_SUPPORT 32576a11cf48SDaniel Schwierzeck Support for drivers/mtd/spi/libspi_flash.o in SPL binary 32586a11cf48SDaniel Schwierzeck 32596a11cf48SDaniel Schwierzeck CONFIG_SPL_SPI_SUPPORT 32606a11cf48SDaniel Schwierzeck Support for drivers/spi/libspi.o in SPL binary 32616a11cf48SDaniel Schwierzeck 3262c57b953dSPavel Machek CONFIG_SPL_RAM_DEVICE 3263c57b953dSPavel Machek Support for running image already present in ram, in SPL binary 3264c57b953dSPavel Machek 32656a11cf48SDaniel Schwierzeck CONFIG_SPL_LIBGENERIC_SUPPORT 32666a11cf48SDaniel Schwierzeck Support for lib/libgeneric.o in SPL binary 32671372cce2SMarian Balakowicz 3268ba1bee43SYing Zhang CONFIG_SPL_ENV_SUPPORT 3269ba1bee43SYing Zhang Support for the environment operating in SPL binary 3270ba1bee43SYing Zhang 3271ba1bee43SYing Zhang CONFIG_SPL_NET_SUPPORT 3272ba1bee43SYing Zhang Support for the net/libnet.o in SPL binary. 3273ba1bee43SYing Zhang It conflicts with SPL env from storage medium specified by 3274ba1bee43SYing Zhang CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE 3275ba1bee43SYing Zhang 327674752baaSScott Wood CONFIG_SPL_PAD_TO 32776113d3f2SBenoît Thébaudeau Image offset to which the SPL should be padded before appending 32786113d3f2SBenoît Thébaudeau the SPL payload. By default, this is defined as 32796113d3f2SBenoît Thébaudeau CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined. 32806113d3f2SBenoît Thébaudeau CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL 32816113d3f2SBenoît Thébaudeau payload without any padding, or >= CONFIG_SPL_MAX_SIZE. 328274752baaSScott Wood 3283ca2fca22SScott Wood CONFIG_SPL_TARGET 3284ca2fca22SScott Wood Final target image containing SPL and payload. Some SPLs 3285ca2fca22SScott Wood use an arch-specific makefile fragment instead, for 3286ca2fca22SScott Wood example if more than one image needs to be produced. 3287ca2fca22SScott Wood 328887ebee39SSimon Glass CONFIG_FIT_SPL_PRINT 328987ebee39SSimon Glass Printing information about a FIT image adds quite a bit of 329087ebee39SSimon Glass code to SPL. So this is normally disabled in SPL. Use this 329187ebee39SSimon Glass option to re-enable it. This will affect the output of the 329287ebee39SSimon Glass bootm command when booting a FIT image. 329387ebee39SSimon Glass 32943aa29de0SYing Zhang- TPL framework 32953aa29de0SYing Zhang CONFIG_TPL 32963aa29de0SYing Zhang Enable building of TPL globally. 32973aa29de0SYing Zhang 32983aa29de0SYing Zhang CONFIG_TPL_PAD_TO 32993aa29de0SYing Zhang Image offset to which the TPL should be padded before appending 33003aa29de0SYing Zhang the TPL payload. By default, this is defined as 33013aa29de0SYing Zhang CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined. 33023aa29de0SYing Zhang CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL 33033aa29de0SYing Zhang payload without any padding, or >= CONFIG_SPL_MAX_SIZE. 33043aa29de0SYing Zhang 3305c609719bSwdenkModem Support: 3306c609719bSwdenk-------------- 3307c609719bSwdenk 3308566e5cf4SWolfgang Denk[so far only for SMDK2400 boards] 3309c609719bSwdenk 331011ccc33fSMarcel Ziswiler- Modem support enable: 3311c609719bSwdenk CONFIG_MODEM_SUPPORT 3312c609719bSwdenk 3313c609719bSwdenk- RTS/CTS Flow control enable: 3314c609719bSwdenk CONFIG_HWFLOW 3315c609719bSwdenk 3316c609719bSwdenk- Modem debug support: 3317c609719bSwdenk CONFIG_MODEM_SUPPORT_DEBUG 3318c609719bSwdenk 3319c609719bSwdenk Enables debugging stuff (char screen[1024], dbg()) 3320c609719bSwdenk for modem support. Useful only with BDI2000. 3321c609719bSwdenk 3322a8c7c708Swdenk- Interrupt support (PPC): 3323a8c7c708Swdenk 3324a8c7c708Swdenk There are common interrupt_init() and timer_interrupt() 3325a8c7c708Swdenk for all PPC archs. interrupt_init() calls interrupt_init_cpu() 332611ccc33fSMarcel Ziswiler for CPU specific initialization. interrupt_init_cpu() 3327a8c7c708Swdenk should set decrementer_count to appropriate value. If 332811ccc33fSMarcel Ziswiler CPU resets decrementer automatically after interrupt 3329a8c7c708Swdenk (ppc4xx) it should set decrementer_count to zero. 333011ccc33fSMarcel Ziswiler timer_interrupt() calls timer_interrupt_cpu() for CPU 3331a8c7c708Swdenk specific handling. If board has watchdog / status_led 3332a8c7c708Swdenk / other_activity_monitor it works automatically from 3333a8c7c708Swdenk general timer_interrupt(). 3334a8c7c708Swdenk 3335c609719bSwdenk- General: 3336c609719bSwdenk 3337c609719bSwdenk In the target system modem support is enabled when a 3338c609719bSwdenk specific key (key combination) is pressed during 3339c609719bSwdenk power-on. Otherwise U-Boot will boot normally 334011ccc33fSMarcel Ziswiler (autoboot). The key_pressed() function is called from 3341c609719bSwdenk board_init(). Currently key_pressed() is a dummy 3342c609719bSwdenk function, returning 1 and thus enabling modem 3343c609719bSwdenk initialization. 3344c609719bSwdenk 3345c609719bSwdenk If there are no modem init strings in the 3346c609719bSwdenk environment, U-Boot proceed to autoboot; the 3347c609719bSwdenk previous output (banner, info printfs) will be 334811ccc33fSMarcel Ziswiler suppressed, though. 3349c609719bSwdenk 3350c609719bSwdenk See also: doc/README.Modem 3351c609719bSwdenk 33529660e442SHelmut RaigerBoard initialization settings: 33539660e442SHelmut Raiger------------------------------ 33549660e442SHelmut Raiger 33559660e442SHelmut RaigerDuring Initialization u-boot calls a number of board specific functions 33569660e442SHelmut Raigerto allow the preparation of board specific prerequisites, e.g. pin setup 33579660e442SHelmut Raigerbefore drivers are initialized. To enable these callbacks the 33589660e442SHelmut Raigerfollowing configuration macros have to be defined. Currently this is 33599660e442SHelmut Raigerarchitecture specific, so please check arch/your_architecture/lib/board.c 33609660e442SHelmut Raigertypically in board_init_f() and board_init_r(). 33619660e442SHelmut Raiger 33629660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f() 33639660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r() 33649660e442SHelmut Raiger- CONFIG_BOARD_LATE_INIT: Call board_late_init() 33659660e442SHelmut Raiger- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init() 3366c609719bSwdenk 3367c609719bSwdenkConfiguration Settings: 3368c609719bSwdenk----------------------- 3369c609719bSwdenk 33706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included; 3371c609719bSwdenk undefine this when you're short of memory. 3372c609719bSwdenk 33732fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default 33742fb2604dSPeter Tyser width of the commands listed in the 'help' command output. 33752fb2604dSPeter Tyser 33766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to 3377c609719bSwdenk prompt for user input. 3378c609719bSwdenk 33796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE: Buffer size for input from the Console 3380c609719bSwdenk 33816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE: Buffer size for Console output 3382c609719bSwdenk 33836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands 3384c609719bSwdenk 33856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to 3386c609719bSwdenk the application (usually a Linux kernel) when it is 3387c609719bSwdenk booted 3388c609719bSwdenk 33896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE: 3390c609719bSwdenk List of legal baudrate settings for this board. 3391c609719bSwdenk 33926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET 3393c609719bSwdenk Suppress display of console information at boot. 3394c609719bSwdenk 33956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV 3396c609719bSwdenk If the board specific function 3397c609719bSwdenk extern int overwrite_console (void); 3398c609719bSwdenk returns 1, the stdin, stderr and stdout are switched to the 3399c609719bSwdenk serial port, else the settings in the environment are used. 3400c609719bSwdenk 34016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE 3402c609719bSwdenk Enable the call to overwrite_console(). 3403c609719bSwdenk 34046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE 3405c609719bSwdenk Enable overwrite of previous console environment settings. 3406c609719bSwdenk 34076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END: 3408c609719bSwdenk Begin and End addresses of the area used by the 3409c609719bSwdenk simple memory test. 3410c609719bSwdenk 34116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST: 3412c609719bSwdenk Enable an alternate, more extensive memory test. 3413c609719bSwdenk 34146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH: 34155f535fe1Swdenk Scratch address used by the alternate memory test 34165f535fe1Swdenk You only need to set this if address zero isn't writeable 34175f535fe1Swdenk 34186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only): 34196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header, 342014f73ca6SStefan Roese this specified memory area will get subtracted from the top 342111ccc33fSMarcel Ziswiler (end) of RAM and won't get "touched" at all by U-Boot. By 342214f73ca6SStefan Roese fixing up gd->ram_size the Linux kernel should gets passed 342314f73ca6SStefan Roese the now "corrected" memory size and won't touch it either. 342414f73ca6SStefan Roese This should work for arch/ppc and arch/powerpc. Only Linux 34255e12e75dSStefan Roese board ports in arch/powerpc with bootwrapper support that 342614f73ca6SStefan Roese recalculate the memory size from the SDRAM controller setup 34275e12e75dSStefan Roese will have to get fixed in Linux additionally. 342814f73ca6SStefan Roese 342914f73ca6SStefan Roese This option can be used as a workaround for the 440EPx/GRx 343014f73ca6SStefan Roese CHIP 11 errata where the last 256 bytes in SDRAM shouldn't 343114f73ca6SStefan Roese be touched. 343214f73ca6SStefan Roese 343314f73ca6SStefan Roese WARNING: Please make sure that this value is a multiple of 343414f73ca6SStefan Roese the Linux page size (normally 4k). If this is not the case, 343514f73ca6SStefan Roese then the end address of the Linux memory will be located at a 343614f73ca6SStefan Roese non page size aligned address and this could cause major 343714f73ca6SStefan Roese problems. 343814f73ca6SStefan Roese 34396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE: 3440c609719bSwdenk Enable temporary baudrate change while serial download 3441c609719bSwdenk 34426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE: 3443c609719bSwdenk Physical start address of SDRAM. _Must_ be 0 here. 3444c609719bSwdenk 34456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE: 3446c609719bSwdenk Physical start address of Motherboard I/O (if using a 3447c609719bSwdenk Cogent motherboard) 3448c609719bSwdenk 34496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE: 3450c609719bSwdenk Physical start address of Flash memory. 3451c609719bSwdenk 34526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE: 3453c609719bSwdenk Physical start address of boot monitor code (set by 3454c609719bSwdenk make config files to be same as the text base address 345514d0a02aSWolfgang Denk (CONFIG_SYS_TEXT_BASE) used when linking) - same as 34566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FLASH_BASE when booting from flash. 3457c609719bSwdenk 34586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN: 34593b57fe0aSwdenk Size of memory reserved for monitor code, used to 34603b57fe0aSwdenk determine _at_compile_time_ (!) if the environment is 34613b57fe0aSwdenk embedded within the U-Boot image, or in a separate 34623b57fe0aSwdenk flash sector. 3463c609719bSwdenk 34646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN: 3465c609719bSwdenk Size of DRAM reserved for malloc() use. 3466c609719bSwdenk 34676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN: 346815940c9aSStefan Roese Normally compressed uImages are limited to an 346915940c9aSStefan Roese uncompressed size of 8 MBytes. If this is not enough, 34706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD you can define CONFIG_SYS_BOOTM_LEN in your board config file 347115940c9aSStefan Roese to adjust this setting to your needs. 3472c609719bSwdenk 34736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ: 3474c609719bSwdenk Maximum size of memory mapped by the startup code of 3475c609719bSwdenk the Linux kernel; all data that must be processed by 34767d721e34SBartlomiej Sieka the Linux kernel (bd_info, boot arguments, FDT blob if 34777d721e34SBartlomiej Sieka used) must be put below this limit, unless "bootm_low" 34781bce2aebSRobert P. J. Day environment variable is defined and non-zero. In such case 34797d721e34SBartlomiej Sieka all data for the Linux kernel must be between "bootm_low" 3480c3624e6eSGrant Likely and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment 3481c3624e6eSGrant Likely variable "bootm_mapsize" will override the value of 3482c3624e6eSGrant Likely CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined, 3483c3624e6eSGrant Likely then the value in "bootm_size" will be used instead. 3484c609719bSwdenk 3485fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH: 3486fca43cc8SJohn Rigby Enable initrd_high functionality. If defined then the 3487fca43cc8SJohn Rigby initrd_high feature is enabled and the bootm ramdisk subcommand 3488fca43cc8SJohn Rigby is enabled. 3489fca43cc8SJohn Rigby 3490fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE: 3491fca43cc8SJohn Rigby Enables allocating and saving kernel cmdline in space between 3492fca43cc8SJohn Rigby "bootm_low" and "bootm_low" + BOOTMAPSZ. 3493fca43cc8SJohn Rigby 3494fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD: 3495fca43cc8SJohn Rigby Enables allocating and saving a kernel copy of the bd_info in 3496fca43cc8SJohn Rigby space between "bootm_low" and "bootm_low" + BOOTMAPSZ. 3497fca43cc8SJohn Rigby 34986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS: 3499c609719bSwdenk Max number of Flash memory banks 3500c609719bSwdenk 35016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT: 3502c609719bSwdenk Max number of sectors on a Flash chip 3503c609719bSwdenk 35046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT: 3505c609719bSwdenk Timeout for Flash erase operations (in ms) 3506c609719bSwdenk 35076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT: 3508c609719bSwdenk Timeout for Flash write operations (in ms) 3509c609719bSwdenk 35106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT 35118564acf9Swdenk Timeout for Flash set sector lock bit operation (in ms) 35128564acf9Swdenk 35136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT 35148564acf9Swdenk Timeout for Flash clear lock bits operation (in ms) 35158564acf9Swdenk 35166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION 35178564acf9Swdenk If defined, hardware flash sectors protection is used 35188564acf9Swdenk instead of U-Boot software protection. 35198564acf9Swdenk 35206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP: 3521c609719bSwdenk 3522c609719bSwdenk Enable TFTP transfers directly to flash memory; 3523c609719bSwdenk without this option such a download has to be 3524c609719bSwdenk performed in two steps: (1) download to RAM, and (2) 3525c609719bSwdenk copy from RAM to flash. 3526c609719bSwdenk 3527c609719bSwdenk The two-step approach is usually more reliable, since 3528c609719bSwdenk you can check if the download worked before you erase 352911ccc33fSMarcel Ziswiler the flash, but in some situations (when system RAM is 353011ccc33fSMarcel Ziswiler too limited to allow for a temporary copy of the 3531c609719bSwdenk downloaded image) this option may be very useful. 3532c609719bSwdenk 35336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI: 3534c609719bSwdenk Define if the flash driver uses extra elements in the 35355653fc33Swdenk common flash structure for storing flash geometry. 35365653fc33Swdenk 353700b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER 35385653fc33Swdenk This option also enables the building of the cfi_flash driver 35395653fc33Swdenk in the drivers directory 354053cf9435Sstroese 354191809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD 354291809ed5SPiotr Ziecik This option enables the building of the cfi_mtd driver 354391809ed5SPiotr Ziecik in the drivers directory. The driver exports CFI flash 354491809ed5SPiotr Ziecik to the MTD layer. 354591809ed5SPiotr Ziecik 35466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE 354796ef831fSGuennadi Liakhovetski Use buffered writes to flash. 354896ef831fSGuennadi Liakhovetski 354996ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N 355096ef831fSGuennadi Liakhovetski s29ws-n MirrorBit flash has non-standard addresses for buffered 355196ef831fSGuennadi Liakhovetski write commands. 355296ef831fSGuennadi Liakhovetski 35536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST 35545568e613SStefan Roese If this option is defined, the common CFI flash doesn't 35555568e613SStefan Roese print it's warning upon not recognized FLASH banks. This 35565568e613SStefan Roese is useful, if some of the configured banks are only 35575568e613SStefan Roese optionally available. 35585568e613SStefan Roese 35599a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS 35609a042e9cSJerry Van Baren If defined (must be an integer), print out countdown 35619a042e9cSJerry Van Baren digits and dots. Recommended value: 45 (9..1) for 80 35629a042e9cSJerry Van Baren column displays, 15 (3..1) for 40 column displays. 35639a042e9cSJerry Van Baren 3564352ef3f1SStefan Roese- CONFIG_FLASH_VERIFY 3565352ef3f1SStefan Roese If defined, the content of the flash (destination) is compared 3566352ef3f1SStefan Roese against the source after the write operation. An error message 3567352ef3f1SStefan Roese will be printed when the contents are not identical. 3568352ef3f1SStefan Roese Please note that this option is useless in nearly all cases, 3569352ef3f1SStefan Roese since such flash programming errors usually are detected earlier 3570352ef3f1SStefan Roese while unprotecting/erasing/programming. Please only enable 3571352ef3f1SStefan Roese this option if you really know what you are doing. 3572352ef3f1SStefan Roese 35736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER: 357411ccc33fSMarcel Ziswiler Defines the number of Ethernet receive buffers. On some 357511ccc33fSMarcel Ziswiler Ethernet controllers it is recommended to set this value 357653cf9435Sstroese to 8 or even higher (EEPRO100 or 405 EMAC), since all 357753cf9435Sstroese buffers can be full shortly after enabling the interface 357811ccc33fSMarcel Ziswiler on high Ethernet traffic. 357953cf9435Sstroese Defaults to 4 if not defined. 3580c609719bSwdenk 3581ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES 3582ea882bafSWolfgang Denk 3583ea882bafSWolfgang Denk Maximum number of entries in the hash table that is used 3584ea882bafSWolfgang Denk internally to store the environment settings. The default 3585ea882bafSWolfgang Denk setting is supposed to be generous and should work in most 3586ea882bafSWolfgang Denk cases. This setting can be used to tune behaviour; see 3587ea882bafSWolfgang Denk lib/hashtable.c for details. 3588ea882bafSWolfgang Denk 35892598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_DEFAULT 35902598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_STATIC 35911bce2aebSRobert P. J. Day Enable validation of the values given to environment variables when 35922598090bSJoe Hershberger calling env set. Variables can be restricted to only decimal, 35932598090bSJoe Hershberger hexadecimal, or boolean. If CONFIG_CMD_NET is also defined, 35942598090bSJoe Hershberger the variables can also be restricted to IP address or MAC address. 35952598090bSJoe Hershberger 35962598090bSJoe Hershberger The format of the list is: 35972598090bSJoe Hershberger type_attribute = [s|d|x|b|i|m] 3598267541f7SJoe Hershberger access_atribute = [a|r|o|c] 3599267541f7SJoe Hershberger attributes = type_attribute[access_atribute] 36002598090bSJoe Hershberger entry = variable_name[:attributes] 36012598090bSJoe Hershberger list = entry[,list] 36022598090bSJoe Hershberger 36032598090bSJoe Hershberger The type attributes are: 36042598090bSJoe Hershberger s - String (default) 36052598090bSJoe Hershberger d - Decimal 36062598090bSJoe Hershberger x - Hexadecimal 36072598090bSJoe Hershberger b - Boolean ([1yYtT|0nNfF]) 36082598090bSJoe Hershberger i - IP address 36092598090bSJoe Hershberger m - MAC address 36102598090bSJoe Hershberger 3611267541f7SJoe Hershberger The access attributes are: 3612267541f7SJoe Hershberger a - Any (default) 3613267541f7SJoe Hershberger r - Read-only 3614267541f7SJoe Hershberger o - Write-once 3615267541f7SJoe Hershberger c - Change-default 3616267541f7SJoe Hershberger 36172598090bSJoe Hershberger - CONFIG_ENV_FLAGS_LIST_DEFAULT 36182598090bSJoe Hershberger Define this to a list (string) to define the ".flags" 36192598090bSJoe Hershberger envirnoment variable in the default or embedded environment. 36202598090bSJoe Hershberger 36212598090bSJoe Hershberger - CONFIG_ENV_FLAGS_LIST_STATIC 36222598090bSJoe Hershberger Define this to a list (string) to define validation that 36232598090bSJoe Hershberger should be done if an entry is not found in the ".flags" 36242598090bSJoe Hershberger environment variable. To override a setting in the static 36252598090bSJoe Hershberger list, simply add an entry for the same variable name to the 36262598090bSJoe Hershberger ".flags" variable. 36272598090bSJoe Hershberger 3628267541f7SJoe Hershberger- CONFIG_ENV_ACCESS_IGNORE_FORCE 3629267541f7SJoe Hershberger If defined, don't allow the -f switch to env set override variable 3630267541f7SJoe Hershberger access flags. 3631267541f7SJoe Hershberger 36325c1a7ea6SSimon Glass- CONFIG_SYS_GENERIC_BOARD 36335c1a7ea6SSimon Glass This selects the architecture-generic board system instead of the 36345c1a7ea6SSimon Glass architecture-specific board files. It is intended to move boards 36355c1a7ea6SSimon Glass to this new framework over time. Defining this will disable the 36365c1a7ea6SSimon Glass arch/foo/lib/board.c file and use common/board_f.c and 36375c1a7ea6SSimon Glass common/board_r.c instead. To use this option your architecture 36385c1a7ea6SSimon Glass must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in 36395c1a7ea6SSimon Glass its config.mk file). If you find problems enabling this option on 36405c1a7ea6SSimon Glass your board please report the problem and send patches! 36415c1a7ea6SSimon Glass 3642632efa74SSimon Glass- CONFIG_SYS_SYM_OFFSETS 3643632efa74SSimon Glass This is set by architectures that use offsets for link symbols 3644632efa74SSimon Glass instead of absolute values. So bss_start is obtained using an 3645632efa74SSimon Glass offset _bss_start_ofs from CONFIG_SYS_TEXT_BASE, rather than 3646632efa74SSimon Glass directly. You should not need to touch this setting. 3647632efa74SSimon Glass 36480b1b60c7SLokesh Vutla- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only) 36490b1b60c7SLokesh Vutla This is set by OMAP boards for the max time that reset should 36500b1b60c7SLokesh Vutla be asserted. See doc/README.omap-reset-time for details on how 36510b1b60c7SLokesh Vutla the value can be calulated on a given board. 3652632efa74SSimon Glass 3653c609719bSwdenkThe following definitions that deal with the placement and management 3654c609719bSwdenkof environment data (variable area); in general, we support the 3655c609719bSwdenkfollowing configurations: 3656c609719bSwdenk 3657c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC: 3658c3eb3fe4SMike Frysinger 3659c3eb3fe4SMike Frysinger Builds up envcrc with the target environment so that external utils 3660c3eb3fe4SMike Frysinger may easily extract it and embed it in final U-Boot images. 3661c3eb3fe4SMike Frysinger 36625a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH: 3663c609719bSwdenk 3664c609719bSwdenk Define this if the environment is in flash memory. 3665c609719bSwdenk 3666c609719bSwdenk a) The environment occupies one whole flash sector, which is 3667c609719bSwdenk "embedded" in the text segment with the U-Boot code. This 3668c609719bSwdenk happens usually with "bottom boot sector" or "top boot 3669c609719bSwdenk sector" type flash chips, which have several smaller 3670c609719bSwdenk sectors at the start or the end. For instance, such a 3671c609719bSwdenk layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In 3672c609719bSwdenk such a case you would place the environment in one of the 3673c609719bSwdenk 4 kB sectors - with U-Boot code before and after it. With 3674c609719bSwdenk "top boot sector" type flash chips, you would put the 3675c609719bSwdenk environment in one of the last sectors, leaving a gap 3676c609719bSwdenk between U-Boot and the environment. 3677c609719bSwdenk 36780e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 3679c609719bSwdenk 3680c609719bSwdenk Offset of environment data (variable area) to the 3681c609719bSwdenk beginning of flash memory; for instance, with bottom boot 3682c609719bSwdenk type flash chips the second sector can be used: the offset 3683c609719bSwdenk for this sector is given here. 3684c609719bSwdenk 36856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE. 3686c609719bSwdenk 36870e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 3688c609719bSwdenk 3689c609719bSwdenk This is just another way to specify the start address of 3690c609719bSwdenk the flash sector containing the environment (instead of 36910e8d1586SJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_OFFSET). 3692c609719bSwdenk 36930e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SECT_SIZE: 3694c609719bSwdenk 3695c609719bSwdenk Size of the sector containing the environment. 3696c609719bSwdenk 3697c609719bSwdenk 3698c609719bSwdenk b) Sometimes flash chips have few, equal sized, BIG sectors. 3699c609719bSwdenk In such a case you don't want to spend a whole sector for 3700c609719bSwdenk the environment. 3701c609719bSwdenk 37020e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 3703c609719bSwdenk 37045a1aceb0SJean-Christophe PLAGNIOL-VILLARD If you use this in combination with CONFIG_ENV_IS_IN_FLASH 37050e8d1586SJean-Christophe PLAGNIOL-VILLARD and CONFIG_ENV_SECT_SIZE, you can specify to use only a part 3706c609719bSwdenk of this flash sector for the environment. This saves 3707c609719bSwdenk memory for the RAM copy of the environment. 3708c609719bSwdenk 3709c609719bSwdenk It may also save flash memory if you decide to use this 3710c609719bSwdenk when your environment is "embedded" within U-Boot code, 3711c609719bSwdenk since then the remainder of the flash sector could be used 3712c609719bSwdenk for U-Boot code. It should be pointed out that this is 3713c609719bSwdenk STRONGLY DISCOURAGED from a robustness point of view: 3714c609719bSwdenk updating the environment in flash makes it always 3715c609719bSwdenk necessary to erase the WHOLE sector. If something goes 3716c609719bSwdenk wrong before the contents has been restored from a copy in 3717c609719bSwdenk RAM, your target system will be dead. 3718c609719bSwdenk 37190e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR_REDUND 37200e8d1586SJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_SIZE_REDUND 3721c609719bSwdenk 3722c609719bSwdenk These settings describe a second storage area used to hold 372311ccc33fSMarcel Ziswiler a redundant copy of the environment data, so that there is 37243e38691eSwdenk a valid backup copy in case there is a power failure during 3725c609719bSwdenk a "saveenv" operation. 3726c609719bSwdenk 3727c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the 3728c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds* 3729c609719bSwdenkaccordingly! 3730c609719bSwdenk 3731c609719bSwdenk 37329314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM: 3733c609719bSwdenk 3734c609719bSwdenk Define this if you have some non-volatile memory device 3735c609719bSwdenk (NVRAM, battery buffered SRAM) which you want to use for the 3736c609719bSwdenk environment. 3737c609719bSwdenk 37380e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 37390e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 3740c609719bSwdenk 374111ccc33fSMarcel Ziswiler These two #defines are used to determine the memory area you 3742c609719bSwdenk want to use for environment. It is assumed that this memory 3743c609719bSwdenk can just be read and written to, without any special 3744c609719bSwdenk provision. 3745c609719bSwdenk 3746c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early 3747c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the 374811ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or 3749c609719bSwdenkU-Boot will hang. 3750c609719bSwdenk 3751c609719bSwdenkPlease note that even with NVRAM we still use a copy of the 3752c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to 3753c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv" 3754c609719bSwdenkto save the current settings. 3755c609719bSwdenk 3756c609719bSwdenk 3757bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM: 3758c609719bSwdenk 3759c609719bSwdenk Use this if you have an EEPROM or similar serial access 3760c609719bSwdenk device and a driver for it. 3761c609719bSwdenk 37620e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 37630e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 3764c609719bSwdenk 3765c609719bSwdenk These two #defines specify the offset and size of the 3766c609719bSwdenk environment area within the total memory of your EEPROM. 3767c609719bSwdenk 37686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR: 3769c609719bSwdenk If defined, specified the chip address of the EEPROM device. 3770c609719bSwdenk The default address is zero. 3771c609719bSwdenk 37726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS: 3773c609719bSwdenk If defined, the number of bits used to address bytes in a 3774c609719bSwdenk single page in the EEPROM device. A 64 byte page, for example 3775c609719bSwdenk would require six bits. 3776c609719bSwdenk 37776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS: 3778c609719bSwdenk If defined, the number of milliseconds to delay between 3779c609719bSwdenk page writes. The default is zero milliseconds. 3780c609719bSwdenk 37816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR_LEN: 3782c609719bSwdenk The length in bytes of the EEPROM memory array address. Note 3783c609719bSwdenk that this is NOT the chip address length! 3784c609719bSwdenk 37856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW: 37865cf91d6bSwdenk EEPROM chips that implement "address overflow" are ones 37875cf91d6bSwdenk like Catalyst 24WC04/08/16 which has 9/10/11 bits of 37885cf91d6bSwdenk address and the extra bits end up in the "chip address" bit 37895cf91d6bSwdenk slots. This makes a 24WC08 (1Kbyte) chip look like four 256 37905cf91d6bSwdenk byte chips. 37915cf91d6bSwdenk 37925cf91d6bSwdenk Note that we consider the length of the address field to 37935cf91d6bSwdenk still be one byte because the extra address bits are hidden 37945cf91d6bSwdenk in the chip address. 37955cf91d6bSwdenk 37966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_SIZE: 3797c609719bSwdenk The size in bytes of the EEPROM device. 3798c609719bSwdenk 3799548738b4SHeiko Schocher - CONFIG_ENV_EEPROM_IS_ON_I2C 3800548738b4SHeiko Schocher define this, if you have I2C and SPI activated, and your 3801548738b4SHeiko Schocher EEPROM, which holds the environment, is on the I2C bus. 3802548738b4SHeiko Schocher 3803548738b4SHeiko Schocher - CONFIG_I2C_ENV_EEPROM_BUS 3804548738b4SHeiko Schocher if you have an Environment on an EEPROM reached over 3805548738b4SHeiko Schocher I2C muxes, you can define here, how to reach this 3806548738b4SHeiko Schocher EEPROM. For example: 3807548738b4SHeiko Schocher 3808ea818dbbSHeiko Schocher #define CONFIG_I2C_ENV_EEPROM_BUS 1 3809548738b4SHeiko Schocher 3810548738b4SHeiko Schocher EEPROM which holds the environment, is reached over 3811548738b4SHeiko Schocher a pca9547 i2c mux with address 0x70, channel 3. 3812c609719bSwdenk 3813057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH: 38145779d8d9Swdenk 38155779d8d9Swdenk Define this if you have a DataFlash memory device which you 38165779d8d9Swdenk want to use for the environment. 38175779d8d9Swdenk 38180e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 38190e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 38200e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 38215779d8d9Swdenk 38225779d8d9Swdenk These three #defines specify the offset and size of the 38235779d8d9Swdenk environment area within the total memory of your DataFlash placed 38245779d8d9Swdenk at the specified address. 38255779d8d9Swdenk 38260a85a9e7SLiu Gang- CONFIG_ENV_IS_IN_REMOTE: 38270a85a9e7SLiu Gang 38280a85a9e7SLiu Gang Define this if you have a remote memory space which you 38290a85a9e7SLiu Gang want to use for the local device's environment. 38300a85a9e7SLiu Gang 38310a85a9e7SLiu Gang - CONFIG_ENV_ADDR: 38320a85a9e7SLiu Gang - CONFIG_ENV_SIZE: 38330a85a9e7SLiu Gang 38340a85a9e7SLiu Gang These two #defines specify the address and size of the 38350a85a9e7SLiu Gang environment area within the remote memory space. The 38360a85a9e7SLiu Gang local device can get the environment from remote memory 3837fc54c7faSLiu Gang space by SRIO or PCIE links. 38380a85a9e7SLiu Gang 38390a85a9e7SLiu GangBE CAREFUL! For some special cases, the local device can not use 38400a85a9e7SLiu Gang"saveenv" command. For example, the local device will get the 3841fc54c7faSLiu Gangenvironment stored in a remote NOR flash by SRIO or PCIE link, 3842fc54c7faSLiu Gangbut it can not erase, write this NOR flash by SRIO or PCIE interface. 38430a85a9e7SLiu Gang 384451bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND: 384513a5695bSwdenk 384613a5695bSwdenk Define this if you have a NAND device which you want to use 384713a5695bSwdenk for the environment. 384813a5695bSwdenk 38490e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 38500e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 385113a5695bSwdenk 385213a5695bSwdenk These two #defines specify the offset and size of the environment 3853fdd813deSScott Wood area within the first NAND device. CONFIG_ENV_OFFSET must be 3854fdd813deSScott Wood aligned to an erase block boundary. 38555779d8d9Swdenk 3856fdd813deSScott Wood - CONFIG_ENV_OFFSET_REDUND (optional): 3857e443c944SMarkus Klotzbuecher 38580e8d1586SJean-Christophe PLAGNIOL-VILLARD This setting describes a second storage area of CONFIG_ENV_SIZE 3859fdd813deSScott Wood size used to hold a redundant copy of the environment data, so 3860fdd813deSScott Wood that there is a valid backup copy in case there is a power failure 3861fdd813deSScott Wood during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be 3862fdd813deSScott Wood aligned to an erase block boundary. 3863e443c944SMarkus Klotzbuecher 3864fdd813deSScott Wood - CONFIG_ENV_RANGE (optional): 3865fdd813deSScott Wood 3866fdd813deSScott Wood Specifies the length of the region in which the environment 3867fdd813deSScott Wood can be written. This should be a multiple of the NAND device's 3868fdd813deSScott Wood block size. Specifying a range with more erase blocks than 3869fdd813deSScott Wood are needed to hold CONFIG_ENV_SIZE allows bad blocks within 3870fdd813deSScott Wood the range to be avoided. 3871fdd813deSScott Wood 3872fdd813deSScott Wood - CONFIG_ENV_OFFSET_OOB (optional): 3873fdd813deSScott Wood 3874fdd813deSScott Wood Enables support for dynamically retrieving the offset of the 3875fdd813deSScott Wood environment from block zero's out-of-band data. The 3876fdd813deSScott Wood "nand env.oob" command can be used to record this offset. 3877fdd813deSScott Wood Currently, CONFIG_ENV_OFFSET_REDUND is not supported when 3878fdd813deSScott Wood using CONFIG_ENV_OFFSET_OOB. 3879e443c944SMarkus Klotzbuecher 3880b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST 3881b74ab737SGuennadi Liakhovetski 3882b74ab737SGuennadi Liakhovetski Defines address in RAM to which the nand_spl code should copy the 3883b74ab737SGuennadi Liakhovetski environment. If redundant environment is used, it will be copied to 3884b74ab737SGuennadi Liakhovetski CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE. 3885b74ab737SGuennadi Liakhovetski 38862b74433fSJoe Hershberger- CONFIG_ENV_IS_IN_UBI: 38872b74433fSJoe Hershberger 38882b74433fSJoe Hershberger Define this if you have an UBI volume that you want to use for the 38892b74433fSJoe Hershberger environment. This has the benefit of wear-leveling the environment 38902b74433fSJoe Hershberger accesses, which is important on NAND. 38912b74433fSJoe Hershberger 38922b74433fSJoe Hershberger - CONFIG_ENV_UBI_PART: 38932b74433fSJoe Hershberger 38942b74433fSJoe Hershberger Define this to a string that is the mtd partition containing the UBI. 38952b74433fSJoe Hershberger 38962b74433fSJoe Hershberger - CONFIG_ENV_UBI_VOLUME: 38972b74433fSJoe Hershberger 38982b74433fSJoe Hershberger Define this to the name of the volume that you want to store the 38992b74433fSJoe Hershberger environment in. 39002b74433fSJoe Hershberger 3901785881f7SJoe Hershberger - CONFIG_ENV_UBI_VOLUME_REDUND: 3902785881f7SJoe Hershberger 3903785881f7SJoe Hershberger Define this to the name of another volume to store a second copy of 3904785881f7SJoe Hershberger the environment in. This will enable redundant environments in UBI. 3905785881f7SJoe Hershberger It is assumed that both volumes are in the same MTD partition. 3906785881f7SJoe Hershberger 39072b74433fSJoe Hershberger - CONFIG_UBI_SILENCE_MSG 39082b74433fSJoe Hershberger - CONFIG_UBIFS_SILENCE_MSG 39092b74433fSJoe Hershberger 39102b74433fSJoe Hershberger You will probably want to define these to avoid a really noisy system 39112b74433fSJoe Hershberger when storing the env in UBI. 39122b74433fSJoe Hershberger 391306e4ae5fSStephen Warren- CONFIG_ENV_IS_IN_MMC: 391406e4ae5fSStephen Warren 391506e4ae5fSStephen Warren Define this if you have an MMC device which you want to use for the 391606e4ae5fSStephen Warren environment. 391706e4ae5fSStephen Warren 391806e4ae5fSStephen Warren - CONFIG_SYS_MMC_ENV_DEV: 391906e4ae5fSStephen Warren 392006e4ae5fSStephen Warren Specifies which MMC device the environment is stored in. 392106e4ae5fSStephen Warren 392206e4ae5fSStephen Warren - CONFIG_SYS_MMC_ENV_PART (optional): 392306e4ae5fSStephen Warren 392406e4ae5fSStephen Warren Specifies which MMC partition the environment is stored in. If not 392506e4ae5fSStephen Warren set, defaults to partition 0, the user area. Common values might be 392606e4ae5fSStephen Warren 1 (first MMC boot partition), 2 (second MMC boot partition). 392706e4ae5fSStephen Warren 392806e4ae5fSStephen Warren - CONFIG_ENV_OFFSET: 392906e4ae5fSStephen Warren - CONFIG_ENV_SIZE: 393006e4ae5fSStephen Warren 393106e4ae5fSStephen Warren These two #defines specify the offset and size of the environment 393206e4ae5fSStephen Warren area within the specified MMC device. 393306e4ae5fSStephen Warren 39345c088ee8SStephen Warren If offset is positive (the usual case), it is treated as relative to 39355c088ee8SStephen Warren the start of the MMC partition. If offset is negative, it is treated 39365c088ee8SStephen Warren as relative to the end of the MMC partition. This can be useful if 39375c088ee8SStephen Warren your board may be fitted with different MMC devices, which have 39385c088ee8SStephen Warren different sizes for the MMC partitions, and you always want the 39395c088ee8SStephen Warren environment placed at the very end of the partition, to leave the 39405c088ee8SStephen Warren maximum possible space before it, to store other data. 39415c088ee8SStephen Warren 394206e4ae5fSStephen Warren These two values are in units of bytes, but must be aligned to an 394306e4ae5fSStephen Warren MMC sector boundary. 394406e4ae5fSStephen Warren 394506e4ae5fSStephen Warren - CONFIG_ENV_OFFSET_REDUND (optional): 394606e4ae5fSStephen Warren 394706e4ae5fSStephen Warren Specifies a second storage area, of CONFIG_ENV_SIZE size, used to 394806e4ae5fSStephen Warren hold a redundant copy of the environment data. This provides a 394906e4ae5fSStephen Warren valid backup copy in case the other copy is corrupted, e.g. due 395006e4ae5fSStephen Warren to a power failure during a "saveenv" operation. 395106e4ae5fSStephen Warren 39525c088ee8SStephen Warren This value may also be positive or negative; this is handled in the 39535c088ee8SStephen Warren same way as CONFIG_ENV_OFFSET. 39545c088ee8SStephen Warren 395506e4ae5fSStephen Warren This value is also in units of bytes, but must also be aligned to 395606e4ae5fSStephen Warren an MMC sector boundary. 395706e4ae5fSStephen Warren 395806e4ae5fSStephen Warren - CONFIG_ENV_SIZE_REDUND (optional): 395906e4ae5fSStephen Warren 396006e4ae5fSStephen Warren This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is 396106e4ae5fSStephen Warren set. If this value is set, it must be set to the same value as 396206e4ae5fSStephen Warren CONFIG_ENV_SIZE. 396306e4ae5fSStephen Warren 39646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET 3965c609719bSwdenk 3966c609719bSwdenk Defines offset to the initial SPI buffer area in DPRAM. The 3967c609719bSwdenk area is used at an early stage (ROM part) if the environment 3968c609719bSwdenk is configured to reside in the SPI EEPROM: We need a 520 byte 3969c609719bSwdenk scratch DPRAM area. It is used between the two initialization 3970c609719bSwdenk calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems 3971c609719bSwdenk to be a good choice since it makes it far enough from the 3972c609719bSwdenk start of the data area as well as from the stack pointer. 3973c609719bSwdenk 3974e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor 3975c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been 3976cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f() 3977c609719bSwdenkuntil then to read environment variables. 3978c609719bSwdenk 397985ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor 398085ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working 398185ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is 398285ec0bccSwdenknecessary, because the first environment variable we need is the 398385ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't 398485ec0bccSwdenkhave any device yet where we could complain.] 3985c609719bSwdenk 3986c609719bSwdenkNote: once the monitor has been relocated, then it will complain if 3987c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you 398885ec0bccSwdenkuse the "saveenv" command to store a valid environment. 3989c609719bSwdenk 39906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN: 3991fc3e2165Swdenk Echo the inverted Ethernet link state to the fault LED. 3992fc3e2165Swdenk 39936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR 3994fc3e2165Swdenk also needs to be defined. 3995fc3e2165Swdenk 39966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR: 3997fc3e2165Swdenk MII address of the PHY to check for the Ethernet link state. 3998c609719bSwdenk 3999f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS: 4000f5675aa5SRon Madrid Define this if you desire to only have use of the NS16550_init 4001f5675aa5SRon Madrid and NS16550_putc functions for the serial driver located at 4002f5675aa5SRon Madrid drivers/serial/ns16550.c. This option is useful for saving 4003f5675aa5SRon Madrid space for already greatly restricted images, including but not 4004f5675aa5SRon Madrid limited to NAND_SPL configurations. 4005f5675aa5SRon Madrid 4006b2b92f53SSimon Glass- CONFIG_DISPLAY_BOARDINFO 4007b2b92f53SSimon Glass Display information about the board that U-Boot is running on 4008b2b92f53SSimon Glass when U-Boot starts up. The board function checkboard() is called 4009b2b92f53SSimon Glass to do this. 4010b2b92f53SSimon Glass 4011e2e3e2b1SSimon Glass- CONFIG_DISPLAY_BOARDINFO_LATE 4012e2e3e2b1SSimon Glass Similar to the previous option, but display this information 4013e2e3e2b1SSimon Glass later, once stdio is running and output goes to the LCD, if 4014e2e3e2b1SSimon Glass present. 4015e2e3e2b1SSimon Glass 4016c609719bSwdenkLow Level (hardware related) configuration options: 4017dc7c9a1aSwdenk--------------------------------------------------- 4018c609719bSwdenk 40196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE: 4020c609719bSwdenk Cache Line Size of the CPU. 4021c609719bSwdenk 40226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR: 4023c609719bSwdenk Default address of the IMMR after system reset. 40242535d602Swdenk 40252535d602Swdenk Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU, 40262535d602Swdenk and RPXsuper) to be able to adjust the position of 40272535d602Swdenk the IMMR register after a reset. 4028c609719bSwdenk 4029e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT: 4030e46fedfeSTimur Tabi Default (power-on reset) physical address of CCSR on Freescale 4031e46fedfeSTimur Tabi PowerPC SOCs. 4032e46fedfeSTimur Tabi 4033e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR: 4034e46fedfeSTimur Tabi Virtual address of CCSR. On a 32-bit build, this is typically 4035e46fedfeSTimur Tabi the same value as CONFIG_SYS_CCSRBAR_DEFAULT. 4036e46fedfeSTimur Tabi 4037e46fedfeSTimur Tabi CONFIG_SYS_DEFAULT_IMMR must also be set to this value, 4038e46fedfeSTimur Tabi for cross-platform code that uses that macro instead. 4039e46fedfeSTimur Tabi 4040e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS: 4041e46fedfeSTimur Tabi Physical address of CCSR. CCSR can be relocated to a new 4042e46fedfeSTimur Tabi physical address, if desired. In this case, this macro should 4043e46fedfeSTimur Tabi be set to that address. Otherwise, it should be set to the 4044e46fedfeSTimur Tabi same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR 4045e46fedfeSTimur Tabi is typically relocated on 36-bit builds. It is recommended 4046e46fedfeSTimur Tabi that this macro be defined via the _HIGH and _LOW macros: 4047e46fedfeSTimur Tabi 4048e46fedfeSTimur Tabi #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH 4049e46fedfeSTimur Tabi * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW) 4050e46fedfeSTimur Tabi 4051e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH: 4052e46fedfeSTimur Tabi Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically 4053e46fedfeSTimur Tabi either 0 (32-bit build) or 0xF (36-bit build). This macro is 4054e46fedfeSTimur Tabi used in assembly code, so it must not contain typecasts or 4055e46fedfeSTimur Tabi integer size suffixes (e.g. "ULL"). 4056e46fedfeSTimur Tabi 4057e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW: 4058e46fedfeSTimur Tabi Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is 4059e46fedfeSTimur Tabi used in assembly code, so it must not contain typecasts or 4060e46fedfeSTimur Tabi integer size suffixes (e.g. "ULL"). 4061e46fedfeSTimur Tabi 4062e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE: 4063e46fedfeSTimur Tabi If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be 4064e46fedfeSTimur Tabi forced to a value that ensures that CCSR is not relocated. 4065e46fedfeSTimur Tabi 40667f6c2cbcSwdenk- Floppy Disk Support: 40676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FDC_DRIVE_NUMBER 40687f6c2cbcSwdenk 40697f6c2cbcSwdenk the default drive number (default value 0) 40707f6c2cbcSwdenk 40716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_ISA_IO_STRIDE 40727f6c2cbcSwdenk 407311ccc33fSMarcel Ziswiler defines the spacing between FDC chipset registers 40747f6c2cbcSwdenk (default value 1) 40757f6c2cbcSwdenk 40766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_ISA_IO_OFFSET 40777f6c2cbcSwdenk 40787f6c2cbcSwdenk defines the offset of register from address. It 40797f6c2cbcSwdenk depends on which part of the data bus is connected to 408011ccc33fSMarcel Ziswiler the FDC chipset. (default value 0) 40817f6c2cbcSwdenk 40826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and 40836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their 40847f6c2cbcSwdenk default value. 40857f6c2cbcSwdenk 40866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD if CONFIG_SYS_FDC_HW_INIT is defined, then the function 40877f6c2cbcSwdenk fdc_hw_init() is called at the beginning of the FDC 40887f6c2cbcSwdenk setup. fdc_hw_init() must be provided by the board 40897f6c2cbcSwdenk source code. It is used to make hardware dependant 40907f6c2cbcSwdenk initializations. 40917f6c2cbcSwdenk 40920abddf82SMacpaul Lin- CONFIG_IDE_AHB: 40930abddf82SMacpaul Lin Most IDE controllers were designed to be connected with PCI 40940abddf82SMacpaul Lin interface. Only few of them were designed for AHB interface. 40950abddf82SMacpaul Lin When software is doing ATA command and data transfer to 40960abddf82SMacpaul Lin IDE devices through IDE-AHB controller, some additional 40970abddf82SMacpaul Lin registers accessing to these kind of IDE-AHB controller 40980abddf82SMacpaul Lin is requierd. 40990abddf82SMacpaul Lin 41006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR: Physical address of the Internal Memory. 410125d6712aSwdenk DO NOT CHANGE unless you know exactly what you're 410225d6712aSwdenk doing! (11-4) [MPC8xx/82xx systems only] 4103c609719bSwdenk 41046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR: 4105c609719bSwdenk 41067152b1d0Swdenk Start address of memory area that can be used for 4107c609719bSwdenk initial data and stack; please note that this must be 4108c609719bSwdenk writable memory that is working WITHOUT special 4109c609719bSwdenk initialization, i. e. you CANNOT use normal RAM which 4110c609719bSwdenk will become available only after programming the 4111c609719bSwdenk memory controller and running certain initialization 4112c609719bSwdenk sequences. 4113c609719bSwdenk 4114c609719bSwdenk U-Boot uses the following memory types: 4115c609719bSwdenk - MPC8xx and MPC8260: IMMR (internal memory of the CPU) 4116c609719bSwdenk - MPC824X: data cache 4117c609719bSwdenk - PPC4xx: data cache 4118c609719bSwdenk 41196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET: 4120c609719bSwdenk 4121c609719bSwdenk Offset of the initial data structure in the memory 41226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually 41236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial 4124c609719bSwdenk data is located at the end of the available space 4125553f0982SWolfgang Denk (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE - 41266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just 41276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR + 41286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_GBL_DATA_OFFSET) downward. 4129c609719bSwdenk 4130c609719bSwdenk Note: 4131c609719bSwdenk On the MPC824X (or other systems that use the data 4132c609719bSwdenk cache for initial memory) the address chosen for 41336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must 4134c609719bSwdenk point to an otherwise UNUSED address space between 4135c609719bSwdenk the top of RAM and the start of the PCI space. 4136c609719bSwdenk 41376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6) 4138c609719bSwdenk 41396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR: System Protection Control (11-9) 4140c609719bSwdenk 41416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26) 4142c609719bSwdenk 41436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31) 4144c609719bSwdenk 41456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30) 4146c609719bSwdenk 41476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27) 4148c609719bSwdenk 41496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM: 4150c609719bSwdenk SDRAM timing 4151c609719bSwdenk 41526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA: 4153c609719bSwdenk periodic timer for refresh 4154c609719bSwdenk 41556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER: Debug Event Register (37-47) 4156c609719bSwdenk 41576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM, 41586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP, 41596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM, 41606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BR1_PRELIM: 4161c609719bSwdenk Memory Controller Definitions: BR0/1 and OR0/1 (FLASH) 4162c609719bSwdenk 4163c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE, 41646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM, 41656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM: 4166c609719bSwdenk Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM) 4167c609719bSwdenk 41686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K, 41696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL: 4170c609719bSwdenk Machine Mode Register and Memory Periodic Timer 4171c609719bSwdenk Prescaler definitions (SDRAM timing) 4172c609719bSwdenk 41736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]: 4174c609719bSwdenk enable I2C microcode relocation patch (MPC8xx); 4175c609719bSwdenk define relocation offset in DPRAM [DSP2] 4176c609719bSwdenk 41776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]: 4178b423d055SHeiko Schocher enable SMC microcode relocation patch (MPC8xx); 4179b423d055SHeiko Schocher define relocation offset in DPRAM [SMC1] 4180b423d055SHeiko Schocher 41816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]: 4182c609719bSwdenk enable SPI microcode relocation patch (MPC8xx); 4183c609719bSwdenk define relocation offset in DPRAM [SCC4] 4184c609719bSwdenk 41856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK: 4186c609719bSwdenk Use OSCM clock mode on MBX8xx board. Be careful, 4187c609719bSwdenk wrong setting might damage your board. Read 4188c609719bSwdenk doc/README.MBX before setting this variable! 4189c609719bSwdenk 41906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only) 4191ea909b76Swdenk Offset of the bootmode word in DPRAM used by post 4192ea909b76Swdenk (Power On Self Tests). This definition overrides 4193ea909b76Swdenk #define'd default value in commproc.h resp. 4194ea909b76Swdenk cpm_8260.h. 4195ea909b76Swdenk 41966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB, 41976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL, 41986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS, 41996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB, 42006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START, 42016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL, 42026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE, 42036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only) 4204a47a12beSStefan Roese Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set. 42055d232d0eSwdenk 42069cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE: 42079cacf4fcSDirk Eibach Disable PCI-Express on systems where it is supported but not 42089cacf4fcSDirk Eibach required. 42099cacf4fcSDirk Eibach 421069fd2d3bSAndrew Sharp- CONFIG_PCI_ENUM_ONLY 421169fd2d3bSAndrew Sharp Only scan through and get the devices on the busses. 421269fd2d3bSAndrew Sharp Don't do any setup work, presumably because someone or 421369fd2d3bSAndrew Sharp something has already done it, and we don't need to do it 421469fd2d3bSAndrew Sharp a second time. Useful for platforms that are pre-booted 421569fd2d3bSAndrew Sharp by coreboot or similar. 421669fd2d3bSAndrew Sharp 4217842033e6SGabor Juhos- CONFIG_PCI_INDIRECT_BRIDGE: 4218842033e6SGabor Juhos Enable support for indirect PCI bridges. 4219842033e6SGabor Juhos 4220a09b9b68SKumar Gala- CONFIG_SYS_SRIO: 4221a09b9b68SKumar Gala Chip has SRIO or not 4222a09b9b68SKumar Gala 4223a09b9b68SKumar Gala- CONFIG_SRIO1: 4224a09b9b68SKumar Gala Board has SRIO 1 port available 4225a09b9b68SKumar Gala 4226a09b9b68SKumar Gala- CONFIG_SRIO2: 4227a09b9b68SKumar Gala Board has SRIO 2 port available 4228a09b9b68SKumar Gala 4229c8b28152SLiu Gang- CONFIG_SRIO_PCIE_BOOT_MASTER 4230c8b28152SLiu Gang Board can support master function for Boot from SRIO and PCIE 4231c8b28152SLiu Gang 4232a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT: 4233a09b9b68SKumar Gala Virtual Address of SRIO port 'n' memory region 4234a09b9b68SKumar Gala 4235a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS: 4236a09b9b68SKumar Gala Physical Address of SRIO port 'n' memory region 4237a09b9b68SKumar Gala 4238a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE: 4239a09b9b68SKumar Gala Size of SRIO port 'n' memory region 4240a09b9b68SKumar Gala 424166bd1846SFabio Estevam- CONFIG_SYS_NAND_BUSWIDTH_16BIT 424266bd1846SFabio Estevam Defined to tell the NAND controller that the NAND chip is using 424366bd1846SFabio Estevam a 16 bit bus. 424466bd1846SFabio Estevam Not all NAND drivers use this symbol. 4245a430e916SFabio Estevam Example of drivers that use it: 424666bd1846SFabio Estevam - drivers/mtd/nand/ndfc.c 4247a430e916SFabio Estevam - drivers/mtd/nand/mxc_nand.c 4248eced4626SAlex Waterman 4249eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG 4250eced4626SAlex Waterman Sets the EBC0_CFG register for the NDFC. If not defined 4251eced4626SAlex Waterman a default value will be used. 4252eced4626SAlex Waterman 4253bb99ad6dSBen Warren- CONFIG_SPD_EEPROM 4254218ca724SWolfgang Denk Get DDR timing information from an I2C EEPROM. Common 4255218ca724SWolfgang Denk with pluggable memory modules such as SODIMMs 4256218ca724SWolfgang Denk 4257bb99ad6dSBen Warren SPD_EEPROM_ADDRESS 4258bb99ad6dSBen Warren I2C address of the SPD EEPROM 4259bb99ad6dSBen Warren 42606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM 4261218ca724SWolfgang Denk If SPD EEPROM is on an I2C bus other than the first 4262218ca724SWolfgang Denk one, specify here. Note that the value must resolve 4263218ca724SWolfgang Denk to something your driver can deal with. 4264bb99ad6dSBen Warren 42651b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING 42661b3e3c4fSYork Sun Get DDR timing information from other than SPD. Common with 42671b3e3c4fSYork Sun soldered DDR chips onboard without SPD. DDR raw timing 42681b3e3c4fSYork Sun parameters are extracted from datasheet and hard-coded into 42691b3e3c4fSYork Sun header files or board specific files. 42701b3e3c4fSYork Sun 42716f5e1dc5SYork Sun- CONFIG_FSL_DDR_INTERACTIVE 42726f5e1dc5SYork Sun Enable interactive DDR debugging. See doc/README.fsl-ddr. 42736f5e1dc5SYork Sun 42746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0 4275218ca724SWolfgang Denk Only for 83xx systems. If specified, then DDR should 4276218ca724SWolfgang Denk be configured using CS0 and CS1 instead of CS2 and CS3. 42772ad6b513STimur Tabi 4278c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12] 4279c26e454dSwdenk Define to enable FEC[12] on a 8xx series processor. 4280c26e454dSwdenk 4281c26e454dSwdenk- CONFIG_FEC[12]_PHY 4282c26e454dSwdenk Define to the hardcoded PHY address which corresponds 42836e592385Swdenk to the given FEC; i. e. 4284c26e454dSwdenk #define CONFIG_FEC1_PHY 4 4285c26e454dSwdenk means that the PHY with address 4 is connected to FEC1 4286c26e454dSwdenk 4287c26e454dSwdenk When set to -1, means to probe for first available. 4288c26e454dSwdenk 4289c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR 4290c26e454dSwdenk The PHY does not have a RXERR line (RMII only). 4291c26e454dSwdenk (so program the FEC to ignore it). 4292c26e454dSwdenk 4293c26e454dSwdenk- CONFIG_RMII 4294c26e454dSwdenk Enable RMII mode for all FECs. 4295c26e454dSwdenk Note that this is a global option, we can't 4296c26e454dSwdenk have one FEC in standard MII mode and another in RMII mode. 4297c26e454dSwdenk 42985cf91d6bSwdenk- CONFIG_CRC32_VERIFY 42995cf91d6bSwdenk Add a verify option to the crc32 command. 43005cf91d6bSwdenk The syntax is: 43015cf91d6bSwdenk 43025cf91d6bSwdenk => crc32 -v <address> <count> <crc32> 43035cf91d6bSwdenk 43045cf91d6bSwdenk Where address/count indicate a memory area 43055cf91d6bSwdenk and crc32 is the correct crc32 which the 43065cf91d6bSwdenk area should have. 43075cf91d6bSwdenk 430856523f12Swdenk- CONFIG_LOOPW 430956523f12Swdenk Add the "loopw" memory command. This only takes effect if 4310602ad3b3SJon Loeliger the memory commands are activated globally (CONFIG_CMD_MEM). 431156523f12Swdenk 43127b466641Sstroese- CONFIG_MX_CYCLIC 43137b466641Sstroese Add the "mdc" and "mwc" memory commands. These are cyclic 43147b466641Sstroese "md/mw" commands. 43157b466641Sstroese Examples: 43167b466641Sstroese 43177b466641Sstroese => mdc.b 10 4 500 43187b466641Sstroese This command will print 4 bytes (10,11,12,13) each 500 ms. 43197b466641Sstroese 43207b466641Sstroese => mwc.l 100 12345678 10 43217b466641Sstroese This command will write 12345678 to address 100 all 10 ms. 43227b466641Sstroese 43237b466641Sstroese This only takes effect if the memory commands are activated 4324602ad3b3SJon Loeliger globally (CONFIG_CMD_MEM). 43257b466641Sstroese 43268aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT 4327afc1ce82SMacpaul Lin [ARM, NDS32, MIPS only] If this variable is defined, then certain 4328e03f3169SWolfgang Denk low level initializations (like setting up the memory 4329e03f3169SWolfgang Denk controller) are omitted and/or U-Boot does not 4330e03f3169SWolfgang Denk relocate itself into RAM. 43318aa1a2d1Swdenk 4332e03f3169SWolfgang Denk Normally this variable MUST NOT be defined. The only 4333e03f3169SWolfgang Denk exception is when U-Boot is loaded (to RAM) by some 4334e03f3169SWolfgang Denk other boot loader or by a debugger which performs 4335e03f3169SWolfgang Denk these initializations itself. 43368aa1a2d1Swdenk 4337401bb30bSAneesh V- CONFIG_SPL_BUILD 4338df81238bSMagnus Lilja Modifies the behaviour of start.S when compiling a loader 4339df81238bSMagnus Lilja that is executed before the actual U-Boot. E.g. when 4340df81238bSMagnus Lilja compiling a NAND SPL. 4341400558b5Swdenk 43423aa29de0SYing Zhang- CONFIG_TPL_BUILD 43433aa29de0SYing Zhang Modifies the behaviour of start.S when compiling a loader 43443aa29de0SYing Zhang that is executed after the SPL and before the actual U-Boot. 43453aa29de0SYing Zhang It is loaded by the SPL. 43463aa29de0SYing Zhang 43475df572f0SYing Zhang- CONFIG_SYS_MPC85XX_NO_RESETVEC 43485df572f0SYing Zhang Only for 85xx systems. If this variable is specified, the section 43495df572f0SYing Zhang .resetvec is not kept and the section .bootpg is placed in the 43505df572f0SYing Zhang previous 4k of the .text section. 43515df572f0SYing Zhang 43524213fc29SSimon Glass- CONFIG_ARCH_MAP_SYSMEM 43534213fc29SSimon Glass Generally U-Boot (and in particular the md command) uses 43544213fc29SSimon Glass effective address. It is therefore not necessary to regard 43554213fc29SSimon Glass U-Boot address as virtual addresses that need to be translated 43564213fc29SSimon Glass to physical addresses. However, sandbox requires this, since 43574213fc29SSimon Glass it maintains its own little RAM buffer which contains all 43584213fc29SSimon Glass addressable memory. This option causes some memory accesses 43594213fc29SSimon Glass to be mapped through map_sysmem() / unmap_sysmem(). 43604213fc29SSimon Glass 4361d8834a13SMatthias Weisser- CONFIG_USE_ARCH_MEMCPY 4362d8834a13SMatthias Weisser CONFIG_USE_ARCH_MEMSET 4363d8834a13SMatthias Weisser If these options are used a optimized version of memcpy/memset will 4364d8834a13SMatthias Weisser be used if available. These functions may be faster under some 4365d8834a13SMatthias Weisser conditions but may increase the binary size. 4366d8834a13SMatthias Weisser 4367588a13f7SSimon Glass- CONFIG_X86_RESET_VECTOR 4368588a13f7SSimon Glass If defined, the x86 reset vector code is included. This is not 4369588a13f7SSimon Glass needed when U-Boot is running from Coreboot. 4370b16f521aSGabe Black 4371fc33705eSMark Jackson- CONFIG_SYS_MPUCLK 4372fc33705eSMark Jackson Defines the MPU clock speed (in MHz). 4373fc33705eSMark Jackson 4374fc33705eSMark Jackson NOTE : currently only supported on AM335x platforms. 43755b5ece9eSGabe Black 4376f2717b47STimur TabiFreescale QE/FMAN Firmware Support: 4377f2717b47STimur Tabi----------------------------------- 4378f2717b47STimur Tabi 4379f2717b47STimur TabiThe Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the 4380f2717b47STimur Tabiloading of "firmware", which is encoded in the QE firmware binary format. 4381f2717b47STimur TabiThis firmware often needs to be loaded during U-Boot booting, so macros 4382f2717b47STimur Tabiare used to identify the storage device (NOR flash, SPI, etc) and the address 4383f2717b47STimur Tabiwithin that device. 4384f2717b47STimur Tabi 4385f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_ADDR 4386f2717b47STimur Tabi The address in the storage device where the firmware is located. The 4387f2717b47STimur Tabi meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro 4388f2717b47STimur Tabi is also specified. 4389f2717b47STimur Tabi 4390f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_LENGTH 4391f2717b47STimur Tabi The maximum possible size of the firmware. The firmware binary format 4392f2717b47STimur Tabi has a field that specifies the actual size of the firmware, but it 4393f2717b47STimur Tabi might not be possible to read any part of the firmware unless some 4394f2717b47STimur Tabi local storage is allocated to hold the entire firmware first. 4395f2717b47STimur Tabi 4396f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NOR 4397f2717b47STimur Tabi Specifies that QE/FMAN firmware is located in NOR flash, mapped as 4398f2717b47STimur Tabi normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the 4399f2717b47STimur Tabi virtual address in NOR flash. 4400f2717b47STimur Tabi 4401f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NAND 4402f2717b47STimur Tabi Specifies that QE/FMAN firmware is located in NAND flash. 4403f2717b47STimur Tabi CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash. 4404f2717b47STimur Tabi 4405f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_MMC 4406f2717b47STimur Tabi Specifies that QE/FMAN firmware is located on the primary SD/MMC 4407f2717b47STimur Tabi device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device. 4408f2717b47STimur Tabi 4409f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH 4410f2717b47STimur Tabi Specifies that QE/FMAN firmware is located on the primary SPI 4411f2717b47STimur Tabi device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device. 4412f2717b47STimur Tabi 4413292dc6c5SLiu Gang- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE 4414292dc6c5SLiu Gang Specifies that QE/FMAN firmware is located in the remote (master) 4415292dc6c5SLiu Gang memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which 4416fc54c7faSLiu Gang can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound 4417fc54c7faSLiu Gang window->master inbound window->master LAW->the ucode address in 4418fc54c7faSLiu Gang master's memory space. 4419f2717b47STimur Tabi 4420c609719bSwdenkBuilding the Software: 4421c609719bSwdenk====================== 4422c609719bSwdenk 4423218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments 4424218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support 4425218ca724SWolfgang Denkall possibly existing versions of cross development tools in all 4426218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we 4427218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK) 4428218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot. 4429c609719bSwdenk 4430218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you 4431218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case, 4432218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell. 4433218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are 4434218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter: 4435c609719bSwdenk 4436218ca724SWolfgang Denk $ CROSS_COMPILE=ppc_4xx- 4437218ca724SWolfgang Denk $ export CROSS_COMPILE 4438c609719bSwdenk 44392f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in 44402f8d396bSPeter Tyser the tools directory you can use the MinGW toolchain 44412f8d396bSPeter Tyser (http://www.mingw.org). Set your HOST tools to the MinGW 44422f8d396bSPeter Tyser toolchain and execute 'make tools'. For example: 44432f8d396bSPeter Tyser 44442f8d396bSPeter Tyser $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools 44452f8d396bSPeter Tyser 44462f8d396bSPeter Tyser Binaries such as tools/mkimage.exe will be created which can 44472f8d396bSPeter Tyser be executed on computers running Windows. 44482f8d396bSPeter Tyser 4449c609719bSwdenkU-Boot is intended to be simple to build. After installing the 4450c609719bSwdenksources you must configure U-Boot for one specific board type. This 4451c609719bSwdenkis done by typing: 4452c609719bSwdenk 4453c609719bSwdenk make NAME_config 4454c609719bSwdenk 4455218ca724SWolfgang Denkwhere "NAME_config" is the name of one of the existing configu- 44564d675ae6SMichael Jonesrations; see boards.cfg for supported names. 445754387ac9Swdenk 4458c609719bSwdenkNote: for some board special configuration names may exist; check if 4459c609719bSwdenk additional information is available from the board vendor; for 44602729af9dSwdenk instance, the TQM823L systems are available without (standard) 44612729af9dSwdenk or with LCD support. You can select such additional "features" 446211ccc33fSMarcel Ziswiler when choosing the configuration, i. e. 4463c609719bSwdenk 44642729af9dSwdenk make TQM823L_config 44652729af9dSwdenk - will configure for a plain TQM823L, i. e. no LCD support 4466c609719bSwdenk 4467c609719bSwdenk make TQM823L_LCD_config 4468c609719bSwdenk - will configure for a TQM823L with U-Boot console on LCD 4469c609719bSwdenk 4470c609719bSwdenk etc. 4471c609719bSwdenk 4472c609719bSwdenk 4473c609719bSwdenkFinally, type "make all", and you should get some working U-Boot 44747152b1d0Swdenkimages ready for download to / installation on your system: 4475c609719bSwdenk 4476c609719bSwdenk- "u-boot.bin" is a raw binary image 4477c609719bSwdenk- "u-boot" is an image in ELF binary format 4478c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format 4479c609719bSwdenk 4480baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved 4481baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change 4482baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory: 4483baf31249SMarian Balakowicz 4484baf31249SMarian Balakowicz1. Add O= to the make command line invocations: 4485baf31249SMarian Balakowicz 4486baf31249SMarian Balakowicz make O=/tmp/build distclean 4487baf31249SMarian Balakowicz make O=/tmp/build NAME_config 4488baf31249SMarian Balakowicz make O=/tmp/build all 4489baf31249SMarian Balakowicz 4490baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location: 4491baf31249SMarian Balakowicz 4492baf31249SMarian Balakowicz export BUILD_DIR=/tmp/build 4493baf31249SMarian Balakowicz make distclean 4494baf31249SMarian Balakowicz make NAME_config 4495baf31249SMarian Balakowicz make all 4496baf31249SMarian Balakowicz 4497baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment 4498baf31249SMarian Balakowiczvariable. 4499baf31249SMarian Balakowicz 4500c609719bSwdenk 4501c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so 4502c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of 4503c609719bSwdenknative "make". 4504c609719bSwdenk 4505c609719bSwdenk 4506c609719bSwdenkIf the system board that you have is not listed, then you will need 4507c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these 4508c609719bSwdenksteps: 4509c609719bSwdenk 4510c609719bSwdenk1. Add a new configuration option for your board to the toplevel 45114d675ae6SMichael Jones "boards.cfg" file, using the existing entries as examples. 45124d675ae6SMichael Jones Follow the instructions there to keep the boards in order. 4513c609719bSwdenk2. Create a new directory to hold your board specific code. Add any 451485ec0bccSwdenk files you need. In your board directory, you will need at least 451585ec0bccSwdenk the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds". 451685ec0bccSwdenk3. Create a new configuration file "include/configs/<board>.h" for 451785ec0bccSwdenk your board 4518c609719bSwdenk3. If you're porting U-Boot to a new CPU, then also create a new 4519c609719bSwdenk directory to hold your CPU specific code. Add any files you need. 452085ec0bccSwdenk4. Run "make <board>_config" with your new name. 4521c609719bSwdenk5. Type "make", and you should get a working "u-boot.srec" file 4522c609719bSwdenk to be installed on your target system. 452385ec0bccSwdenk6. Debug and solve any problems that might arise. 4524c609719bSwdenk [Of course, this last step is much harder than it sounds.] 4525c609719bSwdenk 4526c609719bSwdenk 4527c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.: 4528c609719bSwdenk============================================================== 4529c609719bSwdenk 4530c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board 4531c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to 4532c609719bSwdenkprovide feedback to the other developers. The feedback normally takes 4533c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest 4534218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources. 4535c609719bSwdenk 4536c609719bSwdenkBut before you submit such a patch, please verify that your modifi- 4537c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of 4538c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so, 4539c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot 4540c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can 45417152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE' 4542218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools 4543218ca724SWolfgang Denkyou can type 4544c609719bSwdenk 4545c609719bSwdenk CROSS_COMPILE=ppc_8xx- MAKEALL 4546c609719bSwdenk 4547c609719bSwdenkor to build on a native PowerPC system you can type 4548c609719bSwdenk 4549c609719bSwdenk CROSS_COMPILE=' ' MAKEALL 4550c609719bSwdenk 4551218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build 4552218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by 4553218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target 4554218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and 4555218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default 4556218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment 4557218ca724SWolfgang Denkvariable. For example: 4558baf31249SMarian Balakowicz 4559baf31249SMarian Balakowicz export BUILD_DIR=/tmp/build 4560baf31249SMarian Balakowicz export MAKEALL_LOGDIR=/tmp/log 4561baf31249SMarian Balakowicz CROSS_COMPILE=ppc_8xx- MAKEALL 4562baf31249SMarian Balakowicz 4563218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build, 4564218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean 4565218ca724SWolfgang Denkduring the whole build process. 4566baf31249SMarian Balakowicz 4567baf31249SMarian Balakowicz 4568c609719bSwdenkSee also "U-Boot Porting Guide" below. 4569c609719bSwdenk 4570c609719bSwdenk 4571c609719bSwdenkMonitor Commands - Overview: 4572c609719bSwdenk============================ 4573c609719bSwdenk 4574c609719bSwdenkgo - start application at address 'addr' 4575c609719bSwdenkrun - run commands in an environment variable 4576c609719bSwdenkbootm - boot application image from memory 4577c609719bSwdenkbootp - boot image via network using BootP/TFTP protocol 457844f074c7SMarek Vasutbootz - boot zImage from memory 4579c609719bSwdenktftpboot- boot image via network using TFTP protocol 4580c609719bSwdenk and env variables "ipaddr" and "serverip" 4581c609719bSwdenk (and eventually "gatewayip") 45821fb7cd49SSimon Glasstftpput - upload a file via network using TFTP protocol 4583c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol 4584c609719bSwdenkdiskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd' 4585c609719bSwdenkloads - load S-Record file over serial line 4586c609719bSwdenkloadb - load binary file over serial line (kermit mode) 4587c609719bSwdenkmd - memory display 4588c609719bSwdenkmm - memory modify (auto-incrementing) 4589c609719bSwdenknm - memory modify (constant address) 4590c609719bSwdenkmw - memory write (fill) 4591c609719bSwdenkcp - memory copy 4592c609719bSwdenkcmp - memory compare 4593c609719bSwdenkcrc32 - checksum calculation 45940f89c54bSPeter Tyseri2c - I2C sub-system 4595c609719bSwdenksspi - SPI utility commands 4596c609719bSwdenkbase - print or set address offset 4597c609719bSwdenkprintenv- print environment variables 4598c609719bSwdenksetenv - set environment variables 4599c609719bSwdenksaveenv - save environment variables to persistent storage 4600c609719bSwdenkprotect - enable or disable FLASH write protection 4601c609719bSwdenkerase - erase FLASH memory 4602c609719bSwdenkflinfo - print FLASH memory information 460310635afaSKarl O. Pincnand - NAND memory operations (see doc/README.nand) 4604c609719bSwdenkbdinfo - print Board Info structure 4605c609719bSwdenkiminfo - print header information for application image 4606c609719bSwdenkconinfo - print console devices and informations 4607c609719bSwdenkide - IDE sub-system 4608c609719bSwdenkloop - infinite loop on address range 460956523f12Swdenkloopw - infinite write loop on address range 4610c609719bSwdenkmtest - simple RAM test 4611c609719bSwdenkicache - enable or disable instruction cache 4612c609719bSwdenkdcache - enable or disable data cache 4613c609719bSwdenkreset - Perform RESET of the CPU 4614c609719bSwdenkecho - echo args to console 4615c609719bSwdenkversion - print monitor version 4616c609719bSwdenkhelp - print online help 4617c609719bSwdenk? - alias for 'help' 4618c609719bSwdenk 4619c609719bSwdenk 4620c609719bSwdenkMonitor Commands - Detailed Description: 4621c609719bSwdenk======================================== 4622c609719bSwdenk 4623c609719bSwdenkTODO. 4624c609719bSwdenk 4625c609719bSwdenkFor now: just type "help <command>". 4626c609719bSwdenk 4627c609719bSwdenk 4628c609719bSwdenkEnvironment Variables: 4629c609719bSwdenk====================== 4630c609719bSwdenk 4631c609719bSwdenkU-Boot supports user configuration using Environment Variables which 4632c609719bSwdenkcan be made persistent by saving to Flash memory. 4633c609719bSwdenk 4634c609719bSwdenkEnvironment Variables are set using "setenv", printed using 4635c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv" 4636c609719bSwdenkwithout a value can be used to delete a variable from the 4637c609719bSwdenkenvironment. As long as you don't save the environment you are 4638c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the 4639c609719bSwdenkenvironment is erased by accident, a default environment is provided. 4640c609719bSwdenk 4641c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables. 4642c96f86eeSWolfgang Denk 4643c96f86eeSWolfgang DenkList of environment variables (most likely not complete): 4644c609719bSwdenk 4645c609719bSwdenk baudrate - see CONFIG_BAUDRATE 4646c609719bSwdenk 4647c609719bSwdenk bootdelay - see CONFIG_BOOTDELAY 4648c609719bSwdenk 4649c609719bSwdenk bootcmd - see CONFIG_BOOTCOMMAND 4650c609719bSwdenk 4651c609719bSwdenk bootargs - Boot arguments when booting an RTOS image 4652c609719bSwdenk 4653c609719bSwdenk bootfile - Name of the image to load with TFTP 4654c609719bSwdenk 46557d721e34SBartlomiej Sieka bootm_low - Memory range available for image processing in the bootm 46567d721e34SBartlomiej Sieka command can be restricted. This variable is given as 46577d721e34SBartlomiej Sieka a hexadecimal number and defines lowest address allowed 46587d721e34SBartlomiej Sieka for use by the bootm command. See also "bootm_size" 46597d721e34SBartlomiej Sieka environment variable. Address defined by "bootm_low" is 46607d721e34SBartlomiej Sieka also the base of the initial memory mapping for the Linux 4661c3624e6eSGrant Likely kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and 4662c3624e6eSGrant Likely bootm_mapsize. 4663c3624e6eSGrant Likely 4664c3624e6eSGrant Likely bootm_mapsize - Size of the initial memory mapping for the Linux kernel. 4665c3624e6eSGrant Likely This variable is given as a hexadecimal number and it 4666c3624e6eSGrant Likely defines the size of the memory region starting at base 4667c3624e6eSGrant Likely address bootm_low that is accessible by the Linux kernel 4668c3624e6eSGrant Likely during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used 4669c3624e6eSGrant Likely as the default value if it is defined, and bootm_size is 4670c3624e6eSGrant Likely used otherwise. 46717d721e34SBartlomiej Sieka 46727d721e34SBartlomiej Sieka bootm_size - Memory range available for image processing in the bootm 46737d721e34SBartlomiej Sieka command can be restricted. This variable is given as 46747d721e34SBartlomiej Sieka a hexadecimal number and defines the size of the region 46757d721e34SBartlomiej Sieka allowed for use by the bootm command. See also "bootm_low" 46767d721e34SBartlomiej Sieka environment variable. 46777d721e34SBartlomiej Sieka 46784bae9090SBartlomiej Sieka updatefile - Location of the software update file on a TFTP server, used 46794bae9090SBartlomiej Sieka by the automatic software update feature. Please refer to 46804bae9090SBartlomiej Sieka documentation in doc/README.update for more details. 46814bae9090SBartlomiej Sieka 4682c609719bSwdenk autoload - if set to "no" (any string beginning with 'n'), 4683c609719bSwdenk "bootp" will just load perform a lookup of the 4684c609719bSwdenk configuration from the BOOTP server, but not try to 4685c609719bSwdenk load any image using TFTP 4686c609719bSwdenk 4687c609719bSwdenk autostart - if set to "yes", an image loaded using the "bootp", 4688c609719bSwdenk "rarpboot", "tftpboot" or "diskboot" commands will 4689c609719bSwdenk be automatically started (by internally calling 4690c609719bSwdenk "bootm") 4691c609719bSwdenk 46924a6fd34bSwdenk If set to "no", a standalone image passed to the 46934a6fd34bSwdenk "bootm" command will be copied to the load address 46944a6fd34bSwdenk (and eventually uncompressed), but NOT be started. 46954a6fd34bSwdenk This can be used to load and uncompress arbitrary 46964a6fd34bSwdenk data. 46974a6fd34bSwdenk 4698a28afca5SDavid A. Long fdt_high - if set this restricts the maximum address that the 4699a28afca5SDavid A. Long flattened device tree will be copied into upon boot. 4700fa34f6b2SShawn Guo For example, if you have a system with 1 GB memory 4701fa34f6b2SShawn Guo at physical address 0x10000000, while Linux kernel 4702fa34f6b2SShawn Guo only recognizes the first 704 MB as low memory, you 4703fa34f6b2SShawn Guo may need to set fdt_high as 0x3C000000 to have the 4704fa34f6b2SShawn Guo device tree blob be copied to the maximum address 4705fa34f6b2SShawn Guo of the 704 MB low memory, so that Linux kernel can 4706fa34f6b2SShawn Guo access it during the boot procedure. 4707fa34f6b2SShawn Guo 4708a28afca5SDavid A. Long If this is set to the special value 0xFFFFFFFF then 4709a28afca5SDavid A. Long the fdt will not be copied at all on boot. For this 4710a28afca5SDavid A. Long to work it must reside in writable memory, have 4711a28afca5SDavid A. Long sufficient padding on the end of it for u-boot to 4712a28afca5SDavid A. Long add the information it needs into it, and the memory 4713a28afca5SDavid A. Long must be accessible by the kernel. 4714a28afca5SDavid A. Long 4715eea63e05SSimon Glass fdtcontroladdr- if set this is the address of the control flattened 4716eea63e05SSimon Glass device tree used by U-Boot when CONFIG_OF_CONTROL is 4717eea63e05SSimon Glass defined. 4718eea63e05SSimon Glass 471917ea1177Swdenk i2cfast - (PPC405GP|PPC405EP only) 472017ea1177Swdenk if set to 'y' configures Linux I2C driver for fast 472117ea1177Swdenk mode (400kHZ). This environment variable is used in 472217ea1177Swdenk initialization code. So, for changes to be effective 472317ea1177Swdenk it must be saved and board must be reset. 472417ea1177Swdenk 4725c609719bSwdenk initrd_high - restrict positioning of initrd images: 4726c609719bSwdenk If this variable is not set, initrd images will be 4727c609719bSwdenk copied to the highest possible address in RAM; this 4728c609719bSwdenk is usually what you want since it allows for 4729c609719bSwdenk maximum initrd size. If for some reason you want to 4730c609719bSwdenk make sure that the initrd image is loaded below the 47316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BOOTMAPSZ limit, you can set this environment 4732c609719bSwdenk variable to a value of "no" or "off" or "0". 4733c609719bSwdenk Alternatively, you can set it to a maximum upper 4734c609719bSwdenk address to use (U-Boot will still check that it 4735c609719bSwdenk does not overwrite the U-Boot stack and data). 4736c609719bSwdenk 4737c609719bSwdenk For instance, when you have a system with 16 MB 47387152b1d0Swdenk RAM, and want to reserve 4 MB from use by Linux, 4739c609719bSwdenk you can do this by adding "mem=12M" to the value of 4740c609719bSwdenk the "bootargs" variable. However, now you must make 47417152b1d0Swdenk sure that the initrd image is placed in the first 4742c609719bSwdenk 12 MB as well - this can be done with 4743c609719bSwdenk 4744c609719bSwdenk setenv initrd_high 00c00000 4745c609719bSwdenk 474638b99261Swdenk If you set initrd_high to 0xFFFFFFFF, this is an 474738b99261Swdenk indication to U-Boot that all addresses are legal 474838b99261Swdenk for the Linux kernel, including addresses in flash 474938b99261Swdenk memory. In this case U-Boot will NOT COPY the 475038b99261Swdenk ramdisk at all. This may be useful to reduce the 475138b99261Swdenk boot time on your system, but requires that this 475238b99261Swdenk feature is supported by your Linux kernel. 475338b99261Swdenk 4754c609719bSwdenk ipaddr - IP address; needed for tftpboot command 4755c609719bSwdenk 4756c609719bSwdenk loadaddr - Default load address for commands like "bootp", 4757dc7c9a1aSwdenk "rarpboot", "tftpboot", "loadb" or "diskboot" 4758c609719bSwdenk 4759c609719bSwdenk loads_echo - see CONFIG_LOADS_ECHO 4760c609719bSwdenk 4761c609719bSwdenk serverip - TFTP server IP address; needed for tftpboot command 4762c609719bSwdenk 4763c609719bSwdenk bootretry - see CONFIG_BOOT_RETRY_TIME 4764c609719bSwdenk 4765c609719bSwdenk bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR 4766c609719bSwdenk 4767c609719bSwdenk bootstopkey - see CONFIG_AUTOBOOT_STOP_STR 4768c609719bSwdenk 4769e2a53458SMike Frysinger ethprime - controls which interface is used first. 4770a3d991bdSwdenk 4771e2a53458SMike Frysinger ethact - controls which interface is currently active. 4772e2a53458SMike Frysinger For example you can do the following 4773a3d991bdSwdenk 477448690d80SHeiko Schocher => setenv ethact FEC 477548690d80SHeiko Schocher => ping 192.168.0.1 # traffic sent on FEC 477648690d80SHeiko Schocher => setenv ethact SCC 477748690d80SHeiko Schocher => ping 10.0.0.1 # traffic sent on SCC 4778a3d991bdSwdenk 4779e1692577SMatthias Fuchs ethrotate - When set to "no" U-Boot does not go through all 4780e1692577SMatthias Fuchs available network interfaces. 4781e1692577SMatthias Fuchs It just stays at the currently selected interface. 4782e1692577SMatthias Fuchs 4783a3d991bdSwdenk netretry - When set to "no" each network operation will 4784a3d991bdSwdenk either succeed or fail without retrying. 47856e592385Swdenk When set to "once" the network operation will 47866e592385Swdenk fail when all the available network interfaces 47876e592385Swdenk are tried once without success. 4788a3d991bdSwdenk Useful on scripts which control the retry operation 4789a3d991bdSwdenk themselves. 4790a3d991bdSwdenk 4791b4e2f89dSJean-Christophe PLAGNIOL-VILLARD npe_ucode - set load address for the NPE microcode 4792a1cf027aSJean-Christophe PLAGNIOL-VILLARD 47938d51aacdSSimon Glass silent_linux - If set then linux will be told to boot silently, by 47948d51aacdSSimon Glass changing the console to be empty. If "yes" it will be 47958d51aacdSSimon Glass made silent. If "no" it will not be made silent. If 47968d51aacdSSimon Glass unset, then it will be made silent if the U-Boot console 47978d51aacdSSimon Glass is silent. 47988d51aacdSSimon Glass 479928cb9375SWolfgang Denk tftpsrcport - If this is set, the value is used for TFTP's 4800ecb0ccd9SWolfgang Denk UDP source port. 4801ecb0ccd9SWolfgang Denk 480228cb9375SWolfgang Denk tftpdstport - If this is set, the value is used for TFTP's UDP 480328cb9375SWolfgang Denk destination port instead of the Well Know Port 69. 480428cb9375SWolfgang Denk 4805c96f86eeSWolfgang Denk tftpblocksize - Block size to use for TFTP transfers; if not set, 4806c96f86eeSWolfgang Denk we use the TFTP server's default block size 4807c96f86eeSWolfgang Denk 4808c96f86eeSWolfgang Denk tftptimeout - Retransmission timeout for TFTP packets (in milli- 4809c96f86eeSWolfgang Denk seconds, minimum value is 1000 = 1 second). Defines 4810c96f86eeSWolfgang Denk when a packet is considered to be lost so it has to 4811c96f86eeSWolfgang Denk be retransmitted. The default is 5000 = 5 seconds. 4812c96f86eeSWolfgang Denk Lowering this value may make downloads succeed 4813c96f86eeSWolfgang Denk faster in networks with high packet loss rates or 4814c96f86eeSWolfgang Denk with unreliable TFTP servers. 4815c96f86eeSWolfgang Denk 4816a3d991bdSwdenk vlan - When set to a value < 4095 the traffic over 481711ccc33fSMarcel Ziswiler Ethernet is encapsulated/received over 802.1q 4818a3d991bdSwdenk VLAN tagged frames. 4819c609719bSwdenk 4820dc0b7b0eSJason HobbsThe following image location variables contain the location of images 4821dc0b7b0eSJason Hobbsused in booting. The "Image" column gives the role of the image and is 4822dc0b7b0eSJason Hobbsnot an environment variable name. The other columns are environment 4823dc0b7b0eSJason Hobbsvariable names. "File Name" gives the name of the file on a TFTP 4824dc0b7b0eSJason Hobbsserver, "RAM Address" gives the location in RAM the image will be 4825dc0b7b0eSJason Hobbsloaded to, and "Flash Location" gives the image's address in NOR 4826dc0b7b0eSJason Hobbsflash or offset in NAND flash. 4827dc0b7b0eSJason Hobbs 4828dc0b7b0eSJason Hobbs*Note* - these variables don't have to be defined for all boards, some 4829dc0b7b0eSJason Hobbsboards currenlty use other variables for these purposes, and some 4830dc0b7b0eSJason Hobbsboards use these variables for other purposes. 4831dc0b7b0eSJason Hobbs 4832dc0b7b0eSJason HobbsImage File Name RAM Address Flash Location 4833dc0b7b0eSJason Hobbs----- --------- ----------- -------------- 4834dc0b7b0eSJason Hobbsu-boot u-boot u-boot_addr_r u-boot_addr 4835dc0b7b0eSJason HobbsLinux kernel bootfile kernel_addr_r kernel_addr 4836dc0b7b0eSJason Hobbsdevice tree blob fdtfile fdt_addr_r fdt_addr 4837dc0b7b0eSJason Hobbsramdisk ramdiskfile ramdisk_addr_r ramdisk_addr 4838dc0b7b0eSJason Hobbs 4839c609719bSwdenkThe following environment variables may be used and automatically 4840c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"), 4841c609719bSwdenkdepending the information provided by your boot server: 4842c609719bSwdenk 4843c609719bSwdenk bootfile - see above 4844c609719bSwdenk dnsip - IP address of your Domain Name Server 4845fe389a82Sstroese dnsip2 - IP address of your secondary Domain Name Server 4846c609719bSwdenk gatewayip - IP address of the Gateway (Router) to use 4847c609719bSwdenk hostname - Target hostname 4848c609719bSwdenk ipaddr - see above 4849c609719bSwdenk netmask - Subnet Mask 4850c609719bSwdenk rootpath - Pathname of the root filesystem on the NFS server 4851c609719bSwdenk serverip - see above 4852c609719bSwdenk 4853c609719bSwdenk 4854c609719bSwdenkThere are two special Environment Variables: 4855c609719bSwdenk 4856c609719bSwdenk serial# - contains hardware identification information such 4857c609719bSwdenk as type string and/or serial number 4858c609719bSwdenk ethaddr - Ethernet address 4859c609719bSwdenk 4860c609719bSwdenkThese variables can be set only once (usually during manufacturing of 4861c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables 4862c609719bSwdenkonce they have been set once. 4863c609719bSwdenk 4864c609719bSwdenk 4865c1551ea8SstroeseFurther special Environment Variables: 4866c1551ea8Sstroese 4867c1551ea8Sstroese ver - Contains the U-Boot version string as printed 4868c1551ea8Sstroese with the "version" command. This variable is 4869c1551ea8Sstroese readonly (see CONFIG_VERSION_VARIABLE). 4870c1551ea8Sstroese 4871c1551ea8Sstroese 4872c609719bSwdenkPlease note that changes to some configuration parameters may take 4873c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-). 4874c609719bSwdenk 4875c609719bSwdenk 4876170ab110SJoe HershbergerCallback functions for environment variables: 4877170ab110SJoe Hershberger--------------------------------------------- 4878170ab110SJoe Hershberger 4879170ab110SJoe HershbergerFor some environment variables, the behavior of u-boot needs to change 4880170ab110SJoe Hershbergerwhen their values are changed. This functionailty allows functions to 4881170ab110SJoe Hershbergerbe associated with arbitrary variables. On creation, overwrite, or 4882170ab110SJoe Hershbergerdeletion, the callback will provide the opportunity for some side 4883170ab110SJoe Hershbergereffect to happen or for the change to be rejected. 4884170ab110SJoe Hershberger 4885170ab110SJoe HershbergerThe callbacks are named and associated with a function using the 4886170ab110SJoe HershbergerU_BOOT_ENV_CALLBACK macro in your board or driver code. 4887170ab110SJoe Hershberger 4888170ab110SJoe HershbergerThese callbacks are associated with variables in one of two ways. The 4889170ab110SJoe Hershbergerstatic list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC 4890170ab110SJoe Hershbergerin the board configuration to a string that defines a list of 4891170ab110SJoe Hershbergerassociations. The list must be in the following format: 4892170ab110SJoe Hershberger 4893170ab110SJoe Hershberger entry = variable_name[:callback_name] 4894170ab110SJoe Hershberger list = entry[,list] 4895170ab110SJoe Hershberger 4896170ab110SJoe HershbergerIf the callback name is not specified, then the callback is deleted. 4897170ab110SJoe HershbergerSpaces are also allowed anywhere in the list. 4898170ab110SJoe Hershberger 4899170ab110SJoe HershbergerCallbacks can also be associated by defining the ".callbacks" variable 4900170ab110SJoe Hershbergerwith the same list format above. Any association in ".callbacks" will 4901170ab110SJoe Hershbergeroverride any association in the static list. You can define 4902170ab110SJoe HershbergerCONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the 4903170ab110SJoe Hershberger".callbacks" envirnoment variable in the default or embedded environment. 4904170ab110SJoe Hershberger 4905170ab110SJoe Hershberger 4906f07771ccSwdenkCommand Line Parsing: 4907f07771ccSwdenk===================== 4908f07771ccSwdenk 4909f07771ccSwdenkThere are two different command line parsers available with U-Boot: 49107152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell: 4911f07771ccSwdenk 4912f07771ccSwdenkOld, simple command line parser: 4913f07771ccSwdenk-------------------------------- 4914f07771ccSwdenk 4915f07771ccSwdenk- supports environment variables (through setenv / saveenv commands) 4916f07771ccSwdenk- several commands on one line, separated by ';' 4917fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax 4918f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\', 4919f07771ccSwdenk for example: 4920fe126d8bSWolfgang Denk setenv bootcmd bootm \${address} 4921f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example: 4922f07771ccSwdenk setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off' 4923f07771ccSwdenk 4924f07771ccSwdenkHush shell: 4925f07771ccSwdenk----------- 4926f07771ccSwdenk 4927f07771ccSwdenk- similar to Bourne shell, with control structures like 4928f07771ccSwdenk if...then...else...fi, for...do...done; while...do...done, 4929f07771ccSwdenk until...do...done, ... 4930f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv 4931f07771ccSwdenk commands) and local shell variables (through standard shell syntax 4932f07771ccSwdenk "name=value"); only environment variables can be used with "run" 4933f07771ccSwdenk command 4934f07771ccSwdenk 4935f07771ccSwdenkGeneral rules: 4936f07771ccSwdenk-------------- 4937f07771ccSwdenk 4938f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run" 4939f07771ccSwdenk command) contains several commands separated by semicolon, and 4940f07771ccSwdenk one of these commands fails, then the remaining commands will be 4941f07771ccSwdenk executed anyway. 4942f07771ccSwdenk 4943f07771ccSwdenk(2) If you execute several variables with one call to run (i. e. 494411ccc33fSMarcel Ziswiler calling run with a list of variables as arguments), any failing 4945f07771ccSwdenk command will cause "run" to terminate, i. e. the remaining 4946f07771ccSwdenk variables are not executed. 4947f07771ccSwdenk 4948c609719bSwdenkNote for Redundant Ethernet Interfaces: 4949c609719bSwdenk======================================= 4950c609719bSwdenk 495111ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports 4952c609719bSwdenksuch configurations and is capable of automatic selection of a 49537152b1d0Swdenk"working" interface when needed. MAC assignment works as follows: 4954c609719bSwdenk 4955c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding 4956c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0), 4957c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ... 4958c609719bSwdenk 4959c609719bSwdenkIf the network interface stores some valid MAC address (for instance 4960c609719bSwdenkin SROM), this is used as default address if there is NO correspon- 4961c609719bSwdenkding setting in the environment; if the corresponding environment 4962c609719bSwdenkvariable is set, this overrides the settings in the card; that means: 4963c609719bSwdenk 4964c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the 4965c609719bSwdenk environment, the SROM's address is used. 4966c609719bSwdenk 4967c609719bSwdenko If there is no valid address in the SROM, and a definition in the 4968c609719bSwdenk environment exists, then the value from the environment variable is 4969c609719bSwdenk used. 4970c609719bSwdenk 4971c609719bSwdenko If both the SROM and the environment contain a MAC address, and 4972c609719bSwdenk both addresses are the same, this MAC address is used. 4973c609719bSwdenk 4974c609719bSwdenko If both the SROM and the environment contain a MAC address, and the 4975c609719bSwdenk addresses differ, the value from the environment is used and a 4976c609719bSwdenk warning is printed. 4977c609719bSwdenk 4978c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error 4979c609719bSwdenk is raised. 4980c609719bSwdenk 4981ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses 4982ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process. This 4983ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable. 4984ecee9324SBen WarrenThe naming convention is as follows: 4985ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc. 4986c609719bSwdenk 4987c609719bSwdenkImage Formats: 4988c609719bSwdenk============== 4989c609719bSwdenk 49903310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on) 49913310c549SMarian Balakowiczimages in two formats: 49923310c549SMarian Balakowicz 49933310c549SMarian BalakowiczNew uImage format (FIT) 49943310c549SMarian Balakowicz----------------------- 49953310c549SMarian Balakowicz 49963310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar 49973310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple 49983310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by 49993310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory. 50003310c549SMarian Balakowicz 50013310c549SMarian Balakowicz 50023310c549SMarian BalakowiczOld uImage format 50033310c549SMarian Balakowicz----------------- 50043310c549SMarian Balakowicz 50053310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything, 50063310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for 50073310c549SMarian Balakowiczdetails; basically, the header defines the following image properties: 5008c609719bSwdenk 5009c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD, 5010c609719bSwdenk 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks, 5011f5ed9e39SPeter Tyser LynxOS, pSOS, QNX, RTEMS, INTEGRITY; 5012f5ed9e39SPeter Tyser Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS, 5013f5ed9e39SPeter Tyser INTEGRITY). 50147b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86, 5015afc1ce82SMacpaul Lin IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit; 5016afc1ce82SMacpaul Lin Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC). 5017c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2) 5018c609719bSwdenk* Load Address 5019c609719bSwdenk* Entry Point 5020c609719bSwdenk* Image Name 5021c609719bSwdenk* Image Timestamp 5022c609719bSwdenk 5023c609719bSwdenkThe header is marked by a special Magic Number, and both the header 5024c609719bSwdenkand the data portions of the image are secured against corruption by 5025c609719bSwdenkCRC32 checksums. 5026c609719bSwdenk 5027c609719bSwdenk 5028c609719bSwdenkLinux Support: 5029c609719bSwdenk============== 5030c609719bSwdenk 5031c609719bSwdenkAlthough U-Boot should support any OS or standalone application 50327152b1d0Swdenkeasily, the main focus has always been on Linux during the design of 5033c609719bSwdenkU-Boot. 5034c609719bSwdenk 5035c609719bSwdenkU-Boot includes many features that so far have been part of some 5036c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any 5037c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image; 5038c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation 50397152b1d0Swdenkserves several purposes: 5040c609719bSwdenk 5041c609719bSwdenk- the same features can be used for other OS or standalone 5042c609719bSwdenk applications (for instance: using compressed images to reduce the 5043c609719bSwdenk Flash memory footprint) 5044c609719bSwdenk 5045c609719bSwdenk- it becomes much easier to port new Linux kernel versions because 50467152b1d0Swdenk lots of low-level, hardware dependent stuff are done by U-Boot 5047c609719bSwdenk 5048c609719bSwdenk- the same Linux kernel image can now be used with different "initrd" 5049c609719bSwdenk images; of course this also means that different kernel images can 5050c609719bSwdenk be run with the same "initrd". This makes testing easier (you don't 5051c609719bSwdenk have to build a new "zImage.initrd" Linux image when you just 5052c609719bSwdenk change a file in your "initrd"). Also, a field-upgrade of the 5053c609719bSwdenk software is easier now. 5054c609719bSwdenk 5055c609719bSwdenk 5056c609719bSwdenkLinux HOWTO: 5057c609719bSwdenk============ 5058c609719bSwdenk 5059c609719bSwdenkPorting Linux to U-Boot based systems: 5060c609719bSwdenk--------------------------------------- 5061c609719bSwdenk 5062c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to 5063c609719bSwdenkconfigure the Linux device drivers for use with your target hardware 5064c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to 5065c609719bSwdenkLinux :-). 5066c609719bSwdenk 5067a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot). 5068c609719bSwdenk 5069c609719bSwdenkJust make sure your machine specific header file (for instance 5070c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board 50711dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h, 50721dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value 50736d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR. 5074c609719bSwdenk 5075c609719bSwdenk 5076c609719bSwdenkConfiguring the Linux kernel: 5077c609719bSwdenk----------------------------- 5078c609719bSwdenk 5079c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root 5080c609719bSwdenkdevice (initial ramdisk, NFS) for your target system. 5081c609719bSwdenk 5082c609719bSwdenk 5083c609719bSwdenkBuilding a Linux Image: 5084c609719bSwdenk----------------------- 5085c609719bSwdenk 508624ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are 508724ee89b9Swdenknot used. If you use recent kernel source, a new build target 508824ee89b9Swdenk"uImage" will exist which automatically builds an image usable by 508924ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target, 509024ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a 509124ee89b9Swdenk100% compatible format. 5092c609719bSwdenk 5093c609719bSwdenkExample: 5094c609719bSwdenk 5095c609719bSwdenk make TQM850L_config 5096c609719bSwdenk make oldconfig 5097c609719bSwdenk make dep 509824ee89b9Swdenk make uImage 5099c609719bSwdenk 510024ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to 510124ee89b9Swdenkencapsulate a compressed Linux kernel image with header information, 510224ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing: 5103c609719bSwdenk 510424ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format): 510524ee89b9Swdenk 510624ee89b9Swdenk* convert the kernel into a raw binary image: 510724ee89b9Swdenk 510824ee89b9Swdenk ${CROSS_COMPILE}-objcopy -O binary \ 510924ee89b9Swdenk -R .note -R .comment \ 511024ee89b9Swdenk -S vmlinux linux.bin 511124ee89b9Swdenk 511224ee89b9Swdenk* compress the binary image: 511324ee89b9Swdenk 511424ee89b9Swdenk gzip -9 linux.bin 511524ee89b9Swdenk 511624ee89b9Swdenk* package compressed binary image for U-Boot: 511724ee89b9Swdenk 511824ee89b9Swdenk mkimage -A ppc -O linux -T kernel -C gzip \ 511924ee89b9Swdenk -a 0 -e 0 -n "Linux Kernel Image" \ 512024ee89b9Swdenk -d linux.bin.gz uImage 512124ee89b9Swdenk 512224ee89b9Swdenk 512324ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use 512424ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or 512524ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64 512624ee89b9Swdenkbyte header containing information about target architecture, 512724ee89b9Swdenkoperating system, image type, compression method, entry points, time 512824ee89b9Swdenkstamp, CRC32 checksums, etc. 512924ee89b9Swdenk 513024ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and 513124ee89b9Swdenkprint the header information, or to build new images. 5132c609719bSwdenk 5133c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information 5134c609719bSwdenkcontained in the header of an existing U-Boot image; this includes 5135c609719bSwdenkchecksum verification: 5136c609719bSwdenk 5137c609719bSwdenk tools/mkimage -l image 5138c609719bSwdenk -l ==> list image header information 5139c609719bSwdenk 5140c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image 5141c609719bSwdenkfrom a "data file" which is used as image payload: 5142c609719bSwdenk 5143c609719bSwdenk tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \ 5144c609719bSwdenk -n name -d data_file image 5145c609719bSwdenk -A ==> set architecture to 'arch' 5146c609719bSwdenk -O ==> set operating system to 'os' 5147c609719bSwdenk -T ==> set image type to 'type' 5148c609719bSwdenk -C ==> set compression type 'comp' 5149c609719bSwdenk -a ==> set load address to 'addr' (hex) 5150c609719bSwdenk -e ==> set entry point to 'ep' (hex) 5151c609719bSwdenk -n ==> set image name to 'name' 5152c609719bSwdenk -d ==> use image data from 'datafile' 5153c609719bSwdenk 515469459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load 515569459791Swdenkaddress (0x00000000), but the entry point address depends on the 515669459791Swdenkkernel version: 5157c609719bSwdenk 5158c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C, 515924ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000. 5160c609719bSwdenk 5161c609719bSwdenkSo a typical call to build a U-Boot image would read: 5162c609719bSwdenk 516324ee89b9Swdenk -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 516424ee89b9Swdenk > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \ 5165a47a12beSStefan Roese > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \ 516624ee89b9Swdenk > examples/uImage.TQM850L 516724ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 5168c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 5169c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 5170c609719bSwdenk Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 5171c609719bSwdenk Load Address: 0x00000000 517224ee89b9Swdenk Entry Point: 0x00000000 5173c609719bSwdenk 5174c609719bSwdenkTo verify the contents of the image (or check for corruption): 5175c609719bSwdenk 517624ee89b9Swdenk -> tools/mkimage -l examples/uImage.TQM850L 517724ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 5178c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 5179c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 5180c609719bSwdenk Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 5181c609719bSwdenk Load Address: 0x00000000 518224ee89b9Swdenk Entry Point: 0x00000000 5183c609719bSwdenk 5184c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade 5185c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this 5186c609719bSwdenkneeds more space in Flash, but boots much faster since it does not 5187c609719bSwdenkneed to be uncompressed: 5188c609719bSwdenk 5189a47a12beSStefan Roese -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz 519024ee89b9Swdenk -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 519124ee89b9Swdenk > -A ppc -O linux -T kernel -C none -a 0 -e 0 \ 5192a47a12beSStefan Roese > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \ 519324ee89b9Swdenk > examples/uImage.TQM850L-uncompressed 519424ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 5195c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 5196c609719bSwdenk Image Type: PowerPC Linux Kernel Image (uncompressed) 5197c609719bSwdenk Data Size: 792160 Bytes = 773.59 kB = 0.76 MB 5198c609719bSwdenk Load Address: 0x00000000 519924ee89b9Swdenk Entry Point: 0x00000000 5200c609719bSwdenk 5201c609719bSwdenk 5202c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file 5203c609719bSwdenkwhen your kernel is intended to use an initial ramdisk: 5204c609719bSwdenk 5205c609719bSwdenk -> tools/mkimage -n 'Simple Ramdisk Image' \ 5206c609719bSwdenk > -A ppc -O linux -T ramdisk -C gzip \ 5207c609719bSwdenk > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd 5208c609719bSwdenk Image Name: Simple Ramdisk Image 5209c609719bSwdenk Created: Wed Jan 12 14:01:50 2000 5210c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 5211c609719bSwdenk Data Size: 566530 Bytes = 553.25 kB = 0.54 MB 5212c609719bSwdenk Load Address: 0x00000000 5213c609719bSwdenk Entry Point: 0x00000000 5214c609719bSwdenk 5215c609719bSwdenk 5216c609719bSwdenkInstalling a Linux Image: 5217c609719bSwdenk------------------------- 5218c609719bSwdenk 5219c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface, 5220c609719bSwdenkyou must convert the image to S-Record format: 5221c609719bSwdenk 5222c609719bSwdenk objcopy -I binary -O srec examples/image examples/image.srec 5223c609719bSwdenk 5224c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot 5225c609719bSwdenkimage header, so the resulting S-Record file will be relative to 5226c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to 5227c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads' 5228c609719bSwdenkcommand. 5229c609719bSwdenk 5230c609719bSwdenkExample: install the image to address 0x40100000 (which on the 5231c609719bSwdenkTQM8xxL is in the first Flash bank): 5232c609719bSwdenk 5233c609719bSwdenk => erase 40100000 401FFFFF 5234c609719bSwdenk 5235c609719bSwdenk .......... done 5236c609719bSwdenk Erased 8 sectors 5237c609719bSwdenk 5238c609719bSwdenk => loads 40100000 5239c609719bSwdenk ## Ready for S-Record download ... 5240c609719bSwdenk ~>examples/image.srec 5241c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 12 13 ... 5242c609719bSwdenk ... 5243c609719bSwdenk 15989 15990 15991 15992 5244c609719bSwdenk [file transfer complete] 5245c609719bSwdenk [connected] 5246c609719bSwdenk ## Start Addr = 0x00000000 5247c609719bSwdenk 5248c609719bSwdenk 5249c609719bSwdenkYou can check the success of the download using the 'iminfo' command; 5250c609719bSwdenkthis includes a checksum verification so you can be sure no data 5251c609719bSwdenkcorruption happened: 5252c609719bSwdenk 5253c609719bSwdenk => imi 40100000 5254c609719bSwdenk 5255c609719bSwdenk ## Checking Image at 40100000 ... 5256c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 5257c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 5258c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 5259c609719bSwdenk Load Address: 00000000 5260c609719bSwdenk Entry Point: 0000000c 5261c609719bSwdenk Verifying Checksum ... OK 5262c609719bSwdenk 5263c609719bSwdenk 5264c609719bSwdenkBoot Linux: 5265c609719bSwdenk----------- 5266c609719bSwdenk 5267c609719bSwdenkThe "bootm" command is used to boot an application that is stored in 5268c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents 5269c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as 5270c609719bSwdenkparameters. You can check and modify this variable using the 5271c609719bSwdenk"printenv" and "setenv" commands: 5272c609719bSwdenk 5273c609719bSwdenk 5274c609719bSwdenk => printenv bootargs 5275c609719bSwdenk bootargs=root=/dev/ram 5276c609719bSwdenk 5277c609719bSwdenk => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 5278c609719bSwdenk 5279c609719bSwdenk => printenv bootargs 5280c609719bSwdenk bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 5281c609719bSwdenk 5282c609719bSwdenk => bootm 40020000 5283c609719bSwdenk ## Booting Linux kernel at 40020000 ... 5284c609719bSwdenk Image Name: 2.2.13 for NFS on TQM850L 5285c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 5286c609719bSwdenk Data Size: 381681 Bytes = 372 kB = 0 MB 5287c609719bSwdenk Load Address: 00000000 5288c609719bSwdenk Entry Point: 0000000c 5289c609719bSwdenk Verifying Checksum ... OK 5290c609719bSwdenk Uncompressing Kernel Image ... OK 5291c609719bSwdenk 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 5292c609719bSwdenk Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 5293c609719bSwdenk time_init: decrementer frequency = 187500000/60 5294c609719bSwdenk Calibrating delay loop... 49.77 BogoMIPS 5295c609719bSwdenk Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000] 5296c609719bSwdenk ... 5297c609719bSwdenk 529811ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass 52997152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT 5300c609719bSwdenkformat!) to the "bootm" command: 5301c609719bSwdenk 5302c609719bSwdenk => imi 40100000 40200000 5303c609719bSwdenk 5304c609719bSwdenk ## Checking Image at 40100000 ... 5305c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 5306c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 5307c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 5308c609719bSwdenk Load Address: 00000000 5309c609719bSwdenk Entry Point: 0000000c 5310c609719bSwdenk Verifying Checksum ... OK 5311c609719bSwdenk 5312c609719bSwdenk ## Checking Image at 40200000 ... 5313c609719bSwdenk Image Name: Simple Ramdisk Image 5314c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 5315c609719bSwdenk Data Size: 566530 Bytes = 553 kB = 0 MB 5316c609719bSwdenk Load Address: 00000000 5317c609719bSwdenk Entry Point: 00000000 5318c609719bSwdenk Verifying Checksum ... OK 5319c609719bSwdenk 5320c609719bSwdenk => bootm 40100000 40200000 5321c609719bSwdenk ## Booting Linux kernel at 40100000 ... 5322c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 5323c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 5324c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 5325c609719bSwdenk Load Address: 00000000 5326c609719bSwdenk Entry Point: 0000000c 5327c609719bSwdenk Verifying Checksum ... OK 5328c609719bSwdenk Uncompressing Kernel Image ... OK 5329c609719bSwdenk ## Loading RAMDisk Image at 40200000 ... 5330c609719bSwdenk Image Name: Simple Ramdisk Image 5331c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 5332c609719bSwdenk Data Size: 566530 Bytes = 553 kB = 0 MB 5333c609719bSwdenk Load Address: 00000000 5334c609719bSwdenk Entry Point: 00000000 5335c609719bSwdenk Verifying Checksum ... OK 5336c609719bSwdenk Loading Ramdisk ... OK 5337c609719bSwdenk 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 5338c609719bSwdenk Boot arguments: root=/dev/ram 5339c609719bSwdenk time_init: decrementer frequency = 187500000/60 5340c609719bSwdenk Calibrating delay loop... 49.77 BogoMIPS 5341c609719bSwdenk ... 5342c609719bSwdenk RAMDISK: Compressed image found at block 0 5343c609719bSwdenk VFS: Mounted root (ext2 filesystem). 5344c609719bSwdenk 5345c609719bSwdenk bash# 5346c609719bSwdenk 53470267768eSMatthew McClintockBoot Linux and pass a flat device tree: 53480267768eSMatthew McClintock----------- 53490267768eSMatthew McClintock 53500267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section 53510267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The 53520267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated 53530267768eSMatthew McClintockflat device tree: 53540267768eSMatthew McClintock 53550267768eSMatthew McClintock=> print oftaddr 53560267768eSMatthew McClintockoftaddr=0x300000 53570267768eSMatthew McClintock=> print oft 53580267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb 53590267768eSMatthew McClintock=> tftp $oftaddr $oft 53600267768eSMatthew McClintockSpeed: 1000, full duplex 53610267768eSMatthew McClintockUsing TSEC0 device 53620267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101 53630267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'. 53640267768eSMatthew McClintockLoad address: 0x300000 53650267768eSMatthew McClintockLoading: # 53660267768eSMatthew McClintockdone 53670267768eSMatthew McClintockBytes transferred = 4106 (100a hex) 53680267768eSMatthew McClintock=> tftp $loadaddr $bootfile 53690267768eSMatthew McClintockSpeed: 1000, full duplex 53700267768eSMatthew McClintockUsing TSEC0 device 53710267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2 53720267768eSMatthew McClintockFilename 'uImage'. 53730267768eSMatthew McClintockLoad address: 0x200000 53740267768eSMatthew McClintockLoading:############ 53750267768eSMatthew McClintockdone 53760267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex) 53770267768eSMatthew McClintock=> print loadaddr 53780267768eSMatthew McClintockloadaddr=200000 53790267768eSMatthew McClintock=> print oftaddr 53800267768eSMatthew McClintockoftaddr=0x300000 53810267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr 53820267768eSMatthew McClintock## Booting image at 00200000 ... 53830267768eSMatthew McClintock Image Name: Linux-2.6.17-dirty 53840267768eSMatthew McClintock Image Type: PowerPC Linux Kernel Image (gzip compressed) 53850267768eSMatthew McClintock Data Size: 1029343 Bytes = 1005.2 kB 53860267768eSMatthew McClintock Load Address: 00000000 53870267768eSMatthew McClintock Entry Point: 00000000 53880267768eSMatthew McClintock Verifying Checksum ... OK 53890267768eSMatthew McClintock Uncompressing Kernel Image ... OK 53900267768eSMatthew McClintockBooting using flat device tree at 0x300000 53910267768eSMatthew McClintockUsing MPC85xx ADS machine description 53920267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb 53930267768eSMatthew McClintock[snip] 53940267768eSMatthew McClintock 53950267768eSMatthew McClintock 53966069ff26SwdenkMore About U-Boot Image Types: 53976069ff26Swdenk------------------------------ 53986069ff26Swdenk 53996069ff26SwdenkU-Boot supports the following image types: 54006069ff26Swdenk 54016069ff26Swdenk "Standalone Programs" are directly runnable in the environment 54026069ff26Swdenk provided by U-Boot; it is expected that (if they behave 54036069ff26Swdenk well) you can continue to work in U-Boot after return from 54046069ff26Swdenk the Standalone Program. 54056069ff26Swdenk "OS Kernel Images" are usually images of some Embedded OS which 54066069ff26Swdenk will take over control completely. Usually these programs 54076069ff26Swdenk will install their own set of exception handlers, device 54086069ff26Swdenk drivers, set up the MMU, etc. - this means, that you cannot 54096069ff26Swdenk expect to re-enter U-Boot except by resetting the CPU. 54106069ff26Swdenk "RAMDisk Images" are more or less just data blocks, and their 54116069ff26Swdenk parameters (address, size) are passed to an OS kernel that is 54126069ff26Swdenk being started. 54136069ff26Swdenk "Multi-File Images" contain several images, typically an OS 54146069ff26Swdenk (Linux) kernel image and one or more data images like 54156069ff26Swdenk RAMDisks. This construct is useful for instance when you want 54166069ff26Swdenk to boot over the network using BOOTP etc., where the boot 54176069ff26Swdenk server provides just a single image file, but you want to get 54186069ff26Swdenk for instance an OS kernel and a RAMDisk image. 54196069ff26Swdenk 54206069ff26Swdenk "Multi-File Images" start with a list of image sizes, each 54216069ff26Swdenk image size (in bytes) specified by an "uint32_t" in network 54226069ff26Swdenk byte order. This list is terminated by an "(uint32_t)0". 54236069ff26Swdenk Immediately after the terminating 0 follow the images, one by 54246069ff26Swdenk one, all aligned on "uint32_t" boundaries (size rounded up to 54256069ff26Swdenk a multiple of 4 bytes). 54266069ff26Swdenk 54276069ff26Swdenk "Firmware Images" are binary images containing firmware (like 54286069ff26Swdenk U-Boot or FPGA images) which usually will be programmed to 54296069ff26Swdenk flash memory. 54306069ff26Swdenk 54316069ff26Swdenk "Script files" are command sequences that will be executed by 54326069ff26Swdenk U-Boot's command interpreter; this feature is especially 54336069ff26Swdenk useful when you configure U-Boot to use a real shell (hush) 54346069ff26Swdenk as command interpreter. 54356069ff26Swdenk 543644f074c7SMarek VasutBooting the Linux zImage: 543744f074c7SMarek Vasut------------------------- 543844f074c7SMarek Vasut 543944f074c7SMarek VasutOn some platforms, it's possible to boot Linux zImage. This is done 544044f074c7SMarek Vasutusing the "bootz" command. The syntax of "bootz" command is the same 544144f074c7SMarek Vasutas the syntax of "bootm" command. 544244f074c7SMarek Vasut 54438ac28563STom RiniNote, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply 5444017e1f3fSMarek Vasutkernel with raw initrd images. The syntax is slightly different, the 5445017e1f3fSMarek Vasutaddress of the initrd must be augmented by it's size, in the following 5446017e1f3fSMarek Vasutformat: "<initrd addres>:<initrd size>". 5447017e1f3fSMarek Vasut 5448c609719bSwdenk 5449c609719bSwdenkStandalone HOWTO: 5450c609719bSwdenk================= 5451c609719bSwdenk 5452c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and 5453c609719bSwdenkrun "standalone" applications, which can use some resources of 5454c609719bSwdenkU-Boot like console I/O functions or interrupt services. 5455c609719bSwdenk 5456c609719bSwdenkTwo simple examples are included with the sources: 5457c609719bSwdenk 5458c609719bSwdenk"Hello World" Demo: 5459c609719bSwdenk------------------- 5460c609719bSwdenk 5461c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo 5462c609719bSwdenkapplication; it is automatically compiled when you build U-Boot. 5463c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it 5464c609719bSwdenklike that: 5465c609719bSwdenk 5466c609719bSwdenk => loads 5467c609719bSwdenk ## Ready for S-Record download ... 5468c609719bSwdenk ~>examples/hello_world.srec 5469c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 ... 5470c609719bSwdenk [file transfer complete] 5471c609719bSwdenk [connected] 5472c609719bSwdenk ## Start Addr = 0x00040004 5473c609719bSwdenk 5474c609719bSwdenk => go 40004 Hello World! This is a test. 5475c609719bSwdenk ## Starting application at 0x00040004 ... 5476c609719bSwdenk Hello World 5477c609719bSwdenk argc = 7 5478c609719bSwdenk argv[0] = "40004" 5479c609719bSwdenk argv[1] = "Hello" 5480c609719bSwdenk argv[2] = "World!" 5481c609719bSwdenk argv[3] = "This" 5482c609719bSwdenk argv[4] = "is" 5483c609719bSwdenk argv[5] = "a" 5484c609719bSwdenk argv[6] = "test." 5485c609719bSwdenk argv[7] = "<NULL>" 5486c609719bSwdenk Hit any key to exit ... 5487c609719bSwdenk 5488c609719bSwdenk ## Application terminated, rc = 0x0 5489c609719bSwdenk 5490c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt 5491c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'. 5492c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second. 5493c609719bSwdenkThe interrupt service routine is trivial, just printing a '.' 5494c609719bSwdenkcharacter, but this is just a demo program. The application can be 5495c609719bSwdenkcontrolled by the following keys: 5496c609719bSwdenk 5497c609719bSwdenk ? - print current values og the CPM Timer registers 5498c609719bSwdenk b - enable interrupts and start timer 5499c609719bSwdenk e - stop timer and disable interrupts 5500c609719bSwdenk q - quit application 5501c609719bSwdenk 5502c609719bSwdenk => loads 5503c609719bSwdenk ## Ready for S-Record download ... 5504c609719bSwdenk ~>examples/timer.srec 5505c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 ... 5506c609719bSwdenk [file transfer complete] 5507c609719bSwdenk [connected] 5508c609719bSwdenk ## Start Addr = 0x00040004 5509c609719bSwdenk 5510c609719bSwdenk => go 40004 5511c609719bSwdenk ## Starting application at 0x00040004 ... 5512c609719bSwdenk TIMERS=0xfff00980 5513c609719bSwdenk Using timer 1 5514c609719bSwdenk tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0 5515c609719bSwdenk 5516c609719bSwdenkHit 'b': 5517c609719bSwdenk [q, b, e, ?] Set interval 1000000 us 5518c609719bSwdenk Enabling timer 5519c609719bSwdenkHit '?': 5520c609719bSwdenk [q, b, e, ?] ........ 5521c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0 5522c609719bSwdenkHit '?': 5523c609719bSwdenk [q, b, e, ?] . 5524c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0 5525c609719bSwdenkHit '?': 5526c609719bSwdenk [q, b, e, ?] . 5527c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0 5528c609719bSwdenkHit '?': 5529c609719bSwdenk [q, b, e, ?] . 5530c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0 5531c609719bSwdenkHit 'e': 5532c609719bSwdenk [q, b, e, ?] ...Stopping timer 5533c609719bSwdenkHit 'q': 5534c609719bSwdenk [q, b, e, ?] ## Application terminated, rc = 0x0 5535c609719bSwdenk 5536c609719bSwdenk 553785ec0bccSwdenkMinicom warning: 553885ec0bccSwdenk================ 553985ec0bccSwdenk 55407152b1d0SwdenkOver time, many people have reported problems when trying to use the 554185ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd) 554285ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under 5543f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and 554485ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and 5545e53515a2SKarl O. Pincuse "cu" for S-Record download ("loads" command). See 5546e53515a2SKarl O. Pinchttp://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3. 5547e53515a2SKarl O. Pincfor help with kermit. 5548e53515a2SKarl O. Pinc 554985ec0bccSwdenk 555052f52c14SwdenkNevertheless, if you absolutely want to use it try adding this 555152f52c14Swdenkconfiguration to your "File transfer protocols" section: 555252f52c14Swdenk 555352f52c14Swdenk Name Program Name U/D FullScr IO-Red. Multi 555452f52c14Swdenk X kermit /usr/bin/kermit -i -l %l -s Y U Y N N 555552f52c14Swdenk Y kermit /usr/bin/kermit -i -l %l -r N D Y N N 555652f52c14Swdenk 555752f52c14Swdenk 5558c609719bSwdenkNetBSD Notes: 5559c609719bSwdenk============= 5560c609719bSwdenk 5561c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host 5562c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx). 5563c609719bSwdenk 5564c609719bSwdenkBuilding requires a cross environment; it is known to work on 5565c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also 5566c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make). 5567c609719bSwdenkNote that the cross-powerpc package does not install include files; 5568c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is 5569c609719bSwdenkmissing. This file has to be installed and patched manually: 5570c609719bSwdenk 5571c609719bSwdenk # cd /usr/pkg/cross/powerpc-netbsd/include 5572c609719bSwdenk # mkdir powerpc 5573c609719bSwdenk # ln -s powerpc machine 5574c609719bSwdenk # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h 5575c609719bSwdenk # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST 5576c609719bSwdenk 5577c609719bSwdenkNative builds *don't* work due to incompatibilities between native 5578c609719bSwdenkand U-Boot include files. 5579c609719bSwdenk 5580c609719bSwdenkBooting assumes that (the first part of) the image booted is a 5581c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel 5582c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source 5583c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the 55842a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz 5585c609719bSwdenk 5586c609719bSwdenk 5587c609719bSwdenkImplementation Internals: 5588c609719bSwdenk========================= 5589c609719bSwdenk 5590c609719bSwdenkThe following is not intended to be a complete description of every 5591c609719bSwdenkimplementation detail. However, it should help to understand the 5592c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom 5593c609719bSwdenkhardware. 5594c609719bSwdenk 5595c609719bSwdenk 5596c609719bSwdenkInitial Stack, Global Data: 5597c609719bSwdenk--------------------------- 5598c609719bSwdenk 5599c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot 5600c609719bSwdenkstarts running out of ROM (flash memory), usually without access to 5601c609719bSwdenksystem RAM (because the memory controller is not initialized yet). 5602c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS 5603c609719bSwdenkis not initialized as zero. To be able to get a C environment working 5604c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation 5605c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU 5606c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and 5607c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be 5608c609719bSwdenklocked as (mis-) used as memory, etc. 5609c609719bSwdenk 56107152b1d0Swdenk Chris Hallinan posted a good summary of these issues to the 56110668236bSWolfgang Denk U-Boot mailing list: 561243d9616cSwdenk 561343d9616cSwdenk Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)? 561443d9616cSwdenk From: "Chris Hallinan" <clh@net1plus.com> 561543d9616cSwdenk Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET) 561643d9616cSwdenk ... 561743d9616cSwdenk 561843d9616cSwdenk Correct me if I'm wrong, folks, but the way I understand it 561943d9616cSwdenk is this: Using DCACHE as initial RAM for Stack, etc, does not 562043d9616cSwdenk require any physical RAM backing up the cache. The cleverness 562143d9616cSwdenk is that the cache is being used as a temporary supply of 562243d9616cSwdenk necessary storage before the SDRAM controller is setup. It's 562311ccc33fSMarcel Ziswiler beyond the scope of this list to explain the details, but you 562443d9616cSwdenk can see how this works by studying the cache architecture and 562543d9616cSwdenk operation in the architecture and processor-specific manuals. 562643d9616cSwdenk 562743d9616cSwdenk OCM is On Chip Memory, which I believe the 405GP has 4K. It 562843d9616cSwdenk is another option for the system designer to use as an 562911ccc33fSMarcel Ziswiler initial stack/RAM area prior to SDRAM being available. Either 563043d9616cSwdenk option should work for you. Using CS 4 should be fine if your 563143d9616cSwdenk board designers haven't used it for something that would 563243d9616cSwdenk cause you grief during the initial boot! It is frequently not 563343d9616cSwdenk used. 563443d9616cSwdenk 56356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere 563643d9616cSwdenk with your processor/board/system design. The default value 563743d9616cSwdenk you will find in any recent u-boot distribution in 56388a316c9bSStefan Roese walnut.h should work for you. I'd set it to a value larger 563943d9616cSwdenk than your SDRAM module. If you have a 64MB SDRAM module, set 564043d9616cSwdenk it above 400_0000. Just make sure your board has no resources 564143d9616cSwdenk that are supposed to respond to that address! That code in 564243d9616cSwdenk start.S has been around a while and should work as is when 564343d9616cSwdenk you get the config right. 564443d9616cSwdenk 564543d9616cSwdenk -Chris Hallinan 564643d9616cSwdenk DS4.COM, Inc. 564743d9616cSwdenk 5648c609719bSwdenkIt is essential to remember this, since it has some impact on the C 5649c609719bSwdenkcode for the initialization procedures: 5650c609719bSwdenk 5651c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt 5652c609719bSwdenk to write it. 5653c609719bSwdenk 565411ccc33fSMarcel Ziswiler* Do not use any uninitialized global data (or implicitely initialized 5655c609719bSwdenk as zero data - BSS segment) at all - this is undefined, initiali- 56567152b1d0Swdenk zation is performed later (when relocating to RAM). 5657c609719bSwdenk 5658c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like 5659c609719bSwdenk that. 5660c609719bSwdenk 5661c609719bSwdenkHaving only the stack as writable memory limits means we cannot use 5662c609719bSwdenknormal global data to share information beween the code. But it 5663c609719bSwdenkturned out that the implementation of U-Boot can be greatly 5664c609719bSwdenksimplified by making a global data structure (gd_t) available to all 5665c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_ 5666c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of 5667c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we 5668c609719bSwdenkplace a pointer (gd) to the global data into a register which we 5669c609719bSwdenkreserve for this purpose. 5670c609719bSwdenk 56717152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the 5672c609719bSwdenkrelevant (E)ABI specifications for the current architecture, and by 5673c609719bSwdenkGCC's implementation. 5674c609719bSwdenk 5675c609719bSwdenkFor PowerPC, the following registers have specific use: 5676c609719bSwdenk R1: stack pointer 5677e7670f6cSWolfgang Denk R2: reserved for system use 5678c609719bSwdenk R3-R4: parameter passing and return values 5679c609719bSwdenk R5-R10: parameter passing 5680c609719bSwdenk R13: small data area pointer 5681c609719bSwdenk R30: GOT pointer 5682c609719bSwdenk R31: frame pointer 5683c609719bSwdenk 5684e6bee808SJoakim Tjernlund (U-Boot also uses R12 as internal GOT pointer. r12 5685e6bee808SJoakim Tjernlund is a volatile register so r12 needs to be reset when 5686e6bee808SJoakim Tjernlund going back and forth between asm and C) 5687c609719bSwdenk 5688e7670f6cSWolfgang Denk ==> U-Boot will use R2 to hold a pointer to the global data 5689c609719bSwdenk 5690c609719bSwdenk Note: on PPC, we could use a static initializer (since the 5691c609719bSwdenk address of the global data structure is known at compile time), 5692c609719bSwdenk but it turned out that reserving a register results in somewhat 5693c609719bSwdenk smaller code - although the code savings are not that big (on 5694c609719bSwdenk average for all boards 752 bytes for the whole U-Boot image, 5695c609719bSwdenk 624 text + 127 data). 5696c609719bSwdenk 5697c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here: 56984c58eb55SMike Frysinger http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface 56994c58eb55SMike Frysinger 5700c4db335cSRobin Getz ==> U-Boot will use P3 to hold a pointer to the global data 57014c58eb55SMike Frysinger 5702c609719bSwdenkOn ARM, the following registers are used: 5703c609719bSwdenk 5704c609719bSwdenk R0: function argument word/integer result 5705c609719bSwdenk R1-R3: function argument word 570612eba1b4SJeroen Hofstee R9: platform specific 570712eba1b4SJeroen Hofstee R10: stack limit (used only if stack checking is enabled) 5708c609719bSwdenk R11: argument (frame) pointer 5709c609719bSwdenk R12: temporary workspace 5710c609719bSwdenk R13: stack pointer 5711c609719bSwdenk R14: link register 5712c609719bSwdenk R15: program counter 5713c609719bSwdenk 571412eba1b4SJeroen Hofstee ==> U-Boot will use R9 to hold a pointer to the global data 571512eba1b4SJeroen Hofstee 571612eba1b4SJeroen Hofstee Note: on ARM, only R_ARM_RELATIVE relocations are supported. 5717c609719bSwdenk 57180df01fd3SThomas ChouOn Nios II, the ABI is documented here: 57190df01fd3SThomas Chou http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf 57200df01fd3SThomas Chou 57210df01fd3SThomas Chou ==> U-Boot will use gp to hold a pointer to the global data 57220df01fd3SThomas Chou 57230df01fd3SThomas Chou Note: on Nios II, we give "-G0" option to gcc and don't use gp 57240df01fd3SThomas Chou to access small data sections, so gp is free. 57250df01fd3SThomas Chou 5726afc1ce82SMacpaul LinOn NDS32, the following registers are used: 5727afc1ce82SMacpaul Lin 5728afc1ce82SMacpaul Lin R0-R1: argument/return 5729afc1ce82SMacpaul Lin R2-R5: argument 5730afc1ce82SMacpaul Lin R15: temporary register for assembler 5731afc1ce82SMacpaul Lin R16: trampoline register 5732afc1ce82SMacpaul Lin R28: frame pointer (FP) 5733afc1ce82SMacpaul Lin R29: global pointer (GP) 5734afc1ce82SMacpaul Lin R30: link register (LP) 5735afc1ce82SMacpaul Lin R31: stack pointer (SP) 5736afc1ce82SMacpaul Lin PC: program counter (PC) 5737afc1ce82SMacpaul Lin 5738afc1ce82SMacpaul Lin ==> U-Boot will use R10 to hold a pointer to the global data 5739afc1ce82SMacpaul Lin 5740d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope, 5741d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much. 5742c609719bSwdenk 5743c609719bSwdenkMemory Management: 5744c609719bSwdenk------------------ 5745c609719bSwdenk 5746c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the 5747c609719bSwdenkMMU is not used either for address mapping nor for memory protection. 5748c609719bSwdenk 5749c609719bSwdenkThe available memory is mapped to fixed addresses using the memory 5750c609719bSwdenkcontroller. In this process, a contiguous block is formed for each 5751c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several 5752c609719bSwdenkphysical memory banks. 5753c609719bSwdenk 5754c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on 5755c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After 5756c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself 5757c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some 57586d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN 5759c609719bSwdenkconfiguration setting]. Below that, a structure with global Board 5760c609719bSwdenkInfo data is placed, followed by the stack (growing downward). 5761c609719bSwdenk 5762c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB 5763c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF). 5764c609719bSwdenk 5765c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like 5766c609719bSwdenkthis: 5767c609719bSwdenk 5768c609719bSwdenk 0x0000 0000 Exception Vector code 5769c609719bSwdenk : 5770c609719bSwdenk 0x0000 1FFF 5771c609719bSwdenk 0x0000 2000 Free for Application Use 5772c609719bSwdenk : 5773c609719bSwdenk : 5774c609719bSwdenk 5775c609719bSwdenk : 5776c609719bSwdenk : 5777c609719bSwdenk 0x00FB FF20 Monitor Stack (Growing downward) 5778c609719bSwdenk 0x00FB FFAC Board Info Data and permanent copy of global data 5779c609719bSwdenk 0x00FC 0000 Malloc Arena 5780c609719bSwdenk : 5781c609719bSwdenk 0x00FD FFFF 5782c609719bSwdenk 0x00FE 0000 RAM Copy of Monitor Code 5783c609719bSwdenk ... eventually: LCD or video framebuffer 5784c609719bSwdenk ... eventually: pRAM (Protected RAM - unchanged by reset) 5785c609719bSwdenk 0x00FF FFFF [End of RAM] 5786c609719bSwdenk 5787c609719bSwdenk 5788c609719bSwdenkSystem Initialization: 5789c609719bSwdenk---------------------- 5790c609719bSwdenk 5791c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point 579211ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset 5793c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory. 57947152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address. 5795c609719bSwdenkTo be able to implement the initialization code in C, a (small!) 5796c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs 5797c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked 5798c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core, 5799c609719bSwdenkthe caches and the SIU. 5800c609719bSwdenk 5801c609719bSwdenkNext, all (potentially) available memory banks are mapped using a 5802c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries 5803c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash 5804c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is 5805c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a 5806c609719bSwdenksimple memory test is run that determines the size of the SDRAM 5807c609719bSwdenkbanks. 5808c609719bSwdenk 5809c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of 58107152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first 5811c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address 5812c609719bSwdenk0x00000000, with any additional banks following immediately to create 5813c609719bSwdenkcontiguous memory starting from 0. 5814c609719bSwdenk 5815c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area 5816c609719bSwdenkand allocates memory for use by malloc() and for the global Board 5817c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM 5818c609719bSwdenkpages, and the final stack is set up. 5819c609719bSwdenk 5820c609719bSwdenkOnly after this relocation will you have a "normal" C environment; 5821c609719bSwdenkuntil that you are restricted in several ways, mostly because you are 5822c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a 5823c609719bSwdenknew address in RAM. 5824c609719bSwdenk 5825c609719bSwdenk 5826c609719bSwdenkU-Boot Porting Guide: 5827c609719bSwdenk---------------------- 5828c609719bSwdenk 5829c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing 58306aff3115Swdenklist, October 2002] 5831c609719bSwdenk 5832c609719bSwdenk 5833c609719bSwdenkint main(int argc, char *argv[]) 5834c609719bSwdenk{ 5835c609719bSwdenk sighandler_t no_more_time; 5836c609719bSwdenk 5837c609719bSwdenk signal(SIGALRM, no_more_time); 5838c609719bSwdenk alarm(PROJECT_DEADLINE - toSec (3 * WEEK)); 5839c609719bSwdenk 5840c609719bSwdenk if (available_money > available_manpower) { 58416c3fef28SJerry Van Baren Pay consultant to port U-Boot; 5842c609719bSwdenk return 0; 5843c609719bSwdenk } 5844c609719bSwdenk 5845c609719bSwdenk Download latest U-Boot source; 5846c609719bSwdenk 58470668236bSWolfgang Denk Subscribe to u-boot mailing list; 58486aff3115Swdenk 58496c3fef28SJerry Van Baren if (clueless) 5850c609719bSwdenk email("Hi, I am new to U-Boot, how do I get started?"); 5851c609719bSwdenk 5852c609719bSwdenk while (learning) { 5853c609719bSwdenk Read the README file in the top level directory; 58547cb22f97Swdenk Read http://www.denx.de/twiki/bin/view/DULG/Manual; 58556c3fef28SJerry Van Baren Read applicable doc/*.README; 5856c609719bSwdenk Read the source, Luke; 58576c3fef28SJerry Van Baren /* find . -name "*.[chS]" | xargs grep -i <keyword> */ 5858c609719bSwdenk } 5859c609719bSwdenk 58606c3fef28SJerry Van Baren if (available_money > toLocalCurrency ($2500)) 58616c3fef28SJerry Van Baren Buy a BDI3000; 58626c3fef28SJerry Van Baren else 5863c609719bSwdenk Add a lot of aggravation and time; 5864c609719bSwdenk 58656c3fef28SJerry Van Baren if (a similar board exists) { /* hopefully... */ 58666c3fef28SJerry Van Baren cp -a board/<similar> board/<myboard> 58676c3fef28SJerry Van Baren cp include/configs/<similar>.h include/configs/<myboard>.h 58686c3fef28SJerry Van Baren } else { 5869c609719bSwdenk Create your own board support subdirectory; 58706c3fef28SJerry Van Baren Create your own board include/configs/<myboard>.h file; 58716c3fef28SJerry Van Baren } 58726c3fef28SJerry Van Baren Edit new board/<myboard> files 58736c3fef28SJerry Van Baren Edit new include/configs/<myboard>.h 5874c609719bSwdenk 58756c3fef28SJerry Van Baren while (!accepted) { 5876c609719bSwdenk while (!running) { 5877c609719bSwdenk do { 5878c609719bSwdenk Add / modify source code; 5879c609719bSwdenk } until (compiles); 5880c609719bSwdenk Debug; 5881c609719bSwdenk if (clueless) 5882c609719bSwdenk email("Hi, I am having problems..."); 5883c609719bSwdenk } 58846c3fef28SJerry Van Baren Send patch file to the U-Boot email list; 58856c3fef28SJerry Van Baren if (reasonable critiques) 58866c3fef28SJerry Van Baren Incorporate improvements from email list code review; 58876c3fef28SJerry Van Baren else 58886c3fef28SJerry Van Baren Defend code as written; 58896c3fef28SJerry Van Baren } 5890c609719bSwdenk 5891c609719bSwdenk return 0; 5892c609719bSwdenk} 5893c609719bSwdenk 5894c609719bSwdenkvoid no_more_time (int sig) 5895c609719bSwdenk{ 5896c609719bSwdenk hire_a_guru(); 5897c609719bSwdenk} 5898c609719bSwdenk 5899c609719bSwdenk 5900c609719bSwdenkCoding Standards: 5901c609719bSwdenk----------------- 5902c609719bSwdenk 5903c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel 59042c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script 59057ca9296eSWolfgang Denk"scripts/Lindent" in your Linux kernel source directory. 5906c609719bSwdenk 59072c051651SDetlev ZundelSource files originating from a different project (for example the 59082c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not 59092c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those 59102c051651SDetlev Zundelsources. 59112c051651SDetlev Zundel 59122c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in 59132c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//) 59142c051651SDetlev Zundelin your code. 5915c609719bSwdenk 5916c178d3daSwdenkPlease also stick to the following formatting rules: 5917180d3f74Swdenk- remove any trailing white space 59187ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces 5919180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds 59207ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files 5921180d3f74Swdenk- do not add trailing empty lines to source files 5922180d3f74Swdenk 5923c609719bSwdenkSubmissions which do not conform to the standards may be returned 5924c609719bSwdenkwith a request to reformat the changes. 5925c609719bSwdenk 5926c609719bSwdenk 5927c609719bSwdenkSubmitting Patches: 5928c609719bSwdenk------------------- 5929c609719bSwdenk 5930c609719bSwdenkSince the number of patches for U-Boot is growing, we need to 5931c609719bSwdenkestablish some rules. Submissions which do not conform to these rules 5932c609719bSwdenkmay be rejected, even when they contain important and valuable stuff. 5933c609719bSwdenk 59340d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details. 5935218ca724SWolfgang Denk 59360668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>; 59370668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot 59380668236bSWolfgang Denk 5939c609719bSwdenkWhen you send a patch, please include the following information with 5940c609719bSwdenkit: 5941c609719bSwdenk 5942c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes 5943c609719bSwdenk this bug. Please try to include a way of demonstrating that the 5944c609719bSwdenk patch actually fixes something. 5945c609719bSwdenk 5946c609719bSwdenk* For new features: a description of the feature and your 5947c609719bSwdenk implementation. 5948c609719bSwdenk 5949c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch) 5950c609719bSwdenk 5951c609719bSwdenk* For major contributions, your entry to the CREDITS file 5952c609719bSwdenk 595327af930eSAlbert ARIBAUD* When you add support for a new board, don't forget to add a 595427af930eSAlbert ARIBAUD maintainer e-mail address to the boards.cfg file, too. 5955c609719bSwdenk 5956c609719bSwdenk* If your patch adds new configuration options, don't forget to 5957c609719bSwdenk document these in the README file. 5958c609719bSwdenk 5959218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly* 5960218ca724SWolfgang Denk recommended) you can easily generate the patch using the 59617ca9296eSWolfgang Denk "git format-patch". If you then use "git send-email" to send it to 5962218ca724SWolfgang Denk the U-Boot mailing list, you will avoid most of the common problems 5963218ca724SWolfgang Denk with some other mail clients. 5964c609719bSwdenk 5965218ca724SWolfgang Denk If you cannot use git, use "diff -purN OLD NEW". If your version of 5966218ca724SWolfgang Denk diff does not support these options, then get the latest version of 5967218ca724SWolfgang Denk GNU diff. 59686dff5529Swdenk 5969218ca724SWolfgang Denk The current directory when running this command shall be the parent 5970218ca724SWolfgang Denk directory of the U-Boot source tree (i. e. please make sure that 5971218ca724SWolfgang Denk your patch includes sufficient directory information for the 5972218ca724SWolfgang Denk affected files). 5973218ca724SWolfgang Denk 5974218ca724SWolfgang Denk We prefer patches as plain text. MIME attachments are discouraged, 5975218ca724SWolfgang Denk and compressed attachments must not be used. 5976c609719bSwdenk 597752f52c14Swdenk* If one logical set of modifications affects or creates several 597852f52c14Swdenk files, all these changes shall be submitted in a SINGLE patch file. 597952f52c14Swdenk 598052f52c14Swdenk* Changesets that contain different, unrelated modifications shall be 598152f52c14Swdenk submitted as SEPARATE patches, one patch per changeset. 598252f52c14Swdenk 598352f52c14Swdenk 5984c609719bSwdenkNotes: 5985c609719bSwdenk 5986c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched 5987c609719bSwdenk source tree and make sure that no errors or warnings are reported 5988c609719bSwdenk for any of the boards. 5989c609719bSwdenk 5990c609719bSwdenk* Keep your modifications to the necessary minimum: A patch 5991c609719bSwdenk containing several unrelated changes or arbitrary reformats will be 5992c609719bSwdenk returned with a request to re-formatting / split it. 5993c609719bSwdenk 5994c609719bSwdenk* If you modify existing code, make sure that your new code does not 5995c609719bSwdenk add to the memory footprint of the code ;-) Small is beautiful! 5996c609719bSwdenk When adding new features, these should compile conditionally only 5997c609719bSwdenk (using #ifdef), and the resulting code with the new feature 5998c609719bSwdenk disabled must not need more memory than the old code without your 5999c609719bSwdenk modification. 600090dc6704Swdenk 60010668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the 60020668236bSWolfgang Denk u-boot mailing list. Bigger patches will be moderated. If they are 60030668236bSWolfgang Denk reasonable and not too big, they will be acknowledged. But patches 60040668236bSWolfgang Denk bigger than the size limit should be avoided. 6005