README 123 KB
Newer Older
wdenk's avatar
wdenk committed
1
#
2
# (C) Copyright 2000 - 2005
wdenk's avatar
wdenk committed
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
#
# See file CREDITS for list of people who contributed to this
# project.
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License as
# published by the Free Software Foundation; either version 2 of
# the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston,
# MA 02111-1307 USA
#

Summary:
========

27
This directory contains the source code for U-Boot, a boot loader for
wdenk's avatar
wdenk committed
28
29
30
31
Embedded boards based on PowerPC, ARM, MIPS and several other
processors, which can be installed in a boot ROM and used to
initialize and test the hardware or to download and run application
code.
wdenk's avatar
wdenk committed
32
33

The development of U-Boot is closely related to Linux: some parts of
34
35
the source code originate in the Linux source tree, we have some
header files in common, and special provision has been made to
wdenk's avatar
wdenk committed
36
37
38
39
40
41
42
43
44
45
46
47
48
49
support booting of Linux images.

Some attention has been paid to make this software easily
configurable and extendable. For instance, all monitor commands are
implemented with the same call interface, so that it's very easy to
add new commands. Also, instead of permanently adding rarely used
code (for instance hardware test utilities) to the monitor, you can
load and run it dynamically.


Status:
=======

In general, all boards for which a configuration option exists in the
50
Makefile have been tested to some extent and can be considered
wdenk's avatar
wdenk committed
51
52
"working". In fact, many of them are used in production systems.

53
In case of problems see the CHANGELOG and CREDITS files to find out
wdenk's avatar
wdenk committed
54
55
56
57
58
59
who contributed the specific port.


Where to get help:
==================

60
61
62
63
In case you have questions about, problems with or contributions for
U-Boot you should send a message to the U-Boot mailing list at
<u-boot-users@lists.sourceforge.net>. There is also an archive of
previous traffic on the mailing list - please search the archive
wdenk's avatar
wdenk committed
64
65
66
67
68
69
70
71
before asking FAQ's. Please see
http://lists.sourceforge.net/lists/listinfo/u-boot-users/


Where we come from:
===================

- start from 8xxrom sources
72
- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenk's avatar
wdenk committed
73
74
75
76
77
78
79
80
- clean up code
- make it easier to add custom boards
- make it possible to add other [PowerPC] CPUs
- extend functions, especially:
  * Provide extended interface to Linux boot loader
  * S-Record download
  * network boot
  * PCMCIA / CompactFLash / ATA disk / SCSI ... boot
