Blame view

README 174 KB
83d290c56   Tom Rini   SPDX: Convert all...
1
  # SPDX-License-Identifier: GPL-2.0+
c609719b8   wdenk   Initial revision
2
  #
eca3aeb35   Wolfgang Denk   Licenses: introdu...
3
  # (C) Copyright 2000 - 2013
c609719b8   wdenk   Initial revision
4
  # Wolfgang Denk, DENX Software Engineering, wd@denx.de.
c609719b8   wdenk   Initial revision
5
6
7
  
  Summary:
  ========
24ee89b97   wdenk   * Fix mdelay() on...
8
  This directory contains the source code for U-Boot, a boot loader for
e86e5a074   wdenk   Code cleanup for ...
9
10
11
12
  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
13
14
  
  The development of U-Boot is closely related to Linux: some parts of
24ee89b97   wdenk   * Fix mdelay() on...
15
16
  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
17
18
19
20
21
22
23
24
25
26
27
28
29
30
  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...
31
  Makefile have been tested to some extent and can be considered
c609719b8   wdenk   Initial revision
32
  "working". In fact, many of them are used in production systems.
7207b366d   Robert P. J. Day   doc: Tidy up firs...
33
34
35
36
  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
37

7207b366d   Robert P. J. Day   doc: Tidy up firs...
38
39
40
  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...
41
42
  
  	make CHANGELOG
c609719b8   wdenk   Initial revision
43
44
45
  
  Where to get help:
  ==================
24ee89b97   wdenk   * Fix mdelay() on...
46
  In case you have questions about, problems with or contributions for
7207b366d   Robert P. J. Day   doc: Tidy up firs...
47
  U-Boot, you should send a message to the U-Boot mailing list at
0c32565f5   Peter Tyser   Update mailing li...
48
49
50
51
  <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
52

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

93f19cc0e   wdenk   Prepare for relea...
105
106
  Versioning:
  ===========
360d883aa   Thomas Weber   README: Fix descr...
107
108
109
110
111
112
113
114
  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...
115
  	U-Boot v2009.11	    - Release November 2009
360d883aa   Thomas Weber   README: Fix descr...
116
  	U-Boot v2009.11.1   - Release 1 in version November 2009 stable tree
0de21ecbe   Jelle van der Waa   README: fix typo ...
117
  	U-Boot v2010.09-rc1 - Release candidate 1 for September 2010 release
93f19cc0e   wdenk   Prepare for relea...
118

c609719b8   wdenk   Initial revision
119
120
  Directory Hierarchy:
  ====================
8d321b81c   Peter Tyser   Update README to ...
121
  /arch			Architecture specific files
6eae68e45   Masahiro Yamada   cosmetic: README:...
122
    /arc			Files generic to ARC architecture
8d321b81c   Peter Tyser   Update README to ...
123
    /arm			Files generic to ARM architecture
8d321b81c   Peter Tyser   Update README to ...
124
    /m68k			Files generic to m68k architecture
8d321b81c   Peter Tyser   Update README to ...
125
    /microblaze		Files generic to microblaze architecture
8d321b81c   Peter Tyser   Update README to ...
126
    /mips			Files generic to MIPS architecture
afc1ce828   Macpaul Lin   doc/README: docum...
127
    /nds32		Files generic to NDS32 architecture
8d321b81c   Peter Tyser   Update README to ...
128
    /nios2		Files generic to Altera NIOS2 architecture
33c7731bd   Robert P. J. Day   Cosmetic: Update ...
129
    /openrisc		Files generic to OpenRISC architecture
a47a12bec   Stefan Roese   Move arch/ppc to ...
130
    /powerpc		Files generic to PowerPC architecture
3fafced74   Rick Chen   riscv: doc: Add r...
131
    /riscv		Files generic to RISC-V architecture
7207b366d   Robert P. J. Day   doc: Tidy up firs...
132
    /sandbox		Files generic to HW-independent "sandbox"
8d321b81c   Peter Tyser   Update README to ...
133
    /sh			Files generic to SH architecture
33c7731bd   Robert P. J. Day   Cosmetic: Update ...
134
    /x86			Files generic to x86 architecture
8d321b81c   Peter Tyser   Update README to ...
135
136
  /api			Machine/arch independent API for external apps
  /board			Board dependent files
740f7e5c1   Xu Ziyuan   README: add cmd d...
137
  /cmd			U-Boot commands functions
8d321b81c   Peter Tyser   Update README to ...
138
  /common			Misc architecture independent functions
7207b366d   Robert P. J. Day   doc: Tidy up firs...
139
  /configs		Board default configuration files
8d321b81c   Peter Tyser   Update README to ...
140
141
142
  /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 ...
143
  /dts			Contains Makefile for building internal U-Boot fdt.
8d321b81c   Peter Tyser   Update README to ...
144
145
146
  /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...
147
148
  /lib			Library routines generic to all architectures
  /Licenses		Various license files
8d321b81c   Peter Tyser   Update README to ...
149
150
  /net			Networking code
  /post			Power On Self Test
7207b366d   Robert P. J. Day   doc: Tidy up firs...
151
152
  /scripts		Various build scripts and Makefiles
  /test			Various unit test files
8d321b81c   Peter Tyser   Update README to ...
153
  /tools			Tools to build S-Record or U-Boot images, etc.
c609719b8   wdenk   Initial revision
154

c609719b8   wdenk   Initial revision
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
  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...
170
    "CONFIG_SYS_".
c609719b8   wdenk   Initial revision
171

7207b366d   Robert P. J. Day   doc: Tidy up firs...
172
173
174
175
176
  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
177
178
179
180
181
182
  
  
  Selection of Processor Architecture and Board Type:
  ---------------------------------------------------
  
  For all supported boards there are ready-to-use default
ab584d67c   Holger Freyther   The _config targe...
183
  configurations available; just type "make <board_name>_defconfig".
c609719b8   wdenk   Initial revision
184
185
186
187
  
  Example: For a TQM823L module type:
  
  	cd u-boot
ab584d67c   Holger Freyther   The _config targe...
188
  	make TQM823L_defconfig
c609719b8   wdenk   Initial revision
189

7207b366d   Robert P. J. Day   doc: Tidy up firs...
190
191
192
  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
193

75b3c3aa8   Simon Glass   sandbox: Update a...
194
195
196
197
198
199
200
  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...
201
  See board/sandbox/README.sandbox for more details.
75b3c3aa8   Simon Glass   sandbox: Update a...
202

db910353a   Simon Glass   arm: spl: Allow b...
203
204
205
206
  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...
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
  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...
223

7207b366d   Robert P. J. Day   doc: Tidy up firs...
224
225
  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...
226
227
228
229
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
  
  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
0680f1b1f   Ley Foon Tan   Convert CONFIG_SP...
278
  		done by selecting CONFIG_SPL_BOARD_INIT and then supplying a
db910353a   Simon Glass   arm: spl: Allow b...
279
280
  		spl_board_init() function containing this call
  	- loads U-Boot or (in falcon mode) Linux
c609719b8   wdenk   Initial revision
281
282
283
284
285
286
287
288
289
  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,...
290
291
292
  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.
63b2316c5   Ashish Kumar   fsl-layerscape: C...
293
294
295
296
297
298
299
300
301
  - ARM Platform Bus Type(CCI):
  		CoreLink Cache Coherent Interconnect (CCI) is ARM BUS which
  		provides full cache coherency between two clusters of multi-core
  		CPUs and I/O coherency for devices and I/O masters
  
  		CONFIG_SYS_FSL_HAS_CCI400
  
  		Defined For SoC that has cache coherent interconnect
  		CCN-400
7f6c2cbc2   wdenk   * Vince Husovsky,...
302

c055cee19   Ashish Kumar   armv8: fsl-lsch3:...
303
304
305
  		CONFIG_SYS_FSL_HAS_CCN504
  
  		Defined for SoC that has cache coherent interconnect CCN-504
c609719b8   wdenk   Initial revision
306
  The following options need to be configured:
2628114ec   Kim Phillips   README: Remove ou...
307
308
309
  - CPU Type:	Define exactly one, e.g. CONFIG_MPC85XX.
  
  - Board Type:	Define exactly one, e.g. CONFIG_MPC8540ADS.
6ccec4492   Wolfgang Denk   Add ATSTK1000 and...
310

66412c637   Kumar Gala   powerpc/85xx: Cha...
311
  - 85xx CPU Options:
ffd06e023   York Sun   powerpc/mpc85xx: ...
312
313
314
315
316
  		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...
317
318
319
320
321
  		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: ...
322
323
324
325
  		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...
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
  		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...
345
346
  		CONFIG_A003399_NOR_WORKAROUND
  		Enables a workaround for IFC erratum A003399. It is only
b445bbb49   Jeremiah Mahler   doc: fix grammati...
347
  		required during NOR boot.
74fa22ed7   Prabhakar Kushwaha   powerpc/mpc85xx:N...
348

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

33eee330c   Scott Wood   powerpc/fsl-coren...
353
354
355
356
  		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:...
357
358
359
  		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:...
360
361
362
  		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:...
363
364
365
  		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:...
366
367
  		CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
  		This value denotes start offset of DSP CCSR space.
b135991a3   Priyanka Jain   powerpc/mpc85xx: ...
368
369
370
371
  		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: ...
372
373
  		CONFIG_SYS_CPC_REINIT_F
  		This CONFIG is defined when the CPC is configured as SRAM at the
a187559e3   Bin Meng   Use correct spell...
374
  		time of U-Boot entry and is required to be re-initialized.
fb4a2409b   Aneesh Bansal   powerpc/mpc85xx: ...
375

aade20046   Tang Yuantian   mpc85xx/t104x: Ad...
376
  		CONFIG_DEEP_SLEEP
b445bbb49   Jeremiah Mahler   doc: fix grammati...
377
  		Indicates this SoC supports deep sleep feature. If deep sleep is
aade20046   Tang Yuantian   mpc85xx/t104x: Ad...
378
  		supported, core will start to execute uboot when wakes up.
6cb461b4f   Daniel Schwierzeck   MIPS: fix endiane...
379
380
381
382
383
  - Generic CPU options:
  		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...
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
  		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...
404
405
  		CONFIG_SYS_FSL_DDRC_GEN4
  		Freescale DDR4 controller.
9ac4ffbde   York Sun   Driver/DDR: Add F...
406
407
  		CONFIG_SYS_FSL_DDRC_ARM_GEN3
  		Freescale DDR3 controller for ARM-based SoCs.
5614e71b4   York Sun   Driver/DDR: Movin...
408
409
410
411
412
413
  		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...
414
  		Board config to use DDR2. It can be enabled for SoCs with
5614e71b4   York Sun   Driver/DDR: Movin...
415
416
417
418
419
  		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...
420
421
422
423
424
425
426
427
428
  		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...
429

1b4175d6f   Prabhakar Kushwaha   driver/ifc:Change...
430
431
432
433
434
  		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...
435
436
  		CONFIG_SYS_FSL_IFC_CLK_DIV
  		Defines divider of platform clock(clock input to IFC controller).
add63f94a   Prabhakar Kushwaha   arch: powerpc: up...
437
438
  		CONFIG_SYS_FSL_LBC_CLK_DIV
  		Defines divider of platform clock(clock input to eLBC controller).
690e42584   Prabhakar Kushwaha   powerpc:Rename CO...
439
440
441
442
443
444
445
446
  		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
4e5b1bd0d   York Sun   driver/ddr: Chang...
447
448
449
450
451
  		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...
452
453
454
455
  		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...
456
457
458
459
  		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...
460
461
462
463
464
  		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...
465
466
  		CONFIG_SYS_FSL_HAS_DP_DDR
  		Defines the SoC has DP-DDR used for DPAA.
028dbb8db   Ruchika Gupta   fsl_sec : Change ...
467
468
469
470
471
  		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...
472
473
474
475
476
477
  - 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.
92bbd64e3   Daniel Schwierzeck   README: update MI...
478
479
480
481
482
  		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...
483
484
485
486
487
  - 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.
207774b21   York Sun   armv8/ls2085a: Fi...
488
489
490
491
492
493
494
  		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...
495
496
497
498
499
500
  - 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...
501
  - Linux Kernel Interface:
c609719b8   wdenk   Initial revision
502
503
504
505
506
507
508
509
510
  		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
511
  		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
218ca724c   Wolfgang Denk   README: update do...
512
  		"clocks_in_mhz=1" is automatically included in the
c609719b8   wdenk   Initial revision
513
  		default environment.
5da627a42   wdenk   * Patch by Steven...
514
  		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]
b445bbb49   Jeremiah Mahler   doc: fix grammati...
515
  		When transferring memsize parameter to Linux, some versions
5da627a42   wdenk   * Patch by Steven...
516
517
  		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...
518
  		CONFIG_OF_LIBFDT
f57f70aab   Wolfgang Denk   Support passing o...
519
520
  
  		New kernel versions are expecting firmware settings to be
213bf8c82   Gerald Van Baren   Add a flattened d...
521
522
523
524
525
526
  		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...
527
  		 * The bootm command automatically updates the fdt
213bf8c82   Gerald Van Baren   Add a flattened d...
528

f57f70aab   Wolfgang Denk   Support passing o...
529
  		OF_TBCLK - The timebase frequency.
c2871f038   Kumar Gala   Added OF_STDOUT_P...
530
  		OF_STDOUT_PATH - The path to the console device
f57f70aab   Wolfgang Denk   Support passing o...
531

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

4e2531378   Kumar Gala   Allow board code ...
535
536
537
538
  		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...
539

c654b5172   Simon Glass   fdt: Add ft_syste...
540
541
542
543
544
545
  		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...
546
547
548
549
550
551
552
553
  		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...
554
555
556
557
558
559
560
561
562
  		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 ...
563
564
565
  - vxWorks boot parameters:
  
  		bootvx constructs a valid bootline using the following
9e98b7e3c   Bin Meng   cmd: bootvx: Alwa...
566
567
  		environments variables: bootdev, bootfile, ipaddr, netmask,
  		serverip, gatewayip, hostname, othbootargs.
0b2f4ecad   Niklaus Giger   README: Document ...
568
  		It loads the vxWorks image pointed bootfile.
0b2f4ecad   Niklaus Giger   README: Document ...
569
570
  		Note: If a "bootargs" environment is defined, it will overwride
  		the defaults discussed just above.
2c451f783   Aneesh V   armv7: cache main...
571
  - Cache Configuration:
2c451f783   Aneesh V   armv7: cache main...
572
  		CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
93bc21930   Aneesh V   armv7: add PL310 ...
573
574
575
576
577
  - 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...
578
  - Serial Ports:
48d0192fe   Andreas Engel   Moved conditional...
579
  		CONFIG_PL010_SERIAL
6705d81e9   wdenk   * Patch by Andrea...
580
581
  
  		Define this if you want support for Amba PrimeCell PL010 UARTs.
48d0192fe   Andreas Engel   Moved conditional...
582
  		CONFIG_PL011_SERIAL
