Blame view

README 232 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
  /arch			Architecture specific files
6eae68e45   Masahiro Yamada   cosmetic: README:...
123
124
125
126
    /arc			Files generic to ARC architecture
      /cpu		CPU specific files
        /arc700		Files specific to ARC 700 CPUs
      /lib		Architecture specific library files
8d321b81c   Peter Tyser   Update README to ...
127
128
129
130
    /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...
131
  	/at91		Files specific to Atmel AT91RM9200 CPU
a9046b9e1   Wolfgang Denk   Prepare v2010-rc2
132
133
  	/imx		Files specific to Freescale MC9328 i.MX CPUs
  	/s3c24x0	Files specific to Samsung S3C24X0 CPUs
8d321b81c   Peter Tyser   Update README to ...
134
135
        /arm926ejs	Files specific to ARM 926 CPUs
        /arm1136		Files specific to ARM 1136 CPUs
8d321b81c   Peter Tyser   Update README to ...
136
        /pxa		Files specific to Intel XScale PXA CPUs
8d321b81c   Peter Tyser   Update README to ...
137
138
139
140
141
142
143
144
        /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 ...
145
146
147
148
149
150
151
152
153
154
155
156
157
    /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...
158
        /mips32		Files specific to MIPS32 CPUs
6eae68e45   Masahiro Yamada   cosmetic: README:...
159
        /mips64		Files specific to MIPS64 CPUs
8d321b81c   Peter Tyser   Update README to ...
160
      /lib		Architecture specific library files
afc1ce828   Macpaul Lin   doc/README: docum...
161
162
163
164
    /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 ...
165
166
167
    /nios2		Files generic to Altera NIOS2 architecture
      /cpu		CPU specific files
      /lib		Architecture specific library files
33c7731bd   Robert P. J. Day   Cosmetic: Update ...
168
169
170
    /openrisc		Files generic to OpenRISC architecture
      /cpu		CPU specific files
      /lib		Architecture specific library files
a47a12bec   Stefan Roese   Move arch/ppc to ...
171
    /powerpc		Files generic to PowerPC architecture
8d321b81c   Peter Tyser   Update README to ...
172
      /cpu		CPU specific files
8d321b81c   Peter Tyser   Update README to ...
173
174
175
        /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 ...
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
        /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 ...
191
192
193
    /x86			Files generic to x86 architecture
      /cpu		CPU specific files
      /lib		Architecture specific library files
8d321b81c   Peter Tyser   Update README to ...
194
195
196
197
198
199
  /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 ...
200
  /dts			Contains Makefile for building internal U-Boot fdt.
8d321b81c   Peter Tyser   Update README to ...
201
202
203
204
205
206
207
208
209
  /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 ...
210
  /spl			Secondary Program Loader framework
8d321b81c   Peter Tyser   Update README to ...
211
  /tools			Tools to build S-Record or U-Boot images, etc.
c609719b8   wdenk   Initial revision
212

c609719b8   wdenk   Initial revision
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
  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...
228
    "CONFIG_SYS_".
c609719b8   wdenk   Initial revision
229
230
231
232
233
234
235
236
237
238
239
240
  
  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
ab584d67c   Holger Freyther   The _config targe...
241
  configurations available; just type "make <board_name>_defconfig".
c609719b8   wdenk   Initial revision
242
243
244
245
  
  Example: For a TQM823L module type:
  
  	cd u-boot
ab584d67c   Holger Freyther   The _config targe...
246
  	make TQM823L_defconfig
c609719b8   wdenk   Initial revision
247

11ccc33fa   Marcel Ziswiler   Many spelling fix...
248
  For the Cogent platform, you need to specify the CPU type as well;
ab584d67c   Holger Freyther   The _config targe...
249
  e.g. "make cogent_mpc8xx_defconfig". And also configure the cogent
c609719b8   wdenk   Initial revision
250
  directory according to the instructions in cogent/README.
75b3c3aa8   Simon Glass   sandbox: Update a...
251
252
253
254
255
256
257
  Sandbox Environment:
  --------------------
  
  U-Boot can be built natively to run on a Linux host using the 'sandbox'
  board. This allows feature development which is not board- or architecture-
  specific to be undertaken on a native platform. The sandbox is also used to
  run some of U-Boot's tests.
6b1978f8a   Jagannadha Sutradharudu Teki   sandbox: Update m...
258
  See board/sandbox/README.sandbox for more details.
75b3c3aa8   Simon Glass   sandbox: Update a...
259

db910353a   Simon Glass   arm: spl: Allow b...
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
  Board Initialisation Flow:
  --------------------------
  
  This is the intended start-up flow for boards. This should apply for both
  SPL and U-Boot proper (i.e. they both follow the same rules). At present SPL
  mostly uses a separate code path, but the funtion names and roles of each
  function are the same. Some boards or architectures may not conform to this.
  At least most ARM boards which use CONFIG_SPL_FRAMEWORK conform to this.
  
  Execution starts with start.S with three functions called during init after
  that. The purpose and limitations of each is described below.
  
  lowlevel_init():
  	- purpose: essential init to permit execution to reach board_init_f()
  	- no global_data or BSS
  	- there is no stack (ARMv7 may have one but it will soon be removed)
  	- must not set up SDRAM or use console
  	- must only do the bare minimum to allow execution to continue to
  		board_init_f()
  	- this is almost never needed
  	- return normally from this function
  
  board_init_f():
  	- purpose: set up the machine ready for running board_init_r():
  		i.e. SDRAM and serial UART
  	- global_data is available
  	- stack is in SRAM
  	- BSS is not available, so you cannot use global/static variables,
  		only stack variables and global_data
  
  	Non-SPL-specific notes:
  	- dram_init() is called to set up DRAM. If already done in SPL this
  		can do nothing
  
  	SPL-specific notes:
  	- you can override the entire board_init_f() function with your own
  		version as needed.
  	- preloader_console_init() can be called here in extremis
  	- should set up SDRAM, and anything needed to make the UART work
  	- these is no need to clear BSS, it will be done by crt0.S
  	- must return normally from this function (don't call board_init_r()
  		directly)
  
  Here the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at
  this point the stack and global_data are relocated to below
  CONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of
  memory.
  
  board_init_r():
  	- purpose: main execution, common code
  	- global_data is available
  	- SDRAM is available
  	- BSS is available, all static/global variables can be used
  	- execution eventually continues to main_loop()
  
  	Non-SPL-specific notes:
  	- U-Boot is relocated to the top of memory and is now running from
  		there.
  
  	SPL-specific notes:
  	- stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and
  		CONFIG_SPL_STACK_R_ADDR points into SDRAM
  	- preloader_console_init() can be called here - typically this is
  		done by defining CONFIG_SPL_BOARD_INIT and then supplying a
  		spl_board_init() function containing this call
  	- loads U-Boot or (in falcon mode) Linux
c609719b8   wdenk   Initial revision
326
327
328
329
330
331
332
333
334
  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,...
335
336
337
  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
338
  The following options need to be configured:
2628114ec   Kim Phillips   README: Remove ou...
339
340
341
  - CPU Type:	Define exactly one, e.g. CONFIG_MPC85XX.
  
  - Board Type:	Define exactly one, e.g. CONFIG_MPC8540ADS.
6ccec4492   Wolfgang Denk   Add ATSTK1000 and...
342
343
  
  - CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
09ea0de03   Haavard Skinnemoen   README: Remove AT...
344
  		Define exactly one, e.g. CONFIG_ATSTK1002
c609719b8   wdenk   Initial revision
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
  
  - CPU Module Type: (if CONFIG_COGENT is defined)
  		Define exactly one of
  		CONFIG_CMA286_60_OLD
  --- FIXME --- not tested yet:
  		CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
  		CONFIG_CMA287_23, CONFIG_CMA287_50
  
  - Motherboard Type: (if CONFIG_COGENT is defined)
  		Define exactly one of
  		CONFIG_CMA101, CONFIG_CMA102
  
  - Motherboard I/O Modules: (if CONFIG_COGENT is defined)
  		Define one or more of
  		CONFIG_CMA302
  
  - Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
  		Define one or more of
  		CONFIG_LCD_HEARTBEAT	- update a character position on
11ccc33fa   Marcel Ziswiler   Many spelling fix...
364
  					  the LCD display every second with
c609719b8   wdenk   Initial revision
365
  					  a "rotator" |\-/|\-/
cf946c6d0   Lei Wen   mv: seperate kirk...
366
367
368
369
  - Marvell Family Member
  		CONFIG_SYS_MVFS		- define it if you want to enable
  					  multiple fs option at one time
  					  for marvell soc family
11ccc33fa   Marcel Ziswiler   Many spelling fix...
370
  - 8xx CPU Options: (if using an MPC8xx CPU)
66ca92a5b   wdenk   * Patch by Yuli B...
371
372
  		CONFIG_8xx_GCLK_FREQ	- deprecated: CPU clock if
  					  get_gclk_freq() cannot work
5da627a42   wdenk   * Patch by Steven...
373
374
  					  e.g. if there is no 32KHz
  					  reference PIT/RTC clock
66ca92a5b   wdenk   * Patch by Yuli B...
375
376
  		CONFIG_8xx_OSCLK	- PLL input clock (either EXTCLK
  					  or XTAL/EXTAL)
c609719b8   wdenk   Initial revision
377

66ca92a5b   wdenk   * Patch by Yuli B...
378
  - 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
379
380
  		CONFIG_SYS_8xx_CPUCLK_MIN
  		CONFIG_SYS_8xx_CPUCLK_MAX
66ca92a5b   wdenk   * Patch by Yuli B...
381
  		CONFIG_8xx_CPUCLK_DEFAULT
75d1ea7f6   wdenk   Fix variable CPU ...
382
  			See doc/README.MPC866
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
383
  		CONFIG_SYS_MEASURE_CPUCLK
75d1ea7f6   wdenk   Fix variable CPU ...
384

ba56f6257   wdenk   Patch by Travis S...
385
386
387
388
389
  		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...
390
  		RTC clock or CONFIG_SYS_8XX_XIN)
75d1ea7f6   wdenk   Fix variable CPU ...
391

506f39188   Heiko Schocher   8xx, icache: enab...
392
393
394
395
  		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...
396
  - 85xx CPU Options:
ffd06e023   York Sun   powerpc/mpc85xx: ...
397
398
399
400
401
  		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...
402
403
404
405
406
  		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: ...
407
408
409
410
  		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...
411
412
413
414
415
416
417
418
  		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...
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
  		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...
438
439
  		CONFIG_A003399_NOR_WORKAROUND
  		Enables a workaround for IFC erratum A003399. It is only
b445bbb49   Jeremiah Mahler   doc: fix grammati...
440
  		required during NOR boot.
74fa22ed7   Prabhakar Kushwaha   powerpc/mpc85xx:N...
441

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

33eee330c   Scott Wood   powerpc/fsl-coren...
446
447
448
449
  		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:...
450
451
452
  		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:...
453
454
455
  		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:...
456
457
458
  		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:...
459
460
  		CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
  		This value denotes start offset of DSP CCSR space.
b135991a3   Priyanka Jain   powerpc/mpc85xx: ...
461
462
463
464
  		CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
  		Single Source Clock is clocking mode present in some of FSL SoC's.
  		In this mode, a single differential clock is used to supply
  		clocks to the sysclock, ddrclock and usbclock.
fb4a2409b   Aneesh Bansal   powerpc/mpc85xx: ...
465
466
467
  		CONFIG_SYS_CPC_REINIT_F
  		This CONFIG is defined when the CPC is configured as SRAM at the
  		time of U-boot entry and is required to be re-initialized.
aade20046   Tang Yuantian   mpc85xx/t104x: Ad...
468
  		CONFIG_DEEP_SLEEP
b445bbb49   Jeremiah Mahler   doc: fix grammati...
469
  		Indicates this SoC supports deep sleep feature. If deep sleep is
aade20046   Tang Yuantian   mpc85xx/t104x: Ad...
470
  		supported, core will start to execute uboot when wakes up.
6cb461b4f   Daniel Schwierzeck   MIPS: fix endiane...
471
  - Generic CPU options:
2a1680e30   York Sun   common/board_f: I...
472
473
474
475
476
  		CONFIG_SYS_GENERIC_GLOBAL_DATA
  		Defines global data is initialized in generic board board_init_f().
  		If this macro is defined, global data is created and cleared in
  		generic board board_init_f(). Without this macro, architecture/board
  		should initialize global data before calling board_init_f().
6cb461b4f   Daniel Schwierzeck   MIPS: fix endiane...
477
478
479
480
  		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...
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
  		CONFIG_SYS_FSL_DDR
  		Freescale DDR driver in use. This type of DDR controller is
  		found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
  		SoCs.
  
  		CONFIG_SYS_FSL_DDR_ADDR
  		Freescale DDR memory-mapped register base.
  
  		CONFIG_SYS_FSL_DDR_EMU
  		Specify emulator support for DDR. Some DDR features such as
  		deskew training are not available.
  
  		CONFIG_SYS_FSL_DDRC_GEN1
  		Freescale DDR1 controller.
  
  		CONFIG_SYS_FSL_DDRC_GEN2
  		Freescale DDR2 controller.
  
  		CONFIG_SYS_FSL_DDRC_GEN3
  		Freescale DDR3 controller.
34e026f9b   York Sun   driver/ddr/fsl: A...
501
502
  		CONFIG_SYS_FSL_DDRC_GEN4
  		Freescale DDR4 controller.
9ac4ffbde   York Sun   Driver/DDR: Add F...
503
504
  		CONFIG_SYS_FSL_DDRC_ARM_GEN3
  		Freescale DDR3 controller for ARM-based SoCs.
5614e71b4   York Sun   Driver/DDR: Movin...
505
506
507
508
509
510
511
512
513
514
515
516
  		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
34e026f9b   York Sun   driver/ddr/fsl: A...
517
518
519
520
521
522
523
524
525
  		Freescale DDR3 or DDR3L controllers.
  
  		CONFIG_SYS_FSL_DDR3L
  		Board config to use DDR3L. It can be enabled for SoCs with
  		DDR3L controllers.
  
  		CONFIG_SYS_FSL_DDR4
  		Board config to use DDR4. It can be enabled for SoCs with
  		DDR4 controllers.
5614e71b4   York Sun   Driver/DDR: Movin...
526

1b4175d6f   Prabhakar Kushwaha   driver/ifc:Change...
527
528
529
530
531
  		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...
532
533
534
535
536
537
538
539
  		CONFIG_SYS_FSL_PBL_PBI
  		It enables addition of RCW (Power on reset configuration) in built image.
  		Please refer doc/README.pblimage for more details
  
  		CONFIG_SYS_FSL_PBL_RCW
  		It adds PBI(pre-boot instructions) commands in u-boot build image.
  		PBI commands can be used to configure SoC before it starts the execution.
  		Please refer doc/README.pblimage for more details
89ad7be8e   Prabhakar Kushwaha   Makefile: Add sup...
540
541
542
  		CONFIG_SPL_FSL_PBL
  		It adds a target to create boot binary having SPL binary in PBI format
  		concatenated with u-boot binary.
4e5b1bd0d   York Sun   driver/ddr: Chang...
543
544
545
546
547
  		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...
548
549
550
551
  		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...
552
553
554
555
  		CONFIG_SYS_FSL_DDR_INTLV_256B
  		DDR controller interleaving on 256-byte. This is a special
  		interleaving mode, handled by Dickens for Freescale layerscape
  		SoCs with ARM core.
1d71efbb0   York Sun   driver/ddr: Restr...
556
557
558
559
560
  		CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
  		Number of controllers used as main memory.
  
  		CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
  		Number of controllers used for other than main memory.
028dbb8db   Ruchika Gupta   fsl_sec : Change ...
561
562
563
564
565
  		CONFIG_SYS_FSL_SEC_BE
  		Defines the SEC controller register space as Big Endian
  
  		CONFIG_SYS_FSL_SEC_LE
  		Defines the SEC controller register space as Little Endian
0b953ffc6   Markus Klotzbuecher   Monahans related ...
566
  - Intel Monahans options:
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
567
  		CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
0b953ffc6   Markus Klotzbuecher   Monahans related ...
568
569
570
571
  
  		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...
572
  		CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
cf48eb9ab   Wolfgang Denk   Some code cleanup
573

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

92bbd64e3   Daniel Schwierzeck   README: update MI...
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
  - 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...
610
611
612
613
614
  - 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...
615
616
617
618
619
620
621
  		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...
622
  		CONFIG_ARM_ERRATA_716044
0678587fb   Stephen Warren   ARM: implement so...
623
624
625
  		CONFIG_ARM_ERRATA_742230
  		CONFIG_ARM_ERRATA_743622
  		CONFIG_ARM_ERRATA_751472
f71cbfe3c   Nitin Garg   ARM: Add workarou...
626
  		CONFIG_ARM_ERRATA_794072
b7588e3bd   Nitin Garg   ARM: Add workarou...
627
  		CONFIG_ARM_ERRATA_761320
789fcfd7a   Nitin Garg   MLK-10524: iMX6x:...
628
  		CONFIG_ARM_ERRATA_845369
0678587fb   Stephen Warren   ARM: implement so...
629
630
631
632
633
634
  
  		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!
c616a0df2   Nishanth Menon   ARM: Introduce er...
635
636
637
  		NOTE: The following can be machine specific errata. These
  		do have ability to provide rudimentary version and machine
  		specific checks, but expect no product checks.
5902f4ce0   Nishanth Menon   ARM: Introduce er...
638
  		CONFIG_ARM_ERRATA_430973
b45c48a7c   Nishanth Menon   ARM: Introduce er...
639
  		CONFIG_ARM_ERRATA_454179
9b4d65f91   Nishanth Menon   ARM: Introduce er...
640
  		CONFIG_ARM_ERRATA_621766
c616a0df2   Nishanth Menon   ARM: Introduce er...
641
  		CONFIG_ARM_ERRATA_798870
73c38934d   Stephen Warren   ARM: tegra: suppo...
642
643
644
645
646
647
  - Tegra SoC options:
  		CONFIG_TEGRA_SUPPORT_NON_SECURE
  
  		Support executing U-Boot in non-secure (NS) mode. Certain
  		impossible actions will be skipped if the CPU is in NS mode,
  		such as ARM architectural timer initialization.
5da627a42   wdenk   * Patch by Steven...
648
  - Linux Kernel Interface:
c609719b8   wdenk   Initial revision
649
650
651
652
653
654
655
656
657
  		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
658
  		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
218ca724c   Wolfgang Denk   README: update do...
659
  		"clocks_in_mhz=1" is automatically included in the
c609719b8   wdenk   Initial revision
660
  		default environment.
5da627a42   wdenk   * Patch by Steven...
661
  		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]
b445bbb49   Jeremiah Mahler   doc: fix grammati...
662
  		When transferring memsize parameter to Linux, some versions
5da627a42   wdenk   * Patch by Steven...
663
664
  		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...
665
  		CONFIG_OF_LIBFDT
f57f70aab   Wolfgang Denk   Support passing o...
666
667
  
  		New kernel versions are expecting firmware settings to be
213bf8c82   Gerald Van Baren   Add a flattened d...
668
669
670
671
672
673
  		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...
674
  		 * The bootm command automatically updates the fdt
213bf8c82   Gerald Van Baren   Add a flattened d...
675

b55ae4024   Marcel Ziswiler   FDT: remove obsol...
676
677
678
679
  		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...
680
  		OF_TBCLK - The timebase frequency.
c2871f038   Kumar Gala   Added OF_STDOUT_P...
681
  		OF_STDOUT_PATH - The path to the console device
f57f70aab   Wolfgang Denk   Support passing o...
682

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

4e2531378   Kumar Gala   Allow board code ...
686
687
688
689
  		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...
690

c654b5172   Simon Glass   fdt: Add ft_syste...
691
692
693
694
695
696
  		CONFIG_OF_SYSTEM_SETUP
  
  		Other code has addition modification that it wants to make
  		to the flat device tree before handing it off to the kernel.
  		This causes ft_system_setup() to be called before booting
  		the kernel.
0267768ed   Matthew McClintock   * Modify bootm co...
697
  		CONFIG_OF_BOOT_CPU
11ccc33fa   Marcel Ziswiler   Many spelling fix...
698
  		This define fills in the correct boot CPU in the boot
0267768ed   Matthew McClintock   * Modify bootm co...
699
  		param header, the default value is zero if undefined.
3887c3fbd   Heiko Schocher   mucmc52, uc101: d...
700
701
702
703
704
705
706
707
  		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...
708
709
710
711
712
713
714
715
716
  		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 ...
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
  - 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...
734
735
736
737
  - 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 ...
738
739
740
741
742
  - 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...
743
  - Serial Ports:
48d0192fe   Andreas Engel   Moved conditional...
744
  		CONFIG_PL010_SERIAL
6705d81e9   wdenk   * Patch by Andrea...
745
746
  
  		Define this if you want support for Amba PrimeCell PL010 UARTs.
48d0192fe   Andreas Engel   Moved conditional...
747
  		CONFIG_PL011_SERIAL
6705d81e9   wdenk   * Patch by Andrea...
748
749
750
751
752
753
754
755
756
757
758
759
760
  
  		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...
761
762
763
764
765
766
767
768
769
770
771
  		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.
d57dee578   Karicheri, Muralidharan   serial: nsl16550:...
772
773
774
775
  		CONFIG_SERIAL_HW_FLOW_CONTROL
  
  		Define this variable to enable hw flow control in serial driver.
  		Current user of this option is drivers/serial/nsl16550.c driver
6705d81e9   wdenk   * Patch by Andrea...
776

c609719b8   wdenk   Initial revision
777
  - Console Interface:
43d9616cf   wdenk   * Patch by Robert...
778
779
780
781
  		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
782
783
784
785
786
787
788
  
  		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...
789
  		defines (cf. smiLynxEM, i8042)
c609719b8   wdenk   Initial revision
790
791
792
793
794
795
796
797
798
  			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...
799
800
  			VIDEO_VISIBLE_ROWS	visible pixel rows
  			VIDEO_PIXEL_SIZE	bytes per pixel
c609719b8   wdenk   Initial revision
801
802
  			VIDEO_DATA_FORMAT	graphic data format
  						(0-5, cf. cfb_console.c)
ba56f6257   wdenk   Patch by Travis S...
803
  			VIDEO_FB_ADRS		framebuffer address
c609719b8   wdenk   Initial revision
804
805
806
807
808
809
810
811
812
  			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...
813
  			CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
c609719b8   wdenk   Initial revision
814
815
  			CONFIG_CONSOLE_TIME	display time/date info in
  						upper right corner
602ad3b33   Jon Loeliger   README: Rewrite c...
816
  						(requires CONFIG_CMD_DATE)