81
- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenk's avatar
wdenk committed
82
- add other CPU families (starting with ARM)
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
- create U-Boot project (http://sourceforge.net/projects/u-boot)


Names and Spelling:
===================

The "official" name of this project is "Das U-Boot". The spelling
"U-Boot" shall be used in all written text (documentation, comments
in source files etc.). Example:

	This is the README file for the U-Boot project.

File names etc. shall be based on the string "u-boot". Examples:

	include/asm-ppc/u-boot.h

	#include <asm/u-boot.h>

Variable names, preprocessor constants etc. shall be either based on
the string "u_boot" or on "U_BOOT". Example:

	U_BOOT_VERSION		u_boot_logo
	IH_OS_U_BOOT		u_boot_hush_start
wdenk's avatar
wdenk committed
106
107


wdenk's avatar
wdenk committed
108
109
110
111
112
113
114
115
116
117
118
119
Versioning:
===========

U-Boot uses a 3 level version number containing a version, a
sub-version, and a patchlevel: "U-Boot-2.34.5" means version "2",
sub-version "34", and patchlevel "4".

The patchlevel is used to indicate certain stages of development
between released versions, i. e. officially released versions of
U-Boot will always have a patchlevel of "0".


wdenk's avatar
wdenk committed
120
121
122
Directory Hierarchy:
====================

wdenk's avatar
wdenk committed
123
124
- board		Board dependent files
- common	Misc architecture independent functions
wdenk's avatar
wdenk committed
125
- cpu		CPU specific files
wdenk's avatar
wdenk committed
126
  - 74xx_7xx	Files specific to Freescale MPC74xx and 7xx CPUs
wdenk's avatar
wdenk committed
127
128
  - arm720t	Files specific to ARM 720 CPUs
  - arm920t	Files specific to ARM 920 CPUs
wdenk's avatar
wdenk committed
129
    - at91rm9200 Files specific to Atmel AT91RM9200 CPU
wdenk's avatar
wdenk committed
130
    - imx	Files specific to Freescale MC9328 i.MX CPUs
wdenk's avatar
wdenk committed
131
    - s3c24x0	Files specific to Samsung S3C24X0 CPUs
wdenk's avatar
wdenk committed
132
133
  - arm925t	Files specific to ARM 925 CPUs
  - arm926ejs	Files specific to ARM 926 CPUs
134
  - arm1136	Files specific to ARM 1136 CPUs
135
  - at32ap	Files specific to Atmel AVR32 AP CPUs
wdenk's avatar
wdenk committed
136
137
  - i386	Files specific to i386 CPUs
  - ixp		Files specific to Intel XScale IXP CPUs
wdenk's avatar
wdenk committed
138
  - mcf52x2	Files specific to Freescale ColdFire MCF52x2 CPUs
wdenk's avatar
wdenk committed
139
  - mips	Files specific to MIPS CPUs
wdenk's avatar
wdenk committed
140
141
142
143
144
145
146
  - mpc5xx	Files specific to Freescale MPC5xx  CPUs
  - mpc5xxx	Files specific to Freescale MPC5xxx CPUs
  - mpc8xx	Files specific to Freescale MPC8xx  CPUs
  - mpc8220	Files specific to Freescale MPC8220 CPUs
  - mpc824x	Files specific to Freescale MPC824x CPUs
  - mpc8260	Files specific to Freescale MPC8260 CPUs
  - mpc85xx	Files specific to Freescale MPC85xx CPUs
wdenk's avatar
wdenk committed
147
  - nios	Files specific to Altera NIOS CPUs
wdenk's avatar
wdenk committed
148
  - nios2	Files specific to Altera Nios-II CPUs
Wolfgang Denk's avatar
Wolfgang Denk committed
149
  - ppc4xx	Files specific to AMCC PowerPC 4xx CPUs
wdenk's avatar
wdenk committed
150
151
152
  - pxa		Files specific to Intel XScale PXA CPUs
  - s3c44b0	Files specific to Samsung S3C44B0 CPUs
  - sa1100	Files specific to Intel StrongARM SA1100 CPUs
wdenk's avatar
wdenk committed
153
154
- disk		Code for disk drive partition handling
- doc		Documentation (don't expect too much)
wdenk's avatar
wdenk committed
155
- drivers	Commonly used device drivers
wdenk's avatar
wdenk committed
156
157
158
- dtt		Digital Thermometer and Thermostat drivers
- examples	Example code for standalone applications, etc.
- include	Header Files
wdenk's avatar
wdenk committed
159
- lib_arm	Files generic to ARM	 architecture
Wolfgang Denk's avatar
Wolfgang Denk committed
160
- lib_avr32	Files generic to AVR32	 architecture
wdenk's avatar
wdenk committed
161
162
163
164
165
166
- lib_generic	Files generic to all	 architectures
- lib_i386	Files generic to i386	 architecture
- lib_m68k	Files generic to m68k	 architecture
- lib_mips	Files generic to MIPS	 architecture
- lib_nios	Files generic to NIOS	 architecture
- lib_ppc	Files generic to PowerPC architecture
wdenk's avatar
wdenk committed
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
- net		Networking code
- post		Power On Self Test
- rtc		Real Time Clock drivers
- tools		Tools to build S-Record or U-Boot images, etc.

Software Configuration:
=======================

Configuration is usually done using C preprocessor defines; the
rationale behind that is to avoid dead code whenever possible.

There are two classes of configuration variables:

* Configuration _OPTIONS_:
  These are selectable by the user and have names beginning with
  "CONFIG_".

* Configuration _SETTINGS_:
  These depend on the hardware etc. and should not be meddled with if
  you don't know what you're doing; they have names beginning with
  "CFG_".

Later we will add a configuration tool - probably similar to or even
identical to what's used for the Linux kernel. Right now, we have to
do the configuration by hand, which means creating some symbolic
links and editing some configuration files. We use the TQM8xxL boards
as an example here.


Selection of Processor Architecture and Board Type:
---------------------------------------------------

For all supported boards there are ready-to-use default
configurations available; just type "make <board_name>_config".

Example: For a TQM823L module type:

	cd u-boot
	make TQM823L_config

For the Cogent platform, you need to specify the cpu type as well;
e.g. "make cogent_mpc8xx_config". And also configure the cogent
directory according to the instructions in cogent/README.


Configuration Options:
----------------------

Configuration depends on the combination of board and CPU type; all
such information is kept in a configuration file
"include/configs/<board_name>.h".

Example: For a TQM823L module, all configuration settings are in
"include/configs/TQM823L.h".


wdenk's avatar
wdenk committed
223
224
225
226
227
Many of the options are named exactly as the corresponding Linux
kernel configuration options. The intention is to make it easier to
build a config tool - later.


wdenk's avatar
wdenk committed
228
229
230
231
232
233
234
The following options need to be configured:

- CPU Type:	Define exactly one of

		PowerPC based CPUs:
		-------------------
		CONFIG_MPC823,	CONFIG_MPC850,	CONFIG_MPC855,	CONFIG_MPC860
235
	or	CONFIG_MPC5xx
wdenk's avatar
wdenk committed
236
	or	CONFIG_MPC8220
wdenk's avatar
wdenk committed
237
	or	CONFIG_MPC824X, CONFIG_MPC8260
238
	or	CONFIG_MPC85xx
wdenk's avatar
wdenk committed
239
240
	or	CONFIG_IOP480
	or	CONFIG_405GP
241
	or	CONFIG_405EP
wdenk's avatar
wdenk committed
242
243
	or	CONFIG_440
	or	CONFIG_MPC74xx
wdenk's avatar
wdenk committed
244
	or	CONFIG_750FX
wdenk's avatar
wdenk committed
245
246
247
248
249
250

		ARM based CPUs:
		---------------
		CONFIG_SA1110
		CONFIG_ARM7
		CONFIG_PXA250
251
		CONFIG_CPU_MONAHANS
wdenk's avatar
wdenk committed
252

wdenk's avatar
wdenk committed
253
254
		MicroBlaze based CPUs:
		----------------------
wdenk's avatar
wdenk committed
255
		CONFIG_MICROBLAZE
wdenk's avatar
wdenk committed
256

wdenk's avatar
wdenk committed
257
258
259
260
		Nios-2 based CPUs:
		----------------------
		CONFIG_NIOS2

261
262
263
		AVR32 based CPUs:
		----------------------
		CONFIG_AT32AP
wdenk's avatar
wdenk committed
264
265
266
267
268
269

- Board Type:	Define exactly one of

		PowerPC based boards:
		---------------------

270
271
272
273
274
275
276
		CONFIG_ADCIOP		CONFIG_FPS860L		CONFIG_OXC
		CONFIG_ADS860		CONFIG_GEN860T		CONFIG_PCI405
		CONFIG_AMX860		CONFIG_GENIETV		CONFIG_PCIPPC2
		CONFIG_AP1000		CONFIG_GTH		CONFIG_PCIPPC6
		CONFIG_AR405		CONFIG_gw8260		CONFIG_pcu_e
		CONFIG_BAB7xx		CONFIG_hermes		CONFIG_PIP405
		CONFIG_BC3450		CONFIG_hymod		CONFIG_PM826
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
		CONFIG_c2mon		CONFIG_IAD210		CONFIG_ppmc8260
		CONFIG_CANBT		CONFIG_ICU862		CONFIG_QS823
		CONFIG_CCM		CONFIG_IP860		CONFIG_QS850
		CONFIG_CMI		CONFIG_IPHASE4539	CONFIG_QS860T
		CONFIG_cogent_mpc8260	CONFIG_IVML24		CONFIG_RBC823
		CONFIG_cogent_mpc8xx	CONFIG_IVML24_128	CONFIG_RPXClassic
		CONFIG_CPCI405		CONFIG_IVML24_256	CONFIG_RPXlite
		CONFIG_CPCI4052		CONFIG_IVMS8		CONFIG_RPXsuper
		CONFIG_CPCIISER4	CONFIG_IVMS8_128	CONFIG_rsdproto
		CONFIG_CPU86		CONFIG_IVMS8_256	CONFIG_sacsng
		CONFIG_CRAYL1		CONFIG_JSE		CONFIG_Sandpoint8240
		CONFIG_CSB272		CONFIG_LANTEC		CONFIG_Sandpoint8245
		CONFIG_CU824		CONFIG_LITE5200B	CONFIG_sbc8260
		CONFIG_DASA_SIM		CONFIG_lwmon		CONFIG_sbc8560
		CONFIG_DB64360		CONFIG_MBX		CONFIG_SM850
		CONFIG_DB64460		CONFIG_MBX860T		CONFIG_SPD823TS
		CONFIG_DU405		CONFIG_MHPC		CONFIG_STXGP3
		CONFIG_DUET_ADS		CONFIG_MIP405		CONFIG_SXNI855T
		CONFIG_EBONY		CONFIG_MOUSSE		CONFIG_TQM823L
		CONFIG_ELPPC		CONFIG_MPC8260ADS	CONFIG_TQM8260
		CONFIG_ELPT860		CONFIG_MPC8540ADS	CONFIG_TQM850L
		CONFIG_ep8260		CONFIG_MPC8540EVAL	CONFIG_TQM855L
		CONFIG_ERIC		CONFIG_MPC8560ADS	CONFIG_TQM860L
		CONFIG_ESTEEM192E	CONFIG_MUSENKI		CONFIG_TTTech
		CONFIG_ETX094		CONFIG_MVS1		CONFIG_UTX8245
		CONFIG_EVB64260		CONFIG_NETPHONE		CONFIG_V37
		CONFIG_FADS823		CONFIG_NETTA		CONFIG_W7OLMC
		CONFIG_FADS850SAR	CONFIG_NETVIA		CONFIG_W7OLMG
		CONFIG_FADS860T		CONFIG_NX823		CONFIG_WALNUT
		CONFIG_FLAGADM		CONFIG_OCRTC		CONFIG_ZPC1900
		CONFIG_FPS850L		CONFIG_ORSG		CONFIG_ZUMA
308

wdenk's avatar
wdenk committed
309
310
311
		ARM based boards:
		-----------------

312
		CONFIG_ARMADILLO,	CONFIG_AT91RM9200DK,	CONFIG_CERF250,
313
		CONFIG_CSB637,		CONFIG_DELTA,		CONFIG_DNP1110,
Wolfgang Denk's avatar
Wolfgang Denk committed
314
		CONFIG_EP7312,		CONFIG_H2_OMAP1610,	CONFIG_HHP_CRADLE,
Wolfgang Denk's avatar
Wolfgang Denk committed
315
		CONFIG_IMPA7,	    CONFIG_INNOVATOROMAP1510,	CONFIG_INNOVATOROMAP1610,
316
317
		CONFIG_KB9202,		CONFIG_LART,		CONFIG_LPD7A400,
		CONFIG_LUBBOCK,		CONFIG_OSK_OMAP5912,	CONFIG_OMAP2420H4,
318
319
320
		CONFIG_PLEB2,		CONFIG_SHANNON,		CONFIG_P2_OMAP730,
		CONFIG_SMDK2400,	CONFIG_SMDK2410,	CONFIG_TRAB,
		CONFIG_VCMA9
wdenk's avatar
wdenk committed
321

wdenk's avatar
wdenk committed
322
323
324
325
326
		MicroBlaze based boards:
		------------------------

		CONFIG_SUZAKU

wdenk's avatar
wdenk committed
327
328
329
330
		Nios-2 based boards:
		------------------------

		CONFIG_PCI5441 CONFIG_PK1C20
331
		CONFIG_EP1C20 CONFIG_EP1S10 CONFIG_EP1S40
wdenk's avatar
wdenk committed
332

333
334
335
336
337
338
339
340
341
		AVR32 based boards:
		-------------------

		CONFIG_ATSTK1000

- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
		Define exactly one of
		CONFIG_ATSTK1002

wdenk's avatar
wdenk committed
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363

- CPU Module Type: (if CONFIG_COGENT is defined)
		Define exactly one of
		CONFIG_CMA286_60_OLD
--- FIXME --- not tested yet:
		CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
		CONFIG_CMA287_23, CONFIG_CMA287_50

- Motherboard Type: (if CONFIG_COGENT is defined)
		Define exactly one of
		CONFIG_CMA101, CONFIG_CMA102

- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
		Define one or more of
		CONFIG_CMA302

- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
		Define one or more of
		CONFIG_LCD_HEARTBEAT	- update a character position on
					  the lcd display every second with
					  a "rotator" |\-/|\-/

wdenk's avatar
wdenk committed
364
365
366
367
- Board flavour: (if CONFIG_MPC8260ADS is defined)
		CONFIG_ADSTYPE
		Possible values are:
			CFG_8260ADS	- original MPC8260ADS
368
			CFG_8266ADS	- MPC8266ADS
wdenk's avatar
wdenk committed
369
			CFG_PQ2FADS	- PQ2FADS-ZU or PQ2FADS-VR
370
			CFG_8272ADS	- MPC8272ADS
wdenk's avatar
wdenk committed
371

wdenk's avatar
wdenk committed
372
- MPC824X Family Member (if CONFIG_MPC824X is defined)
wdenk's avatar
wdenk committed
373
374
		Define exactly one of
		CONFIG_MPC8240, CONFIG_MPC8245
wdenk's avatar
wdenk committed
375

376
- 8xx CPU Options: (if using an MPC8xx cpu)
wdenk's avatar
wdenk committed
377
378
		CONFIG_8xx_GCLK_FREQ	- deprecated: CPU clock if
					  get_gclk_freq() cannot work
wdenk's avatar
wdenk committed
379
380
					  e.g. if there is no 32KHz
					  reference PIT/RTC clock
wdenk's avatar
wdenk committed
381
382
		CONFIG_8xx_OSCLK	- PLL input clock (either EXTCLK
					  or XTAL/EXTAL)
wdenk's avatar
wdenk committed
383

wdenk's avatar
wdenk committed
384
385
386
387
- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
		CFG_8xx_CPUCLK_MIN
		CFG_8xx_CPUCLK_MAX
		CONFIG_8xx_CPUCLK_DEFAULT
388
389
390
391
			See doc/README.MPC866

		CFG_MEASURE_CPUCLK

wdenk's avatar
wdenk committed
392
393
394
395
396
		Define this to measure the actual CPU clock instead
		of relying on the correctness of the configured
		values. Mostly useful for board bringup to make sure
		the PLL is locked at the intended frequency. Note
		that this requires a (stable) reference clock (32 kHz
wdenk's avatar
wdenk committed
397
		RTC clock or CFG_8XX_XIN)
398

399
400
401
402
403
404
405
406
- Intel Monahans options:
		CFG_MONAHANS_RUN_MODE_OSC_RATIO

		Defines the Monahans run mode to oscillator
		ratio. Valid values are 8, 16, 24, 31. The core
		frequency is this value multiplied by 13 MHz.

		CFG_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denk's avatar
Wolfgang Denk committed
407

408
409
		Defines the Monahans turbo mode to oscillator
		ratio. Valid values are 1 (default if undefined) and
Wolfgang Denk's avatar
Wolfgang Denk committed
410
		2. The core frequency as calculated above is multiplied
411
		by this value.
Wolfgang Denk's avatar
Wolfgang Denk committed
412

wdenk's avatar
wdenk committed
413
- Linux Kernel Interface:
wdenk's avatar
wdenk committed
414
415
416
417
418
419
420
421
422
423
424
425
426
		CONFIG_CLOCKS_IN_MHZ

		U-Boot stores all clock information in Hz
		internally. For binary compatibility with older Linux
		kernels (which expect the clocks passed in the
		bd_info data to be in MHz) the environment variable
		"clocks_in_mhz" can be defined so that U-Boot
		converts clock data to MHZ before passing it to the
		Linux kernel.
		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
		"clocks_in_mhz=1" is  automatically  included  in  the
		default environment.

wdenk's avatar
wdenk committed
427
428
429
430
431
432
		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]

		When transfering memsize parameter to linux, some versions
		expect it to be in bytes, others in MB.
		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.

433
434
435
436
437
438
439
440
441
442
443
444
		CONFIG_OF_FLAT_TREE

		New kernel versions are expecting firmware settings to be
		passed using flat open firmware trees.
		The environment variable "disable_of", when set, disables this
		functionality.

		CONFIG_OF_FLAT_TREE_MAX_SIZE

		The maximum size of the constructed OF tree.

		OF_CPU - The proper name of the cpus node.
Kumar Gala's avatar
Kumar Gala committed
445
		OF_SOC - The proper name of the soc node.
446
		OF_TBCLK - The timebase frequency.
Kumar Gala's avatar
Kumar Gala committed
447
		OF_STDOUT_PATH - The path to the console device
448

449
450
451
452
453
454
		CONFIG_OF_HAS_BD_T

		The resulting flat device tree will have a copy of the bd_t.
		Space should be pre-allocated in the dts for the bd_t.

		CONFIG_OF_HAS_UBOOT_ENV
455

456
457
458
		The resulting flat device tree will have a copy of u-boot's
		environment variables

459
460
461
462
		CONFIG_OF_BOARD_SETUP

		Board code has addition modification that it wants to make
		to the flat device tree before handing it off to the kernel
463

464
465
466
467
468
		CONFIG_OF_BOOT_CPU

		This define fills in the correct boot cpu in the boot
		param header, the default value is zero if undefined.

wdenk's avatar
wdenk committed
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
- Serial Ports:
		CFG_PL010_SERIAL

		Define this if you want support for Amba PrimeCell PL010 UARTs.

		CFG_PL011_SERIAL

		Define this if you want support for Amba PrimeCell PL011 UARTs.

		CONFIG_PL011_CLOCK

		If you have Amba PrimeCell PL011 UARTs, set this variable to
		the clock speed of the UARTs.

		CONFIG_PL01x_PORTS

		If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
		define this to a list of base addresses for each (supported)
		port. See e.g. include/configs/versatile.h


wdenk's avatar
wdenk committed
490
- Console Interface:
491
492
493
494
		Depending on board, define exactly one serial port
		(like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
		CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
		console by defining CONFIG_8xx_CONS_NONE
wdenk's avatar
wdenk committed
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511

		Note: if CONFIG_8xx_CONS_NONE is defined, the serial
		port routines must be defined elsewhere
		(i.e. serial_init(), serial_getc(), ...)

		CONFIG_CFB_CONSOLE
		Enables console device for a color framebuffer. Needs following
		defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
			VIDEO_FB_LITTLE_ENDIAN	graphic memory organisation
						(default big endian)
			VIDEO_HW_RECTFILL	graphic chip supports
						rectangle fill
						(cf. smiLynxEM)
			VIDEO_HW_BITBLT		graphic chip supports
						bit-blit (cf. smiLynxEM)
			VIDEO_VISIBLE_COLS	visible pixel columns
						(cols=pitch)
wdenk's avatar
wdenk committed
512
513
			VIDEO_VISIBLE_ROWS	visible pixel rows
			VIDEO_PIXEL_SIZE	bytes per pixel
wdenk's avatar
wdenk committed
514
515
			VIDEO_DATA_FORMAT	graphic data format
						(0-5, cf. cfb_console.c)
wdenk's avatar
wdenk committed
516
			VIDEO_FB_ADRS		framebuffer address
wdenk's avatar
wdenk committed
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
			VIDEO_KBD_INIT_FCT	keyboard int fct
						(i.e. i8042_kbd_init())
			VIDEO_TSTC_FCT		test char fct
						(i.e. i8042_tstc)
			VIDEO_GETC_FCT		get char fct
						(i.e. i8042_getc)
			CONFIG_CONSOLE_CURSOR	cursor drawing on/off
						(requires blink timer
						cf. i8042.c)
			CFG_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
			CONFIG_CONSOLE_TIME	display time/date info in
						upper right corner
						(requires CFG_CMD_DATE)
			CONFIG_VIDEO_LOGO	display Linux logo in
						upper left corner
532
533
534
			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
						linux_logo.h for logo.
						Requires CONFIG_VIDEO_LOGO
wdenk's avatar
wdenk committed
535
536
537
538
			CONFIG_CONSOLE_EXTRA_INFO
						addional board info beside
						the logo

539
540
541
		When CONFIG_CFB_CONSOLE is defined, video console is
		default i/o. Serial console can be forced with
		environment 'console=serial'.
wdenk's avatar
wdenk committed
542

wdenk's avatar
wdenk committed
543
544
545
546
		When CONFIG_SILENT_CONSOLE is defined, all console
		messages (by U-Boot and Linux!) can be silenced with
		the "silent" environment variable. See
		doc/README.silent for more information.
wdenk's avatar
wdenk committed
547

wdenk's avatar
wdenk committed
548
549
550
551
- Console Baudrate:
		CONFIG_BAUDRATE - in bps
		Select one of the baudrates listed in
		CFG_BAUDRATE_TABLE, see below.
wdenk's avatar
wdenk committed
552
		CFG_BRGCLK_PRESCALE, baudrate prescale
wdenk's avatar
wdenk committed
553
554
555
556
557
558
559
560
561
562

- Interrupt driven serial port input:
		CONFIG_SERIAL_SOFTWARE_FIFO

		PPC405GP only.
		Use an interrupt handler for receiving data on the
		serial port. It also enables using hardware handshake
		(RTS/CTS) and UART's built-in FIFO. Set the number of
		bytes the interrupt driven input buffer should have.

563
564
		Leave undefined to disable this feature, including
		disable the buffer and hardware handshake.
wdenk's avatar
wdenk committed
565

stroese's avatar
stroese committed
566
567
568
- Console UART Number:
		CONFIG_UART1_CONSOLE

Wolfgang Denk's avatar
Wolfgang Denk committed
569
		AMCC PPC4xx only.
stroese's avatar
stroese committed
570
571
572
		If defined internal UART1 (and not UART0) is used
		as default U-Boot console.

wdenk's avatar
wdenk committed
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
- Boot Delay:	CONFIG_BOOTDELAY - in seconds
		Delay before automatically booting the default image;
		set to -1 to disable autoboot.

		See doc/README.autoboot for these options that
		work with CONFIG_BOOTDELAY. None are required.
		CONFIG_BOOT_RETRY_TIME
		CONFIG_BOOT_RETRY_MIN
		CONFIG_AUTOBOOT_KEYED
		CONFIG_AUTOBOOT_PROMPT
		CONFIG_AUTOBOOT_DELAY_STR
		CONFIG_AUTOBOOT_STOP_STR
		CONFIG_AUTOBOOT_DELAY_STR2
		CONFIG_AUTOBOOT_STOP_STR2
		CONFIG_ZERO_BOOTDELAY_CHECK
		CONFIG_RESET_TO_RETRY

- Autoboot Command:
		CONFIG_BOOTCOMMAND
		Only needed when CONFIG_BOOTDELAY is enabled;
		define a command string that is automatically executed
		when no character is read on the console interface
		within "Boot Delay" after reset.

		CONFIG_BOOTARGS
598
599
600
		This can be used to pass arguments to the bootm
		command. The value of CONFIG_BOOTARGS goes into the
		environment value "bootargs".
wdenk's avatar
wdenk committed
601
602

		CONFIG_RAMBOOT and CONFIG_NFSBOOT
603
604
605
606
		The value of these goes into the environment as
		"ramboot" and "nfsboot" respectively, and can be used
		as a convenience, when switching between booting from
		ram and nfs.
wdenk's avatar
wdenk committed
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648

- Pre-Boot Commands:
		CONFIG_PREBOOT

		When this option is #defined, the existence of the
		environment variable "preboot" will be checked
		immediately before starting the CONFIG_BOOTDELAY
		countdown and/or running the auto-boot command resp.
		entering interactive mode.

		This feature is especially useful when "preboot" is
		automatically generated or modified. For an example
		see the LWMON board specific code: here "preboot" is
		modified when the user holds down a certain
		combination of keys on the (special) keyboard when
		booting the systems

- Serial Download Echo Mode:
		CONFIG_LOADS_ECHO
		If defined to 1, all characters received during a
		serial download (using the "loads" command) are
		echoed back. This might be needed by some terminal
		emulations (like "cu"), but may as well just take
		time on others. This setting #define's the initial
		value of the "loads_echo" environment variable.

- Kgdb Serial Baudrate: (if CFG_CMD_KGDB is defined)
		CONFIG_KGDB_BAUDRATE
		Select one of the baudrates listed in
		CFG_BAUDRATE_TABLE, see below.

- Monitor Functions:
		CONFIG_COMMANDS
		Most monitor functions can be selected (or
		de-selected) by adjusting the definition of
		CONFIG_COMMANDS; to select individual functions,
		#define CONFIG_COMMANDS by "OR"ing any of the
		following values:

		#define enables commands:
		-------------------------
		CFG_CMD_ASKENV	* ask for env variable
wdenk's avatar
wdenk committed
649
		CFG_CMD_AUTOSCRIPT Autoscript Support
wdenk's avatar
wdenk committed
650
		CFG_CMD_BDI	  bdinfo
wdenk's avatar
wdenk committed
651
		CFG_CMD_BEDBUG	* Include BedBug Debugger
wdenk's avatar
wdenk committed
652
		CFG_CMD_BMP	* BMP support
wdenk's avatar
wdenk committed
653
		CFG_CMD_BSP	* Board specific commands
wdenk's avatar
wdenk committed
654
		CFG_CMD_BOOTD	  bootd
wdenk's avatar
wdenk committed
655
		CFG_CMD_CACHE	* icache, dcache
wdenk's avatar
wdenk committed
656
657
		CFG_CMD_CONSOLE	  coninfo
		CFG_CMD_DATE	* support for RTC, date/time...
wdenk's avatar
wdenk committed
658
		CFG_CMD_DHCP	* DHCP support
wdenk's avatar
wdenk committed
659
660
		CFG_CMD_DIAG	* Diagnostics
		CFG_CMD_DOC	* Disk-On-Chip Support
wdenk's avatar
wdenk committed
661
		CFG_CMD_DTT	* Digital Therm and Thermostat
662
		CFG_CMD_ECHO	  echo arguments
wdenk's avatar
wdenk committed
663
		CFG_CMD_EEPROM	* EEPROM read/write support
wdenk's avatar
wdenk committed
664
		CFG_CMD_ELF	* bootelf, bootvx
wdenk's avatar
wdenk committed
665
666
		CFG_CMD_ENV	  saveenv
		CFG_CMD_FDC	* Floppy Disk Support
wdenk's avatar
wdenk committed
667
		CFG_CMD_FAT	* FAT partition support
668
		CFG_CMD_FDOS	* Dos diskette Support
wdenk's avatar
wdenk committed
669
670
		CFG_CMD_FLASH	  flinfo, erase, protect
		CFG_CMD_FPGA	  FPGA device initialization support
wdenk's avatar
wdenk committed
671
		CFG_CMD_HWFLOW	* RTS/CTS hw flow control
wdenk's avatar
wdenk committed
672
673
674
		CFG_CMD_I2C	* I2C serial bus support
		CFG_CMD_IDE	* IDE harddisk support
		CFG_CMD_IMI	  iminfo
wdenk's avatar
wdenk committed
675
		CFG_CMD_IMLS	  List all found images
wdenk's avatar
wdenk committed
676
677
		CFG_CMD_IMMAP	* IMMR dump support
		CFG_CMD_IRQ	* irqinfo
wdenk's avatar
wdenk committed
678
		CFG_CMD_ITEST	  Integer/string test of 2 values
wdenk's avatar
wdenk committed
679
		CFG_CMD_JFFS2	* JFFS2 Support
wdenk's avatar
wdenk committed
680
681
682
683
		CFG_CMD_KGDB	* kgdb
		CFG_CMD_LOADB	  loadb
		CFG_CMD_LOADS	  loads
		CFG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
wdenk's avatar
wdenk committed
684
				  loop, loopw, mtest
wdenk's avatar
wdenk committed
685
		CFG_CMD_MISC	  Misc functions like sleep etc
wdenk's avatar
wdenk committed
686
687
		CFG_CMD_MMC	* MMC memory mapped support
		CFG_CMD_MII	* MII utility commands
wdenk's avatar
wdenk committed
688
		CFG_CMD_NAND	* NAND support
wdenk's avatar
wdenk committed
689
690
691
		CFG_CMD_NET	  bootp, tftpboot, rarpboot
		CFG_CMD_PCI	* pciinfo
		CFG_CMD_PCMCIA	* PCMCIA support
wdenk's avatar
wdenk committed
692
693
		CFG_CMD_PING	* send ICMP ECHO_REQUEST to network host
		CFG_CMD_PORTIO	* Port I/O
wdenk's avatar
wdenk committed
694
695
		CFG_CMD_REGINFO * Register dump
		CFG_CMD_RUN	  run command in env variable
wdenk's avatar
wdenk committed
696
		CFG_CMD_SAVES	* save S record dump
wdenk's avatar
wdenk committed
697
		CFG_CMD_SCSI	* SCSI Support
wdenk's avatar
wdenk committed
698
		CFG_CMD_SDRAM	* print SDRAM configuration information
699
				  (requires CFG_CMD_I2C)
wdenk's avatar
wdenk committed
700
701
702
		CFG_CMD_SETGETDCR Support for DCR Register access (4xx only)
		CFG_CMD_SPI	* SPI serial bus support
		CFG_CMD_USB	* USB support
wdenk's avatar
wdenk committed
703
		CFG_CMD_VFD	* VFD support (TRAB)
wdenk's avatar
wdenk committed
704
		CFG_CMD_BSP	* Board SPecific functions
705
		CFG_CMD_CDP	* Cisco Discover Protocol support
wdenk's avatar
wdenk committed
706
707
708
		-----------------------------------------------
		CFG_CMD_ALL	all

wdenk's avatar
wdenk committed
709
		CONFIG_CMD_DFL	Default configuration; at the moment
wdenk's avatar
wdenk committed
710
711
712
713
714
				this is includes all commands, except
				the ones marked with "*" in the list
				above.

		If you don't define CONFIG_COMMANDS it defaults to
wdenk's avatar
wdenk committed
715
		CONFIG_CMD_DFL in include/cmd_confdefs.h. A board can
wdenk's avatar
wdenk committed
716
717
718
719
720
721
722
723
724
725
		override the default settings in the respective
		include file.

		EXAMPLE: If you want all functions except of network
		support you can write:

		#define CONFIG_COMMANDS (CFG_CMD_ALL & ~CFG_CMD_NET)


	Note:	Don't enable the "icache" and "dcache" commands
726
727
728
729
730
731
732
		(configuration option CFG_CMD_CACHE) unless you know
		what you (and your U-Boot users) are doing. Data
		cache cannot be enabled on systems like the 8xx or
		8260 (where accesses to the IMMR region must be
		uncached), and it cannot be disabled on all other
		systems where we (mis-) use the data cache to hold an
		initial stack and some data.
wdenk's avatar
wdenk committed
733
734
735
736
737
738
739


		XXX - this list needs to get updated!

- Watchdog:
		CONFIG_WATCHDOG
		If this variable is defined, it enables watchdog
wdenk's avatar
wdenk committed
740
		support. There must be support in the platform specific
wdenk's avatar
wdenk committed
741
742
743
744
		code for a watchdog. For the 8xx and 8260 CPUs, the
		SIU Watchdog feature is enabled in the SYPCR
		register.

745
746
747
748
749
750
751
- U-Boot Version:
		CONFIG_VERSION_VARIABLE
		If this variable is defined, an environment variable
		named "ver" is created by U-Boot showing the U-Boot
		version as printed by the "version" command.
		This variable is readonly.

wdenk's avatar
wdenk committed
752
753
754
755
756
757
758
759
760
- Real-Time Clock:

		When CFG_CMD_DATE is selected, the type of the RTC
		has to be selected, too. Define exactly one of the
		following options:

		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
		CONFIG_RTC_MC146818	- use MC146818 RTC
wdenk's avatar
wdenk committed
761
		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
wdenk's avatar
wdenk committed
762
		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
763
		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
wdenk's avatar
wdenk committed
764
		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
wdenk's avatar
wdenk committed
765
		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
wdenk's avatar
wdenk committed
766

wdenk's avatar
wdenk committed
767
768
769
		Note that if the RTC uses I2C, then the I2C interface
		must also be configured. See I2C Support, below.

wdenk's avatar
wdenk committed
770
771
- Timestamp Support:

772
773
774
775
		When CONFIG_TIMESTAMP is selected, the timestamp
		(date and time) of an image is printed by image
		commands like bootm or iminfo. This option is
		automatically enabled when you select CFG_CMD_DATE .
wdenk's avatar
wdenk committed
776
777
778
779
780
781
782
783
784
785

- Partition Support:
		CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
		and/or CONFIG_ISO_PARTITION

		If IDE or SCSI support	is  enabled  (CFG_CMD_IDE  or
		CFG_CMD_SCSI) you must configure support for at least
		one partition type as well.

- IDE Reset method:
wdenk's avatar
wdenk committed
786
787
		CONFIG_IDE_RESET_ROUTINE - this is defined in several
		board configurations files but used nowhere!
wdenk's avatar
wdenk committed
788

wdenk's avatar
wdenk committed
789
790
791
792
		CONFIG_IDE_RESET - is this is defined, IDE Reset will
		be performed by calling the function
			ide_set_reset(int reset)
		which has to be defined in a board specific file
wdenk's avatar
wdenk committed
793
794
795
796
797
798

- ATAPI Support:
		CONFIG_ATAPI

		Set this to enable ATAPI support.

799
800
801
802
803
804
805
806
807
808
809
810
- LBA48 Support
		CONFIG_LBA48

		Set this to enable support for disks larger than 137GB
		Also look at CFG_64BIT_LBA ,CFG_64BIT_VSPRINTF and CFG_64BIT_STRTOUL
		Whithout these , LBA48 support uses 32bit variables and will 'only'
		support disks up to 2.1TB.

		CFG_64BIT_LBA:
			When enabled, makes the IDE subsystem use 64bit sector addresses.
			Default is 32bit.

wdenk's avatar
wdenk committed
811
812
813
814
815
816
817
818
819
820
821
822
823
- SCSI Support:
		At the moment only there is only support for the
		SYM53C8XX SCSI controller; define
		CONFIG_SCSI_SYM53C8XX to enable it.

		CFG_SCSI_MAX_LUN [8], CFG_SCSI_MAX_SCSI_ID [7] and
		CFG_SCSI_MAX_DEVICE [CFG_SCSI_MAX_SCSI_ID *
		CFG_SCSI_MAX_LUN] can be adjusted to define the
		maximum numbers of LUNs, SCSI ID's and target
		devices.
		CFG_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)

- NETWORK Support (PCI):
824
825
		CONFIG_E1000
		Support for Intel 8254x gigabit chips.
stroese's avatar
stroese committed
826

wdenk's avatar
wdenk committed
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
		CONFIG_EEPRO100
		Support for Intel 82557/82559/82559ER chips.
		Optional CONFIG_EEPRO100_SROM_WRITE enables eeprom
		write routine for first time initialisation.

		CONFIG_TULIP
		Support for Digital 2114x chips.
		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
		modem chip initialisation (KS8761/QS6611).

		CONFIG_NATSEMI
		Support for National dp83815 chips.

		CONFIG_NS8382X
		Support for National dp8382[01] gigabit chips.

wdenk's avatar
wdenk committed
843
844
845
846
847
848
849
850
851
852
853
854
- NETWORK Support (other):

		CONFIG_DRIVER_LAN91C96
		Support for SMSC's LAN91C96 chips.

			CONFIG_LAN91C96_BASE
			Define this to hold the physical address
			of the LAN91C96's I/O space

			CONFIG_LAN91C96_USE_32_BIT
			Define this to enable 32 bit addressing

wdenk's avatar
wdenk committed
855
856
857
858
859
860
861
862
863
864
865
866
867
868
		CONFIG_DRIVER_SMC91111
		Support for SMSC's LAN91C111 chip

			CONFIG_SMC91111_BASE
			Define this to hold the physical address
			of the device (I/O space)

			CONFIG_SMC_USE_32_BIT
			Define this if data bus is 32 bits

			CONFIG_SMC_USE_IOFUNCS
			Define this to use i/o functions instead of macros
			(some hardware wont work with macros)

wdenk's avatar
wdenk committed
869
870
- USB Support:
		At the moment only the UHCI host controller is
wdenk's avatar
wdenk committed
871
		supported (PIP405, MIP405, MPC5200); define
wdenk's avatar
wdenk committed
872
873
		CONFIG_USB_UHCI to enable it.
		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk's avatar
wdenk committed
874
		and define CONFIG_USB_STORAGE to enable the USB
wdenk's avatar
wdenk committed
875
876
877
878
		storage devices.
		Note:
		Supported are USB Keyboards and USB Floppy drives
		(TEAC FD-05PUB).
wdenk's avatar
wdenk committed
879
880
881
882
883
884
885
		MPC5200 USB requires additional defines:
			CONFIG_USB_CLOCK
				for 528 MHz Clock: 0x0001bbbb
			CONFIG_USB_CONFIG
				for differential drivers: 0x00001000
				for single ended drivers: 0x00005000

wdenk's avatar
wdenk committed
886

887
- MMC Support:
wdenk's avatar
wdenk committed
888
889
890
		The MMC controller on the Intel PXA is supported. To
		enable this define CONFIG_MMC. The MMC can be
		accessed from the boot prompt by mapping the device
891
892
		to physical memory similar to flash. Command line is
		enabled with CFG_CMD_MMC. The MMC driver also works with
wdenk's avatar
wdenk committed
893
		the FAT fs. This is enabled with CFG_CMD_FAT.
894

wdenk's avatar
wdenk committed
895
896
897
898
899
900
901
902
903
904
905
906
907
908
- Journaling Flash filesystem support:
		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
		CONFIG_JFFS2_NAND_DEV
		Define these for a default partition on a NAND device

		CFG_JFFS2_FIRST_SECTOR,
		CFG_JFFS2_FIRST_BANK, CFG_JFFS2_NUM_BANKS
		Define these for a default partition on a NOR device

		CFG_JFFS_CUSTOM_PART
		Define this to create an own partition. You have to provide a
		function struct part_info* jffs2_part_info(int part_num)

		If you define only one JFFS2 partition you may also want to
wdenk's avatar
wdenk committed
909
		#define CFG_JFFS_SINGLE_PART	1
wdenk's avatar
wdenk committed
910
911
912
		to disable the command chpart. This is the default when you
		have not defined a custom partition

wdenk's avatar
wdenk committed
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
- Keyboard Support:
		CONFIG_ISA_KEYBOARD

		Define this to enable standard (PC-Style) keyboard
		support

		CONFIG_I8042_KBD
		Standard PC keyboard driver with US (is default) and
		GERMAN key layout (switch via environment 'keymap=de') support.
		Export function i8042_kbd_init, i8042_tstc and i8042_getc
		for cfb_console. Supports cursor blinking.

- Video support:
		CONFIG_VIDEO

		Define this to enable video support (for output to
		video).

		CONFIG_VIDEO_CT69000

		Enable Chips & Technologies 69000 Video chip

		CONFIG_VIDEO_SMI_LYNXEM
wdenk's avatar
wdenk committed
936
		Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenk's avatar
wdenk committed
937
938
939
940
		video output is selected via environment 'videoout'
		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
		assumed.

wdenk's avatar
wdenk committed
941
942
		For the CT69000 and SMI_LYNXEM drivers, videomode is
		selected via environment 'videomode'. Two diferent ways
wdenk's avatar
wdenk committed
943
944
		are possible:
		- "videomode=num"   'num' is a standard LiLo mode numbers.
wdenk's avatar
wdenk committed
945
		Following standard modes are supported	(* is default):
wdenk's avatar
wdenk committed
946
947
948
949
950
951
952
953

		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
		-------------+---------------------------------------------
		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
		-------------+---------------------------------------------
wdenk's avatar
wdenk committed
954
955
		(i.e. setenv videomode 317; saveenv; reset;)

wdenk's avatar
wdenk committed
956
		- "videomode=bootargs" all the video parameters are parsed
wdenk's avatar
wdenk committed
957
958
959
		from the bootargs. (See drivers/videomodes.c)


960
		CONFIG_VIDEO_SED13806
961
		Enable Epson SED13806 driver. This driver supports 8bpp
962
963
964
		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
		or CONFIG_VIDEO_SED13806_16BPP

965
- Keyboard Support:
wdenk's avatar
wdenk committed
966
		CONFIG_KEYBOARD
967

wdenk's avatar
wdenk committed
968
969
970
971
		Define this to enable a custom keyboard support.
		This simply calls drv_keyboard_init() which must be
		defined in your board-specific files.
		The only board using this so far is RBC823.
972

wdenk's avatar
wdenk committed
973
974
975
976
977
978
- LCD Support:	CONFIG_LCD

		Define this to enable LCD support (for output to LCD
		display); also select one of the supported displays
		by defining one of these:

wdenk's avatar
wdenk committed
979
		CONFIG_NEC_NL6448AC33:
wdenk's avatar
wdenk committed
980

wdenk's avatar
wdenk committed
981
			NEC NL6448AC33-18. Active, color, single scan.
wdenk's avatar
wdenk committed
982

wdenk's avatar
wdenk committed
983
		CONFIG_NEC_NL6448BC20
wdenk's avatar
wdenk committed
984

wdenk's avatar
wdenk committed
985
986
987
988
989
990
			NEC NL6448BC20-08. 6.5", 640x480.
			Active, color, single scan.

		CONFIG_NEC_NL6448BC33_54

			NEC NL6448BC33-54. 10.4", 640x480.
wdenk's avatar
wdenk committed
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
			Active, color, single scan.

		CONFIG_SHARP_16x9

			Sharp 320x240. Active, color, single scan.
			It isn't 16x9, and I am not sure what it is.

		CONFIG_SHARP_LQ64D341

			Sharp LQ64D341 display, 640x480.
			Active, color, single scan.

		CONFIG_HLD1045

			HLD1045 display, 640x480.
			Active, color, single scan.

		CONFIG_OPTREX_BW

			Optrex	 CBL50840-2 NF-FW 99 22 M5
			or
			Hitachi	 LMG6912RPFC-00T
			or
			Hitachi	 SP14Q002

			320x240. Black & white.

		Normally display is black on white background; define
		CFG_WHITE_ON_BLACK to get it inverted.

wdenk's avatar
wdenk committed
1021
- Splash Screen Support: CONFIG_SPLASH_SCREEN
1022

wdenk's avatar
wdenk committed
1023
1024
1025
		If this option is set, the environment is checked for
		a variable "splashimage". If found, the usual display
		of logo, copyright and system information on the LCD
1026
		is suppressed and the BMP image at the address
wdenk's avatar
wdenk committed
1027
1028
1029
1030
		specified in "splashimage" is loaded instead. The
		console is redirected to the "nulldev", too. This
		allows for a "silent" boot where a splash screen is
		loaded very quickly after power-on.
1031

1032
1033
1034
1035
1036
1037
- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP

		If this option is set, additionally to standard BMP
		images, gzipped BMP images can be displayed via the
		splashscreen support or the bmp command.

wdenk's avatar
wdenk committed
1038
1039
1040
1041
1042
1043
1044
- Compression support:
		CONFIG_BZIP2

		If this option is set, support for bzip2 compressed
		images is included. If not, only uncompressed and gzip
		compressed images are supported.

1045
1046
1047
		NOTE: the bzip2 algorithm requires a lot of RAM, so
		the malloc area (as defined by CFG_MALLOC_LEN) should
		be at least 4MB.
1048

wdenk's avatar
wdenk committed
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
- MII/PHY support:
		CONFIG_PHY_ADDR

		The address of PHY on MII bus.

		CONFIG_PHY_CLOCK_FREQ (ppc4xx)

		The clock frequency of the MII bus

		CONFIG_PHY_GIGE

		If this option is set, support for speed/duplex
		detection of Gigabit PHY is included.

		CONFIG_PHY_RESET_DELAY

		Some PHY like Intel LXT971A need extra delay after
		reset before any MII register access is possible.
		For such PHY, set this option to the usec delay
		required. (minimum 300usec for LXT971A)

		CONFIG_PHY_CMD_DELAY (ppc4xx)

		Some PHY like Intel LXT971A need extra delay after
		command issued before MII status register can be read

wdenk's avatar
wdenk committed
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
- Ethernet address:
		CONFIG_ETHADDR
		CONFIG_ETH2ADDR
		CONFIG_ETH3ADDR

		Define a default value for ethernet address to use
		for the respective ethernet interface, in case this
		is not determined automatically.

- IP address:
		CONFIG_IPADDR

		Define a default value for the IP address to use for
		the default ethernet interface, in case this is not
		determined through e.g. bootp.

- Server IP address:
		CONFIG_SERVERIP

		Defines a default value for theIP address of a TFTP
		server to contact when using the "tftboot" command.

- BOOTP Recovery Mode:
		CONFIG_BOOTP_RANDOM_DELAY

		If you have many targets in a network that try to
		boot using BOOTP, you may want to avoid that all
		systems send out BOOTP requests at precisely the same
		moment (which would happen for instance at recovery
		from a power failure, when all systems will try to
		boot, thus flooding the BOOTP server. Defining
		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
		inserted before sending out BOOTP requests. The
		following delays are insterted then:

		1st BOOTP request:	delay 0 ... 1 sec
		2nd BOOTP request:	delay 0 ... 2 sec
		3rd BOOTP request:	delay 0 ... 4 sec
		4th and following
		BOOTP requests:		delay 0 ... 8 sec

1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
- DHCP Advanced Options:
		CONFIG_BOOTP_MASK

		You can fine tune the DHCP functionality by adding
		these flags to the CONFIG_BOOTP_MASK define:

		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
		serverip from a DHCP server, it is possible that more
		than one DNS serverip is offered to the client.
		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
		serverip will be stored in the additional environment
		variable "dnsip2". The first DNS serverip is always
		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
		is added to the CONFIG_BOOTP_MASK.

		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
		to do a dynamic update of a DNS server. To do this, they
		need the hostname of the DHCP requester.
		If CONFIG_BOOP_SEND_HOSTNAME is added to the
		CONFIG_BOOTP_MASK, the content of the "hostname"
		environment variable is passed as option 12 to
		the DHCP server.

1139
 - CDP Options:
wdenk's avatar
wdenk committed
1140
		CONFIG_CDP_DEVICE_ID
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180

		The device id used in CDP trigger frames.

		CONFIG_CDP_DEVICE_ID_PREFIX

		A two character string which is prefixed to the MAC address
		of the device.

		CONFIG_CDP_PORT_ID

		A printf format string which contains the ascii name of
		the port. Normally is set to "eth%d" which sets
		eth0 for the first ethernet, eth1 for the second etc.

		CONFIG_CDP_CAPABILITIES

		A 32bit integer which indicates the device capabilities;
		0x00000010 for a normal host which does not forwards.

		CONFIG_CDP_VERSION

		An ascii string containing the version of the software.

		CONFIG_CDP_PLATFORM

		An ascii string containing the name of the platform.

		CONFIG_CDP_TRIGGER

		A 32bit integer sent on the trigger.

		CONFIG_CDP_POWER_CONSUMPTION

		A 16bit integer containing the power consumption of the
		device in .1 of milliwatts.

		CONFIG_CDP_APPLIANCE_VLAN_TYPE

		A byte containing the id of the VLAN.

wdenk's avatar
wdenk committed
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
- Status LED:	CONFIG_STATUS_LED

		Several configurations allow to display the current
		status using a LED. For instance, the LED will blink
		fast while running U-Boot code, stop blinking as
		soon as a reply to a BOOTP request was received, and
		start blinking slow once the Linux kernel is running
		(supported by a status LED driver in the Linux
		kernel). Defining CONFIG_STATUS_LED enables this
		feature in U-Boot.

- CAN Support:	CONFIG_CAN_DRIVER

		Defining CONFIG_CAN_DRIVER enables CAN driver support
		on those systems that support this (optional)
		feature, like the TQM8xxL modules.

- I2C Support:	CONFIG_HARD_I2C | CONFIG_SOFT_I2C

wdenk's avatar
wdenk committed
1200
		These enable I2C serial bus commands. Defining either of
1201
1202
		(but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
		include the appropriate I2C driver for the selected cpu.
wdenk's avatar
wdenk committed
1203

1204
1205
		This will allow you to use i2c commands at the u-boot
		command line (as long as you set CFG_CMD_I2C in
wdenk's avatar
wdenk committed
1206
1207
		CONFIG_COMMANDS) and communicate with i2c based realtime
		clock chips. See common/cmd_i2c.c for a description of the
1208
		command line interface.
wdenk's avatar
wdenk committed
1209

1210
1211
1212
1213
1214
1215
		CONFIG_I2C_CMD_TREE is a recommended option that places
		all I2C commands under a single 'i2c' root command.  The
		older 'imm', 'imd', 'iprobe' etc. commands are considered
		deprecated and may disappear in the future.

		CONFIG_HARD_I2C selects a hardware I2C controller.
wdenk's avatar
wdenk committed
1216

1217
		CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenk's avatar
wdenk committed
1218
1219
		bit-banging) driver instead of CPM or similar hardware
		support for I2C.
wdenk's avatar
wdenk committed
1220

1221
		There are several other quantities that must also be
wdenk's avatar
wdenk committed
1222
		defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenk's avatar
wdenk committed
1223

wdenk's avatar
wdenk committed
1224
		In both cases you will need to define CFG_I2C_SPEED
1225
1226
1227
1228
		to be the frequency (in Hz) at which you wish your i2c bus
		to run and CFG_I2C_SLAVE to be the address of this node (ie
		the cpu's i2c node address).

wdenk's avatar
wdenk committed
1229
1230
1231
		Now, the u-boot i2c code for the mpc8xx (cpu/mpc8xx/i2c.c)
		sets the cpu up as a master node and so its address should
		therefore be cleared to 0 (See, eg, MPC823e User's Manual
1232
		p.16-473). So, set CFG_I2C_SLAVE to 0.
wdenk's avatar
wdenk committed
1233

1234
		That's all that's required for CONFIG_HARD_I2C.
wdenk's avatar
wdenk committed
1235

wdenk's avatar
wdenk committed
1236
1237
1238
		If you use the software i2c interface (CONFIG_SOFT_I2C)
		then the following macros need to be defined (examples are
		from include/configs/lwmon.h):
wdenk's avatar
wdenk committed
1239
1240
1241

		I2C_INIT

wdenk's avatar
wdenk committed
1242
		(Optional). Any commands necessary to enable the I2C
1243
		controller or configure ports.
wdenk's avatar
wdenk committed
1244

wdenk's avatar
wdenk committed
1245
		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
wdenk's avatar
wdenk committed
1246

wdenk's avatar
wdenk committed
1247
1248
		I2C_PORT

1249
1250
1251
		(Only for MPC8260 CPU). The I/O port to use (the code
		assumes both bits are on the same port). Valid values
		are 0..3 for ports A..D.
wdenk's avatar
wdenk committed
1252
1253
1254
1255
1256
1257
1258

		I2C_ACTIVE

		The code necessary to make the I2C data line active
		(driven).  If the data line is open collector, this
		define can be null.

wdenk's avatar
wdenk committed
1259
1260
		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)

wdenk's avatar
wdenk committed
1261
1262
1263
1264
1265
1266
		I2C_TRISTATE

		The code necessary to make the I2C data line tri-stated
		(inactive).  If the data line is open collector, this
		define can be null.

wdenk's avatar
wdenk committed
1267
1268
		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)

wdenk's avatar
wdenk committed
1269
1270
1271
1272
1273
		I2C_READ

		Code that returns TRUE if the I2C data line is high,
		FALSE if it is low.

wdenk's avatar
wdenk committed
1274
1275
		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)

