Blame view

README 217 KB
c609719b8   wdenk   Initial revision
1
  #
eca3aeb35   Wolfgang Denk   Licenses: introdu...
2
  # (C) Copyright 2000 - 2013
c609719b8   wdenk   Initial revision
3
4
  # Wolfgang Denk, DENX Software Engineering, wd@denx.de.
  #
eca3aeb35   Wolfgang Denk   Licenses: introdu...
5
  # SPDX-License-Identifier:	GPL-2.0+
c609719b8   wdenk   Initial revision
6
7
8
9
  #
  
  Summary:
  ========
24ee89b97   wdenk   * Fix mdelay() on...
10
  This directory contains the source code for U-Boot, a boot loader for
e86e5a074   wdenk   Code cleanup for ...
11
12
13
14
  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.
c609719b8   wdenk   Initial revision
15
16
  
  The development of U-Boot is closely related to Linux: some parts of
24ee89b97   wdenk   * Fix mdelay() on...
17
18
  the source code originate in the Linux source tree, we have some
  header files in common, and special provision has been made to
c609719b8   wdenk   Initial revision
19
20
21
22
23
24
25
26
27
28
29
30
31
32
  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
24ee89b97   wdenk   * Fix mdelay() on...
33
  Makefile have been tested to some extent and can be considered
c609719b8   wdenk   Initial revision
34
  "working". In fact, many of them are used in production systems.
7207b366d   Robert P. J. Day   doc: Tidy up firs...
35
36
37
38
  In case of problems see the CHANGELOG file to find out who contributed
  the specific port. In addition, there are various MAINTAINERS files
  scattered throughout the U-Boot source identifying the people or
  companies responsible for various boards and subsystems.
c609719b8   wdenk   Initial revision
39

7207b366d   Robert P. J. Day   doc: Tidy up firs...
40
41
42
  Note: As of August, 2010, there is no longer a CHANGELOG file in the
  actual U-Boot source tree; however, it can be created dynamically
  from the Git log using:
adb9d8513   Robert P. J. Day   README: Explain h...
43
44
  
  	make CHANGELOG
c609719b8   wdenk   Initial revision
45
46
47
  
  Where to get help:
  ==================
24ee89b97   wdenk   * Fix mdelay() on...
48
  In case you have questions about, problems with or contributions for
7207b366d   Robert P. J. Day   doc: Tidy up firs...
49
  U-Boot, you should send a message to the U-Boot mailing list at
0c32565f5   Peter Tyser   Update mailing li...
50
51
52
53
  <u-boot@lists.denx.de>. There is also an archive of previous traffic
  on the mailing list - please search the archive before asking FAQ's.
  Please see http://lists.denx.de/pipermail/u-boot and
  http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
c609719b8   wdenk   Initial revision
54

218ca724c   Wolfgang Denk   README: update do...
55
56
  Where to get source code:
  =========================
7207b366d   Robert P. J. Day   doc: Tidy up firs...
57
  The U-Boot source code is maintained in the Git repository at
218ca724c   Wolfgang Denk   README: update do...
58
59
60
61
  git://www.denx.de/git/u-boot.git ; you can browse it online at
  http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
  
  The "snapshot" links on this page allow you to download tarballs of
11ccc33fa   Marcel Ziswiler   Many spelling fix...
62
  any version you might be interested in. Official releases are also
218ca724c   Wolfgang Denk   README: update do...
63
64
  available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
  directory.
d4ee711d8   Anatolij Gustschin   README: update do...
65
  Pre-built (and tested) images are available from
218ca724c   Wolfgang Denk   README: update do...
66
  ftp://ftp.denx.de/pub/u-boot/images/
c609719b8   wdenk   Initial revision
67
68
69
70
  Where we come from:
  ===================
  
  - start from 8xxrom sources
24ee89b97   wdenk   * Fix mdelay() on...
71
  - create PPCBoot project (http://sourceforge.net/projects/ppcboot)
c609719b8   wdenk   Initial revision
72
73
74
75
76
77
78
  - 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
11ccc33fa   Marcel Ziswiler   Many spelling fix...
79
    * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
24ee89b97   wdenk   * Fix mdelay() on...
80
  - create ARMBoot project (http://sourceforge.net/projects/armboot)
c609719b8   wdenk   Initial revision
81
  - add other CPU families (starting with ARM)
24ee89b97   wdenk   * Fix mdelay() on...
82
  - create U-Boot project (http://sourceforge.net/projects/u-boot)
0d28f34bb   Magnus Lilja   Update the U-Boot...
83
  - current project page: see http://www.denx.de/wiki/U-Boot
24ee89b97   wdenk   * Fix mdelay() on...
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
  
  
  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
c609719b8   wdenk   Initial revision
106

93f19cc0e   wdenk   Prepare for relea...
107
108
  Versioning:
  ===========
360d883aa   Thomas Weber   README: Fix descr...
109
110
111
112
113
114
115
116
  Starting with the release in October 2008, the names of the releases
  were changed from numerical release numbers without deeper meaning
  into a time stamp based numbering. Regular releases are identified by
  names consisting of the calendar year and month of the release date.
  Additional fields (if present) indicate release candidates or bug fix
  releases in "stable" maintenance trees.
  
  Examples:
c0f40859f   Wolfgang Denk   README: white-spa...
117
  	U-Boot v2009.11	    - Release November 2009
360d883aa   Thomas Weber   README: Fix descr...
118
  	U-Boot v2009.11.1   - Release 1 in version November 2009 stable tree
0de21ecbe   Jelle van der Waa   README: fix typo ...
119
  	U-Boot v2010.09-rc1 - Release candidate 1 for September 2010 release
93f19cc0e   wdenk   Prepare for relea...
120

c609719b8   wdenk   Initial revision
121
122
  Directory Hierarchy:
  ====================
8d321b81c   Peter Tyser   Update README to ...
123
  /arch			Architecture specific files
6eae68e45   Masahiro Yamada   cosmetic: README:...
124
    /arc			Files generic to ARC architecture
8d321b81c   Peter Tyser   Update README to ...
125
    /arm			Files generic to ARM architecture
8d321b81c   Peter Tyser   Update README to ...
126
    /avr32		Files generic to AVR32 architecture
8d321b81c   Peter Tyser   Update README to ...
127
    /blackfin		Files generic to Analog Devices Blackfin architecture
8d321b81c   Peter Tyser   Update README to ...
128
    /m68k			Files generic to m68k architecture
8d321b81c   Peter Tyser   Update README to ...
129
    /microblaze		Files generic to microblaze architecture
8d321b81c   Peter Tyser   Update README to ...
130
    /mips			Files generic to MIPS architecture
afc1ce828   Macpaul Lin   doc/README: docum...
131
    /nds32		Files generic to NDS32 architecture
8d321b81c   Peter Tyser   Update README to ...
132
    /nios2		Files generic to Altera NIOS2 architecture
33c7731bd   Robert P. J. Day   Cosmetic: Update ...
133
    /openrisc		Files generic to OpenRISC architecture
a47a12bec   Stefan Roese   Move arch/ppc to ...
134
    /powerpc		Files generic to PowerPC architecture
7207b366d   Robert P. J. Day   doc: Tidy up firs...
135
    /sandbox		Files generic to HW-independent "sandbox"
8d321b81c   Peter Tyser   Update README to ...
136
    /sh			Files generic to SH architecture
8d321b81c   Peter Tyser   Update README to ...
137
    /sparc		Files generic to SPARC architecture
33c7731bd   Robert P. J. Day   Cosmetic: Update ...
138
    /x86			Files generic to x86 architecture
8d321b81c   Peter Tyser   Update README to ...
139
140
  /api			Machine/arch independent API for external apps
  /board			Board dependent files
740f7e5c1   Xu Ziyuan   README: add cmd d...
141
  /cmd			U-Boot commands functions
8d321b81c   Peter Tyser   Update README to ...
142
  /common			Misc architecture independent functions
7207b366d   Robert P. J. Day   doc: Tidy up firs...
143
  /configs		Board default configuration files
8d321b81c   Peter Tyser   Update README to ...
144
145
146
  /disk			Code for disk drive partition handling
  /doc			Documentation (don't expect too much)
  /drivers		Commonly used device drivers
33c7731bd   Robert P. J. Day   Cosmetic: Update ...
147
  /dts			Contains Makefile for building internal U-Boot fdt.
8d321b81c   Peter Tyser   Update README to ...
148
149
150
  /examples		Example code for standalone applications, etc.
  /fs			Filesystem code (cramfs, ext2, jffs2, etc.)
  /include		Header Files
7207b366d   Robert P. J. Day   doc: Tidy up firs...
151
152
  /lib			Library routines generic to all architectures
  /Licenses		Various license files
8d321b81c   Peter Tyser   Update README to ...
153
154
  /net			Networking code
  /post			Power On Self Test
7207b366d   Robert P. J. Day   doc: Tidy up firs...
155
156
  /scripts		Various build scripts and Makefiles
  /test			Various unit test files
8d321b81c   Peter Tyser   Update README to ...
157
  /tools			Tools to build S-Record or U-Boot images, etc.
c609719b8   wdenk   Initial revision
158

c609719b8   wdenk   Initial revision
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
  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
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
174
    "CONFIG_SYS_".
c609719b8   wdenk   Initial revision
175

7207b366d   Robert P. J. Day   doc: Tidy up firs...
176
177
178
179
180
  Previously, all configuration was done by hand, which involved creating
  symbolic links and editing configuration files manually. More recently,
  U-Boot has added the Kbuild infrastructure used by the Linux kernel,
  allowing you to use the "make menuconfig" command to configure your
  build.
c609719b8   wdenk   Initial revision
181
182
183
184
185
186
  
  
  Selection of Processor Architecture and Board Type:
  ---------------------------------------------------
  
  For all supported boards there are ready-to-use default
ab584d67c   Holger Freyther   The _config targe...
187
  configurations available; just type "make <board_name>_defconfig".
c609719b8   wdenk   Initial revision
188
189
190
191
  
  Example: For a TQM823L module type:
  
  	cd u-boot
ab584d67c   Holger Freyther   The _config targe...
192
  	make TQM823L_defconfig
c609719b8   wdenk   Initial revision
193

7207b366d   Robert P. J. Day   doc: Tidy up firs...
194
195
196
  Note: If you're looking for the default configuration file for a board
  you're sure used to be there but is now missing, check the file
  doc/README.scrapyard for a list of no longer supported boards.
c609719b8   wdenk   Initial revision
197

75b3c3aa8   Simon Glass   sandbox: Update a...
198
199
200
201
202
203
204
  Sandbox Environment:
  --------------------
  
  U-Boot can be built natively to run on a Linux host using the 'sandbox'
  board. This allows feature development which is not board- or architecture-
  specific to be undertaken on a native platform. The sandbox is also used to
  run some of U-Boot's tests.
6b1978f8a   Jagannadha Sutradharudu Teki   sandbox: Update m...
205
  See board/sandbox/README.sandbox for more details.
75b3c3aa8   Simon Glass   sandbox: Update a...
206

db910353a   Simon Glass   arm: spl: Allow b...
207
208
209
210
  Board Initialisation Flow:
  --------------------------
  
  This is the intended start-up flow for boards. This should apply for both
7207b366d   Robert P. J. Day   doc: Tidy up firs...
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
  SPL and U-Boot proper (i.e. they both follow the same rules).
  
  Note: "SPL" stands for "Secondary Program Loader," which is explained in
  more detail later in this file.
  
  At present, SPL mostly uses a separate code path, but the function names
  and roles of each function are the same. Some boards or architectures
  may not conform to this.  At least most ARM boards which use
  CONFIG_SPL_FRAMEWORK conform to this.
  
  Execution typically starts with an architecture-specific (and possibly
  CPU-specific) start.S file, such as:
  
  	- arch/arm/cpu/armv7/start.S
  	- arch/powerpc/cpu/mpc83xx/start.S
  	- arch/mips/cpu/start.S
db910353a   Simon Glass   arm: spl: Allow b...
227

7207b366d   Robert P. J. Day   doc: Tidy up firs...
228
229
  and so on. From there, three functions are called; the purpose and
  limitations of each of these functions are described below.
db910353a   Simon Glass   arm: spl: Allow b...
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
  
  lowlevel_init():
  	- purpose: essential init to permit execution to reach board_init_f()
  	- no global_data or BSS
  	- there is no stack (ARMv7 may have one but it will soon be removed)
  	- must not set up SDRAM or use console
  	- must only do the bare minimum to allow execution to continue to
  		board_init_f()
  	- this is almost never needed
  	- return normally from this function
  
  board_init_f():
  	- purpose: set up the machine ready for running board_init_r():
  		i.e. SDRAM and serial UART
  	- global_data is available
  	- stack is in SRAM
  	- BSS is not available, so you cannot use global/static variables,
  		only stack variables and global_data
  
  	Non-SPL-specific notes:
  	- dram_init() is called to set up DRAM. If already done in SPL this
  		can do nothing
  
  	SPL-specific notes:
  	- you can override the entire board_init_f() function with your own
  		version as needed.
  	- preloader_console_init() can be called here in extremis
  	- should set up SDRAM, and anything needed to make the UART work
  	- these is no need to clear BSS, it will be done by crt0.S
  	- must return normally from this function (don't call board_init_r()
  		directly)
  
  Here the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at
  this point the stack and global_data are relocated to below
  CONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of
  memory.
  
  board_init_r():
  	- purpose: main execution, common code
  	- global_data is available
  	- SDRAM is available
  	- BSS is available, all static/global variables can be used
  	- execution eventually continues to main_loop()
  
  	Non-SPL-specific notes:
  	- U-Boot is relocated to the top of memory and is now running from
  		there.
  
  	SPL-specific notes:
  	- stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and
  		CONFIG_SPL_STACK_R_ADDR points into SDRAM
  	- preloader_console_init() can be called here - typically this is
  		done by defining CONFIG_SPL_BOARD_INIT and then supplying a
  		spl_board_init() function containing this call
  	- loads U-Boot or (in falcon mode) Linux
c609719b8   wdenk   Initial revision
285
286
287
288
289
290
291
292
293
  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".
7f6c2cbc2   wdenk   * Vince Husovsky,...
294
295
296
  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.
c609719b8   wdenk   Initial revision
297
  The following options need to be configured:
2628114ec   Kim Phillips   README: Remove ou...
298
299
300
  - CPU Type:	Define exactly one, e.g. CONFIG_MPC85XX.
  
  - Board Type:	Define exactly one, e.g. CONFIG_MPC8540ADS.
6ccec4492   Wolfgang Denk   Add ATSTK1000 and...
301
302
  
  - CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
09ea0de03   Haavard Skinnemoen   README: Remove AT...
303
  		Define exactly one, e.g. CONFIG_ATSTK1002
c609719b8   wdenk   Initial revision
304

cf946c6d0   Lei Wen   mv: seperate kirk...
305
306
307
308
  - Marvell Family Member
  		CONFIG_SYS_MVFS		- define it if you want to enable
  					  multiple fs option at one time
  					  for marvell soc family
11ccc33fa   Marcel Ziswiler   Many spelling fix...
309
  - 8xx CPU Options: (if using an MPC8xx CPU)
66ca92a5b   wdenk   * Patch by Yuli B...
310
311
  		CONFIG_8xx_GCLK_FREQ	- deprecated: CPU clock if
  					  get_gclk_freq() cannot work
5da627a42   wdenk   * Patch by Steven...
312
313
  					  e.g. if there is no 32KHz
  					  reference PIT/RTC clock
66ca92a5b   wdenk   * Patch by Yuli B...
314
315
  		CONFIG_8xx_OSCLK	- PLL input clock (either EXTCLK
  					  or XTAL/EXTAL)
c609719b8   wdenk   Initial revision
316

66ca92a5b   wdenk   * Patch by Yuli B...
317
  - 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
318
319
  		CONFIG_SYS_8xx_CPUCLK_MIN
  		CONFIG_SYS_8xx_CPUCLK_MAX
66ca92a5b   wdenk   * Patch by Yuli B...
320
  		CONFIG_8xx_CPUCLK_DEFAULT
75d1ea7f6   wdenk   Fix variable CPU ...
321
  			See doc/README.MPC866
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
322
  		CONFIG_SYS_MEASURE_CPUCLK
75d1ea7f6   wdenk   Fix variable CPU ...
323

ba56f6257   wdenk   Patch by Travis S...
324
325
326
327
328
  		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
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
329
  		RTC clock or CONFIG_SYS_8XX_XIN)
75d1ea7f6   wdenk   Fix variable CPU ...
330

506f39188   Heiko Schocher   8xx, icache: enab...
331
332
333
334
  		CONFIG_SYS_DELAYED_ICACHE
  
  		Define this option if you want to enable the
  		ICache only when Code runs from RAM.
66412c637   Kumar Gala   powerpc/85xx: Cha...
335
  - 85xx CPU Options:
ffd06e023   York Sun   powerpc/mpc85xx: ...
336
337
338
339
340
  		CONFIG_SYS_PPC64
  
  		Specifies that the core is a 64-bit PowerPC implementation (implements
  		the "64" category of the Power ISA). This is necessary for ePAPR
  		compliance, among other possible reasons.
66412c637   Kumar Gala   powerpc/85xx: Cha...
341
342
343
344
345
  		CONFIG_SYS_FSL_TBCLK_DIV
  
  		Defines the core time base clock divider ratio compared to the
  		system clock.  On most PQ3 devices this is 8, on newer QorIQ
  		devices it can be 16 or 32.  The ratio varies from SoC to Soc.
8f29084a4   Kumar Gala   powerpc/fsl_pci: ...
346
347
348
349
  		CONFIG_SYS_FSL_PCIE_COMPAT
  
  		Defines the string to utilize when trying to match PCIe device
  		tree nodes for the given platform.
33eee330c   Scott Wood   powerpc/fsl-coren...
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
  		CONFIG_SYS_FSL_ERRATUM_A004510
  
  		Enables a workaround for erratum A004510.  If set,
  		then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
  		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
  
  		CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
  		CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
  
  		Defines one or two SoC revisions (low 8 bits of SVR)
  		for which the A004510 workaround should be applied.
  
  		The rest of SVR is either not relevant to the decision
  		of whether the erratum is present (e.g. p2040 versus
  		p2041) or is implied by the build target, which controls
  		whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
  
  		See Freescale App Note 4493 for more information about
  		this erratum.
74fa22ed7   Prabhakar Kushwaha   powerpc/mpc85xx:N...
369
370
  		CONFIG_A003399_NOR_WORKAROUND
  		Enables a workaround for IFC erratum A003399. It is only
b445bbb49   Jeremiah Mahler   doc: fix grammati...
371
  		required during NOR boot.
74fa22ed7   Prabhakar Kushwaha   powerpc/mpc85xx:N...
372

9f074e67f   Prabhakar Kushwaha   powerpc/mpc85xx:P...
373
374
  		CONFIG_A008044_WORKAROUND
  		Enables a workaround for T1040/T1042 erratum A008044. It is only
b445bbb49   Jeremiah Mahler   doc: fix grammati...
375
  		required during NAND boot and valid for Rev 1.0 SoC revision
9f074e67f   Prabhakar Kushwaha   powerpc/mpc85xx:P...
376

33eee330c   Scott Wood   powerpc/fsl-coren...
377
378
379
380
  		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
  
  		This is the value to write into CCSR offset 0x18600
  		according to the A004510 workaround.
64501c669   Priyanka Jain   board/bsc9132qds:...
381
382
383
  		CONFIG_SYS_FSL_DSP_DDR_ADDR
  		This value denotes start offset of DDR memory which is
  		connected exclusively to the DSP cores.
765b0bdb8   Priyanka Jain   board/bsc9131rdb:...
384
385
386
  		CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
  		This value denotes start offset of M2 memory
  		which is directly connected to the DSP core.
64501c669   Priyanka Jain   board/bsc9132qds:...
387
388
389
  		CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
  		This value denotes start offset of M3 memory which is directly
  		connected to the DSP core.
765b0bdb8   Priyanka Jain   board/bsc9131rdb:...
390
391
  		CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
  		This value denotes start offset of DSP CCSR space.
b135991a3   Priyanka Jain   powerpc/mpc85xx: ...
392
393
394
395
  		CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
  		Single Source Clock is clocking mode present in some of FSL SoC's.
  		In this mode, a single differential clock is used to supply
  		clocks to the sysclock, ddrclock and usbclock.
fb4a2409b   Aneesh Bansal   powerpc/mpc85xx: ...
396
397
  		CONFIG_SYS_CPC_REINIT_F
  		This CONFIG is defined when the CPC is configured as SRAM at the
a187559e3   Bin Meng   Use correct spell...
398
  		time of U-Boot entry and is required to be re-initialized.
fb4a2409b   Aneesh Bansal   powerpc/mpc85xx: ...
399

aade20046   Tang Yuantian   mpc85xx/t104x: Ad...
400
  		CONFIG_DEEP_SLEEP
b445bbb49   Jeremiah Mahler   doc: fix grammati...
401
  		Indicates this SoC supports deep sleep feature. If deep sleep is
aade20046   Tang Yuantian   mpc85xx/t104x: Ad...
402
  		supported, core will start to execute uboot when wakes up.
6cb461b4f   Daniel Schwierzeck   MIPS: fix endiane...
403
  - Generic CPU options:
2a1680e30   York Sun   common/board_f: I...
404
405
406
407
408
  		CONFIG_SYS_GENERIC_GLOBAL_DATA
  		Defines global data is initialized in generic board board_init_f().
  		If this macro is defined, global data is created and cleared in
  		generic board board_init_f(). Without this macro, architecture/board
  		should initialize global data before calling board_init_f().
6cb461b4f   Daniel Schwierzeck   MIPS: fix endiane...
409
410
411
412
  		CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
  
  		Defines the endianess of the CPU. Implementation of those
  		values is arch specific.
5614e71b4   York Sun   Driver/DDR: Movin...
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
  		CONFIG_SYS_FSL_DDR
  		Freescale DDR driver in use. This type of DDR controller is
  		found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
  		SoCs.
  
  		CONFIG_SYS_FSL_DDR_ADDR
  		Freescale DDR memory-mapped register base.
  
  		CONFIG_SYS_FSL_DDR_EMU
  		Specify emulator support for DDR. Some DDR features such as
  		deskew training are not available.
  
  		CONFIG_SYS_FSL_DDRC_GEN1
  		Freescale DDR1 controller.
  
  		CONFIG_SYS_FSL_DDRC_GEN2
  		Freescale DDR2 controller.
  
  		CONFIG_SYS_FSL_DDRC_GEN3
  		Freescale DDR3 controller.
34e026f9b   York Sun   driver/ddr/fsl: A...
433
434
  		CONFIG_SYS_FSL_DDRC_GEN4
  		Freescale DDR4 controller.
9ac4ffbde   York Sun   Driver/DDR: Add F...
435
436
  		CONFIG_SYS_FSL_DDRC_ARM_GEN3
  		Freescale DDR3 controller for ARM-based SoCs.
5614e71b4   York Sun   Driver/DDR: Movin...
437
438
439
440
441
442
  		CONFIG_SYS_FSL_DDR1
  		Board config to use DDR1. It can be enabled for SoCs with
  		Freescale DDR1 or DDR2 controllers, depending on the board
  		implemetation.
  
  		CONFIG_SYS_FSL_DDR2
62a3b7dd0   Robert P. J. Day   Various, unrelate...
443
  		Board config to use DDR2. It can be enabled for SoCs with
5614e71b4   York Sun   Driver/DDR: Movin...
444
445
446
447
448
  		Freescale DDR2 or DDR3 controllers, depending on the board
  		implementation.
  
  		CONFIG_SYS_FSL_DDR3
  		Board config to use DDR3. It can be enabled for SoCs with
34e026f9b   York Sun   driver/ddr/fsl: A...
449
450
451
452
453
454
455
456
457
  		Freescale DDR3 or DDR3L controllers.
  
  		CONFIG_SYS_FSL_DDR3L
  		Board config to use DDR3L. It can be enabled for SoCs with
  		DDR3L controllers.
  
  		CONFIG_SYS_FSL_DDR4
  		Board config to use DDR4. It can be enabled for SoCs with
  		DDR4 controllers.
5614e71b4   York Sun   Driver/DDR: Movin...
458

1b4175d6f   Prabhakar Kushwaha   driver/ifc:Change...
459
460
461
462
463
  		CONFIG_SYS_FSL_IFC_BE
  		Defines the IFC controller register space as Big Endian
  
  		CONFIG_SYS_FSL_IFC_LE
  		Defines the IFC controller register space as Little Endian
1c40707e3   Prabhakar Kushwaha   arch: powerpc: up...
464
465
  		CONFIG_SYS_FSL_IFC_CLK_DIV
  		Defines divider of platform clock(clock input to IFC controller).
add63f94a   Prabhakar Kushwaha   arch: powerpc: up...
466
467
  		CONFIG_SYS_FSL_LBC_CLK_DIV
  		Defines divider of platform clock(clock input to eLBC controller).
690e42584   Prabhakar Kushwaha   powerpc:Rename CO...
468
469
470
471
472
473
474
475
  		CONFIG_SYS_FSL_PBL_PBI
  		It enables addition of RCW (Power on reset configuration) in built image.
  		Please refer doc/README.pblimage for more details
  
  		CONFIG_SYS_FSL_PBL_RCW
  		It adds PBI(pre-boot instructions) commands in u-boot build image.
  		PBI commands can be used to configure SoC before it starts the execution.
  		Please refer doc/README.pblimage for more details
89ad7be8e   Prabhakar Kushwaha   Makefile: Add sup...
476
477
478
  		CONFIG_SPL_FSL_PBL
  		It adds a target to create boot binary having SPL binary in PBI format
  		concatenated with u-boot binary.
4e5b1bd0d   York Sun   driver/ddr: Chang...
479
480
481
482
483
  		CONFIG_SYS_FSL_DDR_BE
  		Defines the DDR controller register space as Big Endian
  
  		CONFIG_SYS_FSL_DDR_LE
  		Defines the DDR controller register space as Little Endian
6b9e309a8   York Sun   Driver/ddr: Add s...
484
485
486
487
  		CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
  		Physical address from the view of DDR controllers. It is the
  		same as CONFIG_SYS_DDR_SDRAM_BASE for  all Power SoCs. But
  		it could be different for ARM SoCs.
6b1e1254f   York Sun   driver/ddr: Add 2...
488
489
490
491
  		CONFIG_SYS_FSL_DDR_INTLV_256B
  		DDR controller interleaving on 256-byte. This is a special
  		interleaving mode, handled by Dickens for Freescale layerscape
  		SoCs with ARM core.
1d71efbb0   York Sun   driver/ddr: Restr...
492
493
494
495
496
  		CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
  		Number of controllers used as main memory.
  
  		CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
  		Number of controllers used for other than main memory.
449372148   Prabhakar Kushwaha   armv8: LS2080A: R...
497
498
  		CONFIG_SYS_FSL_HAS_DP_DDR
  		Defines the SoC has DP-DDR used for DPAA.
028dbb8db   Ruchika Gupta   fsl_sec : Change ...
499
500
501
502
503
  		CONFIG_SYS_FSL_SEC_BE
  		Defines the SEC controller register space as Big Endian
  
  		CONFIG_SYS_FSL_SEC_LE
  		Defines the SEC controller register space as Little Endian
92bbd64e3   Daniel Schwierzeck   README: update MI...
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
  - MIPS CPU options:
  		CONFIG_SYS_INIT_SP_OFFSET
  
  		Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
  		pointer. This is needed for the temporary stack before
  		relocation.
  
  		CONFIG_SYS_MIPS_CACHE_MODE
  
  		Cache operation mode for the MIPS CPU.
  		See also arch/mips/include/asm/mipsregs.h.
  		Possible values are:
  			CONF_CM_CACHABLE_NO_WA
  			CONF_CM_CACHABLE_WA
  			CONF_CM_UNCACHED
  			CONF_CM_CACHABLE_NONCOHERENT
  			CONF_CM_CACHABLE_CE
  			CONF_CM_CACHABLE_COW
  			CONF_CM_CACHABLE_CUW
  			CONF_CM_CACHABLE_ACCELERATED
  
  		CONFIG_SYS_XWAY_EBU_BOOTCFG
  
  		Special option for Lantiq XWAY SoCs for booting from NOR flash.
  		See also arch/mips/cpu/mips32/start.S.
  
  		CONFIG_XWAY_SWAP_BYTES
  
  		Enable compilation of tools/xway-swap-bytes needed for Lantiq
  		XWAY SoCs for booting from NOR flash. The U-Boot image needs to
  		be swapped if a flash programmer is used.
b67d8816f   Christian Riesch   arm, arm926ejs: A...
535
536
537
538
539
  - ARM options:
  		CONFIG_SYS_EXCEPTION_VECTORS_HIGH
  
  		Select high exception vectors of the ARM core, e.g., do not
  		clear the V bit of the c1 register of CP15.
5356f5451   Aneesh V   ARM: enable Thumb...
540
541
542
543
544
545
546
  		CONFIG_SYS_THUMB_BUILD
  
  		Use this flag to build U-Boot using the Thumb instruction
  		set for ARM architectures. Thumb instruction set provides
  		better code density. For ARM architectures that support
  		Thumb2 this flag will result in Thumb2 code generated by
  		GCC.
207774b21   York Sun   armv8/ls2085a: Fi...
547
548
549
550
551
552
553
  		COUNTER_FREQUENCY
  		Generic timer clock source frequency.
  
  		COUNTER_FREQUENCY_REAL
  		Generic timer clock source frequency if the real clock is
  		different from COUNTER_FREQUENCY, and can only be determined
  		at run time.
73c38934d   Stephen Warren   ARM: tegra: suppo...
554
555
556
557
558
559
  - Tegra SoC options:
  		CONFIG_TEGRA_SUPPORT_NON_SECURE
  
  		Support executing U-Boot in non-secure (NS) mode. Certain
  		impossible actions will be skipped if the CPU is in NS mode,
  		such as ARM architectural timer initialization.
5da627a42   wdenk   * Patch by Steven...
560
  - Linux Kernel Interface:
c609719b8   wdenk   Initial revision
561
562
563
564
565
566
567
568
569
  		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.
c609719b8   wdenk   Initial revision
570
  		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
218ca724c   Wolfgang Denk   README: update do...
571
  		"clocks_in_mhz=1" is automatically included in the
c609719b8   wdenk   Initial revision
572
  		default environment.
5da627a42   wdenk   * Patch by Steven...
573
  		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]
b445bbb49   Jeremiah Mahler   doc: fix grammati...
574
  		When transferring memsize parameter to Linux, some versions
5da627a42   wdenk   * Patch by Steven...
575
576
  		expect it to be in bytes, others in MB.
  		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
fec6d9ee7   Gerald Van Baren   Remove the deprec...
577
  		CONFIG_OF_LIBFDT
f57f70aab   Wolfgang Denk   Support passing o...
578
579
  
  		New kernel versions are expecting firmware settings to be
213bf8c82   Gerald Van Baren   Add a flattened d...
580
581
582
583
584
585
  		passed using flattened device trees (based on open firmware
  		concepts).
  
  		CONFIG_OF_LIBFDT
  		 * New libfdt-based support
  		 * Adds the "fdt" command
3bb342fc8   Kim Phillips   fdt: remove unuse...
586
  		 * The bootm command automatically updates the fdt
213bf8c82   Gerald Van Baren   Add a flattened d...
587

b55ae4024   Marcel Ziswiler   FDT: remove obsol...
588
589
590
591
  		OF_CPU - The proper name of the cpus node (only required for
  			MPC512X and MPC5xxx based boards).
  		OF_SOC - The proper name of the soc node (only required for
  			MPC512X and MPC5xxx based boards).
f57f70aab   Wolfgang Denk   Support passing o...
592
  		OF_TBCLK - The timebase frequency.
c2871f038   Kumar Gala   Added OF_STDOUT_P...
593
  		OF_STDOUT_PATH - The path to the console device
f57f70aab   Wolfgang Denk   Support passing o...
594

11ccc33fa   Marcel Ziswiler   Many spelling fix...
595
596
  		boards with QUICC Engines require OF_QE to set UCC MAC
  		addresses
3bb342fc8   Kim Phillips   fdt: remove unuse...
597

4e2531378   Kumar Gala   Allow board code ...
598
599
600
601
  		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
f57f70aab   Wolfgang Denk   Support passing o...
602

c654b5172   Simon Glass   fdt: Add ft_syste...
603
604
605
606
607
608
  		CONFIG_OF_SYSTEM_SETUP
  
  		Other code has addition modification that it wants to make
  		to the flat device tree before handing it off to the kernel.
  		This causes ft_system_setup() to be called before booting
  		the kernel.
3887c3fbd   Heiko Schocher   mucmc52, uc101: d...
609
610
611
612
613
614
615
616
  		CONFIG_OF_IDE_FIXUP
  
  		U-Boot can detect if an IDE device is present or not.
  		If not, and this new config option is activated, U-Boot
  		removes the ATA node from the DTS before booting Linux,
  		so the Linux IDE driver does not probe the device and
  		crash. This is needed for buggy hardware (uc101) where
  		no pull down resistor is connected to the signal IDE5V_DD7.
7eb29398c   Igor Grinberg   arm: add CONFIG_M...
617
618
619
620
621
622
623
624
625
  		CONFIG_MACH_TYPE	[relevant for ARM only][mandatory]
  
  		This setting is mandatory for all boards that have only one
  		machine type and must be used to specify the machine type
  		number as it appears in the ARM machine registry
  		(see http://www.arm.linux.org.uk/developer/machines/).
  		Only boards that have multiple machine types supported
  		in a single configuration file and the machine type is
  		runtime discoverable, do not have to use this setting.
0b2f4ecad   Niklaus Giger   README: Document ...
626
627
628
  - vxWorks boot parameters:
  
  		bootvx constructs a valid bootline using the following
9e98b7e3c   Bin Meng   cmd: bootvx: Alwa...
629
630
  		environments variables: bootdev, bootfile, ipaddr, netmask,
  		serverip, gatewayip, hostname, othbootargs.
0b2f4ecad   Niklaus Giger   README: Document ...
631
  		It loads the vxWorks image pointed bootfile.
0b2f4ecad   Niklaus Giger   README: Document ...
632
633
  		Note: If a "bootargs" environment is defined, it will overwride
  		the defaults discussed just above.
2c451f783   Aneesh V   armv7: cache main...
634
635
636
637
  - Cache Configuration:
  		CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
  		CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
  		CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
93bc21930   Aneesh V   armv7: add PL310 ...
638
639
640
641
642
  - Cache Configuration for ARM:
  		CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
  				      controller
  		CONFIG_SYS_PL310_BASE - Physical base address of PL310
  					controller register space
6705d81e9   wdenk   * Patch by Andrea...
643
  - Serial Ports:
48d0192fe   Andreas Engel   Moved conditional...
644
  		CONFIG_PL010_SERIAL
6705d81e9   wdenk   * Patch by Andrea...
645
646
  
  		Define this if you want support for Amba PrimeCell PL010 UARTs.
48d0192fe   Andreas Engel   Moved conditional...
647
  		CONFIG_PL011_SERIAL
6705d81e9   wdenk   * Patch by Andrea...
648
649
650
651
652
653
654
655
656
657
658
659
660
  
  		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
d57dee578   Karicheri, Muralidharan   serial: nsl16550:...
661
662
663
664
  		CONFIG_SERIAL_HW_FLOW_CONTROL
  
  		Define this variable to enable hw flow control in serial driver.
  		Current user of this option is drivers/serial/nsl16550.c driver
6705d81e9   wdenk   * Patch by Andrea...
665

c609719b8   wdenk   Initial revision
666
  - Console Interface:
43d9616cf   wdenk   * Patch by Robert...
667
668
669
670
  		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
c609719b8   wdenk   Initial revision
671
672
673
674
  
  		Note: if CONFIG_8xx_CONS_NONE is defined, the serial
  		port routines must be defined elsewhere
  		(i.e. serial_init(), serial_getc(), ...)
c609719b8   wdenk   Initial revision
675
676
677
  - Console Baudrate:
  		CONFIG_BAUDRATE - in bps
  		Select one of the baudrates listed in
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
678
679
  		CONFIG_SYS_BAUDRATE_TABLE, see below.
  		CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
c609719b8   wdenk   Initial revision
680

c92fac91a   Heiko Schocher   82xx serial, smc:...
681
682
683
  - Console Rx buffer length
  		With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
  		the maximum receive buffer length for the SMC.
2b3f12c21   Heiko Schocher   8xx serial, smc: ...
684
  		This option is actual only for 82xx and 8xx possible.
c92fac91a   Heiko Schocher   82xx serial, smc:...
685
686
687
  		If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
  		must be defined, to setup the maximum idle timeout for
  		the SMC.
c609719b8   wdenk   Initial revision
688
689
690
691
692
693
694
695
  - 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
43d9616cf   wdenk   * Patch by Robert...
696
697
698
  		This can be used to pass arguments to the bootm
  		command. The value of CONFIG_BOOTARGS goes into the
  		environment value "bootargs".
c609719b8   wdenk   Initial revision
699
700
  
  		CONFIG_RAMBOOT and CONFIG_NFSBOOT
43d9616cf   wdenk   * Patch by Robert...
701
702
703
  		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
11ccc33fa   Marcel Ziswiler   Many spelling fix...
704
  		RAM and NFS.
c609719b8   wdenk   Initial revision
705

eda0ba38a   Heiko Schocher   bootcount: store ...
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
  - Bootcount:
  		CONFIG_BOOTCOUNT_LIMIT
  		Implements a mechanism for detecting a repeating reboot
  		cycle, see:
  		http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
  
  		CONFIG_BOOTCOUNT_ENV
  		If no softreset save registers are found on the hardware
  		"bootcount" is stored in the environment. To prevent a
  		saveenv on all reboots, the environment variable
  		"upgrade_available" is used. If "upgrade_available" is
  		0, "bootcount" is always 0, if "upgrade_available" is
  		1 "bootcount" is incremented in the environment.
  		So the Userspace Applikation must set the "upgrade_available"
  		and "bootcount" variable to 0, if a boot was successfully.
c609719b8   wdenk   Initial revision
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
  - 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.
602ad3b33   Jon Loeliger   README: Rewrite c...
745
  - Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
c609719b8   wdenk   Initial revision
746
747
  		CONFIG_KGDB_BAUDRATE
  		Select one of the baudrates listed in
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
748
  		CONFIG_SYS_BAUDRATE_TABLE, see below.
c609719b8   wdenk   Initial revision
749
750
  
  - Monitor Functions:
602ad3b33   Jon Loeliger   README: Rewrite c...
751
752
  		Monitor commands can be included or excluded
  		from the build by using the #include files
c6c621bdb   Stephen Warren   README: fix refer...
753
  		<config_cmd_all.h> and #undef'ing unwanted
ef0f2f575   Joe Hershberger   Move defaults fro...
754
  		commands, or adding #define's for wanted commands.
602ad3b33   Jon Loeliger   README: Rewrite c...
755
756
757
  
  		The default command configuration includes all commands
  		except those marked below with a "*".
b401b73d0   Marek Vasut   aes: Add 'aes' co...
758
  		CONFIG_CMD_AES		  AES 128 CBC encrypt/decrypt
602ad3b33   Jon Loeliger   README: Rewrite c...
759
  		CONFIG_CMD_ASKENV	* ask for env variable
602ad3b33   Jon Loeliger   README: Rewrite c...
760
761
762
763
764
  		CONFIG_CMD_BDI		  bdinfo
  		CONFIG_CMD_BEDBUG	* Include BedBug Debugger
  		CONFIG_CMD_BMP		* BMP support
  		CONFIG_CMD_BSP		* Board specific commands
  		CONFIG_CMD_BOOTD	  bootd
d2b2ffe31   Tom Rini   cmd_bootm.c: Add ...
765
  		CONFIG_CMD_BOOTI	* ARM64 Linux kernel Image support
602ad3b33   Jon Loeliger   README: Rewrite c...
766
  		CONFIG_CMD_CACHE	* icache, dcache
08d0d6f32   Michal Simek   common: Add new c...
767
  		CONFIG_CMD_CLK   	* clock command support
602ad3b33   Jon Loeliger   README: Rewrite c...
768
  		CONFIG_CMD_CONSOLE	  coninfo
710b99385   Mike Frysinger   crc32: make comma...
769
  		CONFIG_CMD_CRC32	* crc32
602ad3b33   Jon Loeliger   README: Rewrite c...
770
771
772
  		CONFIG_CMD_DATE		* support for RTC, date/time...
  		CONFIG_CMD_DHCP		* DHCP support
  		CONFIG_CMD_DIAG		* Diagnostics
a7c931045   Peter Tyser   Add support for M...
773
774
775
776
  		CONFIG_CMD_DS4510	* ds4510 I2C gpio commands
  		CONFIG_CMD_DS4510_INFO	* ds4510 I2C info command
  		CONFIG_CMD_DS4510_MEM	* ds4510 I2C eeprom/sram commansd
  		CONFIG_CMD_DS4510_RST	* ds4510 I2C rst command
602ad3b33   Jon Loeliger   README: Rewrite c...
777
778
  		CONFIG_CMD_DTT		* Digital Therm and Thermostat
  		CONFIG_CMD_ECHO		  echo arguments
246c69225   Peter Tyser   Add 'editenv' com...
779
  		CONFIG_CMD_EDITENV	  edit env variable
602ad3b33   Jon Loeliger   README: Rewrite c...
780
  		CONFIG_CMD_EEPROM	* EEPROM read/write support
aa9e60441   Nikita Kiryanov   cmd: eeprom: add ...
781
  		CONFIG_CMD_EEPROM_LAYOUT* EEPROM layout aware commands
602ad3b33   Jon Loeliger   README: Rewrite c...
782
  		CONFIG_CMD_ELF		* bootelf, bootvx
5e2b3e0c5   Joe Hershberger   env: Add a comman...
783
  		CONFIG_CMD_ENV_CALLBACK	* display details about env callbacks
fffad71bc   Joe Hershberger   env: Add a comman...
784
  		CONFIG_CMD_ENV_FLAGS	* display details about env flags
88733e2c6   Andrew Ruder   cmd_nvedit.c: Add...
785
  		CONFIG_CMD_ENV_EXISTS	* check existence of env variable
0c79cda01   Mike Frysinger   env: make import/...
786
  		CONFIG_CMD_EXPORTENV	* export the environment
03e2ecf6b   Stephen Warren   fs: separate CONF...
787
788
  		CONFIG_CMD_EXT2		* ext2 command support
  		CONFIG_CMD_EXT4		* ext4 command support
16f4d9335   Stephen Warren   README: document ...
789
790
  		CONFIG_CMD_FS_GENERIC	* filesystem commands (e.g. load, ls)
  					  that work for multiple fs types
59e890ef7   Christian Gmeiner   fs: make it possi...
791
  		CONFIG_CMD_FS_UUID	* Look up a filesystem UUID
bdab39d35   Mike Frysinger   rename CONFIG_CMD...
792
  		CONFIG_CMD_SAVEENV	  saveenv
602ad3b33   Jon Loeliger   README: Rewrite c...
793
  		CONFIG_CMD_FDC		* Floppy Disk Support
03e2ecf6b   Stephen Warren   fs: separate CONF...
794
  		CONFIG_CMD_FAT		* FAT command support
602ad3b33   Jon Loeliger   README: Rewrite c...
795
796
  		CONFIG_CMD_FLASH	  flinfo, erase, protect
  		CONFIG_CMD_FPGA		  FPGA device initialization support
4d98b5c8a   Vincent Stehlé   README: align def...
797
  		CONFIG_CMD_FUSE		* Device fuse support
53fdc7ef2   Anton Staaf   Add gettime command
798
  		CONFIG_CMD_GETTIME	* Get time since boot
a641b9794   Mike Frysinger   make `go` optional
799
  		CONFIG_CMD_GO		* the 'go' command (exec code)
a000b7950   Kim Phillips   common: add a gre...
800
  		CONFIG_CMD_GREPENV	* search environment
bf36c5d52   Simon Glass   Add hash command ...
801
  		CONFIG_CMD_HASH		* calculate hash / digest
602ad3b33   Jon Loeliger   README: Rewrite c...
802
803
804
  		CONFIG_CMD_I2C		* I2C serial bus support
  		CONFIG_CMD_IDE		* IDE harddisk support
  		CONFIG_CMD_IMI		  iminfo
8fdf1e0f6   Vipin Kumar   imls: Add support...
805
  		CONFIG_CMD_IMLS		  List all images found in NOR flash
4d98b5c8a   Vincent Stehlé   README: align def...
806
  		CONFIG_CMD_IMLS_NAND	* List all images found in NAND flash
602ad3b33   Jon Loeliger   README: Rewrite c...
807
  		CONFIG_CMD_IMMAP	* IMMR dump support
aa53233a1   Simon Glass   Add an I/O tracin...
808
  		CONFIG_CMD_IOTRACE	* I/O tracing for debugging
0c79cda01   Mike Frysinger   env: make import/...
809
  		CONFIG_CMD_IMPORTENV	* import an environment
c167cc020   Joe Hershberger   Add a new "ini" c...
810
  		CONFIG_CMD_INI		* import data from an ini file into the env
602ad3b33   Jon Loeliger   README: Rewrite c...
811
812
813
814
  		CONFIG_CMD_IRQ		* irqinfo
  		CONFIG_CMD_ITEST	  Integer/string test of 2 values
  		CONFIG_CMD_JFFS2	* JFFS2 Support
  		CONFIG_CMD_KGDB		* kgdb
4d98b5c8a   Vincent Stehlé   README: align def...
815
  		CONFIG_CMD_LDRINFO	* ldrinfo (display Blackfin loader)
d22c338e0   Joe Hershberger   net: Add link-loc...
816
817
  		CONFIG_CMD_LINK_LOCAL	* link-local IP address auto-configuration
  					  (169.254.*.*)
602ad3b33   Jon Loeliger   README: Rewrite c...
818
819
  		CONFIG_CMD_LOADB	  loadb
  		CONFIG_CMD_LOADS	  loads
4d98b5c8a   Vincent Stehlé   README: align def...
820
  		CONFIG_CMD_MD5SUM	* print md5 message digest
02c9aa1d4   Robin Getz   Add md5sum and sh...
821
  					  (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
15a33e49d   Simon Glass   Add option to dis...
822
  		CONFIG_CMD_MEMINFO	* Display detailed memory information
602ad3b33   Jon Loeliger   README: Rewrite c...
823
  		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
a2681707b   Wolfgang Denk   Feature Removal: ...
824
  					  loop, loopw
4d98b5c8a   Vincent Stehlé   README: align def...
825
  		CONFIG_CMD_MEMTEST	* mtest
602ad3b33   Jon Loeliger   README: Rewrite c...
826
827
828
  		CONFIG_CMD_MISC		  Misc functions like sleep etc
  		CONFIG_CMD_MMC		* MMC memory mapped support
  		CONFIG_CMD_MII		* MII utility commands
68d7d6510   Stefan Roese   Separate mtdparts...
829
  		CONFIG_CMD_MTDPARTS	* MTD partition support
602ad3b33   Jon Loeliger   README: Rewrite c...
830
831
  		CONFIG_CMD_NAND		* NAND support
  		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
4d98b5c8a   Vincent Stehlé   README: align def...
832
  		CONFIG_CMD_NFS		  NFS support
e92739d34   Peter Tyser   Add support for P...
833
  		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
c0f40859f   Wolfgang Denk   README: white-spa...
834
  		CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
602ad3b33   Jon Loeliger   README: Rewrite c...
835
836
837
838
839
  		CONFIG_CMD_PCI		* pciinfo
  		CONFIG_CMD_PCMCIA		* PCMCIA support
  		CONFIG_CMD_PING		* send ICMP ECHO_REQUEST to network
  					  host
  		CONFIG_CMD_PORTIO	* Port I/O
ff048ea91   Kenneth Waters   Add a command to ...
840
  		CONFIG_CMD_READ		* Read raw data from partition
602ad3b33   Jon Loeliger   README: Rewrite c...
841
842
  		CONFIG_CMD_REGINFO	* Register dump
  		CONFIG_CMD_RUN		  run command in env variable
d304931f2   Simon Glass   sandbox: Add 'sb'...
843
  		CONFIG_CMD_SANDBOX	* sb command to access sandbox features
602ad3b33   Jon Loeliger   README: Rewrite c...
844
  		CONFIG_CMD_SAVES	* save S record dump
c649e3c91   Simon Glass   dm: scsi: Rename ...
845
  		CONFIG_SCSI		* SCSI Support
602ad3b33   Jon Loeliger   README: Rewrite c...
846
847
848
849
  		CONFIG_CMD_SDRAM	* print SDRAM configuration information
  					  (requires CONFIG_CMD_I2C)
  		CONFIG_CMD_SETGETDCR	  Support for DCR Register access
  					  (4xx only)
f61ec45eb   Eric Nelson   README: Add descr...
850
  		CONFIG_CMD_SF		* Read/write/erase SPI NOR flash
4d98b5c8a   Vincent Stehlé   README: align def...
851
  		CONFIG_CMD_SHA1SUM	* print sha1 memory digest
02c9aa1d4   Robin Getz   Add md5sum and sh...
852
  					  (requires CONFIG_CMD_MEMORY)
7d861d95a   Bob Liu   blackfin: bf609: ...
853
  		CONFIG_CMD_SOFTSWITCH	* Soft switch setting command for BF60x
74de7aefd   Wolfgang Denk   Add "source" comm...
854
  		CONFIG_CMD_SOURCE	  "source" command Support
602ad3b33   Jon Loeliger   README: Rewrite c...
855
  		CONFIG_CMD_SPI		* SPI serial bus support
7a83af07a   Luca Ceresoli   TFTP: add tftpsrv...
856
  		CONFIG_CMD_TFTPSRV	* TFTP transfer in server mode
1fb7cd498   Simon Glass   net: tftpput: imp...
857
  		CONFIG_CMD_TFTPPUT	* TFTP put command (upload)
da83bcd7b   Joe Hershberger   Add a command to ...
858
859
  		CONFIG_CMD_TIME		* run command and report execution time (ARM specific)
  		CONFIG_CMD_TIMER	* access to the system tick timer
602ad3b33   Jon Loeliger   README: Rewrite c...
860
  		CONFIG_CMD_USB		* USB support
602ad3b33   Jon Loeliger   README: Rewrite c...
861
  		CONFIG_CMD_CDP		* Cisco Discover Protocol support
c8339f515   Marek Vasut   CMD: Fix typo CMD...
862
  		CONFIG_CMD_MFSL		* Microblaze FSL support
4d98b5c8a   Vincent Stehlé   README: align def...
863
  		CONFIG_CMD_XIMG		  Load part of Multi Image
89c8230de   Przemyslaw Marczak   new commands: uui...
864
  		CONFIG_CMD_UUID		* Generate random UUID or GUID string
c609719b8   wdenk   Initial revision
865
866
867
  
  		EXAMPLE: If you want all functions except of network
  		support you can write:
602ad3b33   Jon Loeliger   README: Rewrite c...
868
869
  		#include "config_cmd_all.h"
  		#undef CONFIG_CMD_NET
c609719b8   wdenk   Initial revision
870

213bf8c82   Gerald Van Baren   Add a flattened d...
871
872
  	Other Commands:
  		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
c609719b8   wdenk   Initial revision
873
874
  
  	Note:	Don't enable the "icache" and "dcache" commands
602ad3b33   Jon Loeliger   README: Rewrite c...
875
  		(configuration option CONFIG_CMD_CACHE) unless you know
43d9616cf   wdenk   * Patch by Robert...
876
877
878
879
880
881
  		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.
c609719b8   wdenk   Initial revision
882
883
884
  
  
  		XXX - this list needs to get updated!
302a64875   Simon Glass   Add an option to ...
885
886
887
888
889
890
891
  - Removal of commands
  		If no commands are needed to boot, you can disable
  		CONFIG_CMDLINE to remove them. In this case, the command line
  		will not be available, and when U-Boot wants to execute the
  		boot command (on start-up) it will call board_run_command()
  		instead. This can reduce image size significantly for very
  		simple boot procedures.
a5ecbe62c   Wolfgang Denk   Add SLRE - Super ...
892
893
  - Regular expression support:
  		CONFIG_REGEX
93e145964   Wolfgang Denk   Coding Style clea...
894
895
896
897
  		If this variable is defined, U-Boot is linked against
  		the SLRE (Super Light Regular Expression) library,
  		which adds regex support to some commands, as for
  		example "env grep" and "setexpr".
a5ecbe62c   Wolfgang Denk   Add SLRE - Super ...
898

45ba8077f   Simon Glass   fdt: ARM: Add dev...
899
900
901
902
903
904
905
  - Device tree:
  		CONFIG_OF_CONTROL
  		If this variable is defined, U-Boot will use a device tree
  		to configure its devices, instead of relying on statically
  		compiled #defines in the board file. This option is
  		experimental and only available on a few boards. The device
  		tree is available in the global data as gd->fdt_blob.
2c0f79e44   Simon Glass   fdt: Add support ...
906
907
  		U-Boot needs to get its device tree from somewhere. This can
  		be done using one of the two options below:
bbb0b128c   Simon Glass   fdt: Add support ...
908
909
910
911
912
913
914
  
  		CONFIG_OF_EMBED
  		If this variable is defined, U-Boot will embed a device tree
  		binary in its image. This device tree file should be in the
  		board directory and called <soc>-<board>.dts. The binary file
  		is then picked up in board_init_f() and made available through
  		the global data structure as gd->blob.
45ba8077f   Simon Glass   fdt: ARM: Add dev...
915

2c0f79e44   Simon Glass   fdt: Add support ...
916
917
918
919
920
921
922
923
924
925
926
  		CONFIG_OF_SEPARATE
  		If this variable is defined, U-Boot will build a device tree
  		binary. It will be called u-boot.dtb. Architecture-specific
  		code will locate it at run-time. Generally this works by:
  
  			cat u-boot.bin u-boot.dtb >image.bin
  
  		and in fact, U-Boot does this for you, creating a file called
  		u-boot-dtb.bin which is useful in the common case. You can
  		still use the individual files if you need something more
  		exotic.
c609719b8   wdenk   Initial revision
927
928
929
  - Watchdog:
  		CONFIG_WATCHDOG
  		If this variable is defined, it enables watchdog
6abe6fb68   Detlev Zundel   README: Clarify d...
930
931
932
933
934
935
936
937
938
939
940
  		support for the SoC. There must be support in the SoC
  		specific code for a watchdog. For the 8xx and 8260
  		CPUs, the SIU Watchdog feature is enabled in the SYPCR
  		register.  When supported for a specific SoC is
  		available, then no further board specific code should
  		be needed to use it.
  
  		CONFIG_HW_WATCHDOG
  		When using a watchdog circuitry external to the used
  		SoC, then define this variable and provide board
  		specific code for the "hw_watchdog_reset" function.
c609719b8   wdenk   Initial revision
941

7bae0d6f6   Heiko Schocher   arm, at91, wdt: m...
942
943
  		CONFIG_AT91_HW_WDT_TIMEOUT
  		specify the timeout in seconds. default 2 seconds.
c1551ea81   stroese   U-Boot version en...
944
945
946
947
948
  - 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.
a1ea8e510   Benoît Thébaudeau   README: Update ve...
949
950
  		Any change to this variable will be reverted at the
  		next reset.
c1551ea81   stroese   U-Boot version en...
951

c609719b8   wdenk   Initial revision
952
  - Real-Time Clock:
602ad3b33   Jon Loeliger   README: Rewrite c...
953
  		When CONFIG_CMD_DATE is selected, the type of the RTC
c609719b8   wdenk   Initial revision
954
955
956
957
958
  		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
4e8b7544b   Fabio Estevam   rtc: Make mc13783...
959
  		CONFIG_RTC_MC13XXX	- use MC13783 or MC13892 RTC
c609719b8   wdenk   Initial revision
960
  		CONFIG_RTC_MC146818	- use MC146818 RTC
1cb8e980c   wdenk   * Patches by Davi...
961
  		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
c609719b8   wdenk   Initial revision
962
  		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
7f70e8530   wdenk   * Patch by David ...
963
  		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
412921d29   Markus Niebel   RTC: add support ...
964
  		CONFIG_RTC_DS1339	- use Maxim, Inc. DS1339 RTC
3bac35137   wdenk   * Patch by Josef ...
965
  		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
9536dfcce   Tor Krill   Add support for I...
966
  		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
4c0d4c3b7   wdenk   * Patch by Tom Ar...
967
  		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
968
  		CONFIG_SYS_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
71d19f30d   Heiko Schocher   rtc, rv3029: add ...
969
970
  		CONFIG_SYS_RV3029_TCR	- enable trickle charger on
  					  RV3029 RTC.
c609719b8   wdenk   Initial revision
971

b37c7e5e5   wdenk   * Patch by Seb Ja...
972
973
  		Note that if the RTC uses I2C, then the I2C interface
  		must also be configured. See I2C Support, below.
e92739d34   Peter Tyser   Add support for P...
974
975
  - GPIO Support:
  		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
e92739d34   Peter Tyser   Add support for P...
976

5dec49ca2   Chris Packham   pca953x: support ...
977
978
979
  		The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
  		chip-ngpio pairs that tell the PCA953X driver the number of
  		pins supported by a particular chip.
e92739d34   Peter Tyser   Add support for P...
980
981
  		Note that if the GPIO device uses I2C, then the I2C interface
  		must also be configured. See I2C Support, below.
aa53233a1   Simon Glass   Add an I/O tracin...
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
  - I/O tracing:
  		When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
  		accesses and can checksum them or write a list of them out
  		to memory. See the 'iotrace' command for details. This is
  		useful for testing device drivers since it can confirm that
  		the driver behaves the same way before and after a code
  		change. Currently this is supported on sandbox and arm. To
  		add support for your architecture, add '#include <iotrace.h>'
  		to the bottom of arch/<arch>/include/asm/io.h and test.
  
  		Example output from the 'iotrace stats' command is below.
  		Note that if the trace buffer is exhausted, the checksum will
  		still continue to operate.
  
  			iotrace is enabled
  			Start:  10000000	(buffer start address)
  			Size:   00010000	(buffer size)
  			Offset: 00000120	(current buffer offset)
  			Output: 10000120	(start + offset)
  			Count:  00000018	(number of trace records)
  			CRC32:  9526fb66	(CRC32 of all trace records)
c609719b8   wdenk   Initial revision
1003
  - Timestamp Support:
43d9616cf   wdenk   * Patch by Robert...
1004
1005
1006
  		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
602ad3b33   Jon Loeliger   README: Rewrite c...
1007
  		automatically enabled when you select CONFIG_CMD_DATE .
c609719b8   wdenk   Initial revision
1008

923c46f97   Karl O. Pinc   README: Cleanup d...
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
  - Partition Labels (disklabels) Supported:
  		Zero or more of the following:
  		CONFIG_MAC_PARTITION   Apple's MacOS partition table.
  		CONFIG_DOS_PARTITION   MS Dos partition table, traditional on the
  				       Intel architecture, USB sticks, etc.
  		CONFIG_ISO_PARTITION   ISO partition table, used on CDROM etc.
  		CONFIG_EFI_PARTITION   GPT partition table, common when EFI is the
  				       bootloader.  Note 2TB partition limit; see
  				       disk/part_efi.c
  		CONFIG_MTD_PARTITIONS  Memory Technology Device partition table.
c609719b8   wdenk   Initial revision
1019

218ca724c   Wolfgang Denk   README: update do...
1020
  		If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
c649e3c91   Simon Glass   dm: scsi: Rename ...
1021
  		CONFIG_SCSI) you must configure support for at
923c46f97   Karl O. Pinc   README: Cleanup d...
1022
  		least one non-MTD partition type as well.
c609719b8   wdenk   Initial revision
1023
1024
  
  - IDE Reset method:
4d13cbad1   wdenk   * Patch by Toluna...
1025
1026
  		CONFIG_IDE_RESET_ROUTINE - this is defined in several
  		board configurations files but used nowhere!
c609719b8   wdenk   Initial revision
1027

4d13cbad1   wdenk   * Patch by Toluna...
1028
1029
1030
1031
  		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
c609719b8   wdenk   Initial revision
1032
1033
1034
1035
1036
  
  - ATAPI Support:
  		CONFIG_ATAPI
  
  		Set this to enable ATAPI support.
c40b29568   wdenk   * Patch by Rune T...
1037
1038
1039
1040
  - LBA48 Support
  		CONFIG_LBA48
  
  		Set this to enable support for disks larger than 137GB
4b142febf   Heiko Schocher   common: delete CO...
1041
  		Also look at CONFIG_SYS_64BIT_LBA.
c40b29568   wdenk   * Patch by Rune T...
1042
1043
  		Whithout these , LBA48 support uses 32bit variables and will 'only'
  		support disks up to 2.1TB.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
1044
  		CONFIG_SYS_64BIT_LBA:
c40b29568   wdenk   * Patch by Rune T...
1045
1046
  			When enabled, makes the IDE subsystem use 64bit sector addresses.
  			Default is 32bit.
c609719b8   wdenk   Initial revision
1047
1048
1049
1050
  - SCSI Support:
  		At the moment only there is only support for the
  		SYM53C8XX SCSI controller; define
  		CONFIG_SCSI_SYM53C8XX to enable it.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
1051
1052
1053
  		CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
  		CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
  		CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
c609719b8   wdenk   Initial revision
1054
1055
  		maximum numbers of LUNs, SCSI ID's and target
  		devices.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
1056
  		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
c609719b8   wdenk   Initial revision
1057

93e145964   Wolfgang Denk   Coding Style clea...
1058
1059
  		The environment variable 'scsidevs' is set to the number of
  		SCSI devices found during the last scan.
447c031ba   Stefan Reinauer   scsi: Add functio...
1060

c609719b8   wdenk   Initial revision
1061
  - NETWORK Support (PCI):
682011ff6   wdenk   * Patches by Udi ...
1062
  		CONFIG_E1000
ce5207e19   Kyle Moffett   e1000: Allow dire...
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
  		Support for Intel 8254x/8257x gigabit chips.
  
  		CONFIG_E1000_SPI
  		Utility code for direct access to the SPI bus on Intel 8257x.
  		This does not do anything useful unless you set at least one
  		of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
  
  		CONFIG_E1000_SPI_GENERIC
  		Allow generic access to the SPI bus on the Intel 8257x, for
  		example with the "sspi" command.
  
  		CONFIG_CMD_E1000
  		Management command for E1000 devices.  When used on devices
  		with SPI support you can reprogram the EEPROM from U-Boot.
53cf9435c   stroese   - CFG_RX_ETH_BUFF...
1077

c609719b8   wdenk   Initial revision
1078
1079
  		CONFIG_EEPRO100
  		Support for Intel 82557/82559/82559ER chips.
11ccc33fa   Marcel Ziswiler   Many spelling fix...
1080
  		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
c609719b8   wdenk   Initial revision
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
  		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.
45219c466   wdenk   Patch by Mathijs ...
1093
  - NETWORK Support (other):
c041e9d21   Jens Scharsig   new at91_emac net...
1094
1095
1096
1097
1098
1099
1100
1101
1102
  		CONFIG_DRIVER_AT91EMAC
  		Support for AT91RM9200 EMAC.
  
  			CONFIG_RMII
  			Define this to use reduced MII inteface
  
  			CONFIG_DRIVER_AT91EMAC_QUIET
  			If this defined, the driver is quiet.
  			The driver doen't show link status messages.
efdd73195   Rob Herring   net: add Calxeda ...
1103
1104
  		CONFIG_CALXEDA_XGMAC
  		Support for the Calxeda XGMAC device
3bb46d23f   Ashok   README : Rename C...
1105
  		CONFIG_LAN91C96
45219c466   wdenk   Patch by Mathijs ...
1106
  		Support for SMSC's LAN91C96 chips.
45219c466   wdenk   Patch by Mathijs ...
1107
1108
  			CONFIG_LAN91C96_USE_32_BIT
  			Define this to enable 32 bit addressing
3bb46d23f   Ashok   README : Rename C...
1109
  		CONFIG_SMC91111
f39748ae8   wdenk   * Patch by Paul R...
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
  		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)
dc02badab   Heiko Schocher   arm, davinci_emac...
1122
1123
1124
1125
1126
  		CONFIG_DRIVER_TI_EMAC
  		Support for davinci emac
  
  			CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
  			Define this if you have more then 3 PHYs.
b3dbf4a51   Macpaul Lin   ftgmac100: suppor...
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
  		CONFIG_FTGMAC100
  		Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
  
  			CONFIG_FTGMAC100_EGIGA
  			Define this to use GE link update with gigabit PHY.
  			Define this if FTGMAC100 is connected to gigabit PHY.
  			If your system has 10/100 PHY only, it might not occur
  			wrong behavior. Because PHY usually return timeout or
  			useless data when polling gigabit status and gigabit
  			control registers. This behavior won't affect the
  			correctnessof 10/100 link speed update.
c2fff331a   Mike Rapoport   smc911x: update S...
1138
  		CONFIG_SMC911X
557b377d8   Jens Gehrlein   smc911x: add 16 b...
1139
  		Support for SMSC's LAN911x and LAN921x chips
c2fff331a   Mike Rapoport   smc911x: update S...
1140
  			CONFIG_SMC911X_BASE
557b377d8   Jens Gehrlein   smc911x: add 16 b...
1141
1142
  			Define this to hold the physical address
  			of the device (I/O space)
c2fff331a   Mike Rapoport   smc911x: update S...
1143
  			CONFIG_SMC911X_32_BIT
557b377d8   Jens Gehrlein   smc911x: add 16 b...
1144
  			Define this if data bus is 32 bits
c2fff331a   Mike Rapoport   smc911x: update S...
1145
  			CONFIG_SMC911X_16_BIT
557b377d8   Jens Gehrlein   smc911x: add 16 b...
1146
1147
  			Define this if data bus is 16 bits. If your processor
  			automatically converts one 32 bit word to two 16 bit
c2fff331a   Mike Rapoport   smc911x: update S...
1148
  			words you may also try CONFIG_SMC911X_32_BIT.
557b377d8   Jens Gehrlein   smc911x: add 16 b...
1149

3d0075fa7   Yoshihiro Shimoda   README: add descr...
1150
1151
1152
1153
1154
1155
1156
1157
  		CONFIG_SH_ETHER
  		Support for Renesas on-chip Ethernet controller
  
  			CONFIG_SH_ETHER_USE_PORT
  			Define the number of ports to be used
  
  			CONFIG_SH_ETHER_PHY_ADDR
  			Define the ETH PHY's address
68260aab9   Yoshihiro Shimoda   net: sh_eth: add ...
1158
1159
  			CONFIG_SH_ETHER_CACHE_WRITEBACK
  			If this option is set, the driver enables cache flush.
b2f97cf27   Heiko Schocher   pwm, imx6: add su...
1160
1161
  - PWM Support:
  		CONFIG_PWM_IMX
5052e8198   Robert P. J. Day   PWM: Correct miss...
1162
  		Support for PWM module on the imx6.
b2f97cf27   Heiko Schocher   pwm, imx6: add su...
1163

5e1247247   Vadim Bendebury   Introduce generic...
1164
  - TPM Support:
90899cc01   Che-liang Chiou   tpm: Rename gener...
1165
1166
  		CONFIG_TPM
  		Support TPM devices.
0766ad2f7   Christophe Ricard   dm: tpm: Move tpm...
1167
1168
  		CONFIG_TPM_TIS_INFINEON
  		Support for Infineon i2c bus TPM devices. Only one device
1b393db58   Tom Wai-Hong Tam   tpm: Reorganize t...
1169
  		per system is supported at this time.
1b393db58   Tom Wai-Hong Tam   tpm: Reorganize t...
1170
1171
  			CONFIG_TPM_TIS_I2C_BURST_LIMITATION
  			Define the burst count bytes upper limit
3aa74088d   Christophe Ricard   tpm: st33zp24: Ad...
1172
1173
1174
1175
1176
1177
  		CONFIG_TPM_ST33ZP24
  		Support for STMicroelectronics TPM devices. Requires DM_TPM support.
  
  			CONFIG_TPM_ST33ZP24_I2C
  			Support for STMicroelectronics ST33ZP24 I2C devices.
  			Requires TPM_ST33ZP24 and I2C.
b75fdc11e   Christophe Ricard   tpm: st33zp24: Ad...
1178
1179
1180
  			CONFIG_TPM_ST33ZP24_SPI
  			Support for STMicroelectronics ST33ZP24 SPI devices.
  			Requires TPM_ST33ZP24 and SPI.
c01939c76   Dirk Eibach   Add Atmel I2C tpm
1181
1182
  		CONFIG_TPM_ATMEL_TWI
  		Support for Atmel TWI TPM device. Requires I2C support.
90899cc01   Che-liang Chiou   tpm: Rename gener...
1183
  		CONFIG_TPM_TIS_LPC
5e1247247   Vadim Bendebury   Introduce generic...
1184
1185
1186
1187
1188
1189
1190
  		Support for generic parallel port TPM devices. Only one device
  		per system is supported at this time.
  
  			CONFIG_TPM_TIS_BASE_ADDRESS
  			Base address where the generic TPM device is mapped
  			to. Contemporary x86 systems usually map it at
  			0xfed40000.
be6c1529c   Reinhard Pfau   tpm: add AUTH1 cm...
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
  		CONFIG_CMD_TPM
  		Add tpm monitor functions.
  		Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
  		provides monitor access to authorized functions.
  
  		CONFIG_TPM
  		Define this to enable the TPM support library which provides
  		functional interfaces to some TPM commands.
  		Requires support for a TPM device.
  
  		CONFIG_TPM_AUTH_SESSIONS
  		Define this to enable authorized functions in the TPM library.
  		Requires CONFIG_TPM and CONFIG_SHA1.
c609719b8   wdenk   Initial revision
1204
1205
  - USB Support:
  		At the moment only the UHCI host controller is
4d13cbad1   wdenk   * Patch by Toluna...
1206
  		supported (PIP405, MIP405, MPC5200); define
c609719b8   wdenk   Initial revision
1207
1208
  		CONFIG_USB_UHCI to enable it.
  		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
30d56fae2   wdenk   Patch by Sam Song...
1209
  		and define CONFIG_USB_STORAGE to enable the USB
c609719b8   wdenk   Initial revision
1210
1211
1212
1213
  		storage devices.
  		Note:
  		Supported are USB Keyboards and USB Floppy drives
  		(TEAC FD-05PUB).
4d13cbad1   wdenk   * Patch by Toluna...
1214
1215
1216
  		MPC5200 USB requires additional defines:
  			CONFIG_USB_CLOCK
  				for 528 MHz Clock: 0x0001bbbb
307ecb6db   Eric Millbrandt   Add support for U...
1217
1218
  			CONFIG_PSC3_USB
  				for USB on PSC3
4d13cbad1   wdenk   * Patch by Toluna...
1219
1220
1221
  			CONFIG_USB_CONFIG
  				for differential drivers: 0x00001000
  				for single ended drivers: 0x00005000
307ecb6db   Eric Millbrandt   Add support for U...
1222
1223
  				for differential drivers on PSC3: 0x00000100
  				for single ended drivers on PSC3: 0x00004100
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
1224
  			CONFIG_SYS_USB_EVENT_POLL
fdcfaa1b0   Zhang Wei   USB event poll su...
1225
1226
  				May be defined to allow interrupt polling
  				instead of using asynchronous interrupts
4d13cbad1   wdenk   * Patch by Toluna...
1227

9ab4ce223   Simon Glass   usb: Add support ...
1228
1229
  		CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
  		txfilltuning field in the EHCI controller on reset.
6e9e06260   Oleksandr Tymoshenko   usb: dwc2: Add dr...
1230
1231
  		CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
  		HW module registers.
16c8d5e76   Wolfgang Denk   Various USB relat...
1232
1233
1234
1235
  - USB Device:
  		Define the below if you wish to use the USB console.
  		Once firmware is rebuilt from a serial console issue the
  		command "setenv stdin usbtty; setenv stdout usbtty" and
11ccc33fa   Marcel Ziswiler   Many spelling fix...
1236
  		attach your USB cable. The Unix command "dmesg" should print
16c8d5e76   Wolfgang Denk   Various USB relat...
1237
1238
  		it has found a new device. The environment variable usbtty
  		can be set to gserial or cdc_acm to enable your device to
386eda022   Wolfgang Denk   Code cleanup
1239
  		appear to a USB host as a Linux gserial device or a
16c8d5e76   Wolfgang Denk   Various USB relat...
1240
1241
1242
1243
1244
1245
1246
  		Common Device Class Abstract Control Model serial device.
  		If you select usbtty = gserial you should be able to enumerate
  		a Linux host by
  		# modprobe usbserial vendor=0xVendorID product=0xProductID
  		else if using cdc_acm, simply setting the environment
  		variable usbtty to be cdc_acm should suffice. The following
  		might be defined in YourBoardName.h
386eda022   Wolfgang Denk   Code cleanup
1247

16c8d5e76   Wolfgang Denk   Various USB relat...
1248
1249
1250
1251
1252
1253
  			CONFIG_USB_DEVICE
  			Define this to build a UDC device
  
  			CONFIG_USB_TTY
  			Define this to have a tty type of device available to
  			talk to the UDC device
386eda022   Wolfgang Denk   Code cleanup
1254

f9da0f894   Vipin KUMAR   Enable high speed...
1255
1256
1257
1258
1259
1260
1261
  			CONFIG_USBD_HS
  			Define this to enable the high speed support for usb
  			device and usbtty. If this feature is enabled, a routine
  			int is_usbd_high_speed(void)
  			also needs to be defined by the driver to dynamically poll
  			whether the enumeration has succeded at high speed or full
  			speed.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
1262
  			CONFIG_SYS_CONSOLE_IS_IN_ENV
16c8d5e76   Wolfgang Denk   Various USB relat...
1263
1264
1265
1266
  			Define this if you want stdin, stdout &/or stderr to
  			be set to usbtty.
  
  			mpc8xx:
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
1267
  				CONFIG_SYS_USB_EXTC_CLK 0xBLAH
16c8d5e76   Wolfgang Denk   Various USB relat...
1268
  				Derive USB clock from external clock "blah"
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
1269
  				- CONFIG_SYS_USB_EXTC_CLK 0x02
386eda022   Wolfgang Denk   Code cleanup
1270

386eda022   Wolfgang Denk   Code cleanup
1271
  		If you have a USB-IF assigned VendorID then you may wish to
16c8d5e76   Wolfgang Denk   Various USB relat...
1272
  		define your own vendor specific values either in BoardName.h
386eda022   Wolfgang Denk   Code cleanup
1273
  		or directly in usbd_vendor_info.h. If you don't define
16c8d5e76   Wolfgang Denk   Various USB relat...
1274
1275
1276
1277
1278
1279
1280
  		CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
  		CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
  		should pretend to be a Linux device to it's target host.
  
  			CONFIG_USBD_MANUFACTURER
  			Define this string as the name of your company for
  			- CONFIG_USBD_MANUFACTURER "my company"
386eda022   Wolfgang Denk   Code cleanup
1281

16c8d5e76   Wolfgang Denk   Various USB relat...
1282
1283
1284
1285
1286
1287
1288
1289
1290
  			CONFIG_USBD_PRODUCT_NAME
  			Define this string as the name of your product
  			- CONFIG_USBD_PRODUCT_NAME "acme usb device"
  
  			CONFIG_USBD_VENDORID
  			Define this as your assigned Vendor ID from the USB
  			Implementors Forum. This *must* be a genuine Vendor ID
  			to avoid polluting the USB namespace.
  			- CONFIG_USBD_VENDORID 0xFFFF
386eda022   Wolfgang Denk   Code cleanup
1291

16c8d5e76   Wolfgang Denk   Various USB relat...
1292
1293
1294
1295
  			CONFIG_USBD_PRODUCTID
  			Define this as the unique Product ID
  			for your device
  			- CONFIG_USBD_PRODUCTID 0xFFFF
4d13cbad1   wdenk   * Patch by Toluna...
1296

d70a560fd   Igor Grinberg   README: add docum...
1297
1298
1299
1300
1301
1302
1303
1304
  - ULPI Layer Support:
  		The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
  		the generic ULPI layer. The generic layer accesses the ULPI PHY
  		via the platform viewport, so you need both the genric layer and
  		the viewport enabled. Currently only Chipidea/ARC based
  		viewport is supported.
  		To enable the ULPI layer support, define CONFIG_USB_ULPI and
  		CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
6d365ea0a   Lucas Stach   tegra20: add USB ...
1305
1306
1307
  		If your ULPI phy needs a different reference clock than the
  		standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
  		the appropriate value in Hz.
c609719b8   wdenk   Initial revision
1308

71f951180   wdenk   * Fix CONFIG_NET_...
1309
  - MMC Support:
8bde7f776   wdenk   * Code cleanup:
1310
1311
1312
  		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
71f951180   wdenk   * Fix CONFIG_NET_...
1313
  		to physical memory similar to flash. Command line is
602ad3b33   Jon Loeliger   README: Rewrite c...
1314
1315
  		enabled with CONFIG_CMD_MMC. The MMC driver also works with
  		the FAT fs. This is enabled with CONFIG_CMD_FAT.
71f951180   wdenk   * Fix CONFIG_NET_...
1316

afb35666d   Yoshihiro Shimoda   mmc: sh_mmcif: ad...
1317
1318
1319
1320
1321
1322
1323
1324
  		CONFIG_SH_MMCIF
  		Support for Renesas on-chip MMCIF controller
  
  			CONFIG_SH_MMCIF_ADDR
  			Define the base address of MMCIF registers
  
  			CONFIG_SH_MMCIF_CLK
  			Define the clock frequency for MMCIF
1fd93c6e7   Pierre Aubert   eMMC: cmd_mmc.c a...
1325
1326
1327
1328
1329
1330
  		CONFIG_SUPPORT_EMMC_BOOT
  		Enable some additional features of the eMMC boot partitions.
  
  		CONFIG_SUPPORT_EMMC_RPMB
  		Enable the commands for reading, writing and programming the
  		key for the Replay Protection Memory Block partition in eMMC.
b3ba6e94b   Tom Rini   README: Document ...
1331
  - USB Device Firmware Update (DFU) class support:
01acd6abb   Paul Kocialkowski   usb: USB download...
1332
  		CONFIG_USB_FUNCTION_DFU
b3ba6e94b   Tom Rini   README: Document ...
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
  		This enables the USB portion of the DFU USB class
  
  		CONFIG_CMD_DFU
  		This enables the command "dfu" which is used to have
  		U-Boot create a DFU class device via USB.  This command
  		requires that the "dfu_alt_info" environment variable be
  		set and define the alt settings to expose to the host.
  
  		CONFIG_DFU_MMC
  		This enables support for exposing (e)MMC devices via DFU.
c6631764c   Pantelis Antoniou   dfu: NAND specifi...
1343
1344
  		CONFIG_DFU_NAND
  		This enables support for exposing NAND devices via DFU.
a9479f043   Afzal Mohammed   dfu: ram support
1345
1346
1347
1348
1349
  		CONFIG_DFU_RAM
  		This enables support for exposing RAM via DFU.
  		Note: DFU spec refer to non-volatile memory usage, but
  		allow usages beyond the scope of spec - here RAM usage,
  		one that would help mostly the developer.
e7e75c70c   Heiko Schocher   dfu: make data bu...
1350
1351
1352
1353
1354
  		CONFIG_SYS_DFU_DATA_BUF_SIZE
  		Dfu transfer uses a buffer before writing data to the
  		raw storage device. Make the size (in bytes) of this buffer
  		configurable. The size of this buffer is also configurable
  		through the "dfu_bufsiz" environment variable.
ea2453d56   Pantelis Antoniou   dfu: Support larg...
1355
1356
1357
1358
1359
1360
  		CONFIG_SYS_DFU_MAX_FILE_SIZE
  		When updating files rather than the raw storage device,
  		we use a static buffer to copy the file into and then write
  		the buffer once we've been given the whole file.  Define
  		this to the maximum filesize (in bytes) for the buffer.
  		Default is 4 MiB if undefined.
001a83198   Heiko Schocher   usb: dfu: introdu...
1361
1362
1363
1364
1365
1366
1367
1368
1369
  		DFU_DEFAULT_POLL_TIMEOUT
  		Poll timeout [ms], is the timeout a device can send to the
  		host. The host must wait for this timeout before sending
  		a subsequent DFU_GET_STATUS request to the device.
  
  		DFU_MANIFEST_POLL_TIMEOUT
  		Poll timeout [ms], which the device sends to the host when
  		entering dfuMANIFEST state. Host waits this timeout, before
  		sending again an USB request to the device.
3aab70afc   Sebastian Siewior   usb/gadget: add t...
1370
  - USB Device Android Fastboot support:
17da3c0c8   Paul Kocialkowski   usb: Fastboot fun...
1371
1372
  		CONFIG_USB_FUNCTION_FASTBOOT
  		This enables the USB part of the fastboot gadget
3aab70afc   Sebastian Siewior   usb/gadget: add t...
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
  		CONFIG_CMD_FASTBOOT
  		This enables the command "fastboot" which enables the Android
  		fastboot mode for the platform's USB device. Fastboot is a USB
  		protocol for downloading images, flashing and device control
  		used on Android devices.
  		See doc/README.android-fastboot for more information.
  
  		CONFIG_ANDROID_BOOT_IMAGE
  		This enables support for booting images which use the Android
  		image format header.
a588d99ac   Paul Kocialkowski   usb: CONFIG_USB_F...
1383
  		CONFIG_FASTBOOT_BUF_ADDR
3aab70afc   Sebastian Siewior   usb/gadget: add t...
1384
1385
1386
  		The fastboot protocol requires a large memory buffer for
  		downloads. Define this to the starting RAM address to use for
  		downloaded images.
a588d99ac   Paul Kocialkowski   usb: CONFIG_USB_F...
1387
  		CONFIG_FASTBOOT_BUF_SIZE
3aab70afc   Sebastian Siewior   usb/gadget: add t...
1388
1389
1390
  		The fastboot protocol requires a large memory buffer for
  		downloads. This buffer should be as large as possible for a
  		platform. Define this to the size available RAM for fastboot.
d1b5ed075   Steve Rae   usb/gadget: fastb...
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
  
  		CONFIG_FASTBOOT_FLASH
  		The fastboot protocol includes a "flash" command for writing
  		the downloaded image to a non-volatile storage device. Define
  		this to enable the "fastboot flash" command.
  
  		CONFIG_FASTBOOT_FLASH_MMC_DEV
  		The fastboot "flash" command requires additional information
  		regarding the non-volatile storage device. Define this to
  		the eMMC device that fastboot should use to store the image.
3aab70afc   Sebastian Siewior   usb/gadget: add t...
1401

0ff7e585d   Steve Rae   fastboot: handle ...
1402
1403
1404
1405
1406
1407
1408
  		CONFIG_FASTBOOT_GPT_NAME
  		The fastboot "flash" command supports writing the downloaded
  		image to the Protective MBR and the Primary GUID Partition
  		Table. (Additionally, this downloaded image is post-processed
  		to generate and write the Backup GUID Partition Table.)
  		This occurs when the specified "partition name" on the
  		"fastboot flash" command line matches this value.
6f6c86309   Petr Kulhavy   fastboot: move FA...
1409
  		The default is "gpt" if undefined.
0ff7e585d   Steve Rae   fastboot: handle ...
1410

b6dd69a4d   Petr Kulhavy   fastboot: add sup...
1411
1412
1413
1414
1415
1416
  		CONFIG_FASTBOOT_MBR_NAME
  		The fastboot "flash" command supports writing the downloaded
  		image to DOS MBR.
  		This occurs when the "partition name" specified on the
  		"fastboot flash" command line matches this value.
  		If not defined the default value "mbr" is used.
6705d81e9   wdenk   * Patch by Andrea...
1417
  - Journaling Flash filesystem support:
b2482dffa   Simon Glass   README: Drop unus...
1418
  		CONFIG_JFFS2_NAND
6705d81e9   wdenk   * Patch by Andrea...
1419
  		Define these for a default partition on a NAND device
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
1420
1421
  		CONFIG_SYS_JFFS2_FIRST_SECTOR,
  		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
6705d81e9   wdenk   * Patch by Andrea...
1422
  		Define these for a default partition on a NOR device
c30a15e59   Donggeun Kim   FAT: Add FAT writ...
1423
1424
  - FAT(File Allocation Table) filesystem write function support:
  		CONFIG_FAT_WRITE
656f4c653   Donggeun Kim   cmd_fat: add FAT ...
1425
1426
1427
1428
1429
1430
  
  		Define this to enable support for saving memory data as a
  		file in FAT formatted partition.
  
  		This will also enable the command "fatwrite" enabling the
  		user to write files to FAT.
c30a15e59   Donggeun Kim   FAT: Add FAT writ...
1431

edb42dbac   Alexander von Gernler   cosmetic: Fix ind...
1432
  - CBFS (Coreboot Filesystem) support:
84cd93272   Gabe Black   fs: Add a Coreboo...
1433
1434
1435
1436
1437
  		CONFIG_CMD_CBFS
  
  		Define this to enable support for reading from a Coreboot
  		filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
  		and cbfsload.
4f0d1a2ae   Siva Durga Prasad Paladugu   fat: Define MAX_C...
1438
1439
1440
1441
1442
  - FAT(File Allocation Table) filesystem cluster size:
  		CONFIG_FS_FAT_MAX_CLUSTSIZE
  
  		Define the max cluster size for fat operations else
  		a default value of 65536 will be defined.
c609719b8   wdenk   Initial revision
1443
  - Keyboard Support:
39f615ed8   Simon Glass   video: input: Cle...
1444
1445
1446
1447
1448
1449
1450
1451
1452
  		See Kconfig help for available keyboard drivers.
  
  		CONFIG_KEYBOARD
  
  		Define this to enable a custom keyboard support.
  		This simply calls drv_keyboard_init() which must be
  		defined in your board-specific files. This option is deprecated
  		and is only used by novena. For new boards, use driver model
  		instead.
c609719b8   wdenk   Initial revision
1453
1454
  
  - Video support:
7d3053fbf   Timur Tabi   powerpc: clean up...
1455
  		CONFIG_FSL_DIU_FB
04e5ae793   Wolfgang Denk   Minor coding styl...
1456
  		Enable the Freescale DIU video driver.	Reference boards for
7d3053fbf   Timur Tabi   powerpc: clean up...
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
  		SOCs that have a DIU should define this macro to enable DIU
  		support, and should also define these other macros:
  
  			CONFIG_SYS_DIU_ADDR
  			CONFIG_VIDEO
  			CONFIG_CMD_BMP
  			CONFIG_CFB_CONSOLE
  			CONFIG_VIDEO_SW_CURSOR
  			CONFIG_VGA_AS_SINGLE_DEVICE
  			CONFIG_VIDEO_LOGO
  			CONFIG_VIDEO_BMP_LOGO
ba8e76bd4   Timur Tabi   powerpc: use 'vid...
1468
1469
  		The DIU driver will look for the 'video-mode' environment
  		variable, and if defined, enable the DIU as a console during
8eca9439e   Fabio Estevam   README: Specify t...
1470
  		boot.  See the documentation file doc/README.video for a
ba8e76bd4   Timur Tabi   powerpc: use 'vid...
1471
  		description of this variable.
7d3053fbf   Timur Tabi   powerpc: clean up...
1472

c609719b8   wdenk   Initial revision
1473
1474
1475
1476
1477
  - 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:
39cf48048   Stelian Pop   Add ATMEL LCD driver
1478
1479
1480
  		CONFIG_ATMEL_LCD:
  
  			HITACHI TX09D70VM1CCA, 3.5", 240x320.
fd3103bb8   wdenk   Add support for B...
1481
  		CONFIG_NEC_NL6448AC33:
c609719b8   wdenk   Initial revision
1482

fd3103bb8   wdenk   Add support for B...
1483
  			NEC NL6448AC33-18. Active, color, single scan.
c609719b8   wdenk   Initial revision
1484

fd3103bb8   wdenk   Add support for B...
1485
  		CONFIG_NEC_NL6448BC20
c609719b8   wdenk   Initial revision
1486

fd3103bb8   wdenk   Add support for B...
1487
1488
1489
1490
1491
1492
  			NEC NL6448BC20-08. 6.5", 640x480.
  			Active, color, single scan.
  
  		CONFIG_NEC_NL6448BC33_54
  
  			NEC NL6448BC33-54. 10.4", 640x480.
c609719b8   wdenk   Initial revision
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
  			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
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
1521
  		CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
c609719b8   wdenk   Initial revision
1522

676d319ef   Simon Glass   lcd: Add CONFIG_L...
1523
  		CONFIG_LCD_ALIGNMENT
b445bbb49   Jeremiah Mahler   doc: fix grammati...
1524
  		Normally the LCD is page-aligned (typically 4KB). If this is
676d319ef   Simon Glass   lcd: Add CONFIG_L...
1525
1526
1527
1528
  		defined then the LCD will be aligned to this value instead.
  		For ARM it is sometimes useful to use MMU_SECTION_SIZE
  		here, since it is cheaper to change data cache settings on
  		a per-section basis.
604c7d4a5   Hannes Petermaier   common/lcd_consol...
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
  		CONFIG_LCD_ROTATION
  
  		Sometimes, for example if the display is mounted in portrait
  		mode or even if it's mounted landscape but rotated by 180degree,
  		we need to rotate our content of the display relative to the
  		framebuffer, so that user can read the messages which are
  		printed out.
  		Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
  		initialized with a given rotation from "vl_rot" out of
  		"vidinfo_t" which is provided by the board specific code.
  		The value for vl_rot is coded as following (matching to
  		fbcon=rotate:<n> linux-kernel commandline):
  		0 = no rotation respectively 0 degree
  		1 = 90 degree rotation
  		2 = 180 degree rotation
  		3 = 270 degree rotation
  
  		If CONFIG_LCD_ROTATION is not defined, the console will be
  		initialized with 0degree rotation.
45d7f5251   Tom Wai-Hong Tam   lcd: Implement RL...
1548
1549
1550
  		CONFIG_LCD_BMP_RLE8
  
  		Support drawing of RLE8-compressed bitmaps on the LCD.
735987c5a   Tom Wai-Hong Tam   edid: Add I2C com...
1551
1552
1553
1554
  		CONFIG_I2C_EDID
  
  		Enables an 'i2c edid' command which can read EDID
  		information over I2C from an attached LCD display.
7152b1d0b   wdenk   * Add support for...
1555
  - Splash Screen Support: CONFIG_SPLASH_SCREEN
d791b1dc3   wdenk   * Make sure Block...
1556

8bde7f776   wdenk   * Code cleanup:
1557
1558
1559
  		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
e94d2cd9d   wdenk   * Fix "cls" comma...
1560
  		is suppressed and the BMP image at the address
8bde7f776   wdenk   * Code cleanup:
1561
1562
1563
1564
  		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.
d791b1dc3   wdenk   * Make sure Block...
1565

c08804853   Nikita Kiryanov   lcd: implement a ...
1566
1567
1568
1569
  		CONFIG_SPLASHIMAGE_GUARD
  
  		If this option is set, then U-Boot will prevent the environment
  		variable "splashimage" from being set to a problematic address
ab5645f14   Fabio Estevam   README: Specify t...
1570
  		(see doc/README.displaying-bmps).
c08804853   Nikita Kiryanov   lcd: implement a ...
1571
1572
1573
1574
1575
  		This option is useful for targets where, due to alignment
  		restrictions, an improperly aligned BMP image will cause a data
  		abort. If you think you will not have problems with unaligned
  		accesses (for example because your toolchain prevents them)
  		there is no need to set this option.
1ca298ced   Matthias Weisser   Added support for...
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
  		CONFIG_SPLASH_SCREEN_ALIGN
  
  		If this option is set the splash image can be freely positioned
  		on the screen. Environment variable "splashpos" specifies the
  		position as "x,y". If a positive number is given it is used as
  		number of pixel from left/top. If a negative number is given it
  		is used as number of pixel from right/bottom. You can also
  		specify 'm' for centering the image.
  
  		Example:
  		setenv splashpos m,m
  			=> image at center of screen
  
  		setenv splashpos 30,20
  			=> image at x = 30 and y = 20
  
  		setenv splashpos -10,m
  			=> vertically centered image
  			   at x = dspWidth - bmpWidth - 9
98f4a3dfc   Stefan Roese   Add SM501 support...
1595
1596
1597
1598
1599
  - 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.
d5011762f   Anatolij Gustschin   video: cfb_consol...
1600
1601
1602
1603
1604
  - Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
  
  		If this option is set, 8-bit RLE compressed BMP images
  		can be displayed via the splashscreen support or the
  		bmp command.
c29fdfc1d   wdenk   Patch by Yuli Bar...
1605
  - Compression support:
8ef704784   Kees Cook   documentation: ad...
1606
1607
1608
  		CONFIG_GZIP
  
  		Enabled by default to support gzip compressed images.
c29fdfc1d   wdenk   Patch by Yuli Bar...
1609
1610
1611
1612
1613
  		CONFIG_BZIP2
  
  		If this option is set, support for bzip2 compressed
  		images is included. If not, only uncompressed and gzip
  		compressed images are supported.
42d1f0394   wdenk   * Patches by Xian...
1614
  		NOTE: the bzip2 algorithm requires a lot of RAM, so
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
1615
  		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
42d1f0394   wdenk   * Patches by Xian...
1616
  		be at least 4MB.
d791b1dc3   wdenk   * Make sure Block...
1617

fc9c1727b   Luigi 'Comio' Mantellini   Add support for L...
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
  		CONFIG_LZMA
  
  		If this option is set, support for lzma compressed
  		images is included.
  
  		Note: The LZMA algorithm adds between 2 and 4KB of code and it
  		requires an amount of dynamic memory that is given by the
  		formula:
  
  			(1846 + 768 << (lc + lp)) * sizeof(uint16)
  
  		Where lc and lp stand for, respectively, Literal context bits
  		and Literal pos bits.
  
  		This value is upper-bounded by 14MB in the worst case. Anyway,
  		for a ~4MB large kernel image, we have lc=3 and lp=0 for a
  		total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
  		a very small buffer.
  
  		Use the lzmainfo tool to determinate the lc and lp values and
  		then calculate the amount of needed dynamic memory (ensuring
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
1639
  		the appropriate CONFIG_SYS_MALLOC_LEN value).
fc9c1727b   Luigi 'Comio' Mantellini   Add support for L...
1640

8ef704784   Kees Cook   documentation: ad...
1641
1642
1643
1644
  		CONFIG_LZO
  
  		If this option is set, support for LZO compressed images
  		is included.
17ea11774   wdenk   Patch by Tolunay ...
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
  - 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
11ccc33fa   Marcel Ziswiler   Many spelling fix...
1657
  		detection of gigabit PHY is included.
17ea11774   wdenk   Patch by Tolunay ...
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
  
  		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
c609719b8   wdenk   Initial revision
1670
1671
1672
1673
  - IP address:
  		CONFIG_IPADDR
  
  		Define a default value for the IP address to use for
11ccc33fa   Marcel Ziswiler   Many spelling fix...
1674
  		the default Ethernet interface, in case this is not
c609719b8   wdenk   Initial revision
1675
  		determined through e.g. bootp.
1ebcd6547   Wolfgang Denk   README: improve d...
1676
  		(Environment variable "ipaddr")
c609719b8   wdenk   Initial revision
1677
1678
1679
  
  - Server IP address:
  		CONFIG_SERVERIP
11ccc33fa   Marcel Ziswiler   Many spelling fix...
1680
  		Defines a default value for the IP address of a TFTP
c609719b8   wdenk   Initial revision
1681
  		server to contact when using the "tftboot" command.
1ebcd6547   Wolfgang Denk   README: improve d...
1682
  		(Environment variable "serverip")
c609719b8   wdenk   Initial revision
1683

97cfe8616   Robin Getz   Save server's MAC...
1684
1685
1686
1687
  		CONFIG_KEEP_SERVERADDR
  
  		Keeps the server's MAC address, in the env 'serveraddr'
  		for passing to bootargs (like Linux's netconsole option)
1ebcd6547   Wolfgang Denk   README: improve d...
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
  - Gateway IP address:
  		CONFIG_GATEWAYIP
  
  		Defines a default value for the IP address of the
  		default router where packets to other networks are
  		sent to.
  		(Environment variable "gatewayip")
  
  - Subnet mask:
  		CONFIG_NETMASK
  
  		Defines a default value for the subnet mask (or
  		routing prefix) which is used to determine if an IP
  		address belongs to the local subnet or needs to be
  		forwarded through a router.
  		(Environment variable "netmask")
53a5c424b   David Updegraff   multicast tftp: R...
1704
1705
1706
1707
1708
  - Multicast TFTP Mode:
  		CONFIG_MCAST_TFTP
  
  		Defines whether you want to support multicast TFTP as per
  		rfc-2090; for example to work with atftp.  Lets lots of targets
11ccc33fa   Marcel Ziswiler   Many spelling fix...
1709
  		tftp down the same boot image concurrently.  Note: the Ethernet
53a5c424b   David Updegraff   multicast tftp: R...
1710
1711
  		driver in use must provide a function: mcast() to join/leave a
  		multicast group.
c609719b8   wdenk   Initial revision
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
  - 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
6c33c7855   Wolfgang Denk   Fixed typo in REA...
1723
  		following delays are inserted then:
c609719b8   wdenk   Initial revision
1724
1725
1726
1727
1728
1729
  
  		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
92ac8acc0   Thierry Reding   net: More BOOTP r...
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
  		CONFIG_BOOTP_ID_CACHE_SIZE
  
  		BOOTP packets are uniquely identified using a 32-bit ID. The
  		server will copy the ID from client requests to responses and
  		U-Boot will use this to determine if it is the destination of
  		an incoming response. Some servers will check that addresses
  		aren't in use before handing them out (usually using an ARP
  		ping) and therefore take up to a few hundred milliseconds to
  		respond. Network congestion may also influence the time it
  		takes for a response to make it back to the client. If that
  		time is too long, U-Boot will retransmit requests. In order
  		to allow earlier responses to still be accepted after these
  		retransmissions, U-Boot's BOOTP client keeps a small cache of
  		IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
  		cache. The default is to keep IDs for up to four outstanding
  		requests. Increasing this will allow U-Boot to accept offers
  		from a BOOTP client in networks with unusually high latency.
fe389a82c   stroese   - Added CONFIG_BO...
1747
  - DHCP Advanced Options:
1fe80d79c   Jon Loeliger   Finally retire cm...
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
  		You can fine tune the DHCP functionality by defining
  		CONFIG_BOOTP_* symbols:
  
  		CONFIG_BOOTP_SUBNETMASK
  		CONFIG_BOOTP_GATEWAY
  		CONFIG_BOOTP_HOSTNAME
  		CONFIG_BOOTP_NISDOMAIN
  		CONFIG_BOOTP_BOOTPATH
  		CONFIG_BOOTP_BOOTFILESIZE
  		CONFIG_BOOTP_DNS
  		CONFIG_BOOTP_DNS2
  		CONFIG_BOOTP_SEND_HOSTNAME
  		CONFIG_BOOTP_NTPSERVER
  		CONFIG_BOOTP_TIMEOFFSET
  		CONFIG_BOOTP_VENDOREX
2c00e099f   Joe Hershberger   net: Add option C...
1763
  		CONFIG_BOOTP_MAY_FAIL
fe389a82c   stroese   - Added CONFIG_BO...
1764

5d110f0aa   Wilson Callan   New CONFIG_BOOTP_...
1765
1766
  		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
  		environment variable, not the BOOTP server.
fe389a82c   stroese   - Added CONFIG_BO...
1767

2c00e099f   Joe Hershberger   net: Add option C...
1768
1769
1770
1771
1772
  		CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
  		after the configured retry count, the call will fail
  		instead of starting over.  This can be used to fail over
  		to Link-local IP address configuration if the DHCP server
  		is not available.
fe389a82c   stroese   - Added CONFIG_BO...
1773
1774
1775
1776
1777
1778
1779
  		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
1fe80d79c   Jon Loeliger   Finally retire cm...
1780
  		is defined.
fe389a82c   stroese   - Added CONFIG_BO...
1781
1782
1783
1784
  
  		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.
5d110f0aa   Wilson Callan   New CONFIG_BOOTP_...
1785
  		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
1fe80d79c   Jon Loeliger   Finally retire cm...
1786
1787
  		of the "hostname" environment variable is passed as
  		option 12 to the DHCP server.
fe389a82c   stroese   - Added CONFIG_BO...
1788

d9a2f416d   Aras Vaichas   DHCP request fix ...
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
  		CONFIG_BOOTP_DHCP_REQUEST_DELAY
  
  		A 32bit value in microseconds for a delay between
  		receiving a "DHCP Offer" and sending the "DHCP Request".
  		This fixes a problem with certain DHCP servers that don't
  		respond 100% of the time to a "DHCP request". E.g. On an
  		AT91RM9200 processor running at 180MHz, this delay needed
  		to be *at least* 15,000 usec before a Windows Server 2003
  		DHCP server would reply 100% of the time. I recommend at
  		least 50,000 usec to be safe. The alternative is to hope
  		that one of the retries will be successful but note that
  		the DHCP timeout and retry process takes a longer than
  		this delay.
d22c338e0   Joe Hershberger   net: Add link-loc...
1802
1803
1804
1805
1806
1807
1808
   - Link-local IP address negotiation:
  		Negotiate with other link-local clients on the local network
  		for an address that doesn't require explicit configuration.
  		This is especially useful if a DHCP server cannot be guaranteed
  		to exist in all environments that the device must operate.
  
  		See doc/README.link-local for more information.
a3d991bd0   wdenk   Patches by Pantel...
1809
   - CDP Options:
6e5923851   wdenk   * Cleanup, minor ...
1810
  		CONFIG_CDP_DEVICE_ID
a3d991bd0   wdenk   Patches by Pantel...
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
  
  		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
11ccc33fa   Marcel Ziswiler   Many spelling fix...
1823
  		eth0 for the first Ethernet, eth1 for the second etc.
a3d991bd0   wdenk   Patches by Pantel...
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
  
  		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.
79267edd1   Uri Mashiach   status_led: Kconf...
1850
  - Status LED:	CONFIG_LED_STATUS
c609719b8   wdenk   Initial revision
1851
1852
1853
1854
1855
1856
1857
  
  		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
79267edd1   Uri Mashiach   status_led: Kconf...
1858
  		kernel). Defining CONFIG_LED_STATUS enables this
c609719b8   wdenk   Initial revision
1859
  		feature in U-Boot.
1df7bbba2   Igor Grinberg   README: document ...
1860
  		Additional options:
79267edd1   Uri Mashiach   status_led: Kconf...
1861
  		CONFIG_LED_STATUS_GPIO
1df7bbba2   Igor Grinberg   README: document ...
1862
1863
  		The status LED can be connected to a GPIO pin.
  		In such cases, the gpio_led driver can be used as a
79267edd1   Uri Mashiach   status_led: Kconf...
1864
  		status LED backend implementation. Define CONFIG_LED_STATUS_GPIO
1df7bbba2   Igor Grinberg   README: document ...
1865
  		to include the gpio_led driver in the U-Boot binary.
9dfdcdfed   Igor Grinberg   gpio_led: add sup...
1866
1867
1868
1869
1870
1871
  		CONFIG_GPIO_LED_INVERTED_TABLE
  		Some GPIO connected LEDs may have inverted polarity in which
  		case the GPIO high value corresponds to LED off state and
  		GPIO low value corresponds to LED on state.
  		In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
  		with a list of GPIO LEDs that have inverted polarity.
c609719b8   wdenk   Initial revision
1872
1873
1874
1875
1876
  - 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.
3f4978c71   Heiko Schocher   i2c: common chang...
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
  - I2C Support:	CONFIG_SYS_I2C
  
  		This enable the NEW i2c subsystem, and will allow you to use
  		i2c commands at the u-boot command line (as long as you set
  		CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
  		based realtime clock chips or other i2c devices. See
  		common/cmd_i2c.c for a description of the command line
  		interface.
  
  		ported i2c driver to the new framework:
ea818dbbc   Heiko Schocher   i2c, soft-i2c: sw...
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
  		- drivers/i2c/soft_i2c.c:
  		  - activate first bus with CONFIG_SYS_I2C_SOFT define
  		    CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
  		    for defining speed and slave address
  		  - activate second bus with I2C_SOFT_DECLARATIONS2 define
  		    CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
  		    for defining speed and slave address
  		  - activate third bus with I2C_SOFT_DECLARATIONS3 define
  		    CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
  		    for defining speed and slave address
  		  - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
  		    CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
  		    for defining speed and slave address
3f4978c71   Heiko Schocher   i2c: common chang...
1900

00f792e0d   Heiko Schocher   i2c, fsl_i2c: swi...
1901
1902
1903
1904
1905
1906
  		- drivers/i2c/fsl_i2c.c:
  		  - activate i2c driver with CONFIG_SYS_I2C_FSL
  		    define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
  		    offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
  		    CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
  		    bus.
93e145964   Wolfgang Denk   Coding Style clea...
1907
  		  - If your board supports a second fsl i2c bus, define
00f792e0d   Heiko Schocher   i2c, fsl_i2c: swi...
1908
1909
1910
1911
  		    CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
  		    CONFIG_SYS_FSL_I2C2_SPEED for the speed and
  		    CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
  		    second bus.
1f2ba722a   Simon Glass   tegra: i2c: Enabl...
1912
  		- drivers/i2c/tegra_i2c.c:
10cee5166   Nobuhiro Iwamatsu   README: I2C: Fix ...
1913
1914
1915
  		  - activate this driver with CONFIG_SYS_I2C_TEGRA
  		  - This driver adds 4 i2c buses with a fix speed from
  		    100000 and the slave addr 0!
1f2ba722a   Simon Glass   tegra: i2c: Enabl...
1916

880540dec   Dirk Eibach   i2c, ppc4xx_i2c: ...
1917
1918
1919
1920
  		- drivers/i2c/ppc4xx_i2c.c
  		  - activate this driver with CONFIG_SYS_I2C_PPC4XX
  		  - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
  		  - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
fac964089   trem   i2c: mxc: move to...
1921
1922
  		- drivers/i2c/i2c_mxc.c
  		  - activate this driver with CONFIG_SYS_I2C_MXC
03544c664   Albert ARIBAUD \\(3ADEV\\)   I2C: mxc_i2c: mak...
1923
1924
1925
1926
  		  - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
  		  - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
  		  - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
  		  - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
fac964089   trem   i2c: mxc: move to...
1927
1928
1929
1930
1931
1932
  		  - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
  		  - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
  		  - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
  		  - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
  		  - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
  		  - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
03544c664   Albert ARIBAUD \\(3ADEV\\)   I2C: mxc_i2c: mak...
1933
1934
  		  - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
  		  - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
b445bbb49   Jeremiah Mahler   doc: fix grammati...
1935
  		If those defines are not set, default value is 100000
fac964089   trem   i2c: mxc: move to...
1936
  		for speed, and 0 for slave.
1086bfa9f   Nobuhiro Iwamatsu   i2c: Add support ...
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
  		- drivers/i2c/rcar_i2c.c:
  		  - activate this driver with CONFIG_SYS_I2C_RCAR
  		  - This driver adds 4 i2c buses
  
  		  - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
  		  - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
  		  - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
  		  - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
  		  - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
  		  - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
  		  - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
  		  - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
  		  - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2035d77d7   Nobuhiro Iwamatsu   i2c: sh_i2c: Upda...
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
  		- drivers/i2c/sh_i2c.c:
  		  - activate this driver with CONFIG_SYS_I2C_SH
  		  - This driver adds from 2 to 5 i2c buses
  
  		  - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
  		  - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
  		  - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
  		  - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
  		  - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
  		  - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
  		  - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
  		  - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
  		  - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
  		  - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
b445bbb49   Jeremiah Mahler   doc: fix grammati...
1964
  		  - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
2035d77d7   Nobuhiro Iwamatsu   i2c: sh_i2c: Upda...
1965

6789e84ec   Heiko Schocher   i2c, omap24xx: co...
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
  		- drivers/i2c/omap24xx_i2c.c
  		  - activate this driver with CONFIG_SYS_I2C_OMAP24XX
  		  - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
  		  - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
  		  - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
  		  - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
  		  - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
  		  - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
  		  - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
  		  - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
  		  - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
  		  - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
0bdffe71f   Heiko Schocher   i2c, zynq: conver...
1978
1979
1980
1981
  		- drivers/i2c/zynq_i2c.c
  		  - activate this driver with CONFIG_SYS_I2C_ZYNQ
  		  - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
  		  - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
e717fc6d1   Naveen Krishna Ch   i2c: samsung: reg...
1982
1983
1984
1985
1986
  		- drivers/i2c/s3c24x0_i2c.c:
  		  - activate this driver with CONFIG_SYS_I2C_S3C24X0
  		  - This driver adds i2c buses (11 for Exynos5250, Exynos5420
  		    9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
  		    with a fix speed from 100000 and the slave addr 0!
b46226bdb   Dirk Eibach   i2c: IHS I2C mast...
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
  		- drivers/i2c/ihs_i2c.c
  		  - activate this driver with CONFIG_SYS_I2C_IHS
  		  - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
  		  - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
  		  - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
  		  - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
  		  - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
  		  - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
  		  - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
  		  - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
  		  - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
  		  - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
  		  - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
  		  - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
071be8969   Dirk Eibach   i2c: ihs_i2c: Dua...
2001
2002
2003
2004
2005
2006
2007
2008
2009
  		  - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
  		  - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
  		  - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
  		  - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
  		  - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
  		  - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
  		  - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
  		  - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
  		  - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
b46226bdb   Dirk Eibach   i2c: IHS I2C mast...
2010

3f4978c71   Heiko Schocher   i2c: common chang...
2011
2012
2013
  		additional defines:
  
  		CONFIG_SYS_NUM_I2C_BUSES
945a18e62   Simon Glass   README: i2c: Drop...
2014
  		Hold the number of i2c buses you want to use.
3f4978c71   Heiko Schocher   i2c: common chang...
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
  
  		CONFIG_SYS_I2C_DIRECT_BUS
  		define this, if you don't use i2c muxes on your hardware.
  		if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
  		omit this define.
  
  		CONFIG_SYS_I2C_MAX_HOPS
  		define how many muxes are maximal consecutively connected
  		on one i2c bus. If you not use i2c muxes, omit this
  		define.
  
  		CONFIG_SYS_I2C_BUSES
b445bbb49   Jeremiah Mahler   doc: fix grammati...
2027
  		hold a list of buses you want to use, only used if
3f4978c71   Heiko Schocher   i2c: common chang...
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
  		CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
  		a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
  		CONFIG_SYS_NUM_I2C_BUSES = 9:
  
  		 CONFIG_SYS_I2C_BUSES	{{0, {I2C_NULL_HOP}}, \
  					{0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
  					{0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
  					{0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
  					{0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
  					{0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
  					{1, {I2C_NULL_HOP}}, \
  					{1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
  					{1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
  					}
  
  		which defines
  			bus 0 on adapter 0 without a mux
ea818dbbc   Heiko Schocher   i2c, soft-i2c: sw...
2045
2046
2047
2048
2049
  			bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
  			bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
  			bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
  			bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
  			bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
3f4978c71   Heiko Schocher   i2c: common chang...
2050
  			bus 6 on adapter 1 without a mux
ea818dbbc   Heiko Schocher   i2c, soft-i2c: sw...
2051
2052
  			bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
  			bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
3f4978c71   Heiko Schocher   i2c: common chang...
2053
2054
  
  		If you do not have i2c muxes on your board, omit this define.
ea818dbbc   Heiko Schocher   i2c, soft-i2c: sw...
2055
  - Legacy I2C Support:	CONFIG_HARD_I2C
3f4978c71   Heiko Schocher   i2c: common chang...
2056
2057
2058
2059
2060
2061
2062
2063
2064
  
  		NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
  		provides the following compelling advantages:
  
  		- more than one i2c adapter is usable
  		- approved multibus support
  		- better i2c mux support
  
  		** Please consider updating your I2C driver now. **
ea818dbbc   Heiko Schocher   i2c, soft-i2c: sw...
2065
2066
2067
  		These enable legacy I2C serial bus commands. Defining
  		CONFIG_HARD_I2C will include the appropriate I2C driver
  		for the selected CPU.
c609719b8   wdenk   Initial revision
2068

945af8d72   wdenk   * Add support for...
2069
  		This will allow you to use i2c commands at the u-boot
602ad3b33   Jon Loeliger   README: Rewrite c...
2070
  		command line (as long as you set CONFIG_CMD_I2C in
b37c7e5e5   wdenk   * Patch by Seb Ja...
2071
2072
  		CONFIG_COMMANDS) and communicate with i2c based realtime
  		clock chips. See common/cmd_i2c.c for a description of the
43d9616cf   wdenk   * Patch by Robert...
2073
  		command line interface.
c609719b8   wdenk   Initial revision
2074

bb99ad6d8   Ben Warren   Add support for m...
2075
  		CONFIG_HARD_I2C selects a hardware I2C controller.
b37c7e5e5   wdenk   * Patch by Seb Ja...
2076

945af8d72   wdenk   * Add support for...
2077
  		There are several other quantities that must also be
ea818dbbc   Heiko Schocher   i2c, soft-i2c: sw...
2078
  		defined when you define CONFIG_HARD_I2C.
c609719b8   wdenk   Initial revision
2079

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2080
  		In both cases you will need to define CONFIG_SYS_I2C_SPEED
945af8d72   wdenk   * Add support for...
2081
  		to be the frequency (in Hz) at which you wish your i2c bus
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2082
  		to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
11ccc33fa   Marcel Ziswiler   Many spelling fix...
2083
  		the CPU's i2c node address).
945af8d72   wdenk   * Add support for...
2084

8d321b81c   Peter Tyser   Update README to ...
2085
  		Now, the u-boot i2c code for the mpc8xx
a47a12bec   Stefan Roese   Move arch/ppc to ...
2086
  		(arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
8d321b81c   Peter Tyser   Update README to ...
2087
2088
2089
  		and so its address should therefore be cleared to 0 (See,
  		eg, MPC823e User's Manual p.16-473). So, set
  		CONFIG_SYS_I2C_SLAVE to 0.
c609719b8   wdenk   Initial revision
2090

5da71efa1   Eric Millbrandt   Reset i2c slave d...
2091
2092
2093
2094
2095
2096
  		CONFIG_SYS_I2C_INIT_MPC5XXX
  
  		When a board is reset during an i2c bus transfer
  		chips might think that the current transfer is still
  		in progress.  Reset the slave devices by sending start
  		commands until the slave device responds.
945af8d72   wdenk   * Add support for...
2097
  		That's all that's required for CONFIG_HARD_I2C.
c609719b8   wdenk   Initial revision
2098

ea818dbbc   Heiko Schocher   i2c, soft-i2c: sw...
2099
  		If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
b37c7e5e5   wdenk   * Patch by Seb Ja...
2100
2101
  		then the following macros need to be defined (examples are
  		from include/configs/lwmon.h):
c609719b8   wdenk   Initial revision
2102
2103
  
  		I2C_INIT
b37c7e5e5   wdenk   * Patch by Seb Ja...
2104
  		(Optional). Any commands necessary to enable the I2C
43d9616cf   wdenk   * Patch by Robert...
2105
  		controller or configure ports.
c609719b8   wdenk   Initial revision
2106

ba56f6257   wdenk   Patch by Travis S...
2107
  		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
b37c7e5e5   wdenk   * Patch by Seb Ja...
2108

c609719b8   wdenk   Initial revision
2109
  		I2C_PORT
43d9616cf   wdenk   * Patch by Robert...
2110
2111
2112
  		(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.
c609719b8   wdenk   Initial revision
2113
2114
2115
2116
2117
2118
  
  		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.
b37c7e5e5   wdenk   * Patch by Seb Ja...
2119
  		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
c609719b8   wdenk   Initial revision
2120
2121
2122
2123
2124
  		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.
b37c7e5e5   wdenk   * Patch by Seb Ja...
2125
  		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
c609719b8   wdenk   Initial revision
2126
  		I2C_READ
472d54605   York Sun   Consolidate bool ...
2127
2128
  		Code that returns true if the I2C data line is high,
  		false if it is low.
c609719b8   wdenk   Initial revision
2129

b37c7e5e5   wdenk   * Patch by Seb Ja...
2130
  		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
c609719b8   wdenk   Initial revision
2131
  		I2C_SDA(bit)
472d54605   York Sun   Consolidate bool ...
2132
2133
  		If <bit> is true, sets the I2C data line high. If it
  		is false, it clears it (low).
c609719b8   wdenk   Initial revision
2134

b37c7e5e5   wdenk   * Patch by Seb Ja...
2135
  		eg: #define I2C_SDA(bit) \
2535d6027   wdenk   * Patch by Martin...
2136
  			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
ba56f6257   wdenk   Patch by Travis S...
2137
  			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
b37c7e5e5   wdenk   * Patch by Seb Ja...
2138

c609719b8   wdenk   Initial revision
2139
  		I2C_SCL(bit)
472d54605   York Sun   Consolidate bool ...
2140
2141
  		If <bit> is true, sets the I2C clock line high. If it
  		is false, it clears it (low).
c609719b8   wdenk   Initial revision
2142

b37c7e5e5   wdenk   * Patch by Seb Ja...
2143
  		eg: #define I2C_SCL(bit) \
2535d6027   wdenk   * Patch by Martin...
2144
  			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
ba56f6257   wdenk   Patch by Travis S...
2145
  			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
b37c7e5e5   wdenk   * Patch by Seb Ja...
2146

c609719b8   wdenk   Initial revision
2147
2148
2149
2150
  		I2C_DELAY
  
  		This delay is invoked four times per clock cycle so this
  		controls the rate of data transfer.  The data rate thus
b37c7e5e5   wdenk   * Patch by Seb Ja...
2151
  		is 1 / (I2C_DELAY * 4). Often defined to be something
945af8d72   wdenk   * Add support for...
2152
  		like:
b37c7e5e5   wdenk   * Patch by Seb Ja...
2153
  		#define I2C_DELAY  udelay(2)
c609719b8   wdenk   Initial revision
2154

793b5726f   Mike Frysinger   i2c: soft_i2c: ad...
2155
2156
2157
2158
2159
2160
2161
2162
2163
  		CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
  
  		If your arch supports the generic GPIO framework (asm/gpio.h),
  		then you may alternatively define the two GPIOs that are to be
  		used as SCL / SDA.  Any of the previous I2C_xxx macros will
  		have GPIO-based defaults assigned to them as appropriate.
  
  		You should define these to the GPIO value as given directly to
  		the generic GPIO functions.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2164
  		CONFIG_SYS_I2C_INIT_BOARD
47cd00fa7   wdenk   * Patches by Robe...
2165

8bde7f776   wdenk   * Code cleanup:
2166
2167
2168
2169
2170
2171
2172
2173
  		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.
47cd00fa7   wdenk   * Patches by Robe...
2174

26a33504a   Richard Retanubun   fsl_i2c: Added a ...
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
  		CONFIG_SYS_I2C_BOARD_LATE_INIT
  
  		An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
  		defined a custom i2c_board_late_init() routine in
  		boards/xxx/board.c is run AFTER the operations in i2c_init()
  		is completed. This callpoint can be used to unreset i2c bus
  		using CPU i2c controller register accesses for CPUs whose i2c
  		controller provide such a method. It is called at the end of
  		i2c_init() to allow i2c_init operations to setup the i2c bus
  		controller on the CPU (e.g. setting bus speed & slave address).
17ea11774   wdenk   Patch by Tolunay ...
2185
2186
2187
2188
2189
  		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)
bb99ad6d8   Ben Warren   Add support for m...
2190
2191
2192
  		CONFIG_I2C_MULTI_BUS
  
  		This option allows the use of multiple I2C buses, each of which
c0f40859f   Wolfgang Denk   README: white-spa...
2193
2194
  		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.
bb99ad6d8   Ben Warren   Add support for m...
2195
  		Note that bus numbering is zero-based.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2196
  		CONFIG_SYS_I2C_NOPROBES
bb99ad6d8   Ben Warren   Add support for m...
2197
2198
  
  		This option specifies a list of I2C devices that will be skipped
c0f40859f   Wolfgang Denk   README: white-spa...
2199
  		when the 'i2c probe' command is issued.	 If CONFIG_I2C_MULTI_BUS
0f89c54be   Peter Tyser   i2c: Update refer...
2200
2201
  		is set, specify a list of bus-device pairs.  Otherwise, specify
  		a 1D array of device addresses
bb99ad6d8   Ben Warren   Add support for m...
2202
2203
2204
  
  		e.g.
  			#undef	CONFIG_I2C_MULTI_BUS
c0f40859f   Wolfgang Denk   README: white-spa...
2205
  			#define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
bb99ad6d8   Ben Warren   Add support for m...
2206
2207
  
  		will skip addresses 0x50 and 0x68 on a board with one I2C bus
c0f40859f   Wolfgang Denk   README: white-spa...
2208
  			#define CONFIG_I2C_MULTI_BUS
945a18e62   Simon Glass   README: i2c: Drop...
2209
  			#define CONFIG_SYS_I2C_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
bb99ad6d8   Ben Warren   Add support for m...
2210
2211
  
  		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2212
  		CONFIG_SYS_SPD_BUS_NUM
be5e61815   Timur Tabi   mpc83xx: Update 8...
2213
2214
2215
  
  		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.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2216
  		CONFIG_SYS_RTC_BUS_NUM
0dc018ece   Stefan Roese   [PATCH] I2C: Add ...
2217
2218
2219
  
  		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.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2220
  		CONFIG_SYS_DTT_BUS_NUM
0dc018ece   Stefan Roese   [PATCH] I2C: Add ...
2221
2222
2223
  
  		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.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2224
  		CONFIG_SYS_I2C_DTT_ADDR:
9ebbb54f7   Victor Gallardo   ppc4xx: Allow DTT...
2225
2226
2227
2228
  
  		If defined, specifies the I2C address of the DTT device.
  		If not defined, then U-Boot uses predefined value for
  		specified DTT device.
2ac6985a7   Andrew Dyer   soft_i2c.c add op...
2229
2230
2231
2232
2233
2234
2235
2236
2237
  		CONFIG_SOFT_I2C_READ_REPEATED_START
  
  		defining this will force the i2c_read() function in
  		the soft_i2c driver to perform an I2C repeated start
  		between writing the address pointer and reading the
  		data.  If this define is omitted the default behaviour
  		of doing a stop-start sequence will be used.  Most I2C
  		devices can use either method, but some require one or
  		the other.
be5e61815   Timur Tabi   mpc83xx: Update 8...
2238

c609719b8   wdenk   Initial revision
2239
2240
2241
2242
2243
  - 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)
6639562e6   Yoshihiro Shimoda   spi: add support ...
2244
2245
2246
2247
  		CONFIG_SH_SPI
  
  		Enables the driver for SPI controller on SuperH. Currently
  		only SH7757 is supported.
c609719b8   wdenk   Initial revision
2248
  		CONFIG_SOFT_SPI
43d9616cf   wdenk   * Patch by Robert...
2249
2250
2251
2252
2253
2254
2255
  		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.
c609719b8   wdenk   Initial revision
2256

04a9e1180   Ben Warren   Add support for a...
2257
2258
2259
2260
2261
  		CONFIG_HARD_SPI
  
  		Enables a hardware SPI driver for general-purpose reads
  		and writes.  As with CONFIG_SOFT_SPI, the board configuration
  		must define a list of chip-select function pointers.
c0f40859f   Wolfgang Denk   README: white-spa...
2262
  		Currently supported on some MPC8xxx processors.	 For an
04a9e1180   Ben Warren   Add support for a...
2263
  		example, see include/configs/mpc8349emds.h.
38254f45b   Guennadi Liakhovetski   New i.MX31 SPI dr...
2264
2265
2266
  		CONFIG_MXC_SPI
  
  		Enables the driver for the SPI controllers on i.MX and MXC
2e3cd1cda   Fabio Estevam   README: Fix suppo...
2267
  		SoCs. Currently i.MX31/35/51 are supported.
38254f45b   Guennadi Liakhovetski   New i.MX31 SPI dr...
2268

f659b5736   Heiko Schocher   spi, spi_mxc: do ...
2269
2270
2271
  		CONFIG_SYS_SPI_MXC_WAIT
  		Timeout for waiting until spi transfer completed.
  		default: (CONFIG_SYS_HZ/100)     /* 10 ms */
0133502e3   Matthias Fuchs   Improve configura...
2272
  - FPGA Support: CONFIG_FPGA
c609719b8   wdenk   Initial revision
2273

0133502e3   Matthias Fuchs   Improve configura...
2274
2275
2276
2277
2278
2279
  		Enables FPGA subsystem.
  
  		CONFIG_FPGA_<vendor>
  
  		Enables support for specific chip vendors.
  		(ALTERA, XILINX)
c609719b8   wdenk   Initial revision
2280

0133502e3   Matthias Fuchs   Improve configura...
2281
  		CONFIG_FPGA_<family>
c609719b8   wdenk   Initial revision
2282

0133502e3   Matthias Fuchs   Improve configura...
2283
2284
2285
2286
2287
2288
  		Enables support for FPGA family.
  		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
  
  		CONFIG_FPGA_COUNT
  
  		Specify the number of FPGA devices to support.
c609719b8   wdenk   Initial revision
2289

64e809afe   Siva Durga Prasad Paladugu   fpga: Guard the L...
2290
2291
2292
  		CONFIG_CMD_FPGA_LOADMK
  
  		Enable support for fpga loadmk command
67193864b   Michal Simek   fpga: Add support...
2293
2294
2295
2296
2297
2298
2299
2300
  		CONFIG_CMD_FPGA_LOADP
  
  		Enable support for fpga loadp command - load partial bitstream
  
  		CONFIG_CMD_FPGA_LOADBP
  
  		Enable support for fpga loadbp command - load partial bitstream
  		(Xilinx only)
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2301
  		CONFIG_SYS_FPGA_PROG_FEEDBACK
c609719b8   wdenk   Initial revision
2302

8bde7f776   wdenk   * Code cleanup:
2303
  		Enable printing of hash marks during FPGA configuration.
c609719b8   wdenk   Initial revision
2304

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2305
  		CONFIG_SYS_FPGA_CHECK_BUSY
c609719b8   wdenk   Initial revision
2306

43d9616cf   wdenk   * Patch by Robert...
2307
2308
2309
2310
  		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.
c609719b8   wdenk   Initial revision
2311
2312
2313
2314
2315
  
  		CONFIG_FPGA_DELAY
  
  		If defined, a function that provides delays in the FPGA
  		configuration driver.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2316
  		CONFIG_SYS_FPGA_CHECK_CTRLC
c609719b8   wdenk   Initial revision
2317
  		Allow Control-C to interrupt FPGA configuration
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2318
  		CONFIG_SYS_FPGA_CHECK_ERROR
c609719b8   wdenk   Initial revision
2319

43d9616cf   wdenk   * Patch by Robert...
2320
2321
2322
2323
  		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).
c609719b8   wdenk   Initial revision
2324

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2325
  		CONFIG_SYS_FPGA_WAIT_INIT
c609719b8   wdenk   Initial revision
2326

b445bbb49   Jeremiah Mahler   doc: fix grammati...
2327
2328
  		Maximum time to wait for the INIT_B line to de-assert
  		after PROB_B has been de-asserted during a Virtex II
43d9616cf   wdenk   * Patch by Robert...
2329
  		FPGA configuration sequence. The default time is 500
11ccc33fa   Marcel Ziswiler   Many spelling fix...
2330
  		ms.
c609719b8   wdenk   Initial revision
2331

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2332
  		CONFIG_SYS_FPGA_WAIT_BUSY
c609719b8   wdenk   Initial revision
2333

b445bbb49   Jeremiah Mahler   doc: fix grammati...
2334
  		Maximum time to wait for BUSY to de-assert during
11ccc33fa   Marcel Ziswiler   Many spelling fix...
2335
  		Virtex II FPGA configuration. The default is 5 ms.
c609719b8   wdenk   Initial revision
2336

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2337
  		CONFIG_SYS_FPGA_WAIT_CONFIG
c609719b8   wdenk   Initial revision
2338

43d9616cf   wdenk   * Patch by Robert...
2339
  		Time to wait after FPGA configuration. The default is
11ccc33fa   Marcel Ziswiler   Many spelling fix...
2340
  		200 ms.
c609719b8   wdenk   Initial revision
2341
2342
  
  - Configuration Management:
b2b8a6967   Stefan Roese   Makefile: Add CON...
2343
2344
2345
2346
2347
2348
  		CONFIG_BUILD_TARGET
  
  		Some SoCs need special image types (e.g. U-Boot binary
  		with a special header) as build targets. By defining
  		CONFIG_BUILD_TARGET in the SoC / board header, this
  		special image will be automatically built upon calling
6de80f219   Simon Glass   Drop references t...
2349
  		make / buildman.
b2b8a6967   Stefan Roese   Makefile: Add CON...
2350

c609719b8   wdenk   Initial revision
2351
  		CONFIG_IDENT_STRING
43d9616cf   wdenk   * Patch by Robert...
2352
2353
  		If defined, this string will be added to the U-Boot
  		version information (U_BOOT_VERSION)
c609719b8   wdenk   Initial revision
2354
2355
  
  - Vendor Parameter Protection:
43d9616cf   wdenk   * Patch by Robert...
2356
2357
  		U-Boot considers the values of the environment
  		variables "serial#" (Board Serial Number) and
7152b1d0b   wdenk   * Add support for...
2358
  		"ethaddr" (Ethernet Address) to be parameters that
43d9616cf   wdenk   * Patch by Robert...
2359
2360
2361
2362
  		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
11ccc33fa   Marcel Ziswiler   Many spelling fix...
2363
  		change this behaviour:
c609719b8   wdenk   Initial revision
2364
2365
2366
  
  		If CONFIG_ENV_OVERWRITE is #defined in your config
  		file, the write protection for vendor parameters is
47cd00fa7   wdenk   * Patches by Robe...
2367
  		completely disabled. Anybody can change or delete
c609719b8   wdenk   Initial revision
2368
  		these parameters.
92ac52082   Joe Hershberger   net: Remove all r...
2369
2370
  		Alternatively, if you define _both_ an ethaddr in the
  		default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
11ccc33fa   Marcel Ziswiler   Many spelling fix...
2371
  		Ethernet address is installed in the environment,
c609719b8   wdenk   Initial revision
2372
2373
2374
  		which can be changed exactly ONCE by the user. [The
  		serial# is unaffected by this, i. e. it remains
  		read-only.]
2598090b7   Joe Hershberger   env: Add environm...
2375
2376
2377
2378
  		The same can be accomplished in a more flexible way
  		for any variable by configuring the type of access
  		to allow for those variables in the ".flags" variable
  		or define CONFIG_ENV_FLAGS_LIST_STATIC.
c609719b8   wdenk   Initial revision
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
  - 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:
fe126d8b3   Wolfgang Denk   Change all '$(......
2394
  			setenv bootargs ... mem=\${mem}
c609719b8   wdenk   Initial revision
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
  			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":
1b0757ece   Wolfgang Denk   PPC: remove dead ...
2406
2407
  			IVMS8, IVML24, SPD8xx, TQM8xxL,
  			HERMES, IP860, RPXlite, LWMON,
544d97e9a   Wolfgang Denk   PCU_E: remove cod...
2408
  			FLAGADM, TQM8260
c609719b8   wdenk   Initial revision
2409

40fef0490   Gabe Black   Introduce arch_ph...
2410
2411
2412
2413
2414
2415
2416
  - Access to physical memory region (> 4GB)
  		Some basic support is provided for operations on memory not
  		normally accessible to U-Boot - e.g. some architectures
  		support access to more than 4GB of memory on 32-bit
  		machines using physical address extension or similar.
  		Define CONFIG_PHYSMEM to access this basic support, which
  		currently only supports clearing the memory.
c609719b8   wdenk   Initial revision
2417
2418
2419
2420
2421
2422
  - 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
11ccc33fa   Marcel Ziswiler   Many spelling fix...
2423
  		system where you want the system to reboot
c609719b8   wdenk   Initial revision
2424
2425
2426
2427
2428
  		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
43d9616cf   wdenk   * Patch by Robert...
2429
2430
2431
2432
  		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.
c609719b8   wdenk   Initial revision
2433

40cb90ee2   Guennadi Liakhovetski   net: make ARP tim...
2434
2435
2436
  		CONFIG_ARP_TIMEOUT
  
  		Timeout waiting for an ARP reply in milliseconds.
48a3e999c   Tetsuyuki Kobayashi   net: nfs: make NF...
2437
2438
2439
2440
2441
2442
  		CONFIG_NFS_TIMEOUT
  
  		Timeout in milliseconds used in NFS protocol.
  		If you encounter "ERROR: Cannot umount" in nfs command,
  		try longer timeout such as
  		#define CONFIG_NFS_TIMEOUT 10000UL
c609719b8   wdenk   Initial revision
2443
  - Command Interpreter:
8078f1a5f   Wolfgang Denk   README says CFG_A...
2444
  		CONFIG_AUTO_COMPLETE
04a85b3b3   wdenk   * Patches by Pant...
2445
2446
  
  		Enable auto completion of commands using TAB.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2447
  		CONFIG_SYS_PROMPT_HUSH_PS2
c609719b8   wdenk   Initial revision
2448
2449
2450
2451
2452
2453
  
  		This defines the secondary prompt string, which is
  		printed when the command interpreter needs more input
  		to complete a command. Usually "> ".
  
  	Note:
8bde7f776   wdenk   * Code cleanup:
2454
2455
2456
2457
2458
2459
2460
  		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.
c609719b8   wdenk   Initial revision
2461

43d9616cf   wdenk   * Patch by Robert...
2462
2463
2464
2465
  		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.
c609719b8   wdenk   Initial revision
2466
2467
2468
2469
2470
2471
  
  		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.
b445bbb49   Jeremiah Mahler   doc: fix grammati...
2472
  - Command Line Editing and History:
aa0c71aca   Wolfgang Denk   Document CONFIG_C...
2473
  		CONFIG_CMDLINE_EDITING
11ccc33fa   Marcel Ziswiler   Many spelling fix...
2474
  		Enable editing and History functions for interactive
b445bbb49   Jeremiah Mahler   doc: fix grammati...
2475
  		command line input operations
aa0c71aca   Wolfgang Denk   Document CONFIG_C...
2476

f3b267b3a   Marek Vasut   hush: Add rudimen...
2477
2478
2479
2480
2481
2482
2483
  - Command Line PS1/PS2 support:
  		CONFIG_CMDLINE_PS_SUPPORT
  
  		Enable support for changing the command prompt string
  		at run-time. Only static string is supported so far.
  		The string is obtained from environment variables PS1
  		and PS2.
a8c7c708a   wdenk   * Patch by Gleb N...
2484
  - Default Environment:
c609719b8   wdenk   Initial revision
2485
  		CONFIG_EXTRA_ENV_SETTINGS
43d9616cf   wdenk   * Patch by Robert...
2486
2487
  		Define this to contain any number of null terminated
  		strings (variable = value pairs) that will be part of
7152b1d0b   wdenk   * Add support for...
2488
  		the default environment compiled into the boot image.
2262cfeef   wdenk   * Patch by Daniel...
2489

43d9616cf   wdenk   * Patch by Robert...
2490
2491
  		For example, place something like this in your
  		board's config file:
c609719b8   wdenk   Initial revision
2492
2493
2494
2495
  
  		#define CONFIG_EXTRA_ENV_SETTINGS \
  			"myvar1=value1\0" \
  			"myvar2=value2\0"
43d9616cf   wdenk   * Patch by Robert...
2496
2497
2498
2499
  		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
7152b1d0b   wdenk   * Add support for...
2500
  		will change soon, there is no guarantee either.
c609719b8   wdenk   Initial revision
2501
  		You better know what you are doing here.
43d9616cf   wdenk   * Patch by Robert...
2502
2503
  		Note: overly (ab)use of the default environment is
  		discouraged. Make sure to check other ways to preset
74de7aefd   Wolfgang Denk   Add "source" comm...
2504
  		the environment like the "source" command or the
43d9616cf   wdenk   * Patch by Robert...
2505
  		boot command first.
c609719b8   wdenk   Initial revision
2506

5e724ca2b   Stephen Warren   Add env vars desc...
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
  		CONFIG_ENV_VARS_UBOOT_CONFIG
  
  		Define this in order to add variables describing the
  		U-Boot build configuration to the default environment.
  		These will be named arch, cpu, board, vendor, and soc.
  
  		Enabling this option will cause the following to be defined:
  
  		- CONFIG_SYS_ARCH
  		- CONFIG_SYS_CPU
  		- CONFIG_SYS_BOARD
  		- CONFIG_SYS_VENDOR
  		- CONFIG_SYS_SOC
7e27f89fd   Tom Rini   README: Document ...
2520
2521
2522
2523
2524
  		CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
  
  		Define this in order to add variables describing certain
  		run-time determined information about the hardware to the
  		environment.  These will be named board_name, board_rev.
06fd85389   Simon Glass   arm: Add CONFIG_D...
2525
2526
2527
  		CONFIG_DELAY_ENVIRONMENT
  
  		Normally the environment is loaded when the board is
b445bbb49   Jeremiah Mahler   doc: fix grammati...
2528
  		initialised so that it is available to U-Boot. This inhibits
06fd85389   Simon Glass   arm: Add CONFIG_D...
2529
2530
2531
2532
  		that so that the environment is not available until
  		explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
  		this is instead controlled by the value of
  		/config/load-environment.
a8c7c708a   wdenk   * Patch by Gleb N...
2533
  - DataFlash Support:
2abbe0754   wdenk   * Patch by Nicola...
2534
  		CONFIG_HAS_DATAFLASH
8bde7f776   wdenk   * Code cleanup:
2535
2536
2537
  		Defining this option enables DataFlash features and
  		allows to read/write in Dataflash via the standard
  		commands cp, md...
2abbe0754   wdenk   * Patch by Nicola...
2538

f61ec45eb   Eric Nelson   README: Add descr...
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
  - Serial Flash support
  		CONFIG_CMD_SF
  
  		Defining this option enables SPI flash commands
  		'sf probe/read/write/erase/update'.
  
  		Usage requires an initial 'probe' to define the serial
  		flash parameters, followed by read/write/erase/update
  		commands.
  
  		The following defaults may be provided by the platform
  		to handle the common case when only a single serial
  		flash is present on the system.
  
  		CONFIG_SF_DEFAULT_BUS		Bus identifier
  		CONFIG_SF_DEFAULT_CS		Chip-select
  		CONFIG_SF_DEFAULT_MODE 		(see include/spi.h)
  		CONFIG_SF_DEFAULT_SPEED		in Hz
240072731   Simon Glass   spi: Add SPI flas...
2557
2558
2559
2560
  		CONFIG_CMD_SF_TEST
  
  		Define this option to include a destructive SPI flash
  		test ('sf test').
b902e07ce   Jagannadha Sutradharudu Teki   sf: Add CONFIG_SF...
2561
2562
2563
2564
  		CONFIG_SF_DUAL_FLASH		Dual flash memories
  
  		Define this option to use dual flash support where two flash
  		memories can be connected with a given cs line.
b445bbb49   Jeremiah Mahler   doc: fix grammati...
2565
  		Currently Xilinx Zynq qspi supports these type of connections.
b902e07ce   Jagannadha Sutradharudu Teki   sf: Add CONFIG_SF...
2566

3f85ce278   wdenk   * CVS add missing...
2567
2568
2569
2570
2571
  - SystemACE Support:
  		CONFIG_SYSTEMACE
  
  		Adding this option adds support for Xilinx SystemACE
  		chips attached via some sort of local bus. The address
11ccc33fa   Marcel Ziswiler   Many spelling fix...
2572
  		of the chip must also be defined in the
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2573
  		CONFIG_SYS_SYSTEMACE_BASE macro. For example:
3f85ce278   wdenk   * CVS add missing...
2574
2575
  
  		#define CONFIG_SYSTEMACE
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2576
  		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
3f85ce278   wdenk   * CVS add missing...
2577
2578
2579
  
  		When SystemACE support is added, the "ace" device type
  		becomes available to the fat commands, i.e. fatls.
ecb0ccd9c   Wolfgang Denk   Allow to force TF...
2580
2581
  - TFTP Fixed UDP Port:
  		CONFIG_TFTP_PORT
28cb93758   Wolfgang Denk   Update for TFTP u...
2582
  		If this is defined, the environment variable tftpsrcp
ecb0ccd9c   Wolfgang Denk   Allow to force TF...
2583
  		is used to supply the TFTP UDP source port value.
28cb93758   Wolfgang Denk   Update for TFTP u...
2584
  		If tftpsrcp isn't defined, the normal pseudo-random port
ecb0ccd9c   Wolfgang Denk   Allow to force TF...
2585
  		number generator is used.
28cb93758   Wolfgang Denk   Update for TFTP u...
2586
2587
2588
2589
2590
  		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
ecb0ccd9c   Wolfgang Denk   Allow to force TF...
2591
2592
2593
2594
2595
2596
  		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.
bf36c5d52   Simon Glass   Add hash command ...
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
  - Hashing support:
  		CONFIG_CMD_HASH
  
  		This enables a generic 'hash' command which can produce
  		hashes / digests from a few algorithms (e.g. SHA1, SHA256).
  
  		CONFIG_HASH_VERIFY
  
  		Enable the hash verify command (hash -v). This adds to code
  		size a little.
94e3c8c4f   gaurav rana   crypto/fsl - Add ...
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
  		CONFIG_SHA1 - This option enables support of hashing using SHA1
  		algorithm. The hash is calculated in software.
  		CONFIG_SHA256 - This option enables support of hashing using
  		SHA256 algorithm. The hash is calculated in software.
  		CONFIG_SHA_HW_ACCEL - This option enables hardware acceleration
  		for SHA1/SHA256 hashing.
  		This affects the 'hash' command and also the
  		hash_lookup_algo() function.
  		CONFIG_SHA_PROG_HW_ACCEL - This option enables
  		hardware-acceleration for SHA1/SHA256 progressive hashing.
  		Data can be streamed in a block at a time and the hashing
  		is performed in hardware.
bf36c5d52   Simon Glass   Add hash command ...
2619
2620
2621
  
  		Note: There is also a sha1sum command, which should perhaps
  		be deprecated in favour of 'hash sha1'.
a11f18737   Robert Winkler   imx: Add document...
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
  - Freescale i.MX specific commands:
  		CONFIG_CMD_HDMIDETECT
  		This enables 'hdmidet' command which returns true if an
  		HDMI monitor is detected.  This command is i.MX 6 specific.
  
  		CONFIG_CMD_BMODE
  		This enables the 'bmode' (bootmode) command for forcing
  		a boot from specific media.
  
  		This is useful for forcing the ROM's usb downloader to
  		activate upon a watchdog reset which is nice when iterating
  		on U-Boot.  Using the reset button or running bmode normal
  		will set it back to normal.  This command currently
  		supports i.MX53 and i.MX6.
9e50c406c   Heiko Schocher   i2c, bootcount: a...
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
  - bootcount support:
  		CONFIG_BOOTCOUNT_LIMIT
  
  		This enables the bootcounter support, see:
  		http://www.denx.de/wiki/DULG/UBootBootCountLimit
  
  		CONFIG_AT91SAM9XE
  		enable special bootcounter support on at91sam9xe based boards.
  		CONFIG_BLACKFIN
  		enable special bootcounter support on blackfin based boards.
  		CONFIG_SOC_DA8XX
  		enable special bootcounter support on da850 based boards.
  		CONFIG_BOOTCOUNT_RAM
  		enable support for the bootcounter in RAM
  		CONFIG_BOOTCOUNT_I2C
  		enable support for the bootcounter on an i2c (like RTC) device.
  			CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
  			CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
  						    the bootcounter.
  			CONFIG_BOOTCOUNT_ALEN = address len
19c402afa   Simon Glass   image: Add RSA su...
2656

a8c7c708a   wdenk   * Patch by Gleb N...
2657
  - Show boot progress:
c609719b8   wdenk   Initial revision
2658
  		CONFIG_SHOW_BOOT_PROGRESS
43d9616cf   wdenk   * Patch by Robert...
2659
2660
2661
2662
2663
2664
  		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:
c609719b8   wdenk   Initial revision
2665

94fd1316b   Simon Glass   bootstage: Store ...
2666

1372cce2b   Marian Balakowicz   [new uImage] Use ...
2667
  Legacy uImage format:
c609719b8   wdenk   Initial revision
2668
2669
    Arg	Where			When
      1	common/cmd_bootm.c	before attempting to boot an image
ba56f6257   wdenk   Patch by Travis S...
2670
     -1	common/cmd_bootm.c	Image header has bad	 magic number
c609719b8   wdenk   Initial revision
2671
      2	common/cmd_bootm.c	Image header has correct magic number
ba56f6257   wdenk   Patch by Travis S...
2672
     -2	common/cmd_bootm.c	Image header has bad	 checksum
c609719b8   wdenk   Initial revision
2673
      3	common/cmd_bootm.c	Image header has correct checksum
ba56f6257   wdenk   Patch by Travis S...
2674
     -3	common/cmd_bootm.c	Image data   has bad	 checksum
c609719b8   wdenk   Initial revision
2675
2676
2677
      4	common/cmd_bootm.c	Image data   has correct checksum
     -4	common/cmd_bootm.c	Image is for unsupported architecture
      5	common/cmd_bootm.c	Architecture check OK
1372cce2b   Marian Balakowicz   [new uImage] Use ...
2678
     -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
c609719b8   wdenk   Initial revision
2679
2680
2681
2682
      6	common/cmd_bootm.c	Image Type check OK
     -6	common/cmd_bootm.c	gunzip uncompression error
     -7	common/cmd_bootm.c	Unimplemented compression type
      7	common/cmd_bootm.c	Uncompression OK
1372cce2b   Marian Balakowicz   [new uImage] Use ...
2683
      8	common/cmd_bootm.c	No uncompress/copy overwrite error
c609719b8   wdenk   Initial revision
2684
     -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
1372cce2b   Marian Balakowicz   [new uImage] Use ...
2685
2686
2687
2688
2689
2690
2691
2692
  
      9	common/image.c		Start initial ramdisk verification
    -10	common/image.c		Ramdisk header has bad	   magic number
    -11	common/image.c		Ramdisk header has bad	   checksum
     10	common/image.c		Ramdisk header is OK
    -12	common/image.c		Ramdisk data   has bad	   checksum
     11	common/image.c		Ramdisk data   has correct checksum
     12	common/image.c		Ramdisk verification complete, start loading
11ccc33fa   Marcel Ziswiler   Many spelling fix...
2693
    -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
1372cce2b   Marian Balakowicz   [new uImage] Use ...
2694
2695
     13	common/image.c		Start multifile image verification
     14	common/image.c		No initial ramdisk, no multifile, continue.
c0f40859f   Wolfgang Denk   README: white-spa...
2696
     15	arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
c609719b8   wdenk   Initial revision
2697

a47a12bec   Stefan Roese   Move arch/ppc to ...
2698
    -30	arch/powerpc/lib/board.c	Fatal error, hang the system
11dadd547   wdenk   * Patch by Steven...
2699
2700
    -31	post/post.c		POST test failed, detected by post_output_backlog()
    -32	post/post.c		POST test failed, detected by post_run_single()
63e73c9a8   wdenk   * Patches by Rein...
2701

566a494f5   Heiko Schocher   [PCS440EP] u...
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
     34	common/cmd_doc.c	before loading a Image from a DOC device
    -35	common/cmd_doc.c	Bad usage of "doc" command
     35	common/cmd_doc.c	correct usage of "doc" command
    -36	common/cmd_doc.c	No boot device
     36	common/cmd_doc.c	correct boot device
    -37	common/cmd_doc.c	Unknown Chip ID on boot device
     37	common/cmd_doc.c	correct chip ID found, device available
    -38	common/cmd_doc.c	Read Error on boot device
     38	common/cmd_doc.c	reading Image header from DOC device OK
    -39	common/cmd_doc.c	Image header has bad magic number
     39	common/cmd_doc.c	Image header has correct magic number
    -40	common/cmd_doc.c	Error reading Image from DOC device
     40	common/cmd_doc.c	Image header has correct magic number
     41	common/cmd_ide.c	before loading a Image from a IDE device
    -42	common/cmd_ide.c	Bad usage of "ide" command
     42	common/cmd_ide.c	correct usage of "ide" command
    -43	common/cmd_ide.c	No boot device
     43	common/cmd_ide.c	boot device found
    -44	common/cmd_ide.c	Device not available
     44	common/cmd_ide.c	Device available
    -45	common/cmd_ide.c	wrong partition selected
     45	common/cmd_ide.c	partition selected
    -46	common/cmd_ide.c	Unknown partition table
     46	common/cmd_ide.c	valid partition table found
    -47	common/cmd_ide.c	Invalid partition type
     47	common/cmd_ide.c	correct partition type
    -48	common/cmd_ide.c	Error reading Image Header on boot device
     48	common/cmd_ide.c	reading Image Header from IDE device OK
    -49	common/cmd_ide.c	Image header has bad magic number
     49	common/cmd_ide.c	Image header has correct magic number
    -50	common/cmd_ide.c	Image header has bad	 checksum
     50	common/cmd_ide.c	Image header has correct checksum
    -51	common/cmd_ide.c	Error reading Image from IDE device
     51	common/cmd_ide.c	reading Image from IDE device OK
     52	common/cmd_nand.c	before loading a Image from a NAND device
    -53	common/cmd_nand.c	Bad usage of "nand" command
     53	common/cmd_nand.c	correct usage of "nand" command
    -54	common/cmd_nand.c	No boot device
     54	common/cmd_nand.c	boot device found
    -55	common/cmd_nand.c	Unknown Chip ID on boot device
     55	common/cmd_nand.c	correct chip ID found, device available
    -56	common/cmd_nand.c	Error reading Image Header on boot device
     56	common/cmd_nand.c	reading Image Header from NAND device OK
    -57	common/cmd_nand.c	Image header has bad magic number
     57	common/cmd_nand.c	Image header has correct magic number
    -58	common/cmd_nand.c	Error reading Image from NAND device
     58	common/cmd_nand.c	reading Image from NAND device OK
  
    -60	common/env_common.c	Environment has a bad CRC, using default
11ccc33fa   Marcel Ziswiler   Many spelling fix...
2751
     64	net/eth.c		starting with Ethernet configuration.
566a494f5   Heiko Schocher   [PCS440EP] u...
2752
2753
2754
2755
    -64	net/eth.c		no Ethernet found.
     65	net/eth.c		Ethernet found.
  
    -80	common/cmd_net.c	usage wrong
bc0571fc1   Joe Hershberger   net: cosmetic: Fi...
2756
2757
2758
     80	common/cmd_net.c	before calling net_loop()
    -81	common/cmd_net.c	some error in net_loop() occurred
     81	common/cmd_net.c	net_loop() back without error
566a494f5   Heiko Schocher   [PCS440EP] u...
2759
2760
    -82	common/cmd_net.c	size == 0 (File with size 0 loaded)
     82	common/cmd_net.c	trying automatic boot
74de7aefd   Wolfgang Denk   Add "source" comm...
2761
2762
     83	common/cmd_net.c	running "source" command
    -83	common/cmd_net.c	some error in automatic boot or "source" command
566a494f5   Heiko Schocher   [PCS440EP] u...
2763
     84	common/cmd_net.c	end without errors
c609719b8   wdenk   Initial revision
2764

1372cce2b   Marian Balakowicz   [new uImage] Use ...
2765
2766
2767
2768
2769
2770
2771
2772
2773
  FIT uImage format:
  
    Arg	Where			When
    100	common/cmd_bootm.c	Kernel FIT Image has correct format
   -100	common/cmd_bootm.c	Kernel FIT Image has incorrect format
    101	common/cmd_bootm.c	No Kernel subimage unit name, using configuration
   -101	common/cmd_bootm.c	Can't get configuration for kernel subimage
    102	common/cmd_bootm.c	Kernel unit name specified
   -103	common/cmd_bootm.c	Can't get kernel subimage node offset
f773bea8e   Marian Balakowicz   [new uImage] Add ...
2774
    103	common/cmd_bootm.c	Found configuration node
1372cce2b   Marian Balakowicz   [new uImage] Use ...
2775
2776
2777
2778
2779
    104	common/cmd_bootm.c	Got kernel subimage node offset
   -104	common/cmd_bootm.c	Kernel subimage hash verification failed
    105	common/cmd_bootm.c	Kernel subimage hash verification OK
   -105	common/cmd_bootm.c	Kernel subimage is for unsupported architecture
    106	common/cmd_bootm.c	Architecture check OK
11ccc33fa   Marcel Ziswiler   Many spelling fix...
2780
2781
   -106	common/cmd_bootm.c	Kernel subimage has wrong type
    107	common/cmd_bootm.c	Kernel subimage type OK
1372cce2b   Marian Balakowicz   [new uImage] Use ...
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
   -107	common/cmd_bootm.c	Can't get kernel subimage data/size
    108	common/cmd_bootm.c	Got kernel subimage data/size
   -108	common/cmd_bootm.c	Wrong image type (not legacy, FIT)
   -109	common/cmd_bootm.c	Can't get kernel subimage type
   -110	common/cmd_bootm.c	Can't get kernel subimage comp
   -111	common/cmd_bootm.c	Can't get kernel subimage os
   -112	common/cmd_bootm.c	Can't get kernel subimage load address
   -113	common/cmd_bootm.c	Image uncompress/copy overwrite error
  
    120	common/image.c		Start initial ramdisk verification
   -120	common/image.c		Ramdisk FIT image has incorrect format
    121	common/image.c		Ramdisk FIT image has correct format
11ccc33fa   Marcel Ziswiler   Many spelling fix...
2794
    122	common/image.c		No ramdisk subimage unit name, using configuration
1372cce2b   Marian Balakowicz   [new uImage] Use ...
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
   -122	common/image.c		Can't get configuration for ramdisk subimage
    123	common/image.c		Ramdisk unit name specified
   -124	common/image.c		Can't get ramdisk subimage node offset
    125	common/image.c		Got ramdisk subimage node offset
   -125	common/image.c		Ramdisk subimage hash verification failed
    126	common/image.c		Ramdisk subimage hash verification OK
   -126	common/image.c		Ramdisk subimage for unsupported architecture
    127	common/image.c		Architecture check OK
   -127	common/image.c		Can't get ramdisk subimage data/size
    128	common/image.c		Got ramdisk subimage data/size
    129	common/image.c		Can't get ramdisk load address
   -129	common/image.c		Got ramdisk load address
11ccc33fa   Marcel Ziswiler   Many spelling fix...
2807
   -130	common/cmd_doc.c	Incorrect FIT image format
1372cce2b   Marian Balakowicz   [new uImage] Use ...
2808
    131	common/cmd_doc.c	FIT image format OK
11ccc33fa   Marcel Ziswiler   Many spelling fix...
2809
   -140	common/cmd_ide.c	Incorrect FIT image format
1372cce2b   Marian Balakowicz   [new uImage] Use ...
2810
    141	common/cmd_ide.c	FIT image format OK
11ccc33fa   Marcel Ziswiler   Many spelling fix...
2811
   -150	common/cmd_nand.c	Incorrect FIT image format
1372cce2b   Marian Balakowicz   [new uImage] Use ...
2812
    151	common/cmd_nand.c	FIT image format OK
21d29f7f9   Heiko Schocher   bootm: make use o...
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
  - legacy image format:
  		CONFIG_IMAGE_FORMAT_LEGACY
  		enables the legacy image format support in U-Boot.
  
  		Default:
  		enabled if CONFIG_FIT_SIGNATURE is not defined.
  
  		CONFIG_DISABLE_IMAGE_LEGACY
  		disable the legacy image format
  
  		This define is introduced, as the legacy image format is
  		enabled per default for backward compatibility.
d95f6ec73   Gabe Black   fdt: Add option t...
2825
  - FIT image support:
9a4f479b6   Dirk Eibach   fit: make sha256 ...
2826
2827
2828
2829
  		CONFIG_FIT_DISABLE_SHA256
  		Supporting SHA256 hashes has quite an impact on binary size.
  		For constrained systems sha256 hash support can be disabled
  		with this option.
73223f0e1   Simon Glass   Kconfig: Move CON...
2830
2831
  		TODO(sjg@chromium.org): Adjust this option to be positive,
  		and move it to Kconfig
4cf2609b0   Wolfgang Denk   README: fix docum...
2832
2833
  - Standalone program support:
  		CONFIG_STANDALONE_LOAD_ADDR
6feff899e   Wolfgang Denk   README: fix typos...
2834
2835
2836
  		This option defines a board specific value for the
  		address where standalone program gets loaded, thus
  		overwriting the architecture dependent default
4cf2609b0   Wolfgang Denk   README: fix docum...
2837
2838
2839
2840
2841
2842
  		settings.
  
  - Frame Buffer Address:
  		CONFIG_FB_ADDR
  
  		Define CONFIG_FB_ADDR if you want to use specific
44a53b574   Wolfgang Denk   VIDEO: better doc...
2843
2844
2845
2846
2847
2848
2849
  		address for frame buffer.  This is typically the case
  		when using a graphics controller has separate video
  		memory.  U-Boot will then place the frame buffer at
  		the given address instead of dynamically reserving it
  		in system RAM by calling lcd_setmem(), which grabs
  		the memory for the frame buffer depending on the
  		configured panel size.
4cf2609b0   Wolfgang Denk   README: fix docum...
2850
2851
  
  		Please see board_init_f function.
cccfc2ab7   Detlev Zundel   README: Rearrange...
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
  - Automatic software updates via TFTP server
  		CONFIG_UPDATE_TFTP
  		CONFIG_UPDATE_TFTP_CNT_MAX
  		CONFIG_UPDATE_TFTP_MSEC_MAX
  
  		These options enable and control the auto-update feature;
  		for a more detailed description refer to doc/README.update.
  
  - MTD Support (mtdparts command, UBI support)
  		CONFIG_MTD_DEVICE
  
  		Adds the MTD device infrastructure from the Linux kernel.
  		Needed for mtdparts command support.
  
  		CONFIG_MTD_PARTITIONS
  
  		Adds the MTD partitioning infrastructure from the Linux
  		kernel. Needed for UBI support.
70c219cd7   Joe Hershberger   ubi: ubifs: Add d...
2870
2871
2872
2873
2874
2875
2876
  - UBI support
  		CONFIG_CMD_UBI
  
  		Adds commands for interacting with MTD partitions formatted
  		with the UBI flash translation layer
  
  		Requires also defining CONFIG_RBTREE
147162dac   Joe Hershberger   ubi: ubifs: Turn ...
2877
2878
2879
2880
  		CONFIG_UBI_SILENCE_MSG
  
  		Make the verbose messages from UBI stop printing.  This leaves
  		warnings and errors enabled.
ff94bc40a   Heiko Schocher   mtd, ubi, ubifs: ...
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
  
  		CONFIG_MTD_UBI_WL_THRESHOLD
  		This parameter defines the maximum difference between the highest
  		erase counter value and the lowest erase counter value of eraseblocks
  		of UBI devices. When this threshold is exceeded, UBI starts performing
  		wear leveling by means of moving data from eraseblock with low erase
  		counter to eraseblocks with high erase counter.
  
  		The default value should be OK for SLC NAND flashes, NOR flashes and
  		other flashes which have eraseblock life-cycle 100000 or more.
  		However, in case of MLC NAND flashes which typically have eraseblock
  		life-cycle less than 10000, the threshold should be lessened (e.g.,
  		to 128 or 256, although it does not have to be power of 2).
  
  		default: 4096
c654b5172   Simon Glass   fdt: Add ft_syste...
2896

ff94bc40a   Heiko Schocher   mtd, ubi, ubifs: ...
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
  		CONFIG_MTD_UBI_BEB_LIMIT
  		This option specifies the maximum bad physical eraseblocks UBI
  		expects on the MTD device (per 1024 eraseblocks). If the
  		underlying flash does not admit of bad eraseblocks (e.g. NOR
  		flash), this value is ignored.
  
  		NAND datasheets often specify the minimum and maximum NVM
  		(Number of Valid Blocks) for the flashes' endurance lifetime.
  		The maximum expected bad eraseblocks per 1024 eraseblocks
  		then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
  		which gives 20 for most NANDs (MaxNVB is basically the total
  		count of eraseblocks on the chip).
  
  		To put it differently, if this value is 20, UBI will try to
  		reserve about 1.9% of physical eraseblocks for bad blocks
  		handling. And that will be 1.9% of eraseblocks on the entire
  		NAND chip, not just the MTD partition UBI attaches. This means
  		that if you have, say, a NAND flash chip admits maximum 40 bad
  		eraseblocks, and it is split on two MTD partitions of the same
  		size, UBI will reserve 40 eraseblocks when attaching a
  		partition.
  
  		default: 20
  
  		CONFIG_MTD_UBI_FASTMAP
  		Fastmap is a mechanism which allows attaching an UBI device
  		in nearly constant time. Instead of scanning the whole MTD device it
  		only has to locate a checkpoint (called fastmap) on the device.
  		The on-flash fastmap contains all information needed to attach
  		the device. Using fastmap makes only sense on large devices where
  		attaching by scanning takes long. UBI will not automatically install
  		a fastmap on old images, but you can set the UBI parameter
  		CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
  		that fastmap-enabled images are still usable with UBI implementations
  		without	fastmap support. On typical flash devices the whole fastmap
  		fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
  
  		CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
  		Set this parameter to enable fastmap automatically on images
  		without a fastmap.
  		default: 0
0195a7bb3   Heiko Schocher   ubi,ubifs: sync w...
2938
2939
2940
  		CONFIG_MTD_UBI_FM_DEBUG
  		Enable UBI fastmap debug
  		default: 0
70c219cd7   Joe Hershberger   ubi: ubifs: Add d...
2941
2942
2943
2944
2945
2946
2947
  - UBIFS support
  		CONFIG_CMD_UBIFS
  
  		Adds commands for interacting with UBI volumes formatted as
  		UBIFS.  UBIFS is read-only in u-boot.
  
  		Requires UBI support as well as CONFIG_LZO
147162dac   Joe Hershberger   ubi: ubifs: Turn ...
2948
2949
2950
2951
  		CONFIG_UBIFS_SILENCE_MSG
  
  		Make the verbose messages from UBIFS stop printing.  This leaves
  		warnings and errors enabled.
6a11cf48a   Daniel Schwierzeck   spl: add initial ...
2952
  - SPL framework
04e5ae793   Wolfgang Denk   Minor coding styl...
2953
2954
  		CONFIG_SPL
  		Enable building of SPL globally.
6a11cf48a   Daniel Schwierzeck   spl: add initial ...
2955

95579793b   Tom Rini   README: document ...
2956
2957
  		CONFIG_SPL_LDSCRIPT
  		LDSCRIPT for linking the SPL binary.
6ebc34611   Albert ARIBAUD   ARM: fix CONFIG_S...
2958
2959
2960
2961
  		CONFIG_SPL_MAX_FOOTPRINT
  		Maximum size in memory allocated to the SPL, BSS included.
  		When defined, the linker checks that the actual memory
  		used by SPL from _start to __bss_end does not exceed it.
8960af8ba   Albert ARIBAUD   cosmetic: fix CON...
2962
  		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
6ebc34611   Albert ARIBAUD   ARM: fix CONFIG_S...
2963
  		must not be both defined at the same time.
95579793b   Tom Rini   README: document ...
2964
  		CONFIG_SPL_MAX_SIZE
6ebc34611   Albert ARIBAUD   ARM: fix CONFIG_S...
2965
2966
2967
2968
  		Maximum size of the SPL image (text, data, rodata, and
  		linker lists sections), BSS excluded.
  		When defined, the linker checks that the actual size does
  		not exceed it.
95579793b   Tom Rini   README: document ...
2969

04e5ae793   Wolfgang Denk   Minor coding styl...
2970
2971
  		CONFIG_SPL_TEXT_BASE
  		TEXT_BASE for linking the SPL binary.
6a11cf48a   Daniel Schwierzeck   spl: add initial ...
2972

94a45bb19   Scott Wood   powerpc/mpc85xx/p...
2973
2974
2975
  		CONFIG_SPL_RELOC_TEXT_BASE
  		Address to relocate to.  If unspecified, this is equal to
  		CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
95579793b   Tom Rini   README: document ...
2976
2977
2978
2979
  		CONFIG_SPL_BSS_START_ADDR
  		Link address for the BSS within the SPL binary.
  
  		CONFIG_SPL_BSS_MAX_SIZE
6ebc34611   Albert ARIBAUD   ARM: fix CONFIG_S...
2980
2981
2982
  		Maximum size in memory allocated to the SPL BSS.
  		When defined, the linker checks that the actual memory used
  		by SPL from __bss_start to __bss_end does not exceed it.
8960af8ba   Albert ARIBAUD   cosmetic: fix CON...
2983
  		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
6ebc34611   Albert ARIBAUD   ARM: fix CONFIG_S...
2984
  		must not be both defined at the same time.
95579793b   Tom Rini   README: document ...
2985
2986
2987
  
  		CONFIG_SPL_STACK
  		Adress of the start of the stack SPL will use
8c80eb3b5   Albert ARIBAUD \(3ADEV\)   Introduce CONFIG_...
2988
2989
2990
2991
2992
2993
2994
2995
2996
  		CONFIG_SPL_PANIC_ON_RAW_IMAGE
  		When defined, SPL will panic() if the image it has
  		loaded does not have a signature.
  		Defining this is useful when code which loads images
  		in SPL cannot guarantee that absolutely all read errors
  		will be caught.
  		An example is the LPC32XX MLC NAND driver, which will
  		consider that a completely unreadable NAND block is bad,
  		and thus should be skipped silently.
e07275151   Marek Vasut   SPL: Add CONFIG_S...
2997
2998
2999
  		CONFIG_SPL_ABORT_ON_RAW_IMAGE
  		When defined, SPL will proceed to another boot method
  		if the image it has loaded does not have a signature.
94a45bb19   Scott Wood   powerpc/mpc85xx/p...
3000
3001
3002
3003
  		CONFIG_SPL_RELOC_STACK
  		Adress of the start of the stack SPL will use after
  		relocation.  If unspecified, this is equal to
  		CONFIG_SPL_STACK.
95579793b   Tom Rini   README: document ...
3004
3005
  		CONFIG_SYS_SPL_MALLOC_START
  		Starting address of the malloc pool used in SPL.
9ac4fc820   Fabio Estevam   board_init: Chang...
3006
3007
3008
  		When this option is set the full malloc is used in SPL and
  		it is set up by spl_init() and before that, the simple malloc()
  		can be used if CONFIG_SYS_MALLOC_F is defined.
95579793b   Tom Rini   README: document ...
3009
3010
3011
  
  		CONFIG_SYS_SPL_MALLOC_SIZE
  		The size of the malloc pool used in SPL.
6a11cf48a   Daniel Schwierzeck   spl: add initial ...
3012

47f7bcae8   Tom Rini   SPL: Move the oma...
3013
3014
3015
3016
  		CONFIG_SPL_FRAMEWORK
  		Enable the SPL framework under common/.  This framework
  		supports MMC, NAND and YMODEM loading of U-Boot and NAND
  		NAND loading of the Linux Kernel.
9607faf20   Tom Rini   README: Add CONFI...
3017
3018
3019
  		CONFIG_SPL_OS_BOOT
  		Enable booting directly to an OS from SPL.
  		See also: doc/README.falcon
861a86f46   Tom Rini   omap-common: SPL:...
3020
3021
3022
  		CONFIG_SPL_DISPLAY_PRINT
  		For ARM, enable an optional function to print more information
  		about the running system.
4b919725b   Scott Wood   spl/powerpc: intr...
3023
3024
  		CONFIG_SPL_INIT_MINIMAL
  		Arch init code should be built for a very small image
b97300b62   Paul Kocialkowski   spl: MMC U-Boot i...
3025
3026
3027
  		CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
  		Partition on the MMC to load U-Boot from when the MMC is being
  		used in raw mode
2b75b0ad3   Peter Korsgaard   spl_mmc: add Falc...
3028
3029
3030
3031
3032
3033
3034
3035
3036
  		CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
  		Sector to load kernel uImage from when MMC is being
  		used in raw mode (for Falcon mode)
  
  		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
  		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
  		Sector and number of sectors to load kernel argument
  		parameters from when MMC is being used in raw mode
  		(for falcon mode)
e2ccdf89a   Paul Kocialkowski   MMC SD fs boot pa...
3037
3038
3039
  		CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
  		Partition on the MMC to load U-Boot from when the MMC is being
  		used in fs mode
fae81c72c   Guillaume GARDET   doc: Update docum...
3040
3041
3042
3043
  		CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
  		Filename to read to load U-Boot when reading from filesystem
  
  		CONFIG_SPL_FS_LOAD_KERNEL_NAME
7ad2cc796   Peter Korsgaard   spl_mmc: add Falc...
3044
  		Filename to read to load kernel uImage when reading
fae81c72c   Guillaume GARDET   doc: Update docum...
3045
  		from filesystem (for Falcon mode)
7ad2cc796   Peter Korsgaard   spl_mmc: add Falc...
3046

fae81c72c   Guillaume GARDET   doc: Update docum...
3047
  		CONFIG_SPL_FS_LOAD_ARGS_NAME
7ad2cc796   Peter Korsgaard   spl_mmc: add Falc...
3048
  		Filename to read to load kernel argument parameters
fae81c72c   Guillaume GARDET   doc: Update docum...
3049
  		when reading from filesystem (for Falcon mode)
7ad2cc796   Peter Korsgaard   spl_mmc: add Falc...
3050

06f60ae3e   Scott Wood   powerpc/mpc83xx: ...
3051
3052
3053
3054
3055
  		CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
  		Set this for NAND SPL on PPC mpc83xx targets, so that
  		start.S waits for the rest of the SPL to load before
  		continuing (the hardware starts execution after just
  		loading the first page rather than the full 4K).
651fcf601   Prabhakar Kushwaha   powerpc:Add suppo...
3056
3057
  		CONFIG_SPL_SKIP_RELOCATE
  		Avoid SPL relocation
6f2f01b9f   Scott Wood   spl/nand: introdu...
3058
3059
3060
3061
3062
3063
3064
3065
3066
  		CONFIG_SPL_NAND_BASE
  		Include nand_base.c in the SPL.  Requires
  		CONFIG_SPL_NAND_DRIVERS.
  
  		CONFIG_SPL_NAND_DRIVERS
  		SPL uses normal NAND drivers, not minimal drivers.
  
  		CONFIG_SPL_NAND_ECC
  		Include standard software ECC in the SPL
95579793b   Tom Rini   README: document ...
3067
  		CONFIG_SPL_NAND_SIMPLE
7d4b79552   Scott Wood   spl/nand: config ...
3068
3069
  		Support for NAND boot using simple NAND drivers that
  		expose the cmd_ctrl() interface.
95579793b   Tom Rini   README: document ...
3070

6f4e7d3c7   Thomas Gleixner   spl: Lightweight ...
3071
3072
3073
  		CONFIG_SPL_UBI
  		Support for a lightweight UBI (fastmap) scanner and
  		loader
0c3117b1f   Heiko Schocher   spl, nand: add op...
3074
3075
3076
  		CONFIG_SPL_NAND_RAW_ONLY
  		Support to boot only raw u-boot.bin images. Use this only
  		if you need to save space.
7c8eea59b   Ying Zhang   powerpc: p1022ds:...
3077
3078
3079
  		CONFIG_SPL_COMMON_INIT_DDR
  		Set for common ddr init with serial presence detect in
  		SPL binary.
95579793b   Tom Rini   README: document ...
3080
3081
3082
3083
3084
3085
  		CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
  		CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
  		CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
  		CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
  		CONFIG_SYS_NAND_ECCBYTES
  		Defines the size and behavior of the NAND that SPL uses
7d4b79552   Scott Wood   spl/nand: config ...
3086
  		to read U-Boot
95579793b   Tom Rini   README: document ...
3087

fbe76ae4e   Prabhakar Kushwaha   board/freescale:R...
3088
3089
  		CONFIG_SPL_NAND_BOOT
  		Add support NAND boot
95579793b   Tom Rini   README: document ...
3090
  		CONFIG_SYS_NAND_U_BOOT_OFFS
7d4b79552   Scott Wood   spl/nand: config ...
3091
3092
3093
3094
3095
3096
3097
  		Location in NAND to read U-Boot from
  
  		CONFIG_SYS_NAND_U_BOOT_DST
  		Location in memory to load U-Boot to
  
  		CONFIG_SYS_NAND_U_BOOT_SIZE
  		Size of image to load
95579793b   Tom Rini   README: document ...
3098
3099
  
  		CONFIG_SYS_NAND_U_BOOT_START
7d4b79552   Scott Wood   spl/nand: config ...
3100
  		Entry point in loaded image to jump to
95579793b   Tom Rini   README: document ...
3101
3102
3103
  
  		CONFIG_SYS_NAND_HW_ECC_OOBFIRST
  		Define this if you need to first read the OOB and then the
b445bbb49   Jeremiah Mahler   doc: fix grammati...
3104
  		data. This is used, for example, on davinci platforms.
95579793b   Tom Rini   README: document ...
3105
3106
3107
3108
  
  		CONFIG_SPL_OMAP3_ID_NAND
  		Support for an OMAP3-specific set of functions to return the
  		ID and MFR of the first attached NAND chip, if present.
c57b953da   Pavel Machek   SPL: Add support ...
3109
3110
  		CONFIG_SPL_RAM_DEVICE
  		Support for running image already present in ram, in SPL binary
6a11cf48a   Daniel Schwierzeck   spl: add initial ...
3111

74752baa7   Scott Wood   spl: Change PAD_T...
3112
  		CONFIG_SPL_PAD_TO
6113d3f27   Benoît Thébaudeau   Makefile: Change ...
3113
3114
3115
3116
3117
  		Image offset to which the SPL should be padded before appending
  		the SPL payload. By default, this is defined as
  		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
  		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
  		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
74752baa7   Scott Wood   spl: Change PAD_T...
3118

ca2fca223   Scott Wood   spl: introduce CO...
3119
3120
3121
3122
  		CONFIG_SPL_TARGET
  		Final target image containing SPL and payload.  Some SPLs
  		use an arch-specific makefile fragment instead, for
  		example if more than one image needs to be produced.
87ebee39e   Simon Glass   image: Add CONFIG...
3123
3124
3125
3126
3127
  		CONFIG_FIT_SPL_PRINT
  		Printing information about a FIT image adds quite a bit of
  		code to SPL. So this is normally disabled in SPL. Use this
  		option to re-enable it. This will affect the output of the
  		bootm command when booting a FIT image.
3aa29de0b   Ying Zhang   TPL : introduce t...
3128
3129
3130
3131
3132
3133
3134
  - TPL framework
  		CONFIG_TPL
  		Enable building of TPL globally.
  
  		CONFIG_TPL_PAD_TO
  		Image offset to which the TPL should be padded before appending
  		the TPL payload. By default, this is defined as
93e145964   Wolfgang Denk   Coding Style clea...
3135
3136
3137
  		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
  		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
  		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
3aa29de0b   Ying Zhang   TPL : introduce t...
3138

a8c7c708a   wdenk   * Patch by Gleb N...
3139
  - Interrupt support (PPC):
d4ca31c40   wdenk   * Cleanup lowboot...
3140
3141
  		There are common interrupt_init() and timer_interrupt()
  		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
11ccc33fa   Marcel Ziswiler   Many spelling fix...
3142
  		for CPU specific initialization. interrupt_init_cpu()
d4ca31c40   wdenk   * Cleanup lowboot...
3143
  		should set decrementer_count to appropriate value. If
11ccc33fa   Marcel Ziswiler   Many spelling fix...
3144
  		CPU resets decrementer automatically after interrupt
d4ca31c40   wdenk   * Cleanup lowboot...
3145
  		(ppc4xx) it should set decrementer_count to zero.
11ccc33fa   Marcel Ziswiler   Many spelling fix...
3146
  		timer_interrupt() calls timer_interrupt_cpu() for CPU
d4ca31c40   wdenk   * Cleanup lowboot...
3147
3148
3149
  		specific handling. If board has watchdog / status_led
  		/ other_activity_monitor it works automatically from
  		general timer_interrupt().
a8c7c708a   wdenk   * Patch by Gleb N...
3150

c609719b8   wdenk   Initial revision
3151

9660e442d   Helmut Raiger   cosmetic: s/BOARD...
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
  Board initialization settings:
  ------------------------------
  
  During Initialization u-boot calls a number of board specific functions
  to allow the preparation of board specific prerequisites, e.g. pin setup
  before drivers are initialized. To enable these callbacks the
  following configuration macros have to be defined. Currently this is
  architecture specific, so please check arch/your_architecture/lib/board.c
  typically in board_init_f() and board_init_r().
  
  - CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
  - CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
  - CONFIG_BOARD_LATE_INIT: Call board_late_init()
  - CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
c609719b8   wdenk   Initial revision
3166

c609719b8   wdenk   Initial revision
3167
3168
  Configuration Settings:
  -----------------------
4d1fd7f1a   York Sun   Add 64-bit data s...
3169
3170
  - CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
  		Optionally it can be defined to support 64-bit memory commands.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3171
  - CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
c609719b8   wdenk   Initial revision
3172
  		undefine this when you're short of memory.
2fb2604d5   Peter Tyser   Command usage cle...
3173
3174
  - CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
  		width of the commands listed in the 'help' command output.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3175
  - CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
c609719b8   wdenk   Initial revision
3176
  		prompt for user input.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3177
  - CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
c609719b8   wdenk   Initial revision
3178

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3179
  - CONFIG_SYS_PBSIZE:	Buffer size for Console output
c609719b8   wdenk   Initial revision
3180

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3181
  - CONFIG_SYS_MAXARGS:	max. Number of arguments accepted for monitor commands
c609719b8   wdenk   Initial revision
3182

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3183
  - CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
c609719b8   wdenk   Initial revision
3184
3185
  		the application (usually a Linux kernel) when it is
  		booted
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3186
  - CONFIG_SYS_BAUDRATE_TABLE:
c609719b8   wdenk   Initial revision
3187
  		List of legal baudrate settings for this board.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3188
  - CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
c609719b8   wdenk   Initial revision
3189
3190
  		Begin and End addresses of the area used by the
  		simple memory test.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3191
  - CONFIG_SYS_ALT_MEMTEST:
8bde7f776   wdenk   * Code cleanup:
3192
  		Enable an alternate, more extensive memory test.
c609719b8   wdenk   Initial revision
3193

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3194
  - CONFIG_SYS_MEMTEST_SCRATCH:
5f535fe17   wdenk   * Patches by Ande...
3195
3196
  		Scratch address used by the alternate memory test
  		You only need to set this if address zero isn't writeable
e81495224   York Sun   Reserve secure me...
3197
  - CONFIG_SYS_MEM_RESERVE_SECURE
e61a7534e   York Sun   armv8: Move secur...
3198
  		Only implemented for ARMv8 for now.
e81495224   York Sun   Reserve secure me...
3199
3200
3201
  		If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
  		is substracted from total RAM and won't be reported to OS.
  		This memory can be used as secure memory. A variable
e61a7534e   York Sun   armv8: Move secur...
3202
  		gd->arch.secure_ram is used to track the location. In systems
e81495224   York Sun   Reserve secure me...
3203
3204
  		the RAM base is not zero, or RAM is divided into banks,
  		this variable needs to be recalcuated to get the address.
aabd7ddb8   York Sun   common: Rewrite h...
3205
  - CONFIG_SYS_MEM_TOP_HIDE:
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3206
  		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
14f73ca67   Stefan Roese   ppc: Add CFG_MEM_...
3207
  		this specified memory area will get subtracted from the top
11ccc33fa   Marcel Ziswiler   Many spelling fix...
3208
  		(end) of RAM and won't get "touched" at all by U-Boot. By
14f73ca67   Stefan Roese   ppc: Add CFG_MEM_...
3209
3210
3211
  		fixing up gd->ram_size the Linux kernel should gets passed
  		the now "corrected" memory size and won't touch it either.
  		This should work for arch/ppc and arch/powerpc. Only Linux
5e12e75d1   Stefan Roese   ppc: Small change...
3212
  		board ports in arch/powerpc with bootwrapper support that
14f73ca67   Stefan Roese   ppc: Add CFG_MEM_...
3213
  		recalculate the memory size from the SDRAM controller setup
5e12e75d1   Stefan Roese   ppc: Small change...
3214
  		will have to get fixed in Linux additionally.
14f73ca67   Stefan Roese   ppc: Add CFG_MEM_...
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
  
  		This option can be used as a workaround for the 440EPx/GRx
  		CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
  		be touched.
  
  		WARNING: Please make sure that this value is a multiple of
  		the Linux page size (normally 4k). If this is not the case,
  		then the end address of the Linux memory will be located at a
  		non page size aligned address and this could cause major
  		problems.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3225
  - CONFIG_SYS_LOADS_BAUD_CHANGE:
c609719b8   wdenk   Initial revision
3226
  		Enable temporary baudrate change while serial download
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3227
  - CONFIG_SYS_SDRAM_BASE:
c609719b8   wdenk   Initial revision
3228
  		Physical start address of SDRAM. _Must_ be 0 here.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3229
  - CONFIG_SYS_FLASH_BASE:
c609719b8   wdenk   Initial revision
3230
  		Physical start address of Flash memory.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3231
  - CONFIG_SYS_MONITOR_BASE:
c609719b8   wdenk   Initial revision
3232
3233
  		Physical start address of boot monitor code (set by
  		make config files to be same as the text base address
14d0a02a1   Wolfgang Denk   Rename TEXT_BASE ...
3234
  		(CONFIG_SYS_TEXT_BASE) used when linking) - same as
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3235
  		CONFIG_SYS_FLASH_BASE when booting from flash.
c609719b8   wdenk   Initial revision
3236

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3237
  - CONFIG_SYS_MONITOR_LEN:
8bde7f776   wdenk   * Code cleanup:
3238
3239
3240
3241
  		Size of memory reserved for monitor code, used to
  		determine _at_compile_time_ (!) if the environment is
  		embedded within the U-Boot image, or in a separate
  		flash sector.
c609719b8   wdenk   Initial revision
3242

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3243
  - CONFIG_SYS_MALLOC_LEN:
c609719b8   wdenk   Initial revision
3244
  		Size of DRAM reserved for malloc() use.
d59476b64   Simon Glass   Add a simple mall...
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
  - CONFIG_SYS_MALLOC_F_LEN
  		Size of the malloc() pool for use before relocation. If
  		this is defined, then a very simple malloc() implementation
  		will become available before relocation. The address is just
  		below the global data, and the stack is moved down to make
  		space.
  
  		This feature allocates regions with increasing addresses
  		within the region. calloc() is supported, but realloc()
  		is not available. free() is supported but does nothing.
b445bbb49   Jeremiah Mahler   doc: fix grammati...
3255
  		The memory will be freed (or in fact just forgotten) when
d59476b64   Simon Glass   Add a simple mall...
3256
  		U-Boot relocates itself.
38687ae67   Simon Glass   dm: Update docume...
3257
3258
3259
3260
  - CONFIG_SYS_MALLOC_SIMPLE
  		Provides a simple and small malloc() and calloc() for those
  		boards which do not use the full malloc in SPL (which is
  		enabled with CONFIG_SYS_SPL_MALLOC_START).
1dfdd9ba4   Thierry Reding   ARM: Implement no...
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
  - CONFIG_SYS_NONCACHED_MEMORY:
  		Size of non-cached memory area. This area of memory will be
  		typically located right below the malloc() area and mapped
  		uncached in the MMU. This is useful for drivers that would
  		otherwise require a lot of explicit cache maintenance. For
  		some drivers it's also impossible to properly maintain the
  		cache. For example if the regions that need to be flushed
  		are not a multiple of the cache-line size, *and* padding
  		cannot be allocated between the regions to align them (i.e.
  		if the HW requires a contiguous array of regions, and the
  		size of each region is not cache-aligned), then a flush of
  		one region may result in overwriting data that hardware has
  		written to another region in the same cache-line. This can
  		happen for example in network drivers where descriptors for
  		buffers are typically smaller than the CPU cache-line (e.g.
  		16 bytes vs. 32 or 64 bytes).
  
  		Non-cached memory is only supported on 32-bit ARM at present.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3279
  - CONFIG_SYS_BOOTM_LEN:
15940c9af   Stefan Roese   Change max size o...
3280
3281
  		Normally compressed uImages are limited to an
  		uncompressed size of 8 MBytes. If this is not enough,
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3282
  		you can define CONFIG_SYS_BOOTM_LEN in your board config file
15940c9af   Stefan Roese   Change max size o...
3283
  		to adjust this setting to your needs.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3284
  - CONFIG_SYS_BOOTMAPSZ:
c609719b8   wdenk   Initial revision
3285
3286
  		Maximum size of memory mapped by the startup code of
  		the Linux kernel; all data that must be processed by
7d721e34a   Bartlomiej Sieka   Boot-related docu...
3287
3288
  		the Linux kernel (bd_info, boot arguments, FDT blob if
  		used) must be put below this limit, unless "bootm_low"
1bce2aeb6   Robert P. J. Day   Cosmetic: Fix a n...
3289
  		environment variable is defined and non-zero. In such case
7d721e34a   Bartlomiej Sieka   Boot-related docu...
3290
  		all data for the Linux kernel must be between "bootm_low"
c0f40859f   Wolfgang Denk   README: white-spa...
3291
  		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.	 The environment
c3624e6ed   Grant Likely   Default to bootm_...
3292
3293
3294
  		variable "bootm_mapsize" will override the value of
  		CONFIG_SYS_BOOTMAPSZ.  If CONFIG_SYS_BOOTMAPSZ is undefined,
  		then the value in "bootm_size" will be used instead.
c609719b8   wdenk   Initial revision
3295

fca43cc80   John Rigby   boot: change some...
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
  - CONFIG_SYS_BOOT_RAMDISK_HIGH:
  		Enable initrd_high functionality.  If defined then the
  		initrd_high feature is enabled and the bootm ramdisk subcommand
  		is enabled.
  
  - CONFIG_SYS_BOOT_GET_CMDLINE:
  		Enables allocating and saving kernel cmdline in space between
  		"bootm_low" and "bootm_low" + BOOTMAPSZ.
  
  - CONFIG_SYS_BOOT_GET_KBD:
  		Enables allocating and saving a kernel copy of the bd_info in
  		space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3308
  - CONFIG_SYS_MAX_FLASH_BANKS:
c609719b8   wdenk   Initial revision
3309
  		Max number of Flash memory banks
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3310
  - CONFIG_SYS_MAX_FLASH_SECT:
c609719b8   wdenk   Initial revision
3311
  		Max number of sectors on a Flash chip
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3312
  - CONFIG_SYS_FLASH_ERASE_TOUT:
c609719b8   wdenk   Initial revision
3313
  		Timeout for Flash erase operations (in ms)
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3314
  - CONFIG_SYS_FLASH_WRITE_TOUT:
c609719b8   wdenk   Initial revision
3315
  		Timeout for Flash write operations (in ms)
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3316
  - CONFIG_SYS_FLASH_LOCK_TOUT
8564acf93   wdenk   * Patches by Yuli...
3317
  		Timeout for Flash set sector lock bit operation (in ms)
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3318
  - CONFIG_SYS_FLASH_UNLOCK_TOUT
8564acf93   wdenk   * Patches by Yuli...
3319
  		Timeout for Flash clear lock bits operation (in ms)
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3320
  - CONFIG_SYS_FLASH_PROTECTION
8564acf93   wdenk   * Patches by Yuli...
3321
3322
  		If defined, hardware flash sectors protection is used
  		instead of U-Boot software protection.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3323
  - CONFIG_SYS_DIRECT_FLASH_TFTP:
c609719b8   wdenk   Initial revision
3324
3325
3326
3327
3328
3329
3330
3331
  
  		Enable TFTP transfers directly to flash memory;
  		without this option such a download has to be
  		performed in two steps: (1) download to RAM, and (2)
  		copy from RAM to flash.
  
  		The two-step approach is usually more reliable, since
  		you can check if the download worked before you erase
11ccc33fa   Marcel Ziswiler   Many spelling fix...
3332
3333
  		the flash, but in some situations (when system RAM is
  		too limited to allow for a temporary copy of the
c609719b8   wdenk   Initial revision
3334
  		downloaded image) this option may be very useful.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3335
  - CONFIG_SYS_FLASH_CFI:
43d9616cf   wdenk   * Patch by Robert...
3336
  		Define if the flash driver uses extra elements in the
5653fc335   wdenk   * Patch by Yuli B...
3337
  		common flash structure for storing flash geometry.
00b1883a4   Jean-Christophe PLAGNIOL-VILLARD   drivers/mtd: Move...
3338
  - CONFIG_FLASH_CFI_DRIVER
5653fc335   wdenk   * Patch by Yuli B...
3339
3340
  		This option also enables the building of the cfi_flash driver
  		in the drivers directory
c609719b8   wdenk   Initial revision
3341

91809ed51   Piotr Ziecik   cfi-mtd: Add cfi-...
3342
3343
3344
3345
  - CONFIG_FLASH_CFI_MTD
  		This option enables the building of the cfi_mtd driver
  		in the drivers directory. The driver exports CFI flash
  		to the MTD layer.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3346
  - CONFIG_SYS_FLASH_USE_BUFFER_WRITE
96ef831f7   Guennadi Liakhovetski   cfi_flash: Suppor...
3347
3348
3349
3350
3351
  		Use buffered writes to flash.
  
  - CONFIG_FLASH_SPANSION_S29WS_N
  		s29ws-n MirrorBit flash has non-standard addresses for buffered
  		write commands.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3352
  - CONFIG_SYS_FLASH_QUIET_TEST
5568e613e   Stefan Roese   Add support for P...
3353
3354
3355
3356
  		If this option is defined, the common CFI flash doesn't
  		print it's warning upon not recognized FLASH banks. This
  		is useful, if some of the configured banks are only
  		optionally available.
9a042e9ca   Jerry Van Baren   Flash programming...
3357
3358
3359
3360
  - CONFIG_FLASH_SHOW_PROGRESS
  		If defined (must be an integer), print out countdown
  		digits and dots.  Recommended value: 45 (9..1) for 80
  		column displays, 15 (3..1) for 40 column displays.
352ef3f1b   Stefan Roese   flash: Add option...
3361
3362
3363
3364
3365
3366
3367
3368
  - CONFIG_FLASH_VERIFY
  		If defined, the content of the flash (destination) is compared
  		against the source after the write operation. An error message
  		will be printed when the contents are not identical.
  		Please note that this option is useless in nearly all cases,
  		since such flash programming errors usually are detected earlier
  		while unprotecting/erasing/programming. Please only enable
  		this option if you really know what you are doing.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3369
  - CONFIG_SYS_RX_ETH_BUFFER:
11ccc33fa   Marcel Ziswiler   Many spelling fix...
3370
3371
  		Defines the number of Ethernet receive buffers. On some
  		Ethernet controllers it is recommended to set this value
53cf9435c   stroese   - CFG_RX_ETH_BUFF...
3372
3373
  		to 8 or even higher (EEPRO100 or 405 EMAC), since all
  		buffers can be full shortly after enabling the interface
11ccc33fa   Marcel Ziswiler   Many spelling fix...
3374
  		on high Ethernet traffic.
53cf9435c   stroese   - CFG_RX_ETH_BUFF...
3375
  		Defaults to 4 if not defined.
ea882baf9   Wolfgang Denk   New implementatio...
3376
  - CONFIG_ENV_MAX_ENTRIES
071bc9233   Wolfgang Denk   Coding Style cleanup
3377
3378
3379
3380
3381
  	Maximum number of entries in the hash table that is used
  	internally to store the environment settings. The default
  	setting is supposed to be generous and should work in most
  	cases. This setting can be used to tune behaviour; see
  	lib/hashtable.c for details.
ea882baf9   Wolfgang Denk   New implementatio...
3382

2598090b7   Joe Hershberger   env: Add environm...
3383
3384
  - CONFIG_ENV_FLAGS_LIST_DEFAULT
  - CONFIG_ENV_FLAGS_LIST_STATIC
1bce2aeb6   Robert P. J. Day   Cosmetic: Fix a n...
3385
  	Enable validation of the values given to environment variables when
2598090b7   Joe Hershberger   env: Add environm...
3386
3387
3388
3389
3390
3391
  	calling env set.  Variables can be restricted to only decimal,
  	hexadecimal, or boolean.  If CONFIG_CMD_NET is also defined,
  	the variables can also be restricted to IP address or MAC address.
  
  	The format of the list is:
  		type_attribute = [s|d|x|b|i|m]
b445bbb49   Jeremiah Mahler   doc: fix grammati...
3392
3393
  		access_attribute = [a|r|o|c]
  		attributes = type_attribute[access_attribute]
2598090b7   Joe Hershberger   env: Add environm...
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
  		entry = variable_name[:attributes]
  		list = entry[,list]
  
  	The type attributes are:
  		s - String (default)
  		d - Decimal
  		x - Hexadecimal
  		b - Boolean ([1yYtT|0nNfF])
  		i - IP address
  		m - MAC address
267541f77   Joe Hershberger   env: Add support ...
3404
3405
3406
3407
3408
  	The access attributes are:
  		a - Any (default)
  		r - Read-only
  		o - Write-once
  		c - Change-default
2598090b7   Joe Hershberger   env: Add environm...
3409
3410
  	- CONFIG_ENV_FLAGS_LIST_DEFAULT
  		Define this to a list (string) to define the ".flags"
b445bbb49   Jeremiah Mahler   doc: fix grammati...
3411
  		environment variable in the default or embedded environment.
2598090b7   Joe Hershberger   env: Add environm...
3412
3413
3414
3415
3416
3417
3418
  
  	- CONFIG_ENV_FLAGS_LIST_STATIC
  		Define this to a list (string) to define validation that
  		should be done if an entry is not found in the ".flags"
  		environment variable.  To override a setting in the static
  		list, simply add an entry for the same variable name to the
  		".flags" variable.
bdf1fe4e6   Joe Hershberger   env: Add regex su...
3419
3420
3421
  	If CONFIG_REGEX is defined, the variable_name above is evaluated as a
  	regular expression. This allows multiple variables to define the same
  	flags without explicitly listing them for each variable.
267541f77   Joe Hershberger   env: Add support ...
3422
3423
3424
  - CONFIG_ENV_ACCESS_IGNORE_FORCE
  	If defined, don't allow the -f switch to env set override variable
  	access flags.
0b1b60c77   Lokesh Vutla   ARM: OMAP5: Fix w...
3425
3426
3427
  - CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
  	This is set by OMAP boards for the max time that reset should
  	be asserted. See doc/README.omap-reset-time for details on how
b445bbb49   Jeremiah Mahler   doc: fix grammati...
3428
  	the value can be calculated on a given board.
632efa744   Simon Glass   Add CONFIG_SYS_SY...
3429

0d296cc2d   Gabe Black   Provide option to...
3430
3431
3432
3433
  - CONFIG_USE_STDINT
  	If stdint.h is available with your toolchain you can define this
  	option to enable it. You can provide option 'USE_STDINT=1' when
  	building U-Boot to enable this.
c609719b8   wdenk   Initial revision
3434
3435
3436
  The following definitions that deal with the placement and management
  of environment data (variable area); in general, we support the
  following configurations:
c3eb3fe49   Mike Frysinger   env: allow people...
3437
3438
3439
3440
  - CONFIG_BUILD_ENVCRC:
  
  	Builds up envcrc with the target environment so that external utils
  	may easily extract it and embed it in final U-Boot images.
5a1aceb06   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ENV_IS...
3441
  - CONFIG_ENV_IS_IN_FLASH:
c609719b8   wdenk   Initial revision
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
  
  	Define this if the environment is in flash memory.
  
  	a) The environment occupies one whole flash sector, which is
  	   "embedded" in the text segment with the U-Boot code. This
  	   happens usually with "bottom boot sector" or "top boot
  	   sector" type flash chips, which have several smaller
  	   sectors at the start or the end. For instance, such a
  	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
  	   such a case you would place the environment in one of the
  	   4 kB sectors - with U-Boot code before and after it. With
  	   "top boot sector" type flash chips, you would put the
  	   environment in one of the last sectors, leaving a gap
  	   between U-Boot and the environment.
0e8d15866   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ENV ma...
3456
  	- CONFIG_ENV_OFFSET:
c609719b8   wdenk   Initial revision
3457
3458
3459
3460
3461
  
  	   Offset of environment data (variable area) to the
  	   beginning of flash memory; for instance, with bottom boot
  	   type flash chips the second sector can be used: the offset
  	   for this sector is given here.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3462
  	   CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
c609719b8   wdenk   Initial revision
3463

0e8d15866   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ENV ma...
3464
  	- CONFIG_ENV_ADDR:
c609719b8   wdenk   Initial revision
3465
3466
3467
  
  	   This is just another way to specify the start address of
  	   the flash sector containing the environment (instead of
0e8d15866   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ENV ma...
3468
  	   CONFIG_ENV_OFFSET).
c609719b8   wdenk   Initial revision
3469

0e8d15866   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ENV ma...
3470
  	- CONFIG_ENV_SECT_SIZE:
c609719b8   wdenk   Initial revision
3471
3472
3473
3474
3475
3476
3477
  
  	   Size of the sector containing the environment.
  
  
  	b) Sometimes flash chips have few, equal sized, BIG sectors.
  	   In such a case you don't want to spend a whole sector for
  	   the environment.
0e8d15866   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ENV ma...
3478
  	- CONFIG_ENV_SIZE:
c609719b8   wdenk   Initial revision
3479

5a1aceb06   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ENV_IS...
3480
  	   If you use this in combination with CONFIG_ENV_IS_IN_FLASH
0e8d15866   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ENV ma...
3481
  	   and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
c609719b8   wdenk   Initial revision
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
  	   of this flash sector for the environment. This saves
  	   memory for the RAM copy of the environment.
  
  	   It may also save flash memory if you decide to use this
  	   when your environment is "embedded" within U-Boot code,
  	   since then the remainder of the flash sector could be used
  	   for U-Boot code. It should be pointed out that this is
  	   STRONGLY DISCOURAGED from a robustness point of view:
  	   updating the environment in flash makes it always
  	   necessary to erase the WHOLE sector. If something goes
  	   wrong before the contents has been restored from a copy in
  	   RAM, your target system will be dead.
0e8d15866   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ENV ma...
3494
3495
  	- CONFIG_ENV_ADDR_REDUND
  	  CONFIG_ENV_SIZE_REDUND
c609719b8   wdenk   Initial revision
3496

43d9616cf   wdenk   * Patch by Robert...
3497
  	   These settings describe a second storage area used to hold
11ccc33fa   Marcel Ziswiler   Many spelling fix...
3498
  	   a redundant copy of the environment data, so that there is
3e38691e8   wdenk   * Patch by Arun D...
3499
  	   a valid backup copy in case there is a power failure during
43d9616cf   wdenk   * Patch by Robert...
3500
  	   a "saveenv" operation.
c609719b8   wdenk   Initial revision
3501
3502
3503
3504
  
  BE CAREFUL! Any changes to the flash layout, and some changes to the
  source code will make it necessary to adapt <board>/u-boot.lds*
  accordingly!
9314cee69   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ENV_IS...
3505
  - CONFIG_ENV_IS_IN_NVRAM:
c609719b8   wdenk   Initial revision
3506
3507
3508
3509
  
  	Define this if you have some non-volatile memory device
  	(NVRAM, battery buffered SRAM) which you want to use for the
  	environment.
0e8d15866   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ENV ma...
3510
3511
  	- CONFIG_ENV_ADDR:
  	- CONFIG_ENV_SIZE:
c609719b8   wdenk   Initial revision
3512

11ccc33fa   Marcel Ziswiler   Many spelling fix...
3513
  	  These two #defines are used to determine the memory area you
c609719b8   wdenk   Initial revision
3514
3515
3516
3517
3518
  	  want to use for environment. It is assumed that this memory
  	  can just be read and written to, without any special
  	  provision.
  
  BE CAREFUL! The first access to the environment happens quite early
b445bbb49   Jeremiah Mahler   doc: fix grammati...
3519
  in U-Boot initialization (when we try to get the setting of for the
11ccc33fa   Marcel Ziswiler   Many spelling fix...
3520
  console baudrate). You *MUST* have mapped your NVRAM area then, or
c609719b8   wdenk   Initial revision
3521
3522
3523
3524
3525
3526
  U-Boot will hang.
  
  Please note that even with NVRAM we still use a copy of the
  environment in RAM: we could work on NVRAM directly, but we want to
  keep settings there always unmodified except somebody uses "saveenv"
  to save the current settings.
bb1f8b4f8   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ENV_IS...
3527
  - CONFIG_ENV_IS_IN_EEPROM:
c609719b8   wdenk   Initial revision
3528
3529
3530
  
  	Use this if you have an EEPROM or similar serial access
  	device and a driver for it.
0e8d15866   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ENV ma...
3531
3532
  	- CONFIG_ENV_OFFSET:
  	- CONFIG_ENV_SIZE:
c609719b8   wdenk   Initial revision
3533
3534
3535
  
  	  These two #defines specify the offset and size of the
  	  environment area within the total memory of your EEPROM.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3536
  	- CONFIG_SYS_I2C_EEPROM_ADDR:
c609719b8   wdenk   Initial revision
3537
3538
  	  If defined, specified the chip address of the EEPROM device.
  	  The default address is zero.
189d257b7   Christian Gmeiner   cmd_eeprom: make ...
3539
3540
  	- CONFIG_SYS_I2C_EEPROM_BUS:
  	  If defined, specified the i2c bus of the EEPROM device.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3541
  	- CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
c609719b8   wdenk   Initial revision
3542
3543
3544
  	  If defined, the number of bits used to address bytes in a
  	  single page in the EEPROM device.  A 64 byte page, for example
  	  would require six bits.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3545
  	- CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
c609719b8   wdenk   Initial revision
3546
  	  If defined, the number of milliseconds to delay between
ba56f6257   wdenk   Patch by Travis S...
3547
  	  page writes.	The default is zero milliseconds.
c609719b8   wdenk   Initial revision
3548

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3549
  	- CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
c609719b8   wdenk   Initial revision
3550
3551
  	  The length in bytes of the EEPROM memory array address.  Note
  	  that this is NOT the chip address length!
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3552
  	- CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
5cf91d6bd   wdenk   * Modify KUP4X bo...
3553
3554
3555
3556
3557
3558
3559
3560
3561
  	  EEPROM chips that implement "address overflow" are ones
  	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
  	  address and the extra bits end up in the "chip address" bit
  	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
  	  byte chips.
  
  	  Note that we consider the length of the address field to
  	  still be one byte because the extra address bits are hidden
  	  in the chip address.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3562
  	- CONFIG_SYS_EEPROM_SIZE:
c609719b8   wdenk   Initial revision
3563
  	  The size in bytes of the EEPROM device.
548738b4d   Heiko Schocher   cmd_eeprom: I2C u...
3564
3565
3566
3567
3568
3569
3570
3571
  	- CONFIG_ENV_EEPROM_IS_ON_I2C
  	  define this, if you have I2C and SPI activated, and your
  	  EEPROM, which holds the environment, is on the I2C bus.
  
  	- CONFIG_I2C_ENV_EEPROM_BUS
  	  if you have an Environment on an EEPROM reached over
  	  I2C muxes, you can define here, how to reach this
  	  EEPROM. For example:
ea818dbbc   Heiko Schocher   i2c, soft-i2c: sw...
3572
  	  #define CONFIG_I2C_ENV_EEPROM_BUS	  1
548738b4d   Heiko Schocher   cmd_eeprom: I2C u...
3573
3574
3575
  
  	  EEPROM which holds the environment, is reached over
  	  a pca9547 i2c mux with address 0x70, channel 3.
c609719b8   wdenk   Initial revision
3576

057c849c4   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ENV_IS...
3577
  - CONFIG_ENV_IS_IN_DATAFLASH:
5779d8d98   wdenk   * Patch by Nicola...
3578

d4ca31c40   wdenk   * Cleanup lowboot...
3579
  	Define this if you have a DataFlash memory device which you
5779d8d98   wdenk   * Patch by Nicola...
3580
  	want to use for the environment.
0e8d15866   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ENV ma...
3581
3582
3583
  	- CONFIG_ENV_OFFSET:
  	- CONFIG_ENV_ADDR:
  	- CONFIG_ENV_SIZE:
5779d8d98   wdenk   * Patch by Nicola...
3584
3585
3586
3587
  
  	  These three #defines specify the offset and size of the
  	  environment area within the total memory of your DataFlash placed
  	  at the specified address.
bd83b5921   Wu, Josh   README: document ...
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
  - CONFIG_ENV_IS_IN_SPI_FLASH:
  
  	Define this if you have a SPI Flash memory device which you
  	want to use for the environment.
  
  	- CONFIG_ENV_OFFSET:
  	- CONFIG_ENV_SIZE:
  
  	  These two #defines specify the offset and size of the
  	  environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
  	  aligned to an erase sector boundary.
  
  	- CONFIG_ENV_SECT_SIZE:
  
  	  Define the SPI flash's sector size.
  
  	- CONFIG_ENV_OFFSET_REDUND (optional):
  
  	  This setting describes a second storage area of CONFIG_ENV_SIZE
  	  size used to hold a redundant copy of the environment data, so
  	  that there is a valid backup copy in case there is a power failure
9dd05fb8c   Simon Glass   README: Correct C...
3609
  	  during a "saveenv" operation. CONFIG_ENV_OFFSET_REDUND must be
bd83b5921   Wu, Josh   README: document ...
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
  	  aligned to an erase sector boundary.
  
  	- CONFIG_ENV_SPI_BUS (optional):
  	- CONFIG_ENV_SPI_CS (optional):
  
  	  Define the SPI bus and chip select. If not defined they will be 0.
  
  	- CONFIG_ENV_SPI_MAX_HZ (optional):
  
  	  Define the SPI max work clock. If not defined then use 1MHz.
  
  	- CONFIG_ENV_SPI_MODE (optional):
  
  	  Define the SPI work mode. If not defined then use SPI_MODE_3.
0a85a9e70   Liu Gang   powerpc/corenet_d...
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
  - CONFIG_ENV_IS_IN_REMOTE:
  
  	Define this if you have a remote memory space which you
  	want to use for the local device's environment.
  
  	- CONFIG_ENV_ADDR:
  	- CONFIG_ENV_SIZE:
  
  	  These two #defines specify the address and size of the
  	  environment area within the remote memory space. The
  	  local device can get the environment from remote memory
fc54c7fa0   Liu Gang   powerpc/corenet_d...
3635
  	  space by SRIO or PCIE links.
0a85a9e70   Liu Gang   powerpc/corenet_d...
3636
3637
3638
  
  BE CAREFUL! For some special cases, the local device can not use
  "saveenv" command. For example, the local device will get the
fc54c7fa0   Liu Gang   powerpc/corenet_d...
3639
3640
  environment stored in a remote NOR flash by SRIO or PCIE link,
  but it can not erase, write this NOR flash by SRIO or PCIE interface.
0a85a9e70   Liu Gang   powerpc/corenet_d...
3641

51bfee192   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ENV_IS...
3642
  - CONFIG_ENV_IS_IN_NAND:
13a5695b7   wdenk   Patch by Jian Zha...
3643
3644
3645
  
  	Define this if you have a NAND device which you want to use
  	for the environment.
0e8d15866   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ENV ma...
3646
3647
  	- CONFIG_ENV_OFFSET:
  	- CONFIG_ENV_SIZE:
13a5695b7   wdenk   Patch by Jian Zha...
3648
3649
  
  	  These two #defines specify the offset and size of the environment
fdd813def   Scott Wood   README: Add new N...
3650
3651
  	  area within the first NAND device.  CONFIG_ENV_OFFSET must be
  	  aligned to an erase block boundary.
5779d8d98   wdenk   * Patch by Nicola...
3652

fdd813def   Scott Wood   README: Add new N...
3653
  	- CONFIG_ENV_OFFSET_REDUND (optional):
e443c944c   Markus Klotzbuecher   Support for redun...
3654

0e8d15866   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ENV ma...
3655
  	  This setting describes a second storage area of CONFIG_ENV_SIZE
fdd813def   Scott Wood   README: Add new N...
3656
3657
  	  size used to hold a redundant copy of the environment data, so
  	  that there is a valid backup copy in case there is a power failure
9dd05fb8c   Simon Glass   README: Correct C...
3658
  	  during a "saveenv" operation.	 CONFIG_ENV_OFFSET_REDUND must be
fdd813def   Scott Wood   README: Add new N...
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
  	  aligned to an erase block boundary.
  
  	- CONFIG_ENV_RANGE (optional):
  
  	  Specifies the length of the region in which the environment
  	  can be written.  This should be a multiple of the NAND device's
  	  block size.  Specifying a range with more erase blocks than
  	  are needed to hold CONFIG_ENV_SIZE allows bad blocks within
  	  the range to be avoided.
  
  	- CONFIG_ENV_OFFSET_OOB (optional):
  
  	  Enables support for dynamically retrieving the offset of the
  	  environment from block zero's out-of-band data.  The
  	  "nand env.oob" command can be used to record this offset.
  	  Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
  	  using CONFIG_ENV_OFFSET_OOB.
e443c944c   Markus Klotzbuecher   Support for redun...
3676

b74ab7373   Guennadi Liakhovetski   nand_spl: read en...
3677
3678
3679
3680
3681
  - CONFIG_NAND_ENV_DST
  
  	Defines address in RAM to which the nand_spl code should copy the
  	environment. If redundant environment is used, it will be copied to
  	CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
2b74433f3   Joe Hershberger   env: Add support ...
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
  - CONFIG_ENV_IS_IN_UBI:
  
  	Define this if you have an UBI volume that you want to use for the
  	environment.  This has the benefit of wear-leveling the environment
  	accesses, which is important on NAND.
  
  	- CONFIG_ENV_UBI_PART:
  
  	  Define this to a string that is the mtd partition containing the UBI.
  
  	- CONFIG_ENV_UBI_VOLUME:
  
  	  Define this to the name of the volume that you want to store the
  	  environment in.
785881f77   Joe Hershberger   env: Add redundan...
3696
3697
3698
3699
3700
  	- CONFIG_ENV_UBI_VOLUME_REDUND:
  
  	  Define this to the name of another volume to store a second copy of
  	  the environment in.  This will enable redundant environments in UBI.
  	  It is assumed that both volumes are in the same MTD partition.
2b74433f3   Joe Hershberger   env: Add support ...
3701
3702
3703
3704
3705
  	- CONFIG_UBI_SILENCE_MSG
  	- CONFIG_UBIFS_SILENCE_MSG
  
  	  You will probably want to define these to avoid a really noisy system
  	  when storing the env in UBI.
d1db76f14   Wu, Josh   README: document ...
3706
3707
3708
3709
3710
3711
  - CONFIG_ENV_IS_IN_FAT:
         Define this if you want to use the FAT file system for the environment.
  
         - FAT_ENV_INTERFACE:
  
           Define this to a string that is the name of the block device.
419877846   Nicolae Rosia   README: fix typo ...
3712
         - FAT_ENV_DEVICE_AND_PART:
d1db76f14   Wu, Josh   README: document ...
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
  
           Define this to a string to specify the partition of the device. It can
           be as following:
  
             "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
                 - "D:P": device D partition P. Error occurs if device D has no
                          partition table.
                 - "D:0": device D.
                 - "D" or "D:": device D partition 1 if device D has partition
                                table, or the whole device D if has no partition
                                table.
                 - "D:auto": first partition in device D with bootable flag set.
b445bbb49   Jeremiah Mahler   doc: fix grammati...
3725
                             If none, first valid partition in device D. If no
d1db76f14   Wu, Josh   README: document ...
3726
3727
3728
3729
3730
                             partition table then means device D.
  
         - FAT_ENV_FILE:
  
           It's a string of the FAT file name. This file use to store the
b445bbb49   Jeremiah Mahler   doc: fix grammati...
3731
           environment.
d1db76f14   Wu, Josh   README: document ...
3732
3733
  
         - CONFIG_FAT_WRITE:
b445bbb49   Jeremiah Mahler   doc: fix grammati...
3734
           This should be defined. Otherwise it cannot save the environment file.
d1db76f14   Wu, Josh   README: document ...
3735

06e4ae5f8   Stephen Warren   README: document ...
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
  - CONFIG_ENV_IS_IN_MMC:
  
  	Define this if you have an MMC device which you want to use for the
  	environment.
  
  	- CONFIG_SYS_MMC_ENV_DEV:
  
  	  Specifies which MMC device the environment is stored in.
  
  	- CONFIG_SYS_MMC_ENV_PART (optional):
  
  	  Specifies which MMC partition the environment is stored in. If not
  	  set, defaults to partition 0, the user area. Common values might be
  	  1 (first MMC boot partition), 2 (second MMC boot partition).
  
  	- CONFIG_ENV_OFFSET:
  	- CONFIG_ENV_SIZE:
  
  	  These two #defines specify the offset and size of the environment
  	  area within the specified MMC device.
5c088ee84   Stephen Warren   env_mmc: allow ne...
3756
3757
3758
3759
3760
3761
3762
  	  If offset is positive (the usual case), it is treated as relative to
  	  the start of the MMC partition. If offset is negative, it is treated
  	  as relative to the end of the MMC partition. This can be useful if
  	  your board may be fitted with different MMC devices, which have
  	  different sizes for the MMC partitions, and you always want the
  	  environment placed at the very end of the partition, to leave the
  	  maximum possible space before it, to store other data.
06e4ae5f8   Stephen Warren   README: document ...
3763
3764
3765
3766
3767
3768
3769
3770
3771
  	  These two values are in units of bytes, but must be aligned to an
  	  MMC sector boundary.
  
  	- CONFIG_ENV_OFFSET_REDUND (optional):
  
  	  Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
  	  hold a redundant copy of the environment data. This provides a
  	  valid backup copy in case the other copy is corrupted, e.g. due
  	  to a power failure during a "saveenv" operation.
5c088ee84   Stephen Warren   env_mmc: allow ne...
3772
3773
  	  This value may also be positive or negative; this is handled in the
  	  same way as CONFIG_ENV_OFFSET.
06e4ae5f8   Stephen Warren   README: document ...
3774
3775
3776
3777
3778
3779
3780
3781
  	  This value is also in units of bytes, but must also be aligned to
  	  an MMC sector boundary.
  
  	- CONFIG_ENV_SIZE_REDUND (optional):
  
  	  This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
  	  set. If this value is set, it must be set to the same value as
  	  CONFIG_ENV_SIZE.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3782
  - CONFIG_SYS_SPI_INIT_OFFSET
c609719b8   wdenk   Initial revision
3783
3784
3785
3786
3787
3788
3789
3790
  
  	Defines offset to the initial SPI buffer area in DPRAM. The
  	area is used at an early stage (ROM part) if the environment
  	is configured to reside in the SPI EEPROM: We need a 520 byte
  	scratch DPRAM area. It is used between the two initialization
  	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
  	to be a good choice since it makes it far enough from the
  	start of the data area as well as from the stack pointer.
e881cb563   Bruce Adler   fix wording in RE...
3791
  Please note that the environment is read-only until the monitor
c609719b8   wdenk   Initial revision
3792
  has been relocated to RAM and a RAM copy of the environment has been
cdb749778   Wolfgang Denk   Rename getenv_r()...
3793
  created; also, when using EEPROM you will have to use getenv_f()
c609719b8   wdenk   Initial revision
3794
  until then to read environment variables.
85ec0bcc1   wdenk   * Patch by Arun D...
3795
3796
3797
3798
3799
3800
  The environment is protected by a CRC32 checksum. Before the monitor
  is relocated into RAM, as a result of a bad CRC you will be working
  with the compiled-in default environment - *silently*!!! [This is
  necessary, because the first environment variable we need is the
  "baudrate" setting for the console - if we have a bad CRC, we don't
  have any device yet where we could complain.]
c609719b8   wdenk   Initial revision
3801
3802
3803
  
  Note: once the monitor has been relocated, then it will complain if
  the default environment is used; a new CRC is computed as soon as you
85ec0bcc1   wdenk   * Patch by Arun D...
3804
  use the "saveenv" command to store a valid environment.
c609719b8   wdenk   Initial revision
3805

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3806
  - CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
42d1f0394   wdenk   * Patches by Xian...
3807
  		Echo the inverted Ethernet link state to the fault LED.
fc3e2165e   wdenk   * Patch by Sangmo...
3808

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3809
  		Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
fc3e2165e   wdenk   * Patch by Sangmo...
3810
  		      also needs to be defined.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3811
  - CONFIG_SYS_FAULT_MII_ADDR:
42d1f0394   wdenk   * Patches by Xian...
3812
  		MII address of the PHY to check for the Ethernet link state.
c609719b8   wdenk   Initial revision
3813

f5675aa5c   Ron Madrid   Create configurat...
3814
3815
3816
3817
3818
3819
  - CONFIG_NS16550_MIN_FUNCTIONS:
  		Define this if you desire to only have use of the NS16550_init
  		and NS16550_putc functions for the serial driver located at
  		drivers/serial/ns16550.c.  This option is useful for saving
  		space for already greatly restricted images, including but not
  		limited to NAND_SPL configurations.
b2b92f531   Simon Glass   Document the CONF...
3820
3821
3822
3823
  - CONFIG_DISPLAY_BOARDINFO
  		Display information about the board that U-Boot is running on
  		when U-Boot starts up. The board function checkboard() is called
  		to do this.
e2e3e2b1b   Simon Glass   arm: Add CONFIG_D...
3824
3825
3826
3827
  - CONFIG_DISPLAY_BOARDINFO_LATE
  		Similar to the previous option, but display this information
  		later, once stdio is running and output goes to the LCD, if
  		present.
feb858012   Sascha Silbe   README: document ...
3828
3829
3830
3831
  - CONFIG_BOARD_SIZE_LIMIT:
  		Maximum size of the U-Boot image. When defined, the
  		build system checks that the actual size does not
  		exceed it.
c609719b8   wdenk   Initial revision
3832
  Low Level (hardware related) configuration options:
dc7c9a1a5   wdenk   * Patch by Rick B...
3833
  ---------------------------------------------------
c609719b8   wdenk   Initial revision
3834

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3835
  - CONFIG_SYS_CACHELINE_SIZE:
c609719b8   wdenk   Initial revision
3836
  		Cache Line Size of the CPU.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3837
  - CONFIG_SYS_DEFAULT_IMMR:
c609719b8   wdenk   Initial revision
3838
  		Default address of the IMMR after system reset.
2535d6027   wdenk   * Patch by Martin...
3839

42d1f0394   wdenk   * Patches by Xian...
3840
3841
3842
  		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
  		and RPXsuper) to be able to adjust the position of
  		the IMMR register after a reset.
c609719b8   wdenk   Initial revision
3843

e46fedfeb   Timur Tabi   powerpc/85xx: int...
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
  - CONFIG_SYS_CCSRBAR_DEFAULT:
  		Default (power-on reset) physical address of CCSR on Freescale
  		PowerPC SOCs.
  
  - CONFIG_SYS_CCSRBAR:
  		Virtual address of CCSR.  On a 32-bit build, this is typically
  		the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
  
  		CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
  		for cross-platform code that uses that macro instead.
  
  - CONFIG_SYS_CCSRBAR_PHYS:
  		Physical address of CCSR.  CCSR can be relocated to a new
  		physical address, if desired.  In this case, this macro should
c0f40859f   Wolfgang Denk   README: white-spa...
3858
  		be set to that address.	 Otherwise, it should be set to the
e46fedfeb   Timur Tabi   powerpc/85xx: int...
3859
3860
3861
3862
3863
3864
3865
3866
  		same value as CONFIG_SYS_CCSRBAR_DEFAULT.  For example, CCSR
  		is typically relocated on 36-bit builds.  It is recommended
  		that this macro be defined via the _HIGH and _LOW macros:
  
  		#define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
  			* 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
  
  - CONFIG_SYS_CCSRBAR_PHYS_HIGH:
4cf2609b0   Wolfgang Denk   README: fix docum...
3867
3868
  		Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS.	This value is typically
  		either 0 (32-bit build) or 0xF (36-bit build).	This macro is
e46fedfeb   Timur Tabi   powerpc/85xx: int...
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
  		used in assembly code, so it must not contain typecasts or
  		integer size suffixes (e.g. "ULL").
  
  - CONFIG_SYS_CCSRBAR_PHYS_LOW:
  		Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS.  This macro is
  		used in assembly code, so it must not contain typecasts or
  		integer size suffixes (e.g. "ULL").
  
  - CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
  		If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
  		forced to a value that ensures that CCSR is not relocated.
7f6c2cbc2   wdenk   * Vince Husovsky,...
3880
  - Floppy Disk Support:
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3881
  		CONFIG_SYS_FDC_DRIVE_NUMBER
7f6c2cbc2   wdenk   * Vince Husovsky,...
3882
3883
  
  		the default drive number (default value 0)
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3884
  		CONFIG_SYS_ISA_IO_STRIDE
7f6c2cbc2   wdenk   * Vince Husovsky,...
3885

11ccc33fa   Marcel Ziswiler   Many spelling fix...
3886
  		defines the spacing between FDC chipset registers
7f6c2cbc2   wdenk   * Vince Husovsky,...
3887
  		(default value 1)
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3888
  		CONFIG_SYS_ISA_IO_OFFSET
7f6c2cbc2   wdenk   * Vince Husovsky,...
3889

43d9616cf   wdenk   * Patch by Robert...
3890
3891
  		defines the offset of register from address. It
  		depends on which part of the data bus is connected to
11ccc33fa   Marcel Ziswiler   Many spelling fix...
3892
  		the FDC chipset. (default value 0)
7f6c2cbc2   wdenk   * Vince Husovsky,...
3893

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3894
3895
  		If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
  		CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
43d9616cf   wdenk   * Patch by Robert...
3896
  		default value.
7f6c2cbc2   wdenk   * Vince Husovsky,...
3897

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3898
  		if CONFIG_SYS_FDC_HW_INIT is defined, then the function
43d9616cf   wdenk   * Patch by Robert...
3899
3900
  		fdc_hw_init() is called at the beginning of the FDC
  		setup. fdc_hw_init() must be provided by the board
b445bbb49   Jeremiah Mahler   doc: fix grammati...
3901
  		source code. It is used to make hardware-dependent
43d9616cf   wdenk   * Patch by Robert...
3902
  		initializations.
7f6c2cbc2   wdenk   * Vince Husovsky,...
3903

0abddf82d   Macpaul Lin   cmd_ide: enhance ...
3904
3905
3906
3907
3908
3909
  - CONFIG_IDE_AHB:
  		Most IDE controllers were designed to be connected with PCI
  		interface. Only few of them were designed for AHB interface.
  		When software is doing ATA command and data transfer to
  		IDE devices through IDE-AHB controller, some additional
  		registers accessing to these kind of IDE-AHB controller
b445bbb49   Jeremiah Mahler   doc: fix grammati...
3910
  		is required.
0abddf82d   Macpaul Lin   cmd_ide: enhance ...
3911

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3912
  - CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
efe2a4d5c   wdenk   Code cleanup.
3913
  		DO NOT CHANGE unless you know exactly what you're
25d6712a8   wdenk   * Clean up CMC PU...
3914
  		doing! (11-4) [MPC8xx/82xx systems only]
c609719b8   wdenk   Initial revision
3915

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3916
  - CONFIG_SYS_INIT_RAM_ADDR:
c609719b8   wdenk   Initial revision
3917

7152b1d0b   wdenk   * Add support for...
3918
  		Start address of memory area that can be used for
c609719b8   wdenk   Initial revision
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
  		initial data and stack; please note that this must be
  		writable memory that is working WITHOUT special
  		initialization, i. e. you CANNOT use normal RAM which
  		will become available only after programming the
  		memory controller and running certain initialization
  		sequences.
  
  		U-Boot uses the following memory types:
  		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
  		- MPC824X: data cache
  		- PPC4xx:  data cache
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3930
  - CONFIG_SYS_GBL_DATA_OFFSET:
c609719b8   wdenk   Initial revision
3931
3932
  
  		Offset of the initial data structure in the memory
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3933
3934
  		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
  		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
c609719b8   wdenk   Initial revision
3935
  		data is located at the end of the available space
553f09823   Wolfgang Denk   Rename CONFIG_SYS...
3936
  		(sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
acd51f9d9   Simon Glass   README: Drop CONF...
3937
  		GENERATED_GBL_DATA_SIZE), and the initial stack is just
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3938
3939
  		below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
  		CONFIG_SYS_GBL_DATA_OFFSET) downward.
c609719b8   wdenk   Initial revision
3940
3941
3942
3943
  
  	Note:
  		On the MPC824X (or other systems that use the data
  		cache for initial memory) the address chosen for
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3944
  		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
c609719b8   wdenk   Initial revision
3945
3946
  		point to an otherwise UNUSED address space between
  		the top of RAM and the start of the PCI space.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3947
  - CONFIG_SYS_SIUMCR:	SIU Module Configuration (11-6)
c609719b8   wdenk   Initial revision
3948

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3949
  - CONFIG_SYS_SYPCR:	System Protection Control (11-9)
c609719b8   wdenk   Initial revision
3950

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3951
  - CONFIG_SYS_TBSCR:	Time Base Status and Control (11-26)
c609719b8   wdenk   Initial revision
3952

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3953
  - CONFIG_SYS_PISCR:	Periodic Interrupt Status and Control (11-31)
c609719b8   wdenk   Initial revision
3954

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3955
  - CONFIG_SYS_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
c609719b8   wdenk   Initial revision
3956

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3957
  - CONFIG_SYS_SCCR:	System Clock and reset Control Register (15-27)
c609719b8   wdenk   Initial revision
3958

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3959
  - CONFIG_SYS_OR_TIMING_SDRAM:
c609719b8   wdenk   Initial revision
3960
  		SDRAM timing
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3961
  - CONFIG_SYS_MAMR_PTA:
c609719b8   wdenk   Initial revision
3962
  		periodic timer for refresh
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3963
  - CONFIG_SYS_DER:	Debug Event Register (37-47)
c609719b8   wdenk   Initial revision
3964

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3965
3966
3967
3968
  - FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
    CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
    CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
    CONFIG_SYS_BR1_PRELIM:
c609719b8   wdenk   Initial revision
3969
3970
3971
  		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
  
  - SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3972
3973
    CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
    CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
c609719b8   wdenk   Initial revision
3974
  		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3975
3976
  - CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
    CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
c609719b8   wdenk   Initial revision
3977
3978
  		Machine Mode Register and Memory Periodic Timer
  		Prescaler definitions (SDRAM timing)
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3979
  - CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
c609719b8   wdenk   Initial revision
3980
3981
  		enable I2C microcode relocation patch (MPC8xx);
  		define relocation offset in DPRAM [DSP2]
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3982
  - CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
b423d055c   Heiko Schocher   Enable SMC microc...
3983
3984
  		enable SMC microcode relocation patch (MPC8xx);
  		define relocation offset in DPRAM [SMC1]
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3985
  - CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
c609719b8   wdenk   Initial revision
3986
3987
  		enable SPI microcode relocation patch (MPC8xx);
  		define relocation offset in DPRAM [SCC4]
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3988
  - CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
43d9616cf   wdenk   * Patch by Robert...
3989
3990
3991
3992
  		Offset of the bootmode word in DPRAM used by post
  		(Power On Self Tests). This definition overrides
  		#define'd default value in commproc.h resp.
  		cpm_8260.h.
ea909b760   wdenk   * Added support f...
3993

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3994
3995
3996
3997
3998
3999
4000
4001
  - CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
    CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
    CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
    CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
    CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
    CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
    CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
    CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
a47a12bec   Stefan Roese   Move arch/ppc to ...
4002
  		Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
5d232d0e7   wdenk   * Patch by Dave E...
4003

9cacf4fc4   Dirk Eibach   ppc4xx: Add READM...
4004
4005
4006
  - CONFIG_PCI_DISABLE_PCIE:
  		Disable PCI-Express on systems where it is supported but not
  		required.
69fd2d3b0   Andrew Sharp   pci: add CONFIG_P...
4007
  - CONFIG_PCI_ENUM_ONLY
b445bbb49   Jeremiah Mahler   doc: fix grammati...
4008
  		Only scan through and get the devices on the buses.
69fd2d3b0   Andrew Sharp   pci: add CONFIG_P...
4009
4010
4011
4012
  		Don't do any setup work, presumably because someone or
  		something has already done it, and we don't need to do it
  		a second time.	Useful for platforms that are pre-booted
  		by coreboot or similar.
842033e69   Gabor Juhos   pci: introduce CO...
4013
4014
  - CONFIG_PCI_INDIRECT_BRIDGE:
  		Enable support for indirect PCI bridges.
a09b9b68d   Kumar Gala   powerpc/8xxx: Ref...
4015
4016
4017
4018
4019
4020
4021
4022
  - CONFIG_SYS_SRIO:
  		Chip has SRIO or not
  
  - CONFIG_SRIO1:
  		Board has SRIO 1 port available
  
  - CONFIG_SRIO2:
  		Board has SRIO 2 port available
c8b281524   Liu Gang   powerpc/boot: Cha...
4023
4024
  - CONFIG_SRIO_PCIE_BOOT_MASTER
  		Board can support master function for Boot from SRIO and PCIE
a09b9b68d   Kumar Gala   powerpc/8xxx: Ref...
4025
4026
4027
4028
4029
4030
4031
4032
  - CONFIG_SYS_SRIOn_MEM_VIRT:
  		Virtual Address of SRIO port 'n' memory region
  
  - CONFIG_SYS_SRIOn_MEM_PHYS:
  		Physical Address of SRIO port 'n' memory region
  
  - CONFIG_SYS_SRIOn_MEM_SIZE:
  		Size of SRIO port 'n' memory region
66bd1846e   Fabio Estevam   mtd: nand: Introd...
4033
4034
4035
4036
  - CONFIG_SYS_NAND_BUSWIDTH_16BIT
  		Defined to tell the NAND controller that the NAND chip is using
  		a 16 bit bus.
  		Not all NAND drivers use this symbol.
a430e9164   Fabio Estevam   mtd: nand: mxc_na...
4037
  		Example of drivers that use it:
66bd1846e   Fabio Estevam   mtd: nand: Introd...
4038
  		- drivers/mtd/nand/ndfc.c
a430e9164   Fabio Estevam   mtd: nand: mxc_na...
4039
  		- drivers/mtd/nand/mxc_nand.c
eced4626e   Alex Waterman   NAND: Add 16bit N...
4040
4041
4042
4043
  
  - CONFIG_SYS_NDFC_EBC0_CFG
  		Sets the EBC0_CFG register for the NDFC. If not defined
  		a default value will be used.
bb99ad6d8   Ben Warren   Add support for m...
4044
  - CONFIG_SPD_EEPROM
218ca724c   Wolfgang Denk   README: update do...
4045
4046
  		Get DDR timing information from an I2C EEPROM. Common
  		with pluggable memory modules such as SODIMMs
bb99ad6d8   Ben Warren   Add support for m...
4047
4048
    SPD_EEPROM_ADDRESS
  		I2C address of the SPD EEPROM
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
4049
  - CONFIG_SYS_SPD_BUS_NUM
218ca724c   Wolfgang Denk   README: update do...
4050
4051
4052
  		If SPD EEPROM is on an I2C bus other than the first
  		one, specify here. Note that the value must resolve
  		to something your driver can deal with.
bb99ad6d8   Ben Warren   Add support for m...
4053

1b3e3c4f2   York Sun   powerpc/mpc8xxx: ...
4054
4055
4056
4057
4058
  - CONFIG_SYS_DDR_RAW_TIMING
  		Get DDR timing information from other than SPD. Common with
  		soldered DDR chips onboard without SPD. DDR raw timing
  		parameters are extracted from datasheet and hard-coded into
  		header files or board specific files.
6f5e1dc53   York Sun   powerpc/8xxx: Add...
4059
4060
  - CONFIG_FSL_DDR_INTERACTIVE
  		Enable interactive DDR debugging. See doc/README.fsl-ddr.
e32d59a2f   York Sun   driver/ddr/fsl: A...
4061
4062
  - CONFIG_FSL_DDR_SYNC_REFRESH
  		Enable sync of refresh for multiple controllers.
4516ff816   York Sun   driver/ddr/fsl: A...
4063
4064
  - CONFIG_FSL_DDR_BIST
  		Enable built-in memory test for Freescale DDR controllers.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
4065
  - CONFIG_SYS_83XX_DDR_USES_CS0
218ca724c   Wolfgang Denk   README: update do...
4066
4067
  		Only for 83xx systems. If specified, then DDR should
  		be configured using CS0 and CS1 instead of CS2 and CS3.
2ad6b513b   Timur Tabi   mpc83xx: Add supp...
4068

c26e454df   wdenk   Patches by Pantel...
4069
4070
4071
4072
4073
  - CONFIG_ETHER_ON_FEC[12]
  		Define to enable FEC[12] on a 8xx series processor.
  
  - CONFIG_FEC[12]_PHY
  		Define to the hardcoded PHY address which corresponds
6e5923851   wdenk   * Cleanup, minor ...
4074
4075
  		to the given FEC; i. e.
  			#define CONFIG_FEC1_PHY 4
c26e454df   wdenk   Patches by Pantel...
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
  		means that the PHY with address 4 is connected to FEC1
  
  		When set to -1, means to probe for first available.
  
  - CONFIG_FEC[12]_PHY_NORXERR
  		The PHY does not have a RXERR line (RMII only).
  		(so program the FEC to ignore it).
  
  - CONFIG_RMII
  		Enable RMII mode for all FECs.
  		Note that this is a global option, we can't
  		have one FEC in standard MII mode and another in RMII mode.
5cf91d6bd   wdenk   * Modify KUP4X bo...
4088
4089
4090
4091
4092
4093
4094
4095
4096
  - CONFIG_CRC32_VERIFY
  		Add a verify option to the crc32 command.
  		The syntax is:
  
  		=> crc32 -v <address> <count> <crc32>
  
  		Where address/count indicate a memory area
  		and crc32 is the correct crc32 which the
  		area should have.
56523f128   wdenk   * Patch by Martin...
4097
4098
  - CONFIG_LOOPW
  		Add the "loopw" memory command. This only takes effect if
602ad3b33   Jon Loeliger   README: Rewrite c...
4099
  		the memory commands are activated globally (CONFIG_CMD_MEM).
56523f128   wdenk   * Patch by Martin...
4100

7b4666414   stroese   CONFIG_MX_CYCLIC ...
4101
4102
4103
4104
  - CONFIG_MX_CYCLIC
  		Add the "mdc" and "mwc" memory commands. These are cyclic
  		"md/mw" commands.
  		Examples:
efe2a4d5c   wdenk   Code cleanup.
4105
  		=> mdc.b 10 4 500
7b4666414   stroese   CONFIG_MX_CYCLIC ...
4106
  		This command will print 4 bytes (10,11,12,13) each 500 ms.
efe2a4d5c   wdenk   Code cleanup.
4107
  		=> mwc.l 100 12345678 10
7b4666414   stroese   CONFIG_MX_CYCLIC ...
4108
  		This command will write 12345678 to address 100 all 10 ms.
efe2a4d5c   wdenk   Code cleanup.
4109
  		This only takes effect if the memory commands are activated
602ad3b33   Jon Loeliger   README: Rewrite c...
4110
  		globally (CONFIG_CMD_MEM).
7b4666414   stroese   CONFIG_MX_CYCLIC ...
4111

8aa1a2d11   wdenk   Patch by Steven S...
4112
  - CONFIG_SKIP_LOWLEVEL_INIT
afc1ce828   Macpaul Lin   doc/README: docum...
4113
  		[ARM, NDS32, MIPS only] If this variable is defined, then certain
844f07d8a   Wolfgang Denk   Coding Style (whi...
4114
4115
4116
4117
4118
4119
4120
4121
  		low level initializations (like setting up the memory
  		controller) are omitted and/or U-Boot does not
  		relocate itself into RAM.
  
  		Normally this variable MUST NOT be defined. The only
  		exception is when U-Boot is loaded (to RAM) by some
  		other boot loader or by a debugger which performs
  		these initializations itself.
8aa1a2d11   wdenk   Patch by Steven S...
4122

b5bd09820   Simon Glass   arm: Allow skippi...
4123
4124
  - CONFIG_SKIP_LOWLEVEL_INIT_ONLY
  		[ARM926EJ-S only] This allows just the call to lowlevel_init()
90211f772   yeongjun Kim   fixing typo error...
4125
  		to be skipped. The normal CP15 init (such as enabling the
b5bd09820   Simon Glass   arm: Allow skippi...
4126
  		instruction cache) is still performed.
401bb30b6   Aneesh V   replace CONFIG_PR...
4127
  - CONFIG_SPL_BUILD
df81238b3   Magnus Lilja   ARM1136: Introduc...
4128
4129
4130
  		Modifies the behaviour of start.S when compiling a loader
  		that is executed before the actual U-Boot. E.g. when
  		compiling a NAND SPL.
400558b56   wdenk   Prepare for SoC r...
4131

3aa29de0b   Ying Zhang   TPL : introduce t...
4132
4133
4134
4135
  - CONFIG_TPL_BUILD
  		Modifies the behaviour of start.S  when compiling a loader
  		that is executed after the SPL and before the actual U-Boot.
  		It is loaded by the SPL.
5df572f01   Ying Zhang   powerpc/mpc85xx: ...
4136
4137
4138
4139
  - CONFIG_SYS_MPC85XX_NO_RESETVEC
  		Only for 85xx systems. If this variable is specified, the section
  		.resetvec is not kept and the section .bootpg is placed in the
  		previous 4k of the .text section.
4213fc291   Simon Glass   sandbox: Add un/m...
4140
4141
4142
4143
4144
4145
4146
4147
  - CONFIG_ARCH_MAP_SYSMEM
  		Generally U-Boot (and in particular the md command) uses
  		effective address. It is therefore not necessary to regard
  		U-Boot address as virtual addresses that need to be translated
  		to physical addresses. However, sandbox requires this, since
  		it maintains its own little RAM buffer which contains all
  		addressable memory. This option causes some memory accesses
  		to be mapped through map_sysmem() / unmap_sysmem().
588a13f74   Simon Glass   x86: Rename CONFI...
4148
4149
4150
  - CONFIG_X86_RESET_VECTOR
  		If defined, the x86 reset vector code is included. This is not
  		needed when U-Boot is running from Coreboot.
b16f521a5   Gabe Black   x86: Allow exclud...
4151

fc33705e6   Mark Jackson   Allow AM335x MPU ...
4152
4153
4154
4155
  - CONFIG_SYS_MPUCLK
  		Defines the MPU clock speed (in MHz).
  
  		NOTE : currently only supported on AM335x platforms.
5b5ece9ef   Gabe Black   x86: Allow compil...
4156

16678eb40   Heiko Schocher   arm, am33x: make ...
4157
4158
  - CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
  		Enables the RTC32K OSC on AM33xx based plattforms
999d7d326   Karicheri, Muralidharan   NAND: DaVinci: al...
4159
4160
4161
4162
  - CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
  		Option to disable subpage write in NAND driver
  		driver that uses this:
  		drivers/mtd/nand/davinci_nand.c
f2717b47e   Timur Tabi   powerpc/85xx: cle...
4163
4164
4165
4166
4167
4168
4169
4170
  Freescale QE/FMAN Firmware Support:
  -----------------------------------
  
  The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
  loading of "firmware", which is encoded in the QE firmware binary format.
  This firmware often needs to be loaded during U-Boot booting, so macros
  are used to identify the storage device (NOR flash, SPI, etc) and the address
  within that device.
dcf1d774b   Zhao Qiang   QE/FMAN: modify C...
4171
4172
4173
4174
4175
4176
4177
  - CONFIG_SYS_FMAN_FW_ADDR
  	The address in the storage device where the FMAN microcode is located.  The
  	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
  	is also specified.
  
  - CONFIG_SYS_QE_FW_ADDR
  	The address in the storage device where the QE microcode is located.  The
f2717b47e   Timur Tabi   powerpc/85xx: cle...
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
  	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
  	is also specified.
  
  - CONFIG_SYS_QE_FMAN_FW_LENGTH
  	The maximum possible size of the firmware.  The firmware binary format
  	has a field that specifies the actual size of the firmware, but it
  	might not be possible to read any part of the firmware unless some
  	local storage is allocated to hold the entire firmware first.
  
  - CONFIG_SYS_QE_FMAN_FW_IN_NOR
  	Specifies that QE/FMAN firmware is located in NOR flash, mapped as
  	normal addressable memory via the LBC.  CONFIG_SYS_FMAN_FW_ADDR is the
  	virtual address in NOR flash.
  
  - CONFIG_SYS_QE_FMAN_FW_IN_NAND
  	Specifies that QE/FMAN firmware is located in NAND flash.
  	CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
  
  - CONFIG_SYS_QE_FMAN_FW_IN_MMC
  	Specifies that QE/FMAN firmware is located on the primary SD/MMC
  	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
292dc6c50   Liu Gang   powerpc/corenet_d...
4199
4200
4201
  - CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
  	Specifies that QE/FMAN firmware is located in the remote (master)
  	memory space.	CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
fc54c7fa0   Liu Gang   powerpc/corenet_d...
4202
4203
4204
  	can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
  	window->master inbound window->master LAW->the ucode address in
  	master's memory space.
f2717b47e   Timur Tabi   powerpc/85xx: cle...
4205

b940ca64b   J. German Rivera   armv8/fsl-lsch3: ...
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
  Freescale Layerscape Management Complex Firmware Support:
  ---------------------------------------------------------
  The Freescale Layerscape Management Complex (MC) supports the loading of
  "firmware".
  This firmware often needs to be loaded during U-Boot booting, so macros
  are used to identify the storage device (NOR flash, SPI, etc) and the address
  within that device.
  
  - CONFIG_FSL_MC_ENET
  	Enable the MC driver for Layerscape SoCs.
5c0550897   Prabhakar Kushwaha   armv8/fsl-lsch3: ...
4216
4217
4218
4219
4220
  Freescale Layerscape Debug Server Support:
  -------------------------------------------
  The Freescale Layerscape Debug Server Support supports the loading of
  "Debug Server firmware" and triggering SP boot-rom.
  This firmware often needs to be loaded during U-Boot booting.
c04921414   York Sun   armv8: fsl-layers...
4221
4222
  - CONFIG_SYS_MC_RSV_MEM_ALIGN
  	Define alignment of reserved memory MC requires
5c0550897   Prabhakar Kushwaha   armv8/fsl-lsch3: ...
4223

f3f431a71   Paul Kocialkowski   Reproducible U-Bo...
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
  Reproducible builds
  -------------------
  
  In order to achieve reproducible builds, timestamps used in the U-Boot build
  process have to be set to a fixed value.
  
  This is done using the SOURCE_DATE_EPOCH environment variable.
  SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
  option for U-Boot or an environment variable in U-Boot.
  
  SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
c609719b8   wdenk   Initial revision
4235
4236
  Building the Software:
  ======================
218ca724c   Wolfgang Denk   README: update do...
4237
4238
4239
4240
4241
4242
  Building U-Boot has been tested in several native build environments
  and in many different cross environments. Of course we cannot support
  all possibly existing versions of cross development tools in all
  (potentially obsolete) versions. In case of tool chain problems we
  recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
  which is extensively used to build and test U-Boot.
c609719b8   wdenk   Initial revision
4243

218ca724c   Wolfgang Denk   README: update do...
4244
4245
4246
4247
4248
  If you are not using a native environment, it is assumed that you
  have GNU cross compiling tools available in your path. In this case,
  you must set the environment variable CROSS_COMPILE in your shell.
  Note that no changes to the Makefile or any other source files are
  necessary. For example using the ELDK on a 4xx CPU, please enter:
c609719b8   wdenk   Initial revision
4249

218ca724c   Wolfgang Denk   README: update do...
4250
4251
  	$ CROSS_COMPILE=ppc_4xx-
  	$ export CROSS_COMPILE
c609719b8   wdenk   Initial revision
4252

2f8d396b9   Peter Tyser   Add support for b...
4253
4254
4255
4256
4257
4258
4259
4260
4261
  Note: If you wish to generate Windows versions of the utilities in
        the tools directory you can use the MinGW toolchain
        (http://www.mingw.org).  Set your HOST tools to the MinGW
        toolchain and execute 'make tools'.  For example:
  
         $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
  
        Binaries such as tools/mkimage.exe will be created which can
        be executed on computers running Windows.
218ca724c   Wolfgang Denk   README: update do...
4262
4263
  U-Boot is intended to be simple to build. After installing the
  sources you must configure U-Boot for one specific board type. This
c609719b8   wdenk   Initial revision
4264
  is done by typing:
ab584d67c   Holger Freyther   The _config targe...
4265
  	make NAME_defconfig
c609719b8   wdenk   Initial revision
4266

ab584d67c   Holger Freyther   The _config targe...
4267
  where "NAME_defconfig" is the name of one of the existing configu-
4d675ae6e   Michael Jones   README: supported...
4268
  rations; see boards.cfg for supported names.
db01a2ea9   wdenk   * Patch by Stephe...
4269

2729af9d5   wdenk   * Fix minor NAND ...
4270
4271
4272
4273
  Note: for some board special configuration names may exist; check if
        additional information is available from the board vendor; for
        instance, the TQM823L systems are available without (standard)
        or with LCD support. You can select such additional "features"
11ccc33fa   Marcel Ziswiler   Many spelling fix...
4274
        when choosing the configuration, i. e.
2729af9d5   wdenk   * Fix minor NAND ...
4275

ab584d67c   Holger Freyther   The _config targe...
4276
        make TQM823L_defconfig
2729af9d5   wdenk   * Fix minor NAND ...
4277
  	- will configure for a plain TQM823L, i. e. no LCD support
ab584d67c   Holger Freyther   The _config targe...
4278
        make TQM823L_LCD_defconfig
2729af9d5   wdenk   * Fix minor NAND ...
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
  	- will configure for a TQM823L with U-Boot console on LCD
  
        etc.
  
  
  Finally, type "make all", and you should get some working U-Boot
  images ready for download to / installation on your system:
  
  - "u-boot.bin" is a raw binary image
  - "u-boot" is an image in ELF binary format
  - "u-boot.srec" is in Motorola S-Record format
baf312495   Marian Balakowicz   Add documentation...
4290
4291
4292
4293
4294
4295
4296
  By default the build is performed locally and the objects are saved
  in the source directory. One of the two methods can be used to change
  this behavior and build U-Boot to some external directory:
  
  1. Add O= to the make command line invocations:
  
  	make O=/tmp/build distclean
ab584d67c   Holger Freyther   The _config targe...
4297
  	make O=/tmp/build NAME_defconfig
baf312495   Marian Balakowicz   Add documentation...
4298
  	make O=/tmp/build all
adbba9960   Timo Ketola   doc: fix document...
4299
  2. Set environment variable KBUILD_OUTPUT to point to the desired location:
baf312495   Marian Balakowicz   Add documentation...
4300

adbba9960   Timo Ketola   doc: fix document...
4301
  	export KBUILD_OUTPUT=/tmp/build
baf312495   Marian Balakowicz   Add documentation...
4302
  	make distclean
ab584d67c   Holger Freyther   The _config targe...
4303
  	make NAME_defconfig
baf312495   Marian Balakowicz   Add documentation...
4304
  	make all
adbba9960   Timo Ketola   doc: fix document...
4305
  Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
baf312495   Marian Balakowicz   Add documentation...
4306
  variable.
2729af9d5   wdenk   * Fix minor NAND ...
4307
4308
4309
4310
4311
4312
4313
4314
4315
  
  Please be aware that the Makefiles assume you are using GNU make, so
  for instance on NetBSD you might need to use "gmake" instead of
  native "make".
  
  
  If the system board that you have is not listed, then you will need
  to port U-Boot to your hardware platform. To do this, follow these
  steps:
3c1496cd4   Phil Sutter   README: Review th...
4316
  1.  Create a new directory to hold your board specific code. Add any
2729af9d5   wdenk   * Fix minor NAND ...
4317
      files you need. In your board directory, you will need at least
3c1496cd4   Phil Sutter   README: Review th...
4318
4319
4320
      the "Makefile" and a "<board>.c".
  2.  Create a new configuration file "include/configs/<board>.h" for
      your board.
2729af9d5   wdenk   * Fix minor NAND ...
4321
4322
  3.  If you're porting U-Boot to a new CPU, then also create a new
      directory to hold your CPU specific code. Add any files you need.
ab584d67c   Holger Freyther   The _config targe...
4323
  4.  Run "make <board>_defconfig" with your new name.
2729af9d5   wdenk   * Fix minor NAND ...
4324
4325
4326
4327
4328
4329
4330
4331
  5.  Type "make", and you should get a working "u-boot.srec" file
      to be installed on your target system.
  6.  Debug and solve any problems that might arise.
      [Of course, this last step is much harder than it sounds.]
  
  
  Testing of U-Boot Modifications, Ports to New Hardware, etc.:
  ==============================================================
218ca724c   Wolfgang Denk   README: update do...
4332
4333
  If you have modified U-Boot sources (for instance added a new board
  or support for new devices, a new CPU, etc.) you are expected to
2729af9d5   wdenk   * Fix minor NAND ...
4334
4335
  provide feedback to the other developers. The feedback normally takes
  the form of a "patch", i. e. a context diff against a certain (latest
218ca724c   Wolfgang Denk   README: update do...
4336
  official or latest in the git repository) version of U-Boot sources.
2729af9d5   wdenk   * Fix minor NAND ...
4337

218ca724c   Wolfgang Denk   README: update do...
4338
4339
  But before you submit such a patch, please verify that your modifi-
  cation did not break existing code. At least make sure that *ALL* of
2729af9d5   wdenk   * Fix minor NAND ...
4340
  the supported boards compile WITHOUT ANY compiler warnings. To do so,
6de80f219   Simon Glass   Drop references t...
4341
4342
4343
4344
  just run the buildman script (tools/buildman/buildman), which will
  configure and build U-Boot for ALL supported system. Be warned, this
  will take a while. Please see the buildman README, or run 'buildman -H'
  for documentation.
baf312495   Marian Balakowicz   Add documentation...
4345

2729af9d5   wdenk   * Fix minor NAND ...
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
  See also "U-Boot Porting Guide" below.
  
  
  Monitor Commands - Overview:
  ============================
  
  go	- start application at address 'addr'
  run	- run commands in an environment variable
  bootm	- boot application image from memory
  bootp	- boot image via network using BootP/TFTP protocol
44f074c77   Marek Vasut   BOOT: Add "bootz"...
4356
  bootz   - boot zImage from memory
2729af9d5   wdenk   * Fix minor NAND ...
4357
4358
4359
  tftpboot- boot image via network using TFTP protocol
  	       and env variables "ipaddr" and "serverip"
  	       (and eventually "gatewayip")
1fb7cd498   Simon Glass   net: tftpput: imp...
4360
  tftpput - upload a file via network using TFTP protocol
2729af9d5   wdenk   * Fix minor NAND ...
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
  rarpboot- boot image via network using RARP/TFTP protocol
  diskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
  loads	- load S-Record file over serial line
  loadb	- load binary file over serial line (kermit mode)
  md	- memory display
  mm	- memory modify (auto-incrementing)
  nm	- memory modify (constant address)
  mw	- memory write (fill)
  cp	- memory copy
  cmp	- memory compare
  crc32	- checksum calculation
0f89c54be   Peter Tyser   i2c: Update refer...
4372
  i2c	- I2C sub-system
2729af9d5   wdenk   * Fix minor NAND ...
4373
4374
4375
4376
4377
4378
4379
4380
  sspi	- SPI utility commands
  base	- print or set address offset
  printenv- print environment variables
  setenv	- set environment variables
  saveenv - save environment variables to persistent storage
  protect - enable or disable FLASH write protection
  erase	- erase FLASH memory
  flinfo	- print FLASH memory information
10635afa5   Karl O. Pinc   README: Reference...
4381
  nand	- NAND memory operations (see doc/README.nand)
2729af9d5   wdenk   * Fix minor NAND ...
4382
4383
4384
4385
4386
  bdinfo	- print Board Info structure
  iminfo	- print header information for application image
  coninfo - print console devices and informations
  ide	- IDE sub-system
  loop	- infinite loop on address range
56523f128   wdenk   * Patch by Martin...
4387
  loopw	- infinite write loop on address range
2729af9d5   wdenk   * Fix minor NAND ...
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
  mtest	- simple RAM test
  icache	- enable or disable instruction cache
  dcache	- enable or disable data cache
  reset	- Perform RESET of the CPU
  echo	- echo args to console
  version - print monitor version
  help	- print online help
  ?	- alias for 'help'
  
  
  Monitor Commands - Detailed Description:
  ========================================
  
  TODO.
  
  For now: just type "help <command>".
  
  
  Environment Variables:
  ======================
  
  U-Boot supports user configuration using Environment Variables which
  can be made persistent by saving to Flash memory.
c609719b8   wdenk   Initial revision
4411

2729af9d5   wdenk   * Fix minor NAND ...
4412
4413
4414
4415
4416
4417
  Environment Variables are set using "setenv", printed using
  "printenv", and saved to Flash using "saveenv". Using "setenv"
  without a value can be used to delete a variable from the
  environment. As long as you don't save the environment you are
  working with an in-memory copy. In case the Flash area containing the
  environment is erased by accident, a default environment is provided.
c609719b8   wdenk   Initial revision
4418

c96f86eef   Wolfgang Denk   TFTP: allow for a...
4419
4420
4421
  Some configuration options can be set using Environment Variables.
  
  List of environment variables (most likely not complete):
c609719b8   wdenk   Initial revision
4422

2729af9d5   wdenk   * Fix minor NAND ...
4423
    baudrate	- see CONFIG_BAUDRATE
c609719b8   wdenk   Initial revision
4424

2729af9d5   wdenk   * Fix minor NAND ...
4425
    bootdelay	- see CONFIG_BOOTDELAY
c609719b8   wdenk   Initial revision
4426

2729af9d5   wdenk   * Fix minor NAND ...
4427
    bootcmd	- see CONFIG_BOOTCOMMAND
4a6fd34b2   wdenk   * Patch by Lutz D...
4428

2729af9d5   wdenk   * Fix minor NAND ...
4429
    bootargs	- Boot arguments when booting an RTOS image
c609719b8   wdenk   Initial revision
4430

2729af9d5   wdenk   * Fix minor NAND ...
4431
    bootfile	- Name of the image to load with TFTP
c609719b8   wdenk   Initial revision
4432

7d721e34a   Bartlomiej Sieka   Boot-related docu...
4433
4434
4435
4436
4437
4438
    bootm_low	- Memory range available for image processing in the bootm
  		  command can be restricted. This variable is given as
  		  a hexadecimal number and defines lowest address allowed
  		  for use by the bootm command. See also "bootm_size"
  		  environment variable. Address defined by "bootm_low" is
  		  also the base of the initial memory mapping for the Linux
c3624e6ed   Grant Likely   Default to bootm_...
4439
4440
  		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
  		  bootm_mapsize.
c0f40859f   Wolfgang Denk   README: white-spa...
4441
    bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
c3624e6ed   Grant Likely   Default to bootm_...
4442
4443
4444
4445
4446
4447
  		  This variable is given as a hexadecimal number and it
  		  defines the size of the memory region starting at base
  		  address bootm_low that is accessible by the Linux kernel
  		  during early boot.  If unset, CONFIG_SYS_BOOTMAPSZ is used
  		  as the default value if it is defined, and bootm_size is
  		  used otherwise.
7d721e34a   Bartlomiej Sieka   Boot-related docu...
4448
4449
4450
4451
4452
4453
  
    bootm_size	- Memory range available for image processing in the bootm
  		  command can be restricted. This variable is given as
  		  a hexadecimal number and defines the size of the region
  		  allowed for use by the bootm command. See also "bootm_low"
  		  environment variable.
4bae90904   Bartlomiej Sieka   Automatic softwar...
4454
4455
4456
    updatefile	- Location of the software update file on a TFTP server, used
  		  by the automatic software update feature. Please refer to
  		  documentation in doc/README.update for more details.
2729af9d5   wdenk   * Fix minor NAND ...
4457
4458
4459
4460
    autoload	- if set to "no" (any string beginning with 'n'),
  		  "bootp" will just load perform a lookup of the
  		  configuration from the BOOTP server, but not try to
  		  load any image using TFTP
c609719b8   wdenk   Initial revision
4461

2729af9d5   wdenk   * Fix minor NAND ...
4462
4463
4464
4465
    autostart	- if set to "yes", an image loaded using the "bootp",
  		  "rarpboot", "tftpboot" or "diskboot" commands will
  		  be automatically started (by internally calling
  		  "bootm")
38b99261c   wdenk   Add zero-copy ram...
4466

2729af9d5   wdenk   * Fix minor NAND ...
4467
4468
4469
4470
4471
  		  If set to "no", a standalone image passed to the
  		  "bootm" command will be copied to the load address
  		  (and eventually uncompressed), but NOT be started.
  		  This can be used to load and uncompress arbitrary
  		  data.
c609719b8   wdenk   Initial revision
4472

a28afca57   David A. Long   Add uboot "fdt_hi...
4473
4474
    fdt_high	- if set this restricts the maximum address that the
  		  flattened device tree will be copied into upon boot.
fa34f6b25   Shawn Guo   common/image.c: a...
4475
4476
4477
4478
4479
4480
4481
  		  For example, if you have a system with 1 GB memory
  		  at physical address 0x10000000, while Linux kernel
  		  only recognizes the first 704 MB as low memory, you
  		  may need to set fdt_high as 0x3C000000 to have the
  		  device tree blob be copied to the maximum address
  		  of the 704 MB low memory, so that Linux kernel can
  		  access it during the boot procedure.
a28afca57   David A. Long   Add uboot "fdt_hi...
4482
4483
4484
4485
4486
4487
  		  If this is set to the special value 0xFFFFFFFF then
  		  the fdt will not be copied at all on boot.  For this
  		  to work it must reside in writable memory, have
  		  sufficient padding on the end of it for u-boot to
  		  add the information it needs into it, and the memory
  		  must be accessible by the kernel.
eea63e05d   Simon Glass   fdt: ARM: Add fdt...
4488
4489
4490
    fdtcontroladdr- if set this is the address of the control flattened
  		  device tree used by U-Boot when CONFIG_OF_CONTROL is
  		  defined.
17ea11774   wdenk   Patch by Tolunay ...
4491
4492
4493
4494
4495
    i2cfast	- (PPC405GP|PPC405EP only)
  		  if set to 'y' configures Linux I2C driver for fast
  		  mode (400kHZ). This environment variable is used in
  		  initialization code. So, for changes to be effective
  		  it must be saved and board must be reset.
2729af9d5   wdenk   * Fix minor NAND ...
4496
4497
4498
4499
4500
4501
    initrd_high	- restrict positioning of initrd images:
  		  If this variable is not set, initrd images will be
  		  copied to the highest possible address in RAM; this
  		  is usually what you want since it allows for
  		  maximum initrd size. If for some reason you want to
  		  make sure that the initrd image is loaded below the
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
4502
  		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
2729af9d5   wdenk   * Fix minor NAND ...
4503
4504
4505
4506
  		  variable to a value of "no" or "off" or "0".
  		  Alternatively, you can set it to a maximum upper
  		  address to use (U-Boot will still check that it
  		  does not overwrite the U-Boot stack and data).
c609719b8   wdenk   Initial revision
4507

2729af9d5   wdenk   * Fix minor NAND ...
4508
4509
4510
4511
4512
4513
  		  For instance, when you have a system with 16 MB
  		  RAM, and want to reserve 4 MB from use by Linux,
  		  you can do this by adding "mem=12M" to the value of
  		  the "bootargs" variable. However, now you must make
  		  sure that the initrd image is placed in the first
  		  12 MB as well - this can be done with
c609719b8   wdenk   Initial revision
4514

2729af9d5   wdenk   * Fix minor NAND ...
4515
  		  setenv initrd_high 00c00000
c609719b8   wdenk   Initial revision
4516

2729af9d5   wdenk   * Fix minor NAND ...
4517
4518
4519
4520
4521
4522
4523
  		  If you set initrd_high to 0xFFFFFFFF, this is an
  		  indication to U-Boot that all addresses are legal
  		  for the Linux kernel, including addresses in flash
  		  memory. In this case U-Boot will NOT COPY the
  		  ramdisk at all. This may be useful to reduce the
  		  boot time on your system, but requires that this
  		  feature is supported by your Linux kernel.
c609719b8   wdenk   Initial revision
4524

2729af9d5   wdenk   * Fix minor NAND ...
4525
    ipaddr	- IP address; needed for tftpboot command
c609719b8   wdenk   Initial revision
4526

2729af9d5   wdenk   * Fix minor NAND ...
4527
4528
    loadaddr	- Default load address for commands like "bootp",
  		  "rarpboot", "tftpboot", "loadb" or "diskboot"
c609719b8   wdenk   Initial revision
4529

2729af9d5   wdenk   * Fix minor NAND ...
4530
    loads_echo	- see CONFIG_LOADS_ECHO
a3d991bd0   wdenk   Patches by Pantel...
4531

2729af9d5   wdenk   * Fix minor NAND ...
4532
    serverip	- TFTP server IP address; needed for tftpboot command
a3d991bd0   wdenk   Patches by Pantel...
4533

2729af9d5   wdenk   * Fix minor NAND ...
4534
    bootretry	- see CONFIG_BOOT_RETRY_TIME
a3d991bd0   wdenk   Patches by Pantel...
4535

2729af9d5   wdenk   * Fix minor NAND ...
4536
    bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
a3d991bd0   wdenk   Patches by Pantel...
4537

2729af9d5   wdenk   * Fix minor NAND ...
4538
    bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
c609719b8   wdenk   Initial revision
4539

e2a53458a   Mike Frysinger   net: drop !NET_MU...
4540
    ethprime	- controls which interface is used first.
c609719b8   wdenk   Initial revision
4541

e2a53458a   Mike Frysinger   net: drop !NET_MU...
4542
4543
    ethact	- controls which interface is currently active.
  		  For example you can do the following
c609719b8   wdenk   Initial revision
4544

48690d802   Heiko Schocher   net ppc: fix ethe...
4545
4546
4547
4548
  		  => setenv ethact FEC
  		  => ping 192.168.0.1 # traffic sent on FEC
  		  => setenv ethact SCC
  		  => ping 10.0.0.1 # traffic sent on SCC
c609719b8   wdenk   Initial revision
4549

e16925773   Matthias Fuchs   net: add 'ethrota...
4550
4551
4552
    ethrotate	- When set to "no" U-Boot does not go through all
  		  available network interfaces.
  		  It just stays at the currently selected interface.
c96f86eef   Wolfgang Denk   TFTP: allow for a...
4553
    netretry	- When set to "no" each network operation will
2729af9d5   wdenk   * Fix minor NAND ...
4554
4555
4556
4557
4558
4559
  		  either succeed or fail without retrying.
  		  When set to "once" the network operation will
  		  fail when all the available network interfaces
  		  are tried once without success.
  		  Useful on scripts which control the retry operation
  		  themselves.
c609719b8   wdenk   Initial revision
4560

b4e2f89df   Jean-Christophe PLAGNIOL-VILLARD   ixp: remove the o...
4561
    npe_ucode	- set load address for the NPE microcode
a1cf027a0   Jean-Christophe PLAGNIOL-VILLARD   IXP: add dynamic ...
4562

b445bbb49   Jeremiah Mahler   doc: fix grammati...
4563
    silent_linux  - If set then Linux will be told to boot silently, by
8d51aacd8   Simon Glass   RFC: bootm: Add s...
4564
4565
4566
4567
  		  changing the console to be empty. If "yes" it will be
  		  made silent. If "no" it will not be made silent. If
  		  unset, then it will be made silent if the U-Boot console
  		  is silent.
f5fb73467   Albert ARIBAUD \(3ADEV\)   net: TFTP: variab...
4568
    tftpsrcp	- If this is set, the value is used for TFTP's
ecb0ccd9c   Wolfgang Denk   Allow to force TF...
4569
  		  UDP source port.
f5fb73467   Albert ARIBAUD \(3ADEV\)   net: TFTP: variab...
4570
    tftpdstp	- If this is set, the value is used for TFTP's UDP
28cb93758   Wolfgang Denk   Update for TFTP u...
4571
  		  destination port instead of the Well Know Port 69.
c96f86eef   Wolfgang Denk   TFTP: allow for a...
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
    tftpblocksize - Block size to use for TFTP transfers; if not set,
  		  we use the TFTP server's default block size
  
    tftptimeout	- Retransmission timeout for TFTP packets (in milli-
  		  seconds, minimum value is 1000 = 1 second). Defines
  		  when a packet is considered to be lost so it has to
  		  be retransmitted. The default is 5000 = 5 seconds.
  		  Lowering this value may make downloads succeed
  		  faster in networks with high packet loss rates or
  		  with unreliable TFTP servers.
f5fb73467   Albert ARIBAUD \(3ADEV\)   net: TFTP: variab...
4582
4583
4584
4585
4586
4587
4588
    tftptimeoutcountmax	- maximum count of TFTP timeouts (no
  		  unit, minimum value = 0). Defines how many timeouts
  		  can happen during a single file transfer before that
  		  transfer is aborted. The default is 10, and 0 means
  		  'no timeouts allowed'. Increasing this value may help
  		  downloads succeed with high packet loss rates, or with
  		  unreliable TFTP servers or client hardware.
c96f86eef   Wolfgang Denk   TFTP: allow for a...
4589
    vlan		- When set to a value < 4095 the traffic over
11ccc33fa   Marcel Ziswiler   Many spelling fix...
4590
  		  Ethernet is encapsulated/received over 802.1q
2729af9d5   wdenk   * Fix minor NAND ...
4591
  		  VLAN tagged frames.
c609719b8   wdenk   Initial revision
4592

50768f5b0   Alexandre Messier   net: bootp: Add e...
4593
4594
4595
4596
4597
    bootpretryperiod	- Period during which BOOTP/DHCP sends retries.
  		  Unsigned value, in milliseconds. If not set, the period will
  		  be either the default (28000), or a value based on
  		  CONFIG_NET_RETRY_COUNT, if defined. This value has
  		  precedence over the valu based on CONFIG_NET_RETRY_COUNT.
dc0b7b0e6   Jason Hobbs   README: document ...
4598
4599
4600
4601
4602
4603
4604
4605
4606
  The following image location variables contain the location of images
  used in booting. The "Image" column gives the role of the image and is
  not an environment variable name. The other columns are environment
  variable names. "File Name" gives the name of the file on a TFTP
  server, "RAM Address" gives the location in RAM the image will be
  loaded to, and "Flash Location" gives the image's address in NOR
  flash or offset in NAND flash.
  
  *Note* - these variables don't have to be defined for all boards, some
aed9fed97   Fabio Estevam   README: fix typo ...
4607
  boards currently use other variables for these purposes, and some
dc0b7b0e6   Jason Hobbs   README: document ...
4608
  boards use these variables for other purposes.
c0f40859f   Wolfgang Denk   README: white-spa...
4609
4610
4611
4612
4613
4614
  Image		    File Name	     RAM Address       Flash Location
  -----		    ---------	     -----------       --------------
  u-boot		    u-boot	     u-boot_addr_r     u-boot_addr
  Linux kernel	    bootfile	     kernel_addr_r     kernel_addr
  device tree blob    fdtfile	     fdt_addr_r	       fdt_addr
  ramdisk		    ramdiskfile	     ramdisk_addr_r    ramdisk_addr
dc0b7b0e6   Jason Hobbs   README: document ...
4615

2729af9d5   wdenk   * Fix minor NAND ...
4616
4617
4618
  The following environment variables may be used and automatically
  updated by the network boot commands ("bootp" and "rarpboot"),
  depending the information provided by your boot server:
c609719b8   wdenk   Initial revision
4619

2729af9d5   wdenk   * Fix minor NAND ...
4620
4621
4622
4623
4624
4625
4626
4627
4628
    bootfile	- see above
    dnsip		- IP address of your Domain Name Server
    dnsip2	- IP address of your secondary Domain Name Server
    gatewayip	- IP address of the Gateway (Router) to use
    hostname	- Target hostname
    ipaddr	- see above
    netmask	- Subnet Mask
    rootpath	- Pathname of the root filesystem on the NFS server
    serverip	- see above
c1551ea81   stroese   U-Boot version en...
4629

c1551ea81   stroese   U-Boot version en...
4630

2729af9d5   wdenk   * Fix minor NAND ...
4631
  There are two special Environment Variables:
c1551ea81   stroese   U-Boot version en...
4632

2729af9d5   wdenk   * Fix minor NAND ...
4633
4634
4635
    serial#	- contains hardware identification information such
  		  as type string and/or serial number
    ethaddr	- Ethernet address
c609719b8   wdenk   Initial revision
4636

2729af9d5   wdenk   * Fix minor NAND ...
4637
4638
4639
  These variables can be set only once (usually during manufacturing of
  the board). U-Boot refuses to delete or overwrite these variables
  once they have been set once.
c609719b8   wdenk   Initial revision
4640

f07771cc2   wdenk   * Fix data abort ...
4641

2729af9d5   wdenk   * Fix minor NAND ...
4642
  Further special Environment Variables:
f07771cc2   wdenk   * Fix data abort ...
4643

2729af9d5   wdenk   * Fix minor NAND ...
4644
4645
4646
    ver		- Contains the U-Boot version string as printed
  		  with the "version" command. This variable is
  		  readonly (see CONFIG_VERSION_VARIABLE).
f07771cc2   wdenk   * Fix data abort ...
4647

f07771cc2   wdenk   * Fix data abort ...
4648

2729af9d5   wdenk   * Fix minor NAND ...
4649
4650
  Please note that changes to some configuration parameters may take
  only effect after the next boot (yes, that's just like Windoze :-).
f07771cc2   wdenk   * Fix data abort ...
4651

f07771cc2   wdenk   * Fix data abort ...
4652

170ab1107   Joe Hershberger   env: Add support ...
4653
4654
4655
4656
  Callback functions for environment variables:
  ---------------------------------------------
  
  For some environment variables, the behavior of u-boot needs to change
b445bbb49   Jeremiah Mahler   doc: fix grammati...
4657
  when their values are changed.  This functionality allows functions to
170ab1107   Joe Hershberger   env: Add support ...
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
  be associated with arbitrary variables.  On creation, overwrite, or
  deletion, the callback will provide the opportunity for some side
  effect to happen or for the change to be rejected.
  
  The callbacks are named and associated with a function using the
  U_BOOT_ENV_CALLBACK macro in your board or driver code.
  
  These callbacks are associated with variables in one of two ways.  The
  static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
  in the board configuration to a string that defines a list of
  associations.  The list must be in the following format:
  
  	entry = variable_name[:callback_name]
  	list = entry[,list]
  
  If the callback name is not specified, then the callback is deleted.
  Spaces are also allowed anywhere in the list.
  
  Callbacks can also be associated by defining the ".callbacks" variable
  with the same list format above.  Any association in ".callbacks" will
  override any association in the static list. You can define
  CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
b445bbb49   Jeremiah Mahler   doc: fix grammati...
4680
  ".callbacks" environment variable in the default or embedded environment.
170ab1107   Joe Hershberger   env: Add support ...
4681

bdf1fe4e6   Joe Hershberger   env: Add regex su...
4682
4683
4684
  If CONFIG_REGEX is defined, the variable_name above is evaluated as a
  regular expression. This allows multiple variables to be connected to
  the same callback without explicitly listing them all out.
170ab1107   Joe Hershberger   env: Add support ...
4685

2729af9d5   wdenk   * Fix minor NAND ...
4686
4687
  Command Line Parsing:
  =====================
f07771cc2   wdenk   * Fix data abort ...
4688

2729af9d5   wdenk   * Fix minor NAND ...
4689
4690
  There are two different command line parsers available with U-Boot:
  the old "simple" one, and the much more powerful "hush" shell:
c609719b8   wdenk   Initial revision
4691

2729af9d5   wdenk   * Fix minor NAND ...
4692
4693
  Old, simple command line parser:
  --------------------------------
c609719b8   wdenk   Initial revision
4694

2729af9d5   wdenk   * Fix minor NAND ...
4695
4696
  - supports environment variables (through setenv / saveenv commands)
  - several commands on one line, separated by ';'
fe126d8b3   Wolfgang Denk   Change all '$(......
4697
  - variable substitution using "... ${name} ..." syntax
2729af9d5   wdenk   * Fix minor NAND ...
4698
4699
  - special characters ('$', ';') can be escaped by prefixing with '\',
    for example:
fe126d8b3   Wolfgang Denk   Change all '$(......
4700
  	setenv bootcmd bootm \${address}
2729af9d5   wdenk   * Fix minor NAND ...
4701
4702
  - You can also escape text by enclosing in single apostrophes, for example:
  	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
c609719b8   wdenk   Initial revision
4703

2729af9d5   wdenk   * Fix minor NAND ...
4704
4705
  Hush shell:
  -----------
c609719b8   wdenk   Initial revision
4706

2729af9d5   wdenk   * Fix minor NAND ...
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
  - similar to Bourne shell, with control structures like
    if...then...else...fi, for...do...done; while...do...done,
    until...do...done, ...
  - supports environment ("global") variables (through setenv / saveenv
    commands) and local shell variables (through standard shell syntax
    "name=value"); only environment variables can be used with "run"
    command
  
  General rules:
  --------------
c609719b8   wdenk   Initial revision
4717

2729af9d5   wdenk   * Fix minor NAND ...
4718
4719
4720
4721
  (1) If a command line (or an environment variable executed by a "run"
      command) contains several commands separated by semicolon, and
      one of these commands fails, then the remaining commands will be
      executed anyway.
c609719b8   wdenk   Initial revision
4722

2729af9d5   wdenk   * Fix minor NAND ...
4723
  (2) If you execute several variables with one call to run (i. e.
11ccc33fa   Marcel Ziswiler   Many spelling fix...
4724
      calling run with a list of variables as arguments), any failing
2729af9d5   wdenk   * Fix minor NAND ...
4725
4726
      command will cause "run" to terminate, i. e. the remaining
      variables are not executed.
c609719b8   wdenk   Initial revision
4727

2729af9d5   wdenk   * Fix minor NAND ...
4728
4729
  Note for Redundant Ethernet Interfaces:
  =======================================
c609719b8   wdenk   Initial revision
4730

11ccc33fa   Marcel Ziswiler   Many spelling fix...
4731
  Some boards come with redundant Ethernet interfaces; U-Boot supports
2729af9d5   wdenk   * Fix minor NAND ...
4732
4733
  such configurations and is capable of automatic selection of a
  "working" interface when needed. MAC assignment works as follows:
c609719b8   wdenk   Initial revision
4734

2729af9d5   wdenk   * Fix minor NAND ...
4735
4736
4737
  Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
  MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
  "eth1addr" (=>eth1), "eth2addr", ...
c609719b8   wdenk   Initial revision
4738

2729af9d5   wdenk   * Fix minor NAND ...
4739
4740
4741
4742
  If the network interface stores some valid MAC address (for instance
  in SROM), this is used as default address if there is NO correspon-
  ding setting in the environment; if the corresponding environment
  variable is set, this overrides the settings in the card; that means:
c609719b8   wdenk   Initial revision
4743

2729af9d5   wdenk   * Fix minor NAND ...
4744
4745
  o If the SROM has a valid MAC address, and there is no address in the
    environment, the SROM's address is used.
c609719b8   wdenk   Initial revision
4746

2729af9d5   wdenk   * Fix minor NAND ...
4747
4748
4749
  o If there is no valid address in the SROM, and a definition in the
    environment exists, then the value from the environment variable is
    used.
c609719b8   wdenk   Initial revision
4750

2729af9d5   wdenk   * Fix minor NAND ...
4751
4752
  o If both the SROM and the environment contain a MAC address, and
    both addresses are the same, this MAC address is used.
c609719b8   wdenk   Initial revision
4753

2729af9d5   wdenk   * Fix minor NAND ...
4754
4755
4756
  o If both the SROM and the environment contain a MAC address, and the
    addresses differ, the value from the environment is used and a
    warning is printed.
c609719b8   wdenk   Initial revision
4757

2729af9d5   wdenk   * Fix minor NAND ...
4758
  o If neither SROM nor the environment contain a MAC address, an error
bef1014b3   Joe Hershberger   net: Implement ra...
4759
4760
    is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
    a random, locally-assigned MAC is used.
c609719b8   wdenk   Initial revision
4761

ecee9324d   Ben Warren   Program net devic...
4762
  If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
c0f40859f   Wolfgang Denk   README: white-spa...
4763
  will be programmed into hardware as part of the initialization process.	 This
ecee9324d   Ben Warren   Program net devic...
4764
4765
4766
  may be skipped by setting the appropriate 'ethmacskip' environment variable.
  The naming convention is as follows:
  "ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
c609719b8   wdenk   Initial revision
4767

2729af9d5   wdenk   * Fix minor NAND ...
4768
4769
  Image Formats:
  ==============
c609719b8   wdenk   Initial revision
4770

3310c549a   Marian Balakowicz   [new uImage] Add ...
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
  U-Boot is capable of booting (and performing other auxiliary operations on)
  images in two formats:
  
  New uImage format (FIT)
  -----------------------
  
  Flexible and powerful format based on Flattened Image Tree -- FIT (similar
  to Flattened Device Tree). It allows the use of images with multiple
  components (several kernels, ramdisks, etc.), with contents protected by
  SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
  
  
  Old uImage format
  -----------------
  
  Old image format is based on binary files which can be basically anything,
  preceded by a special header; see the definitions in include/image.h for
  details; basically, the header defines the following image properties:
c609719b8   wdenk   Initial revision
4789

2729af9d5   wdenk   * Fix minor NAND ...
4790
4791
  * Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
    4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
f5ed9e390   Peter Tyser   Add support for b...
4792
4793
4794
    LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
    Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
    INTEGRITY).
7b64fef33   Wolfgang Denk   Add AVR32 archite...
4795
  * Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
afc1ce828   Macpaul Lin   doc/README: docum...
4796
4797
    IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
    Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
2729af9d5   wdenk   * Fix minor NAND ...
4798
4799
4800
4801
4802
  * Compression Type (uncompressed, gzip, bzip2)
  * Load Address
  * Entry Point
  * Image Name
  * Image Timestamp
c609719b8   wdenk   Initial revision
4803

2729af9d5   wdenk   * Fix minor NAND ...
4804
4805
4806
  The header is marked by a special Magic Number, and both the header
  and the data portions of the image are secured against corruption by
  CRC32 checksums.
c609719b8   wdenk   Initial revision
4807

2729af9d5   wdenk   * Fix minor NAND ...
4808
4809
  Linux Support:
  ==============
c609719b8   wdenk   Initial revision
4810

2729af9d5   wdenk   * Fix minor NAND ...
4811
4812
4813
  Although U-Boot should support any OS or standalone application
  easily, the main focus has always been on Linux during the design of
  U-Boot.
c609719b8   wdenk   Initial revision
4814

2729af9d5   wdenk   * Fix minor NAND ...
4815
4816
4817
4818
4819
  U-Boot includes many features that so far have been part of some
  special "boot loader" code within the Linux kernel. Also, any
  "initrd" images to be used are no longer part of one big Linux image;
  instead, kernel and "initrd" are separate images. This implementation
  serves several purposes:
c609719b8   wdenk   Initial revision
4820

2729af9d5   wdenk   * Fix minor NAND ...
4821
4822
4823
  - the same features can be used for other OS or standalone
    applications (for instance: using compressed images to reduce the
    Flash memory footprint)
c609719b8   wdenk   Initial revision
4824

2729af9d5   wdenk   * Fix minor NAND ...
4825
4826
  - it becomes much easier to port new Linux kernel versions because
    lots of low-level, hardware dependent stuff are done by U-Boot
c609719b8   wdenk   Initial revision
4827

2729af9d5   wdenk   * Fix minor NAND ...
4828
4829
4830
4831
4832
4833
  - the same Linux kernel image can now be used with different "initrd"
    images; of course this also means that different kernel images can
    be run with the same "initrd". This makes testing easier (you don't
    have to build a new "zImage.initrd" Linux image when you just
    change a file in your "initrd"). Also, a field-upgrade of the
    software is easier now.
c609719b8   wdenk   Initial revision
4834

c609719b8   wdenk   Initial revision
4835

2729af9d5   wdenk   * Fix minor NAND ...
4836
4837
  Linux HOWTO:
  ============
c609719b8   wdenk   Initial revision
4838

2729af9d5   wdenk   * Fix minor NAND ...
4839
4840
  Porting Linux to U-Boot based systems:
  ---------------------------------------
c609719b8   wdenk   Initial revision
4841

2729af9d5   wdenk   * Fix minor NAND ...
4842
4843
4844
4845
  U-Boot cannot save you from doing all the necessary modifications to
  configure the Linux device drivers for use with your target hardware
  (no, we don't intend to provide a full virtual machine interface to
  Linux :-).
c609719b8   wdenk   Initial revision
4846

a47a12bec   Stefan Roese   Move arch/ppc to ...
4847
  But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
24ee89b97   wdenk   * Fix mdelay() on...
4848

2729af9d5   wdenk   * Fix minor NAND ...
4849
4850
  Just make sure your machine specific header file (for instance
  include/asm-ppc/tqm8xx.h) includes the same definition of the Board
1dc306931   Markus Heidelberg   README: fix missi...
4851
4852
  Information structure as we define in include/asm-<arch>/u-boot.h,
  and make sure that your definition of IMAP_ADDR uses the same value
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
4853
  as your U-Boot configuration in CONFIG_SYS_IMMR.
24ee89b97   wdenk   * Fix mdelay() on...
4854

2eb31b13d   Simon Glass   dm: Update README...
4855
4856
4857
4858
  Note that U-Boot now has a driver model, a unified model for drivers.
  If you are adding a new driver, plumb it into driver model. If there
  is no uclass available, you are encouraged to create one. See
  doc/driver-model.
c609719b8   wdenk   Initial revision
4859

2729af9d5   wdenk   * Fix minor NAND ...
4860
4861
  Configuring the Linux kernel:
  -----------------------------
c609719b8   wdenk   Initial revision
4862

2729af9d5   wdenk   * Fix minor NAND ...
4863
4864
4865
4866
4867
4868
  No specific requirements for U-Boot. Make sure you have some root
  device (initial ramdisk, NFS) for your target system.
  
  
  Building a Linux Image:
  -----------------------
c609719b8   wdenk   Initial revision
4869

2729af9d5   wdenk   * Fix minor NAND ...
4870
4871
4872
4873
4874
4875
4876
4877
  With U-Boot, "normal" build targets like "zImage" or "bzImage" are
  not used. If you use recent kernel source, a new build target
  "uImage" will exist which automatically builds an image usable by
  U-Boot. Most older kernels also have support for a "pImage" target,
  which was introduced for our predecessor project PPCBoot and uses a
  100% compatible format.
  
  Example:
ab584d67c   Holger Freyther   The _config targe...
4878
  	make TQM850L_defconfig
2729af9d5   wdenk   * Fix minor NAND ...
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
  	make oldconfig
  	make dep
  	make uImage
  
  The "uImage" build target uses a special tool (in 'tools/mkimage') to
  encapsulate a compressed Linux kernel image with header	 information,
  CRC32 checksum etc. for use with U-Boot. This is what we are doing:
  
  * build a standard "vmlinux" kernel image (in ELF binary format):
  
  * convert the kernel into a raw binary image:
  
  	${CROSS_COMPILE}-objcopy -O binary \
  				 -R .note -R .comment \
  				 -S vmlinux linux.bin
  
  * compress the binary image:
  
  	gzip -9 linux.bin
  
  * package compressed binary image for U-Boot:
  
  	mkimage -A ppc -O linux -T kernel -C gzip \
  		-a 0 -e 0 -n "Linux Kernel Image" \
  		-d linux.bin.gz uImage
c609719b8   wdenk   Initial revision
4904

c609719b8   wdenk   Initial revision
4905

2729af9d5   wdenk   * Fix minor NAND ...
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
  The "mkimage" tool can also be used to create ramdisk images for use
  with U-Boot, either separated from the Linux kernel image, or
  combined into one file. "mkimage" encapsulates the images with a 64
  byte header containing information about target architecture,
  operating system, image type, compression method, entry points, time
  stamp, CRC32 checksums, etc.
  
  "mkimage" can be called in two ways: to verify existing images and
  print the header information, or to build new images.
  
  In the first form (with "-l" option) mkimage lists the information
  contained in the header of an existing U-Boot image; this includes
  checksum verification:
c609719b8   wdenk   Initial revision
4919

2729af9d5   wdenk   * Fix minor NAND ...
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
  	tools/mkimage -l image
  	  -l ==> list image header information
  
  The second form (with "-d" option) is used to build a U-Boot image
  from a "data file" which is used as image payload:
  
  	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
  		      -n name -d data_file image
  	  -A ==> set architecture to 'arch'
  	  -O ==> set operating system to 'os'
  	  -T ==> set image type to 'type'
  	  -C ==> set compression type 'comp'
  	  -a ==> set load address to 'addr' (hex)
  	  -e ==> set entry point to 'ep' (hex)
  	  -n ==> set image name to 'name'
  	  -d ==> use image data from 'datafile'
694597912   wdenk   Fix CONFIG_ETH*AD...
4936
4937
4938
  Right now, all Linux kernels for PowerPC systems use the same load
  address (0x00000000), but the entry point address depends on the
  kernel version:
2729af9d5   wdenk   * Fix minor NAND ...
4939
4940
4941
4942
4943
4944
4945
4946
  
  - 2.2.x kernels have the entry point at 0x0000000C,
  - 2.3.x and later kernels have the entry point at 0x00000000.
  
  So a typical call to build a U-Boot image would read:
  
  	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
  	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
a47a12bec   Stefan Roese   Move arch/ppc to ...
4947
  	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
2729af9d5   wdenk   * Fix minor NAND ...
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
  	> examples/uImage.TQM850L
  	Image Name:   2.4.4 kernel for TQM850L
  	Created:      Wed Jul 19 02:34:59 2000
  	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
  	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
  	Load Address: 0x00000000
  	Entry Point:  0x00000000
  
  To verify the contents of the image (or check for corruption):
  
  	-> tools/mkimage -l examples/uImage.TQM850L
  	Image Name:   2.4.4 kernel for TQM850L
  	Created:      Wed Jul 19 02:34:59 2000
  	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
  	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
  	Load Address: 0x00000000
  	Entry Point:  0x00000000
  
  NOTE: for embedded systems where boot time is critical you can trade
  speed for memory and install an UNCOMPRESSED image instead: this
  needs more space in Flash, but boots much faster since it does not
  need to be uncompressed:
a47a12bec   Stefan Roese   Move arch/ppc to ...
4970
  	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
2729af9d5   wdenk   * Fix minor NAND ...
4971
4972
  	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
  	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
a47a12bec   Stefan Roese   Move arch/ppc to ...
4973
  	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
2729af9d5   wdenk   * Fix minor NAND ...
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
  	> examples/uImage.TQM850L-uncompressed
  	Image Name:   2.4.4 kernel for TQM850L
  	Created:      Wed Jul 19 02:34:59 2000
  	Image Type:   PowerPC Linux Kernel Image (uncompressed)
  	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
  	Load Address: 0x00000000
  	Entry Point:  0x00000000
  
  
  Similar you can build U-Boot images from a 'ramdisk.image.gz' file
  when your kernel is intended to use an initial ramdisk:
  
  	-> tools/mkimage -n 'Simple Ramdisk Image' \
  	> -A ppc -O linux -T ramdisk -C gzip \
  	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
  	Image Name:   Simple Ramdisk Image
  	Created:      Wed Jan 12 14:01:50 2000
  	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
  	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
  	Load Address: 0x00000000
  	Entry Point:  0x00000000
a804b5ce2   Guilherme Maciel Ferreira   Add dumpimage, a ...
4995
4996
4997
4998
  The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
  option performs the converse operation of the mkimage's second form (the "-d"
  option). Given an image built by mkimage, the dumpimage extracts a "data file"
  from the image:
f41f5b7c0   Guilherme Maciel Ferreira   dumpimage: add 'T...
4999
5000
5001
5002
  	tools/dumpimage -i image -T type -p position data_file
  	  -i ==> extract from the 'image' a specific 'data_file'
  	  -T ==> set image type to 'type'
  	  -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
a804b5ce2   Guilherme Maciel Ferreira   Add dumpimage, a ...
5003

2729af9d5   wdenk   * Fix minor NAND ...
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
  
  Installing a Linux Image:
  -------------------------
  
  To downloading a U-Boot image over the serial (console) interface,
  you must convert the image to S-Record format:
  
  	objcopy -I binary -O srec examples/image examples/image.srec
  
  The 'objcopy' does not understand the information in the U-Boot
  image header, so the resulting S-Record file will be relative to
  address 0x00000000. To load it to a given address, you need to
  specify the target address as 'offset' parameter with the 'loads'
  command.
  
  Example: install the image to address 0x40100000 (which on the
  TQM8xxL is in the first Flash bank):
  
  	=> erase 40100000 401FFFFF
  
  	.......... done
  	Erased 8 sectors
  
  	=> loads 40100000
  	## Ready for S-Record download ...
  	~>examples/image.srec
  	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
  	...
  	15989 15990 15991 15992
  	[file transfer complete]
  	[connected]
  	## Start Addr = 0x00000000
  
  
  You can check the success of the download using the 'iminfo' command;
218ca724c   Wolfgang Denk   README: update do...
5039
  this includes a checksum verification so you can be sure no data
2729af9d5   wdenk   * Fix minor NAND ...
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
  corruption happened:
  
  	=> imi 40100000
  
  	## Checking Image at 40100000 ...
  	   Image Name:	 2.2.13 for initrd on TQM850L
  	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
  	   Data Size:	 335725 Bytes = 327 kB = 0 MB
  	   Load Address: 00000000
  	   Entry Point:	 0000000c
  	   Verifying Checksum ... OK
  
  
  Boot Linux:
  -----------
  
  The "bootm" command is used to boot an application that is stored in
  memory (RAM or Flash). In case of a Linux kernel image, the contents
  of the "bootargs" environment variable is passed to the kernel as
  parameters. You can check and modify this variable using the
  "printenv" and "setenv" commands:
  
  
  	=> printenv bootargs
  	bootargs=root=/dev/ram
  
  	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
  
  	=> printenv bootargs
  	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
  
  	=> bootm 40020000
  	## Booting Linux kernel at 40020000 ...
  	   Image Name:	 2.2.13 for NFS on TQM850L
  	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
  	   Data Size:	 381681 Bytes = 372 kB = 0 MB
  	   Load Address: 00000000
  	   Entry Point:	 0000000c
  	   Verifying Checksum ... OK
  	   Uncompressing Kernel Image ... OK
  	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
  	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
  	time_init: decrementer frequency = 187500000/60
  	Calibrating delay loop... 49.77 BogoMIPS
  	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
  	...
11ccc33fa   Marcel Ziswiler   Many spelling fix...
5086
  If you want to boot a Linux kernel with initial RAM disk, you pass
2729af9d5   wdenk   * Fix minor NAND ...
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
  the memory addresses of both the kernel and the initrd image (PPBCOOT
  format!) to the "bootm" command:
  
  	=> imi 40100000 40200000
  
  	## Checking Image at 40100000 ...
  	   Image Name:	 2.2.13 for initrd on TQM850L
  	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
  	   Data Size:	 335725 Bytes = 327 kB = 0 MB
  	   Load Address: 00000000
  	   Entry Point:	 0000000c
  	   Verifying Checksum ... OK
  
  	## Checking Image at 40200000 ...
  	   Image Name:	 Simple Ramdisk Image
  	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
  	   Data Size:	 566530 Bytes = 553 kB = 0 MB
  	   Load Address: 00000000
  	   Entry Point:	 00000000
  	   Verifying Checksum ... OK
  
  	=> bootm 40100000 40200000
  	## Booting Linux kernel at 40100000 ...
  	   Image Name:	 2.2.13 for initrd on TQM850L
  	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
  	   Data Size:	 335725 Bytes = 327 kB = 0 MB
  	   Load Address: 00000000
  	   Entry Point:	 0000000c
  	   Verifying Checksum ... OK
  	   Uncompressing Kernel Image ... OK
  	## Loading RAMDisk Image at 40200000 ...
  	   Image Name:	 Simple Ramdisk Image
  	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
  	   Data Size:	 566530 Bytes = 553 kB = 0 MB
  	   Load Address: 00000000
  	   Entry Point:	 00000000
  	   Verifying Checksum ... OK
  	   Loading Ramdisk ... OK
  	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
  	Boot arguments: root=/dev/ram
  	time_init: decrementer frequency = 187500000/60
  	Calibrating delay loop... 49.77 BogoMIPS
  	...
  	RAMDISK: Compressed image found at block 0
  	VFS: Mounted root (ext2 filesystem).
  
  	bash#
0267768ed   Matthew McClintock   * Modify bootm co...
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
  Boot Linux and pass a flat device tree:
  -----------
  
  First, U-Boot must be compiled with the appropriate defines. See the section
  titled "Linux Kernel Interface" above for a more in depth explanation. The
  following is an example of how to start a kernel and pass an updated
  flat device tree:
  
  => print oftaddr
  oftaddr=0x300000
  => print oft
  oft=oftrees/mpc8540ads.dtb
  => tftp $oftaddr $oft
  Speed: 1000, full duplex
  Using TSEC0 device
  TFTP from server 192.168.1.1; our IP address is 192.168.1.101
  Filename 'oftrees/mpc8540ads.dtb'.
  Load address: 0x300000
  Loading: #
  done
  Bytes transferred = 4106 (100a hex)
  => tftp $loadaddr $bootfile
  Speed: 1000, full duplex
  Using TSEC0 device
  TFTP from server 192.168.1.1; our IP address is 192.168.1.2
  Filename 'uImage'.
  Load address: 0x200000
  Loading:############
  done
  Bytes transferred = 1029407 (fb51f hex)
  => print loadaddr
  loadaddr=200000
  => print oftaddr
  oftaddr=0x300000
  => bootm $loadaddr - $oftaddr
  ## Booting image at 00200000 ...
a9398e018   Wolfgang Denk   Minor code cleanu...
5170
5171
5172
     Image Name:	 Linux-2.6.17-dirty
     Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
     Data Size:	 1029343 Bytes = 1005.2 kB
0267768ed   Matthew McClintock   * Modify bootm co...
5173
     Load Address: 00000000
a9398e018   Wolfgang Denk   Minor code cleanu...
5174
     Entry Point:	 00000000
0267768ed   Matthew McClintock   * Modify bootm co...
5175
5176
5177
5178
5179
5180
     Verifying Checksum ... OK
     Uncompressing Kernel Image ... OK
  Booting using flat device tree at 0x300000
  Using MPC85xx ADS machine description
  Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
  [snip]
2729af9d5   wdenk   * Fix minor NAND ...
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
  More About U-Boot Image Types:
  ------------------------------
  
  U-Boot supports the following image types:
  
     "Standalone Programs" are directly runnable in the environment
  	provided by U-Boot; it is expected that (if they behave
  	well) you can continue to work in U-Boot after return from
  	the Standalone Program.
     "OS Kernel Images" are usually images of some Embedded OS which
  	will take over control completely. Usually these programs
  	will install their own set of exception handlers, device
  	drivers, set up the MMU, etc. - this means, that you cannot
  	expect to re-enter U-Boot except by resetting the CPU.
     "RAMDisk Images" are more or less just data blocks, and their
  	parameters (address, size) are passed to an OS kernel that is
  	being started.
     "Multi-File Images" contain several images, typically an OS
  	(Linux) kernel image and one or more data images like
  	RAMDisks. This construct is useful for instance when you want
  	to boot over the network using BOOTP etc., where the boot
  	server provides just a single image file, but you want to get
  	for instance an OS kernel and a RAMDisk image.
  
  	"Multi-File Images" start with a list of image sizes, each
  	image size (in bytes) specified by an "uint32_t" in network
  	byte order. This list is terminated by an "(uint32_t)0".
  	Immediately after the terminating 0 follow the images, one by
  	one, all aligned on "uint32_t" boundaries (size rounded up to
  	a multiple of 4 bytes).
  
     "Firmware Images" are binary images containing firmware (like
  	U-Boot or FPGA images) which usually will be programmed to
  	flash memory.
  
     "Script files" are command sequences that will be executed by
  	U-Boot's command interpreter; this feature is especially
  	useful when you configure U-Boot to use a real shell (hush)
  	as command interpreter.
44f074c77   Marek Vasut   BOOT: Add "bootz"...
5220
5221
5222
5223
5224
5225
  Booting the Linux zImage:
  -------------------------
  
  On some platforms, it's possible to boot Linux zImage. This is done
  using the "bootz" command. The syntax of "bootz" command is the same
  as the syntax of "bootm" command.
8ac28563a   Tom Rini   README: Correct r...
5226
  Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
017e1f3f9   Marek Vasut   BOOT: Add RAW ram...
5227
5228
5229
  kernel with raw initrd images. The syntax is slightly different, the
  address of the initrd must be augmented by it's size, in the following
  format: "<initrd addres>:<initrd size>".
2729af9d5   wdenk   * Fix minor NAND ...
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
  
  Standalone HOWTO:
  =================
  
  One of the features of U-Boot is that you can dynamically load and
  run "standalone" applications, which can use some resources of
  U-Boot like console I/O functions or interrupt services.
  
  Two simple examples are included with the sources:
  
  "Hello World" Demo:
  -------------------
  
  'examples/hello_world.c' contains a small "Hello World" Demo
  application; it is automatically compiled when you build U-Boot.
  It's configured to run at address 0x00040004, so you can play with it
  like that:
  
  	=> loads
  	## Ready for S-Record download ...
  	~>examples/hello_world.srec
  	1 2 3 4 5 6 7 8 9 10 11 ...
  	[file transfer complete]
  	[connected]
  	## Start Addr = 0x00040004
  
  	=> go 40004 Hello World! This is a test.
  	## Starting application at 0x00040004 ...
  	Hello World
  	argc = 7
  	argv[0] = "40004"
  	argv[1] = "Hello"
  	argv[2] = "World!"
  	argv[3] = "This"
  	argv[4] = "is"
  	argv[5] = "a"
  	argv[6] = "test."
  	argv[7] = "<NULL>"
  	Hit any key to exit ...
  
  	## Application terminated, rc = 0x0
  
  Another example, which demonstrates how to register a CPM interrupt
  handler with the U-Boot code, can be found in 'examples/timer.c'.
  Here, a CPM timer is set up to generate an interrupt every second.
  The interrupt service routine is trivial, just printing a '.'
  character, but this is just a demo program. The application can be
  controlled by the following keys:
  
  	? - print current values og the CPM Timer registers
  	b - enable interrupts and start timer
  	e - stop timer and disable interrupts
  	q - quit application
  
  	=> loads
  	## Ready for S-Record download ...
  	~>examples/timer.srec
  	1 2 3 4 5 6 7 8 9 10 11 ...
  	[file transfer complete]
  	[connected]
  	## Start Addr = 0x00040004
  
  	=> go 40004
  	## Starting application at 0x00040004 ...
  	TIMERS=0xfff00980
  	Using timer 1
  	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
  
  Hit 'b':
  	[q, b, e, ?] Set interval 1000000 us
  	Enabling timer
  Hit '?':
  	[q, b, e, ?] ........
  	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
  Hit '?':
  	[q, b, e, ?] .
  	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
  Hit '?':
  	[q, b, e, ?] .
  	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
  Hit '?':
  	[q, b, e, ?] .
  	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
  Hit 'e':
  	[q, b, e, ?] ...Stopping timer
  Hit 'q':
  	[q, b, e, ?] ## Application terminated, rc = 0x0
  
  
  Minicom warning:
  ================
  
  Over time, many people have reported problems when trying to use the
  "minicom" terminal emulation program for serial download. I (wd)
  consider minicom to be broken, and recommend not to use it. Under
  Unix, I recommend to use C-Kermit for general purpose use (and
  especially for kermit binary protocol download ("loadb" command), and
e53515a21   Karl O. Pinc   README: Add handy...
5327
5328
5329
  use "cu" for S-Record download ("loads" command).  See
  http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
  for help with kermit.
2729af9d5   wdenk   * Fix minor NAND ...
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
  
  Nevertheless, if you absolutely want to use it try adding this
  configuration to your "File transfer protocols" section:
  
  	   Name	   Program			Name U/D FullScr IO-Red. Multi
  	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
  	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
  
  
  NetBSD Notes:
  =============
  
  Starting at version 0.9.2, U-Boot supports NetBSD both as host
  (build U-Boot) and target system (boots NetBSD/mpc8xx).
  
  Building requires a cross environment; it is known to work on
  NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
  need gmake since the Makefiles are not compatible with BSD make).
  Note that the cross-powerpc package does not install include files;
  attempting to build U-Boot will fail because <machine/ansi.h> is
  missing.  This file has to be installed and patched manually:
  
  	# cd /usr/pkg/cross/powerpc-netbsd/include
  	# mkdir powerpc
  	# ln -s powerpc machine
  	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
  	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
  
  Native builds *don't* work due to incompatibilities between native
  and U-Boot include files.
  
  Booting assumes that (the first part of) the image booted is a
  stage-2 loader which in turn loads and then invokes the kernel
  proper. Loader sources will eventually appear in the NetBSD source
  tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
2a8af1873   wdenk   * Fixes for TQM85...
5365
  meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
2729af9d5   wdenk   * Fix minor NAND ...
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
  
  
  Implementation Internals:
  =========================
  
  The following is not intended to be a complete description of every
  implementation detail. However, it should help to understand the
  inner workings of U-Boot and make it easier to port it to custom
  hardware.
  
  
  Initial Stack, Global Data:
  ---------------------------
  
  The implementation of U-Boot is complicated by the fact that U-Boot
  starts running out of ROM (flash memory), usually without access to
  system RAM (because the memory controller is not initialized yet).
  This means that we don't have writable Data or BSS segments, and BSS
  is not initialized as zero. To be able to get a C environment working
  at all, we have to allocate at least a minimal stack. Implementation
  options for this are defined and restricted by the CPU used: Some CPU
  models provide on-chip memory (like the IMMR area on MPC8xx and
  MPC826x processors), on others (parts of) the data cache can be
  locked as (mis-) used as memory, etc.
218ca724c   Wolfgang Denk   README: update do...
5390
  	Chris Hallinan posted a good summary of these issues to the
0668236ba   Wolfgang Denk   README: update ma...
5391
  	U-Boot mailing list:
2729af9d5   wdenk   * Fix minor NAND ...
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
  
  	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
  	From: "Chris Hallinan" <clh@net1plus.com>
  	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
  	...
  
  	Correct me if I'm wrong, folks, but the way I understand it
  	is this: Using DCACHE as initial RAM for Stack, etc, does not
  	require any physical RAM backing up the cache. The cleverness
  	is that the cache is being used as a temporary supply of
  	necessary storage before the SDRAM controller is setup. It's
11ccc33fa   Marcel Ziswiler   Many spelling fix...
5403
  	beyond the scope of this list to explain the details, but you
2729af9d5   wdenk   * Fix minor NAND ...
5404
5405
5406
5407
5408
  	can see how this works by studying the cache architecture and
  	operation in the architecture and processor-specific manuals.
  
  	OCM is On Chip Memory, which I believe the 405GP has 4K. It
  	is another option for the system designer to use as an
11ccc33fa   Marcel Ziswiler   Many spelling fix...
5409
  	initial stack/RAM area prior to SDRAM being available. Either
2729af9d5   wdenk   * Fix minor NAND ...
5410
5411
5412
5413
  	option should work for you. Using CS 4 should be fine if your
  	board designers haven't used it for something that would
  	cause you grief during the initial boot! It is frequently not
  	used.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
5414
  	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
2729af9d5   wdenk   * Fix minor NAND ...
5415
5416
  	with your processor/board/system design. The default value
  	you will find in any recent u-boot distribution in
8a316c9b6   Stefan Roese   Major cleanup for...
5417
  	walnut.h should work for you. I'd set it to a value larger
2729af9d5   wdenk   * Fix minor NAND ...
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
  	than your SDRAM module. If you have a 64MB SDRAM module, set
  	it above 400_0000. Just make sure your board has no resources
  	that are supposed to respond to that address! That code in
  	start.S has been around a while and should work as is when
  	you get the config right.
  
  	-Chris Hallinan
  	DS4.COM, Inc.
  
  It is essential to remember this, since it has some impact on the C
  code for the initialization procedures:
  
  * Initialized global data (data segment) is read-only. Do not attempt
    to write it.
b445bbb49   Jeremiah Mahler   doc: fix grammati...
5432
  * Do not use any uninitialized global data (or implicitly initialized
2729af9d5   wdenk   * Fix minor NAND ...
5433
5434
5435
5436
5437
5438
5439
    as zero data - BSS segment) at all - this is undefined, initiali-
    zation is performed later (when relocating to RAM).
  
  * Stack space is very limited. Avoid big data buffers or things like
    that.
  
  Having only the stack as writable memory limits means we cannot use
b445bbb49   Jeremiah Mahler   doc: fix grammati...
5440
  normal global data to share information between the code. But it
2729af9d5   wdenk   * Fix minor NAND ...
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
  turned out that the implementation of U-Boot can be greatly
  simplified by making a global data structure (gd_t) available to all
  functions. We could pass a pointer to this data as argument to _all_
  functions, but this would bloat the code. Instead we use a feature of
  the GCC compiler (Global Register Variables) to share the data: we
  place a pointer (gd) to the global data into a register which we
  reserve for this purpose.
  
  When choosing a register for such a purpose we are restricted by the
  relevant  (E)ABI  specifications for the current architecture, and by
  GCC's implementation.
  
  For PowerPC, the following registers have specific use:
  	R1:	stack pointer
e7670f6c1   Wolfgang Denk   PPC: Use r2 inste...
5455
  	R2:	reserved for system use
2729af9d5   wdenk   * Fix minor NAND ...
5456
5457
5458
5459
5460
  	R3-R4:	parameter passing and return values
  	R5-R10: parameter passing
  	R13:	small data area pointer
  	R30:	GOT pointer
  	R31:	frame pointer
e6bee8081   Joakim Tjernlund   ppc: Update READM...
5461
5462
5463
  	(U-Boot also uses R12 as internal GOT pointer. r12
  	is a volatile register so r12 needs to be reset when
  	going back and forth between asm and C)
2729af9d5   wdenk   * Fix minor NAND ...
5464

e7670f6c1   Wolfgang Denk   PPC: Use r2 inste...
5465
      ==> U-Boot will use R2 to hold a pointer to the global data
2729af9d5   wdenk   * Fix minor NAND ...
5466
5467
5468
5469
5470
5471
5472
  
      Note: on PPC, we could use a static initializer (since the
      address of the global data structure is known at compile time),
      but it turned out that reserving a register results in somewhat
      smaller code - although the code savings are not that big (on
      average for all boards 752 bytes for the whole U-Boot image,
      624 text + 127 data).
c4db335c2   Robin Getz   Blackfin: change ...
5473
  On Blackfin, the normal C ABI (except for P3) is followed as documented here:
4c58eb555   Mike Frysinger   add some more Bla...
5474
  	http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
c4db335c2   Robin Getz   Blackfin: change ...
5475
      ==> U-Boot will use P3 to hold a pointer to the global data
4c58eb555   Mike Frysinger   add some more Bla...
5476

2729af9d5   wdenk   * Fix minor NAND ...
5477
5478
5479
5480
  On ARM, the following registers are used:
  
  	R0:	function argument word/integer result
  	R1-R3:	function argument word
12eba1b49   Jeroen Hofstee   README: update AR...
5481
5482
  	R9:	platform specific
  	R10:	stack limit (used only if stack checking is enabled)
2729af9d5   wdenk   * Fix minor NAND ...
5483
5484
5485
5486
5487
  	R11:	argument (frame) pointer
  	R12:	temporary workspace
  	R13:	stack pointer
  	R14:	link register
  	R15:	program counter
12eba1b49   Jeroen Hofstee   README: update AR...
5488
5489
5490
      ==> U-Boot will use R9 to hold a pointer to the global data
  
      Note: on ARM, only R_ARM_RELATIVE relocations are supported.
2729af9d5   wdenk   * Fix minor NAND ...
5491

0df01fd3d   Thomas Chou   nios2: fix r15 is...
5492
5493
5494
5495
5496
5497
5498
  On Nios II, the ABI is documented here:
  	http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
  
      ==> U-Boot will use gp to hold a pointer to the global data
  
      Note: on Nios II, we give "-G0" option to gcc and don't use gp
      to access small data sections, so gp is free.
afc1ce828   Macpaul Lin   doc/README: docum...
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
  On NDS32, the following registers are used:
  
  	R0-R1:	argument/return
  	R2-R5:	argument
  	R15:	temporary register for assembler
  	R16:	trampoline register
  	R28:	frame pointer (FP)
  	R29:	global pointer (GP)
  	R30:	link register (LP)
  	R31:	stack pointer (SP)
  	PC:	program counter (PC)
  
      ==> U-Boot will use R10 to hold a pointer to the global data
d87080b72   Wolfgang Denk   GCC-4.x fixes: cl...
5512
5513
  NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
  or current versions of GCC may "optimize" the code too much.
2729af9d5   wdenk   * Fix minor NAND ...
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
  
  Memory Management:
  ------------------
  
  U-Boot runs in system state and uses physical addresses, i.e. the
  MMU is not used either for address mapping nor for memory protection.
  
  The available memory is mapped to fixed addresses using the memory
  controller. In this process, a contiguous block is formed for each
  memory type (Flash, SDRAM, SRAM), even when it consists of several
  physical memory banks.
  
  U-Boot is installed in the first 128 kB of the first Flash bank (on
  TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
  booting and sizing and initializing DRAM, the code relocates itself
  to the upper end of DRAM. Immediately below the U-Boot code some
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
5530
  memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
2729af9d5   wdenk   * Fix minor NAND ...
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
  configuration setting]. Below that, a structure with global Board
  Info data is placed, followed by the stack (growing downward).
  
  Additionally, some exception handler code is copied to the low 8 kB
  of DRAM (0x00000000 ... 0x00001FFF).
  
  So a typical memory configuration with 16 MB of DRAM could look like
  this:
  
  	0x0000 0000	Exception Vector code
  	      :
  	0x0000 1FFF
  	0x0000 2000	Free for Application Use
  	      :
  	      :
  
  	      :
  	      :
  	0x00FB FF20	Monitor Stack (Growing downward)
  	0x00FB FFAC	Board Info Data and permanent copy of global data
  	0x00FC 0000	Malloc Arena
  	      :
  	0x00FD FFFF
  	0x00FE 0000	RAM Copy of Monitor Code
  	...		eventually: LCD or video framebuffer
  	...		eventually: pRAM (Protected RAM - unchanged by reset)
  	0x00FF FFFF	[End of RAM]
  
  
  System Initialization:
  ----------------------
c609719b8   wdenk   Initial revision
5562

2729af9d5   wdenk   * Fix minor NAND ...
5563
  In the reset configuration, U-Boot starts at the reset entry point
11ccc33fa   Marcel Ziswiler   Many spelling fix...
5564
  (on most PowerPC systems at address 0x00000100). Because of the reset
b445bbb49   Jeremiah Mahler   doc: fix grammati...
5565
  configuration for CS0# this is a mirror of the on board Flash memory.
2729af9d5   wdenk   * Fix minor NAND ...
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
  To be able to re-map memory U-Boot then jumps to its link address.
  To be able to implement the initialization code in C, a (small!)
  initial stack is set up in the internal Dual Ported RAM (in case CPUs
  which provide such a feature like MPC8xx or MPC8260), or in a locked
  part of the data cache. After that, U-Boot initializes the CPU core,
  the caches and the SIU.
  
  Next, all (potentially) available memory banks are mapped using a
  preliminary mapping. For example, we put them on 512 MB boundaries
  (multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
  on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
  programmed for SDRAM access. Using the temporary configuration, a
  simple memory test is run that determines the size of the SDRAM
  banks.
  
  When there is more than one SDRAM bank, and the banks are of
  different size, the largest is mapped first. For equal size, the first
  bank (CS2#) is mapped first. The first mapping is always for address
  0x00000000, with any additional banks following immediately to create
  contiguous memory starting from 0.
  
  Then, the monitor installs itself at the upper end of the SDRAM area
  and allocates memory for use by malloc() and for the global Board
  Info data; also, the exception vector code is copied to the low RAM
  pages, and the final stack is set up.
  
  Only after this relocation will you have a "normal" C environment;
  until that you are restricted in several ways, mostly because you are
  running from ROM, and because the code will have to be relocated to a
  new address in RAM.
  
  
  U-Boot Porting Guide:
  ----------------------
c609719b8   wdenk   Initial revision
5600

2729af9d5   wdenk   * Fix minor NAND ...
5601
5602
  [Based on messages by Jerry Van Baren in the U-Boot-Users mailing
  list, October 2002]
c609719b8   wdenk   Initial revision
5603

6c3fef28b   Jerry Van Baren   Improve U-Boot Po...
5604
  int main(int argc, char *argv[])
2729af9d5   wdenk   * Fix minor NAND ...
5605
5606
  {
  	sighandler_t no_more_time;
c609719b8   wdenk   Initial revision
5607

6c3fef28b   Jerry Van Baren   Improve U-Boot Po...
5608
5609
  	signal(SIGALRM, no_more_time);
  	alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
c609719b8   wdenk   Initial revision
5610

2729af9d5   wdenk   * Fix minor NAND ...
5611
  	if (available_money > available_manpower) {
6c3fef28b   Jerry Van Baren   Improve U-Boot Po...
5612
  		Pay consultant to port U-Boot;
c609719b8   wdenk   Initial revision
5613
5614
  		return 0;
  	}
2729af9d5   wdenk   * Fix minor NAND ...
5615
  	Download latest U-Boot source;
0668236ba   Wolfgang Denk   README: update ma...
5616
  	Subscribe to u-boot mailing list;
2729af9d5   wdenk   * Fix minor NAND ...
5617

6c3fef28b   Jerry Van Baren   Improve U-Boot Po...
5618
5619
  	if (clueless)
  		email("Hi, I am new to U-Boot, how do I get started?");
2729af9d5   wdenk   * Fix minor NAND ...
5620
5621
5622
  
  	while (learning) {
  		Read the README file in the top level directory;
6c3fef28b   Jerry Van Baren   Improve U-Boot Po...
5623
5624
  		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
  		Read applicable doc/*.README;
2729af9d5   wdenk   * Fix minor NAND ...
5625
  		Read the source, Luke;
6c3fef28b   Jerry Van Baren   Improve U-Boot Po...
5626
  		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
2729af9d5   wdenk   * Fix minor NAND ...
5627
  	}
6c3fef28b   Jerry Van Baren   Improve U-Boot Po...
5628
5629
5630
  	if (available_money > toLocalCurrency ($2500))
  		Buy a BDI3000;
  	else
2729af9d5   wdenk   * Fix minor NAND ...
5631
  		Add a lot of aggravation and time;
2729af9d5   wdenk   * Fix minor NAND ...
5632

6c3fef28b   Jerry Van Baren   Improve U-Boot Po...
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
  	if (a similar board exists) {	/* hopefully... */
  		cp -a board/<similar> board/<myboard>
  		cp include/configs/<similar>.h include/configs/<myboard>.h
  	} else {
  		Create your own board support subdirectory;
  		Create your own board include/configs/<myboard>.h file;
  	}
  	Edit new board/<myboard> files
  	Edit new include/configs/<myboard>.h
  
  	while (!accepted) {
  		while (!running) {
  			do {
  				Add / modify source code;
  			} until (compiles);
  			Debug;
  			if (clueless)
  				email("Hi, I am having problems...");
  		}
  		Send patch file to the U-Boot email list;
  		if (reasonable critiques)
  			Incorporate improvements from email list code review;
  		else
  			Defend code as written;
2729af9d5   wdenk   * Fix minor NAND ...
5657
  	}
2729af9d5   wdenk   * Fix minor NAND ...
5658
5659
5660
5661
5662
5663
5664
5665
  
  	return 0;
  }
  
  void no_more_time (int sig)
  {
        hire_a_guru();
  }
c609719b8   wdenk   Initial revision
5666

2729af9d5   wdenk   * Fix minor NAND ...
5667
5668
  Coding Standards:
  -----------------
c609719b8   wdenk   Initial revision
5669

2729af9d5   wdenk   * Fix minor NAND ...
5670
  All contributions to U-Boot should conform to the Linux kernel
2c0516517   Detlev Zundel   Added changelog e...
5671
  coding style; see the file "Documentation/CodingStyle" and the script
7ca9296e1   Wolfgang Denk   README: udate Cod...
5672
  "scripts/Lindent" in your Linux kernel source directory.
2c0516517   Detlev Zundel   Added changelog e...
5673
5674
5675
  
  Source files originating from a different project (for example the
  MTD subsystem) are generally exempt from these guidelines and are not
b445bbb49   Jeremiah Mahler   doc: fix grammati...
5676
  reformatted to ease subsequent migration to newer versions of those
2c0516517   Detlev Zundel   Added changelog e...
5677
5678
5679
5680
5681
  sources.
  
  Please note that U-Boot is implemented in C (and to some small parts in
  Assembler); no C++ is used, so please do not use C++ style comments (//)
  in your code.
c609719b8   wdenk   Initial revision
5682

2729af9d5   wdenk   * Fix minor NAND ...
5683
5684
  Please also stick to the following formatting rules:
  - remove any trailing white space
7ca9296e1   Wolfgang Denk   README: udate Cod...
5685
  - use TAB characters for indentation and vertical alignment, not spaces
2729af9d5   wdenk   * Fix minor NAND ...
5686
5687
  - make sure NOT to use DOS '\r
  ' line feeds
7ca9296e1   Wolfgang Denk   README: udate Cod...
5688
  - do not add more than 2 consecutive empty lines to source files
2729af9d5   wdenk   * Fix minor NAND ...
5689
  - do not add trailing empty lines to source files
180d3f74e   wdenk   * Fix problems ca...
5690

2729af9d5   wdenk   * Fix minor NAND ...
5691
5692
  Submissions which do not conform to the standards may be returned
  with a request to reformat the changes.
c609719b8   wdenk   Initial revision
5693

2729af9d5   wdenk   * Fix minor NAND ...
5694
5695
  Submitting Patches:
  -------------------
c609719b8   wdenk   Initial revision
5696

2729af9d5   wdenk   * Fix minor NAND ...
5697
5698
5699
  Since the number of patches for U-Boot is growing, we need to
  establish some rules. Submissions which do not conform to these rules
  may be rejected, even when they contain important and valuable stuff.
c609719b8   wdenk   Initial revision
5700

0d28f34bb   Magnus Lilja   Update the U-Boot...
5701
  Please see http://www.denx.de/wiki/U-Boot/Patches for details.
218ca724c   Wolfgang Denk   README: update do...
5702

0668236ba   Wolfgang Denk   README: update ma...
5703
5704
  Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
  see http://lists.denx.de/mailman/listinfo/u-boot
2729af9d5   wdenk   * Fix minor NAND ...
5705
5706
  When you send a patch, please include the following information with
  it:
c609719b8   wdenk   Initial revision
5707

2729af9d5   wdenk   * Fix minor NAND ...
5708
5709
5710
  * For bug fixes: a description of the bug and how your patch fixes
    this bug. Please try to include a way of demonstrating that the
    patch actually fixes something.
c609719b8   wdenk   Initial revision
5711

2729af9d5   wdenk   * Fix minor NAND ...
5712
5713
  * For new features: a description of the feature and your
    implementation.
c609719b8   wdenk   Initial revision
5714

2729af9d5   wdenk   * Fix minor NAND ...
5715
  * A CHANGELOG entry as plaintext (separate from the patch)
c609719b8   wdenk   Initial revision
5716

7207b366d   Robert P. J. Day   doc: Tidy up firs...
5717
5718
  * For major contributions, add a MAINTAINERS file with your
    information and associated file and directory references.
c609719b8   wdenk   Initial revision
5719

27af930e9   Albert ARIBAUD   Merge and reforma...
5720
5721
  * When you add support for a new board, don't forget to add a
    maintainer e-mail address to the boards.cfg file, too.
c609719b8   wdenk   Initial revision
5722

2729af9d5   wdenk   * Fix minor NAND ...
5723
5724
  * If your patch adds new configuration options, don't forget to
    document these in the README file.
c609719b8   wdenk   Initial revision
5725

218ca724c   Wolfgang Denk   README: update do...
5726
5727
  * The patch itself. If you are using git (which is *strongly*
    recommended) you can easily generate the patch using the
7ca9296e1   Wolfgang Denk   README: udate Cod...
5728
    "git format-patch". If you then use "git send-email" to send it to
218ca724c   Wolfgang Denk   README: update do...
5729
5730
5731
5732
5733
5734
    the U-Boot mailing list, you will avoid most of the common problems
    with some other mail clients.
  
    If you cannot use git, use "diff -purN OLD NEW". If your version of
    diff does not support these options, then get the latest version of
    GNU diff.
c609719b8   wdenk   Initial revision
5735

218ca724c   Wolfgang Denk   README: update do...
5736
5737
5738
5739
    The current directory when running this command shall be the parent
    directory of the U-Boot source tree (i. e. please make sure that
    your patch includes sufficient directory information for the
    affected files).
6dff55297   wdenk   * Patches by Mart...
5740

218ca724c   Wolfgang Denk   README: update do...
5741
5742
    We prefer patches as plain text. MIME attachments are discouraged,
    and compressed attachments must not be used.
c609719b8   wdenk   Initial revision
5743

2729af9d5   wdenk   * Fix minor NAND ...
5744
5745
  * If one logical set of modifications affects or creates several
    files, all these changes shall be submitted in a SINGLE patch file.
52f52c149   wdenk   Patches by Robert...
5746

2729af9d5   wdenk   * Fix minor NAND ...
5747
5748
  * Changesets that contain different, unrelated modifications shall be
    submitted as SEPARATE patches, one patch per changeset.
8bde7f776   wdenk   * Code cleanup:
5749

52f52c149   wdenk   Patches by Robert...
5750

2729af9d5   wdenk   * Fix minor NAND ...
5751
  Notes:
c609719b8   wdenk   Initial revision
5752

6de80f219   Simon Glass   Drop references t...
5753
  * Before sending the patch, run the buildman script on your patched
2729af9d5   wdenk   * Fix minor NAND ...
5754
5755
    source tree and make sure that no errors or warnings are reported
    for any of the boards.
c609719b8   wdenk   Initial revision
5756

2729af9d5   wdenk   * Fix minor NAND ...
5757
5758
5759
  * Keep your modifications to the necessary minimum: A patch
    containing several unrelated changes or arbitrary reformats will be
    returned with a request to re-formatting / split it.
c609719b8   wdenk   Initial revision
5760

2729af9d5   wdenk   * Fix minor NAND ...
5761
5762
5763
5764
5765
5766
  * If you modify existing code, make sure that your new code does not
    add to the memory footprint of the code ;-) Small is beautiful!
    When adding new features, these should compile conditionally only
    (using #ifdef), and the resulting code with the new feature
    disabled must not need more memory than the old code without your
    modification.
90dc67049   wdenk   README: add expla...
5767

0668236ba   Wolfgang Denk   README: update ma...
5768
5769
5770
5771
  * Remember that there is a size limit of 100 kB per message on the
    u-boot mailing list. Bigger patches will be moderated. If they are
    reasonable and not too big, they will be acknowledged. But patches
    bigger than the size limit should be avoided.