1c609719bSwdenk# 23a473b2aSwdenk# (C) Copyright 2000 - 2004 3c609719bSwdenk# Wolfgang Denk, DENX Software Engineering, wd@denx.de. 4c609719bSwdenk# 5c609719bSwdenk# See file CREDITS for list of people who contributed to this 6c609719bSwdenk# project. 7c609719bSwdenk# 8c609719bSwdenk# This program is free software; you can redistribute it and/or 9c609719bSwdenk# modify it under the terms of the GNU General Public License as 10c609719bSwdenk# published by the Free Software Foundation; either version 2 of 11c609719bSwdenk# the License, or (at your option) any later version. 12c609719bSwdenk# 13c609719bSwdenk# This program is distributed in the hope that it will be useful, 14c609719bSwdenk# but WITHOUT ANY WARRANTY; without even the implied warranty of 15c609719bSwdenk# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16c609719bSwdenk# GNU General Public License for more details. 17c609719bSwdenk# 18c609719bSwdenk# You should have received a copy of the GNU General Public License 19c609719bSwdenk# along with this program; if not, write to the Free Software 20c609719bSwdenk# Foundation, Inc., 59 Temple Place, Suite 330, Boston, 21c609719bSwdenk# MA 02111-1307 USA 22c609719bSwdenk# 23c609719bSwdenk 24c609719bSwdenkSummary: 25c609719bSwdenk======== 26c609719bSwdenk 2724ee89b9SwdenkThis directory contains the source code for U-Boot, a boot loader for 2824ee89b9SwdenkEmbedded boards based on PowerPC and ARM processors, which can be 2924ee89b9Swdenkinstalled in a boot ROM and used to initialize and test the hardware 3024ee89b9Swdenkor to download and run application code. 31c609719bSwdenk 32c609719bSwdenkThe development of U-Boot is closely related to Linux: some parts of 3324ee89b9Swdenkthe source code originate in the Linux source tree, we have some 3424ee89b9Swdenkheader files in common, and special provision has been made to 35c609719bSwdenksupport booting of Linux images. 36c609719bSwdenk 37c609719bSwdenkSome attention has been paid to make this software easily 38c609719bSwdenkconfigurable and extendable. For instance, all monitor commands are 39c609719bSwdenkimplemented with the same call interface, so that it's very easy to 40c609719bSwdenkadd new commands. Also, instead of permanently adding rarely used 41c609719bSwdenkcode (for instance hardware test utilities) to the monitor, you can 42c609719bSwdenkload and run it dynamically. 43c609719bSwdenk 44c609719bSwdenk 45c609719bSwdenkStatus: 46c609719bSwdenk======= 47c609719bSwdenk 48c609719bSwdenkIn general, all boards for which a configuration option exists in the 49c609719bSwdenkMakefile have been tested to some extent and can be considered 50c609719bSwdenk"working". In fact, many of them are used in production systems. 51c609719bSwdenk 52c609719bSwdenkIn case of problems see the CHANGELOG and CREDITS files to find out 53c609719bSwdenkwho contributed the specific port. 54c609719bSwdenk 55c609719bSwdenk 56c609719bSwdenkWhere to get help: 57c609719bSwdenk================== 58c609719bSwdenk 59c609719bSwdenkIn case you have questions about, problems with or contributions for 60c609719bSwdenkU-Boot you should send a message to the U-Boot mailing list at 61c609719bSwdenk<u-boot-users@lists.sourceforge.net>. There is also an archive of 62c609719bSwdenkprevious traffic on the mailing list - please search the archive 63c609719bSwdenkbefore asking FAQ's. Please see 64c609719bSwdenkhttp://lists.sourceforge.net/lists/listinfo/u-boot-users/ 65c609719bSwdenk 66c609719bSwdenk 67c609719bSwdenkWhere we come from: 68c609719bSwdenk=================== 69c609719bSwdenk 70c609719bSwdenk- start from 8xxrom sources 7124ee89b9Swdenk- create PPCBoot project (http://sourceforge.net/projects/ppcboot) 72c609719bSwdenk- clean up code 73c609719bSwdenk- make it easier to add custom boards 74c609719bSwdenk- make it possible to add other [PowerPC] CPUs 75c609719bSwdenk- extend functions, especially: 76c609719bSwdenk * Provide extended interface to Linux boot loader 77c609719bSwdenk * S-Record download 78c609719bSwdenk * network boot 79c609719bSwdenk * PCMCIA / CompactFLash / ATA disk / SCSI ... boot 8024ee89b9Swdenk- create ARMBoot project (http://sourceforge.net/projects/armboot) 81c609719bSwdenk- add other CPU families (starting with ARM) 8224ee89b9Swdenk- create U-Boot project (http://sourceforge.net/projects/u-boot) 8324ee89b9Swdenk 8424ee89b9Swdenk 8524ee89b9SwdenkNames and Spelling: 8624ee89b9Swdenk=================== 8724ee89b9Swdenk 8824ee89b9SwdenkThe "official" name of this project is "Das U-Boot". The spelling 8924ee89b9Swdenk"U-Boot" shall be used in all written text (documentation, comments 9024ee89b9Swdenkin source files etc.). Example: 9124ee89b9Swdenk 9224ee89b9Swdenk This is the README file for the U-Boot project. 9324ee89b9Swdenk 9424ee89b9SwdenkFile names etc. shall be based on the string "u-boot". Examples: 9524ee89b9Swdenk 9624ee89b9Swdenk include/asm-ppc/u-boot.h 9724ee89b9Swdenk 9824ee89b9Swdenk #include <asm/u-boot.h> 9924ee89b9Swdenk 10024ee89b9SwdenkVariable names, preprocessor constants etc. shall be either based on 10124ee89b9Swdenkthe string "u_boot" or on "U_BOOT". Example: 10224ee89b9Swdenk 10324ee89b9Swdenk U_BOOT_VERSION u_boot_logo 10424ee89b9Swdenk IH_OS_U_BOOT u_boot_hush_start 105c609719bSwdenk 106c609719bSwdenk 10793f19cc0SwdenkVersioning: 10893f19cc0Swdenk=========== 10993f19cc0Swdenk 11093f19cc0SwdenkU-Boot uses a 3 level version number containing a version, a 11193f19cc0Swdenksub-version, and a patchlevel: "U-Boot-2.34.5" means version "2", 11293f19cc0Swdenksub-version "34", and patchlevel "4". 11393f19cc0Swdenk 11493f19cc0SwdenkThe patchlevel is used to indicate certain stages of development 11593f19cc0Swdenkbetween released versions, i. e. officially released versions of 11693f19cc0SwdenkU-Boot will always have a patchlevel of "0". 11793f19cc0Swdenk 11893f19cc0Swdenk 119c609719bSwdenkDirectory Hierarchy: 120c609719bSwdenk==================== 121c609719bSwdenk 1227152b1d0Swdenk- board Board dependent files 1237152b1d0Swdenk- common Misc architecture independent functions 124c609719bSwdenk- cpu CPU specific files 12511dadd54Swdenk - 74xx_7xx Files specific to Motorola MPC74xx and 7xx CPUs 12611dadd54Swdenk - arm720t Files specific to ARM 720 CPUs 12711dadd54Swdenk - arm920t Files specific to ARM 920 CPUs 12811dadd54Swdenk - arm925t Files specific to ARM 925 CPUs 12911dadd54Swdenk - arm926ejs Files specific to ARM 926 CPUs 13011dadd54Swdenk - at91rm9200 Files specific to Atmel AT91RM9200 CPUs 13111dadd54Swdenk - i386 Files specific to i386 CPUs 13211dadd54Swdenk - ixp Files specific to Intel XScale IXP CPUs 13311dadd54Swdenk - mcf52x2 Files specific to Motorola ColdFire MCF52x2 CPUs 13411dadd54Swdenk - mips Files specific to MIPS CPUs 13511dadd54Swdenk - mpc5xx Files specific to Motorola MPC5xx CPUs 13611dadd54Swdenk - mpc5xxx Files specific to Motorola MPC5xxx CPUs 13711dadd54Swdenk - mpc8xx Files specific to Motorola MPC8xx CPUs 13811dadd54Swdenk - mpc824x Files specific to Motorola MPC824x CPUs 13911dadd54Swdenk - mpc8260 Files specific to Motorola MPC8260 CPUs 14011dadd54Swdenk - mpc85xx Files specific to Motorola MPC85xx CPUs 14111dadd54Swdenk - nios Files specific to Altera NIOS CPUs 14211dadd54Swdenk - ppc4xx Files specific to IBM PowerPC 4xx CPUs 14311dadd54Swdenk - pxa Files specific to Intel XScale PXA CPUs 14411dadd54Swdenk - s3c44b0 Files specific to Samsung S3C44B0 CPUs 14511dadd54Swdenk - sa1100 Files specific to Intel StrongARM SA1100 CPUs 146c609719bSwdenk- disk Code for disk drive partition handling 147c609719bSwdenk- doc Documentation (don't expect too much) 1487152b1d0Swdenk- drivers Commonly used device drivers 149c609719bSwdenk- dtt Digital Thermometer and Thermostat drivers 150c609719bSwdenk- examples Example code for standalone applications, etc. 151c609719bSwdenk- include Header Files 15211dadd54Swdenk- lib_arm Files generic to ARM architecture 15311dadd54Swdenk- lib_generic Files generic to all architectures 15411dadd54Swdenk- lib_i386 Files generic to i386 architecture 15511dadd54Swdenk- lib_m68k Files generic to m68k architecture 15611dadd54Swdenk- lib_mips Files generic to MIPS architecture 15711dadd54Swdenk- lib_nios Files generic to NIOS architecture 15811dadd54Swdenk- lib_ppc Files generic to PowerPC architecture 159c609719bSwdenk- net Networking code 160c609719bSwdenk- post Power On Self Test 161c609719bSwdenk- rtc Real Time Clock drivers 162c609719bSwdenk- tools Tools to build S-Record or U-Boot images, etc. 163c609719bSwdenk 164c609719bSwdenkSoftware Configuration: 165c609719bSwdenk======================= 166c609719bSwdenk 167c609719bSwdenkConfiguration is usually done using C preprocessor defines; the 168c609719bSwdenkrationale behind that is to avoid dead code whenever possible. 169c609719bSwdenk 170c609719bSwdenkThere are two classes of configuration variables: 171c609719bSwdenk 172c609719bSwdenk* Configuration _OPTIONS_: 173c609719bSwdenk These are selectable by the user and have names beginning with 174c609719bSwdenk "CONFIG_". 175c609719bSwdenk 176c609719bSwdenk* Configuration _SETTINGS_: 177c609719bSwdenk These depend on the hardware etc. and should not be meddled with if 178c609719bSwdenk you don't know what you're doing; they have names beginning with 179c609719bSwdenk "CFG_". 180c609719bSwdenk 181c609719bSwdenkLater we will add a configuration tool - probably similar to or even 182c609719bSwdenkidentical to what's used for the Linux kernel. Right now, we have to 183c609719bSwdenkdo the configuration by hand, which means creating some symbolic 184c609719bSwdenklinks and editing some configuration files. We use the TQM8xxL boards 185c609719bSwdenkas an example here. 186c609719bSwdenk 187c609719bSwdenk 188c609719bSwdenkSelection of Processor Architecture and Board Type: 189c609719bSwdenk--------------------------------------------------- 190c609719bSwdenk 191c609719bSwdenkFor all supported boards there are ready-to-use default 192c609719bSwdenkconfigurations available; just type "make <board_name>_config". 193c609719bSwdenk 194c609719bSwdenkExample: For a TQM823L module type: 195c609719bSwdenk 196c609719bSwdenk cd u-boot 197c609719bSwdenk make TQM823L_config 198c609719bSwdenk 199c609719bSwdenkFor the Cogent platform, you need to specify the cpu type as well; 200c609719bSwdenke.g. "make cogent_mpc8xx_config". And also configure the cogent 201c609719bSwdenkdirectory according to the instructions in cogent/README. 202c609719bSwdenk 203c609719bSwdenk 204c609719bSwdenkConfiguration Options: 205c609719bSwdenk---------------------- 206c609719bSwdenk 207c609719bSwdenkConfiguration depends on the combination of board and CPU type; all 208c609719bSwdenksuch information is kept in a configuration file 209c609719bSwdenk"include/configs/<board_name>.h". 210c609719bSwdenk 211c609719bSwdenkExample: For a TQM823L module, all configuration settings are in 212c609719bSwdenk"include/configs/TQM823L.h". 213c609719bSwdenk 214c609719bSwdenk 2157f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux 2167f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to 2177f6c2cbcSwdenkbuild a config tool - later. 2187f6c2cbcSwdenk 2197f6c2cbcSwdenk 220c609719bSwdenkThe following options need to be configured: 221c609719bSwdenk 222c609719bSwdenk- CPU Type: Define exactly one of 223c609719bSwdenk 224c609719bSwdenk PowerPC based CPUs: 225c609719bSwdenk ------------------- 226c609719bSwdenk CONFIG_MPC823, CONFIG_MPC850, CONFIG_MPC855, CONFIG_MPC860 2270db5bca8Swdenk or CONFIG_MPC5xx 228c609719bSwdenk or CONFIG_MPC824X, CONFIG_MPC8260 22942d1f039Swdenk or CONFIG_MPC85xx 230c609719bSwdenk or CONFIG_IOP480 231c609719bSwdenk or CONFIG_405GP 23212f34241Swdenk or CONFIG_405EP 233c609719bSwdenk or CONFIG_440 234c609719bSwdenk or CONFIG_MPC74xx 23572755c71Swdenk or CONFIG_750FX 236c609719bSwdenk 237c609719bSwdenk ARM based CPUs: 238c609719bSwdenk --------------- 239c609719bSwdenk CONFIG_SA1110 240c609719bSwdenk CONFIG_ARM7 241c609719bSwdenk CONFIG_PXA250 242c609719bSwdenk 243507bbe3eSwdenk MicroBlaze based CPUs: 244507bbe3eSwdenk ---------------------- 245507bbe3eSwdenk CONFIG_MICROBLZE 246507bbe3eSwdenk 247c609719bSwdenk 248c609719bSwdenk- Board Type: Define exactly one of 249c609719bSwdenk 250c609719bSwdenk PowerPC based boards: 251c609719bSwdenk --------------------- 252c609719bSwdenk 253db01a2eaSwdenk CONFIG_ADCIOP, CONFIG_ADS860, CONFIG_AMX860, 254db01a2eaSwdenk CONFIG_AR405, CONFIG_BAB7xx, CONFIG_c2mon, 255db01a2eaSwdenk CONFIG_CANBT, CONFIG_CCM, CONFIG_CMI, 256db01a2eaSwdenk CONFIG_cogent_mpc8260, CONFIG_cogent_mpc8xx, CONFIG_CPCI405, 257db01a2eaSwdenk CONFIG_CPCI4052, CONFIG_CPCIISER4, CONFIG_CPU86, 258db01a2eaSwdenk CONFIG_CRAYL1, CONFIG_CU824, CONFIG_DASA_SIM, 259db01a2eaSwdenk CONFIG_DB64360, CONFIG_DB64460, CONFIG_DU405, 260db01a2eaSwdenk CONFIG_DUET_ADS, CONFIG_EBONY, CONFIG_ELPPC, 261db01a2eaSwdenk CONFIG_ELPT860, CONFIG_ep8260, CONFIG_ERIC, 262db01a2eaSwdenk CONFIG_ESTEEM192E, CONFIG_ETX094, CONFIG_EVB64260, 263db01a2eaSwdenk CONFIG_FADS823, CONFIG_FADS850SAR, CONFIG_FADS860T, 264db01a2eaSwdenk CONFIG_FLAGADM, CONFIG_FPS850L, CONFIG_FPS860L, 265db01a2eaSwdenk CONFIG_GEN860T, CONFIG_GENIETV, CONFIG_GTH, 266db01a2eaSwdenk CONFIG_gw8260, CONFIG_hermes, CONFIG_hymod, 267db01a2eaSwdenk CONFIG_IAD210, CONFIG_ICU862, CONFIG_IP860, 268db01a2eaSwdenk CONFIG_IPHASE4539, CONFIG_IVML24, CONFIG_IVML24_128, 269db01a2eaSwdenk CONFIG_IVML24_256, CONFIG_IVMS8, CONFIG_IVMS8_128, 270db01a2eaSwdenk CONFIG_IVMS8_256, CONFIG_JSE, CONFIG_LANTEC, 271db01a2eaSwdenk CONFIG_lwmon, CONFIG_MBX, CONFIG_MBX860T, 272db01a2eaSwdenk CONFIG_MHPC, CONFIG_MIP405, CONFIG_MOUSSE, 273db01a2eaSwdenk CONFIG_MPC8260ADS, CONFIG_MPC8540ADS, CONFIG_MPC8560ADS, 274db01a2eaSwdenk CONFIG_MUSENKI, CONFIG_MVS1, CONFIG_NETPHONE, 275db01a2eaSwdenk CONFIG_NETTA, CONFIG_NETVIA, CONFIG_NX823, 276db01a2eaSwdenk CONFIG_OCRTC, CONFIG_ORSG, CONFIG_OXC, 277db01a2eaSwdenk CONFIG_PCI405, CONFIG_PCIPPC2, CONFIG_PCIPPC6, 278db01a2eaSwdenk CONFIG_pcu_e, CONFIG_PIP405, CONFIG_PM826, 279db01a2eaSwdenk CONFIG_ppmc8260, CONFIG_QS823, CONFIG_QS850, 280db01a2eaSwdenk CONFIG_QS860T, CONFIG_RBC823, CONFIG_RPXClassic, 281db01a2eaSwdenk CONFIG_RPXlite, CONFIG_RPXsuper, CONFIG_rsdproto, 282db01a2eaSwdenk CONFIG_sacsng, CONFIG_Sandpoint8240, CONFIG_Sandpoint8245, 283db01a2eaSwdenk CONFIG_sbc8260, CONFIG_SM850, CONFIG_SPD823TS, 2847abf0c58Swdenk CONFIG_STXGP3, CONFIG_SXNI855T, CONFIG_TQM823L, 2857abf0c58Swdenk CONFIG_TQM8260, CONFIG_TQM850L, CONFIG_TQM855L, 2867abf0c58Swdenk CONFIG_TQM860L, CONFIG_TTTech, CONFIG_UTX8245, 2877abf0c58Swdenk CONFIG_V37, CONFIG_W7OLMC, CONFIG_W7OLMG, 2887abf0c58Swdenk CONFIG_WALNUT405, CONFIG_ZPC1900, CONFIG_ZUMA, 289c609719bSwdenk 290c609719bSwdenk ARM based boards: 291c609719bSwdenk ----------------- 292c609719bSwdenk 293db01a2eaSwdenk CONFIG_AT91RM9200DK, CONFIG_DNP1110, CONFIG_EP7312, 294db01a2eaSwdenk CONFIG_H2_OMAP1610, CONFIG_HHP_CRADLE, CONFIG_IMPA7, 295db01a2eaSwdenk CONFIG_INNOVATOROMAP1510, CONFIG_INNOVATOROMAP1610, CONFIG_LART, 296db01a2eaSwdenk CONFIG_LUBBOCK, CONFIG_SHANNON, CONFIG_SMDK2400, 29763e73c9aSwdenk CONFIG_SMDK2410, CONFIG_TRAB, CONFIG_VCMA9, 298c609719bSwdenk 299507bbe3eSwdenk MicroBlaze based boards: 300507bbe3eSwdenk ------------------------ 301507bbe3eSwdenk 302507bbe3eSwdenk CONFIG_SUZAKU 303507bbe3eSwdenk 304c609719bSwdenk 305c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined) 306c609719bSwdenk Define exactly one of 307c609719bSwdenk CONFIG_CMA286_60_OLD 308c609719bSwdenk--- FIXME --- not tested yet: 309c609719bSwdenk CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P, 310c609719bSwdenk CONFIG_CMA287_23, CONFIG_CMA287_50 311c609719bSwdenk 312c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined) 313c609719bSwdenk Define exactly one of 314c609719bSwdenk CONFIG_CMA101, CONFIG_CMA102 315c609719bSwdenk 316c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined) 317c609719bSwdenk Define one or more of 318c609719bSwdenk CONFIG_CMA302 319c609719bSwdenk 320c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined) 321c609719bSwdenk Define one or more of 322c609719bSwdenk CONFIG_LCD_HEARTBEAT - update a character position on 323c609719bSwdenk the lcd display every second with 324c609719bSwdenk a "rotator" |\-/|\-/ 325c609719bSwdenk 3262535d602Swdenk- Board flavour: (if CONFIG_MPC8260ADS is defined) 3272535d602Swdenk CONFIG_ADSTYPE 3282535d602Swdenk Possible values are: 3292535d602Swdenk CFG_8260ADS - original MPC8260ADS 330180d3f74Swdenk CFG_8266ADS - MPC8266ADS 33154387ac9Swdenk CFG_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR 33204a85b3bSwdenk CFG_8272ADS - MPC8272ADS 3332535d602Swdenk 334c609719bSwdenk- MPC824X Family Member (if CONFIG_MPC824X is defined) 335c609719bSwdenk Define exactly one of 336c609719bSwdenk CONFIG_MPC8240, CONFIG_MPC8245 337c609719bSwdenk 33875d1ea7fSwdenk- 8xx CPU Options: (if using an MPC8xx cpu) 339c609719bSwdenk Define one or more of 3405da627a4Swdenk CONFIG_8xx_GCLK_FREQ - if get_gclk_freq() cannot work 3415da627a4Swdenk e.g. if there is no 32KHz 3425da627a4Swdenk reference PIT/RTC clock 343c609719bSwdenk 34475d1ea7fSwdenk- 859/866 CPU options: (if using a MPC859 or MPC866 CPU): 34575d1ea7fSwdenk CFG_866_OSCCLK 34675d1ea7fSwdenk CFG_866_CPUCLK_MIN 34775d1ea7fSwdenk CFG_866_CPUCLK_MAX 34875d1ea7fSwdenk CFG_866_CPUCLK_DEFAULT 34975d1ea7fSwdenk See doc/README.MPC866 35075d1ea7fSwdenk 35175d1ea7fSwdenk CFG_MEASURE_CPUCLK 35275d1ea7fSwdenk 35375d1ea7fSwdenk Define this to measure the actual CPU clock instead 35475d1ea7fSwdenk of relying on the correctness of the configured 35575d1ea7fSwdenk values. Mostly useful for board bringup to make sure 35675d1ea7fSwdenk the PLL is locked at the intended frequency. Note 35775d1ea7fSwdenk that this requires a (stable) reference clock (32 kHz 35875d1ea7fSwdenk RTC clock), 35975d1ea7fSwdenk 3605da627a4Swdenk- Linux Kernel Interface: 361c609719bSwdenk CONFIG_CLOCKS_IN_MHZ 362c609719bSwdenk 363c609719bSwdenk U-Boot stores all clock information in Hz 364c609719bSwdenk internally. For binary compatibility with older Linux 365c609719bSwdenk kernels (which expect the clocks passed in the 366c609719bSwdenk bd_info data to be in MHz) the environment variable 367c609719bSwdenk "clocks_in_mhz" can be defined so that U-Boot 368c609719bSwdenk converts clock data to MHZ before passing it to the 369c609719bSwdenk Linux kernel. 370c609719bSwdenk When CONFIG_CLOCKS_IN_MHZ is defined, a definition of 371c609719bSwdenk "clocks_in_mhz=1" is automatically included in the 372c609719bSwdenk default environment. 373c609719bSwdenk 3745da627a4Swdenk CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only] 3755da627a4Swdenk 3765da627a4Swdenk When transfering memsize parameter to linux, some versions 3775da627a4Swdenk expect it to be in bytes, others in MB. 3785da627a4Swdenk Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes. 3795da627a4Swdenk 380c609719bSwdenk- Console Interface: 381c609719bSwdenk Depending on board, define exactly one serial port 382c609719bSwdenk (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2, 383c609719bSwdenk CONFIG_8xx_CONS_SCC1, ...), or switch off the serial 384c609719bSwdenk console by defining CONFIG_8xx_CONS_NONE 385c609719bSwdenk 386c609719bSwdenk Note: if CONFIG_8xx_CONS_NONE is defined, the serial 387c609719bSwdenk port routines must be defined elsewhere 388c609719bSwdenk (i.e. serial_init(), serial_getc(), ...) 389c609719bSwdenk 390c609719bSwdenk CONFIG_CFB_CONSOLE 391c609719bSwdenk Enables console device for a color framebuffer. Needs following 392c609719bSwdenk defines (cf. smiLynxEM, i8042, board/eltec/bab7xx) 393c609719bSwdenk VIDEO_FB_LITTLE_ENDIAN graphic memory organisation 394c609719bSwdenk (default big endian) 395c609719bSwdenk VIDEO_HW_RECTFILL graphic chip supports 396c609719bSwdenk rectangle fill 397c609719bSwdenk (cf. smiLynxEM) 398c609719bSwdenk VIDEO_HW_BITBLT graphic chip supports 399c609719bSwdenk bit-blit (cf. smiLynxEM) 400c609719bSwdenk VIDEO_VISIBLE_COLS visible pixel columns 401c609719bSwdenk (cols=pitch) 402c609719bSwdenk VIDEO_VISIBLE_ROWS visible pixel rows 403c609719bSwdenk VIDEO_PIXEL_SIZE bytes per pixel 404c609719bSwdenk VIDEO_DATA_FORMAT graphic data format 405c609719bSwdenk (0-5, cf. cfb_console.c) 406c609719bSwdenk VIDEO_FB_ADRS framebuffer address 407c609719bSwdenk VIDEO_KBD_INIT_FCT keyboard int fct 408c609719bSwdenk (i.e. i8042_kbd_init()) 409c609719bSwdenk VIDEO_TSTC_FCT test char fct 410c609719bSwdenk (i.e. i8042_tstc) 411c609719bSwdenk VIDEO_GETC_FCT get char fct 412c609719bSwdenk (i.e. i8042_getc) 413c609719bSwdenk CONFIG_CONSOLE_CURSOR cursor drawing on/off 414c609719bSwdenk (requires blink timer 415c609719bSwdenk cf. i8042.c) 416c609719bSwdenk CFG_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c) 417c609719bSwdenk CONFIG_CONSOLE_TIME display time/date info in 418c609719bSwdenk upper right corner 419c609719bSwdenk (requires CFG_CMD_DATE) 420c609719bSwdenk CONFIG_VIDEO_LOGO display Linux logo in 421c609719bSwdenk upper left corner 422a6c7ad2fSwdenk CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of 423a6c7ad2fSwdenk linux_logo.h for logo. 424a6c7ad2fSwdenk Requires CONFIG_VIDEO_LOGO 425c609719bSwdenk CONFIG_CONSOLE_EXTRA_INFO 426c609719bSwdenk addional board info beside 427c609719bSwdenk the logo 428c609719bSwdenk 429c609719bSwdenk When CONFIG_CFB_CONSOLE is defined, video console is 430c609719bSwdenk default i/o. Serial console can be forced with 431c609719bSwdenk environment 'console=serial'. 432c609719bSwdenk 433a3ad8e26Swdenk When CONFIG_SILENT_CONSOLE is defined, all console 434a3ad8e26Swdenk messages (by U-Boot and Linux!) can be silenced with 435a3ad8e26Swdenk the "silent" environment variable. See 436a3ad8e26Swdenk doc/README.silent for more information. 437a3ad8e26Swdenk 438c609719bSwdenk- Console Baudrate: 439c609719bSwdenk CONFIG_BAUDRATE - in bps 440c609719bSwdenk Select one of the baudrates listed in 441c609719bSwdenk CFG_BAUDRATE_TABLE, see below. 4423bbc899fSwdenk CFG_BRGCLK_PRESCALE, baudrate prescale 443c609719bSwdenk 444c609719bSwdenk- Interrupt driven serial port input: 445c609719bSwdenk CONFIG_SERIAL_SOFTWARE_FIFO 446c609719bSwdenk 447c609719bSwdenk PPC405GP only. 448c609719bSwdenk Use an interrupt handler for receiving data on the 449c609719bSwdenk serial port. It also enables using hardware handshake 450c609719bSwdenk (RTS/CTS) and UART's built-in FIFO. Set the number of 451c609719bSwdenk bytes the interrupt driven input buffer should have. 452c609719bSwdenk 453109c0e3aSwdenk Leave undefined to disable this feature, including 454109c0e3aSwdenk disable the buffer and hardware handshake. 455c609719bSwdenk 4561d49b1f3Sstroese- Console UART Number: 4571d49b1f3Sstroese CONFIG_UART1_CONSOLE 4581d49b1f3Sstroese 4591d49b1f3Sstroese IBM PPC4xx only. 4601d49b1f3Sstroese If defined internal UART1 (and not UART0) is used 4611d49b1f3Sstroese as default U-Boot console. 4621d49b1f3Sstroese 463c609719bSwdenk- Boot Delay: CONFIG_BOOTDELAY - in seconds 464c609719bSwdenk Delay before automatically booting the default image; 465c609719bSwdenk set to -1 to disable autoboot. 466c609719bSwdenk 467c609719bSwdenk See doc/README.autoboot for these options that 468c609719bSwdenk work with CONFIG_BOOTDELAY. None are required. 469c609719bSwdenk CONFIG_BOOT_RETRY_TIME 470c609719bSwdenk CONFIG_BOOT_RETRY_MIN 471c609719bSwdenk CONFIG_AUTOBOOT_KEYED 472c609719bSwdenk CONFIG_AUTOBOOT_PROMPT 473c609719bSwdenk CONFIG_AUTOBOOT_DELAY_STR 474c609719bSwdenk CONFIG_AUTOBOOT_STOP_STR 475c609719bSwdenk CONFIG_AUTOBOOT_DELAY_STR2 476c609719bSwdenk CONFIG_AUTOBOOT_STOP_STR2 477c609719bSwdenk CONFIG_ZERO_BOOTDELAY_CHECK 478c609719bSwdenk CONFIG_RESET_TO_RETRY 479c609719bSwdenk 480c609719bSwdenk- Autoboot Command: 481c609719bSwdenk CONFIG_BOOTCOMMAND 482c609719bSwdenk Only needed when CONFIG_BOOTDELAY is enabled; 483c609719bSwdenk define a command string that is automatically executed 484c609719bSwdenk when no character is read on the console interface 485c609719bSwdenk within "Boot Delay" after reset. 486c609719bSwdenk 487c609719bSwdenk CONFIG_BOOTARGS 488c609719bSwdenk This can be used to pass arguments to the bootm 489c609719bSwdenk command. The value of CONFIG_BOOTARGS goes into the 490c609719bSwdenk environment value "bootargs". 491c609719bSwdenk 492c609719bSwdenk CONFIG_RAMBOOT and CONFIG_NFSBOOT 493c609719bSwdenk The value of these goes into the environment as 494c609719bSwdenk "ramboot" and "nfsboot" respectively, and can be used 495c609719bSwdenk as a convenience, when switching between booting from 496c609719bSwdenk ram and nfs. 497c609719bSwdenk 498c609719bSwdenk- Pre-Boot Commands: 499c609719bSwdenk CONFIG_PREBOOT 500c609719bSwdenk 501c609719bSwdenk When this option is #defined, the existence of the 502c609719bSwdenk environment variable "preboot" will be checked 503c609719bSwdenk immediately before starting the CONFIG_BOOTDELAY 504c609719bSwdenk countdown and/or running the auto-boot command resp. 505c609719bSwdenk entering interactive mode. 506c609719bSwdenk 507c609719bSwdenk This feature is especially useful when "preboot" is 508c609719bSwdenk automatically generated or modified. For an example 509c609719bSwdenk see the LWMON board specific code: here "preboot" is 510c609719bSwdenk modified when the user holds down a certain 511c609719bSwdenk combination of keys on the (special) keyboard when 512c609719bSwdenk booting the systems 513c609719bSwdenk 514c609719bSwdenk- Serial Download Echo Mode: 515c609719bSwdenk CONFIG_LOADS_ECHO 516c609719bSwdenk If defined to 1, all characters received during a 517c609719bSwdenk serial download (using the "loads" command) are 518c609719bSwdenk echoed back. This might be needed by some terminal 519c609719bSwdenk emulations (like "cu"), but may as well just take 520c609719bSwdenk time on others. This setting #define's the initial 521c609719bSwdenk value of the "loads_echo" environment variable. 522c609719bSwdenk 523c609719bSwdenk- Kgdb Serial Baudrate: (if CFG_CMD_KGDB is defined) 524c609719bSwdenk CONFIG_KGDB_BAUDRATE 525c609719bSwdenk Select one of the baudrates listed in 526c609719bSwdenk CFG_BAUDRATE_TABLE, see below. 527c609719bSwdenk 528c609719bSwdenk- Monitor Functions: 529c609719bSwdenk CONFIG_COMMANDS 530c609719bSwdenk Most monitor functions can be selected (or 531c609719bSwdenk de-selected) by adjusting the definition of 532c609719bSwdenk CONFIG_COMMANDS; to select individual functions, 533c609719bSwdenk #define CONFIG_COMMANDS by "OR"ing any of the 534c609719bSwdenk following values: 535c609719bSwdenk 536c609719bSwdenk #define enables commands: 537c609719bSwdenk ------------------------- 538c609719bSwdenk CFG_CMD_ASKENV * ask for env variable 53978137c3cSwdenk CFG_CMD_AUTOSCRIPT Autoscript Support 540c609719bSwdenk CFG_CMD_BDI bdinfo 541c609719bSwdenk CFG_CMD_BEDBUG Include BedBug Debugger 54278137c3cSwdenk CFG_CMD_BMP * BMP support 543c609719bSwdenk CFG_CMD_BOOTD bootd 544c609719bSwdenk CFG_CMD_CACHE icache, dcache 545c609719bSwdenk CFG_CMD_CONSOLE coninfo 546c609719bSwdenk CFG_CMD_DATE * support for RTC, date/time... 547c609719bSwdenk CFG_CMD_DHCP DHCP support 54878137c3cSwdenk CFG_CMD_DIAG * Diagnostics 54978137c3cSwdenk CFG_CMD_DOC * Disk-On-Chip Support 55078137c3cSwdenk CFG_CMD_DTT Digital Therm and Thermostat 551c609719bSwdenk CFG_CMD_ECHO * echo arguments 552c609719bSwdenk CFG_CMD_EEPROM * EEPROM read/write support 553c609719bSwdenk CFG_CMD_ELF bootelf, bootvx 554c609719bSwdenk CFG_CMD_ENV saveenv 555c609719bSwdenk CFG_CMD_FDC * Floppy Disk Support 55671f95118Swdenk CFG_CMD_FAT FAT partition support 5572262cfeeSwdenk CFG_CMD_FDOS * Dos diskette Support 558c609719bSwdenk CFG_CMD_FLASH flinfo, erase, protect 559c609719bSwdenk CFG_CMD_FPGA FPGA device initialization support 56078137c3cSwdenk CFG_CMD_HWFLOW * RTS/CTS hw flow control 561c609719bSwdenk CFG_CMD_I2C * I2C serial bus support 562c609719bSwdenk CFG_CMD_IDE * IDE harddisk support 563c609719bSwdenk CFG_CMD_IMI iminfo 56478137c3cSwdenk CFG_CMD_IMLS List all found images 565c609719bSwdenk CFG_CMD_IMMAP * IMMR dump support 566c609719bSwdenk CFG_CMD_IRQ * irqinfo 5672d1a537dSwdenk CFG_CMD_ITEST * Integer/string test of 2 values 56878137c3cSwdenk CFG_CMD_JFFS2 * JFFS2 Support 569c609719bSwdenk CFG_CMD_KGDB * kgdb 570c609719bSwdenk CFG_CMD_LOADB loadb 571c609719bSwdenk CFG_CMD_LOADS loads 572c609719bSwdenk CFG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base, 573c609719bSwdenk loop, mtest 57478137c3cSwdenk CFG_CMD_MISC Misc functions like sleep etc 57571f95118Swdenk CFG_CMD_MMC MMC memory mapped support 576c609719bSwdenk CFG_CMD_MII MII utility commands 57778137c3cSwdenk CFG_CMD_NAND * NAND support 578c609719bSwdenk CFG_CMD_NET bootp, tftpboot, rarpboot 579c609719bSwdenk CFG_CMD_PCI * pciinfo 580c609719bSwdenk CFG_CMD_PCMCIA * PCMCIA support 58178137c3cSwdenk CFG_CMD_PING * send ICMP ECHO_REQUEST to network host 582ef5a9672Swdenk CFG_CMD_PORTIO * Port I/O 583c609719bSwdenk CFG_CMD_REGINFO * Register dump 584c609719bSwdenk CFG_CMD_RUN run command in env variable 58578137c3cSwdenk CFG_CMD_SAVES save S record dump 586c609719bSwdenk CFG_CMD_SCSI * SCSI Support 58778137c3cSwdenk CFG_CMD_SDRAM * print SDRAM configuration information 588c609719bSwdenk CFG_CMD_SETGETDCR Support for DCR Register access (4xx only) 589c609719bSwdenk CFG_CMD_SPI * SPI serial bus support 590c609719bSwdenk CFG_CMD_USB * USB support 59178137c3cSwdenk CFG_CMD_VFD * VFD support (TRAB) 592c609719bSwdenk CFG_CMD_BSP * Board SPecific functions 593a3d991bdSwdenk CFG_CMD_CDP * Cisco Discover Protocol support 594c609719bSwdenk ----------------------------------------------- 595c609719bSwdenk CFG_CMD_ALL all 596c609719bSwdenk 597c609719bSwdenk CFG_CMD_DFL Default configuration; at the moment 598c609719bSwdenk this is includes all commands, except 599c609719bSwdenk the ones marked with "*" in the list 600c609719bSwdenk above. 601c609719bSwdenk 602c609719bSwdenk If you don't define CONFIG_COMMANDS it defaults to 603c609719bSwdenk CFG_CMD_DFL in include/cmd_confdefs.h. A board can 604c609719bSwdenk override the default settings in the respective 605c609719bSwdenk include file. 606c609719bSwdenk 607c609719bSwdenk EXAMPLE: If you want all functions except of network 608c609719bSwdenk support you can write: 609c609719bSwdenk 610c609719bSwdenk #define CONFIG_COMMANDS (CFG_CMD_ALL & ~CFG_CMD_NET) 611c609719bSwdenk 612c609719bSwdenk 613c609719bSwdenk Note: Don't enable the "icache" and "dcache" commands 614c609719bSwdenk (configuration option CFG_CMD_CACHE) unless you know 615c609719bSwdenk what you (and your U-Boot users) are doing. Data 616c609719bSwdenk cache cannot be enabled on systems like the 8xx or 617c609719bSwdenk 8260 (where accesses to the IMMR region must be 618c609719bSwdenk uncached), and it cannot be disabled on all other 619c609719bSwdenk systems where we (mis-) use the data cache to hold an 620c609719bSwdenk initial stack and some data. 621c609719bSwdenk 622c609719bSwdenk 623c609719bSwdenk XXX - this list needs to get updated! 624c609719bSwdenk 625c609719bSwdenk- Watchdog: 626c609719bSwdenk CONFIG_WATCHDOG 627c609719bSwdenk If this variable is defined, it enables watchdog 6287152b1d0Swdenk support. There must be support in the platform specific 629c609719bSwdenk code for a watchdog. For the 8xx and 8260 CPUs, the 630c609719bSwdenk SIU Watchdog feature is enabled in the SYPCR 631c609719bSwdenk register. 632c609719bSwdenk 633c1551ea8Sstroese- U-Boot Version: 634c1551ea8Sstroese CONFIG_VERSION_VARIABLE 635c1551ea8Sstroese If this variable is defined, an environment variable 636c1551ea8Sstroese named "ver" is created by U-Boot showing the U-Boot 637c1551ea8Sstroese version as printed by the "version" command. 638c1551ea8Sstroese This variable is readonly. 639c1551ea8Sstroese 640c609719bSwdenk- Real-Time Clock: 641c609719bSwdenk 642c609719bSwdenk When CFG_CMD_DATE is selected, the type of the RTC 643c609719bSwdenk has to be selected, too. Define exactly one of the 644c609719bSwdenk following options: 645c609719bSwdenk 646c609719bSwdenk CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx 647c609719bSwdenk CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC 648c609719bSwdenk CONFIG_RTC_MC146818 - use MC146818 RTC 6491cb8e980Swdenk CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC 650c609719bSwdenk CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC 6517f70e853Swdenk CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC 6523bac3513Swdenk CONFIG_RTC_DS164x - use Dallas DS164x RTC 653c609719bSwdenk 654b37c7e5eSwdenk Note that if the RTC uses I2C, then the I2C interface 655b37c7e5eSwdenk must also be configured. See I2C Support, below. 656b37c7e5eSwdenk 657c609719bSwdenk- Timestamp Support: 658c609719bSwdenk 659c609719bSwdenk When CONFIG_TIMESTAMP is selected, the timestamp 660c609719bSwdenk (date and time) of an image is printed by image 661c609719bSwdenk commands like bootm or iminfo. This option is 662c609719bSwdenk automatically enabled when you select CFG_CMD_DATE . 663c609719bSwdenk 664c609719bSwdenk- Partition Support: 665c609719bSwdenk CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION 666c609719bSwdenk and/or CONFIG_ISO_PARTITION 667c609719bSwdenk 668c609719bSwdenk If IDE or SCSI support is enabled (CFG_CMD_IDE or 669c609719bSwdenk CFG_CMD_SCSI) you must configure support for at least 670c609719bSwdenk one partition type as well. 671c609719bSwdenk 672c609719bSwdenk- IDE Reset method: 6734d13cbadSwdenk CONFIG_IDE_RESET_ROUTINE - this is defined in several 6744d13cbadSwdenk board configurations files but used nowhere! 675c609719bSwdenk 6764d13cbadSwdenk CONFIG_IDE_RESET - is this is defined, IDE Reset will 6774d13cbadSwdenk be performed by calling the function 6784d13cbadSwdenk ide_set_reset(int reset) 6794d13cbadSwdenk which has to be defined in a board specific file 680c609719bSwdenk 681c609719bSwdenk- ATAPI Support: 682c609719bSwdenk CONFIG_ATAPI 683c609719bSwdenk 684c609719bSwdenk Set this to enable ATAPI support. 685c609719bSwdenk 686c40b2956Swdenk- LBA48 Support 687c40b2956Swdenk CONFIG_LBA48 688c40b2956Swdenk 689c40b2956Swdenk Set this to enable support for disks larger than 137GB 690c40b2956Swdenk Also look at CFG_64BIT_LBA ,CFG_64BIT_VSPRINTF and CFG_64BIT_STRTOUL 691c40b2956Swdenk Whithout these , LBA48 support uses 32bit variables and will 'only' 692c40b2956Swdenk support disks up to 2.1TB. 693c40b2956Swdenk 694c40b2956Swdenk CFG_64BIT_LBA: 695c40b2956Swdenk When enabled, makes the IDE subsystem use 64bit sector addresses. 696c40b2956Swdenk Default is 32bit. 697c40b2956Swdenk 698c609719bSwdenk- SCSI Support: 699c609719bSwdenk At the moment only there is only support for the 700c609719bSwdenk SYM53C8XX SCSI controller; define 701c609719bSwdenk CONFIG_SCSI_SYM53C8XX to enable it. 702c609719bSwdenk 703c609719bSwdenk CFG_SCSI_MAX_LUN [8], CFG_SCSI_MAX_SCSI_ID [7] and 704c609719bSwdenk CFG_SCSI_MAX_DEVICE [CFG_SCSI_MAX_SCSI_ID * 705c609719bSwdenk CFG_SCSI_MAX_LUN] can be adjusted to define the 706c609719bSwdenk maximum numbers of LUNs, SCSI ID's and target 707c609719bSwdenk devices. 708c609719bSwdenk CFG_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz) 709c609719bSwdenk 710c609719bSwdenk- NETWORK Support (PCI): 711682011ffSwdenk CONFIG_E1000 712682011ffSwdenk Support for Intel 8254x gigabit chips. 713682011ffSwdenk 714c609719bSwdenk CONFIG_EEPRO100 715c609719bSwdenk Support for Intel 82557/82559/82559ER chips. 716c609719bSwdenk Optional CONFIG_EEPRO100_SROM_WRITE enables eeprom 717c609719bSwdenk write routine for first time initialisation. 718c609719bSwdenk 719c609719bSwdenk CONFIG_TULIP 720c609719bSwdenk Support for Digital 2114x chips. 721c609719bSwdenk Optional CONFIG_TULIP_SELECT_MEDIA for board specific 722c609719bSwdenk modem chip initialisation (KS8761/QS6611). 723c609719bSwdenk 724c609719bSwdenk CONFIG_NATSEMI 725c609719bSwdenk Support for National dp83815 chips. 726c609719bSwdenk 727c609719bSwdenk CONFIG_NS8382X 728c609719bSwdenk Support for National dp8382[01] gigabit chips. 729c609719bSwdenk 73045219c46Swdenk- NETWORK Support (other): 73145219c46Swdenk 73245219c46Swdenk CONFIG_DRIVER_LAN91C96 73345219c46Swdenk Support for SMSC's LAN91C96 chips. 73445219c46Swdenk 73545219c46Swdenk CONFIG_LAN91C96_BASE 73645219c46Swdenk Define this to hold the physical address 73745219c46Swdenk of the LAN91C96's I/O space 73845219c46Swdenk 73945219c46Swdenk CONFIG_LAN91C96_USE_32_BIT 74045219c46Swdenk Define this to enable 32 bit addressing 74145219c46Swdenk 742c609719bSwdenk- USB Support: 743c609719bSwdenk At the moment only the UHCI host controller is 7444d13cbadSwdenk supported (PIP405, MIP405, MPC5200); define 745c609719bSwdenk CONFIG_USB_UHCI to enable it. 746c609719bSwdenk define CONFIG_USB_KEYBOARD to enable the USB Keyboard 747c609719bSwdenk end define CONFIG_USB_STORAGE to enable the USB 748c609719bSwdenk storage devices. 749c609719bSwdenk Note: 750c609719bSwdenk Supported are USB Keyboards and USB Floppy drives 751c609719bSwdenk (TEAC FD-05PUB). 7524d13cbadSwdenk MPC5200 USB requires additional defines: 7534d13cbadSwdenk CONFIG_USB_CLOCK 7544d13cbadSwdenk for 528 MHz Clock: 0x0001bbbb 7554d13cbadSwdenk CONFIG_USB_CONFIG 7564d13cbadSwdenk for differential drivers: 0x00001000 7574d13cbadSwdenk for single ended drivers: 0x00005000 7584d13cbadSwdenk 759c609719bSwdenk 76071f95118Swdenk- MMC Support: 76171f95118Swdenk The MMC controller on the Intel PXA is supported. To 76271f95118Swdenk enable this define CONFIG_MMC. The MMC can be 76371f95118Swdenk accessed from the boot prompt by mapping the device 76471f95118Swdenk to physical memory similar to flash. Command line is 76571f95118Swdenk enabled with CFG_CMD_MMC. The MMC driver also works with 76671f95118Swdenk the FAT fs. This is enabled with CFG_CMD_FAT. 76771f95118Swdenk 768c609719bSwdenk- Keyboard Support: 769c609719bSwdenk CONFIG_ISA_KEYBOARD 770c609719bSwdenk 771c609719bSwdenk Define this to enable standard (PC-Style) keyboard 772c609719bSwdenk support 773c609719bSwdenk 774c609719bSwdenk CONFIG_I8042_KBD 775c609719bSwdenk Standard PC keyboard driver with US (is default) and 776c609719bSwdenk GERMAN key layout (switch via environment 'keymap=de') support. 777c609719bSwdenk Export function i8042_kbd_init, i8042_tstc and i8042_getc 778c609719bSwdenk for cfb_console. Supports cursor blinking. 779c609719bSwdenk 780c609719bSwdenk- Video support: 781c609719bSwdenk CONFIG_VIDEO 782c609719bSwdenk 783c609719bSwdenk Define this to enable video support (for output to 784c609719bSwdenk video). 785c609719bSwdenk 786c609719bSwdenk CONFIG_VIDEO_CT69000 787c609719bSwdenk 788c609719bSwdenk Enable Chips & Technologies 69000 Video chip 789c609719bSwdenk 790c609719bSwdenk CONFIG_VIDEO_SMI_LYNXEM 791eeb1b77bSwdenk Enable Silicon Motion SMI 712/710/810 Video chip. The 792eeb1b77bSwdenk video output is selected via environment 'videoout' 793eeb1b77bSwdenk (1 = LCD and 2 = CRT). If videoout is undefined, CRT is 794eeb1b77bSwdenk assumed. 795c609719bSwdenk 796eeb1b77bSwdenk For the CT69000 and SMI_LYNXEM drivers, videomode is 797eeb1b77bSwdenk selected via environment 'videomode'. Two diferent ways 798eeb1b77bSwdenk are possible: 799eeb1b77bSwdenk - "videomode=num" 'num' is a standard LiLo mode numbers. 800eeb1b77bSwdenk Following standard modes are supported (* is default): 801eeb1b77bSwdenk 802eeb1b77bSwdenk Colors 640x480 800x600 1024x768 1152x864 1280x1024 803eeb1b77bSwdenk -------------+--------------------------------------------- 804eeb1b77bSwdenk 8 bits | 0x301* 0x303 0x305 0x161 0x307 805eeb1b77bSwdenk 15 bits | 0x310 0x313 0x316 0x162 0x319 806eeb1b77bSwdenk 16 bits | 0x311 0x314 0x317 0x163 0x31A 807eeb1b77bSwdenk 24 bits | 0x312 0x315 0x318 ? 0x31B 808eeb1b77bSwdenk -------------+--------------------------------------------- 809c609719bSwdenk (i.e. setenv videomode 317; saveenv; reset;) 810c609719bSwdenk 811eeb1b77bSwdenk - "videomode=bootargs" all the video parameters are parsed 812eeb1b77bSwdenk from the bootargs. (See drivers/videomodes.c) 813eeb1b77bSwdenk 814eeb1b77bSwdenk 815a6c7ad2fSwdenk CONFIG_VIDEO_SED13806 816a6c7ad2fSwdenk Enable Epson SED13806 driver. This driver supports 8bpp 817a6c7ad2fSwdenk and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP 818a6c7ad2fSwdenk or CONFIG_VIDEO_SED13806_16BPP 819a6c7ad2fSwdenk 820682011ffSwdenk- Keyboard Support: 821682011ffSwdenk CONFIG_KEYBOARD 822682011ffSwdenk 823682011ffSwdenk Define this to enable a custom keyboard support. 824682011ffSwdenk This simply calls drv_keyboard_init() which must be 825682011ffSwdenk defined in your board-specific files. 826682011ffSwdenk The only board using this so far is RBC823. 827a6c7ad2fSwdenk 828c609719bSwdenk- LCD Support: CONFIG_LCD 829c609719bSwdenk 830c609719bSwdenk Define this to enable LCD support (for output to LCD 831c609719bSwdenk display); also select one of the supported displays 832c609719bSwdenk by defining one of these: 833c609719bSwdenk 834fd3103bbSwdenk CONFIG_NEC_NL6448AC33: 835c609719bSwdenk 836fd3103bbSwdenk NEC NL6448AC33-18. Active, color, single scan. 837c609719bSwdenk 838fd3103bbSwdenk CONFIG_NEC_NL6448BC20 839c609719bSwdenk 840fd3103bbSwdenk NEC NL6448BC20-08. 6.5", 640x480. 841fd3103bbSwdenk Active, color, single scan. 842fd3103bbSwdenk 843fd3103bbSwdenk CONFIG_NEC_NL6448BC33_54 844fd3103bbSwdenk 845fd3103bbSwdenk NEC NL6448BC33-54. 10.4", 640x480. 846c609719bSwdenk Active, color, single scan. 847c609719bSwdenk 848c609719bSwdenk CONFIG_SHARP_16x9 849c609719bSwdenk 850c609719bSwdenk Sharp 320x240. Active, color, single scan. 851c609719bSwdenk It isn't 16x9, and I am not sure what it is. 852c609719bSwdenk 853c609719bSwdenk CONFIG_SHARP_LQ64D341 854c609719bSwdenk 855c609719bSwdenk Sharp LQ64D341 display, 640x480. 856c609719bSwdenk Active, color, single scan. 857c609719bSwdenk 858c609719bSwdenk CONFIG_HLD1045 859c609719bSwdenk 860c609719bSwdenk HLD1045 display, 640x480. 861c609719bSwdenk Active, color, single scan. 862c609719bSwdenk 863c609719bSwdenk CONFIG_OPTREX_BW 864c609719bSwdenk 865c609719bSwdenk Optrex CBL50840-2 NF-FW 99 22 M5 866c609719bSwdenk or 867c609719bSwdenk Hitachi LMG6912RPFC-00T 868c609719bSwdenk or 869c609719bSwdenk Hitachi SP14Q002 870c609719bSwdenk 871c609719bSwdenk 320x240. Black & white. 872c609719bSwdenk 873c609719bSwdenk Normally display is black on white background; define 874c609719bSwdenk CFG_WHITE_ON_BLACK to get it inverted. 875c609719bSwdenk 8767152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN 877d791b1dcSwdenk 878d791b1dcSwdenk If this option is set, the environment is checked for 879d791b1dcSwdenk a variable "splashimage". If found, the usual display 880d791b1dcSwdenk of logo, copyright and system information on the LCD 881d791b1dcSwdenk is supressed and the BMP image at the address 882d791b1dcSwdenk specified in "splashimage" is loaded instead. The 883d791b1dcSwdenk console is redirected to the "nulldev", too. This 884d791b1dcSwdenk allows for a "silent" boot where a splash screen is 885d791b1dcSwdenk loaded very quickly after power-on. 886d791b1dcSwdenk 887c29fdfc1Swdenk- Compression support: 888c29fdfc1Swdenk CONFIG_BZIP2 889c29fdfc1Swdenk 890c29fdfc1Swdenk If this option is set, support for bzip2 compressed 891c29fdfc1Swdenk images is included. If not, only uncompressed and gzip 892c29fdfc1Swdenk compressed images are supported. 893c29fdfc1Swdenk 894c29fdfc1Swdenk NOTE: the bzip2 algorithm requires a lot of RAM, so 895c29fdfc1Swdenk the malloc area (as defined by CFG_MALLOC_LEN) should 896c29fdfc1Swdenk be at least 4MB. 897d791b1dcSwdenk 898c609719bSwdenk- Ethernet address: 899c609719bSwdenk CONFIG_ETHADDR 900c609719bSwdenk CONFIG_ETH2ADDR 901c609719bSwdenk CONFIG_ETH3ADDR 902c609719bSwdenk 903c609719bSwdenk Define a default value for ethernet address to use 904c609719bSwdenk for the respective ethernet interface, in case this 905c609719bSwdenk is not determined automatically. 906c609719bSwdenk 907c609719bSwdenk- IP address: 908c609719bSwdenk CONFIG_IPADDR 909c609719bSwdenk 910c609719bSwdenk Define a default value for the IP address to use for 911c609719bSwdenk the default ethernet interface, in case this is not 912c609719bSwdenk determined through e.g. bootp. 913c609719bSwdenk 914c609719bSwdenk- Server IP address: 915c609719bSwdenk CONFIG_SERVERIP 916c609719bSwdenk 917c609719bSwdenk Defines a default value for theIP address of a TFTP 918c609719bSwdenk server to contact when using the "tftboot" command. 919c609719bSwdenk 920c609719bSwdenk- BOOTP Recovery Mode: 921c609719bSwdenk CONFIG_BOOTP_RANDOM_DELAY 922c609719bSwdenk 923c609719bSwdenk If you have many targets in a network that try to 924c609719bSwdenk boot using BOOTP, you may want to avoid that all 925c609719bSwdenk systems send out BOOTP requests at precisely the same 926c609719bSwdenk moment (which would happen for instance at recovery 927c609719bSwdenk from a power failure, when all systems will try to 928c609719bSwdenk boot, thus flooding the BOOTP server. Defining 929c609719bSwdenk CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be 930c609719bSwdenk inserted before sending out BOOTP requests. The 931c609719bSwdenk following delays are insterted then: 932c609719bSwdenk 933c609719bSwdenk 1st BOOTP request: delay 0 ... 1 sec 934c609719bSwdenk 2nd BOOTP request: delay 0 ... 2 sec 935c609719bSwdenk 3rd BOOTP request: delay 0 ... 4 sec 936c609719bSwdenk 4th and following 937c609719bSwdenk BOOTP requests: delay 0 ... 8 sec 938c609719bSwdenk 939fe389a82Sstroese- DHCP Advanced Options: 940fe389a82Sstroese CONFIG_BOOTP_MASK 941fe389a82Sstroese 942fe389a82Sstroese You can fine tune the DHCP functionality by adding 943fe389a82Sstroese these flags to the CONFIG_BOOTP_MASK define: 944fe389a82Sstroese 945fe389a82Sstroese CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS 946fe389a82Sstroese serverip from a DHCP server, it is possible that more 947fe389a82Sstroese than one DNS serverip is offered to the client. 948fe389a82Sstroese If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS 949fe389a82Sstroese serverip will be stored in the additional environment 950fe389a82Sstroese variable "dnsip2". The first DNS serverip is always 951fe389a82Sstroese stored in the variable "dnsip", when CONFIG_BOOTP_DNS 952fe389a82Sstroese is added to the CONFIG_BOOTP_MASK. 953fe389a82Sstroese 954fe389a82Sstroese CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable 955fe389a82Sstroese to do a dynamic update of a DNS server. To do this, they 956fe389a82Sstroese need the hostname of the DHCP requester. 957fe389a82Sstroese If CONFIG_BOOP_SEND_HOSTNAME is added to the 958fe389a82Sstroese CONFIG_BOOTP_MASK, the content of the "hostname" 959fe389a82Sstroese environment variable is passed as option 12 to 960fe389a82Sstroese the DHCP server. 961fe389a82Sstroese 962a3d991bdSwdenk - CDP Options: 963a3d991bdSwdenk CONFIG_CDP_DEVICE_ID 964a3d991bdSwdenk 965a3d991bdSwdenk The device id used in CDP trigger frames. 966a3d991bdSwdenk 967a3d991bdSwdenk CONFIG_CDP_DEVICE_ID_PREFIX 968a3d991bdSwdenk 969a3d991bdSwdenk A two character string which is prefixed to the MAC address 970a3d991bdSwdenk of the device. 971a3d991bdSwdenk 972a3d991bdSwdenk CONFIG_CDP_PORT_ID 973a3d991bdSwdenk 974a3d991bdSwdenk A printf format string which contains the ascii name of 975a3d991bdSwdenk the port. Normally is set to "eth%d" which sets 976a3d991bdSwdenk eth0 for the first ethernet, eth1 for the second etc. 977a3d991bdSwdenk 978a3d991bdSwdenk CONFIG_CDP_CAPABILITIES 979a3d991bdSwdenk 980a3d991bdSwdenk A 32bit integer which indicates the device capabilities; 981a3d991bdSwdenk 0x00000010 for a normal host which does not forwards. 982a3d991bdSwdenk 983a3d991bdSwdenk CONFIG_CDP_VERSION 984a3d991bdSwdenk 985a3d991bdSwdenk An ascii string containing the version of the software. 986a3d991bdSwdenk 987a3d991bdSwdenk CONFIG_CDP_PLATFORM 988a3d991bdSwdenk 989a3d991bdSwdenk An ascii string containing the name of the platform. 990a3d991bdSwdenk 991a3d991bdSwdenk CONFIG_CDP_TRIGGER 992a3d991bdSwdenk 993a3d991bdSwdenk A 32bit integer sent on the trigger. 994a3d991bdSwdenk 995a3d991bdSwdenk CONFIG_CDP_POWER_CONSUMPTION 996a3d991bdSwdenk 997a3d991bdSwdenk A 16bit integer containing the power consumption of the 998a3d991bdSwdenk device in .1 of milliwatts. 999a3d991bdSwdenk 1000a3d991bdSwdenk CONFIG_CDP_APPLIANCE_VLAN_TYPE 1001a3d991bdSwdenk 1002a3d991bdSwdenk A byte containing the id of the VLAN. 1003a3d991bdSwdenk 1004c609719bSwdenk- Status LED: CONFIG_STATUS_LED 1005c609719bSwdenk 1006c609719bSwdenk Several configurations allow to display the current 1007c609719bSwdenk status using a LED. For instance, the LED will blink 1008c609719bSwdenk fast while running U-Boot code, stop blinking as 1009c609719bSwdenk soon as a reply to a BOOTP request was received, and 1010c609719bSwdenk start blinking slow once the Linux kernel is running 1011c609719bSwdenk (supported by a status LED driver in the Linux 1012c609719bSwdenk kernel). Defining CONFIG_STATUS_LED enables this 1013c609719bSwdenk feature in U-Boot. 1014c609719bSwdenk 1015c609719bSwdenk- CAN Support: CONFIG_CAN_DRIVER 1016c609719bSwdenk 1017c609719bSwdenk Defining CONFIG_CAN_DRIVER enables CAN driver support 1018c609719bSwdenk on those systems that support this (optional) 1019c609719bSwdenk feature, like the TQM8xxL modules. 1020c609719bSwdenk 1021c609719bSwdenk- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C 1022c609719bSwdenk 1023b37c7e5eSwdenk These enable I2C serial bus commands. Defining either of 1024b37c7e5eSwdenk (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will 1025b37c7e5eSwdenk include the appropriate I2C driver for the selected cpu. 1026c609719bSwdenk 1027b37c7e5eSwdenk This will allow you to use i2c commands at the u-boot 1028b37c7e5eSwdenk command line (as long as you set CFG_CMD_I2C in 1029b37c7e5eSwdenk CONFIG_COMMANDS) and communicate with i2c based realtime 1030b37c7e5eSwdenk clock chips. See common/cmd_i2c.c for a description of the 1031c609719bSwdenk command line interface. 1032c609719bSwdenk 1033b37c7e5eSwdenk CONFIG_HARD_I2C selects the CPM hardware driver for I2C. 1034c609719bSwdenk 1035b37c7e5eSwdenk CONFIG_SOFT_I2C configures u-boot to use a software (aka 1036b37c7e5eSwdenk bit-banging) driver instead of CPM or similar hardware 1037b37c7e5eSwdenk support for I2C. 1038c609719bSwdenk 1039b37c7e5eSwdenk There are several other quantities that must also be 1040b37c7e5eSwdenk defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C. 1041c609719bSwdenk 1042b37c7e5eSwdenk In both cases you will need to define CFG_I2C_SPEED 1043b37c7e5eSwdenk to be the frequency (in Hz) at which you wish your i2c bus 1044b37c7e5eSwdenk to run and CFG_I2C_SLAVE to be the address of this node (ie 1045b37c7e5eSwdenk the cpu's i2c node address). 1046c609719bSwdenk 1047b37c7e5eSwdenk Now, the u-boot i2c code for the mpc8xx (cpu/mpc8xx/i2c.c) 1048b37c7e5eSwdenk sets the cpu up as a master node and so its address should 1049b37c7e5eSwdenk therefore be cleared to 0 (See, eg, MPC823e User's Manual 1050b37c7e5eSwdenk p.16-473). So, set CFG_I2C_SLAVE to 0. 1051b37c7e5eSwdenk 1052b37c7e5eSwdenk That's all that's required for CONFIG_HARD_I2C. 1053b37c7e5eSwdenk 1054b37c7e5eSwdenk If you use the software i2c interface (CONFIG_SOFT_I2C) 1055b37c7e5eSwdenk then the following macros need to be defined (examples are 1056b37c7e5eSwdenk from include/configs/lwmon.h): 1057c609719bSwdenk 1058c609719bSwdenk I2C_INIT 1059c609719bSwdenk 1060b37c7e5eSwdenk (Optional). Any commands necessary to enable the I2C 1061c609719bSwdenk controller or configure ports. 1062c609719bSwdenk 1063b37c7e5eSwdenk eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL) 1064b37c7e5eSwdenk 1065c609719bSwdenk I2C_PORT 1066c609719bSwdenk 1067c609719bSwdenk (Only for MPC8260 CPU). The I/O port to use (the code 1068c609719bSwdenk assumes both bits are on the same port). Valid values 1069c609719bSwdenk are 0..3 for ports A..D. 1070c609719bSwdenk 1071c609719bSwdenk I2C_ACTIVE 1072c609719bSwdenk 1073c609719bSwdenk The code necessary to make the I2C data line active 1074c609719bSwdenk (driven). If the data line is open collector, this 1075c609719bSwdenk define can be null. 1076c609719bSwdenk 1077b37c7e5eSwdenk eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA) 1078b37c7e5eSwdenk 1079c609719bSwdenk I2C_TRISTATE 1080c609719bSwdenk 1081c609719bSwdenk The code necessary to make the I2C data line tri-stated 1082c609719bSwdenk (inactive). If the data line is open collector, this 1083c609719bSwdenk define can be null. 1084c609719bSwdenk 1085b37c7e5eSwdenk eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA) 1086b37c7e5eSwdenk 1087c609719bSwdenk I2C_READ 1088c609719bSwdenk 1089c609719bSwdenk Code that returns TRUE if the I2C data line is high, 1090c609719bSwdenk FALSE if it is low. 1091c609719bSwdenk 1092b37c7e5eSwdenk eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0) 1093b37c7e5eSwdenk 1094c609719bSwdenk I2C_SDA(bit) 1095c609719bSwdenk 1096c609719bSwdenk If <bit> is TRUE, sets the I2C data line high. If it 1097c609719bSwdenk is FALSE, it clears it (low). 1098c609719bSwdenk 1099b37c7e5eSwdenk eg: #define I2C_SDA(bit) \ 1100b37c7e5eSwdenk if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \ 1101b37c7e5eSwdenk else immr->im_cpm.cp_pbdat &= ~PB_SDA 1102b37c7e5eSwdenk 1103c609719bSwdenk I2C_SCL(bit) 1104c609719bSwdenk 1105c609719bSwdenk If <bit> is TRUE, sets the I2C clock line high. If it 1106c609719bSwdenk is FALSE, it clears it (low). 1107c609719bSwdenk 1108b37c7e5eSwdenk eg: #define I2C_SCL(bit) \ 1109b37c7e5eSwdenk if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \ 1110b37c7e5eSwdenk else immr->im_cpm.cp_pbdat &= ~PB_SCL 1111b37c7e5eSwdenk 1112c609719bSwdenk I2C_DELAY 1113c609719bSwdenk 1114c609719bSwdenk This delay is invoked four times per clock cycle so this 1115c609719bSwdenk controls the rate of data transfer. The data rate thus 1116b37c7e5eSwdenk is 1 / (I2C_DELAY * 4). Often defined to be something 1117b37c7e5eSwdenk like: 1118b37c7e5eSwdenk 1119b37c7e5eSwdenk #define I2C_DELAY udelay(2) 1120c609719bSwdenk 112147cd00faSwdenk CFG_I2C_INIT_BOARD 112247cd00faSwdenk 112347cd00faSwdenk When a board is reset during an i2c bus transfer 112447cd00faSwdenk chips might think that the current transfer is still 112547cd00faSwdenk in progress. On some boards it is possible to access 112647cd00faSwdenk the i2c SCLK line directly, either by using the 112747cd00faSwdenk processor pin as a GPIO or by having a second pin 112847cd00faSwdenk connected to the bus. If this option is defined a 112947cd00faSwdenk custom i2c_init_board() routine in boards/xxx/board.c 113047cd00faSwdenk is run early in the boot sequence. 113147cd00faSwdenk 1132c609719bSwdenk- SPI Support: CONFIG_SPI 1133c609719bSwdenk 1134c609719bSwdenk Enables SPI driver (so far only tested with 1135c609719bSwdenk SPI EEPROM, also an instance works with Crystal A/D and 1136c609719bSwdenk D/As on the SACSng board) 1137c609719bSwdenk 1138c609719bSwdenk CONFIG_SPI_X 1139c609719bSwdenk 1140c609719bSwdenk Enables extended (16-bit) SPI EEPROM addressing. 1141c609719bSwdenk (symmetrical to CONFIG_I2C_X) 1142c609719bSwdenk 1143c609719bSwdenk CONFIG_SOFT_SPI 1144c609719bSwdenk 1145c609719bSwdenk Enables a software (bit-bang) SPI driver rather than 1146c609719bSwdenk using hardware support. This is a general purpose 1147c609719bSwdenk driver that only requires three general I/O port pins 1148c609719bSwdenk (two outputs, one input) to function. If this is 1149c609719bSwdenk defined, the board configuration must define several 1150c609719bSwdenk SPI configuration items (port pins to use, etc). For 1151c609719bSwdenk an example, see include/configs/sacsng.h. 1152c609719bSwdenk 1153c609719bSwdenk- FPGA Support: CONFIG_FPGA_COUNT 1154c609719bSwdenk 1155c609719bSwdenk Specify the number of FPGA devices to support. 1156c609719bSwdenk 1157c609719bSwdenk CONFIG_FPGA 1158c609719bSwdenk 1159c609719bSwdenk Used to specify the types of FPGA devices. For example, 1160c609719bSwdenk #define CONFIG_FPGA CFG_XILINX_VIRTEX2 1161c609719bSwdenk 1162c609719bSwdenk CFG_FPGA_PROG_FEEDBACK 1163c609719bSwdenk 1164c609719bSwdenk Enable printing of hash marks during FPGA configuration. 1165c609719bSwdenk 1166c609719bSwdenk CFG_FPGA_CHECK_BUSY 1167c609719bSwdenk 1168c609719bSwdenk Enable checks on FPGA configuration interface busy 1169c609719bSwdenk status by the configuration function. This option 1170c609719bSwdenk will require a board or device specific function to 1171c609719bSwdenk be written. 1172c609719bSwdenk 1173c609719bSwdenk CONFIG_FPGA_DELAY 1174c609719bSwdenk 1175c609719bSwdenk If defined, a function that provides delays in the FPGA 1176c609719bSwdenk configuration driver. 1177c609719bSwdenk 1178c609719bSwdenk CFG_FPGA_CHECK_CTRLC 1179c609719bSwdenk Allow Control-C to interrupt FPGA configuration 1180c609719bSwdenk 1181c609719bSwdenk CFG_FPGA_CHECK_ERROR 1182c609719bSwdenk 1183c609719bSwdenk Check for configuration errors during FPGA bitfile 1184c609719bSwdenk loading. For example, abort during Virtex II 1185c609719bSwdenk configuration if the INIT_B line goes low (which 1186c609719bSwdenk indicated a CRC error). 1187c609719bSwdenk 1188c609719bSwdenk CFG_FPGA_WAIT_INIT 1189c609719bSwdenk 1190c609719bSwdenk Maximum time to wait for the INIT_B line to deassert 1191c609719bSwdenk after PROB_B has been deasserted during a Virtex II 1192c609719bSwdenk FPGA configuration sequence. The default time is 500 1193c609719bSwdenk mS. 1194c609719bSwdenk 1195c609719bSwdenk CFG_FPGA_WAIT_BUSY 1196c609719bSwdenk 1197c609719bSwdenk Maximum time to wait for BUSY to deassert during 1198c609719bSwdenk Virtex II FPGA configuration. The default is 5 mS. 1199c609719bSwdenk 1200c609719bSwdenk CFG_FPGA_WAIT_CONFIG 1201c609719bSwdenk 1202c609719bSwdenk Time to wait after FPGA configuration. The default is 1203c609719bSwdenk 200 mS. 1204c609719bSwdenk 1205c609719bSwdenk- Configuration Management: 1206c609719bSwdenk CONFIG_IDENT_STRING 1207c609719bSwdenk 1208c609719bSwdenk If defined, this string will be added to the U-Boot 1209c609719bSwdenk version information (U_BOOT_VERSION) 1210c609719bSwdenk 1211c609719bSwdenk- Vendor Parameter Protection: 1212c609719bSwdenk 1213c609719bSwdenk U-Boot considers the values of the environment 1214c609719bSwdenk variables "serial#" (Board Serial Number) and 12157152b1d0Swdenk "ethaddr" (Ethernet Address) to be parameters that 1216c609719bSwdenk are set once by the board vendor / manufacturer, and 1217c609719bSwdenk protects these variables from casual modification by 1218c609719bSwdenk the user. Once set, these variables are read-only, 1219c609719bSwdenk and write or delete attempts are rejected. You can 1220c609719bSwdenk change this behviour: 1221c609719bSwdenk 1222c609719bSwdenk If CONFIG_ENV_OVERWRITE is #defined in your config 1223c609719bSwdenk file, the write protection for vendor parameters is 122447cd00faSwdenk completely disabled. Anybody can change or delete 1225c609719bSwdenk these parameters. 1226c609719bSwdenk 1227c609719bSwdenk Alternatively, if you #define _both_ CONFIG_ETHADDR 1228c609719bSwdenk _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default 1229c609719bSwdenk ethernet address is installed in the environment, 1230c609719bSwdenk which can be changed exactly ONCE by the user. [The 1231c609719bSwdenk serial# is unaffected by this, i. e. it remains 1232c609719bSwdenk read-only.] 1233c609719bSwdenk 1234c609719bSwdenk- Protected RAM: 1235c609719bSwdenk CONFIG_PRAM 1236c609719bSwdenk 1237c609719bSwdenk Define this variable to enable the reservation of 1238c609719bSwdenk "protected RAM", i. e. RAM which is not overwritten 1239c609719bSwdenk by U-Boot. Define CONFIG_PRAM to hold the number of 1240c609719bSwdenk kB you want to reserve for pRAM. You can overwrite 1241c609719bSwdenk this default value by defining an environment 1242c609719bSwdenk variable "pram" to the number of kB you want to 1243c609719bSwdenk reserve. Note that the board info structure will 1244c609719bSwdenk still show the full amount of RAM. If pRAM is 1245c609719bSwdenk reserved, a new environment variable "mem" will 1246c609719bSwdenk automatically be defined to hold the amount of 1247c609719bSwdenk remaining RAM in a form that can be passed as boot 1248c609719bSwdenk argument to Linux, for instance like that: 1249c609719bSwdenk 1250c609719bSwdenk setenv bootargs ... mem=\$(mem) 1251c609719bSwdenk saveenv 1252c609719bSwdenk 1253c609719bSwdenk This way you can tell Linux not to use this memory, 1254c609719bSwdenk either, which results in a memory region that will 1255c609719bSwdenk not be affected by reboots. 1256c609719bSwdenk 1257c609719bSwdenk *WARNING* If your board configuration uses automatic 1258c609719bSwdenk detection of the RAM size, you must make sure that 1259c609719bSwdenk this memory test is non-destructive. So far, the 1260c609719bSwdenk following board configurations are known to be 1261c609719bSwdenk "pRAM-clean": 1262c609719bSwdenk 1263c609719bSwdenk ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL, 1264c609719bSwdenk HERMES, IP860, RPXlite, LWMON, LANTEC, 1265c609719bSwdenk PCU_E, FLAGADM, TQM8260 1266c609719bSwdenk 1267c609719bSwdenk- Error Recovery: 1268c609719bSwdenk CONFIG_PANIC_HANG 1269c609719bSwdenk 1270c609719bSwdenk Define this variable to stop the system in case of a 1271c609719bSwdenk fatal error, so that you have to reset it manually. 1272c609719bSwdenk This is probably NOT a good idea for an embedded 1273c609719bSwdenk system where you want to system to reboot 1274c609719bSwdenk automatically as fast as possible, but it may be 1275c609719bSwdenk useful during development since you can try to debug 1276c609719bSwdenk the conditions that lead to the situation. 1277c609719bSwdenk 1278c609719bSwdenk CONFIG_NET_RETRY_COUNT 1279c609719bSwdenk 1280c609719bSwdenk This variable defines the number of retries for 1281c609719bSwdenk network operations like ARP, RARP, TFTP, or BOOTP 1282c609719bSwdenk before giving up the operation. If not defined, a 1283c609719bSwdenk default value of 5 is used. 1284c609719bSwdenk 1285c609719bSwdenk- Command Interpreter: 128604a85b3bSwdenk CFG_AUTO_COMPLETE 128704a85b3bSwdenk 128804a85b3bSwdenk Enable auto completion of commands using TAB. 128904a85b3bSwdenk 1290c609719bSwdenk CFG_HUSH_PARSER 1291c609719bSwdenk 1292c609719bSwdenk Define this variable to enable the "hush" shell (from 1293c609719bSwdenk Busybox) as command line interpreter, thus enabling 1294c609719bSwdenk powerful command line syntax like 1295c609719bSwdenk if...then...else...fi conditionals or `&&' and '||' 1296c609719bSwdenk constructs ("shell scripts"). 1297c609719bSwdenk 1298c609719bSwdenk If undefined, you get the old, much simpler behaviour 1299c609719bSwdenk with a somewhat smaller memory footprint. 1300c609719bSwdenk 1301c609719bSwdenk 1302c609719bSwdenk CFG_PROMPT_HUSH_PS2 1303c609719bSwdenk 1304c609719bSwdenk This defines the secondary prompt string, which is 1305c609719bSwdenk printed when the command interpreter needs more input 1306c609719bSwdenk to complete a command. Usually "> ". 1307c609719bSwdenk 1308c609719bSwdenk Note: 1309c609719bSwdenk 1310c609719bSwdenk In the current implementation, the local variables 1311c609719bSwdenk space and global environment variables space are 1312c609719bSwdenk separated. Local variables are those you define by 13133b57fe0aSwdenk simply typing `name=value'. To access a local 1314c609719bSwdenk variable later on, you have write `$name' or 13153b57fe0aSwdenk `${name}'; to execute the contents of a variable 13163b57fe0aSwdenk directly type `$name' at the command prompt. 1317c609719bSwdenk 1318c609719bSwdenk Global environment variables are those you use 1319c609719bSwdenk setenv/printenv to work with. To run a command stored 1320c609719bSwdenk in such a variable, you need to use the run command, 1321c609719bSwdenk and you must not use the '$' sign to access them. 1322c609719bSwdenk 1323c609719bSwdenk To store commands and special characters in a 1324c609719bSwdenk variable, please use double quotation marks 1325c609719bSwdenk surrounding the whole text of the variable, instead 1326c609719bSwdenk of the backslashes before semicolons and special 1327c609719bSwdenk symbols. 1328c609719bSwdenk 1329a8c7c708Swdenk- Default Environment: 1330c609719bSwdenk CONFIG_EXTRA_ENV_SETTINGS 1331c609719bSwdenk 1332c609719bSwdenk Define this to contain any number of null terminated 1333c609719bSwdenk strings (variable = value pairs) that will be part of 13347152b1d0Swdenk the default environment compiled into the boot image. 13352262cfeeSwdenk 1336c609719bSwdenk For example, place something like this in your 1337c609719bSwdenk board's config file: 1338c609719bSwdenk 1339c609719bSwdenk #define CONFIG_EXTRA_ENV_SETTINGS \ 1340c609719bSwdenk "myvar1=value1\0" \ 1341c609719bSwdenk "myvar2=value2\0" 1342c609719bSwdenk 1343c609719bSwdenk Warning: This method is based on knowledge about the 1344c609719bSwdenk internal format how the environment is stored by the 13452262cfeeSwdenk U-Boot code. This is NOT an official, exported 1346c609719bSwdenk interface! Although it is unlikely that this format 13477152b1d0Swdenk will change soon, there is no guarantee either. 1348c609719bSwdenk You better know what you are doing here. 1349c609719bSwdenk 1350c609719bSwdenk Note: overly (ab)use of the default environment is 1351c609719bSwdenk discouraged. Make sure to check other ways to preset 1352c609719bSwdenk the environment like the autoscript function or the 1353c609719bSwdenk boot command first. 1354c609719bSwdenk 1355a8c7c708Swdenk- DataFlash Support: 13562abbe075Swdenk CONFIG_HAS_DATAFLASH 13572abbe075Swdenk 13582abbe075Swdenk Defining this option enables DataFlash features and 13592abbe075Swdenk allows to read/write in Dataflash via the standard 13602abbe075Swdenk commands cp, md... 13612abbe075Swdenk 13623f85ce27Swdenk- SystemACE Support: 13633f85ce27Swdenk CONFIG_SYSTEMACE 13643f85ce27Swdenk 13653f85ce27Swdenk Adding this option adds support for Xilinx SystemACE 13663f85ce27Swdenk chips attached via some sort of local bus. The address 13673f85ce27Swdenk of the chip must alsh be defined in the 13683f85ce27Swdenk CFG_SYSTEMACE_BASE macro. For example: 13693f85ce27Swdenk 13703f85ce27Swdenk #define CONFIG_SYSTEMACE 13713f85ce27Swdenk #define CFG_SYSTEMACE_BASE 0xf0000000 13723f85ce27Swdenk 13733f85ce27Swdenk When SystemACE support is added, the "ace" device type 13743f85ce27Swdenk becomes available to the fat commands, i.e. fatls. 13753f85ce27Swdenk 1376a8c7c708Swdenk- Show boot progress: 1377c609719bSwdenk CONFIG_SHOW_BOOT_PROGRESS 1378c609719bSwdenk 1379c609719bSwdenk Defining this option allows to add some board- 1380c609719bSwdenk specific code (calling a user-provided function 1381c609719bSwdenk "show_boot_progress(int)") that enables you to show 1382c609719bSwdenk the system's boot progress on some display (for 1383c609719bSwdenk example, some LED's) on your board. At the moment, 1384c609719bSwdenk the following checkpoints are implemented: 1385c609719bSwdenk 1386c609719bSwdenk Arg Where When 1387c609719bSwdenk 1 common/cmd_bootm.c before attempting to boot an image 1388c609719bSwdenk -1 common/cmd_bootm.c Image header has bad magic number 1389c609719bSwdenk 2 common/cmd_bootm.c Image header has correct magic number 1390c609719bSwdenk -2 common/cmd_bootm.c Image header has bad checksum 1391c609719bSwdenk 3 common/cmd_bootm.c Image header has correct checksum 1392c609719bSwdenk -3 common/cmd_bootm.c Image data has bad checksum 1393c609719bSwdenk 4 common/cmd_bootm.c Image data has correct checksum 1394c609719bSwdenk -4 common/cmd_bootm.c Image is for unsupported architecture 1395c609719bSwdenk 5 common/cmd_bootm.c Architecture check OK 1396c609719bSwdenk -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi, standalone) 1397c609719bSwdenk 6 common/cmd_bootm.c Image Type check OK 1398c609719bSwdenk -6 common/cmd_bootm.c gunzip uncompression error 1399c609719bSwdenk -7 common/cmd_bootm.c Unimplemented compression type 1400c609719bSwdenk 7 common/cmd_bootm.c Uncompression OK 1401c609719bSwdenk -8 common/cmd_bootm.c Wrong Image Type (not kernel, multi, standalone) 1402c609719bSwdenk 8 common/cmd_bootm.c Image Type check OK 1403c609719bSwdenk -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX) 1404c609719bSwdenk 9 common/cmd_bootm.c Start initial ramdisk verification 1405c609719bSwdenk -10 common/cmd_bootm.c Ramdisk header has bad magic number 1406c609719bSwdenk -11 common/cmd_bootm.c Ramdisk header has bad checksum 1407c609719bSwdenk 10 common/cmd_bootm.c Ramdisk header is OK 1408c609719bSwdenk -12 common/cmd_bootm.c Ramdisk data has bad checksum 1409c609719bSwdenk 11 common/cmd_bootm.c Ramdisk data has correct checksum 1410c609719bSwdenk 12 common/cmd_bootm.c Ramdisk verification complete, start loading 1411c609719bSwdenk -13 common/cmd_bootm.c Wrong Image Type (not PPC Linux Ramdisk) 1412c609719bSwdenk 13 common/cmd_bootm.c Start multifile image verification 1413c609719bSwdenk 14 common/cmd_bootm.c No initial ramdisk, no multifile, continue. 1414c609719bSwdenk 15 common/cmd_bootm.c All preparation done, transferring control to OS 1415c609719bSwdenk 141663e73c9aSwdenk -30 lib_ppc/board.c Fatal error, hang the system 141763e73c9aSwdenk -31 post/post.c POST test failed, detected by post_output_backlog() 141863e73c9aSwdenk -32 post/post.c POST test failed, detected by post_run_single() 141963e73c9aSwdenk 1420c609719bSwdenk -1 common/cmd_doc.c Bad usage of "doc" command 1421c609719bSwdenk -1 common/cmd_doc.c No boot device 1422c609719bSwdenk -1 common/cmd_doc.c Unknown Chip ID on boot device 1423c609719bSwdenk -1 common/cmd_doc.c Read Error on boot device 1424c609719bSwdenk -1 common/cmd_doc.c Image header has bad magic number 1425c609719bSwdenk 1426c609719bSwdenk -1 common/cmd_ide.c Bad usage of "ide" command 1427c609719bSwdenk -1 common/cmd_ide.c No boot device 1428c609719bSwdenk -1 common/cmd_ide.c Unknown boot device 1429c609719bSwdenk -1 common/cmd_ide.c Unknown partition table 1430c609719bSwdenk -1 common/cmd_ide.c Invalid partition type 1431c609719bSwdenk -1 common/cmd_ide.c Read Error on boot device 1432c609719bSwdenk -1 common/cmd_ide.c Image header has bad magic number 1433c609719bSwdenk 1434206c60cbSwdenk -1 common/cmd_nand.c Bad usage of "nand" command 1435206c60cbSwdenk -1 common/cmd_nand.c No boot device 1436206c60cbSwdenk -1 common/cmd_nand.c Unknown Chip ID on boot device 1437206c60cbSwdenk -1 common/cmd_nand.c Read Error on boot device 1438206c60cbSwdenk -1 common/cmd_nand.c Image header has bad magic number 1439206c60cbSwdenk 1440206c60cbSwdenk -1 common/env_common.c Environment has a bad CRC, using default 1441c609719bSwdenk 1442c609719bSwdenk 1443c609719bSwdenkModem Support: 1444c609719bSwdenk-------------- 1445c609719bSwdenk 144685ec0bccSwdenk[so far only for SMDK2400 and TRAB boards] 1447c609719bSwdenk 1448c609719bSwdenk- Modem support endable: 1449c609719bSwdenk CONFIG_MODEM_SUPPORT 1450c609719bSwdenk 1451c609719bSwdenk- RTS/CTS Flow control enable: 1452c609719bSwdenk CONFIG_HWFLOW 1453c609719bSwdenk 1454c609719bSwdenk- Modem debug support: 1455c609719bSwdenk CONFIG_MODEM_SUPPORT_DEBUG 1456c609719bSwdenk 1457c609719bSwdenk Enables debugging stuff (char screen[1024], dbg()) 1458c609719bSwdenk for modem support. Useful only with BDI2000. 1459c609719bSwdenk 1460a8c7c708Swdenk- Interrupt support (PPC): 1461a8c7c708Swdenk 1462a8c7c708Swdenk There are common interrupt_init() and timer_interrupt() 1463a8c7c708Swdenk for all PPC archs. interrupt_init() calls interrupt_init_cpu() 1464a8c7c708Swdenk for cpu specific initialization. interrupt_init_cpu() 1465a8c7c708Swdenk should set decrementer_count to appropriate value. If 1466a8c7c708Swdenk cpu resets decrementer automatically after interrupt 1467a8c7c708Swdenk (ppc4xx) it should set decrementer_count to zero. 1468a8c7c708Swdenk timer_interrupt() calls timer_interrupt_cpu() for cpu 1469a8c7c708Swdenk specific handling. If board has watchdog / status_led 1470a8c7c708Swdenk / other_activity_monitor it works automatically from 1471a8c7c708Swdenk general timer_interrupt(). 1472a8c7c708Swdenk 1473c609719bSwdenk- General: 1474c609719bSwdenk 1475c609719bSwdenk In the target system modem support is enabled when a 1476c609719bSwdenk specific key (key combination) is pressed during 1477c609719bSwdenk power-on. Otherwise U-Boot will boot normally 1478c609719bSwdenk (autoboot). The key_pressed() fuction is called from 1479c609719bSwdenk board_init(). Currently key_pressed() is a dummy 1480c609719bSwdenk function, returning 1 and thus enabling modem 1481c609719bSwdenk initialization. 1482c609719bSwdenk 1483c609719bSwdenk If there are no modem init strings in the 1484c609719bSwdenk environment, U-Boot proceed to autoboot; the 1485c609719bSwdenk previous output (banner, info printfs) will be 1486c609719bSwdenk supressed, though. 1487c609719bSwdenk 1488c609719bSwdenk See also: doc/README.Modem 1489c609719bSwdenk 1490c609719bSwdenk 1491c609719bSwdenkConfiguration Settings: 1492c609719bSwdenk----------------------- 1493c609719bSwdenk 1494c609719bSwdenk- CFG_LONGHELP: Defined when you want long help messages included; 1495c609719bSwdenk undefine this when you're short of memory. 1496c609719bSwdenk 1497c609719bSwdenk- CFG_PROMPT: This is what U-Boot prints on the console to 1498c609719bSwdenk prompt for user input. 1499c609719bSwdenk 1500c609719bSwdenk- CFG_CBSIZE: Buffer size for input from the Console 1501c609719bSwdenk 1502c609719bSwdenk- CFG_PBSIZE: Buffer size for Console output 1503c609719bSwdenk 1504c609719bSwdenk- CFG_MAXARGS: max. Number of arguments accepted for monitor commands 1505c609719bSwdenk 1506c609719bSwdenk- CFG_BARGSIZE: Buffer size for Boot Arguments which are passed to 1507c609719bSwdenk the application (usually a Linux kernel) when it is 1508c609719bSwdenk booted 1509c609719bSwdenk 1510c609719bSwdenk- CFG_BAUDRATE_TABLE: 1511c609719bSwdenk List of legal baudrate settings for this board. 1512c609719bSwdenk 1513c609719bSwdenk- CFG_CONSOLE_INFO_QUIET 1514c609719bSwdenk Suppress display of console information at boot. 1515c609719bSwdenk 1516c609719bSwdenk- CFG_CONSOLE_IS_IN_ENV 1517c609719bSwdenk If the board specific function 1518c609719bSwdenk extern int overwrite_console (void); 1519c609719bSwdenk returns 1, the stdin, stderr and stdout are switched to the 1520c609719bSwdenk serial port, else the settings in the environment are used. 1521c609719bSwdenk 1522c609719bSwdenk- CFG_CONSOLE_OVERWRITE_ROUTINE 1523c609719bSwdenk Enable the call to overwrite_console(). 1524c609719bSwdenk 1525c609719bSwdenk- CFG_CONSOLE_ENV_OVERWRITE 1526c609719bSwdenk Enable overwrite of previous console environment settings. 1527c609719bSwdenk 1528c609719bSwdenk- CFG_MEMTEST_START, CFG_MEMTEST_END: 1529c609719bSwdenk Begin and End addresses of the area used by the 1530c609719bSwdenk simple memory test. 1531c609719bSwdenk 1532c609719bSwdenk- CFG_ALT_MEMTEST: 1533c609719bSwdenk Enable an alternate, more extensive memory test. 1534c609719bSwdenk 15355f535fe1Swdenk- CFG_MEMTEST_SCRATCH: 15365f535fe1Swdenk Scratch address used by the alternate memory test 15375f535fe1Swdenk You only need to set this if address zero isn't writeable 15385f535fe1Swdenk 1539c609719bSwdenk- CFG_TFTP_LOADADDR: 1540c609719bSwdenk Default load address for network file downloads 1541c609719bSwdenk 1542c609719bSwdenk- CFG_LOADS_BAUD_CHANGE: 1543c609719bSwdenk Enable temporary baudrate change while serial download 1544c609719bSwdenk 1545c609719bSwdenk- CFG_SDRAM_BASE: 1546c609719bSwdenk Physical start address of SDRAM. _Must_ be 0 here. 1547c609719bSwdenk 1548c609719bSwdenk- CFG_MBIO_BASE: 1549c609719bSwdenk Physical start address of Motherboard I/O (if using a 1550c609719bSwdenk Cogent motherboard) 1551c609719bSwdenk 1552c609719bSwdenk- CFG_FLASH_BASE: 1553c609719bSwdenk Physical start address of Flash memory. 1554c609719bSwdenk 1555c609719bSwdenk- CFG_MONITOR_BASE: 1556c609719bSwdenk Physical start address of boot monitor code (set by 1557c609719bSwdenk make config files to be same as the text base address 1558c609719bSwdenk (TEXT_BASE) used when linking) - same as 1559c609719bSwdenk CFG_FLASH_BASE when booting from flash. 1560c609719bSwdenk 1561c609719bSwdenk- CFG_MONITOR_LEN: 15623b57fe0aSwdenk Size of memory reserved for monitor code, used to 15633b57fe0aSwdenk determine _at_compile_time_ (!) if the environment is 15643b57fe0aSwdenk embedded within the U-Boot image, or in a separate 15653b57fe0aSwdenk flash sector. 1566c609719bSwdenk 1567c609719bSwdenk- CFG_MALLOC_LEN: 1568c609719bSwdenk Size of DRAM reserved for malloc() use. 1569c609719bSwdenk 1570c609719bSwdenk- CFG_BOOTMAPSZ: 1571c609719bSwdenk Maximum size of memory mapped by the startup code of 1572c609719bSwdenk the Linux kernel; all data that must be processed by 1573c609719bSwdenk the Linux kernel (bd_info, boot arguments, eventually 1574c609719bSwdenk initrd image) must be put below this limit. 1575c609719bSwdenk 1576c609719bSwdenk- CFG_MAX_FLASH_BANKS: 1577c609719bSwdenk Max number of Flash memory banks 1578c609719bSwdenk 1579c609719bSwdenk- CFG_MAX_FLASH_SECT: 1580c609719bSwdenk Max number of sectors on a Flash chip 1581c609719bSwdenk 1582c609719bSwdenk- CFG_FLASH_ERASE_TOUT: 1583c609719bSwdenk Timeout for Flash erase operations (in ms) 1584c609719bSwdenk 1585c609719bSwdenk- CFG_FLASH_WRITE_TOUT: 1586c609719bSwdenk Timeout for Flash write operations (in ms) 1587c609719bSwdenk 15888564acf9Swdenk- CFG_FLASH_LOCK_TOUT 15898564acf9Swdenk Timeout for Flash set sector lock bit operation (in ms) 15908564acf9Swdenk 15918564acf9Swdenk- CFG_FLASH_UNLOCK_TOUT 15928564acf9Swdenk Timeout for Flash clear lock bits operation (in ms) 15938564acf9Swdenk 15948564acf9Swdenk- CFG_FLASH_PROTECTION 15958564acf9Swdenk If defined, hardware flash sectors protection is used 15968564acf9Swdenk instead of U-Boot software protection. 15978564acf9Swdenk 1598c609719bSwdenk- CFG_DIRECT_FLASH_TFTP: 1599c609719bSwdenk 1600c609719bSwdenk Enable TFTP transfers directly to flash memory; 1601c609719bSwdenk without this option such a download has to be 1602c609719bSwdenk performed in two steps: (1) download to RAM, and (2) 1603c609719bSwdenk copy from RAM to flash. 1604c609719bSwdenk 1605c609719bSwdenk The two-step approach is usually more reliable, since 1606c609719bSwdenk you can check if the download worked before you erase 1607c609719bSwdenk the flash, but in some situations (when sytem RAM is 1608c609719bSwdenk too limited to allow for a tempory copy of the 1609c609719bSwdenk downloaded image) this option may be very useful. 1610c609719bSwdenk 1611c609719bSwdenk- CFG_FLASH_CFI: 1612c609719bSwdenk Define if the flash driver uses extra elements in the 16135653fc33Swdenk common flash structure for storing flash geometry. 16145653fc33Swdenk 16155653fc33Swdenk- CFG_FLASH_CFI_DRIVER 16165653fc33Swdenk This option also enables the building of the cfi_flash driver 16175653fc33Swdenk in the drivers directory 161853cf9435Sstroese 161953cf9435Sstroese- CFG_RX_ETH_BUFFER: 162053cf9435Sstroese Defines the number of ethernet receive buffers. On some 162153cf9435Sstroese ethernet controllers it is recommended to set this value 162253cf9435Sstroese to 8 or even higher (EEPRO100 or 405 EMAC), since all 162353cf9435Sstroese buffers can be full shortly after enabling the interface 162453cf9435Sstroese on high ethernet traffic. 162553cf9435Sstroese Defaults to 4 if not defined. 1626c609719bSwdenk 1627c609719bSwdenkThe following definitions that deal with the placement and management 1628c609719bSwdenkof environment data (variable area); in general, we support the 1629c609719bSwdenkfollowing configurations: 1630c609719bSwdenk 1631c609719bSwdenk- CFG_ENV_IS_IN_FLASH: 1632c609719bSwdenk 1633c609719bSwdenk Define this if the environment is in flash memory. 1634c609719bSwdenk 1635c609719bSwdenk a) The environment occupies one whole flash sector, which is 1636c609719bSwdenk "embedded" in the text segment with the U-Boot code. This 1637c609719bSwdenk happens usually with "bottom boot sector" or "top boot 1638c609719bSwdenk sector" type flash chips, which have several smaller 1639c609719bSwdenk sectors at the start or the end. For instance, such a 1640c609719bSwdenk layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In 1641c609719bSwdenk such a case you would place the environment in one of the 1642c609719bSwdenk 4 kB sectors - with U-Boot code before and after it. With 1643c609719bSwdenk "top boot sector" type flash chips, you would put the 1644c609719bSwdenk environment in one of the last sectors, leaving a gap 1645c609719bSwdenk between U-Boot and the environment. 1646c609719bSwdenk 1647c609719bSwdenk - CFG_ENV_OFFSET: 1648c609719bSwdenk 1649c609719bSwdenk Offset of environment data (variable area) to the 1650c609719bSwdenk beginning of flash memory; for instance, with bottom boot 1651c609719bSwdenk type flash chips the second sector can be used: the offset 1652c609719bSwdenk for this sector is given here. 1653c609719bSwdenk 1654c609719bSwdenk CFG_ENV_OFFSET is used relative to CFG_FLASH_BASE. 1655c609719bSwdenk 1656c609719bSwdenk - CFG_ENV_ADDR: 1657c609719bSwdenk 1658c609719bSwdenk This is just another way to specify the start address of 1659c609719bSwdenk the flash sector containing the environment (instead of 1660c609719bSwdenk CFG_ENV_OFFSET). 1661c609719bSwdenk 1662c609719bSwdenk - CFG_ENV_SECT_SIZE: 1663c609719bSwdenk 1664c609719bSwdenk Size of the sector containing the environment. 1665c609719bSwdenk 1666c609719bSwdenk 1667c609719bSwdenk b) Sometimes flash chips have few, equal sized, BIG sectors. 1668c609719bSwdenk In such a case you don't want to spend a whole sector for 1669c609719bSwdenk the environment. 1670c609719bSwdenk 1671c609719bSwdenk - CFG_ENV_SIZE: 1672c609719bSwdenk 1673c609719bSwdenk If you use this in combination with CFG_ENV_IS_IN_FLASH 1674c609719bSwdenk and CFG_ENV_SECT_SIZE, you can specify to use only a part 1675c609719bSwdenk of this flash sector for the environment. This saves 1676c609719bSwdenk memory for the RAM copy of the environment. 1677c609719bSwdenk 1678c609719bSwdenk It may also save flash memory if you decide to use this 1679c609719bSwdenk when your environment is "embedded" within U-Boot code, 1680c609719bSwdenk since then the remainder of the flash sector could be used 1681c609719bSwdenk for U-Boot code. It should be pointed out that this is 1682c609719bSwdenk STRONGLY DISCOURAGED from a robustness point of view: 1683c609719bSwdenk updating the environment in flash makes it always 1684c609719bSwdenk necessary to erase the WHOLE sector. If something goes 1685c609719bSwdenk wrong before the contents has been restored from a copy in 1686c609719bSwdenk RAM, your target system will be dead. 1687c609719bSwdenk 1688c609719bSwdenk - CFG_ENV_ADDR_REDUND 1689c609719bSwdenk CFG_ENV_SIZE_REDUND 1690c609719bSwdenk 1691c609719bSwdenk These settings describe a second storage area used to hold 1692c609719bSwdenk a redundand copy of the environment data, so that there is 16933e38691eSwdenk a valid backup copy in case there is a power failure during 1694c609719bSwdenk a "saveenv" operation. 1695c609719bSwdenk 1696c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the 1697c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds* 1698c609719bSwdenkaccordingly! 1699c609719bSwdenk 1700c609719bSwdenk 1701c609719bSwdenk- CFG_ENV_IS_IN_NVRAM: 1702c609719bSwdenk 1703c609719bSwdenk Define this if you have some non-volatile memory device 1704c609719bSwdenk (NVRAM, battery buffered SRAM) which you want to use for the 1705c609719bSwdenk environment. 1706c609719bSwdenk 1707c609719bSwdenk - CFG_ENV_ADDR: 1708c609719bSwdenk - CFG_ENV_SIZE: 1709c609719bSwdenk 1710c609719bSwdenk These two #defines are used to determin the memory area you 1711c609719bSwdenk want to use for environment. It is assumed that this memory 1712c609719bSwdenk can just be read and written to, without any special 1713c609719bSwdenk provision. 1714c609719bSwdenk 1715c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early 1716c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the 1717c609719bSwdenkconsole baudrate). You *MUST* have mappend your NVRAM area then, or 1718c609719bSwdenkU-Boot will hang. 1719c609719bSwdenk 1720c609719bSwdenkPlease note that even with NVRAM we still use a copy of the 1721c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to 1722c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv" 1723c609719bSwdenkto save the current settings. 1724c609719bSwdenk 1725c609719bSwdenk 1726c609719bSwdenk- CFG_ENV_IS_IN_EEPROM: 1727c609719bSwdenk 1728c609719bSwdenk Use this if you have an EEPROM or similar serial access 1729c609719bSwdenk device and a driver for it. 1730c609719bSwdenk 1731c609719bSwdenk - CFG_ENV_OFFSET: 1732c609719bSwdenk - CFG_ENV_SIZE: 1733c609719bSwdenk 1734c609719bSwdenk These two #defines specify the offset and size of the 1735c609719bSwdenk environment area within the total memory of your EEPROM. 1736c609719bSwdenk 1737c609719bSwdenk - CFG_I2C_EEPROM_ADDR: 1738c609719bSwdenk If defined, specified the chip address of the EEPROM device. 1739c609719bSwdenk The default address is zero. 1740c609719bSwdenk 1741c609719bSwdenk - CFG_EEPROM_PAGE_WRITE_BITS: 1742c609719bSwdenk If defined, the number of bits used to address bytes in a 1743c609719bSwdenk single page in the EEPROM device. A 64 byte page, for example 1744c609719bSwdenk would require six bits. 1745c609719bSwdenk 1746c609719bSwdenk - CFG_EEPROM_PAGE_WRITE_DELAY_MS: 1747c609719bSwdenk If defined, the number of milliseconds to delay between 1748c609719bSwdenk page writes. The default is zero milliseconds. 1749c609719bSwdenk 1750c609719bSwdenk - CFG_I2C_EEPROM_ADDR_LEN: 1751c609719bSwdenk The length in bytes of the EEPROM memory array address. Note 1752c609719bSwdenk that this is NOT the chip address length! 1753c609719bSwdenk 17545cf91d6bSwdenk - CFG_I2C_EEPROM_ADDR_OVERFLOW: 17555cf91d6bSwdenk EEPROM chips that implement "address overflow" are ones 17565cf91d6bSwdenk like Catalyst 24WC04/08/16 which has 9/10/11 bits of 17575cf91d6bSwdenk address and the extra bits end up in the "chip address" bit 17585cf91d6bSwdenk slots. This makes a 24WC08 (1Kbyte) chip look like four 256 17595cf91d6bSwdenk byte chips. 17605cf91d6bSwdenk 17615cf91d6bSwdenk Note that we consider the length of the address field to 17625cf91d6bSwdenk still be one byte because the extra address bits are hidden 17635cf91d6bSwdenk in the chip address. 17645cf91d6bSwdenk 1765c609719bSwdenk - CFG_EEPROM_SIZE: 1766c609719bSwdenk The size in bytes of the EEPROM device. 1767c609719bSwdenk 1768c609719bSwdenk 17695779d8d9Swdenk- CFG_ENV_IS_IN_DATAFLASH: 17705779d8d9Swdenk 17715779d8d9Swdenk Define this if you have a DataFlash memory device which you 17725779d8d9Swdenk want to use for the environment. 17735779d8d9Swdenk 17745779d8d9Swdenk - CFG_ENV_OFFSET: 17755779d8d9Swdenk - CFG_ENV_ADDR: 17765779d8d9Swdenk - CFG_ENV_SIZE: 17775779d8d9Swdenk 17785779d8d9Swdenk These three #defines specify the offset and size of the 17795779d8d9Swdenk environment area within the total memory of your DataFlash placed 17805779d8d9Swdenk at the specified address. 17815779d8d9Swdenk 17825779d8d9Swdenk 1783c609719bSwdenk- CFG_SPI_INIT_OFFSET 1784c609719bSwdenk 1785c609719bSwdenk Defines offset to the initial SPI buffer area in DPRAM. The 1786c609719bSwdenk area is used at an early stage (ROM part) if the environment 1787c609719bSwdenk is configured to reside in the SPI EEPROM: We need a 520 byte 1788c609719bSwdenk scratch DPRAM area. It is used between the two initialization 1789c609719bSwdenk calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems 1790c609719bSwdenk to be a good choice since it makes it far enough from the 1791c609719bSwdenk start of the data area as well as from the stack pointer. 1792c609719bSwdenk 1793c609719bSwdenkPlease note that the environment is read-only as long as the monitor 1794c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been 1795c609719bSwdenkcreated; also, when using EEPROM you will have to use getenv_r() 1796c609719bSwdenkuntil then to read environment variables. 1797c609719bSwdenk 179885ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor 179985ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working 180085ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is 180185ec0bccSwdenknecessary, because the first environment variable we need is the 180285ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't 180385ec0bccSwdenkhave any device yet where we could complain.] 1804c609719bSwdenk 1805c609719bSwdenkNote: once the monitor has been relocated, then it will complain if 1806c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you 180785ec0bccSwdenkuse the "saveenv" command to store a valid environment. 1808c609719bSwdenk 1809fc3e2165Swdenk- CFG_FAULT_ECHO_LINK_DOWN: 1810fc3e2165Swdenk Echo the inverted Ethernet link state to the fault LED. 1811fc3e2165Swdenk 1812fc3e2165Swdenk Note: If this option is active, then CFG_FAULT_MII_ADDR 1813fc3e2165Swdenk also needs to be defined. 1814fc3e2165Swdenk 1815fc3e2165Swdenk- CFG_FAULT_MII_ADDR: 1816fc3e2165Swdenk MII address of the PHY to check for the Ethernet link state. 1817c609719bSwdenk 1818c40b2956Swdenk- CFG_64BIT_VSPRINTF: 1819c40b2956Swdenk Makes vsprintf (and all *printf functions) support printing 1820c40b2956Swdenk of 64bit values by using the L quantifier 1821c40b2956Swdenk 1822c40b2956Swdenk- CFG_64BIT_STRTOUL: 1823c40b2956Swdenk Adds simple_strtoull that returns a 64bit value 1824c40b2956Swdenk 1825c609719bSwdenkLow Level (hardware related) configuration options: 1826dc7c9a1aSwdenk--------------------------------------------------- 1827c609719bSwdenk 1828c609719bSwdenk- CFG_CACHELINE_SIZE: 1829c609719bSwdenk Cache Line Size of the CPU. 1830c609719bSwdenk 1831c609719bSwdenk- CFG_DEFAULT_IMMR: 1832c609719bSwdenk Default address of the IMMR after system reset. 18332535d602Swdenk 18342535d602Swdenk Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU, 18352535d602Swdenk and RPXsuper) to be able to adjust the position of 18362535d602Swdenk the IMMR register after a reset. 1837c609719bSwdenk 18387f6c2cbcSwdenk- Floppy Disk Support: 18397f6c2cbcSwdenk CFG_FDC_DRIVE_NUMBER 18407f6c2cbcSwdenk 18417f6c2cbcSwdenk the default drive number (default value 0) 18427f6c2cbcSwdenk 18437f6c2cbcSwdenk CFG_ISA_IO_STRIDE 18447f6c2cbcSwdenk 18457f6c2cbcSwdenk defines the spacing between fdc chipset registers 18467f6c2cbcSwdenk (default value 1) 18477f6c2cbcSwdenk 18487f6c2cbcSwdenk CFG_ISA_IO_OFFSET 18497f6c2cbcSwdenk 18507f6c2cbcSwdenk defines the offset of register from address. It 18517f6c2cbcSwdenk depends on which part of the data bus is connected to 18527f6c2cbcSwdenk the fdc chipset. (default value 0) 18537f6c2cbcSwdenk 18547f6c2cbcSwdenk If CFG_ISA_IO_STRIDE CFG_ISA_IO_OFFSET and 18557f6c2cbcSwdenk CFG_FDC_DRIVE_NUMBER are undefined, they take their 18567f6c2cbcSwdenk default value. 18577f6c2cbcSwdenk 18587f6c2cbcSwdenk if CFG_FDC_HW_INIT is defined, then the function 18597f6c2cbcSwdenk fdc_hw_init() is called at the beginning of the FDC 18607f6c2cbcSwdenk setup. fdc_hw_init() must be provided by the board 18617f6c2cbcSwdenk source code. It is used to make hardware dependant 18627f6c2cbcSwdenk initializations. 18637f6c2cbcSwdenk 1864c609719bSwdenk- CFG_IMMR: Physical address of the Internal Memory Mapped 1865c609719bSwdenk Register; DO NOT CHANGE! (11-4) 1866c609719bSwdenk [MPC8xx systems only] 1867c609719bSwdenk 1868c609719bSwdenk- CFG_INIT_RAM_ADDR: 1869c609719bSwdenk 18707152b1d0Swdenk Start address of memory area that can be used for 1871c609719bSwdenk initial data and stack; please note that this must be 1872c609719bSwdenk writable memory that is working WITHOUT special 1873c609719bSwdenk initialization, i. e. you CANNOT use normal RAM which 1874c609719bSwdenk will become available only after programming the 1875c609719bSwdenk memory controller and running certain initialization 1876c609719bSwdenk sequences. 1877c609719bSwdenk 1878c609719bSwdenk U-Boot uses the following memory types: 1879c609719bSwdenk - MPC8xx and MPC8260: IMMR (internal memory of the CPU) 1880c609719bSwdenk - MPC824X: data cache 1881c609719bSwdenk - PPC4xx: data cache 1882c609719bSwdenk 188385ec0bccSwdenk- CFG_GBL_DATA_OFFSET: 1884c609719bSwdenk 1885c609719bSwdenk Offset of the initial data structure in the memory 1886c609719bSwdenk area defined by CFG_INIT_RAM_ADDR. Usually 188785ec0bccSwdenk CFG_GBL_DATA_OFFSET is chosen such that the initial 1888c609719bSwdenk data is located at the end of the available space 1889c609719bSwdenk (sometimes written as (CFG_INIT_RAM_END - 1890c609719bSwdenk CFG_INIT_DATA_SIZE), and the initial stack is just 1891c609719bSwdenk below that area (growing from (CFG_INIT_RAM_ADDR + 189285ec0bccSwdenk CFG_GBL_DATA_OFFSET) downward. 1893c609719bSwdenk 1894c609719bSwdenk Note: 1895c609719bSwdenk On the MPC824X (or other systems that use the data 1896c609719bSwdenk cache for initial memory) the address chosen for 1897c609719bSwdenk CFG_INIT_RAM_ADDR is basically arbitrary - it must 1898c609719bSwdenk point to an otherwise UNUSED address space between 1899c609719bSwdenk the top of RAM and the start of the PCI space. 1900c609719bSwdenk 1901c609719bSwdenk- CFG_SIUMCR: SIU Module Configuration (11-6) 1902c609719bSwdenk 1903c609719bSwdenk- CFG_SYPCR: System Protection Control (11-9) 1904c609719bSwdenk 1905c609719bSwdenk- CFG_TBSCR: Time Base Status and Control (11-26) 1906c609719bSwdenk 1907c609719bSwdenk- CFG_PISCR: Periodic Interrupt Status and Control (11-31) 1908c609719bSwdenk 1909c609719bSwdenk- CFG_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30) 1910c609719bSwdenk 1911c609719bSwdenk- CFG_SCCR: System Clock and reset Control Register (15-27) 1912c609719bSwdenk 1913c609719bSwdenk- CFG_OR_TIMING_SDRAM: 1914c609719bSwdenk SDRAM timing 1915c609719bSwdenk 1916c609719bSwdenk- CFG_MAMR_PTA: 1917c609719bSwdenk periodic timer for refresh 1918c609719bSwdenk 1919c609719bSwdenk- CFG_DER: Debug Event Register (37-47) 1920c609719bSwdenk 1921c609719bSwdenk- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CFG_REMAP_OR_AM, 1922c609719bSwdenk CFG_PRELIM_OR_AM, CFG_OR_TIMING_FLASH, CFG_OR0_REMAP, 1923c609719bSwdenk CFG_OR0_PRELIM, CFG_BR0_PRELIM, CFG_OR1_REMAP, CFG_OR1_PRELIM, 1924c609719bSwdenk CFG_BR1_PRELIM: 1925c609719bSwdenk Memory Controller Definitions: BR0/1 and OR0/1 (FLASH) 1926c609719bSwdenk 1927c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE, 1928c609719bSwdenk CFG_OR_TIMING_SDRAM, CFG_OR2_PRELIM, CFG_BR2_PRELIM, 1929c609719bSwdenk CFG_OR3_PRELIM, CFG_BR3_PRELIM: 1930c609719bSwdenk Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM) 1931c609719bSwdenk 1932c609719bSwdenk- CFG_MAMR_PTA, CFG_MPTPR_2BK_4K, CFG_MPTPR_1BK_4K, CFG_MPTPR_2BK_8K, 1933c609719bSwdenk CFG_MPTPR_1BK_8K, CFG_MAMR_8COL, CFG_MAMR_9COL: 1934c609719bSwdenk Machine Mode Register and Memory Periodic Timer 1935c609719bSwdenk Prescaler definitions (SDRAM timing) 1936c609719bSwdenk 1937c609719bSwdenk- CFG_I2C_UCODE_PATCH, CFG_I2C_DPMEM_OFFSET [0x1FC0]: 1938c609719bSwdenk enable I2C microcode relocation patch (MPC8xx); 1939c609719bSwdenk define relocation offset in DPRAM [DSP2] 1940c609719bSwdenk 1941c609719bSwdenk- CFG_SPI_UCODE_PATCH, CFG_SPI_DPMEM_OFFSET [0x1FC0]: 1942c609719bSwdenk enable SPI microcode relocation patch (MPC8xx); 1943c609719bSwdenk define relocation offset in DPRAM [SCC4] 1944c609719bSwdenk 1945c609719bSwdenk- CFG_USE_OSCCLK: 1946c609719bSwdenk Use OSCM clock mode on MBX8xx board. Be careful, 1947c609719bSwdenk wrong setting might damage your board. Read 1948c609719bSwdenk doc/README.MBX before setting this variable! 1949c609719bSwdenk 1950ea909b76Swdenk- CFG_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only) 1951ea909b76Swdenk Offset of the bootmode word in DPRAM used by post 1952ea909b76Swdenk (Power On Self Tests). This definition overrides 1953ea909b76Swdenk #define'd default value in commproc.h resp. 1954ea909b76Swdenk cpm_8260.h. 1955ea909b76Swdenk 19565d232d0eSwdenk- CFG_PCI_SLV_MEM_LOCAL, CFG_PCI_SLV_MEM_BUS, CFG_PICMR0_MASK_ATTRIB, 19575d232d0eSwdenk CFG_PCI_MSTR0_LOCAL, CFG_PCIMSK0_MASK, CFG_PCI_MSTR1_LOCAL, 19585d232d0eSwdenk CFG_PCIMSK1_MASK, CFG_PCI_MSTR_MEM_LOCAL, CFG_PCI_MSTR_MEM_BUS, 19595d232d0eSwdenk CFG_CPU_PCI_MEM_START, CFG_PCI_MSTR_MEM_SIZE, CFG_POCMR0_MASK_ATTRIB, 19605d232d0eSwdenk CFG_PCI_MSTR_MEMIO_LOCAL, CFG_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START, 19615d232d0eSwdenk CFG_PCI_MSTR_MEMIO_SIZE, CFG_POCMR1_MASK_ATTRIB, CFG_PCI_MSTR_IO_LOCAL, 19625d232d0eSwdenk CFG_PCI_MSTR_IO_BUS, CFG_CPU_PCI_IO_START, CFG_PCI_MSTR_IO_SIZE, 19635d232d0eSwdenk CFG_POCMR2_MASK_ATTRIB: (MPC826x only) 19645d232d0eSwdenk Overrides the default PCI memory map in cpu/mpc8260/pci.c if set. 19655d232d0eSwdenk 1966c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12] 1967c26e454dSwdenk Define to enable FEC[12] on a 8xx series processor. 1968c26e454dSwdenk 1969c26e454dSwdenk- CONFIG_FEC[12]_PHY 1970c26e454dSwdenk Define to the hardcoded PHY address which corresponds 19716e592385Swdenk to the given FEC; i. e. 1972c26e454dSwdenk #define CONFIG_FEC1_PHY 4 1973c26e454dSwdenk means that the PHY with address 4 is connected to FEC1 1974c26e454dSwdenk 1975c26e454dSwdenk When set to -1, means to probe for first available. 1976c26e454dSwdenk 1977c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR 1978c26e454dSwdenk The PHY does not have a RXERR line (RMII only). 1979c26e454dSwdenk (so program the FEC to ignore it). 1980c26e454dSwdenk 1981c26e454dSwdenk- CONFIG_RMII 1982c26e454dSwdenk Enable RMII mode for all FECs. 1983c26e454dSwdenk Note that this is a global option, we can't 1984c26e454dSwdenk have one FEC in standard MII mode and another in RMII mode. 1985c26e454dSwdenk 19865cf91d6bSwdenk- CONFIG_CRC32_VERIFY 19875cf91d6bSwdenk Add a verify option to the crc32 command. 19885cf91d6bSwdenk The syntax is: 19895cf91d6bSwdenk 19905cf91d6bSwdenk => crc32 -v <address> <count> <crc32> 19915cf91d6bSwdenk 19925cf91d6bSwdenk Where address/count indicate a memory area 19935cf91d6bSwdenk and crc32 is the correct crc32 which the 19945cf91d6bSwdenk area should have. 19955cf91d6bSwdenk 1996c609719bSwdenkBuilding the Software: 1997c609719bSwdenk====================== 1998c609719bSwdenk 1999c609719bSwdenkBuilding U-Boot has been tested in native PPC environments (on a 2000c609719bSwdenkPowerBook G3 running LinuxPPC 2000) and in cross environments 2001c609719bSwdenk(running RedHat 6.x and 7.x Linux on x86, Solaris 2.6 on a SPARC, and 2002c609719bSwdenkNetBSD 1.5 on x86). 2003c609719bSwdenk 2004c609719bSwdenkIf you are not using a native PPC environment, it is assumed that you 2005c609719bSwdenkhave the GNU cross compiling tools available in your path and named 2006c609719bSwdenkwith a prefix of "powerpc-linux-". If this is not the case, (e.g. if 2007c609719bSwdenkyou are using Monta Vista's Hard Hat Linux CDK 1.2) you must change 2008c609719bSwdenkthe definition of CROSS_COMPILE in Makefile. For HHL on a 4xx CPU, 2009c609719bSwdenkchange it to: 2010c609719bSwdenk 2011c609719bSwdenk CROSS_COMPILE = ppc_4xx- 2012c609719bSwdenk 2013c609719bSwdenk 2014c609719bSwdenkU-Boot is intended to be simple to build. After installing the 2015c609719bSwdenksources you must configure U-Boot for one specific board type. This 2016c609719bSwdenkis done by typing: 2017c609719bSwdenk 2018c609719bSwdenk make NAME_config 2019c609719bSwdenk 2020c609719bSwdenkwhere "NAME_config" is the name of one of the existing 2021c609719bSwdenkconfigurations; the following names are supported: 2022c609719bSwdenk 2023db01a2eaSwdenk ADCIOP_config ADS860_config AR405_config 2024db01a2eaSwdenk at91rm9200dk_config CANBT_config cmi_mpc5xx_config 2025db01a2eaSwdenk cogent_common_config cogent_mpc8260_config cogent_mpc8xx_config 2026db01a2eaSwdenk CPCI405_config CPCIISER4_config CU824_config 2027db01a2eaSwdenk DUET_ADS_config EBONY_config ELPT860_config 2028db01a2eaSwdenk ESTEEM192E_config ETX094_config FADS823_config 2029db01a2eaSwdenk FADS850SAR_config FADS860T_config FPS850L_config 2030db01a2eaSwdenk FPS860L_config GEN860T_config GENIETV_config 2031db01a2eaSwdenk GTH_config hermes_config hymod_config 2032db01a2eaSwdenk IP860_config IVML24_config IVMS8_config 2033db01a2eaSwdenk JSE_config LANTEC_config lwmon_config 2034db01a2eaSwdenk MBX860T_config MBX_config MPC8260ADS_config 2035db01a2eaSwdenk MPC8540ADS_config MPC8560ADS_config NETVIA_config 2036db01a2eaSwdenk omap1510inn_config omap1610h2_config omap1610inn_config 2037db01a2eaSwdenk pcu_e_config PIP405_config QS823_config 2038db01a2eaSwdenk QS850_config QS860T_config RPXlite_config 2039db01a2eaSwdenk RPXsuper_config rsdproto_config Sandpoint8240_config 2040db01a2eaSwdenk sbc8260_config SM850_config SPD823TS_config 20417abf0c58Swdenk stxgp3_config SXNI855T_config TQM823L_config 20427abf0c58Swdenk TQM850L_config TQM855L_config TQM860L_config 20437abf0c58Swdenk WALNUT405_config ZPC1900_config 204454387ac9Swdenk 2045c609719bSwdenkNote: for some board special configuration names may exist; check if 2046c609719bSwdenk additional information is available from the board vendor; for 2047*2729af9dSwdenk instance, the TQM823L systems are available without (standard) 2048*2729af9dSwdenk or with LCD support. You can select such additional "features" 2049c609719bSwdenk when chosing the configuration, i. e. 2050c609719bSwdenk 2051*2729af9dSwdenk make TQM823L_config 2052*2729af9dSwdenk - will configure for a plain TQM823L, i. e. no LCD support 2053c609719bSwdenk 2054c609719bSwdenk make TQM823L_LCD_config 2055c609719bSwdenk - will configure for a TQM823L with U-Boot console on LCD 2056c609719bSwdenk 2057c609719bSwdenk etc. 2058c609719bSwdenk 2059c609719bSwdenk 2060c609719bSwdenkFinally, type "make all", and you should get some working U-Boot 20617152b1d0Swdenkimages ready for download to / installation on your system: 2062c609719bSwdenk 2063c609719bSwdenk- "u-boot.bin" is a raw binary image 2064c609719bSwdenk- "u-boot" is an image in ELF binary format 2065c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format 2066c609719bSwdenk 2067c609719bSwdenk 2068c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so 2069c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of 2070c609719bSwdenknative "make". 2071c609719bSwdenk 2072c609719bSwdenk 2073c609719bSwdenkIf the system board that you have is not listed, then you will need 2074c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these 2075c609719bSwdenksteps: 2076c609719bSwdenk 2077c609719bSwdenk1. Add a new configuration option for your board to the toplevel 207885ec0bccSwdenk "Makefile" and to the "MAKEALL" script, using the existing 207985ec0bccSwdenk entries as examples. Note that here and at many other places 20807152b1d0Swdenk boards and other names are listed in alphabetical sort order. Please 208185ec0bccSwdenk keep this order. 2082c609719bSwdenk2. Create a new directory to hold your board specific code. Add any 208385ec0bccSwdenk files you need. In your board directory, you will need at least 208485ec0bccSwdenk the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds". 208585ec0bccSwdenk3. Create a new configuration file "include/configs/<board>.h" for 208685ec0bccSwdenk your board 2087c609719bSwdenk3. If you're porting U-Boot to a new CPU, then also create a new 2088c609719bSwdenk directory to hold your CPU specific code. Add any files you need. 208985ec0bccSwdenk4. Run "make <board>_config" with your new name. 2090c609719bSwdenk5. Type "make", and you should get a working "u-boot.srec" file 2091c609719bSwdenk to be installed on your target system. 209285ec0bccSwdenk6. Debug and solve any problems that might arise. 2093c609719bSwdenk [Of course, this last step is much harder than it sounds.] 2094c609719bSwdenk 2095c609719bSwdenk 2096c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.: 2097c609719bSwdenk============================================================== 2098c609719bSwdenk 2099c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board 2100c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to 2101c609719bSwdenkprovide feedback to the other developers. The feedback normally takes 2102c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest 2103c609719bSwdenkofficial or latest in CVS) version of U-Boot sources. 2104c609719bSwdenk 2105c609719bSwdenkBut before you submit such a patch, please verify that your modifi- 2106c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of 2107c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so, 2108c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot 2109c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can 21107152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE' 2111c609719bSwdenkenvironment variable to the script, i. e. to use the cross tools from 2112c609719bSwdenkMontaVista's Hard Hat Linux you can type 2113c609719bSwdenk 2114c609719bSwdenk CROSS_COMPILE=ppc_8xx- MAKEALL 2115c609719bSwdenk 2116c609719bSwdenkor to build on a native PowerPC system you can type 2117c609719bSwdenk 2118c609719bSwdenk CROSS_COMPILE=' ' MAKEALL 2119c609719bSwdenk 2120c609719bSwdenkSee also "U-Boot Porting Guide" below. 2121c609719bSwdenk 2122c609719bSwdenk 2123c609719bSwdenkMonitor Commands - Overview: 2124c609719bSwdenk============================ 2125c609719bSwdenk 2126c609719bSwdenkgo - start application at address 'addr' 2127c609719bSwdenkrun - run commands in an environment variable 2128c609719bSwdenkbootm - boot application image from memory 2129c609719bSwdenkbootp - boot image via network using BootP/TFTP protocol 2130c609719bSwdenktftpboot- boot image via network using TFTP protocol 2131c609719bSwdenk and env variables "ipaddr" and "serverip" 2132c609719bSwdenk (and eventually "gatewayip") 2133c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol 2134c609719bSwdenkdiskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd' 2135c609719bSwdenkloads - load S-Record file over serial line 2136c609719bSwdenkloadb - load binary file over serial line (kermit mode) 2137c609719bSwdenkmd - memory display 2138c609719bSwdenkmm - memory modify (auto-incrementing) 2139c609719bSwdenknm - memory modify (constant address) 2140c609719bSwdenkmw - memory write (fill) 2141c609719bSwdenkcp - memory copy 2142c609719bSwdenkcmp - memory compare 2143c609719bSwdenkcrc32 - checksum calculation 2144c609719bSwdenkimd - i2c memory display 2145c609719bSwdenkimm - i2c memory modify (auto-incrementing) 2146c609719bSwdenkinm - i2c memory modify (constant address) 2147c609719bSwdenkimw - i2c memory write (fill) 2148c609719bSwdenkicrc32 - i2c checksum calculation 2149c609719bSwdenkiprobe - probe to discover valid I2C chip addresses 2150c609719bSwdenkiloop - infinite loop on address range 2151c609719bSwdenkisdram - print SDRAM configuration information 2152c609719bSwdenksspi - SPI utility commands 2153c609719bSwdenkbase - print or set address offset 2154c609719bSwdenkprintenv- print environment variables 2155c609719bSwdenksetenv - set environment variables 2156c609719bSwdenksaveenv - save environment variables to persistent storage 2157c609719bSwdenkprotect - enable or disable FLASH write protection 2158c609719bSwdenkerase - erase FLASH memory 2159c609719bSwdenkflinfo - print FLASH memory information 2160c609719bSwdenkbdinfo - print Board Info structure 2161c609719bSwdenkiminfo - print header information for application image 2162c609719bSwdenkconinfo - print console devices and informations 2163c609719bSwdenkide - IDE sub-system 2164c609719bSwdenkloop - infinite loop on address range 2165c609719bSwdenkmtest - simple RAM test 2166c609719bSwdenkicache - enable or disable instruction cache 2167c609719bSwdenkdcache - enable or disable data cache 2168c609719bSwdenkreset - Perform RESET of the CPU 2169c609719bSwdenkecho - echo args to console 2170c609719bSwdenkversion - print monitor version 2171c609719bSwdenkhelp - print online help 2172c609719bSwdenk? - alias for 'help' 2173c609719bSwdenk 2174c609719bSwdenk 2175c609719bSwdenkMonitor Commands - Detailed Description: 2176c609719bSwdenk======================================== 2177c609719bSwdenk 2178c609719bSwdenkTODO. 2179c609719bSwdenk 2180c609719bSwdenkFor now: just type "help <command>". 2181c609719bSwdenk 2182c609719bSwdenk 2183c609719bSwdenkEnvironment Variables: 2184c609719bSwdenk====================== 2185c609719bSwdenk 2186c609719bSwdenkU-Boot supports user configuration using Environment Variables which 2187c609719bSwdenkcan be made persistent by saving to Flash memory. 2188c609719bSwdenk 2189c609719bSwdenkEnvironment Variables are set using "setenv", printed using 2190c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv" 2191c609719bSwdenkwithout a value can be used to delete a variable from the 2192c609719bSwdenkenvironment. As long as you don't save the environment you are 2193c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the 2194c609719bSwdenkenvironment is erased by accident, a default environment is provided. 2195c609719bSwdenk 2196c609719bSwdenkSome configuration options can be set using Environment Variables: 2197c609719bSwdenk 2198c609719bSwdenk baudrate - see CONFIG_BAUDRATE 2199c609719bSwdenk 2200c609719bSwdenk bootdelay - see CONFIG_BOOTDELAY 2201c609719bSwdenk 2202c609719bSwdenk bootcmd - see CONFIG_BOOTCOMMAND 2203c609719bSwdenk 2204c609719bSwdenk bootargs - Boot arguments when booting an RTOS image 2205c609719bSwdenk 2206c609719bSwdenk bootfile - Name of the image to load with TFTP 2207c609719bSwdenk 2208c609719bSwdenk autoload - if set to "no" (any string beginning with 'n'), 2209c609719bSwdenk "bootp" will just load perform a lookup of the 2210c609719bSwdenk configuration from the BOOTP server, but not try to 2211c609719bSwdenk load any image using TFTP 2212c609719bSwdenk 2213c609719bSwdenk autostart - if set to "yes", an image loaded using the "bootp", 2214c609719bSwdenk "rarpboot", "tftpboot" or "diskboot" commands will 2215c609719bSwdenk be automatically started (by internally calling 2216c609719bSwdenk "bootm") 2217c609719bSwdenk 22184a6fd34bSwdenk If set to "no", a standalone image passed to the 22194a6fd34bSwdenk "bootm" command will be copied to the load address 22204a6fd34bSwdenk (and eventually uncompressed), but NOT be started. 22214a6fd34bSwdenk This can be used to load and uncompress arbitrary 22224a6fd34bSwdenk data. 22234a6fd34bSwdenk 2224c609719bSwdenk initrd_high - restrict positioning of initrd images: 2225c609719bSwdenk If this variable is not set, initrd images will be 2226c609719bSwdenk copied to the highest possible address in RAM; this 2227c609719bSwdenk is usually what you want since it allows for 2228c609719bSwdenk maximum initrd size. If for some reason you want to 2229c609719bSwdenk make sure that the initrd image is loaded below the 2230c609719bSwdenk CFG_BOOTMAPSZ limit, you can set this environment 2231c609719bSwdenk variable to a value of "no" or "off" or "0". 2232c609719bSwdenk Alternatively, you can set it to a maximum upper 2233c609719bSwdenk address to use (U-Boot will still check that it 2234c609719bSwdenk does not overwrite the U-Boot stack and data). 2235c609719bSwdenk 2236c609719bSwdenk For instance, when you have a system with 16 MB 22377152b1d0Swdenk RAM, and want to reserve 4 MB from use by Linux, 2238c609719bSwdenk you can do this by adding "mem=12M" to the value of 2239c609719bSwdenk the "bootargs" variable. However, now you must make 22407152b1d0Swdenk sure that the initrd image is placed in the first 2241c609719bSwdenk 12 MB as well - this can be done with 2242c609719bSwdenk 2243c609719bSwdenk setenv initrd_high 00c00000 2244c609719bSwdenk 224538b99261Swdenk If you set initrd_high to 0xFFFFFFFF, this is an 224638b99261Swdenk indication to U-Boot that all addresses are legal 224738b99261Swdenk for the Linux kernel, including addresses in flash 224838b99261Swdenk memory. In this case U-Boot will NOT COPY the 224938b99261Swdenk ramdisk at all. This may be useful to reduce the 225038b99261Swdenk boot time on your system, but requires that this 225138b99261Swdenk feature is supported by your Linux kernel. 225238b99261Swdenk 2253c609719bSwdenk ipaddr - IP address; needed for tftpboot command 2254c609719bSwdenk 2255c609719bSwdenk loadaddr - Default load address for commands like "bootp", 2256dc7c9a1aSwdenk "rarpboot", "tftpboot", "loadb" or "diskboot" 2257c609719bSwdenk 2258c609719bSwdenk loads_echo - see CONFIG_LOADS_ECHO 2259c609719bSwdenk 2260c609719bSwdenk serverip - TFTP server IP address; needed for tftpboot command 2261c609719bSwdenk 2262c609719bSwdenk bootretry - see CONFIG_BOOT_RETRY_TIME 2263c609719bSwdenk 2264c609719bSwdenk bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR 2265c609719bSwdenk 2266c609719bSwdenk bootstopkey - see CONFIG_AUTOBOOT_STOP_STR 2267c609719bSwdenk 2268a3d991bdSwdenk ethprime - When CONFIG_NET_MULTI is enabled controls which 2269a3d991bdSwdenk interface is used first. 2270a3d991bdSwdenk 2271a3d991bdSwdenk ethact - When CONFIG_NET_MULTI is enabled controls which 2272a3d991bdSwdenk interface is currently active. For example you 2273a3d991bdSwdenk can do the following 2274a3d991bdSwdenk 2275a3d991bdSwdenk => setenv ethact FEC ETHERNET 2276a3d991bdSwdenk => ping 192.168.0.1 # traffic sent on FEC ETHERNET 2277a3d991bdSwdenk => setenv ethact SCC ETHERNET 2278a3d991bdSwdenk => ping 10.0.0.1 # traffic sent on SCC ETHERNET 2279a3d991bdSwdenk 2280a3d991bdSwdenk netretry - When set to "no" each network operation will 2281a3d991bdSwdenk either succeed or fail without retrying. 22826e592385Swdenk When set to "once" the network operation will 22836e592385Swdenk fail when all the available network interfaces 22846e592385Swdenk are tried once without success. 2285a3d991bdSwdenk Useful on scripts which control the retry operation 2286a3d991bdSwdenk themselves. 2287a3d991bdSwdenk 2288a3d991bdSwdenk vlan - When set to a value < 4095 the traffic over 2289a3d991bdSwdenk ethernet is encapsulated/received over 802.1q 2290a3d991bdSwdenk VLAN tagged frames. 2291c609719bSwdenk 2292c609719bSwdenkThe following environment variables may be used and automatically 2293c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"), 2294c609719bSwdenkdepending the information provided by your boot server: 2295c609719bSwdenk 2296c609719bSwdenk bootfile - see above 2297c609719bSwdenk dnsip - IP address of your Domain Name Server 2298fe389a82Sstroese dnsip2 - IP address of your secondary Domain Name Server 2299c609719bSwdenk gatewayip - IP address of the Gateway (Router) to use 2300c609719bSwdenk hostname - Target hostname 2301c609719bSwdenk ipaddr - see above 2302c609719bSwdenk netmask - Subnet Mask 2303c609719bSwdenk rootpath - Pathname of the root filesystem on the NFS server 2304c609719bSwdenk serverip - see above 2305c609719bSwdenk 2306c609719bSwdenk 2307c609719bSwdenkThere are two special Environment Variables: 2308c609719bSwdenk 2309c609719bSwdenk serial# - contains hardware identification information such 2310c609719bSwdenk as type string and/or serial number 2311c609719bSwdenk ethaddr - Ethernet address 2312c609719bSwdenk 2313c609719bSwdenkThese variables can be set only once (usually during manufacturing of 2314c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables 2315c609719bSwdenkonce they have been set once. 2316c609719bSwdenk 2317c609719bSwdenk 2318c1551ea8SstroeseFurther special Environment Variables: 2319c1551ea8Sstroese 2320c1551ea8Sstroese ver - Contains the U-Boot version string as printed 2321c1551ea8Sstroese with the "version" command. This variable is 2322c1551ea8Sstroese readonly (see CONFIG_VERSION_VARIABLE). 2323c1551ea8Sstroese 2324c1551ea8Sstroese 2325c609719bSwdenkPlease note that changes to some configuration parameters may take 2326c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-). 2327c609719bSwdenk 2328c609719bSwdenk 2329f07771ccSwdenkCommand Line Parsing: 2330f07771ccSwdenk===================== 2331f07771ccSwdenk 2332f07771ccSwdenkThere are two different command line parsers available with U-Boot: 23337152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell: 2334f07771ccSwdenk 2335f07771ccSwdenkOld, simple command line parser: 2336f07771ccSwdenk-------------------------------- 2337f07771ccSwdenk 2338f07771ccSwdenk- supports environment variables (through setenv / saveenv commands) 2339f07771ccSwdenk- several commands on one line, separated by ';' 2340f07771ccSwdenk- variable substitution using "... $(name) ..." syntax 2341f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\', 2342f07771ccSwdenk for example: 2343f07771ccSwdenk setenv bootcmd bootm \$(address) 2344f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example: 2345f07771ccSwdenk setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off' 2346f07771ccSwdenk 2347f07771ccSwdenkHush shell: 2348f07771ccSwdenk----------- 2349f07771ccSwdenk 2350f07771ccSwdenk- similar to Bourne shell, with control structures like 2351f07771ccSwdenk if...then...else...fi, for...do...done; while...do...done, 2352f07771ccSwdenk until...do...done, ... 2353f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv 2354f07771ccSwdenk commands) and local shell variables (through standard shell syntax 2355f07771ccSwdenk "name=value"); only environment variables can be used with "run" 2356f07771ccSwdenk command 2357f07771ccSwdenk 2358f07771ccSwdenkGeneral rules: 2359f07771ccSwdenk-------------- 2360f07771ccSwdenk 2361f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run" 2362f07771ccSwdenk command) contains several commands separated by semicolon, and 2363f07771ccSwdenk one of these commands fails, then the remaining commands will be 2364f07771ccSwdenk executed anyway. 2365f07771ccSwdenk 2366f07771ccSwdenk(2) If you execute several variables with one call to run (i. e. 2367f07771ccSwdenk calling run with a list af variables as arguments), any failing 2368f07771ccSwdenk command will cause "run" to terminate, i. e. the remaining 2369f07771ccSwdenk variables are not executed. 2370f07771ccSwdenk 2371c609719bSwdenkNote for Redundant Ethernet Interfaces: 2372c609719bSwdenk======================================= 2373c609719bSwdenk 23747152b1d0SwdenkSome boards come with redundant ethernet interfaces; U-Boot supports 2375c609719bSwdenksuch configurations and is capable of automatic selection of a 23767152b1d0Swdenk"working" interface when needed. MAC assignment works as follows: 2377c609719bSwdenk 2378c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding 2379c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0), 2380c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ... 2381c609719bSwdenk 2382c609719bSwdenkIf the network interface stores some valid MAC address (for instance 2383c609719bSwdenkin SROM), this is used as default address if there is NO correspon- 2384c609719bSwdenkding setting in the environment; if the corresponding environment 2385c609719bSwdenkvariable is set, this overrides the settings in the card; that means: 2386c609719bSwdenk 2387c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the 2388c609719bSwdenk environment, the SROM's address is used. 2389c609719bSwdenk 2390c609719bSwdenko If there is no valid address in the SROM, and a definition in the 2391c609719bSwdenk environment exists, then the value from the environment variable is 2392c609719bSwdenk used. 2393c609719bSwdenk 2394c609719bSwdenko If both the SROM and the environment contain a MAC address, and 2395c609719bSwdenk both addresses are the same, this MAC address is used. 2396c609719bSwdenk 2397c609719bSwdenko If both the SROM and the environment contain a MAC address, and the 2398c609719bSwdenk addresses differ, the value from the environment is used and a 2399c609719bSwdenk warning is printed. 2400c609719bSwdenk 2401c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error 2402c609719bSwdenk is raised. 2403c609719bSwdenk 2404c609719bSwdenk 2405c609719bSwdenkImage Formats: 2406c609719bSwdenk============== 2407c609719bSwdenk 2408c609719bSwdenkThe "boot" commands of this monitor operate on "image" files which 2409c609719bSwdenkcan be basicly anything, preceeded by a special header; see the 2410c609719bSwdenkdefinitions in include/image.h for details; basicly, the header 2411c609719bSwdenkdefines the following image properties: 2412c609719bSwdenk 2413c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD, 2414c609719bSwdenk 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks, 24157f70e853Swdenk LynxOS, pSOS, QNX, RTEMS, ARTOS; 24161f4bb37dSwdenk Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, ARTOS, LynxOS). 2417c609719bSwdenk* Target CPU Architecture (Provisions for Alpha, ARM, Intel x86, 24183d1e8a9dSwdenk IA64, MIPS, NIOS, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit; 24193d1e8a9dSwdenk Currently supported: ARM, Intel x86, MIPS, NIOS, PowerPC). 2420c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2) 2421c609719bSwdenk* Load Address 2422c609719bSwdenk* Entry Point 2423c609719bSwdenk* Image Name 2424c609719bSwdenk* Image Timestamp 2425c609719bSwdenk 2426c609719bSwdenkThe header is marked by a special Magic Number, and both the header 2427c609719bSwdenkand the data portions of the image are secured against corruption by 2428c609719bSwdenkCRC32 checksums. 2429c609719bSwdenk 2430c609719bSwdenk 2431c609719bSwdenkLinux Support: 2432c609719bSwdenk============== 2433c609719bSwdenk 2434c609719bSwdenkAlthough U-Boot should support any OS or standalone application 24357152b1d0Swdenkeasily, the main focus has always been on Linux during the design of 2436c609719bSwdenkU-Boot. 2437c609719bSwdenk 2438c609719bSwdenkU-Boot includes many features that so far have been part of some 2439c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any 2440c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image; 2441c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation 24427152b1d0Swdenkserves several purposes: 2443c609719bSwdenk 2444c609719bSwdenk- the same features can be used for other OS or standalone 2445c609719bSwdenk applications (for instance: using compressed images to reduce the 2446c609719bSwdenk Flash memory footprint) 2447c609719bSwdenk 2448c609719bSwdenk- it becomes much easier to port new Linux kernel versions because 24497152b1d0Swdenk lots of low-level, hardware dependent stuff are done by U-Boot 2450c609719bSwdenk 2451c609719bSwdenk- the same Linux kernel image can now be used with different "initrd" 2452c609719bSwdenk images; of course this also means that different kernel images can 2453c609719bSwdenk be run with the same "initrd". This makes testing easier (you don't 2454c609719bSwdenk have to build a new "zImage.initrd" Linux image when you just 2455c609719bSwdenk change a file in your "initrd"). Also, a field-upgrade of the 2456c609719bSwdenk software is easier now. 2457c609719bSwdenk 2458c609719bSwdenk 2459c609719bSwdenkLinux HOWTO: 2460c609719bSwdenk============ 2461c609719bSwdenk 2462c609719bSwdenkPorting Linux to U-Boot based systems: 2463c609719bSwdenk--------------------------------------- 2464c609719bSwdenk 2465c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to 2466c609719bSwdenkconfigure the Linux device drivers for use with your target hardware 2467c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to 2468c609719bSwdenkLinux :-). 2469c609719bSwdenk 2470c609719bSwdenkBut now you can ignore ALL boot loader code (in arch/ppc/mbxboot). 2471c609719bSwdenk 2472c609719bSwdenkJust make sure your machine specific header file (for instance 2473c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board 2474c609719bSwdenkInformation structure as we define in include/u-boot.h, and make 2475c609719bSwdenksure that your definition of IMAP_ADDR uses the same value as your 2476c609719bSwdenkU-Boot configuration in CFG_IMMR. 2477c609719bSwdenk 2478c609719bSwdenk 2479c609719bSwdenkConfiguring the Linux kernel: 2480c609719bSwdenk----------------------------- 2481c609719bSwdenk 2482c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root 2483c609719bSwdenkdevice (initial ramdisk, NFS) for your target system. 2484c609719bSwdenk 2485c609719bSwdenk 2486c609719bSwdenkBuilding a Linux Image: 2487c609719bSwdenk----------------------- 2488c609719bSwdenk 248924ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are 249024ee89b9Swdenknot used. If you use recent kernel source, a new build target 249124ee89b9Swdenk"uImage" will exist which automatically builds an image usable by 249224ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target, 249324ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a 249424ee89b9Swdenk100% compatible format. 2495c609719bSwdenk 2496c609719bSwdenkExample: 2497c609719bSwdenk 2498c609719bSwdenk make TQM850L_config 2499c609719bSwdenk make oldconfig 2500c609719bSwdenk make dep 250124ee89b9Swdenk make uImage 2502c609719bSwdenk 250324ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to 250424ee89b9Swdenkencapsulate a compressed Linux kernel image with header information, 250524ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing: 2506c609719bSwdenk 250724ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format): 250824ee89b9Swdenk 250924ee89b9Swdenk* convert the kernel into a raw binary image: 251024ee89b9Swdenk 251124ee89b9Swdenk ${CROSS_COMPILE}-objcopy -O binary \ 251224ee89b9Swdenk -R .note -R .comment \ 251324ee89b9Swdenk -S vmlinux linux.bin 251424ee89b9Swdenk 251524ee89b9Swdenk* compress the binary image: 251624ee89b9Swdenk 251724ee89b9Swdenk gzip -9 linux.bin 251824ee89b9Swdenk 251924ee89b9Swdenk* package compressed binary image for U-Boot: 252024ee89b9Swdenk 252124ee89b9Swdenk mkimage -A ppc -O linux -T kernel -C gzip \ 252224ee89b9Swdenk -a 0 -e 0 -n "Linux Kernel Image" \ 252324ee89b9Swdenk -d linux.bin.gz uImage 252424ee89b9Swdenk 252524ee89b9Swdenk 252624ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use 252724ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or 252824ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64 252924ee89b9Swdenkbyte header containing information about target architecture, 253024ee89b9Swdenkoperating system, image type, compression method, entry points, time 253124ee89b9Swdenkstamp, CRC32 checksums, etc. 253224ee89b9Swdenk 253324ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and 253424ee89b9Swdenkprint the header information, or to build new images. 2535c609719bSwdenk 2536c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information 2537c609719bSwdenkcontained in the header of an existing U-Boot image; this includes 2538c609719bSwdenkchecksum verification: 2539c609719bSwdenk 2540c609719bSwdenk tools/mkimage -l image 2541c609719bSwdenk -l ==> list image header information 2542c609719bSwdenk 2543c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image 2544c609719bSwdenkfrom a "data file" which is used as image payload: 2545c609719bSwdenk 2546c609719bSwdenk tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \ 2547c609719bSwdenk -n name -d data_file image 2548c609719bSwdenk -A ==> set architecture to 'arch' 2549c609719bSwdenk -O ==> set operating system to 'os' 2550c609719bSwdenk -T ==> set image type to 'type' 2551c609719bSwdenk -C ==> set compression type 'comp' 2552c609719bSwdenk -a ==> set load address to 'addr' (hex) 2553c609719bSwdenk -e ==> set entry point to 'ep' (hex) 2554c609719bSwdenk -n ==> set image name to 'name' 2555c609719bSwdenk -d ==> use image data from 'datafile' 2556c609719bSwdenk 2557c609719bSwdenkRight now, all Linux kernels use the same load address (0x00000000), 2558c609719bSwdenkbut the entry point address depends on the kernel version: 2559c609719bSwdenk 2560c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C, 256124ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000. 2562c609719bSwdenk 2563c609719bSwdenkSo a typical call to build a U-Boot image would read: 2564c609719bSwdenk 256524ee89b9Swdenk -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 256624ee89b9Swdenk > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \ 256724ee89b9Swdenk > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz \ 256824ee89b9Swdenk > examples/uImage.TQM850L 256924ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 2570c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 2571c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 2572c609719bSwdenk Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 2573c609719bSwdenk Load Address: 0x00000000 257424ee89b9Swdenk Entry Point: 0x00000000 2575c609719bSwdenk 2576c609719bSwdenkTo verify the contents of the image (or check for corruption): 2577c609719bSwdenk 257824ee89b9Swdenk -> tools/mkimage -l examples/uImage.TQM850L 257924ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 2580c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 2581c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 2582c609719bSwdenk Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 2583c609719bSwdenk Load Address: 0x00000000 258424ee89b9Swdenk Entry Point: 0x00000000 2585c609719bSwdenk 2586c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade 2587c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this 2588c609719bSwdenkneeds more space in Flash, but boots much faster since it does not 2589c609719bSwdenkneed to be uncompressed: 2590c609719bSwdenk 259124ee89b9Swdenk -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz 259224ee89b9Swdenk -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 259324ee89b9Swdenk > -A ppc -O linux -T kernel -C none -a 0 -e 0 \ 259424ee89b9Swdenk > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux \ 259524ee89b9Swdenk > examples/uImage.TQM850L-uncompressed 259624ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 2597c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 2598c609719bSwdenk Image Type: PowerPC Linux Kernel Image (uncompressed) 2599c609719bSwdenk Data Size: 792160 Bytes = 773.59 kB = 0.76 MB 2600c609719bSwdenk Load Address: 0x00000000 260124ee89b9Swdenk Entry Point: 0x00000000 2602c609719bSwdenk 2603c609719bSwdenk 2604c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file 2605c609719bSwdenkwhen your kernel is intended to use an initial ramdisk: 2606c609719bSwdenk 2607c609719bSwdenk -> tools/mkimage -n 'Simple Ramdisk Image' \ 2608c609719bSwdenk > -A ppc -O linux -T ramdisk -C gzip \ 2609c609719bSwdenk > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd 2610c609719bSwdenk Image Name: Simple Ramdisk Image 2611c609719bSwdenk Created: Wed Jan 12 14:01:50 2000 2612c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 2613c609719bSwdenk Data Size: 566530 Bytes = 553.25 kB = 0.54 MB 2614c609719bSwdenk Load Address: 0x00000000 2615c609719bSwdenk Entry Point: 0x00000000 2616c609719bSwdenk 2617c609719bSwdenk 2618c609719bSwdenkInstalling a Linux Image: 2619c609719bSwdenk------------------------- 2620c609719bSwdenk 2621c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface, 2622c609719bSwdenkyou must convert the image to S-Record format: 2623c609719bSwdenk 2624c609719bSwdenk objcopy -I binary -O srec examples/image examples/image.srec 2625c609719bSwdenk 2626c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot 2627c609719bSwdenkimage header, so the resulting S-Record file will be relative to 2628c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to 2629c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads' 2630c609719bSwdenkcommand. 2631c609719bSwdenk 2632c609719bSwdenkExample: install the image to address 0x40100000 (which on the 2633c609719bSwdenkTQM8xxL is in the first Flash bank): 2634c609719bSwdenk 2635c609719bSwdenk => erase 40100000 401FFFFF 2636c609719bSwdenk 2637c609719bSwdenk .......... done 2638c609719bSwdenk Erased 8 sectors 2639c609719bSwdenk 2640c609719bSwdenk => loads 40100000 2641c609719bSwdenk ## Ready for S-Record download ... 2642c609719bSwdenk ~>examples/image.srec 2643c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 12 13 ... 2644c609719bSwdenk ... 2645c609719bSwdenk 15989 15990 15991 15992 2646c609719bSwdenk [file transfer complete] 2647c609719bSwdenk [connected] 2648c609719bSwdenk ## Start Addr = 0x00000000 2649c609719bSwdenk 2650c609719bSwdenk 2651c609719bSwdenkYou can check the success of the download using the 'iminfo' command; 2652c609719bSwdenkthis includes a checksum verification so you can be sure no data 2653c609719bSwdenkcorruption happened: 2654c609719bSwdenk 2655c609719bSwdenk => imi 40100000 2656c609719bSwdenk 2657c609719bSwdenk ## Checking Image at 40100000 ... 2658c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 2659c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 2660c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 2661c609719bSwdenk Load Address: 00000000 2662c609719bSwdenk Entry Point: 0000000c 2663c609719bSwdenk Verifying Checksum ... OK 2664c609719bSwdenk 2665c609719bSwdenk 2666c609719bSwdenkBoot Linux: 2667c609719bSwdenk----------- 2668c609719bSwdenk 2669c609719bSwdenkThe "bootm" command is used to boot an application that is stored in 2670c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents 2671c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as 2672c609719bSwdenkparameters. You can check and modify this variable using the 2673c609719bSwdenk"printenv" and "setenv" commands: 2674c609719bSwdenk 2675c609719bSwdenk 2676c609719bSwdenk => printenv bootargs 2677c609719bSwdenk bootargs=root=/dev/ram 2678c609719bSwdenk 2679c609719bSwdenk => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 2680c609719bSwdenk 2681c609719bSwdenk => printenv bootargs 2682c609719bSwdenk bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 2683c609719bSwdenk 2684c609719bSwdenk => bootm 40020000 2685c609719bSwdenk ## Booting Linux kernel at 40020000 ... 2686c609719bSwdenk Image Name: 2.2.13 for NFS on TQM850L 2687c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 2688c609719bSwdenk Data Size: 381681 Bytes = 372 kB = 0 MB 2689c609719bSwdenk Load Address: 00000000 2690c609719bSwdenk Entry Point: 0000000c 2691c609719bSwdenk Verifying Checksum ... OK 2692c609719bSwdenk Uncompressing Kernel Image ... OK 2693c609719bSwdenk 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 2694c609719bSwdenk Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 2695c609719bSwdenk time_init: decrementer frequency = 187500000/60 2696c609719bSwdenk Calibrating delay loop... 49.77 BogoMIPS 2697c609719bSwdenk Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000] 2698c609719bSwdenk ... 2699c609719bSwdenk 2700c609719bSwdenkIf you want to boot a Linux kernel with initial ram disk, you pass 27017152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT 2702c609719bSwdenkformat!) to the "bootm" command: 2703c609719bSwdenk 2704c609719bSwdenk => imi 40100000 40200000 2705c609719bSwdenk 2706c609719bSwdenk ## Checking Image at 40100000 ... 2707c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 2708c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 2709c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 2710c609719bSwdenk Load Address: 00000000 2711c609719bSwdenk Entry Point: 0000000c 2712c609719bSwdenk Verifying Checksum ... OK 2713c609719bSwdenk 2714c609719bSwdenk ## Checking Image at 40200000 ... 2715c609719bSwdenk Image Name: Simple Ramdisk Image 2716c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 2717c609719bSwdenk Data Size: 566530 Bytes = 553 kB = 0 MB 2718c609719bSwdenk Load Address: 00000000 2719c609719bSwdenk Entry Point: 00000000 2720c609719bSwdenk Verifying Checksum ... OK 2721c609719bSwdenk 2722c609719bSwdenk => bootm 40100000 40200000 2723c609719bSwdenk ## Booting Linux kernel at 40100000 ... 2724c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 2725c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 2726c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 2727c609719bSwdenk Load Address: 00000000 2728c609719bSwdenk Entry Point: 0000000c 2729c609719bSwdenk Verifying Checksum ... OK 2730c609719bSwdenk Uncompressing Kernel Image ... OK 2731c609719bSwdenk ## Loading RAMDisk Image at 40200000 ... 2732c609719bSwdenk Image Name: Simple Ramdisk Image 2733c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 2734c609719bSwdenk Data Size: 566530 Bytes = 553 kB = 0 MB 2735c609719bSwdenk Load Address: 00000000 2736c609719bSwdenk Entry Point: 00000000 2737c609719bSwdenk Verifying Checksum ... OK 2738c609719bSwdenk Loading Ramdisk ... OK 2739c609719bSwdenk 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 2740c609719bSwdenk Boot arguments: root=/dev/ram 2741c609719bSwdenk time_init: decrementer frequency = 187500000/60 2742c609719bSwdenk Calibrating delay loop... 49.77 BogoMIPS 2743c609719bSwdenk ... 2744c609719bSwdenk RAMDISK: Compressed image found at block 0 2745c609719bSwdenk VFS: Mounted root (ext2 filesystem). 2746c609719bSwdenk 2747c609719bSwdenk bash# 2748c609719bSwdenk 27496069ff26SwdenkMore About U-Boot Image Types: 27506069ff26Swdenk------------------------------ 27516069ff26Swdenk 27526069ff26SwdenkU-Boot supports the following image types: 27536069ff26Swdenk 27546069ff26Swdenk "Standalone Programs" are directly runnable in the environment 27556069ff26Swdenk provided by U-Boot; it is expected that (if they behave 27566069ff26Swdenk well) you can continue to work in U-Boot after return from 27576069ff26Swdenk the Standalone Program. 27586069ff26Swdenk "OS Kernel Images" are usually images of some Embedded OS which 27596069ff26Swdenk will take over control completely. Usually these programs 27606069ff26Swdenk will install their own set of exception handlers, device 27616069ff26Swdenk drivers, set up the MMU, etc. - this means, that you cannot 27626069ff26Swdenk expect to re-enter U-Boot except by resetting the CPU. 27636069ff26Swdenk "RAMDisk Images" are more or less just data blocks, and their 27646069ff26Swdenk parameters (address, size) are passed to an OS kernel that is 27656069ff26Swdenk being started. 27666069ff26Swdenk "Multi-File Images" contain several images, typically an OS 27676069ff26Swdenk (Linux) kernel image and one or more data images like 27686069ff26Swdenk RAMDisks. This construct is useful for instance when you want 27696069ff26Swdenk to boot over the network using BOOTP etc., where the boot 27706069ff26Swdenk server provides just a single image file, but you want to get 27716069ff26Swdenk for instance an OS kernel and a RAMDisk image. 27726069ff26Swdenk 27736069ff26Swdenk "Multi-File Images" start with a list of image sizes, each 27746069ff26Swdenk image size (in bytes) specified by an "uint32_t" in network 27756069ff26Swdenk byte order. This list is terminated by an "(uint32_t)0". 27766069ff26Swdenk Immediately after the terminating 0 follow the images, one by 27776069ff26Swdenk one, all aligned on "uint32_t" boundaries (size rounded up to 27786069ff26Swdenk a multiple of 4 bytes). 27796069ff26Swdenk 27806069ff26Swdenk "Firmware Images" are binary images containing firmware (like 27816069ff26Swdenk U-Boot or FPGA images) which usually will be programmed to 27826069ff26Swdenk flash memory. 27836069ff26Swdenk 27846069ff26Swdenk "Script files" are command sequences that will be executed by 27856069ff26Swdenk U-Boot's command interpreter; this feature is especially 27866069ff26Swdenk useful when you configure U-Boot to use a real shell (hush) 27876069ff26Swdenk as command interpreter. 27886069ff26Swdenk 2789c609719bSwdenk 2790c609719bSwdenkStandalone HOWTO: 2791c609719bSwdenk================= 2792c609719bSwdenk 2793c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and 2794c609719bSwdenkrun "standalone" applications, which can use some resources of 2795c609719bSwdenkU-Boot like console I/O functions or interrupt services. 2796c609719bSwdenk 2797c609719bSwdenkTwo simple examples are included with the sources: 2798c609719bSwdenk 2799c609719bSwdenk"Hello World" Demo: 2800c609719bSwdenk------------------- 2801c609719bSwdenk 2802c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo 2803c609719bSwdenkapplication; it is automatically compiled when you build U-Boot. 2804c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it 2805c609719bSwdenklike that: 2806c609719bSwdenk 2807c609719bSwdenk => loads 2808c609719bSwdenk ## Ready for S-Record download ... 2809c609719bSwdenk ~>examples/hello_world.srec 2810c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 ... 2811c609719bSwdenk [file transfer complete] 2812c609719bSwdenk [connected] 2813c609719bSwdenk ## Start Addr = 0x00040004 2814c609719bSwdenk 2815c609719bSwdenk => go 40004 Hello World! This is a test. 2816c609719bSwdenk ## Starting application at 0x00040004 ... 2817c609719bSwdenk Hello World 2818c609719bSwdenk argc = 7 2819c609719bSwdenk argv[0] = "40004" 2820c609719bSwdenk argv[1] = "Hello" 2821c609719bSwdenk argv[2] = "World!" 2822c609719bSwdenk argv[3] = "This" 2823c609719bSwdenk argv[4] = "is" 2824c609719bSwdenk argv[5] = "a" 2825c609719bSwdenk argv[6] = "test." 2826c609719bSwdenk argv[7] = "<NULL>" 2827c609719bSwdenk Hit any key to exit ... 2828c609719bSwdenk 2829c609719bSwdenk ## Application terminated, rc = 0x0 2830c609719bSwdenk 2831c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt 2832c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'. 2833c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second. 2834c609719bSwdenkThe interrupt service routine is trivial, just printing a '.' 2835c609719bSwdenkcharacter, but this is just a demo program. The application can be 2836c609719bSwdenkcontrolled by the following keys: 2837c609719bSwdenk 2838c609719bSwdenk ? - print current values og the CPM Timer registers 2839c609719bSwdenk b - enable interrupts and start timer 2840c609719bSwdenk e - stop timer and disable interrupts 2841c609719bSwdenk q - quit application 2842c609719bSwdenk 2843c609719bSwdenk => loads 2844c609719bSwdenk ## Ready for S-Record download ... 2845c609719bSwdenk ~>examples/timer.srec 2846c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 ... 2847c609719bSwdenk [file transfer complete] 2848c609719bSwdenk [connected] 2849c609719bSwdenk ## Start Addr = 0x00040004 2850c609719bSwdenk 2851c609719bSwdenk => go 40004 2852c609719bSwdenk ## Starting application at 0x00040004 ... 2853c609719bSwdenk TIMERS=0xfff00980 2854c609719bSwdenk Using timer 1 2855c609719bSwdenk tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0 2856c609719bSwdenk 2857c609719bSwdenkHit 'b': 2858c609719bSwdenk [q, b, e, ?] Set interval 1000000 us 2859c609719bSwdenk Enabling timer 2860c609719bSwdenkHit '?': 2861c609719bSwdenk [q, b, e, ?] ........ 2862c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0 2863c609719bSwdenkHit '?': 2864c609719bSwdenk [q, b, e, ?] . 2865c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0 2866c609719bSwdenkHit '?': 2867c609719bSwdenk [q, b, e, ?] . 2868c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0 2869c609719bSwdenkHit '?': 2870c609719bSwdenk [q, b, e, ?] . 2871c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0 2872c609719bSwdenkHit 'e': 2873c609719bSwdenk [q, b, e, ?] ...Stopping timer 2874c609719bSwdenkHit 'q': 2875c609719bSwdenk [q, b, e, ?] ## Application terminated, rc = 0x0 2876c609719bSwdenk 2877c609719bSwdenk 287885ec0bccSwdenkMinicom warning: 287985ec0bccSwdenk================ 288085ec0bccSwdenk 28817152b1d0SwdenkOver time, many people have reported problems when trying to use the 288285ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd) 288385ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under 2884f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and 288585ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and 288685ec0bccSwdenkuse "cu" for S-Record download ("loads" command). 288785ec0bccSwdenk 288852f52c14SwdenkNevertheless, if you absolutely want to use it try adding this 288952f52c14Swdenkconfiguration to your "File transfer protocols" section: 289052f52c14Swdenk 289152f52c14Swdenk Name Program Name U/D FullScr IO-Red. Multi 289252f52c14Swdenk X kermit /usr/bin/kermit -i -l %l -s Y U Y N N 289352f52c14Swdenk Y kermit /usr/bin/kermit -i -l %l -r N D Y N N 289452f52c14Swdenk 289552f52c14Swdenk 2896c609719bSwdenkNetBSD Notes: 2897c609719bSwdenk============= 2898c609719bSwdenk 2899c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host 2900c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx). 2901c609719bSwdenk 2902c609719bSwdenkBuilding requires a cross environment; it is known to work on 2903c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also 2904c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make). 2905c609719bSwdenkNote that the cross-powerpc package does not install include files; 2906c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is 2907c609719bSwdenkmissing. This file has to be installed and patched manually: 2908c609719bSwdenk 2909c609719bSwdenk # cd /usr/pkg/cross/powerpc-netbsd/include 2910c609719bSwdenk # mkdir powerpc 2911c609719bSwdenk # ln -s powerpc machine 2912c609719bSwdenk # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h 2913c609719bSwdenk # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST 2914c609719bSwdenk 2915c609719bSwdenkNative builds *don't* work due to incompatibilities between native 2916c609719bSwdenkand U-Boot include files. 2917c609719bSwdenk 2918c609719bSwdenkBooting assumes that (the first part of) the image booted is a 2919c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel 2920c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source 2921c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the 2922c609719bSwdenkmeantime, send mail to bruno@exet-ag.de and/or wd@denx.de for 2923c609719bSwdenkdetails. 2924c609719bSwdenk 2925c609719bSwdenk 2926c609719bSwdenkImplementation Internals: 2927c609719bSwdenk========================= 2928c609719bSwdenk 2929c609719bSwdenkThe following is not intended to be a complete description of every 2930c609719bSwdenkimplementation detail. However, it should help to understand the 2931c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom 2932c609719bSwdenkhardware. 2933c609719bSwdenk 2934c609719bSwdenk 2935c609719bSwdenkInitial Stack, Global Data: 2936c609719bSwdenk--------------------------- 2937c609719bSwdenk 2938c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot 2939c609719bSwdenkstarts running out of ROM (flash memory), usually without access to 2940c609719bSwdenksystem RAM (because the memory controller is not initialized yet). 2941c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS 2942c609719bSwdenkis not initialized as zero. To be able to get a C environment working 2943c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation 2944c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU 2945c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and 2946c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be 2947c609719bSwdenklocked as (mis-) used as memory, etc. 2948c609719bSwdenk 29497152b1d0Swdenk Chris Hallinan posted a good summary of these issues to the 295043d9616cSwdenk u-boot-users mailing list: 295143d9616cSwdenk 295243d9616cSwdenk Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)? 295343d9616cSwdenk From: "Chris Hallinan" <clh@net1plus.com> 295443d9616cSwdenk Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET) 295543d9616cSwdenk ... 295643d9616cSwdenk 295743d9616cSwdenk Correct me if I'm wrong, folks, but the way I understand it 295843d9616cSwdenk is this: Using DCACHE as initial RAM for Stack, etc, does not 295943d9616cSwdenk require any physical RAM backing up the cache. The cleverness 296043d9616cSwdenk is that the cache is being used as a temporary supply of 296143d9616cSwdenk necessary storage before the SDRAM controller is setup. It's 296243d9616cSwdenk beyond the scope of this list to expain the details, but you 296343d9616cSwdenk can see how this works by studying the cache architecture and 296443d9616cSwdenk operation in the architecture and processor-specific manuals. 296543d9616cSwdenk 296643d9616cSwdenk OCM is On Chip Memory, which I believe the 405GP has 4K. It 296743d9616cSwdenk is another option for the system designer to use as an 296843d9616cSwdenk initial stack/ram area prior to SDRAM being available. Either 296943d9616cSwdenk option should work for you. Using CS 4 should be fine if your 297043d9616cSwdenk board designers haven't used it for something that would 297143d9616cSwdenk cause you grief during the initial boot! It is frequently not 297243d9616cSwdenk used. 297343d9616cSwdenk 297443d9616cSwdenk CFG_INIT_RAM_ADDR should be somewhere that won't interfere 297543d9616cSwdenk with your processor/board/system design. The default value 297643d9616cSwdenk you will find in any recent u-boot distribution in 297743d9616cSwdenk Walnut405.h should work for you. I'd set it to a value larger 297843d9616cSwdenk than your SDRAM module. If you have a 64MB SDRAM module, set 297943d9616cSwdenk it above 400_0000. Just make sure your board has no resources 298043d9616cSwdenk that are supposed to respond to that address! That code in 298143d9616cSwdenk start.S has been around a while and should work as is when 298243d9616cSwdenk you get the config right. 298343d9616cSwdenk 298443d9616cSwdenk -Chris Hallinan 298543d9616cSwdenk DS4.COM, Inc. 298643d9616cSwdenk 2987c609719bSwdenkIt is essential to remember this, since it has some impact on the C 2988c609719bSwdenkcode for the initialization procedures: 2989c609719bSwdenk 2990c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt 2991c609719bSwdenk to write it. 2992c609719bSwdenk 2993c609719bSwdenk* Do not use any unitialized global data (or implicitely initialized 2994c609719bSwdenk as zero data - BSS segment) at all - this is undefined, initiali- 29957152b1d0Swdenk zation is performed later (when relocating to RAM). 2996c609719bSwdenk 2997c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like 2998c609719bSwdenk that. 2999c609719bSwdenk 3000c609719bSwdenkHaving only the stack as writable memory limits means we cannot use 3001c609719bSwdenknormal global data to share information beween the code. But it 3002c609719bSwdenkturned out that the implementation of U-Boot can be greatly 3003c609719bSwdenksimplified by making a global data structure (gd_t) available to all 3004c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_ 3005c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of 3006c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we 3007c609719bSwdenkplace a pointer (gd) to the global data into a register which we 3008c609719bSwdenkreserve for this purpose. 3009c609719bSwdenk 30107152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the 3011c609719bSwdenkrelevant (E)ABI specifications for the current architecture, and by 3012c609719bSwdenkGCC's implementation. 3013c609719bSwdenk 3014c609719bSwdenkFor PowerPC, the following registers have specific use: 3015c609719bSwdenk R1: stack pointer 3016c609719bSwdenk R2: TOC pointer 3017c609719bSwdenk R3-R4: parameter passing and return values 3018c609719bSwdenk R5-R10: parameter passing 3019c609719bSwdenk R13: small data area pointer 3020c609719bSwdenk R30: GOT pointer 3021c609719bSwdenk R31: frame pointer 3022c609719bSwdenk 3023c609719bSwdenk (U-Boot also uses R14 as internal GOT pointer.) 3024c609719bSwdenk 3025c609719bSwdenk ==> U-Boot will use R29 to hold a pointer to the global data 3026c609719bSwdenk 3027c609719bSwdenk Note: on PPC, we could use a static initializer (since the 3028c609719bSwdenk address of the global data structure is known at compile time), 3029c609719bSwdenk but it turned out that reserving a register results in somewhat 3030c609719bSwdenk smaller code - although the code savings are not that big (on 3031c609719bSwdenk average for all boards 752 bytes for the whole U-Boot image, 3032c609719bSwdenk 624 text + 127 data). 3033c609719bSwdenk 3034c609719bSwdenkOn ARM, the following registers are used: 3035c609719bSwdenk 3036c609719bSwdenk R0: function argument word/integer result 3037c609719bSwdenk R1-R3: function argument word 3038c609719bSwdenk R9: GOT pointer 3039c609719bSwdenk R10: stack limit (used only if stack checking if enabled) 3040c609719bSwdenk R11: argument (frame) pointer 3041c609719bSwdenk R12: temporary workspace 3042c609719bSwdenk R13: stack pointer 3043c609719bSwdenk R14: link register 3044c609719bSwdenk R15: program counter 3045c609719bSwdenk 3046c609719bSwdenk ==> U-Boot will use R8 to hold a pointer to the global data 3047c609719bSwdenk 3048c609719bSwdenk 3049c609719bSwdenkMemory Management: 3050c609719bSwdenk------------------ 3051c609719bSwdenk 3052c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the 3053c609719bSwdenkMMU is not used either for address mapping nor for memory protection. 3054c609719bSwdenk 3055c609719bSwdenkThe available memory is mapped to fixed addresses using the memory 3056c609719bSwdenkcontroller. In this process, a contiguous block is formed for each 3057c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several 3058c609719bSwdenkphysical memory banks. 3059c609719bSwdenk 3060c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on 3061c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After 3062c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself 3063c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some 3064c609719bSwdenkmemory is reserved for use by malloc() [see CFG_MALLOC_LEN 3065c609719bSwdenkconfiguration setting]. Below that, a structure with global Board 3066c609719bSwdenkInfo data is placed, followed by the stack (growing downward). 3067c609719bSwdenk 3068c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB 3069c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF). 3070c609719bSwdenk 3071c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like 3072c609719bSwdenkthis: 3073c609719bSwdenk 3074c609719bSwdenk 0x0000 0000 Exception Vector code 3075c609719bSwdenk : 3076c609719bSwdenk 0x0000 1FFF 3077c609719bSwdenk 0x0000 2000 Free for Application Use 3078c609719bSwdenk : 3079c609719bSwdenk : 3080c609719bSwdenk 3081c609719bSwdenk : 3082c609719bSwdenk : 3083c609719bSwdenk 0x00FB FF20 Monitor Stack (Growing downward) 3084c609719bSwdenk 0x00FB FFAC Board Info Data and permanent copy of global data 3085c609719bSwdenk 0x00FC 0000 Malloc Arena 3086c609719bSwdenk : 3087c609719bSwdenk 0x00FD FFFF 3088c609719bSwdenk 0x00FE 0000 RAM Copy of Monitor Code 3089c609719bSwdenk ... eventually: LCD or video framebuffer 3090c609719bSwdenk ... eventually: pRAM (Protected RAM - unchanged by reset) 3091c609719bSwdenk 0x00FF FFFF [End of RAM] 3092c609719bSwdenk 3093c609719bSwdenk 3094c609719bSwdenkSystem Initialization: 3095c609719bSwdenk---------------------- 3096c609719bSwdenk 3097c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point 3098c609719bSwdenk(on most PowerPC systens at address 0x00000100). Because of the reset 3099c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory. 31007152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address. 3101c609719bSwdenkTo be able to implement the initialization code in C, a (small!) 3102c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs 3103c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked 3104c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core, 3105c609719bSwdenkthe caches and the SIU. 3106c609719bSwdenk 3107c609719bSwdenkNext, all (potentially) available memory banks are mapped using a 3108c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries 3109c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash 3110c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is 3111c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a 3112c609719bSwdenksimple memory test is run that determines the size of the SDRAM 3113c609719bSwdenkbanks. 3114c609719bSwdenk 3115c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of 31167152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first 3117c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address 3118c609719bSwdenk0x00000000, with any additional banks following immediately to create 3119c609719bSwdenkcontiguous memory starting from 0. 3120c609719bSwdenk 3121c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area 3122c609719bSwdenkand allocates memory for use by malloc() and for the global Board 3123c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM 3124c609719bSwdenkpages, and the final stack is set up. 3125c609719bSwdenk 3126c609719bSwdenkOnly after this relocation will you have a "normal" C environment; 3127c609719bSwdenkuntil that you are restricted in several ways, mostly because you are 3128c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a 3129c609719bSwdenknew address in RAM. 3130c609719bSwdenk 3131c609719bSwdenk 3132c609719bSwdenkU-Boot Porting Guide: 3133c609719bSwdenk---------------------- 3134c609719bSwdenk 3135c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing 31366aff3115Swdenklist, October 2002] 3137c609719bSwdenk 3138c609719bSwdenk 3139c609719bSwdenkint main (int argc, char *argv[]) 3140c609719bSwdenk{ 3141c609719bSwdenk sighandler_t no_more_time; 3142c609719bSwdenk 3143c609719bSwdenk signal (SIGALRM, no_more_time); 3144c609719bSwdenk alarm (PROJECT_DEADLINE - toSec (3 * WEEK)); 3145c609719bSwdenk 3146c609719bSwdenk if (available_money > available_manpower) { 3147c609719bSwdenk pay consultant to port U-Boot; 3148c609719bSwdenk return 0; 3149c609719bSwdenk } 3150c609719bSwdenk 3151c609719bSwdenk Download latest U-Boot source; 3152c609719bSwdenk 31536aff3115Swdenk Subscribe to u-boot-users mailing list; 31546aff3115Swdenk 3155c609719bSwdenk if (clueless) { 3156c609719bSwdenk email ("Hi, I am new to U-Boot, how do I get started?"); 3157c609719bSwdenk } 3158c609719bSwdenk 3159c609719bSwdenk while (learning) { 3160c609719bSwdenk Read the README file in the top level directory; 31617cb22f97Swdenk Read http://www.denx.de/twiki/bin/view/DULG/Manual ; 3162c609719bSwdenk Read the source, Luke; 3163c609719bSwdenk } 3164c609719bSwdenk 3165c609719bSwdenk if (available_money > toLocalCurrency ($2500)) { 3166c609719bSwdenk Buy a BDI2000; 3167c609719bSwdenk } else { 3168c609719bSwdenk Add a lot of aggravation and time; 3169c609719bSwdenk } 3170c609719bSwdenk 3171c609719bSwdenk Create your own board support subdirectory; 3172c609719bSwdenk 31736aff3115Swdenk Create your own board config file; 31746aff3115Swdenk 3175c609719bSwdenk while (!running) { 3176c609719bSwdenk do { 3177c609719bSwdenk Add / modify source code; 3178c609719bSwdenk } until (compiles); 3179c609719bSwdenk Debug; 3180c609719bSwdenk if (clueless) 3181c609719bSwdenk email ("Hi, I am having problems..."); 3182c609719bSwdenk } 3183c609719bSwdenk Send patch file to Wolfgang; 3184c609719bSwdenk 3185c609719bSwdenk return 0; 3186c609719bSwdenk} 3187c609719bSwdenk 3188c609719bSwdenkvoid no_more_time (int sig) 3189c609719bSwdenk{ 3190c609719bSwdenk hire_a_guru(); 3191c609719bSwdenk} 3192c609719bSwdenk 3193c609719bSwdenk 3194c609719bSwdenkCoding Standards: 3195c609719bSwdenk----------------- 3196c609719bSwdenk 3197c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel 3198c609719bSwdenkcoding style; see the file "Documentation/CodingStyle" in your Linux 3199c609719bSwdenkkernel source directory. 3200c609719bSwdenk 3201c609719bSwdenkPlease note that U-Boot is implemented in C (and to some small parts 3202c609719bSwdenkin Assembler); no C++ is used, so please do not use C++ style 3203c609719bSwdenkcomments (//) in your code. 3204c609719bSwdenk 3205c178d3daSwdenkPlease also stick to the following formatting rules: 3206180d3f74Swdenk- remove any trailing white space 3207180d3f74Swdenk- use TAB characters for indentation, not spaces 3208180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds 3209180d3f74Swdenk- do not add more than 2 empty lines to source files 3210180d3f74Swdenk- do not add trailing empty lines to source files 3211180d3f74Swdenk 3212c609719bSwdenkSubmissions which do not conform to the standards may be returned 3213c609719bSwdenkwith a request to reformat the changes. 3214c609719bSwdenk 3215c609719bSwdenk 3216c609719bSwdenkSubmitting Patches: 3217c609719bSwdenk------------------- 3218c609719bSwdenk 3219c609719bSwdenkSince the number of patches for U-Boot is growing, we need to 3220c609719bSwdenkestablish some rules. Submissions which do not conform to these rules 3221c609719bSwdenkmay be rejected, even when they contain important and valuable stuff. 3222c609719bSwdenk 3223c609719bSwdenk 3224c609719bSwdenkWhen you send a patch, please include the following information with 3225c609719bSwdenkit: 3226c609719bSwdenk 3227c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes 3228c609719bSwdenk this bug. Please try to include a way of demonstrating that the 3229c609719bSwdenk patch actually fixes something. 3230c609719bSwdenk 3231c609719bSwdenk* For new features: a description of the feature and your 3232c609719bSwdenk implementation. 3233c609719bSwdenk 3234c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch) 3235c609719bSwdenk 3236c609719bSwdenk* For major contributions, your entry to the CREDITS file 3237c609719bSwdenk 3238c609719bSwdenk* When you add support for a new board, don't forget to add this 3239c609719bSwdenk board to the MAKEALL script, too. 3240c609719bSwdenk 3241c609719bSwdenk* If your patch adds new configuration options, don't forget to 3242c609719bSwdenk document these in the README file. 3243c609719bSwdenk 3244c609719bSwdenk* The patch itself. If you are accessing the CVS repository use "cvs 3245c609719bSwdenk update; cvs diff -puRN"; else, use "diff -purN OLD NEW". If your 3246c609719bSwdenk version of diff does not support these options, then get the latest 3247c609719bSwdenk version of GNU diff. 3248c609719bSwdenk 32496dff5529Swdenk The current directory when running this command shall be the top 32506dff5529Swdenk level directory of the U-Boot source tree, or it's parent directory 32516dff5529Swdenk (i. e. please make sure that your patch includes sufficient 32526dff5529Swdenk directory information for the affected files). 32536dff5529Swdenk 3254c609719bSwdenk We accept patches as plain text, MIME attachments or as uuencoded 3255c609719bSwdenk gzipped text. 3256c609719bSwdenk 325752f52c14Swdenk* If one logical set of modifications affects or creates several 325852f52c14Swdenk files, all these changes shall be submitted in a SINGLE patch file. 325952f52c14Swdenk 326052f52c14Swdenk* Changesets that contain different, unrelated modifications shall be 326152f52c14Swdenk submitted as SEPARATE patches, one patch per changeset. 326252f52c14Swdenk 326352f52c14Swdenk 3264c609719bSwdenkNotes: 3265c609719bSwdenk 3266c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched 3267c609719bSwdenk source tree and make sure that no errors or warnings are reported 3268c609719bSwdenk for any of the boards. 3269c609719bSwdenk 3270c609719bSwdenk* Keep your modifications to the necessary minimum: A patch 3271c609719bSwdenk containing several unrelated changes or arbitrary reformats will be 3272c609719bSwdenk returned with a request to re-formatting / split it. 3273c609719bSwdenk 3274c609719bSwdenk* If you modify existing code, make sure that your new code does not 3275c609719bSwdenk add to the memory footprint of the code ;-) Small is beautiful! 3276c609719bSwdenk When adding new features, these should compile conditionally only 3277c609719bSwdenk (using #ifdef), and the resulting code with the new feature 3278c609719bSwdenk disabled must not need more memory than the old code without your 3279c609719bSwdenk modification. 3280