wdenk's avatar
wdenk committed
1276
1277
1278
1279
1280
		I2C_SDA(bit)

		If <bit> is TRUE, sets the I2C data line high. If it
		is FALSE, it clears it (low).

wdenk's avatar
wdenk committed
1281
		eg: #define I2C_SDA(bit) \
wdenk's avatar
wdenk committed
1282
			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
wdenk's avatar
wdenk committed
1283
			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenk's avatar
wdenk committed
1284

wdenk's avatar
wdenk committed
1285
1286
1287
1288
1289
		I2C_SCL(bit)

		If <bit> is TRUE, sets the I2C clock line high. If it
		is FALSE, it clears it (low).

wdenk's avatar
wdenk committed
1290
		eg: #define I2C_SCL(bit) \
wdenk's avatar
wdenk committed
1291
			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
wdenk's avatar
wdenk committed
1292
			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenk's avatar
wdenk committed
1293

wdenk's avatar
wdenk committed
1294
1295
1296
1297
		I2C_DELAY

		This delay is invoked four times per clock cycle so this
		controls the rate of data transfer.  The data rate thus
wdenk's avatar
wdenk committed
1298
		is 1 / (I2C_DELAY * 4). Often defined to be something
1299
1300
		like:

wdenk's avatar
wdenk committed
1301
		#define I2C_DELAY  udelay(2)
