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 1356eae68e4SMasahiro Yamada /arc Files generic to ARC architecture 1366eae68e4SMasahiro Yamada /cpu CPU specific files 1376eae68e4SMasahiro Yamada /arc700 Files specific to ARC 700 CPUs 1386eae68e4SMasahiro Yamada /lib Architecture specific library files 1398d321b81SPeter Tyser /arm Files generic to ARM architecture 1408d321b81SPeter Tyser /cpu CPU specific files 1418d321b81SPeter Tyser /arm720t Files specific to ARM 720 CPUs 1428d321b81SPeter Tyser /arm920t Files specific to ARM 920 CPUs 1436eb0921aSAndreas Bießmann /at91 Files specific to Atmel AT91RM9200 CPU 1448d321b81SPeter Tyser /imx Files specific to Freescale MC9328 i.MX CPUs 1458d321b81SPeter Tyser /s3c24x0 Files specific to Samsung S3C24X0 CPUs 1468d321b81SPeter Tyser /arm926ejs Files specific to ARM 926 CPUs 1478d321b81SPeter Tyser /arm1136 Files specific to ARM 1136 CPUs 1488d321b81SPeter Tyser /pxa Files specific to Intel XScale PXA CPUs 1498d321b81SPeter Tyser /sa1100 Files specific to Intel StrongARM SA1100 CPUs 1508d321b81SPeter Tyser /lib Architecture specific library files 1518d321b81SPeter Tyser /avr32 Files generic to AVR32 architecture 1528d321b81SPeter Tyser /cpu CPU specific files 1538d321b81SPeter Tyser /lib Architecture specific library files 1548d321b81SPeter Tyser /blackfin Files generic to Analog Devices Blackfin architecture 1558d321b81SPeter Tyser /cpu CPU specific files 1568d321b81SPeter Tyser /lib Architecture specific library files 1578d321b81SPeter Tyser /m68k Files generic to m68k architecture 1588d321b81SPeter Tyser /cpu CPU specific files 1598d321b81SPeter Tyser /mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs 1608d321b81SPeter Tyser /mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs 1618d321b81SPeter Tyser /mcf532x Files specific to Freescale ColdFire MCF5329 CPUs 1628d321b81SPeter Tyser /mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs 1638d321b81SPeter Tyser /mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs 1648d321b81SPeter Tyser /lib Architecture specific library files 1658d321b81SPeter Tyser /microblaze Files generic to microblaze architecture 1668d321b81SPeter Tyser /cpu CPU specific files 1678d321b81SPeter Tyser /lib Architecture specific library files 1688d321b81SPeter Tyser /mips Files generic to MIPS architecture 1698d321b81SPeter Tyser /cpu CPU specific files 17092bbd64eSDaniel Schwierzeck /mips32 Files specific to MIPS32 CPUs 1716eae68e4SMasahiro Yamada /mips64 Files specific to MIPS64 CPUs 1728d321b81SPeter Tyser /lib Architecture specific library files 173afc1ce82SMacpaul Lin /nds32 Files generic to NDS32 architecture 174afc1ce82SMacpaul Lin /cpu CPU specific files 175afc1ce82SMacpaul Lin /n1213 Files specific to Andes Technology N1213 CPUs 176afc1ce82SMacpaul Lin /lib Architecture specific library files 1778d321b81SPeter Tyser /nios2 Files generic to Altera NIOS2 architecture 1788d321b81SPeter Tyser /cpu CPU specific files 1798d321b81SPeter Tyser /lib Architecture specific library files 18033c7731bSRobert P. J. Day /openrisc Files generic to OpenRISC architecture 18133c7731bSRobert P. J. Day /cpu CPU specific files 18233c7731bSRobert P. J. Day /lib Architecture specific library files 183a47a12beSStefan Roese /powerpc Files generic to PowerPC architecture 1848d321b81SPeter Tyser /cpu CPU specific files 1858d321b81SPeter Tyser /mpc5xx Files specific to Freescale MPC5xx CPUs 1868d321b81SPeter Tyser /mpc5xxx Files specific to Freescale MPC5xxx CPUs 1878d321b81SPeter Tyser /mpc8xx Files specific to Freescale MPC8xx CPUs 1888d321b81SPeter Tyser /mpc8260 Files specific to Freescale MPC8260 CPUs 1898d321b81SPeter Tyser /mpc85xx Files specific to Freescale MPC85xx CPUs 1908d321b81SPeter Tyser /ppc4xx Files specific to AMCC PowerPC 4xx CPUs 1918d321b81SPeter Tyser /lib Architecture specific library files 1928d321b81SPeter Tyser /sh Files generic to SH architecture 1938d321b81SPeter Tyser /cpu CPU specific files 1948d321b81SPeter Tyser /sh2 Files specific to sh2 CPUs 1958d321b81SPeter Tyser /sh3 Files specific to sh3 CPUs 1968d321b81SPeter Tyser /sh4 Files specific to sh4 CPUs 1978d321b81SPeter Tyser /lib Architecture specific library files 1988d321b81SPeter Tyser /sparc Files generic to SPARC architecture 1998d321b81SPeter Tyser /cpu CPU specific files 2008d321b81SPeter Tyser /leon2 Files specific to Gaisler LEON2 SPARC CPU 2018d321b81SPeter Tyser /leon3 Files specific to Gaisler LEON3 SPARC CPU 2028d321b81SPeter Tyser /lib Architecture specific library files 20333c7731bSRobert P. J. Day /x86 Files generic to x86 architecture 20433c7731bSRobert P. J. Day /cpu CPU specific files 20533c7731bSRobert P. J. Day /lib Architecture specific library files 2068d321b81SPeter Tyser/api Machine/arch independent API for external apps 2078d321b81SPeter Tyser/board Board dependent files 2088d321b81SPeter Tyser/common Misc architecture independent functions 2098d321b81SPeter Tyser/disk Code for disk drive partition handling 2108d321b81SPeter Tyser/doc Documentation (don't expect too much) 2118d321b81SPeter Tyser/drivers Commonly used device drivers 21233c7731bSRobert P. J. Day/dts Contains Makefile for building internal U-Boot fdt. 2138d321b81SPeter Tyser/examples Example code for standalone applications, etc. 2148d321b81SPeter Tyser/fs Filesystem code (cramfs, ext2, jffs2, etc.) 2158d321b81SPeter Tyser/include Header Files 2168d321b81SPeter Tyser/lib Files generic to all architectures 2178d321b81SPeter Tyser /libfdt Library files to support flattened device trees 2188d321b81SPeter Tyser /lzma Library files to support LZMA decompression 2198d321b81SPeter Tyser /lzo Library files to support LZO decompression 2208d321b81SPeter Tyser/net Networking code 2218d321b81SPeter Tyser/post Power On Self Test 22233c7731bSRobert P. J. Day/spl Secondary Program Loader framework 2238d321b81SPeter Tyser/tools Tools to build S-Record or U-Boot images, etc. 224c609719bSwdenk 225c609719bSwdenkSoftware Configuration: 226c609719bSwdenk======================= 227c609719bSwdenk 228c609719bSwdenkConfiguration is usually done using C preprocessor defines; the 229c609719bSwdenkrationale behind that is to avoid dead code whenever possible. 230c609719bSwdenk 231c609719bSwdenkThere are two classes of configuration variables: 232c609719bSwdenk 233c609719bSwdenk* Configuration _OPTIONS_: 234c609719bSwdenk These are selectable by the user and have names beginning with 235c609719bSwdenk "CONFIG_". 236c609719bSwdenk 237c609719bSwdenk* Configuration _SETTINGS_: 238c609719bSwdenk These depend on the hardware etc. and should not be meddled with if 239c609719bSwdenk you don't know what you're doing; they have names beginning with 2406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD "CONFIG_SYS_". 241c609719bSwdenk 242c609719bSwdenkLater we will add a configuration tool - probably similar to or even 243c609719bSwdenkidentical to what's used for the Linux kernel. Right now, we have to 244c609719bSwdenkdo the configuration by hand, which means creating some symbolic 245c609719bSwdenklinks and editing some configuration files. We use the TQM8xxL boards 246c609719bSwdenkas an example here. 247c609719bSwdenk 248c609719bSwdenk 249c609719bSwdenkSelection of Processor Architecture and Board Type: 250c609719bSwdenk--------------------------------------------------- 251c609719bSwdenk 252c609719bSwdenkFor all supported boards there are ready-to-use default 253ab584d67SHolger Freytherconfigurations available; just type "make <board_name>_defconfig". 254c609719bSwdenk 255c609719bSwdenkExample: For a TQM823L module type: 256c609719bSwdenk 257c609719bSwdenk cd u-boot 258ab584d67SHolger Freyther make TQM823L_defconfig 259c609719bSwdenk 26011ccc33fSMarcel ZiswilerFor the Cogent platform, you need to specify the CPU type as well; 261ab584d67SHolger Freythere.g. "make cogent_mpc8xx_defconfig". And also configure the cogent 262c609719bSwdenkdirectory according to the instructions in cogent/README. 263c609719bSwdenk 264c609719bSwdenk 26575b3c3aaSSimon GlassSandbox Environment: 26675b3c3aaSSimon Glass-------------------- 26775b3c3aaSSimon Glass 26875b3c3aaSSimon GlassU-Boot can be built natively to run on a Linux host using the 'sandbox' 26975b3c3aaSSimon Glassboard. This allows feature development which is not board- or architecture- 27075b3c3aaSSimon Glassspecific to be undertaken on a native platform. The sandbox is also used to 27175b3c3aaSSimon Glassrun some of U-Boot's tests. 27275b3c3aaSSimon Glass 2736b1978f8SJagannadha Sutradharudu TekiSee board/sandbox/README.sandbox for more details. 27475b3c3aaSSimon Glass 27575b3c3aaSSimon Glass 276db910353SSimon GlassBoard Initialisation Flow: 277db910353SSimon Glass-------------------------- 278db910353SSimon Glass 279db910353SSimon GlassThis is the intended start-up flow for boards. This should apply for both 280db910353SSimon GlassSPL and U-Boot proper (i.e. they both follow the same rules). At present SPL 281db910353SSimon Glassmostly uses a separate code path, but the funtion names and roles of each 282db910353SSimon Glassfunction are the same. Some boards or architectures may not conform to this. 283db910353SSimon GlassAt least most ARM boards which use CONFIG_SPL_FRAMEWORK conform to this. 284db910353SSimon Glass 285db910353SSimon GlassExecution starts with start.S with three functions called during init after 286db910353SSimon Glassthat. The purpose and limitations of each is described below. 287db910353SSimon Glass 288db910353SSimon Glasslowlevel_init(): 289db910353SSimon Glass - purpose: essential init to permit execution to reach board_init_f() 290db910353SSimon Glass - no global_data or BSS 291db910353SSimon Glass - there is no stack (ARMv7 may have one but it will soon be removed) 292db910353SSimon Glass - must not set up SDRAM or use console 293db910353SSimon Glass - must only do the bare minimum to allow execution to continue to 294db910353SSimon Glass board_init_f() 295db910353SSimon Glass - this is almost never needed 296db910353SSimon Glass - return normally from this function 297db910353SSimon Glass 298db910353SSimon Glassboard_init_f(): 299db910353SSimon Glass - purpose: set up the machine ready for running board_init_r(): 300db910353SSimon Glass i.e. SDRAM and serial UART 301db910353SSimon Glass - global_data is available 302db910353SSimon Glass - stack is in SRAM 303db910353SSimon Glass - BSS is not available, so you cannot use global/static variables, 304db910353SSimon Glass only stack variables and global_data 305db910353SSimon Glass 306db910353SSimon Glass Non-SPL-specific notes: 307db910353SSimon Glass - dram_init() is called to set up DRAM. If already done in SPL this 308db910353SSimon Glass can do nothing 309db910353SSimon Glass 310db910353SSimon Glass SPL-specific notes: 311db910353SSimon Glass - you can override the entire board_init_f() function with your own 312db910353SSimon Glass version as needed. 313db910353SSimon Glass - preloader_console_init() can be called here in extremis 314db910353SSimon Glass - should set up SDRAM, and anything needed to make the UART work 315db910353SSimon Glass - these is no need to clear BSS, it will be done by crt0.S 316db910353SSimon Glass - must return normally from this function (don't call board_init_r() 317db910353SSimon Glass directly) 318db910353SSimon Glass 319db910353SSimon GlassHere the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at 320db910353SSimon Glassthis point the stack and global_data are relocated to below 321db910353SSimon GlassCONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of 322db910353SSimon Glassmemory. 323db910353SSimon Glass 324db910353SSimon Glassboard_init_r(): 325db910353SSimon Glass - purpose: main execution, common code 326db910353SSimon Glass - global_data is available 327db910353SSimon Glass - SDRAM is available 328db910353SSimon Glass - BSS is available, all static/global variables can be used 329db910353SSimon Glass - execution eventually continues to main_loop() 330db910353SSimon Glass 331db910353SSimon Glass Non-SPL-specific notes: 332db910353SSimon Glass - U-Boot is relocated to the top of memory and is now running from 333db910353SSimon Glass there. 334db910353SSimon Glass 335db910353SSimon Glass SPL-specific notes: 336db910353SSimon Glass - stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and 337db910353SSimon Glass CONFIG_SPL_STACK_R_ADDR points into SDRAM 338db910353SSimon Glass - preloader_console_init() can be called here - typically this is 339db910353SSimon Glass done by defining CONFIG_SPL_BOARD_INIT and then supplying a 340db910353SSimon Glass spl_board_init() function containing this call 341db910353SSimon Glass - loads U-Boot or (in falcon mode) Linux 342db910353SSimon Glass 343db910353SSimon Glass 344db910353SSimon Glass 345c609719bSwdenkConfiguration Options: 346c609719bSwdenk---------------------- 347c609719bSwdenk 348c609719bSwdenkConfiguration depends on the combination of board and CPU type; all 349c609719bSwdenksuch information is kept in a configuration file 350c609719bSwdenk"include/configs/<board_name>.h". 351c609719bSwdenk 352c609719bSwdenkExample: For a TQM823L module, all configuration settings are in 353c609719bSwdenk"include/configs/TQM823L.h". 354c609719bSwdenk 355c609719bSwdenk 3567f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux 3577f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to 3587f6c2cbcSwdenkbuild a config tool - later. 3597f6c2cbcSwdenk 3607f6c2cbcSwdenk 361c609719bSwdenkThe following options need to be configured: 362c609719bSwdenk 3632628114eSKim Phillips- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX. 364c609719bSwdenk 3652628114eSKim Phillips- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS. 3666ccec449SWolfgang Denk 3676ccec449SWolfgang Denk- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined) 36809ea0de0SHaavard Skinnemoen Define exactly one, e.g. CONFIG_ATSTK1002 369c609719bSwdenk 370c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined) 371c609719bSwdenk Define exactly one of 372c609719bSwdenk CONFIG_CMA286_60_OLD 373c609719bSwdenk--- FIXME --- not tested yet: 374c609719bSwdenk CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P, 375c609719bSwdenk CONFIG_CMA287_23, CONFIG_CMA287_50 376c609719bSwdenk 377c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined) 378c609719bSwdenk Define exactly one of 379c609719bSwdenk CONFIG_CMA101, CONFIG_CMA102 380c609719bSwdenk 381c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined) 382c609719bSwdenk Define one or more of 383c609719bSwdenk CONFIG_CMA302 384c609719bSwdenk 385c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined) 386c609719bSwdenk Define one or more of 387c609719bSwdenk CONFIG_LCD_HEARTBEAT - update a character position on 38811ccc33fSMarcel Ziswiler the LCD display every second with 389c609719bSwdenk a "rotator" |\-/|\-/ 390c609719bSwdenk 391cf946c6dSLei Wen- Marvell Family Member 392cf946c6dSLei Wen CONFIG_SYS_MVFS - define it if you want to enable 393cf946c6dSLei Wen multiple fs option at one time 394cf946c6dSLei Wen for marvell soc family 395cf946c6dSLei Wen 39611ccc33fSMarcel Ziswiler- 8xx CPU Options: (if using an MPC8xx CPU) 39766ca92a5Swdenk CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if 39866ca92a5Swdenk get_gclk_freq() cannot work 3995da627a4Swdenk e.g. if there is no 32KHz 4005da627a4Swdenk reference PIT/RTC clock 40166ca92a5Swdenk CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK 40266ca92a5Swdenk or XTAL/EXTAL) 403c609719bSwdenk 40466ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU): 4056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8xx_CPUCLK_MIN 4066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8xx_CPUCLK_MAX 40766ca92a5Swdenk CONFIG_8xx_CPUCLK_DEFAULT 40875d1ea7fSwdenk See doc/README.MPC866 40975d1ea7fSwdenk 4106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MEASURE_CPUCLK 41175d1ea7fSwdenk 41275d1ea7fSwdenk Define this to measure the actual CPU clock instead 41375d1ea7fSwdenk of relying on the correctness of the configured 41475d1ea7fSwdenk values. Mostly useful for board bringup to make sure 41575d1ea7fSwdenk the PLL is locked at the intended frequency. Note 41675d1ea7fSwdenk that this requires a (stable) reference clock (32 kHz 4176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD RTC clock or CONFIG_SYS_8XX_XIN) 41875d1ea7fSwdenk 419506f3918SHeiko Schocher CONFIG_SYS_DELAYED_ICACHE 420506f3918SHeiko Schocher 421506f3918SHeiko Schocher Define this option if you want to enable the 422506f3918SHeiko Schocher ICache only when Code runs from RAM. 423506f3918SHeiko Schocher 42466412c63SKumar Gala- 85xx CPU Options: 425ffd06e02SYork Sun CONFIG_SYS_PPC64 426ffd06e02SYork Sun 427ffd06e02SYork Sun Specifies that the core is a 64-bit PowerPC implementation (implements 428ffd06e02SYork Sun the "64" category of the Power ISA). This is necessary for ePAPR 429ffd06e02SYork Sun compliance, among other possible reasons. 430ffd06e02SYork Sun 43166412c63SKumar Gala CONFIG_SYS_FSL_TBCLK_DIV 43266412c63SKumar Gala 43366412c63SKumar Gala Defines the core time base clock divider ratio compared to the 43466412c63SKumar Gala system clock. On most PQ3 devices this is 8, on newer QorIQ 43566412c63SKumar Gala devices it can be 16 or 32. The ratio varies from SoC to Soc. 43666412c63SKumar Gala 4378f29084aSKumar Gala CONFIG_SYS_FSL_PCIE_COMPAT 4388f29084aSKumar Gala 4398f29084aSKumar Gala Defines the string to utilize when trying to match PCIe device 4408f29084aSKumar Gala tree nodes for the given platform. 4418f29084aSKumar Gala 442afa6b551SPrabhakar Kushwaha CONFIG_SYS_PPC_E500_DEBUG_TLB 443afa6b551SPrabhakar Kushwaha 444afa6b551SPrabhakar Kushwaha Enables a temporary TLB entry to be used during boot to work 445afa6b551SPrabhakar Kushwaha around limitations in e500v1 and e500v2 external debugger 446afa6b551SPrabhakar Kushwaha support. This reduces the portions of the boot code where 447afa6b551SPrabhakar Kushwaha breakpoints and single stepping do not work. The value of this 448afa6b551SPrabhakar Kushwaha symbol should be set to the TLB1 entry to be used for this 449afa6b551SPrabhakar Kushwaha purpose. 450afa6b551SPrabhakar Kushwaha 45133eee330SScott Wood CONFIG_SYS_FSL_ERRATUM_A004510 45233eee330SScott Wood 45333eee330SScott Wood Enables a workaround for erratum A004510. If set, 45433eee330SScott Wood then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and 45533eee330SScott Wood CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set. 45633eee330SScott Wood 45733eee330SScott Wood CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV 45833eee330SScott Wood CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional) 45933eee330SScott Wood 46033eee330SScott Wood Defines one or two SoC revisions (low 8 bits of SVR) 46133eee330SScott Wood for which the A004510 workaround should be applied. 46233eee330SScott Wood 46333eee330SScott Wood The rest of SVR is either not relevant to the decision 46433eee330SScott Wood of whether the erratum is present (e.g. p2040 versus 46533eee330SScott Wood p2041) or is implied by the build target, which controls 46633eee330SScott Wood whether CONFIG_SYS_FSL_ERRATUM_A004510 is set. 46733eee330SScott Wood 46833eee330SScott Wood See Freescale App Note 4493 for more information about 46933eee330SScott Wood this erratum. 47033eee330SScott Wood 47174fa22edSPrabhakar Kushwaha CONFIG_A003399_NOR_WORKAROUND 47274fa22edSPrabhakar Kushwaha Enables a workaround for IFC erratum A003399. It is only 473b445bbb4SJeremiah Mahler required during NOR boot. 47474fa22edSPrabhakar Kushwaha 4759f074e67SPrabhakar Kushwaha CONFIG_A008044_WORKAROUND 4769f074e67SPrabhakar Kushwaha Enables a workaround for T1040/T1042 erratum A008044. It is only 477b445bbb4SJeremiah Mahler required during NAND boot and valid for Rev 1.0 SoC revision 4789f074e67SPrabhakar Kushwaha 47933eee330SScott Wood CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY 48033eee330SScott Wood 48133eee330SScott Wood This is the value to write into CCSR offset 0x18600 48233eee330SScott Wood according to the A004510 workaround. 48333eee330SScott Wood 48464501c66SPriyanka Jain CONFIG_SYS_FSL_DSP_DDR_ADDR 48564501c66SPriyanka Jain This value denotes start offset of DDR memory which is 48664501c66SPriyanka Jain connected exclusively to the DSP cores. 48764501c66SPriyanka Jain 488765b0bdbSPriyanka Jain CONFIG_SYS_FSL_DSP_M2_RAM_ADDR 489765b0bdbSPriyanka Jain This value denotes start offset of M2 memory 490765b0bdbSPriyanka Jain which is directly connected to the DSP core. 491765b0bdbSPriyanka Jain 49264501c66SPriyanka Jain CONFIG_SYS_FSL_DSP_M3_RAM_ADDR 49364501c66SPriyanka Jain This value denotes start offset of M3 memory which is directly 49464501c66SPriyanka Jain connected to the DSP core. 49564501c66SPriyanka Jain 496765b0bdbSPriyanka Jain CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT 497765b0bdbSPriyanka Jain This value denotes start offset of DSP CCSR space. 498765b0bdbSPriyanka Jain 499b135991aSPriyanka Jain CONFIG_SYS_FSL_SINGLE_SOURCE_CLK 500b135991aSPriyanka Jain Single Source Clock is clocking mode present in some of FSL SoC's. 501b135991aSPriyanka Jain In this mode, a single differential clock is used to supply 502b135991aSPriyanka Jain clocks to the sysclock, ddrclock and usbclock. 503b135991aSPriyanka Jain 504fb4a2409SAneesh Bansal CONFIG_SYS_CPC_REINIT_F 505fb4a2409SAneesh Bansal This CONFIG is defined when the CPC is configured as SRAM at the 506fb4a2409SAneesh Bansal time of U-boot entry and is required to be re-initialized. 507fb4a2409SAneesh Bansal 508aade2004STang Yuantian CONFIG_DEEP_SLEEP 509b445bbb4SJeremiah Mahler Indicates this SoC supports deep sleep feature. If deep sleep is 510aade2004STang Yuantian supported, core will start to execute uboot when wakes up. 511aade2004STang Yuantian 5126cb461b4SDaniel Schwierzeck- Generic CPU options: 5132a1680e3SYork Sun CONFIG_SYS_GENERIC_GLOBAL_DATA 5142a1680e3SYork Sun Defines global data is initialized in generic board board_init_f(). 5152a1680e3SYork Sun If this macro is defined, global data is created and cleared in 5162a1680e3SYork Sun generic board board_init_f(). Without this macro, architecture/board 5172a1680e3SYork Sun should initialize global data before calling board_init_f(). 5182a1680e3SYork Sun 5196cb461b4SDaniel Schwierzeck CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN 5206cb461b4SDaniel Schwierzeck 5216cb461b4SDaniel Schwierzeck Defines the endianess of the CPU. Implementation of those 5226cb461b4SDaniel Schwierzeck values is arch specific. 5236cb461b4SDaniel Schwierzeck 5245614e71bSYork Sun CONFIG_SYS_FSL_DDR 5255614e71bSYork Sun Freescale DDR driver in use. This type of DDR controller is 5265614e71bSYork Sun found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core 5275614e71bSYork Sun SoCs. 5285614e71bSYork Sun 5295614e71bSYork Sun CONFIG_SYS_FSL_DDR_ADDR 5305614e71bSYork Sun Freescale DDR memory-mapped register base. 5315614e71bSYork Sun 5325614e71bSYork Sun CONFIG_SYS_FSL_DDR_EMU 5335614e71bSYork Sun Specify emulator support for DDR. Some DDR features such as 5345614e71bSYork Sun deskew training are not available. 5355614e71bSYork Sun 5365614e71bSYork Sun CONFIG_SYS_FSL_DDRC_GEN1 5375614e71bSYork Sun Freescale DDR1 controller. 5385614e71bSYork Sun 5395614e71bSYork Sun CONFIG_SYS_FSL_DDRC_GEN2 5405614e71bSYork Sun Freescale DDR2 controller. 5415614e71bSYork Sun 5425614e71bSYork Sun CONFIG_SYS_FSL_DDRC_GEN3 5435614e71bSYork Sun Freescale DDR3 controller. 5445614e71bSYork Sun 54534e026f9SYork Sun CONFIG_SYS_FSL_DDRC_GEN4 54634e026f9SYork Sun Freescale DDR4 controller. 54734e026f9SYork Sun 5489ac4ffbdSYork Sun CONFIG_SYS_FSL_DDRC_ARM_GEN3 5499ac4ffbdSYork Sun Freescale DDR3 controller for ARM-based SoCs. 5509ac4ffbdSYork Sun 5515614e71bSYork Sun CONFIG_SYS_FSL_DDR1 5525614e71bSYork Sun Board config to use DDR1. It can be enabled for SoCs with 5535614e71bSYork Sun Freescale DDR1 or DDR2 controllers, depending on the board 5545614e71bSYork Sun implemetation. 5555614e71bSYork Sun 5565614e71bSYork Sun CONFIG_SYS_FSL_DDR2 5575614e71bSYork Sun Board config to use DDR2. It can be eanbeld for SoCs with 5585614e71bSYork Sun Freescale DDR2 or DDR3 controllers, depending on the board 5595614e71bSYork Sun implementation. 5605614e71bSYork Sun 5615614e71bSYork Sun CONFIG_SYS_FSL_DDR3 5625614e71bSYork Sun Board config to use DDR3. It can be enabled for SoCs with 56334e026f9SYork Sun Freescale DDR3 or DDR3L controllers. 56434e026f9SYork Sun 56534e026f9SYork Sun CONFIG_SYS_FSL_DDR3L 56634e026f9SYork Sun Board config to use DDR3L. It can be enabled for SoCs with 56734e026f9SYork Sun DDR3L controllers. 56834e026f9SYork Sun 56934e026f9SYork Sun CONFIG_SYS_FSL_DDR4 57034e026f9SYork Sun Board config to use DDR4. It can be enabled for SoCs with 57134e026f9SYork Sun DDR4 controllers. 5725614e71bSYork Sun 5731b4175d6SPrabhakar Kushwaha CONFIG_SYS_FSL_IFC_BE 5741b4175d6SPrabhakar Kushwaha Defines the IFC controller register space as Big Endian 5751b4175d6SPrabhakar Kushwaha 5761b4175d6SPrabhakar Kushwaha CONFIG_SYS_FSL_IFC_LE 5771b4175d6SPrabhakar Kushwaha Defines the IFC controller register space as Little Endian 5781b4175d6SPrabhakar Kushwaha 579690e4258SPrabhakar Kushwaha CONFIG_SYS_FSL_PBL_PBI 580690e4258SPrabhakar Kushwaha It enables addition of RCW (Power on reset configuration) in built image. 581690e4258SPrabhakar Kushwaha Please refer doc/README.pblimage for more details 582690e4258SPrabhakar Kushwaha 583690e4258SPrabhakar Kushwaha CONFIG_SYS_FSL_PBL_RCW 584690e4258SPrabhakar Kushwaha It adds PBI(pre-boot instructions) commands in u-boot build image. 585690e4258SPrabhakar Kushwaha PBI commands can be used to configure SoC before it starts the execution. 586690e4258SPrabhakar Kushwaha Please refer doc/README.pblimage for more details 587690e4258SPrabhakar Kushwaha 58889ad7be8SPrabhakar Kushwaha CONFIG_SPL_FSL_PBL 58989ad7be8SPrabhakar Kushwaha It adds a target to create boot binary having SPL binary in PBI format 59089ad7be8SPrabhakar Kushwaha concatenated with u-boot binary. 59189ad7be8SPrabhakar Kushwaha 5924e5b1bd0SYork Sun CONFIG_SYS_FSL_DDR_BE 5934e5b1bd0SYork Sun Defines the DDR controller register space as Big Endian 5944e5b1bd0SYork Sun 5954e5b1bd0SYork Sun CONFIG_SYS_FSL_DDR_LE 5964e5b1bd0SYork Sun Defines the DDR controller register space as Little Endian 5974e5b1bd0SYork Sun 5986b9e309aSYork Sun CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY 5996b9e309aSYork Sun Physical address from the view of DDR controllers. It is the 6006b9e309aSYork Sun same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But 6016b9e309aSYork Sun it could be different for ARM SoCs. 6026b9e309aSYork Sun 6036b1e1254SYork Sun CONFIG_SYS_FSL_DDR_INTLV_256B 6046b1e1254SYork Sun DDR controller interleaving on 256-byte. This is a special 6056b1e1254SYork Sun interleaving mode, handled by Dickens for Freescale layerscape 6066b1e1254SYork Sun SoCs with ARM core. 6076b1e1254SYork Sun 6081d71efbbSYork Sun CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS 6091d71efbbSYork Sun Number of controllers used as main memory. 6101d71efbbSYork Sun 6111d71efbbSYork Sun CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS 6121d71efbbSYork Sun Number of controllers used for other than main memory. 6131d71efbbSYork Sun 614028dbb8dSRuchika Gupta CONFIG_SYS_FSL_SEC_BE 615028dbb8dSRuchika Gupta Defines the SEC controller register space as Big Endian 616028dbb8dSRuchika Gupta 617028dbb8dSRuchika Gupta CONFIG_SYS_FSL_SEC_LE 618028dbb8dSRuchika Gupta Defines the SEC controller register space as Little Endian 619028dbb8dSRuchika Gupta 6200b953ffcSMarkus Klotzbuecher- Intel Monahans options: 6216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO 6220b953ffcSMarkus Klotzbuecher 6230b953ffcSMarkus Klotzbuecher Defines the Monahans run mode to oscillator 6240b953ffcSMarkus Klotzbuecher ratio. Valid values are 8, 16, 24, 31. The core 6250b953ffcSMarkus Klotzbuecher frequency is this value multiplied by 13 MHz. 6260b953ffcSMarkus Klotzbuecher 6276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO 6280b953ffcSMarkus Klotzbuecher 6290b953ffcSMarkus Klotzbuecher Defines the Monahans turbo mode to oscillator 6300b953ffcSMarkus Klotzbuecher ratio. Valid values are 1 (default if undefined) and 6310b953ffcSMarkus Klotzbuecher 2. The core frequency as calculated above is multiplied 6320b953ffcSMarkus Klotzbuecher by this value. 6330b953ffcSMarkus Klotzbuecher 63492bbd64eSDaniel Schwierzeck- MIPS CPU options: 63592bbd64eSDaniel Schwierzeck CONFIG_SYS_INIT_SP_OFFSET 63692bbd64eSDaniel Schwierzeck 63792bbd64eSDaniel Schwierzeck Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack 63892bbd64eSDaniel Schwierzeck pointer. This is needed for the temporary stack before 63992bbd64eSDaniel Schwierzeck relocation. 64092bbd64eSDaniel Schwierzeck 64192bbd64eSDaniel Schwierzeck CONFIG_SYS_MIPS_CACHE_MODE 64292bbd64eSDaniel Schwierzeck 64392bbd64eSDaniel Schwierzeck Cache operation mode for the MIPS CPU. 64492bbd64eSDaniel Schwierzeck See also arch/mips/include/asm/mipsregs.h. 64592bbd64eSDaniel Schwierzeck Possible values are: 64692bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_NO_WA 64792bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_WA 64892bbd64eSDaniel Schwierzeck CONF_CM_UNCACHED 64992bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_NONCOHERENT 65092bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_CE 65192bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_COW 65292bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_CUW 65392bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_ACCELERATED 65492bbd64eSDaniel Schwierzeck 65592bbd64eSDaniel Schwierzeck CONFIG_SYS_XWAY_EBU_BOOTCFG 65692bbd64eSDaniel Schwierzeck 65792bbd64eSDaniel Schwierzeck Special option for Lantiq XWAY SoCs for booting from NOR flash. 65892bbd64eSDaniel Schwierzeck See also arch/mips/cpu/mips32/start.S. 65992bbd64eSDaniel Schwierzeck 66092bbd64eSDaniel Schwierzeck CONFIG_XWAY_SWAP_BYTES 66192bbd64eSDaniel Schwierzeck 66292bbd64eSDaniel Schwierzeck Enable compilation of tools/xway-swap-bytes needed for Lantiq 66392bbd64eSDaniel Schwierzeck XWAY SoCs for booting from NOR flash. The U-Boot image needs to 66492bbd64eSDaniel Schwierzeck be swapped if a flash programmer is used. 66592bbd64eSDaniel Schwierzeck 666b67d8816SChristian Riesch- ARM options: 667b67d8816SChristian Riesch CONFIG_SYS_EXCEPTION_VECTORS_HIGH 668b67d8816SChristian Riesch 669b67d8816SChristian Riesch Select high exception vectors of the ARM core, e.g., do not 670b67d8816SChristian Riesch clear the V bit of the c1 register of CP15. 671b67d8816SChristian Riesch 6725356f545SAneesh V CONFIG_SYS_THUMB_BUILD 6735356f545SAneesh V 6745356f545SAneesh V Use this flag to build U-Boot using the Thumb instruction 6755356f545SAneesh V set for ARM architectures. Thumb instruction set provides 6765356f545SAneesh V better code density. For ARM architectures that support 6775356f545SAneesh V Thumb2 this flag will result in Thumb2 code generated by 6785356f545SAneesh V GCC. 6795356f545SAneesh V 680c5d4752cSStephen Warren CONFIG_ARM_ERRATA_716044 6810678587fSStephen Warren CONFIG_ARM_ERRATA_742230 6820678587fSStephen Warren CONFIG_ARM_ERRATA_743622 6830678587fSStephen Warren CONFIG_ARM_ERRATA_751472 684b7588e3bSNitin Garg CONFIG_ARM_ERRATA_761320 685*e392b923SIan Campbell CONFIG_ARM_ERRATA_773022 686*e392b923SIan Campbell CONFIG_ARM_ERRATA_774769 687*e392b923SIan Campbell CONFIG_ARM_ERRATA_794072 6880678587fSStephen Warren 6890678587fSStephen Warren If set, the workarounds for these ARM errata are applied early 6900678587fSStephen Warren during U-Boot startup. Note that these options force the 6910678587fSStephen Warren workarounds to be applied; no CPU-type/version detection 6920678587fSStephen Warren exists, unlike the similar options in the Linux kernel. Do not 6930678587fSStephen Warren set these options unless they apply! 6940678587fSStephen Warren 695207774b2SYork Sun COUNTER_FREQUENCY 696207774b2SYork Sun Generic timer clock source frequency. 697207774b2SYork Sun 698207774b2SYork Sun COUNTER_FREQUENCY_REAL 699207774b2SYork Sun Generic timer clock source frequency if the real clock is 700207774b2SYork Sun different from COUNTER_FREQUENCY, and can only be determined 701207774b2SYork Sun at run time. 702207774b2SYork Sun 703c616a0dfSNishanth Menon NOTE: The following can be machine specific errata. These 704c616a0dfSNishanth Menon do have ability to provide rudimentary version and machine 705c616a0dfSNishanth Menon specific checks, but expect no product checks. 7065902f4ceSNishanth Menon CONFIG_ARM_ERRATA_430973 707b45c48a7SNishanth Menon CONFIG_ARM_ERRATA_454179 7089b4d65f9SNishanth Menon CONFIG_ARM_ERRATA_621766 709c616a0dfSNishanth Menon CONFIG_ARM_ERRATA_798870 710a615d0beSNishanth Menon CONFIG_ARM_ERRATA_801819 711c616a0dfSNishanth Menon 71273c38934SStephen Warren- Tegra SoC options: 71373c38934SStephen Warren CONFIG_TEGRA_SUPPORT_NON_SECURE 71473c38934SStephen Warren 71573c38934SStephen Warren Support executing U-Boot in non-secure (NS) mode. Certain 71673c38934SStephen Warren impossible actions will be skipped if the CPU is in NS mode, 71773c38934SStephen Warren such as ARM architectural timer initialization. 71873c38934SStephen Warren 7195da627a4Swdenk- Linux Kernel Interface: 720c609719bSwdenk CONFIG_CLOCKS_IN_MHZ 721c609719bSwdenk 722c609719bSwdenk U-Boot stores all clock information in Hz 723c609719bSwdenk internally. For binary compatibility with older Linux 724c609719bSwdenk kernels (which expect the clocks passed in the 725c609719bSwdenk bd_info data to be in MHz) the environment variable 726c609719bSwdenk "clocks_in_mhz" can be defined so that U-Boot 727c609719bSwdenk converts clock data to MHZ before passing it to the 728c609719bSwdenk Linux kernel. 729c609719bSwdenk When CONFIG_CLOCKS_IN_MHZ is defined, a definition of 730c609719bSwdenk "clocks_in_mhz=1" is automatically included in the 731c609719bSwdenk default environment. 732c609719bSwdenk 7335da627a4Swdenk CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only] 7345da627a4Swdenk 735b445bbb4SJeremiah Mahler When transferring memsize parameter to Linux, some versions 7365da627a4Swdenk expect it to be in bytes, others in MB. 7375da627a4Swdenk Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes. 7385da627a4Swdenk 739fec6d9eeSGerald Van Baren CONFIG_OF_LIBFDT 740f57f70aaSWolfgang Denk 741f57f70aaSWolfgang Denk New kernel versions are expecting firmware settings to be 742213bf8c8SGerald Van Baren passed using flattened device trees (based on open firmware 743213bf8c8SGerald Van Baren concepts). 744213bf8c8SGerald Van Baren 745213bf8c8SGerald Van Baren CONFIG_OF_LIBFDT 746213bf8c8SGerald Van Baren * New libfdt-based support 747213bf8c8SGerald Van Baren * Adds the "fdt" command 7483bb342fcSKim Phillips * The bootm command automatically updates the fdt 749213bf8c8SGerald Van Baren 750b55ae402SMarcel Ziswiler OF_CPU - The proper name of the cpus node (only required for 751b55ae402SMarcel Ziswiler MPC512X and MPC5xxx based boards). 752b55ae402SMarcel Ziswiler OF_SOC - The proper name of the soc node (only required for 753b55ae402SMarcel Ziswiler MPC512X and MPC5xxx based boards). 754f57f70aaSWolfgang Denk OF_TBCLK - The timebase frequency. 755c2871f03SKumar Gala OF_STDOUT_PATH - The path to the console device 756f57f70aaSWolfgang Denk 75711ccc33fSMarcel Ziswiler boards with QUICC Engines require OF_QE to set UCC MAC 75811ccc33fSMarcel Ziswiler addresses 7593bb342fcSKim Phillips 7604e253137SKumar Gala CONFIG_OF_BOARD_SETUP 7614e253137SKumar Gala 7624e253137SKumar Gala Board code has addition modification that it wants to make 7634e253137SKumar Gala to the flat device tree before handing it off to the kernel 7646705d81eSwdenk 765c654b517SSimon Glass CONFIG_OF_SYSTEM_SETUP 766c654b517SSimon Glass 767c654b517SSimon Glass Other code has addition modification that it wants to make 768c654b517SSimon Glass to the flat device tree before handing it off to the kernel. 769c654b517SSimon Glass This causes ft_system_setup() to be called before booting 770c654b517SSimon Glass the kernel. 771c654b517SSimon Glass 7720267768eSMatthew McClintock CONFIG_OF_BOOT_CPU 7730267768eSMatthew McClintock 77411ccc33fSMarcel Ziswiler This define fills in the correct boot CPU in the boot 7750267768eSMatthew McClintock param header, the default value is zero if undefined. 7760267768eSMatthew McClintock 7773887c3fbSHeiko Schocher CONFIG_OF_IDE_FIXUP 7783887c3fbSHeiko Schocher 7793887c3fbSHeiko Schocher U-Boot can detect if an IDE device is present or not. 7803887c3fbSHeiko Schocher If not, and this new config option is activated, U-Boot 7813887c3fbSHeiko Schocher removes the ATA node from the DTS before booting Linux, 7823887c3fbSHeiko Schocher so the Linux IDE driver does not probe the device and 7833887c3fbSHeiko Schocher crash. This is needed for buggy hardware (uc101) where 7843887c3fbSHeiko Schocher no pull down resistor is connected to the signal IDE5V_DD7. 7853887c3fbSHeiko Schocher 7867eb29398SIgor Grinberg CONFIG_MACH_TYPE [relevant for ARM only][mandatory] 7877eb29398SIgor Grinberg 7887eb29398SIgor Grinberg This setting is mandatory for all boards that have only one 7897eb29398SIgor Grinberg machine type and must be used to specify the machine type 7907eb29398SIgor Grinberg number as it appears in the ARM machine registry 7917eb29398SIgor Grinberg (see http://www.arm.linux.org.uk/developer/machines/). 7927eb29398SIgor Grinberg Only boards that have multiple machine types supported 7937eb29398SIgor Grinberg in a single configuration file and the machine type is 7947eb29398SIgor Grinberg runtime discoverable, do not have to use this setting. 7957eb29398SIgor Grinberg 7960b2f4ecaSNiklaus Giger- vxWorks boot parameters: 7970b2f4ecaSNiklaus Giger 7980b2f4ecaSNiklaus Giger bootvx constructs a valid bootline using the following 7990b2f4ecaSNiklaus Giger environments variables: bootfile, ipaddr, serverip, hostname. 8000b2f4ecaSNiklaus Giger It loads the vxWorks image pointed bootfile. 8010b2f4ecaSNiklaus Giger 8020b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name 8030b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address 8040b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server 8050b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters 8060b2f4ecaSNiklaus Giger 8070b2f4ecaSNiklaus Giger CONFIG_SYS_VXWORKS_ADD_PARAMS 8080b2f4ecaSNiklaus Giger 8090b2f4ecaSNiklaus Giger Add it at the end of the bootline. E.g "u=username pw=secret" 8100b2f4ecaSNiklaus Giger 8110b2f4ecaSNiklaus Giger Note: If a "bootargs" environment is defined, it will overwride 8120b2f4ecaSNiklaus Giger the defaults discussed just above. 8130b2f4ecaSNiklaus Giger 8142c451f78SAneesh V- Cache Configuration: 8152c451f78SAneesh V CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot 8162c451f78SAneesh V CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot 8172c451f78SAneesh V CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot 8182c451f78SAneesh V 81993bc2193SAneesh V- Cache Configuration for ARM: 82093bc2193SAneesh V CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache 82193bc2193SAneesh V controller 82293bc2193SAneesh V CONFIG_SYS_PL310_BASE - Physical base address of PL310 82393bc2193SAneesh V controller register space 82493bc2193SAneesh V 8256705d81eSwdenk- Serial Ports: 82648d0192fSAndreas Engel CONFIG_PL010_SERIAL 8276705d81eSwdenk 8286705d81eSwdenk Define this if you want support for Amba PrimeCell PL010 UARTs. 8296705d81eSwdenk 83048d0192fSAndreas Engel CONFIG_PL011_SERIAL 8316705d81eSwdenk 8326705d81eSwdenk Define this if you want support for Amba PrimeCell PL011 UARTs. 8336705d81eSwdenk 8346705d81eSwdenk CONFIG_PL011_CLOCK 8356705d81eSwdenk 8366705d81eSwdenk If you have Amba PrimeCell PL011 UARTs, set this variable to 8376705d81eSwdenk the clock speed of the UARTs. 8386705d81eSwdenk 8396705d81eSwdenk CONFIG_PL01x_PORTS 8406705d81eSwdenk 8416705d81eSwdenk If you have Amba PrimeCell PL010 or PL011 UARTs on your board, 8426705d81eSwdenk define this to a list of base addresses for each (supported) 8436705d81eSwdenk port. See e.g. include/configs/versatile.h 8446705d81eSwdenk 845d57dee57SKaricheri, Muralidharan CONFIG_SERIAL_HW_FLOW_CONTROL 846d57dee57SKaricheri, Muralidharan 847d57dee57SKaricheri, Muralidharan Define this variable to enable hw flow control in serial driver. 848d57dee57SKaricheri, Muralidharan Current user of this option is drivers/serial/nsl16550.c driver 8496705d81eSwdenk 850c609719bSwdenk- Console Interface: 851c609719bSwdenk Depending on board, define exactly one serial port 852c609719bSwdenk (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2, 853c609719bSwdenk CONFIG_8xx_CONS_SCC1, ...), or switch off the serial 854c609719bSwdenk console by defining CONFIG_8xx_CONS_NONE 855c609719bSwdenk 856c609719bSwdenk Note: if CONFIG_8xx_CONS_NONE is defined, the serial 857c609719bSwdenk port routines must be defined elsewhere 858c609719bSwdenk (i.e. serial_init(), serial_getc(), ...) 859c609719bSwdenk 860c609719bSwdenk CONFIG_CFB_CONSOLE 861c609719bSwdenk Enables console device for a color framebuffer. Needs following 862c53043b7SWolfgang Denk defines (cf. smiLynxEM, i8042) 863c609719bSwdenk VIDEO_FB_LITTLE_ENDIAN graphic memory organisation 864c609719bSwdenk (default big endian) 865c609719bSwdenk VIDEO_HW_RECTFILL graphic chip supports 866c609719bSwdenk rectangle fill 867c609719bSwdenk (cf. smiLynxEM) 868c609719bSwdenk VIDEO_HW_BITBLT graphic chip supports 869c609719bSwdenk bit-blit (cf. smiLynxEM) 870c609719bSwdenk VIDEO_VISIBLE_COLS visible pixel columns 871c609719bSwdenk (cols=pitch) 872c609719bSwdenk VIDEO_VISIBLE_ROWS visible pixel rows 873c609719bSwdenk VIDEO_PIXEL_SIZE bytes per pixel 874c609719bSwdenk VIDEO_DATA_FORMAT graphic data format 875c609719bSwdenk (0-5, cf. cfb_console.c) 876c609719bSwdenk VIDEO_FB_ADRS framebuffer address 877c609719bSwdenk VIDEO_KBD_INIT_FCT keyboard int fct 878c609719bSwdenk (i.e. i8042_kbd_init()) 879c609719bSwdenk VIDEO_TSTC_FCT test char fct 880c609719bSwdenk (i.e. i8042_tstc) 881c609719bSwdenk VIDEO_GETC_FCT get char fct 882c609719bSwdenk (i.e. i8042_getc) 883c609719bSwdenk CONFIG_CONSOLE_CURSOR cursor drawing on/off 884c609719bSwdenk (requires blink timer 885c609719bSwdenk cf. i8042.c) 8866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c) 887c609719bSwdenk CONFIG_CONSOLE_TIME display time/date info in 888c609719bSwdenk upper right corner 889602ad3b3SJon Loeliger (requires CONFIG_CMD_DATE) 890c609719bSwdenk CONFIG_VIDEO_LOGO display Linux logo in 891c609719bSwdenk upper left corner 892a6c7ad2fSwdenk CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of 893a6c7ad2fSwdenk linux_logo.h for logo. 894a6c7ad2fSwdenk Requires CONFIG_VIDEO_LOGO 895c609719bSwdenk CONFIG_CONSOLE_EXTRA_INFO 89611ccc33fSMarcel Ziswiler additional board info beside 897c609719bSwdenk the logo 898c609719bSwdenk 89933a35bbbSPali Rohár When CONFIG_CFB_CONSOLE_ANSI is defined, console will support 90033a35bbbSPali Rohár a limited number of ANSI escape sequences (cursor control, 90133a35bbbSPali Rohár erase functions and limited graphics rendition control). 90233a35bbbSPali Rohár 903c609719bSwdenk When CONFIG_CFB_CONSOLE is defined, video console is 904c609719bSwdenk default i/o. Serial console can be forced with 905c609719bSwdenk environment 'console=serial'. 906c609719bSwdenk 907a3ad8e26Swdenk When CONFIG_SILENT_CONSOLE is defined, all console 908a3ad8e26Swdenk messages (by U-Boot and Linux!) can be silenced with 909a3ad8e26Swdenk the "silent" environment variable. See 910a3ad8e26Swdenk doc/README.silent for more information. 911a3ad8e26Swdenk 91245ae2546SHeiko Schocher CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default 91345ae2546SHeiko Schocher is 0x00. 91445ae2546SHeiko Schocher CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default 91545ae2546SHeiko Schocher is 0xa0. 91645ae2546SHeiko Schocher 917c609719bSwdenk- Console Baudrate: 918c609719bSwdenk CONFIG_BAUDRATE - in bps 919c609719bSwdenk Select one of the baudrates listed in 9206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BAUDRATE_TABLE, see below. 9216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale 922c609719bSwdenk 923c92fac91SHeiko Schocher- Console Rx buffer length 924c92fac91SHeiko Schocher With CONFIG_SYS_SMC_RXBUFLEN it is possible to define 925c92fac91SHeiko Schocher the maximum receive buffer length for the SMC. 9262b3f12c2SHeiko Schocher This option is actual only for 82xx and 8xx possible. 927c92fac91SHeiko Schocher If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE 928c92fac91SHeiko Schocher must be defined, to setup the maximum idle timeout for 929c92fac91SHeiko Schocher the SMC. 930c92fac91SHeiko Schocher 9319558b48aSGraeme Russ- Pre-Console Buffer: 9329558b48aSGraeme Russ Prior to the console being initialised (i.e. serial UART 9339558b48aSGraeme Russ initialised etc) all console output is silently discarded. 9349558b48aSGraeme Russ Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to 9359558b48aSGraeme Russ buffer any console messages prior to the console being 9369558b48aSGraeme Russ initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ 9379558b48aSGraeme Russ bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is 9389558b48aSGraeme Russ a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ 9399558b48aSGraeme Russ bytes are output before the console is initialised, the 9409558b48aSGraeme Russ earlier bytes are discarded. 9419558b48aSGraeme Russ 942a8552c7cSHans de Goede Note that when printing the buffer a copy is made on the 943a8552c7cSHans de Goede stack so CONFIG_PRE_CON_BUF_SZ must fit on the stack. 944a8552c7cSHans de Goede 9459558b48aSGraeme Russ 'Sane' compilers will generate smaller code if 9469558b48aSGraeme Russ CONFIG_PRE_CON_BUF_SZ is a power of 2 9479558b48aSGraeme Russ 948046a37bdSSonny Rao- Safe printf() functions 949046a37bdSSonny Rao Define CONFIG_SYS_VSNPRINTF to compile in safe versions of 950046a37bdSSonny Rao the printf() functions. These are defined in 951046a37bdSSonny Rao include/vsprintf.h and include snprintf(), vsnprintf() and 952046a37bdSSonny Rao so on. Code size increase is approximately 300-500 bytes. 953046a37bdSSonny Rao If this option is not given then these functions will 954046a37bdSSonny Rao silently discard their buffer size argument - this means 955046a37bdSSonny Rao you are not getting any overflow checking in this case. 956046a37bdSSonny Rao 957c609719bSwdenk- Boot Delay: CONFIG_BOOTDELAY - in seconds 958c609719bSwdenk Delay before automatically booting the default image; 959c609719bSwdenk set to -1 to disable autoboot. 96093d7212fSJoe Hershberger set to -2 to autoboot with no delay and not check for abort 96193d7212fSJoe Hershberger (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined). 962c609719bSwdenk 963c609719bSwdenk See doc/README.autoboot for these options that 964c609719bSwdenk work with CONFIG_BOOTDELAY. None are required. 965c609719bSwdenk CONFIG_BOOT_RETRY_TIME 966c609719bSwdenk CONFIG_BOOT_RETRY_MIN 967c609719bSwdenk CONFIG_AUTOBOOT_KEYED 968c609719bSwdenk CONFIG_AUTOBOOT_PROMPT 969c609719bSwdenk CONFIG_AUTOBOOT_DELAY_STR 970c609719bSwdenk CONFIG_AUTOBOOT_STOP_STR 971c609719bSwdenk CONFIG_ZERO_BOOTDELAY_CHECK 972c609719bSwdenk CONFIG_RESET_TO_RETRY 973c609719bSwdenk 974c609719bSwdenk- Autoboot Command: 975c609719bSwdenk CONFIG_BOOTCOMMAND 976c609719bSwdenk Only needed when CONFIG_BOOTDELAY is enabled; 977c609719bSwdenk define a command string that is automatically executed 978c609719bSwdenk when no character is read on the console interface 979c609719bSwdenk within "Boot Delay" after reset. 980c609719bSwdenk 981c609719bSwdenk CONFIG_BOOTARGS 982c609719bSwdenk This can be used to pass arguments to the bootm 983c609719bSwdenk command. The value of CONFIG_BOOTARGS goes into the 984c609719bSwdenk environment value "bootargs". 985c609719bSwdenk 986c609719bSwdenk CONFIG_RAMBOOT and CONFIG_NFSBOOT 987c609719bSwdenk The value of these goes into the environment as 988c609719bSwdenk "ramboot" and "nfsboot" respectively, and can be used 989c609719bSwdenk as a convenience, when switching between booting from 99011ccc33fSMarcel Ziswiler RAM and NFS. 991c609719bSwdenk 992eda0ba38SHeiko Schocher- Bootcount: 993eda0ba38SHeiko Schocher CONFIG_BOOTCOUNT_LIMIT 994eda0ba38SHeiko Schocher Implements a mechanism for detecting a repeating reboot 995eda0ba38SHeiko Schocher cycle, see: 996eda0ba38SHeiko Schocher http://www.denx.de/wiki/view/DULG/UBootBootCountLimit 997eda0ba38SHeiko Schocher 998eda0ba38SHeiko Schocher CONFIG_BOOTCOUNT_ENV 999eda0ba38SHeiko Schocher If no softreset save registers are found on the hardware 1000eda0ba38SHeiko Schocher "bootcount" is stored in the environment. To prevent a 1001eda0ba38SHeiko Schocher saveenv on all reboots, the environment variable 1002eda0ba38SHeiko Schocher "upgrade_available" is used. If "upgrade_available" is 1003eda0ba38SHeiko Schocher 0, "bootcount" is always 0, if "upgrade_available" is 1004eda0ba38SHeiko Schocher 1 "bootcount" is incremented in the environment. 1005eda0ba38SHeiko Schocher So the Userspace Applikation must set the "upgrade_available" 1006eda0ba38SHeiko Schocher and "bootcount" variable to 0, if a boot was successfully. 1007eda0ba38SHeiko Schocher 1008c609719bSwdenk- Pre-Boot Commands: 1009c609719bSwdenk CONFIG_PREBOOT 1010c609719bSwdenk 1011c609719bSwdenk When this option is #defined, the existence of the 1012c609719bSwdenk environment variable "preboot" will be checked 1013c609719bSwdenk immediately before starting the CONFIG_BOOTDELAY 1014c609719bSwdenk countdown and/or running the auto-boot command resp. 1015c609719bSwdenk entering interactive mode. 1016c609719bSwdenk 1017c609719bSwdenk This feature is especially useful when "preboot" is 1018c609719bSwdenk automatically generated or modified. For an example 1019c609719bSwdenk see the LWMON board specific code: here "preboot" is 1020c609719bSwdenk modified when the user holds down a certain 1021c609719bSwdenk combination of keys on the (special) keyboard when 1022c609719bSwdenk booting the systems 1023c609719bSwdenk 1024c609719bSwdenk- Serial Download Echo Mode: 1025c609719bSwdenk CONFIG_LOADS_ECHO 1026c609719bSwdenk If defined to 1, all characters received during a 1027c609719bSwdenk serial download (using the "loads" command) are 1028c609719bSwdenk echoed back. This might be needed by some terminal 1029c609719bSwdenk emulations (like "cu"), but may as well just take 1030c609719bSwdenk time on others. This setting #define's the initial 1031c609719bSwdenk value of the "loads_echo" environment variable. 1032c609719bSwdenk 1033602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined) 1034c609719bSwdenk CONFIG_KGDB_BAUDRATE 1035c609719bSwdenk Select one of the baudrates listed in 10366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BAUDRATE_TABLE, see below. 1037c609719bSwdenk 1038c609719bSwdenk- Monitor Functions: 1039602ad3b3SJon Loeliger Monitor commands can be included or excluded 1040602ad3b3SJon Loeliger from the build by using the #include files 1041c6c621bdSStephen Warren <config_cmd_all.h> and #undef'ing unwanted 1042ef0f2f57SJoe Hershberger commands, or adding #define's for wanted commands. 1043c609719bSwdenk 1044602ad3b3SJon Loeliger The default command configuration includes all commands 1045602ad3b3SJon Loeliger except those marked below with a "*". 1046602ad3b3SJon Loeliger 1047b401b73dSMarek Vasut CONFIG_CMD_AES AES 128 CBC encrypt/decrypt 1048602ad3b3SJon Loeliger CONFIG_CMD_ASKENV * ask for env variable 1049602ad3b3SJon Loeliger CONFIG_CMD_BDI bdinfo 1050602ad3b3SJon Loeliger CONFIG_CMD_BEDBUG * Include BedBug Debugger 1051602ad3b3SJon Loeliger CONFIG_CMD_BMP * BMP support 1052602ad3b3SJon Loeliger CONFIG_CMD_BSP * Board specific commands 1053602ad3b3SJon Loeliger CONFIG_CMD_BOOTD bootd 1054d2b2ffe3STom Rini CONFIG_CMD_BOOTI * ARM64 Linux kernel Image support 1055602ad3b3SJon Loeliger CONFIG_CMD_CACHE * icache, dcache 105608d0d6f3SMichal Simek CONFIG_CMD_CLK * clock command support 1057602ad3b3SJon Loeliger CONFIG_CMD_CONSOLE coninfo 1058710b9938SMike Frysinger CONFIG_CMD_CRC32 * crc32 1059602ad3b3SJon Loeliger CONFIG_CMD_DATE * support for RTC, date/time... 1060602ad3b3SJon Loeliger CONFIG_CMD_DHCP * DHCP support 1061602ad3b3SJon Loeliger CONFIG_CMD_DIAG * Diagnostics 1062a7c93104SPeter Tyser CONFIG_CMD_DS4510 * ds4510 I2C gpio commands 1063a7c93104SPeter Tyser CONFIG_CMD_DS4510_INFO * ds4510 I2C info command 1064a7c93104SPeter Tyser CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd 1065a7c93104SPeter Tyser CONFIG_CMD_DS4510_RST * ds4510 I2C rst command 1066602ad3b3SJon Loeliger CONFIG_CMD_DTT * Digital Therm and Thermostat 1067602ad3b3SJon Loeliger CONFIG_CMD_ECHO echo arguments 1068246c6922SPeter Tyser CONFIG_CMD_EDITENV edit env variable 1069602ad3b3SJon Loeliger CONFIG_CMD_EEPROM * EEPROM read/write support 1070602ad3b3SJon Loeliger CONFIG_CMD_ELF * bootelf, bootvx 10715e2b3e0cSJoe Hershberger CONFIG_CMD_ENV_CALLBACK * display details about env callbacks 1072fffad71bSJoe Hershberger CONFIG_CMD_ENV_FLAGS * display details about env flags 107388733e2cSAndrew Ruder CONFIG_CMD_ENV_EXISTS * check existence of env variable 10740c79cda0SMike Frysinger CONFIG_CMD_EXPORTENV * export the environment 107503e2ecf6SStephen Warren CONFIG_CMD_EXT2 * ext2 command support 107603e2ecf6SStephen Warren CONFIG_CMD_EXT4 * ext4 command support 107716f4d933SStephen Warren CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls) 107816f4d933SStephen Warren that work for multiple fs types 107959e890efSChristian Gmeiner CONFIG_CMD_FS_UUID * Look up a filesystem UUID 1080bdab39d3SMike Frysinger CONFIG_CMD_SAVEENV saveenv 1081602ad3b3SJon Loeliger CONFIG_CMD_FDC * Floppy Disk Support 108203e2ecf6SStephen Warren CONFIG_CMD_FAT * FAT command support 1083602ad3b3SJon Loeliger CONFIG_CMD_FLASH flinfo, erase, protect 1084602ad3b3SJon Loeliger CONFIG_CMD_FPGA FPGA device initialization support 10854d98b5c8SVincent Stehlé CONFIG_CMD_FUSE * Device fuse support 108653fdc7efSAnton Staaf CONFIG_CMD_GETTIME * Get time since boot 1087a641b979SMike Frysinger CONFIG_CMD_GO * the 'go' command (exec code) 1088a000b795SKim Phillips CONFIG_CMD_GREPENV * search environment 1089bf36c5d5SSimon Glass CONFIG_CMD_HASH * calculate hash / digest 1090602ad3b3SJon Loeliger CONFIG_CMD_HWFLOW * RTS/CTS hw flow control 1091602ad3b3SJon Loeliger CONFIG_CMD_I2C * I2C serial bus support 1092602ad3b3SJon Loeliger CONFIG_CMD_IDE * IDE harddisk support 1093602ad3b3SJon Loeliger CONFIG_CMD_IMI iminfo 10948fdf1e0fSVipin Kumar CONFIG_CMD_IMLS List all images found in NOR flash 10954d98b5c8SVincent Stehlé CONFIG_CMD_IMLS_NAND * List all images found in NAND flash 1096602ad3b3SJon Loeliger CONFIG_CMD_IMMAP * IMMR dump support 1097aa53233aSSimon Glass CONFIG_CMD_IOTRACE * I/O tracing for debugging 10980c79cda0SMike Frysinger CONFIG_CMD_IMPORTENV * import an environment 1099c167cc02SJoe Hershberger CONFIG_CMD_INI * import data from an ini file into the env 1100602ad3b3SJon Loeliger CONFIG_CMD_IRQ * irqinfo 1101602ad3b3SJon Loeliger CONFIG_CMD_ITEST Integer/string test of 2 values 1102602ad3b3SJon Loeliger CONFIG_CMD_JFFS2 * JFFS2 Support 1103602ad3b3SJon Loeliger CONFIG_CMD_KGDB * kgdb 11044d98b5c8SVincent Stehlé CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader) 1105d22c338eSJoe Hershberger CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration 1106d22c338eSJoe Hershberger (169.254.*.*) 1107602ad3b3SJon Loeliger CONFIG_CMD_LOADB loadb 1108602ad3b3SJon Loeliger CONFIG_CMD_LOADS loads 11094d98b5c8SVincent Stehlé CONFIG_CMD_MD5SUM * print md5 message digest 111002c9aa1dSRobin Getz (requires CONFIG_CMD_MEMORY and CONFIG_MD5) 111115a33e49SSimon Glass CONFIG_CMD_MEMINFO * Display detailed memory information 1112602ad3b3SJon Loeliger CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base, 1113a2681707SWolfgang Denk loop, loopw 11144d98b5c8SVincent Stehlé CONFIG_CMD_MEMTEST * mtest 1115602ad3b3SJon Loeliger CONFIG_CMD_MISC Misc functions like sleep etc 1116602ad3b3SJon Loeliger CONFIG_CMD_MMC * MMC memory mapped support 1117602ad3b3SJon Loeliger CONFIG_CMD_MII * MII utility commands 111868d7d651SStefan Roese CONFIG_CMD_MTDPARTS * MTD partition support 1119602ad3b3SJon Loeliger CONFIG_CMD_NAND * NAND support 1120602ad3b3SJon Loeliger CONFIG_CMD_NET bootp, tftpboot, rarpboot 11214d98b5c8SVincent Stehlé CONFIG_CMD_NFS NFS support 1122e92739d3SPeter Tyser CONFIG_CMD_PCA953X * PCA953x I2C gpio commands 1123e92739d3SPeter Tyser CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command 1124602ad3b3SJon Loeliger CONFIG_CMD_PCI * pciinfo 1125602ad3b3SJon Loeliger CONFIG_CMD_PCMCIA * PCMCIA support 1126602ad3b3SJon Loeliger CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network 1127602ad3b3SJon Loeliger host 1128602ad3b3SJon Loeliger CONFIG_CMD_PORTIO * Port I/O 1129ff048ea9SKenneth Waters CONFIG_CMD_READ * Read raw data from partition 1130602ad3b3SJon Loeliger CONFIG_CMD_REGINFO * Register dump 1131602ad3b3SJon Loeliger CONFIG_CMD_RUN run command in env variable 1132d304931fSSimon Glass CONFIG_CMD_SANDBOX * sb command to access sandbox features 1133602ad3b3SJon Loeliger CONFIG_CMD_SAVES * save S record dump 1134602ad3b3SJon Loeliger CONFIG_CMD_SCSI * SCSI Support 1135602ad3b3SJon Loeliger CONFIG_CMD_SDRAM * print SDRAM configuration information 1136602ad3b3SJon Loeliger (requires CONFIG_CMD_I2C) 1137602ad3b3SJon Loeliger CONFIG_CMD_SETGETDCR Support for DCR Register access 1138602ad3b3SJon Loeliger (4xx only) 1139f61ec45eSEric Nelson CONFIG_CMD_SF * Read/write/erase SPI NOR flash 11404d98b5c8SVincent Stehlé CONFIG_CMD_SHA1SUM * print sha1 memory digest 114102c9aa1dSRobin Getz (requires CONFIG_CMD_MEMORY) 11427d861d95SBob Liu CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x 114374de7aefSWolfgang Denk CONFIG_CMD_SOURCE "source" command Support 1144602ad3b3SJon Loeliger CONFIG_CMD_SPI * SPI serial bus support 11457a83af07SLuca Ceresoli CONFIG_CMD_TFTPSRV * TFTP transfer in server mode 11461fb7cd49SSimon Glass CONFIG_CMD_TFTPPUT * TFTP put command (upload) 1147da83bcd7SJoe Hershberger CONFIG_CMD_TIME * run command and report execution time (ARM specific) 1148da83bcd7SJoe Hershberger CONFIG_CMD_TIMER * access to the system tick timer 1149602ad3b3SJon Loeliger CONFIG_CMD_USB * USB support 1150602ad3b3SJon Loeliger CONFIG_CMD_CDP * Cisco Discover Protocol support 1151c8339f51SMarek Vasut CONFIG_CMD_MFSL * Microblaze FSL support 11524d98b5c8SVincent Stehlé CONFIG_CMD_XIMG Load part of Multi Image 115389c8230dSPrzemyslaw Marczak CONFIG_CMD_UUID * Generate random UUID or GUID string 1154c609719bSwdenk 1155c609719bSwdenk EXAMPLE: If you want all functions except of network 1156c609719bSwdenk support you can write: 1157c609719bSwdenk 1158602ad3b3SJon Loeliger #include "config_cmd_all.h" 1159602ad3b3SJon Loeliger #undef CONFIG_CMD_NET 1160c609719bSwdenk 1161213bf8c8SGerald Van Baren Other Commands: 1162213bf8c8SGerald Van Baren fdt (flattened device tree) command: CONFIG_OF_LIBFDT 1163c609719bSwdenk 1164c609719bSwdenk Note: Don't enable the "icache" and "dcache" commands 1165602ad3b3SJon Loeliger (configuration option CONFIG_CMD_CACHE) unless you know 1166c609719bSwdenk what you (and your U-Boot users) are doing. Data 1167c609719bSwdenk cache cannot be enabled on systems like the 8xx or 1168c609719bSwdenk 8260 (where accesses to the IMMR region must be 1169c609719bSwdenk uncached), and it cannot be disabled on all other 1170c609719bSwdenk systems where we (mis-) use the data cache to hold an 1171c609719bSwdenk initial stack and some data. 1172c609719bSwdenk 1173c609719bSwdenk 1174c609719bSwdenk XXX - this list needs to get updated! 1175c609719bSwdenk 1176a5ecbe62SWolfgang Denk- Regular expression support: 1177a5ecbe62SWolfgang Denk CONFIG_REGEX 1178a5ecbe62SWolfgang Denk If this variable is defined, U-Boot is linked against 1179a5ecbe62SWolfgang Denk the SLRE (Super Light Regular Expression) library, 1180a5ecbe62SWolfgang Denk which adds regex support to some commands, as for 1181a5ecbe62SWolfgang Denk example "env grep" and "setexpr". 1182a5ecbe62SWolfgang Denk 118345ba8077SSimon Glass- Device tree: 118445ba8077SSimon Glass CONFIG_OF_CONTROL 118545ba8077SSimon Glass If this variable is defined, U-Boot will use a device tree 118645ba8077SSimon Glass to configure its devices, instead of relying on statically 118745ba8077SSimon Glass compiled #defines in the board file. This option is 118845ba8077SSimon Glass experimental and only available on a few boards. The device 118945ba8077SSimon Glass tree is available in the global data as gd->fdt_blob. 119045ba8077SSimon Glass 11912c0f79e4SSimon Glass U-Boot needs to get its device tree from somewhere. This can 11922c0f79e4SSimon Glass be done using one of the two options below: 1193bbb0b128SSimon Glass 1194bbb0b128SSimon Glass CONFIG_OF_EMBED 1195bbb0b128SSimon Glass If this variable is defined, U-Boot will embed a device tree 1196bbb0b128SSimon Glass binary in its image. This device tree file should be in the 1197bbb0b128SSimon Glass board directory and called <soc>-<board>.dts. The binary file 1198bbb0b128SSimon Glass is then picked up in board_init_f() and made available through 1199bbb0b128SSimon Glass the global data structure as gd->blob. 120045ba8077SSimon Glass 12012c0f79e4SSimon Glass CONFIG_OF_SEPARATE 12022c0f79e4SSimon Glass If this variable is defined, U-Boot will build a device tree 12032c0f79e4SSimon Glass binary. It will be called u-boot.dtb. Architecture-specific 12042c0f79e4SSimon Glass code will locate it at run-time. Generally this works by: 12052c0f79e4SSimon Glass 12062c0f79e4SSimon Glass cat u-boot.bin u-boot.dtb >image.bin 12072c0f79e4SSimon Glass 12082c0f79e4SSimon Glass and in fact, U-Boot does this for you, creating a file called 12092c0f79e4SSimon Glass u-boot-dtb.bin which is useful in the common case. You can 12102c0f79e4SSimon Glass still use the individual files if you need something more 12112c0f79e4SSimon Glass exotic. 12122c0f79e4SSimon Glass 1213c609719bSwdenk- Watchdog: 1214c609719bSwdenk CONFIG_WATCHDOG 1215c609719bSwdenk If this variable is defined, it enables watchdog 12166abe6fb6SDetlev Zundel support for the SoC. There must be support in the SoC 12176abe6fb6SDetlev Zundel specific code for a watchdog. For the 8xx and 8260 12186abe6fb6SDetlev Zundel CPUs, the SIU Watchdog feature is enabled in the SYPCR 12196abe6fb6SDetlev Zundel register. When supported for a specific SoC is 12206abe6fb6SDetlev Zundel available, then no further board specific code should 12216abe6fb6SDetlev Zundel be needed to use it. 12226abe6fb6SDetlev Zundel 12236abe6fb6SDetlev Zundel CONFIG_HW_WATCHDOG 12246abe6fb6SDetlev Zundel When using a watchdog circuitry external to the used 12256abe6fb6SDetlev Zundel SoC, then define this variable and provide board 12266abe6fb6SDetlev Zundel specific code for the "hw_watchdog_reset" function. 1227c609719bSwdenk 12287bae0d6fSHeiko Schocher CONFIG_AT91_HW_WDT_TIMEOUT 12297bae0d6fSHeiko Schocher specify the timeout in seconds. default 2 seconds. 12307bae0d6fSHeiko Schocher 1231c1551ea8Sstroese- U-Boot Version: 1232c1551ea8Sstroese CONFIG_VERSION_VARIABLE 1233c1551ea8Sstroese If this variable is defined, an environment variable 1234c1551ea8Sstroese named "ver" is created by U-Boot showing the U-Boot 1235c1551ea8Sstroese version as printed by the "version" command. 1236a1ea8e51SBenoît Thébaudeau Any change to this variable will be reverted at the 1237a1ea8e51SBenoît Thébaudeau next reset. 1238c1551ea8Sstroese 1239c609719bSwdenk- Real-Time Clock: 1240c609719bSwdenk 1241602ad3b3SJon Loeliger When CONFIG_CMD_DATE is selected, the type of the RTC 1242c609719bSwdenk has to be selected, too. Define exactly one of the 1243c609719bSwdenk following options: 1244c609719bSwdenk 1245c609719bSwdenk CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx 1246c609719bSwdenk CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC 12474e8b7544SFabio Estevam CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC 1248c609719bSwdenk CONFIG_RTC_MC146818 - use MC146818 RTC 12491cb8e980Swdenk CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC 1250c609719bSwdenk CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC 12517f70e853Swdenk CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC 1252412921d2SMarkus Niebel CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC 12533bac3513Swdenk CONFIG_RTC_DS164x - use Dallas DS164x RTC 12549536dfccSTor Krill CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC 12554c0d4c3bSwdenk CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC 12566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337 125771d19f30SHeiko Schocher CONFIG_SYS_RV3029_TCR - enable trickle charger on 125871d19f30SHeiko Schocher RV3029 RTC. 1259c609719bSwdenk 1260b37c7e5eSwdenk Note that if the RTC uses I2C, then the I2C interface 1261b37c7e5eSwdenk must also be configured. See I2C Support, below. 1262b37c7e5eSwdenk 1263e92739d3SPeter Tyser- GPIO Support: 1264e92739d3SPeter Tyser CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO 1265e92739d3SPeter Tyser 12665dec49caSChris Packham The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of 12675dec49caSChris Packham chip-ngpio pairs that tell the PCA953X driver the number of 12685dec49caSChris Packham pins supported by a particular chip. 12695dec49caSChris Packham 1270e92739d3SPeter Tyser Note that if the GPIO device uses I2C, then the I2C interface 1271e92739d3SPeter Tyser must also be configured. See I2C Support, below. 1272e92739d3SPeter Tyser 1273aa53233aSSimon Glass- I/O tracing: 1274aa53233aSSimon Glass When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O 1275aa53233aSSimon Glass accesses and can checksum them or write a list of them out 1276aa53233aSSimon Glass to memory. See the 'iotrace' command for details. This is 1277aa53233aSSimon Glass useful for testing device drivers since it can confirm that 1278aa53233aSSimon Glass the driver behaves the same way before and after a code 1279aa53233aSSimon Glass change. Currently this is supported on sandbox and arm. To 1280aa53233aSSimon Glass add support for your architecture, add '#include <iotrace.h>' 1281aa53233aSSimon Glass to the bottom of arch/<arch>/include/asm/io.h and test. 1282aa53233aSSimon Glass 1283aa53233aSSimon Glass Example output from the 'iotrace stats' command is below. 1284aa53233aSSimon Glass Note that if the trace buffer is exhausted, the checksum will 1285aa53233aSSimon Glass still continue to operate. 1286aa53233aSSimon Glass 1287aa53233aSSimon Glass iotrace is enabled 1288aa53233aSSimon Glass Start: 10000000 (buffer start address) 1289aa53233aSSimon Glass Size: 00010000 (buffer size) 1290aa53233aSSimon Glass Offset: 00000120 (current buffer offset) 1291aa53233aSSimon Glass Output: 10000120 (start + offset) 1292aa53233aSSimon Glass Count: 00000018 (number of trace records) 1293aa53233aSSimon Glass CRC32: 9526fb66 (CRC32 of all trace records) 1294aa53233aSSimon Glass 1295c609719bSwdenk- Timestamp Support: 1296c609719bSwdenk 1297c609719bSwdenk When CONFIG_TIMESTAMP is selected, the timestamp 1298c609719bSwdenk (date and time) of an image is printed by image 1299c609719bSwdenk commands like bootm or iminfo. This option is 1300602ad3b3SJon Loeliger automatically enabled when you select CONFIG_CMD_DATE . 1301c609719bSwdenk 1302923c46f9SKarl O. Pinc- Partition Labels (disklabels) Supported: 1303923c46f9SKarl O. Pinc Zero or more of the following: 1304923c46f9SKarl O. Pinc CONFIG_MAC_PARTITION Apple's MacOS partition table. 1305923c46f9SKarl O. Pinc CONFIG_DOS_PARTITION MS Dos partition table, traditional on the 1306923c46f9SKarl O. Pinc Intel architecture, USB sticks, etc. 1307923c46f9SKarl O. Pinc CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc. 1308923c46f9SKarl O. Pinc CONFIG_EFI_PARTITION GPT partition table, common when EFI is the 1309923c46f9SKarl O. Pinc bootloader. Note 2TB partition limit; see 1310923c46f9SKarl O. Pinc disk/part_efi.c 1311923c46f9SKarl O. Pinc CONFIG_MTD_PARTITIONS Memory Technology Device partition table. 1312c609719bSwdenk 1313602ad3b3SJon Loeliger If IDE or SCSI support is enabled (CONFIG_CMD_IDE or 1314218ca724SWolfgang Denk CONFIG_CMD_SCSI) you must configure support for at 1315923c46f9SKarl O. Pinc least one non-MTD partition type as well. 1316c609719bSwdenk 1317c609719bSwdenk- IDE Reset method: 13184d13cbadSwdenk CONFIG_IDE_RESET_ROUTINE - this is defined in several 13194d13cbadSwdenk board configurations files but used nowhere! 1320c609719bSwdenk 13214d13cbadSwdenk CONFIG_IDE_RESET - is this is defined, IDE Reset will 13224d13cbadSwdenk be performed by calling the function 13234d13cbadSwdenk ide_set_reset(int reset) 13244d13cbadSwdenk which has to be defined in a board specific file 1325c609719bSwdenk 1326c609719bSwdenk- ATAPI Support: 1327c609719bSwdenk CONFIG_ATAPI 1328c609719bSwdenk 1329c609719bSwdenk Set this to enable ATAPI support. 1330c609719bSwdenk 1331c40b2956Swdenk- LBA48 Support 1332c40b2956Swdenk CONFIG_LBA48 1333c40b2956Swdenk 1334c40b2956Swdenk Set this to enable support for disks larger than 137GB 13354b142febSHeiko Schocher Also look at CONFIG_SYS_64BIT_LBA. 1336c40b2956Swdenk Whithout these , LBA48 support uses 32bit variables and will 'only' 1337c40b2956Swdenk support disks up to 2.1TB. 1338c40b2956Swdenk 13396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_64BIT_LBA: 1340c40b2956Swdenk When enabled, makes the IDE subsystem use 64bit sector addresses. 1341c40b2956Swdenk Default is 32bit. 1342c40b2956Swdenk 1343c609719bSwdenk- SCSI Support: 1344c609719bSwdenk At the moment only there is only support for the 1345c609719bSwdenk SYM53C8XX SCSI controller; define 1346c609719bSwdenk CONFIG_SCSI_SYM53C8XX to enable it. 1347c609719bSwdenk 13486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and 13496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID * 13506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the 1351c609719bSwdenk maximum numbers of LUNs, SCSI ID's and target 1352c609719bSwdenk devices. 13536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz) 1354c609719bSwdenk 1355447c031bSStefan Reinauer The environment variable 'scsidevs' is set to the number of 1356447c031bSStefan Reinauer SCSI devices found during the last scan. 1357447c031bSStefan Reinauer 1358c609719bSwdenk- NETWORK Support (PCI): 1359682011ffSwdenk CONFIG_E1000 1360ce5207e1SKyle Moffett Support for Intel 8254x/8257x gigabit chips. 1361ce5207e1SKyle Moffett 1362ce5207e1SKyle Moffett CONFIG_E1000_SPI 1363ce5207e1SKyle Moffett Utility code for direct access to the SPI bus on Intel 8257x. 1364ce5207e1SKyle Moffett This does not do anything useful unless you set at least one 1365ce5207e1SKyle Moffett of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC. 1366ce5207e1SKyle Moffett 1367ce5207e1SKyle Moffett CONFIG_E1000_SPI_GENERIC 1368ce5207e1SKyle Moffett Allow generic access to the SPI bus on the Intel 8257x, for 1369ce5207e1SKyle Moffett example with the "sspi" command. 1370ce5207e1SKyle Moffett 1371ce5207e1SKyle Moffett CONFIG_CMD_E1000 1372ce5207e1SKyle Moffett Management command for E1000 devices. When used on devices 1373ce5207e1SKyle Moffett with SPI support you can reprogram the EEPROM from U-Boot. 1374682011ffSwdenk 1375c609719bSwdenk CONFIG_EEPRO100 1376c609719bSwdenk Support for Intel 82557/82559/82559ER chips. 137711ccc33fSMarcel Ziswiler Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM 1378c609719bSwdenk write routine for first time initialisation. 1379c609719bSwdenk 1380c609719bSwdenk CONFIG_TULIP 1381c609719bSwdenk Support for Digital 2114x chips. 1382c609719bSwdenk Optional CONFIG_TULIP_SELECT_MEDIA for board specific 1383c609719bSwdenk modem chip initialisation (KS8761/QS6611). 1384c609719bSwdenk 1385c609719bSwdenk CONFIG_NATSEMI 1386c609719bSwdenk Support for National dp83815 chips. 1387c609719bSwdenk 1388c609719bSwdenk CONFIG_NS8382X 1389c609719bSwdenk Support for National dp8382[01] gigabit chips. 1390c609719bSwdenk 139145219c46Swdenk- NETWORK Support (other): 139245219c46Swdenk 1393c041e9d2SJens Scharsig CONFIG_DRIVER_AT91EMAC 1394c041e9d2SJens Scharsig Support for AT91RM9200 EMAC. 1395c041e9d2SJens Scharsig 1396c041e9d2SJens Scharsig CONFIG_RMII 1397c041e9d2SJens Scharsig Define this to use reduced MII inteface 1398c041e9d2SJens Scharsig 1399c041e9d2SJens Scharsig CONFIG_DRIVER_AT91EMAC_QUIET 1400c041e9d2SJens Scharsig If this defined, the driver is quiet. 1401c041e9d2SJens Scharsig The driver doen't show link status messages. 1402c041e9d2SJens Scharsig 1403efdd7319SRob Herring CONFIG_CALXEDA_XGMAC 1404efdd7319SRob Herring Support for the Calxeda XGMAC device 1405efdd7319SRob Herring 14063bb46d23SAshok CONFIG_LAN91C96 140745219c46Swdenk Support for SMSC's LAN91C96 chips. 140845219c46Swdenk 140945219c46Swdenk CONFIG_LAN91C96_BASE 141045219c46Swdenk Define this to hold the physical address 141145219c46Swdenk of the LAN91C96's I/O space 141245219c46Swdenk 141345219c46Swdenk CONFIG_LAN91C96_USE_32_BIT 141445219c46Swdenk Define this to enable 32 bit addressing 141545219c46Swdenk 14163bb46d23SAshok CONFIG_SMC91111 1417f39748aeSwdenk Support for SMSC's LAN91C111 chip 1418f39748aeSwdenk 1419f39748aeSwdenk CONFIG_SMC91111_BASE 1420f39748aeSwdenk Define this to hold the physical address 1421f39748aeSwdenk of the device (I/O space) 1422f39748aeSwdenk 1423f39748aeSwdenk CONFIG_SMC_USE_32_BIT 1424f39748aeSwdenk Define this if data bus is 32 bits 1425f39748aeSwdenk 1426f39748aeSwdenk CONFIG_SMC_USE_IOFUNCS 1427f39748aeSwdenk Define this to use i/o functions instead of macros 1428f39748aeSwdenk (some hardware wont work with macros) 1429f39748aeSwdenk 1430dc02badaSHeiko Schocher CONFIG_DRIVER_TI_EMAC 1431dc02badaSHeiko Schocher Support for davinci emac 1432dc02badaSHeiko Schocher 1433dc02badaSHeiko Schocher CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT 1434dc02badaSHeiko Schocher Define this if you have more then 3 PHYs. 1435dc02badaSHeiko Schocher 1436b3dbf4a5SMacpaul Lin CONFIG_FTGMAC100 1437b3dbf4a5SMacpaul Lin Support for Faraday's FTGMAC100 Gigabit SoC Ethernet 1438b3dbf4a5SMacpaul Lin 1439b3dbf4a5SMacpaul Lin CONFIG_FTGMAC100_EGIGA 1440b3dbf4a5SMacpaul Lin Define this to use GE link update with gigabit PHY. 1441b3dbf4a5SMacpaul Lin Define this if FTGMAC100 is connected to gigabit PHY. 1442b3dbf4a5SMacpaul Lin If your system has 10/100 PHY only, it might not occur 1443b3dbf4a5SMacpaul Lin wrong behavior. Because PHY usually return timeout or 1444b3dbf4a5SMacpaul Lin useless data when polling gigabit status and gigabit 1445b3dbf4a5SMacpaul Lin control registers. This behavior won't affect the 1446b3dbf4a5SMacpaul Lin correctnessof 10/100 link speed update. 1447b3dbf4a5SMacpaul Lin 1448c2fff331SMike Rapoport CONFIG_SMC911X 1449557b377dSJens Gehrlein Support for SMSC's LAN911x and LAN921x chips 1450557b377dSJens Gehrlein 1451c2fff331SMike Rapoport CONFIG_SMC911X_BASE 1452557b377dSJens Gehrlein Define this to hold the physical address 1453557b377dSJens Gehrlein of the device (I/O space) 1454557b377dSJens Gehrlein 1455c2fff331SMike Rapoport CONFIG_SMC911X_32_BIT 1456557b377dSJens Gehrlein Define this if data bus is 32 bits 1457557b377dSJens Gehrlein 1458c2fff331SMike Rapoport CONFIG_SMC911X_16_BIT 1459557b377dSJens Gehrlein Define this if data bus is 16 bits. If your processor 1460557b377dSJens Gehrlein automatically converts one 32 bit word to two 16 bit 1461c2fff331SMike Rapoport words you may also try CONFIG_SMC911X_32_BIT. 1462557b377dSJens Gehrlein 14633d0075faSYoshihiro Shimoda CONFIG_SH_ETHER 14643d0075faSYoshihiro Shimoda Support for Renesas on-chip Ethernet controller 14653d0075faSYoshihiro Shimoda 14663d0075faSYoshihiro Shimoda CONFIG_SH_ETHER_USE_PORT 14673d0075faSYoshihiro Shimoda Define the number of ports to be used 14683d0075faSYoshihiro Shimoda 14693d0075faSYoshihiro Shimoda CONFIG_SH_ETHER_PHY_ADDR 14703d0075faSYoshihiro Shimoda Define the ETH PHY's address 14713d0075faSYoshihiro Shimoda 147268260aabSYoshihiro Shimoda CONFIG_SH_ETHER_CACHE_WRITEBACK 147368260aabSYoshihiro Shimoda If this option is set, the driver enables cache flush. 147468260aabSYoshihiro Shimoda 1475b2f97cf2SHeiko Schocher- PWM Support: 1476b2f97cf2SHeiko Schocher CONFIG_PWM_IMX 1477b2f97cf2SHeiko Schocher Support for PWM modul on the imx6. 1478b2f97cf2SHeiko Schocher 14795e124724SVadim Bendebury- TPM Support: 148090899cc0SChe-liang Chiou CONFIG_TPM 148190899cc0SChe-liang Chiou Support TPM devices. 148290899cc0SChe-liang Chiou 14831b393db5STom Wai-Hong Tam CONFIG_TPM_TIS_I2C 14841b393db5STom Wai-Hong Tam Support for i2c bus TPM devices. Only one device 14851b393db5STom Wai-Hong Tam per system is supported at this time. 14861b393db5STom Wai-Hong Tam 14871b393db5STom Wai-Hong Tam CONFIG_TPM_TIS_I2C_BURST_LIMITATION 14881b393db5STom Wai-Hong Tam Define the burst count bytes upper limit 14891b393db5STom Wai-Hong Tam 1490c01939c7SDirk Eibach CONFIG_TPM_ATMEL_TWI 1491c01939c7SDirk Eibach Support for Atmel TWI TPM device. Requires I2C support. 1492c01939c7SDirk Eibach 149390899cc0SChe-liang Chiou CONFIG_TPM_TIS_LPC 14945e124724SVadim Bendebury Support for generic parallel port TPM devices. Only one device 14955e124724SVadim Bendebury per system is supported at this time. 14965e124724SVadim Bendebury 14975e124724SVadim Bendebury CONFIG_TPM_TIS_BASE_ADDRESS 14985e124724SVadim Bendebury Base address where the generic TPM device is mapped 14995e124724SVadim Bendebury to. Contemporary x86 systems usually map it at 15005e124724SVadim Bendebury 0xfed40000. 15015e124724SVadim Bendebury 1502be6c1529SReinhard Pfau CONFIG_CMD_TPM 1503be6c1529SReinhard Pfau Add tpm monitor functions. 1504be6c1529SReinhard Pfau Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also 1505be6c1529SReinhard Pfau provides monitor access to authorized functions. 1506be6c1529SReinhard Pfau 1507be6c1529SReinhard Pfau CONFIG_TPM 1508be6c1529SReinhard Pfau Define this to enable the TPM support library which provides 1509be6c1529SReinhard Pfau functional interfaces to some TPM commands. 1510be6c1529SReinhard Pfau Requires support for a TPM device. 1511be6c1529SReinhard Pfau 1512be6c1529SReinhard Pfau CONFIG_TPM_AUTH_SESSIONS 1513be6c1529SReinhard Pfau Define this to enable authorized functions in the TPM library. 1514be6c1529SReinhard Pfau Requires CONFIG_TPM and CONFIG_SHA1. 1515be6c1529SReinhard Pfau 1516c609719bSwdenk- USB Support: 1517c609719bSwdenk At the moment only the UHCI host controller is 15184d13cbadSwdenk supported (PIP405, MIP405, MPC5200); define 1519c609719bSwdenk CONFIG_USB_UHCI to enable it. 1520c609719bSwdenk define CONFIG_USB_KEYBOARD to enable the USB Keyboard 152130d56faeSwdenk and define CONFIG_USB_STORAGE to enable the USB 1522c609719bSwdenk storage devices. 1523c609719bSwdenk Note: 1524c609719bSwdenk Supported are USB Keyboards and USB Floppy drives 1525c609719bSwdenk (TEAC FD-05PUB). 15264d13cbadSwdenk MPC5200 USB requires additional defines: 15274d13cbadSwdenk CONFIG_USB_CLOCK 15284d13cbadSwdenk for 528 MHz Clock: 0x0001bbbb 1529307ecb6dSEric Millbrandt CONFIG_PSC3_USB 1530307ecb6dSEric Millbrandt for USB on PSC3 15314d13cbadSwdenk CONFIG_USB_CONFIG 15324d13cbadSwdenk for differential drivers: 0x00001000 15334d13cbadSwdenk for single ended drivers: 0x00005000 1534307ecb6dSEric Millbrandt for differential drivers on PSC3: 0x00000100 1535307ecb6dSEric Millbrandt for single ended drivers on PSC3: 0x00004100 15366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_USB_EVENT_POLL 1537fdcfaa1bSZhang Wei May be defined to allow interrupt polling 1538fdcfaa1bSZhang Wei instead of using asynchronous interrupts 15394d13cbadSwdenk 15409ab4ce22SSimon Glass CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the 15419ab4ce22SSimon Glass txfilltuning field in the EHCI controller on reset. 15429ab4ce22SSimon Glass 15436e9e0626SOleksandr Tymoshenko CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2 15446e9e0626SOleksandr Tymoshenko HW module registers. 15456e9e0626SOleksandr Tymoshenko 154616c8d5e7SWolfgang Denk- USB Device: 154716c8d5e7SWolfgang Denk Define the below if you wish to use the USB console. 154816c8d5e7SWolfgang Denk Once firmware is rebuilt from a serial console issue the 154916c8d5e7SWolfgang Denk command "setenv stdin usbtty; setenv stdout usbtty" and 155011ccc33fSMarcel Ziswiler attach your USB cable. The Unix command "dmesg" should print 155116c8d5e7SWolfgang Denk it has found a new device. The environment variable usbtty 155216c8d5e7SWolfgang Denk can be set to gserial or cdc_acm to enable your device to 155316c8d5e7SWolfgang Denk appear to a USB host as a Linux gserial device or a 155416c8d5e7SWolfgang Denk Common Device Class Abstract Control Model serial device. 155516c8d5e7SWolfgang Denk If you select usbtty = gserial you should be able to enumerate 155616c8d5e7SWolfgang Denk a Linux host by 155716c8d5e7SWolfgang Denk # modprobe usbserial vendor=0xVendorID product=0xProductID 155816c8d5e7SWolfgang Denk else if using cdc_acm, simply setting the environment 155916c8d5e7SWolfgang Denk variable usbtty to be cdc_acm should suffice. The following 156016c8d5e7SWolfgang Denk might be defined in YourBoardName.h 156116c8d5e7SWolfgang Denk 156216c8d5e7SWolfgang Denk CONFIG_USB_DEVICE 156316c8d5e7SWolfgang Denk Define this to build a UDC device 156416c8d5e7SWolfgang Denk 156516c8d5e7SWolfgang Denk CONFIG_USB_TTY 156616c8d5e7SWolfgang Denk Define this to have a tty type of device available to 156716c8d5e7SWolfgang Denk talk to the UDC device 156816c8d5e7SWolfgang Denk 1569f9da0f89SVipin KUMAR CONFIG_USBD_HS 1570f9da0f89SVipin KUMAR Define this to enable the high speed support for usb 1571f9da0f89SVipin KUMAR device and usbtty. If this feature is enabled, a routine 1572f9da0f89SVipin KUMAR int is_usbd_high_speed(void) 1573f9da0f89SVipin KUMAR also needs to be defined by the driver to dynamically poll 1574f9da0f89SVipin KUMAR whether the enumeration has succeded at high speed or full 1575f9da0f89SVipin KUMAR speed. 1576f9da0f89SVipin KUMAR 15776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_CONSOLE_IS_IN_ENV 157816c8d5e7SWolfgang Denk Define this if you want stdin, stdout &/or stderr to 157916c8d5e7SWolfgang Denk be set to usbtty. 158016c8d5e7SWolfgang Denk 158116c8d5e7SWolfgang Denk mpc8xx: 15826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_USB_EXTC_CLK 0xBLAH 158316c8d5e7SWolfgang Denk Derive USB clock from external clock "blah" 15846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_USB_EXTC_CLK 0x02 158516c8d5e7SWolfgang Denk 15866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_USB_BRG_CLK 0xBLAH 158716c8d5e7SWolfgang Denk Derive USB clock from brgclk 15886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_USB_BRG_CLK 0x04 158916c8d5e7SWolfgang Denk 159016c8d5e7SWolfgang Denk If you have a USB-IF assigned VendorID then you may wish to 159116c8d5e7SWolfgang Denk define your own vendor specific values either in BoardName.h 159216c8d5e7SWolfgang Denk or directly in usbd_vendor_info.h. If you don't define 159316c8d5e7SWolfgang Denk CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME, 159416c8d5e7SWolfgang Denk CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot 159516c8d5e7SWolfgang Denk should pretend to be a Linux device to it's target host. 159616c8d5e7SWolfgang Denk 159716c8d5e7SWolfgang Denk CONFIG_USBD_MANUFACTURER 159816c8d5e7SWolfgang Denk Define this string as the name of your company for 159916c8d5e7SWolfgang Denk - CONFIG_USBD_MANUFACTURER "my company" 160016c8d5e7SWolfgang Denk 160116c8d5e7SWolfgang Denk CONFIG_USBD_PRODUCT_NAME 160216c8d5e7SWolfgang Denk Define this string as the name of your product 160316c8d5e7SWolfgang Denk - CONFIG_USBD_PRODUCT_NAME "acme usb device" 160416c8d5e7SWolfgang Denk 160516c8d5e7SWolfgang Denk CONFIG_USBD_VENDORID 160616c8d5e7SWolfgang Denk Define this as your assigned Vendor ID from the USB 160716c8d5e7SWolfgang Denk Implementors Forum. This *must* be a genuine Vendor ID 160816c8d5e7SWolfgang Denk to avoid polluting the USB namespace. 160916c8d5e7SWolfgang Denk - CONFIG_USBD_VENDORID 0xFFFF 161016c8d5e7SWolfgang Denk 161116c8d5e7SWolfgang Denk CONFIG_USBD_PRODUCTID 161216c8d5e7SWolfgang Denk Define this as the unique Product ID 161316c8d5e7SWolfgang Denk for your device 161416c8d5e7SWolfgang Denk - CONFIG_USBD_PRODUCTID 0xFFFF 1615c609719bSwdenk 1616d70a560fSIgor Grinberg- ULPI Layer Support: 1617d70a560fSIgor Grinberg The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via 1618d70a560fSIgor Grinberg the generic ULPI layer. The generic layer accesses the ULPI PHY 1619d70a560fSIgor Grinberg via the platform viewport, so you need both the genric layer and 1620d70a560fSIgor Grinberg the viewport enabled. Currently only Chipidea/ARC based 1621d70a560fSIgor Grinberg viewport is supported. 1622d70a560fSIgor Grinberg To enable the ULPI layer support, define CONFIG_USB_ULPI and 1623d70a560fSIgor Grinberg CONFIG_USB_ULPI_VIEWPORT in your board configuration file. 16246d365ea0SLucas Stach If your ULPI phy needs a different reference clock than the 16256d365ea0SLucas Stach standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to 16266d365ea0SLucas Stach the appropriate value in Hz. 1627c609719bSwdenk 1628c609719bSwdenk- MMC Support: 1629c609719bSwdenk The MMC controller on the Intel PXA is supported. To 1630c609719bSwdenk enable this define CONFIG_MMC. The MMC can be 1631c609719bSwdenk accessed from the boot prompt by mapping the device 1632c609719bSwdenk to physical memory similar to flash. Command line is 1633602ad3b3SJon Loeliger enabled with CONFIG_CMD_MMC. The MMC driver also works with 1634602ad3b3SJon Loeliger the FAT fs. This is enabled with CONFIG_CMD_FAT. 1635c609719bSwdenk 1636afb35666SYoshihiro Shimoda CONFIG_SH_MMCIF 1637afb35666SYoshihiro Shimoda Support for Renesas on-chip MMCIF controller 1638afb35666SYoshihiro Shimoda 1639afb35666SYoshihiro Shimoda CONFIG_SH_MMCIF_ADDR 1640afb35666SYoshihiro Shimoda Define the base address of MMCIF registers 1641afb35666SYoshihiro Shimoda 1642afb35666SYoshihiro Shimoda CONFIG_SH_MMCIF_CLK 1643afb35666SYoshihiro Shimoda Define the clock frequency for MMCIF 1644afb35666SYoshihiro Shimoda 16451fd93c6eSPierre Aubert CONFIG_GENERIC_MMC 16461fd93c6eSPierre Aubert Enable the generic MMC driver 16471fd93c6eSPierre Aubert 16481fd93c6eSPierre Aubert CONFIG_SUPPORT_EMMC_BOOT 16491fd93c6eSPierre Aubert Enable some additional features of the eMMC boot partitions. 16501fd93c6eSPierre Aubert 16511fd93c6eSPierre Aubert CONFIG_SUPPORT_EMMC_RPMB 16521fd93c6eSPierre Aubert Enable the commands for reading, writing and programming the 16531fd93c6eSPierre Aubert key for the Replay Protection Memory Block partition in eMMC. 16541fd93c6eSPierre Aubert 1655b3ba6e94STom Rini- USB Device Firmware Update (DFU) class support: 165601acd6abSPaul Kocialkowski CONFIG_USB_FUNCTION_DFU 1657b3ba6e94STom Rini This enables the USB portion of the DFU USB class 1658b3ba6e94STom Rini 1659b3ba6e94STom Rini CONFIG_CMD_DFU 1660b3ba6e94STom Rini This enables the command "dfu" which is used to have 1661b3ba6e94STom Rini U-Boot create a DFU class device via USB. This command 1662b3ba6e94STom Rini requires that the "dfu_alt_info" environment variable be 1663b3ba6e94STom Rini set and define the alt settings to expose to the host. 1664b3ba6e94STom Rini 1665b3ba6e94STom Rini CONFIG_DFU_MMC 1666b3ba6e94STom Rini This enables support for exposing (e)MMC devices via DFU. 1667b3ba6e94STom Rini 1668c6631764SPantelis Antoniou CONFIG_DFU_NAND 1669c6631764SPantelis Antoniou This enables support for exposing NAND devices via DFU. 1670c6631764SPantelis Antoniou 1671a9479f04SAfzal Mohammed CONFIG_DFU_RAM 1672a9479f04SAfzal Mohammed This enables support for exposing RAM via DFU. 1673a9479f04SAfzal Mohammed Note: DFU spec refer to non-volatile memory usage, but 1674a9479f04SAfzal Mohammed allow usages beyond the scope of spec - here RAM usage, 1675a9479f04SAfzal Mohammed one that would help mostly the developer. 1676a9479f04SAfzal Mohammed 1677e7e75c70SHeiko Schocher CONFIG_SYS_DFU_DATA_BUF_SIZE 1678e7e75c70SHeiko Schocher Dfu transfer uses a buffer before writing data to the 1679e7e75c70SHeiko Schocher raw storage device. Make the size (in bytes) of this buffer 1680e7e75c70SHeiko Schocher configurable. The size of this buffer is also configurable 1681e7e75c70SHeiko Schocher through the "dfu_bufsiz" environment variable. 1682e7e75c70SHeiko Schocher 1683ea2453d5SPantelis Antoniou CONFIG_SYS_DFU_MAX_FILE_SIZE 1684ea2453d5SPantelis Antoniou When updating files rather than the raw storage device, 1685ea2453d5SPantelis Antoniou we use a static buffer to copy the file into and then write 1686ea2453d5SPantelis Antoniou the buffer once we've been given the whole file. Define 1687ea2453d5SPantelis Antoniou this to the maximum filesize (in bytes) for the buffer. 1688ea2453d5SPantelis Antoniou Default is 4 MiB if undefined. 1689ea2453d5SPantelis Antoniou 1690001a8319SHeiko Schocher DFU_DEFAULT_POLL_TIMEOUT 1691001a8319SHeiko Schocher Poll timeout [ms], is the timeout a device can send to the 1692001a8319SHeiko Schocher host. The host must wait for this timeout before sending 1693001a8319SHeiko Schocher a subsequent DFU_GET_STATUS request to the device. 1694001a8319SHeiko Schocher 1695001a8319SHeiko Schocher DFU_MANIFEST_POLL_TIMEOUT 1696001a8319SHeiko Schocher Poll timeout [ms], which the device sends to the host when 1697001a8319SHeiko Schocher entering dfuMANIFEST state. Host waits this timeout, before 1698001a8319SHeiko Schocher sending again an USB request to the device. 1699001a8319SHeiko Schocher 17003aab70afSSebastian Siewior- USB Device Android Fastboot support: 170117da3c0cSPaul Kocialkowski CONFIG_USB_FUNCTION_FASTBOOT 170217da3c0cSPaul Kocialkowski This enables the USB part of the fastboot gadget 170317da3c0cSPaul Kocialkowski 17043aab70afSSebastian Siewior CONFIG_CMD_FASTBOOT 17053aab70afSSebastian Siewior This enables the command "fastboot" which enables the Android 17063aab70afSSebastian Siewior fastboot mode for the platform's USB device. Fastboot is a USB 17073aab70afSSebastian Siewior protocol for downloading images, flashing and device control 17083aab70afSSebastian Siewior used on Android devices. 17093aab70afSSebastian Siewior See doc/README.android-fastboot for more information. 17103aab70afSSebastian Siewior 17113aab70afSSebastian Siewior CONFIG_ANDROID_BOOT_IMAGE 17123aab70afSSebastian Siewior This enables support for booting images which use the Android 17133aab70afSSebastian Siewior image format header. 17143aab70afSSebastian Siewior 1715a588d99aSPaul Kocialkowski CONFIG_FASTBOOT_BUF_ADDR 17163aab70afSSebastian Siewior The fastboot protocol requires a large memory buffer for 17173aab70afSSebastian Siewior downloads. Define this to the starting RAM address to use for 17183aab70afSSebastian Siewior downloaded images. 17193aab70afSSebastian Siewior 1720a588d99aSPaul Kocialkowski CONFIG_FASTBOOT_BUF_SIZE 17213aab70afSSebastian Siewior The fastboot protocol requires a large memory buffer for 17223aab70afSSebastian Siewior downloads. This buffer should be as large as possible for a 17233aab70afSSebastian Siewior platform. Define this to the size available RAM for fastboot. 17243aab70afSSebastian Siewior 1725d1b5ed07SSteve Rae CONFIG_FASTBOOT_FLASH 1726d1b5ed07SSteve Rae The fastboot protocol includes a "flash" command for writing 1727d1b5ed07SSteve Rae the downloaded image to a non-volatile storage device. Define 1728d1b5ed07SSteve Rae this to enable the "fastboot flash" command. 1729d1b5ed07SSteve Rae 1730d1b5ed07SSteve Rae CONFIG_FASTBOOT_FLASH_MMC_DEV 1731d1b5ed07SSteve Rae The fastboot "flash" command requires additional information 1732d1b5ed07SSteve Rae regarding the non-volatile storage device. Define this to 1733d1b5ed07SSteve Rae the eMMC device that fastboot should use to store the image. 1734d1b5ed07SSteve Rae 17350ff7e585SSteve Rae CONFIG_FASTBOOT_GPT_NAME 17360ff7e585SSteve Rae The fastboot "flash" command supports writing the downloaded 17370ff7e585SSteve Rae image to the Protective MBR and the Primary GUID Partition 17380ff7e585SSteve Rae Table. (Additionally, this downloaded image is post-processed 17390ff7e585SSteve Rae to generate and write the Backup GUID Partition Table.) 17400ff7e585SSteve Rae This occurs when the specified "partition name" on the 17410ff7e585SSteve Rae "fastboot flash" command line matches this value. 17420ff7e585SSteve Rae Default is GPT_ENTRY_NAME (currently "gpt") if undefined. 17430ff7e585SSteve Rae 17446705d81eSwdenk- Journaling Flash filesystem support: 17456705d81eSwdenk CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE, 17466705d81eSwdenk CONFIG_JFFS2_NAND_DEV 17476705d81eSwdenk Define these for a default partition on a NAND device 17486705d81eSwdenk 17496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS2_FIRST_SECTOR, 17506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS 17516705d81eSwdenk Define these for a default partition on a NOR device 17526705d81eSwdenk 17536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS_CUSTOM_PART 17546705d81eSwdenk Define this to create an own partition. You have to provide a 17556705d81eSwdenk function struct part_info* jffs2_part_info(int part_num) 17566705d81eSwdenk 17576705d81eSwdenk If you define only one JFFS2 partition you may also want to 17586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_JFFS_SINGLE_PART 1 17596705d81eSwdenk to disable the command chpart. This is the default when you 17606705d81eSwdenk have not defined a custom partition 17616705d81eSwdenk 1762c30a15e5SDonggeun Kim- FAT(File Allocation Table) filesystem write function support: 1763c30a15e5SDonggeun Kim CONFIG_FAT_WRITE 1764656f4c65SDonggeun Kim 1765656f4c65SDonggeun Kim Define this to enable support for saving memory data as a 1766656f4c65SDonggeun Kim file in FAT formatted partition. 1767656f4c65SDonggeun Kim 1768656f4c65SDonggeun Kim This will also enable the command "fatwrite" enabling the 1769656f4c65SDonggeun Kim user to write files to FAT. 1770c30a15e5SDonggeun Kim 177184cd9327SGabe BlackCBFS (Coreboot Filesystem) support 177284cd9327SGabe Black CONFIG_CMD_CBFS 177384cd9327SGabe Black 177484cd9327SGabe Black Define this to enable support for reading from a Coreboot 177584cd9327SGabe Black filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls 177684cd9327SGabe Black and cbfsload. 177784cd9327SGabe Black 17784f0d1a2aSSiva Durga Prasad Paladugu- FAT(File Allocation Table) filesystem cluster size: 17794f0d1a2aSSiva Durga Prasad Paladugu CONFIG_FS_FAT_MAX_CLUSTSIZE 17804f0d1a2aSSiva Durga Prasad Paladugu 17814f0d1a2aSSiva Durga Prasad Paladugu Define the max cluster size for fat operations else 17824f0d1a2aSSiva Durga Prasad Paladugu a default value of 65536 will be defined. 17834f0d1a2aSSiva Durga Prasad Paladugu 1784c609719bSwdenk- Keyboard Support: 1785c609719bSwdenk CONFIG_ISA_KEYBOARD 1786c609719bSwdenk 1787c609719bSwdenk Define this to enable standard (PC-Style) keyboard 1788c609719bSwdenk support 1789c609719bSwdenk 1790c609719bSwdenk CONFIG_I8042_KBD 1791c609719bSwdenk Standard PC keyboard driver with US (is default) and 1792c609719bSwdenk GERMAN key layout (switch via environment 'keymap=de') support. 1793c609719bSwdenk Export function i8042_kbd_init, i8042_tstc and i8042_getc 1794c609719bSwdenk for cfb_console. Supports cursor blinking. 1795c609719bSwdenk 1796713cb680SHung-ying Tyan CONFIG_CROS_EC_KEYB 1797713cb680SHung-ying Tyan Enables a Chrome OS keyboard using the CROS_EC interface. 1798713cb680SHung-ying Tyan This uses CROS_EC to communicate with a second microcontroller 1799713cb680SHung-ying Tyan which provides key scans on request. 1800713cb680SHung-ying Tyan 1801c609719bSwdenk- Video support: 1802c609719bSwdenk CONFIG_VIDEO 1803c609719bSwdenk 1804c609719bSwdenk Define this to enable video support (for output to 1805c609719bSwdenk video). 1806c609719bSwdenk 1807c609719bSwdenk CONFIG_VIDEO_CT69000 1808c609719bSwdenk 1809c609719bSwdenk Enable Chips & Technologies 69000 Video chip 1810c609719bSwdenk 1811c609719bSwdenk CONFIG_VIDEO_SMI_LYNXEM 1812eeb1b77bSwdenk Enable Silicon Motion SMI 712/710/810 Video chip. The 1813eeb1b77bSwdenk video output is selected via environment 'videoout' 1814eeb1b77bSwdenk (1 = LCD and 2 = CRT). If videoout is undefined, CRT is 1815eeb1b77bSwdenk assumed. 1816c609719bSwdenk 1817eeb1b77bSwdenk For the CT69000 and SMI_LYNXEM drivers, videomode is 181811ccc33fSMarcel Ziswiler selected via environment 'videomode'. Two different ways 1819eeb1b77bSwdenk are possible: 1820eeb1b77bSwdenk - "videomode=num" 'num' is a standard LiLo mode numbers. 1821eeb1b77bSwdenk Following standard modes are supported (* is default): 1822eeb1b77bSwdenk 1823eeb1b77bSwdenk Colors 640x480 800x600 1024x768 1152x864 1280x1024 1824eeb1b77bSwdenk -------------+--------------------------------------------- 1825eeb1b77bSwdenk 8 bits | 0x301* 0x303 0x305 0x161 0x307 1826eeb1b77bSwdenk 15 bits | 0x310 0x313 0x316 0x162 0x319 1827eeb1b77bSwdenk 16 bits | 0x311 0x314 0x317 0x163 0x31A 1828eeb1b77bSwdenk 24 bits | 0x312 0x315 0x318 ? 0x31B 1829eeb1b77bSwdenk -------------+--------------------------------------------- 1830c609719bSwdenk (i.e. setenv videomode 317; saveenv; reset;) 1831c609719bSwdenk 1832eeb1b77bSwdenk - "videomode=bootargs" all the video parameters are parsed 18337817cb20SMarcel Ziswiler from the bootargs. (See drivers/video/videomodes.c) 1834eeb1b77bSwdenk 1835eeb1b77bSwdenk 1836a6c7ad2fSwdenk CONFIG_VIDEO_SED13806 1837a6c7ad2fSwdenk Enable Epson SED13806 driver. This driver supports 8bpp 1838a6c7ad2fSwdenk and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP 1839a6c7ad2fSwdenk or CONFIG_VIDEO_SED13806_16BPP 1840a6c7ad2fSwdenk 18417d3053fbSTimur Tabi CONFIG_FSL_DIU_FB 18427d3053fbSTimur Tabi Enable the Freescale DIU video driver. Reference boards for 18437d3053fbSTimur Tabi SOCs that have a DIU should define this macro to enable DIU 18447d3053fbSTimur Tabi support, and should also define these other macros: 18457d3053fbSTimur Tabi 18467d3053fbSTimur Tabi CONFIG_SYS_DIU_ADDR 18477d3053fbSTimur Tabi CONFIG_VIDEO 18487d3053fbSTimur Tabi CONFIG_CMD_BMP 18497d3053fbSTimur Tabi CONFIG_CFB_CONSOLE 18507d3053fbSTimur Tabi CONFIG_VIDEO_SW_CURSOR 18517d3053fbSTimur Tabi CONFIG_VGA_AS_SINGLE_DEVICE 18527d3053fbSTimur Tabi CONFIG_VIDEO_LOGO 18537d3053fbSTimur Tabi CONFIG_VIDEO_BMP_LOGO 18547d3053fbSTimur Tabi 1855ba8e76bdSTimur Tabi The DIU driver will look for the 'video-mode' environment 1856ba8e76bdSTimur Tabi variable, and if defined, enable the DIU as a console during 1857ba8e76bdSTimur Tabi boot. See the documentation file README.video for a 1858ba8e76bdSTimur Tabi description of this variable. 18597d3053fbSTimur Tabi 1860058d59b0SSimon Glass 1861682011ffSwdenk- Keyboard Support: 1862682011ffSwdenk CONFIG_KEYBOARD 1863682011ffSwdenk 1864682011ffSwdenk Define this to enable a custom keyboard support. 1865682011ffSwdenk This simply calls drv_keyboard_init() which must be 1866682011ffSwdenk defined in your board-specific files. 1867682011ffSwdenk The only board using this so far is RBC823. 1868a6c7ad2fSwdenk 1869c609719bSwdenk- LCD Support: CONFIG_LCD 1870c609719bSwdenk 1871c609719bSwdenk Define this to enable LCD support (for output to LCD 1872c609719bSwdenk display); also select one of the supported displays 1873c609719bSwdenk by defining one of these: 1874c609719bSwdenk 187539cf4804SStelian Pop CONFIG_ATMEL_LCD: 187639cf4804SStelian Pop 187739cf4804SStelian Pop HITACHI TX09D70VM1CCA, 3.5", 240x320. 187839cf4804SStelian Pop 1879fd3103bbSwdenk CONFIG_NEC_NL6448AC33: 1880c609719bSwdenk 1881fd3103bbSwdenk NEC NL6448AC33-18. Active, color, single scan. 1882c609719bSwdenk 1883fd3103bbSwdenk CONFIG_NEC_NL6448BC20 1884c609719bSwdenk 1885fd3103bbSwdenk NEC NL6448BC20-08. 6.5", 640x480. 1886fd3103bbSwdenk Active, color, single scan. 1887fd3103bbSwdenk 1888fd3103bbSwdenk CONFIG_NEC_NL6448BC33_54 1889fd3103bbSwdenk 1890fd3103bbSwdenk NEC NL6448BC33-54. 10.4", 640x480. 1891c609719bSwdenk Active, color, single scan. 1892c609719bSwdenk 1893c609719bSwdenk CONFIG_SHARP_16x9 1894c609719bSwdenk 1895c609719bSwdenk Sharp 320x240. Active, color, single scan. 1896c609719bSwdenk It isn't 16x9, and I am not sure what it is. 1897c609719bSwdenk 1898c609719bSwdenk CONFIG_SHARP_LQ64D341 1899c609719bSwdenk 1900c609719bSwdenk Sharp LQ64D341 display, 640x480. 1901c609719bSwdenk Active, color, single scan. 1902c609719bSwdenk 1903c609719bSwdenk CONFIG_HLD1045 1904c609719bSwdenk 1905c609719bSwdenk HLD1045 display, 640x480. 1906c609719bSwdenk Active, color, single scan. 1907c609719bSwdenk 1908c609719bSwdenk CONFIG_OPTREX_BW 1909c609719bSwdenk 1910c609719bSwdenk Optrex CBL50840-2 NF-FW 99 22 M5 1911c609719bSwdenk or 1912c609719bSwdenk Hitachi LMG6912RPFC-00T 1913c609719bSwdenk or 1914c609719bSwdenk Hitachi SP14Q002 1915c609719bSwdenk 1916c609719bSwdenk 320x240. Black & white. 1917c609719bSwdenk 1918c609719bSwdenk Normally display is black on white background; define 19196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_WHITE_ON_BLACK to get it inverted. 1920c609719bSwdenk 1921676d319eSSimon Glass CONFIG_LCD_ALIGNMENT 1922676d319eSSimon Glass 1923b445bbb4SJeremiah Mahler Normally the LCD is page-aligned (typically 4KB). If this is 1924676d319eSSimon Glass defined then the LCD will be aligned to this value instead. 1925676d319eSSimon Glass For ARM it is sometimes useful to use MMU_SECTION_SIZE 1926676d319eSSimon Glass here, since it is cheaper to change data cache settings on 1927676d319eSSimon Glass a per-section basis. 1928676d319eSSimon Glass 19290d89efefSSimon Glass CONFIG_CONSOLE_SCROLL_LINES 19300d89efefSSimon Glass 19310d89efefSSimon Glass When the console need to be scrolled, this is the number of 19320d89efefSSimon Glass lines to scroll by. It defaults to 1. Increasing this makes 19330d89efefSSimon Glass the console jump but can help speed up operation when scrolling 19340d89efefSSimon Glass is slow. 1935676d319eSSimon Glass 1936604c7d4aSHannes Petermaier CONFIG_LCD_ROTATION 1937604c7d4aSHannes Petermaier 1938604c7d4aSHannes Petermaier Sometimes, for example if the display is mounted in portrait 1939604c7d4aSHannes Petermaier mode or even if it's mounted landscape but rotated by 180degree, 1940604c7d4aSHannes Petermaier we need to rotate our content of the display relative to the 1941604c7d4aSHannes Petermaier framebuffer, so that user can read the messages which are 1942604c7d4aSHannes Petermaier printed out. 1943604c7d4aSHannes Petermaier Once CONFIG_LCD_ROTATION is defined, the lcd_console will be 1944604c7d4aSHannes Petermaier initialized with a given rotation from "vl_rot" out of 1945604c7d4aSHannes Petermaier "vidinfo_t" which is provided by the board specific code. 1946604c7d4aSHannes Petermaier The value for vl_rot is coded as following (matching to 1947604c7d4aSHannes Petermaier fbcon=rotate:<n> linux-kernel commandline): 1948604c7d4aSHannes Petermaier 0 = no rotation respectively 0 degree 1949604c7d4aSHannes Petermaier 1 = 90 degree rotation 1950604c7d4aSHannes Petermaier 2 = 180 degree rotation 1951604c7d4aSHannes Petermaier 3 = 270 degree rotation 1952604c7d4aSHannes Petermaier 1953604c7d4aSHannes Petermaier If CONFIG_LCD_ROTATION is not defined, the console will be 1954604c7d4aSHannes Petermaier initialized with 0degree rotation. 1955604c7d4aSHannes Petermaier 195645d7f525STom Wai-Hong Tam CONFIG_LCD_BMP_RLE8 195745d7f525STom Wai-Hong Tam 195845d7f525STom Wai-Hong Tam Support drawing of RLE8-compressed bitmaps on the LCD. 195945d7f525STom Wai-Hong Tam 1960735987c5STom Wai-Hong Tam CONFIG_I2C_EDID 1961735987c5STom Wai-Hong Tam 1962735987c5STom Wai-Hong Tam Enables an 'i2c edid' command which can read EDID 1963735987c5STom Wai-Hong Tam information over I2C from an attached LCD display. 1964735987c5STom Wai-Hong Tam 19657152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN 1966d791b1dcSwdenk 1967d791b1dcSwdenk If this option is set, the environment is checked for 1968d791b1dcSwdenk a variable "splashimage". If found, the usual display 1969d791b1dcSwdenk of logo, copyright and system information on the LCD 1970e94d2cd9Swdenk is suppressed and the BMP image at the address 1971d791b1dcSwdenk specified in "splashimage" is loaded instead. The 1972d791b1dcSwdenk console is redirected to the "nulldev", too. This 1973d791b1dcSwdenk allows for a "silent" boot where a splash screen is 1974d791b1dcSwdenk loaded very quickly after power-on. 1975d791b1dcSwdenk 1976c0880485SNikita Kiryanov CONFIG_SPLASHIMAGE_GUARD 1977c0880485SNikita Kiryanov 1978c0880485SNikita Kiryanov If this option is set, then U-Boot will prevent the environment 1979c0880485SNikita Kiryanov variable "splashimage" from being set to a problematic address 19801551df35STom Rini (see README.displaying-bmps). 1981c0880485SNikita Kiryanov This option is useful for targets where, due to alignment 1982c0880485SNikita Kiryanov restrictions, an improperly aligned BMP image will cause a data 1983c0880485SNikita Kiryanov abort. If you think you will not have problems with unaligned 1984c0880485SNikita Kiryanov accesses (for example because your toolchain prevents them) 1985c0880485SNikita Kiryanov there is no need to set this option. 1986c0880485SNikita Kiryanov 19871ca298ceSMatthias Weisser CONFIG_SPLASH_SCREEN_ALIGN 19881ca298ceSMatthias Weisser 19891ca298ceSMatthias Weisser If this option is set the splash image can be freely positioned 19901ca298ceSMatthias Weisser on the screen. Environment variable "splashpos" specifies the 19911ca298ceSMatthias Weisser position as "x,y". If a positive number is given it is used as 19921ca298ceSMatthias Weisser number of pixel from left/top. If a negative number is given it 19931ca298ceSMatthias Weisser is used as number of pixel from right/bottom. You can also 19941ca298ceSMatthias Weisser specify 'm' for centering the image. 19951ca298ceSMatthias Weisser 19961ca298ceSMatthias Weisser Example: 19971ca298ceSMatthias Weisser setenv splashpos m,m 19981ca298ceSMatthias Weisser => image at center of screen 19991ca298ceSMatthias Weisser 20001ca298ceSMatthias Weisser setenv splashpos 30,20 20011ca298ceSMatthias Weisser => image at x = 30 and y = 20 20021ca298ceSMatthias Weisser 20031ca298ceSMatthias Weisser setenv splashpos -10,m 20041ca298ceSMatthias Weisser => vertically centered image 20051ca298ceSMatthias Weisser at x = dspWidth - bmpWidth - 9 20061ca298ceSMatthias Weisser 200798f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP 200898f4a3dfSStefan Roese 200998f4a3dfSStefan Roese If this option is set, additionally to standard BMP 201098f4a3dfSStefan Roese images, gzipped BMP images can be displayed via the 201198f4a3dfSStefan Roese splashscreen support or the bmp command. 201298f4a3dfSStefan Roese 2013d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8 2014d5011762SAnatolij Gustschin 2015d5011762SAnatolij Gustschin If this option is set, 8-bit RLE compressed BMP images 2016d5011762SAnatolij Gustschin can be displayed via the splashscreen support or the 2017d5011762SAnatolij Gustschin bmp command. 2018d5011762SAnatolij Gustschin 2019b445bbb4SJeremiah Mahler- Do compressing for memory range: 2020f2b96dfbSLei Wen CONFIG_CMD_ZIP 2021f2b96dfbSLei Wen 2022f2b96dfbSLei Wen If this option is set, it would use zlib deflate method 2023f2b96dfbSLei Wen to compress the specified memory at its best effort. 2024f2b96dfbSLei Wen 2025c29fdfc1Swdenk- Compression support: 20268ef70478SKees Cook CONFIG_GZIP 20278ef70478SKees Cook 20288ef70478SKees Cook Enabled by default to support gzip compressed images. 20298ef70478SKees Cook 2030c29fdfc1Swdenk CONFIG_BZIP2 2031c29fdfc1Swdenk 2032c29fdfc1Swdenk If this option is set, support for bzip2 compressed 2033c29fdfc1Swdenk images is included. If not, only uncompressed and gzip 2034c29fdfc1Swdenk compressed images are supported. 2035c29fdfc1Swdenk 2036c29fdfc1Swdenk NOTE: the bzip2 algorithm requires a lot of RAM, so 20376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should 2038c29fdfc1Swdenk be at least 4MB. 2039d791b1dcSwdenk 2040fc9c1727SLuigi 'Comio' Mantellini CONFIG_LZMA 2041fc9c1727SLuigi 'Comio' Mantellini 2042fc9c1727SLuigi 'Comio' Mantellini If this option is set, support for lzma compressed 2043fc9c1727SLuigi 'Comio' Mantellini images is included. 2044fc9c1727SLuigi 'Comio' Mantellini 2045fc9c1727SLuigi 'Comio' Mantellini Note: The LZMA algorithm adds between 2 and 4KB of code and it 2046fc9c1727SLuigi 'Comio' Mantellini requires an amount of dynamic memory that is given by the 2047fc9c1727SLuigi 'Comio' Mantellini formula: 2048fc9c1727SLuigi 'Comio' Mantellini 2049fc9c1727SLuigi 'Comio' Mantellini (1846 + 768 << (lc + lp)) * sizeof(uint16) 2050fc9c1727SLuigi 'Comio' Mantellini 2051fc9c1727SLuigi 'Comio' Mantellini Where lc and lp stand for, respectively, Literal context bits 2052fc9c1727SLuigi 'Comio' Mantellini and Literal pos bits. 2053fc9c1727SLuigi 'Comio' Mantellini 2054fc9c1727SLuigi 'Comio' Mantellini This value is upper-bounded by 14MB in the worst case. Anyway, 2055fc9c1727SLuigi 'Comio' Mantellini for a ~4MB large kernel image, we have lc=3 and lp=0 for a 2056fc9c1727SLuigi 'Comio' Mantellini total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is 2057fc9c1727SLuigi 'Comio' Mantellini a very small buffer. 2058fc9c1727SLuigi 'Comio' Mantellini 2059fc9c1727SLuigi 'Comio' Mantellini Use the lzmainfo tool to determinate the lc and lp values and 2060fc9c1727SLuigi 'Comio' Mantellini then calculate the amount of needed dynamic memory (ensuring 20616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD the appropriate CONFIG_SYS_MALLOC_LEN value). 2062fc9c1727SLuigi 'Comio' Mantellini 20638ef70478SKees Cook CONFIG_LZO 20648ef70478SKees Cook 20658ef70478SKees Cook If this option is set, support for LZO compressed images 20668ef70478SKees Cook is included. 20678ef70478SKees Cook 206817ea1177Swdenk- MII/PHY support: 206917ea1177Swdenk CONFIG_PHY_ADDR 207017ea1177Swdenk 207117ea1177Swdenk The address of PHY on MII bus. 207217ea1177Swdenk 207317ea1177Swdenk CONFIG_PHY_CLOCK_FREQ (ppc4xx) 207417ea1177Swdenk 207517ea1177Swdenk The clock frequency of the MII bus 207617ea1177Swdenk 207717ea1177Swdenk CONFIG_PHY_GIGE 207817ea1177Swdenk 207917ea1177Swdenk If this option is set, support for speed/duplex 208011ccc33fSMarcel Ziswiler detection of gigabit PHY is included. 208117ea1177Swdenk 208217ea1177Swdenk CONFIG_PHY_RESET_DELAY 208317ea1177Swdenk 208417ea1177Swdenk Some PHY like Intel LXT971A need extra delay after 208517ea1177Swdenk reset before any MII register access is possible. 208617ea1177Swdenk For such PHY, set this option to the usec delay 208717ea1177Swdenk required. (minimum 300usec for LXT971A) 208817ea1177Swdenk 208917ea1177Swdenk CONFIG_PHY_CMD_DELAY (ppc4xx) 209017ea1177Swdenk 209117ea1177Swdenk Some PHY like Intel LXT971A need extra delay after 209217ea1177Swdenk command issued before MII status register can be read 209317ea1177Swdenk 2094c609719bSwdenk- IP address: 2095c609719bSwdenk CONFIG_IPADDR 2096c609719bSwdenk 2097c609719bSwdenk Define a default value for the IP address to use for 209811ccc33fSMarcel Ziswiler the default Ethernet interface, in case this is not 2099c609719bSwdenk determined through e.g. bootp. 21001ebcd654SWolfgang Denk (Environment variable "ipaddr") 2101c609719bSwdenk 2102c609719bSwdenk- Server IP address: 2103c609719bSwdenk CONFIG_SERVERIP 2104c609719bSwdenk 2105c609719bSwdenk Defines a default value for the IP address of a TFTP 2106c609719bSwdenk server to contact when using the "tftboot" command. 21071ebcd654SWolfgang Denk (Environment variable "serverip") 2108c609719bSwdenk 210997cfe861SRobin Getz CONFIG_KEEP_SERVERADDR 211097cfe861SRobin Getz 211197cfe861SRobin Getz Keeps the server's MAC address, in the env 'serveraddr' 211297cfe861SRobin Getz for passing to bootargs (like Linux's netconsole option) 211397cfe861SRobin Getz 21141ebcd654SWolfgang Denk- Gateway IP address: 21151ebcd654SWolfgang Denk CONFIG_GATEWAYIP 21161ebcd654SWolfgang Denk 21171ebcd654SWolfgang Denk Defines a default value for the IP address of the 21181ebcd654SWolfgang Denk default router where packets to other networks are 21191ebcd654SWolfgang Denk sent to. 21201ebcd654SWolfgang Denk (Environment variable "gatewayip") 21211ebcd654SWolfgang Denk 21221ebcd654SWolfgang Denk- Subnet mask: 21231ebcd654SWolfgang Denk CONFIG_NETMASK 21241ebcd654SWolfgang Denk 21251ebcd654SWolfgang Denk Defines a default value for the subnet mask (or 21261ebcd654SWolfgang Denk routing prefix) which is used to determine if an IP 21271ebcd654SWolfgang Denk address belongs to the local subnet or needs to be 21281ebcd654SWolfgang Denk forwarded through a router. 21291ebcd654SWolfgang Denk (Environment variable "netmask") 21301ebcd654SWolfgang Denk 213153a5c424SDavid Updegraff- Multicast TFTP Mode: 213253a5c424SDavid Updegraff CONFIG_MCAST_TFTP 213353a5c424SDavid Updegraff 213453a5c424SDavid Updegraff Defines whether you want to support multicast TFTP as per 213553a5c424SDavid Updegraff rfc-2090; for example to work with atftp. Lets lots of targets 213611ccc33fSMarcel Ziswiler tftp down the same boot image concurrently. Note: the Ethernet 213753a5c424SDavid Updegraff driver in use must provide a function: mcast() to join/leave a 213853a5c424SDavid Updegraff multicast group. 213953a5c424SDavid Updegraff 2140c609719bSwdenk- BOOTP Recovery Mode: 2141c609719bSwdenk CONFIG_BOOTP_RANDOM_DELAY 2142c609719bSwdenk 2143c609719bSwdenk If you have many targets in a network that try to 2144c609719bSwdenk boot using BOOTP, you may want to avoid that all 2145c609719bSwdenk systems send out BOOTP requests at precisely the same 2146c609719bSwdenk moment (which would happen for instance at recovery 2147c609719bSwdenk from a power failure, when all systems will try to 2148c609719bSwdenk boot, thus flooding the BOOTP server. Defining 2149c609719bSwdenk CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be 2150c609719bSwdenk inserted before sending out BOOTP requests. The 21516c33c785SWolfgang Denk following delays are inserted then: 2152c609719bSwdenk 2153c609719bSwdenk 1st BOOTP request: delay 0 ... 1 sec 2154c609719bSwdenk 2nd BOOTP request: delay 0 ... 2 sec 2155c609719bSwdenk 3rd BOOTP request: delay 0 ... 4 sec 2156c609719bSwdenk 4th and following 2157c609719bSwdenk BOOTP requests: delay 0 ... 8 sec 2158c609719bSwdenk 215992ac8accSThierry Reding CONFIG_BOOTP_ID_CACHE_SIZE 216092ac8accSThierry Reding 216192ac8accSThierry Reding BOOTP packets are uniquely identified using a 32-bit ID. The 216292ac8accSThierry Reding server will copy the ID from client requests to responses and 216392ac8accSThierry Reding U-Boot will use this to determine if it is the destination of 216492ac8accSThierry Reding an incoming response. Some servers will check that addresses 216592ac8accSThierry Reding aren't in use before handing them out (usually using an ARP 216692ac8accSThierry Reding ping) and therefore take up to a few hundred milliseconds to 216792ac8accSThierry Reding respond. Network congestion may also influence the time it 216892ac8accSThierry Reding takes for a response to make it back to the client. If that 216992ac8accSThierry Reding time is too long, U-Boot will retransmit requests. In order 217092ac8accSThierry Reding to allow earlier responses to still be accepted after these 217192ac8accSThierry Reding retransmissions, U-Boot's BOOTP client keeps a small cache of 217292ac8accSThierry Reding IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this 217392ac8accSThierry Reding cache. The default is to keep IDs for up to four outstanding 217492ac8accSThierry Reding requests. Increasing this will allow U-Boot to accept offers 217592ac8accSThierry Reding from a BOOTP client in networks with unusually high latency. 217692ac8accSThierry Reding 2177fe389a82Sstroese- DHCP Advanced Options: 21781fe80d79SJon Loeliger You can fine tune the DHCP functionality by defining 21791fe80d79SJon Loeliger CONFIG_BOOTP_* symbols: 2180fe389a82Sstroese 21811fe80d79SJon Loeliger CONFIG_BOOTP_SUBNETMASK 21821fe80d79SJon Loeliger CONFIG_BOOTP_GATEWAY 21831fe80d79SJon Loeliger CONFIG_BOOTP_HOSTNAME 21841fe80d79SJon Loeliger CONFIG_BOOTP_NISDOMAIN 21851fe80d79SJon Loeliger CONFIG_BOOTP_BOOTPATH 21861fe80d79SJon Loeliger CONFIG_BOOTP_BOOTFILESIZE 21871fe80d79SJon Loeliger CONFIG_BOOTP_DNS 21881fe80d79SJon Loeliger CONFIG_BOOTP_DNS2 21891fe80d79SJon Loeliger CONFIG_BOOTP_SEND_HOSTNAME 21901fe80d79SJon Loeliger CONFIG_BOOTP_NTPSERVER 21911fe80d79SJon Loeliger CONFIG_BOOTP_TIMEOFFSET 21921fe80d79SJon Loeliger CONFIG_BOOTP_VENDOREX 21932c00e099SJoe Hershberger CONFIG_BOOTP_MAY_FAIL 2194fe389a82Sstroese 21955d110f0aSWilson Callan CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip 21965d110f0aSWilson Callan environment variable, not the BOOTP server. 2197fe389a82Sstroese 21982c00e099SJoe Hershberger CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found 21992c00e099SJoe Hershberger after the configured retry count, the call will fail 22002c00e099SJoe Hershberger instead of starting over. This can be used to fail over 22012c00e099SJoe Hershberger to Link-local IP address configuration if the DHCP server 22022c00e099SJoe Hershberger is not available. 22032c00e099SJoe Hershberger 2204fe389a82Sstroese CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS 2205fe389a82Sstroese serverip from a DHCP server, it is possible that more 2206fe389a82Sstroese than one DNS serverip is offered to the client. 2207fe389a82Sstroese If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS 2208fe389a82Sstroese serverip will be stored in the additional environment 2209fe389a82Sstroese variable "dnsip2". The first DNS serverip is always 2210fe389a82Sstroese stored in the variable "dnsip", when CONFIG_BOOTP_DNS 22111fe80d79SJon Loeliger is defined. 2212fe389a82Sstroese 2213fe389a82Sstroese CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable 2214fe389a82Sstroese to do a dynamic update of a DNS server. To do this, they 2215fe389a82Sstroese need the hostname of the DHCP requester. 22165d110f0aSWilson Callan If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content 22171fe80d79SJon Loeliger of the "hostname" environment variable is passed as 22181fe80d79SJon Loeliger option 12 to the DHCP server. 2219fe389a82Sstroese 2220d9a2f416SAras Vaichas CONFIG_BOOTP_DHCP_REQUEST_DELAY 2221d9a2f416SAras Vaichas 2222d9a2f416SAras Vaichas A 32bit value in microseconds for a delay between 2223d9a2f416SAras Vaichas receiving a "DHCP Offer" and sending the "DHCP Request". 2224d9a2f416SAras Vaichas This fixes a problem with certain DHCP servers that don't 2225d9a2f416SAras Vaichas respond 100% of the time to a "DHCP request". E.g. On an 2226d9a2f416SAras Vaichas AT91RM9200 processor running at 180MHz, this delay needed 2227d9a2f416SAras Vaichas to be *at least* 15,000 usec before a Windows Server 2003 2228d9a2f416SAras Vaichas DHCP server would reply 100% of the time. I recommend at 2229d9a2f416SAras Vaichas least 50,000 usec to be safe. The alternative is to hope 2230d9a2f416SAras Vaichas that one of the retries will be successful but note that 2231d9a2f416SAras Vaichas the DHCP timeout and retry process takes a longer than 2232d9a2f416SAras Vaichas this delay. 2233d9a2f416SAras Vaichas 2234d22c338eSJoe Hershberger - Link-local IP address negotiation: 2235d22c338eSJoe Hershberger Negotiate with other link-local clients on the local network 2236d22c338eSJoe Hershberger for an address that doesn't require explicit configuration. 2237d22c338eSJoe Hershberger This is especially useful if a DHCP server cannot be guaranteed 2238d22c338eSJoe Hershberger to exist in all environments that the device must operate. 2239d22c338eSJoe Hershberger 2240d22c338eSJoe Hershberger See doc/README.link-local for more information. 2241d22c338eSJoe Hershberger 2242a3d991bdSwdenk - CDP Options: 2243a3d991bdSwdenk CONFIG_CDP_DEVICE_ID 2244a3d991bdSwdenk 2245a3d991bdSwdenk The device id used in CDP trigger frames. 2246a3d991bdSwdenk 2247a3d991bdSwdenk CONFIG_CDP_DEVICE_ID_PREFIX 2248a3d991bdSwdenk 2249a3d991bdSwdenk A two character string which is prefixed to the MAC address 2250a3d991bdSwdenk of the device. 2251a3d991bdSwdenk 2252a3d991bdSwdenk CONFIG_CDP_PORT_ID 2253a3d991bdSwdenk 2254a3d991bdSwdenk A printf format string which contains the ascii name of 2255a3d991bdSwdenk the port. Normally is set to "eth%d" which sets 225611ccc33fSMarcel Ziswiler eth0 for the first Ethernet, eth1 for the second etc. 2257a3d991bdSwdenk 2258a3d991bdSwdenk CONFIG_CDP_CAPABILITIES 2259a3d991bdSwdenk 2260a3d991bdSwdenk A 32bit integer which indicates the device capabilities; 2261a3d991bdSwdenk 0x00000010 for a normal host which does not forwards. 2262a3d991bdSwdenk 2263a3d991bdSwdenk CONFIG_CDP_VERSION 2264a3d991bdSwdenk 2265a3d991bdSwdenk An ascii string containing the version of the software. 2266a3d991bdSwdenk 2267a3d991bdSwdenk CONFIG_CDP_PLATFORM 2268a3d991bdSwdenk 2269a3d991bdSwdenk An ascii string containing the name of the platform. 2270a3d991bdSwdenk 2271a3d991bdSwdenk CONFIG_CDP_TRIGGER 2272a3d991bdSwdenk 2273a3d991bdSwdenk A 32bit integer sent on the trigger. 2274a3d991bdSwdenk 2275a3d991bdSwdenk CONFIG_CDP_POWER_CONSUMPTION 2276a3d991bdSwdenk 2277a3d991bdSwdenk A 16bit integer containing the power consumption of the 2278a3d991bdSwdenk device in .1 of milliwatts. 2279a3d991bdSwdenk 2280a3d991bdSwdenk CONFIG_CDP_APPLIANCE_VLAN_TYPE 2281a3d991bdSwdenk 2282a3d991bdSwdenk A byte containing the id of the VLAN. 2283a3d991bdSwdenk 2284c609719bSwdenk- Status LED: CONFIG_STATUS_LED 2285c609719bSwdenk 2286c609719bSwdenk Several configurations allow to display the current 2287c609719bSwdenk status using a LED. For instance, the LED will blink 2288c609719bSwdenk fast while running U-Boot code, stop blinking as 2289c609719bSwdenk soon as a reply to a BOOTP request was received, and 2290c609719bSwdenk start blinking slow once the Linux kernel is running 2291c609719bSwdenk (supported by a status LED driver in the Linux 2292c609719bSwdenk kernel). Defining CONFIG_STATUS_LED enables this 2293c609719bSwdenk feature in U-Boot. 2294c609719bSwdenk 22951df7bbbaSIgor Grinberg Additional options: 22961df7bbbaSIgor Grinberg 22971df7bbbaSIgor Grinberg CONFIG_GPIO_LED 22981df7bbbaSIgor Grinberg The status LED can be connected to a GPIO pin. 22991df7bbbaSIgor Grinberg In such cases, the gpio_led driver can be used as a 23001df7bbbaSIgor Grinberg status LED backend implementation. Define CONFIG_GPIO_LED 23011df7bbbaSIgor Grinberg to include the gpio_led driver in the U-Boot binary. 23021df7bbbaSIgor Grinberg 23039dfdcdfeSIgor Grinberg CONFIG_GPIO_LED_INVERTED_TABLE 23049dfdcdfeSIgor Grinberg Some GPIO connected LEDs may have inverted polarity in which 23059dfdcdfeSIgor Grinberg case the GPIO high value corresponds to LED off state and 23069dfdcdfeSIgor Grinberg GPIO low value corresponds to LED on state. 23079dfdcdfeSIgor Grinberg In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined 23089dfdcdfeSIgor Grinberg with a list of GPIO LEDs that have inverted polarity. 23099dfdcdfeSIgor Grinberg 2310c609719bSwdenk- CAN Support: CONFIG_CAN_DRIVER 2311c609719bSwdenk 2312c609719bSwdenk Defining CONFIG_CAN_DRIVER enables CAN driver support 2313c609719bSwdenk on those systems that support this (optional) 2314c609719bSwdenk feature, like the TQM8xxL modules. 2315c609719bSwdenk 23163f4978c7SHeiko Schocher- I2C Support: CONFIG_SYS_I2C 2317c609719bSwdenk 23183f4978c7SHeiko Schocher This enable the NEW i2c subsystem, and will allow you to use 23193f4978c7SHeiko Schocher i2c commands at the u-boot command line (as long as you set 23203f4978c7SHeiko Schocher CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c 23213f4978c7SHeiko Schocher based realtime clock chips or other i2c devices. See 23223f4978c7SHeiko Schocher common/cmd_i2c.c for a description of the command line 23233f4978c7SHeiko Schocher interface. 23243f4978c7SHeiko Schocher 23253f4978c7SHeiko Schocher ported i2c driver to the new framework: 2326ea818dbbSHeiko Schocher - drivers/i2c/soft_i2c.c: 2327ea818dbbSHeiko Schocher - activate first bus with CONFIG_SYS_I2C_SOFT define 2328ea818dbbSHeiko Schocher CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE 2329ea818dbbSHeiko Schocher for defining speed and slave address 2330ea818dbbSHeiko Schocher - activate second bus with I2C_SOFT_DECLARATIONS2 define 2331ea818dbbSHeiko Schocher CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2 2332ea818dbbSHeiko Schocher for defining speed and slave address 2333ea818dbbSHeiko Schocher - activate third bus with I2C_SOFT_DECLARATIONS3 define 2334ea818dbbSHeiko Schocher CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3 2335ea818dbbSHeiko Schocher for defining speed and slave address 2336ea818dbbSHeiko Schocher - activate fourth bus with I2C_SOFT_DECLARATIONS4 define 2337ea818dbbSHeiko Schocher CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4 2338ea818dbbSHeiko Schocher for defining speed and slave address 23393f4978c7SHeiko Schocher 234000f792e0SHeiko Schocher - drivers/i2c/fsl_i2c.c: 234100f792e0SHeiko Schocher - activate i2c driver with CONFIG_SYS_I2C_FSL 234200f792e0SHeiko Schocher define CONFIG_SYS_FSL_I2C_OFFSET for setting the register 234300f792e0SHeiko Schocher offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and 234400f792e0SHeiko Schocher CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first 234500f792e0SHeiko Schocher bus. 234600f792e0SHeiko Schocher - If your board supports a second fsl i2c bus, define 234700f792e0SHeiko Schocher CONFIG_SYS_FSL_I2C2_OFFSET for the register offset 234800f792e0SHeiko Schocher CONFIG_SYS_FSL_I2C2_SPEED for the speed and 234900f792e0SHeiko Schocher CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the 235000f792e0SHeiko Schocher second bus. 235100f792e0SHeiko Schocher 23521f2ba722SSimon Glass - drivers/i2c/tegra_i2c.c: 23531f2ba722SSimon Glass - activate this driver with CONFIG_SYS_I2C_TEGRA 23541f2ba722SSimon Glass - This driver adds 4 i2c buses with a fix speed from 23551f2ba722SSimon Glass 100000 and the slave addr 0! 23561f2ba722SSimon Glass 2357880540deSDirk Eibach - drivers/i2c/ppc4xx_i2c.c 2358880540deSDirk Eibach - activate this driver with CONFIG_SYS_I2C_PPC4XX 2359880540deSDirk Eibach - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0 2360880540deSDirk Eibach - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1 2361880540deSDirk Eibach 2362fac96408Strem - drivers/i2c/i2c_mxc.c 2363fac96408Strem - activate this driver with CONFIG_SYS_I2C_MXC 236403544c66SAlbert ARIBAUD \\(3ADEV\\) - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1 236503544c66SAlbert ARIBAUD \\(3ADEV\\) - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2 236603544c66SAlbert ARIBAUD \\(3ADEV\\) - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3 236703544c66SAlbert ARIBAUD \\(3ADEV\\) - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4 2368fac96408Strem - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED 2369fac96408Strem - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE 2370fac96408Strem - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED 2371fac96408Strem - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE 2372fac96408Strem - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED 2373fac96408Strem - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE 237403544c66SAlbert ARIBAUD \\(3ADEV\\) - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED 237503544c66SAlbert ARIBAUD \\(3ADEV\\) - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE 2376b445bbb4SJeremiah Mahler If those defines are not set, default value is 100000 2377fac96408Strem for speed, and 0 for slave. 2378fac96408Strem 23791086bfa9SNobuhiro Iwamatsu - drivers/i2c/rcar_i2c.c: 23801086bfa9SNobuhiro Iwamatsu - activate this driver with CONFIG_SYS_I2C_RCAR 23811086bfa9SNobuhiro Iwamatsu - This driver adds 4 i2c buses 23821086bfa9SNobuhiro Iwamatsu 23831086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0 23841086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0 23851086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1 23861086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1 23871086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2 23881086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2 23891086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3 23901086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3 23911086bfa9SNobuhiro Iwamatsu - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses 23921086bfa9SNobuhiro Iwamatsu 23932035d77dSNobuhiro Iwamatsu - drivers/i2c/sh_i2c.c: 23942035d77dSNobuhiro Iwamatsu - activate this driver with CONFIG_SYS_I2C_SH 23952035d77dSNobuhiro Iwamatsu - This driver adds from 2 to 5 i2c buses 23962035d77dSNobuhiro Iwamatsu 23972035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0 23982035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0 23992035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1 24002035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1 24012035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2 24022035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2 24032035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3 24042035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3 24052035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4 24062035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4 24072035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5 24082035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5 2409b445bbb4SJeremiah Mahler - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses 24102035d77dSNobuhiro Iwamatsu 24116789e84eSHeiko Schocher - drivers/i2c/omap24xx_i2c.c 24126789e84eSHeiko Schocher - activate this driver with CONFIG_SYS_I2C_OMAP24XX 24136789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0 24146789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0 24156789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1 24166789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1 24176789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2 24186789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2 24196789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3 24206789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3 24216789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4 24226789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4 24236789e84eSHeiko Schocher 24240bdffe71SHeiko Schocher - drivers/i2c/zynq_i2c.c 24250bdffe71SHeiko Schocher - activate this driver with CONFIG_SYS_I2C_ZYNQ 24260bdffe71SHeiko Schocher - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting 24270bdffe71SHeiko Schocher - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr 24280bdffe71SHeiko Schocher 2429e717fc6dSNaveen Krishna Ch - drivers/i2c/s3c24x0_i2c.c: 2430e717fc6dSNaveen Krishna Ch - activate this driver with CONFIG_SYS_I2C_S3C24X0 2431e717fc6dSNaveen Krishna Ch - This driver adds i2c buses (11 for Exynos5250, Exynos5420 2432e717fc6dSNaveen Krishna Ch 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung) 2433e717fc6dSNaveen Krishna Ch with a fix speed from 100000 and the slave addr 0! 2434e717fc6dSNaveen Krishna Ch 2435b46226bdSDirk Eibach - drivers/i2c/ihs_i2c.c 2436b46226bdSDirk Eibach - activate this driver with CONFIG_SYS_I2C_IHS 2437b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0 2438b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0 2439b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0 2440b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1 2441b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1 2442b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1 2443b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2 2444b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2 2445b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2 2446b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3 2447b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3 2448b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3 2449b46226bdSDirk Eibach 24503f4978c7SHeiko Schocher additional defines: 24513f4978c7SHeiko Schocher 24523f4978c7SHeiko Schocher CONFIG_SYS_NUM_I2C_BUSES 2453b445bbb4SJeremiah Mahler Hold the number of i2c buses you want to use. If you 24543f4978c7SHeiko Schocher don't use/have i2c muxes on your i2c bus, this 24553f4978c7SHeiko Schocher is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can 24563f4978c7SHeiko Schocher omit this define. 24573f4978c7SHeiko Schocher 24583f4978c7SHeiko Schocher CONFIG_SYS_I2C_DIRECT_BUS 24593f4978c7SHeiko Schocher define this, if you don't use i2c muxes on your hardware. 24603f4978c7SHeiko Schocher if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can 24613f4978c7SHeiko Schocher omit this define. 24623f4978c7SHeiko Schocher 24633f4978c7SHeiko Schocher CONFIG_SYS_I2C_MAX_HOPS 24643f4978c7SHeiko Schocher define how many muxes are maximal consecutively connected 24653f4978c7SHeiko Schocher on one i2c bus. If you not use i2c muxes, omit this 24663f4978c7SHeiko Schocher define. 24673f4978c7SHeiko Schocher 24683f4978c7SHeiko Schocher CONFIG_SYS_I2C_BUSES 2469b445bbb4SJeremiah Mahler hold a list of buses you want to use, only used if 24703f4978c7SHeiko Schocher CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example 24713f4978c7SHeiko Schocher a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and 24723f4978c7SHeiko Schocher CONFIG_SYS_NUM_I2C_BUSES = 9: 24733f4978c7SHeiko Schocher 24743f4978c7SHeiko Schocher CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \ 24753f4978c7SHeiko Schocher {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \ 24763f4978c7SHeiko Schocher {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \ 24773f4978c7SHeiko Schocher {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \ 24783f4978c7SHeiko Schocher {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \ 24793f4978c7SHeiko Schocher {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \ 24803f4978c7SHeiko Schocher {1, {I2C_NULL_HOP}}, \ 24813f4978c7SHeiko Schocher {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \ 24823f4978c7SHeiko Schocher {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \ 24833f4978c7SHeiko Schocher } 24843f4978c7SHeiko Schocher 24853f4978c7SHeiko Schocher which defines 24863f4978c7SHeiko Schocher bus 0 on adapter 0 without a mux 2487ea818dbbSHeiko Schocher bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1 2488ea818dbbSHeiko Schocher bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2 2489ea818dbbSHeiko Schocher bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3 2490ea818dbbSHeiko Schocher bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4 2491ea818dbbSHeiko Schocher bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5 24923f4978c7SHeiko Schocher bus 6 on adapter 1 without a mux 2493ea818dbbSHeiko Schocher bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1 2494ea818dbbSHeiko Schocher bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2 24953f4978c7SHeiko Schocher 24963f4978c7SHeiko Schocher If you do not have i2c muxes on your board, omit this define. 24973f4978c7SHeiko Schocher 2498ea818dbbSHeiko Schocher- Legacy I2C Support: CONFIG_HARD_I2C 24993f4978c7SHeiko Schocher 25003f4978c7SHeiko Schocher NOTE: It is intended to move drivers to CONFIG_SYS_I2C which 25013f4978c7SHeiko Schocher provides the following compelling advantages: 25023f4978c7SHeiko Schocher 25033f4978c7SHeiko Schocher - more than one i2c adapter is usable 25043f4978c7SHeiko Schocher - approved multibus support 25053f4978c7SHeiko Schocher - better i2c mux support 25063f4978c7SHeiko Schocher 25073f4978c7SHeiko Schocher ** Please consider updating your I2C driver now. ** 25083f4978c7SHeiko Schocher 2509ea818dbbSHeiko Schocher These enable legacy I2C serial bus commands. Defining 2510ea818dbbSHeiko Schocher CONFIG_HARD_I2C will include the appropriate I2C driver 2511ea818dbbSHeiko Schocher for the selected CPU. 2512c609719bSwdenk 2513b37c7e5eSwdenk This will allow you to use i2c commands at the u-boot 2514602ad3b3SJon Loeliger command line (as long as you set CONFIG_CMD_I2C in 2515b37c7e5eSwdenk CONFIG_COMMANDS) and communicate with i2c based realtime 2516b37c7e5eSwdenk clock chips. See common/cmd_i2c.c for a description of the 2517c609719bSwdenk command line interface. 2518c609719bSwdenk 2519bb99ad6dSBen Warren CONFIG_HARD_I2C selects a hardware I2C controller. 2520c609719bSwdenk 2521b37c7e5eSwdenk There are several other quantities that must also be 2522ea818dbbSHeiko Schocher defined when you define CONFIG_HARD_I2C. 2523c609719bSwdenk 25246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD In both cases you will need to define CONFIG_SYS_I2C_SPEED 2525b37c7e5eSwdenk to be the frequency (in Hz) at which you wish your i2c bus 25266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie 252711ccc33fSMarcel Ziswiler the CPU's i2c node address). 2528c609719bSwdenk 25298d321b81SPeter Tyser Now, the u-boot i2c code for the mpc8xx 2530a47a12beSStefan Roese (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node 25318d321b81SPeter Tyser and so its address should therefore be cleared to 0 (See, 25328d321b81SPeter Tyser eg, MPC823e User's Manual p.16-473). So, set 25338d321b81SPeter Tyser CONFIG_SYS_I2C_SLAVE to 0. 2534b37c7e5eSwdenk 25355da71efaSEric Millbrandt CONFIG_SYS_I2C_INIT_MPC5XXX 25365da71efaSEric Millbrandt 25375da71efaSEric Millbrandt When a board is reset during an i2c bus transfer 25385da71efaSEric Millbrandt chips might think that the current transfer is still 25395da71efaSEric Millbrandt in progress. Reset the slave devices by sending start 25405da71efaSEric Millbrandt commands until the slave device responds. 25415da71efaSEric Millbrandt 2542b37c7e5eSwdenk That's all that's required for CONFIG_HARD_I2C. 2543b37c7e5eSwdenk 2544ea818dbbSHeiko Schocher If you use the software i2c interface (CONFIG_SYS_I2C_SOFT) 2545b37c7e5eSwdenk then the following macros need to be defined (examples are 2546b37c7e5eSwdenk from include/configs/lwmon.h): 2547c609719bSwdenk 2548c609719bSwdenk I2C_INIT 2549c609719bSwdenk 2550b37c7e5eSwdenk (Optional). Any commands necessary to enable the I2C 2551c609719bSwdenk controller or configure ports. 2552c609719bSwdenk 2553b37c7e5eSwdenk eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL) 2554b37c7e5eSwdenk 2555c609719bSwdenk I2C_PORT 2556c609719bSwdenk 2557c609719bSwdenk (Only for MPC8260 CPU). The I/O port to use (the code 2558c609719bSwdenk assumes both bits are on the same port). Valid values 2559c609719bSwdenk are 0..3 for ports A..D. 2560c609719bSwdenk 2561c609719bSwdenk I2C_ACTIVE 2562c609719bSwdenk 2563c609719bSwdenk The code necessary to make the I2C data line active 2564c609719bSwdenk (driven). If the data line is open collector, this 2565c609719bSwdenk define can be null. 2566c609719bSwdenk 2567b37c7e5eSwdenk eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA) 2568b37c7e5eSwdenk 2569c609719bSwdenk I2C_TRISTATE 2570c609719bSwdenk 2571c609719bSwdenk The code necessary to make the I2C data line tri-stated 2572c609719bSwdenk (inactive). If the data line is open collector, this 2573c609719bSwdenk define can be null. 2574c609719bSwdenk 2575b37c7e5eSwdenk eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA) 2576b37c7e5eSwdenk 2577c609719bSwdenk I2C_READ 2578c609719bSwdenk 2579472d5460SYork Sun Code that returns true if the I2C data line is high, 2580472d5460SYork Sun false if it is low. 2581c609719bSwdenk 2582b37c7e5eSwdenk eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0) 2583b37c7e5eSwdenk 2584c609719bSwdenk I2C_SDA(bit) 2585c609719bSwdenk 2586472d5460SYork Sun If <bit> is true, sets the I2C data line high. If it 2587472d5460SYork Sun is false, it clears it (low). 2588c609719bSwdenk 2589b37c7e5eSwdenk eg: #define I2C_SDA(bit) \ 2590b37c7e5eSwdenk if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \ 2591b37c7e5eSwdenk else immr->im_cpm.cp_pbdat &= ~PB_SDA 2592b37c7e5eSwdenk 2593c609719bSwdenk I2C_SCL(bit) 2594c609719bSwdenk 2595472d5460SYork Sun If <bit> is true, sets the I2C clock line high. If it 2596472d5460SYork Sun is false, it clears it (low). 2597c609719bSwdenk 2598b37c7e5eSwdenk eg: #define I2C_SCL(bit) \ 2599b37c7e5eSwdenk if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \ 2600b37c7e5eSwdenk else immr->im_cpm.cp_pbdat &= ~PB_SCL 2601b37c7e5eSwdenk 2602c609719bSwdenk I2C_DELAY 2603c609719bSwdenk 2604c609719bSwdenk This delay is invoked four times per clock cycle so this 2605c609719bSwdenk controls the rate of data transfer. The data rate thus 2606b37c7e5eSwdenk is 1 / (I2C_DELAY * 4). Often defined to be something 2607b37c7e5eSwdenk like: 2608b37c7e5eSwdenk 2609b37c7e5eSwdenk #define I2C_DELAY udelay(2) 2610c609719bSwdenk 2611793b5726SMike Frysinger CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA 2612793b5726SMike Frysinger 2613793b5726SMike Frysinger If your arch supports the generic GPIO framework (asm/gpio.h), 2614793b5726SMike Frysinger then you may alternatively define the two GPIOs that are to be 2615793b5726SMike Frysinger used as SCL / SDA. Any of the previous I2C_xxx macros will 2616793b5726SMike Frysinger have GPIO-based defaults assigned to them as appropriate. 2617793b5726SMike Frysinger 2618793b5726SMike Frysinger You should define these to the GPIO value as given directly to 2619793b5726SMike Frysinger the generic GPIO functions. 2620793b5726SMike Frysinger 26216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_INIT_BOARD 262247cd00faSwdenk 262347cd00faSwdenk When a board is reset during an i2c bus transfer 262447cd00faSwdenk chips might think that the current transfer is still 262547cd00faSwdenk in progress. On some boards it is possible to access 262647cd00faSwdenk the i2c SCLK line directly, either by using the 262747cd00faSwdenk processor pin as a GPIO or by having a second pin 262847cd00faSwdenk connected to the bus. If this option is defined a 262947cd00faSwdenk custom i2c_init_board() routine in boards/xxx/board.c 263047cd00faSwdenk is run early in the boot sequence. 263147cd00faSwdenk 263226a33504SRichard Retanubun CONFIG_SYS_I2C_BOARD_LATE_INIT 263326a33504SRichard Retanubun 263426a33504SRichard Retanubun An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is 263526a33504SRichard Retanubun defined a custom i2c_board_late_init() routine in 263626a33504SRichard Retanubun boards/xxx/board.c is run AFTER the operations in i2c_init() 263726a33504SRichard Retanubun is completed. This callpoint can be used to unreset i2c bus 263826a33504SRichard Retanubun using CPU i2c controller register accesses for CPUs whose i2c 263926a33504SRichard Retanubun controller provide such a method. It is called at the end of 264026a33504SRichard Retanubun i2c_init() to allow i2c_init operations to setup the i2c bus 264126a33504SRichard Retanubun controller on the CPU (e.g. setting bus speed & slave address). 264226a33504SRichard Retanubun 264317ea1177Swdenk CONFIG_I2CFAST (PPC405GP|PPC405EP only) 264417ea1177Swdenk 264517ea1177Swdenk This option enables configuration of bi_iic_fast[] flags 264617ea1177Swdenk in u-boot bd_info structure based on u-boot environment 264717ea1177Swdenk variable "i2cfast". (see also i2cfast) 264817ea1177Swdenk 2649bb99ad6dSBen Warren CONFIG_I2C_MULTI_BUS 2650bb99ad6dSBen Warren 2651bb99ad6dSBen Warren This option allows the use of multiple I2C buses, each of which 2652bb99ad6dSBen Warren must have a controller. At any point in time, only one bus is 2653bb99ad6dSBen Warren active. To switch to a different bus, use the 'i2c dev' command. 2654bb99ad6dSBen Warren Note that bus numbering is zero-based. 2655bb99ad6dSBen Warren 26566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_NOPROBES 2657bb99ad6dSBen Warren 2658bb99ad6dSBen Warren This option specifies a list of I2C devices that will be skipped 26590f89c54bSPeter Tyser when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS 26600f89c54bSPeter Tyser is set, specify a list of bus-device pairs. Otherwise, specify 26610f89c54bSPeter Tyser a 1D array of device addresses 2662bb99ad6dSBen Warren 2663bb99ad6dSBen Warren e.g. 2664bb99ad6dSBen Warren #undef CONFIG_I2C_MULTI_BUS 26656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68} 2666bb99ad6dSBen Warren 2667bb99ad6dSBen Warren will skip addresses 0x50 and 0x68 on a board with one I2C bus 2668bb99ad6dSBen Warren 2669bb99ad6dSBen Warren #define CONFIG_I2C_MULTI_BUS 26706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}} 2671bb99ad6dSBen Warren 2672bb99ad6dSBen Warren will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1 2673bb99ad6dSBen Warren 26746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SPD_BUS_NUM 2675be5e6181STimur Tabi 2676be5e6181STimur Tabi If defined, then this indicates the I2C bus number for DDR SPD. 2677be5e6181STimur Tabi If not defined, then U-Boot assumes that SPD is on I2C bus 0. 2678be5e6181STimur Tabi 26796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_RTC_BUS_NUM 26800dc018ecSStefan Roese 26810dc018ecSStefan Roese If defined, then this indicates the I2C bus number for the RTC. 26820dc018ecSStefan Roese If not defined, then U-Boot assumes that RTC is on I2C bus 0. 26830dc018ecSStefan Roese 26846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_DTT_BUS_NUM 26850dc018ecSStefan Roese 26860dc018ecSStefan Roese If defined, then this indicates the I2C bus number for the DTT. 26870dc018ecSStefan Roese If not defined, then U-Boot assumes that DTT is on I2C bus 0. 26880dc018ecSStefan Roese 26896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_DTT_ADDR: 26909ebbb54fSVictor Gallardo 26919ebbb54fSVictor Gallardo If defined, specifies the I2C address of the DTT device. 26929ebbb54fSVictor Gallardo If not defined, then U-Boot uses predefined value for 26939ebbb54fSVictor Gallardo specified DTT device. 26949ebbb54fSVictor Gallardo 26952ac6985aSAndrew Dyer CONFIG_SOFT_I2C_READ_REPEATED_START 26962ac6985aSAndrew Dyer 26972ac6985aSAndrew Dyer defining this will force the i2c_read() function in 26982ac6985aSAndrew Dyer the soft_i2c driver to perform an I2C repeated start 26992ac6985aSAndrew Dyer between writing the address pointer and reading the 27002ac6985aSAndrew Dyer data. If this define is omitted the default behaviour 27012ac6985aSAndrew Dyer of doing a stop-start sequence will be used. Most I2C 27022ac6985aSAndrew Dyer devices can use either method, but some require one or 27032ac6985aSAndrew Dyer the other. 2704be5e6181STimur Tabi 2705c609719bSwdenk- SPI Support: CONFIG_SPI 2706c609719bSwdenk 2707c609719bSwdenk Enables SPI driver (so far only tested with 2708c609719bSwdenk SPI EEPROM, also an instance works with Crystal A/D and 2709c609719bSwdenk D/As on the SACSng board) 2710c609719bSwdenk 27116639562eSYoshihiro Shimoda CONFIG_SH_SPI 27126639562eSYoshihiro Shimoda 27136639562eSYoshihiro Shimoda Enables the driver for SPI controller on SuperH. Currently 27146639562eSYoshihiro Shimoda only SH7757 is supported. 27156639562eSYoshihiro Shimoda 2716c609719bSwdenk CONFIG_SPI_X 2717c609719bSwdenk 2718c609719bSwdenk Enables extended (16-bit) SPI EEPROM addressing. 2719c609719bSwdenk (symmetrical to CONFIG_I2C_X) 2720c609719bSwdenk 2721c609719bSwdenk CONFIG_SOFT_SPI 2722c609719bSwdenk 2723c609719bSwdenk Enables a software (bit-bang) SPI driver rather than 2724c609719bSwdenk using hardware support. This is a general purpose 2725c609719bSwdenk driver that only requires three general I/O port pins 2726c609719bSwdenk (two outputs, one input) to function. If this is 2727c609719bSwdenk defined, the board configuration must define several 2728c609719bSwdenk SPI configuration items (port pins to use, etc). For 2729c609719bSwdenk an example, see include/configs/sacsng.h. 2730c609719bSwdenk 273104a9e118SBen Warren CONFIG_HARD_SPI 273204a9e118SBen Warren 273304a9e118SBen Warren Enables a hardware SPI driver for general-purpose reads 273404a9e118SBen Warren and writes. As with CONFIG_SOFT_SPI, the board configuration 273504a9e118SBen Warren must define a list of chip-select function pointers. 273604a9e118SBen Warren Currently supported on some MPC8xxx processors. For an 273704a9e118SBen Warren example, see include/configs/mpc8349emds.h. 273804a9e118SBen Warren 273938254f45SGuennadi Liakhovetski CONFIG_MXC_SPI 274038254f45SGuennadi Liakhovetski 274138254f45SGuennadi Liakhovetski Enables the driver for the SPI controllers on i.MX and MXC 27422e3cd1cdSFabio Estevam SoCs. Currently i.MX31/35/51 are supported. 274338254f45SGuennadi Liakhovetski 2744f659b573SHeiko Schocher CONFIG_SYS_SPI_MXC_WAIT 2745f659b573SHeiko Schocher Timeout for waiting until spi transfer completed. 2746f659b573SHeiko Schocher default: (CONFIG_SYS_HZ/100) /* 10 ms */ 2747f659b573SHeiko Schocher 27480133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA 27490133502eSMatthias Fuchs 27500133502eSMatthias Fuchs Enables FPGA subsystem. 27510133502eSMatthias Fuchs 27520133502eSMatthias Fuchs CONFIG_FPGA_<vendor> 27530133502eSMatthias Fuchs 27540133502eSMatthias Fuchs Enables support for specific chip vendors. 27550133502eSMatthias Fuchs (ALTERA, XILINX) 27560133502eSMatthias Fuchs 27570133502eSMatthias Fuchs CONFIG_FPGA_<family> 27580133502eSMatthias Fuchs 27590133502eSMatthias Fuchs Enables support for FPGA family. 27600133502eSMatthias Fuchs (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX) 27610133502eSMatthias Fuchs 27620133502eSMatthias Fuchs CONFIG_FPGA_COUNT 2763c609719bSwdenk 2764c609719bSwdenk Specify the number of FPGA devices to support. 2765c609719bSwdenk 276664e809afSSiva Durga Prasad Paladugu CONFIG_CMD_FPGA_LOADMK 276764e809afSSiva Durga Prasad Paladugu 276864e809afSSiva Durga Prasad Paladugu Enable support for fpga loadmk command 276964e809afSSiva Durga Prasad Paladugu 277067193864SMichal Simek CONFIG_CMD_FPGA_LOADP 277167193864SMichal Simek 277267193864SMichal Simek Enable support for fpga loadp command - load partial bitstream 277367193864SMichal Simek 277467193864SMichal Simek CONFIG_CMD_FPGA_LOADBP 277567193864SMichal Simek 277667193864SMichal Simek Enable support for fpga loadbp command - load partial bitstream 277767193864SMichal Simek (Xilinx only) 277867193864SMichal Simek 27796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_PROG_FEEDBACK 2780c609719bSwdenk 2781c609719bSwdenk Enable printing of hash marks during FPGA configuration. 2782c609719bSwdenk 27836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_BUSY 2784c609719bSwdenk 2785c609719bSwdenk Enable checks on FPGA configuration interface busy 2786c609719bSwdenk status by the configuration function. This option 2787c609719bSwdenk will require a board or device specific function to 2788c609719bSwdenk be written. 2789c609719bSwdenk 2790c609719bSwdenk CONFIG_FPGA_DELAY 2791c609719bSwdenk 2792c609719bSwdenk If defined, a function that provides delays in the FPGA 2793c609719bSwdenk configuration driver. 2794c609719bSwdenk 27956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_CTRLC 2796c609719bSwdenk Allow Control-C to interrupt FPGA configuration 2797c609719bSwdenk 27986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_ERROR 2799c609719bSwdenk 2800c609719bSwdenk Check for configuration errors during FPGA bitfile 2801c609719bSwdenk loading. For example, abort during Virtex II 2802c609719bSwdenk configuration if the INIT_B line goes low (which 2803c609719bSwdenk indicated a CRC error). 2804c609719bSwdenk 28056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_INIT 2806c609719bSwdenk 2807b445bbb4SJeremiah Mahler Maximum time to wait for the INIT_B line to de-assert 2808b445bbb4SJeremiah Mahler after PROB_B has been de-asserted during a Virtex II 2809c609719bSwdenk FPGA configuration sequence. The default time is 500 281011ccc33fSMarcel Ziswiler ms. 2811c609719bSwdenk 28126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_BUSY 2813c609719bSwdenk 2814b445bbb4SJeremiah Mahler Maximum time to wait for BUSY to de-assert during 281511ccc33fSMarcel Ziswiler Virtex II FPGA configuration. The default is 5 ms. 2816c609719bSwdenk 28176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_CONFIG 2818c609719bSwdenk 2819c609719bSwdenk Time to wait after FPGA configuration. The default is 282011ccc33fSMarcel Ziswiler 200 ms. 2821c609719bSwdenk 2822c609719bSwdenk- Configuration Management: 2823b2b8a696SStefan Roese CONFIG_BUILD_TARGET 2824b2b8a696SStefan Roese 2825b2b8a696SStefan Roese Some SoCs need special image types (e.g. U-Boot binary 2826b2b8a696SStefan Roese with a special header) as build targets. By defining 2827b2b8a696SStefan Roese CONFIG_BUILD_TARGET in the SoC / board header, this 2828b2b8a696SStefan Roese special image will be automatically built upon calling 2829b2b8a696SStefan Roese make / MAKEALL. 2830b2b8a696SStefan Roese 2831c609719bSwdenk CONFIG_IDENT_STRING 2832c609719bSwdenk 2833c609719bSwdenk If defined, this string will be added to the U-Boot 2834c609719bSwdenk version information (U_BOOT_VERSION) 2835c609719bSwdenk 2836c609719bSwdenk- Vendor Parameter Protection: 2837c609719bSwdenk 2838c609719bSwdenk U-Boot considers the values of the environment 2839c609719bSwdenk variables "serial#" (Board Serial Number) and 28407152b1d0Swdenk "ethaddr" (Ethernet Address) to be parameters that 2841c609719bSwdenk are set once by the board vendor / manufacturer, and 2842c609719bSwdenk protects these variables from casual modification by 2843c609719bSwdenk the user. Once set, these variables are read-only, 2844c609719bSwdenk and write or delete attempts are rejected. You can 284511ccc33fSMarcel Ziswiler change this behaviour: 2846c609719bSwdenk 2847c609719bSwdenk If CONFIG_ENV_OVERWRITE is #defined in your config 2848c609719bSwdenk file, the write protection for vendor parameters is 284947cd00faSwdenk completely disabled. Anybody can change or delete 2850c609719bSwdenk these parameters. 2851c609719bSwdenk 285292ac5208SJoe Hershberger Alternatively, if you define _both_ an ethaddr in the 285392ac5208SJoe Hershberger default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default 285411ccc33fSMarcel Ziswiler Ethernet address is installed in the environment, 2855c609719bSwdenk which can be changed exactly ONCE by the user. [The 2856c609719bSwdenk serial# is unaffected by this, i. e. it remains 2857c609719bSwdenk read-only.] 2858c609719bSwdenk 28592598090bSJoe Hershberger The same can be accomplished in a more flexible way 28602598090bSJoe Hershberger for any variable by configuring the type of access 28612598090bSJoe Hershberger to allow for those variables in the ".flags" variable 28622598090bSJoe Hershberger or define CONFIG_ENV_FLAGS_LIST_STATIC. 28632598090bSJoe Hershberger 2864c609719bSwdenk- Protected RAM: 2865c609719bSwdenk CONFIG_PRAM 2866c609719bSwdenk 2867c609719bSwdenk Define this variable to enable the reservation of 2868c609719bSwdenk "protected RAM", i. e. RAM which is not overwritten 2869c609719bSwdenk by U-Boot. Define CONFIG_PRAM to hold the number of 2870c609719bSwdenk kB you want to reserve for pRAM. You can overwrite 2871c609719bSwdenk this default value by defining an environment 2872c609719bSwdenk variable "pram" to the number of kB you want to 2873c609719bSwdenk reserve. Note that the board info structure will 2874c609719bSwdenk still show the full amount of RAM. If pRAM is 2875c609719bSwdenk reserved, a new environment variable "mem" will 2876c609719bSwdenk automatically be defined to hold the amount of 2877c609719bSwdenk remaining RAM in a form that can be passed as boot 2878c609719bSwdenk argument to Linux, for instance like that: 2879c609719bSwdenk 2880fe126d8bSWolfgang Denk setenv bootargs ... mem=\${mem} 2881c609719bSwdenk saveenv 2882c609719bSwdenk 2883c609719bSwdenk This way you can tell Linux not to use this memory, 2884c609719bSwdenk either, which results in a memory region that will 2885c609719bSwdenk not be affected by reboots. 2886c609719bSwdenk 2887c609719bSwdenk *WARNING* If your board configuration uses automatic 2888c609719bSwdenk detection of the RAM size, you must make sure that 2889c609719bSwdenk this memory test is non-destructive. So far, the 2890c609719bSwdenk following board configurations are known to be 2891c609719bSwdenk "pRAM-clean": 2892c609719bSwdenk 28931b0757ecSWolfgang Denk IVMS8, IVML24, SPD8xx, TQM8xxL, 28941b0757ecSWolfgang Denk HERMES, IP860, RPXlite, LWMON, 2895544d97e9SWolfgang Denk FLAGADM, TQM8260 2896c609719bSwdenk 289740fef049SGabe Black- Access to physical memory region (> 4GB) 289840fef049SGabe Black Some basic support is provided for operations on memory not 289940fef049SGabe Black normally accessible to U-Boot - e.g. some architectures 290040fef049SGabe Black support access to more than 4GB of memory on 32-bit 290140fef049SGabe Black machines using physical address extension or similar. 290240fef049SGabe Black Define CONFIG_PHYSMEM to access this basic support, which 290340fef049SGabe Black currently only supports clearing the memory. 290440fef049SGabe Black 2905c609719bSwdenk- Error Recovery: 2906c609719bSwdenk CONFIG_PANIC_HANG 2907c609719bSwdenk 2908c609719bSwdenk Define this variable to stop the system in case of a 2909c609719bSwdenk fatal error, so that you have to reset it manually. 2910c609719bSwdenk This is probably NOT a good idea for an embedded 291111ccc33fSMarcel Ziswiler system where you want the system to reboot 2912c609719bSwdenk automatically as fast as possible, but it may be 2913c609719bSwdenk useful during development since you can try to debug 2914c609719bSwdenk the conditions that lead to the situation. 2915c609719bSwdenk 2916c609719bSwdenk CONFIG_NET_RETRY_COUNT 2917c609719bSwdenk 2918c609719bSwdenk This variable defines the number of retries for 2919c609719bSwdenk network operations like ARP, RARP, TFTP, or BOOTP 2920c609719bSwdenk before giving up the operation. If not defined, a 2921c609719bSwdenk default value of 5 is used. 2922c609719bSwdenk 292340cb90eeSGuennadi Liakhovetski CONFIG_ARP_TIMEOUT 292440cb90eeSGuennadi Liakhovetski 292540cb90eeSGuennadi Liakhovetski Timeout waiting for an ARP reply in milliseconds. 292640cb90eeSGuennadi Liakhovetski 292748a3e999STetsuyuki Kobayashi CONFIG_NFS_TIMEOUT 292848a3e999STetsuyuki Kobayashi 292948a3e999STetsuyuki Kobayashi Timeout in milliseconds used in NFS protocol. 293048a3e999STetsuyuki Kobayashi If you encounter "ERROR: Cannot umount" in nfs command, 293148a3e999STetsuyuki Kobayashi try longer timeout such as 293248a3e999STetsuyuki Kobayashi #define CONFIG_NFS_TIMEOUT 10000UL 293348a3e999STetsuyuki Kobayashi 2934c609719bSwdenk- Command Interpreter: 29358078f1a5SWolfgang Denk CONFIG_AUTO_COMPLETE 293604a85b3bSwdenk 293704a85b3bSwdenk Enable auto completion of commands using TAB. 293804a85b3bSwdenk 29396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PROMPT_HUSH_PS2 2940c609719bSwdenk 2941c609719bSwdenk This defines the secondary prompt string, which is 2942c609719bSwdenk printed when the command interpreter needs more input 2943c609719bSwdenk to complete a command. Usually "> ". 2944c609719bSwdenk 2945c609719bSwdenk Note: 2946c609719bSwdenk 2947c609719bSwdenk In the current implementation, the local variables 2948c609719bSwdenk space and global environment variables space are 2949c609719bSwdenk separated. Local variables are those you define by 29503b57fe0aSwdenk simply typing `name=value'. To access a local 2951c609719bSwdenk variable later on, you have write `$name' or 29523b57fe0aSwdenk `${name}'; to execute the contents of a variable 29533b57fe0aSwdenk directly type `$name' at the command prompt. 2954c609719bSwdenk 2955c609719bSwdenk Global environment variables are those you use 2956c609719bSwdenk setenv/printenv to work with. To run a command stored 2957c609719bSwdenk in such a variable, you need to use the run command, 2958c609719bSwdenk and you must not use the '$' sign to access them. 2959c609719bSwdenk 2960c609719bSwdenk To store commands and special characters in a 2961c609719bSwdenk variable, please use double quotation marks 2962c609719bSwdenk surrounding the whole text of the variable, instead 2963c609719bSwdenk of the backslashes before semicolons and special 2964c609719bSwdenk symbols. 2965c609719bSwdenk 2966b445bbb4SJeremiah Mahler- Command Line Editing and History: 2967aa0c71acSWolfgang Denk CONFIG_CMDLINE_EDITING 2968aa0c71acSWolfgang Denk 296911ccc33fSMarcel Ziswiler Enable editing and History functions for interactive 2970aa0c71acSWolfgang Denk command line input operations 2971aa0c71acSWolfgang Denk 2972a8c7c708Swdenk- Default Environment: 2973c609719bSwdenk CONFIG_EXTRA_ENV_SETTINGS 2974c609719bSwdenk 2975c609719bSwdenk Define this to contain any number of null terminated 2976c609719bSwdenk strings (variable = value pairs) that will be part of 29777152b1d0Swdenk the default environment compiled into the boot image. 29782262cfeeSwdenk 2979c609719bSwdenk For example, place something like this in your 2980c609719bSwdenk board's config file: 2981c609719bSwdenk 2982c609719bSwdenk #define CONFIG_EXTRA_ENV_SETTINGS \ 2983c609719bSwdenk "myvar1=value1\0" \ 2984c609719bSwdenk "myvar2=value2\0" 2985c609719bSwdenk 2986c609719bSwdenk Warning: This method is based on knowledge about the 2987c609719bSwdenk internal format how the environment is stored by the 29882262cfeeSwdenk U-Boot code. This is NOT an official, exported 2989c609719bSwdenk interface! Although it is unlikely that this format 29907152b1d0Swdenk will change soon, there is no guarantee either. 2991c609719bSwdenk You better know what you are doing here. 2992c609719bSwdenk 2993c609719bSwdenk Note: overly (ab)use of the default environment is 2994c609719bSwdenk discouraged. Make sure to check other ways to preset 299574de7aefSWolfgang Denk the environment like the "source" command or the 2996c609719bSwdenk boot command first. 2997c609719bSwdenk 29985e724ca2SStephen Warren CONFIG_ENV_VARS_UBOOT_CONFIG 29995e724ca2SStephen Warren 30005e724ca2SStephen Warren Define this in order to add variables describing the 30015e724ca2SStephen Warren U-Boot build configuration to the default environment. 30025e724ca2SStephen Warren These will be named arch, cpu, board, vendor, and soc. 30035e724ca2SStephen Warren 30045e724ca2SStephen Warren Enabling this option will cause the following to be defined: 30055e724ca2SStephen Warren 30065e724ca2SStephen Warren - CONFIG_SYS_ARCH 30075e724ca2SStephen Warren - CONFIG_SYS_CPU 30085e724ca2SStephen Warren - CONFIG_SYS_BOARD 30095e724ca2SStephen Warren - CONFIG_SYS_VENDOR 30105e724ca2SStephen Warren - CONFIG_SYS_SOC 30115e724ca2SStephen Warren 30127e27f89fSTom Rini CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG 30137e27f89fSTom Rini 30147e27f89fSTom Rini Define this in order to add variables describing certain 30157e27f89fSTom Rini run-time determined information about the hardware to the 30167e27f89fSTom Rini environment. These will be named board_name, board_rev. 30177e27f89fSTom Rini 301806fd8538SSimon Glass CONFIG_DELAY_ENVIRONMENT 301906fd8538SSimon Glass 302006fd8538SSimon Glass Normally the environment is loaded when the board is 3021b445bbb4SJeremiah Mahler initialised so that it is available to U-Boot. This inhibits 302206fd8538SSimon Glass that so that the environment is not available until 302306fd8538SSimon Glass explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL 302406fd8538SSimon Glass this is instead controlled by the value of 302506fd8538SSimon Glass /config/load-environment. 302606fd8538SSimon Glass 30273b10cf12SChris Packham- Parallel Flash support: 30283b10cf12SChris Packham CONFIG_SYS_NO_FLASH 30293b10cf12SChris Packham 30303b10cf12SChris Packham Traditionally U-boot was run on systems with parallel NOR 30313b10cf12SChris Packham flash. This option is used to disable support for parallel NOR 30323b10cf12SChris Packham flash. This option should be defined if the board does not have 30333b10cf12SChris Packham parallel flash. 30343b10cf12SChris Packham 30353b10cf12SChris Packham If this option is not defined one of the generic flash drivers 30363b10cf12SChris Packham (e.g. CONFIG_FLASH_CFI_DRIVER or CONFIG_ST_SMI) must be 30373b10cf12SChris Packham selected or the board must provide an implementation of the 30383b10cf12SChris Packham flash API (see include/flash.h). 30393b10cf12SChris Packham 3040a8c7c708Swdenk- DataFlash Support: 30412abbe075Swdenk CONFIG_HAS_DATAFLASH 30422abbe075Swdenk 30432abbe075Swdenk Defining this option enables DataFlash features and 30442abbe075Swdenk allows to read/write in Dataflash via the standard 30452abbe075Swdenk commands cp, md... 30462abbe075Swdenk 3047f61ec45eSEric Nelson- Serial Flash support 3048f61ec45eSEric Nelson CONFIG_CMD_SF 3049f61ec45eSEric Nelson 3050f61ec45eSEric Nelson Defining this option enables SPI flash commands 3051f61ec45eSEric Nelson 'sf probe/read/write/erase/update'. 3052f61ec45eSEric Nelson 3053f61ec45eSEric Nelson Usage requires an initial 'probe' to define the serial 3054f61ec45eSEric Nelson flash parameters, followed by read/write/erase/update 3055f61ec45eSEric Nelson commands. 3056f61ec45eSEric Nelson 3057f61ec45eSEric Nelson The following defaults may be provided by the platform 3058f61ec45eSEric Nelson to handle the common case when only a single serial 3059f61ec45eSEric Nelson flash is present on the system. 3060f61ec45eSEric Nelson 3061f61ec45eSEric Nelson CONFIG_SF_DEFAULT_BUS Bus identifier 3062f61ec45eSEric Nelson CONFIG_SF_DEFAULT_CS Chip-select 3063f61ec45eSEric Nelson CONFIG_SF_DEFAULT_MODE (see include/spi.h) 3064f61ec45eSEric Nelson CONFIG_SF_DEFAULT_SPEED in Hz 3065f61ec45eSEric Nelson 306624007273SSimon Glass CONFIG_CMD_SF_TEST 306724007273SSimon Glass 306824007273SSimon Glass Define this option to include a destructive SPI flash 306924007273SSimon Glass test ('sf test'). 307024007273SSimon Glass 3071b902e07cSJagannadha Sutradharudu Teki CONFIG_SF_DUAL_FLASH Dual flash memories 3072b902e07cSJagannadha Sutradharudu Teki 3073b902e07cSJagannadha Sutradharudu Teki Define this option to use dual flash support where two flash 3074b902e07cSJagannadha Sutradharudu Teki memories can be connected with a given cs line. 3075b445bbb4SJeremiah Mahler Currently Xilinx Zynq qspi supports these type of connections. 3076b902e07cSJagannadha Sutradharudu Teki 30773f85ce27Swdenk- SystemACE Support: 30783f85ce27Swdenk CONFIG_SYSTEMACE 30793f85ce27Swdenk 30803f85ce27Swdenk Adding this option adds support for Xilinx SystemACE 30813f85ce27Swdenk chips attached via some sort of local bus. The address 308211ccc33fSMarcel Ziswiler of the chip must also be defined in the 30836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SYSTEMACE_BASE macro. For example: 30843f85ce27Swdenk 30853f85ce27Swdenk #define CONFIG_SYSTEMACE 30866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000 30873f85ce27Swdenk 30883f85ce27Swdenk When SystemACE support is added, the "ace" device type 30893f85ce27Swdenk becomes available to the fat commands, i.e. fatls. 30903f85ce27Swdenk 3091ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port: 3092ecb0ccd9SWolfgang Denk CONFIG_TFTP_PORT 3093ecb0ccd9SWolfgang Denk 309428cb9375SWolfgang Denk If this is defined, the environment variable tftpsrcp 3095ecb0ccd9SWolfgang Denk is used to supply the TFTP UDP source port value. 309628cb9375SWolfgang Denk If tftpsrcp isn't defined, the normal pseudo-random port 3097ecb0ccd9SWolfgang Denk number generator is used. 3098ecb0ccd9SWolfgang Denk 309928cb9375SWolfgang Denk Also, the environment variable tftpdstp is used to supply 310028cb9375SWolfgang Denk the TFTP UDP destination port value. If tftpdstp isn't 310128cb9375SWolfgang Denk defined, the normal port 69 is used. 310228cb9375SWolfgang Denk 310328cb9375SWolfgang Denk The purpose for tftpsrcp is to allow a TFTP server to 3104ecb0ccd9SWolfgang Denk blindly start the TFTP transfer using the pre-configured 3105ecb0ccd9SWolfgang Denk target IP address and UDP port. This has the effect of 3106ecb0ccd9SWolfgang Denk "punching through" the (Windows XP) firewall, allowing 3107ecb0ccd9SWolfgang Denk the remainder of the TFTP transfer to proceed normally. 3108ecb0ccd9SWolfgang Denk A better solution is to properly configure the firewall, 3109ecb0ccd9SWolfgang Denk but sometimes that is not allowed. 3110ecb0ccd9SWolfgang Denk 3111bf36c5d5SSimon Glass- Hashing support: 3112bf36c5d5SSimon Glass CONFIG_CMD_HASH 3113bf36c5d5SSimon Glass 3114bf36c5d5SSimon Glass This enables a generic 'hash' command which can produce 3115bf36c5d5SSimon Glass hashes / digests from a few algorithms (e.g. SHA1, SHA256). 3116bf36c5d5SSimon Glass 3117bf36c5d5SSimon Glass CONFIG_HASH_VERIFY 3118bf36c5d5SSimon Glass 3119bf36c5d5SSimon Glass Enable the hash verify command (hash -v). This adds to code 3120bf36c5d5SSimon Glass size a little. 3121bf36c5d5SSimon Glass 312294e3c8c4Sgaurav rana CONFIG_SHA1 - This option enables support of hashing using SHA1 312394e3c8c4Sgaurav rana algorithm. The hash is calculated in software. 312494e3c8c4Sgaurav rana CONFIG_SHA256 - This option enables support of hashing using 312594e3c8c4Sgaurav rana SHA256 algorithm. The hash is calculated in software. 312694e3c8c4Sgaurav rana CONFIG_SHA_HW_ACCEL - This option enables hardware acceleration 312794e3c8c4Sgaurav rana for SHA1/SHA256 hashing. 312894e3c8c4Sgaurav rana This affects the 'hash' command and also the 312994e3c8c4Sgaurav rana hash_lookup_algo() function. 313094e3c8c4Sgaurav rana CONFIG_SHA_PROG_HW_ACCEL - This option enables 313194e3c8c4Sgaurav rana hardware-acceleration for SHA1/SHA256 progressive hashing. 313294e3c8c4Sgaurav rana Data can be streamed in a block at a time and the hashing 313394e3c8c4Sgaurav rana is performed in hardware. 3134bf36c5d5SSimon Glass 3135bf36c5d5SSimon Glass Note: There is also a sha1sum command, which should perhaps 3136bf36c5d5SSimon Glass be deprecated in favour of 'hash sha1'. 3137bf36c5d5SSimon Glass 3138a11f1873SRobert Winkler- Freescale i.MX specific commands: 3139a11f1873SRobert Winkler CONFIG_CMD_HDMIDETECT 3140a11f1873SRobert Winkler This enables 'hdmidet' command which returns true if an 3141a11f1873SRobert Winkler HDMI monitor is detected. This command is i.MX 6 specific. 3142a11f1873SRobert Winkler 3143a11f1873SRobert Winkler CONFIG_CMD_BMODE 3144a11f1873SRobert Winkler This enables the 'bmode' (bootmode) command for forcing 3145a11f1873SRobert Winkler a boot from specific media. 3146a11f1873SRobert Winkler 3147a11f1873SRobert Winkler This is useful for forcing the ROM's usb downloader to 3148a11f1873SRobert Winkler activate upon a watchdog reset which is nice when iterating 3149a11f1873SRobert Winkler on U-Boot. Using the reset button or running bmode normal 3150a11f1873SRobert Winkler will set it back to normal. This command currently 3151a11f1873SRobert Winkler supports i.MX53 and i.MX6. 3152a11f1873SRobert Winkler 315319c402afSSimon Glass- Signing support: 315419c402afSSimon Glass CONFIG_RSA 315519c402afSSimon Glass 315619c402afSSimon Glass This enables the RSA algorithm used for FIT image verification 31578bf2aad7SDetlev Zundel in U-Boot. See doc/uImage.FIT/signature.txt for more information. 315819c402afSSimon Glass 3159c937ff6dSRuchika Gupta The Modular Exponentiation algorithm in RSA is implemented using 3160c937ff6dSRuchika Gupta driver model. So CONFIG_DM needs to be enabled by default for this 3161c937ff6dSRuchika Gupta library to function. 3162c937ff6dSRuchika Gupta 316319c402afSSimon Glass The signing part is build into mkimage regardless of this 3164c937ff6dSRuchika Gupta option. The software based modular exponentiation is built into 3165c937ff6dSRuchika Gupta mkimage irrespective of this option. 316619c402afSSimon Glass 31679e50c406SHeiko Schocher- bootcount support: 31689e50c406SHeiko Schocher CONFIG_BOOTCOUNT_LIMIT 31699e50c406SHeiko Schocher 31709e50c406SHeiko Schocher This enables the bootcounter support, see: 31719e50c406SHeiko Schocher http://www.denx.de/wiki/DULG/UBootBootCountLimit 31729e50c406SHeiko Schocher 31739e50c406SHeiko Schocher CONFIG_AT91SAM9XE 31749e50c406SHeiko Schocher enable special bootcounter support on at91sam9xe based boards. 31759e50c406SHeiko Schocher CONFIG_BLACKFIN 31769e50c406SHeiko Schocher enable special bootcounter support on blackfin based boards. 31779e50c406SHeiko Schocher CONFIG_SOC_DA8XX 31789e50c406SHeiko Schocher enable special bootcounter support on da850 based boards. 31799e50c406SHeiko Schocher CONFIG_BOOTCOUNT_RAM 31809e50c406SHeiko Schocher enable support for the bootcounter in RAM 31819e50c406SHeiko Schocher CONFIG_BOOTCOUNT_I2C 31829e50c406SHeiko Schocher enable support for the bootcounter on an i2c (like RTC) device. 31839e50c406SHeiko Schocher CONFIG_SYS_I2C_RTC_ADDR = i2c chip address 31849e50c406SHeiko Schocher CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for 31859e50c406SHeiko Schocher the bootcounter. 31869e50c406SHeiko Schocher CONFIG_BOOTCOUNT_ALEN = address len 318719c402afSSimon Glass 3188a8c7c708Swdenk- Show boot progress: 3189c609719bSwdenk CONFIG_SHOW_BOOT_PROGRESS 3190c609719bSwdenk 3191c609719bSwdenk Defining this option allows to add some board- 3192c609719bSwdenk specific code (calling a user-provided function 3193c609719bSwdenk "show_boot_progress(int)") that enables you to show 3194c609719bSwdenk the system's boot progress on some display (for 3195c609719bSwdenk example, some LED's) on your board. At the moment, 3196c609719bSwdenk the following checkpoints are implemented: 3197c609719bSwdenk 319894fd1316SSimon Glass 31991372cce2SMarian BalakowiczLegacy uImage format: 32001372cce2SMarian Balakowicz 3201c609719bSwdenk Arg Where When 3202c609719bSwdenk 1 common/cmd_bootm.c before attempting to boot an image 3203c609719bSwdenk -1 common/cmd_bootm.c Image header has bad magic number 3204c609719bSwdenk 2 common/cmd_bootm.c Image header has correct magic number 3205c609719bSwdenk -2 common/cmd_bootm.c Image header has bad checksum 3206c609719bSwdenk 3 common/cmd_bootm.c Image header has correct checksum 3207c609719bSwdenk -3 common/cmd_bootm.c Image data has bad checksum 3208c609719bSwdenk 4 common/cmd_bootm.c Image data has correct checksum 3209c609719bSwdenk -4 common/cmd_bootm.c Image is for unsupported architecture 3210c609719bSwdenk 5 common/cmd_bootm.c Architecture check OK 32111372cce2SMarian Balakowicz -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi) 3212c609719bSwdenk 6 common/cmd_bootm.c Image Type check OK 3213c609719bSwdenk -6 common/cmd_bootm.c gunzip uncompression error 3214c609719bSwdenk -7 common/cmd_bootm.c Unimplemented compression type 3215c609719bSwdenk 7 common/cmd_bootm.c Uncompression OK 32161372cce2SMarian Balakowicz 8 common/cmd_bootm.c No uncompress/copy overwrite error 3217c609719bSwdenk -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX) 32181372cce2SMarian Balakowicz 32191372cce2SMarian Balakowicz 9 common/image.c Start initial ramdisk verification 32201372cce2SMarian Balakowicz -10 common/image.c Ramdisk header has bad magic number 32211372cce2SMarian Balakowicz -11 common/image.c Ramdisk header has bad checksum 32221372cce2SMarian Balakowicz 10 common/image.c Ramdisk header is OK 32231372cce2SMarian Balakowicz -12 common/image.c Ramdisk data has bad checksum 32241372cce2SMarian Balakowicz 11 common/image.c Ramdisk data has correct checksum 32251372cce2SMarian Balakowicz 12 common/image.c Ramdisk verification complete, start loading 322611ccc33fSMarcel Ziswiler -13 common/image.c Wrong Image Type (not PPC Linux ramdisk) 32271372cce2SMarian Balakowicz 13 common/image.c Start multifile image verification 32281372cce2SMarian Balakowicz 14 common/image.c No initial ramdisk, no multifile, continue. 32291372cce2SMarian Balakowicz 3230ea0364f1SPeter Tyser 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS 3231c609719bSwdenk 3232a47a12beSStefan Roese -30 arch/powerpc/lib/board.c Fatal error, hang the system 323363e73c9aSwdenk -31 post/post.c POST test failed, detected by post_output_backlog() 323463e73c9aSwdenk -32 post/post.c POST test failed, detected by post_run_single() 323563e73c9aSwdenk 3236566a494fSHeiko Schocher 34 common/cmd_doc.c before loading a Image from a DOC device 3237566a494fSHeiko Schocher -35 common/cmd_doc.c Bad usage of "doc" command 3238566a494fSHeiko Schocher 35 common/cmd_doc.c correct usage of "doc" command 3239566a494fSHeiko Schocher -36 common/cmd_doc.c No boot device 3240566a494fSHeiko Schocher 36 common/cmd_doc.c correct boot device 3241566a494fSHeiko Schocher -37 common/cmd_doc.c Unknown Chip ID on boot device 3242566a494fSHeiko Schocher 37 common/cmd_doc.c correct chip ID found, device available 3243566a494fSHeiko Schocher -38 common/cmd_doc.c Read Error on boot device 3244566a494fSHeiko Schocher 38 common/cmd_doc.c reading Image header from DOC device OK 3245566a494fSHeiko Schocher -39 common/cmd_doc.c Image header has bad magic number 3246566a494fSHeiko Schocher 39 common/cmd_doc.c Image header has correct magic number 3247566a494fSHeiko Schocher -40 common/cmd_doc.c Error reading Image from DOC device 3248566a494fSHeiko Schocher 40 common/cmd_doc.c Image header has correct magic number 3249566a494fSHeiko Schocher 41 common/cmd_ide.c before loading a Image from a IDE device 3250566a494fSHeiko Schocher -42 common/cmd_ide.c Bad usage of "ide" command 3251566a494fSHeiko Schocher 42 common/cmd_ide.c correct usage of "ide" command 3252566a494fSHeiko Schocher -43 common/cmd_ide.c No boot device 3253566a494fSHeiko Schocher 43 common/cmd_ide.c boot device found 3254566a494fSHeiko Schocher -44 common/cmd_ide.c Device not available 3255566a494fSHeiko Schocher 44 common/cmd_ide.c Device available 3256566a494fSHeiko Schocher -45 common/cmd_ide.c wrong partition selected 3257566a494fSHeiko Schocher 45 common/cmd_ide.c partition selected 3258566a494fSHeiko Schocher -46 common/cmd_ide.c Unknown partition table 3259566a494fSHeiko Schocher 46 common/cmd_ide.c valid partition table found 3260566a494fSHeiko Schocher -47 common/cmd_ide.c Invalid partition type 3261566a494fSHeiko Schocher 47 common/cmd_ide.c correct partition type 3262566a494fSHeiko Schocher -48 common/cmd_ide.c Error reading Image Header on boot device 3263566a494fSHeiko Schocher 48 common/cmd_ide.c reading Image Header from IDE device OK 3264566a494fSHeiko Schocher -49 common/cmd_ide.c Image header has bad magic number 3265566a494fSHeiko Schocher 49 common/cmd_ide.c Image header has correct magic number 3266566a494fSHeiko Schocher -50 common/cmd_ide.c Image header has bad checksum 3267566a494fSHeiko Schocher 50 common/cmd_ide.c Image header has correct checksum 3268566a494fSHeiko Schocher -51 common/cmd_ide.c Error reading Image from IDE device 3269566a494fSHeiko Schocher 51 common/cmd_ide.c reading Image from IDE device OK 3270566a494fSHeiko Schocher 52 common/cmd_nand.c before loading a Image from a NAND device 3271566a494fSHeiko Schocher -53 common/cmd_nand.c Bad usage of "nand" command 3272566a494fSHeiko Schocher 53 common/cmd_nand.c correct usage of "nand" command 3273566a494fSHeiko Schocher -54 common/cmd_nand.c No boot device 3274566a494fSHeiko Schocher 54 common/cmd_nand.c boot device found 3275566a494fSHeiko Schocher -55 common/cmd_nand.c Unknown Chip ID on boot device 3276566a494fSHeiko Schocher 55 common/cmd_nand.c correct chip ID found, device available 3277566a494fSHeiko Schocher -56 common/cmd_nand.c Error reading Image Header on boot device 3278566a494fSHeiko Schocher 56 common/cmd_nand.c reading Image Header from NAND device OK 3279566a494fSHeiko Schocher -57 common/cmd_nand.c Image header has bad magic number 3280566a494fSHeiko Schocher 57 common/cmd_nand.c Image header has correct magic number 3281566a494fSHeiko Schocher -58 common/cmd_nand.c Error reading Image from NAND device 3282566a494fSHeiko Schocher 58 common/cmd_nand.c reading Image from NAND device OK 3283c609719bSwdenk 3284566a494fSHeiko Schocher -60 common/env_common.c Environment has a bad CRC, using default 3285c609719bSwdenk 3286566a494fSHeiko Schocher 64 net/eth.c starting with Ethernet configuration. 3287566a494fSHeiko Schocher -64 net/eth.c no Ethernet found. 3288566a494fSHeiko Schocher 65 net/eth.c Ethernet found. 3289206c60cbSwdenk 3290566a494fSHeiko Schocher -80 common/cmd_net.c usage wrong 3291bc0571fcSJoe Hershberger 80 common/cmd_net.c before calling net_loop() 3292bc0571fcSJoe Hershberger -81 common/cmd_net.c some error in net_loop() occurred 3293bc0571fcSJoe Hershberger 81 common/cmd_net.c net_loop() back without error 3294566a494fSHeiko Schocher -82 common/cmd_net.c size == 0 (File with size 0 loaded) 3295566a494fSHeiko Schocher 82 common/cmd_net.c trying automatic boot 329674de7aefSWolfgang Denk 83 common/cmd_net.c running "source" command 329774de7aefSWolfgang Denk -83 common/cmd_net.c some error in automatic boot or "source" command 3298566a494fSHeiko Schocher 84 common/cmd_net.c end without errors 3299c609719bSwdenk 33001372cce2SMarian BalakowiczFIT uImage format: 33011372cce2SMarian Balakowicz 33021372cce2SMarian Balakowicz Arg Where When 33031372cce2SMarian Balakowicz 100 common/cmd_bootm.c Kernel FIT Image has correct format 33041372cce2SMarian Balakowicz -100 common/cmd_bootm.c Kernel FIT Image has incorrect format 33051372cce2SMarian Balakowicz 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration 33061372cce2SMarian Balakowicz -101 common/cmd_bootm.c Can't get configuration for kernel subimage 33071372cce2SMarian Balakowicz 102 common/cmd_bootm.c Kernel unit name specified 33081372cce2SMarian Balakowicz -103 common/cmd_bootm.c Can't get kernel subimage node offset 3309f773bea8SMarian Balakowicz 103 common/cmd_bootm.c Found configuration node 33101372cce2SMarian Balakowicz 104 common/cmd_bootm.c Got kernel subimage node offset 33111372cce2SMarian Balakowicz -104 common/cmd_bootm.c Kernel subimage hash verification failed 33121372cce2SMarian Balakowicz 105 common/cmd_bootm.c Kernel subimage hash verification OK 33131372cce2SMarian Balakowicz -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture 33141372cce2SMarian Balakowicz 106 common/cmd_bootm.c Architecture check OK 331511ccc33fSMarcel Ziswiler -106 common/cmd_bootm.c Kernel subimage has wrong type 331611ccc33fSMarcel Ziswiler 107 common/cmd_bootm.c Kernel subimage type OK 33171372cce2SMarian Balakowicz -107 common/cmd_bootm.c Can't get kernel subimage data/size 33181372cce2SMarian Balakowicz 108 common/cmd_bootm.c Got kernel subimage data/size 33191372cce2SMarian Balakowicz -108 common/cmd_bootm.c Wrong image type (not legacy, FIT) 33201372cce2SMarian Balakowicz -109 common/cmd_bootm.c Can't get kernel subimage type 33211372cce2SMarian Balakowicz -110 common/cmd_bootm.c Can't get kernel subimage comp 33221372cce2SMarian Balakowicz -111 common/cmd_bootm.c Can't get kernel subimage os 33231372cce2SMarian Balakowicz -112 common/cmd_bootm.c Can't get kernel subimage load address 33241372cce2SMarian Balakowicz -113 common/cmd_bootm.c Image uncompress/copy overwrite error 33251372cce2SMarian Balakowicz 33261372cce2SMarian Balakowicz 120 common/image.c Start initial ramdisk verification 33271372cce2SMarian Balakowicz -120 common/image.c Ramdisk FIT image has incorrect format 33281372cce2SMarian Balakowicz 121 common/image.c Ramdisk FIT image has correct format 332911ccc33fSMarcel Ziswiler 122 common/image.c No ramdisk subimage unit name, using configuration 33301372cce2SMarian Balakowicz -122 common/image.c Can't get configuration for ramdisk subimage 33311372cce2SMarian Balakowicz 123 common/image.c Ramdisk unit name specified 33321372cce2SMarian Balakowicz -124 common/image.c Can't get ramdisk subimage node offset 33331372cce2SMarian Balakowicz 125 common/image.c Got ramdisk subimage node offset 33341372cce2SMarian Balakowicz -125 common/image.c Ramdisk subimage hash verification failed 33351372cce2SMarian Balakowicz 126 common/image.c Ramdisk subimage hash verification OK 33361372cce2SMarian Balakowicz -126 common/image.c Ramdisk subimage for unsupported architecture 33371372cce2SMarian Balakowicz 127 common/image.c Architecture check OK 33381372cce2SMarian Balakowicz -127 common/image.c Can't get ramdisk subimage data/size 33391372cce2SMarian Balakowicz 128 common/image.c Got ramdisk subimage data/size 33401372cce2SMarian Balakowicz 129 common/image.c Can't get ramdisk load address 33411372cce2SMarian Balakowicz -129 common/image.c Got ramdisk load address 33421372cce2SMarian Balakowicz 334311ccc33fSMarcel Ziswiler -130 common/cmd_doc.c Incorrect FIT image format 33441372cce2SMarian Balakowicz 131 common/cmd_doc.c FIT image format OK 33451372cce2SMarian Balakowicz 334611ccc33fSMarcel Ziswiler -140 common/cmd_ide.c Incorrect FIT image format 33471372cce2SMarian Balakowicz 141 common/cmd_ide.c FIT image format OK 33481372cce2SMarian Balakowicz 334911ccc33fSMarcel Ziswiler -150 common/cmd_nand.c Incorrect FIT image format 33501372cce2SMarian Balakowicz 151 common/cmd_nand.c FIT image format OK 33511372cce2SMarian Balakowicz 335221d29f7fSHeiko Schocher- legacy image format: 335321d29f7fSHeiko Schocher CONFIG_IMAGE_FORMAT_LEGACY 335421d29f7fSHeiko Schocher enables the legacy image format support in U-Boot. 335521d29f7fSHeiko Schocher 335621d29f7fSHeiko Schocher Default: 335721d29f7fSHeiko Schocher enabled if CONFIG_FIT_SIGNATURE is not defined. 335821d29f7fSHeiko Schocher 335921d29f7fSHeiko Schocher CONFIG_DISABLE_IMAGE_LEGACY 336021d29f7fSHeiko Schocher disable the legacy image format 336121d29f7fSHeiko Schocher 336221d29f7fSHeiko Schocher This define is introduced, as the legacy image format is 336321d29f7fSHeiko Schocher enabled per default for backward compatibility. 336421d29f7fSHeiko Schocher 3365d95f6ec7SGabe Black- FIT image support: 3366d95f6ec7SGabe Black CONFIG_FIT 3367d95f6ec7SGabe Black Enable support for the FIT uImage format. 3368d95f6ec7SGabe Black 3369d95f6ec7SGabe Black CONFIG_FIT_BEST_MATCH 3370d95f6ec7SGabe Black When no configuration is explicitly selected, default to the 3371d95f6ec7SGabe Black one whose fdt's compatibility field best matches that of 3372d95f6ec7SGabe Black U-Boot itself. A match is considered "best" if it matches the 3373d95f6ec7SGabe Black most specific compatibility entry of U-Boot's fdt's root node. 3374d95f6ec7SGabe Black The order of entries in the configuration's fdt is ignored. 3375d95f6ec7SGabe Black 33763e569a6bSSimon Glass CONFIG_FIT_SIGNATURE 33773e569a6bSSimon Glass This option enables signature verification of FIT uImages, 337894e3c8c4Sgaurav rana using a hash signed and verified using RSA. If 337994e3c8c4Sgaurav rana CONFIG_SHA_PROG_HW_ACCEL is defined, i.e support for progressive 338094e3c8c4Sgaurav rana hashing is available using hardware, RSA library will use it. 338194e3c8c4Sgaurav rana See doc/uImage.FIT/signature.txt for more details. 33823e569a6bSSimon Glass 338321d29f7fSHeiko Schocher WARNING: When relying on signed FIT images with required 338421d29f7fSHeiko Schocher signature check the legacy image format is default 338521d29f7fSHeiko Schocher disabled. If a board need legacy image format support 338621d29f7fSHeiko Schocher enable this through CONFIG_IMAGE_FORMAT_LEGACY 338721d29f7fSHeiko Schocher 33889a4f479bSDirk Eibach CONFIG_FIT_DISABLE_SHA256 33899a4f479bSDirk Eibach Supporting SHA256 hashes has quite an impact on binary size. 33909a4f479bSDirk Eibach For constrained systems sha256 hash support can be disabled 33919a4f479bSDirk Eibach with this option. 33929a4f479bSDirk Eibach 33934cf2609bSWolfgang Denk- Standalone program support: 33944cf2609bSWolfgang Denk CONFIG_STANDALONE_LOAD_ADDR 33954cf2609bSWolfgang Denk 33966feff899SWolfgang Denk This option defines a board specific value for the 33976feff899SWolfgang Denk address where standalone program gets loaded, thus 33986feff899SWolfgang Denk overwriting the architecture dependent default 33994cf2609bSWolfgang Denk settings. 34004cf2609bSWolfgang Denk 34014cf2609bSWolfgang Denk- Frame Buffer Address: 34024cf2609bSWolfgang Denk CONFIG_FB_ADDR 34034cf2609bSWolfgang Denk 34044cf2609bSWolfgang Denk Define CONFIG_FB_ADDR if you want to use specific 340544a53b57SWolfgang Denk address for frame buffer. This is typically the case 340644a53b57SWolfgang Denk when using a graphics controller has separate video 340744a53b57SWolfgang Denk memory. U-Boot will then place the frame buffer at 340844a53b57SWolfgang Denk the given address instead of dynamically reserving it 340944a53b57SWolfgang Denk in system RAM by calling lcd_setmem(), which grabs 341044a53b57SWolfgang Denk the memory for the frame buffer depending on the 341144a53b57SWolfgang Denk configured panel size. 34124cf2609bSWolfgang Denk 34134cf2609bSWolfgang Denk Please see board_init_f function. 34144cf2609bSWolfgang Denk 3415cccfc2abSDetlev Zundel- Automatic software updates via TFTP server 3416cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP 3417cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP_CNT_MAX 3418cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP_MSEC_MAX 3419cccfc2abSDetlev Zundel 3420cccfc2abSDetlev Zundel These options enable and control the auto-update feature; 3421cccfc2abSDetlev Zundel for a more detailed description refer to doc/README.update. 3422cccfc2abSDetlev Zundel 3423cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support) 3424cccfc2abSDetlev Zundel CONFIG_MTD_DEVICE 3425cccfc2abSDetlev Zundel 3426cccfc2abSDetlev Zundel Adds the MTD device infrastructure from the Linux kernel. 3427cccfc2abSDetlev Zundel Needed for mtdparts command support. 3428cccfc2abSDetlev Zundel 3429cccfc2abSDetlev Zundel CONFIG_MTD_PARTITIONS 3430cccfc2abSDetlev Zundel 3431cccfc2abSDetlev Zundel Adds the MTD partitioning infrastructure from the Linux 3432cccfc2abSDetlev Zundel kernel. Needed for UBI support. 3433cccfc2abSDetlev Zundel 343470c219cdSJoe Hershberger- UBI support 343570c219cdSJoe Hershberger CONFIG_CMD_UBI 343670c219cdSJoe Hershberger 343770c219cdSJoe Hershberger Adds commands for interacting with MTD partitions formatted 343870c219cdSJoe Hershberger with the UBI flash translation layer 343970c219cdSJoe Hershberger 344070c219cdSJoe Hershberger Requires also defining CONFIG_RBTREE 344170c219cdSJoe Hershberger 3442147162daSJoe Hershberger CONFIG_UBI_SILENCE_MSG 3443147162daSJoe Hershberger 3444147162daSJoe Hershberger Make the verbose messages from UBI stop printing. This leaves 3445147162daSJoe Hershberger warnings and errors enabled. 3446147162daSJoe Hershberger 3447ff94bc40SHeiko Schocher 3448ff94bc40SHeiko Schocher CONFIG_MTD_UBI_WL_THRESHOLD 3449ff94bc40SHeiko Schocher This parameter defines the maximum difference between the highest 3450ff94bc40SHeiko Schocher erase counter value and the lowest erase counter value of eraseblocks 3451ff94bc40SHeiko Schocher of UBI devices. When this threshold is exceeded, UBI starts performing 3452ff94bc40SHeiko Schocher wear leveling by means of moving data from eraseblock with low erase 3453ff94bc40SHeiko Schocher counter to eraseblocks with high erase counter. 3454ff94bc40SHeiko Schocher 3455ff94bc40SHeiko Schocher The default value should be OK for SLC NAND flashes, NOR flashes and 3456ff94bc40SHeiko Schocher other flashes which have eraseblock life-cycle 100000 or more. 3457ff94bc40SHeiko Schocher However, in case of MLC NAND flashes which typically have eraseblock 3458ff94bc40SHeiko Schocher life-cycle less than 10000, the threshold should be lessened (e.g., 3459ff94bc40SHeiko Schocher to 128 or 256, although it does not have to be power of 2). 3460ff94bc40SHeiko Schocher 3461ff94bc40SHeiko Schocher default: 4096 3462ff94bc40SHeiko Schocher 3463ff94bc40SHeiko Schocher CONFIG_MTD_UBI_BEB_LIMIT 3464ff94bc40SHeiko Schocher This option specifies the maximum bad physical eraseblocks UBI 3465ff94bc40SHeiko Schocher expects on the MTD device (per 1024 eraseblocks). If the 3466ff94bc40SHeiko Schocher underlying flash does not admit of bad eraseblocks (e.g. NOR 3467ff94bc40SHeiko Schocher flash), this value is ignored. 3468ff94bc40SHeiko Schocher 3469ff94bc40SHeiko Schocher NAND datasheets often specify the minimum and maximum NVM 3470ff94bc40SHeiko Schocher (Number of Valid Blocks) for the flashes' endurance lifetime. 3471ff94bc40SHeiko Schocher The maximum expected bad eraseblocks per 1024 eraseblocks 3472ff94bc40SHeiko Schocher then can be calculated as "1024 * (1 - MinNVB / MaxNVB)", 3473ff94bc40SHeiko Schocher which gives 20 for most NANDs (MaxNVB is basically the total 3474ff94bc40SHeiko Schocher count of eraseblocks on the chip). 3475ff94bc40SHeiko Schocher 3476ff94bc40SHeiko Schocher To put it differently, if this value is 20, UBI will try to 3477ff94bc40SHeiko Schocher reserve about 1.9% of physical eraseblocks for bad blocks 3478ff94bc40SHeiko Schocher handling. And that will be 1.9% of eraseblocks on the entire 3479ff94bc40SHeiko Schocher NAND chip, not just the MTD partition UBI attaches. This means 3480ff94bc40SHeiko Schocher that if you have, say, a NAND flash chip admits maximum 40 bad 3481ff94bc40SHeiko Schocher eraseblocks, and it is split on two MTD partitions of the same 3482ff94bc40SHeiko Schocher size, UBI will reserve 40 eraseblocks when attaching a 3483ff94bc40SHeiko Schocher partition. 3484ff94bc40SHeiko Schocher 3485ff94bc40SHeiko Schocher default: 20 3486ff94bc40SHeiko Schocher 3487ff94bc40SHeiko Schocher CONFIG_MTD_UBI_FASTMAP 3488ff94bc40SHeiko Schocher Fastmap is a mechanism which allows attaching an UBI device 3489ff94bc40SHeiko Schocher in nearly constant time. Instead of scanning the whole MTD device it 3490ff94bc40SHeiko Schocher only has to locate a checkpoint (called fastmap) on the device. 3491ff94bc40SHeiko Schocher The on-flash fastmap contains all information needed to attach 3492ff94bc40SHeiko Schocher the device. Using fastmap makes only sense on large devices where 3493ff94bc40SHeiko Schocher attaching by scanning takes long. UBI will not automatically install 3494ff94bc40SHeiko Schocher a fastmap on old images, but you can set the UBI parameter 3495ff94bc40SHeiko Schocher CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note 3496ff94bc40SHeiko Schocher that fastmap-enabled images are still usable with UBI implementations 3497ff94bc40SHeiko Schocher without fastmap support. On typical flash devices the whole fastmap 3498ff94bc40SHeiko Schocher fits into one PEB. UBI will reserve PEBs to hold two fastmaps. 3499ff94bc40SHeiko Schocher 3500ff94bc40SHeiko Schocher CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT 3501ff94bc40SHeiko Schocher Set this parameter to enable fastmap automatically on images 3502ff94bc40SHeiko Schocher without a fastmap. 3503ff94bc40SHeiko Schocher default: 0 3504ff94bc40SHeiko Schocher 350570c219cdSJoe Hershberger- UBIFS support 350670c219cdSJoe Hershberger CONFIG_CMD_UBIFS 350770c219cdSJoe Hershberger 350870c219cdSJoe Hershberger Adds commands for interacting with UBI volumes formatted as 350970c219cdSJoe Hershberger UBIFS. UBIFS is read-only in u-boot. 351070c219cdSJoe Hershberger 351170c219cdSJoe Hershberger Requires UBI support as well as CONFIG_LZO 351270c219cdSJoe Hershberger 3513147162daSJoe Hershberger CONFIG_UBIFS_SILENCE_MSG 3514147162daSJoe Hershberger 3515147162daSJoe Hershberger Make the verbose messages from UBIFS stop printing. This leaves 3516147162daSJoe Hershberger warnings and errors enabled. 3517147162daSJoe Hershberger 35186a11cf48SDaniel Schwierzeck- SPL framework 35196a11cf48SDaniel Schwierzeck CONFIG_SPL 35206a11cf48SDaniel Schwierzeck Enable building of SPL globally. 35216a11cf48SDaniel Schwierzeck 352295579793STom Rini CONFIG_SPL_LDSCRIPT 352395579793STom Rini LDSCRIPT for linking the SPL binary. 352495579793STom Rini 35256ebc3461SAlbert ARIBAUD CONFIG_SPL_MAX_FOOTPRINT 35266ebc3461SAlbert ARIBAUD Maximum size in memory allocated to the SPL, BSS included. 35276ebc3461SAlbert ARIBAUD When defined, the linker checks that the actual memory 35286ebc3461SAlbert ARIBAUD used by SPL from _start to __bss_end does not exceed it. 35298960af8bSAlbert ARIBAUD CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE 35306ebc3461SAlbert ARIBAUD must not be both defined at the same time. 35316ebc3461SAlbert ARIBAUD 353295579793STom Rini CONFIG_SPL_MAX_SIZE 35336ebc3461SAlbert ARIBAUD Maximum size of the SPL image (text, data, rodata, and 35346ebc3461SAlbert ARIBAUD linker lists sections), BSS excluded. 35356ebc3461SAlbert ARIBAUD When defined, the linker checks that the actual size does 35366ebc3461SAlbert ARIBAUD not exceed it. 353795579793STom Rini 35386a11cf48SDaniel Schwierzeck CONFIG_SPL_TEXT_BASE 35396a11cf48SDaniel Schwierzeck TEXT_BASE for linking the SPL binary. 35406a11cf48SDaniel Schwierzeck 354194a45bb1SScott Wood CONFIG_SPL_RELOC_TEXT_BASE 354294a45bb1SScott Wood Address to relocate to. If unspecified, this is equal to 354394a45bb1SScott Wood CONFIG_SPL_TEXT_BASE (i.e. no relocation is done). 354494a45bb1SScott Wood 354595579793STom Rini CONFIG_SPL_BSS_START_ADDR 354695579793STom Rini Link address for the BSS within the SPL binary. 354795579793STom Rini 354895579793STom Rini CONFIG_SPL_BSS_MAX_SIZE 35496ebc3461SAlbert ARIBAUD Maximum size in memory allocated to the SPL BSS. 35506ebc3461SAlbert ARIBAUD When defined, the linker checks that the actual memory used 35516ebc3461SAlbert ARIBAUD by SPL from __bss_start to __bss_end does not exceed it. 35528960af8bSAlbert ARIBAUD CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE 35536ebc3461SAlbert ARIBAUD must not be both defined at the same time. 355495579793STom Rini 355595579793STom Rini CONFIG_SPL_STACK 355695579793STom Rini Adress of the start of the stack SPL will use 355795579793STom Rini 35588c80eb3bSAlbert ARIBAUD \(3ADEV\) CONFIG_SPL_PANIC_ON_RAW_IMAGE 35598c80eb3bSAlbert ARIBAUD \(3ADEV\) When defined, SPL will panic() if the image it has 35608c80eb3bSAlbert ARIBAUD \(3ADEV\) loaded does not have a signature. 35618c80eb3bSAlbert ARIBAUD \(3ADEV\) Defining this is useful when code which loads images 35628c80eb3bSAlbert ARIBAUD \(3ADEV\) in SPL cannot guarantee that absolutely all read errors 35638c80eb3bSAlbert ARIBAUD \(3ADEV\) will be caught. 35648c80eb3bSAlbert ARIBAUD \(3ADEV\) An example is the LPC32XX MLC NAND driver, which will 35658c80eb3bSAlbert ARIBAUD \(3ADEV\) consider that a completely unreadable NAND block is bad, 35668c80eb3bSAlbert ARIBAUD \(3ADEV\) and thus should be skipped silently. 35678c80eb3bSAlbert ARIBAUD \(3ADEV\) 356894a45bb1SScott Wood CONFIG_SPL_RELOC_STACK 356994a45bb1SScott Wood Adress of the start of the stack SPL will use after 357094a45bb1SScott Wood relocation. If unspecified, this is equal to 357194a45bb1SScott Wood CONFIG_SPL_STACK. 357294a45bb1SScott Wood 357395579793STom Rini CONFIG_SYS_SPL_MALLOC_START 357495579793STom Rini Starting address of the malloc pool used in SPL. 357595579793STom Rini 357695579793STom Rini CONFIG_SYS_SPL_MALLOC_SIZE 357795579793STom Rini The size of the malloc pool used in SPL. 35786a11cf48SDaniel Schwierzeck 357947f7bcaeSTom Rini CONFIG_SPL_FRAMEWORK 358047f7bcaeSTom Rini Enable the SPL framework under common/. This framework 358147f7bcaeSTom Rini supports MMC, NAND and YMODEM loading of U-Boot and NAND 358247f7bcaeSTom Rini NAND loading of the Linux Kernel. 358347f7bcaeSTom Rini 35849607faf2STom Rini CONFIG_SPL_OS_BOOT 35859607faf2STom Rini Enable booting directly to an OS from SPL. 35869607faf2STom Rini See also: doc/README.falcon 35879607faf2STom Rini 3588861a86f4STom Rini CONFIG_SPL_DISPLAY_PRINT 3589861a86f4STom Rini For ARM, enable an optional function to print more information 3590861a86f4STom Rini about the running system. 3591861a86f4STom Rini 35924b919725SScott Wood CONFIG_SPL_INIT_MINIMAL 35934b919725SScott Wood Arch init code should be built for a very small image 35944b919725SScott Wood 35956a11cf48SDaniel Schwierzeck CONFIG_SPL_LIBCOMMON_SUPPORT 35966a11cf48SDaniel Schwierzeck Support for common/libcommon.o in SPL binary 35976a11cf48SDaniel Schwierzeck 35986a11cf48SDaniel Schwierzeck CONFIG_SPL_LIBDISK_SUPPORT 35996a11cf48SDaniel Schwierzeck Support for disk/libdisk.o in SPL binary 36006a11cf48SDaniel Schwierzeck 36016a11cf48SDaniel Schwierzeck CONFIG_SPL_I2C_SUPPORT 36026a11cf48SDaniel Schwierzeck Support for drivers/i2c/libi2c.o in SPL binary 36036a11cf48SDaniel Schwierzeck 36046a11cf48SDaniel Schwierzeck CONFIG_SPL_GPIO_SUPPORT 36056a11cf48SDaniel Schwierzeck Support for drivers/gpio/libgpio.o in SPL binary 36066a11cf48SDaniel Schwierzeck 36076a11cf48SDaniel Schwierzeck CONFIG_SPL_MMC_SUPPORT 36086a11cf48SDaniel Schwierzeck Support for drivers/mmc/libmmc.o in SPL binary 36096a11cf48SDaniel Schwierzeck 361095579793STom Rini CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR, 361195579793STom Rini CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS, 3612e2ccdf89SPaul Kocialkowski Address and partition on the MMC to load U-Boot from 361395579793STom Rini when the MMC is being used in raw mode. 361495579793STom Rini 3615b97300b6SPaul Kocialkowski CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION 3616b97300b6SPaul Kocialkowski Partition on the MMC to load U-Boot from when the MMC is being 3617b97300b6SPaul Kocialkowski used in raw mode 3618b97300b6SPaul Kocialkowski 36192b75b0adSPeter Korsgaard CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR 36202b75b0adSPeter Korsgaard Sector to load kernel uImage from when MMC is being 36212b75b0adSPeter Korsgaard used in raw mode (for Falcon mode) 36222b75b0adSPeter Korsgaard 36232b75b0adSPeter Korsgaard CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR, 36242b75b0adSPeter Korsgaard CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS 36252b75b0adSPeter Korsgaard Sector and number of sectors to load kernel argument 36262b75b0adSPeter Korsgaard parameters from when MMC is being used in raw mode 36272b75b0adSPeter Korsgaard (for falcon mode) 36282b75b0adSPeter Korsgaard 3629e2ccdf89SPaul Kocialkowski CONFIG_SYS_MMCSD_FS_BOOT_PARTITION 3630e2ccdf89SPaul Kocialkowski Partition on the MMC to load U-Boot from when the MMC is being 3631e2ccdf89SPaul Kocialkowski used in fs mode 3632e2ccdf89SPaul Kocialkowski 363395579793STom Rini CONFIG_SPL_FAT_SUPPORT 363495579793STom Rini Support for fs/fat/libfat.o in SPL binary 363595579793STom Rini 3636fae81c72SGuillaume GARDET CONFIG_SPL_EXT_SUPPORT 3637fae81c72SGuillaume GARDET Support for EXT filesystem in SPL binary 363895579793STom Rini 3639fae81c72SGuillaume GARDET CONFIG_SPL_FS_LOAD_PAYLOAD_NAME 3640fae81c72SGuillaume GARDET Filename to read to load U-Boot when reading from filesystem 3641fae81c72SGuillaume GARDET 3642fae81c72SGuillaume GARDET CONFIG_SPL_FS_LOAD_KERNEL_NAME 36437ad2cc79SPeter Korsgaard Filename to read to load kernel uImage when reading 3644fae81c72SGuillaume GARDET from filesystem (for Falcon mode) 36457ad2cc79SPeter Korsgaard 3646fae81c72SGuillaume GARDET CONFIG_SPL_FS_LOAD_ARGS_NAME 36477ad2cc79SPeter Korsgaard Filename to read to load kernel argument parameters 3648fae81c72SGuillaume GARDET when reading from filesystem (for Falcon mode) 36497ad2cc79SPeter Korsgaard 365006f60ae3SScott Wood CONFIG_SPL_MPC83XX_WAIT_FOR_NAND 365106f60ae3SScott Wood Set this for NAND SPL on PPC mpc83xx targets, so that 365206f60ae3SScott Wood start.S waits for the rest of the SPL to load before 365306f60ae3SScott Wood continuing (the hardware starts execution after just 365406f60ae3SScott Wood loading the first page rather than the full 4K). 365506f60ae3SScott Wood 3656651fcf60SPrabhakar Kushwaha CONFIG_SPL_SKIP_RELOCATE 3657651fcf60SPrabhakar Kushwaha Avoid SPL relocation 3658651fcf60SPrabhakar Kushwaha 36596f2f01b9SScott Wood CONFIG_SPL_NAND_BASE 36606f2f01b9SScott Wood Include nand_base.c in the SPL. Requires 36616f2f01b9SScott Wood CONFIG_SPL_NAND_DRIVERS. 36626f2f01b9SScott Wood 36636f2f01b9SScott Wood CONFIG_SPL_NAND_DRIVERS 36646f2f01b9SScott Wood SPL uses normal NAND drivers, not minimal drivers. 36656f2f01b9SScott Wood 36666f2f01b9SScott Wood CONFIG_SPL_NAND_ECC 36676f2f01b9SScott Wood Include standard software ECC in the SPL 36686f2f01b9SScott Wood 366995579793STom Rini CONFIG_SPL_NAND_SIMPLE 36707d4b7955SScott Wood Support for NAND boot using simple NAND drivers that 36717d4b7955SScott Wood expose the cmd_ctrl() interface. 367295579793STom Rini 36736dd3b566STom Rini CONFIG_SPL_MTD_SUPPORT 36746dd3b566STom Rini Support for the MTD subsystem within SPL. Useful for 36756dd3b566STom Rini environment on NAND support within SPL. 36766dd3b566STom Rini 36770c3117b1SHeiko Schocher CONFIG_SPL_NAND_RAW_ONLY 36780c3117b1SHeiko Schocher Support to boot only raw u-boot.bin images. Use this only 36790c3117b1SHeiko Schocher if you need to save space. 36800c3117b1SHeiko Schocher 3681bb0dc108SYing Zhang CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT 3682bb0dc108SYing Zhang Set for the SPL on PPC mpc8xxx targets, support for 36835614e71bSYork Sun drivers/ddr/fsl/libddr.o in SPL binary. 3684bb0dc108SYing Zhang 36857c8eea59SYing Zhang CONFIG_SPL_COMMON_INIT_DDR 36867c8eea59SYing Zhang Set for common ddr init with serial presence detect in 36877c8eea59SYing Zhang SPL binary. 36887c8eea59SYing Zhang 368995579793STom Rini CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT, 369095579793STom Rini CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE, 369195579793STom Rini CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS, 369295579793STom Rini CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE, 369395579793STom Rini CONFIG_SYS_NAND_ECCBYTES 369495579793STom Rini Defines the size and behavior of the NAND that SPL uses 36957d4b7955SScott Wood to read U-Boot 369695579793STom Rini 3697fbe76ae4SPrabhakar Kushwaha CONFIG_SPL_NAND_BOOT 3698fbe76ae4SPrabhakar Kushwaha Add support NAND boot 3699fbe76ae4SPrabhakar Kushwaha 370095579793STom Rini CONFIG_SYS_NAND_U_BOOT_OFFS 37017d4b7955SScott Wood Location in NAND to read U-Boot from 37027d4b7955SScott Wood 37037d4b7955SScott Wood CONFIG_SYS_NAND_U_BOOT_DST 37047d4b7955SScott Wood Location in memory to load U-Boot to 37057d4b7955SScott Wood 37067d4b7955SScott Wood CONFIG_SYS_NAND_U_BOOT_SIZE 37077d4b7955SScott Wood Size of image to load 370895579793STom Rini 370995579793STom Rini CONFIG_SYS_NAND_U_BOOT_START 37107d4b7955SScott Wood Entry point in loaded image to jump to 371195579793STom Rini 371295579793STom Rini CONFIG_SYS_NAND_HW_ECC_OOBFIRST 371395579793STom Rini Define this if you need to first read the OOB and then the 3714b445bbb4SJeremiah Mahler data. This is used, for example, on davinci platforms. 371595579793STom Rini 371695579793STom Rini CONFIG_SPL_OMAP3_ID_NAND 371795579793STom Rini Support for an OMAP3-specific set of functions to return the 371895579793STom Rini ID and MFR of the first attached NAND chip, if present. 371995579793STom Rini 37206a11cf48SDaniel Schwierzeck CONFIG_SPL_SERIAL_SUPPORT 37216a11cf48SDaniel Schwierzeck Support for drivers/serial/libserial.o in SPL binary 37226a11cf48SDaniel Schwierzeck 37236a11cf48SDaniel Schwierzeck CONFIG_SPL_SPI_FLASH_SUPPORT 37246a11cf48SDaniel Schwierzeck Support for drivers/mtd/spi/libspi_flash.o in SPL binary 37256a11cf48SDaniel Schwierzeck 37266a11cf48SDaniel Schwierzeck CONFIG_SPL_SPI_SUPPORT 37276a11cf48SDaniel Schwierzeck Support for drivers/spi/libspi.o in SPL binary 37286a11cf48SDaniel Schwierzeck 3729c57b953dSPavel Machek CONFIG_SPL_RAM_DEVICE 3730c57b953dSPavel Machek Support for running image already present in ram, in SPL binary 3731c57b953dSPavel Machek 37326a11cf48SDaniel Schwierzeck CONFIG_SPL_LIBGENERIC_SUPPORT 37336a11cf48SDaniel Schwierzeck Support for lib/libgeneric.o in SPL binary 37341372cce2SMarian Balakowicz 3735ba1bee43SYing Zhang CONFIG_SPL_ENV_SUPPORT 3736ba1bee43SYing Zhang Support for the environment operating in SPL binary 3737ba1bee43SYing Zhang 3738ba1bee43SYing Zhang CONFIG_SPL_NET_SUPPORT 3739ba1bee43SYing Zhang Support for the net/libnet.o in SPL binary. 3740ba1bee43SYing Zhang It conflicts with SPL env from storage medium specified by 3741ba1bee43SYing Zhang CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE 3742ba1bee43SYing Zhang 374374752baaSScott Wood CONFIG_SPL_PAD_TO 37446113d3f2SBenoît Thébaudeau Image offset to which the SPL should be padded before appending 37456113d3f2SBenoît Thébaudeau the SPL payload. By default, this is defined as 37466113d3f2SBenoît Thébaudeau CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined. 37476113d3f2SBenoît Thébaudeau CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL 37486113d3f2SBenoît Thébaudeau payload without any padding, or >= CONFIG_SPL_MAX_SIZE. 374974752baaSScott Wood 3750ca2fca22SScott Wood CONFIG_SPL_TARGET 3751ca2fca22SScott Wood Final target image containing SPL and payload. Some SPLs 3752ca2fca22SScott Wood use an arch-specific makefile fragment instead, for 3753ca2fca22SScott Wood example if more than one image needs to be produced. 3754ca2fca22SScott Wood 375587ebee39SSimon Glass CONFIG_FIT_SPL_PRINT 375687ebee39SSimon Glass Printing information about a FIT image adds quite a bit of 375787ebee39SSimon Glass code to SPL. So this is normally disabled in SPL. Use this 375887ebee39SSimon Glass option to re-enable it. This will affect the output of the 375987ebee39SSimon Glass bootm command when booting a FIT image. 376087ebee39SSimon Glass 37613aa29de0SYing Zhang- TPL framework 37623aa29de0SYing Zhang CONFIG_TPL 37633aa29de0SYing Zhang Enable building of TPL globally. 37643aa29de0SYing Zhang 37653aa29de0SYing Zhang CONFIG_TPL_PAD_TO 37663aa29de0SYing Zhang Image offset to which the TPL should be padded before appending 37673aa29de0SYing Zhang the TPL payload. By default, this is defined as 37683aa29de0SYing Zhang CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined. 37693aa29de0SYing Zhang CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL 37703aa29de0SYing Zhang payload without any padding, or >= CONFIG_SPL_MAX_SIZE. 37713aa29de0SYing Zhang 3772c609719bSwdenkModem Support: 3773c609719bSwdenk-------------- 3774c609719bSwdenk 3775566e5cf4SWolfgang Denk[so far only for SMDK2400 boards] 3776c609719bSwdenk 377711ccc33fSMarcel Ziswiler- Modem support enable: 3778c609719bSwdenk CONFIG_MODEM_SUPPORT 3779c609719bSwdenk 3780c609719bSwdenk- RTS/CTS Flow control enable: 3781c609719bSwdenk CONFIG_HWFLOW 3782c609719bSwdenk 3783c609719bSwdenk- Modem debug support: 3784c609719bSwdenk CONFIG_MODEM_SUPPORT_DEBUG 3785c609719bSwdenk 3786c609719bSwdenk Enables debugging stuff (char screen[1024], dbg()) 3787c609719bSwdenk for modem support. Useful only with BDI2000. 3788c609719bSwdenk 3789a8c7c708Swdenk- Interrupt support (PPC): 3790a8c7c708Swdenk 3791a8c7c708Swdenk There are common interrupt_init() and timer_interrupt() 3792a8c7c708Swdenk for all PPC archs. interrupt_init() calls interrupt_init_cpu() 379311ccc33fSMarcel Ziswiler for CPU specific initialization. interrupt_init_cpu() 3794a8c7c708Swdenk should set decrementer_count to appropriate value. If 379511ccc33fSMarcel Ziswiler CPU resets decrementer automatically after interrupt 3796a8c7c708Swdenk (ppc4xx) it should set decrementer_count to zero. 379711ccc33fSMarcel Ziswiler timer_interrupt() calls timer_interrupt_cpu() for CPU 3798a8c7c708Swdenk specific handling. If board has watchdog / status_led 3799a8c7c708Swdenk / other_activity_monitor it works automatically from 3800a8c7c708Swdenk general timer_interrupt(). 3801a8c7c708Swdenk 3802c609719bSwdenk- General: 3803c609719bSwdenk 3804c609719bSwdenk In the target system modem support is enabled when a 3805c609719bSwdenk specific key (key combination) is pressed during 3806c609719bSwdenk power-on. Otherwise U-Boot will boot normally 380711ccc33fSMarcel Ziswiler (autoboot). The key_pressed() function is called from 3808c609719bSwdenk board_init(). Currently key_pressed() is a dummy 3809c609719bSwdenk function, returning 1 and thus enabling modem 3810c609719bSwdenk initialization. 3811c609719bSwdenk 3812c609719bSwdenk If there are no modem init strings in the 3813c609719bSwdenk environment, U-Boot proceed to autoboot; the 3814c609719bSwdenk previous output (banner, info printfs) will be 381511ccc33fSMarcel Ziswiler suppressed, though. 3816c609719bSwdenk 3817c609719bSwdenk See also: doc/README.Modem 3818c609719bSwdenk 38199660e442SHelmut RaigerBoard initialization settings: 38209660e442SHelmut Raiger------------------------------ 38219660e442SHelmut Raiger 38229660e442SHelmut RaigerDuring Initialization u-boot calls a number of board specific functions 38239660e442SHelmut Raigerto allow the preparation of board specific prerequisites, e.g. pin setup 38249660e442SHelmut Raigerbefore drivers are initialized. To enable these callbacks the 38259660e442SHelmut Raigerfollowing configuration macros have to be defined. Currently this is 38269660e442SHelmut Raigerarchitecture specific, so please check arch/your_architecture/lib/board.c 38279660e442SHelmut Raigertypically in board_init_f() and board_init_r(). 38289660e442SHelmut Raiger 38299660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f() 38309660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r() 38319660e442SHelmut Raiger- CONFIG_BOARD_LATE_INIT: Call board_late_init() 38329660e442SHelmut Raiger- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init() 3833c609719bSwdenk 3834c609719bSwdenkConfiguration Settings: 3835c609719bSwdenk----------------------- 3836c609719bSwdenk 38374d1fd7f1SYork Sun- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit. 38384d1fd7f1SYork Sun Optionally it can be defined to support 64-bit memory commands. 38394d1fd7f1SYork Sun 38406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included; 3841c609719bSwdenk undefine this when you're short of memory. 3842c609719bSwdenk 38432fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default 38442fb2604dSPeter Tyser width of the commands listed in the 'help' command output. 38452fb2604dSPeter Tyser 38466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to 3847c609719bSwdenk prompt for user input. 3848c609719bSwdenk 38496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE: Buffer size for input from the Console 3850c609719bSwdenk 38516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE: Buffer size for Console output 3852c609719bSwdenk 38536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands 3854c609719bSwdenk 38556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to 3856c609719bSwdenk the application (usually a Linux kernel) when it is 3857c609719bSwdenk booted 3858c609719bSwdenk 38596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE: 3860c609719bSwdenk List of legal baudrate settings for this board. 3861c609719bSwdenk 38626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET 3863c609719bSwdenk Suppress display of console information at boot. 3864c609719bSwdenk 38656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV 3866c609719bSwdenk If the board specific function 3867c609719bSwdenk extern int overwrite_console (void); 3868c609719bSwdenk returns 1, the stdin, stderr and stdout are switched to the 3869c609719bSwdenk serial port, else the settings in the environment are used. 3870c609719bSwdenk 38716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE 3872c609719bSwdenk Enable the call to overwrite_console(). 3873c609719bSwdenk 38746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE 3875c609719bSwdenk Enable overwrite of previous console environment settings. 3876c609719bSwdenk 38776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END: 3878c609719bSwdenk Begin and End addresses of the area used by the 3879c609719bSwdenk simple memory test. 3880c609719bSwdenk 38816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST: 3882c609719bSwdenk Enable an alternate, more extensive memory test. 3883c609719bSwdenk 38846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH: 38855f535fe1Swdenk Scratch address used by the alternate memory test 38865f535fe1Swdenk You only need to set this if address zero isn't writeable 38875f535fe1Swdenk 38886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only): 38896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header, 389014f73ca6SStefan Roese this specified memory area will get subtracted from the top 389111ccc33fSMarcel Ziswiler (end) of RAM and won't get "touched" at all by U-Boot. By 389214f73ca6SStefan Roese fixing up gd->ram_size the Linux kernel should gets passed 389314f73ca6SStefan Roese the now "corrected" memory size and won't touch it either. 389414f73ca6SStefan Roese This should work for arch/ppc and arch/powerpc. Only Linux 38955e12e75dSStefan Roese board ports in arch/powerpc with bootwrapper support that 389614f73ca6SStefan Roese recalculate the memory size from the SDRAM controller setup 38975e12e75dSStefan Roese will have to get fixed in Linux additionally. 389814f73ca6SStefan Roese 389914f73ca6SStefan Roese This option can be used as a workaround for the 440EPx/GRx 390014f73ca6SStefan Roese CHIP 11 errata where the last 256 bytes in SDRAM shouldn't 390114f73ca6SStefan Roese be touched. 390214f73ca6SStefan Roese 390314f73ca6SStefan Roese WARNING: Please make sure that this value is a multiple of 390414f73ca6SStefan Roese the Linux page size (normally 4k). If this is not the case, 390514f73ca6SStefan Roese then the end address of the Linux memory will be located at a 390614f73ca6SStefan Roese non page size aligned address and this could cause major 390714f73ca6SStefan Roese problems. 390814f73ca6SStefan Roese 39096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE: 3910c609719bSwdenk Enable temporary baudrate change while serial download 3911c609719bSwdenk 39126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE: 3913c609719bSwdenk Physical start address of SDRAM. _Must_ be 0 here. 3914c609719bSwdenk 39156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE: 3916c609719bSwdenk Physical start address of Motherboard I/O (if using a 3917c609719bSwdenk Cogent motherboard) 3918c609719bSwdenk 39196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE: 3920c609719bSwdenk Physical start address of Flash memory. 3921c609719bSwdenk 39226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE: 3923c609719bSwdenk Physical start address of boot monitor code (set by 3924c609719bSwdenk make config files to be same as the text base address 392514d0a02aSWolfgang Denk (CONFIG_SYS_TEXT_BASE) used when linking) - same as 39266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FLASH_BASE when booting from flash. 3927c609719bSwdenk 39286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN: 39293b57fe0aSwdenk Size of memory reserved for monitor code, used to 39303b57fe0aSwdenk determine _at_compile_time_ (!) if the environment is 39313b57fe0aSwdenk embedded within the U-Boot image, or in a separate 39323b57fe0aSwdenk flash sector. 3933c609719bSwdenk 39346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN: 3935c609719bSwdenk Size of DRAM reserved for malloc() use. 3936c609719bSwdenk 3937d59476b6SSimon Glass- CONFIG_SYS_MALLOC_F_LEN 3938d59476b6SSimon Glass Size of the malloc() pool for use before relocation. If 3939d59476b6SSimon Glass this is defined, then a very simple malloc() implementation 3940d59476b6SSimon Glass will become available before relocation. The address is just 3941d59476b6SSimon Glass below the global data, and the stack is moved down to make 3942d59476b6SSimon Glass space. 3943d59476b6SSimon Glass 3944d59476b6SSimon Glass This feature allocates regions with increasing addresses 3945d59476b6SSimon Glass within the region. calloc() is supported, but realloc() 3946d59476b6SSimon Glass is not available. free() is supported but does nothing. 3947b445bbb4SJeremiah Mahler The memory will be freed (or in fact just forgotten) when 3948d59476b6SSimon Glass U-Boot relocates itself. 3949d59476b6SSimon Glass 3950e7b14e9aSSimon Glass Pre-relocation malloc() is only supported on ARM and sandbox 395129afe9e6SSimon Glass at present but is fairly easy to enable for other archs. 395229afe9e6SSimon Glass 395338687ae6SSimon Glass- CONFIG_SYS_MALLOC_SIMPLE 395438687ae6SSimon Glass Provides a simple and small malloc() and calloc() for those 395538687ae6SSimon Glass boards which do not use the full malloc in SPL (which is 395638687ae6SSimon Glass enabled with CONFIG_SYS_SPL_MALLOC_START). 395738687ae6SSimon Glass 39581dfdd9baSThierry Reding- CONFIG_SYS_NONCACHED_MEMORY: 39591dfdd9baSThierry Reding Size of non-cached memory area. This area of memory will be 39601dfdd9baSThierry Reding typically located right below the malloc() area and mapped 39611dfdd9baSThierry Reding uncached in the MMU. This is useful for drivers that would 39621dfdd9baSThierry Reding otherwise require a lot of explicit cache maintenance. For 39631dfdd9baSThierry Reding some drivers it's also impossible to properly maintain the 39641dfdd9baSThierry Reding cache. For example if the regions that need to be flushed 39651dfdd9baSThierry Reding are not a multiple of the cache-line size, *and* padding 39661dfdd9baSThierry Reding cannot be allocated between the regions to align them (i.e. 39671dfdd9baSThierry Reding if the HW requires a contiguous array of regions, and the 39681dfdd9baSThierry Reding size of each region is not cache-aligned), then a flush of 39691dfdd9baSThierry Reding one region may result in overwriting data that hardware has 39701dfdd9baSThierry Reding written to another region in the same cache-line. This can 39711dfdd9baSThierry Reding happen for example in network drivers where descriptors for 39721dfdd9baSThierry Reding buffers are typically smaller than the CPU cache-line (e.g. 39731dfdd9baSThierry Reding 16 bytes vs. 32 or 64 bytes). 39741dfdd9baSThierry Reding 39751dfdd9baSThierry Reding Non-cached memory is only supported on 32-bit ARM at present. 39761dfdd9baSThierry Reding 39776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN: 397815940c9aSStefan Roese Normally compressed uImages are limited to an 397915940c9aSStefan Roese uncompressed size of 8 MBytes. If this is not enough, 39806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD you can define CONFIG_SYS_BOOTM_LEN in your board config file 398115940c9aSStefan Roese to adjust this setting to your needs. 3982c609719bSwdenk 39836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ: 3984c609719bSwdenk Maximum size of memory mapped by the startup code of 3985c609719bSwdenk the Linux kernel; all data that must be processed by 39867d721e34SBartlomiej Sieka the Linux kernel (bd_info, boot arguments, FDT blob if 39877d721e34SBartlomiej Sieka used) must be put below this limit, unless "bootm_low" 39881bce2aebSRobert P. J. Day environment variable is defined and non-zero. In such case 39897d721e34SBartlomiej Sieka all data for the Linux kernel must be between "bootm_low" 3990c3624e6eSGrant Likely and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment 3991c3624e6eSGrant Likely variable "bootm_mapsize" will override the value of 3992c3624e6eSGrant Likely CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined, 3993c3624e6eSGrant Likely then the value in "bootm_size" will be used instead. 3994c609719bSwdenk 3995fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH: 3996fca43cc8SJohn Rigby Enable initrd_high functionality. If defined then the 3997fca43cc8SJohn Rigby initrd_high feature is enabled and the bootm ramdisk subcommand 3998fca43cc8SJohn Rigby is enabled. 3999fca43cc8SJohn Rigby 4000fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE: 4001fca43cc8SJohn Rigby Enables allocating and saving kernel cmdline in space between 4002fca43cc8SJohn Rigby "bootm_low" and "bootm_low" + BOOTMAPSZ. 4003fca43cc8SJohn Rigby 4004fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD: 4005fca43cc8SJohn Rigby Enables allocating and saving a kernel copy of the bd_info in 4006fca43cc8SJohn Rigby space between "bootm_low" and "bootm_low" + BOOTMAPSZ. 4007fca43cc8SJohn Rigby 40086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS: 4009c609719bSwdenk Max number of Flash memory banks 4010c609719bSwdenk 40116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT: 4012c609719bSwdenk Max number of sectors on a Flash chip 4013c609719bSwdenk 40146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT: 4015c609719bSwdenk Timeout for Flash erase operations (in ms) 4016c609719bSwdenk 40176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT: 4018c609719bSwdenk Timeout for Flash write operations (in ms) 4019c609719bSwdenk 40206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT 40218564acf9Swdenk Timeout for Flash set sector lock bit operation (in ms) 40228564acf9Swdenk 40236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT 40248564acf9Swdenk Timeout for Flash clear lock bits operation (in ms) 40258564acf9Swdenk 40266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION 40278564acf9Swdenk If defined, hardware flash sectors protection is used 40288564acf9Swdenk instead of U-Boot software protection. 40298564acf9Swdenk 40306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP: 4031c609719bSwdenk 4032c609719bSwdenk Enable TFTP transfers directly to flash memory; 4033c609719bSwdenk without this option such a download has to be 4034c609719bSwdenk performed in two steps: (1) download to RAM, and (2) 4035c609719bSwdenk copy from RAM to flash. 4036c609719bSwdenk 4037c609719bSwdenk The two-step approach is usually more reliable, since 4038c609719bSwdenk you can check if the download worked before you erase 403911ccc33fSMarcel Ziswiler the flash, but in some situations (when system RAM is 404011ccc33fSMarcel Ziswiler too limited to allow for a temporary copy of the 4041c609719bSwdenk downloaded image) this option may be very useful. 4042c609719bSwdenk 40436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI: 4044c609719bSwdenk Define if the flash driver uses extra elements in the 40455653fc33Swdenk common flash structure for storing flash geometry. 40465653fc33Swdenk 404700b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER 40485653fc33Swdenk This option also enables the building of the cfi_flash driver 40495653fc33Swdenk in the drivers directory 405053cf9435Sstroese 405191809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD 405291809ed5SPiotr Ziecik This option enables the building of the cfi_mtd driver 405391809ed5SPiotr Ziecik in the drivers directory. The driver exports CFI flash 405491809ed5SPiotr Ziecik to the MTD layer. 405591809ed5SPiotr Ziecik 40566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE 405796ef831fSGuennadi Liakhovetski Use buffered writes to flash. 405896ef831fSGuennadi Liakhovetski 405996ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N 406096ef831fSGuennadi Liakhovetski s29ws-n MirrorBit flash has non-standard addresses for buffered 406196ef831fSGuennadi Liakhovetski write commands. 406296ef831fSGuennadi Liakhovetski 40636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST 40645568e613SStefan Roese If this option is defined, the common CFI flash doesn't 40655568e613SStefan Roese print it's warning upon not recognized FLASH banks. This 40665568e613SStefan Roese is useful, if some of the configured banks are only 40675568e613SStefan Roese optionally available. 40685568e613SStefan Roese 40699a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS 40709a042e9cSJerry Van Baren If defined (must be an integer), print out countdown 40719a042e9cSJerry Van Baren digits and dots. Recommended value: 45 (9..1) for 80 40729a042e9cSJerry Van Baren column displays, 15 (3..1) for 40 column displays. 40739a042e9cSJerry Van Baren 4074352ef3f1SStefan Roese- CONFIG_FLASH_VERIFY 4075352ef3f1SStefan Roese If defined, the content of the flash (destination) is compared 4076352ef3f1SStefan Roese against the source after the write operation. An error message 4077352ef3f1SStefan Roese will be printed when the contents are not identical. 4078352ef3f1SStefan Roese Please note that this option is useless in nearly all cases, 4079352ef3f1SStefan Roese since such flash programming errors usually are detected earlier 4080352ef3f1SStefan Roese while unprotecting/erasing/programming. Please only enable 4081352ef3f1SStefan Roese this option if you really know what you are doing. 4082352ef3f1SStefan Roese 40836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER: 408411ccc33fSMarcel Ziswiler Defines the number of Ethernet receive buffers. On some 408511ccc33fSMarcel Ziswiler Ethernet controllers it is recommended to set this value 408653cf9435Sstroese to 8 or even higher (EEPRO100 or 405 EMAC), since all 408753cf9435Sstroese buffers can be full shortly after enabling the interface 408811ccc33fSMarcel Ziswiler on high Ethernet traffic. 408953cf9435Sstroese Defaults to 4 if not defined. 4090c609719bSwdenk 4091ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES 4092ea882bafSWolfgang Denk 4093ea882bafSWolfgang Denk Maximum number of entries in the hash table that is used 4094ea882bafSWolfgang Denk internally to store the environment settings. The default 4095ea882bafSWolfgang Denk setting is supposed to be generous and should work in most 4096ea882bafSWolfgang Denk cases. This setting can be used to tune behaviour; see 4097ea882bafSWolfgang Denk lib/hashtable.c for details. 4098ea882bafSWolfgang Denk 40992598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_DEFAULT 41002598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_STATIC 41011bce2aebSRobert P. J. Day Enable validation of the values given to environment variables when 41022598090bSJoe Hershberger calling env set. Variables can be restricted to only decimal, 41032598090bSJoe Hershberger hexadecimal, or boolean. If CONFIG_CMD_NET is also defined, 41042598090bSJoe Hershberger the variables can also be restricted to IP address or MAC address. 41052598090bSJoe Hershberger 41062598090bSJoe Hershberger The format of the list is: 41072598090bSJoe Hershberger type_attribute = [s|d|x|b|i|m] 4108b445bbb4SJeremiah Mahler access_attribute = [a|r|o|c] 4109b445bbb4SJeremiah Mahler attributes = type_attribute[access_attribute] 41102598090bSJoe Hershberger entry = variable_name[:attributes] 41112598090bSJoe Hershberger list = entry[,list] 41122598090bSJoe Hershberger 41132598090bSJoe Hershberger The type attributes are: 41142598090bSJoe Hershberger s - String (default) 41152598090bSJoe Hershberger d - Decimal 41162598090bSJoe Hershberger x - Hexadecimal 41172598090bSJoe Hershberger b - Boolean ([1yYtT|0nNfF]) 41182598090bSJoe Hershberger i - IP address 41192598090bSJoe Hershberger m - MAC address 41202598090bSJoe Hershberger 4121267541f7SJoe Hershberger The access attributes are: 4122267541f7SJoe Hershberger a - Any (default) 4123267541f7SJoe Hershberger r - Read-only 4124267541f7SJoe Hershberger o - Write-once 4125267541f7SJoe Hershberger c - Change-default 4126267541f7SJoe Hershberger 41272598090bSJoe Hershberger - CONFIG_ENV_FLAGS_LIST_DEFAULT 41282598090bSJoe Hershberger Define this to a list (string) to define the ".flags" 4129b445bbb4SJeremiah Mahler environment variable in the default or embedded environment. 41302598090bSJoe Hershberger 41312598090bSJoe Hershberger - CONFIG_ENV_FLAGS_LIST_STATIC 41322598090bSJoe Hershberger Define this to a list (string) to define validation that 41332598090bSJoe Hershberger should be done if an entry is not found in the ".flags" 41342598090bSJoe Hershberger environment variable. To override a setting in the static 41352598090bSJoe Hershberger list, simply add an entry for the same variable name to the 41362598090bSJoe Hershberger ".flags" variable. 41372598090bSJoe Hershberger 4138bdf1fe4eSJoe Hershberger If CONFIG_REGEX is defined, the variable_name above is evaluated as a 4139bdf1fe4eSJoe Hershberger regular expression. This allows multiple variables to define the same 4140bdf1fe4eSJoe Hershberger flags without explicitly listing them for each variable. 4141bdf1fe4eSJoe Hershberger 4142267541f7SJoe Hershberger- CONFIG_ENV_ACCESS_IGNORE_FORCE 4143267541f7SJoe Hershberger If defined, don't allow the -f switch to env set override variable 4144267541f7SJoe Hershberger access flags. 4145267541f7SJoe Hershberger 41465c1a7ea6SSimon Glass- CONFIG_SYS_GENERIC_BOARD 41475c1a7ea6SSimon Glass This selects the architecture-generic board system instead of the 41485c1a7ea6SSimon Glass architecture-specific board files. It is intended to move boards 41495c1a7ea6SSimon Glass to this new framework over time. Defining this will disable the 41505c1a7ea6SSimon Glass arch/foo/lib/board.c file and use common/board_f.c and 41515c1a7ea6SSimon Glass common/board_r.c instead. To use this option your architecture 41520a12e687SMasahiro Yamada must support it (i.e. must select HAVE_GENERIC_BOARD in arch/Kconfig). 41530a12e687SMasahiro Yamada If you find problems enabling this option on your board please report 41540a12e687SMasahiro Yamada the problem and send patches! 41555c1a7ea6SSimon Glass 41560b1b60c7SLokesh Vutla- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only) 41570b1b60c7SLokesh Vutla This is set by OMAP boards for the max time that reset should 41580b1b60c7SLokesh Vutla be asserted. See doc/README.omap-reset-time for details on how 4159b445bbb4SJeremiah Mahler the value can be calculated on a given board. 4160632efa74SSimon Glass 41610d296cc2SGabe Black- CONFIG_USE_STDINT 41620d296cc2SGabe Black If stdint.h is available with your toolchain you can define this 41630d296cc2SGabe Black option to enable it. You can provide option 'USE_STDINT=1' when 41640d296cc2SGabe Black building U-Boot to enable this. 41650d296cc2SGabe Black 4166c609719bSwdenkThe following definitions that deal with the placement and management 4167c609719bSwdenkof environment data (variable area); in general, we support the 4168c609719bSwdenkfollowing configurations: 4169c609719bSwdenk 4170c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC: 4171c3eb3fe4SMike Frysinger 4172c3eb3fe4SMike Frysinger Builds up envcrc with the target environment so that external utils 4173c3eb3fe4SMike Frysinger may easily extract it and embed it in final U-Boot images. 4174c3eb3fe4SMike Frysinger 41755a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH: 4176c609719bSwdenk 4177c609719bSwdenk Define this if the environment is in flash memory. 4178c609719bSwdenk 4179c609719bSwdenk a) The environment occupies one whole flash sector, which is 4180c609719bSwdenk "embedded" in the text segment with the U-Boot code. This 4181c609719bSwdenk happens usually with "bottom boot sector" or "top boot 4182c609719bSwdenk sector" type flash chips, which have several smaller 4183c609719bSwdenk sectors at the start or the end. For instance, such a 4184c609719bSwdenk layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In 4185c609719bSwdenk such a case you would place the environment in one of the 4186c609719bSwdenk 4 kB sectors - with U-Boot code before and after it. With 4187c609719bSwdenk "top boot sector" type flash chips, you would put the 4188c609719bSwdenk environment in one of the last sectors, leaving a gap 4189c609719bSwdenk between U-Boot and the environment. 4190c609719bSwdenk 41910e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 4192c609719bSwdenk 4193c609719bSwdenk Offset of environment data (variable area) to the 4194c609719bSwdenk beginning of flash memory; for instance, with bottom boot 4195c609719bSwdenk type flash chips the second sector can be used: the offset 4196c609719bSwdenk for this sector is given here. 4197c609719bSwdenk 41986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE. 4199c609719bSwdenk 42000e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 4201c609719bSwdenk 4202c609719bSwdenk This is just another way to specify the start address of 4203c609719bSwdenk the flash sector containing the environment (instead of 42040e8d1586SJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_OFFSET). 4205c609719bSwdenk 42060e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SECT_SIZE: 4207c609719bSwdenk 4208c609719bSwdenk Size of the sector containing the environment. 4209c609719bSwdenk 4210c609719bSwdenk 4211c609719bSwdenk b) Sometimes flash chips have few, equal sized, BIG sectors. 4212c609719bSwdenk In such a case you don't want to spend a whole sector for 4213c609719bSwdenk the environment. 4214c609719bSwdenk 42150e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 4216c609719bSwdenk 42175a1aceb0SJean-Christophe PLAGNIOL-VILLARD If you use this in combination with CONFIG_ENV_IS_IN_FLASH 42180e8d1586SJean-Christophe PLAGNIOL-VILLARD and CONFIG_ENV_SECT_SIZE, you can specify to use only a part 4219c609719bSwdenk of this flash sector for the environment. This saves 4220c609719bSwdenk memory for the RAM copy of the environment. 4221c609719bSwdenk 4222c609719bSwdenk It may also save flash memory if you decide to use this 4223c609719bSwdenk when your environment is "embedded" within U-Boot code, 4224c609719bSwdenk since then the remainder of the flash sector could be used 4225c609719bSwdenk for U-Boot code. It should be pointed out that this is 4226c609719bSwdenk STRONGLY DISCOURAGED from a robustness point of view: 4227c609719bSwdenk updating the environment in flash makes it always 4228c609719bSwdenk necessary to erase the WHOLE sector. If something goes 4229c609719bSwdenk wrong before the contents has been restored from a copy in 4230c609719bSwdenk RAM, your target system will be dead. 4231c609719bSwdenk 42320e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR_REDUND 42330e8d1586SJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_SIZE_REDUND 4234c609719bSwdenk 4235c609719bSwdenk These settings describe a second storage area used to hold 423611ccc33fSMarcel Ziswiler a redundant copy of the environment data, so that there is 42373e38691eSwdenk a valid backup copy in case there is a power failure during 4238c609719bSwdenk a "saveenv" operation. 4239c609719bSwdenk 4240c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the 4241c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds* 4242c609719bSwdenkaccordingly! 4243c609719bSwdenk 4244c609719bSwdenk 42459314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM: 4246c609719bSwdenk 4247c609719bSwdenk Define this if you have some non-volatile memory device 4248c609719bSwdenk (NVRAM, battery buffered SRAM) which you want to use for the 4249c609719bSwdenk environment. 4250c609719bSwdenk 42510e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 42520e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 4253c609719bSwdenk 425411ccc33fSMarcel Ziswiler These two #defines are used to determine the memory area you 4255c609719bSwdenk want to use for environment. It is assumed that this memory 4256c609719bSwdenk can just be read and written to, without any special 4257c609719bSwdenk provision. 4258c609719bSwdenk 4259c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early 4260b445bbb4SJeremiah Mahlerin U-Boot initialization (when we try to get the setting of for the 426111ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or 4262c609719bSwdenkU-Boot will hang. 4263c609719bSwdenk 4264c609719bSwdenkPlease note that even with NVRAM we still use a copy of the 4265c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to 4266c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv" 4267c609719bSwdenkto save the current settings. 4268c609719bSwdenk 4269c609719bSwdenk 4270bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM: 4271c609719bSwdenk 4272c609719bSwdenk Use this if you have an EEPROM or similar serial access 4273c609719bSwdenk device and a driver for it. 4274c609719bSwdenk 42750e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 42760e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 4277c609719bSwdenk 4278c609719bSwdenk These two #defines specify the offset and size of the 4279c609719bSwdenk environment area within the total memory of your EEPROM. 4280c609719bSwdenk 42816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR: 4282c609719bSwdenk If defined, specified the chip address of the EEPROM device. 4283c609719bSwdenk The default address is zero. 4284c609719bSwdenk 4285189d257bSChristian Gmeiner - CONFIG_SYS_I2C_EEPROM_BUS: 4286189d257bSChristian Gmeiner If defined, specified the i2c bus of the EEPROM device. 4287189d257bSChristian Gmeiner 42886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS: 4289c609719bSwdenk If defined, the number of bits used to address bytes in a 4290c609719bSwdenk single page in the EEPROM device. A 64 byte page, for example 4291c609719bSwdenk would require six bits. 4292c609719bSwdenk 42936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS: 4294c609719bSwdenk If defined, the number of milliseconds to delay between 4295c609719bSwdenk page writes. The default is zero milliseconds. 4296c609719bSwdenk 42976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR_LEN: 4298c609719bSwdenk The length in bytes of the EEPROM memory array address. Note 4299c609719bSwdenk that this is NOT the chip address length! 4300c609719bSwdenk 43016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW: 43025cf91d6bSwdenk EEPROM chips that implement "address overflow" are ones 43035cf91d6bSwdenk like Catalyst 24WC04/08/16 which has 9/10/11 bits of 43045cf91d6bSwdenk address and the extra bits end up in the "chip address" bit 43055cf91d6bSwdenk slots. This makes a 24WC08 (1Kbyte) chip look like four 256 43065cf91d6bSwdenk byte chips. 43075cf91d6bSwdenk 43085cf91d6bSwdenk Note that we consider the length of the address field to 43095cf91d6bSwdenk still be one byte because the extra address bits are hidden 43105cf91d6bSwdenk in the chip address. 43115cf91d6bSwdenk 43126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_SIZE: 4313c609719bSwdenk The size in bytes of the EEPROM device. 4314c609719bSwdenk 4315548738b4SHeiko Schocher - CONFIG_ENV_EEPROM_IS_ON_I2C 4316548738b4SHeiko Schocher define this, if you have I2C and SPI activated, and your 4317548738b4SHeiko Schocher EEPROM, which holds the environment, is on the I2C bus. 4318548738b4SHeiko Schocher 4319548738b4SHeiko Schocher - CONFIG_I2C_ENV_EEPROM_BUS 4320548738b4SHeiko Schocher if you have an Environment on an EEPROM reached over 4321548738b4SHeiko Schocher I2C muxes, you can define here, how to reach this 4322548738b4SHeiko Schocher EEPROM. For example: 4323548738b4SHeiko Schocher 4324ea818dbbSHeiko Schocher #define CONFIG_I2C_ENV_EEPROM_BUS 1 4325548738b4SHeiko Schocher 4326548738b4SHeiko Schocher EEPROM which holds the environment, is reached over 4327548738b4SHeiko Schocher a pca9547 i2c mux with address 0x70, channel 3. 4328c609719bSwdenk 4329057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH: 43305779d8d9Swdenk 43315779d8d9Swdenk Define this if you have a DataFlash memory device which you 43325779d8d9Swdenk want to use for the environment. 43335779d8d9Swdenk 43340e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 43350e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 43360e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 43375779d8d9Swdenk 43385779d8d9Swdenk These three #defines specify the offset and size of the 43395779d8d9Swdenk environment area within the total memory of your DataFlash placed 43405779d8d9Swdenk at the specified address. 43415779d8d9Swdenk 4342bd83b592SWu, Josh- CONFIG_ENV_IS_IN_SPI_FLASH: 4343bd83b592SWu, Josh 4344bd83b592SWu, Josh Define this if you have a SPI Flash memory device which you 4345bd83b592SWu, Josh want to use for the environment. 4346bd83b592SWu, Josh 4347bd83b592SWu, Josh - CONFIG_ENV_OFFSET: 4348bd83b592SWu, Josh - CONFIG_ENV_SIZE: 4349bd83b592SWu, Josh 4350bd83b592SWu, Josh These two #defines specify the offset and size of the 4351bd83b592SWu, Josh environment area within the SPI Flash. CONFIG_ENV_OFFSET must be 4352bd83b592SWu, Josh aligned to an erase sector boundary. 4353bd83b592SWu, Josh 4354bd83b592SWu, Josh - CONFIG_ENV_SECT_SIZE: 4355bd83b592SWu, Josh 4356bd83b592SWu, Josh Define the SPI flash's sector size. 4357bd83b592SWu, Josh 4358bd83b592SWu, Josh - CONFIG_ENV_OFFSET_REDUND (optional): 4359bd83b592SWu, Josh 4360bd83b592SWu, Josh This setting describes a second storage area of CONFIG_ENV_SIZE 4361bd83b592SWu, Josh size used to hold a redundant copy of the environment data, so 4362bd83b592SWu, Josh that there is a valid backup copy in case there is a power failure 4363bd83b592SWu, Josh during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be 4364bd83b592SWu, Josh aligned to an erase sector boundary. 4365bd83b592SWu, Josh 4366bd83b592SWu, Josh - CONFIG_ENV_SPI_BUS (optional): 4367bd83b592SWu, Josh - CONFIG_ENV_SPI_CS (optional): 4368bd83b592SWu, Josh 4369bd83b592SWu, Josh Define the SPI bus and chip select. If not defined they will be 0. 4370bd83b592SWu, Josh 4371bd83b592SWu, Josh - CONFIG_ENV_SPI_MAX_HZ (optional): 4372bd83b592SWu, Josh 4373bd83b592SWu, Josh Define the SPI max work clock. If not defined then use 1MHz. 4374bd83b592SWu, Josh 4375bd83b592SWu, Josh - CONFIG_ENV_SPI_MODE (optional): 4376bd83b592SWu, Josh 4377bd83b592SWu, Josh Define the SPI work mode. If not defined then use SPI_MODE_3. 4378bd83b592SWu, Josh 43790a85a9e7SLiu Gang- CONFIG_ENV_IS_IN_REMOTE: 43800a85a9e7SLiu Gang 43810a85a9e7SLiu Gang Define this if you have a remote memory space which you 43820a85a9e7SLiu Gang want to use for the local device's environment. 43830a85a9e7SLiu Gang 43840a85a9e7SLiu Gang - CONFIG_ENV_ADDR: 43850a85a9e7SLiu Gang - CONFIG_ENV_SIZE: 43860a85a9e7SLiu Gang 43870a85a9e7SLiu Gang These two #defines specify the address and size of the 43880a85a9e7SLiu Gang environment area within the remote memory space. The 43890a85a9e7SLiu Gang local device can get the environment from remote memory 4390fc54c7faSLiu Gang space by SRIO or PCIE links. 43910a85a9e7SLiu Gang 43920a85a9e7SLiu GangBE CAREFUL! For some special cases, the local device can not use 43930a85a9e7SLiu Gang"saveenv" command. For example, the local device will get the 4394fc54c7faSLiu Gangenvironment stored in a remote NOR flash by SRIO or PCIE link, 4395fc54c7faSLiu Gangbut it can not erase, write this NOR flash by SRIO or PCIE interface. 43960a85a9e7SLiu Gang 439751bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND: 439813a5695bSwdenk 439913a5695bSwdenk Define this if you have a NAND device which you want to use 440013a5695bSwdenk for the environment. 440113a5695bSwdenk 44020e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 44030e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 440413a5695bSwdenk 440513a5695bSwdenk These two #defines specify the offset and size of the environment 4406fdd813deSScott Wood area within the first NAND device. CONFIG_ENV_OFFSET must be 4407fdd813deSScott Wood aligned to an erase block boundary. 44085779d8d9Swdenk 4409fdd813deSScott Wood - CONFIG_ENV_OFFSET_REDUND (optional): 4410e443c944SMarkus Klotzbuecher 44110e8d1586SJean-Christophe PLAGNIOL-VILLARD This setting describes a second storage area of CONFIG_ENV_SIZE 4412fdd813deSScott Wood size used to hold a redundant copy of the environment data, so 4413fdd813deSScott Wood that there is a valid backup copy in case there is a power failure 4414fdd813deSScott Wood during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be 4415fdd813deSScott Wood aligned to an erase block boundary. 4416e443c944SMarkus Klotzbuecher 4417fdd813deSScott Wood - CONFIG_ENV_RANGE (optional): 4418fdd813deSScott Wood 4419fdd813deSScott Wood Specifies the length of the region in which the environment 4420fdd813deSScott Wood can be written. This should be a multiple of the NAND device's 4421fdd813deSScott Wood block size. Specifying a range with more erase blocks than 4422fdd813deSScott Wood are needed to hold CONFIG_ENV_SIZE allows bad blocks within 4423fdd813deSScott Wood the range to be avoided. 4424fdd813deSScott Wood 4425fdd813deSScott Wood - CONFIG_ENV_OFFSET_OOB (optional): 4426fdd813deSScott Wood 4427fdd813deSScott Wood Enables support for dynamically retrieving the offset of the 4428fdd813deSScott Wood environment from block zero's out-of-band data. The 4429fdd813deSScott Wood "nand env.oob" command can be used to record this offset. 4430fdd813deSScott Wood Currently, CONFIG_ENV_OFFSET_REDUND is not supported when 4431fdd813deSScott Wood using CONFIG_ENV_OFFSET_OOB. 4432e443c944SMarkus Klotzbuecher 4433b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST 4434b74ab737SGuennadi Liakhovetski 4435b74ab737SGuennadi Liakhovetski Defines address in RAM to which the nand_spl code should copy the 4436b74ab737SGuennadi Liakhovetski environment. If redundant environment is used, it will be copied to 4437b74ab737SGuennadi Liakhovetski CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE. 4438b74ab737SGuennadi Liakhovetski 44392b74433fSJoe Hershberger- CONFIG_ENV_IS_IN_UBI: 44402b74433fSJoe Hershberger 44412b74433fSJoe Hershberger Define this if you have an UBI volume that you want to use for the 44422b74433fSJoe Hershberger environment. This has the benefit of wear-leveling the environment 44432b74433fSJoe Hershberger accesses, which is important on NAND. 44442b74433fSJoe Hershberger 44452b74433fSJoe Hershberger - CONFIG_ENV_UBI_PART: 44462b74433fSJoe Hershberger 44472b74433fSJoe Hershberger Define this to a string that is the mtd partition containing the UBI. 44482b74433fSJoe Hershberger 44492b74433fSJoe Hershberger - CONFIG_ENV_UBI_VOLUME: 44502b74433fSJoe Hershberger 44512b74433fSJoe Hershberger Define this to the name of the volume that you want to store the 44522b74433fSJoe Hershberger environment in. 44532b74433fSJoe Hershberger 4454785881f7SJoe Hershberger - CONFIG_ENV_UBI_VOLUME_REDUND: 4455785881f7SJoe Hershberger 4456785881f7SJoe Hershberger Define this to the name of another volume to store a second copy of 4457785881f7SJoe Hershberger the environment in. This will enable redundant environments in UBI. 4458785881f7SJoe Hershberger It is assumed that both volumes are in the same MTD partition. 4459785881f7SJoe Hershberger 44602b74433fSJoe Hershberger - CONFIG_UBI_SILENCE_MSG 44612b74433fSJoe Hershberger - CONFIG_UBIFS_SILENCE_MSG 44622b74433fSJoe Hershberger 44632b74433fSJoe Hershberger You will probably want to define these to avoid a really noisy system 44642b74433fSJoe Hershberger when storing the env in UBI. 44652b74433fSJoe Hershberger 4466d1db76f1SWu, Josh- CONFIG_ENV_IS_IN_FAT: 4467d1db76f1SWu, Josh Define this if you want to use the FAT file system for the environment. 4468d1db76f1SWu, Josh 4469d1db76f1SWu, Josh - FAT_ENV_INTERFACE: 4470d1db76f1SWu, Josh 4471d1db76f1SWu, Josh Define this to a string that is the name of the block device. 4472d1db76f1SWu, Josh 4473d1db76f1SWu, Josh - FAT_ENV_DEV_AND_PART: 4474d1db76f1SWu, Josh 4475d1db76f1SWu, Josh Define this to a string to specify the partition of the device. It can 4476d1db76f1SWu, Josh be as following: 4477d1db76f1SWu, Josh 4478d1db76f1SWu, Josh "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1) 4479d1db76f1SWu, Josh - "D:P": device D partition P. Error occurs if device D has no 4480d1db76f1SWu, Josh partition table. 4481d1db76f1SWu, Josh - "D:0": device D. 4482d1db76f1SWu, Josh - "D" or "D:": device D partition 1 if device D has partition 4483d1db76f1SWu, Josh table, or the whole device D if has no partition 4484d1db76f1SWu, Josh table. 4485d1db76f1SWu, Josh - "D:auto": first partition in device D with bootable flag set. 4486b445bbb4SJeremiah Mahler If none, first valid partition in device D. If no 4487d1db76f1SWu, Josh partition table then means device D. 4488d1db76f1SWu, Josh 4489d1db76f1SWu, Josh - FAT_ENV_FILE: 4490d1db76f1SWu, Josh 4491d1db76f1SWu, Josh It's a string of the FAT file name. This file use to store the 4492b445bbb4SJeremiah Mahler environment. 4493d1db76f1SWu, Josh 4494d1db76f1SWu, Josh - CONFIG_FAT_WRITE: 4495b445bbb4SJeremiah Mahler This should be defined. Otherwise it cannot save the environment file. 4496d1db76f1SWu, Josh 449706e4ae5fSStephen Warren- CONFIG_ENV_IS_IN_MMC: 449806e4ae5fSStephen Warren 449906e4ae5fSStephen Warren Define this if you have an MMC device which you want to use for the 450006e4ae5fSStephen Warren environment. 450106e4ae5fSStephen Warren 450206e4ae5fSStephen Warren - CONFIG_SYS_MMC_ENV_DEV: 450306e4ae5fSStephen Warren 450406e4ae5fSStephen Warren Specifies which MMC device the environment is stored in. 450506e4ae5fSStephen Warren 450606e4ae5fSStephen Warren - CONFIG_SYS_MMC_ENV_PART (optional): 450706e4ae5fSStephen Warren 450806e4ae5fSStephen Warren Specifies which MMC partition the environment is stored in. If not 450906e4ae5fSStephen Warren set, defaults to partition 0, the user area. Common values might be 451006e4ae5fSStephen Warren 1 (first MMC boot partition), 2 (second MMC boot partition). 451106e4ae5fSStephen Warren 451206e4ae5fSStephen Warren - CONFIG_ENV_OFFSET: 451306e4ae5fSStephen Warren - CONFIG_ENV_SIZE: 451406e4ae5fSStephen Warren 451506e4ae5fSStephen Warren These two #defines specify the offset and size of the environment 451606e4ae5fSStephen Warren area within the specified MMC device. 451706e4ae5fSStephen Warren 45185c088ee8SStephen Warren If offset is positive (the usual case), it is treated as relative to 45195c088ee8SStephen Warren the start of the MMC partition. If offset is negative, it is treated 45205c088ee8SStephen Warren as relative to the end of the MMC partition. This can be useful if 45215c088ee8SStephen Warren your board may be fitted with different MMC devices, which have 45225c088ee8SStephen Warren different sizes for the MMC partitions, and you always want the 45235c088ee8SStephen Warren environment placed at the very end of the partition, to leave the 45245c088ee8SStephen Warren maximum possible space before it, to store other data. 45255c088ee8SStephen Warren 452606e4ae5fSStephen Warren These two values are in units of bytes, but must be aligned to an 452706e4ae5fSStephen Warren MMC sector boundary. 452806e4ae5fSStephen Warren 452906e4ae5fSStephen Warren - CONFIG_ENV_OFFSET_REDUND (optional): 453006e4ae5fSStephen Warren 453106e4ae5fSStephen Warren Specifies a second storage area, of CONFIG_ENV_SIZE size, used to 453206e4ae5fSStephen Warren hold a redundant copy of the environment data. This provides a 453306e4ae5fSStephen Warren valid backup copy in case the other copy is corrupted, e.g. due 453406e4ae5fSStephen Warren to a power failure during a "saveenv" operation. 453506e4ae5fSStephen Warren 45365c088ee8SStephen Warren This value may also be positive or negative; this is handled in the 45375c088ee8SStephen Warren same way as CONFIG_ENV_OFFSET. 45385c088ee8SStephen Warren 453906e4ae5fSStephen Warren This value is also in units of bytes, but must also be aligned to 454006e4ae5fSStephen Warren an MMC sector boundary. 454106e4ae5fSStephen Warren 454206e4ae5fSStephen Warren - CONFIG_ENV_SIZE_REDUND (optional): 454306e4ae5fSStephen Warren 454406e4ae5fSStephen Warren This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is 454506e4ae5fSStephen Warren set. If this value is set, it must be set to the same value as 454606e4ae5fSStephen Warren CONFIG_ENV_SIZE. 454706e4ae5fSStephen Warren 45486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET 4549c609719bSwdenk 4550c609719bSwdenk Defines offset to the initial SPI buffer area in DPRAM. The 4551c609719bSwdenk area is used at an early stage (ROM part) if the environment 4552c609719bSwdenk is configured to reside in the SPI EEPROM: We need a 520 byte 4553c609719bSwdenk scratch DPRAM area. It is used between the two initialization 4554c609719bSwdenk calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems 4555c609719bSwdenk to be a good choice since it makes it far enough from the 4556c609719bSwdenk start of the data area as well as from the stack pointer. 4557c609719bSwdenk 4558e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor 4559c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been 4560cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f() 4561c609719bSwdenkuntil then to read environment variables. 4562c609719bSwdenk 456385ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor 456485ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working 456585ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is 456685ec0bccSwdenknecessary, because the first environment variable we need is the 456785ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't 456885ec0bccSwdenkhave any device yet where we could complain.] 4569c609719bSwdenk 4570c609719bSwdenkNote: once the monitor has been relocated, then it will complain if 4571c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you 457285ec0bccSwdenkuse the "saveenv" command to store a valid environment. 4573c609719bSwdenk 45746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN: 4575fc3e2165Swdenk Echo the inverted Ethernet link state to the fault LED. 4576fc3e2165Swdenk 45776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR 4578fc3e2165Swdenk also needs to be defined. 4579fc3e2165Swdenk 45806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR: 4581fc3e2165Swdenk MII address of the PHY to check for the Ethernet link state. 4582c609719bSwdenk 4583f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS: 4584f5675aa5SRon Madrid Define this if you desire to only have use of the NS16550_init 4585f5675aa5SRon Madrid and NS16550_putc functions for the serial driver located at 4586f5675aa5SRon Madrid drivers/serial/ns16550.c. This option is useful for saving 4587f5675aa5SRon Madrid space for already greatly restricted images, including but not 4588f5675aa5SRon Madrid limited to NAND_SPL configurations. 4589f5675aa5SRon Madrid 4590b2b92f53SSimon Glass- CONFIG_DISPLAY_BOARDINFO 4591b2b92f53SSimon Glass Display information about the board that U-Boot is running on 4592b2b92f53SSimon Glass when U-Boot starts up. The board function checkboard() is called 4593b2b92f53SSimon Glass to do this. 4594b2b92f53SSimon Glass 4595e2e3e2b1SSimon Glass- CONFIG_DISPLAY_BOARDINFO_LATE 4596e2e3e2b1SSimon Glass Similar to the previous option, but display this information 4597e2e3e2b1SSimon Glass later, once stdio is running and output goes to the LCD, if 4598e2e3e2b1SSimon Glass present. 4599e2e3e2b1SSimon Glass 4600feb85801SSascha Silbe- CONFIG_BOARD_SIZE_LIMIT: 4601feb85801SSascha Silbe Maximum size of the U-Boot image. When defined, the 4602feb85801SSascha Silbe build system checks that the actual size does not 4603feb85801SSascha Silbe exceed it. 4604feb85801SSascha Silbe 4605c609719bSwdenkLow Level (hardware related) configuration options: 4606dc7c9a1aSwdenk--------------------------------------------------- 4607c609719bSwdenk 46086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE: 4609c609719bSwdenk Cache Line Size of the CPU. 4610c609719bSwdenk 46116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR: 4612c609719bSwdenk Default address of the IMMR after system reset. 46132535d602Swdenk 46142535d602Swdenk Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU, 46152535d602Swdenk and RPXsuper) to be able to adjust the position of 46162535d602Swdenk the IMMR register after a reset. 4617c609719bSwdenk 4618e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT: 4619e46fedfeSTimur Tabi Default (power-on reset) physical address of CCSR on Freescale 4620e46fedfeSTimur Tabi PowerPC SOCs. 4621e46fedfeSTimur Tabi 4622e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR: 4623e46fedfeSTimur Tabi Virtual address of CCSR. On a 32-bit build, this is typically 4624e46fedfeSTimur Tabi the same value as CONFIG_SYS_CCSRBAR_DEFAULT. 4625e46fedfeSTimur Tabi 4626e46fedfeSTimur Tabi CONFIG_SYS_DEFAULT_IMMR must also be set to this value, 4627e46fedfeSTimur Tabi for cross-platform code that uses that macro instead. 4628e46fedfeSTimur Tabi 4629e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS: 4630e46fedfeSTimur Tabi Physical address of CCSR. CCSR can be relocated to a new 4631e46fedfeSTimur Tabi physical address, if desired. In this case, this macro should 4632e46fedfeSTimur Tabi be set to that address. Otherwise, it should be set to the 4633e46fedfeSTimur Tabi same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR 4634e46fedfeSTimur Tabi is typically relocated on 36-bit builds. It is recommended 4635e46fedfeSTimur Tabi that this macro be defined via the _HIGH and _LOW macros: 4636e46fedfeSTimur Tabi 4637e46fedfeSTimur Tabi #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH 4638e46fedfeSTimur Tabi * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW) 4639e46fedfeSTimur Tabi 4640e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH: 4641e46fedfeSTimur Tabi Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically 4642e46fedfeSTimur Tabi either 0 (32-bit build) or 0xF (36-bit build). This macro is 4643e46fedfeSTimur Tabi used in assembly code, so it must not contain typecasts or 4644e46fedfeSTimur Tabi integer size suffixes (e.g. "ULL"). 4645e46fedfeSTimur Tabi 4646e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW: 4647e46fedfeSTimur Tabi Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is 4648e46fedfeSTimur Tabi used in assembly code, so it must not contain typecasts or 4649e46fedfeSTimur Tabi integer size suffixes (e.g. "ULL"). 4650e46fedfeSTimur Tabi 4651e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE: 4652e46fedfeSTimur Tabi If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be 4653e46fedfeSTimur Tabi forced to a value that ensures that CCSR is not relocated. 4654e46fedfeSTimur Tabi 46557f6c2cbcSwdenk- Floppy Disk Support: 46566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FDC_DRIVE_NUMBER 46577f6c2cbcSwdenk 46587f6c2cbcSwdenk the default drive number (default value 0) 46597f6c2cbcSwdenk 46606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_ISA_IO_STRIDE 46617f6c2cbcSwdenk 466211ccc33fSMarcel Ziswiler defines the spacing between FDC chipset registers 46637f6c2cbcSwdenk (default value 1) 46647f6c2cbcSwdenk 46656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_ISA_IO_OFFSET 46667f6c2cbcSwdenk 46677f6c2cbcSwdenk defines the offset of register from address. It 46687f6c2cbcSwdenk depends on which part of the data bus is connected to 466911ccc33fSMarcel Ziswiler the FDC chipset. (default value 0) 46707f6c2cbcSwdenk 46716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and 46726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their 46737f6c2cbcSwdenk default value. 46747f6c2cbcSwdenk 46756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD if CONFIG_SYS_FDC_HW_INIT is defined, then the function 46767f6c2cbcSwdenk fdc_hw_init() is called at the beginning of the FDC 46777f6c2cbcSwdenk setup. fdc_hw_init() must be provided by the board 4678b445bbb4SJeremiah Mahler source code. It is used to make hardware-dependent 46797f6c2cbcSwdenk initializations. 46807f6c2cbcSwdenk 46810abddf82SMacpaul Lin- CONFIG_IDE_AHB: 46820abddf82SMacpaul Lin Most IDE controllers were designed to be connected with PCI 46830abddf82SMacpaul Lin interface. Only few of them were designed for AHB interface. 46840abddf82SMacpaul Lin When software is doing ATA command and data transfer to 46850abddf82SMacpaul Lin IDE devices through IDE-AHB controller, some additional 46860abddf82SMacpaul Lin registers accessing to these kind of IDE-AHB controller 4687b445bbb4SJeremiah Mahler is required. 46880abddf82SMacpaul Lin 46896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR: Physical address of the Internal Memory. 469025d6712aSwdenk DO NOT CHANGE unless you know exactly what you're 469125d6712aSwdenk doing! (11-4) [MPC8xx/82xx systems only] 4692c609719bSwdenk 46936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR: 4694c609719bSwdenk 46957152b1d0Swdenk Start address of memory area that can be used for 4696c609719bSwdenk initial data and stack; please note that this must be 4697c609719bSwdenk writable memory that is working WITHOUT special 4698c609719bSwdenk initialization, i. e. you CANNOT use normal RAM which 4699c609719bSwdenk will become available only after programming the 4700c609719bSwdenk memory controller and running certain initialization 4701c609719bSwdenk sequences. 4702c609719bSwdenk 4703c609719bSwdenk U-Boot uses the following memory types: 4704c609719bSwdenk - MPC8xx and MPC8260: IMMR (internal memory of the CPU) 4705c609719bSwdenk - MPC824X: data cache 4706c609719bSwdenk - PPC4xx: data cache 4707c609719bSwdenk 47086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET: 4709c609719bSwdenk 4710c609719bSwdenk Offset of the initial data structure in the memory 47116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually 47126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial 4713c609719bSwdenk data is located at the end of the available space 4714553f0982SWolfgang Denk (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE - 47156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just 47166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR + 47176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_GBL_DATA_OFFSET) downward. 4718c609719bSwdenk 4719c609719bSwdenk Note: 4720c609719bSwdenk On the MPC824X (or other systems that use the data 4721c609719bSwdenk cache for initial memory) the address chosen for 47226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must 4723c609719bSwdenk point to an otherwise UNUSED address space between 4724c609719bSwdenk the top of RAM and the start of the PCI space. 4725c609719bSwdenk 47266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6) 4727c609719bSwdenk 47286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR: System Protection Control (11-9) 4729c609719bSwdenk 47306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26) 4731c609719bSwdenk 47326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31) 4733c609719bSwdenk 47346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30) 4735c609719bSwdenk 47366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27) 4737c609719bSwdenk 47386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM: 4739c609719bSwdenk SDRAM timing 4740c609719bSwdenk 47416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA: 4742c609719bSwdenk periodic timer for refresh 4743c609719bSwdenk 47446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER: Debug Event Register (37-47) 4745c609719bSwdenk 47466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM, 47476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP, 47486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM, 47496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BR1_PRELIM: 4750c609719bSwdenk Memory Controller Definitions: BR0/1 and OR0/1 (FLASH) 4751c609719bSwdenk 4752c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE, 47536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM, 47546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM: 4755c609719bSwdenk Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM) 4756c609719bSwdenk 47576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K, 47586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL: 4759c609719bSwdenk Machine Mode Register and Memory Periodic Timer 4760c609719bSwdenk Prescaler definitions (SDRAM timing) 4761c609719bSwdenk 47626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]: 4763c609719bSwdenk enable I2C microcode relocation patch (MPC8xx); 4764c609719bSwdenk define relocation offset in DPRAM [DSP2] 4765c609719bSwdenk 47666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]: 4767b423d055SHeiko Schocher enable SMC microcode relocation patch (MPC8xx); 4768b423d055SHeiko Schocher define relocation offset in DPRAM [SMC1] 4769b423d055SHeiko Schocher 47706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]: 4771c609719bSwdenk enable SPI microcode relocation patch (MPC8xx); 4772c609719bSwdenk define relocation offset in DPRAM [SCC4] 4773c609719bSwdenk 47746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK: 4775c609719bSwdenk Use OSCM clock mode on MBX8xx board. Be careful, 4776c609719bSwdenk wrong setting might damage your board. Read 4777c609719bSwdenk doc/README.MBX before setting this variable! 4778c609719bSwdenk 47796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only) 4780ea909b76Swdenk Offset of the bootmode word in DPRAM used by post 4781ea909b76Swdenk (Power On Self Tests). This definition overrides 4782ea909b76Swdenk #define'd default value in commproc.h resp. 4783ea909b76Swdenk cpm_8260.h. 4784ea909b76Swdenk 47856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB, 47866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL, 47876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS, 47886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB, 47896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START, 47906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL, 47916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE, 47926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only) 4793a47a12beSStefan Roese Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set. 47945d232d0eSwdenk 47959cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE: 47969cacf4fcSDirk Eibach Disable PCI-Express on systems where it is supported but not 47979cacf4fcSDirk Eibach required. 47989cacf4fcSDirk Eibach 479969fd2d3bSAndrew Sharp- CONFIG_PCI_ENUM_ONLY 4800b445bbb4SJeremiah Mahler Only scan through and get the devices on the buses. 480169fd2d3bSAndrew Sharp Don't do any setup work, presumably because someone or 480269fd2d3bSAndrew Sharp something has already done it, and we don't need to do it 480369fd2d3bSAndrew Sharp a second time. Useful for platforms that are pre-booted 480469fd2d3bSAndrew Sharp by coreboot or similar. 480569fd2d3bSAndrew Sharp 4806842033e6SGabor Juhos- CONFIG_PCI_INDIRECT_BRIDGE: 4807842033e6SGabor Juhos Enable support for indirect PCI bridges. 4808842033e6SGabor Juhos 4809a09b9b68SKumar Gala- CONFIG_SYS_SRIO: 4810a09b9b68SKumar Gala Chip has SRIO or not 4811a09b9b68SKumar Gala 4812a09b9b68SKumar Gala- CONFIG_SRIO1: 4813a09b9b68SKumar Gala Board has SRIO 1 port available 4814a09b9b68SKumar Gala 4815a09b9b68SKumar Gala- CONFIG_SRIO2: 4816a09b9b68SKumar Gala Board has SRIO 2 port available 4817a09b9b68SKumar Gala 4818c8b28152SLiu Gang- CONFIG_SRIO_PCIE_BOOT_MASTER 4819c8b28152SLiu Gang Board can support master function for Boot from SRIO and PCIE 4820c8b28152SLiu Gang 4821a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT: 4822a09b9b68SKumar Gala Virtual Address of SRIO port 'n' memory region 4823a09b9b68SKumar Gala 4824a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS: 4825a09b9b68SKumar Gala Physical Address of SRIO port 'n' memory region 4826a09b9b68SKumar Gala 4827a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE: 4828a09b9b68SKumar Gala Size of SRIO port 'n' memory region 4829a09b9b68SKumar Gala 483066bd1846SFabio Estevam- CONFIG_SYS_NAND_BUSWIDTH_16BIT 483166bd1846SFabio Estevam Defined to tell the NAND controller that the NAND chip is using 483266bd1846SFabio Estevam a 16 bit bus. 483366bd1846SFabio Estevam Not all NAND drivers use this symbol. 4834a430e916SFabio Estevam Example of drivers that use it: 483566bd1846SFabio Estevam - drivers/mtd/nand/ndfc.c 4836a430e916SFabio Estevam - drivers/mtd/nand/mxc_nand.c 4837eced4626SAlex Waterman 4838eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG 4839eced4626SAlex Waterman Sets the EBC0_CFG register for the NDFC. If not defined 4840eced4626SAlex Waterman a default value will be used. 4841eced4626SAlex Waterman 4842bb99ad6dSBen Warren- CONFIG_SPD_EEPROM 4843218ca724SWolfgang Denk Get DDR timing information from an I2C EEPROM. Common 4844218ca724SWolfgang Denk with pluggable memory modules such as SODIMMs 4845218ca724SWolfgang Denk 4846bb99ad6dSBen Warren SPD_EEPROM_ADDRESS 4847bb99ad6dSBen Warren I2C address of the SPD EEPROM 4848bb99ad6dSBen Warren 48496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM 4850218ca724SWolfgang Denk If SPD EEPROM is on an I2C bus other than the first 4851218ca724SWolfgang Denk one, specify here. Note that the value must resolve 4852218ca724SWolfgang Denk to something your driver can deal with. 4853bb99ad6dSBen Warren 48541b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING 48551b3e3c4fSYork Sun Get DDR timing information from other than SPD. Common with 48561b3e3c4fSYork Sun soldered DDR chips onboard without SPD. DDR raw timing 48571b3e3c4fSYork Sun parameters are extracted from datasheet and hard-coded into 48581b3e3c4fSYork Sun header files or board specific files. 48591b3e3c4fSYork Sun 48606f5e1dc5SYork Sun- CONFIG_FSL_DDR_INTERACTIVE 48616f5e1dc5SYork Sun Enable interactive DDR debugging. See doc/README.fsl-ddr. 48626f5e1dc5SYork Sun 4863e32d59a2SYork Sun- CONFIG_FSL_DDR_SYNC_REFRESH 4864e32d59a2SYork Sun Enable sync of refresh for multiple controllers. 4865e32d59a2SYork Sun 48664516ff81SYork Sun- CONFIG_FSL_DDR_BIST 48674516ff81SYork Sun Enable built-in memory test for Freescale DDR controllers. 48684516ff81SYork Sun 48696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0 4870218ca724SWolfgang Denk Only for 83xx systems. If specified, then DDR should 4871218ca724SWolfgang Denk be configured using CS0 and CS1 instead of CS2 and CS3. 48722ad6b513STimur Tabi 4873c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12] 4874c26e454dSwdenk Define to enable FEC[12] on a 8xx series processor. 4875c26e454dSwdenk 4876c26e454dSwdenk- CONFIG_FEC[12]_PHY 4877c26e454dSwdenk Define to the hardcoded PHY address which corresponds 48786e592385Swdenk to the given FEC; i. e. 4879c26e454dSwdenk #define CONFIG_FEC1_PHY 4 4880c26e454dSwdenk means that the PHY with address 4 is connected to FEC1 4881c26e454dSwdenk 4882c26e454dSwdenk When set to -1, means to probe for first available. 4883c26e454dSwdenk 4884c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR 4885c26e454dSwdenk The PHY does not have a RXERR line (RMII only). 4886c26e454dSwdenk (so program the FEC to ignore it). 4887c26e454dSwdenk 4888c26e454dSwdenk- CONFIG_RMII 4889c26e454dSwdenk Enable RMII mode for all FECs. 4890c26e454dSwdenk Note that this is a global option, we can't 4891c26e454dSwdenk have one FEC in standard MII mode and another in RMII mode. 4892c26e454dSwdenk 48935cf91d6bSwdenk- CONFIG_CRC32_VERIFY 48945cf91d6bSwdenk Add a verify option to the crc32 command. 48955cf91d6bSwdenk The syntax is: 48965cf91d6bSwdenk 48975cf91d6bSwdenk => crc32 -v <address> <count> <crc32> 48985cf91d6bSwdenk 48995cf91d6bSwdenk Where address/count indicate a memory area 49005cf91d6bSwdenk and crc32 is the correct crc32 which the 49015cf91d6bSwdenk area should have. 49025cf91d6bSwdenk 490356523f12Swdenk- CONFIG_LOOPW 490456523f12Swdenk Add the "loopw" memory command. This only takes effect if 4905602ad3b3SJon Loeliger the memory commands are activated globally (CONFIG_CMD_MEM). 490656523f12Swdenk 49077b466641Sstroese- CONFIG_MX_CYCLIC 49087b466641Sstroese Add the "mdc" and "mwc" memory commands. These are cyclic 49097b466641Sstroese "md/mw" commands. 49107b466641Sstroese Examples: 49117b466641Sstroese 49127b466641Sstroese => mdc.b 10 4 500 49137b466641Sstroese This command will print 4 bytes (10,11,12,13) each 500 ms. 49147b466641Sstroese 49157b466641Sstroese => mwc.l 100 12345678 10 49167b466641Sstroese This command will write 12345678 to address 100 all 10 ms. 49177b466641Sstroese 49187b466641Sstroese This only takes effect if the memory commands are activated 4919602ad3b3SJon Loeliger globally (CONFIG_CMD_MEM). 49207b466641Sstroese 49218aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT 4922afc1ce82SMacpaul Lin [ARM, NDS32, MIPS only] If this variable is defined, then certain 4923e03f3169SWolfgang Denk low level initializations (like setting up the memory 4924e03f3169SWolfgang Denk controller) are omitted and/or U-Boot does not 4925e03f3169SWolfgang Denk relocate itself into RAM. 49268aa1a2d1Swdenk 4927e03f3169SWolfgang Denk Normally this variable MUST NOT be defined. The only 4928e03f3169SWolfgang Denk exception is when U-Boot is loaded (to RAM) by some 4929e03f3169SWolfgang Denk other boot loader or by a debugger which performs 4930e03f3169SWolfgang Denk these initializations itself. 49318aa1a2d1Swdenk 4932401bb30bSAneesh V- CONFIG_SPL_BUILD 4933df81238bSMagnus Lilja Modifies the behaviour of start.S when compiling a loader 4934df81238bSMagnus Lilja that is executed before the actual U-Boot. E.g. when 4935df81238bSMagnus Lilja compiling a NAND SPL. 4936400558b5Swdenk 49373aa29de0SYing Zhang- CONFIG_TPL_BUILD 49383aa29de0SYing Zhang Modifies the behaviour of start.S when compiling a loader 49393aa29de0SYing Zhang that is executed after the SPL and before the actual U-Boot. 49403aa29de0SYing Zhang It is loaded by the SPL. 49413aa29de0SYing Zhang 49425df572f0SYing Zhang- CONFIG_SYS_MPC85XX_NO_RESETVEC 49435df572f0SYing Zhang Only for 85xx systems. If this variable is specified, the section 49445df572f0SYing Zhang .resetvec is not kept and the section .bootpg is placed in the 49455df572f0SYing Zhang previous 4k of the .text section. 49465df572f0SYing Zhang 49474213fc29SSimon Glass- CONFIG_ARCH_MAP_SYSMEM 49484213fc29SSimon Glass Generally U-Boot (and in particular the md command) uses 49494213fc29SSimon Glass effective address. It is therefore not necessary to regard 49504213fc29SSimon Glass U-Boot address as virtual addresses that need to be translated 49514213fc29SSimon Glass to physical addresses. However, sandbox requires this, since 49524213fc29SSimon Glass it maintains its own little RAM buffer which contains all 49534213fc29SSimon Glass addressable memory. This option causes some memory accesses 49544213fc29SSimon Glass to be mapped through map_sysmem() / unmap_sysmem(). 49554213fc29SSimon Glass 4956d8834a13SMatthias Weisser- CONFIG_USE_ARCH_MEMCPY 4957d8834a13SMatthias Weisser CONFIG_USE_ARCH_MEMSET 4958d8834a13SMatthias Weisser If these options are used a optimized version of memcpy/memset will 4959d8834a13SMatthias Weisser be used if available. These functions may be faster under some 4960d8834a13SMatthias Weisser conditions but may increase the binary size. 4961d8834a13SMatthias Weisser 4962588a13f7SSimon Glass- CONFIG_X86_RESET_VECTOR 4963588a13f7SSimon Glass If defined, the x86 reset vector code is included. This is not 4964588a13f7SSimon Glass needed when U-Boot is running from Coreboot. 4965b16f521aSGabe Black 4966fc33705eSMark Jackson- CONFIG_SYS_MPUCLK 4967fc33705eSMark Jackson Defines the MPU clock speed (in MHz). 4968fc33705eSMark Jackson 4969fc33705eSMark Jackson NOTE : currently only supported on AM335x platforms. 49705b5ece9eSGabe Black 497116678eb4SHeiko Schocher- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC: 497216678eb4SHeiko Schocher Enables the RTC32K OSC on AM33xx based plattforms 497316678eb4SHeiko Schocher 4974999d7d32SKaricheri, Muralidharan- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE 4975999d7d32SKaricheri, Muralidharan Option to disable subpage write in NAND driver 4976999d7d32SKaricheri, Muralidharan driver that uses this: 4977999d7d32SKaricheri, Muralidharan drivers/mtd/nand/davinci_nand.c 4978999d7d32SKaricheri, Muralidharan 4979f2717b47STimur TabiFreescale QE/FMAN Firmware Support: 4980f2717b47STimur Tabi----------------------------------- 4981f2717b47STimur Tabi 4982f2717b47STimur TabiThe Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the 4983f2717b47STimur Tabiloading of "firmware", which is encoded in the QE firmware binary format. 4984f2717b47STimur TabiThis firmware often needs to be loaded during U-Boot booting, so macros 4985f2717b47STimur Tabiare used to identify the storage device (NOR flash, SPI, etc) and the address 4986f2717b47STimur Tabiwithin that device. 4987f2717b47STimur Tabi 4988dcf1d774SZhao Qiang- CONFIG_SYS_FMAN_FW_ADDR 4989dcf1d774SZhao Qiang The address in the storage device where the FMAN microcode is located. The 4990dcf1d774SZhao Qiang meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro 4991dcf1d774SZhao Qiang is also specified. 4992dcf1d774SZhao Qiang 4993dcf1d774SZhao Qiang- CONFIG_SYS_QE_FW_ADDR 4994dcf1d774SZhao Qiang The address in the storage device where the QE microcode is located. The 4995f2717b47STimur Tabi meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro 4996f2717b47STimur Tabi is also specified. 4997f2717b47STimur Tabi 4998f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_LENGTH 4999f2717b47STimur Tabi The maximum possible size of the firmware. The firmware binary format 5000f2717b47STimur Tabi has a field that specifies the actual size of the firmware, but it 5001f2717b47STimur Tabi might not be possible to read any part of the firmware unless some 5002f2717b47STimur Tabi local storage is allocated to hold the entire firmware first. 5003f2717b47STimur Tabi 5004f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NOR 5005f2717b47STimur Tabi Specifies that QE/FMAN firmware is located in NOR flash, mapped as 5006f2717b47STimur Tabi normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the 5007f2717b47STimur Tabi virtual address in NOR flash. 5008f2717b47STimur Tabi 5009f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NAND 5010f2717b47STimur Tabi Specifies that QE/FMAN firmware is located in NAND flash. 5011f2717b47STimur Tabi CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash. 5012f2717b47STimur Tabi 5013f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_MMC 5014f2717b47STimur Tabi Specifies that QE/FMAN firmware is located on the primary SD/MMC 5015f2717b47STimur Tabi device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device. 5016f2717b47STimur Tabi 5017f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH 5018f2717b47STimur Tabi Specifies that QE/FMAN firmware is located on the primary SPI 5019f2717b47STimur Tabi device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device. 5020f2717b47STimur Tabi 5021292dc6c5SLiu Gang- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE 5022292dc6c5SLiu Gang Specifies that QE/FMAN firmware is located in the remote (master) 5023292dc6c5SLiu Gang memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which 5024fc54c7faSLiu Gang can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound 5025fc54c7faSLiu Gang window->master inbound window->master LAW->the ucode address in 5026fc54c7faSLiu Gang master's memory space. 5027f2717b47STimur Tabi 5028b940ca64SJ. German RiveraFreescale Layerscape Management Complex Firmware Support: 5029b940ca64SJ. German Rivera--------------------------------------------------------- 5030b940ca64SJ. German RiveraThe Freescale Layerscape Management Complex (MC) supports the loading of 5031b940ca64SJ. German Rivera"firmware". 5032b940ca64SJ. German RiveraThis firmware often needs to be loaded during U-Boot booting, so macros 5033b940ca64SJ. German Riveraare used to identify the storage device (NOR flash, SPI, etc) and the address 5034b940ca64SJ. German Riverawithin that device. 5035b940ca64SJ. German Rivera 5036b940ca64SJ. German Rivera- CONFIG_FSL_MC_ENET 5037b940ca64SJ. German Rivera Enable the MC driver for Layerscape SoCs. 5038b940ca64SJ. German Rivera 5039b940ca64SJ. German Rivera- CONFIG_SYS_LS_MC_FW_ADDR 5040b940ca64SJ. German Rivera The address in the storage device where the firmware is located. The 5041b940ca64SJ. German Rivera meaning of this address depends on which CONFIG_SYS_LS_MC_FW_IN_xxx macro 5042b940ca64SJ. German Rivera is also specified. 5043b940ca64SJ. German Rivera 5044b940ca64SJ. German Rivera- CONFIG_SYS_LS_MC_FW_LENGTH 5045b940ca64SJ. German Rivera The maximum possible size of the firmware. The firmware binary format 5046b940ca64SJ. German Rivera has a field that specifies the actual size of the firmware, but it 5047b940ca64SJ. German Rivera might not be possible to read any part of the firmware unless some 5048b940ca64SJ. German Rivera local storage is allocated to hold the entire firmware first. 5049b940ca64SJ. German Rivera 5050b940ca64SJ. German Rivera- CONFIG_SYS_LS_MC_FW_IN_NOR 5051b940ca64SJ. German Rivera Specifies that MC firmware is located in NOR flash, mapped as 5052b940ca64SJ. German Rivera normal addressable memory via the LBC. CONFIG_SYS_LS_MC_FW_ADDR is the 5053b940ca64SJ. German Rivera virtual address in NOR flash. 5054b940ca64SJ. German Rivera 50555c055089SPrabhakar KushwahaFreescale Layerscape Debug Server Support: 50565c055089SPrabhakar Kushwaha------------------------------------------- 50575c055089SPrabhakar KushwahaThe Freescale Layerscape Debug Server Support supports the loading of 50585c055089SPrabhakar Kushwaha"Debug Server firmware" and triggering SP boot-rom. 50595c055089SPrabhakar KushwahaThis firmware often needs to be loaded during U-Boot booting. 50605c055089SPrabhakar Kushwaha 50615c055089SPrabhakar Kushwaha- CONFIG_FSL_DEBUG_SERVER 50625c055089SPrabhakar Kushwaha Enable the Debug Server for Layerscape SoCs. 50635c055089SPrabhakar Kushwaha 50645c055089SPrabhakar Kushwaha- CONFIG_SYS_DEBUG_SERVER_DRAM_BLOCK_MIN_SIZE 50655c055089SPrabhakar Kushwaha Define minimum DDR size required for debug server image 50665c055089SPrabhakar Kushwaha 50675c055089SPrabhakar Kushwaha- CONFIG_SYS_MEM_TOP_HIDE_MIN 50685c055089SPrabhakar Kushwaha Define minimum DDR size to be hided from top of the DDR memory 50695c055089SPrabhakar Kushwaha 5070f3f431a7SPaul KocialkowskiReproducible builds 5071f3f431a7SPaul Kocialkowski------------------- 5072f3f431a7SPaul Kocialkowski 5073f3f431a7SPaul KocialkowskiIn order to achieve reproducible builds, timestamps used in the U-Boot build 5074f3f431a7SPaul Kocialkowskiprocess have to be set to a fixed value. 5075f3f431a7SPaul Kocialkowski 5076f3f431a7SPaul KocialkowskiThis is done using the SOURCE_DATE_EPOCH environment variable. 5077f3f431a7SPaul KocialkowskiSOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration 5078f3f431a7SPaul Kocialkowskioption for U-Boot or an environment variable in U-Boot. 5079f3f431a7SPaul Kocialkowski 5080f3f431a7SPaul KocialkowskiSOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC. 5081f3f431a7SPaul Kocialkowski 5082c609719bSwdenkBuilding the Software: 5083c609719bSwdenk====================== 5084c609719bSwdenk 5085218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments 5086218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support 5087218ca724SWolfgang Denkall possibly existing versions of cross development tools in all 5088218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we 5089218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK) 5090218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot. 5091c609719bSwdenk 5092218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you 5093218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case, 5094218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell. 5095218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are 5096218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter: 5097c609719bSwdenk 5098218ca724SWolfgang Denk $ CROSS_COMPILE=ppc_4xx- 5099218ca724SWolfgang Denk $ export CROSS_COMPILE 5100c609719bSwdenk 51012f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in 51022f8d396bSPeter Tyser the tools directory you can use the MinGW toolchain 51032f8d396bSPeter Tyser (http://www.mingw.org). Set your HOST tools to the MinGW 51042f8d396bSPeter Tyser toolchain and execute 'make tools'. For example: 51052f8d396bSPeter Tyser 51062f8d396bSPeter Tyser $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools 51072f8d396bSPeter Tyser 51082f8d396bSPeter Tyser Binaries such as tools/mkimage.exe will be created which can 51092f8d396bSPeter Tyser be executed on computers running Windows. 51102f8d396bSPeter Tyser 5111c609719bSwdenkU-Boot is intended to be simple to build. After installing the 5112c609719bSwdenksources you must configure U-Boot for one specific board type. This 5113c609719bSwdenkis done by typing: 5114c609719bSwdenk 5115ab584d67SHolger Freyther make NAME_defconfig 5116c609719bSwdenk 5117ab584d67SHolger Freytherwhere "NAME_defconfig" is the name of one of the existing configu- 51184d675ae6SMichael Jonesrations; see boards.cfg for supported names. 511954387ac9Swdenk 5120c609719bSwdenkNote: for some board special configuration names may exist; check if 5121c609719bSwdenk additional information is available from the board vendor; for 51222729af9dSwdenk instance, the TQM823L systems are available without (standard) 51232729af9dSwdenk or with LCD support. You can select such additional "features" 512411ccc33fSMarcel Ziswiler when choosing the configuration, i. e. 5125c609719bSwdenk 5126ab584d67SHolger Freyther make TQM823L_defconfig 51272729af9dSwdenk - will configure for a plain TQM823L, i. e. no LCD support 5128c609719bSwdenk 5129ab584d67SHolger Freyther make TQM823L_LCD_defconfig 5130c609719bSwdenk - will configure for a TQM823L with U-Boot console on LCD 5131c609719bSwdenk 5132c609719bSwdenk etc. 5133c609719bSwdenk 5134c609719bSwdenk 5135c609719bSwdenkFinally, type "make all", and you should get some working U-Boot 51367152b1d0Swdenkimages ready for download to / installation on your system: 5137c609719bSwdenk 5138c609719bSwdenk- "u-boot.bin" is a raw binary image 5139c609719bSwdenk- "u-boot" is an image in ELF binary format 5140c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format 5141c609719bSwdenk 5142baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved 5143baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change 5144baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory: 5145baf31249SMarian Balakowicz 5146baf31249SMarian Balakowicz1. Add O= to the make command line invocations: 5147baf31249SMarian Balakowicz 5148baf31249SMarian Balakowicz make O=/tmp/build distclean 5149ab584d67SHolger Freyther make O=/tmp/build NAME_defconfig 5150baf31249SMarian Balakowicz make O=/tmp/build all 5151baf31249SMarian Balakowicz 5152adbba996STimo Ketola2. Set environment variable KBUILD_OUTPUT to point to the desired location: 5153baf31249SMarian Balakowicz 5154adbba996STimo Ketola export KBUILD_OUTPUT=/tmp/build 5155baf31249SMarian Balakowicz make distclean 5156ab584d67SHolger Freyther make NAME_defconfig 5157baf31249SMarian Balakowicz make all 5158baf31249SMarian Balakowicz 5159adbba996STimo KetolaNote that the command line "O=" setting overrides the KBUILD_OUTPUT environment 5160baf31249SMarian Balakowiczvariable. 5161baf31249SMarian Balakowicz 5162c609719bSwdenk 5163c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so 5164c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of 5165c609719bSwdenknative "make". 5166c609719bSwdenk 5167c609719bSwdenk 5168c609719bSwdenkIf the system board that you have is not listed, then you will need 5169c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these 5170c609719bSwdenksteps: 5171c609719bSwdenk 5172c609719bSwdenk1. Add a new configuration option for your board to the toplevel 51734d675ae6SMichael Jones "boards.cfg" file, using the existing entries as examples. 51744d675ae6SMichael Jones Follow the instructions there to keep the boards in order. 5175c609719bSwdenk2. Create a new directory to hold your board specific code. Add any 517685ec0bccSwdenk files you need. In your board directory, you will need at least 517785ec0bccSwdenk the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds". 517885ec0bccSwdenk3. Create a new configuration file "include/configs/<board>.h" for 517985ec0bccSwdenk your board 5180c609719bSwdenk3. If you're porting U-Boot to a new CPU, then also create a new 5181c609719bSwdenk directory to hold your CPU specific code. Add any files you need. 5182ab584d67SHolger Freyther4. Run "make <board>_defconfig" with your new name. 5183c609719bSwdenk5. Type "make", and you should get a working "u-boot.srec" file 5184c609719bSwdenk to be installed on your target system. 518585ec0bccSwdenk6. Debug and solve any problems that might arise. 5186c609719bSwdenk [Of course, this last step is much harder than it sounds.] 5187c609719bSwdenk 5188c609719bSwdenk 5189c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.: 5190c609719bSwdenk============================================================== 5191c609719bSwdenk 5192c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board 5193c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to 5194c609719bSwdenkprovide feedback to the other developers. The feedback normally takes 5195c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest 5196218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources. 5197c609719bSwdenk 5198c609719bSwdenkBut before you submit such a patch, please verify that your modifi- 5199c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of 5200c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so, 5201c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot 5202c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can 52037152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE' 5204218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools 5205218ca724SWolfgang Denkyou can type 5206c609719bSwdenk 5207c609719bSwdenk CROSS_COMPILE=ppc_8xx- MAKEALL 5208c609719bSwdenk 5209c609719bSwdenkor to build on a native PowerPC system you can type 5210c609719bSwdenk 5211c609719bSwdenk CROSS_COMPILE=' ' MAKEALL 5212c609719bSwdenk 5213218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build 5214218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by 5215218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target 5216218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and 5217218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default 5218218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment 5219218ca724SWolfgang Denkvariable. For example: 5220baf31249SMarian Balakowicz 5221baf31249SMarian Balakowicz export BUILD_DIR=/tmp/build 5222baf31249SMarian Balakowicz export MAKEALL_LOGDIR=/tmp/log 5223baf31249SMarian Balakowicz CROSS_COMPILE=ppc_8xx- MAKEALL 5224baf31249SMarian Balakowicz 5225218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build, 5226218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean 5227218ca724SWolfgang Denkduring the whole build process. 5228baf31249SMarian Balakowicz 5229baf31249SMarian Balakowicz 5230c609719bSwdenkSee also "U-Boot Porting Guide" below. 5231c609719bSwdenk 5232c609719bSwdenk 5233c609719bSwdenkMonitor Commands - Overview: 5234c609719bSwdenk============================ 5235c609719bSwdenk 5236c609719bSwdenkgo - start application at address 'addr' 5237c609719bSwdenkrun - run commands in an environment variable 5238c609719bSwdenkbootm - boot application image from memory 5239c609719bSwdenkbootp - boot image via network using BootP/TFTP protocol 524044f074c7SMarek Vasutbootz - boot zImage from memory 5241c609719bSwdenktftpboot- boot image via network using TFTP protocol 5242c609719bSwdenk and env variables "ipaddr" and "serverip" 5243c609719bSwdenk (and eventually "gatewayip") 52441fb7cd49SSimon Glasstftpput - upload a file via network using TFTP protocol 5245c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol 5246c609719bSwdenkdiskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd' 5247c609719bSwdenkloads - load S-Record file over serial line 5248c609719bSwdenkloadb - load binary file over serial line (kermit mode) 5249c609719bSwdenkmd - memory display 5250c609719bSwdenkmm - memory modify (auto-incrementing) 5251c609719bSwdenknm - memory modify (constant address) 5252c609719bSwdenkmw - memory write (fill) 5253c609719bSwdenkcp - memory copy 5254c609719bSwdenkcmp - memory compare 5255c609719bSwdenkcrc32 - checksum calculation 52560f89c54bSPeter Tyseri2c - I2C sub-system 5257c609719bSwdenksspi - SPI utility commands 5258c609719bSwdenkbase - print or set address offset 5259c609719bSwdenkprintenv- print environment variables 5260c609719bSwdenksetenv - set environment variables 5261c609719bSwdenksaveenv - save environment variables to persistent storage 5262c609719bSwdenkprotect - enable or disable FLASH write protection 5263c609719bSwdenkerase - erase FLASH memory 5264c609719bSwdenkflinfo - print FLASH memory information 526510635afaSKarl O. Pincnand - NAND memory operations (see doc/README.nand) 5266c609719bSwdenkbdinfo - print Board Info structure 5267c609719bSwdenkiminfo - print header information for application image 5268c609719bSwdenkconinfo - print console devices and informations 5269c609719bSwdenkide - IDE sub-system 5270c609719bSwdenkloop - infinite loop on address range 527156523f12Swdenkloopw - infinite write loop on address range 5272c609719bSwdenkmtest - simple RAM test 5273c609719bSwdenkicache - enable or disable instruction cache 5274c609719bSwdenkdcache - enable or disable data cache 5275c609719bSwdenkreset - Perform RESET of the CPU 5276c609719bSwdenkecho - echo args to console 5277c609719bSwdenkversion - print monitor version 5278c609719bSwdenkhelp - print online help 5279c609719bSwdenk? - alias for 'help' 5280c609719bSwdenk 5281c609719bSwdenk 5282c609719bSwdenkMonitor Commands - Detailed Description: 5283c609719bSwdenk======================================== 5284c609719bSwdenk 5285c609719bSwdenkTODO. 5286c609719bSwdenk 5287c609719bSwdenkFor now: just type "help <command>". 5288c609719bSwdenk 5289c609719bSwdenk 5290c609719bSwdenkEnvironment Variables: 5291c609719bSwdenk====================== 5292c609719bSwdenk 5293c609719bSwdenkU-Boot supports user configuration using Environment Variables which 5294c609719bSwdenkcan be made persistent by saving to Flash memory. 5295c609719bSwdenk 5296c609719bSwdenkEnvironment Variables are set using "setenv", printed using 5297c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv" 5298c609719bSwdenkwithout a value can be used to delete a variable from the 5299c609719bSwdenkenvironment. As long as you don't save the environment you are 5300c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the 5301c609719bSwdenkenvironment is erased by accident, a default environment is provided. 5302c609719bSwdenk 5303c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables. 5304c96f86eeSWolfgang Denk 5305c96f86eeSWolfgang DenkList of environment variables (most likely not complete): 5306c609719bSwdenk 5307c609719bSwdenk baudrate - see CONFIG_BAUDRATE 5308c609719bSwdenk 5309c609719bSwdenk bootdelay - see CONFIG_BOOTDELAY 5310c609719bSwdenk 5311c609719bSwdenk bootcmd - see CONFIG_BOOTCOMMAND 5312c609719bSwdenk 5313c609719bSwdenk bootargs - Boot arguments when booting an RTOS image 5314c609719bSwdenk 5315c609719bSwdenk bootfile - Name of the image to load with TFTP 5316c609719bSwdenk 53177d721e34SBartlomiej Sieka bootm_low - Memory range available for image processing in the bootm 53187d721e34SBartlomiej Sieka command can be restricted. This variable is given as 53197d721e34SBartlomiej Sieka a hexadecimal number and defines lowest address allowed 53207d721e34SBartlomiej Sieka for use by the bootm command. See also "bootm_size" 53217d721e34SBartlomiej Sieka environment variable. Address defined by "bootm_low" is 53227d721e34SBartlomiej Sieka also the base of the initial memory mapping for the Linux 5323c3624e6eSGrant Likely kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and 5324c3624e6eSGrant Likely bootm_mapsize. 5325c3624e6eSGrant Likely 5326c3624e6eSGrant Likely bootm_mapsize - Size of the initial memory mapping for the Linux kernel. 5327c3624e6eSGrant Likely This variable is given as a hexadecimal number and it 5328c3624e6eSGrant Likely defines the size of the memory region starting at base 5329c3624e6eSGrant Likely address bootm_low that is accessible by the Linux kernel 5330c3624e6eSGrant Likely during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used 5331c3624e6eSGrant Likely as the default value if it is defined, and bootm_size is 5332c3624e6eSGrant Likely used otherwise. 53337d721e34SBartlomiej Sieka 53347d721e34SBartlomiej Sieka bootm_size - Memory range available for image processing in the bootm 53357d721e34SBartlomiej Sieka command can be restricted. This variable is given as 53367d721e34SBartlomiej Sieka a hexadecimal number and defines the size of the region 53377d721e34SBartlomiej Sieka allowed for use by the bootm command. See also "bootm_low" 53387d721e34SBartlomiej Sieka environment variable. 53397d721e34SBartlomiej Sieka 53404bae9090SBartlomiej Sieka updatefile - Location of the software update file on a TFTP server, used 53414bae9090SBartlomiej Sieka by the automatic software update feature. Please refer to 53424bae9090SBartlomiej Sieka documentation in doc/README.update for more details. 53434bae9090SBartlomiej Sieka 5344c609719bSwdenk autoload - if set to "no" (any string beginning with 'n'), 5345c609719bSwdenk "bootp" will just load perform a lookup of the 5346c609719bSwdenk configuration from the BOOTP server, but not try to 5347c609719bSwdenk load any image using TFTP 5348c609719bSwdenk 5349c609719bSwdenk autostart - if set to "yes", an image loaded using the "bootp", 5350c609719bSwdenk "rarpboot", "tftpboot" or "diskboot" commands will 5351c609719bSwdenk be automatically started (by internally calling 5352c609719bSwdenk "bootm") 5353c609719bSwdenk 53544a6fd34bSwdenk If set to "no", a standalone image passed to the 53554a6fd34bSwdenk "bootm" command will be copied to the load address 53564a6fd34bSwdenk (and eventually uncompressed), but NOT be started. 53574a6fd34bSwdenk This can be used to load and uncompress arbitrary 53584a6fd34bSwdenk data. 53594a6fd34bSwdenk 5360a28afca5SDavid A. Long fdt_high - if set this restricts the maximum address that the 5361a28afca5SDavid A. Long flattened device tree will be copied into upon boot. 5362fa34f6b2SShawn Guo For example, if you have a system with 1 GB memory 5363fa34f6b2SShawn Guo at physical address 0x10000000, while Linux kernel 5364fa34f6b2SShawn Guo only recognizes the first 704 MB as low memory, you 5365fa34f6b2SShawn Guo may need to set fdt_high as 0x3C000000 to have the 5366fa34f6b2SShawn Guo device tree blob be copied to the maximum address 5367fa34f6b2SShawn Guo of the 704 MB low memory, so that Linux kernel can 5368fa34f6b2SShawn Guo access it during the boot procedure. 5369fa34f6b2SShawn Guo 5370a28afca5SDavid A. Long If this is set to the special value 0xFFFFFFFF then 5371a28afca5SDavid A. Long the fdt will not be copied at all on boot. For this 5372a28afca5SDavid A. Long to work it must reside in writable memory, have 5373a28afca5SDavid A. Long sufficient padding on the end of it for u-boot to 5374a28afca5SDavid A. Long add the information it needs into it, and the memory 5375a28afca5SDavid A. Long must be accessible by the kernel. 5376a28afca5SDavid A. Long 5377eea63e05SSimon Glass fdtcontroladdr- if set this is the address of the control flattened 5378eea63e05SSimon Glass device tree used by U-Boot when CONFIG_OF_CONTROL is 5379eea63e05SSimon Glass defined. 5380eea63e05SSimon Glass 538117ea1177Swdenk i2cfast - (PPC405GP|PPC405EP only) 538217ea1177Swdenk if set to 'y' configures Linux I2C driver for fast 538317ea1177Swdenk mode (400kHZ). This environment variable is used in 538417ea1177Swdenk initialization code. So, for changes to be effective 538517ea1177Swdenk it must be saved and board must be reset. 538617ea1177Swdenk 5387c609719bSwdenk initrd_high - restrict positioning of initrd images: 5388c609719bSwdenk If this variable is not set, initrd images will be 5389c609719bSwdenk copied to the highest possible address in RAM; this 5390c609719bSwdenk is usually what you want since it allows for 5391c609719bSwdenk maximum initrd size. If for some reason you want to 5392c609719bSwdenk make sure that the initrd image is loaded below the 53936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BOOTMAPSZ limit, you can set this environment 5394c609719bSwdenk variable to a value of "no" or "off" or "0". 5395c609719bSwdenk Alternatively, you can set it to a maximum upper 5396c609719bSwdenk address to use (U-Boot will still check that it 5397c609719bSwdenk does not overwrite the U-Boot stack and data). 5398c609719bSwdenk 5399c609719bSwdenk For instance, when you have a system with 16 MB 54007152b1d0Swdenk RAM, and want to reserve 4 MB from use by Linux, 5401c609719bSwdenk you can do this by adding "mem=12M" to the value of 5402c609719bSwdenk the "bootargs" variable. However, now you must make 54037152b1d0Swdenk sure that the initrd image is placed in the first 5404c609719bSwdenk 12 MB as well - this can be done with 5405c609719bSwdenk 5406c609719bSwdenk setenv initrd_high 00c00000 5407c609719bSwdenk 540838b99261Swdenk If you set initrd_high to 0xFFFFFFFF, this is an 540938b99261Swdenk indication to U-Boot that all addresses are legal 541038b99261Swdenk for the Linux kernel, including addresses in flash 541138b99261Swdenk memory. In this case U-Boot will NOT COPY the 541238b99261Swdenk ramdisk at all. This may be useful to reduce the 541338b99261Swdenk boot time on your system, but requires that this 541438b99261Swdenk feature is supported by your Linux kernel. 541538b99261Swdenk 5416c609719bSwdenk ipaddr - IP address; needed for tftpboot command 5417c609719bSwdenk 5418c609719bSwdenk loadaddr - Default load address for commands like "bootp", 5419dc7c9a1aSwdenk "rarpboot", "tftpboot", "loadb" or "diskboot" 5420c609719bSwdenk 5421c609719bSwdenk loads_echo - see CONFIG_LOADS_ECHO 5422c609719bSwdenk 5423c609719bSwdenk serverip - TFTP server IP address; needed for tftpboot command 5424c609719bSwdenk 5425c609719bSwdenk bootretry - see CONFIG_BOOT_RETRY_TIME 5426c609719bSwdenk 5427c609719bSwdenk bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR 5428c609719bSwdenk 5429c609719bSwdenk bootstopkey - see CONFIG_AUTOBOOT_STOP_STR 5430c609719bSwdenk 5431e2a53458SMike Frysinger ethprime - controls which interface is used first. 5432a3d991bdSwdenk 5433e2a53458SMike Frysinger ethact - controls which interface is currently active. 5434e2a53458SMike Frysinger For example you can do the following 5435a3d991bdSwdenk 543648690d80SHeiko Schocher => setenv ethact FEC 543748690d80SHeiko Schocher => ping 192.168.0.1 # traffic sent on FEC 543848690d80SHeiko Schocher => setenv ethact SCC 543948690d80SHeiko Schocher => ping 10.0.0.1 # traffic sent on SCC 5440a3d991bdSwdenk 5441e1692577SMatthias Fuchs ethrotate - When set to "no" U-Boot does not go through all 5442e1692577SMatthias Fuchs available network interfaces. 5443e1692577SMatthias Fuchs It just stays at the currently selected interface. 5444e1692577SMatthias Fuchs 5445a3d991bdSwdenk netretry - When set to "no" each network operation will 5446a3d991bdSwdenk either succeed or fail without retrying. 54476e592385Swdenk When set to "once" the network operation will 54486e592385Swdenk fail when all the available network interfaces 54496e592385Swdenk are tried once without success. 5450a3d991bdSwdenk Useful on scripts which control the retry operation 5451a3d991bdSwdenk themselves. 5452a3d991bdSwdenk 5453b4e2f89dSJean-Christophe PLAGNIOL-VILLARD npe_ucode - set load address for the NPE microcode 5454a1cf027aSJean-Christophe PLAGNIOL-VILLARD 5455b445bbb4SJeremiah Mahler silent_linux - If set then Linux will be told to boot silently, by 54568d51aacdSSimon Glass changing the console to be empty. If "yes" it will be 54578d51aacdSSimon Glass made silent. If "no" it will not be made silent. If 54588d51aacdSSimon Glass unset, then it will be made silent if the U-Boot console 54598d51aacdSSimon Glass is silent. 54608d51aacdSSimon Glass 546128cb9375SWolfgang Denk tftpsrcport - If this is set, the value is used for TFTP's 5462ecb0ccd9SWolfgang Denk UDP source port. 5463ecb0ccd9SWolfgang Denk 546428cb9375SWolfgang Denk tftpdstport - If this is set, the value is used for TFTP's UDP 546528cb9375SWolfgang Denk destination port instead of the Well Know Port 69. 546628cb9375SWolfgang Denk 5467c96f86eeSWolfgang Denk tftpblocksize - Block size to use for TFTP transfers; if not set, 5468c96f86eeSWolfgang Denk we use the TFTP server's default block size 5469c96f86eeSWolfgang Denk 5470c96f86eeSWolfgang Denk tftptimeout - Retransmission timeout for TFTP packets (in milli- 5471c96f86eeSWolfgang Denk seconds, minimum value is 1000 = 1 second). Defines 5472c96f86eeSWolfgang Denk when a packet is considered to be lost so it has to 5473c96f86eeSWolfgang Denk be retransmitted. The default is 5000 = 5 seconds. 5474c96f86eeSWolfgang Denk Lowering this value may make downloads succeed 5475c96f86eeSWolfgang Denk faster in networks with high packet loss rates or 5476c96f86eeSWolfgang Denk with unreliable TFTP servers. 5477c96f86eeSWolfgang Denk 5478a3d991bdSwdenk vlan - When set to a value < 4095 the traffic over 547911ccc33fSMarcel Ziswiler Ethernet is encapsulated/received over 802.1q 5480a3d991bdSwdenk VLAN tagged frames. 5481c609719bSwdenk 5482dc0b7b0eSJason HobbsThe following image location variables contain the location of images 5483dc0b7b0eSJason Hobbsused in booting. The "Image" column gives the role of the image and is 5484dc0b7b0eSJason Hobbsnot an environment variable name. The other columns are environment 5485dc0b7b0eSJason Hobbsvariable names. "File Name" gives the name of the file on a TFTP 5486dc0b7b0eSJason Hobbsserver, "RAM Address" gives the location in RAM the image will be 5487dc0b7b0eSJason Hobbsloaded to, and "Flash Location" gives the image's address in NOR 5488dc0b7b0eSJason Hobbsflash or offset in NAND flash. 5489dc0b7b0eSJason Hobbs 5490dc0b7b0eSJason Hobbs*Note* - these variables don't have to be defined for all boards, some 5491aed9fed9SFabio Estevamboards currently use other variables for these purposes, and some 5492dc0b7b0eSJason Hobbsboards use these variables for other purposes. 5493dc0b7b0eSJason Hobbs 5494dc0b7b0eSJason HobbsImage File Name RAM Address Flash Location 5495dc0b7b0eSJason Hobbs----- --------- ----------- -------------- 5496dc0b7b0eSJason Hobbsu-boot u-boot u-boot_addr_r u-boot_addr 5497dc0b7b0eSJason HobbsLinux kernel bootfile kernel_addr_r kernel_addr 5498dc0b7b0eSJason Hobbsdevice tree blob fdtfile fdt_addr_r fdt_addr 5499dc0b7b0eSJason Hobbsramdisk ramdiskfile ramdisk_addr_r ramdisk_addr 5500dc0b7b0eSJason Hobbs 5501c609719bSwdenkThe following environment variables may be used and automatically 5502c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"), 5503c609719bSwdenkdepending the information provided by your boot server: 5504c609719bSwdenk 5505c609719bSwdenk bootfile - see above 5506c609719bSwdenk dnsip - IP address of your Domain Name Server 5507fe389a82Sstroese dnsip2 - IP address of your secondary Domain Name Server 5508c609719bSwdenk gatewayip - IP address of the Gateway (Router) to use 5509c609719bSwdenk hostname - Target hostname 5510c609719bSwdenk ipaddr - see above 5511c609719bSwdenk netmask - Subnet Mask 5512c609719bSwdenk rootpath - Pathname of the root filesystem on the NFS server 5513c609719bSwdenk serverip - see above 5514c609719bSwdenk 5515c609719bSwdenk 5516c609719bSwdenkThere are two special Environment Variables: 5517c609719bSwdenk 5518c609719bSwdenk serial# - contains hardware identification information such 5519c609719bSwdenk as type string and/or serial number 5520c609719bSwdenk ethaddr - Ethernet address 5521c609719bSwdenk 5522c609719bSwdenkThese variables can be set only once (usually during manufacturing of 5523c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables 5524c609719bSwdenkonce they have been set once. 5525c609719bSwdenk 5526c609719bSwdenk 5527c1551ea8SstroeseFurther special Environment Variables: 5528c1551ea8Sstroese 5529c1551ea8Sstroese ver - Contains the U-Boot version string as printed 5530c1551ea8Sstroese with the "version" command. This variable is 5531c1551ea8Sstroese readonly (see CONFIG_VERSION_VARIABLE). 5532c1551ea8Sstroese 5533c1551ea8Sstroese 5534c609719bSwdenkPlease note that changes to some configuration parameters may take 5535c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-). 5536c609719bSwdenk 5537c609719bSwdenk 5538170ab110SJoe HershbergerCallback functions for environment variables: 5539170ab110SJoe Hershberger--------------------------------------------- 5540170ab110SJoe Hershberger 5541170ab110SJoe HershbergerFor some environment variables, the behavior of u-boot needs to change 5542b445bbb4SJeremiah Mahlerwhen their values are changed. This functionality allows functions to 5543170ab110SJoe Hershbergerbe associated with arbitrary variables. On creation, overwrite, or 5544170ab110SJoe Hershbergerdeletion, the callback will provide the opportunity for some side 5545170ab110SJoe Hershbergereffect to happen or for the change to be rejected. 5546170ab110SJoe Hershberger 5547170ab110SJoe HershbergerThe callbacks are named and associated with a function using the 5548170ab110SJoe HershbergerU_BOOT_ENV_CALLBACK macro in your board or driver code. 5549170ab110SJoe Hershberger 5550170ab110SJoe HershbergerThese callbacks are associated with variables in one of two ways. The 5551170ab110SJoe Hershbergerstatic list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC 5552170ab110SJoe Hershbergerin the board configuration to a string that defines a list of 5553170ab110SJoe Hershbergerassociations. The list must be in the following format: 5554170ab110SJoe Hershberger 5555170ab110SJoe Hershberger entry = variable_name[:callback_name] 5556170ab110SJoe Hershberger list = entry[,list] 5557170ab110SJoe Hershberger 5558170ab110SJoe HershbergerIf the callback name is not specified, then the callback is deleted. 5559170ab110SJoe HershbergerSpaces are also allowed anywhere in the list. 5560170ab110SJoe Hershberger 5561170ab110SJoe HershbergerCallbacks can also be associated by defining the ".callbacks" variable 5562170ab110SJoe Hershbergerwith the same list format above. Any association in ".callbacks" will 5563170ab110SJoe Hershbergeroverride any association in the static list. You can define 5564170ab110SJoe HershbergerCONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the 5565b445bbb4SJeremiah Mahler".callbacks" environment variable in the default or embedded environment. 5566170ab110SJoe Hershberger 5567bdf1fe4eSJoe HershbergerIf CONFIG_REGEX is defined, the variable_name above is evaluated as a 5568bdf1fe4eSJoe Hershbergerregular expression. This allows multiple variables to be connected to 5569bdf1fe4eSJoe Hershbergerthe same callback without explicitly listing them all out. 5570bdf1fe4eSJoe Hershberger 5571170ab110SJoe Hershberger 5572f07771ccSwdenkCommand Line Parsing: 5573f07771ccSwdenk===================== 5574f07771ccSwdenk 5575f07771ccSwdenkThere are two different command line parsers available with U-Boot: 55767152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell: 5577f07771ccSwdenk 5578f07771ccSwdenkOld, simple command line parser: 5579f07771ccSwdenk-------------------------------- 5580f07771ccSwdenk 5581f07771ccSwdenk- supports environment variables (through setenv / saveenv commands) 5582f07771ccSwdenk- several commands on one line, separated by ';' 5583fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax 5584f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\', 5585f07771ccSwdenk for example: 5586fe126d8bSWolfgang Denk setenv bootcmd bootm \${address} 5587f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example: 5588f07771ccSwdenk setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off' 5589f07771ccSwdenk 5590f07771ccSwdenkHush shell: 5591f07771ccSwdenk----------- 5592f07771ccSwdenk 5593f07771ccSwdenk- similar to Bourne shell, with control structures like 5594f07771ccSwdenk if...then...else...fi, for...do...done; while...do...done, 5595f07771ccSwdenk until...do...done, ... 5596f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv 5597f07771ccSwdenk commands) and local shell variables (through standard shell syntax 5598f07771ccSwdenk "name=value"); only environment variables can be used with "run" 5599f07771ccSwdenk command 5600f07771ccSwdenk 5601f07771ccSwdenkGeneral rules: 5602f07771ccSwdenk-------------- 5603f07771ccSwdenk 5604f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run" 5605f07771ccSwdenk command) contains several commands separated by semicolon, and 5606f07771ccSwdenk one of these commands fails, then the remaining commands will be 5607f07771ccSwdenk executed anyway. 5608f07771ccSwdenk 5609f07771ccSwdenk(2) If you execute several variables with one call to run (i. e. 561011ccc33fSMarcel Ziswiler calling run with a list of variables as arguments), any failing 5611f07771ccSwdenk command will cause "run" to terminate, i. e. the remaining 5612f07771ccSwdenk variables are not executed. 5613f07771ccSwdenk 5614c609719bSwdenkNote for Redundant Ethernet Interfaces: 5615c609719bSwdenk======================================= 5616c609719bSwdenk 561711ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports 5618c609719bSwdenksuch configurations and is capable of automatic selection of a 56197152b1d0Swdenk"working" interface when needed. MAC assignment works as follows: 5620c609719bSwdenk 5621c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding 5622c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0), 5623c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ... 5624c609719bSwdenk 5625c609719bSwdenkIf the network interface stores some valid MAC address (for instance 5626c609719bSwdenkin SROM), this is used as default address if there is NO correspon- 5627c609719bSwdenkding setting in the environment; if the corresponding environment 5628c609719bSwdenkvariable is set, this overrides the settings in the card; that means: 5629c609719bSwdenk 5630c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the 5631c609719bSwdenk environment, the SROM's address is used. 5632c609719bSwdenk 5633c609719bSwdenko If there is no valid address in the SROM, and a definition in the 5634c609719bSwdenk environment exists, then the value from the environment variable is 5635c609719bSwdenk used. 5636c609719bSwdenk 5637c609719bSwdenko If both the SROM and the environment contain a MAC address, and 5638c609719bSwdenk both addresses are the same, this MAC address is used. 5639c609719bSwdenk 5640c609719bSwdenko If both the SROM and the environment contain a MAC address, and the 5641c609719bSwdenk addresses differ, the value from the environment is used and a 5642c609719bSwdenk warning is printed. 5643c609719bSwdenk 5644c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error 5645bef1014bSJoe Hershberger is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case 5646bef1014bSJoe Hershberger a random, locally-assigned MAC is used. 5647c609719bSwdenk 5648ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses 5649ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process. This 5650ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable. 5651ecee9324SBen WarrenThe naming convention is as follows: 5652ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc. 5653c609719bSwdenk 5654c609719bSwdenkImage Formats: 5655c609719bSwdenk============== 5656c609719bSwdenk 56573310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on) 56583310c549SMarian Balakowiczimages in two formats: 56593310c549SMarian Balakowicz 56603310c549SMarian BalakowiczNew uImage format (FIT) 56613310c549SMarian Balakowicz----------------------- 56623310c549SMarian Balakowicz 56633310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar 56643310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple 56653310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by 56663310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory. 56673310c549SMarian Balakowicz 56683310c549SMarian Balakowicz 56693310c549SMarian BalakowiczOld uImage format 56703310c549SMarian Balakowicz----------------- 56713310c549SMarian Balakowicz 56723310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything, 56733310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for 56743310c549SMarian Balakowiczdetails; basically, the header defines the following image properties: 5675c609719bSwdenk 5676c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD, 5677c609719bSwdenk 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks, 5678f5ed9e39SPeter Tyser LynxOS, pSOS, QNX, RTEMS, INTEGRITY; 5679f5ed9e39SPeter Tyser Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS, 5680f5ed9e39SPeter Tyser INTEGRITY). 56817b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86, 5682afc1ce82SMacpaul Lin IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit; 5683afc1ce82SMacpaul Lin Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC). 5684c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2) 5685c609719bSwdenk* Load Address 5686c609719bSwdenk* Entry Point 5687c609719bSwdenk* Image Name 5688c609719bSwdenk* Image Timestamp 5689c609719bSwdenk 5690c609719bSwdenkThe header is marked by a special Magic Number, and both the header 5691c609719bSwdenkand the data portions of the image are secured against corruption by 5692c609719bSwdenkCRC32 checksums. 5693c609719bSwdenk 5694c609719bSwdenk 5695c609719bSwdenkLinux Support: 5696c609719bSwdenk============== 5697c609719bSwdenk 5698c609719bSwdenkAlthough U-Boot should support any OS or standalone application 56997152b1d0Swdenkeasily, the main focus has always been on Linux during the design of 5700c609719bSwdenkU-Boot. 5701c609719bSwdenk 5702c609719bSwdenkU-Boot includes many features that so far have been part of some 5703c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any 5704c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image; 5705c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation 57067152b1d0Swdenkserves several purposes: 5707c609719bSwdenk 5708c609719bSwdenk- the same features can be used for other OS or standalone 5709c609719bSwdenk applications (for instance: using compressed images to reduce the 5710c609719bSwdenk Flash memory footprint) 5711c609719bSwdenk 5712c609719bSwdenk- it becomes much easier to port new Linux kernel versions because 57137152b1d0Swdenk lots of low-level, hardware dependent stuff are done by U-Boot 5714c609719bSwdenk 5715c609719bSwdenk- the same Linux kernel image can now be used with different "initrd" 5716c609719bSwdenk images; of course this also means that different kernel images can 5717c609719bSwdenk be run with the same "initrd". This makes testing easier (you don't 5718c609719bSwdenk have to build a new "zImage.initrd" Linux image when you just 5719c609719bSwdenk change a file in your "initrd"). Also, a field-upgrade of the 5720c609719bSwdenk software is easier now. 5721c609719bSwdenk 5722c609719bSwdenk 5723c609719bSwdenkLinux HOWTO: 5724c609719bSwdenk============ 5725c609719bSwdenk 5726c609719bSwdenkPorting Linux to U-Boot based systems: 5727c609719bSwdenk--------------------------------------- 5728c609719bSwdenk 5729c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to 5730c609719bSwdenkconfigure the Linux device drivers for use with your target hardware 5731c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to 5732c609719bSwdenkLinux :-). 5733c609719bSwdenk 5734a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot). 5735c609719bSwdenk 5736c609719bSwdenkJust make sure your machine specific header file (for instance 5737c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board 57381dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h, 57391dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value 57406d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR. 5741c609719bSwdenk 57422eb31b13SSimon GlassNote that U-Boot now has a driver model, a unified model for drivers. 57432eb31b13SSimon GlassIf you are adding a new driver, plumb it into driver model. If there 57442eb31b13SSimon Glassis no uclass available, you are encouraged to create one. See 57452eb31b13SSimon Glassdoc/driver-model. 57462eb31b13SSimon Glass 5747c609719bSwdenk 5748c609719bSwdenkConfiguring the Linux kernel: 5749c609719bSwdenk----------------------------- 5750c609719bSwdenk 5751c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root 5752c609719bSwdenkdevice (initial ramdisk, NFS) for your target system. 5753c609719bSwdenk 5754c609719bSwdenk 5755c609719bSwdenkBuilding a Linux Image: 5756c609719bSwdenk----------------------- 5757c609719bSwdenk 575824ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are 575924ee89b9Swdenknot used. If you use recent kernel source, a new build target 576024ee89b9Swdenk"uImage" will exist which automatically builds an image usable by 576124ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target, 576224ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a 576324ee89b9Swdenk100% compatible format. 5764c609719bSwdenk 5765c609719bSwdenkExample: 5766c609719bSwdenk 5767ab584d67SHolger Freyther make TQM850L_defconfig 5768c609719bSwdenk make oldconfig 5769c609719bSwdenk make dep 577024ee89b9Swdenk make uImage 5771c609719bSwdenk 577224ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to 577324ee89b9Swdenkencapsulate a compressed Linux kernel image with header information, 577424ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing: 5775c609719bSwdenk 577624ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format): 577724ee89b9Swdenk 577824ee89b9Swdenk* convert the kernel into a raw binary image: 577924ee89b9Swdenk 578024ee89b9Swdenk ${CROSS_COMPILE}-objcopy -O binary \ 578124ee89b9Swdenk -R .note -R .comment \ 578224ee89b9Swdenk -S vmlinux linux.bin 578324ee89b9Swdenk 578424ee89b9Swdenk* compress the binary image: 578524ee89b9Swdenk 578624ee89b9Swdenk gzip -9 linux.bin 578724ee89b9Swdenk 578824ee89b9Swdenk* package compressed binary image for U-Boot: 578924ee89b9Swdenk 579024ee89b9Swdenk mkimage -A ppc -O linux -T kernel -C gzip \ 579124ee89b9Swdenk -a 0 -e 0 -n "Linux Kernel Image" \ 579224ee89b9Swdenk -d linux.bin.gz uImage 579324ee89b9Swdenk 579424ee89b9Swdenk 579524ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use 579624ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or 579724ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64 579824ee89b9Swdenkbyte header containing information about target architecture, 579924ee89b9Swdenkoperating system, image type, compression method, entry points, time 580024ee89b9Swdenkstamp, CRC32 checksums, etc. 580124ee89b9Swdenk 580224ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and 580324ee89b9Swdenkprint the header information, or to build new images. 5804c609719bSwdenk 5805c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information 5806c609719bSwdenkcontained in the header of an existing U-Boot image; this includes 5807c609719bSwdenkchecksum verification: 5808c609719bSwdenk 5809c609719bSwdenk tools/mkimage -l image 5810c609719bSwdenk -l ==> list image header information 5811c609719bSwdenk 5812c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image 5813c609719bSwdenkfrom a "data file" which is used as image payload: 5814c609719bSwdenk 5815c609719bSwdenk tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \ 5816c609719bSwdenk -n name -d data_file image 5817c609719bSwdenk -A ==> set architecture to 'arch' 5818c609719bSwdenk -O ==> set operating system to 'os' 5819c609719bSwdenk -T ==> set image type to 'type' 5820c609719bSwdenk -C ==> set compression type 'comp' 5821c609719bSwdenk -a ==> set load address to 'addr' (hex) 5822c609719bSwdenk -e ==> set entry point to 'ep' (hex) 5823c609719bSwdenk -n ==> set image name to 'name' 5824c609719bSwdenk -d ==> use image data from 'datafile' 5825c609719bSwdenk 582669459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load 582769459791Swdenkaddress (0x00000000), but the entry point address depends on the 582869459791Swdenkkernel version: 5829c609719bSwdenk 5830c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C, 583124ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000. 5832c609719bSwdenk 5833c609719bSwdenkSo a typical call to build a U-Boot image would read: 5834c609719bSwdenk 583524ee89b9Swdenk -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 583624ee89b9Swdenk > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \ 5837a47a12beSStefan Roese > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \ 583824ee89b9Swdenk > examples/uImage.TQM850L 583924ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 5840c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 5841c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 5842c609719bSwdenk Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 5843c609719bSwdenk Load Address: 0x00000000 584424ee89b9Swdenk Entry Point: 0x00000000 5845c609719bSwdenk 5846c609719bSwdenkTo verify the contents of the image (or check for corruption): 5847c609719bSwdenk 584824ee89b9Swdenk -> tools/mkimage -l examples/uImage.TQM850L 584924ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 5850c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 5851c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 5852c609719bSwdenk Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 5853c609719bSwdenk Load Address: 0x00000000 585424ee89b9Swdenk Entry Point: 0x00000000 5855c609719bSwdenk 5856c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade 5857c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this 5858c609719bSwdenkneeds more space in Flash, but boots much faster since it does not 5859c609719bSwdenkneed to be uncompressed: 5860c609719bSwdenk 5861a47a12beSStefan Roese -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz 586224ee89b9Swdenk -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 586324ee89b9Swdenk > -A ppc -O linux -T kernel -C none -a 0 -e 0 \ 5864a47a12beSStefan Roese > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \ 586524ee89b9Swdenk > examples/uImage.TQM850L-uncompressed 586624ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 5867c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 5868c609719bSwdenk Image Type: PowerPC Linux Kernel Image (uncompressed) 5869c609719bSwdenk Data Size: 792160 Bytes = 773.59 kB = 0.76 MB 5870c609719bSwdenk Load Address: 0x00000000 587124ee89b9Swdenk Entry Point: 0x00000000 5872c609719bSwdenk 5873c609719bSwdenk 5874c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file 5875c609719bSwdenkwhen your kernel is intended to use an initial ramdisk: 5876c609719bSwdenk 5877c609719bSwdenk -> tools/mkimage -n 'Simple Ramdisk Image' \ 5878c609719bSwdenk > -A ppc -O linux -T ramdisk -C gzip \ 5879c609719bSwdenk > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd 5880c609719bSwdenk Image Name: Simple Ramdisk Image 5881c609719bSwdenk Created: Wed Jan 12 14:01:50 2000 5882c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 5883c609719bSwdenk Data Size: 566530 Bytes = 553.25 kB = 0.54 MB 5884c609719bSwdenk Load Address: 0x00000000 5885c609719bSwdenk Entry Point: 0x00000000 5886c609719bSwdenk 5887a804b5ceSGuilherme Maciel FerreiraThe "dumpimage" is a tool to disassemble images built by mkimage. Its "-i" 5888a804b5ceSGuilherme Maciel Ferreiraoption performs the converse operation of the mkimage's second form (the "-d" 5889a804b5ceSGuilherme Maciel Ferreiraoption). Given an image built by mkimage, the dumpimage extracts a "data file" 5890a804b5ceSGuilherme Maciel Ferreirafrom the image: 5891a804b5ceSGuilherme Maciel Ferreira 5892f41f5b7cSGuilherme Maciel Ferreira tools/dumpimage -i image -T type -p position data_file 5893f41f5b7cSGuilherme Maciel Ferreira -i ==> extract from the 'image' a specific 'data_file' 5894f41f5b7cSGuilherme Maciel Ferreira -T ==> set image type to 'type' 5895f41f5b7cSGuilherme Maciel Ferreira -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image' 5896a804b5ceSGuilherme Maciel Ferreira 5897c609719bSwdenk 5898c609719bSwdenkInstalling a Linux Image: 5899c609719bSwdenk------------------------- 5900c609719bSwdenk 5901c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface, 5902c609719bSwdenkyou must convert the image to S-Record format: 5903c609719bSwdenk 5904c609719bSwdenk objcopy -I binary -O srec examples/image examples/image.srec 5905c609719bSwdenk 5906c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot 5907c609719bSwdenkimage header, so the resulting S-Record file will be relative to 5908c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to 5909c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads' 5910c609719bSwdenkcommand. 5911c609719bSwdenk 5912c609719bSwdenkExample: install the image to address 0x40100000 (which on the 5913c609719bSwdenkTQM8xxL is in the first Flash bank): 5914c609719bSwdenk 5915c609719bSwdenk => erase 40100000 401FFFFF 5916c609719bSwdenk 5917c609719bSwdenk .......... done 5918c609719bSwdenk Erased 8 sectors 5919c609719bSwdenk 5920c609719bSwdenk => loads 40100000 5921c609719bSwdenk ## Ready for S-Record download ... 5922c609719bSwdenk ~>examples/image.srec 5923c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 12 13 ... 5924c609719bSwdenk ... 5925c609719bSwdenk 15989 15990 15991 15992 5926c609719bSwdenk [file transfer complete] 5927c609719bSwdenk [connected] 5928c609719bSwdenk ## Start Addr = 0x00000000 5929c609719bSwdenk 5930c609719bSwdenk 5931c609719bSwdenkYou can check the success of the download using the 'iminfo' command; 5932c609719bSwdenkthis includes a checksum verification so you can be sure no data 5933c609719bSwdenkcorruption happened: 5934c609719bSwdenk 5935c609719bSwdenk => imi 40100000 5936c609719bSwdenk 5937c609719bSwdenk ## Checking Image at 40100000 ... 5938c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 5939c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 5940c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 5941c609719bSwdenk Load Address: 00000000 5942c609719bSwdenk Entry Point: 0000000c 5943c609719bSwdenk Verifying Checksum ... OK 5944c609719bSwdenk 5945c609719bSwdenk 5946c609719bSwdenkBoot Linux: 5947c609719bSwdenk----------- 5948c609719bSwdenk 5949c609719bSwdenkThe "bootm" command is used to boot an application that is stored in 5950c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents 5951c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as 5952c609719bSwdenkparameters. You can check and modify this variable using the 5953c609719bSwdenk"printenv" and "setenv" commands: 5954c609719bSwdenk 5955c609719bSwdenk 5956c609719bSwdenk => printenv bootargs 5957c609719bSwdenk bootargs=root=/dev/ram 5958c609719bSwdenk 5959c609719bSwdenk => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 5960c609719bSwdenk 5961c609719bSwdenk => printenv bootargs 5962c609719bSwdenk bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 5963c609719bSwdenk 5964c609719bSwdenk => bootm 40020000 5965c609719bSwdenk ## Booting Linux kernel at 40020000 ... 5966c609719bSwdenk Image Name: 2.2.13 for NFS on TQM850L 5967c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 5968c609719bSwdenk Data Size: 381681 Bytes = 372 kB = 0 MB 5969c609719bSwdenk Load Address: 00000000 5970c609719bSwdenk Entry Point: 0000000c 5971c609719bSwdenk Verifying Checksum ... OK 5972c609719bSwdenk Uncompressing Kernel Image ... OK 5973c609719bSwdenk 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 5974c609719bSwdenk Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 5975c609719bSwdenk time_init: decrementer frequency = 187500000/60 5976c609719bSwdenk Calibrating delay loop... 49.77 BogoMIPS 5977c609719bSwdenk Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000] 5978c609719bSwdenk ... 5979c609719bSwdenk 598011ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass 59817152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT 5982c609719bSwdenkformat!) to the "bootm" command: 5983c609719bSwdenk 5984c609719bSwdenk => imi 40100000 40200000 5985c609719bSwdenk 5986c609719bSwdenk ## Checking Image at 40100000 ... 5987c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 5988c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 5989c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 5990c609719bSwdenk Load Address: 00000000 5991c609719bSwdenk Entry Point: 0000000c 5992c609719bSwdenk Verifying Checksum ... OK 5993c609719bSwdenk 5994c609719bSwdenk ## Checking Image at 40200000 ... 5995c609719bSwdenk Image Name: Simple Ramdisk Image 5996c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 5997c609719bSwdenk Data Size: 566530 Bytes = 553 kB = 0 MB 5998c609719bSwdenk Load Address: 00000000 5999c609719bSwdenk Entry Point: 00000000 6000c609719bSwdenk Verifying Checksum ... OK 6001c609719bSwdenk 6002c609719bSwdenk => bootm 40100000 40200000 6003c609719bSwdenk ## Booting Linux kernel at 40100000 ... 6004c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 6005c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 6006c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 6007c609719bSwdenk Load Address: 00000000 6008c609719bSwdenk Entry Point: 0000000c 6009c609719bSwdenk Verifying Checksum ... OK 6010c609719bSwdenk Uncompressing Kernel Image ... OK 6011c609719bSwdenk ## Loading RAMDisk Image at 40200000 ... 6012c609719bSwdenk Image Name: Simple Ramdisk Image 6013c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 6014c609719bSwdenk Data Size: 566530 Bytes = 553 kB = 0 MB 6015c609719bSwdenk Load Address: 00000000 6016c609719bSwdenk Entry Point: 00000000 6017c609719bSwdenk Verifying Checksum ... OK 6018c609719bSwdenk Loading Ramdisk ... OK 6019c609719bSwdenk 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 6020c609719bSwdenk Boot arguments: root=/dev/ram 6021c609719bSwdenk time_init: decrementer frequency = 187500000/60 6022c609719bSwdenk Calibrating delay loop... 49.77 BogoMIPS 6023c609719bSwdenk ... 6024c609719bSwdenk RAMDISK: Compressed image found at block 0 6025c609719bSwdenk VFS: Mounted root (ext2 filesystem). 6026c609719bSwdenk 6027c609719bSwdenk bash# 6028c609719bSwdenk 60290267768eSMatthew McClintockBoot Linux and pass a flat device tree: 60300267768eSMatthew McClintock----------- 60310267768eSMatthew McClintock 60320267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section 60330267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The 60340267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated 60350267768eSMatthew McClintockflat device tree: 60360267768eSMatthew McClintock 60370267768eSMatthew McClintock=> print oftaddr 60380267768eSMatthew McClintockoftaddr=0x300000 60390267768eSMatthew McClintock=> print oft 60400267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb 60410267768eSMatthew McClintock=> tftp $oftaddr $oft 60420267768eSMatthew McClintockSpeed: 1000, full duplex 60430267768eSMatthew McClintockUsing TSEC0 device 60440267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101 60450267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'. 60460267768eSMatthew McClintockLoad address: 0x300000 60470267768eSMatthew McClintockLoading: # 60480267768eSMatthew McClintockdone 60490267768eSMatthew McClintockBytes transferred = 4106 (100a hex) 60500267768eSMatthew McClintock=> tftp $loadaddr $bootfile 60510267768eSMatthew McClintockSpeed: 1000, full duplex 60520267768eSMatthew McClintockUsing TSEC0 device 60530267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2 60540267768eSMatthew McClintockFilename 'uImage'. 60550267768eSMatthew McClintockLoad address: 0x200000 60560267768eSMatthew McClintockLoading:############ 60570267768eSMatthew McClintockdone 60580267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex) 60590267768eSMatthew McClintock=> print loadaddr 60600267768eSMatthew McClintockloadaddr=200000 60610267768eSMatthew McClintock=> print oftaddr 60620267768eSMatthew McClintockoftaddr=0x300000 60630267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr 60640267768eSMatthew McClintock## Booting image at 00200000 ... 60650267768eSMatthew McClintock Image Name: Linux-2.6.17-dirty 60660267768eSMatthew McClintock Image Type: PowerPC Linux Kernel Image (gzip compressed) 60670267768eSMatthew McClintock Data Size: 1029343 Bytes = 1005.2 kB 60680267768eSMatthew McClintock Load Address: 00000000 60690267768eSMatthew McClintock Entry Point: 00000000 60700267768eSMatthew McClintock Verifying Checksum ... OK 60710267768eSMatthew McClintock Uncompressing Kernel Image ... OK 60720267768eSMatthew McClintockBooting using flat device tree at 0x300000 60730267768eSMatthew McClintockUsing MPC85xx ADS machine description 60740267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb 60750267768eSMatthew McClintock[snip] 60760267768eSMatthew McClintock 60770267768eSMatthew McClintock 60786069ff26SwdenkMore About U-Boot Image Types: 60796069ff26Swdenk------------------------------ 60806069ff26Swdenk 60816069ff26SwdenkU-Boot supports the following image types: 60826069ff26Swdenk 60836069ff26Swdenk "Standalone Programs" are directly runnable in the environment 60846069ff26Swdenk provided by U-Boot; it is expected that (if they behave 60856069ff26Swdenk well) you can continue to work in U-Boot after return from 60866069ff26Swdenk the Standalone Program. 60876069ff26Swdenk "OS Kernel Images" are usually images of some Embedded OS which 60886069ff26Swdenk will take over control completely. Usually these programs 60896069ff26Swdenk will install their own set of exception handlers, device 60906069ff26Swdenk drivers, set up the MMU, etc. - this means, that you cannot 60916069ff26Swdenk expect to re-enter U-Boot except by resetting the CPU. 60926069ff26Swdenk "RAMDisk Images" are more or less just data blocks, and their 60936069ff26Swdenk parameters (address, size) are passed to an OS kernel that is 60946069ff26Swdenk being started. 60956069ff26Swdenk "Multi-File Images" contain several images, typically an OS 60966069ff26Swdenk (Linux) kernel image and one or more data images like 60976069ff26Swdenk RAMDisks. This construct is useful for instance when you want 60986069ff26Swdenk to boot over the network using BOOTP etc., where the boot 60996069ff26Swdenk server provides just a single image file, but you want to get 61006069ff26Swdenk for instance an OS kernel and a RAMDisk image. 61016069ff26Swdenk 61026069ff26Swdenk "Multi-File Images" start with a list of image sizes, each 61036069ff26Swdenk image size (in bytes) specified by an "uint32_t" in network 61046069ff26Swdenk byte order. This list is terminated by an "(uint32_t)0". 61056069ff26Swdenk Immediately after the terminating 0 follow the images, one by 61066069ff26Swdenk one, all aligned on "uint32_t" boundaries (size rounded up to 61076069ff26Swdenk a multiple of 4 bytes). 61086069ff26Swdenk 61096069ff26Swdenk "Firmware Images" are binary images containing firmware (like 61106069ff26Swdenk U-Boot or FPGA images) which usually will be programmed to 61116069ff26Swdenk flash memory. 61126069ff26Swdenk 61136069ff26Swdenk "Script files" are command sequences that will be executed by 61146069ff26Swdenk U-Boot's command interpreter; this feature is especially 61156069ff26Swdenk useful when you configure U-Boot to use a real shell (hush) 61166069ff26Swdenk as command interpreter. 61176069ff26Swdenk 611844f074c7SMarek VasutBooting the Linux zImage: 611944f074c7SMarek Vasut------------------------- 612044f074c7SMarek Vasut 612144f074c7SMarek VasutOn some platforms, it's possible to boot Linux zImage. This is done 612244f074c7SMarek Vasutusing the "bootz" command. The syntax of "bootz" command is the same 612344f074c7SMarek Vasutas the syntax of "bootm" command. 612444f074c7SMarek Vasut 61258ac28563STom RiniNote, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply 6126017e1f3fSMarek Vasutkernel with raw initrd images. The syntax is slightly different, the 6127017e1f3fSMarek Vasutaddress of the initrd must be augmented by it's size, in the following 6128017e1f3fSMarek Vasutformat: "<initrd addres>:<initrd size>". 6129017e1f3fSMarek Vasut 6130c609719bSwdenk 6131c609719bSwdenkStandalone HOWTO: 6132c609719bSwdenk================= 6133c609719bSwdenk 6134c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and 6135c609719bSwdenkrun "standalone" applications, which can use some resources of 6136c609719bSwdenkU-Boot like console I/O functions or interrupt services. 6137c609719bSwdenk 6138c609719bSwdenkTwo simple examples are included with the sources: 6139c609719bSwdenk 6140c609719bSwdenk"Hello World" Demo: 6141c609719bSwdenk------------------- 6142c609719bSwdenk 6143c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo 6144c609719bSwdenkapplication; it is automatically compiled when you build U-Boot. 6145c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it 6146c609719bSwdenklike that: 6147c609719bSwdenk 6148c609719bSwdenk => loads 6149c609719bSwdenk ## Ready for S-Record download ... 6150c609719bSwdenk ~>examples/hello_world.srec 6151c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 ... 6152c609719bSwdenk [file transfer complete] 6153c609719bSwdenk [connected] 6154c609719bSwdenk ## Start Addr = 0x00040004 6155c609719bSwdenk 6156c609719bSwdenk => go 40004 Hello World! This is a test. 6157c609719bSwdenk ## Starting application at 0x00040004 ... 6158c609719bSwdenk Hello World 6159c609719bSwdenk argc = 7 6160c609719bSwdenk argv[0] = "40004" 6161c609719bSwdenk argv[1] = "Hello" 6162c609719bSwdenk argv[2] = "World!" 6163c609719bSwdenk argv[3] = "This" 6164c609719bSwdenk argv[4] = "is" 6165c609719bSwdenk argv[5] = "a" 6166c609719bSwdenk argv[6] = "test." 6167c609719bSwdenk argv[7] = "<NULL>" 6168c609719bSwdenk Hit any key to exit ... 6169c609719bSwdenk 6170c609719bSwdenk ## Application terminated, rc = 0x0 6171c609719bSwdenk 6172c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt 6173c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'. 6174c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second. 6175c609719bSwdenkThe interrupt service routine is trivial, just printing a '.' 6176c609719bSwdenkcharacter, but this is just a demo program. The application can be 6177c609719bSwdenkcontrolled by the following keys: 6178c609719bSwdenk 6179c609719bSwdenk ? - print current values og the CPM Timer registers 6180c609719bSwdenk b - enable interrupts and start timer 6181c609719bSwdenk e - stop timer and disable interrupts 6182c609719bSwdenk q - quit application 6183c609719bSwdenk 6184c609719bSwdenk => loads 6185c609719bSwdenk ## Ready for S-Record download ... 6186c609719bSwdenk ~>examples/timer.srec 6187c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 ... 6188c609719bSwdenk [file transfer complete] 6189c609719bSwdenk [connected] 6190c609719bSwdenk ## Start Addr = 0x00040004 6191c609719bSwdenk 6192c609719bSwdenk => go 40004 6193c609719bSwdenk ## Starting application at 0x00040004 ... 6194c609719bSwdenk TIMERS=0xfff00980 6195c609719bSwdenk Using timer 1 6196c609719bSwdenk tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0 6197c609719bSwdenk 6198c609719bSwdenkHit 'b': 6199c609719bSwdenk [q, b, e, ?] Set interval 1000000 us 6200c609719bSwdenk Enabling timer 6201c609719bSwdenkHit '?': 6202c609719bSwdenk [q, b, e, ?] ........ 6203c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0 6204c609719bSwdenkHit '?': 6205c609719bSwdenk [q, b, e, ?] . 6206c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0 6207c609719bSwdenkHit '?': 6208c609719bSwdenk [q, b, e, ?] . 6209c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0 6210c609719bSwdenkHit '?': 6211c609719bSwdenk [q, b, e, ?] . 6212c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0 6213c609719bSwdenkHit 'e': 6214c609719bSwdenk [q, b, e, ?] ...Stopping timer 6215c609719bSwdenkHit 'q': 6216c609719bSwdenk [q, b, e, ?] ## Application terminated, rc = 0x0 6217c609719bSwdenk 6218c609719bSwdenk 621985ec0bccSwdenkMinicom warning: 622085ec0bccSwdenk================ 622185ec0bccSwdenk 62227152b1d0SwdenkOver time, many people have reported problems when trying to use the 622385ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd) 622485ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under 6225f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and 622685ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and 6227e53515a2SKarl O. Pincuse "cu" for S-Record download ("loads" command). See 6228e53515a2SKarl O. Pinchttp://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3. 6229e53515a2SKarl O. Pincfor help with kermit. 6230e53515a2SKarl O. Pinc 623185ec0bccSwdenk 623252f52c14SwdenkNevertheless, if you absolutely want to use it try adding this 623352f52c14Swdenkconfiguration to your "File transfer protocols" section: 623452f52c14Swdenk 623552f52c14Swdenk Name Program Name U/D FullScr IO-Red. Multi 623652f52c14Swdenk X kermit /usr/bin/kermit -i -l %l -s Y U Y N N 623752f52c14Swdenk Y kermit /usr/bin/kermit -i -l %l -r N D Y N N 623852f52c14Swdenk 623952f52c14Swdenk 6240c609719bSwdenkNetBSD Notes: 6241c609719bSwdenk============= 6242c609719bSwdenk 6243c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host 6244c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx). 6245c609719bSwdenk 6246c609719bSwdenkBuilding requires a cross environment; it is known to work on 6247c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also 6248c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make). 6249c609719bSwdenkNote that the cross-powerpc package does not install include files; 6250c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is 6251c609719bSwdenkmissing. This file has to be installed and patched manually: 6252c609719bSwdenk 6253c609719bSwdenk # cd /usr/pkg/cross/powerpc-netbsd/include 6254c609719bSwdenk # mkdir powerpc 6255c609719bSwdenk # ln -s powerpc machine 6256c609719bSwdenk # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h 6257c609719bSwdenk # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST 6258c609719bSwdenk 6259c609719bSwdenkNative builds *don't* work due to incompatibilities between native 6260c609719bSwdenkand U-Boot include files. 6261c609719bSwdenk 6262c609719bSwdenkBooting assumes that (the first part of) the image booted is a 6263c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel 6264c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source 6265c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the 62662a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz 6267c609719bSwdenk 6268c609719bSwdenk 6269c609719bSwdenkImplementation Internals: 6270c609719bSwdenk========================= 6271c609719bSwdenk 6272c609719bSwdenkThe following is not intended to be a complete description of every 6273c609719bSwdenkimplementation detail. However, it should help to understand the 6274c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom 6275c609719bSwdenkhardware. 6276c609719bSwdenk 6277c609719bSwdenk 6278c609719bSwdenkInitial Stack, Global Data: 6279c609719bSwdenk--------------------------- 6280c609719bSwdenk 6281c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot 6282c609719bSwdenkstarts running out of ROM (flash memory), usually without access to 6283c609719bSwdenksystem RAM (because the memory controller is not initialized yet). 6284c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS 6285c609719bSwdenkis not initialized as zero. To be able to get a C environment working 6286c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation 6287c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU 6288c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and 6289c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be 6290c609719bSwdenklocked as (mis-) used as memory, etc. 6291c609719bSwdenk 62927152b1d0Swdenk Chris Hallinan posted a good summary of these issues to the 62930668236bSWolfgang Denk U-Boot mailing list: 629443d9616cSwdenk 629543d9616cSwdenk Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)? 629643d9616cSwdenk From: "Chris Hallinan" <clh@net1plus.com> 629743d9616cSwdenk Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET) 629843d9616cSwdenk ... 629943d9616cSwdenk 630043d9616cSwdenk Correct me if I'm wrong, folks, but the way I understand it 630143d9616cSwdenk is this: Using DCACHE as initial RAM for Stack, etc, does not 630243d9616cSwdenk require any physical RAM backing up the cache. The cleverness 630343d9616cSwdenk is that the cache is being used as a temporary supply of 630443d9616cSwdenk necessary storage before the SDRAM controller is setup. It's 630511ccc33fSMarcel Ziswiler beyond the scope of this list to explain the details, but you 630643d9616cSwdenk can see how this works by studying the cache architecture and 630743d9616cSwdenk operation in the architecture and processor-specific manuals. 630843d9616cSwdenk 630943d9616cSwdenk OCM is On Chip Memory, which I believe the 405GP has 4K. It 631043d9616cSwdenk is another option for the system designer to use as an 631111ccc33fSMarcel Ziswiler initial stack/RAM area prior to SDRAM being available. Either 631243d9616cSwdenk option should work for you. Using CS 4 should be fine if your 631343d9616cSwdenk board designers haven't used it for something that would 631443d9616cSwdenk cause you grief during the initial boot! It is frequently not 631543d9616cSwdenk used. 631643d9616cSwdenk 63176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere 631843d9616cSwdenk with your processor/board/system design. The default value 631943d9616cSwdenk you will find in any recent u-boot distribution in 63208a316c9bSStefan Roese walnut.h should work for you. I'd set it to a value larger 632143d9616cSwdenk than your SDRAM module. If you have a 64MB SDRAM module, set 632243d9616cSwdenk it above 400_0000. Just make sure your board has no resources 632343d9616cSwdenk that are supposed to respond to that address! That code in 632443d9616cSwdenk start.S has been around a while and should work as is when 632543d9616cSwdenk you get the config right. 632643d9616cSwdenk 632743d9616cSwdenk -Chris Hallinan 632843d9616cSwdenk DS4.COM, Inc. 632943d9616cSwdenk 6330c609719bSwdenkIt is essential to remember this, since it has some impact on the C 6331c609719bSwdenkcode for the initialization procedures: 6332c609719bSwdenk 6333c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt 6334c609719bSwdenk to write it. 6335c609719bSwdenk 6336b445bbb4SJeremiah Mahler* Do not use any uninitialized global data (or implicitly initialized 6337c609719bSwdenk as zero data - BSS segment) at all - this is undefined, initiali- 63387152b1d0Swdenk zation is performed later (when relocating to RAM). 6339c609719bSwdenk 6340c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like 6341c609719bSwdenk that. 6342c609719bSwdenk 6343c609719bSwdenkHaving only the stack as writable memory limits means we cannot use 6344b445bbb4SJeremiah Mahlernormal global data to share information between the code. But it 6345c609719bSwdenkturned out that the implementation of U-Boot can be greatly 6346c609719bSwdenksimplified by making a global data structure (gd_t) available to all 6347c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_ 6348c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of 6349c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we 6350c609719bSwdenkplace a pointer (gd) to the global data into a register which we 6351c609719bSwdenkreserve for this purpose. 6352c609719bSwdenk 63537152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the 6354c609719bSwdenkrelevant (E)ABI specifications for the current architecture, and by 6355c609719bSwdenkGCC's implementation. 6356c609719bSwdenk 6357c609719bSwdenkFor PowerPC, the following registers have specific use: 6358c609719bSwdenk R1: stack pointer 6359e7670f6cSWolfgang Denk R2: reserved for system use 6360c609719bSwdenk R3-R4: parameter passing and return values 6361c609719bSwdenk R5-R10: parameter passing 6362c609719bSwdenk R13: small data area pointer 6363c609719bSwdenk R30: GOT pointer 6364c609719bSwdenk R31: frame pointer 6365c609719bSwdenk 6366e6bee808SJoakim Tjernlund (U-Boot also uses R12 as internal GOT pointer. r12 6367e6bee808SJoakim Tjernlund is a volatile register so r12 needs to be reset when 6368e6bee808SJoakim Tjernlund going back and forth between asm and C) 6369c609719bSwdenk 6370e7670f6cSWolfgang Denk ==> U-Boot will use R2 to hold a pointer to the global data 6371c609719bSwdenk 6372c609719bSwdenk Note: on PPC, we could use a static initializer (since the 6373c609719bSwdenk address of the global data structure is known at compile time), 6374c609719bSwdenk but it turned out that reserving a register results in somewhat 6375c609719bSwdenk smaller code - although the code savings are not that big (on 6376c609719bSwdenk average for all boards 752 bytes for the whole U-Boot image, 6377c609719bSwdenk 624 text + 127 data). 6378c609719bSwdenk 6379c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here: 63804c58eb55SMike Frysinger http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface 63814c58eb55SMike Frysinger 6382c4db335cSRobin Getz ==> U-Boot will use P3 to hold a pointer to the global data 63834c58eb55SMike Frysinger 6384c609719bSwdenkOn ARM, the following registers are used: 6385c609719bSwdenk 6386c609719bSwdenk R0: function argument word/integer result 6387c609719bSwdenk R1-R3: function argument word 638812eba1b4SJeroen Hofstee R9: platform specific 638912eba1b4SJeroen Hofstee R10: stack limit (used only if stack checking is enabled) 6390c609719bSwdenk R11: argument (frame) pointer 6391c609719bSwdenk R12: temporary workspace 6392c609719bSwdenk R13: stack pointer 6393c609719bSwdenk R14: link register 6394c609719bSwdenk R15: program counter 6395c609719bSwdenk 639612eba1b4SJeroen Hofstee ==> U-Boot will use R9 to hold a pointer to the global data 639712eba1b4SJeroen Hofstee 639812eba1b4SJeroen Hofstee Note: on ARM, only R_ARM_RELATIVE relocations are supported. 6399c609719bSwdenk 64000df01fd3SThomas ChouOn Nios II, the ABI is documented here: 64010df01fd3SThomas Chou http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf 64020df01fd3SThomas Chou 64030df01fd3SThomas Chou ==> U-Boot will use gp to hold a pointer to the global data 64040df01fd3SThomas Chou 64050df01fd3SThomas Chou Note: on Nios II, we give "-G0" option to gcc and don't use gp 64060df01fd3SThomas Chou to access small data sections, so gp is free. 64070df01fd3SThomas Chou 6408afc1ce82SMacpaul LinOn NDS32, the following registers are used: 6409afc1ce82SMacpaul Lin 6410afc1ce82SMacpaul Lin R0-R1: argument/return 6411afc1ce82SMacpaul Lin R2-R5: argument 6412afc1ce82SMacpaul Lin R15: temporary register for assembler 6413afc1ce82SMacpaul Lin R16: trampoline register 6414afc1ce82SMacpaul Lin R28: frame pointer (FP) 6415afc1ce82SMacpaul Lin R29: global pointer (GP) 6416afc1ce82SMacpaul Lin R30: link register (LP) 6417afc1ce82SMacpaul Lin R31: stack pointer (SP) 6418afc1ce82SMacpaul Lin PC: program counter (PC) 6419afc1ce82SMacpaul Lin 6420afc1ce82SMacpaul Lin ==> U-Boot will use R10 to hold a pointer to the global data 6421afc1ce82SMacpaul Lin 6422d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope, 6423d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much. 6424c609719bSwdenk 6425c609719bSwdenkMemory Management: 6426c609719bSwdenk------------------ 6427c609719bSwdenk 6428c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the 6429c609719bSwdenkMMU is not used either for address mapping nor for memory protection. 6430c609719bSwdenk 6431c609719bSwdenkThe available memory is mapped to fixed addresses using the memory 6432c609719bSwdenkcontroller. In this process, a contiguous block is formed for each 6433c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several 6434c609719bSwdenkphysical memory banks. 6435c609719bSwdenk 6436c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on 6437c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After 6438c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself 6439c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some 64406d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN 6441c609719bSwdenkconfiguration setting]. Below that, a structure with global Board 6442c609719bSwdenkInfo data is placed, followed by the stack (growing downward). 6443c609719bSwdenk 6444c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB 6445c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF). 6446c609719bSwdenk 6447c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like 6448c609719bSwdenkthis: 6449c609719bSwdenk 6450c609719bSwdenk 0x0000 0000 Exception Vector code 6451c609719bSwdenk : 6452c609719bSwdenk 0x0000 1FFF 6453c609719bSwdenk 0x0000 2000 Free for Application Use 6454c609719bSwdenk : 6455c609719bSwdenk : 6456c609719bSwdenk 6457c609719bSwdenk : 6458c609719bSwdenk : 6459c609719bSwdenk 0x00FB FF20 Monitor Stack (Growing downward) 6460c609719bSwdenk 0x00FB FFAC Board Info Data and permanent copy of global data 6461c609719bSwdenk 0x00FC 0000 Malloc Arena 6462c609719bSwdenk : 6463c609719bSwdenk 0x00FD FFFF 6464c609719bSwdenk 0x00FE 0000 RAM Copy of Monitor Code 6465c609719bSwdenk ... eventually: LCD or video framebuffer 6466c609719bSwdenk ... eventually: pRAM (Protected RAM - unchanged by reset) 6467c609719bSwdenk 0x00FF FFFF [End of RAM] 6468c609719bSwdenk 6469c609719bSwdenk 6470c609719bSwdenkSystem Initialization: 6471c609719bSwdenk---------------------- 6472c609719bSwdenk 6473c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point 647411ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset 6475c609719bSwdenkconfiguration for CS0# this is a mirror of the on board Flash memory. 64767152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address. 6477c609719bSwdenkTo be able to implement the initialization code in C, a (small!) 6478c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs 6479c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked 6480c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core, 6481c609719bSwdenkthe caches and the SIU. 6482c609719bSwdenk 6483c609719bSwdenkNext, all (potentially) available memory banks are mapped using a 6484c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries 6485c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash 6486c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is 6487c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a 6488c609719bSwdenksimple memory test is run that determines the size of the SDRAM 6489c609719bSwdenkbanks. 6490c609719bSwdenk 6491c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of 64927152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first 6493c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address 6494c609719bSwdenk0x00000000, with any additional banks following immediately to create 6495c609719bSwdenkcontiguous memory starting from 0. 6496c609719bSwdenk 6497c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area 6498c609719bSwdenkand allocates memory for use by malloc() and for the global Board 6499c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM 6500c609719bSwdenkpages, and the final stack is set up. 6501c609719bSwdenk 6502c609719bSwdenkOnly after this relocation will you have a "normal" C environment; 6503c609719bSwdenkuntil that you are restricted in several ways, mostly because you are 6504c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a 6505c609719bSwdenknew address in RAM. 6506c609719bSwdenk 6507c609719bSwdenk 6508c609719bSwdenkU-Boot Porting Guide: 6509c609719bSwdenk---------------------- 6510c609719bSwdenk 6511c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing 65126aff3115Swdenklist, October 2002] 6513c609719bSwdenk 6514c609719bSwdenk 6515c609719bSwdenkint main(int argc, char *argv[]) 6516c609719bSwdenk{ 6517c609719bSwdenk sighandler_t no_more_time; 6518c609719bSwdenk 6519c609719bSwdenk signal(SIGALRM, no_more_time); 6520c609719bSwdenk alarm(PROJECT_DEADLINE - toSec (3 * WEEK)); 6521c609719bSwdenk 6522c609719bSwdenk if (available_money > available_manpower) { 65236c3fef28SJerry Van Baren Pay consultant to port U-Boot; 6524c609719bSwdenk return 0; 6525c609719bSwdenk } 6526c609719bSwdenk 6527c609719bSwdenk Download latest U-Boot source; 6528c609719bSwdenk 65290668236bSWolfgang Denk Subscribe to u-boot mailing list; 65306aff3115Swdenk 65316c3fef28SJerry Van Baren if (clueless) 6532c609719bSwdenk email("Hi, I am new to U-Boot, how do I get started?"); 6533c609719bSwdenk 6534c609719bSwdenk while (learning) { 6535c609719bSwdenk Read the README file in the top level directory; 65367cb22f97Swdenk Read http://www.denx.de/twiki/bin/view/DULG/Manual; 65376c3fef28SJerry Van Baren Read applicable doc/*.README; 6538c609719bSwdenk Read the source, Luke; 65396c3fef28SJerry Van Baren /* find . -name "*.[chS]" | xargs grep -i <keyword> */ 6540c609719bSwdenk } 6541c609719bSwdenk 65426c3fef28SJerry Van Baren if (available_money > toLocalCurrency ($2500)) 65436c3fef28SJerry Van Baren Buy a BDI3000; 65446c3fef28SJerry Van Baren else 6545c609719bSwdenk Add a lot of aggravation and time; 6546c609719bSwdenk 65476c3fef28SJerry Van Baren if (a similar board exists) { /* hopefully... */ 65486c3fef28SJerry Van Baren cp -a board/<similar> board/<myboard> 65496c3fef28SJerry Van Baren cp include/configs/<similar>.h include/configs/<myboard>.h 65506c3fef28SJerry Van Baren } else { 6551c609719bSwdenk Create your own board support subdirectory; 65526c3fef28SJerry Van Baren Create your own board include/configs/<myboard>.h file; 65536c3fef28SJerry Van Baren } 65546c3fef28SJerry Van Baren Edit new board/<myboard> files 65556c3fef28SJerry Van Baren Edit new include/configs/<myboard>.h 6556c609719bSwdenk 65576c3fef28SJerry Van Baren while (!accepted) { 6558c609719bSwdenk while (!running) { 6559c609719bSwdenk do { 6560c609719bSwdenk Add / modify source code; 6561c609719bSwdenk } until (compiles); 6562c609719bSwdenk Debug; 6563c609719bSwdenk if (clueless) 6564c609719bSwdenk email("Hi, I am having problems..."); 6565c609719bSwdenk } 65666c3fef28SJerry Van Baren Send patch file to the U-Boot email list; 65676c3fef28SJerry Van Baren if (reasonable critiques) 65686c3fef28SJerry Van Baren Incorporate improvements from email list code review; 65696c3fef28SJerry Van Baren else 65706c3fef28SJerry Van Baren Defend code as written; 65716c3fef28SJerry Van Baren } 6572c609719bSwdenk 6573c609719bSwdenk return 0; 6574c609719bSwdenk} 6575c609719bSwdenk 6576c609719bSwdenkvoid no_more_time (int sig) 6577c609719bSwdenk{ 6578c609719bSwdenk hire_a_guru(); 6579c609719bSwdenk} 6580c609719bSwdenk 6581c609719bSwdenk 6582c609719bSwdenkCoding Standards: 6583c609719bSwdenk----------------- 6584c609719bSwdenk 6585c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel 65862c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script 65877ca9296eSWolfgang Denk"scripts/Lindent" in your Linux kernel source directory. 6588c609719bSwdenk 65892c051651SDetlev ZundelSource files originating from a different project (for example the 65902c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not 6591b445bbb4SJeremiah Mahlerreformatted to ease subsequent migration to newer versions of those 65922c051651SDetlev Zundelsources. 65932c051651SDetlev Zundel 65942c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in 65952c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//) 65962c051651SDetlev Zundelin your code. 6597c609719bSwdenk 6598c178d3daSwdenkPlease also stick to the following formatting rules: 6599180d3f74Swdenk- remove any trailing white space 66007ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces 6601180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds 66027ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files 6603180d3f74Swdenk- do not add trailing empty lines to source files 6604180d3f74Swdenk 6605c609719bSwdenkSubmissions which do not conform to the standards may be returned 6606c609719bSwdenkwith a request to reformat the changes. 6607c609719bSwdenk 6608c609719bSwdenk 6609c609719bSwdenkSubmitting Patches: 6610c609719bSwdenk------------------- 6611c609719bSwdenk 6612c609719bSwdenkSince the number of patches for U-Boot is growing, we need to 6613c609719bSwdenkestablish some rules. Submissions which do not conform to these rules 6614c609719bSwdenkmay be rejected, even when they contain important and valuable stuff. 6615c609719bSwdenk 66160d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details. 6617218ca724SWolfgang Denk 66180668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>; 66190668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot 66200668236bSWolfgang Denk 6621c609719bSwdenkWhen you send a patch, please include the following information with 6622c609719bSwdenkit: 6623c609719bSwdenk 6624c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes 6625c609719bSwdenk this bug. Please try to include a way of demonstrating that the 6626c609719bSwdenk patch actually fixes something. 6627c609719bSwdenk 6628c609719bSwdenk* For new features: a description of the feature and your 6629c609719bSwdenk implementation. 6630c609719bSwdenk 6631c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch) 6632c609719bSwdenk 6633c609719bSwdenk* For major contributions, your entry to the CREDITS file 6634c609719bSwdenk 663527af930eSAlbert ARIBAUD* When you add support for a new board, don't forget to add a 663627af930eSAlbert ARIBAUD maintainer e-mail address to the boards.cfg file, too. 6637c609719bSwdenk 6638c609719bSwdenk* If your patch adds new configuration options, don't forget to 6639c609719bSwdenk document these in the README file. 6640c609719bSwdenk 6641218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly* 6642218ca724SWolfgang Denk recommended) you can easily generate the patch using the 66437ca9296eSWolfgang Denk "git format-patch". If you then use "git send-email" to send it to 6644218ca724SWolfgang Denk the U-Boot mailing list, you will avoid most of the common problems 6645218ca724SWolfgang Denk with some other mail clients. 6646c609719bSwdenk 6647218ca724SWolfgang Denk If you cannot use git, use "diff -purN OLD NEW". If your version of 6648218ca724SWolfgang Denk diff does not support these options, then get the latest version of 6649218ca724SWolfgang Denk GNU diff. 66506dff5529Swdenk 6651218ca724SWolfgang Denk The current directory when running this command shall be the parent 6652218ca724SWolfgang Denk directory of the U-Boot source tree (i. e. please make sure that 6653218ca724SWolfgang Denk your patch includes sufficient directory information for the 6654218ca724SWolfgang Denk affected files). 6655218ca724SWolfgang Denk 6656218ca724SWolfgang Denk We prefer patches as plain text. MIME attachments are discouraged, 6657218ca724SWolfgang Denk and compressed attachments must not be used. 6658c609719bSwdenk 665952f52c14Swdenk* If one logical set of modifications affects or creates several 666052f52c14Swdenk files, all these changes shall be submitted in a SINGLE patch file. 666152f52c14Swdenk 666252f52c14Swdenk* Changesets that contain different, unrelated modifications shall be 666352f52c14Swdenk submitted as SEPARATE patches, one patch per changeset. 666452f52c14Swdenk 666552f52c14Swdenk 6666c609719bSwdenkNotes: 6667c609719bSwdenk 6668c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched 6669c609719bSwdenk source tree and make sure that no errors or warnings are reported 6670c609719bSwdenk for any of the boards. 6671c609719bSwdenk 6672c609719bSwdenk* Keep your modifications to the necessary minimum: A patch 6673c609719bSwdenk containing several unrelated changes or arbitrary reformats will be 6674c609719bSwdenk returned with a request to re-formatting / split it. 6675c609719bSwdenk 6676c609719bSwdenk* If you modify existing code, make sure that your new code does not 6677c609719bSwdenk add to the memory footprint of the code ;-) Small is beautiful! 6678c609719bSwdenk When adding new features, these should compile conditionally only 6679c609719bSwdenk (using #ifdef), and the resulting code with the new feature 6680c609719bSwdenk disabled must not need more memory than the old code without your 6681c609719bSwdenk modification. 668290dc6704Swdenk 66830668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the 66840668236bSWolfgang Denk u-boot mailing list. Bigger patches will be moderated. If they are 66850668236bSWolfgang Denk reasonable and not too big, they will be acknowledged. But patches 66860668236bSWolfgang Denk bigger than the size limit should be avoided. 6687