6705d81e9   wdenk   * Patch by Andrea...
583
584
585
586
587
588
589
590
591
592
593
594
595
  
  		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:...
596
597
598
599
  		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...
600

c609719b8   wdenk   Initial revision
601
602
603
  - Console Baudrate:
  		CONFIG_BAUDRATE - in bps
  		Select one of the baudrates listed in
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
604
  		CONFIG_SYS_BAUDRATE_TABLE, see below.
c609719b8   wdenk   Initial revision
605

c609719b8   wdenk   Initial revision
606
607
608
609
610
611
  - 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.
c609719b8   wdenk   Initial revision
612
  		CONFIG_RAMBOOT and CONFIG_NFSBOOT
43d9616cf   wdenk   * Patch by Robert...
613
614
615
  		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...
616
  		RAM and NFS.
c609719b8   wdenk   Initial revision
617

c609719b8   wdenk   Initial revision
618
619
620
621
622
623
624
625
  - 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...
626
  - Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
c609719b8   wdenk   Initial revision
627
628
  		CONFIG_KGDB_BAUDRATE
  		Select one of the baudrates listed in
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
629
  		CONFIG_SYS_BAUDRATE_TABLE, see below.
c609719b8   wdenk   Initial revision
630

302a64875   Simon Glass   Add an option to ...
631
632
633
634
635
636
637
  - 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 ...
638
639
  - Regular expression support:
  		CONFIG_REGEX
93e145964   Wolfgang Denk   Coding Style clea...
640
641
642
643
  		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 ...
644

45ba8077f   Simon Glass   fdt: ARM: Add dev...
645
646
647
648
649
650
651
  - 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 ...
652
  		U-Boot needs to get its device tree from somewhere. This can
82f766d1d   Alex Deymo   Allow boards to i...
653
  		be done using one of the three options below:
bbb0b128c   Simon Glass   fdt: Add support ...
654
655
656
657
658
659
  
  		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
eb3eb6020   Nobuhiro Iwamatsu   README: Fix typo ...
660
  		the global data structure as gd->fdt_blob.
45ba8077f   Simon Glass   fdt: ARM: Add dev...
661

2c0f79e44   Simon Glass   fdt: Add support ...
662
663
664
665
666
667
668
669
670
671
672
  		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.
82f766d1d   Alex Deymo   Allow boards to i...
673
674
675
676
677
  		CONFIG_OF_BOARD
  		If this variable is defined, U-Boot will use the device tree
  		provided by the board at runtime instead of embedding one with
  		the image. Only boards defining board_fdt_blob_setup() support
  		this option (see include/fdtdec.h file).
c609719b8   wdenk   Initial revision
678
679
680
  - Watchdog:
  		CONFIG_WATCHDOG
  		If this variable is defined, it enables watchdog
6abe6fb68   Detlev Zundel   README: Clarify d...
681
  		support for the SoC. There must be support in the SoC
907208c45   Christophe Leroy   powerpc: Partialy...
682
683
684
685
686
  		specific code for a watchdog. For the 8xx
  		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.
6abe6fb68   Detlev Zundel   README: Clarify d...
687
688
689
690
691
  
  		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
692
693
  
  - Real-Time Clock:
602ad3b33   Jon Loeliger   README: Rewrite c...
694
  		When CONFIG_CMD_DATE is selected, the type of the RTC
c609719b8   wdenk   Initial revision
695
696
  		has to be selected, too. Define exactly one of the
  		following options:
c609719b8   wdenk   Initial revision
697
  		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
4e8b7544b   Fabio Estevam   rtc: Make mc13783...
698
  		CONFIG_RTC_MC13XXX	- use MC13783 or MC13892 RTC
c609719b8   wdenk   Initial revision
699
  		CONFIG_RTC_MC146818	- use MC146818 RTC
1cb8e980c   wdenk   * Patches by Davi...
700
  		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
c609719b8   wdenk   Initial revision
701
  		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
7f70e8530   wdenk   * Patch by David ...
702
  		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
412921d29   Markus Niebel   RTC: add support ...
703
  		CONFIG_RTC_DS1339	- use Maxim, Inc. DS1339 RTC
3bac35137   wdenk   * Patch by Josef ...
704
  		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
9536dfcce   Tor Krill   Add support for I...
705
  		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
4c0d4c3b7   wdenk   * Patch by Tom Ar...
706
  		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
2bd3cab33   Chris Packham   rtc: ds1337: drop...
707
  		CONFIG_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
71d19f30d   Heiko Schocher   rtc, rv3029: add ...
708
709
  		CONFIG_SYS_RV3029_TCR	- enable trickle charger on
  					  RV3029 RTC.
c609719b8   wdenk   Initial revision
710

b37c7e5e5   wdenk   * Patch by Seb Ja...
711
712
  		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...
713
714
  - GPIO Support:
  		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
e92739d34   Peter Tyser   Add support for P...
715

5dec49ca2   Chris Packham   pca953x: support ...
716
717
718
  		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...
719
720
  		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...
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
  - 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
742
  - Timestamp Support:
43d9616cf   wdenk   * Patch by Robert...
743
744
745
  		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...
746
  		automatically enabled when you select CONFIG_CMD_DATE .
c609719b8   wdenk   Initial revision
747

923c46f97   Karl O. Pinc   README: Cleanup d...
748
749
750
  - Partition Labels (disklabels) Supported:
  		Zero or more of the following:
  		CONFIG_MAC_PARTITION   Apple's MacOS partition table.
923c46f97   Karl O. Pinc   README: Cleanup d...
751
752
753
754
  		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
c649e3c91   Simon Glass   dm: scsi: Rename ...
755
  		CONFIG_SCSI) you must configure support for at
923c46f97   Karl O. Pinc   README: Cleanup d...
756
  		least one non-MTD partition type as well.
c609719b8   wdenk   Initial revision
757
758
  
  - IDE Reset method:
4d13cbad1   wdenk   * Patch by Toluna...
759
760
  		CONFIG_IDE_RESET_ROUTINE - this is defined in several
  		board configurations files but used nowhere!
c609719b8   wdenk   Initial revision
761

4d13cbad1   wdenk   * Patch by Toluna...
762
763
764
765
  		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
766
767
768
769
770
  
  - ATAPI Support:
  		CONFIG_ATAPI
  
  		Set this to enable ATAPI support.
c40b29568   wdenk   * Patch by Rune T...
771
772
773
774
  - LBA48 Support
  		CONFIG_LBA48
  
  		Set this to enable support for disks larger than 137GB
4b142febf   Heiko Schocher   common: delete CO...
775
  		Also look at CONFIG_SYS_64BIT_LBA.
c40b29568   wdenk   * Patch by Rune T...
776
777
  		Whithout these , LBA48 support uses 32bit variables and will 'only'
  		support disks up to 2.1TB.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
778
  		CONFIG_SYS_64BIT_LBA:
c40b29568   wdenk   * Patch by Rune T...
779
780
  			When enabled, makes the IDE subsystem use 64bit sector addresses.
  			Default is 32bit.
c609719b8   wdenk   Initial revision
781
  - SCSI Support:
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
782
783
784
  		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
785
786
  		maximum numbers of LUNs, SCSI ID's and target
  		devices.
c609719b8   wdenk   Initial revision
787

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

c609719b8   wdenk   Initial revision
791
  - NETWORK Support (PCI):
682011ff6   wdenk   * Patches by Udi ...
792
  		CONFIG_E1000
ce5207e19   Kyle Moffett   e1000: Allow dire...
793
794
795
796
797
798
799
800
801
802
  		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.
c609719b8   wdenk   Initial revision
803
804
  		CONFIG_EEPRO100
  		Support for Intel 82557/82559/82559ER chips.
11ccc33fa   Marcel Ziswiler   Many spelling fix...
805
  		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
c609719b8   wdenk   Initial revision
806
807
808
809
810
811
812
813
814
815
816
817
  		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 ...
818
  - NETWORK Support (other):
c041e9d21   Jens Scharsig   new at91_emac net...
819
820
821
822
823
824
825
826
827
  		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 ...
828
829
  		CONFIG_CALXEDA_XGMAC
  		Support for the Calxeda XGMAC device
3bb46d23f   Ashok   README : Rename C...
830
  		CONFIG_LAN91C96
45219c466   wdenk   Patch by Mathijs ...
831
  		Support for SMSC's LAN91C96 chips.
45219c466   wdenk   Patch by Mathijs ...
832
833
  			CONFIG_LAN91C96_USE_32_BIT
  			Define this to enable 32 bit addressing
3bb46d23f   Ashok   README : Rename C...
834
  		CONFIG_SMC91111
f39748ae8   wdenk   * Patch by Paul R...
835
836
837
838
839
840
841
842
843
844
845
846
  		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...
847
848
  			CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
  			Define this if you have more then 3 PHYs.
b3dbf4a51   Macpaul Lin   ftgmac100: suppor...
849
850
851
852
853
854
855
856
857
858
859
  		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.
3d0075fa7   Yoshihiro Shimoda   README: add descr...
860
861
862
863
864
865
866
867
  		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 ...
868
869
  			CONFIG_SH_ETHER_CACHE_WRITEBACK
  			If this option is set, the driver enables cache flush.
b2f97cf27   Heiko Schocher   pwm, imx6: add su...
870
871
  - PWM Support:
  		CONFIG_PWM_IMX
5052e8198   Robert P. J. Day   PWM: Correct miss...
872
  		Support for PWM module on the imx6.
b2f97cf27   Heiko Schocher   pwm, imx6: add su...
873

5e1247247   Vadim Bendebury   Introduce generic...
874
  - TPM Support:
90899cc01   Che-liang Chiou   tpm: Rename gener...
875
876
  		CONFIG_TPM
  		Support TPM devices.
0766ad2f7   Christophe Ricard   dm: tpm: Move tpm...
877
878
  		CONFIG_TPM_TIS_INFINEON
  		Support for Infineon i2c bus TPM devices. Only one device
1b393db58   Tom Wai-Hong Tam   tpm: Reorganize t...
879
  		per system is supported at this time.
1b393db58   Tom Wai-Hong Tam   tpm: Reorganize t...
880
881
  			CONFIG_TPM_TIS_I2C_BURST_LIMITATION
  			Define the burst count bytes upper limit
3aa74088d   Christophe Ricard   tpm: st33zp24: Ad...
882
883
884
885
886
887
  		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...
888
889
890
  			CONFIG_TPM_ST33ZP24_SPI
  			Support for STMicroelectronics ST33ZP24 SPI devices.
  			Requires TPM_ST33ZP24 and SPI.
c01939c76   Dirk Eibach   Add Atmel I2C tpm
891
892
  		CONFIG_TPM_ATMEL_TWI
  		Support for Atmel TWI TPM device. Requires I2C support.
90899cc01   Che-liang Chiou   tpm: Rename gener...
893
  		CONFIG_TPM_TIS_LPC
5e1247247   Vadim Bendebury   Introduce generic...
894
895
896
897
898
899
900
  		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...
901
902
903
904
905
906
907
908
  		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
909
910
  - USB Support:
  		At the moment only the UHCI host controller is
064b55cfc   Heiko Schocher   powerpc, 5xxx, 51...
911
  		supported (PIP405, MIP405); define
c609719b8   wdenk   Initial revision
912
913
  		CONFIG_USB_UHCI to enable it.
  		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
30d56fae2   wdenk   Patch by Sam Song...
914
  		and define CONFIG_USB_STORAGE to enable the USB
c609719b8   wdenk   Initial revision
915
916
917
918
  		storage devices.
  		Note:
  		Supported are USB Keyboards and USB Floppy drives
  		(TEAC FD-05PUB).
4d13cbad1   wdenk   * Patch by Toluna...
919

9ab4ce223   Simon Glass   usb: Add support ...
920
921
  		CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
  		txfilltuning field in the EHCI controller on reset.
6e9e06260   Oleksandr Tymoshenko   usb: dwc2: Add dr...
922
923
  		CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
  		HW module registers.
16c8d5e76   Wolfgang Denk   Various USB relat...
924
925
926
927
  - 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...
928
  		attach your USB cable. The Unix command "dmesg" should print
16c8d5e76   Wolfgang Denk   Various USB relat...
929
930
  		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
931
  		appear to a USB host as a Linux gserial device or a
16c8d5e76   Wolfgang Denk   Various USB relat...
932
933
934
935
936
937
938
  		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
939

16c8d5e76   Wolfgang Denk   Various USB relat...
940
941
942
943
944
945
  			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
946

f9da0f894   Vipin KUMAR   Enable high speed...
947
948
949
950
951
952
953
  			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...
954
  			CONFIG_SYS_CONSOLE_IS_IN_ENV
16c8d5e76   Wolfgang Denk   Various USB relat...
955
956
  			Define this if you want stdin, stdout &/or stderr to
  			be set to usbtty.
386eda022   Wolfgang Denk   Code cleanup
957
  		If you have a USB-IF assigned VendorID then you may wish to
16c8d5e76   Wolfgang Denk   Various USB relat...
958
  		define your own vendor specific values either in BoardName.h
386eda022   Wolfgang Denk   Code cleanup
959
  		or directly in usbd_vendor_info.h. If you don't define
16c8d5e76   Wolfgang Denk   Various USB relat...
960
961
962
963
964
965
966
  		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
967

16c8d5e76   Wolfgang Denk   Various USB relat...
968
969
970
971
972
973
974
975
976
  			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
977

16c8d5e76   Wolfgang Denk   Various USB relat...
978
979
980
981
  			CONFIG_USBD_PRODUCTID
  			Define this as the unique Product ID
  			for your device
  			- CONFIG_USBD_PRODUCTID 0xFFFF
4d13cbad1   wdenk   * Patch by Toluna...
982

d70a560fd   Igor Grinberg   README: add docum...
983
984
985
986
987
988
989
990
  - 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 ...
991
992
993
  		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
994

71f951180   wdenk   * Fix CONFIG_NET_...
995
  - MMC Support:
8bde7f776   wdenk   * Code cleanup:
996
997
998
  		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_...
999
  		to physical memory similar to flash. Command line is
602ad3b33   Jon Loeliger   README: Rewrite c...
1000
1001
  		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_...
1002

afb35666d   Yoshihiro Shimoda   mmc: sh_mmcif: ad...
1003
1004
1005
1006
1007
1008
1009
1010
  		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
b3ba6e94b   Tom Rini   README: Document ...
1011
  - USB Device Firmware Update (DFU) class support:
bb4059a53   Marek Vasut   dfu: Rename _FUNC...
1012
  		CONFIG_DFU_OVER_USB
b3ba6e94b   Tom Rini   README: Document ...
1013
  		This enables the USB portion of the DFU USB class
c6631764c   Pantelis Antoniou   dfu: NAND specifi...
1014
1015
  		CONFIG_DFU_NAND
  		This enables support for exposing NAND devices via DFU.
a9479f043   Afzal Mohammed   dfu: ram support
1016
1017
1018
1019
1020
  		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...