wdenk's avatar
wdenk committed
1302

1303
1304
		CFG_I2C_INIT_BOARD

wdenk's avatar
wdenk committed
1305
1306
1307
1308
1309
1310
1311
1312
		When a board is reset during an i2c bus transfer
		chips might think that the current transfer is still
		in progress. On some boards it is possible to access
		the i2c SCLK line directly, either by using the
		processor pin as a GPIO or by having a second pin
		connected to the bus. If this option is defined a
		custom i2c_init_board() routine in boards/xxx/board.c
		is run early in the boot sequence.
1313

wdenk's avatar
wdenk committed
1314
1315
1316
1317
1318
1319
		CONFIG_I2CFAST (PPC405GP|PPC405EP only)

		This option enables configuration of bi_iic_fast[] flags
		in u-boot bd_info structure based on u-boot environment
		variable "i2cfast". (see also i2cfast)

1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
		CONFIG_I2C_MULTI_BUS

		This option allows the use of multiple I2C buses, each of which
		must have a controller.  At any point in time, only one bus is
		active.  To switch to a different bus, use the 'i2c dev' command.
		Note that bus numbering is zero-based.

		CFG_I2C_NOPROBES

		This option specifies a list of I2C devices that will be skipped
		when the 'i2c probe' command is issued (or 'iprobe' using the legacy
		command).  If CONFIG_I2C_MULTI_BUS is set, specify a list of bus-device
		pairs.  Otherwise, specify a 1D array of device addresses

		e.g.
			#undef	CONFIG_I2C_MULTI_BUS
			#define CFG_I2C_NOPROBES	{0x50,0x68}

		will skip addresses 0x50 and 0x68 on a board with one I2C bus

			#define	CONFIG_I2C_MULTI_BUS
			#define CFG_I2C_MULTI_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}

		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1

