1c609719bSwdenk# 2eca3aeb3SWolfgang Denk# (C) Copyright 2000 - 2013 3c609719bSwdenk# Wolfgang Denk, DENX Software Engineering, wd@denx.de. 4c609719bSwdenk# 5eca3aeb3SWolfgang Denk# SPDX-License-Identifier: GPL-2.0+ 6c609719bSwdenk# 7c609719bSwdenk 8c609719bSwdenkSummary: 9c609719bSwdenk======== 10c609719bSwdenk 1124ee89b9SwdenkThis directory contains the source code for U-Boot, a boot loader for 12e86e5a07SwdenkEmbedded boards based on PowerPC, ARM, MIPS and several other 13e86e5a07Swdenkprocessors, which can be installed in a boot ROM and used to 14e86e5a07Swdenkinitialize and test the hardware or to download and run application 15e86e5a07Swdenkcode. 16c609719bSwdenk 17c609719bSwdenkThe development of U-Boot is closely related to Linux: some parts of 1824ee89b9Swdenkthe source code originate in the Linux source tree, we have some 1924ee89b9Swdenkheader files in common, and special provision has been made to 20c609719bSwdenksupport booting of Linux images. 21c609719bSwdenk 22c609719bSwdenkSome attention has been paid to make this software easily 23c609719bSwdenkconfigurable and extendable. For instance, all monitor commands are 24c609719bSwdenkimplemented with the same call interface, so that it's very easy to 25c609719bSwdenkadd new commands. Also, instead of permanently adding rarely used 26c609719bSwdenkcode (for instance hardware test utilities) to the monitor, you can 27c609719bSwdenkload and run it dynamically. 28c609719bSwdenk 29c609719bSwdenk 30c609719bSwdenkStatus: 31c609719bSwdenk======= 32c609719bSwdenk 33c609719bSwdenkIn general, all boards for which a configuration option exists in the 34c609719bSwdenkMakefile have been tested to some extent and can be considered 35c609719bSwdenk"working". In fact, many of them are used in production systems. 36c609719bSwdenk 37c609719bSwdenkIn case of problems see the CHANGELOG and CREDITS files to find out 3827af930eSAlbert ARIBAUDwho contributed the specific port. The boards.cfg file lists board 39218ca724SWolfgang Denkmaintainers. 40c609719bSwdenk 41adb9d851SRobert P. J. DayNote: There is no CHANGELOG file in the actual U-Boot source tree; 42adb9d851SRobert P. J. Dayit can be created dynamically from the Git log using: 43adb9d851SRobert P. J. Day 44adb9d851SRobert P. J. Day make CHANGELOG 45adb9d851SRobert P. J. Day 46c609719bSwdenk 47c609719bSwdenkWhere to get help: 48c609719bSwdenk================== 49c609719bSwdenk 50c609719bSwdenkIn case you have questions about, problems with or contributions for 51c609719bSwdenkU-Boot you should send a message to the U-Boot mailing list at 520c32565fSPeter Tyser<u-boot@lists.denx.de>. There is also an archive of previous traffic 530c32565fSPeter Tyseron the mailing list - please search the archive before asking FAQ's. 540c32565fSPeter TyserPlease see http://lists.denx.de/pipermail/u-boot and 550c32565fSPeter Tyserhttp://dir.gmane.org/gmane.comp.boot-loaders.u-boot 56c609719bSwdenk 57c609719bSwdenk 58218ca724SWolfgang DenkWhere to get source code: 59218ca724SWolfgang Denk========================= 60218ca724SWolfgang Denk 61218ca724SWolfgang DenkThe U-Boot source code is maintained in the git repository at 62218ca724SWolfgang Denkgit://www.denx.de/git/u-boot.git ; you can browse it online at 63218ca724SWolfgang Denkhttp://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary 64218ca724SWolfgang Denk 65218ca724SWolfgang DenkThe "snapshot" links on this page allow you to download tarballs of 6611ccc33fSMarcel Ziswilerany version you might be interested in. Official releases are also 67218ca724SWolfgang Denkavailable for FTP download from the ftp://ftp.denx.de/pub/u-boot/ 68218ca724SWolfgang Denkdirectory. 69218ca724SWolfgang Denk 70d4ee711dSAnatolij GustschinPre-built (and tested) images are available from 71218ca724SWolfgang Denkftp://ftp.denx.de/pub/u-boot/images/ 72218ca724SWolfgang Denk 73218ca724SWolfgang Denk 74c609719bSwdenkWhere we come from: 75c609719bSwdenk=================== 76c609719bSwdenk 77c609719bSwdenk- start from 8xxrom sources 7824ee89b9Swdenk- create PPCBoot project (http://sourceforge.net/projects/ppcboot) 79c609719bSwdenk- clean up code 80c609719bSwdenk- make it easier to add custom boards 81c609719bSwdenk- make it possible to add other [PowerPC] CPUs 82c609719bSwdenk- extend functions, especially: 83c609719bSwdenk * Provide extended interface to Linux boot loader 84c609719bSwdenk * S-Record download 85c609719bSwdenk * network boot 8611ccc33fSMarcel Ziswiler * PCMCIA / CompactFlash / ATA disk / SCSI ... boot 8724ee89b9Swdenk- create ARMBoot project (http://sourceforge.net/projects/armboot) 88c609719bSwdenk- add other CPU families (starting with ARM) 8924ee89b9Swdenk- create U-Boot project (http://sourceforge.net/projects/u-boot) 900d28f34bSMagnus Lilja- current project page: see http://www.denx.de/wiki/U-Boot 9124ee89b9Swdenk 9224ee89b9Swdenk 9324ee89b9SwdenkNames and Spelling: 9424ee89b9Swdenk=================== 9524ee89b9Swdenk 9624ee89b9SwdenkThe "official" name of this project is "Das U-Boot". The spelling 9724ee89b9Swdenk"U-Boot" shall be used in all written text (documentation, comments 9824ee89b9Swdenkin source files etc.). Example: 9924ee89b9Swdenk 10024ee89b9Swdenk This is the README file for the U-Boot project. 10124ee89b9Swdenk 10224ee89b9SwdenkFile names etc. shall be based on the string "u-boot". Examples: 10324ee89b9Swdenk 10424ee89b9Swdenk include/asm-ppc/u-boot.h 10524ee89b9Swdenk 10624ee89b9Swdenk #include <asm/u-boot.h> 10724ee89b9Swdenk 10824ee89b9SwdenkVariable names, preprocessor constants etc. shall be either based on 10924ee89b9Swdenkthe string "u_boot" or on "U_BOOT". Example: 11024ee89b9Swdenk 11124ee89b9Swdenk U_BOOT_VERSION u_boot_logo 11224ee89b9Swdenk IH_OS_U_BOOT u_boot_hush_start 113c609719bSwdenk 114c609719bSwdenk 11593f19cc0SwdenkVersioning: 11693f19cc0Swdenk=========== 11793f19cc0Swdenk 118360d883aSThomas WeberStarting with the release in October 2008, the names of the releases 119360d883aSThomas Weberwere changed from numerical release numbers without deeper meaning 120360d883aSThomas Weberinto a time stamp based numbering. Regular releases are identified by 121360d883aSThomas Webernames consisting of the calendar year and month of the release date. 122360d883aSThomas WeberAdditional fields (if present) indicate release candidates or bug fix 123360d883aSThomas Weberreleases in "stable" maintenance trees. 12493f19cc0Swdenk 125360d883aSThomas WeberExamples: 126360d883aSThomas Weber U-Boot v2009.11 - Release November 2009 127360d883aSThomas Weber U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree 128360d883aSThomas Weber U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release 12993f19cc0Swdenk 13093f19cc0Swdenk 131c609719bSwdenkDirectory Hierarchy: 132c609719bSwdenk==================== 133c609719bSwdenk 1348d321b81SPeter Tyser/arch Architecture specific files 1358d321b81SPeter Tyser /arm Files generic to ARM architecture 1368d321b81SPeter Tyser /cpu CPU specific files 1378d321b81SPeter Tyser /arm720t Files specific to ARM 720 CPUs 1388d321b81SPeter Tyser /arm920t Files specific to ARM 920 CPUs 1396eb0921aSAndreas Bießmann /at91 Files specific to Atmel AT91RM9200 CPU 1408d321b81SPeter Tyser /imx Files specific to Freescale MC9328 i.MX CPUs 1418d321b81SPeter Tyser /s3c24x0 Files specific to Samsung S3C24X0 CPUs 1428d321b81SPeter Tyser /arm926ejs Files specific to ARM 926 CPUs 1438d321b81SPeter Tyser /arm1136 Files specific to ARM 1136 CPUs 1448d321b81SPeter Tyser /ixp Files specific to Intel XScale IXP CPUs 1458d321b81SPeter Tyser /pxa Files specific to Intel XScale PXA CPUs 1468d321b81SPeter Tyser /sa1100 Files specific to Intel StrongARM SA1100 CPUs 1478d321b81SPeter Tyser /lib Architecture specific library files 1488d321b81SPeter Tyser /avr32 Files generic to AVR32 architecture 1498d321b81SPeter Tyser /cpu CPU specific files 1508d321b81SPeter Tyser /lib Architecture specific library files 1518d321b81SPeter Tyser /blackfin Files generic to Analog Devices Blackfin architecture 1528d321b81SPeter Tyser /cpu CPU specific files 1538d321b81SPeter Tyser /lib Architecture specific library files 1548d321b81SPeter Tyser /m68k Files generic to m68k architecture 1558d321b81SPeter Tyser /cpu CPU specific files 1568d321b81SPeter Tyser /mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs 1578d321b81SPeter Tyser /mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs 1588d321b81SPeter Tyser /mcf532x Files specific to Freescale ColdFire MCF5329 CPUs 1598d321b81SPeter Tyser /mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs 1608d321b81SPeter Tyser /mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs 1618d321b81SPeter Tyser /lib Architecture specific library files 1628d321b81SPeter Tyser /microblaze Files generic to microblaze architecture 1638d321b81SPeter Tyser /cpu CPU specific files 1648d321b81SPeter Tyser /lib Architecture specific library files 1658d321b81SPeter Tyser /mips Files generic to MIPS architecture 1668d321b81SPeter Tyser /cpu CPU specific files 16792bbd64eSDaniel Schwierzeck /mips32 Files specific to MIPS32 CPUs 16880421fccSXiangfu Liu /xburst Files specific to Ingenic XBurst CPUs 1698d321b81SPeter Tyser /lib Architecture specific library files 170afc1ce82SMacpaul Lin /nds32 Files generic to NDS32 architecture 171afc1ce82SMacpaul Lin /cpu CPU specific files 172afc1ce82SMacpaul Lin /n1213 Files specific to Andes Technology N1213 CPUs 173afc1ce82SMacpaul Lin /lib Architecture specific library files 1748d321b81SPeter Tyser /nios2 Files generic to Altera NIOS2 architecture 1758d321b81SPeter Tyser /cpu CPU specific files 1768d321b81SPeter Tyser /lib Architecture specific library files 17733c7731bSRobert P. J. Day /openrisc Files generic to OpenRISC architecture 17833c7731bSRobert P. J. Day /cpu CPU specific files 17933c7731bSRobert P. J. Day /lib Architecture specific library files 180a47a12beSStefan Roese /powerpc Files generic to PowerPC architecture 1818d321b81SPeter Tyser /cpu CPU specific files 1828d321b81SPeter Tyser /74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs 1838d321b81SPeter Tyser /mpc5xx Files specific to Freescale MPC5xx CPUs 1848d321b81SPeter Tyser /mpc5xxx Files specific to Freescale MPC5xxx CPUs 1858d321b81SPeter Tyser /mpc8xx Files specific to Freescale MPC8xx CPUs 1868d321b81SPeter Tyser /mpc824x Files specific to Freescale MPC824x CPUs 1878d321b81SPeter Tyser /mpc8260 Files specific to Freescale MPC8260 CPUs 1888d321b81SPeter Tyser /mpc85xx Files specific to Freescale MPC85xx CPUs 1898d321b81SPeter Tyser /ppc4xx Files specific to AMCC PowerPC 4xx CPUs 1908d321b81SPeter Tyser /lib Architecture specific library files 1918d321b81SPeter Tyser /sh Files generic to SH architecture 1928d321b81SPeter Tyser /cpu CPU specific files 1938d321b81SPeter Tyser /sh2 Files specific to sh2 CPUs 1948d321b81SPeter Tyser /sh3 Files specific to sh3 CPUs 1958d321b81SPeter Tyser /sh4 Files specific to sh4 CPUs 1968d321b81SPeter Tyser /lib Architecture specific library files 1978d321b81SPeter Tyser /sparc Files generic to SPARC architecture 1988d321b81SPeter Tyser /cpu CPU specific files 1998d321b81SPeter Tyser /leon2 Files specific to Gaisler LEON2 SPARC CPU 2008d321b81SPeter Tyser /leon3 Files specific to Gaisler LEON3 SPARC CPU 2018d321b81SPeter Tyser /lib Architecture specific library files 20233c7731bSRobert P. J. Day /x86 Files generic to x86 architecture 20333c7731bSRobert P. J. Day /cpu CPU specific files 20433c7731bSRobert P. J. Day /lib Architecture specific library files 2058d321b81SPeter Tyser/api Machine/arch independent API for external apps 2068d321b81SPeter Tyser/board Board dependent files 2078d321b81SPeter Tyser/common Misc architecture independent functions 2088d321b81SPeter Tyser/disk Code for disk drive partition handling 2098d321b81SPeter Tyser/doc Documentation (don't expect too much) 2108d321b81SPeter Tyser/drivers Commonly used device drivers 21133c7731bSRobert P. J. Day/dts Contains Makefile for building internal U-Boot fdt. 2128d321b81SPeter Tyser/examples Example code for standalone applications, etc. 2138d321b81SPeter Tyser/fs Filesystem code (cramfs, ext2, jffs2, etc.) 2148d321b81SPeter Tyser/include Header Files 2158d321b81SPeter Tyser/lib Files generic to all architectures 2168d321b81SPeter Tyser /libfdt Library files to support flattened device trees 2178d321b81SPeter Tyser /lzma Library files to support LZMA decompression 2188d321b81SPeter Tyser /lzo Library files to support LZO decompression 2198d321b81SPeter Tyser/net Networking code 2208d321b81SPeter Tyser/post Power On Self Test 22133c7731bSRobert P. J. Day/spl Secondary Program Loader framework 2228d321b81SPeter Tyser/tools Tools to build S-Record or U-Boot images, etc. 223c609719bSwdenk 224c609719bSwdenkSoftware Configuration: 225c609719bSwdenk======================= 226c609719bSwdenk 227c609719bSwdenkConfiguration is usually done using C preprocessor defines; the 228c609719bSwdenkrationale behind that is to avoid dead code whenever possible. 229c609719bSwdenk 230c609719bSwdenkThere are two classes of configuration variables: 231c609719bSwdenk 232c609719bSwdenk* Configuration _OPTIONS_: 233c609719bSwdenk These are selectable by the user and have names beginning with 234c609719bSwdenk "CONFIG_". 235c609719bSwdenk 236c609719bSwdenk* Configuration _SETTINGS_: 237c609719bSwdenk These depend on the hardware etc. and should not be meddled with if 238c609719bSwdenk you don't know what you're doing; they have names beginning with 2396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD "CONFIG_SYS_". 240c609719bSwdenk 241c609719bSwdenkLater we will add a configuration tool - probably similar to or even 242c609719bSwdenkidentical to what's used for the Linux kernel. Right now, we have to 243c609719bSwdenkdo the configuration by hand, which means creating some symbolic 244c609719bSwdenklinks and editing some configuration files. We use the TQM8xxL boards 245c609719bSwdenkas an example here. 246c609719bSwdenk 247c609719bSwdenk 248c609719bSwdenkSelection of Processor Architecture and Board Type: 249c609719bSwdenk--------------------------------------------------- 250c609719bSwdenk 251c609719bSwdenkFor all supported boards there are ready-to-use default 252c609719bSwdenkconfigurations available; just type "make <board_name>_config". 253c609719bSwdenk 254c609719bSwdenkExample: For a TQM823L module type: 255c609719bSwdenk 256c609719bSwdenk cd u-boot 257c609719bSwdenk make TQM823L_config 258c609719bSwdenk 25911ccc33fSMarcel ZiswilerFor the Cogent platform, you need to specify the CPU type as well; 260c609719bSwdenke.g. "make cogent_mpc8xx_config". And also configure the cogent 261c609719bSwdenkdirectory according to the instructions in cogent/README. 262c609719bSwdenk 263c609719bSwdenk 264c609719bSwdenkConfiguration Options: 265c609719bSwdenk---------------------- 266c609719bSwdenk 267c609719bSwdenkConfiguration depends on the combination of board and CPU type; all 268c609719bSwdenksuch information is kept in a configuration file 269c609719bSwdenk"include/configs/<board_name>.h". 270c609719bSwdenk 271c609719bSwdenkExample: For a TQM823L module, all configuration settings are in 272c609719bSwdenk"include/configs/TQM823L.h". 273c609719bSwdenk 274c609719bSwdenk 2757f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux 2767f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to 2777f6c2cbcSwdenkbuild a config tool - later. 2787f6c2cbcSwdenk 2797f6c2cbcSwdenk 280c609719bSwdenkThe following options need to be configured: 281c609719bSwdenk 2822628114eSKim Phillips- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX. 283c609719bSwdenk 2842628114eSKim Phillips- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS. 2856ccec449SWolfgang Denk 2866ccec449SWolfgang Denk- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined) 28709ea0de0SHaavard Skinnemoen Define exactly one, e.g. CONFIG_ATSTK1002 288c609719bSwdenk 289c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined) 290c609719bSwdenk Define exactly one of 291c609719bSwdenk CONFIG_CMA286_60_OLD 292c609719bSwdenk--- FIXME --- not tested yet: 293c609719bSwdenk CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P, 294c609719bSwdenk CONFIG_CMA287_23, CONFIG_CMA287_50 295c609719bSwdenk 296c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined) 297c609719bSwdenk Define exactly one of 298c609719bSwdenk CONFIG_CMA101, CONFIG_CMA102 299c609719bSwdenk 300c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined) 301c609719bSwdenk Define one or more of 302c609719bSwdenk CONFIG_CMA302 303c609719bSwdenk 304c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined) 305c609719bSwdenk Define one or more of 306c609719bSwdenk CONFIG_LCD_HEARTBEAT - update a character position on 30711ccc33fSMarcel Ziswiler the LCD display every second with 308c609719bSwdenk a "rotator" |\-/|\-/ 309c609719bSwdenk 3102535d602Swdenk- Board flavour: (if CONFIG_MPC8260ADS is defined) 3112535d602Swdenk CONFIG_ADSTYPE 3122535d602Swdenk Possible values are: 3136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8260ADS - original MPC8260ADS 3146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8266ADS - MPC8266ADS 3156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR 3166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8272ADS - MPC8272ADS 3172535d602Swdenk 318cf946c6dSLei Wen- Marvell Family Member 319cf946c6dSLei Wen CONFIG_SYS_MVFS - define it if you want to enable 320cf946c6dSLei Wen multiple fs option at one time 321cf946c6dSLei Wen for marvell soc family 322cf946c6dSLei Wen 323c609719bSwdenk- MPC824X Family Member (if CONFIG_MPC824X is defined) 324c609719bSwdenk Define exactly one of 325c609719bSwdenk CONFIG_MPC8240, CONFIG_MPC8245 326c609719bSwdenk 32711ccc33fSMarcel Ziswiler- 8xx CPU Options: (if using an MPC8xx CPU) 32866ca92a5Swdenk CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if 32966ca92a5Swdenk get_gclk_freq() cannot work 3305da627a4Swdenk e.g. if there is no 32KHz 3315da627a4Swdenk reference PIT/RTC clock 33266ca92a5Swdenk CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK 33366ca92a5Swdenk or XTAL/EXTAL) 334c609719bSwdenk 33566ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU): 3366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8xx_CPUCLK_MIN 3376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8xx_CPUCLK_MAX 33866ca92a5Swdenk CONFIG_8xx_CPUCLK_DEFAULT 33975d1ea7fSwdenk See doc/README.MPC866 34075d1ea7fSwdenk 3416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MEASURE_CPUCLK 34275d1ea7fSwdenk 34375d1ea7fSwdenk Define this to measure the actual CPU clock instead 34475d1ea7fSwdenk of relying on the correctness of the configured 34575d1ea7fSwdenk values. Mostly useful for board bringup to make sure 34675d1ea7fSwdenk the PLL is locked at the intended frequency. Note 34775d1ea7fSwdenk that this requires a (stable) reference clock (32 kHz 3486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD RTC clock or CONFIG_SYS_8XX_XIN) 34975d1ea7fSwdenk 350506f3918SHeiko Schocher CONFIG_SYS_DELAYED_ICACHE 351506f3918SHeiko Schocher 352506f3918SHeiko Schocher Define this option if you want to enable the 353506f3918SHeiko Schocher ICache only when Code runs from RAM. 354506f3918SHeiko Schocher 35566412c63SKumar Gala- 85xx CPU Options: 356ffd06e02SYork Sun CONFIG_SYS_PPC64 357ffd06e02SYork Sun 358ffd06e02SYork Sun Specifies that the core is a 64-bit PowerPC implementation (implements 359ffd06e02SYork Sun the "64" category of the Power ISA). This is necessary for ePAPR 360ffd06e02SYork Sun compliance, among other possible reasons. 361ffd06e02SYork Sun 36266412c63SKumar Gala CONFIG_SYS_FSL_TBCLK_DIV 36366412c63SKumar Gala 36466412c63SKumar Gala Defines the core time base clock divider ratio compared to the 36566412c63SKumar Gala system clock. On most PQ3 devices this is 8, on newer QorIQ 36666412c63SKumar Gala devices it can be 16 or 32. The ratio varies from SoC to Soc. 36766412c63SKumar Gala 3688f29084aSKumar Gala CONFIG_SYS_FSL_PCIE_COMPAT 3698f29084aSKumar Gala 3708f29084aSKumar Gala Defines the string to utilize when trying to match PCIe device 3718f29084aSKumar Gala tree nodes for the given platform. 3728f29084aSKumar Gala 373afa6b551SPrabhakar Kushwaha CONFIG_SYS_PPC_E500_DEBUG_TLB 374afa6b551SPrabhakar Kushwaha 375afa6b551SPrabhakar Kushwaha Enables a temporary TLB entry to be used during boot to work 376afa6b551SPrabhakar Kushwaha around limitations in e500v1 and e500v2 external debugger 377afa6b551SPrabhakar Kushwaha support. This reduces the portions of the boot code where 378afa6b551SPrabhakar Kushwaha breakpoints and single stepping do not work. The value of this 379afa6b551SPrabhakar Kushwaha symbol should be set to the TLB1 entry to be used for this 380afa6b551SPrabhakar Kushwaha purpose. 381afa6b551SPrabhakar Kushwaha 38233eee330SScott Wood CONFIG_SYS_FSL_ERRATUM_A004510 38333eee330SScott Wood 38433eee330SScott Wood Enables a workaround for erratum A004510. If set, 38533eee330SScott Wood then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and 38633eee330SScott Wood CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set. 38733eee330SScott Wood 38833eee330SScott Wood CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV 38933eee330SScott Wood CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional) 39033eee330SScott Wood 39133eee330SScott Wood Defines one or two SoC revisions (low 8 bits of SVR) 39233eee330SScott Wood for which the A004510 workaround should be applied. 39333eee330SScott Wood 39433eee330SScott Wood The rest of SVR is either not relevant to the decision 39533eee330SScott Wood of whether the erratum is present (e.g. p2040 versus 39633eee330SScott Wood p2041) or is implied by the build target, which controls 39733eee330SScott Wood whether CONFIG_SYS_FSL_ERRATUM_A004510 is set. 39833eee330SScott Wood 39933eee330SScott Wood See Freescale App Note 4493 for more information about 40033eee330SScott Wood this erratum. 40133eee330SScott Wood 40274fa22edSPrabhakar Kushwaha CONFIG_A003399_NOR_WORKAROUND 40374fa22edSPrabhakar Kushwaha Enables a workaround for IFC erratum A003399. It is only 40474fa22edSPrabhakar Kushwaha requred during NOR boot. 40574fa22edSPrabhakar Kushwaha 40633eee330SScott Wood CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY 40733eee330SScott Wood 40833eee330SScott Wood This is the value to write into CCSR offset 0x18600 40933eee330SScott Wood according to the A004510 workaround. 41033eee330SScott Wood 41164501c66SPriyanka Jain CONFIG_SYS_FSL_DSP_DDR_ADDR 41264501c66SPriyanka Jain This value denotes start offset of DDR memory which is 41364501c66SPriyanka Jain connected exclusively to the DSP cores. 41464501c66SPriyanka Jain 415765b0bdbSPriyanka Jain CONFIG_SYS_FSL_DSP_M2_RAM_ADDR 416765b0bdbSPriyanka Jain This value denotes start offset of M2 memory 417765b0bdbSPriyanka Jain which is directly connected to the DSP core. 418765b0bdbSPriyanka Jain 41964501c66SPriyanka Jain CONFIG_SYS_FSL_DSP_M3_RAM_ADDR 42064501c66SPriyanka Jain This value denotes start offset of M3 memory which is directly 42164501c66SPriyanka Jain connected to the DSP core. 42264501c66SPriyanka Jain 423765b0bdbSPriyanka Jain CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT 424765b0bdbSPriyanka Jain This value denotes start offset of DSP CCSR space. 425765b0bdbSPriyanka Jain 426*b135991aSPriyanka Jain CONFIG_SYS_FSL_SINGLE_SOURCE_CLK 427*b135991aSPriyanka Jain Single Source Clock is clocking mode present in some of FSL SoC's. 428*b135991aSPriyanka Jain In this mode, a single differential clock is used to supply 429*b135991aSPriyanka Jain clocks to the sysclock, ddrclock and usbclock. 430*b135991aSPriyanka Jain 4316cb461b4SDaniel Schwierzeck- Generic CPU options: 4326cb461b4SDaniel Schwierzeck CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN 4336cb461b4SDaniel Schwierzeck 4346cb461b4SDaniel Schwierzeck Defines the endianess of the CPU. Implementation of those 4356cb461b4SDaniel Schwierzeck values is arch specific. 4366cb461b4SDaniel Schwierzeck 4375614e71bSYork Sun CONFIG_SYS_FSL_DDR 4385614e71bSYork Sun Freescale DDR driver in use. This type of DDR controller is 4395614e71bSYork Sun found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core 4405614e71bSYork Sun SoCs. 4415614e71bSYork Sun 4425614e71bSYork Sun CONFIG_SYS_FSL_DDR_ADDR 4435614e71bSYork Sun Freescale DDR memory-mapped register base. 4445614e71bSYork Sun 4455614e71bSYork Sun CONFIG_SYS_FSL_DDR_EMU 4465614e71bSYork Sun Specify emulator support for DDR. Some DDR features such as 4475614e71bSYork Sun deskew training are not available. 4485614e71bSYork Sun 4495614e71bSYork Sun CONFIG_SYS_FSL_DDRC_GEN1 4505614e71bSYork Sun Freescale DDR1 controller. 4515614e71bSYork Sun 4525614e71bSYork Sun CONFIG_SYS_FSL_DDRC_GEN2 4535614e71bSYork Sun Freescale DDR2 controller. 4545614e71bSYork Sun 4555614e71bSYork Sun CONFIG_SYS_FSL_DDRC_GEN3 4565614e71bSYork Sun Freescale DDR3 controller. 4575614e71bSYork Sun 4589ac4ffbdSYork Sun CONFIG_SYS_FSL_DDRC_ARM_GEN3 4599ac4ffbdSYork Sun Freescale DDR3 controller for ARM-based SoCs. 4609ac4ffbdSYork Sun 4615614e71bSYork Sun CONFIG_SYS_FSL_DDR1 4625614e71bSYork Sun Board config to use DDR1. It can be enabled for SoCs with 4635614e71bSYork Sun Freescale DDR1 or DDR2 controllers, depending on the board 4645614e71bSYork Sun implemetation. 4655614e71bSYork Sun 4665614e71bSYork Sun CONFIG_SYS_FSL_DDR2 4675614e71bSYork Sun Board config to use DDR2. It can be eanbeld for SoCs with 4685614e71bSYork Sun Freescale DDR2 or DDR3 controllers, depending on the board 4695614e71bSYork Sun implementation. 4705614e71bSYork Sun 4715614e71bSYork Sun CONFIG_SYS_FSL_DDR3 4725614e71bSYork Sun Board config to use DDR3. It can be enabled for SoCs with 4735614e71bSYork Sun Freescale DDR3 controllers. 4745614e71bSYork Sun 4750b953ffcSMarkus Klotzbuecher- Intel Monahans options: 4766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO 4770b953ffcSMarkus Klotzbuecher 4780b953ffcSMarkus Klotzbuecher Defines the Monahans run mode to oscillator 4790b953ffcSMarkus Klotzbuecher ratio. Valid values are 8, 16, 24, 31. The core 4800b953ffcSMarkus Klotzbuecher frequency is this value multiplied by 13 MHz. 4810b953ffcSMarkus Klotzbuecher 4826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO 4830b953ffcSMarkus Klotzbuecher 4840b953ffcSMarkus Klotzbuecher Defines the Monahans turbo mode to oscillator 4850b953ffcSMarkus Klotzbuecher ratio. Valid values are 1 (default if undefined) and 4860b953ffcSMarkus Klotzbuecher 2. The core frequency as calculated above is multiplied 4870b953ffcSMarkus Klotzbuecher by this value. 4880b953ffcSMarkus Klotzbuecher 48992bbd64eSDaniel Schwierzeck- MIPS CPU options: 49092bbd64eSDaniel Schwierzeck CONFIG_SYS_INIT_SP_OFFSET 49192bbd64eSDaniel Schwierzeck 49292bbd64eSDaniel Schwierzeck Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack 49392bbd64eSDaniel Schwierzeck pointer. This is needed for the temporary stack before 49492bbd64eSDaniel Schwierzeck relocation. 49592bbd64eSDaniel Schwierzeck 49692bbd64eSDaniel Schwierzeck CONFIG_SYS_MIPS_CACHE_MODE 49792bbd64eSDaniel Schwierzeck 49892bbd64eSDaniel Schwierzeck Cache operation mode for the MIPS CPU. 49992bbd64eSDaniel Schwierzeck See also arch/mips/include/asm/mipsregs.h. 50092bbd64eSDaniel Schwierzeck Possible values are: 50192bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_NO_WA 50292bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_WA 50392bbd64eSDaniel Schwierzeck CONF_CM_UNCACHED 50492bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_NONCOHERENT 50592bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_CE 50692bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_COW 50792bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_CUW 50892bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_ACCELERATED 50992bbd64eSDaniel Schwierzeck 51092bbd64eSDaniel Schwierzeck CONFIG_SYS_XWAY_EBU_BOOTCFG 51192bbd64eSDaniel Schwierzeck 51292bbd64eSDaniel Schwierzeck Special option for Lantiq XWAY SoCs for booting from NOR flash. 51392bbd64eSDaniel Schwierzeck See also arch/mips/cpu/mips32/start.S. 51492bbd64eSDaniel Schwierzeck 51592bbd64eSDaniel Schwierzeck CONFIG_XWAY_SWAP_BYTES 51692bbd64eSDaniel Schwierzeck 51792bbd64eSDaniel Schwierzeck Enable compilation of tools/xway-swap-bytes needed for Lantiq 51892bbd64eSDaniel Schwierzeck XWAY SoCs for booting from NOR flash. The U-Boot image needs to 51992bbd64eSDaniel Schwierzeck be swapped if a flash programmer is used. 52092bbd64eSDaniel Schwierzeck 521b67d8816SChristian Riesch- ARM options: 522b67d8816SChristian Riesch CONFIG_SYS_EXCEPTION_VECTORS_HIGH 523b67d8816SChristian Riesch 524b67d8816SChristian Riesch Select high exception vectors of the ARM core, e.g., do not 525b67d8816SChristian Riesch clear the V bit of the c1 register of CP15. 526b67d8816SChristian Riesch 5275356f545SAneesh V CONFIG_SYS_THUMB_BUILD 5285356f545SAneesh V 5295356f545SAneesh V Use this flag to build U-Boot using the Thumb instruction 5305356f545SAneesh V set for ARM architectures. Thumb instruction set provides 5315356f545SAneesh V better code density. For ARM architectures that support 5325356f545SAneesh V Thumb2 this flag will result in Thumb2 code generated by 5335356f545SAneesh V GCC. 5345356f545SAneesh V 535c5d4752cSStephen Warren CONFIG_ARM_ERRATA_716044 5360678587fSStephen Warren CONFIG_ARM_ERRATA_742230 5370678587fSStephen Warren CONFIG_ARM_ERRATA_743622 5380678587fSStephen Warren CONFIG_ARM_ERRATA_751472 5390678587fSStephen Warren 5400678587fSStephen Warren If set, the workarounds for these ARM errata are applied early 5410678587fSStephen Warren during U-Boot startup. Note that these options force the 5420678587fSStephen Warren workarounds to be applied; no CPU-type/version detection 5430678587fSStephen Warren exists, unlike the similar options in the Linux kernel. Do not 5440678587fSStephen Warren set these options unless they apply! 5450678587fSStephen Warren 546795659dcSStephen Warren- CPU timer options: 547795659dcSStephen Warren CONFIG_SYS_HZ 548795659dcSStephen Warren 549795659dcSStephen Warren The frequency of the timer returned by get_timer(). 550795659dcSStephen Warren get_timer() must operate in milliseconds and this CONFIG 551795659dcSStephen Warren option must be set to 1000. 552795659dcSStephen Warren 5535da627a4Swdenk- Linux Kernel Interface: 554c609719bSwdenk CONFIG_CLOCKS_IN_MHZ 555c609719bSwdenk 556c609719bSwdenk U-Boot stores all clock information in Hz 557c609719bSwdenk internally. For binary compatibility with older Linux 558c609719bSwdenk kernels (which expect the clocks passed in the 559c609719bSwdenk bd_info data to be in MHz) the environment variable 560c609719bSwdenk "clocks_in_mhz" can be defined so that U-Boot 561c609719bSwdenk converts clock data to MHZ before passing it to the 562c609719bSwdenk Linux kernel. 563c609719bSwdenk When CONFIG_CLOCKS_IN_MHZ is defined, a definition of 564c609719bSwdenk "clocks_in_mhz=1" is automatically included in the 565c609719bSwdenk default environment. 566c609719bSwdenk 5675da627a4Swdenk CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only] 5685da627a4Swdenk 56911ccc33fSMarcel Ziswiler When transferring memsize parameter to linux, some versions 5705da627a4Swdenk expect it to be in bytes, others in MB. 5715da627a4Swdenk Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes. 5725da627a4Swdenk 573fec6d9eeSGerald Van Baren CONFIG_OF_LIBFDT 574f57f70aaSWolfgang Denk 575f57f70aaSWolfgang Denk New kernel versions are expecting firmware settings to be 576213bf8c8SGerald Van Baren passed using flattened device trees (based on open firmware 577213bf8c8SGerald Van Baren concepts). 578213bf8c8SGerald Van Baren 579213bf8c8SGerald Van Baren CONFIG_OF_LIBFDT 580213bf8c8SGerald Van Baren * New libfdt-based support 581213bf8c8SGerald Van Baren * Adds the "fdt" command 5823bb342fcSKim Phillips * The bootm command automatically updates the fdt 583213bf8c8SGerald Van Baren 584b55ae402SMarcel Ziswiler OF_CPU - The proper name of the cpus node (only required for 585b55ae402SMarcel Ziswiler MPC512X and MPC5xxx based boards). 586b55ae402SMarcel Ziswiler OF_SOC - The proper name of the soc node (only required for 587b55ae402SMarcel Ziswiler MPC512X and MPC5xxx based boards). 588f57f70aaSWolfgang Denk OF_TBCLK - The timebase frequency. 589c2871f03SKumar Gala OF_STDOUT_PATH - The path to the console device 590f57f70aaSWolfgang Denk 59111ccc33fSMarcel Ziswiler boards with QUICC Engines require OF_QE to set UCC MAC 59211ccc33fSMarcel Ziswiler addresses 5933bb342fcSKim Phillips 5944e253137SKumar Gala CONFIG_OF_BOARD_SETUP 5954e253137SKumar Gala 5964e253137SKumar Gala Board code has addition modification that it wants to make 5974e253137SKumar Gala to the flat device tree before handing it off to the kernel 5986705d81eSwdenk 5990267768eSMatthew McClintock CONFIG_OF_BOOT_CPU 6000267768eSMatthew McClintock 60111ccc33fSMarcel Ziswiler This define fills in the correct boot CPU in the boot 6020267768eSMatthew McClintock param header, the default value is zero if undefined. 6030267768eSMatthew McClintock 6043887c3fbSHeiko Schocher CONFIG_OF_IDE_FIXUP 6053887c3fbSHeiko Schocher 6063887c3fbSHeiko Schocher U-Boot can detect if an IDE device is present or not. 6073887c3fbSHeiko Schocher If not, and this new config option is activated, U-Boot 6083887c3fbSHeiko Schocher removes the ATA node from the DTS before booting Linux, 6093887c3fbSHeiko Schocher so the Linux IDE driver does not probe the device and 6103887c3fbSHeiko Schocher crash. This is needed for buggy hardware (uc101) where 6113887c3fbSHeiko Schocher no pull down resistor is connected to the signal IDE5V_DD7. 6123887c3fbSHeiko Schocher 6137eb29398SIgor Grinberg CONFIG_MACH_TYPE [relevant for ARM only][mandatory] 6147eb29398SIgor Grinberg 6157eb29398SIgor Grinberg This setting is mandatory for all boards that have only one 6167eb29398SIgor Grinberg machine type and must be used to specify the machine type 6177eb29398SIgor Grinberg number as it appears in the ARM machine registry 6187eb29398SIgor Grinberg (see http://www.arm.linux.org.uk/developer/machines/). 6197eb29398SIgor Grinberg Only boards that have multiple machine types supported 6207eb29398SIgor Grinberg in a single configuration file and the machine type is 6217eb29398SIgor Grinberg runtime discoverable, do not have to use this setting. 6227eb29398SIgor Grinberg 6230b2f4ecaSNiklaus Giger- vxWorks boot parameters: 6240b2f4ecaSNiklaus Giger 6250b2f4ecaSNiklaus Giger bootvx constructs a valid bootline using the following 6260b2f4ecaSNiklaus Giger environments variables: bootfile, ipaddr, serverip, hostname. 6270b2f4ecaSNiklaus Giger It loads the vxWorks image pointed bootfile. 6280b2f4ecaSNiklaus Giger 6290b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name 6300b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address 6310b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server 6320b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters 6330b2f4ecaSNiklaus Giger 6340b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_ADD_PARAMS 6350b2f4ecaSNiklaus Giger 6360b2f4ecaSNiklaus Giger Add it at the end of the bootline. E.g "u=username pw=secret" 6370b2f4ecaSNiklaus Giger 6380b2f4ecaSNiklaus Giger Note: If a "bootargs" environment is defined, it will overwride 6390b2f4ecaSNiklaus Giger the defaults discussed just above. 6400b2f4ecaSNiklaus Giger 6412c451f78SAneesh V- Cache Configuration: 6422c451f78SAneesh V CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot 6432c451f78SAneesh V CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot 6442c451f78SAneesh V CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot 6452c451f78SAneesh V 64693bc2193SAneesh V- Cache Configuration for ARM: 64793bc2193SAneesh V CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache 64893bc2193SAneesh V controller 64993bc2193SAneesh V CONFIG_SYS_PL310_BASE - Physical base address of PL310 65093bc2193SAneesh V controller register space 65193bc2193SAneesh V 6526705d81eSwdenk- Serial Ports: 65348d0192fSAndreas Engel CONFIG_PL010_SERIAL 6546705d81eSwdenk 6556705d81eSwdenk Define this if you want support for Amba PrimeCell PL010 UARTs. 6566705d81eSwdenk 65748d0192fSAndreas Engel CONFIG_PL011_SERIAL 6586705d81eSwdenk 6596705d81eSwdenk Define this if you want support for Amba PrimeCell PL011 UARTs. 6606705d81eSwdenk 6616705d81eSwdenk CONFIG_PL011_CLOCK 6626705d81eSwdenk 6636705d81eSwdenk If you have Amba PrimeCell PL011 UARTs, set this variable to 6646705d81eSwdenk the clock speed of the UARTs. 6656705d81eSwdenk 6666705d81eSwdenk CONFIG_PL01x_PORTS 6676705d81eSwdenk 6686705d81eSwdenk If you have Amba PrimeCell PL010 or PL011 UARTs on your board, 6696705d81eSwdenk define this to a list of base addresses for each (supported) 6706705d81eSwdenk port. See e.g. include/configs/versatile.h 6716705d81eSwdenk 672910f1ae3SJohn Rigby CONFIG_PL011_SERIAL_RLCR 673910f1ae3SJohn Rigby 674910f1ae3SJohn Rigby Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500) 675910f1ae3SJohn Rigby have separate receive and transmit line control registers. Set 676910f1ae3SJohn Rigby this variable to initialize the extra register. 677910f1ae3SJohn Rigby 678910f1ae3SJohn Rigby CONFIG_PL011_SERIAL_FLUSH_ON_INIT 679910f1ae3SJohn Rigby 680910f1ae3SJohn Rigby On some platforms (e.g. U8500) U-Boot is loaded by a second stage 681910f1ae3SJohn Rigby boot loader that has already initialized the UART. Define this 682910f1ae3SJohn Rigby variable to flush the UART at init time. 683910f1ae3SJohn Rigby 6846705d81eSwdenk 685c609719bSwdenk- Console Interface: 686c609719bSwdenk Depending on board, define exactly one serial port 687c609719bSwdenk (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2, 688c609719bSwdenk CONFIG_8xx_CONS_SCC1, ...), or switch off the serial 689c609719bSwdenk console by defining CONFIG_8xx_CONS_NONE 690c609719bSwdenk 691c609719bSwdenk Note: if CONFIG_8xx_CONS_NONE is defined, the serial 692c609719bSwdenk port routines must be defined elsewhere 693c609719bSwdenk (i.e. serial_init(), serial_getc(), ...) 694c609719bSwdenk 695c609719bSwdenk CONFIG_CFB_CONSOLE 696c609719bSwdenk Enables console device for a color framebuffer. Needs following 697c53043b7SWolfgang Denk defines (cf. smiLynxEM, i8042) 698c609719bSwdenk VIDEO_FB_LITTLE_ENDIAN graphic memory organisation 699c609719bSwdenk (default big endian) 700c609719bSwdenk VIDEO_HW_RECTFILL graphic chip supports 701c609719bSwdenk rectangle fill 702c609719bSwdenk (cf. smiLynxEM) 703c609719bSwdenk VIDEO_HW_BITBLT graphic chip supports 704c609719bSwdenk bit-blit (cf. smiLynxEM) 705c609719bSwdenk VIDEO_VISIBLE_COLS visible pixel columns 706c609719bSwdenk (cols=pitch) 707c609719bSwdenk VIDEO_VISIBLE_ROWS visible pixel rows 708c609719bSwdenk VIDEO_PIXEL_SIZE bytes per pixel 709c609719bSwdenk VIDEO_DATA_FORMAT graphic data format 710c609719bSwdenk (0-5, cf. cfb_console.c) 711c609719bSwdenk VIDEO_FB_ADRS framebuffer address 712c609719bSwdenk VIDEO_KBD_INIT_FCT keyboard int fct 713c609719bSwdenk (i.e. i8042_kbd_init()) 714c609719bSwdenk VIDEO_TSTC_FCT test char fct 715c609719bSwdenk (i.e. i8042_tstc) 716c609719bSwdenk VIDEO_GETC_FCT get char fct 717c609719bSwdenk (i.e. i8042_getc) 718c609719bSwdenk CONFIG_CONSOLE_CURSOR cursor drawing on/off 719c609719bSwdenk (requires blink timer 720c609719bSwdenk cf. i8042.c) 7216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c) 722c609719bSwdenk CONFIG_CONSOLE_TIME display time/date info in 723c609719bSwdenk upper right corner 724602ad3b3SJon Loeliger (requires CONFIG_CMD_DATE) 725c609719bSwdenk CONFIG_VIDEO_LOGO display Linux logo in 726c609719bSwdenk upper left corner 727a6c7ad2fSwdenk CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of 728a6c7ad2fSwdenk linux_logo.h for logo. 729a6c7ad2fSwdenk Requires CONFIG_VIDEO_LOGO 730c609719bSwdenk CONFIG_CONSOLE_EXTRA_INFO 73111ccc33fSMarcel Ziswiler additional board info beside 732c609719bSwdenk the logo 733c609719bSwdenk 73433a35bbbSPali Rohár When CONFIG_CFB_CONSOLE_ANSI is defined, console will support 73533a35bbbSPali Rohár a limited number of ANSI escape sequences (cursor control, 73633a35bbbSPali Rohár erase functions and limited graphics rendition control). 73733a35bbbSPali Rohár 738c609719bSwdenk When CONFIG_CFB_CONSOLE is defined, video console is 739c609719bSwdenk default i/o. Serial console can be forced with 740c609719bSwdenk environment 'console=serial'. 741c609719bSwdenk 742a3ad8e26Swdenk When CONFIG_SILENT_CONSOLE is defined, all console 743a3ad8e26Swdenk messages (by U-Boot and Linux!) can be silenced with 744a3ad8e26Swdenk the "silent" environment variable. See 745a3ad8e26Swdenk doc/README.silent for more information. 746a3ad8e26Swdenk 74745ae2546SHeiko Schocher CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default 74845ae2546SHeiko Schocher is 0x00. 74945ae2546SHeiko Schocher CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default 75045ae2546SHeiko Schocher is 0xa0. 75145ae2546SHeiko Schocher 752c609719bSwdenk- Console Baudrate: 753c609719bSwdenk CONFIG_BAUDRATE - in bps 754c609719bSwdenk Select one of the baudrates listed in 7556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BAUDRATE_TABLE, see below. 7566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale 757c609719bSwdenk 758c92fac91SHeiko Schocher- Console Rx buffer length 759c92fac91SHeiko Schocher With CONFIG_SYS_SMC_RXBUFLEN it is possible to define 760c92fac91SHeiko Schocher the maximum receive buffer length for the SMC. 7612b3f12c2SHeiko Schocher This option is actual only for 82xx and 8xx possible. 762c92fac91SHeiko Schocher If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE 763c92fac91SHeiko Schocher must be defined, to setup the maximum idle timeout for 764c92fac91SHeiko Schocher the SMC. 765c92fac91SHeiko Schocher 7669558b48aSGraeme Russ- Pre-Console Buffer: 7679558b48aSGraeme Russ Prior to the console being initialised (i.e. serial UART 7689558b48aSGraeme Russ initialised etc) all console output is silently discarded. 7699558b48aSGraeme Russ Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to 7709558b48aSGraeme Russ buffer any console messages prior to the console being 7719558b48aSGraeme Russ initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ 7729558b48aSGraeme Russ bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is 7739558b48aSGraeme Russ a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ 7749558b48aSGraeme Russ bytes are output before the console is initialised, the 7759558b48aSGraeme Russ earlier bytes are discarded. 7769558b48aSGraeme Russ 7779558b48aSGraeme Russ 'Sane' compilers will generate smaller code if 7789558b48aSGraeme Russ CONFIG_PRE_CON_BUF_SZ is a power of 2 7799558b48aSGraeme Russ 780046a37bdSSonny Rao- Safe printf() functions 781046a37bdSSonny Rao Define CONFIG_SYS_VSNPRINTF to compile in safe versions of 782046a37bdSSonny Rao the printf() functions. These are defined in 783046a37bdSSonny Rao include/vsprintf.h and include snprintf(), vsnprintf() and 784046a37bdSSonny Rao so on. Code size increase is approximately 300-500 bytes. 785046a37bdSSonny Rao If this option is not given then these functions will 786046a37bdSSonny Rao silently discard their buffer size argument - this means 787046a37bdSSonny Rao you are not getting any overflow checking in this case. 788046a37bdSSonny Rao 789c609719bSwdenk- Boot Delay: CONFIG_BOOTDELAY - in seconds 790c609719bSwdenk Delay before automatically booting the default image; 791c609719bSwdenk set to -1 to disable autoboot. 79293d7212fSJoe Hershberger set to -2 to autoboot with no delay and not check for abort 79393d7212fSJoe Hershberger (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined). 794c609719bSwdenk 795c609719bSwdenk See doc/README.autoboot for these options that 796c609719bSwdenk work with CONFIG_BOOTDELAY. None are required. 797c609719bSwdenk CONFIG_BOOT_RETRY_TIME 798c609719bSwdenk CONFIG_BOOT_RETRY_MIN 799c609719bSwdenk CONFIG_AUTOBOOT_KEYED 800c609719bSwdenk CONFIG_AUTOBOOT_PROMPT 801c609719bSwdenk CONFIG_AUTOBOOT_DELAY_STR 802c609719bSwdenk CONFIG_AUTOBOOT_STOP_STR 803c609719bSwdenk CONFIG_AUTOBOOT_DELAY_STR2 804c609719bSwdenk CONFIG_AUTOBOOT_STOP_STR2 805c609719bSwdenk CONFIG_ZERO_BOOTDELAY_CHECK 806c609719bSwdenk CONFIG_RESET_TO_RETRY 807c609719bSwdenk 808c609719bSwdenk- Autoboot Command: 809c609719bSwdenk CONFIG_BOOTCOMMAND 810c609719bSwdenk Only needed when CONFIG_BOOTDELAY is enabled; 811c609719bSwdenk define a command string that is automatically executed 812c609719bSwdenk when no character is read on the console interface 813c609719bSwdenk within "Boot Delay" after reset. 814c609719bSwdenk 815c609719bSwdenk CONFIG_BOOTARGS 816c609719bSwdenk This can be used to pass arguments to the bootm 817c609719bSwdenk command. The value of CONFIG_BOOTARGS goes into the 818c609719bSwdenk environment value "bootargs". 819c609719bSwdenk 820c609719bSwdenk CONFIG_RAMBOOT and CONFIG_NFSBOOT 821c609719bSwdenk The value of these goes into the environment as 822c609719bSwdenk "ramboot" and "nfsboot" respectively, and can be used 823c609719bSwdenk as a convenience, when switching between booting from 82411ccc33fSMarcel Ziswiler RAM and NFS. 825c609719bSwdenk 826eda0ba38SHeiko Schocher- Bootcount: 827eda0ba38SHeiko Schocher CONFIG_BOOTCOUNT_LIMIT 828eda0ba38SHeiko Schocher Implements a mechanism for detecting a repeating reboot 829eda0ba38SHeiko Schocher cycle, see: 830eda0ba38SHeiko Schocher http://www.denx.de/wiki/view/DULG/UBootBootCountLimit 831eda0ba38SHeiko Schocher 832eda0ba38SHeiko Schocher CONFIG_BOOTCOUNT_ENV 833eda0ba38SHeiko Schocher If no softreset save registers are found on the hardware 834eda0ba38SHeiko Schocher "bootcount" is stored in the environment. To prevent a 835eda0ba38SHeiko Schocher saveenv on all reboots, the environment variable 836eda0ba38SHeiko Schocher "upgrade_available" is used. If "upgrade_available" is 837eda0ba38SHeiko Schocher 0, "bootcount" is always 0, if "upgrade_available" is 838eda0ba38SHeiko Schocher 1 "bootcount" is incremented in the environment. 839eda0ba38SHeiko Schocher So the Userspace Applikation must set the "upgrade_available" 840eda0ba38SHeiko Schocher and "bootcount" variable to 0, if a boot was successfully. 841eda0ba38SHeiko Schocher 842c609719bSwdenk- Pre-Boot Commands: 843c609719bSwdenk CONFIG_PREBOOT 844c609719bSwdenk 845c609719bSwdenk When this option is #defined, the existence of the 846c609719bSwdenk environment variable "preboot" will be checked 847c609719bSwdenk immediately before starting the CONFIG_BOOTDELAY 848c609719bSwdenk countdown and/or running the auto-boot command resp. 849c609719bSwdenk entering interactive mode. 850c609719bSwdenk 851c609719bSwdenk This feature is especially useful when "preboot" is 852c609719bSwdenk automatically generated or modified. For an example 853c609719bSwdenk see the LWMON board specific code: here "preboot" is 854c609719bSwdenk modified when the user holds down a certain 855c609719bSwdenk combination of keys on the (special) keyboard when 856c609719bSwdenk booting the systems 857c609719bSwdenk 858c609719bSwdenk- Serial Download Echo Mode: 859c609719bSwdenk CONFIG_LOADS_ECHO 860c609719bSwdenk If defined to 1, all characters received during a 861c609719bSwdenk serial download (using the "loads" command) are 862c609719bSwdenk echoed back. This might be needed by some terminal 863c609719bSwdenk emulations (like "cu"), but may as well just take 864c609719bSwdenk time on others. This setting #define's the initial 865c609719bSwdenk value of the "loads_echo" environment variable. 866c609719bSwdenk 867602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined) 868c609719bSwdenk CONFIG_KGDB_BAUDRATE 869c609719bSwdenk Select one of the baudrates listed in 8706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BAUDRATE_TABLE, see below. 871c609719bSwdenk 872c609719bSwdenk- Monitor Functions: 873602ad3b3SJon Loeliger Monitor commands can be included or excluded 874602ad3b3SJon Loeliger from the build by using the #include files 875c6c621bdSStephen Warren <config_cmd_all.h> and #undef'ing unwanted 876c6c621bdSStephen Warren commands, or using <config_cmd_default.h> 877602ad3b3SJon Loeliger and augmenting with additional #define's 878602ad3b3SJon Loeliger for wanted commands. 879c609719bSwdenk 880602ad3b3SJon Loeliger The default command configuration includes all commands 881602ad3b3SJon Loeliger except those marked below with a "*". 882602ad3b3SJon Loeliger 883602ad3b3SJon Loeliger CONFIG_CMD_ASKENV * ask for env variable 884602ad3b3SJon Loeliger CONFIG_CMD_BDI bdinfo 885602ad3b3SJon Loeliger CONFIG_CMD_BEDBUG * Include BedBug Debugger 886602ad3b3SJon Loeliger CONFIG_CMD_BMP * BMP support 887602ad3b3SJon Loeliger CONFIG_CMD_BSP * Board specific commands 888602ad3b3SJon Loeliger CONFIG_CMD_BOOTD bootd 889602ad3b3SJon Loeliger CONFIG_CMD_CACHE * icache, dcache 890602ad3b3SJon Loeliger CONFIG_CMD_CONSOLE coninfo 891710b9938SMike Frysinger CONFIG_CMD_CRC32 * crc32 892602ad3b3SJon Loeliger CONFIG_CMD_DATE * support for RTC, date/time... 893602ad3b3SJon Loeliger CONFIG_CMD_DHCP * DHCP support 894602ad3b3SJon Loeliger CONFIG_CMD_DIAG * Diagnostics 895a7c93104SPeter Tyser CONFIG_CMD_DS4510 * ds4510 I2C gpio commands 896a7c93104SPeter Tyser CONFIG_CMD_DS4510_INFO * ds4510 I2C info command 897a7c93104SPeter Tyser CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd 898a7c93104SPeter Tyser CONFIG_CMD_DS4510_RST * ds4510 I2C rst command 899602ad3b3SJon Loeliger CONFIG_CMD_DTT * Digital Therm and Thermostat 900602ad3b3SJon Loeliger CONFIG_CMD_ECHO echo arguments 901246c6922SPeter Tyser CONFIG_CMD_EDITENV edit env variable 902602ad3b3SJon Loeliger CONFIG_CMD_EEPROM * EEPROM read/write support 903602ad3b3SJon Loeliger CONFIG_CMD_ELF * bootelf, bootvx 9045e2b3e0cSJoe Hershberger CONFIG_CMD_ENV_CALLBACK * display details about env callbacks 905fffad71bSJoe Hershberger CONFIG_CMD_ENV_FLAGS * display details about env flags 90688733e2cSAndrew Ruder CONFIG_CMD_ENV_EXISTS * check existence of env variable 9070c79cda0SMike Frysinger CONFIG_CMD_EXPORTENV * export the environment 90803e2ecf6SStephen Warren CONFIG_CMD_EXT2 * ext2 command support 90903e2ecf6SStephen Warren CONFIG_CMD_EXT4 * ext4 command support 910bdab39d3SMike Frysinger CONFIG_CMD_SAVEENV saveenv 911602ad3b3SJon Loeliger CONFIG_CMD_FDC * Floppy Disk Support 91203e2ecf6SStephen Warren CONFIG_CMD_FAT * FAT command support 913602ad3b3SJon Loeliger CONFIG_CMD_FDOS * Dos diskette Support 914602ad3b3SJon Loeliger CONFIG_CMD_FLASH flinfo, erase, protect 915602ad3b3SJon Loeliger CONFIG_CMD_FPGA FPGA device initialization support 9164d98b5c8SVincent Stehlé CONFIG_CMD_FUSE * Device fuse support 91753fdc7efSAnton Staaf CONFIG_CMD_GETTIME * Get time since boot 918a641b979SMike Frysinger CONFIG_CMD_GO * the 'go' command (exec code) 919a000b795SKim Phillips CONFIG_CMD_GREPENV * search environment 920bf36c5d5SSimon Glass CONFIG_CMD_HASH * calculate hash / digest 921602ad3b3SJon Loeliger CONFIG_CMD_HWFLOW * RTS/CTS hw flow control 922602ad3b3SJon Loeliger CONFIG_CMD_I2C * I2C serial bus support 923602ad3b3SJon Loeliger CONFIG_CMD_IDE * IDE harddisk support 924602ad3b3SJon Loeliger CONFIG_CMD_IMI iminfo 9258fdf1e0fSVipin Kumar CONFIG_CMD_IMLS List all images found in NOR flash 9264d98b5c8SVincent Stehlé CONFIG_CMD_IMLS_NAND * List all images found in NAND flash 927602ad3b3SJon Loeliger CONFIG_CMD_IMMAP * IMMR dump support 9280c79cda0SMike Frysinger CONFIG_CMD_IMPORTENV * import an environment 929c167cc02SJoe Hershberger CONFIG_CMD_INI * import data from an ini file into the env 930602ad3b3SJon Loeliger CONFIG_CMD_IRQ * irqinfo 931602ad3b3SJon Loeliger CONFIG_CMD_ITEST Integer/string test of 2 values 932602ad3b3SJon Loeliger CONFIG_CMD_JFFS2 * JFFS2 Support 933602ad3b3SJon Loeliger CONFIG_CMD_KGDB * kgdb 9344d98b5c8SVincent Stehlé CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader) 935d22c338eSJoe Hershberger CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration 936d22c338eSJoe Hershberger (169.254.*.*) 937602ad3b3SJon Loeliger CONFIG_CMD_LOADB loadb 938602ad3b3SJon Loeliger CONFIG_CMD_LOADS loads 9394d98b5c8SVincent Stehlé CONFIG_CMD_MD5SUM * print md5 message digest 94002c9aa1dSRobin Getz (requires CONFIG_CMD_MEMORY and CONFIG_MD5) 94115a33e49SSimon Glass CONFIG_CMD_MEMINFO * Display detailed memory information 942602ad3b3SJon Loeliger CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base, 943a2681707SWolfgang Denk loop, loopw 9444d98b5c8SVincent Stehlé CONFIG_CMD_MEMTEST * mtest 945602ad3b3SJon Loeliger CONFIG_CMD_MISC Misc functions like sleep etc 946602ad3b3SJon Loeliger CONFIG_CMD_MMC * MMC memory mapped support 947602ad3b3SJon Loeliger CONFIG_CMD_MII * MII utility commands 94868d7d651SStefan Roese CONFIG_CMD_MTDPARTS * MTD partition support 949602ad3b3SJon Loeliger CONFIG_CMD_NAND * NAND support 950602ad3b3SJon Loeliger CONFIG_CMD_NET bootp, tftpboot, rarpboot 9514d98b5c8SVincent Stehlé CONFIG_CMD_NFS NFS support 952e92739d3SPeter Tyser CONFIG_CMD_PCA953X * PCA953x I2C gpio commands 953e92739d3SPeter Tyser CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command 954602ad3b3SJon Loeliger CONFIG_CMD_PCI * pciinfo 955602ad3b3SJon Loeliger CONFIG_CMD_PCMCIA * PCMCIA support 956602ad3b3SJon Loeliger CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network 957602ad3b3SJon Loeliger host 958602ad3b3SJon Loeliger CONFIG_CMD_PORTIO * Port I/O 959ff048ea9SKenneth Waters CONFIG_CMD_READ * Read raw data from partition 960602ad3b3SJon Loeliger CONFIG_CMD_REGINFO * Register dump 961602ad3b3SJon Loeliger CONFIG_CMD_RUN run command in env variable 962d304931fSSimon Glass CONFIG_CMD_SANDBOX * sb command to access sandbox features 963602ad3b3SJon Loeliger CONFIG_CMD_SAVES * save S record dump 964602ad3b3SJon Loeliger CONFIG_CMD_SCSI * SCSI Support 965602ad3b3SJon Loeliger CONFIG_CMD_SDRAM * print SDRAM configuration information 966602ad3b3SJon Loeliger (requires CONFIG_CMD_I2C) 967602ad3b3SJon Loeliger CONFIG_CMD_SETGETDCR Support for DCR Register access 968602ad3b3SJon Loeliger (4xx only) 969f61ec45eSEric Nelson CONFIG_CMD_SF * Read/write/erase SPI NOR flash 9704d98b5c8SVincent Stehlé CONFIG_CMD_SHA1SUM * print sha1 memory digest 97102c9aa1dSRobin Getz (requires CONFIG_CMD_MEMORY) 9727d861d95SBob Liu CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x 97374de7aefSWolfgang Denk CONFIG_CMD_SOURCE "source" command Support 974602ad3b3SJon Loeliger CONFIG_CMD_SPI * SPI serial bus support 9757a83af07SLuca Ceresoli CONFIG_CMD_TFTPSRV * TFTP transfer in server mode 9761fb7cd49SSimon Glass CONFIG_CMD_TFTPPUT * TFTP put command (upload) 977da83bcd7SJoe Hershberger CONFIG_CMD_TIME * run command and report execution time (ARM specific) 978da83bcd7SJoe Hershberger CONFIG_CMD_TIMER * access to the system tick timer 979602ad3b3SJon Loeliger CONFIG_CMD_USB * USB support 980602ad3b3SJon Loeliger CONFIG_CMD_CDP * Cisco Discover Protocol support 981c8339f51SMarek Vasut CONFIG_CMD_MFSL * Microblaze FSL support 9824d98b5c8SVincent Stehlé CONFIG_CMD_XIMG Load part of Multi Image 983c609719bSwdenk 984c609719bSwdenk 985c609719bSwdenk EXAMPLE: If you want all functions except of network 986c609719bSwdenk support you can write: 987c609719bSwdenk 988602ad3b3SJon Loeliger #include "config_cmd_all.h" 989602ad3b3SJon Loeliger #undef CONFIG_CMD_NET 990c609719bSwdenk 991213bf8c8SGerald Van Baren Other Commands: 992213bf8c8SGerald Van Baren fdt (flattened device tree) command: CONFIG_OF_LIBFDT 993c609719bSwdenk 994c609719bSwdenk Note: Don't enable the "icache" and "dcache" commands 995602ad3b3SJon Loeliger (configuration option CONFIG_CMD_CACHE) unless you know 996c609719bSwdenk what you (and your U-Boot users) are doing. Data 997c609719bSwdenk cache cannot be enabled on systems like the 8xx or 998c609719bSwdenk 8260 (where accesses to the IMMR region must be 999c609719bSwdenk uncached), and it cannot be disabled on all other 1000c609719bSwdenk systems where we (mis-) use the data cache to hold an 1001c609719bSwdenk initial stack and some data. 1002c609719bSwdenk 1003c609719bSwdenk 1004c609719bSwdenk XXX - this list needs to get updated! 1005c609719bSwdenk 1006a5ecbe62SWolfgang Denk- Regular expression support: 1007a5ecbe62SWolfgang Denk CONFIG_REGEX 1008a5ecbe62SWolfgang Denk If this variable is defined, U-Boot is linked against 1009a5ecbe62SWolfgang Denk the SLRE (Super Light Regular Expression) library, 1010a5ecbe62SWolfgang Denk which adds regex support to some commands, as for 1011a5ecbe62SWolfgang Denk example "env grep" and "setexpr". 1012a5ecbe62SWolfgang Denk 101345ba8077SSimon Glass- Device tree: 101445ba8077SSimon Glass CONFIG_OF_CONTROL 101545ba8077SSimon Glass If this variable is defined, U-Boot will use a device tree 101645ba8077SSimon Glass to configure its devices, instead of relying on statically 101745ba8077SSimon Glass compiled #defines in the board file. This option is 101845ba8077SSimon Glass experimental and only available on a few boards. The device 101945ba8077SSimon Glass tree is available in the global data as gd->fdt_blob. 102045ba8077SSimon Glass 10212c0f79e4SSimon Glass U-Boot needs to get its device tree from somewhere. This can 10222c0f79e4SSimon Glass be done using one of the two options below: 1023bbb0b128SSimon Glass 1024bbb0b128SSimon Glass CONFIG_OF_EMBED 1025bbb0b128SSimon Glass If this variable is defined, U-Boot will embed a device tree 1026bbb0b128SSimon Glass binary in its image. This device tree file should be in the 1027bbb0b128SSimon Glass board directory and called <soc>-<board>.dts. The binary file 1028bbb0b128SSimon Glass is then picked up in board_init_f() and made available through 1029bbb0b128SSimon Glass the global data structure as gd->blob. 103045ba8077SSimon Glass 10312c0f79e4SSimon Glass CONFIG_OF_SEPARATE 10322c0f79e4SSimon Glass If this variable is defined, U-Boot will build a device tree 10332c0f79e4SSimon Glass binary. It will be called u-boot.dtb. Architecture-specific 10342c0f79e4SSimon Glass code will locate it at run-time. Generally this works by: 10352c0f79e4SSimon Glass 10362c0f79e4SSimon Glass cat u-boot.bin u-boot.dtb >image.bin 10372c0f79e4SSimon Glass 10382c0f79e4SSimon Glass and in fact, U-Boot does this for you, creating a file called 10392c0f79e4SSimon Glass u-boot-dtb.bin which is useful in the common case. You can 10402c0f79e4SSimon Glass still use the individual files if you need something more 10412c0f79e4SSimon Glass exotic. 10422c0f79e4SSimon Glass 1043c609719bSwdenk- Watchdog: 1044c609719bSwdenk CONFIG_WATCHDOG 1045c609719bSwdenk If this variable is defined, it enables watchdog 10466abe6fb6SDetlev Zundel support for the SoC. There must be support in the SoC 10476abe6fb6SDetlev Zundel specific code for a watchdog. For the 8xx and 8260 10486abe6fb6SDetlev Zundel CPUs, the SIU Watchdog feature is enabled in the SYPCR 10496abe6fb6SDetlev Zundel register. When supported for a specific SoC is 10506abe6fb6SDetlev Zundel available, then no further board specific code should 10516abe6fb6SDetlev Zundel be needed to use it. 10526abe6fb6SDetlev Zundel 10536abe6fb6SDetlev Zundel CONFIG_HW_WATCHDOG 10546abe6fb6SDetlev Zundel When using a watchdog circuitry external to the used 10556abe6fb6SDetlev Zundel SoC, then define this variable and provide board 10566abe6fb6SDetlev Zundel specific code for the "hw_watchdog_reset" function. 1057c609719bSwdenk 1058c1551ea8Sstroese- U-Boot Version: 1059c1551ea8Sstroese CONFIG_VERSION_VARIABLE 1060c1551ea8Sstroese If this variable is defined, an environment variable 1061c1551ea8Sstroese named "ver" is created by U-Boot showing the U-Boot 1062c1551ea8Sstroese version as printed by the "version" command. 1063a1ea8e51SBenoît Thébaudeau Any change to this variable will be reverted at the 1064a1ea8e51SBenoît Thébaudeau next reset. 1065c1551ea8Sstroese 1066c609719bSwdenk- Real-Time Clock: 1067c609719bSwdenk 1068602ad3b3SJon Loeliger When CONFIG_CMD_DATE is selected, the type of the RTC 1069c609719bSwdenk has to be selected, too. Define exactly one of the 1070c609719bSwdenk following options: 1071c609719bSwdenk 1072c609719bSwdenk CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx 1073c609719bSwdenk CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC 10744e8b7544SFabio Estevam CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC 1075c609719bSwdenk CONFIG_RTC_MC146818 - use MC146818 RTC 10761cb8e980Swdenk CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC 1077c609719bSwdenk CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC 10787f70e853Swdenk CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC 10793bac3513Swdenk CONFIG_RTC_DS164x - use Dallas DS164x RTC 10809536dfccSTor Krill CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC 10814c0d4c3bSwdenk CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC 10826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337 108371d19f30SHeiko Schocher CONFIG_SYS_RV3029_TCR - enable trickle charger on 108471d19f30SHeiko Schocher RV3029 RTC. 1085c609719bSwdenk 1086b37c7e5eSwdenk Note that if the RTC uses I2C, then the I2C interface 1087b37c7e5eSwdenk must also be configured. See I2C Support, below. 1088b37c7e5eSwdenk 1089e92739d3SPeter Tyser- GPIO Support: 1090e92739d3SPeter Tyser CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO 1091e92739d3SPeter Tyser 10925dec49caSChris Packham The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of 10935dec49caSChris Packham chip-ngpio pairs that tell the PCA953X driver the number of 10945dec49caSChris Packham pins supported by a particular chip. 10955dec49caSChris Packham 1096e92739d3SPeter Tyser Note that if the GPIO device uses I2C, then the I2C interface 1097e92739d3SPeter Tyser must also be configured. See I2C Support, below. 1098e92739d3SPeter Tyser 1099c609719bSwdenk- Timestamp Support: 1100c609719bSwdenk 1101c609719bSwdenk When CONFIG_TIMESTAMP is selected, the timestamp 1102c609719bSwdenk (date and time) of an image is printed by image 1103c609719bSwdenk commands like bootm or iminfo. This option is 1104602ad3b3SJon Loeliger automatically enabled when you select CONFIG_CMD_DATE . 1105c609719bSwdenk 1106923c46f9SKarl O. Pinc- Partition Labels (disklabels) Supported: 1107923c46f9SKarl O. Pinc Zero or more of the following: 1108923c46f9SKarl O. Pinc CONFIG_MAC_PARTITION Apple's MacOS partition table. 1109923c46f9SKarl O. Pinc CONFIG_DOS_PARTITION MS Dos partition table, traditional on the 1110923c46f9SKarl O. Pinc Intel architecture, USB sticks, etc. 1111923c46f9SKarl O. Pinc CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc. 1112923c46f9SKarl O. Pinc CONFIG_EFI_PARTITION GPT partition table, common when EFI is the 1113923c46f9SKarl O. Pinc bootloader. Note 2TB partition limit; see 1114923c46f9SKarl O. Pinc disk/part_efi.c 1115923c46f9SKarl O. Pinc CONFIG_MTD_PARTITIONS Memory Technology Device partition table. 1116c609719bSwdenk 1117602ad3b3SJon Loeliger If IDE or SCSI support is enabled (CONFIG_CMD_IDE or 1118218ca724SWolfgang Denk CONFIG_CMD_SCSI) you must configure support for at 1119923c46f9SKarl O. Pinc least one non-MTD partition type as well. 1120c609719bSwdenk 1121c609719bSwdenk- IDE Reset method: 11224d13cbadSwdenk CONFIG_IDE_RESET_ROUTINE - this is defined in several 11234d13cbadSwdenk board configurations files but used nowhere! 1124c609719bSwdenk 11254d13cbadSwdenk CONFIG_IDE_RESET - is this is defined, IDE Reset will 11264d13cbadSwdenk be performed by calling the function 11274d13cbadSwdenk ide_set_reset(int reset) 11284d13cbadSwdenk which has to be defined in a board specific file 1129c609719bSwdenk 1130c609719bSwdenk- ATAPI Support: 1131c609719bSwdenk CONFIG_ATAPI 1132c609719bSwdenk 1133c609719bSwdenk Set this to enable ATAPI support. 1134c609719bSwdenk 1135c40b2956Swdenk- LBA48 Support 1136c40b2956Swdenk CONFIG_LBA48 1137c40b2956Swdenk 1138c40b2956Swdenk Set this to enable support for disks larger than 137GB 11394b142febSHeiko Schocher Also look at CONFIG_SYS_64BIT_LBA. 1140c40b2956Swdenk Whithout these , LBA48 support uses 32bit variables and will 'only' 1141c40b2956Swdenk support disks up to 2.1TB. 1142c40b2956Swdenk 11436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_64BIT_LBA: 1144c40b2956Swdenk When enabled, makes the IDE subsystem use 64bit sector addresses. 1145c40b2956Swdenk Default is 32bit. 1146c40b2956Swdenk 1147c609719bSwdenk- SCSI Support: 1148c609719bSwdenk At the moment only there is only support for the 1149c609719bSwdenk SYM53C8XX SCSI controller; define 1150c609719bSwdenk CONFIG_SCSI_SYM53C8XX to enable it. 1151c609719bSwdenk 11526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and 11536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID * 11546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the 1155c609719bSwdenk maximum numbers of LUNs, SCSI ID's and target 1156c609719bSwdenk devices. 11576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz) 1158c609719bSwdenk 1159447c031bSStefan Reinauer The environment variable 'scsidevs' is set to the number of 1160447c031bSStefan Reinauer SCSI devices found during the last scan. 1161447c031bSStefan Reinauer 1162c609719bSwdenk- NETWORK Support (PCI): 1163682011ffSwdenk CONFIG_E1000 1164ce5207e1SKyle Moffett Support for Intel 8254x/8257x gigabit chips. 1165ce5207e1SKyle Moffett 1166ce5207e1SKyle Moffett CONFIG_E1000_SPI 1167ce5207e1SKyle Moffett Utility code for direct access to the SPI bus on Intel 8257x. 1168ce5207e1SKyle Moffett This does not do anything useful unless you set at least one 1169ce5207e1SKyle Moffett of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC. 1170ce5207e1SKyle Moffett 1171ce5207e1SKyle Moffett CONFIG_E1000_SPI_GENERIC 1172ce5207e1SKyle Moffett Allow generic access to the SPI bus on the Intel 8257x, for 1173ce5207e1SKyle Moffett example with the "sspi" command. 1174ce5207e1SKyle Moffett 1175ce5207e1SKyle Moffett CONFIG_CMD_E1000 1176ce5207e1SKyle Moffett Management command for E1000 devices. When used on devices 1177ce5207e1SKyle Moffett with SPI support you can reprogram the EEPROM from U-Boot. 1178682011ffSwdenk 1179ac3315c2SAndre Schwarz CONFIG_E1000_FALLBACK_MAC 118011ccc33fSMarcel Ziswiler default MAC for empty EEPROM after production. 1181ac3315c2SAndre Schwarz 1182c609719bSwdenk CONFIG_EEPRO100 1183c609719bSwdenk Support for Intel 82557/82559/82559ER chips. 118411ccc33fSMarcel Ziswiler Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM 1185c609719bSwdenk write routine for first time initialisation. 1186c609719bSwdenk 1187c609719bSwdenk CONFIG_TULIP 1188c609719bSwdenk Support for Digital 2114x chips. 1189c609719bSwdenk Optional CONFIG_TULIP_SELECT_MEDIA for board specific 1190c609719bSwdenk modem chip initialisation (KS8761/QS6611). 1191c609719bSwdenk 1192c609719bSwdenk CONFIG_NATSEMI 1193c609719bSwdenk Support for National dp83815 chips. 1194c609719bSwdenk 1195c609719bSwdenk CONFIG_NS8382X 1196c609719bSwdenk Support for National dp8382[01] gigabit chips. 1197c609719bSwdenk 119845219c46Swdenk- NETWORK Support (other): 119945219c46Swdenk 1200c041e9d2SJens Scharsig CONFIG_DRIVER_AT91EMAC 1201c041e9d2SJens Scharsig Support for AT91RM9200 EMAC. 1202c041e9d2SJens Scharsig 1203c041e9d2SJens Scharsig CONFIG_RMII 1204c041e9d2SJens Scharsig Define this to use reduced MII inteface 1205c041e9d2SJens Scharsig 1206c041e9d2SJens Scharsig CONFIG_DRIVER_AT91EMAC_QUIET 1207c041e9d2SJens Scharsig If this defined, the driver is quiet. 1208c041e9d2SJens Scharsig The driver doen't show link status messages. 1209c041e9d2SJens Scharsig 1210efdd7319SRob Herring CONFIG_CALXEDA_XGMAC 1211efdd7319SRob Herring Support for the Calxeda XGMAC device 1212efdd7319SRob Herring 12133bb46d23SAshok CONFIG_LAN91C96 121445219c46Swdenk Support for SMSC's LAN91C96 chips. 121545219c46Swdenk 121645219c46Swdenk CONFIG_LAN91C96_BASE 121745219c46Swdenk Define this to hold the physical address 121845219c46Swdenk of the LAN91C96's I/O space 121945219c46Swdenk 122045219c46Swdenk CONFIG_LAN91C96_USE_32_BIT 122145219c46Swdenk Define this to enable 32 bit addressing 122245219c46Swdenk 12233bb46d23SAshok CONFIG_SMC91111 1224f39748aeSwdenk Support for SMSC's LAN91C111 chip 1225f39748aeSwdenk 1226f39748aeSwdenk CONFIG_SMC91111_BASE 1227f39748aeSwdenk Define this to hold the physical address 1228f39748aeSwdenk of the device (I/O space) 1229f39748aeSwdenk 1230f39748aeSwdenk CONFIG_SMC_USE_32_BIT 1231f39748aeSwdenk Define this if data bus is 32 bits 1232f39748aeSwdenk 1233f39748aeSwdenk CONFIG_SMC_USE_IOFUNCS 1234f39748aeSwdenk Define this to use i/o functions instead of macros 1235f39748aeSwdenk (some hardware wont work with macros) 1236f39748aeSwdenk 1237dc02badaSHeiko Schocher CONFIG_DRIVER_TI_EMAC 1238dc02badaSHeiko Schocher Support for davinci emac 1239dc02badaSHeiko Schocher 1240dc02badaSHeiko Schocher CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT 1241dc02badaSHeiko Schocher Define this if you have more then 3 PHYs. 1242dc02badaSHeiko Schocher 1243b3dbf4a5SMacpaul Lin CONFIG_FTGMAC100 1244b3dbf4a5SMacpaul Lin Support for Faraday's FTGMAC100 Gigabit SoC Ethernet 1245b3dbf4a5SMacpaul Lin 1246b3dbf4a5SMacpaul Lin CONFIG_FTGMAC100_EGIGA 1247b3dbf4a5SMacpaul Lin Define this to use GE link update with gigabit PHY. 1248b3dbf4a5SMacpaul Lin Define this if FTGMAC100 is connected to gigabit PHY. 1249b3dbf4a5SMacpaul Lin If your system has 10/100 PHY only, it might not occur 1250b3dbf4a5SMacpaul Lin wrong behavior. Because PHY usually return timeout or 1251b3dbf4a5SMacpaul Lin useless data when polling gigabit status and gigabit 1252b3dbf4a5SMacpaul Lin control registers. This behavior won't affect the 1253b3dbf4a5SMacpaul Lin correctnessof 10/100 link speed update. 1254b3dbf4a5SMacpaul Lin 1255c2fff331SMike Rapoport CONFIG_SMC911X 1256557b377dSJens Gehrlein Support for SMSC's LAN911x and LAN921x chips 1257557b377dSJens Gehrlein 1258c2fff331SMike Rapoport CONFIG_SMC911X_BASE 1259557b377dSJens Gehrlein Define this to hold the physical address 1260557b377dSJens Gehrlein of the device (I/O space) 1261557b377dSJens Gehrlein 1262c2fff331SMike Rapoport CONFIG_SMC911X_32_BIT 1263557b377dSJens Gehrlein Define this if data bus is 32 bits 1264557b377dSJens Gehrlein 1265c2fff331SMike Rapoport CONFIG_SMC911X_16_BIT 1266557b377dSJens Gehrlein Define this if data bus is 16 bits. If your processor 1267557b377dSJens Gehrlein automatically converts one 32 bit word to two 16 bit 1268c2fff331SMike Rapoport words you may also try CONFIG_SMC911X_32_BIT. 1269557b377dSJens Gehrlein 12703d0075faSYoshihiro Shimoda CONFIG_SH_ETHER 12713d0075faSYoshihiro Shimoda Support for Renesas on-chip Ethernet controller 12723d0075faSYoshihiro Shimoda 12733d0075faSYoshihiro Shimoda CONFIG_SH_ETHER_USE_PORT 12743d0075faSYoshihiro Shimoda Define the number of ports to be used 12753d0075faSYoshihiro Shimoda 12763d0075faSYoshihiro Shimoda CONFIG_SH_ETHER_PHY_ADDR 12773d0075faSYoshihiro Shimoda Define the ETH PHY's address 12783d0075faSYoshihiro Shimoda 127968260aabSYoshihiro Shimoda CONFIG_SH_ETHER_CACHE_WRITEBACK 128068260aabSYoshihiro Shimoda If this option is set, the driver enables cache flush. 128168260aabSYoshihiro Shimoda 12825e124724SVadim Bendebury- TPM Support: 128390899cc0SChe-liang Chiou CONFIG_TPM 128490899cc0SChe-liang Chiou Support TPM devices. 128590899cc0SChe-liang Chiou 12861b393db5STom Wai-Hong Tam CONFIG_TPM_TIS_I2C 12871b393db5STom Wai-Hong Tam Support for i2c bus TPM devices. Only one device 12881b393db5STom Wai-Hong Tam per system is supported at this time. 12891b393db5STom Wai-Hong Tam 12901b393db5STom Wai-Hong Tam CONFIG_TPM_TIS_I2C_BUS_NUMBER 12911b393db5STom Wai-Hong Tam Define the the i2c bus number for the TPM device 12921b393db5STom Wai-Hong Tam 12931b393db5STom Wai-Hong Tam CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS 12941b393db5STom Wai-Hong Tam Define the TPM's address on the i2c bus 12951b393db5STom Wai-Hong Tam 12961b393db5STom Wai-Hong Tam CONFIG_TPM_TIS_I2C_BURST_LIMITATION 12971b393db5STom Wai-Hong Tam Define the burst count bytes upper limit 12981b393db5STom Wai-Hong Tam 1299c01939c7SDirk Eibach CONFIG_TPM_ATMEL_TWI 1300c01939c7SDirk Eibach Support for Atmel TWI TPM device. Requires I2C support. 1301c01939c7SDirk Eibach 130290899cc0SChe-liang Chiou CONFIG_TPM_TIS_LPC 13035e124724SVadim Bendebury Support for generic parallel port TPM devices. Only one device 13045e124724SVadim Bendebury per system is supported at this time. 13055e124724SVadim Bendebury 13065e124724SVadim Bendebury CONFIG_TPM_TIS_BASE_ADDRESS 13075e124724SVadim Bendebury Base address where the generic TPM device is mapped 13085e124724SVadim Bendebury to. Contemporary x86 systems usually map it at 13095e124724SVadim Bendebury 0xfed40000. 13105e124724SVadim Bendebury 1311be6c1529SReinhard Pfau CONFIG_CMD_TPM 1312be6c1529SReinhard Pfau Add tpm monitor functions. 1313be6c1529SReinhard Pfau Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also 1314be6c1529SReinhard Pfau provides monitor access to authorized functions. 1315be6c1529SReinhard Pfau 1316be6c1529SReinhard Pfau CONFIG_TPM 1317be6c1529SReinhard Pfau Define this to enable the TPM support library which provides 1318be6c1529SReinhard Pfau functional interfaces to some TPM commands. 1319be6c1529SReinhard Pfau Requires support for a TPM device. 1320be6c1529SReinhard Pfau 1321be6c1529SReinhard Pfau CONFIG_TPM_AUTH_SESSIONS 1322be6c1529SReinhard Pfau Define this to enable authorized functions in the TPM library. 1323be6c1529SReinhard Pfau Requires CONFIG_TPM and CONFIG_SHA1. 1324be6c1529SReinhard Pfau 1325c609719bSwdenk- USB Support: 1326c609719bSwdenk At the moment only the UHCI host controller is 13274d13cbadSwdenk supported (PIP405, MIP405, MPC5200); define 1328c609719bSwdenk CONFIG_USB_UHCI to enable it. 1329c609719bSwdenk define CONFIG_USB_KEYBOARD to enable the USB Keyboard 133030d56faeSwdenk and define CONFIG_USB_STORAGE to enable the USB 1331c609719bSwdenk storage devices. 1332c609719bSwdenk Note: 1333c609719bSwdenk Supported are USB Keyboards and USB Floppy drives 1334c609719bSwdenk (TEAC FD-05PUB). 13354d13cbadSwdenk MPC5200 USB requires additional defines: 13364d13cbadSwdenk CONFIG_USB_CLOCK 13374d13cbadSwdenk for 528 MHz Clock: 0x0001bbbb 1338307ecb6dSEric Millbrandt CONFIG_PSC3_USB 1339307ecb6dSEric Millbrandt for USB on PSC3 13404d13cbadSwdenk CONFIG_USB_CONFIG 13414d13cbadSwdenk for differential drivers: 0x00001000 13424d13cbadSwdenk for single ended drivers: 0x00005000 1343307ecb6dSEric Millbrandt for differential drivers on PSC3: 0x00000100 1344307ecb6dSEric Millbrandt for single ended drivers on PSC3: 0x00004100 13456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_USB_EVENT_POLL 1346fdcfaa1bSZhang Wei May be defined to allow interrupt polling 1347fdcfaa1bSZhang Wei instead of using asynchronous interrupts 13484d13cbadSwdenk 13499ab4ce22SSimon Glass CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the 13509ab4ce22SSimon Glass txfilltuning field in the EHCI controller on reset. 13519ab4ce22SSimon Glass 1352aa155058SKuo-Jung Su CONFIG_USB_HUB_MIN_POWER_ON_DELAY defines the minimum 1353aa155058SKuo-Jung Su interval for usb hub power-on delay.(minimum 100msec) 1354aa155058SKuo-Jung Su 135516c8d5e7SWolfgang Denk- USB Device: 135616c8d5e7SWolfgang Denk Define the below if you wish to use the USB console. 135716c8d5e7SWolfgang Denk Once firmware is rebuilt from a serial console issue the 135816c8d5e7SWolfgang Denk command "setenv stdin usbtty; setenv stdout usbtty" and 135911ccc33fSMarcel Ziswiler attach your USB cable. The Unix command "dmesg" should print 136016c8d5e7SWolfgang Denk it has found a new device. The environment variable usbtty 136116c8d5e7SWolfgang Denk can be set to gserial or cdc_acm to enable your device to 136216c8d5e7SWolfgang Denk appear to a USB host as a Linux gserial device or a 136316c8d5e7SWolfgang Denk Common Device Class Abstract Control Model serial device. 136416c8d5e7SWolfgang Denk If you select usbtty = gserial you should be able to enumerate 136516c8d5e7SWolfgang Denk a Linux host by 136616c8d5e7SWolfgang Denk # modprobe usbserial vendor=0xVendorID product=0xProductID 136716c8d5e7SWolfgang Denk else if using cdc_acm, simply setting the environment 136816c8d5e7SWolfgang Denk variable usbtty to be cdc_acm should suffice. The following 136916c8d5e7SWolfgang Denk might be defined in YourBoardName.h 137016c8d5e7SWolfgang Denk 137116c8d5e7SWolfgang Denk CONFIG_USB_DEVICE 137216c8d5e7SWolfgang Denk Define this to build a UDC device 137316c8d5e7SWolfgang Denk 137416c8d5e7SWolfgang Denk CONFIG_USB_TTY 137516c8d5e7SWolfgang Denk Define this to have a tty type of device available to 137616c8d5e7SWolfgang Denk talk to the UDC device 137716c8d5e7SWolfgang Denk 1378f9da0f89SVipin KUMAR CONFIG_USBD_HS 1379f9da0f89SVipin KUMAR Define this to enable the high speed support for usb 1380f9da0f89SVipin KUMAR device and usbtty. If this feature is enabled, a routine 1381f9da0f89SVipin KUMAR int is_usbd_high_speed(void) 1382f9da0f89SVipin KUMAR also needs to be defined by the driver to dynamically poll 1383f9da0f89SVipin KUMAR whether the enumeration has succeded at high speed or full 1384f9da0f89SVipin KUMAR speed. 1385f9da0f89SVipin KUMAR 13866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_CONSOLE_IS_IN_ENV 138716c8d5e7SWolfgang Denk Define this if you want stdin, stdout &/or stderr to 138816c8d5e7SWolfgang Denk be set to usbtty. 138916c8d5e7SWolfgang Denk 139016c8d5e7SWolfgang Denk mpc8xx: 13916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_USB_EXTC_CLK 0xBLAH 139216c8d5e7SWolfgang Denk Derive USB clock from external clock "blah" 13936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_USB_EXTC_CLK 0x02 139416c8d5e7SWolfgang Denk 13956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_USB_BRG_CLK 0xBLAH 139616c8d5e7SWolfgang Denk Derive USB clock from brgclk 13976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_USB_BRG_CLK 0x04 139816c8d5e7SWolfgang Denk 139916c8d5e7SWolfgang Denk If you have a USB-IF assigned VendorID then you may wish to 140016c8d5e7SWolfgang Denk define your own vendor specific values either in BoardName.h 140116c8d5e7SWolfgang Denk or directly in usbd_vendor_info.h. If you don't define 140216c8d5e7SWolfgang Denk CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME, 140316c8d5e7SWolfgang Denk CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot 140416c8d5e7SWolfgang Denk should pretend to be a Linux device to it's target host. 140516c8d5e7SWolfgang Denk 140616c8d5e7SWolfgang Denk CONFIG_USBD_MANUFACTURER 140716c8d5e7SWolfgang Denk Define this string as the name of your company for 140816c8d5e7SWolfgang Denk - CONFIG_USBD_MANUFACTURER "my company" 140916c8d5e7SWolfgang Denk 141016c8d5e7SWolfgang Denk CONFIG_USBD_PRODUCT_NAME 141116c8d5e7SWolfgang Denk Define this string as the name of your product 141216c8d5e7SWolfgang Denk - CONFIG_USBD_PRODUCT_NAME "acme usb device" 141316c8d5e7SWolfgang Denk 141416c8d5e7SWolfgang Denk CONFIG_USBD_VENDORID 141516c8d5e7SWolfgang Denk Define this as your assigned Vendor ID from the USB 141616c8d5e7SWolfgang Denk Implementors Forum. This *must* be a genuine Vendor ID 141716c8d5e7SWolfgang Denk to avoid polluting the USB namespace. 141816c8d5e7SWolfgang Denk - CONFIG_USBD_VENDORID 0xFFFF 141916c8d5e7SWolfgang Denk 142016c8d5e7SWolfgang Denk CONFIG_USBD_PRODUCTID 142116c8d5e7SWolfgang Denk Define this as the unique Product ID 142216c8d5e7SWolfgang Denk for your device 142316c8d5e7SWolfgang Denk - CONFIG_USBD_PRODUCTID 0xFFFF 1424c609719bSwdenk 1425351e9b20SPrzemyslaw Marczak Some USB device drivers may need to check USB cable attachment. 1426351e9b20SPrzemyslaw Marczak In this case you can enable following config in BoardName.h: 1427351e9b20SPrzemyslaw Marczak CONFIG_USB_CABLE_CHECK 1428351e9b20SPrzemyslaw Marczak This enables function definition: 1429351e9b20SPrzemyslaw Marczak - usb_cable_connected() in include/usb.h 1430351e9b20SPrzemyslaw Marczak Implementation of this function is board-specific. 1431351e9b20SPrzemyslaw Marczak 1432d70a560fSIgor Grinberg- ULPI Layer Support: 1433d70a560fSIgor Grinberg The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via 1434d70a560fSIgor Grinberg the generic ULPI layer. The generic layer accesses the ULPI PHY 1435d70a560fSIgor Grinberg via the platform viewport, so you need both the genric layer and 1436d70a560fSIgor Grinberg the viewport enabled. Currently only Chipidea/ARC based 1437d70a560fSIgor Grinberg viewport is supported. 1438d70a560fSIgor Grinberg To enable the ULPI layer support, define CONFIG_USB_ULPI and 1439d70a560fSIgor Grinberg CONFIG_USB_ULPI_VIEWPORT in your board configuration file. 14406d365ea0SLucas Stach If your ULPI phy needs a different reference clock than the 14416d365ea0SLucas Stach standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to 14426d365ea0SLucas Stach the appropriate value in Hz. 1443c609719bSwdenk 1444c609719bSwdenk- MMC Support: 1445c609719bSwdenk The MMC controller on the Intel PXA is supported. To 1446c609719bSwdenk enable this define CONFIG_MMC. The MMC can be 1447c609719bSwdenk accessed from the boot prompt by mapping the device 1448c609719bSwdenk to physical memory similar to flash. Command line is 1449602ad3b3SJon Loeliger enabled with CONFIG_CMD_MMC. The MMC driver also works with 1450602ad3b3SJon Loeliger the FAT fs. This is enabled with CONFIG_CMD_FAT. 1451c609719bSwdenk 1452afb35666SYoshihiro Shimoda CONFIG_SH_MMCIF 1453afb35666SYoshihiro Shimoda Support for Renesas on-chip MMCIF controller 1454afb35666SYoshihiro Shimoda 1455afb35666SYoshihiro Shimoda CONFIG_SH_MMCIF_ADDR 1456afb35666SYoshihiro Shimoda Define the base address of MMCIF registers 1457afb35666SYoshihiro Shimoda 1458afb35666SYoshihiro Shimoda CONFIG_SH_MMCIF_CLK 1459afb35666SYoshihiro Shimoda Define the clock frequency for MMCIF 1460afb35666SYoshihiro Shimoda 1461b3ba6e94STom Rini- USB Device Firmware Update (DFU) class support: 1462b3ba6e94STom Rini CONFIG_DFU_FUNCTION 1463b3ba6e94STom Rini This enables the USB portion of the DFU USB class 1464b3ba6e94STom Rini 1465b3ba6e94STom Rini CONFIG_CMD_DFU 1466b3ba6e94STom Rini This enables the command "dfu" which is used to have 1467b3ba6e94STom Rini U-Boot create a DFU class device via USB. This command 1468b3ba6e94STom Rini requires that the "dfu_alt_info" environment variable be 1469b3ba6e94STom Rini set and define the alt settings to expose to the host. 1470b3ba6e94STom Rini 1471b3ba6e94STom Rini CONFIG_DFU_MMC 1472b3ba6e94STom Rini This enables support for exposing (e)MMC devices via DFU. 1473b3ba6e94STom Rini 1474c6631764SPantelis Antoniou CONFIG_DFU_NAND 1475c6631764SPantelis Antoniou This enables support for exposing NAND devices via DFU. 1476c6631764SPantelis Antoniou 1477a9479f04SAfzal Mohammed CONFIG_DFU_RAM 1478a9479f04SAfzal Mohammed This enables support for exposing RAM via DFU. 1479a9479f04SAfzal Mohammed Note: DFU spec refer to non-volatile memory usage, but 1480a9479f04SAfzal Mohammed allow usages beyond the scope of spec - here RAM usage, 1481a9479f04SAfzal Mohammed one that would help mostly the developer. 1482a9479f04SAfzal Mohammed 1483e7e75c70SHeiko Schocher CONFIG_SYS_DFU_DATA_BUF_SIZE 1484e7e75c70SHeiko Schocher Dfu transfer uses a buffer before writing data to the 1485e7e75c70SHeiko Schocher raw storage device. Make the size (in bytes) of this buffer 1486e7e75c70SHeiko Schocher configurable. The size of this buffer is also configurable 1487e7e75c70SHeiko Schocher through the "dfu_bufsiz" environment variable. 1488e7e75c70SHeiko Schocher 1489ea2453d5SPantelis Antoniou CONFIG_SYS_DFU_MAX_FILE_SIZE 1490ea2453d5SPantelis Antoniou When updating files rather than the raw storage device, 1491ea2453d5SPantelis Antoniou we use a static buffer to copy the file into and then write 1492ea2453d5SPantelis Antoniou the buffer once we've been given the whole file. Define 1493ea2453d5SPantelis Antoniou this to the maximum filesize (in bytes) for the buffer. 1494ea2453d5SPantelis Antoniou Default is 4 MiB if undefined. 1495ea2453d5SPantelis Antoniou 14966705d81eSwdenk- Journaling Flash filesystem support: 14976705d81eSwdenk CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE, 14986705d81eSwdenk CONFIG_JFFS2_NAND_DEV 14996705d81eSwdenk Define these for a default partition on a NAND device 15006705d81eSwdenk 15016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS2_FIRST_SECTOR, 15026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS 15036705d81eSwdenk Define these for a default partition on a NOR device 15046705d81eSwdenk 15056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS_CUSTOM_PART 15066705d81eSwdenk Define this to create an own partition. You have to provide a 15076705d81eSwdenk function struct part_info* jffs2_part_info(int part_num) 15086705d81eSwdenk 15096705d81eSwdenk If you define only one JFFS2 partition you may also want to 15106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_JFFS_SINGLE_PART 1 15116705d81eSwdenk to disable the command chpart. This is the default when you 15126705d81eSwdenk have not defined a custom partition 15136705d81eSwdenk 1514c30a15e5SDonggeun Kim- FAT(File Allocation Table) filesystem write function support: 1515c30a15e5SDonggeun Kim CONFIG_FAT_WRITE 1516656f4c65SDonggeun Kim 1517656f4c65SDonggeun Kim Define this to enable support for saving memory data as a 1518656f4c65SDonggeun Kim file in FAT formatted partition. 1519656f4c65SDonggeun Kim 1520656f4c65SDonggeun Kim This will also enable the command "fatwrite" enabling the 1521656f4c65SDonggeun Kim user to write files to FAT. 1522c30a15e5SDonggeun Kim 152384cd9327SGabe BlackCBFS (Coreboot Filesystem) support 152484cd9327SGabe Black CONFIG_CMD_CBFS 152584cd9327SGabe Black 152684cd9327SGabe Black Define this to enable support for reading from a Coreboot 152784cd9327SGabe Black filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls 152884cd9327SGabe Black and cbfsload. 152984cd9327SGabe Black 1530c609719bSwdenk- Keyboard Support: 1531c609719bSwdenk CONFIG_ISA_KEYBOARD 1532c609719bSwdenk 1533c609719bSwdenk Define this to enable standard (PC-Style) keyboard 1534c609719bSwdenk support 1535c609719bSwdenk 1536c609719bSwdenk CONFIG_I8042_KBD 1537c609719bSwdenk Standard PC keyboard driver with US (is default) and 1538c609719bSwdenk GERMAN key layout (switch via environment 'keymap=de') support. 1539c609719bSwdenk Export function i8042_kbd_init, i8042_tstc and i8042_getc 1540c609719bSwdenk for cfb_console. Supports cursor blinking. 1541c609719bSwdenk 1542713cb680SHung-ying Tyan CONFIG_CROS_EC_KEYB 1543713cb680SHung-ying Tyan Enables a Chrome OS keyboard using the CROS_EC interface. 1544713cb680SHung-ying Tyan This uses CROS_EC to communicate with a second microcontroller 1545713cb680SHung-ying Tyan which provides key scans on request. 1546713cb680SHung-ying Tyan 1547c609719bSwdenk- Video support: 1548c609719bSwdenk CONFIG_VIDEO 1549c609719bSwdenk 1550c609719bSwdenk Define this to enable video support (for output to 1551c609719bSwdenk video). 1552c609719bSwdenk 1553c609719bSwdenk CONFIG_VIDEO_CT69000 1554c609719bSwdenk 1555c609719bSwdenk Enable Chips & Technologies 69000 Video chip 1556c609719bSwdenk 1557c609719bSwdenk CONFIG_VIDEO_SMI_LYNXEM 1558eeb1b77bSwdenk Enable Silicon Motion SMI 712/710/810 Video chip. The 1559eeb1b77bSwdenk video output is selected via environment 'videoout' 1560eeb1b77bSwdenk (1 = LCD and 2 = CRT). If videoout is undefined, CRT is 1561eeb1b77bSwdenk assumed. 1562c609719bSwdenk 1563eeb1b77bSwdenk For the CT69000 and SMI_LYNXEM drivers, videomode is 156411ccc33fSMarcel Ziswiler selected via environment 'videomode'. Two different ways 1565eeb1b77bSwdenk are possible: 1566eeb1b77bSwdenk - "videomode=num" 'num' is a standard LiLo mode numbers. 1567eeb1b77bSwdenk Following standard modes are supported (* is default): 1568eeb1b77bSwdenk 1569eeb1b77bSwdenk Colors 640x480 800x600 1024x768 1152x864 1280x1024 1570eeb1b77bSwdenk -------------+--------------------------------------------- 1571eeb1b77bSwdenk 8 bits | 0x301* 0x303 0x305 0x161 0x307 1572eeb1b77bSwdenk 15 bits | 0x310 0x313 0x316 0x162 0x319 1573eeb1b77bSwdenk 16 bits | 0x311 0x314 0x317 0x163 0x31A 1574eeb1b77bSwdenk 24 bits | 0x312 0x315 0x318 ? 0x31B 1575eeb1b77bSwdenk -------------+--------------------------------------------- 1576c609719bSwdenk (i.e. setenv videomode 317; saveenv; reset;) 1577c609719bSwdenk 1578eeb1b77bSwdenk - "videomode=bootargs" all the video parameters are parsed 15797817cb20SMarcel Ziswiler from the bootargs. (See drivers/video/videomodes.c) 1580eeb1b77bSwdenk 1581eeb1b77bSwdenk 1582a6c7ad2fSwdenk CONFIG_VIDEO_SED13806 1583a6c7ad2fSwdenk Enable Epson SED13806 driver. This driver supports 8bpp 1584a6c7ad2fSwdenk and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP 1585a6c7ad2fSwdenk or CONFIG_VIDEO_SED13806_16BPP 1586a6c7ad2fSwdenk 15877d3053fbSTimur Tabi CONFIG_FSL_DIU_FB 15887d3053fbSTimur Tabi Enable the Freescale DIU video driver. Reference boards for 15897d3053fbSTimur Tabi SOCs that have a DIU should define this macro to enable DIU 15907d3053fbSTimur Tabi support, and should also define these other macros: 15917d3053fbSTimur Tabi 15927d3053fbSTimur Tabi CONFIG_SYS_DIU_ADDR 15937d3053fbSTimur Tabi CONFIG_VIDEO 15947d3053fbSTimur Tabi CONFIG_CMD_BMP 15957d3053fbSTimur Tabi CONFIG_CFB_CONSOLE 15967d3053fbSTimur Tabi CONFIG_VIDEO_SW_CURSOR 15977d3053fbSTimur Tabi CONFIG_VGA_AS_SINGLE_DEVICE 15987d3053fbSTimur Tabi CONFIG_VIDEO_LOGO 15997d3053fbSTimur Tabi CONFIG_VIDEO_BMP_LOGO 16007d3053fbSTimur Tabi 1601ba8e76bdSTimur Tabi The DIU driver will look for the 'video-mode' environment 1602ba8e76bdSTimur Tabi variable, and if defined, enable the DIU as a console during 1603ba8e76bdSTimur Tabi boot. See the documentation file README.video for a 1604ba8e76bdSTimur Tabi description of this variable. 16057d3053fbSTimur Tabi 1606058d59b0SSimon Glass CONFIG_VIDEO_VGA 1607058d59b0SSimon Glass 1608058d59b0SSimon Glass Enable the VGA video / BIOS for x86. The alternative if you 1609058d59b0SSimon Glass are using coreboot is to use the coreboot frame buffer 1610058d59b0SSimon Glass driver. 1611058d59b0SSimon Glass 1612058d59b0SSimon Glass 1613682011ffSwdenk- Keyboard Support: 1614682011ffSwdenk CONFIG_KEYBOARD 1615682011ffSwdenk 1616682011ffSwdenk Define this to enable a custom keyboard support. 1617682011ffSwdenk This simply calls drv_keyboard_init() which must be 1618682011ffSwdenk defined in your board-specific files. 1619682011ffSwdenk The only board using this so far is RBC823. 1620a6c7ad2fSwdenk 1621c609719bSwdenk- LCD Support: CONFIG_LCD 1622c609719bSwdenk 1623c609719bSwdenk Define this to enable LCD support (for output to LCD 1624c609719bSwdenk display); also select one of the supported displays 1625c609719bSwdenk by defining one of these: 1626c609719bSwdenk 162739cf4804SStelian Pop CONFIG_ATMEL_LCD: 162839cf4804SStelian Pop 162939cf4804SStelian Pop HITACHI TX09D70VM1CCA, 3.5", 240x320. 163039cf4804SStelian Pop 1631fd3103bbSwdenk CONFIG_NEC_NL6448AC33: 1632c609719bSwdenk 1633fd3103bbSwdenk NEC NL6448AC33-18. Active, color, single scan. 1634c609719bSwdenk 1635fd3103bbSwdenk CONFIG_NEC_NL6448BC20 1636c609719bSwdenk 1637fd3103bbSwdenk NEC NL6448BC20-08. 6.5", 640x480. 1638fd3103bbSwdenk Active, color, single scan. 1639fd3103bbSwdenk 1640fd3103bbSwdenk CONFIG_NEC_NL6448BC33_54 1641fd3103bbSwdenk 1642fd3103bbSwdenk NEC NL6448BC33-54. 10.4", 640x480. 1643c609719bSwdenk Active, color, single scan. 1644c609719bSwdenk 1645c609719bSwdenk CONFIG_SHARP_16x9 1646c609719bSwdenk 1647c609719bSwdenk Sharp 320x240. Active, color, single scan. 1648c609719bSwdenk It isn't 16x9, and I am not sure what it is. 1649c609719bSwdenk 1650c609719bSwdenk CONFIG_SHARP_LQ64D341 1651c609719bSwdenk 1652c609719bSwdenk Sharp LQ64D341 display, 640x480. 1653c609719bSwdenk Active, color, single scan. 1654c609719bSwdenk 1655c609719bSwdenk CONFIG_HLD1045 1656c609719bSwdenk 1657c609719bSwdenk HLD1045 display, 640x480. 1658c609719bSwdenk Active, color, single scan. 1659c609719bSwdenk 1660c609719bSwdenk CONFIG_OPTREX_BW 1661c609719bSwdenk 1662c609719bSwdenk Optrex CBL50840-2 NF-FW 99 22 M5 1663c609719bSwdenk or 1664c609719bSwdenk Hitachi LMG6912RPFC-00T 1665c609719bSwdenk or 1666c609719bSwdenk Hitachi SP14Q002 1667c609719bSwdenk 1668c609719bSwdenk 320x240. Black & white. 1669c609719bSwdenk 1670c609719bSwdenk Normally display is black on white background; define 16716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_WHITE_ON_BLACK to get it inverted. 1672c609719bSwdenk 1673676d319eSSimon Glass CONFIG_LCD_ALIGNMENT 1674676d319eSSimon Glass 1675676d319eSSimon Glass Normally the LCD is page-aligned (tyically 4KB). If this is 1676676d319eSSimon Glass defined then the LCD will be aligned to this value instead. 1677676d319eSSimon Glass For ARM it is sometimes useful to use MMU_SECTION_SIZE 1678676d319eSSimon Glass here, since it is cheaper to change data cache settings on 1679676d319eSSimon Glass a per-section basis. 1680676d319eSSimon Glass 16810d89efefSSimon Glass CONFIG_CONSOLE_SCROLL_LINES 16820d89efefSSimon Glass 16830d89efefSSimon Glass When the console need to be scrolled, this is the number of 16840d89efefSSimon Glass lines to scroll by. It defaults to 1. Increasing this makes 16850d89efefSSimon Glass the console jump but can help speed up operation when scrolling 16860d89efefSSimon Glass is slow. 1687676d319eSSimon Glass 168845d7f525STom Wai-Hong Tam CONFIG_LCD_BMP_RLE8 168945d7f525STom Wai-Hong Tam 169045d7f525STom Wai-Hong Tam Support drawing of RLE8-compressed bitmaps on the LCD. 169145d7f525STom Wai-Hong Tam 1692735987c5STom Wai-Hong Tam CONFIG_I2C_EDID 1693735987c5STom Wai-Hong Tam 1694735987c5STom Wai-Hong Tam Enables an 'i2c edid' command which can read EDID 1695735987c5STom Wai-Hong Tam information over I2C from an attached LCD display. 1696735987c5STom Wai-Hong Tam 16977152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN 1698d791b1dcSwdenk 1699d791b1dcSwdenk If this option is set, the environment is checked for 1700d791b1dcSwdenk a variable "splashimage". If found, the usual display 1701d791b1dcSwdenk of logo, copyright and system information on the LCD 1702e94d2cd9Swdenk is suppressed and the BMP image at the address 1703d791b1dcSwdenk specified in "splashimage" is loaded instead. The 1704d791b1dcSwdenk console is redirected to the "nulldev", too. This 1705d791b1dcSwdenk allows for a "silent" boot where a splash screen is 1706d791b1dcSwdenk loaded very quickly after power-on. 1707d791b1dcSwdenk 1708c0880485SNikita Kiryanov CONFIG_SPLASHIMAGE_GUARD 1709c0880485SNikita Kiryanov 1710c0880485SNikita Kiryanov If this option is set, then U-Boot will prevent the environment 1711c0880485SNikita Kiryanov variable "splashimage" from being set to a problematic address 1712c0880485SNikita Kiryanov (see README.displaying-bmps and README.arm-unaligned-accesses). 1713c0880485SNikita Kiryanov This option is useful for targets where, due to alignment 1714c0880485SNikita Kiryanov restrictions, an improperly aligned BMP image will cause a data 1715c0880485SNikita Kiryanov abort. If you think you will not have problems with unaligned 1716c0880485SNikita Kiryanov accesses (for example because your toolchain prevents them) 1717c0880485SNikita Kiryanov there is no need to set this option. 1718c0880485SNikita Kiryanov 17191ca298ceSMatthias Weisser CONFIG_SPLASH_SCREEN_ALIGN 17201ca298ceSMatthias Weisser 17211ca298ceSMatthias Weisser If this option is set the splash image can be freely positioned 17221ca298ceSMatthias Weisser on the screen. Environment variable "splashpos" specifies the 17231ca298ceSMatthias Weisser position as "x,y". If a positive number is given it is used as 17241ca298ceSMatthias Weisser number of pixel from left/top. If a negative number is given it 17251ca298ceSMatthias Weisser is used as number of pixel from right/bottom. You can also 17261ca298ceSMatthias Weisser specify 'm' for centering the image. 17271ca298ceSMatthias Weisser 17281ca298ceSMatthias Weisser Example: 17291ca298ceSMatthias Weisser setenv splashpos m,m 17301ca298ceSMatthias Weisser => image at center of screen 17311ca298ceSMatthias Weisser 17321ca298ceSMatthias Weisser setenv splashpos 30,20 17331ca298ceSMatthias Weisser => image at x = 30 and y = 20 17341ca298ceSMatthias Weisser 17351ca298ceSMatthias Weisser setenv splashpos -10,m 17361ca298ceSMatthias Weisser => vertically centered image 17371ca298ceSMatthias Weisser at x = dspWidth - bmpWidth - 9 17381ca298ceSMatthias Weisser 173998f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP 174098f4a3dfSStefan Roese 174198f4a3dfSStefan Roese If this option is set, additionally to standard BMP 174298f4a3dfSStefan Roese images, gzipped BMP images can be displayed via the 174398f4a3dfSStefan Roese splashscreen support or the bmp command. 174498f4a3dfSStefan Roese 1745d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8 1746d5011762SAnatolij Gustschin 1747d5011762SAnatolij Gustschin If this option is set, 8-bit RLE compressed BMP images 1748d5011762SAnatolij Gustschin can be displayed via the splashscreen support or the 1749d5011762SAnatolij Gustschin bmp command. 1750d5011762SAnatolij Gustschin 1751f2b96dfbSLei Wen- Do compresssing for memory range: 1752f2b96dfbSLei Wen CONFIG_CMD_ZIP 1753f2b96dfbSLei Wen 1754f2b96dfbSLei Wen If this option is set, it would use zlib deflate method 1755f2b96dfbSLei Wen to compress the specified memory at its best effort. 1756f2b96dfbSLei Wen 1757c29fdfc1Swdenk- Compression support: 17588ef70478SKees Cook CONFIG_GZIP 17598ef70478SKees Cook 17608ef70478SKees Cook Enabled by default to support gzip compressed images. 17618ef70478SKees Cook 1762c29fdfc1Swdenk CONFIG_BZIP2 1763c29fdfc1Swdenk 1764c29fdfc1Swdenk If this option is set, support for bzip2 compressed 1765c29fdfc1Swdenk images is included. If not, only uncompressed and gzip 1766c29fdfc1Swdenk compressed images are supported. 1767c29fdfc1Swdenk 1768c29fdfc1Swdenk NOTE: the bzip2 algorithm requires a lot of RAM, so 17696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should 1770c29fdfc1Swdenk be at least 4MB. 1771d791b1dcSwdenk 1772fc9c1727SLuigi 'Comio' Mantellini CONFIG_LZMA 1773fc9c1727SLuigi 'Comio' Mantellini 1774fc9c1727SLuigi 'Comio' Mantellini If this option is set, support for lzma compressed 1775fc9c1727SLuigi 'Comio' Mantellini images is included. 1776fc9c1727SLuigi 'Comio' Mantellini 1777fc9c1727SLuigi 'Comio' Mantellini Note: The LZMA algorithm adds between 2 and 4KB of code and it 1778fc9c1727SLuigi 'Comio' Mantellini requires an amount of dynamic memory that is given by the 1779fc9c1727SLuigi 'Comio' Mantellini formula: 1780fc9c1727SLuigi 'Comio' Mantellini 1781fc9c1727SLuigi 'Comio' Mantellini (1846 + 768 << (lc + lp)) * sizeof(uint16) 1782fc9c1727SLuigi 'Comio' Mantellini 1783fc9c1727SLuigi 'Comio' Mantellini Where lc and lp stand for, respectively, Literal context bits 1784fc9c1727SLuigi 'Comio' Mantellini and Literal pos bits. 1785fc9c1727SLuigi 'Comio' Mantellini 1786fc9c1727SLuigi 'Comio' Mantellini This value is upper-bounded by 14MB in the worst case. Anyway, 1787fc9c1727SLuigi 'Comio' Mantellini for a ~4MB large kernel image, we have lc=3 and lp=0 for a 1788fc9c1727SLuigi 'Comio' Mantellini total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is 1789fc9c1727SLuigi 'Comio' Mantellini a very small buffer. 1790fc9c1727SLuigi 'Comio' Mantellini 1791fc9c1727SLuigi 'Comio' Mantellini Use the lzmainfo tool to determinate the lc and lp values and 1792fc9c1727SLuigi 'Comio' Mantellini then calculate the amount of needed dynamic memory (ensuring 17936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD the appropriate CONFIG_SYS_MALLOC_LEN value). 1794fc9c1727SLuigi 'Comio' Mantellini 17958ef70478SKees Cook CONFIG_LZO 17968ef70478SKees Cook 17978ef70478SKees Cook If this option is set, support for LZO compressed images 17988ef70478SKees Cook is included. 17998ef70478SKees Cook 180017ea1177Swdenk- MII/PHY support: 180117ea1177Swdenk CONFIG_PHY_ADDR 180217ea1177Swdenk 180317ea1177Swdenk The address of PHY on MII bus. 180417ea1177Swdenk 180517ea1177Swdenk CONFIG_PHY_CLOCK_FREQ (ppc4xx) 180617ea1177Swdenk 180717ea1177Swdenk The clock frequency of the MII bus 180817ea1177Swdenk 180917ea1177Swdenk CONFIG_PHY_GIGE 181017ea1177Swdenk 181117ea1177Swdenk If this option is set, support for speed/duplex 181211ccc33fSMarcel Ziswiler detection of gigabit PHY is included. 181317ea1177Swdenk 181417ea1177Swdenk CONFIG_PHY_RESET_DELAY 181517ea1177Swdenk 181617ea1177Swdenk Some PHY like Intel LXT971A need extra delay after 181717ea1177Swdenk reset before any MII register access is possible. 181817ea1177Swdenk For such PHY, set this option to the usec delay 181917ea1177Swdenk required. (minimum 300usec for LXT971A) 182017ea1177Swdenk 182117ea1177Swdenk CONFIG_PHY_CMD_DELAY (ppc4xx) 182217ea1177Swdenk 182317ea1177Swdenk Some PHY like Intel LXT971A need extra delay after 182417ea1177Swdenk command issued before MII status register can be read 182517ea1177Swdenk 1826c609719bSwdenk- Ethernet address: 1827c609719bSwdenk CONFIG_ETHADDR 1828c68a05feSrichardretanubun CONFIG_ETH1ADDR 1829c609719bSwdenk CONFIG_ETH2ADDR 1830c609719bSwdenk CONFIG_ETH3ADDR 1831c68a05feSrichardretanubun CONFIG_ETH4ADDR 1832c68a05feSrichardretanubun CONFIG_ETH5ADDR 1833c609719bSwdenk 183411ccc33fSMarcel Ziswiler Define a default value for Ethernet address to use 183511ccc33fSMarcel Ziswiler for the respective Ethernet interface, in case this 1836c609719bSwdenk is not determined automatically. 1837c609719bSwdenk 1838c609719bSwdenk- IP address: 1839c609719bSwdenk CONFIG_IPADDR 1840c609719bSwdenk 1841c609719bSwdenk Define a default value for the IP address to use for 184211ccc33fSMarcel Ziswiler the default Ethernet interface, in case this is not 1843c609719bSwdenk determined through e.g. bootp. 18441ebcd654SWolfgang Denk (Environment variable "ipaddr") 1845c609719bSwdenk 1846c609719bSwdenk- Server IP address: 1847c609719bSwdenk CONFIG_SERVERIP 1848c609719bSwdenk 1849c609719bSwdenk Defines a default value for the IP address of a TFTP 1850c609719bSwdenk server to contact when using the "tftboot" command. 18511ebcd654SWolfgang Denk (Environment variable "serverip") 1852c609719bSwdenk 185397cfe861SRobin Getz CONFIG_KEEP_SERVERADDR 185497cfe861SRobin Getz 185597cfe861SRobin Getz Keeps the server's MAC address, in the env 'serveraddr' 185697cfe861SRobin Getz for passing to bootargs (like Linux's netconsole option) 185797cfe861SRobin Getz 18581ebcd654SWolfgang Denk- Gateway IP address: 18591ebcd654SWolfgang Denk CONFIG_GATEWAYIP 18601ebcd654SWolfgang Denk 18611ebcd654SWolfgang Denk Defines a default value for the IP address of the 18621ebcd654SWolfgang Denk default router where packets to other networks are 18631ebcd654SWolfgang Denk sent to. 18641ebcd654SWolfgang Denk (Environment variable "gatewayip") 18651ebcd654SWolfgang Denk 18661ebcd654SWolfgang Denk- Subnet mask: 18671ebcd654SWolfgang Denk CONFIG_NETMASK 18681ebcd654SWolfgang Denk 18691ebcd654SWolfgang Denk Defines a default value for the subnet mask (or 18701ebcd654SWolfgang Denk routing prefix) which is used to determine if an IP 18711ebcd654SWolfgang Denk address belongs to the local subnet or needs to be 18721ebcd654SWolfgang Denk forwarded through a router. 18731ebcd654SWolfgang Denk (Environment variable "netmask") 18741ebcd654SWolfgang Denk 187553a5c424SDavid Updegraff- Multicast TFTP Mode: 187653a5c424SDavid Updegraff CONFIG_MCAST_TFTP 187753a5c424SDavid Updegraff 187853a5c424SDavid Updegraff Defines whether you want to support multicast TFTP as per 187953a5c424SDavid Updegraff rfc-2090; for example to work with atftp. Lets lots of targets 188011ccc33fSMarcel Ziswiler tftp down the same boot image concurrently. Note: the Ethernet 188153a5c424SDavid Updegraff driver in use must provide a function: mcast() to join/leave a 188253a5c424SDavid Updegraff multicast group. 188353a5c424SDavid Updegraff 1884c609719bSwdenk- BOOTP Recovery Mode: 1885c609719bSwdenk CONFIG_BOOTP_RANDOM_DELAY 1886c609719bSwdenk 1887c609719bSwdenk If you have many targets in a network that try to 1888c609719bSwdenk boot using BOOTP, you may want to avoid that all 1889c609719bSwdenk systems send out BOOTP requests at precisely the same 1890c609719bSwdenk moment (which would happen for instance at recovery 1891c609719bSwdenk from a power failure, when all systems will try to 1892c609719bSwdenk boot, thus flooding the BOOTP server. Defining 1893c609719bSwdenk CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be 1894c609719bSwdenk inserted before sending out BOOTP requests. The 18956c33c785SWolfgang Denk following delays are inserted then: 1896c609719bSwdenk 1897c609719bSwdenk 1st BOOTP request: delay 0 ... 1 sec 1898c609719bSwdenk 2nd BOOTP request: delay 0 ... 2 sec 1899c609719bSwdenk 3rd BOOTP request: delay 0 ... 4 sec 1900c609719bSwdenk 4th and following 1901c609719bSwdenk BOOTP requests: delay 0 ... 8 sec 1902c609719bSwdenk 1903fe389a82Sstroese- DHCP Advanced Options: 19041fe80d79SJon Loeliger You can fine tune the DHCP functionality by defining 19051fe80d79SJon Loeliger CONFIG_BOOTP_* symbols: 1906fe389a82Sstroese 19071fe80d79SJon Loeliger CONFIG_BOOTP_SUBNETMASK 19081fe80d79SJon Loeliger CONFIG_BOOTP_GATEWAY 19091fe80d79SJon Loeliger CONFIG_BOOTP_HOSTNAME 19101fe80d79SJon Loeliger CONFIG_BOOTP_NISDOMAIN 19111fe80d79SJon Loeliger CONFIG_BOOTP_BOOTPATH 19121fe80d79SJon Loeliger CONFIG_BOOTP_BOOTFILESIZE 19131fe80d79SJon Loeliger CONFIG_BOOTP_DNS 19141fe80d79SJon Loeliger CONFIG_BOOTP_DNS2 19151fe80d79SJon Loeliger CONFIG_BOOTP_SEND_HOSTNAME 19161fe80d79SJon Loeliger CONFIG_BOOTP_NTPSERVER 19171fe80d79SJon Loeliger CONFIG_BOOTP_TIMEOFFSET 19181fe80d79SJon Loeliger CONFIG_BOOTP_VENDOREX 19192c00e099SJoe Hershberger CONFIG_BOOTP_MAY_FAIL 1920fe389a82Sstroese 19215d110f0aSWilson Callan CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip 19225d110f0aSWilson Callan environment variable, not the BOOTP server. 1923fe389a82Sstroese 19242c00e099SJoe Hershberger CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found 19252c00e099SJoe Hershberger after the configured retry count, the call will fail 19262c00e099SJoe Hershberger instead of starting over. This can be used to fail over 19272c00e099SJoe Hershberger to Link-local IP address configuration if the DHCP server 19282c00e099SJoe Hershberger is not available. 19292c00e099SJoe Hershberger 1930fe389a82Sstroese CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS 1931fe389a82Sstroese serverip from a DHCP server, it is possible that more 1932fe389a82Sstroese than one DNS serverip is offered to the client. 1933fe389a82Sstroese If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS 1934fe389a82Sstroese serverip will be stored in the additional environment 1935fe389a82Sstroese variable "dnsip2". The first DNS serverip is always 1936fe389a82Sstroese stored in the variable "dnsip", when CONFIG_BOOTP_DNS 19371fe80d79SJon Loeliger is defined. 1938fe389a82Sstroese 1939fe389a82Sstroese CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable 1940fe389a82Sstroese to do a dynamic update of a DNS server. To do this, they 1941fe389a82Sstroese need the hostname of the DHCP requester. 19425d110f0aSWilson Callan If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content 19431fe80d79SJon Loeliger of the "hostname" environment variable is passed as 19441fe80d79SJon Loeliger option 12 to the DHCP server. 1945fe389a82Sstroese 1946d9a2f416SAras Vaichas CONFIG_BOOTP_DHCP_REQUEST_DELAY 1947d9a2f416SAras Vaichas 1948d9a2f416SAras Vaichas A 32bit value in microseconds for a delay between 1949d9a2f416SAras Vaichas receiving a "DHCP Offer" and sending the "DHCP Request". 1950d9a2f416SAras Vaichas This fixes a problem with certain DHCP servers that don't 1951d9a2f416SAras Vaichas respond 100% of the time to a "DHCP request". E.g. On an 1952d9a2f416SAras Vaichas AT91RM9200 processor running at 180MHz, this delay needed 1953d9a2f416SAras Vaichas to be *at least* 15,000 usec before a Windows Server 2003 1954d9a2f416SAras Vaichas DHCP server would reply 100% of the time. I recommend at 1955d9a2f416SAras Vaichas least 50,000 usec to be safe. The alternative is to hope 1956d9a2f416SAras Vaichas that one of the retries will be successful but note that 1957d9a2f416SAras Vaichas the DHCP timeout and retry process takes a longer than 1958d9a2f416SAras Vaichas this delay. 1959d9a2f416SAras Vaichas 1960d22c338eSJoe Hershberger - Link-local IP address negotiation: 1961d22c338eSJoe Hershberger Negotiate with other link-local clients on the local network 1962d22c338eSJoe Hershberger for an address that doesn't require explicit configuration. 1963d22c338eSJoe Hershberger This is especially useful if a DHCP server cannot be guaranteed 1964d22c338eSJoe Hershberger to exist in all environments that the device must operate. 1965d22c338eSJoe Hershberger 1966d22c338eSJoe Hershberger See doc/README.link-local for more information. 1967d22c338eSJoe Hershberger 1968a3d991bdSwdenk - CDP Options: 1969a3d991bdSwdenk CONFIG_CDP_DEVICE_ID 1970a3d991bdSwdenk 1971a3d991bdSwdenk The device id used in CDP trigger frames. 1972a3d991bdSwdenk 1973a3d991bdSwdenk CONFIG_CDP_DEVICE_ID_PREFIX 1974a3d991bdSwdenk 1975a3d991bdSwdenk A two character string which is prefixed to the MAC address 1976a3d991bdSwdenk of the device. 1977a3d991bdSwdenk 1978a3d991bdSwdenk CONFIG_CDP_PORT_ID 1979a3d991bdSwdenk 1980a3d991bdSwdenk A printf format string which contains the ascii name of 1981a3d991bdSwdenk the port. Normally is set to "eth%d" which sets 198211ccc33fSMarcel Ziswiler eth0 for the first Ethernet, eth1 for the second etc. 1983a3d991bdSwdenk 1984a3d991bdSwdenk CONFIG_CDP_CAPABILITIES 1985a3d991bdSwdenk 1986a3d991bdSwdenk A 32bit integer which indicates the device capabilities; 1987a3d991bdSwdenk 0x00000010 for a normal host which does not forwards. 1988a3d991bdSwdenk 1989a3d991bdSwdenk CONFIG_CDP_VERSION 1990a3d991bdSwdenk 1991a3d991bdSwdenk An ascii string containing the version of the software. 1992a3d991bdSwdenk 1993a3d991bdSwdenk CONFIG_CDP_PLATFORM 1994a3d991bdSwdenk 1995a3d991bdSwdenk An ascii string containing the name of the platform. 1996a3d991bdSwdenk 1997a3d991bdSwdenk CONFIG_CDP_TRIGGER 1998a3d991bdSwdenk 1999a3d991bdSwdenk A 32bit integer sent on the trigger. 2000a3d991bdSwdenk 2001a3d991bdSwdenk CONFIG_CDP_POWER_CONSUMPTION 2002a3d991bdSwdenk 2003a3d991bdSwdenk A 16bit integer containing the power consumption of the 2004a3d991bdSwdenk device in .1 of milliwatts. 2005a3d991bdSwdenk 2006a3d991bdSwdenk CONFIG_CDP_APPLIANCE_VLAN_TYPE 2007a3d991bdSwdenk 2008a3d991bdSwdenk A byte containing the id of the VLAN. 2009a3d991bdSwdenk 2010c609719bSwdenk- Status LED: CONFIG_STATUS_LED 2011c609719bSwdenk 2012c609719bSwdenk Several configurations allow to display the current 2013c609719bSwdenk status using a LED. For instance, the LED will blink 2014c609719bSwdenk fast while running U-Boot code, stop blinking as 2015c609719bSwdenk soon as a reply to a BOOTP request was received, and 2016c609719bSwdenk start blinking slow once the Linux kernel is running 2017c609719bSwdenk (supported by a status LED driver in the Linux 2018c609719bSwdenk kernel). Defining CONFIG_STATUS_LED enables this 2019c609719bSwdenk feature in U-Boot. 2020c609719bSwdenk 20211df7bbbaSIgor Grinberg Additional options: 20221df7bbbaSIgor Grinberg 20231df7bbbaSIgor Grinberg CONFIG_GPIO_LED 20241df7bbbaSIgor Grinberg The status LED can be connected to a GPIO pin. 20251df7bbbaSIgor Grinberg In such cases, the gpio_led driver can be used as a 20261df7bbbaSIgor Grinberg status LED backend implementation. Define CONFIG_GPIO_LED 20271df7bbbaSIgor Grinberg to include the gpio_led driver in the U-Boot binary. 20281df7bbbaSIgor Grinberg 20299dfdcdfeSIgor Grinberg CONFIG_GPIO_LED_INVERTED_TABLE 20309dfdcdfeSIgor Grinberg Some GPIO connected LEDs may have inverted polarity in which 20319dfdcdfeSIgor Grinberg case the GPIO high value corresponds to LED off state and 20329dfdcdfeSIgor Grinberg GPIO low value corresponds to LED on state. 20339dfdcdfeSIgor Grinberg In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined 20349dfdcdfeSIgor Grinberg with a list of GPIO LEDs that have inverted polarity. 20359dfdcdfeSIgor Grinberg 2036c609719bSwdenk- CAN Support: CONFIG_CAN_DRIVER 2037c609719bSwdenk 2038c609719bSwdenk Defining CONFIG_CAN_DRIVER enables CAN driver support 2039c609719bSwdenk on those systems that support this (optional) 2040c609719bSwdenk feature, like the TQM8xxL modules. 2041c609719bSwdenk 20423f4978c7SHeiko Schocher- I2C Support: CONFIG_SYS_I2C 2043c609719bSwdenk 20443f4978c7SHeiko Schocher This enable the NEW i2c subsystem, and will allow you to use 20453f4978c7SHeiko Schocher i2c commands at the u-boot command line (as long as you set 20463f4978c7SHeiko Schocher CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c 20473f4978c7SHeiko Schocher based realtime clock chips or other i2c devices. See 20483f4978c7SHeiko Schocher common/cmd_i2c.c for a description of the command line 20493f4978c7SHeiko Schocher interface. 20503f4978c7SHeiko Schocher 20513f4978c7SHeiko Schocher ported i2c driver to the new framework: 2052ea818dbbSHeiko Schocher - drivers/i2c/soft_i2c.c: 2053ea818dbbSHeiko Schocher - activate first bus with CONFIG_SYS_I2C_SOFT define 2054ea818dbbSHeiko Schocher CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE 2055ea818dbbSHeiko Schocher for defining speed and slave address 2056ea818dbbSHeiko Schocher - activate second bus with I2C_SOFT_DECLARATIONS2 define 2057ea818dbbSHeiko Schocher CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2 2058ea818dbbSHeiko Schocher for defining speed and slave address 2059ea818dbbSHeiko Schocher - activate third bus with I2C_SOFT_DECLARATIONS3 define 2060ea818dbbSHeiko Schocher CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3 2061ea818dbbSHeiko Schocher for defining speed and slave address 2062ea818dbbSHeiko Schocher - activate fourth bus with I2C_SOFT_DECLARATIONS4 define 2063ea818dbbSHeiko Schocher CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4 2064ea818dbbSHeiko Schocher for defining speed and slave address 20653f4978c7SHeiko Schocher 206600f792e0SHeiko Schocher - drivers/i2c/fsl_i2c.c: 206700f792e0SHeiko Schocher - activate i2c driver with CONFIG_SYS_I2C_FSL 206800f792e0SHeiko Schocher define CONFIG_SYS_FSL_I2C_OFFSET for setting the register 206900f792e0SHeiko Schocher offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and 207000f792e0SHeiko Schocher CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first 207100f792e0SHeiko Schocher bus. 207200f792e0SHeiko Schocher - If your board supports a second fsl i2c bus, define 207300f792e0SHeiko Schocher CONFIG_SYS_FSL_I2C2_OFFSET for the register offset 207400f792e0SHeiko Schocher CONFIG_SYS_FSL_I2C2_SPEED for the speed and 207500f792e0SHeiko Schocher CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the 207600f792e0SHeiko Schocher second bus. 207700f792e0SHeiko Schocher 20781f2ba722SSimon Glass - drivers/i2c/tegra_i2c.c: 20791f2ba722SSimon Glass - activate this driver with CONFIG_SYS_I2C_TEGRA 20801f2ba722SSimon Glass - This driver adds 4 i2c buses with a fix speed from 20811f2ba722SSimon Glass 100000 and the slave addr 0! 20821f2ba722SSimon Glass 2083880540deSDirk Eibach - drivers/i2c/ppc4xx_i2c.c 2084880540deSDirk Eibach - activate this driver with CONFIG_SYS_I2C_PPC4XX 2085880540deSDirk Eibach - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0 2086880540deSDirk Eibach - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1 2087880540deSDirk Eibach 2088fac96408Strem - drivers/i2c/i2c_mxc.c 2089fac96408Strem - activate this driver with CONFIG_SYS_I2C_MXC 2090fac96408Strem - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED 2091fac96408Strem - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE 2092fac96408Strem - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED 2093fac96408Strem - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE 2094fac96408Strem - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED 2095fac96408Strem - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE 2096fac96408Strem If thoses defines are not set, default value is 100000 2097fac96408Strem for speed, and 0 for slave. 2098fac96408Strem 20991086bfa9SNobuhiro Iwamatsu - drivers/i2c/rcar_i2c.c: 21001086bfa9SNobuhiro Iwamatsu - activate this driver with CONFIG_SYS_I2C_RCAR 21011086bfa9SNobuhiro Iwamatsu - This driver adds 4 i2c buses 21021086bfa9SNobuhiro Iwamatsu 21031086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0 21041086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0 21051086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1 21061086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1 21071086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2 21081086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2 21091086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3 21101086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3 21111086bfa9SNobuhiro Iwamatsu - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses 21121086bfa9SNobuhiro Iwamatsu 21132035d77dSNobuhiro Iwamatsu - drivers/i2c/sh_i2c.c: 21142035d77dSNobuhiro Iwamatsu - activate this driver with CONFIG_SYS_I2C_SH 21152035d77dSNobuhiro Iwamatsu - This driver adds from 2 to 5 i2c buses 21162035d77dSNobuhiro Iwamatsu 21172035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0 21182035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0 21192035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1 21202035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1 21212035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2 21222035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2 21232035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3 21242035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3 21252035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4 21262035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4 21272035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5 21282035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5 21292035d77dSNobuhiro Iwamatsu - CONFIF_SYS_I2C_SH_NUM_CONTROLLERS for nummber of i2c buses 21302035d77dSNobuhiro Iwamatsu 21316789e84eSHeiko Schocher - drivers/i2c/omap24xx_i2c.c 21326789e84eSHeiko Schocher - activate this driver with CONFIG_SYS_I2C_OMAP24XX 21336789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0 21346789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0 21356789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1 21366789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1 21376789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2 21386789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2 21396789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3 21406789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3 21416789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4 21426789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4 21436789e84eSHeiko Schocher 21440bdffe71SHeiko Schocher - drivers/i2c/zynq_i2c.c 21450bdffe71SHeiko Schocher - activate this driver with CONFIG_SYS_I2C_ZYNQ 21460bdffe71SHeiko Schocher - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting 21470bdffe71SHeiko Schocher - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr 21480bdffe71SHeiko Schocher 2149e717fc6dSNaveen Krishna Ch - drivers/i2c/s3c24x0_i2c.c: 2150e717fc6dSNaveen Krishna Ch - activate this driver with CONFIG_SYS_I2C_S3C24X0 2151e717fc6dSNaveen Krishna Ch - This driver adds i2c buses (11 for Exynos5250, Exynos5420 2152e717fc6dSNaveen Krishna Ch 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung) 2153e717fc6dSNaveen Krishna Ch with a fix speed from 100000 and the slave addr 0! 2154e717fc6dSNaveen Krishna Ch 21553f4978c7SHeiko Schocher additional defines: 21563f4978c7SHeiko Schocher 21573f4978c7SHeiko Schocher CONFIG_SYS_NUM_I2C_BUSES 21583f4978c7SHeiko Schocher Hold the number of i2c busses you want to use. If you 21593f4978c7SHeiko Schocher don't use/have i2c muxes on your i2c bus, this 21603f4978c7SHeiko Schocher is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can 21613f4978c7SHeiko Schocher omit this define. 21623f4978c7SHeiko Schocher 21633f4978c7SHeiko Schocher CONFIG_SYS_I2C_DIRECT_BUS 21643f4978c7SHeiko Schocher define this, if you don't use i2c muxes on your hardware. 21653f4978c7SHeiko Schocher if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can 21663f4978c7SHeiko Schocher omit this define. 21673f4978c7SHeiko Schocher 21683f4978c7SHeiko Schocher CONFIG_SYS_I2C_MAX_HOPS 21693f4978c7SHeiko Schocher define how many muxes are maximal consecutively connected 21703f4978c7SHeiko Schocher on one i2c bus. If you not use i2c muxes, omit this 21713f4978c7SHeiko Schocher define. 21723f4978c7SHeiko Schocher 21733f4978c7SHeiko Schocher CONFIG_SYS_I2C_BUSES 21743f4978c7SHeiko Schocher hold a list of busses you want to use, only used if 21753f4978c7SHeiko Schocher CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example 21763f4978c7SHeiko Schocher a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and 21773f4978c7SHeiko Schocher CONFIG_SYS_NUM_I2C_BUSES = 9: 21783f4978c7SHeiko Schocher 21793f4978c7SHeiko Schocher CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \ 21803f4978c7SHeiko Schocher {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \ 21813f4978c7SHeiko Schocher {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \ 21823f4978c7SHeiko Schocher {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \ 21833f4978c7SHeiko Schocher {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \ 21843f4978c7SHeiko Schocher {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \ 21853f4978c7SHeiko Schocher {1, {I2C_NULL_HOP}}, \ 21863f4978c7SHeiko Schocher {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \ 21873f4978c7SHeiko Schocher {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \ 21883f4978c7SHeiko Schocher } 21893f4978c7SHeiko Schocher 21903f4978c7SHeiko Schocher which defines 21913f4978c7SHeiko Schocher bus 0 on adapter 0 without a mux 2192ea818dbbSHeiko Schocher bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1 2193ea818dbbSHeiko Schocher bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2 2194ea818dbbSHeiko Schocher bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3 2195ea818dbbSHeiko Schocher bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4 2196ea818dbbSHeiko Schocher bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5 21973f4978c7SHeiko Schocher bus 6 on adapter 1 without a mux 2198ea818dbbSHeiko Schocher bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1 2199ea818dbbSHeiko Schocher bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2 22003f4978c7SHeiko Schocher 22013f4978c7SHeiko Schocher If you do not have i2c muxes on your board, omit this define. 22023f4978c7SHeiko Schocher 2203ea818dbbSHeiko Schocher- Legacy I2C Support: CONFIG_HARD_I2C 22043f4978c7SHeiko Schocher 22053f4978c7SHeiko Schocher NOTE: It is intended to move drivers to CONFIG_SYS_I2C which 22063f4978c7SHeiko Schocher provides the following compelling advantages: 22073f4978c7SHeiko Schocher 22083f4978c7SHeiko Schocher - more than one i2c adapter is usable 22093f4978c7SHeiko Schocher - approved multibus support 22103f4978c7SHeiko Schocher - better i2c mux support 22113f4978c7SHeiko Schocher 22123f4978c7SHeiko Schocher ** Please consider updating your I2C driver now. ** 22133f4978c7SHeiko Schocher 2214ea818dbbSHeiko Schocher These enable legacy I2C serial bus commands. Defining 2215ea818dbbSHeiko Schocher CONFIG_HARD_I2C will include the appropriate I2C driver 2216ea818dbbSHeiko Schocher for the selected CPU. 2217c609719bSwdenk 2218b37c7e5eSwdenk This will allow you to use i2c commands at the u-boot 2219602ad3b3SJon Loeliger command line (as long as you set CONFIG_CMD_I2C in 2220b37c7e5eSwdenk CONFIG_COMMANDS) and communicate with i2c based realtime 2221b37c7e5eSwdenk clock chips. See common/cmd_i2c.c for a description of the 2222c609719bSwdenk command line interface. 2223c609719bSwdenk 2224bb99ad6dSBen Warren CONFIG_HARD_I2C selects a hardware I2C controller. 2225c609719bSwdenk 2226b37c7e5eSwdenk There are several other quantities that must also be 2227ea818dbbSHeiko Schocher defined when you define CONFIG_HARD_I2C. 2228c609719bSwdenk 22296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD In both cases you will need to define CONFIG_SYS_I2C_SPEED 2230b37c7e5eSwdenk to be the frequency (in Hz) at which you wish your i2c bus 22316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie 223211ccc33fSMarcel Ziswiler the CPU's i2c node address). 2233c609719bSwdenk 22348d321b81SPeter Tyser Now, the u-boot i2c code for the mpc8xx 2235a47a12beSStefan Roese (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node 22368d321b81SPeter Tyser and so its address should therefore be cleared to 0 (See, 22378d321b81SPeter Tyser eg, MPC823e User's Manual p.16-473). So, set 22388d321b81SPeter Tyser CONFIG_SYS_I2C_SLAVE to 0. 2239b37c7e5eSwdenk 22405da71efaSEric Millbrandt CONFIG_SYS_I2C_INIT_MPC5XXX 22415da71efaSEric Millbrandt 22425da71efaSEric Millbrandt When a board is reset during an i2c bus transfer 22435da71efaSEric Millbrandt chips might think that the current transfer is still 22445da71efaSEric Millbrandt in progress. Reset the slave devices by sending start 22455da71efaSEric Millbrandt commands until the slave device responds. 22465da71efaSEric Millbrandt 2247b37c7e5eSwdenk That's all that's required for CONFIG_HARD_I2C. 2248b37c7e5eSwdenk 2249ea818dbbSHeiko Schocher If you use the software i2c interface (CONFIG_SYS_I2C_SOFT) 2250b37c7e5eSwdenk then the following macros need to be defined (examples are 2251b37c7e5eSwdenk from include/configs/lwmon.h): 2252c609719bSwdenk 2253c609719bSwdenk I2C_INIT 2254c609719bSwdenk 2255b37c7e5eSwdenk (Optional). Any commands necessary to enable the I2C 2256c609719bSwdenk controller or configure ports. 2257c609719bSwdenk 2258b37c7e5eSwdenk eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL) 2259b37c7e5eSwdenk 2260c609719bSwdenk I2C_PORT 2261c609719bSwdenk 2262c609719bSwdenk (Only for MPC8260 CPU). The I/O port to use (the code 2263c609719bSwdenk assumes both bits are on the same port). Valid values 2264c609719bSwdenk are 0..3 for ports A..D. 2265c609719bSwdenk 2266c609719bSwdenk I2C_ACTIVE 2267c609719bSwdenk 2268c609719bSwdenk The code necessary to make the I2C data line active 2269c609719bSwdenk (driven). If the data line is open collector, this 2270c609719bSwdenk define can be null. 2271c609719bSwdenk 2272b37c7e5eSwdenk eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA) 2273b37c7e5eSwdenk 2274c609719bSwdenk I2C_TRISTATE 2275c609719bSwdenk 2276c609719bSwdenk The code necessary to make the I2C data line tri-stated 2277c609719bSwdenk (inactive). If the data line is open collector, this 2278c609719bSwdenk define can be null. 2279c609719bSwdenk 2280b37c7e5eSwdenk eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA) 2281b37c7e5eSwdenk 2282c609719bSwdenk I2C_READ 2283c609719bSwdenk 2284472d5460SYork Sun Code that returns true if the I2C data line is high, 2285472d5460SYork Sun false if it is low. 2286c609719bSwdenk 2287b37c7e5eSwdenk eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0) 2288b37c7e5eSwdenk 2289c609719bSwdenk I2C_SDA(bit) 2290c609719bSwdenk 2291472d5460SYork Sun If <bit> is true, sets the I2C data line high. If it 2292472d5460SYork Sun is false, it clears it (low). 2293c609719bSwdenk 2294b37c7e5eSwdenk eg: #define I2C_SDA(bit) \ 2295b37c7e5eSwdenk if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \ 2296b37c7e5eSwdenk else immr->im_cpm.cp_pbdat &= ~PB_SDA 2297b37c7e5eSwdenk 2298c609719bSwdenk I2C_SCL(bit) 2299c609719bSwdenk 2300472d5460SYork Sun If <bit> is true, sets the I2C clock line high. If it 2301472d5460SYork Sun is false, it clears it (low). 2302c609719bSwdenk 2303b37c7e5eSwdenk eg: #define I2C_SCL(bit) \ 2304b37c7e5eSwdenk if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \ 2305b37c7e5eSwdenk else immr->im_cpm.cp_pbdat &= ~PB_SCL 2306b37c7e5eSwdenk 2307c609719bSwdenk I2C_DELAY 2308c609719bSwdenk 2309c609719bSwdenk This delay is invoked four times per clock cycle so this 2310c609719bSwdenk controls the rate of data transfer. The data rate thus 2311b37c7e5eSwdenk is 1 / (I2C_DELAY * 4). Often defined to be something 2312b37c7e5eSwdenk like: 2313b37c7e5eSwdenk 2314b37c7e5eSwdenk #define I2C_DELAY udelay(2) 2315c609719bSwdenk 2316793b5726SMike Frysinger CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA 2317793b5726SMike Frysinger 2318793b5726SMike Frysinger If your arch supports the generic GPIO framework (asm/gpio.h), 2319793b5726SMike Frysinger then you may alternatively define the two GPIOs that are to be 2320793b5726SMike Frysinger used as SCL / SDA. Any of the previous I2C_xxx macros will 2321793b5726SMike Frysinger have GPIO-based defaults assigned to them as appropriate. 2322793b5726SMike Frysinger 2323793b5726SMike Frysinger You should define these to the GPIO value as given directly to 2324793b5726SMike Frysinger the generic GPIO functions. 2325793b5726SMike Frysinger 23266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_INIT_BOARD 232747cd00faSwdenk 232847cd00faSwdenk When a board is reset during an i2c bus transfer 232947cd00faSwdenk chips might think that the current transfer is still 233047cd00faSwdenk in progress. On some boards it is possible to access 233147cd00faSwdenk the i2c SCLK line directly, either by using the 233247cd00faSwdenk processor pin as a GPIO or by having a second pin 233347cd00faSwdenk connected to the bus. If this option is defined a 233447cd00faSwdenk custom i2c_init_board() routine in boards/xxx/board.c 233547cd00faSwdenk is run early in the boot sequence. 233647cd00faSwdenk 233726a33504SRichard Retanubun CONFIG_SYS_I2C_BOARD_LATE_INIT 233826a33504SRichard Retanubun 233926a33504SRichard Retanubun An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is 234026a33504SRichard Retanubun defined a custom i2c_board_late_init() routine in 234126a33504SRichard Retanubun boards/xxx/board.c is run AFTER the operations in i2c_init() 234226a33504SRichard Retanubun is completed. This callpoint can be used to unreset i2c bus 234326a33504SRichard Retanubun using CPU i2c controller register accesses for CPUs whose i2c 234426a33504SRichard Retanubun controller provide such a method. It is called at the end of 234526a33504SRichard Retanubun i2c_init() to allow i2c_init operations to setup the i2c bus 234626a33504SRichard Retanubun controller on the CPU (e.g. setting bus speed & slave address). 234726a33504SRichard Retanubun 234817ea1177Swdenk CONFIG_I2CFAST (PPC405GP|PPC405EP only) 234917ea1177Swdenk 235017ea1177Swdenk This option enables configuration of bi_iic_fast[] flags 235117ea1177Swdenk in u-boot bd_info structure based on u-boot environment 235217ea1177Swdenk variable "i2cfast". (see also i2cfast) 235317ea1177Swdenk 2354bb99ad6dSBen Warren CONFIG_I2C_MULTI_BUS 2355bb99ad6dSBen Warren 2356bb99ad6dSBen Warren This option allows the use of multiple I2C buses, each of which 2357bb99ad6dSBen Warren must have a controller. At any point in time, only one bus is 2358bb99ad6dSBen Warren active. To switch to a different bus, use the 'i2c dev' command. 2359bb99ad6dSBen Warren Note that bus numbering is zero-based. 2360bb99ad6dSBen Warren 23616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_NOPROBES 2362bb99ad6dSBen Warren 2363bb99ad6dSBen Warren This option specifies a list of I2C devices that will be skipped 23640f89c54bSPeter Tyser when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS 23650f89c54bSPeter Tyser is set, specify a list of bus-device pairs. Otherwise, specify 23660f89c54bSPeter Tyser a 1D array of device addresses 2367bb99ad6dSBen Warren 2368bb99ad6dSBen Warren e.g. 2369bb99ad6dSBen Warren #undef CONFIG_I2C_MULTI_BUS 23706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68} 2371bb99ad6dSBen Warren 2372bb99ad6dSBen Warren will skip addresses 0x50 and 0x68 on a board with one I2C bus 2373bb99ad6dSBen Warren 2374bb99ad6dSBen Warren #define CONFIG_I2C_MULTI_BUS 23756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}} 2376bb99ad6dSBen Warren 2377bb99ad6dSBen Warren will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1 2378bb99ad6dSBen Warren 23796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SPD_BUS_NUM 2380be5e6181STimur Tabi 2381be5e6181STimur Tabi If defined, then this indicates the I2C bus number for DDR SPD. 2382be5e6181STimur Tabi If not defined, then U-Boot assumes that SPD is on I2C bus 0. 2383be5e6181STimur Tabi 23846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_RTC_BUS_NUM 23850dc018ecSStefan Roese 23860dc018ecSStefan Roese If defined, then this indicates the I2C bus number for the RTC. 23870dc018ecSStefan Roese If not defined, then U-Boot assumes that RTC is on I2C bus 0. 23880dc018ecSStefan Roese 23896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_DTT_BUS_NUM 23900dc018ecSStefan Roese 23910dc018ecSStefan Roese If defined, then this indicates the I2C bus number for the DTT. 23920dc018ecSStefan Roese If not defined, then U-Boot assumes that DTT is on I2C bus 0. 23930dc018ecSStefan Roese 23946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_DTT_ADDR: 23959ebbb54fSVictor Gallardo 23969ebbb54fSVictor Gallardo If defined, specifies the I2C address of the DTT device. 23979ebbb54fSVictor Gallardo If not defined, then U-Boot uses predefined value for 23989ebbb54fSVictor Gallardo specified DTT device. 23999ebbb54fSVictor Gallardo 24002ac6985aSAndrew Dyer CONFIG_SOFT_I2C_READ_REPEATED_START 24012ac6985aSAndrew Dyer 24022ac6985aSAndrew Dyer defining this will force the i2c_read() function in 24032ac6985aSAndrew Dyer the soft_i2c driver to perform an I2C repeated start 24042ac6985aSAndrew Dyer between writing the address pointer and reading the 24052ac6985aSAndrew Dyer data. If this define is omitted the default behaviour 24062ac6985aSAndrew Dyer of doing a stop-start sequence will be used. Most I2C 24072ac6985aSAndrew Dyer devices can use either method, but some require one or 24082ac6985aSAndrew Dyer the other. 2409be5e6181STimur Tabi 2410c609719bSwdenk- SPI Support: CONFIG_SPI 2411c609719bSwdenk 2412c609719bSwdenk Enables SPI driver (so far only tested with 2413c609719bSwdenk SPI EEPROM, also an instance works with Crystal A/D and 2414c609719bSwdenk D/As on the SACSng board) 2415c609719bSwdenk 24166639562eSYoshihiro Shimoda CONFIG_SH_SPI 24176639562eSYoshihiro Shimoda 24186639562eSYoshihiro Shimoda Enables the driver for SPI controller on SuperH. Currently 24196639562eSYoshihiro Shimoda only SH7757 is supported. 24206639562eSYoshihiro Shimoda 2421c609719bSwdenk CONFIG_SPI_X 2422c609719bSwdenk 2423c609719bSwdenk Enables extended (16-bit) SPI EEPROM addressing. 2424c609719bSwdenk (symmetrical to CONFIG_I2C_X) 2425c609719bSwdenk 2426c609719bSwdenk CONFIG_SOFT_SPI 2427c609719bSwdenk 2428c609719bSwdenk Enables a software (bit-bang) SPI driver rather than 2429c609719bSwdenk using hardware support. This is a general purpose 2430c609719bSwdenk driver that only requires three general I/O port pins 2431c609719bSwdenk (two outputs, one input) to function. If this is 2432c609719bSwdenk defined, the board configuration must define several 2433c609719bSwdenk SPI configuration items (port pins to use, etc). For 2434c609719bSwdenk an example, see include/configs/sacsng.h. 2435c609719bSwdenk 243604a9e118SBen Warren CONFIG_HARD_SPI 243704a9e118SBen Warren 243804a9e118SBen Warren Enables a hardware SPI driver for general-purpose reads 243904a9e118SBen Warren and writes. As with CONFIG_SOFT_SPI, the board configuration 244004a9e118SBen Warren must define a list of chip-select function pointers. 244104a9e118SBen Warren Currently supported on some MPC8xxx processors. For an 244204a9e118SBen Warren example, see include/configs/mpc8349emds.h. 244304a9e118SBen Warren 244438254f45SGuennadi Liakhovetski CONFIG_MXC_SPI 244538254f45SGuennadi Liakhovetski 244638254f45SGuennadi Liakhovetski Enables the driver for the SPI controllers on i.MX and MXC 24472e3cd1cdSFabio Estevam SoCs. Currently i.MX31/35/51 are supported. 244838254f45SGuennadi Liakhovetski 24490133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA 24500133502eSMatthias Fuchs 24510133502eSMatthias Fuchs Enables FPGA subsystem. 24520133502eSMatthias Fuchs 24530133502eSMatthias Fuchs CONFIG_FPGA_<vendor> 24540133502eSMatthias Fuchs 24550133502eSMatthias Fuchs Enables support for specific chip vendors. 24560133502eSMatthias Fuchs (ALTERA, XILINX) 24570133502eSMatthias Fuchs 24580133502eSMatthias Fuchs CONFIG_FPGA_<family> 24590133502eSMatthias Fuchs 24600133502eSMatthias Fuchs Enables support for FPGA family. 24610133502eSMatthias Fuchs (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX) 24620133502eSMatthias Fuchs 24630133502eSMatthias Fuchs CONFIG_FPGA_COUNT 2464c609719bSwdenk 2465c609719bSwdenk Specify the number of FPGA devices to support. 2466c609719bSwdenk 24676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_PROG_FEEDBACK 2468c609719bSwdenk 2469c609719bSwdenk Enable printing of hash marks during FPGA configuration. 2470c609719bSwdenk 24716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_BUSY 2472c609719bSwdenk 2473c609719bSwdenk Enable checks on FPGA configuration interface busy 2474c609719bSwdenk status by the configuration function. This option 2475c609719bSwdenk will require a board or device specific function to 2476c609719bSwdenk be written. 2477c609719bSwdenk 2478c609719bSwdenk CONFIG_FPGA_DELAY 2479c609719bSwdenk 2480c609719bSwdenk If defined, a function that provides delays in the FPGA 2481c609719bSwdenk configuration driver. 2482c609719bSwdenk 24836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_CTRLC 2484c609719bSwdenk Allow Control-C to interrupt FPGA configuration 2485c609719bSwdenk 24866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_ERROR 2487c609719bSwdenk 2488c609719bSwdenk Check for configuration errors during FPGA bitfile 2489c609719bSwdenk loading. For example, abort during Virtex II 2490c609719bSwdenk configuration if the INIT_B line goes low (which 2491c609719bSwdenk indicated a CRC error). 2492c609719bSwdenk 24936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_INIT 2494c609719bSwdenk 2495c609719bSwdenk Maximum time to wait for the INIT_B line to deassert 2496c609719bSwdenk after PROB_B has been deasserted during a Virtex II 2497c609719bSwdenk FPGA configuration sequence. The default time is 500 249811ccc33fSMarcel Ziswiler ms. 2499c609719bSwdenk 25006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_BUSY 2501c609719bSwdenk 2502c609719bSwdenk Maximum time to wait for BUSY to deassert during 250311ccc33fSMarcel Ziswiler Virtex II FPGA configuration. The default is 5 ms. 2504c609719bSwdenk 25056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_CONFIG 2506c609719bSwdenk 2507c609719bSwdenk Time to wait after FPGA configuration. The default is 250811ccc33fSMarcel Ziswiler 200 ms. 2509c609719bSwdenk 2510c609719bSwdenk- Configuration Management: 2511c609719bSwdenk CONFIG_IDENT_STRING 2512c609719bSwdenk 2513c609719bSwdenk If defined, this string will be added to the U-Boot 2514c609719bSwdenk version information (U_BOOT_VERSION) 2515c609719bSwdenk 2516c609719bSwdenk- Vendor Parameter Protection: 2517c609719bSwdenk 2518c609719bSwdenk U-Boot considers the values of the environment 2519c609719bSwdenk variables "serial#" (Board Serial Number) and 25207152b1d0Swdenk "ethaddr" (Ethernet Address) to be parameters that 2521c609719bSwdenk are set once by the board vendor / manufacturer, and 2522c609719bSwdenk protects these variables from casual modification by 2523c609719bSwdenk the user. Once set, these variables are read-only, 2524c609719bSwdenk and write or delete attempts are rejected. You can 252511ccc33fSMarcel Ziswiler change this behaviour: 2526c609719bSwdenk 2527c609719bSwdenk If CONFIG_ENV_OVERWRITE is #defined in your config 2528c609719bSwdenk file, the write protection for vendor parameters is 252947cd00faSwdenk completely disabled. Anybody can change or delete 2530c609719bSwdenk these parameters. 2531c609719bSwdenk 2532c609719bSwdenk Alternatively, if you #define _both_ CONFIG_ETHADDR 2533c609719bSwdenk _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default 253411ccc33fSMarcel Ziswiler Ethernet address is installed in the environment, 2535c609719bSwdenk which can be changed exactly ONCE by the user. [The 2536c609719bSwdenk serial# is unaffected by this, i. e. it remains 2537c609719bSwdenk read-only.] 2538c609719bSwdenk 25392598090bSJoe Hershberger The same can be accomplished in a more flexible way 25402598090bSJoe Hershberger for any variable by configuring the type of access 25412598090bSJoe Hershberger to allow for those variables in the ".flags" variable 25422598090bSJoe Hershberger or define CONFIG_ENV_FLAGS_LIST_STATIC. 25432598090bSJoe Hershberger 2544c609719bSwdenk- Protected RAM: 2545c609719bSwdenk CONFIG_PRAM 2546c609719bSwdenk 2547c609719bSwdenk Define this variable to enable the reservation of 2548c609719bSwdenk "protected RAM", i. e. RAM which is not overwritten 2549c609719bSwdenk by U-Boot. Define CONFIG_PRAM to hold the number of 2550c609719bSwdenk kB you want to reserve for pRAM. You can overwrite 2551c609719bSwdenk this default value by defining an environment 2552c609719bSwdenk variable "pram" to the number of kB you want to 2553c609719bSwdenk reserve. Note that the board info structure will 2554c609719bSwdenk still show the full amount of RAM. If pRAM is 2555c609719bSwdenk reserved, a new environment variable "mem" will 2556c609719bSwdenk automatically be defined to hold the amount of 2557c609719bSwdenk remaining RAM in a form that can be passed as boot 2558c609719bSwdenk argument to Linux, for instance like that: 2559c609719bSwdenk 2560fe126d8bSWolfgang Denk setenv bootargs ... mem=\${mem} 2561c609719bSwdenk saveenv 2562c609719bSwdenk 2563c609719bSwdenk This way you can tell Linux not to use this memory, 2564c609719bSwdenk either, which results in a memory region that will 2565c609719bSwdenk not be affected by reboots. 2566c609719bSwdenk 2567c609719bSwdenk *WARNING* If your board configuration uses automatic 2568c609719bSwdenk detection of the RAM size, you must make sure that 2569c609719bSwdenk this memory test is non-destructive. So far, the 2570c609719bSwdenk following board configurations are known to be 2571c609719bSwdenk "pRAM-clean": 2572c609719bSwdenk 25731b0757ecSWolfgang Denk IVMS8, IVML24, SPD8xx, TQM8xxL, 25741b0757ecSWolfgang Denk HERMES, IP860, RPXlite, LWMON, 2575544d97e9SWolfgang Denk FLAGADM, TQM8260 2576c609719bSwdenk 257740fef049SGabe Black- Access to physical memory region (> 4GB) 257840fef049SGabe Black Some basic support is provided for operations on memory not 257940fef049SGabe Black normally accessible to U-Boot - e.g. some architectures 258040fef049SGabe Black support access to more than 4GB of memory on 32-bit 258140fef049SGabe Black machines using physical address extension or similar. 258240fef049SGabe Black Define CONFIG_PHYSMEM to access this basic support, which 258340fef049SGabe Black currently only supports clearing the memory. 258440fef049SGabe Black 2585c609719bSwdenk- Error Recovery: 2586c609719bSwdenk CONFIG_PANIC_HANG 2587c609719bSwdenk 2588c609719bSwdenk Define this variable to stop the system in case of a 2589c609719bSwdenk fatal error, so that you have to reset it manually. 2590c609719bSwdenk This is probably NOT a good idea for an embedded 259111ccc33fSMarcel Ziswiler system where you want the system to reboot 2592c609719bSwdenk automatically as fast as possible, but it may be 2593c609719bSwdenk useful during development since you can try to debug 2594c609719bSwdenk the conditions that lead to the situation. 2595c609719bSwdenk 2596c609719bSwdenk CONFIG_NET_RETRY_COUNT 2597c609719bSwdenk 2598c609719bSwdenk This variable defines the number of retries for 2599c609719bSwdenk network operations like ARP, RARP, TFTP, or BOOTP 2600c609719bSwdenk before giving up the operation. If not defined, a 2601c609719bSwdenk default value of 5 is used. 2602c609719bSwdenk 260340cb90eeSGuennadi Liakhovetski CONFIG_ARP_TIMEOUT 260440cb90eeSGuennadi Liakhovetski 260540cb90eeSGuennadi Liakhovetski Timeout waiting for an ARP reply in milliseconds. 260640cb90eeSGuennadi Liakhovetski 260748a3e999STetsuyuki Kobayashi CONFIG_NFS_TIMEOUT 260848a3e999STetsuyuki Kobayashi 260948a3e999STetsuyuki Kobayashi Timeout in milliseconds used in NFS protocol. 261048a3e999STetsuyuki Kobayashi If you encounter "ERROR: Cannot umount" in nfs command, 261148a3e999STetsuyuki Kobayashi try longer timeout such as 261248a3e999STetsuyuki Kobayashi #define CONFIG_NFS_TIMEOUT 10000UL 261348a3e999STetsuyuki Kobayashi 2614c609719bSwdenk- Command Interpreter: 26158078f1a5SWolfgang Denk CONFIG_AUTO_COMPLETE 261604a85b3bSwdenk 261704a85b3bSwdenk Enable auto completion of commands using TAB. 261804a85b3bSwdenk 26198078f1a5SWolfgang Denk Note that this feature has NOT been implemented yet 26208078f1a5SWolfgang Denk for the "hush" shell. 26218078f1a5SWolfgang Denk 26228078f1a5SWolfgang Denk 26236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_HUSH_PARSER 2624c609719bSwdenk 2625c609719bSwdenk Define this variable to enable the "hush" shell (from 2626c609719bSwdenk Busybox) as command line interpreter, thus enabling 2627c609719bSwdenk powerful command line syntax like 2628c609719bSwdenk if...then...else...fi conditionals or `&&' and '||' 2629c609719bSwdenk constructs ("shell scripts"). 2630c609719bSwdenk 2631c609719bSwdenk If undefined, you get the old, much simpler behaviour 2632c609719bSwdenk with a somewhat smaller memory footprint. 2633c609719bSwdenk 2634c609719bSwdenk 26356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PROMPT_HUSH_PS2 2636c609719bSwdenk 2637c609719bSwdenk This defines the secondary prompt string, which is 2638c609719bSwdenk printed when the command interpreter needs more input 2639c609719bSwdenk to complete a command. Usually "> ". 2640c609719bSwdenk 2641c609719bSwdenk Note: 2642c609719bSwdenk 2643c609719bSwdenk In the current implementation, the local variables 2644c609719bSwdenk space and global environment variables space are 2645c609719bSwdenk separated. Local variables are those you define by 26463b57fe0aSwdenk simply typing `name=value'. To access a local 2647c609719bSwdenk variable later on, you have write `$name' or 26483b57fe0aSwdenk `${name}'; to execute the contents of a variable 26493b57fe0aSwdenk directly type `$name' at the command prompt. 2650c609719bSwdenk 2651c609719bSwdenk Global environment variables are those you use 2652c609719bSwdenk setenv/printenv to work with. To run a command stored 2653c609719bSwdenk in such a variable, you need to use the run command, 2654c609719bSwdenk and you must not use the '$' sign to access them. 2655c609719bSwdenk 2656c609719bSwdenk To store commands and special characters in a 2657c609719bSwdenk variable, please use double quotation marks 2658c609719bSwdenk surrounding the whole text of the variable, instead 2659c609719bSwdenk of the backslashes before semicolons and special 2660c609719bSwdenk symbols. 2661c609719bSwdenk 2662aa0c71acSWolfgang Denk- Commandline Editing and History: 2663aa0c71acSWolfgang Denk CONFIG_CMDLINE_EDITING 2664aa0c71acSWolfgang Denk 266511ccc33fSMarcel Ziswiler Enable editing and History functions for interactive 2666aa0c71acSWolfgang Denk commandline input operations 2667aa0c71acSWolfgang Denk 2668a8c7c708Swdenk- Default Environment: 2669c609719bSwdenk CONFIG_EXTRA_ENV_SETTINGS 2670c609719bSwdenk 2671c609719bSwdenk Define this to contain any number of null terminated 2672c609719bSwdenk strings (variable = value pairs) that will be part of 26737152b1d0Swdenk the default environment compiled into the boot image. 26742262cfeeSwdenk 2675c609719bSwdenk For example, place something like this in your 2676c609719bSwdenk board's config file: 2677c609719bSwdenk 2678c609719bSwdenk #define CONFIG_EXTRA_ENV_SETTINGS \ 2679c609719bSwdenk "myvar1=value1\0" \ 2680c609719bSwdenk "myvar2=value2\0" 2681c609719bSwdenk 2682c609719bSwdenk Warning: This method is based on knowledge about the 2683c609719bSwdenk internal format how the environment is stored by the 26842262cfeeSwdenk U-Boot code. This is NOT an official, exported 2685c609719bSwdenk interface! Although it is unlikely that this format 26867152b1d0Swdenk will change soon, there is no guarantee either. 2687c609719bSwdenk You better know what you are doing here. 2688c609719bSwdenk 2689c609719bSwdenk Note: overly (ab)use of the default environment is 2690c609719bSwdenk discouraged. Make sure to check other ways to preset 269174de7aefSWolfgang Denk the environment like the "source" command or the 2692c609719bSwdenk boot command first. 2693c609719bSwdenk 26945e724ca2SStephen Warren CONFIG_ENV_VARS_UBOOT_CONFIG 26955e724ca2SStephen Warren 26965e724ca2SStephen Warren Define this in order to add variables describing the 26975e724ca2SStephen Warren U-Boot build configuration to the default environment. 26985e724ca2SStephen Warren These will be named arch, cpu, board, vendor, and soc. 26995e724ca2SStephen Warren 27005e724ca2SStephen Warren Enabling this option will cause the following to be defined: 27015e724ca2SStephen Warren 27025e724ca2SStephen Warren - CONFIG_SYS_ARCH 27035e724ca2SStephen Warren - CONFIG_SYS_CPU 27045e724ca2SStephen Warren - CONFIG_SYS_BOARD 27055e724ca2SStephen Warren - CONFIG_SYS_VENDOR 27065e724ca2SStephen Warren - CONFIG_SYS_SOC 27075e724ca2SStephen Warren 27087e27f89fSTom Rini CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG 27097e27f89fSTom Rini 27107e27f89fSTom Rini Define this in order to add variables describing certain 27117e27f89fSTom Rini run-time determined information about the hardware to the 27127e27f89fSTom Rini environment. These will be named board_name, board_rev. 27137e27f89fSTom Rini 271406fd8538SSimon Glass CONFIG_DELAY_ENVIRONMENT 271506fd8538SSimon Glass 271606fd8538SSimon Glass Normally the environment is loaded when the board is 271706fd8538SSimon Glass intialised so that it is available to U-Boot. This inhibits 271806fd8538SSimon Glass that so that the environment is not available until 271906fd8538SSimon Glass explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL 272006fd8538SSimon Glass this is instead controlled by the value of 272106fd8538SSimon Glass /config/load-environment. 272206fd8538SSimon Glass 2723a8c7c708Swdenk- DataFlash Support: 27242abbe075Swdenk CONFIG_HAS_DATAFLASH 27252abbe075Swdenk 27262abbe075Swdenk Defining this option enables DataFlash features and 27272abbe075Swdenk allows to read/write in Dataflash via the standard 27282abbe075Swdenk commands cp, md... 27292abbe075Swdenk 2730f61ec45eSEric Nelson- Serial Flash support 2731f61ec45eSEric Nelson CONFIG_CMD_SF 2732f61ec45eSEric Nelson 2733f61ec45eSEric Nelson Defining this option enables SPI flash commands 2734f61ec45eSEric Nelson 'sf probe/read/write/erase/update'. 2735f61ec45eSEric Nelson 2736f61ec45eSEric Nelson Usage requires an initial 'probe' to define the serial 2737f61ec45eSEric Nelson flash parameters, followed by read/write/erase/update 2738f61ec45eSEric Nelson commands. 2739f61ec45eSEric Nelson 2740f61ec45eSEric Nelson The following defaults may be provided by the platform 2741f61ec45eSEric Nelson to handle the common case when only a single serial 2742f61ec45eSEric Nelson flash is present on the system. 2743f61ec45eSEric Nelson 2744f61ec45eSEric Nelson CONFIG_SF_DEFAULT_BUS Bus identifier 2745f61ec45eSEric Nelson CONFIG_SF_DEFAULT_CS Chip-select 2746f61ec45eSEric Nelson CONFIG_SF_DEFAULT_MODE (see include/spi.h) 2747f61ec45eSEric Nelson CONFIG_SF_DEFAULT_SPEED in Hz 2748f61ec45eSEric Nelson 274924007273SSimon Glass CONFIG_CMD_SF_TEST 275024007273SSimon Glass 275124007273SSimon Glass Define this option to include a destructive SPI flash 275224007273SSimon Glass test ('sf test'). 275324007273SSimon Glass 27541dcd6d03SJagannadha Sutradharudu Teki CONFIG_SPI_FLASH_BAR Ban/Extended Addr Reg 27551dcd6d03SJagannadha Sutradharudu Teki 27561dcd6d03SJagannadha Sutradharudu Teki Define this option to use the Bank addr/Extended addr 27571dcd6d03SJagannadha Sutradharudu Teki support on SPI flashes which has size > 16Mbytes. 27581dcd6d03SJagannadha Sutradharudu Teki 27593f85ce27Swdenk- SystemACE Support: 27603f85ce27Swdenk CONFIG_SYSTEMACE 27613f85ce27Swdenk 27623f85ce27Swdenk Adding this option adds support for Xilinx SystemACE 27633f85ce27Swdenk chips attached via some sort of local bus. The address 276411ccc33fSMarcel Ziswiler of the chip must also be defined in the 27656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SYSTEMACE_BASE macro. For example: 27663f85ce27Swdenk 27673f85ce27Swdenk #define CONFIG_SYSTEMACE 27686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000 27693f85ce27Swdenk 27703f85ce27Swdenk When SystemACE support is added, the "ace" device type 27713f85ce27Swdenk becomes available to the fat commands, i.e. fatls. 27723f85ce27Swdenk 2773ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port: 2774ecb0ccd9SWolfgang Denk CONFIG_TFTP_PORT 2775ecb0ccd9SWolfgang Denk 277628cb9375SWolfgang Denk If this is defined, the environment variable tftpsrcp 2777ecb0ccd9SWolfgang Denk is used to supply the TFTP UDP source port value. 277828cb9375SWolfgang Denk If tftpsrcp isn't defined, the normal pseudo-random port 2779ecb0ccd9SWolfgang Denk number generator is used. 2780ecb0ccd9SWolfgang Denk 278128cb9375SWolfgang Denk Also, the environment variable tftpdstp is used to supply 278228cb9375SWolfgang Denk the TFTP UDP destination port value. If tftpdstp isn't 278328cb9375SWolfgang Denk defined, the normal port 69 is used. 278428cb9375SWolfgang Denk 278528cb9375SWolfgang Denk The purpose for tftpsrcp is to allow a TFTP server to 2786ecb0ccd9SWolfgang Denk blindly start the TFTP transfer using the pre-configured 2787ecb0ccd9SWolfgang Denk target IP address and UDP port. This has the effect of 2788ecb0ccd9SWolfgang Denk "punching through" the (Windows XP) firewall, allowing 2789ecb0ccd9SWolfgang Denk the remainder of the TFTP transfer to proceed normally. 2790ecb0ccd9SWolfgang Denk A better solution is to properly configure the firewall, 2791ecb0ccd9SWolfgang Denk but sometimes that is not allowed. 2792ecb0ccd9SWolfgang Denk 2793bf36c5d5SSimon Glass- Hashing support: 2794bf36c5d5SSimon Glass CONFIG_CMD_HASH 2795bf36c5d5SSimon Glass 2796bf36c5d5SSimon Glass This enables a generic 'hash' command which can produce 2797bf36c5d5SSimon Glass hashes / digests from a few algorithms (e.g. SHA1, SHA256). 2798bf36c5d5SSimon Glass 2799bf36c5d5SSimon Glass CONFIG_HASH_VERIFY 2800bf36c5d5SSimon Glass 2801bf36c5d5SSimon Glass Enable the hash verify command (hash -v). This adds to code 2802bf36c5d5SSimon Glass size a little. 2803bf36c5d5SSimon Glass 2804bf36c5d5SSimon Glass CONFIG_SHA1 - support SHA1 hashing 2805bf36c5d5SSimon Glass CONFIG_SHA256 - support SHA256 hashing 2806bf36c5d5SSimon Glass 2807bf36c5d5SSimon Glass Note: There is also a sha1sum command, which should perhaps 2808bf36c5d5SSimon Glass be deprecated in favour of 'hash sha1'. 2809bf36c5d5SSimon Glass 2810a11f1873SRobert Winkler- Freescale i.MX specific commands: 2811a11f1873SRobert Winkler CONFIG_CMD_HDMIDETECT 2812a11f1873SRobert Winkler This enables 'hdmidet' command which returns true if an 2813a11f1873SRobert Winkler HDMI monitor is detected. This command is i.MX 6 specific. 2814a11f1873SRobert Winkler 2815a11f1873SRobert Winkler CONFIG_CMD_BMODE 2816a11f1873SRobert Winkler This enables the 'bmode' (bootmode) command for forcing 2817a11f1873SRobert Winkler a boot from specific media. 2818a11f1873SRobert Winkler 2819a11f1873SRobert Winkler This is useful for forcing the ROM's usb downloader to 2820a11f1873SRobert Winkler activate upon a watchdog reset which is nice when iterating 2821a11f1873SRobert Winkler on U-Boot. Using the reset button or running bmode normal 2822a11f1873SRobert Winkler will set it back to normal. This command currently 2823a11f1873SRobert Winkler supports i.MX53 and i.MX6. 2824a11f1873SRobert Winkler 282519c402afSSimon Glass- Signing support: 282619c402afSSimon Glass CONFIG_RSA 282719c402afSSimon Glass 282819c402afSSimon Glass This enables the RSA algorithm used for FIT image verification 282919c402afSSimon Glass in U-Boot. See doc/uImage/signature for more information. 283019c402afSSimon Glass 283119c402afSSimon Glass The signing part is build into mkimage regardless of this 283219c402afSSimon Glass option. 283319c402afSSimon Glass 283419c402afSSimon Glass 2835a8c7c708Swdenk- Show boot progress: 2836c609719bSwdenk CONFIG_SHOW_BOOT_PROGRESS 2837c609719bSwdenk 2838c609719bSwdenk Defining this option allows to add some board- 2839c609719bSwdenk specific code (calling a user-provided function 2840c609719bSwdenk "show_boot_progress(int)") that enables you to show 2841c609719bSwdenk the system's boot progress on some display (for 2842c609719bSwdenk example, some LED's) on your board. At the moment, 2843c609719bSwdenk the following checkpoints are implemented: 2844c609719bSwdenk 28453a608ca0SSimon Glass- Detailed boot stage timing 28463a608ca0SSimon Glass CONFIG_BOOTSTAGE 28473a608ca0SSimon Glass Define this option to get detailed timing of each stage 28483a608ca0SSimon Glass of the boot process. 28493a608ca0SSimon Glass 28503a608ca0SSimon Glass CONFIG_BOOTSTAGE_USER_COUNT 28513a608ca0SSimon Glass This is the number of available user bootstage records. 28523a608ca0SSimon Glass Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...) 28533a608ca0SSimon Glass a new ID will be allocated from this stash. If you exceed 28543a608ca0SSimon Glass the limit, recording will stop. 28553a608ca0SSimon Glass 28563a608ca0SSimon Glass CONFIG_BOOTSTAGE_REPORT 28573a608ca0SSimon Glass Define this to print a report before boot, similar to this: 28583a608ca0SSimon Glass 28593a608ca0SSimon Glass Timer summary in microseconds: 28603a608ca0SSimon Glass Mark Elapsed Stage 28613a608ca0SSimon Glass 0 0 reset 28623a608ca0SSimon Glass 3,575,678 3,575,678 board_init_f start 28633a608ca0SSimon Glass 3,575,695 17 arch_cpu_init A9 28643a608ca0SSimon Glass 3,575,777 82 arch_cpu_init done 28653a608ca0SSimon Glass 3,659,598 83,821 board_init_r start 28663a608ca0SSimon Glass 3,910,375 250,777 main_loop 28673a608ca0SSimon Glass 29,916,167 26,005,792 bootm_start 28683a608ca0SSimon Glass 30,361,327 445,160 start_kernel 28693a608ca0SSimon Glass 28702eba38cfSSimon Glass CONFIG_CMD_BOOTSTAGE 28712eba38cfSSimon Glass Add a 'bootstage' command which supports printing a report 28722eba38cfSSimon Glass and un/stashing of bootstage data. 28732eba38cfSSimon Glass 287494fd1316SSimon Glass CONFIG_BOOTSTAGE_FDT 287594fd1316SSimon Glass Stash the bootstage information in the FDT. A root 'bootstage' 287694fd1316SSimon Glass node is created with each bootstage id as a child. Each child 287794fd1316SSimon Glass has a 'name' property and either 'mark' containing the 287894fd1316SSimon Glass mark time in microsecond, or 'accum' containing the 287994fd1316SSimon Glass accumulated time for that bootstage id in microseconds. 288094fd1316SSimon Glass For example: 288194fd1316SSimon Glass 288294fd1316SSimon Glass bootstage { 288394fd1316SSimon Glass 154 { 288494fd1316SSimon Glass name = "board_init_f"; 288594fd1316SSimon Glass mark = <3575678>; 288694fd1316SSimon Glass }; 288794fd1316SSimon Glass 170 { 288894fd1316SSimon Glass name = "lcd"; 288994fd1316SSimon Glass accum = <33482>; 289094fd1316SSimon Glass }; 289194fd1316SSimon Glass }; 289294fd1316SSimon Glass 289394fd1316SSimon Glass Code in the Linux kernel can find this in /proc/devicetree. 289494fd1316SSimon Glass 28951372cce2SMarian BalakowiczLegacy uImage format: 28961372cce2SMarian Balakowicz 2897c609719bSwdenk Arg Where When 2898c609719bSwdenk 1 common/cmd_bootm.c before attempting to boot an image 2899c609719bSwdenk -1 common/cmd_bootm.c Image header has bad magic number 2900c609719bSwdenk 2 common/cmd_bootm.c Image header has correct magic number 2901c609719bSwdenk -2 common/cmd_bootm.c Image header has bad checksum 2902c609719bSwdenk 3 common/cmd_bootm.c Image header has correct checksum 2903c609719bSwdenk -3 common/cmd_bootm.c Image data has bad checksum 2904c609719bSwdenk 4 common/cmd_bootm.c Image data has correct checksum 2905c609719bSwdenk -4 common/cmd_bootm.c Image is for unsupported architecture 2906c609719bSwdenk 5 common/cmd_bootm.c Architecture check OK 29071372cce2SMarian Balakowicz -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi) 2908c609719bSwdenk 6 common/cmd_bootm.c Image Type check OK 2909c609719bSwdenk -6 common/cmd_bootm.c gunzip uncompression error 2910c609719bSwdenk -7 common/cmd_bootm.c Unimplemented compression type 2911c609719bSwdenk 7 common/cmd_bootm.c Uncompression OK 29121372cce2SMarian Balakowicz 8 common/cmd_bootm.c No uncompress/copy overwrite error 2913c609719bSwdenk -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX) 29141372cce2SMarian Balakowicz 29151372cce2SMarian Balakowicz 9 common/image.c Start initial ramdisk verification 29161372cce2SMarian Balakowicz -10 common/image.c Ramdisk header has bad magic number 29171372cce2SMarian Balakowicz -11 common/image.c Ramdisk header has bad checksum 29181372cce2SMarian Balakowicz 10 common/image.c Ramdisk header is OK 29191372cce2SMarian Balakowicz -12 common/image.c Ramdisk data has bad checksum 29201372cce2SMarian Balakowicz 11 common/image.c Ramdisk data has correct checksum 29211372cce2SMarian Balakowicz 12 common/image.c Ramdisk verification complete, start loading 292211ccc33fSMarcel Ziswiler -13 common/image.c Wrong Image Type (not PPC Linux ramdisk) 29231372cce2SMarian Balakowicz 13 common/image.c Start multifile image verification 29241372cce2SMarian Balakowicz 14 common/image.c No initial ramdisk, no multifile, continue. 29251372cce2SMarian Balakowicz 2926ea0364f1SPeter Tyser 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS 2927c609719bSwdenk 2928a47a12beSStefan Roese -30 arch/powerpc/lib/board.c Fatal error, hang the system 292963e73c9aSwdenk -31 post/post.c POST test failed, detected by post_output_backlog() 293063e73c9aSwdenk -32 post/post.c POST test failed, detected by post_run_single() 293163e73c9aSwdenk 2932566a494fSHeiko Schocher 34 common/cmd_doc.c before loading a Image from a DOC device 2933566a494fSHeiko Schocher -35 common/cmd_doc.c Bad usage of "doc" command 2934566a494fSHeiko Schocher 35 common/cmd_doc.c correct usage of "doc" command 2935566a494fSHeiko Schocher -36 common/cmd_doc.c No boot device 2936566a494fSHeiko Schocher 36 common/cmd_doc.c correct boot device 2937566a494fSHeiko Schocher -37 common/cmd_doc.c Unknown Chip ID on boot device 2938566a494fSHeiko Schocher 37 common/cmd_doc.c correct chip ID found, device available 2939566a494fSHeiko Schocher -38 common/cmd_doc.c Read Error on boot device 2940566a494fSHeiko Schocher 38 common/cmd_doc.c reading Image header from DOC device OK 2941566a494fSHeiko Schocher -39 common/cmd_doc.c Image header has bad magic number 2942566a494fSHeiko Schocher 39 common/cmd_doc.c Image header has correct magic number 2943566a494fSHeiko Schocher -40 common/cmd_doc.c Error reading Image from DOC device 2944566a494fSHeiko Schocher 40 common/cmd_doc.c Image header has correct magic number 2945566a494fSHeiko Schocher 41 common/cmd_ide.c before loading a Image from a IDE device 2946566a494fSHeiko Schocher -42 common/cmd_ide.c Bad usage of "ide" command 2947566a494fSHeiko Schocher 42 common/cmd_ide.c correct usage of "ide" command 2948566a494fSHeiko Schocher -43 common/cmd_ide.c No boot device 2949566a494fSHeiko Schocher 43 common/cmd_ide.c boot device found 2950566a494fSHeiko Schocher -44 common/cmd_ide.c Device not available 2951566a494fSHeiko Schocher 44 common/cmd_ide.c Device available 2952566a494fSHeiko Schocher -45 common/cmd_ide.c wrong partition selected 2953566a494fSHeiko Schocher 45 common/cmd_ide.c partition selected 2954566a494fSHeiko Schocher -46 common/cmd_ide.c Unknown partition table 2955566a494fSHeiko Schocher 46 common/cmd_ide.c valid partition table found 2956566a494fSHeiko Schocher -47 common/cmd_ide.c Invalid partition type 2957566a494fSHeiko Schocher 47 common/cmd_ide.c correct partition type 2958566a494fSHeiko Schocher -48 common/cmd_ide.c Error reading Image Header on boot device 2959566a494fSHeiko Schocher 48 common/cmd_ide.c reading Image Header from IDE device OK 2960566a494fSHeiko Schocher -49 common/cmd_ide.c Image header has bad magic number 2961566a494fSHeiko Schocher 49 common/cmd_ide.c Image header has correct magic number 2962566a494fSHeiko Schocher -50 common/cmd_ide.c Image header has bad checksum 2963566a494fSHeiko Schocher 50 common/cmd_ide.c Image header has correct checksum 2964566a494fSHeiko Schocher -51 common/cmd_ide.c Error reading Image from IDE device 2965566a494fSHeiko Schocher 51 common/cmd_ide.c reading Image from IDE device OK 2966566a494fSHeiko Schocher 52 common/cmd_nand.c before loading a Image from a NAND device 2967566a494fSHeiko Schocher -53 common/cmd_nand.c Bad usage of "nand" command 2968566a494fSHeiko Schocher 53 common/cmd_nand.c correct usage of "nand" command 2969566a494fSHeiko Schocher -54 common/cmd_nand.c No boot device 2970566a494fSHeiko Schocher 54 common/cmd_nand.c boot device found 2971566a494fSHeiko Schocher -55 common/cmd_nand.c Unknown Chip ID on boot device 2972566a494fSHeiko Schocher 55 common/cmd_nand.c correct chip ID found, device available 2973566a494fSHeiko Schocher -56 common/cmd_nand.c Error reading Image Header on boot device 2974566a494fSHeiko Schocher 56 common/cmd_nand.c reading Image Header from NAND device OK 2975566a494fSHeiko Schocher -57 common/cmd_nand.c Image header has bad magic number 2976566a494fSHeiko Schocher 57 common/cmd_nand.c Image header has correct magic number 2977566a494fSHeiko Schocher -58 common/cmd_nand.c Error reading Image from NAND device 2978566a494fSHeiko Schocher 58 common/cmd_nand.c reading Image from NAND device OK 2979c609719bSwdenk 2980566a494fSHeiko Schocher -60 common/env_common.c Environment has a bad CRC, using default 2981c609719bSwdenk 2982566a494fSHeiko Schocher 64 net/eth.c starting with Ethernet configuration. 2983566a494fSHeiko Schocher -64 net/eth.c no Ethernet found. 2984566a494fSHeiko Schocher 65 net/eth.c Ethernet found. 2985206c60cbSwdenk 2986566a494fSHeiko Schocher -80 common/cmd_net.c usage wrong 2987566a494fSHeiko Schocher 80 common/cmd_net.c before calling NetLoop() 298811ccc33fSMarcel Ziswiler -81 common/cmd_net.c some error in NetLoop() occurred 2989566a494fSHeiko Schocher 81 common/cmd_net.c NetLoop() back without error 2990566a494fSHeiko Schocher -82 common/cmd_net.c size == 0 (File with size 0 loaded) 2991566a494fSHeiko Schocher 82 common/cmd_net.c trying automatic boot 299274de7aefSWolfgang Denk 83 common/cmd_net.c running "source" command 299374de7aefSWolfgang Denk -83 common/cmd_net.c some error in automatic boot or "source" command 2994566a494fSHeiko Schocher 84 common/cmd_net.c end without errors 2995c609719bSwdenk 29961372cce2SMarian BalakowiczFIT uImage format: 29971372cce2SMarian Balakowicz 29981372cce2SMarian Balakowicz Arg Where When 29991372cce2SMarian Balakowicz 100 common/cmd_bootm.c Kernel FIT Image has correct format 30001372cce2SMarian Balakowicz -100 common/cmd_bootm.c Kernel FIT Image has incorrect format 30011372cce2SMarian Balakowicz 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration 30021372cce2SMarian Balakowicz -101 common/cmd_bootm.c Can't get configuration for kernel subimage 30031372cce2SMarian Balakowicz 102 common/cmd_bootm.c Kernel unit name specified 30041372cce2SMarian Balakowicz -103 common/cmd_bootm.c Can't get kernel subimage node offset 3005f773bea8SMarian Balakowicz 103 common/cmd_bootm.c Found configuration node 30061372cce2SMarian Balakowicz 104 common/cmd_bootm.c Got kernel subimage node offset 30071372cce2SMarian Balakowicz -104 common/cmd_bootm.c Kernel subimage hash verification failed 30081372cce2SMarian Balakowicz 105 common/cmd_bootm.c Kernel subimage hash verification OK 30091372cce2SMarian Balakowicz -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture 30101372cce2SMarian Balakowicz 106 common/cmd_bootm.c Architecture check OK 301111ccc33fSMarcel Ziswiler -106 common/cmd_bootm.c Kernel subimage has wrong type 301211ccc33fSMarcel Ziswiler 107 common/cmd_bootm.c Kernel subimage type OK 30131372cce2SMarian Balakowicz -107 common/cmd_bootm.c Can't get kernel subimage data/size 30141372cce2SMarian Balakowicz 108 common/cmd_bootm.c Got kernel subimage data/size 30151372cce2SMarian Balakowicz -108 common/cmd_bootm.c Wrong image type (not legacy, FIT) 30161372cce2SMarian Balakowicz -109 common/cmd_bootm.c Can't get kernel subimage type 30171372cce2SMarian Balakowicz -110 common/cmd_bootm.c Can't get kernel subimage comp 30181372cce2SMarian Balakowicz -111 common/cmd_bootm.c Can't get kernel subimage os 30191372cce2SMarian Balakowicz -112 common/cmd_bootm.c Can't get kernel subimage load address 30201372cce2SMarian Balakowicz -113 common/cmd_bootm.c Image uncompress/copy overwrite error 30211372cce2SMarian Balakowicz 30221372cce2SMarian Balakowicz 120 common/image.c Start initial ramdisk verification 30231372cce2SMarian Balakowicz -120 common/image.c Ramdisk FIT image has incorrect format 30241372cce2SMarian Balakowicz 121 common/image.c Ramdisk FIT image has correct format 302511ccc33fSMarcel Ziswiler 122 common/image.c No ramdisk subimage unit name, using configuration 30261372cce2SMarian Balakowicz -122 common/image.c Can't get configuration for ramdisk subimage 30271372cce2SMarian Balakowicz 123 common/image.c Ramdisk unit name specified 30281372cce2SMarian Balakowicz -124 common/image.c Can't get ramdisk subimage node offset 30291372cce2SMarian Balakowicz 125 common/image.c Got ramdisk subimage node offset 30301372cce2SMarian Balakowicz -125 common/image.c Ramdisk subimage hash verification failed 30311372cce2SMarian Balakowicz 126 common/image.c Ramdisk subimage hash verification OK 30321372cce2SMarian Balakowicz -126 common/image.c Ramdisk subimage for unsupported architecture 30331372cce2SMarian Balakowicz 127 common/image.c Architecture check OK 30341372cce2SMarian Balakowicz -127 common/image.c Can't get ramdisk subimage data/size 30351372cce2SMarian Balakowicz 128 common/image.c Got ramdisk subimage data/size 30361372cce2SMarian Balakowicz 129 common/image.c Can't get ramdisk load address 30371372cce2SMarian Balakowicz -129 common/image.c Got ramdisk load address 30381372cce2SMarian Balakowicz 303911ccc33fSMarcel Ziswiler -130 common/cmd_doc.c Incorrect FIT image format 30401372cce2SMarian Balakowicz 131 common/cmd_doc.c FIT image format OK 30411372cce2SMarian Balakowicz 304211ccc33fSMarcel Ziswiler -140 common/cmd_ide.c Incorrect FIT image format 30431372cce2SMarian Balakowicz 141 common/cmd_ide.c FIT image format OK 30441372cce2SMarian Balakowicz 304511ccc33fSMarcel Ziswiler -150 common/cmd_nand.c Incorrect FIT image format 30461372cce2SMarian Balakowicz 151 common/cmd_nand.c FIT image format OK 30471372cce2SMarian Balakowicz 3048d95f6ec7SGabe Black- FIT image support: 3049d95f6ec7SGabe Black CONFIG_FIT 3050d95f6ec7SGabe Black Enable support for the FIT uImage format. 3051d95f6ec7SGabe Black 3052d95f6ec7SGabe Black CONFIG_FIT_BEST_MATCH 3053d95f6ec7SGabe Black When no configuration is explicitly selected, default to the 3054d95f6ec7SGabe Black one whose fdt's compatibility field best matches that of 3055d95f6ec7SGabe Black U-Boot itself. A match is considered "best" if it matches the 3056d95f6ec7SGabe Black most specific compatibility entry of U-Boot's fdt's root node. 3057d95f6ec7SGabe Black The order of entries in the configuration's fdt is ignored. 3058d95f6ec7SGabe Black 30593e569a6bSSimon Glass CONFIG_FIT_SIGNATURE 30603e569a6bSSimon Glass This option enables signature verification of FIT uImages, 30613e569a6bSSimon Glass using a hash signed and verified using RSA. See 30623e569a6bSSimon Glass doc/uImage.FIT/signature.txt for more details. 30633e569a6bSSimon Glass 30644cf2609bSWolfgang Denk- Standalone program support: 30654cf2609bSWolfgang Denk CONFIG_STANDALONE_LOAD_ADDR 30664cf2609bSWolfgang Denk 30676feff899SWolfgang Denk This option defines a board specific value for the 30686feff899SWolfgang Denk address where standalone program gets loaded, thus 30696feff899SWolfgang Denk overwriting the architecture dependent default 30704cf2609bSWolfgang Denk settings. 30714cf2609bSWolfgang Denk 30724cf2609bSWolfgang Denk- Frame Buffer Address: 30734cf2609bSWolfgang Denk CONFIG_FB_ADDR 30744cf2609bSWolfgang Denk 30754cf2609bSWolfgang Denk Define CONFIG_FB_ADDR if you want to use specific 307644a53b57SWolfgang Denk address for frame buffer. This is typically the case 307744a53b57SWolfgang Denk when using a graphics controller has separate video 307844a53b57SWolfgang Denk memory. U-Boot will then place the frame buffer at 307944a53b57SWolfgang Denk the given address instead of dynamically reserving it 308044a53b57SWolfgang Denk in system RAM by calling lcd_setmem(), which grabs 308144a53b57SWolfgang Denk the memory for the frame buffer depending on the 308244a53b57SWolfgang Denk configured panel size. 30834cf2609bSWolfgang Denk 30844cf2609bSWolfgang Denk Please see board_init_f function. 30854cf2609bSWolfgang Denk 3086cccfc2abSDetlev Zundel- Automatic software updates via TFTP server 3087cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP 3088cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP_CNT_MAX 3089cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP_MSEC_MAX 3090cccfc2abSDetlev Zundel 3091cccfc2abSDetlev Zundel These options enable and control the auto-update feature; 3092cccfc2abSDetlev Zundel for a more detailed description refer to doc/README.update. 3093cccfc2abSDetlev Zundel 3094cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support) 3095cccfc2abSDetlev Zundel CONFIG_MTD_DEVICE 3096cccfc2abSDetlev Zundel 3097cccfc2abSDetlev Zundel Adds the MTD device infrastructure from the Linux kernel. 3098cccfc2abSDetlev Zundel Needed for mtdparts command support. 3099cccfc2abSDetlev Zundel 3100cccfc2abSDetlev Zundel CONFIG_MTD_PARTITIONS 3101cccfc2abSDetlev Zundel 3102cccfc2abSDetlev Zundel Adds the MTD partitioning infrastructure from the Linux 3103cccfc2abSDetlev Zundel kernel. Needed for UBI support. 3104cccfc2abSDetlev Zundel 310570c219cdSJoe Hershberger- UBI support 310670c219cdSJoe Hershberger CONFIG_CMD_UBI 310770c219cdSJoe Hershberger 310870c219cdSJoe Hershberger Adds commands for interacting with MTD partitions formatted 310970c219cdSJoe Hershberger with the UBI flash translation layer 311070c219cdSJoe Hershberger 311170c219cdSJoe Hershberger Requires also defining CONFIG_RBTREE 311270c219cdSJoe Hershberger 3113147162daSJoe Hershberger CONFIG_UBI_SILENCE_MSG 3114147162daSJoe Hershberger 3115147162daSJoe Hershberger Make the verbose messages from UBI stop printing. This leaves 3116147162daSJoe Hershberger warnings and errors enabled. 3117147162daSJoe Hershberger 311870c219cdSJoe Hershberger- UBIFS support 311970c219cdSJoe Hershberger CONFIG_CMD_UBIFS 312070c219cdSJoe Hershberger 312170c219cdSJoe Hershberger Adds commands for interacting with UBI volumes formatted as 312270c219cdSJoe Hershberger UBIFS. UBIFS is read-only in u-boot. 312370c219cdSJoe Hershberger 312470c219cdSJoe Hershberger Requires UBI support as well as CONFIG_LZO 312570c219cdSJoe Hershberger 3126147162daSJoe Hershberger CONFIG_UBIFS_SILENCE_MSG 3127147162daSJoe Hershberger 3128147162daSJoe Hershberger Make the verbose messages from UBIFS stop printing. This leaves 3129147162daSJoe Hershberger warnings and errors enabled. 3130147162daSJoe Hershberger 31316a11cf48SDaniel Schwierzeck- SPL framework 31326a11cf48SDaniel Schwierzeck CONFIG_SPL 31336a11cf48SDaniel Schwierzeck Enable building of SPL globally. 31346a11cf48SDaniel Schwierzeck 313595579793STom Rini CONFIG_SPL_LDSCRIPT 313695579793STom Rini LDSCRIPT for linking the SPL binary. 313795579793STom Rini 31386ebc3461SAlbert ARIBAUD CONFIG_SPL_MAX_FOOTPRINT 31396ebc3461SAlbert ARIBAUD Maximum size in memory allocated to the SPL, BSS included. 31406ebc3461SAlbert ARIBAUD When defined, the linker checks that the actual memory 31416ebc3461SAlbert ARIBAUD used by SPL from _start to __bss_end does not exceed it. 31428960af8bSAlbert ARIBAUD CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE 31436ebc3461SAlbert ARIBAUD must not be both defined at the same time. 31446ebc3461SAlbert ARIBAUD 314595579793STom Rini CONFIG_SPL_MAX_SIZE 31466ebc3461SAlbert ARIBAUD Maximum size of the SPL image (text, data, rodata, and 31476ebc3461SAlbert ARIBAUD linker lists sections), BSS excluded. 31486ebc3461SAlbert ARIBAUD When defined, the linker checks that the actual size does 31496ebc3461SAlbert ARIBAUD not exceed it. 315095579793STom Rini 31516a11cf48SDaniel Schwierzeck CONFIG_SPL_TEXT_BASE 31526a11cf48SDaniel Schwierzeck TEXT_BASE for linking the SPL binary. 31536a11cf48SDaniel Schwierzeck 315494a45bb1SScott Wood CONFIG_SPL_RELOC_TEXT_BASE 315594a45bb1SScott Wood Address to relocate to. If unspecified, this is equal to 315694a45bb1SScott Wood CONFIG_SPL_TEXT_BASE (i.e. no relocation is done). 315794a45bb1SScott Wood 315895579793STom Rini CONFIG_SPL_BSS_START_ADDR 315995579793STom Rini Link address for the BSS within the SPL binary. 316095579793STom Rini 316195579793STom Rini CONFIG_SPL_BSS_MAX_SIZE 31626ebc3461SAlbert ARIBAUD Maximum size in memory allocated to the SPL BSS. 31636ebc3461SAlbert ARIBAUD When defined, the linker checks that the actual memory used 31646ebc3461SAlbert ARIBAUD by SPL from __bss_start to __bss_end does not exceed it. 31658960af8bSAlbert ARIBAUD CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE 31666ebc3461SAlbert ARIBAUD must not be both defined at the same time. 316795579793STom Rini 316895579793STom Rini CONFIG_SPL_STACK 316995579793STom Rini Adress of the start of the stack SPL will use 317095579793STom Rini 317194a45bb1SScott Wood CONFIG_SPL_RELOC_STACK 317294a45bb1SScott Wood Adress of the start of the stack SPL will use after 317394a45bb1SScott Wood relocation. If unspecified, this is equal to 317494a45bb1SScott Wood CONFIG_SPL_STACK. 317594a45bb1SScott Wood 317695579793STom Rini CONFIG_SYS_SPL_MALLOC_START 317795579793STom Rini Starting address of the malloc pool used in SPL. 317895579793STom Rini 317995579793STom Rini CONFIG_SYS_SPL_MALLOC_SIZE 318095579793STom Rini The size of the malloc pool used in SPL. 31816a11cf48SDaniel Schwierzeck 318247f7bcaeSTom Rini CONFIG_SPL_FRAMEWORK 318347f7bcaeSTom Rini Enable the SPL framework under common/. This framework 318447f7bcaeSTom Rini supports MMC, NAND and YMODEM loading of U-Boot and NAND 318547f7bcaeSTom Rini NAND loading of the Linux Kernel. 318647f7bcaeSTom Rini 3187861a86f4STom Rini CONFIG_SPL_DISPLAY_PRINT 3188861a86f4STom Rini For ARM, enable an optional function to print more information 3189861a86f4STom Rini about the running system. 3190861a86f4STom Rini 31914b919725SScott Wood CONFIG_SPL_INIT_MINIMAL 31924b919725SScott Wood Arch init code should be built for a very small image 31934b919725SScott Wood 31946a11cf48SDaniel Schwierzeck CONFIG_SPL_LIBCOMMON_SUPPORT 31956a11cf48SDaniel Schwierzeck Support for common/libcommon.o in SPL binary 31966a11cf48SDaniel Schwierzeck 31976a11cf48SDaniel Schwierzeck CONFIG_SPL_LIBDISK_SUPPORT 31986a11cf48SDaniel Schwierzeck Support for disk/libdisk.o in SPL binary 31996a11cf48SDaniel Schwierzeck 32006a11cf48SDaniel Schwierzeck CONFIG_SPL_I2C_SUPPORT 32016a11cf48SDaniel Schwierzeck Support for drivers/i2c/libi2c.o in SPL binary 32026a11cf48SDaniel Schwierzeck 32036a11cf48SDaniel Schwierzeck CONFIG_SPL_GPIO_SUPPORT 32046a11cf48SDaniel Schwierzeck Support for drivers/gpio/libgpio.o in SPL binary 32056a11cf48SDaniel Schwierzeck 32066a11cf48SDaniel Schwierzeck CONFIG_SPL_MMC_SUPPORT 32076a11cf48SDaniel Schwierzeck Support for drivers/mmc/libmmc.o in SPL binary 32086a11cf48SDaniel Schwierzeck 320995579793STom Rini CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR, 321095579793STom Rini CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS, 321195579793STom Rini CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION 321295579793STom Rini Address, size and partition on the MMC to load U-Boot from 321395579793STom Rini when the MMC is being used in raw mode. 321495579793STom Rini 32152b75b0adSPeter Korsgaard CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR 32162b75b0adSPeter Korsgaard Sector to load kernel uImage from when MMC is being 32172b75b0adSPeter Korsgaard used in raw mode (for Falcon mode) 32182b75b0adSPeter Korsgaard 32192b75b0adSPeter Korsgaard CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR, 32202b75b0adSPeter Korsgaard CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS 32212b75b0adSPeter Korsgaard Sector and number of sectors to load kernel argument 32222b75b0adSPeter Korsgaard parameters from when MMC is being used in raw mode 32232b75b0adSPeter Korsgaard (for falcon mode) 32242b75b0adSPeter Korsgaard 322595579793STom Rini CONFIG_SPL_FAT_SUPPORT 322695579793STom Rini Support for fs/fat/libfat.o in SPL binary 322795579793STom Rini 322895579793STom Rini CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME 322995579793STom Rini Filename to read to load U-Boot when reading from FAT 323095579793STom Rini 32317ad2cc79SPeter Korsgaard CONFIG_SPL_FAT_LOAD_KERNEL_NAME 32327ad2cc79SPeter Korsgaard Filename to read to load kernel uImage when reading 32337ad2cc79SPeter Korsgaard from FAT (for Falcon mode) 32347ad2cc79SPeter Korsgaard 32357ad2cc79SPeter Korsgaard CONFIG_SPL_FAT_LOAD_ARGS_NAME 32367ad2cc79SPeter Korsgaard Filename to read to load kernel argument parameters 32377ad2cc79SPeter Korsgaard when reading from FAT (for Falcon mode) 32387ad2cc79SPeter Korsgaard 323906f60ae3SScott Wood CONFIG_SPL_MPC83XX_WAIT_FOR_NAND 324006f60ae3SScott Wood Set this for NAND SPL on PPC mpc83xx targets, so that 324106f60ae3SScott Wood start.S waits for the rest of the SPL to load before 324206f60ae3SScott Wood continuing (the hardware starts execution after just 324306f60ae3SScott Wood loading the first page rather than the full 4K). 324406f60ae3SScott Wood 32456f2f01b9SScott Wood CONFIG_SPL_NAND_BASE 32466f2f01b9SScott Wood Include nand_base.c in the SPL. Requires 32476f2f01b9SScott Wood CONFIG_SPL_NAND_DRIVERS. 32486f2f01b9SScott Wood 32496f2f01b9SScott Wood CONFIG_SPL_NAND_DRIVERS 32506f2f01b9SScott Wood SPL uses normal NAND drivers, not minimal drivers. 32516f2f01b9SScott Wood 32526f2f01b9SScott Wood CONFIG_SPL_NAND_ECC 32536f2f01b9SScott Wood Include standard software ECC in the SPL 32546f2f01b9SScott Wood 325595579793STom Rini CONFIG_SPL_NAND_SIMPLE 32567d4b7955SScott Wood Support for NAND boot using simple NAND drivers that 32577d4b7955SScott Wood expose the cmd_ctrl() interface. 325895579793STom Rini 3259bb0dc108SYing Zhang CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT 3260bb0dc108SYing Zhang Set for the SPL on PPC mpc8xxx targets, support for 32615614e71bSYork Sun drivers/ddr/fsl/libddr.o in SPL binary. 3262bb0dc108SYing Zhang 32637c8eea59SYing Zhang CONFIG_SPL_COMMON_INIT_DDR 32647c8eea59SYing Zhang Set for common ddr init with serial presence detect in 32657c8eea59SYing Zhang SPL binary. 32667c8eea59SYing Zhang 326795579793STom Rini CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT, 326895579793STom Rini CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE, 326995579793STom Rini CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS, 327095579793STom Rini CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE, 327195579793STom Rini CONFIG_SYS_NAND_ECCBYTES 327295579793STom Rini Defines the size and behavior of the NAND that SPL uses 32737d4b7955SScott Wood to read U-Boot 327495579793STom Rini 3275fbe76ae4SPrabhakar Kushwaha CONFIG_SPL_NAND_BOOT 3276fbe76ae4SPrabhakar Kushwaha Add support NAND boot 3277fbe76ae4SPrabhakar Kushwaha 327895579793STom Rini CONFIG_SYS_NAND_U_BOOT_OFFS 32797d4b7955SScott Wood Location in NAND to read U-Boot from 32807d4b7955SScott Wood 32817d4b7955SScott Wood CONFIG_SYS_NAND_U_BOOT_DST 32827d4b7955SScott Wood Location in memory to load U-Boot to 32837d4b7955SScott Wood 32847d4b7955SScott Wood CONFIG_SYS_NAND_U_BOOT_SIZE 32857d4b7955SScott Wood Size of image to load 328695579793STom Rini 328795579793STom Rini CONFIG_SYS_NAND_U_BOOT_START 32887d4b7955SScott Wood Entry point in loaded image to jump to 328995579793STom Rini 329095579793STom Rini CONFIG_SYS_NAND_HW_ECC_OOBFIRST 329195579793STom Rini Define this if you need to first read the OOB and then the 329295579793STom Rini data. This is used for example on davinci plattforms. 329395579793STom Rini 329495579793STom Rini CONFIG_SPL_OMAP3_ID_NAND 329595579793STom Rini Support for an OMAP3-specific set of functions to return the 329695579793STom Rini ID and MFR of the first attached NAND chip, if present. 329795579793STom Rini 32986a11cf48SDaniel Schwierzeck CONFIG_SPL_SERIAL_SUPPORT 32996a11cf48SDaniel Schwierzeck Support for drivers/serial/libserial.o in SPL binary 33006a11cf48SDaniel Schwierzeck 33016a11cf48SDaniel Schwierzeck CONFIG_SPL_SPI_FLASH_SUPPORT 33026a11cf48SDaniel Schwierzeck Support for drivers/mtd/spi/libspi_flash.o in SPL binary 33036a11cf48SDaniel Schwierzeck 33046a11cf48SDaniel Schwierzeck CONFIG_SPL_SPI_SUPPORT 33056a11cf48SDaniel Schwierzeck Support for drivers/spi/libspi.o in SPL binary 33066a11cf48SDaniel Schwierzeck 3307c57b953dSPavel Machek CONFIG_SPL_RAM_DEVICE 3308c57b953dSPavel Machek Support for running image already present in ram, in SPL binary 3309c57b953dSPavel Machek 33106a11cf48SDaniel Schwierzeck CONFIG_SPL_LIBGENERIC_SUPPORT 33116a11cf48SDaniel Schwierzeck Support for lib/libgeneric.o in SPL binary 33121372cce2SMarian Balakowicz 3313ba1bee43SYing Zhang CONFIG_SPL_ENV_SUPPORT 3314ba1bee43SYing Zhang Support for the environment operating in SPL binary 3315ba1bee43SYing Zhang 3316ba1bee43SYing Zhang CONFIG_SPL_NET_SUPPORT 3317ba1bee43SYing Zhang Support for the net/libnet.o in SPL binary. 3318ba1bee43SYing Zhang It conflicts with SPL env from storage medium specified by 3319ba1bee43SYing Zhang CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE 3320ba1bee43SYing Zhang 332174752baaSScott Wood CONFIG_SPL_PAD_TO 33226113d3f2SBenoît Thébaudeau Image offset to which the SPL should be padded before appending 33236113d3f2SBenoît Thébaudeau the SPL payload. By default, this is defined as 33246113d3f2SBenoît Thébaudeau CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined. 33256113d3f2SBenoît Thébaudeau CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL 33266113d3f2SBenoît Thébaudeau payload without any padding, or >= CONFIG_SPL_MAX_SIZE. 332774752baaSScott Wood 3328ca2fca22SScott Wood CONFIG_SPL_TARGET 3329ca2fca22SScott Wood Final target image containing SPL and payload. Some SPLs 3330ca2fca22SScott Wood use an arch-specific makefile fragment instead, for 3331ca2fca22SScott Wood example if more than one image needs to be produced. 3332ca2fca22SScott Wood 333387ebee39SSimon Glass CONFIG_FIT_SPL_PRINT 333487ebee39SSimon Glass Printing information about a FIT image adds quite a bit of 333587ebee39SSimon Glass code to SPL. So this is normally disabled in SPL. Use this 333687ebee39SSimon Glass option to re-enable it. This will affect the output of the 333787ebee39SSimon Glass bootm command when booting a FIT image. 333887ebee39SSimon Glass 33393aa29de0SYing Zhang- TPL framework 33403aa29de0SYing Zhang CONFIG_TPL 33413aa29de0SYing Zhang Enable building of TPL globally. 33423aa29de0SYing Zhang 33433aa29de0SYing Zhang CONFIG_TPL_PAD_TO 33443aa29de0SYing Zhang Image offset to which the TPL should be padded before appending 33453aa29de0SYing Zhang the TPL payload. By default, this is defined as 33463aa29de0SYing Zhang CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined. 33473aa29de0SYing Zhang CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL 33483aa29de0SYing Zhang payload without any padding, or >= CONFIG_SPL_MAX_SIZE. 33493aa29de0SYing Zhang 3350c609719bSwdenkModem Support: 3351c609719bSwdenk-------------- 3352c609719bSwdenk 3353566e5cf4SWolfgang Denk[so far only for SMDK2400 boards] 3354c609719bSwdenk 335511ccc33fSMarcel Ziswiler- Modem support enable: 3356c609719bSwdenk CONFIG_MODEM_SUPPORT 3357c609719bSwdenk 3358c609719bSwdenk- RTS/CTS Flow control enable: 3359c609719bSwdenk CONFIG_HWFLOW 3360c609719bSwdenk 3361c609719bSwdenk- Modem debug support: 3362c609719bSwdenk CONFIG_MODEM_SUPPORT_DEBUG 3363c609719bSwdenk 3364c609719bSwdenk Enables debugging stuff (char screen[1024], dbg()) 3365c609719bSwdenk for modem support. Useful only with BDI2000. 3366c609719bSwdenk 3367a8c7c708Swdenk- Interrupt support (PPC): 3368a8c7c708Swdenk 3369a8c7c708Swdenk There are common interrupt_init() and timer_interrupt() 3370a8c7c708Swdenk for all PPC archs. interrupt_init() calls interrupt_init_cpu() 337111ccc33fSMarcel Ziswiler for CPU specific initialization. interrupt_init_cpu() 3372a8c7c708Swdenk should set decrementer_count to appropriate value. If 337311ccc33fSMarcel Ziswiler CPU resets decrementer automatically after interrupt 3374a8c7c708Swdenk (ppc4xx) it should set decrementer_count to zero. 337511ccc33fSMarcel Ziswiler timer_interrupt() calls timer_interrupt_cpu() for CPU 3376a8c7c708Swdenk specific handling. If board has watchdog / status_led 3377a8c7c708Swdenk / other_activity_monitor it works automatically from 3378a8c7c708Swdenk general timer_interrupt(). 3379a8c7c708Swdenk 3380c609719bSwdenk- General: 3381c609719bSwdenk 3382c609719bSwdenk In the target system modem support is enabled when a 3383c609719bSwdenk specific key (key combination) is pressed during 3384c609719bSwdenk power-on. Otherwise U-Boot will boot normally 338511ccc33fSMarcel Ziswiler (autoboot). The key_pressed() function is called from 3386c609719bSwdenk board_init(). Currently key_pressed() is a dummy 3387c609719bSwdenk function, returning 1 and thus enabling modem 3388c609719bSwdenk initialization. 3389c609719bSwdenk 3390c609719bSwdenk If there are no modem init strings in the 3391c609719bSwdenk environment, U-Boot proceed to autoboot; the 3392c609719bSwdenk previous output (banner, info printfs) will be 339311ccc33fSMarcel Ziswiler suppressed, though. 3394c609719bSwdenk 3395c609719bSwdenk See also: doc/README.Modem 3396c609719bSwdenk 33979660e442SHelmut RaigerBoard initialization settings: 33989660e442SHelmut Raiger------------------------------ 33999660e442SHelmut Raiger 34009660e442SHelmut RaigerDuring Initialization u-boot calls a number of board specific functions 34019660e442SHelmut Raigerto allow the preparation of board specific prerequisites, e.g. pin setup 34029660e442SHelmut Raigerbefore drivers are initialized. To enable these callbacks the 34039660e442SHelmut Raigerfollowing configuration macros have to be defined. Currently this is 34049660e442SHelmut Raigerarchitecture specific, so please check arch/your_architecture/lib/board.c 34059660e442SHelmut Raigertypically in board_init_f() and board_init_r(). 34069660e442SHelmut Raiger 34079660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f() 34089660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r() 34099660e442SHelmut Raiger- CONFIG_BOARD_LATE_INIT: Call board_late_init() 34109660e442SHelmut Raiger- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init() 3411c609719bSwdenk 3412c609719bSwdenkConfiguration Settings: 3413c609719bSwdenk----------------------- 3414c609719bSwdenk 34156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included; 3416c609719bSwdenk undefine this when you're short of memory. 3417c609719bSwdenk 34182fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default 34192fb2604dSPeter Tyser width of the commands listed in the 'help' command output. 34202fb2604dSPeter Tyser 34216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to 3422c609719bSwdenk prompt for user input. 3423c609719bSwdenk 34246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE: Buffer size for input from the Console 3425c609719bSwdenk 34266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE: Buffer size for Console output 3427c609719bSwdenk 34286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands 3429c609719bSwdenk 34306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to 3431c609719bSwdenk the application (usually a Linux kernel) when it is 3432c609719bSwdenk booted 3433c609719bSwdenk 34346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE: 3435c609719bSwdenk List of legal baudrate settings for this board. 3436c609719bSwdenk 34376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET 3438c609719bSwdenk Suppress display of console information at boot. 3439c609719bSwdenk 34406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV 3441c609719bSwdenk If the board specific function 3442c609719bSwdenk extern int overwrite_console (void); 3443c609719bSwdenk returns 1, the stdin, stderr and stdout are switched to the 3444c609719bSwdenk serial port, else the settings in the environment are used. 3445c609719bSwdenk 34466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE 3447c609719bSwdenk Enable the call to overwrite_console(). 3448c609719bSwdenk 34496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE 3450c609719bSwdenk Enable overwrite of previous console environment settings. 3451c609719bSwdenk 34526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END: 3453c609719bSwdenk Begin and End addresses of the area used by the 3454c609719bSwdenk simple memory test. 3455c609719bSwdenk 34566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST: 3457c609719bSwdenk Enable an alternate, more extensive memory test. 3458c609719bSwdenk 34596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH: 34605f535fe1Swdenk Scratch address used by the alternate memory test 34615f535fe1Swdenk You only need to set this if address zero isn't writeable 34625f535fe1Swdenk 34636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only): 34646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header, 346514f73ca6SStefan Roese this specified memory area will get subtracted from the top 346611ccc33fSMarcel Ziswiler (end) of RAM and won't get "touched" at all by U-Boot. By 346714f73ca6SStefan Roese fixing up gd->ram_size the Linux kernel should gets passed 346814f73ca6SStefan Roese the now "corrected" memory size and won't touch it either. 346914f73ca6SStefan Roese This should work for arch/ppc and arch/powerpc. Only Linux 34705e12e75dSStefan Roese board ports in arch/powerpc with bootwrapper support that 347114f73ca6SStefan Roese recalculate the memory size from the SDRAM controller setup 34725e12e75dSStefan Roese will have to get fixed in Linux additionally. 347314f73ca6SStefan Roese 347414f73ca6SStefan Roese This option can be used as a workaround for the 440EPx/GRx 347514f73ca6SStefan Roese CHIP 11 errata where the last 256 bytes in SDRAM shouldn't 347614f73ca6SStefan Roese be touched. 347714f73ca6SStefan Roese 347814f73ca6SStefan Roese WARNING: Please make sure that this value is a multiple of 347914f73ca6SStefan Roese the Linux page size (normally 4k). If this is not the case, 348014f73ca6SStefan Roese then the end address of the Linux memory will be located at a 348114f73ca6SStefan Roese non page size aligned address and this could cause major 348214f73ca6SStefan Roese problems. 348314f73ca6SStefan Roese 34846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE: 3485c609719bSwdenk Enable temporary baudrate change while serial download 3486c609719bSwdenk 34876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE: 3488c609719bSwdenk Physical start address of SDRAM. _Must_ be 0 here. 3489c609719bSwdenk 34906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE: 3491c609719bSwdenk Physical start address of Motherboard I/O (if using a 3492c609719bSwdenk Cogent motherboard) 3493c609719bSwdenk 34946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE: 3495c609719bSwdenk Physical start address of Flash memory. 3496c609719bSwdenk 34976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE: 3498c609719bSwdenk Physical start address of boot monitor code (set by 3499c609719bSwdenk make config files to be same as the text base address 350014d0a02aSWolfgang Denk (CONFIG_SYS_TEXT_BASE) used when linking) - same as 35016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FLASH_BASE when booting from flash. 3502c609719bSwdenk 35036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN: 35043b57fe0aSwdenk Size of memory reserved for monitor code, used to 35053b57fe0aSwdenk determine _at_compile_time_ (!) if the environment is 35063b57fe0aSwdenk embedded within the U-Boot image, or in a separate 35073b57fe0aSwdenk flash sector. 3508c609719bSwdenk 35096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN: 3510c609719bSwdenk Size of DRAM reserved for malloc() use. 3511c609719bSwdenk 35126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN: 351315940c9aSStefan Roese Normally compressed uImages are limited to an 351415940c9aSStefan Roese uncompressed size of 8 MBytes. If this is not enough, 35156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD you can define CONFIG_SYS_BOOTM_LEN in your board config file 351615940c9aSStefan Roese to adjust this setting to your needs. 3517c609719bSwdenk 35186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ: 3519c609719bSwdenk Maximum size of memory mapped by the startup code of 3520c609719bSwdenk the Linux kernel; all data that must be processed by 35217d721e34SBartlomiej Sieka the Linux kernel (bd_info, boot arguments, FDT blob if 35227d721e34SBartlomiej Sieka used) must be put below this limit, unless "bootm_low" 35231bce2aebSRobert P. J. Day environment variable is defined and non-zero. In such case 35247d721e34SBartlomiej Sieka all data for the Linux kernel must be between "bootm_low" 3525c3624e6eSGrant Likely and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment 3526c3624e6eSGrant Likely variable "bootm_mapsize" will override the value of 3527c3624e6eSGrant Likely CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined, 3528c3624e6eSGrant Likely then the value in "bootm_size" will be used instead. 3529c609719bSwdenk 3530fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH: 3531fca43cc8SJohn Rigby Enable initrd_high functionality. If defined then the 3532fca43cc8SJohn Rigby initrd_high feature is enabled and the bootm ramdisk subcommand 3533fca43cc8SJohn Rigby is enabled. 3534fca43cc8SJohn Rigby 3535fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE: 3536fca43cc8SJohn Rigby Enables allocating and saving kernel cmdline in space between 3537fca43cc8SJohn Rigby "bootm_low" and "bootm_low" + BOOTMAPSZ. 3538fca43cc8SJohn Rigby 3539fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD: 3540fca43cc8SJohn Rigby Enables allocating and saving a kernel copy of the bd_info in 3541fca43cc8SJohn Rigby space between "bootm_low" and "bootm_low" + BOOTMAPSZ. 3542fca43cc8SJohn Rigby 35436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS: 3544c609719bSwdenk Max number of Flash memory banks 3545c609719bSwdenk 35466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT: 3547c609719bSwdenk Max number of sectors on a Flash chip 3548c609719bSwdenk 35496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT: 3550c609719bSwdenk Timeout for Flash erase operations (in ms) 3551c609719bSwdenk 35526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT: 3553c609719bSwdenk Timeout for Flash write operations (in ms) 3554c609719bSwdenk 35556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT 35568564acf9Swdenk Timeout for Flash set sector lock bit operation (in ms) 35578564acf9Swdenk 35586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT 35598564acf9Swdenk Timeout for Flash clear lock bits operation (in ms) 35608564acf9Swdenk 35616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION 35628564acf9Swdenk If defined, hardware flash sectors protection is used 35638564acf9Swdenk instead of U-Boot software protection. 35648564acf9Swdenk 35656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP: 3566c609719bSwdenk 3567c609719bSwdenk Enable TFTP transfers directly to flash memory; 3568c609719bSwdenk without this option such a download has to be 3569c609719bSwdenk performed in two steps: (1) download to RAM, and (2) 3570c609719bSwdenk copy from RAM to flash. 3571c609719bSwdenk 3572c609719bSwdenk The two-step approach is usually more reliable, since 3573c609719bSwdenk you can check if the download worked before you erase 357411ccc33fSMarcel Ziswiler the flash, but in some situations (when system RAM is 357511ccc33fSMarcel Ziswiler too limited to allow for a temporary copy of the 3576c609719bSwdenk downloaded image) this option may be very useful. 3577c609719bSwdenk 35786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI: 3579c609719bSwdenk Define if the flash driver uses extra elements in the 35805653fc33Swdenk common flash structure for storing flash geometry. 35815653fc33Swdenk 358200b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER 35835653fc33Swdenk This option also enables the building of the cfi_flash driver 35845653fc33Swdenk in the drivers directory 358553cf9435Sstroese 358691809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD 358791809ed5SPiotr Ziecik This option enables the building of the cfi_mtd driver 358891809ed5SPiotr Ziecik in the drivers directory. The driver exports CFI flash 358991809ed5SPiotr Ziecik to the MTD layer. 359091809ed5SPiotr Ziecik 35916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE 359296ef831fSGuennadi Liakhovetski Use buffered writes to flash. 359396ef831fSGuennadi Liakhovetski 359496ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N 359596ef831fSGuennadi Liakhovetski s29ws-n MirrorBit flash has non-standard addresses for buffered 359696ef831fSGuennadi Liakhovetski write commands. 359796ef831fSGuennadi Liakhovetski 35986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST 35995568e613SStefan Roese If this option is defined, the common CFI flash doesn't 36005568e613SStefan Roese print it's warning upon not recognized FLASH banks. This 36015568e613SStefan Roese is useful, if some of the configured banks are only 36025568e613SStefan Roese optionally available. 36035568e613SStefan Roese 36049a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS 36059a042e9cSJerry Van Baren If defined (must be an integer), print out countdown 36069a042e9cSJerry Van Baren digits and dots. Recommended value: 45 (9..1) for 80 36079a042e9cSJerry Van Baren column displays, 15 (3..1) for 40 column displays. 36089a042e9cSJerry Van Baren 3609352ef3f1SStefan Roese- CONFIG_FLASH_VERIFY 3610352ef3f1SStefan Roese If defined, the content of the flash (destination) is compared 3611352ef3f1SStefan Roese against the source after the write operation. An error message 3612352ef3f1SStefan Roese will be printed when the contents are not identical. 3613352ef3f1SStefan Roese Please note that this option is useless in nearly all cases, 3614352ef3f1SStefan Roese since such flash programming errors usually are detected earlier 3615352ef3f1SStefan Roese while unprotecting/erasing/programming. Please only enable 3616352ef3f1SStefan Roese this option if you really know what you are doing. 3617352ef3f1SStefan Roese 36186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER: 361911ccc33fSMarcel Ziswiler Defines the number of Ethernet receive buffers. On some 362011ccc33fSMarcel Ziswiler Ethernet controllers it is recommended to set this value 362153cf9435Sstroese to 8 or even higher (EEPRO100 or 405 EMAC), since all 362253cf9435Sstroese buffers can be full shortly after enabling the interface 362311ccc33fSMarcel Ziswiler on high Ethernet traffic. 362453cf9435Sstroese Defaults to 4 if not defined. 3625c609719bSwdenk 3626ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES 3627ea882bafSWolfgang Denk 3628ea882bafSWolfgang Denk Maximum number of entries in the hash table that is used 3629ea882bafSWolfgang Denk internally to store the environment settings. The default 3630ea882bafSWolfgang Denk setting is supposed to be generous and should work in most 3631ea882bafSWolfgang Denk cases. This setting can be used to tune behaviour; see 3632ea882bafSWolfgang Denk lib/hashtable.c for details. 3633ea882bafSWolfgang Denk 36342598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_DEFAULT 36352598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_STATIC 36361bce2aebSRobert P. J. Day Enable validation of the values given to environment variables when 36372598090bSJoe Hershberger calling env set. Variables can be restricted to only decimal, 36382598090bSJoe Hershberger hexadecimal, or boolean. If CONFIG_CMD_NET is also defined, 36392598090bSJoe Hershberger the variables can also be restricted to IP address or MAC address. 36402598090bSJoe Hershberger 36412598090bSJoe Hershberger The format of the list is: 36422598090bSJoe Hershberger type_attribute = [s|d|x|b|i|m] 3643267541f7SJoe Hershberger access_atribute = [a|r|o|c] 3644267541f7SJoe Hershberger attributes = type_attribute[access_atribute] 36452598090bSJoe Hershberger entry = variable_name[:attributes] 36462598090bSJoe Hershberger list = entry[,list] 36472598090bSJoe Hershberger 36482598090bSJoe Hershberger The type attributes are: 36492598090bSJoe Hershberger s - String (default) 36502598090bSJoe Hershberger d - Decimal 36512598090bSJoe Hershberger x - Hexadecimal 36522598090bSJoe Hershberger b - Boolean ([1yYtT|0nNfF]) 36532598090bSJoe Hershberger i - IP address 36542598090bSJoe Hershberger m - MAC address 36552598090bSJoe Hershberger 3656267541f7SJoe Hershberger The access attributes are: 3657267541f7SJoe Hershberger a - Any (default) 3658267541f7SJoe Hershberger r - Read-only 3659267541f7SJoe Hershberger o - Write-once 3660267541f7SJoe Hershberger c - Change-default 3661267541f7SJoe Hershberger 36622598090bSJoe Hershberger - CONFIG_ENV_FLAGS_LIST_DEFAULT 36632598090bSJoe Hershberger Define this to a list (string) to define the ".flags" 36642598090bSJoe Hershberger envirnoment variable in the default or embedded environment. 36652598090bSJoe Hershberger 36662598090bSJoe Hershberger - CONFIG_ENV_FLAGS_LIST_STATIC 36672598090bSJoe Hershberger Define this to a list (string) to define validation that 36682598090bSJoe Hershberger should be done if an entry is not found in the ".flags" 36692598090bSJoe Hershberger environment variable. To override a setting in the static 36702598090bSJoe Hershberger list, simply add an entry for the same variable name to the 36712598090bSJoe Hershberger ".flags" variable. 36722598090bSJoe Hershberger 3673267541f7SJoe Hershberger- CONFIG_ENV_ACCESS_IGNORE_FORCE 3674267541f7SJoe Hershberger If defined, don't allow the -f switch to env set override variable 3675267541f7SJoe Hershberger access flags. 3676267541f7SJoe Hershberger 36775c1a7ea6SSimon Glass- CONFIG_SYS_GENERIC_BOARD 36785c1a7ea6SSimon Glass This selects the architecture-generic board system instead of the 36795c1a7ea6SSimon Glass architecture-specific board files. It is intended to move boards 36805c1a7ea6SSimon Glass to this new framework over time. Defining this will disable the 36815c1a7ea6SSimon Glass arch/foo/lib/board.c file and use common/board_f.c and 36825c1a7ea6SSimon Glass common/board_r.c instead. To use this option your architecture 36835c1a7ea6SSimon Glass must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in 36845c1a7ea6SSimon Glass its config.mk file). If you find problems enabling this option on 36855c1a7ea6SSimon Glass your board please report the problem and send patches! 36865c1a7ea6SSimon Glass 3687632efa74SSimon Glass- CONFIG_SYS_SYM_OFFSETS 3688632efa74SSimon Glass This is set by architectures that use offsets for link symbols 3689632efa74SSimon Glass instead of absolute values. So bss_start is obtained using an 3690632efa74SSimon Glass offset _bss_start_ofs from CONFIG_SYS_TEXT_BASE, rather than 3691632efa74SSimon Glass directly. You should not need to touch this setting. 3692632efa74SSimon Glass 36930b1b60c7SLokesh Vutla- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only) 36940b1b60c7SLokesh Vutla This is set by OMAP boards for the max time that reset should 36950b1b60c7SLokesh Vutla be asserted. See doc/README.omap-reset-time for details on how 36960b1b60c7SLokesh Vutla the value can be calulated on a given board. 3697632efa74SSimon Glass 3698c609719bSwdenkThe following definitions that deal with the placement and management 3699c609719bSwdenkof environment data (variable area); in general, we support the 3700c609719bSwdenkfollowing configurations: 3701c609719bSwdenk 3702c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC: 3703c3eb3fe4SMike Frysinger 3704c3eb3fe4SMike Frysinger Builds up envcrc with the target environment so that external utils 3705c3eb3fe4SMike Frysinger may easily extract it and embed it in final U-Boot images. 3706c3eb3fe4SMike Frysinger 37075a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH: 3708c609719bSwdenk 3709c609719bSwdenk Define this if the environment is in flash memory. 3710c609719bSwdenk 3711c609719bSwdenk a) The environment occupies one whole flash sector, which is 3712c609719bSwdenk "embedded" in the text segment with the U-Boot code. This 3713c609719bSwdenk happens usually with "bottom boot sector" or "top boot 3714c609719bSwdenk sector" type flash chips, which have several smaller 3715c609719bSwdenk sectors at the start or the end. For instance, such a 3716c609719bSwdenk layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In 3717c609719bSwdenk such a case you would place the environment in one of the 3718c609719bSwdenk 4 kB sectors - with U-Boot code before and after it. With 3719c609719bSwdenk "top boot sector" type flash chips, you would put the 3720c609719bSwdenk environment in one of the last sectors, leaving a gap 3721c609719bSwdenk between U-Boot and the environment. 3722c609719bSwdenk 37230e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 3724c609719bSwdenk 3725c609719bSwdenk Offset of environment data (variable area) to the 3726c609719bSwdenk beginning of flash memory; for instance, with bottom boot 3727c609719bSwdenk type flash chips the second sector can be used: the offset 3728c609719bSwdenk for this sector is given here. 3729c609719bSwdenk 37306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE. 3731c609719bSwdenk 37320e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 3733c609719bSwdenk 3734c609719bSwdenk This is just another way to specify the start address of 3735c609719bSwdenk the flash sector containing the environment (instead of 37360e8d1586SJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_OFFSET). 3737c609719bSwdenk 37380e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SECT_SIZE: 3739c609719bSwdenk 3740c609719bSwdenk Size of the sector containing the environment. 3741c609719bSwdenk 3742c609719bSwdenk 3743c609719bSwdenk b) Sometimes flash chips have few, equal sized, BIG sectors. 3744c609719bSwdenk In such a case you don't want to spend a whole sector for 3745c609719bSwdenk the environment. 3746c609719bSwdenk 37470e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 3748c609719bSwdenk 37495a1aceb0SJean-Christophe PLAGNIOL-VILLARD If you use this in combination with CONFIG_ENV_IS_IN_FLASH 37500e8d1586SJean-Christophe PLAGNIOL-VILLARD and CONFIG_ENV_SECT_SIZE, you can specify to use only a part 3751c609719bSwdenk of this flash sector for the environment. This saves 3752c609719bSwdenk memory for the RAM copy of the environment. 3753c609719bSwdenk 3754c609719bSwdenk It may also save flash memory if you decide to use this 3755c609719bSwdenk when your environment is "embedded" within U-Boot code, 3756c609719bSwdenk since then the remainder of the flash sector could be used 3757c609719bSwdenk for U-Boot code. It should be pointed out that this is 3758c609719bSwdenk STRONGLY DISCOURAGED from a robustness point of view: 3759c609719bSwdenk updating the environment in flash makes it always 3760c609719bSwdenk necessary to erase the WHOLE sector. If something goes 3761c609719bSwdenk wrong before the contents has been restored from a copy in 3762c609719bSwdenk RAM, your target system will be dead. 3763c609719bSwdenk 37640e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR_REDUND 37650e8d1586SJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_SIZE_REDUND 3766c609719bSwdenk 3767c609719bSwdenk These settings describe a second storage area used to hold 376811ccc33fSMarcel Ziswiler a redundant copy of the environment data, so that there is 37693e38691eSwdenk a valid backup copy in case there is a power failure during 3770c609719bSwdenk a "saveenv" operation. 3771c609719bSwdenk 3772c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the 3773c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds* 3774c609719bSwdenkaccordingly! 3775c609719bSwdenk 3776c609719bSwdenk 37779314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM: 3778c609719bSwdenk 3779c609719bSwdenk Define this if you have some non-volatile memory device 3780c609719bSwdenk (NVRAM, battery buffered SRAM) which you want to use for the 3781c609719bSwdenk environment. 3782c609719bSwdenk 37830e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 37840e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 3785c609719bSwdenk 378611ccc33fSMarcel Ziswiler These two #defines are used to determine the memory area you 3787c609719bSwdenk want to use for environment. It is assumed that this memory 3788c609719bSwdenk can just be read and written to, without any special 3789c609719bSwdenk provision. 3790c609719bSwdenk 3791c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early 3792c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the 379311ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or 3794c609719bSwdenkU-Boot will hang. 3795c609719bSwdenk 3796c609719bSwdenkPlease note that even with NVRAM we still use a copy of the 3797c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to 3798c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv" 3799c609719bSwdenkto save the current settings. 3800c609719bSwdenk 3801c609719bSwdenk 3802bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM: 3803c609719bSwdenk 3804c609719bSwdenk Use this if you have an EEPROM or similar serial access 3805c609719bSwdenk device and a driver for it. 3806c609719bSwdenk 38070e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 38080e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 3809c609719bSwdenk 3810c609719bSwdenk These two #defines specify the offset and size of the 3811c609719bSwdenk environment area within the total memory of your EEPROM. 3812c609719bSwdenk 38136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR: 3814c609719bSwdenk If defined, specified the chip address of the EEPROM device. 3815c609719bSwdenk The default address is zero. 3816c609719bSwdenk 38176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS: 3818c609719bSwdenk If defined, the number of bits used to address bytes in a 3819c609719bSwdenk single page in the EEPROM device. A 64 byte page, for example 3820c609719bSwdenk would require six bits. 3821c609719bSwdenk 38226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS: 3823c609719bSwdenk If defined, the number of milliseconds to delay between 3824c609719bSwdenk page writes. The default is zero milliseconds. 3825c609719bSwdenk 38266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR_LEN: 3827c609719bSwdenk The length in bytes of the EEPROM memory array address. Note 3828c609719bSwdenk that this is NOT the chip address length! 3829c609719bSwdenk 38306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW: 38315cf91d6bSwdenk EEPROM chips that implement "address overflow" are ones 38325cf91d6bSwdenk like Catalyst 24WC04/08/16 which has 9/10/11 bits of 38335cf91d6bSwdenk address and the extra bits end up in the "chip address" bit 38345cf91d6bSwdenk slots. This makes a 24WC08 (1Kbyte) chip look like four 256 38355cf91d6bSwdenk byte chips. 38365cf91d6bSwdenk 38375cf91d6bSwdenk Note that we consider the length of the address field to 38385cf91d6bSwdenk still be one byte because the extra address bits are hidden 38395cf91d6bSwdenk in the chip address. 38405cf91d6bSwdenk 38416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_SIZE: 3842c609719bSwdenk The size in bytes of the EEPROM device. 3843c609719bSwdenk 3844548738b4SHeiko Schocher - CONFIG_ENV_EEPROM_IS_ON_I2C 3845548738b4SHeiko Schocher define this, if you have I2C and SPI activated, and your 3846548738b4SHeiko Schocher EEPROM, which holds the environment, is on the I2C bus. 3847548738b4SHeiko Schocher 3848548738b4SHeiko Schocher - CONFIG_I2C_ENV_EEPROM_BUS 3849548738b4SHeiko Schocher if you have an Environment on an EEPROM reached over 3850548738b4SHeiko Schocher I2C muxes, you can define here, how to reach this 3851548738b4SHeiko Schocher EEPROM. For example: 3852548738b4SHeiko Schocher 3853ea818dbbSHeiko Schocher #define CONFIG_I2C_ENV_EEPROM_BUS 1 3854548738b4SHeiko Schocher 3855548738b4SHeiko Schocher EEPROM which holds the environment, is reached over 3856548738b4SHeiko Schocher a pca9547 i2c mux with address 0x70, channel 3. 3857c609719bSwdenk 3858057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH: 38595779d8d9Swdenk 38605779d8d9Swdenk Define this if you have a DataFlash memory device which you 38615779d8d9Swdenk want to use for the environment. 38625779d8d9Swdenk 38630e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 38640e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 38650e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 38665779d8d9Swdenk 38675779d8d9Swdenk These three #defines specify the offset and size of the 38685779d8d9Swdenk environment area within the total memory of your DataFlash placed 38695779d8d9Swdenk at the specified address. 38705779d8d9Swdenk 38710a85a9e7SLiu Gang- CONFIG_ENV_IS_IN_REMOTE: 38720a85a9e7SLiu Gang 38730a85a9e7SLiu Gang Define this if you have a remote memory space which you 38740a85a9e7SLiu Gang want to use for the local device's environment. 38750a85a9e7SLiu Gang 38760a85a9e7SLiu Gang - CONFIG_ENV_ADDR: 38770a85a9e7SLiu Gang - CONFIG_ENV_SIZE: 38780a85a9e7SLiu Gang 38790a85a9e7SLiu Gang These two #defines specify the address and size of the 38800a85a9e7SLiu Gang environment area within the remote memory space. The 38810a85a9e7SLiu Gang local device can get the environment from remote memory 3882fc54c7faSLiu Gang space by SRIO or PCIE links. 38830a85a9e7SLiu Gang 38840a85a9e7SLiu GangBE CAREFUL! For some special cases, the local device can not use 38850a85a9e7SLiu Gang"saveenv" command. For example, the local device will get the 3886fc54c7faSLiu Gangenvironment stored in a remote NOR flash by SRIO or PCIE link, 3887fc54c7faSLiu Gangbut it can not erase, write this NOR flash by SRIO or PCIE interface. 38880a85a9e7SLiu Gang 388951bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND: 389013a5695bSwdenk 389113a5695bSwdenk Define this if you have a NAND device which you want to use 389213a5695bSwdenk for the environment. 389313a5695bSwdenk 38940e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 38950e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 389613a5695bSwdenk 389713a5695bSwdenk These two #defines specify the offset and size of the environment 3898fdd813deSScott Wood area within the first NAND device. CONFIG_ENV_OFFSET must be 3899fdd813deSScott Wood aligned to an erase block boundary. 39005779d8d9Swdenk 3901fdd813deSScott Wood - CONFIG_ENV_OFFSET_REDUND (optional): 3902e443c944SMarkus Klotzbuecher 39030e8d1586SJean-Christophe PLAGNIOL-VILLARD This setting describes a second storage area of CONFIG_ENV_SIZE 3904fdd813deSScott Wood size used to hold a redundant copy of the environment data, so 3905fdd813deSScott Wood that there is a valid backup copy in case there is a power failure 3906fdd813deSScott Wood during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be 3907fdd813deSScott Wood aligned to an erase block boundary. 3908e443c944SMarkus Klotzbuecher 3909fdd813deSScott Wood - CONFIG_ENV_RANGE (optional): 3910fdd813deSScott Wood 3911fdd813deSScott Wood Specifies the length of the region in which the environment 3912fdd813deSScott Wood can be written. This should be a multiple of the NAND device's 3913fdd813deSScott Wood block size. Specifying a range with more erase blocks than 3914fdd813deSScott Wood are needed to hold CONFIG_ENV_SIZE allows bad blocks within 3915fdd813deSScott Wood the range to be avoided. 3916fdd813deSScott Wood 3917fdd813deSScott Wood - CONFIG_ENV_OFFSET_OOB (optional): 3918fdd813deSScott Wood 3919fdd813deSScott Wood Enables support for dynamically retrieving the offset of the 3920fdd813deSScott Wood environment from block zero's out-of-band data. The 3921fdd813deSScott Wood "nand env.oob" command can be used to record this offset. 3922fdd813deSScott Wood Currently, CONFIG_ENV_OFFSET_REDUND is not supported when 3923fdd813deSScott Wood using CONFIG_ENV_OFFSET_OOB. 3924e443c944SMarkus Klotzbuecher 3925b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST 3926b74ab737SGuennadi Liakhovetski 3927b74ab737SGuennadi Liakhovetski Defines address in RAM to which the nand_spl code should copy the 3928b74ab737SGuennadi Liakhovetski environment. If redundant environment is used, it will be copied to 3929b74ab737SGuennadi Liakhovetski CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE. 3930b74ab737SGuennadi Liakhovetski 39312b74433fSJoe Hershberger- CONFIG_ENV_IS_IN_UBI: 39322b74433fSJoe Hershberger 39332b74433fSJoe Hershberger Define this if you have an UBI volume that you want to use for the 39342b74433fSJoe Hershberger environment. This has the benefit of wear-leveling the environment 39352b74433fSJoe Hershberger accesses, which is important on NAND. 39362b74433fSJoe Hershberger 39372b74433fSJoe Hershberger - CONFIG_ENV_UBI_PART: 39382b74433fSJoe Hershberger 39392b74433fSJoe Hershberger Define this to a string that is the mtd partition containing the UBI. 39402b74433fSJoe Hershberger 39412b74433fSJoe Hershberger - CONFIG_ENV_UBI_VOLUME: 39422b74433fSJoe Hershberger 39432b74433fSJoe Hershberger Define this to the name of the volume that you want to store the 39442b74433fSJoe Hershberger environment in. 39452b74433fSJoe Hershberger 3946785881f7SJoe Hershberger - CONFIG_ENV_UBI_VOLUME_REDUND: 3947785881f7SJoe Hershberger 3948785881f7SJoe Hershberger Define this to the name of another volume to store a second copy of 3949785881f7SJoe Hershberger the environment in. This will enable redundant environments in UBI. 3950785881f7SJoe Hershberger It is assumed that both volumes are in the same MTD partition. 3951785881f7SJoe Hershberger 39522b74433fSJoe Hershberger - CONFIG_UBI_SILENCE_MSG 39532b74433fSJoe Hershberger - CONFIG_UBIFS_SILENCE_MSG 39542b74433fSJoe Hershberger 39552b74433fSJoe Hershberger You will probably want to define these to avoid a really noisy system 39562b74433fSJoe Hershberger when storing the env in UBI. 39572b74433fSJoe Hershberger 395806e4ae5fSStephen Warren- CONFIG_ENV_IS_IN_MMC: 395906e4ae5fSStephen Warren 396006e4ae5fSStephen Warren Define this if you have an MMC device which you want to use for the 396106e4ae5fSStephen Warren environment. 396206e4ae5fSStephen Warren 396306e4ae5fSStephen Warren - CONFIG_SYS_MMC_ENV_DEV: 396406e4ae5fSStephen Warren 396506e4ae5fSStephen Warren Specifies which MMC device the environment is stored in. 396606e4ae5fSStephen Warren 396706e4ae5fSStephen Warren - CONFIG_SYS_MMC_ENV_PART (optional): 396806e4ae5fSStephen Warren 396906e4ae5fSStephen Warren Specifies which MMC partition the environment is stored in. If not 397006e4ae5fSStephen Warren set, defaults to partition 0, the user area. Common values might be 397106e4ae5fSStephen Warren 1 (first MMC boot partition), 2 (second MMC boot partition). 397206e4ae5fSStephen Warren 397306e4ae5fSStephen Warren - CONFIG_ENV_OFFSET: 397406e4ae5fSStephen Warren - CONFIG_ENV_SIZE: 397506e4ae5fSStephen Warren 397606e4ae5fSStephen Warren These two #defines specify the offset and size of the environment 397706e4ae5fSStephen Warren area within the specified MMC device. 397806e4ae5fSStephen Warren 39795c088ee8SStephen Warren If offset is positive (the usual case), it is treated as relative to 39805c088ee8SStephen Warren the start of the MMC partition. If offset is negative, it is treated 39815c088ee8SStephen Warren as relative to the end of the MMC partition. This can be useful if 39825c088ee8SStephen Warren your board may be fitted with different MMC devices, which have 39835c088ee8SStephen Warren different sizes for the MMC partitions, and you always want the 39845c088ee8SStephen Warren environment placed at the very end of the partition, to leave the 39855c088ee8SStephen Warren maximum possible space before it, to store other data. 39865c088ee8SStephen Warren 398706e4ae5fSStephen Warren These two values are in units of bytes, but must be aligned to an 398806e4ae5fSStephen Warren MMC sector boundary. 398906e4ae5fSStephen Warren 399006e4ae5fSStephen Warren - CONFIG_ENV_OFFSET_REDUND (optional): 399106e4ae5fSStephen Warren 399206e4ae5fSStephen Warren Specifies a second storage area, of CONFIG_ENV_SIZE size, used to 399306e4ae5fSStephen Warren hold a redundant copy of the environment data. This provides a 399406e4ae5fSStephen Warren valid backup copy in case the other copy is corrupted, e.g. due 399506e4ae5fSStephen Warren to a power failure during a "saveenv" operation. 399606e4ae5fSStephen Warren 39975c088ee8SStephen Warren This value may also be positive or negative; this is handled in the 39985c088ee8SStephen Warren same way as CONFIG_ENV_OFFSET. 39995c088ee8SStephen Warren 400006e4ae5fSStephen Warren This value is also in units of bytes, but must also be aligned to 400106e4ae5fSStephen Warren an MMC sector boundary. 400206e4ae5fSStephen Warren 400306e4ae5fSStephen Warren - CONFIG_ENV_SIZE_REDUND (optional): 400406e4ae5fSStephen Warren 400506e4ae5fSStephen Warren This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is 400606e4ae5fSStephen Warren set. If this value is set, it must be set to the same value as 400706e4ae5fSStephen Warren CONFIG_ENV_SIZE. 400806e4ae5fSStephen Warren 40096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET 4010c609719bSwdenk 4011c609719bSwdenk Defines offset to the initial SPI buffer area in DPRAM. The 4012c609719bSwdenk area is used at an early stage (ROM part) if the environment 4013c609719bSwdenk is configured to reside in the SPI EEPROM: We need a 520 byte 4014c609719bSwdenk scratch DPRAM area. It is used between the two initialization 4015c609719bSwdenk calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems 4016c609719bSwdenk to be a good choice since it makes it far enough from the 4017c609719bSwdenk start of the data area as well as from the stack pointer. 4018c609719bSwdenk 4019e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor 4020c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been 4021cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f() 4022c609719bSwdenkuntil then to read environment variables. 4023c609719bSwdenk 402485ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor 402585ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working 402685ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is 402785ec0bccSwdenknecessary, because the first environment variable we need is the 402885ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't 402985ec0bccSwdenkhave any device yet where we could complain.] 4030c609719bSwdenk 4031c609719bSwdenkNote: once the monitor has been relocated, then it will complain if 4032c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you 403385ec0bccSwdenkuse the "saveenv" command to store a valid environment. 4034c609719bSwdenk 40356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN: 4036fc3e2165Swdenk Echo the inverted Ethernet link state to the fault LED. 4037fc3e2165Swdenk 40386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR 4039fc3e2165Swdenk also needs to be defined. 4040fc3e2165Swdenk 40416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR: 4042fc3e2165Swdenk MII address of the PHY to check for the Ethernet link state. 4043c609719bSwdenk 4044f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS: 4045f5675aa5SRon Madrid Define this if you desire to only have use of the NS16550_init 4046f5675aa5SRon Madrid and NS16550_putc functions for the serial driver located at 4047f5675aa5SRon Madrid drivers/serial/ns16550.c. This option is useful for saving 4048f5675aa5SRon Madrid space for already greatly restricted images, including but not 4049f5675aa5SRon Madrid limited to NAND_SPL configurations. 4050f5675aa5SRon Madrid 4051b2b92f53SSimon Glass- CONFIG_DISPLAY_BOARDINFO 4052b2b92f53SSimon Glass Display information about the board that U-Boot is running on 4053b2b92f53SSimon Glass when U-Boot starts up. The board function checkboard() is called 4054b2b92f53SSimon Glass to do this. 4055b2b92f53SSimon Glass 4056e2e3e2b1SSimon Glass- CONFIG_DISPLAY_BOARDINFO_LATE 4057e2e3e2b1SSimon Glass Similar to the previous option, but display this information 4058e2e3e2b1SSimon Glass later, once stdio is running and output goes to the LCD, if 4059e2e3e2b1SSimon Glass present. 4060e2e3e2b1SSimon Glass 4061c609719bSwdenkLow Level (hardware related) configuration options: 4062dc7c9a1aSwdenk--------------------------------------------------- 4063c609719bSwdenk 40646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE: 4065c609719bSwdenk Cache Line Size of the CPU. 4066c609719bSwdenk 40676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR: 4068c609719bSwdenk Default address of the IMMR after system reset. 40692535d602Swdenk 40702535d602Swdenk Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU, 40712535d602Swdenk and RPXsuper) to be able to adjust the position of 40722535d602Swdenk the IMMR register after a reset. 4073c609719bSwdenk 4074e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT: 4075e46fedfeSTimur Tabi Default (power-on reset) physical address of CCSR on Freescale 4076e46fedfeSTimur Tabi PowerPC SOCs. 4077e46fedfeSTimur Tabi 4078e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR: 4079e46fedfeSTimur Tabi Virtual address of CCSR. On a 32-bit build, this is typically 4080e46fedfeSTimur Tabi the same value as CONFIG_SYS_CCSRBAR_DEFAULT. 4081e46fedfeSTimur Tabi 4082e46fedfeSTimur Tabi CONFIG_SYS_DEFAULT_IMMR must also be set to this value, 4083e46fedfeSTimur Tabi for cross-platform code that uses that macro instead. 4084e46fedfeSTimur Tabi 4085e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS: 4086e46fedfeSTimur Tabi Physical address of CCSR. CCSR can be relocated to a new 4087e46fedfeSTimur Tabi physical address, if desired. In this case, this macro should 4088e46fedfeSTimur Tabi be set to that address. Otherwise, it should be set to the 4089e46fedfeSTimur Tabi same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR 4090e46fedfeSTimur Tabi is typically relocated on 36-bit builds. It is recommended 4091e46fedfeSTimur Tabi that this macro be defined via the _HIGH and _LOW macros: 4092e46fedfeSTimur Tabi 4093e46fedfeSTimur Tabi #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH 4094e46fedfeSTimur Tabi * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW) 4095e46fedfeSTimur Tabi 4096e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH: 4097e46fedfeSTimur Tabi Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically 4098e46fedfeSTimur Tabi either 0 (32-bit build) or 0xF (36-bit build). This macro is 4099e46fedfeSTimur Tabi used in assembly code, so it must not contain typecasts or 4100e46fedfeSTimur Tabi integer size suffixes (e.g. "ULL"). 4101e46fedfeSTimur Tabi 4102e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW: 4103e46fedfeSTimur Tabi Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is 4104e46fedfeSTimur Tabi used in assembly code, so it must not contain typecasts or 4105e46fedfeSTimur Tabi integer size suffixes (e.g. "ULL"). 4106e46fedfeSTimur Tabi 4107e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE: 4108e46fedfeSTimur Tabi If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be 4109e46fedfeSTimur Tabi forced to a value that ensures that CCSR is not relocated. 4110e46fedfeSTimur Tabi 41117f6c2cbcSwdenk- Floppy Disk Support: 41126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FDC_DRIVE_NUMBER 41137f6c2cbcSwdenk 41147f6c2cbcSwdenk the default drive number (default value 0) 41157f6c2cbcSwdenk 41166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_ISA_IO_STRIDE 41177f6c2cbcSwdenk 411811ccc33fSMarcel Ziswiler defines the spacing between FDC chipset registers 41197f6c2cbcSwdenk (default value 1) 41207f6c2cbcSwdenk 41216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_ISA_IO_OFFSET 41227f6c2cbcSwdenk 41237f6c2cbcSwdenk defines the offset of register from address. It 41247f6c2cbcSwdenk depends on which part of the data bus is connected to 412511ccc33fSMarcel Ziswiler the FDC chipset. (default value 0) 41267f6c2cbcSwdenk 41276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and 41286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their 41297f6c2cbcSwdenk default value. 41307f6c2cbcSwdenk 41316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD if CONFIG_SYS_FDC_HW_INIT is defined, then the function 41327f6c2cbcSwdenk fdc_hw_init() is called at the beginning of the FDC 41337f6c2cbcSwdenk setup. fdc_hw_init() must be provided by the board 41347f6c2cbcSwdenk source code. It is used to make hardware dependant 41357f6c2cbcSwdenk initializations. 41367f6c2cbcSwdenk 41370abddf82SMacpaul Lin- CONFIG_IDE_AHB: 41380abddf82SMacpaul Lin Most IDE controllers were designed to be connected with PCI 41390abddf82SMacpaul Lin interface. Only few of them were designed for AHB interface. 41400abddf82SMacpaul Lin When software is doing ATA command and data transfer to 41410abddf82SMacpaul Lin IDE devices through IDE-AHB controller, some additional 41420abddf82SMacpaul Lin registers accessing to these kind of IDE-AHB controller 41430abddf82SMacpaul Lin is requierd. 41440abddf82SMacpaul Lin 41456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR: Physical address of the Internal Memory. 414625d6712aSwdenk DO NOT CHANGE unless you know exactly what you're 414725d6712aSwdenk doing! (11-4) [MPC8xx/82xx systems only] 4148c609719bSwdenk 41496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR: 4150c609719bSwdenk 41517152b1d0Swdenk Start address of memory area that can be used for 4152c609719bSwdenk initial data and stack; please note that this must be 4153c609719bSwdenk writable memory that is working WITHOUT special 4154c609719bSwdenk initialization, i. e. you CANNOT use normal RAM which 4155c609719bSwdenk will become available only after programming the 4156c609719bSwdenk memory controller and running certain initialization 4157c609719bSwdenk sequences. 4158c609719bSwdenk 4159c609719bSwdenk U-Boot uses the following memory types: 4160c609719bSwdenk - MPC8xx and MPC8260: IMMR (internal memory of the CPU) 4161c609719bSwdenk - MPC824X: data cache 4162c609719bSwdenk - PPC4xx: data cache 4163c609719bSwdenk 41646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET: 4165c609719bSwdenk 4166c609719bSwdenk Offset of the initial data structure in the memory 41676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually 41686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial 4169c609719bSwdenk data is located at the end of the available space 4170553f0982SWolfgang Denk (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE - 41716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just 41726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR + 41736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_GBL_DATA_OFFSET) downward. 4174c609719bSwdenk 4175c609719bSwdenk Note: 4176c609719bSwdenk On the MPC824X (or other systems that use the data 4177c609719bSwdenk cache for initial memory) the address chosen for 41786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must 4179c609719bSwdenk point to an otherwise UNUSED address space between 4180c609719bSwdenk the top of RAM and the start of the PCI space. 4181c609719bSwdenk 41826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6) 4183c609719bSwdenk 41846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR: System Protection Control (11-9) 4185c609719bSwdenk 41866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26) 4187c609719bSwdenk 41886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31) 4189c609719bSwdenk 41906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30) 4191c609719bSwdenk 41926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27) 4193c609719bSwdenk 41946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM: 4195c609719bSwdenk SDRAM timing 4196c609719bSwdenk 41976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA: 4198c609719bSwdenk periodic timer for refresh 4199c609719bSwdenk 42006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER: Debug Event Register (37-47) 4201c609719bSwdenk 42026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM, 42036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP, 42046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM, 42056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BR1_PRELIM: 4206c609719bSwdenk Memory Controller Definitions: BR0/1 and OR0/1 (FLASH) 4207c609719bSwdenk 4208c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE, 42096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM, 42106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM: 4211c609719bSwdenk Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM) 4212c609719bSwdenk 42136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K, 42146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL: 4215c609719bSwdenk Machine Mode Register and Memory Periodic Timer 4216c609719bSwdenk Prescaler definitions (SDRAM timing) 4217c609719bSwdenk 42186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]: 4219c609719bSwdenk enable I2C microcode relocation patch (MPC8xx); 4220c609719bSwdenk define relocation offset in DPRAM [DSP2] 4221c609719bSwdenk 42226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]: 4223b423d055SHeiko Schocher enable SMC microcode relocation patch (MPC8xx); 4224b423d055SHeiko Schocher define relocation offset in DPRAM [SMC1] 4225b423d055SHeiko Schocher 42266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]: 4227c609719bSwdenk enable SPI microcode relocation patch (MPC8xx); 4228c609719bSwdenk define relocation offset in DPRAM [SCC4] 4229c609719bSwdenk 42306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK: 4231c609719bSwdenk Use OSCM clock mode on MBX8xx board. Be careful, 4232c609719bSwdenk wrong setting might damage your board. Read 4233c609719bSwdenk doc/README.MBX before setting this variable! 4234c609719bSwdenk 42356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only) 4236ea909b76Swdenk Offset of the bootmode word in DPRAM used by post 4237ea909b76Swdenk (Power On Self Tests). This definition overrides 4238ea909b76Swdenk #define'd default value in commproc.h resp. 4239ea909b76Swdenk cpm_8260.h. 4240ea909b76Swdenk 42416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB, 42426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL, 42436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS, 42446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB, 42456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START, 42466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL, 42476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE, 42486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only) 4249a47a12beSStefan Roese Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set. 42505d232d0eSwdenk 42519cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE: 42529cacf4fcSDirk Eibach Disable PCI-Express on systems where it is supported but not 42539cacf4fcSDirk Eibach required. 42549cacf4fcSDirk Eibach 425569fd2d3bSAndrew Sharp- CONFIG_PCI_ENUM_ONLY 425669fd2d3bSAndrew Sharp Only scan through and get the devices on the busses. 425769fd2d3bSAndrew Sharp Don't do any setup work, presumably because someone or 425869fd2d3bSAndrew Sharp something has already done it, and we don't need to do it 425969fd2d3bSAndrew Sharp a second time. Useful for platforms that are pre-booted 426069fd2d3bSAndrew Sharp by coreboot or similar. 426169fd2d3bSAndrew Sharp 4262842033e6SGabor Juhos- CONFIG_PCI_INDIRECT_BRIDGE: 4263842033e6SGabor Juhos Enable support for indirect PCI bridges. 4264842033e6SGabor Juhos 4265a09b9b68SKumar Gala- CONFIG_SYS_SRIO: 4266a09b9b68SKumar Gala Chip has SRIO or not 4267a09b9b68SKumar Gala 4268a09b9b68SKumar Gala- CONFIG_SRIO1: 4269a09b9b68SKumar Gala Board has SRIO 1 port available 4270a09b9b68SKumar Gala 4271a09b9b68SKumar Gala- CONFIG_SRIO2: 4272a09b9b68SKumar Gala Board has SRIO 2 port available 4273a09b9b68SKumar Gala 4274c8b28152SLiu Gang- CONFIG_SRIO_PCIE_BOOT_MASTER 4275c8b28152SLiu Gang Board can support master function for Boot from SRIO and PCIE 4276c8b28152SLiu Gang 4277a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT: 4278a09b9b68SKumar Gala Virtual Address of SRIO port 'n' memory region 4279a09b9b68SKumar Gala 4280a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS: 4281a09b9b68SKumar Gala Physical Address of SRIO port 'n' memory region 4282a09b9b68SKumar Gala 4283a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE: 4284a09b9b68SKumar Gala Size of SRIO port 'n' memory region 4285a09b9b68SKumar Gala 428666bd1846SFabio Estevam- CONFIG_SYS_NAND_BUSWIDTH_16BIT 428766bd1846SFabio Estevam Defined to tell the NAND controller that the NAND chip is using 428866bd1846SFabio Estevam a 16 bit bus. 428966bd1846SFabio Estevam Not all NAND drivers use this symbol. 4290a430e916SFabio Estevam Example of drivers that use it: 429166bd1846SFabio Estevam - drivers/mtd/nand/ndfc.c 4292a430e916SFabio Estevam - drivers/mtd/nand/mxc_nand.c 4293eced4626SAlex Waterman 4294eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG 4295eced4626SAlex Waterman Sets the EBC0_CFG register for the NDFC. If not defined 4296eced4626SAlex Waterman a default value will be used. 4297eced4626SAlex Waterman 4298bb99ad6dSBen Warren- CONFIG_SPD_EEPROM 4299218ca724SWolfgang Denk Get DDR timing information from an I2C EEPROM. Common 4300218ca724SWolfgang Denk with pluggable memory modules such as SODIMMs 4301218ca724SWolfgang Denk 4302bb99ad6dSBen Warren SPD_EEPROM_ADDRESS 4303bb99ad6dSBen Warren I2C address of the SPD EEPROM 4304bb99ad6dSBen Warren 43056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM 4306218ca724SWolfgang Denk If SPD EEPROM is on an I2C bus other than the first 4307218ca724SWolfgang Denk one, specify here. Note that the value must resolve 4308218ca724SWolfgang Denk to something your driver can deal with. 4309bb99ad6dSBen Warren 43101b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING 43111b3e3c4fSYork Sun Get DDR timing information from other than SPD. Common with 43121b3e3c4fSYork Sun soldered DDR chips onboard without SPD. DDR raw timing 43131b3e3c4fSYork Sun parameters are extracted from datasheet and hard-coded into 43141b3e3c4fSYork Sun header files or board specific files. 43151b3e3c4fSYork Sun 43166f5e1dc5SYork Sun- CONFIG_FSL_DDR_INTERACTIVE 43176f5e1dc5SYork Sun Enable interactive DDR debugging. See doc/README.fsl-ddr. 43186f5e1dc5SYork Sun 43196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0 4320218ca724SWolfgang Denk Only for 83xx systems. If specified, then DDR should 4321218ca724SWolfgang Denk be configured using CS0 and CS1 instead of CS2 and CS3. 43222ad6b513STimur Tabi 4323c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12] 4324c26e454dSwdenk Define to enable FEC[12] on a 8xx series processor. 4325c26e454dSwdenk 4326c26e454dSwdenk- CONFIG_FEC[12]_PHY 4327c26e454dSwdenk Define to the hardcoded PHY address which corresponds 43286e592385Swdenk to the given FEC; i. e. 4329c26e454dSwdenk #define CONFIG_FEC1_PHY 4 4330c26e454dSwdenk means that the PHY with address 4 is connected to FEC1 4331c26e454dSwdenk 4332c26e454dSwdenk When set to -1, means to probe for first available. 4333c26e454dSwdenk 4334c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR 4335c26e454dSwdenk The PHY does not have a RXERR line (RMII only). 4336c26e454dSwdenk (so program the FEC to ignore it). 4337c26e454dSwdenk 4338c26e454dSwdenk- CONFIG_RMII 4339c26e454dSwdenk Enable RMII mode for all FECs. 4340c26e454dSwdenk Note that this is a global option, we can't 4341c26e454dSwdenk have one FEC in standard MII mode and another in RMII mode. 4342c26e454dSwdenk 43435cf91d6bSwdenk- CONFIG_CRC32_VERIFY 43445cf91d6bSwdenk Add a verify option to the crc32 command. 43455cf91d6bSwdenk The syntax is: 43465cf91d6bSwdenk 43475cf91d6bSwdenk => crc32 -v <address> <count> <crc32> 43485cf91d6bSwdenk 43495cf91d6bSwdenk Where address/count indicate a memory area 43505cf91d6bSwdenk and crc32 is the correct crc32 which the 43515cf91d6bSwdenk area should have. 43525cf91d6bSwdenk 435356523f12Swdenk- CONFIG_LOOPW 435456523f12Swdenk Add the "loopw" memory command. This only takes effect if 4355602ad3b3SJon Loeliger the memory commands are activated globally (CONFIG_CMD_MEM). 435656523f12Swdenk 43577b466641Sstroese- CONFIG_MX_CYCLIC 43587b466641Sstroese Add the "mdc" and "mwc" memory commands. These are cyclic 43597b466641Sstroese "md/mw" commands. 43607b466641Sstroese Examples: 43617b466641Sstroese 43627b466641Sstroese => mdc.b 10 4 500 43637b466641Sstroese This command will print 4 bytes (10,11,12,13) each 500 ms. 43647b466641Sstroese 43657b466641Sstroese => mwc.l 100 12345678 10 43667b466641Sstroese This command will write 12345678 to address 100 all 10 ms. 43677b466641Sstroese 43687b466641Sstroese This only takes effect if the memory commands are activated 4369602ad3b3SJon Loeliger globally (CONFIG_CMD_MEM). 43707b466641Sstroese 43718aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT 4372afc1ce82SMacpaul Lin [ARM, NDS32, MIPS only] If this variable is defined, then certain 4373e03f3169SWolfgang Denk low level initializations (like setting up the memory 4374e03f3169SWolfgang Denk controller) are omitted and/or U-Boot does not 4375e03f3169SWolfgang Denk relocate itself into RAM. 43768aa1a2d1Swdenk 4377e03f3169SWolfgang Denk Normally this variable MUST NOT be defined. The only 4378e03f3169SWolfgang Denk exception is when U-Boot is loaded (to RAM) by some 4379e03f3169SWolfgang Denk other boot loader or by a debugger which performs 4380e03f3169SWolfgang Denk these initializations itself. 43818aa1a2d1Swdenk 4382401bb30bSAneesh V- CONFIG_SPL_BUILD 4383df81238bSMagnus Lilja Modifies the behaviour of start.S when compiling a loader 4384df81238bSMagnus Lilja that is executed before the actual U-Boot. E.g. when 4385df81238bSMagnus Lilja compiling a NAND SPL. 4386400558b5Swdenk 43873aa29de0SYing Zhang- CONFIG_TPL_BUILD 43883aa29de0SYing Zhang Modifies the behaviour of start.S when compiling a loader 43893aa29de0SYing Zhang that is executed after the SPL and before the actual U-Boot. 43903aa29de0SYing Zhang It is loaded by the SPL. 43913aa29de0SYing Zhang 43925df572f0SYing Zhang- CONFIG_SYS_MPC85XX_NO_RESETVEC 43935df572f0SYing Zhang Only for 85xx systems. If this variable is specified, the section 43945df572f0SYing Zhang .resetvec is not kept and the section .bootpg is placed in the 43955df572f0SYing Zhang previous 4k of the .text section. 43965df572f0SYing Zhang 43974213fc29SSimon Glass- CONFIG_ARCH_MAP_SYSMEM 43984213fc29SSimon Glass Generally U-Boot (and in particular the md command) uses 43994213fc29SSimon Glass effective address. It is therefore not necessary to regard 44004213fc29SSimon Glass U-Boot address as virtual addresses that need to be translated 44014213fc29SSimon Glass to physical addresses. However, sandbox requires this, since 44024213fc29SSimon Glass it maintains its own little RAM buffer which contains all 44034213fc29SSimon Glass addressable memory. This option causes some memory accesses 44044213fc29SSimon Glass to be mapped through map_sysmem() / unmap_sysmem(). 44054213fc29SSimon Glass 4406d8834a13SMatthias Weisser- CONFIG_USE_ARCH_MEMCPY 4407d8834a13SMatthias Weisser CONFIG_USE_ARCH_MEMSET 4408d8834a13SMatthias Weisser If these options are used a optimized version of memcpy/memset will 4409d8834a13SMatthias Weisser be used if available. These functions may be faster under some 4410d8834a13SMatthias Weisser conditions but may increase the binary size. 4411d8834a13SMatthias Weisser 4412588a13f7SSimon Glass- CONFIG_X86_RESET_VECTOR 4413588a13f7SSimon Glass If defined, the x86 reset vector code is included. This is not 4414588a13f7SSimon Glass needed when U-Boot is running from Coreboot. 4415b16f521aSGabe Black 4416fc33705eSMark Jackson- CONFIG_SYS_MPUCLK 4417fc33705eSMark Jackson Defines the MPU clock speed (in MHz). 4418fc33705eSMark Jackson 4419fc33705eSMark Jackson NOTE : currently only supported on AM335x platforms. 44205b5ece9eSGabe Black 442116678eb4SHeiko Schocher- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC: 442216678eb4SHeiko Schocher Enables the RTC32K OSC on AM33xx based plattforms 442316678eb4SHeiko Schocher 4424f2717b47STimur TabiFreescale QE/FMAN Firmware Support: 4425f2717b47STimur Tabi----------------------------------- 4426f2717b47STimur Tabi 4427f2717b47STimur TabiThe Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the 4428f2717b47STimur Tabiloading of "firmware", which is encoded in the QE firmware binary format. 4429f2717b47STimur TabiThis firmware often needs to be loaded during U-Boot booting, so macros 4430f2717b47STimur Tabiare used to identify the storage device (NOR flash, SPI, etc) and the address 4431f2717b47STimur Tabiwithin that device. 4432f2717b47STimur Tabi 4433f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_ADDR 4434f2717b47STimur Tabi The address in the storage device where the firmware is located. The 4435f2717b47STimur Tabi meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro 4436f2717b47STimur Tabi is also specified. 4437f2717b47STimur Tabi 4438f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_LENGTH 4439f2717b47STimur Tabi The maximum possible size of the firmware. The firmware binary format 4440f2717b47STimur Tabi has a field that specifies the actual size of the firmware, but it 4441f2717b47STimur Tabi might not be possible to read any part of the firmware unless some 4442f2717b47STimur Tabi local storage is allocated to hold the entire firmware first. 4443f2717b47STimur Tabi 4444f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NOR 4445f2717b47STimur Tabi Specifies that QE/FMAN firmware is located in NOR flash, mapped as 4446f2717b47STimur Tabi normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the 4447f2717b47STimur Tabi virtual address in NOR flash. 4448f2717b47STimur Tabi 4449f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NAND 4450f2717b47STimur Tabi Specifies that QE/FMAN firmware is located in NAND flash. 4451f2717b47STimur Tabi CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash. 4452f2717b47STimur Tabi 4453f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_MMC 4454f2717b47STimur Tabi Specifies that QE/FMAN firmware is located on the primary SD/MMC 4455f2717b47STimur Tabi device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device. 4456f2717b47STimur Tabi 4457f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH 4458f2717b47STimur Tabi Specifies that QE/FMAN firmware is located on the primary SPI 4459f2717b47STimur Tabi device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device. 4460f2717b47STimur Tabi 4461292dc6c5SLiu Gang- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE 4462292dc6c5SLiu Gang Specifies that QE/FMAN firmware is located in the remote (master) 4463292dc6c5SLiu Gang memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which 4464fc54c7faSLiu Gang can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound 4465fc54c7faSLiu Gang window->master inbound window->master LAW->the ucode address in 4466fc54c7faSLiu Gang master's memory space. 4467f2717b47STimur Tabi 4468c609719bSwdenkBuilding the Software: 4469c609719bSwdenk====================== 4470c609719bSwdenk 4471218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments 4472218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support 4473218ca724SWolfgang Denkall possibly existing versions of cross development tools in all 4474218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we 4475218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK) 4476218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot. 4477c609719bSwdenk 4478218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you 4479218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case, 4480218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell. 4481218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are 4482218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter: 4483c609719bSwdenk 4484218ca724SWolfgang Denk $ CROSS_COMPILE=ppc_4xx- 4485218ca724SWolfgang Denk $ export CROSS_COMPILE 4486c609719bSwdenk 44872f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in 44882f8d396bSPeter Tyser the tools directory you can use the MinGW toolchain 44892f8d396bSPeter Tyser (http://www.mingw.org). Set your HOST tools to the MinGW 44902f8d396bSPeter Tyser toolchain and execute 'make tools'. For example: 44912f8d396bSPeter Tyser 44922f8d396bSPeter Tyser $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools 44932f8d396bSPeter Tyser 44942f8d396bSPeter Tyser Binaries such as tools/mkimage.exe will be created which can 44952f8d396bSPeter Tyser be executed on computers running Windows. 44962f8d396bSPeter Tyser 4497c609719bSwdenkU-Boot is intended to be simple to build. After installing the 4498c609719bSwdenksources you must configure U-Boot for one specific board type. This 4499c609719bSwdenkis done by typing: 4500c609719bSwdenk 4501c609719bSwdenk make NAME_config 4502c609719bSwdenk 4503218ca724SWolfgang Denkwhere "NAME_config" is the name of one of the existing configu- 45044d675ae6SMichael Jonesrations; see boards.cfg for supported names. 450554387ac9Swdenk 4506c609719bSwdenkNote: for some board special configuration names may exist; check if 4507c609719bSwdenk additional information is available from the board vendor; for 45082729af9dSwdenk instance, the TQM823L systems are available without (standard) 45092729af9dSwdenk or with LCD support. You can select such additional "features" 451011ccc33fSMarcel Ziswiler when choosing the configuration, i. e. 4511c609719bSwdenk 45122729af9dSwdenk make TQM823L_config 45132729af9dSwdenk - will configure for a plain TQM823L, i. e. no LCD support 4514c609719bSwdenk 4515c609719bSwdenk make TQM823L_LCD_config 4516c609719bSwdenk - will configure for a TQM823L with U-Boot console on LCD 4517c609719bSwdenk 4518c609719bSwdenk etc. 4519c609719bSwdenk 4520c609719bSwdenk 4521c609719bSwdenkFinally, type "make all", and you should get some working U-Boot 45227152b1d0Swdenkimages ready for download to / installation on your system: 4523c609719bSwdenk 4524c609719bSwdenk- "u-boot.bin" is a raw binary image 4525c609719bSwdenk- "u-boot" is an image in ELF binary format 4526c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format 4527c609719bSwdenk 4528baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved 4529baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change 4530baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory: 4531baf31249SMarian Balakowicz 4532baf31249SMarian Balakowicz1. Add O= to the make command line invocations: 4533baf31249SMarian Balakowicz 4534baf31249SMarian Balakowicz make O=/tmp/build distclean 4535baf31249SMarian Balakowicz make O=/tmp/build NAME_config 4536baf31249SMarian Balakowicz make O=/tmp/build all 4537baf31249SMarian Balakowicz 4538baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location: 4539baf31249SMarian Balakowicz 4540baf31249SMarian Balakowicz export BUILD_DIR=/tmp/build 4541baf31249SMarian Balakowicz make distclean 4542baf31249SMarian Balakowicz make NAME_config 4543baf31249SMarian Balakowicz make all 4544baf31249SMarian Balakowicz 4545baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment 4546baf31249SMarian Balakowiczvariable. 4547baf31249SMarian Balakowicz 4548c609719bSwdenk 4549c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so 4550c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of 4551c609719bSwdenknative "make". 4552c609719bSwdenk 4553c609719bSwdenk 4554c609719bSwdenkIf the system board that you have is not listed, then you will need 4555c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these 4556c609719bSwdenksteps: 4557c609719bSwdenk 4558c609719bSwdenk1. Add a new configuration option for your board to the toplevel 45594d675ae6SMichael Jones "boards.cfg" file, using the existing entries as examples. 45604d675ae6SMichael Jones Follow the instructions there to keep the boards in order. 4561c609719bSwdenk2. Create a new directory to hold your board specific code. Add any 456285ec0bccSwdenk files you need. In your board directory, you will need at least 456385ec0bccSwdenk the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds". 456485ec0bccSwdenk3. Create a new configuration file "include/configs/<board>.h" for 456585ec0bccSwdenk your board 4566c609719bSwdenk3. If you're porting U-Boot to a new CPU, then also create a new 4567c609719bSwdenk directory to hold your CPU specific code. Add any files you need. 456885ec0bccSwdenk4. Run "make <board>_config" with your new name. 4569c609719bSwdenk5. Type "make", and you should get a working "u-boot.srec" file 4570c609719bSwdenk to be installed on your target system. 457185ec0bccSwdenk6. Debug and solve any problems that might arise. 4572c609719bSwdenk [Of course, this last step is much harder than it sounds.] 4573c609719bSwdenk 4574c609719bSwdenk 4575c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.: 4576c609719bSwdenk============================================================== 4577c609719bSwdenk 4578c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board 4579c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to 4580c609719bSwdenkprovide feedback to the other developers. The feedback normally takes 4581c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest 4582218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources. 4583c609719bSwdenk 4584c609719bSwdenkBut before you submit such a patch, please verify that your modifi- 4585c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of 4586c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so, 4587c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot 4588c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can 45897152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE' 4590218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools 4591218ca724SWolfgang Denkyou can type 4592c609719bSwdenk 4593c609719bSwdenk CROSS_COMPILE=ppc_8xx- MAKEALL 4594c609719bSwdenk 4595c609719bSwdenkor to build on a native PowerPC system you can type 4596c609719bSwdenk 4597c609719bSwdenk CROSS_COMPILE=' ' MAKEALL 4598c609719bSwdenk 4599218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build 4600218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by 4601218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target 4602218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and 4603218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default 4604218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment 4605218ca724SWolfgang Denkvariable. For example: 4606baf31249SMarian Balakowicz 4607baf31249SMarian Balakowicz export BUILD_DIR=/tmp/build 4608baf31249SMarian Balakowicz export MAKEALL_LOGDIR=/tmp/log 4609baf31249SMarian Balakowicz CROSS_COMPILE=ppc_8xx- MAKEALL 4610baf31249SMarian Balakowicz 4611218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build, 4612218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean 4613218ca724SWolfgang Denkduring the whole build process. 4614baf31249SMarian Balakowicz 4615baf31249SMarian Balakowicz 4616c609719bSwdenkSee also "U-Boot Porting Guide" below. 4617c609719bSwdenk 4618c609719bSwdenk 4619c609719bSwdenkMonitor Commands - Overview: 4620c609719bSwdenk============================ 4621c609719bSwdenk 4622c609719bSwdenkgo - start application at address 'addr' 4623c609719bSwdenkrun - run commands in an environment variable 4624c609719bSwdenkbootm - boot application image from memory 4625c609719bSwdenkbootp - boot image via network using BootP/TFTP protocol 462644f074c7SMarek Vasutbootz - boot zImage from memory 4627c609719bSwdenktftpboot- boot image via network using TFTP protocol 4628c609719bSwdenk and env variables "ipaddr" and "serverip" 4629c609719bSwdenk (and eventually "gatewayip") 46301fb7cd49SSimon Glasstftpput - upload a file via network using TFTP protocol 4631c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol 4632c609719bSwdenkdiskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd' 4633c609719bSwdenkloads - load S-Record file over serial line 4634c609719bSwdenkloadb - load binary file over serial line (kermit mode) 4635c609719bSwdenkmd - memory display 4636c609719bSwdenkmm - memory modify (auto-incrementing) 4637c609719bSwdenknm - memory modify (constant address) 4638c609719bSwdenkmw - memory write (fill) 4639c609719bSwdenkcp - memory copy 4640c609719bSwdenkcmp - memory compare 4641c609719bSwdenkcrc32 - checksum calculation 46420f89c54bSPeter Tyseri2c - I2C sub-system 4643c609719bSwdenksspi - SPI utility commands 4644c609719bSwdenkbase - print or set address offset 4645c609719bSwdenkprintenv- print environment variables 4646c609719bSwdenksetenv - set environment variables 4647c609719bSwdenksaveenv - save environment variables to persistent storage 4648c609719bSwdenkprotect - enable or disable FLASH write protection 4649c609719bSwdenkerase - erase FLASH memory 4650c609719bSwdenkflinfo - print FLASH memory information 465110635afaSKarl O. Pincnand - NAND memory operations (see doc/README.nand) 4652c609719bSwdenkbdinfo - print Board Info structure 4653c609719bSwdenkiminfo - print header information for application image 4654c609719bSwdenkconinfo - print console devices and informations 4655c609719bSwdenkide - IDE sub-system 4656c609719bSwdenkloop - infinite loop on address range 465756523f12Swdenkloopw - infinite write loop on address range 4658c609719bSwdenkmtest - simple RAM test 4659c609719bSwdenkicache - enable or disable instruction cache 4660c609719bSwdenkdcache - enable or disable data cache 4661c609719bSwdenkreset - Perform RESET of the CPU 4662c609719bSwdenkecho - echo args to console 4663c609719bSwdenkversion - print monitor version 4664c609719bSwdenkhelp - print online help 4665c609719bSwdenk? - alias for 'help' 4666c609719bSwdenk 4667c609719bSwdenk 4668c609719bSwdenkMonitor Commands - Detailed Description: 4669c609719bSwdenk======================================== 4670c609719bSwdenk 4671c609719bSwdenkTODO. 4672c609719bSwdenk 4673c609719bSwdenkFor now: just type "help <command>". 4674c609719bSwdenk 4675c609719bSwdenk 4676c609719bSwdenkEnvironment Variables: 4677c609719bSwdenk====================== 4678c609719bSwdenk 4679c609719bSwdenkU-Boot supports user configuration using Environment Variables which 4680c609719bSwdenkcan be made persistent by saving to Flash memory. 4681c609719bSwdenk 4682c609719bSwdenkEnvironment Variables are set using "setenv", printed using 4683c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv" 4684c609719bSwdenkwithout a value can be used to delete a variable from the 4685c609719bSwdenkenvironment. As long as you don't save the environment you are 4686c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the 4687c609719bSwdenkenvironment is erased by accident, a default environment is provided. 4688c609719bSwdenk 4689c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables. 4690c96f86eeSWolfgang Denk 4691c96f86eeSWolfgang DenkList of environment variables (most likely not complete): 4692c609719bSwdenk 4693c609719bSwdenk baudrate - see CONFIG_BAUDRATE 4694c609719bSwdenk 4695c609719bSwdenk bootdelay - see CONFIG_BOOTDELAY 4696c609719bSwdenk 4697c609719bSwdenk bootcmd - see CONFIG_BOOTCOMMAND 4698c609719bSwdenk 4699c609719bSwdenk bootargs - Boot arguments when booting an RTOS image 4700c609719bSwdenk 4701c609719bSwdenk bootfile - Name of the image to load with TFTP 4702c609719bSwdenk 47037d721e34SBartlomiej Sieka bootm_low - Memory range available for image processing in the bootm 47047d721e34SBartlomiej Sieka command can be restricted. This variable is given as 47057d721e34SBartlomiej Sieka a hexadecimal number and defines lowest address allowed 47067d721e34SBartlomiej Sieka for use by the bootm command. See also "bootm_size" 47077d721e34SBartlomiej Sieka environment variable. Address defined by "bootm_low" is 47087d721e34SBartlomiej Sieka also the base of the initial memory mapping for the Linux 4709c3624e6eSGrant Likely kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and 4710c3624e6eSGrant Likely bootm_mapsize. 4711c3624e6eSGrant Likely 4712c3624e6eSGrant Likely bootm_mapsize - Size of the initial memory mapping for the Linux kernel. 4713c3624e6eSGrant Likely This variable is given as a hexadecimal number and it 4714c3624e6eSGrant Likely defines the size of the memory region starting at base 4715c3624e6eSGrant Likely address bootm_low that is accessible by the Linux kernel 4716c3624e6eSGrant Likely during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used 4717c3624e6eSGrant Likely as the default value if it is defined, and bootm_size is 4718c3624e6eSGrant Likely used otherwise. 47197d721e34SBartlomiej Sieka 47207d721e34SBartlomiej Sieka bootm_size - Memory range available for image processing in the bootm 47217d721e34SBartlomiej Sieka command can be restricted. This variable is given as 47227d721e34SBartlomiej Sieka a hexadecimal number and defines the size of the region 47237d721e34SBartlomiej Sieka allowed for use by the bootm command. See also "bootm_low" 47247d721e34SBartlomiej Sieka environment variable. 47257d721e34SBartlomiej Sieka 47264bae9090SBartlomiej Sieka updatefile - Location of the software update file on a TFTP server, used 47274bae9090SBartlomiej Sieka by the automatic software update feature. Please refer to 47284bae9090SBartlomiej Sieka documentation in doc/README.update for more details. 47294bae9090SBartlomiej Sieka 4730c609719bSwdenk autoload - if set to "no" (any string beginning with 'n'), 4731c609719bSwdenk "bootp" will just load perform a lookup of the 4732c609719bSwdenk configuration from the BOOTP server, but not try to 4733c609719bSwdenk load any image using TFTP 4734c609719bSwdenk 4735c609719bSwdenk autostart - if set to "yes", an image loaded using the "bootp", 4736c609719bSwdenk "rarpboot", "tftpboot" or "diskboot" commands will 4737c609719bSwdenk be automatically started (by internally calling 4738c609719bSwdenk "bootm") 4739c609719bSwdenk 47404a6fd34bSwdenk If set to "no", a standalone image passed to the 47414a6fd34bSwdenk "bootm" command will be copied to the load address 47424a6fd34bSwdenk (and eventually uncompressed), but NOT be started. 47434a6fd34bSwdenk This can be used to load and uncompress arbitrary 47444a6fd34bSwdenk data. 47454a6fd34bSwdenk 4746a28afca5SDavid A. Long fdt_high - if set this restricts the maximum address that the 4747a28afca5SDavid A. Long flattened device tree will be copied into upon boot. 4748fa34f6b2SShawn Guo For example, if you have a system with 1 GB memory 4749fa34f6b2SShawn Guo at physical address 0x10000000, while Linux kernel 4750fa34f6b2SShawn Guo only recognizes the first 704 MB as low memory, you 4751fa34f6b2SShawn Guo may need to set fdt_high as 0x3C000000 to have the 4752fa34f6b2SShawn Guo device tree blob be copied to the maximum address 4753fa34f6b2SShawn Guo of the 704 MB low memory, so that Linux kernel can 4754fa34f6b2SShawn Guo access it during the boot procedure. 4755fa34f6b2SShawn Guo 4756a28afca5SDavid A. Long If this is set to the special value 0xFFFFFFFF then 4757a28afca5SDavid A. Long the fdt will not be copied at all on boot. For this 4758a28afca5SDavid A. Long to work it must reside in writable memory, have 4759a28afca5SDavid A. Long sufficient padding on the end of it for u-boot to 4760a28afca5SDavid A. Long add the information it needs into it, and the memory 4761a28afca5SDavid A. Long must be accessible by the kernel. 4762a28afca5SDavid A. Long 4763eea63e05SSimon Glass fdtcontroladdr- if set this is the address of the control flattened 4764eea63e05SSimon Glass device tree used by U-Boot when CONFIG_OF_CONTROL is 4765eea63e05SSimon Glass defined. 4766eea63e05SSimon Glass 476717ea1177Swdenk i2cfast - (PPC405GP|PPC405EP only) 476817ea1177Swdenk if set to 'y' configures Linux I2C driver for fast 476917ea1177Swdenk mode (400kHZ). This environment variable is used in 477017ea1177Swdenk initialization code. So, for changes to be effective 477117ea1177Swdenk it must be saved and board must be reset. 477217ea1177Swdenk 4773c609719bSwdenk initrd_high - restrict positioning of initrd images: 4774c609719bSwdenk If this variable is not set, initrd images will be 4775c609719bSwdenk copied to the highest possible address in RAM; this 4776c609719bSwdenk is usually what you want since it allows for 4777c609719bSwdenk maximum initrd size. If for some reason you want to 4778c609719bSwdenk make sure that the initrd image is loaded below the 47796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BOOTMAPSZ limit, you can set this environment 4780c609719bSwdenk variable to a value of "no" or "off" or "0". 4781c609719bSwdenk Alternatively, you can set it to a maximum upper 4782c609719bSwdenk address to use (U-Boot will still check that it 4783c609719bSwdenk does not overwrite the U-Boot stack and data). 4784c609719bSwdenk 4785c609719bSwdenk For instance, when you have a system with 16 MB 47867152b1d0Swdenk RAM, and want to reserve 4 MB from use by Linux, 4787c609719bSwdenk you can do this by adding "mem=12M" to the value of 4788c609719bSwdenk the "bootargs" variable. However, now you must make 47897152b1d0Swdenk sure that the initrd image is placed in the first 4790c609719bSwdenk 12 MB as well - this can be done with 4791c609719bSwdenk 4792c609719bSwdenk setenv initrd_high 00c00000 4793c609719bSwdenk 479438b99261Swdenk If you set initrd_high to 0xFFFFFFFF, this is an 479538b99261Swdenk indication to U-Boot that all addresses are legal 479638b99261Swdenk for the Linux kernel, including addresses in flash 479738b99261Swdenk memory. In this case U-Boot will NOT COPY the 479838b99261Swdenk ramdisk at all. This may be useful to reduce the 479938b99261Swdenk boot time on your system, but requires that this 480038b99261Swdenk feature is supported by your Linux kernel. 480138b99261Swdenk 4802c609719bSwdenk ipaddr - IP address; needed for tftpboot command 4803c609719bSwdenk 4804c609719bSwdenk loadaddr - Default load address for commands like "bootp", 4805dc7c9a1aSwdenk "rarpboot", "tftpboot", "loadb" or "diskboot" 4806c609719bSwdenk 4807c609719bSwdenk loads_echo - see CONFIG_LOADS_ECHO 4808c609719bSwdenk 4809c609719bSwdenk serverip - TFTP server IP address; needed for tftpboot command 4810c609719bSwdenk 4811c609719bSwdenk bootretry - see CONFIG_BOOT_RETRY_TIME 4812c609719bSwdenk 4813c609719bSwdenk bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR 4814c609719bSwdenk 4815c609719bSwdenk bootstopkey - see CONFIG_AUTOBOOT_STOP_STR 4816c609719bSwdenk 4817e2a53458SMike Frysinger ethprime - controls which interface is used first. 4818a3d991bdSwdenk 4819e2a53458SMike Frysinger ethact - controls which interface is currently active. 4820e2a53458SMike Frysinger For example you can do the following 4821a3d991bdSwdenk 482248690d80SHeiko Schocher => setenv ethact FEC 482348690d80SHeiko Schocher => ping 192.168.0.1 # traffic sent on FEC 482448690d80SHeiko Schocher => setenv ethact SCC 482548690d80SHeiko Schocher => ping 10.0.0.1 # traffic sent on SCC 4826a3d991bdSwdenk 4827e1692577SMatthias Fuchs ethrotate - When set to "no" U-Boot does not go through all 4828e1692577SMatthias Fuchs available network interfaces. 4829e1692577SMatthias Fuchs It just stays at the currently selected interface. 4830e1692577SMatthias Fuchs 4831a3d991bdSwdenk netretry - When set to "no" each network operation will 4832a3d991bdSwdenk either succeed or fail without retrying. 48336e592385Swdenk When set to "once" the network operation will 48346e592385Swdenk fail when all the available network interfaces 48356e592385Swdenk are tried once without success. 4836a3d991bdSwdenk Useful on scripts which control the retry operation 4837a3d991bdSwdenk themselves. 4838a3d991bdSwdenk 4839b4e2f89dSJean-Christophe PLAGNIOL-VILLARD npe_ucode - set load address for the NPE microcode 4840a1cf027aSJean-Christophe PLAGNIOL-VILLARD 48418d51aacdSSimon Glass silent_linux - If set then linux will be told to boot silently, by 48428d51aacdSSimon Glass changing the console to be empty. If "yes" it will be 48438d51aacdSSimon Glass made silent. If "no" it will not be made silent. If 48448d51aacdSSimon Glass unset, then it will be made silent if the U-Boot console 48458d51aacdSSimon Glass is silent. 48468d51aacdSSimon Glass 484728cb9375SWolfgang Denk tftpsrcport - If this is set, the value is used for TFTP's 4848ecb0ccd9SWolfgang Denk UDP source port. 4849ecb0ccd9SWolfgang Denk 485028cb9375SWolfgang Denk tftpdstport - If this is set, the value is used for TFTP's UDP 485128cb9375SWolfgang Denk destination port instead of the Well Know Port 69. 485228cb9375SWolfgang Denk 4853c96f86eeSWolfgang Denk tftpblocksize - Block size to use for TFTP transfers; if not set, 4854c96f86eeSWolfgang Denk we use the TFTP server's default block size 4855c96f86eeSWolfgang Denk 4856c96f86eeSWolfgang Denk tftptimeout - Retransmission timeout for TFTP packets (in milli- 4857c96f86eeSWolfgang Denk seconds, minimum value is 1000 = 1 second). Defines 4858c96f86eeSWolfgang Denk when a packet is considered to be lost so it has to 4859c96f86eeSWolfgang Denk be retransmitted. The default is 5000 = 5 seconds. 4860c96f86eeSWolfgang Denk Lowering this value may make downloads succeed 4861c96f86eeSWolfgang Denk faster in networks with high packet loss rates or 4862c96f86eeSWolfgang Denk with unreliable TFTP servers. 4863c96f86eeSWolfgang Denk 4864a3d991bdSwdenk vlan - When set to a value < 4095 the traffic over 486511ccc33fSMarcel Ziswiler Ethernet is encapsulated/received over 802.1q 4866a3d991bdSwdenk VLAN tagged frames. 4867c609719bSwdenk 4868dc0b7b0eSJason HobbsThe following image location variables contain the location of images 4869dc0b7b0eSJason Hobbsused in booting. The "Image" column gives the role of the image and is 4870dc0b7b0eSJason Hobbsnot an environment variable name. The other columns are environment 4871dc0b7b0eSJason Hobbsvariable names. "File Name" gives the name of the file on a TFTP 4872dc0b7b0eSJason Hobbsserver, "RAM Address" gives the location in RAM the image will be 4873dc0b7b0eSJason Hobbsloaded to, and "Flash Location" gives the image's address in NOR 4874dc0b7b0eSJason Hobbsflash or offset in NAND flash. 4875dc0b7b0eSJason Hobbs 4876dc0b7b0eSJason Hobbs*Note* - these variables don't have to be defined for all boards, some 4877dc0b7b0eSJason Hobbsboards currenlty use other variables for these purposes, and some 4878dc0b7b0eSJason Hobbsboards use these variables for other purposes. 4879dc0b7b0eSJason Hobbs 4880dc0b7b0eSJason HobbsImage File Name RAM Address Flash Location 4881dc0b7b0eSJason Hobbs----- --------- ----------- -------------- 4882dc0b7b0eSJason Hobbsu-boot u-boot u-boot_addr_r u-boot_addr 4883dc0b7b0eSJason HobbsLinux kernel bootfile kernel_addr_r kernel_addr 4884dc0b7b0eSJason Hobbsdevice tree blob fdtfile fdt_addr_r fdt_addr 4885dc0b7b0eSJason Hobbsramdisk ramdiskfile ramdisk_addr_r ramdisk_addr 4886dc0b7b0eSJason Hobbs 4887c609719bSwdenkThe following environment variables may be used and automatically 4888c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"), 4889c609719bSwdenkdepending the information provided by your boot server: 4890c609719bSwdenk 4891c609719bSwdenk bootfile - see above 4892c609719bSwdenk dnsip - IP address of your Domain Name Server 4893fe389a82Sstroese dnsip2 - IP address of your secondary Domain Name Server 4894c609719bSwdenk gatewayip - IP address of the Gateway (Router) to use 4895c609719bSwdenk hostname - Target hostname 4896c609719bSwdenk ipaddr - see above 4897c609719bSwdenk netmask - Subnet Mask 4898c609719bSwdenk rootpath - Pathname of the root filesystem on the NFS server 4899c609719bSwdenk serverip - see above 4900c609719bSwdenk 4901c609719bSwdenk 4902c609719bSwdenkThere are two special Environment Variables: 4903c609719bSwdenk 4904c609719bSwdenk serial# - contains hardware identification information such 4905c609719bSwdenk as type string and/or serial number 4906c609719bSwdenk ethaddr - Ethernet address 4907c609719bSwdenk 4908c609719bSwdenkThese variables can be set only once (usually during manufacturing of 4909c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables 4910c609719bSwdenkonce they have been set once. 4911c609719bSwdenk 4912c609719bSwdenk 4913c1551ea8SstroeseFurther special Environment Variables: 4914c1551ea8Sstroese 4915c1551ea8Sstroese ver - Contains the U-Boot version string as printed 4916c1551ea8Sstroese with the "version" command. This variable is 4917c1551ea8Sstroese readonly (see CONFIG_VERSION_VARIABLE). 4918c1551ea8Sstroese 4919c1551ea8Sstroese 4920c609719bSwdenkPlease note that changes to some configuration parameters may take 4921c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-). 4922c609719bSwdenk 4923c609719bSwdenk 4924170ab110SJoe HershbergerCallback functions for environment variables: 4925170ab110SJoe Hershberger--------------------------------------------- 4926170ab110SJoe Hershberger 4927170ab110SJoe HershbergerFor some environment variables, the behavior of u-boot needs to change 4928170ab110SJoe Hershbergerwhen their values are changed. This functionailty allows functions to 4929170ab110SJoe Hershbergerbe associated with arbitrary variables. On creation, overwrite, or 4930170ab110SJoe Hershbergerdeletion, the callback will provide the opportunity for some side 4931170ab110SJoe Hershbergereffect to happen or for the change to be rejected. 4932170ab110SJoe Hershberger 4933170ab110SJoe HershbergerThe callbacks are named and associated with a function using the 4934170ab110SJoe HershbergerU_BOOT_ENV_CALLBACK macro in your board or driver code. 4935170ab110SJoe Hershberger 4936170ab110SJoe HershbergerThese callbacks are associated with variables in one of two ways. The 4937170ab110SJoe Hershbergerstatic list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC 4938170ab110SJoe Hershbergerin the board configuration to a string that defines a list of 4939170ab110SJoe Hershbergerassociations. The list must be in the following format: 4940170ab110SJoe Hershberger 4941170ab110SJoe Hershberger entry = variable_name[:callback_name] 4942170ab110SJoe Hershberger list = entry[,list] 4943170ab110SJoe Hershberger 4944170ab110SJoe HershbergerIf the callback name is not specified, then the callback is deleted. 4945170ab110SJoe HershbergerSpaces are also allowed anywhere in the list. 4946170ab110SJoe Hershberger 4947170ab110SJoe HershbergerCallbacks can also be associated by defining the ".callbacks" variable 4948170ab110SJoe Hershbergerwith the same list format above. Any association in ".callbacks" will 4949170ab110SJoe Hershbergeroverride any association in the static list. You can define 4950170ab110SJoe HershbergerCONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the 4951170ab110SJoe Hershberger".callbacks" envirnoment variable in the default or embedded environment. 4952170ab110SJoe Hershberger 4953170ab110SJoe Hershberger 4954f07771ccSwdenkCommand Line Parsing: 4955f07771ccSwdenk===================== 4956f07771ccSwdenk 4957f07771ccSwdenkThere are two different command line parsers available with U-Boot: 49587152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell: 4959f07771ccSwdenk 4960f07771ccSwdenkOld, simple command line parser: 4961f07771ccSwdenk-------------------------------- 4962f07771ccSwdenk 4963f07771ccSwdenk- supports environment variables (through setenv / saveenv commands) 4964f07771ccSwdenk- several commands on one line, separated by ';' 4965fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax 4966f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\', 4967f07771ccSwdenk for example: 4968fe126d8bSWolfgang Denk setenv bootcmd bootm \${address} 4969f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example: 4970f07771ccSwdenk setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off' 4971f07771ccSwdenk 4972f07771ccSwdenkHush shell: 4973f07771ccSwdenk----------- 4974f07771ccSwdenk 4975f07771ccSwdenk- similar to Bourne shell, with control structures like 4976f07771ccSwdenk if...then...else...fi, for...do...done; while...do...done, 4977f07771ccSwdenk until...do...done, ... 4978f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv 4979f07771ccSwdenk commands) and local shell variables (through standard shell syntax 4980f07771ccSwdenk "name=value"); only environment variables can be used with "run" 4981f07771ccSwdenk command 4982f07771ccSwdenk 4983f07771ccSwdenkGeneral rules: 4984f07771ccSwdenk-------------- 4985f07771ccSwdenk 4986f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run" 4987f07771ccSwdenk command) contains several commands separated by semicolon, and 4988f07771ccSwdenk one of these commands fails, then the remaining commands will be 4989f07771ccSwdenk executed anyway. 4990f07771ccSwdenk 4991f07771ccSwdenk(2) If you execute several variables with one call to run (i. e. 499211ccc33fSMarcel Ziswiler calling run with a list of variables as arguments), any failing 4993f07771ccSwdenk command will cause "run" to terminate, i. e. the remaining 4994f07771ccSwdenk variables are not executed. 4995f07771ccSwdenk 4996c609719bSwdenkNote for Redundant Ethernet Interfaces: 4997c609719bSwdenk======================================= 4998c609719bSwdenk 499911ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports 5000c609719bSwdenksuch configurations and is capable of automatic selection of a 50017152b1d0Swdenk"working" interface when needed. MAC assignment works as follows: 5002c609719bSwdenk 5003c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding 5004c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0), 5005c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ... 5006c609719bSwdenk 5007c609719bSwdenkIf the network interface stores some valid MAC address (for instance 5008c609719bSwdenkin SROM), this is used as default address if there is NO correspon- 5009c609719bSwdenkding setting in the environment; if the corresponding environment 5010c609719bSwdenkvariable is set, this overrides the settings in the card; that means: 5011c609719bSwdenk 5012c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the 5013c609719bSwdenk environment, the SROM's address is used. 5014c609719bSwdenk 5015c609719bSwdenko If there is no valid address in the SROM, and a definition in the 5016c609719bSwdenk environment exists, then the value from the environment variable is 5017c609719bSwdenk used. 5018c609719bSwdenk 5019c609719bSwdenko If both the SROM and the environment contain a MAC address, and 5020c609719bSwdenk both addresses are the same, this MAC address is used. 5021c609719bSwdenk 5022c609719bSwdenko If both the SROM and the environment contain a MAC address, and the 5023c609719bSwdenk addresses differ, the value from the environment is used and a 5024c609719bSwdenk warning is printed. 5025c609719bSwdenk 5026c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error 5027c609719bSwdenk is raised. 5028c609719bSwdenk 5029ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses 5030ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process. This 5031ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable. 5032ecee9324SBen WarrenThe naming convention is as follows: 5033ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc. 5034c609719bSwdenk 5035c609719bSwdenkImage Formats: 5036c609719bSwdenk============== 5037c609719bSwdenk 50383310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on) 50393310c549SMarian Balakowiczimages in two formats: 50403310c549SMarian Balakowicz 50413310c549SMarian BalakowiczNew uImage format (FIT) 50423310c549SMarian Balakowicz----------------------- 50433310c549SMarian Balakowicz 50443310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar 50453310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple 50463310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by 50473310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory. 50483310c549SMarian Balakowicz 50493310c549SMarian Balakowicz 50503310c549SMarian BalakowiczOld uImage format 50513310c549SMarian Balakowicz----------------- 50523310c549SMarian Balakowicz 50533310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything, 50543310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for 50553310c549SMarian Balakowiczdetails; basically, the header defines the following image properties: 5056c609719bSwdenk 5057c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD, 5058c609719bSwdenk 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks, 5059f5ed9e39SPeter Tyser LynxOS, pSOS, QNX, RTEMS, INTEGRITY; 5060f5ed9e39SPeter Tyser Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS, 5061f5ed9e39SPeter Tyser INTEGRITY). 50627b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86, 5063afc1ce82SMacpaul Lin IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit; 5064afc1ce82SMacpaul Lin Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC). 5065c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2) 5066c609719bSwdenk* Load Address 5067c609719bSwdenk* Entry Point 5068c609719bSwdenk* Image Name 5069c609719bSwdenk* Image Timestamp 5070c609719bSwdenk 5071c609719bSwdenkThe header is marked by a special Magic Number, and both the header 5072c609719bSwdenkand the data portions of the image are secured against corruption by 5073c609719bSwdenkCRC32 checksums. 5074c609719bSwdenk 5075c609719bSwdenk 5076c609719bSwdenkLinux Support: 5077c609719bSwdenk============== 5078c609719bSwdenk 5079c609719bSwdenkAlthough U-Boot should support any OS or standalone application 50807152b1d0Swdenkeasily, the main focus has always been on Linux during the design of 5081c609719bSwdenkU-Boot. 5082c609719bSwdenk 5083c609719bSwdenkU-Boot includes many features that so far have been part of some 5084c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any 5085c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image; 5086c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation 50877152b1d0Swdenkserves several purposes: 5088c609719bSwdenk 5089c609719bSwdenk- the same features can be used for other OS or standalone 5090c609719bSwdenk applications (for instance: using compressed images to reduce the 5091c609719bSwdenk Flash memory footprint) 5092c609719bSwdenk 5093c609719bSwdenk- it becomes much easier to port new Linux kernel versions because 50947152b1d0Swdenk lots of low-level, hardware dependent stuff are done by U-Boot 5095c609719bSwdenk 5096c609719bSwdenk- the same Linux kernel image can now be used with different "initrd" 5097c609719bSwdenk images; of course this also means that different kernel images can 5098c609719bSwdenk be run with the same "initrd". This makes testing easier (you don't 5099c609719bSwdenk have to build a new "zImage.initrd" Linux image when you just 5100c609719bSwdenk change a file in your "initrd"). Also, a field-upgrade of the 5101c609719bSwdenk software is easier now. 5102c609719bSwdenk 5103c609719bSwdenk 5104c609719bSwdenkLinux HOWTO: 5105c609719bSwdenk============ 5106c609719bSwdenk 5107c609719bSwdenkPorting Linux to U-Boot based systems: 5108c609719bSwdenk--------------------------------------- 5109c609719bSwdenk 5110c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to 5111c609719bSwdenkconfigure the Linux device drivers for use with your target hardware 5112c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to 5113c609719bSwdenkLinux :-). 5114c609719bSwdenk 5115a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot). 5116c609719bSwdenk 5117c609719bSwdenkJust make sure your machine specific header file (for instance 5118c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board 51191dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h, 51201dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value 51216d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR. 5122c609719bSwdenk 5123c609719bSwdenk 5124c609719bSwdenkConfiguring the Linux kernel: 5125c609719bSwdenk----------------------------- 5126c609719bSwdenk 5127c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root 5128c609719bSwdenkdevice (initial ramdisk, NFS) for your target system. 5129c609719bSwdenk 5130c609719bSwdenk 5131c609719bSwdenkBuilding a Linux Image: 5132c609719bSwdenk----------------------- 5133c609719bSwdenk 513424ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are 513524ee89b9Swdenknot used. If you use recent kernel source, a new build target 513624ee89b9Swdenk"uImage" will exist which automatically builds an image usable by 513724ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target, 513824ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a 513924ee89b9Swdenk100% compatible format. 5140c609719bSwdenk 5141c609719bSwdenkExample: 5142c609719bSwdenk 5143c609719bSwdenk make TQM850L_config 5144c609719bSwdenk make oldconfig 5145c609719bSwdenk make dep 514624ee89b9Swdenk make uImage 5147c609719bSwdenk 514824ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to 514924ee89b9Swdenkencapsulate a compressed Linux kernel image with header information, 515024ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing: 5151c609719bSwdenk 515224ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format): 515324ee89b9Swdenk 515424ee89b9Swdenk* convert the kernel into a raw binary image: 515524ee89b9Swdenk 515624ee89b9Swdenk ${CROSS_COMPILE}-objcopy -O binary \ 515724ee89b9Swdenk -R .note -R .comment \ 515824ee89b9Swdenk -S vmlinux linux.bin 515924ee89b9Swdenk 516024ee89b9Swdenk* compress the binary image: 516124ee89b9Swdenk 516224ee89b9Swdenk gzip -9 linux.bin 516324ee89b9Swdenk 516424ee89b9Swdenk* package compressed binary image for U-Boot: 516524ee89b9Swdenk 516624ee89b9Swdenk mkimage -A ppc -O linux -T kernel -C gzip \ 516724ee89b9Swdenk -a 0 -e 0 -n "Linux Kernel Image" \ 516824ee89b9Swdenk -d linux.bin.gz uImage 516924ee89b9Swdenk 517024ee89b9Swdenk 517124ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use 517224ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or 517324ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64 517424ee89b9Swdenkbyte header containing information about target architecture, 517524ee89b9Swdenkoperating system, image type, compression method, entry points, time 517624ee89b9Swdenkstamp, CRC32 checksums, etc. 517724ee89b9Swdenk 517824ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and 517924ee89b9Swdenkprint the header information, or to build new images. 5180c609719bSwdenk 5181c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information 5182c609719bSwdenkcontained in the header of an existing U-Boot image; this includes 5183c609719bSwdenkchecksum verification: 5184c609719bSwdenk 5185c609719bSwdenk tools/mkimage -l image 5186c609719bSwdenk -l ==> list image header information 5187c609719bSwdenk 5188c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image 5189c609719bSwdenkfrom a "data file" which is used as image payload: 5190c609719bSwdenk 5191c609719bSwdenk tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \ 5192c609719bSwdenk -n name -d data_file image 5193c609719bSwdenk -A ==> set architecture to 'arch' 5194c609719bSwdenk -O ==> set operating system to 'os' 5195c609719bSwdenk -T ==> set image type to 'type' 5196c609719bSwdenk -C ==> set compression type 'comp' 5197c609719bSwdenk -a ==> set load address to 'addr' (hex) 5198c609719bSwdenk -e ==> set entry point to 'ep' (hex) 5199c609719bSwdenk -n ==> set image name to 'name' 5200c609719bSwdenk -d ==> use image data from 'datafile' 5201c609719bSwdenk 520269459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load 520369459791Swdenkaddress (0x00000000), but the entry point address depends on the 520469459791Swdenkkernel version: 5205c609719bSwdenk 5206c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C, 520724ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000. 5208c609719bSwdenk 5209c609719bSwdenkSo a typical call to build a U-Boot image would read: 5210c609719bSwdenk 521124ee89b9Swdenk -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 521224ee89b9Swdenk > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \ 5213a47a12beSStefan Roese > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \ 521424ee89b9Swdenk > examples/uImage.TQM850L 521524ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 5216c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 5217c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 5218c609719bSwdenk Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 5219c609719bSwdenk Load Address: 0x00000000 522024ee89b9Swdenk Entry Point: 0x00000000 5221c609719bSwdenk 5222c609719bSwdenkTo verify the contents of the image (or check for corruption): 5223c609719bSwdenk 522424ee89b9Swdenk -> tools/mkimage -l examples/uImage.TQM850L 522524ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 5226c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 5227c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 5228c609719bSwdenk Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 5229c609719bSwdenk Load Address: 0x00000000 523024ee89b9Swdenk Entry Point: 0x00000000 5231c609719bSwdenk 5232c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade 5233c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this 5234c609719bSwdenkneeds more space in Flash, but boots much faster since it does not 5235c609719bSwdenkneed to be uncompressed: 5236c609719bSwdenk 5237a47a12beSStefan Roese -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz 523824ee89b9Swdenk -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 523924ee89b9Swdenk > -A ppc -O linux -T kernel -C none -a 0 -e 0 \ 5240a47a12beSStefan Roese > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \ 524124ee89b9Swdenk > examples/uImage.TQM850L-uncompressed 524224ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 5243c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 5244c609719bSwdenk Image Type: PowerPC Linux Kernel Image (uncompressed) 5245c609719bSwdenk Data Size: 792160 Bytes = 773.59 kB = 0.76 MB 5246c609719bSwdenk Load Address: 0x00000000 524724ee89b9Swdenk Entry Point: 0x00000000 5248c609719bSwdenk 5249c609719bSwdenk 5250c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file 5251c609719bSwdenkwhen your kernel is intended to use an initial ramdisk: 5252c609719bSwdenk 5253c609719bSwdenk -> tools/mkimage -n 'Simple Ramdisk Image' \ 5254c609719bSwdenk > -A ppc -O linux -T ramdisk -C gzip \ 5255c609719bSwdenk > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd 5256c609719bSwdenk Image Name: Simple Ramdisk Image 5257c609719bSwdenk Created: Wed Jan 12 14:01:50 2000 5258c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 5259c609719bSwdenk Data Size: 566530 Bytes = 553.25 kB = 0.54 MB 5260c609719bSwdenk Load Address: 0x00000000 5261c609719bSwdenk Entry Point: 0x00000000 5262c609719bSwdenk 5263a804b5ceSGuilherme Maciel FerreiraThe "dumpimage" is a tool to disassemble images built by mkimage. Its "-i" 5264a804b5ceSGuilherme Maciel Ferreiraoption performs the converse operation of the mkimage's second form (the "-d" 5265a804b5ceSGuilherme Maciel Ferreiraoption). Given an image built by mkimage, the dumpimage extracts a "data file" 5266a804b5ceSGuilherme Maciel Ferreirafrom the image: 5267a804b5ceSGuilherme Maciel Ferreira 5268a804b5ceSGuilherme Maciel Ferreira tools/dumpimage -i image -p position data_file 5269a804b5ceSGuilherme Maciel Ferreira -i ==> extract from the 'image' a specific 'data_file', \ 5270a804b5ceSGuilherme Maciel Ferreira indexed by 'position' 5271a804b5ceSGuilherme Maciel Ferreira 5272c609719bSwdenk 5273c609719bSwdenkInstalling a Linux Image: 5274c609719bSwdenk------------------------- 5275c609719bSwdenk 5276c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface, 5277c609719bSwdenkyou must convert the image to S-Record format: 5278c609719bSwdenk 5279c609719bSwdenk objcopy -I binary -O srec examples/image examples/image.srec 5280c609719bSwdenk 5281c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot 5282c609719bSwdenkimage header, so the resulting S-Record file will be relative to 5283c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to 5284c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads' 5285c609719bSwdenkcommand. 5286c609719bSwdenk 5287c609719bSwdenkExample: install the image to address 0x40100000 (which on the 5288c609719bSwdenkTQM8xxL is in the first Flash bank): 5289c609719bSwdenk 5290c609719bSwdenk => erase 40100000 401FFFFF 5291c609719bSwdenk 5292c609719bSwdenk .......... done 5293c609719bSwdenk Erased 8 sectors 5294c609719bSwdenk 5295c609719bSwdenk => loads 40100000 5296c609719bSwdenk ## Ready for S-Record download ... 5297c609719bSwdenk ~>examples/image.srec 5298c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 12 13 ... 5299c609719bSwdenk ... 5300c609719bSwdenk 15989 15990 15991 15992 5301c609719bSwdenk [file transfer complete] 5302c609719bSwdenk [connected] 5303c609719bSwdenk ## Start Addr = 0x00000000 5304c609719bSwdenk 5305c609719bSwdenk 5306c609719bSwdenkYou can check the success of the download using the 'iminfo' command; 5307c609719bSwdenkthis includes a checksum verification so you can be sure no data 5308c609719bSwdenkcorruption happened: 5309c609719bSwdenk 5310c609719bSwdenk => imi 40100000 5311c609719bSwdenk 5312c609719bSwdenk ## Checking Image at 40100000 ... 5313c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 5314c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 5315c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 5316c609719bSwdenk Load Address: 00000000 5317c609719bSwdenk Entry Point: 0000000c 5318c609719bSwdenk Verifying Checksum ... OK 5319c609719bSwdenk 5320c609719bSwdenk 5321c609719bSwdenkBoot Linux: 5322c609719bSwdenk----------- 5323c609719bSwdenk 5324c609719bSwdenkThe "bootm" command is used to boot an application that is stored in 5325c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents 5326c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as 5327c609719bSwdenkparameters. You can check and modify this variable using the 5328c609719bSwdenk"printenv" and "setenv" commands: 5329c609719bSwdenk 5330c609719bSwdenk 5331c609719bSwdenk => printenv bootargs 5332c609719bSwdenk bootargs=root=/dev/ram 5333c609719bSwdenk 5334c609719bSwdenk => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 5335c609719bSwdenk 5336c609719bSwdenk => printenv bootargs 5337c609719bSwdenk bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 5338c609719bSwdenk 5339c609719bSwdenk => bootm 40020000 5340c609719bSwdenk ## Booting Linux kernel at 40020000 ... 5341c609719bSwdenk Image Name: 2.2.13 for NFS on TQM850L 5342c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 5343c609719bSwdenk Data Size: 381681 Bytes = 372 kB = 0 MB 5344c609719bSwdenk Load Address: 00000000 5345c609719bSwdenk Entry Point: 0000000c 5346c609719bSwdenk Verifying Checksum ... OK 5347c609719bSwdenk Uncompressing Kernel Image ... OK 5348c609719bSwdenk 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 5349c609719bSwdenk Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 5350c609719bSwdenk time_init: decrementer frequency = 187500000/60 5351c609719bSwdenk Calibrating delay loop... 49.77 BogoMIPS 5352c609719bSwdenk Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000] 5353c609719bSwdenk ... 5354c609719bSwdenk 535511ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass 53567152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT 5357c609719bSwdenkformat!) to the "bootm" command: 5358c609719bSwdenk 5359c609719bSwdenk => imi 40100000 40200000 5360c609719bSwdenk 5361c609719bSwdenk ## Checking Image at 40100000 ... 5362c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 5363c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 5364c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 5365c609719bSwdenk Load Address: 00000000 5366c609719bSwdenk Entry Point: 0000000c 5367c609719bSwdenk Verifying Checksum ... OK 5368c609719bSwdenk 5369c609719bSwdenk ## Checking Image at 40200000 ... 5370c609719bSwdenk Image Name: Simple Ramdisk Image 5371c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 5372c609719bSwdenk Data Size: 566530 Bytes = 553 kB = 0 MB 5373c609719bSwdenk Load Address: 00000000 5374c609719bSwdenk Entry Point: 00000000 5375c609719bSwdenk Verifying Checksum ... OK 5376c609719bSwdenk 5377c609719bSwdenk => bootm 40100000 40200000 5378c609719bSwdenk ## Booting Linux kernel at 40100000 ... 5379c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 5380c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 5381c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 5382c609719bSwdenk Load Address: 00000000 5383c609719bSwdenk Entry Point: 0000000c 5384c609719bSwdenk Verifying Checksum ... OK 5385c609719bSwdenk Uncompressing Kernel Image ... OK 5386c609719bSwdenk ## Loading RAMDisk Image at 40200000 ... 5387c609719bSwdenk Image Name: Simple Ramdisk Image 5388c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 5389c609719bSwdenk Data Size: 566530 Bytes = 553 kB = 0 MB 5390c609719bSwdenk Load Address: 00000000 5391c609719bSwdenk Entry Point: 00000000 5392c609719bSwdenk Verifying Checksum ... OK 5393c609719bSwdenk Loading Ramdisk ... OK 5394c609719bSwdenk 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 5395c609719bSwdenk Boot arguments: root=/dev/ram 5396c609719bSwdenk time_init: decrementer frequency = 187500000/60 5397c609719bSwdenk Calibrating delay loop... 49.77 BogoMIPS 5398c609719bSwdenk ... 5399c609719bSwdenk RAMDISK: Compressed image found at block 0 5400c609719bSwdenk VFS: Mounted root (ext2 filesystem). 5401c609719bSwdenk 5402c609719bSwdenk bash# 5403c609719bSwdenk 54040267768eSMatthew McClintockBoot Linux and pass a flat device tree: 54050267768eSMatthew McClintock----------- 54060267768eSMatthew McClintock 54070267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section 54080267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The 54090267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated 54100267768eSMatthew McClintockflat device tree: 54110267768eSMatthew McClintock 54120267768eSMatthew McClintock=> print oftaddr 54130267768eSMatthew McClintockoftaddr=0x300000 54140267768eSMatthew McClintock=> print oft 54150267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb 54160267768eSMatthew McClintock=> tftp $oftaddr $oft 54170267768eSMatthew McClintockSpeed: 1000, full duplex 54180267768eSMatthew McClintockUsing TSEC0 device 54190267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101 54200267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'. 54210267768eSMatthew McClintockLoad address: 0x300000 54220267768eSMatthew McClintockLoading: # 54230267768eSMatthew McClintockdone 54240267768eSMatthew McClintockBytes transferred = 4106 (100a hex) 54250267768eSMatthew McClintock=> tftp $loadaddr $bootfile 54260267768eSMatthew McClintockSpeed: 1000, full duplex 54270267768eSMatthew McClintockUsing TSEC0 device 54280267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2 54290267768eSMatthew McClintockFilename 'uImage'. 54300267768eSMatthew McClintockLoad address: 0x200000 54310267768eSMatthew McClintockLoading:############ 54320267768eSMatthew McClintockdone 54330267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex) 54340267768eSMatthew McClintock=> print loadaddr 54350267768eSMatthew McClintockloadaddr=200000 54360267768eSMatthew McClintock=> print oftaddr 54370267768eSMatthew McClintockoftaddr=0x300000 54380267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr 54390267768eSMatthew McClintock## Booting image at 00200000 ... 54400267768eSMatthew McClintock Image Name: Linux-2.6.17-dirty 54410267768eSMatthew McClintock Image Type: PowerPC Linux Kernel Image (gzip compressed) 54420267768eSMatthew McClintock Data Size: 1029343 Bytes = 1005.2 kB 54430267768eSMatthew McClintock Load Address: 00000000 54440267768eSMatthew McClintock Entry Point: 00000000 54450267768eSMatthew McClintock Verifying Checksum ... OK 54460267768eSMatthew McClintock Uncompressing Kernel Image ... OK 54470267768eSMatthew McClintockBooting using flat device tree at 0x300000 54480267768eSMatthew McClintockUsing MPC85xx ADS machine description 54490267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb 54500267768eSMatthew McClintock[snip] 54510267768eSMatthew McClintock 54520267768eSMatthew McClintock 54536069ff26SwdenkMore About U-Boot Image Types: 54546069ff26Swdenk------------------------------ 54556069ff26Swdenk 54566069ff26SwdenkU-Boot supports the following image types: 54576069ff26Swdenk 54586069ff26Swdenk "Standalone Programs" are directly runnable in the environment 54596069ff26Swdenk provided by U-Boot; it is expected that (if they behave 54606069ff26Swdenk well) you can continue to work in U-Boot after return from 54616069ff26Swdenk the Standalone Program. 54626069ff26Swdenk "OS Kernel Images" are usually images of some Embedded OS which 54636069ff26Swdenk will take over control completely. Usually these programs 54646069ff26Swdenk will install their own set of exception handlers, device 54656069ff26Swdenk drivers, set up the MMU, etc. - this means, that you cannot 54666069ff26Swdenk expect to re-enter U-Boot except by resetting the CPU. 54676069ff26Swdenk "RAMDisk Images" are more or less just data blocks, and their 54686069ff26Swdenk parameters (address, size) are passed to an OS kernel that is 54696069ff26Swdenk being started. 54706069ff26Swdenk "Multi-File Images" contain several images, typically an OS 54716069ff26Swdenk (Linux) kernel image and one or more data images like 54726069ff26Swdenk RAMDisks. This construct is useful for instance when you want 54736069ff26Swdenk to boot over the network using BOOTP etc., where the boot 54746069ff26Swdenk server provides just a single image file, but you want to get 54756069ff26Swdenk for instance an OS kernel and a RAMDisk image. 54766069ff26Swdenk 54776069ff26Swdenk "Multi-File Images" start with a list of image sizes, each 54786069ff26Swdenk image size (in bytes) specified by an "uint32_t" in network 54796069ff26Swdenk byte order. This list is terminated by an "(uint32_t)0". 54806069ff26Swdenk Immediately after the terminating 0 follow the images, one by 54816069ff26Swdenk one, all aligned on "uint32_t" boundaries (size rounded up to 54826069ff26Swdenk a multiple of 4 bytes). 54836069ff26Swdenk 54846069ff26Swdenk "Firmware Images" are binary images containing firmware (like 54856069ff26Swdenk U-Boot or FPGA images) which usually will be programmed to 54866069ff26Swdenk flash memory. 54876069ff26Swdenk 54886069ff26Swdenk "Script files" are command sequences that will be executed by 54896069ff26Swdenk U-Boot's command interpreter; this feature is especially 54906069ff26Swdenk useful when you configure U-Boot to use a real shell (hush) 54916069ff26Swdenk as command interpreter. 54926069ff26Swdenk 549344f074c7SMarek VasutBooting the Linux zImage: 549444f074c7SMarek Vasut------------------------- 549544f074c7SMarek Vasut 549644f074c7SMarek VasutOn some platforms, it's possible to boot Linux zImage. This is done 549744f074c7SMarek Vasutusing the "bootz" command. The syntax of "bootz" command is the same 549844f074c7SMarek Vasutas the syntax of "bootm" command. 549944f074c7SMarek Vasut 55008ac28563STom RiniNote, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply 5501017e1f3fSMarek Vasutkernel with raw initrd images. The syntax is slightly different, the 5502017e1f3fSMarek Vasutaddress of the initrd must be augmented by it's size, in the following 5503017e1f3fSMarek Vasutformat: "<initrd addres>:<initrd size>". 5504017e1f3fSMarek Vasut 5505c609719bSwdenk 5506c609719bSwdenkStandalone HOWTO: 5507c609719bSwdenk================= 5508c609719bSwdenk 5509c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and 5510c609719bSwdenkrun "standalone" applications, which can use some resources of 5511c609719bSwdenkU-Boot like console I/O functions or interrupt services. 5512c609719bSwdenk 5513c609719bSwdenkTwo simple examples are included with the sources: 5514c609719bSwdenk 5515c609719bSwdenk"Hello World" Demo: 5516c609719bSwdenk------------------- 5517c609719bSwdenk 5518c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo 5519c609719bSwdenkapplication; it is automatically compiled when you build U-Boot. 5520c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it 5521c609719bSwdenklike that: 5522c609719bSwdenk 5523c609719bSwdenk => loads 5524c609719bSwdenk ## Ready for S-Record download ... 5525c609719bSwdenk ~>examples/hello_world.srec 5526c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 ... 5527c609719bSwdenk [file transfer complete] 5528c609719bSwdenk [connected] 5529c609719bSwdenk ## Start Addr = 0x00040004 5530c609719bSwdenk 5531c609719bSwdenk => go 40004 Hello World! This is a test. 5532c609719bSwdenk ## Starting application at 0x00040004 ... 5533c609719bSwdenk Hello World 5534c609719bSwdenk argc = 7 5535c609719bSwdenk argv[0] = "40004" 5536c609719bSwdenk argv[1] = "Hello" 5537c609719bSwdenk argv[2] = "World!" 5538c609719bSwdenk argv[3] = "This" 5539c609719bSwdenk argv[4] = "is" 5540c609719bSwdenk argv[5] = "a" 5541c609719bSwdenk argv[6] = "test." 5542c609719bSwdenk argv[7] = "<NULL>" 5543c609719bSwdenk Hit any key to exit ... 5544c609719bSwdenk 5545c609719bSwdenk ## Application terminated, rc = 0x0 5546c609719bSwdenk 5547c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt 5548c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'. 5549c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second. 5550c609719bSwdenkThe interrupt service routine is trivial, just printing a '.' 5551c609719bSwdenkcharacter, but this is just a demo program. The application can be 5552c609719bSwdenkcontrolled by the following keys: 5553c609719bSwdenk 5554c609719bSwdenk ? - print current values og the CPM Timer registers 5555c609719bSwdenk b - enable interrupts and start timer 5556c609719bSwdenk e - stop timer and disable interrupts 5557c609719bSwdenk q - quit application 5558c609719bSwdenk 5559c609719bSwdenk => loads 5560c609719bSwdenk ## Ready for S-Record download ... 5561c609719bSwdenk ~>examples/timer.srec 5562c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 ... 5563c609719bSwdenk [file transfer complete] 5564c609719bSwdenk [connected] 5565c609719bSwdenk ## Start Addr = 0x00040004 5566c609719bSwdenk 5567c609719bSwdenk => go 40004 5568c609719bSwdenk ## Starting application at 0x00040004 ... 5569c609719bSwdenk TIMERS=0xfff00980 5570c609719bSwdenk Using timer 1 5571c609719bSwdenk tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0 5572c609719bSwdenk 5573c609719bSwdenkHit 'b': 5574c609719bSwdenk [q, b, e, ?] Set interval 1000000 us 5575c609719bSwdenk Enabling timer 5576c609719bSwdenkHit '?': 5577c609719bSwdenk [q, b, e, ?] ........ 5578c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0 5579c609719bSwdenkHit '?': 5580c609719bSwdenk [q, b, e, ?] . 5581c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0 5582c609719bSwdenkHit '?': 5583c609719bSwdenk [q, b, e, ?] . 5584c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0 5585c609719bSwdenkHit '?': 5586c609719bSwdenk [q, b, e, ?] . 5587c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0 5588c609719bSwdenkHit 'e': 5589c609719bSwdenk [q, b, e, ?] ...Stopping timer 5590c609719bSwdenkHit 'q': 5591c609719bSwdenk [q, b, e, ?] ## Application terminated, rc = 0x0 5592c609719bSwdenk 5593c609719bSwdenk 559485ec0bccSwdenkMinicom warning: 559585ec0bccSwdenk================ 559685ec0bccSwdenk 55977152b1d0SwdenkOver time, many people have reported problems when trying to use the 559885ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd) 559985ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under 5600f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and 560185ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and 5602e53515a2SKarl O. Pincuse "cu" for S-Record download ("loads" command). See 5603e53515a2SKarl O. Pinchttp://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3. 5604e53515a2SKarl O. Pincfor help with kermit. 5605e53515a2SKarl O. Pinc 560685ec0bccSwdenk 560752f52c14SwdenkNevertheless, if you absolutely want to use it try adding this 560852f52c14Swdenkconfiguration to your "File transfer protocols" section: 560952f52c14Swdenk 561052f52c14Swdenk Name Program Name U/D FullScr IO-Red. Multi 561152f52c14Swdenk X kermit /usr/bin/kermit -i -l %l -s Y U Y N N 561252f52c14Swdenk Y kermit /usr/bin/kermit -i -l %l -r N D Y N N 561352f52c14Swdenk 561452f52c14Swdenk 5615c609719bSwdenkNetBSD Notes: 5616c609719bSwdenk============= 5617c609719bSwdenk 5618c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host 5619c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx). 5620c609719bSwdenk 5621c609719bSwdenkBuilding requires a cross environment; it is known to work on 5622c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also 5623c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make). 5624c609719bSwdenkNote that the cross-powerpc package does not install include files; 5625c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is 5626c609719bSwdenkmissing. This file has to be installed and patched manually: 5627c609719bSwdenk 5628c609719bSwdenk # cd /usr/pkg/cross/powerpc-netbsd/include 5629c609719bSwdenk # mkdir powerpc 5630c609719bSwdenk # ln -s powerpc machine 5631c609719bSwdenk # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h 5632c609719bSwdenk # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST 5633c609719bSwdenk 5634c609719bSwdenkNative builds *don't* work due to incompatibilities between native 5635c609719bSwdenkand U-Boot include files. 5636c609719bSwdenk 5637c609719bSwdenkBooting assumes that (the first part of) the image booted is a 5638c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel 5639c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source 5640c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the 56412a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz 5642c609719bSwdenk 5643c609719bSwdenk 5644c609719bSwdenkImplementation Internals: 5645c609719bSwdenk========================= 5646c609719bSwdenk 5647c609719bSwdenkThe following is not intended to be a complete description of every 5648c609719bSwdenkimplementation detail. However, it should help to understand the 5649c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom 5650c609719bSwdenkhardware. 5651c609719bSwdenk 5652c609719bSwdenk 5653c609719bSwdenkInitial Stack, Global Data: 5654c609719bSwdenk--------------------------- 5655c609719bSwdenk 5656c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot 5657c609719bSwdenkstarts running out of ROM (flash memory), usually without access to 5658c609719bSwdenksystem RAM (because the memory controller is not initialized yet). 5659c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS 5660c609719bSwdenkis not initialized as zero. To be able to get a C environment working 5661c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation 5662c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU 5663c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and 5664c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be 5665c609719bSwdenklocked as (mis-) used as memory, etc. 5666c609719bSwdenk 56677152b1d0Swdenk Chris Hallinan posted a good summary of these issues to the 56680668236bSWolfgang Denk U-Boot mailing list: 566943d9616cSwdenk 567043d9616cSwdenk Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)? 567143d9616cSwdenk From: "Chris Hallinan" <clh@net1plus.com> 567243d9616cSwdenk Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET) 567343d9616cSwdenk ... 567443d9616cSwdenk 567543d9616cSwdenk Correct me if I'm wrong, folks, but the way I understand it 567643d9616cSwdenk is this: Using DCACHE as initial RAM for Stack, etc, does not 567743d9616cSwdenk require any physical RAM backing up the cache. The cleverness 567843d9616cSwdenk is that the cache is being used as a temporary supply of 567943d9616cSwdenk necessary storage before the SDRAM controller is setup. It's 568011ccc33fSMarcel Ziswiler beyond the scope of this list to explain the details, but you 568143d9616cSwdenk can see how this works by studying the cache architecture and 568243d9616cSwdenk operation in the architecture and processor-specific manuals. 568343d9616cSwdenk 568443d9616cSwdenk OCM is On Chip Memory, which I believe the 405GP has 4K. It 568543d9616cSwdenk is another option for the system designer to use as an 568611ccc33fSMarcel Ziswiler initial stack/RAM area prior to SDRAM being available. Either 568743d9616cSwdenk option should work for you. Using CS 4 should be fine if your 568843d9616cSwdenk board designers haven't used it for something that would 568943d9616cSwdenk cause you grief during the initial boot! It is frequently not 569043d9616cSwdenk used. 569143d9616cSwdenk 56926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere 569343d9616cSwdenk with your processor/board/system design. The default value 569443d9616cSwdenk you will find in any recent u-boot distribution in 56958a316c9bSStefan Roese walnut.h should work for you. I'd set it to a value larger 569643d9616cSwdenk than your SDRAM module. If you have a 64MB SDRAM module, set 569743d9616cSwdenk it above 400_0000. Just make sure your board has no resources 569843d9616cSwdenk that are supposed to respond to that address! That code in 569943d9616cSwdenk start.S has been around a while and should work as is when 570043d9616cSwdenk you get the config right. 570143d9616cSwdenk 570243d9616cSwdenk -Chris Hallinan 570343d9616cSwdenk DS4.COM, Inc. 570443d9616cSwdenk 5705c609719bSwdenkIt is essential to remember this, since it has some impact on the C 5706c609719bSwdenkcode for the initialization procedures: 5707c609719bSwdenk 5708c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt 5709c609719bSwdenk to write it. 5710c609719bSwdenk 571111ccc33fSMarcel Ziswiler* Do not use any uninitialized global data (or implicitely initialized 5712c609719bSwdenk as zero data - BSS segment) at all - this is undefined, initiali- 57137152b1d0Swdenk zation is performed later (when relocating to RAM). 5714c609719bSwdenk 5715c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like 5716c609719bSwdenk that. 5717c609719bSwdenk 5718c609719bSwdenkHaving only the stack as writable memory limits means we cannot use 5719c609719bSwdenknormal global data to share information beween the code. But it 5720c609719bSwdenkturned out that the implementation of U-Boot can be greatly 5721c609719bSwdenksimplified by making a global data structure (gd_t) available to all 5722c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_ 5723c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of 5724c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we 5725c609719bSwdenkplace a pointer (gd) to the global data into a register which we 5726c609719bSwdenkreserve for this purpose. 5727c609719bSwdenk 57287152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the 5729c609719bSwdenkrelevant (E)ABI specifications for the current architecture, and by 5730c609719bSwdenkGCC's implementation. 5731c609719bSwdenk 5732c609719bSwdenkFor PowerPC, the following registers have specific use: 5733c609719bSwdenk R1: stack pointer 5734e7670f6cSWolfgang Denk R2: reserved for system use 5735c609719bSwdenk R3-R4: parameter passing and return values 5736c609719bSwdenk R5-R10: parameter passing 5737c609719bSwdenk R13: small data area pointer 5738c609719bSwdenk R30: GOT pointer 5739c609719bSwdenk R31: frame pointer 5740c609719bSwdenk 5741e6bee808SJoakim Tjernlund (U-Boot also uses R12 as internal GOT pointer. r12 5742e6bee808SJoakim Tjernlund is a volatile register so r12 needs to be reset when 5743e6bee808SJoakim Tjernlund going back and forth between asm and C) 5744c609719bSwdenk 5745e7670f6cSWolfgang Denk ==> U-Boot will use R2 to hold a pointer to the global data 5746c609719bSwdenk 5747c609719bSwdenk Note: on PPC, we could use a static initializer (since the 5748c609719bSwdenk address of the global data structure is known at compile time), 5749c609719bSwdenk but it turned out that reserving a register results in somewhat 5750c609719bSwdenk smaller code - although the code savings are not that big (on 5751c609719bSwdenk average for all boards 752 bytes for the whole U-Boot image, 5752c609719bSwdenk 624 text + 127 data). 5753c609719bSwdenk 5754c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here: 57554c58eb55SMike Frysinger http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface 57564c58eb55SMike Frysinger 5757c4db335cSRobin Getz ==> U-Boot will use P3 to hold a pointer to the global data 57584c58eb55SMike Frysinger 5759c609719bSwdenkOn ARM, the following registers are used: 5760c609719bSwdenk 5761c609719bSwdenk R0: function argument word/integer result 5762c609719bSwdenk R1-R3: function argument word 576312eba1b4SJeroen Hofstee R9: platform specific 576412eba1b4SJeroen Hofstee R10: stack limit (used only if stack checking is enabled) 5765c609719bSwdenk R11: argument (frame) pointer 5766c609719bSwdenk R12: temporary workspace 5767c609719bSwdenk R13: stack pointer 5768c609719bSwdenk R14: link register 5769c609719bSwdenk R15: program counter 5770c609719bSwdenk 577112eba1b4SJeroen Hofstee ==> U-Boot will use R9 to hold a pointer to the global data 577212eba1b4SJeroen Hofstee 577312eba1b4SJeroen Hofstee Note: on ARM, only R_ARM_RELATIVE relocations are supported. 5774c609719bSwdenk 57750df01fd3SThomas ChouOn Nios II, the ABI is documented here: 57760df01fd3SThomas Chou http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf 57770df01fd3SThomas Chou 57780df01fd3SThomas Chou ==> U-Boot will use gp to hold a pointer to the global data 57790df01fd3SThomas Chou 57800df01fd3SThomas Chou Note: on Nios II, we give "-G0" option to gcc and don't use gp 57810df01fd3SThomas Chou to access small data sections, so gp is free. 57820df01fd3SThomas Chou 5783afc1ce82SMacpaul LinOn NDS32, the following registers are used: 5784afc1ce82SMacpaul Lin 5785afc1ce82SMacpaul Lin R0-R1: argument/return 5786afc1ce82SMacpaul Lin R2-R5: argument 5787afc1ce82SMacpaul Lin R15: temporary register for assembler 5788afc1ce82SMacpaul Lin R16: trampoline register 5789afc1ce82SMacpaul Lin R28: frame pointer (FP) 5790afc1ce82SMacpaul Lin R29: global pointer (GP) 5791afc1ce82SMacpaul Lin R30: link register (LP) 5792afc1ce82SMacpaul Lin R31: stack pointer (SP) 5793afc1ce82SMacpaul Lin PC: program counter (PC) 5794afc1ce82SMacpaul Lin 5795afc1ce82SMacpaul Lin ==> U-Boot will use R10 to hold a pointer to the global data 5796afc1ce82SMacpaul Lin 5797d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope, 5798d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much. 5799c609719bSwdenk 5800c609719bSwdenkMemory Management: 5801c609719bSwdenk------------------ 5802c609719bSwdenk 5803c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the 5804c609719bSwdenkMMU is not used either for address mapping nor for memory protection. 5805c609719bSwdenk 5806c609719bSwdenkThe available memory is mapped to fixed addresses using the memory 5807c609719bSwdenkcontroller. In this process, a contiguous block is formed for each 5808c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several 5809c609719bSwdenkphysical memory banks. 5810c609719bSwdenk 5811c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on 5812c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After 5813c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself 5814c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some 58156d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN 5816c609719bSwdenkconfiguration setting]. Below that, a structure with global Board 5817c609719bSwdenkInfo data is placed, followed by the stack (growing downward). 5818c609719bSwdenk 5819c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB 5820c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF). 5821c609719bSwdenk 5822c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like 5823c609719bSwdenkthis: 5824c609719bSwdenk 5825c609719bSwdenk 0x0000 0000 Exception Vector code 5826c609719bSwdenk : 5827c609719bSwdenk 0x0000 1FFF 5828c609719bSwdenk 0x0000 2000 Free for Application Use 5829c609719bSwdenk : 5830c609719bSwdenk : 5831c609719bSwdenk 5832c609719bSwdenk : 5833c609719bSwdenk : 5834c609719bSwdenk 0x00FB FF20 Monitor Stack (Growing downward) 5835c609719bSwdenk 0x00FB FFAC Board Info Data and permanent copy of global data 5836c609719bSwdenk 0x00FC 0000 Malloc Arena 5837c609719bSwdenk : 5838c609719bSwdenk 0x00FD FFFF 5839c609719bSwdenk 0x00FE 0000 RAM Copy of Monitor Code 5840c609719bSwdenk ... eventually: LCD or video framebuffer 5841c609719bSwdenk ... eventually: pRAM (Protected RAM - unchanged by reset) 5842c609719bSwdenk 0x00FF FFFF [End of RAM] 5843c609719bSwdenk 5844c609719bSwdenk 5845c609719bSwdenkSystem Initialization: 5846c609719bSwdenk---------------------- 5847c609719bSwdenk 5848c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point 584911ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset 5850c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory. 58517152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address. 5852c609719bSwdenkTo be able to implement the initialization code in C, a (small!) 5853c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs 5854c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked 5855c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core, 5856c609719bSwdenkthe caches and the SIU. 5857c609719bSwdenk 5858c609719bSwdenkNext, all (potentially) available memory banks are mapped using a 5859c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries 5860c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash 5861c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is 5862c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a 5863c609719bSwdenksimple memory test is run that determines the size of the SDRAM 5864c609719bSwdenkbanks. 5865c609719bSwdenk 5866c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of 58677152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first 5868c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address 5869c609719bSwdenk0x00000000, with any additional banks following immediately to create 5870c609719bSwdenkcontiguous memory starting from 0. 5871c609719bSwdenk 5872c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area 5873c609719bSwdenkand allocates memory for use by malloc() and for the global Board 5874c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM 5875c609719bSwdenkpages, and the final stack is set up. 5876c609719bSwdenk 5877c609719bSwdenkOnly after this relocation will you have a "normal" C environment; 5878c609719bSwdenkuntil that you are restricted in several ways, mostly because you are 5879c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a 5880c609719bSwdenknew address in RAM. 5881c609719bSwdenk 5882c609719bSwdenk 5883c609719bSwdenkU-Boot Porting Guide: 5884c609719bSwdenk---------------------- 5885c609719bSwdenk 5886c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing 58876aff3115Swdenklist, October 2002] 5888c609719bSwdenk 5889c609719bSwdenk 5890c609719bSwdenkint main(int argc, char *argv[]) 5891c609719bSwdenk{ 5892c609719bSwdenk sighandler_t no_more_time; 5893c609719bSwdenk 5894c609719bSwdenk signal(SIGALRM, no_more_time); 5895c609719bSwdenk alarm(PROJECT_DEADLINE - toSec (3 * WEEK)); 5896c609719bSwdenk 5897c609719bSwdenk if (available_money > available_manpower) { 58986c3fef28SJerry Van Baren Pay consultant to port U-Boot; 5899c609719bSwdenk return 0; 5900c609719bSwdenk } 5901c609719bSwdenk 5902c609719bSwdenk Download latest U-Boot source; 5903c609719bSwdenk 59040668236bSWolfgang Denk Subscribe to u-boot mailing list; 59056aff3115Swdenk 59066c3fef28SJerry Van Baren if (clueless) 5907c609719bSwdenk email("Hi, I am new to U-Boot, how do I get started?"); 5908c609719bSwdenk 5909c609719bSwdenk while (learning) { 5910c609719bSwdenk Read the README file in the top level directory; 59117cb22f97Swdenk Read http://www.denx.de/twiki/bin/view/DULG/Manual; 59126c3fef28SJerry Van Baren Read applicable doc/*.README; 5913c609719bSwdenk Read the source, Luke; 59146c3fef28SJerry Van Baren /* find . -name "*.[chS]" | xargs grep -i <keyword> */ 5915c609719bSwdenk } 5916c609719bSwdenk 59176c3fef28SJerry Van Baren if (available_money > toLocalCurrency ($2500)) 59186c3fef28SJerry Van Baren Buy a BDI3000; 59196c3fef28SJerry Van Baren else 5920c609719bSwdenk Add a lot of aggravation and time; 5921c609719bSwdenk 59226c3fef28SJerry Van Baren if (a similar board exists) { /* hopefully... */ 59236c3fef28SJerry Van Baren cp -a board/<similar> board/<myboard> 59246c3fef28SJerry Van Baren cp include/configs/<similar>.h include/configs/<myboard>.h 59256c3fef28SJerry Van Baren } else { 5926c609719bSwdenk Create your own board support subdirectory; 59276c3fef28SJerry Van Baren Create your own board include/configs/<myboard>.h file; 59286c3fef28SJerry Van Baren } 59296c3fef28SJerry Van Baren Edit new board/<myboard> files 59306c3fef28SJerry Van Baren Edit new include/configs/<myboard>.h 5931c609719bSwdenk 59326c3fef28SJerry Van Baren while (!accepted) { 5933c609719bSwdenk while (!running) { 5934c609719bSwdenk do { 5935c609719bSwdenk Add / modify source code; 5936c609719bSwdenk } until (compiles); 5937c609719bSwdenk Debug; 5938c609719bSwdenk if (clueless) 5939c609719bSwdenk email("Hi, I am having problems..."); 5940c609719bSwdenk } 59416c3fef28SJerry Van Baren Send patch file to the U-Boot email list; 59426c3fef28SJerry Van Baren if (reasonable critiques) 59436c3fef28SJerry Van Baren Incorporate improvements from email list code review; 59446c3fef28SJerry Van Baren else 59456c3fef28SJerry Van Baren Defend code as written; 59466c3fef28SJerry Van Baren } 5947c609719bSwdenk 5948c609719bSwdenk return 0; 5949c609719bSwdenk} 5950c609719bSwdenk 5951c609719bSwdenkvoid no_more_time (int sig) 5952c609719bSwdenk{ 5953c609719bSwdenk hire_a_guru(); 5954c609719bSwdenk} 5955c609719bSwdenk 5956c609719bSwdenk 5957c609719bSwdenkCoding Standards: 5958c609719bSwdenk----------------- 5959c609719bSwdenk 5960c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel 59612c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script 59627ca9296eSWolfgang Denk"scripts/Lindent" in your Linux kernel source directory. 5963c609719bSwdenk 59642c051651SDetlev ZundelSource files originating from a different project (for example the 59652c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not 59662c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those 59672c051651SDetlev Zundelsources. 59682c051651SDetlev Zundel 59692c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in 59702c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//) 59712c051651SDetlev Zundelin your code. 5972c609719bSwdenk 5973c178d3daSwdenkPlease also stick to the following formatting rules: 5974180d3f74Swdenk- remove any trailing white space 59757ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces 5976180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds 59777ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files 5978180d3f74Swdenk- do not add trailing empty lines to source files 5979180d3f74Swdenk 5980c609719bSwdenkSubmissions which do not conform to the standards may be returned 5981c609719bSwdenkwith a request to reformat the changes. 5982c609719bSwdenk 5983c609719bSwdenk 5984c609719bSwdenkSubmitting Patches: 5985c609719bSwdenk------------------- 5986c609719bSwdenk 5987c609719bSwdenkSince the number of patches for U-Boot is growing, we need to 5988c609719bSwdenkestablish some rules. Submissions which do not conform to these rules 5989c609719bSwdenkmay be rejected, even when they contain important and valuable stuff. 5990c609719bSwdenk 59910d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details. 5992218ca724SWolfgang Denk 59930668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>; 59940668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot 59950668236bSWolfgang Denk 5996c609719bSwdenkWhen you send a patch, please include the following information with 5997c609719bSwdenkit: 5998c609719bSwdenk 5999c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes 6000c609719bSwdenk this bug. Please try to include a way of demonstrating that the 6001c609719bSwdenk patch actually fixes something. 6002c609719bSwdenk 6003c609719bSwdenk* For new features: a description of the feature and your 6004c609719bSwdenk implementation. 6005c609719bSwdenk 6006c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch) 6007c609719bSwdenk 6008c609719bSwdenk* For major contributions, your entry to the CREDITS file 6009c609719bSwdenk 601027af930eSAlbert ARIBAUD* When you add support for a new board, don't forget to add a 601127af930eSAlbert ARIBAUD maintainer e-mail address to the boards.cfg file, too. 6012c609719bSwdenk 6013c609719bSwdenk* If your patch adds new configuration options, don't forget to 6014c609719bSwdenk document these in the README file. 6015c609719bSwdenk 6016218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly* 6017218ca724SWolfgang Denk recommended) you can easily generate the patch using the 60187ca9296eSWolfgang Denk "git format-patch". If you then use "git send-email" to send it to 6019218ca724SWolfgang Denk the U-Boot mailing list, you will avoid most of the common problems 6020218ca724SWolfgang Denk with some other mail clients. 6021c609719bSwdenk 6022218ca724SWolfgang Denk If you cannot use git, use "diff -purN OLD NEW". If your version of 6023218ca724SWolfgang Denk diff does not support these options, then get the latest version of 6024218ca724SWolfgang Denk GNU diff. 60256dff5529Swdenk 6026218ca724SWolfgang Denk The current directory when running this command shall be the parent 6027218ca724SWolfgang Denk directory of the U-Boot source tree (i. e. please make sure that 6028218ca724SWolfgang Denk your patch includes sufficient directory information for the 6029218ca724SWolfgang Denk affected files). 6030218ca724SWolfgang Denk 6031218ca724SWolfgang Denk We prefer patches as plain text. MIME attachments are discouraged, 6032218ca724SWolfgang Denk and compressed attachments must not be used. 6033c609719bSwdenk 603452f52c14Swdenk* If one logical set of modifications affects or creates several 603552f52c14Swdenk files, all these changes shall be submitted in a SINGLE patch file. 603652f52c14Swdenk 603752f52c14Swdenk* Changesets that contain different, unrelated modifications shall be 603852f52c14Swdenk submitted as SEPARATE patches, one patch per changeset. 603952f52c14Swdenk 604052f52c14Swdenk 6041c609719bSwdenkNotes: 6042c609719bSwdenk 6043c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched 6044c609719bSwdenk source tree and make sure that no errors or warnings are reported 6045c609719bSwdenk for any of the boards. 6046c609719bSwdenk 6047c609719bSwdenk* Keep your modifications to the necessary minimum: A patch 6048c609719bSwdenk containing several unrelated changes or arbitrary reformats will be 6049c609719bSwdenk returned with a request to re-formatting / split it. 6050c609719bSwdenk 6051c609719bSwdenk* If you modify existing code, make sure that your new code does not 6052c609719bSwdenk add to the memory footprint of the code ;-) Small is beautiful! 6053c609719bSwdenk When adding new features, these should compile conditionally only 6054c609719bSwdenk (using #ifdef), and the resulting code with the new feature 6055c609719bSwdenk disabled must not need more memory than the old code without your 6056c609719bSwdenk modification. 605790dc6704Swdenk 60580668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the 60590668236bSWolfgang Denk u-boot mailing list. Bigger patches will be moderated. If they are 60600668236bSWolfgang Denk reasonable and not too big, they will be acknowledged. But patches 60610668236bSWolfgang Denk bigger than the size limit should be avoided. 6062