Blame view

README 209 KB
c609719b8   wdenk   Initial revision
1
  #
eca3aeb35   Wolfgang Denk   Licenses: introdu...
2
  # (C) Copyright 2000 - 2013
c609719b8   wdenk   Initial revision
3
4
  # Wolfgang Denk, DENX Software Engineering, wd@denx.de.
  #
eca3aeb35   Wolfgang Denk   Licenses: introdu...
5
  # SPDX-License-Identifier:	GPL-2.0+
c609719b8   wdenk   Initial revision
6
7
8
9
  #
  
  Summary:
  ========
24ee89b97   wdenk   * Fix mdelay() on...
10
  This directory contains the source code for U-Boot, a boot loader for
e86e5a074   wdenk   Code cleanup for ...
11
12
13
14
  Embedded boards based on PowerPC, ARM, MIPS and several other
  processors, which can be installed in a boot ROM and used to
  initialize and test the hardware or to download and run application
  code.
c609719b8   wdenk   Initial revision
15
16
  
  The development of U-Boot is closely related to Linux: some parts of
24ee89b97   wdenk   * Fix mdelay() on...
17
18
  the source code originate in the Linux source tree, we have some
  header files in common, and special provision has been made to
c609719b8   wdenk   Initial revision
19
20
21
22
23
24
25
26
27
28
29
30
31
32
  support booting of Linux images.
  
  Some attention has been paid to make this software easily
  configurable and extendable. For instance, all monitor commands are
  implemented with the same call interface, so that it's very easy to
  add new commands. Also, instead of permanently adding rarely used
  code (for instance hardware test utilities) to the monitor, you can
  load and run it dynamically.
  
  
  Status:
  =======
  
  In general, all boards for which a configuration option exists in the
24ee89b97   wdenk   * Fix mdelay() on...
33
  Makefile have been tested to some extent and can be considered
c609719b8   wdenk   Initial revision
34
  "working". In fact, many of them are used in production systems.
24ee89b97   wdenk   * Fix mdelay() on...
35
  In case of problems see the CHANGELOG and CREDITS files to find out
27af930e9   Albert ARIBAUD   Merge and reforma...
36
  who contributed the specific port. The boards.cfg file lists board
218ca724c   Wolfgang Denk   README: update do...
37
  maintainers.
c609719b8   wdenk   Initial revision
38

adb9d8513   Robert P. J. Day   README: Explain h...
39
40
41
42
  Note: There is no CHANGELOG file in the actual U-Boot source tree;
  it can be created dynamically from the Git log using:
  
  	make CHANGELOG
c609719b8   wdenk   Initial revision
43
44
45
  
  Where to get help:
  ==================
24ee89b97   wdenk   * Fix mdelay() on...
46
47
  In case you have questions about, problems with or contributions for
  U-Boot you should send a message to the U-Boot mailing list at
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
55
56
57
58
59
60
  Where to get source code:
  =========================
  
  The U-Boot source code is maintained in the git repository at
  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...
61
  any version you might be interested in. Official releases are also
218ca724c   Wolfgang Denk   README: update do...
62
63
  available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
  directory.
d4ee711d8   Anatolij Gustschin   README: update do...
64
  Pre-built (and tested) images are available from
218ca724c   Wolfgang Denk   README: update do...
65
  ftp://ftp.denx.de/pub/u-boot/images/
c609719b8   wdenk   Initial revision
66
67
68
69
  Where we come from:
  ===================
  
  - start from 8xxrom sources