1345
1346
1347
1348
1349
		CFG_SPD_BUS_NUM

		If defined, then this indicates the I2C bus number for DDR SPD.
		If not defined, then U-Boot assumes that SPD is on I2C bus 0.

1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
		CFG_RTC_BUS_NUM

		If defined, then this indicates the I2C bus number for the RTC.
		If not defined, then U-Boot assumes that RTC is on I2C bus 0.

		CFG_DTT_BUS_NUM

		If defined, then this indicates the I2C bus number for the DTT.
		If not defined, then U-Boot assumes that DTT is on I2C bus 0.

1360
1361
1362
1363
1364
1365
		CONFIG_FSL_I2C

		Define this option if you want to use Freescale's I2C driver in
		drivers/fsl_i2c.c.


wdenk's avatar
wdenk committed
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
- SPI Support:	CONFIG_SPI

		Enables SPI driver (so far only tested with
		SPI EEPROM, also an instance works with Crystal A/D and
		D/As on the SACSng board)

		CONFIG_SPI_X

		Enables extended (16-bit) SPI EEPROM addressing.
		(symmetrical to CONFIG_I2C_X)

		CONFIG_SOFT_SPI

1379
1380
1381
1382
1383
1384
1385
		Enables a software (bit-bang) SPI driver rather than
		using hardware support. This is a general purpose
		driver that only requires three general I/O port pins
		(two outputs, one input) to function. If this is
		defined, the board configuration must define several
		SPI configuration items (port pins to use, etc). For
		an example, see include/configs/sacsng.h.
