1c609719bSwdenk# 2c609719bSwdenk# (C) Copyright 2000 - 2002 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 122c609719bSwdenk- board Board dependend files 123c609719bSwdenk- common Misc architecture independend functions 124c609719bSwdenk- cpu CPU specific files 125c609719bSwdenk- disk Code for disk drive partition handling 126c609719bSwdenk- doc Documentation (don't expect too much) 127c609719bSwdenk- drivers Common used device drivers 128c609719bSwdenk- dtt Digital Thermometer and Thermostat drivers 129c609719bSwdenk- examples Example code for standalone applications, etc. 130c609719bSwdenk- include Header Files 131c609719bSwdenk- disk Harddisk interface code 132c609719bSwdenk- net Networking code 133c609719bSwdenk- ppc Files generic to PowerPC architecture 134c609719bSwdenk- post Power On Self Test 135c609719bSwdenk- post/arch Symlink to architecture specific Power On Self Test 136c609719bSwdenk- post/arch-ppc PowerPC architecture specific Power On Self Test 137c609719bSwdenk- post/cpu/mpc8260 MPC8260 CPU specific Power On Self Test 138c609719bSwdenk- post/cpu/mpc8xx MPC8xx CPU specific Power On Self Test 139c609719bSwdenk- rtc Real Time Clock drivers 140c609719bSwdenk- tools Tools to build S-Record or U-Boot images, etc. 141c609719bSwdenk 142c609719bSwdenk- cpu/74xx_7xx Files specific to Motorola MPC74xx and 7xx CPUs 1430db5bca8Swdenk- cpu/mpc5xx Files specific to Motorola MPC5xx CPUs 144c609719bSwdenk- cpu/mpc8xx Files specific to Motorola MPC8xx CPUs 145c609719bSwdenk- cpu/mpc824x Files specific to Motorola MPC824x CPUs 146c609719bSwdenk- cpu/mpc8260 Files specific to Motorola MPC8260 CPU 147c609719bSwdenk- cpu/ppc4xx Files specific to IBM 4xx CPUs 148c609719bSwdenk 1493bac3513Swdenk- board/LEOX/ Files specific to boards manufactured by The LEOX team 1503bac3513Swdenk- board/LEOX/elpt860 Files specific to ELPT860 boards 151c609719bSwdenk- board/RPXClassic 152c609719bSwdenk Files specific to RPXClassic boards 153c609719bSwdenk- board/RPXlite Files specific to RPXlite boards 154c609719bSwdenk- board/c2mon Files specific to c2mon boards 1550db5bca8Swdenk- board/cmi Files specific to cmi boards 156c609719bSwdenk- board/cogent Files specific to Cogent boards 157c609719bSwdenk (need further configuration) 158c609719bSwdenk Files specific to CPCIISER4 boards 159c609719bSwdenk- board/cpu86 Files specific to CPU86 boards 160c609719bSwdenk- board/cray/ Files specific to boards manufactured by Cray 161c609719bSwdenk- board/cray/L1 Files specific to L1 boards 162c609719bSwdenk- board/cu824 Files specific to CU824 boards 163c609719bSwdenk- board/ebony Files specific to IBM Ebony board 164c609719bSwdenk- board/eric Files specific to ERIC boards 165c609719bSwdenk- board/esd/ Files specific to boards manufactured by ESD 166c609719bSwdenk- board/esd/adciop Files specific to ADCIOP boards 167c609719bSwdenk- board/esd/ar405 Files specific to AR405 boards 168c609719bSwdenk- board/esd/canbt Files specific to CANBT boards 169c609719bSwdenk- board/esd/cpci405 Files specific to CPCI405 boards 170c609719bSwdenk- board/esd/cpciiser4 Files specific to CPCIISER4 boards 171c609719bSwdenk- board/esd/common Common files for ESD boards 172c609719bSwdenk- board/esd/dasa_sim Files specific to DASA_SIM boards 173c609719bSwdenk- board/esd/du405 Files specific to DU405 boards 174c609719bSwdenk- board/esd/ocrtc Files specific to OCRTC boards 175c609719bSwdenk- board/esd/pci405 Files specific to PCI405 boards 176c609719bSwdenk- board/esteem192e 177c609719bSwdenk Files specific to ESTEEM192E boards 178c609719bSwdenk- board/etx094 Files specific to ETX_094 boards 179c609719bSwdenk- board/evb64260 180c609719bSwdenk Files specific to EVB64260 boards 181c609719bSwdenk- board/fads Files specific to FADS boards 182c609719bSwdenk- board/flagadm Files specific to FLAGADM boards 1837aa78614Swdenk- board/gen860t Files specific to GEN860T and GEN860T_SC boards 184c609719bSwdenk- board/genietv Files specific to GENIETV boards 185c609719bSwdenk- board/gth Files specific to GTH boards 186c609719bSwdenk- board/hermes Files specific to HERMES boards 187c609719bSwdenk- board/hymod Files specific to HYMOD boards 188c609719bSwdenk- board/icu862 Files specific to ICU862 boards 189c609719bSwdenk- board/ip860 Files specific to IP860 boards 190c609719bSwdenk- board/iphase4539 191c609719bSwdenk Files specific to Interphase4539 boards 192c609719bSwdenk- board/ivm Files specific to IVMS8/IVML24 boards 193c609719bSwdenk- board/lantec Files specific to LANTEC boards 194c609719bSwdenk- board/lwmon Files specific to LWMON boards 195c609719bSwdenk- board/mbx8xx Files specific to MBX boards 196c609719bSwdenk- board/mpc8260ads 197c609719bSwdenk Files specific to MMPC8260ADS boards 198c609719bSwdenk- board/mpl/ Files specific to boards manufactured by MPL 199c609719bSwdenk- board/mpl/common Common files for MPL boards 200c609719bSwdenk- board/mpl/pip405 Files specific to PIP405 boards 201c609719bSwdenk- board/mpl/mip405 Files specific to MIP405 boards 202c609719bSwdenk- board/musenki Files specific to MUSEKNI boards 203c609719bSwdenk- board/mvs1 Files specific to MVS1 boards 204c609719bSwdenk- board/nx823 Files specific to NX823 boards 205c609719bSwdenk- board/oxc Files specific to OXC boards 206c609719bSwdenk- board/pcippc2 Files specific to PCIPPC2/PCIPPC6 boards 207c609719bSwdenk- board/pm826 Files specific to PM826 boards 208c609719bSwdenk- board/ppmc8260 209c609719bSwdenk Files specific to PPMC8260 boards 210c609719bSwdenk- board/rpxsuper 211c609719bSwdenk Files specific to RPXsuper boards 212c609719bSwdenk- board/rsdproto 213c609719bSwdenk Files specific to RSDproto boards 214c609719bSwdenk- board/sandpoint 215c609719bSwdenk Files specific to Sandpoint boards 216c609719bSwdenk- board/sbc8260 Files specific to SBC8260 boards 217c609719bSwdenk- board/sacsng Files specific to SACSng boards 218c609719bSwdenk- board/siemens Files specific to boards manufactured by Siemens AG 219c609719bSwdenk- board/siemens/CCM Files specific to CCM boards 220c609719bSwdenk- board/siemens/IAD210 Files specific to IAD210 boards 221c609719bSwdenk- board/siemens/SCM Files specific to SCM boards 222c609719bSwdenk- board/siemens/pcu_e Files specific to PCU_E boards 223c609719bSwdenk- board/sixnet Files specific to SIXNET boards 224c609719bSwdenk- board/spd8xx Files specific to SPD8xxTS boards 225c609719bSwdenk- board/tqm8260 Files specific to TQM8260 boards 226c609719bSwdenk- board/tqm8xx Files specific to TQM8xxL boards 227c609719bSwdenk- board/w7o Files specific to W7O boards 228c609719bSwdenk- board/walnut405 229c609719bSwdenk Files specific to Walnut405 boards 230c609719bSwdenk- board/westel/ Files specific to boards manufactured by Westel Wireless 231c609719bSwdenk- board/westel/amx860 Files specific to AMX860 boards 232c609719bSwdenk- board/utx8245 Files specific to UTX8245 boards 233c609719bSwdenk 234c609719bSwdenkSoftware Configuration: 235c609719bSwdenk======================= 236c609719bSwdenk 237c609719bSwdenkConfiguration is usually done using C preprocessor defines; the 238c609719bSwdenkrationale behind that is to avoid dead code whenever possible. 239c609719bSwdenk 240c609719bSwdenkThere are two classes of configuration variables: 241c609719bSwdenk 242c609719bSwdenk* Configuration _OPTIONS_: 243c609719bSwdenk These are selectable by the user and have names beginning with 244c609719bSwdenk "CONFIG_". 245c609719bSwdenk 246c609719bSwdenk* Configuration _SETTINGS_: 247c609719bSwdenk These depend on the hardware etc. and should not be meddled with if 248c609719bSwdenk you don't know what you're doing; they have names beginning with 249c609719bSwdenk "CFG_". 250c609719bSwdenk 251c609719bSwdenkLater we will add a configuration tool - probably similar to or even 252c609719bSwdenkidentical to what's used for the Linux kernel. Right now, we have to 253c609719bSwdenkdo the configuration by hand, which means creating some symbolic 254c609719bSwdenklinks and editing some configuration files. We use the TQM8xxL boards 255c609719bSwdenkas an example here. 256c609719bSwdenk 257c609719bSwdenk 258c609719bSwdenkSelection of Processor Architecture and Board Type: 259c609719bSwdenk--------------------------------------------------- 260c609719bSwdenk 261c609719bSwdenkFor all supported boards there are ready-to-use default 262c609719bSwdenkconfigurations available; just type "make <board_name>_config". 263c609719bSwdenk 264c609719bSwdenkExample: For a TQM823L module type: 265c609719bSwdenk 266c609719bSwdenk cd u-boot 267c609719bSwdenk make TQM823L_config 268c609719bSwdenk 269c609719bSwdenkFor the Cogent platform, you need to specify the cpu type as well; 270c609719bSwdenke.g. "make cogent_mpc8xx_config". And also configure the cogent 271c609719bSwdenkdirectory according to the instructions in cogent/README. 272c609719bSwdenk 273c609719bSwdenk 274c609719bSwdenkConfiguration Options: 275c609719bSwdenk---------------------- 276c609719bSwdenk 277c609719bSwdenkConfiguration depends on the combination of board and CPU type; all 278c609719bSwdenksuch information is kept in a configuration file 279c609719bSwdenk"include/configs/<board_name>.h". 280c609719bSwdenk 281c609719bSwdenkExample: For a TQM823L module, all configuration settings are in 282c609719bSwdenk"include/configs/TQM823L.h". 283c609719bSwdenk 284c609719bSwdenk 2857f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux 2867f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to 2877f6c2cbcSwdenkbuild a config tool - later. 2887f6c2cbcSwdenk 2897f6c2cbcSwdenk 290c609719bSwdenkThe following options need to be configured: 291c609719bSwdenk 292c609719bSwdenk- CPU Type: Define exactly one of 293c609719bSwdenk 294c609719bSwdenk PowerPC based CPUs: 295c609719bSwdenk ------------------- 296c609719bSwdenk CONFIG_MPC823, CONFIG_MPC850, CONFIG_MPC855, CONFIG_MPC860 2970db5bca8Swdenk or CONFIG_MPC5xx 298c609719bSwdenk or CONFIG_MPC824X, CONFIG_MPC8260 299c609719bSwdenk or CONFIG_IOP480 300c609719bSwdenk or CONFIG_405GP 301c609719bSwdenk or CONFIG_440 302c609719bSwdenk or CONFIG_MPC74xx 303c609719bSwdenk 304c609719bSwdenk ARM based CPUs: 305c609719bSwdenk --------------- 306c609719bSwdenk CONFIG_SA1110 307c609719bSwdenk CONFIG_ARM7 308c609719bSwdenk CONFIG_PXA250 309c609719bSwdenk 310c609719bSwdenk 311c609719bSwdenk- Board Type: Define exactly one of 312c609719bSwdenk 313c609719bSwdenk PowerPC based boards: 314c609719bSwdenk --------------------- 315c609719bSwdenk 316c609719bSwdenk CONFIG_ADCIOP, CONFIG_ICU862 CONFIG_RPXsuper, 317c609719bSwdenk CONFIG_ADS860, CONFIG_IP860, CONFIG_SM850, 318c609719bSwdenk CONFIG_AMX860, CONFIG_IPHASE4539, CONFIG_SPD823TS, 319c609719bSwdenk CONFIG_AR405, CONFIG_IVML24, CONFIG_SXNI855T, 320c609719bSwdenk CONFIG_BAB7xx, CONFIG_IVML24_128, CONFIG_Sandpoint8240, 321c609719bSwdenk CONFIG_CANBT, CONFIG_IVML24_256, CONFIG_Sandpoint8245, 322c609719bSwdenk CONFIG_CCM, CONFIG_IVMS8, CONFIG_TQM823L, 323c609719bSwdenk CONFIG_CPCI405, CONFIG_IVMS8_128, CONFIG_TQM850L, 324c609719bSwdenk CONFIG_CPCI4052, CONFIG_IVMS8_256, CONFIG_TQM855L, 325c609719bSwdenk CONFIG_CPCIISER4, CONFIG_LANTEC, CONFIG_TQM860L, 326c609719bSwdenk CONFIG_CPU86, CONFIG_MBX, CONFIG_TQM8260, 327c609719bSwdenk CONFIG_CRAYL1, CONFIG_MBX860T, CONFIG_TTTech, 328c609719bSwdenk CONFIG_CU824, CONFIG_MHPC, CONFIG_UTX8245, 329c609719bSwdenk CONFIG_DASA_SIM, CONFIG_MIP405, CONFIG_W7OLMC, 330c609719bSwdenk CONFIG_DU405, CONFIG_MOUSSE, CONFIG_W7OLMG, 331c609719bSwdenk CONFIG_ELPPC, CONFIG_MPC8260ADS, CONFIG_WALNUT405, 332c609719bSwdenk CONFIG_ERIC, CONFIG_MUSENKI, CONFIG_ZUMA, 333c609719bSwdenk CONFIG_ESTEEM192E, CONFIG_MVS1, CONFIG_c2mon, 334c609719bSwdenk CONFIG_ETX094, CONFIG_NX823, CONFIG_cogent_mpc8260, 335c609719bSwdenk CONFIG_EVB64260, CONFIG_OCRTC, CONFIG_cogent_mpc8xx, 336c609719bSwdenk CONFIG_FADS823, CONFIG_ORSG, CONFIG_ep8260, 337c609719bSwdenk CONFIG_FADS850SAR, CONFIG_OXC, CONFIG_gw8260, 338c609719bSwdenk CONFIG_FADS860T, CONFIG_PCI405, CONFIG_hermes, 339c609719bSwdenk CONFIG_FLAGADM, CONFIG_PCIPPC2, CONFIG_hymod, 340c609719bSwdenk CONFIG_FPS850L, CONFIG_PCIPPC6, CONFIG_lwmon, 341c609719bSwdenk CONFIG_GEN860T, CONFIG_PIP405, CONFIG_pcu_e, 342c609719bSwdenk CONFIG_GENIETV, CONFIG_PM826, CONFIG_ppmc8260, 343c609719bSwdenk CONFIG_GTH, CONFIG_RPXClassic, CONFIG_rsdproto, 344c609719bSwdenk CONFIG_IAD210, CONFIG_RPXlite, CONFIG_sbc8260, 345608c9146Swdenk CONFIG_EBONY, CONFIG_sacsng, CONFIG_FPS860L, 346*7f70e853Swdenk CONFIG_V37, CONFIG_ELPT860, CONFIG_CMI, 347*7f70e853Swdenk CONFIG_NETVIA 348c609719bSwdenk 349c609719bSwdenk ARM based boards: 350c609719bSwdenk ----------------- 351c609719bSwdenk 352c609719bSwdenk CONFIG_HHP_CRADLE, CONFIG_DNP1110, CONFIG_EP7312, 353c609719bSwdenk CONFIG_IMPA7, CONFIG_LART, CONFIG_LUBBOCK, 354c609719bSwdenk CONFIG_SHANNON, CONFIG_SMDK2400, CONFIG_SMDK2410, 355c609719bSwdenk CONFIG_TRAB 356c609719bSwdenk 357c609719bSwdenk 358c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined) 359c609719bSwdenk Define exactly one of 360c609719bSwdenk CONFIG_CMA286_60_OLD 361c609719bSwdenk--- FIXME --- not tested yet: 362c609719bSwdenk CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P, 363c609719bSwdenk CONFIG_CMA287_23, CONFIG_CMA287_50 364c609719bSwdenk 365c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined) 366c609719bSwdenk Define exactly one of 367c609719bSwdenk CONFIG_CMA101, CONFIG_CMA102 368c609719bSwdenk 369c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined) 370c609719bSwdenk Define one or more of 371c609719bSwdenk CONFIG_CMA302 372c609719bSwdenk 373c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined) 374c609719bSwdenk Define one or more of 375c609719bSwdenk CONFIG_LCD_HEARTBEAT - update a character position on 376c609719bSwdenk the lcd display every second with 377c609719bSwdenk a "rotator" |\-/|\-/ 378c609719bSwdenk 379c609719bSwdenk- MPC824X Family Member (if CONFIG_MPC824X is defined) 380c609719bSwdenk Define exactly one of 381c609719bSwdenk CONFIG_MPC8240, CONFIG_MPC8245 382c609719bSwdenk 383c609719bSwdenk- 8xx CPU Options: (if using an 8xx cpu) 384c609719bSwdenk Define one or more of 385c609719bSwdenk CONFIG_8xx_GCLK_FREQ - if get_gclk_freq() can not work e.g. 386c609719bSwdenk no 32KHz reference PIT/RTC clock 387c609719bSwdenk 388c609719bSwdenk- Clock Interface: 389c609719bSwdenk CONFIG_CLOCKS_IN_MHZ 390c609719bSwdenk 391c609719bSwdenk U-Boot stores all clock information in Hz 392c609719bSwdenk internally. For binary compatibility with older Linux 393c609719bSwdenk kernels (which expect the clocks passed in the 394c609719bSwdenk bd_info data to be in MHz) the environment variable 395c609719bSwdenk "clocks_in_mhz" can be defined so that U-Boot 396c609719bSwdenk converts clock data to MHZ before passing it to the 397c609719bSwdenk Linux kernel. 398c609719bSwdenk 399c609719bSwdenk When CONFIG_CLOCKS_IN_MHZ is defined, a definition of 400c609719bSwdenk "clocks_in_mhz=1" is automatically included in the 401c609719bSwdenk default environment. 402c609719bSwdenk 403c609719bSwdenk- Console Interface: 404c609719bSwdenk Depending on board, define exactly one serial port 405c609719bSwdenk (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2, 406c609719bSwdenk CONFIG_8xx_CONS_SCC1, ...), or switch off the serial 407c609719bSwdenk console by defining CONFIG_8xx_CONS_NONE 408c609719bSwdenk 409c609719bSwdenk Note: if CONFIG_8xx_CONS_NONE is defined, the serial 410c609719bSwdenk port routines must be defined elsewhere 411c609719bSwdenk (i.e. serial_init(), serial_getc(), ...) 412c609719bSwdenk 413c609719bSwdenk CONFIG_CFB_CONSOLE 414c609719bSwdenk Enables console device for a color framebuffer. Needs following 415c609719bSwdenk defines (cf. smiLynxEM, i8042, board/eltec/bab7xx) 416c609719bSwdenk VIDEO_FB_LITTLE_ENDIAN graphic memory organisation 417c609719bSwdenk (default big endian) 418c609719bSwdenk VIDEO_HW_RECTFILL graphic chip supports 419c609719bSwdenk rectangle fill 420c609719bSwdenk (cf. smiLynxEM) 421c609719bSwdenk VIDEO_HW_BITBLT graphic chip supports 422c609719bSwdenk bit-blit (cf. smiLynxEM) 423c609719bSwdenk VIDEO_VISIBLE_COLS visible pixel columns 424c609719bSwdenk (cols=pitch) 425c609719bSwdenk VIDEO_VISIBLE_ROWS visible pixel rows 426c609719bSwdenk VIDEO_PIXEL_SIZE bytes per pixel 427c609719bSwdenk VIDEO_DATA_FORMAT graphic data format 428c609719bSwdenk (0-5, cf. cfb_console.c) 429c609719bSwdenk VIDEO_FB_ADRS framebuffer address 430c609719bSwdenk VIDEO_KBD_INIT_FCT keyboard int fct 431c609719bSwdenk (i.e. i8042_kbd_init()) 432c609719bSwdenk VIDEO_TSTC_FCT test char fct 433c609719bSwdenk (i.e. i8042_tstc) 434c609719bSwdenk VIDEO_GETC_FCT get char fct 435c609719bSwdenk (i.e. i8042_getc) 436c609719bSwdenk CONFIG_CONSOLE_CURSOR cursor drawing on/off 437c609719bSwdenk (requires blink timer 438c609719bSwdenk cf. i8042.c) 439c609719bSwdenk CFG_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c) 440c609719bSwdenk CONFIG_CONSOLE_TIME display time/date info in 441c609719bSwdenk upper right corner 442c609719bSwdenk (requires CFG_CMD_DATE) 443c609719bSwdenk CONFIG_VIDEO_LOGO display Linux logo in 444c609719bSwdenk upper left corner 445a6c7ad2fSwdenk CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of 446a6c7ad2fSwdenk linux_logo.h for logo. 447a6c7ad2fSwdenk Requires CONFIG_VIDEO_LOGO 448c609719bSwdenk CONFIG_CONSOLE_EXTRA_INFO 449c609719bSwdenk addional board info beside 450c609719bSwdenk the logo 451c609719bSwdenk 452c609719bSwdenk When CONFIG_CFB_CONSOLE is defined, video console is 453c609719bSwdenk default i/o. Serial console can be forced with 454c609719bSwdenk environment 'console=serial'. 455c609719bSwdenk 456c609719bSwdenk- Console Baudrate: 457c609719bSwdenk CONFIG_BAUDRATE - in bps 458c609719bSwdenk Select one of the baudrates listed in 459c609719bSwdenk CFG_BAUDRATE_TABLE, see below. 460c609719bSwdenk 461c609719bSwdenk- Interrupt driven serial port input: 462c609719bSwdenk CONFIG_SERIAL_SOFTWARE_FIFO 463c609719bSwdenk 464c609719bSwdenk PPC405GP only. 465c609719bSwdenk Use an interrupt handler for receiving data on the 466c609719bSwdenk serial port. It also enables using hardware handshake 467c609719bSwdenk (RTS/CTS) and UART's built-in FIFO. Set the number of 468c609719bSwdenk bytes the interrupt driven input buffer should have. 469c609719bSwdenk 470c609719bSwdenk Set to 0 to disable this feature (this is the default). 471c609719bSwdenk This will also disable hardware handshake. 472c609719bSwdenk 473c609719bSwdenk- Boot Delay: CONFIG_BOOTDELAY - in seconds 474c609719bSwdenk Delay before automatically booting the default image; 475c609719bSwdenk set to -1 to disable autoboot. 476c609719bSwdenk 477c609719bSwdenk See doc/README.autoboot for these options that 478c609719bSwdenk work with CONFIG_BOOTDELAY. None are required. 479c609719bSwdenk CONFIG_BOOT_RETRY_TIME 480c609719bSwdenk CONFIG_BOOT_RETRY_MIN 481c609719bSwdenk CONFIG_AUTOBOOT_KEYED 482c609719bSwdenk CONFIG_AUTOBOOT_PROMPT 483c609719bSwdenk CONFIG_AUTOBOOT_DELAY_STR 484c609719bSwdenk CONFIG_AUTOBOOT_STOP_STR 485c609719bSwdenk CONFIG_AUTOBOOT_DELAY_STR2 486c609719bSwdenk CONFIG_AUTOBOOT_STOP_STR2 487c609719bSwdenk CONFIG_ZERO_BOOTDELAY_CHECK 488c609719bSwdenk CONFIG_RESET_TO_RETRY 489c609719bSwdenk 490c609719bSwdenk- Autoboot Command: 491c609719bSwdenk CONFIG_BOOTCOMMAND 492c609719bSwdenk Only needed when CONFIG_BOOTDELAY is enabled; 493c609719bSwdenk define a command string that is automatically executed 494c609719bSwdenk when no character is read on the console interface 495c609719bSwdenk within "Boot Delay" after reset. 496c609719bSwdenk 497c609719bSwdenk CONFIG_BOOTARGS 498c609719bSwdenk This can be used to pass arguments to the bootm 499c609719bSwdenk command. The value of CONFIG_BOOTARGS goes into the 500c609719bSwdenk environment value "bootargs". 501c609719bSwdenk 502c609719bSwdenk CONFIG_RAMBOOT and CONFIG_NFSBOOT 503c609719bSwdenk The value of these goes into the environment as 504c609719bSwdenk "ramboot" and "nfsboot" respectively, and can be used 505c609719bSwdenk as a convenience, when switching between booting from 506c609719bSwdenk ram and nfs. 507c609719bSwdenk 508c609719bSwdenk- Pre-Boot Commands: 509c609719bSwdenk CONFIG_PREBOOT 510c609719bSwdenk 511c609719bSwdenk When this option is #defined, the existence of the 512c609719bSwdenk environment variable "preboot" will be checked 513c609719bSwdenk immediately before starting the CONFIG_BOOTDELAY 514c609719bSwdenk countdown and/or running the auto-boot command resp. 515c609719bSwdenk entering interactive mode. 516c609719bSwdenk 517c609719bSwdenk This feature is especially useful when "preboot" is 518c609719bSwdenk automatically generated or modified. For an example 519c609719bSwdenk see the LWMON board specific code: here "preboot" is 520c609719bSwdenk modified when the user holds down a certain 521c609719bSwdenk combination of keys on the (special) keyboard when 522c609719bSwdenk booting the systems 523c609719bSwdenk 524c609719bSwdenk- Serial Download Echo Mode: 525c609719bSwdenk CONFIG_LOADS_ECHO 526c609719bSwdenk If defined to 1, all characters received during a 527c609719bSwdenk serial download (using the "loads" command) are 528c609719bSwdenk echoed back. This might be needed by some terminal 529c609719bSwdenk emulations (like "cu"), but may as well just take 530c609719bSwdenk time on others. This setting #define's the initial 531c609719bSwdenk value of the "loads_echo" environment variable. 532c609719bSwdenk 533c609719bSwdenk- Kgdb Serial Baudrate: (if CFG_CMD_KGDB is defined) 534c609719bSwdenk CONFIG_KGDB_BAUDRATE 535c609719bSwdenk Select one of the baudrates listed in 536c609719bSwdenk CFG_BAUDRATE_TABLE, see below. 537c609719bSwdenk 538c609719bSwdenk- Monitor Functions: 539c609719bSwdenk CONFIG_COMMANDS 540c609719bSwdenk Most monitor functions can be selected (or 541c609719bSwdenk de-selected) by adjusting the definition of 542c609719bSwdenk CONFIG_COMMANDS; to select individual functions, 543c609719bSwdenk #define CONFIG_COMMANDS by "OR"ing any of the 544c609719bSwdenk following values: 545c609719bSwdenk 546c609719bSwdenk #define enables commands: 547c609719bSwdenk ------------------------- 548c609719bSwdenk CFG_CMD_ASKENV * ask for env variable 549c609719bSwdenk CFG_CMD_BDI bdinfo 550c609719bSwdenk CFG_CMD_BEDBUG Include BedBug Debugger 551c609719bSwdenk CFG_CMD_BOOTD bootd 552c609719bSwdenk CFG_CMD_CACHE icache, dcache 553c609719bSwdenk CFG_CMD_CONSOLE coninfo 554c609719bSwdenk CFG_CMD_DATE * support for RTC, date/time... 555c609719bSwdenk CFG_CMD_DHCP DHCP support 556c609719bSwdenk CFG_CMD_ECHO * echo arguments 557c609719bSwdenk CFG_CMD_EEPROM * EEPROM read/write support 558c609719bSwdenk CFG_CMD_ELF bootelf, bootvx 559c609719bSwdenk CFG_CMD_ENV saveenv 560c609719bSwdenk CFG_CMD_FDC * Floppy Disk Support 5612262cfeeSwdenk CFG_CMD_FDOS * Dos diskette Support 562c609719bSwdenk CFG_CMD_FLASH flinfo, erase, protect 563c609719bSwdenk CFG_CMD_FPGA FPGA device initialization support 564c609719bSwdenk CFG_CMD_I2C * I2C serial bus support 565c609719bSwdenk CFG_CMD_IDE * IDE harddisk support 566c609719bSwdenk CFG_CMD_IMI iminfo 567c609719bSwdenk CFG_CMD_IMMAP * IMMR dump support 568c609719bSwdenk CFG_CMD_IRQ * irqinfo 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 574c609719bSwdenk CFG_CMD_MII MII utility commands 575c609719bSwdenk CFG_CMD_NET bootp, tftpboot, rarpboot 576c609719bSwdenk CFG_CMD_PCI * pciinfo 577c609719bSwdenk CFG_CMD_PCMCIA * PCMCIA support 578c609719bSwdenk CFG_CMD_REGINFO * Register dump 579c609719bSwdenk CFG_CMD_RUN run command in env variable 580c609719bSwdenk CFG_CMD_SCSI * SCSI Support 581c609719bSwdenk CFG_CMD_SETGETDCR Support for DCR Register access (4xx only) 582c609719bSwdenk CFG_CMD_SPI * SPI serial bus support 583c609719bSwdenk CFG_CMD_USB * USB support 584c609719bSwdenk CFG_CMD_BSP * Board SPecific functions 585c609719bSwdenk ----------------------------------------------- 586c609719bSwdenk CFG_CMD_ALL all 587c609719bSwdenk 588c609719bSwdenk CFG_CMD_DFL Default configuration; at the moment 589c609719bSwdenk this is includes all commands, except 590c609719bSwdenk the ones marked with "*" in the list 591c609719bSwdenk above. 592c609719bSwdenk 593c609719bSwdenk If you don't define CONFIG_COMMANDS it defaults to 594c609719bSwdenk CFG_CMD_DFL in include/cmd_confdefs.h. A board can 595c609719bSwdenk override the default settings in the respective 596c609719bSwdenk include file. 597c609719bSwdenk 598c609719bSwdenk EXAMPLE: If you want all functions except of network 599c609719bSwdenk support you can write: 600c609719bSwdenk 601c609719bSwdenk #define CONFIG_COMMANDS (CFG_CMD_ALL & ~CFG_CMD_NET) 602c609719bSwdenk 603c609719bSwdenk 604c609719bSwdenk Note: Don't enable the "icache" and "dcache" commands 605c609719bSwdenk (configuration option CFG_CMD_CACHE) unless you know 606c609719bSwdenk what you (and your U-Boot users) are doing. Data 607c609719bSwdenk cache cannot be enabled on systems like the 8xx or 608c609719bSwdenk 8260 (where accesses to the IMMR region must be 609c609719bSwdenk uncached), and it cannot be disabled on all other 610c609719bSwdenk systems where we (mis-) use the data cache to hold an 611c609719bSwdenk initial stack and some data. 612c609719bSwdenk 613c609719bSwdenk 614c609719bSwdenk XXX - this list needs to get updated! 615c609719bSwdenk 616c609719bSwdenk- Watchdog: 617c609719bSwdenk CONFIG_WATCHDOG 618c609719bSwdenk If this variable is defined, it enables watchdog 619c609719bSwdenk support. There must support in the platform specific 620c609719bSwdenk code for a watchdog. For the 8xx and 8260 CPUs, the 621c609719bSwdenk SIU Watchdog feature is enabled in the SYPCR 622c609719bSwdenk register. 623c609719bSwdenk 624c1551ea8Sstroese- U-Boot Version: 625c1551ea8Sstroese CONFIG_VERSION_VARIABLE 626c1551ea8Sstroese If this variable is defined, an environment variable 627c1551ea8Sstroese named "ver" is created by U-Boot showing the U-Boot 628c1551ea8Sstroese version as printed by the "version" command. 629c1551ea8Sstroese This variable is readonly. 630c1551ea8Sstroese 631c609719bSwdenk- Real-Time Clock: 632c609719bSwdenk 633c609719bSwdenk When CFG_CMD_DATE is selected, the type of the RTC 634c609719bSwdenk has to be selected, too. Define exactly one of the 635c609719bSwdenk following options: 636c609719bSwdenk 637c609719bSwdenk CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx 638c609719bSwdenk CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC 639c609719bSwdenk CONFIG_RTC_MC146818 - use MC146818 RTC 6401cb8e980Swdenk CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC 641c609719bSwdenk CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC 642*7f70e853Swdenk CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC 6433bac3513Swdenk CONFIG_RTC_DS164x - use Dallas DS164x RTC 644c609719bSwdenk 645c609719bSwdenk- Timestamp Support: 646c609719bSwdenk 647c609719bSwdenk When CONFIG_TIMESTAMP is selected, the timestamp 648c609719bSwdenk (date and time) of an image is printed by image 649c609719bSwdenk commands like bootm or iminfo. This option is 650c609719bSwdenk automatically enabled when you select CFG_CMD_DATE . 651c609719bSwdenk 652c609719bSwdenk- Partition Support: 653c609719bSwdenk CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION 654c609719bSwdenk and/or CONFIG_ISO_PARTITION 655c609719bSwdenk 656c609719bSwdenk If IDE or SCSI support is enabled (CFG_CMD_IDE or 657c609719bSwdenk CFG_CMD_SCSI) you must configure support for at least 658c609719bSwdenk one partition type as well. 659c609719bSwdenk 660c609719bSwdenk- IDE Reset method: 661c609719bSwdenk CONFIG_IDE_RESET_ROUTINE 662c609719bSwdenk 663c609719bSwdenk Set this to define that instead of a reset Pin, the 664c609719bSwdenk routine ide_set_reset(int idereset) will be used. 665c609719bSwdenk 666c609719bSwdenk- ATAPI Support: 667c609719bSwdenk CONFIG_ATAPI 668c609719bSwdenk 669c609719bSwdenk Set this to enable ATAPI support. 670c609719bSwdenk 671c609719bSwdenk- SCSI Support: 672c609719bSwdenk At the moment only there is only support for the 673c609719bSwdenk SYM53C8XX SCSI controller; define 674c609719bSwdenk CONFIG_SCSI_SYM53C8XX to enable it. 675c609719bSwdenk 676c609719bSwdenk CFG_SCSI_MAX_LUN [8], CFG_SCSI_MAX_SCSI_ID [7] and 677c609719bSwdenk CFG_SCSI_MAX_DEVICE [CFG_SCSI_MAX_SCSI_ID * 678c609719bSwdenk CFG_SCSI_MAX_LUN] can be adjusted to define the 679c609719bSwdenk maximum numbers of LUNs, SCSI ID's and target 680c609719bSwdenk devices. 681c609719bSwdenk CFG_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz) 682c609719bSwdenk 683c609719bSwdenk- NETWORK Support (PCI): 684c609719bSwdenk CONFIG_EEPRO100 685c609719bSwdenk Support for Intel 82557/82559/82559ER chips. 686c609719bSwdenk Optional CONFIG_EEPRO100_SROM_WRITE enables eeprom 687c609719bSwdenk write routine for first time initialisation. 688c609719bSwdenk 689c609719bSwdenk CONFIG_TULIP 690c609719bSwdenk Support for Digital 2114x chips. 691c609719bSwdenk Optional CONFIG_TULIP_SELECT_MEDIA for board specific 692c609719bSwdenk modem chip initialisation (KS8761/QS6611). 693c609719bSwdenk 694c609719bSwdenk CONFIG_NATSEMI 695c609719bSwdenk Support for National dp83815 chips. 696c609719bSwdenk 697c609719bSwdenk CONFIG_NS8382X 698c609719bSwdenk Support for National dp8382[01] gigabit chips. 699c609719bSwdenk 70045219c46Swdenk- NETWORK Support (other): 70145219c46Swdenk 70245219c46Swdenk CONFIG_DRIVER_LAN91C96 70345219c46Swdenk Support for SMSC's LAN91C96 chips. 70445219c46Swdenk 70545219c46Swdenk CONFIG_LAN91C96_BASE 70645219c46Swdenk Define this to hold the physical address 70745219c46Swdenk of the LAN91C96's I/O space 70845219c46Swdenk 70945219c46Swdenk CONFIG_LAN91C96_USE_32_BIT 71045219c46Swdenk Define this to enable 32 bit addressing 71145219c46Swdenk 712c609719bSwdenk- USB Support: 713c609719bSwdenk At the moment only the UHCI host controller is 714c609719bSwdenk supported (PIP405, MIP405); define 715c609719bSwdenk CONFIG_USB_UHCI to enable it. 716c609719bSwdenk define CONFIG_USB_KEYBOARD to enable the USB Keyboard 717c609719bSwdenk end define CONFIG_USB_STORAGE to enable the USB 718c609719bSwdenk storage devices. 719c609719bSwdenk Note: 720c609719bSwdenk Supported are USB Keyboards and USB Floppy drives 721c609719bSwdenk (TEAC FD-05PUB). 722c609719bSwdenk 723c609719bSwdenk- Keyboard Support: 724c609719bSwdenk CONFIG_ISA_KEYBOARD 725c609719bSwdenk 726c609719bSwdenk Define this to enable standard (PC-Style) keyboard 727c609719bSwdenk support 728c609719bSwdenk 729c609719bSwdenk CONFIG_I8042_KBD 730c609719bSwdenk Standard PC keyboard driver with US (is default) and 731c609719bSwdenk GERMAN key layout (switch via environment 'keymap=de') support. 732c609719bSwdenk Export function i8042_kbd_init, i8042_tstc and i8042_getc 733c609719bSwdenk for cfb_console. Supports cursor blinking. 734c609719bSwdenk 735c609719bSwdenk- Video support: 736c609719bSwdenk CONFIG_VIDEO 737c609719bSwdenk 738c609719bSwdenk Define this to enable video support (for output to 739c609719bSwdenk video). 740c609719bSwdenk 741c609719bSwdenk CONFIG_VIDEO_CT69000 742c609719bSwdenk 743c609719bSwdenk Enable Chips & Technologies 69000 Video chip 744c609719bSwdenk 745c609719bSwdenk CONFIG_VIDEO_SMI_LYNXEM 746c609719bSwdenk Enable Silicon Motion SMI 712/710/810 Video chip 747c609719bSwdenk Videomode are selected via environment 'videomode' with 748c609719bSwdenk standard LiLo mode numbers. 749c609719bSwdenk Following modes are supported (* is default): 750c609719bSwdenk 751c609719bSwdenk 800x600 1024x768 1280x1024 752c609719bSwdenk 256 (8bit) 303* 305 307 753c609719bSwdenk 65536 (16bit) 314 317 31a 754c609719bSwdenk 16,7 Mill (24bit) 315 318 31b 755c609719bSwdenk (i.e. setenv videomode 317; saveenv; reset;) 756c609719bSwdenk 757a6c7ad2fSwdenk CONFIG_VIDEO_SED13806 758a6c7ad2fSwdenk Enable Epson SED13806 driver. This driver supports 8bpp 759a6c7ad2fSwdenk and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP 760a6c7ad2fSwdenk or CONFIG_VIDEO_SED13806_16BPP 761a6c7ad2fSwdenk 762a6c7ad2fSwdenk 763c609719bSwdenk- LCD Support: CONFIG_LCD 764c609719bSwdenk 765c609719bSwdenk Define this to enable LCD support (for output to LCD 766c609719bSwdenk display); also select one of the supported displays 767c609719bSwdenk by defining one of these: 768c609719bSwdenk 769c609719bSwdenk CONFIG_NEC_NL6648AC33: 770c609719bSwdenk 771c609719bSwdenk NEC NL6648AC33-18. Active, color, single scan. 772c609719bSwdenk 773c609719bSwdenk CONFIG_NEC_NL6648BC20 774c609719bSwdenk 775c609719bSwdenk NEC NL6648BC20-08. 6.5", 640x480. 776c609719bSwdenk Active, color, single scan. 777c609719bSwdenk 778c609719bSwdenk CONFIG_SHARP_16x9 779c609719bSwdenk 780c609719bSwdenk Sharp 320x240. Active, color, single scan. 781c609719bSwdenk It isn't 16x9, and I am not sure what it is. 782c609719bSwdenk 783c609719bSwdenk CONFIG_SHARP_LQ64D341 784c609719bSwdenk 785c609719bSwdenk Sharp LQ64D341 display, 640x480. 786c609719bSwdenk Active, color, single scan. 787c609719bSwdenk 788c609719bSwdenk CONFIG_HLD1045 789c609719bSwdenk 790c609719bSwdenk HLD1045 display, 640x480. 791c609719bSwdenk Active, color, single scan. 792c609719bSwdenk 793c609719bSwdenk CONFIG_OPTREX_BW 794c609719bSwdenk 795c609719bSwdenk Optrex CBL50840-2 NF-FW 99 22 M5 796c609719bSwdenk or 797c609719bSwdenk Hitachi LMG6912RPFC-00T 798c609719bSwdenk or 799c609719bSwdenk Hitachi SP14Q002 800c609719bSwdenk 801c609719bSwdenk 320x240. Black & white. 802c609719bSwdenk 803c609719bSwdenk Normally display is black on white background; define 804c609719bSwdenk CFG_WHITE_ON_BLACK to get it inverted. 805c609719bSwdenk 806d791b1dcSwdenk- Spash Screen Support: CONFIG_SPLASH_SCREEN 807d791b1dcSwdenk 808d791b1dcSwdenk If this option is set, the environment is checked for 809d791b1dcSwdenk a variable "splashimage". If found, the usual display 810d791b1dcSwdenk of logo, copyright and system information on the LCD 811d791b1dcSwdenk is supressed and the BMP image at the address 812d791b1dcSwdenk specified in "splashimage" is loaded instead. The 813d791b1dcSwdenk console is redirected to the "nulldev", too. This 814d791b1dcSwdenk allows for a "silent" boot where a splash screen is 815d791b1dcSwdenk loaded very quickly after power-on. 816d791b1dcSwdenk 817d791b1dcSwdenk 818c609719bSwdenk- Ethernet address: 819c609719bSwdenk CONFIG_ETHADDR 820c609719bSwdenk CONFIG_ETH2ADDR 821c609719bSwdenk CONFIG_ETH3ADDR 822c609719bSwdenk 823c609719bSwdenk Define a default value for ethernet address to use 824c609719bSwdenk for the respective ethernet interface, in case this 825c609719bSwdenk is not determined automatically. 826c609719bSwdenk 827c609719bSwdenk- IP address: 828c609719bSwdenk CONFIG_IPADDR 829c609719bSwdenk 830c609719bSwdenk Define a default value for the IP address to use for 831c609719bSwdenk the default ethernet interface, in case this is not 832c609719bSwdenk determined through e.g. bootp. 833c609719bSwdenk 834c609719bSwdenk- Server IP address: 835c609719bSwdenk CONFIG_SERVERIP 836c609719bSwdenk 837c609719bSwdenk Defines a default value for theIP address of a TFTP 838c609719bSwdenk server to contact when using the "tftboot" command. 839c609719bSwdenk 840c609719bSwdenk- BOOTP Recovery Mode: 841c609719bSwdenk CONFIG_BOOTP_RANDOM_DELAY 842c609719bSwdenk 843c609719bSwdenk If you have many targets in a network that try to 844c609719bSwdenk boot using BOOTP, you may want to avoid that all 845c609719bSwdenk systems send out BOOTP requests at precisely the same 846c609719bSwdenk moment (which would happen for instance at recovery 847c609719bSwdenk from a power failure, when all systems will try to 848c609719bSwdenk boot, thus flooding the BOOTP server. Defining 849c609719bSwdenk CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be 850c609719bSwdenk inserted before sending out BOOTP requests. The 851c609719bSwdenk following delays are insterted then: 852c609719bSwdenk 853c609719bSwdenk 1st BOOTP request: delay 0 ... 1 sec 854c609719bSwdenk 2nd BOOTP request: delay 0 ... 2 sec 855c609719bSwdenk 3rd BOOTP request: delay 0 ... 4 sec 856c609719bSwdenk 4th and following 857c609719bSwdenk BOOTP requests: delay 0 ... 8 sec 858c609719bSwdenk 859c609719bSwdenk- Status LED: CONFIG_STATUS_LED 860c609719bSwdenk 861c609719bSwdenk Several configurations allow to display the current 862c609719bSwdenk status using a LED. For instance, the LED will blink 863c609719bSwdenk fast while running U-Boot code, stop blinking as 864c609719bSwdenk soon as a reply to a BOOTP request was received, and 865c609719bSwdenk start blinking slow once the Linux kernel is running 866c609719bSwdenk (supported by a status LED driver in the Linux 867c609719bSwdenk kernel). Defining CONFIG_STATUS_LED enables this 868c609719bSwdenk feature in U-Boot. 869c609719bSwdenk 870c609719bSwdenk- CAN Support: CONFIG_CAN_DRIVER 871c609719bSwdenk 872c609719bSwdenk Defining CONFIG_CAN_DRIVER enables CAN driver support 873c609719bSwdenk on those systems that support this (optional) 874c609719bSwdenk feature, like the TQM8xxL modules. 875c609719bSwdenk 876c609719bSwdenk- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C 877c609719bSwdenk 878c609719bSwdenk Enables I2C serial bus commands. If this is selected, 879c609719bSwdenk either CONFIG_HARD_I2C or CONFIG_SOFT_I2C must be defined 880c609719bSwdenk to include the appropriate I2C driver. 881c609719bSwdenk 882c609719bSwdenk See also: common/cmd_i2c.c for a description of the 883c609719bSwdenk command line interface. 884c609719bSwdenk 885c609719bSwdenk 886c609719bSwdenk CONFIG_HARD_I2C 887c609719bSwdenk 888c609719bSwdenk Selects the CPM hardware driver for I2C. 889c609719bSwdenk 890c609719bSwdenk CONFIG_SOFT_I2C 891c609719bSwdenk 892c609719bSwdenk Use software (aka bit-banging) driver instead of CPM 893c609719bSwdenk or similar hardware support for I2C. This is configured 894c609719bSwdenk via the following defines. 895c609719bSwdenk 896c609719bSwdenk I2C_INIT 897c609719bSwdenk 898c609719bSwdenk (Optional). Any commands necessary to enable I2C 899c609719bSwdenk controller or configure ports. 900c609719bSwdenk 901c609719bSwdenk I2C_PORT 902c609719bSwdenk 903c609719bSwdenk (Only for MPC8260 CPU). The I/O port to use (the code 904c609719bSwdenk assumes both bits are on the same port). Valid values 905c609719bSwdenk are 0..3 for ports A..D. 906c609719bSwdenk 907c609719bSwdenk I2C_ACTIVE 908c609719bSwdenk 909c609719bSwdenk The code necessary to make the I2C data line active 910c609719bSwdenk (driven). If the data line is open collector, this 911c609719bSwdenk define can be null. 912c609719bSwdenk 913c609719bSwdenk I2C_TRISTATE 914c609719bSwdenk 915c609719bSwdenk The code necessary to make the I2C data line tri-stated 916c609719bSwdenk (inactive). If the data line is open collector, this 917c609719bSwdenk define can be null. 918c609719bSwdenk 919c609719bSwdenk I2C_READ 920c609719bSwdenk 921c609719bSwdenk Code that returns TRUE if the I2C data line is high, 922c609719bSwdenk FALSE if it is low. 923c609719bSwdenk 924c609719bSwdenk I2C_SDA(bit) 925c609719bSwdenk 926c609719bSwdenk If <bit> is TRUE, sets the I2C data line high. If it 927c609719bSwdenk is FALSE, it clears it (low). 928c609719bSwdenk 929c609719bSwdenk I2C_SCL(bit) 930c609719bSwdenk 931c609719bSwdenk If <bit> is TRUE, sets the I2C clock line high. If it 932c609719bSwdenk is FALSE, it clears it (low). 933c609719bSwdenk 934c609719bSwdenk I2C_DELAY 935c609719bSwdenk 936c609719bSwdenk This delay is invoked four times per clock cycle so this 937c609719bSwdenk controls the rate of data transfer. The data rate thus 938c609719bSwdenk is 1 / (I2C_DELAY * 4). 939c609719bSwdenk 94047cd00faSwdenk CFG_I2C_INIT_BOARD 94147cd00faSwdenk 94247cd00faSwdenk When a board is reset during an i2c bus transfer 94347cd00faSwdenk chips might think that the current transfer is still 94447cd00faSwdenk in progress. On some boards it is possible to access 94547cd00faSwdenk the i2c SCLK line directly, either by using the 94647cd00faSwdenk processor pin as a GPIO or by having a second pin 94747cd00faSwdenk connected to the bus. If this option is defined a 94847cd00faSwdenk custom i2c_init_board() routine in boards/xxx/board.c 94947cd00faSwdenk is run early in the boot sequence. 95047cd00faSwdenk 951c609719bSwdenk- SPI Support: CONFIG_SPI 952c609719bSwdenk 953c609719bSwdenk Enables SPI driver (so far only tested with 954c609719bSwdenk SPI EEPROM, also an instance works with Crystal A/D and 955c609719bSwdenk D/As on the SACSng board) 956c609719bSwdenk 957c609719bSwdenk CONFIG_SPI_X 958c609719bSwdenk 959c609719bSwdenk Enables extended (16-bit) SPI EEPROM addressing. 960c609719bSwdenk (symmetrical to CONFIG_I2C_X) 961c609719bSwdenk 962c609719bSwdenk CONFIG_SOFT_SPI 963c609719bSwdenk 964c609719bSwdenk Enables a software (bit-bang) SPI driver rather than 965c609719bSwdenk using hardware support. This is a general purpose 966c609719bSwdenk driver that only requires three general I/O port pins 967c609719bSwdenk (two outputs, one input) to function. If this is 968c609719bSwdenk defined, the board configuration must define several 969c609719bSwdenk SPI configuration items (port pins to use, etc). For 970c609719bSwdenk an example, see include/configs/sacsng.h. 971c609719bSwdenk 972c609719bSwdenk- FPGA Support: CONFIG_FPGA_COUNT 973c609719bSwdenk 974c609719bSwdenk Specify the number of FPGA devices to support. 975c609719bSwdenk 976c609719bSwdenk CONFIG_FPGA 977c609719bSwdenk 978c609719bSwdenk Used to specify the types of FPGA devices. For 979c609719bSwdenk example, 980c609719bSwdenk #define CONFIG_FPGA CFG_XILINX_VIRTEX2 981c609719bSwdenk 982c609719bSwdenk CFG_FPGA_PROG_FEEDBACK 983c609719bSwdenk 984c609719bSwdenk Enable printing of hash marks during FPGA 985c609719bSwdenk configuration. 986c609719bSwdenk 987c609719bSwdenk CFG_FPGA_CHECK_BUSY 988c609719bSwdenk 989c609719bSwdenk Enable checks on FPGA configuration interface busy 990c609719bSwdenk status by the configuration function. This option 991c609719bSwdenk will require a board or device specific function to 992c609719bSwdenk be written. 993c609719bSwdenk 994c609719bSwdenk CONFIG_FPGA_DELAY 995c609719bSwdenk 996c609719bSwdenk If defined, a function that provides delays in the 997c609719bSwdenk FPGA configuration driver. 998c609719bSwdenk 999c609719bSwdenk CFG_FPGA_CHECK_CTRLC 1000c609719bSwdenk 1001c609719bSwdenk Allow Control-C to interrupt FPGA configuration 1002c609719bSwdenk 1003c609719bSwdenk CFG_FPGA_CHECK_ERROR 1004c609719bSwdenk 1005c609719bSwdenk Check for configuration errors during FPGA bitfile 1006c609719bSwdenk loading. For example, abort during Virtex II 1007c609719bSwdenk configuration if the INIT_B line goes low (which 1008c609719bSwdenk indicated a CRC error). 1009c609719bSwdenk 1010c609719bSwdenk CFG_FPGA_WAIT_INIT 1011c609719bSwdenk 1012c609719bSwdenk Maximum time to wait for the INIT_B line to deassert 1013c609719bSwdenk after PROB_B has been deasserted during a Virtex II 1014c609719bSwdenk FPGA configuration sequence. The default time is 500 mS. 1015c609719bSwdenk 1016c609719bSwdenk CFG_FPGA_WAIT_BUSY 1017c609719bSwdenk 1018c609719bSwdenk Maximum time to wait for BUSY to deassert during 1019c609719bSwdenk Virtex II FPGA configuration. The default is 5 mS. 1020c609719bSwdenk 1021c609719bSwdenk CFG_FPGA_WAIT_CONFIG 1022c609719bSwdenk 1023c609719bSwdenk Time to wait after FPGA configuration. The default is 1024c609719bSwdenk 200 mS. 1025c609719bSwdenk 1026c609719bSwdenk- FPGA Support: CONFIG_FPGA_COUNT 1027c609719bSwdenk 1028c609719bSwdenk Specify the number of FPGA devices to support. 1029c609719bSwdenk 1030c609719bSwdenk CONFIG_FPGA 1031c609719bSwdenk 1032c609719bSwdenk Used to specify the types of FPGA devices. For example, 1033c609719bSwdenk #define CONFIG_FPGA CFG_XILINX_VIRTEX2 1034c609719bSwdenk 1035c609719bSwdenk CFG_FPGA_PROG_FEEDBACK 1036c609719bSwdenk 1037c609719bSwdenk Enable printing of hash marks during FPGA configuration. 1038c609719bSwdenk 1039c609719bSwdenk CFG_FPGA_CHECK_BUSY 1040c609719bSwdenk 1041c609719bSwdenk Enable checks on FPGA configuration interface busy 1042c609719bSwdenk status by the configuration function. This option 1043c609719bSwdenk will require a board or device specific function to 1044c609719bSwdenk be written. 1045c609719bSwdenk 1046c609719bSwdenk CONFIG_FPGA_DELAY 1047c609719bSwdenk 1048c609719bSwdenk If defined, a function that provides delays in the FPGA 1049c609719bSwdenk configuration driver. 1050c609719bSwdenk 1051c609719bSwdenk CFG_FPGA_CHECK_CTRLC 1052c609719bSwdenk Allow Control-C to interrupt FPGA configuration 1053c609719bSwdenk 1054c609719bSwdenk CFG_FPGA_CHECK_ERROR 1055c609719bSwdenk 1056c609719bSwdenk Check for configuration errors during FPGA bitfile 1057c609719bSwdenk loading. For example, abort during Virtex II 1058c609719bSwdenk configuration if the INIT_B line goes low (which 1059c609719bSwdenk indicated a CRC error). 1060c609719bSwdenk 1061c609719bSwdenk CFG_FPGA_WAIT_INIT 1062c609719bSwdenk 1063c609719bSwdenk Maximum time to wait for the INIT_B line to deassert 1064c609719bSwdenk after PROB_B has been deasserted during a Virtex II 1065c609719bSwdenk FPGA configuration sequence. The default time is 500 1066c609719bSwdenk mS. 1067c609719bSwdenk 1068c609719bSwdenk CFG_FPGA_WAIT_BUSY 1069c609719bSwdenk 1070c609719bSwdenk Maximum time to wait for BUSY to deassert during 1071c609719bSwdenk Virtex II FPGA configuration. The default is 5 mS. 1072c609719bSwdenk 1073c609719bSwdenk CFG_FPGA_WAIT_CONFIG 1074c609719bSwdenk 1075c609719bSwdenk Time to wait after FPGA configuration. The default is 1076c609719bSwdenk 200 mS. 1077c609719bSwdenk 1078c609719bSwdenk- Configuration Management: 1079c609719bSwdenk CONFIG_IDENT_STRING 1080c609719bSwdenk 1081c609719bSwdenk If defined, this string will be added to the U-Boot 1082c609719bSwdenk version information (U_BOOT_VERSION) 1083c609719bSwdenk 1084c609719bSwdenk- Vendor Parameter Protection: 1085c609719bSwdenk 1086c609719bSwdenk U-Boot considers the values of the environment 1087c609719bSwdenk variables "serial#" (Board Serial Number) and 1088c609719bSwdenk "ethaddr" (Ethernet Address) to bb parameters that 1089c609719bSwdenk are set once by the board vendor / manufacturer, and 1090c609719bSwdenk protects these variables from casual modification by 1091c609719bSwdenk the user. Once set, these variables are read-only, 1092c609719bSwdenk and write or delete attempts are rejected. You can 1093c609719bSwdenk change this behviour: 1094c609719bSwdenk 1095c609719bSwdenk If CONFIG_ENV_OVERWRITE is #defined in your config 1096c609719bSwdenk file, the write protection for vendor parameters is 109747cd00faSwdenk completely disabled. Anybody can change or delete 1098c609719bSwdenk these parameters. 1099c609719bSwdenk 1100c609719bSwdenk Alternatively, if you #define _both_ CONFIG_ETHADDR 1101c609719bSwdenk _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default 1102c609719bSwdenk ethernet address is installed in the environment, 1103c609719bSwdenk which can be changed exactly ONCE by the user. [The 1104c609719bSwdenk serial# is unaffected by this, i. e. it remains 1105c609719bSwdenk read-only.] 1106c609719bSwdenk 1107c609719bSwdenk- Protected RAM: 1108c609719bSwdenk CONFIG_PRAM 1109c609719bSwdenk 1110c609719bSwdenk Define this variable to enable the reservation of 1111c609719bSwdenk "protected RAM", i. e. RAM which is not overwritten 1112c609719bSwdenk by U-Boot. Define CONFIG_PRAM to hold the number of 1113c609719bSwdenk kB you want to reserve for pRAM. You can overwrite 1114c609719bSwdenk this default value by defining an environment 1115c609719bSwdenk variable "pram" to the number of kB you want to 1116c609719bSwdenk reserve. Note that the board info structure will 1117c609719bSwdenk still show the full amount of RAM. If pRAM is 1118c609719bSwdenk reserved, a new environment variable "mem" will 1119c609719bSwdenk automatically be defined to hold the amount of 1120c609719bSwdenk remaining RAM in a form that can be passed as boot 1121c609719bSwdenk argument to Linux, for instance like that: 1122c609719bSwdenk 1123c609719bSwdenk setenv bootargs ... mem=\$(mem) 1124c609719bSwdenk saveenv 1125c609719bSwdenk 1126c609719bSwdenk This way you can tell Linux not to use this memory, 1127c609719bSwdenk either, which results in a memory region that will 1128c609719bSwdenk not be affected by reboots. 1129c609719bSwdenk 1130c609719bSwdenk *WARNING* If your board configuration uses automatic 1131c609719bSwdenk detection of the RAM size, you must make sure that 1132c609719bSwdenk this memory test is non-destructive. So far, the 1133c609719bSwdenk following board configurations are known to be 1134c609719bSwdenk "pRAM-clean": 1135c609719bSwdenk 1136c609719bSwdenk ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL, 1137c609719bSwdenk HERMES, IP860, RPXlite, LWMON, LANTEC, 1138c609719bSwdenk PCU_E, FLAGADM, TQM8260 1139c609719bSwdenk 1140c609719bSwdenk- Error Recovery: 1141c609719bSwdenk CONFIG_PANIC_HANG 1142c609719bSwdenk 1143c609719bSwdenk Define this variable to stop the system in case of a 1144c609719bSwdenk fatal error, so that you have to reset it manually. 1145c609719bSwdenk This is probably NOT a good idea for an embedded 1146c609719bSwdenk system where you want to system to reboot 1147c609719bSwdenk automatically as fast as possible, but it may be 1148c609719bSwdenk useful during development since you can try to debug 1149c609719bSwdenk the conditions that lead to the situation. 1150c609719bSwdenk 1151c609719bSwdenk CONFIG_NET_RETRY_COUNT 1152c609719bSwdenk 1153c609719bSwdenk This variable defines the number of retries for 1154c609719bSwdenk network operations like ARP, RARP, TFTP, or BOOTP 1155c609719bSwdenk before giving up the operation. If not defined, a 1156c609719bSwdenk default value of 5 is used. 1157c609719bSwdenk 1158c609719bSwdenk- Command Interpreter: 1159c609719bSwdenk CFG_HUSH_PARSER 1160c609719bSwdenk 1161c609719bSwdenk Define this variable to enable the "hush" shell (from 1162c609719bSwdenk Busybox) as command line interpreter, thus enabling 1163c609719bSwdenk powerful command line syntax like 1164c609719bSwdenk if...then...else...fi conditionals or `&&' and '||' 1165c609719bSwdenk constructs ("shell scripts"). 1166c609719bSwdenk 1167c609719bSwdenk If undefined, you get the old, much simpler behaviour 1168c609719bSwdenk with a somewhat smaller memory footprint. 1169c609719bSwdenk 1170c609719bSwdenk 1171c609719bSwdenk CFG_PROMPT_HUSH_PS2 1172c609719bSwdenk 1173c609719bSwdenk This defines the secondary prompt string, which is 1174c609719bSwdenk printed when the command interpreter needs more input 1175c609719bSwdenk to complete a command. Usually "> ". 1176c609719bSwdenk 1177c609719bSwdenk Note: 1178c609719bSwdenk 1179c609719bSwdenk In the current implementation, the local variables 1180c609719bSwdenk space and global environment variables space are 1181c609719bSwdenk separated. Local variables are those you define by 1182c609719bSwdenk simply typing like `name=value'. To access a local 1183c609719bSwdenk variable later on, you have write `$name' or 1184c609719bSwdenk `${name}'; variable directly by typing say `$name' at 1185c609719bSwdenk the command prompt. 1186c609719bSwdenk 1187c609719bSwdenk Global environment variables are those you use 1188c609719bSwdenk setenv/printenv to work with. To run a command stored 1189c609719bSwdenk in such a variable, you need to use the run command, 1190c609719bSwdenk and you must not use the '$' sign to access them. 1191c609719bSwdenk 1192c609719bSwdenk To store commands and special characters in a 1193c609719bSwdenk variable, please use double quotation marks 1194c609719bSwdenk surrounding the whole text of the variable, instead 1195c609719bSwdenk of the backslashes before semicolons and special 1196c609719bSwdenk symbols. 1197c609719bSwdenk 1198c609719bSwdenk- Default Environment 1199c609719bSwdenk CONFIG_EXTRA_ENV_SETTINGS 1200c609719bSwdenk 1201c609719bSwdenk Define this to contain any number of null terminated 1202c609719bSwdenk strings (variable = value pairs) that will be part of 1203c609719bSwdenk the default enviroment compiled into the boot image. 12042262cfeeSwdenk 1205c609719bSwdenk For example, place something like this in your 1206c609719bSwdenk board's config file: 1207c609719bSwdenk 1208c609719bSwdenk #define CONFIG_EXTRA_ENV_SETTINGS \ 1209c609719bSwdenk "myvar1=value1\0" \ 1210c609719bSwdenk "myvar2=value2\0" 1211c609719bSwdenk 1212c609719bSwdenk Warning: This method is based on knowledge about the 1213c609719bSwdenk internal format how the environment is stored by the 12142262cfeeSwdenk U-Boot code. This is NOT an official, exported 1215c609719bSwdenk interface! Although it is unlikely that this format 12162262cfeeSwdenk will change soon, but there is no guarantee either. 1217c609719bSwdenk You better know what you are doing here. 1218c609719bSwdenk 1219c609719bSwdenk Note: overly (ab)use of the default environment is 1220c609719bSwdenk discouraged. Make sure to check other ways to preset 1221c609719bSwdenk the environment like the autoscript function or the 1222c609719bSwdenk boot command first. 1223c609719bSwdenk 1224c609719bSwdenk- Show boot progress 1225c609719bSwdenk CONFIG_SHOW_BOOT_PROGRESS 1226c609719bSwdenk 1227c609719bSwdenk Defining this option allows to add some board- 1228c609719bSwdenk specific code (calling a user-provided function 1229c609719bSwdenk "show_boot_progress(int)") that enables you to show 1230c609719bSwdenk the system's boot progress on some display (for 1231c609719bSwdenk example, some LED's) on your board. At the moment, 1232c609719bSwdenk the following checkpoints are implemented: 1233c609719bSwdenk 1234c609719bSwdenk Arg Where When 1235c609719bSwdenk 1 common/cmd_bootm.c before attempting to boot an image 1236c609719bSwdenk -1 common/cmd_bootm.c Image header has bad magic number 1237c609719bSwdenk 2 common/cmd_bootm.c Image header has correct magic number 1238c609719bSwdenk -2 common/cmd_bootm.c Image header has bad checksum 1239c609719bSwdenk 3 common/cmd_bootm.c Image header has correct checksum 1240c609719bSwdenk -3 common/cmd_bootm.c Image data has bad checksum 1241c609719bSwdenk 4 common/cmd_bootm.c Image data has correct checksum 1242c609719bSwdenk -4 common/cmd_bootm.c Image is for unsupported architecture 1243c609719bSwdenk 5 common/cmd_bootm.c Architecture check OK 1244c609719bSwdenk -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi, standalone) 1245c609719bSwdenk 6 common/cmd_bootm.c Image Type check OK 1246c609719bSwdenk -6 common/cmd_bootm.c gunzip uncompression error 1247c609719bSwdenk -7 common/cmd_bootm.c Unimplemented compression type 1248c609719bSwdenk 7 common/cmd_bootm.c Uncompression OK 1249c609719bSwdenk -8 common/cmd_bootm.c Wrong Image Type (not kernel, multi, standalone) 1250c609719bSwdenk 8 common/cmd_bootm.c Image Type check OK 1251c609719bSwdenk -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX) 1252c609719bSwdenk 9 common/cmd_bootm.c Start initial ramdisk verification 1253c609719bSwdenk -10 common/cmd_bootm.c Ramdisk header has bad magic number 1254c609719bSwdenk -11 common/cmd_bootm.c Ramdisk header has bad checksum 1255c609719bSwdenk 10 common/cmd_bootm.c Ramdisk header is OK 1256c609719bSwdenk -12 common/cmd_bootm.c Ramdisk data has bad checksum 1257c609719bSwdenk 11 common/cmd_bootm.c Ramdisk data has correct checksum 1258c609719bSwdenk 12 common/cmd_bootm.c Ramdisk verification complete, start loading 1259c609719bSwdenk -13 common/cmd_bootm.c Wrong Image Type (not PPC Linux Ramdisk) 1260c609719bSwdenk 13 common/cmd_bootm.c Start multifile image verification 1261c609719bSwdenk 14 common/cmd_bootm.c No initial ramdisk, no multifile, continue. 1262c609719bSwdenk 15 common/cmd_bootm.c All preparation done, transferring control to OS 1263c609719bSwdenk 1264c609719bSwdenk -1 common/cmd_doc.c Bad usage of "doc" command 1265c609719bSwdenk -1 common/cmd_doc.c No boot device 1266c609719bSwdenk -1 common/cmd_doc.c Unknown Chip ID on boot device 1267c609719bSwdenk -1 common/cmd_doc.c Read Error on boot device 1268c609719bSwdenk -1 common/cmd_doc.c Image header has bad magic number 1269c609719bSwdenk 1270c609719bSwdenk -1 common/cmd_ide.c Bad usage of "ide" command 1271c609719bSwdenk -1 common/cmd_ide.c No boot device 1272c609719bSwdenk -1 common/cmd_ide.c Unknown boot device 1273c609719bSwdenk -1 common/cmd_ide.c Unknown partition table 1274c609719bSwdenk -1 common/cmd_ide.c Invalid partition type 1275c609719bSwdenk -1 common/cmd_ide.c Read Error on boot device 1276c609719bSwdenk -1 common/cmd_ide.c Image header has bad magic number 1277c609719bSwdenk 1278c609719bSwdenk -1 common/cmd_nvedit.c Environment not changable, but has bad CRC 1279c609719bSwdenk 1280c609719bSwdenk 1281c609719bSwdenkModem Support: 1282c609719bSwdenk-------------- 1283c609719bSwdenk 128485ec0bccSwdenk[so far only for SMDK2400 and TRAB boards] 1285c609719bSwdenk 1286c609719bSwdenk- Modem support endable: 1287c609719bSwdenk CONFIG_MODEM_SUPPORT 1288c609719bSwdenk 1289c609719bSwdenk- RTS/CTS Flow control enable: 1290c609719bSwdenk CONFIG_HWFLOW 1291c609719bSwdenk 1292c609719bSwdenk- Modem debug support: 1293c609719bSwdenk CONFIG_MODEM_SUPPORT_DEBUG 1294c609719bSwdenk 1295c609719bSwdenk Enables debugging stuff (char screen[1024], dbg()) 1296c609719bSwdenk for modem support. Useful only with BDI2000. 1297c609719bSwdenk 1298c609719bSwdenk- General: 1299c609719bSwdenk 1300c609719bSwdenk In the target system modem support is enabled when a 1301c609719bSwdenk specific key (key combination) is pressed during 1302c609719bSwdenk power-on. Otherwise U-Boot will boot normally 1303c609719bSwdenk (autoboot). The key_pressed() fuction is called from 1304c609719bSwdenk board_init(). Currently key_pressed() is a dummy 1305c609719bSwdenk function, returning 1 and thus enabling modem 1306c609719bSwdenk initialization. 1307c609719bSwdenk 1308c609719bSwdenk If there are no modem init strings in the 1309c609719bSwdenk environment, U-Boot proceed to autoboot; the 1310c609719bSwdenk previous output (banner, info printfs) will be 1311c609719bSwdenk supressed, though. 1312c609719bSwdenk 1313c609719bSwdenk See also: doc/README.Modem 1314c609719bSwdenk 1315c609719bSwdenk 1316c609719bSwdenk 1317c609719bSwdenk 1318c609719bSwdenkConfiguration Settings: 1319c609719bSwdenk----------------------- 1320c609719bSwdenk 1321c609719bSwdenk- CFG_LONGHELP: Defined when you want long help messages included; 1322c609719bSwdenk undefine this when you're short of memory. 1323c609719bSwdenk 1324c609719bSwdenk- CFG_PROMPT: This is what U-Boot prints on the console to 1325c609719bSwdenk prompt for user input. 1326c609719bSwdenk 1327c609719bSwdenk- CFG_CBSIZE: Buffer size for input from the Console 1328c609719bSwdenk 1329c609719bSwdenk- CFG_PBSIZE: Buffer size for Console output 1330c609719bSwdenk 1331c609719bSwdenk- CFG_MAXARGS: max. Number of arguments accepted for monitor commands 1332c609719bSwdenk 1333c609719bSwdenk- CFG_BARGSIZE: Buffer size for Boot Arguments which are passed to 1334c609719bSwdenk the application (usually a Linux kernel) when it is 1335c609719bSwdenk booted 1336c609719bSwdenk 1337c609719bSwdenk- CFG_BAUDRATE_TABLE: 1338c609719bSwdenk List of legal baudrate settings for this board. 1339c609719bSwdenk 1340c609719bSwdenk- CFG_CONSOLE_INFO_QUIET 1341c609719bSwdenk Suppress display of console information at boot. 1342c609719bSwdenk 1343c609719bSwdenk- CFG_CONSOLE_IS_IN_ENV 1344c609719bSwdenk If the board specific function 1345c609719bSwdenk extern int overwrite_console (void); 1346c609719bSwdenk returns 1, the stdin, stderr and stdout are switched to the 1347c609719bSwdenk serial port, else the settings in the environment are used. 1348c609719bSwdenk 1349c609719bSwdenk- CFG_CONSOLE_OVERWRITE_ROUTINE 1350c609719bSwdenk Enable the call to overwrite_console(). 1351c609719bSwdenk 1352c609719bSwdenk- CFG_CONSOLE_ENV_OVERWRITE 1353c609719bSwdenk Enable overwrite of previous console environment settings. 1354c609719bSwdenk 1355c609719bSwdenk- CFG_MEMTEST_START, CFG_MEMTEST_END: 1356c609719bSwdenk Begin and End addresses of the area used by the 1357c609719bSwdenk simple memory test. 1358c609719bSwdenk 1359c609719bSwdenk- CFG_ALT_MEMTEST: 1360c609719bSwdenk Enable an alternate, more extensive memory test. 1361c609719bSwdenk 1362c609719bSwdenk- CFG_TFTP_LOADADDR: 1363c609719bSwdenk Default load address for network file downloads 1364c609719bSwdenk 1365c609719bSwdenk- CFG_LOADS_BAUD_CHANGE: 1366c609719bSwdenk Enable temporary baudrate change while serial download 1367c609719bSwdenk 1368c609719bSwdenk- CFG_SDRAM_BASE: 1369c609719bSwdenk Physical start address of SDRAM. _Must_ be 0 here. 1370c609719bSwdenk 1371c609719bSwdenk- CFG_MBIO_BASE: 1372c609719bSwdenk Physical start address of Motherboard I/O (if using a 1373c609719bSwdenk Cogent motherboard) 1374c609719bSwdenk 1375c609719bSwdenk- CFG_FLASH_BASE: 1376c609719bSwdenk Physical start address of Flash memory. 1377c609719bSwdenk 1378c609719bSwdenk- CFG_MONITOR_BASE: 1379c609719bSwdenk Physical start address of boot monitor code (set by 1380c609719bSwdenk make config files to be same as the text base address 1381c609719bSwdenk (TEXT_BASE) used when linking) - same as 1382c609719bSwdenk CFG_FLASH_BASE when booting from flash. 1383c609719bSwdenk 1384c609719bSwdenk- CFG_MONITOR_LEN: 1385c609719bSwdenk Size of memory reserved for monitor code 1386c609719bSwdenk 1387c609719bSwdenk- CFG_MALLOC_LEN: 1388c609719bSwdenk Size of DRAM reserved for malloc() use. 1389c609719bSwdenk 1390c609719bSwdenk- CFG_BOOTMAPSZ: 1391c609719bSwdenk Maximum size of memory mapped by the startup code of 1392c609719bSwdenk the Linux kernel; all data that must be processed by 1393c609719bSwdenk the Linux kernel (bd_info, boot arguments, eventually 1394c609719bSwdenk initrd image) must be put below this limit. 1395c609719bSwdenk 1396c609719bSwdenk- CFG_MAX_FLASH_BANKS: 1397c609719bSwdenk Max number of Flash memory banks 1398c609719bSwdenk 1399c609719bSwdenk- CFG_MAX_FLASH_SECT: 1400c609719bSwdenk Max number of sectors on a Flash chip 1401c609719bSwdenk 1402c609719bSwdenk- CFG_FLASH_ERASE_TOUT: 1403c609719bSwdenk Timeout for Flash erase operations (in ms) 1404c609719bSwdenk 1405c609719bSwdenk- CFG_FLASH_WRITE_TOUT: 1406c609719bSwdenk Timeout for Flash write operations (in ms) 1407c609719bSwdenk 1408c609719bSwdenk- CFG_DIRECT_FLASH_TFTP: 1409c609719bSwdenk 1410c609719bSwdenk Enable TFTP transfers directly to flash memory; 1411c609719bSwdenk without this option such a download has to be 1412c609719bSwdenk performed in two steps: (1) download to RAM, and (2) 1413c609719bSwdenk copy from RAM to flash. 1414c609719bSwdenk 1415c609719bSwdenk The two-step approach is usually more reliable, since 1416c609719bSwdenk you can check if the download worked before you erase 1417c609719bSwdenk the flash, but in some situations (when sytem RAM is 1418c609719bSwdenk too limited to allow for a tempory copy of the 1419c609719bSwdenk downloaded image) this option may be very useful. 1420c609719bSwdenk 1421c609719bSwdenk- CFG_FLASH_CFI: 1422c609719bSwdenk Define if the flash driver uses extra elements in the 1423c609719bSwdenk common flash structure for storing flash geometry 1424c609719bSwdenk 1425c609719bSwdenkThe following definitions that deal with the placement and management 1426c609719bSwdenkof environment data (variable area); in general, we support the 1427c609719bSwdenkfollowing configurations: 1428c609719bSwdenk 1429c609719bSwdenk- CFG_ENV_IS_IN_FLASH: 1430c609719bSwdenk 1431c609719bSwdenk Define this if the environment is in flash memory. 1432c609719bSwdenk 1433c609719bSwdenk a) The environment occupies one whole flash sector, which is 1434c609719bSwdenk "embedded" in the text segment with the U-Boot code. This 1435c609719bSwdenk happens usually with "bottom boot sector" or "top boot 1436c609719bSwdenk sector" type flash chips, which have several smaller 1437c609719bSwdenk sectors at the start or the end. For instance, such a 1438c609719bSwdenk layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In 1439c609719bSwdenk such a case you would place the environment in one of the 1440c609719bSwdenk 4 kB sectors - with U-Boot code before and after it. With 1441c609719bSwdenk "top boot sector" type flash chips, you would put the 1442c609719bSwdenk environment in one of the last sectors, leaving a gap 1443c609719bSwdenk between U-Boot and the environment. 1444c609719bSwdenk 1445c609719bSwdenk - CFG_ENV_OFFSET: 1446c609719bSwdenk 1447c609719bSwdenk Offset of environment data (variable area) to the 1448c609719bSwdenk beginning of flash memory; for instance, with bottom boot 1449c609719bSwdenk type flash chips the second sector can be used: the offset 1450c609719bSwdenk for this sector is given here. 1451c609719bSwdenk 1452c609719bSwdenk CFG_ENV_OFFSET is used relative to CFG_FLASH_BASE. 1453c609719bSwdenk 1454c609719bSwdenk - CFG_ENV_ADDR: 1455c609719bSwdenk 1456c609719bSwdenk This is just another way to specify the start address of 1457c609719bSwdenk the flash sector containing the environment (instead of 1458c609719bSwdenk CFG_ENV_OFFSET). 1459c609719bSwdenk 1460c609719bSwdenk - CFG_ENV_SECT_SIZE: 1461c609719bSwdenk 1462c609719bSwdenk Size of the sector containing the environment. 1463c609719bSwdenk 1464c609719bSwdenk 1465c609719bSwdenk b) Sometimes flash chips have few, equal sized, BIG sectors. 1466c609719bSwdenk In such a case you don't want to spend a whole sector for 1467c609719bSwdenk the environment. 1468c609719bSwdenk 1469c609719bSwdenk - CFG_ENV_SIZE: 1470c609719bSwdenk 1471c609719bSwdenk If you use this in combination with CFG_ENV_IS_IN_FLASH 1472c609719bSwdenk and CFG_ENV_SECT_SIZE, you can specify to use only a part 1473c609719bSwdenk of this flash sector for the environment. This saves 1474c609719bSwdenk memory for the RAM copy of the environment. 1475c609719bSwdenk 1476c609719bSwdenk It may also save flash memory if you decide to use this 1477c609719bSwdenk when your environment is "embedded" within U-Boot code, 1478c609719bSwdenk since then the remainder of the flash sector could be used 1479c609719bSwdenk for U-Boot code. It should be pointed out that this is 1480c609719bSwdenk STRONGLY DISCOURAGED from a robustness point of view: 1481c609719bSwdenk updating the environment in flash makes it always 1482c609719bSwdenk necessary to erase the WHOLE sector. If something goes 1483c609719bSwdenk wrong before the contents has been restored from a copy in 1484c609719bSwdenk RAM, your target system will be dead. 1485c609719bSwdenk 1486c609719bSwdenk - CFG_ENV_ADDR_REDUND 1487c609719bSwdenk CFG_ENV_SIZE_REDUND 1488c609719bSwdenk 1489c609719bSwdenk These settings describe a second storage area used to hold 1490c609719bSwdenk a redundand copy of the environment data, so that there is 14913e38691eSwdenk a valid backup copy in case there is a power failure during 1492c609719bSwdenk a "saveenv" operation. 1493c609719bSwdenk 1494c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the 1495c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds* 1496c609719bSwdenkaccordingly! 1497c609719bSwdenk 1498c609719bSwdenk 1499c609719bSwdenk- CFG_ENV_IS_IN_NVRAM: 1500c609719bSwdenk 1501c609719bSwdenk Define this if you have some non-volatile memory device 1502c609719bSwdenk (NVRAM, battery buffered SRAM) which you want to use for the 1503c609719bSwdenk environment. 1504c609719bSwdenk 1505c609719bSwdenk - CFG_ENV_ADDR: 1506c609719bSwdenk - CFG_ENV_SIZE: 1507c609719bSwdenk 1508c609719bSwdenk These two #defines are used to determin the memory area you 1509c609719bSwdenk want to use for environment. It is assumed that this memory 1510c609719bSwdenk can just be read and written to, without any special 1511c609719bSwdenk provision. 1512c609719bSwdenk 1513c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early 1514c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the 1515c609719bSwdenkconsole baudrate). You *MUST* have mappend your NVRAM area then, or 1516c609719bSwdenkU-Boot will hang. 1517c609719bSwdenk 1518c609719bSwdenkPlease note that even with NVRAM we still use a copy of the 1519c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to 1520c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv" 1521c609719bSwdenkto save the current settings. 1522c609719bSwdenk 1523c609719bSwdenk 1524c609719bSwdenk- CFG_ENV_IS_IN_EEPROM: 1525c609719bSwdenk 1526c609719bSwdenk Use this if you have an EEPROM or similar serial access 1527c609719bSwdenk device and a driver for it. 1528c609719bSwdenk 1529c609719bSwdenk - CFG_ENV_OFFSET: 1530c609719bSwdenk - CFG_ENV_SIZE: 1531c609719bSwdenk 1532c609719bSwdenk These two #defines specify the offset and size of the 1533c609719bSwdenk environment area within the total memory of your EEPROM. 1534c609719bSwdenk 1535c609719bSwdenk - CFG_I2C_EEPROM_ADDR: 1536c609719bSwdenk If defined, specified the chip address of the EEPROM device. 1537c609719bSwdenk The default address is zero. 1538c609719bSwdenk 1539c609719bSwdenk - CFG_EEPROM_PAGE_WRITE_BITS: 1540c609719bSwdenk If defined, the number of bits used to address bytes in a 1541c609719bSwdenk single page in the EEPROM device. A 64 byte page, for example 1542c609719bSwdenk would require six bits. 1543c609719bSwdenk 1544c609719bSwdenk - CFG_EEPROM_PAGE_WRITE_DELAY_MS: 1545c609719bSwdenk If defined, the number of milliseconds to delay between 1546c609719bSwdenk page writes. The default is zero milliseconds. 1547c609719bSwdenk 1548c609719bSwdenk - CFG_I2C_EEPROM_ADDR_LEN: 1549c609719bSwdenk The length in bytes of the EEPROM memory array address. Note 1550c609719bSwdenk that this is NOT the chip address length! 1551c609719bSwdenk 1552c609719bSwdenk - CFG_EEPROM_SIZE: 1553c609719bSwdenk The size in bytes of the EEPROM device. 1554c609719bSwdenk 1555c609719bSwdenk 1556c609719bSwdenk- CFG_SPI_INIT_OFFSET 1557c609719bSwdenk 1558c609719bSwdenk Defines offset to the initial SPI buffer area in DPRAM. The 1559c609719bSwdenk area is used at an early stage (ROM part) if the environment 1560c609719bSwdenk is configured to reside in the SPI EEPROM: We need a 520 byte 1561c609719bSwdenk scratch DPRAM area. It is used between the two initialization 1562c609719bSwdenk calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems 1563c609719bSwdenk to be a good choice since it makes it far enough from the 1564c609719bSwdenk start of the data area as well as from the stack pointer. 1565c609719bSwdenk 1566c609719bSwdenkPlease note that the environment is read-only as long as the monitor 1567c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been 1568c609719bSwdenkcreated; also, when using EEPROM you will have to use getenv_r() 1569c609719bSwdenkuntil then to read environment variables. 1570c609719bSwdenk 157185ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor 157285ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working 157385ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is 157485ec0bccSwdenknecessary, because the first environment variable we need is the 157585ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't 157685ec0bccSwdenkhave any device yet where we could complain.] 1577c609719bSwdenk 1578c609719bSwdenkNote: once the monitor has been relocated, then it will complain if 1579c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you 158085ec0bccSwdenkuse the "saveenv" command to store a valid environment. 1581c609719bSwdenk 1582c609719bSwdenk 1583c609719bSwdenkLow Level (hardware related) configuration options: 1584dc7c9a1aSwdenk--------------------------------------------------- 1585c609719bSwdenk 1586c609719bSwdenk- CFG_CACHELINE_SIZE: 1587c609719bSwdenk Cache Line Size of the CPU. 1588c609719bSwdenk 1589c609719bSwdenk- CFG_DEFAULT_IMMR: 1590c609719bSwdenk Default address of the IMMR after system reset. 1591c609719bSwdenk Needed on some 8260 systems (MPC8260ADS and RPXsuper) 1592c609719bSwdenk to be able to adjust the position of the IMMR 1593c609719bSwdenk register after a reset. 1594c609719bSwdenk 15957f6c2cbcSwdenk- Floppy Disk Support: 15967f6c2cbcSwdenk CFG_FDC_DRIVE_NUMBER 15977f6c2cbcSwdenk 15987f6c2cbcSwdenk the default drive number (default value 0) 15997f6c2cbcSwdenk 16007f6c2cbcSwdenk CFG_ISA_IO_STRIDE 16017f6c2cbcSwdenk 16027f6c2cbcSwdenk defines the spacing between fdc chipset registers 16037f6c2cbcSwdenk (default value 1) 16047f6c2cbcSwdenk 16057f6c2cbcSwdenk CFG_ISA_IO_OFFSET 16067f6c2cbcSwdenk 16077f6c2cbcSwdenk defines the offset of register from address. It 16087f6c2cbcSwdenk depends on which part of the data bus is connected to 16097f6c2cbcSwdenk the fdc chipset. (default value 0) 16107f6c2cbcSwdenk 16117f6c2cbcSwdenk If CFG_ISA_IO_STRIDE CFG_ISA_IO_OFFSET and 16127f6c2cbcSwdenk CFG_FDC_DRIVE_NUMBER are undefined, they take their 16137f6c2cbcSwdenk default value. 16147f6c2cbcSwdenk 16157f6c2cbcSwdenk if CFG_FDC_HW_INIT is defined, then the function 16167f6c2cbcSwdenk fdc_hw_init() is called at the beginning of the FDC 16177f6c2cbcSwdenk setup. fdc_hw_init() must be provided by the board 16187f6c2cbcSwdenk source code. It is used to make hardware dependant 16197f6c2cbcSwdenk initializations. 16207f6c2cbcSwdenk 1621c609719bSwdenk- CFG_IMMR: Physical address of the Internal Memory Mapped 1622c609719bSwdenk Register; DO NOT CHANGE! (11-4) 1623c609719bSwdenk [MPC8xx systems only] 1624c609719bSwdenk 1625c609719bSwdenk- CFG_INIT_RAM_ADDR: 1626c609719bSwdenk 1627c609719bSwdenk Start address of memory area tha can be used for 1628c609719bSwdenk initial data and stack; please note that this must be 1629c609719bSwdenk writable memory that is working WITHOUT special 1630c609719bSwdenk initialization, i. e. you CANNOT use normal RAM which 1631c609719bSwdenk will become available only after programming the 1632c609719bSwdenk memory controller and running certain initialization 1633c609719bSwdenk sequences. 1634c609719bSwdenk 1635c609719bSwdenk U-Boot uses the following memory types: 1636c609719bSwdenk - MPC8xx and MPC8260: IMMR (internal memory of the CPU) 1637c609719bSwdenk - MPC824X: data cache 1638c609719bSwdenk - PPC4xx: data cache 1639c609719bSwdenk 164085ec0bccSwdenk- CFG_GBL_DATA_OFFSET: 1641c609719bSwdenk 1642c609719bSwdenk Offset of the initial data structure in the memory 1643c609719bSwdenk area defined by CFG_INIT_RAM_ADDR. Usually 164485ec0bccSwdenk CFG_GBL_DATA_OFFSET is chosen such that the initial 1645c609719bSwdenk data is located at the end of the available space 1646c609719bSwdenk (sometimes written as (CFG_INIT_RAM_END - 1647c609719bSwdenk CFG_INIT_DATA_SIZE), and the initial stack is just 1648c609719bSwdenk below that area (growing from (CFG_INIT_RAM_ADDR + 164985ec0bccSwdenk CFG_GBL_DATA_OFFSET) downward. 1650c609719bSwdenk 1651c609719bSwdenk Note: 1652c609719bSwdenk On the MPC824X (or other systems that use the data 1653c609719bSwdenk cache for initial memory) the address chosen for 1654c609719bSwdenk CFG_INIT_RAM_ADDR is basically arbitrary - it must 1655c609719bSwdenk point to an otherwise UNUSED address space between 1656c609719bSwdenk the top of RAM and the start of the PCI space. 1657c609719bSwdenk 1658c609719bSwdenk- CFG_SIUMCR: SIU Module Configuration (11-6) 1659c609719bSwdenk 1660c609719bSwdenk- CFG_SYPCR: System Protection Control (11-9) 1661c609719bSwdenk 1662c609719bSwdenk- CFG_TBSCR: Time Base Status and Control (11-26) 1663c609719bSwdenk 1664c609719bSwdenk- CFG_PISCR: Periodic Interrupt Status and Control (11-31) 1665c609719bSwdenk 1666c609719bSwdenk- CFG_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30) 1667c609719bSwdenk 1668c609719bSwdenk- CFG_SCCR: System Clock and reset Control Register (15-27) 1669c609719bSwdenk 1670c609719bSwdenk- CFG_OR_TIMING_SDRAM: 1671c609719bSwdenk SDRAM timing 1672c609719bSwdenk 1673c609719bSwdenk- CFG_MAMR_PTA: 1674c609719bSwdenk periodic timer for refresh 1675c609719bSwdenk 1676c609719bSwdenk- CFG_DER: Debug Event Register (37-47) 1677c609719bSwdenk 1678c609719bSwdenk- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CFG_REMAP_OR_AM, 1679c609719bSwdenk CFG_PRELIM_OR_AM, CFG_OR_TIMING_FLASH, CFG_OR0_REMAP, 1680c609719bSwdenk CFG_OR0_PRELIM, CFG_BR0_PRELIM, CFG_OR1_REMAP, CFG_OR1_PRELIM, 1681c609719bSwdenk CFG_BR1_PRELIM: 1682c609719bSwdenk Memory Controller Definitions: BR0/1 and OR0/1 (FLASH) 1683c609719bSwdenk 1684c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE, 1685c609719bSwdenk CFG_OR_TIMING_SDRAM, CFG_OR2_PRELIM, CFG_BR2_PRELIM, 1686c609719bSwdenk CFG_OR3_PRELIM, CFG_BR3_PRELIM: 1687c609719bSwdenk Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM) 1688c609719bSwdenk 1689c609719bSwdenk- CFG_MAMR_PTA, CFG_MPTPR_2BK_4K, CFG_MPTPR_1BK_4K, CFG_MPTPR_2BK_8K, 1690c609719bSwdenk CFG_MPTPR_1BK_8K, CFG_MAMR_8COL, CFG_MAMR_9COL: 1691c609719bSwdenk Machine Mode Register and Memory Periodic Timer 1692c609719bSwdenk Prescaler definitions (SDRAM timing) 1693c609719bSwdenk 1694c609719bSwdenk- CFG_I2C_UCODE_PATCH, CFG_I2C_DPMEM_OFFSET [0x1FC0]: 1695c609719bSwdenk enable I2C microcode relocation patch (MPC8xx); 1696c609719bSwdenk define relocation offset in DPRAM [DSP2] 1697c609719bSwdenk 1698c609719bSwdenk- CFG_SPI_UCODE_PATCH, CFG_SPI_DPMEM_OFFSET [0x1FC0]: 1699c609719bSwdenk enable SPI microcode relocation patch (MPC8xx); 1700c609719bSwdenk define relocation offset in DPRAM [SCC4] 1701c609719bSwdenk 1702c609719bSwdenk- CFG_USE_OSCCLK: 1703c609719bSwdenk Use OSCM clock mode on MBX8xx board. Be careful, 1704c609719bSwdenk wrong setting might damage your board. Read 1705c609719bSwdenk doc/README.MBX before setting this variable! 1706c609719bSwdenk 1707ea909b76Swdenk- CFG_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only) 1708ea909b76Swdenk Offset of the bootmode word in DPRAM used by post 1709ea909b76Swdenk (Power On Self Tests). This definition overrides 1710ea909b76Swdenk #define'd default value in commproc.h resp. 1711ea909b76Swdenk cpm_8260.h. 1712ea909b76Swdenk 1713c609719bSwdenkBuilding the Software: 1714c609719bSwdenk====================== 1715c609719bSwdenk 1716c609719bSwdenkBuilding U-Boot has been tested in native PPC environments (on a 1717c609719bSwdenkPowerBook G3 running LinuxPPC 2000) and in cross environments 1718c609719bSwdenk(running RedHat 6.x and 7.x Linux on x86, Solaris 2.6 on a SPARC, and 1719c609719bSwdenkNetBSD 1.5 on x86). 1720c609719bSwdenk 1721c609719bSwdenkIf you are not using a native PPC environment, it is assumed that you 1722c609719bSwdenkhave the GNU cross compiling tools available in your path and named 1723c609719bSwdenkwith a prefix of "powerpc-linux-". If this is not the case, (e.g. if 1724c609719bSwdenkyou are using Monta Vista's Hard Hat Linux CDK 1.2) you must change 1725c609719bSwdenkthe definition of CROSS_COMPILE in Makefile. For HHL on a 4xx CPU, 1726c609719bSwdenkchange it to: 1727c609719bSwdenk 1728c609719bSwdenk CROSS_COMPILE = ppc_4xx- 1729c609719bSwdenk 1730c609719bSwdenk 1731c609719bSwdenkU-Boot is intended to be simple to build. After installing the 1732c609719bSwdenksources you must configure U-Boot for one specific board type. This 1733c609719bSwdenkis done by typing: 1734c609719bSwdenk 1735c609719bSwdenk make NAME_config 1736c609719bSwdenk 1737c609719bSwdenkwhere "NAME_config" is the name of one of the existing 1738c609719bSwdenkconfigurations; the following names are supported: 1739c609719bSwdenk 1740c609719bSwdenk ADCIOP_config GTH_config TQM850L_config 1741c609719bSwdenk ADS860_config IP860_config TQM855L_config 1742c609719bSwdenk AR405_config IVML24_config TQM860L_config 1743c609719bSwdenk CANBT_config IVMS8_config WALNUT405_config 1744c609719bSwdenk CPCI405_config LANTEC_config cogent_common_config 1745c609719bSwdenk CPCIISER4_config MBX_config cogent_mpc8260_config 1746c609719bSwdenk CU824_config MBX860T_config cogent_mpc8xx_config 1747c609719bSwdenk ESTEEM192E_config RPXlite_config hermes_config 1748c609719bSwdenk ETX094_config RPXsuper_config hymod_config 1749c609719bSwdenk FADS823_config SM850_config lwmon_config 1750c609719bSwdenk FADS850SAR_config SPD823TS_config pcu_e_config 1751c609719bSwdenk FADS860T_config SXNI855T_config rsdproto_config 1752c609719bSwdenk FPS850L_config Sandpoint8240_config sbc8260_config 1753c609719bSwdenk GENIETV_config TQM823L_config PIP405_config 1754384ae025Swdenk GEN860T_config EBONY_config FPS860L_config 1755*7f70e853Swdenk ELPT860_config cmi_mpc5xx_config NETVIA_config 1756c609719bSwdenk 1757c609719bSwdenkNote: for some board special configuration names may exist; check if 1758c609719bSwdenk additional information is available from the board vendor; for 1759c609719bSwdenk instance, the TQM8xxL systems run normally at 50 MHz and use a 1760c609719bSwdenk SCC for 10baseT ethernet; there are also systems with 80 MHz 1761c609719bSwdenk CPU clock, and an optional Fast Ethernet module is available 1762c609719bSwdenk for CPU's with FEC. You can select such additional "features" 1763c609719bSwdenk when chosing the configuration, i. e. 1764c609719bSwdenk 1765c609719bSwdenk make TQM860L_config 1766c609719bSwdenk - will configure for a plain TQM860L, i. e. 50MHz, no FEC 1767c609719bSwdenk 1768c609719bSwdenk make TQM860L_FEC_config 1769c609719bSwdenk - will configure for a TQM860L at 50MHz with FEC for ethernet 1770c609719bSwdenk 1771c609719bSwdenk make TQM860L_80MHz_config 1772c609719bSwdenk - will configure for a TQM860L at 80 MHz, with normal 10baseT 1773c609719bSwdenk interface 1774c609719bSwdenk 1775c609719bSwdenk make TQM860L_FEC_80MHz_config 1776c609719bSwdenk - will configure for a TQM860L at 80 MHz with FEC for ethernet 1777c609719bSwdenk 1778c609719bSwdenk make TQM823L_LCD_config 1779c609719bSwdenk - will configure for a TQM823L with U-Boot console on LCD 1780c609719bSwdenk 1781c609719bSwdenk make TQM823L_LCD_80MHz_config 1782c609719bSwdenk - will configure for a TQM823L at 80 MHz with U-Boot console on LCD 1783c609719bSwdenk 1784c609719bSwdenk etc. 1785c609719bSwdenk 1786c609719bSwdenk 1787c609719bSwdenk 1788c609719bSwdenkFinally, type "make all", and you should get some working U-Boot 1789c609719bSwdenkimages ready for downlod to / installation on your system: 1790c609719bSwdenk 1791c609719bSwdenk- "u-boot.bin" is a raw binary image 1792c609719bSwdenk- "u-boot" is an image in ELF binary format 1793c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format 1794c609719bSwdenk 1795c609719bSwdenk 1796c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so 1797c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of 1798c609719bSwdenknative "make". 1799c609719bSwdenk 1800c609719bSwdenk 1801c609719bSwdenkIf the system board that you have is not listed, then you will need 1802c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these 1803c609719bSwdenksteps: 1804c609719bSwdenk 1805c609719bSwdenk1. Add a new configuration option for your board to the toplevel 180685ec0bccSwdenk "Makefile" and to the "MAKEALL" script, using the existing 180785ec0bccSwdenk entries as examples. Note that here and at many other places 180885ec0bccSwdenk boards and other names are listed alphabetically sorted. Please 180985ec0bccSwdenk keep this order. 1810c609719bSwdenk2. Create a new directory to hold your board specific code. Add any 181185ec0bccSwdenk files you need. In your board directory, you will need at least 181285ec0bccSwdenk the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds". 181385ec0bccSwdenk3. Create a new configuration file "include/configs/<board>.h" for 181485ec0bccSwdenk your board 1815c609719bSwdenk3. If you're porting U-Boot to a new CPU, then also create a new 1816c609719bSwdenk directory to hold your CPU specific code. Add any files you need. 181785ec0bccSwdenk4. Run "make <board>_config" with your new name. 1818c609719bSwdenk5. Type "make", and you should get a working "u-boot.srec" file 1819c609719bSwdenk to be installed on your target system. 182085ec0bccSwdenk6. Debug and solve any problems that might arise. 1821c609719bSwdenk [Of course, this last step is much harder than it sounds.] 1822c609719bSwdenk 1823c609719bSwdenk 1824c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.: 1825c609719bSwdenk============================================================== 1826c609719bSwdenk 1827c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board 1828c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to 1829c609719bSwdenkprovide feedback to the other developers. The feedback normally takes 1830c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest 1831c609719bSwdenkofficial or latest in CVS) version of U-Boot sources. 1832c609719bSwdenk 1833c609719bSwdenkBut before you submit such a patch, please verify that your modifi- 1834c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of 1835c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so, 1836c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot 1837c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can 1838c609719bSwdenkselect which (cross) compiler to use py passing a `CROSS_COMPILE' 1839c609719bSwdenkenvironment variable to the script, i. e. to use the cross tools from 1840c609719bSwdenkMontaVista's Hard Hat Linux you can type 1841c609719bSwdenk 1842c609719bSwdenk CROSS_COMPILE=ppc_8xx- MAKEALL 1843c609719bSwdenk 1844c609719bSwdenkor to build on a native PowerPC system you can type 1845c609719bSwdenk 1846c609719bSwdenk CROSS_COMPILE=' ' MAKEALL 1847c609719bSwdenk 1848c609719bSwdenkSee also "U-Boot Porting Guide" below. 1849c609719bSwdenk 1850c609719bSwdenk 1851c609719bSwdenk 1852c609719bSwdenkMonitor Commands - Overview: 1853c609719bSwdenk============================ 1854c609719bSwdenk 1855c609719bSwdenkgo - start application at address 'addr' 1856c609719bSwdenkrun - run commands in an environment variable 1857c609719bSwdenkbootm - boot application image from memory 1858c609719bSwdenkbootp - boot image via network using BootP/TFTP protocol 1859c609719bSwdenktftpboot- boot image via network using TFTP protocol 1860c609719bSwdenk and env variables "ipaddr" and "serverip" 1861c609719bSwdenk (and eventually "gatewayip") 1862c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol 1863c609719bSwdenkdiskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd' 1864c609719bSwdenkloads - load S-Record file over serial line 1865c609719bSwdenkloadb - load binary file over serial line (kermit mode) 1866c609719bSwdenkmd - memory display 1867c609719bSwdenkmm - memory modify (auto-incrementing) 1868c609719bSwdenknm - memory modify (constant address) 1869c609719bSwdenkmw - memory write (fill) 1870c609719bSwdenkcp - memory copy 1871c609719bSwdenkcmp - memory compare 1872c609719bSwdenkcrc32 - checksum calculation 1873c609719bSwdenkimd - i2c memory display 1874c609719bSwdenkimm - i2c memory modify (auto-incrementing) 1875c609719bSwdenkinm - i2c memory modify (constant address) 1876c609719bSwdenkimw - i2c memory write (fill) 1877c609719bSwdenkicrc32 - i2c checksum calculation 1878c609719bSwdenkiprobe - probe to discover valid I2C chip addresses 1879c609719bSwdenkiloop - infinite loop on address range 1880c609719bSwdenkisdram - print SDRAM configuration information 1881c609719bSwdenksspi - SPI utility commands 1882c609719bSwdenkbase - print or set address offset 1883c609719bSwdenkprintenv- print environment variables 1884c609719bSwdenksetenv - set environment variables 1885c609719bSwdenksaveenv - save environment variables to persistent storage 1886c609719bSwdenkprotect - enable or disable FLASH write protection 1887c609719bSwdenkerase - erase FLASH memory 1888c609719bSwdenkflinfo - print FLASH memory information 1889c609719bSwdenkbdinfo - print Board Info structure 1890c609719bSwdenkiminfo - print header information for application image 1891c609719bSwdenkconinfo - print console devices and informations 1892c609719bSwdenkide - IDE sub-system 1893c609719bSwdenkloop - infinite loop on address range 1894c609719bSwdenkmtest - simple RAM test 1895c609719bSwdenkicache - enable or disable instruction cache 1896c609719bSwdenkdcache - enable or disable data cache 1897c609719bSwdenkreset - Perform RESET of the CPU 1898c609719bSwdenkecho - echo args to console 1899c609719bSwdenkversion - print monitor version 1900c609719bSwdenkhelp - print online help 1901c609719bSwdenk? - alias for 'help' 1902c609719bSwdenk 1903c609719bSwdenk 1904c609719bSwdenkMonitor Commands - Detailed Description: 1905c609719bSwdenk======================================== 1906c609719bSwdenk 1907c609719bSwdenkTODO. 1908c609719bSwdenk 1909c609719bSwdenkFor now: just type "help <command>". 1910c609719bSwdenk 1911c609719bSwdenk 1912c609719bSwdenkEnvironment Variables: 1913c609719bSwdenk====================== 1914c609719bSwdenk 1915c609719bSwdenkU-Boot supports user configuration using Environment Variables which 1916c609719bSwdenkcan be made persistent by saving to Flash memory. 1917c609719bSwdenk 1918c609719bSwdenkEnvironment Variables are set using "setenv", printed using 1919c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv" 1920c609719bSwdenkwithout a value can be used to delete a variable from the 1921c609719bSwdenkenvironment. As long as you don't save the environment you are 1922c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the 1923c609719bSwdenkenvironment is erased by accident, a default environment is provided. 1924c609719bSwdenk 1925c609719bSwdenkSome configuration options can be set using Environment Variables: 1926c609719bSwdenk 1927c609719bSwdenk baudrate - see CONFIG_BAUDRATE 1928c609719bSwdenk 1929c609719bSwdenk bootdelay - see CONFIG_BOOTDELAY 1930c609719bSwdenk 1931c609719bSwdenk bootcmd - see CONFIG_BOOTCOMMAND 1932c609719bSwdenk 1933c609719bSwdenk bootargs - Boot arguments when booting an RTOS image 1934c609719bSwdenk 1935c609719bSwdenk bootfile - Name of the image to load with TFTP 1936c609719bSwdenk 1937c609719bSwdenk autoload - if set to "no" (any string beginning with 'n'), 1938c609719bSwdenk "bootp" will just load perform a lookup of the 1939c609719bSwdenk configuration from the BOOTP server, but not try to 1940c609719bSwdenk load any image using TFTP 1941c609719bSwdenk 1942c609719bSwdenk autostart - if set to "yes", an image loaded using the "bootp", 1943c609719bSwdenk "rarpboot", "tftpboot" or "diskboot" commands will 1944c609719bSwdenk be automatically started (by internally calling 1945c609719bSwdenk "bootm") 1946c609719bSwdenk 19474a6fd34bSwdenk If set to "no", a standalone image passed to the 19484a6fd34bSwdenk "bootm" command will be copied to the load address 19494a6fd34bSwdenk (and eventually uncompressed), but NOT be started. 19504a6fd34bSwdenk This can be used to load and uncompress arbitrary 19514a6fd34bSwdenk data. 19524a6fd34bSwdenk 1953c609719bSwdenk initrd_high - restrict positioning of initrd images: 1954c609719bSwdenk If this variable is not set, initrd images will be 1955c609719bSwdenk copied to the highest possible address in RAM; this 1956c609719bSwdenk is usually what you want since it allows for 1957c609719bSwdenk maximum initrd size. If for some reason you want to 1958c609719bSwdenk make sure that the initrd image is loaded below the 1959c609719bSwdenk CFG_BOOTMAPSZ limit, you can set this environment 1960c609719bSwdenk variable to a value of "no" or "off" or "0". 1961c609719bSwdenk Alternatively, you can set it to a maximum upper 1962c609719bSwdenk address to use (U-Boot will still check that it 1963c609719bSwdenk does not overwrite the U-Boot stack and data). 1964c609719bSwdenk 1965c609719bSwdenk For instance, when you have a system with 16 MB 1966c609719bSwdenk RAM, and want to reseve 4 MB from use by Linux, 1967c609719bSwdenk you can do this by adding "mem=12M" to the value of 1968c609719bSwdenk the "bootargs" variable. However, now you must make 1969c609719bSwdenk sure, that the initrd image is placed in the first 1970c609719bSwdenk 12 MB as well - this can be done with 1971c609719bSwdenk 1972c609719bSwdenk setenv initrd_high 00c00000 1973c609719bSwdenk 1974c609719bSwdenk ipaddr - IP address; needed for tftpboot command 1975c609719bSwdenk 1976c609719bSwdenk loadaddr - Default load address for commands like "bootp", 1977dc7c9a1aSwdenk "rarpboot", "tftpboot", "loadb" or "diskboot" 1978c609719bSwdenk 1979c609719bSwdenk loads_echo - see CONFIG_LOADS_ECHO 1980c609719bSwdenk 1981c609719bSwdenk serverip - TFTP server IP address; needed for tftpboot command 1982c609719bSwdenk 1983c609719bSwdenk bootretry - see CONFIG_BOOT_RETRY_TIME 1984c609719bSwdenk 1985c609719bSwdenk bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR 1986c609719bSwdenk 1987c609719bSwdenk bootstopkey - see CONFIG_AUTOBOOT_STOP_STR 1988c609719bSwdenk 1989c609719bSwdenk 1990c609719bSwdenkThe following environment variables may be used and automatically 1991c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"), 1992c609719bSwdenkdepending the information provided by your boot server: 1993c609719bSwdenk 1994c609719bSwdenk bootfile - see above 1995c609719bSwdenk dnsip - IP address of your Domain Name Server 1996c609719bSwdenk gatewayip - IP address of the Gateway (Router) to use 1997c609719bSwdenk hostname - Target hostname 1998c609719bSwdenk ipaddr - see above 1999c609719bSwdenk netmask - Subnet Mask 2000c609719bSwdenk rootpath - Pathname of the root filesystem on the NFS server 2001c609719bSwdenk serverip - see above 2002c609719bSwdenk 2003c609719bSwdenk 2004c609719bSwdenkThere are two special Environment Variables: 2005c609719bSwdenk 2006c609719bSwdenk serial# - contains hardware identification information such 2007c609719bSwdenk as type string and/or serial number 2008c609719bSwdenk ethaddr - Ethernet address 2009c609719bSwdenk 2010c609719bSwdenkThese variables can be set only once (usually during manufacturing of 2011c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables 2012c609719bSwdenkonce they have been set once. 2013c609719bSwdenk 2014c609719bSwdenk 2015c1551ea8SstroeseFurther special Environment Variables: 2016c1551ea8Sstroese 2017c1551ea8Sstroese ver - Contains the U-Boot version string as printed 2018c1551ea8Sstroese with the "version" command. This variable is 2019c1551ea8Sstroese readonly (see CONFIG_VERSION_VARIABLE). 2020c1551ea8Sstroese 2021c1551ea8Sstroese 2022c609719bSwdenkPlease note that changes to some configuration parameters may take 2023c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-). 2024c609719bSwdenk 2025c609719bSwdenk 2026c609719bSwdenkNote for Redundant Ethernet Interfaces: 2027c609719bSwdenk======================================= 2028c609719bSwdenk 2029c609719bSwdenkSome boards come with redundand ethernet interfaces; U-Boot supports 2030c609719bSwdenksuch configurations and is capable of automatic selection of a 2031c609719bSwdenk"working" interface when needed. MAC assignemnt works as follows: 2032c609719bSwdenk 2033c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding 2034c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0), 2035c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ... 2036c609719bSwdenk 2037c609719bSwdenkIf the network interface stores some valid MAC address (for instance 2038c609719bSwdenkin SROM), this is used as default address if there is NO correspon- 2039c609719bSwdenkding setting in the environment; if the corresponding environment 2040c609719bSwdenkvariable is set, this overrides the settings in the card; that means: 2041c609719bSwdenk 2042c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the 2043c609719bSwdenk environment, the SROM's address is used. 2044c609719bSwdenk 2045c609719bSwdenko If there is no valid address in the SROM, and a definition in the 2046c609719bSwdenk environment exists, then the value from the environment variable is 2047c609719bSwdenk used. 2048c609719bSwdenk 2049c609719bSwdenko If both the SROM and the environment contain a MAC address, and 2050c609719bSwdenk both addresses are the same, this MAC address is used. 2051c609719bSwdenk 2052c609719bSwdenko If both the SROM and the environment contain a MAC address, and the 2053c609719bSwdenk addresses differ, the value from the environment is used and a 2054c609719bSwdenk warning is printed. 2055c609719bSwdenk 2056c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error 2057c609719bSwdenk is raised. 2058c609719bSwdenk 2059c609719bSwdenk 2060c609719bSwdenk 2061c609719bSwdenkImage Formats: 2062c609719bSwdenk============== 2063c609719bSwdenk 2064c609719bSwdenkThe "boot" commands of this monitor operate on "image" files which 2065c609719bSwdenkcan be basicly anything, preceeded by a special header; see the 2066c609719bSwdenkdefinitions in include/image.h for details; basicly, the header 2067c609719bSwdenkdefines the following image properties: 2068c609719bSwdenk 2069c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD, 2070c609719bSwdenk 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks, 2071*7f70e853Swdenk LynxOS, pSOS, QNX, RTEMS, ARTOS; 2072*7f70e853Swdenk Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, ARTOS). 2073c609719bSwdenk* Target CPU Architecture (Provisions for Alpha, ARM, Intel x86, 2074c609719bSwdenk IA64, MIPS, MIPS, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit; 2075c609719bSwdenk Currently supported: PowerPC). 2076c609719bSwdenk* Compression Type (Provisions for uncompressed, gzip, bzip2; 2077c609719bSwdenk Currently supported: uncompressed, gzip). 2078c609719bSwdenk* Load Address 2079c609719bSwdenk* Entry Point 2080c609719bSwdenk* Image Name 2081c609719bSwdenk* Image Timestamp 2082c609719bSwdenk 2083c609719bSwdenkThe header is marked by a special Magic Number, and both the header 2084c609719bSwdenkand the data portions of the image are secured against corruption by 2085c609719bSwdenkCRC32 checksums. 2086c609719bSwdenk 2087c609719bSwdenk 2088c609719bSwdenkLinux Support: 2089c609719bSwdenk============== 2090c609719bSwdenk 2091c609719bSwdenkAlthough U-Boot should support any OS or standalone application 2092c609719bSwdenkeasily, Linux has always been in the focus during the design of 2093c609719bSwdenkU-Boot. 2094c609719bSwdenk 2095c609719bSwdenkU-Boot includes many features that so far have been part of some 2096c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any 2097c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image; 2098c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation 2099c609719bSwdenkserves serveral purposes: 2100c609719bSwdenk 2101c609719bSwdenk- the same features can be used for other OS or standalone 2102c609719bSwdenk applications (for instance: using compressed images to reduce the 2103c609719bSwdenk Flash memory footprint) 2104c609719bSwdenk 2105c609719bSwdenk- it becomes much easier to port new Linux kernel versions because 2106c609719bSwdenk lots of low-level, hardware dependend stuff are done by U-Boot 2107c609719bSwdenk 2108c609719bSwdenk- the same Linux kernel image can now be used with different "initrd" 2109c609719bSwdenk images; of course this also means that different kernel images can 2110c609719bSwdenk be run with the same "initrd". This makes testing easier (you don't 2111c609719bSwdenk have to build a new "zImage.initrd" Linux image when you just 2112c609719bSwdenk change a file in your "initrd"). Also, a field-upgrade of the 2113c609719bSwdenk software is easier now. 2114c609719bSwdenk 2115c609719bSwdenk 2116c609719bSwdenkLinux HOWTO: 2117c609719bSwdenk============ 2118c609719bSwdenk 2119c609719bSwdenkPorting Linux to U-Boot based systems: 2120c609719bSwdenk--------------------------------------- 2121c609719bSwdenk 2122c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to 2123c609719bSwdenkconfigure the Linux device drivers for use with your target hardware 2124c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to 2125c609719bSwdenkLinux :-). 2126c609719bSwdenk 2127c609719bSwdenkBut now you can ignore ALL boot loader code (in arch/ppc/mbxboot). 2128c609719bSwdenk 2129c609719bSwdenkJust make sure your machine specific header file (for instance 2130c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board 2131c609719bSwdenkInformation structure as we define in include/u-boot.h, and make 2132c609719bSwdenksure that your definition of IMAP_ADDR uses the same value as your 2133c609719bSwdenkU-Boot configuration in CFG_IMMR. 2134c609719bSwdenk 2135c609719bSwdenk 2136c609719bSwdenkConfiguring the Linux kernel: 2137c609719bSwdenk----------------------------- 2138c609719bSwdenk 2139c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root 2140c609719bSwdenkdevice (initial ramdisk, NFS) for your target system. 2141c609719bSwdenk 2142c609719bSwdenk 2143c609719bSwdenkBuilding a Linux Image: 2144c609719bSwdenk----------------------- 2145c609719bSwdenk 214624ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are 214724ee89b9Swdenknot used. If you use recent kernel source, a new build target 214824ee89b9Swdenk"uImage" will exist which automatically builds an image usable by 214924ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target, 215024ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a 215124ee89b9Swdenk100% compatible format. 2152c609719bSwdenk 2153c609719bSwdenkExample: 2154c609719bSwdenk 2155c609719bSwdenk make TQM850L_config 2156c609719bSwdenk make oldconfig 2157c609719bSwdenk make dep 215824ee89b9Swdenk make uImage 2159c609719bSwdenk 216024ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to 216124ee89b9Swdenkencapsulate a compressed Linux kernel image with header information, 216224ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing: 2163c609719bSwdenk 216424ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format): 216524ee89b9Swdenk 216624ee89b9Swdenk* convert the kernel into a raw binary image: 216724ee89b9Swdenk 216824ee89b9Swdenk ${CROSS_COMPILE}-objcopy -O binary \ 216924ee89b9Swdenk -R .note -R .comment \ 217024ee89b9Swdenk -S vmlinux linux.bin 217124ee89b9Swdenk 217224ee89b9Swdenk* compress the binary image: 217324ee89b9Swdenk 217424ee89b9Swdenk gzip -9 linux.bin 217524ee89b9Swdenk 217624ee89b9Swdenk* package compressed binary image for U-Boot: 217724ee89b9Swdenk 217824ee89b9Swdenk mkimage -A ppc -O linux -T kernel -C gzip \ 217924ee89b9Swdenk -a 0 -e 0 -n "Linux Kernel Image" \ 218024ee89b9Swdenk -d linux.bin.gz uImage 218124ee89b9Swdenk 218224ee89b9Swdenk 218324ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use 218424ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or 218524ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64 218624ee89b9Swdenkbyte header containing information about target architecture, 218724ee89b9Swdenkoperating system, image type, compression method, entry points, time 218824ee89b9Swdenkstamp, CRC32 checksums, etc. 218924ee89b9Swdenk 219024ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and 219124ee89b9Swdenkprint the header information, or to build new images. 2192c609719bSwdenk 2193c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information 2194c609719bSwdenkcontained in the header of an existing U-Boot image; this includes 2195c609719bSwdenkchecksum verification: 2196c609719bSwdenk 2197c609719bSwdenk tools/mkimage -l image 2198c609719bSwdenk -l ==> list image header information 2199c609719bSwdenk 2200c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image 2201c609719bSwdenkfrom a "data file" which is used as image payload: 2202c609719bSwdenk 2203c609719bSwdenk tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \ 2204c609719bSwdenk -n name -d data_file image 2205c609719bSwdenk -A ==> set architecture to 'arch' 2206c609719bSwdenk -O ==> set operating system to 'os' 2207c609719bSwdenk -T ==> set image type to 'type' 2208c609719bSwdenk -C ==> set compression type 'comp' 2209c609719bSwdenk -a ==> set load address to 'addr' (hex) 2210c609719bSwdenk -e ==> set entry point to 'ep' (hex) 2211c609719bSwdenk -n ==> set image name to 'name' 2212c609719bSwdenk -d ==> use image data from 'datafile' 2213c609719bSwdenk 2214c609719bSwdenkRight now, all Linux kernels use the same load address (0x00000000), 2215c609719bSwdenkbut the entry point address depends on the kernel version: 2216c609719bSwdenk 2217c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C, 221824ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000. 2219c609719bSwdenk 2220c609719bSwdenkSo a typical call to build a U-Boot image would read: 2221c609719bSwdenk 222224ee89b9Swdenk -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 222324ee89b9Swdenk > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \ 222424ee89b9Swdenk > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz \ 222524ee89b9Swdenk > examples/uImage.TQM850L 222624ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 2227c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 2228c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 2229c609719bSwdenk Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 2230c609719bSwdenk Load Address: 0x00000000 223124ee89b9Swdenk Entry Point: 0x00000000 2232c609719bSwdenk 2233c609719bSwdenkTo verify the contents of the image (or check for corruption): 2234c609719bSwdenk 223524ee89b9Swdenk -> tools/mkimage -l examples/uImage.TQM850L 223624ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 2237c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 2238c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 2239c609719bSwdenk Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 2240c609719bSwdenk Load Address: 0x00000000 224124ee89b9Swdenk Entry Point: 0x00000000 2242c609719bSwdenk 2243c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade 2244c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this 2245c609719bSwdenkneeds more space in Flash, but boots much faster since it does not 2246c609719bSwdenkneed to be uncompressed: 2247c609719bSwdenk 224824ee89b9Swdenk -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz 224924ee89b9Swdenk -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 225024ee89b9Swdenk > -A ppc -O linux -T kernel -C none -a 0 -e 0 \ 225124ee89b9Swdenk > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux \ 225224ee89b9Swdenk > examples/uImage.TQM850L-uncompressed 225324ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 2254c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 2255c609719bSwdenk Image Type: PowerPC Linux Kernel Image (uncompressed) 2256c609719bSwdenk Data Size: 792160 Bytes = 773.59 kB = 0.76 MB 2257c609719bSwdenk Load Address: 0x00000000 225824ee89b9Swdenk Entry Point: 0x00000000 2259c609719bSwdenk 2260c609719bSwdenk 2261c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file 2262c609719bSwdenkwhen your kernel is intended to use an initial ramdisk: 2263c609719bSwdenk 2264c609719bSwdenk -> tools/mkimage -n 'Simple Ramdisk Image' \ 2265c609719bSwdenk > -A ppc -O linux -T ramdisk -C gzip \ 2266c609719bSwdenk > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd 2267c609719bSwdenk Image Name: Simple Ramdisk Image 2268c609719bSwdenk Created: Wed Jan 12 14:01:50 2000 2269c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 2270c609719bSwdenk Data Size: 566530 Bytes = 553.25 kB = 0.54 MB 2271c609719bSwdenk Load Address: 0x00000000 2272c609719bSwdenk Entry Point: 0x00000000 2273c609719bSwdenk 2274c609719bSwdenk 2275c609719bSwdenkInstalling a Linux Image: 2276c609719bSwdenk------------------------- 2277c609719bSwdenk 2278c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface, 2279c609719bSwdenkyou must convert the image to S-Record format: 2280c609719bSwdenk 2281c609719bSwdenk objcopy -I binary -O srec examples/image examples/image.srec 2282c609719bSwdenk 2283c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot 2284c609719bSwdenkimage header, so the resulting S-Record file will be relative to 2285c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to 2286c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads' 2287c609719bSwdenkcommand. 2288c609719bSwdenk 2289c609719bSwdenkExample: install the image to address 0x40100000 (which on the 2290c609719bSwdenkTQM8xxL is in the first Flash bank): 2291c609719bSwdenk 2292c609719bSwdenk => erase 40100000 401FFFFF 2293c609719bSwdenk 2294c609719bSwdenk .......... done 2295c609719bSwdenk Erased 8 sectors 2296c609719bSwdenk 2297c609719bSwdenk => loads 40100000 2298c609719bSwdenk ## Ready for S-Record download ... 2299c609719bSwdenk ~>examples/image.srec 2300c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 12 13 ... 2301c609719bSwdenk ... 2302c609719bSwdenk 15989 15990 15991 15992 2303c609719bSwdenk [file transfer complete] 2304c609719bSwdenk [connected] 2305c609719bSwdenk ## Start Addr = 0x00000000 2306c609719bSwdenk 2307c609719bSwdenk 2308c609719bSwdenkYou can check the success of the download using the 'iminfo' command; 2309c609719bSwdenkthis includes a checksum verification so you can be sure no data 2310c609719bSwdenkcorruption happened: 2311c609719bSwdenk 2312c609719bSwdenk => imi 40100000 2313c609719bSwdenk 2314c609719bSwdenk ## Checking Image at 40100000 ... 2315c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 2316c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 2317c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 2318c609719bSwdenk Load Address: 00000000 2319c609719bSwdenk Entry Point: 0000000c 2320c609719bSwdenk Verifying Checksum ... OK 2321c609719bSwdenk 2322c609719bSwdenk 2323c609719bSwdenk 2324c609719bSwdenkBoot Linux: 2325c609719bSwdenk----------- 2326c609719bSwdenk 2327c609719bSwdenkThe "bootm" command is used to boot an application that is stored in 2328c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents 2329c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as 2330c609719bSwdenkparameters. You can check and modify this variable using the 2331c609719bSwdenk"printenv" and "setenv" commands: 2332c609719bSwdenk 2333c609719bSwdenk 2334c609719bSwdenk => printenv bootargs 2335c609719bSwdenk bootargs=root=/dev/ram 2336c609719bSwdenk 2337c609719bSwdenk => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 2338c609719bSwdenk 2339c609719bSwdenk => printenv bootargs 2340c609719bSwdenk bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 2341c609719bSwdenk 2342c609719bSwdenk => bootm 40020000 2343c609719bSwdenk ## Booting Linux kernel at 40020000 ... 2344c609719bSwdenk Image Name: 2.2.13 for NFS on TQM850L 2345c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 2346c609719bSwdenk Data Size: 381681 Bytes = 372 kB = 0 MB 2347c609719bSwdenk Load Address: 00000000 2348c609719bSwdenk Entry Point: 0000000c 2349c609719bSwdenk Verifying Checksum ... OK 2350c609719bSwdenk Uncompressing Kernel Image ... OK 2351c609719bSwdenk 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 2352c609719bSwdenk Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 2353c609719bSwdenk time_init: decrementer frequency = 187500000/60 2354c609719bSwdenk Calibrating delay loop... 49.77 BogoMIPS 2355c609719bSwdenk Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000] 2356c609719bSwdenk ... 2357c609719bSwdenk 2358c609719bSwdenkIf you want to boot a Linux kernel with initial ram disk, you pass 2359c609719bSwdenkthe memory addreses of both the kernel and the initrd image (PPBCOOT 2360c609719bSwdenkformat!) to the "bootm" command: 2361c609719bSwdenk 2362c609719bSwdenk => imi 40100000 40200000 2363c609719bSwdenk 2364c609719bSwdenk ## Checking Image at 40100000 ... 2365c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 2366c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 2367c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 2368c609719bSwdenk Load Address: 00000000 2369c609719bSwdenk Entry Point: 0000000c 2370c609719bSwdenk Verifying Checksum ... OK 2371c609719bSwdenk 2372c609719bSwdenk ## Checking Image at 40200000 ... 2373c609719bSwdenk Image Name: Simple Ramdisk Image 2374c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 2375c609719bSwdenk Data Size: 566530 Bytes = 553 kB = 0 MB 2376c609719bSwdenk Load Address: 00000000 2377c609719bSwdenk Entry Point: 00000000 2378c609719bSwdenk Verifying Checksum ... OK 2379c609719bSwdenk 2380c609719bSwdenk => bootm 40100000 40200000 2381c609719bSwdenk ## Booting Linux kernel at 40100000 ... 2382c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 2383c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 2384c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 2385c609719bSwdenk Load Address: 00000000 2386c609719bSwdenk Entry Point: 0000000c 2387c609719bSwdenk Verifying Checksum ... OK 2388c609719bSwdenk Uncompressing Kernel Image ... OK 2389c609719bSwdenk ## Loading RAMDisk Image at 40200000 ... 2390c609719bSwdenk Image Name: Simple Ramdisk Image 2391c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 2392c609719bSwdenk Data Size: 566530 Bytes = 553 kB = 0 MB 2393c609719bSwdenk Load Address: 00000000 2394c609719bSwdenk Entry Point: 00000000 2395c609719bSwdenk Verifying Checksum ... OK 2396c609719bSwdenk Loading Ramdisk ... OK 2397c609719bSwdenk 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 2398c609719bSwdenk Boot arguments: root=/dev/ram 2399c609719bSwdenk time_init: decrementer frequency = 187500000/60 2400c609719bSwdenk Calibrating delay loop... 49.77 BogoMIPS 2401c609719bSwdenk ... 2402c609719bSwdenk RAMDISK: Compressed image found at block 0 2403c609719bSwdenk VFS: Mounted root (ext2 filesystem). 2404c609719bSwdenk 2405c609719bSwdenk bash# 2406c609719bSwdenk 24076069ff26SwdenkMore About U-Boot Image Types: 24086069ff26Swdenk------------------------------ 24096069ff26Swdenk 24106069ff26SwdenkU-Boot supports the following image types: 24116069ff26Swdenk 24126069ff26Swdenk "Standalone Programs" are directly runnable in the environment 24136069ff26Swdenk provided by U-Boot; it is expected that (if they behave 24146069ff26Swdenk well) you can continue to work in U-Boot after return from 24156069ff26Swdenk the Standalone Program. 24166069ff26Swdenk "OS Kernel Images" are usually images of some Embedded OS which 24176069ff26Swdenk will take over control completely. Usually these programs 24186069ff26Swdenk will install their own set of exception handlers, device 24196069ff26Swdenk drivers, set up the MMU, etc. - this means, that you cannot 24206069ff26Swdenk expect to re-enter U-Boot except by resetting the CPU. 24216069ff26Swdenk "RAMDisk Images" are more or less just data blocks, and their 24226069ff26Swdenk parameters (address, size) are passed to an OS kernel that is 24236069ff26Swdenk being started. 24246069ff26Swdenk "Multi-File Images" contain several images, typically an OS 24256069ff26Swdenk (Linux) kernel image and one or more data images like 24266069ff26Swdenk RAMDisks. This construct is useful for instance when you want 24276069ff26Swdenk to boot over the network using BOOTP etc., where the boot 24286069ff26Swdenk server provides just a single image file, but you want to get 24296069ff26Swdenk for instance an OS kernel and a RAMDisk image. 24306069ff26Swdenk 24316069ff26Swdenk "Multi-File Images" start with a list of image sizes, each 24326069ff26Swdenk image size (in bytes) specified by an "uint32_t" in network 24336069ff26Swdenk byte order. This list is terminated by an "(uint32_t)0". 24346069ff26Swdenk Immediately after the terminating 0 follow the images, one by 24356069ff26Swdenk one, all aligned on "uint32_t" boundaries (size rounded up to 24366069ff26Swdenk a multiple of 4 bytes). 24376069ff26Swdenk 24386069ff26Swdenk "Firmware Images" are binary images containing firmware (like 24396069ff26Swdenk U-Boot or FPGA images) which usually will be programmed to 24406069ff26Swdenk flash memory. 24416069ff26Swdenk 24426069ff26Swdenk "Script files" are command sequences that will be executed by 24436069ff26Swdenk U-Boot's command interpreter; this feature is especially 24446069ff26Swdenk useful when you configure U-Boot to use a real shell (hush) 24456069ff26Swdenk as command interpreter. 24466069ff26Swdenk 2447c609719bSwdenk 2448c609719bSwdenkStandalone HOWTO: 2449c609719bSwdenk================= 2450c609719bSwdenk 2451c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and 2452c609719bSwdenkrun "standalone" applications, which can use some resources of 2453c609719bSwdenkU-Boot like console I/O functions or interrupt services. 2454c609719bSwdenk 2455c609719bSwdenkTwo simple examples are included with the sources: 2456c609719bSwdenk 2457c609719bSwdenk"Hello World" Demo: 2458c609719bSwdenk------------------- 2459c609719bSwdenk 2460c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo 2461c609719bSwdenkapplication; it is automatically compiled when you build U-Boot. 2462c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it 2463c609719bSwdenklike that: 2464c609719bSwdenk 2465c609719bSwdenk => loads 2466c609719bSwdenk ## Ready for S-Record download ... 2467c609719bSwdenk ~>examples/hello_world.srec 2468c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 ... 2469c609719bSwdenk [file transfer complete] 2470c609719bSwdenk [connected] 2471c609719bSwdenk ## Start Addr = 0x00040004 2472c609719bSwdenk 2473c609719bSwdenk => go 40004 Hello World! This is a test. 2474c609719bSwdenk ## Starting application at 0x00040004 ... 2475c609719bSwdenk Hello World 2476c609719bSwdenk argc = 7 2477c609719bSwdenk argv[0] = "40004" 2478c609719bSwdenk argv[1] = "Hello" 2479c609719bSwdenk argv[2] = "World!" 2480c609719bSwdenk argv[3] = "This" 2481c609719bSwdenk argv[4] = "is" 2482c609719bSwdenk argv[5] = "a" 2483c609719bSwdenk argv[6] = "test." 2484c609719bSwdenk argv[7] = "<NULL>" 2485c609719bSwdenk Hit any key to exit ... 2486c609719bSwdenk 2487c609719bSwdenk ## Application terminated, rc = 0x0 2488c609719bSwdenk 2489c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt 2490c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'. 2491c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second. 2492c609719bSwdenkThe interrupt service routine is trivial, just printing a '.' 2493c609719bSwdenkcharacter, but this is just a demo program. The application can be 2494c609719bSwdenkcontrolled by the following keys: 2495c609719bSwdenk 2496c609719bSwdenk ? - print current values og the CPM Timer registers 2497c609719bSwdenk b - enable interrupts and start timer 2498c609719bSwdenk e - stop timer and disable interrupts 2499c609719bSwdenk q - quit application 2500c609719bSwdenk 2501c609719bSwdenk => loads 2502c609719bSwdenk ## Ready for S-Record download ... 2503c609719bSwdenk ~>examples/timer.srec 2504c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 ... 2505c609719bSwdenk [file transfer complete] 2506c609719bSwdenk [connected] 2507c609719bSwdenk ## Start Addr = 0x00040004 2508c609719bSwdenk 2509c609719bSwdenk => go 40004 2510c609719bSwdenk ## Starting application at 0x00040004 ... 2511c609719bSwdenk TIMERS=0xfff00980 2512c609719bSwdenk Using timer 1 2513c609719bSwdenk tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0 2514c609719bSwdenk 2515c609719bSwdenkHit 'b': 2516c609719bSwdenk [q, b, e, ?] Set interval 1000000 us 2517c609719bSwdenk Enabling timer 2518c609719bSwdenkHit '?': 2519c609719bSwdenk [q, b, e, ?] ........ 2520c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0 2521c609719bSwdenkHit '?': 2522c609719bSwdenk [q, b, e, ?] . 2523c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0 2524c609719bSwdenkHit '?': 2525c609719bSwdenk [q, b, e, ?] . 2526c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0 2527c609719bSwdenkHit '?': 2528c609719bSwdenk [q, b, e, ?] . 2529c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0 2530c609719bSwdenkHit 'e': 2531c609719bSwdenk [q, b, e, ?] ...Stopping timer 2532c609719bSwdenkHit 'q': 2533c609719bSwdenk [q, b, e, ?] ## Application terminated, rc = 0x0 2534c609719bSwdenk 2535c609719bSwdenk 253685ec0bccSwdenk 253785ec0bccSwdenkMinicom warning: 253885ec0bccSwdenk================ 253985ec0bccSwdenk 254085ec0bccSwdenkOver time, many people have reported problems when trying to used the 254185ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd) 254285ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under 254385ec0bccSwdenkUnix, I recommend to use CKermit for general purpose use (and 254485ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and 254585ec0bccSwdenkuse "cu" for S-Record download ("loads" command). 254685ec0bccSwdenk 2547c609719bSwdenkNetBSD Notes: 2548c609719bSwdenk============= 2549c609719bSwdenk 2550c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host 2551c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx). 2552c609719bSwdenk 2553c609719bSwdenkBuilding requires a cross environment; it is known to work on 2554c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also 2555c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make). 2556c609719bSwdenkNote that the cross-powerpc package does not install include files; 2557c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is 2558c609719bSwdenkmissing. This file has to be installed and patched manually: 2559c609719bSwdenk 2560c609719bSwdenk # cd /usr/pkg/cross/powerpc-netbsd/include 2561c609719bSwdenk # mkdir powerpc 2562c609719bSwdenk # ln -s powerpc machine 2563c609719bSwdenk # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h 2564c609719bSwdenk # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST 2565c609719bSwdenk 2566c609719bSwdenkNative builds *don't* work due to incompatibilities between native 2567c609719bSwdenkand U-Boot include files. 2568c609719bSwdenk 2569c609719bSwdenkBooting assumes that (the first part of) the image booted is a 2570c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel 2571c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source 2572c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the 2573c609719bSwdenkmeantime, send mail to bruno@exet-ag.de and/or wd@denx.de for 2574c609719bSwdenkdetails. 2575c609719bSwdenk 2576c609719bSwdenk 2577c609719bSwdenkImplementation Internals: 2578c609719bSwdenk========================= 2579c609719bSwdenk 2580c609719bSwdenkThe following is not intended to be a complete description of every 2581c609719bSwdenkimplementation detail. However, it should help to understand the 2582c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom 2583c609719bSwdenkhardware. 2584c609719bSwdenk 2585c609719bSwdenk 2586c609719bSwdenkInitial Stack, Global Data: 2587c609719bSwdenk--------------------------- 2588c609719bSwdenk 2589c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot 2590c609719bSwdenkstarts running out of ROM (flash memory), usually without access to 2591c609719bSwdenksystem RAM (because the memory controller is not initialized yet). 2592c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS 2593c609719bSwdenkis not initialized as zero. To be able to get a C environment working 2594c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation 2595c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU 2596c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and 2597c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be 2598c609719bSwdenklocked as (mis-) used as memory, etc. 2599c609719bSwdenk 260043d9616cSwdenk Chris Hallinan posted a good summy of these issues to the 260143d9616cSwdenk u-boot-users mailing list: 260243d9616cSwdenk 260343d9616cSwdenk Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)? 260443d9616cSwdenk From: "Chris Hallinan" <clh@net1plus.com> 260543d9616cSwdenk Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET) 260643d9616cSwdenk ... 260743d9616cSwdenk 260843d9616cSwdenk Correct me if I'm wrong, folks, but the way I understand it 260943d9616cSwdenk is this: Using DCACHE as initial RAM for Stack, etc, does not 261043d9616cSwdenk require any physical RAM backing up the cache. The cleverness 261143d9616cSwdenk is that the cache is being used as a temporary supply of 261243d9616cSwdenk necessary storage before the SDRAM controller is setup. It's 261343d9616cSwdenk beyond the scope of this list to expain the details, but you 261443d9616cSwdenk can see how this works by studying the cache architecture and 261543d9616cSwdenk operation in the architecture and processor-specific manuals. 261643d9616cSwdenk 261743d9616cSwdenk OCM is On Chip Memory, which I believe the 405GP has 4K. It 261843d9616cSwdenk is another option for the system designer to use as an 261943d9616cSwdenk initial stack/ram area prior to SDRAM being available. Either 262043d9616cSwdenk option should work for you. Using CS 4 should be fine if your 262143d9616cSwdenk board designers haven't used it for something that would 262243d9616cSwdenk cause you grief during the initial boot! It is frequently not 262343d9616cSwdenk used. 262443d9616cSwdenk 262543d9616cSwdenk CFG_INIT_RAM_ADDR should be somewhere that won't interfere 262643d9616cSwdenk with your processor/board/system design. The default value 262743d9616cSwdenk you will find in any recent u-boot distribution in 262843d9616cSwdenk Walnut405.h should work for you. I'd set it to a value larger 262943d9616cSwdenk than your SDRAM module. If you have a 64MB SDRAM module, set 263043d9616cSwdenk it above 400_0000. Just make sure your board has no resources 263143d9616cSwdenk that are supposed to respond to that address! That code in 263243d9616cSwdenk start.S has been around a while and should work as is when 263343d9616cSwdenk you get the config right. 263443d9616cSwdenk 263543d9616cSwdenk -Chris Hallinan 263643d9616cSwdenk DS4.COM, Inc. 263743d9616cSwdenk 2638c609719bSwdenkIt is essential to remember this, since it has some impact on the C 2639c609719bSwdenkcode for the initialization procedures: 2640c609719bSwdenk 2641c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt 2642c609719bSwdenk to write it. 2643c609719bSwdenk 2644c609719bSwdenk* Do not use any unitialized global data (or implicitely initialized 2645c609719bSwdenk as zero data - BSS segment) at all - this is undefined, initiali- 2646c609719bSwdenk zation is performed later (when relocationg to RAM). 2647c609719bSwdenk 2648c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like 2649c609719bSwdenk that. 2650c609719bSwdenk 2651c609719bSwdenkHaving only the stack as writable memory limits means we cannot use 2652c609719bSwdenknormal global data to share information beween the code. But it 2653c609719bSwdenkturned out that the implementation of U-Boot can be greatly 2654c609719bSwdenksimplified by making a global data structure (gd_t) available to all 2655c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_ 2656c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of 2657c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we 2658c609719bSwdenkplace a pointer (gd) to the global data into a register which we 2659c609719bSwdenkreserve for this purpose. 2660c609719bSwdenk 2661c609719bSwdenkWhen chosing a register for such a purpose we are restricted by the 2662c609719bSwdenkrelevant (E)ABI specifications for the current architecture, and by 2663c609719bSwdenkGCC's implementation. 2664c609719bSwdenk 2665c609719bSwdenkFor PowerPC, the following registers have specific use: 2666c609719bSwdenk R1: stack pointer 2667c609719bSwdenk R2: TOC pointer 2668c609719bSwdenk R3-R4: parameter passing and return values 2669c609719bSwdenk R5-R10: parameter passing 2670c609719bSwdenk R13: small data area pointer 2671c609719bSwdenk R30: GOT pointer 2672c609719bSwdenk R31: frame pointer 2673c609719bSwdenk 2674c609719bSwdenk (U-Boot also uses R14 as internal GOT pointer.) 2675c609719bSwdenk 2676c609719bSwdenk ==> U-Boot will use R29 to hold a pointer to the global data 2677c609719bSwdenk 2678c609719bSwdenk Note: on PPC, we could use a static initializer (since the 2679c609719bSwdenk address of the global data structure is known at compile time), 2680c609719bSwdenk but it turned out that reserving a register results in somewhat 2681c609719bSwdenk smaller code - although the code savings are not that big (on 2682c609719bSwdenk average for all boards 752 bytes for the whole U-Boot image, 2683c609719bSwdenk 624 text + 127 data). 2684c609719bSwdenk 2685c609719bSwdenkOn ARM, the following registers are used: 2686c609719bSwdenk 2687c609719bSwdenk R0: function argument word/integer result 2688c609719bSwdenk R1-R3: function argument word 2689c609719bSwdenk R9: GOT pointer 2690c609719bSwdenk R10: stack limit (used only if stack checking if enabled) 2691c609719bSwdenk R11: argument (frame) pointer 2692c609719bSwdenk R12: temporary workspace 2693c609719bSwdenk R13: stack pointer 2694c609719bSwdenk R14: link register 2695c609719bSwdenk R15: program counter 2696c609719bSwdenk 2697c609719bSwdenk ==> U-Boot will use R8 to hold a pointer to the global data 2698c609719bSwdenk 2699c609719bSwdenk 2700c609719bSwdenk 2701c609719bSwdenkMemory Management: 2702c609719bSwdenk------------------ 2703c609719bSwdenk 2704c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the 2705c609719bSwdenkMMU is not used either for address mapping nor for memory protection. 2706c609719bSwdenk 2707c609719bSwdenkThe available memory is mapped to fixed addresses using the memory 2708c609719bSwdenkcontroller. In this process, a contiguous block is formed for each 2709c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several 2710c609719bSwdenkphysical memory banks. 2711c609719bSwdenk 2712c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on 2713c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After 2714c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself 2715c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some 2716c609719bSwdenkmemory is reserved for use by malloc() [see CFG_MALLOC_LEN 2717c609719bSwdenkconfiguration setting]. Below that, a structure with global Board 2718c609719bSwdenkInfo data is placed, followed by the stack (growing downward). 2719c609719bSwdenk 2720c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB 2721c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF). 2722c609719bSwdenk 2723c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like 2724c609719bSwdenkthis: 2725c609719bSwdenk 2726c609719bSwdenk 0x0000 0000 Exception Vector code 2727c609719bSwdenk : 2728c609719bSwdenk 0x0000 1FFF 2729c609719bSwdenk 0x0000 2000 Free for Application Use 2730c609719bSwdenk : 2731c609719bSwdenk : 2732c609719bSwdenk 2733c609719bSwdenk : 2734c609719bSwdenk : 2735c609719bSwdenk 0x00FB FF20 Monitor Stack (Growing downward) 2736c609719bSwdenk 0x00FB FFAC Board Info Data and permanent copy of global data 2737c609719bSwdenk 0x00FC 0000 Malloc Arena 2738c609719bSwdenk : 2739c609719bSwdenk 0x00FD FFFF 2740c609719bSwdenk 0x00FE 0000 RAM Copy of Monitor Code 2741c609719bSwdenk ... eventually: LCD or video framebuffer 2742c609719bSwdenk ... eventually: pRAM (Protected RAM - unchanged by reset) 2743c609719bSwdenk 0x00FF FFFF [End of RAM] 2744c609719bSwdenk 2745c609719bSwdenk 2746c609719bSwdenkSystem Initialization: 2747c609719bSwdenk---------------------- 2748c609719bSwdenk 2749c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point 2750c609719bSwdenk(on most PowerPC systens at address 0x00000100). Because of the reset 2751c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory. 2752c609719bSwdenkTo be able to re-map memory U-Boot then jumps to it's link address. 2753c609719bSwdenkTo be able to implement the initialization code in C, a (small!) 2754c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs 2755c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked 2756c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core, 2757c609719bSwdenkthe caches and the SIU. 2758c609719bSwdenk 2759c609719bSwdenkNext, all (potentially) available memory banks are mapped using a 2760c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries 2761c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash 2762c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is 2763c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a 2764c609719bSwdenksimple memory test is run that determines the size of the SDRAM 2765c609719bSwdenkbanks. 2766c609719bSwdenk 2767c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of 2768c609719bSwdenkdifferent size, the larger is mapped first. For equal size, the first 2769c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address 2770c609719bSwdenk0x00000000, with any additional banks following immediately to create 2771c609719bSwdenkcontiguous memory starting from 0. 2772c609719bSwdenk 2773c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area 2774c609719bSwdenkand allocates memory for use by malloc() and for the global Board 2775c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM 2776c609719bSwdenkpages, and the final stack is set up. 2777c609719bSwdenk 2778c609719bSwdenkOnly after this relocation will you have a "normal" C environment; 2779c609719bSwdenkuntil that you are restricted in several ways, mostly because you are 2780c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a 2781c609719bSwdenknew address in RAM. 2782c609719bSwdenk 2783c609719bSwdenk 2784c609719bSwdenkU-Boot Porting Guide: 2785c609719bSwdenk---------------------- 2786c609719bSwdenk 2787c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing 27886aff3115Swdenklist, October 2002] 2789c609719bSwdenk 2790c609719bSwdenk 2791c609719bSwdenkint main (int argc, char *argv[]) 2792c609719bSwdenk{ 2793c609719bSwdenk sighandler_t no_more_time; 2794c609719bSwdenk 2795c609719bSwdenk signal (SIGALRM, no_more_time); 2796c609719bSwdenk alarm (PROJECT_DEADLINE - toSec (3 * WEEK)); 2797c609719bSwdenk 2798c609719bSwdenk if (available_money > available_manpower) { 2799c609719bSwdenk pay consultant to port U-Boot; 2800c609719bSwdenk return 0; 2801c609719bSwdenk } 2802c609719bSwdenk 2803c609719bSwdenk Download latest U-Boot source; 2804c609719bSwdenk 28056aff3115Swdenk Subscribe to u-boot-users mailing list; 28066aff3115Swdenk 2807c609719bSwdenk if (clueless) { 2808c609719bSwdenk email ("Hi, I am new to U-Boot, how do I get started?"); 2809c609719bSwdenk } 2810c609719bSwdenk 2811c609719bSwdenk while (learning) { 2812c609719bSwdenk Read the README file in the top level directory; 2813c609719bSwdenk Read http://www.denx.de/re/DPLG.html 2814c609719bSwdenk Read the source, Luke; 2815c609719bSwdenk } 2816c609719bSwdenk 2817c609719bSwdenk if (available_money > toLocalCurrency ($2500)) { 2818c609719bSwdenk Buy a BDI2000; 2819c609719bSwdenk } else { 2820c609719bSwdenk Add a lot of aggravation and time; 2821c609719bSwdenk } 2822c609719bSwdenk 2823c609719bSwdenk Create your own board support subdirectory; 2824c609719bSwdenk 28256aff3115Swdenk Create your own board config file; 28266aff3115Swdenk 2827c609719bSwdenk while (!running) { 2828c609719bSwdenk do { 2829c609719bSwdenk Add / modify source code; 2830c609719bSwdenk } until (compiles); 2831c609719bSwdenk Debug; 2832c609719bSwdenk if (clueless) 2833c609719bSwdenk email ("Hi, I am having problems..."); 2834c609719bSwdenk } 2835c609719bSwdenk Send patch file to Wolfgang; 2836c609719bSwdenk 2837c609719bSwdenk return 0; 2838c609719bSwdenk} 2839c609719bSwdenk 2840c609719bSwdenkvoid no_more_time (int sig) 2841c609719bSwdenk{ 2842c609719bSwdenk hire_a_guru(); 2843c609719bSwdenk} 2844c609719bSwdenk 2845c609719bSwdenk 2846c609719bSwdenk 2847c609719bSwdenkCoding Standards: 2848c609719bSwdenk----------------- 2849c609719bSwdenk 2850c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel 2851c609719bSwdenkcoding style; see the file "Documentation/CodingStyle" in your Linux 2852c609719bSwdenkkernel source directory. 2853c609719bSwdenk 2854c609719bSwdenkPlease note that U-Boot is implemented in C (and to some small parts 2855c609719bSwdenkin Assembler); no C++ is used, so please do not use C++ style 2856c609719bSwdenkcomments (//) in your code. 2857c609719bSwdenk 2858c609719bSwdenkSubmissions which do not conform to the standards may be returned 2859c609719bSwdenkwith a request to reformat the changes. 2860c609719bSwdenk 2861c609719bSwdenk 2862c609719bSwdenkSubmitting Patches: 2863c609719bSwdenk------------------- 2864c609719bSwdenk 2865c609719bSwdenkSince the number of patches for U-Boot is growing, we need to 2866c609719bSwdenkestablish some rules. Submissions which do not conform to these rules 2867c609719bSwdenkmay be rejected, even when they contain important and valuable stuff. 2868c609719bSwdenk 2869c609719bSwdenk 2870c609719bSwdenkWhen you send a patch, please include the following information with 2871c609719bSwdenkit: 2872c609719bSwdenk 2873c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes 2874c609719bSwdenk this bug. Please try to include a way of demonstrating that the 2875c609719bSwdenk patch actually fixes something. 2876c609719bSwdenk 2877c609719bSwdenk* For new features: a description of the feature and your 2878c609719bSwdenk implementation. 2879c609719bSwdenk 2880c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch) 2881c609719bSwdenk 2882c609719bSwdenk* For major contributions, your entry to the CREDITS file 2883c609719bSwdenk 2884c609719bSwdenk* When you add support for a new board, don't forget to add this 2885c609719bSwdenk board to the MAKEALL script, too. 2886c609719bSwdenk 2887c609719bSwdenk* If your patch adds new configuration options, don't forget to 2888c609719bSwdenk document these in the README file. 2889c609719bSwdenk 2890c609719bSwdenk* The patch itself. If you are accessing the CVS repository use "cvs 2891c609719bSwdenk update; cvs diff -puRN"; else, use "diff -purN OLD NEW". If your 2892c609719bSwdenk version of diff does not support these options, then get the latest 2893c609719bSwdenk version of GNU diff. 2894c609719bSwdenk 2895c609719bSwdenk We accept patches as plain text, MIME attachments or as uuencoded 2896c609719bSwdenk gzipped text. 2897c609719bSwdenk 2898c609719bSwdenkNotes: 2899c609719bSwdenk 2900c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched 2901c609719bSwdenk source tree and make sure that no errors or warnings are reported 2902c609719bSwdenk for any of the boards. 2903c609719bSwdenk 2904c609719bSwdenk* Keep your modifications to the necessary minimum: A patch 2905c609719bSwdenk containing several unrelated changes or arbitrary reformats will be 2906c609719bSwdenk returned with a request to re-formatting / split it. 2907c609719bSwdenk 2908c609719bSwdenk* If you modify existing code, make sure that your new code does not 2909c609719bSwdenk add to the memory footprint of the code ;-) Small is beautiful! 2910c609719bSwdenk When adding new features, these should compile conditionally only 2911c609719bSwdenk (using #ifdef), and the resulting code with the new feature 2912c609719bSwdenk disabled must not need more memory than the old code without your 2913c609719bSwdenk modification. 2914