1021
1022
1023
1024
1025
  		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...
1026
1027
1028
1029
1030
1031
  		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...
1032
1033
1034
1035
1036
1037
1038
1039
1040
  		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.
6705d81e9   wdenk   * Patch by Andrea...
1041
  - Journaling Flash filesystem support:
b2482dffa   Simon Glass   README: Drop unus...
1042
  		CONFIG_JFFS2_NAND
6705d81e9   wdenk   * Patch by Andrea...
1043
  		Define these for a default partition on a NAND device
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
1044
1045
  		CONFIG_SYS_JFFS2_FIRST_SECTOR,
  		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
6705d81e9   wdenk   * Patch by Andrea...
1046
  		Define these for a default partition on a NOR device
c609719b8   wdenk   Initial revision
1047
  - Keyboard Support:
39f615ed8   Simon Glass   video: input: Cle...
1048
1049
1050
1051
1052
1053
1054
1055
1056
  		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
1057
1058
  
  - Video support:
7d3053fbf   Timur Tabi   powerpc: clean up...
1059
  		CONFIG_FSL_DIU_FB
04e5ae793   Wolfgang Denk   Minor coding styl...
1060
  		Enable the Freescale DIU video driver.	Reference boards for
7d3053fbf   Timur Tabi   powerpc: clean up...
1061
1062
1063
1064
1065
  		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
7d3053fbf   Timur Tabi   powerpc: clean up...
1066
1067
1068
1069
1070
  			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...
1071
1072
  		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...
1073
  		boot.  See the documentation file doc/README.video for a
ba8e76bd4   Timur Tabi   powerpc: use 'vid...
1074
  		description of this variable.
7d3053fbf   Timur Tabi   powerpc: clean up...
1075

c609719b8   wdenk   Initial revision
1076
1077
1078
1079
1080
  - 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
1081
1082
1083
  		CONFIG_ATMEL_LCD:
  
  			HITACHI TX09D70VM1CCA, 3.5", 240x320.
fd3103bb8   wdenk   Add support for B...
1084
  		CONFIG_NEC_NL6448AC33:
c609719b8   wdenk   Initial revision
1085

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

fd3103bb8   wdenk   Add support for B...
1088
  		CONFIG_NEC_NL6448BC20
c609719b8   wdenk   Initial revision
1089

fd3103bb8   wdenk   Add support for B...
1090
1091
1092
1093
1094
1095
  			NEC NL6448BC20-08. 6.5", 640x480.
  			Active, color, single scan.
  
  		CONFIG_NEC_NL6448BC33_54
  
  			NEC NL6448BC33-54. 10.4", 640x480.
c609719b8   wdenk   Initial revision
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
  			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.
676d319ef   Simon Glass   lcd: Add CONFIG_L...
1122
  		CONFIG_LCD_ALIGNMENT
b445bbb49   Jeremiah Mahler   doc: fix grammati...
1123
  		Normally the LCD is page-aligned (typically 4KB). If this is
676d319ef   Simon Glass   lcd: Add CONFIG_L...
1124
1125
1126
1127
  		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...
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
  		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...
1147
1148
1149
  		CONFIG_LCD_BMP_RLE8
  
  		Support drawing of RLE8-compressed bitmaps on the LCD.
735987c5a   Tom Wai-Hong Tam   edid: Add I2C com...
1150
1151
1152
1153
  		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...
1154
  - Splash Screen Support: CONFIG_SPLASH_SCREEN
d791b1dc3   wdenk   * Make sure Block...
1155

8bde7f776   wdenk   * Code cleanup:
1156
1157
1158
  		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...
1159
  		is suppressed and the BMP image at the address
8bde7f776   wdenk   * Code cleanup:
1160
1161
1162
1163
  		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...
1164

c08804853   Nikita Kiryanov   lcd: implement a ...
1165
1166
1167
1168
  		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...
1169
  		(see doc/README.displaying-bmps).
c08804853   Nikita Kiryanov   lcd: implement a ...
1170
1171
1172
1173
1174
  		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...
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
  		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...
1194
1195
1196
1197
1198
  - 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...
1199
1200
1201
1202
1203
  - 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...
1204
  - Compression support:
8ef704784   Kees Cook   documentation: ad...
1205
1206
1207
  		CONFIG_GZIP
  
  		Enabled by default to support gzip compressed images.
c29fdfc1d   wdenk   Patch by Yuli Bar...
1208
1209
1210
1211
1212
  		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...
1213
  		NOTE: the bzip2 algorithm requires a lot of RAM, so
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
1214
  		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
42d1f0394   wdenk   * Patches by Xian...
1215
  		be at least 4MB.
d791b1dc3   wdenk   * Make sure Block...
1216

17ea11774   wdenk   Patch by Tolunay ...
1217
  - MII/PHY support:
17ea11774   wdenk   Patch by Tolunay ...
1218
1219
1220
  		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
  
  		The clock frequency of the MII bus
17ea11774   wdenk   Patch by Tolunay ...
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
  		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
1232
1233
1234
1235
  - IP address:
  		CONFIG_IPADDR
  
  		Define a default value for the IP address to use for
11ccc33fa   Marcel Ziswiler   Many spelling fix...
1236
  		the default Ethernet interface, in case this is not
c609719b8   wdenk   Initial revision
1237
  		determined through e.g. bootp.
1ebcd6547   Wolfgang Denk   README: improve d...
1238
  		(Environment variable "ipaddr")
c609719b8   wdenk   Initial revision
1239
1240
1241
  
  - Server IP address:
  		CONFIG_SERVERIP
11ccc33fa   Marcel Ziswiler   Many spelling fix...
1242
  		Defines a default value for the IP address of a TFTP
c609719b8   wdenk   Initial revision
1243
  		server to contact when using the "tftboot" command.
1ebcd6547   Wolfgang Denk   README: improve d...
1244
  		(Environment variable "serverip")
c609719b8   wdenk   Initial revision
1245

97cfe8616   Robin Getz   Save server's MAC...
1246
1247
1248
1249
  		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...
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
  - 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")
c609719b8   wdenk   Initial revision
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
  - 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...
1277
  		following delays are inserted then:
c609719b8   wdenk   Initial revision
1278
1279
1280
1281
1282
1283
  
  		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...
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
  		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...
1301
  - DHCP Advanced Options:
1fe80d79c   Jon Loeliger   Finally retire cm...
1302
1303
  		You can fine tune the DHCP functionality by defining
  		CONFIG_BOOTP_* symbols:
1fe80d79c   Jon Loeliger   Finally retire cm...
1304
  		CONFIG_BOOTP_NISDOMAIN
1fe80d79c   Jon Loeliger   Finally retire cm...
1305
  		CONFIG_BOOTP_BOOTFILESIZE
1fe80d79c   Jon Loeliger   Finally retire cm...
1306
1307
1308
1309
  		CONFIG_BOOTP_SEND_HOSTNAME
  		CONFIG_BOOTP_NTPSERVER
  		CONFIG_BOOTP_TIMEOFFSET
  		CONFIG_BOOTP_VENDOREX
2c00e099f   Joe Hershberger   net: Add option C...
1310
  		CONFIG_BOOTP_MAY_FAIL
fe389a82c   stroese   - Added CONFIG_BO...
1311

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

2c00e099f   Joe Hershberger   net: Add option C...
1315
1316
1317
1318
1319
  		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...
1320
1321
1322
  		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_...
1323
  		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
1fe80d79c   Jon Loeliger   Finally retire cm...
1324
1325
  		of the "hostname" environment variable is passed as
  		option 12 to the DHCP server.
fe389a82c   stroese   - Added CONFIG_BO...
1326

d9a2f416d   Aras Vaichas   DHCP request fix ...
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
  		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...
1340
1341
1342
1343
1344
1345
1346
   - 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.
24acb83d8   Prabhakar Kushwaha   common: Fix-up MA...
1347
1348
1349
1350
1351
1352
1353
1354
   - MAC address from environment variables
  
  		FDT_SEQ_MACADDR_FROM_ENV
  
  		Fix-up device tree with MAC addresses fetched sequentially from
  		environment variables. This config work on assumption that
  		non-usable ethernet node of device-tree are either not present
  		or their status has been marked as "disabled".
a3d991bd0   wdenk   Patches by Pantel...
1355
   - CDP Options:
6e5923851   wdenk   * Cleanup, minor ...
1356
  		CONFIG_CDP_DEVICE_ID
a3d991bd0   wdenk   Patches by Pantel...
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
  
  		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...
1369
  		eth0 for the first Ethernet, eth1 for the second etc.
a3d991bd0   wdenk   Patches by Pantel...
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
  
  		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...
1396
  - Status LED:	CONFIG_LED_STATUS
c609719b8   wdenk   Initial revision
1397
1398
1399
1400
1401
1402
1403
  
  		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...
1404
  		kernel). Defining CONFIG_LED_STATUS enables this
c609719b8   wdenk   Initial revision
1405
  		feature in U-Boot.
1df7bbba2   Igor Grinberg   README: document ...
1406
  		Additional options:
79267edd1   Uri Mashiach   status_led: Kconf...
1407
  		CONFIG_LED_STATUS_GPIO
1df7bbba2   Igor Grinberg   README: document ...
1408
1409
  		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...
1410
  		status LED backend implementation. Define CONFIG_LED_STATUS_GPIO
1df7bbba2   Igor Grinberg   README: document ...
1411
  		to include the gpio_led driver in the U-Boot binary.
9dfdcdfed   Igor Grinberg   gpio_led: add sup...
1412
1413
1414
1415
1416
1417
  		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.
3f4978c71   Heiko Schocher   i2c: common chang...
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
  - 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...
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
  		- 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...
1441

00f792e0d   Heiko Schocher   i2c, fsl_i2c: swi...
1442
1443
1444
1445
1446
1447
  		- 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...
1448
  		  - If your board supports a second fsl i2c bus, define
00f792e0d   Heiko Schocher   i2c, fsl_i2c: swi...
1449
1450
1451
1452
  		    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...
1453
  		- drivers/i2c/tegra_i2c.c:
10cee5166   Nobuhiro Iwamatsu   README: I2C: Fix ...
1454
1455
1456
  		  - 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...
1457

880540dec   Dirk Eibach   i2c, ppc4xx_i2c: ...
1458
1459
1460
1461
  		- 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...
1462
1463
  		- drivers/i2c/i2c_mxc.c
  		  - activate this driver with CONFIG_SYS_I2C_MXC
03544c664   Albert ARIBAUD \\(3ADEV\\)   I2C: mxc_i2c: mak...
1464
1465
1466
1467
  		  - 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...
1468
1469
1470
1471
1472
1473
  		  - 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...
1474
1475
  		  - 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...
1476
  		If those defines are not set, default value is 100000
fac964089   trem   i2c: mxc: move to...
1477
  		for speed, and 0 for slave.
1086bfa9f   Nobuhiro Iwamatsu   i2c: Add support ...
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
  		- 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...
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
  		- 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...
1505
  		  - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
2035d77d7   Nobuhiro Iwamatsu   i2c: sh_i2c: Upda...
1506

6789e84ec   Heiko Schocher   i2c, omap24xx: co...
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
  		- 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
e717fc6d1   Naveen Krishna Ch   i2c: samsung: reg...
1519
1520
1521
1522
1523
  		- 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...
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
  		- 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...
1538
1539
1540
1541
1542
1543
1544
1545
1546
  		  - 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...
1547

3f4978c71   Heiko Schocher   i2c: common chang...
1548
1549
1550
  		additional defines:
  
  		CONFIG_SYS_NUM_I2C_BUSES
945a18e62   Simon Glass   README: i2c: Drop...
1551
  		Hold the number of i2c buses you want to use.
3f4978c71   Heiko Schocher   i2c: common chang...
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
  
  		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...
1564
  		hold a list of buses you want to use, only used if
3f4978c71   Heiko Schocher   i2c: common chang...
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
  		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...
1582
1583
1584
1585
1586
  			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...
1587
  			bus 6 on adapter 1 without a mux
ea818dbbc   Heiko Schocher   i2c, soft-i2c: sw...
1588
1589
  			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...
1590
1591
  
  		If you do not have i2c muxes on your board, omit this define.
ce3b5d691   Simon Glass   Drop use of CONFI...
1592
  - Legacy I2C Support:
ea818dbbc   Heiko Schocher   i2c, soft-i2c: sw...
1593
  		If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
b37c7e5e5   wdenk   * Patch by Seb Ja...
1594
1595
  		then the following macros need to be defined (examples are
  		from include/configs/lwmon.h):
c609719b8   wdenk   Initial revision
1596
1597
  
  		I2C_INIT
b37c7e5e5   wdenk   * Patch by Seb Ja...
1598
  		(Optional). Any commands necessary to enable the I2C
43d9616cf   wdenk   * Patch by Robert...
1599
  		controller or configure ports.
c609719b8   wdenk   Initial revision
1600

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

c609719b8   wdenk   Initial revision
1603
1604
1605
1606
1607
  		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...
1608
  		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
c609719b8   wdenk   Initial revision
1609
1610
1611
1612
1613
  		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...
1614
  		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
c609719b8   wdenk   Initial revision
1615
  		I2C_READ
472d54605   York Sun   Consolidate bool ...
1616
1617
  		Code that returns true if the I2C data line is high,
  		false if it is low.
c609719b8   wdenk   Initial revision
1618

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

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

c609719b8   wdenk   Initial revision
1628
  		I2C_SCL(bit)
472d54605   York Sun   Consolidate bool ...
1629
1630
  		If <bit> is true, sets the I2C clock line high. If it
  		is false, it clears it (low).
c609719b8   wdenk   Initial revision
1631

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

c609719b8   wdenk   Initial revision
1636
1637
1638
1639
  		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...
1640
  		is 1 / (I2C_DELAY * 4). Often defined to be something
945af8d72   wdenk   * Add support for...
1641
  		like:
b37c7e5e5   wdenk   * Patch by Seb Ja...
1642
  		#define I2C_DELAY  udelay(2)
c609719b8   wdenk   Initial revision
1643

793b5726f   Mike Frysinger   i2c: soft_i2c: ad...
1644
1645
1646
1647
1648
1649
1650
1651
1652
  		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...
1653
  		CONFIG_SYS_I2C_INIT_BOARD
47cd00fa7   wdenk   * Patches by Robe...
1654

8bde7f776   wdenk   * Code cleanup:
1655
1656
1657
1658
1659
1660
1661
1662
  		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...
1663

bb99ad6d8   Ben Warren   Add support for m...
1664
1665
1666
  		CONFIG_I2C_MULTI_BUS
  
  		This option allows the use of multiple I2C buses, each of which
c0f40859f   Wolfgang Denk   README: white-spa...
1667
1668
  		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...
1669
  		Note that bus numbering is zero-based.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
1670
  		CONFIG_SYS_I2C_NOPROBES
bb99ad6d8   Ben Warren   Add support for m...
1671
1672
  
  		This option specifies a list of I2C devices that will be skipped