wdenk's avatar
wdenk committed
1386

wdenk's avatar
wdenk committed
1387
- FPGA Support: CONFIG_FPGA_COUNT
wdenk's avatar
wdenk committed
1388

wdenk's avatar
wdenk committed
1389
		Specify the number of FPGA devices to support.
wdenk's avatar
wdenk committed
1390

wdenk's avatar
wdenk committed
1391
		CONFIG_FPGA
wdenk's avatar
wdenk committed
1392

wdenk's avatar
wdenk committed
1393
1394
		Used to specify the types of FPGA devices.  For example,
		#define CONFIG_FPGA  CFG_XILINX_VIRTEX2
wdenk's avatar
wdenk committed
1395

wdenk's avatar
wdenk committed
1396
		CFG_FPGA_PROG_FEEDBACK
wdenk's avatar
wdenk committed
1397

wdenk's avatar
wdenk committed
1398
		Enable printing of hash marks during FPGA configuration.
wdenk's avatar
wdenk committed
1399
1400
1401

		CFG_FPGA_CHECK_BUSY

1402
1403
1404
1405
		Enable checks on FPGA configuration interface busy
		status by the configuration function. This option
		will require a board or device specific function to
		be written.
wdenk's avatar
wdenk committed
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416

		CONFIG_FPGA_DELAY

		If defined, a function that provides delays in the FPGA
		configuration driver.

		CFG_FPGA_CHECK_CTRLC
		Allow Control-C to interrupt FPGA configuration

		CFG_FPGA_CHECK_ERROR

