blob: 36ae0fb5ea3694245bb772210a4a2a9463c0db77 [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Wolfgang Denk218ca722008-03-26 10:40:12 +01002# (C) Copyright 2000 - 2008
wdenkc6097192002-11-03 00:24:07 +00003# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4#
5# See file CREDITS for list of people who contributed to this
6# project.
7#
8# This program is free software; you can redistribute it and/or
9# modify it under the terms of the GNU General Public License as
10# published by the Free Software Foundation; either version 2 of
11# the License, or (at your option) any later version.
12#
13# This program is distributed in the hope that it will be useful,
14# but WITHOUT ANY WARRANTY; without even the implied warranty of
15# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16# GNU General Public License for more details.
17#
18# You should have received a copy of the GNU General Public License
19# along with this program; if not, write to the Free Software
20# Foundation, Inc., 59 Temple Place, Suite 330, Boston,
21# MA 02111-1307 USA
22#
23
24Summary:
25========
26
wdenk24ee89b2002-11-03 17:56:27 +000027This directory contains the source code for U-Boot, a boot loader for
wdenke86e5a02004-10-17 21:12:06 +000028Embedded boards based on PowerPC, ARM, MIPS and several other
29processors, which can be installed in a boot ROM and used to
30initialize and test the hardware or to download and run application
31code.
wdenkc6097192002-11-03 00:24:07 +000032
33The development of U-Boot is closely related to Linux: some parts of
wdenk24ee89b2002-11-03 17:56:27 +000034the source code originate in the Linux source tree, we have some
35header files in common, and special provision has been made to
wdenkc6097192002-11-03 00:24:07 +000036support booting of Linux images.
37
38Some attention has been paid to make this software easily
39configurable and extendable. For instance, all monitor commands are
40implemented with the same call interface, so that it's very easy to
41add new commands. Also, instead of permanently adding rarely used
42code (for instance hardware test utilities) to the monitor, you can
43load and run it dynamically.
44
45
46Status:
47=======
48
49In general, all boards for which a configuration option exists in the
wdenk24ee89b2002-11-03 17:56:27 +000050Makefile have been tested to some extent and can be considered
wdenkc6097192002-11-03 00:24:07 +000051"working". In fact, many of them are used in production systems.
52
wdenk24ee89b2002-11-03 17:56:27 +000053In case of problems see the CHANGELOG and CREDITS files to find out
Wolfgang Denk218ca722008-03-26 10:40:12 +010054who contributed the specific port. The MAINTAINERS file lists board
55maintainers.
wdenkc6097192002-11-03 00:24:07 +000056
wdenkc6097192002-11-03 00:24:07 +000057
58Where to get help:
59==================
60
wdenk24ee89b2002-11-03 17:56:27 +000061In case you have questions about, problems with or contributions for
62U-Boot you should send a message to the U-Boot mailing list at
63<u-boot-users@lists.sourceforge.net>. There is also an archive of
64previous traffic on the mailing list - please search the archive
wdenkc6097192002-11-03 00:24:07 +000065before asking FAQ's. Please see
66http://lists.sourceforge.net/lists/listinfo/u-boot-users/
67
68
Wolfgang Denk218ca722008-03-26 10:40:12 +010069Where to get source code:
70=========================
71
72The U-Boot source code is maintained in the git repository at
73git://www.denx.de/git/u-boot.git ; you can browse it online at
74http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
75
76The "snapshot" links on this page allow you to download tarballs of
77any version you might be interested in. Ofifcial releases are also
78available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
79directory.
80
Anatolij Gustschind4ee7112008-03-26 18:13:33 +010081Pre-built (and tested) images are available from
Wolfgang Denk218ca722008-03-26 10:40:12 +010082ftp://ftp.denx.de/pub/u-boot/images/
83
84
wdenkc6097192002-11-03 00:24:07 +000085Where we come from:
86===================
87
88- start from 8xxrom sources
wdenk24ee89b2002-11-03 17:56:27 +000089- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenkc6097192002-11-03 00:24:07 +000090- clean up code
91- make it easier to add custom boards
92- make it possible to add other [PowerPC] CPUs
93- extend functions, especially:
94 * Provide extended interface to Linux boot loader
95 * S-Record download
96 * network boot
97 * PCMCIA / CompactFLash / ATA disk / SCSI ... boot
wdenk24ee89b2002-11-03 17:56:27 +000098- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenkc6097192002-11-03 00:24:07 +000099- add other CPU families (starting with ARM)
wdenk24ee89b2002-11-03 17:56:27 +0000100- create U-Boot project (http://sourceforge.net/projects/u-boot)
Wolfgang Denk218ca722008-03-26 10:40:12 +0100101- current project page: see http://www.denx.de/wiki/UBoot
wdenk24ee89b2002-11-03 17:56:27 +0000102
103
104Names and Spelling:
105===================
106
107The "official" name of this project is "Das U-Boot". The spelling
108"U-Boot" shall be used in all written text (documentation, comments
109in source files etc.). Example:
110
111 This is the README file for the U-Boot project.
112
113File names etc. shall be based on the string "u-boot". Examples:
114
115 include/asm-ppc/u-boot.h
116
117 #include <asm/u-boot.h>
118
119Variable names, preprocessor constants etc. shall be either based on
120the string "u_boot" or on "U_BOOT". Example:
121
122 U_BOOT_VERSION u_boot_logo
123 IH_OS_U_BOOT u_boot_hush_start
wdenkc6097192002-11-03 00:24:07 +0000124
125
wdenk93f19cc2002-12-17 17:55:09 +0000126Versioning:
127===========
128
129U-Boot uses a 3 level version number containing a version, a
130sub-version, and a patchlevel: "U-Boot-2.34.5" means version "2",
131sub-version "34", and patchlevel "4".
132
133The patchlevel is used to indicate certain stages of development
134between released versions, i. e. officially released versions of
135U-Boot will always have a patchlevel of "0".
136
137
wdenkc6097192002-11-03 00:24:07 +0000138Directory Hierarchy:
139====================
140
wdenk7152b1d2003-09-05 23:19:14 +0000141- board Board dependent files
142- common Misc architecture independent functions
wdenkc6097192002-11-03 00:24:07 +0000143- cpu CPU specific files
wdenk983fda82004-10-28 00:09:35 +0000144 - 74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs
wdenk11dadd52004-02-27 00:07:27 +0000145 - arm720t Files specific to ARM 720 CPUs
146 - arm920t Files specific to ARM 920 CPUs
wdenka85f9f22005-04-06 13:52:31 +0000147 - at91rm9200 Files specific to Atmel AT91RM9200 CPU
wdenk983fda82004-10-28 00:09:35 +0000148 - imx Files specific to Freescale MC9328 i.MX CPUs
wdenk1d9f4102004-10-09 22:21:29 +0000149 - s3c24x0 Files specific to Samsung S3C24X0 CPUs
wdenk11dadd52004-02-27 00:07:27 +0000150 - arm925t Files specific to ARM 925 CPUs
151 - arm926ejs Files specific to ARM 926 CPUs
wdenk8ed96042005-01-09 23:16:25 +0000152 - arm1136 Files specific to ARM 1136 CPUs
Wolfgang Denk72a087e2006-10-24 14:27:35 +0200153 - at32ap Files specific to Atmel AVR32 AP CPUs
wdenk11dadd52004-02-27 00:07:27 +0000154 - i386 Files specific to i386 CPUs
155 - ixp Files specific to Intel XScale IXP CPUs
Daniel Hellstromb3309902008-03-28 10:00:33 +0100156 - leon2 Files specific to Gaisler LEON2 SPARC CPU
Daniel Hellstrom1e9a1642008-03-26 22:51:29 +0100157 - leon3 Files specific to Gaisler LEON3 SPARC CPU
wdenk983fda82004-10-28 00:09:35 +0000158 - mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs
TsiChungLiew1552af72008-01-14 17:43:33 -0600159 - mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs
TsiChung Liew8e585f02007-06-18 13:50:13 -0500160 - mcf532x Files specific to Freescale ColdFire MCF5329 CPUs
TsiChungLiew8ae158c2007-08-16 15:05:11 -0500161 - mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs
TsiChungLiew57a12722008-01-15 14:15:46 -0600162 - mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs
wdenk11dadd52004-02-27 00:07:27 +0000163 - mips Files specific to MIPS CPUs
wdenk983fda82004-10-28 00:09:35 +0000164 - mpc5xx Files specific to Freescale MPC5xx CPUs
165 - mpc5xxx Files specific to Freescale MPC5xxx CPUs
166 - mpc8xx Files specific to Freescale MPC8xx CPUs
167 - mpc8220 Files specific to Freescale MPC8220 CPUs
168 - mpc824x Files specific to Freescale MPC824x CPUs
169 - mpc8260 Files specific to Freescale MPC8260 CPUs
170 - mpc85xx Files specific to Freescale MPC85xx CPUs
wdenk11dadd52004-02-27 00:07:27 +0000171 - nios Files specific to Altera NIOS CPUs
wdenk5c952cf2004-10-10 21:27:30 +0000172 - nios2 Files specific to Altera Nios-II CPUs
Wolfgang Denk0c8721a2005-09-23 11:05:55 +0200173 - ppc4xx Files specific to AMCC PowerPC 4xx CPUs
wdenk11dadd52004-02-27 00:07:27 +0000174 - pxa Files specific to Intel XScale PXA CPUs
175 - s3c44b0 Files specific to Samsung S3C44B0 CPUs
176 - sa1100 Files specific to Intel StrongARM SA1100 CPUs
wdenkc6097192002-11-03 00:24:07 +0000177- disk Code for disk drive partition handling
178- doc Documentation (don't expect too much)
wdenk7152b1d2003-09-05 23:19:14 +0000179- drivers Commonly used device drivers
wdenkc6097192002-11-03 00:24:07 +0000180- dtt Digital Thermometer and Thermostat drivers
181- examples Example code for standalone applications, etc.
182- include Header Files
wdenk11dadd52004-02-27 00:07:27 +0000183- lib_arm Files generic to ARM architecture
Wolfgang Denk7b64fef2006-10-24 14:21:16 +0200184- lib_avr32 Files generic to AVR32 architecture
wdenk11dadd52004-02-27 00:07:27 +0000185- lib_generic Files generic to all architectures
186- lib_i386 Files generic to i386 architecture
187- lib_m68k Files generic to m68k architecture
188- lib_mips Files generic to MIPS architecture
189- lib_nios Files generic to NIOS architecture
190- lib_ppc Files generic to PowerPC architecture
Daniel Hellstromc2f02da2008-03-28 09:47:00 +0100191- lib_sparc Files generic to SPARC architecture
Wolfgang Denk218ca722008-03-26 10:40:12 +0100192- libfdt Library files to support flattened device trees
wdenkc6097192002-11-03 00:24:07 +0000193- net Networking code
wdenkc6097192002-11-03 00:24:07 +0000194- post Power On Self Test
wdenkc6097192002-11-03 00:24:07 +0000195- rtc Real Time Clock drivers
196- tools Tools to build S-Record or U-Boot images, etc.
197
wdenkc6097192002-11-03 00:24:07 +0000198Software Configuration:
199=======================
200
201Configuration is usually done using C preprocessor defines; the
202rationale behind that is to avoid dead code whenever possible.
203
204There are two classes of configuration variables:
205
206* Configuration _OPTIONS_:
207 These are selectable by the user and have names beginning with
208 "CONFIG_".
209
210* Configuration _SETTINGS_:
211 These depend on the hardware etc. and should not be meddled with if
212 you don't know what you're doing; they have names beginning with
213 "CFG_".
214
215Later we will add a configuration tool - probably similar to or even
216identical to what's used for the Linux kernel. Right now, we have to
217do the configuration by hand, which means creating some symbolic
218links and editing some configuration files. We use the TQM8xxL boards
219as an example here.
220
221
222Selection of Processor Architecture and Board Type:
223---------------------------------------------------
224
225For all supported boards there are ready-to-use default
226configurations available; just type "make <board_name>_config".
227
228Example: For a TQM823L module type:
229
230 cd u-boot
231 make TQM823L_config
232
233For the Cogent platform, you need to specify the cpu type as well;
234e.g. "make cogent_mpc8xx_config". And also configure the cogent
235directory according to the instructions in cogent/README.
236
237
238Configuration Options:
239----------------------
240
241Configuration depends on the combination of board and CPU type; all
242such information is kept in a configuration file
243"include/configs/<board_name>.h".
244
245Example: For a TQM823L module, all configuration settings are in
246"include/configs/TQM823L.h".
247
248
wdenk7f6c2cb2002-11-10 22:06:23 +0000249Many of the options are named exactly as the corresponding Linux
250kernel configuration options. The intention is to make it easier to
251build a config tool - later.
252
253
wdenkc6097192002-11-03 00:24:07 +0000254The following options need to be configured:
255
Kim Phillips26281142007-08-10 13:28:25 -0500256- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000257
Kim Phillips26281142007-08-10 13:28:25 -0500258- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk6ccec442006-10-24 14:42:37 +0200259
260- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen09ea0de2007-11-01 12:44:20 +0100261 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000262
263- CPU Module Type: (if CONFIG_COGENT is defined)
264 Define exactly one of
265 CONFIG_CMA286_60_OLD
266--- FIXME --- not tested yet:
267 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
268 CONFIG_CMA287_23, CONFIG_CMA287_50
269
270- Motherboard Type: (if CONFIG_COGENT is defined)
271 Define exactly one of
272 CONFIG_CMA101, CONFIG_CMA102
273
274- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
275 Define one or more of
276 CONFIG_CMA302
277
278- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
279 Define one or more of
280 CONFIG_LCD_HEARTBEAT - update a character position on
281 the lcd display every second with
282 a "rotator" |\-/|\-/
283
wdenk2535d602003-07-17 23:16:40 +0000284- Board flavour: (if CONFIG_MPC8260ADS is defined)
285 CONFIG_ADSTYPE
286 Possible values are:
287 CFG_8260ADS - original MPC8260ADS
wdenk180d3f72004-01-04 16:28:35 +0000288 CFG_8266ADS - MPC8266ADS
wdenk54387ac2003-10-08 22:45:44 +0000289 CFG_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR
wdenk04a85b32004-04-15 18:22:41 +0000290 CFG_8272ADS - MPC8272ADS
wdenk2535d602003-07-17 23:16:40 +0000291
wdenkc6097192002-11-03 00:24:07 +0000292- MPC824X Family Member (if CONFIG_MPC824X is defined)
wdenk5da627a2003-10-09 20:09:04 +0000293 Define exactly one of
294 CONFIG_MPC8240, CONFIG_MPC8245
wdenkc6097192002-11-03 00:24:07 +0000295
wdenk75d1ea72004-01-31 20:06:54 +0000296- 8xx CPU Options: (if using an MPC8xx cpu)
wdenk66ca92a2004-09-28 17:59:53 +0000297 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
298 get_gclk_freq() cannot work
wdenk5da627a2003-10-09 20:09:04 +0000299 e.g. if there is no 32KHz
300 reference PIT/RTC clock
wdenk66ca92a2004-09-28 17:59:53 +0000301 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
302 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000303
wdenk66ca92a2004-09-28 17:59:53 +0000304- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
305 CFG_8xx_CPUCLK_MIN
306 CFG_8xx_CPUCLK_MAX
307 CONFIG_8xx_CPUCLK_DEFAULT
wdenk75d1ea72004-01-31 20:06:54 +0000308 See doc/README.MPC866
309
310 CFG_MEASURE_CPUCLK
311
wdenkba56f622004-02-06 23:19:44 +0000312 Define this to measure the actual CPU clock instead
313 of relying on the correctness of the configured
314 values. Mostly useful for board bringup to make sure
315 the PLL is locked at the intended frequency. Note
316 that this requires a (stable) reference clock (32 kHz
wdenk66ca92a2004-09-28 17:59:53 +0000317 RTC clock or CFG_8XX_XIN)
wdenk75d1ea72004-01-31 20:06:54 +0000318
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100319- Intel Monahans options:
320 CFG_MONAHANS_RUN_MODE_OSC_RATIO
321
322 Defines the Monahans run mode to oscillator
323 ratio. Valid values are 8, 16, 24, 31. The core
324 frequency is this value multiplied by 13 MHz.
325
326 CFG_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200327
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100328 Defines the Monahans turbo mode to oscillator
329 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200330 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100331 by this value.
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200332
wdenk5da627a2003-10-09 20:09:04 +0000333- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000334 CONFIG_CLOCKS_IN_MHZ
335
336 U-Boot stores all clock information in Hz
337 internally. For binary compatibility with older Linux
338 kernels (which expect the clocks passed in the
339 bd_info data to be in MHz) the environment variable
340 "clocks_in_mhz" can be defined so that U-Boot
341 converts clock data to MHZ before passing it to the
342 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000343 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denk218ca722008-03-26 10:40:12 +0100344 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000345 default environment.
346
wdenk5da627a2003-10-09 20:09:04 +0000347 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
348
349 When transfering memsize parameter to linux, some versions
350 expect it to be in bytes, others in MB.
351 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
352
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400353 CONFIG_OF_LIBFDT / CONFIG_OF_FLAT_TREE
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200354
355 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400356 passed using flattened device trees (based on open firmware
357 concepts).
358
359 CONFIG_OF_LIBFDT
360 * New libfdt-based support
361 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500362 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400363
364 CONFIG_OF_FLAT_TREE
365 * Deprecated, see CONFIG_OF_LIBFDT
366 * Original ft_build.c-based support
367 * Automatically modifies the dft as part of the bootm command
368 * The environment variable "disable_of", when set,
369 disables this functionality.
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200370
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200371 OF_CPU - The proper name of the cpus node.
Kumar Galac2871f02006-01-11 13:59:02 -0600372 OF_SOC - The proper name of the soc node.
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200373 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600374 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200375
Kim Phillips3bb342f2007-08-10 14:34:14 -0500376 boards with QUICC Engines require OF_QE to set UCC mac addresses
377
Kumar Gala4e253132006-01-11 13:54:17 -0600378 CONFIG_OF_BOARD_SETUP
379
380 Board code has addition modification that it wants to make
381 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000382
Matthew McClintock02677682006-06-28 10:41:37 -0500383 CONFIG_OF_BOOT_CPU
384
385 This define fills in the correct boot cpu in the boot
386 param header, the default value is zero if undefined.
387
wdenk6705d812004-08-02 23:22:59 +0000388- Serial Ports:
389 CFG_PL010_SERIAL
390
391 Define this if you want support for Amba PrimeCell PL010 UARTs.
392
393 CFG_PL011_SERIAL
394
395 Define this if you want support for Amba PrimeCell PL011 UARTs.
396
397 CONFIG_PL011_CLOCK
398
399 If you have Amba PrimeCell PL011 UARTs, set this variable to
400 the clock speed of the UARTs.
401
402 CONFIG_PL01x_PORTS
403
404 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
405 define this to a list of base addresses for each (supported)
406 port. See e.g. include/configs/versatile.h
407
408
wdenkc6097192002-11-03 00:24:07 +0000409- Console Interface:
wdenk43d96162003-03-06 00:02:04 +0000410 Depending on board, define exactly one serial port
411 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
412 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
413 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000414
415 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
416 port routines must be defined elsewhere
417 (i.e. serial_init(), serial_getc(), ...)
418
419 CONFIG_CFB_CONSOLE
420 Enables console device for a color framebuffer. Needs following
421 defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
422 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
423 (default big endian)
424 VIDEO_HW_RECTFILL graphic chip supports
425 rectangle fill
426 (cf. smiLynxEM)
427 VIDEO_HW_BITBLT graphic chip supports
428 bit-blit (cf. smiLynxEM)
429 VIDEO_VISIBLE_COLS visible pixel columns
430 (cols=pitch)
wdenkba56f622004-02-06 23:19:44 +0000431 VIDEO_VISIBLE_ROWS visible pixel rows
432 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000433 VIDEO_DATA_FORMAT graphic data format
434 (0-5, cf. cfb_console.c)
wdenkba56f622004-02-06 23:19:44 +0000435 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000436 VIDEO_KBD_INIT_FCT keyboard int fct
437 (i.e. i8042_kbd_init())
438 VIDEO_TSTC_FCT test char fct
439 (i.e. i8042_tstc)
440 VIDEO_GETC_FCT get char fct
441 (i.e. i8042_getc)
442 CONFIG_CONSOLE_CURSOR cursor drawing on/off
443 (requires blink timer
444 cf. i8042.c)
445 CFG_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
446 CONFIG_CONSOLE_TIME display time/date info in
447 upper right corner
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500448 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000449 CONFIG_VIDEO_LOGO display Linux logo in
450 upper left corner
wdenka6c7ad22002-12-03 21:28:10 +0000451 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
452 linux_logo.h for logo.
453 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000454 CONFIG_CONSOLE_EXTRA_INFO
455 addional board info beside
456 the logo
457
wdenk43d96162003-03-06 00:02:04 +0000458 When CONFIG_CFB_CONSOLE is defined, video console is
459 default i/o. Serial console can be forced with
460 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000461
wdenkd4ca31c2004-01-02 14:00:00 +0000462 When CONFIG_SILENT_CONSOLE is defined, all console
463 messages (by U-Boot and Linux!) can be silenced with
464 the "silent" environment variable. See
465 doc/README.silent for more information.
wdenka3ad8e22003-10-19 23:22:11 +0000466
wdenkc6097192002-11-03 00:24:07 +0000467- Console Baudrate:
468 CONFIG_BAUDRATE - in bps
469 Select one of the baudrates listed in
470 CFG_BAUDRATE_TABLE, see below.
wdenk3bbc8992003-12-07 22:27:15 +0000471 CFG_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000472
473- Interrupt driven serial port input:
474 CONFIG_SERIAL_SOFTWARE_FIFO
475
476 PPC405GP only.
477 Use an interrupt handler for receiving data on the
478 serial port. It also enables using hardware handshake
479 (RTS/CTS) and UART's built-in FIFO. Set the number of
480 bytes the interrupt driven input buffer should have.
481
wdenk109c0e32004-03-23 21:43:07 +0000482 Leave undefined to disable this feature, including
483 disable the buffer and hardware handshake.
wdenkc6097192002-11-03 00:24:07 +0000484
stroese1d49b1f2003-05-23 11:39:05 +0000485- Console UART Number:
486 CONFIG_UART1_CONSOLE
487
Wolfgang Denk0c8721a2005-09-23 11:05:55 +0200488 AMCC PPC4xx only.
stroese1d49b1f2003-05-23 11:39:05 +0000489 If defined internal UART1 (and not UART0) is used
490 as default U-Boot console.
491
wdenkc6097192002-11-03 00:24:07 +0000492- Boot Delay: CONFIG_BOOTDELAY - in seconds
493 Delay before automatically booting the default image;
494 set to -1 to disable autoboot.
495
496 See doc/README.autoboot for these options that
497 work with CONFIG_BOOTDELAY. None are required.
498 CONFIG_BOOT_RETRY_TIME
499 CONFIG_BOOT_RETRY_MIN
500 CONFIG_AUTOBOOT_KEYED
501 CONFIG_AUTOBOOT_PROMPT
502 CONFIG_AUTOBOOT_DELAY_STR
503 CONFIG_AUTOBOOT_STOP_STR
504 CONFIG_AUTOBOOT_DELAY_STR2
505 CONFIG_AUTOBOOT_STOP_STR2
506 CONFIG_ZERO_BOOTDELAY_CHECK
507 CONFIG_RESET_TO_RETRY
508
509- Autoboot Command:
510 CONFIG_BOOTCOMMAND
511 Only needed when CONFIG_BOOTDELAY is enabled;
512 define a command string that is automatically executed
513 when no character is read on the console interface
514 within "Boot Delay" after reset.
515
516 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000517 This can be used to pass arguments to the bootm
518 command. The value of CONFIG_BOOTARGS goes into the
519 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000520
521 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000522 The value of these goes into the environment as
523 "ramboot" and "nfsboot" respectively, and can be used
524 as a convenience, when switching between booting from
525 ram and nfs.
wdenkc6097192002-11-03 00:24:07 +0000526
527- Pre-Boot Commands:
528 CONFIG_PREBOOT
529
530 When this option is #defined, the existence of the
531 environment variable "preboot" will be checked
532 immediately before starting the CONFIG_BOOTDELAY
533 countdown and/or running the auto-boot command resp.
534 entering interactive mode.
535
536 This feature is especially useful when "preboot" is
537 automatically generated or modified. For an example
538 see the LWMON board specific code: here "preboot" is
539 modified when the user holds down a certain
540 combination of keys on the (special) keyboard when
541 booting the systems
542
543- Serial Download Echo Mode:
544 CONFIG_LOADS_ECHO
545 If defined to 1, all characters received during a
546 serial download (using the "loads" command) are
547 echoed back. This might be needed by some terminal
548 emulations (like "cu"), but may as well just take
549 time on others. This setting #define's the initial
550 value of the "loads_echo" environment variable.
551
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500552- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000553 CONFIG_KGDB_BAUDRATE
554 Select one of the baudrates listed in
555 CFG_BAUDRATE_TABLE, see below.
556
557- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500558 Monitor commands can be included or excluded
559 from the build by using the #include files
560 "config_cmd_all.h" and #undef'ing unwanted
561 commands, or using "config_cmd_default.h"
562 and augmenting with additional #define's
563 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000564
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500565 The default command configuration includes all commands
566 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000567
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500568 CONFIG_CMD_ASKENV * ask for env variable
569 CONFIG_CMD_AUTOSCRIPT Autoscript Support
570 CONFIG_CMD_BDI bdinfo
571 CONFIG_CMD_BEDBUG * Include BedBug Debugger
572 CONFIG_CMD_BMP * BMP support
573 CONFIG_CMD_BSP * Board specific commands
574 CONFIG_CMD_BOOTD bootd
575 CONFIG_CMD_CACHE * icache, dcache
576 CONFIG_CMD_CONSOLE coninfo
577 CONFIG_CMD_DATE * support for RTC, date/time...
578 CONFIG_CMD_DHCP * DHCP support
579 CONFIG_CMD_DIAG * Diagnostics
580 CONFIG_CMD_DOC * Disk-On-Chip Support
581 CONFIG_CMD_DTT * Digital Therm and Thermostat
582 CONFIG_CMD_ECHO echo arguments
583 CONFIG_CMD_EEPROM * EEPROM read/write support
584 CONFIG_CMD_ELF * bootelf, bootvx
585 CONFIG_CMD_ENV saveenv
586 CONFIG_CMD_FDC * Floppy Disk Support
587 CONFIG_CMD_FAT * FAT partition support
588 CONFIG_CMD_FDOS * Dos diskette Support
589 CONFIG_CMD_FLASH flinfo, erase, protect
590 CONFIG_CMD_FPGA FPGA device initialization support
591 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
592 CONFIG_CMD_I2C * I2C serial bus support
593 CONFIG_CMD_IDE * IDE harddisk support
594 CONFIG_CMD_IMI iminfo
595 CONFIG_CMD_IMLS List all found images
596 CONFIG_CMD_IMMAP * IMMR dump support
597 CONFIG_CMD_IRQ * irqinfo
598 CONFIG_CMD_ITEST Integer/string test of 2 values
599 CONFIG_CMD_JFFS2 * JFFS2 Support
600 CONFIG_CMD_KGDB * kgdb
601 CONFIG_CMD_LOADB loadb
602 CONFIG_CMD_LOADS loads
603 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
604 loop, loopw, mtest
605 CONFIG_CMD_MISC Misc functions like sleep etc
606 CONFIG_CMD_MMC * MMC memory mapped support
607 CONFIG_CMD_MII * MII utility commands
608 CONFIG_CMD_NAND * NAND support
609 CONFIG_CMD_NET bootp, tftpboot, rarpboot
610 CONFIG_CMD_PCI * pciinfo
611 CONFIG_CMD_PCMCIA * PCMCIA support
612 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
613 host
614 CONFIG_CMD_PORTIO * Port I/O
615 CONFIG_CMD_REGINFO * Register dump
616 CONFIG_CMD_RUN run command in env variable
617 CONFIG_CMD_SAVES * save S record dump
618 CONFIG_CMD_SCSI * SCSI Support
619 CONFIG_CMD_SDRAM * print SDRAM configuration information
620 (requires CONFIG_CMD_I2C)
621 CONFIG_CMD_SETGETDCR Support for DCR Register access
622 (4xx only)
623 CONFIG_CMD_SPI * SPI serial bus support
624 CONFIG_CMD_USB * USB support
625 CONFIG_CMD_VFD * VFD support (TRAB)
626 CONFIG_CMD_BSP * Board SPecific functions
627 CONFIG_CMD_CDP * Cisco Discover Protocol support
628 CONFIG_CMD_FSL * Microblaze FSL support
wdenkc6097192002-11-03 00:24:07 +0000629
wdenkc6097192002-11-03 00:24:07 +0000630
631 EXAMPLE: If you want all functions except of network
632 support you can write:
633
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500634 #include "config_cmd_all.h"
635 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000636
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400637 Other Commands:
638 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000639
640 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500641 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +0000642 what you (and your U-Boot users) are doing. Data
643 cache cannot be enabled on systems like the 8xx or
644 8260 (where accesses to the IMMR region must be
645 uncached), and it cannot be disabled on all other
646 systems where we (mis-) use the data cache to hold an
647 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000648
649
650 XXX - this list needs to get updated!
651
652- Watchdog:
653 CONFIG_WATCHDOG
654 If this variable is defined, it enables watchdog
wdenk7152b1d2003-09-05 23:19:14 +0000655 support. There must be support in the platform specific
wdenkc6097192002-11-03 00:24:07 +0000656 code for a watchdog. For the 8xx and 8260 CPUs, the
657 SIU Watchdog feature is enabled in the SYPCR
658 register.
659
stroesec1551ea2003-04-04 15:53:41 +0000660- U-Boot Version:
661 CONFIG_VERSION_VARIABLE
662 If this variable is defined, an environment variable
663 named "ver" is created by U-Boot showing the U-Boot
664 version as printed by the "version" command.
665 This variable is readonly.
666
wdenkc6097192002-11-03 00:24:07 +0000667- Real-Time Clock:
668
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500669 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000670 has to be selected, too. Define exactly one of the
671 following options:
672
673 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
674 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Guennadi Liakhovetski7ce63702008-04-15 14:15:30 +0200675 CONFIG_RTC_MC13783 - use MC13783 RTC
wdenkc6097192002-11-03 00:24:07 +0000676 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +0000677 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000678 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +0000679 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenk3bac3512003-03-12 10:41:04 +0000680 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +0100681 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +0000682 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Joakim Tjernlundda8808d2008-03-26 13:02:13 +0100683 CFG_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
wdenkc6097192002-11-03 00:24:07 +0000684
wdenkb37c7e52003-06-30 16:24:52 +0000685 Note that if the RTC uses I2C, then the I2C interface
686 must also be configured. See I2C Support, below.
687
wdenkc6097192002-11-03 00:24:07 +0000688- Timestamp Support:
689
wdenk43d96162003-03-06 00:02:04 +0000690 When CONFIG_TIMESTAMP is selected, the timestamp
691 (date and time) of an image is printed by image
692 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500693 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000694
695- Partition Support:
696 CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
697 and/or CONFIG_ISO_PARTITION
698
Wolfgang Denk218ca722008-03-26 10:40:12 +0100699 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
700 CONFIG_CMD_SCSI) you must configure support for at
701 least one partition type as well.
wdenkc6097192002-11-03 00:24:07 +0000702
703- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +0000704 CONFIG_IDE_RESET_ROUTINE - this is defined in several
705 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +0000706
wdenk4d13cba2004-03-14 14:09:05 +0000707 CONFIG_IDE_RESET - is this is defined, IDE Reset will
708 be performed by calling the function
709 ide_set_reset(int reset)
710 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +0000711
712- ATAPI Support:
713 CONFIG_ATAPI
714
715 Set this to enable ATAPI support.
716
wdenkc40b2952004-03-13 23:29:43 +0000717- LBA48 Support
718 CONFIG_LBA48
719
720 Set this to enable support for disks larger than 137GB
721 Also look at CFG_64BIT_LBA ,CFG_64BIT_VSPRINTF and CFG_64BIT_STRTOUL
722 Whithout these , LBA48 support uses 32bit variables and will 'only'
723 support disks up to 2.1TB.
724
725 CFG_64BIT_LBA:
726 When enabled, makes the IDE subsystem use 64bit sector addresses.
727 Default is 32bit.
728
wdenkc6097192002-11-03 00:24:07 +0000729- SCSI Support:
730 At the moment only there is only support for the
731 SYM53C8XX SCSI controller; define
732 CONFIG_SCSI_SYM53C8XX to enable it.
733
734 CFG_SCSI_MAX_LUN [8], CFG_SCSI_MAX_SCSI_ID [7] and
735 CFG_SCSI_MAX_DEVICE [CFG_SCSI_MAX_SCSI_ID *
736 CFG_SCSI_MAX_LUN] can be adjusted to define the
737 maximum numbers of LUNs, SCSI ID's and target
738 devices.
739 CFG_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
740
741- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +0000742 CONFIG_E1000
743 Support for Intel 8254x gigabit chips.
stroese53cf9432003-06-05 15:39:44 +0000744
Andre Schwarzac3315c2008-03-06 16:45:44 +0100745 CONFIG_E1000_FALLBACK_MAC
746 default MAC for empty eeprom after production.
747
wdenkc6097192002-11-03 00:24:07 +0000748 CONFIG_EEPRO100
749 Support for Intel 82557/82559/82559ER chips.
750 Optional CONFIG_EEPRO100_SROM_WRITE enables eeprom
751 write routine for first time initialisation.
752
753 CONFIG_TULIP
754 Support for Digital 2114x chips.
755 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
756 modem chip initialisation (KS8761/QS6611).
757
758 CONFIG_NATSEMI
759 Support for National dp83815 chips.
760
761 CONFIG_NS8382X
762 Support for National dp8382[01] gigabit chips.
763
wdenk45219c42003-05-12 21:50:16 +0000764- NETWORK Support (other):
765
766 CONFIG_DRIVER_LAN91C96
767 Support for SMSC's LAN91C96 chips.
768
769 CONFIG_LAN91C96_BASE
770 Define this to hold the physical address
771 of the LAN91C96's I/O space
772
773 CONFIG_LAN91C96_USE_32_BIT
774 Define this to enable 32 bit addressing
775
wdenkf39748a2004-06-09 13:37:52 +0000776 CONFIG_DRIVER_SMC91111
777 Support for SMSC's LAN91C111 chip
778
779 CONFIG_SMC91111_BASE
780 Define this to hold the physical address
781 of the device (I/O space)
782
783 CONFIG_SMC_USE_32_BIT
784 Define this if data bus is 32 bits
785
786 CONFIG_SMC_USE_IOFUNCS
787 Define this to use i/o functions instead of macros
788 (some hardware wont work with macros)
789
wdenkc6097192002-11-03 00:24:07 +0000790- USB Support:
791 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +0000792 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +0000793 CONFIG_USB_UHCI to enable it.
794 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +0000795 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +0000796 storage devices.
797 Note:
798 Supported are USB Keyboards and USB Floppy drives
799 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +0000800 MPC5200 USB requires additional defines:
801 CONFIG_USB_CLOCK
802 for 528 MHz Clock: 0x0001bbbb
803 CONFIG_USB_CONFIG
804 for differential drivers: 0x00001000
805 for single ended drivers: 0x00005000
Zhang Weifdcfaa12007-06-06 10:08:13 +0200806 CFG_USB_EVENT_POLL
807 May be defined to allow interrupt polling
808 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +0000809
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200810- USB Device:
811 Define the below if you wish to use the USB console.
812 Once firmware is rebuilt from a serial console issue the
813 command "setenv stdin usbtty; setenv stdout usbtty" and
814 attach your usb cable. The Unix command "dmesg" should print
815 it has found a new device. The environment variable usbtty
816 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +0200817 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200818 Common Device Class Abstract Control Model serial device.
819 If you select usbtty = gserial you should be able to enumerate
820 a Linux host by
821 # modprobe usbserial vendor=0xVendorID product=0xProductID
822 else if using cdc_acm, simply setting the environment
823 variable usbtty to be cdc_acm should suffice. The following
824 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +0200825
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200826 CONFIG_USB_DEVICE
827 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +0000828
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200829 CONFIG_USB_TTY
830 Define this to have a tty type of device available to
831 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +0200832
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200833 CFG_CONSOLE_IS_IN_ENV
834 Define this if you want stdin, stdout &/or stderr to
835 be set to usbtty.
836
837 mpc8xx:
838 CFG_USB_EXTC_CLK 0xBLAH
839 Derive USB clock from external clock "blah"
Wolfgang Denk386eda02006-06-14 18:14:56 +0200840 - CFG_USB_EXTC_CLK 0x02
841
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200842 CFG_USB_BRG_CLK 0xBLAH
843 Derive USB clock from brgclk
844 - CFG_USB_BRG_CLK 0x04
845
Wolfgang Denk386eda02006-06-14 18:14:56 +0200846 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200847 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +0200848 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200849 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
850 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
851 should pretend to be a Linux device to it's target host.
852
853 CONFIG_USBD_MANUFACTURER
854 Define this string as the name of your company for
855 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +0200856
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200857 CONFIG_USBD_PRODUCT_NAME
858 Define this string as the name of your product
859 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
860
861 CONFIG_USBD_VENDORID
862 Define this as your assigned Vendor ID from the USB
863 Implementors Forum. This *must* be a genuine Vendor ID
864 to avoid polluting the USB namespace.
865 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +0200866
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200867 CONFIG_USBD_PRODUCTID
868 Define this as the unique Product ID
869 for your device
870 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +0000871
872
873- MMC Support:
874 The MMC controller on the Intel PXA is supported. To
875 enable this define CONFIG_MMC. The MMC can be
876 accessed from the boot prompt by mapping the device
877 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500878 enabled with CONFIG_CMD_MMC. The MMC driver also works with
879 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +0000880
wdenk6705d812004-08-02 23:22:59 +0000881- Journaling Flash filesystem support:
882 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
883 CONFIG_JFFS2_NAND_DEV
884 Define these for a default partition on a NAND device
885
886 CFG_JFFS2_FIRST_SECTOR,
887 CFG_JFFS2_FIRST_BANK, CFG_JFFS2_NUM_BANKS
888 Define these for a default partition on a NOR device
889
890 CFG_JFFS_CUSTOM_PART
891 Define this to create an own partition. You have to provide a
892 function struct part_info* jffs2_part_info(int part_num)
893
894 If you define only one JFFS2 partition you may also want to
wdenkefe2a4d2004-12-16 21:44:03 +0000895 #define CFG_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +0000896 to disable the command chpart. This is the default when you
897 have not defined a custom partition
898
wdenkc6097192002-11-03 00:24:07 +0000899- Keyboard Support:
900 CONFIG_ISA_KEYBOARD
901
902 Define this to enable standard (PC-Style) keyboard
903 support
904
905 CONFIG_I8042_KBD
906 Standard PC keyboard driver with US (is default) and
907 GERMAN key layout (switch via environment 'keymap=de') support.
908 Export function i8042_kbd_init, i8042_tstc and i8042_getc
909 for cfb_console. Supports cursor blinking.
910
911- Video support:
912 CONFIG_VIDEO
913
914 Define this to enable video support (for output to
915 video).
916
917 CONFIG_VIDEO_CT69000
918
919 Enable Chips & Technologies 69000 Video chip
920
921 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +0000922 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +0000923 video output is selected via environment 'videoout'
924 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
925 assumed.
wdenkc6097192002-11-03 00:24:07 +0000926
wdenkb79a11c2004-03-25 15:14:43 +0000927 For the CT69000 and SMI_LYNXEM drivers, videomode is
928 selected via environment 'videomode'. Two diferent ways
wdenkeeb1b772004-03-23 22:53:55 +0000929 are possible:
930 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +0000931 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +0000932
933 Colors 640x480 800x600 1024x768 1152x864 1280x1024
934 -------------+---------------------------------------------
935 8 bits | 0x301* 0x303 0x305 0x161 0x307
936 15 bits | 0x310 0x313 0x316 0x162 0x319
937 16 bits | 0x311 0x314 0x317 0x163 0x31A
938 24 bits | 0x312 0x315 0x318 ? 0x31B
939 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +0000940 (i.e. setenv videomode 317; saveenv; reset;)
941
wdenkb79a11c2004-03-25 15:14:43 +0000942 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +0100943 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +0000944
945
stroesec1551ea2003-04-04 15:53:41 +0000946 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +0000947 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +0000948 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
949 or CONFIG_VIDEO_SED13806_16BPP
950
wdenk682011f2003-06-03 23:54:09 +0000951- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +0000952 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +0000953
wdenk8bde7f72003-06-27 21:31:46 +0000954 Define this to enable a custom keyboard support.
955 This simply calls drv_keyboard_init() which must be
956 defined in your board-specific files.
957 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +0000958
wdenkc6097192002-11-03 00:24:07 +0000959- LCD Support: CONFIG_LCD
960
961 Define this to enable LCD support (for output to LCD
962 display); also select one of the supported displays
963 by defining one of these:
964
wdenkfd3103b2003-11-25 16:55:19 +0000965 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +0000966
wdenkfd3103b2003-11-25 16:55:19 +0000967 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +0000968
wdenkfd3103b2003-11-25 16:55:19 +0000969 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +0000970
wdenkfd3103b2003-11-25 16:55:19 +0000971 NEC NL6448BC20-08. 6.5", 640x480.
972 Active, color, single scan.
973
974 CONFIG_NEC_NL6448BC33_54
975
976 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +0000977 Active, color, single scan.
978
979 CONFIG_SHARP_16x9
980
981 Sharp 320x240. Active, color, single scan.
982 It isn't 16x9, and I am not sure what it is.
983
984 CONFIG_SHARP_LQ64D341
985
986 Sharp LQ64D341 display, 640x480.
987 Active, color, single scan.
988
989 CONFIG_HLD1045
990
991 HLD1045 display, 640x480.
992 Active, color, single scan.
993
994 CONFIG_OPTREX_BW
995
996 Optrex CBL50840-2 NF-FW 99 22 M5
997 or
998 Hitachi LMG6912RPFC-00T
999 or
1000 Hitachi SP14Q002
1001
1002 320x240. Black & white.
1003
1004 Normally display is black on white background; define
1005 CFG_WHITE_ON_BLACK to get it inverted.
1006
wdenk7152b1d2003-09-05 23:19:14 +00001007- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001008
wdenk8bde7f72003-06-27 21:31:46 +00001009 If this option is set, the environment is checked for
1010 a variable "splashimage". If found, the usual display
1011 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001012 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001013 specified in "splashimage" is loaded instead. The
1014 console is redirected to the "nulldev", too. This
1015 allows for a "silent" boot where a splash screen is
1016 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001017
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001018- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1019
1020 If this option is set, additionally to standard BMP
1021 images, gzipped BMP images can be displayed via the
1022 splashscreen support or the bmp command.
1023
wdenkc29fdfc2003-08-29 20:57:53 +00001024- Compression support:
1025 CONFIG_BZIP2
1026
1027 If this option is set, support for bzip2 compressed
1028 images is included. If not, only uncompressed and gzip
1029 compressed images are supported.
1030
wdenk42d1f032003-10-15 23:53:47 +00001031 NOTE: the bzip2 algorithm requires a lot of RAM, so
1032 the malloc area (as defined by CFG_MALLOC_LEN) should
1033 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001034
wdenk17ea1172004-06-06 21:51:03 +00001035- MII/PHY support:
1036 CONFIG_PHY_ADDR
1037
1038 The address of PHY on MII bus.
1039
1040 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1041
1042 The clock frequency of the MII bus
1043
1044 CONFIG_PHY_GIGE
1045
1046 If this option is set, support for speed/duplex
1047 detection of Gigabit PHY is included.
1048
1049 CONFIG_PHY_RESET_DELAY
1050
1051 Some PHY like Intel LXT971A need extra delay after
1052 reset before any MII register access is possible.
1053 For such PHY, set this option to the usec delay
1054 required. (minimum 300usec for LXT971A)
1055
1056 CONFIG_PHY_CMD_DELAY (ppc4xx)
1057
1058 Some PHY like Intel LXT971A need extra delay after
1059 command issued before MII status register can be read
1060
wdenkc6097192002-11-03 00:24:07 +00001061- Ethernet address:
1062 CONFIG_ETHADDR
1063 CONFIG_ETH2ADDR
1064 CONFIG_ETH3ADDR
1065
1066 Define a default value for ethernet address to use
1067 for the respective ethernet interface, in case this
1068 is not determined automatically.
1069
1070- IP address:
1071 CONFIG_IPADDR
1072
1073 Define a default value for the IP address to use for
1074 the default ethernet interface, in case this is not
1075 determined through e.g. bootp.
1076
1077- Server IP address:
1078 CONFIG_SERVERIP
1079
1080 Defines a default value for theIP address of a TFTP
1081 server to contact when using the "tftboot" command.
1082
David Updegraff53a5c422007-06-11 10:41:07 -05001083- Multicast TFTP Mode:
1084 CONFIG_MCAST_TFTP
1085
1086 Defines whether you want to support multicast TFTP as per
1087 rfc-2090; for example to work with atftp. Lets lots of targets
1088 tftp down the same boot image concurrently. Note: the ethernet
1089 driver in use must provide a function: mcast() to join/leave a
1090 multicast group.
1091
1092 CONFIG_BOOTP_RANDOM_DELAY
wdenkc6097192002-11-03 00:24:07 +00001093- BOOTP Recovery Mode:
1094 CONFIG_BOOTP_RANDOM_DELAY
1095
1096 If you have many targets in a network that try to
1097 boot using BOOTP, you may want to avoid that all
1098 systems send out BOOTP requests at precisely the same
1099 moment (which would happen for instance at recovery
1100 from a power failure, when all systems will try to
1101 boot, thus flooding the BOOTP server. Defining
1102 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1103 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02001104 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001105
1106 1st BOOTP request: delay 0 ... 1 sec
1107 2nd BOOTP request: delay 0 ... 2 sec
1108 3rd BOOTP request: delay 0 ... 4 sec
1109 4th and following
1110 BOOTP requests: delay 0 ... 8 sec
1111
stroesefe389a82003-08-28 14:17:32 +00001112- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001113 You can fine tune the DHCP functionality by defining
1114 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00001115
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001116 CONFIG_BOOTP_SUBNETMASK
1117 CONFIG_BOOTP_GATEWAY
1118 CONFIG_BOOTP_HOSTNAME
1119 CONFIG_BOOTP_NISDOMAIN
1120 CONFIG_BOOTP_BOOTPATH
1121 CONFIG_BOOTP_BOOTFILESIZE
1122 CONFIG_BOOTP_DNS
1123 CONFIG_BOOTP_DNS2
1124 CONFIG_BOOTP_SEND_HOSTNAME
1125 CONFIG_BOOTP_NTPSERVER
1126 CONFIG_BOOTP_TIMEOFFSET
1127 CONFIG_BOOTP_VENDOREX
stroesefe389a82003-08-28 14:17:32 +00001128
Wilson Callan5d110f02007-07-28 10:56:13 -04001129 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1130 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00001131
1132 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1133 serverip from a DHCP server, it is possible that more
1134 than one DNS serverip is offered to the client.
1135 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1136 serverip will be stored in the additional environment
1137 variable "dnsip2". The first DNS serverip is always
1138 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001139 is defined.
stroesefe389a82003-08-28 14:17:32 +00001140
1141 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1142 to do a dynamic update of a DNS server. To do this, they
1143 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04001144 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001145 of the "hostname" environment variable is passed as
1146 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00001147
Aras Vaichasd9a2f412008-03-26 09:43:57 +11001148 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1149
1150 A 32bit value in microseconds for a delay between
1151 receiving a "DHCP Offer" and sending the "DHCP Request".
1152 This fixes a problem with certain DHCP servers that don't
1153 respond 100% of the time to a "DHCP request". E.g. On an
1154 AT91RM9200 processor running at 180MHz, this delay needed
1155 to be *at least* 15,000 usec before a Windows Server 2003
1156 DHCP server would reply 100% of the time. I recommend at
1157 least 50,000 usec to be safe. The alternative is to hope
1158 that one of the retries will be successful but note that
1159 the DHCP timeout and retry process takes a longer than
1160 this delay.
1161
wdenka3d991b2004-04-15 21:48:45 +00001162 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00001163 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00001164
1165 The device id used in CDP trigger frames.
1166
1167 CONFIG_CDP_DEVICE_ID_PREFIX
1168
1169 A two character string which is prefixed to the MAC address
1170 of the device.
1171
1172 CONFIG_CDP_PORT_ID
1173
1174 A printf format string which contains the ascii name of
1175 the port. Normally is set to "eth%d" which sets
1176 eth0 for the first ethernet, eth1 for the second etc.
1177
1178 CONFIG_CDP_CAPABILITIES
1179
1180 A 32bit integer which indicates the device capabilities;
1181 0x00000010 for a normal host which does not forwards.
1182
1183 CONFIG_CDP_VERSION
1184
1185 An ascii string containing the version of the software.
1186
1187 CONFIG_CDP_PLATFORM
1188
1189 An ascii string containing the name of the platform.
1190
1191 CONFIG_CDP_TRIGGER
1192
1193 A 32bit integer sent on the trigger.
1194
1195 CONFIG_CDP_POWER_CONSUMPTION
1196
1197 A 16bit integer containing the power consumption of the
1198 device in .1 of milliwatts.
1199
1200 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1201
1202 A byte containing the id of the VLAN.
1203
wdenkc6097192002-11-03 00:24:07 +00001204- Status LED: CONFIG_STATUS_LED
1205
1206 Several configurations allow to display the current
1207 status using a LED. For instance, the LED will blink
1208 fast while running U-Boot code, stop blinking as
1209 soon as a reply to a BOOTP request was received, and
1210 start blinking slow once the Linux kernel is running
1211 (supported by a status LED driver in the Linux
1212 kernel). Defining CONFIG_STATUS_LED enables this
1213 feature in U-Boot.
1214
1215- CAN Support: CONFIG_CAN_DRIVER
1216
1217 Defining CONFIG_CAN_DRIVER enables CAN driver support
1218 on those systems that support this (optional)
1219 feature, like the TQM8xxL modules.
1220
1221- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1222
wdenkb37c7e52003-06-30 16:24:52 +00001223 These enable I2C serial bus commands. Defining either of
wdenk945af8d2003-07-16 21:53:01 +00001224 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
1225 include the appropriate I2C driver for the selected cpu.
wdenkc6097192002-11-03 00:24:07 +00001226
wdenk945af8d2003-07-16 21:53:01 +00001227 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001228 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00001229 CONFIG_COMMANDS) and communicate with i2c based realtime
1230 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00001231 command line interface.
wdenkc6097192002-11-03 00:24:07 +00001232
Ben Warrenbb99ad62006-09-07 16:50:54 -04001233 CONFIG_I2C_CMD_TREE is a recommended option that places
1234 all I2C commands under a single 'i2c' root command. The
1235 older 'imm', 'imd', 'iprobe' etc. commands are considered
1236 deprecated and may disappear in the future.
1237
1238 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00001239
wdenk945af8d2003-07-16 21:53:01 +00001240 CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenkb37c7e52003-06-30 16:24:52 +00001241 bit-banging) driver instead of CPM or similar hardware
1242 support for I2C.
wdenkc6097192002-11-03 00:24:07 +00001243
wdenk945af8d2003-07-16 21:53:01 +00001244 There are several other quantities that must also be
wdenkb37c7e52003-06-30 16:24:52 +00001245 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenkc6097192002-11-03 00:24:07 +00001246
wdenkb37c7e52003-06-30 16:24:52 +00001247 In both cases you will need to define CFG_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00001248 to be the frequency (in Hz) at which you wish your i2c bus
1249 to run and CFG_I2C_SLAVE to be the address of this node (ie
1250 the cpu's i2c node address).
1251
wdenkb37c7e52003-06-30 16:24:52 +00001252 Now, the u-boot i2c code for the mpc8xx (cpu/mpc8xx/i2c.c)
1253 sets the cpu up as a master node and so its address should
1254 therefore be cleared to 0 (See, eg, MPC823e User's Manual
wdenk945af8d2003-07-16 21:53:01 +00001255 p.16-473). So, set CFG_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00001256
wdenk945af8d2003-07-16 21:53:01 +00001257 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00001258
1259 If you use the software i2c interface (CONFIG_SOFT_I2C)
1260 then the following macros need to be defined (examples are
1261 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001262
1263 I2C_INIT
1264
wdenkb37c7e52003-06-30 16:24:52 +00001265 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00001266 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001267
wdenkba56f622004-02-06 23:19:44 +00001268 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00001269
wdenkc6097192002-11-03 00:24:07 +00001270 I2C_PORT
1271
wdenk43d96162003-03-06 00:02:04 +00001272 (Only for MPC8260 CPU). The I/O port to use (the code
1273 assumes both bits are on the same port). Valid values
1274 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00001275
1276 I2C_ACTIVE
1277
1278 The code necessary to make the I2C data line active
1279 (driven). If the data line is open collector, this
1280 define can be null.
1281
wdenkb37c7e52003-06-30 16:24:52 +00001282 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1283
wdenkc6097192002-11-03 00:24:07 +00001284 I2C_TRISTATE
1285
1286 The code necessary to make the I2C data line tri-stated
1287 (inactive). If the data line is open collector, this
1288 define can be null.
1289
wdenkb37c7e52003-06-30 16:24:52 +00001290 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1291
wdenkc6097192002-11-03 00:24:07 +00001292 I2C_READ
1293
1294 Code that returns TRUE if the I2C data line is high,
1295 FALSE if it is low.
1296
wdenkb37c7e52003-06-30 16:24:52 +00001297 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1298
wdenkc6097192002-11-03 00:24:07 +00001299 I2C_SDA(bit)
1300
1301 If <bit> is TRUE, sets the I2C data line high. If it
1302 is FALSE, it clears it (low).
1303
wdenkb37c7e52003-06-30 16:24:52 +00001304 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00001305 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00001306 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00001307
wdenkc6097192002-11-03 00:24:07 +00001308 I2C_SCL(bit)
1309
1310 If <bit> is TRUE, sets the I2C clock line high. If it
1311 is FALSE, it clears it (low).
1312
wdenkb37c7e52003-06-30 16:24:52 +00001313 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00001314 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00001315 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00001316
wdenkc6097192002-11-03 00:24:07 +00001317 I2C_DELAY
1318
1319 This delay is invoked four times per clock cycle so this
1320 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00001321 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00001322 like:
1323
wdenkb37c7e52003-06-30 16:24:52 +00001324 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001325
wdenk47cd00f2003-03-06 13:39:27 +00001326 CFG_I2C_INIT_BOARD
1327
wdenk8bde7f72003-06-27 21:31:46 +00001328 When a board is reset during an i2c bus transfer
1329 chips might think that the current transfer is still
1330 in progress. On some boards it is possible to access
1331 the i2c SCLK line directly, either by using the
1332 processor pin as a GPIO or by having a second pin
1333 connected to the bus. If this option is defined a
1334 custom i2c_init_board() routine in boards/xxx/board.c
1335 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00001336
wdenk17ea1172004-06-06 21:51:03 +00001337 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
1338
1339 This option enables configuration of bi_iic_fast[] flags
1340 in u-boot bd_info structure based on u-boot environment
1341 variable "i2cfast". (see also i2cfast)
1342
Ben Warrenbb99ad62006-09-07 16:50:54 -04001343 CONFIG_I2C_MULTI_BUS
1344
1345 This option allows the use of multiple I2C buses, each of which
1346 must have a controller. At any point in time, only one bus is
1347 active. To switch to a different bus, use the 'i2c dev' command.
1348 Note that bus numbering is zero-based.
1349
1350 CFG_I2C_NOPROBES
1351
1352 This option specifies a list of I2C devices that will be skipped
1353 when the 'i2c probe' command is issued (or 'iprobe' using the legacy
1354 command). If CONFIG_I2C_MULTI_BUS is set, specify a list of bus-device
Wolfgang Denk218ca722008-03-26 10:40:12 +01001355 pairs. Otherwise, specify a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04001356
1357 e.g.
1358 #undef CONFIG_I2C_MULTI_BUS
1359 #define CFG_I2C_NOPROBES {0x50,0x68}
1360
1361 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1362
1363 #define CONFIG_I2C_MULTI_BUS
1364 #define CFG_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
1365
1366 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1367
Timur Tabibe5e6182006-11-03 19:15:00 -06001368 CFG_SPD_BUS_NUM
1369
1370 If defined, then this indicates the I2C bus number for DDR SPD.
1371 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1372
Stefan Roese0dc018e2007-02-20 10:51:26 +01001373 CFG_RTC_BUS_NUM
1374
1375 If defined, then this indicates the I2C bus number for the RTC.
1376 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1377
1378 CFG_DTT_BUS_NUM
1379
1380 If defined, then this indicates the I2C bus number for the DTT.
1381 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
1382
Timur Tabibe5e6182006-11-03 19:15:00 -06001383 CONFIG_FSL_I2C
1384
1385 Define this option if you want to use Freescale's I2C driver in
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001386 drivers/i2c/fsl_i2c.c.
Timur Tabibe5e6182006-11-03 19:15:00 -06001387
1388
wdenkc6097192002-11-03 00:24:07 +00001389- SPI Support: CONFIG_SPI
1390
1391 Enables SPI driver (so far only tested with
1392 SPI EEPROM, also an instance works with Crystal A/D and
1393 D/As on the SACSng board)
1394
1395 CONFIG_SPI_X
1396
1397 Enables extended (16-bit) SPI EEPROM addressing.
1398 (symmetrical to CONFIG_I2C_X)
1399
1400 CONFIG_SOFT_SPI
1401
wdenk43d96162003-03-06 00:02:04 +00001402 Enables a software (bit-bang) SPI driver rather than
1403 using hardware support. This is a general purpose
1404 driver that only requires three general I/O port pins
1405 (two outputs, one input) to function. If this is
1406 defined, the board configuration must define several
1407 SPI configuration items (port pins to use, etc). For
1408 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00001409
Ben Warren04a9e112008-01-16 22:37:35 -05001410 CONFIG_HARD_SPI
1411
1412 Enables a hardware SPI driver for general-purpose reads
1413 and writes. As with CONFIG_SOFT_SPI, the board configuration
1414 must define a list of chip-select function pointers.
1415 Currently supported on some MPC8xxx processors. For an
1416 example, see include/configs/mpc8349emds.h.
1417
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02001418 CONFIG_MXC_SPI
1419
1420 Enables the driver for the SPI controllers on i.MX and MXC
1421 SoCs. Currently only i.MX31 is supported.
1422
Matthias Fuchs01335022007-12-27 17:12:34 +01001423- FPGA Support: CONFIG_FPGA
1424
1425 Enables FPGA subsystem.
1426
1427 CONFIG_FPGA_<vendor>
1428
1429 Enables support for specific chip vendors.
1430 (ALTERA, XILINX)
1431
1432 CONFIG_FPGA_<family>
1433
1434 Enables support for FPGA family.
1435 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
1436
1437 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00001438
wdenk43d96162003-03-06 00:02:04 +00001439 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00001440
wdenk8bde7f72003-06-27 21:31:46 +00001441 CFG_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00001442
wdenk8bde7f72003-06-27 21:31:46 +00001443 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00001444
1445 CFG_FPGA_CHECK_BUSY
1446
wdenk43d96162003-03-06 00:02:04 +00001447 Enable checks on FPGA configuration interface busy
1448 status by the configuration function. This option
1449 will require a board or device specific function to
1450 be written.
wdenkc6097192002-11-03 00:24:07 +00001451
1452 CONFIG_FPGA_DELAY
1453
1454 If defined, a function that provides delays in the FPGA
1455 configuration driver.
1456
1457 CFG_FPGA_CHECK_CTRLC
1458 Allow Control-C to interrupt FPGA configuration
1459
1460 CFG_FPGA_CHECK_ERROR
1461
wdenk43d96162003-03-06 00:02:04 +00001462 Check for configuration errors during FPGA bitfile
1463 loading. For example, abort during Virtex II
1464 configuration if the INIT_B line goes low (which
1465 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00001466
1467 CFG_FPGA_WAIT_INIT
1468
wdenk43d96162003-03-06 00:02:04 +00001469 Maximum time to wait for the INIT_B line to deassert
1470 after PROB_B has been deasserted during a Virtex II
1471 FPGA configuration sequence. The default time is 500
1472 mS.
wdenkc6097192002-11-03 00:24:07 +00001473
1474 CFG_FPGA_WAIT_BUSY
1475
wdenk43d96162003-03-06 00:02:04 +00001476 Maximum time to wait for BUSY to deassert during
1477 Virtex II FPGA configuration. The default is 5 mS.
wdenkc6097192002-11-03 00:24:07 +00001478
1479 CFG_FPGA_WAIT_CONFIG
1480
wdenk43d96162003-03-06 00:02:04 +00001481 Time to wait after FPGA configuration. The default is
1482 200 mS.
wdenkc6097192002-11-03 00:24:07 +00001483
1484- Configuration Management:
1485 CONFIG_IDENT_STRING
1486
wdenk43d96162003-03-06 00:02:04 +00001487 If defined, this string will be added to the U-Boot
1488 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00001489
1490- Vendor Parameter Protection:
1491
wdenk43d96162003-03-06 00:02:04 +00001492 U-Boot considers the values of the environment
1493 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00001494 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00001495 are set once by the board vendor / manufacturer, and
1496 protects these variables from casual modification by
1497 the user. Once set, these variables are read-only,
1498 and write or delete attempts are rejected. You can
1499 change this behviour:
wdenkc6097192002-11-03 00:24:07 +00001500
1501 If CONFIG_ENV_OVERWRITE is #defined in your config
1502 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00001503 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00001504 these parameters.
1505
1506 Alternatively, if you #define _both_ CONFIG_ETHADDR
1507 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
1508 ethernet address is installed in the environment,
1509 which can be changed exactly ONCE by the user. [The
1510 serial# is unaffected by this, i. e. it remains
1511 read-only.]
1512
1513- Protected RAM:
1514 CONFIG_PRAM
1515
1516 Define this variable to enable the reservation of
1517 "protected RAM", i. e. RAM which is not overwritten
1518 by U-Boot. Define CONFIG_PRAM to hold the number of
1519 kB you want to reserve for pRAM. You can overwrite
1520 this default value by defining an environment
1521 variable "pram" to the number of kB you want to
1522 reserve. Note that the board info structure will
1523 still show the full amount of RAM. If pRAM is
1524 reserved, a new environment variable "mem" will
1525 automatically be defined to hold the amount of
1526 remaining RAM in a form that can be passed as boot
1527 argument to Linux, for instance like that:
1528
Wolfgang Denkfe126d82005-11-20 21:40:11 +01001529 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00001530 saveenv
1531
1532 This way you can tell Linux not to use this memory,
1533 either, which results in a memory region that will
1534 not be affected by reboots.
1535
1536 *WARNING* If your board configuration uses automatic
1537 detection of the RAM size, you must make sure that
1538 this memory test is non-destructive. So far, the
1539 following board configurations are known to be
1540 "pRAM-clean":
1541
1542 ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1543 HERMES, IP860, RPXlite, LWMON, LANTEC,
1544 PCU_E, FLAGADM, TQM8260
1545
1546- Error Recovery:
1547 CONFIG_PANIC_HANG
1548
1549 Define this variable to stop the system in case of a
1550 fatal error, so that you have to reset it manually.
1551 This is probably NOT a good idea for an embedded
1552 system where you want to system to reboot
1553 automatically as fast as possible, but it may be
1554 useful during development since you can try to debug
1555 the conditions that lead to the situation.
1556
1557 CONFIG_NET_RETRY_COUNT
1558
wdenk43d96162003-03-06 00:02:04 +00001559 This variable defines the number of retries for
1560 network operations like ARP, RARP, TFTP, or BOOTP
1561 before giving up the operation. If not defined, a
1562 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00001563
1564- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02001565 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00001566
1567 Enable auto completion of commands using TAB.
1568
Wolfgang Denka9398e02006-11-27 15:32:42 +01001569 Note that this feature has NOT been implemented yet
1570 for the "hush" shell.
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02001571
1572
wdenkc6097192002-11-03 00:24:07 +00001573 CFG_HUSH_PARSER
1574
1575 Define this variable to enable the "hush" shell (from
1576 Busybox) as command line interpreter, thus enabling
1577 powerful command line syntax like
1578 if...then...else...fi conditionals or `&&' and '||'
1579 constructs ("shell scripts").
1580
1581 If undefined, you get the old, much simpler behaviour
1582 with a somewhat smaller memory footprint.
1583
1584
1585 CFG_PROMPT_HUSH_PS2
1586
1587 This defines the secondary prompt string, which is
1588 printed when the command interpreter needs more input
1589 to complete a command. Usually "> ".
1590
1591 Note:
1592
wdenk8bde7f72003-06-27 21:31:46 +00001593 In the current implementation, the local variables
1594 space and global environment variables space are
1595 separated. Local variables are those you define by
1596 simply typing `name=value'. To access a local
1597 variable later on, you have write `$name' or
1598 `${name}'; to execute the contents of a variable
1599 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00001600
wdenk43d96162003-03-06 00:02:04 +00001601 Global environment variables are those you use
1602 setenv/printenv to work with. To run a command stored
1603 in such a variable, you need to use the run command,
1604 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00001605
1606 To store commands and special characters in a
1607 variable, please use double quotation marks
1608 surrounding the whole text of the variable, instead
1609 of the backslashes before semicolons and special
1610 symbols.
1611
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02001612- Commandline Editing and History:
1613 CONFIG_CMDLINE_EDITING
1614
Wolfgang Denkb9365a22006-07-21 11:56:05 +02001615 Enable editiong and History functions for interactive
1616 commandline input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02001617
wdenka8c7c702003-12-06 19:49:23 +00001618- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00001619 CONFIG_EXTRA_ENV_SETTINGS
1620
wdenk43d96162003-03-06 00:02:04 +00001621 Define this to contain any number of null terminated
1622 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00001623 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00001624
wdenk43d96162003-03-06 00:02:04 +00001625 For example, place something like this in your
1626 board's config file:
wdenkc6097192002-11-03 00:24:07 +00001627
1628 #define CONFIG_EXTRA_ENV_SETTINGS \
1629 "myvar1=value1\0" \
1630 "myvar2=value2\0"
1631
wdenk43d96162003-03-06 00:02:04 +00001632 Warning: This method is based on knowledge about the
1633 internal format how the environment is stored by the
1634 U-Boot code. This is NOT an official, exported
1635 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00001636 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00001637 You better know what you are doing here.
1638
wdenk43d96162003-03-06 00:02:04 +00001639 Note: overly (ab)use of the default environment is
1640 discouraged. Make sure to check other ways to preset
1641 the environment like the autoscript function or the
1642 boot command first.
wdenkc6097192002-11-03 00:24:07 +00001643
wdenka8c7c702003-12-06 19:49:23 +00001644- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00001645 CONFIG_HAS_DATAFLASH
1646
wdenk8bde7f72003-06-27 21:31:46 +00001647 Defining this option enables DataFlash features and
1648 allows to read/write in Dataflash via the standard
1649 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00001650
wdenk3f85ce22004-02-23 16:11:30 +00001651- SystemACE Support:
1652 CONFIG_SYSTEMACE
1653
1654 Adding this option adds support for Xilinx SystemACE
1655 chips attached via some sort of local bus. The address
1656 of the chip must alsh be defined in the
1657 CFG_SYSTEMACE_BASE macro. For example:
1658
1659 #define CONFIG_SYSTEMACE
1660 #define CFG_SYSTEMACE_BASE 0xf0000000
1661
1662 When SystemACE support is added, the "ace" device type
1663 becomes available to the fat commands, i.e. fatls.
1664
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001665- TFTP Fixed UDP Port:
1666 CONFIG_TFTP_PORT
1667
Wolfgang Denk28cb9372005-09-24 23:25:46 +02001668 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001669 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02001670 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001671 number generator is used.
1672
Wolfgang Denk28cb9372005-09-24 23:25:46 +02001673 Also, the environment variable tftpdstp is used to supply
1674 the TFTP UDP destination port value. If tftpdstp isn't
1675 defined, the normal port 69 is used.
1676
1677 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001678 blindly start the TFTP transfer using the pre-configured
1679 target IP address and UDP port. This has the effect of
1680 "punching through" the (Windows XP) firewall, allowing
1681 the remainder of the TFTP transfer to proceed normally.
1682 A better solution is to properly configure the firewall,
1683 but sometimes that is not allowed.
1684
wdenka8c7c702003-12-06 19:49:23 +00001685- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00001686 CONFIG_SHOW_BOOT_PROGRESS
1687
wdenk43d96162003-03-06 00:02:04 +00001688 Defining this option allows to add some board-
1689 specific code (calling a user-provided function
1690 "show_boot_progress(int)") that enables you to show
1691 the system's boot progress on some display (for
1692 example, some LED's) on your board. At the moment,
1693 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00001694
Marian Balakowicz1372cce2008-03-12 10:33:01 +01001695Legacy uImage format:
1696
wdenkc6097192002-11-03 00:24:07 +00001697 Arg Where When
1698 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00001699 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00001700 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00001701 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00001702 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00001703 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00001704 4 common/cmd_bootm.c Image data has correct checksum
1705 -4 common/cmd_bootm.c Image is for unsupported architecture
1706 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01001707 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00001708 6 common/cmd_bootm.c Image Type check OK
1709 -6 common/cmd_bootm.c gunzip uncompression error
1710 -7 common/cmd_bootm.c Unimplemented compression type
1711 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01001712 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00001713 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01001714
1715 9 common/image.c Start initial ramdisk verification
1716 -10 common/image.c Ramdisk header has bad magic number
1717 -11 common/image.c Ramdisk header has bad checksum
1718 10 common/image.c Ramdisk header is OK
1719 -12 common/image.c Ramdisk data has bad checksum
1720 11 common/image.c Ramdisk data has correct checksum
1721 12 common/image.c Ramdisk verification complete, start loading
1722 -13 common/image.c Wrong Image Type (not PPC Linux Ramdisk)
1723 13 common/image.c Start multifile image verification
1724 14 common/image.c No initial ramdisk, no multifile, continue.
1725
1726 15 lib_<arch>/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00001727
wdenk11dadd52004-02-27 00:07:27 +00001728 -30 lib_ppc/board.c Fatal error, hang the system
1729 -31 post/post.c POST test failed, detected by post_output_backlog()
1730 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00001731
Heiko Schocher566a4942007-06-22 19:11:54 +02001732 34 common/cmd_doc.c before loading a Image from a DOC device
1733 -35 common/cmd_doc.c Bad usage of "doc" command
1734 35 common/cmd_doc.c correct usage of "doc" command
1735 -36 common/cmd_doc.c No boot device
1736 36 common/cmd_doc.c correct boot device
1737 -37 common/cmd_doc.c Unknown Chip ID on boot device
1738 37 common/cmd_doc.c correct chip ID found, device available
1739 -38 common/cmd_doc.c Read Error on boot device
1740 38 common/cmd_doc.c reading Image header from DOC device OK
1741 -39 common/cmd_doc.c Image header has bad magic number
1742 39 common/cmd_doc.c Image header has correct magic number
1743 -40 common/cmd_doc.c Error reading Image from DOC device
1744 40 common/cmd_doc.c Image header has correct magic number
1745 41 common/cmd_ide.c before loading a Image from a IDE device
1746 -42 common/cmd_ide.c Bad usage of "ide" command
1747 42 common/cmd_ide.c correct usage of "ide" command
1748 -43 common/cmd_ide.c No boot device
1749 43 common/cmd_ide.c boot device found
1750 -44 common/cmd_ide.c Device not available
1751 44 common/cmd_ide.c Device available
1752 -45 common/cmd_ide.c wrong partition selected
1753 45 common/cmd_ide.c partition selected
1754 -46 common/cmd_ide.c Unknown partition table
1755 46 common/cmd_ide.c valid partition table found
1756 -47 common/cmd_ide.c Invalid partition type
1757 47 common/cmd_ide.c correct partition type
1758 -48 common/cmd_ide.c Error reading Image Header on boot device
1759 48 common/cmd_ide.c reading Image Header from IDE device OK
1760 -49 common/cmd_ide.c Image header has bad magic number
1761 49 common/cmd_ide.c Image header has correct magic number
1762 -50 common/cmd_ide.c Image header has bad checksum
1763 50 common/cmd_ide.c Image header has correct checksum
1764 -51 common/cmd_ide.c Error reading Image from IDE device
1765 51 common/cmd_ide.c reading Image from IDE device OK
1766 52 common/cmd_nand.c before loading a Image from a NAND device
1767 -53 common/cmd_nand.c Bad usage of "nand" command
1768 53 common/cmd_nand.c correct usage of "nand" command
1769 -54 common/cmd_nand.c No boot device
1770 54 common/cmd_nand.c boot device found
1771 -55 common/cmd_nand.c Unknown Chip ID on boot device
1772 55 common/cmd_nand.c correct chip ID found, device available
1773 -56 common/cmd_nand.c Error reading Image Header on boot device
1774 56 common/cmd_nand.c reading Image Header from NAND device OK
1775 -57 common/cmd_nand.c Image header has bad magic number
1776 57 common/cmd_nand.c Image header has correct magic number
1777 -58 common/cmd_nand.c Error reading Image from NAND device
1778 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00001779
Heiko Schocher566a4942007-06-22 19:11:54 +02001780 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00001781
Heiko Schocher566a4942007-06-22 19:11:54 +02001782 64 net/eth.c starting with Ethernetconfiguration.
1783 -64 net/eth.c no Ethernet found.
1784 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00001785
Heiko Schocher566a4942007-06-22 19:11:54 +02001786 -80 common/cmd_net.c usage wrong
1787 80 common/cmd_net.c before calling NetLoop()
1788 -81 common/cmd_net.c some error in NetLoop() occured
1789 81 common/cmd_net.c NetLoop() back without error
1790 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
1791 82 common/cmd_net.c trying automatic boot
1792 83 common/cmd_net.c running autoscript
1793 -83 common/cmd_net.c some error in automatic boot or autoscript
1794 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00001795
Marian Balakowicz1372cce2008-03-12 10:33:01 +01001796FIT uImage format:
1797
1798 Arg Where When
1799 100 common/cmd_bootm.c Kernel FIT Image has correct format
1800 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
1801 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
1802 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
1803 102 common/cmd_bootm.c Kernel unit name specified
1804 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01001805 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01001806 104 common/cmd_bootm.c Got kernel subimage node offset
1807 -104 common/cmd_bootm.c Kernel subimage hash verification failed
1808 105 common/cmd_bootm.c Kernel subimage hash verification OK
1809 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
1810 106 common/cmd_bootm.c Architecture check OK
1811 -106 common/cmd_bootm.c Kernel subimage has wrong typea
1812 107 common/cmd_bootm.c Kernel subimge type OK
1813 -107 common/cmd_bootm.c Can't get kernel subimage data/size
1814 108 common/cmd_bootm.c Got kernel subimage data/size
1815 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
1816 -109 common/cmd_bootm.c Can't get kernel subimage type
1817 -110 common/cmd_bootm.c Can't get kernel subimage comp
1818 -111 common/cmd_bootm.c Can't get kernel subimage os
1819 -112 common/cmd_bootm.c Can't get kernel subimage load address
1820 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
1821
1822 120 common/image.c Start initial ramdisk verification
1823 -120 common/image.c Ramdisk FIT image has incorrect format
1824 121 common/image.c Ramdisk FIT image has correct format
1825 122 common/image.c No Ramdisk subimage unit name, using configuration
1826 -122 common/image.c Can't get configuration for ramdisk subimage
1827 123 common/image.c Ramdisk unit name specified
1828 -124 common/image.c Can't get ramdisk subimage node offset
1829 125 common/image.c Got ramdisk subimage node offset
1830 -125 common/image.c Ramdisk subimage hash verification failed
1831 126 common/image.c Ramdisk subimage hash verification OK
1832 -126 common/image.c Ramdisk subimage for unsupported architecture
1833 127 common/image.c Architecture check OK
1834 -127 common/image.c Can't get ramdisk subimage data/size
1835 128 common/image.c Got ramdisk subimage data/size
1836 129 common/image.c Can't get ramdisk load address
1837 -129 common/image.c Got ramdisk load address
1838
1839 -130 common/cmd_doc.c Icorrect FIT image format
1840 131 common/cmd_doc.c FIT image format OK
1841
1842 -140 common/cmd_ide.c Icorrect FIT image format
1843 141 common/cmd_ide.c FIT image format OK
1844
1845 -150 common/cmd_nand.c Icorrect FIT image format
1846 151 common/cmd_nand.c FIT image format OK
1847
1848
wdenkc6097192002-11-03 00:24:07 +00001849Modem Support:
1850--------------
1851
wdenk85ec0bc2003-03-31 16:34:49 +00001852[so far only for SMDK2400 and TRAB boards]
wdenkc6097192002-11-03 00:24:07 +00001853
1854- Modem support endable:
1855 CONFIG_MODEM_SUPPORT
1856
1857- RTS/CTS Flow control enable:
1858 CONFIG_HWFLOW
1859
1860- Modem debug support:
1861 CONFIG_MODEM_SUPPORT_DEBUG
1862
wdenk43d96162003-03-06 00:02:04 +00001863 Enables debugging stuff (char screen[1024], dbg())
1864 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00001865
wdenka8c7c702003-12-06 19:49:23 +00001866- Interrupt support (PPC):
1867
wdenkd4ca31c2004-01-02 14:00:00 +00001868 There are common interrupt_init() and timer_interrupt()
1869 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
1870 for cpu specific initialization. interrupt_init_cpu()
1871 should set decrementer_count to appropriate value. If
1872 cpu resets decrementer automatically after interrupt
1873 (ppc4xx) it should set decrementer_count to zero.
1874 timer_interrupt() calls timer_interrupt_cpu() for cpu
1875 specific handling. If board has watchdog / status_led
1876 / other_activity_monitor it works automatically from
1877 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00001878
wdenkc6097192002-11-03 00:24:07 +00001879- General:
1880
wdenk43d96162003-03-06 00:02:04 +00001881 In the target system modem support is enabled when a
1882 specific key (key combination) is pressed during
1883 power-on. Otherwise U-Boot will boot normally
1884 (autoboot). The key_pressed() fuction is called from
1885 board_init(). Currently key_pressed() is a dummy
1886 function, returning 1 and thus enabling modem
1887 initialization.
wdenkc6097192002-11-03 00:24:07 +00001888
wdenk43d96162003-03-06 00:02:04 +00001889 If there are no modem init strings in the
1890 environment, U-Boot proceed to autoboot; the
1891 previous output (banner, info printfs) will be
1892 supressed, though.
wdenkc6097192002-11-03 00:24:07 +00001893
1894 See also: doc/README.Modem
1895
1896
wdenkc6097192002-11-03 00:24:07 +00001897Configuration Settings:
1898-----------------------
1899
1900- CFG_LONGHELP: Defined when you want long help messages included;
1901 undefine this when you're short of memory.
1902
1903- CFG_PROMPT: This is what U-Boot prints on the console to
1904 prompt for user input.
1905
1906- CFG_CBSIZE: Buffer size for input from the Console
1907
1908- CFG_PBSIZE: Buffer size for Console output
1909
1910- CFG_MAXARGS: max. Number of arguments accepted for monitor commands
1911
1912- CFG_BARGSIZE: Buffer size for Boot Arguments which are passed to
1913 the application (usually a Linux kernel) when it is
1914 booted
1915
1916- CFG_BAUDRATE_TABLE:
1917 List of legal baudrate settings for this board.
1918
1919- CFG_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00001920 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00001921
1922- CFG_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00001923 If the board specific function
1924 extern int overwrite_console (void);
1925 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00001926 serial port, else the settings in the environment are used.
1927
1928- CFG_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00001929 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00001930
1931- CFG_CONSOLE_ENV_OVERWRITE
1932 Enable overwrite of previous console environment settings.
1933
1934- CFG_MEMTEST_START, CFG_MEMTEST_END:
1935 Begin and End addresses of the area used by the
1936 simple memory test.
1937
1938- CFG_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00001939 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00001940
wdenk5f535fe2003-09-18 09:21:33 +00001941- CFG_MEMTEST_SCRATCH:
1942 Scratch address used by the alternate memory test
1943 You only need to set this if address zero isn't writeable
1944
Stefan Roese14f73ca2008-03-26 10:14:11 +01001945- CFG_MEM_TOP_HIDE (PPC only):
1946 If CFG_MEM_TOP_HIDE is defined in the board config header,
1947 this specified memory area will get subtracted from the top
1948 (end) of ram and won't get "touched" at all by U-Boot. By
1949 fixing up gd->ram_size the Linux kernel should gets passed
1950 the now "corrected" memory size and won't touch it either.
1951 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01001952 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01001953 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01001954 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01001955
1956 This option can be used as a workaround for the 440EPx/GRx
1957 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
1958 be touched.
1959
1960 WARNING: Please make sure that this value is a multiple of
1961 the Linux page size (normally 4k). If this is not the case,
1962 then the end address of the Linux memory will be located at a
1963 non page size aligned address and this could cause major
1964 problems.
1965
wdenkc6097192002-11-03 00:24:07 +00001966- CFG_TFTP_LOADADDR:
1967 Default load address for network file downloads
1968
1969- CFG_LOADS_BAUD_CHANGE:
1970 Enable temporary baudrate change while serial download
1971
1972- CFG_SDRAM_BASE:
1973 Physical start address of SDRAM. _Must_ be 0 here.
1974
1975- CFG_MBIO_BASE:
1976 Physical start address of Motherboard I/O (if using a
1977 Cogent motherboard)
1978
1979- CFG_FLASH_BASE:
1980 Physical start address of Flash memory.
1981
1982- CFG_MONITOR_BASE:
1983 Physical start address of boot monitor code (set by
1984 make config files to be same as the text base address
1985 (TEXT_BASE) used when linking) - same as
1986 CFG_FLASH_BASE when booting from flash.
1987
1988- CFG_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00001989 Size of memory reserved for monitor code, used to
1990 determine _at_compile_time_ (!) if the environment is
1991 embedded within the U-Boot image, or in a separate
1992 flash sector.
wdenkc6097192002-11-03 00:24:07 +00001993
1994- CFG_MALLOC_LEN:
1995 Size of DRAM reserved for malloc() use.
1996
Stefan Roese15940c92006-03-13 11:16:36 +01001997- CFG_BOOTM_LEN:
1998 Normally compressed uImages are limited to an
1999 uncompressed size of 8 MBytes. If this is not enough,
2000 you can define CFG_BOOTM_LEN in your board config file
2001 to adjust this setting to your needs.
2002
wdenkc6097192002-11-03 00:24:07 +00002003- CFG_BOOTMAPSZ:
2004 Maximum size of memory mapped by the startup code of
2005 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02002006 the Linux kernel (bd_info, boot arguments, FDT blob if
2007 used) must be put below this limit, unless "bootm_low"
2008 enviroment variable is defined and non-zero. In such case
2009 all data for the Linux kernel must be between "bootm_low"
2010 and "bootm_low" + CFG_BOOTMAPSZ.
wdenkc6097192002-11-03 00:24:07 +00002011
2012- CFG_MAX_FLASH_BANKS:
2013 Max number of Flash memory banks
2014
2015- CFG_MAX_FLASH_SECT:
2016 Max number of sectors on a Flash chip
2017
2018- CFG_FLASH_ERASE_TOUT:
2019 Timeout for Flash erase operations (in ms)
2020
2021- CFG_FLASH_WRITE_TOUT:
2022 Timeout for Flash write operations (in ms)
2023
wdenk8564acf2003-07-14 22:13:32 +00002024- CFG_FLASH_LOCK_TOUT
2025 Timeout for Flash set sector lock bit operation (in ms)
2026
2027- CFG_FLASH_UNLOCK_TOUT
2028 Timeout for Flash clear lock bits operation (in ms)
2029
2030- CFG_FLASH_PROTECTION
2031 If defined, hardware flash sectors protection is used
2032 instead of U-Boot software protection.
2033
wdenkc6097192002-11-03 00:24:07 +00002034- CFG_DIRECT_FLASH_TFTP:
2035
2036 Enable TFTP transfers directly to flash memory;
2037 without this option such a download has to be
2038 performed in two steps: (1) download to RAM, and (2)
2039 copy from RAM to flash.
2040
2041 The two-step approach is usually more reliable, since
2042 you can check if the download worked before you erase
2043 the flash, but in some situations (when sytem RAM is
2044 too limited to allow for a tempory copy of the
2045 downloaded image) this option may be very useful.
2046
2047- CFG_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00002048 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00002049 common flash structure for storing flash geometry.
2050
2051- CFG_FLASH_CFI_DRIVER
2052 This option also enables the building of the cfi_flash driver
2053 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00002054
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02002055- CFG_FLASH_USE_BUFFER_WRITE
2056 Use buffered writes to flash.
2057
2058- CONFIG_FLASH_SPANSION_S29WS_N
2059 s29ws-n MirrorBit flash has non-standard addresses for buffered
2060 write commands.
2061
Stefan Roese5568e612005-11-22 13:20:42 +01002062- CFG_FLASH_QUIET_TEST
2063 If this option is defined, the common CFI flash doesn't
2064 print it's warning upon not recognized FLASH banks. This
2065 is useful, if some of the configured banks are only
2066 optionally available.
2067
Jerry Van Baren9a042e92008-03-08 13:48:01 -05002068- CONFIG_FLASH_SHOW_PROGRESS
2069 If defined (must be an integer), print out countdown
2070 digits and dots. Recommended value: 45 (9..1) for 80
2071 column displays, 15 (3..1) for 40 column displays.
2072
stroese53cf9432003-06-05 15:39:44 +00002073- CFG_RX_ETH_BUFFER:
2074 Defines the number of ethernet receive buffers. On some
2075 ethernet controllers it is recommended to set this value
2076 to 8 or even higher (EEPRO100 or 405 EMAC), since all
2077 buffers can be full shortly after enabling the interface
2078 on high ethernet traffic.
2079 Defaults to 4 if not defined.
2080
wdenkc6097192002-11-03 00:24:07 +00002081The following definitions that deal with the placement and management
2082of environment data (variable area); in general, we support the
2083following configurations:
2084
2085- CFG_ENV_IS_IN_FLASH:
2086
2087 Define this if the environment is in flash memory.
2088
2089 a) The environment occupies one whole flash sector, which is
2090 "embedded" in the text segment with the U-Boot code. This
2091 happens usually with "bottom boot sector" or "top boot
2092 sector" type flash chips, which have several smaller
2093 sectors at the start or the end. For instance, such a
2094 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
2095 such a case you would place the environment in one of the
2096 4 kB sectors - with U-Boot code before and after it. With
2097 "top boot sector" type flash chips, you would put the
2098 environment in one of the last sectors, leaving a gap
2099 between U-Boot and the environment.
2100
2101 - CFG_ENV_OFFSET:
2102
2103 Offset of environment data (variable area) to the
2104 beginning of flash memory; for instance, with bottom boot
2105 type flash chips the second sector can be used: the offset
2106 for this sector is given here.
2107
2108 CFG_ENV_OFFSET is used relative to CFG_FLASH_BASE.
2109
2110 - CFG_ENV_ADDR:
2111
2112 This is just another way to specify the start address of
2113 the flash sector containing the environment (instead of
2114 CFG_ENV_OFFSET).
2115
2116 - CFG_ENV_SECT_SIZE:
2117
2118 Size of the sector containing the environment.
2119
2120
2121 b) Sometimes flash chips have few, equal sized, BIG sectors.
2122 In such a case you don't want to spend a whole sector for
2123 the environment.
2124
2125 - CFG_ENV_SIZE:
2126
2127 If you use this in combination with CFG_ENV_IS_IN_FLASH
2128 and CFG_ENV_SECT_SIZE, you can specify to use only a part
2129 of this flash sector for the environment. This saves
2130 memory for the RAM copy of the environment.
2131
2132 It may also save flash memory if you decide to use this
2133 when your environment is "embedded" within U-Boot code,
2134 since then the remainder of the flash sector could be used
2135 for U-Boot code. It should be pointed out that this is
2136 STRONGLY DISCOURAGED from a robustness point of view:
2137 updating the environment in flash makes it always
2138 necessary to erase the WHOLE sector. If something goes
2139 wrong before the contents has been restored from a copy in
2140 RAM, your target system will be dead.
2141
2142 - CFG_ENV_ADDR_REDUND
2143 CFG_ENV_SIZE_REDUND
2144
wdenk43d96162003-03-06 00:02:04 +00002145 These settings describe a second storage area used to hold
2146 a redundand copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00002147 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00002148 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00002149
2150BE CAREFUL! Any changes to the flash layout, and some changes to the
2151source code will make it necessary to adapt <board>/u-boot.lds*
2152accordingly!
2153
2154
2155- CFG_ENV_IS_IN_NVRAM:
2156
2157 Define this if you have some non-volatile memory device
2158 (NVRAM, battery buffered SRAM) which you want to use for the
2159 environment.
2160
2161 - CFG_ENV_ADDR:
2162 - CFG_ENV_SIZE:
2163
2164 These two #defines are used to determin the memory area you
2165 want to use for environment. It is assumed that this memory
2166 can just be read and written to, without any special
2167 provision.
2168
2169BE CAREFUL! The first access to the environment happens quite early
2170in U-Boot initalization (when we try to get the setting of for the
2171console baudrate). You *MUST* have mappend your NVRAM area then, or
2172U-Boot will hang.
2173
2174Please note that even with NVRAM we still use a copy of the
2175environment in RAM: we could work on NVRAM directly, but we want to
2176keep settings there always unmodified except somebody uses "saveenv"
2177to save the current settings.
2178
2179
2180- CFG_ENV_IS_IN_EEPROM:
2181
2182 Use this if you have an EEPROM or similar serial access
2183 device and a driver for it.
2184
2185 - CFG_ENV_OFFSET:
2186 - CFG_ENV_SIZE:
2187
2188 These two #defines specify the offset and size of the
2189 environment area within the total memory of your EEPROM.
2190
2191 - CFG_I2C_EEPROM_ADDR:
2192 If defined, specified the chip address of the EEPROM device.
2193 The default address is zero.
2194
2195 - CFG_EEPROM_PAGE_WRITE_BITS:
2196 If defined, the number of bits used to address bytes in a
2197 single page in the EEPROM device. A 64 byte page, for example
2198 would require six bits.
2199
2200 - CFG_EEPROM_PAGE_WRITE_DELAY_MS:
2201 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00002202 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00002203
2204 - CFG_I2C_EEPROM_ADDR_LEN:
2205 The length in bytes of the EEPROM memory array address. Note
2206 that this is NOT the chip address length!
2207
wdenk5cf91d62004-04-23 20:32:05 +00002208 - CFG_I2C_EEPROM_ADDR_OVERFLOW:
2209 EEPROM chips that implement "address overflow" are ones
2210 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
2211 address and the extra bits end up in the "chip address" bit
2212 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
2213 byte chips.
2214
2215 Note that we consider the length of the address field to
2216 still be one byte because the extra address bits are hidden
2217 in the chip address.
2218
wdenkc6097192002-11-03 00:24:07 +00002219 - CFG_EEPROM_SIZE:
2220 The size in bytes of the EEPROM device.
2221
wdenkc6097192002-11-03 00:24:07 +00002222
wdenk5779d8d2003-12-06 23:55:10 +00002223- CFG_ENV_IS_IN_DATAFLASH:
2224
wdenkd4ca31c2004-01-02 14:00:00 +00002225 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00002226 want to use for the environment.
2227
2228 - CFG_ENV_OFFSET:
2229 - CFG_ENV_ADDR:
2230 - CFG_ENV_SIZE:
2231
2232 These three #defines specify the offset and size of the
2233 environment area within the total memory of your DataFlash placed
2234 at the specified address.
2235
wdenk13a56952004-06-09 14:58:14 +00002236- CFG_ENV_IS_IN_NAND:
2237
2238 Define this if you have a NAND device which you want to use
2239 for the environment.
2240
2241 - CFG_ENV_OFFSET:
2242 - CFG_ENV_SIZE:
2243
2244 These two #defines specify the offset and size of the environment
2245 area within the first NAND device.
wdenk5779d8d2003-12-06 23:55:10 +00002246
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002247 - CFG_ENV_OFFSET_REDUND
2248
2249 This setting describes a second storage area of CFG_ENV_SIZE
2250 size used to hold a redundant copy of the environment data,
2251 so that there is a valid backup copy in case there is a
2252 power failure during a "saveenv" operation.
2253
2254 Note: CFG_ENV_OFFSET and CFG_ENV_OFFSET_REDUND must be aligned
2255 to a block boundary, and CFG_ENV_SIZE must be a multiple of
2256 the NAND devices block size.
2257
wdenkc6097192002-11-03 00:24:07 +00002258- CFG_SPI_INIT_OFFSET
2259
2260 Defines offset to the initial SPI buffer area in DPRAM. The
2261 area is used at an early stage (ROM part) if the environment
2262 is configured to reside in the SPI EEPROM: We need a 520 byte
2263 scratch DPRAM area. It is used between the two initialization
2264 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
2265 to be a good choice since it makes it far enough from the
2266 start of the data area as well as from the stack pointer.
2267
Bruce Adlere881cb52007-11-02 13:15:42 -07002268Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00002269has been relocated to RAM and a RAM copy of the environment has been
2270created; also, when using EEPROM you will have to use getenv_r()
2271until then to read environment variables.
2272
wdenk85ec0bc2003-03-31 16:34:49 +00002273The environment is protected by a CRC32 checksum. Before the monitor
2274is relocated into RAM, as a result of a bad CRC you will be working
2275with the compiled-in default environment - *silently*!!! [This is
2276necessary, because the first environment variable we need is the
2277"baudrate" setting for the console - if we have a bad CRC, we don't
2278have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00002279
2280Note: once the monitor has been relocated, then it will complain if
2281the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00002282use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00002283
wdenkfc3e2162003-10-08 22:33:00 +00002284- CFG_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00002285 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00002286
2287 Note: If this option is active, then CFG_FAULT_MII_ADDR
2288 also needs to be defined.
2289
2290- CFG_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00002291 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00002292
wdenkc40b2952004-03-13 23:29:43 +00002293- CFG_64BIT_VSPRINTF:
2294 Makes vsprintf (and all *printf functions) support printing
2295 of 64bit values by using the L quantifier
2296
2297- CFG_64BIT_STRTOUL:
2298 Adds simple_strtoull that returns a 64bit value
2299
wdenkc6097192002-11-03 00:24:07 +00002300Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00002301---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00002302
2303- CFG_CACHELINE_SIZE:
2304 Cache Line Size of the CPU.
2305
2306- CFG_DEFAULT_IMMR:
2307 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00002308
wdenk42d1f032003-10-15 23:53:47 +00002309 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
2310 and RPXsuper) to be able to adjust the position of
2311 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00002312
wdenk7f6c2cb2002-11-10 22:06:23 +00002313- Floppy Disk Support:
2314 CFG_FDC_DRIVE_NUMBER
2315
2316 the default drive number (default value 0)
2317
2318 CFG_ISA_IO_STRIDE
2319
2320 defines the spacing between fdc chipset registers
2321 (default value 1)
2322
2323 CFG_ISA_IO_OFFSET
2324
wdenk43d96162003-03-06 00:02:04 +00002325 defines the offset of register from address. It
2326 depends on which part of the data bus is connected to
2327 the fdc chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00002328
wdenk43d96162003-03-06 00:02:04 +00002329 If CFG_ISA_IO_STRIDE CFG_ISA_IO_OFFSET and
2330 CFG_FDC_DRIVE_NUMBER are undefined, they take their
2331 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00002332
wdenk43d96162003-03-06 00:02:04 +00002333 if CFG_FDC_HW_INIT is defined, then the function
2334 fdc_hw_init() is called at the beginning of the FDC
2335 setup. fdc_hw_init() must be provided by the board
2336 source code. It is used to make hardware dependant
2337 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00002338
wdenk25d67122004-12-10 11:40:40 +00002339- CFG_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00002340 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00002341 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00002342
2343- CFG_INIT_RAM_ADDR:
2344
wdenk7152b1d2003-09-05 23:19:14 +00002345 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00002346 initial data and stack; please note that this must be
2347 writable memory that is working WITHOUT special
2348 initialization, i. e. you CANNOT use normal RAM which
2349 will become available only after programming the
2350 memory controller and running certain initialization
2351 sequences.
2352
2353 U-Boot uses the following memory types:
2354 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
2355 - MPC824X: data cache
2356 - PPC4xx: data cache
2357
wdenk85ec0bc2003-03-31 16:34:49 +00002358- CFG_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002359
2360 Offset of the initial data structure in the memory
2361 area defined by CFG_INIT_RAM_ADDR. Usually
wdenk85ec0bc2003-03-31 16:34:49 +00002362 CFG_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00002363 data is located at the end of the available space
2364 (sometimes written as (CFG_INIT_RAM_END -
2365 CFG_INIT_DATA_SIZE), and the initial stack is just
2366 below that area (growing from (CFG_INIT_RAM_ADDR +
wdenk85ec0bc2003-03-31 16:34:49 +00002367 CFG_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00002368
2369 Note:
2370 On the MPC824X (or other systems that use the data
2371 cache for initial memory) the address chosen for
2372 CFG_INIT_RAM_ADDR is basically arbitrary - it must
2373 point to an otherwise UNUSED address space between
2374 the top of RAM and the start of the PCI space.
2375
2376- CFG_SIUMCR: SIU Module Configuration (11-6)
2377
2378- CFG_SYPCR: System Protection Control (11-9)
2379
2380- CFG_TBSCR: Time Base Status and Control (11-26)
2381
2382- CFG_PISCR: Periodic Interrupt Status and Control (11-31)
2383
2384- CFG_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
2385
2386- CFG_SCCR: System Clock and reset Control Register (15-27)
2387
2388- CFG_OR_TIMING_SDRAM:
2389 SDRAM timing
2390
2391- CFG_MAMR_PTA:
2392 periodic timer for refresh
2393
2394- CFG_DER: Debug Event Register (37-47)
2395
2396- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CFG_REMAP_OR_AM,
2397 CFG_PRELIM_OR_AM, CFG_OR_TIMING_FLASH, CFG_OR0_REMAP,
2398 CFG_OR0_PRELIM, CFG_BR0_PRELIM, CFG_OR1_REMAP, CFG_OR1_PRELIM,
2399 CFG_BR1_PRELIM:
2400 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
2401
2402- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
2403 CFG_OR_TIMING_SDRAM, CFG_OR2_PRELIM, CFG_BR2_PRELIM,
2404 CFG_OR3_PRELIM, CFG_BR3_PRELIM:
2405 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
2406
2407- CFG_MAMR_PTA, CFG_MPTPR_2BK_4K, CFG_MPTPR_1BK_4K, CFG_MPTPR_2BK_8K,
2408 CFG_MPTPR_1BK_8K, CFG_MAMR_8COL, CFG_MAMR_9COL:
2409 Machine Mode Register and Memory Periodic Timer
2410 Prescaler definitions (SDRAM timing)
2411
2412- CFG_I2C_UCODE_PATCH, CFG_I2C_DPMEM_OFFSET [0x1FC0]:
2413 enable I2C microcode relocation patch (MPC8xx);
2414 define relocation offset in DPRAM [DSP2]
2415
Heiko Schocherb423d052008-01-11 01:12:07 +01002416- CFG_SMC_UCODE_PATCH, CFG_SMC_DPMEM_OFFSET [0x1FC0]:
2417 enable SMC microcode relocation patch (MPC8xx);
2418 define relocation offset in DPRAM [SMC1]
2419
wdenkc6097192002-11-03 00:24:07 +00002420- CFG_SPI_UCODE_PATCH, CFG_SPI_DPMEM_OFFSET [0x1FC0]:
2421 enable SPI microcode relocation patch (MPC8xx);
2422 define relocation offset in DPRAM [SCC4]
2423
2424- CFG_USE_OSCCLK:
2425 Use OSCM clock mode on MBX8xx board. Be careful,
2426 wrong setting might damage your board. Read
2427 doc/README.MBX before setting this variable!
2428
wdenkea909b72002-11-21 23:11:29 +00002429- CFG_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00002430 Offset of the bootmode word in DPRAM used by post
2431 (Power On Self Tests). This definition overrides
2432 #define'd default value in commproc.h resp.
2433 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00002434
stroese1d49b1f2003-05-23 11:39:05 +00002435- CFG_PCI_SLV_MEM_LOCAL, CFG_PCI_SLV_MEM_BUS, CFG_PICMR0_MASK_ATTRIB,
2436 CFG_PCI_MSTR0_LOCAL, CFG_PCIMSK0_MASK, CFG_PCI_MSTR1_LOCAL,
2437 CFG_PCIMSK1_MASK, CFG_PCI_MSTR_MEM_LOCAL, CFG_PCI_MSTR_MEM_BUS,
2438 CFG_CPU_PCI_MEM_START, CFG_PCI_MSTR_MEM_SIZE, CFG_POCMR0_MASK_ATTRIB,
2439 CFG_PCI_MSTR_MEMIO_LOCAL, CFG_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
2440 CFG_PCI_MSTR_MEMIO_SIZE, CFG_POCMR1_MASK_ATTRIB, CFG_PCI_MSTR_IO_LOCAL,
2441 CFG_PCI_MSTR_IO_BUS, CFG_CPU_PCI_IO_START, CFG_PCI_MSTR_IO_SIZE,
wdenk5d232d02003-05-22 22:52:13 +00002442 CFG_POCMR2_MASK_ATTRIB: (MPC826x only)
2443 Overrides the default PCI memory map in cpu/mpc8260/pci.c if set.
2444
Ben Warrenbb99ad62006-09-07 16:50:54 -04002445- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01002446 Get DDR timing information from an I2C EEPROM. Common
2447 with pluggable memory modules such as SODIMMs
2448
Ben Warrenbb99ad62006-09-07 16:50:54 -04002449 SPD_EEPROM_ADDRESS
2450 I2C address of the SPD EEPROM
2451
2452- CFG_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01002453 If SPD EEPROM is on an I2C bus other than the first
2454 one, specify here. Note that the value must resolve
2455 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04002456
Timur Tabi2ad6b512006-10-31 18:44:42 -06002457- CFG_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01002458 Only for 83xx systems. If specified, then DDR should
2459 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06002460
2461- CFG_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01002462 Only for 83xx systems. If specified, then DDR should
2463 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06002464
wdenkc26e4542004-04-18 10:13:26 +00002465- CONFIG_ETHER_ON_FEC[12]
2466 Define to enable FEC[12] on a 8xx series processor.
2467
2468- CONFIG_FEC[12]_PHY
2469 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00002470 to the given FEC; i. e.
2471 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00002472 means that the PHY with address 4 is connected to FEC1
2473
2474 When set to -1, means to probe for first available.
2475
2476- CONFIG_FEC[12]_PHY_NORXERR
2477 The PHY does not have a RXERR line (RMII only).
2478 (so program the FEC to ignore it).
2479
2480- CONFIG_RMII
2481 Enable RMII mode for all FECs.
2482 Note that this is a global option, we can't
2483 have one FEC in standard MII mode and another in RMII mode.
2484
wdenk5cf91d62004-04-23 20:32:05 +00002485- CONFIG_CRC32_VERIFY
2486 Add a verify option to the crc32 command.
2487 The syntax is:
2488
2489 => crc32 -v <address> <count> <crc32>
2490
2491 Where address/count indicate a memory area
2492 and crc32 is the correct crc32 which the
2493 area should have.
2494
wdenk56523f12004-07-11 17:40:54 +00002495- CONFIG_LOOPW
2496 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05002497 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00002498
stroese7b466642004-12-16 18:46:55 +00002499- CONFIG_MX_CYCLIC
2500 Add the "mdc" and "mwc" memory commands. These are cyclic
2501 "md/mw" commands.
2502 Examples:
2503
wdenkefe2a4d2004-12-16 21:44:03 +00002504 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00002505 This command will print 4 bytes (10,11,12,13) each 500 ms.
2506
wdenkefe2a4d2004-12-16 21:44:03 +00002507 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00002508 This command will write 12345678 to address 100 all 10 ms.
2509
wdenkefe2a4d2004-12-16 21:44:03 +00002510 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05002511 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00002512
wdenk8aa1a2d2005-04-04 12:44:11 +00002513- CONFIG_SKIP_LOWLEVEL_INIT
2514- CONFIG_SKIP_RELOCATE_UBOOT
2515
wdenk3c2b3d42005-04-05 23:32:21 +00002516 [ARM only] If these variables are defined, then
2517 certain low level initializations (like setting up
2518 the memory controller) are omitted and/or U-Boot does
2519 not relocate itself into RAM.
2520 Normally these variables MUST NOT be defined. The
2521 only exception is when U-Boot is loaded (to RAM) by
2522 some other boot loader or by a debugger which
2523 performs these intializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00002524
wdenk400558b2005-04-02 23:52:25 +00002525
wdenkc6097192002-11-03 00:24:07 +00002526Building the Software:
2527======================
2528
Wolfgang Denk218ca722008-03-26 10:40:12 +01002529Building U-Boot has been tested in several native build environments
2530and in many different cross environments. Of course we cannot support
2531all possibly existing versions of cross development tools in all
2532(potentially obsolete) versions. In case of tool chain problems we
2533recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
2534which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00002535
Wolfgang Denk218ca722008-03-26 10:40:12 +01002536If you are not using a native environment, it is assumed that you
2537have GNU cross compiling tools available in your path. In this case,
2538you must set the environment variable CROSS_COMPILE in your shell.
2539Note that no changes to the Makefile or any other source files are
2540necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00002541
Wolfgang Denk218ca722008-03-26 10:40:12 +01002542 $ CROSS_COMPILE=ppc_4xx-
2543 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00002544
Wolfgang Denk218ca722008-03-26 10:40:12 +01002545U-Boot is intended to be simple to build. After installing the
2546sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00002547is done by typing:
2548
2549 make NAME_config
2550
Wolfgang Denk218ca722008-03-26 10:40:12 +01002551where "NAME_config" is the name of one of the existing configu-
2552rations; see the main Makefile for supported names.
wdenk54387ac2003-10-08 22:45:44 +00002553
wdenk2729af92004-05-03 20:45:30 +00002554Note: for some board special configuration names may exist; check if
2555 additional information is available from the board vendor; for
2556 instance, the TQM823L systems are available without (standard)
2557 or with LCD support. You can select such additional "features"
2558 when chosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00002559
wdenk2729af92004-05-03 20:45:30 +00002560 make TQM823L_config
2561 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00002562
wdenk2729af92004-05-03 20:45:30 +00002563 make TQM823L_LCD_config
2564 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00002565
wdenk2729af92004-05-03 20:45:30 +00002566 etc.
wdenkc6097192002-11-03 00:24:07 +00002567
wdenkc6097192002-11-03 00:24:07 +00002568
wdenk2729af92004-05-03 20:45:30 +00002569Finally, type "make all", and you should get some working U-Boot
2570images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00002571
wdenk2729af92004-05-03 20:45:30 +00002572- "u-boot.bin" is a raw binary image
2573- "u-boot" is an image in ELF binary format
2574- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00002575
Marian Balakowiczbaf31242006-09-07 17:25:40 +02002576By default the build is performed locally and the objects are saved
2577in the source directory. One of the two methods can be used to change
2578this behavior and build U-Boot to some external directory:
2579
25801. Add O= to the make command line invocations:
2581
2582 make O=/tmp/build distclean
2583 make O=/tmp/build NAME_config
2584 make O=/tmp/build all
2585
25862. Set environment variable BUILD_DIR to point to the desired location:
2587
2588 export BUILD_DIR=/tmp/build
2589 make distclean
2590 make NAME_config
2591 make all
2592
2593Note that the command line "O=" setting overrides the BUILD_DIR environment
2594variable.
2595
wdenkc6097192002-11-03 00:24:07 +00002596
wdenk2729af92004-05-03 20:45:30 +00002597Please be aware that the Makefiles assume you are using GNU make, so
2598for instance on NetBSD you might need to use "gmake" instead of
2599native "make".
wdenkc6097192002-11-03 00:24:07 +00002600
wdenkc6097192002-11-03 00:24:07 +00002601
wdenk2729af92004-05-03 20:45:30 +00002602If the system board that you have is not listed, then you will need
2603to port U-Boot to your hardware platform. To do this, follow these
2604steps:
wdenkc6097192002-11-03 00:24:07 +00002605
wdenk2729af92004-05-03 20:45:30 +000026061. Add a new configuration option for your board to the toplevel
2607 "Makefile" and to the "MAKEALL" script, using the existing
2608 entries as examples. Note that here and at many other places
2609 boards and other names are listed in alphabetical sort order. Please
2610 keep this order.
26112. Create a new directory to hold your board specific code. Add any
2612 files you need. In your board directory, you will need at least
2613 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
26143. Create a new configuration file "include/configs/<board>.h" for
2615 your board
26163. If you're porting U-Boot to a new CPU, then also create a new
2617 directory to hold your CPU specific code. Add any files you need.
26184. Run "make <board>_config" with your new name.
26195. Type "make", and you should get a working "u-boot.srec" file
2620 to be installed on your target system.
26216. Debug and solve any problems that might arise.
2622 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00002623
wdenkc6097192002-11-03 00:24:07 +00002624
wdenk2729af92004-05-03 20:45:30 +00002625Testing of U-Boot Modifications, Ports to New Hardware, etc.:
2626==============================================================
wdenkc6097192002-11-03 00:24:07 +00002627
Wolfgang Denk218ca722008-03-26 10:40:12 +01002628If you have modified U-Boot sources (for instance added a new board
2629or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00002630provide feedback to the other developers. The feedback normally takes
2631the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01002632official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00002633
Wolfgang Denk218ca722008-03-26 10:40:12 +01002634But before you submit such a patch, please verify that your modifi-
2635cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00002636the supported boards compile WITHOUT ANY compiler warnings. To do so,
2637just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01002638for ALL supported system. Be warned, this will take a while. You can
2639select which (cross) compiler to use by passing a `CROSS_COMPILE'
2640environment variable to the script, i. e. to use the ELDK cross tools
2641you can type
wdenkc6097192002-11-03 00:24:07 +00002642
wdenk2729af92004-05-03 20:45:30 +00002643 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00002644
wdenk2729af92004-05-03 20:45:30 +00002645or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00002646
wdenk2729af92004-05-03 20:45:30 +00002647 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00002648
Wolfgang Denk218ca722008-03-26 10:40:12 +01002649When using the MAKEALL script, the default behaviour is to build
2650U-Boot in the source directory. This location can be changed by
2651setting the BUILD_DIR environment variable. Also, for each target
2652built, the MAKEALL script saves two log files (<target>.ERR and
2653<target>.MAKEALL) in the <source dir>/LOG directory. This default
2654location can be changed by setting the MAKEALL_LOGDIR environment
2655variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02002656
2657 export BUILD_DIR=/tmp/build
2658 export MAKEALL_LOGDIR=/tmp/log
2659 CROSS_COMPILE=ppc_8xx- MAKEALL
2660
Wolfgang Denk218ca722008-03-26 10:40:12 +01002661With the above settings build objects are saved in the /tmp/build,
2662log files are saved in the /tmp/log and the source tree remains clean
2663during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02002664
2665
wdenk2729af92004-05-03 20:45:30 +00002666See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00002667
wdenkc6097192002-11-03 00:24:07 +00002668
wdenk2729af92004-05-03 20:45:30 +00002669Monitor Commands - Overview:
2670============================
wdenkc6097192002-11-03 00:24:07 +00002671
wdenk2729af92004-05-03 20:45:30 +00002672go - start application at address 'addr'
2673run - run commands in an environment variable
2674bootm - boot application image from memory
2675bootp - boot image via network using BootP/TFTP protocol
2676tftpboot- boot image via network using TFTP protocol
2677 and env variables "ipaddr" and "serverip"
2678 (and eventually "gatewayip")
2679rarpboot- boot image via network using RARP/TFTP protocol
2680diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
2681loads - load S-Record file over serial line
2682loadb - load binary file over serial line (kermit mode)
2683md - memory display
2684mm - memory modify (auto-incrementing)
2685nm - memory modify (constant address)
2686mw - memory write (fill)
2687cp - memory copy
2688cmp - memory compare
2689crc32 - checksum calculation
2690imd - i2c memory display
2691imm - i2c memory modify (auto-incrementing)
2692inm - i2c memory modify (constant address)
2693imw - i2c memory write (fill)
2694icrc32 - i2c checksum calculation
2695iprobe - probe to discover valid I2C chip addresses
2696iloop - infinite loop on address range
2697isdram - print SDRAM configuration information
2698sspi - SPI utility commands
2699base - print or set address offset
2700printenv- print environment variables
2701setenv - set environment variables
2702saveenv - save environment variables to persistent storage
2703protect - enable or disable FLASH write protection
2704erase - erase FLASH memory
2705flinfo - print FLASH memory information
2706bdinfo - print Board Info structure
2707iminfo - print header information for application image
2708coninfo - print console devices and informations
2709ide - IDE sub-system
2710loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00002711loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00002712mtest - simple RAM test
2713icache - enable or disable instruction cache
2714dcache - enable or disable data cache
2715reset - Perform RESET of the CPU
2716echo - echo args to console
2717version - print monitor version
2718help - print online help
2719? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00002720
wdenkc6097192002-11-03 00:24:07 +00002721
wdenk2729af92004-05-03 20:45:30 +00002722Monitor Commands - Detailed Description:
2723========================================
wdenkc6097192002-11-03 00:24:07 +00002724
wdenk2729af92004-05-03 20:45:30 +00002725TODO.
wdenkc6097192002-11-03 00:24:07 +00002726
wdenk2729af92004-05-03 20:45:30 +00002727For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00002728
2729
wdenk2729af92004-05-03 20:45:30 +00002730Environment Variables:
2731======================
wdenkc6097192002-11-03 00:24:07 +00002732
wdenk2729af92004-05-03 20:45:30 +00002733U-Boot supports user configuration using Environment Variables which
2734can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00002735
wdenk2729af92004-05-03 20:45:30 +00002736Environment Variables are set using "setenv", printed using
2737"printenv", and saved to Flash using "saveenv". Using "setenv"
2738without a value can be used to delete a variable from the
2739environment. As long as you don't save the environment you are
2740working with an in-memory copy. In case the Flash area containing the
2741environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00002742
wdenk2729af92004-05-03 20:45:30 +00002743Some configuration options can be set using Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00002744
wdenk2729af92004-05-03 20:45:30 +00002745 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00002746
wdenk2729af92004-05-03 20:45:30 +00002747 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00002748
wdenk2729af92004-05-03 20:45:30 +00002749 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00002750
wdenk2729af92004-05-03 20:45:30 +00002751 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00002752
wdenk2729af92004-05-03 20:45:30 +00002753 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00002754
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02002755 bootm_low - Memory range available for image processing in the bootm
2756 command can be restricted. This variable is given as
2757 a hexadecimal number and defines lowest address allowed
2758 for use by the bootm command. See also "bootm_size"
2759 environment variable. Address defined by "bootm_low" is
2760 also the base of the initial memory mapping for the Linux
2761 kernel -- see the descripton of CFG_BOOTMAPSZ.
2762
2763 bootm_size - Memory range available for image processing in the bootm
2764 command can be restricted. This variable is given as
2765 a hexadecimal number and defines the size of the region
2766 allowed for use by the bootm command. See also "bootm_low"
2767 environment variable.
2768
wdenk2729af92004-05-03 20:45:30 +00002769 autoload - if set to "no" (any string beginning with 'n'),
2770 "bootp" will just load perform a lookup of the
2771 configuration from the BOOTP server, but not try to
2772 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00002773
Marian Balakowicz3310c542008-03-12 12:13:13 +01002774 autoscript - if set to "yes" commands like "loadb", "loady",
2775 "bootp", "tftpb", "rarpboot" and "nfs" will attempt
2776 to automatically run script images (by internally
2777 calling "autoscript").
2778
2779 autoscript_uname - if script image is in a format (FIT) this
2780 variable is used to get script subimage unit name.
2781
wdenk2729af92004-05-03 20:45:30 +00002782 autostart - if set to "yes", an image loaded using the "bootp",
2783 "rarpboot", "tftpboot" or "diskboot" commands will
2784 be automatically started (by internally calling
2785 "bootm")
wdenkc6097192002-11-03 00:24:07 +00002786
wdenk2729af92004-05-03 20:45:30 +00002787 If set to "no", a standalone image passed to the
2788 "bootm" command will be copied to the load address
2789 (and eventually uncompressed), but NOT be started.
2790 This can be used to load and uncompress arbitrary
2791 data.
wdenkc6097192002-11-03 00:24:07 +00002792
wdenk17ea1172004-06-06 21:51:03 +00002793 i2cfast - (PPC405GP|PPC405EP only)
2794 if set to 'y' configures Linux I2C driver for fast
2795 mode (400kHZ). This environment variable is used in
2796 initialization code. So, for changes to be effective
2797 it must be saved and board must be reset.
2798
wdenk2729af92004-05-03 20:45:30 +00002799 initrd_high - restrict positioning of initrd images:
2800 If this variable is not set, initrd images will be
2801 copied to the highest possible address in RAM; this
2802 is usually what you want since it allows for
2803 maximum initrd size. If for some reason you want to
2804 make sure that the initrd image is loaded below the
2805 CFG_BOOTMAPSZ limit, you can set this environment
2806 variable to a value of "no" or "off" or "0".
2807 Alternatively, you can set it to a maximum upper
2808 address to use (U-Boot will still check that it
2809 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00002810
wdenk2729af92004-05-03 20:45:30 +00002811 For instance, when you have a system with 16 MB
2812 RAM, and want to reserve 4 MB from use by Linux,
2813 you can do this by adding "mem=12M" to the value of
2814 the "bootargs" variable. However, now you must make
2815 sure that the initrd image is placed in the first
2816 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00002817
wdenk2729af92004-05-03 20:45:30 +00002818 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00002819
wdenk2729af92004-05-03 20:45:30 +00002820 If you set initrd_high to 0xFFFFFFFF, this is an
2821 indication to U-Boot that all addresses are legal
2822 for the Linux kernel, including addresses in flash
2823 memory. In this case U-Boot will NOT COPY the
2824 ramdisk at all. This may be useful to reduce the
2825 boot time on your system, but requires that this
2826 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00002827
wdenk2729af92004-05-03 20:45:30 +00002828 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00002829
wdenk2729af92004-05-03 20:45:30 +00002830 loadaddr - Default load address for commands like "bootp",
2831 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00002832
wdenk2729af92004-05-03 20:45:30 +00002833 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00002834
wdenk2729af92004-05-03 20:45:30 +00002835 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00002836
wdenk2729af92004-05-03 20:45:30 +00002837 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00002838
wdenk2729af92004-05-03 20:45:30 +00002839 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00002840
wdenk2729af92004-05-03 20:45:30 +00002841 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00002842
wdenk2729af92004-05-03 20:45:30 +00002843 ethprime - When CONFIG_NET_MULTI is enabled controls which
2844 interface is used first.
wdenkc6097192002-11-03 00:24:07 +00002845
wdenk2729af92004-05-03 20:45:30 +00002846 ethact - When CONFIG_NET_MULTI is enabled controls which
2847 interface is currently active. For example you
2848 can do the following
wdenkc6097192002-11-03 00:24:07 +00002849
wdenk2729af92004-05-03 20:45:30 +00002850 => setenv ethact FEC ETHERNET
2851 => ping 192.168.0.1 # traffic sent on FEC ETHERNET
2852 => setenv ethact SCC ETHERNET
2853 => ping 10.0.0.1 # traffic sent on SCC ETHERNET
wdenkc6097192002-11-03 00:24:07 +00002854
Matthias Fuchse1692572008-01-17 07:45:05 +01002855 ethrotate - When set to "no" U-Boot does not go through all
2856 available network interfaces.
2857 It just stays at the currently selected interface.
2858
wdenk2729af92004-05-03 20:45:30 +00002859 netretry - When set to "no" each network operation will
2860 either succeed or fail without retrying.
2861 When set to "once" the network operation will
2862 fail when all the available network interfaces
2863 are tried once without success.
2864 Useful on scripts which control the retry operation
2865 themselves.
wdenkc6097192002-11-03 00:24:07 +00002866
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01002867 npe_ucode - see CONFIG_IXP4XX_NPE_EXT_UCOD
2868 if set load address for the npe microcode
2869
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002870 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002871 UDP source port.
2872
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002873 tftpdstport - If this is set, the value is used for TFTP's UDP
2874 destination port instead of the Well Know Port 69.
2875
wdenk2729af92004-05-03 20:45:30 +00002876 vlan - When set to a value < 4095 the traffic over
2877 ethernet is encapsulated/received over 802.1q
2878 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00002879
wdenk2729af92004-05-03 20:45:30 +00002880The following environment variables may be used and automatically
2881updated by the network boot commands ("bootp" and "rarpboot"),
2882depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00002883
wdenk2729af92004-05-03 20:45:30 +00002884 bootfile - see above
2885 dnsip - IP address of your Domain Name Server
2886 dnsip2 - IP address of your secondary Domain Name Server
2887 gatewayip - IP address of the Gateway (Router) to use
2888 hostname - Target hostname
2889 ipaddr - see above
2890 netmask - Subnet Mask
2891 rootpath - Pathname of the root filesystem on the NFS server
2892 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00002893
wdenka3d991b2004-04-15 21:48:45 +00002894
wdenk2729af92004-05-03 20:45:30 +00002895There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00002896
wdenk2729af92004-05-03 20:45:30 +00002897 serial# - contains hardware identification information such
2898 as type string and/or serial number
2899 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00002900
wdenk2729af92004-05-03 20:45:30 +00002901These variables can be set only once (usually during manufacturing of
2902the board). U-Boot refuses to delete or overwrite these variables
2903once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00002904
2905
wdenk2729af92004-05-03 20:45:30 +00002906Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00002907
wdenk2729af92004-05-03 20:45:30 +00002908 ver - Contains the U-Boot version string as printed
2909 with the "version" command. This variable is
2910 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00002911
wdenkc6097192002-11-03 00:24:07 +00002912
wdenk2729af92004-05-03 20:45:30 +00002913Please note that changes to some configuration parameters may take
2914only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00002915
stroesec1551ea2003-04-04 15:53:41 +00002916
wdenk2729af92004-05-03 20:45:30 +00002917Command Line Parsing:
2918=====================
stroesec1551ea2003-04-04 15:53:41 +00002919
wdenk2729af92004-05-03 20:45:30 +00002920There are two different command line parsers available with U-Boot:
2921the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00002922
wdenk2729af92004-05-03 20:45:30 +00002923Old, simple command line parser:
2924--------------------------------
wdenkc6097192002-11-03 00:24:07 +00002925
wdenk2729af92004-05-03 20:45:30 +00002926- supports environment variables (through setenv / saveenv commands)
2927- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01002928- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00002929- special characters ('$', ';') can be escaped by prefixing with '\',
2930 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01002931 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00002932- You can also escape text by enclosing in single apostrophes, for example:
2933 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00002934
wdenk2729af92004-05-03 20:45:30 +00002935Hush shell:
2936-----------
wdenkf07771c2003-05-28 08:06:31 +00002937
wdenk2729af92004-05-03 20:45:30 +00002938- similar to Bourne shell, with control structures like
2939 if...then...else...fi, for...do...done; while...do...done,
2940 until...do...done, ...
2941- supports environment ("global") variables (through setenv / saveenv
2942 commands) and local shell variables (through standard shell syntax
2943 "name=value"); only environment variables can be used with "run"
2944 command
wdenkf07771c2003-05-28 08:06:31 +00002945
wdenk2729af92004-05-03 20:45:30 +00002946General rules:
2947--------------
wdenkf07771c2003-05-28 08:06:31 +00002948
wdenk2729af92004-05-03 20:45:30 +00002949(1) If a command line (or an environment variable executed by a "run"
2950 command) contains several commands separated by semicolon, and
2951 one of these commands fails, then the remaining commands will be
2952 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00002953
wdenk2729af92004-05-03 20:45:30 +00002954(2) If you execute several variables with one call to run (i. e.
2955 calling run with a list af variables as arguments), any failing
2956 command will cause "run" to terminate, i. e. the remaining
2957 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00002958
wdenk2729af92004-05-03 20:45:30 +00002959Note for Redundant Ethernet Interfaces:
2960=======================================
wdenkf07771c2003-05-28 08:06:31 +00002961
wdenk2729af92004-05-03 20:45:30 +00002962Some boards come with redundant ethernet interfaces; U-Boot supports
2963such configurations and is capable of automatic selection of a
2964"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00002965
wdenk2729af92004-05-03 20:45:30 +00002966Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
2967MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
2968"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00002969
wdenk2729af92004-05-03 20:45:30 +00002970If the network interface stores some valid MAC address (for instance
2971in SROM), this is used as default address if there is NO correspon-
2972ding setting in the environment; if the corresponding environment
2973variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00002974
wdenk2729af92004-05-03 20:45:30 +00002975o If the SROM has a valid MAC address, and there is no address in the
2976 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00002977
wdenk2729af92004-05-03 20:45:30 +00002978o If there is no valid address in the SROM, and a definition in the
2979 environment exists, then the value from the environment variable is
2980 used.
wdenkc6097192002-11-03 00:24:07 +00002981
wdenk2729af92004-05-03 20:45:30 +00002982o If both the SROM and the environment contain a MAC address, and
2983 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00002984
wdenk2729af92004-05-03 20:45:30 +00002985o If both the SROM and the environment contain a MAC address, and the
2986 addresses differ, the value from the environment is used and a
2987 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00002988
wdenk2729af92004-05-03 20:45:30 +00002989o If neither SROM nor the environment contain a MAC address, an error
2990 is raised.
wdenkc6097192002-11-03 00:24:07 +00002991
wdenkc6097192002-11-03 00:24:07 +00002992
wdenk2729af92004-05-03 20:45:30 +00002993Image Formats:
2994==============
wdenkc6097192002-11-03 00:24:07 +00002995
Marian Balakowicz3310c542008-03-12 12:13:13 +01002996U-Boot is capable of booting (and performing other auxiliary operations on)
2997images in two formats:
2998
2999New uImage format (FIT)
3000-----------------------
3001
3002Flexible and powerful format based on Flattened Image Tree -- FIT (similar
3003to Flattened Device Tree). It allows the use of images with multiple
3004components (several kernels, ramdisks, etc.), with contents protected by
3005SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
3006
3007
3008Old uImage format
3009-----------------
3010
3011Old image format is based on binary files which can be basically anything,
3012preceded by a special header; see the definitions in include/image.h for
3013details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00003014
wdenk2729af92004-05-03 20:45:30 +00003015* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
3016 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
3017 LynxOS, pSOS, QNX, RTEMS, ARTOS;
3018 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, ARTOS, LynxOS).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02003019* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
wdenk2729af92004-05-03 20:45:30 +00003020 IA64, MIPS, NIOS, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02003021 Currently supported: ARM, AVR32, Intel x86, MIPS, NIOS, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00003022* Compression Type (uncompressed, gzip, bzip2)
3023* Load Address
3024* Entry Point
3025* Image Name
3026* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00003027
wdenk2729af92004-05-03 20:45:30 +00003028The header is marked by a special Magic Number, and both the header
3029and the data portions of the image are secured against corruption by
3030CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00003031
wdenkc6097192002-11-03 00:24:07 +00003032
wdenk2729af92004-05-03 20:45:30 +00003033Linux Support:
3034==============
wdenkc6097192002-11-03 00:24:07 +00003035
wdenk2729af92004-05-03 20:45:30 +00003036Although U-Boot should support any OS or standalone application
3037easily, the main focus has always been on Linux during the design of
3038U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003039
wdenk2729af92004-05-03 20:45:30 +00003040U-Boot includes many features that so far have been part of some
3041special "boot loader" code within the Linux kernel. Also, any
3042"initrd" images to be used are no longer part of one big Linux image;
3043instead, kernel and "initrd" are separate images. This implementation
3044serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00003045
wdenk2729af92004-05-03 20:45:30 +00003046- the same features can be used for other OS or standalone
3047 applications (for instance: using compressed images to reduce the
3048 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00003049
wdenk2729af92004-05-03 20:45:30 +00003050- it becomes much easier to port new Linux kernel versions because
3051 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00003052
wdenk2729af92004-05-03 20:45:30 +00003053- the same Linux kernel image can now be used with different "initrd"
3054 images; of course this also means that different kernel images can
3055 be run with the same "initrd". This makes testing easier (you don't
3056 have to build a new "zImage.initrd" Linux image when you just
3057 change a file in your "initrd"). Also, a field-upgrade of the
3058 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00003059
wdenkc6097192002-11-03 00:24:07 +00003060
wdenk2729af92004-05-03 20:45:30 +00003061Linux HOWTO:
3062============
wdenkc6097192002-11-03 00:24:07 +00003063
wdenk2729af92004-05-03 20:45:30 +00003064Porting Linux to U-Boot based systems:
3065---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003066
wdenk2729af92004-05-03 20:45:30 +00003067U-Boot cannot save you from doing all the necessary modifications to
3068configure the Linux device drivers for use with your target hardware
3069(no, we don't intend to provide a full virtual machine interface to
3070Linux :-).
wdenkc6097192002-11-03 00:24:07 +00003071
wdenk2729af92004-05-03 20:45:30 +00003072But now you can ignore ALL boot loader code (in arch/ppc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00003073
wdenk2729af92004-05-03 20:45:30 +00003074Just make sure your machine specific header file (for instance
3075include/asm-ppc/tqm8xx.h) includes the same definition of the Board
3076Information structure as we define in include/u-boot.h, and make
3077sure that your definition of IMAP_ADDR uses the same value as your
3078U-Boot configuration in CFG_IMMR.
wdenkc6097192002-11-03 00:24:07 +00003079
wdenkc6097192002-11-03 00:24:07 +00003080
wdenk2729af92004-05-03 20:45:30 +00003081Configuring the Linux kernel:
3082-----------------------------
wdenkc6097192002-11-03 00:24:07 +00003083
wdenk2729af92004-05-03 20:45:30 +00003084No specific requirements for U-Boot. Make sure you have some root
3085device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00003086
wdenkc6097192002-11-03 00:24:07 +00003087
wdenk2729af92004-05-03 20:45:30 +00003088Building a Linux Image:
3089-----------------------
wdenkc6097192002-11-03 00:24:07 +00003090
wdenk2729af92004-05-03 20:45:30 +00003091With U-Boot, "normal" build targets like "zImage" or "bzImage" are
3092not used. If you use recent kernel source, a new build target
3093"uImage" will exist which automatically builds an image usable by
3094U-Boot. Most older kernels also have support for a "pImage" target,
3095which was introduced for our predecessor project PPCBoot and uses a
3096100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00003097
wdenk2729af92004-05-03 20:45:30 +00003098Example:
wdenkc6097192002-11-03 00:24:07 +00003099
wdenk2729af92004-05-03 20:45:30 +00003100 make TQM850L_config
3101 make oldconfig
3102 make dep
3103 make uImage
wdenkc6097192002-11-03 00:24:07 +00003104
wdenk2729af92004-05-03 20:45:30 +00003105The "uImage" build target uses a special tool (in 'tools/mkimage') to
3106encapsulate a compressed Linux kernel image with header information,
3107CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00003108
wdenk2729af92004-05-03 20:45:30 +00003109* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00003110
wdenk2729af92004-05-03 20:45:30 +00003111* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00003112
wdenk2729af92004-05-03 20:45:30 +00003113 ${CROSS_COMPILE}-objcopy -O binary \
3114 -R .note -R .comment \
3115 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00003116
wdenk2729af92004-05-03 20:45:30 +00003117* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00003118
wdenk2729af92004-05-03 20:45:30 +00003119 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00003120
wdenk2729af92004-05-03 20:45:30 +00003121* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00003122
wdenk2729af92004-05-03 20:45:30 +00003123 mkimage -A ppc -O linux -T kernel -C gzip \
3124 -a 0 -e 0 -n "Linux Kernel Image" \
3125 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00003126
wdenk24ee89b2002-11-03 17:56:27 +00003127
wdenk2729af92004-05-03 20:45:30 +00003128The "mkimage" tool can also be used to create ramdisk images for use
3129with U-Boot, either separated from the Linux kernel image, or
3130combined into one file. "mkimage" encapsulates the images with a 64
3131byte header containing information about target architecture,
3132operating system, image type, compression method, entry points, time
3133stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00003134
wdenk2729af92004-05-03 20:45:30 +00003135"mkimage" can be called in two ways: to verify existing images and
3136print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00003137
wdenk2729af92004-05-03 20:45:30 +00003138In the first form (with "-l" option) mkimage lists the information
3139contained in the header of an existing U-Boot image; this includes
3140checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00003141
wdenk2729af92004-05-03 20:45:30 +00003142 tools/mkimage -l image
3143 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00003144
wdenk2729af92004-05-03 20:45:30 +00003145The second form (with "-d" option) is used to build a U-Boot image
3146from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00003147
wdenk2729af92004-05-03 20:45:30 +00003148 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
3149 -n name -d data_file image
3150 -A ==> set architecture to 'arch'
3151 -O ==> set operating system to 'os'
3152 -T ==> set image type to 'type'
3153 -C ==> set compression type 'comp'
3154 -a ==> set load address to 'addr' (hex)
3155 -e ==> set entry point to 'ep' (hex)
3156 -n ==> set image name to 'name'
3157 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00003158
wdenk69459792004-05-29 16:53:29 +00003159Right now, all Linux kernels for PowerPC systems use the same load
3160address (0x00000000), but the entry point address depends on the
3161kernel version:
wdenkc6097192002-11-03 00:24:07 +00003162
wdenk2729af92004-05-03 20:45:30 +00003163- 2.2.x kernels have the entry point at 0x0000000C,
3164- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00003165
wdenk2729af92004-05-03 20:45:30 +00003166So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00003167
wdenk2729af92004-05-03 20:45:30 +00003168 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3169 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
3170 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz \
3171 > examples/uImage.TQM850L
3172 Image Name: 2.4.4 kernel for TQM850L
3173 Created: Wed Jul 19 02:34:59 2000
3174 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3175 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3176 Load Address: 0x00000000
3177 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003178
wdenk2729af92004-05-03 20:45:30 +00003179To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00003180
wdenk2729af92004-05-03 20:45:30 +00003181 -> tools/mkimage -l examples/uImage.TQM850L
3182 Image Name: 2.4.4 kernel for TQM850L
3183 Created: Wed Jul 19 02:34:59 2000
3184 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3185 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3186 Load Address: 0x00000000
3187 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003188
wdenk2729af92004-05-03 20:45:30 +00003189NOTE: for embedded systems where boot time is critical you can trade
3190speed for memory and install an UNCOMPRESSED image instead: this
3191needs more space in Flash, but boots much faster since it does not
3192need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00003193
wdenk2729af92004-05-03 20:45:30 +00003194 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz
3195 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3196 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
3197 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux \
3198 > examples/uImage.TQM850L-uncompressed
3199 Image Name: 2.4.4 kernel for TQM850L
3200 Created: Wed Jul 19 02:34:59 2000
3201 Image Type: PowerPC Linux Kernel Image (uncompressed)
3202 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
3203 Load Address: 0x00000000
3204 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003205
wdenkc6097192002-11-03 00:24:07 +00003206
wdenk2729af92004-05-03 20:45:30 +00003207Similar you can build U-Boot images from a 'ramdisk.image.gz' file
3208when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00003209
wdenk2729af92004-05-03 20:45:30 +00003210 -> tools/mkimage -n 'Simple Ramdisk Image' \
3211 > -A ppc -O linux -T ramdisk -C gzip \
3212 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
3213 Image Name: Simple Ramdisk Image
3214 Created: Wed Jan 12 14:01:50 2000
3215 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3216 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
3217 Load Address: 0x00000000
3218 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00003219
wdenkdb01a2e2004-04-15 23:14:49 +00003220
wdenk2729af92004-05-03 20:45:30 +00003221Installing a Linux Image:
3222-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00003223
wdenk2729af92004-05-03 20:45:30 +00003224To downloading a U-Boot image over the serial (console) interface,
3225you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00003226
wdenk2729af92004-05-03 20:45:30 +00003227 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00003228
wdenk2729af92004-05-03 20:45:30 +00003229The 'objcopy' does not understand the information in the U-Boot
3230image header, so the resulting S-Record file will be relative to
3231address 0x00000000. To load it to a given address, you need to
3232specify the target address as 'offset' parameter with the 'loads'
3233command.
wdenkc6097192002-11-03 00:24:07 +00003234
wdenk2729af92004-05-03 20:45:30 +00003235Example: install the image to address 0x40100000 (which on the
3236TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00003237
wdenk2729af92004-05-03 20:45:30 +00003238 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00003239
wdenk2729af92004-05-03 20:45:30 +00003240 .......... done
3241 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00003242
wdenk2729af92004-05-03 20:45:30 +00003243 => loads 40100000
3244 ## Ready for S-Record download ...
3245 ~>examples/image.srec
3246 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
3247 ...
3248 15989 15990 15991 15992
3249 [file transfer complete]
3250 [connected]
3251 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003252
3253
wdenk2729af92004-05-03 20:45:30 +00003254You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01003255this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00003256corruption happened:
wdenkc6097192002-11-03 00:24:07 +00003257
wdenk2729af92004-05-03 20:45:30 +00003258 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00003259
wdenk2729af92004-05-03 20:45:30 +00003260 ## Checking Image at 40100000 ...
3261 Image Name: 2.2.13 for initrd on TQM850L
3262 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3263 Data Size: 335725 Bytes = 327 kB = 0 MB
3264 Load Address: 00000000
3265 Entry Point: 0000000c
3266 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003267
3268
wdenk2729af92004-05-03 20:45:30 +00003269Boot Linux:
3270-----------
wdenkc6097192002-11-03 00:24:07 +00003271
wdenk2729af92004-05-03 20:45:30 +00003272The "bootm" command is used to boot an application that is stored in
3273memory (RAM or Flash). In case of a Linux kernel image, the contents
3274of the "bootargs" environment variable is passed to the kernel as
3275parameters. You can check and modify this variable using the
3276"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00003277
3278
wdenk2729af92004-05-03 20:45:30 +00003279 => printenv bootargs
3280 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00003281
wdenk2729af92004-05-03 20:45:30 +00003282 => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
wdenkc6097192002-11-03 00:24:07 +00003283
wdenk2729af92004-05-03 20:45:30 +00003284 => printenv bootargs
3285 bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
wdenkc6097192002-11-03 00:24:07 +00003286
wdenk2729af92004-05-03 20:45:30 +00003287 => bootm 40020000
3288 ## Booting Linux kernel at 40020000 ...
3289 Image Name: 2.2.13 for NFS on TQM850L
3290 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3291 Data Size: 381681 Bytes = 372 kB = 0 MB
3292 Load Address: 00000000
3293 Entry Point: 0000000c
3294 Verifying Checksum ... OK
3295 Uncompressing Kernel Image ... OK
3296 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
3297 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3298 time_init: decrementer frequency = 187500000/60
3299 Calibrating delay loop... 49.77 BogoMIPS
3300 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
3301 ...
wdenkc6097192002-11-03 00:24:07 +00003302
wdenk2729af92004-05-03 20:45:30 +00003303If you want to boot a Linux kernel with initial ram disk, you pass
3304the memory addresses of both the kernel and the initrd image (PPBCOOT
3305format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00003306
wdenk2729af92004-05-03 20:45:30 +00003307 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00003308
wdenk2729af92004-05-03 20:45:30 +00003309 ## Checking Image at 40100000 ...
3310 Image Name: 2.2.13 for initrd on TQM850L
3311 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3312 Data Size: 335725 Bytes = 327 kB = 0 MB
3313 Load Address: 00000000
3314 Entry Point: 0000000c
3315 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003316
wdenk2729af92004-05-03 20:45:30 +00003317 ## Checking Image at 40200000 ...
3318 Image Name: Simple Ramdisk Image
3319 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3320 Data Size: 566530 Bytes = 553 kB = 0 MB
3321 Load Address: 00000000
3322 Entry Point: 00000000
3323 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003324
wdenk2729af92004-05-03 20:45:30 +00003325 => bootm 40100000 40200000
3326 ## Booting Linux kernel at 40100000 ...
3327 Image Name: 2.2.13 for initrd on TQM850L
3328 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3329 Data Size: 335725 Bytes = 327 kB = 0 MB
3330 Load Address: 00000000
3331 Entry Point: 0000000c
3332 Verifying Checksum ... OK
3333 Uncompressing Kernel Image ... OK
3334 ## Loading RAMDisk Image at 40200000 ...
3335 Image Name: Simple Ramdisk Image
3336 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3337 Data Size: 566530 Bytes = 553 kB = 0 MB
3338 Load Address: 00000000
3339 Entry Point: 00000000
3340 Verifying Checksum ... OK
3341 Loading Ramdisk ... OK
3342 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
3343 Boot arguments: root=/dev/ram
3344 time_init: decrementer frequency = 187500000/60
3345 Calibrating delay loop... 49.77 BogoMIPS
3346 ...
3347 RAMDISK: Compressed image found at block 0
3348 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00003349
wdenk2729af92004-05-03 20:45:30 +00003350 bash#
wdenkc6097192002-11-03 00:24:07 +00003351
Matthew McClintock02677682006-06-28 10:41:37 -05003352Boot Linux and pass a flat device tree:
3353-----------
3354
3355First, U-Boot must be compiled with the appropriate defines. See the section
3356titled "Linux Kernel Interface" above for a more in depth explanation. The
3357following is an example of how to start a kernel and pass an updated
3358flat device tree:
3359
3360=> print oftaddr
3361oftaddr=0x300000
3362=> print oft
3363oft=oftrees/mpc8540ads.dtb
3364=> tftp $oftaddr $oft
3365Speed: 1000, full duplex
3366Using TSEC0 device
3367TFTP from server 192.168.1.1; our IP address is 192.168.1.101
3368Filename 'oftrees/mpc8540ads.dtb'.
3369Load address: 0x300000
3370Loading: #
3371done
3372Bytes transferred = 4106 (100a hex)
3373=> tftp $loadaddr $bootfile
3374Speed: 1000, full duplex
3375Using TSEC0 device
3376TFTP from server 192.168.1.1; our IP address is 192.168.1.2
3377Filename 'uImage'.
3378Load address: 0x200000
3379Loading:############
3380done
3381Bytes transferred = 1029407 (fb51f hex)
3382=> print loadaddr
3383loadaddr=200000
3384=> print oftaddr
3385oftaddr=0x300000
3386=> bootm $loadaddr - $oftaddr
3387## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01003388 Image Name: Linux-2.6.17-dirty
3389 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3390 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05003391 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01003392 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05003393 Verifying Checksum ... OK
3394 Uncompressing Kernel Image ... OK
3395Booting using flat device tree at 0x300000
3396Using MPC85xx ADS machine description
3397Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
3398[snip]
3399
3400
wdenk2729af92004-05-03 20:45:30 +00003401More About U-Boot Image Types:
3402------------------------------
wdenk6069ff22003-02-28 00:49:47 +00003403
wdenk2729af92004-05-03 20:45:30 +00003404U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00003405
wdenk2729af92004-05-03 20:45:30 +00003406 "Standalone Programs" are directly runnable in the environment
3407 provided by U-Boot; it is expected that (if they behave
3408 well) you can continue to work in U-Boot after return from
3409 the Standalone Program.
3410 "OS Kernel Images" are usually images of some Embedded OS which
3411 will take over control completely. Usually these programs
3412 will install their own set of exception handlers, device
3413 drivers, set up the MMU, etc. - this means, that you cannot
3414 expect to re-enter U-Boot except by resetting the CPU.
3415 "RAMDisk Images" are more or less just data blocks, and their
3416 parameters (address, size) are passed to an OS kernel that is
3417 being started.
3418 "Multi-File Images" contain several images, typically an OS
3419 (Linux) kernel image and one or more data images like
3420 RAMDisks. This construct is useful for instance when you want
3421 to boot over the network using BOOTP etc., where the boot
3422 server provides just a single image file, but you want to get
3423 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00003424
wdenk2729af92004-05-03 20:45:30 +00003425 "Multi-File Images" start with a list of image sizes, each
3426 image size (in bytes) specified by an "uint32_t" in network
3427 byte order. This list is terminated by an "(uint32_t)0".
3428 Immediately after the terminating 0 follow the images, one by
3429 one, all aligned on "uint32_t" boundaries (size rounded up to
3430 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00003431
wdenk2729af92004-05-03 20:45:30 +00003432 "Firmware Images" are binary images containing firmware (like
3433 U-Boot or FPGA images) which usually will be programmed to
3434 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00003435
wdenk2729af92004-05-03 20:45:30 +00003436 "Script files" are command sequences that will be executed by
3437 U-Boot's command interpreter; this feature is especially
3438 useful when you configure U-Boot to use a real shell (hush)
3439 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00003440
wdenkc6097192002-11-03 00:24:07 +00003441
wdenk2729af92004-05-03 20:45:30 +00003442Standalone HOWTO:
3443=================
wdenkc6097192002-11-03 00:24:07 +00003444
wdenk2729af92004-05-03 20:45:30 +00003445One of the features of U-Boot is that you can dynamically load and
3446run "standalone" applications, which can use some resources of
3447U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00003448
wdenk2729af92004-05-03 20:45:30 +00003449Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00003450
wdenk2729af92004-05-03 20:45:30 +00003451"Hello World" Demo:
3452-------------------
wdenkc6097192002-11-03 00:24:07 +00003453
wdenk2729af92004-05-03 20:45:30 +00003454'examples/hello_world.c' contains a small "Hello World" Demo
3455application; it is automatically compiled when you build U-Boot.
3456It's configured to run at address 0x00040004, so you can play with it
3457like that:
wdenkc6097192002-11-03 00:24:07 +00003458
wdenk2729af92004-05-03 20:45:30 +00003459 => loads
3460 ## Ready for S-Record download ...
3461 ~>examples/hello_world.srec
3462 1 2 3 4 5 6 7 8 9 10 11 ...
3463 [file transfer complete]
3464 [connected]
3465 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00003466
wdenk2729af92004-05-03 20:45:30 +00003467 => go 40004 Hello World! This is a test.
3468 ## Starting application at 0x00040004 ...
3469 Hello World
3470 argc = 7
3471 argv[0] = "40004"
3472 argv[1] = "Hello"
3473 argv[2] = "World!"
3474 argv[3] = "This"
3475 argv[4] = "is"
3476 argv[5] = "a"
3477 argv[6] = "test."
3478 argv[7] = "<NULL>"
3479 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00003480
wdenk2729af92004-05-03 20:45:30 +00003481 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00003482
wdenk2729af92004-05-03 20:45:30 +00003483Another example, which demonstrates how to register a CPM interrupt
3484handler with the U-Boot code, can be found in 'examples/timer.c'.
3485Here, a CPM timer is set up to generate an interrupt every second.
3486The interrupt service routine is trivial, just printing a '.'
3487character, but this is just a demo program. The application can be
3488controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00003489
wdenk2729af92004-05-03 20:45:30 +00003490 ? - print current values og the CPM Timer registers
3491 b - enable interrupts and start timer
3492 e - stop timer and disable interrupts
3493 q - quit application
wdenkc6097192002-11-03 00:24:07 +00003494
wdenk2729af92004-05-03 20:45:30 +00003495 => loads
3496 ## Ready for S-Record download ...
3497 ~>examples/timer.srec
3498 1 2 3 4 5 6 7 8 9 10 11 ...
3499 [file transfer complete]
3500 [connected]
3501 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00003502
wdenk2729af92004-05-03 20:45:30 +00003503 => go 40004
3504 ## Starting application at 0x00040004 ...
3505 TIMERS=0xfff00980
3506 Using timer 1
3507 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00003508
wdenk2729af92004-05-03 20:45:30 +00003509Hit 'b':
3510 [q, b, e, ?] Set interval 1000000 us
3511 Enabling timer
3512Hit '?':
3513 [q, b, e, ?] ........
3514 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
3515Hit '?':
3516 [q, b, e, ?] .
3517 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
3518Hit '?':
3519 [q, b, e, ?] .
3520 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
3521Hit '?':
3522 [q, b, e, ?] .
3523 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
3524Hit 'e':
3525 [q, b, e, ?] ...Stopping timer
3526Hit 'q':
3527 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00003528
3529
wdenk2729af92004-05-03 20:45:30 +00003530Minicom warning:
3531================
wdenk85ec0bc2003-03-31 16:34:49 +00003532
wdenk2729af92004-05-03 20:45:30 +00003533Over time, many people have reported problems when trying to use the
3534"minicom" terminal emulation program for serial download. I (wd)
3535consider minicom to be broken, and recommend not to use it. Under
3536Unix, I recommend to use C-Kermit for general purpose use (and
3537especially for kermit binary protocol download ("loadb" command), and
3538use "cu" for S-Record download ("loads" command).
wdenk85ec0bc2003-03-31 16:34:49 +00003539
wdenk2729af92004-05-03 20:45:30 +00003540Nevertheless, if you absolutely want to use it try adding this
3541configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00003542
wdenk2729af92004-05-03 20:45:30 +00003543 Name Program Name U/D FullScr IO-Red. Multi
3544 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
3545 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00003546
3547
wdenk2729af92004-05-03 20:45:30 +00003548NetBSD Notes:
3549=============
wdenkc6097192002-11-03 00:24:07 +00003550
wdenk2729af92004-05-03 20:45:30 +00003551Starting at version 0.9.2, U-Boot supports NetBSD both as host
3552(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00003553
wdenk2729af92004-05-03 20:45:30 +00003554Building requires a cross environment; it is known to work on
3555NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
3556need gmake since the Makefiles are not compatible with BSD make).
3557Note that the cross-powerpc package does not install include files;
3558attempting to build U-Boot will fail because <machine/ansi.h> is
3559missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00003560
wdenk2729af92004-05-03 20:45:30 +00003561 # cd /usr/pkg/cross/powerpc-netbsd/include
3562 # mkdir powerpc
3563 # ln -s powerpc machine
3564 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
3565 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00003566
wdenk2729af92004-05-03 20:45:30 +00003567Native builds *don't* work due to incompatibilities between native
3568and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00003569
wdenk2729af92004-05-03 20:45:30 +00003570Booting assumes that (the first part of) the image booted is a
3571stage-2 loader which in turn loads and then invokes the kernel
3572proper. Loader sources will eventually appear in the NetBSD source
3573tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00003574meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00003575
3576
wdenk2729af92004-05-03 20:45:30 +00003577Implementation Internals:
3578=========================
wdenkc6097192002-11-03 00:24:07 +00003579
wdenk2729af92004-05-03 20:45:30 +00003580The following is not intended to be a complete description of every
3581implementation detail. However, it should help to understand the
3582inner workings of U-Boot and make it easier to port it to custom
3583hardware.
wdenkc6097192002-11-03 00:24:07 +00003584
3585
wdenk2729af92004-05-03 20:45:30 +00003586Initial Stack, Global Data:
3587---------------------------
wdenkc6097192002-11-03 00:24:07 +00003588
wdenk2729af92004-05-03 20:45:30 +00003589The implementation of U-Boot is complicated by the fact that U-Boot
3590starts running out of ROM (flash memory), usually without access to
3591system RAM (because the memory controller is not initialized yet).
3592This means that we don't have writable Data or BSS segments, and BSS
3593is not initialized as zero. To be able to get a C environment working
3594at all, we have to allocate at least a minimal stack. Implementation
3595options for this are defined and restricted by the CPU used: Some CPU
3596models provide on-chip memory (like the IMMR area on MPC8xx and
3597MPC826x processors), on others (parts of) the data cache can be
3598locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00003599
Wolfgang Denk218ca722008-03-26 10:40:12 +01003600 Chris Hallinan posted a good summary of these issues to the
wdenk2729af92004-05-03 20:45:30 +00003601 u-boot-users mailing list:
wdenk43d96162003-03-06 00:02:04 +00003602
wdenk2729af92004-05-03 20:45:30 +00003603 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
3604 From: "Chris Hallinan" <clh@net1plus.com>
3605 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
3606 ...
wdenk43d96162003-03-06 00:02:04 +00003607
wdenk2729af92004-05-03 20:45:30 +00003608 Correct me if I'm wrong, folks, but the way I understand it
3609 is this: Using DCACHE as initial RAM for Stack, etc, does not
3610 require any physical RAM backing up the cache. The cleverness
3611 is that the cache is being used as a temporary supply of
3612 necessary storage before the SDRAM controller is setup. It's
3613 beyond the scope of this list to expain the details, but you
3614 can see how this works by studying the cache architecture and
3615 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00003616
wdenk2729af92004-05-03 20:45:30 +00003617 OCM is On Chip Memory, which I believe the 405GP has 4K. It
3618 is another option for the system designer to use as an
3619 initial stack/ram area prior to SDRAM being available. Either
3620 option should work for you. Using CS 4 should be fine if your
3621 board designers haven't used it for something that would
3622 cause you grief during the initial boot! It is frequently not
3623 used.
wdenk43d96162003-03-06 00:02:04 +00003624
wdenk2729af92004-05-03 20:45:30 +00003625 CFG_INIT_RAM_ADDR should be somewhere that won't interfere
3626 with your processor/board/system design. The default value
3627 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02003628 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00003629 than your SDRAM module. If you have a 64MB SDRAM module, set
3630 it above 400_0000. Just make sure your board has no resources
3631 that are supposed to respond to that address! That code in
3632 start.S has been around a while and should work as is when
3633 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00003634
wdenk2729af92004-05-03 20:45:30 +00003635 -Chris Hallinan
3636 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00003637
wdenk2729af92004-05-03 20:45:30 +00003638It is essential to remember this, since it has some impact on the C
3639code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00003640
wdenk2729af92004-05-03 20:45:30 +00003641* Initialized global data (data segment) is read-only. Do not attempt
3642 to write it.
wdenkc6097192002-11-03 00:24:07 +00003643
wdenk2729af92004-05-03 20:45:30 +00003644* Do not use any unitialized global data (or implicitely initialized
3645 as zero data - BSS segment) at all - this is undefined, initiali-
3646 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00003647
wdenk2729af92004-05-03 20:45:30 +00003648* Stack space is very limited. Avoid big data buffers or things like
3649 that.
wdenkc6097192002-11-03 00:24:07 +00003650
wdenk2729af92004-05-03 20:45:30 +00003651Having only the stack as writable memory limits means we cannot use
3652normal global data to share information beween the code. But it
3653turned out that the implementation of U-Boot can be greatly
3654simplified by making a global data structure (gd_t) available to all
3655functions. We could pass a pointer to this data as argument to _all_
3656functions, but this would bloat the code. Instead we use a feature of
3657the GCC compiler (Global Register Variables) to share the data: we
3658place a pointer (gd) to the global data into a register which we
3659reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00003660
wdenk2729af92004-05-03 20:45:30 +00003661When choosing a register for such a purpose we are restricted by the
3662relevant (E)ABI specifications for the current architecture, and by
3663GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00003664
wdenk2729af92004-05-03 20:45:30 +00003665For PowerPC, the following registers have specific use:
3666 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01003667 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00003668 R3-R4: parameter passing and return values
3669 R5-R10: parameter passing
3670 R13: small data area pointer
3671 R30: GOT pointer
3672 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00003673
wdenk2729af92004-05-03 20:45:30 +00003674 (U-Boot also uses R14 as internal GOT pointer.)
wdenkc6097192002-11-03 00:24:07 +00003675
Wolfgang Denke7670f62008-02-14 22:43:22 +01003676 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00003677
wdenk2729af92004-05-03 20:45:30 +00003678 Note: on PPC, we could use a static initializer (since the
3679 address of the global data structure is known at compile time),
3680 but it turned out that reserving a register results in somewhat
3681 smaller code - although the code savings are not that big (on
3682 average for all boards 752 bytes for the whole U-Boot image,
3683 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00003684
Mike Frysinger4c58eb52008-02-04 19:26:54 -05003685On Blackfin, the normal C ABI (except for P5) is followed as documented here:
3686 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
3687
3688 ==> U-Boot will use P5 to hold a pointer to the global data
3689
wdenk2729af92004-05-03 20:45:30 +00003690On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00003691
wdenk2729af92004-05-03 20:45:30 +00003692 R0: function argument word/integer result
3693 R1-R3: function argument word
3694 R9: GOT pointer
3695 R10: stack limit (used only if stack checking if enabled)
3696 R11: argument (frame) pointer
3697 R12: temporary workspace
3698 R13: stack pointer
3699 R14: link register
3700 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00003701
wdenk2729af92004-05-03 20:45:30 +00003702 ==> U-Boot will use R8 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00003703
Wolfgang Denkd87080b2006-03-31 18:32:53 +02003704NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
3705or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00003706
wdenk2729af92004-05-03 20:45:30 +00003707Memory Management:
3708------------------
wdenkc6097192002-11-03 00:24:07 +00003709
wdenk2729af92004-05-03 20:45:30 +00003710U-Boot runs in system state and uses physical addresses, i.e. the
3711MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00003712
wdenk2729af92004-05-03 20:45:30 +00003713The available memory is mapped to fixed addresses using the memory
3714controller. In this process, a contiguous block is formed for each
3715memory type (Flash, SDRAM, SRAM), even when it consists of several
3716physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00003717
wdenk2729af92004-05-03 20:45:30 +00003718U-Boot is installed in the first 128 kB of the first Flash bank (on
3719TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
3720booting and sizing and initializing DRAM, the code relocates itself
3721to the upper end of DRAM. Immediately below the U-Boot code some
3722memory is reserved for use by malloc() [see CFG_MALLOC_LEN
3723configuration setting]. Below that, a structure with global Board
3724Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00003725
wdenk2729af92004-05-03 20:45:30 +00003726Additionally, some exception handler code is copied to the low 8 kB
3727of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00003728
wdenk2729af92004-05-03 20:45:30 +00003729So a typical memory configuration with 16 MB of DRAM could look like
3730this:
wdenkc6097192002-11-03 00:24:07 +00003731
wdenk2729af92004-05-03 20:45:30 +00003732 0x0000 0000 Exception Vector code
3733 :
3734 0x0000 1FFF
3735 0x0000 2000 Free for Application Use
3736 :
3737 :
wdenkc6097192002-11-03 00:24:07 +00003738
wdenk2729af92004-05-03 20:45:30 +00003739 :
3740 :
3741 0x00FB FF20 Monitor Stack (Growing downward)
3742 0x00FB FFAC Board Info Data and permanent copy of global data
3743 0x00FC 0000 Malloc Arena
3744 :
3745 0x00FD FFFF
3746 0x00FE 0000 RAM Copy of Monitor Code
3747 ... eventually: LCD or video framebuffer
3748 ... eventually: pRAM (Protected RAM - unchanged by reset)
3749 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00003750
3751
wdenk2729af92004-05-03 20:45:30 +00003752System Initialization:
3753----------------------
wdenkc6097192002-11-03 00:24:07 +00003754
wdenk2729af92004-05-03 20:45:30 +00003755In the reset configuration, U-Boot starts at the reset entry point
3756(on most PowerPC systens at address 0x00000100). Because of the reset
3757configuration for CS0# this is a mirror of the onboard Flash memory.
3758To be able to re-map memory U-Boot then jumps to its link address.
3759To be able to implement the initialization code in C, a (small!)
3760initial stack is set up in the internal Dual Ported RAM (in case CPUs
3761which provide such a feature like MPC8xx or MPC8260), or in a locked
3762part of the data cache. After that, U-Boot initializes the CPU core,
3763the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00003764
wdenk2729af92004-05-03 20:45:30 +00003765Next, all (potentially) available memory banks are mapped using a
3766preliminary mapping. For example, we put them on 512 MB boundaries
3767(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
3768on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
3769programmed for SDRAM access. Using the temporary configuration, a
3770simple memory test is run that determines the size of the SDRAM
3771banks.
wdenkc6097192002-11-03 00:24:07 +00003772
wdenk2729af92004-05-03 20:45:30 +00003773When there is more than one SDRAM bank, and the banks are of
3774different size, the largest is mapped first. For equal size, the first
3775bank (CS2#) is mapped first. The first mapping is always for address
37760x00000000, with any additional banks following immediately to create
3777contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00003778
wdenk2729af92004-05-03 20:45:30 +00003779Then, the monitor installs itself at the upper end of the SDRAM area
3780and allocates memory for use by malloc() and for the global Board
3781Info data; also, the exception vector code is copied to the low RAM
3782pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00003783
wdenk2729af92004-05-03 20:45:30 +00003784Only after this relocation will you have a "normal" C environment;
3785until that you are restricted in several ways, mostly because you are
3786running from ROM, and because the code will have to be relocated to a
3787new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00003788
3789
wdenk2729af92004-05-03 20:45:30 +00003790U-Boot Porting Guide:
3791----------------------
wdenkc6097192002-11-03 00:24:07 +00003792
wdenk2729af92004-05-03 20:45:30 +00003793[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
3794list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00003795
3796
wdenk2729af92004-05-03 20:45:30 +00003797int main (int argc, char *argv[])
3798{
3799 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00003800
wdenk2729af92004-05-03 20:45:30 +00003801 signal (SIGALRM, no_more_time);
3802 alarm (PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00003803
wdenk2729af92004-05-03 20:45:30 +00003804 if (available_money > available_manpower) {
3805 pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00003806 return 0;
3807 }
3808
wdenk2729af92004-05-03 20:45:30 +00003809 Download latest U-Boot source;
3810
3811 Subscribe to u-boot-users mailing list;
3812
3813 if (clueless) {
3814 email ("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00003815 }
3816
wdenk2729af92004-05-03 20:45:30 +00003817 while (learning) {
3818 Read the README file in the top level directory;
3819 Read http://www.denx.de/twiki/bin/view/DULG/Manual ;
3820 Read the source, Luke;
3821 }
wdenkc6097192002-11-03 00:24:07 +00003822
wdenk2729af92004-05-03 20:45:30 +00003823 if (available_money > toLocalCurrency ($2500)) {
3824 Buy a BDI2000;
3825 } else {
3826 Add a lot of aggravation and time;
3827 }
wdenkc6097192002-11-03 00:24:07 +00003828
wdenk2729af92004-05-03 20:45:30 +00003829 Create your own board support subdirectory;
wdenkc6097192002-11-03 00:24:07 +00003830
wdenk2729af92004-05-03 20:45:30 +00003831 Create your own board config file;
wdenk6aff3112002-12-17 01:51:00 +00003832
wdenk2729af92004-05-03 20:45:30 +00003833 while (!running) {
3834 do {
3835 Add / modify source code;
3836 } until (compiles);
3837 Debug;
3838 if (clueless)
3839 email ("Hi, I am having problems...");
3840 }
3841 Send patch file to Wolfgang;
wdenkc6097192002-11-03 00:24:07 +00003842
wdenk2729af92004-05-03 20:45:30 +00003843 return 0;
3844}
3845
3846void no_more_time (int sig)
3847{
3848 hire_a_guru();
3849}
wdenkc6097192002-11-03 00:24:07 +00003850
3851
wdenk2729af92004-05-03 20:45:30 +00003852Coding Standards:
3853-----------------
wdenkc6097192002-11-03 00:24:07 +00003854
wdenk2729af92004-05-03 20:45:30 +00003855All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02003856coding style; see the file "Documentation/CodingStyle" and the script
3857"scripts/Lindent" in your Linux kernel source directory. In sources
3858originating from U-Boot a style corresponding to "Lindent -pcs" (adding
3859spaces before parameters to function calls) is actually used.
wdenk2729af92004-05-03 20:45:30 +00003860
Detlev Zundel2c051652006-09-01 15:39:02 +02003861Source files originating from a different project (for example the
3862MTD subsystem) are generally exempt from these guidelines and are not
3863reformated to ease subsequent migration to newer versions of those
3864sources.
3865
3866Please note that U-Boot is implemented in C (and to some small parts in
3867Assembler); no C++ is used, so please do not use C++ style comments (//)
3868in your code.
wdenk2729af92004-05-03 20:45:30 +00003869
3870Please also stick to the following formatting rules:
3871- remove any trailing white space
3872- use TAB characters for indentation, not spaces
3873- make sure NOT to use DOS '\r\n' line feeds
3874- do not add more than 2 empty lines to source files
3875- do not add trailing empty lines to source files
3876
3877Submissions which do not conform to the standards may be returned
3878with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00003879
3880
wdenk2729af92004-05-03 20:45:30 +00003881Submitting Patches:
3882-------------------
wdenkc6097192002-11-03 00:24:07 +00003883
wdenk2729af92004-05-03 20:45:30 +00003884Since the number of patches for U-Boot is growing, we need to
3885establish some rules. Submissions which do not conform to these rules
3886may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00003887
wdenk90dc6702005-05-03 14:12:25 +00003888Patches shall be sent to the u-boot-users mailing list.
wdenkc6097192002-11-03 00:24:07 +00003889
Wolfgang Denk218ca722008-03-26 10:40:12 +01003890Please see http://www.denx.de/wiki/UBoot/Patches for details.
3891
wdenk2729af92004-05-03 20:45:30 +00003892When you send a patch, please include the following information with
3893it:
wdenkc6097192002-11-03 00:24:07 +00003894
wdenk2729af92004-05-03 20:45:30 +00003895* For bug fixes: a description of the bug and how your patch fixes
3896 this bug. Please try to include a way of demonstrating that the
3897 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00003898
wdenk2729af92004-05-03 20:45:30 +00003899* For new features: a description of the feature and your
3900 implementation.
wdenkc6097192002-11-03 00:24:07 +00003901
wdenk2729af92004-05-03 20:45:30 +00003902* A CHANGELOG entry as plaintext (separate from the patch)
3903
3904* For major contributions, your entry to the CREDITS file
3905
3906* When you add support for a new board, don't forget to add this
3907 board to the MAKEALL script, too.
3908
3909* If your patch adds new configuration options, don't forget to
3910 document these in the README file.
3911
Wolfgang Denk218ca722008-03-26 10:40:12 +01003912* The patch itself. If you are using git (which is *strongly*
3913 recommended) you can easily generate the patch using the
3914 "git-format-patch". If you then use "git-send-email" to send it to
3915 the U-Boot mailing list, you will avoid most of the common problems
3916 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00003917
Wolfgang Denk218ca722008-03-26 10:40:12 +01003918 If you cannot use git, use "diff -purN OLD NEW". If your version of
3919 diff does not support these options, then get the latest version of
3920 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00003921
Wolfgang Denk218ca722008-03-26 10:40:12 +01003922 The current directory when running this command shall be the parent
3923 directory of the U-Boot source tree (i. e. please make sure that
3924 your patch includes sufficient directory information for the
3925 affected files).
3926
3927 We prefer patches as plain text. MIME attachments are discouraged,
3928 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00003929
3930* If one logical set of modifications affects or creates several
3931 files, all these changes shall be submitted in a SINGLE patch file.
3932
3933* Changesets that contain different, unrelated modifications shall be
3934 submitted as SEPARATE patches, one patch per changeset.
3935
3936
3937Notes:
3938
3939* Before sending the patch, run the MAKEALL script on your patched
3940 source tree and make sure that no errors or warnings are reported
3941 for any of the boards.
3942
3943* Keep your modifications to the necessary minimum: A patch
3944 containing several unrelated changes or arbitrary reformats will be
3945 returned with a request to re-formatting / split it.
3946
3947* If you modify existing code, make sure that your new code does not
3948 add to the memory footprint of the code ;-) Small is beautiful!
3949 When adding new features, these should compile conditionally only
3950 (using #ifdef), and the resulting code with the new feature
3951 disabled must not need more memory than the old code without your
3952 modification.
wdenk90dc6702005-05-03 14:12:25 +00003953
3954* Remember that there is a size limit of 40 kB per message on the
Wolfgang Denk218ca722008-03-26 10:40:12 +01003955 u-boot-users mailing list. Bigger patches will be moderated. If
3956 they are reasonable and not bigger than 100 kB, they will be
3957 acknowledged. Even bigger patches should be avoided.