c0f40859f   Wolfgang Denk   README: white-spa...
1673
  		when the 'i2c probe' command is issued.	 If CONFIG_I2C_MULTI_BUS
0f89c54be   Peter Tyser   i2c: Update refer...
1674
1675
  		is set, specify a list of bus-device pairs.  Otherwise, specify
  		a 1D array of device addresses
bb99ad6d8   Ben Warren   Add support for m...
1676
1677
1678
  
  		e.g.
  			#undef	CONFIG_I2C_MULTI_BUS
c0f40859f   Wolfgang Denk   README: white-spa...
1679
  			#define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
bb99ad6d8   Ben Warren   Add support for m...
1680
1681
  
  		will skip addresses 0x50 and 0x68 on a board with one I2C bus
c0f40859f   Wolfgang Denk   README: white-spa...
1682
  			#define CONFIG_I2C_MULTI_BUS
945a18e62   Simon Glass   README: i2c: Drop...
1683
  			#define CONFIG_SYS_I2C_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
bb99ad6d8   Ben Warren   Add support for m...
1684
1685
  
  		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
1686
  		CONFIG_SYS_SPD_BUS_NUM
be5e61815   Timur Tabi   mpc83xx: Update 8...
1687
1688
1689
  
  		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...
1690
  		CONFIG_SYS_RTC_BUS_NUM
0dc018ece   Stefan Roese   [PATCH] I2C: Add ...
1691
1692
1693
  
  		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.
2ac6985a7   Andrew Dyer   soft_i2c.c add op...
1694
1695
1696
1697
1698
1699
1700
1701
1702
  		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...
1703

c609719b8   wdenk   Initial revision
1704
1705
1706
1707
1708
  - 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)
c609719b8   wdenk   Initial revision
1709
  		CONFIG_SOFT_SPI
43d9616cf   wdenk   * Patch by Robert...
1710
1711
1712
1713
1714
1715
1716
  		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
1717

f659b5736   Heiko Schocher   spi, spi_mxc: do ...
1718
1719
1720
  		CONFIG_SYS_SPI_MXC_WAIT
  		Timeout for waiting until spi transfer completed.
  		default: (CONFIG_SYS_HZ/100)     /* 10 ms */
0133502e3   Matthias Fuchs   Improve configura...
1721
  - FPGA Support: CONFIG_FPGA
c609719b8   wdenk   Initial revision
1722

0133502e3   Matthias Fuchs   Improve configura...
1723
1724
1725
1726
1727
1728
  		Enables FPGA subsystem.
  
  		CONFIG_FPGA_<vendor>
  
  		Enables support for specific chip vendors.
  		(ALTERA, XILINX)
c609719b8   wdenk   Initial revision
1729

0133502e3   Matthias Fuchs   Improve configura...
1730
  		CONFIG_FPGA_<family>
c609719b8   wdenk   Initial revision
1731

0133502e3   Matthias Fuchs   Improve configura...
1732
1733
1734
1735
1736
1737
  		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
1738

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
1739
  		CONFIG_SYS_FPGA_PROG_FEEDBACK
c609719b8   wdenk   Initial revision
1740

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

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

43d9616cf   wdenk   * Patch by Robert...
1745
1746
1747
1748
  		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
1749
1750
1751
1752
1753
  
  		CONFIG_FPGA_DELAY
  
  		If defined, a function that provides delays in the FPGA
  		configuration driver.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
1754
  		CONFIG_SYS_FPGA_CHECK_CTRLC
c609719b8   wdenk   Initial revision
1755
  		Allow Control-C to interrupt FPGA configuration
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
1756
  		CONFIG_SYS_FPGA_CHECK_ERROR
c609719b8   wdenk   Initial revision
1757

43d9616cf   wdenk   * Patch by Robert...
1758
1759
1760
1761
  		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
1762

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

b445bbb49   Jeremiah Mahler   doc: fix grammati...
1765
1766
  		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...
1767
  		FPGA configuration sequence. The default time is 500
11ccc33fa   Marcel Ziswiler   Many spelling fix...
1768
  		ms.
c609719b8   wdenk   Initial revision
1769

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

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

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

43d9616cf   wdenk   * Patch by Robert...
1777
  		Time to wait after FPGA configuration. The default is
11ccc33fa   Marcel Ziswiler   Many spelling fix...
1778
  		200 ms.
c609719b8   wdenk   Initial revision
1779
1780
  
  - Configuration Management:
b2b8a6967   Stefan Roese   Makefile: Add CON...
1781

c609719b8   wdenk   Initial revision
1782
  		CONFIG_IDENT_STRING
43d9616cf   wdenk   * Patch by Robert...
1783
1784
  		If defined, this string will be added to the U-Boot
  		version information (U_BOOT_VERSION)
c609719b8   wdenk   Initial revision
1785
1786
  
  - Vendor Parameter Protection:
43d9616cf   wdenk   * Patch by Robert...
1787
1788
  		U-Boot considers the values of the environment
  		variables "serial#" (Board Serial Number) and
7152b1d0b   wdenk   * Add support for...
1789
  		"ethaddr" (Ethernet Address) to be parameters that
43d9616cf   wdenk   * Patch by Robert...
1790
1791
1792
1793
  		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...
1794
  		change this behaviour:
c609719b8   wdenk   Initial revision
1795
1796
1797
  
  		If CONFIG_ENV_OVERWRITE is #defined in your config
  		file, the write protection for vendor parameters is
47cd00fa7   wdenk   * Patches by Robe...
1798
  		completely disabled. Anybody can change or delete
c609719b8   wdenk   Initial revision
1799
  		these parameters.
92ac52082   Joe Hershberger   net: Remove all r...
1800
1801
  		Alternatively, if you define _both_ an ethaddr in the
  		default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
11ccc33fa   Marcel Ziswiler   Many spelling fix...
1802
  		Ethernet address is installed in the environment,
c609719b8   wdenk   Initial revision
1803
1804
1805
  		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...
1806
1807
1808
1809
  		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
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
  - 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 '$(......
1825
  			setenv bootargs ... mem=\${mem}
c609719b8   wdenk   Initial revision
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
  			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":
5b8e76c35   Heiko Schocher   powerpc, 8xx: rem...
1837
  			IVMS8, IVML24, SPD8xx,
1b0757ece   Wolfgang Denk   PPC: remove dead ...
1838
  			HERMES, IP860, RPXlite, LWMON,
2eb48ff7a   Heiko Schocher   powerpc, 8260: re...
1839
  			FLAGADM
c609719b8   wdenk   Initial revision
1840

40fef0490   Gabe Black   Introduce arch_ph...
1841
1842
1843
1844
1845
1846
1847
  - 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
1848
  - Error Recovery:
c609719b8   wdenk   Initial revision
1849
  		CONFIG_NET_RETRY_COUNT
43d9616cf   wdenk   * Patch by Robert...
1850
1851
1852
1853
  		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
1854

40cb90ee2   Guennadi Liakhovetski   net: make ARP tim...
1855
1856
1857
  		CONFIG_ARP_TIMEOUT
  
  		Timeout waiting for an ARP reply in milliseconds.
48a3e999c   Tetsuyuki Kobayashi   net: nfs: make NF...
1858
1859
1860
1861
1862
1863
  		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
1864
  - Command Interpreter:
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
1865
  		CONFIG_SYS_PROMPT_HUSH_PS2
c609719b8   wdenk   Initial revision
1866
1867
1868
1869
1870
1871
  
  		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:
1872
1873
1874
1875
1876
1877
1878
  		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
1879

43d9616cf   wdenk   * Patch by Robert...
1880
1881
1882
1883
  		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
1884
1885
1886
1887
1888
1889
  
  		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...
1890
  - Command Line Editing and History:
f3b267b3a   Marek Vasut   hush: Add rudimen...
1891
1892
1893
1894
1895
1896
  		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...
1897
  - Default Environment:
c609719b8   wdenk   Initial revision
1898
  		CONFIG_EXTRA_ENV_SETTINGS
43d9616cf   wdenk   * Patch by Robert...
1899
1900
  		Define this to contain any number of null terminated
  		strings (variable = value pairs) that will be part of
7152b1d0b   wdenk   * Add support for...
1901
  		the default environment compiled into the boot image.
2262cfeef   wdenk   * Patch by Daniel...
1902

43d9616cf   wdenk   * Patch by Robert...
1903
1904
  		For example, place something like this in your
  		board's config file:
c609719b8   wdenk   Initial revision
1905
1906
1907
1908
  
  		#define CONFIG_EXTRA_ENV_SETTINGS \
  			"myvar1=value1\0" \
  			"myvar2=value2\0"
43d9616cf   wdenk   * Patch by Robert...
1909
1910
1911
1912
  		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...
1913
  		will change soon, there is no guarantee either.
c609719b8   wdenk   Initial revision
1914
  		You better know what you are doing here.
43d9616cf   wdenk   * Patch by Robert...
1915
1916
  		Note: overly (ab)use of the default environment is
  		discouraged. Make sure to check other ways to preset
74de7aefd   Wolfgang Denk   Add "source" comm...
1917
  		the environment like the "source" command or the
43d9616cf   wdenk   * Patch by Robert...
1918
  		boot command first.
c609719b8   wdenk   Initial revision
1919

06fd85389   Simon Glass   arm: Add CONFIG_D...
1920
1921
1922
  		CONFIG_DELAY_ENVIRONMENT
  
  		Normally the environment is loaded when the board is
b445bbb49   Jeremiah Mahler   doc: fix grammati...
1923
  		initialised so that it is available to U-Boot. This inhibits
06fd85389   Simon Glass   arm: Add CONFIG_D...
1924
1925
1926
1927
  		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.
ecb0ccd9c   Wolfgang Denk   Allow to force TF...
1928
1929
  - TFTP Fixed UDP Port:
  		CONFIG_TFTP_PORT
28cb93758   Wolfgang Denk   Update for TFTP u...
1930
  		If this is defined, the environment variable tftpsrcp
ecb0ccd9c   Wolfgang Denk   Allow to force TF...
1931
  		is used to supply the TFTP UDP source port value.
28cb93758   Wolfgang Denk   Update for TFTP u...
1932
  		If tftpsrcp isn't defined, the normal pseudo-random port
ecb0ccd9c   Wolfgang Denk   Allow to force TF...
1933
  		number generator is used.
28cb93758   Wolfgang Denk   Update for TFTP u...
1934
1935
1936
1937
1938
  		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...
1939
1940
1941
1942
1943
1944
  		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.
a8c7c708a   wdenk   * Patch by Gleb N...
1945
  - Show boot progress:
c609719b8   wdenk   Initial revision
1946
  		CONFIG_SHOW_BOOT_PROGRESS
43d9616cf   wdenk   * Patch by Robert...
1947
1948
1949
1950
1951
1952
  		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
1953

94fd1316b   Simon Glass   bootstage: Store ...
1954

1372cce2b   Marian Balakowicz   [new uImage] Use ...
1955
  Legacy uImage format:
c609719b8   wdenk   Initial revision
1956
1957
    Arg	Where			When
      1	common/cmd_bootm.c	before attempting to boot an image
ba56f6257   wdenk   Patch by Travis S...
1958
     -1	common/cmd_bootm.c	Image header has bad	 magic number
c609719b8   wdenk   Initial revision
1959
      2	common/cmd_bootm.c	Image header has correct magic number
ba56f6257   wdenk   Patch by Travis S...
1960
     -2	common/cmd_bootm.c	Image header has bad	 checksum
c609719b8   wdenk   Initial revision
1961
      3	common/cmd_bootm.c	Image header has correct checksum
ba56f6257   wdenk   Patch by Travis S...
1962
     -3	common/cmd_bootm.c	Image data   has bad	 checksum
c609719b8   wdenk   Initial revision
1963
1964
1965
      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 ...
1966
     -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
c609719b8   wdenk   Initial revision
1967
1968
1969
1970
      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 ...
1971
      8	common/cmd_bootm.c	No uncompress/copy overwrite error
c609719b8   wdenk   Initial revision
1972
     -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
1372cce2b   Marian Balakowicz   [new uImage] Use ...
1973
1974
1975
1976
1977
1978
1979
1980
  
      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...
1981
    -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
1372cce2b   Marian Balakowicz   [new uImage] Use ...
1982
1983
     13	common/image.c		Start multifile image verification
     14	common/image.c		No initial ramdisk, no multifile, continue.
c0f40859f   Wolfgang Denk   README: white-spa...
1984
     15	arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
c609719b8   wdenk   Initial revision
1985

a47a12bec   Stefan Roese   Move arch/ppc to ...
1986
    -30	arch/powerpc/lib/board.c	Fatal error, hang the system
11dadd547   wdenk   * Patch by Steven...
1987
1988
    -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...
1989

566a494f5   Heiko Schocher   [PCS440EP] u...
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
     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...
2039
     64	net/eth.c		starting with Ethernet configuration.
566a494f5   Heiko Schocher   [PCS440EP] u...
2040
2041
2042
2043
    -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...
2044
2045
2046
     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...
2047
2048
    -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...
2049
2050
     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...
2051
     84	common/cmd_net.c	end without errors
c609719b8   wdenk   Initial revision
2052

1372cce2b   Marian Balakowicz   [new uImage] Use ...
2053
2054
2055
2056
2057
2058
2059
2060
2061
  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 ...
2062
    103	common/cmd_bootm.c	Found configuration node
1372cce2b   Marian Balakowicz   [new uImage] Use ...
2063
2064
2065
2066
2067
    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...
2068
2069
   -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 ...
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
   -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...
2082
    122	common/image.c		No ramdisk subimage unit name, using configuration
1372cce2b   Marian Balakowicz   [new uImage] Use ...
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
   -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...
2095
   -130	common/cmd_doc.c	Incorrect FIT image format
1372cce2b   Marian Balakowicz   [new uImage] Use ...
2096
    131	common/cmd_doc.c	FIT image format OK
11ccc33fa   Marcel Ziswiler   Many spelling fix...
2097
   -140	common/cmd_ide.c	Incorrect FIT image format
1372cce2b   Marian Balakowicz   [new uImage] Use ...
2098
    141	common/cmd_ide.c	FIT image format OK
11ccc33fa   Marcel Ziswiler   Many spelling fix...
2099
   -150	common/cmd_nand.c	Incorrect FIT image format
1372cce2b   Marian Balakowicz   [new uImage] Use ...
2100
    151	common/cmd_nand.c	FIT image format OK
4cf2609b0   Wolfgang Denk   README: fix docum...
2101
2102
  - Standalone program support:
  		CONFIG_STANDALONE_LOAD_ADDR
6feff899e   Wolfgang Denk   README: fix typos...
2103
2104
2105
  		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...
2106
2107
2108
2109
2110
2111
  		settings.
  
  - Frame Buffer Address:
  		CONFIG_FB_ADDR
  
  		Define CONFIG_FB_ADDR if you want to use specific
44a53b574   Wolfgang Denk   VIDEO: better doc...
2112
2113
2114
2115
2116
2117
2118
  		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...