c609719b8   wdenk   Initial revision
817
818
  			CONFIG_VIDEO_LOGO	display Linux logo in
  						upper left corner
a6c7ad2f6   wdenk   * Fix startup pro...
819
820
821
  			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
  						linux_logo.h for logo.
  						Requires CONFIG_VIDEO_LOGO
c609719b8   wdenk   Initial revision
822
  			CONFIG_CONSOLE_EXTRA_INFO
11ccc33fa   Marcel Ziswiler   Many spelling fix...
823
  						additional board info beside
c609719b8   wdenk   Initial revision
824
  						the logo
33a35bbbe   Pali Rohár   cfb_console: Add ...
825
826
827
  		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...
828
829
830
  		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
831

d4ca31c40   wdenk   * Cleanup lowboot...
832
833
834
835
  		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...
836

45ae2546e   Heiko Schocher   video, cfb_consol...
837
838
839
840
  		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
841
842
843
  - Console Baudrate:
  		CONFIG_BAUDRATE - in bps
  		Select one of the baudrates listed in
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
844
845
  		CONFIG_SYS_BAUDRATE_TABLE, see below.
  		CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
c609719b8   wdenk   Initial revision
846

c92fac91a   Heiko Schocher   82xx serial, smc:...
847
848
849
  - 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: ...
850
  		This option is actual only for 82xx and 8xx possible.
c92fac91a   Heiko Schocher   82xx serial, smc:...
851
852
853
  		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...
854
  - Pre-Console Buffer:
4cf2609b0   Wolfgang Denk   README: fix docum...
855
856
857
858
859
860
861
  		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...
862
  		bytes are output before the console is initialised, the
4cf2609b0   Wolfgang Denk   README: fix docum...
863
864
865
866
  		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...
867

046a37bd5   Sonny Rao   Add safe vsnprint...
868
869
870
871
872
873
874
875
  - 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
876
877
878
  - 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...
879
880
  		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
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
  
  		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...
903
904
905
  		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
906
907
  
  		CONFIG_RAMBOOT and CONFIG_NFSBOOT
43d9616cf   wdenk   * Patch by Robert...
908
909
910
  		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...
911
  		RAM and NFS.
c609719b8   wdenk   Initial revision
912

eda0ba38a   Heiko Schocher   bootcount: store ...
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
  - 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
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
  - 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...
952
  - Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
c609719b8   wdenk   Initial revision
953
954
  		CONFIG_KGDB_BAUDRATE
  		Select one of the baudrates listed in
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
955
  		CONFIG_SYS_BAUDRATE_TABLE, see below.
c609719b8   wdenk   Initial revision
956
957
  
  - Monitor Functions:
602ad3b33   Jon Loeliger   README: Rewrite c...
958
959
  		Monitor commands can be included or excluded
  		from the build by using the #include files
c6c621bdb   Stephen Warren   README: fix refer...
960
961
  		<config_cmd_all.h> and #undef'ing unwanted
  		commands, or using <config_cmd_default.h>
602ad3b33   Jon Loeliger   README: Rewrite c...
962
963
964
965
966
  		and augmenting with additional #define's
  		for wanted commands.
  
  		The default command configuration includes all commands
  		except those marked below with a "*".
b401b73d0   Marek Vasut   aes: Add 'aes' co...
967
  		CONFIG_CMD_AES		  AES 128 CBC encrypt/decrypt
602ad3b33   Jon Loeliger   README: Rewrite c...
968
  		CONFIG_CMD_ASKENV	* ask for env variable
602ad3b33   Jon Loeliger   README: Rewrite c...
969
970
971
972
973
  		CONFIG_CMD_BDI		  bdinfo
  		CONFIG_CMD_BEDBUG	* Include BedBug Debugger
  		CONFIG_CMD_BMP		* BMP support
  		CONFIG_CMD_BSP		* Board specific commands
  		CONFIG_CMD_BOOTD	  bootd
d2b2ffe31   Tom Rini   cmd_bootm.c: Add ...
974
  		CONFIG_CMD_BOOTI	* ARM64 Linux kernel Image support
602ad3b33   Jon Loeliger   README: Rewrite c...
975
  		CONFIG_CMD_CACHE	* icache, dcache
08d0d6f32   Michal Simek   common: Add new c...
976
  		CONFIG_CMD_CLK   	* clock command support
602ad3b33   Jon Loeliger   README: Rewrite c...
977
  		CONFIG_CMD_CONSOLE	  coninfo
710b99385   Mike Frysinger   crc32: make comma...
978
  		CONFIG_CMD_CRC32	* crc32
602ad3b33   Jon Loeliger   README: Rewrite c...
979
980
981
  		CONFIG_CMD_DATE		* support for RTC, date/time...
  		CONFIG_CMD_DHCP		* DHCP support
  		CONFIG_CMD_DIAG		* Diagnostics
a7c931045   Peter Tyser   Add support for M...
982
983
984
985
  		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...
986
987
  		CONFIG_CMD_DTT		* Digital Therm and Thermostat
  		CONFIG_CMD_ECHO		  echo arguments
246c69225   Peter Tyser   Add 'editenv' com...
988
  		CONFIG_CMD_EDITENV	  edit env variable
602ad3b33   Jon Loeliger   README: Rewrite c...
989
990
  		CONFIG_CMD_EEPROM	* EEPROM read/write support
  		CONFIG_CMD_ELF		* bootelf, bootvx
5e2b3e0c5   Joe Hershberger   env: Add a comman...
991
  		CONFIG_CMD_ENV_CALLBACK	* display details about env callbacks
fffad71bc   Joe Hershberger   env: Add a comman...
992
  		CONFIG_CMD_ENV_FLAGS	* display details about env flags
88733e2c6   Andrew Ruder   cmd_nvedit.c: Add...
993
  		CONFIG_CMD_ENV_EXISTS	* check existence of env variable
0c79cda01   Mike Frysinger   env: make import/...
994
  		CONFIG_CMD_EXPORTENV	* export the environment
03e2ecf6b   Stephen Warren   fs: separate CONF...
995
996
  		CONFIG_CMD_EXT2		* ext2 command support
  		CONFIG_CMD_EXT4		* ext4 command support
16f4d9335   Stephen Warren   README: document ...
997
998
  		CONFIG_CMD_FS_GENERIC	* filesystem commands (e.g. load, ls)
  					  that work for multiple fs types
59e890ef7   Christian Gmeiner   fs: make it possi...
999
  		CONFIG_CMD_FS_UUID	* Look up a filesystem UUID
bdab39d35   Mike Frysinger   rename CONFIG_CMD...
1000
  		CONFIG_CMD_SAVEENV	  saveenv
602ad3b33   Jon Loeliger   README: Rewrite c...
1001
  		CONFIG_CMD_FDC		* Floppy Disk Support
03e2ecf6b   Stephen Warren   fs: separate CONF...
1002
  		CONFIG_CMD_FAT		* FAT command support
602ad3b33   Jon Loeliger   README: Rewrite c...
1003
1004
  		CONFIG_CMD_FLASH	  flinfo, erase, protect
  		CONFIG_CMD_FPGA		  FPGA device initialization support
4d98b5c8a   Vincent Stehlé   README: align def...
1005
  		CONFIG_CMD_FUSE		* Device fuse support
53fdc7ef2   Anton Staaf   Add gettime command
1006
  		CONFIG_CMD_GETTIME	* Get time since boot
a641b9794   Mike Frysinger   make `go` optional
1007
  		CONFIG_CMD_GO		* the 'go' command (exec code)
a000b7950   Kim Phillips   common: add a gre...
1008
  		CONFIG_CMD_GREPENV	* search environment
bf36c5d52   Simon Glass   Add hash command ...
1009
  		CONFIG_CMD_HASH		* calculate hash / digest
602ad3b33   Jon Loeliger   README: Rewrite c...
1010
1011
1012
1013
  		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...
1014
  		CONFIG_CMD_IMLS		  List all images found in NOR flash
4d98b5c8a   Vincent Stehlé   README: align def...
1015
  		CONFIG_CMD_IMLS_NAND	* List all images found in NAND flash
602ad3b33   Jon Loeliger   README: Rewrite c...
1016
  		CONFIG_CMD_IMMAP	* IMMR dump support
aa53233a1   Simon Glass   Add an I/O tracin...
1017
  		CONFIG_CMD_IOTRACE	* I/O tracing for debugging
0c79cda01   Mike Frysinger   env: make import/...
1018
  		CONFIG_CMD_IMPORTENV	* import an environment
c167cc020   Joe Hershberger   Add a new "ini" c...
1019
  		CONFIG_CMD_INI		* import data from an ini file into the env
602ad3b33   Jon Loeliger   README: Rewrite c...
1020
1021
1022
1023
  		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...
1024
  		CONFIG_CMD_LDRINFO	* ldrinfo (display Blackfin loader)
d22c338e0   Joe Hershberger   net: Add link-loc...
1025
1026
  		CONFIG_CMD_LINK_LOCAL	* link-local IP address auto-configuration
  					  (169.254.*.*)
602ad3b33   Jon Loeliger   README: Rewrite c...
1027
1028
  		CONFIG_CMD_LOADB	  loadb
  		CONFIG_CMD_LOADS	  loads
4d98b5c8a   Vincent Stehlé   README: align def...
1029
  		CONFIG_CMD_MD5SUM	* print md5 message digest