1417
1418
1419
1420
		Check for configuration errors during FPGA bitfile
		loading. For example, abort during Virtex II
		configuration if the INIT_B line goes low (which
		indicated a CRC error).
wdenk's avatar
wdenk committed
1421
1422
1423

		CFG_FPGA_WAIT_INIT

1424
1425
1426
1427
		Maximum time to wait for the INIT_B line to deassert
		after PROB_B has been deasserted during a Virtex II
		FPGA configuration sequence. The default time is 500
		mS.
wdenk's avatar
wdenk committed
1428
1429
1430

		CFG_FPGA_WAIT_BUSY

1431
1432
		Maximum time to wait for BUSY to deassert during
		Virtex II FPGA configuration. The default is 5 mS.
wdenk's avatar
wdenk committed
1433
1434
1435

		CFG_FPGA_WAIT_CONFIG

1436
1437
		Time to wait after FPGA configuration. The default is
		200 mS.
wdenk's avatar
wdenk committed
1438
1439
1440
1441

- Configuration Management:
		CONFIG_IDENT_STRING

1442
1443
		If defined, this string will be added to the U-Boot
		version information (U_BOOT_VERSION)
wdenk's avatar
wdenk committed
1444
1445
1446

- Vendor Parameter Protection:

1447
1448
		U-Boot considers the values of the environment
		variables "serial#" (Board Serial Number) and