2119
2120
  
  		Please see board_init_f function.
cccfc2ab7   Detlev Zundel   README: Rearrange...
2121
2122
2123
2124
2125
2126
2127
2128
2129
  - 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)
ff94bc40a   Heiko Schocher   mtd, ubi, ubifs: ...
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
  		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...
2144

ff94bc40a   Heiko Schocher   mtd, ubi, ubifs: ...
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
  		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...
2186
2187
2188
  		CONFIG_MTD_UBI_FM_DEBUG
  		Enable UBI fastmap debug
  		default: 0
6a11cf48a   Daniel Schwierzeck   spl: add initial ...
2189
  - SPL framework
04e5ae793   Wolfgang Denk   Minor coding styl...
2190
2191
  		CONFIG_SPL
  		Enable building of SPL globally.
6a11cf48a   Daniel Schwierzeck   spl: add initial ...
2192

95579793b   Tom Rini   README: document ...
2193
2194
  		CONFIG_SPL_LDSCRIPT
  		LDSCRIPT for linking the SPL binary.
6ebc34611   Albert ARIBAUD   ARM: fix CONFIG_S...
2195
2196
2197
2198
  		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...
2199
  		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
6ebc34611   Albert ARIBAUD   ARM: fix CONFIG_S...
2200
  		must not be both defined at the same time.
95579793b   Tom Rini   README: document ...
2201
  		CONFIG_SPL_MAX_SIZE
6ebc34611   Albert ARIBAUD   ARM: fix CONFIG_S...
2202
2203
2204
2205
  		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 ...
2206

94a45bb19   Scott Wood   powerpc/mpc85xx/p...
2207
2208
2209
  		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 ...
2210
2211
2212
2213
  		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...
2214
2215
2216
  		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...
2217
  		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
6ebc34611   Albert ARIBAUD   ARM: fix CONFIG_S...
2218
  		must not be both defined at the same time.
95579793b   Tom Rini   README: document ...
2219
2220
2221
  
  		CONFIG_SPL_STACK
  		Adress of the start of the stack SPL will use
8c80eb3b5   Albert ARIBAUD \(3ADEV\)   Introduce CONFIG_...
2222
2223
2224
2225
2226
2227
2228
2229
2230
  		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.
94a45bb19   Scott Wood   powerpc/mpc85xx/p...
2231
2232
2233
2234
  		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 ...
2235
2236
  		CONFIG_SYS_SPL_MALLOC_START
  		Starting address of the malloc pool used in SPL.
9ac4fc820   Fabio Estevam   board_init: Chang...
2237
2238
2239
  		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 ...
2240
2241
2242
  
  		CONFIG_SYS_SPL_MALLOC_SIZE
  		The size of the malloc pool used in SPL.
6a11cf48a   Daniel Schwierzeck   spl: add initial ...
2243

9607faf20   Tom Rini   README: Add CONFI...
2244
2245
2246
  		CONFIG_SPL_OS_BOOT
  		Enable booting directly to an OS from SPL.
  		See also: doc/README.falcon
861a86f46   Tom Rini   omap-common: SPL:...
2247
2248
2249
  		CONFIG_SPL_DISPLAY_PRINT
  		For ARM, enable an optional function to print more information
  		about the running system.
4b919725b   Scott Wood   spl/powerpc: intr...
2250
2251
  		CONFIG_SPL_INIT_MINIMAL
  		Arch init code should be built for a very small image
b97300b62   Paul Kocialkowski   spl: MMC U-Boot i...
2252
2253
2254
  		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...
2255
2256
2257
2258
2259
2260
2261
2262
2263
  		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...
2264
2265
2266
  		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...
2267
2268
2269
2270
  		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...
2271
  		Filename to read to load kernel uImage when reading
fae81c72c   Guillaume GARDET   doc: Update docum...
2272
  		from filesystem (for Falcon mode)
7ad2cc796   Peter Korsgaard   spl_mmc: add Falc...
2273

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

06f60ae3e   Scott Wood   powerpc/mpc83xx: ...
2278
2279
2280
2281
2282
  		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...
2283
2284
  		CONFIG_SPL_SKIP_RELOCATE
  		Avoid SPL relocation
6f2f01b9f   Scott Wood   spl/nand: introdu...
2285
2286
2287
2288
2289
2290
  		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.
15e207faa   Jörg Krause   spl, nand: add op...
2291
2292
2293
  		CONFIG_SPL_NAND_IDENT
  		SPL uses the chip ID list to identify the NAND flash.
  		Requires CONFIG_SPL_NAND_BASE.
6f2f01b9f   Scott Wood   spl/nand: introdu...
2294
2295
  		CONFIG_SPL_NAND_ECC
  		Include standard software ECC in the SPL
95579793b   Tom Rini   README: document ...
2296
  		CONFIG_SPL_NAND_SIMPLE
7d4b79552   Scott Wood   spl/nand: config ...
2297
2298
  		Support for NAND boot using simple NAND drivers that
  		expose the cmd_ctrl() interface.
95579793b   Tom Rini   README: document ...
2299

6f4e7d3c7   Thomas Gleixner   spl: Lightweight ...
2300
2301
2302
  		CONFIG_SPL_UBI
  		Support for a lightweight UBI (fastmap) scanner and
  		loader
0c3117b1f   Heiko Schocher   spl, nand: add op...
2303
2304
2305
  		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:...
2306
2307
2308
  		CONFIG_SPL_COMMON_INIT_DDR
  		Set for common ddr init with serial presence detect in
  		SPL binary.
95579793b   Tom Rini   README: document ...
2309
2310
2311
2312
2313
2314
  		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 ...
2315
  		to read U-Boot
95579793b   Tom Rini   README: document ...
2316
2317
  
  		CONFIG_SYS_NAND_U_BOOT_OFFS
7d4b79552   Scott Wood   spl/nand: config ...
2318
2319
2320
2321
2322
2323
2324
  		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 ...
2325
2326
  
  		CONFIG_SYS_NAND_U_BOOT_START
7d4b79552   Scott Wood   spl/nand: config ...
2327
  		Entry point in loaded image to jump to
95579793b   Tom Rini   README: document ...
2328
2329
2330
  
  		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...
2331
  		data. This is used, for example, on davinci platforms.
95579793b   Tom Rini   README: document ...
2332

c57b953da   Pavel Machek   SPL: Add support ...
2333
2334
  		CONFIG_SPL_RAM_DEVICE
  		Support for running image already present in ram, in SPL binary
6a11cf48a   Daniel Schwierzeck   spl: add initial ...
2335

74752baa7   Scott Wood   spl: Change PAD_T...
2336
  		CONFIG_SPL_PAD_TO
6113d3f27   Benoît Thébaudeau   Makefile: Change ...
2337
2338
2339
2340
2341
  		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...
2342

ca2fca223   Scott Wood   spl: introduce CO...
2343
2344
2345
2346
  		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.
b527b9c6c   Marek Vasut   fit: Fix CONFIG_F...
2347
  		CONFIG_SPL_FIT_PRINT
87ebee39e   Simon Glass   image: Add CONFIG...
2348
2349
2350
2351
  		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...
2352
2353
2354
2355
2356
2357
2358
  - 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...
2359
2360
2361
  		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...
2362

a8c7c708a   wdenk   * Patch by Gleb N...
2363
  - Interrupt support (PPC):
d4ca31c40   wdenk   * Cleanup lowboot...
2364
2365
  		There are common interrupt_init() and timer_interrupt()
  		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
11ccc33fa   Marcel Ziswiler   Many spelling fix...
2366
  		for CPU specific initialization. interrupt_init_cpu()
d4ca31c40   wdenk   * Cleanup lowboot...
2367
  		should set decrementer_count to appropriate value. If
11ccc33fa   Marcel Ziswiler   Many spelling fix...
2368
  		CPU resets decrementer automatically after interrupt
d4ca31c40   wdenk   * Cleanup lowboot...
2369
  		(ppc4xx) it should set decrementer_count to zero.
11ccc33fa   Marcel Ziswiler   Many spelling fix...
2370
  		timer_interrupt() calls timer_interrupt_cpu() for CPU
d4ca31c40   wdenk   * Cleanup lowboot...
2371
2372
2373
  		specific handling. If board has watchdog / status_led
  		/ other_activity_monitor it works automatically from
  		general timer_interrupt().
a8c7c708a   wdenk   * Patch by Gleb N...
2374

c609719b8   wdenk   Initial revision
2375

9660e442d   Helmut Raiger   cosmetic: s/BOARD...
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
  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
2390

c609719b8   wdenk   Initial revision
2391
2392
  Configuration Settings:
  -----------------------
4d1fd7f1a   York Sun   Add 64-bit data s...
2393
2394
  - 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...
2395
  - CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
c609719b8   wdenk   Initial revision
2396
  		undefine this when you're short of memory.
2fb2604d5   Peter Tyser   Command usage cle...
2397
2398
  - 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...
2399
  - CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
c609719b8   wdenk   Initial revision
2400
  		prompt for user input.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2401
  - CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
c609719b8   wdenk   Initial revision
2402

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

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

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2407
  - CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
c609719b8   wdenk   Initial revision
2408
2409
  		the application (usually a Linux kernel) when it is
  		booted
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2410
  - CONFIG_SYS_BAUDRATE_TABLE:
c609719b8   wdenk   Initial revision
2411
  		List of legal baudrate settings for this board.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2412
  - CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
c609719b8   wdenk   Initial revision
2413
2414
  		Begin and End addresses of the area used by the
  		simple memory test.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2415
  - CONFIG_SYS_MEMTEST_SCRATCH:
5f535fe17   wdenk   * Patches by Ande...
2416
2417
  		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...
2418
  - CONFIG_SYS_MEM_RESERVE_SECURE
e61a7534e   York Sun   armv8: Move secur...
2419
  		Only implemented for ARMv8 for now.
e81495224   York Sun   Reserve secure me...
2420
2421
2422
  		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...
2423
  		gd->arch.secure_ram is used to track the location. In systems
e81495224   York Sun   Reserve secure me...
2424
2425
  		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...
2426
  - CONFIG_SYS_MEM_TOP_HIDE:
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2427
  		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
14f73ca67   Stefan Roese   ppc: Add CFG_MEM_...
2428
  		this specified memory area will get subtracted from the top
11ccc33fa   Marcel Ziswiler   Many spelling fix...
2429
  		(end) of RAM and won't get "touched" at all by U-Boot. By
14f73ca67   Stefan Roese   ppc: Add CFG_MEM_...
2430
2431
2432
  		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...
2433
  		board ports in arch/powerpc with bootwrapper support that
14f73ca67   Stefan Roese   ppc: Add CFG_MEM_...
2434
  		recalculate the memory size from the SDRAM controller setup
5e12e75d1   Stefan Roese   ppc: Small change...
2435
  		will have to get fixed in Linux additionally.
14f73ca67   Stefan Roese   ppc: Add CFG_MEM_...
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
  
  		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...
2446
  - CONFIG_SYS_LOADS_BAUD_CHANGE:
c609719b8   wdenk   Initial revision
2447
  		Enable temporary baudrate change while serial download
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2448
  - CONFIG_SYS_SDRAM_BASE:
c609719b8   wdenk   Initial revision
2449
  		Physical start address of SDRAM. _Must_ be 0 here.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2450
  - CONFIG_SYS_FLASH_BASE:
c609719b8   wdenk   Initial revision
2451
  		Physical start address of Flash memory.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2452
  - CONFIG_SYS_MONITOR_BASE:
c609719b8   wdenk   Initial revision
2453
2454
  		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 ...
2455
  		(CONFIG_SYS_TEXT_BASE) used when linking) - same as
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2456
  		CONFIG_SYS_FLASH_BASE when booting from flash.
c609719b8   wdenk   Initial revision
2457

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2458
  - CONFIG_SYS_MONITOR_LEN:
8bde7f776   wdenk   * Code cleanup:
2459
2460
2461
2462
  		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
2463

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2464
  - CONFIG_SYS_MALLOC_LEN:
c609719b8   wdenk   Initial revision
2465
  		Size of DRAM reserved for malloc() use.
d59476b64   Simon Glass   Add a simple mall...
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
  - 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...
2476
  		The memory will be freed (or in fact just forgotten) when
d59476b64   Simon Glass   Add a simple mall...
2477
  		U-Boot relocates itself.
38687ae67   Simon Glass   dm: Update docume...
2478
2479
2480
2481
  - 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...
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
  - 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...
2500
  - CONFIG_SYS_BOOTM_LEN:
15940c9af   Stefan Roese   Change max size o...
2501
2502
  		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...
2503
  		you can define CONFIG_SYS_BOOTM_LEN in your board config file
15940c9af   Stefan Roese   Change max size o...
2504
  		to adjust this setting to your needs.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2505
  - CONFIG_SYS_BOOTMAPSZ:
c609719b8   wdenk   Initial revision
2506
2507
  		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...
2508
2509
  		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...
2510
  		environment variable is defined and non-zero. In such case
7d721e34a   Bartlomiej Sieka   Boot-related docu...
2511
  		all data for the Linux kernel must be between "bootm_low"
c0f40859f   Wolfgang Denk   README: white-spa...
2512
  		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.	 The environment
c3624e6ed   Grant Likely   Default to bootm_...
2513
2514
2515
  		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
2516

fca43cc80   John Rigby   boot: change some...
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
  - 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...
2529
  - CONFIG_SYS_MAX_FLASH_BANKS:
c609719b8   wdenk   Initial revision
2530
  		Max number of Flash memory banks
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2531
  - CONFIG_SYS_MAX_FLASH_SECT:
c609719b8   wdenk   Initial revision
2532
  		Max number of sectors on a Flash chip
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2533
  - CONFIG_SYS_FLASH_ERASE_TOUT:
c609719b8   wdenk   Initial revision
2534
  		Timeout for Flash erase operations (in ms)
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2535
  - CONFIG_SYS_FLASH_WRITE_TOUT:
c609719b8   wdenk   Initial revision
2536
  		Timeout for Flash write operations (in ms)
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2537
  - CONFIG_SYS_FLASH_LOCK_TOUT
8564acf93   wdenk   * Patches by Yuli...
2538
  		Timeout for Flash set sector lock bit operation (in ms)
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2539
  - CONFIG_SYS_FLASH_UNLOCK_TOUT
8564acf93   wdenk   * Patches by Yuli...
2540
  		Timeout for Flash clear lock bits operation (in ms)
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2541
  - CONFIG_SYS_FLASH_PROTECTION
8564acf93   wdenk   * Patches by Yuli...
2542
2543
  		If defined, hardware flash sectors protection is used
  		instead of U-Boot software protection.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2544
  - CONFIG_SYS_DIRECT_FLASH_TFTP:
c609719b8   wdenk   Initial revision
2545
2546
2547
2548
2549
2550
2551
2552
  
  		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...