02c9aa1d4   Robin Getz   Add md5sum and sh...
1030
  					  (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
15a33e49d   Simon Glass   Add option to dis...
1031
  		CONFIG_CMD_MEMINFO	* Display detailed memory information
602ad3b33   Jon Loeliger   README: Rewrite c...
1032
  		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
a2681707b   Wolfgang Denk   Feature Removal: ...
1033
  					  loop, loopw
4d98b5c8a   Vincent Stehlé   README: align def...
1034
  		CONFIG_CMD_MEMTEST	* mtest
602ad3b33   Jon Loeliger   README: Rewrite c...
1035
1036
1037
  		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...
1038
  		CONFIG_CMD_MTDPARTS	* MTD partition support
602ad3b33   Jon Loeliger   README: Rewrite c...
1039
1040
  		CONFIG_CMD_NAND		* NAND support
  		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
4d98b5c8a   Vincent Stehlé   README: align def...
1041
  		CONFIG_CMD_NFS		  NFS support
e92739d34   Peter Tyser   Add support for P...
1042
  		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
c0f40859f   Wolfgang Denk   README: white-spa...
1043
  		CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
602ad3b33   Jon Loeliger   README: Rewrite c...
1044
1045
1046
1047
1048
  		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 ...
1049
  		CONFIG_CMD_READ		* Read raw data from partition
602ad3b33   Jon Loeliger   README: Rewrite c...
1050
1051
  		CONFIG_CMD_REGINFO	* Register dump
  		CONFIG_CMD_RUN		  run command in env variable
d304931f2   Simon Glass   sandbox: Add 'sb'...
1052
  		CONFIG_CMD_SANDBOX	* sb command to access sandbox features
602ad3b33   Jon Loeliger   README: Rewrite c...
1053
1054
1055
1056
1057
1058
  		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...
1059
  		CONFIG_CMD_SF		* Read/write/erase SPI NOR flash
4d98b5c8a   Vincent Stehlé   README: align def...
1060
  		CONFIG_CMD_SHA1SUM	* print sha1 memory digest
02c9aa1d4   Robin Getz   Add md5sum and sh...
1061
  					  (requires CONFIG_CMD_MEMORY)
7d861d95a   Bob Liu   blackfin: bf609: ...
1062
  		CONFIG_CMD_SOFTSWITCH	* Soft switch setting command for BF60x
74de7aefd   Wolfgang Denk   Add "source" comm...
1063
  		CONFIG_CMD_SOURCE	  "source" command Support
602ad3b33   Jon Loeliger   README: Rewrite c...
1064
  		CONFIG_CMD_SPI		* SPI serial bus support
7a83af07a   Luca Ceresoli   TFTP: add tftpsrv...
1065
  		CONFIG_CMD_TFTPSRV	* TFTP transfer in server mode
1fb7cd498   Simon Glass   net: tftpput: imp...
1066
  		CONFIG_CMD_TFTPPUT	* TFTP put command (upload)
da83bcd7b   Joe Hershberger   Add a command to ...
1067
1068
  		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...
1069
  		CONFIG_CMD_USB		* USB support
602ad3b33   Jon Loeliger   README: Rewrite c...
1070
  		CONFIG_CMD_CDP		* Cisco Discover Protocol support
c8339f515   Marek Vasut   CMD: Fix typo CMD...
1071
  		CONFIG_CMD_MFSL		* Microblaze FSL support
4d98b5c8a   Vincent Stehlé   README: align def...
1072
  		CONFIG_CMD_XIMG		  Load part of Multi Image
89c8230de   Przemyslaw Marczak   new commands: uui...
1073
  		CONFIG_CMD_UUID		* Generate random UUID or GUID string
c609719b8   wdenk   Initial revision
1074
1075
1076
  
  		EXAMPLE: If you want all functions except of network
  		support you can write:
602ad3b33   Jon Loeliger   README: Rewrite c...
1077
1078
  		#include "config_cmd_all.h"
  		#undef CONFIG_CMD_NET
c609719b8   wdenk   Initial revision
1079

213bf8c82   Gerald Van Baren   Add a flattened d...
1080
1081
  	Other Commands:
  		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
c609719b8   wdenk   Initial revision
1082
1083
  
  	Note:	Don't enable the "icache" and "dcache" commands
602ad3b33   Jon Loeliger   README: Rewrite c...
1084
  		(configuration option CONFIG_CMD_CACHE) unless you know
43d9616cf   wdenk   * Patch by Robert...
1085
1086
1087
1088
1089
1090
  		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
1091
1092
1093
  
  
  		XXX - this list needs to get updated!
a5ecbe62c   Wolfgang Denk   Add SLRE - Super ...
1094
1095
  - Regular expression support:
  		CONFIG_REGEX
93e145964   Wolfgang Denk   Coding Style clea...
1096
1097
1098
1099
  		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 ...
1100

45ba8077f   Simon Glass   fdt: ARM: Add dev...
1101
1102
1103
1104
1105
1106
1107
  - 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 ...
1108
1109
  		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 ...
1110
1111
1112
1113
1114
1115
1116
  
  		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...
1117

2c0f79e44   Simon Glass   fdt: Add support ...
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
  		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
1129
1130
1131
  - Watchdog:
  		CONFIG_WATCHDOG
  		If this variable is defined, it enables watchdog
6abe6fb68   Detlev Zundel   README: Clarify d...
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
  		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
1143

7bae0d6f6   Heiko Schocher   arm, at91, wdt: m...
1144
1145
  		CONFIG_AT91_HW_WDT_TIMEOUT
  		specify the timeout in seconds. default 2 seconds.
c1551ea81   stroese   U-Boot version en...
1146
1147
1148
1149
1150
  - 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...
1151
1152
  		Any change to this variable will be reverted at the
  		next reset.
c1551ea81   stroese   U-Boot version en...
1153

c609719b8   wdenk   Initial revision
1154
  - Real-Time Clock:
602ad3b33   Jon Loeliger   README: Rewrite c...
1155
  		When CONFIG_CMD_DATE is selected, the type of the RTC
c609719b8   wdenk   Initial revision
1156
1157
1158
1159
1160
  		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...
1161
  		CONFIG_RTC_MC13XXX	- use MC13783 or MC13892 RTC
c609719b8   wdenk   Initial revision
1162
  		CONFIG_RTC_MC146818	- use MC146818 RTC
1cb8e980c   wdenk   * Patches by Davi...
1163
  		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
c609719b8   wdenk   Initial revision
1164
  		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
7f70e8530   wdenk   * Patch by David ...
1165
  		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
412921d29   Markus Niebel   RTC: add support ...
1166
  		CONFIG_RTC_DS1339	- use Maxim, Inc. DS1339 RTC
3bac35137   wdenk   * Patch by Josef ...
1167
  		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
9536dfcce   Tor Krill   Add support for I...
1168
  		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
4c0d4c3b7   wdenk   * Patch by Tom Ar...
1169
  		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
1170
  		CONFIG_SYS_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
71d19f30d   Heiko Schocher   rtc, rv3029: add ...
1171
1172
  		CONFIG_SYS_RV3029_TCR	- enable trickle charger on
  					  RV3029 RTC.
c609719b8   wdenk   Initial revision
1173

b37c7e5e5   wdenk   * Patch by Seb Ja...
1174
1175
  		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...
1176
1177
  - GPIO Support:
  		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
e92739d34   Peter Tyser   Add support for P...
1178

5dec49ca2   Chris Packham   pca953x: support ...
1179
1180
1181
  		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...
1182
1183
  		Note that if the GPIO device uses I2C, then the I2C interface
  		must also be configured. See I2C Support, below.
aa53233a1   Simon Glass   Add an I/O tracin...
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
  - I/O tracing:
  		When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
  		accesses and can checksum them or write a list of them out
  		to memory. See the 'iotrace' command for details. This is
  		useful for testing device drivers since it can confirm that
  		the driver behaves the same way before and after a code
  		change. Currently this is supported on sandbox and arm. To
  		add support for your architecture, add '#include <iotrace.h>'
  		to the bottom of arch/<arch>/include/asm/io.h and test.
  
  		Example output from the 'iotrace stats' command is below.
  		Note that if the trace buffer is exhausted, the checksum will
  		still continue to operate.
  
  			iotrace is enabled
  			Start:  10000000	(buffer start address)
  			Size:   00010000	(buffer size)
  			Offset: 00000120	(current buffer offset)
  			Output: 10000120	(start + offset)
  			Count:  00000018	(number of trace records)
  			CRC32:  9526fb66	(CRC32 of all trace records)
c609719b8   wdenk   Initial revision
1205
  - Timestamp Support:
43d9616cf   wdenk   * Patch by Robert...
1206
1207
1208
  		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...
1209
  		automatically enabled when you select CONFIG_CMD_DATE .
c609719b8   wdenk   Initial revision
1210

923c46f97   Karl O. Pinc   README: Cleanup d...
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
  - 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
1221

218ca724c   Wolfgang Denk   README: update do...
1222
1223
  		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...
1224
  		least one non-MTD partition type as well.
c609719b8   wdenk   Initial revision
1225
1226
  
  - IDE Reset method:
4d13cbad1   wdenk   * Patch by Toluna...
1227
1228
  		CONFIG_IDE_RESET_ROUTINE - this is defined in several
  		board configurations files but used nowhere!
c609719b8   wdenk   Initial revision
1229

4d13cbad1   wdenk   * Patch by Toluna...
1230
1231
1232
1233
  		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
1234
1235
1236
1237
1238
  
  - ATAPI Support:
  		CONFIG_ATAPI
  
  		Set this to enable ATAPI support.
c40b29568   wdenk   * Patch by Rune T...
1239
1240
1241
1242
  - LBA48 Support
  		CONFIG_LBA48
  
  		Set this to enable support for disks larger than 137GB
4b142febf   Heiko Schocher   common: delete CO...
1243
  		Also look at CONFIG_SYS_64BIT_LBA.
c40b29568   wdenk   * Patch by Rune T...
1244
1245
  		Whithout these , LBA48 support uses 32bit variables and will 'only'
  		support disks up to 2.1TB.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
1246
  		CONFIG_SYS_64BIT_LBA:
c40b29568   wdenk   * Patch by Rune T...
1247
1248
  			When enabled, makes the IDE subsystem use 64bit sector addresses.
  			Default is 32bit.
c609719b8   wdenk   Initial revision
1249
1250
1251
1252
  - 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...
1253
1254
1255
  		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
1256
1257
  		maximum numbers of LUNs, SCSI ID's and target
  		devices.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
1258
  		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
c609719b8   wdenk   Initial revision
1259

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

c609719b8   wdenk   Initial revision
1263
  - NETWORK Support (PCI):
682011ff6   wdenk   * Patches by Udi ...
1264
  		CONFIG_E1000
ce5207e19   Kyle Moffett   e1000: Allow dire...
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
  		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...
1279

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

c609719b8   wdenk   Initial revision
1283
1284
  		CONFIG_EEPRO100
  		Support for Intel 82557/82559/82559ER chips.
11ccc33fa   Marcel Ziswiler   Many spelling fix...
1285
  		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
c609719b8   wdenk   Initial revision
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
  		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 ...
1298
  - NETWORK Support (other):
c041e9d21   Jens Scharsig   new at91_emac net...
1299
1300
1301
1302
1303
1304
1305
1306
1307
  		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 ...
1308
1309
  		CONFIG_CALXEDA_XGMAC
  		Support for the Calxeda XGMAC device
3bb46d23f   Ashok   README : Rename C...
1310
  		CONFIG_LAN91C96
45219c466   wdenk   Patch by Mathijs ...
1311
1312
1313
1314
1315
1316
1317
1318
  		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...
1319
  		CONFIG_SMC91111
f39748ae8   wdenk   * Patch by Paul R...
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
  		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...
1332
1333
1334
1335
1336
  		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...
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
  		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...
1348
  		CONFIG_SMC911X
557b377d8   Jens Gehrlein   smc911x: add 16 b...
1349
  		Support for SMSC's LAN911x and LAN921x chips
c2fff331a   Mike Rapoport   smc911x: update S...
1350
  			CONFIG_SMC911X_BASE
557b377d8   Jens Gehrlein   smc911x: add 16 b...
1351
1352
  			Define this to hold the physical address
  			of the device (I/O space)
c2fff331a   Mike Rapoport   smc911x: update S...
1353
  			CONFIG_SMC911X_32_BIT
557b377d8   Jens Gehrlein   smc911x: add 16 b...
1354
  			Define this if data bus is 32 bits
c2fff331a   Mike Rapoport   smc911x: update S...
1355
  			CONFIG_SMC911X_16_BIT
557b377d8   Jens Gehrlein   smc911x: add 16 b...
1356
1357
  			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...
1358
  			words you may also try CONFIG_SMC911X_32_BIT.
557b377d8   Jens Gehrlein   smc911x: add 16 b...
1359

3d0075fa7   Yoshihiro Shimoda   README: add descr...
1360
1361
1362
1363
1364
1365
1366
1367
  		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 ...
1368
1369
  			CONFIG_SH_ETHER_CACHE_WRITEBACK
  			If this option is set, the driver enables cache flush.
b2f97cf27   Heiko Schocher   pwm, imx6: add su...
1370
1371
1372
  - PWM Support:
  		CONFIG_PWM_IMX
  		Support for PWM modul on the imx6.
5e1247247   Vadim Bendebury   Introduce generic...
1373
  - TPM Support:
90899cc01   Che-liang Chiou   tpm: Rename gener...
1374
1375
  		CONFIG_TPM
  		Support TPM devices.
1b393db58   Tom Wai-Hong Tam   tpm: Reorganize t...
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
  		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
1388
1389
  		CONFIG_TPM_ATMEL_TWI
  		Support for Atmel TWI TPM device. Requires I2C support.
90899cc01   Che-liang Chiou   tpm: Rename gener...
1390
  		CONFIG_TPM_TIS_LPC
5e1247247   Vadim Bendebury   Introduce generic...
1391
1392
1393
1394
1395
1396
1397
  		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...
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
  		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
1411
1412
  - USB Support:
  		At the moment only the UHCI host controller is
4d13cbad1   wdenk   * Patch by Toluna...
1413
  		supported (PIP405, MIP405, MPC5200); define
c609719b8   wdenk   Initial revision
1414
1415
  		CONFIG_USB_UHCI to enable it.
  		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
30d56fae2   wdenk   Patch by Sam Song...
1416
  		and define CONFIG_USB_STORAGE to enable the USB
c609719b8   wdenk   Initial revision
1417
1418
1419
1420
  		storage devices.
  		Note:
  		Supported are USB Keyboards and USB Floppy drives
  		(TEAC FD-05PUB).
4d13cbad1   wdenk   * Patch by Toluna...
1421
1422
1423
  		MPC5200 USB requires additional defines:
  			CONFIG_USB_CLOCK
  				for 528 MHz Clock: 0x0001bbbb
307ecb6db   Eric Millbrandt   Add support for U...
1424
1425
  			CONFIG_PSC3_USB
  				for USB on PSC3
4d13cbad1   wdenk   * Patch by Toluna...
1426
1427
1428
  			CONFIG_USB_CONFIG
  				for differential drivers: 0x00001000
  				for single ended drivers: 0x00005000
307ecb6db   Eric Millbrandt   Add support for U...
1429
1430
  				for differential drivers on PSC3: 0x00000100
  				for single ended drivers on PSC3: 0x00004100
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
1431
  			CONFIG_SYS_USB_EVENT_POLL
fdcfaa1b0   Zhang Wei   USB event poll su...
1432
1433
  				May be defined to allow interrupt polling
  				instead of using asynchronous interrupts
4d13cbad1   wdenk   * Patch by Toluna...
1434

9ab4ce223   Simon Glass   usb: Add support ...
1435
1436
  		CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
  		txfilltuning field in the EHCI controller on reset.
6e9e06260   Oleksandr Tymoshenko   usb: dwc2: Add dr...
1437
1438
  		CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
  		HW module registers.
16c8d5e76   Wolfgang Denk   Various USB relat...
1439
1440
1441
1442
  - 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...
1443
  		attach your USB cable. The Unix command "dmesg" should print
16c8d5e76   Wolfgang Denk   Various USB relat...
1444
1445
  		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
1446
  		appear to a USB host as a Linux gserial device or a
16c8d5e76   Wolfgang Denk   Various USB relat...
1447
1448
1449
1450
1451
1452
1453
  		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
1454

16c8d5e76   Wolfgang Denk   Various USB relat...
1455
1456
1457
1458
1459
1460
  			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
1461

f9da0f894   Vipin KUMAR   Enable high speed...
1462
1463
1464
1465
1466
1467
1468
  			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...
1469
  			CONFIG_SYS_CONSOLE_IS_IN_ENV
16c8d5e76   Wolfgang Denk   Various USB relat...
1470
1471
1472
1473
  			Define this if you want stdin, stdout &/or stderr to
  			be set to usbtty.
  
  			mpc8xx:
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
1474
  				CONFIG_SYS_USB_EXTC_CLK 0xBLAH
16c8d5e76   Wolfgang Denk   Various USB relat...
1475
  				Derive USB clock from external clock "blah"
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
1476
  				- CONFIG_SYS_USB_EXTC_CLK 0x02
386eda022   Wolfgang Denk   Code cleanup
1477

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
1478
  				CONFIG_SYS_USB_BRG_CLK 0xBLAH
16c8d5e76   Wolfgang Denk   Various USB relat...
1479
  				Derive USB clock from brgclk
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
1480
  				- CONFIG_SYS_USB_BRG_CLK 0x04
16c8d5e76   Wolfgang Denk   Various USB relat...
1481

386eda022   Wolfgang Denk   Code cleanup
1482
  		If you have a USB-IF assigned VendorID then you may wish to
16c8d5e76   Wolfgang Denk   Various USB relat...
1483
  		define your own vendor specific values either in BoardName.h
386eda022   Wolfgang Denk   Code cleanup
1484
  		or directly in usbd_vendor_info.h. If you don't define
16c8d5e76   Wolfgang Denk   Various USB relat...
1485
1486
1487
1488
1489
1490
1491
  		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
1492

16c8d5e76   Wolfgang Denk   Various USB relat...
1493
1494
1495
1496
1497
1498
1499
1500
1501
  			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
1502

16c8d5e76   Wolfgang Denk   Various USB relat...
1503
1504
1505
1506
  			CONFIG_USBD_PRODUCTID
  			Define this as the unique Product ID
  			for your device
  			- CONFIG_USBD_PRODUCTID 0xFFFF
4d13cbad1   wdenk   * Patch by Toluna...
1507

d70a560fd   Igor Grinberg   README: add docum...
1508
1509
1510
1511
1512
1513
1514
1515
  - 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 ...
1516
1517
1518
  		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
1519

71f951180   wdenk   * Fix CONFIG_NET_...
1520
  - MMC Support:
8bde7f776   wdenk   * Code cleanup:
1521
1522
1523
  		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_...
1524
  		to physical memory similar to flash. Command line is
602ad3b33   Jon Loeliger   README: Rewrite c...
1525
1526
  		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_...
1527

afb35666d   Yoshihiro Shimoda   mmc: sh_mmcif: ad...
1528
1529
1530
1531
1532
1533
1534
1535
  		CONFIG_SH_MMCIF
  		Support for Renesas on-chip MMCIF controller
  
  			CONFIG_SH_MMCIF_ADDR
  			Define the base address of MMCIF registers
  
  			CONFIG_SH_MMCIF_CLK
  			Define the clock frequency for MMCIF
1fd93c6e7   Pierre Aubert   eMMC: cmd_mmc.c a...
1536
1537
1538
1539
1540
1541
1542
1543
1544
  		CONFIG_GENERIC_MMC
  		Enable the generic MMC driver
  
  		CONFIG_SUPPORT_EMMC_BOOT
  		Enable some additional features of the eMMC boot partitions.
  
  		CONFIG_SUPPORT_EMMC_RPMB
  		Enable the commands for reading, writing and programming the
  		key for the Replay Protection Memory Block partition in eMMC.
b3ba6e94b   Tom Rini   README: Document ...
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
  - 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...
1557
1558
  		CONFIG_DFU_NAND
  		This enables support for exposing NAND devices via DFU.
a9479f043   Afzal Mohammed   dfu: ram support
1559
1560
1561
1562
1563
  		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...
1564
1565
1566
1567
1568
  		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...
1569
1570
1571
1572
1573
1574
  		CONFIG_SYS_DFU_MAX_FILE_SIZE
  		When updating files rather than the raw storage device,
  		we use a static buffer to copy the file into and then write
  		the buffer once we've been given the whole file.  Define
  		this to the maximum filesize (in bytes) for the buffer.
  		Default is 4 MiB if undefined.
001a83198   Heiko Schocher   usb: dfu: introdu...
1575
1576
1577
1578
1579
1580
1581
1582
1583
  		DFU_DEFAULT_POLL_TIMEOUT
  		Poll timeout [ms], is the timeout a device can send to the
  		host. The host must wait for this timeout before sending
  		a subsequent DFU_GET_STATUS request to the device.
  
  		DFU_MANIFEST_POLL_TIMEOUT
  		Poll timeout [ms], which the device sends to the host when
  		entering dfuMANIFEST state. Host waits this timeout, before
  		sending again an USB request to the device.
3aab70afc   Sebastian Siewior   usb/gadget: add t...
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
  - USB Device Android Fastboot support:
  		CONFIG_CMD_FASTBOOT
  		This enables the command "fastboot" which enables the Android
  		fastboot mode for the platform's USB device. Fastboot is a USB
  		protocol for downloading images, flashing and device control
  		used on Android devices.
  		See doc/README.android-fastboot for more information.
  
  		CONFIG_ANDROID_BOOT_IMAGE
  		This enables support for booting images which use the Android
  		image format header.
  
  		CONFIG_USB_FASTBOOT_BUF_ADDR
  		The fastboot protocol requires a large memory buffer for
  		downloads. Define this to the starting RAM address to use for
  		downloaded images.
  
  		CONFIG_USB_FASTBOOT_BUF_SIZE
  		The fastboot protocol requires a large memory buffer for
  		downloads. This buffer should be as large as possible for a
  		platform. Define this to the size available RAM for fastboot.
d1b5ed075   Steve Rae   usb/gadget: fastb...
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
  
  		CONFIG_FASTBOOT_FLASH
  		The fastboot protocol includes a "flash" command for writing
  		the downloaded image to a non-volatile storage device. Define
  		this to enable the "fastboot flash" command.
  
  		CONFIG_FASTBOOT_FLASH_MMC_DEV
  		The fastboot "flash" command requires additional information
  		regarding the non-volatile storage device. Define this to
  		the eMMC device that fastboot should use to store the image.
3aab70afc   Sebastian Siewior   usb/gadget: add t...
1615

0ff7e585d   Steve Rae   fastboot: handle ...
1616
1617
1618
1619
1620
1621
1622
1623
  		CONFIG_FASTBOOT_GPT_NAME
  		The fastboot "flash" command supports writing the downloaded
  		image to the Protective MBR and the Primary GUID Partition
  		Table. (Additionally, this downloaded image is post-processed
  		to generate and write the Backup GUID Partition Table.)
  		This occurs when the specified "partition name" on the
  		"fastboot flash" command line matches this value.
  		Default is GPT_ENTRY_NAME (currently "gpt") if undefined.
6705d81e9   wdenk   * Patch by Andrea...
1624
1625
1626
1627
  - 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...
1628
1629
  		CONFIG_SYS_JFFS2_FIRST_SECTOR,
  		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
6705d81e9   wdenk   * Patch by Andrea...
1630
  		Define these for a default partition on a NOR device
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
1631
  		CONFIG_SYS_JFFS_CUSTOM_PART
6705d81e9   wdenk   * Patch by Andrea...
1632
1633
1634
1635
  		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...
1636
  		#define CONFIG_SYS_JFFS_SINGLE_PART	1
6705d81e9   wdenk   * Patch by Andrea...
1637
1638
  		to disable the command chpart. This is the default when you
  		have not defined a custom partition
c30a15e59   Donggeun Kim   FAT: Add FAT writ...
1639
1640
  - FAT(File Allocation Table) filesystem write function support:
  		CONFIG_FAT_WRITE
656f4c653   Donggeun Kim   cmd_fat: add FAT ...
1641
1642
1643
1644
1645
1646
  
  		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...
1647

84cd93272   Gabe Black   fs: Add a Coreboo...
1648
1649
1650
1651
1652
1653
  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.
4f0d1a2ae   Siva Durga Prasad Paladugu   fat: Define MAX_C...
1654
1655
1656
1657
1658
  - FAT(File Allocation Table) filesystem cluster size:
  		CONFIG_FS_FAT_MAX_CLUSTSIZE
  
  		Define the max cluster size for fat operations else
  		a default value of 65536 will be defined.
c609719b8   wdenk   Initial revision
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
  - 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...
1670
1671
1672
1673
  		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
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
  - 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
1685
  		Enable Silicon Motion SMI 712/710/810 Video chip. The
eeb1b77b7   wdenk   * Patch by Pierre...
1686
1687
1688
  		video output is selected via environment 'videoout'
  		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
  		assumed.
b79a11cc2   wdenk   Code cleanup
1689
  		For the CT69000 and SMI_LYNXEM drivers, videomode is
11ccc33fa   Marcel Ziswiler   Many spelling fix...
1690
  		selected via environment 'videomode'. Two different ways
eeb1b77b7   wdenk   * Patch by Pierre...
1691
1692
  		are possible:
  		- "videomode=num"   'num' is a standard LiLo mode numbers.
6e5923851   wdenk   * Cleanup, minor ...
1693
  		Following standard modes are supported	(* is default):
eeb1b77b7   wdenk   * Patch by Pierre...
1694
1695
1696
1697
1698
1699
1700
1701
  
  		      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
1702
  		(i.e. setenv videomode 317; saveenv; reset;)
b79a11cc2   wdenk   Code cleanup
1703
  		- "videomode=bootargs" all the video parameters are parsed
7817cb208   Marcel Ziswiler   fix comments with...
1704
  		from the bootargs. (See drivers/video/videomodes.c)
eeb1b77b7   wdenk   * Patch by Pierre...
1705

c1551ea81   stroese   U-Boot version en...
1706
  		CONFIG_VIDEO_SED13806
43d9616cf   wdenk   * Patch by Robert...
1707
  		Enable Epson SED13806 driver. This driver supports 8bpp
a6c7ad2f6   wdenk   * Fix startup pro...
1708
1709
  		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
  		or CONFIG_VIDEO_SED13806_16BPP
7d3053fbf   Timur Tabi   powerpc: clean up...
1710
  		CONFIG_FSL_DIU_FB
04e5ae793   Wolfgang Denk   Minor coding styl...
1711
  		Enable the Freescale DIU video driver.	Reference boards for
7d3053fbf   Timur Tabi   powerpc: clean up...
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
  		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...
1723
1724
1725
1726
  		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...
1727

058d59b08   Simon Glass   x86: Build vga vi...
1728
1729
1730
1731
1732
  		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 ...
1733
  - Keyboard Support:
8bde7f776   wdenk   * Code cleanup:
1734
  		CONFIG_KEYBOARD
682011ff6   wdenk   * Patches by Udi ...
1735

8bde7f776   wdenk   * Code cleanup:
1736
1737
1738
1739
  		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...
1740

c609719b8   wdenk   Initial revision
1741
1742
1743
1744
1745
  - 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
1746
1747
1748
  		CONFIG_ATMEL_LCD:
  
  			HITACHI TX09D70VM1CCA, 3.5", 240x320.
fd3103bb8   wdenk   Add support for B...
1749
  		CONFIG_NEC_NL6448AC33:
c609719b8   wdenk   Initial revision
1750

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

fd3103bb8   wdenk   Add support for B...
1753
  		CONFIG_NEC_NL6448BC20
c609719b8   wdenk   Initial revision
1754

fd3103bb8   wdenk   Add support for B...
1755
1756
1757
1758
1759
1760
  			NEC NL6448BC20-08. 6.5", 640x480.
  			Active, color, single scan.
  
  		CONFIG_NEC_NL6448BC33_54
  
  			NEC NL6448BC33-54. 10.4", 640x480.
c609719b8   wdenk   Initial revision
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
  			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...
1789
  		CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
c609719b8   wdenk   Initial revision
1790

676d319ef   Simon Glass   lcd: Add CONFIG_L...
1791
  		CONFIG_LCD_ALIGNMENT
b445bbb49   Jeremiah Mahler   doc: fix grammati...
1792
  		Normally the LCD is page-aligned (typically 4KB). If this is
676d319ef   Simon Glass   lcd: Add CONFIG_L...
1793
1794
1795
1796
  		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...
1797
1798
1799
1800
1801
1802
  		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...
1803

45d7f5251   Tom Wai-Hong Tam   lcd: Implement RL...
1804
1805
1806
  		CONFIG_LCD_BMP_RLE8
  
  		Support drawing of RLE8-compressed bitmaps on the LCD.
735987c5a   Tom Wai-Hong Tam   edid: Add I2C com...
1807
1808
1809
1810
  		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...
1811
  - Splash Screen Support: CONFIG_SPLASH_SCREEN
d791b1dc3   wdenk   * Make sure Block...
1812

8bde7f776   wdenk   * Code cleanup:
1813
1814
1815
  		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...
1816
  		is suppressed and the BMP image at the address
8bde7f776   wdenk   * Code cleanup:
1817
1818
1819
1820
  		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...
1821

c08804853   Nikita Kiryanov   lcd: implement a ...
1822
1823
1824
1825
  		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...
1826
  		(see README.displaying-bmps).
c08804853   Nikita Kiryanov   lcd: implement a ...
1827
1828
1829
1830
1831
  		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...
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
  		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...
1851
1852
1853
1854
1855
  - 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...
1856
1857
1858
1859
1860
  - 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.
b445bbb49   Jeremiah Mahler   doc: fix grammati...
1861
  - Do compressing for memory range:
f2b96dfbb   Lei Wen   common: add zip c...
1862
1863
1864
1865
  		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...
1866
  - Compression support:
8ef704784   Kees Cook   documentation: ad...
1867
1868
1869
  		CONFIG_GZIP
  
  		Enabled by default to support gzip compressed images.
c29fdfc1d   wdenk   Patch by Yuli Bar...
1870
1871
1872
1873
1874
  		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...
1875
  		NOTE: the bzip2 algorithm requires a lot of RAM, so
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
1876
  		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
42d1f0394   wdenk   * Patches by Xian...
1877
  		be at least 4MB.
d791b1dc3   wdenk   * Make sure Block...
1878

fc9c1727b   Luigi 'Comio' Mantellini   Add support for L...
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
  		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...
1900
  		the appropriate CONFIG_SYS_MALLOC_LEN value).
fc9c1727b   Luigi 'Comio' Mantellini   Add support for L...
1901

8ef704784   Kees Cook   documentation: ad...
1902
1903
1904
1905
  		CONFIG_LZO
  
  		If this option is set, support for LZO compressed images
  		is included.
17ea11774   wdenk   Patch by Tolunay ...
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
  - 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...
1918
  		detection of gigabit PHY is included.
17ea11774   wdenk   Patch by Tolunay ...
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
  
  		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
1931
1932
  - Ethernet address:
  		CONFIG_ETHADDR
c68a05fee   richardretanubun   Adds two more eth...
1933
  		CONFIG_ETH1ADDR
c609719b8   wdenk   Initial revision
1934
1935
  		CONFIG_ETH2ADDR
  		CONFIG_ETH3ADDR
c68a05fee   richardretanubun   Adds two more eth...
1936
1937
  		CONFIG_ETH4ADDR
  		CONFIG_ETH5ADDR
c609719b8   wdenk   Initial revision
1938

11ccc33fa   Marcel Ziswiler   Many spelling fix...
1939
1940
  		Define a default value for Ethernet address to use
  		for the respective Ethernet interface, in case this
c609719b8   wdenk   Initial revision
1941
1942
1943
1944
1945
1946
  		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...
1947
  		the default Ethernet interface, in case this is not
c609719b8   wdenk   Initial revision
1948
  		determined through e.g. bootp.
1ebcd6547   Wolfgang Denk   README: improve d...
1949
  		(Environment variable "ipaddr")
c609719b8   wdenk   Initial revision
1950
1951
1952
  
  - Server IP address:
  		CONFIG_SERVERIP
11ccc33fa   Marcel Ziswiler   Many spelling fix...
1953
  		Defines a default value for the IP address of a TFTP
c609719b8   wdenk   Initial revision
1954
  		server to contact when using the "tftboot" command.
1ebcd6547   Wolfgang Denk   README: improve d...
1955
  		(Environment variable "serverip")
c609719b8   wdenk   Initial revision
1956

97cfe8616   Robin Getz   Save server's MAC...
1957
1958
1959
1960
  		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...
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
  - 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...
1977
1978
1979
1980
1981
  - 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...
1982
  		tftp down the same boot image concurrently.  Note: the Ethernet
53a5c424b   David Updegraff   multicast tftp: R...
1983
1984
  		driver in use must provide a function: mcast() to join/leave a
  		multicast group.
c609719b8   wdenk   Initial revision
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
  - 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...
1996
  		following delays are inserted then:
c609719b8   wdenk   Initial revision
1997
1998
1999
2000
2001
2002
  
  		1st BOOTP request:	delay 0 ... 1 sec
  		2nd BOOTP request:	delay 0 ... 2 sec
  		3rd BOOTP request:	delay 0 ... 4 sec
  		4th and following
  		BOOTP requests:		delay 0 ... 8 sec
92ac8acc0   Thierry Reding   net: More BOOTP r...
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
  		CONFIG_BOOTP_ID_CACHE_SIZE
  
  		BOOTP packets are uniquely identified using a 32-bit ID. The
  		server will copy the ID from client requests to responses and
  		U-Boot will use this to determine if it is the destination of
  		an incoming response. Some servers will check that addresses
  		aren't in use before handing them out (usually using an ARP
  		ping) and therefore take up to a few hundred milliseconds to
  		respond. Network congestion may also influence the time it
  		takes for a response to make it back to the client. If that
  		time is too long, U-Boot will retransmit requests. In order
  		to allow earlier responses to still be accepted after these
  		retransmissions, U-Boot's BOOTP client keeps a small cache of
  		IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
  		cache. The default is to keep IDs for up to four outstanding
  		requests. Increasing this will allow U-Boot to accept offers
  		from a BOOTP client in networks with unusually high latency.
fe389a82c   stroese   - Added CONFIG_BO...
2020
  - DHCP Advanced Options:
1fe80d79c   Jon Loeliger   Finally retire cm...
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
  		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...
2036
  		CONFIG_BOOTP_MAY_FAIL
fe389a82c   stroese   - Added CONFIG_BO...
2037

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

2c00e099f   Joe Hershberger   net: Add option C...
2041
2042
2043
2044
2045
  		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...
2046
2047
2048
2049
2050
2051
2052
  		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...
2053
  		is defined.
fe389a82c   stroese   - Added CONFIG_BO...
2054
2055
2056
2057
  
  		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_...
2058
  		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
1fe80d79c   Jon Loeliger   Finally retire cm...
2059
2060
  		of the "hostname" environment variable is passed as
  		option 12 to the DHCP server.
fe389a82c   stroese   - Added CONFIG_BO...
2061

d9a2f416d   Aras Vaichas   DHCP request fix ...
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
  		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...
2075
2076
2077
2078
2079
2080
2081
   - 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...
2082
   - CDP Options:
6e5923851   wdenk   * Cleanup, minor ...
2083
  		CONFIG_CDP_DEVICE_ID
a3d991bd0   wdenk   Patches by Pantel...
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
  
  		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...
2096
  		eth0 for the first Ethernet, eth1 for the second etc.
a3d991bd0   wdenk   Patches by Pantel...
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
  
  		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
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
  - 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 ...
2133
2134
2135
2136
2137
2138
2139
  		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...
2140
2141
2142
2143
2144
2145
  		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
2146
2147
2148
2149
2150
  - 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...
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
  - 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...
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
  		- 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...
2174

00f792e0d   Heiko Schocher   i2c, fsl_i2c: swi...
2175
2176
2177
2178
2179
2180
  		- 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...
2181
  		  - If your board supports a second fsl i2c bus, define