wdenk's avatar
wdenk committed
1449
		"ethaddr" (Ethernet Address) to be parameters that
1450
1451
1452
1453
1454
		are set once by the board vendor / manufacturer, and
		protects these variables from casual modification by
		the user. Once set, these variables are read-only,
		and write or delete attempts are rejected. You can
		change this behviour:
wdenk's avatar
wdenk committed
1455
1456
1457

		If CONFIG_ENV_OVERWRITE is #defined in your config
		file, the write protection for vendor parameters is
1458
		completely disabled. Anybody can change or delete
wdenk's avatar
wdenk committed
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
		these parameters.

		Alternatively, if you #define _both_ CONFIG_ETHADDR
		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
		ethernet address is installed in the environment,
		which can be changed exactly ONCE by the user. [The
		serial# is unaffected by this, i. e. it remains
		read-only.]

- Protected RAM:
		CONFIG_PRAM

		Define this variable to enable the reservation of
		"protected RAM", i. e. RAM which is not overwritten
		by U-Boot. Define CONFIG_PRAM to hold the number of
		kB you want to reserve for pRAM. You can overwrite
		this default value by defining an environment
		variable "pram" to the number of kB you want to
		reserve. Note that the board info structure will
		still show the full amount of RAM. If pRAM is
		reserved, a new environment variable "mem" will
		automatically be defined to hold the amount of
		remaining RAM in a form that can be passed as boot
		argument to Linux, for instance like that:

1484
			setenv bootargs ... mem=\${mem}
wdenk's avatar
wdenk committed
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
			saveenv

		This way you can tell Linux not to use this memory,
		either, which results in a memory region that will
		not be affected by reboots.

		*WARNING* If your board configuration uses automatic
		detection of the RAM size, you must make sure that
		this memory test is non-destructive. So far, the
		following board configurations are known to be
		"pRAM-clean":

			ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
			HERMES, IP860, RPXlite, LWMON, LANTEC,
			PCU_E, FLAGADM, TQM8260

- Error Recovery:
		CONFIG_PANIC_HANG

		Define this variable to stop the system in case of a
		fatal error, so that you have to reset it manually.
		This is probably NOT a good idea for an embedded
		system where you want to system to reboot
		automatically as fast as possible, but it may be
		useful during development since you can try to debug
		the conditions that lead to the situation.

		CONFIG_NET_RETRY_COUNT

1514
1515
1516
1517
		This variable defines the number of retries for
		network operations like ARP, RARP, TFTP, or BOOTP
		before giving up the operation. If not defined, a
		default value of 5 is used.
wdenk's avatar
wdenk committed
1518
1519

- Command Interpreter:
1520
		CONFIG_AUTO_COMPLETE
1521
1522
1523

		Enable auto completion of commands using TAB.

1524
1525
		Note that this feature has NOT been implemented yet
		for the "hush" shell.
1526
1527


wdenk's avatar
wdenk committed
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
		CFG_HUSH_PARSER

		Define this variable to enable the "hush" shell (from
		Busybox) as command line interpreter, thus enabling
		powerful command line syntax like
		if...then...else...fi conditionals or `&&' and '||'
		constructs ("shell scripts").

		If undefined, you get the old, much simpler behaviour
		with a somewhat smaller memory footprint.


		CFG_PROMPT_HUSH_PS2

		This defines the secondary prompt string, which is
		printed when the command interpreter needs more input
		to complete a command. Usually "> ".

	Note:

wdenk's avatar
wdenk committed
1548
1549
1550
1551
1552
1553
1554
		In the current implementation, the local variables
		space and global environment variables space are
		separated. Local variables are those you define by
		simply typing `name=value'. To access a local
		variable later on, you have write `$name' or
		`${name}'; to execute the contents of a variable
		directly type `$name' at the command prompt.
wdenk's avatar
wdenk committed
1555

1556
1557
1558
1559
		Global environment variables are those you use
		setenv/printenv to work with. To run a command stored
		in such a variable, you need to use the run command,
		and you must not use the '$' sign to access them.
wdenk's avatar
wdenk committed
1560
1561
1562
1563
1564
1565
1566

		To store commands and special characters in a
		variable, please use double quotation marks
		surrounding the whole text of the variable, instead
		of the backslashes before semicolons and special
		symbols.

1567
1568
1569
- Commandline Editing and History:
		CONFIG_CMDLINE_EDITING

Wolfgang Denk's avatar
Wolfgang Denk committed
1570
1571
		Enable editiong and History functions for interactive
		commandline input operations
1572

wdenk's avatar
wdenk committed
1573
- Default Environment:
wdenk's avatar
wdenk committed
1574
1575
		CONFIG_EXTRA_ENV_SETTINGS

1576
1577
		Define this to contain any number of null terminated
		strings (variable = value pairs) that will be part of
wdenk's avatar
wdenk committed
1578
		the default environment compiled into the boot image.
1579

1580
1581
		For example, place something like this in your
		board's config file:
wdenk's avatar
wdenk committed
1582
1583
1584
1585
1586

		#define CONFIG_EXTRA_ENV_SETTINGS \
			"myvar1=value1\0" \
			"myvar2=value2\0"

1587
1588
1589
1590
		Warning: This method is based on knowledge about the
		internal format how the environment is stored by the
		U-Boot code. This is NOT an official, exported
		interface! Although it is unlikely that this format
wdenk's avatar
wdenk committed
1591
		will change soon, there is no guarantee either.
wdenk's avatar
wdenk committed
1592
1593
		You better know what you are doing here.

1594
1595
1596
1597
		Note: overly (ab)use of the default environment is
		discouraged. Make sure to check other ways to preset
		the environment like the autoscript function or the
		boot command first.
wdenk's avatar
wdenk committed
1598

wdenk's avatar
wdenk committed
1599
- DataFlash Support:
1600
1601
		CONFIG_HAS_DATAFLASH

wdenk's avatar
wdenk committed
1602
1603
1604
		Defining this option enables DataFlash features and
		allows to read/write in Dataflash via the standard
		commands cp, md...
1605

wdenk's avatar
wdenk committed
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
- SystemACE Support:
		CONFIG_SYSTEMACE

		Adding this option adds support for Xilinx SystemACE
		chips attached via some sort of local bus. The address
		of the chip must alsh be defined in the
		CFG_SYSTEMACE_BASE macro. For example:

		#define CONFIG_SYSTEMACE
		#define CFG_SYSTEMACE_BASE 0xf0000000

		When SystemACE support is added, the "ace" device type
		becomes available to the fat commands, i.e. fatls.

1620
1621
1622
- TFTP Fixed UDP Port:
		CONFIG_TFTP_PORT

1623
		If this is defined, the environment variable tftpsrcp
1624
		is used to supply the TFTP UDP source port value.
1625
		If tftpsrcp isn't defined, the normal pseudo-random port
1626
1627
		number generator is used.

1628
1629
1630
1631
1632
		Also, the environment variable tftpdstp is used to supply
		the TFTP UDP destination port value.  If tftpdstp isn't
		defined, the normal port 69 is used.

		The purpose for tftpsrcp is to allow a TFTP server to
1633
1634
1635
1636
1637
1638
1639
		blindly start the TFTP transfer using the pre-configured
		target IP address and UDP port. This has the effect of
		"punching through" the (Windows XP) firewall, allowing
		the remainder of the TFTP transfer to proceed normally.
		A better solution is to properly configure the firewall,
		but sometimes that is not allowed.

wdenk's avatar
wdenk committed
1640
- Show boot progress:
wdenk's avatar
wdenk committed
1641
1642
		CONFIG_SHOW_BOOT_PROGRESS

1643
1644
1645
1646
1647
1648
		Defining this option allows to add some board-
		specific code (calling a user-provided function
		"show_boot_progress(int)") that enables you to show
		the system's boot progress on some display (for
		example, some LED's) on your board. At the moment,
		the following checkpoints are implemented:
wdenk's avatar
wdenk committed
1649
1650
1651

  Arg	Where			When
    1	common/cmd_bootm.c	before attempting to boot an image
wdenk's avatar
wdenk committed
1652
   -1	common/cmd_bootm.c	Image header has bad	 magic number
wdenk's avatar
wdenk committed
1653
    2	common/cmd_bootm.c	Image header has correct magic number
wdenk's avatar
wdenk committed
1654
   -2	common/cmd_bootm.c	Image header has bad	 checksum
wdenk's avatar
wdenk committed
1655
    3	common/cmd_bootm.c	Image header has correct checksum
wdenk's avatar
wdenk committed
1656
   -3	common/cmd_bootm.c	Image data   has bad	 checksum
wdenk's avatar
wdenk committed
1657
1658
1659
1660
1661
1662
1663
1