2553
2554
  		the flash, but in some situations (when system RAM is
  		too limited to allow for a temporary copy of the
c609719b8   wdenk   Initial revision
2555
  		downloaded image) this option may be very useful.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2556
  - CONFIG_SYS_FLASH_CFI:
43d9616cf   wdenk   * Patch by Robert...
2557
  		Define if the flash driver uses extra elements in the
5653fc335   wdenk   * Patch by Yuli B...
2558
  		common flash structure for storing flash geometry.
00b1883a4   Jean-Christophe PLAGNIOL-VILLARD   drivers/mtd: Move...
2559
  - CONFIG_FLASH_CFI_DRIVER
5653fc335   wdenk   * Patch by Yuli B...
2560
2561
  		This option also enables the building of the cfi_flash driver
  		in the drivers directory
c609719b8   wdenk   Initial revision
2562

91809ed51   Piotr Ziecik   cfi-mtd: Add cfi-...
2563
2564
2565
2566
  - 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...
2567
  - CONFIG_SYS_FLASH_USE_BUFFER_WRITE
96ef831f7   Guennadi Liakhovetski   cfi_flash: Suppor...
2568
2569
2570
2571
2572
  		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...
2573
  - CONFIG_SYS_FLASH_QUIET_TEST
5568e613e   Stefan Roese   Add support for P...
2574
2575
2576
2577
  		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...
2578
2579
2580
2581
  - 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...
2582
2583
2584
2585
2586
2587
2588
2589
  - 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...
2590
  - CONFIG_SYS_RX_ETH_BUFFER:
11ccc33fa   Marcel Ziswiler   Many spelling fix...
2591
2592
  		Defines the number of Ethernet receive buffers. On some
  		Ethernet controllers it is recommended to set this value
53cf9435c   stroese   - CFG_RX_ETH_BUFF...
2593
2594
  		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...
2595
  		on high Ethernet traffic.
53cf9435c   stroese   - CFG_RX_ETH_BUFF...
2596
  		Defaults to 4 if not defined.
ea882baf9   Wolfgang Denk   New implementatio...
2597
  - CONFIG_ENV_MAX_ENTRIES
071bc9233   Wolfgang Denk   Coding Style cleanup
2598
2599
2600
2601
2602
  	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...
2603

2598090b7   Joe Hershberger   env: Add environm...
2604
2605
  - CONFIG_ENV_FLAGS_LIST_DEFAULT
  - CONFIG_ENV_FLAGS_LIST_STATIC
1bce2aeb6   Robert P. J. Day   Cosmetic: Fix a n...
2606
  	Enable validation of the values given to environment variables when
2598090b7   Joe Hershberger   env: Add environm...
2607
2608
2609
2610
2611
2612
  	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...
2613
2614
  		access_attribute = [a|r|o|c]
  		attributes = type_attribute[access_attribute]
2598090b7   Joe Hershberger   env: Add environm...
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
  		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 ...
2625
2626
2627
2628
2629
  	The access attributes are:
  		a - Any (default)
  		r - Read-only
  		o - Write-once
  		c - Change-default
2598090b7   Joe Hershberger   env: Add environm...
2630
2631
  	- CONFIG_ENV_FLAGS_LIST_DEFAULT
  		Define this to a list (string) to define the ".flags"
b445bbb49   Jeremiah Mahler   doc: fix grammati...
2632
  		environment variable in the default or embedded environment.
2598090b7   Joe Hershberger   env: Add environm...
2633
2634
2635
2636
2637
2638
2639
  
  	- 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...
2640
2641
2642
  	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 ...
2643
2644
2645
  - CONFIG_ENV_ACCESS_IGNORE_FORCE
  	If defined, don't allow the -f switch to env set override variable
  	access flags.
c609719b8   wdenk   Initial revision
2646
2647
2648
  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...
2649
2650
2651
2652
  - 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.
c609719b8   wdenk   Initial revision
2653
  BE CAREFUL! The first access to the environment happens quite early
b445bbb49   Jeremiah Mahler   doc: fix grammati...
2654
  in U-Boot initialization (when we try to get the setting of for the
11ccc33fa   Marcel Ziswiler   Many spelling fix...
2655
  console baudrate). You *MUST* have mapped your NVRAM area then, or
c609719b8   wdenk   Initial revision
2656
2657
2658
2659
2660
2661
  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.
0a85a9e70   Liu Gang   powerpc/corenet_d...
2662
2663
  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...
2664
2665
  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...
2666

b74ab7373   Guennadi Liakhovetski   nand_spl: read en...
2667
2668
2669
2670
2671
  - 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.
e881cb563   Bruce Adler   fix wording in RE...
2672
  Please note that the environment is read-only until the monitor
c609719b8   wdenk   Initial revision
2673
  has been relocated to RAM and a RAM copy of the environment has been
00caae6d4   Simon Glass   env: Rename geten...
2674
  created; also, when using EEPROM you will have to use env_get_f()
c609719b8   wdenk   Initial revision
2675
  until then to read environment variables.
85ec0bcc1   wdenk   * Patch by Arun D...
2676
2677
2678
2679
2680
2681
  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
2682
2683
2684
  
  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...
2685
  use the "saveenv" command to store a valid environment.
c609719b8   wdenk   Initial revision
2686

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

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

f5675aa5c   Ron Madrid   Create configurat...
2695
2696
2697
2698
2699
2700
  - 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...
2701
2702
2703
2704
  - 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...
2705
2706
2707
2708
  - 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 ...
2709
2710
2711
2712
  - 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
2713
  Low Level (hardware related) configuration options:
dc7c9a1a5   wdenk   * Patch by Rick B...
2714
  ---------------------------------------------------
c609719b8   wdenk   Initial revision
2715

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2716
  - CONFIG_SYS_CACHELINE_SIZE:
c609719b8   wdenk   Initial revision
2717
  		Cache Line Size of the CPU.
e46fedfeb   Timur Tabi   powerpc/85xx: int...
2718
2719
2720
2721
2722
2723
2724
  - 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.
e46fedfeb   Timur Tabi   powerpc/85xx: int...
2725
2726
2727
  - 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...
2728
  		be set to that address.	 Otherwise, it should be set to the
e46fedfeb   Timur Tabi   powerpc/85xx: int...
2729
2730
2731
2732
2733
2734
2735
2736
  		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...
2737
2738
  		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...
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
  		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,...
2750
  - Floppy Disk Support:
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2751
  		CONFIG_SYS_FDC_DRIVE_NUMBER
7f6c2cbc2   wdenk   * Vince Husovsky,...
2752
2753
  
  		the default drive number (default value 0)
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2754
  		CONFIG_SYS_ISA_IO_STRIDE
7f6c2cbc2   wdenk   * Vince Husovsky,...
2755

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

43d9616cf   wdenk   * Patch by Robert...
2760
2761
  		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...
2762
  		the FDC chipset. (default value 0)
7f6c2cbc2   wdenk   * Vince Husovsky,...
2763

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2764
2765
  		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...
2766
  		default value.
7f6c2cbc2   wdenk   * Vince Husovsky,...
2767

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2768
  		if CONFIG_SYS_FDC_HW_INIT is defined, then the function
43d9616cf   wdenk   * Patch by Robert...
2769
2770
  		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...
2771
  		source code. It is used to make hardware-dependent
43d9616cf   wdenk   * Patch by Robert...
2772
  		initializations.
7f6c2cbc2   wdenk   * Vince Husovsky,...
2773

0abddf82d   Macpaul Lin   cmd_ide: enhance ...
2774
2775
2776
2777
2778
2779
  - 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...
2780
  		is required.
0abddf82d   Macpaul Lin   cmd_ide: enhance ...
2781

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2782
  - CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
efe2a4d5c   wdenk   Code cleanup.
2783
  		DO NOT CHANGE unless you know exactly what you're
907208c45   Christophe Leroy   powerpc: Partialy...
2784
  		doing! (11-4) [MPC8xx systems only]
c609719b8   wdenk   Initial revision
2785

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

7152b1d0b   wdenk   * Add support for...
2788
  		Start address of memory area that can be used for
c609719b8   wdenk   Initial revision
2789
2790
2791
2792
2793
2794
2795
2796
  		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:
907208c45   Christophe Leroy   powerpc: Partialy...
2797
  		- MPC8xx: IMMR (internal memory of the CPU)
c609719b8   wdenk   Initial revision
2798

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2799
  - CONFIG_SYS_GBL_DATA_OFFSET:
c609719b8   wdenk   Initial revision
2800
2801
  
  		Offset of the initial data structure in the memory
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2802
2803
  		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
  		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
c609719b8   wdenk   Initial revision
2804
  		data is located at the end of the available space
553f09823   Wolfgang Denk   Rename CONFIG_SYS...
2805
  		(sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
acd51f9d9   Simon Glass   README: Drop CONF...
2806
  		GENERATED_GBL_DATA_SIZE), and the initial stack is just
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2807
2808
  		below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
  		CONFIG_SYS_GBL_DATA_OFFSET) downward.
c609719b8   wdenk   Initial revision
2809
2810
2811
2812
  
  	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...
2813
  		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
c609719b8   wdenk   Initial revision
2814
2815
  		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...
2816
  - CONFIG_SYS_SCCR:	System Clock and reset Control Register (15-27)
c609719b8   wdenk   Initial revision
2817

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2818
  - CONFIG_SYS_OR_TIMING_SDRAM:
c609719b8   wdenk   Initial revision
2819
  		SDRAM timing
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2820
  - CONFIG_SYS_MAMR_PTA:
c609719b8   wdenk   Initial revision
2821
  		periodic timer for refresh
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2822
2823
2824
2825
  - 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
2826
2827
2828
  		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...
2829
2830
    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
2831
  		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
69fd2d3b0   Andrew Sharp   pci: add CONFIG_P...
2832
  - CONFIG_PCI_ENUM_ONLY
b445bbb49   Jeremiah Mahler   doc: fix grammati...
2833
  		Only scan through and get the devices on the buses.
69fd2d3b0   Andrew Sharp   pci: add CONFIG_P...
2834
2835
2836
2837
  		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...
2838
2839
  - CONFIG_PCI_INDIRECT_BRIDGE:
  		Enable support for indirect PCI bridges.
a09b9b68d   Kumar Gala   powerpc/8xxx: Ref...
2840
2841
2842
2843
2844
2845
2846
2847
  - 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...
2848
2849
  - CONFIG_SRIO_PCIE_BOOT_MASTER
  		Board can support master function for Boot from SRIO and PCIE
a09b9b68d   Kumar Gala   powerpc/8xxx: Ref...
2850
2851
2852
2853
2854
2855
2856
2857
  - 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...
2858
2859
2860
2861
  - 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...
2862
  		Example of drivers that use it:
a430fa06a   Miquel Raynal   mtd: move NAND fi...
2863
2864
  		- drivers/mtd/nand/raw/ndfc.c
  		- drivers/mtd/nand/raw/mxc_nand.c
eced4626e   Alex Waterman   NAND: Add 16bit N...
2865
2866
2867
2868
  
  - 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...
2869
  - CONFIG_SPD_EEPROM
218ca724c   Wolfgang Denk   README: update do...
2870
2871
  		Get DDR timing information from an I2C EEPROM. Common
  		with pluggable memory modules such as SODIMMs
bb99ad6d8   Ben Warren   Add support for m...
2872
2873
    SPD_EEPROM_ADDRESS
  		I2C address of the SPD EEPROM
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2874
  - CONFIG_SYS_SPD_BUS_NUM
218ca724c   Wolfgang Denk   README: update do...
2875
2876
2877
  		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...
2878

1b3e3c4f2   York Sun   powerpc/mpc8xxx: ...
2879
2880
2881
2882
2883
  - 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...
2884
2885
  - CONFIG_FSL_DDR_INTERACTIVE
  		Enable interactive DDR debugging. See doc/README.fsl-ddr.
e32d59a2f   York Sun   driver/ddr/fsl: A...
2886
2887
  - CONFIG_FSL_DDR_SYNC_REFRESH
  		Enable sync of refresh for multiple controllers.
4516ff816   York Sun   driver/ddr/fsl: A...
2888
2889
  - CONFIG_FSL_DDR_BIST
  		Enable built-in memory test for Freescale DDR controllers.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2890
  - CONFIG_SYS_83XX_DDR_USES_CS0
218ca724c   Wolfgang Denk   README: update do...
2891
2892
  		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...
2893

c26e454df   wdenk   Patches by Pantel...
2894
2895
2896
2897
  - 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...
2898
2899
2900
2901
2902
2903
2904
2905
2906
  - 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...
2907
2908
  - CONFIG_LOOPW
  		Add the "loopw" memory command. This only takes effect if
493f420e1   Simon Glass   Kconfig: Drop CON...
2909
  		the memory commands are activated globally (CONFIG_CMD_MEMORY).
56523f128   wdenk   * Patch by Martin...
2910

7b4666414   stroese   CONFIG_MX_CYCLIC ...
2911
2912
2913
2914
  - CONFIG_MX_CYCLIC
  		Add the "mdc" and "mwc" memory commands. These are cyclic
  		"md/mw" commands.
  		Examples:
efe2a4d5c   wdenk   Code cleanup.
2915
  		=> mdc.b 10 4 500
7b4666414   stroese   CONFIG_MX_CYCLIC ...
2916
  		This command will print 4 bytes (10,11,12,13) each 500 ms.
efe2a4d5c   wdenk   Code cleanup.
2917
  		=> mwc.l 100 12345678 10
7b4666414   stroese   CONFIG_MX_CYCLIC ...
2918
  		This command will write 12345678 to address 100 all 10 ms.
efe2a4d5c   wdenk   Code cleanup.
2919
  		This only takes effect if the memory commands are activated
493f420e1   Simon Glass   Kconfig: Drop CON...
2920
  		globally (CONFIG_CMD_MEMORY).
7b4666414   stroese   CONFIG_MX_CYCLIC ...
2921

8aa1a2d11   wdenk   Patch by Steven S...
2922
  - CONFIG_SKIP_LOWLEVEL_INIT
3fafced74   Rick Chen   riscv: doc: Add r...
2923
  		[ARM, NDS32, MIPS, RISC-V only] If this variable is defined, then certain
