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 /pxa Files specific to Intel XScale PXA CPUs 1458d321b81SPeter Tyser /sa1100 Files specific to Intel StrongARM SA1100 CPUs 1468d321b81SPeter Tyser /lib Architecture specific library files 1478d321b81SPeter Tyser /avr32 Files generic to AVR32 architecture 1488d321b81SPeter Tyser /cpu CPU specific files 1498d321b81SPeter Tyser /lib Architecture specific library files 1508d321b81SPeter Tyser /blackfin Files generic to Analog Devices Blackfin architecture 1518d321b81SPeter Tyser /cpu CPU specific files 1528d321b81SPeter Tyser /lib Architecture specific library files 1538d321b81SPeter Tyser /m68k Files generic to m68k architecture 1548d321b81SPeter Tyser /cpu CPU specific files 1558d321b81SPeter Tyser /mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs 1568d321b81SPeter Tyser /mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs 1578d321b81SPeter Tyser /mcf532x Files specific to Freescale ColdFire MCF5329 CPUs 1588d321b81SPeter Tyser /mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs 1598d321b81SPeter Tyser /mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs 1608d321b81SPeter Tyser /lib Architecture specific library files 1618d321b81SPeter Tyser /microblaze Files generic to microblaze architecture 1628d321b81SPeter Tyser /cpu CPU specific files 1638d321b81SPeter Tyser /lib Architecture specific library files 1648d321b81SPeter Tyser /mips Files generic to MIPS architecture 1658d321b81SPeter Tyser /cpu CPU specific files 16692bbd64eSDaniel Schwierzeck /mips32 Files specific to MIPS32 CPUs 16780421fccSXiangfu Liu /xburst Files specific to Ingenic XBurst CPUs 1688d321b81SPeter Tyser /lib Architecture specific library files 169afc1ce82SMacpaul Lin /nds32 Files generic to NDS32 architecture 170afc1ce82SMacpaul Lin /cpu CPU specific files 171afc1ce82SMacpaul Lin /n1213 Files specific to Andes Technology N1213 CPUs 172afc1ce82SMacpaul Lin /lib Architecture specific library files 1738d321b81SPeter Tyser /nios2 Files generic to Altera NIOS2 architecture 1748d321b81SPeter Tyser /cpu CPU specific files 1758d321b81SPeter Tyser /lib Architecture specific library files 17633c7731bSRobert P. J. Day /openrisc Files generic to OpenRISC architecture 17733c7731bSRobert P. J. Day /cpu CPU specific files 17833c7731bSRobert P. J. Day /lib Architecture specific library files 179a47a12beSStefan Roese /powerpc Files generic to PowerPC architecture 1808d321b81SPeter Tyser /cpu CPU specific files 1818d321b81SPeter Tyser /74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs 1828d321b81SPeter Tyser /mpc5xx Files specific to Freescale MPC5xx CPUs 1838d321b81SPeter Tyser /mpc5xxx Files specific to Freescale MPC5xxx CPUs 1848d321b81SPeter Tyser /mpc8xx Files specific to Freescale MPC8xx CPUs 1858d321b81SPeter Tyser /mpc824x Files specific to Freescale MPC824x CPUs 1868d321b81SPeter Tyser /mpc8260 Files specific to Freescale MPC8260 CPUs 1878d321b81SPeter Tyser /mpc85xx Files specific to Freescale MPC85xx CPUs 1888d321b81SPeter Tyser /ppc4xx Files specific to AMCC PowerPC 4xx CPUs 1898d321b81SPeter Tyser /lib Architecture specific library files 1908d321b81SPeter Tyser /sh Files generic to SH architecture 1918d321b81SPeter Tyser /cpu CPU specific files 1928d321b81SPeter Tyser /sh2 Files specific to sh2 CPUs 1938d321b81SPeter Tyser /sh3 Files specific to sh3 CPUs 1948d321b81SPeter Tyser /sh4 Files specific to sh4 CPUs 1958d321b81SPeter Tyser /lib Architecture specific library files 1968d321b81SPeter Tyser /sparc Files generic to SPARC architecture 1978d321b81SPeter Tyser /cpu CPU specific files 1988d321b81SPeter Tyser /leon2 Files specific to Gaisler LEON2 SPARC CPU 1998d321b81SPeter Tyser /leon3 Files specific to Gaisler LEON3 SPARC CPU 2008d321b81SPeter Tyser /lib Architecture specific library files 20133c7731bSRobert P. J. Day /x86 Files generic to x86 architecture 20233c7731bSRobert P. J. Day /cpu CPU specific files 20333c7731bSRobert P. J. Day /lib Architecture specific library files 2048d321b81SPeter Tyser/api Machine/arch independent API for external apps 2058d321b81SPeter Tyser/board Board dependent files 2068d321b81SPeter Tyser/common Misc architecture independent functions 2078d321b81SPeter Tyser/disk Code for disk drive partition handling 2088d321b81SPeter Tyser/doc Documentation (don't expect too much) 2098d321b81SPeter Tyser/drivers Commonly used device drivers 21033c7731bSRobert P. J. Day/dts Contains Makefile for building internal U-Boot fdt. 2118d321b81SPeter Tyser/examples Example code for standalone applications, etc. 2128d321b81SPeter Tyser/fs Filesystem code (cramfs, ext2, jffs2, etc.) 2138d321b81SPeter Tyser/include Header Files 2148d321b81SPeter Tyser/lib Files generic to all architectures 2158d321b81SPeter Tyser /libfdt Library files to support flattened device trees 2168d321b81SPeter Tyser /lzma Library files to support LZMA decompression 2178d321b81SPeter Tyser /lzo Library files to support LZO decompression 2188d321b81SPeter Tyser/net Networking code 2198d321b81SPeter Tyser/post Power On Self Test 22033c7731bSRobert P. J. Day/spl Secondary Program Loader framework 2218d321b81SPeter Tyser/tools Tools to build S-Record or U-Boot images, etc. 222c609719bSwdenk 223c609719bSwdenkSoftware Configuration: 224c609719bSwdenk======================= 225c609719bSwdenk 226c609719bSwdenkConfiguration is usually done using C preprocessor defines; the 227c609719bSwdenkrationale behind that is to avoid dead code whenever possible. 228c609719bSwdenk 229c609719bSwdenkThere are two classes of configuration variables: 230c609719bSwdenk 231c609719bSwdenk* Configuration _OPTIONS_: 232c609719bSwdenk These are selectable by the user and have names beginning with 233c609719bSwdenk "CONFIG_". 234c609719bSwdenk 235c609719bSwdenk* Configuration _SETTINGS_: 236c609719bSwdenk These depend on the hardware etc. and should not be meddled with if 237c609719bSwdenk you don't know what you're doing; they have names beginning with 2386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD "CONFIG_SYS_". 239c609719bSwdenk 240c609719bSwdenkLater we will add a configuration tool - probably similar to or even 241c609719bSwdenkidentical to what's used for the Linux kernel. Right now, we have to 242c609719bSwdenkdo the configuration by hand, which means creating some symbolic 243c609719bSwdenklinks and editing some configuration files. We use the TQM8xxL boards 244c609719bSwdenkas an example here. 245c609719bSwdenk 246c609719bSwdenk 247c609719bSwdenkSelection of Processor Architecture and Board Type: 248c609719bSwdenk--------------------------------------------------- 249c609719bSwdenk 250c609719bSwdenkFor all supported boards there are ready-to-use default 251c609719bSwdenkconfigurations available; just type "make <board_name>_config". 252c609719bSwdenk 253c609719bSwdenkExample: For a TQM823L module type: 254c609719bSwdenk 255c609719bSwdenk cd u-boot 256c609719bSwdenk make TQM823L_config 257c609719bSwdenk 25811ccc33fSMarcel ZiswilerFor the Cogent platform, you need to specify the CPU type as well; 259c609719bSwdenke.g. "make cogent_mpc8xx_config". And also configure the cogent 260c609719bSwdenkdirectory according to the instructions in cogent/README. 261c609719bSwdenk 262c609719bSwdenk 263c609719bSwdenkConfiguration Options: 264c609719bSwdenk---------------------- 265c609719bSwdenk 266c609719bSwdenkConfiguration depends on the combination of board and CPU type; all 267c609719bSwdenksuch information is kept in a configuration file 268c609719bSwdenk"include/configs/<board_name>.h". 269c609719bSwdenk 270c609719bSwdenkExample: For a TQM823L module, all configuration settings are in 271c609719bSwdenk"include/configs/TQM823L.h". 272c609719bSwdenk 273c609719bSwdenk 2747f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux 2757f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to 2767f6c2cbcSwdenkbuild a config tool - later. 2777f6c2cbcSwdenk 2787f6c2cbcSwdenk 279c609719bSwdenkThe following options need to be configured: 280c609719bSwdenk 2812628114eSKim Phillips- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX. 282c609719bSwdenk 2832628114eSKim Phillips- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS. 2846ccec449SWolfgang Denk 2856ccec449SWolfgang Denk- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined) 28609ea0de0SHaavard Skinnemoen Define exactly one, e.g. CONFIG_ATSTK1002 287c609719bSwdenk 288c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined) 289c609719bSwdenk Define exactly one of 290c609719bSwdenk CONFIG_CMA286_60_OLD 291c609719bSwdenk--- FIXME --- not tested yet: 292c609719bSwdenk CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P, 293c609719bSwdenk CONFIG_CMA287_23, CONFIG_CMA287_50 294c609719bSwdenk 295c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined) 296c609719bSwdenk Define exactly one of 297c609719bSwdenk CONFIG_CMA101, CONFIG_CMA102 298c609719bSwdenk 299c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined) 300c609719bSwdenk Define one or more of 301c609719bSwdenk CONFIG_CMA302 302c609719bSwdenk 303c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined) 304c609719bSwdenk Define one or more of 305c609719bSwdenk CONFIG_LCD_HEARTBEAT - update a character position on 30611ccc33fSMarcel Ziswiler the LCD display every second with 307c609719bSwdenk a "rotator" |\-/|\-/ 308c609719bSwdenk 3092535d602Swdenk- Board flavour: (if CONFIG_MPC8260ADS is defined) 3102535d602Swdenk CONFIG_ADSTYPE 3112535d602Swdenk Possible values are: 3126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8260ADS - original MPC8260ADS 3136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8266ADS - MPC8266ADS 3146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR 3156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8272ADS - MPC8272ADS 3162535d602Swdenk 317cf946c6dSLei Wen- Marvell Family Member 318cf946c6dSLei Wen CONFIG_SYS_MVFS - define it if you want to enable 319cf946c6dSLei Wen multiple fs option at one time 320cf946c6dSLei Wen for marvell soc family 321cf946c6dSLei Wen 322c609719bSwdenk- MPC824X Family Member (if CONFIG_MPC824X is defined) 323c609719bSwdenk Define exactly one of 324c609719bSwdenk CONFIG_MPC8240, CONFIG_MPC8245 325c609719bSwdenk 32611ccc33fSMarcel Ziswiler- 8xx CPU Options: (if using an MPC8xx CPU) 32766ca92a5Swdenk CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if 32866ca92a5Swdenk get_gclk_freq() cannot work 3295da627a4Swdenk e.g. if there is no 32KHz 3305da627a4Swdenk reference PIT/RTC clock 33166ca92a5Swdenk CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK 33266ca92a5Swdenk or XTAL/EXTAL) 333c609719bSwdenk 33466ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU): 3356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8xx_CPUCLK_MIN 3366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8xx_CPUCLK_MAX 33766ca92a5Swdenk CONFIG_8xx_CPUCLK_DEFAULT 33875d1ea7fSwdenk See doc/README.MPC866 33975d1ea7fSwdenk 3406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MEASURE_CPUCLK 34175d1ea7fSwdenk 34275d1ea7fSwdenk Define this to measure the actual CPU clock instead 34375d1ea7fSwdenk of relying on the correctness of the configured 34475d1ea7fSwdenk values. Mostly useful for board bringup to make sure 34575d1ea7fSwdenk the PLL is locked at the intended frequency. Note 34675d1ea7fSwdenk that this requires a (stable) reference clock (32 kHz 3476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD RTC clock or CONFIG_SYS_8XX_XIN) 34875d1ea7fSwdenk 349506f3918SHeiko Schocher CONFIG_SYS_DELAYED_ICACHE 350506f3918SHeiko Schocher 351506f3918SHeiko Schocher Define this option if you want to enable the 352506f3918SHeiko Schocher ICache only when Code runs from RAM. 353506f3918SHeiko Schocher 35466412c63SKumar Gala- 85xx CPU Options: 355ffd06e02SYork Sun CONFIG_SYS_PPC64 356ffd06e02SYork Sun 357ffd06e02SYork Sun Specifies that the core is a 64-bit PowerPC implementation (implements 358ffd06e02SYork Sun the "64" category of the Power ISA). This is necessary for ePAPR 359ffd06e02SYork Sun compliance, among other possible reasons. 360ffd06e02SYork Sun 36166412c63SKumar Gala CONFIG_SYS_FSL_TBCLK_DIV 36266412c63SKumar Gala 36366412c63SKumar Gala Defines the core time base clock divider ratio compared to the 36466412c63SKumar Gala system clock. On most PQ3 devices this is 8, on newer QorIQ 36566412c63SKumar Gala devices it can be 16 or 32. The ratio varies from SoC to Soc. 36666412c63SKumar Gala 3678f29084aSKumar Gala CONFIG_SYS_FSL_PCIE_COMPAT 3688f29084aSKumar Gala 3698f29084aSKumar Gala Defines the string to utilize when trying to match PCIe device 3708f29084aSKumar Gala tree nodes for the given platform. 3718f29084aSKumar Gala 372afa6b551SPrabhakar Kushwaha CONFIG_SYS_PPC_E500_DEBUG_TLB 373afa6b551SPrabhakar Kushwaha 374afa6b551SPrabhakar Kushwaha Enables a temporary TLB entry to be used during boot to work 375afa6b551SPrabhakar Kushwaha around limitations in e500v1 and e500v2 external debugger 376afa6b551SPrabhakar Kushwaha support. This reduces the portions of the boot code where 377afa6b551SPrabhakar Kushwaha breakpoints and single stepping do not work. The value of this 378afa6b551SPrabhakar Kushwaha symbol should be set to the TLB1 entry to be used for this 379afa6b551SPrabhakar Kushwaha purpose. 380afa6b551SPrabhakar Kushwaha 38133eee330SScott Wood CONFIG_SYS_FSL_ERRATUM_A004510 38233eee330SScott Wood 38333eee330SScott Wood Enables a workaround for erratum A004510. If set, 38433eee330SScott Wood then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and 38533eee330SScott Wood CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set. 38633eee330SScott Wood 38733eee330SScott Wood CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV 38833eee330SScott Wood CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional) 38933eee330SScott Wood 39033eee330SScott Wood Defines one or two SoC revisions (low 8 bits of SVR) 39133eee330SScott Wood for which the A004510 workaround should be applied. 39233eee330SScott Wood 39333eee330SScott Wood The rest of SVR is either not relevant to the decision 39433eee330SScott Wood of whether the erratum is present (e.g. p2040 versus 39533eee330SScott Wood p2041) or is implied by the build target, which controls 39633eee330SScott Wood whether CONFIG_SYS_FSL_ERRATUM_A004510 is set. 39733eee330SScott Wood 39833eee330SScott Wood See Freescale App Note 4493 for more information about 39933eee330SScott Wood this erratum. 40033eee330SScott Wood 40174fa22edSPrabhakar Kushwaha CONFIG_A003399_NOR_WORKAROUND 40274fa22edSPrabhakar Kushwaha Enables a workaround for IFC erratum A003399. It is only 40374fa22edSPrabhakar Kushwaha requred during NOR boot. 40474fa22edSPrabhakar Kushwaha 40533eee330SScott Wood CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY 40633eee330SScott Wood 40733eee330SScott Wood This is the value to write into CCSR offset 0x18600 40833eee330SScott Wood according to the A004510 workaround. 40933eee330SScott Wood 41064501c66SPriyanka Jain CONFIG_SYS_FSL_DSP_DDR_ADDR 41164501c66SPriyanka Jain This value denotes start offset of DDR memory which is 41264501c66SPriyanka Jain connected exclusively to the DSP cores. 41364501c66SPriyanka Jain 414765b0bdbSPriyanka Jain CONFIG_SYS_FSL_DSP_M2_RAM_ADDR 415765b0bdbSPriyanka Jain This value denotes start offset of M2 memory 416765b0bdbSPriyanka Jain which is directly connected to the DSP core. 417765b0bdbSPriyanka Jain 41864501c66SPriyanka Jain CONFIG_SYS_FSL_DSP_M3_RAM_ADDR 41964501c66SPriyanka Jain This value denotes start offset of M3 memory which is directly 42064501c66SPriyanka Jain connected to the DSP core. 42164501c66SPriyanka Jain 422765b0bdbSPriyanka Jain CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT 423765b0bdbSPriyanka Jain This value denotes start offset of DSP CCSR space. 424765b0bdbSPriyanka Jain 425b135991aSPriyanka Jain CONFIG_SYS_FSL_SINGLE_SOURCE_CLK 426b135991aSPriyanka Jain Single Source Clock is clocking mode present in some of FSL SoC's. 427b135991aSPriyanka Jain In this mode, a single differential clock is used to supply 428b135991aSPriyanka Jain clocks to the sysclock, ddrclock and usbclock. 429b135991aSPriyanka Jain 4306cb461b4SDaniel Schwierzeck- Generic CPU options: 4316cb461b4SDaniel Schwierzeck CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN 4326cb461b4SDaniel Schwierzeck 4336cb461b4SDaniel Schwierzeck Defines the endianess of the CPU. Implementation of those 4346cb461b4SDaniel Schwierzeck values is arch specific. 4356cb461b4SDaniel Schwierzeck 4365614e71bSYork Sun CONFIG_SYS_FSL_DDR 4375614e71bSYork Sun Freescale DDR driver in use. This type of DDR controller is 4385614e71bSYork Sun found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core 4395614e71bSYork Sun SoCs. 4405614e71bSYork Sun 4415614e71bSYork Sun CONFIG_SYS_FSL_DDR_ADDR 4425614e71bSYork Sun Freescale DDR memory-mapped register base. 4435614e71bSYork Sun 4445614e71bSYork Sun CONFIG_SYS_FSL_DDR_EMU 4455614e71bSYork Sun Specify emulator support for DDR. Some DDR features such as 4465614e71bSYork Sun deskew training are not available. 4475614e71bSYork Sun 4485614e71bSYork Sun CONFIG_SYS_FSL_DDRC_GEN1 4495614e71bSYork Sun Freescale DDR1 controller. 4505614e71bSYork Sun 4515614e71bSYork Sun CONFIG_SYS_FSL_DDRC_GEN2 4525614e71bSYork Sun Freescale DDR2 controller. 4535614e71bSYork Sun 4545614e71bSYork Sun CONFIG_SYS_FSL_DDRC_GEN3 4555614e71bSYork Sun Freescale DDR3 controller. 4565614e71bSYork Sun 4579ac4ffbdSYork Sun CONFIG_SYS_FSL_DDRC_ARM_GEN3 4589ac4ffbdSYork Sun Freescale DDR3 controller for ARM-based SoCs. 4599ac4ffbdSYork Sun 4605614e71bSYork Sun CONFIG_SYS_FSL_DDR1 4615614e71bSYork Sun Board config to use DDR1. It can be enabled for SoCs with 4625614e71bSYork Sun Freescale DDR1 or DDR2 controllers, depending on the board 4635614e71bSYork Sun implemetation. 4645614e71bSYork Sun 4655614e71bSYork Sun CONFIG_SYS_FSL_DDR2 4665614e71bSYork Sun Board config to use DDR2. It can be eanbeld for SoCs with 4675614e71bSYork Sun Freescale DDR2 or DDR3 controllers, depending on the board 4685614e71bSYork Sun implementation. 4695614e71bSYork Sun 4705614e71bSYork Sun CONFIG_SYS_FSL_DDR3 4715614e71bSYork Sun Board config to use DDR3. It can be enabled for SoCs with 4725614e71bSYork Sun Freescale DDR3 controllers. 4735614e71bSYork Sun 4741b4175d6SPrabhakar Kushwaha CONFIG_SYS_FSL_IFC_BE 4751b4175d6SPrabhakar Kushwaha Defines the IFC controller register space as Big Endian 4761b4175d6SPrabhakar Kushwaha 4771b4175d6SPrabhakar Kushwaha CONFIG_SYS_FSL_IFC_LE 4781b4175d6SPrabhakar Kushwaha Defines the IFC controller register space as Little Endian 4791b4175d6SPrabhakar Kushwaha 480690e4258SPrabhakar Kushwaha CONFIG_SYS_FSL_PBL_PBI 481690e4258SPrabhakar Kushwaha It enables addition of RCW (Power on reset configuration) in built image. 482690e4258SPrabhakar Kushwaha Please refer doc/README.pblimage for more details 483690e4258SPrabhakar Kushwaha 484690e4258SPrabhakar Kushwaha CONFIG_SYS_FSL_PBL_RCW 485690e4258SPrabhakar Kushwaha It adds PBI(pre-boot instructions) commands in u-boot build image. 486690e4258SPrabhakar Kushwaha PBI commands can be used to configure SoC before it starts the execution. 487690e4258SPrabhakar Kushwaha Please refer doc/README.pblimage for more details 488690e4258SPrabhakar Kushwaha 4894e5b1bd0SYork Sun CONFIG_SYS_FSL_DDR_BE 4904e5b1bd0SYork Sun Defines the DDR controller register space as Big Endian 4914e5b1bd0SYork Sun 4924e5b1bd0SYork Sun CONFIG_SYS_FSL_DDR_LE 4934e5b1bd0SYork Sun Defines the DDR controller register space as Little Endian 4944e5b1bd0SYork Sun 4956b9e309aSYork Sun CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY 4966b9e309aSYork Sun Physical address from the view of DDR controllers. It is the 4976b9e309aSYork Sun same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But 4986b9e309aSYork Sun it could be different for ARM SoCs. 4996b9e309aSYork Sun 5006b1e1254SYork Sun CONFIG_SYS_FSL_DDR_INTLV_256B 5016b1e1254SYork Sun DDR controller interleaving on 256-byte. This is a special 5026b1e1254SYork Sun interleaving mode, handled by Dickens for Freescale layerscape 5036b1e1254SYork Sun SoCs with ARM core. 5046b1e1254SYork Sun 5050b953ffcSMarkus Klotzbuecher- Intel Monahans options: 5066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO 5070b953ffcSMarkus Klotzbuecher 5080b953ffcSMarkus Klotzbuecher Defines the Monahans run mode to oscillator 5090b953ffcSMarkus Klotzbuecher ratio. Valid values are 8, 16, 24, 31. The core 5100b953ffcSMarkus Klotzbuecher frequency is this value multiplied by 13 MHz. 5110b953ffcSMarkus Klotzbuecher 5126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO 5130b953ffcSMarkus Klotzbuecher 5140b953ffcSMarkus Klotzbuecher Defines the Monahans turbo mode to oscillator 5150b953ffcSMarkus Klotzbuecher ratio. Valid values are 1 (default if undefined) and 5160b953ffcSMarkus Klotzbuecher 2. The core frequency as calculated above is multiplied 5170b953ffcSMarkus Klotzbuecher by this value. 5180b953ffcSMarkus Klotzbuecher 51992bbd64eSDaniel Schwierzeck- MIPS CPU options: 52092bbd64eSDaniel Schwierzeck CONFIG_SYS_INIT_SP_OFFSET 52192bbd64eSDaniel Schwierzeck 52292bbd64eSDaniel Schwierzeck Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack 52392bbd64eSDaniel Schwierzeck pointer. This is needed for the temporary stack before 52492bbd64eSDaniel Schwierzeck relocation. 52592bbd64eSDaniel Schwierzeck 52692bbd64eSDaniel Schwierzeck CONFIG_SYS_MIPS_CACHE_MODE 52792bbd64eSDaniel Schwierzeck 52892bbd64eSDaniel Schwierzeck Cache operation mode for the MIPS CPU. 52992bbd64eSDaniel Schwierzeck See also arch/mips/include/asm/mipsregs.h. 53092bbd64eSDaniel Schwierzeck Possible values are: 53192bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_NO_WA 53292bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_WA 53392bbd64eSDaniel Schwierzeck CONF_CM_UNCACHED 53492bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_NONCOHERENT 53592bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_CE 53692bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_COW 53792bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_CUW 53892bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_ACCELERATED 53992bbd64eSDaniel Schwierzeck 54092bbd64eSDaniel Schwierzeck CONFIG_SYS_XWAY_EBU_BOOTCFG 54192bbd64eSDaniel Schwierzeck 54292bbd64eSDaniel Schwierzeck Special option for Lantiq XWAY SoCs for booting from NOR flash. 54392bbd64eSDaniel Schwierzeck See also arch/mips/cpu/mips32/start.S. 54492bbd64eSDaniel Schwierzeck 54592bbd64eSDaniel Schwierzeck CONFIG_XWAY_SWAP_BYTES 54692bbd64eSDaniel Schwierzeck 54792bbd64eSDaniel Schwierzeck Enable compilation of tools/xway-swap-bytes needed for Lantiq 54892bbd64eSDaniel Schwierzeck XWAY SoCs for booting from NOR flash. The U-Boot image needs to 54992bbd64eSDaniel Schwierzeck be swapped if a flash programmer is used. 55092bbd64eSDaniel Schwierzeck 551b67d8816SChristian Riesch- ARM options: 552b67d8816SChristian Riesch CONFIG_SYS_EXCEPTION_VECTORS_HIGH 553b67d8816SChristian Riesch 554b67d8816SChristian Riesch Select high exception vectors of the ARM core, e.g., do not 555b67d8816SChristian Riesch clear the V bit of the c1 register of CP15. 556b67d8816SChristian Riesch 5575356f545SAneesh V CONFIG_SYS_THUMB_BUILD 5585356f545SAneesh V 5595356f545SAneesh V Use this flag to build U-Boot using the Thumb instruction 5605356f545SAneesh V set for ARM architectures. Thumb instruction set provides 5615356f545SAneesh V better code density. For ARM architectures that support 5625356f545SAneesh V Thumb2 this flag will result in Thumb2 code generated by 5635356f545SAneesh V GCC. 5645356f545SAneesh V 565c5d4752cSStephen Warren CONFIG_ARM_ERRATA_716044 5660678587fSStephen Warren CONFIG_ARM_ERRATA_742230 5670678587fSStephen Warren CONFIG_ARM_ERRATA_743622 5680678587fSStephen Warren CONFIG_ARM_ERRATA_751472 569f71cbfe3SNitin Garg CONFIG_ARM_ERRATA_794072 570b7588e3bSNitin Garg CONFIG_ARM_ERRATA_761320 5710678587fSStephen Warren 5720678587fSStephen Warren If set, the workarounds for these ARM errata are applied early 5730678587fSStephen Warren during U-Boot startup. Note that these options force the 5740678587fSStephen Warren workarounds to be applied; no CPU-type/version detection 5750678587fSStephen Warren exists, unlike the similar options in the Linux kernel. Do not 5760678587fSStephen Warren set these options unless they apply! 5770678587fSStephen Warren 578795659dcSStephen Warren- CPU timer options: 579795659dcSStephen Warren CONFIG_SYS_HZ 580795659dcSStephen Warren 581795659dcSStephen Warren The frequency of the timer returned by get_timer(). 582795659dcSStephen Warren get_timer() must operate in milliseconds and this CONFIG 583795659dcSStephen Warren option must be set to 1000. 584795659dcSStephen Warren 5855da627a4Swdenk- Linux Kernel Interface: 586c609719bSwdenk CONFIG_CLOCKS_IN_MHZ 587c609719bSwdenk 588c609719bSwdenk U-Boot stores all clock information in Hz 589c609719bSwdenk internally. For binary compatibility with older Linux 590c609719bSwdenk kernels (which expect the clocks passed in the 591c609719bSwdenk bd_info data to be in MHz) the environment variable 592c609719bSwdenk "clocks_in_mhz" can be defined so that U-Boot 593c609719bSwdenk converts clock data to MHZ before passing it to the 594c609719bSwdenk Linux kernel. 595c609719bSwdenk When CONFIG_CLOCKS_IN_MHZ is defined, a definition of 596c609719bSwdenk "clocks_in_mhz=1" is automatically included in the 597c609719bSwdenk default environment. 598c609719bSwdenk 5995da627a4Swdenk CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only] 6005da627a4Swdenk 60111ccc33fSMarcel Ziswiler When transferring memsize parameter to linux, some versions 6025da627a4Swdenk expect it to be in bytes, others in MB. 6035da627a4Swdenk Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes. 6045da627a4Swdenk 605fec6d9eeSGerald Van Baren CONFIG_OF_LIBFDT 606f57f70aaSWolfgang Denk 607f57f70aaSWolfgang Denk New kernel versions are expecting firmware settings to be 608213bf8c8SGerald Van Baren passed using flattened device trees (based on open firmware 609213bf8c8SGerald Van Baren concepts). 610213bf8c8SGerald Van Baren 611213bf8c8SGerald Van Baren CONFIG_OF_LIBFDT 612213bf8c8SGerald Van Baren * New libfdt-based support 613213bf8c8SGerald Van Baren * Adds the "fdt" command 6143bb342fcSKim Phillips * The bootm command automatically updates the fdt 615213bf8c8SGerald Van Baren 616b55ae402SMarcel Ziswiler OF_CPU - The proper name of the cpus node (only required for 617b55ae402SMarcel Ziswiler MPC512X and MPC5xxx based boards). 618b55ae402SMarcel Ziswiler OF_SOC - The proper name of the soc node (only required for 619b55ae402SMarcel Ziswiler MPC512X and MPC5xxx based boards). 620f57f70aaSWolfgang Denk OF_TBCLK - The timebase frequency. 621c2871f03SKumar Gala OF_STDOUT_PATH - The path to the console device 622f57f70aaSWolfgang Denk 62311ccc33fSMarcel Ziswiler boards with QUICC Engines require OF_QE to set UCC MAC 62411ccc33fSMarcel Ziswiler addresses 6253bb342fcSKim Phillips 6264e253137SKumar Gala CONFIG_OF_BOARD_SETUP 6274e253137SKumar Gala 6284e253137SKumar Gala Board code has addition modification that it wants to make 6294e253137SKumar Gala to the flat device tree before handing it off to the kernel 6306705d81eSwdenk 6310267768eSMatthew McClintock CONFIG_OF_BOOT_CPU 6320267768eSMatthew McClintock 63311ccc33fSMarcel Ziswiler This define fills in the correct boot CPU in the boot 6340267768eSMatthew McClintock param header, the default value is zero if undefined. 6350267768eSMatthew McClintock 6363887c3fbSHeiko Schocher CONFIG_OF_IDE_FIXUP 6373887c3fbSHeiko Schocher 6383887c3fbSHeiko Schocher U-Boot can detect if an IDE device is present or not. 6393887c3fbSHeiko Schocher If not, and this new config option is activated, U-Boot 6403887c3fbSHeiko Schocher removes the ATA node from the DTS before booting Linux, 6413887c3fbSHeiko Schocher so the Linux IDE driver does not probe the device and 6423887c3fbSHeiko Schocher crash. This is needed for buggy hardware (uc101) where 6433887c3fbSHeiko Schocher no pull down resistor is connected to the signal IDE5V_DD7. 6443887c3fbSHeiko Schocher 6457eb29398SIgor Grinberg CONFIG_MACH_TYPE [relevant for ARM only][mandatory] 6467eb29398SIgor Grinberg 6477eb29398SIgor Grinberg This setting is mandatory for all boards that have only one 6487eb29398SIgor Grinberg machine type and must be used to specify the machine type 6497eb29398SIgor Grinberg number as it appears in the ARM machine registry 6507eb29398SIgor Grinberg (see http://www.arm.linux.org.uk/developer/machines/). 6517eb29398SIgor Grinberg Only boards that have multiple machine types supported 6527eb29398SIgor Grinberg in a single configuration file and the machine type is 6537eb29398SIgor Grinberg runtime discoverable, do not have to use this setting. 6547eb29398SIgor Grinberg 6550b2f4ecaSNiklaus Giger- vxWorks boot parameters: 6560b2f4ecaSNiklaus Giger 6570b2f4ecaSNiklaus Giger bootvx constructs a valid bootline using the following 6580b2f4ecaSNiklaus Giger environments variables: bootfile, ipaddr, serverip, hostname. 6590b2f4ecaSNiklaus Giger It loads the vxWorks image pointed bootfile. 6600b2f4ecaSNiklaus Giger 6610b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name 6620b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address 6630b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server 6640b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters 6650b2f4ecaSNiklaus Giger 6660b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_ADD_PARAMS 6670b2f4ecaSNiklaus Giger 6680b2f4ecaSNiklaus Giger Add it at the end of the bootline. E.g "u=username pw=secret" 6690b2f4ecaSNiklaus Giger 6700b2f4ecaSNiklaus Giger Note: If a "bootargs" environment is defined, it will overwride 6710b2f4ecaSNiklaus Giger the defaults discussed just above. 6720b2f4ecaSNiklaus Giger 6732c451f78SAneesh V- Cache Configuration: 6742c451f78SAneesh V CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot 6752c451f78SAneesh V CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot 6762c451f78SAneesh V CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot 6772c451f78SAneesh V 67893bc2193SAneesh V- Cache Configuration for ARM: 67993bc2193SAneesh V CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache 68093bc2193SAneesh V controller 68193bc2193SAneesh V CONFIG_SYS_PL310_BASE - Physical base address of PL310 68293bc2193SAneesh V controller register space 68393bc2193SAneesh V 6846705d81eSwdenk- Serial Ports: 68548d0192fSAndreas Engel CONFIG_PL010_SERIAL 6866705d81eSwdenk 6876705d81eSwdenk Define this if you want support for Amba PrimeCell PL010 UARTs. 6886705d81eSwdenk 68948d0192fSAndreas Engel CONFIG_PL011_SERIAL 6906705d81eSwdenk 6916705d81eSwdenk Define this if you want support for Amba PrimeCell PL011 UARTs. 6926705d81eSwdenk 6936705d81eSwdenk CONFIG_PL011_CLOCK 6946705d81eSwdenk 6956705d81eSwdenk If you have Amba PrimeCell PL011 UARTs, set this variable to 6966705d81eSwdenk the clock speed of the UARTs. 6976705d81eSwdenk 6986705d81eSwdenk CONFIG_PL01x_PORTS 6996705d81eSwdenk 7006705d81eSwdenk If you have Amba PrimeCell PL010 or PL011 UARTs on your board, 7016705d81eSwdenk define this to a list of base addresses for each (supported) 7026705d81eSwdenk port. See e.g. include/configs/versatile.h 7036705d81eSwdenk 704910f1ae3SJohn Rigby CONFIG_PL011_SERIAL_RLCR 705910f1ae3SJohn Rigby 706910f1ae3SJohn Rigby Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500) 707910f1ae3SJohn Rigby have separate receive and transmit line control registers. Set 708910f1ae3SJohn Rigby this variable to initialize the extra register. 709910f1ae3SJohn Rigby 710910f1ae3SJohn Rigby CONFIG_PL011_SERIAL_FLUSH_ON_INIT 711910f1ae3SJohn Rigby 712910f1ae3SJohn Rigby On some platforms (e.g. U8500) U-Boot is loaded by a second stage 713910f1ae3SJohn Rigby boot loader that has already initialized the UART. Define this 714910f1ae3SJohn Rigby variable to flush the UART at init time. 715910f1ae3SJohn Rigby 7166705d81eSwdenk 717c609719bSwdenk- Console Interface: 718c609719bSwdenk Depending on board, define exactly one serial port 719c609719bSwdenk (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2, 720c609719bSwdenk CONFIG_8xx_CONS_SCC1, ...), or switch off the serial 721c609719bSwdenk console by defining CONFIG_8xx_CONS_NONE 722c609719bSwdenk 723c609719bSwdenk Note: if CONFIG_8xx_CONS_NONE is defined, the serial 724c609719bSwdenk port routines must be defined elsewhere 725c609719bSwdenk (i.e. serial_init(), serial_getc(), ...) 726c609719bSwdenk 727c609719bSwdenk CONFIG_CFB_CONSOLE 728c609719bSwdenk Enables console device for a color framebuffer. Needs following 729c53043b7SWolfgang Denk defines (cf. smiLynxEM, i8042) 730c609719bSwdenk VIDEO_FB_LITTLE_ENDIAN graphic memory organisation 731c609719bSwdenk (default big endian) 732c609719bSwdenk VIDEO_HW_RECTFILL graphic chip supports 733c609719bSwdenk rectangle fill 734c609719bSwdenk (cf. smiLynxEM) 735c609719bSwdenk VIDEO_HW_BITBLT graphic chip supports 736c609719bSwdenk bit-blit (cf. smiLynxEM) 737c609719bSwdenk VIDEO_VISIBLE_COLS visible pixel columns 738c609719bSwdenk (cols=pitch) 739c609719bSwdenk VIDEO_VISIBLE_ROWS visible pixel rows 740c609719bSwdenk VIDEO_PIXEL_SIZE bytes per pixel 741c609719bSwdenk VIDEO_DATA_FORMAT graphic data format 742c609719bSwdenk (0-5, cf. cfb_console.c) 743c609719bSwdenk VIDEO_FB_ADRS framebuffer address 744c609719bSwdenk VIDEO_KBD_INIT_FCT keyboard int fct 745c609719bSwdenk (i.e. i8042_kbd_init()) 746c609719bSwdenk VIDEO_TSTC_FCT test char fct 747c609719bSwdenk (i.e. i8042_tstc) 748c609719bSwdenk VIDEO_GETC_FCT get char fct 749c609719bSwdenk (i.e. i8042_getc) 750c609719bSwdenk CONFIG_CONSOLE_CURSOR cursor drawing on/off 751c609719bSwdenk (requires blink timer 752c609719bSwdenk cf. i8042.c) 7536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c) 754c609719bSwdenk CONFIG_CONSOLE_TIME display time/date info in 755c609719bSwdenk upper right corner 756602ad3b3SJon Loeliger (requires CONFIG_CMD_DATE) 757c609719bSwdenk CONFIG_VIDEO_LOGO display Linux logo in 758c609719bSwdenk upper left corner 759a6c7ad2fSwdenk CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of 760a6c7ad2fSwdenk linux_logo.h for logo. 761a6c7ad2fSwdenk Requires CONFIG_VIDEO_LOGO 762c609719bSwdenk CONFIG_CONSOLE_EXTRA_INFO 76311ccc33fSMarcel Ziswiler additional board info beside 764c609719bSwdenk the logo 765c609719bSwdenk 76633a35bbbSPali Rohár When CONFIG_CFB_CONSOLE_ANSI is defined, console will support 76733a35bbbSPali Rohár a limited number of ANSI escape sequences (cursor control, 76833a35bbbSPali Rohár erase functions and limited graphics rendition control). 76933a35bbbSPali Rohár 770c609719bSwdenk When CONFIG_CFB_CONSOLE is defined, video console is 771c609719bSwdenk default i/o. Serial console can be forced with 772c609719bSwdenk environment 'console=serial'. 773c609719bSwdenk 774a3ad8e26Swdenk When CONFIG_SILENT_CONSOLE is defined, all console 775a3ad8e26Swdenk messages (by U-Boot and Linux!) can be silenced with 776a3ad8e26Swdenk the "silent" environment variable. See 777a3ad8e26Swdenk doc/README.silent for more information. 778a3ad8e26Swdenk 77945ae2546SHeiko Schocher CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default 78045ae2546SHeiko Schocher is 0x00. 78145ae2546SHeiko Schocher CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default 78245ae2546SHeiko Schocher is 0xa0. 78345ae2546SHeiko Schocher 784c609719bSwdenk- Console Baudrate: 785c609719bSwdenk CONFIG_BAUDRATE - in bps 786c609719bSwdenk Select one of the baudrates listed in 7876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BAUDRATE_TABLE, see below. 7886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale 789c609719bSwdenk 790c92fac91SHeiko Schocher- Console Rx buffer length 791c92fac91SHeiko Schocher With CONFIG_SYS_SMC_RXBUFLEN it is possible to define 792c92fac91SHeiko Schocher the maximum receive buffer length for the SMC. 7932b3f12c2SHeiko Schocher This option is actual only for 82xx and 8xx possible. 794c92fac91SHeiko Schocher If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE 795c92fac91SHeiko Schocher must be defined, to setup the maximum idle timeout for 796c92fac91SHeiko Schocher the SMC. 797c92fac91SHeiko Schocher 7989558b48aSGraeme Russ- Pre-Console Buffer: 7999558b48aSGraeme Russ Prior to the console being initialised (i.e. serial UART 8009558b48aSGraeme Russ initialised etc) all console output is silently discarded. 8019558b48aSGraeme Russ Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to 8029558b48aSGraeme Russ buffer any console messages prior to the console being 8039558b48aSGraeme Russ initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ 8049558b48aSGraeme Russ bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is 8059558b48aSGraeme Russ a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ 8069558b48aSGraeme Russ bytes are output before the console is initialised, the 8079558b48aSGraeme Russ earlier bytes are discarded. 8089558b48aSGraeme Russ 8099558b48aSGraeme Russ 'Sane' compilers will generate smaller code if 8109558b48aSGraeme Russ CONFIG_PRE_CON_BUF_SZ is a power of 2 8119558b48aSGraeme Russ 812046a37bdSSonny Rao- Safe printf() functions 813046a37bdSSonny Rao Define CONFIG_SYS_VSNPRINTF to compile in safe versions of 814046a37bdSSonny Rao the printf() functions. These are defined in 815046a37bdSSonny Rao include/vsprintf.h and include snprintf(), vsnprintf() and 816046a37bdSSonny Rao so on. Code size increase is approximately 300-500 bytes. 817046a37bdSSonny Rao If this option is not given then these functions will 818046a37bdSSonny Rao silently discard their buffer size argument - this means 819046a37bdSSonny Rao you are not getting any overflow checking in this case. 820046a37bdSSonny Rao 821c609719bSwdenk- Boot Delay: CONFIG_BOOTDELAY - in seconds 822c609719bSwdenk Delay before automatically booting the default image; 823c609719bSwdenk set to -1 to disable autoboot. 82493d7212fSJoe Hershberger set to -2 to autoboot with no delay and not check for abort 82593d7212fSJoe Hershberger (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined). 826c609719bSwdenk 827c609719bSwdenk See doc/README.autoboot for these options that 828c609719bSwdenk work with CONFIG_BOOTDELAY. None are required. 829c609719bSwdenk CONFIG_BOOT_RETRY_TIME 830c609719bSwdenk CONFIG_BOOT_RETRY_MIN 831c609719bSwdenk CONFIG_AUTOBOOT_KEYED 832c609719bSwdenk CONFIG_AUTOBOOT_PROMPT 833c609719bSwdenk CONFIG_AUTOBOOT_DELAY_STR 834c609719bSwdenk CONFIG_AUTOBOOT_STOP_STR 835c609719bSwdenk CONFIG_AUTOBOOT_DELAY_STR2 836c609719bSwdenk CONFIG_AUTOBOOT_STOP_STR2 837c609719bSwdenk CONFIG_ZERO_BOOTDELAY_CHECK 838c609719bSwdenk CONFIG_RESET_TO_RETRY 839c609719bSwdenk 840c609719bSwdenk- Autoboot Command: 841c609719bSwdenk CONFIG_BOOTCOMMAND 842c609719bSwdenk Only needed when CONFIG_BOOTDELAY is enabled; 843c609719bSwdenk define a command string that is automatically executed 844c609719bSwdenk when no character is read on the console interface 845c609719bSwdenk within "Boot Delay" after reset. 846c609719bSwdenk 847c609719bSwdenk CONFIG_BOOTARGS 848c609719bSwdenk This can be used to pass arguments to the bootm 849c609719bSwdenk command. The value of CONFIG_BOOTARGS goes into the 850c609719bSwdenk environment value "bootargs". 851c609719bSwdenk 852c609719bSwdenk CONFIG_RAMBOOT and CONFIG_NFSBOOT 853c609719bSwdenk The value of these goes into the environment as 854c609719bSwdenk "ramboot" and "nfsboot" respectively, and can be used 855c609719bSwdenk as a convenience, when switching between booting from 85611ccc33fSMarcel Ziswiler RAM and NFS. 857c609719bSwdenk 858eda0ba38SHeiko Schocher- Bootcount: 859eda0ba38SHeiko Schocher CONFIG_BOOTCOUNT_LIMIT 860eda0ba38SHeiko Schocher Implements a mechanism for detecting a repeating reboot 861eda0ba38SHeiko Schocher cycle, see: 862eda0ba38SHeiko Schocher http://www.denx.de/wiki/view/DULG/UBootBootCountLimit 863eda0ba38SHeiko Schocher 864eda0ba38SHeiko Schocher CONFIG_BOOTCOUNT_ENV 865eda0ba38SHeiko Schocher If no softreset save registers are found on the hardware 866eda0ba38SHeiko Schocher "bootcount" is stored in the environment. To prevent a 867eda0ba38SHeiko Schocher saveenv on all reboots, the environment variable 868eda0ba38SHeiko Schocher "upgrade_available" is used. If "upgrade_available" is 869eda0ba38SHeiko Schocher 0, "bootcount" is always 0, if "upgrade_available" is 870eda0ba38SHeiko Schocher 1 "bootcount" is incremented in the environment. 871eda0ba38SHeiko Schocher So the Userspace Applikation must set the "upgrade_available" 872eda0ba38SHeiko Schocher and "bootcount" variable to 0, if a boot was successfully. 873eda0ba38SHeiko Schocher 874c609719bSwdenk- Pre-Boot Commands: 875c609719bSwdenk CONFIG_PREBOOT 876c609719bSwdenk 877c609719bSwdenk When this option is #defined, the existence of the 878c609719bSwdenk environment variable "preboot" will be checked 879c609719bSwdenk immediately before starting the CONFIG_BOOTDELAY 880c609719bSwdenk countdown and/or running the auto-boot command resp. 881c609719bSwdenk entering interactive mode. 882c609719bSwdenk 883c609719bSwdenk This feature is especially useful when "preboot" is 884c609719bSwdenk automatically generated or modified. For an example 885c609719bSwdenk see the LWMON board specific code: here "preboot" is 886c609719bSwdenk modified when the user holds down a certain 887c609719bSwdenk combination of keys on the (special) keyboard when 888c609719bSwdenk booting the systems 889c609719bSwdenk 890c609719bSwdenk- Serial Download Echo Mode: 891c609719bSwdenk CONFIG_LOADS_ECHO 892c609719bSwdenk If defined to 1, all characters received during a 893c609719bSwdenk serial download (using the "loads" command) are 894c609719bSwdenk echoed back. This might be needed by some terminal 895c609719bSwdenk emulations (like "cu"), but may as well just take 896c609719bSwdenk time on others. This setting #define's the initial 897c609719bSwdenk value of the "loads_echo" environment variable. 898c609719bSwdenk 899602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined) 900c609719bSwdenk CONFIG_KGDB_BAUDRATE 901c609719bSwdenk Select one of the baudrates listed in 9026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BAUDRATE_TABLE, see below. 903c609719bSwdenk 904c609719bSwdenk- Monitor Functions: 905602ad3b3SJon Loeliger Monitor commands can be included or excluded 906602ad3b3SJon Loeliger from the build by using the #include files 907c6c621bdSStephen Warren <config_cmd_all.h> and #undef'ing unwanted 908c6c621bdSStephen Warren commands, or using <config_cmd_default.h> 909602ad3b3SJon Loeliger and augmenting with additional #define's 910602ad3b3SJon Loeliger for wanted commands. 911c609719bSwdenk 912602ad3b3SJon Loeliger The default command configuration includes all commands 913602ad3b3SJon Loeliger except those marked below with a "*". 914602ad3b3SJon Loeliger 915602ad3b3SJon Loeliger CONFIG_CMD_ASKENV * ask for env variable 916602ad3b3SJon Loeliger CONFIG_CMD_BDI bdinfo 917602ad3b3SJon Loeliger CONFIG_CMD_BEDBUG * Include BedBug Debugger 918602ad3b3SJon Loeliger CONFIG_CMD_BMP * BMP support 919602ad3b3SJon Loeliger CONFIG_CMD_BSP * Board specific commands 920602ad3b3SJon Loeliger CONFIG_CMD_BOOTD bootd 921602ad3b3SJon Loeliger CONFIG_CMD_CACHE * icache, dcache 92208d0d6f3SMichal Simek CONFIG_CMD_CLK * clock command support 923602ad3b3SJon Loeliger CONFIG_CMD_CONSOLE coninfo 924710b9938SMike Frysinger CONFIG_CMD_CRC32 * crc32 925602ad3b3SJon Loeliger CONFIG_CMD_DATE * support for RTC, date/time... 926602ad3b3SJon Loeliger CONFIG_CMD_DHCP * DHCP support 927602ad3b3SJon Loeliger CONFIG_CMD_DIAG * Diagnostics 928a7c93104SPeter Tyser CONFIG_CMD_DS4510 * ds4510 I2C gpio commands 929a7c93104SPeter Tyser CONFIG_CMD_DS4510_INFO * ds4510 I2C info command 930a7c93104SPeter Tyser CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd 931a7c93104SPeter Tyser CONFIG_CMD_DS4510_RST * ds4510 I2C rst command 932602ad3b3SJon Loeliger CONFIG_CMD_DTT * Digital Therm and Thermostat 933602ad3b3SJon Loeliger CONFIG_CMD_ECHO echo arguments 934246c6922SPeter Tyser CONFIG_CMD_EDITENV edit env variable 935602ad3b3SJon Loeliger CONFIG_CMD_EEPROM * EEPROM read/write support 936602ad3b3SJon Loeliger CONFIG_CMD_ELF * bootelf, bootvx 9375e2b3e0cSJoe Hershberger CONFIG_CMD_ENV_CALLBACK * display details about env callbacks 938fffad71bSJoe Hershberger CONFIG_CMD_ENV_FLAGS * display details about env flags 93988733e2cSAndrew Ruder CONFIG_CMD_ENV_EXISTS * check existence of env variable 9400c79cda0SMike Frysinger CONFIG_CMD_EXPORTENV * export the environment 94103e2ecf6SStephen Warren CONFIG_CMD_EXT2 * ext2 command support 94203e2ecf6SStephen Warren CONFIG_CMD_EXT4 * ext4 command support 94316f4d933SStephen Warren CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls) 94416f4d933SStephen Warren that work for multiple fs types 945bdab39d3SMike Frysinger CONFIG_CMD_SAVEENV saveenv 946602ad3b3SJon Loeliger CONFIG_CMD_FDC * Floppy Disk Support 94703e2ecf6SStephen Warren CONFIG_CMD_FAT * FAT command support 948602ad3b3SJon Loeliger CONFIG_CMD_FLASH flinfo, erase, protect 949602ad3b3SJon Loeliger CONFIG_CMD_FPGA FPGA device initialization support 9504d98b5c8SVincent Stehlé CONFIG_CMD_FUSE * Device fuse support 95153fdc7efSAnton Staaf CONFIG_CMD_GETTIME * Get time since boot 952a641b979SMike Frysinger CONFIG_CMD_GO * the 'go' command (exec code) 953a000b795SKim Phillips CONFIG_CMD_GREPENV * search environment 954bf36c5d5SSimon Glass CONFIG_CMD_HASH * calculate hash / digest 955602ad3b3SJon Loeliger CONFIG_CMD_HWFLOW * RTS/CTS hw flow control 956602ad3b3SJon Loeliger CONFIG_CMD_I2C * I2C serial bus support 957602ad3b3SJon Loeliger CONFIG_CMD_IDE * IDE harddisk support 958602ad3b3SJon Loeliger CONFIG_CMD_IMI iminfo 9598fdf1e0fSVipin Kumar CONFIG_CMD_IMLS List all images found in NOR flash 9604d98b5c8SVincent Stehlé CONFIG_CMD_IMLS_NAND * List all images found in NAND flash 961602ad3b3SJon Loeliger CONFIG_CMD_IMMAP * IMMR dump support 9620c79cda0SMike Frysinger CONFIG_CMD_IMPORTENV * import an environment 963c167cc02SJoe Hershberger CONFIG_CMD_INI * import data from an ini file into the env 964602ad3b3SJon Loeliger CONFIG_CMD_IRQ * irqinfo 965602ad3b3SJon Loeliger CONFIG_CMD_ITEST Integer/string test of 2 values 966602ad3b3SJon Loeliger CONFIG_CMD_JFFS2 * JFFS2 Support 967602ad3b3SJon Loeliger CONFIG_CMD_KGDB * kgdb 9684d98b5c8SVincent Stehlé CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader) 969d22c338eSJoe Hershberger CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration 970d22c338eSJoe Hershberger (169.254.*.*) 971602ad3b3SJon Loeliger CONFIG_CMD_LOADB loadb 972602ad3b3SJon Loeliger CONFIG_CMD_LOADS loads 9734d98b5c8SVincent Stehlé CONFIG_CMD_MD5SUM * print md5 message digest 97402c9aa1dSRobin Getz (requires CONFIG_CMD_MEMORY and CONFIG_MD5) 97515a33e49SSimon Glass CONFIG_CMD_MEMINFO * Display detailed memory information 976602ad3b3SJon Loeliger CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base, 977a2681707SWolfgang Denk loop, loopw 9784d98b5c8SVincent Stehlé CONFIG_CMD_MEMTEST * mtest 979602ad3b3SJon Loeliger CONFIG_CMD_MISC Misc functions like sleep etc 980602ad3b3SJon Loeliger CONFIG_CMD_MMC * MMC memory mapped support 981602ad3b3SJon Loeliger CONFIG_CMD_MII * MII utility commands 98268d7d651SStefan Roese CONFIG_CMD_MTDPARTS * MTD partition support 983602ad3b3SJon Loeliger CONFIG_CMD_NAND * NAND support 984602ad3b3SJon Loeliger CONFIG_CMD_NET bootp, tftpboot, rarpboot 9854d98b5c8SVincent Stehlé CONFIG_CMD_NFS NFS support 986e92739d3SPeter Tyser CONFIG_CMD_PCA953X * PCA953x I2C gpio commands 987e92739d3SPeter Tyser CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command 988602ad3b3SJon Loeliger CONFIG_CMD_PCI * pciinfo 989602ad3b3SJon Loeliger CONFIG_CMD_PCMCIA * PCMCIA support 990602ad3b3SJon Loeliger CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network 991602ad3b3SJon Loeliger host 992602ad3b3SJon Loeliger CONFIG_CMD_PORTIO * Port I/O 993ff048ea9SKenneth Waters CONFIG_CMD_READ * Read raw data from partition 994602ad3b3SJon Loeliger CONFIG_CMD_REGINFO * Register dump 995602ad3b3SJon Loeliger CONFIG_CMD_RUN run command in env variable 996d304931fSSimon Glass CONFIG_CMD_SANDBOX * sb command to access sandbox features 997602ad3b3SJon Loeliger CONFIG_CMD_SAVES * save S record dump 998602ad3b3SJon Loeliger CONFIG_CMD_SCSI * SCSI Support 999602ad3b3SJon Loeliger CONFIG_CMD_SDRAM * print SDRAM configuration information 1000602ad3b3SJon Loeliger (requires CONFIG_CMD_I2C) 1001602ad3b3SJon Loeliger CONFIG_CMD_SETGETDCR Support for DCR Register access 1002602ad3b3SJon Loeliger (4xx only) 1003f61ec45eSEric Nelson CONFIG_CMD_SF * Read/write/erase SPI NOR flash 10044d98b5c8SVincent Stehlé CONFIG_CMD_SHA1SUM * print sha1 memory digest 100502c9aa1dSRobin Getz (requires CONFIG_CMD_MEMORY) 10067d861d95SBob Liu CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x 100774de7aefSWolfgang Denk CONFIG_CMD_SOURCE "source" command Support 1008602ad3b3SJon Loeliger CONFIG_CMD_SPI * SPI serial bus support 10097a83af07SLuca Ceresoli CONFIG_CMD_TFTPSRV * TFTP transfer in server mode 10101fb7cd49SSimon Glass CONFIG_CMD_TFTPPUT * TFTP put command (upload) 1011da83bcd7SJoe Hershberger CONFIG_CMD_TIME * run command and report execution time (ARM specific) 1012da83bcd7SJoe Hershberger CONFIG_CMD_TIMER * access to the system tick timer 1013602ad3b3SJon Loeliger CONFIG_CMD_USB * USB support 1014602ad3b3SJon Loeliger CONFIG_CMD_CDP * Cisco Discover Protocol support 1015c8339f51SMarek Vasut CONFIG_CMD_MFSL * Microblaze FSL support 10164d98b5c8SVincent Stehlé CONFIG_CMD_XIMG Load part of Multi Image 101789c8230dSPrzemyslaw Marczak CONFIG_CMD_UUID * Generate random UUID or GUID string 1018c609719bSwdenk 1019c609719bSwdenk EXAMPLE: If you want all functions except of network 1020c609719bSwdenk support you can write: 1021c609719bSwdenk 1022602ad3b3SJon Loeliger #include "config_cmd_all.h" 1023602ad3b3SJon Loeliger #undef CONFIG_CMD_NET 1024c609719bSwdenk 1025213bf8c8SGerald Van Baren Other Commands: 1026213bf8c8SGerald Van Baren fdt (flattened device tree) command: CONFIG_OF_LIBFDT 1027c609719bSwdenk 1028c609719bSwdenk Note: Don't enable the "icache" and "dcache" commands 1029602ad3b3SJon Loeliger (configuration option CONFIG_CMD_CACHE) unless you know 1030c609719bSwdenk what you (and your U-Boot users) are doing. Data 1031c609719bSwdenk cache cannot be enabled on systems like the 8xx or 1032c609719bSwdenk 8260 (where accesses to the IMMR region must be 1033c609719bSwdenk uncached), and it cannot be disabled on all other 1034c609719bSwdenk systems where we (mis-) use the data cache to hold an 1035c609719bSwdenk initial stack and some data. 1036c609719bSwdenk 1037c609719bSwdenk 1038c609719bSwdenk XXX - this list needs to get updated! 1039c609719bSwdenk 1040a5ecbe62SWolfgang Denk- Regular expression support: 1041a5ecbe62SWolfgang Denk CONFIG_REGEX 1042a5ecbe62SWolfgang Denk If this variable is defined, U-Boot is linked against 1043a5ecbe62SWolfgang Denk the SLRE (Super Light Regular Expression) library, 1044a5ecbe62SWolfgang Denk which adds regex support to some commands, as for 1045a5ecbe62SWolfgang Denk example "env grep" and "setexpr". 1046a5ecbe62SWolfgang Denk 104745ba8077SSimon Glass- Device tree: 104845ba8077SSimon Glass CONFIG_OF_CONTROL 104945ba8077SSimon Glass If this variable is defined, U-Boot will use a device tree 105045ba8077SSimon Glass to configure its devices, instead of relying on statically 105145ba8077SSimon Glass compiled #defines in the board file. This option is 105245ba8077SSimon Glass experimental and only available on a few boards. The device 105345ba8077SSimon Glass tree is available in the global data as gd->fdt_blob. 105445ba8077SSimon Glass 10552c0f79e4SSimon Glass U-Boot needs to get its device tree from somewhere. This can 10562c0f79e4SSimon Glass be done using one of the two options below: 1057bbb0b128SSimon Glass 1058bbb0b128SSimon Glass CONFIG_OF_EMBED 1059bbb0b128SSimon Glass If this variable is defined, U-Boot will embed a device tree 1060bbb0b128SSimon Glass binary in its image. This device tree file should be in the 1061bbb0b128SSimon Glass board directory and called <soc>-<board>.dts. The binary file 1062bbb0b128SSimon Glass is then picked up in board_init_f() and made available through 1063bbb0b128SSimon Glass the global data structure as gd->blob. 106445ba8077SSimon Glass 10652c0f79e4SSimon Glass CONFIG_OF_SEPARATE 10662c0f79e4SSimon Glass If this variable is defined, U-Boot will build a device tree 10672c0f79e4SSimon Glass binary. It will be called u-boot.dtb. Architecture-specific 10682c0f79e4SSimon Glass code will locate it at run-time. Generally this works by: 10692c0f79e4SSimon Glass 10702c0f79e4SSimon Glass cat u-boot.bin u-boot.dtb >image.bin 10712c0f79e4SSimon Glass 10722c0f79e4SSimon Glass and in fact, U-Boot does this for you, creating a file called 10732c0f79e4SSimon Glass u-boot-dtb.bin which is useful in the common case. You can 10742c0f79e4SSimon Glass still use the individual files if you need something more 10752c0f79e4SSimon Glass exotic. 10762c0f79e4SSimon Glass 1077c609719bSwdenk- Watchdog: 1078c609719bSwdenk CONFIG_WATCHDOG 1079c609719bSwdenk If this variable is defined, it enables watchdog 10806abe6fb6SDetlev Zundel support for the SoC. There must be support in the SoC 10816abe6fb6SDetlev Zundel specific code for a watchdog. For the 8xx and 8260 10826abe6fb6SDetlev Zundel CPUs, the SIU Watchdog feature is enabled in the SYPCR 10836abe6fb6SDetlev Zundel register. When supported for a specific SoC is 10846abe6fb6SDetlev Zundel available, then no further board specific code should 10856abe6fb6SDetlev Zundel be needed to use it. 10866abe6fb6SDetlev Zundel 10876abe6fb6SDetlev Zundel CONFIG_HW_WATCHDOG 10886abe6fb6SDetlev Zundel When using a watchdog circuitry external to the used 10896abe6fb6SDetlev Zundel SoC, then define this variable and provide board 10906abe6fb6SDetlev Zundel specific code for the "hw_watchdog_reset" function. 1091c609719bSwdenk 1092c1551ea8Sstroese- U-Boot Version: 1093c1551ea8Sstroese CONFIG_VERSION_VARIABLE 1094c1551ea8Sstroese If this variable is defined, an environment variable 1095c1551ea8Sstroese named "ver" is created by U-Boot showing the U-Boot 1096c1551ea8Sstroese version as printed by the "version" command. 1097a1ea8e51SBenoît Thébaudeau Any change to this variable will be reverted at the 1098a1ea8e51SBenoît Thébaudeau next reset. 1099c1551ea8Sstroese 1100c609719bSwdenk- Real-Time Clock: 1101c609719bSwdenk 1102602ad3b3SJon Loeliger When CONFIG_CMD_DATE is selected, the type of the RTC 1103c609719bSwdenk has to be selected, too. Define exactly one of the 1104c609719bSwdenk following options: 1105c609719bSwdenk 1106c609719bSwdenk CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx 1107c609719bSwdenk CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC 11084e8b7544SFabio Estevam CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC 1109c609719bSwdenk CONFIG_RTC_MC146818 - use MC146818 RTC 11101cb8e980Swdenk CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC 1111c609719bSwdenk CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC 11127f70e853Swdenk CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC 11133bac3513Swdenk CONFIG_RTC_DS164x - use Dallas DS164x RTC 11149536dfccSTor Krill CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC 11154c0d4c3bSwdenk CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC 11166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337 111771d19f30SHeiko Schocher CONFIG_SYS_RV3029_TCR - enable trickle charger on 111871d19f30SHeiko Schocher RV3029 RTC. 1119c609719bSwdenk 1120b37c7e5eSwdenk Note that if the RTC uses I2C, then the I2C interface 1121b37c7e5eSwdenk must also be configured. See I2C Support, below. 1122b37c7e5eSwdenk 1123e92739d3SPeter Tyser- GPIO Support: 1124e92739d3SPeter Tyser CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO 1125e92739d3SPeter Tyser 11265dec49caSChris Packham The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of 11275dec49caSChris Packham chip-ngpio pairs that tell the PCA953X driver the number of 11285dec49caSChris Packham pins supported by a particular chip. 11295dec49caSChris Packham 1130e92739d3SPeter Tyser Note that if the GPIO device uses I2C, then the I2C interface 1131e92739d3SPeter Tyser must also be configured. See I2C Support, below. 1132e92739d3SPeter Tyser 1133c609719bSwdenk- Timestamp Support: 1134c609719bSwdenk 1135c609719bSwdenk When CONFIG_TIMESTAMP is selected, the timestamp 1136c609719bSwdenk (date and time) of an image is printed by image 1137c609719bSwdenk commands like bootm or iminfo. This option is 1138602ad3b3SJon Loeliger automatically enabled when you select CONFIG_CMD_DATE . 1139c609719bSwdenk 1140923c46f9SKarl O. Pinc- Partition Labels (disklabels) Supported: 1141923c46f9SKarl O. Pinc Zero or more of the following: 1142923c46f9SKarl O. Pinc CONFIG_MAC_PARTITION Apple's MacOS partition table. 1143923c46f9SKarl O. Pinc CONFIG_DOS_PARTITION MS Dos partition table, traditional on the 1144923c46f9SKarl O. Pinc Intel architecture, USB sticks, etc. 1145923c46f9SKarl O. Pinc CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc. 1146923c46f9SKarl O. Pinc CONFIG_EFI_PARTITION GPT partition table, common when EFI is the 1147923c46f9SKarl O. Pinc bootloader. Note 2TB partition limit; see 1148923c46f9SKarl O. Pinc disk/part_efi.c 1149923c46f9SKarl O. Pinc CONFIG_MTD_PARTITIONS Memory Technology Device partition table. 1150c609719bSwdenk 1151602ad3b3SJon Loeliger If IDE or SCSI support is enabled (CONFIG_CMD_IDE or 1152218ca724SWolfgang Denk CONFIG_CMD_SCSI) you must configure support for at 1153923c46f9SKarl O. Pinc least one non-MTD partition type as well. 1154c609719bSwdenk 1155c609719bSwdenk- IDE Reset method: 11564d13cbadSwdenk CONFIG_IDE_RESET_ROUTINE - this is defined in several 11574d13cbadSwdenk board configurations files but used nowhere! 1158c609719bSwdenk 11594d13cbadSwdenk CONFIG_IDE_RESET - is this is defined, IDE Reset will 11604d13cbadSwdenk be performed by calling the function 11614d13cbadSwdenk ide_set_reset(int reset) 11624d13cbadSwdenk which has to be defined in a board specific file 1163c609719bSwdenk 1164c609719bSwdenk- ATAPI Support: 1165c609719bSwdenk CONFIG_ATAPI 1166c609719bSwdenk 1167c609719bSwdenk Set this to enable ATAPI support. 1168c609719bSwdenk 1169c40b2956Swdenk- LBA48 Support 1170c40b2956Swdenk CONFIG_LBA48 1171c40b2956Swdenk 1172c40b2956Swdenk Set this to enable support for disks larger than 137GB 11734b142febSHeiko Schocher Also look at CONFIG_SYS_64BIT_LBA. 1174c40b2956Swdenk Whithout these , LBA48 support uses 32bit variables and will 'only' 1175c40b2956Swdenk support disks up to 2.1TB. 1176c40b2956Swdenk 11776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_64BIT_LBA: 1178c40b2956Swdenk When enabled, makes the IDE subsystem use 64bit sector addresses. 1179c40b2956Swdenk Default is 32bit. 1180c40b2956Swdenk 1181c609719bSwdenk- SCSI Support: 1182c609719bSwdenk At the moment only there is only support for the 1183c609719bSwdenk SYM53C8XX SCSI controller; define 1184c609719bSwdenk CONFIG_SCSI_SYM53C8XX to enable it. 1185c609719bSwdenk 11866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and 11876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID * 11886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the 1189c609719bSwdenk maximum numbers of LUNs, SCSI ID's and target 1190c609719bSwdenk devices. 11916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz) 1192c609719bSwdenk 1193447c031bSStefan Reinauer The environment variable 'scsidevs' is set to the number of 1194447c031bSStefan Reinauer SCSI devices found during the last scan. 1195447c031bSStefan Reinauer 1196c609719bSwdenk- NETWORK Support (PCI): 1197682011ffSwdenk CONFIG_E1000 1198ce5207e1SKyle Moffett Support for Intel 8254x/8257x gigabit chips. 1199ce5207e1SKyle Moffett 1200ce5207e1SKyle Moffett CONFIG_E1000_SPI 1201ce5207e1SKyle Moffett Utility code for direct access to the SPI bus on Intel 8257x. 1202ce5207e1SKyle Moffett This does not do anything useful unless you set at least one 1203ce5207e1SKyle Moffett of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC. 1204ce5207e1SKyle Moffett 1205ce5207e1SKyle Moffett CONFIG_E1000_SPI_GENERIC 1206ce5207e1SKyle Moffett Allow generic access to the SPI bus on the Intel 8257x, for 1207ce5207e1SKyle Moffett example with the "sspi" command. 1208ce5207e1SKyle Moffett 1209ce5207e1SKyle Moffett CONFIG_CMD_E1000 1210ce5207e1SKyle Moffett Management command for E1000 devices. When used on devices 1211ce5207e1SKyle Moffett with SPI support you can reprogram the EEPROM from U-Boot. 1212682011ffSwdenk 1213ac3315c2SAndre Schwarz CONFIG_E1000_FALLBACK_MAC 121411ccc33fSMarcel Ziswiler default MAC for empty EEPROM after production. 1215ac3315c2SAndre Schwarz 1216c609719bSwdenk CONFIG_EEPRO100 1217c609719bSwdenk Support for Intel 82557/82559/82559ER chips. 121811ccc33fSMarcel Ziswiler Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM 1219c609719bSwdenk write routine for first time initialisation. 1220c609719bSwdenk 1221c609719bSwdenk CONFIG_TULIP 1222c609719bSwdenk Support for Digital 2114x chips. 1223c609719bSwdenk Optional CONFIG_TULIP_SELECT_MEDIA for board specific 1224c609719bSwdenk modem chip initialisation (KS8761/QS6611). 1225c609719bSwdenk 1226c609719bSwdenk CONFIG_NATSEMI 1227c609719bSwdenk Support for National dp83815 chips. 1228c609719bSwdenk 1229c609719bSwdenk CONFIG_NS8382X 1230c609719bSwdenk Support for National dp8382[01] gigabit chips. 1231c609719bSwdenk 123245219c46Swdenk- NETWORK Support (other): 123345219c46Swdenk 1234c041e9d2SJens Scharsig CONFIG_DRIVER_AT91EMAC 1235c041e9d2SJens Scharsig Support for AT91RM9200 EMAC. 1236c041e9d2SJens Scharsig 1237c041e9d2SJens Scharsig CONFIG_RMII 1238c041e9d2SJens Scharsig Define this to use reduced MII inteface 1239c041e9d2SJens Scharsig 1240c041e9d2SJens Scharsig CONFIG_DRIVER_AT91EMAC_QUIET 1241c041e9d2SJens Scharsig If this defined, the driver is quiet. 1242c041e9d2SJens Scharsig The driver doen't show link status messages. 1243c041e9d2SJens Scharsig 1244efdd7319SRob Herring CONFIG_CALXEDA_XGMAC 1245efdd7319SRob Herring Support for the Calxeda XGMAC device 1246efdd7319SRob Herring 12473bb46d23SAshok CONFIG_LAN91C96 124845219c46Swdenk Support for SMSC's LAN91C96 chips. 124945219c46Swdenk 125045219c46Swdenk CONFIG_LAN91C96_BASE 125145219c46Swdenk Define this to hold the physical address 125245219c46Swdenk of the LAN91C96's I/O space 125345219c46Swdenk 125445219c46Swdenk CONFIG_LAN91C96_USE_32_BIT 125545219c46Swdenk Define this to enable 32 bit addressing 125645219c46Swdenk 12573bb46d23SAshok CONFIG_SMC91111 1258f39748aeSwdenk Support for SMSC's LAN91C111 chip 1259f39748aeSwdenk 1260f39748aeSwdenk CONFIG_SMC91111_BASE 1261f39748aeSwdenk Define this to hold the physical address 1262f39748aeSwdenk of the device (I/O space) 1263f39748aeSwdenk 1264f39748aeSwdenk CONFIG_SMC_USE_32_BIT 1265f39748aeSwdenk Define this if data bus is 32 bits 1266f39748aeSwdenk 1267f39748aeSwdenk CONFIG_SMC_USE_IOFUNCS 1268f39748aeSwdenk Define this to use i/o functions instead of macros 1269f39748aeSwdenk (some hardware wont work with macros) 1270f39748aeSwdenk 1271dc02badaSHeiko Schocher CONFIG_DRIVER_TI_EMAC 1272dc02badaSHeiko Schocher Support for davinci emac 1273dc02badaSHeiko Schocher 1274dc02badaSHeiko Schocher CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT 1275dc02badaSHeiko Schocher Define this if you have more then 3 PHYs. 1276dc02badaSHeiko Schocher 1277b3dbf4a5SMacpaul Lin CONFIG_FTGMAC100 1278b3dbf4a5SMacpaul Lin Support for Faraday's FTGMAC100 Gigabit SoC Ethernet 1279b3dbf4a5SMacpaul Lin 1280b3dbf4a5SMacpaul Lin CONFIG_FTGMAC100_EGIGA 1281b3dbf4a5SMacpaul Lin Define this to use GE link update with gigabit PHY. 1282b3dbf4a5SMacpaul Lin Define this if FTGMAC100 is connected to gigabit PHY. 1283b3dbf4a5SMacpaul Lin If your system has 10/100 PHY only, it might not occur 1284b3dbf4a5SMacpaul Lin wrong behavior. Because PHY usually return timeout or 1285b3dbf4a5SMacpaul Lin useless data when polling gigabit status and gigabit 1286b3dbf4a5SMacpaul Lin control registers. This behavior won't affect the 1287b3dbf4a5SMacpaul Lin correctnessof 10/100 link speed update. 1288b3dbf4a5SMacpaul Lin 1289c2fff331SMike Rapoport CONFIG_SMC911X 1290557b377dSJens Gehrlein Support for SMSC's LAN911x and LAN921x chips 1291557b377dSJens Gehrlein 1292c2fff331SMike Rapoport CONFIG_SMC911X_BASE 1293557b377dSJens Gehrlein Define this to hold the physical address 1294557b377dSJens Gehrlein of the device (I/O space) 1295557b377dSJens Gehrlein 1296c2fff331SMike Rapoport CONFIG_SMC911X_32_BIT 1297557b377dSJens Gehrlein Define this if data bus is 32 bits 1298557b377dSJens Gehrlein 1299c2fff331SMike Rapoport CONFIG_SMC911X_16_BIT 1300557b377dSJens Gehrlein Define this if data bus is 16 bits. If your processor 1301557b377dSJens Gehrlein automatically converts one 32 bit word to two 16 bit 1302c2fff331SMike Rapoport words you may also try CONFIG_SMC911X_32_BIT. 1303557b377dSJens Gehrlein 13043d0075faSYoshihiro Shimoda CONFIG_SH_ETHER 13053d0075faSYoshihiro Shimoda Support for Renesas on-chip Ethernet controller 13063d0075faSYoshihiro Shimoda 13073d0075faSYoshihiro Shimoda CONFIG_SH_ETHER_USE_PORT 13083d0075faSYoshihiro Shimoda Define the number of ports to be used 13093d0075faSYoshihiro Shimoda 13103d0075faSYoshihiro Shimoda CONFIG_SH_ETHER_PHY_ADDR 13113d0075faSYoshihiro Shimoda Define the ETH PHY's address 13123d0075faSYoshihiro Shimoda 131368260aabSYoshihiro Shimoda CONFIG_SH_ETHER_CACHE_WRITEBACK 131468260aabSYoshihiro Shimoda If this option is set, the driver enables cache flush. 131568260aabSYoshihiro Shimoda 13165e124724SVadim Bendebury- TPM Support: 131790899cc0SChe-liang Chiou CONFIG_TPM 131890899cc0SChe-liang Chiou Support TPM devices. 131990899cc0SChe-liang Chiou 13201b393db5STom Wai-Hong Tam CONFIG_TPM_TIS_I2C 13211b393db5STom Wai-Hong Tam Support for i2c bus TPM devices. Only one device 13221b393db5STom Wai-Hong Tam per system is supported at this time. 13231b393db5STom Wai-Hong Tam 13241b393db5STom Wai-Hong Tam CONFIG_TPM_TIS_I2C_BUS_NUMBER 13251b393db5STom Wai-Hong Tam Define the the i2c bus number for the TPM device 13261b393db5STom Wai-Hong Tam 13271b393db5STom Wai-Hong Tam CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS 13281b393db5STom Wai-Hong Tam Define the TPM's address on the i2c bus 13291b393db5STom Wai-Hong Tam 13301b393db5STom Wai-Hong Tam CONFIG_TPM_TIS_I2C_BURST_LIMITATION 13311b393db5STom Wai-Hong Tam Define the burst count bytes upper limit 13321b393db5STom Wai-Hong Tam 1333c01939c7SDirk Eibach CONFIG_TPM_ATMEL_TWI 1334c01939c7SDirk Eibach Support for Atmel TWI TPM device. Requires I2C support. 1335c01939c7SDirk Eibach 133690899cc0SChe-liang Chiou CONFIG_TPM_TIS_LPC 13375e124724SVadim Bendebury Support for generic parallel port TPM devices. Only one device 13385e124724SVadim Bendebury per system is supported at this time. 13395e124724SVadim Bendebury 13405e124724SVadim Bendebury CONFIG_TPM_TIS_BASE_ADDRESS 13415e124724SVadim Bendebury Base address where the generic TPM device is mapped 13425e124724SVadim Bendebury to. Contemporary x86 systems usually map it at 13435e124724SVadim Bendebury 0xfed40000. 13445e124724SVadim Bendebury 1345be6c1529SReinhard Pfau CONFIG_CMD_TPM 1346be6c1529SReinhard Pfau Add tpm monitor functions. 1347be6c1529SReinhard Pfau Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also 1348be6c1529SReinhard Pfau provides monitor access to authorized functions. 1349be6c1529SReinhard Pfau 1350be6c1529SReinhard Pfau CONFIG_TPM 1351be6c1529SReinhard Pfau Define this to enable the TPM support library which provides 1352be6c1529SReinhard Pfau functional interfaces to some TPM commands. 1353be6c1529SReinhard Pfau Requires support for a TPM device. 1354be6c1529SReinhard Pfau 1355be6c1529SReinhard Pfau CONFIG_TPM_AUTH_SESSIONS 1356be6c1529SReinhard Pfau Define this to enable authorized functions in the TPM library. 1357be6c1529SReinhard Pfau Requires CONFIG_TPM and CONFIG_SHA1. 1358be6c1529SReinhard Pfau 1359c609719bSwdenk- USB Support: 1360c609719bSwdenk At the moment only the UHCI host controller is 13614d13cbadSwdenk supported (PIP405, MIP405, MPC5200); define 1362c609719bSwdenk CONFIG_USB_UHCI to enable it. 1363c609719bSwdenk define CONFIG_USB_KEYBOARD to enable the USB Keyboard 136430d56faeSwdenk and define CONFIG_USB_STORAGE to enable the USB 1365c609719bSwdenk storage devices. 1366c609719bSwdenk Note: 1367c609719bSwdenk Supported are USB Keyboards and USB Floppy drives 1368c609719bSwdenk (TEAC FD-05PUB). 13694d13cbadSwdenk MPC5200 USB requires additional defines: 13704d13cbadSwdenk CONFIG_USB_CLOCK 13714d13cbadSwdenk for 528 MHz Clock: 0x0001bbbb 1372307ecb6dSEric Millbrandt CONFIG_PSC3_USB 1373307ecb6dSEric Millbrandt for USB on PSC3 13744d13cbadSwdenk CONFIG_USB_CONFIG 13754d13cbadSwdenk for differential drivers: 0x00001000 13764d13cbadSwdenk for single ended drivers: 0x00005000 1377307ecb6dSEric Millbrandt for differential drivers on PSC3: 0x00000100 1378307ecb6dSEric Millbrandt for single ended drivers on PSC3: 0x00004100 13796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_USB_EVENT_POLL 1380fdcfaa1bSZhang Wei May be defined to allow interrupt polling 1381fdcfaa1bSZhang Wei instead of using asynchronous interrupts 13824d13cbadSwdenk 13839ab4ce22SSimon Glass CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the 13849ab4ce22SSimon Glass txfilltuning field in the EHCI controller on reset. 13859ab4ce22SSimon Glass 1386aa155058SKuo-Jung Su CONFIG_USB_HUB_MIN_POWER_ON_DELAY defines the minimum 1387aa155058SKuo-Jung Su interval for usb hub power-on delay.(minimum 100msec) 1388aa155058SKuo-Jung Su 138916c8d5e7SWolfgang Denk- USB Device: 139016c8d5e7SWolfgang Denk Define the below if you wish to use the USB console. 139116c8d5e7SWolfgang Denk Once firmware is rebuilt from a serial console issue the 139216c8d5e7SWolfgang Denk command "setenv stdin usbtty; setenv stdout usbtty" and 139311ccc33fSMarcel Ziswiler attach your USB cable. The Unix command "dmesg" should print 139416c8d5e7SWolfgang Denk it has found a new device. The environment variable usbtty 139516c8d5e7SWolfgang Denk can be set to gserial or cdc_acm to enable your device to 139616c8d5e7SWolfgang Denk appear to a USB host as a Linux gserial device or a 139716c8d5e7SWolfgang Denk Common Device Class Abstract Control Model serial device. 139816c8d5e7SWolfgang Denk If you select usbtty = gserial you should be able to enumerate 139916c8d5e7SWolfgang Denk a Linux host by 140016c8d5e7SWolfgang Denk # modprobe usbserial vendor=0xVendorID product=0xProductID 140116c8d5e7SWolfgang Denk else if using cdc_acm, simply setting the environment 140216c8d5e7SWolfgang Denk variable usbtty to be cdc_acm should suffice. The following 140316c8d5e7SWolfgang Denk might be defined in YourBoardName.h 140416c8d5e7SWolfgang Denk 140516c8d5e7SWolfgang Denk CONFIG_USB_DEVICE 140616c8d5e7SWolfgang Denk Define this to build a UDC device 140716c8d5e7SWolfgang Denk 140816c8d5e7SWolfgang Denk CONFIG_USB_TTY 140916c8d5e7SWolfgang Denk Define this to have a tty type of device available to 141016c8d5e7SWolfgang Denk talk to the UDC device 141116c8d5e7SWolfgang Denk 1412f9da0f89SVipin KUMAR CONFIG_USBD_HS 1413f9da0f89SVipin KUMAR Define this to enable the high speed support for usb 1414f9da0f89SVipin KUMAR device and usbtty. If this feature is enabled, a routine 1415f9da0f89SVipin KUMAR int is_usbd_high_speed(void) 1416f9da0f89SVipin KUMAR also needs to be defined by the driver to dynamically poll 1417f9da0f89SVipin KUMAR whether the enumeration has succeded at high speed or full 1418f9da0f89SVipin KUMAR speed. 1419f9da0f89SVipin KUMAR 14206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_CONSOLE_IS_IN_ENV 142116c8d5e7SWolfgang Denk Define this if you want stdin, stdout &/or stderr to 142216c8d5e7SWolfgang Denk be set to usbtty. 142316c8d5e7SWolfgang Denk 142416c8d5e7SWolfgang Denk mpc8xx: 14256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_USB_EXTC_CLK 0xBLAH 142616c8d5e7SWolfgang Denk Derive USB clock from external clock "blah" 14276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_USB_EXTC_CLK 0x02 142816c8d5e7SWolfgang Denk 14296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_USB_BRG_CLK 0xBLAH 143016c8d5e7SWolfgang Denk Derive USB clock from brgclk 14316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_USB_BRG_CLK 0x04 143216c8d5e7SWolfgang Denk 143316c8d5e7SWolfgang Denk If you have a USB-IF assigned VendorID then you may wish to 143416c8d5e7SWolfgang Denk define your own vendor specific values either in BoardName.h 143516c8d5e7SWolfgang Denk or directly in usbd_vendor_info.h. If you don't define 143616c8d5e7SWolfgang Denk CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME, 143716c8d5e7SWolfgang Denk CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot 143816c8d5e7SWolfgang Denk should pretend to be a Linux device to it's target host. 143916c8d5e7SWolfgang Denk 144016c8d5e7SWolfgang Denk CONFIG_USBD_MANUFACTURER 144116c8d5e7SWolfgang Denk Define this string as the name of your company for 144216c8d5e7SWolfgang Denk - CONFIG_USBD_MANUFACTURER "my company" 144316c8d5e7SWolfgang Denk 144416c8d5e7SWolfgang Denk CONFIG_USBD_PRODUCT_NAME 144516c8d5e7SWolfgang Denk Define this string as the name of your product 144616c8d5e7SWolfgang Denk - CONFIG_USBD_PRODUCT_NAME "acme usb device" 144716c8d5e7SWolfgang Denk 144816c8d5e7SWolfgang Denk CONFIG_USBD_VENDORID 144916c8d5e7SWolfgang Denk Define this as your assigned Vendor ID from the USB 145016c8d5e7SWolfgang Denk Implementors Forum. This *must* be a genuine Vendor ID 145116c8d5e7SWolfgang Denk to avoid polluting the USB namespace. 145216c8d5e7SWolfgang Denk - CONFIG_USBD_VENDORID 0xFFFF 145316c8d5e7SWolfgang Denk 145416c8d5e7SWolfgang Denk CONFIG_USBD_PRODUCTID 145516c8d5e7SWolfgang Denk Define this as the unique Product ID 145616c8d5e7SWolfgang Denk for your device 145716c8d5e7SWolfgang Denk - CONFIG_USBD_PRODUCTID 0xFFFF 1458c609719bSwdenk 1459351e9b20SPrzemyslaw Marczak Some USB device drivers may need to check USB cable attachment. 1460351e9b20SPrzemyslaw Marczak In this case you can enable following config in BoardName.h: 1461351e9b20SPrzemyslaw Marczak CONFIG_USB_CABLE_CHECK 1462351e9b20SPrzemyslaw Marczak This enables function definition: 1463351e9b20SPrzemyslaw Marczak - usb_cable_connected() in include/usb.h 1464351e9b20SPrzemyslaw Marczak Implementation of this function is board-specific. 1465351e9b20SPrzemyslaw Marczak 1466d70a560fSIgor Grinberg- ULPI Layer Support: 1467d70a560fSIgor Grinberg The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via 1468d70a560fSIgor Grinberg the generic ULPI layer. The generic layer accesses the ULPI PHY 1469d70a560fSIgor Grinberg via the platform viewport, so you need both the genric layer and 1470d70a560fSIgor Grinberg the viewport enabled. Currently only Chipidea/ARC based 1471d70a560fSIgor Grinberg viewport is supported. 1472d70a560fSIgor Grinberg To enable the ULPI layer support, define CONFIG_USB_ULPI and 1473d70a560fSIgor Grinberg CONFIG_USB_ULPI_VIEWPORT in your board configuration file. 14746d365ea0SLucas Stach If your ULPI phy needs a different reference clock than the 14756d365ea0SLucas Stach standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to 14766d365ea0SLucas Stach the appropriate value in Hz. 1477c609719bSwdenk 1478c609719bSwdenk- MMC Support: 1479c609719bSwdenk The MMC controller on the Intel PXA is supported. To 1480c609719bSwdenk enable this define CONFIG_MMC. The MMC can be 1481c609719bSwdenk accessed from the boot prompt by mapping the device 1482c609719bSwdenk to physical memory similar to flash. Command line is 1483602ad3b3SJon Loeliger enabled with CONFIG_CMD_MMC. The MMC driver also works with 1484602ad3b3SJon Loeliger the FAT fs. This is enabled with CONFIG_CMD_FAT. 1485c609719bSwdenk 1486afb35666SYoshihiro Shimoda CONFIG_SH_MMCIF 1487afb35666SYoshihiro Shimoda Support for Renesas on-chip MMCIF controller 1488afb35666SYoshihiro Shimoda 1489afb35666SYoshihiro Shimoda CONFIG_SH_MMCIF_ADDR 1490afb35666SYoshihiro Shimoda Define the base address of MMCIF registers 1491afb35666SYoshihiro Shimoda 1492afb35666SYoshihiro Shimoda CONFIG_SH_MMCIF_CLK 1493afb35666SYoshihiro Shimoda Define the clock frequency for MMCIF 1494afb35666SYoshihiro Shimoda 1495b3ba6e94STom Rini- USB Device Firmware Update (DFU) class support: 1496b3ba6e94STom Rini CONFIG_DFU_FUNCTION 1497b3ba6e94STom Rini This enables the USB portion of the DFU USB class 1498b3ba6e94STom Rini 1499b3ba6e94STom Rini CONFIG_CMD_DFU 1500b3ba6e94STom Rini This enables the command "dfu" which is used to have 1501b3ba6e94STom Rini U-Boot create a DFU class device via USB. This command 1502b3ba6e94STom Rini requires that the "dfu_alt_info" environment variable be 1503b3ba6e94STom Rini set and define the alt settings to expose to the host. 1504b3ba6e94STom Rini 1505b3ba6e94STom Rini CONFIG_DFU_MMC 1506b3ba6e94STom Rini This enables support for exposing (e)MMC devices via DFU. 1507b3ba6e94STom Rini 1508c6631764SPantelis Antoniou CONFIG_DFU_NAND 1509c6631764SPantelis Antoniou This enables support for exposing NAND devices via DFU. 1510c6631764SPantelis Antoniou 1511a9479f04SAfzal Mohammed CONFIG_DFU_RAM 1512a9479f04SAfzal Mohammed This enables support for exposing RAM via DFU. 1513a9479f04SAfzal Mohammed Note: DFU spec refer to non-volatile memory usage, but 1514a9479f04SAfzal Mohammed allow usages beyond the scope of spec - here RAM usage, 1515a9479f04SAfzal Mohammed one that would help mostly the developer. 1516a9479f04SAfzal Mohammed 1517e7e75c70SHeiko Schocher CONFIG_SYS_DFU_DATA_BUF_SIZE 1518e7e75c70SHeiko Schocher Dfu transfer uses a buffer before writing data to the 1519e7e75c70SHeiko Schocher raw storage device. Make the size (in bytes) of this buffer 1520e7e75c70SHeiko Schocher configurable. The size of this buffer is also configurable 1521e7e75c70SHeiko Schocher through the "dfu_bufsiz" environment variable. 1522e7e75c70SHeiko Schocher 1523ea2453d5SPantelis Antoniou CONFIG_SYS_DFU_MAX_FILE_SIZE 1524ea2453d5SPantelis Antoniou When updating files rather than the raw storage device, 1525ea2453d5SPantelis Antoniou we use a static buffer to copy the file into and then write 1526ea2453d5SPantelis Antoniou the buffer once we've been given the whole file. Define 1527ea2453d5SPantelis Antoniou this to the maximum filesize (in bytes) for the buffer. 1528ea2453d5SPantelis Antoniou Default is 4 MiB if undefined. 1529ea2453d5SPantelis Antoniou 1530001a8319SHeiko Schocher DFU_DEFAULT_POLL_TIMEOUT 1531001a8319SHeiko Schocher Poll timeout [ms], is the timeout a device can send to the 1532001a8319SHeiko Schocher host. The host must wait for this timeout before sending 1533001a8319SHeiko Schocher a subsequent DFU_GET_STATUS request to the device. 1534001a8319SHeiko Schocher 1535001a8319SHeiko Schocher DFU_MANIFEST_POLL_TIMEOUT 1536001a8319SHeiko Schocher Poll timeout [ms], which the device sends to the host when 1537001a8319SHeiko Schocher entering dfuMANIFEST state. Host waits this timeout, before 1538001a8319SHeiko Schocher sending again an USB request to the device. 1539001a8319SHeiko Schocher 15406705d81eSwdenk- Journaling Flash filesystem support: 15416705d81eSwdenk CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE, 15426705d81eSwdenk CONFIG_JFFS2_NAND_DEV 15436705d81eSwdenk Define these for a default partition on a NAND device 15446705d81eSwdenk 15456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS2_FIRST_SECTOR, 15466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS 15476705d81eSwdenk Define these for a default partition on a NOR device 15486705d81eSwdenk 15496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS_CUSTOM_PART 15506705d81eSwdenk Define this to create an own partition. You have to provide a 15516705d81eSwdenk function struct part_info* jffs2_part_info(int part_num) 15526705d81eSwdenk 15536705d81eSwdenk If you define only one JFFS2 partition you may also want to 15546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_JFFS_SINGLE_PART 1 15556705d81eSwdenk to disable the command chpart. This is the default when you 15566705d81eSwdenk have not defined a custom partition 15576705d81eSwdenk 1558c30a15e5SDonggeun Kim- FAT(File Allocation Table) filesystem write function support: 1559c30a15e5SDonggeun Kim CONFIG_FAT_WRITE 1560656f4c65SDonggeun Kim 1561656f4c65SDonggeun Kim Define this to enable support for saving memory data as a 1562656f4c65SDonggeun Kim file in FAT formatted partition. 1563656f4c65SDonggeun Kim 1564656f4c65SDonggeun Kim This will also enable the command "fatwrite" enabling the 1565656f4c65SDonggeun Kim user to write files to FAT. 1566c30a15e5SDonggeun Kim 156784cd9327SGabe BlackCBFS (Coreboot Filesystem) support 156884cd9327SGabe Black CONFIG_CMD_CBFS 156984cd9327SGabe Black 157084cd9327SGabe Black Define this to enable support for reading from a Coreboot 157184cd9327SGabe Black filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls 157284cd9327SGabe Black and cbfsload. 157384cd9327SGabe Black 1574c609719bSwdenk- Keyboard Support: 1575c609719bSwdenk CONFIG_ISA_KEYBOARD 1576c609719bSwdenk 1577c609719bSwdenk Define this to enable standard (PC-Style) keyboard 1578c609719bSwdenk support 1579c609719bSwdenk 1580c609719bSwdenk CONFIG_I8042_KBD 1581c609719bSwdenk Standard PC keyboard driver with US (is default) and 1582c609719bSwdenk GERMAN key layout (switch via environment 'keymap=de') support. 1583c609719bSwdenk Export function i8042_kbd_init, i8042_tstc and i8042_getc 1584c609719bSwdenk for cfb_console. Supports cursor blinking. 1585c609719bSwdenk 1586713cb680SHung-ying Tyan CONFIG_CROS_EC_KEYB 1587713cb680SHung-ying Tyan Enables a Chrome OS keyboard using the CROS_EC interface. 1588713cb680SHung-ying Tyan This uses CROS_EC to communicate with a second microcontroller 1589713cb680SHung-ying Tyan which provides key scans on request. 1590713cb680SHung-ying Tyan 1591c609719bSwdenk- Video support: 1592c609719bSwdenk CONFIG_VIDEO 1593c609719bSwdenk 1594c609719bSwdenk Define this to enable video support (for output to 1595c609719bSwdenk video). 1596c609719bSwdenk 1597c609719bSwdenk CONFIG_VIDEO_CT69000 1598c609719bSwdenk 1599c609719bSwdenk Enable Chips & Technologies 69000 Video chip 1600c609719bSwdenk 1601c609719bSwdenk CONFIG_VIDEO_SMI_LYNXEM 1602eeb1b77bSwdenk Enable Silicon Motion SMI 712/710/810 Video chip. The 1603eeb1b77bSwdenk video output is selected via environment 'videoout' 1604eeb1b77bSwdenk (1 = LCD and 2 = CRT). If videoout is undefined, CRT is 1605eeb1b77bSwdenk assumed. 1606c609719bSwdenk 1607eeb1b77bSwdenk For the CT69000 and SMI_LYNXEM drivers, videomode is 160811ccc33fSMarcel Ziswiler selected via environment 'videomode'. Two different ways 1609eeb1b77bSwdenk are possible: 1610eeb1b77bSwdenk - "videomode=num" 'num' is a standard LiLo mode numbers. 1611eeb1b77bSwdenk Following standard modes are supported (* is default): 1612eeb1b77bSwdenk 1613eeb1b77bSwdenk Colors 640x480 800x600 1024x768 1152x864 1280x1024 1614eeb1b77bSwdenk -------------+--------------------------------------------- 1615eeb1b77bSwdenk 8 bits | 0x301* 0x303 0x305 0x161 0x307 1616eeb1b77bSwdenk 15 bits | 0x310 0x313 0x316 0x162 0x319 1617eeb1b77bSwdenk 16 bits | 0x311 0x314 0x317 0x163 0x31A 1618eeb1b77bSwdenk 24 bits | 0x312 0x315 0x318 ? 0x31B 1619eeb1b77bSwdenk -------------+--------------------------------------------- 1620c609719bSwdenk (i.e. setenv videomode 317; saveenv; reset;) 1621c609719bSwdenk 1622eeb1b77bSwdenk - "videomode=bootargs" all the video parameters are parsed 16237817cb20SMarcel Ziswiler from the bootargs. (See drivers/video/videomodes.c) 1624eeb1b77bSwdenk 1625eeb1b77bSwdenk 1626a6c7ad2fSwdenk CONFIG_VIDEO_SED13806 1627a6c7ad2fSwdenk Enable Epson SED13806 driver. This driver supports 8bpp 1628a6c7ad2fSwdenk and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP 1629a6c7ad2fSwdenk or CONFIG_VIDEO_SED13806_16BPP 1630a6c7ad2fSwdenk 16317d3053fbSTimur Tabi CONFIG_FSL_DIU_FB 16327d3053fbSTimur Tabi Enable the Freescale DIU video driver. Reference boards for 16337d3053fbSTimur Tabi SOCs that have a DIU should define this macro to enable DIU 16347d3053fbSTimur Tabi support, and should also define these other macros: 16357d3053fbSTimur Tabi 16367d3053fbSTimur Tabi CONFIG_SYS_DIU_ADDR 16377d3053fbSTimur Tabi CONFIG_VIDEO 16387d3053fbSTimur Tabi CONFIG_CMD_BMP 16397d3053fbSTimur Tabi CONFIG_CFB_CONSOLE 16407d3053fbSTimur Tabi CONFIG_VIDEO_SW_CURSOR 16417d3053fbSTimur Tabi CONFIG_VGA_AS_SINGLE_DEVICE 16427d3053fbSTimur Tabi CONFIG_VIDEO_LOGO 16437d3053fbSTimur Tabi CONFIG_VIDEO_BMP_LOGO 16447d3053fbSTimur Tabi 1645ba8e76bdSTimur Tabi The DIU driver will look for the 'video-mode' environment 1646ba8e76bdSTimur Tabi variable, and if defined, enable the DIU as a console during 1647ba8e76bdSTimur Tabi boot. See the documentation file README.video for a 1648ba8e76bdSTimur Tabi description of this variable. 16497d3053fbSTimur Tabi 1650058d59b0SSimon Glass CONFIG_VIDEO_VGA 1651058d59b0SSimon Glass 1652058d59b0SSimon Glass Enable the VGA video / BIOS for x86. The alternative if you 1653058d59b0SSimon Glass are using coreboot is to use the coreboot frame buffer 1654058d59b0SSimon Glass driver. 1655058d59b0SSimon Glass 1656058d59b0SSimon Glass 1657682011ffSwdenk- Keyboard Support: 1658682011ffSwdenk CONFIG_KEYBOARD 1659682011ffSwdenk 1660682011ffSwdenk Define this to enable a custom keyboard support. 1661682011ffSwdenk This simply calls drv_keyboard_init() which must be 1662682011ffSwdenk defined in your board-specific files. 1663682011ffSwdenk The only board using this so far is RBC823. 1664a6c7ad2fSwdenk 1665c609719bSwdenk- LCD Support: CONFIG_LCD 1666c609719bSwdenk 1667c609719bSwdenk Define this to enable LCD support (for output to LCD 1668c609719bSwdenk display); also select one of the supported displays 1669c609719bSwdenk by defining one of these: 1670c609719bSwdenk 167139cf4804SStelian Pop CONFIG_ATMEL_LCD: 167239cf4804SStelian Pop 167339cf4804SStelian Pop HITACHI TX09D70VM1CCA, 3.5", 240x320. 167439cf4804SStelian Pop 1675fd3103bbSwdenk CONFIG_NEC_NL6448AC33: 1676c609719bSwdenk 1677fd3103bbSwdenk NEC NL6448AC33-18. Active, color, single scan. 1678c609719bSwdenk 1679fd3103bbSwdenk CONFIG_NEC_NL6448BC20 1680c609719bSwdenk 1681fd3103bbSwdenk NEC NL6448BC20-08. 6.5", 640x480. 1682fd3103bbSwdenk Active, color, single scan. 1683fd3103bbSwdenk 1684fd3103bbSwdenk CONFIG_NEC_NL6448BC33_54 1685fd3103bbSwdenk 1686fd3103bbSwdenk NEC NL6448BC33-54. 10.4", 640x480. 1687c609719bSwdenk Active, color, single scan. 1688c609719bSwdenk 1689c609719bSwdenk CONFIG_SHARP_16x9 1690c609719bSwdenk 1691c609719bSwdenk Sharp 320x240. Active, color, single scan. 1692c609719bSwdenk It isn't 16x9, and I am not sure what it is. 1693c609719bSwdenk 1694c609719bSwdenk CONFIG_SHARP_LQ64D341 1695c609719bSwdenk 1696c609719bSwdenk Sharp LQ64D341 display, 640x480. 1697c609719bSwdenk Active, color, single scan. 1698c609719bSwdenk 1699c609719bSwdenk CONFIG_HLD1045 1700c609719bSwdenk 1701c609719bSwdenk HLD1045 display, 640x480. 1702c609719bSwdenk Active, color, single scan. 1703c609719bSwdenk 1704c609719bSwdenk CONFIG_OPTREX_BW 1705c609719bSwdenk 1706c609719bSwdenk Optrex CBL50840-2 NF-FW 99 22 M5 1707c609719bSwdenk or 1708c609719bSwdenk Hitachi LMG6912RPFC-00T 1709c609719bSwdenk or 1710c609719bSwdenk Hitachi SP14Q002 1711c609719bSwdenk 1712c609719bSwdenk 320x240. Black & white. 1713c609719bSwdenk 1714c609719bSwdenk Normally display is black on white background; define 17156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_WHITE_ON_BLACK to get it inverted. 1716c609719bSwdenk 1717676d319eSSimon Glass CONFIG_LCD_ALIGNMENT 1718676d319eSSimon Glass 1719676d319eSSimon Glass Normally the LCD is page-aligned (tyically 4KB). If this is 1720676d319eSSimon Glass defined then the LCD will be aligned to this value instead. 1721676d319eSSimon Glass For ARM it is sometimes useful to use MMU_SECTION_SIZE 1722676d319eSSimon Glass here, since it is cheaper to change data cache settings on 1723676d319eSSimon Glass a per-section basis. 1724676d319eSSimon Glass 17250d89efefSSimon Glass CONFIG_CONSOLE_SCROLL_LINES 17260d89efefSSimon Glass 17270d89efefSSimon Glass When the console need to be scrolled, this is the number of 17280d89efefSSimon Glass lines to scroll by. It defaults to 1. Increasing this makes 17290d89efefSSimon Glass the console jump but can help speed up operation when scrolling 17300d89efefSSimon Glass is slow. 1731676d319eSSimon Glass 173245d7f525STom Wai-Hong Tam CONFIG_LCD_BMP_RLE8 173345d7f525STom Wai-Hong Tam 173445d7f525STom Wai-Hong Tam Support drawing of RLE8-compressed bitmaps on the LCD. 173545d7f525STom Wai-Hong Tam 1736735987c5STom Wai-Hong Tam CONFIG_I2C_EDID 1737735987c5STom Wai-Hong Tam 1738735987c5STom Wai-Hong Tam Enables an 'i2c edid' command which can read EDID 1739735987c5STom Wai-Hong Tam information over I2C from an attached LCD display. 1740735987c5STom Wai-Hong Tam 17417152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN 1742d791b1dcSwdenk 1743d791b1dcSwdenk If this option is set, the environment is checked for 1744d791b1dcSwdenk a variable "splashimage". If found, the usual display 1745d791b1dcSwdenk of logo, copyright and system information on the LCD 1746e94d2cd9Swdenk is suppressed and the BMP image at the address 1747d791b1dcSwdenk specified in "splashimage" is loaded instead. The 1748d791b1dcSwdenk console is redirected to the "nulldev", too. This 1749d791b1dcSwdenk allows for a "silent" boot where a splash screen is 1750d791b1dcSwdenk loaded very quickly after power-on. 1751d791b1dcSwdenk 1752c0880485SNikita Kiryanov CONFIG_SPLASHIMAGE_GUARD 1753c0880485SNikita Kiryanov 1754c0880485SNikita Kiryanov If this option is set, then U-Boot will prevent the environment 1755c0880485SNikita Kiryanov variable "splashimage" from being set to a problematic address 17561551df35STom Rini (see README.displaying-bmps). 1757c0880485SNikita Kiryanov This option is useful for targets where, due to alignment 1758c0880485SNikita Kiryanov restrictions, an improperly aligned BMP image will cause a data 1759c0880485SNikita Kiryanov abort. If you think you will not have problems with unaligned 1760c0880485SNikita Kiryanov accesses (for example because your toolchain prevents them) 1761c0880485SNikita Kiryanov there is no need to set this option. 1762c0880485SNikita Kiryanov 17631ca298ceSMatthias Weisser CONFIG_SPLASH_SCREEN_ALIGN 17641ca298ceSMatthias Weisser 17651ca298ceSMatthias Weisser If this option is set the splash image can be freely positioned 17661ca298ceSMatthias Weisser on the screen. Environment variable "splashpos" specifies the 17671ca298ceSMatthias Weisser position as "x,y". If a positive number is given it is used as 17681ca298ceSMatthias Weisser number of pixel from left/top. If a negative number is given it 17691ca298ceSMatthias Weisser is used as number of pixel from right/bottom. You can also 17701ca298ceSMatthias Weisser specify 'm' for centering the image. 17711ca298ceSMatthias Weisser 17721ca298ceSMatthias Weisser Example: 17731ca298ceSMatthias Weisser setenv splashpos m,m 17741ca298ceSMatthias Weisser => image at center of screen 17751ca298ceSMatthias Weisser 17761ca298ceSMatthias Weisser setenv splashpos 30,20 17771ca298ceSMatthias Weisser => image at x = 30 and y = 20 17781ca298ceSMatthias Weisser 17791ca298ceSMatthias Weisser setenv splashpos -10,m 17801ca298ceSMatthias Weisser => vertically centered image 17811ca298ceSMatthias Weisser at x = dspWidth - bmpWidth - 9 17821ca298ceSMatthias Weisser 178398f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP 178498f4a3dfSStefan Roese 178598f4a3dfSStefan Roese If this option is set, additionally to standard BMP 178698f4a3dfSStefan Roese images, gzipped BMP images can be displayed via the 178798f4a3dfSStefan Roese splashscreen support or the bmp command. 178898f4a3dfSStefan Roese 1789d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8 1790d5011762SAnatolij Gustschin 1791d5011762SAnatolij Gustschin If this option is set, 8-bit RLE compressed BMP images 1792d5011762SAnatolij Gustschin can be displayed via the splashscreen support or the 1793d5011762SAnatolij Gustschin bmp command. 1794d5011762SAnatolij Gustschin 1795f2b96dfbSLei Wen- Do compresssing for memory range: 1796f2b96dfbSLei Wen CONFIG_CMD_ZIP 1797f2b96dfbSLei Wen 1798f2b96dfbSLei Wen If this option is set, it would use zlib deflate method 1799f2b96dfbSLei Wen to compress the specified memory at its best effort. 1800f2b96dfbSLei Wen 1801c29fdfc1Swdenk- Compression support: 18028ef70478SKees Cook CONFIG_GZIP 18038ef70478SKees Cook 18048ef70478SKees Cook Enabled by default to support gzip compressed images. 18058ef70478SKees Cook 1806c29fdfc1Swdenk CONFIG_BZIP2 1807c29fdfc1Swdenk 1808c29fdfc1Swdenk If this option is set, support for bzip2 compressed 1809c29fdfc1Swdenk images is included. If not, only uncompressed and gzip 1810c29fdfc1Swdenk compressed images are supported. 1811c29fdfc1Swdenk 1812c29fdfc1Swdenk NOTE: the bzip2 algorithm requires a lot of RAM, so 18136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should 1814c29fdfc1Swdenk be at least 4MB. 1815d791b1dcSwdenk 1816fc9c1727SLuigi 'Comio' Mantellini CONFIG_LZMA 1817fc9c1727SLuigi 'Comio' Mantellini 1818fc9c1727SLuigi 'Comio' Mantellini If this option is set, support for lzma compressed 1819fc9c1727SLuigi 'Comio' Mantellini images is included. 1820fc9c1727SLuigi 'Comio' Mantellini 1821fc9c1727SLuigi 'Comio' Mantellini Note: The LZMA algorithm adds between 2 and 4KB of code and it 1822fc9c1727SLuigi 'Comio' Mantellini requires an amount of dynamic memory that is given by the 1823fc9c1727SLuigi 'Comio' Mantellini formula: 1824fc9c1727SLuigi 'Comio' Mantellini 1825fc9c1727SLuigi 'Comio' Mantellini (1846 + 768 << (lc + lp)) * sizeof(uint16) 1826fc9c1727SLuigi 'Comio' Mantellini 1827fc9c1727SLuigi 'Comio' Mantellini Where lc and lp stand for, respectively, Literal context bits 1828fc9c1727SLuigi 'Comio' Mantellini and Literal pos bits. 1829fc9c1727SLuigi 'Comio' Mantellini 1830fc9c1727SLuigi 'Comio' Mantellini This value is upper-bounded by 14MB in the worst case. Anyway, 1831fc9c1727SLuigi 'Comio' Mantellini for a ~4MB large kernel image, we have lc=3 and lp=0 for a 1832fc9c1727SLuigi 'Comio' Mantellini total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is 1833fc9c1727SLuigi 'Comio' Mantellini a very small buffer. 1834fc9c1727SLuigi 'Comio' Mantellini 1835fc9c1727SLuigi 'Comio' Mantellini Use the lzmainfo tool to determinate the lc and lp values and 1836fc9c1727SLuigi 'Comio' Mantellini then calculate the amount of needed dynamic memory (ensuring 18376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD the appropriate CONFIG_SYS_MALLOC_LEN value). 1838fc9c1727SLuigi 'Comio' Mantellini 18398ef70478SKees Cook CONFIG_LZO 18408ef70478SKees Cook 18418ef70478SKees Cook If this option is set, support for LZO compressed images 18428ef70478SKees Cook is included. 18438ef70478SKees Cook 184417ea1177Swdenk- MII/PHY support: 184517ea1177Swdenk CONFIG_PHY_ADDR 184617ea1177Swdenk 184717ea1177Swdenk The address of PHY on MII bus. 184817ea1177Swdenk 184917ea1177Swdenk CONFIG_PHY_CLOCK_FREQ (ppc4xx) 185017ea1177Swdenk 185117ea1177Swdenk The clock frequency of the MII bus 185217ea1177Swdenk 185317ea1177Swdenk CONFIG_PHY_GIGE 185417ea1177Swdenk 185517ea1177Swdenk If this option is set, support for speed/duplex 185611ccc33fSMarcel Ziswiler detection of gigabit PHY is included. 185717ea1177Swdenk 185817ea1177Swdenk CONFIG_PHY_RESET_DELAY 185917ea1177Swdenk 186017ea1177Swdenk Some PHY like Intel LXT971A need extra delay after 186117ea1177Swdenk reset before any MII register access is possible. 186217ea1177Swdenk For such PHY, set this option to the usec delay 186317ea1177Swdenk required. (minimum 300usec for LXT971A) 186417ea1177Swdenk 186517ea1177Swdenk CONFIG_PHY_CMD_DELAY (ppc4xx) 186617ea1177Swdenk 186717ea1177Swdenk Some PHY like Intel LXT971A need extra delay after 186817ea1177Swdenk command issued before MII status register can be read 186917ea1177Swdenk 1870c609719bSwdenk- Ethernet address: 1871c609719bSwdenk CONFIG_ETHADDR 1872c68a05feSrichardretanubun CONFIG_ETH1ADDR 1873c609719bSwdenk CONFIG_ETH2ADDR 1874c609719bSwdenk CONFIG_ETH3ADDR 1875c68a05feSrichardretanubun CONFIG_ETH4ADDR 1876c68a05feSrichardretanubun CONFIG_ETH5ADDR 1877c609719bSwdenk 187811ccc33fSMarcel Ziswiler Define a default value for Ethernet address to use 187911ccc33fSMarcel Ziswiler for the respective Ethernet interface, in case this 1880c609719bSwdenk is not determined automatically. 1881c609719bSwdenk 1882c609719bSwdenk- IP address: 1883c609719bSwdenk CONFIG_IPADDR 1884c609719bSwdenk 1885c609719bSwdenk Define a default value for the IP address to use for 188611ccc33fSMarcel Ziswiler the default Ethernet interface, in case this is not 1887c609719bSwdenk determined through e.g. bootp. 18881ebcd654SWolfgang Denk (Environment variable "ipaddr") 1889c609719bSwdenk 1890c609719bSwdenk- Server IP address: 1891c609719bSwdenk CONFIG_SERVERIP 1892c609719bSwdenk 1893c609719bSwdenk Defines a default value for the IP address of a TFTP 1894c609719bSwdenk server to contact when using the "tftboot" command. 18951ebcd654SWolfgang Denk (Environment variable "serverip") 1896c609719bSwdenk 189797cfe861SRobin Getz CONFIG_KEEP_SERVERADDR 189897cfe861SRobin Getz 189997cfe861SRobin Getz Keeps the server's MAC address, in the env 'serveraddr' 190097cfe861SRobin Getz for passing to bootargs (like Linux's netconsole option) 190197cfe861SRobin Getz 19021ebcd654SWolfgang Denk- Gateway IP address: 19031ebcd654SWolfgang Denk CONFIG_GATEWAYIP 19041ebcd654SWolfgang Denk 19051ebcd654SWolfgang Denk Defines a default value for the IP address of the 19061ebcd654SWolfgang Denk default router where packets to other networks are 19071ebcd654SWolfgang Denk sent to. 19081ebcd654SWolfgang Denk (Environment variable "gatewayip") 19091ebcd654SWolfgang Denk 19101ebcd654SWolfgang Denk- Subnet mask: 19111ebcd654SWolfgang Denk CONFIG_NETMASK 19121ebcd654SWolfgang Denk 19131ebcd654SWolfgang Denk Defines a default value for the subnet mask (or 19141ebcd654SWolfgang Denk routing prefix) which is used to determine if an IP 19151ebcd654SWolfgang Denk address belongs to the local subnet or needs to be 19161ebcd654SWolfgang Denk forwarded through a router. 19171ebcd654SWolfgang Denk (Environment variable "netmask") 19181ebcd654SWolfgang Denk 191953a5c424SDavid Updegraff- Multicast TFTP Mode: 192053a5c424SDavid Updegraff CONFIG_MCAST_TFTP 192153a5c424SDavid Updegraff 192253a5c424SDavid Updegraff Defines whether you want to support multicast TFTP as per 192353a5c424SDavid Updegraff rfc-2090; for example to work with atftp. Lets lots of targets 192411ccc33fSMarcel Ziswiler tftp down the same boot image concurrently. Note: the Ethernet 192553a5c424SDavid Updegraff driver in use must provide a function: mcast() to join/leave a 192653a5c424SDavid Updegraff multicast group. 192753a5c424SDavid Updegraff 1928c609719bSwdenk- BOOTP Recovery Mode: 1929c609719bSwdenk CONFIG_BOOTP_RANDOM_DELAY 1930c609719bSwdenk 1931c609719bSwdenk If you have many targets in a network that try to 1932c609719bSwdenk boot using BOOTP, you may want to avoid that all 1933c609719bSwdenk systems send out BOOTP requests at precisely the same 1934c609719bSwdenk moment (which would happen for instance at recovery 1935c609719bSwdenk from a power failure, when all systems will try to 1936c609719bSwdenk boot, thus flooding the BOOTP server. Defining 1937c609719bSwdenk CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be 1938c609719bSwdenk inserted before sending out BOOTP requests. The 19396c33c785SWolfgang Denk following delays are inserted then: 1940c609719bSwdenk 1941c609719bSwdenk 1st BOOTP request: delay 0 ... 1 sec 1942c609719bSwdenk 2nd BOOTP request: delay 0 ... 2 sec 1943c609719bSwdenk 3rd BOOTP request: delay 0 ... 4 sec 1944c609719bSwdenk 4th and following 1945c609719bSwdenk BOOTP requests: delay 0 ... 8 sec 1946c609719bSwdenk 1947fe389a82Sstroese- DHCP Advanced Options: 19481fe80d79SJon Loeliger You can fine tune the DHCP functionality by defining 19491fe80d79SJon Loeliger CONFIG_BOOTP_* symbols: 1950fe389a82Sstroese 19511fe80d79SJon Loeliger CONFIG_BOOTP_SUBNETMASK 19521fe80d79SJon Loeliger CONFIG_BOOTP_GATEWAY 19531fe80d79SJon Loeliger CONFIG_BOOTP_HOSTNAME 19541fe80d79SJon Loeliger CONFIG_BOOTP_NISDOMAIN 19551fe80d79SJon Loeliger CONFIG_BOOTP_BOOTPATH 19561fe80d79SJon Loeliger CONFIG_BOOTP_BOOTFILESIZE 19571fe80d79SJon Loeliger CONFIG_BOOTP_DNS 19581fe80d79SJon Loeliger CONFIG_BOOTP_DNS2 19591fe80d79SJon Loeliger CONFIG_BOOTP_SEND_HOSTNAME 19601fe80d79SJon Loeliger CONFIG_BOOTP_NTPSERVER 19611fe80d79SJon Loeliger CONFIG_BOOTP_TIMEOFFSET 19621fe80d79SJon Loeliger CONFIG_BOOTP_VENDOREX 19632c00e099SJoe Hershberger CONFIG_BOOTP_MAY_FAIL 1964fe389a82Sstroese 19655d110f0aSWilson Callan CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip 19665d110f0aSWilson Callan environment variable, not the BOOTP server. 1967fe389a82Sstroese 19682c00e099SJoe Hershberger CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found 19692c00e099SJoe Hershberger after the configured retry count, the call will fail 19702c00e099SJoe Hershberger instead of starting over. This can be used to fail over 19712c00e099SJoe Hershberger to Link-local IP address configuration if the DHCP server 19722c00e099SJoe Hershberger is not available. 19732c00e099SJoe Hershberger 1974fe389a82Sstroese CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS 1975fe389a82Sstroese serverip from a DHCP server, it is possible that more 1976fe389a82Sstroese than one DNS serverip is offered to the client. 1977fe389a82Sstroese If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS 1978fe389a82Sstroese serverip will be stored in the additional environment 1979fe389a82Sstroese variable "dnsip2". The first DNS serverip is always 1980fe389a82Sstroese stored in the variable "dnsip", when CONFIG_BOOTP_DNS 19811fe80d79SJon Loeliger is defined. 1982fe389a82Sstroese 1983fe389a82Sstroese CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable 1984fe389a82Sstroese to do a dynamic update of a DNS server. To do this, they 1985fe389a82Sstroese need the hostname of the DHCP requester. 19865d110f0aSWilson Callan If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content 19871fe80d79SJon Loeliger of the "hostname" environment variable is passed as 19881fe80d79SJon Loeliger option 12 to the DHCP server. 1989fe389a82Sstroese 1990d9a2f416SAras Vaichas CONFIG_BOOTP_DHCP_REQUEST_DELAY 1991d9a2f416SAras Vaichas 1992d9a2f416SAras Vaichas A 32bit value in microseconds for a delay between 1993d9a2f416SAras Vaichas receiving a "DHCP Offer" and sending the "DHCP Request". 1994d9a2f416SAras Vaichas This fixes a problem with certain DHCP servers that don't 1995d9a2f416SAras Vaichas respond 100% of the time to a "DHCP request". E.g. On an 1996d9a2f416SAras Vaichas AT91RM9200 processor running at 180MHz, this delay needed 1997d9a2f416SAras Vaichas to be *at least* 15,000 usec before a Windows Server 2003 1998d9a2f416SAras Vaichas DHCP server would reply 100% of the time. I recommend at 1999d9a2f416SAras Vaichas least 50,000 usec to be safe. The alternative is to hope 2000d9a2f416SAras Vaichas that one of the retries will be successful but note that 2001d9a2f416SAras Vaichas the DHCP timeout and retry process takes a longer than 2002d9a2f416SAras Vaichas this delay. 2003d9a2f416SAras Vaichas 2004d22c338eSJoe Hershberger - Link-local IP address negotiation: 2005d22c338eSJoe Hershberger Negotiate with other link-local clients on the local network 2006d22c338eSJoe Hershberger for an address that doesn't require explicit configuration. 2007d22c338eSJoe Hershberger This is especially useful if a DHCP server cannot be guaranteed 2008d22c338eSJoe Hershberger to exist in all environments that the device must operate. 2009d22c338eSJoe Hershberger 2010d22c338eSJoe Hershberger See doc/README.link-local for more information. 2011d22c338eSJoe Hershberger 2012a3d991bdSwdenk - CDP Options: 2013a3d991bdSwdenk CONFIG_CDP_DEVICE_ID 2014a3d991bdSwdenk 2015a3d991bdSwdenk The device id used in CDP trigger frames. 2016a3d991bdSwdenk 2017a3d991bdSwdenk CONFIG_CDP_DEVICE_ID_PREFIX 2018a3d991bdSwdenk 2019a3d991bdSwdenk A two character string which is prefixed to the MAC address 2020a3d991bdSwdenk of the device. 2021a3d991bdSwdenk 2022a3d991bdSwdenk CONFIG_CDP_PORT_ID 2023a3d991bdSwdenk 2024a3d991bdSwdenk A printf format string which contains the ascii name of 2025a3d991bdSwdenk the port. Normally is set to "eth%d" which sets 202611ccc33fSMarcel Ziswiler eth0 for the first Ethernet, eth1 for the second etc. 2027a3d991bdSwdenk 2028a3d991bdSwdenk CONFIG_CDP_CAPABILITIES 2029a3d991bdSwdenk 2030a3d991bdSwdenk A 32bit integer which indicates the device capabilities; 2031a3d991bdSwdenk 0x00000010 for a normal host which does not forwards. 2032a3d991bdSwdenk 2033a3d991bdSwdenk CONFIG_CDP_VERSION 2034a3d991bdSwdenk 2035a3d991bdSwdenk An ascii string containing the version of the software. 2036a3d991bdSwdenk 2037a3d991bdSwdenk CONFIG_CDP_PLATFORM 2038a3d991bdSwdenk 2039a3d991bdSwdenk An ascii string containing the name of the platform. 2040a3d991bdSwdenk 2041a3d991bdSwdenk CONFIG_CDP_TRIGGER 2042a3d991bdSwdenk 2043a3d991bdSwdenk A 32bit integer sent on the trigger. 2044a3d991bdSwdenk 2045a3d991bdSwdenk CONFIG_CDP_POWER_CONSUMPTION 2046a3d991bdSwdenk 2047a3d991bdSwdenk A 16bit integer containing the power consumption of the 2048a3d991bdSwdenk device in .1 of milliwatts. 2049a3d991bdSwdenk 2050a3d991bdSwdenk CONFIG_CDP_APPLIANCE_VLAN_TYPE 2051a3d991bdSwdenk 2052a3d991bdSwdenk A byte containing the id of the VLAN. 2053a3d991bdSwdenk 2054c609719bSwdenk- Status LED: CONFIG_STATUS_LED 2055c609719bSwdenk 2056c609719bSwdenk Several configurations allow to display the current 2057c609719bSwdenk status using a LED. For instance, the LED will blink 2058c609719bSwdenk fast while running U-Boot code, stop blinking as 2059c609719bSwdenk soon as a reply to a BOOTP request was received, and 2060c609719bSwdenk start blinking slow once the Linux kernel is running 2061c609719bSwdenk (supported by a status LED driver in the Linux 2062c609719bSwdenk kernel). Defining CONFIG_STATUS_LED enables this 2063c609719bSwdenk feature in U-Boot. 2064c609719bSwdenk 20651df7bbbaSIgor Grinberg Additional options: 20661df7bbbaSIgor Grinberg 20671df7bbbaSIgor Grinberg CONFIG_GPIO_LED 20681df7bbbaSIgor Grinberg The status LED can be connected to a GPIO pin. 20691df7bbbaSIgor Grinberg In such cases, the gpio_led driver can be used as a 20701df7bbbaSIgor Grinberg status LED backend implementation. Define CONFIG_GPIO_LED 20711df7bbbaSIgor Grinberg to include the gpio_led driver in the U-Boot binary. 20721df7bbbaSIgor Grinberg 20739dfdcdfeSIgor Grinberg CONFIG_GPIO_LED_INVERTED_TABLE 20749dfdcdfeSIgor Grinberg Some GPIO connected LEDs may have inverted polarity in which 20759dfdcdfeSIgor Grinberg case the GPIO high value corresponds to LED off state and 20769dfdcdfeSIgor Grinberg GPIO low value corresponds to LED on state. 20779dfdcdfeSIgor Grinberg In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined 20789dfdcdfeSIgor Grinberg with a list of GPIO LEDs that have inverted polarity. 20799dfdcdfeSIgor Grinberg 2080c609719bSwdenk- CAN Support: CONFIG_CAN_DRIVER 2081c609719bSwdenk 2082c609719bSwdenk Defining CONFIG_CAN_DRIVER enables CAN driver support 2083c609719bSwdenk on those systems that support this (optional) 2084c609719bSwdenk feature, like the TQM8xxL modules. 2085c609719bSwdenk 20863f4978c7SHeiko Schocher- I2C Support: CONFIG_SYS_I2C 2087c609719bSwdenk 20883f4978c7SHeiko Schocher This enable the NEW i2c subsystem, and will allow you to use 20893f4978c7SHeiko Schocher i2c commands at the u-boot command line (as long as you set 20903f4978c7SHeiko Schocher CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c 20913f4978c7SHeiko Schocher based realtime clock chips or other i2c devices. See 20923f4978c7SHeiko Schocher common/cmd_i2c.c for a description of the command line 20933f4978c7SHeiko Schocher interface. 20943f4978c7SHeiko Schocher 20953f4978c7SHeiko Schocher ported i2c driver to the new framework: 2096ea818dbbSHeiko Schocher - drivers/i2c/soft_i2c.c: 2097ea818dbbSHeiko Schocher - activate first bus with CONFIG_SYS_I2C_SOFT define 2098ea818dbbSHeiko Schocher CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE 2099ea818dbbSHeiko Schocher for defining speed and slave address 2100ea818dbbSHeiko Schocher - activate second bus with I2C_SOFT_DECLARATIONS2 define 2101ea818dbbSHeiko Schocher CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2 2102ea818dbbSHeiko Schocher for defining speed and slave address 2103ea818dbbSHeiko Schocher - activate third bus with I2C_SOFT_DECLARATIONS3 define 2104ea818dbbSHeiko Schocher CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3 2105ea818dbbSHeiko Schocher for defining speed and slave address 2106ea818dbbSHeiko Schocher - activate fourth bus with I2C_SOFT_DECLARATIONS4 define 2107ea818dbbSHeiko Schocher CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4 2108ea818dbbSHeiko Schocher for defining speed and slave address 21093f4978c7SHeiko Schocher 211000f792e0SHeiko Schocher - drivers/i2c/fsl_i2c.c: 211100f792e0SHeiko Schocher - activate i2c driver with CONFIG_SYS_I2C_FSL 211200f792e0SHeiko Schocher define CONFIG_SYS_FSL_I2C_OFFSET for setting the register 211300f792e0SHeiko Schocher offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and 211400f792e0SHeiko Schocher CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first 211500f792e0SHeiko Schocher bus. 211600f792e0SHeiko Schocher - If your board supports a second fsl i2c bus, define 211700f792e0SHeiko Schocher CONFIG_SYS_FSL_I2C2_OFFSET for the register offset 211800f792e0SHeiko Schocher CONFIG_SYS_FSL_I2C2_SPEED for the speed and 211900f792e0SHeiko Schocher CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the 212000f792e0SHeiko Schocher second bus. 212100f792e0SHeiko Schocher 21221f2ba722SSimon Glass - drivers/i2c/tegra_i2c.c: 21231f2ba722SSimon Glass - activate this driver with CONFIG_SYS_I2C_TEGRA 21241f2ba722SSimon Glass - This driver adds 4 i2c buses with a fix speed from 21251f2ba722SSimon Glass 100000 and the slave addr 0! 21261f2ba722SSimon Glass 2127880540deSDirk Eibach - drivers/i2c/ppc4xx_i2c.c 2128880540deSDirk Eibach - activate this driver with CONFIG_SYS_I2C_PPC4XX 2129880540deSDirk Eibach - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0 2130880540deSDirk Eibach - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1 2131880540deSDirk Eibach 2132fac96408Strem - drivers/i2c/i2c_mxc.c 2133fac96408Strem - activate this driver with CONFIG_SYS_I2C_MXC 2134fac96408Strem - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED 2135fac96408Strem - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE 2136fac96408Strem - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED 2137fac96408Strem - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE 2138fac96408Strem - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED 2139fac96408Strem - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE 2140fac96408Strem If thoses defines are not set, default value is 100000 2141fac96408Strem for speed, and 0 for slave. 2142fac96408Strem 21431086bfa9SNobuhiro Iwamatsu - drivers/i2c/rcar_i2c.c: 21441086bfa9SNobuhiro Iwamatsu - activate this driver with CONFIG_SYS_I2C_RCAR 21451086bfa9SNobuhiro Iwamatsu - This driver adds 4 i2c buses 21461086bfa9SNobuhiro Iwamatsu 21471086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0 21481086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0 21491086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1 21501086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1 21511086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2 21521086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2 21531086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3 21541086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3 21551086bfa9SNobuhiro Iwamatsu - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses 21561086bfa9SNobuhiro Iwamatsu 21572035d77dSNobuhiro Iwamatsu - drivers/i2c/sh_i2c.c: 21582035d77dSNobuhiro Iwamatsu - activate this driver with CONFIG_SYS_I2C_SH 21592035d77dSNobuhiro Iwamatsu - This driver adds from 2 to 5 i2c buses 21602035d77dSNobuhiro Iwamatsu 21612035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0 21622035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0 21632035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1 21642035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1 21652035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2 21662035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2 21672035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3 21682035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3 21692035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4 21702035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4 21712035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5 21722035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5 21732035d77dSNobuhiro Iwamatsu - CONFIF_SYS_I2C_SH_NUM_CONTROLLERS for nummber of i2c buses 21742035d77dSNobuhiro Iwamatsu 21756789e84eSHeiko Schocher - drivers/i2c/omap24xx_i2c.c 21766789e84eSHeiko Schocher - activate this driver with CONFIG_SYS_I2C_OMAP24XX 21776789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0 21786789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0 21796789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1 21806789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1 21816789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2 21826789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2 21836789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3 21846789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3 21856789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4 21866789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4 21876789e84eSHeiko Schocher 21880bdffe71SHeiko Schocher - drivers/i2c/zynq_i2c.c 21890bdffe71SHeiko Schocher - activate this driver with CONFIG_SYS_I2C_ZYNQ 21900bdffe71SHeiko Schocher - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting 21910bdffe71SHeiko Schocher - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr 21920bdffe71SHeiko Schocher 2193e717fc6dSNaveen Krishna Ch - drivers/i2c/s3c24x0_i2c.c: 2194e717fc6dSNaveen Krishna Ch - activate this driver with CONFIG_SYS_I2C_S3C24X0 2195e717fc6dSNaveen Krishna Ch - This driver adds i2c buses (11 for Exynos5250, Exynos5420 2196e717fc6dSNaveen Krishna Ch 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung) 2197e717fc6dSNaveen Krishna Ch with a fix speed from 100000 and the slave addr 0! 2198e717fc6dSNaveen Krishna Ch 21993f4978c7SHeiko Schocher additional defines: 22003f4978c7SHeiko Schocher 22013f4978c7SHeiko Schocher CONFIG_SYS_NUM_I2C_BUSES 22023f4978c7SHeiko Schocher Hold the number of i2c busses you want to use. If you 22033f4978c7SHeiko Schocher don't use/have i2c muxes on your i2c bus, this 22043f4978c7SHeiko Schocher is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can 22053f4978c7SHeiko Schocher omit this define. 22063f4978c7SHeiko Schocher 22073f4978c7SHeiko Schocher CONFIG_SYS_I2C_DIRECT_BUS 22083f4978c7SHeiko Schocher define this, if you don't use i2c muxes on your hardware. 22093f4978c7SHeiko Schocher if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can 22103f4978c7SHeiko Schocher omit this define. 22113f4978c7SHeiko Schocher 22123f4978c7SHeiko Schocher CONFIG_SYS_I2C_MAX_HOPS 22133f4978c7SHeiko Schocher define how many muxes are maximal consecutively connected 22143f4978c7SHeiko Schocher on one i2c bus. If you not use i2c muxes, omit this 22153f4978c7SHeiko Schocher define. 22163f4978c7SHeiko Schocher 22173f4978c7SHeiko Schocher CONFIG_SYS_I2C_BUSES 22183f4978c7SHeiko Schocher hold a list of busses you want to use, only used if 22193f4978c7SHeiko Schocher CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example 22203f4978c7SHeiko Schocher a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and 22213f4978c7SHeiko Schocher CONFIG_SYS_NUM_I2C_BUSES = 9: 22223f4978c7SHeiko Schocher 22233f4978c7SHeiko Schocher CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \ 22243f4978c7SHeiko Schocher {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \ 22253f4978c7SHeiko Schocher {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \ 22263f4978c7SHeiko Schocher {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \ 22273f4978c7SHeiko Schocher {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \ 22283f4978c7SHeiko Schocher {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \ 22293f4978c7SHeiko Schocher {1, {I2C_NULL_HOP}}, \ 22303f4978c7SHeiko Schocher {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \ 22313f4978c7SHeiko Schocher {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \ 22323f4978c7SHeiko Schocher } 22333f4978c7SHeiko Schocher 22343f4978c7SHeiko Schocher which defines 22353f4978c7SHeiko Schocher bus 0 on adapter 0 without a mux 2236ea818dbbSHeiko Schocher bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1 2237ea818dbbSHeiko Schocher bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2 2238ea818dbbSHeiko Schocher bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3 2239ea818dbbSHeiko Schocher bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4 2240ea818dbbSHeiko Schocher bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5 22413f4978c7SHeiko Schocher bus 6 on adapter 1 without a mux 2242ea818dbbSHeiko Schocher bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1 2243ea818dbbSHeiko Schocher bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2 22443f4978c7SHeiko Schocher 22453f4978c7SHeiko Schocher If you do not have i2c muxes on your board, omit this define. 22463f4978c7SHeiko Schocher 2247ea818dbbSHeiko Schocher- Legacy I2C Support: CONFIG_HARD_I2C 22483f4978c7SHeiko Schocher 22493f4978c7SHeiko Schocher NOTE: It is intended to move drivers to CONFIG_SYS_I2C which 22503f4978c7SHeiko Schocher provides the following compelling advantages: 22513f4978c7SHeiko Schocher 22523f4978c7SHeiko Schocher - more than one i2c adapter is usable 22533f4978c7SHeiko Schocher - approved multibus support 22543f4978c7SHeiko Schocher - better i2c mux support 22553f4978c7SHeiko Schocher 22563f4978c7SHeiko Schocher ** Please consider updating your I2C driver now. ** 22573f4978c7SHeiko Schocher 2258ea818dbbSHeiko Schocher These enable legacy I2C serial bus commands. Defining 2259ea818dbbSHeiko Schocher CONFIG_HARD_I2C will include the appropriate I2C driver 2260ea818dbbSHeiko Schocher for the selected CPU. 2261c609719bSwdenk 2262b37c7e5eSwdenk This will allow you to use i2c commands at the u-boot 2263602ad3b3SJon Loeliger command line (as long as you set CONFIG_CMD_I2C in 2264b37c7e5eSwdenk CONFIG_COMMANDS) and communicate with i2c based realtime 2265b37c7e5eSwdenk clock chips. See common/cmd_i2c.c for a description of the 2266c609719bSwdenk command line interface. 2267c609719bSwdenk 2268bb99ad6dSBen Warren CONFIG_HARD_I2C selects a hardware I2C controller. 2269c609719bSwdenk 2270b37c7e5eSwdenk There are several other quantities that must also be 2271ea818dbbSHeiko Schocher defined when you define CONFIG_HARD_I2C. 2272c609719bSwdenk 22736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD In both cases you will need to define CONFIG_SYS_I2C_SPEED 2274b37c7e5eSwdenk to be the frequency (in Hz) at which you wish your i2c bus 22756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie 227611ccc33fSMarcel Ziswiler the CPU's i2c node address). 2277c609719bSwdenk 22788d321b81SPeter Tyser Now, the u-boot i2c code for the mpc8xx 2279a47a12beSStefan Roese (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node 22808d321b81SPeter Tyser and so its address should therefore be cleared to 0 (See, 22818d321b81SPeter Tyser eg, MPC823e User's Manual p.16-473). So, set 22828d321b81SPeter Tyser CONFIG_SYS_I2C_SLAVE to 0. 2283b37c7e5eSwdenk 22845da71efaSEric Millbrandt CONFIG_SYS_I2C_INIT_MPC5XXX 22855da71efaSEric Millbrandt 22865da71efaSEric Millbrandt When a board is reset during an i2c bus transfer 22875da71efaSEric Millbrandt chips might think that the current transfer is still 22885da71efaSEric Millbrandt in progress. Reset the slave devices by sending start 22895da71efaSEric Millbrandt commands until the slave device responds. 22905da71efaSEric Millbrandt 2291b37c7e5eSwdenk That's all that's required for CONFIG_HARD_I2C. 2292b37c7e5eSwdenk 2293ea818dbbSHeiko Schocher If you use the software i2c interface (CONFIG_SYS_I2C_SOFT) 2294b37c7e5eSwdenk then the following macros need to be defined (examples are 2295b37c7e5eSwdenk from include/configs/lwmon.h): 2296c609719bSwdenk 2297c609719bSwdenk I2C_INIT 2298c609719bSwdenk 2299b37c7e5eSwdenk (Optional). Any commands necessary to enable the I2C 2300c609719bSwdenk controller or configure ports. 2301c609719bSwdenk 2302b37c7e5eSwdenk eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL) 2303b37c7e5eSwdenk 2304c609719bSwdenk I2C_PORT 2305c609719bSwdenk 2306c609719bSwdenk (Only for MPC8260 CPU). The I/O port to use (the code 2307c609719bSwdenk assumes both bits are on the same port). Valid values 2308c609719bSwdenk are 0..3 for ports A..D. 2309c609719bSwdenk 2310c609719bSwdenk I2C_ACTIVE 2311c609719bSwdenk 2312c609719bSwdenk The code necessary to make the I2C data line active 2313c609719bSwdenk (driven). If the data line is open collector, this 2314c609719bSwdenk define can be null. 2315c609719bSwdenk 2316b37c7e5eSwdenk eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA) 2317b37c7e5eSwdenk 2318c609719bSwdenk I2C_TRISTATE 2319c609719bSwdenk 2320c609719bSwdenk The code necessary to make the I2C data line tri-stated 2321c609719bSwdenk (inactive). If the data line is open collector, this 2322c609719bSwdenk define can be null. 2323c609719bSwdenk 2324b37c7e5eSwdenk eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA) 2325b37c7e5eSwdenk 2326c609719bSwdenk I2C_READ 2327c609719bSwdenk 2328472d5460SYork Sun Code that returns true if the I2C data line is high, 2329472d5460SYork Sun false if it is low. 2330c609719bSwdenk 2331b37c7e5eSwdenk eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0) 2332b37c7e5eSwdenk 2333c609719bSwdenk I2C_SDA(bit) 2334c609719bSwdenk 2335472d5460SYork Sun If <bit> is true, sets the I2C data line high. If it 2336472d5460SYork Sun is false, it clears it (low). 2337c609719bSwdenk 2338b37c7e5eSwdenk eg: #define I2C_SDA(bit) \ 2339b37c7e5eSwdenk if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \ 2340b37c7e5eSwdenk else immr->im_cpm.cp_pbdat &= ~PB_SDA 2341b37c7e5eSwdenk 2342c609719bSwdenk I2C_SCL(bit) 2343c609719bSwdenk 2344472d5460SYork Sun If <bit> is true, sets the I2C clock line high. If it 2345472d5460SYork Sun is false, it clears it (low). 2346c609719bSwdenk 2347b37c7e5eSwdenk eg: #define I2C_SCL(bit) \ 2348b37c7e5eSwdenk if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \ 2349b37c7e5eSwdenk else immr->im_cpm.cp_pbdat &= ~PB_SCL 2350b37c7e5eSwdenk 2351c609719bSwdenk I2C_DELAY 2352c609719bSwdenk 2353c609719bSwdenk This delay is invoked four times per clock cycle so this 2354c609719bSwdenk controls the rate of data transfer. The data rate thus 2355b37c7e5eSwdenk is 1 / (I2C_DELAY * 4). Often defined to be something 2356b37c7e5eSwdenk like: 2357b37c7e5eSwdenk 2358b37c7e5eSwdenk #define I2C_DELAY udelay(2) 2359c609719bSwdenk 2360793b5726SMike Frysinger CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA 2361793b5726SMike Frysinger 2362793b5726SMike Frysinger If your arch supports the generic GPIO framework (asm/gpio.h), 2363793b5726SMike Frysinger then you may alternatively define the two GPIOs that are to be 2364793b5726SMike Frysinger used as SCL / SDA. Any of the previous I2C_xxx macros will 2365793b5726SMike Frysinger have GPIO-based defaults assigned to them as appropriate. 2366793b5726SMike Frysinger 2367793b5726SMike Frysinger You should define these to the GPIO value as given directly to 2368793b5726SMike Frysinger the generic GPIO functions. 2369793b5726SMike Frysinger 23706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_INIT_BOARD 237147cd00faSwdenk 237247cd00faSwdenk When a board is reset during an i2c bus transfer 237347cd00faSwdenk chips might think that the current transfer is still 237447cd00faSwdenk in progress. On some boards it is possible to access 237547cd00faSwdenk the i2c SCLK line directly, either by using the 237647cd00faSwdenk processor pin as a GPIO or by having a second pin 237747cd00faSwdenk connected to the bus. If this option is defined a 237847cd00faSwdenk custom i2c_init_board() routine in boards/xxx/board.c 237947cd00faSwdenk is run early in the boot sequence. 238047cd00faSwdenk 238126a33504SRichard Retanubun CONFIG_SYS_I2C_BOARD_LATE_INIT 238226a33504SRichard Retanubun 238326a33504SRichard Retanubun An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is 238426a33504SRichard Retanubun defined a custom i2c_board_late_init() routine in 238526a33504SRichard Retanubun boards/xxx/board.c is run AFTER the operations in i2c_init() 238626a33504SRichard Retanubun is completed. This callpoint can be used to unreset i2c bus 238726a33504SRichard Retanubun using CPU i2c controller register accesses for CPUs whose i2c 238826a33504SRichard Retanubun controller provide such a method. It is called at the end of 238926a33504SRichard Retanubun i2c_init() to allow i2c_init operations to setup the i2c bus 239026a33504SRichard Retanubun controller on the CPU (e.g. setting bus speed & slave address). 239126a33504SRichard Retanubun 239217ea1177Swdenk CONFIG_I2CFAST (PPC405GP|PPC405EP only) 239317ea1177Swdenk 239417ea1177Swdenk This option enables configuration of bi_iic_fast[] flags 239517ea1177Swdenk in u-boot bd_info structure based on u-boot environment 239617ea1177Swdenk variable "i2cfast". (see also i2cfast) 239717ea1177Swdenk 2398bb99ad6dSBen Warren CONFIG_I2C_MULTI_BUS 2399bb99ad6dSBen Warren 2400bb99ad6dSBen Warren This option allows the use of multiple I2C buses, each of which 2401bb99ad6dSBen Warren must have a controller. At any point in time, only one bus is 2402bb99ad6dSBen Warren active. To switch to a different bus, use the 'i2c dev' command. 2403bb99ad6dSBen Warren Note that bus numbering is zero-based. 2404bb99ad6dSBen Warren 24056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_NOPROBES 2406bb99ad6dSBen Warren 2407bb99ad6dSBen Warren This option specifies a list of I2C devices that will be skipped 24080f89c54bSPeter Tyser when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS 24090f89c54bSPeter Tyser is set, specify a list of bus-device pairs. Otherwise, specify 24100f89c54bSPeter Tyser a 1D array of device addresses 2411bb99ad6dSBen Warren 2412bb99ad6dSBen Warren e.g. 2413bb99ad6dSBen Warren #undef CONFIG_I2C_MULTI_BUS 24146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68} 2415bb99ad6dSBen Warren 2416bb99ad6dSBen Warren will skip addresses 0x50 and 0x68 on a board with one I2C bus 2417bb99ad6dSBen Warren 2418bb99ad6dSBen Warren #define CONFIG_I2C_MULTI_BUS 24196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}} 2420bb99ad6dSBen Warren 2421bb99ad6dSBen Warren will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1 2422bb99ad6dSBen Warren 24236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SPD_BUS_NUM 2424be5e6181STimur Tabi 2425be5e6181STimur Tabi If defined, then this indicates the I2C bus number for DDR SPD. 2426be5e6181STimur Tabi If not defined, then U-Boot assumes that SPD is on I2C bus 0. 2427be5e6181STimur Tabi 24286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_RTC_BUS_NUM 24290dc018ecSStefan Roese 24300dc018ecSStefan Roese If defined, then this indicates the I2C bus number for the RTC. 24310dc018ecSStefan Roese If not defined, then U-Boot assumes that RTC is on I2C bus 0. 24320dc018ecSStefan Roese 24336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_DTT_BUS_NUM 24340dc018ecSStefan Roese 24350dc018ecSStefan Roese If defined, then this indicates the I2C bus number for the DTT. 24360dc018ecSStefan Roese If not defined, then U-Boot assumes that DTT is on I2C bus 0. 24370dc018ecSStefan Roese 24386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_DTT_ADDR: 24399ebbb54fSVictor Gallardo 24409ebbb54fSVictor Gallardo If defined, specifies the I2C address of the DTT device. 24419ebbb54fSVictor Gallardo If not defined, then U-Boot uses predefined value for 24429ebbb54fSVictor Gallardo specified DTT device. 24439ebbb54fSVictor Gallardo 24442ac6985aSAndrew Dyer CONFIG_SOFT_I2C_READ_REPEATED_START 24452ac6985aSAndrew Dyer 24462ac6985aSAndrew Dyer defining this will force the i2c_read() function in 24472ac6985aSAndrew Dyer the soft_i2c driver to perform an I2C repeated start 24482ac6985aSAndrew Dyer between writing the address pointer and reading the 24492ac6985aSAndrew Dyer data. If this define is omitted the default behaviour 24502ac6985aSAndrew Dyer of doing a stop-start sequence will be used. Most I2C 24512ac6985aSAndrew Dyer devices can use either method, but some require one or 24522ac6985aSAndrew Dyer the other. 2453be5e6181STimur Tabi 2454c609719bSwdenk- SPI Support: CONFIG_SPI 2455c609719bSwdenk 2456c609719bSwdenk Enables SPI driver (so far only tested with 2457c609719bSwdenk SPI EEPROM, also an instance works with Crystal A/D and 2458c609719bSwdenk D/As on the SACSng board) 2459c609719bSwdenk 24606639562eSYoshihiro Shimoda CONFIG_SH_SPI 24616639562eSYoshihiro Shimoda 24626639562eSYoshihiro Shimoda Enables the driver for SPI controller on SuperH. Currently 24636639562eSYoshihiro Shimoda only SH7757 is supported. 24646639562eSYoshihiro Shimoda 2465c609719bSwdenk CONFIG_SPI_X 2466c609719bSwdenk 2467c609719bSwdenk Enables extended (16-bit) SPI EEPROM addressing. 2468c609719bSwdenk (symmetrical to CONFIG_I2C_X) 2469c609719bSwdenk 2470c609719bSwdenk CONFIG_SOFT_SPI 2471c609719bSwdenk 2472c609719bSwdenk Enables a software (bit-bang) SPI driver rather than 2473c609719bSwdenk using hardware support. This is a general purpose 2474c609719bSwdenk driver that only requires three general I/O port pins 2475c609719bSwdenk (two outputs, one input) to function. If this is 2476c609719bSwdenk defined, the board configuration must define several 2477c609719bSwdenk SPI configuration items (port pins to use, etc). For 2478c609719bSwdenk an example, see include/configs/sacsng.h. 2479c609719bSwdenk 248004a9e118SBen Warren CONFIG_HARD_SPI 248104a9e118SBen Warren 248204a9e118SBen Warren Enables a hardware SPI driver for general-purpose reads 248304a9e118SBen Warren and writes. As with CONFIG_SOFT_SPI, the board configuration 248404a9e118SBen Warren must define a list of chip-select function pointers. 248504a9e118SBen Warren Currently supported on some MPC8xxx processors. For an 248604a9e118SBen Warren example, see include/configs/mpc8349emds.h. 248704a9e118SBen Warren 248838254f45SGuennadi Liakhovetski CONFIG_MXC_SPI 248938254f45SGuennadi Liakhovetski 249038254f45SGuennadi Liakhovetski Enables the driver for the SPI controllers on i.MX and MXC 24912e3cd1cdSFabio Estevam SoCs. Currently i.MX31/35/51 are supported. 249238254f45SGuennadi Liakhovetski 24930133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA 24940133502eSMatthias Fuchs 24950133502eSMatthias Fuchs Enables FPGA subsystem. 24960133502eSMatthias Fuchs 24970133502eSMatthias Fuchs CONFIG_FPGA_<vendor> 24980133502eSMatthias Fuchs 24990133502eSMatthias Fuchs Enables support for specific chip vendors. 25000133502eSMatthias Fuchs (ALTERA, XILINX) 25010133502eSMatthias Fuchs 25020133502eSMatthias Fuchs CONFIG_FPGA_<family> 25030133502eSMatthias Fuchs 25040133502eSMatthias Fuchs Enables support for FPGA family. 25050133502eSMatthias Fuchs (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX) 25060133502eSMatthias Fuchs 25070133502eSMatthias Fuchs CONFIG_FPGA_COUNT 2508c609719bSwdenk 2509c609719bSwdenk Specify the number of FPGA devices to support. 2510c609719bSwdenk 25116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_PROG_FEEDBACK 2512c609719bSwdenk 2513c609719bSwdenk Enable printing of hash marks during FPGA configuration. 2514c609719bSwdenk 25156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_BUSY 2516c609719bSwdenk 2517c609719bSwdenk Enable checks on FPGA configuration interface busy 2518c609719bSwdenk status by the configuration function. This option 2519c609719bSwdenk will require a board or device specific function to 2520c609719bSwdenk be written. 2521c609719bSwdenk 2522c609719bSwdenk CONFIG_FPGA_DELAY 2523c609719bSwdenk 2524c609719bSwdenk If defined, a function that provides delays in the FPGA 2525c609719bSwdenk configuration driver. 2526c609719bSwdenk 25276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_CTRLC 2528c609719bSwdenk Allow Control-C to interrupt FPGA configuration 2529c609719bSwdenk 25306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_ERROR 2531c609719bSwdenk 2532c609719bSwdenk Check for configuration errors during FPGA bitfile 2533c609719bSwdenk loading. For example, abort during Virtex II 2534c609719bSwdenk configuration if the INIT_B line goes low (which 2535c609719bSwdenk indicated a CRC error). 2536c609719bSwdenk 25376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_INIT 2538c609719bSwdenk 2539c609719bSwdenk Maximum time to wait for the INIT_B line to deassert 2540c609719bSwdenk after PROB_B has been deasserted during a Virtex II 2541c609719bSwdenk FPGA configuration sequence. The default time is 500 254211ccc33fSMarcel Ziswiler ms. 2543c609719bSwdenk 25446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_BUSY 2545c609719bSwdenk 2546c609719bSwdenk Maximum time to wait for BUSY to deassert during 254711ccc33fSMarcel Ziswiler Virtex II FPGA configuration. The default is 5 ms. 2548c609719bSwdenk 25496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_CONFIG 2550c609719bSwdenk 2551c609719bSwdenk Time to wait after FPGA configuration. The default is 255211ccc33fSMarcel Ziswiler 200 ms. 2553c609719bSwdenk 2554c609719bSwdenk- Configuration Management: 2555c609719bSwdenk CONFIG_IDENT_STRING 2556c609719bSwdenk 2557c609719bSwdenk If defined, this string will be added to the U-Boot 2558c609719bSwdenk version information (U_BOOT_VERSION) 2559c609719bSwdenk 2560c609719bSwdenk- Vendor Parameter Protection: 2561c609719bSwdenk 2562c609719bSwdenk U-Boot considers the values of the environment 2563c609719bSwdenk variables "serial#" (Board Serial Number) and 25647152b1d0Swdenk "ethaddr" (Ethernet Address) to be parameters that 2565c609719bSwdenk are set once by the board vendor / manufacturer, and 2566c609719bSwdenk protects these variables from casual modification by 2567c609719bSwdenk the user. Once set, these variables are read-only, 2568c609719bSwdenk and write or delete attempts are rejected. You can 256911ccc33fSMarcel Ziswiler change this behaviour: 2570c609719bSwdenk 2571c609719bSwdenk If CONFIG_ENV_OVERWRITE is #defined in your config 2572c609719bSwdenk file, the write protection for vendor parameters is 257347cd00faSwdenk completely disabled. Anybody can change or delete 2574c609719bSwdenk these parameters. 2575c609719bSwdenk 2576c609719bSwdenk Alternatively, if you #define _both_ CONFIG_ETHADDR 2577c609719bSwdenk _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default 257811ccc33fSMarcel Ziswiler Ethernet address is installed in the environment, 2579c609719bSwdenk which can be changed exactly ONCE by the user. [The 2580c609719bSwdenk serial# is unaffected by this, i. e. it remains 2581c609719bSwdenk read-only.] 2582c609719bSwdenk 25832598090bSJoe Hershberger The same can be accomplished in a more flexible way 25842598090bSJoe Hershberger for any variable by configuring the type of access 25852598090bSJoe Hershberger to allow for those variables in the ".flags" variable 25862598090bSJoe Hershberger or define CONFIG_ENV_FLAGS_LIST_STATIC. 25872598090bSJoe Hershberger 2588c609719bSwdenk- Protected RAM: 2589c609719bSwdenk CONFIG_PRAM 2590c609719bSwdenk 2591c609719bSwdenk Define this variable to enable the reservation of 2592c609719bSwdenk "protected RAM", i. e. RAM which is not overwritten 2593c609719bSwdenk by U-Boot. Define CONFIG_PRAM to hold the number of 2594c609719bSwdenk kB you want to reserve for pRAM. You can overwrite 2595c609719bSwdenk this default value by defining an environment 2596c609719bSwdenk variable "pram" to the number of kB you want to 2597c609719bSwdenk reserve. Note that the board info structure will 2598c609719bSwdenk still show the full amount of RAM. If pRAM is 2599c609719bSwdenk reserved, a new environment variable "mem" will 2600c609719bSwdenk automatically be defined to hold the amount of 2601c609719bSwdenk remaining RAM in a form that can be passed as boot 2602c609719bSwdenk argument to Linux, for instance like that: 2603c609719bSwdenk 2604fe126d8bSWolfgang Denk setenv bootargs ... mem=\${mem} 2605c609719bSwdenk saveenv 2606c609719bSwdenk 2607c609719bSwdenk This way you can tell Linux not to use this memory, 2608c609719bSwdenk either, which results in a memory region that will 2609c609719bSwdenk not be affected by reboots. 2610c609719bSwdenk 2611c609719bSwdenk *WARNING* If your board configuration uses automatic 2612c609719bSwdenk detection of the RAM size, you must make sure that 2613c609719bSwdenk this memory test is non-destructive. So far, the 2614c609719bSwdenk following board configurations are known to be 2615c609719bSwdenk "pRAM-clean": 2616c609719bSwdenk 26171b0757ecSWolfgang Denk IVMS8, IVML24, SPD8xx, TQM8xxL, 26181b0757ecSWolfgang Denk HERMES, IP860, RPXlite, LWMON, 2619544d97e9SWolfgang Denk FLAGADM, TQM8260 2620c609719bSwdenk 262140fef049SGabe Black- Access to physical memory region (> 4GB) 262240fef049SGabe Black Some basic support is provided for operations on memory not 262340fef049SGabe Black normally accessible to U-Boot - e.g. some architectures 262440fef049SGabe Black support access to more than 4GB of memory on 32-bit 262540fef049SGabe Black machines using physical address extension or similar. 262640fef049SGabe Black Define CONFIG_PHYSMEM to access this basic support, which 262740fef049SGabe Black currently only supports clearing the memory. 262840fef049SGabe Black 2629c609719bSwdenk- Error Recovery: 2630c609719bSwdenk CONFIG_PANIC_HANG 2631c609719bSwdenk 2632c609719bSwdenk Define this variable to stop the system in case of a 2633c609719bSwdenk fatal error, so that you have to reset it manually. 2634c609719bSwdenk This is probably NOT a good idea for an embedded 263511ccc33fSMarcel Ziswiler system where you want the system to reboot 2636c609719bSwdenk automatically as fast as possible, but it may be 2637c609719bSwdenk useful during development since you can try to debug 2638c609719bSwdenk the conditions that lead to the situation. 2639c609719bSwdenk 2640c609719bSwdenk CONFIG_NET_RETRY_COUNT 2641c609719bSwdenk 2642c609719bSwdenk This variable defines the number of retries for 2643c609719bSwdenk network operations like ARP, RARP, TFTP, or BOOTP 2644c609719bSwdenk before giving up the operation. If not defined, a 2645c609719bSwdenk default value of 5 is used. 2646c609719bSwdenk 264740cb90eeSGuennadi Liakhovetski CONFIG_ARP_TIMEOUT 264840cb90eeSGuennadi Liakhovetski 264940cb90eeSGuennadi Liakhovetski Timeout waiting for an ARP reply in milliseconds. 265040cb90eeSGuennadi Liakhovetski 265148a3e999STetsuyuki Kobayashi CONFIG_NFS_TIMEOUT 265248a3e999STetsuyuki Kobayashi 265348a3e999STetsuyuki Kobayashi Timeout in milliseconds used in NFS protocol. 265448a3e999STetsuyuki Kobayashi If you encounter "ERROR: Cannot umount" in nfs command, 265548a3e999STetsuyuki Kobayashi try longer timeout such as 265648a3e999STetsuyuki Kobayashi #define CONFIG_NFS_TIMEOUT 10000UL 265748a3e999STetsuyuki Kobayashi 2658c609719bSwdenk- Command Interpreter: 26598078f1a5SWolfgang Denk CONFIG_AUTO_COMPLETE 266004a85b3bSwdenk 266104a85b3bSwdenk Enable auto completion of commands using TAB. 266204a85b3bSwdenk 26638078f1a5SWolfgang Denk Note that this feature has NOT been implemented yet 26648078f1a5SWolfgang Denk for the "hush" shell. 26658078f1a5SWolfgang Denk 26668078f1a5SWolfgang Denk 26676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_HUSH_PARSER 2668c609719bSwdenk 2669c609719bSwdenk Define this variable to enable the "hush" shell (from 2670c609719bSwdenk Busybox) as command line interpreter, thus enabling 2671c609719bSwdenk powerful command line syntax like 2672c609719bSwdenk if...then...else...fi conditionals or `&&' and '||' 2673c609719bSwdenk constructs ("shell scripts"). 2674c609719bSwdenk 2675c609719bSwdenk If undefined, you get the old, much simpler behaviour 2676c609719bSwdenk with a somewhat smaller memory footprint. 2677c609719bSwdenk 2678c609719bSwdenk 26796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PROMPT_HUSH_PS2 2680c609719bSwdenk 2681c609719bSwdenk This defines the secondary prompt string, which is 2682c609719bSwdenk printed when the command interpreter needs more input 2683c609719bSwdenk to complete a command. Usually "> ". 2684c609719bSwdenk 2685c609719bSwdenk Note: 2686c609719bSwdenk 2687c609719bSwdenk In the current implementation, the local variables 2688c609719bSwdenk space and global environment variables space are 2689c609719bSwdenk separated. Local variables are those you define by 26903b57fe0aSwdenk simply typing `name=value'. To access a local 2691c609719bSwdenk variable later on, you have write `$name' or 26923b57fe0aSwdenk `${name}'; to execute the contents of a variable 26933b57fe0aSwdenk directly type `$name' at the command prompt. 2694c609719bSwdenk 2695c609719bSwdenk Global environment variables are those you use 2696c609719bSwdenk setenv/printenv to work with. To run a command stored 2697c609719bSwdenk in such a variable, you need to use the run command, 2698c609719bSwdenk and you must not use the '$' sign to access them. 2699c609719bSwdenk 2700c609719bSwdenk To store commands and special characters in a 2701c609719bSwdenk variable, please use double quotation marks 2702c609719bSwdenk surrounding the whole text of the variable, instead 2703c609719bSwdenk of the backslashes before semicolons and special 2704c609719bSwdenk symbols. 2705c609719bSwdenk 2706aa0c71acSWolfgang Denk- Commandline Editing and History: 2707aa0c71acSWolfgang Denk CONFIG_CMDLINE_EDITING 2708aa0c71acSWolfgang Denk 270911ccc33fSMarcel Ziswiler Enable editing and History functions for interactive 2710aa0c71acSWolfgang Denk commandline input operations 2711aa0c71acSWolfgang Denk 2712a8c7c708Swdenk- Default Environment: 2713c609719bSwdenk CONFIG_EXTRA_ENV_SETTINGS 2714c609719bSwdenk 2715c609719bSwdenk Define this to contain any number of null terminated 2716c609719bSwdenk strings (variable = value pairs) that will be part of 27177152b1d0Swdenk the default environment compiled into the boot image. 27182262cfeeSwdenk 2719c609719bSwdenk For example, place something like this in your 2720c609719bSwdenk board's config file: 2721c609719bSwdenk 2722c609719bSwdenk #define CONFIG_EXTRA_ENV_SETTINGS \ 2723c609719bSwdenk "myvar1=value1\0" \ 2724c609719bSwdenk "myvar2=value2\0" 2725c609719bSwdenk 2726c609719bSwdenk Warning: This method is based on knowledge about the 2727c609719bSwdenk internal format how the environment is stored by the 27282262cfeeSwdenk U-Boot code. This is NOT an official, exported 2729c609719bSwdenk interface! Although it is unlikely that this format 27307152b1d0Swdenk will change soon, there is no guarantee either. 2731c609719bSwdenk You better know what you are doing here. 2732c609719bSwdenk 2733c609719bSwdenk Note: overly (ab)use of the default environment is 2734c609719bSwdenk discouraged. Make sure to check other ways to preset 273574de7aefSWolfgang Denk the environment like the "source" command or the 2736c609719bSwdenk boot command first. 2737c609719bSwdenk 27385e724ca2SStephen Warren CONFIG_ENV_VARS_UBOOT_CONFIG 27395e724ca2SStephen Warren 27405e724ca2SStephen Warren Define this in order to add variables describing the 27415e724ca2SStephen Warren U-Boot build configuration to the default environment. 27425e724ca2SStephen Warren These will be named arch, cpu, board, vendor, and soc. 27435e724ca2SStephen Warren 27445e724ca2SStephen Warren Enabling this option will cause the following to be defined: 27455e724ca2SStephen Warren 27465e724ca2SStephen Warren - CONFIG_SYS_ARCH 27475e724ca2SStephen Warren - CONFIG_SYS_CPU 27485e724ca2SStephen Warren - CONFIG_SYS_BOARD 27495e724ca2SStephen Warren - CONFIG_SYS_VENDOR 27505e724ca2SStephen Warren - CONFIG_SYS_SOC 27515e724ca2SStephen Warren 27527e27f89fSTom Rini CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG 27537e27f89fSTom Rini 27547e27f89fSTom Rini Define this in order to add variables describing certain 27557e27f89fSTom Rini run-time determined information about the hardware to the 27567e27f89fSTom Rini environment. These will be named board_name, board_rev. 27577e27f89fSTom Rini 275806fd8538SSimon Glass CONFIG_DELAY_ENVIRONMENT 275906fd8538SSimon Glass 276006fd8538SSimon Glass Normally the environment is loaded when the board is 276106fd8538SSimon Glass intialised so that it is available to U-Boot. This inhibits 276206fd8538SSimon Glass that so that the environment is not available until 276306fd8538SSimon Glass explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL 276406fd8538SSimon Glass this is instead controlled by the value of 276506fd8538SSimon Glass /config/load-environment. 276606fd8538SSimon Glass 2767a8c7c708Swdenk- DataFlash Support: 27682abbe075Swdenk CONFIG_HAS_DATAFLASH 27692abbe075Swdenk 27702abbe075Swdenk Defining this option enables DataFlash features and 27712abbe075Swdenk allows to read/write in Dataflash via the standard 27722abbe075Swdenk commands cp, md... 27732abbe075Swdenk 2774f61ec45eSEric Nelson- Serial Flash support 2775f61ec45eSEric Nelson CONFIG_CMD_SF 2776f61ec45eSEric Nelson 2777f61ec45eSEric Nelson Defining this option enables SPI flash commands 2778f61ec45eSEric Nelson 'sf probe/read/write/erase/update'. 2779f61ec45eSEric Nelson 2780f61ec45eSEric Nelson Usage requires an initial 'probe' to define the serial 2781f61ec45eSEric Nelson flash parameters, followed by read/write/erase/update 2782f61ec45eSEric Nelson commands. 2783f61ec45eSEric Nelson 2784f61ec45eSEric Nelson The following defaults may be provided by the platform 2785f61ec45eSEric Nelson to handle the common case when only a single serial 2786f61ec45eSEric Nelson flash is present on the system. 2787f61ec45eSEric Nelson 2788f61ec45eSEric Nelson CONFIG_SF_DEFAULT_BUS Bus identifier 2789f61ec45eSEric Nelson CONFIG_SF_DEFAULT_CS Chip-select 2790f61ec45eSEric Nelson CONFIG_SF_DEFAULT_MODE (see include/spi.h) 2791f61ec45eSEric Nelson CONFIG_SF_DEFAULT_SPEED in Hz 2792f61ec45eSEric Nelson 279324007273SSimon Glass CONFIG_CMD_SF_TEST 279424007273SSimon Glass 279524007273SSimon Glass Define this option to include a destructive SPI flash 279624007273SSimon Glass test ('sf test'). 279724007273SSimon Glass 27981dcd6d03SJagannadha Sutradharudu Teki CONFIG_SPI_FLASH_BAR Ban/Extended Addr Reg 27991dcd6d03SJagannadha Sutradharudu Teki 28001dcd6d03SJagannadha Sutradharudu Teki Define this option to use the Bank addr/Extended addr 28011dcd6d03SJagannadha Sutradharudu Teki support on SPI flashes which has size > 16Mbytes. 28021dcd6d03SJagannadha Sutradharudu Teki 2803b902e07cSJagannadha Sutradharudu Teki CONFIG_SF_DUAL_FLASH Dual flash memories 2804b902e07cSJagannadha Sutradharudu Teki 2805b902e07cSJagannadha Sutradharudu Teki Define this option to use dual flash support where two flash 2806b902e07cSJagannadha Sutradharudu Teki memories can be connected with a given cs line. 2807b902e07cSJagannadha Sutradharudu Teki currently Xilinx Zynq qspi support these type of connections. 2808b902e07cSJagannadha Sutradharudu Teki 28093f85ce27Swdenk- SystemACE Support: 28103f85ce27Swdenk CONFIG_SYSTEMACE 28113f85ce27Swdenk 28123f85ce27Swdenk Adding this option adds support for Xilinx SystemACE 28133f85ce27Swdenk chips attached via some sort of local bus. The address 281411ccc33fSMarcel Ziswiler of the chip must also be defined in the 28156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SYSTEMACE_BASE macro. For example: 28163f85ce27Swdenk 28173f85ce27Swdenk #define CONFIG_SYSTEMACE 28186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000 28193f85ce27Swdenk 28203f85ce27Swdenk When SystemACE support is added, the "ace" device type 28213f85ce27Swdenk becomes available to the fat commands, i.e. fatls. 28223f85ce27Swdenk 2823ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port: 2824ecb0ccd9SWolfgang Denk CONFIG_TFTP_PORT 2825ecb0ccd9SWolfgang Denk 282628cb9375SWolfgang Denk If this is defined, the environment variable tftpsrcp 2827ecb0ccd9SWolfgang Denk is used to supply the TFTP UDP source port value. 282828cb9375SWolfgang Denk If tftpsrcp isn't defined, the normal pseudo-random port 2829ecb0ccd9SWolfgang Denk number generator is used. 2830ecb0ccd9SWolfgang Denk 283128cb9375SWolfgang Denk Also, the environment variable tftpdstp is used to supply 283228cb9375SWolfgang Denk the TFTP UDP destination port value. If tftpdstp isn't 283328cb9375SWolfgang Denk defined, the normal port 69 is used. 283428cb9375SWolfgang Denk 283528cb9375SWolfgang Denk The purpose for tftpsrcp is to allow a TFTP server to 2836ecb0ccd9SWolfgang Denk blindly start the TFTP transfer using the pre-configured 2837ecb0ccd9SWolfgang Denk target IP address and UDP port. This has the effect of 2838ecb0ccd9SWolfgang Denk "punching through" the (Windows XP) firewall, allowing 2839ecb0ccd9SWolfgang Denk the remainder of the TFTP transfer to proceed normally. 2840ecb0ccd9SWolfgang Denk A better solution is to properly configure the firewall, 2841ecb0ccd9SWolfgang Denk but sometimes that is not allowed. 2842ecb0ccd9SWolfgang Denk 2843bf36c5d5SSimon Glass- Hashing support: 2844bf36c5d5SSimon Glass CONFIG_CMD_HASH 2845bf36c5d5SSimon Glass 2846bf36c5d5SSimon Glass This enables a generic 'hash' command which can produce 2847bf36c5d5SSimon Glass hashes / digests from a few algorithms (e.g. SHA1, SHA256). 2848bf36c5d5SSimon Glass 2849bf36c5d5SSimon Glass CONFIG_HASH_VERIFY 2850bf36c5d5SSimon Glass 2851bf36c5d5SSimon Glass Enable the hash verify command (hash -v). This adds to code 2852bf36c5d5SSimon Glass size a little. 2853bf36c5d5SSimon Glass 2854bf36c5d5SSimon Glass CONFIG_SHA1 - support SHA1 hashing 2855bf36c5d5SSimon Glass CONFIG_SHA256 - support SHA256 hashing 2856bf36c5d5SSimon Glass 2857bf36c5d5SSimon Glass Note: There is also a sha1sum command, which should perhaps 2858bf36c5d5SSimon Glass be deprecated in favour of 'hash sha1'. 2859bf36c5d5SSimon Glass 2860a11f1873SRobert Winkler- Freescale i.MX specific commands: 2861a11f1873SRobert Winkler CONFIG_CMD_HDMIDETECT 2862a11f1873SRobert Winkler This enables 'hdmidet' command which returns true if an 2863a11f1873SRobert Winkler HDMI monitor is detected. This command is i.MX 6 specific. 2864a11f1873SRobert Winkler 2865a11f1873SRobert Winkler CONFIG_CMD_BMODE 2866a11f1873SRobert Winkler This enables the 'bmode' (bootmode) command for forcing 2867a11f1873SRobert Winkler a boot from specific media. 2868a11f1873SRobert Winkler 2869a11f1873SRobert Winkler This is useful for forcing the ROM's usb downloader to 2870a11f1873SRobert Winkler activate upon a watchdog reset which is nice when iterating 2871a11f1873SRobert Winkler on U-Boot. Using the reset button or running bmode normal 2872a11f1873SRobert Winkler will set it back to normal. This command currently 2873a11f1873SRobert Winkler supports i.MX53 and i.MX6. 2874a11f1873SRobert Winkler 287519c402afSSimon Glass- Signing support: 287619c402afSSimon Glass CONFIG_RSA 287719c402afSSimon Glass 287819c402afSSimon Glass This enables the RSA algorithm used for FIT image verification 28798bf2aad7SDetlev Zundel in U-Boot. See doc/uImage.FIT/signature.txt for more information. 288019c402afSSimon Glass 288119c402afSSimon Glass The signing part is build into mkimage regardless of this 288219c402afSSimon Glass option. 288319c402afSSimon Glass 28849e50c406SHeiko Schocher- bootcount support: 28859e50c406SHeiko Schocher CONFIG_BOOTCOUNT_LIMIT 28869e50c406SHeiko Schocher 28879e50c406SHeiko Schocher This enables the bootcounter support, see: 28889e50c406SHeiko Schocher http://www.denx.de/wiki/DULG/UBootBootCountLimit 28899e50c406SHeiko Schocher 28909e50c406SHeiko Schocher CONFIG_AT91SAM9XE 28919e50c406SHeiko Schocher enable special bootcounter support on at91sam9xe based boards. 28929e50c406SHeiko Schocher CONFIG_BLACKFIN 28939e50c406SHeiko Schocher enable special bootcounter support on blackfin based boards. 28949e50c406SHeiko Schocher CONFIG_SOC_DA8XX 28959e50c406SHeiko Schocher enable special bootcounter support on da850 based boards. 28969e50c406SHeiko Schocher CONFIG_BOOTCOUNT_RAM 28979e50c406SHeiko Schocher enable support for the bootcounter in RAM 28989e50c406SHeiko Schocher CONFIG_BOOTCOUNT_I2C 28999e50c406SHeiko Schocher enable support for the bootcounter on an i2c (like RTC) device. 29009e50c406SHeiko Schocher CONFIG_SYS_I2C_RTC_ADDR = i2c chip address 29019e50c406SHeiko Schocher CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for 29029e50c406SHeiko Schocher the bootcounter. 29039e50c406SHeiko Schocher CONFIG_BOOTCOUNT_ALEN = address len 290419c402afSSimon Glass 2905a8c7c708Swdenk- Show boot progress: 2906c609719bSwdenk CONFIG_SHOW_BOOT_PROGRESS 2907c609719bSwdenk 2908c609719bSwdenk Defining this option allows to add some board- 2909c609719bSwdenk specific code (calling a user-provided function 2910c609719bSwdenk "show_boot_progress(int)") that enables you to show 2911c609719bSwdenk the system's boot progress on some display (for 2912c609719bSwdenk example, some LED's) on your board. At the moment, 2913c609719bSwdenk the following checkpoints are implemented: 2914c609719bSwdenk 29153a608ca0SSimon Glass- Detailed boot stage timing 29163a608ca0SSimon Glass CONFIG_BOOTSTAGE 29173a608ca0SSimon Glass Define this option to get detailed timing of each stage 29183a608ca0SSimon Glass of the boot process. 29193a608ca0SSimon Glass 29203a608ca0SSimon Glass CONFIG_BOOTSTAGE_USER_COUNT 29213a608ca0SSimon Glass This is the number of available user bootstage records. 29223a608ca0SSimon Glass Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...) 29233a608ca0SSimon Glass a new ID will be allocated from this stash. If you exceed 29243a608ca0SSimon Glass the limit, recording will stop. 29253a608ca0SSimon Glass 29263a608ca0SSimon Glass CONFIG_BOOTSTAGE_REPORT 29273a608ca0SSimon Glass Define this to print a report before boot, similar to this: 29283a608ca0SSimon Glass 29293a608ca0SSimon Glass Timer summary in microseconds: 29303a608ca0SSimon Glass Mark Elapsed Stage 29313a608ca0SSimon Glass 0 0 reset 29323a608ca0SSimon Glass 3,575,678 3,575,678 board_init_f start 29333a608ca0SSimon Glass 3,575,695 17 arch_cpu_init A9 29343a608ca0SSimon Glass 3,575,777 82 arch_cpu_init done 29353a608ca0SSimon Glass 3,659,598 83,821 board_init_r start 29363a608ca0SSimon Glass 3,910,375 250,777 main_loop 29373a608ca0SSimon Glass 29,916,167 26,005,792 bootm_start 29383a608ca0SSimon Glass 30,361,327 445,160 start_kernel 29393a608ca0SSimon Glass 29402eba38cfSSimon Glass CONFIG_CMD_BOOTSTAGE 29412eba38cfSSimon Glass Add a 'bootstage' command which supports printing a report 29422eba38cfSSimon Glass and un/stashing of bootstage data. 29432eba38cfSSimon Glass 294494fd1316SSimon Glass CONFIG_BOOTSTAGE_FDT 294594fd1316SSimon Glass Stash the bootstage information in the FDT. A root 'bootstage' 294694fd1316SSimon Glass node is created with each bootstage id as a child. Each child 294794fd1316SSimon Glass has a 'name' property and either 'mark' containing the 294894fd1316SSimon Glass mark time in microsecond, or 'accum' containing the 294994fd1316SSimon Glass accumulated time for that bootstage id in microseconds. 295094fd1316SSimon Glass For example: 295194fd1316SSimon Glass 295294fd1316SSimon Glass bootstage { 295394fd1316SSimon Glass 154 { 295494fd1316SSimon Glass name = "board_init_f"; 295594fd1316SSimon Glass mark = <3575678>; 295694fd1316SSimon Glass }; 295794fd1316SSimon Glass 170 { 295894fd1316SSimon Glass name = "lcd"; 295994fd1316SSimon Glass accum = <33482>; 296094fd1316SSimon Glass }; 296194fd1316SSimon Glass }; 296294fd1316SSimon Glass 296394fd1316SSimon Glass Code in the Linux kernel can find this in /proc/devicetree. 296494fd1316SSimon Glass 29651372cce2SMarian BalakowiczLegacy uImage format: 29661372cce2SMarian Balakowicz 2967c609719bSwdenk Arg Where When 2968c609719bSwdenk 1 common/cmd_bootm.c before attempting to boot an image 2969c609719bSwdenk -1 common/cmd_bootm.c Image header has bad magic number 2970c609719bSwdenk 2 common/cmd_bootm.c Image header has correct magic number 2971c609719bSwdenk -2 common/cmd_bootm.c Image header has bad checksum 2972c609719bSwdenk 3 common/cmd_bootm.c Image header has correct checksum 2973c609719bSwdenk -3 common/cmd_bootm.c Image data has bad checksum 2974c609719bSwdenk 4 common/cmd_bootm.c Image data has correct checksum 2975c609719bSwdenk -4 common/cmd_bootm.c Image is for unsupported architecture 2976c609719bSwdenk 5 common/cmd_bootm.c Architecture check OK 29771372cce2SMarian Balakowicz -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi) 2978c609719bSwdenk 6 common/cmd_bootm.c Image Type check OK 2979c609719bSwdenk -6 common/cmd_bootm.c gunzip uncompression error 2980c609719bSwdenk -7 common/cmd_bootm.c Unimplemented compression type 2981c609719bSwdenk 7 common/cmd_bootm.c Uncompression OK 29821372cce2SMarian Balakowicz 8 common/cmd_bootm.c No uncompress/copy overwrite error 2983c609719bSwdenk -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX) 29841372cce2SMarian Balakowicz 29851372cce2SMarian Balakowicz 9 common/image.c Start initial ramdisk verification 29861372cce2SMarian Balakowicz -10 common/image.c Ramdisk header has bad magic number 29871372cce2SMarian Balakowicz -11 common/image.c Ramdisk header has bad checksum 29881372cce2SMarian Balakowicz 10 common/image.c Ramdisk header is OK 29891372cce2SMarian Balakowicz -12 common/image.c Ramdisk data has bad checksum 29901372cce2SMarian Balakowicz 11 common/image.c Ramdisk data has correct checksum 29911372cce2SMarian Balakowicz 12 common/image.c Ramdisk verification complete, start loading 299211ccc33fSMarcel Ziswiler -13 common/image.c Wrong Image Type (not PPC Linux ramdisk) 29931372cce2SMarian Balakowicz 13 common/image.c Start multifile image verification 29941372cce2SMarian Balakowicz 14 common/image.c No initial ramdisk, no multifile, continue. 29951372cce2SMarian Balakowicz 2996ea0364f1SPeter Tyser 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS 2997c609719bSwdenk 2998a47a12beSStefan Roese -30 arch/powerpc/lib/board.c Fatal error, hang the system 299963e73c9aSwdenk -31 post/post.c POST test failed, detected by post_output_backlog() 300063e73c9aSwdenk -32 post/post.c POST test failed, detected by post_run_single() 300163e73c9aSwdenk 3002566a494fSHeiko Schocher 34 common/cmd_doc.c before loading a Image from a DOC device 3003566a494fSHeiko Schocher -35 common/cmd_doc.c Bad usage of "doc" command 3004566a494fSHeiko Schocher 35 common/cmd_doc.c correct usage of "doc" command 3005566a494fSHeiko Schocher -36 common/cmd_doc.c No boot device 3006566a494fSHeiko Schocher 36 common/cmd_doc.c correct boot device 3007566a494fSHeiko Schocher -37 common/cmd_doc.c Unknown Chip ID on boot device 3008566a494fSHeiko Schocher 37 common/cmd_doc.c correct chip ID found, device available 3009566a494fSHeiko Schocher -38 common/cmd_doc.c Read Error on boot device 3010566a494fSHeiko Schocher 38 common/cmd_doc.c reading Image header from DOC device OK 3011566a494fSHeiko Schocher -39 common/cmd_doc.c Image header has bad magic number 3012566a494fSHeiko Schocher 39 common/cmd_doc.c Image header has correct magic number 3013566a494fSHeiko Schocher -40 common/cmd_doc.c Error reading Image from DOC device 3014566a494fSHeiko Schocher 40 common/cmd_doc.c Image header has correct magic number 3015566a494fSHeiko Schocher 41 common/cmd_ide.c before loading a Image from a IDE device 3016566a494fSHeiko Schocher -42 common/cmd_ide.c Bad usage of "ide" command 3017566a494fSHeiko Schocher 42 common/cmd_ide.c correct usage of "ide" command 3018566a494fSHeiko Schocher -43 common/cmd_ide.c No boot device 3019566a494fSHeiko Schocher 43 common/cmd_ide.c boot device found 3020566a494fSHeiko Schocher -44 common/cmd_ide.c Device not available 3021566a494fSHeiko Schocher 44 common/cmd_ide.c Device available 3022566a494fSHeiko Schocher -45 common/cmd_ide.c wrong partition selected 3023566a494fSHeiko Schocher 45 common/cmd_ide.c partition selected 3024566a494fSHeiko Schocher -46 common/cmd_ide.c Unknown partition table 3025566a494fSHeiko Schocher 46 common/cmd_ide.c valid partition table found 3026566a494fSHeiko Schocher -47 common/cmd_ide.c Invalid partition type 3027566a494fSHeiko Schocher 47 common/cmd_ide.c correct partition type 3028566a494fSHeiko Schocher -48 common/cmd_ide.c Error reading Image Header on boot device 3029566a494fSHeiko Schocher 48 common/cmd_ide.c reading Image Header from IDE device OK 3030566a494fSHeiko Schocher -49 common/cmd_ide.c Image header has bad magic number 3031566a494fSHeiko Schocher 49 common/cmd_ide.c Image header has correct magic number 3032566a494fSHeiko Schocher -50 common/cmd_ide.c Image header has bad checksum 3033566a494fSHeiko Schocher 50 common/cmd_ide.c Image header has correct checksum 3034566a494fSHeiko Schocher -51 common/cmd_ide.c Error reading Image from IDE device 3035566a494fSHeiko Schocher 51 common/cmd_ide.c reading Image from IDE device OK 3036566a494fSHeiko Schocher 52 common/cmd_nand.c before loading a Image from a NAND device 3037566a494fSHeiko Schocher -53 common/cmd_nand.c Bad usage of "nand" command 3038566a494fSHeiko Schocher 53 common/cmd_nand.c correct usage of "nand" command 3039566a494fSHeiko Schocher -54 common/cmd_nand.c No boot device 3040566a494fSHeiko Schocher 54 common/cmd_nand.c boot device found 3041566a494fSHeiko Schocher -55 common/cmd_nand.c Unknown Chip ID on boot device 3042566a494fSHeiko Schocher 55 common/cmd_nand.c correct chip ID found, device available 3043566a494fSHeiko Schocher -56 common/cmd_nand.c Error reading Image Header on boot device 3044566a494fSHeiko Schocher 56 common/cmd_nand.c reading Image Header from NAND device OK 3045566a494fSHeiko Schocher -57 common/cmd_nand.c Image header has bad magic number 3046566a494fSHeiko Schocher 57 common/cmd_nand.c Image header has correct magic number 3047566a494fSHeiko Schocher -58 common/cmd_nand.c Error reading Image from NAND device 3048566a494fSHeiko Schocher 58 common/cmd_nand.c reading Image from NAND device OK 3049c609719bSwdenk 3050566a494fSHeiko Schocher -60 common/env_common.c Environment has a bad CRC, using default 3051c609719bSwdenk 3052566a494fSHeiko Schocher 64 net/eth.c starting with Ethernet configuration. 3053566a494fSHeiko Schocher -64 net/eth.c no Ethernet found. 3054566a494fSHeiko Schocher 65 net/eth.c Ethernet found. 3055206c60cbSwdenk 3056566a494fSHeiko Schocher -80 common/cmd_net.c usage wrong 3057566a494fSHeiko Schocher 80 common/cmd_net.c before calling NetLoop() 305811ccc33fSMarcel Ziswiler -81 common/cmd_net.c some error in NetLoop() occurred 3059566a494fSHeiko Schocher 81 common/cmd_net.c NetLoop() back without error 3060566a494fSHeiko Schocher -82 common/cmd_net.c size == 0 (File with size 0 loaded) 3061566a494fSHeiko Schocher 82 common/cmd_net.c trying automatic boot 306274de7aefSWolfgang Denk 83 common/cmd_net.c running "source" command 306374de7aefSWolfgang Denk -83 common/cmd_net.c some error in automatic boot or "source" command 3064566a494fSHeiko Schocher 84 common/cmd_net.c end without errors 3065c609719bSwdenk 30661372cce2SMarian BalakowiczFIT uImage format: 30671372cce2SMarian Balakowicz 30681372cce2SMarian Balakowicz Arg Where When 30691372cce2SMarian Balakowicz 100 common/cmd_bootm.c Kernel FIT Image has correct format 30701372cce2SMarian Balakowicz -100 common/cmd_bootm.c Kernel FIT Image has incorrect format 30711372cce2SMarian Balakowicz 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration 30721372cce2SMarian Balakowicz -101 common/cmd_bootm.c Can't get configuration for kernel subimage 30731372cce2SMarian Balakowicz 102 common/cmd_bootm.c Kernel unit name specified 30741372cce2SMarian Balakowicz -103 common/cmd_bootm.c Can't get kernel subimage node offset 3075f773bea8SMarian Balakowicz 103 common/cmd_bootm.c Found configuration node 30761372cce2SMarian Balakowicz 104 common/cmd_bootm.c Got kernel subimage node offset 30771372cce2SMarian Balakowicz -104 common/cmd_bootm.c Kernel subimage hash verification failed 30781372cce2SMarian Balakowicz 105 common/cmd_bootm.c Kernel subimage hash verification OK 30791372cce2SMarian Balakowicz -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture 30801372cce2SMarian Balakowicz 106 common/cmd_bootm.c Architecture check OK 308111ccc33fSMarcel Ziswiler -106 common/cmd_bootm.c Kernel subimage has wrong type 308211ccc33fSMarcel Ziswiler 107 common/cmd_bootm.c Kernel subimage type OK 30831372cce2SMarian Balakowicz -107 common/cmd_bootm.c Can't get kernel subimage data/size 30841372cce2SMarian Balakowicz 108 common/cmd_bootm.c Got kernel subimage data/size 30851372cce2SMarian Balakowicz -108 common/cmd_bootm.c Wrong image type (not legacy, FIT) 30861372cce2SMarian Balakowicz -109 common/cmd_bootm.c Can't get kernel subimage type 30871372cce2SMarian Balakowicz -110 common/cmd_bootm.c Can't get kernel subimage comp 30881372cce2SMarian Balakowicz -111 common/cmd_bootm.c Can't get kernel subimage os 30891372cce2SMarian Balakowicz -112 common/cmd_bootm.c Can't get kernel subimage load address 30901372cce2SMarian Balakowicz -113 common/cmd_bootm.c Image uncompress/copy overwrite error 30911372cce2SMarian Balakowicz 30921372cce2SMarian Balakowicz 120 common/image.c Start initial ramdisk verification 30931372cce2SMarian Balakowicz -120 common/image.c Ramdisk FIT image has incorrect format 30941372cce2SMarian Balakowicz 121 common/image.c Ramdisk FIT image has correct format 309511ccc33fSMarcel Ziswiler 122 common/image.c No ramdisk subimage unit name, using configuration 30961372cce2SMarian Balakowicz -122 common/image.c Can't get configuration for ramdisk subimage 30971372cce2SMarian Balakowicz 123 common/image.c Ramdisk unit name specified 30981372cce2SMarian Balakowicz -124 common/image.c Can't get ramdisk subimage node offset 30991372cce2SMarian Balakowicz 125 common/image.c Got ramdisk subimage node offset 31001372cce2SMarian Balakowicz -125 common/image.c Ramdisk subimage hash verification failed 31011372cce2SMarian Balakowicz 126 common/image.c Ramdisk subimage hash verification OK 31021372cce2SMarian Balakowicz -126 common/image.c Ramdisk subimage for unsupported architecture 31031372cce2SMarian Balakowicz 127 common/image.c Architecture check OK 31041372cce2SMarian Balakowicz -127 common/image.c Can't get ramdisk subimage data/size 31051372cce2SMarian Balakowicz 128 common/image.c Got ramdisk subimage data/size 31061372cce2SMarian Balakowicz 129 common/image.c Can't get ramdisk load address 31071372cce2SMarian Balakowicz -129 common/image.c Got ramdisk load address 31081372cce2SMarian Balakowicz 310911ccc33fSMarcel Ziswiler -130 common/cmd_doc.c Incorrect FIT image format 31101372cce2SMarian Balakowicz 131 common/cmd_doc.c FIT image format OK 31111372cce2SMarian Balakowicz 311211ccc33fSMarcel Ziswiler -140 common/cmd_ide.c Incorrect FIT image format 31131372cce2SMarian Balakowicz 141 common/cmd_ide.c FIT image format OK 31141372cce2SMarian Balakowicz 311511ccc33fSMarcel Ziswiler -150 common/cmd_nand.c Incorrect FIT image format 31161372cce2SMarian Balakowicz 151 common/cmd_nand.c FIT image format OK 31171372cce2SMarian Balakowicz 3118d95f6ec7SGabe Black- FIT image support: 3119d95f6ec7SGabe Black CONFIG_FIT 3120d95f6ec7SGabe Black Enable support for the FIT uImage format. 3121d95f6ec7SGabe Black 3122d95f6ec7SGabe Black CONFIG_FIT_BEST_MATCH 3123d95f6ec7SGabe Black When no configuration is explicitly selected, default to the 3124d95f6ec7SGabe Black one whose fdt's compatibility field best matches that of 3125d95f6ec7SGabe Black U-Boot itself. A match is considered "best" if it matches the 3126d95f6ec7SGabe Black most specific compatibility entry of U-Boot's fdt's root node. 3127d95f6ec7SGabe Black The order of entries in the configuration's fdt is ignored. 3128d95f6ec7SGabe Black 31293e569a6bSSimon Glass CONFIG_FIT_SIGNATURE 31303e569a6bSSimon Glass This option enables signature verification of FIT uImages, 31313e569a6bSSimon Glass using a hash signed and verified using RSA. See 31323e569a6bSSimon Glass doc/uImage.FIT/signature.txt for more details. 31333e569a6bSSimon Glass 31344cf2609bSWolfgang Denk- Standalone program support: 31354cf2609bSWolfgang Denk CONFIG_STANDALONE_LOAD_ADDR 31364cf2609bSWolfgang Denk 31376feff899SWolfgang Denk This option defines a board specific value for the 31386feff899SWolfgang Denk address where standalone program gets loaded, thus 31396feff899SWolfgang Denk overwriting the architecture dependent default 31404cf2609bSWolfgang Denk settings. 31414cf2609bSWolfgang Denk 31424cf2609bSWolfgang Denk- Frame Buffer Address: 31434cf2609bSWolfgang Denk CONFIG_FB_ADDR 31444cf2609bSWolfgang Denk 31454cf2609bSWolfgang Denk Define CONFIG_FB_ADDR if you want to use specific 314644a53b57SWolfgang Denk address for frame buffer. This is typically the case 314744a53b57SWolfgang Denk when using a graphics controller has separate video 314844a53b57SWolfgang Denk memory. U-Boot will then place the frame buffer at 314944a53b57SWolfgang Denk the given address instead of dynamically reserving it 315044a53b57SWolfgang Denk in system RAM by calling lcd_setmem(), which grabs 315144a53b57SWolfgang Denk the memory for the frame buffer depending on the 315244a53b57SWolfgang Denk configured panel size. 31534cf2609bSWolfgang Denk 31544cf2609bSWolfgang Denk Please see board_init_f function. 31554cf2609bSWolfgang Denk 3156cccfc2abSDetlev Zundel- Automatic software updates via TFTP server 3157cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP 3158cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP_CNT_MAX 3159cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP_MSEC_MAX 3160cccfc2abSDetlev Zundel 3161cccfc2abSDetlev Zundel These options enable and control the auto-update feature; 3162cccfc2abSDetlev Zundel for a more detailed description refer to doc/README.update. 3163cccfc2abSDetlev Zundel 3164cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support) 3165cccfc2abSDetlev Zundel CONFIG_MTD_DEVICE 3166cccfc2abSDetlev Zundel 3167cccfc2abSDetlev Zundel Adds the MTD device infrastructure from the Linux kernel. 3168cccfc2abSDetlev Zundel Needed for mtdparts command support. 3169cccfc2abSDetlev Zundel 3170cccfc2abSDetlev Zundel CONFIG_MTD_PARTITIONS 3171cccfc2abSDetlev Zundel 3172cccfc2abSDetlev Zundel Adds the MTD partitioning infrastructure from the Linux 3173cccfc2abSDetlev Zundel kernel. Needed for UBI support. 3174cccfc2abSDetlev Zundel 317570c219cdSJoe Hershberger- UBI support 317670c219cdSJoe Hershberger CONFIG_CMD_UBI 317770c219cdSJoe Hershberger 317870c219cdSJoe Hershberger Adds commands for interacting with MTD partitions formatted 317970c219cdSJoe Hershberger with the UBI flash translation layer 318070c219cdSJoe Hershberger 318170c219cdSJoe Hershberger Requires also defining CONFIG_RBTREE 318270c219cdSJoe Hershberger 3183147162daSJoe Hershberger CONFIG_UBI_SILENCE_MSG 3184147162daSJoe Hershberger 3185147162daSJoe Hershberger Make the verbose messages from UBI stop printing. This leaves 3186147162daSJoe Hershberger warnings and errors enabled. 3187147162daSJoe Hershberger 318870c219cdSJoe Hershberger- UBIFS support 318970c219cdSJoe Hershberger CONFIG_CMD_UBIFS 319070c219cdSJoe Hershberger 319170c219cdSJoe Hershberger Adds commands for interacting with UBI volumes formatted as 319270c219cdSJoe Hershberger UBIFS. UBIFS is read-only in u-boot. 319370c219cdSJoe Hershberger 319470c219cdSJoe Hershberger Requires UBI support as well as CONFIG_LZO 319570c219cdSJoe Hershberger 3196147162daSJoe Hershberger CONFIG_UBIFS_SILENCE_MSG 3197147162daSJoe Hershberger 3198147162daSJoe Hershberger Make the verbose messages from UBIFS stop printing. This leaves 3199147162daSJoe Hershberger warnings and errors enabled. 3200147162daSJoe Hershberger 32016a11cf48SDaniel Schwierzeck- SPL framework 32026a11cf48SDaniel Schwierzeck CONFIG_SPL 32036a11cf48SDaniel Schwierzeck Enable building of SPL globally. 32046a11cf48SDaniel Schwierzeck 320595579793STom Rini CONFIG_SPL_LDSCRIPT 320695579793STom Rini LDSCRIPT for linking the SPL binary. 320795579793STom Rini 32086ebc3461SAlbert ARIBAUD CONFIG_SPL_MAX_FOOTPRINT 32096ebc3461SAlbert ARIBAUD Maximum size in memory allocated to the SPL, BSS included. 32106ebc3461SAlbert ARIBAUD When defined, the linker checks that the actual memory 32116ebc3461SAlbert ARIBAUD used by SPL from _start to __bss_end does not exceed it. 32128960af8bSAlbert ARIBAUD CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE 32136ebc3461SAlbert ARIBAUD must not be both defined at the same time. 32146ebc3461SAlbert ARIBAUD 321595579793STom Rini CONFIG_SPL_MAX_SIZE 32166ebc3461SAlbert ARIBAUD Maximum size of the SPL image (text, data, rodata, and 32176ebc3461SAlbert ARIBAUD linker lists sections), BSS excluded. 32186ebc3461SAlbert ARIBAUD When defined, the linker checks that the actual size does 32196ebc3461SAlbert ARIBAUD not exceed it. 322095579793STom Rini 32216a11cf48SDaniel Schwierzeck CONFIG_SPL_TEXT_BASE 32226a11cf48SDaniel Schwierzeck TEXT_BASE for linking the SPL binary. 32236a11cf48SDaniel Schwierzeck 322494a45bb1SScott Wood CONFIG_SPL_RELOC_TEXT_BASE 322594a45bb1SScott Wood Address to relocate to. If unspecified, this is equal to 322694a45bb1SScott Wood CONFIG_SPL_TEXT_BASE (i.e. no relocation is done). 322794a45bb1SScott Wood 322895579793STom Rini CONFIG_SPL_BSS_START_ADDR 322995579793STom Rini Link address for the BSS within the SPL binary. 323095579793STom Rini 323195579793STom Rini CONFIG_SPL_BSS_MAX_SIZE 32326ebc3461SAlbert ARIBAUD Maximum size in memory allocated to the SPL BSS. 32336ebc3461SAlbert ARIBAUD When defined, the linker checks that the actual memory used 32346ebc3461SAlbert ARIBAUD by SPL from __bss_start to __bss_end does not exceed it. 32358960af8bSAlbert ARIBAUD CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE 32366ebc3461SAlbert ARIBAUD must not be both defined at the same time. 323795579793STom Rini 323895579793STom Rini CONFIG_SPL_STACK 323995579793STom Rini Adress of the start of the stack SPL will use 324095579793STom Rini 324194a45bb1SScott Wood CONFIG_SPL_RELOC_STACK 324294a45bb1SScott Wood Adress of the start of the stack SPL will use after 324394a45bb1SScott Wood relocation. If unspecified, this is equal to 324494a45bb1SScott Wood CONFIG_SPL_STACK. 324594a45bb1SScott Wood 324695579793STom Rini CONFIG_SYS_SPL_MALLOC_START 324795579793STom Rini Starting address of the malloc pool used in SPL. 324895579793STom Rini 324995579793STom Rini CONFIG_SYS_SPL_MALLOC_SIZE 325095579793STom Rini The size of the malloc pool used in SPL. 32516a11cf48SDaniel Schwierzeck 325247f7bcaeSTom Rini CONFIG_SPL_FRAMEWORK 325347f7bcaeSTom Rini Enable the SPL framework under common/. This framework 325447f7bcaeSTom Rini supports MMC, NAND and YMODEM loading of U-Boot and NAND 325547f7bcaeSTom Rini NAND loading of the Linux Kernel. 325647f7bcaeSTom Rini 32579607faf2STom Rini CONFIG_SPL_OS_BOOT 32589607faf2STom Rini Enable booting directly to an OS from SPL. 32599607faf2STom Rini See also: doc/README.falcon 32609607faf2STom Rini 3261861a86f4STom Rini CONFIG_SPL_DISPLAY_PRINT 3262861a86f4STom Rini For ARM, enable an optional function to print more information 3263861a86f4STom Rini about the running system. 3264861a86f4STom Rini 32654b919725SScott Wood CONFIG_SPL_INIT_MINIMAL 32664b919725SScott Wood Arch init code should be built for a very small image 32674b919725SScott Wood 32686a11cf48SDaniel Schwierzeck CONFIG_SPL_LIBCOMMON_SUPPORT 32696a11cf48SDaniel Schwierzeck Support for common/libcommon.o in SPL binary 32706a11cf48SDaniel Schwierzeck 32716a11cf48SDaniel Schwierzeck CONFIG_SPL_LIBDISK_SUPPORT 32726a11cf48SDaniel Schwierzeck Support for disk/libdisk.o in SPL binary 32736a11cf48SDaniel Schwierzeck 32746a11cf48SDaniel Schwierzeck CONFIG_SPL_I2C_SUPPORT 32756a11cf48SDaniel Schwierzeck Support for drivers/i2c/libi2c.o in SPL binary 32766a11cf48SDaniel Schwierzeck 32776a11cf48SDaniel Schwierzeck CONFIG_SPL_GPIO_SUPPORT 32786a11cf48SDaniel Schwierzeck Support for drivers/gpio/libgpio.o in SPL binary 32796a11cf48SDaniel Schwierzeck 32806a11cf48SDaniel Schwierzeck CONFIG_SPL_MMC_SUPPORT 32816a11cf48SDaniel Schwierzeck Support for drivers/mmc/libmmc.o in SPL binary 32826a11cf48SDaniel Schwierzeck 328395579793STom Rini CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR, 328495579793STom Rini CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS, 328595579793STom Rini CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION 328695579793STom Rini Address, size and partition on the MMC to load U-Boot from 328795579793STom Rini when the MMC is being used in raw mode. 328895579793STom Rini 32892b75b0adSPeter Korsgaard CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR 32902b75b0adSPeter Korsgaard Sector to load kernel uImage from when MMC is being 32912b75b0adSPeter Korsgaard used in raw mode (for Falcon mode) 32922b75b0adSPeter Korsgaard 32932b75b0adSPeter Korsgaard CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR, 32942b75b0adSPeter Korsgaard CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS 32952b75b0adSPeter Korsgaard Sector and number of sectors to load kernel argument 32962b75b0adSPeter Korsgaard parameters from when MMC is being used in raw mode 32972b75b0adSPeter Korsgaard (for falcon mode) 32982b75b0adSPeter Korsgaard 329995579793STom Rini CONFIG_SPL_FAT_SUPPORT 330095579793STom Rini Support for fs/fat/libfat.o in SPL binary 330195579793STom Rini 330295579793STom Rini CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME 330395579793STom Rini Filename to read to load U-Boot when reading from FAT 330495579793STom Rini 33057ad2cc79SPeter Korsgaard CONFIG_SPL_FAT_LOAD_KERNEL_NAME 33067ad2cc79SPeter Korsgaard Filename to read to load kernel uImage when reading 33077ad2cc79SPeter Korsgaard from FAT (for Falcon mode) 33087ad2cc79SPeter Korsgaard 33097ad2cc79SPeter Korsgaard CONFIG_SPL_FAT_LOAD_ARGS_NAME 33107ad2cc79SPeter Korsgaard Filename to read to load kernel argument parameters 33117ad2cc79SPeter Korsgaard when reading from FAT (for Falcon mode) 33127ad2cc79SPeter Korsgaard 331306f60ae3SScott Wood CONFIG_SPL_MPC83XX_WAIT_FOR_NAND 331406f60ae3SScott Wood Set this for NAND SPL on PPC mpc83xx targets, so that 331506f60ae3SScott Wood start.S waits for the rest of the SPL to load before 331606f60ae3SScott Wood continuing (the hardware starts execution after just 331706f60ae3SScott Wood loading the first page rather than the full 4K). 331806f60ae3SScott Wood 33196f2f01b9SScott Wood CONFIG_SPL_NAND_BASE 33206f2f01b9SScott Wood Include nand_base.c in the SPL. Requires 33216f2f01b9SScott Wood CONFIG_SPL_NAND_DRIVERS. 33226f2f01b9SScott Wood 33236f2f01b9SScott Wood CONFIG_SPL_NAND_DRIVERS 33246f2f01b9SScott Wood SPL uses normal NAND drivers, not minimal drivers. 33256f2f01b9SScott Wood 33266f2f01b9SScott Wood CONFIG_SPL_NAND_ECC 33276f2f01b9SScott Wood Include standard software ECC in the SPL 33286f2f01b9SScott Wood 332995579793STom Rini CONFIG_SPL_NAND_SIMPLE 33307d4b7955SScott Wood Support for NAND boot using simple NAND drivers that 33317d4b7955SScott Wood expose the cmd_ctrl() interface. 333295579793STom Rini 33336dd3b566STom Rini CONFIG_SPL_MTD_SUPPORT 33346dd3b566STom Rini Support for the MTD subsystem within SPL. Useful for 33356dd3b566STom Rini environment on NAND support within SPL. 33366dd3b566STom Rini 3337bb0dc108SYing Zhang CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT 3338bb0dc108SYing Zhang Set for the SPL on PPC mpc8xxx targets, support for 33395614e71bSYork Sun drivers/ddr/fsl/libddr.o in SPL binary. 3340bb0dc108SYing Zhang 33417c8eea59SYing Zhang CONFIG_SPL_COMMON_INIT_DDR 33427c8eea59SYing Zhang Set for common ddr init with serial presence detect in 33437c8eea59SYing Zhang SPL binary. 33447c8eea59SYing Zhang 334595579793STom Rini CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT, 334695579793STom Rini CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE, 334795579793STom Rini CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS, 334895579793STom Rini CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE, 334995579793STom Rini CONFIG_SYS_NAND_ECCBYTES 335095579793STom Rini Defines the size and behavior of the NAND that SPL uses 33517d4b7955SScott Wood to read U-Boot 335295579793STom Rini 3353fbe76ae4SPrabhakar Kushwaha CONFIG_SPL_NAND_BOOT 3354fbe76ae4SPrabhakar Kushwaha Add support NAND boot 3355fbe76ae4SPrabhakar Kushwaha 335695579793STom Rini CONFIG_SYS_NAND_U_BOOT_OFFS 33577d4b7955SScott Wood Location in NAND to read U-Boot from 33587d4b7955SScott Wood 33597d4b7955SScott Wood CONFIG_SYS_NAND_U_BOOT_DST 33607d4b7955SScott Wood Location in memory to load U-Boot to 33617d4b7955SScott Wood 33627d4b7955SScott Wood CONFIG_SYS_NAND_U_BOOT_SIZE 33637d4b7955SScott Wood Size of image to load 336495579793STom Rini 336595579793STom Rini CONFIG_SYS_NAND_U_BOOT_START 33667d4b7955SScott Wood Entry point in loaded image to jump to 336795579793STom Rini 336895579793STom Rini CONFIG_SYS_NAND_HW_ECC_OOBFIRST 336995579793STom Rini Define this if you need to first read the OOB and then the 337095579793STom Rini data. This is used for example on davinci plattforms. 337195579793STom Rini 337295579793STom Rini CONFIG_SPL_OMAP3_ID_NAND 337395579793STom Rini Support for an OMAP3-specific set of functions to return the 337495579793STom Rini ID and MFR of the first attached NAND chip, if present. 337595579793STom Rini 33766a11cf48SDaniel Schwierzeck CONFIG_SPL_SERIAL_SUPPORT 33776a11cf48SDaniel Schwierzeck Support for drivers/serial/libserial.o in SPL binary 33786a11cf48SDaniel Schwierzeck 33796a11cf48SDaniel Schwierzeck CONFIG_SPL_SPI_FLASH_SUPPORT 33806a11cf48SDaniel Schwierzeck Support for drivers/mtd/spi/libspi_flash.o in SPL binary 33816a11cf48SDaniel Schwierzeck 33826a11cf48SDaniel Schwierzeck CONFIG_SPL_SPI_SUPPORT 33836a11cf48SDaniel Schwierzeck Support for drivers/spi/libspi.o in SPL binary 33846a11cf48SDaniel Schwierzeck 3385c57b953dSPavel Machek CONFIG_SPL_RAM_DEVICE 3386c57b953dSPavel Machek Support for running image already present in ram, in SPL binary 3387c57b953dSPavel Machek 33886a11cf48SDaniel Schwierzeck CONFIG_SPL_LIBGENERIC_SUPPORT 33896a11cf48SDaniel Schwierzeck Support for lib/libgeneric.o in SPL binary 33901372cce2SMarian Balakowicz 3391ba1bee43SYing Zhang CONFIG_SPL_ENV_SUPPORT 3392ba1bee43SYing Zhang Support for the environment operating in SPL binary 3393ba1bee43SYing Zhang 3394ba1bee43SYing Zhang CONFIG_SPL_NET_SUPPORT 3395ba1bee43SYing Zhang Support for the net/libnet.o in SPL binary. 3396ba1bee43SYing Zhang It conflicts with SPL env from storage medium specified by 3397ba1bee43SYing Zhang CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE 3398ba1bee43SYing Zhang 339974752baaSScott Wood CONFIG_SPL_PAD_TO 34006113d3f2SBenoît Thébaudeau Image offset to which the SPL should be padded before appending 34016113d3f2SBenoît Thébaudeau the SPL payload. By default, this is defined as 34026113d3f2SBenoît Thébaudeau CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined. 34036113d3f2SBenoît Thébaudeau CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL 34046113d3f2SBenoît Thébaudeau payload without any padding, or >= CONFIG_SPL_MAX_SIZE. 340574752baaSScott Wood 3406ca2fca22SScott Wood CONFIG_SPL_TARGET 3407ca2fca22SScott Wood Final target image containing SPL and payload. Some SPLs 3408ca2fca22SScott Wood use an arch-specific makefile fragment instead, for 3409ca2fca22SScott Wood example if more than one image needs to be produced. 3410ca2fca22SScott Wood 341187ebee39SSimon Glass CONFIG_FIT_SPL_PRINT 341287ebee39SSimon Glass Printing information about a FIT image adds quite a bit of 341387ebee39SSimon Glass code to SPL. So this is normally disabled in SPL. Use this 341487ebee39SSimon Glass option to re-enable it. This will affect the output of the 341587ebee39SSimon Glass bootm command when booting a FIT image. 341687ebee39SSimon Glass 34173aa29de0SYing Zhang- TPL framework 34183aa29de0SYing Zhang CONFIG_TPL 34193aa29de0SYing Zhang Enable building of TPL globally. 34203aa29de0SYing Zhang 34213aa29de0SYing Zhang CONFIG_TPL_PAD_TO 34223aa29de0SYing Zhang Image offset to which the TPL should be padded before appending 34233aa29de0SYing Zhang the TPL payload. By default, this is defined as 34243aa29de0SYing Zhang CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined. 34253aa29de0SYing Zhang CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL 34263aa29de0SYing Zhang payload without any padding, or >= CONFIG_SPL_MAX_SIZE. 34273aa29de0SYing Zhang 3428c609719bSwdenkModem Support: 3429c609719bSwdenk-------------- 3430c609719bSwdenk 3431566e5cf4SWolfgang Denk[so far only for SMDK2400 boards] 3432c609719bSwdenk 343311ccc33fSMarcel Ziswiler- Modem support enable: 3434c609719bSwdenk CONFIG_MODEM_SUPPORT 3435c609719bSwdenk 3436c609719bSwdenk- RTS/CTS Flow control enable: 3437c609719bSwdenk CONFIG_HWFLOW 3438c609719bSwdenk 3439c609719bSwdenk- Modem debug support: 3440c609719bSwdenk CONFIG_MODEM_SUPPORT_DEBUG 3441c609719bSwdenk 3442c609719bSwdenk Enables debugging stuff (char screen[1024], dbg()) 3443c609719bSwdenk for modem support. Useful only with BDI2000. 3444c609719bSwdenk 3445a8c7c708Swdenk- Interrupt support (PPC): 3446a8c7c708Swdenk 3447a8c7c708Swdenk There are common interrupt_init() and timer_interrupt() 3448a8c7c708Swdenk for all PPC archs. interrupt_init() calls interrupt_init_cpu() 344911ccc33fSMarcel Ziswiler for CPU specific initialization. interrupt_init_cpu() 3450a8c7c708Swdenk should set decrementer_count to appropriate value. If 345111ccc33fSMarcel Ziswiler CPU resets decrementer automatically after interrupt 3452a8c7c708Swdenk (ppc4xx) it should set decrementer_count to zero. 345311ccc33fSMarcel Ziswiler timer_interrupt() calls timer_interrupt_cpu() for CPU 3454a8c7c708Swdenk specific handling. If board has watchdog / status_led 3455a8c7c708Swdenk / other_activity_monitor it works automatically from 3456a8c7c708Swdenk general timer_interrupt(). 3457a8c7c708Swdenk 3458c609719bSwdenk- General: 3459c609719bSwdenk 3460c609719bSwdenk In the target system modem support is enabled when a 3461c609719bSwdenk specific key (key combination) is pressed during 3462c609719bSwdenk power-on. Otherwise U-Boot will boot normally 346311ccc33fSMarcel Ziswiler (autoboot). The key_pressed() function is called from 3464c609719bSwdenk board_init(). Currently key_pressed() is a dummy 3465c609719bSwdenk function, returning 1 and thus enabling modem 3466c609719bSwdenk initialization. 3467c609719bSwdenk 3468c609719bSwdenk If there are no modem init strings in the 3469c609719bSwdenk environment, U-Boot proceed to autoboot; the 3470c609719bSwdenk previous output (banner, info printfs) will be 347111ccc33fSMarcel Ziswiler suppressed, though. 3472c609719bSwdenk 3473c609719bSwdenk See also: doc/README.Modem 3474c609719bSwdenk 34759660e442SHelmut RaigerBoard initialization settings: 34769660e442SHelmut Raiger------------------------------ 34779660e442SHelmut Raiger 34789660e442SHelmut RaigerDuring Initialization u-boot calls a number of board specific functions 34799660e442SHelmut Raigerto allow the preparation of board specific prerequisites, e.g. pin setup 34809660e442SHelmut Raigerbefore drivers are initialized. To enable these callbacks the 34819660e442SHelmut Raigerfollowing configuration macros have to be defined. Currently this is 34829660e442SHelmut Raigerarchitecture specific, so please check arch/your_architecture/lib/board.c 34839660e442SHelmut Raigertypically in board_init_f() and board_init_r(). 34849660e442SHelmut Raiger 34859660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f() 34869660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r() 34879660e442SHelmut Raiger- CONFIG_BOARD_LATE_INIT: Call board_late_init() 34889660e442SHelmut Raiger- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init() 3489c609719bSwdenk 3490c609719bSwdenkConfiguration Settings: 3491c609719bSwdenk----------------------- 3492c609719bSwdenk 34934d1fd7f1SYork Sun- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit. 34944d1fd7f1SYork Sun Optionally it can be defined to support 64-bit memory commands. 34954d1fd7f1SYork Sun 34966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included; 3497c609719bSwdenk undefine this when you're short of memory. 3498c609719bSwdenk 34992fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default 35002fb2604dSPeter Tyser width of the commands listed in the 'help' command output. 35012fb2604dSPeter Tyser 35026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to 3503c609719bSwdenk prompt for user input. 3504c609719bSwdenk 35056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE: Buffer size for input from the Console 3506c609719bSwdenk 35076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE: Buffer size for Console output 3508c609719bSwdenk 35096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands 3510c609719bSwdenk 35116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to 3512c609719bSwdenk the application (usually a Linux kernel) when it is 3513c609719bSwdenk booted 3514c609719bSwdenk 35156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE: 3516c609719bSwdenk List of legal baudrate settings for this board. 3517c609719bSwdenk 35186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET 3519c609719bSwdenk Suppress display of console information at boot. 3520c609719bSwdenk 35216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV 3522c609719bSwdenk If the board specific function 3523c609719bSwdenk extern int overwrite_console (void); 3524c609719bSwdenk returns 1, the stdin, stderr and stdout are switched to the 3525c609719bSwdenk serial port, else the settings in the environment are used. 3526c609719bSwdenk 35276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE 3528c609719bSwdenk Enable the call to overwrite_console(). 3529c609719bSwdenk 35306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE 3531c609719bSwdenk Enable overwrite of previous console environment settings. 3532c609719bSwdenk 35336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END: 3534c609719bSwdenk Begin and End addresses of the area used by the 3535c609719bSwdenk simple memory test. 3536c609719bSwdenk 35376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST: 3538c609719bSwdenk Enable an alternate, more extensive memory test. 3539c609719bSwdenk 35406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH: 35415f535fe1Swdenk Scratch address used by the alternate memory test 35425f535fe1Swdenk You only need to set this if address zero isn't writeable 35435f535fe1Swdenk 35446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only): 35456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header, 354614f73ca6SStefan Roese this specified memory area will get subtracted from the top 354711ccc33fSMarcel Ziswiler (end) of RAM and won't get "touched" at all by U-Boot. By 354814f73ca6SStefan Roese fixing up gd->ram_size the Linux kernel should gets passed 354914f73ca6SStefan Roese the now "corrected" memory size and won't touch it either. 355014f73ca6SStefan Roese This should work for arch/ppc and arch/powerpc. Only Linux 35515e12e75dSStefan Roese board ports in arch/powerpc with bootwrapper support that 355214f73ca6SStefan Roese recalculate the memory size from the SDRAM controller setup 35535e12e75dSStefan Roese will have to get fixed in Linux additionally. 355414f73ca6SStefan Roese 355514f73ca6SStefan Roese This option can be used as a workaround for the 440EPx/GRx 355614f73ca6SStefan Roese CHIP 11 errata where the last 256 bytes in SDRAM shouldn't 355714f73ca6SStefan Roese be touched. 355814f73ca6SStefan Roese 355914f73ca6SStefan Roese WARNING: Please make sure that this value is a multiple of 356014f73ca6SStefan Roese the Linux page size (normally 4k). If this is not the case, 356114f73ca6SStefan Roese then the end address of the Linux memory will be located at a 356214f73ca6SStefan Roese non page size aligned address and this could cause major 356314f73ca6SStefan Roese problems. 356414f73ca6SStefan Roese 35656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE: 3566c609719bSwdenk Enable temporary baudrate change while serial download 3567c609719bSwdenk 35686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE: 3569c609719bSwdenk Physical start address of SDRAM. _Must_ be 0 here. 3570c609719bSwdenk 35716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE: 3572c609719bSwdenk Physical start address of Motherboard I/O (if using a 3573c609719bSwdenk Cogent motherboard) 3574c609719bSwdenk 35756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE: 3576c609719bSwdenk Physical start address of Flash memory. 3577c609719bSwdenk 35786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE: 3579c609719bSwdenk Physical start address of boot monitor code (set by 3580c609719bSwdenk make config files to be same as the text base address 358114d0a02aSWolfgang Denk (CONFIG_SYS_TEXT_BASE) used when linking) - same as 35826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FLASH_BASE when booting from flash. 3583c609719bSwdenk 35846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN: 35853b57fe0aSwdenk Size of memory reserved for monitor code, used to 35863b57fe0aSwdenk determine _at_compile_time_ (!) if the environment is 35873b57fe0aSwdenk embedded within the U-Boot image, or in a separate 35883b57fe0aSwdenk flash sector. 3589c609719bSwdenk 35906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN: 3591c609719bSwdenk Size of DRAM reserved for malloc() use. 3592c609719bSwdenk 35936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN: 359415940c9aSStefan Roese Normally compressed uImages are limited to an 359515940c9aSStefan Roese uncompressed size of 8 MBytes. If this is not enough, 35966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD you can define CONFIG_SYS_BOOTM_LEN in your board config file 359715940c9aSStefan Roese to adjust this setting to your needs. 3598c609719bSwdenk 35996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ: 3600c609719bSwdenk Maximum size of memory mapped by the startup code of 3601c609719bSwdenk the Linux kernel; all data that must be processed by 36027d721e34SBartlomiej Sieka the Linux kernel (bd_info, boot arguments, FDT blob if 36037d721e34SBartlomiej Sieka used) must be put below this limit, unless "bootm_low" 36041bce2aebSRobert P. J. Day environment variable is defined and non-zero. In such case 36057d721e34SBartlomiej Sieka all data for the Linux kernel must be between "bootm_low" 3606c3624e6eSGrant Likely and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment 3607c3624e6eSGrant Likely variable "bootm_mapsize" will override the value of 3608c3624e6eSGrant Likely CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined, 3609c3624e6eSGrant Likely then the value in "bootm_size" will be used instead. 3610c609719bSwdenk 3611fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH: 3612fca43cc8SJohn Rigby Enable initrd_high functionality. If defined then the 3613fca43cc8SJohn Rigby initrd_high feature is enabled and the bootm ramdisk subcommand 3614fca43cc8SJohn Rigby is enabled. 3615fca43cc8SJohn Rigby 3616fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE: 3617fca43cc8SJohn Rigby Enables allocating and saving kernel cmdline in space between 3618fca43cc8SJohn Rigby "bootm_low" and "bootm_low" + BOOTMAPSZ. 3619fca43cc8SJohn Rigby 3620fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD: 3621fca43cc8SJohn Rigby Enables allocating and saving a kernel copy of the bd_info in 3622fca43cc8SJohn Rigby space between "bootm_low" and "bootm_low" + BOOTMAPSZ. 3623fca43cc8SJohn Rigby 36246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS: 3625c609719bSwdenk Max number of Flash memory banks 3626c609719bSwdenk 36276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT: 3628c609719bSwdenk Max number of sectors on a Flash chip 3629c609719bSwdenk 36306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT: 3631c609719bSwdenk Timeout for Flash erase operations (in ms) 3632c609719bSwdenk 36336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT: 3634c609719bSwdenk Timeout for Flash write operations (in ms) 3635c609719bSwdenk 36366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT 36378564acf9Swdenk Timeout for Flash set sector lock bit operation (in ms) 36388564acf9Swdenk 36396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT 36408564acf9Swdenk Timeout for Flash clear lock bits operation (in ms) 36418564acf9Swdenk 36426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION 36438564acf9Swdenk If defined, hardware flash sectors protection is used 36448564acf9Swdenk instead of U-Boot software protection. 36458564acf9Swdenk 36466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP: 3647c609719bSwdenk 3648c609719bSwdenk Enable TFTP transfers directly to flash memory; 3649c609719bSwdenk without this option such a download has to be 3650c609719bSwdenk performed in two steps: (1) download to RAM, and (2) 3651c609719bSwdenk copy from RAM to flash. 3652c609719bSwdenk 3653c609719bSwdenk The two-step approach is usually more reliable, since 3654c609719bSwdenk you can check if the download worked before you erase 365511ccc33fSMarcel Ziswiler the flash, but in some situations (when system RAM is 365611ccc33fSMarcel Ziswiler too limited to allow for a temporary copy of the 3657c609719bSwdenk downloaded image) this option may be very useful. 3658c609719bSwdenk 36596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI: 3660c609719bSwdenk Define if the flash driver uses extra elements in the 36615653fc33Swdenk common flash structure for storing flash geometry. 36625653fc33Swdenk 366300b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER 36645653fc33Swdenk This option also enables the building of the cfi_flash driver 36655653fc33Swdenk in the drivers directory 366653cf9435Sstroese 366791809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD 366891809ed5SPiotr Ziecik This option enables the building of the cfi_mtd driver 366991809ed5SPiotr Ziecik in the drivers directory. The driver exports CFI flash 367091809ed5SPiotr Ziecik to the MTD layer. 367191809ed5SPiotr Ziecik 36726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE 367396ef831fSGuennadi Liakhovetski Use buffered writes to flash. 367496ef831fSGuennadi Liakhovetski 367596ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N 367696ef831fSGuennadi Liakhovetski s29ws-n MirrorBit flash has non-standard addresses for buffered 367796ef831fSGuennadi Liakhovetski write commands. 367896ef831fSGuennadi Liakhovetski 36796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST 36805568e613SStefan Roese If this option is defined, the common CFI flash doesn't 36815568e613SStefan Roese print it's warning upon not recognized FLASH banks. This 36825568e613SStefan Roese is useful, if some of the configured banks are only 36835568e613SStefan Roese optionally available. 36845568e613SStefan Roese 36859a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS 36869a042e9cSJerry Van Baren If defined (must be an integer), print out countdown 36879a042e9cSJerry Van Baren digits and dots. Recommended value: 45 (9..1) for 80 36889a042e9cSJerry Van Baren column displays, 15 (3..1) for 40 column displays. 36899a042e9cSJerry Van Baren 3690352ef3f1SStefan Roese- CONFIG_FLASH_VERIFY 3691352ef3f1SStefan Roese If defined, the content of the flash (destination) is compared 3692352ef3f1SStefan Roese against the source after the write operation. An error message 3693352ef3f1SStefan Roese will be printed when the contents are not identical. 3694352ef3f1SStefan Roese Please note that this option is useless in nearly all cases, 3695352ef3f1SStefan Roese since such flash programming errors usually are detected earlier 3696352ef3f1SStefan Roese while unprotecting/erasing/programming. Please only enable 3697352ef3f1SStefan Roese this option if you really know what you are doing. 3698352ef3f1SStefan Roese 36996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER: 370011ccc33fSMarcel Ziswiler Defines the number of Ethernet receive buffers. On some 370111ccc33fSMarcel Ziswiler Ethernet controllers it is recommended to set this value 370253cf9435Sstroese to 8 or even higher (EEPRO100 or 405 EMAC), since all 370353cf9435Sstroese buffers can be full shortly after enabling the interface 370411ccc33fSMarcel Ziswiler on high Ethernet traffic. 370553cf9435Sstroese Defaults to 4 if not defined. 3706c609719bSwdenk 3707ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES 3708ea882bafSWolfgang Denk 3709ea882bafSWolfgang Denk Maximum number of entries in the hash table that is used 3710ea882bafSWolfgang Denk internally to store the environment settings. The default 3711ea882bafSWolfgang Denk setting is supposed to be generous and should work in most 3712ea882bafSWolfgang Denk cases. This setting can be used to tune behaviour; see 3713ea882bafSWolfgang Denk lib/hashtable.c for details. 3714ea882bafSWolfgang Denk 37152598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_DEFAULT 37162598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_STATIC 37171bce2aebSRobert P. J. Day Enable validation of the values given to environment variables when 37182598090bSJoe Hershberger calling env set. Variables can be restricted to only decimal, 37192598090bSJoe Hershberger hexadecimal, or boolean. If CONFIG_CMD_NET is also defined, 37202598090bSJoe Hershberger the variables can also be restricted to IP address or MAC address. 37212598090bSJoe Hershberger 37222598090bSJoe Hershberger The format of the list is: 37232598090bSJoe Hershberger type_attribute = [s|d|x|b|i|m] 3724267541f7SJoe Hershberger access_atribute = [a|r|o|c] 3725267541f7SJoe Hershberger attributes = type_attribute[access_atribute] 37262598090bSJoe Hershberger entry = variable_name[:attributes] 37272598090bSJoe Hershberger list = entry[,list] 37282598090bSJoe Hershberger 37292598090bSJoe Hershberger The type attributes are: 37302598090bSJoe Hershberger s - String (default) 37312598090bSJoe Hershberger d - Decimal 37322598090bSJoe Hershberger x - Hexadecimal 37332598090bSJoe Hershberger b - Boolean ([1yYtT|0nNfF]) 37342598090bSJoe Hershberger i - IP address 37352598090bSJoe Hershberger m - MAC address 37362598090bSJoe Hershberger 3737267541f7SJoe Hershberger The access attributes are: 3738267541f7SJoe Hershberger a - Any (default) 3739267541f7SJoe Hershberger r - Read-only 3740267541f7SJoe Hershberger o - Write-once 3741267541f7SJoe Hershberger c - Change-default 3742267541f7SJoe Hershberger 37432598090bSJoe Hershberger - CONFIG_ENV_FLAGS_LIST_DEFAULT 37442598090bSJoe Hershberger Define this to a list (string) to define the ".flags" 37452598090bSJoe Hershberger envirnoment variable in the default or embedded environment. 37462598090bSJoe Hershberger 37472598090bSJoe Hershberger - CONFIG_ENV_FLAGS_LIST_STATIC 37482598090bSJoe Hershberger Define this to a list (string) to define validation that 37492598090bSJoe Hershberger should be done if an entry is not found in the ".flags" 37502598090bSJoe Hershberger environment variable. To override a setting in the static 37512598090bSJoe Hershberger list, simply add an entry for the same variable name to the 37522598090bSJoe Hershberger ".flags" variable. 37532598090bSJoe Hershberger 3754267541f7SJoe Hershberger- CONFIG_ENV_ACCESS_IGNORE_FORCE 3755267541f7SJoe Hershberger If defined, don't allow the -f switch to env set override variable 3756267541f7SJoe Hershberger access flags. 3757267541f7SJoe Hershberger 37585c1a7ea6SSimon Glass- CONFIG_SYS_GENERIC_BOARD 37595c1a7ea6SSimon Glass This selects the architecture-generic board system instead of the 37605c1a7ea6SSimon Glass architecture-specific board files. It is intended to move boards 37615c1a7ea6SSimon Glass to this new framework over time. Defining this will disable the 37625c1a7ea6SSimon Glass arch/foo/lib/board.c file and use common/board_f.c and 37635c1a7ea6SSimon Glass common/board_r.c instead. To use this option your architecture 37645c1a7ea6SSimon Glass must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in 37655c1a7ea6SSimon Glass its config.mk file). If you find problems enabling this option on 37665c1a7ea6SSimon Glass your board please report the problem and send patches! 37675c1a7ea6SSimon Glass 37680b1b60c7SLokesh Vutla- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only) 37690b1b60c7SLokesh Vutla This is set by OMAP boards for the max time that reset should 37700b1b60c7SLokesh Vutla be asserted. See doc/README.omap-reset-time for details on how 37710b1b60c7SLokesh Vutla the value can be calulated on a given board. 3772632efa74SSimon Glass 3773c609719bSwdenkThe following definitions that deal with the placement and management 3774c609719bSwdenkof environment data (variable area); in general, we support the 3775c609719bSwdenkfollowing configurations: 3776c609719bSwdenk 3777c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC: 3778c3eb3fe4SMike Frysinger 3779c3eb3fe4SMike Frysinger Builds up envcrc with the target environment so that external utils 3780c3eb3fe4SMike Frysinger may easily extract it and embed it in final U-Boot images. 3781c3eb3fe4SMike Frysinger 37825a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH: 3783c609719bSwdenk 3784c609719bSwdenk Define this if the environment is in flash memory. 3785c609719bSwdenk 3786c609719bSwdenk a) The environment occupies one whole flash sector, which is 3787c609719bSwdenk "embedded" in the text segment with the U-Boot code. This 3788c609719bSwdenk happens usually with "bottom boot sector" or "top boot 3789c609719bSwdenk sector" type flash chips, which have several smaller 3790c609719bSwdenk sectors at the start or the end. For instance, such a 3791c609719bSwdenk layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In 3792c609719bSwdenk such a case you would place the environment in one of the 3793c609719bSwdenk 4 kB sectors - with U-Boot code before and after it. With 3794c609719bSwdenk "top boot sector" type flash chips, you would put the 3795c609719bSwdenk environment in one of the last sectors, leaving a gap 3796c609719bSwdenk between U-Boot and the environment. 3797c609719bSwdenk 37980e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 3799c609719bSwdenk 3800c609719bSwdenk Offset of environment data (variable area) to the 3801c609719bSwdenk beginning of flash memory; for instance, with bottom boot 3802c609719bSwdenk type flash chips the second sector can be used: the offset 3803c609719bSwdenk for this sector is given here. 3804c609719bSwdenk 38056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE. 3806c609719bSwdenk 38070e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 3808c609719bSwdenk 3809c609719bSwdenk This is just another way to specify the start address of 3810c609719bSwdenk the flash sector containing the environment (instead of 38110e8d1586SJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_OFFSET). 3812c609719bSwdenk 38130e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SECT_SIZE: 3814c609719bSwdenk 3815c609719bSwdenk Size of the sector containing the environment. 3816c609719bSwdenk 3817c609719bSwdenk 3818c609719bSwdenk b) Sometimes flash chips have few, equal sized, BIG sectors. 3819c609719bSwdenk In such a case you don't want to spend a whole sector for 3820c609719bSwdenk the environment. 3821c609719bSwdenk 38220e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 3823c609719bSwdenk 38245a1aceb0SJean-Christophe PLAGNIOL-VILLARD If you use this in combination with CONFIG_ENV_IS_IN_FLASH 38250e8d1586SJean-Christophe PLAGNIOL-VILLARD and CONFIG_ENV_SECT_SIZE, you can specify to use only a part 3826c609719bSwdenk of this flash sector for the environment. This saves 3827c609719bSwdenk memory for the RAM copy of the environment. 3828c609719bSwdenk 3829c609719bSwdenk It may also save flash memory if you decide to use this 3830c609719bSwdenk when your environment is "embedded" within U-Boot code, 3831c609719bSwdenk since then the remainder of the flash sector could be used 3832c609719bSwdenk for U-Boot code. It should be pointed out that this is 3833c609719bSwdenk STRONGLY DISCOURAGED from a robustness point of view: 3834c609719bSwdenk updating the environment in flash makes it always 3835c609719bSwdenk necessary to erase the WHOLE sector. If something goes 3836c609719bSwdenk wrong before the contents has been restored from a copy in 3837c609719bSwdenk RAM, your target system will be dead. 3838c609719bSwdenk 38390e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR_REDUND 38400e8d1586SJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_SIZE_REDUND 3841c609719bSwdenk 3842c609719bSwdenk These settings describe a second storage area used to hold 384311ccc33fSMarcel Ziswiler a redundant copy of the environment data, so that there is 38443e38691eSwdenk a valid backup copy in case there is a power failure during 3845c609719bSwdenk a "saveenv" operation. 3846c609719bSwdenk 3847c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the 3848c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds* 3849c609719bSwdenkaccordingly! 3850c609719bSwdenk 3851c609719bSwdenk 38529314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM: 3853c609719bSwdenk 3854c609719bSwdenk Define this if you have some non-volatile memory device 3855c609719bSwdenk (NVRAM, battery buffered SRAM) which you want to use for the 3856c609719bSwdenk environment. 3857c609719bSwdenk 38580e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 38590e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 3860c609719bSwdenk 386111ccc33fSMarcel Ziswiler These two #defines are used to determine the memory area you 3862c609719bSwdenk want to use for environment. It is assumed that this memory 3863c609719bSwdenk can just be read and written to, without any special 3864c609719bSwdenk provision. 3865c609719bSwdenk 3866c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early 3867c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the 386811ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or 3869c609719bSwdenkU-Boot will hang. 3870c609719bSwdenk 3871c609719bSwdenkPlease note that even with NVRAM we still use a copy of the 3872c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to 3873c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv" 3874c609719bSwdenkto save the current settings. 3875c609719bSwdenk 3876c609719bSwdenk 3877bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM: 3878c609719bSwdenk 3879c609719bSwdenk Use this if you have an EEPROM or similar serial access 3880c609719bSwdenk device and a driver for it. 3881c609719bSwdenk 38820e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 38830e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 3884c609719bSwdenk 3885c609719bSwdenk These two #defines specify the offset and size of the 3886c609719bSwdenk environment area within the total memory of your EEPROM. 3887c609719bSwdenk 38886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR: 3889c609719bSwdenk If defined, specified the chip address of the EEPROM device. 3890c609719bSwdenk The default address is zero. 3891c609719bSwdenk 38926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS: 3893c609719bSwdenk If defined, the number of bits used to address bytes in a 3894c609719bSwdenk single page in the EEPROM device. A 64 byte page, for example 3895c609719bSwdenk would require six bits. 3896c609719bSwdenk 38976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS: 3898c609719bSwdenk If defined, the number of milliseconds to delay between 3899c609719bSwdenk page writes. The default is zero milliseconds. 3900c609719bSwdenk 39016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR_LEN: 3902c609719bSwdenk The length in bytes of the EEPROM memory array address. Note 3903c609719bSwdenk that this is NOT the chip address length! 3904c609719bSwdenk 39056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW: 39065cf91d6bSwdenk EEPROM chips that implement "address overflow" are ones 39075cf91d6bSwdenk like Catalyst 24WC04/08/16 which has 9/10/11 bits of 39085cf91d6bSwdenk address and the extra bits end up in the "chip address" bit 39095cf91d6bSwdenk slots. This makes a 24WC08 (1Kbyte) chip look like four 256 39105cf91d6bSwdenk byte chips. 39115cf91d6bSwdenk 39125cf91d6bSwdenk Note that we consider the length of the address field to 39135cf91d6bSwdenk still be one byte because the extra address bits are hidden 39145cf91d6bSwdenk in the chip address. 39155cf91d6bSwdenk 39166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_SIZE: 3917c609719bSwdenk The size in bytes of the EEPROM device. 3918c609719bSwdenk 3919548738b4SHeiko Schocher - CONFIG_ENV_EEPROM_IS_ON_I2C 3920548738b4SHeiko Schocher define this, if you have I2C and SPI activated, and your 3921548738b4SHeiko Schocher EEPROM, which holds the environment, is on the I2C bus. 3922548738b4SHeiko Schocher 3923548738b4SHeiko Schocher - CONFIG_I2C_ENV_EEPROM_BUS 3924548738b4SHeiko Schocher if you have an Environment on an EEPROM reached over 3925548738b4SHeiko Schocher I2C muxes, you can define here, how to reach this 3926548738b4SHeiko Schocher EEPROM. For example: 3927548738b4SHeiko Schocher 3928ea818dbbSHeiko Schocher #define CONFIG_I2C_ENV_EEPROM_BUS 1 3929548738b4SHeiko Schocher 3930548738b4SHeiko Schocher EEPROM which holds the environment, is reached over 3931548738b4SHeiko Schocher a pca9547 i2c mux with address 0x70, channel 3. 3932c609719bSwdenk 3933057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH: 39345779d8d9Swdenk 39355779d8d9Swdenk Define this if you have a DataFlash memory device which you 39365779d8d9Swdenk want to use for the environment. 39375779d8d9Swdenk 39380e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 39390e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 39400e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 39415779d8d9Swdenk 39425779d8d9Swdenk These three #defines specify the offset and size of the 39435779d8d9Swdenk environment area within the total memory of your DataFlash placed 39445779d8d9Swdenk at the specified address. 39455779d8d9Swdenk 39460a85a9e7SLiu Gang- CONFIG_ENV_IS_IN_REMOTE: 39470a85a9e7SLiu Gang 39480a85a9e7SLiu Gang Define this if you have a remote memory space which you 39490a85a9e7SLiu Gang want to use for the local device's environment. 39500a85a9e7SLiu Gang 39510a85a9e7SLiu Gang - CONFIG_ENV_ADDR: 39520a85a9e7SLiu Gang - CONFIG_ENV_SIZE: 39530a85a9e7SLiu Gang 39540a85a9e7SLiu Gang These two #defines specify the address and size of the 39550a85a9e7SLiu Gang environment area within the remote memory space. The 39560a85a9e7SLiu Gang local device can get the environment from remote memory 3957fc54c7faSLiu Gang space by SRIO or PCIE links. 39580a85a9e7SLiu Gang 39590a85a9e7SLiu GangBE CAREFUL! For some special cases, the local device can not use 39600a85a9e7SLiu Gang"saveenv" command. For example, the local device will get the 3961fc54c7faSLiu Gangenvironment stored in a remote NOR flash by SRIO or PCIE link, 3962fc54c7faSLiu Gangbut it can not erase, write this NOR flash by SRIO or PCIE interface. 39630a85a9e7SLiu Gang 396451bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND: 396513a5695bSwdenk 396613a5695bSwdenk Define this if you have a NAND device which you want to use 396713a5695bSwdenk for the environment. 396813a5695bSwdenk 39690e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 39700e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 397113a5695bSwdenk 397213a5695bSwdenk These two #defines specify the offset and size of the environment 3973fdd813deSScott Wood area within the first NAND device. CONFIG_ENV_OFFSET must be 3974fdd813deSScott Wood aligned to an erase block boundary. 39755779d8d9Swdenk 3976fdd813deSScott Wood - CONFIG_ENV_OFFSET_REDUND (optional): 3977e443c944SMarkus Klotzbuecher 39780e8d1586SJean-Christophe PLAGNIOL-VILLARD This setting describes a second storage area of CONFIG_ENV_SIZE 3979fdd813deSScott Wood size used to hold a redundant copy of the environment data, so 3980fdd813deSScott Wood that there is a valid backup copy in case there is a power failure 3981fdd813deSScott Wood during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be 3982fdd813deSScott Wood aligned to an erase block boundary. 3983e443c944SMarkus Klotzbuecher 3984fdd813deSScott Wood - CONFIG_ENV_RANGE (optional): 3985fdd813deSScott Wood 3986fdd813deSScott Wood Specifies the length of the region in which the environment 3987fdd813deSScott Wood can be written. This should be a multiple of the NAND device's 3988fdd813deSScott Wood block size. Specifying a range with more erase blocks than 3989fdd813deSScott Wood are needed to hold CONFIG_ENV_SIZE allows bad blocks within 3990fdd813deSScott Wood the range to be avoided. 3991fdd813deSScott Wood 3992fdd813deSScott Wood - CONFIG_ENV_OFFSET_OOB (optional): 3993fdd813deSScott Wood 3994fdd813deSScott Wood Enables support for dynamically retrieving the offset of the 3995fdd813deSScott Wood environment from block zero's out-of-band data. The 3996fdd813deSScott Wood "nand env.oob" command can be used to record this offset. 3997fdd813deSScott Wood Currently, CONFIG_ENV_OFFSET_REDUND is not supported when 3998fdd813deSScott Wood using CONFIG_ENV_OFFSET_OOB. 3999e443c944SMarkus Klotzbuecher 4000b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST 4001b74ab737SGuennadi Liakhovetski 4002b74ab737SGuennadi Liakhovetski Defines address in RAM to which the nand_spl code should copy the 4003b74ab737SGuennadi Liakhovetski environment. If redundant environment is used, it will be copied to 4004b74ab737SGuennadi Liakhovetski CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE. 4005b74ab737SGuennadi Liakhovetski 40062b74433fSJoe Hershberger- CONFIG_ENV_IS_IN_UBI: 40072b74433fSJoe Hershberger 40082b74433fSJoe Hershberger Define this if you have an UBI volume that you want to use for the 40092b74433fSJoe Hershberger environment. This has the benefit of wear-leveling the environment 40102b74433fSJoe Hershberger accesses, which is important on NAND. 40112b74433fSJoe Hershberger 40122b74433fSJoe Hershberger - CONFIG_ENV_UBI_PART: 40132b74433fSJoe Hershberger 40142b74433fSJoe Hershberger Define this to a string that is the mtd partition containing the UBI. 40152b74433fSJoe Hershberger 40162b74433fSJoe Hershberger - CONFIG_ENV_UBI_VOLUME: 40172b74433fSJoe Hershberger 40182b74433fSJoe Hershberger Define this to the name of the volume that you want to store the 40192b74433fSJoe Hershberger environment in. 40202b74433fSJoe Hershberger 4021785881f7SJoe Hershberger - CONFIG_ENV_UBI_VOLUME_REDUND: 4022785881f7SJoe Hershberger 4023785881f7SJoe Hershberger Define this to the name of another volume to store a second copy of 4024785881f7SJoe Hershberger the environment in. This will enable redundant environments in UBI. 4025785881f7SJoe Hershberger It is assumed that both volumes are in the same MTD partition. 4026785881f7SJoe Hershberger 40272b74433fSJoe Hershberger - CONFIG_UBI_SILENCE_MSG 40282b74433fSJoe Hershberger - CONFIG_UBIFS_SILENCE_MSG 40292b74433fSJoe Hershberger 40302b74433fSJoe Hershberger You will probably want to define these to avoid a really noisy system 40312b74433fSJoe Hershberger when storing the env in UBI. 40322b74433fSJoe Hershberger 403306e4ae5fSStephen Warren- CONFIG_ENV_IS_IN_MMC: 403406e4ae5fSStephen Warren 403506e4ae5fSStephen Warren Define this if you have an MMC device which you want to use for the 403606e4ae5fSStephen Warren environment. 403706e4ae5fSStephen Warren 403806e4ae5fSStephen Warren - CONFIG_SYS_MMC_ENV_DEV: 403906e4ae5fSStephen Warren 404006e4ae5fSStephen Warren Specifies which MMC device the environment is stored in. 404106e4ae5fSStephen Warren 404206e4ae5fSStephen Warren - CONFIG_SYS_MMC_ENV_PART (optional): 404306e4ae5fSStephen Warren 404406e4ae5fSStephen Warren Specifies which MMC partition the environment is stored in. If not 404506e4ae5fSStephen Warren set, defaults to partition 0, the user area. Common values might be 404606e4ae5fSStephen Warren 1 (first MMC boot partition), 2 (second MMC boot partition). 404706e4ae5fSStephen Warren 404806e4ae5fSStephen Warren - CONFIG_ENV_OFFSET: 404906e4ae5fSStephen Warren - CONFIG_ENV_SIZE: 405006e4ae5fSStephen Warren 405106e4ae5fSStephen Warren These two #defines specify the offset and size of the environment 405206e4ae5fSStephen Warren area within the specified MMC device. 405306e4ae5fSStephen Warren 40545c088ee8SStephen Warren If offset is positive (the usual case), it is treated as relative to 40555c088ee8SStephen Warren the start of the MMC partition. If offset is negative, it is treated 40565c088ee8SStephen Warren as relative to the end of the MMC partition. This can be useful if 40575c088ee8SStephen Warren your board may be fitted with different MMC devices, which have 40585c088ee8SStephen Warren different sizes for the MMC partitions, and you always want the 40595c088ee8SStephen Warren environment placed at the very end of the partition, to leave the 40605c088ee8SStephen Warren maximum possible space before it, to store other data. 40615c088ee8SStephen Warren 406206e4ae5fSStephen Warren These two values are in units of bytes, but must be aligned to an 406306e4ae5fSStephen Warren MMC sector boundary. 406406e4ae5fSStephen Warren 406506e4ae5fSStephen Warren - CONFIG_ENV_OFFSET_REDUND (optional): 406606e4ae5fSStephen Warren 406706e4ae5fSStephen Warren Specifies a second storage area, of CONFIG_ENV_SIZE size, used to 406806e4ae5fSStephen Warren hold a redundant copy of the environment data. This provides a 406906e4ae5fSStephen Warren valid backup copy in case the other copy is corrupted, e.g. due 407006e4ae5fSStephen Warren to a power failure during a "saveenv" operation. 407106e4ae5fSStephen Warren 40725c088ee8SStephen Warren This value may also be positive or negative; this is handled in the 40735c088ee8SStephen Warren same way as CONFIG_ENV_OFFSET. 40745c088ee8SStephen Warren 407506e4ae5fSStephen Warren This value is also in units of bytes, but must also be aligned to 407606e4ae5fSStephen Warren an MMC sector boundary. 407706e4ae5fSStephen Warren 407806e4ae5fSStephen Warren - CONFIG_ENV_SIZE_REDUND (optional): 407906e4ae5fSStephen Warren 408006e4ae5fSStephen Warren This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is 408106e4ae5fSStephen Warren set. If this value is set, it must be set to the same value as 408206e4ae5fSStephen Warren CONFIG_ENV_SIZE. 408306e4ae5fSStephen Warren 40846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET 4085c609719bSwdenk 4086c609719bSwdenk Defines offset to the initial SPI buffer area in DPRAM. The 4087c609719bSwdenk area is used at an early stage (ROM part) if the environment 4088c609719bSwdenk is configured to reside in the SPI EEPROM: We need a 520 byte 4089c609719bSwdenk scratch DPRAM area. It is used between the two initialization 4090c609719bSwdenk calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems 4091c609719bSwdenk to be a good choice since it makes it far enough from the 4092c609719bSwdenk start of the data area as well as from the stack pointer. 4093c609719bSwdenk 4094e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor 4095c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been 4096cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f() 4097c609719bSwdenkuntil then to read environment variables. 4098c609719bSwdenk 409985ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor 410085ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working 410185ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is 410285ec0bccSwdenknecessary, because the first environment variable we need is the 410385ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't 410485ec0bccSwdenkhave any device yet where we could complain.] 4105c609719bSwdenk 4106c609719bSwdenkNote: once the monitor has been relocated, then it will complain if 4107c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you 410885ec0bccSwdenkuse the "saveenv" command to store a valid environment. 4109c609719bSwdenk 41106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN: 4111fc3e2165Swdenk Echo the inverted Ethernet link state to the fault LED. 4112fc3e2165Swdenk 41136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR 4114fc3e2165Swdenk also needs to be defined. 4115fc3e2165Swdenk 41166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR: 4117fc3e2165Swdenk MII address of the PHY to check for the Ethernet link state. 4118c609719bSwdenk 4119f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS: 4120f5675aa5SRon Madrid Define this if you desire to only have use of the NS16550_init 4121f5675aa5SRon Madrid and NS16550_putc functions for the serial driver located at 4122f5675aa5SRon Madrid drivers/serial/ns16550.c. This option is useful for saving 4123f5675aa5SRon Madrid space for already greatly restricted images, including but not 4124f5675aa5SRon Madrid limited to NAND_SPL configurations. 4125f5675aa5SRon Madrid 4126b2b92f53SSimon Glass- CONFIG_DISPLAY_BOARDINFO 4127b2b92f53SSimon Glass Display information about the board that U-Boot is running on 4128b2b92f53SSimon Glass when U-Boot starts up. The board function checkboard() is called 4129b2b92f53SSimon Glass to do this. 4130b2b92f53SSimon Glass 4131e2e3e2b1SSimon Glass- CONFIG_DISPLAY_BOARDINFO_LATE 4132e2e3e2b1SSimon Glass Similar to the previous option, but display this information 4133e2e3e2b1SSimon Glass later, once stdio is running and output goes to the LCD, if 4134e2e3e2b1SSimon Glass present. 4135e2e3e2b1SSimon Glass 4136c609719bSwdenkLow Level (hardware related) configuration options: 4137dc7c9a1aSwdenk--------------------------------------------------- 4138c609719bSwdenk 41396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE: 4140c609719bSwdenk Cache Line Size of the CPU. 4141c609719bSwdenk 41426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR: 4143c609719bSwdenk Default address of the IMMR after system reset. 41442535d602Swdenk 41452535d602Swdenk Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU, 41462535d602Swdenk and RPXsuper) to be able to adjust the position of 41472535d602Swdenk the IMMR register after a reset. 4148c609719bSwdenk 4149e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT: 4150e46fedfeSTimur Tabi Default (power-on reset) physical address of CCSR on Freescale 4151e46fedfeSTimur Tabi PowerPC SOCs. 4152e46fedfeSTimur Tabi 4153e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR: 4154e46fedfeSTimur Tabi Virtual address of CCSR. On a 32-bit build, this is typically 4155e46fedfeSTimur Tabi the same value as CONFIG_SYS_CCSRBAR_DEFAULT. 4156e46fedfeSTimur Tabi 4157e46fedfeSTimur Tabi CONFIG_SYS_DEFAULT_IMMR must also be set to this value, 4158e46fedfeSTimur Tabi for cross-platform code that uses that macro instead. 4159e46fedfeSTimur Tabi 4160e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS: 4161e46fedfeSTimur Tabi Physical address of CCSR. CCSR can be relocated to a new 4162e46fedfeSTimur Tabi physical address, if desired. In this case, this macro should 4163e46fedfeSTimur Tabi be set to that address. Otherwise, it should be set to the 4164e46fedfeSTimur Tabi same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR 4165e46fedfeSTimur Tabi is typically relocated on 36-bit builds. It is recommended 4166e46fedfeSTimur Tabi that this macro be defined via the _HIGH and _LOW macros: 4167e46fedfeSTimur Tabi 4168e46fedfeSTimur Tabi #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH 4169e46fedfeSTimur Tabi * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW) 4170e46fedfeSTimur Tabi 4171e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH: 4172e46fedfeSTimur Tabi Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically 4173e46fedfeSTimur Tabi either 0 (32-bit build) or 0xF (36-bit build). This macro is 4174e46fedfeSTimur Tabi used in assembly code, so it must not contain typecasts or 4175e46fedfeSTimur Tabi integer size suffixes (e.g. "ULL"). 4176e46fedfeSTimur Tabi 4177e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW: 4178e46fedfeSTimur Tabi Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is 4179e46fedfeSTimur Tabi used in assembly code, so it must not contain typecasts or 4180e46fedfeSTimur Tabi integer size suffixes (e.g. "ULL"). 4181e46fedfeSTimur Tabi 4182e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE: 4183e46fedfeSTimur Tabi If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be 4184e46fedfeSTimur Tabi forced to a value that ensures that CCSR is not relocated. 4185e46fedfeSTimur Tabi 41867f6c2cbcSwdenk- Floppy Disk Support: 41876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FDC_DRIVE_NUMBER 41887f6c2cbcSwdenk 41897f6c2cbcSwdenk the default drive number (default value 0) 41907f6c2cbcSwdenk 41916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_ISA_IO_STRIDE 41927f6c2cbcSwdenk 419311ccc33fSMarcel Ziswiler defines the spacing between FDC chipset registers 41947f6c2cbcSwdenk (default value 1) 41957f6c2cbcSwdenk 41966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_ISA_IO_OFFSET 41977f6c2cbcSwdenk 41987f6c2cbcSwdenk defines the offset of register from address. It 41997f6c2cbcSwdenk depends on which part of the data bus is connected to 420011ccc33fSMarcel Ziswiler the FDC chipset. (default value 0) 42017f6c2cbcSwdenk 42026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and 42036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their 42047f6c2cbcSwdenk default value. 42057f6c2cbcSwdenk 42066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD if CONFIG_SYS_FDC_HW_INIT is defined, then the function 42077f6c2cbcSwdenk fdc_hw_init() is called at the beginning of the FDC 42087f6c2cbcSwdenk setup. fdc_hw_init() must be provided by the board 42097f6c2cbcSwdenk source code. It is used to make hardware dependant 42107f6c2cbcSwdenk initializations. 42117f6c2cbcSwdenk 42120abddf82SMacpaul Lin- CONFIG_IDE_AHB: 42130abddf82SMacpaul Lin Most IDE controllers were designed to be connected with PCI 42140abddf82SMacpaul Lin interface. Only few of them were designed for AHB interface. 42150abddf82SMacpaul Lin When software is doing ATA command and data transfer to 42160abddf82SMacpaul Lin IDE devices through IDE-AHB controller, some additional 42170abddf82SMacpaul Lin registers accessing to these kind of IDE-AHB controller 42180abddf82SMacpaul Lin is requierd. 42190abddf82SMacpaul Lin 42206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR: Physical address of the Internal Memory. 422125d6712aSwdenk DO NOT CHANGE unless you know exactly what you're 422225d6712aSwdenk doing! (11-4) [MPC8xx/82xx systems only] 4223c609719bSwdenk 42246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR: 4225c609719bSwdenk 42267152b1d0Swdenk Start address of memory area that can be used for 4227c609719bSwdenk initial data and stack; please note that this must be 4228c609719bSwdenk writable memory that is working WITHOUT special 4229c609719bSwdenk initialization, i. e. you CANNOT use normal RAM which 4230c609719bSwdenk will become available only after programming the 4231c609719bSwdenk memory controller and running certain initialization 4232c609719bSwdenk sequences. 4233c609719bSwdenk 4234c609719bSwdenk U-Boot uses the following memory types: 4235c609719bSwdenk - MPC8xx and MPC8260: IMMR (internal memory of the CPU) 4236c609719bSwdenk - MPC824X: data cache 4237c609719bSwdenk - PPC4xx: data cache 4238c609719bSwdenk 42396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET: 4240c609719bSwdenk 4241c609719bSwdenk Offset of the initial data structure in the memory 42426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually 42436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial 4244c609719bSwdenk data is located at the end of the available space 4245553f0982SWolfgang Denk (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE - 42466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just 42476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR + 42486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_GBL_DATA_OFFSET) downward. 4249c609719bSwdenk 4250c609719bSwdenk Note: 4251c609719bSwdenk On the MPC824X (or other systems that use the data 4252c609719bSwdenk cache for initial memory) the address chosen for 42536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must 4254c609719bSwdenk point to an otherwise UNUSED address space between 4255c609719bSwdenk the top of RAM and the start of the PCI space. 4256c609719bSwdenk 42576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6) 4258c609719bSwdenk 42596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR: System Protection Control (11-9) 4260c609719bSwdenk 42616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26) 4262c609719bSwdenk 42636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31) 4264c609719bSwdenk 42656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30) 4266c609719bSwdenk 42676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27) 4268c609719bSwdenk 42696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM: 4270c609719bSwdenk SDRAM timing 4271c609719bSwdenk 42726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA: 4273c609719bSwdenk periodic timer for refresh 4274c609719bSwdenk 42756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER: Debug Event Register (37-47) 4276c609719bSwdenk 42776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM, 42786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP, 42796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM, 42806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BR1_PRELIM: 4281c609719bSwdenk Memory Controller Definitions: BR0/1 and OR0/1 (FLASH) 4282c609719bSwdenk 4283c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE, 42846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM, 42856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM: 4286c609719bSwdenk Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM) 4287c609719bSwdenk 42886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K, 42896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL: 4290c609719bSwdenk Machine Mode Register and Memory Periodic Timer 4291c609719bSwdenk Prescaler definitions (SDRAM timing) 4292c609719bSwdenk 42936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]: 4294c609719bSwdenk enable I2C microcode relocation patch (MPC8xx); 4295c609719bSwdenk define relocation offset in DPRAM [DSP2] 4296c609719bSwdenk 42976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]: 4298b423d055SHeiko Schocher enable SMC microcode relocation patch (MPC8xx); 4299b423d055SHeiko Schocher define relocation offset in DPRAM [SMC1] 4300b423d055SHeiko Schocher 43016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]: 4302c609719bSwdenk enable SPI microcode relocation patch (MPC8xx); 4303c609719bSwdenk define relocation offset in DPRAM [SCC4] 4304c609719bSwdenk 43056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK: 4306c609719bSwdenk Use OSCM clock mode on MBX8xx board. Be careful, 4307c609719bSwdenk wrong setting might damage your board. Read 4308c609719bSwdenk doc/README.MBX before setting this variable! 4309c609719bSwdenk 43106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only) 4311ea909b76Swdenk Offset of the bootmode word in DPRAM used by post 4312ea909b76Swdenk (Power On Self Tests). This definition overrides 4313ea909b76Swdenk #define'd default value in commproc.h resp. 4314ea909b76Swdenk cpm_8260.h. 4315ea909b76Swdenk 43166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB, 43176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL, 43186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS, 43196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB, 43206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START, 43216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL, 43226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE, 43236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only) 4324a47a12beSStefan Roese Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set. 43255d232d0eSwdenk 43269cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE: 43279cacf4fcSDirk Eibach Disable PCI-Express on systems where it is supported but not 43289cacf4fcSDirk Eibach required. 43299cacf4fcSDirk Eibach 433069fd2d3bSAndrew Sharp- CONFIG_PCI_ENUM_ONLY 433169fd2d3bSAndrew Sharp Only scan through and get the devices on the busses. 433269fd2d3bSAndrew Sharp Don't do any setup work, presumably because someone or 433369fd2d3bSAndrew Sharp something has already done it, and we don't need to do it 433469fd2d3bSAndrew Sharp a second time. Useful for platforms that are pre-booted 433569fd2d3bSAndrew Sharp by coreboot or similar. 433669fd2d3bSAndrew Sharp 4337842033e6SGabor Juhos- CONFIG_PCI_INDIRECT_BRIDGE: 4338842033e6SGabor Juhos Enable support for indirect PCI bridges. 4339842033e6SGabor Juhos 4340a09b9b68SKumar Gala- CONFIG_SYS_SRIO: 4341a09b9b68SKumar Gala Chip has SRIO or not 4342a09b9b68SKumar Gala 4343a09b9b68SKumar Gala- CONFIG_SRIO1: 4344a09b9b68SKumar Gala Board has SRIO 1 port available 4345a09b9b68SKumar Gala 4346a09b9b68SKumar Gala- CONFIG_SRIO2: 4347a09b9b68SKumar Gala Board has SRIO 2 port available 4348a09b9b68SKumar Gala 4349c8b28152SLiu Gang- CONFIG_SRIO_PCIE_BOOT_MASTER 4350c8b28152SLiu Gang Board can support master function for Boot from SRIO and PCIE 4351c8b28152SLiu Gang 4352a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT: 4353a09b9b68SKumar Gala Virtual Address of SRIO port 'n' memory region 4354a09b9b68SKumar Gala 4355a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS: 4356a09b9b68SKumar Gala Physical Address of SRIO port 'n' memory region 4357a09b9b68SKumar Gala 4358a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE: 4359a09b9b68SKumar Gala Size of SRIO port 'n' memory region 4360a09b9b68SKumar Gala 436166bd1846SFabio Estevam- CONFIG_SYS_NAND_BUSWIDTH_16BIT 436266bd1846SFabio Estevam Defined to tell the NAND controller that the NAND chip is using 436366bd1846SFabio Estevam a 16 bit bus. 436466bd1846SFabio Estevam Not all NAND drivers use this symbol. 4365a430e916SFabio Estevam Example of drivers that use it: 436666bd1846SFabio Estevam - drivers/mtd/nand/ndfc.c 4367a430e916SFabio Estevam - drivers/mtd/nand/mxc_nand.c 4368eced4626SAlex Waterman 4369eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG 4370eced4626SAlex Waterman Sets the EBC0_CFG register for the NDFC. If not defined 4371eced4626SAlex Waterman a default value will be used. 4372eced4626SAlex Waterman 4373bb99ad6dSBen Warren- CONFIG_SPD_EEPROM 4374218ca724SWolfgang Denk Get DDR timing information from an I2C EEPROM. Common 4375218ca724SWolfgang Denk with pluggable memory modules such as SODIMMs 4376218ca724SWolfgang Denk 4377bb99ad6dSBen Warren SPD_EEPROM_ADDRESS 4378bb99ad6dSBen Warren I2C address of the SPD EEPROM 4379bb99ad6dSBen Warren 43806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM 4381218ca724SWolfgang Denk If SPD EEPROM is on an I2C bus other than the first 4382218ca724SWolfgang Denk one, specify here. Note that the value must resolve 4383218ca724SWolfgang Denk to something your driver can deal with. 4384bb99ad6dSBen Warren 43851b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING 43861b3e3c4fSYork Sun Get DDR timing information from other than SPD. Common with 43871b3e3c4fSYork Sun soldered DDR chips onboard without SPD. DDR raw timing 43881b3e3c4fSYork Sun parameters are extracted from datasheet and hard-coded into 43891b3e3c4fSYork Sun header files or board specific files. 43901b3e3c4fSYork Sun 43916f5e1dc5SYork Sun- CONFIG_FSL_DDR_INTERACTIVE 43926f5e1dc5SYork Sun Enable interactive DDR debugging. See doc/README.fsl-ddr. 43936f5e1dc5SYork Sun 43946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0 4395218ca724SWolfgang Denk Only for 83xx systems. If specified, then DDR should 4396218ca724SWolfgang Denk be configured using CS0 and CS1 instead of CS2 and CS3. 43972ad6b513STimur Tabi 4398c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12] 4399c26e454dSwdenk Define to enable FEC[12] on a 8xx series processor. 4400c26e454dSwdenk 4401c26e454dSwdenk- CONFIG_FEC[12]_PHY 4402c26e454dSwdenk Define to the hardcoded PHY address which corresponds 44036e592385Swdenk to the given FEC; i. e. 4404c26e454dSwdenk #define CONFIG_FEC1_PHY 4 4405c26e454dSwdenk means that the PHY with address 4 is connected to FEC1 4406c26e454dSwdenk 4407c26e454dSwdenk When set to -1, means to probe for first available. 4408c26e454dSwdenk 4409c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR 4410c26e454dSwdenk The PHY does not have a RXERR line (RMII only). 4411c26e454dSwdenk (so program the FEC to ignore it). 4412c26e454dSwdenk 4413c26e454dSwdenk- CONFIG_RMII 4414c26e454dSwdenk Enable RMII mode for all FECs. 4415c26e454dSwdenk Note that this is a global option, we can't 4416c26e454dSwdenk have one FEC in standard MII mode and another in RMII mode. 4417c26e454dSwdenk 44185cf91d6bSwdenk- CONFIG_CRC32_VERIFY 44195cf91d6bSwdenk Add a verify option to the crc32 command. 44205cf91d6bSwdenk The syntax is: 44215cf91d6bSwdenk 44225cf91d6bSwdenk => crc32 -v <address> <count> <crc32> 44235cf91d6bSwdenk 44245cf91d6bSwdenk Where address/count indicate a memory area 44255cf91d6bSwdenk and crc32 is the correct crc32 which the 44265cf91d6bSwdenk area should have. 44275cf91d6bSwdenk 442856523f12Swdenk- CONFIG_LOOPW 442956523f12Swdenk Add the "loopw" memory command. This only takes effect if 4430602ad3b3SJon Loeliger the memory commands are activated globally (CONFIG_CMD_MEM). 443156523f12Swdenk 44327b466641Sstroese- CONFIG_MX_CYCLIC 44337b466641Sstroese Add the "mdc" and "mwc" memory commands. These are cyclic 44347b466641Sstroese "md/mw" commands. 44357b466641Sstroese Examples: 44367b466641Sstroese 44377b466641Sstroese => mdc.b 10 4 500 44387b466641Sstroese This command will print 4 bytes (10,11,12,13) each 500 ms. 44397b466641Sstroese 44407b466641Sstroese => mwc.l 100 12345678 10 44417b466641Sstroese This command will write 12345678 to address 100 all 10 ms. 44427b466641Sstroese 44437b466641Sstroese This only takes effect if the memory commands are activated 4444602ad3b3SJon Loeliger globally (CONFIG_CMD_MEM). 44457b466641Sstroese 44468aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT 4447afc1ce82SMacpaul Lin [ARM, NDS32, MIPS only] If this variable is defined, then certain 4448e03f3169SWolfgang Denk low level initializations (like setting up the memory 4449e03f3169SWolfgang Denk controller) are omitted and/or U-Boot does not 4450e03f3169SWolfgang Denk relocate itself into RAM. 44518aa1a2d1Swdenk 4452e03f3169SWolfgang Denk Normally this variable MUST NOT be defined. The only 4453e03f3169SWolfgang Denk exception is when U-Boot is loaded (to RAM) by some 4454e03f3169SWolfgang Denk other boot loader or by a debugger which performs 4455e03f3169SWolfgang Denk these initializations itself. 44568aa1a2d1Swdenk 4457401bb30bSAneesh V- CONFIG_SPL_BUILD 4458df81238bSMagnus Lilja Modifies the behaviour of start.S when compiling a loader 4459df81238bSMagnus Lilja that is executed before the actual U-Boot. E.g. when 4460df81238bSMagnus Lilja compiling a NAND SPL. 4461400558b5Swdenk 44623aa29de0SYing Zhang- CONFIG_TPL_BUILD 44633aa29de0SYing Zhang Modifies the behaviour of start.S when compiling a loader 44643aa29de0SYing Zhang that is executed after the SPL and before the actual U-Boot. 44653aa29de0SYing Zhang It is loaded by the SPL. 44663aa29de0SYing Zhang 44675df572f0SYing Zhang- CONFIG_SYS_MPC85XX_NO_RESETVEC 44685df572f0SYing Zhang Only for 85xx systems. If this variable is specified, the section 44695df572f0SYing Zhang .resetvec is not kept and the section .bootpg is placed in the 44705df572f0SYing Zhang previous 4k of the .text section. 44715df572f0SYing Zhang 44724213fc29SSimon Glass- CONFIG_ARCH_MAP_SYSMEM 44734213fc29SSimon Glass Generally U-Boot (and in particular the md command) uses 44744213fc29SSimon Glass effective address. It is therefore not necessary to regard 44754213fc29SSimon Glass U-Boot address as virtual addresses that need to be translated 44764213fc29SSimon Glass to physical addresses. However, sandbox requires this, since 44774213fc29SSimon Glass it maintains its own little RAM buffer which contains all 44784213fc29SSimon Glass addressable memory. This option causes some memory accesses 44794213fc29SSimon Glass to be mapped through map_sysmem() / unmap_sysmem(). 44804213fc29SSimon Glass 4481d8834a13SMatthias Weisser- CONFIG_USE_ARCH_MEMCPY 4482d8834a13SMatthias Weisser CONFIG_USE_ARCH_MEMSET 4483d8834a13SMatthias Weisser If these options are used a optimized version of memcpy/memset will 4484d8834a13SMatthias Weisser be used if available. These functions may be faster under some 4485d8834a13SMatthias Weisser conditions but may increase the binary size. 4486d8834a13SMatthias Weisser 4487588a13f7SSimon Glass- CONFIG_X86_RESET_VECTOR 4488588a13f7SSimon Glass If defined, the x86 reset vector code is included. This is not 4489588a13f7SSimon Glass needed when U-Boot is running from Coreboot. 4490b16f521aSGabe Black 4491fc33705eSMark Jackson- CONFIG_SYS_MPUCLK 4492fc33705eSMark Jackson Defines the MPU clock speed (in MHz). 4493fc33705eSMark Jackson 4494fc33705eSMark Jackson NOTE : currently only supported on AM335x platforms. 44955b5ece9eSGabe Black 449616678eb4SHeiko Schocher- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC: 449716678eb4SHeiko Schocher Enables the RTC32K OSC on AM33xx based plattforms 449816678eb4SHeiko Schocher 4499*999d7d32SKaricheri, Muralidharan- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE 4500*999d7d32SKaricheri, Muralidharan Option to disable subpage write in NAND driver 4501*999d7d32SKaricheri, Muralidharan driver that uses this: 4502*999d7d32SKaricheri, Muralidharan drivers/mtd/nand/davinci_nand.c 4503*999d7d32SKaricheri, Muralidharan 4504f2717b47STimur TabiFreescale QE/FMAN Firmware Support: 4505f2717b47STimur Tabi----------------------------------- 4506f2717b47STimur Tabi 4507f2717b47STimur TabiThe Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the 4508f2717b47STimur Tabiloading of "firmware", which is encoded in the QE firmware binary format. 4509f2717b47STimur TabiThis firmware often needs to be loaded during U-Boot booting, so macros 4510f2717b47STimur Tabiare used to identify the storage device (NOR flash, SPI, etc) and the address 4511f2717b47STimur Tabiwithin that device. 4512f2717b47STimur Tabi 4513f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_ADDR 4514f2717b47STimur Tabi The address in the storage device where the firmware is located. The 4515f2717b47STimur Tabi meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro 4516f2717b47STimur Tabi is also specified. 4517f2717b47STimur Tabi 4518f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_LENGTH 4519f2717b47STimur Tabi The maximum possible size of the firmware. The firmware binary format 4520f2717b47STimur Tabi has a field that specifies the actual size of the firmware, but it 4521f2717b47STimur Tabi might not be possible to read any part of the firmware unless some 4522f2717b47STimur Tabi local storage is allocated to hold the entire firmware first. 4523f2717b47STimur Tabi 4524f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NOR 4525f2717b47STimur Tabi Specifies that QE/FMAN firmware is located in NOR flash, mapped as 4526f2717b47STimur Tabi normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the 4527f2717b47STimur Tabi virtual address in NOR flash. 4528f2717b47STimur Tabi 4529f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NAND 4530f2717b47STimur Tabi Specifies that QE/FMAN firmware is located in NAND flash. 4531f2717b47STimur Tabi CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash. 4532f2717b47STimur Tabi 4533f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_MMC 4534f2717b47STimur Tabi Specifies that QE/FMAN firmware is located on the primary SD/MMC 4535f2717b47STimur Tabi device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device. 4536f2717b47STimur Tabi 4537f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH 4538f2717b47STimur Tabi Specifies that QE/FMAN firmware is located on the primary SPI 4539f2717b47STimur Tabi device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device. 4540f2717b47STimur Tabi 4541292dc6c5SLiu Gang- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE 4542292dc6c5SLiu Gang Specifies that QE/FMAN firmware is located in the remote (master) 4543292dc6c5SLiu Gang memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which 4544fc54c7faSLiu Gang can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound 4545fc54c7faSLiu Gang window->master inbound window->master LAW->the ucode address in 4546fc54c7faSLiu Gang master's memory space. 4547f2717b47STimur Tabi 4548c609719bSwdenkBuilding the Software: 4549c609719bSwdenk====================== 4550c609719bSwdenk 4551218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments 4552218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support 4553218ca724SWolfgang Denkall possibly existing versions of cross development tools in all 4554218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we 4555218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK) 4556218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot. 4557c609719bSwdenk 4558218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you 4559218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case, 4560218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell. 4561218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are 4562218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter: 4563c609719bSwdenk 4564218ca724SWolfgang Denk $ CROSS_COMPILE=ppc_4xx- 4565218ca724SWolfgang Denk $ export CROSS_COMPILE 4566c609719bSwdenk 45672f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in 45682f8d396bSPeter Tyser the tools directory you can use the MinGW toolchain 45692f8d396bSPeter Tyser (http://www.mingw.org). Set your HOST tools to the MinGW 45702f8d396bSPeter Tyser toolchain and execute 'make tools'. For example: 45712f8d396bSPeter Tyser 45722f8d396bSPeter Tyser $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools 45732f8d396bSPeter Tyser 45742f8d396bSPeter Tyser Binaries such as tools/mkimage.exe will be created which can 45752f8d396bSPeter Tyser be executed on computers running Windows. 45762f8d396bSPeter Tyser 4577c609719bSwdenkU-Boot is intended to be simple to build. After installing the 4578c609719bSwdenksources you must configure U-Boot for one specific board type. This 4579c609719bSwdenkis done by typing: 4580c609719bSwdenk 4581c609719bSwdenk make NAME_config 4582c609719bSwdenk 4583218ca724SWolfgang Denkwhere "NAME_config" is the name of one of the existing configu- 45844d675ae6SMichael Jonesrations; see boards.cfg for supported names. 458554387ac9Swdenk 4586c609719bSwdenkNote: for some board special configuration names may exist; check if 4587c609719bSwdenk additional information is available from the board vendor; for 45882729af9dSwdenk instance, the TQM823L systems are available without (standard) 45892729af9dSwdenk or with LCD support. You can select such additional "features" 459011ccc33fSMarcel Ziswiler when choosing the configuration, i. e. 4591c609719bSwdenk 45922729af9dSwdenk make TQM823L_config 45932729af9dSwdenk - will configure for a plain TQM823L, i. e. no LCD support 4594c609719bSwdenk 4595c609719bSwdenk make TQM823L_LCD_config 4596c609719bSwdenk - will configure for a TQM823L with U-Boot console on LCD 4597c609719bSwdenk 4598c609719bSwdenk etc. 4599c609719bSwdenk 4600c609719bSwdenk 4601c609719bSwdenkFinally, type "make all", and you should get some working U-Boot 46027152b1d0Swdenkimages ready for download to / installation on your system: 4603c609719bSwdenk 4604c609719bSwdenk- "u-boot.bin" is a raw binary image 4605c609719bSwdenk- "u-boot" is an image in ELF binary format 4606c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format 4607c609719bSwdenk 4608baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved 4609baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change 4610baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory: 4611baf31249SMarian Balakowicz 4612baf31249SMarian Balakowicz1. Add O= to the make command line invocations: 4613baf31249SMarian Balakowicz 4614baf31249SMarian Balakowicz make O=/tmp/build distclean 4615baf31249SMarian Balakowicz make O=/tmp/build NAME_config 4616baf31249SMarian Balakowicz make O=/tmp/build all 4617baf31249SMarian Balakowicz 4618baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location: 4619baf31249SMarian Balakowicz 4620baf31249SMarian Balakowicz export BUILD_DIR=/tmp/build 4621baf31249SMarian Balakowicz make distclean 4622baf31249SMarian Balakowicz make NAME_config 4623baf31249SMarian Balakowicz make all 4624baf31249SMarian Balakowicz 4625baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment 4626baf31249SMarian Balakowiczvariable. 4627baf31249SMarian Balakowicz 4628c609719bSwdenk 4629c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so 4630c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of 4631c609719bSwdenknative "make". 4632c609719bSwdenk 4633c609719bSwdenk 4634c609719bSwdenkIf the system board that you have is not listed, then you will need 4635c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these 4636c609719bSwdenksteps: 4637c609719bSwdenk 4638c609719bSwdenk1. Add a new configuration option for your board to the toplevel 46394d675ae6SMichael Jones "boards.cfg" file, using the existing entries as examples. 46404d675ae6SMichael Jones Follow the instructions there to keep the boards in order. 4641c609719bSwdenk2. Create a new directory to hold your board specific code. Add any 464285ec0bccSwdenk files you need. In your board directory, you will need at least 464385ec0bccSwdenk the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds". 464485ec0bccSwdenk3. Create a new configuration file "include/configs/<board>.h" for 464585ec0bccSwdenk your board 4646c609719bSwdenk3. If you're porting U-Boot to a new CPU, then also create a new 4647c609719bSwdenk directory to hold your CPU specific code. Add any files you need. 464885ec0bccSwdenk4. Run "make <board>_config" with your new name. 4649c609719bSwdenk5. Type "make", and you should get a working "u-boot.srec" file 4650c609719bSwdenk to be installed on your target system. 465185ec0bccSwdenk6. Debug and solve any problems that might arise. 4652c609719bSwdenk [Of course, this last step is much harder than it sounds.] 4653c609719bSwdenk 4654c609719bSwdenk 4655c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.: 4656c609719bSwdenk============================================================== 4657c609719bSwdenk 4658c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board 4659c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to 4660c609719bSwdenkprovide feedback to the other developers. The feedback normally takes 4661c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest 4662218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources. 4663c609719bSwdenk 4664c609719bSwdenkBut before you submit such a patch, please verify that your modifi- 4665c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of 4666c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so, 4667c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot 4668c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can 46697152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE' 4670218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools 4671218ca724SWolfgang Denkyou can type 4672c609719bSwdenk 4673c609719bSwdenk CROSS_COMPILE=ppc_8xx- MAKEALL 4674c609719bSwdenk 4675c609719bSwdenkor to build on a native PowerPC system you can type 4676c609719bSwdenk 4677c609719bSwdenk CROSS_COMPILE=' ' MAKEALL 4678c609719bSwdenk 4679218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build 4680218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by 4681218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target 4682218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and 4683218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default 4684218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment 4685218ca724SWolfgang Denkvariable. For example: 4686baf31249SMarian Balakowicz 4687baf31249SMarian Balakowicz export BUILD_DIR=/tmp/build 4688baf31249SMarian Balakowicz export MAKEALL_LOGDIR=/tmp/log 4689baf31249SMarian Balakowicz CROSS_COMPILE=ppc_8xx- MAKEALL 4690baf31249SMarian Balakowicz 4691218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build, 4692218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean 4693218ca724SWolfgang Denkduring the whole build process. 4694baf31249SMarian Balakowicz 4695baf31249SMarian Balakowicz 4696c609719bSwdenkSee also "U-Boot Porting Guide" below. 4697c609719bSwdenk 4698c609719bSwdenk 4699c609719bSwdenkMonitor Commands - Overview: 4700c609719bSwdenk============================ 4701c609719bSwdenk 4702c609719bSwdenkgo - start application at address 'addr' 4703c609719bSwdenkrun - run commands in an environment variable 4704c609719bSwdenkbootm - boot application image from memory 4705c609719bSwdenkbootp - boot image via network using BootP/TFTP protocol 470644f074c7SMarek Vasutbootz - boot zImage from memory 4707c609719bSwdenktftpboot- boot image via network using TFTP protocol 4708c609719bSwdenk and env variables "ipaddr" and "serverip" 4709c609719bSwdenk (and eventually "gatewayip") 47101fb7cd49SSimon Glasstftpput - upload a file via network using TFTP protocol 4711c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol 4712c609719bSwdenkdiskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd' 4713c609719bSwdenkloads - load S-Record file over serial line 4714c609719bSwdenkloadb - load binary file over serial line (kermit mode) 4715c609719bSwdenkmd - memory display 4716c609719bSwdenkmm - memory modify (auto-incrementing) 4717c609719bSwdenknm - memory modify (constant address) 4718c609719bSwdenkmw - memory write (fill) 4719c609719bSwdenkcp - memory copy 4720c609719bSwdenkcmp - memory compare 4721c609719bSwdenkcrc32 - checksum calculation 47220f89c54bSPeter Tyseri2c - I2C sub-system 4723c609719bSwdenksspi - SPI utility commands 4724c609719bSwdenkbase - print or set address offset 4725c609719bSwdenkprintenv- print environment variables 4726c609719bSwdenksetenv - set environment variables 4727c609719bSwdenksaveenv - save environment variables to persistent storage 4728c609719bSwdenkprotect - enable or disable FLASH write protection 4729c609719bSwdenkerase - erase FLASH memory 4730c609719bSwdenkflinfo - print FLASH memory information 473110635afaSKarl O. Pincnand - NAND memory operations (see doc/README.nand) 4732c609719bSwdenkbdinfo - print Board Info structure 4733c609719bSwdenkiminfo - print header information for application image 4734c609719bSwdenkconinfo - print console devices and informations 4735c609719bSwdenkide - IDE sub-system 4736c609719bSwdenkloop - infinite loop on address range 473756523f12Swdenkloopw - infinite write loop on address range 4738c609719bSwdenkmtest - simple RAM test 4739c609719bSwdenkicache - enable or disable instruction cache 4740c609719bSwdenkdcache - enable or disable data cache 4741c609719bSwdenkreset - Perform RESET of the CPU 4742c609719bSwdenkecho - echo args to console 4743c609719bSwdenkversion - print monitor version 4744c609719bSwdenkhelp - print online help 4745c609719bSwdenk? - alias for 'help' 4746c609719bSwdenk 4747c609719bSwdenk 4748c609719bSwdenkMonitor Commands - Detailed Description: 4749c609719bSwdenk======================================== 4750c609719bSwdenk 4751c609719bSwdenkTODO. 4752c609719bSwdenk 4753c609719bSwdenkFor now: just type "help <command>". 4754c609719bSwdenk 4755c609719bSwdenk 4756c609719bSwdenkEnvironment Variables: 4757c609719bSwdenk====================== 4758c609719bSwdenk 4759c609719bSwdenkU-Boot supports user configuration using Environment Variables which 4760c609719bSwdenkcan be made persistent by saving to Flash memory. 4761c609719bSwdenk 4762c609719bSwdenkEnvironment Variables are set using "setenv", printed using 4763c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv" 4764c609719bSwdenkwithout a value can be used to delete a variable from the 4765c609719bSwdenkenvironment. As long as you don't save the environment you are 4766c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the 4767c609719bSwdenkenvironment is erased by accident, a default environment is provided. 4768c609719bSwdenk 4769c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables. 4770c96f86eeSWolfgang Denk 4771c96f86eeSWolfgang DenkList of environment variables (most likely not complete): 4772c609719bSwdenk 4773c609719bSwdenk baudrate - see CONFIG_BAUDRATE 4774c609719bSwdenk 4775c609719bSwdenk bootdelay - see CONFIG_BOOTDELAY 4776c609719bSwdenk 4777c609719bSwdenk bootcmd - see CONFIG_BOOTCOMMAND 4778c609719bSwdenk 4779c609719bSwdenk bootargs - Boot arguments when booting an RTOS image 4780c609719bSwdenk 4781c609719bSwdenk bootfile - Name of the image to load with TFTP 4782c609719bSwdenk 47837d721e34SBartlomiej Sieka bootm_low - Memory range available for image processing in the bootm 47847d721e34SBartlomiej Sieka command can be restricted. This variable is given as 47857d721e34SBartlomiej Sieka a hexadecimal number and defines lowest address allowed 47867d721e34SBartlomiej Sieka for use by the bootm command. See also "bootm_size" 47877d721e34SBartlomiej Sieka environment variable. Address defined by "bootm_low" is 47887d721e34SBartlomiej Sieka also the base of the initial memory mapping for the Linux 4789c3624e6eSGrant Likely kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and 4790c3624e6eSGrant Likely bootm_mapsize. 4791c3624e6eSGrant Likely 4792c3624e6eSGrant Likely bootm_mapsize - Size of the initial memory mapping for the Linux kernel. 4793c3624e6eSGrant Likely This variable is given as a hexadecimal number and it 4794c3624e6eSGrant Likely defines the size of the memory region starting at base 4795c3624e6eSGrant Likely address bootm_low that is accessible by the Linux kernel 4796c3624e6eSGrant Likely during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used 4797c3624e6eSGrant Likely as the default value if it is defined, and bootm_size is 4798c3624e6eSGrant Likely used otherwise. 47997d721e34SBartlomiej Sieka 48007d721e34SBartlomiej Sieka bootm_size - Memory range available for image processing in the bootm 48017d721e34SBartlomiej Sieka command can be restricted. This variable is given as 48027d721e34SBartlomiej Sieka a hexadecimal number and defines the size of the region 48037d721e34SBartlomiej Sieka allowed for use by the bootm command. See also "bootm_low" 48047d721e34SBartlomiej Sieka environment variable. 48057d721e34SBartlomiej Sieka 48064bae9090SBartlomiej Sieka updatefile - Location of the software update file on a TFTP server, used 48074bae9090SBartlomiej Sieka by the automatic software update feature. Please refer to 48084bae9090SBartlomiej Sieka documentation in doc/README.update for more details. 48094bae9090SBartlomiej Sieka 4810c609719bSwdenk autoload - if set to "no" (any string beginning with 'n'), 4811c609719bSwdenk "bootp" will just load perform a lookup of the 4812c609719bSwdenk configuration from the BOOTP server, but not try to 4813c609719bSwdenk load any image using TFTP 4814c609719bSwdenk 4815c609719bSwdenk autostart - if set to "yes", an image loaded using the "bootp", 4816c609719bSwdenk "rarpboot", "tftpboot" or "diskboot" commands will 4817c609719bSwdenk be automatically started (by internally calling 4818c609719bSwdenk "bootm") 4819c609719bSwdenk 48204a6fd34bSwdenk If set to "no", a standalone image passed to the 48214a6fd34bSwdenk "bootm" command will be copied to the load address 48224a6fd34bSwdenk (and eventually uncompressed), but NOT be started. 48234a6fd34bSwdenk This can be used to load and uncompress arbitrary 48244a6fd34bSwdenk data. 48254a6fd34bSwdenk 4826a28afca5SDavid A. Long fdt_high - if set this restricts the maximum address that the 4827a28afca5SDavid A. Long flattened device tree will be copied into upon boot. 4828fa34f6b2SShawn Guo For example, if you have a system with 1 GB memory 4829fa34f6b2SShawn Guo at physical address 0x10000000, while Linux kernel 4830fa34f6b2SShawn Guo only recognizes the first 704 MB as low memory, you 4831fa34f6b2SShawn Guo may need to set fdt_high as 0x3C000000 to have the 4832fa34f6b2SShawn Guo device tree blob be copied to the maximum address 4833fa34f6b2SShawn Guo of the 704 MB low memory, so that Linux kernel can 4834fa34f6b2SShawn Guo access it during the boot procedure. 4835fa34f6b2SShawn Guo 4836a28afca5SDavid A. Long If this is set to the special value 0xFFFFFFFF then 4837a28afca5SDavid A. Long the fdt will not be copied at all on boot. For this 4838a28afca5SDavid A. Long to work it must reside in writable memory, have 4839a28afca5SDavid A. Long sufficient padding on the end of it for u-boot to 4840a28afca5SDavid A. Long add the information it needs into it, and the memory 4841a28afca5SDavid A. Long must be accessible by the kernel. 4842a28afca5SDavid A. Long 4843eea63e05SSimon Glass fdtcontroladdr- if set this is the address of the control flattened 4844eea63e05SSimon Glass device tree used by U-Boot when CONFIG_OF_CONTROL is 4845eea63e05SSimon Glass defined. 4846eea63e05SSimon Glass 484717ea1177Swdenk i2cfast - (PPC405GP|PPC405EP only) 484817ea1177Swdenk if set to 'y' configures Linux I2C driver for fast 484917ea1177Swdenk mode (400kHZ). This environment variable is used in 485017ea1177Swdenk initialization code. So, for changes to be effective 485117ea1177Swdenk it must be saved and board must be reset. 485217ea1177Swdenk 4853c609719bSwdenk initrd_high - restrict positioning of initrd images: 4854c609719bSwdenk If this variable is not set, initrd images will be 4855c609719bSwdenk copied to the highest possible address in RAM; this 4856c609719bSwdenk is usually what you want since it allows for 4857c609719bSwdenk maximum initrd size. If for some reason you want to 4858c609719bSwdenk make sure that the initrd image is loaded below the 48596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BOOTMAPSZ limit, you can set this environment 4860c609719bSwdenk variable to a value of "no" or "off" or "0". 4861c609719bSwdenk Alternatively, you can set it to a maximum upper 4862c609719bSwdenk address to use (U-Boot will still check that it 4863c609719bSwdenk does not overwrite the U-Boot stack and data). 4864c609719bSwdenk 4865c609719bSwdenk For instance, when you have a system with 16 MB 48667152b1d0Swdenk RAM, and want to reserve 4 MB from use by Linux, 4867c609719bSwdenk you can do this by adding "mem=12M" to the value of 4868c609719bSwdenk the "bootargs" variable. However, now you must make 48697152b1d0Swdenk sure that the initrd image is placed in the first 4870c609719bSwdenk 12 MB as well - this can be done with 4871c609719bSwdenk 4872c609719bSwdenk setenv initrd_high 00c00000 4873c609719bSwdenk 487438b99261Swdenk If you set initrd_high to 0xFFFFFFFF, this is an 487538b99261Swdenk indication to U-Boot that all addresses are legal 487638b99261Swdenk for the Linux kernel, including addresses in flash 487738b99261Swdenk memory. In this case U-Boot will NOT COPY the 487838b99261Swdenk ramdisk at all. This may be useful to reduce the 487938b99261Swdenk boot time on your system, but requires that this 488038b99261Swdenk feature is supported by your Linux kernel. 488138b99261Swdenk 4882c609719bSwdenk ipaddr - IP address; needed for tftpboot command 4883c609719bSwdenk 4884c609719bSwdenk loadaddr - Default load address for commands like "bootp", 4885dc7c9a1aSwdenk "rarpboot", "tftpboot", "loadb" or "diskboot" 4886c609719bSwdenk 4887c609719bSwdenk loads_echo - see CONFIG_LOADS_ECHO 4888c609719bSwdenk 4889c609719bSwdenk serverip - TFTP server IP address; needed for tftpboot command 4890c609719bSwdenk 4891c609719bSwdenk bootretry - see CONFIG_BOOT_RETRY_TIME 4892c609719bSwdenk 4893c609719bSwdenk bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR 4894c609719bSwdenk 4895c609719bSwdenk bootstopkey - see CONFIG_AUTOBOOT_STOP_STR 4896c609719bSwdenk 4897e2a53458SMike Frysinger ethprime - controls which interface is used first. 4898a3d991bdSwdenk 4899e2a53458SMike Frysinger ethact - controls which interface is currently active. 4900e2a53458SMike Frysinger For example you can do the following 4901a3d991bdSwdenk 490248690d80SHeiko Schocher => setenv ethact FEC 490348690d80SHeiko Schocher => ping 192.168.0.1 # traffic sent on FEC 490448690d80SHeiko Schocher => setenv ethact SCC 490548690d80SHeiko Schocher => ping 10.0.0.1 # traffic sent on SCC 4906a3d991bdSwdenk 4907e1692577SMatthias Fuchs ethrotate - When set to "no" U-Boot does not go through all 4908e1692577SMatthias Fuchs available network interfaces. 4909e1692577SMatthias Fuchs It just stays at the currently selected interface. 4910e1692577SMatthias Fuchs 4911a3d991bdSwdenk netretry - When set to "no" each network operation will 4912a3d991bdSwdenk either succeed or fail without retrying. 49136e592385Swdenk When set to "once" the network operation will 49146e592385Swdenk fail when all the available network interfaces 49156e592385Swdenk are tried once without success. 4916a3d991bdSwdenk Useful on scripts which control the retry operation 4917a3d991bdSwdenk themselves. 4918a3d991bdSwdenk 4919b4e2f89dSJean-Christophe PLAGNIOL-VILLARD npe_ucode - set load address for the NPE microcode 4920a1cf027aSJean-Christophe PLAGNIOL-VILLARD 49218d51aacdSSimon Glass silent_linux - If set then linux will be told to boot silently, by 49228d51aacdSSimon Glass changing the console to be empty. If "yes" it will be 49238d51aacdSSimon Glass made silent. If "no" it will not be made silent. If 49248d51aacdSSimon Glass unset, then it will be made silent if the U-Boot console 49258d51aacdSSimon Glass is silent. 49268d51aacdSSimon Glass 492728cb9375SWolfgang Denk tftpsrcport - If this is set, the value is used for TFTP's 4928ecb0ccd9SWolfgang Denk UDP source port. 4929ecb0ccd9SWolfgang Denk 493028cb9375SWolfgang Denk tftpdstport - If this is set, the value is used for TFTP's UDP 493128cb9375SWolfgang Denk destination port instead of the Well Know Port 69. 493228cb9375SWolfgang Denk 4933c96f86eeSWolfgang Denk tftpblocksize - Block size to use for TFTP transfers; if not set, 4934c96f86eeSWolfgang Denk we use the TFTP server's default block size 4935c96f86eeSWolfgang Denk 4936c96f86eeSWolfgang Denk tftptimeout - Retransmission timeout for TFTP packets (in milli- 4937c96f86eeSWolfgang Denk seconds, minimum value is 1000 = 1 second). Defines 4938c96f86eeSWolfgang Denk when a packet is considered to be lost so it has to 4939c96f86eeSWolfgang Denk be retransmitted. The default is 5000 = 5 seconds. 4940c96f86eeSWolfgang Denk Lowering this value may make downloads succeed 4941c96f86eeSWolfgang Denk faster in networks with high packet loss rates or 4942c96f86eeSWolfgang Denk with unreliable TFTP servers. 4943c96f86eeSWolfgang Denk 4944a3d991bdSwdenk vlan - When set to a value < 4095 the traffic over 494511ccc33fSMarcel Ziswiler Ethernet is encapsulated/received over 802.1q 4946a3d991bdSwdenk VLAN tagged frames. 4947c609719bSwdenk 4948dc0b7b0eSJason HobbsThe following image location variables contain the location of images 4949dc0b7b0eSJason Hobbsused in booting. The "Image" column gives the role of the image and is 4950dc0b7b0eSJason Hobbsnot an environment variable name. The other columns are environment 4951dc0b7b0eSJason Hobbsvariable names. "File Name" gives the name of the file on a TFTP 4952dc0b7b0eSJason Hobbsserver, "RAM Address" gives the location in RAM the image will be 4953dc0b7b0eSJason Hobbsloaded to, and "Flash Location" gives the image's address in NOR 4954dc0b7b0eSJason Hobbsflash or offset in NAND flash. 4955dc0b7b0eSJason Hobbs 4956dc0b7b0eSJason Hobbs*Note* - these variables don't have to be defined for all boards, some 4957dc0b7b0eSJason Hobbsboards currenlty use other variables for these purposes, and some 4958dc0b7b0eSJason Hobbsboards use these variables for other purposes. 4959dc0b7b0eSJason Hobbs 4960dc0b7b0eSJason HobbsImage File Name RAM Address Flash Location 4961dc0b7b0eSJason Hobbs----- --------- ----------- -------------- 4962dc0b7b0eSJason Hobbsu-boot u-boot u-boot_addr_r u-boot_addr 4963dc0b7b0eSJason HobbsLinux kernel bootfile kernel_addr_r kernel_addr 4964dc0b7b0eSJason Hobbsdevice tree blob fdtfile fdt_addr_r fdt_addr 4965dc0b7b0eSJason Hobbsramdisk ramdiskfile ramdisk_addr_r ramdisk_addr 4966dc0b7b0eSJason Hobbs 4967c609719bSwdenkThe following environment variables may be used and automatically 4968c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"), 4969c609719bSwdenkdepending the information provided by your boot server: 4970c609719bSwdenk 4971c609719bSwdenk bootfile - see above 4972c609719bSwdenk dnsip - IP address of your Domain Name Server 4973fe389a82Sstroese dnsip2 - IP address of your secondary Domain Name Server 4974c609719bSwdenk gatewayip - IP address of the Gateway (Router) to use 4975c609719bSwdenk hostname - Target hostname 4976c609719bSwdenk ipaddr - see above 4977c609719bSwdenk netmask - Subnet Mask 4978c609719bSwdenk rootpath - Pathname of the root filesystem on the NFS server 4979c609719bSwdenk serverip - see above 4980c609719bSwdenk 4981c609719bSwdenk 4982c609719bSwdenkThere are two special Environment Variables: 4983c609719bSwdenk 4984c609719bSwdenk serial# - contains hardware identification information such 4985c609719bSwdenk as type string and/or serial number 4986c609719bSwdenk ethaddr - Ethernet address 4987c609719bSwdenk 4988c609719bSwdenkThese variables can be set only once (usually during manufacturing of 4989c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables 4990c609719bSwdenkonce they have been set once. 4991c609719bSwdenk 4992c609719bSwdenk 4993c1551ea8SstroeseFurther special Environment Variables: 4994c1551ea8Sstroese 4995c1551ea8Sstroese ver - Contains the U-Boot version string as printed 4996c1551ea8Sstroese with the "version" command. This variable is 4997c1551ea8Sstroese readonly (see CONFIG_VERSION_VARIABLE). 4998c1551ea8Sstroese 4999c1551ea8Sstroese 5000c609719bSwdenkPlease note that changes to some configuration parameters may take 5001c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-). 5002c609719bSwdenk 5003c609719bSwdenk 5004170ab110SJoe HershbergerCallback functions for environment variables: 5005170ab110SJoe Hershberger--------------------------------------------- 5006170ab110SJoe Hershberger 5007170ab110SJoe HershbergerFor some environment variables, the behavior of u-boot needs to change 5008170ab110SJoe Hershbergerwhen their values are changed. This functionailty allows functions to 5009170ab110SJoe Hershbergerbe associated with arbitrary variables. On creation, overwrite, or 5010170ab110SJoe Hershbergerdeletion, the callback will provide the opportunity for some side 5011170ab110SJoe Hershbergereffect to happen or for the change to be rejected. 5012170ab110SJoe Hershberger 5013170ab110SJoe HershbergerThe callbacks are named and associated with a function using the 5014170ab110SJoe HershbergerU_BOOT_ENV_CALLBACK macro in your board or driver code. 5015170ab110SJoe Hershberger 5016170ab110SJoe HershbergerThese callbacks are associated with variables in one of two ways. The 5017170ab110SJoe Hershbergerstatic list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC 5018170ab110SJoe Hershbergerin the board configuration to a string that defines a list of 5019170ab110SJoe Hershbergerassociations. The list must be in the following format: 5020170ab110SJoe Hershberger 5021170ab110SJoe Hershberger entry = variable_name[:callback_name] 5022170ab110SJoe Hershberger list = entry[,list] 5023170ab110SJoe Hershberger 5024170ab110SJoe HershbergerIf the callback name is not specified, then the callback is deleted. 5025170ab110SJoe HershbergerSpaces are also allowed anywhere in the list. 5026170ab110SJoe Hershberger 5027170ab110SJoe HershbergerCallbacks can also be associated by defining the ".callbacks" variable 5028170ab110SJoe Hershbergerwith the same list format above. Any association in ".callbacks" will 5029170ab110SJoe Hershbergeroverride any association in the static list. You can define 5030170ab110SJoe HershbergerCONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the 5031170ab110SJoe Hershberger".callbacks" envirnoment variable in the default or embedded environment. 5032170ab110SJoe Hershberger 5033170ab110SJoe Hershberger 5034f07771ccSwdenkCommand Line Parsing: 5035f07771ccSwdenk===================== 5036f07771ccSwdenk 5037f07771ccSwdenkThere are two different command line parsers available with U-Boot: 50387152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell: 5039f07771ccSwdenk 5040f07771ccSwdenkOld, simple command line parser: 5041f07771ccSwdenk-------------------------------- 5042f07771ccSwdenk 5043f07771ccSwdenk- supports environment variables (through setenv / saveenv commands) 5044f07771ccSwdenk- several commands on one line, separated by ';' 5045fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax 5046f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\', 5047f07771ccSwdenk for example: 5048fe126d8bSWolfgang Denk setenv bootcmd bootm \${address} 5049f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example: 5050f07771ccSwdenk setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off' 5051f07771ccSwdenk 5052f07771ccSwdenkHush shell: 5053f07771ccSwdenk----------- 5054f07771ccSwdenk 5055f07771ccSwdenk- similar to Bourne shell, with control structures like 5056f07771ccSwdenk if...then...else...fi, for...do...done; while...do...done, 5057f07771ccSwdenk until...do...done, ... 5058f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv 5059f07771ccSwdenk commands) and local shell variables (through standard shell syntax 5060f07771ccSwdenk "name=value"); only environment variables can be used with "run" 5061f07771ccSwdenk command 5062f07771ccSwdenk 5063f07771ccSwdenkGeneral rules: 5064f07771ccSwdenk-------------- 5065f07771ccSwdenk 5066f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run" 5067f07771ccSwdenk command) contains several commands separated by semicolon, and 5068f07771ccSwdenk one of these commands fails, then the remaining commands will be 5069f07771ccSwdenk executed anyway. 5070f07771ccSwdenk 5071f07771ccSwdenk(2) If you execute several variables with one call to run (i. e. 507211ccc33fSMarcel Ziswiler calling run with a list of variables as arguments), any failing 5073f07771ccSwdenk command will cause "run" to terminate, i. e. the remaining 5074f07771ccSwdenk variables are not executed. 5075f07771ccSwdenk 5076c609719bSwdenkNote for Redundant Ethernet Interfaces: 5077c609719bSwdenk======================================= 5078c609719bSwdenk 507911ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports 5080c609719bSwdenksuch configurations and is capable of automatic selection of a 50817152b1d0Swdenk"working" interface when needed. MAC assignment works as follows: 5082c609719bSwdenk 5083c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding 5084c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0), 5085c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ... 5086c609719bSwdenk 5087c609719bSwdenkIf the network interface stores some valid MAC address (for instance 5088c609719bSwdenkin SROM), this is used as default address if there is NO correspon- 5089c609719bSwdenkding setting in the environment; if the corresponding environment 5090c609719bSwdenkvariable is set, this overrides the settings in the card; that means: 5091c609719bSwdenk 5092c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the 5093c609719bSwdenk environment, the SROM's address is used. 5094c609719bSwdenk 5095c609719bSwdenko If there is no valid address in the SROM, and a definition in the 5096c609719bSwdenk environment exists, then the value from the environment variable is 5097c609719bSwdenk used. 5098c609719bSwdenk 5099c609719bSwdenko If both the SROM and the environment contain a MAC address, and 5100c609719bSwdenk both addresses are the same, this MAC address is used. 5101c609719bSwdenk 5102c609719bSwdenko If both the SROM and the environment contain a MAC address, and the 5103c609719bSwdenk addresses differ, the value from the environment is used and a 5104c609719bSwdenk warning is printed. 5105c609719bSwdenk 5106c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error 5107c609719bSwdenk is raised. 5108c609719bSwdenk 5109ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses 5110ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process. This 5111ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable. 5112ecee9324SBen WarrenThe naming convention is as follows: 5113ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc. 5114c609719bSwdenk 5115c609719bSwdenkImage Formats: 5116c609719bSwdenk============== 5117c609719bSwdenk 51183310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on) 51193310c549SMarian Balakowiczimages in two formats: 51203310c549SMarian Balakowicz 51213310c549SMarian BalakowiczNew uImage format (FIT) 51223310c549SMarian Balakowicz----------------------- 51233310c549SMarian Balakowicz 51243310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar 51253310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple 51263310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by 51273310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory. 51283310c549SMarian Balakowicz 51293310c549SMarian Balakowicz 51303310c549SMarian BalakowiczOld uImage format 51313310c549SMarian Balakowicz----------------- 51323310c549SMarian Balakowicz 51333310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything, 51343310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for 51353310c549SMarian Balakowiczdetails; basically, the header defines the following image properties: 5136c609719bSwdenk 5137c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD, 5138c609719bSwdenk 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks, 5139f5ed9e39SPeter Tyser LynxOS, pSOS, QNX, RTEMS, INTEGRITY; 5140f5ed9e39SPeter Tyser Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS, 5141f5ed9e39SPeter Tyser INTEGRITY). 51427b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86, 5143afc1ce82SMacpaul Lin IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit; 5144afc1ce82SMacpaul Lin Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC). 5145c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2) 5146c609719bSwdenk* Load Address 5147c609719bSwdenk* Entry Point 5148c609719bSwdenk* Image Name 5149c609719bSwdenk* Image Timestamp 5150c609719bSwdenk 5151c609719bSwdenkThe header is marked by a special Magic Number, and both the header 5152c609719bSwdenkand the data portions of the image are secured against corruption by 5153c609719bSwdenkCRC32 checksums. 5154c609719bSwdenk 5155c609719bSwdenk 5156c609719bSwdenkLinux Support: 5157c609719bSwdenk============== 5158c609719bSwdenk 5159c609719bSwdenkAlthough U-Boot should support any OS or standalone application 51607152b1d0Swdenkeasily, the main focus has always been on Linux during the design of 5161c609719bSwdenkU-Boot. 5162c609719bSwdenk 5163c609719bSwdenkU-Boot includes many features that so far have been part of some 5164c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any 5165c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image; 5166c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation 51677152b1d0Swdenkserves several purposes: 5168c609719bSwdenk 5169c609719bSwdenk- the same features can be used for other OS or standalone 5170c609719bSwdenk applications (for instance: using compressed images to reduce the 5171c609719bSwdenk Flash memory footprint) 5172c609719bSwdenk 5173c609719bSwdenk- it becomes much easier to port new Linux kernel versions because 51747152b1d0Swdenk lots of low-level, hardware dependent stuff are done by U-Boot 5175c609719bSwdenk 5176c609719bSwdenk- the same Linux kernel image can now be used with different "initrd" 5177c609719bSwdenk images; of course this also means that different kernel images can 5178c609719bSwdenk be run with the same "initrd". This makes testing easier (you don't 5179c609719bSwdenk have to build a new "zImage.initrd" Linux image when you just 5180c609719bSwdenk change a file in your "initrd"). Also, a field-upgrade of the 5181c609719bSwdenk software is easier now. 5182c609719bSwdenk 5183c609719bSwdenk 5184c609719bSwdenkLinux HOWTO: 5185c609719bSwdenk============ 5186c609719bSwdenk 5187c609719bSwdenkPorting Linux to U-Boot based systems: 5188c609719bSwdenk--------------------------------------- 5189c609719bSwdenk 5190c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to 5191c609719bSwdenkconfigure the Linux device drivers for use with your target hardware 5192c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to 5193c609719bSwdenkLinux :-). 5194c609719bSwdenk 5195a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot). 5196c609719bSwdenk 5197c609719bSwdenkJust make sure your machine specific header file (for instance 5198c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board 51991dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h, 52001dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value 52016d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR. 5202c609719bSwdenk 5203c609719bSwdenk 5204c609719bSwdenkConfiguring the Linux kernel: 5205c609719bSwdenk----------------------------- 5206c609719bSwdenk 5207c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root 5208c609719bSwdenkdevice (initial ramdisk, NFS) for your target system. 5209c609719bSwdenk 5210c609719bSwdenk 5211c609719bSwdenkBuilding a Linux Image: 5212c609719bSwdenk----------------------- 5213c609719bSwdenk 521424ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are 521524ee89b9Swdenknot used. If you use recent kernel source, a new build target 521624ee89b9Swdenk"uImage" will exist which automatically builds an image usable by 521724ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target, 521824ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a 521924ee89b9Swdenk100% compatible format. 5220c609719bSwdenk 5221c609719bSwdenkExample: 5222c609719bSwdenk 5223c609719bSwdenk make TQM850L_config 5224c609719bSwdenk make oldconfig 5225c609719bSwdenk make dep 522624ee89b9Swdenk make uImage 5227c609719bSwdenk 522824ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to 522924ee89b9Swdenkencapsulate a compressed Linux kernel image with header information, 523024ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing: 5231c609719bSwdenk 523224ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format): 523324ee89b9Swdenk 523424ee89b9Swdenk* convert the kernel into a raw binary image: 523524ee89b9Swdenk 523624ee89b9Swdenk ${CROSS_COMPILE}-objcopy -O binary \ 523724ee89b9Swdenk -R .note -R .comment \ 523824ee89b9Swdenk -S vmlinux linux.bin 523924ee89b9Swdenk 524024ee89b9Swdenk* compress the binary image: 524124ee89b9Swdenk 524224ee89b9Swdenk gzip -9 linux.bin 524324ee89b9Swdenk 524424ee89b9Swdenk* package compressed binary image for U-Boot: 524524ee89b9Swdenk 524624ee89b9Swdenk mkimage -A ppc -O linux -T kernel -C gzip \ 524724ee89b9Swdenk -a 0 -e 0 -n "Linux Kernel Image" \ 524824ee89b9Swdenk -d linux.bin.gz uImage 524924ee89b9Swdenk 525024ee89b9Swdenk 525124ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use 525224ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or 525324ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64 525424ee89b9Swdenkbyte header containing information about target architecture, 525524ee89b9Swdenkoperating system, image type, compression method, entry points, time 525624ee89b9Swdenkstamp, CRC32 checksums, etc. 525724ee89b9Swdenk 525824ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and 525924ee89b9Swdenkprint the header information, or to build new images. 5260c609719bSwdenk 5261c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information 5262c609719bSwdenkcontained in the header of an existing U-Boot image; this includes 5263c609719bSwdenkchecksum verification: 5264c609719bSwdenk 5265c609719bSwdenk tools/mkimage -l image 5266c609719bSwdenk -l ==> list image header information 5267c609719bSwdenk 5268c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image 5269c609719bSwdenkfrom a "data file" which is used as image payload: 5270c609719bSwdenk 5271c609719bSwdenk tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \ 5272c609719bSwdenk -n name -d data_file image 5273c609719bSwdenk -A ==> set architecture to 'arch' 5274c609719bSwdenk -O ==> set operating system to 'os' 5275c609719bSwdenk -T ==> set image type to 'type' 5276c609719bSwdenk -C ==> set compression type 'comp' 5277c609719bSwdenk -a ==> set load address to 'addr' (hex) 5278c609719bSwdenk -e ==> set entry point to 'ep' (hex) 5279c609719bSwdenk -n ==> set image name to 'name' 5280c609719bSwdenk -d ==> use image data from 'datafile' 5281c609719bSwdenk 528269459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load 528369459791Swdenkaddress (0x00000000), but the entry point address depends on the 528469459791Swdenkkernel version: 5285c609719bSwdenk 5286c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C, 528724ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000. 5288c609719bSwdenk 5289c609719bSwdenkSo a typical call to build a U-Boot image would read: 5290c609719bSwdenk 529124ee89b9Swdenk -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 529224ee89b9Swdenk > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \ 5293a47a12beSStefan Roese > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \ 529424ee89b9Swdenk > examples/uImage.TQM850L 529524ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 5296c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 5297c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 5298c609719bSwdenk Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 5299c609719bSwdenk Load Address: 0x00000000 530024ee89b9Swdenk Entry Point: 0x00000000 5301c609719bSwdenk 5302c609719bSwdenkTo verify the contents of the image (or check for corruption): 5303c609719bSwdenk 530424ee89b9Swdenk -> tools/mkimage -l examples/uImage.TQM850L 530524ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 5306c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 5307c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 5308c609719bSwdenk Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 5309c609719bSwdenk Load Address: 0x00000000 531024ee89b9Swdenk Entry Point: 0x00000000 5311c609719bSwdenk 5312c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade 5313c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this 5314c609719bSwdenkneeds more space in Flash, but boots much faster since it does not 5315c609719bSwdenkneed to be uncompressed: 5316c609719bSwdenk 5317a47a12beSStefan Roese -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz 531824ee89b9Swdenk -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 531924ee89b9Swdenk > -A ppc -O linux -T kernel -C none -a 0 -e 0 \ 5320a47a12beSStefan Roese > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \ 532124ee89b9Swdenk > examples/uImage.TQM850L-uncompressed 532224ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 5323c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 5324c609719bSwdenk Image Type: PowerPC Linux Kernel Image (uncompressed) 5325c609719bSwdenk Data Size: 792160 Bytes = 773.59 kB = 0.76 MB 5326c609719bSwdenk Load Address: 0x00000000 532724ee89b9Swdenk Entry Point: 0x00000000 5328c609719bSwdenk 5329c609719bSwdenk 5330c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file 5331c609719bSwdenkwhen your kernel is intended to use an initial ramdisk: 5332c609719bSwdenk 5333c609719bSwdenk -> tools/mkimage -n 'Simple Ramdisk Image' \ 5334c609719bSwdenk > -A ppc -O linux -T ramdisk -C gzip \ 5335c609719bSwdenk > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd 5336c609719bSwdenk Image Name: Simple Ramdisk Image 5337c609719bSwdenk Created: Wed Jan 12 14:01:50 2000 5338c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 5339c609719bSwdenk Data Size: 566530 Bytes = 553.25 kB = 0.54 MB 5340c609719bSwdenk Load Address: 0x00000000 5341c609719bSwdenk Entry Point: 0x00000000 5342c609719bSwdenk 5343a804b5ceSGuilherme Maciel FerreiraThe "dumpimage" is a tool to disassemble images built by mkimage. Its "-i" 5344a804b5ceSGuilherme Maciel Ferreiraoption performs the converse operation of the mkimage's second form (the "-d" 5345a804b5ceSGuilherme Maciel Ferreiraoption). Given an image built by mkimage, the dumpimage extracts a "data file" 5346a804b5ceSGuilherme Maciel Ferreirafrom the image: 5347a804b5ceSGuilherme Maciel Ferreira 5348a804b5ceSGuilherme Maciel Ferreira tools/dumpimage -i image -p position data_file 5349a804b5ceSGuilherme Maciel Ferreira -i ==> extract from the 'image' a specific 'data_file', \ 5350a804b5ceSGuilherme Maciel Ferreira indexed by 'position' 5351a804b5ceSGuilherme Maciel Ferreira 5352c609719bSwdenk 5353c609719bSwdenkInstalling a Linux Image: 5354c609719bSwdenk------------------------- 5355c609719bSwdenk 5356c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface, 5357c609719bSwdenkyou must convert the image to S-Record format: 5358c609719bSwdenk 5359c609719bSwdenk objcopy -I binary -O srec examples/image examples/image.srec 5360c609719bSwdenk 5361c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot 5362c609719bSwdenkimage header, so the resulting S-Record file will be relative to 5363c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to 5364c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads' 5365c609719bSwdenkcommand. 5366c609719bSwdenk 5367c609719bSwdenkExample: install the image to address 0x40100000 (which on the 5368c609719bSwdenkTQM8xxL is in the first Flash bank): 5369c609719bSwdenk 5370c609719bSwdenk => erase 40100000 401FFFFF 5371c609719bSwdenk 5372c609719bSwdenk .......... done 5373c609719bSwdenk Erased 8 sectors 5374c609719bSwdenk 5375c609719bSwdenk => loads 40100000 5376c609719bSwdenk ## Ready for S-Record download ... 5377c609719bSwdenk ~>examples/image.srec 5378c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 12 13 ... 5379c609719bSwdenk ... 5380c609719bSwdenk 15989 15990 15991 15992 5381c609719bSwdenk [file transfer complete] 5382c609719bSwdenk [connected] 5383c609719bSwdenk ## Start Addr = 0x00000000 5384c609719bSwdenk 5385c609719bSwdenk 5386c609719bSwdenkYou can check the success of the download using the 'iminfo' command; 5387c609719bSwdenkthis includes a checksum verification so you can be sure no data 5388c609719bSwdenkcorruption happened: 5389c609719bSwdenk 5390c609719bSwdenk => imi 40100000 5391c609719bSwdenk 5392c609719bSwdenk ## Checking Image at 40100000 ... 5393c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 5394c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 5395c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 5396c609719bSwdenk Load Address: 00000000 5397c609719bSwdenk Entry Point: 0000000c 5398c609719bSwdenk Verifying Checksum ... OK 5399c609719bSwdenk 5400c609719bSwdenk 5401c609719bSwdenkBoot Linux: 5402c609719bSwdenk----------- 5403c609719bSwdenk 5404c609719bSwdenkThe "bootm" command is used to boot an application that is stored in 5405c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents 5406c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as 5407c609719bSwdenkparameters. You can check and modify this variable using the 5408c609719bSwdenk"printenv" and "setenv" commands: 5409c609719bSwdenk 5410c609719bSwdenk 5411c609719bSwdenk => printenv bootargs 5412c609719bSwdenk bootargs=root=/dev/ram 5413c609719bSwdenk 5414c609719bSwdenk => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 5415c609719bSwdenk 5416c609719bSwdenk => printenv bootargs 5417c609719bSwdenk bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 5418c609719bSwdenk 5419c609719bSwdenk => bootm 40020000 5420c609719bSwdenk ## Booting Linux kernel at 40020000 ... 5421c609719bSwdenk Image Name: 2.2.13 for NFS on TQM850L 5422c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 5423c609719bSwdenk Data Size: 381681 Bytes = 372 kB = 0 MB 5424c609719bSwdenk Load Address: 00000000 5425c609719bSwdenk Entry Point: 0000000c 5426c609719bSwdenk Verifying Checksum ... OK 5427c609719bSwdenk Uncompressing Kernel Image ... OK 5428c609719bSwdenk 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 5429c609719bSwdenk Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 5430c609719bSwdenk time_init: decrementer frequency = 187500000/60 5431c609719bSwdenk Calibrating delay loop... 49.77 BogoMIPS 5432c609719bSwdenk Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000] 5433c609719bSwdenk ... 5434c609719bSwdenk 543511ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass 54367152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT 5437c609719bSwdenkformat!) to the "bootm" command: 5438c609719bSwdenk 5439c609719bSwdenk => imi 40100000 40200000 5440c609719bSwdenk 5441c609719bSwdenk ## Checking Image at 40100000 ... 5442c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 5443c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 5444c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 5445c609719bSwdenk Load Address: 00000000 5446c609719bSwdenk Entry Point: 0000000c 5447c609719bSwdenk Verifying Checksum ... OK 5448c609719bSwdenk 5449c609719bSwdenk ## Checking Image at 40200000 ... 5450c609719bSwdenk Image Name: Simple Ramdisk Image 5451c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 5452c609719bSwdenk Data Size: 566530 Bytes = 553 kB = 0 MB 5453c609719bSwdenk Load Address: 00000000 5454c609719bSwdenk Entry Point: 00000000 5455c609719bSwdenk Verifying Checksum ... OK 5456c609719bSwdenk 5457c609719bSwdenk => bootm 40100000 40200000 5458c609719bSwdenk ## Booting Linux kernel at 40100000 ... 5459c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 5460c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 5461c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 5462c609719bSwdenk Load Address: 00000000 5463c609719bSwdenk Entry Point: 0000000c 5464c609719bSwdenk Verifying Checksum ... OK 5465c609719bSwdenk Uncompressing Kernel Image ... OK 5466c609719bSwdenk ## Loading RAMDisk Image at 40200000 ... 5467c609719bSwdenk Image Name: Simple Ramdisk Image 5468c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 5469c609719bSwdenk Data Size: 566530 Bytes = 553 kB = 0 MB 5470c609719bSwdenk Load Address: 00000000 5471c609719bSwdenk Entry Point: 00000000 5472c609719bSwdenk Verifying Checksum ... OK 5473c609719bSwdenk Loading Ramdisk ... OK 5474c609719bSwdenk 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 5475c609719bSwdenk Boot arguments: root=/dev/ram 5476c609719bSwdenk time_init: decrementer frequency = 187500000/60 5477c609719bSwdenk Calibrating delay loop... 49.77 BogoMIPS 5478c609719bSwdenk ... 5479c609719bSwdenk RAMDISK: Compressed image found at block 0 5480c609719bSwdenk VFS: Mounted root (ext2 filesystem). 5481c609719bSwdenk 5482c609719bSwdenk bash# 5483c609719bSwdenk 54840267768eSMatthew McClintockBoot Linux and pass a flat device tree: 54850267768eSMatthew McClintock----------- 54860267768eSMatthew McClintock 54870267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section 54880267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The 54890267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated 54900267768eSMatthew McClintockflat device tree: 54910267768eSMatthew McClintock 54920267768eSMatthew McClintock=> print oftaddr 54930267768eSMatthew McClintockoftaddr=0x300000 54940267768eSMatthew McClintock=> print oft 54950267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb 54960267768eSMatthew McClintock=> tftp $oftaddr $oft 54970267768eSMatthew McClintockSpeed: 1000, full duplex 54980267768eSMatthew McClintockUsing TSEC0 device 54990267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101 55000267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'. 55010267768eSMatthew McClintockLoad address: 0x300000 55020267768eSMatthew McClintockLoading: # 55030267768eSMatthew McClintockdone 55040267768eSMatthew McClintockBytes transferred = 4106 (100a hex) 55050267768eSMatthew McClintock=> tftp $loadaddr $bootfile 55060267768eSMatthew McClintockSpeed: 1000, full duplex 55070267768eSMatthew McClintockUsing TSEC0 device 55080267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2 55090267768eSMatthew McClintockFilename 'uImage'. 55100267768eSMatthew McClintockLoad address: 0x200000 55110267768eSMatthew McClintockLoading:############ 55120267768eSMatthew McClintockdone 55130267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex) 55140267768eSMatthew McClintock=> print loadaddr 55150267768eSMatthew McClintockloadaddr=200000 55160267768eSMatthew McClintock=> print oftaddr 55170267768eSMatthew McClintockoftaddr=0x300000 55180267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr 55190267768eSMatthew McClintock## Booting image at 00200000 ... 55200267768eSMatthew McClintock Image Name: Linux-2.6.17-dirty 55210267768eSMatthew McClintock Image Type: PowerPC Linux Kernel Image (gzip compressed) 55220267768eSMatthew McClintock Data Size: 1029343 Bytes = 1005.2 kB 55230267768eSMatthew McClintock Load Address: 00000000 55240267768eSMatthew McClintock Entry Point: 00000000 55250267768eSMatthew McClintock Verifying Checksum ... OK 55260267768eSMatthew McClintock Uncompressing Kernel Image ... OK 55270267768eSMatthew McClintockBooting using flat device tree at 0x300000 55280267768eSMatthew McClintockUsing MPC85xx ADS machine description 55290267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb 55300267768eSMatthew McClintock[snip] 55310267768eSMatthew McClintock 55320267768eSMatthew McClintock 55336069ff26SwdenkMore About U-Boot Image Types: 55346069ff26Swdenk------------------------------ 55356069ff26Swdenk 55366069ff26SwdenkU-Boot supports the following image types: 55376069ff26Swdenk 55386069ff26Swdenk "Standalone Programs" are directly runnable in the environment 55396069ff26Swdenk provided by U-Boot; it is expected that (if they behave 55406069ff26Swdenk well) you can continue to work in U-Boot after return from 55416069ff26Swdenk the Standalone Program. 55426069ff26Swdenk "OS Kernel Images" are usually images of some Embedded OS which 55436069ff26Swdenk will take over control completely. Usually these programs 55446069ff26Swdenk will install their own set of exception handlers, device 55456069ff26Swdenk drivers, set up the MMU, etc. - this means, that you cannot 55466069ff26Swdenk expect to re-enter U-Boot except by resetting the CPU. 55476069ff26Swdenk "RAMDisk Images" are more or less just data blocks, and their 55486069ff26Swdenk parameters (address, size) are passed to an OS kernel that is 55496069ff26Swdenk being started. 55506069ff26Swdenk "Multi-File Images" contain several images, typically an OS 55516069ff26Swdenk (Linux) kernel image and one or more data images like 55526069ff26Swdenk RAMDisks. This construct is useful for instance when you want 55536069ff26Swdenk to boot over the network using BOOTP etc., where the boot 55546069ff26Swdenk server provides just a single image file, but you want to get 55556069ff26Swdenk for instance an OS kernel and a RAMDisk image. 55566069ff26Swdenk 55576069ff26Swdenk "Multi-File Images" start with a list of image sizes, each 55586069ff26Swdenk image size (in bytes) specified by an "uint32_t" in network 55596069ff26Swdenk byte order. This list is terminated by an "(uint32_t)0". 55606069ff26Swdenk Immediately after the terminating 0 follow the images, one by 55616069ff26Swdenk one, all aligned on "uint32_t" boundaries (size rounded up to 55626069ff26Swdenk a multiple of 4 bytes). 55636069ff26Swdenk 55646069ff26Swdenk "Firmware Images" are binary images containing firmware (like 55656069ff26Swdenk U-Boot or FPGA images) which usually will be programmed to 55666069ff26Swdenk flash memory. 55676069ff26Swdenk 55686069ff26Swdenk "Script files" are command sequences that will be executed by 55696069ff26Swdenk U-Boot's command interpreter; this feature is especially 55706069ff26Swdenk useful when you configure U-Boot to use a real shell (hush) 55716069ff26Swdenk as command interpreter. 55726069ff26Swdenk 557344f074c7SMarek VasutBooting the Linux zImage: 557444f074c7SMarek Vasut------------------------- 557544f074c7SMarek Vasut 557644f074c7SMarek VasutOn some platforms, it's possible to boot Linux zImage. This is done 557744f074c7SMarek Vasutusing the "bootz" command. The syntax of "bootz" command is the same 557844f074c7SMarek Vasutas the syntax of "bootm" command. 557944f074c7SMarek Vasut 55808ac28563STom RiniNote, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply 5581017e1f3fSMarek Vasutkernel with raw initrd images. The syntax is slightly different, the 5582017e1f3fSMarek Vasutaddress of the initrd must be augmented by it's size, in the following 5583017e1f3fSMarek Vasutformat: "<initrd addres>:<initrd size>". 5584017e1f3fSMarek Vasut 5585c609719bSwdenk 5586c609719bSwdenkStandalone HOWTO: 5587c609719bSwdenk================= 5588c609719bSwdenk 5589c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and 5590c609719bSwdenkrun "standalone" applications, which can use some resources of 5591c609719bSwdenkU-Boot like console I/O functions or interrupt services. 5592c609719bSwdenk 5593c609719bSwdenkTwo simple examples are included with the sources: 5594c609719bSwdenk 5595c609719bSwdenk"Hello World" Demo: 5596c609719bSwdenk------------------- 5597c609719bSwdenk 5598c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo 5599c609719bSwdenkapplication; it is automatically compiled when you build U-Boot. 5600c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it 5601c609719bSwdenklike that: 5602c609719bSwdenk 5603c609719bSwdenk => loads 5604c609719bSwdenk ## Ready for S-Record download ... 5605c609719bSwdenk ~>examples/hello_world.srec 5606c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 ... 5607c609719bSwdenk [file transfer complete] 5608c609719bSwdenk [connected] 5609c609719bSwdenk ## Start Addr = 0x00040004 5610c609719bSwdenk 5611c609719bSwdenk => go 40004 Hello World! This is a test. 5612c609719bSwdenk ## Starting application at 0x00040004 ... 5613c609719bSwdenk Hello World 5614c609719bSwdenk argc = 7 5615c609719bSwdenk argv[0] = "40004" 5616c609719bSwdenk argv[1] = "Hello" 5617c609719bSwdenk argv[2] = "World!" 5618c609719bSwdenk argv[3] = "This" 5619c609719bSwdenk argv[4] = "is" 5620c609719bSwdenk argv[5] = "a" 5621c609719bSwdenk argv[6] = "test." 5622c609719bSwdenk argv[7] = "<NULL>" 5623c609719bSwdenk Hit any key to exit ... 5624c609719bSwdenk 5625c609719bSwdenk ## Application terminated, rc = 0x0 5626c609719bSwdenk 5627c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt 5628c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'. 5629c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second. 5630c609719bSwdenkThe interrupt service routine is trivial, just printing a '.' 5631c609719bSwdenkcharacter, but this is just a demo program. The application can be 5632c609719bSwdenkcontrolled by the following keys: 5633c609719bSwdenk 5634c609719bSwdenk ? - print current values og the CPM Timer registers 5635c609719bSwdenk b - enable interrupts and start timer 5636c609719bSwdenk e - stop timer and disable interrupts 5637c609719bSwdenk q - quit application 5638c609719bSwdenk 5639c609719bSwdenk => loads 5640c609719bSwdenk ## Ready for S-Record download ... 5641c609719bSwdenk ~>examples/timer.srec 5642c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 ... 5643c609719bSwdenk [file transfer complete] 5644c609719bSwdenk [connected] 5645c609719bSwdenk ## Start Addr = 0x00040004 5646c609719bSwdenk 5647c609719bSwdenk => go 40004 5648c609719bSwdenk ## Starting application at 0x00040004 ... 5649c609719bSwdenk TIMERS=0xfff00980 5650c609719bSwdenk Using timer 1 5651c609719bSwdenk tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0 5652c609719bSwdenk 5653c609719bSwdenkHit 'b': 5654c609719bSwdenk [q, b, e, ?] Set interval 1000000 us 5655c609719bSwdenk Enabling timer 5656c609719bSwdenkHit '?': 5657c609719bSwdenk [q, b, e, ?] ........ 5658c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0 5659c609719bSwdenkHit '?': 5660c609719bSwdenk [q, b, e, ?] . 5661c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0 5662c609719bSwdenkHit '?': 5663c609719bSwdenk [q, b, e, ?] . 5664c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0 5665c609719bSwdenkHit '?': 5666c609719bSwdenk [q, b, e, ?] . 5667c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0 5668c609719bSwdenkHit 'e': 5669c609719bSwdenk [q, b, e, ?] ...Stopping timer 5670c609719bSwdenkHit 'q': 5671c609719bSwdenk [q, b, e, ?] ## Application terminated, rc = 0x0 5672c609719bSwdenk 5673c609719bSwdenk 567485ec0bccSwdenkMinicom warning: 567585ec0bccSwdenk================ 567685ec0bccSwdenk 56777152b1d0SwdenkOver time, many people have reported problems when trying to use the 567885ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd) 567985ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under 5680f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and 568185ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and 5682e53515a2SKarl O. Pincuse "cu" for S-Record download ("loads" command). See 5683e53515a2SKarl O. Pinchttp://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3. 5684e53515a2SKarl O. Pincfor help with kermit. 5685e53515a2SKarl O. Pinc 568685ec0bccSwdenk 568752f52c14SwdenkNevertheless, if you absolutely want to use it try adding this 568852f52c14Swdenkconfiguration to your "File transfer protocols" section: 568952f52c14Swdenk 569052f52c14Swdenk Name Program Name U/D FullScr IO-Red. Multi 569152f52c14Swdenk X kermit /usr/bin/kermit -i -l %l -s Y U Y N N 569252f52c14Swdenk Y kermit /usr/bin/kermit -i -l %l -r N D Y N N 569352f52c14Swdenk 569452f52c14Swdenk 5695c609719bSwdenkNetBSD Notes: 5696c609719bSwdenk============= 5697c609719bSwdenk 5698c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host 5699c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx). 5700c609719bSwdenk 5701c609719bSwdenkBuilding requires a cross environment; it is known to work on 5702c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also 5703c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make). 5704c609719bSwdenkNote that the cross-powerpc package does not install include files; 5705c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is 5706c609719bSwdenkmissing. This file has to be installed and patched manually: 5707c609719bSwdenk 5708c609719bSwdenk # cd /usr/pkg/cross/powerpc-netbsd/include 5709c609719bSwdenk # mkdir powerpc 5710c609719bSwdenk # ln -s powerpc machine 5711c609719bSwdenk # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h 5712c609719bSwdenk # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST 5713c609719bSwdenk 5714c609719bSwdenkNative builds *don't* work due to incompatibilities between native 5715c609719bSwdenkand U-Boot include files. 5716c609719bSwdenk 5717c609719bSwdenkBooting assumes that (the first part of) the image booted is a 5718c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel 5719c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source 5720c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the 57212a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz 5722c609719bSwdenk 5723c609719bSwdenk 5724c609719bSwdenkImplementation Internals: 5725c609719bSwdenk========================= 5726c609719bSwdenk 5727c609719bSwdenkThe following is not intended to be a complete description of every 5728c609719bSwdenkimplementation detail. However, it should help to understand the 5729c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom 5730c609719bSwdenkhardware. 5731c609719bSwdenk 5732c609719bSwdenk 5733c609719bSwdenkInitial Stack, Global Data: 5734c609719bSwdenk--------------------------- 5735c609719bSwdenk 5736c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot 5737c609719bSwdenkstarts running out of ROM (flash memory), usually without access to 5738c609719bSwdenksystem RAM (because the memory controller is not initialized yet). 5739c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS 5740c609719bSwdenkis not initialized as zero. To be able to get a C environment working 5741c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation 5742c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU 5743c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and 5744c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be 5745c609719bSwdenklocked as (mis-) used as memory, etc. 5746c609719bSwdenk 57477152b1d0Swdenk Chris Hallinan posted a good summary of these issues to the 57480668236bSWolfgang Denk U-Boot mailing list: 574943d9616cSwdenk 575043d9616cSwdenk Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)? 575143d9616cSwdenk From: "Chris Hallinan" <clh@net1plus.com> 575243d9616cSwdenk Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET) 575343d9616cSwdenk ... 575443d9616cSwdenk 575543d9616cSwdenk Correct me if I'm wrong, folks, but the way I understand it 575643d9616cSwdenk is this: Using DCACHE as initial RAM for Stack, etc, does not 575743d9616cSwdenk require any physical RAM backing up the cache. The cleverness 575843d9616cSwdenk is that the cache is being used as a temporary supply of 575943d9616cSwdenk necessary storage before the SDRAM controller is setup. It's 576011ccc33fSMarcel Ziswiler beyond the scope of this list to explain the details, but you 576143d9616cSwdenk can see how this works by studying the cache architecture and 576243d9616cSwdenk operation in the architecture and processor-specific manuals. 576343d9616cSwdenk 576443d9616cSwdenk OCM is On Chip Memory, which I believe the 405GP has 4K. It 576543d9616cSwdenk is another option for the system designer to use as an 576611ccc33fSMarcel Ziswiler initial stack/RAM area prior to SDRAM being available. Either 576743d9616cSwdenk option should work for you. Using CS 4 should be fine if your 576843d9616cSwdenk board designers haven't used it for something that would 576943d9616cSwdenk cause you grief during the initial boot! It is frequently not 577043d9616cSwdenk used. 577143d9616cSwdenk 57726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere 577343d9616cSwdenk with your processor/board/system design. The default value 577443d9616cSwdenk you will find in any recent u-boot distribution in 57758a316c9bSStefan Roese walnut.h should work for you. I'd set it to a value larger 577643d9616cSwdenk than your SDRAM module. If you have a 64MB SDRAM module, set 577743d9616cSwdenk it above 400_0000. Just make sure your board has no resources 577843d9616cSwdenk that are supposed to respond to that address! That code in 577943d9616cSwdenk start.S has been around a while and should work as is when 578043d9616cSwdenk you get the config right. 578143d9616cSwdenk 578243d9616cSwdenk -Chris Hallinan 578343d9616cSwdenk DS4.COM, Inc. 578443d9616cSwdenk 5785c609719bSwdenkIt is essential to remember this, since it has some impact on the C 5786c609719bSwdenkcode for the initialization procedures: 5787c609719bSwdenk 5788c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt 5789c609719bSwdenk to write it. 5790c609719bSwdenk 579111ccc33fSMarcel Ziswiler* Do not use any uninitialized global data (or implicitely initialized 5792c609719bSwdenk as zero data - BSS segment) at all - this is undefined, initiali- 57937152b1d0Swdenk zation is performed later (when relocating to RAM). 5794c609719bSwdenk 5795c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like 5796c609719bSwdenk that. 5797c609719bSwdenk 5798c609719bSwdenkHaving only the stack as writable memory limits means we cannot use 5799c609719bSwdenknormal global data to share information beween the code. But it 5800c609719bSwdenkturned out that the implementation of U-Boot can be greatly 5801c609719bSwdenksimplified by making a global data structure (gd_t) available to all 5802c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_ 5803c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of 5804c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we 5805c609719bSwdenkplace a pointer (gd) to the global data into a register which we 5806c609719bSwdenkreserve for this purpose. 5807c609719bSwdenk 58087152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the 5809c609719bSwdenkrelevant (E)ABI specifications for the current architecture, and by 5810c609719bSwdenkGCC's implementation. 5811c609719bSwdenk 5812c609719bSwdenkFor PowerPC, the following registers have specific use: 5813c609719bSwdenk R1: stack pointer 5814e7670f6cSWolfgang Denk R2: reserved for system use 5815c609719bSwdenk R3-R4: parameter passing and return values 5816c609719bSwdenk R5-R10: parameter passing 5817c609719bSwdenk R13: small data area pointer 5818c609719bSwdenk R30: GOT pointer 5819c609719bSwdenk R31: frame pointer 5820c609719bSwdenk 5821e6bee808SJoakim Tjernlund (U-Boot also uses R12 as internal GOT pointer. r12 5822e6bee808SJoakim Tjernlund is a volatile register so r12 needs to be reset when 5823e6bee808SJoakim Tjernlund going back and forth between asm and C) 5824c609719bSwdenk 5825e7670f6cSWolfgang Denk ==> U-Boot will use R2 to hold a pointer to the global data 5826c609719bSwdenk 5827c609719bSwdenk Note: on PPC, we could use a static initializer (since the 5828c609719bSwdenk address of the global data structure is known at compile time), 5829c609719bSwdenk but it turned out that reserving a register results in somewhat 5830c609719bSwdenk smaller code - although the code savings are not that big (on 5831c609719bSwdenk average for all boards 752 bytes for the whole U-Boot image, 5832c609719bSwdenk 624 text + 127 data). 5833c609719bSwdenk 5834c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here: 58354c58eb55SMike Frysinger http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface 58364c58eb55SMike Frysinger 5837c4db335cSRobin Getz ==> U-Boot will use P3 to hold a pointer to the global data 58384c58eb55SMike Frysinger 5839c609719bSwdenkOn ARM, the following registers are used: 5840c609719bSwdenk 5841c609719bSwdenk R0: function argument word/integer result 5842c609719bSwdenk R1-R3: function argument word 584312eba1b4SJeroen Hofstee R9: platform specific 584412eba1b4SJeroen Hofstee R10: stack limit (used only if stack checking is enabled) 5845c609719bSwdenk R11: argument (frame) pointer 5846c609719bSwdenk R12: temporary workspace 5847c609719bSwdenk R13: stack pointer 5848c609719bSwdenk R14: link register 5849c609719bSwdenk R15: program counter 5850c609719bSwdenk 585112eba1b4SJeroen Hofstee ==> U-Boot will use R9 to hold a pointer to the global data 585212eba1b4SJeroen Hofstee 585312eba1b4SJeroen Hofstee Note: on ARM, only R_ARM_RELATIVE relocations are supported. 5854c609719bSwdenk 58550df01fd3SThomas ChouOn Nios II, the ABI is documented here: 58560df01fd3SThomas Chou http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf 58570df01fd3SThomas Chou 58580df01fd3SThomas Chou ==> U-Boot will use gp to hold a pointer to the global data 58590df01fd3SThomas Chou 58600df01fd3SThomas Chou Note: on Nios II, we give "-G0" option to gcc and don't use gp 58610df01fd3SThomas Chou to access small data sections, so gp is free. 58620df01fd3SThomas Chou 5863afc1ce82SMacpaul LinOn NDS32, the following registers are used: 5864afc1ce82SMacpaul Lin 5865afc1ce82SMacpaul Lin R0-R1: argument/return 5866afc1ce82SMacpaul Lin R2-R5: argument 5867afc1ce82SMacpaul Lin R15: temporary register for assembler 5868afc1ce82SMacpaul Lin R16: trampoline register 5869afc1ce82SMacpaul Lin R28: frame pointer (FP) 5870afc1ce82SMacpaul Lin R29: global pointer (GP) 5871afc1ce82SMacpaul Lin R30: link register (LP) 5872afc1ce82SMacpaul Lin R31: stack pointer (SP) 5873afc1ce82SMacpaul Lin PC: program counter (PC) 5874afc1ce82SMacpaul Lin 5875afc1ce82SMacpaul Lin ==> U-Boot will use R10 to hold a pointer to the global data 5876afc1ce82SMacpaul Lin 5877d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope, 5878d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much. 5879c609719bSwdenk 5880c609719bSwdenkMemory Management: 5881c609719bSwdenk------------------ 5882c609719bSwdenk 5883c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the 5884c609719bSwdenkMMU is not used either for address mapping nor for memory protection. 5885c609719bSwdenk 5886c609719bSwdenkThe available memory is mapped to fixed addresses using the memory 5887c609719bSwdenkcontroller. In this process, a contiguous block is formed for each 5888c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several 5889c609719bSwdenkphysical memory banks. 5890c609719bSwdenk 5891c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on 5892c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After 5893c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself 5894c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some 58956d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN 5896c609719bSwdenkconfiguration setting]. Below that, a structure with global Board 5897c609719bSwdenkInfo data is placed, followed by the stack (growing downward). 5898c609719bSwdenk 5899c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB 5900c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF). 5901c609719bSwdenk 5902c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like 5903c609719bSwdenkthis: 5904c609719bSwdenk 5905c609719bSwdenk 0x0000 0000 Exception Vector code 5906c609719bSwdenk : 5907c609719bSwdenk 0x0000 1FFF 5908c609719bSwdenk 0x0000 2000 Free for Application Use 5909c609719bSwdenk : 5910c609719bSwdenk : 5911c609719bSwdenk 5912c609719bSwdenk : 5913c609719bSwdenk : 5914c609719bSwdenk 0x00FB FF20 Monitor Stack (Growing downward) 5915c609719bSwdenk 0x00FB FFAC Board Info Data and permanent copy of global data 5916c609719bSwdenk 0x00FC 0000 Malloc Arena 5917c609719bSwdenk : 5918c609719bSwdenk 0x00FD FFFF 5919c609719bSwdenk 0x00FE 0000 RAM Copy of Monitor Code 5920c609719bSwdenk ... eventually: LCD or video framebuffer 5921c609719bSwdenk ... eventually: pRAM (Protected RAM - unchanged by reset) 5922c609719bSwdenk 0x00FF FFFF [End of RAM] 5923c609719bSwdenk 5924c609719bSwdenk 5925c609719bSwdenkSystem Initialization: 5926c609719bSwdenk---------------------- 5927c609719bSwdenk 5928c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point 592911ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset 5930c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory. 59317152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address. 5932c609719bSwdenkTo be able to implement the initialization code in C, a (small!) 5933c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs 5934c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked 5935c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core, 5936c609719bSwdenkthe caches and the SIU. 5937c609719bSwdenk 5938c609719bSwdenkNext, all (potentially) available memory banks are mapped using a 5939c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries 5940c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash 5941c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is 5942c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a 5943c609719bSwdenksimple memory test is run that determines the size of the SDRAM 5944c609719bSwdenkbanks. 5945c609719bSwdenk 5946c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of 59477152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first 5948c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address 5949c609719bSwdenk0x00000000, with any additional banks following immediately to create 5950c609719bSwdenkcontiguous memory starting from 0. 5951c609719bSwdenk 5952c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area 5953c609719bSwdenkand allocates memory for use by malloc() and for the global Board 5954c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM 5955c609719bSwdenkpages, and the final stack is set up. 5956c609719bSwdenk 5957c609719bSwdenkOnly after this relocation will you have a "normal" C environment; 5958c609719bSwdenkuntil that you are restricted in several ways, mostly because you are 5959c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a 5960c609719bSwdenknew address in RAM. 5961c609719bSwdenk 5962c609719bSwdenk 5963c609719bSwdenkU-Boot Porting Guide: 5964c609719bSwdenk---------------------- 5965c609719bSwdenk 5966c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing 59676aff3115Swdenklist, October 2002] 5968c609719bSwdenk 5969c609719bSwdenk 5970c609719bSwdenkint main(int argc, char *argv[]) 5971c609719bSwdenk{ 5972c609719bSwdenk sighandler_t no_more_time; 5973c609719bSwdenk 5974c609719bSwdenk signal(SIGALRM, no_more_time); 5975c609719bSwdenk alarm(PROJECT_DEADLINE - toSec (3 * WEEK)); 5976c609719bSwdenk 5977c609719bSwdenk if (available_money > available_manpower) { 59786c3fef28SJerry Van Baren Pay consultant to port U-Boot; 5979c609719bSwdenk return 0; 5980c609719bSwdenk } 5981c609719bSwdenk 5982c609719bSwdenk Download latest U-Boot source; 5983c609719bSwdenk 59840668236bSWolfgang Denk Subscribe to u-boot mailing list; 59856aff3115Swdenk 59866c3fef28SJerry Van Baren if (clueless) 5987c609719bSwdenk email("Hi, I am new to U-Boot, how do I get started?"); 5988c609719bSwdenk 5989c609719bSwdenk while (learning) { 5990c609719bSwdenk Read the README file in the top level directory; 59917cb22f97Swdenk Read http://www.denx.de/twiki/bin/view/DULG/Manual; 59926c3fef28SJerry Van Baren Read applicable doc/*.README; 5993c609719bSwdenk Read the source, Luke; 59946c3fef28SJerry Van Baren /* find . -name "*.[chS]" | xargs grep -i <keyword> */ 5995c609719bSwdenk } 5996c609719bSwdenk 59976c3fef28SJerry Van Baren if (available_money > toLocalCurrency ($2500)) 59986c3fef28SJerry Van Baren Buy a BDI3000; 59996c3fef28SJerry Van Baren else 6000c609719bSwdenk Add a lot of aggravation and time; 6001c609719bSwdenk 60026c3fef28SJerry Van Baren if (a similar board exists) { /* hopefully... */ 60036c3fef28SJerry Van Baren cp -a board/<similar> board/<myboard> 60046c3fef28SJerry Van Baren cp include/configs/<similar>.h include/configs/<myboard>.h 60056c3fef28SJerry Van Baren } else { 6006c609719bSwdenk Create your own board support subdirectory; 60076c3fef28SJerry Van Baren Create your own board include/configs/<myboard>.h file; 60086c3fef28SJerry Van Baren } 60096c3fef28SJerry Van Baren Edit new board/<myboard> files 60106c3fef28SJerry Van Baren Edit new include/configs/<myboard>.h 6011c609719bSwdenk 60126c3fef28SJerry Van Baren while (!accepted) { 6013c609719bSwdenk while (!running) { 6014c609719bSwdenk do { 6015c609719bSwdenk Add / modify source code; 6016c609719bSwdenk } until (compiles); 6017c609719bSwdenk Debug; 6018c609719bSwdenk if (clueless) 6019c609719bSwdenk email("Hi, I am having problems..."); 6020c609719bSwdenk } 60216c3fef28SJerry Van Baren Send patch file to the U-Boot email list; 60226c3fef28SJerry Van Baren if (reasonable critiques) 60236c3fef28SJerry Van Baren Incorporate improvements from email list code review; 60246c3fef28SJerry Van Baren else 60256c3fef28SJerry Van Baren Defend code as written; 60266c3fef28SJerry Van Baren } 6027c609719bSwdenk 6028c609719bSwdenk return 0; 6029c609719bSwdenk} 6030c609719bSwdenk 6031c609719bSwdenkvoid no_more_time (int sig) 6032c609719bSwdenk{ 6033c609719bSwdenk hire_a_guru(); 6034c609719bSwdenk} 6035c609719bSwdenk 6036c609719bSwdenk 6037c609719bSwdenkCoding Standards: 6038c609719bSwdenk----------------- 6039c609719bSwdenk 6040c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel 60412c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script 60427ca9296eSWolfgang Denk"scripts/Lindent" in your Linux kernel source directory. 6043c609719bSwdenk 60442c051651SDetlev ZundelSource files originating from a different project (for example the 60452c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not 60462c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those 60472c051651SDetlev Zundelsources. 60482c051651SDetlev Zundel 60492c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in 60502c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//) 60512c051651SDetlev Zundelin your code. 6052c609719bSwdenk 6053c178d3daSwdenkPlease also stick to the following formatting rules: 6054180d3f74Swdenk- remove any trailing white space 60557ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces 6056180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds 60577ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files 6058180d3f74Swdenk- do not add trailing empty lines to source files 6059180d3f74Swdenk 6060c609719bSwdenkSubmissions which do not conform to the standards may be returned 6061c609719bSwdenkwith a request to reformat the changes. 6062c609719bSwdenk 6063c609719bSwdenk 6064c609719bSwdenkSubmitting Patches: 6065c609719bSwdenk------------------- 6066c609719bSwdenk 6067c609719bSwdenkSince the number of patches for U-Boot is growing, we need to 6068c609719bSwdenkestablish some rules. Submissions which do not conform to these rules 6069c609719bSwdenkmay be rejected, even when they contain important and valuable stuff. 6070c609719bSwdenk 60710d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details. 6072218ca724SWolfgang Denk 60730668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>; 60740668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot 60750668236bSWolfgang Denk 6076c609719bSwdenkWhen you send a patch, please include the following information with 6077c609719bSwdenkit: 6078c609719bSwdenk 6079c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes 6080c609719bSwdenk this bug. Please try to include a way of demonstrating that the 6081c609719bSwdenk patch actually fixes something. 6082c609719bSwdenk 6083c609719bSwdenk* For new features: a description of the feature and your 6084c609719bSwdenk implementation. 6085c609719bSwdenk 6086c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch) 6087c609719bSwdenk 6088c609719bSwdenk* For major contributions, your entry to the CREDITS file 6089c609719bSwdenk 609027af930eSAlbert ARIBAUD* When you add support for a new board, don't forget to add a 609127af930eSAlbert ARIBAUD maintainer e-mail address to the boards.cfg file, too. 6092c609719bSwdenk 6093c609719bSwdenk* If your patch adds new configuration options, don't forget to 6094c609719bSwdenk document these in the README file. 6095c609719bSwdenk 6096218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly* 6097218ca724SWolfgang Denk recommended) you can easily generate the patch using the 60987ca9296eSWolfgang Denk "git format-patch". If you then use "git send-email" to send it to 6099218ca724SWolfgang Denk the U-Boot mailing list, you will avoid most of the common problems 6100218ca724SWolfgang Denk with some other mail clients. 6101c609719bSwdenk 6102218ca724SWolfgang Denk If you cannot use git, use "diff -purN OLD NEW". If your version of 6103218ca724SWolfgang Denk diff does not support these options, then get the latest version of 6104218ca724SWolfgang Denk GNU diff. 61056dff5529Swdenk 6106218ca724SWolfgang Denk The current directory when running this command shall be the parent 6107218ca724SWolfgang Denk directory of the U-Boot source tree (i. e. please make sure that 6108218ca724SWolfgang Denk your patch includes sufficient directory information for the 6109218ca724SWolfgang Denk affected files). 6110218ca724SWolfgang Denk 6111218ca724SWolfgang Denk We prefer patches as plain text. MIME attachments are discouraged, 6112218ca724SWolfgang Denk and compressed attachments must not be used. 6113c609719bSwdenk 611452f52c14Swdenk* If one logical set of modifications affects or creates several 611552f52c14Swdenk files, all these changes shall be submitted in a SINGLE patch file. 611652f52c14Swdenk 611752f52c14Swdenk* Changesets that contain different, unrelated modifications shall be 611852f52c14Swdenk submitted as SEPARATE patches, one patch per changeset. 611952f52c14Swdenk 612052f52c14Swdenk 6121c609719bSwdenkNotes: 6122c609719bSwdenk 6123c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched 6124c609719bSwdenk source tree and make sure that no errors or warnings are reported 6125c609719bSwdenk for any of the boards. 6126c609719bSwdenk 6127c609719bSwdenk* Keep your modifications to the necessary minimum: A patch 6128c609719bSwdenk containing several unrelated changes or arbitrary reformats will be 6129c609719bSwdenk returned with a request to re-formatting / split it. 6130c609719bSwdenk 6131c609719bSwdenk* If you modify existing code, make sure that your new code does not 6132c609719bSwdenk add to the memory footprint of the code ;-) Small is beautiful! 6133c609719bSwdenk When adding new features, these should compile conditionally only 6134c609719bSwdenk (using #ifdef), and the resulting code with the new feature 6135c609719bSwdenk disabled must not need more memory than the old code without your 6136c609719bSwdenk modification. 613790dc6704Swdenk 61380668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the 61390668236bSWolfgang Denk u-boot mailing list. Bigger patches will be moderated. If they are 61400668236bSWolfgang Denk reasonable and not too big, they will be acknowledged. But patches 61410668236bSWolfgang Denk bigger than the size limit should be avoided. 6142