24ee89b97   wdenk   * Fix mdelay() on...
70
  - create PPCBoot project (http://sourceforge.net/projects/ppcboot)
c609719b8   wdenk   Initial revision
71
72
73
74
75
76
77
  - 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...
78
    * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
24ee89b97   wdenk   * Fix mdelay() on...
79
  - create ARMBoot project (http://sourceforge.net/projects/armboot)
c609719b8   wdenk   Initial revision
80
  - add other CPU families (starting with ARM)
24ee89b97   wdenk   * Fix mdelay() on...
81
  - create U-Boot project (http://sourceforge.net/projects/u-boot)
0d28f34bb   Magnus Lilja   Update the U-Boot...
82
  - current project page: see http://www.denx.de/wiki/U-Boot
24ee89b97   wdenk   * Fix mdelay() on...
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
  
  
  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
105

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

c609719b8   wdenk   Initial revision
120
121
  Directory Hierarchy:
  ====================
8d321b81c   Peter Tyser   Update README to ...
122
123
124
125
126
  /arch			Architecture specific files
    /arm			Files generic to ARM architecture
      /cpu		CPU specific files
        /arm720t		Files specific to ARM 720 CPUs
        /arm920t		Files specific to ARM 920 CPUs
6eb0921a7   Andreas Bießmann   README: fix arm92...
127
  	/at91		Files specific to Atmel AT91RM9200 CPU
a9046b9e1   Wolfgang Denk   Prepare v2010-rc2
128
129
  	/imx		Files specific to Freescale MC9328 i.MX CPUs
  	/s3c24x0	Files specific to Samsung S3C24X0 CPUs
8d321b81c   Peter Tyser   Update README to ...
130
131
        /arm926ejs	Files specific to ARM 926 CPUs
        /arm1136		Files specific to ARM 1136 CPUs
8d321b81c   Peter Tyser   Update README to ...
132
        /pxa		Files specific to Intel XScale PXA CPUs
8d321b81c   Peter Tyser   Update README to ...
133
134
135
136
137
138
139
140
        /sa1100		Files specific to Intel StrongARM SA1100 CPUs
      /lib		Architecture specific library files
    /avr32		Files generic to AVR32 architecture
      /cpu		CPU specific files
      /lib		Architecture specific library files
    /blackfin		Files generic to Analog Devices Blackfin architecture
      /cpu		CPU specific files
      /lib		Architecture specific library files
8d321b81c   Peter Tyser   Update README to ...
141
142
143
144
145
146
147
148
149
150
151
152
153
    /m68k			Files generic to m68k architecture
      /cpu		CPU specific files
        /mcf52x2		Files specific to Freescale ColdFire MCF52x2 CPUs
        /mcf5227x		Files specific to Freescale ColdFire MCF5227x CPUs
        /mcf532x		Files specific to Freescale ColdFire MCF5329 CPUs
        /mcf5445x		Files specific to Freescale ColdFire MCF5445x CPUs
        /mcf547x_8x	Files specific to Freescale ColdFire MCF547x_8x CPUs
      /lib		Architecture specific library files
    /microblaze		Files generic to microblaze architecture
      /cpu		CPU specific files
      /lib		Architecture specific library files
    /mips			Files generic to MIPS architecture
      /cpu		CPU specific files
92bbd64e3   Daniel Schwierzeck   README: update MI...
154
        /mips32		Files specific to MIPS32 CPUs
80421fcc3   Xiangfu Liu   MIPS: Ingenic XBu...
155
        /xburst		Files specific to Ingenic XBurst CPUs
8d321b81c   Peter Tyser   Update README to ...
156
      /lib		Architecture specific library files
afc1ce828   Macpaul Lin   doc/README: docum...
157
158
159
160
    /nds32		Files generic to NDS32 architecture
      /cpu		CPU specific files
        /n1213		Files specific to Andes Technology N1213 CPUs
      /lib		Architecture specific library files
8d321b81c   Peter Tyser   Update README to ...
161
162
163
    /nios2		Files generic to Altera NIOS2 architecture
      /cpu		CPU specific files
      /lib		Architecture specific library files
33c7731bd   Robert P. J. Day   Cosmetic: Update ...
164
165
166
    /openrisc		Files generic to OpenRISC architecture
      /cpu		CPU specific files
      /lib		Architecture specific library files
a47a12bec   Stefan Roese   Move arch/ppc to ...
167
    /powerpc		Files generic to PowerPC architecture
8d321b81c   Peter Tyser   Update README to ...
168
169
170
171
172
      /cpu		CPU specific files
        /74xx_7xx		Files specific to Freescale MPC74xx and 7xx CPUs
        /mpc5xx		Files specific to Freescale MPC5xx CPUs
        /mpc5xxx		Files specific to Freescale MPC5xxx CPUs
        /mpc8xx		Files specific to Freescale MPC8xx CPUs
8d321b81c   Peter Tyser   Update README to ...
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
        /mpc824x		Files specific to Freescale MPC824x CPUs
        /mpc8260		Files specific to Freescale MPC8260 CPUs
        /mpc85xx		Files specific to Freescale MPC85xx CPUs
        /ppc4xx		Files specific to AMCC PowerPC 4xx CPUs
      /lib		Architecture specific library files
    /sh			Files generic to SH architecture
      /cpu		CPU specific files
        /sh2		Files specific to sh2 CPUs
        /sh3		Files specific to sh3 CPUs
        /sh4		Files specific to sh4 CPUs
      /lib		Architecture specific library files
    /sparc		Files generic to SPARC architecture
      /cpu		CPU specific files
        /leon2		Files specific to Gaisler LEON2 SPARC CPU
        /leon3		Files specific to Gaisler LEON3 SPARC CPU
      /lib		Architecture specific library files
33c7731bd   Robert P. J. Day   Cosmetic: Update ...
189
190
191
    /x86			Files generic to x86 architecture
      /cpu		CPU specific files
      /lib		Architecture specific library files
8d321b81c   Peter Tyser   Update README to ...
192
193
194
195
196
197
  /api			Machine/arch independent API for external apps
  /board			Board dependent files
  /common			Misc architecture independent functions
  /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 ...
198
  /dts			Contains Makefile for building internal U-Boot fdt.
8d321b81c   Peter Tyser   Update README to ...
199
200
201
202
203
204
205
206
207
  /examples		Example code for standalone applications, etc.
  /fs			Filesystem code (cramfs, ext2, jffs2, etc.)
  /include		Header Files
  /lib			Files generic to all architectures
    /libfdt		Library files to support flattened device trees
    /lzma			Library files to support LZMA decompression
    /lzo			Library files to support LZO decompression
  /net			Networking code
  /post			Power On Self Test
33c7731bd   Robert P. J. Day   Cosmetic: Update ...
208
  /spl			Secondary Program Loader framework
8d321b81c   Peter Tyser   Update README to ...
209
  /tools			Tools to build S-Record or U-Boot images, etc.
c609719b8   wdenk   Initial revision
210

c609719b8   wdenk   Initial revision
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
  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...
226
    "CONFIG_SYS_".
c609719b8   wdenk   Initial revision
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
  
  Later we will add a configuration tool - probably similar to or even
  identical to what's used for the Linux kernel. Right now, we have to
  do the configuration by hand, which means creating some symbolic
  links and editing some configuration files. We use the TQM8xxL boards
  as an example here.
  
  
  Selection of Processor Architecture and Board Type:
  ---------------------------------------------------
  
  For all supported boards there are ready-to-use default
  configurations available; just type "make <board_name>_config".
  
  Example: For a TQM823L module type:
  
  	cd u-boot
  	make TQM823L_config
11ccc33fa   Marcel Ziswiler   Many spelling fix...
245
  For the Cogent platform, you need to specify the CPU type as well;
c609719b8   wdenk   Initial revision
246
247
248
249
250
251
252
253
254
255
256
257
258
  e.g. "make cogent_mpc8xx_config". And also configure the cogent
  directory according to the instructions in cogent/README.
  
  
  Configuration Options:
  ----------------------
  
  Configuration depends on the combination of board and CPU type; all
  such information is kept in a configuration file
  "include/configs/<board_name>.h".
  
  Example: For a TQM823L module, all configuration settings are in
  "include/configs/TQM823L.h".
7f6c2cbc2   wdenk   * Vince Husovsky,...
259
260
261
  Many of the options are named exactly as the corresponding Linux
  kernel configuration options. The intention is to make it easier to
  build a config tool - later.
c609719b8   wdenk   Initial revision
262
  The following options need to be configured:
2628114ec   Kim Phillips   README: Remove ou...
263
264
265
  - CPU Type:	Define exactly one, e.g. CONFIG_MPC85XX.
  
  - Board Type:	Define exactly one, e.g. CONFIG_MPC8540ADS.
6ccec4492   Wolfgang Denk   Add ATSTK1000 and...
266
267
  
  - CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
09ea0de03   Haavard Skinnemoen   README: Remove AT...
268
  		Define exactly one, e.g. CONFIG_ATSTK1002
c609719b8   wdenk   Initial revision
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
  
  - CPU Module Type: (if CONFIG_COGENT is defined)
  		Define exactly one of
  		CONFIG_CMA286_60_OLD
  --- FIXME --- not tested yet:
  		CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
  		CONFIG_CMA287_23, CONFIG_CMA287_50
  
  - Motherboard Type: (if CONFIG_COGENT is defined)
  		Define exactly one of
  		CONFIG_CMA101, CONFIG_CMA102
  
  - Motherboard I/O Modules: (if CONFIG_COGENT is defined)
  		Define one or more of
  		CONFIG_CMA302
  
  - Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
  		Define one or more of
  		CONFIG_LCD_HEARTBEAT	- update a character position on
11ccc33fa   Marcel Ziswiler   Many spelling fix...
288
  					  the LCD display every second with
c609719b8   wdenk   Initial revision
289
  					  a "rotator" |\-/|\-/
2535d6027   wdenk   * Patch by Martin...
290
291
292
  - Board flavour: (if CONFIG_MPC8260ADS is defined)
  		CONFIG_ADSTYPE
  		Possible values are:
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
293
294
295
296
  			CONFIG_SYS_8260ADS	- original MPC8260ADS
  			CONFIG_SYS_8266ADS	- MPC8266ADS
  			CONFIG_SYS_PQ2FADS	- PQ2FADS-ZU or PQ2FADS-VR
  			CONFIG_SYS_8272ADS	- MPC8272ADS
2535d6027   wdenk   * Patch by Martin...
297

cf946c6d0   Lei Wen   mv: seperate kirk...
298
299
300
301
  - Marvell Family Member
  		CONFIG_SYS_MVFS		- define it if you want to enable
  					  multiple fs option at one time
  					  for marvell soc family
c609719b8   wdenk   Initial revision
302
  - MPC824X Family Member (if CONFIG_MPC824X is defined)
5da627a42   wdenk   * Patch by Steven...
303
304
  		Define exactly one of
  		CONFIG_MPC8240, CONFIG_MPC8245
c609719b8   wdenk   Initial revision
305

11ccc33fa   Marcel Ziswiler   Many spelling fix...
306
  - 8xx CPU Options: (if using an MPC8xx CPU)
66ca92a5b   wdenk   * Patch by Yuli B...
307
308
  		CONFIG_8xx_GCLK_FREQ	- deprecated: CPU clock if
  					  get_gclk_freq() cannot work
5da627a42   wdenk   * Patch by Steven...
309
310
  					  e.g. if there is no 32KHz
  					  reference PIT/RTC clock
66ca92a5b   wdenk   * Patch by Yuli B...
311
312
  		CONFIG_8xx_OSCLK	- PLL input clock (either EXTCLK
  					  or XTAL/EXTAL)
c609719b8   wdenk   Initial revision
313

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

ba56f6257   wdenk   Patch by Travis S...
321
322
323
324
325
  		Define this to measure the actual CPU clock instead
  		of relying on the correctness of the configured
  		values. Mostly useful for board bringup to make sure
  		the PLL is locked at the intended frequency. Note
  		that this requires a (stable) reference clock (32 kHz
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
326
  		RTC clock or CONFIG_SYS_8XX_XIN)
75d1ea7f6   wdenk   Fix variable CPU ...
327

506f39188   Heiko Schocher   8xx, icache: enab...
328
329
330
331
  		CONFIG_SYS_DELAYED_ICACHE
  
  		Define this option if you want to enable the
  		ICache only when Code runs from RAM.
66412c637   Kumar Gala   powerpc/85xx: Cha...
332
  - 85xx CPU Options:
ffd06e023   York Sun   powerpc/mpc85xx: ...
333
334
335
336
337
  		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...
338
339
340
341
342
  		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: ...
343
344
345
346
  		CONFIG_SYS_FSL_PCIE_COMPAT
  
  		Defines the string to utilize when trying to match PCIe device
  		tree nodes for the given platform.
afa6b551f   Prabhakar Kushwaha   PATCH 1/4][v4] do...
347
348
349
350
351
352
353
354
  		CONFIG_SYS_PPC_E500_DEBUG_TLB
  
  		Enables a temporary TLB entry to be used during boot to work
  		around limitations in e500v1 and e500v2 external debugger
  		support. This reduces the portions of the boot code where
  		breakpoints and single stepping do not work.  The value of this
  		symbol should be set to the TLB1 entry to be used for this
  		purpose.
33eee330c   Scott Wood   powerpc/fsl-coren...
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
  		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...
374
375
376
  		CONFIG_A003399_NOR_WORKAROUND
  		Enables a workaround for IFC erratum A003399. It is only
  		requred during NOR boot.
33eee330c   Scott Wood   powerpc/fsl-coren...
377
378
379
380
  		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
  
  		This is the value to write into CCSR offset 0x18600
  		according to the A004510 workaround.
64501c669   Priyanka Jain   board/bsc9132qds:...
381
382
383
  		CONFIG_SYS_FSL_DSP_DDR_ADDR
  		This value denotes start offset of DDR memory which is
  		connected exclusively to the DSP cores.
765b0bdb8   Priyanka Jain   board/bsc9131rdb:...
384
385
386
  		CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
  		This value denotes start offset of M2 memory
  		which is directly connected to the DSP core.
64501c669   Priyanka Jain   board/bsc9132qds:...
387
388
389
  		CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
  		This value denotes start offset of M3 memory which is directly
  		connected to the DSP core.
765b0bdb8   Priyanka Jain   board/bsc9131rdb:...
390
391
  		CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
  		This value denotes start offset of DSP CCSR space.
b135991a3   Priyanka Jain   powerpc/mpc85xx: ...
392
393
394
395
  		CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
  		Single Source Clock is clocking mode present in some of FSL SoC's.
  		In this mode, a single differential clock is used to supply
  		clocks to the sysclock, ddrclock and usbclock.
6cb461b4f   Daniel Schwierzeck   MIPS: fix endiane...
396
397
398
399
400
  - 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...
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
  		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.
9ac4ffbde   York Sun   Driver/DDR: Add F...
421
422
  		CONFIG_SYS_FSL_DDRC_ARM_GEN3
  		Freescale DDR3 controller for ARM-based SoCs.
5614e71b4   York Sun   Driver/DDR: Movin...
423
424
425
426
427
428
429
430
431
432
433
434
435
  		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
  		Board config to use DDR2. It can be eanbeld for SoCs with
  		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
  		Freescale DDR3 controllers.
1b4175d6f   Prabhakar Kushwaha   driver/ifc:Change...
436
437
438
439
440
  		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
690e42584   Prabhakar Kushwaha   powerpc:Rename CO...
441
442
443
444
445
446
447
448
  		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...
449
450
451
452
453
  		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...
454
455
456
457
  		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...
458
459
460
461
  		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.
0b953ffc6   Markus Klotzbuecher   Monahans related ...
462
  - Intel Monahans options:
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
463
  		CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
0b953ffc6   Markus Klotzbuecher   Monahans related ...
464
465
466
467
  
  		Defines the Monahans run mode to oscillator
  		ratio. Valid values are 8, 16, 24, 31. The core
  		frequency is this value multiplied by 13 MHz.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
468
  		CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
cf48eb9ab   Wolfgang Denk   Some code cleanup
469

0b953ffc6   Markus Klotzbuecher   Monahans related ...
470
471
  		Defines the Monahans turbo mode to oscillator
  		ratio. Valid values are 1 (default if undefined) and
cf48eb9ab   Wolfgang Denk   Some code cleanup
472
  		2. The core frequency as calculated above is multiplied
0b953ffc6   Markus Klotzbuecher   Monahans related ...
473
  		by this value.
cf48eb9ab   Wolfgang Denk   Some code cleanup
474

92bbd64e3   Daniel Schwierzeck   README: update MI...
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
  - MIPS CPU options:
  		CONFIG_SYS_INIT_SP_OFFSET
  
  		Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
  		pointer. This is needed for the temporary stack before
  		relocation.
  
  		CONFIG_SYS_MIPS_CACHE_MODE
  
  		Cache operation mode for the MIPS CPU.
  		See also arch/mips/include/asm/mipsregs.h.
  		Possible values are:
  			CONF_CM_CACHABLE_NO_WA
  			CONF_CM_CACHABLE_WA
  			CONF_CM_UNCACHED
  			CONF_CM_CACHABLE_NONCOHERENT
  			CONF_CM_CACHABLE_CE
  			CONF_CM_CACHABLE_COW
  			CONF_CM_CACHABLE_CUW
  			CONF_CM_CACHABLE_ACCELERATED
  
  		CONFIG_SYS_XWAY_EBU_BOOTCFG
  
  		Special option for Lantiq XWAY SoCs for booting from NOR flash.
  		See also arch/mips/cpu/mips32/start.S.
  
  		CONFIG_XWAY_SWAP_BYTES
  
  		Enable compilation of tools/xway-swap-bytes needed for Lantiq
  		XWAY SoCs for booting from NOR flash. The U-Boot image needs to
  		be swapped if a flash programmer is used.
b67d8816f   Christian Riesch   arm, arm926ejs: A...
506
507
508
509
510
  - ARM options:
  		CONFIG_SYS_EXCEPTION_VECTORS_HIGH
  
  		Select high exception vectors of the ARM core, e.g., do not
  		clear the V bit of the c1 register of CP15.
5356f5451   Aneesh V   ARM: enable Thumb...
511
512
513
514
515
516
517
  		CONFIG_SYS_THUMB_BUILD
  
  		Use this flag to build U-Boot using the Thumb instruction
  		set for ARM architectures. Thumb instruction set provides
  		better code density. For ARM architectures that support
  		Thumb2 this flag will result in Thumb2 code generated by
  		GCC.
c5d4752c0   Stephen Warren   ARM: implement er...
518
  		CONFIG_ARM_ERRATA_716044
0678587fb   Stephen Warren   ARM: implement so...
519
520
521
522
523
524
525
526
527
  		CONFIG_ARM_ERRATA_742230
  		CONFIG_ARM_ERRATA_743622
  		CONFIG_ARM_ERRATA_751472
  
  		If set, the workarounds for these ARM errata are applied early
  		during U-Boot startup. Note that these options force the
  		workarounds to be applied; no CPU-type/version detection
  		exists, unlike the similar options in the Linux kernel. Do not
  		set these options unless they apply!
795659dc1   Stephen Warren   README: document ...
528
529
530
531
532
533
  - CPU timer options:
  		CONFIG_SYS_HZ
  
  		The frequency of the timer returned by get_timer().
  		get_timer() must operate in milliseconds and this CONFIG
  		option must be set to 1000.
5da627a42   wdenk   * Patch by Steven...
534
  - Linux Kernel Interface:
c609719b8   wdenk   Initial revision
535
536
537
538
539
540
541
542
543
  		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
544
  		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
218ca724c   Wolfgang Denk   README: update do...
545
  		"clocks_in_mhz=1" is automatically included in the
c609719b8   wdenk   Initial revision
546
  		default environment.
5da627a42   wdenk   * Patch by Steven...
547
  		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]
11ccc33fa   Marcel Ziswiler   Many spelling fix...
548
  		When transferring memsize parameter to linux, some versions
5da627a42   wdenk   * Patch by Steven...
549
550
  		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...
551
  		CONFIG_OF_LIBFDT
f57f70aab   Wolfgang Denk   Support passing o...
552
553
  
  		New kernel versions are expecting firmware settings to be
213bf8c82   Gerald Van Baren   Add a flattened d...
554
555
556
557
558
559
  		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...
560
  		 * The bootm command automatically updates the fdt
213bf8c82   Gerald Van Baren   Add a flattened d...
561

b55ae4024   Marcel Ziswiler   FDT: remove obsol...
562
563
564
565
  		OF_CPU - The proper name of the cpus node (only required for
  			MPC512X and MPC5xxx based boards).
  		OF_SOC - The proper name of the soc node (only required for
  			MPC512X and MPC5xxx based boards).
f57f70aab   Wolfgang Denk   Support passing o...
566
  		OF_TBCLK - The timebase frequency.
c2871f038   Kumar Gala   Added OF_STDOUT_P...
567
  		OF_STDOUT_PATH - The path to the console device
f57f70aab   Wolfgang Denk   Support passing o...
568

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

4e2531378   Kumar Gala   Allow board code ...
572
573
574
575
  		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...
576

0267768ed   Matthew McClintock   * Modify bootm co...
577
  		CONFIG_OF_BOOT_CPU
11ccc33fa   Marcel Ziswiler   Many spelling fix...
578
  		This define fills in the correct boot CPU in the boot
0267768ed   Matthew McClintock   * Modify bootm co...
579
  		param header, the default value is zero if undefined.
3887c3fbd   Heiko Schocher   mucmc52, uc101: d...
580
581
582
583
584
585
586
587
  		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...
588
589
590
591
592
593
594
595
596
  		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 ...
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
  - vxWorks boot parameters:
  
  		bootvx constructs a valid bootline using the following
  		environments variables: bootfile, ipaddr, serverip, hostname.
  		It loads the vxWorks image pointed bootfile.
  
  		CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
  		CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
  		CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
  		CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
  
  		CONFIG_SYS_VXWORKS_ADD_PARAMS
  
  		Add it at the end of the bootline. E.g "u=username pw=secret"
  
  		Note: If a "bootargs" environment is defined, it will overwride
  		the defaults discussed just above.
2c451f783   Aneesh V   armv7: cache main...
614
615
616
617
  - Cache Configuration:
  		CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
  		CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
  		CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
93bc21930   Aneesh V   armv7: add PL310 ...
618
619
620
621
622
  - 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...
623
  - Serial Ports:
48d0192fe   Andreas Engel   Moved conditional...
624
  		CONFIG_PL010_SERIAL
6705d81e9   wdenk   * Patch by Andrea...
625
626
  
  		Define this if you want support for Amba PrimeCell PL010 UARTs.
48d0192fe   Andreas Engel   Moved conditional...
627
  		CONFIG_PL011_SERIAL
6705d81e9   wdenk   * Patch by Andrea...
628
629
630
631
632
633
634
635
636
637
638
639
640
  
  		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
910f1ae3e   John Rigby   Serial: p1011: ne...
641
642
643
644
645
646
647
648
649
650
651
  		CONFIG_PL011_SERIAL_RLCR
  
  		Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
  		have separate receive and transmit line control registers.  Set
  		this variable to initialize the extra register.
  
  		CONFIG_PL011_SERIAL_FLUSH_ON_INIT
  
  		On some platforms (e.g. U8500) U-Boot is loaded by a second stage
  		boot loader that has already initialized the UART.  Define this
  		variable to flush the UART at init time.
6705d81e9   wdenk   * Patch by Andrea...
652

c609719b8   wdenk   Initial revision
653
  - Console Interface:
43d9616cf   wdenk   * Patch by Robert...
654
655
656
657
  		Depending on board, define exactly one serial port
  		(like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
  		CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
  		console by defining CONFIG_8xx_CONS_NONE
c609719b8   wdenk   Initial revision
658
659
660
661
662
663
664
  
  		Note: if CONFIG_8xx_CONS_NONE is defined, the serial
  		port routines must be defined elsewhere
  		(i.e. serial_init(), serial_getc(), ...)
  
  		CONFIG_CFB_CONSOLE
  		Enables console device for a color framebuffer. Needs following
c53043b7f   Wolfgang Denk   MPC7xx: remove ob...
665
  		defines (cf. smiLynxEM, i8042)
c609719b8   wdenk   Initial revision
666
667
668
669
670
671
672
673
674
  			VIDEO_FB_LITTLE_ENDIAN	graphic memory organisation
  						(default big endian)
  			VIDEO_HW_RECTFILL	graphic chip supports
  						rectangle fill
  						(cf. smiLynxEM)
  			VIDEO_HW_BITBLT		graphic chip supports
  						bit-blit (cf. smiLynxEM)
  			VIDEO_VISIBLE_COLS	visible pixel columns
  						(cols=pitch)
ba56f6257   wdenk   Patch by Travis S...
675
676
  			VIDEO_VISIBLE_ROWS	visible pixel rows
  			VIDEO_PIXEL_SIZE	bytes per pixel
c609719b8   wdenk   Initial revision
677
678
  			VIDEO_DATA_FORMAT	graphic data format
  						(0-5, cf. cfb_console.c)
ba56f6257   wdenk   Patch by Travis S...
679
  			VIDEO_FB_ADRS		framebuffer address
c609719b8   wdenk   Initial revision
680
681
682
683
684
685
686
687
688
  			VIDEO_KBD_INIT_FCT	keyboard int fct
  						(i.e. i8042_kbd_init())
  			VIDEO_TSTC_FCT		test char fct
  						(i.e. i8042_tstc)
  			VIDEO_GETC_FCT		get char fct
  						(i.e. i8042_getc)
  			CONFIG_CONSOLE_CURSOR	cursor drawing on/off
  						(requires blink timer
  						cf. i8042.c)
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
689
  			CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
c609719b8   wdenk   Initial revision
690
691
  			CONFIG_CONSOLE_TIME	display time/date info in
  						upper right corner
602ad3b33   Jon Loeliger   README: Rewrite c...
692
  						(requires CONFIG_CMD_DATE)
c609719b8   wdenk   Initial revision
693
694
  			CONFIG_VIDEO_LOGO	display Linux logo in
  						upper left corner
a6c7ad2f6   wdenk   * Fix startup pro...
695
696
697
  			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
  						linux_logo.h for logo.
  						Requires CONFIG_VIDEO_LOGO
c609719b8   wdenk   Initial revision
698
  			CONFIG_CONSOLE_EXTRA_INFO
11ccc33fa   Marcel Ziswiler   Many spelling fix...
699
  						additional board info beside
c609719b8   wdenk   Initial revision
700
  						the logo
33a35bbbe   Pali Rohár   cfb_console: Add ...
701
702
703
  		When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
  		a limited number of ANSI escape sequences (cursor control,
  		erase functions and limited graphics rendition control).
43d9616cf   wdenk   * Patch by Robert...
704
705
706
  		When CONFIG_CFB_CONSOLE is defined, video console is
  		default i/o. Serial console can be forced with
  		environment 'console=serial'.
c609719b8   wdenk   Initial revision
707

d4ca31c40   wdenk   * Cleanup lowboot...
708
709
710
711
  		When CONFIG_SILENT_CONSOLE is defined, all console
  		messages (by U-Boot and Linux!) can be silenced with
  		the "silent" environment variable. See
  		doc/README.silent for more information.
a3ad8e26a   wdenk   * Patch by Steven...
712

45ae2546e   Heiko Schocher   video, cfb_consol...
713
714
715
716
  		CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
  			is 0x00.
  		CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
  			is 0xa0.
c609719b8   wdenk   Initial revision
717
718
719
  - Console Baudrate:
  		CONFIG_BAUDRATE - in bps
  		Select one of the baudrates listed in
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
720
721
  		CONFIG_SYS_BAUDRATE_TABLE, see below.
  		CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
c609719b8   wdenk   Initial revision
722

c92fac91a   Heiko Schocher   82xx serial, smc:...
723
724
725
  - Console Rx buffer length
  		With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
  		the maximum receive buffer length for the SMC.
2b3f12c21   Heiko Schocher   8xx serial, smc: ...
726
  		This option is actual only for 82xx and 8xx possible.
c92fac91a   Heiko Schocher   82xx serial, smc:...
727
728
729
  		If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
  		must be defined, to setup the maximum idle timeout for
  		the SMC.
9558b48af   Graeme Russ   console: Implemen...
730
  - Pre-Console Buffer:
4cf2609b0   Wolfgang Denk   README: fix docum...
731
732
733
734
735
736
737
  		Prior to the console being initialised (i.e. serial UART
  		initialised etc) all console output is silently discarded.
  		Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
  		buffer any console messages prior to the console being
  		initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
  		bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
  		a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
6feff899e   Wolfgang Denk   README: fix typos...
738
  		bytes are output before the console is initialised, the
4cf2609b0   Wolfgang Denk   README: fix docum...
739
740
741
742
  		earlier bytes are discarded.
  
  		'Sane' compilers will generate smaller code if
  		CONFIG_PRE_CON_BUF_SZ is a power of 2
9558b48af   Graeme Russ   console: Implemen...
743

046a37bd5   Sonny Rao   Add safe vsnprint...
744
745
746
747
748
749
750
751
  - Safe printf() functions
  		Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
  		the printf() functions. These are defined in
  		include/vsprintf.h and include snprintf(), vsnprintf() and
  		so on. Code size increase is approximately 300-500 bytes.
  		If this option is not given then these functions will
  		silently discard their buffer size argument - this means
  		you are not getting any overflow checking in this case.
c609719b8   wdenk   Initial revision
752
753
754
  - Boot Delay:	CONFIG_BOOTDELAY - in seconds
  		Delay before automatically booting the default image;
  		set to -1 to disable autoboot.
93d7212fa   Joe Hershberger   Allow runtime con...
755
756
  		set to -2 to autoboot with no delay and not check for abort
  		(even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
c609719b8   wdenk   Initial revision
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
  
  		See doc/README.autoboot for these options that
  		work with CONFIG_BOOTDELAY. None are required.
  		CONFIG_BOOT_RETRY_TIME
  		CONFIG_BOOT_RETRY_MIN
  		CONFIG_AUTOBOOT_KEYED
  		CONFIG_AUTOBOOT_PROMPT
  		CONFIG_AUTOBOOT_DELAY_STR
  		CONFIG_AUTOBOOT_STOP_STR
  		CONFIG_AUTOBOOT_DELAY_STR2
  		CONFIG_AUTOBOOT_STOP_STR2
  		CONFIG_ZERO_BOOTDELAY_CHECK
  		CONFIG_RESET_TO_RETRY
  
  - Autoboot Command:
  		CONFIG_BOOTCOMMAND
  		Only needed when CONFIG_BOOTDELAY is enabled;
  		define a command string that is automatically executed
  		when no character is read on the console interface
  		within "Boot Delay" after reset.
  
  		CONFIG_BOOTARGS
43d9616cf   wdenk   * Patch by Robert...
779
780
781
  		This can be used to pass arguments to the bootm
  		command. The value of CONFIG_BOOTARGS goes into the
  		environment value "bootargs".
c609719b8   wdenk   Initial revision
782
783
  
  		CONFIG_RAMBOOT and CONFIG_NFSBOOT
43d9616cf   wdenk   * Patch by Robert...
784
785
786
  		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...
787
  		RAM and NFS.
c609719b8   wdenk   Initial revision
788

eda0ba38a   Heiko Schocher   bootcount: store ...
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
  - Bootcount:
  		CONFIG_BOOTCOUNT_LIMIT
  		Implements a mechanism for detecting a repeating reboot
  		cycle, see:
  		http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
  
  		CONFIG_BOOTCOUNT_ENV
  		If no softreset save registers are found on the hardware
  		"bootcount" is stored in the environment. To prevent a
  		saveenv on all reboots, the environment variable
  		"upgrade_available" is used. If "upgrade_available" is
  		0, "bootcount" is always 0, if "upgrade_available" is
  		1 "bootcount" is incremented in the environment.
  		So the Userspace Applikation must set the "upgrade_available"
  		and "bootcount" variable to 0, if a boot was successfully.
c609719b8   wdenk   Initial revision
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
  - Pre-Boot Commands:
  		CONFIG_PREBOOT
  
  		When this option is #defined, the existence of the
  		environment variable "preboot" will be checked
  		immediately before starting the CONFIG_BOOTDELAY
  		countdown and/or running the auto-boot command resp.
  		entering interactive mode.
  
  		This feature is especially useful when "preboot" is
  		automatically generated or modified. For an example
  		see the LWMON board specific code: here "preboot" is
  		modified when the user holds down a certain
  		combination of keys on the (special) keyboard when
  		booting the systems
  
  - Serial Download Echo Mode:
  		CONFIG_LOADS_ECHO
  		If defined to 1, all characters received during a
  		serial download (using the "loads" command) are
  		echoed back. This might be needed by some terminal
  		emulations (like "cu"), but may as well just take
  		time on others. This setting #define's the initial
  		value of the "loads_echo" environment variable.
602ad3b33   Jon Loeliger   README: Rewrite c...
828
  - Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
c609719b8   wdenk   Initial revision
829
830
  		CONFIG_KGDB_BAUDRATE
  		Select one of the baudrates listed in
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
831
  		CONFIG_SYS_BAUDRATE_TABLE, see below.
c609719b8   wdenk   Initial revision
832
833
  
  - Monitor Functions:
602ad3b33   Jon Loeliger   README: Rewrite c...
834
835
  		Monitor commands can be included or excluded
  		from the build by using the #include files
c6c621bdb   Stephen Warren   README: fix refer...
836
837
  		<config_cmd_all.h> and #undef'ing unwanted
  		commands, or using <config_cmd_default.h>
602ad3b33   Jon Loeliger   README: Rewrite c...
838
839
840
841
842
843
844
  		and augmenting with additional #define's
  		for wanted commands.
  
  		The default command configuration includes all commands
  		except those marked below with a "*".
  
  		CONFIG_CMD_ASKENV	* ask for env variable
602ad3b33   Jon Loeliger   README: Rewrite c...
845
846
847
848
849
850
  		CONFIG_CMD_BDI		  bdinfo
  		CONFIG_CMD_BEDBUG	* Include BedBug Debugger
  		CONFIG_CMD_BMP		* BMP support
  		CONFIG_CMD_BSP		* Board specific commands
  		CONFIG_CMD_BOOTD	  bootd
  		CONFIG_CMD_CACHE	* icache, dcache
08d0d6f32   Michal Simek   common: Add new c...
851
  		CONFIG_CMD_CLK   	* clock command support
602ad3b33   Jon Loeliger   README: Rewrite c...
852
  		CONFIG_CMD_CONSOLE	  coninfo
710b99385   Mike Frysinger   crc32: make comma...
853
  		CONFIG_CMD_CRC32	* crc32
602ad3b33   Jon Loeliger   README: Rewrite c...
854
855
856
  		CONFIG_CMD_DATE		* support for RTC, date/time...
  		CONFIG_CMD_DHCP		* DHCP support
  		CONFIG_CMD_DIAG		* Diagnostics
a7c931045   Peter Tyser   Add support for M...
857
858
859
860
  		CONFIG_CMD_DS4510	* ds4510 I2C gpio commands
  		CONFIG_CMD_DS4510_INFO	* ds4510 I2C info command
  		CONFIG_CMD_DS4510_MEM	* ds4510 I2C eeprom/sram commansd
  		CONFIG_CMD_DS4510_RST	* ds4510 I2C rst command
602ad3b33   Jon Loeliger   README: Rewrite c...
861
862
  		CONFIG_CMD_DTT		* Digital Therm and Thermostat
  		CONFIG_CMD_ECHO		  echo arguments
246c69225   Peter Tyser   Add 'editenv' com...
863
  		CONFIG_CMD_EDITENV	  edit env variable
602ad3b33   Jon Loeliger   README: Rewrite c...
864
865
  		CONFIG_CMD_EEPROM	* EEPROM read/write support
  		CONFIG_CMD_ELF		* bootelf, bootvx
5e2b3e0c5   Joe Hershberger   env: Add a comman...
866
  		CONFIG_CMD_ENV_CALLBACK	* display details about env callbacks
fffad71bc   Joe Hershberger   env: Add a comman...
867
  		CONFIG_CMD_ENV_FLAGS	* display details about env flags
88733e2c6   Andrew Ruder   cmd_nvedit.c: Add...
868
  		CONFIG_CMD_ENV_EXISTS	* check existence of env variable
0c79cda01   Mike Frysinger   env: make import/...
869
  		CONFIG_CMD_EXPORTENV	* export the environment
03e2ecf6b   Stephen Warren   fs: separate CONF...
870
871
  		CONFIG_CMD_EXT2		* ext2 command support
  		CONFIG_CMD_EXT4		* ext4 command support
16f4d9335   Stephen Warren   README: document ...
872
873
  		CONFIG_CMD_FS_GENERIC	* filesystem commands (e.g. load, ls)
  					  that work for multiple fs types
bdab39d35   Mike Frysinger   rename CONFIG_CMD...
874
  		CONFIG_CMD_SAVEENV	  saveenv
602ad3b33   Jon Loeliger   README: Rewrite c...
875
  		CONFIG_CMD_FDC		* Floppy Disk Support
03e2ecf6b   Stephen Warren   fs: separate CONF...
876
  		CONFIG_CMD_FAT		* FAT command support
602ad3b33   Jon Loeliger   README: Rewrite c...
877
878
  		CONFIG_CMD_FLASH	  flinfo, erase, protect
  		CONFIG_CMD_FPGA		  FPGA device initialization support
4d98b5c8a   Vincent Stehlé   README: align def...
879
  		CONFIG_CMD_FUSE		* Device fuse support
53fdc7ef2   Anton Staaf   Add gettime command
880
  		CONFIG_CMD_GETTIME	* Get time since boot
a641b9794   Mike Frysinger   make `go` optional
881
  		CONFIG_CMD_GO		* the 'go' command (exec code)
a000b7950   Kim Phillips   common: add a gre...
882
  		CONFIG_CMD_GREPENV	* search environment
bf36c5d52   Simon Glass   Add hash command ...
883
  		CONFIG_CMD_HASH		* calculate hash / digest
602ad3b33   Jon Loeliger   README: Rewrite c...
884
885
886
887
  		CONFIG_CMD_HWFLOW	* RTS/CTS hw flow control
  		CONFIG_CMD_I2C		* I2C serial bus support
  		CONFIG_CMD_IDE		* IDE harddisk support
  		CONFIG_CMD_IMI		  iminfo
8fdf1e0f6   Vipin Kumar   imls: Add support...
888
  		CONFIG_CMD_IMLS		  List all images found in NOR flash
4d98b5c8a   Vincent Stehlé   README: align def...
889
  		CONFIG_CMD_IMLS_NAND	* List all images found in NAND flash
602ad3b33   Jon Loeliger   README: Rewrite c...
890
  		CONFIG_CMD_IMMAP	* IMMR dump support
0c79cda01   Mike Frysinger   env: make import/...
891
  		CONFIG_CMD_IMPORTENV	* import an environment
c167cc020   Joe Hershberger   Add a new "ini" c...
892
  		CONFIG_CMD_INI		* import data from an ini file into the env
602ad3b33   Jon Loeliger   README: Rewrite c...
893
894
895
896
  		CONFIG_CMD_IRQ		* irqinfo
  		CONFIG_CMD_ITEST	  Integer/string test of 2 values
  		CONFIG_CMD_JFFS2	* JFFS2 Support
  		CONFIG_CMD_KGDB		* kgdb
4d98b5c8a   Vincent Stehlé   README: align def...
897
  		CONFIG_CMD_LDRINFO	* ldrinfo (display Blackfin loader)
d22c338e0   Joe Hershberger   net: Add link-loc...
898
899
  		CONFIG_CMD_LINK_LOCAL	* link-local IP address auto-configuration
  					  (169.254.*.*)
602ad3b33   Jon Loeliger   README: Rewrite c...
900
901
  		CONFIG_CMD_LOADB	  loadb
  		CONFIG_CMD_LOADS	  loads
4d98b5c8a   Vincent Stehlé   README: align def...
902
  		CONFIG_CMD_MD5SUM	* print md5 message digest
02c9aa1d4   Robin Getz   Add md5sum and sh...
903
  					  (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
15a33e49d   Simon Glass   Add option to dis...
904
  		CONFIG_CMD_MEMINFO	* Display detailed memory information
602ad3b33   Jon Loeliger   README: Rewrite c...
905
  		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
a2681707b   Wolfgang Denk   Feature Removal: ...
906
  					  loop, loopw
4d98b5c8a   Vincent Stehlé   README: align def...
907
  		CONFIG_CMD_MEMTEST	* mtest
602ad3b33   Jon Loeliger   README: Rewrite c...
908
909
910
  		CONFIG_CMD_MISC		  Misc functions like sleep etc
  		CONFIG_CMD_MMC		* MMC memory mapped support
  		CONFIG_CMD_MII		* MII utility commands
68d7d6510   Stefan Roese   Separate mtdparts...
911
  		CONFIG_CMD_MTDPARTS	* MTD partition support
602ad3b33   Jon Loeliger   README: Rewrite c...
912
913
  		CONFIG_CMD_NAND		* NAND support
  		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
4d98b5c8a   Vincent Stehlé   README: align def...
914
  		CONFIG_CMD_NFS		  NFS support
e92739d34   Peter Tyser   Add support for P...
915
  		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
c0f40859f   Wolfgang Denk   README: white-spa...
916
  		CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
602ad3b33   Jon Loeliger   README: Rewrite c...
917
918
919
920
921
  		CONFIG_CMD_PCI		* pciinfo
  		CONFIG_CMD_PCMCIA		* PCMCIA support
  		CONFIG_CMD_PING		* send ICMP ECHO_REQUEST to network
  					  host
  		CONFIG_CMD_PORTIO	* Port I/O
ff048ea91   Kenneth Waters   Add a command to ...
922
  		CONFIG_CMD_READ		* Read raw data from partition
602ad3b33   Jon Loeliger   README: Rewrite c...
923
924
  		CONFIG_CMD_REGINFO	* Register dump
  		CONFIG_CMD_RUN		  run command in env variable
d304931f2   Simon Glass   sandbox: Add 'sb'...
925
  		CONFIG_CMD_SANDBOX	* sb command to access sandbox features
602ad3b33   Jon Loeliger   README: Rewrite c...
926
927
928
929
930
931
  		CONFIG_CMD_SAVES	* save S record dump
  		CONFIG_CMD_SCSI		* SCSI Support
  		CONFIG_CMD_SDRAM	* print SDRAM configuration information
  					  (requires CONFIG_CMD_I2C)
  		CONFIG_CMD_SETGETDCR	  Support for DCR Register access
  					  (4xx only)
f61ec45eb   Eric Nelson   README: Add descr...
932
  		CONFIG_CMD_SF		* Read/write/erase SPI NOR flash
4d98b5c8a   Vincent Stehlé   README: align def...
933
  		CONFIG_CMD_SHA1SUM	* print sha1 memory digest
02c9aa1d4   Robin Getz   Add md5sum and sh...
934
  					  (requires CONFIG_CMD_MEMORY)
7d861d95a   Bob Liu   blackfin: bf609: ...
935
  		CONFIG_CMD_SOFTSWITCH	* Soft switch setting command for BF60x
74de7aefd   Wolfgang Denk   Add "source" comm...
936
  		CONFIG_CMD_SOURCE	  "source" command Support
602ad3b33   Jon Loeliger   README: Rewrite c...
937
  		CONFIG_CMD_SPI		* SPI serial bus support
7a83af07a   Luca Ceresoli   TFTP: add tftpsrv...
938
  		CONFIG_CMD_TFTPSRV	* TFTP transfer in server mode
1fb7cd498   Simon Glass   net: tftpput: imp...
939
  		CONFIG_CMD_TFTPPUT	* TFTP put command (upload)
da83bcd7b   Joe Hershberger   Add a command to ...
940
941
  		CONFIG_CMD_TIME		* run command and report execution time (ARM specific)
  		CONFIG_CMD_TIMER	* access to the system tick timer
602ad3b33   Jon Loeliger   README: Rewrite c...
942
  		CONFIG_CMD_USB		* USB support
602ad3b33   Jon Loeliger   README: Rewrite c...
943
  		CONFIG_CMD_CDP		* Cisco Discover Protocol support
c8339f515   Marek Vasut   CMD: Fix typo CMD...
944
  		CONFIG_CMD_MFSL		* Microblaze FSL support
4d98b5c8a   Vincent Stehlé   README: align def...
945
  		CONFIG_CMD_XIMG		  Load part of Multi Image
602ad3b33   Jon Loeliger   README: Rewrite c...
946

c609719b8   wdenk   Initial revision
947
948
949
  
  		EXAMPLE: If you want all functions except of network
  		support you can write:
602ad3b33   Jon Loeliger   README: Rewrite c...
950
951
  		#include "config_cmd_all.h"
  		#undef CONFIG_CMD_NET
c609719b8   wdenk   Initial revision
952

213bf8c82   Gerald Van Baren   Add a flattened d...
953
954
  	Other Commands:
  		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
c609719b8   wdenk   Initial revision
955
956
  
  	Note:	Don't enable the "icache" and "dcache" commands
602ad3b33   Jon Loeliger   README: Rewrite c...
957
  		(configuration option CONFIG_CMD_CACHE) unless you know
43d9616cf   wdenk   * Patch by Robert...
958
959
960
961
962
963
  		what you (and your U-Boot users) are doing. Data
  		cache cannot be enabled on systems like the 8xx or
  		8260 (where accesses to the IMMR region must be
  		uncached), and it cannot be disabled on all other
  		systems where we (mis-) use the data cache to hold an
  		initial stack and some data.
c609719b8   wdenk   Initial revision
964
965
966
  
  
  		XXX - this list needs to get updated!
a5ecbe62c   Wolfgang Denk   Add SLRE - Super ...
967
968
  - Regular expression support:
  		CONFIG_REGEX
93e145964   Wolfgang Denk   Coding Style clea...
969
970
971
972
  		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 ...
973

45ba8077f   Simon Glass   fdt: ARM: Add dev...
974
975
976
977
978
979
980
  - 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 ...
981
982
  		U-Boot needs to get its device tree from somewhere. This can
  		be done using one of the two options below:
bbb0b128c   Simon Glass   fdt: Add support ...
983
984
985
986
987
988
989
  
  		CONFIG_OF_EMBED
  		If this variable is defined, U-Boot will embed a device tree
  		binary in its image. This device tree file should be in the
  		board directory and called <soc>-<board>.dts. The binary file
  		is then picked up in board_init_f() and made available through
  		the global data structure as gd->blob.
45ba8077f   Simon Glass   fdt: ARM: Add dev...
990

2c0f79e44   Simon Glass   fdt: Add support ...
991
992
993
994
995
996
997
998
999
1000
1001
  		CONFIG_OF_SEPARATE
  		If this variable is defined, U-Boot will build a device tree
  		binary. It will be called u-boot.dtb. Architecture-specific
  		code will locate it at run-time. Generally this works by:
  
  			cat u-boot.bin u-boot.dtb >image.bin
  
  		and in fact, U-Boot does this for you, creating a file called
  		u-boot-dtb.bin which is useful in the common case. You can
  		still use the individual files if you need something more
  		exotic.
c609719b8   wdenk   Initial revision
1002
1003
1004
  - Watchdog:
  		CONFIG_WATCHDOG
  		If this variable is defined, it enables watchdog
6abe6fb68   Detlev Zundel   README: Clarify d...
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
  		support for the SoC. There must be support in the SoC
  		specific code for a watchdog. For the 8xx and 8260
  		CPUs, the SIU Watchdog feature is enabled in the SYPCR
  		register.  When supported for a specific SoC is
  		available, then no further board specific code should
  		be needed to use it.
  
  		CONFIG_HW_WATCHDOG
  		When using a watchdog circuitry external to the used
  		SoC, then define this variable and provide board
  		specific code for the "hw_watchdog_reset" function.
c609719b8   wdenk   Initial revision
1016

c1551ea81   stroese   U-Boot version en...
1017
1018
1019
1020
1021
  - U-Boot Version:
  		CONFIG_VERSION_VARIABLE
  		If this variable is defined, an environment variable
  		named "ver" is created by U-Boot showing the U-Boot
  		version as printed by the "version" command.
a1ea8e510   Benoît Thébaudeau   README: Update ve...
1022
1023
  		Any change to this variable will be reverted at the
  		next reset.
c1551ea81   stroese   U-Boot version en...
1024

c609719b8   wdenk   Initial revision
1025
  - Real-Time Clock:
602ad3b33   Jon Loeliger   README: Rewrite c...
1026
  		When CONFIG_CMD_DATE is selected, the type of the RTC
c609719b8   wdenk   Initial revision
1027
1028
1029
1030
1031
  		has to be selected, too. Define exactly one of the
  		following options:
  
  		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
  		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
4e8b7544b   Fabio Estevam   rtc: Make mc13783...
1032
  		CONFIG_RTC_MC13XXX	- use MC13783 or MC13892 RTC
c609719b8   wdenk   Initial revision
1033
  		CONFIG_RTC_MC146818	- use MC146818 RTC
1cb8e980c   wdenk   * Patches by Davi...
1034
  		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
c609719b8   wdenk   Initial revision
1035
  		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
7f70e8530   wdenk   * Patch by David ...
1036
  		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
3bac35137   wdenk   * Patch by Josef ...
1037
  		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
9536dfcce   Tor Krill   Add support for I...
1038
  		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
4c0d4c3b7   wdenk   * Patch by Tom Ar...
1039
  		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
1040
  		CONFIG_SYS_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
71d19f30d   Heiko Schocher   rtc, rv3029: add ...
1041
1042
  		CONFIG_SYS_RV3029_TCR	- enable trickle charger on
  					  RV3029 RTC.
c609719b8   wdenk   Initial revision
1043

b37c7e5e5   wdenk   * Patch by Seb Ja...
1044
1045
  		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...
1046
1047
  - GPIO Support:
  		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
e92739d34   Peter Tyser   Add support for P...
1048

5dec49ca2   Chris Packham   pca953x: support ...
1049
1050
1051
  		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...
1052
1053
  		Note that if the GPIO device uses I2C, then the I2C interface
  		must also be configured. See I2C Support, below.
c609719b8   wdenk   Initial revision
1054
  - Timestamp Support:
43d9616cf   wdenk   * Patch by Robert...
1055
1056
1057
  		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...
1058
  		automatically enabled when you select CONFIG_CMD_DATE .
c609719b8   wdenk   Initial revision
1059

923c46f97   Karl O. Pinc   README: Cleanup d...
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
  - Partition Labels (disklabels) Supported:
  		Zero or more of the following:
  		CONFIG_MAC_PARTITION   Apple's MacOS partition table.
  		CONFIG_DOS_PARTITION   MS Dos partition table, traditional on the
  				       Intel architecture, USB sticks, etc.
  		CONFIG_ISO_PARTITION   ISO partition table, used on CDROM etc.
  		CONFIG_EFI_PARTITION   GPT partition table, common when EFI is the
  				       bootloader.  Note 2TB partition limit; see
  				       disk/part_efi.c
  		CONFIG_MTD_PARTITIONS  Memory Technology Device partition table.
c609719b8   wdenk   Initial revision
1070

218ca724c   Wolfgang Denk   README: update do...
1071
1072
  		If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
  		CONFIG_CMD_SCSI) you must configure support for at
923c46f97   Karl O. Pinc   README: Cleanup d...
1073
  		least one non-MTD partition type as well.
c609719b8   wdenk   Initial revision
1074
1075
  
  - IDE Reset method:
4d13cbad1   wdenk   * Patch by Toluna...
1076
1077
  		CONFIG_IDE_RESET_ROUTINE - this is defined in several
  		board configurations files but used nowhere!
c609719b8   wdenk   Initial revision
1078

4d13cbad1   wdenk   * Patch by Toluna...
1079
1080
1081
1082
  		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
1083
1084
1085
1086
1087
  
  - ATAPI Support:
  		CONFIG_ATAPI
  
  		Set this to enable ATAPI support.
c40b29568   wdenk   * Patch by Rune T...
1088
1089
1090
1091
  - LBA48 Support
  		CONFIG_LBA48
  
  		Set this to enable support for disks larger than 137GB
4b142febf   Heiko Schocher   common: delete CO...
1092
  		Also look at CONFIG_SYS_64BIT_LBA.
c40b29568   wdenk   * Patch by Rune T...
1093
1094
  		Whithout these , LBA48 support uses 32bit variables and will 'only'
  		support disks up to 2.1TB.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
1095
  		CONFIG_SYS_64BIT_LBA:
c40b29568   wdenk   * Patch by Rune T...
1096
1097
  			When enabled, makes the IDE subsystem use 64bit sector addresses.
  			Default is 32bit.
c609719b8   wdenk   Initial revision
1098
1099
1100
1101
  - SCSI Support:
  		At the moment only there is only support for the
  		SYM53C8XX SCSI controller; define
  		CONFIG_SCSI_SYM53C8XX to enable it.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
1102
1103
1104
  		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
1105
1106
  		maximum numbers of LUNs, SCSI ID's and target
  		devices.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
1107
  		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
c609719b8   wdenk   Initial revision
1108

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

c609719b8   wdenk   Initial revision
1112
  - NETWORK Support (PCI):
682011ff6   wdenk   * Patches by Udi ...
1113
  		CONFIG_E1000
ce5207e19   Kyle Moffett   e1000: Allow dire...
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
  		Support for Intel 8254x/8257x gigabit chips.
  
  		CONFIG_E1000_SPI
  		Utility code for direct access to the SPI bus on Intel 8257x.
  		This does not do anything useful unless you set at least one
  		of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
  
  		CONFIG_E1000_SPI_GENERIC
  		Allow generic access to the SPI bus on the Intel 8257x, for
  		example with the "sspi" command.
  
  		CONFIG_CMD_E1000
  		Management command for E1000 devices.  When used on devices
  		with SPI support you can reprogram the EEPROM from U-Boot.
53cf9435c   stroese   - CFG_RX_ETH_BUFF...
1128

ac3315c26   Andre Schwarz   new PHY @ e1000 -...
1129
  		CONFIG_E1000_FALLBACK_MAC
11ccc33fa   Marcel Ziswiler   Many spelling fix...
1130
  		default MAC for empty EEPROM after production.
ac3315c26   Andre Schwarz   new PHY @ e1000 -...
1131

c609719b8   wdenk   Initial revision
1132
1133
  		CONFIG_EEPRO100
  		Support for Intel 82557/82559/82559ER chips.
11ccc33fa   Marcel Ziswiler   Many spelling fix...
1134
  		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
c609719b8   wdenk   Initial revision
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
  		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 ...
1147
  - NETWORK Support (other):
c041e9d21   Jens Scharsig   new at91_emac net...
1148
1149
1150
1151
1152
1153
1154
1155
1156
  		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 ...
1157
1158
  		CONFIG_CALXEDA_XGMAC
  		Support for the Calxeda XGMAC device
3bb46d23f   Ashok   README : Rename C...
1159
  		CONFIG_LAN91C96
45219c466   wdenk   Patch by Mathijs ...
1160
1161
1162
1163
1164
1165
1166
1167
  		Support for SMSC's LAN91C96 chips.
  
  			CONFIG_LAN91C96_BASE
  			Define this to hold the physical address
  			of the LAN91C96's I/O space
  
  			CONFIG_LAN91C96_USE_32_BIT
  			Define this to enable 32 bit addressing
3bb46d23f   Ashok   README : Rename C...
1168
  		CONFIG_SMC91111
f39748ae8   wdenk   * Patch by Paul R...
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
  		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...
1181
1182
1183
1184
1185
  		CONFIG_DRIVER_TI_EMAC
  		Support for davinci emac
  
  			CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
  			Define this if you have more then 3 PHYs.
b3dbf4a51   Macpaul Lin   ftgmac100: suppor...
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
  		CONFIG_FTGMAC100
  		Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
  
  			CONFIG_FTGMAC100_EGIGA
  			Define this to use GE link update with gigabit PHY.
  			Define this if FTGMAC100 is connected to gigabit PHY.
  			If your system has 10/100 PHY only, it might not occur
  			wrong behavior. Because PHY usually return timeout or
  			useless data when polling gigabit status and gigabit
  			control registers. This behavior won't affect the
  			correctnessof 10/100 link speed update.
c2fff331a   Mike Rapoport   smc911x: update S...
1197
  		CONFIG_SMC911X
557b377d8   Jens Gehrlein   smc911x: add 16 b...
1198
  		Support for SMSC's LAN911x and LAN921x chips
c2fff331a   Mike Rapoport   smc911x: update S...
1199
  			CONFIG_SMC911X_BASE
557b377d8   Jens Gehrlein   smc911x: add 16 b...
1200
1201
  			Define this to hold the physical address
  			of the device (I/O space)
c2fff331a   Mike Rapoport   smc911x: update S...
1202
  			CONFIG_SMC911X_32_BIT
557b377d8   Jens Gehrlein   smc911x: add 16 b...
1203
  			Define this if data bus is 32 bits
c2fff331a   Mike Rapoport   smc911x: update S...
1204
  			CONFIG_SMC911X_16_BIT
557b377d8   Jens Gehrlein   smc911x: add 16 b...
1205
1206
  			Define this if data bus is 16 bits. If your processor
  			automatically converts one 32 bit word to two 16 bit
c2fff331a   Mike Rapoport   smc911x: update S...
1207
  			words you may also try CONFIG_SMC911X_32_BIT.
557b377d8   Jens Gehrlein   smc911x: add 16 b...
1208

3d0075fa7   Yoshihiro Shimoda   README: add descr...
1209
1210
1211
1212
1213
1214
1215
1216
  		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 ...
1217
1218
  			CONFIG_SH_ETHER_CACHE_WRITEBACK
  			If this option is set, the driver enables cache flush.
5e1247247   Vadim Bendebury   Introduce generic...
1219
  - TPM Support:
90899cc01   Che-liang Chiou   tpm: Rename gener...
1220
1221
  		CONFIG_TPM
  		Support TPM devices.
1b393db58   Tom Wai-Hong Tam   tpm: Reorganize t...
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
  		CONFIG_TPM_TIS_I2C
  		Support for i2c bus TPM devices. Only one device
  		per system is supported at this time.
  
  			CONFIG_TPM_TIS_I2C_BUS_NUMBER
  			Define the the i2c bus number for the TPM device
  
  			CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
  			Define the TPM's address on the i2c bus
  
  			CONFIG_TPM_TIS_I2C_BURST_LIMITATION
  			Define the burst count bytes upper limit
c01939c76   Dirk Eibach   Add Atmel I2C tpm
1234
1235
  		CONFIG_TPM_ATMEL_TWI
  		Support for Atmel TWI TPM device. Requires I2C support.
90899cc01   Che-liang Chiou   tpm: Rename gener...
1236
  		CONFIG_TPM_TIS_LPC
5e1247247   Vadim Bendebury   Introduce generic...
1237
1238
1239
1240
1241
1242
1243
  		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...
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
  		CONFIG_CMD_TPM
  		Add tpm monitor functions.
  		Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
  		provides monitor access to authorized functions.
  
  		CONFIG_TPM
  		Define this to enable the TPM support library which provides
  		functional interfaces to some TPM commands.
  		Requires support for a TPM device.
  
  		CONFIG_TPM_AUTH_SESSIONS
  		Define this to enable authorized functions in the TPM library.
  		Requires CONFIG_TPM and CONFIG_SHA1.
c609719b8   wdenk   Initial revision
1257
1258
  - USB Support:
  		At the moment only the UHCI host controller is
4d13cbad1   wdenk   * Patch by Toluna...
1259
  		supported (PIP405, MIP405, MPC5200); define
c609719b8   wdenk   Initial revision
1260
1261
  		CONFIG_USB_UHCI to enable it.
  		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
30d56fae2   wdenk   Patch by Sam Song...
1262
  		and define CONFIG_USB_STORAGE to enable the USB
c609719b8   wdenk   Initial revision
1263
1264
1265
1266
  		storage devices.
  		Note:
  		Supported are USB Keyboards and USB Floppy drives
  		(TEAC FD-05PUB).
4d13cbad1   wdenk   * Patch by Toluna...
1267
1268
1269
  		MPC5200 USB requires additional defines:
  			CONFIG_USB_CLOCK
  				for 528 MHz Clock: 0x0001bbbb
307ecb6db   Eric Millbrandt   Add support for U...
1270
1271
  			CONFIG_PSC3_USB
  				for USB on PSC3
4d13cbad1   wdenk   * Patch by Toluna...
1272
1273
1274
  			CONFIG_USB_CONFIG
  				for differential drivers: 0x00001000
  				for single ended drivers: 0x00005000
307ecb6db   Eric Millbrandt   Add support for U...
1275
1276
  				for differential drivers on PSC3: 0x00000100
  				for single ended drivers on PSC3: 0x00004100
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
1277
  			CONFIG_SYS_USB_EVENT_POLL
fdcfaa1b0   Zhang Wei   USB event poll su...
1278
1279
  				May be defined to allow interrupt polling
  				instead of using asynchronous interrupts
4d13cbad1   wdenk   * Patch by Toluna...
1280

9ab4ce223   Simon Glass   usb: Add support ...
1281
1282
  		CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
  		txfilltuning field in the EHCI controller on reset.
aa1550588   Kuo-Jung Su   usb: hub: make mi...
1283
1284
  		CONFIG_USB_HUB_MIN_POWER_ON_DELAY defines the minimum
  		interval for usb hub power-on delay.(minimum 100msec)
16c8d5e76   Wolfgang Denk   Various USB relat...
1285
1286
1287
1288
  - 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...
1289
  		attach your USB cable. The Unix command "dmesg" should print
16c8d5e76   Wolfgang Denk   Various USB relat...
1290
1291
  		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
1292
  		appear to a USB host as a Linux gserial device or a
16c8d5e76   Wolfgang Denk   Various USB relat...
1293
1294
1295
1296
1297
1298
1299
  		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
1300

16c8d5e76   Wolfgang Denk   Various USB relat...
1301
1302
1303
1304
1305
1306
  			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
1307

f9da0f894   Vipin KUMAR   Enable high speed...
1308
1309
1310
1311
1312
1313
1314
  			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...
1315
  			CONFIG_SYS_CONSOLE_IS_IN_ENV
16c8d5e76   Wolfgang Denk   Various USB relat...
1316
1317
1318
1319
  			Define this if you want stdin, stdout &/or stderr to
  			be set to usbtty.
  
  			mpc8xx:
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
1320
  				CONFIG_SYS_USB_EXTC_CLK 0xBLAH
16c8d5e76   Wolfgang Denk   Various USB relat...
1321
  				Derive USB clock from external clock "blah"
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
1322
  				- CONFIG_SYS_USB_EXTC_CLK 0x02
386eda022   Wolfgang Denk   Code cleanup
1323

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
1324
  				CONFIG_SYS_USB_BRG_CLK 0xBLAH
16c8d5e76   Wolfgang Denk   Various USB relat...
1325
  				Derive USB clock from brgclk
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
1326
  				- CONFIG_SYS_USB_BRG_CLK 0x04
16c8d5e76   Wolfgang Denk   Various USB relat...
1327

386eda022   Wolfgang Denk   Code cleanup
1328
  		If you have a USB-IF assigned VendorID then you may wish to
16c8d5e76   Wolfgang Denk   Various USB relat...
1329
  		define your own vendor specific values either in BoardName.h
386eda022   Wolfgang Denk   Code cleanup
1330
  		or directly in usbd_vendor_info.h. If you don't define
16c8d5e76   Wolfgang Denk   Various USB relat...
1331
1332
1333
1334
1335
1336
1337
  		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
1338

16c8d5e76   Wolfgang Denk   Various USB relat...
1339
1340
1341
1342
1343
1344
1345
1346
1347
  			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
1348

16c8d5e76   Wolfgang Denk   Various USB relat...
1349
1350
1351
1352
  			CONFIG_USBD_PRODUCTID
  			Define this as the unique Product ID
  			for your device
  			- CONFIG_USBD_PRODUCTID 0xFFFF
4d13cbad1   wdenk   * Patch by Toluna...
1353

351e9b206   Przemyslaw Marczak   usb: ums: add ums...
1354
1355
1356
1357
1358
1359
  		Some USB device drivers may need to check USB cable attachment.
  		In this case you can enable following config in BoardName.h:
  			CONFIG_USB_CABLE_CHECK
  			This enables function definition:
  			- usb_cable_connected() in include/usb.h
  			Implementation of this function is board-specific.
d70a560fd   Igor Grinberg   README: add docum...
1360
1361
1362
1363
1364
1365
1366
1367
  - 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 ...
1368
1369
1370
  		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
1371

71f951180   wdenk   * Fix CONFIG_NET_...
1372
  - MMC Support:
8bde7f776   wdenk   * Code cleanup:
1373
1374
1375
  		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_...
1376
  		to physical memory similar to flash. Command line is
602ad3b33   Jon Loeliger   README: Rewrite c...
1377
1378
  		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_...
1379

afb35666d   Yoshihiro Shimoda   mmc: sh_mmcif: ad...
1380
1381
1382
1383
1384
1385
1386
1387
  		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 ...
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
  - USB Device Firmware Update (DFU) class support:
  		CONFIG_DFU_FUNCTION
  		This enables the USB portion of the DFU USB class
  
  		CONFIG_CMD_DFU
  		This enables the command "dfu" which is used to have
  		U-Boot create a DFU class device via USB.  This command
  		requires that the "dfu_alt_info" environment variable be
  		set and define the alt settings to expose to the host.
  
  		CONFIG_DFU_MMC
  		This enables support for exposing (e)MMC devices via DFU.
c6631764c   Pantelis Antoniou   dfu: NAND specifi...
1400
1401
  		CONFIG_DFU_NAND
  		This enables support for exposing NAND devices via DFU.
a9479f043   Afzal Mohammed   dfu: ram support
1402
1403
1404
1405
1406
  		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...
1407
1408
1409
1410
1411
  		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...
1412
1413
1414
1415
1416
1417
  		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.
6705d81e9   wdenk   * Patch by Andrea...
1418
1419
1420
1421
  - Journaling Flash filesystem support:
  		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
  		CONFIG_JFFS2_NAND_DEV
  		Define these for a default partition on a NAND device
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
1422
1423
  		CONFIG_SYS_JFFS2_FIRST_SECTOR,
  		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
6705d81e9   wdenk   * Patch by Andrea...
1424
  		Define these for a default partition on a NOR device
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
1425
  		CONFIG_SYS_JFFS_CUSTOM_PART
6705d81e9   wdenk   * Patch by Andrea...
1426
1427
1428
1429
  		Define this to create an own partition. You have to provide a
  		function struct part_info* jffs2_part_info(int part_num)
  
  		If you define only one JFFS2 partition you may also want to
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
1430
  		#define CONFIG_SYS_JFFS_SINGLE_PART	1
6705d81e9   wdenk   * Patch by Andrea...
1431
1432
  		to disable the command chpart. This is the default when you
  		have not defined a custom partition
c30a15e59   Donggeun Kim   FAT: Add FAT writ...
1433
1434
  - FAT(File Allocation Table) filesystem write function support:
  		CONFIG_FAT_WRITE
656f4c653   Donggeun Kim   cmd_fat: add FAT ...
1435
1436
1437
1438
1439
1440
  
  		Define this to enable support for saving memory data as a
  		file in FAT formatted partition.
  
  		This will also enable the command "fatwrite" enabling the
  		user to write files to FAT.
c30a15e59   Donggeun Kim   FAT: Add FAT writ...
1441

84cd93272   Gabe Black   fs: Add a Coreboo...
1442
1443
1444
1445
1446
1447
  CBFS (Coreboot Filesystem) support
  		CONFIG_CMD_CBFS
  
  		Define this to enable support for reading from a Coreboot
  		filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
  		and cbfsload.
c609719b8   wdenk   Initial revision
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
  - Keyboard Support:
  		CONFIG_ISA_KEYBOARD
  
  		Define this to enable standard (PC-Style) keyboard
  		support
  
  		CONFIG_I8042_KBD
  		Standard PC keyboard driver with US (is default) and
  		GERMAN key layout (switch via environment 'keymap=de') support.
  		Export function i8042_kbd_init, i8042_tstc and i8042_getc
  		for cfb_console. Supports cursor blinking.
713cb6804   Hung-ying Tyan   cros: adds cros_e...
1459
1460
1461
1462
  		CONFIG_CROS_EC_KEYB
  		Enables a Chrome OS keyboard using the CROS_EC interface.
  		This uses CROS_EC to communicate with a second microcontroller
  		which provides key scans on request.
c609719b8   wdenk   Initial revision
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
  - Video support:
  		CONFIG_VIDEO
  
  		Define this to enable video support (for output to
  		video).
  
  		CONFIG_VIDEO_CT69000
  
  		Enable Chips & Technologies 69000 Video chip
  
  		CONFIG_VIDEO_SMI_LYNXEM
b79a11cc2   wdenk   Code cleanup
1474
  		Enable Silicon Motion SMI 712/710/810 Video chip. The
eeb1b77b7   wdenk   * Patch by Pierre...
1475
1476
1477
  		video output is selected via environment 'videoout'
  		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
  		assumed.
b79a11cc2   wdenk   Code cleanup
1478
  		For the CT69000 and SMI_LYNXEM drivers, videomode is
11ccc33fa   Marcel Ziswiler   Many spelling fix...
1479
  		selected via environment 'videomode'. Two different ways
eeb1b77b7   wdenk   * Patch by Pierre...
1480
1481
  		are possible:
  		- "videomode=num"   'num' is a standard LiLo mode numbers.
6e5923851   wdenk   * Cleanup, minor ...
1482
  		Following standard modes are supported	(* is default):
eeb1b77b7   wdenk   * Patch by Pierre...
1483
1484
1485
1486
1487
1488
1489
1490
  
  		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
  		-------------+---------------------------------------------
  		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
  		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
  		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
  		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
  		-------------+---------------------------------------------
c609719b8   wdenk   Initial revision
1491
  		(i.e. setenv videomode 317; saveenv; reset;)
b79a11cc2   wdenk   Code cleanup
1492
  		- "videomode=bootargs" all the video parameters are parsed
7817cb208   Marcel Ziswiler   fix comments with...
1493
  		from the bootargs. (See drivers/video/videomodes.c)
eeb1b77b7   wdenk   * Patch by Pierre...
1494

c1551ea81   stroese   U-Boot version en...
1495
  		CONFIG_VIDEO_SED13806
43d9616cf   wdenk   * Patch by Robert...
1496
  		Enable Epson SED13806 driver. This driver supports 8bpp
a6c7ad2f6   wdenk   * Fix startup pro...
1497
1498
  		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
  		or CONFIG_VIDEO_SED13806_16BPP
7d3053fbf   Timur Tabi   powerpc: clean up...
1499
  		CONFIG_FSL_DIU_FB
04e5ae793   Wolfgang Denk   Minor coding styl...
1500
  		Enable the Freescale DIU video driver.	Reference boards for
7d3053fbf   Timur Tabi   powerpc: clean up...
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
  		SOCs that have a DIU should define this macro to enable DIU
  		support, and should also define these other macros:
  
  			CONFIG_SYS_DIU_ADDR
  			CONFIG_VIDEO
  			CONFIG_CMD_BMP
  			CONFIG_CFB_CONSOLE
  			CONFIG_VIDEO_SW_CURSOR
  			CONFIG_VGA_AS_SINGLE_DEVICE
  			CONFIG_VIDEO_LOGO
  			CONFIG_VIDEO_BMP_LOGO
ba8e76bd4   Timur Tabi   powerpc: use 'vid...
1512
1513
1514
1515
  		The DIU driver will look for the 'video-mode' environment
  		variable, and if defined, enable the DIU as a console during
  		boot.  See the documentation file README.video for a
  		description of this variable.
7d3053fbf   Timur Tabi   powerpc: clean up...
1516

058d59b08   Simon Glass   x86: Build vga vi...
1517
1518
1519
1520
1521
  		CONFIG_VIDEO_VGA
  
  		Enable the VGA video / BIOS for x86. The alternative if you
  		are using coreboot is to use the coreboot frame buffer
  		driver.
682011ff6   wdenk   * Patches by Udi ...
1522
  - Keyboard Support:
8bde7f776   wdenk   * Code cleanup:
1523
  		CONFIG_KEYBOARD
682011ff6   wdenk   * Patches by Udi ...
1524

8bde7f776   wdenk   * Code cleanup:
1525
1526
1527
1528
  		Define this to enable a custom keyboard support.
  		This simply calls drv_keyboard_init() which must be
  		defined in your board-specific files.
  		The only board using this so far is RBC823.
a6c7ad2f6   wdenk   * Fix startup pro...
1529

c609719b8   wdenk   Initial revision
1530
1531
1532
1533
1534
  - 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
1535
1536
1537
  		CONFIG_ATMEL_LCD:
  
  			HITACHI TX09D70VM1CCA, 3.5", 240x320.
fd3103bb8   wdenk   Add support for B...
1538
  		CONFIG_NEC_NL6448AC33:
c609719b8   wdenk   Initial revision
1539

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

fd3103bb8   wdenk   Add support for B...
1542
  		CONFIG_NEC_NL6448BC20
c609719b8   wdenk   Initial revision
1543

fd3103bb8   wdenk   Add support for B...
1544
1545
1546
1547
1548
1549
  			NEC NL6448BC20-08. 6.5", 640x480.
  			Active, color, single scan.
  
  		CONFIG_NEC_NL6448BC33_54
  
  			NEC NL6448BC33-54. 10.4", 640x480.
c609719b8   wdenk   Initial revision
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
  			Active, color, single scan.
  
  		CONFIG_SHARP_16x9
  
  			Sharp 320x240. Active, color, single scan.
  			It isn't 16x9, and I am not sure what it is.
  
  		CONFIG_SHARP_LQ64D341
  
  			Sharp LQ64D341 display, 640x480.
  			Active, color, single scan.
  
  		CONFIG_HLD1045
  
  			HLD1045 display, 640x480.
  			Active, color, single scan.
  
  		CONFIG_OPTREX_BW
  
  			Optrex	 CBL50840-2 NF-FW 99 22 M5
  			or
  			Hitachi	 LMG6912RPFC-00T
  			or
  			Hitachi	 SP14Q002
  
  			320x240. Black & white.
  
  		Normally display is black on white background; define
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
1578
  		CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
c609719b8   wdenk   Initial revision
1579

676d319ef   Simon Glass   lcd: Add CONFIG_L...
1580
1581
1582
1583
1584
1585
1586
  		CONFIG_LCD_ALIGNMENT
  
  		Normally the LCD is page-aligned (tyically 4KB). If this is
  		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.
0d89efef7   Simon Glass   lcd: Add CONFIG_C...
1587
1588
1589
1590
1591
1592
  		CONFIG_CONSOLE_SCROLL_LINES
  
  		When the console need to be scrolled, this is the number of
  		lines to scroll by. It defaults to 1. Increasing this makes
  		the console jump but can help speed up operation when scrolling
  		is slow.
676d319ef   Simon Glass   lcd: Add CONFIG_L...
1593

45d7f5251   Tom Wai-Hong Tam   lcd: Implement RL...
1594
1595
1596
  		CONFIG_LCD_BMP_RLE8
  
  		Support drawing of RLE8-compressed bitmaps on the LCD.
735987c5a   Tom Wai-Hong Tam   edid: Add I2C com...
1597
1598
1599
1600
  		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...
1601
  - Splash Screen Support: CONFIG_SPLASH_SCREEN
d791b1dc3   wdenk   * Make sure Block...
1602

8bde7f776   wdenk   * Code cleanup:
1603
1604
1605
  		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...
1606
  		is suppressed and the BMP image at the address
8bde7f776   wdenk   * Code cleanup:
1607
1608
1609
1610
  		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...
1611

c08804853   Nikita Kiryanov   lcd: implement a ...
1612
1613
1614
1615
  		CONFIG_SPLASHIMAGE_GUARD
  
  		If this option is set, then U-Boot will prevent the environment
  		variable "splashimage" from being set to a problematic address
1551df35f   Tom Rini   arm: Switch to -m...
1616
  		(see README.displaying-bmps).
c08804853   Nikita Kiryanov   lcd: implement a ...
1617
1618
1619
1620
1621
  		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...
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
  		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...
1641
1642
1643
1644
1645
  - 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...
1646
1647
1648
1649
1650
  - 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.
f2b96dfbb   Lei Wen   common: add zip c...
1651
1652
1653
1654
1655
  - Do compresssing for memory range:
  		CONFIG_CMD_ZIP
  
  		If this option is set, it would use zlib deflate method
  		to compress the specified memory at its best effort.
c29fdfc1d   wdenk   Patch by Yuli Bar...
1656
  - Compression support:
8ef704784   Kees Cook   documentation: ad...
1657
1658
1659
  		CONFIG_GZIP
  
  		Enabled by default to support gzip compressed images.
c29fdfc1d   wdenk   Patch by Yuli Bar...
1660
1661
1662
1663
1664
  		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...
1665
  		NOTE: the bzip2 algorithm requires a lot of RAM, so
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
1666
  		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
42d1f0394   wdenk   * Patches by Xian...
1667
  		be at least 4MB.
d791b1dc3   wdenk   * Make sure Block...
1668

fc9c1727b   Luigi 'Comio' Mantellini   Add support for L...
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
  		CONFIG_LZMA
  
  		If this option is set, support for lzma compressed
  		images is included.
  
  		Note: The LZMA algorithm adds between 2 and 4KB of code and it
  		requires an amount of dynamic memory that is given by the
  		formula:
  
  			(1846 + 768 << (lc + lp)) * sizeof(uint16)
  
  		Where lc and lp stand for, respectively, Literal context bits
  		and Literal pos bits.
  
  		This value is upper-bounded by 14MB in the worst case. Anyway,
  		for a ~4MB large kernel image, we have lc=3 and lp=0 for a
  		total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
  		a very small buffer.
  
  		Use the lzmainfo tool to determinate the lc and lp values and
  		then calculate the amount of needed dynamic memory (ensuring
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
1690
  		the appropriate CONFIG_SYS_MALLOC_LEN value).
fc9c1727b   Luigi 'Comio' Mantellini   Add support for L...
1691

8ef704784   Kees Cook   documentation: ad...
1692
1693
1694
1695
  		CONFIG_LZO
  
  		If this option is set, support for LZO compressed images
  		is included.
17ea11774   wdenk   Patch by Tolunay ...
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
  - MII/PHY support:
  		CONFIG_PHY_ADDR
  
  		The address of PHY on MII bus.
  
  		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
  
  		The clock frequency of the MII bus
  
  		CONFIG_PHY_GIGE
  
  		If this option is set, support for speed/duplex
11ccc33fa   Marcel Ziswiler   Many spelling fix...
1708
  		detection of gigabit PHY is included.
17ea11774   wdenk   Patch by Tolunay ...
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
  
  		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
1721
1722
  - Ethernet address:
  		CONFIG_ETHADDR
c68a05fee   richardretanubun   Adds two more eth...
1723
  		CONFIG_ETH1ADDR
c609719b8   wdenk   Initial revision
1724
1725
  		CONFIG_ETH2ADDR
  		CONFIG_ETH3ADDR
c68a05fee   richardretanubun   Adds two more eth...
1726
1727
  		CONFIG_ETH4ADDR
  		CONFIG_ETH5ADDR
c609719b8   wdenk   Initial revision
1728

11ccc33fa   Marcel Ziswiler   Many spelling fix...
1729
1730
  		Define a default value for Ethernet address to use
  		for the respective Ethernet interface, in case this
c609719b8   wdenk   Initial revision
1731
1732
1733
1734
1735
1736
  		is not determined automatically.
  
  - IP address:
  		CONFIG_IPADDR
  
  		Define a default value for the IP address to use for
11ccc33fa   Marcel Ziswiler   Many spelling fix...
1737
  		the default Ethernet interface, in case this is not
c609719b8   wdenk   Initial revision
1738
  		determined through e.g. bootp.
1ebcd6547   Wolfgang Denk   README: improve d...
1739
  		(Environment variable "ipaddr")
c609719b8   wdenk   Initial revision
1740
1741
1742
  
  - Server IP address:
  		CONFIG_SERVERIP
11ccc33fa   Marcel Ziswiler   Many spelling fix...
1743
  		Defines a default value for the IP address of a TFTP
c609719b8   wdenk   Initial revision
1744
  		server to contact when using the "tftboot" command.
1ebcd6547   Wolfgang Denk   README: improve d...
1745
  		(Environment variable "serverip")
c609719b8   wdenk   Initial revision
1746

97cfe8616   Robin Getz   Save server's MAC...
1747
1748
1749
1750
  		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...
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
  - Gateway IP address:
  		CONFIG_GATEWAYIP
  
  		Defines a default value for the IP address of the
  		default router where packets to other networks are
  		sent to.
  		(Environment variable "gatewayip")
  
  - Subnet mask:
  		CONFIG_NETMASK
  
  		Defines a default value for the subnet mask (or
  		routing prefix) which is used to determine if an IP
  		address belongs to the local subnet or needs to be
  		forwarded through a router.
  		(Environment variable "netmask")
53a5c424b   David Updegraff   multicast tftp: R...
1767
1768
1769
1770
1771
  - Multicast TFTP Mode:
  		CONFIG_MCAST_TFTP
  
  		Defines whether you want to support multicast TFTP as per
  		rfc-2090; for example to work with atftp.  Lets lots of targets
11ccc33fa   Marcel Ziswiler   Many spelling fix...
1772
  		tftp down the same boot image concurrently.  Note: the Ethernet
53a5c424b   David Updegraff   multicast tftp: R...
1773
1774
  		driver in use must provide a function: mcast() to join/leave a
  		multicast group.
c609719b8   wdenk   Initial revision
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
  - 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...
1786
  		following delays are inserted then:
c609719b8   wdenk   Initial revision
1787
1788
1789
1790
1791
1792
  
  		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
fe389a82c   stroese   - Added CONFIG_BO...
1793
  - DHCP Advanced Options:
1fe80d79c   Jon Loeliger   Finally retire cm...
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
  		You can fine tune the DHCP functionality by defining
  		CONFIG_BOOTP_* symbols:
  
  		CONFIG_BOOTP_SUBNETMASK
  		CONFIG_BOOTP_GATEWAY
  		CONFIG_BOOTP_HOSTNAME
  		CONFIG_BOOTP_NISDOMAIN
  		CONFIG_BOOTP_BOOTPATH
  		CONFIG_BOOTP_BOOTFILESIZE
  		CONFIG_BOOTP_DNS
  		CONFIG_BOOTP_DNS2
  		CONFIG_BOOTP_SEND_HOSTNAME
  		CONFIG_BOOTP_NTPSERVER
  		CONFIG_BOOTP_TIMEOFFSET
  		CONFIG_BOOTP_VENDOREX
2c00e099f   Joe Hershberger   net: Add option C...
1809
  		CONFIG_BOOTP_MAY_FAIL
fe389a82c   stroese   - Added CONFIG_BO...
1810

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

2c00e099f   Joe Hershberger   net: Add option C...
1814
1815
1816
1817
1818
  		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...
1819
1820
1821
1822
1823
1824
1825
  		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
  		serverip from a DHCP server, it is possible that more
  		than one DNS serverip is offered to the client.
  		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
  		serverip will be stored in the additional environment
  		variable "dnsip2". The first DNS serverip is always
  		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
1fe80d79c   Jon Loeliger   Finally retire cm...
1826
  		is defined.
fe389a82c   stroese   - Added CONFIG_BO...
1827
1828
1829
1830
  
  		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_...
1831
  		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
1fe80d79c   Jon Loeliger   Finally retire cm...
1832
1833
  		of the "hostname" environment variable is passed as
  		option 12 to the DHCP server.
fe389a82c   stroese   - Added CONFIG_BO...
1834

d9a2f416d   Aras Vaichas   DHCP request fix ...
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
  		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...
1848
1849
1850
1851
1852
1853
1854
   - Link-local IP address negotiation:
  		Negotiate with other link-local clients on the local network
  		for an address that doesn't require explicit configuration.
  		This is especially useful if a DHCP server cannot be guaranteed
  		to exist in all environments that the device must operate.
  
  		See doc/README.link-local for more information.
a3d991bd0   wdenk   Patches by Pantel...
1855
   - CDP Options:
6e5923851   wdenk   * Cleanup, minor ...
1856
  		CONFIG_CDP_DEVICE_ID
a3d991bd0   wdenk   Patches by Pantel...
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
  
  		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...
1869
  		eth0 for the first Ethernet, eth1 for the second etc.
a3d991bd0   wdenk   Patches by Pantel...
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
  
  		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.
c609719b8   wdenk   Initial revision
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
  - Status LED:	CONFIG_STATUS_LED
  
  		Several configurations allow to display the current
  		status using a LED. For instance, the LED will blink
  		fast while running U-Boot code, stop blinking as
  		soon as a reply to a BOOTP request was received, and
  		start blinking slow once the Linux kernel is running
  		(supported by a status LED driver in the Linux
  		kernel). Defining CONFIG_STATUS_LED enables this
  		feature in U-Boot.
1df7bbba2   Igor Grinberg   README: document ...
1906
1907
1908
1909
1910
1911
1912
  		Additional options:
  
  		CONFIG_GPIO_LED
  		The status LED can be connected to a GPIO pin.
  		In such cases, the gpio_led driver can be used as a
  		status LED backend implementation. Define CONFIG_GPIO_LED
  		to include the gpio_led driver in the U-Boot binary.
9dfdcdfed   Igor Grinberg   gpio_led: add sup...
1913
1914
1915
1916
1917
1918
  		CONFIG_GPIO_LED_INVERTED_TABLE
  		Some GPIO connected LEDs may have inverted polarity in which
  		case the GPIO high value corresponds to LED off state and
  		GPIO low value corresponds to LED on state.
  		In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
  		with a list of GPIO LEDs that have inverted polarity.
c609719b8   wdenk   Initial revision
1919
1920
1921
1922
1923
  - CAN Support:	CONFIG_CAN_DRIVER
  
  		Defining CONFIG_CAN_DRIVER enables CAN driver support
  		on those systems that support this (optional)
  		feature, like the TQM8xxL modules.
3f4978c71   Heiko Schocher   i2c: common chang...
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
  - 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...
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
  		- 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...
1947

00f792e0d   Heiko Schocher   i2c, fsl_i2c: swi...
1948
1949
1950
1951
1952
1953
  		- 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...
1954
  		  - If your board supports a second fsl i2c bus, define
00f792e0d   Heiko Schocher   i2c, fsl_i2c: swi...
1955
1956
1957
1958
  		    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...
1959
  		- drivers/i2c/tegra_i2c.c:
10cee5166   Nobuhiro Iwamatsu   README: I2C: Fix ...
1960
1961
1962
  		  - 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...
1963

880540dec   Dirk Eibach   i2c, ppc4xx_i2c: ...
1964
1965
1966
1967
  		- 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...
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
  		- drivers/i2c/i2c_mxc.c
  		  - activate this driver with CONFIG_SYS_I2C_MXC
  		  - 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
  		If thoses defines are not set, default value is 100000
  		for speed, and 0 for slave.
1086bfa9f   Nobuhiro Iwamatsu   i2c: Add support ...
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
  		- 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...
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
  		- 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
  		  - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
  		  - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
  		  - CONFIF_SYS_I2C_SH_NUM_CONTROLLERS for nummber of i2c buses
6789e84ec   Heiko Schocher   i2c, omap24xx: co...
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
  		- drivers/i2c/omap24xx_i2c.c
  		  - activate this driver with CONFIG_SYS_I2C_OMAP24XX
  		  - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
  		  - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
  		  - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
  		  - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
  		  - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
  		  - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
  		  - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
  		  - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
  		  - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
  		  - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
0bdffe71f   Heiko Schocher   i2c, zynq: conver...
2020
2021
2022
2023
  		- drivers/i2c/zynq_i2c.c
  		  - activate this driver with CONFIG_SYS_I2C_ZYNQ
  		  - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
  		  - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
e717fc6d1   Naveen Krishna Ch   i2c: samsung: reg...
2024
2025
2026
2027
2028
  		- 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!
3f4978c71   Heiko Schocher   i2c: common chang...
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
  		additional defines:
  
  		CONFIG_SYS_NUM_I2C_BUSES
  		Hold the number of i2c busses you want to use. If you
  		don't use/have i2c muxes on your i2c bus, this
  		is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
  		omit this define.
  
  		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
  		hold a list of busses you want to use, only used if
  		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...
2066
2067
2068
2069
2070
  			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...
2071
  			bus 6 on adapter 1 without a mux
ea818dbbc   Heiko Schocher   i2c, soft-i2c: sw...
2072
2073
  			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...
2074
2075
  
  		If you do not have i2c muxes on your board, omit this define.
ea818dbbc   Heiko Schocher   i2c, soft-i2c: sw...
2076
  - Legacy I2C Support:	CONFIG_HARD_I2C
3f4978c71   Heiko Schocher   i2c: common chang...
2077
2078
2079
2080
2081
2082
2083
2084
2085
  
  		NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
  		provides the following compelling advantages:
  
  		- more than one i2c adapter is usable
  		- approved multibus support
  		- better i2c mux support
  
  		** Please consider updating your I2C driver now. **
ea818dbbc   Heiko Schocher   i2c, soft-i2c: sw...
2086
2087
2088
  		These enable legacy I2C serial bus commands. Defining
  		CONFIG_HARD_I2C will include the appropriate I2C driver
  		for the selected CPU.
c609719b8   wdenk   Initial revision
2089

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

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

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

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

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

5da71efa1   Eric Millbrandt   Reset i2c slave d...
2112
2113
2114
2115
2116
2117
  		CONFIG_SYS_I2C_INIT_MPC5XXX
  
  		When a board is reset during an i2c bus transfer
  		chips might think that the current transfer is still
  		in progress.  Reset the slave devices by sending start
  		commands until the slave device responds.
945af8d72   wdenk   * Add support for...
2118
  		That's all that's required for CONFIG_HARD_I2C.
c609719b8   wdenk   Initial revision
2119

ea818dbbc   Heiko Schocher   i2c, soft-i2c: sw...
2120
  		If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
b37c7e5e5   wdenk   * Patch by Seb Ja...
2121
2122
  		then the following macros need to be defined (examples are
  		from include/configs/lwmon.h):
c609719b8   wdenk   Initial revision
2123
2124
  
  		I2C_INIT
b37c7e5e5   wdenk   * Patch by Seb Ja...
2125
  		(Optional). Any commands necessary to enable the I2C
43d9616cf   wdenk   * Patch by Robert...
2126
  		controller or configure ports.
c609719b8   wdenk   Initial revision
2127

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

c609719b8   wdenk   Initial revision
2130
  		I2C_PORT
43d9616cf   wdenk   * Patch by Robert...
2131
2132
2133
  		(Only for MPC8260 CPU). The I/O port to use (the code
  		assumes both bits are on the same port). Valid values
  		are 0..3 for ports A..D.
c609719b8   wdenk   Initial revision
2134
2135
2136
2137
2138
2139
  
  		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...
2140
  		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
c609719b8   wdenk   Initial revision
2141
2142
2143
2144
2145
  		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...
2146
  		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
c609719b8   wdenk   Initial revision
2147
  		I2C_READ
472d54605   York Sun   Consolidate bool ...
2148
2149
  		Code that returns true if the I2C data line is high,
  		false if it is low.
c609719b8   wdenk   Initial revision
2150

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

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

c609719b8   wdenk   Initial revision
2160
  		I2C_SCL(bit)
472d54605   York Sun   Consolidate bool ...
2161
2162
  		If <bit> is true, sets the I2C clock line high. If it
  		is false, it clears it (low).
c609719b8   wdenk   Initial revision
2163

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

c609719b8   wdenk   Initial revision
2168
2169
2170
2171
  		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...
2172
  		is 1 / (I2C_DELAY * 4). Often defined to be something
945af8d72   wdenk   * Add support for...
2173
  		like:
b37c7e5e5   wdenk   * Patch by Seb Ja...
2174
  		#define I2C_DELAY  udelay(2)
c609719b8   wdenk   Initial revision
2175

793b5726f   Mike Frysinger   i2c: soft_i2c: ad...
2176
2177
2178
2179
2180
2181
2182
2183
2184
  		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...
2185
  		CONFIG_SYS_I2C_INIT_BOARD
47cd00fa7   wdenk   * Patches by Robe...
2186

8bde7f776   wdenk   * Code cleanup:
2187
2188
2189
2190
2191
2192
2193
2194
  		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...
2195

26a33504a   Richard Retanubun   fsl_i2c: Added a ...
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
  		CONFIG_SYS_I2C_BOARD_LATE_INIT
  
  		An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
  		defined a custom i2c_board_late_init() routine in
  		boards/xxx/board.c is run AFTER the operations in i2c_init()
  		is completed. This callpoint can be used to unreset i2c bus
  		using CPU i2c controller register accesses for CPUs whose i2c
  		controller provide such a method. It is called at the end of
  		i2c_init() to allow i2c_init operations to setup the i2c bus
  		controller on the CPU (e.g. setting bus speed & slave address).
17ea11774   wdenk   Patch by Tolunay ...
2206
2207
2208
2209
2210
  		CONFIG_I2CFAST (PPC405GP|PPC405EP only)
  
  		This option enables configuration of bi_iic_fast[] flags
  		in u-boot bd_info structure based on u-boot environment
  		variable "i2cfast". (see also i2cfast)
bb99ad6d8   Ben Warren   Add support for m...
2211
2212
2213
  		CONFIG_I2C_MULTI_BUS
  
  		This option allows the use of multiple I2C buses, each of which
c0f40859f   Wolfgang Denk   README: white-spa...
2214
2215
  		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...
2216
  		Note that bus numbering is zero-based.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2217
  		CONFIG_SYS_I2C_NOPROBES
bb99ad6d8   Ben Warren   Add support for m...
2218
2219
  
  		This option specifies a list of I2C devices that will be skipped
c0f40859f   Wolfgang Denk   README: white-spa...
2220
  		when the 'i2c probe' command is issued.	 If CONFIG_I2C_MULTI_BUS
0f89c54be   Peter Tyser   i2c: Update refer...
2221
2222
  		is set, specify a list of bus-device pairs.  Otherwise, specify
  		a 1D array of device addresses
bb99ad6d8   Ben Warren   Add support for m...
2223
2224
2225
  
  		e.g.
  			#undef	CONFIG_I2C_MULTI_BUS
c0f40859f   Wolfgang Denk   README: white-spa...
2226
  			#define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
bb99ad6d8   Ben Warren   Add support for m...
2227
2228
  
  		will skip addresses 0x50 and 0x68 on a board with one I2C bus
c0f40859f   Wolfgang Denk   README: white-spa...
2229
  			#define CONFIG_I2C_MULTI_BUS
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2230
  			#define CONFIG_SYS_I2C_MULTI_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
bb99ad6d8   Ben Warren   Add support for m...
2231
2232
  
  		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2233
  		CONFIG_SYS_SPD_BUS_NUM
be5e61815   Timur Tabi   mpc83xx: Update 8...
2234
2235
2236
  
  		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...
2237
  		CONFIG_SYS_RTC_BUS_NUM
0dc018ece   Stefan Roese   [PATCH] I2C: Add ...
2238
2239
2240
  
  		If defined, then this indicates the I2C bus number for the RTC.
  		If not defined, then U-Boot assumes that RTC is on I2C bus 0.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2241
  		CONFIG_SYS_DTT_BUS_NUM
0dc018ece   Stefan Roese   [PATCH] I2C: Add ...
2242
2243
2244
  
  		If defined, then this indicates the I2C bus number for the DTT.
  		If not defined, then U-Boot assumes that DTT is on I2C bus 0.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2245
  		CONFIG_SYS_I2C_DTT_ADDR:
9ebbb54f7   Victor Gallardo   ppc4xx: Allow DTT...
2246
2247
2248
2249
  
  		If defined, specifies the I2C address of the DTT device.
  		If not defined, then U-Boot uses predefined value for
  		specified DTT device.
2ac6985a7   Andrew Dyer   soft_i2c.c add op...
2250
2251
2252
2253
2254
2255
2256
2257
2258
  		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...
2259

c609719b8   wdenk   Initial revision
2260
2261
2262
2263
2264
  - SPI Support:	CONFIG_SPI
  
  		Enables SPI driver (so far only tested with
  		SPI EEPROM, also an instance works with Crystal A/D and
  		D/As on the SACSng board)
6639562e6   Yoshihiro Shimoda   spi: add support ...
2265
2266
2267
2268
  		CONFIG_SH_SPI
  
  		Enables the driver for SPI controller on SuperH. Currently
  		only SH7757 is supported.
c609719b8   wdenk   Initial revision
2269
2270
2271
2272
2273
2274
  		CONFIG_SPI_X
  
  		Enables extended (16-bit) SPI EEPROM addressing.
  		(symmetrical to CONFIG_I2C_X)
  
  		CONFIG_SOFT_SPI
43d9616cf   wdenk   * Patch by Robert...
2275
2276
2277
2278
2279
2280
2281
  		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
2282

04a9e1180   Ben Warren   Add support for a...
2283
2284
2285
2286
2287
  		CONFIG_HARD_SPI
  
  		Enables a hardware SPI driver for general-purpose reads
  		and writes.  As with CONFIG_SOFT_SPI, the board configuration
  		must define a list of chip-select function pointers.
c0f40859f   Wolfgang Denk   README: white-spa...
2288
  		Currently supported on some MPC8xxx processors.	 For an
04a9e1180   Ben Warren   Add support for a...
2289
  		example, see include/configs/mpc8349emds.h.
38254f45b   Guennadi Liakhovetski   New i.MX31 SPI dr...
2290
2291
2292
  		CONFIG_MXC_SPI
  
  		Enables the driver for the SPI controllers on i.MX and MXC
2e3cd1cda   Fabio Estevam   README: Fix suppo...
2293
  		SoCs. Currently i.MX31/35/51 are supported.
38254f45b   Guennadi Liakhovetski   New i.MX31 SPI dr...
2294

0133502e3   Matthias Fuchs   Improve configura...
2295
  - FPGA Support: CONFIG_FPGA
c609719b8   wdenk   Initial revision
2296

0133502e3   Matthias Fuchs   Improve configura...
2297
2298
2299
2300
2301
2302
  		Enables FPGA subsystem.
  
  		CONFIG_FPGA_<vendor>
  
  		Enables support for specific chip vendors.
  		(ALTERA, XILINX)
c609719b8   wdenk   Initial revision
2303

0133502e3   Matthias Fuchs   Improve configura...
2304
  		CONFIG_FPGA_<family>
c609719b8   wdenk   Initial revision
2305

0133502e3   Matthias Fuchs   Improve configura...
2306
2307
2308
2309
2310
2311
  		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
2312

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

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

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

43d9616cf   wdenk   * Patch by Robert...
2319
2320
2321
2322
  		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
2323
2324
2325
2326
2327
  
  		CONFIG_FPGA_DELAY
  
  		If defined, a function that provides delays in the FPGA
  		configuration driver.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2328
  		CONFIG_SYS_FPGA_CHECK_CTRLC
c609719b8   wdenk   Initial revision
2329
  		Allow Control-C to interrupt FPGA configuration
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2330
  		CONFIG_SYS_FPGA_CHECK_ERROR
c609719b8   wdenk   Initial revision
2331

43d9616cf   wdenk   * Patch by Robert...
2332
2333
2334
2335
  		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
2336

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

43d9616cf   wdenk   * Patch by Robert...
2339
2340
2341
  		Maximum time to wait for the INIT_B line to deassert
  		after PROB_B has been deasserted during a Virtex II
  		FPGA configuration sequence. The default time is 500
11ccc33fa   Marcel Ziswiler   Many spelling fix...
2342
  		ms.
c609719b8   wdenk   Initial revision
2343

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

43d9616cf   wdenk   * Patch by Robert...
2346
  		Maximum time to wait for BUSY to deassert during
11ccc33fa   Marcel Ziswiler   Many spelling fix...
2347
  		Virtex II FPGA configuration. The default is 5 ms.
c609719b8   wdenk   Initial revision
2348

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

43d9616cf   wdenk   * Patch by Robert...
2351
  		Time to wait after FPGA configuration. The default is
11ccc33fa   Marcel Ziswiler   Many spelling fix...
2352
  		200 ms.
c609719b8   wdenk   Initial revision
2353
2354
2355
  
  - Configuration Management:
  		CONFIG_IDENT_STRING
43d9616cf   wdenk   * Patch by Robert...
2356
2357
  		If defined, this string will be added to the U-Boot
  		version information (U_BOOT_VERSION)
c609719b8   wdenk   Initial revision
2358
2359
  
  - Vendor Parameter Protection:
43d9616cf   wdenk   * Patch by Robert...
2360
2361
  		U-Boot considers the values of the environment
  		variables "serial#" (Board Serial Number) and
7152b1d0b   wdenk   * Add support for...
2362
  		"ethaddr" (Ethernet Address) to be parameters that
43d9616cf   wdenk   * Patch by Robert...
2363
2364
2365
2366
  		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...
2367
  		change this behaviour:
c609719b8   wdenk   Initial revision
2368
2369
2370
  
  		If CONFIG_ENV_OVERWRITE is #defined in your config
  		file, the write protection for vendor parameters is
47cd00fa7   wdenk   * Patches by Robe...
2371
  		completely disabled. Anybody can change or delete
c609719b8   wdenk   Initial revision
2372
2373
2374
2375
  		these parameters.
  
  		Alternatively, if you #define _both_ CONFIG_ETHADDR
  		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
11ccc33fa   Marcel Ziswiler   Many spelling fix...
2376
  		Ethernet address is installed in the environment,
c609719b8   wdenk   Initial revision
2377
2378
2379
  		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...
2380
2381
2382
2383
  		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
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
  - 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 '$(......
2399
  			setenv bootargs ... mem=\${mem}
c609719b8   wdenk   Initial revision
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
  			saveenv
  
  		This way you can tell Linux not to use this memory,
  		either, which results in a memory region that will
  		not be affected by reboots.
  
  		*WARNING* If your board configuration uses automatic
  		detection of the RAM size, you must make sure that
  		this memory test is non-destructive. So far, the
  		following board configurations are known to be
  		"pRAM-clean":
1b0757ece   Wolfgang Denk   PPC: remove dead ...
2411
2412
  			IVMS8, IVML24, SPD8xx, TQM8xxL,
  			HERMES, IP860, RPXlite, LWMON,
544d97e9a   Wolfgang Denk   PCU_E: remove cod...
2413
  			FLAGADM, TQM8260
c609719b8   wdenk   Initial revision
2414

40fef0490   Gabe Black   Introduce arch_ph...
2415
2416
2417
2418
2419
2420
2421
  - 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
2422
2423
2424
2425
2426
2427
  - Error Recovery:
  		CONFIG_PANIC_HANG
  
  		Define this variable to stop the system in case of a
  		fatal error, so that you have to reset it manually.
  		This is probably NOT a good idea for an embedded
11ccc33fa   Marcel Ziswiler   Many spelling fix...
2428
  		system where you want the system to reboot
c609719b8   wdenk   Initial revision
2429
2430
2431
2432
2433
  		automatically as fast as possible, but it may be
  		useful during development since you can try to debug
  		the conditions that lead to the situation.
  
  		CONFIG_NET_RETRY_COUNT
43d9616cf   wdenk   * Patch by Robert...
2434
2435
2436
2437
  		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
2438

40cb90ee2   Guennadi Liakhovetski   net: make ARP tim...
2439
2440
2441
  		CONFIG_ARP_TIMEOUT
  
  		Timeout waiting for an ARP reply in milliseconds.
48a3e999c   Tetsuyuki Kobayashi   net: nfs: make NF...
2442
2443
2444
2445
2446
2447
  		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
2448
  - Command Interpreter:
8078f1a5f   Wolfgang Denk   README says CFG_A...
2449
  		CONFIG_AUTO_COMPLETE
04a85b3b3   wdenk   * Patches by Pant...
2450
2451
  
  		Enable auto completion of commands using TAB.
a9398e018   Wolfgang Denk   Minor code cleanu...
2452
2453
  		Note that this feature has NOT been implemented yet
  		for the "hush" shell.
8078f1a5f   Wolfgang Denk   README says CFG_A...
2454

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2455
  		CONFIG_SYS_HUSH_PARSER
c609719b8   wdenk   Initial revision
2456
2457
2458
2459
2460
2461
2462
2463
2464
  
  		Define this variable to enable the "hush" shell (from
  		Busybox) as command line interpreter, thus enabling
  		powerful command line syntax like
  		if...then...else...fi conditionals or `&&' and '||'
  		constructs ("shell scripts").
  
  		If undefined, you get the old, much simpler behaviour
  		with a somewhat smaller memory footprint.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2465
  		CONFIG_SYS_PROMPT_HUSH_PS2
c609719b8   wdenk   Initial revision
2466
2467
2468
2469
2470
2471
  
  		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:
2472
2473
2474
2475
2476
2477
2478
  		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
2479

43d9616cf   wdenk   * Patch by Robert...
2480
2481
2482
2483
  		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
2484
2485
2486
2487
2488
2489
  
  		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.
aa0c71aca   Wolfgang Denk   Document CONFIG_C...
2490
2491
  - Commandline Editing and History:
  		CONFIG_CMDLINE_EDITING
11ccc33fa   Marcel Ziswiler   Many spelling fix...
2492
  		Enable editing and History functions for interactive
b9365a26a   Wolfgang Denk   Code cleanup
2493
  		commandline input operations
aa0c71aca   Wolfgang Denk   Document CONFIG_C...
2494

a8c7c708a   wdenk   * Patch by Gleb N...
2495
  - Default Environment:
c609719b8   wdenk   Initial revision
2496
  		CONFIG_EXTRA_ENV_SETTINGS
43d9616cf   wdenk   * Patch by Robert...
2497
2498
  		Define this to contain any number of null terminated
  		strings (variable = value pairs) that will be part of
7152b1d0b   wdenk   * Add support for...
2499
  		the default environment compiled into the boot image.
2262cfeef   wdenk   * Patch by Daniel...
2500

43d9616cf   wdenk   * Patch by Robert...
2501
2502
  		For example, place something like this in your
  		board's config file:
c609719b8   wdenk   Initial revision
2503
2504
2505
2506
  
  		#define CONFIG_EXTRA_ENV_SETTINGS \
  			"myvar1=value1\0" \
  			"myvar2=value2\0"
43d9616cf   wdenk   * Patch by Robert...
2507
2508
2509
2510
  		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...
2511
  		will change soon, there is no guarantee either.
c609719b8   wdenk   Initial revision
2512
  		You better know what you are doing here.
43d9616cf   wdenk   * Patch by Robert...
2513
2514
  		Note: overly (ab)use of the default environment is
  		discouraged. Make sure to check other ways to preset
74de7aefd   Wolfgang Denk   Add "source" comm...
2515
  		the environment like the "source" command or the
43d9616cf   wdenk   * Patch by Robert...
2516
  		boot command first.
c609719b8   wdenk   Initial revision
2517

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

f61ec45eb   Eric Nelson   README: Add descr...
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
  - Serial Flash support
  		CONFIG_CMD_SF
  
  		Defining this option enables SPI flash commands
  		'sf probe/read/write/erase/update'.
  
  		Usage requires an initial 'probe' to define the serial
  		flash parameters, followed by read/write/erase/update
  		commands.
  
  		The following defaults may be provided by the platform
  		to handle the common case when only a single serial
  		flash is present on the system.
  
  		CONFIG_SF_DEFAULT_BUS		Bus identifier
  		CONFIG_SF_DEFAULT_CS		Chip-select
  		CONFIG_SF_DEFAULT_MODE 		(see include/spi.h)
  		CONFIG_SF_DEFAULT_SPEED		in Hz
240072731   Simon Glass   spi: Add SPI flas...
2568
2569
2570
2571
  		CONFIG_CMD_SF_TEST
  
  		Define this option to include a destructive SPI flash
  		test ('sf test').
1dcd6d038   Jagannadha Sutradharudu Teki   sf: Add bank addr...
2572
2573
2574
2575
  		CONFIG_SPI_FLASH_BAR		Ban/Extended Addr Reg
  
  		Define this option to use the Bank addr/Extended addr
  		support on SPI flashes which has size > 16Mbytes.
b902e07ce   Jagannadha Sutradharudu Teki   sf: Add CONFIG_SF...
2576
2577
2578
2579
2580
  		CONFIG_SF_DUAL_FLASH		Dual flash memories
  
  		Define this option to use dual flash support where two flash
  		memories can be connected with a given cs line.
  		currently Xilinx Zynq qspi support these type of connections.
3f85ce278   wdenk   * CVS add missing...
2581
2582
2583
2584
2585
  - SystemACE Support:
  		CONFIG_SYSTEMACE
  
  		Adding this option adds support for Xilinx SystemACE
  		chips attached via some sort of local bus. The address
11ccc33fa   Marcel Ziswiler   Many spelling fix...
2586
  		of the chip must also be defined in the
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2587
  		CONFIG_SYS_SYSTEMACE_BASE macro. For example:
3f85ce278   wdenk   * CVS add missing...
2588
2589
  
  		#define CONFIG_SYSTEMACE
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2590
  		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
3f85ce278   wdenk   * CVS add missing...
2591
2592
2593
  
  		When SystemACE support is added, the "ace" device type
  		becomes available to the fat commands, i.e. fatls.
ecb0ccd9c   Wolfgang Denk   Allow to force TF...
2594
2595
  - TFTP Fixed UDP Port:
  		CONFIG_TFTP_PORT
28cb93758   Wolfgang Denk   Update for TFTP u...
2596
  		If this is defined, the environment variable tftpsrcp
ecb0ccd9c   Wolfgang Denk   Allow to force TF...
2597
  		is used to supply the TFTP UDP source port value.
28cb93758   Wolfgang Denk   Update for TFTP u...
2598
  		If tftpsrcp isn't defined, the normal pseudo-random port
ecb0ccd9c   Wolfgang Denk   Allow to force TF...
2599
  		number generator is used.
28cb93758   Wolfgang Denk   Update for TFTP u...
2600
2601
2602
2603
2604
  		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...
2605
2606
2607
2608
2609
2610
  		blindly start the TFTP transfer using the pre-configured
  		target IP address and UDP port. This has the effect of
  		"punching through" the (Windows XP) firewall, allowing
  		the remainder of the TFTP transfer to proceed normally.
  		A better solution is to properly configure the firewall,
  		but sometimes that is not allowed.
bf36c5d52   Simon Glass   Add hash command ...
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
  - Hashing support:
  		CONFIG_CMD_HASH
  
  		This enables a generic 'hash' command which can produce
  		hashes / digests from a few algorithms (e.g. SHA1, SHA256).
  
  		CONFIG_HASH_VERIFY
  
  		Enable the hash verify command (hash -v). This adds to code
  		size a little.
  
  		CONFIG_SHA1 - support SHA1 hashing
  		CONFIG_SHA256 - support SHA256 hashing
  
  		Note: There is also a sha1sum command, which should perhaps
  		be deprecated in favour of 'hash sha1'.
a11f18737   Robert Winkler   imx: Add document...
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
  - Freescale i.MX specific commands:
  		CONFIG_CMD_HDMIDETECT
  		This enables 'hdmidet' command which returns true if an
  		HDMI monitor is detected.  This command is i.MX 6 specific.
  
  		CONFIG_CMD_BMODE
  		This enables the 'bmode' (bootmode) command for forcing
  		a boot from specific media.
  
  		This is useful for forcing the ROM's usb downloader to
  		activate upon a watchdog reset which is nice when iterating
  		on U-Boot.  Using the reset button or running bmode normal
  		will set it back to normal.  This command currently
  		supports i.MX53 and i.MX6.
19c402afa   Simon Glass   image: Add RSA su...
2641
2642
2643
2644
  - Signing support:
  		CONFIG_RSA
  
  		This enables the RSA algorithm used for FIT image verification
8bf2aad7e   Detlev Zundel   doc: README: Corr...
2645
  		in U-Boot. See doc/uImage.FIT/signature.txt for more information.
19c402afa   Simon Glass   image: Add RSA su...
2646
2647
2648
  
  		The signing part is build into mkimage regardless of this
  		option.
9e50c406c   Heiko Schocher   i2c, bootcount: a...
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
  - bootcount support:
  		CONFIG_BOOTCOUNT_LIMIT
  
  		This enables the bootcounter support, see:
  		http://www.denx.de/wiki/DULG/UBootBootCountLimit
  
  		CONFIG_AT91SAM9XE
  		enable special bootcounter support on at91sam9xe based boards.
  		CONFIG_BLACKFIN
  		enable special bootcounter support on blackfin based boards.
  		CONFIG_SOC_DA8XX
  		enable special bootcounter support on da850 based boards.
  		CONFIG_BOOTCOUNT_RAM
  		enable support for the bootcounter in RAM
  		CONFIG_BOOTCOUNT_I2C
  		enable support for the bootcounter on an i2c (like RTC) device.
  			CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
  			CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
  						    the bootcounter.
  			CONFIG_BOOTCOUNT_ALEN = address len
19c402afa   Simon Glass   image: Add RSA su...
2669

a8c7c708a   wdenk   * Patch by Gleb N...
2670
  - Show boot progress:
c609719b8   wdenk   Initial revision
2671
  		CONFIG_SHOW_BOOT_PROGRESS
43d9616cf   wdenk   * Patch by Robert...
2672
2673
2674
2675
2676
2677
  		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
2678

3a608ca01   Simon Glass   bootstage: Implem...
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
  - Detailed boot stage timing
  		CONFIG_BOOTSTAGE
  		Define this option to get detailed timing of each stage
  		of the boot process.
  
  		CONFIG_BOOTSTAGE_USER_COUNT
  		This is the number of available user bootstage records.
  		Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
  		a new ID will be allocated from this stash. If you exceed
  		the limit, recording will stop.
  
  		CONFIG_BOOTSTAGE_REPORT
  		Define this to print a report before boot, similar to this:
  
  		Timer summary in microseconds:
  		       Mark    Elapsed  Stage
  			  0          0  reset
  		  3,575,678  3,575,678  board_init_f start
  		  3,575,695         17  arch_cpu_init A9
  		  3,575,777         82  arch_cpu_init done
  		  3,659,598     83,821  board_init_r start
  		  3,910,375    250,777  main_loop
  		 29,916,167 26,005,792  bootm_start
  		 30,361,327    445,160  start_kernel
2eba38cf8   Simon Glass   bootstage: Add bo...
2703
2704
2705
  		CONFIG_CMD_BOOTSTAGE
  		Add a 'bootstage' command which supports printing a report
  		and un/stashing of bootstage data.
94fd1316b   Simon Glass   bootstage: Store ...
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
  		CONFIG_BOOTSTAGE_FDT
  		Stash the bootstage information in the FDT. A root 'bootstage'
  		node is created with each bootstage id as a child. Each child
  		has a 'name' property and either 'mark' containing the
  		mark time in microsecond, or 'accum' containing the
  		accumulated time for that bootstage id in microseconds.
  		For example:
  
  		bootstage {
  			154 {
  				name = "board_init_f";
  				mark = <3575678>;
  			};
  			170 {
  				name = "lcd";
  				accum = <33482>;
  			};
  		};
  
  		Code in the Linux kernel can find this in /proc/devicetree.
1372cce2b   Marian Balakowicz   [new uImage] Use ...
2726
  Legacy uImage format:
c609719b8   wdenk   Initial revision
2727
2728
    Arg	Where			When
      1	common/cmd_bootm.c	before attempting to boot an image
ba56f6257   wdenk   Patch by Travis S...
2729
     -1	common/cmd_bootm.c	Image header has bad	 magic number
c609719b8   wdenk   Initial revision
2730
      2	common/cmd_bootm.c	Image header has correct magic number
ba56f6257   wdenk   Patch by Travis S...
2731
     -2	common/cmd_bootm.c	Image header has bad	 checksum
c609719b8   wdenk   Initial revision
2732
      3	common/cmd_bootm.c	Image header has correct checksum
ba56f6257   wdenk   Patch by Travis S...
2733
     -3	common/cmd_bootm.c	Image data   has bad	 checksum
c609719b8   wdenk   Initial revision
2734
2735
2736
      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 ...
2737
     -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
c609719b8   wdenk   Initial revision
2738
2739
2740
2741
      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 ...
2742
      8	common/cmd_bootm.c	No uncompress/copy overwrite error
c609719b8   wdenk   Initial revision
2743
     -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
1372cce2b   Marian Balakowicz   [new uImage] Use ...
2744
2745
2746
2747
2748
2749
2750
2751
  
      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...
2752
    -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
1372cce2b   Marian Balakowicz   [new uImage] Use ...
2753
2754
     13	common/image.c		Start multifile image verification
     14	common/image.c		No initial ramdisk, no multifile, continue.
c0f40859f   Wolfgang Denk   README: white-spa...
2755
     15	arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
c609719b8   wdenk   Initial revision
2756

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

566a494f5   Heiko Schocher   [PCS440EP] u...
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
     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...
2810
     64	net/eth.c		starting with Ethernet configuration.
566a494f5   Heiko Schocher   [PCS440EP] u...
2811
2812
2813
2814
2815
    -64	net/eth.c		no Ethernet found.
     65	net/eth.c		Ethernet found.
  
    -80	common/cmd_net.c	usage wrong
     80	common/cmd_net.c	before calling NetLoop()
11ccc33fa   Marcel Ziswiler   Many spelling fix...
2816
    -81	common/cmd_net.c	some error in NetLoop() occurred
566a494f5   Heiko Schocher   [PCS440EP] u...
2817
2818
2819
     81	common/cmd_net.c	NetLoop() back without error
    -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...
2820
2821
     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...
2822
     84	common/cmd_net.c	end without errors
c609719b8   wdenk   Initial revision
2823

1372cce2b   Marian Balakowicz   [new uImage] Use ...
2824
2825
2826
2827
2828
2829
2830
2831
2832
  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 ...
2833
    103	common/cmd_bootm.c	Found configuration node
1372cce2b   Marian Balakowicz   [new uImage] Use ...
2834
2835
2836
2837
2838
    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...
2839
2840
   -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 ...
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
   -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...
2853
    122	common/image.c		No ramdisk subimage unit name, using configuration
1372cce2b   Marian Balakowicz   [new uImage] Use ...
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
   -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...
2866
   -130	common/cmd_doc.c	Incorrect FIT image format
1372cce2b   Marian Balakowicz   [new uImage] Use ...
2867
    131	common/cmd_doc.c	FIT image format OK
11ccc33fa   Marcel Ziswiler   Many spelling fix...
2868
   -140	common/cmd_ide.c	Incorrect FIT image format
1372cce2b   Marian Balakowicz   [new uImage] Use ...
2869
    141	common/cmd_ide.c	FIT image format OK
11ccc33fa   Marcel Ziswiler   Many spelling fix...
2870
   -150	common/cmd_nand.c	Incorrect FIT image format
1372cce2b   Marian Balakowicz   [new uImage] Use ...
2871
    151	common/cmd_nand.c	FIT image format OK
d95f6ec73   Gabe Black   fdt: Add option t...
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
  - FIT image support:
  		CONFIG_FIT
  		Enable support for the FIT uImage format.
  
  		CONFIG_FIT_BEST_MATCH
  		When no configuration is explicitly selected, default to the
  		one whose fdt's compatibility field best matches that of
  		U-Boot itself. A match is considered "best" if it matches the
  		most specific compatibility entry of U-Boot's fdt's root node.
  		The order of entries in the configuration's fdt is ignored.
3e569a6b1   Simon Glass   image: Add signin...
2882
2883
2884
2885
  		CONFIG_FIT_SIGNATURE
  		This option enables signature verification of FIT uImages,
  		using a hash signed and verified using RSA. See
  		doc/uImage.FIT/signature.txt for more details.
4cf2609b0   Wolfgang Denk   README: fix docum...
2886
2887
  - Standalone program support:
  		CONFIG_STANDALONE_LOAD_ADDR
6feff899e   Wolfgang Denk   README: fix typos...
2888
2889
2890
  		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...
2891
2892
2893
2894
2895
2896
  		settings.
  
  - Frame Buffer Address:
  		CONFIG_FB_ADDR
  
  		Define CONFIG_FB_ADDR if you want to use specific
44a53b574   Wolfgang Denk   VIDEO: better doc...
2897
2898
2899
2900
2901
2902
2903
  		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...
2904
2905
  
  		Please see board_init_f function.
cccfc2ab7   Detlev Zundel   README: Rearrange...
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
  - Automatic software updates via TFTP server
  		CONFIG_UPDATE_TFTP
  		CONFIG_UPDATE_TFTP_CNT_MAX
  		CONFIG_UPDATE_TFTP_MSEC_MAX
  
  		These options enable and control the auto-update feature;
  		for a more detailed description refer to doc/README.update.
  
  - MTD Support (mtdparts command, UBI support)
  		CONFIG_MTD_DEVICE
  
  		Adds the MTD device infrastructure from the Linux kernel.
  		Needed for mtdparts command support.
  
  		CONFIG_MTD_PARTITIONS
  
  		Adds the MTD partitioning infrastructure from the Linux
  		kernel. Needed for UBI support.
70c219cd7   Joe Hershberger   ubi: ubifs: Add d...
2924
2925
2926
2927
2928
2929
2930
  - UBI support
  		CONFIG_CMD_UBI
  
  		Adds commands for interacting with MTD partitions formatted
  		with the UBI flash translation layer
  
  		Requires also defining CONFIG_RBTREE
147162dac   Joe Hershberger   ubi: ubifs: Turn ...
2931
2932
2933
2934
  		CONFIG_UBI_SILENCE_MSG
  
  		Make the verbose messages from UBI stop printing.  This leaves
  		warnings and errors enabled.
70c219cd7   Joe Hershberger   ubi: ubifs: Add d...
2935
2936
2937
2938
2939
2940
2941
  - UBIFS support
  		CONFIG_CMD_UBIFS
  
  		Adds commands for interacting with UBI volumes formatted as
  		UBIFS.  UBIFS is read-only in u-boot.
  
  		Requires UBI support as well as CONFIG_LZO
147162dac   Joe Hershberger   ubi: ubifs: Turn ...
2942
2943
2944
2945
  		CONFIG_UBIFS_SILENCE_MSG
  
  		Make the verbose messages from UBIFS stop printing.  This leaves
  		warnings and errors enabled.
6a11cf48a   Daniel Schwierzeck   spl: add initial ...
2946
  - SPL framework
04e5ae793   Wolfgang Denk   Minor coding styl...
2947
2948
  		CONFIG_SPL
  		Enable building of SPL globally.
6a11cf48a   Daniel Schwierzeck   spl: add initial ...
2949

95579793b   Tom Rini   README: document ...
2950
2951
  		CONFIG_SPL_LDSCRIPT
  		LDSCRIPT for linking the SPL binary.
6ebc34611   Albert ARIBAUD   ARM: fix CONFIG_S...
2952
2953
2954
2955
  		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...
2956
  		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
6ebc34611   Albert ARIBAUD   ARM: fix CONFIG_S...
2957
  		must not be both defined at the same time.
95579793b   Tom Rini   README: document ...
2958
  		CONFIG_SPL_MAX_SIZE
6ebc34611   Albert ARIBAUD   ARM: fix CONFIG_S...
2959
2960
2961
2962
  		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 ...
2963

04e5ae793   Wolfgang Denk   Minor coding styl...
2964
2965
  		CONFIG_SPL_TEXT_BASE
  		TEXT_BASE for linking the SPL binary.
6a11cf48a   Daniel Schwierzeck   spl: add initial ...
2966

94a45bb19   Scott Wood   powerpc/mpc85xx/p...
2967
2968
2969
  		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 ...
2970
2971
2972
2973
  		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...
2974
2975
2976
  		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...
2977
  		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
6ebc34611   Albert ARIBAUD   ARM: fix CONFIG_S...
2978
  		must not be both defined at the same time.
95579793b   Tom Rini   README: document ...
2979
2980
2981
  
  		CONFIG_SPL_STACK
  		Adress of the start of the stack SPL will use
94a45bb19   Scott Wood   powerpc/mpc85xx/p...
2982
2983
2984
2985
  		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 ...
2986
2987
2988
2989
2990
  		CONFIG_SYS_SPL_MALLOC_START
  		Starting address of the malloc pool used in SPL.
  
  		CONFIG_SYS_SPL_MALLOC_SIZE
  		The size of the malloc pool used in SPL.
6a11cf48a   Daniel Schwierzeck   spl: add initial ...
2991

47f7bcae8   Tom Rini   SPL: Move the oma...
2992
2993
2994
2995
  		CONFIG_SPL_FRAMEWORK
  		Enable the SPL framework under common/.  This framework
  		supports MMC, NAND and YMODEM loading of U-Boot and NAND
  		NAND loading of the Linux Kernel.
861a86f46   Tom Rini   omap-common: SPL:...
2996
2997
2998
  		CONFIG_SPL_DISPLAY_PRINT
  		For ARM, enable an optional function to print more information
  		about the running system.
4b919725b   Scott Wood   spl/powerpc: intr...
2999
3000
  		CONFIG_SPL_INIT_MINIMAL
  		Arch init code should be built for a very small image
04e5ae793   Wolfgang Denk   Minor coding styl...
3001
3002
  		CONFIG_SPL_LIBCOMMON_SUPPORT
  		Support for common/libcommon.o in SPL binary
6a11cf48a   Daniel Schwierzeck   spl: add initial ...
3003

04e5ae793   Wolfgang Denk   Minor coding styl...
3004
3005
  		CONFIG_SPL_LIBDISK_SUPPORT
  		Support for disk/libdisk.o in SPL binary
6a11cf48a   Daniel Schwierzeck   spl: add initial ...
3006

04e5ae793   Wolfgang Denk   Minor coding styl...
3007
3008
  		CONFIG_SPL_I2C_SUPPORT
  		Support for drivers/i2c/libi2c.o in SPL binary
6a11cf48a   Daniel Schwierzeck   spl: add initial ...
3009

04e5ae793   Wolfgang Denk   Minor coding styl...
3010
3011
  		CONFIG_SPL_GPIO_SUPPORT
  		Support for drivers/gpio/libgpio.o in SPL binary
6a11cf48a   Daniel Schwierzeck   spl: add initial ...
3012

04e5ae793   Wolfgang Denk   Minor coding styl...
3013
3014
  		CONFIG_SPL_MMC_SUPPORT
  		Support for drivers/mmc/libmmc.o in SPL binary
6a11cf48a   Daniel Schwierzeck   spl: add initial ...
3015

95579793b   Tom Rini   README: document ...
3016
3017
3018
3019
3020
  		CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
  		CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
  		CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
  		Address, size and 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...
3021
3022
3023
3024
3025
3026
3027
3028
3029
  		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)
95579793b   Tom Rini   README: document ...
3030
3031
3032
3033
3034
  		CONFIG_SPL_FAT_SUPPORT
  		Support for fs/fat/libfat.o in SPL binary
  
  		CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
  		Filename to read to load U-Boot when reading from FAT
7ad2cc796   Peter Korsgaard   spl_mmc: add Falc...
3035
3036
3037
3038
3039
3040
3041
  		CONFIG_SPL_FAT_LOAD_KERNEL_NAME
  		Filename to read to load kernel uImage when reading
  		from FAT (for Falcon mode)
  
  		CONFIG_SPL_FAT_LOAD_ARGS_NAME
  		Filename to read to load kernel argument parameters
  		when reading from FAT (for Falcon mode)
06f60ae3e   Scott Wood   powerpc/mpc83xx: ...
3042
3043
3044
3045
3046
  		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).
6f2f01b9f   Scott Wood   spl/nand: introdu...
3047
3048
3049
3050
3051
3052
3053
3054
3055
  		CONFIG_SPL_NAND_BASE
  		Include nand_base.c in the SPL.  Requires
  		CONFIG_SPL_NAND_DRIVERS.
  
  		CONFIG_SPL_NAND_DRIVERS
  		SPL uses normal NAND drivers, not minimal drivers.
  
  		CONFIG_SPL_NAND_ECC
  		Include standard software ECC in the SPL
95579793b   Tom Rini   README: document ...
3056
  		CONFIG_SPL_NAND_SIMPLE
7d4b79552   Scott Wood   spl/nand: config ...
3057
3058
  		Support for NAND boot using simple NAND drivers that
  		expose the cmd_ctrl() interface.
95579793b   Tom Rini   README: document ...
3059

bb0dc1084   Ying Zhang   powerpc: mpc85xx:...
3060
3061
  		CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
  		Set for the SPL on PPC mpc8xxx targets, support for
5614e71b4   York Sun   Driver/DDR: Movin...
3062
  		drivers/ddr/fsl/libddr.o in SPL binary.
bb0dc1084   Ying Zhang   powerpc: mpc85xx:...
3063

7c8eea59b   Ying Zhang   powerpc: p1022ds:...
3064
3065
3066
  		CONFIG_SPL_COMMON_INIT_DDR
  		Set for common ddr init with serial presence detect in
  		SPL binary.
95579793b   Tom Rini   README: document ...
3067
3068
3069
3070
3071
3072
  		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 ...
3073
  		to read U-Boot
95579793b   Tom Rini   README: document ...
3074

fbe76ae4e   Prabhakar Kushwaha   board/freescale:R...
3075
3076
  		CONFIG_SPL_NAND_BOOT
  		Add support NAND boot
95579793b   Tom Rini   README: document ...
3077
  		CONFIG_SYS_NAND_U_BOOT_OFFS
7d4b79552   Scott Wood   spl/nand: config ...
3078
3079
3080
3081
3082
3083
3084
  		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 ...
3085
3086
  
  		CONFIG_SYS_NAND_U_BOOT_START
7d4b79552   Scott Wood   spl/nand: config ...
3087
  		Entry point in loaded image to jump to
95579793b   Tom Rini   README: document ...
3088
3089
3090
3091
3092
3093
3094
3095
  
  		CONFIG_SYS_NAND_HW_ECC_OOBFIRST
  		Define this if you need to first read the OOB and then the
  		data. This is used for example on davinci plattforms.
  
  		CONFIG_SPL_OMAP3_ID_NAND
  		Support for an OMAP3-specific set of functions to return the
  		ID and MFR of the first attached NAND chip, if present.
04e5ae793   Wolfgang Denk   Minor coding styl...
3096
3097
  		CONFIG_SPL_SERIAL_SUPPORT
  		Support for drivers/serial/libserial.o in SPL binary
6a11cf48a   Daniel Schwierzeck   spl: add initial ...
3098

04e5ae793   Wolfgang Denk   Minor coding styl...
3099
3100
  		CONFIG_SPL_SPI_FLASH_SUPPORT
  		Support for drivers/mtd/spi/libspi_flash.o in SPL binary
6a11cf48a   Daniel Schwierzeck   spl: add initial ...
3101

04e5ae793   Wolfgang Denk   Minor coding styl...
3102
3103
  		CONFIG_SPL_SPI_SUPPORT
  		Support for drivers/spi/libspi.o in SPL binary
c57b953da   Pavel Machek   SPL: Add support ...
3104
3105
3106
  
  		CONFIG_SPL_RAM_DEVICE
  		Support for running image already present in ram, in SPL binary
6a11cf48a   Daniel Schwierzeck   spl: add initial ...
3107

04e5ae793   Wolfgang Denk   Minor coding styl...
3108
3109
  		CONFIG_SPL_LIBGENERIC_SUPPORT
  		Support for lib/libgeneric.o in SPL binary
1372cce2b   Marian Balakowicz   [new uImage] Use ...
3110

ba1bee43e   Ying Zhang   common/Makefile: ...
3111
3112
3113
3114
3115
3116
3117
  		CONFIG_SPL_ENV_SUPPORT
  		Support for the environment operating in SPL binary
  
  		CONFIG_SPL_NET_SUPPORT
  		Support for the net/libnet.o in SPL binary.
  		It conflicts with SPL env from storage medium specified by
  		CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
74752baa7   Scott Wood   spl: Change PAD_T...
3118
  		CONFIG_SPL_PAD_TO
6113d3f27   Benoît Thébaudeau   Makefile: Change ...
3119
3120
3121
3122
3123
  		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...
3124

ca2fca223   Scott Wood   spl: introduce CO...
3125
3126
3127
3128
  		CONFIG_SPL_TARGET
  		Final target image containing SPL and payload.  Some SPLs
  		use an arch-specific makefile fragment instead, for
  		example if more than one image needs to be produced.
87ebee39e   Simon Glass   image: Add CONFIG...
3129
3130
3131
3132
3133
  		CONFIG_FIT_SPL_PRINT
  		Printing information about a FIT image adds quite a bit of
  		code to SPL. So this is normally disabled in SPL. Use this
  		option to re-enable it. This will affect the output of the
  		bootm command when booting a FIT image.
3aa29de0b   Ying Zhang   TPL : introduce t...
3134
3135
3136
3137
3138
3139
3140
  - 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...
3141
3142
3143
  		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...
3144

c609719b8   wdenk   Initial revision
3145
3146
  Modem Support:
  --------------
566e5cf45   Wolfgang Denk   ARM: drop unsuppo...
3147
  [so far only for SMDK2400 boards]
c609719b8   wdenk   Initial revision
3148

11ccc33fa   Marcel Ziswiler   Many spelling fix...
3149
  - Modem support enable:
c609719b8   wdenk   Initial revision
3150
3151
3152
3153
3154
3155
3156
  		CONFIG_MODEM_SUPPORT
  
  - RTS/CTS Flow control enable:
  		CONFIG_HWFLOW
  
  - Modem debug support:
  		CONFIG_MODEM_SUPPORT_DEBUG
43d9616cf   wdenk   * Patch by Robert...
3157
3158
  		Enables debugging stuff (char screen[1024], dbg())
  		for modem support. Useful only with BDI2000.
c609719b8   wdenk   Initial revision
3159

a8c7c708a   wdenk   * Patch by Gleb N...
3160
  - Interrupt support (PPC):
d4ca31c40   wdenk   * Cleanup lowboot...
3161
3162
  		There are common interrupt_init() and timer_interrupt()
  		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
11ccc33fa   Marcel Ziswiler   Many spelling fix...
3163
  		for CPU specific initialization. interrupt_init_cpu()
d4ca31c40   wdenk   * Cleanup lowboot...
3164
  		should set decrementer_count to appropriate value. If
11ccc33fa   Marcel Ziswiler   Many spelling fix...
3165
  		CPU resets decrementer automatically after interrupt
d4ca31c40   wdenk   * Cleanup lowboot...
3166
  		(ppc4xx) it should set decrementer_count to zero.
11ccc33fa   Marcel Ziswiler   Many spelling fix...
3167
  		timer_interrupt() calls timer_interrupt_cpu() for CPU
d4ca31c40   wdenk   * Cleanup lowboot...
3168
3169
3170
  		specific handling. If board has watchdog / status_led
  		/ other_activity_monitor it works automatically from
  		general timer_interrupt().
a8c7c708a   wdenk   * Patch by Gleb N...
3171

c609719b8   wdenk   Initial revision
3172
  - General:
43d9616cf   wdenk   * Patch by Robert...
3173
3174
3175
  		In the target system modem support is enabled when a
  		specific key (key combination) is pressed during
  		power-on. Otherwise U-Boot will boot normally
11ccc33fa   Marcel Ziswiler   Many spelling fix...
3176
  		(autoboot). The key_pressed() function is called from
43d9616cf   wdenk   * Patch by Robert...
3177
3178
3179
  		board_init(). Currently key_pressed() is a dummy
  		function, returning 1 and thus enabling modem
  		initialization.
c609719b8   wdenk   Initial revision
3180

43d9616cf   wdenk   * Patch by Robert...
3181
3182
3183
  		If there are no modem init strings in the
  		environment, U-Boot proceed to autoboot; the
  		previous output (banner, info printfs) will be
11ccc33fa   Marcel Ziswiler   Many spelling fix...
3184
  		suppressed, though.
c609719b8   wdenk   Initial revision
3185
3186
  
  		See also: doc/README.Modem
9660e442d   Helmut Raiger   cosmetic: s/BOARD...
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
  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
3201

c609719b8   wdenk   Initial revision
3202
3203
  Configuration Settings:
  -----------------------
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3204
  - CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
c609719b8   wdenk   Initial revision
3205
  		undefine this when you're short of memory.
2fb2604d5   Peter Tyser   Command usage cle...
3206
3207
  - 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...
3208
  - CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
c609719b8   wdenk   Initial revision
3209
  		prompt for user input.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3210
  - CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
c609719b8   wdenk   Initial revision
3211

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

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

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3216
  - CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
c609719b8   wdenk   Initial revision
3217
3218
  		the application (usually a Linux kernel) when it is
  		booted
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3219
  - CONFIG_SYS_BAUDRATE_TABLE:
c609719b8   wdenk   Initial revision
3220
  		List of legal baudrate settings for this board.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3221
  - CONFIG_SYS_CONSOLE_INFO_QUIET
8bde7f776   wdenk   * Code cleanup:
3222
  		Suppress display of console information at boot.
c609719b8   wdenk   Initial revision
3223

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3224
  - CONFIG_SYS_CONSOLE_IS_IN_ENV
8bde7f776   wdenk   * Code cleanup:
3225
3226
3227
  		If the board specific function
  			extern int overwrite_console (void);
  		returns 1, the stdin, stderr and stdout are switched to the
c609719b8   wdenk   Initial revision
3228
  		serial port, else the settings in the environment are used.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3229
  - CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
8bde7f776   wdenk   * Code cleanup:
3230
  		Enable the call to overwrite_console().
c609719b8   wdenk   Initial revision
3231

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3232
  - CONFIG_SYS_CONSOLE_ENV_OVERWRITE
c609719b8   wdenk   Initial revision
3233
  		Enable overwrite of previous console environment settings.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3234
  - CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
c609719b8   wdenk   Initial revision
3235
3236
  		Begin and End addresses of the area used by the
  		simple memory test.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3237
  - CONFIG_SYS_ALT_MEMTEST:
8bde7f776   wdenk   * Code cleanup:
3238
  		Enable an alternate, more extensive memory test.
c609719b8   wdenk   Initial revision
3239

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3240
  - CONFIG_SYS_MEMTEST_SCRATCH:
5f535fe17   wdenk   * Patches by Ande...
3241
3242
  		Scratch address used by the alternate memory test
  		You only need to set this if address zero isn't writeable
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3243
3244
  - CONFIG_SYS_MEM_TOP_HIDE (PPC only):
  		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
14f73ca67   Stefan Roese   ppc: Add CFG_MEM_...
3245
  		this specified memory area will get subtracted from the top
11ccc33fa   Marcel Ziswiler   Many spelling fix...
3246
  		(end) of RAM and won't get "touched" at all by U-Boot. By
14f73ca67   Stefan Roese   ppc: Add CFG_MEM_...
3247
3248
3249
  		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...
3250
  		board ports in arch/powerpc with bootwrapper support that
14f73ca67   Stefan Roese   ppc: Add CFG_MEM_...
3251
  		recalculate the memory size from the SDRAM controller setup
5e12e75d1   Stefan Roese   ppc: Small change...
3252
  		will have to get fixed in Linux additionally.
14f73ca67   Stefan Roese   ppc: Add CFG_MEM_...
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
  
  		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...
3263
  - CONFIG_SYS_LOADS_BAUD_CHANGE:
c609719b8   wdenk   Initial revision
3264
  		Enable temporary baudrate change while serial download
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3265
  - CONFIG_SYS_SDRAM_BASE:
c609719b8   wdenk   Initial revision
3266
  		Physical start address of SDRAM. _Must_ be 0 here.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3267
  - CONFIG_SYS_MBIO_BASE:
c609719b8   wdenk   Initial revision
3268
3269
  		Physical start address of Motherboard I/O (if using a
  		Cogent motherboard)
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3270
  - CONFIG_SYS_FLASH_BASE:
c609719b8   wdenk   Initial revision
3271
  		Physical start address of Flash memory.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3272
  - CONFIG_SYS_MONITOR_BASE:
c609719b8   wdenk   Initial revision
3273
3274
  		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 ...
3275
  		(CONFIG_SYS_TEXT_BASE) used when linking) - same as
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3276
  		CONFIG_SYS_FLASH_BASE when booting from flash.
c609719b8   wdenk   Initial revision
3277

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3278
  - CONFIG_SYS_MONITOR_LEN:
8bde7f776   wdenk   * Code cleanup:
3279
3280
3281
3282
  		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
3283

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3284
  - CONFIG_SYS_MALLOC_LEN:
c609719b8   wdenk   Initial revision
3285
  		Size of DRAM reserved for malloc() use.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3286
  - CONFIG_SYS_BOOTM_LEN:
15940c9af   Stefan Roese   Change max size o...
3287
3288
  		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...
3289
  		you can define CONFIG_SYS_BOOTM_LEN in your board config file
15940c9af   Stefan Roese   Change max size o...
3290
  		to adjust this setting to your needs.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3291
  - CONFIG_SYS_BOOTMAPSZ:
c609719b8   wdenk   Initial revision
3292
3293
  		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...
3294
3295
  		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...
3296
  		environment variable is defined and non-zero. In such case
7d721e34a   Bartlomiej Sieka   Boot-related docu...
3297
  		all data for the Linux kernel must be between "bootm_low"
c0f40859f   Wolfgang Denk   README: white-spa...
3298
  		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.	 The environment
c3624e6ed   Grant Likely   Default to bootm_...
3299
3300
3301
  		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
3302

fca43cc80   John Rigby   boot: change some...
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
  - 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...
3315
  - CONFIG_SYS_MAX_FLASH_BANKS:
c609719b8   wdenk   Initial revision
3316
  		Max number of Flash memory banks
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3317
  - CONFIG_SYS_MAX_FLASH_SECT:
c609719b8   wdenk   Initial revision
3318
  		Max number of sectors on a Flash chip
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3319
  - CONFIG_SYS_FLASH_ERASE_TOUT:
c609719b8   wdenk   Initial revision
3320
  		Timeout for Flash erase operations (in ms)
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3321
  - CONFIG_SYS_FLASH_WRITE_TOUT:
c609719b8   wdenk   Initial revision
3322
  		Timeout for Flash write operations (in ms)
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3323
  - CONFIG_SYS_FLASH_LOCK_TOUT
8564acf93   wdenk   * Patches by Yuli...
3324
  		Timeout for Flash set sector lock bit operation (in ms)
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3325
  - CONFIG_SYS_FLASH_UNLOCK_TOUT
8564acf93   wdenk   * Patches by Yuli...
3326
  		Timeout for Flash clear lock bits operation (in ms)
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3327
  - CONFIG_SYS_FLASH_PROTECTION
8564acf93   wdenk   * Patches by Yuli...
3328
3329
  		If defined, hardware flash sectors protection is used
  		instead of U-Boot software protection.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3330
  - CONFIG_SYS_DIRECT_FLASH_TFTP:
c609719b8   wdenk   Initial revision
3331
3332
3333
3334
3335
3336
3337
3338
  
  		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...
3339
3340
  		the flash, but in some situations (when system RAM is
  		too limited to allow for a temporary copy of the
c609719b8   wdenk   Initial revision
3341
  		downloaded image) this option may be very useful.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3342
  - CONFIG_SYS_FLASH_CFI:
43d9616cf   wdenk   * Patch by Robert...
3343
  		Define if the flash driver uses extra elements in the
5653fc335   wdenk   * Patch by Yuli B...
3344
  		common flash structure for storing flash geometry.
00b1883a4   Jean-Christophe PLAGNIOL-VILLARD   drivers/mtd: Move...
3345
  - CONFIG_FLASH_CFI_DRIVER
5653fc335   wdenk   * Patch by Yuli B...
3346
3347
  		This option also enables the building of the cfi_flash driver
  		in the drivers directory
c609719b8   wdenk   Initial revision
3348

91809ed51   Piotr Ziecik   cfi-mtd: Add cfi-...
3349
3350
3351
3352
  - 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...
3353
  - CONFIG_SYS_FLASH_USE_BUFFER_WRITE
96ef831f7   Guennadi Liakhovetski   cfi_flash: Suppor...
3354
3355
3356
3357
3358
  		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...
3359
  - CONFIG_SYS_FLASH_QUIET_TEST
5568e613e   Stefan Roese   Add support for P...
3360
3361
3362
3363
  		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...
3364
3365
3366
3367
  - 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...
3368
3369
3370
3371
3372
3373
3374
3375
  - 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...
3376
  - CONFIG_SYS_RX_ETH_BUFFER:
11ccc33fa   Marcel Ziswiler   Many spelling fix...
3377
3378
  		Defines the number of Ethernet receive buffers. On some
  		Ethernet controllers it is recommended to set this value
53cf9435c   stroese   - CFG_RX_ETH_BUFF...
3379
3380
  		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...
3381
  		on high Ethernet traffic.
53cf9435c   stroese   - CFG_RX_ETH_BUFF...
3382
  		Defaults to 4 if not defined.
ea882baf9   Wolfgang Denk   New implementatio...
3383
  - CONFIG_ENV_MAX_ENTRIES
071bc9233   Wolfgang Denk   Coding Style cleanup
3384
3385
3386
3387
3388
  	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...
3389

2598090b7   Joe Hershberger   env: Add environm...
3390
3391
  - CONFIG_ENV_FLAGS_LIST_DEFAULT
  - CONFIG_ENV_FLAGS_LIST_STATIC
1bce2aeb6   Robert P. J. Day   Cosmetic: Fix a n...
3392
  	Enable validation of the values given to environment variables when
2598090b7   Joe Hershberger   env: Add environm...
3393
3394
3395
3396
3397
3398
  	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]
267541f77   Joe Hershberger   env: Add support ...
3399
3400
  		access_atribute = [a|r|o|c]
  		attributes = type_attribute[access_atribute]
2598090b7   Joe Hershberger   env: Add environm...
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
  		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 ...
3411
3412
3413
3414
3415
  	The access attributes are:
  		a - Any (default)
  		r - Read-only
  		o - Write-once
  		c - Change-default
2598090b7   Joe Hershberger   env: Add environm...
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
  	- CONFIG_ENV_FLAGS_LIST_DEFAULT
  		Define this to a list (string) to define the ".flags"
  		envirnoment variable in the default or embedded environment.
  
  	- 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.
267541f77   Joe Hershberger   env: Add support ...
3426
3427
3428
  - CONFIG_ENV_ACCESS_IGNORE_FORCE
  	If defined, don't allow the -f switch to env set override variable
  	access flags.
5c1a7ea6a   Simon Glass   __HAVE_ARCH_GENER...
3429
3430
3431
3432
3433
3434
3435
3436
3437
  - CONFIG_SYS_GENERIC_BOARD
  	This selects the architecture-generic board system instead of the
  	architecture-specific board files. It is intended to move boards
  	to this new framework over time. Defining this will disable the
  	arch/foo/lib/board.c file and use common/board_f.c and
  	common/board_r.c instead. To use this option your architecture
  	must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
  	its config.mk file). If you find problems enabling this option on
  	your board please report the problem and send patches!
0b1b60c77   Lokesh Vutla   ARM: OMAP5: Fix w...
3438
3439
3440
3441
  - CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
  	This is set by OMAP boards for the max time that reset should
  	be asserted. See doc/README.omap-reset-time for details on how
  	the value can be calulated on a given board.
632efa744   Simon Glass   Add CONFIG_SYS_SY...
3442

c609719b8   wdenk   Initial revision
3443
3444
3445
  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...
3446
3447
3448
3449
  - CONFIG_BUILD_ENVCRC:
  
  	Builds up envcrc with the target environment so that external utils
  	may easily extract it and embed it in final U-Boot images.
5a1aceb06   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ENV_IS...
3450
  - CONFIG_ENV_IS_IN_FLASH:
c609719b8   wdenk   Initial revision
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
  
  	Define this if the environment is in flash memory.
  
  	a) The environment occupies one whole flash sector, which is
  	   "embedded" in the text segment with the U-Boot code. This
  	   happens usually with "bottom boot sector" or "top boot
  	   sector" type flash chips, which have several smaller
  	   sectors at the start or the end. For instance, such a
  	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
  	   such a case you would place the environment in one of the
  	   4 kB sectors - with U-Boot code before and after it. With
  	   "top boot sector" type flash chips, you would put the
  	   environment in one of the last sectors, leaving a gap
  	   between U-Boot and the environment.
0e8d15866   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ENV ma...
3465
  	- CONFIG_ENV_OFFSET:
c609719b8   wdenk   Initial revision
3466
3467
3468
3469
3470
  
  	   Offset of environment data (variable area) to the
  	   beginning of flash memory; for instance, with bottom boot
  	   type flash chips the second sector can be used: the offset
  	   for this sector is given here.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3471
  	   CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
c609719b8   wdenk   Initial revision
3472

0e8d15866   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ENV ma...
3473
  	- CONFIG_ENV_ADDR:
c609719b8   wdenk   Initial revision
3474
3475
3476
  
  	   This is just another way to specify the start address of
  	   the flash sector containing the environment (instead of
0e8d15866   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ENV ma...
3477
  	   CONFIG_ENV_OFFSET).
c609719b8   wdenk   Initial revision
3478

0e8d15866   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ENV ma...
3479
  	- CONFIG_ENV_SECT_SIZE:
c609719b8   wdenk   Initial revision
3480
3481
3482
3483
3484
3485
3486
  
  	   Size of the sector containing the environment.
  
  
  	b) Sometimes flash chips have few, equal sized, BIG sectors.
  	   In such a case you don't want to spend a whole sector for
  	   the environment.
0e8d15866   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ENV ma...
3487
  	- CONFIG_ENV_SIZE:
c609719b8   wdenk   Initial revision
3488

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

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

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

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

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

d4ca31c40   wdenk   * Cleanup lowboot...
3586
  	Define this if you have a DataFlash memory device which you
5779d8d98   wdenk   * Patch by Nicola...
3587
  	want to use for the environment.
0e8d15866   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ENV ma...
3588
3589
3590
  	- CONFIG_ENV_OFFSET:
  	- CONFIG_ENV_ADDR:
  	- CONFIG_ENV_SIZE:
5779d8d98   wdenk   * Patch by Nicola...
3591
3592
3593
3594
  
  	  These three #defines specify the offset and size of the
  	  environment area within the total memory of your DataFlash placed
  	  at the specified address.
0a85a9e70   Liu Gang   powerpc/corenet_d...
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
  - CONFIG_ENV_IS_IN_REMOTE:
  
  	Define this if you have a remote memory space which you
  	want to use for the local device's environment.
  
  	- CONFIG_ENV_ADDR:
  	- CONFIG_ENV_SIZE:
  
  	  These two #defines specify the address and size of the
  	  environment area within the remote memory space. The
  	  local device can get the environment from remote memory
fc54c7fa0   Liu Gang   powerpc/corenet_d...
3606
  	  space by SRIO or PCIE links.
0a85a9e70   Liu Gang   powerpc/corenet_d...
3607
3608
3609
  
  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...
3610
3611
  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...
3612

51bfee192   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ENV_IS...
3613
  - CONFIG_ENV_IS_IN_NAND:
13a5695b7   wdenk   Patch by Jian Zha...
3614
3615
3616
  
  	Define this if you have a NAND device which you want to use
  	for the environment.
0e8d15866   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ENV ma...
3617
3618
  	- CONFIG_ENV_OFFSET:
  	- CONFIG_ENV_SIZE:
13a5695b7   wdenk   Patch by Jian Zha...
3619
3620
  
  	  These two #defines specify the offset and size of the environment
fdd813def   Scott Wood   README: Add new N...
3621
3622
  	  area within the first NAND device.  CONFIG_ENV_OFFSET must be
  	  aligned to an erase block boundary.
5779d8d98   wdenk   * Patch by Nicola...
3623

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

0e8d15866   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ENV ma...
3626
  	  This setting describes a second storage area of CONFIG_ENV_SIZE
fdd813def   Scott Wood   README: Add new N...
3627
3628
  	  size used to hold a redundant copy of the environment data, so
  	  that there is a valid backup copy in case there is a power failure
c0f40859f   Wolfgang Denk   README: white-spa...
3629
  	  during a "saveenv" operation.	 CONFIG_ENV_OFFSET_RENDUND must be
fdd813def   Scott Wood   README: Add new N...
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
  	  aligned to an erase block boundary.
  
  	- CONFIG_ENV_RANGE (optional):
  
  	  Specifies the length of the region in which the environment
  	  can be written.  This should be a multiple of the NAND device's
  	  block size.  Specifying a range with more erase blocks than
  	  are needed to hold CONFIG_ENV_SIZE allows bad blocks within
  	  the range to be avoided.
  
  	- CONFIG_ENV_OFFSET_OOB (optional):
  
  	  Enables support for dynamically retrieving the offset of the
  	  environment from block zero's out-of-band data.  The
  	  "nand env.oob" command can be used to record this offset.
  	  Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
  	  using CONFIG_ENV_OFFSET_OOB.
e443c944c   Markus Klotzbuecher   Support for redun...
3647

b74ab7373   Guennadi Liakhovetski   nand_spl: read en...
3648
3649
3650
3651
3652
  - CONFIG_NAND_ENV_DST
  
  	Defines address in RAM to which the nand_spl code should copy the
  	environment. If redundant environment is used, it will be copied to
  	CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
2b74433f3   Joe Hershberger   env: Add support ...
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
  - CONFIG_ENV_IS_IN_UBI:
  
  	Define this if you have an UBI volume that you want to use for the
  	environment.  This has the benefit of wear-leveling the environment
  	accesses, which is important on NAND.
  
  	- CONFIG_ENV_UBI_PART:
  
  	  Define this to a string that is the mtd partition containing the UBI.
  
  	- CONFIG_ENV_UBI_VOLUME:
  
  	  Define this to the name of the volume that you want to store the
  	  environment in.
785881f77   Joe Hershberger   env: Add redundan...
3667
3668
3669
3670
3671
  	- CONFIG_ENV_UBI_VOLUME_REDUND:
  
  	  Define this to the name of another volume to store a second copy of
  	  the environment in.  This will enable redundant environments in UBI.
  	  It is assumed that both volumes are in the same MTD partition.
2b74433f3   Joe Hershberger   env: Add support ...
3672
3673
3674
3675
3676
  	- CONFIG_UBI_SILENCE_MSG
  	- CONFIG_UBIFS_SILENCE_MSG
  
  	  You will probably want to define these to avoid a really noisy system
  	  when storing the env in UBI.
06e4ae5f8   Stephen Warren   README: document ...
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
  - CONFIG_ENV_IS_IN_MMC:
  
  	Define this if you have an MMC device which you want to use for the
  	environment.
  
  	- CONFIG_SYS_MMC_ENV_DEV:
  
  	  Specifies which MMC device the environment is stored in.
  
  	- CONFIG_SYS_MMC_ENV_PART (optional):
  
  	  Specifies which MMC partition the environment is stored in. If not
  	  set, defaults to partition 0, the user area. Common values might be
  	  1 (first MMC boot partition), 2 (second MMC boot partition).
  
  	- CONFIG_ENV_OFFSET:
  	- CONFIG_ENV_SIZE:
  
  	  These two #defines specify the offset and size of the environment
  	  area within the specified MMC device.
5c088ee84   Stephen Warren   env_mmc: allow ne...
3697
3698
3699
3700
3701
3702
3703
  	  If offset is positive (the usual case), it is treated as relative to
  	  the start of the MMC partition. If offset is negative, it is treated
  	  as relative to the end of the MMC partition. This can be useful if
  	  your board may be fitted with different MMC devices, which have
  	  different sizes for the MMC partitions, and you always want the
  	  environment placed at the very end of the partition, to leave the
  	  maximum possible space before it, to store other data.
06e4ae5f8   Stephen Warren   README: document ...
3704
3705
3706
3707
3708
3709
3710
3711
3712
  	  These two values are in units of bytes, but must be aligned to an
  	  MMC sector boundary.
  
  	- CONFIG_ENV_OFFSET_REDUND (optional):
  
  	  Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
  	  hold a redundant copy of the environment data. This provides a
  	  valid backup copy in case the other copy is corrupted, e.g. due
  	  to a power failure during a "saveenv" operation.
5c088ee84   Stephen Warren   env_mmc: allow ne...
3713
3714
  	  This value may also be positive or negative; this is handled in the
  	  same way as CONFIG_ENV_OFFSET.
06e4ae5f8   Stephen Warren   README: document ...
3715
3716
3717
3718
3719
3720
3721
3722
  	  This value is also in units of bytes, but must also be aligned to
  	  an MMC sector boundary.
  
  	- CONFIG_ENV_SIZE_REDUND (optional):
  
  	  This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
  	  set. If this value is set, it must be set to the same value as
  	  CONFIG_ENV_SIZE.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3723
  - CONFIG_SYS_SPI_INIT_OFFSET
c609719b8   wdenk   Initial revision
3724
3725
3726
3727
3728
3729
3730
3731
  
  	Defines offset to the initial SPI buffer area in DPRAM. The
  	area is used at an early stage (ROM part) if the environment
  	is configured to reside in the SPI EEPROM: We need a 520 byte
  	scratch DPRAM area. It is used between the two initialization
  	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
  	to be a good choice since it makes it far enough from the
  	start of the data area as well as from the stack pointer.
e881cb563   Bruce Adler   fix wording in RE...
3732
  Please note that the environment is read-only until the monitor
c609719b8   wdenk   Initial revision
3733
  has been relocated to RAM and a RAM copy of the environment has been
cdb749778   Wolfgang Denk   Rename getenv_r()...
3734
  created; also, when using EEPROM you will have to use getenv_f()
c609719b8   wdenk   Initial revision
3735
  until then to read environment variables.
85ec0bcc1   wdenk   * Patch by Arun D...
3736
3737
3738
3739
3740
3741
  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
3742
3743
3744
  
  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...
3745
  use the "saveenv" command to store a valid environment.
c609719b8   wdenk   Initial revision
3746

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

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

f5675aa5c   Ron Madrid   Create configurat...
3755
3756
3757
3758
3759
3760
  - 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...
3761
3762
3763
3764
  - 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...
3765
3766
3767
3768
  - 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.
c609719b8   wdenk   Initial revision
3769
  Low Level (hardware related) configuration options:
dc7c9a1a5   wdenk   * Patch by Rick B...
3770
  ---------------------------------------------------
c609719b8   wdenk   Initial revision
3771

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3772
  - CONFIG_SYS_CACHELINE_SIZE:
c609719b8   wdenk   Initial revision
3773
  		Cache Line Size of the CPU.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3774
  - CONFIG_SYS_DEFAULT_IMMR:
c609719b8   wdenk   Initial revision
3775
  		Default address of the IMMR after system reset.
2535d6027   wdenk   * Patch by Martin...
3776

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

e46fedfeb   Timur Tabi   powerpc/85xx: int...
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
  - CONFIG_SYS_CCSRBAR_DEFAULT:
  		Default (power-on reset) physical address of CCSR on Freescale
  		PowerPC SOCs.
  
  - CONFIG_SYS_CCSRBAR:
  		Virtual address of CCSR.  On a 32-bit build, this is typically
  		the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
  
  		CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
  		for cross-platform code that uses that macro instead.
  
  - CONFIG_SYS_CCSRBAR_PHYS:
  		Physical address of CCSR.  CCSR can be relocated to a new
  		physical address, if desired.  In this case, this macro should
c0f40859f   Wolfgang Denk   README: white-spa...
3795
  		be set to that address.	 Otherwise, it should be set to the
e46fedfeb   Timur Tabi   powerpc/85xx: int...
3796
3797
3798
3799
3800
3801
3802
3803
  		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...
3804
3805
  		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...
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
  		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,...
3817
  - Floppy Disk Support:
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3818
  		CONFIG_SYS_FDC_DRIVE_NUMBER
7f6c2cbc2   wdenk   * Vince Husovsky,...
3819
3820
  
  		the default drive number (default value 0)
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3821
  		CONFIG_SYS_ISA_IO_STRIDE
7f6c2cbc2   wdenk   * Vince Husovsky,...
3822

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

43d9616cf   wdenk   * Patch by Robert...
3827
3828
  		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...
3829
  		the FDC chipset. (default value 0)
7f6c2cbc2   wdenk   * Vince Husovsky,...
3830

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3831
3832
  		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...
3833
  		default value.
7f6c2cbc2   wdenk   * Vince Husovsky,...
3834

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3835
  		if CONFIG_SYS_FDC_HW_INIT is defined, then the function
43d9616cf   wdenk   * Patch by Robert...
3836
3837
3838
3839
  		fdc_hw_init() is called at the beginning of the FDC
  		setup. fdc_hw_init() must be provided by the board
  		source code. It is used to make hardware dependant
  		initializations.
7f6c2cbc2   wdenk   * Vince Husovsky,...
3840

0abddf82d   Macpaul Lin   cmd_ide: enhance ...
3841
3842
3843
3844
3845
3846
3847
  - 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
  		is requierd.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3848
  - CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
efe2a4d5c   wdenk   Code cleanup.
3849
  		DO NOT CHANGE unless you know exactly what you're
25d6712a8   wdenk   * Clean up CMC PU...
3850
  		doing! (11-4) [MPC8xx/82xx systems only]
c609719b8   wdenk   Initial revision
3851

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

7152b1d0b   wdenk   * Add support for...
3854
  		Start address of memory area that can be used for
c609719b8   wdenk   Initial revision
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
  		initial data and stack; please note that this must be
  		writable memory that is working WITHOUT special
  		initialization, i. e. you CANNOT use normal RAM which
  		will become available only after programming the
  		memory controller and running certain initialization
  		sequences.
  
  		U-Boot uses the following memory types:
  		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
  		- MPC824X: data cache
  		- PPC4xx:  data cache
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3866
  - CONFIG_SYS_GBL_DATA_OFFSET:
c609719b8   wdenk   Initial revision
3867
3868
  
  		Offset of the initial data structure in the memory
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3869
3870
  		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
  		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
c609719b8   wdenk   Initial revision
3871
  		data is located at the end of the available space
553f09823   Wolfgang Denk   Rename CONFIG_SYS...
3872
  		(sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3873
3874
3875
  		CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
  		below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
  		CONFIG_SYS_GBL_DATA_OFFSET) downward.
c609719b8   wdenk   Initial revision
3876
3877
3878
3879
  
  	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...
3880
  		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
c609719b8   wdenk   Initial revision
3881
3882
  		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...
3883
  - CONFIG_SYS_SIUMCR:	SIU Module Configuration (11-6)
c609719b8   wdenk   Initial revision
3884

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

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

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

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

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

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3895
  - CONFIG_SYS_OR_TIMING_SDRAM:
c609719b8   wdenk   Initial revision
3896
  		SDRAM timing
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3897
  - CONFIG_SYS_MAMR_PTA:
c609719b8   wdenk   Initial revision
3898
  		periodic timer for refresh
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3899
  - CONFIG_SYS_DER:	Debug Event Register (37-47)
c609719b8   wdenk   Initial revision
3900

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3901
3902
3903
3904
  - 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
3905
3906
3907
  		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...
3908
3909
    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
3910
  		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3911
3912
  - CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
    CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
c609719b8   wdenk   Initial revision
3913
3914
  		Machine Mode Register and Memory Periodic Timer
  		Prescaler definitions (SDRAM timing)
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3915
  - CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
c609719b8   wdenk   Initial revision
3916
3917
  		enable I2C microcode relocation patch (MPC8xx);
  		define relocation offset in DPRAM [DSP2]
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3918
  - CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
b423d055c   Heiko Schocher   Enable SMC microc...
3919
3920
  		enable SMC microcode relocation patch (MPC8xx);
  		define relocation offset in DPRAM [SMC1]
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3921
  - CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
c609719b8   wdenk   Initial revision
3922
3923
  		enable SPI microcode relocation patch (MPC8xx);
  		define relocation offset in DPRAM [SCC4]
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3924
  - CONFIG_SYS_USE_OSCCLK:
c609719b8   wdenk   Initial revision
3925
3926
3927
  		Use OSCM clock mode on MBX8xx board. Be careful,
  		wrong setting might damage your board. Read
  		doc/README.MBX before setting this variable!
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3928
  - CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
43d9616cf   wdenk   * Patch by Robert...
3929
3930
3931
3932
  		Offset of the bootmode word in DPRAM used by post
  		(Power On Self Tests). This definition overrides
  		#define'd default value in commproc.h resp.
  		cpm_8260.h.
ea909b760   wdenk   * Added support f...
3933

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3934
3935
3936
3937
3938
3939
3940
3941
  - CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
    CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
    CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
    CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
    CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
    CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
    CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
    CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
a47a12bec   Stefan Roese   Move arch/ppc to ...
3942
  		Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
5d232d0e7   wdenk   * Patch by Dave E...
3943

9cacf4fc4   Dirk Eibach   ppc4xx: Add READM...
3944
3945
3946
  - CONFIG_PCI_DISABLE_PCIE:
  		Disable PCI-Express on systems where it is supported but not
  		required.
69fd2d3b0   Andrew Sharp   pci: add CONFIG_P...
3947
3948
3949
3950
3951
3952
  - CONFIG_PCI_ENUM_ONLY
  		Only scan through and get the devices on the busses.
  		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...
3953
3954
  - CONFIG_PCI_INDIRECT_BRIDGE:
  		Enable support for indirect PCI bridges.
a09b9b68d   Kumar Gala   powerpc/8xxx: Ref...
3955
3956
3957
3958
3959
3960
3961
3962
  - 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...
3963
3964
  - CONFIG_SRIO_PCIE_BOOT_MASTER
  		Board can support master function for Boot from SRIO and PCIE
a09b9b68d   Kumar Gala   powerpc/8xxx: Ref...
3965
3966
3967
3968
3969
3970
3971
3972
  - 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...
3973
3974
3975
3976
  - 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...
3977
  		Example of drivers that use it:
66bd1846e   Fabio Estevam   mtd: nand: Introd...
3978
  		- drivers/mtd/nand/ndfc.c
a430e9164   Fabio Estevam   mtd: nand: mxc_na...
3979
  		- drivers/mtd/nand/mxc_nand.c
eced4626e   Alex Waterman   NAND: Add 16bit N...
3980
3981
3982
3983
  
  - 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...
3984
  - CONFIG_SPD_EEPROM
218ca724c   Wolfgang Denk   README: update do...
3985
3986
  		Get DDR timing information from an I2C EEPROM. Common
  		with pluggable memory modules such as SODIMMs
bb99ad6d8   Ben Warren   Add support for m...
3987
3988
    SPD_EEPROM_ADDRESS
  		I2C address of the SPD EEPROM
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3989
  - CONFIG_SYS_SPD_BUS_NUM
218ca724c   Wolfgang Denk   README: update do...
3990
3991
3992
  		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...
3993

1b3e3c4f2   York Sun   powerpc/mpc8xxx: ...
3994
3995
3996
3997
3998
  - 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...
3999
4000
  - CONFIG_FSL_DDR_INTERACTIVE
  		Enable interactive DDR debugging. See doc/README.fsl-ddr.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
4001
  - CONFIG_SYS_83XX_DDR_USES_CS0
218ca724c   Wolfgang Denk   README: update do...
4002
4003
  		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...
4004

c26e454df   wdenk   Patches by Pantel...
4005
4006
4007
4008
4009
  - CONFIG_ETHER_ON_FEC[12]
  		Define to enable FEC[12] on a 8xx series processor.
  
  - CONFIG_FEC[12]_PHY
  		Define to the hardcoded PHY address which corresponds
6e5923851   wdenk   * Cleanup, minor ...
4010
4011
  		to the given FEC; i. e.
  			#define CONFIG_FEC1_PHY 4
c26e454df   wdenk   Patches by Pantel...
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
  		means that the PHY with address 4 is connected to FEC1
  
  		When set to -1, means to probe for first available.
  
  - CONFIG_FEC[12]_PHY_NORXERR
  		The PHY does not have a RXERR line (RMII only).
  		(so program the FEC to ignore it).
  
  - CONFIG_RMII
  		Enable RMII mode for all FECs.
  		Note that this is a global option, we can't
  		have one FEC in standard MII mode and another in RMII mode.
5cf91d6bd   wdenk   * Modify KUP4X bo...
4024
4025
4026
4027
4028
4029
4030
4031
4032
  - 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...
4033
4034
  - CONFIG_LOOPW
  		Add the "loopw" memory command. This only takes effect if
602ad3b33   Jon Loeliger   README: Rewrite c...
4035
  		the memory commands are activated globally (CONFIG_CMD_MEM).
56523f128   wdenk   * Patch by Martin...
4036

7b4666414   stroese   CONFIG_MX_CYCLIC ...
4037
4038
4039
4040
  - CONFIG_MX_CYCLIC
  		Add the "mdc" and "mwc" memory commands. These are cyclic
  		"md/mw" commands.
  		Examples:
efe2a4d5c   wdenk   Code cleanup.
4041
  		=> mdc.b 10 4 500
7b4666414   stroese   CONFIG_MX_CYCLIC ...
4042
  		This command will print 4 bytes (10,11,12,13) each 500 ms.
efe2a4d5c   wdenk   Code cleanup.
4043
  		=> mwc.l 100 12345678 10
7b4666414   stroese   CONFIG_MX_CYCLIC ...
4044
  		This command will write 12345678 to address 100 all 10 ms.
efe2a4d5c   wdenk   Code cleanup.
4045
  		This only takes effect if the memory commands are activated
602ad3b33   Jon Loeliger   README: Rewrite c...
4046
  		globally (CONFIG_CMD_MEM).
7b4666414   stroese   CONFIG_MX_CYCLIC ...
4047

8aa1a2d11   wdenk   Patch by Steven S...
4048
  - CONFIG_SKIP_LOWLEVEL_INIT
afc1ce828   Macpaul Lin   doc/README: docum...
4049
  		[ARM, NDS32, MIPS only] If this variable is defined, then certain
844f07d8a   Wolfgang Denk   Coding Style (whi...
4050
4051
4052
4053
4054
4055
4056
4057
  		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...
4058

401bb30b6   Aneesh V   replace CONFIG_PR...
4059
  - CONFIG_SPL_BUILD
df81238b3   Magnus Lilja   ARM1136: Introduc...
4060
4061
4062
  		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...
4063

3aa29de0b   Ying Zhang   TPL : introduce t...
4064
4065
4066
4067
  - 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: ...
4068
4069
4070
4071
  - 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...
4072
4073
4074
4075
4076
4077
4078
4079
  - 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().
d8834a132   Matthias Weisser   arm: Use optimize...
4080
4081
4082
4083
4084
  - CONFIG_USE_ARCH_MEMCPY
    CONFIG_USE_ARCH_MEMSET
  		If these options are used a optimized version of memcpy/memset will
  		be used if available. These functions may be faster under some
  		conditions but may increase the binary size.
588a13f74   Simon Glass   x86: Rename CONFI...
4085
4086
4087
  - 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...
4088

fc33705e6   Mark Jackson   Allow AM335x MPU ...
4089
4090
4091
4092
  - CONFIG_SYS_MPUCLK
  		Defines the MPU clock speed (in MHz).
  
  		NOTE : currently only supported on AM335x platforms.
5b5ece9ef   Gabe Black   x86: Allow compil...
4093

16678eb40   Heiko Schocher   arm, am33x: make ...
4094
4095
  - CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
  		Enables the RTC32K OSC on AM33xx based plattforms
f2717b47e   Timur Tabi   powerpc/85xx: cle...
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
  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.
  
  - CONFIG_SYS_QE_FMAN_FW_ADDR
  	The address in the storage device where the firmware is located.  The
  	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
  	is also specified.
  
  - CONFIG_SYS_QE_FMAN_FW_LENGTH
  	The maximum possible size of the firmware.  The firmware binary format
  	has a field that specifies the actual size of the firmware, but it
  	might not be possible to read any part of the firmware unless some
  	local storage is allocated to hold the entire firmware first.
  
  - CONFIG_SYS_QE_FMAN_FW_IN_NOR
  	Specifies that QE/FMAN firmware is located in NOR flash, mapped as
  	normal addressable memory via the LBC.  CONFIG_SYS_FMAN_FW_ADDR is the
  	virtual address in NOR flash.
  
  - CONFIG_SYS_QE_FMAN_FW_IN_NAND
  	Specifies that QE/FMAN firmware is located in NAND flash.
  	CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
  
  - CONFIG_SYS_QE_FMAN_FW_IN_MMC
  	Specifies that QE/FMAN firmware is located on the primary SD/MMC
  	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
  
  - CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
  	Specifies that QE/FMAN firmware is located on the primary SPI
  	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
292dc6c50   Liu Gang   powerpc/corenet_d...
4132
4133
4134
  - 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...
4135
4136
4137
  	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...
4138

c609719b8   wdenk   Initial revision
4139
4140
  Building the Software:
  ======================
218ca724c   Wolfgang Denk   README: update do...
4141
4142
4143
4144
4145
4146
  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
4147

218ca724c   Wolfgang Denk   README: update do...
4148
4149
4150
4151
4152
  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
4153

218ca724c   Wolfgang Denk   README: update do...
4154
4155
  	$ CROSS_COMPILE=ppc_4xx-
  	$ export CROSS_COMPILE
c609719b8   wdenk   Initial revision
4156

2f8d396b9   Peter Tyser   Add support for b...
4157
4158
4159
4160
4161
4162
4163
4164
4165
  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...
4166
4167
  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
4168
4169
4170
  is done by typing:
  
  	make NAME_config
218ca724c   Wolfgang Denk   README: update do...
4171
  where "NAME_config" is the name of one of the existing configu-
4d675ae6e   Michael Jones   README: supported...
4172
  rations; see boards.cfg for supported names.
db01a2ea9   wdenk   * Patch by Stephe...
4173

2729af9d5   wdenk   * Fix minor NAND ...
4174
4175
4176
4177
  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...
4178
        when choosing the configuration, i. e.
2729af9d5   wdenk   * Fix minor NAND ...
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
  
        make TQM823L_config
  	- will configure for a plain TQM823L, i. e. no LCD support
  
        make TQM823L_LCD_config
  	- 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...
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
  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
  	make O=/tmp/build NAME_config
  	make O=/tmp/build all
  
  2. Set environment variable BUILD_DIR to point to the desired location:
  
  	export BUILD_DIR=/tmp/build
  	make distclean
  	make NAME_config
  	make all
  
  Note that the command line "O=" setting overrides the BUILD_DIR environment
  variable.
2729af9d5   wdenk   * Fix minor NAND ...
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
  
  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:
  
  1.  Add a new configuration option for your board to the toplevel
4d675ae6e   Michael Jones   README: supported...
4225
4226
      "boards.cfg" file, using the existing entries as examples.
      Follow the instructions there to keep the boards in order.
2729af9d5   wdenk   * Fix minor NAND ...
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
  2.  Create a new directory to hold your board specific code. Add any
      files you need. In your board directory, you will need at least
      the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
  3.  Create a new configuration file "include/configs/<board>.h" for
      your board
  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.
  4.  Run "make <board>_config" with your new name.
  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...
4243
4244
  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 ...
4245
4246
  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...
4247
  official or latest in the git repository) version of U-Boot sources.
2729af9d5   wdenk   * Fix minor NAND ...
4248

218ca724c   Wolfgang Denk   README: update do...
4249
4250
  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 ...
4251
4252
  the supported boards compile WITHOUT ANY compiler warnings. To do so,
  just run the "MAKEALL" script, which will configure and build U-Boot
218ca724c   Wolfgang Denk   README: update do...
4253
4254
4255
4256
  for ALL supported system. Be warned, this will take a while. You can
  select which (cross) compiler to use by passing a `CROSS_COMPILE'
  environment variable to the script, i. e. to use the ELDK cross tools
  you can type
2729af9d5   wdenk   * Fix minor NAND ...
4257
4258
4259
4260
4261
4262
  
  	CROSS_COMPILE=ppc_8xx- MAKEALL
  
  or to build on a native PowerPC system you can type
  
  	CROSS_COMPILE=' ' MAKEALL
218ca724c   Wolfgang Denk   README: update do...
4263
4264
4265
4266
4267
4268
4269
  When using the MAKEALL script, the default behaviour is to build
  U-Boot in the source directory. This location can be changed by
  setting the BUILD_DIR environment variable. Also, for each target
  built, the MAKEALL script saves two log files (<target>.ERR and
  <target>.MAKEALL) in the <source dir>/LOG directory. This default
  location can be changed by setting the MAKEALL_LOGDIR environment
  variable. For example:
baf312495   Marian Balakowicz   Add documentation...
4270
4271
4272
4273
  
  	export BUILD_DIR=/tmp/build
  	export MAKEALL_LOGDIR=/tmp/log
  	CROSS_COMPILE=ppc_8xx- MAKEALL
218ca724c   Wolfgang Denk   README: update do...
4274
4275
4276
  With the above settings build objects are saved in the /tmp/build,
  log files are saved in the /tmp/log and the source tree remains clean
  during the whole build process.
baf312495   Marian Balakowicz   Add documentation...
4277

2729af9d5   wdenk   * Fix minor NAND ...
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
  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"...
4288
  bootz   - boot zImage from memory
2729af9d5   wdenk   * Fix minor NAND ...
4289
4290
4291
  tftpboot- boot image via network using TFTP protocol
  	       and env variables "ipaddr" and "serverip"
  	       (and eventually "gatewayip")
1fb7cd498   Simon Glass   net: tftpput: imp...
4292
  tftpput - upload a file via network using TFTP protocol
2729af9d5   wdenk   * Fix minor NAND ...
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
  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...
4304
  i2c	- I2C sub-system
2729af9d5   wdenk   * Fix minor NAND ...
4305
4306
4307
4308
4309
4310
4311
4312
  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...
4313
  nand	- NAND memory operations (see doc/README.nand)
2729af9d5   wdenk   * Fix minor NAND ...
4314
4315
4316
4317
4318
  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...
4319
  loopw	- infinite write loop on address range
2729af9d5   wdenk   * Fix minor NAND ...
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
  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
4343

2729af9d5   wdenk   * Fix minor NAND ...
4344
4345
4346
4347
4348
4349
  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
4350

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

2729af9d5   wdenk   * Fix minor NAND ...
4355
    baudrate	- see CONFIG_BAUDRATE
c609719b8   wdenk   Initial revision
4356

2729af9d5   wdenk   * Fix minor NAND ...
4357
    bootdelay	- see CONFIG_BOOTDELAY
c609719b8   wdenk   Initial revision
4358

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

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

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

7d721e34a   Bartlomiej Sieka   Boot-related docu...
4365
4366
4367
4368
4369
4370
    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_...
4371
4372
  		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
  		  bootm_mapsize.
c0f40859f   Wolfgang Denk   README: white-spa...
4373
    bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
c3624e6ed   Grant Likely   Default to bootm_...
4374
4375
4376
4377
4378
4379
  		  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...
4380
4381
4382
4383
4384
4385
  
    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...
4386
4387
4388
    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 ...
4389
4390
4391
4392
    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
4393

2729af9d5   wdenk   * Fix minor NAND ...
4394
4395
4396
4397
    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...
4398

2729af9d5   wdenk   * Fix minor NAND ...
4399
4400
4401
4402
4403
  		  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
4404

a28afca57   David A. Long   Add uboot "fdt_hi...
4405
4406
    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...
4407
4408
4409
4410
4411
4412
4413
  		  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...
4414
4415
4416
4417
4418
4419
  		  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...
4420
4421
4422
    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 ...
4423
4424
4425
4426
4427
    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 ...
4428
4429
4430
4431
4432
4433
    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...
4434
  		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
2729af9d5   wdenk   * Fix minor NAND ...
4435
4436
4437
4438
  		  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
4439

2729af9d5   wdenk   * Fix minor NAND ...
4440
4441
4442
4443
4444
4445
  		  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
4446

2729af9d5   wdenk   * Fix minor NAND ...
4447
  		  setenv initrd_high 00c00000
c609719b8   wdenk   Initial revision
4448

2729af9d5   wdenk   * Fix minor NAND ...
4449
4450
4451
4452
4453
4454
4455
  		  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
4456

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

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

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

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

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

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

2729af9d5   wdenk   * Fix minor NAND ...
4470
    bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
c609719b8   wdenk   Initial revision
4471

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

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

48690d802   Heiko Schocher   net ppc: fix ethe...
4477
4478
4479
4480
  		  => 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
4481

e16925773   Matthias Fuchs   net: add 'ethrota...
4482
4483
4484
    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...
4485
    netretry	- When set to "no" each network operation will
2729af9d5   wdenk   * Fix minor NAND ...
4486
4487
4488
4489
4490
4491
  		  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
4492

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

8d51aacd8   Simon Glass   RFC: bootm: Add s...
4495
4496
4497
4498
4499
    silent_linux  - If set then linux will be told to boot silently, by
  		  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.
28cb93758   Wolfgang Denk   Update for TFTP u...
4500
    tftpsrcport	- If this is set, the value is used for TFTP's
ecb0ccd9c   Wolfgang Denk   Allow to force TF...
4501
  		  UDP source port.
28cb93758   Wolfgang Denk   Update for TFTP u...
4502
4503
    tftpdstport	- If this is set, the value is used for TFTP's UDP
  		  destination port instead of the Well Know Port 69.
c96f86eef   Wolfgang Denk   TFTP: allow for a...
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
    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.
  
    vlan		- When set to a value < 4095 the traffic over
11ccc33fa   Marcel Ziswiler   Many spelling fix...
4516
  		  Ethernet is encapsulated/received over 802.1q
2729af9d5   wdenk   * Fix minor NAND ...
4517
  		  VLAN tagged frames.
c609719b8   wdenk   Initial revision
4518

dc0b7b0e6   Jason Hobbs   README: document ...
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
  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
  boards currenlty use other variables for these purposes, and some
  boards use these variables for other purposes.
c0f40859f   Wolfgang Denk   README: white-spa...
4530
4531
4532
4533
4534
4535
  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 ...
4536

2729af9d5   wdenk   * Fix minor NAND ...
4537
4538
4539
  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
4540

2729af9d5   wdenk   * Fix minor NAND ...
4541
4542
4543
4544
4545
4546
4547
4548
4549
    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...
4550

c1551ea81   stroese   U-Boot version en...
4551

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

2729af9d5   wdenk   * Fix minor NAND ...
4554
4555
4556
    serial#	- contains hardware identification information such
  		  as type string and/or serial number
    ethaddr	- Ethernet address
c609719b8   wdenk   Initial revision
4557

2729af9d5   wdenk   * Fix minor NAND ...
4558
4559
4560
  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
4561

f07771cc2   wdenk   * Fix data abort ...
4562

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

2729af9d5   wdenk   * Fix minor NAND ...
4565
4566
4567
    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 ...
4568

f07771cc2   wdenk   * Fix data abort ...
4569

2729af9d5   wdenk   * Fix minor NAND ...
4570
4571
  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 ...
4572

f07771cc2   wdenk   * Fix data abort ...
4573

170ab1107   Joe Hershberger   env: Add support ...
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
  Callback functions for environment variables:
  ---------------------------------------------
  
  For some environment variables, the behavior of u-boot needs to change
  when their values are changed.  This functionailty allows functions to
  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
  ".callbacks" envirnoment variable in the default or embedded environment.
2729af9d5   wdenk   * Fix minor NAND ...
4602
4603
  Command Line Parsing:
  =====================
f07771cc2   wdenk   * Fix data abort ...
4604

2729af9d5   wdenk   * Fix minor NAND ...
4605
4606
  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
4607

2729af9d5   wdenk   * Fix minor NAND ...
4608
4609
  Old, simple command line parser:
  --------------------------------
c609719b8   wdenk   Initial revision
4610

2729af9d5   wdenk   * Fix minor NAND ...
4611
4612
  - supports environment variables (through setenv / saveenv commands)
  - several commands on one line, separated by ';'
fe126d8b3   Wolfgang Denk   Change all '$(......
4613
  - variable substitution using "... ${name} ..." syntax
2729af9d5   wdenk   * Fix minor NAND ...
4614
4615
  - special characters ('$', ';') can be escaped by prefixing with '\',
    for example:
fe126d8b3   Wolfgang Denk   Change all '$(......
4616
  	setenv bootcmd bootm \${address}
2729af9d5   wdenk   * Fix minor NAND ...
4617
4618
  - 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
4619

2729af9d5   wdenk   * Fix minor NAND ...
4620
4621
  Hush shell:
  -----------
c609719b8   wdenk   Initial revision
4622

2729af9d5   wdenk   * Fix minor NAND ...
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
  - 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
4633

2729af9d5   wdenk   * Fix minor NAND ...
4634
4635
4636
4637
  (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
4638

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

2729af9d5   wdenk   * Fix minor NAND ...
4644
4645
  Note for Redundant Ethernet Interfaces:
  =======================================
c609719b8   wdenk   Initial revision
4646

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

2729af9d5   wdenk   * Fix minor NAND ...
4651
4652
4653
  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
4654

2729af9d5   wdenk   * Fix minor NAND ...
4655
4656
4657
4658
  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
4659

2729af9d5   wdenk   * Fix minor NAND ...
4660
4661
  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
4662

2729af9d5   wdenk   * Fix minor NAND ...
4663
4664
4665
  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
4666

2729af9d5   wdenk   * Fix minor NAND ...
4667
4668
  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
4669

2729af9d5   wdenk   * Fix minor NAND ...
4670
4671
4672
  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
4673

2729af9d5   wdenk   * Fix minor NAND ...
4674
4675
  o If neither SROM nor the environment contain a MAC address, an error
    is raised.
c609719b8   wdenk   Initial revision
4676

ecee9324d   Ben Warren   Program net devic...
4677
  If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
c0f40859f   Wolfgang Denk   README: white-spa...
4678
  will be programmed into hardware as part of the initialization process.	 This
ecee9324d   Ben Warren   Program net devic...
4679
4680
4681
  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
4682

2729af9d5   wdenk   * Fix minor NAND ...
4683
4684
  Image Formats:
  ==============
c609719b8   wdenk   Initial revision
4685

3310c549a   Marian Balakowicz   [new uImage] Add ...
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
  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
4704

2729af9d5   wdenk   * Fix minor NAND ...
4705
4706
  * 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...
4707
4708
4709
    LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
    Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
    INTEGRITY).
7b64fef33   Wolfgang Denk   Add AVR32 archite...
4710
  * Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
afc1ce828   Macpaul Lin   doc/README: docum...
4711
4712
    IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
    Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
2729af9d5   wdenk   * Fix minor NAND ...
4713
4714
4715
4716
4717
  * Compression Type (uncompressed, gzip, bzip2)
  * Load Address
  * Entry Point
  * Image Name
  * Image Timestamp
c609719b8   wdenk   Initial revision
4718

2729af9d5   wdenk   * Fix minor NAND ...
4719
4720
4721
  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
4722

2729af9d5   wdenk   * Fix minor NAND ...
4723
4724
  Linux Support:
  ==============
c609719b8   wdenk   Initial revision
4725

2729af9d5   wdenk   * Fix minor NAND ...
4726
4727
4728
  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
4729

2729af9d5   wdenk   * Fix minor NAND ...
4730
4731
4732
4733
4734
  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
4735

2729af9d5   wdenk   * Fix minor NAND ...
4736
4737
4738
  - 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
4739

2729af9d5   wdenk   * Fix minor NAND ...
4740
4741
  - 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
4742

2729af9d5   wdenk   * Fix minor NAND ...
4743
4744
4745
4746
4747
4748
  - 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
4749

c609719b8   wdenk   Initial revision
4750

2729af9d5   wdenk   * Fix minor NAND ...
4751
4752
  Linux HOWTO:
  ============
c609719b8   wdenk   Initial revision
4753

2729af9d5   wdenk   * Fix minor NAND ...
4754
4755
  Porting Linux to U-Boot based systems:
  ---------------------------------------
c609719b8   wdenk   Initial revision
4756

2729af9d5   wdenk   * Fix minor NAND ...
4757
4758
4759
4760
  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
4761

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

2729af9d5   wdenk   * Fix minor NAND ...
4764
4765
  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...
4766
4767
  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...
4768
  as your U-Boot configuration in CONFIG_SYS_IMMR.
24ee89b97   wdenk   * Fix mdelay() on...
4769

c609719b8   wdenk   Initial revision
4770

2729af9d5   wdenk   * Fix minor NAND ...
4771
4772
  Configuring the Linux kernel:
  -----------------------------
c609719b8   wdenk   Initial revision
4773

2729af9d5   wdenk   * Fix minor NAND ...
4774
4775
4776
4777
4778
4779
  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
4780

2729af9d5   wdenk   * Fix minor NAND ...
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
  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:
  
  	make TQM850L_config
  	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
4816

c609719b8   wdenk   Initial revision
4817

2729af9d5   wdenk   * Fix minor NAND ...
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
  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
4831

2729af9d5   wdenk   * Fix minor NAND ...
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
  	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...
4848
4849
4850
  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 ...
4851
4852
4853
4854
4855
4856
4857
4858
  
  - 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 ...
4859
  	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
2729af9d5   wdenk   * Fix minor NAND ...
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
  	> 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 ...
4882
  	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
2729af9d5   wdenk   * Fix minor NAND ...
4883
4884
  	-> 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 ...
4885
  	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
2729af9d5   wdenk   * Fix minor NAND ...
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
  	> 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 ...
4907
4908
4909
4910
4911
4912
4913
4914
  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:
  
  	tools/dumpimage -i image -p position data_file
  	  -i ==> extract from the 'image' a specific 'data_file', \
  	   indexed by 'position'
2729af9d5   wdenk   * Fix minor NAND ...
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
  
  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...
4950
  this includes a checksum verification so you can be sure no data
2729af9d5   wdenk   * Fix minor NAND ...
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
  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...
4997
  If you want to boot a Linux kernel with initial RAM disk, you pass
2729af9d5   wdenk   * Fix minor NAND ...
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
  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...
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
  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...
5081
5082
5083
     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...
5084
     Load Address: 00000000
a9398e018   Wolfgang Denk   Minor code cleanu...
5085
     Entry Point:	 00000000
0267768ed   Matthew McClintock   * Modify bootm co...
5086
5087
5088
5089
5090
5091
     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 ...
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
  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"...
5131
5132
5133
5134
5135
5136
  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...
5137
  Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
017e1f3f9   Marek Vasut   BOOT: Add RAW ram...
5138
5139
5140
  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 ...
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
  
  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...
5238
5239
5240
  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 ...
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
  
  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...
5276
  meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
2729af9d5   wdenk   * Fix minor NAND ...
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
  
  
  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...
5301
  	Chris Hallinan posted a good summary of these issues to the
0668236ba   Wolfgang Denk   README: update ma...
5302
  	U-Boot mailing list:
2729af9d5   wdenk   * Fix minor NAND ...
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
  
  	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...
5314
  	beyond the scope of this list to explain the details, but you
2729af9d5   wdenk   * Fix minor NAND ...
5315
5316
5317
5318
5319
  	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...
5320
  	initial stack/RAM area prior to SDRAM being available. Either
2729af9d5   wdenk   * Fix minor NAND ...
5321
5322
5323
5324
  	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...
5325
  	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
2729af9d5   wdenk   * Fix minor NAND ...
5326
5327
  	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...
5328
  	walnut.h should work for you. I'd set it to a value larger
2729af9d5   wdenk   * Fix minor NAND ...
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
  	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.
11ccc33fa   Marcel Ziswiler   Many spelling fix...
5343
  * Do not use any uninitialized global data (or implicitely initialized
2729af9d5   wdenk   * Fix minor NAND ...
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
    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
  normal global data to share information beween the code. But it
  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...
5366
  	R2:	reserved for system use
2729af9d5   wdenk   * Fix minor NAND ...
5367
5368
5369
5370
5371
  	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...
5372
5373
5374
  	(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 ...
5375

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

2729af9d5   wdenk   * Fix minor NAND ...
5388
5389
5390
5391
  On ARM, the following registers are used:
  
  	R0:	function argument word/integer result
  	R1-R3:	function argument word
12eba1b49   Jeroen Hofstee   README: update AR...
5392
5393
  	R9:	platform specific
  	R10:	stack limit (used only if stack checking is enabled)
2729af9d5   wdenk   * Fix minor NAND ...
5394
5395
5396
5397
5398
  	R11:	argument (frame) pointer
  	R12:	temporary workspace
  	R13:	stack pointer
  	R14:	link register
  	R15:	program counter
12eba1b49   Jeroen Hofstee   README: update AR...
5399
5400
5401
      ==> 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 ...
5402

0df01fd3d   Thomas Chou   nios2: fix r15 is...
5403
5404
5405
5406
5407
5408
5409
  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...
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
  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...
5423
5424
  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 ...
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
  
  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...
5441
  memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
2729af9d5   wdenk   * Fix minor NAND ...
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
  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
5473

2729af9d5   wdenk   * Fix minor NAND ...
5474
  In the reset configuration, U-Boot starts at the reset entry point
11ccc33fa   Marcel Ziswiler   Many spelling fix...
5475
  (on most PowerPC systems at address 0x00000100). Because of the reset
2729af9d5   wdenk   * Fix minor NAND ...
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
  configuration for CS0# this is a mirror of the onboard Flash memory.
  To be able to re-map memory U-Boot then jumps to its link address.
  To be able to implement the initialization code in C, a (small!)
  initial stack is set up in the internal Dual Ported RAM (in case CPUs
  which provide such a feature like MPC8xx or MPC8260), or in a locked
  part of the data cache. After that, U-Boot initializes the CPU core,
  the caches and the SIU.
  
  Next, all (potentially) available memory banks are mapped using a
  preliminary mapping. For example, we put them on 512 MB boundaries
  (multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
  on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
  programmed for SDRAM access. Using the temporary configuration, a
  simple memory test is run that determines the size of the SDRAM
  banks.
  
  When there is more than one SDRAM bank, and the banks are of
  different size, the largest is mapped first. For equal size, the first
  bank (CS2#) is mapped first. The first mapping is always for address
  0x00000000, with any additional banks following immediately to create
  contiguous memory starting from 0.
  
  Then, the monitor installs itself at the upper end of the SDRAM area
  and allocates memory for use by malloc() and for the global Board
  Info data; also, the exception vector code is copied to the low RAM
  pages, and the final stack is set up.
  
  Only after this relocation will you have a "normal" C environment;
  until that you are restricted in several ways, mostly because you are
  running from ROM, and because the code will have to be relocated to a
  new address in RAM.
  
  
  U-Boot Porting Guide:
  ----------------------
c609719b8   wdenk   Initial revision
5511

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

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

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

2729af9d5   wdenk   * Fix minor NAND ...
5522
  	if (available_money > available_manpower) {
6c3fef28b   Jerry Van Baren   Improve U-Boot Po...
5523
  		Pay consultant to port U-Boot;
c609719b8   wdenk   Initial revision
5524
5525
  		return 0;
  	}
2729af9d5   wdenk   * Fix minor NAND ...
5526
  	Download latest U-Boot source;
0668236ba   Wolfgang Denk   README: update ma...
5527
  	Subscribe to u-boot mailing list;
2729af9d5   wdenk   * Fix minor NAND ...
5528

6c3fef28b   Jerry Van Baren   Improve U-Boot Po...
5529
5530
  	if (clueless)
  		email("Hi, I am new to U-Boot, how do I get started?");
2729af9d5   wdenk   * Fix minor NAND ...
5531
5532
5533
  
  	while (learning) {
  		Read the README file in the top level directory;
6c3fef28b   Jerry Van Baren   Improve U-Boot Po...
5534
5535
  		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
  		Read applicable doc/*.README;
2729af9d5   wdenk   * Fix minor NAND ...
5536
  		Read the source, Luke;
6c3fef28b   Jerry Van Baren   Improve U-Boot Po...
5537
  		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
2729af9d5   wdenk   * Fix minor NAND ...
5538
  	}
6c3fef28b   Jerry Van Baren   Improve U-Boot Po...
5539
5540
5541
  	if (available_money > toLocalCurrency ($2500))
  		Buy a BDI3000;
  	else
2729af9d5   wdenk   * Fix minor NAND ...
5542
  		Add a lot of aggravation and time;
2729af9d5   wdenk   * Fix minor NAND ...
5543

6c3fef28b   Jerry Van Baren   Improve U-Boot Po...
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
  	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 ...
5568
  	}
2729af9d5   wdenk   * Fix minor NAND ...
5569
5570
5571
5572
5573
5574
5575
5576
  
  	return 0;
  }
  
  void no_more_time (int sig)
  {
        hire_a_guru();
  }
c609719b8   wdenk   Initial revision
5577

2729af9d5   wdenk   * Fix minor NAND ...
5578
5579
  Coding Standards:
  -----------------
c609719b8   wdenk   Initial revision
5580

2729af9d5   wdenk   * Fix minor NAND ...
5581
  All contributions to U-Boot should conform to the Linux kernel
2c0516517   Detlev Zundel   Added changelog e...
5582
  coding style; see the file "Documentation/CodingStyle" and the script
7ca9296e1   Wolfgang Denk   README: udate Cod...
5583
  "scripts/Lindent" in your Linux kernel source directory.
2c0516517   Detlev Zundel   Added changelog e...
5584
5585
5586
5587
5588
5589
5590
5591
5592
  
  Source files originating from a different project (for example the
  MTD subsystem) are generally exempt from these guidelines and are not
  reformated to ease subsequent migration to newer versions of those
  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
5593

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

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

2729af9d5   wdenk   * Fix minor NAND ...
5605
5606
  Submitting Patches:
  -------------------
c609719b8   wdenk   Initial revision
5607

2729af9d5   wdenk   * Fix minor NAND ...
5608
5609
5610
  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
5611

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

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

2729af9d5   wdenk   * Fix minor NAND ...
5619
5620
5621
  * 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
5622

2729af9d5   wdenk   * Fix minor NAND ...
5623
5624
  * For new features: a description of the feature and your
    implementation.
c609719b8   wdenk   Initial revision
5625

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

2729af9d5   wdenk   * Fix minor NAND ...
5628
  * For major contributions, your entry to the CREDITS file
c609719b8   wdenk   Initial revision
5629

27af930e9   Albert ARIBAUD   Merge and reforma...
5630
5631
  * 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
5632

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

218ca724c   Wolfgang Denk   README: update do...
5636
5637
  * 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...
5638
    "git format-patch". If you then use "git send-email" to send it to
218ca724c   Wolfgang Denk   README: update do...
5639
5640
5641
5642
5643
5644
    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
5645

218ca724c   Wolfgang Denk   README: update do...
5646
5647
5648
5649
    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...
5650

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

2729af9d5   wdenk   * Fix minor NAND ...
5654
5655
  * 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...
5656

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

52f52c149   wdenk   Patches by Robert...
5660

2729af9d5   wdenk   * Fix minor NAND ...
5661
  Notes:
c609719b8   wdenk   Initial revision
5662

2729af9d5   wdenk   * Fix minor NAND ...
5663
5664
5665
  * Before sending the patch, run the MAKEALL script on your patched
    source tree and make sure that no errors or warnings are reported
    for any of the boards.
c609719b8   wdenk   Initial revision
5666

2729af9d5   wdenk   * Fix minor NAND ...
5667
5668
5669
  * 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
5670

2729af9d5   wdenk   * Fix minor NAND ...
5671
5672
5673
5674
5675
5676
  * 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...
5677

0668236ba   Wolfgang Denk   README: update ma...
5678
5679
5680
5681
  * 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.