844f07d8a   Wolfgang Denk   Coding Style (whi...
2924
2925
2926
2927
2928
2929
2930
2931
  		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...
2932

b5bd09820   Simon Glass   arm: Allow skippi...
2933
2934
  - CONFIG_SKIP_LOWLEVEL_INIT_ONLY
  		[ARM926EJ-S only] This allows just the call to lowlevel_init()
90211f772   yeongjun Kim   fixing typo error...
2935
  		to be skipped. The normal CP15 init (such as enabling the
b5bd09820   Simon Glass   arm: Allow skippi...
2936
  		instruction cache) is still performed.
401bb30b6   Aneesh V   replace CONFIG_PR...
2937
  - CONFIG_SPL_BUILD
df81238b3   Magnus Lilja   ARM1136: Introduc...
2938
2939
2940
  		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...
2941

3aa29de0b   Ying Zhang   TPL : introduce t...
2942
2943
2944
2945
  - 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: ...
2946
2947
2948
2949
  - 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...
2950
2951
2952
2953
2954
2955
2956
2957
  - 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...
2958
2959
2960
  - 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...
2961

999d7d326   Karicheri, Muralidharan   NAND: DaVinci: al...
2962
2963
2964
  - CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
  		Option to disable subpage write in NAND driver
  		driver that uses this:
a430fa06a   Miquel Raynal   mtd: move NAND fi...
2965
  		drivers/mtd/nand/raw/davinci_nand.c
999d7d326   Karicheri, Muralidharan   NAND: DaVinci: al...
2966

f2717b47e   Timur Tabi   powerpc/85xx: cle...
2967
2968
2969
2970
2971
2972
2973
2974
  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...
2975
2976
  - CONFIG_SYS_FMAN_FW_ADDR
  	The address in the storage device where the FMAN microcode is located.  The
cc1e98b55   Tom Rini   configs: Migrate ...
2977
  	meaning of this address depends on which CONFIG_SYS_QE_FMAN_FW_IN_xxx macro
dcf1d774b   Zhao Qiang   QE/FMAN: modify C...
2978
2979
2980
2981
  	is also specified.
  
  - CONFIG_SYS_QE_FW_ADDR
  	The address in the storage device where the QE microcode is located.  The
cc1e98b55   Tom Rini   configs: Migrate ...
2982
  	meaning of this address depends on which CONFIG_SYS_QE_FMAN_FW_IN_xxx macro
f2717b47e   Timur Tabi   powerpc/85xx: cle...
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
  	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...
3003
3004
3005
  - 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...
3006
3007
3008
  	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...
3009

b940ca64b   J. German Rivera   armv8/fsl-lsch3: ...
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
  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: ...
3020
3021
3022
3023
3024
  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...
3025
3026
  - CONFIG_SYS_MC_RSV_MEM_ALIGN
  	Define alignment of reserved memory MC requires
5c0550897   Prabhakar Kushwaha   armv8/fsl-lsch3: ...
3027

f3f431a71   Paul Kocialkowski   Reproducible U-Bo...
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
  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
3039
3040
  Building the Software:
  ======================
218ca724c   Wolfgang Denk   README: update do...
3041
3042
3043
3044
3045
3046
  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
3047

218ca724c   Wolfgang Denk   README: update do...
3048
3049
3050
3051
3052
  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
3053

218ca724c   Wolfgang Denk   README: update do...
3054
3055
  	$ CROSS_COMPILE=ppc_4xx-
  	$ export CROSS_COMPILE
c609719b8   wdenk   Initial revision
3056

2f8d396b9   Peter Tyser   Add support for b...
3057
3058
3059
3060
3061
3062
3063
3064
3065
  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...
3066
3067
  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
3068
  is done by typing:
ab584d67c   Holger Freyther   The _config targe...
3069
  	make NAME_defconfig
c609719b8   wdenk   Initial revision
3070

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

2729af9d5   wdenk   * Fix minor NAND ...
3074
3075
3076
3077
  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...
3078
        when choosing the configuration, i. e.
2729af9d5   wdenk   * Fix minor NAND ...
3079

ab584d67c   Holger Freyther   The _config targe...
3080
        make TQM823L_defconfig
2729af9d5   wdenk   * Fix minor NAND ...
3081
  	- will configure for a plain TQM823L, i. e. no LCD support
ab584d67c   Holger Freyther   The _config targe...
3082
        make TQM823L_LCD_defconfig
2729af9d5   wdenk   * Fix minor NAND ...
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
  	- 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...
3094
3095
3096
3097
3098
3099
3100
  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...
3101
  	make O=/tmp/build NAME_defconfig
baf312495   Marian Balakowicz   Add documentation...
3102
  	make O=/tmp/build all
adbba9960   Timo Ketola   doc: fix document...
3103
  2. Set environment variable KBUILD_OUTPUT to point to the desired location:
baf312495   Marian Balakowicz   Add documentation...
3104

adbba9960   Timo Ketola   doc: fix document...
3105
  	export KBUILD_OUTPUT=/tmp/build
baf312495   Marian Balakowicz   Add documentation...
3106
  	make distclean
ab584d67c   Holger Freyther   The _config targe...
3107
  	make NAME_defconfig
baf312495   Marian Balakowicz   Add documentation...
3108
  	make all
adbba9960   Timo Ketola   doc: fix document...
3109
  Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
baf312495   Marian Balakowicz   Add documentation...
3110
  variable.
215bb1c14   Daniel Schwierzeck   README: add doc f...
3111
3112
3113
3114
3115
  User specific CPPFLAGS, AFLAGS and CFLAGS can be passed to the compiler by
  setting the according environment variables KCPPFLAGS, KAFLAGS and KCFLAGS.
  For example to treat all compiler warnings as errors:
  
  	make KCFLAGS=-Werror
2729af9d5   wdenk   * Fix minor NAND ...
3116
3117
3118
3119
3120
3121
3122
3123
3124
  
  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...
3125
  1.  Create a new directory to hold your board specific code. Add any
2729af9d5   wdenk   * Fix minor NAND ...
3126
      files you need. In your board directory, you will need at least
3c1496cd4   Phil Sutter   README: Review th...
3127
3128
3129
      the "Makefile" and a "<board>.c".
  2.  Create a new configuration file "include/configs/<board>.h" for
      your board.
2729af9d5   wdenk   * Fix minor NAND ...
3130
3131
  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...
3132
  4.  Run "make <board>_defconfig" with your new name.
2729af9d5   wdenk   * Fix minor NAND ...
3133
3134
3135
3136
3137
3138
3139
3140
  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...
3141
3142
  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 ...
3143
3144
  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...
3145
  official or latest in the git repository) version of U-Boot sources.
2729af9d5   wdenk   * Fix minor NAND ...
3146

218ca724c   Wolfgang Denk   README: update do...
3147
3148
  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 ...
3149
  the supported boards compile WITHOUT ANY compiler warnings. To do so,
6de80f219   Simon Glass   Drop references t...
3150
3151
3152
3153
  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...
3154

2729af9d5   wdenk   * Fix minor NAND ...
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
  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"...
3165
  bootz   - boot zImage from memory
2729af9d5   wdenk   * Fix minor NAND ...
3166
3167
3168
  tftpboot- boot image via network using TFTP protocol
  	       and env variables "ipaddr" and "serverip"
  	       (and eventually "gatewayip")
1fb7cd498   Simon Glass   net: tftpput: imp...
3169
  tftpput - upload a file via network using TFTP protocol
2729af9d5   wdenk   * Fix minor NAND ...
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
  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...
3181
  i2c	- I2C sub-system
2729af9d5   wdenk   * Fix minor NAND ...
3182
3183
3184
3185
3186
3187
3188
3189
  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...
3190
  nand	- NAND memory operations (see doc/README.nand)
2729af9d5   wdenk   * Fix minor NAND ...
3191
3192
3193
3194
3195
  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...
3196
  loopw	- infinite write loop on address range
2729af9d5   wdenk   * Fix minor NAND ...
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
  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
3220

2729af9d5   wdenk   * Fix minor NAND ...
3221
3222
3223
3224
3225
3226
  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
3227

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

2729af9d5   wdenk   * Fix minor NAND ...
3232
    baudrate	- see CONFIG_BAUDRATE
c609719b8   wdenk   Initial revision
3233

2729af9d5   wdenk   * Fix minor NAND ...
3234
    bootdelay	- see CONFIG_BOOTDELAY
c609719b8   wdenk   Initial revision
3235

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

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

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

7d721e34a   Bartlomiej Sieka   Boot-related docu...
3242
3243
3244
3245
3246
3247
    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_...
3248
3249
  		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
  		  bootm_mapsize.
c0f40859f   Wolfgang Denk   README: white-spa...
3250
    bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
c3624e6ed   Grant Likely   Default to bootm_...
3251
3252
3253
3254
3255
3256
  		  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...
3257
3258
3259
3260
3261
3262
  
    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...
3263
3264
3265
    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 ...
3266
3267
3268
3269
    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
3270

2729af9d5   wdenk   * Fix minor NAND ...
3271
3272
3273
3274
    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...
3275

2729af9d5   wdenk   * Fix minor NAND ...
3276
3277
3278
3279
3280
  		  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
3281

a28afca57   David A. Long   Add uboot "fdt_hi...
3282
3283
    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...
3284
3285
3286
3287
3288
3289
3290
  		  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...
3291
3292
3293
3294
3295
3296
  		  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...
3297
3298
3299
    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 ...
3300
3301
3302
3303
3304
    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 ...
3305
3306
3307
3308
3309
3310
    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...
3311
  		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
2729af9d5   wdenk   * Fix minor NAND ...
3312
3313
3314
3315
  		  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
3316

2729af9d5   wdenk   * Fix minor NAND ...
3317
3318
3319
3320
3321
3322
  		  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
3323

2729af9d5   wdenk   * Fix minor NAND ...
3324
  		  setenv initrd_high 00c00000
c609719b8   wdenk   Initial revision
3325

2729af9d5   wdenk   * Fix minor NAND ...
3326
3327
3328
3329
3330
3331
3332
  		  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
3333

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

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

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

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

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

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

2729af9d5   wdenk   * Fix minor NAND ...
3347
    bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
c609719b8   wdenk   Initial revision
3348

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

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

48690d802   Heiko Schocher   net ppc: fix ethe...
3354
3355
3356
3357
  		  => 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
3358

e16925773   Matthias Fuchs   net: add 'ethrota...
3359
3360
3361
    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...
3362
    netretry	- When set to "no" each network operation will
2729af9d5   wdenk   * Fix minor NAND ...
3363
3364
3365
3366
3367
3368
  		  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
3369

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

b445bbb49   Jeremiah Mahler   doc: fix grammati...
3372
    silent_linux  - If set then Linux will be told to boot silently, by
8d51aacd8   Simon Glass   RFC: bootm: Add s...
3373
3374
3375
3376
  		  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...
3377
    tftpsrcp	- If this is set, the value is used for TFTP's
ecb0ccd9c   Wolfgang Denk   Allow to force TF...
3378
  		  UDP source port.
f5fb73467   Albert ARIBAUD \(3ADEV\)   net: TFTP: variab...
3379
    tftpdstp	- If this is set, the value is used for TFTP's UDP
28cb93758   Wolfgang Denk   Update for TFTP u...
3380
  		  destination port instead of the Well Know Port 69.
c96f86eef   Wolfgang Denk   TFTP: allow for a...
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
    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...
3391
3392
3393
3394
3395
3396
3397
    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...
3398
    vlan		- When set to a value < 4095 the traffic over
11ccc33fa   Marcel Ziswiler   Many spelling fix...
3399
  		  Ethernet is encapsulated/received over 802.1q
2729af9d5   wdenk   * Fix minor NAND ...
3400
  		  VLAN tagged frames.
c609719b8   wdenk   Initial revision
3401

50768f5b0   Alexandre Messier   net: bootp: Add e...
3402
3403
3404
3405
3406
    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 ...
3407
3408
3409
3410
3411
3412
3413
3414
3415
  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 ...
3416
  boards currently use other variables for these purposes, and some
dc0b7b0e6   Jason Hobbs   README: document ...
3417
  boards use these variables for other purposes.
c0f40859f   Wolfgang Denk   README: white-spa...
3418
3419
3420
3421
3422
3423
  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 ...
3424

2729af9d5   wdenk   * Fix minor NAND ...
3425
3426
3427
  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
3428

2729af9d5   wdenk   * Fix minor NAND ...
3429
3430
3431
3432
3433
3434
3435
3436
3437
    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...
3438

c1551ea81   stroese   U-Boot version en...
3439

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

2729af9d5   wdenk   * Fix minor NAND ...
3442
3443
3444
    serial#	- contains hardware identification information such
  		  as type string and/or serial number
    ethaddr	- Ethernet address
c609719b8   wdenk   Initial revision
3445

2729af9d5   wdenk   * Fix minor NAND ...
3446
3447
3448
  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
3449

f07771cc2   wdenk   * Fix data abort ...
3450

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

2729af9d5   wdenk   * Fix minor NAND ...
3453
3454
3455
    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 ...
3456

f07771cc2   wdenk   * Fix data abort ...
3457

2729af9d5   wdenk   * Fix minor NAND ...
3458
3459
  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 ...
3460

f07771cc2   wdenk   * Fix data abort ...
3461

170ab1107   Joe Hershberger   env: Add support ...
3462
3463
3464
3465
  Callback functions for environment variables:
  ---------------------------------------------
  
  For some environment variables, the behavior of u-boot needs to change
b445bbb49   Jeremiah Mahler   doc: fix grammati...
3466
  when their values are changed.  This functionality allows functions to
170ab1107   Joe Hershberger   env: Add support ...
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
  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...
3489
  ".callbacks" environment variable in the default or embedded environment.
170ab1107   Joe Hershberger   env: Add support ...
3490

bdf1fe4e6   Joe Hershberger   env: Add regex su...
3491
3492
3493
  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.
1b04047a8   Heinrich Schuchardt   README: U_BOOT_EN...
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
  The signature of the callback functions is:
  
      int callback(const char *name, const char *value, enum env_op op, int flags)
  
  * name - changed environment variable
  * value - new value of the environment variable
  * op - operation (create, overwrite, or delete)
  * flags - attributes of the environment variable change, see flags H_* in
    include/search.h
  
  The return value is 0 if the variable change is accepted and 1 otherwise.
170ab1107   Joe Hershberger   env: Add support ...
3505

2729af9d5   wdenk   * Fix minor NAND ...
3506
3507
  Command Line Parsing:
  =====================
f07771cc2   wdenk   * Fix data abort ...
3508

2729af9d5   wdenk   * Fix minor NAND ...
3509
3510
  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
3511

2729af9d5   wdenk   * Fix minor NAND ...
3512
3513
  Old, simple command line parser:
  --------------------------------
c609719b8   wdenk   Initial revision
3514

2729af9d5   wdenk   * Fix minor NAND ...
3515
3516
  - supports environment variables (through setenv / saveenv commands)
  - several commands on one line, separated by ';'
fe126d8b3   Wolfgang Denk   Change all '$(......
3517
  - variable substitution using "... ${name} ..." syntax
2729af9d5   wdenk   * Fix minor NAND ...
3518
3519
  - special characters ('$', ';') can be escaped by prefixing with '\',
    for example:
fe126d8b3   Wolfgang Denk   Change all '$(......
3520
  	setenv bootcmd bootm \${address}
2729af9d5   wdenk   * Fix minor NAND ...
3521
3522
  - 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
3523

2729af9d5   wdenk   * Fix minor NAND ...
3524
3525
  Hush shell:
  -----------
c609719b8   wdenk   Initial revision
3526

2729af9d5   wdenk   * Fix minor NAND ...
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
  - 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
3537