00f792e0d   Heiko Schocher   i2c, fsl_i2c: swi...
2182
2183
2184
2185
  		    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...
2186
  		- drivers/i2c/tegra_i2c.c:
10cee5166   Nobuhiro Iwamatsu   README: I2C: Fix ...
2187
2188
2189
  		  - 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...
2190

880540dec   Dirk Eibach   i2c, ppc4xx_i2c: ...
2191
2192
2193
2194
  		- 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...
2195
2196
2197
2198
2199
2200
2201
2202
  		- 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
b445bbb49   Jeremiah Mahler   doc: fix grammati...
2203
  		If those defines are not set, default value is 100000
fac964089   trem   i2c: mxc: move to...
2204
  		for speed, and 0 for slave.
1086bfa9f   Nobuhiro Iwamatsu   i2c: Add support ...
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
  		- 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...
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
  		- 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
b445bbb49   Jeremiah Mahler   doc: fix grammati...
2234
  		  - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
2035d77d7   Nobuhiro Iwamatsu   i2c: sh_i2c: Upda...
2235

6789e84ec   Heiko Schocher   i2c, omap24xx: co...
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
  		- 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...
2248
2249
2250
2251
  		- 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...
2252
2253
2254
2255
2256
  		- drivers/i2c/s3c24x0_i2c.c:
  		  - activate this driver with CONFIG_SYS_I2C_S3C24X0
  		  - This driver adds i2c buses (11 for Exynos5250, Exynos5420
  		    9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
  		    with a fix speed from 100000 and the slave addr 0!
b46226bdb   Dirk Eibach   i2c: IHS I2C mast...
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
  		- drivers/i2c/ihs_i2c.c
  		  - activate this driver with CONFIG_SYS_I2C_IHS
  		  - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
  		  - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
  		  - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
  		  - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
  		  - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
  		  - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
  		  - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
  		  - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
  		  - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
  		  - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
  		  - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
  		  - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
3f4978c71   Heiko Schocher   i2c: common chang...
2271
2272
2273
  		additional defines:
  
  		CONFIG_SYS_NUM_I2C_BUSES
b445bbb49   Jeremiah Mahler   doc: fix grammati...
2274
  		Hold the number of i2c buses you want to use. If you
3f4978c71   Heiko Schocher   i2c: common chang...
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
  		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
b445bbb49   Jeremiah Mahler   doc: fix grammati...
2290
  		hold a list of buses you want to use, only used if
3f4978c71   Heiko Schocher   i2c: common chang...
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
  		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...
2308
2309
2310
2311
2312
  			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...
2313
  			bus 6 on adapter 1 without a mux
ea818dbbc   Heiko Schocher   i2c, soft-i2c: sw...
2314
2315
  			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...
2316
2317
  
  		If you do not have i2c muxes on your board, omit this define.
ea818dbbc   Heiko Schocher   i2c, soft-i2c: sw...
2318
  - Legacy I2C Support:	CONFIG_HARD_I2C
3f4978c71   Heiko Schocher   i2c: common chang...
2319
2320
2321
2322
2323
2324
2325
2326
2327
  
  		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...
2328
2329
2330
  		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
2331

945af8d72   wdenk   * Add support for...
2332
  		This will allow you to use i2c commands at the u-boot
602ad3b33   Jon Loeliger   README: Rewrite c...
2333
  		command line (as long as you set CONFIG_CMD_I2C in
b37c7e5e5   wdenk   * Patch by Seb Ja...
2334
2335
  		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...
2336
  		command line interface.
c609719b8   wdenk   Initial revision
2337

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

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

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

8d321b81c   Peter Tyser   Update README to ...
2348
  		Now, the u-boot i2c code for the mpc8xx
a47a12bec   Stefan Roese   Move arch/ppc to ...
2349
  		(arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
8d321b81c   Peter Tyser   Update README to ...
2350
2351
2352
  		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
2353

5da71efa1   Eric Millbrandt   Reset i2c slave d...
2354
2355
2356
2357
2358
2359
  		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...
2360
  		That's all that's required for CONFIG_HARD_I2C.
c609719b8   wdenk   Initial revision
2361

ea818dbbc   Heiko Schocher   i2c, soft-i2c: sw...
2362
  		If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
b37c7e5e5   wdenk   * Patch by Seb Ja...
2363
2364
  		then the following macros need to be defined (examples are
  		from include/configs/lwmon.h):
c609719b8   wdenk   Initial revision
2365
2366
  
  		I2C_INIT
b37c7e5e5   wdenk   * Patch by Seb Ja...
2367
  		(Optional). Any commands necessary to enable the I2C
43d9616cf   wdenk   * Patch by Robert...
2368
  		controller or configure ports.
c609719b8   wdenk   Initial revision
2369

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

c609719b8   wdenk   Initial revision
2372
  		I2C_PORT
43d9616cf   wdenk   * Patch by Robert...
2373
2374
2375
  		(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
2376
2377
2378
2379
2380
2381
  
  		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...
2382
  		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
c609719b8   wdenk   Initial revision
2383
2384
2385
2386
2387
  		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...
2388
  		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
c609719b8   wdenk   Initial revision
2389
  		I2C_READ
472d54605   York Sun   Consolidate bool ...
2390
2391
  		Code that returns true if the I2C data line is high,
  		false if it is low.
c609719b8   wdenk   Initial revision
2392

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

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

c609719b8   wdenk   Initial revision
2402
  		I2C_SCL(bit)
472d54605   York Sun   Consolidate bool ...
2403
2404
  		If <bit> is true, sets the I2C clock line high. If it
  		is false, it clears it (low).
c609719b8   wdenk   Initial revision
2405

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

c609719b8   wdenk   Initial revision
2410
2411
2412
2413
  		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...
2414
  		is 1 / (I2C_DELAY * 4). Often defined to be something
945af8d72   wdenk   * Add support for...
2415
  		like:
b37c7e5e5   wdenk   * Patch by Seb Ja...
2416
  		#define I2C_DELAY  udelay(2)
c609719b8   wdenk   Initial revision
2417

793b5726f   Mike Frysinger   i2c: soft_i2c: ad...
2418
2419
2420
2421
2422
2423
2424
2425
2426
  		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...
2427
  		CONFIG_SYS_I2C_INIT_BOARD
47cd00fa7   wdenk   * Patches by Robe...
2428

8bde7f776   wdenk   * Code cleanup:
2429
2430
2431
2432
2433
2434
2435
2436
  		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...
2437

26a33504a   Richard Retanubun   fsl_i2c: Added a ...
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
  		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 ...
2448
2449
2450
2451
2452
  		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...
2453
2454
2455
  		CONFIG_I2C_MULTI_BUS
  
  		This option allows the use of multiple I2C buses, each of which
c0f40859f   Wolfgang Denk   README: white-spa...
2456
2457
  		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...
2458
  		Note that bus numbering is zero-based.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2459
  		CONFIG_SYS_I2C_NOPROBES
bb99ad6d8   Ben Warren   Add support for m...
2460
2461
  
  		This option specifies a list of I2C devices that will be skipped
c0f40859f   Wolfgang Denk   README: white-spa...
2462
  		when the 'i2c probe' command is issued.	 If CONFIG_I2C_MULTI_BUS
0f89c54be   Peter Tyser   i2c: Update refer...
2463
2464
  		is set, specify a list of bus-device pairs.  Otherwise, specify
  		a 1D array of device addresses
bb99ad6d8   Ben Warren   Add support for m...
2465
2466
2467
  
  		e.g.
  			#undef	CONFIG_I2C_MULTI_BUS
c0f40859f   Wolfgang Denk   README: white-spa...
2468
  			#define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
bb99ad6d8   Ben Warren   Add support for m...
2469
2470
  
  		will skip addresses 0x50 and 0x68 on a board with one I2C bus
c0f40859f   Wolfgang Denk   README: white-spa...
2471
  			#define CONFIG_I2C_MULTI_BUS
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2472
  			#define CONFIG_SYS_I2C_MULTI_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
bb99ad6d8   Ben Warren   Add support for m...
2473
2474
  
  		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2475
  		CONFIG_SYS_SPD_BUS_NUM
be5e61815   Timur Tabi   mpc83xx: Update 8...
2476
2477
2478
  
  		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...
2479
  		CONFIG_SYS_RTC_BUS_NUM
0dc018ece   Stefan Roese   [PATCH] I2C: Add ...
2480
2481
2482
  
  		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...
2483
  		CONFIG_SYS_DTT_BUS_NUM
0dc018ece   Stefan Roese   [PATCH] I2C: Add ...
2484
2485
2486
  
  		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...
2487
  		CONFIG_SYS_I2C_DTT_ADDR:
9ebbb54f7   Victor Gallardo   ppc4xx: Allow DTT...
2488
2489
2490
2491
  
  		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...
2492
2493
2494
2495
2496
2497
2498
2499
2500
  		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...
2501

c609719b8   wdenk   Initial revision
2502
2503
2504
2505
2506
  - 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 ...
2507
2508
2509
2510
  		CONFIG_SH_SPI
  
  		Enables the driver for SPI controller on SuperH. Currently
  		only SH7757 is supported.
c609719b8   wdenk   Initial revision
2511
2512
2513
2514
2515
2516
  		CONFIG_SPI_X
  
  		Enables extended (16-bit) SPI EEPROM addressing.
  		(symmetrical to CONFIG_I2C_X)
  
  		CONFIG_SOFT_SPI
43d9616cf   wdenk   * Patch by Robert...
2517
2518
2519
2520
2521
2522
2523
  		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
2524

04a9e1180   Ben Warren   Add support for a...
2525
2526
2527
2528
2529
  		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...
2530
  		Currently supported on some MPC8xxx processors.	 For an
04a9e1180   Ben Warren   Add support for a...
2531
  		example, see include/configs/mpc8349emds.h.
38254f45b   Guennadi Liakhovetski   New i.MX31 SPI dr...
2532
2533
2534
  		CONFIG_MXC_SPI
  
  		Enables the driver for the SPI controllers on i.MX and MXC
2e3cd1cda   Fabio Estevam   README: Fix suppo...
2535
  		SoCs. Currently i.MX31/35/51 are supported.
38254f45b   Guennadi Liakhovetski   New i.MX31 SPI dr...
2536

f659b5736   Heiko Schocher   spi, spi_mxc: do ...
2537
2538
2539
  		CONFIG_SYS_SPI_MXC_WAIT
  		Timeout for waiting until spi transfer completed.
  		default: (CONFIG_SYS_HZ/100)     /* 10 ms */
0133502e3   Matthias Fuchs   Improve configura...
2540
  - FPGA Support: CONFIG_FPGA
c609719b8   wdenk   Initial revision
2541

0133502e3   Matthias Fuchs   Improve configura...
2542
2543
2544
2545
2546
2547
  		Enables FPGA subsystem.
  
  		CONFIG_FPGA_<vendor>
  
  		Enables support for specific chip vendors.
  		(ALTERA, XILINX)
c609719b8   wdenk   Initial revision
2548

0133502e3   Matthias Fuchs   Improve configura...
2549
  		CONFIG_FPGA_<family>
c609719b8   wdenk   Initial revision
2550

0133502e3   Matthias Fuchs   Improve configura...
2551
2552
2553
2554
2555
2556
  		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
2557

64e809afe   Siva Durga Prasad Paladugu   fpga: Guard the L...
2558
2559
2560
  		CONFIG_CMD_FPGA_LOADMK
  
  		Enable support for fpga loadmk command
67193864b   Michal Simek   fpga: Add support...
2561
2562
2563
2564
2565
2566
2567
2568
  		CONFIG_CMD_FPGA_LOADP
  
  		Enable support for fpga loadp command - load partial bitstream
  
  		CONFIG_CMD_FPGA_LOADBP
  
  		Enable support for fpga loadbp command - load partial bitstream
  		(Xilinx only)
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2569
  		CONFIG_SYS_FPGA_PROG_FEEDBACK
c609719b8   wdenk   Initial revision
2570

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

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

43d9616cf   wdenk   * Patch by Robert...
2575
2576
2577
2578
  		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
2579
2580
2581
2582
2583
  
  		CONFIG_FPGA_DELAY
  
  		If defined, a function that provides delays in the FPGA
  		configuration driver.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2584
  		CONFIG_SYS_FPGA_CHECK_CTRLC
c609719b8   wdenk   Initial revision
2585
  		Allow Control-C to interrupt FPGA configuration
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2586
  		CONFIG_SYS_FPGA_CHECK_ERROR
c609719b8   wdenk   Initial revision
2587

43d9616cf   wdenk   * Patch by Robert...
2588
2589
2590
2591
  		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
2592

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

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

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

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

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

43d9616cf   wdenk   * Patch by Robert...
2607
  		Time to wait after FPGA configuration. The default is
11ccc33fa   Marcel Ziswiler   Many spelling fix...
2608
  		200 ms.
c609719b8   wdenk   Initial revision
2609
2610
  
  - Configuration Management:
b2b8a6967   Stefan Roese   Makefile: Add CON...
2611
2612
2613
2614
2615
2616
2617
  		CONFIG_BUILD_TARGET
  
  		Some SoCs need special image types (e.g. U-Boot binary
  		with a special header) as build targets. By defining
  		CONFIG_BUILD_TARGET in the SoC / board header, this
  		special image will be automatically built upon calling
  		make / MAKEALL.
c609719b8   wdenk   Initial revision
2618
  		CONFIG_IDENT_STRING
43d9616cf   wdenk   * Patch by Robert...
2619
2620
  		If defined, this string will be added to the U-Boot
  		version information (U_BOOT_VERSION)
c609719b8   wdenk   Initial revision
2621
2622
  
  - Vendor Parameter Protection:
43d9616cf   wdenk   * Patch by Robert...
2623
2624
  		U-Boot considers the values of the environment
  		variables "serial#" (Board Serial Number) and
7152b1d0b   wdenk   * Add support for...
2625
  		"ethaddr" (Ethernet Address) to be parameters that
43d9616cf   wdenk   * Patch by Robert...
2626
2627
2628
2629
  		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...
2630
  		change this behaviour:
c609719b8   wdenk   Initial revision
2631
2632
2633
  
  		If CONFIG_ENV_OVERWRITE is #defined in your config
  		file, the write protection for vendor parameters is
47cd00fa7   wdenk   * Patches by Robe...
2634
  		completely disabled. Anybody can change or delete
c609719b8   wdenk   Initial revision
2635
2636
2637
2638
  		these parameters.
  
  		Alternatively, if you #define _both_ CONFIG_ETHADDR
  		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
11ccc33fa   Marcel Ziswiler   Many spelling fix...
2639
  		Ethernet address is installed in the environment,
c609719b8   wdenk   Initial revision
2640
2641
2642
  		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...
2643
2644
2645
2646
  		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
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
  - 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 '$(......
2662
  			setenv bootargs ... mem=\${mem}
c609719b8   wdenk   Initial revision
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
  			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 ...
2674
2675
  			IVMS8, IVML24, SPD8xx, TQM8xxL,
  			HERMES, IP860, RPXlite, LWMON,
544d97e9a   Wolfgang Denk   PCU_E: remove cod...
2676
  			FLAGADM, TQM8260
c609719b8   wdenk   Initial revision
2677

40fef0490   Gabe Black   Introduce arch_ph...
2678
2679
2680
2681
2682
2683
2684
  - 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
2685
2686
2687
2688
2689
2690
  - 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...
2691
  		system where you want the system to reboot
c609719b8   wdenk   Initial revision
2692
2693
2694
2695
2696
  		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...
2697
2698
2699
2700
  		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
2701

40cb90ee2   Guennadi Liakhovetski   net: make ARP tim...
2702
2703
2704
  		CONFIG_ARP_TIMEOUT
  
  		Timeout waiting for an ARP reply in milliseconds.
48a3e999c   Tetsuyuki Kobayashi   net: nfs: make NF...
2705
2706
2707
2708
2709
2710
  		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
2711
  - Command Interpreter:
8078f1a5f   Wolfgang Denk   README says CFG_A...
2712
  		CONFIG_AUTO_COMPLETE
04a85b3b3   wdenk   * Patches by Pant...
2713
2714
  
  		Enable auto completion of commands using TAB.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2715
  		CONFIG_SYS_PROMPT_HUSH_PS2
c609719b8   wdenk   Initial revision
2716
2717
2718
2719
2720
2721
  
  		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:
2722
2723
2724
2725
2726
2727
2728
  		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
2729

43d9616cf   wdenk   * Patch by Robert...
2730
2731
2732
2733
  		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
2734
2735
2736
2737
2738
2739
  
  		To store commands and special characters in a
  		variable, please use double quotation marks
  		surrounding the whole text of the variable, instead
  		of the backslashes before semicolons and special
  		symbols.
b445bbb49   Jeremiah Mahler   doc: fix grammati...
2740
  - Command Line Editing and History:
aa0c71aca   Wolfgang Denk   Document CONFIG_C...
2741
  		CONFIG_CMDLINE_EDITING
11ccc33fa   Marcel Ziswiler   Many spelling fix...
2742
  		Enable editing and History functions for interactive
b445bbb49   Jeremiah Mahler   doc: fix grammati...
2743
  		command line input operations
aa0c71aca   Wolfgang Denk   Document CONFIG_C...
2744

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

43d9616cf   wdenk   * Patch by Robert...
2751
2752
  		For example, place something like this in your
  		board's config file:
c609719b8   wdenk   Initial revision
2753
2754
2755
2756
  
  		#define CONFIG_EXTRA_ENV_SETTINGS \
  			"myvar1=value1\0" \
  			"myvar2=value2\0"
43d9616cf   wdenk   * Patch by Robert...
2757
2758
2759
2760
  		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...
2761
  		will change soon, there is no guarantee either.
c609719b8   wdenk   Initial revision
2762
  		You better know what you are doing here.
43d9616cf   wdenk   * Patch by Robert...
2763
2764
  		Note: overly (ab)use of the default environment is
  		discouraged. Make sure to check other ways to preset
74de7aefd   Wolfgang Denk   Add "source" comm...
2765
  		the environment like the "source" command or the
43d9616cf   wdenk   * Patch by Robert...
2766
  		boot command first.
c609719b8   wdenk   Initial revision
2767

5e724ca2b   Stephen Warren   Add env vars desc...
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
  		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 ...
2781
2782
2783
2784
2785
  		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...
2786
2787
2788
  		CONFIG_DELAY_ENVIRONMENT
  
  		Normally the environment is loaded when the board is
b445bbb49   Jeremiah Mahler   doc: fix grammati...
2789
  		initialised so that it is available to U-Boot. This inhibits
06fd85389   Simon Glass   arm: Add CONFIG_D...
2790
2791
2792
2793
  		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...
2794
  - DataFlash Support:
2abbe0754   wdenk   * Patch by Nicola...
2795
  		CONFIG_HAS_DATAFLASH
8bde7f776   wdenk   * Code cleanup:
2796
2797
2798
  		Defining this option enables DataFlash features and
  		allows to read/write in Dataflash via the standard
  		commands cp, md...
2abbe0754   wdenk   * Patch by Nicola...
2799

f61ec45eb   Eric Nelson   README: Add descr...
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
  - 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...
2818
2819
2820
2821
  		CONFIG_CMD_SF_TEST
  
  		Define this option to include a destructive SPI flash
  		test ('sf test').
1dcd6d038   Jagannadha Sutradharudu Teki   sf: Add bank addr...
2822
2823
2824
2825
  		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...
2826
2827
2828
2829
  		CONFIG_SF_DUAL_FLASH		Dual flash memories
  
  		Define this option to use dual flash support where two flash
  		memories can be connected with a given cs line.
b445bbb49   Jeremiah Mahler   doc: fix grammati...
2830
  		Currently Xilinx Zynq qspi supports these type of connections.
b902e07ce   Jagannadha Sutradharudu Teki   sf: Add CONFIG_SF...
2831

562f8df18   Heiko Schocher   spi: add config o...
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
  		CONFIG_SYS_SPI_ST_ENABLE_WP_PIN
  		enable the W#/Vpp signal to disable writing to the status
  		register on ST MICRON flashes like the N25Q128.
  		The status register write enable/disable bit, combined with
  		the W#/VPP signal provides hardware data protection for the
  		device as follows: When the enable/disable bit is set to 1,
  		and the W#/VPP signal is driven LOW, the status register
  		nonvolatile bits become read-only and the WRITE STATUS REGISTER
  		operation will not execute. The only way to exit this
  		hardware-protected mode is to drive W#/VPP HIGH.
3f85ce278   wdenk   * CVS add missing...
2842
2843
2844
2845
2846
  - 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...
2847
  		of the chip must also be defined in the
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2848
  		CONFIG_SYS_SYSTEMACE_BASE macro. For example:
3f85ce278   wdenk   * CVS add missing...
2849
2850
  
  		#define CONFIG_SYSTEMACE
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
2851
  		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
3f85ce278   wdenk   * CVS add missing...
2852
2853
2854
  
  		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...
2855
2856
  - TFTP Fixed UDP Port:
  		CONFIG_TFTP_PORT
28cb93758   Wolfgang Denk   Update for TFTP u...
2857
  		If this is defined, the environment variable tftpsrcp
ecb0ccd9c   Wolfgang Denk   Allow to force TF...
2858
  		is used to supply the TFTP UDP source port value.
28cb93758   Wolfgang Denk   Update for TFTP u...
2859
  		If tftpsrcp isn't defined, the normal pseudo-random port
ecb0ccd9c   Wolfgang Denk   Allow to force TF...
2860
  		number generator is used.
28cb93758   Wolfgang Denk   Update for TFTP u...
2861
2862
2863
2864
2865
  		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...
2866
2867
2868
2869
2870
2871
  		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 ...
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
  - Hashing support:
  		CONFIG_CMD_HASH
  
  		This enables a generic 'hash' command which can produce
  		hashes / digests from a few algorithms (e.g. SHA1, SHA256).
  
  		CONFIG_HASH_VERIFY
  
  		Enable the hash verify command (hash -v). This adds to code
  		size a little.
94e3c8c4f   gaurav rana   crypto/fsl - Add ...
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
  		CONFIG_SHA1 - This option enables support of hashing using SHA1
  		algorithm. The hash is calculated in software.
  		CONFIG_SHA256 - This option enables support of hashing using
  		SHA256 algorithm. The hash is calculated in software.
  		CONFIG_SHA_HW_ACCEL - This option enables hardware acceleration
  		for SHA1/SHA256 hashing.
  		This affects the 'hash' command and also the
  		hash_lookup_algo() function.
  		CONFIG_SHA_PROG_HW_ACCEL - This option enables
  		hardware-acceleration for SHA1/SHA256 progressive hashing.
  		Data can be streamed in a block at a time and the hashing
  		is performed in hardware.
bf36c5d52   Simon Glass   Add hash command ...
2894
2895
2896
  
  		Note: There is also a sha1sum command, which should perhaps
  		be deprecated in favour of 'hash sha1'.
a11f18737   Robert Winkler   imx: Add document...
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
  - 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...
2911
2912
2913
2914
  - Signing support:
  		CONFIG_RSA
  
  		This enables the RSA algorithm used for FIT image verification
8bf2aad7e   Detlev Zundel   doc: README: Corr...
2915
  		in U-Boot. See doc/uImage.FIT/signature.txt for more information.
19c402afa   Simon Glass   image: Add RSA su...
2916

c937ff6dc   Ruchika Gupta   lib/rsa: Modify r...
2917
2918
2919
  		The Modular Exponentiation algorithm in RSA is implemented using
  		driver model. So CONFIG_DM needs to be enabled by default for this
  		library to function.
19c402afa   Simon Glass   image: Add RSA su...
2920
  		The signing part is build into mkimage regardless of this
c937ff6dc   Ruchika Gupta   lib/rsa: Modify r...
2921
2922
  		option. The software based modular exponentiation is built into
  		mkimage irrespective of this option.
19c402afa   Simon Glass   image: Add RSA su...
2923

9e50c406c   Heiko Schocher   i2c, bootcount: a...
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
  - 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...
2944

a8c7c708a   wdenk   * Patch by Gleb N...
2945
  - Show boot progress:
c609719b8   wdenk   Initial revision
2946
  		CONFIG_SHOW_BOOT_PROGRESS
43d9616cf   wdenk   * Patch by Robert...
2947
2948
2949
2950
2951
2952
  		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
2953

3a608ca01   Simon Glass   bootstage: Implem...
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
  - 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...
2978
2979
2980
  		CONFIG_CMD_BOOTSTAGE
  		Add a 'bootstage' command which supports printing a report
  		and un/stashing of bootstage data.
94fd1316b   Simon Glass   bootstage: Store ...
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
  		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 ...
3001
  Legacy uImage format:
c609719b8   wdenk   Initial revision
3002
3003
    Arg	Where			When
      1	common/cmd_bootm.c	before attempting to boot an image
ba56f6257   wdenk   Patch by Travis S...
3004
     -1	common/cmd_bootm.c	Image header has bad	 magic number
c609719b8   wdenk   Initial revision
3005
      2	common/cmd_bootm.c	Image header has correct magic number
ba56f6257   wdenk   Patch by Travis S...
3006
     -2	common/cmd_bootm.c	Image header has bad	 checksum
c609719b8   wdenk   Initial revision
3007
      3	common/cmd_bootm.c	Image header has correct checksum
ba56f6257   wdenk   Patch by Travis S...
3008
     -3	common/cmd_bootm.c	Image data   has bad	 checksum
c609719b8   wdenk   Initial revision
3009
3010
3011
      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 ...
3012
     -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
c609719b8   wdenk   Initial revision
3013
3014
3015
3016
      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 ...
3017
      8	common/cmd_bootm.c	No uncompress/copy overwrite error
c609719b8   wdenk   Initial revision
3018
     -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
1372cce2b   Marian Balakowicz   [new uImage] Use ...
3019
3020
3021
3022
3023
3024
3025
3026
  
      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...
3027
    -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
1372cce2b   Marian Balakowicz   [new uImage] Use ...
3028
3029
     13	common/image.c		Start multifile image verification
     14	common/image.c		No initial ramdisk, no multifile, continue.
c0f40859f   Wolfgang Denk   README: white-spa...
3030
     15	arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
c609719b8   wdenk   Initial revision
3031

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

566a494f5   Heiko Schocher   [PCS440EP] u...
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
     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...
3085
     64	net/eth.c		starting with Ethernet configuration.
566a494f5   Heiko Schocher   [PCS440EP] u...
3086
3087
3088
3089
3090
    -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...
3091
    -81	common/cmd_net.c	some error in NetLoop() occurred
566a494f5   Heiko Schocher   [PCS440EP] u...
3092
3093
3094
     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...
3095
3096
     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...
3097
     84	common/cmd_net.c	end without errors
c609719b8   wdenk   Initial revision
3098

1372cce2b   Marian Balakowicz   [new uImage] Use ...
3099
3100
3101
3102
3103
3104
3105
3106
3107
  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 ...
3108
    103	common/cmd_bootm.c	Found configuration node
1372cce2b   Marian Balakowicz   [new uImage] Use ...
3109
3110
3111
3112
3113
    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...
3114
3115
   -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 ...
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
   -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...
3128
    122	common/image.c		No ramdisk subimage unit name, using configuration
1372cce2b   Marian Balakowicz   [new uImage] Use ...
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
   -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...
3141
   -130	common/cmd_doc.c	Incorrect FIT image format
1372cce2b   Marian Balakowicz   [new uImage] Use ...
3142
    131	common/cmd_doc.c	FIT image format OK
11ccc33fa   Marcel Ziswiler   Many spelling fix...
3143
   -140	common/cmd_ide.c	Incorrect FIT image format
1372cce2b   Marian Balakowicz   [new uImage] Use ...
3144
    141	common/cmd_ide.c	FIT image format OK
11ccc33fa   Marcel Ziswiler   Many spelling fix...
3145
   -150	common/cmd_nand.c	Incorrect FIT image format
1372cce2b   Marian Balakowicz   [new uImage] Use ...
3146
    151	common/cmd_nand.c	FIT image format OK
21d29f7f9   Heiko Schocher   bootm: make use o...
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
  - legacy image format:
  		CONFIG_IMAGE_FORMAT_LEGACY
  		enables the legacy image format support in U-Boot.
  
  		Default:
  		enabled if CONFIG_FIT_SIGNATURE is not defined.
  
  		CONFIG_DISABLE_IMAGE_LEGACY
  		disable the legacy image format
  
  		This define is introduced, as the legacy image format is
  		enabled per default for backward compatibility.
d95f6ec73   Gabe Black   fdt: Add option t...
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
  - 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...
3169
3170
  		CONFIG_FIT_SIGNATURE
  		This option enables signature verification of FIT uImages,
94e3c8c4f   gaurav rana   crypto/fsl - Add ...
3171
3172
3173
3174
  		using a hash signed and verified using RSA. If
  		CONFIG_SHA_PROG_HW_ACCEL is defined, i.e support for progressive
  		hashing is available using hardware, RSA library will use it.
  		See doc/uImage.FIT/signature.txt for more details.
3e569a6b1   Simon Glass   image: Add signin...
3175

21d29f7f9   Heiko Schocher   bootm: make use o...
3176
3177
3178
3179
  		WARNING: When relying on signed FIT images with required
  		signature check the legacy image format is default
  		disabled. If a board need legacy image format support
  		enable this through CONFIG_IMAGE_FORMAT_LEGACY
9a4f479b6   Dirk Eibach   fit: make sha256 ...
3180
3181
3182
3183
  		CONFIG_FIT_DISABLE_SHA256
  		Supporting SHA256 hashes has quite an impact on binary size.
  		For constrained systems sha256 hash support can be disabled
  		with this option.
4cf2609b0   Wolfgang Denk   README: fix docum...
3184
3185
  - Standalone program support:
  		CONFIG_STANDALONE_LOAD_ADDR
6feff899e   Wolfgang Denk   README: fix typos...
3186
3187
3188
  		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...
3189
3190
3191
3192
3193
3194
  		settings.
  
  - Frame Buffer Address:
  		CONFIG_FB_ADDR
  
  		Define CONFIG_FB_ADDR if you want to use specific
44a53b574   Wolfgang Denk   VIDEO: better doc...
3195
3196
3197
3198
3199
3200
3201
  		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...
3202
3203
  
  		Please see board_init_f function.
cccfc2ab7   Detlev Zundel   README: Rearrange...
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
  - 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...
3222
3223
3224
3225
3226
3227
3228
  - 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 ...
3229
3230
3231
3232
  		CONFIG_UBI_SILENCE_MSG
  
  		Make the verbose messages from UBI stop printing.  This leaves
  		warnings and errors enabled.
ff94bc40a   Heiko Schocher   mtd, ubi, ubifs: ...
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
  
  		CONFIG_MTD_UBI_WL_THRESHOLD
  		This parameter defines the maximum difference between the highest
  		erase counter value and the lowest erase counter value of eraseblocks
  		of UBI devices. When this threshold is exceeded, UBI starts performing
  		wear leveling by means of moving data from eraseblock with low erase
  		counter to eraseblocks with high erase counter.
  
  		The default value should be OK for SLC NAND flashes, NOR flashes and
  		other flashes which have eraseblock life-cycle 100000 or more.
  		However, in case of MLC NAND flashes which typically have eraseblock
  		life-cycle less than 10000, the threshold should be lessened (e.g.,
  		to 128 or 256, although it does not have to be power of 2).
  
  		default: 4096
c654b5172   Simon Glass   fdt: Add ft_syste...
3248

ff94bc40a   Heiko Schocher   mtd, ubi, ubifs: ...
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
  		CONFIG_MTD_UBI_BEB_LIMIT
  		This option specifies the maximum bad physical eraseblocks UBI
  		expects on the MTD device (per 1024 eraseblocks). If the
  		underlying flash does not admit of bad eraseblocks (e.g. NOR
  		flash), this value is ignored.
  
  		NAND datasheets often specify the minimum and maximum NVM
  		(Number of Valid Blocks) for the flashes' endurance lifetime.
  		The maximum expected bad eraseblocks per 1024 eraseblocks
  		then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
  		which gives 20 for most NANDs (MaxNVB is basically the total
  		count of eraseblocks on the chip).
  
  		To put it differently, if this value is 20, UBI will try to
  		reserve about 1.9% of physical eraseblocks for bad blocks
  		handling. And that will be 1.9% of eraseblocks on the entire
  		NAND chip, not just the MTD partition UBI attaches. This means
  		that if you have, say, a NAND flash chip admits maximum 40 bad
  		eraseblocks, and it is split on two MTD partitions of the same
  		size, UBI will reserve 40 eraseblocks when attaching a
  		partition.
  
  		default: 20
  
  		CONFIG_MTD_UBI_FASTMAP
  		Fastmap is a mechanism which allows attaching an UBI device
  		in nearly constant time. Instead of scanning the whole MTD device it
  		only has to locate a checkpoint (called fastmap) on the device.
  		The on-flash fastmap contains all information needed to attach
  		the device. Using fastmap makes only sense on large devices where
  		attaching by scanning takes long. UBI will not automatically install
  		a fastmap on old images, but you can set the UBI parameter
  		CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
  		that fastmap-enabled images are still usable with UBI implementations
  		without	fastmap support. On typical flash devices the whole fastmap
  		fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
  
  		CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
  		Set this parameter to enable fastmap automatically on images
  		without a fastmap.
  		default: 0
70c219cd7   Joe Hershberger   ubi: ubifs: Add d...
3290
3291
3292
3293
3294
3295
3296
  - 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 ...
3297
3298
3299
3300
  		CONFIG_UBIFS_SILENCE_MSG
  
  		Make the verbose messages from UBIFS stop printing.  This leaves
  		warnings and errors enabled.
6a11cf48a   Daniel Schwierzeck   spl: add initial ...
3301
  - SPL framework
04e5ae793   Wolfgang Denk   Minor coding styl...
3302
3303
  		CONFIG_SPL
  		Enable building of SPL globally.
6a11cf48a   Daniel Schwierzeck   spl: add initial ...
3304

95579793b   Tom Rini   README: document ...
3305
3306
  		CONFIG_SPL_LDSCRIPT
  		LDSCRIPT for linking the SPL binary.
6ebc34611   Albert ARIBAUD   ARM: fix CONFIG_S...
3307
3308
3309
3310
  		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...
3311
  		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
6ebc34611   Albert ARIBAUD   ARM: fix CONFIG_S...
3312
  		must not be both defined at the same time.
95579793b   Tom Rini   README: document ...
3313
  		CONFIG_SPL_MAX_SIZE
6ebc34611   Albert ARIBAUD   ARM: fix CONFIG_S...
3314
3315
3316
3317
  		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 ...
3318

04e5ae793   Wolfgang Denk   Minor coding styl...
3319
3320
  		CONFIG_SPL_TEXT_BASE
  		TEXT_BASE for linking the SPL binary.
6a11cf48a   Daniel Schwierzeck   spl: add initial ...
3321

94a45bb19   Scott Wood   powerpc/mpc85xx/p...
3322
3323
3324
  		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 ...
3325
3326
3327
3328
  		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...
3329
3330
3331
  		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...
3332
  		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
6ebc34611   Albert ARIBAUD   ARM: fix CONFIG_S...
3333
  		must not be both defined at the same time.
95579793b   Tom Rini   README: document ...
3334
3335
3336
  
  		CONFIG_SPL_STACK
  		Adress of the start of the stack SPL will use
8c80eb3b5   Albert ARIBAUD \(3ADEV\)   Introduce CONFIG_...
3337
3338
3339
3340
3341
3342
3343
3344
3345
  		CONFIG_SPL_PANIC_ON_RAW_IMAGE
  		When defined, SPL will panic() if the image it has
  		loaded does not have a signature.
  		Defining this is useful when code which loads images
  		in SPL cannot guarantee that absolutely all read errors
  		will be caught.
  		An example is the LPC32XX MLC NAND driver, which will
  		consider that a completely unreadable NAND block is bad,
  		and thus should be skipped silently.
94a45bb19   Scott Wood   powerpc/mpc85xx/p...
3346
3347
3348
3349
  		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 ...
3350
3351
3352
3353
3354
  		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 ...
3355

47f7bcae8   Tom Rini   SPL: Move the oma...
3356
3357
3358
3359
  		CONFIG_SPL_FRAMEWORK
  		Enable the SPL framework under common/.  This framework
  		supports MMC, NAND and YMODEM loading of U-Boot and NAND
  		NAND loading of the Linux Kernel.
9607faf20   Tom Rini   README: Add CONFI...
3360
3361
3362
  		CONFIG_SPL_OS_BOOT
  		Enable booting directly to an OS from SPL.
  		See also: doc/README.falcon
861a86f46   Tom Rini   omap-common: SPL:...
3363
3364
3365
  		CONFIG_SPL_DISPLAY_PRINT
  		For ARM, enable an optional function to print more information
  		about the running system.
4b919725b   Scott Wood   spl/powerpc: intr...
3366
3367
  		CONFIG_SPL_INIT_MINIMAL
  		Arch init code should be built for a very small image
04e5ae793   Wolfgang Denk   Minor coding styl...
3368
3369
  		CONFIG_SPL_LIBCOMMON_SUPPORT
  		Support for common/libcommon.o in SPL binary
6a11cf48a   Daniel Schwierzeck   spl: add initial ...
3370

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

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

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

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

95579793b   Tom Rini   README: document ...
3383
3384
  		CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
  		CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
e2ccdf89a   Paul Kocialkowski   MMC SD fs boot pa...
3385
  		Address and partition on the MMC to load U-Boot from
95579793b   Tom Rini   README: document ...
3386
  		when the MMC is being used in raw mode.
b97300b62   Paul Kocialkowski   spl: MMC U-Boot i...
3387
3388
3389
  		CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
  		Partition on the MMC to load U-Boot from when the MMC is being
  		used in raw mode
2b75b0ad3   Peter Korsgaard   spl_mmc: add Falc...
3390
3391
3392
3393
3394
3395
3396
3397
3398
  		CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
  		Sector to load kernel uImage from when MMC is being
  		used in raw mode (for Falcon mode)
  
  		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
  		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
  		Sector and number of sectors to load kernel argument
  		parameters from when MMC is being used in raw mode
  		(for falcon mode)
e2ccdf89a   Paul Kocialkowski   MMC SD fs boot pa...
3399
3400
3401
  		CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
  		Partition on the MMC to load U-Boot from when the MMC is being
  		used in fs mode
95579793b   Tom Rini   README: document ...
3402
3403
  		CONFIG_SPL_FAT_SUPPORT
  		Support for fs/fat/libfat.o in SPL binary
fae81c72c   Guillaume GARDET   doc: Update docum...
3404
3405
  		CONFIG_SPL_EXT_SUPPORT
  		Support for EXT filesystem in SPL binary
95579793b   Tom Rini   README: document ...
3406

fae81c72c   Guillaume GARDET   doc: Update docum...
3407
3408
3409
3410
  		CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
  		Filename to read to load U-Boot when reading from filesystem
  
  		CONFIG_SPL_FS_LOAD_KERNEL_NAME
7ad2cc796   Peter Korsgaard   spl_mmc: add Falc...
3411
  		Filename to read to load kernel uImage when reading
fae81c72c   Guillaume GARDET   doc: Update docum...
3412
  		from filesystem (for Falcon mode)
7ad2cc796   Peter Korsgaard   spl_mmc: add Falc...
3413

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

06f60ae3e   Scott Wood   powerpc/mpc83xx: ...
3418
3419
3420
3421
3422
  		CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
  		Set this for NAND SPL on PPC mpc83xx targets, so that
  		start.S waits for the rest of the SPL to load before
  		continuing (the hardware starts execution after just
  		loading the first page rather than the full 4K).
651fcf601   Prabhakar Kushwaha   powerpc:Add suppo...
3423
3424
  		CONFIG_SPL_SKIP_RELOCATE
  		Avoid SPL relocation
6f2f01b9f   Scott Wood   spl/nand: introdu...
3425
3426
3427
3428
3429
3430
3431
3432
3433
  		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 ...
3434
  		CONFIG_SPL_NAND_SIMPLE
7d4b79552   Scott Wood   spl/nand: config ...
3435
3436
  		Support for NAND boot using simple NAND drivers that
  		expose the cmd_ctrl() interface.
95579793b   Tom Rini   README: document ...
3437

6dd3b5668   Tom Rini   mtd: Add a CONFIG...
3438
3439
3440
  		CONFIG_SPL_MTD_SUPPORT
  		Support for the MTD subsystem within SPL.  Useful for
  		environment on NAND support within SPL.
0c3117b1f   Heiko Schocher   spl, nand: add op...
3441
3442
3443
  		CONFIG_SPL_NAND_RAW_ONLY
  		Support to boot only raw u-boot.bin images. Use this only
  		if you need to save space.
bb0dc1084   Ying Zhang   powerpc: mpc85xx:...
3444
3445
  		CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
  		Set for the SPL on PPC mpc8xxx targets, support for
5614e71b4   York Sun   Driver/DDR: Movin...
3446
  		drivers/ddr/fsl/libddr.o in SPL binary.
bb0dc1084   Ying Zhang   powerpc: mpc85xx:...
3447

7c8eea59b   Ying Zhang   powerpc: p1022ds:...
3448
3449
3450
  		CONFIG_SPL_COMMON_INIT_DDR
  		Set for common ddr init with serial presence detect in
  		SPL binary.
95579793b   Tom Rini   README: document ...
3451
3452
3453
3454
3455
3456
  		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 ...
3457
  		to read U-Boot
95579793b   Tom Rini   README: document ...
3458

fbe76ae4e   Prabhakar Kushwaha   board/freescale:R...
3459
3460
  		CONFIG_SPL_NAND_BOOT
  		Add support NAND boot
95579793b   Tom Rini   README: document ...
3461
  		CONFIG_SYS_NAND_U_BOOT_OFFS
7d4b79552   Scott Wood   spl/nand: config ...
3462
3463
3464
3465
3466
3467
3468
  		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 ...
3469
3470
  
  		CONFIG_SYS_NAND_U_BOOT_START
7d4b79552   Scott Wood   spl/nand: config ...
3471
  		Entry point in loaded image to jump to
95579793b   Tom Rini   README: document ...
3472
3473
3474
  
  		CONFIG_SYS_NAND_HW_ECC_OOBFIRST
  		Define this if you need to first read the OOB and then the
b445bbb49   Jeremiah Mahler   doc: fix grammati...
3475
  		data. This is used, for example, on davinci platforms.
95579793b   Tom Rini   README: document ...
3476
3477
3478
3479
  
  		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...
3480
3481
  		CONFIG_SPL_SERIAL_SUPPORT
  		Support for drivers/serial/libserial.o in SPL binary
6a11cf48a   Daniel Schwierzeck   spl: add initial ...
3482

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

04e5ae793   Wolfgang Denk   Minor coding styl...
3486
3487
  		CONFIG_SPL_SPI_SUPPORT
  		Support for drivers/spi/libspi.o in SPL binary
c57b953da   Pavel Machek   SPL: Add support ...
3488
3489
3490
  
  		CONFIG_SPL_RAM_DEVICE
  		Support for running image already present in ram, in SPL binary
6a11cf48a   Daniel Schwierzeck   spl: add initial ...
3491

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

ba1bee43e   Ying Zhang   common/Makefile: ...
3495
3496
3497
3498
3499
3500
3501
  		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...
3502
  		CONFIG_SPL_PAD_TO
6113d3f27   Benoît Thébaudeau   Makefile: Change ...
3503
3504
3505
3506
3507
  		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...
3508

ca2fca223   Scott Wood   spl: introduce CO...
3509
3510
3511
3512
  		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...
3513
3514
3515
3516
3517
  		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...
3518
3519
3520
3521
3522
3523
3524
  - 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...
3525
3526
3527
  		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...
3528

c609719b8   wdenk   Initial revision
3529
3530
  Modem Support:
  --------------
566e5cf45   Wolfgang Denk   ARM: drop unsuppo...
3531
  [so far only for SMDK2400 boards]
c609719b8   wdenk   Initial revision
3532

11ccc33fa   Marcel Ziswiler   Many spelling fix...
3533
  - Modem support enable:
c609719b8   wdenk   Initial revision
3534
3535
3536
3537
3538
3539
3540
  		CONFIG_MODEM_SUPPORT
  
  - RTS/CTS Flow control enable:
  		CONFIG_HWFLOW
  
  - Modem debug support:
  		CONFIG_MODEM_SUPPORT_DEBUG
43d9616cf   wdenk   * Patch by Robert...
3541
3542
  		Enables debugging stuff (char screen[1024], dbg())
  		for modem support. Useful only with BDI2000.
c609719b8   wdenk   Initial revision
3543

a8c7c708a   wdenk   * Patch by Gleb N...
3544
  - Interrupt support (PPC):
d4ca31c40   wdenk   * Cleanup lowboot...
3545
3546
  		There are common interrupt_init() and timer_interrupt()
  		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
11ccc33fa   Marcel Ziswiler   Many spelling fix...
3547
  		for CPU specific initialization. interrupt_init_cpu()
d4ca31c40   wdenk   * Cleanup lowboot...
3548
  		should set decrementer_count to appropriate value. If
11ccc33fa   Marcel Ziswiler   Many spelling fix...
3549
  		CPU resets decrementer automatically after interrupt
d4ca31c40   wdenk   * Cleanup lowboot...
3550
  		(ppc4xx) it should set decrementer_count to zero.
11ccc33fa   Marcel Ziswiler   Many spelling fix...
3551
  		timer_interrupt() calls timer_interrupt_cpu() for CPU
d4ca31c40   wdenk   * Cleanup lowboot...
3552
3553
3554
  		specific handling. If board has watchdog / status_led
  		/ other_activity_monitor it works automatically from
  		general timer_interrupt().
a8c7c708a   wdenk   * Patch by Gleb N...
3555

c609719b8   wdenk   Initial revision
3556
  - General:
43d9616cf   wdenk   * Patch by Robert...
3557
3558
3559
  		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...
3560
  		(autoboot). The key_pressed() function is called from
43d9616cf   wdenk   * Patch by Robert...
3561
3562
3563
  		board_init(). Currently key_pressed() is a dummy
  		function, returning 1 and thus enabling modem
  		initialization.
c609719b8   wdenk   Initial revision
3564

43d9616cf   wdenk   * Patch by Robert...
3565
3566
3567
  		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...
3568
  		suppressed, though.
c609719b8   wdenk   Initial revision
3569
3570
  
  		See also: doc/README.Modem
9660e442d   Helmut Raiger   cosmetic: s/BOARD...
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
  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
3585

c609719b8   wdenk   Initial revision
3586
3587
  Configuration Settings:
  -----------------------
4d1fd7f1a   York Sun   Add 64-bit data s...
3588
3589
  - CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
  		Optionally it can be defined to support 64-bit memory commands.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3590
  - CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
c609719b8   wdenk   Initial revision
3591
  		undefine this when you're short of memory.
2fb2604d5   Peter Tyser   Command usage cle...
3592
3593
  - 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...
3594
  - CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
c609719b8   wdenk   Initial revision
3595
  		prompt for user input.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3596
  - CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
c609719b8   wdenk   Initial revision
3597

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

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

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3602
  - CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
c609719b8   wdenk   Initial revision
3603
3604
  		the application (usually a Linux kernel) when it is
  		booted
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3605
  - CONFIG_SYS_BAUDRATE_TABLE:
c609719b8   wdenk   Initial revision
3606
  		List of legal baudrate settings for this board.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3607
  - CONFIG_SYS_CONSOLE_INFO_QUIET
8bde7f776   wdenk   * Code cleanup:
3608
  		Suppress display of console information at boot.
c609719b8   wdenk   Initial revision
3609

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3610
  - CONFIG_SYS_CONSOLE_IS_IN_ENV
8bde7f776   wdenk   * Code cleanup:
3611
3612
3613
  		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
3614
  		serial port, else the settings in the environment are used.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3615
  - CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
8bde7f776   wdenk   * Code cleanup:
3616
  		Enable the call to overwrite_console().
c609719b8   wdenk   Initial revision
3617

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3618
  - CONFIG_SYS_CONSOLE_ENV_OVERWRITE
c609719b8   wdenk   Initial revision
3619
  		Enable overwrite of previous console environment settings.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3620
  - CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
c609719b8   wdenk   Initial revision
3621
3622
  		Begin and End addresses of the area used by the
  		simple memory test.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3623
  - CONFIG_SYS_ALT_MEMTEST:
8bde7f776   wdenk   * Code cleanup:
3624
  		Enable an alternate, more extensive memory test.
c609719b8   wdenk   Initial revision
3625

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3626
  - CONFIG_SYS_MEMTEST_SCRATCH:
5f535fe17   wdenk   * Patches by Ande...
3627
3628
  		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...
3629
3630
  - 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_...
3631
  		this specified memory area will get subtracted from the top
11ccc33fa   Marcel Ziswiler   Many spelling fix...
3632
  		(end) of RAM and won't get "touched" at all by U-Boot. By
14f73ca67   Stefan Roese   ppc: Add CFG_MEM_...
3633
3634
3635
  		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...
3636
  		board ports in arch/powerpc with bootwrapper support that
14f73ca67   Stefan Roese   ppc: Add CFG_MEM_...
3637
  		recalculate the memory size from the SDRAM controller setup
5e12e75d1   Stefan Roese   ppc: Small change...
3638
  		will have to get fixed in Linux additionally.
14f73ca67   Stefan Roese   ppc: Add CFG_MEM_...
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
  
  		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...
3649
  - CONFIG_SYS_LOADS_BAUD_CHANGE:
c609719b8   wdenk   Initial revision
3650
  		Enable temporary baudrate change while serial download
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3651
  - CONFIG_SYS_SDRAM_BASE:
c609719b8   wdenk   Initial revision
3652
  		Physical start address of SDRAM. _Must_ be 0 here.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3653
  - CONFIG_SYS_MBIO_BASE:
c609719b8   wdenk   Initial revision
3654
3655
  		Physical start address of Motherboard I/O (if using a
  		Cogent motherboard)
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3656
  - CONFIG_SYS_FLASH_BASE:
c609719b8   wdenk   Initial revision
3657
  		Physical start address of Flash memory.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3658
  - CONFIG_SYS_MONITOR_BASE:
c609719b8   wdenk   Initial revision
3659
3660
  		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 ...
3661
  		(CONFIG_SYS_TEXT_BASE) used when linking) - same as
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3662
  		CONFIG_SYS_FLASH_BASE when booting from flash.
c609719b8   wdenk   Initial revision
3663

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3664
  - CONFIG_SYS_MONITOR_LEN:
8bde7f776   wdenk   * Code cleanup:
3665
3666
3667
3668
  		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
3669

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3670
  - CONFIG_SYS_MALLOC_LEN:
c609719b8   wdenk   Initial revision
3671
  		Size of DRAM reserved for malloc() use.
d59476b64   Simon Glass   Add a simple mall...
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
  - CONFIG_SYS_MALLOC_F_LEN
  		Size of the malloc() pool for use before relocation. If
  		this is defined, then a very simple malloc() implementation
  		will become available before relocation. The address is just
  		below the global data, and the stack is moved down to make
  		space.
  
  		This feature allocates regions with increasing addresses
  		within the region. calloc() is supported, but realloc()
  		is not available. free() is supported but does nothing.
b445bbb49   Jeremiah Mahler   doc: fix grammati...
3682
  		The memory will be freed (or in fact just forgotten) when
d59476b64   Simon Glass   Add a simple mall...
3683
  		U-Boot relocates itself.
e7b14e9ab   Simon Glass   dm: Fix repeated ...
3684
  		Pre-relocation malloc() is only supported on ARM and sandbox
29afe9e6e   Simon Glass   sandbox: Support ...
3685
  		at present but is fairly easy to enable for other archs.
38687ae67   Simon Glass   dm: Update docume...
3686
3687
3688
3689
  - CONFIG_SYS_MALLOC_SIMPLE
  		Provides a simple and small malloc() and calloc() for those
  		boards which do not use the full malloc in SPL (which is
  		enabled with CONFIG_SYS_SPL_MALLOC_START).
1dfdd9ba4   Thierry Reding   ARM: Implement no...
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
  - CONFIG_SYS_NONCACHED_MEMORY:
  		Size of non-cached memory area. This area of memory will be
  		typically located right below the malloc() area and mapped
  		uncached in the MMU. This is useful for drivers that would
  		otherwise require a lot of explicit cache maintenance. For
  		some drivers it's also impossible to properly maintain the
  		cache. For example if the regions that need to be flushed
  		are not a multiple of the cache-line size, *and* padding
  		cannot be allocated between the regions to align them (i.e.
  		if the HW requires a contiguous array of regions, and the
  		size of each region is not cache-aligned), then a flush of
  		one region may result in overwriting data that hardware has
  		written to another region in the same cache-line. This can
  		happen for example in network drivers where descriptors for
  		buffers are typically smaller than the CPU cache-line (e.g.
  		16 bytes vs. 32 or 64 bytes).
  
  		Non-cached memory is only supported on 32-bit ARM at present.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3708
  - CONFIG_SYS_BOOTM_LEN:
15940c9af   Stefan Roese   Change max size o...
3709
3710
  		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...
3711
  		you can define CONFIG_SYS_BOOTM_LEN in your board config file
15940c9af   Stefan Roese   Change max size o...
3712
  		to adjust this setting to your needs.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3713
  - CONFIG_SYS_BOOTMAPSZ:
c609719b8   wdenk   Initial revision
3714
3715
  		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...
3716
3717
  		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...
3718
  		environment variable is defined and non-zero. In such case
7d721e34a   Bartlomiej Sieka   Boot-related docu...
3719
  		all data for the Linux kernel must be between "bootm_low"
c0f40859f   Wolfgang Denk   README: white-spa...
3720
  		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.	 The environment
c3624e6ed   Grant Likely   Default to bootm_...
3721
3722
3723
  		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
3724

fca43cc80   John Rigby   boot: change some...
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
  - 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...
3737
  - CONFIG_SYS_MAX_FLASH_BANKS:
c609719b8   wdenk   Initial revision
3738
  		Max number of Flash memory banks
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3739
  - CONFIG_SYS_MAX_FLASH_SECT:
c609719b8   wdenk   Initial revision
3740
  		Max number of sectors on a Flash chip
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3741
  - CONFIG_SYS_FLASH_ERASE_TOUT:
c609719b8   wdenk   Initial revision
3742
  		Timeout for Flash erase operations (in ms)
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3743
  - CONFIG_SYS_FLASH_WRITE_TOUT:
c609719b8   wdenk   Initial revision
3744
  		Timeout for Flash write operations (in ms)
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3745
  - CONFIG_SYS_FLASH_LOCK_TOUT
8564acf93   wdenk   * Patches by Yuli...
3746
  		Timeout for Flash set sector lock bit operation (in ms)
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3747
  - CONFIG_SYS_FLASH_UNLOCK_TOUT
8564acf93   wdenk   * Patches by Yuli...
3748
  		Timeout for Flash clear lock bits operation (in ms)
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3749
  - CONFIG_SYS_FLASH_PROTECTION
8564acf93   wdenk   * Patches by Yuli...
3750
3751
  		If defined, hardware flash sectors protection is used
  		instead of U-Boot software protection.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3752
  - CONFIG_SYS_DIRECT_FLASH_TFTP:
c609719b8   wdenk   Initial revision
3753
3754
3755
3756
3757
3758
3759
3760
  
  		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...
3761
3762
  		the flash, but in some situations (when system RAM is
  		too limited to allow for a temporary copy of the
c609719b8   wdenk   Initial revision
3763
  		downloaded image) this option may be very useful.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3764
  - CONFIG_SYS_FLASH_CFI:
43d9616cf   wdenk   * Patch by Robert...
3765
  		Define if the flash driver uses extra elements in the
5653fc335   wdenk   * Patch by Yuli B...
3766
  		common flash structure for storing flash geometry.
00b1883a4   Jean-Christophe PLAGNIOL-VILLARD   drivers/mtd: Move...
3767
  - CONFIG_FLASH_CFI_DRIVER
5653fc335   wdenk   * Patch by Yuli B...
3768
3769
  		This option also enables the building of the cfi_flash driver
  		in the drivers directory
c609719b8   wdenk   Initial revision
3770

91809ed51   Piotr Ziecik   cfi-mtd: Add cfi-...
3771
3772
3773
3774
  - 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...
3775
  - CONFIG_SYS_FLASH_USE_BUFFER_WRITE
96ef831f7   Guennadi Liakhovetski   cfi_flash: Suppor...
3776
3777
3778
3779
3780
  		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...
3781
  - CONFIG_SYS_FLASH_QUIET_TEST
5568e613e   Stefan Roese   Add support for P...
3782
3783
3784
3785
  		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...
3786
3787
3788
3789
  - 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...
3790
3791
3792
3793
3794
3795
3796
3797
  - 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...
3798
  - CONFIG_SYS_RX_ETH_BUFFER:
11ccc33fa   Marcel Ziswiler   Many spelling fix...
3799
3800
  		Defines the number of Ethernet receive buffers. On some
  		Ethernet controllers it is recommended to set this value
53cf9435c   stroese   - CFG_RX_ETH_BUFF...
3801
3802
  		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...
3803
  		on high Ethernet traffic.
53cf9435c   stroese   - CFG_RX_ETH_BUFF...
3804
  		Defaults to 4 if not defined.
ea882baf9   Wolfgang Denk   New implementatio...
3805
  - CONFIG_ENV_MAX_ENTRIES
071bc9233   Wolfgang Denk   Coding Style cleanup
3806
3807
3808
3809
3810
  	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...
3811

2598090b7   Joe Hershberger   env: Add environm...
3812
3813
  - CONFIG_ENV_FLAGS_LIST_DEFAULT
  - CONFIG_ENV_FLAGS_LIST_STATIC
1bce2aeb6   Robert P. J. Day   Cosmetic: Fix a n...
3814
  	Enable validation of the values given to environment variables when
2598090b7   Joe Hershberger   env: Add environm...
3815
3816
3817
3818
3819
3820
  	calling env set.  Variables can be restricted to only decimal,
  	hexadecimal, or boolean.  If CONFIG_CMD_NET is also defined,
  	the variables can also be restricted to IP address or MAC address.
  
  	The format of the list is:
  		type_attribute = [s|d|x|b|i|m]
b445bbb49   Jeremiah Mahler   doc: fix grammati...
3821
3822
  		access_attribute = [a|r|o|c]
  		attributes = type_attribute[access_attribute]
2598090b7   Joe Hershberger   env: Add environm...
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
  		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 ...
3833
3834
3835
3836
3837
  	The access attributes are:
  		a - Any (default)
  		r - Read-only
  		o - Write-once
  		c - Change-default
2598090b7   Joe Hershberger   env: Add environm...
3838
3839
  	- CONFIG_ENV_FLAGS_LIST_DEFAULT
  		Define this to a list (string) to define the ".flags"
b445bbb49   Jeremiah Mahler   doc: fix grammati...
3840
  		environment variable in the default or embedded environment.
2598090b7   Joe Hershberger   env: Add environm...
3841
3842
3843
3844
3845
3846
3847
  
  	- 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 ...
3848
3849
3850
  - 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...
3851
3852
3853
3854
3855
3856
  - 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
0a12e6872   Masahiro Yamada   generic-board: mo...
3857
3858
3859
  	must support it (i.e. must select HAVE_GENERIC_BOARD in arch/Kconfig).
  	If you find problems enabling this option on your board please report
  	the problem and send patches!
5c1a7ea6a   Simon Glass   __HAVE_ARCH_GENER...
3860

0b1b60c77   Lokesh Vutla   ARM: OMAP5: Fix w...
3861
3862
3863
  - CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
  	This is set by OMAP boards for the max time that reset should
  	be asserted. See doc/README.omap-reset-time for details on how
b445bbb49   Jeremiah Mahler   doc: fix grammati...
3864
  	the value can be calculated on a given board.
632efa744   Simon Glass   Add CONFIG_SYS_SY...
3865

0d296cc2d   Gabe Black   Provide option to...
3866
3867
3868
3869
  - CONFIG_USE_STDINT
  	If stdint.h is available with your toolchain you can define this
  	option to enable it. You can provide option 'USE_STDINT=1' when
  	building U-Boot to enable this.
c609719b8   wdenk   Initial revision
3870
3871
3872
  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...
3873
3874
3875
3876
  - 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...
3877
  - CONFIG_ENV_IS_IN_FLASH:
c609719b8   wdenk   Initial revision
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
  
  	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...
3892
  	- CONFIG_ENV_OFFSET:
c609719b8   wdenk   Initial revision
3893
3894
3895
3896
3897
  
  	   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...
3898
  	   CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
c609719b8   wdenk   Initial revision
3899

0e8d15866   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ENV ma...
3900
  	- CONFIG_ENV_ADDR:
c609719b8   wdenk   Initial revision
3901
3902
3903
  
  	   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...
3904
  	   CONFIG_ENV_OFFSET).
c609719b8   wdenk   Initial revision
3905

0e8d15866   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ENV ma...
3906
  	- CONFIG_ENV_SECT_SIZE:
c609719b8   wdenk   Initial revision
3907
3908
3909
3910
3911
3912
3913
  
  	   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...
3914
  	- CONFIG_ENV_SIZE:
c609719b8   wdenk   Initial revision
3915

5a1aceb06   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ENV_IS...
3916
  	   If you use this in combination with CONFIG_ENV_IS_IN_FLASH
0e8d15866   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ENV ma...
3917
  	   and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
c609719b8   wdenk   Initial revision
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
  	   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...
3930
3931
  	- CONFIG_ENV_ADDR_REDUND
  	  CONFIG_ENV_SIZE_REDUND
c609719b8   wdenk   Initial revision
3932

43d9616cf   wdenk   * Patch by Robert...
3933
  	   These settings describe a second storage area used to hold
11ccc33fa   Marcel Ziswiler   Many spelling fix...
3934
  	   a redundant copy of the environment data, so that there is
3e38691e8   wdenk   * Patch by Arun D...
3935
  	   a valid backup copy in case there is a power failure during
43d9616cf   wdenk   * Patch by Robert...
3936
  	   a "saveenv" operation.
c609719b8   wdenk   Initial revision
3937
3938
3939
3940
  
  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...
3941
  - CONFIG_ENV_IS_IN_NVRAM:
c609719b8   wdenk   Initial revision
3942
3943
3944
3945
  
  	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...
3946
3947
  	- CONFIG_ENV_ADDR:
  	- CONFIG_ENV_SIZE:
c609719b8   wdenk   Initial revision
3948

11ccc33fa   Marcel Ziswiler   Many spelling fix...
3949
  	  These two #defines are used to determine the memory area you
c609719b8   wdenk   Initial revision
3950
3951
3952
3953
3954
  	  want to use for environment. It is assumed that this memory
  	  can just be read and written to, without any special
  	  provision.
  
  BE CAREFUL! The first access to the environment happens quite early
b445bbb49   Jeremiah Mahler   doc: fix grammati...
3955
  in U-Boot initialization (when we try to get the setting of for the
11ccc33fa   Marcel Ziswiler   Many spelling fix...
3956
  console baudrate). You *MUST* have mapped your NVRAM area then, or
c609719b8   wdenk   Initial revision
3957
3958
3959
3960
3961
3962
  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...
3963
  - CONFIG_ENV_IS_IN_EEPROM:
c609719b8   wdenk   Initial revision
3964
3965
3966
  
  	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...
3967
3968
  	- CONFIG_ENV_OFFSET:
  	- CONFIG_ENV_SIZE:
c609719b8   wdenk   Initial revision
3969
3970
3971
  
  	  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...
3972
  	- CONFIG_SYS_I2C_EEPROM_ADDR:
c609719b8   wdenk   Initial revision
3973
3974
  	  If defined, specified the chip address of the EEPROM device.
  	  The default address is zero.
189d257b7   Christian Gmeiner   cmd_eeprom: make ...
3975
3976
  	- CONFIG_SYS_I2C_EEPROM_BUS:
  	  If defined, specified the i2c bus of the EEPROM device.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3977
  	- CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
c609719b8   wdenk   Initial revision
3978
3979
3980
  	  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...
3981
  	- CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
c609719b8   wdenk   Initial revision
3982
  	  If defined, the number of milliseconds to delay between
ba56f6257   wdenk   Patch by Travis S...
3983
  	  page writes.	The default is zero milliseconds.
c609719b8   wdenk   Initial revision
3984

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
3985
  	- CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
c609719b8   wdenk   Initial revision
3986
3987
  	  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...
3988
  	- CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
5cf91d6bd   wdenk   * Modify KUP4X bo...
3989
3990
3991
3992
3993
3994
3995
3996
3997
  	  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...
3998
  	- CONFIG_SYS_EEPROM_SIZE:
c609719b8   wdenk   Initial revision
3999
  	  The size in bytes of the EEPROM device.
548738b4d   Heiko Schocher   cmd_eeprom: I2C u...
4000
4001
4002
4003
4004
4005
4006
4007
  	- 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...
4008
  	  #define CONFIG_I2C_ENV_EEPROM_BUS	  1
548738b4d   Heiko Schocher   cmd_eeprom: I2C u...
4009
4010
4011
  
  	  EEPROM which holds the environment, is reached over
  	  a pca9547 i2c mux with address 0x70, channel 3.
c609719b8   wdenk   Initial revision
4012

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

d4ca31c40   wdenk   * Cleanup lowboot...
4015
  	Define this if you have a DataFlash memory device which you
5779d8d98   wdenk   * Patch by Nicola...
4016
  	want to use for the environment.
0e8d15866   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ENV ma...
4017
4018
4019
  	- CONFIG_ENV_OFFSET:
  	- CONFIG_ENV_ADDR:
  	- CONFIG_ENV_SIZE:
5779d8d98   wdenk   * Patch by Nicola...
4020
4021
4022
4023
  
  	  These three #defines specify the offset and size of the
  	  environment area within the total memory of your DataFlash placed
  	  at the specified address.
bd83b5921   Wu, Josh   README: document ...
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
  - CONFIG_ENV_IS_IN_SPI_FLASH:
  
  	Define this if you have a SPI Flash memory device which you
  	want to use for the environment.
  
  	- CONFIG_ENV_OFFSET:
  	- CONFIG_ENV_SIZE:
  
  	  These two #defines specify the offset and size of the
  	  environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
  	  aligned to an erase sector boundary.
  
  	- CONFIG_ENV_SECT_SIZE:
  
  	  Define the SPI flash's sector size.
  
  	- CONFIG_ENV_OFFSET_REDUND (optional):
  
  	  This setting describes a second storage area of CONFIG_ENV_SIZE
  	  size used to hold a redundant copy of the environment data, so
  	  that there is a valid backup copy in case there is a power failure
  	  during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
  	  aligned to an erase sector boundary.
  
  	- CONFIG_ENV_SPI_BUS (optional):
  	- CONFIG_ENV_SPI_CS (optional):
  
  	  Define the SPI bus and chip select. If not defined they will be 0.
  
  	- CONFIG_ENV_SPI_MAX_HZ (optional):
  
  	  Define the SPI max work clock. If not defined then use 1MHz.
  
  	- CONFIG_ENV_SPI_MODE (optional):
  
  	  Define the SPI work mode. If not defined then use SPI_MODE_3.
0a85a9e70   Liu Gang   powerpc/corenet_d...
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
  - 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...
4071
  	  space by SRIO or PCIE links.
0a85a9e70   Liu Gang   powerpc/corenet_d...
4072
4073
4074
  
  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...
4075
4076
  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...
4077

51bfee192   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ENV_IS...
4078
  - CONFIG_ENV_IS_IN_NAND:
13a5695b7   wdenk   Patch by Jian Zha...
4079
4080
4081
  
  	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...
4082
4083
  	- CONFIG_ENV_OFFSET:
  	- CONFIG_ENV_SIZE:
13a5695b7   wdenk   Patch by Jian Zha...
4084
4085
  
  	  These two #defines specify the offset and size of the environment
fdd813def   Scott Wood   README: Add new N...
4086
4087
  	  area within the first NAND device.  CONFIG_ENV_OFFSET must be
  	  aligned to an erase block boundary.
5779d8d98   wdenk   * Patch by Nicola...
4088

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

0e8d15866   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ENV ma...
4091
  	  This setting describes a second storage area of CONFIG_ENV_SIZE
fdd813def   Scott Wood   README: Add new N...
4092
4093
  	  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...
4094
  	  during a "saveenv" operation.	 CONFIG_ENV_OFFSET_RENDUND must be
fdd813def   Scott Wood   README: Add new N...
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
  	  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...
4112

b74ab7373   Guennadi Liakhovetski   nand_spl: read en...
4113
4114
4115
4116
4117
  - 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 ...
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
  - 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...
4132
4133
4134
4135
4136
  	- 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 ...
4137
4138
4139
4140
4141
  	- CONFIG_UBI_SILENCE_MSG
  	- CONFIG_UBIFS_SILENCE_MSG
  
  	  You will probably want to define these to avoid a really noisy system
  	  when storing the env in UBI.
d1db76f14   Wu, Josh   README: document ...
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
  - CONFIG_ENV_IS_IN_FAT:
         Define this if you want to use the FAT file system for the environment.
  
         - FAT_ENV_INTERFACE:
  
           Define this to a string that is the name of the block device.
  
         - FAT_ENV_DEV_AND_PART:
  
           Define this to a string to specify the partition of the device. It can
           be as following:
  
             "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
                 - "D:P": device D partition P. Error occurs if device D has no
                          partition table.
                 - "D:0": device D.
                 - "D" or "D:": device D partition 1 if device D has partition
                                table, or the whole device D if has no partition
                                table.
                 - "D:auto": first partition in device D with bootable flag set.
b445bbb49   Jeremiah Mahler   doc: fix grammati...
4162
                             If none, first valid partition in device D. If no
d1db76f14   Wu, Josh   README: document ...
4163
4164
4165
4166
4167
                             partition table then means device D.
  
         - FAT_ENV_FILE:
  
           It's a string of the FAT file name. This file use to store the
b445bbb49   Jeremiah Mahler   doc: fix grammati...
4168
           environment.
d1db76f14   Wu, Josh   README: document ...
4169
4170
  
         - CONFIG_FAT_WRITE:
b445bbb49   Jeremiah Mahler   doc: fix grammati...
4171
           This should be defined. Otherwise it cannot save the environment file.
d1db76f14   Wu, Josh   README: document ...
4172

06e4ae5f8   Stephen Warren   README: document ...
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
  - 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...
4193
4194
4195
4196
4197
4198
4199
  	  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 ...
4200
4201
4202
4203
4204
4205
4206
4207
4208
  	  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...
4209
4210
  	  This value may also be positive or negative; this is handled in the
  	  same way as CONFIG_ENV_OFFSET.
06e4ae5f8   Stephen Warren   README: document ...
4211
4212
4213
4214
4215
4216
4217
4218
  	  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...
4219
  - CONFIG_SYS_SPI_INIT_OFFSET
c609719b8   wdenk   Initial revision
4220
4221
4222
4223
4224
4225
4226
4227
  
  	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...
4228
  Please note that the environment is read-only until the monitor
c609719b8   wdenk   Initial revision
4229
  has been relocated to RAM and a RAM copy of the environment has been
cdb749778   Wolfgang Denk   Rename getenv_r()...
4230
  created; also, when using EEPROM you will have to use getenv_f()
c609719b8   wdenk   Initial revision
4231
  until then to read environment variables.
85ec0bcc1   wdenk   * Patch by Arun D...
4232
4233
4234
4235
4236
4237
  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
4238
4239
4240
  
  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...
4241
  use the "saveenv" command to store a valid environment.
c609719b8   wdenk   Initial revision
4242

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

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

f5675aa5c   Ron Madrid   Create configurat...
4251
4252
4253
4254
4255
4256
  - 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...
4257
4258
4259
4260
  - 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...
4261
4262
4263
4264
  - CONFIG_DISPLAY_BOARDINFO_LATE
  		Similar to the previous option, but display this information
  		later, once stdio is running and output goes to the LCD, if
  		present.
feb858012   Sascha Silbe   README: document ...
4265
4266
4267
4268
  - CONFIG_BOARD_SIZE_LIMIT:
  		Maximum size of the U-Boot image. When defined, the
  		build system checks that the actual size does not
  		exceed it.
c609719b8   wdenk   Initial revision
4269
  Low Level (hardware related) configuration options:
dc7c9a1a5   wdenk   * Patch by Rick B...
4270
  ---------------------------------------------------
c609719b8   wdenk   Initial revision
4271

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
4272
  - CONFIG_SYS_CACHELINE_SIZE:
c609719b8   wdenk   Initial revision
4273
  		Cache Line Size of the CPU.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
4274
  - CONFIG_SYS_DEFAULT_IMMR:
c609719b8   wdenk   Initial revision
4275
  		Default address of the IMMR after system reset.
2535d6027   wdenk   * Patch by Martin...
4276

42d1f0394   wdenk   * Patches by Xian...
4277
4278
4279
  		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
4280

e46fedfeb   Timur Tabi   powerpc/85xx: int...
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
  - 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...
4295
  		be set to that address.	 Otherwise, it should be set to the
e46fedfeb   Timur Tabi   powerpc/85xx: int...
4296
4297
4298
4299
4300
4301
4302
4303
  		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...
4304
4305
  		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...
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
  		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,...
4317
  - Floppy Disk Support:
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
4318
  		CONFIG_SYS_FDC_DRIVE_NUMBER
7f6c2cbc2   wdenk   * Vince Husovsky,...
4319
4320
  
  		the default drive number (default value 0)
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
4321
  		CONFIG_SYS_ISA_IO_STRIDE
7f6c2cbc2   wdenk   * Vince Husovsky,...
4322

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

43d9616cf   wdenk   * Patch by Robert...
4327
4328
  		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...
4329
  		the FDC chipset. (default value 0)
7f6c2cbc2   wdenk   * Vince Husovsky,...
4330

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
4331
4332
  		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...
4333
  		default value.
7f6c2cbc2   wdenk   * Vince Husovsky,...
4334

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

0abddf82d   Macpaul Lin   cmd_ide: enhance ...
4341
4342
4343
4344
4345
4346
  - CONFIG_IDE_AHB:
  		Most IDE controllers were designed to be connected with PCI
  		interface. Only few of them were designed for AHB interface.
  		When software is doing ATA command and data transfer to
  		IDE devices through IDE-AHB controller, some additional
  		registers accessing to these kind of IDE-AHB controller
b445bbb49   Jeremiah Mahler   doc: fix grammati...
4347
  		is required.
0abddf82d   Macpaul Lin   cmd_ide: enhance ...
4348

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

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

7152b1d0b   wdenk   * Add support for...
4355
  		Start address of memory area that can be used for
c609719b8   wdenk   Initial revision
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
  		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...
4367
  - CONFIG_SYS_GBL_DATA_OFFSET:
c609719b8   wdenk   Initial revision
4368
4369
  
  		Offset of the initial data structure in the memory
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
4370
4371
  		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
  		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
c609719b8   wdenk   Initial revision
4372
  		data is located at the end of the available space
553f09823   Wolfgang Denk   Rename CONFIG_SYS...
4373
  		(sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
4374
4375
4376
  		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
4377
4378
4379
4380
  
  	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...
4381
  		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
c609719b8   wdenk   Initial revision
4382
4383
  		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...
4384
  - CONFIG_SYS_SIUMCR:	SIU Module Configuration (11-6)
c609719b8   wdenk   Initial revision
4385

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

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

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

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

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

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
4396
  - CONFIG_SYS_OR_TIMING_SDRAM:
c609719b8   wdenk   Initial revision
4397
  		SDRAM timing
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
4398
  - CONFIG_SYS_MAMR_PTA:
c609719b8   wdenk   Initial revision
4399
  		periodic timer for refresh
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
4400
  - CONFIG_SYS_DER:	Debug Event Register (37-47)
c609719b8   wdenk   Initial revision
4401

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
4402
4403
4404
4405
  - 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
4406
4407
4408
  		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...
4409
4410
    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
4411
  		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
4412
4413
  - 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
4414
4415
  		Machine Mode Register and Memory Periodic Timer
  		Prescaler definitions (SDRAM timing)
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
4416
  - CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
c609719b8   wdenk   Initial revision
4417
4418
  		enable I2C microcode relocation patch (MPC8xx);
  		define relocation offset in DPRAM [DSP2]
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
4419
  - CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
b423d055c   Heiko Schocher   Enable SMC microc...
4420
4421
  		enable SMC microcode relocation patch (MPC8xx);
  		define relocation offset in DPRAM [SMC1]
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
4422
  - CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
c609719b8   wdenk   Initial revision
4423
4424
  		enable SPI microcode relocation patch (MPC8xx);
  		define relocation offset in DPRAM [SCC4]
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
4425
  - CONFIG_SYS_USE_OSCCLK:
c609719b8   wdenk   Initial revision
4426
4427
4428
  		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...
4429
  - CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
43d9616cf   wdenk   * Patch by Robert...
4430
4431
4432
4433
  		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...
4434

6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
4435
4436
4437
4438
4439
4440
4441
4442
  - 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 ...
4443
  		Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
5d232d0e7   wdenk   * Patch by Dave E...
4444

9cacf4fc4   Dirk Eibach   ppc4xx: Add READM...
4445
4446
4447
  - CONFIG_PCI_DISABLE_PCIE:
  		Disable PCI-Express on systems where it is supported but not
  		required.
69fd2d3b0   Andrew Sharp   pci: add CONFIG_P...
4448
  - CONFIG_PCI_ENUM_ONLY
b445bbb49   Jeremiah Mahler   doc: fix grammati...
4449
  		Only scan through and get the devices on the buses.
69fd2d3b0   Andrew Sharp   pci: add CONFIG_P...
4450
4451
4452
4453
  		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...
4454
4455
  - CONFIG_PCI_INDIRECT_BRIDGE:
  		Enable support for indirect PCI bridges.
a09b9b68d   Kumar Gala   powerpc/8xxx: Ref...
4456
4457
4458
4459
4460
4461
4462
4463
  - 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...
4464
4465
  - CONFIG_SRIO_PCIE_BOOT_MASTER
  		Board can support master function for Boot from SRIO and PCIE
a09b9b68d   Kumar Gala   powerpc/8xxx: Ref...
4466
4467
4468
4469
4470
4471
4472
4473
  - 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...
4474
4475
4476
4477
  - 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...
4478
  		Example of drivers that use it:
66bd1846e   Fabio Estevam   mtd: nand: Introd...
4479
  		- drivers/mtd/nand/ndfc.c
a430e9164   Fabio Estevam   mtd: nand: mxc_na...
4480
  		- drivers/mtd/nand/mxc_nand.c
eced4626e   Alex Waterman   NAND: Add 16bit N...
4481
4482
4483
4484
  
  - 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...
4485
  - CONFIG_SPD_EEPROM
218ca724c   Wolfgang Denk   README: update do...
4486
4487
  		Get DDR timing information from an I2C EEPROM. Common
  		with pluggable memory modules such as SODIMMs
bb99ad6d8   Ben Warren   Add support for m...
4488
4489
    SPD_EEPROM_ADDRESS
  		I2C address of the SPD EEPROM
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
4490
  - CONFIG_SYS_SPD_BUS_NUM
218ca724c   Wolfgang Denk   README: update do...
4491
4492
4493
  		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...
4494

1b3e3c4f2   York Sun   powerpc/mpc8xxx: ...
4495
4496
4497
4498
4499
  - 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...
4500
4501
  - CONFIG_FSL_DDR_INTERACTIVE
  		Enable interactive DDR debugging. See doc/README.fsl-ddr.
e32d59a2f   York Sun   driver/ddr/fsl: A...
4502
4503
  - CONFIG_FSL_DDR_SYNC_REFRESH
  		Enable sync of refresh for multiple controllers.
6d0f6bcf3   Jean-Christophe PLAGNIOL-VILLARD   rename CFG_ macro...
4504
  - CONFIG_SYS_83XX_DDR_USES_CS0
218ca724c   Wolfgang Denk   README: update do...
4505
4506
  		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...
4507

c26e454df   wdenk   Patches by Pantel...
4508
4509
4510
4511
4512
  - 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 ...
4513
4514
  		to the given FEC; i. e.
  			#define CONFIG_FEC1_PHY 4
c26e454df   wdenk   Patches by Pantel...
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
  		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...
4527
4528
4529
4530
4531
4532
4533
4534
4535
  - 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...
4536
4537
  - CONFIG_LOOPW
  		Add the "loopw" memory command. This only takes effect if
602ad3b33   Jon Loeliger   README: Rewrite c...
4538
  		the memory commands are activated globally (CONFIG_CMD_MEM).
56523f128   wdenk   * Patch by Martin...
4539

7b4666414   stroese   CONFIG_MX_CYCLIC ...
4540
4541
4542
4543
  - CONFIG_MX_CYCLIC
  		Add the "mdc" and "mwc" memory commands. These are cyclic
  		"md/mw" commands.
  		Examples:
efe2a4d5c   wdenk   Code cleanup.
4544
  		=> mdc.b 10 4 500
7b4666414   stroese   CONFIG_MX_CYCLIC ...
4545
  		This command will print 4 bytes (10,11,12,13) each 500 ms.
efe2a4d5c   wdenk   Code cleanup.
4546
  		=> mwc.l 100 12345678 10
7b4666414   stroese   CONFIG_MX_CYCLIC ...
4547
  		This command will write 12345678 to address 100 all 10 ms.
efe2a4d5c   wdenk   Code cleanup.
4548
  		This only takes effect if the memory commands are activated
602ad3b33   Jon Loeliger   README: Rewrite c...
4549
  		globally (CONFIG_CMD_MEM).
7b4666414   stroese   CONFIG_MX_CYCLIC ...
4550

8aa1a2d11   wdenk   Patch by Steven S...
4551
  - CONFIG_SKIP_LOWLEVEL_INIT
afc1ce828   Macpaul Lin   doc/README: docum...
4552
  		[ARM, NDS32, MIPS only] If this variable is defined, then certain
844f07d8a   Wolfgang Denk   Coding Style (whi...
4553
4554
4555
4556
4557
4558
4559
4560
  		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...
4561

401bb30b6   Aneesh V   replace CONFIG_PR...
4562
  - CONFIG_SPL_BUILD
df81238b3   Magnus Lilja   ARM1136: Introduc...
4563
4564
4565
  		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...
4566

3aa29de0b   Ying Zhang   TPL : introduce t...
4567
4568
4569
4570
  - 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: ...
4571
4572
4573
4574
  - 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...
4575
4576
4577
4578
4579
4580
4581
4582
  - 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...
4583
4584
4585
4586
4587
  - 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...
4588
4589
4590
  - 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...
4591

fc33705e6   Mark Jackson   Allow AM335x MPU ...
4592
4593
4594
4595
  - CONFIG_SYS_MPUCLK
  		Defines the MPU clock speed (in MHz).
  
  		NOTE : currently only supported on AM335x platforms.
5b5ece9ef   Gabe Black   x86: Allow compil...
4596

16678eb40   Heiko Schocher   arm, am33x: make ...
4597
4598
  - CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
  		Enables the RTC32K OSC on AM33xx based plattforms
999d7d326   Karicheri, Muralidharan   NAND: DaVinci: al...
4599
4600
4601
4602
  - CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
  		Option to disable subpage write in NAND driver
  		driver that uses this:
  		drivers/mtd/nand/davinci_nand.c
f2717b47e   Timur Tabi   powerpc/85xx: cle...
4603
4604
4605
4606
4607
4608
4609
4610
  Freescale QE/FMAN Firmware Support:
  -----------------------------------
  
  The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
  loading of "firmware", which is encoded in the QE firmware binary format.
  This firmware often needs to be loaded during U-Boot booting, so macros
  are used to identify the storage device (NOR flash, SPI, etc) and the address
  within that device.
dcf1d774b   Zhao Qiang   QE/FMAN: modify C...
4611
4612
4613
4614
4615
4616
4617
  - CONFIG_SYS_FMAN_FW_ADDR
  	The address in the storage device where the FMAN microcode is located.  The
  	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
  	is also specified.
  
  - CONFIG_SYS_QE_FW_ADDR
  	The address in the storage device where the QE microcode is located.  The
f2717b47e   Timur Tabi   powerpc/85xx: cle...
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
  	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...
4643
4644
4645
  - 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...
4646
4647
4648
  	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...
4649

b940ca64b   J. German Rivera   armv8/fsl-lsch3: ...
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
  Freescale Layerscape Management Complex Firmware Support:
  ---------------------------------------------------------
  The Freescale Layerscape Management Complex (MC) supports the loading of
  "firmware".
  This firmware often needs to be loaded during U-Boot booting, so macros
  are used to identify the storage device (NOR flash, SPI, etc) and the address
  within that device.
  
  - CONFIG_FSL_MC_ENET
  	Enable the MC driver for Layerscape SoCs.
  
  - CONFIG_SYS_LS_MC_FW_ADDR
  	The address in the storage device where the firmware is located.  The
  	meaning of this address depends on which CONFIG_SYS_LS_MC_FW_IN_xxx macro
  	is also specified.
  
  - CONFIG_SYS_LS_MC_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_LS_MC_FW_IN_NOR
  	Specifies that MC firmware is located in NOR flash, mapped as
  	normal addressable memory via the LBC. CONFIG_SYS_LS_MC_FW_ADDR is the
  	virtual address in NOR flash.
c609719b8   wdenk   Initial revision
4676
4677
  Building the Software:
  ======================
218ca724c   Wolfgang Denk   README: update do...
4678
4679
4680
4681
4682
4683
  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
4684

218ca724c   Wolfgang Denk   README: update do...
4685
4686
4687
4688
4689
  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
4690

218ca724c   Wolfgang Denk   README: update do...
4691
4692
  	$ CROSS_COMPILE=ppc_4xx-
  	$ export CROSS_COMPILE
c609719b8   wdenk   Initial revision
4693

2f8d396b9   Peter Tyser   Add support for b...
4694
4695
4696
4697
4698
4699
4700
4701
4702
  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...
4703
4704
  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
4705
  is done by typing:
ab584d67c   Holger Freyther   The _config targe...
4706
  	make NAME_defconfig
c609719b8   wdenk   Initial revision
4707

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

2729af9d5   wdenk   * Fix minor NAND ...
4711
4712
4713
4714
  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...
4715
        when choosing the configuration, i. e.
2729af9d5   wdenk   * Fix minor NAND ...
4716

ab584d67c   Holger Freyther   The _config targe...
4717
        make TQM823L_defconfig
2729af9d5   wdenk   * Fix minor NAND ...
4718
  	- will configure for a plain TQM823L, i. e. no LCD support
ab584d67c   Holger Freyther   The _config targe...
4719
        make TQM823L_LCD_defconfig
2729af9d5   wdenk   * Fix minor NAND ...
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
  	- 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...
4731
4732
4733
4734
4735
4736
4737
  By default the build is performed locally and the objects are saved
  in the source directory. One of the two methods can be used to change
  this behavior and build U-Boot to some external directory:
  
  1. Add O= to the make command line invocations:
  
  	make O=/tmp/build distclean
ab584d67c   Holger Freyther   The _config targe...
4738
  	make O=/tmp/build NAME_defconfig
baf312495   Marian Balakowicz   Add documentation...
4739
  	make O=/tmp/build all
adbba9960   Timo Ketola   doc: fix document...
4740
  2. Set environment variable KBUILD_OUTPUT to point to the desired location:
baf312495   Marian Balakowicz   Add documentation...
4741

adbba9960   Timo Ketola   doc: fix document...
4742
  	export KBUILD_OUTPUT=/tmp/build
baf312495   Marian Balakowicz   Add documentation...
4743
  	make distclean
ab584d67c   Holger Freyther   The _config targe...
4744
  	make NAME_defconfig
baf312495   Marian Balakowicz   Add documentation...
4745
  	make all
adbba9960   Timo Ketola   doc: fix document...
4746
  Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
baf312495   Marian Balakowicz   Add documentation...
4747
  variable.
2729af9d5   wdenk   * Fix minor NAND ...
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
  
  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...
4759
4760
      "boards.cfg" file, using the existing entries as examples.
      Follow the instructions there to keep the boards in order.
2729af9d5   wdenk   * Fix minor NAND ...
4761
4762
4763
4764
4765
4766
4767
  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.
ab584d67c   Holger Freyther   The _config targe...
4768
  4.  Run "make <board>_defconfig" with your new name.
2729af9d5   wdenk   * Fix minor NAND ...
4769
4770
4771
4772
4773
4774
4775
4776
  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...
4777
4778
  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 ...
4779
4780
  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...
4781
  official or latest in the git repository) version of U-Boot sources.
2729af9d5   wdenk   * Fix minor NAND ...
4782

218ca724c   Wolfgang Denk   README: update do...
4783
4784
  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 ...
4785
4786
  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...
4787
4788
4789
4790
  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 ...
4791
4792
4793
4794
4795
4796
  
  	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...
4797
4798
4799
4800
4801
4802
4803
  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...
4804
4805
4806
4807
  
  	export BUILD_DIR=/tmp/build
  	export MAKEALL_LOGDIR=/tmp/log
  	CROSS_COMPILE=ppc_8xx- MAKEALL
218ca724c   Wolfgang Denk   README: update do...
4808
4809
4810
  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...
4811

2729af9d5   wdenk   * Fix minor NAND ...
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
  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"...
4822
  bootz   - boot zImage from memory
2729af9d5   wdenk   * Fix minor NAND ...
4823
4824
4825
  tftpboot- boot image via network using TFTP protocol
  	       and env variables "ipaddr" and "serverip"
  	       (and eventually "gatewayip")
1fb7cd498   Simon Glass   net: tftpput: imp...
4826
  tftpput - upload a file via network using TFTP protocol
2729af9d5   wdenk   * Fix minor NAND ...
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
  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...
4838
  i2c	- I2C sub-system
2729af9d5   wdenk   * Fix minor NAND ...
4839
4840
4841
4842
4843
4844
4845
4846
  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...
4847
  nand	- NAND memory operations (see doc/README.nand)
2729af9d5   wdenk   * Fix minor NAND ...
4848
4849
4850
4851
4852
  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...
4853
  loopw	- infinite write loop on address range
2729af9d5   wdenk   * Fix minor NAND ...
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
  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
4877

2729af9d5   wdenk   * Fix minor NAND ...
4878
4879
4880
4881
4882
4883
  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
4884

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

2729af9d5   wdenk   * Fix minor NAND ...
4889
    baudrate	- see CONFIG_BAUDRATE
c609719b8   wdenk   Initial revision
4890

2729af9d5   wdenk   * Fix minor NAND ...
4891
    bootdelay	- see CONFIG_BOOTDELAY
c609719b8   wdenk   Initial revision
4892

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

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

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

7d721e34a   Bartlomiej Sieka   Boot-related docu...
4899
4900
4901
4902
4903
4904
    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_...
4905
4906
  		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
  		  bootm_mapsize.
c0f40859f   Wolfgang Denk   README: white-spa...
4907
    bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
c3624e6ed   Grant Likely   Default to bootm_...
4908
4909
4910
4911
4912
4913
  		  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...
4914
4915
4916
4917
4918
4919
  
    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...
4920
4921
4922
    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 ...
4923
4924
4925
4926
    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
4927

2729af9d5   wdenk   * Fix minor NAND ...
4928
4929
4930
4931
    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...
4932

2729af9d5   wdenk   * Fix minor NAND ...
4933
4934
4935
4936
4937
  		  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
4938

a28afca57   David A. Long   Add uboot "fdt_hi...
4939
4940
    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...
4941
4942
4943
4944
4945
4946
4947
  		  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...
4948
4949
4950
4951
4952
4953
  		  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...
4954
4955
4956
    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 ...
4957
4958
4959
4960
4961
    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 ...
4962
4963
4964
4965
4966
4967
    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...
4968
  		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
2729af9d5   wdenk   * Fix minor NAND ...
4969
4970
4971
4972
  		  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
4973

2729af9d5   wdenk   * Fix minor NAND ...
4974
4975
4976
4977
4978
4979
  		  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
4980

2729af9d5   wdenk   * Fix minor NAND ...
4981
  		  setenv initrd_high 00c00000
c609719b8   wdenk   Initial revision
4982

2729af9d5   wdenk   * Fix minor NAND ...
4983
4984
4985
4986
4987
4988
4989
  		  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
4990

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

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

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

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

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

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

2729af9d5   wdenk   * Fix minor NAND ...
5004
    bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
c609719b8   wdenk   Initial revision
5005

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

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

48690d802   Heiko Schocher   net ppc: fix ethe...
5011
5012
5013
5014
  		  => 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
5015

e16925773   Matthias Fuchs   net: add 'ethrota...
5016
5017
5018
    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...
5019
    netretry	- When set to "no" each network operation will
2729af9d5   wdenk   * Fix minor NAND ...
5020
5021
5022
5023
5024
5025
  		  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
5026

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

b445bbb49   Jeremiah Mahler   doc: fix grammati...
5029
    silent_linux  - If set then Linux will be told to boot silently, by
8d51aacd8   Simon Glass   RFC: bootm: Add s...
5030
5031
5032
5033
  		  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...
5034
    tftpsrcport	- If this is set, the value is used for TFTP's
ecb0ccd9c   Wolfgang Denk   Allow to force TF...
5035
  		  UDP source port.
28cb93758   Wolfgang Denk   Update for TFTP u...
5036
5037
    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...
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
    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...
5050
  		  Ethernet is encapsulated/received over 802.1q
2729af9d5   wdenk   * Fix minor NAND ...
5051
  		  VLAN tagged frames.
c609719b8   wdenk   Initial revision
5052

dc0b7b0e6   Jason Hobbs   README: document ...
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
  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...
5064
5065
5066
5067
5068
5069
  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 ...
5070

2729af9d5   wdenk   * Fix minor NAND ...
5071
5072
5073
  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
5074

2729af9d5   wdenk   * Fix minor NAND ...
5075
5076
5077
5078
5079
5080
5081
5082
5083
    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...
5084

c1551ea81   stroese   U-Boot version en...
5085

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

2729af9d5   wdenk   * Fix minor NAND ...
5088
5089
5090
    serial#	- contains hardware identification information such
  		  as type string and/or serial number
    ethaddr	- Ethernet address
c609719b8   wdenk   Initial revision
5091

2729af9d5   wdenk   * Fix minor NAND ...
5092
5093
5094
  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
5095

f07771cc2   wdenk   * Fix data abort ...
5096

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

2729af9d5   wdenk   * Fix minor NAND ...
5099
5100
5101
    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 ...
5102

f07771cc2   wdenk   * Fix data abort ...
5103

2729af9d5   wdenk   * Fix minor NAND ...
5104
5105
  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 ...
5106

f07771cc2   wdenk   * Fix data abort ...
5107

170ab1107   Joe Hershberger   env: Add support ...
5108
5109
5110
5111
  Callback functions for environment variables:
  ---------------------------------------------
  
  For some environment variables, the behavior of u-boot needs to change
b445bbb49   Jeremiah Mahler   doc: fix grammati...
5112
  when their values are changed.  This functionality allows functions to
170ab1107   Joe Hershberger   env: Add support ...
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
  be associated with arbitrary variables.  On creation, overwrite, or
  deletion, the callback will provide the opportunity for some side
  effect to happen or for the change to be rejected.
  
  The callbacks are named and associated with a function using the
  U_BOOT_ENV_CALLBACK macro in your board or driver code.
  
  These callbacks are associated with variables in one of two ways.  The
  static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
  in the board configuration to a string that defines a list of
  associations.  The list must be in the following format:
  
  	entry = variable_name[:callback_name]
  	list = entry[,list]
  
  If the callback name is not specified, then the callback is deleted.
  Spaces are also allowed anywhere in the list.
  
  Callbacks can also be associated by defining the ".callbacks" variable
  with the same list format above.  Any association in ".callbacks" will
  override any association in the static list. You can define
  CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
b445bbb49   Jeremiah Mahler   doc: fix grammati...
5135
  ".callbacks" environment variable in the default or embedded environment.
170ab1107   Joe Hershberger   env: Add support ...
5136

2729af9d5   wdenk   * Fix minor NAND ...
5137
5138
  Command Line Parsing:
  =====================
f07771cc2   wdenk   * Fix data abort ...
5139

2729af9d5   wdenk   * Fix minor NAND ...
5140
5141
  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
5142

2729af9d5   wdenk   * Fix minor NAND ...
5143
5144
  Old, simple command line parser:
  --------------------------------
c609719b8   wdenk   Initial revision
5145

2729af9d5   wdenk   * Fix minor NAND ...
5146
5147
  - supports environment variables (through setenv / saveenv commands)
  - several commands on one line, separated by ';'
fe126d8b3   Wolfgang Denk   Change all '$(......
5148
  - variable substitution using "... ${name} ..." syntax
2729af9d5   wdenk   * Fix minor NAND ...
5149
5150
  - special characters ('$', ';') can be escaped by prefixing with '\',
    for example:
fe126d8b3   Wolfgang Denk   Change all '$(......
5151
  	setenv bootcmd bootm \${address}
2729af9d5   wdenk   * Fix minor NAND ...
5152
5153
  - 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
5154

2729af9d5   wdenk   * Fix minor NAND ...
5155
5156
  Hush shell:
  -----------
c609719b8   wdenk   Initial revision
5157

2729af9d5   wdenk   * Fix minor NAND ...
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
  - 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
5168

2729af9d5   wdenk   * Fix minor NAND ...
5169
5170
5171
5172
  (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
5173

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

2729af9d5   wdenk   * Fix minor NAND ...
5179
5180
  Note for Redundant Ethernet Interfaces:
  =======================================
c609719b8   wdenk   Initial revision
5181

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

2729af9d5   wdenk   * Fix minor NAND ...
5186
5187
5188
  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
5189

2729af9d5   wdenk   * Fix minor NAND ...
5190
5191
5192
5193
  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
5194

2729af9d5   wdenk   * Fix minor NAND ...
5195
5196
  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
5197

2729af9d5   wdenk   * Fix minor NAND ...
5198
5199
5200
  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
5201

2729af9d5   wdenk   * Fix minor NAND ...
5202
5203
  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
5204

2729af9d5   wdenk   * Fix minor NAND ...
5205
5206
5207
  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
5208

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

ecee9324d   Ben Warren   Program net devic...
5212
  If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
c0f40859f   Wolfgang Denk   README: white-spa...
5213
  will be programmed into hardware as part of the initialization process.	 This
ecee9324d   Ben Warren   Program net devic...
5214
5215
5216
  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
5217

2729af9d5   wdenk   * Fix minor NAND ...
5218
5219
  Image Formats:
  ==============
c609719b8   wdenk   Initial revision
5220

3310c549a   Marian Balakowicz   [new uImage] Add ...
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
  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
5239

2729af9d5   wdenk   * Fix minor NAND ...
5240
5241
  * 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...
5242
5243
5244
    LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
    Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
    INTEGRITY).
7b64fef33   Wolfgang Denk   Add AVR32 archite...
5245
  * Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
afc1ce828   Macpaul Lin   doc/README: docum...
5246
5247
    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 ...
5248
5249
5250
5251
5252
  * Compression Type (uncompressed, gzip, bzip2)
  * Load Address
  * Entry Point
  * Image Name
  * Image Timestamp
c609719b8   wdenk   Initial revision
5253

2729af9d5   wdenk   * Fix minor NAND ...
5254
5255
5256
  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
5257

2729af9d5   wdenk   * Fix minor NAND ...
5258
5259
  Linux Support:
  ==============
c609719b8   wdenk   Initial revision
5260

2729af9d5   wdenk   * Fix minor NAND ...
5261
5262
5263
  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
5264

2729af9d5   wdenk   * Fix minor NAND ...
5265
5266
5267
5268
5269
  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
5270

2729af9d5   wdenk   * Fix minor NAND ...
5271
5272
5273
  - 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
5274

2729af9d5   wdenk   * Fix minor NAND ...
5275
5276
  - 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
5277

2729af9d5   wdenk   * Fix minor NAND ...
5278
5279
5280
5281
5282
5283
  - 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
5284

c609719b8   wdenk   Initial revision
5285

2729af9d5   wdenk   * Fix minor NAND ...
5286
5287
  Linux HOWTO:
  ============
c609719b8   wdenk   Initial revision
5288

2729af9d5   wdenk   * Fix minor NAND ...
5289
5290
  Porting Linux to U-Boot based systems:
  ---------------------------------------
c609719b8   wdenk   Initial revision
5291

2729af9d5   wdenk   * Fix minor NAND ...
5292
5293
5294
5295
  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
5296

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

2729af9d5   wdenk   * Fix minor NAND ...
5299
5300
  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...
5301
5302
  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...
5303
  as your U-Boot configuration in CONFIG_SYS_IMMR.
24ee89b97   wdenk   * Fix mdelay() on...
5304

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

2729af9d5   wdenk   * Fix minor NAND ...
5310
5311
  Configuring the Linux kernel:
  -----------------------------
c609719b8   wdenk   Initial revision
5312

2729af9d5   wdenk   * Fix minor NAND ...
5313
5314
5315
5316
5317
5318
  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
5319

2729af9d5   wdenk   * Fix minor NAND ...
5320
5321
5322
5323
5324
5325
5326
5327
  With U-Boot, "normal" build targets like "zImage" or "bzImage" are
  not used. If you use recent kernel source, a new build target
  "uImage" will exist which automatically builds an image usable by
  U-Boot. Most older kernels also have support for a "pImage" target,
  which was introduced for our predecessor project PPCBoot and uses a
  100% compatible format.
  
  Example:
ab584d67c   Holger Freyther   The _config targe...
5328
  	make TQM850L_defconfig
2729af9d5   wdenk   * Fix minor NAND ...
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
  	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
5354

c609719b8   wdenk   Initial revision
5355

2729af9d5   wdenk   * Fix minor NAND ...
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
  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
5369

2729af9d5   wdenk   * Fix minor NAND ...
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
  	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...
5386
5387
5388
  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 ...
5389
5390
5391
5392
5393
5394
5395
5396
  
  - 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 ...
5397
  	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
2729af9d5   wdenk   * Fix minor NAND ...
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
  	> 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 ...
5420
  	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
2729af9d5   wdenk   * Fix minor NAND ...
5421
5422
  	-> 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 ...
5423
  	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
2729af9d5   wdenk   * Fix minor NAND ...
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
  	> 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 ...
5445
5446
5447
5448
  The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
  option performs the converse operation of the mkimage's second form (the "-d"
  option). Given an image built by mkimage, the dumpimage extracts a "data file"
  from the image:
f41f5b7c0   Guilherme Maciel Ferreira   dumpimage: add 'T...
5449
5450
5451
5452
  	tools/dumpimage -i image -T type -p position data_file
  	  -i ==> extract from the 'image' a specific 'data_file'
  	  -T ==> set image type to 'type'
  	  -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
a804b5ce2   Guilherme Maciel Ferreira   Add dumpimage, a ...
5453

2729af9d5   wdenk   * Fix minor NAND ...
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
  
  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...
5489
  this includes a checksum verification so you can be sure no data
2729af9d5   wdenk   * Fix minor NAND ...
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
  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...
5536
  If you want to boot a Linux kernel with initial RAM disk, you pass
2729af9d5   wdenk   * Fix minor NAND ...
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
  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...
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
  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...
5620
5621
5622
     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...
5623
     Load Address: 00000000
a9398e018   Wolfgang Denk   Minor code cleanu...
5624
     Entry Point:	 00000000
0267768ed   Matthew McClintock   * Modify bootm co...
5625
5626
5627
5628
5629
5630
     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 ...
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
  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"...
5670
5671
5672
5673
5674
5675
  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...
5676
  Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
017e1f3f9   Marek Vasut   BOOT: Add RAW ram...
5677
5678
5679
  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 ...
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
  
  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...
5777
5778
5779
  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 ...
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
  
  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...
5815
  meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
2729af9d5   wdenk   * Fix minor NAND ...
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
  
  
  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...
5840
  	Chris Hallinan posted a good summary of these issues to the
0668236ba   Wolfgang Denk   README: update ma...
5841
  	U-Boot mailing list:
2729af9d5   wdenk   * Fix minor NAND ...
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
  
  	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...
5853
  	beyond the scope of this list to explain the details, but you
2729af9d5   wdenk   * Fix minor NAND ...
5854
5855
5856
5857
5858
  	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...
5859
  	initial stack/RAM area prior to SDRAM being available. Either
2729af9d5   wdenk   * Fix minor NAND ...
5860
5861
5862
5863
  	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...
5864
  	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
2729af9d5   wdenk   * Fix minor NAND ...
5865
5866
  	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...
5867
  	walnut.h should work for you. I'd set it to a value larger
2729af9d5   wdenk   * Fix minor NAND ...
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
  	than your SDRAM module. If you have a 64MB SDRAM module, set
  	it above 400_0000. Just make sure your board has no resources
  	that are supposed to respond to that address! That code in
  	start.S has been around a while and should work as is when
  	you get the config right.
  
  	-Chris Hallinan
  	DS4.COM, Inc.
  
  It is essential to remember this, since it has some impact on the C
  code for the initialization procedures:
  
  * Initialized global data (data segment) is read-only. Do not attempt
    to write it.
b445bbb49   Jeremiah Mahler   doc: fix grammati...
5882
  * Do not use any uninitialized global data (or implicitly initialized
2729af9d5   wdenk   * Fix minor NAND ...
5883
5884
5885
5886
5887
5888
5889
    as zero data - BSS segment) at all - this is undefined, initiali-
    zation is performed later (when relocating to RAM).
  
  * Stack space is very limited. Avoid big data buffers or things like
    that.
  
  Having only the stack as writable memory limits means we cannot use
b445bbb49   Jeremiah Mahler   doc: fix grammati...
5890
  normal global data to share information between the code. But it
2729af9d5   wdenk   * Fix minor NAND ...
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
  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...
5905
  	R2:	reserved for system use
2729af9d5   wdenk   * Fix minor NAND ...
5906
5907
5908
5909
5910
  	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...
5911
5912
5913
  	(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 ...
5914

e7670f6c1   Wolfgang Denk   PPC: Use r2 inste...
5915
      ==> U-Boot will use R2 to hold a pointer to the global data
2729af9d5   wdenk   * Fix minor NAND ...
5916
5917
5918
5919
5920
5921
5922
  
      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 ...
5923
  On Blackfin, the normal C ABI (except for P3) is followed as documented here:
4c58eb555   Mike Frysinger   add some more Bla...
5924
  	http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
c4db335c2   Robin Getz   Blackfin: change ...
5925
      ==> U-Boot will use P3 to hold a pointer to the global data
4c58eb555   Mike Frysinger   add some more Bla...
5926

2729af9d5   wdenk   * Fix minor NAND ...
5927
5928
5929
5930
  On ARM, the following registers are used:
  
  	R0:	function argument word/integer result
  	R1-R3:	function argument word
12eba1b49   Jeroen Hofstee   README: update AR...
5931
5932
  	R9:	platform specific
  	R10:	stack limit (used only if stack checking is enabled)
2729af9d5   wdenk   * Fix minor NAND ...
5933
5934
5935
5936
5937
  	R11:	argument (frame) pointer
  	R12:	temporary workspace
  	R13:	stack pointer
  	R14:	link register
  	R15:	program counter
12eba1b49   Jeroen Hofstee   README: update AR...
5938
5939
5940
      ==> 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 ...
5941

0df01fd3d   Thomas Chou   nios2: fix r15 is...
5942
5943
5944
5945
5946
5947
5948
  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...
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
  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...
5962
5963
  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 ...
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
  
  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...
5980
  memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
2729af9d5   wdenk   * Fix minor NAND ...
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
  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
6012

2729af9d5   wdenk   * Fix minor NAND ...
6013
  In the reset configuration, U-Boot starts at the reset entry point
11ccc33fa   Marcel Ziswiler   Many spelling fix...
6014
  (on most PowerPC systems at address 0x00000100). Because of the reset
b445bbb49   Jeremiah Mahler   doc: fix grammati...
6015
  configuration for CS0# this is a mirror of the on board Flash memory.
2729af9d5   wdenk   * Fix minor NAND ...
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
  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
6050

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

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

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

2729af9d5   wdenk   * Fix minor NAND ...
6061
  	if (available_money > available_manpower) {
6c3fef28b   Jerry Van Baren   Improve U-Boot Po...
6062
  		Pay consultant to port U-Boot;
c609719b8   wdenk   Initial revision
6063
6064
  		return 0;
  	}
2729af9d5   wdenk   * Fix minor NAND ...
6065
  	Download latest U-Boot source;
0668236ba   Wolfgang Denk   README: update ma...
6066
  	Subscribe to u-boot mailing list;
2729af9d5   wdenk   * Fix minor NAND ...
6067

6c3fef28b   Jerry Van Baren   Improve U-Boot Po...
6068
6069
  	if (clueless)
  		email("Hi, I am new to U-Boot, how do I get started?");
2729af9d5   wdenk   * Fix minor NAND ...
6070
6071
6072
  
  	while (learning) {
  		Read the README file in the top level directory;
6c3fef28b   Jerry Van Baren   Improve U-Boot Po...
6073
6074
  		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
  		Read applicable doc/*.README;
2729af9d5   wdenk   * Fix minor NAND ...
6075
  		Read the source, Luke;
6c3fef28b   Jerry Van Baren   Improve U-Boot Po...
6076
  		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
2729af9d5   wdenk   * Fix minor NAND ...
6077
  	}
6c3fef28b   Jerry Van Baren   Improve U-Boot Po...
6078
6079
6080
  	if (available_money > toLocalCurrency ($2500))
  		Buy a BDI3000;
  	else
2729af9d5   wdenk   * Fix minor NAND ...
6081
  		Add a lot of aggravation and time;
2729af9d5   wdenk   * Fix minor NAND ...
6082

6c3fef28b   Jerry Van Baren   Improve U-Boot Po...
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
  	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 ...
6107
  	}
2729af9d5   wdenk   * Fix minor NAND ...
6108
6109
6110
6111
6112
6113
6114
6115
  
  	return 0;
  }
  
  void no_more_time (int sig)
  {
        hire_a_guru();
  }
c609719b8   wdenk   Initial revision
6116

2729af9d5   wdenk   * Fix minor NAND ...
6117
6118
  Coding Standards:
  -----------------
c609719b8   wdenk   Initial revision
6119

2729af9d5   wdenk   * Fix minor NAND ...
6120
  All contributions to U-Boot should conform to the Linux kernel
2c0516517   Detlev Zundel   Added changelog e...
6121
  coding style; see the file "Documentation/CodingStyle" and the script
7ca9296e1   Wolfgang Denk   README: udate Cod...
6122
  "scripts/Lindent" in your Linux kernel source directory.
2c0516517   Detlev Zundel   Added changelog e...
6123
6124
6125
  
  Source files originating from a different project (for example the
  MTD subsystem) are generally exempt from these guidelines and are not
b445bbb49   Jeremiah Mahler   doc: fix grammati...
6126
  reformatted to ease subsequent migration to newer versions of those
2c0516517   Detlev Zundel   Added changelog e...
6127
6128
6129
6130
6131
  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
6132

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

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

2729af9d5   wdenk   * Fix minor NAND ...
6144
6145
  Submitting Patches:
  -------------------
c609719b8   wdenk   Initial revision
6146

2729af9d5   wdenk   * Fix minor NAND ...
6147
6148
6149
  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
6150

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

0668236ba   Wolfgang Denk   README: update ma...
6153
6154
  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 ...
6155
6156
  When you send a patch, please include the following information with
  it:
c609719b8   wdenk   Initial revision
6157

2729af9d5   wdenk   * Fix minor NAND ...
6158
6159
6160
  * 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
6161

2729af9d5   wdenk   * Fix minor NAND ...
6162
6163
  * For new features: a description of the feature and your
    implementation.
c609719b8   wdenk   Initial revision
6164

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

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

27af930e9   Albert ARIBAUD   Merge and reforma...
6169
6170
  * 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
6171

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

218ca724c   Wolfgang Denk   README: update do...
6175
6176
  * 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...
6177
    "git format-patch". If you then use "git send-email" to send it to
218ca724c   Wolfgang Denk   README: update do...
6178
6179
6180
6181
6182
6183
    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
6184

218ca724c   Wolfgang Denk   README: update do...
6185
6186
6187
6188
    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...
6189

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

2729af9d5   wdenk   * Fix minor NAND ...
6193
6194
  * 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...
6195

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

52f52c149   wdenk   Patches by Robert...
6199

2729af9d5   wdenk   * Fix minor NAND ...
6200
  Notes:
c609719b8   wdenk   Initial revision
6201

2729af9d5   wdenk   * Fix minor NAND ...
6202
6203
6204
  * 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
6205

2729af9d5   wdenk   * Fix minor NAND ...
6206
6207
6208
  * 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
6209

2729af9d5   wdenk   * Fix minor NAND ...
6210
6211
6212
6213
6214
6215
  * 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...
6216

0668236ba   Wolfgang Denk   README: update ma...
6217
6218
6219
6220
  * 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.