2729af9d5   wdenk   * Fix minor NAND ...
3538
3539
3540
3541
  (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
3542

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

2729af9d5   wdenk   * Fix minor NAND ...
3548
3549
  Note for Redundant Ethernet Interfaces:
  =======================================
c609719b8   wdenk   Initial revision
3550

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

2729af9d5   wdenk   * Fix minor NAND ...
3555
3556
3557
  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
3558

2729af9d5   wdenk   * Fix minor NAND ...
3559
3560
3561
3562
  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
3563

2729af9d5   wdenk   * Fix minor NAND ...
3564
3565
  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
3566

2729af9d5   wdenk   * Fix minor NAND ...
3567
3568
3569
  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
3570

2729af9d5   wdenk   * Fix minor NAND ...
3571
3572
  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
3573

2729af9d5   wdenk   * Fix minor NAND ...
3574
3575
3576
  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
3577

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

ecee9324d   Ben Warren   Program net devic...
3582
  If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
c0f40859f   Wolfgang Denk   README: white-spa...
3583
  will be programmed into hardware as part of the initialization process.	 This
ecee9324d   Ben Warren   Program net devic...
3584
3585
3586
  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
3587

2729af9d5   wdenk   * Fix minor NAND ...
3588
3589
  Image Formats:
  ==============
c609719b8   wdenk   Initial revision
3590

3310c549a   Marian Balakowicz   [new uImage] Add ...
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
  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
3609

2729af9d5   wdenk   * Fix minor NAND ...
3610
3611
  * 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...
3612
3613
3614
    LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
    Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
    INTEGRITY).
daab59ac0   Andy Shevchenko   avr32: Retire AVR...
3615
  * Target CPU Architecture (Provisions for Alpha, ARM, Intel x86,
afc1ce828   Macpaul Lin   doc/README: docum...
3616
    IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
daab59ac0   Andy Shevchenko   avr32: Retire AVR...
3617
    Currently supported: ARM, Intel x86, MIPS, NDS32, Nios II, PowerPC).
2729af9d5   wdenk   * Fix minor NAND ...
3618
3619
3620
3621
3622
  * Compression Type (uncompressed, gzip, bzip2)
  * Load Address
  * Entry Point
  * Image Name
  * Image Timestamp
c609719b8   wdenk   Initial revision
3623

2729af9d5   wdenk   * Fix minor NAND ...
3624
3625
3626
  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
3627

2729af9d5   wdenk   * Fix minor NAND ...
3628
3629
  Linux Support:
  ==============
c609719b8   wdenk   Initial revision
3630

2729af9d5   wdenk   * Fix minor NAND ...
3631
3632
3633
  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
3634

2729af9d5   wdenk   * Fix minor NAND ...
3635
3636
3637
3638
3639
  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
3640

2729af9d5   wdenk   * Fix minor NAND ...
3641
3642
3643
  - 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
3644

2729af9d5   wdenk   * Fix minor NAND ...
3645
3646
  - 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
3647

2729af9d5   wdenk   * Fix minor NAND ...
3648
3649
3650
3651
3652
3653
  - 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
3654

c609719b8   wdenk   Initial revision
3655

2729af9d5   wdenk   * Fix minor NAND ...
3656
3657
  Linux HOWTO:
  ============
c609719b8   wdenk   Initial revision
3658

2729af9d5   wdenk   * Fix minor NAND ...
3659
3660
  Porting Linux to U-Boot based systems:
  ---------------------------------------
c609719b8   wdenk   Initial revision
3661

2729af9d5   wdenk   * Fix minor NAND ...
3662
3663
3664
3665
  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
3666

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

2729af9d5   wdenk   * Fix minor NAND ...
3669
3670
  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...
3671
3672
  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...
3673
  as your U-Boot configuration in CONFIG_SYS_IMMR.
24ee89b97   wdenk   * Fix mdelay() on...
3674

2eb31b13d   Simon Glass   dm: Update README...
3675
3676
3677
3678
  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
3679

2729af9d5   wdenk   * Fix minor NAND ...
3680
3681
  Configuring the Linux kernel:
  -----------------------------
c609719b8   wdenk   Initial revision
3682

2729af9d5   wdenk   * Fix minor NAND ...
3683
3684
3685
3686
3687
3688
  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
3689

2729af9d5   wdenk   * Fix minor NAND ...
3690
3691
3692
3693
3694
3695
3696
3697
  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...
3698
  	make TQM850L_defconfig
2729af9d5   wdenk   * Fix minor NAND ...
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
  	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
3724

c609719b8   wdenk   Initial revision
3725

2729af9d5   wdenk   * Fix minor NAND ...
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
  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
3739

2729af9d5   wdenk   * Fix minor NAND ...
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
  	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...
3756
3757
3758
  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 ...
3759
3760
3761
3762
3763
3764
3765
3766
  
  - 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 ...
3767
  	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
2729af9d5   wdenk   * Fix minor NAND ...
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
  	> 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 ...
3790
  	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
2729af9d5   wdenk   * Fix minor NAND ...
3791
3792
  	-> 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 ...
3793
  	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
2729af9d5   wdenk   * Fix minor NAND ...
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
  	> 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 ...
3815
3816
3817
3818
  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...
3819
3820
3821
3822
  	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 ...
3823

2729af9d5   wdenk   * Fix minor NAND ...
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
  
  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...
3859
  this includes a checksum verification so you can be sure no data
2729af9d5   wdenk   * Fix minor NAND ...
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
  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...
3906
  If you want to boot a Linux kernel with initial RAM disk, you pass
2729af9d5   wdenk   * Fix minor NAND ...
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
  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...
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
  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...
3990
3991
3992
     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...
3993
     Load Address: 00000000
a9398e018   Wolfgang Denk   Minor code cleanu...
3994
     Entry Point:	 00000000
0267768ed   Matthew McClintock   * Modify bootm co...
3995
3996
3997
3998
3999
4000
     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 ...
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
  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"...
4040
4041
4042
4043
4044
4045
  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...
4046
  Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
017e1f3f9   Marek Vasut   BOOT: Add RAW ram...
4047
4048
4049
  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 ...
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
  
  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...
4147
4148
4149
  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 ...
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
  
  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...
4185
  meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
2729af9d5   wdenk   * Fix minor NAND ...
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
  
  
  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...
4210
  	Chris Hallinan posted a good summary of these issues to the
0668236ba   Wolfgang Denk   README: update ma...
4211
  	U-Boot mailing list:
2729af9d5   wdenk   * Fix minor NAND ...
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
  
  	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...
4223
  	beyond the scope of this list to explain the details, but you
2729af9d5   wdenk   * Fix minor NAND ...
4224
4225
4226
4227
4228
  	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...
4229
  	initial stack/RAM area prior to SDRAM being available. Either
2729af9d5   wdenk   * Fix minor NAND ...
4230
4231
4232
4233
  	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...
4234
  	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
2729af9d5   wdenk   * Fix minor NAND ...
4235
4236
  	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...
4237
  	walnut.h should work for you. I'd set it to a value larger
2729af9d5   wdenk   * Fix minor NAND ...
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
  	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...
4252
  * Do not use any uninitialized global data (or implicitly initialized
2729af9d5   wdenk   * Fix minor NAND ...
4253
4254
4255
4256
4257
4258
4259
    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...
4260
  normal global data to share information between the code. But it
2729af9d5   wdenk   * Fix minor NAND ...
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
  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...
4275
  	R2:	reserved for system use
2729af9d5   wdenk   * Fix minor NAND ...
4276
4277
4278
4279
4280
  	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...
4281
4282
4283
  	(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 ...
4284

e7670f6c1   Wolfgang Denk   PPC: Use r2 inste...
4285
      ==> U-Boot will use R2 to hold a pointer to the global data
2729af9d5   wdenk   * Fix minor NAND ...
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
  
      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).
  
  On ARM, the following registers are used:
  
  	R0:	function argument word/integer result
  	R1-R3:	function argument word
12eba1b49   Jeroen Hofstee   README: update AR...
4298
4299
  	R9:	platform specific
  	R10:	stack limit (used only if stack checking is enabled)
2729af9d5   wdenk   * Fix minor NAND ...
4300
4301
4302
4303
4304
  	R11:	argument (frame) pointer
  	R12:	temporary workspace
  	R13:	stack pointer
  	R14:	link register
  	R15:	program counter
12eba1b49   Jeroen Hofstee   README: update AR...
4305
4306
4307
      ==> 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 ...
4308

0df01fd3d   Thomas Chou   nios2: fix r15 is...
4309
4310
4311
4312
4313
4314
4315
  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...
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
  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...
4329
4330
  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 ...
4331

3fafced74   Rick Chen   riscv: doc: Add r...
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
  On RISC-V, the following registers are used:
  
  	x0: hard-wired zero (zero)
  	x1: return address (ra)
  	x2:	stack pointer (sp)
  	x3:	global pointer (gp)
  	x4:	thread pointer (tp)
  	x5:	link register (t0)
  	x8:	frame pointer (fp)
  	x10-x11:	arguments/return values (a0-1)
  	x12-x17:	arguments (a2-7)
  	x28-31:	 temporaries (t3-6)
  	pc:	program counter (pc)
  
      ==> U-Boot will use gp to hold a pointer to the global data
2729af9d5   wdenk   * Fix minor NAND ...
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
  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...
4362
  memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
2729af9d5   wdenk   * Fix minor NAND ...
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
  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
4394

2729af9d5   wdenk   * Fix minor NAND ...
4395
  In the reset configuration, U-Boot starts at the reset entry point
11ccc33fa   Marcel Ziswiler   Many spelling fix...
4396
  (on most PowerPC systems at address 0x00000100). Because of the reset
b445bbb49   Jeremiah Mahler   doc: fix grammati...
4397
  configuration for CS0# this is a mirror of the on board Flash memory.
2729af9d5   wdenk   * Fix minor NAND ...
4398
4399
4400
  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
2eb48ff7a   Heiko Schocher   powerpc, 8260: re...
4401
4402
4403
  which provide such a feature like), or in a locked part of the data
  cache. After that, U-Boot initializes the CPU core, the caches and
  the SIU.
2729af9d5   wdenk   * Fix minor NAND ...
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
  
  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
4432

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

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

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

2729af9d5   wdenk   * Fix minor NAND ...
4443
  	if (available_money > available_manpower) {
6c3fef28b   Jerry Van Baren   Improve U-Boot Po...
4444
  		Pay consultant to port U-Boot;
c609719b8   wdenk   Initial revision
4445
4446
  		return 0;
  	}
2729af9d5   wdenk   * Fix minor NAND ...
4447
  	Download latest U-Boot source;
0668236ba   Wolfgang Denk   README: update ma...
4448
  	Subscribe to u-boot mailing list;
2729af9d5   wdenk   * Fix minor NAND ...
4449

6c3fef28b   Jerry Van Baren   Improve U-Boot Po...
4450
4451
  	if (clueless)
  		email("Hi, I am new to U-Boot, how do I get started?");
2729af9d5   wdenk   * Fix minor NAND ...
4452
4453
4454
  
  	while (learning) {
  		Read the README file in the top level directory;
6c3fef28b   Jerry Van Baren   Improve U-Boot Po...
4455
4456
  		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
  		Read applicable doc/*.README;
2729af9d5   wdenk   * Fix minor NAND ...
4457
  		Read the source, Luke;
6c3fef28b   Jerry Van Baren   Improve U-Boot Po...
4458
  		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
2729af9d5   wdenk   * Fix minor NAND ...
4459
  	}
6c3fef28b   Jerry Van Baren   Improve U-Boot Po...
4460
4461
4462
  	if (available_money > toLocalCurrency ($2500))
  		Buy a BDI3000;
  	else
2729af9d5   wdenk   * Fix minor NAND ...
4463
  		Add a lot of aggravation and time;
2729af9d5   wdenk   * Fix minor NAND ...
4464

6c3fef28b   Jerry Van Baren   Improve U-Boot Po...
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
  	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 ...
4489
  	}
2729af9d5   wdenk   * Fix minor NAND ...
4490
4491
4492
4493
4494
4495
4496
4497
  
  	return 0;
  }
  
  void no_more_time (int sig)
  {
        hire_a_guru();
  }
c609719b8   wdenk   Initial revision
4498

2729af9d5   wdenk   * Fix minor NAND ...
4499
4500
  Coding Standards:
  -----------------
c609719b8   wdenk   Initial revision
4501

2729af9d5   wdenk   * Fix minor NAND ...
4502
  All contributions to U-Boot should conform to the Linux kernel
659208da4   Baruch Siach   README: update th...
4503
4504
4505
  coding style; see the kernel coding style guide at
  https://www.kernel.org/doc/html/latest/process/coding-style.html, and the
  script "scripts/Lindent" in your Linux kernel source directory.
2c0516517   Detlev Zundel   Added changelog e...
4506
4507
4508
  
  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...
4509
  reformatted to ease subsequent migration to newer versions of those
2c0516517   Detlev Zundel   Added changelog e...
4510
4511
4512
4513
4514
  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
4515

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

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

2729af9d5   wdenk   * Fix minor NAND ...
4527
4528
  Submitting Patches:
  -------------------
c609719b8   wdenk   Initial revision
4529

2729af9d5   wdenk   * Fix minor NAND ...
4530
4531
4532
  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
4533

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

0668236ba   Wolfgang Denk   README: update ma...
4536
  Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
1dade18e4   S. Lockwood-Childs   README: update ma...
4537
  see https://lists.denx.de/listinfo/u-boot
0668236ba   Wolfgang Denk   README: update ma...
4538

2729af9d5   wdenk   * Fix minor NAND ...
4539
4540
  When you send a patch, please include the following information with
  it:
c609719b8   wdenk   Initial revision
4541

2729af9d5   wdenk   * Fix minor NAND ...
4542
4543
4544
  * 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
4545

2729af9d5   wdenk   * Fix minor NAND ...
4546
4547
  * For new features: a description of the feature and your
    implementation.
c609719b8   wdenk   Initial revision
4548

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

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

27af930e9   Albert ARIBAUD   Merge and reforma...
4554
4555
  * 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
4556

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

218ca724c   Wolfgang Denk   README: update do...
4560
4561
  * 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...
4562
    "git format-patch". If you then use "git send-email" to send it to
218ca724c   Wolfgang Denk   README: update do...
4563
4564
4565
4566
4567
4568
    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
4569

218ca724c   Wolfgang Denk   README: update do...
4570
4571
4572
4573
    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...
4574

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

2729af9d5   wdenk   * Fix minor NAND ...
4578
4579
  * 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...
4580

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

52f52c149   wdenk   Patches by Robert...
4584

2729af9d5   wdenk   * Fix minor NAND ...
4585
  Notes:
c609719b8   wdenk   Initial revision
4586

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

2729af9d5   wdenk   * Fix minor NAND ...
4591
4592
4593
  * 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
4594

2729af9d5   wdenk   * Fix minor NAND ...
4595
4596
4597
4598
4599
4600
  * 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...
4601

0668236ba   Wolfgang Denk   README: update ma...
4602
4603
4604
4605
  * 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.