blob: 082bd2ab1cec242fe5a6d93c788de48129b8159d [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Wolfgang Denk1234ce72013-06-21 10:22:36 +02002# (C) Copyright 2000 - 2013
wdenkc6097192002-11-03 00:24:07 +00003# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4#
Wolfgang Denk1234ce72013-06-21 10:22:36 +02005# SPDX-License-Identifier: GPL-2.0+
wdenkc6097192002-11-03 00:24:07 +00006#
7
8Summary:
9========
10
wdenk24ee89b2002-11-03 17:56:27 +000011This directory contains the source code for U-Boot, a boot loader for
wdenkce4832c2004-10-17 21:12:06 +000012Embedded boards based on PowerPC, ARM, MIPS and several other
13processors, which can be installed in a boot ROM and used to
14initialize and test the hardware or to download and run application
15code.
wdenkc6097192002-11-03 00:24:07 +000016
17The development of U-Boot is closely related to Linux: some parts of
wdenk24ee89b2002-11-03 17:56:27 +000018the source code originate in the Linux source tree, we have some
19header files in common, and special provision has been made to
wdenkc6097192002-11-03 00:24:07 +000020support booting of Linux images.
21
22Some attention has been paid to make this software easily
23configurable and extendable. For instance, all monitor commands are
24implemented with the same call interface, so that it's very easy to
25add new commands. Also, instead of permanently adding rarely used
26code (for instance hardware test utilities) to the monitor, you can
27load and run it dynamically.
28
29
30Status:
31=======
32
33In general, all boards for which a configuration option exists in the
wdenk24ee89b2002-11-03 17:56:27 +000034Makefile have been tested to some extent and can be considered
wdenkc6097192002-11-03 00:24:07 +000035"working". In fact, many of them are used in production systems.
36
wdenk24ee89b2002-11-03 17:56:27 +000037In case of problems see the CHANGELOG and CREDITS files to find out
Albert ARIBAUD48e910f2013-09-11 15:52:51 +020038who contributed the specific port. The boards.cfg file lists board
Wolfgang Denkb240aef2008-03-26 10:40:12 +010039maintainers.
wdenkc6097192002-11-03 00:24:07 +000040
Robert P. J. Day974ed2f2012-11-14 02:03:20 +000041Note: There is no CHANGELOG file in the actual U-Boot source tree;
42it can be created dynamically from the Git log using:
43
44 make CHANGELOG
45
wdenkc6097192002-11-03 00:24:07 +000046
47Where to get help:
48==================
49
wdenk24ee89b2002-11-03 17:56:27 +000050In case you have questions about, problems with or contributions for
51U-Boot you should send a message to the U-Boot mailing list at
Peter Tyser8804a612008-09-10 09:18:34 -050052<u-boot@lists.denx.de>. There is also an archive of previous traffic
53on the mailing list - please search the archive before asking FAQ's.
54Please see http://lists.denx.de/pipermail/u-boot and
55http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
wdenkc6097192002-11-03 00:24:07 +000056
57
Wolfgang Denkb240aef2008-03-26 10:40:12 +010058Where to get source code:
59=========================
60
61The U-Boot source code is maintained in the git repository at
62git://www.denx.de/git/u-boot.git ; you can browse it online at
63http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
64
65The "snapshot" links on this page allow you to download tarballs of
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +020066any version you might be interested in. Official releases are also
Wolfgang Denkb240aef2008-03-26 10:40:12 +010067available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
68directory.
69
Anatolij Gustschin08337f32008-03-26 18:13:33 +010070Pre-built (and tested) images are available from
Wolfgang Denkb240aef2008-03-26 10:40:12 +010071ftp://ftp.denx.de/pub/u-boot/images/
72
73
wdenkc6097192002-11-03 00:24:07 +000074Where we come from:
75===================
76
77- start from 8xxrom sources
wdenk24ee89b2002-11-03 17:56:27 +000078- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenkc6097192002-11-03 00:24:07 +000079- clean up code
80- make it easier to add custom boards
81- make it possible to add other [PowerPC] CPUs
82- extend functions, especially:
83 * Provide extended interface to Linux boot loader
84 * S-Record download
85 * network boot
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +020086 * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
wdenk24ee89b2002-11-03 17:56:27 +000087- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenkc6097192002-11-03 00:24:07 +000088- add other CPU families (starting with ARM)
wdenk24ee89b2002-11-03 17:56:27 +000089- create U-Boot project (http://sourceforge.net/projects/u-boot)
Magnus Liljaf3b287b2008-08-06 19:32:33 +020090- current project page: see http://www.denx.de/wiki/U-Boot
wdenk24ee89b2002-11-03 17:56:27 +000091
92
93Names and Spelling:
94===================
95
96The "official" name of this project is "Das U-Boot". The spelling
97"U-Boot" shall be used in all written text (documentation, comments
98in source files etc.). Example:
99
100 This is the README file for the U-Boot project.
101
102File names etc. shall be based on the string "u-boot". Examples:
103
104 include/asm-ppc/u-boot.h
105
106 #include <asm/u-boot.h>
107
108Variable names, preprocessor constants etc. shall be either based on
109the string "u_boot" or on "U_BOOT". Example:
wdenkc6097192002-11-03 00:24:07 +0000110
wdenk24ee89b2002-11-03 17:56:27 +0000111 U_BOOT_VERSION u_boot_logo
112 IH_OS_U_BOOT u_boot_hush_start
113
wdenkc6097192002-11-03 00:24:07 +0000114
wdenk7474aca2002-12-17 17:55:09 +0000115Versioning:
116===========
117
Thomas Webere89e6282010-09-28 08:06:25 +0200118Starting with the release in October 2008, the names of the releases
119were changed from numerical release numbers without deeper meaning
120into a time stamp based numbering. Regular releases are identified by
121names consisting of the calendar year and month of the release date.
122Additional fields (if present) indicate release candidates or bug fix
123releases in "stable" maintenance trees.
wdenk7474aca2002-12-17 17:55:09 +0000124
Thomas Webere89e6282010-09-28 08:06:25 +0200125Examples:
Wolfgang Denk092ae952011-10-26 10:21:21 +0000126 U-Boot v2009.11 - Release November 2009
Thomas Webere89e6282010-09-28 08:06:25 +0200127 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
128 U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
wdenk7474aca2002-12-17 17:55:09 +0000129
130
wdenkc6097192002-11-03 00:24:07 +0000131Directory Hierarchy:
132====================
133
Peter Tysere4d1abc2010-04-12 22:28:21 -0500134/arch Architecture specific files
Masahiro Yamadaef6ebff2014-03-07 18:02:02 +0900135 /arc Files generic to ARC architecture
136 /cpu CPU specific files
137 /arc700 Files specific to ARC 700 CPUs
138 /lib Architecture specific library files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500139 /arm Files generic to ARM architecture
140 /cpu CPU specific files
141 /arm720t Files specific to ARM 720 CPUs
142 /arm920t Files specific to ARM 920 CPUs
Andreas Bießmannd9a9d562011-07-18 09:41:08 +0000143 /at91 Files specific to Atmel AT91RM9200 CPU
Wolfgang Denk16fa98a2010-06-13 17:48:15 +0200144 /imx Files specific to Freescale MC9328 i.MX CPUs
145 /s3c24x0 Files specific to Samsung S3C24X0 CPUs
Peter Tysere4d1abc2010-04-12 22:28:21 -0500146 /arm926ejs Files specific to ARM 926 CPUs
147 /arm1136 Files specific to ARM 1136 CPUs
Peter Tysere4d1abc2010-04-12 22:28:21 -0500148 /pxa Files specific to Intel XScale PXA CPUs
Peter Tysere4d1abc2010-04-12 22:28:21 -0500149 /sa1100 Files specific to Intel StrongARM SA1100 CPUs
150 /lib Architecture specific library files
151 /avr32 Files generic to AVR32 architecture
152 /cpu CPU specific files
153 /lib Architecture specific library files
154 /blackfin Files generic to Analog Devices Blackfin architecture
155 /cpu CPU specific files
156 /lib Architecture specific library files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500157 /m68k Files generic to m68k architecture
158 /cpu CPU specific files
159 /mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs
160 /mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs
161 /mcf532x Files specific to Freescale ColdFire MCF5329 CPUs
162 /mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs
163 /mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs
164 /lib Architecture specific library files
165 /microblaze Files generic to microblaze architecture
166 /cpu CPU specific files
167 /lib Architecture specific library files
168 /mips Files generic to MIPS architecture
169 /cpu CPU specific files
Daniel Schwierzeckd52a6232011-07-27 13:22:39 +0200170 /mips32 Files specific to MIPS32 CPUs
Masahiro Yamadaef6ebff2014-03-07 18:02:02 +0900171 /mips64 Files specific to MIPS64 CPUs
Peter Tysere4d1abc2010-04-12 22:28:21 -0500172 /lib Architecture specific library files
Macpaul Lin1cac36e2011-10-19 20:41:11 +0000173 /nds32 Files generic to NDS32 architecture
174 /cpu CPU specific files
175 /n1213 Files specific to Andes Technology N1213 CPUs
176 /lib Architecture specific library files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500177 /nios2 Files generic to Altera NIOS2 architecture
178 /cpu CPU specific files
179 /lib Architecture specific library files
Robert P. J. Daya269c932013-09-15 18:34:15 -0400180 /openrisc Files generic to OpenRISC architecture
181 /cpu CPU specific files
182 /lib Architecture specific library files
Stefan Roese88fbf932010-04-15 16:07:28 +0200183 /powerpc Files generic to PowerPC architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500184 /cpu CPU specific files
185 /74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs
186 /mpc5xx Files specific to Freescale MPC5xx CPUs
187 /mpc5xxx Files specific to Freescale MPC5xxx CPUs
188 /mpc8xx Files specific to Freescale MPC8xx CPUs
Peter Tysere4d1abc2010-04-12 22:28:21 -0500189 /mpc824x Files specific to Freescale MPC824x CPUs
190 /mpc8260 Files specific to Freescale MPC8260 CPUs
191 /mpc85xx Files specific to Freescale MPC85xx CPUs
192 /ppc4xx Files specific to AMCC PowerPC 4xx CPUs
193 /lib Architecture specific library files
194 /sh Files generic to SH architecture
195 /cpu CPU specific files
196 /sh2 Files specific to sh2 CPUs
197 /sh3 Files specific to sh3 CPUs
198 /sh4 Files specific to sh4 CPUs
199 /lib Architecture specific library files
200 /sparc Files generic to SPARC architecture
201 /cpu CPU specific files
202 /leon2 Files specific to Gaisler LEON2 SPARC CPU
203 /leon3 Files specific to Gaisler LEON3 SPARC CPU
204 /lib Architecture specific library files
Robert P. J. Daya269c932013-09-15 18:34:15 -0400205 /x86 Files generic to x86 architecture
206 /cpu CPU specific files
207 /lib Architecture specific library files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500208/api Machine/arch independent API for external apps
209/board Board dependent files
210/common Misc architecture independent functions
211/disk Code for disk drive partition handling
212/doc Documentation (don't expect too much)
213/drivers Commonly used device drivers
Robert P. J. Daya269c932013-09-15 18:34:15 -0400214/dts Contains Makefile for building internal U-Boot fdt.
Peter Tysere4d1abc2010-04-12 22:28:21 -0500215/examples Example code for standalone applications, etc.
216/fs Filesystem code (cramfs, ext2, jffs2, etc.)
217/include Header Files
218/lib Files generic to all architectures
219 /libfdt Library files to support flattened device trees
220 /lzma Library files to support LZMA decompression
221 /lzo Library files to support LZO decompression
222/net Networking code
223/post Power On Self Test
Robert P. J. Daya269c932013-09-15 18:34:15 -0400224/spl Secondary Program Loader framework
Peter Tysere4d1abc2010-04-12 22:28:21 -0500225/tools Tools to build S-Record or U-Boot images, etc.
wdenkc6097192002-11-03 00:24:07 +0000226
wdenkc6097192002-11-03 00:24:07 +0000227Software Configuration:
228=======================
229
230Configuration is usually done using C preprocessor defines; the
231rationale behind that is to avoid dead code whenever possible.
232
233There are two classes of configuration variables:
234
235* Configuration _OPTIONS_:
236 These are selectable by the user and have names beginning with
237 "CONFIG_".
238
239* Configuration _SETTINGS_:
240 These depend on the hardware etc. and should not be meddled with if
241 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200242 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000243
244Later we will add a configuration tool - probably similar to or even
245identical to what's used for the Linux kernel. Right now, we have to
246do the configuration by hand, which means creating some symbolic
247links and editing some configuration files. We use the TQM8xxL boards
248as an example here.
249
250
251Selection of Processor Architecture and Board Type:
252---------------------------------------------------
253
254For all supported boards there are ready-to-use default
255configurations available; just type "make <board_name>_config".
256
257Example: For a TQM823L module type:
258
259 cd u-boot
260 make TQM823L_config
261
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200262For the Cogent platform, you need to specify the CPU type as well;
wdenkc6097192002-11-03 00:24:07 +0000263e.g. "make cogent_mpc8xx_config". And also configure the cogent
264directory according to the instructions in cogent/README.
265
266
Simon Glass53552c92014-03-22 17:12:59 -0600267Sandbox Environment:
268--------------------
269
270U-Boot can be built natively to run on a Linux host using the 'sandbox'
271board. This allows feature development which is not board- or architecture-
272specific to be undertaken on a native platform. The sandbox is also used to
273run some of U-Boot's tests.
274
275See board/sandbox/sandbox/README.sandbox for more details.
276
277
wdenkc6097192002-11-03 00:24:07 +0000278Configuration Options:
279----------------------
280
281Configuration depends on the combination of board and CPU type; all
282such information is kept in a configuration file
283"include/configs/<board_name>.h".
284
285Example: For a TQM823L module, all configuration settings are in
286"include/configs/TQM823L.h".
287
288
wdenk1272e232002-11-10 22:06:23 +0000289Many of the options are named exactly as the corresponding Linux
290kernel configuration options. The intention is to make it easier to
291build a config tool - later.
292
293
wdenkc6097192002-11-03 00:24:07 +0000294The following options need to be configured:
295
Kim Phillips203fee32007-08-10 13:28:25 -0500296- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000297
Kim Phillips203fee32007-08-10 13:28:25 -0500298- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk994ad962006-10-24 14:42:37 +0200299
300- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen9d5a43f2007-11-01 12:44:20 +0100301 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000302
303- CPU Module Type: (if CONFIG_COGENT is defined)
304 Define exactly one of
305 CONFIG_CMA286_60_OLD
306--- FIXME --- not tested yet:
307 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
308 CONFIG_CMA287_23, CONFIG_CMA287_50
309
310- Motherboard Type: (if CONFIG_COGENT is defined)
311 Define exactly one of
312 CONFIG_CMA101, CONFIG_CMA102
313
314- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
315 Define one or more of
316 CONFIG_CMA302
317
318- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
319 Define one or more of
320 CONFIG_LCD_HEARTBEAT - update a character position on
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200321 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000322 a "rotator" |\-/|\-/
323
Lei Wen20014762011-02-09 18:06:58 +0530324- Marvell Family Member
325 CONFIG_SYS_MVFS - define it if you want to enable
326 multiple fs option at one time
327 for marvell soc family
328
wdenkc6097192002-11-03 00:24:07 +0000329- MPC824X Family Member (if CONFIG_MPC824X is defined)
wdenk9b7f3842003-10-09 20:09:04 +0000330 Define exactly one of
331 CONFIG_MPC8240, CONFIG_MPC8245
wdenkc6097192002-11-03 00:24:07 +0000332
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200333- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk20bddb32004-09-28 17:59:53 +0000334 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
335 get_gclk_freq() cannot work
wdenk9b7f3842003-10-09 20:09:04 +0000336 e.g. if there is no 32KHz
337 reference PIT/RTC clock
wdenk20bddb32004-09-28 17:59:53 +0000338 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
339 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000340
wdenk20bddb32004-09-28 17:59:53 +0000341- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200342 CONFIG_SYS_8xx_CPUCLK_MIN
343 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk20bddb32004-09-28 17:59:53 +0000344 CONFIG_8xx_CPUCLK_DEFAULT
wdenkfde37042004-01-31 20:06:54 +0000345 See doc/README.MPC866
346
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200347 CONFIG_SYS_MEASURE_CPUCLK
wdenkfde37042004-01-31 20:06:54 +0000348
wdenk544e9732004-02-06 23:19:44 +0000349 Define this to measure the actual CPU clock instead
350 of relying on the correctness of the configured
351 values. Mostly useful for board bringup to make sure
352 the PLL is locked at the intended frequency. Note
353 that this requires a (stable) reference clock (32 kHz
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200354 RTC clock or CONFIG_SYS_8XX_XIN)
wdenkfde37042004-01-31 20:06:54 +0000355
Heiko Schocher734f0272009-03-12 07:37:15 +0100356 CONFIG_SYS_DELAYED_ICACHE
357
358 Define this option if you want to enable the
359 ICache only when Code runs from RAM.
360
Kumar Galaf4fb90f2011-02-18 05:40:54 -0600361- 85xx CPU Options:
York Sun2394a0f2012-10-08 07:44:30 +0000362 CONFIG_SYS_PPC64
363
364 Specifies that the core is a 64-bit PowerPC implementation (implements
365 the "64" category of the Power ISA). This is necessary for ePAPR
366 compliance, among other possible reasons.
367
Kumar Galaf4fb90f2011-02-18 05:40:54 -0600368 CONFIG_SYS_FSL_TBCLK_DIV
369
370 Defines the core time base clock divider ratio compared to the
371 system clock. On most PQ3 devices this is 8, on newer QorIQ
372 devices it can be 16 or 32. The ratio varies from SoC to Soc.
373
Kumar Gala179b1b22011-05-20 00:39:21 -0500374 CONFIG_SYS_FSL_PCIE_COMPAT
375
376 Defines the string to utilize when trying to match PCIe device
377 tree nodes for the given platform.
378
Prabhakar Kushwahaa6a30622012-04-29 23:56:13 +0000379 CONFIG_SYS_PPC_E500_DEBUG_TLB
380
381 Enables a temporary TLB entry to be used during boot to work
382 around limitations in e500v1 and e500v2 external debugger
383 support. This reduces the portions of the boot code where
384 breakpoints and single stepping do not work. The value of this
385 symbol should be set to the TLB1 entry to be used for this
386 purpose.
387
Scott Wood80806962012-08-14 10:14:53 +0000388 CONFIG_SYS_FSL_ERRATUM_A004510
389
390 Enables a workaround for erratum A004510. If set,
391 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
392 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
393
394 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
395 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
396
397 Defines one or two SoC revisions (low 8 bits of SVR)
398 for which the A004510 workaround should be applied.
399
400 The rest of SVR is either not relevant to the decision
401 of whether the erratum is present (e.g. p2040 versus
402 p2041) or is implied by the build target, which controls
403 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
404
405 See Freescale App Note 4493 for more information about
406 this erratum.
407
Prabhakar Kushwahad324f472013-04-16 13:27:44 +0530408 CONFIG_A003399_NOR_WORKAROUND
409 Enables a workaround for IFC erratum A003399. It is only
410 requred during NOR boot.
411
Scott Wood80806962012-08-14 10:14:53 +0000412 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
413
414 This is the value to write into CCSR offset 0x18600
415 according to the A004510 workaround.
416
Priyanka Jainc73b9032013-07-02 09:21:04 +0530417 CONFIG_SYS_FSL_DSP_DDR_ADDR
418 This value denotes start offset of DDR memory which is
419 connected exclusively to the DSP cores.
420
Priyanka Jainf81e8b22013-04-04 09:31:54 +0530421 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
422 This value denotes start offset of M2 memory
423 which is directly connected to the DSP core.
424
Priyanka Jainc73b9032013-07-02 09:21:04 +0530425 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
426 This value denotes start offset of M3 memory which is directly
427 connected to the DSP core.
428
Priyanka Jainf81e8b22013-04-04 09:31:54 +0530429 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
430 This value denotes start offset of DSP CCSR space.
431
Priyanka Jaine9dcaa82013-12-17 14:25:52 +0530432 CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
433 Single Source Clock is clocking mode present in some of FSL SoC's.
434 In this mode, a single differential clock is used to supply
435 clocks to the sysclock, ddrclock and usbclock.
436
Aneesh Bansal8bcbc272014-03-18 23:40:26 +0530437 CONFIG_SYS_CPC_REINIT_F
438 This CONFIG is defined when the CPC is configured as SRAM at the
439 time of U-boot entry and is required to be re-initialized.
440
Tang Yuantiana7364af2014-04-17 15:33:46 +0800441 CONFIG_DEEP_SLEEP
442 Inidcates this SoC supports deep sleep feature. If deep sleep is
443 supported, core will start to execute uboot when wakes up.
444
Daniel Schwierzeckd8a49ca2012-04-02 02:57:56 +0000445- Generic CPU options:
York Sun021d2022014-05-02 17:28:04 -0700446 CONFIG_SYS_GENERIC_GLOBAL_DATA
447 Defines global data is initialized in generic board board_init_f().
448 If this macro is defined, global data is created and cleared in
449 generic board board_init_f(). Without this macro, architecture/board
450 should initialize global data before calling board_init_f().
451
Daniel Schwierzeckd8a49ca2012-04-02 02:57:56 +0000452 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
453
454 Defines the endianess of the CPU. Implementation of those
455 values is arch specific.
456
York Sunf0626592013-09-30 09:22:09 -0700457 CONFIG_SYS_FSL_DDR
458 Freescale DDR driver in use. This type of DDR controller is
459 found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
460 SoCs.
461
462 CONFIG_SYS_FSL_DDR_ADDR
463 Freescale DDR memory-mapped register base.
464
465 CONFIG_SYS_FSL_DDR_EMU
466 Specify emulator support for DDR. Some DDR features such as
467 deskew training are not available.
468
469 CONFIG_SYS_FSL_DDRC_GEN1
470 Freescale DDR1 controller.
471
472 CONFIG_SYS_FSL_DDRC_GEN2
473 Freescale DDR2 controller.
474
475 CONFIG_SYS_FSL_DDRC_GEN3
476 Freescale DDR3 controller.
477
York Sun2896cb72014-03-27 17:54:47 -0700478 CONFIG_SYS_FSL_DDRC_GEN4
479 Freescale DDR4 controller.
480
York Sun461c9392013-09-30 14:20:51 -0700481 CONFIG_SYS_FSL_DDRC_ARM_GEN3
482 Freescale DDR3 controller for ARM-based SoCs.
483
York Sunf0626592013-09-30 09:22:09 -0700484 CONFIG_SYS_FSL_DDR1
485 Board config to use DDR1. It can be enabled for SoCs with
486 Freescale DDR1 or DDR2 controllers, depending on the board
487 implemetation.
488
489 CONFIG_SYS_FSL_DDR2
490 Board config to use DDR2. It can be eanbeld for SoCs with
491 Freescale DDR2 or DDR3 controllers, depending on the board
492 implementation.
493
494 CONFIG_SYS_FSL_DDR3
495 Board config to use DDR3. It can be enabled for SoCs with
York Sun2896cb72014-03-27 17:54:47 -0700496 Freescale DDR3 or DDR3L controllers.
497
498 CONFIG_SYS_FSL_DDR3L
499 Board config to use DDR3L. It can be enabled for SoCs with
500 DDR3L controllers.
501
502 CONFIG_SYS_FSL_DDR4
503 Board config to use DDR4. It can be enabled for SoCs with
504 DDR4 controllers.
York Sunf0626592013-09-30 09:22:09 -0700505
Prabhakar Kushwaha62908c22014-01-18 12:28:30 +0530506 CONFIG_SYS_FSL_IFC_BE
507 Defines the IFC controller register space as Big Endian
508
509 CONFIG_SYS_FSL_IFC_LE
510 Defines the IFC controller register space as Little Endian
511
Prabhakar Kushwaha950f2f72014-01-13 11:28:04 +0530512 CONFIG_SYS_FSL_PBL_PBI
513 It enables addition of RCW (Power on reset configuration) in built image.
514 Please refer doc/README.pblimage for more details
515
516 CONFIG_SYS_FSL_PBL_RCW
517 It adds PBI(pre-boot instructions) commands in u-boot build image.
518 PBI commands can be used to configure SoC before it starts the execution.
519 Please refer doc/README.pblimage for more details
520
Prabhakar Kushwaha2c27f122014-04-08 19:13:34 +0530521 CONFIG_SPL_FSL_PBL
522 It adds a target to create boot binary having SPL binary in PBI format
523 concatenated with u-boot binary.
524
York Sun29647ab2014-02-10 13:59:42 -0800525 CONFIG_SYS_FSL_DDR_BE
526 Defines the DDR controller register space as Big Endian
527
528 CONFIG_SYS_FSL_DDR_LE
529 Defines the DDR controller register space as Little Endian
530
York Sun3a0916d2014-02-10 13:59:43 -0800531 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
532 Physical address from the view of DDR controllers. It is the
533 same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But
534 it could be different for ARM SoCs.
535
York Sunc459ae62014-02-10 13:59:44 -0800536 CONFIG_SYS_FSL_DDR_INTLV_256B
537 DDR controller interleaving on 256-byte. This is a special
538 interleaving mode, handled by Dickens for Freescale layerscape
539 SoCs with ARM core.
540
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100541- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200542 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100543
544 Defines the Monahans run mode to oscillator
545 ratio. Valid values are 8, 16, 24, 31. The core
546 frequency is this value multiplied by 13 MHz.
547
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200548 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200549
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100550 Defines the Monahans turbo mode to oscillator
551 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200552 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100553 by this value.
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200554
Daniel Schwierzeckd52a6232011-07-27 13:22:39 +0200555- MIPS CPU options:
556 CONFIG_SYS_INIT_SP_OFFSET
557
558 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
559 pointer. This is needed for the temporary stack before
560 relocation.
561
562 CONFIG_SYS_MIPS_CACHE_MODE
563
564 Cache operation mode for the MIPS CPU.
565 See also arch/mips/include/asm/mipsregs.h.
566 Possible values are:
567 CONF_CM_CACHABLE_NO_WA
568 CONF_CM_CACHABLE_WA
569 CONF_CM_UNCACHED
570 CONF_CM_CACHABLE_NONCOHERENT
571 CONF_CM_CACHABLE_CE
572 CONF_CM_CACHABLE_COW
573 CONF_CM_CACHABLE_CUW
574 CONF_CM_CACHABLE_ACCELERATED
575
576 CONFIG_SYS_XWAY_EBU_BOOTCFG
577
578 Special option for Lantiq XWAY SoCs for booting from NOR flash.
579 See also arch/mips/cpu/mips32/start.S.
580
581 CONFIG_XWAY_SWAP_BYTES
582
583 Enable compilation of tools/xway-swap-bytes needed for Lantiq
584 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
585 be swapped if a flash programmer is used.
586
Christian Riesch48c2d6d2012-02-02 00:44:39 +0000587- ARM options:
588 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
589
590 Select high exception vectors of the ARM core, e.g., do not
591 clear the V bit of the c1 register of CP15.
592
Aneesh Vb8e40802012-03-08 07:20:19 +0000593 CONFIG_SYS_THUMB_BUILD
594
595 Use this flag to build U-Boot using the Thumb instruction
596 set for ARM architectures. Thumb instruction set provides
597 better code density. For ARM architectures that support
598 Thumb2 this flag will result in Thumb2 code generated by
599 GCC.
600
Stephen Warrenc63c3502013-03-04 13:29:40 +0000601 CONFIG_ARM_ERRATA_716044
Stephen Warrene9d59c92013-02-26 12:28:27 +0000602 CONFIG_ARM_ERRATA_742230
603 CONFIG_ARM_ERRATA_743622
604 CONFIG_ARM_ERRATA_751472
Nitin Garg7f17aed2014-04-02 08:55:01 -0500605 CONFIG_ARM_ERRATA_794072
Nitin Garg245defa2014-04-02 08:55:02 -0500606 CONFIG_ARM_ERRATA_761320
Stephen Warrene9d59c92013-02-26 12:28:27 +0000607
608 If set, the workarounds for these ARM errata are applied early
609 during U-Boot startup. Note that these options force the
610 workarounds to be applied; no CPU-type/version detection
611 exists, unlike the similar options in the Linux kernel. Do not
612 set these options unless they apply!
613
Stephen Warren445d56c2013-03-27 17:06:41 +0000614- CPU timer options:
615 CONFIG_SYS_HZ
616
617 The frequency of the timer returned by get_timer().
618 get_timer() must operate in milliseconds and this CONFIG
619 option must be set to 1000.
620
wdenk9b7f3842003-10-09 20:09:04 +0000621- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000622 CONFIG_CLOCKS_IN_MHZ
623
624 U-Boot stores all clock information in Hz
625 internally. For binary compatibility with older Linux
626 kernels (which expect the clocks passed in the
627 bd_info data to be in MHz) the environment variable
628 "clocks_in_mhz" can be defined so that U-Boot
629 converts clock data to MHZ before passing it to the
630 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000631 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denkb240aef2008-03-26 10:40:12 +0100632 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000633 default environment.
634
wdenk9b7f3842003-10-09 20:09:04 +0000635 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
636
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200637 When transferring memsize parameter to linux, some versions
wdenk9b7f3842003-10-09 20:09:04 +0000638 expect it to be in bytes, others in MB.
639 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
640
Gerald Van Barenfcd91bb2008-06-03 20:34:45 -0400641 CONFIG_OF_LIBFDT
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200642
643 New kernel versions are expecting firmware settings to be
Gerald Van Barend6abef42007-03-31 12:23:51 -0400644 passed using flattened device trees (based on open firmware
645 concepts).
646
647 CONFIG_OF_LIBFDT
648 * New libfdt-based support
649 * Adds the "fdt" command
Kim Phillips9b46eb62007-08-10 14:34:14 -0500650 * The bootm command automatically updates the fdt
Gerald Van Barend6abef42007-03-31 12:23:51 -0400651
Marcel Ziswilerb29bc712009-09-09 21:18:41 +0200652 OF_CPU - The proper name of the cpus node (only required for
653 MPC512X and MPC5xxx based boards).
654 OF_SOC - The proper name of the soc node (only required for
655 MPC512X and MPC5xxx based boards).
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200656 OF_TBCLK - The timebase frequency.
Kumar Galae40c2b52006-01-11 13:59:02 -0600657 OF_STDOUT_PATH - The path to the console device
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200658
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200659 boards with QUICC Engines require OF_QE to set UCC MAC
660 addresses
Kim Phillips9b46eb62007-08-10 14:34:14 -0500661
Kumar Gala1e26aa52006-01-11 13:54:17 -0600662 CONFIG_OF_BOARD_SETUP
663
664 Board code has addition modification that it wants to make
665 to the flat device tree before handing it off to the kernel
wdenkda04a8b2004-08-02 23:22:59 +0000666
Matthew McClintockefae4ca2006-06-28 10:41:37 -0500667 CONFIG_OF_BOOT_CPU
668
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200669 This define fills in the correct boot CPU in the boot
Matthew McClintockefae4ca2006-06-28 10:41:37 -0500670 param header, the default value is zero if undefined.
671
Heiko Schocherffb293a2009-09-23 07:56:08 +0200672 CONFIG_OF_IDE_FIXUP
673
674 U-Boot can detect if an IDE device is present or not.
675 If not, and this new config option is activated, U-Boot
676 removes the ATA node from the DTS before booting Linux,
677 so the Linux IDE driver does not probe the device and
678 crash. This is needed for buggy hardware (uc101) where
679 no pull down resistor is connected to the signal IDE5V_DD7.
680
Igor Grinberg06890672011-07-14 05:45:07 +0000681 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
682
683 This setting is mandatory for all boards that have only one
684 machine type and must be used to specify the machine type
685 number as it appears in the ARM machine registry
686 (see http://www.arm.linux.org.uk/developer/machines/).
687 Only boards that have multiple machine types supported
688 in a single configuration file and the machine type is
689 runtime discoverable, do not have to use this setting.
690
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100691- vxWorks boot parameters:
692
693 bootvx constructs a valid bootline using the following
694 environments variables: bootfile, ipaddr, serverip, hostname.
695 It loads the vxWorks image pointed bootfile.
696
697 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
698 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
699 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
700 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
701
702 CONFIG_SYS_VXWORKS_ADD_PARAMS
703
704 Add it at the end of the bootline. E.g "u=username pw=secret"
705
706 Note: If a "bootargs" environment is defined, it will overwride
707 the defaults discussed just above.
708
Aneesh V960f5c02011-06-16 23:30:47 +0000709- Cache Configuration:
710 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
711 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
712 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
713
Aneesh V686a0752011-06-16 23:30:51 +0000714- Cache Configuration for ARM:
715 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
716 controller
717 CONFIG_SYS_PL310_BASE - Physical base address of PL310
718 controller register space
719
wdenkda04a8b2004-08-02 23:22:59 +0000720- Serial Ports:
Andreas Engel0813b122008-09-08 14:30:53 +0200721 CONFIG_PL010_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000722
723 Define this if you want support for Amba PrimeCell PL010 UARTs.
724
Andreas Engel0813b122008-09-08 14:30:53 +0200725 CONFIG_PL011_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000726
727 Define this if you want support for Amba PrimeCell PL011 UARTs.
728
729 CONFIG_PL011_CLOCK
730
731 If you have Amba PrimeCell PL011 UARTs, set this variable to
732 the clock speed of the UARTs.
733
734 CONFIG_PL01x_PORTS
735
736 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
737 define this to a list of base addresses for each (supported)
738 port. See e.g. include/configs/versatile.h
739
John Rigby34e21ee2011-04-19 10:42:39 +0000740 CONFIG_PL011_SERIAL_RLCR
741
742 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
743 have separate receive and transmit line control registers. Set
744 this variable to initialize the extra register.
745
746 CONFIG_PL011_SERIAL_FLUSH_ON_INIT
747
748 On some platforms (e.g. U8500) U-Boot is loaded by a second stage
749 boot loader that has already initialized the UART. Define this
750 variable to flush the UART at init time.
751
Karicheri, Muralidharancbc08882014-04-09 15:38:46 -0400752 CONFIG_SERIAL_HW_FLOW_CONTROL
753
754 Define this variable to enable hw flow control in serial driver.
755 Current user of this option is drivers/serial/nsl16550.c driver
wdenkda04a8b2004-08-02 23:22:59 +0000756
wdenkc6097192002-11-03 00:24:07 +0000757- Console Interface:
wdenk4a5c8a72003-03-06 00:02:04 +0000758 Depending on board, define exactly one serial port
759 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
760 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
761 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000762
763 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
764 port routines must be defined elsewhere
765 (i.e. serial_init(), serial_getc(), ...)
766
767 CONFIG_CFB_CONSOLE
768 Enables console device for a color framebuffer. Needs following
Wolfgang Denkf6e50a42011-12-07 12:19:20 +0000769 defines (cf. smiLynxEM, i8042)
wdenkc6097192002-11-03 00:24:07 +0000770 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
771 (default big endian)
772 VIDEO_HW_RECTFILL graphic chip supports
773 rectangle fill
774 (cf. smiLynxEM)
775 VIDEO_HW_BITBLT graphic chip supports
776 bit-blit (cf. smiLynxEM)
777 VIDEO_VISIBLE_COLS visible pixel columns
778 (cols=pitch)
wdenk544e9732004-02-06 23:19:44 +0000779 VIDEO_VISIBLE_ROWS visible pixel rows
780 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000781 VIDEO_DATA_FORMAT graphic data format
782 (0-5, cf. cfb_console.c)
wdenk544e9732004-02-06 23:19:44 +0000783 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000784 VIDEO_KBD_INIT_FCT keyboard int fct
785 (i.e. i8042_kbd_init())
786 VIDEO_TSTC_FCT test char fct
787 (i.e. i8042_tstc)
788 VIDEO_GETC_FCT get char fct
789 (i.e. i8042_getc)
790 CONFIG_CONSOLE_CURSOR cursor drawing on/off
791 (requires blink timer
792 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200793 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000794 CONFIG_CONSOLE_TIME display time/date info in
795 upper right corner
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500796 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000797 CONFIG_VIDEO_LOGO display Linux logo in
798 upper left corner
wdenk9dd2b882002-12-03 21:28:10 +0000799 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
800 linux_logo.h for logo.
801 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000802 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200803 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000804 the logo
805
Pali Rohár4a57da32012-10-19 13:30:09 +0000806 When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
807 a limited number of ANSI escape sequences (cursor control,
808 erase functions and limited graphics rendition control).
809
wdenk4a5c8a72003-03-06 00:02:04 +0000810 When CONFIG_CFB_CONSOLE is defined, video console is
811 default i/o. Serial console can be forced with
812 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000813
wdenk1ebf41e2004-01-02 14:00:00 +0000814 When CONFIG_SILENT_CONSOLE is defined, all console
815 messages (by U-Boot and Linux!) can be silenced with
816 the "silent" environment variable. See
817 doc/README.silent for more information.
wdenk3da587e2003-10-19 23:22:11 +0000818
Heiko Schocher62759562013-10-22 11:06:06 +0200819 CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
820 is 0x00.
821 CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
822 is 0xa0.
823
wdenkc6097192002-11-03 00:24:07 +0000824- Console Baudrate:
825 CONFIG_BAUDRATE - in bps
826 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200827 CONFIG_SYS_BAUDRATE_TABLE, see below.
828 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000829
Heiko Schocher327480a2009-01-30 12:55:38 +0100830- Console Rx buffer length
831 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
832 the maximum receive buffer length for the SMC.
Heiko Schocher362447f2009-02-10 09:31:47 +0100833 This option is actual only for 82xx and 8xx possible.
Heiko Schocher327480a2009-01-30 12:55:38 +0100834 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
835 must be defined, to setup the maximum idle timeout for
836 the SMC.
837
Graeme Russ3c28f482011-09-01 00:48:27 +0000838- Pre-Console Buffer:
Wolfgang Denkd590fb12011-10-07 09:58:21 +0200839 Prior to the console being initialised (i.e. serial UART
840 initialised etc) all console output is silently discarded.
841 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
842 buffer any console messages prior to the console being
843 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
844 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
845 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
Wolfgang Denk23f78482011-10-09 21:06:34 +0200846 bytes are output before the console is initialised, the
Wolfgang Denkd590fb12011-10-07 09:58:21 +0200847 earlier bytes are discarded.
Graeme Russ3c28f482011-09-01 00:48:27 +0000848
Wolfgang Denkd590fb12011-10-07 09:58:21 +0200849 'Sane' compilers will generate smaller code if
850 CONFIG_PRE_CON_BUF_SZ is a power of 2
Graeme Russ3c28f482011-09-01 00:48:27 +0000851
Sonny Raocd55bde2011-11-02 09:52:08 +0000852- Safe printf() functions
853 Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
854 the printf() functions. These are defined in
855 include/vsprintf.h and include snprintf(), vsnprintf() and
856 so on. Code size increase is approximately 300-500 bytes.
857 If this option is not given then these functions will
858 silently discard their buffer size argument - this means
859 you are not getting any overflow checking in this case.
860
wdenkc6097192002-11-03 00:24:07 +0000861- Boot Delay: CONFIG_BOOTDELAY - in seconds
862 Delay before automatically booting the default image;
863 set to -1 to disable autoboot.
Joe Hershberger96ccaf32012-08-17 10:53:12 +0000864 set to -2 to autoboot with no delay and not check for abort
865 (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
wdenkc6097192002-11-03 00:24:07 +0000866
867 See doc/README.autoboot for these options that
868 work with CONFIG_BOOTDELAY. None are required.
869 CONFIG_BOOT_RETRY_TIME
870 CONFIG_BOOT_RETRY_MIN
871 CONFIG_AUTOBOOT_KEYED
872 CONFIG_AUTOBOOT_PROMPT
873 CONFIG_AUTOBOOT_DELAY_STR
874 CONFIG_AUTOBOOT_STOP_STR
875 CONFIG_AUTOBOOT_DELAY_STR2
876 CONFIG_AUTOBOOT_STOP_STR2
877 CONFIG_ZERO_BOOTDELAY_CHECK
878 CONFIG_RESET_TO_RETRY
879
880- Autoboot Command:
881 CONFIG_BOOTCOMMAND
882 Only needed when CONFIG_BOOTDELAY is enabled;
883 define a command string that is automatically executed
884 when no character is read on the console interface
885 within "Boot Delay" after reset.
886
887 CONFIG_BOOTARGS
wdenk4a5c8a72003-03-06 00:02:04 +0000888 This can be used to pass arguments to the bootm
889 command. The value of CONFIG_BOOTARGS goes into the
890 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000891
892 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk4a5c8a72003-03-06 00:02:04 +0000893 The value of these goes into the environment as
894 "ramboot" and "nfsboot" respectively, and can be used
895 as a convenience, when switching between booting from
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200896 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000897
Heiko Schocher040c5c32013-11-04 14:04:59 +0100898- Bootcount:
899 CONFIG_BOOTCOUNT_LIMIT
900 Implements a mechanism for detecting a repeating reboot
901 cycle, see:
902 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
903
904 CONFIG_BOOTCOUNT_ENV
905 If no softreset save registers are found on the hardware
906 "bootcount" is stored in the environment. To prevent a
907 saveenv on all reboots, the environment variable
908 "upgrade_available" is used. If "upgrade_available" is
909 0, "bootcount" is always 0, if "upgrade_available" is
910 1 "bootcount" is incremented in the environment.
911 So the Userspace Applikation must set the "upgrade_available"
912 and "bootcount" variable to 0, if a boot was successfully.
913
wdenkc6097192002-11-03 00:24:07 +0000914- Pre-Boot Commands:
915 CONFIG_PREBOOT
916
917 When this option is #defined, the existence of the
918 environment variable "preboot" will be checked
919 immediately before starting the CONFIG_BOOTDELAY
920 countdown and/or running the auto-boot command resp.
921 entering interactive mode.
922
923 This feature is especially useful when "preboot" is
924 automatically generated or modified. For an example
925 see the LWMON board specific code: here "preboot" is
926 modified when the user holds down a certain
927 combination of keys on the (special) keyboard when
928 booting the systems
929
930- Serial Download Echo Mode:
931 CONFIG_LOADS_ECHO
932 If defined to 1, all characters received during a
933 serial download (using the "loads" command) are
934 echoed back. This might be needed by some terminal
935 emulations (like "cu"), but may as well just take
936 time on others. This setting #define's the initial
937 value of the "loads_echo" environment variable.
938
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500939- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000940 CONFIG_KGDB_BAUDRATE
941 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200942 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000943
944- Monitor Functions:
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500945 Monitor commands can be included or excluded
946 from the build by using the #include files
Stephen Warren963a7cf2012-08-05 16:07:19 +0000947 <config_cmd_all.h> and #undef'ing unwanted
948 commands, or using <config_cmd_default.h>
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500949 and augmenting with additional #define's
950 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000951
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500952 The default command configuration includes all commands
953 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000954
Marek Vasutc4d8a1b2014-03-05 19:58:39 +0100955 CONFIG_CMD_AES AES 128 CBC encrypt/decrypt
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500956 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500957 CONFIG_CMD_BDI bdinfo
958 CONFIG_CMD_BEDBUG * Include BedBug Debugger
959 CONFIG_CMD_BMP * BMP support
960 CONFIG_CMD_BSP * Board specific commands
961 CONFIG_CMD_BOOTD bootd
962 CONFIG_CMD_CACHE * icache, dcache
Michal Simeka0d28022013-11-21 13:39:02 -0800963 CONFIG_CMD_CLK * clock command support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500964 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger321ab9e2010-12-21 14:19:51 -0500965 CONFIG_CMD_CRC32 * crc32
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500966 CONFIG_CMD_DATE * support for RTC, date/time...
967 CONFIG_CMD_DHCP * DHCP support
968 CONFIG_CMD_DIAG * Diagnostics
Peter Tyser15258042008-12-17 16:36:22 -0600969 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
970 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
971 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
972 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500973 CONFIG_CMD_DTT * Digital Therm and Thermostat
974 CONFIG_CMD_ECHO echo arguments
Peter Tyser0deafa22009-10-25 15:12:56 -0500975 CONFIG_CMD_EDITENV edit env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500976 CONFIG_CMD_EEPROM * EEPROM read/write support
977 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger1b0d5512012-12-11 22:16:25 -0600978 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergera2d62b72012-12-11 22:16:33 -0600979 CONFIG_CMD_ENV_FLAGS * display details about env flags
Andrew Ruder94463402013-10-22 19:07:34 -0500980 CONFIG_CMD_ENV_EXISTS * check existence of env variable
Mike Frysingerf3ddf202010-12-26 23:09:45 -0500981 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren4f8662d2012-10-22 06:43:50 +0000982 CONFIG_CMD_EXT2 * ext2 command support
983 CONFIG_CMD_EXT4 * ext4 command support
Stephen Warren3d5a3882014-01-24 20:46:37 -0700984 CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls)
985 that work for multiple fs types
Mike Frysinger78dcaf42009-01-28 19:08:14 -0500986 CONFIG_CMD_SAVEENV saveenv
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500987 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren4f8662d2012-10-22 06:43:50 +0000988 CONFIG_CMD_FAT * FAT command support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500989 CONFIG_CMD_FLASH flinfo, erase, protect
990 CONFIG_CMD_FPGA FPGA device initialization support
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200991 CONFIG_CMD_FUSE * Device fuse support
Anton Staafd1390c82012-12-05 14:46:29 +0000992 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysinger2ed02412010-12-26 23:32:22 -0500993 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsf0c9d532011-04-05 07:15:14 +0000994 CONFIG_CMD_GREPENV * search environment
Simon Glass058bb8d2012-12-05 14:46:38 +0000995 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500996 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
997 CONFIG_CMD_I2C * I2C serial bus support
998 CONFIG_CMD_IDE * IDE harddisk support
999 CONFIG_CMD_IMI iminfo
Vipin Kumar3df41b12012-12-16 22:32:48 +00001000 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001001 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001002 CONFIG_CMD_IMMAP * IMMR dump support
Simon Glass4dc47ca2014-06-11 23:29:41 -06001003 CONFIG_CMD_IOTRACE * I/O tracing for debugging
Mike Frysingerf3ddf202010-12-26 23:09:45 -05001004 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershberger0fd32d72012-10-03 11:15:51 +00001005 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001006 CONFIG_CMD_IRQ * irqinfo
1007 CONFIG_CMD_ITEST Integer/string test of 2 values
1008 CONFIG_CMD_JFFS2 * JFFS2 Support
1009 CONFIG_CMD_KGDB * kgdb
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001010 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00001011 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
1012 (169.254.*.*)
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001013 CONFIG_CMD_LOADB loadb
1014 CONFIG_CMD_LOADS loads
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001015 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz93d6cb02009-07-27 00:07:59 -04001016 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glasseacd14f2012-11-30 13:01:20 +00001017 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001018 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denk9d009282013-03-08 10:51:32 +00001019 loop, loopw
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001020 CONFIG_CMD_MEMTEST * mtest
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001021 CONFIG_CMD_MISC Misc functions like sleep etc
1022 CONFIG_CMD_MMC * MMC memory mapped support
1023 CONFIG_CMD_MII * MII utility commands
Stefan Roeseb1423dd2009-03-19 13:30:36 +01001024 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001025 CONFIG_CMD_NAND * NAND support
1026 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001027 CONFIG_CMD_NFS NFS support
Peter Tyser9902e422008-12-17 16:36:21 -06001028 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denk092ae952011-10-26 10:21:21 +00001029 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001030 CONFIG_CMD_PCI * pciinfo
1031 CONFIG_CMD_PCMCIA * PCMCIA support
1032 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
1033 host
1034 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersc889fb42012-12-05 14:46:30 +00001035 CONFIG_CMD_READ * Read raw data from partition
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001036 CONFIG_CMD_REGINFO * Register dump
1037 CONFIG_CMD_RUN run command in env variable
Simon Glassbf6ce792012-12-26 09:53:36 +00001038 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001039 CONFIG_CMD_SAVES * save S record dump
1040 CONFIG_CMD_SCSI * SCSI Support
1041 CONFIG_CMD_SDRAM * print SDRAM configuration information
1042 (requires CONFIG_CMD_I2C)
1043 CONFIG_CMD_SETGETDCR Support for DCR Register access
1044 (4xx only)
Eric Nelson97f5f8f2012-01-31 10:52:08 -07001045 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001046 CONFIG_CMD_SHA1SUM * print sha1 memory digest
Robin Getz93d6cb02009-07-27 00:07:59 -04001047 (requires CONFIG_CMD_MEMORY)
Bob Liua671b702013-02-05 19:05:41 +08001048 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk85c25df2009-04-01 23:34:12 +02001049 CONFIG_CMD_SOURCE "source" command Support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001050 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7aa81a42011-05-17 00:03:40 +00001051 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass6a398d22011-10-24 18:00:07 +00001052 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershberger59f3f522012-10-03 12:14:57 +00001053 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
1054 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001055 CONFIG_CMD_USB * USB support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001056 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasut71729392012-03-31 07:47:16 +00001057 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001058 CONFIG_CMD_XIMG Load part of Multi Image
Przemyslaw Marczak2eb40ee2014-04-02 10:20:05 +02001059 CONFIG_CMD_UUID * Generate random UUID or GUID string
wdenkc6097192002-11-03 00:24:07 +00001060
1061 EXAMPLE: If you want all functions except of network
1062 support you can write:
1063
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001064 #include "config_cmd_all.h"
1065 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +00001066
Gerald Van Barend6abef42007-03-31 12:23:51 -04001067 Other Commands:
1068 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +00001069
1070 Note: Don't enable the "icache" and "dcache" commands
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001071 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk4a5c8a72003-03-06 00:02:04 +00001072 what you (and your U-Boot users) are doing. Data
1073 cache cannot be enabled on systems like the 8xx or
1074 8260 (where accesses to the IMMR region must be
1075 uncached), and it cannot be disabled on all other
1076 systems where we (mis-) use the data cache to hold an
1077 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +00001078
1079
1080 XXX - this list needs to get updated!
1081
Wolfgang Denk2aceea12013-03-23 23:50:31 +00001082- Regular expression support:
1083 CONFIG_REGEX
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001084 If this variable is defined, U-Boot is linked against
1085 the SLRE (Super Light Regular Expression) library,
1086 which adds regex support to some commands, as for
1087 example "env grep" and "setexpr".
Wolfgang Denk2aceea12013-03-23 23:50:31 +00001088
Simon Glass3d686442011-10-15 05:48:20 +00001089- Device tree:
1090 CONFIG_OF_CONTROL
1091 If this variable is defined, U-Boot will use a device tree
1092 to configure its devices, instead of relying on statically
1093 compiled #defines in the board file. This option is
1094 experimental and only available on a few boards. The device
1095 tree is available in the global data as gd->fdt_blob.
1096
Simon Glass5cb34db2011-10-24 19:15:31 +00001097 U-Boot needs to get its device tree from somewhere. This can
1098 be done using one of the two options below:
Simon Glass38d6b8d2011-10-15 05:48:21 +00001099
1100 CONFIG_OF_EMBED
1101 If this variable is defined, U-Boot will embed a device tree
1102 binary in its image. This device tree file should be in the
1103 board directory and called <soc>-<board>.dts. The binary file
1104 is then picked up in board_init_f() and made available through
1105 the global data structure as gd->blob.
Simon Glass3d686442011-10-15 05:48:20 +00001106
Simon Glass5cb34db2011-10-24 19:15:31 +00001107 CONFIG_OF_SEPARATE
1108 If this variable is defined, U-Boot will build a device tree
1109 binary. It will be called u-boot.dtb. Architecture-specific
1110 code will locate it at run-time. Generally this works by:
1111
1112 cat u-boot.bin u-boot.dtb >image.bin
1113
1114 and in fact, U-Boot does this for you, creating a file called
1115 u-boot-dtb.bin which is useful in the common case. You can
1116 still use the individual files if you need something more
1117 exotic.
1118
wdenkc6097192002-11-03 00:24:07 +00001119- Watchdog:
1120 CONFIG_WATCHDOG
1121 If this variable is defined, it enables watchdog
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +00001122 support for the SoC. There must be support in the SoC
1123 specific code for a watchdog. For the 8xx and 8260
1124 CPUs, the SIU Watchdog feature is enabled in the SYPCR
1125 register. When supported for a specific SoC is
1126 available, then no further board specific code should
1127 be needed to use it.
1128
1129 CONFIG_HW_WATCHDOG
1130 When using a watchdog circuitry external to the used
1131 SoC, then define this variable and provide board
1132 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +00001133
stroeseb9c17c52003-04-04 15:53:41 +00001134- U-Boot Version:
1135 CONFIG_VERSION_VARIABLE
1136 If this variable is defined, an environment variable
1137 named "ver" is created by U-Boot showing the U-Boot
1138 version as printed by the "version" command.
Benoît Thébaudeauce9a1552012-08-13 15:01:14 +02001139 Any change to this variable will be reverted at the
1140 next reset.
stroeseb9c17c52003-04-04 15:53:41 +00001141
wdenkc6097192002-11-03 00:24:07 +00001142- Real-Time Clock:
1143
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001144 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +00001145 has to be selected, too. Define exactly one of the
1146 following options:
1147
1148 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1149 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam3f8d1782011-10-24 06:44:15 +00001150 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001151 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1fe2c702003-03-06 21:55:29 +00001152 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001153 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk0893c472003-05-20 14:25:27 +00001154 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenkef5fe752003-03-12 10:41:04 +00001155 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krillb27939b2008-03-15 15:40:26 +01001156 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenkaeba06f2004-06-09 17:34:58 +00001157 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001158 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher1f1b7012011-03-28 09:24:22 +02001159 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1160 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001161
wdenkb9bbd242003-06-30 16:24:52 +00001162 Note that if the RTC uses I2C, then the I2C interface
1163 must also be configured. See I2C Support, below.
1164
Peter Tyser9902e422008-12-17 16:36:21 -06001165- GPIO Support:
1166 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tyser9902e422008-12-17 16:36:21 -06001167
Chris Packham9b383202010-12-19 10:12:13 +00001168 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1169 chip-ngpio pairs that tell the PCA953X driver the number of
1170 pins supported by a particular chip.
1171
Peter Tyser9902e422008-12-17 16:36:21 -06001172 Note that if the GPIO device uses I2C, then the I2C interface
1173 must also be configured. See I2C Support, below.
1174
Simon Glass4dc47ca2014-06-11 23:29:41 -06001175- I/O tracing:
1176 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
1177 accesses and can checksum them or write a list of them out
1178 to memory. See the 'iotrace' command for details. This is
1179 useful for testing device drivers since it can confirm that
1180 the driver behaves the same way before and after a code
1181 change. Currently this is supported on sandbox and arm. To
1182 add support for your architecture, add '#include <iotrace.h>'
1183 to the bottom of arch/<arch>/include/asm/io.h and test.
1184
1185 Example output from the 'iotrace stats' command is below.
1186 Note that if the trace buffer is exhausted, the checksum will
1187 still continue to operate.
1188
1189 iotrace is enabled
1190 Start: 10000000 (buffer start address)
1191 Size: 00010000 (buffer size)
1192 Offset: 00000120 (current buffer offset)
1193 Output: 10000120 (start + offset)
1194 Count: 00000018 (number of trace records)
1195 CRC32: 9526fb66 (CRC32 of all trace records)
1196
wdenkc6097192002-11-03 00:24:07 +00001197- Timestamp Support:
1198
wdenk4a5c8a72003-03-06 00:02:04 +00001199 When CONFIG_TIMESTAMP is selected, the timestamp
1200 (date and time) of an image is printed by image
1201 commands like bootm or iminfo. This option is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001202 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001203
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001204- Partition Labels (disklabels) Supported:
1205 Zero or more of the following:
1206 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1207 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1208 Intel architecture, USB sticks, etc.
1209 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1210 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1211 bootloader. Note 2TB partition limit; see
1212 disk/part_efi.c
1213 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001214
Wolfgang Denkb240aef2008-03-26 10:40:12 +01001215 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1216 CONFIG_CMD_SCSI) you must configure support for at
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001217 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001218
1219- IDE Reset method:
wdenk369d43d2004-03-14 14:09:05 +00001220 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1221 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001222
wdenk369d43d2004-03-14 14:09:05 +00001223 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1224 be performed by calling the function
1225 ide_set_reset(int reset)
1226 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001227
1228- ATAPI Support:
1229 CONFIG_ATAPI
1230
1231 Set this to enable ATAPI support.
1232
wdenkf602aa02004-03-13 23:29:43 +00001233- LBA48 Support
1234 CONFIG_LBA48
1235
1236 Set this to enable support for disks larger than 137GB
Heiko Schocher0f602e12009-12-03 11:21:21 +01001237 Also look at CONFIG_SYS_64BIT_LBA.
wdenkf602aa02004-03-13 23:29:43 +00001238 Whithout these , LBA48 support uses 32bit variables and will 'only'
1239 support disks up to 2.1TB.
1240
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001241 CONFIG_SYS_64BIT_LBA:
wdenkf602aa02004-03-13 23:29:43 +00001242 When enabled, makes the IDE subsystem use 64bit sector addresses.
1243 Default is 32bit.
1244
wdenkc6097192002-11-03 00:24:07 +00001245- SCSI Support:
1246 At the moment only there is only support for the
1247 SYM53C8XX SCSI controller; define
1248 CONFIG_SCSI_SYM53C8XX to enable it.
1249
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001250 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1251 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1252 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001253 maximum numbers of LUNs, SCSI ID's and target
1254 devices.
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001255 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001256
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001257 The environment variable 'scsidevs' is set to the number of
1258 SCSI devices found during the last scan.
Stefan Reinauere50a10e2012-10-29 05:23:48 +00001259
wdenkc6097192002-11-03 00:24:07 +00001260- NETWORK Support (PCI):
wdenk4e112c12003-06-03 23:54:09 +00001261 CONFIG_E1000
Kyle Moffett64b94dd2011-10-18 11:05:29 +00001262 Support for Intel 8254x/8257x gigabit chips.
1263
1264 CONFIG_E1000_SPI
1265 Utility code for direct access to the SPI bus on Intel 8257x.
1266 This does not do anything useful unless you set at least one
1267 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1268
1269 CONFIG_E1000_SPI_GENERIC
1270 Allow generic access to the SPI bus on the Intel 8257x, for
1271 example with the "sspi" command.
1272
1273 CONFIG_CMD_E1000
1274 Management command for E1000 devices. When used on devices
1275 with SPI support you can reprogram the EEPROM from U-Boot.
stroese94ef1cf2003-06-05 15:39:44 +00001276
Andre Schwarz68c2a302008-03-06 16:45:44 +01001277 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001278 default MAC for empty EEPROM after production.
Andre Schwarz68c2a302008-03-06 16:45:44 +01001279
wdenkc6097192002-11-03 00:24:07 +00001280 CONFIG_EEPRO100
1281 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001282 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001283 write routine for first time initialisation.
1284
1285 CONFIG_TULIP
1286 Support for Digital 2114x chips.
1287 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1288 modem chip initialisation (KS8761/QS6611).
1289
1290 CONFIG_NATSEMI
1291 Support for National dp83815 chips.
1292
1293 CONFIG_NS8382X
1294 Support for National dp8382[01] gigabit chips.
1295
wdenkaa603362003-05-12 21:50:16 +00001296- NETWORK Support (other):
1297
Jens Scharsigdab7cb82010-01-23 12:03:45 +01001298 CONFIG_DRIVER_AT91EMAC
1299 Support for AT91RM9200 EMAC.
1300
1301 CONFIG_RMII
1302 Define this to use reduced MII inteface
1303
1304 CONFIG_DRIVER_AT91EMAC_QUIET
1305 If this defined, the driver is quiet.
1306 The driver doen't show link status messages.
1307
Rob Herringc9830dc2011-12-15 11:15:49 +00001308 CONFIG_CALXEDA_XGMAC
1309 Support for the Calxeda XGMAC device
1310
Ashok93fb8722012-10-15 06:20:47 +00001311 CONFIG_LAN91C96
wdenkaa603362003-05-12 21:50:16 +00001312 Support for SMSC's LAN91C96 chips.
1313
1314 CONFIG_LAN91C96_BASE
1315 Define this to hold the physical address
1316 of the LAN91C96's I/O space
1317
1318 CONFIG_LAN91C96_USE_32_BIT
1319 Define this to enable 32 bit addressing
1320
Ashok93fb8722012-10-15 06:20:47 +00001321 CONFIG_SMC91111
wdenk3c711762004-06-09 13:37:52 +00001322 Support for SMSC's LAN91C111 chip
1323
1324 CONFIG_SMC91111_BASE
1325 Define this to hold the physical address
1326 of the device (I/O space)
1327
1328 CONFIG_SMC_USE_32_BIT
1329 Define this if data bus is 32 bits
1330
1331 CONFIG_SMC_USE_IOFUNCS
1332 Define this to use i/o functions instead of macros
1333 (some hardware wont work with macros)
1334
Heiko Schocher7d037f72011-11-15 10:00:04 -05001335 CONFIG_DRIVER_TI_EMAC
1336 Support for davinci emac
1337
1338 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1339 Define this if you have more then 3 PHYs.
1340
Macpaul Lin199c6252010-12-21 16:59:46 +08001341 CONFIG_FTGMAC100
1342 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1343
1344 CONFIG_FTGMAC100_EGIGA
1345 Define this to use GE link update with gigabit PHY.
1346 Define this if FTGMAC100 is connected to gigabit PHY.
1347 If your system has 10/100 PHY only, it might not occur
1348 wrong behavior. Because PHY usually return timeout or
1349 useless data when polling gigabit status and gigabit
1350 control registers. This behavior won't affect the
1351 correctnessof 10/100 link speed update.
1352
Mike Rapoportf4761af2009-11-11 10:03:03 +02001353 CONFIG_SMC911X
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001354 Support for SMSC's LAN911x and LAN921x chips
1355
Mike Rapoportf4761af2009-11-11 10:03:03 +02001356 CONFIG_SMC911X_BASE
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001357 Define this to hold the physical address
1358 of the device (I/O space)
1359
Mike Rapoportf4761af2009-11-11 10:03:03 +02001360 CONFIG_SMC911X_32_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001361 Define this if data bus is 32 bits
1362
Mike Rapoportf4761af2009-11-11 10:03:03 +02001363 CONFIG_SMC911X_16_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001364 Define this if data bus is 16 bits. If your processor
1365 automatically converts one 32 bit word to two 16 bit
Mike Rapoportf4761af2009-11-11 10:03:03 +02001366 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001367
Yoshihiro Shimodaed4cea02011-01-27 10:06:03 +09001368 CONFIG_SH_ETHER
1369 Support for Renesas on-chip Ethernet controller
1370
1371 CONFIG_SH_ETHER_USE_PORT
1372 Define the number of ports to be used
1373
1374 CONFIG_SH_ETHER_PHY_ADDR
1375 Define the ETH PHY's address
1376
Yoshihiro Shimoda281aa052011-01-27 10:06:08 +09001377 CONFIG_SH_ETHER_CACHE_WRITEBACK
1378 If this option is set, the driver enables cache flush.
1379
Vadim Bendeburydac69642011-10-17 08:36:14 +00001380- TPM Support:
Che-liang Chiouacea5702013-04-12 11:04:34 +00001381 CONFIG_TPM
1382 Support TPM devices.
1383
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001384 CONFIG_TPM_TIS_I2C
1385 Support for i2c bus TPM devices. Only one device
1386 per system is supported at this time.
1387
1388 CONFIG_TPM_TIS_I2C_BUS_NUMBER
1389 Define the the i2c bus number for the TPM device
1390
1391 CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
1392 Define the TPM's address on the i2c bus
1393
1394 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1395 Define the burst count bytes upper limit
1396
Dirk Eibach20489092013-06-26 15:55:15 +02001397 CONFIG_TPM_ATMEL_TWI
1398 Support for Atmel TWI TPM device. Requires I2C support.
1399
Che-liang Chiouacea5702013-04-12 11:04:34 +00001400 CONFIG_TPM_TIS_LPC
Vadim Bendeburydac69642011-10-17 08:36:14 +00001401 Support for generic parallel port TPM devices. Only one device
1402 per system is supported at this time.
1403
1404 CONFIG_TPM_TIS_BASE_ADDRESS
1405 Base address where the generic TPM device is mapped
1406 to. Contemporary x86 systems usually map it at
1407 0xfed40000.
1408
Reinhard Pfau4fece432013-06-26 15:55:13 +02001409 CONFIG_CMD_TPM
1410 Add tpm monitor functions.
1411 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1412 provides monitor access to authorized functions.
1413
1414 CONFIG_TPM
1415 Define this to enable the TPM support library which provides
1416 functional interfaces to some TPM commands.
1417 Requires support for a TPM device.
1418
1419 CONFIG_TPM_AUTH_SESSIONS
1420 Define this to enable authorized functions in the TPM library.
1421 Requires CONFIG_TPM and CONFIG_SHA1.
1422
wdenkc6097192002-11-03 00:24:07 +00001423- USB Support:
1424 At the moment only the UHCI host controller is
wdenk369d43d2004-03-14 14:09:05 +00001425 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001426 CONFIG_USB_UHCI to enable it.
1427 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenkfb30b4c2004-10-09 22:44:59 +00001428 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001429 storage devices.
1430 Note:
1431 Supported are USB Keyboards and USB Floppy drives
1432 (TEAC FD-05PUB).
wdenk369d43d2004-03-14 14:09:05 +00001433 MPC5200 USB requires additional defines:
1434 CONFIG_USB_CLOCK
1435 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt02848522009-08-13 08:32:37 -05001436 CONFIG_PSC3_USB
1437 for USB on PSC3
wdenk369d43d2004-03-14 14:09:05 +00001438 CONFIG_USB_CONFIG
1439 for differential drivers: 0x00001000
1440 for single ended drivers: 0x00005000
Eric Millbrandt02848522009-08-13 08:32:37 -05001441 for differential drivers on PSC3: 0x00000100
1442 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001443 CONFIG_SYS_USB_EVENT_POLL
Zhang Wei063f9ff2007-06-06 10:08:13 +02001444 May be defined to allow interrupt polling
1445 instead of using asynchronous interrupts
wdenk369d43d2004-03-14 14:09:05 +00001446
Simon Glass5978cdb2012-02-27 10:52:47 +00001447 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1448 txfilltuning field in the EHCI controller on reset.
1449
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001450- USB Device:
1451 Define the below if you wish to use the USB console.
1452 Once firmware is rebuilt from a serial console issue the
1453 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001454 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001455 it has found a new device. The environment variable usbtty
1456 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denke2601822006-06-14 18:14:56 +02001457 appear to a USB host as a Linux gserial device or a
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001458 Common Device Class Abstract Control Model serial device.
1459 If you select usbtty = gserial you should be able to enumerate
1460 a Linux host by
1461 # modprobe usbserial vendor=0xVendorID product=0xProductID
1462 else if using cdc_acm, simply setting the environment
1463 variable usbtty to be cdc_acm should suffice. The following
1464 might be defined in YourBoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001465
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001466 CONFIG_USB_DEVICE
1467 Define this to build a UDC device
1468
1469 CONFIG_USB_TTY
1470 Define this to have a tty type of device available to
1471 talk to the UDC device
Wolfgang Denke2601822006-06-14 18:14:56 +02001472
Vipin KUMARbdb17702012-03-26 15:38:06 +05301473 CONFIG_USBD_HS
1474 Define this to enable the high speed support for usb
1475 device and usbtty. If this feature is enabled, a routine
1476 int is_usbd_high_speed(void)
1477 also needs to be defined by the driver to dynamically poll
1478 whether the enumeration has succeded at high speed or full
1479 speed.
1480
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001481 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001482 Define this if you want stdin, stdout &/or stderr to
1483 be set to usbtty.
1484
1485 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001486 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001487 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001488 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denke2601822006-06-14 18:14:56 +02001489
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001490 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001491 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001492 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001493
Wolfgang Denke2601822006-06-14 18:14:56 +02001494 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001495 define your own vendor specific values either in BoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001496 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001497 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1498 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1499 should pretend to be a Linux device to it's target host.
1500
1501 CONFIG_USBD_MANUFACTURER
1502 Define this string as the name of your company for
1503 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denke2601822006-06-14 18:14:56 +02001504
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001505 CONFIG_USBD_PRODUCT_NAME
1506 Define this string as the name of your product
1507 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
wdenkc6097192002-11-03 00:24:07 +00001508
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001509 CONFIG_USBD_VENDORID
1510 Define this as your assigned Vendor ID from the USB
1511 Implementors Forum. This *must* be a genuine Vendor ID
1512 to avoid polluting the USB namespace.
1513 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001514
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001515 CONFIG_USBD_PRODUCTID
1516 Define this as the unique Product ID
1517 for your device
1518 - CONFIG_USBD_PRODUCTID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001519
Igor Grinbergac5f6ee2011-12-12 12:08:35 +02001520- ULPI Layer Support:
1521 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1522 the generic ULPI layer. The generic layer accesses the ULPI PHY
1523 via the platform viewport, so you need both the genric layer and
1524 the viewport enabled. Currently only Chipidea/ARC based
1525 viewport is supported.
1526 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1527 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stachf31e4112012-10-01 00:44:35 +02001528 If your ULPI phy needs a different reference clock than the
1529 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1530 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001531
wdenk7a428cc2003-06-15 22:40:42 +00001532- MMC Support:
wdenk57b2d802003-06-27 21:31:46 +00001533 The MMC controller on the Intel PXA is supported. To
1534 enable this define CONFIG_MMC. The MMC can be
1535 accessed from the boot prompt by mapping the device
wdenk7a428cc2003-06-15 22:40:42 +00001536 to physical memory similar to flash. Command line is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001537 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1538 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenk7a428cc2003-06-15 22:40:42 +00001539
Yoshihiro Shimodadb7717b2011-07-04 22:21:22 +00001540 CONFIG_SH_MMCIF
1541 Support for Renesas on-chip MMCIF controller
1542
1543 CONFIG_SH_MMCIF_ADDR
1544 Define the base address of MMCIF registers
1545
1546 CONFIG_SH_MMCIF_CLK
1547 Define the clock frequency for MMCIF
1548
Pierre Aubertbcc302c2014-04-24 10:30:08 +02001549 CONFIG_GENERIC_MMC
1550 Enable the generic MMC driver
1551
1552 CONFIG_SUPPORT_EMMC_BOOT
1553 Enable some additional features of the eMMC boot partitions.
1554
1555 CONFIG_SUPPORT_EMMC_RPMB
1556 Enable the commands for reading, writing and programming the
1557 key for the Replay Protection Memory Block partition in eMMC.
1558
Tom Rini58a8d322013-03-14 05:32:47 +00001559- USB Device Firmware Update (DFU) class support:
1560 CONFIG_DFU_FUNCTION
1561 This enables the USB portion of the DFU USB class
1562
1563 CONFIG_CMD_DFU
1564 This enables the command "dfu" which is used to have
1565 U-Boot create a DFU class device via USB. This command
1566 requires that the "dfu_alt_info" environment variable be
1567 set and define the alt settings to expose to the host.
1568
1569 CONFIG_DFU_MMC
1570 This enables support for exposing (e)MMC devices via DFU.
1571
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +00001572 CONFIG_DFU_NAND
1573 This enables support for exposing NAND devices via DFU.
1574
Afzal Mohammede3c687a2013-09-18 01:15:24 +05301575 CONFIG_DFU_RAM
1576 This enables support for exposing RAM via DFU.
1577 Note: DFU spec refer to non-volatile memory usage, but
1578 allow usages beyond the scope of spec - here RAM usage,
1579 one that would help mostly the developer.
1580
Heiko Schochera2f831e2013-06-12 06:05:51 +02001581 CONFIG_SYS_DFU_DATA_BUF_SIZE
1582 Dfu transfer uses a buffer before writing data to the
1583 raw storage device. Make the size (in bytes) of this buffer
1584 configurable. The size of this buffer is also configurable
1585 through the "dfu_bufsiz" environment variable.
1586
Pantelis Antonioua6e788d2013-03-14 05:32:48 +00001587 CONFIG_SYS_DFU_MAX_FILE_SIZE
1588 When updating files rather than the raw storage device,
1589 we use a static buffer to copy the file into and then write
1590 the buffer once we've been given the whole file. Define
1591 this to the maximum filesize (in bytes) for the buffer.
1592 Default is 4 MiB if undefined.
1593
Heiko Schochere1ba1512014-03-18 08:09:56 +01001594 DFU_DEFAULT_POLL_TIMEOUT
1595 Poll timeout [ms], is the timeout a device can send to the
1596 host. The host must wait for this timeout before sending
1597 a subsequent DFU_GET_STATUS request to the device.
1598
1599 DFU_MANIFEST_POLL_TIMEOUT
1600 Poll timeout [ms], which the device sends to the host when
1601 entering dfuMANIFEST state. Host waits this timeout, before
1602 sending again an USB request to the device.
1603
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001604- USB Device Android Fastboot support:
1605 CONFIG_CMD_FASTBOOT
1606 This enables the command "fastboot" which enables the Android
1607 fastboot mode for the platform's USB device. Fastboot is a USB
1608 protocol for downloading images, flashing and device control
1609 used on Android devices.
1610 See doc/README.android-fastboot for more information.
1611
1612 CONFIG_ANDROID_BOOT_IMAGE
1613 This enables support for booting images which use the Android
1614 image format header.
1615
1616 CONFIG_USB_FASTBOOT_BUF_ADDR
1617 The fastboot protocol requires a large memory buffer for
1618 downloads. Define this to the starting RAM address to use for
1619 downloaded images.
1620
1621 CONFIG_USB_FASTBOOT_BUF_SIZE
1622 The fastboot protocol requires a large memory buffer for
1623 downloads. This buffer should be as large as possible for a
1624 platform. Define this to the size available RAM for fastboot.
1625
wdenkda04a8b2004-08-02 23:22:59 +00001626- Journaling Flash filesystem support:
1627 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1628 CONFIG_JFFS2_NAND_DEV
1629 Define these for a default partition on a NAND device
1630
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001631 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1632 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenkda04a8b2004-08-02 23:22:59 +00001633 Define these for a default partition on a NOR device
1634
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001635 CONFIG_SYS_JFFS_CUSTOM_PART
wdenkda04a8b2004-08-02 23:22:59 +00001636 Define this to create an own partition. You have to provide a
1637 function struct part_info* jffs2_part_info(int part_num)
1638
1639 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001640 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenkda04a8b2004-08-02 23:22:59 +00001641 to disable the command chpart. This is the default when you
1642 have not defined a custom partition
1643
Donggeun Kim8f814002011-10-24 21:15:28 +00001644- FAT(File Allocation Table) filesystem write function support:
1645 CONFIG_FAT_WRITE
Donggeun Kimb44c8ab2012-03-22 04:38:56 +00001646
1647 Define this to enable support for saving memory data as a
1648 file in FAT formatted partition.
1649
1650 This will also enable the command "fatwrite" enabling the
1651 user to write files to FAT.
Donggeun Kim8f814002011-10-24 21:15:28 +00001652
Gabe Black7f8574c2012-10-12 14:26:11 +00001653CBFS (Coreboot Filesystem) support
1654 CONFIG_CMD_CBFS
1655
1656 Define this to enable support for reading from a Coreboot
1657 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1658 and cbfsload.
1659
Siva Durga Prasad Paladugu1c4cf332014-05-26 19:18:37 +05301660- FAT(File Allocation Table) filesystem cluster size:
1661 CONFIG_FS_FAT_MAX_CLUSTSIZE
1662
1663 Define the max cluster size for fat operations else
1664 a default value of 65536 will be defined.
1665
wdenkc6097192002-11-03 00:24:07 +00001666- Keyboard Support:
1667 CONFIG_ISA_KEYBOARD
1668
1669 Define this to enable standard (PC-Style) keyboard
1670 support
1671
1672 CONFIG_I8042_KBD
1673 Standard PC keyboard driver with US (is default) and
1674 GERMAN key layout (switch via environment 'keymap=de') support.
1675 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1676 for cfb_console. Supports cursor blinking.
1677
Hung-ying Tyan4a48bcf2013-05-15 18:27:32 +08001678 CONFIG_CROS_EC_KEYB
1679 Enables a Chrome OS keyboard using the CROS_EC interface.
1680 This uses CROS_EC to communicate with a second microcontroller
1681 which provides key scans on request.
1682
wdenkc6097192002-11-03 00:24:07 +00001683- Video support:
1684 CONFIG_VIDEO
1685
1686 Define this to enable video support (for output to
1687 video).
1688
1689 CONFIG_VIDEO_CT69000
1690
1691 Enable Chips & Technologies 69000 Video chip
1692
1693 CONFIG_VIDEO_SMI_LYNXEM
wdenkd3602132004-03-25 15:14:43 +00001694 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkaea86e42004-03-23 22:53:55 +00001695 video output is selected via environment 'videoout'
1696 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1697 assumed.
wdenkc6097192002-11-03 00:24:07 +00001698
wdenkd3602132004-03-25 15:14:43 +00001699 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001700 selected via environment 'videomode'. Two different ways
wdenkaea86e42004-03-23 22:53:55 +00001701 are possible:
1702 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk05939202004-04-18 17:39:38 +00001703 Following standard modes are supported (* is default):
wdenkaea86e42004-03-23 22:53:55 +00001704
1705 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1706 -------------+---------------------------------------------
1707 8 bits | 0x301* 0x303 0x305 0x161 0x307
1708 15 bits | 0x310 0x313 0x316 0x162 0x319
1709 16 bits | 0x311 0x314 0x317 0x163 0x31A
1710 24 bits | 0x312 0x315 0x318 ? 0x31B
1711 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001712 (i.e. setenv videomode 317; saveenv; reset;)
1713
wdenkd3602132004-03-25 15:14:43 +00001714 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswileraea68562007-12-30 03:30:46 +01001715 from the bootargs. (See drivers/video/videomodes.c)
wdenkaea86e42004-03-23 22:53:55 +00001716
1717
stroeseb9c17c52003-04-04 15:53:41 +00001718 CONFIG_VIDEO_SED13806
wdenk4a5c8a72003-03-06 00:02:04 +00001719 Enable Epson SED13806 driver. This driver supports 8bpp
wdenk9dd2b882002-12-03 21:28:10 +00001720 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1721 or CONFIG_VIDEO_SED13806_16BPP
1722
Timur Tabi020edd22011-02-15 17:09:19 -06001723 CONFIG_FSL_DIU_FB
Wolfgang Denk825223d2011-09-11 21:24:09 +02001724 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi020edd22011-02-15 17:09:19 -06001725 SOCs that have a DIU should define this macro to enable DIU
1726 support, and should also define these other macros:
1727
1728 CONFIG_SYS_DIU_ADDR
1729 CONFIG_VIDEO
1730 CONFIG_CMD_BMP
1731 CONFIG_CFB_CONSOLE
1732 CONFIG_VIDEO_SW_CURSOR
1733 CONFIG_VGA_AS_SINGLE_DEVICE
1734 CONFIG_VIDEO_LOGO
1735 CONFIG_VIDEO_BMP_LOGO
1736
Timur Tabi32f709e2011-04-11 14:18:22 -05001737 The DIU driver will look for the 'video-mode' environment
1738 variable, and if defined, enable the DIU as a console during
1739 boot. See the documentation file README.video for a
1740 description of this variable.
Timur Tabi020edd22011-02-15 17:09:19 -06001741
Simon Glass54df8ce2012-12-03 13:59:47 +00001742 CONFIG_VIDEO_VGA
1743
1744 Enable the VGA video / BIOS for x86. The alternative if you
1745 are using coreboot is to use the coreboot frame buffer
1746 driver.
1747
1748
wdenk4e112c12003-06-03 23:54:09 +00001749- Keyboard Support:
wdenk57b2d802003-06-27 21:31:46 +00001750 CONFIG_KEYBOARD
wdenk4e112c12003-06-03 23:54:09 +00001751
wdenk57b2d802003-06-27 21:31:46 +00001752 Define this to enable a custom keyboard support.
1753 This simply calls drv_keyboard_init() which must be
1754 defined in your board-specific files.
1755 The only board using this so far is RBC823.
wdenk9dd2b882002-12-03 21:28:10 +00001756
wdenkc6097192002-11-03 00:24:07 +00001757- LCD Support: CONFIG_LCD
1758
1759 Define this to enable LCD support (for output to LCD
1760 display); also select one of the supported displays
1761 by defining one of these:
1762
Stelian Popf6f86652008-05-09 21:57:18 +02001763 CONFIG_ATMEL_LCD:
1764
1765 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1766
wdenkc0d54ae2003-11-25 16:55:19 +00001767 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001768
wdenkc0d54ae2003-11-25 16:55:19 +00001769 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001770
wdenkc0d54ae2003-11-25 16:55:19 +00001771 CONFIG_NEC_NL6448BC20
1772
1773 NEC NL6448BC20-08. 6.5", 640x480.
1774 Active, color, single scan.
1775
1776 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +00001777
wdenkc0d54ae2003-11-25 16:55:19 +00001778 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001779 Active, color, single scan.
1780
1781 CONFIG_SHARP_16x9
1782
1783 Sharp 320x240. Active, color, single scan.
1784 It isn't 16x9, and I am not sure what it is.
1785
1786 CONFIG_SHARP_LQ64D341
1787
1788 Sharp LQ64D341 display, 640x480.
1789 Active, color, single scan.
1790
1791 CONFIG_HLD1045
1792
1793 HLD1045 display, 640x480.
1794 Active, color, single scan.
1795
1796 CONFIG_OPTREX_BW
1797
1798 Optrex CBL50840-2 NF-FW 99 22 M5
1799 or
1800 Hitachi LMG6912RPFC-00T
1801 or
1802 Hitachi SP14Q002
1803
1804 320x240. Black & white.
1805
1806 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001807 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001808
Simon Glass599a4df2012-10-17 13:24:54 +00001809 CONFIG_LCD_ALIGNMENT
1810
1811 Normally the LCD is page-aligned (tyically 4KB). If this is
1812 defined then the LCD will be aligned to this value instead.
1813 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1814 here, since it is cheaper to change data cache settings on
1815 a per-section basis.
1816
Simon Glassaf3e2802012-10-17 13:24:59 +00001817 CONFIG_CONSOLE_SCROLL_LINES
1818
1819 When the console need to be scrolled, this is the number of
1820 lines to scroll by. It defaults to 1. Increasing this makes
1821 the console jump but can help speed up operation when scrolling
1822 is slow.
Simon Glass599a4df2012-10-17 13:24:54 +00001823
Tom Wai-Hong Tam79926a42012-09-28 15:11:16 +00001824 CONFIG_LCD_BMP_RLE8
1825
1826 Support drawing of RLE8-compressed bitmaps on the LCD.
1827
Tom Wai-Hong Tam6664f202012-12-05 14:46:40 +00001828 CONFIG_I2C_EDID
1829
1830 Enables an 'i2c edid' command which can read EDID
1831 information over I2C from an attached LCD display.
1832
wdenkeb20ad32003-09-05 23:19:14 +00001833- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenk92bbe3f2003-04-20 14:04:18 +00001834
wdenk57b2d802003-06-27 21:31:46 +00001835 If this option is set, the environment is checked for
1836 a variable "splashimage". If found, the usual display
1837 of logo, copyright and system information on the LCD
wdenk01686632004-06-30 22:59:18 +00001838 is suppressed and the BMP image at the address
wdenk57b2d802003-06-27 21:31:46 +00001839 specified in "splashimage" is loaded instead. The
1840 console is redirected to the "nulldev", too. This
1841 allows for a "silent" boot where a splash screen is
1842 loaded very quickly after power-on.
wdenk92bbe3f2003-04-20 14:04:18 +00001843
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001844 CONFIG_SPLASHIMAGE_GUARD
1845
1846 If this option is set, then U-Boot will prevent the environment
1847 variable "splashimage" from being set to a problematic address
Tom Rini958a8f82014-02-25 10:27:01 -05001848 (see README.displaying-bmps).
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001849 This option is useful for targets where, due to alignment
1850 restrictions, an improperly aligned BMP image will cause a data
1851 abort. If you think you will not have problems with unaligned
1852 accesses (for example because your toolchain prevents them)
1853 there is no need to set this option.
1854
Matthias Weisser53884182009-07-09 16:07:30 +02001855 CONFIG_SPLASH_SCREEN_ALIGN
1856
1857 If this option is set the splash image can be freely positioned
1858 on the screen. Environment variable "splashpos" specifies the
1859 position as "x,y". If a positive number is given it is used as
1860 number of pixel from left/top. If a negative number is given it
1861 is used as number of pixel from right/bottom. You can also
1862 specify 'm' for centering the image.
1863
1864 Example:
1865 setenv splashpos m,m
1866 => image at center of screen
1867
1868 setenv splashpos 30,20
1869 => image at x = 30 and y = 20
1870
1871 setenv splashpos -10,m
1872 => vertically centered image
1873 at x = dspWidth - bmpWidth - 9
1874
Stefan Roesed9d97742005-09-22 09:04:17 +02001875- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1876
1877 If this option is set, additionally to standard BMP
1878 images, gzipped BMP images can be displayed via the
1879 splashscreen support or the bmp command.
1880
Anatolij Gustschin6b4e4fc2010-03-15 14:50:25 +01001881- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1882
1883 If this option is set, 8-bit RLE compressed BMP images
1884 can be displayed via the splashscreen support or the
1885 bmp command.
1886
Lei Wene4e248d2012-09-28 04:26:47 +00001887- Do compresssing for memory range:
1888 CONFIG_CMD_ZIP
1889
1890 If this option is set, it would use zlib deflate method
1891 to compress the specified memory at its best effort.
1892
wdenk710e3502003-08-29 20:57:53 +00001893- Compression support:
Kees Cook5b06e642013-08-16 07:59:12 -07001894 CONFIG_GZIP
1895
1896 Enabled by default to support gzip compressed images.
1897
wdenk710e3502003-08-29 20:57:53 +00001898 CONFIG_BZIP2
1899
1900 If this option is set, support for bzip2 compressed
1901 images is included. If not, only uncompressed and gzip
1902 compressed images are supported.
1903
wdenk9c53f402003-10-15 23:53:47 +00001904 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001905 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk9c53f402003-10-15 23:53:47 +00001906 be at least 4MB.
wdenk92bbe3f2003-04-20 14:04:18 +00001907
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001908 CONFIG_LZMA
1909
1910 If this option is set, support for lzma compressed
1911 images is included.
1912
1913 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1914 requires an amount of dynamic memory that is given by the
1915 formula:
1916
1917 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1918
1919 Where lc and lp stand for, respectively, Literal context bits
1920 and Literal pos bits.
1921
1922 This value is upper-bounded by 14MB in the worst case. Anyway,
1923 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1924 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1925 a very small buffer.
1926
1927 Use the lzmainfo tool to determinate the lc and lp values and
1928 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001929 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001930
Kees Cook5b06e642013-08-16 07:59:12 -07001931 CONFIG_LZO
1932
1933 If this option is set, support for LZO compressed images
1934 is included.
1935
wdenk0e2bd9c2004-06-06 21:51:03 +00001936- MII/PHY support:
1937 CONFIG_PHY_ADDR
1938
1939 The address of PHY on MII bus.
1940
1941 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1942
1943 The clock frequency of the MII bus
1944
1945 CONFIG_PHY_GIGE
1946
1947 If this option is set, support for speed/duplex
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001948 detection of gigabit PHY is included.
wdenk0e2bd9c2004-06-06 21:51:03 +00001949
1950 CONFIG_PHY_RESET_DELAY
1951
1952 Some PHY like Intel LXT971A need extra delay after
1953 reset before any MII register access is possible.
1954 For such PHY, set this option to the usec delay
1955 required. (minimum 300usec for LXT971A)
1956
1957 CONFIG_PHY_CMD_DELAY (ppc4xx)
1958
1959 Some PHY like Intel LXT971A need extra delay after
1960 command issued before MII status register can be read
1961
wdenkc6097192002-11-03 00:24:07 +00001962- Ethernet address:
1963 CONFIG_ETHADDR
richardretanubune5167f12008-09-29 18:28:23 -04001964 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001965 CONFIG_ETH2ADDR
1966 CONFIG_ETH3ADDR
richardretanubune5167f12008-09-29 18:28:23 -04001967 CONFIG_ETH4ADDR
1968 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001969
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001970 Define a default value for Ethernet address to use
1971 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001972 is not determined automatically.
1973
1974- IP address:
1975 CONFIG_IPADDR
1976
1977 Define a default value for the IP address to use for
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001978 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001979 determined through e.g. bootp.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001980 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001981
1982- Server IP address:
1983 CONFIG_SERVERIP
1984
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001985 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001986 server to contact when using the "tftboot" command.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001987 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001988
Robin Getz470a6d42009-07-21 12:15:28 -04001989 CONFIG_KEEP_SERVERADDR
1990
1991 Keeps the server's MAC address, in the env 'serveraddr'
1992 for passing to bootargs (like Linux's netconsole option)
1993
Wolfgang Denk26da2992011-10-26 10:21:22 +00001994- Gateway IP address:
1995 CONFIG_GATEWAYIP
1996
1997 Defines a default value for the IP address of the
1998 default router where packets to other networks are
1999 sent to.
2000 (Environment variable "gatewayip")
2001
2002- Subnet mask:
2003 CONFIG_NETMASK
2004
2005 Defines a default value for the subnet mask (or
2006 routing prefix) which is used to determine if an IP
2007 address belongs to the local subnet or needs to be
2008 forwarded through a router.
2009 (Environment variable "netmask")
2010
David Updegraff7280da72007-06-11 10:41:07 -05002011- Multicast TFTP Mode:
2012 CONFIG_MCAST_TFTP
2013
2014 Defines whether you want to support multicast TFTP as per
2015 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002016 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff7280da72007-06-11 10:41:07 -05002017 driver in use must provide a function: mcast() to join/leave a
2018 multicast group.
2019
wdenkc6097192002-11-03 00:24:07 +00002020- BOOTP Recovery Mode:
2021 CONFIG_BOOTP_RANDOM_DELAY
2022
2023 If you have many targets in a network that try to
2024 boot using BOOTP, you may want to avoid that all
2025 systems send out BOOTP requests at precisely the same
2026 moment (which would happen for instance at recovery
2027 from a power failure, when all systems will try to
2028 boot, thus flooding the BOOTP server. Defining
2029 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
2030 inserted before sending out BOOTP requests. The
Wolfgang Denkb65aaf92007-08-06 23:21:05 +02002031 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00002032
2033 1st BOOTP request: delay 0 ... 1 sec
2034 2nd BOOTP request: delay 0 ... 2 sec
2035 3rd BOOTP request: delay 0 ... 4 sec
2036 4th and following
2037 BOOTP requests: delay 0 ... 8 sec
2038
stroesee0aadfb2003-08-28 14:17:32 +00002039- DHCP Advanced Options:
Jon Loeliger5336a762007-07-09 22:08:34 -05002040 You can fine tune the DHCP functionality by defining
2041 CONFIG_BOOTP_* symbols:
stroesee0aadfb2003-08-28 14:17:32 +00002042
Jon Loeliger5336a762007-07-09 22:08:34 -05002043 CONFIG_BOOTP_SUBNETMASK
2044 CONFIG_BOOTP_GATEWAY
2045 CONFIG_BOOTP_HOSTNAME
2046 CONFIG_BOOTP_NISDOMAIN
2047 CONFIG_BOOTP_BOOTPATH
2048 CONFIG_BOOTP_BOOTFILESIZE
2049 CONFIG_BOOTP_DNS
2050 CONFIG_BOOTP_DNS2
2051 CONFIG_BOOTP_SEND_HOSTNAME
2052 CONFIG_BOOTP_NTPSERVER
2053 CONFIG_BOOTP_TIMEOFFSET
2054 CONFIG_BOOTP_VENDOREX
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00002055 CONFIG_BOOTP_MAY_FAIL
stroesee0aadfb2003-08-28 14:17:32 +00002056
Wilson Callan22bcd6e2007-07-28 10:56:13 -04002057 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
2058 environment variable, not the BOOTP server.
stroesee0aadfb2003-08-28 14:17:32 +00002059
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00002060 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
2061 after the configured retry count, the call will fail
2062 instead of starting over. This can be used to fail over
2063 to Link-local IP address configuration if the DHCP server
2064 is not available.
2065
stroesee0aadfb2003-08-28 14:17:32 +00002066 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
2067 serverip from a DHCP server, it is possible that more
2068 than one DNS serverip is offered to the client.
2069 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
2070 serverip will be stored in the additional environment
2071 variable "dnsip2". The first DNS serverip is always
2072 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger5336a762007-07-09 22:08:34 -05002073 is defined.
stroesee0aadfb2003-08-28 14:17:32 +00002074
2075 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
2076 to do a dynamic update of a DNS server. To do this, they
2077 need the hostname of the DHCP requester.
Wilson Callan22bcd6e2007-07-28 10:56:13 -04002078 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger5336a762007-07-09 22:08:34 -05002079 of the "hostname" environment variable is passed as
2080 option 12 to the DHCP server.
stroesee0aadfb2003-08-28 14:17:32 +00002081
Aras Vaichas72aa3f32008-03-26 09:43:57 +11002082 CONFIG_BOOTP_DHCP_REQUEST_DELAY
2083
2084 A 32bit value in microseconds for a delay between
2085 receiving a "DHCP Offer" and sending the "DHCP Request".
2086 This fixes a problem with certain DHCP servers that don't
2087 respond 100% of the time to a "DHCP request". E.g. On an
2088 AT91RM9200 processor running at 180MHz, this delay needed
2089 to be *at least* 15,000 usec before a Windows Server 2003
2090 DHCP server would reply 100% of the time. I recommend at
2091 least 50,000 usec to be safe. The alternative is to hope
2092 that one of the retries will be successful but note that
2093 the DHCP timeout and retry process takes a longer than
2094 this delay.
2095
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00002096 - Link-local IP address negotiation:
2097 Negotiate with other link-local clients on the local network
2098 for an address that doesn't require explicit configuration.
2099 This is especially useful if a DHCP server cannot be guaranteed
2100 to exist in all environments that the device must operate.
2101
2102 See doc/README.link-local for more information.
2103
wdenk145d2c12004-04-15 21:48:45 +00002104 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00002105 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00002106
2107 The device id used in CDP trigger frames.
2108
2109 CONFIG_CDP_DEVICE_ID_PREFIX
2110
2111 A two character string which is prefixed to the MAC address
2112 of the device.
2113
2114 CONFIG_CDP_PORT_ID
2115
2116 A printf format string which contains the ascii name of
2117 the port. Normally is set to "eth%d" which sets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002118 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-04-15 21:48:45 +00002119
2120 CONFIG_CDP_CAPABILITIES
2121
2122 A 32bit integer which indicates the device capabilities;
2123 0x00000010 for a normal host which does not forwards.
2124
2125 CONFIG_CDP_VERSION
2126
2127 An ascii string containing the version of the software.
2128
2129 CONFIG_CDP_PLATFORM
2130
2131 An ascii string containing the name of the platform.
2132
2133 CONFIG_CDP_TRIGGER
2134
2135 A 32bit integer sent on the trigger.
2136
2137 CONFIG_CDP_POWER_CONSUMPTION
2138
2139 A 16bit integer containing the power consumption of the
2140 device in .1 of milliwatts.
2141
2142 CONFIG_CDP_APPLIANCE_VLAN_TYPE
2143
2144 A byte containing the id of the VLAN.
2145
wdenkc6097192002-11-03 00:24:07 +00002146- Status LED: CONFIG_STATUS_LED
2147
2148 Several configurations allow to display the current
2149 status using a LED. For instance, the LED will blink
2150 fast while running U-Boot code, stop blinking as
2151 soon as a reply to a BOOTP request was received, and
2152 start blinking slow once the Linux kernel is running
2153 (supported by a status LED driver in the Linux
2154 kernel). Defining CONFIG_STATUS_LED enables this
2155 feature in U-Boot.
2156
Igor Grinberg4997a9e2013-11-08 01:03:50 +02002157 Additional options:
2158
2159 CONFIG_GPIO_LED
2160 The status LED can be connected to a GPIO pin.
2161 In such cases, the gpio_led driver can be used as a
2162 status LED backend implementation. Define CONFIG_GPIO_LED
2163 to include the gpio_led driver in the U-Boot binary.
2164
Igor Grinberg203bd9f2013-11-08 01:03:52 +02002165 CONFIG_GPIO_LED_INVERTED_TABLE
2166 Some GPIO connected LEDs may have inverted polarity in which
2167 case the GPIO high value corresponds to LED off state and
2168 GPIO low value corresponds to LED on state.
2169 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
2170 with a list of GPIO LEDs that have inverted polarity.
2171
wdenkc6097192002-11-03 00:24:07 +00002172- CAN Support: CONFIG_CAN_DRIVER
2173
2174 Defining CONFIG_CAN_DRIVER enables CAN driver support
2175 on those systems that support this (optional)
2176 feature, like the TQM8xxL modules.
2177
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002178- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00002179
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002180 This enable the NEW i2c subsystem, and will allow you to use
2181 i2c commands at the u-boot command line (as long as you set
2182 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
2183 based realtime clock chips or other i2c devices. See
2184 common/cmd_i2c.c for a description of the command line
2185 interface.
2186
2187 ported i2c driver to the new framework:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002188 - drivers/i2c/soft_i2c.c:
2189 - activate first bus with CONFIG_SYS_I2C_SOFT define
2190 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2191 for defining speed and slave address
2192 - activate second bus with I2C_SOFT_DECLARATIONS2 define
2193 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2194 for defining speed and slave address
2195 - activate third bus with I2C_SOFT_DECLARATIONS3 define
2196 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2197 for defining speed and slave address
2198 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2199 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2200 for defining speed and slave address
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002201
Heiko Schocherf2850742012-10-24 13:48:22 +02002202 - drivers/i2c/fsl_i2c.c:
2203 - activate i2c driver with CONFIG_SYS_I2C_FSL
2204 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
2205 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
2206 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
2207 bus.
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02002208 - If your board supports a second fsl i2c bus, define
Heiko Schocherf2850742012-10-24 13:48:22 +02002209 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
2210 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
2211 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
2212 second bus.
2213
Simon Glass026fefb2012-10-30 07:28:53 +00002214 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu045acfa2013-10-11 16:23:53 +09002215 - activate this driver with CONFIG_SYS_I2C_TEGRA
2216 - This driver adds 4 i2c buses with a fix speed from
2217 100000 and the slave addr 0!
Simon Glass026fefb2012-10-30 07:28:53 +00002218
Dirk Eibach42b204f2013-04-25 02:40:01 +00002219 - drivers/i2c/ppc4xx_i2c.c
2220 - activate this driver with CONFIG_SYS_I2C_PPC4XX
2221 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2222 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2223
trema49f40a2013-09-21 18:13:35 +02002224 - drivers/i2c/i2c_mxc.c
2225 - activate this driver with CONFIG_SYS_I2C_MXC
2226 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2227 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2228 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2229 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2230 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2231 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
2232 If thoses defines are not set, default value is 100000
2233 for speed, and 0 for slave.
2234
Nobuhiro Iwamatsue94ea2f2013-09-27 16:58:30 +09002235 - drivers/i2c/rcar_i2c.c:
2236 - activate this driver with CONFIG_SYS_I2C_RCAR
2237 - This driver adds 4 i2c buses
2238
2239 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2240 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2241 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2242 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2243 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2244 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2245 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2246 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2247 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2248
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09002249 - drivers/i2c/sh_i2c.c:
2250 - activate this driver with CONFIG_SYS_I2C_SH
2251 - This driver adds from 2 to 5 i2c buses
2252
2253 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
2254 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
2255 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
2256 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
2257 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
2258 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2259 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2260 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2261 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2262 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
2263 - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
2264 - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
2265 - CONFIF_SYS_I2C_SH_NUM_CONTROLLERS for nummber of i2c buses
2266
Heiko Schocherf53f2b82013-10-22 11:03:18 +02002267 - drivers/i2c/omap24xx_i2c.c
2268 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2269 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2270 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2271 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2272 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2273 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2274 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2275 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2276 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2277 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2278 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2279
Heiko Schocher465819a2013-11-08 07:30:53 +01002280 - drivers/i2c/zynq_i2c.c
2281 - activate this driver with CONFIG_SYS_I2C_ZYNQ
2282 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2283 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2284
Naveen Krishna Ch5d5efd32013-12-06 12:12:38 +05302285 - drivers/i2c/s3c24x0_i2c.c:
2286 - activate this driver with CONFIG_SYS_I2C_S3C24X0
2287 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2288 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2289 with a fix speed from 100000 and the slave addr 0!
2290
Dirk Eibachb9577432014-07-03 09:28:18 +02002291 - drivers/i2c/ihs_i2c.c
2292 - activate this driver with CONFIG_SYS_I2C_IHS
2293 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2294 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2295 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2296 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2297 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2298 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2299 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2300 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2301 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2302 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2303 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2304 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
2305
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002306 additional defines:
2307
2308 CONFIG_SYS_NUM_I2C_BUSES
2309 Hold the number of i2c busses you want to use. If you
2310 don't use/have i2c muxes on your i2c bus, this
2311 is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
2312 omit this define.
2313
2314 CONFIG_SYS_I2C_DIRECT_BUS
2315 define this, if you don't use i2c muxes on your hardware.
2316 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2317 omit this define.
2318
2319 CONFIG_SYS_I2C_MAX_HOPS
2320 define how many muxes are maximal consecutively connected
2321 on one i2c bus. If you not use i2c muxes, omit this
2322 define.
2323
2324 CONFIG_SYS_I2C_BUSES
2325 hold a list of busses you want to use, only used if
2326 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2327 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2328 CONFIG_SYS_NUM_I2C_BUSES = 9:
2329
2330 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2331 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2332 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2333 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2334 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2335 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2336 {1, {I2C_NULL_HOP}}, \
2337 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2338 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2339 }
2340
2341 which defines
2342 bus 0 on adapter 0 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002343 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2344 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2345 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2346 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2347 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002348 bus 6 on adapter 1 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002349 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2350 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002351
2352 If you do not have i2c muxes on your board, omit this define.
2353
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002354- Legacy I2C Support: CONFIG_HARD_I2C
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002355
2356 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
2357 provides the following compelling advantages:
2358
2359 - more than one i2c adapter is usable
2360 - approved multibus support
2361 - better i2c mux support
2362
2363 ** Please consider updating your I2C driver now. **
wdenkc6097192002-11-03 00:24:07 +00002364
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002365 These enable legacy I2C serial bus commands. Defining
2366 CONFIG_HARD_I2C will include the appropriate I2C driver
2367 for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00002368
wdenk21136db2003-07-16 21:53:01 +00002369 This will allow you to use i2c commands at the u-boot
Jon Loeligerc1da5c92007-06-11 19:03:39 -05002370 command line (as long as you set CONFIG_CMD_I2C in
wdenkb9bbd242003-06-30 16:24:52 +00002371 CONFIG_COMMANDS) and communicate with i2c based realtime
2372 clock chips. See common/cmd_i2c.c for a description of the
wdenk4a5c8a72003-03-06 00:02:04 +00002373 command line interface.
wdenkc6097192002-11-03 00:24:07 +00002374
Ben Warren45657152006-09-07 16:50:54 -04002375 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkb9bbd242003-06-30 16:24:52 +00002376
wdenk21136db2003-07-16 21:53:01 +00002377 There are several other quantities that must also be
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002378 defined when you define CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002379
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002380 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk21136db2003-07-16 21:53:01 +00002381 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002382 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002383 the CPU's i2c node address).
wdenk21136db2003-07-16 21:53:01 +00002384
Peter Tysere4d1abc2010-04-12 22:28:21 -05002385 Now, the u-boot i2c code for the mpc8xx
Stefan Roese88fbf932010-04-15 16:07:28 +02002386 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tysere4d1abc2010-04-12 22:28:21 -05002387 and so its address should therefore be cleared to 0 (See,
2388 eg, MPC823e User's Manual p.16-473). So, set
2389 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00002390
Eric Millbrandt12990a42009-09-03 08:09:44 -05002391 CONFIG_SYS_I2C_INIT_MPC5XXX
2392
2393 When a board is reset during an i2c bus transfer
2394 chips might think that the current transfer is still
2395 in progress. Reset the slave devices by sending start
2396 commands until the slave device responds.
2397
wdenk21136db2003-07-16 21:53:01 +00002398 That's all that's required for CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002399
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002400 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb9bbd242003-06-30 16:24:52 +00002401 then the following macros need to be defined (examples are
2402 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002403
2404 I2C_INIT
2405
wdenkb9bbd242003-06-30 16:24:52 +00002406 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00002407 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002408
wdenk544e9732004-02-06 23:19:44 +00002409 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00002410
wdenkc6097192002-11-03 00:24:07 +00002411 I2C_PORT
2412
wdenk4a5c8a72003-03-06 00:02:04 +00002413 (Only for MPC8260 CPU). The I/O port to use (the code
2414 assumes both bits are on the same port). Valid values
2415 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00002416
2417 I2C_ACTIVE
2418
2419 The code necessary to make the I2C data line active
2420 (driven). If the data line is open collector, this
2421 define can be null.
2422
wdenkb9bbd242003-06-30 16:24:52 +00002423 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2424
wdenkc6097192002-11-03 00:24:07 +00002425 I2C_TRISTATE
2426
2427 The code necessary to make the I2C data line tri-stated
2428 (inactive). If the data line is open collector, this
2429 define can be null.
2430
wdenkb9bbd242003-06-30 16:24:52 +00002431 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2432
wdenkc6097192002-11-03 00:24:07 +00002433 I2C_READ
2434
York Sun4a598092013-04-01 11:29:11 -07002435 Code that returns true if the I2C data line is high,
2436 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002437
wdenkb9bbd242003-06-30 16:24:52 +00002438 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2439
wdenkc6097192002-11-03 00:24:07 +00002440 I2C_SDA(bit)
2441
York Sun4a598092013-04-01 11:29:11 -07002442 If <bit> is true, sets the I2C data line high. If it
2443 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002444
wdenkb9bbd242003-06-30 16:24:52 +00002445 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002446 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00002447 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00002448
wdenkc6097192002-11-03 00:24:07 +00002449 I2C_SCL(bit)
2450
York Sun4a598092013-04-01 11:29:11 -07002451 If <bit> is true, sets the I2C clock line high. If it
2452 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002453
wdenkb9bbd242003-06-30 16:24:52 +00002454 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002455 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00002456 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00002457
wdenkc6097192002-11-03 00:24:07 +00002458 I2C_DELAY
2459
2460 This delay is invoked four times per clock cycle so this
2461 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00002462 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00002463 like:
2464
wdenkb9bbd242003-06-30 16:24:52 +00002465 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002466
Mike Frysingeree12d542010-07-21 13:38:02 -04002467 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2468
2469 If your arch supports the generic GPIO framework (asm/gpio.h),
2470 then you may alternatively define the two GPIOs that are to be
2471 used as SCL / SDA. Any of the previous I2C_xxx macros will
2472 have GPIO-based defaults assigned to them as appropriate.
2473
2474 You should define these to the GPIO value as given directly to
2475 the generic GPIO functions.
2476
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002477 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00002478
wdenk57b2d802003-06-27 21:31:46 +00002479 When a board is reset during an i2c bus transfer
2480 chips might think that the current transfer is still
2481 in progress. On some boards it is possible to access
2482 the i2c SCLK line directly, either by using the
2483 processor pin as a GPIO or by having a second pin
2484 connected to the bus. If this option is defined a
2485 custom i2c_init_board() routine in boards/xxx/board.c
2486 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00002487
Richard Retanubundf0149c2010-04-12 15:08:17 -04002488 CONFIG_SYS_I2C_BOARD_LATE_INIT
2489
2490 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2491 defined a custom i2c_board_late_init() routine in
2492 boards/xxx/board.c is run AFTER the operations in i2c_init()
2493 is completed. This callpoint can be used to unreset i2c bus
2494 using CPU i2c controller register accesses for CPUs whose i2c
2495 controller provide such a method. It is called at the end of
2496 i2c_init() to allow i2c_init operations to setup the i2c bus
2497 controller on the CPU (e.g. setting bus speed & slave address).
2498
wdenk0e2bd9c2004-06-06 21:51:03 +00002499 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2500
2501 This option enables configuration of bi_iic_fast[] flags
2502 in u-boot bd_info structure based on u-boot environment
2503 variable "i2cfast". (see also i2cfast)
2504
Ben Warren45657152006-09-07 16:50:54 -04002505 CONFIG_I2C_MULTI_BUS
2506
2507 This option allows the use of multiple I2C buses, each of which
Wolfgang Denk092ae952011-10-26 10:21:21 +00002508 must have a controller. At any point in time, only one bus is
2509 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warren45657152006-09-07 16:50:54 -04002510 Note that bus numbering is zero-based.
2511
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002512 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04002513
2514 This option specifies a list of I2C devices that will be skipped
Wolfgang Denk092ae952011-10-26 10:21:21 +00002515 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser469cde42009-04-18 22:34:03 -05002516 is set, specify a list of bus-device pairs. Otherwise, specify
2517 a 1D array of device addresses
Ben Warren45657152006-09-07 16:50:54 -04002518
2519 e.g.
2520 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denk092ae952011-10-26 10:21:21 +00002521 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04002522
2523 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2524
Wolfgang Denk092ae952011-10-26 10:21:21 +00002525 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002526 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-09-07 16:50:54 -04002527
2528 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2529
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002530 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-11-03 19:15:00 -06002531
2532 If defined, then this indicates the I2C bus number for DDR SPD.
2533 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2534
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002535 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002536
2537 If defined, then this indicates the I2C bus number for the RTC.
2538 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2539
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002540 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002541
2542 If defined, then this indicates the I2C bus number for the DTT.
2543 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2544
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002545 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo31856dd2008-09-09 15:13:29 -07002546
2547 If defined, specifies the I2C address of the DTT device.
2548 If not defined, then U-Boot uses predefined value for
2549 specified DTT device.
2550
Andrew Dyer58c41f92008-12-29 17:36:01 -06002551 CONFIG_SOFT_I2C_READ_REPEATED_START
2552
2553 defining this will force the i2c_read() function in
2554 the soft_i2c driver to perform an I2C repeated start
2555 between writing the address pointer and reading the
2556 data. If this define is omitted the default behaviour
2557 of doing a stop-start sequence will be used. Most I2C
2558 devices can use either method, but some require one or
2559 the other.
Timur Tabiab347542006-11-03 19:15:00 -06002560
wdenkc6097192002-11-03 00:24:07 +00002561- SPI Support: CONFIG_SPI
2562
2563 Enables SPI driver (so far only tested with
2564 SPI EEPROM, also an instance works with Crystal A/D and
2565 D/As on the SACSng board)
2566
Yoshihiro Shimoda65bd9b42011-01-31 16:50:43 +09002567 CONFIG_SH_SPI
2568
2569 Enables the driver for SPI controller on SuperH. Currently
2570 only SH7757 is supported.
2571
wdenkc6097192002-11-03 00:24:07 +00002572 CONFIG_SPI_X
2573
2574 Enables extended (16-bit) SPI EEPROM addressing.
2575 (symmetrical to CONFIG_I2C_X)
2576
2577 CONFIG_SOFT_SPI
2578
wdenk4a5c8a72003-03-06 00:02:04 +00002579 Enables a software (bit-bang) SPI driver rather than
2580 using hardware support. This is a general purpose
2581 driver that only requires three general I/O port pins
2582 (two outputs, one input) to function. If this is
2583 defined, the board configuration must define several
2584 SPI configuration items (port pins to use, etc). For
2585 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002586
Ben Warren7efe9272008-01-16 22:37:35 -05002587 CONFIG_HARD_SPI
2588
2589 Enables a hardware SPI driver for general-purpose reads
2590 and writes. As with CONFIG_SOFT_SPI, the board configuration
2591 must define a list of chip-select function pointers.
Wolfgang Denk092ae952011-10-26 10:21:21 +00002592 Currently supported on some MPC8xxx processors. For an
Ben Warren7efe9272008-01-16 22:37:35 -05002593 example, see include/configs/mpc8349emds.h.
2594
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002595 CONFIG_MXC_SPI
2596
2597 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevamdcd342c2011-10-28 08:57:46 +00002598 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002599
Matthias Fuchsa4400872007-12-27 17:12:34 +01002600- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00002601
Matthias Fuchsa4400872007-12-27 17:12:34 +01002602 Enables FPGA subsystem.
2603
2604 CONFIG_FPGA_<vendor>
2605
2606 Enables support for specific chip vendors.
2607 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00002608
Matthias Fuchsa4400872007-12-27 17:12:34 +01002609 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00002610
Matthias Fuchsa4400872007-12-27 17:12:34 +01002611 Enables support for FPGA family.
2612 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2613
2614 CONFIG_FPGA_COUNT
2615
2616 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002617
Siva Durga Prasad Paladuguadc11de2014-03-14 16:35:38 +05302618 CONFIG_CMD_FPGA_LOADMK
2619
2620 Enable support for fpga loadmk command
2621
Michal Simek64c70982014-05-02 13:43:39 +02002622 CONFIG_CMD_FPGA_LOADP
2623
2624 Enable support for fpga loadp command - load partial bitstream
2625
2626 CONFIG_CMD_FPGA_LOADBP
2627
2628 Enable support for fpga loadbp command - load partial bitstream
2629 (Xilinx only)
2630
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002631 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002632
wdenk57b2d802003-06-27 21:31:46 +00002633 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002634
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002635 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002636
wdenk4a5c8a72003-03-06 00:02:04 +00002637 Enable checks on FPGA configuration interface busy
2638 status by the configuration function. This option
2639 will require a board or device specific function to
2640 be written.
wdenkc6097192002-11-03 00:24:07 +00002641
2642 CONFIG_FPGA_DELAY
2643
2644 If defined, a function that provides delays in the FPGA
2645 configuration driver.
2646
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002647 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002648 Allow Control-C to interrupt FPGA configuration
2649
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002650 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002651
wdenk4a5c8a72003-03-06 00:02:04 +00002652 Check for configuration errors during FPGA bitfile
2653 loading. For example, abort during Virtex II
2654 configuration if the INIT_B line goes low (which
2655 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002656
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002657 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002658
wdenk4a5c8a72003-03-06 00:02:04 +00002659 Maximum time to wait for the INIT_B line to deassert
2660 after PROB_B has been deasserted during a Virtex II
2661 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002662 ms.
wdenkc6097192002-11-03 00:24:07 +00002663
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002664 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002665
wdenk4a5c8a72003-03-06 00:02:04 +00002666 Maximum time to wait for BUSY to deassert during
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002667 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002668
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002669 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002670
wdenk4a5c8a72003-03-06 00:02:04 +00002671 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002672 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002673
2674- Configuration Management:
2675 CONFIG_IDENT_STRING
2676
wdenk4a5c8a72003-03-06 00:02:04 +00002677 If defined, this string will be added to the U-Boot
2678 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002679
2680- Vendor Parameter Protection:
2681
wdenk4a5c8a72003-03-06 00:02:04 +00002682 U-Boot considers the values of the environment
2683 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00002684 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00002685 are set once by the board vendor / manufacturer, and
2686 protects these variables from casual modification by
2687 the user. Once set, these variables are read-only,
2688 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002689 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002690
2691 If CONFIG_ENV_OVERWRITE is #defined in your config
2692 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00002693 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002694 these parameters.
2695
2696 Alternatively, if you #define _both_ CONFIG_ETHADDR
2697 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002698 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002699 which can be changed exactly ONCE by the user. [The
2700 serial# is unaffected by this, i. e. it remains
2701 read-only.]
2702
Joe Hershberger71497d02012-12-11 22:16:31 -06002703 The same can be accomplished in a more flexible way
2704 for any variable by configuring the type of access
2705 to allow for those variables in the ".flags" variable
2706 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2707
wdenkc6097192002-11-03 00:24:07 +00002708- Protected RAM:
2709 CONFIG_PRAM
2710
2711 Define this variable to enable the reservation of
2712 "protected RAM", i. e. RAM which is not overwritten
2713 by U-Boot. Define CONFIG_PRAM to hold the number of
2714 kB you want to reserve for pRAM. You can overwrite
2715 this default value by defining an environment
2716 variable "pram" to the number of kB you want to
2717 reserve. Note that the board info structure will
2718 still show the full amount of RAM. If pRAM is
2719 reserved, a new environment variable "mem" will
2720 automatically be defined to hold the amount of
2721 remaining RAM in a form that can be passed as boot
2722 argument to Linux, for instance like that:
2723
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01002724 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002725 saveenv
2726
2727 This way you can tell Linux not to use this memory,
2728 either, which results in a memory region that will
2729 not be affected by reboots.
2730
2731 *WARNING* If your board configuration uses automatic
2732 detection of the RAM size, you must make sure that
2733 this memory test is non-destructive. So far, the
2734 following board configurations are known to be
2735 "pRAM-clean":
2736
Wolfgang Denk90326762012-10-24 02:36:15 +00002737 IVMS8, IVML24, SPD8xx, TQM8xxL,
2738 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denkcd4e42e2010-10-05 22:54:53 +02002739 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002740
Gabe Blacka2f3a932012-12-02 04:55:18 +00002741- Access to physical memory region (> 4GB)
2742 Some basic support is provided for operations on memory not
2743 normally accessible to U-Boot - e.g. some architectures
2744 support access to more than 4GB of memory on 32-bit
2745 machines using physical address extension or similar.
2746 Define CONFIG_PHYSMEM to access this basic support, which
2747 currently only supports clearing the memory.
2748
wdenkc6097192002-11-03 00:24:07 +00002749- Error Recovery:
2750 CONFIG_PANIC_HANG
2751
2752 Define this variable to stop the system in case of a
2753 fatal error, so that you have to reset it manually.
2754 This is probably NOT a good idea for an embedded
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002755 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002756 automatically as fast as possible, but it may be
2757 useful during development since you can try to debug
2758 the conditions that lead to the situation.
2759
2760 CONFIG_NET_RETRY_COUNT
2761
wdenk4a5c8a72003-03-06 00:02:04 +00002762 This variable defines the number of retries for
2763 network operations like ARP, RARP, TFTP, or BOOTP
2764 before giving up the operation. If not defined, a
2765 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002766
Guennadi Liakhovetskib38c2b32008-04-03 17:04:19 +02002767 CONFIG_ARP_TIMEOUT
2768
2769 Timeout waiting for an ARP reply in milliseconds.
2770
Tetsuyuki Kobayashi147e3902012-07-03 22:25:21 +00002771 CONFIG_NFS_TIMEOUT
2772
2773 Timeout in milliseconds used in NFS protocol.
2774 If you encounter "ERROR: Cannot umount" in nfs command,
2775 try longer timeout such as
2776 #define CONFIG_NFS_TIMEOUT 10000UL
2777
wdenkc6097192002-11-03 00:24:07 +00002778- Command Interpreter:
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002779 CONFIG_AUTO_COMPLETE
wdenk3902d702004-04-15 18:22:41 +00002780
2781 Enable auto completion of commands using TAB.
2782
Wolfgang Denk018147d2006-11-27 15:32:42 +01002783 Note that this feature has NOT been implemented yet
2784 for the "hush" shell.
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002785
2786
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002787 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00002788
2789 Define this variable to enable the "hush" shell (from
2790 Busybox) as command line interpreter, thus enabling
2791 powerful command line syntax like
2792 if...then...else...fi conditionals or `&&' and '||'
2793 constructs ("shell scripts").
2794
2795 If undefined, you get the old, much simpler behaviour
2796 with a somewhat smaller memory footprint.
2797
2798
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002799 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002800
2801 This defines the secondary prompt string, which is
2802 printed when the command interpreter needs more input
2803 to complete a command. Usually "> ".
2804
2805 Note:
2806
wdenk57b2d802003-06-27 21:31:46 +00002807 In the current implementation, the local variables
2808 space and global environment variables space are
2809 separated. Local variables are those you define by
2810 simply typing `name=value'. To access a local
2811 variable later on, you have write `$name' or
2812 `${name}'; to execute the contents of a variable
2813 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002814
wdenk4a5c8a72003-03-06 00:02:04 +00002815 Global environment variables are those you use
2816 setenv/printenv to work with. To run a command stored
2817 in such a variable, you need to use the run command,
2818 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002819
2820 To store commands and special characters in a
2821 variable, please use double quotation marks
2822 surrounding the whole text of the variable, instead
2823 of the backslashes before semicolons and special
2824 symbols.
2825
Wolfgang Denk2039a072006-07-21 11:35:21 +02002826- Commandline Editing and History:
2827 CONFIG_CMDLINE_EDITING
2828
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002829 Enable editing and History functions for interactive
Wolfgang Denkc80857e2006-07-21 11:56:05 +02002830 commandline input operations
Wolfgang Denk2039a072006-07-21 11:35:21 +02002831
wdenkc0aa5c52003-12-06 19:49:23 +00002832- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002833 CONFIG_EXTRA_ENV_SETTINGS
2834
wdenk4a5c8a72003-03-06 00:02:04 +00002835 Define this to contain any number of null terminated
2836 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00002837 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00002838
wdenk4a5c8a72003-03-06 00:02:04 +00002839 For example, place something like this in your
2840 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002841
2842 #define CONFIG_EXTRA_ENV_SETTINGS \
2843 "myvar1=value1\0" \
2844 "myvar2=value2\0"
2845
wdenk4a5c8a72003-03-06 00:02:04 +00002846 Warning: This method is based on knowledge about the
2847 internal format how the environment is stored by the
2848 U-Boot code. This is NOT an official, exported
2849 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00002850 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002851 You better know what you are doing here.
2852
wdenk4a5c8a72003-03-06 00:02:04 +00002853 Note: overly (ab)use of the default environment is
2854 discouraged. Make sure to check other ways to preset
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002855 the environment like the "source" command or the
wdenk4a5c8a72003-03-06 00:02:04 +00002856 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002857
Stephen Warren1465d5f2012-05-22 09:21:54 +00002858 CONFIG_ENV_VARS_UBOOT_CONFIG
2859
2860 Define this in order to add variables describing the
2861 U-Boot build configuration to the default environment.
2862 These will be named arch, cpu, board, vendor, and soc.
2863
2864 Enabling this option will cause the following to be defined:
2865
2866 - CONFIG_SYS_ARCH
2867 - CONFIG_SYS_CPU
2868 - CONFIG_SYS_BOARD
2869 - CONFIG_SYS_VENDOR
2870 - CONFIG_SYS_SOC
2871
Tom Rini4c8cc9b2012-10-24 07:28:16 +00002872 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2873
2874 Define this in order to add variables describing certain
2875 run-time determined information about the hardware to the
2876 environment. These will be named board_name, board_rev.
2877
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002878 CONFIG_DELAY_ENVIRONMENT
2879
2880 Normally the environment is loaded when the board is
2881 intialised so that it is available to U-Boot. This inhibits
2882 that so that the environment is not available until
2883 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2884 this is instead controlled by the value of
2885 /config/load-environment.
2886
wdenkc0aa5c52003-12-06 19:49:23 +00002887- DataFlash Support:
wdenk381669a2003-06-16 23:50:08 +00002888 CONFIG_HAS_DATAFLASH
2889
wdenk57b2d802003-06-27 21:31:46 +00002890 Defining this option enables DataFlash features and
2891 allows to read/write in Dataflash via the standard
2892 commands cp, md...
wdenk381669a2003-06-16 23:50:08 +00002893
Eric Nelson97f5f8f2012-01-31 10:52:08 -07002894- Serial Flash support
2895 CONFIG_CMD_SF
2896
2897 Defining this option enables SPI flash commands
2898 'sf probe/read/write/erase/update'.
2899
2900 Usage requires an initial 'probe' to define the serial
2901 flash parameters, followed by read/write/erase/update
2902 commands.
2903
2904 The following defaults may be provided by the platform
2905 to handle the common case when only a single serial
2906 flash is present on the system.
2907
2908 CONFIG_SF_DEFAULT_BUS Bus identifier
2909 CONFIG_SF_DEFAULT_CS Chip-select
2910 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2911 CONFIG_SF_DEFAULT_SPEED in Hz
2912
Simon Glass4b5545e2012-10-08 13:16:02 +00002913 CONFIG_CMD_SF_TEST
2914
2915 Define this option to include a destructive SPI flash
2916 test ('sf test').
2917
Jagannadha Sutradharudu Tekic6d173d2013-06-19 15:33:58 +05302918 CONFIG_SPI_FLASH_BAR Ban/Extended Addr Reg
2919
2920 Define this option to use the Bank addr/Extended addr
2921 support on SPI flashes which has size > 16Mbytes.
2922
Jagannadha Sutradharudu Tekid7f253b2014-01-11 15:25:04 +05302923 CONFIG_SF_DUAL_FLASH Dual flash memories
2924
2925 Define this option to use dual flash support where two flash
2926 memories can be connected with a given cs line.
2927 currently Xilinx Zynq qspi support these type of connections.
2928
wdenkef893942004-02-23 16:11:30 +00002929- SystemACE Support:
2930 CONFIG_SYSTEMACE
2931
2932 Adding this option adds support for Xilinx SystemACE
2933 chips attached via some sort of local bus. The address
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002934 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002935 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenkef893942004-02-23 16:11:30 +00002936
2937 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002938 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenkef893942004-02-23 16:11:30 +00002939
2940 When SystemACE support is added, the "ace" device type
2941 becomes available to the fat commands, i.e. fatls.
2942
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002943- TFTP Fixed UDP Port:
2944 CONFIG_TFTP_PORT
2945
Wolfgang Denk227b5192005-09-24 23:25:46 +02002946 If this is defined, the environment variable tftpsrcp
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002947 is used to supply the TFTP UDP source port value.
Wolfgang Denk227b5192005-09-24 23:25:46 +02002948 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002949 number generator is used.
2950
Wolfgang Denk227b5192005-09-24 23:25:46 +02002951 Also, the environment variable tftpdstp is used to supply
2952 the TFTP UDP destination port value. If tftpdstp isn't
2953 defined, the normal port 69 is used.
2954
2955 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002956 blindly start the TFTP transfer using the pre-configured
2957 target IP address and UDP port. This has the effect of
2958 "punching through" the (Windows XP) firewall, allowing
2959 the remainder of the TFTP transfer to proceed normally.
2960 A better solution is to properly configure the firewall,
2961 but sometimes that is not allowed.
2962
Simon Glass058bb8d2012-12-05 14:46:38 +00002963- Hashing support:
2964 CONFIG_CMD_HASH
2965
2966 This enables a generic 'hash' command which can produce
2967 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
2968
2969 CONFIG_HASH_VERIFY
2970
2971 Enable the hash verify command (hash -v). This adds to code
2972 size a little.
2973
2974 CONFIG_SHA1 - support SHA1 hashing
2975 CONFIG_SHA256 - support SHA256 hashing
2976
2977 Note: There is also a sha1sum command, which should perhaps
2978 be deprecated in favour of 'hash sha1'.
2979
Robert Winkler765ccf42013-07-24 17:57:06 -07002980- Freescale i.MX specific commands:
2981 CONFIG_CMD_HDMIDETECT
2982 This enables 'hdmidet' command which returns true if an
2983 HDMI monitor is detected. This command is i.MX 6 specific.
2984
2985 CONFIG_CMD_BMODE
2986 This enables the 'bmode' (bootmode) command for forcing
2987 a boot from specific media.
2988
2989 This is useful for forcing the ROM's usb downloader to
2990 activate upon a watchdog reset which is nice when iterating
2991 on U-Boot. Using the reset button or running bmode normal
2992 will set it back to normal. This command currently
2993 supports i.MX53 and i.MX6.
2994
Simon Glass35191a32013-06-13 15:10:02 -07002995- Signing support:
2996 CONFIG_RSA
2997
2998 This enables the RSA algorithm used for FIT image verification
Detlev Zundel49dc73b2014-01-20 16:21:46 +01002999 in U-Boot. See doc/uImage.FIT/signature.txt for more information.
Simon Glass35191a32013-06-13 15:10:02 -07003000
3001 The signing part is build into mkimage regardless of this
3002 option.
3003
Heiko Schocher443ca402014-01-25 07:27:13 +01003004- bootcount support:
3005 CONFIG_BOOTCOUNT_LIMIT
3006
3007 This enables the bootcounter support, see:
3008 http://www.denx.de/wiki/DULG/UBootBootCountLimit
3009
3010 CONFIG_AT91SAM9XE
3011 enable special bootcounter support on at91sam9xe based boards.
3012 CONFIG_BLACKFIN
3013 enable special bootcounter support on blackfin based boards.
3014 CONFIG_SOC_DA8XX
3015 enable special bootcounter support on da850 based boards.
3016 CONFIG_BOOTCOUNT_RAM
3017 enable support for the bootcounter in RAM
3018 CONFIG_BOOTCOUNT_I2C
3019 enable support for the bootcounter on an i2c (like RTC) device.
3020 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
3021 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
3022 the bootcounter.
3023 CONFIG_BOOTCOUNT_ALEN = address len
Simon Glass35191a32013-06-13 15:10:02 -07003024
wdenkc0aa5c52003-12-06 19:49:23 +00003025- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00003026 CONFIG_SHOW_BOOT_PROGRESS
3027
wdenk4a5c8a72003-03-06 00:02:04 +00003028 Defining this option allows to add some board-
3029 specific code (calling a user-provided function
3030 "show_boot_progress(int)") that enables you to show
3031 the system's boot progress on some display (for
3032 example, some LED's) on your board. At the moment,
3033 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00003034
Simon Glass31a870e2012-02-13 13:51:19 +00003035- Detailed boot stage timing
3036 CONFIG_BOOTSTAGE
3037 Define this option to get detailed timing of each stage
3038 of the boot process.
3039
3040 CONFIG_BOOTSTAGE_USER_COUNT
3041 This is the number of available user bootstage records.
3042 Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
3043 a new ID will be allocated from this stash. If you exceed
3044 the limit, recording will stop.
3045
3046 CONFIG_BOOTSTAGE_REPORT
3047 Define this to print a report before boot, similar to this:
3048
3049 Timer summary in microseconds:
3050 Mark Elapsed Stage
3051 0 0 reset
3052 3,575,678 3,575,678 board_init_f start
3053 3,575,695 17 arch_cpu_init A9
3054 3,575,777 82 arch_cpu_init done
3055 3,659,598 83,821 board_init_r start
3056 3,910,375 250,777 main_loop
3057 29,916,167 26,005,792 bootm_start
3058 30,361,327 445,160 start_kernel
3059
Simon Glass4afd88e2012-09-28 08:56:39 +00003060 CONFIG_CMD_BOOTSTAGE
3061 Add a 'bootstage' command which supports printing a report
3062 and un/stashing of bootstage data.
3063
Simon Glass0fa36a42012-09-28 08:56:37 +00003064 CONFIG_BOOTSTAGE_FDT
3065 Stash the bootstage information in the FDT. A root 'bootstage'
3066 node is created with each bootstage id as a child. Each child
3067 has a 'name' property and either 'mark' containing the
3068 mark time in microsecond, or 'accum' containing the
3069 accumulated time for that bootstage id in microseconds.
3070 For example:
3071
3072 bootstage {
3073 154 {
3074 name = "board_init_f";
3075 mark = <3575678>;
3076 };
3077 170 {
3078 name = "lcd";
3079 accum = <33482>;
3080 };
3081 };
3082
3083 Code in the Linux kernel can find this in /proc/devicetree.
3084
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003085Legacy uImage format:
3086
wdenkc6097192002-11-03 00:24:07 +00003087 Arg Where When
3088 1 common/cmd_bootm.c before attempting to boot an image
wdenk544e9732004-02-06 23:19:44 +00003089 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00003090 2 common/cmd_bootm.c Image header has correct magic number
wdenk544e9732004-02-06 23:19:44 +00003091 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003092 3 common/cmd_bootm.c Image header has correct checksum
wdenk544e9732004-02-06 23:19:44 +00003093 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003094 4 common/cmd_bootm.c Image data has correct checksum
3095 -4 common/cmd_bootm.c Image is for unsupported architecture
3096 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003097 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00003098 6 common/cmd_bootm.c Image Type check OK
3099 -6 common/cmd_bootm.c gunzip uncompression error
3100 -7 common/cmd_bootm.c Unimplemented compression type
3101 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003102 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00003103 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003104
3105 9 common/image.c Start initial ramdisk verification
3106 -10 common/image.c Ramdisk header has bad magic number
3107 -11 common/image.c Ramdisk header has bad checksum
3108 10 common/image.c Ramdisk header is OK
3109 -12 common/image.c Ramdisk data has bad checksum
3110 11 common/image.c Ramdisk data has correct checksum
3111 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003112 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003113 13 common/image.c Start multifile image verification
3114 14 common/image.c No initial ramdisk, no multifile, continue.
3115
Wolfgang Denk092ae952011-10-26 10:21:21 +00003116 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00003117
Stefan Roese88fbf932010-04-15 16:07:28 +02003118 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenkd729d302004-02-27 00:07:27 +00003119 -31 post/post.c POST test failed, detected by post_output_backlog()
3120 -32 post/post.c POST test failed, detected by post_run_single()
wdenke97d3d92004-02-23 22:22:28 +00003121
Heiko Schocher633e03a2007-06-22 19:11:54 +02003122 34 common/cmd_doc.c before loading a Image from a DOC device
3123 -35 common/cmd_doc.c Bad usage of "doc" command
3124 35 common/cmd_doc.c correct usage of "doc" command
3125 -36 common/cmd_doc.c No boot device
3126 36 common/cmd_doc.c correct boot device
3127 -37 common/cmd_doc.c Unknown Chip ID on boot device
3128 37 common/cmd_doc.c correct chip ID found, device available
3129 -38 common/cmd_doc.c Read Error on boot device
3130 38 common/cmd_doc.c reading Image header from DOC device OK
3131 -39 common/cmd_doc.c Image header has bad magic number
3132 39 common/cmd_doc.c Image header has correct magic number
3133 -40 common/cmd_doc.c Error reading Image from DOC device
3134 40 common/cmd_doc.c Image header has correct magic number
3135 41 common/cmd_ide.c before loading a Image from a IDE device
3136 -42 common/cmd_ide.c Bad usage of "ide" command
3137 42 common/cmd_ide.c correct usage of "ide" command
3138 -43 common/cmd_ide.c No boot device
3139 43 common/cmd_ide.c boot device found
3140 -44 common/cmd_ide.c Device not available
3141 44 common/cmd_ide.c Device available
3142 -45 common/cmd_ide.c wrong partition selected
3143 45 common/cmd_ide.c partition selected
3144 -46 common/cmd_ide.c Unknown partition table
3145 46 common/cmd_ide.c valid partition table found
3146 -47 common/cmd_ide.c Invalid partition type
3147 47 common/cmd_ide.c correct partition type
3148 -48 common/cmd_ide.c Error reading Image Header on boot device
3149 48 common/cmd_ide.c reading Image Header from IDE device OK
3150 -49 common/cmd_ide.c Image header has bad magic number
3151 49 common/cmd_ide.c Image header has correct magic number
3152 -50 common/cmd_ide.c Image header has bad checksum
3153 50 common/cmd_ide.c Image header has correct checksum
3154 -51 common/cmd_ide.c Error reading Image from IDE device
3155 51 common/cmd_ide.c reading Image from IDE device OK
3156 52 common/cmd_nand.c before loading a Image from a NAND device
3157 -53 common/cmd_nand.c Bad usage of "nand" command
3158 53 common/cmd_nand.c correct usage of "nand" command
3159 -54 common/cmd_nand.c No boot device
3160 54 common/cmd_nand.c boot device found
3161 -55 common/cmd_nand.c Unknown Chip ID on boot device
3162 55 common/cmd_nand.c correct chip ID found, device available
3163 -56 common/cmd_nand.c Error reading Image Header on boot device
3164 56 common/cmd_nand.c reading Image Header from NAND device OK
3165 -57 common/cmd_nand.c Image header has bad magic number
3166 57 common/cmd_nand.c Image header has correct magic number
3167 -58 common/cmd_nand.c Error reading Image from NAND device
3168 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00003169
Heiko Schocher633e03a2007-06-22 19:11:54 +02003170 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00003171
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003172 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher633e03a2007-06-22 19:11:54 +02003173 -64 net/eth.c no Ethernet found.
3174 65 net/eth.c Ethernet found.
wdenkc6097192002-11-03 00:24:07 +00003175
Heiko Schocher633e03a2007-06-22 19:11:54 +02003176 -80 common/cmd_net.c usage wrong
3177 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003178 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher633e03a2007-06-22 19:11:54 +02003179 81 common/cmd_net.c NetLoop() back without error
3180 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
3181 82 common/cmd_net.c trying automatic boot
Wolfgang Denk85c25df2009-04-01 23:34:12 +02003182 83 common/cmd_net.c running "source" command
3183 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher633e03a2007-06-22 19:11:54 +02003184 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00003185
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003186FIT uImage format:
3187
3188 Arg Where When
3189 100 common/cmd_bootm.c Kernel FIT Image has correct format
3190 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
3191 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
3192 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
3193 102 common/cmd_bootm.c Kernel unit name specified
3194 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +01003195 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003196 104 common/cmd_bootm.c Got kernel subimage node offset
3197 -104 common/cmd_bootm.c Kernel subimage hash verification failed
3198 105 common/cmd_bootm.c Kernel subimage hash verification OK
3199 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
3200 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003201 -106 common/cmd_bootm.c Kernel subimage has wrong type
3202 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003203 -107 common/cmd_bootm.c Can't get kernel subimage data/size
3204 108 common/cmd_bootm.c Got kernel subimage data/size
3205 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
3206 -109 common/cmd_bootm.c Can't get kernel subimage type
3207 -110 common/cmd_bootm.c Can't get kernel subimage comp
3208 -111 common/cmd_bootm.c Can't get kernel subimage os
3209 -112 common/cmd_bootm.c Can't get kernel subimage load address
3210 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
3211
3212 120 common/image.c Start initial ramdisk verification
3213 -120 common/image.c Ramdisk FIT image has incorrect format
3214 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003215 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003216 -122 common/image.c Can't get configuration for ramdisk subimage
3217 123 common/image.c Ramdisk unit name specified
3218 -124 common/image.c Can't get ramdisk subimage node offset
3219 125 common/image.c Got ramdisk subimage node offset
3220 -125 common/image.c Ramdisk subimage hash verification failed
3221 126 common/image.c Ramdisk subimage hash verification OK
3222 -126 common/image.c Ramdisk subimage for unsupported architecture
3223 127 common/image.c Architecture check OK
3224 -127 common/image.c Can't get ramdisk subimage data/size
3225 128 common/image.c Got ramdisk subimage data/size
3226 129 common/image.c Can't get ramdisk load address
3227 -129 common/image.c Got ramdisk load address
3228
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003229 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003230 131 common/cmd_doc.c FIT image format OK
3231
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003232 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003233 141 common/cmd_ide.c FIT image format OK
3234
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003235 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003236 151 common/cmd_nand.c FIT image format OK
3237
Heiko Schocher515eb122014-05-28 11:33:33 +02003238- legacy image format:
3239 CONFIG_IMAGE_FORMAT_LEGACY
3240 enables the legacy image format support in U-Boot.
3241
3242 Default:
3243 enabled if CONFIG_FIT_SIGNATURE is not defined.
3244
3245 CONFIG_DISABLE_IMAGE_LEGACY
3246 disable the legacy image format
3247
3248 This define is introduced, as the legacy image format is
3249 enabled per default for backward compatibility.
3250
Gabe Blackd572e162012-10-25 16:31:10 +00003251- FIT image support:
3252 CONFIG_FIT
3253 Enable support for the FIT uImage format.
3254
3255 CONFIG_FIT_BEST_MATCH
3256 When no configuration is explicitly selected, default to the
3257 one whose fdt's compatibility field best matches that of
3258 U-Boot itself. A match is considered "best" if it matches the
3259 most specific compatibility entry of U-Boot's fdt's root node.
3260 The order of entries in the configuration's fdt is ignored.
3261
Simon Glass58fe7e52013-06-13 15:10:00 -07003262 CONFIG_FIT_SIGNATURE
3263 This option enables signature verification of FIT uImages,
3264 using a hash signed and verified using RSA. See
3265 doc/uImage.FIT/signature.txt for more details.
3266
Heiko Schocher515eb122014-05-28 11:33:33 +02003267 WARNING: When relying on signed FIT images with required
3268 signature check the legacy image format is default
3269 disabled. If a board need legacy image format support
3270 enable this through CONFIG_IMAGE_FORMAT_LEGACY
3271
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003272- Standalone program support:
3273 CONFIG_STANDALONE_LOAD_ADDR
3274
Wolfgang Denk23f78482011-10-09 21:06:34 +02003275 This option defines a board specific value for the
3276 address where standalone program gets loaded, thus
3277 overwriting the architecture dependent default
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003278 settings.
3279
3280- Frame Buffer Address:
3281 CONFIG_FB_ADDR
3282
3283 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denka71eb8e2013-01-03 00:43:59 +00003284 address for frame buffer. This is typically the case
3285 when using a graphics controller has separate video
3286 memory. U-Boot will then place the frame buffer at
3287 the given address instead of dynamically reserving it
3288 in system RAM by calling lcd_setmem(), which grabs
3289 the memory for the frame buffer depending on the
3290 configured panel size.
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003291
3292 Please see board_init_f function.
3293
Detlev Zundel0ecb6112009-12-01 17:16:19 +01003294- Automatic software updates via TFTP server
3295 CONFIG_UPDATE_TFTP
3296 CONFIG_UPDATE_TFTP_CNT_MAX
3297 CONFIG_UPDATE_TFTP_MSEC_MAX
3298
3299 These options enable and control the auto-update feature;
3300 for a more detailed description refer to doc/README.update.
3301
3302- MTD Support (mtdparts command, UBI support)
3303 CONFIG_MTD_DEVICE
3304
3305 Adds the MTD device infrastructure from the Linux kernel.
3306 Needed for mtdparts command support.
3307
3308 CONFIG_MTD_PARTITIONS
3309
3310 Adds the MTD partitioning infrastructure from the Linux
3311 kernel. Needed for UBI support.
3312
Joe Hershberger7d80fc12013-04-08 10:32:48 +00003313- UBI support
3314 CONFIG_CMD_UBI
3315
3316 Adds commands for interacting with MTD partitions formatted
3317 with the UBI flash translation layer
3318
3319 Requires also defining CONFIG_RBTREE
3320
Joe Hershberger47550fc2013-04-08 10:32:49 +00003321 CONFIG_UBI_SILENCE_MSG
3322
3323 Make the verbose messages from UBI stop printing. This leaves
3324 warnings and errors enabled.
3325
Joe Hershberger7d80fc12013-04-08 10:32:48 +00003326- UBIFS support
3327 CONFIG_CMD_UBIFS
3328
3329 Adds commands for interacting with UBI volumes formatted as
3330 UBIFS. UBIFS is read-only in u-boot.
3331
3332 Requires UBI support as well as CONFIG_LZO
3333
Joe Hershberger47550fc2013-04-08 10:32:49 +00003334 CONFIG_UBIFS_SILENCE_MSG
3335
3336 Make the verbose messages from UBIFS stop printing. This leaves
3337 warnings and errors enabled.
3338
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003339- SPL framework
Wolfgang Denk825223d2011-09-11 21:24:09 +02003340 CONFIG_SPL
3341 Enable building of SPL globally.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003342
Tom Rini36853852012-02-14 07:29:40 +00003343 CONFIG_SPL_LDSCRIPT
3344 LDSCRIPT for linking the SPL binary.
3345
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003346 CONFIG_SPL_MAX_FOOTPRINT
3347 Maximum size in memory allocated to the SPL, BSS included.
3348 When defined, the linker checks that the actual memory
3349 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00003350 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003351 must not be both defined at the same time.
3352
Tom Rini36853852012-02-14 07:29:40 +00003353 CONFIG_SPL_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003354 Maximum size of the SPL image (text, data, rodata, and
3355 linker lists sections), BSS excluded.
3356 When defined, the linker checks that the actual size does
3357 not exceed it.
Tom Rini36853852012-02-14 07:29:40 +00003358
Wolfgang Denk825223d2011-09-11 21:24:09 +02003359 CONFIG_SPL_TEXT_BASE
3360 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003361
Scott Woodc4f0d002012-09-20 19:05:12 -05003362 CONFIG_SPL_RELOC_TEXT_BASE
3363 Address to relocate to. If unspecified, this is equal to
3364 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
3365
Tom Rini36853852012-02-14 07:29:40 +00003366 CONFIG_SPL_BSS_START_ADDR
3367 Link address for the BSS within the SPL binary.
3368
3369 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003370 Maximum size in memory allocated to the SPL BSS.
3371 When defined, the linker checks that the actual memory used
3372 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00003373 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003374 must not be both defined at the same time.
Tom Rini36853852012-02-14 07:29:40 +00003375
3376 CONFIG_SPL_STACK
3377 Adress of the start of the stack SPL will use
3378
Scott Woodc4f0d002012-09-20 19:05:12 -05003379 CONFIG_SPL_RELOC_STACK
3380 Adress of the start of the stack SPL will use after
3381 relocation. If unspecified, this is equal to
3382 CONFIG_SPL_STACK.
3383
Tom Rini36853852012-02-14 07:29:40 +00003384 CONFIG_SYS_SPL_MALLOC_START
3385 Starting address of the malloc pool used in SPL.
3386
3387 CONFIG_SYS_SPL_MALLOC_SIZE
3388 The size of the malloc pool used in SPL.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003389
Tom Rini28591df2012-08-13 12:03:19 -07003390 CONFIG_SPL_FRAMEWORK
3391 Enable the SPL framework under common/. This framework
3392 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3393 NAND loading of the Linux Kernel.
3394
Tom Rinic2b76002014-03-28 12:03:39 -04003395 CONFIG_SPL_OS_BOOT
3396 Enable booting directly to an OS from SPL.
3397 See also: doc/README.falcon
3398
Tom Rinife3b0c72012-08-13 11:37:56 -07003399 CONFIG_SPL_DISPLAY_PRINT
3400 For ARM, enable an optional function to print more information
3401 about the running system.
3402
Scott Wood7c810902012-09-20 16:35:21 -05003403 CONFIG_SPL_INIT_MINIMAL
3404 Arch init code should be built for a very small image
3405
Wolfgang Denk825223d2011-09-11 21:24:09 +02003406 CONFIG_SPL_LIBCOMMON_SUPPORT
3407 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003408
Wolfgang Denk825223d2011-09-11 21:24:09 +02003409 CONFIG_SPL_LIBDISK_SUPPORT
3410 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003411
Wolfgang Denk825223d2011-09-11 21:24:09 +02003412 CONFIG_SPL_I2C_SUPPORT
3413 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003414
Wolfgang Denk825223d2011-09-11 21:24:09 +02003415 CONFIG_SPL_GPIO_SUPPORT
3416 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003417
Wolfgang Denk825223d2011-09-11 21:24:09 +02003418 CONFIG_SPL_MMC_SUPPORT
3419 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003420
Tom Rini36853852012-02-14 07:29:40 +00003421 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
3422 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
3423 CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
3424 Address, size and partition on the MMC to load U-Boot from
3425 when the MMC is being used in raw mode.
3426
Peter Korsgaard01b542f2013-05-13 08:36:29 +00003427 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3428 Sector to load kernel uImage from when MMC is being
3429 used in raw mode (for Falcon mode)
3430
3431 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3432 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3433 Sector and number of sectors to load kernel argument
3434 parameters from when MMC is being used in raw mode
3435 (for falcon mode)
3436
Tom Rini36853852012-02-14 07:29:40 +00003437 CONFIG_SPL_FAT_SUPPORT
3438 Support for fs/fat/libfat.o in SPL binary
3439
3440 CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
3441 Filename to read to load U-Boot when reading from FAT
3442
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003443 CONFIG_SPL_FAT_LOAD_KERNEL_NAME
3444 Filename to read to load kernel uImage when reading
3445 from FAT (for Falcon mode)
3446
3447 CONFIG_SPL_FAT_LOAD_ARGS_NAME
3448 Filename to read to load kernel argument parameters
3449 when reading from FAT (for Falcon mode)
3450
Scott Wood2b36fbb2012-12-06 13:33:17 +00003451 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3452 Set this for NAND SPL on PPC mpc83xx targets, so that
3453 start.S waits for the rest of the SPL to load before
3454 continuing (the hardware starts execution after just
3455 loading the first page rather than the full 4K).
3456
Prabhakar Kushwaha6e2b9a32014-04-08 19:12:31 +05303457 CONFIG_SPL_SKIP_RELOCATE
3458 Avoid SPL relocation
3459
Scott Woodc352a0c2012-09-20 19:09:07 -05003460 CONFIG_SPL_NAND_BASE
3461 Include nand_base.c in the SPL. Requires
3462 CONFIG_SPL_NAND_DRIVERS.
3463
3464 CONFIG_SPL_NAND_DRIVERS
3465 SPL uses normal NAND drivers, not minimal drivers.
3466
3467 CONFIG_SPL_NAND_ECC
3468 Include standard software ECC in the SPL
3469
Tom Rini36853852012-02-14 07:29:40 +00003470 CONFIG_SPL_NAND_SIMPLE
Scott Wood36c440e2012-09-21 18:35:27 -05003471 Support for NAND boot using simple NAND drivers that
3472 expose the cmd_ctrl() interface.
Tom Rini36853852012-02-14 07:29:40 +00003473
Tom Rini543c9f12014-03-28 12:03:36 -04003474 CONFIG_SPL_MTD_SUPPORT
3475 Support for the MTD subsystem within SPL. Useful for
3476 environment on NAND support within SPL.
3477
Ying Zhang9ff70262013-08-16 15:16:11 +08003478 CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3479 Set for the SPL on PPC mpc8xxx targets, support for
York Sunf0626592013-09-30 09:22:09 -07003480 drivers/ddr/fsl/libddr.o in SPL binary.
Ying Zhang9ff70262013-08-16 15:16:11 +08003481
Ying Zhangdfb2b152013-08-16 15:16:12 +08003482 CONFIG_SPL_COMMON_INIT_DDR
3483 Set for common ddr init with serial presence detect in
3484 SPL binary.
3485
Tom Rini36853852012-02-14 07:29:40 +00003486 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3487 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3488 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3489 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3490 CONFIG_SYS_NAND_ECCBYTES
3491 Defines the size and behavior of the NAND that SPL uses
Scott Wood36c440e2012-09-21 18:35:27 -05003492 to read U-Boot
Tom Rini36853852012-02-14 07:29:40 +00003493
Prabhakar Kushwahaafffcb02013-12-11 12:42:11 +05303494 CONFIG_SPL_NAND_BOOT
3495 Add support NAND boot
3496
Tom Rini36853852012-02-14 07:29:40 +00003497 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood36c440e2012-09-21 18:35:27 -05003498 Location in NAND to read U-Boot from
3499
3500 CONFIG_SYS_NAND_U_BOOT_DST
3501 Location in memory to load U-Boot to
3502
3503 CONFIG_SYS_NAND_U_BOOT_SIZE
3504 Size of image to load
Tom Rini36853852012-02-14 07:29:40 +00003505
3506 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood36c440e2012-09-21 18:35:27 -05003507 Entry point in loaded image to jump to
Tom Rini36853852012-02-14 07:29:40 +00003508
3509 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3510 Define this if you need to first read the OOB and then the
3511 data. This is used for example on davinci plattforms.
3512
3513 CONFIG_SPL_OMAP3_ID_NAND
3514 Support for an OMAP3-specific set of functions to return the
3515 ID and MFR of the first attached NAND chip, if present.
3516
Wolfgang Denk825223d2011-09-11 21:24:09 +02003517 CONFIG_SPL_SERIAL_SUPPORT
3518 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003519
Wolfgang Denk825223d2011-09-11 21:24:09 +02003520 CONFIG_SPL_SPI_FLASH_SUPPORT
3521 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003522
Wolfgang Denk825223d2011-09-11 21:24:09 +02003523 CONFIG_SPL_SPI_SUPPORT
3524 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003525
Pavel Machekde997252012-08-30 22:42:11 +02003526 CONFIG_SPL_RAM_DEVICE
3527 Support for running image already present in ram, in SPL binary
3528
Wolfgang Denk825223d2011-09-11 21:24:09 +02003529 CONFIG_SPL_LIBGENERIC_SUPPORT
3530 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003531
Ying Zhang602f7d32013-05-20 14:07:25 +08003532 CONFIG_SPL_ENV_SUPPORT
3533 Support for the environment operating in SPL binary
3534
3535 CONFIG_SPL_NET_SUPPORT
3536 Support for the net/libnet.o in SPL binary.
3537 It conflicts with SPL env from storage medium specified by
3538 CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3539
Scott Woodeb7bd972012-12-06 13:33:16 +00003540 CONFIG_SPL_PAD_TO
Benoît Thébaudeauf0180722013-04-11 09:35:49 +00003541 Image offset to which the SPL should be padded before appending
3542 the SPL payload. By default, this is defined as
3543 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3544 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3545 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Woodeb7bd972012-12-06 13:33:16 +00003546
Scott Woodf147eb72012-09-21 16:27:32 -05003547 CONFIG_SPL_TARGET
3548 Final target image containing SPL and payload. Some SPLs
3549 use an arch-specific makefile fragment instead, for
3550 example if more than one image needs to be produced.
3551
Simon Glass82d94532013-05-08 08:05:59 +00003552 CONFIG_FIT_SPL_PRINT
3553 Printing information about a FIT image adds quite a bit of
3554 code to SPL. So this is normally disabled in SPL. Use this
3555 option to re-enable it. This will affect the output of the
3556 bootm command when booting a FIT image.
3557
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003558- TPL framework
3559 CONFIG_TPL
3560 Enable building of TPL globally.
3561
3562 CONFIG_TPL_PAD_TO
3563 Image offset to which the TPL should be padded before appending
3564 the TPL payload. By default, this is defined as
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02003565 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3566 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3567 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003568
wdenkc6097192002-11-03 00:24:07 +00003569Modem Support:
3570--------------
3571
Wolfgang Denk8f399b32011-05-01 20:44:23 +02003572[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00003573
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003574- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00003575 CONFIG_MODEM_SUPPORT
3576
3577- RTS/CTS Flow control enable:
3578 CONFIG_HWFLOW
3579
3580- Modem debug support:
3581 CONFIG_MODEM_SUPPORT_DEBUG
3582
wdenk4a5c8a72003-03-06 00:02:04 +00003583 Enables debugging stuff (char screen[1024], dbg())
3584 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00003585
wdenkc0aa5c52003-12-06 19:49:23 +00003586- Interrupt support (PPC):
3587
wdenk1ebf41e2004-01-02 14:00:00 +00003588 There are common interrupt_init() and timer_interrupt()
3589 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003590 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00003591 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003592 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00003593 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003594 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00003595 specific handling. If board has watchdog / status_led
3596 / other_activity_monitor it works automatically from
3597 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00003598
wdenkc6097192002-11-03 00:24:07 +00003599- General:
3600
wdenk4a5c8a72003-03-06 00:02:04 +00003601 In the target system modem support is enabled when a
3602 specific key (key combination) is pressed during
3603 power-on. Otherwise U-Boot will boot normally
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003604 (autoboot). The key_pressed() function is called from
wdenk4a5c8a72003-03-06 00:02:04 +00003605 board_init(). Currently key_pressed() is a dummy
3606 function, returning 1 and thus enabling modem
3607 initialization.
wdenkc6097192002-11-03 00:24:07 +00003608
wdenk4a5c8a72003-03-06 00:02:04 +00003609 If there are no modem init strings in the
3610 environment, U-Boot proceed to autoboot; the
3611 previous output (banner, info printfs) will be
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003612 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00003613
3614 See also: doc/README.Modem
3615
Helmut Raigerd5a184b2011-10-20 04:19:47 +00003616Board initialization settings:
3617------------------------------
3618
3619During Initialization u-boot calls a number of board specific functions
3620to allow the preparation of board specific prerequisites, e.g. pin setup
3621before drivers are initialized. To enable these callbacks the
3622following configuration macros have to be defined. Currently this is
3623architecture specific, so please check arch/your_architecture/lib/board.c
3624typically in board_init_f() and board_init_r().
3625
3626- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3627- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3628- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3629- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003630
wdenkc6097192002-11-03 00:24:07 +00003631Configuration Settings:
3632-----------------------
3633
York Sun6c480012014-02-26 17:03:19 -08003634- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3635 Optionally it can be defined to support 64-bit memory commands.
3636
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003637- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003638 undefine this when you're short of memory.
3639
Peter Tyserdfb72b82009-01-27 18:03:12 -06003640- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3641 width of the commands listed in the 'help' command output.
3642
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003643- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003644 prompt for user input.
3645
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003646- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003647
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003648- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003649
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003650- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003651
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003652- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003653 the application (usually a Linux kernel) when it is
3654 booted
3655
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003656- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003657 List of legal baudrate settings for this board.
3658
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003659- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk57b2d802003-06-27 21:31:46 +00003660 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00003661
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003662- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk57b2d802003-06-27 21:31:46 +00003663 If the board specific function
3664 extern int overwrite_console (void);
3665 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00003666 serial port, else the settings in the environment are used.
3667
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003668- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk57b2d802003-06-27 21:31:46 +00003669 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00003670
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003671- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00003672 Enable overwrite of previous console environment settings.
3673
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003674- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003675 Begin and End addresses of the area used by the
3676 simple memory test.
3677
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003678- CONFIG_SYS_ALT_MEMTEST:
wdenk57b2d802003-06-27 21:31:46 +00003679 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003680
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003681- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5958f4a2003-09-18 09:21:33 +00003682 Scratch address used by the alternate memory test
3683 You only need to set this if address zero isn't writeable
3684
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003685- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
3686 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01003687 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003688 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01003689 fixing up gd->ram_size the Linux kernel should gets passed
3690 the now "corrected" memory size and won't touch it either.
3691 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01003692 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01003693 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01003694 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01003695
3696 This option can be used as a workaround for the 440EPx/GRx
3697 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3698 be touched.
3699
3700 WARNING: Please make sure that this value is a multiple of
3701 the Linux page size (normally 4k). If this is not the case,
3702 then the end address of the Linux memory will be located at a
3703 non page size aligned address and this could cause major
3704 problems.
3705
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003706- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003707 Enable temporary baudrate change while serial download
3708
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003709- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003710 Physical start address of SDRAM. _Must_ be 0 here.
3711
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003712- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00003713 Physical start address of Motherboard I/O (if using a
3714 Cogent motherboard)
3715
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003716- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003717 Physical start address of Flash memory.
3718
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003719- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003720 Physical start address of boot monitor code (set by
3721 make config files to be same as the text base address
Wolfgang Denk0708bc62010-10-07 21:51:12 +02003722 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003723 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003724
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003725- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00003726 Size of memory reserved for monitor code, used to
3727 determine _at_compile_time_ (!) if the environment is
3728 embedded within the U-Boot image, or in a separate
3729 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003730
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003731- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003732 Size of DRAM reserved for malloc() use.
3733
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003734- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01003735 Normally compressed uImages are limited to an
3736 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003737 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01003738 to adjust this setting to your needs.
3739
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003740- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003741 Maximum size of memory mapped by the startup code of
3742 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003743 the Linux kernel (bd_info, boot arguments, FDT blob if
3744 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003745 environment variable is defined and non-zero. In such case
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003746 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denk092ae952011-10-26 10:21:21 +00003747 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likely26396382011-03-28 09:58:43 +00003748 variable "bootm_mapsize" will override the value of
3749 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3750 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003751
John Rigbyeea8e692010-10-13 13:57:35 -06003752- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3753 Enable initrd_high functionality. If defined then the
3754 initrd_high feature is enabled and the bootm ramdisk subcommand
3755 is enabled.
3756
3757- CONFIG_SYS_BOOT_GET_CMDLINE:
3758 Enables allocating and saving kernel cmdline in space between
3759 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3760
3761- CONFIG_SYS_BOOT_GET_KBD:
3762 Enables allocating and saving a kernel copy of the bd_info in
3763 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3764
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003765- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003766 Max number of Flash memory banks
3767
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003768- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003769 Max number of sectors on a Flash chip
3770
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003771- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003772 Timeout for Flash erase operations (in ms)
3773
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003774- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003775 Timeout for Flash write operations (in ms)
3776
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003777- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003778 Timeout for Flash set sector lock bit operation (in ms)
3779
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003780- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003781 Timeout for Flash clear lock bits operation (in ms)
3782
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003783- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00003784 If defined, hardware flash sectors protection is used
3785 instead of U-Boot software protection.
3786
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003787- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003788
3789 Enable TFTP transfers directly to flash memory;
3790 without this option such a download has to be
3791 performed in two steps: (1) download to RAM, and (2)
3792 copy from RAM to flash.
3793
3794 The two-step approach is usually more reliable, since
3795 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003796 the flash, but in some situations (when system RAM is
3797 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003798 downloaded image) this option may be very useful.
3799
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003800- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00003801 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00003802 common flash structure for storing flash geometry.
3803
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02003804- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00003805 This option also enables the building of the cfi_flash driver
3806 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003807
Piotr Ziecik3e939e92008-11-17 15:57:58 +01003808- CONFIG_FLASH_CFI_MTD
3809 This option enables the building of the cfi_mtd driver
3810 in the drivers directory. The driver exports CFI flash
3811 to the MTD layer.
3812
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003813- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02003814 Use buffered writes to flash.
3815
3816- CONFIG_FLASH_SPANSION_S29WS_N
3817 s29ws-n MirrorBit flash has non-standard addresses for buffered
3818 write commands.
3819
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003820- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01003821 If this option is defined, the common CFI flash doesn't
3822 print it's warning upon not recognized FLASH banks. This
3823 is useful, if some of the configured banks are only
3824 optionally available.
3825
Jerry Van Barenaae73572008-03-08 13:48:01 -05003826- CONFIG_FLASH_SHOW_PROGRESS
3827 If defined (must be an integer), print out countdown
3828 digits and dots. Recommended value: 45 (9..1) for 80
3829 column displays, 15 (3..1) for 40 column displays.
3830
Stefan Roesed20cba52013-04-04 15:53:14 +02003831- CONFIG_FLASH_VERIFY
3832 If defined, the content of the flash (destination) is compared
3833 against the source after the write operation. An error message
3834 will be printed when the contents are not identical.
3835 Please note that this option is useless in nearly all cases,
3836 since such flash programming errors usually are detected earlier
3837 while unprotecting/erasing/programming. Please only enable
3838 this option if you really know what you are doing.
3839
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003840- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003841 Defines the number of Ethernet receive buffers. On some
3842 Ethernet controllers it is recommended to set this value
stroese94ef1cf2003-06-05 15:39:44 +00003843 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3844 buffers can be full shortly after enabling the interface
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003845 on high Ethernet traffic.
stroese94ef1cf2003-06-05 15:39:44 +00003846 Defaults to 4 if not defined.
3847
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003848- CONFIG_ENV_MAX_ENTRIES
3849
Wolfgang Denk1136f692010-10-27 22:48:30 +02003850 Maximum number of entries in the hash table that is used
3851 internally to store the environment settings. The default
3852 setting is supposed to be generous and should work in most
3853 cases. This setting can be used to tune behaviour; see
3854 lib/hashtable.c for details.
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003855
Joe Hershberger71497d02012-12-11 22:16:31 -06003856- CONFIG_ENV_FLAGS_LIST_DEFAULT
3857- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003858 Enable validation of the values given to environment variables when
Joe Hershberger71497d02012-12-11 22:16:31 -06003859 calling env set. Variables can be restricted to only decimal,
3860 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3861 the variables can also be restricted to IP address or MAC address.
3862
3863 The format of the list is:
3864 type_attribute = [s|d|x|b|i|m]
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003865 access_atribute = [a|r|o|c]
3866 attributes = type_attribute[access_atribute]
Joe Hershberger71497d02012-12-11 22:16:31 -06003867 entry = variable_name[:attributes]
3868 list = entry[,list]
3869
3870 The type attributes are:
3871 s - String (default)
3872 d - Decimal
3873 x - Hexadecimal
3874 b - Boolean ([1yYtT|0nNfF])
3875 i - IP address
3876 m - MAC address
3877
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003878 The access attributes are:
3879 a - Any (default)
3880 r - Read-only
3881 o - Write-once
3882 c - Change-default
3883
Joe Hershberger71497d02012-12-11 22:16:31 -06003884 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3885 Define this to a list (string) to define the ".flags"
3886 envirnoment variable in the default or embedded environment.
3887
3888 - CONFIG_ENV_FLAGS_LIST_STATIC
3889 Define this to a list (string) to define validation that
3890 should be done if an entry is not found in the ".flags"
3891 environment variable. To override a setting in the static
3892 list, simply add an entry for the same variable name to the
3893 ".flags" variable.
3894
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003895- CONFIG_ENV_ACCESS_IGNORE_FORCE
3896 If defined, don't allow the -f switch to env set override variable
3897 access flags.
3898
Simon Glass66828322013-03-08 13:45:27 +00003899- CONFIG_SYS_GENERIC_BOARD
3900 This selects the architecture-generic board system instead of the
3901 architecture-specific board files. It is intended to move boards
3902 to this new framework over time. Defining this will disable the
3903 arch/foo/lib/board.c file and use common/board_f.c and
3904 common/board_r.c instead. To use this option your architecture
3905 must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
3906 its config.mk file). If you find problems enabling this option on
3907 your board please report the problem and send patches!
3908
Lokesh Vutla100c2d82013-04-17 20:49:40 +00003909- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
3910 This is set by OMAP boards for the max time that reset should
3911 be asserted. See doc/README.omap-reset-time for details on how
3912 the value can be calulated on a given board.
Simon Glass9c9f44a2013-03-11 07:06:48 +00003913
wdenkc6097192002-11-03 00:24:07 +00003914The following definitions that deal with the placement and management
3915of environment data (variable area); in general, we support the
3916following configurations:
3917
Mike Frysinger63b8f122011-07-08 10:44:25 +00003918- CONFIG_BUILD_ENVCRC:
3919
3920 Builds up envcrc with the target environment so that external utils
3921 may easily extract it and embed it in final U-Boot images.
3922
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02003923- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00003924
3925 Define this if the environment is in flash memory.
3926
3927 a) The environment occupies one whole flash sector, which is
3928 "embedded" in the text segment with the U-Boot code. This
3929 happens usually with "bottom boot sector" or "top boot
3930 sector" type flash chips, which have several smaller
3931 sectors at the start or the end. For instance, such a
3932 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3933 such a case you would place the environment in one of the
3934 4 kB sectors - with U-Boot code before and after it. With
3935 "top boot sector" type flash chips, you would put the
3936 environment in one of the last sectors, leaving a gap
3937 between U-Boot and the environment.
3938
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003939 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003940
3941 Offset of environment data (variable area) to the
3942 beginning of flash memory; for instance, with bottom boot
3943 type flash chips the second sector can be used: the offset
3944 for this sector is given here.
3945
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003946 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00003947
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003948 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003949
3950 This is just another way to specify the start address of
3951 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003952 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00003953
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003954 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003955
3956 Size of the sector containing the environment.
3957
3958
3959 b) Sometimes flash chips have few, equal sized, BIG sectors.
3960 In such a case you don't want to spend a whole sector for
3961 the environment.
3962
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003963 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003964
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02003965 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003966 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00003967 of this flash sector for the environment. This saves
3968 memory for the RAM copy of the environment.
3969
3970 It may also save flash memory if you decide to use this
3971 when your environment is "embedded" within U-Boot code,
3972 since then the remainder of the flash sector could be used
3973 for U-Boot code. It should be pointed out that this is
3974 STRONGLY DISCOURAGED from a robustness point of view:
3975 updating the environment in flash makes it always
3976 necessary to erase the WHOLE sector. If something goes
3977 wrong before the contents has been restored from a copy in
3978 RAM, your target system will be dead.
3979
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003980 - CONFIG_ENV_ADDR_REDUND
3981 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00003982
wdenk4a5c8a72003-03-06 00:02:04 +00003983 These settings describe a second storage area used to hold
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003984 a redundant copy of the environment data, so that there is
wdenkb02744a2003-04-05 00:53:31 +00003985 a valid backup copy in case there is a power failure during
wdenk4a5c8a72003-03-06 00:02:04 +00003986 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00003987
3988BE CAREFUL! Any changes to the flash layout, and some changes to the
3989source code will make it necessary to adapt <board>/u-boot.lds*
3990accordingly!
3991
3992
Jean-Christophe PLAGNIOL-VILLARDfdb79c32008-09-10 22:47:59 +02003993- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00003994
3995 Define this if you have some non-volatile memory device
3996 (NVRAM, battery buffered SRAM) which you want to use for the
3997 environment.
3998
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003999 - CONFIG_ENV_ADDR:
4000 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004001
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004002 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00004003 want to use for environment. It is assumed that this memory
4004 can just be read and written to, without any special
4005 provision.
4006
4007BE CAREFUL! The first access to the environment happens quite early
4008in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004009console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00004010U-Boot will hang.
4011
4012Please note that even with NVRAM we still use a copy of the
4013environment in RAM: we could work on NVRAM directly, but we want to
4014keep settings there always unmodified except somebody uses "saveenv"
4015to save the current settings.
4016
4017
Jean-Christophe PLAGNIOL-VILLARDe46af642008-09-05 09:19:30 +02004018- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00004019
4020 Use this if you have an EEPROM or similar serial access
4021 device and a driver for it.
4022
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004023 - CONFIG_ENV_OFFSET:
4024 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004025
4026 These two #defines specify the offset and size of the
4027 environment area within the total memory of your EEPROM.
4028
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004029 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004030 If defined, specified the chip address of the EEPROM device.
4031 The default address is zero.
4032
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004033 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00004034 If defined, the number of bits used to address bytes in a
4035 single page in the EEPROM device. A 64 byte page, for example
4036 would require six bits.
4037
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004038 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00004039 If defined, the number of milliseconds to delay between
wdenk544e9732004-02-06 23:19:44 +00004040 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00004041
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004042 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00004043 The length in bytes of the EEPROM memory array address. Note
4044 that this is NOT the chip address length!
4045
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004046 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk20c98a62004-04-23 20:32:05 +00004047 EEPROM chips that implement "address overflow" are ones
4048 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
4049 address and the extra bits end up in the "chip address" bit
4050 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
4051 byte chips.
4052
4053 Note that we consider the length of the address field to
4054 still be one byte because the extra address bits are hidden
4055 in the chip address.
4056
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004057 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004058 The size in bytes of the EEPROM device.
4059
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01004060 - CONFIG_ENV_EEPROM_IS_ON_I2C
4061 define this, if you have I2C and SPI activated, and your
4062 EEPROM, which holds the environment, is on the I2C bus.
4063
4064 - CONFIG_I2C_ENV_EEPROM_BUS
4065 if you have an Environment on an EEPROM reached over
4066 I2C muxes, you can define here, how to reach this
4067 EEPROM. For example:
4068
Heiko Schocher479a4cf2013-01-29 08:53:15 +01004069 #define CONFIG_I2C_ENV_EEPROM_BUS 1
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01004070
4071 EEPROM which holds the environment, is reached over
4072 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00004073
Jean-Christophe PLAGNIOL-VILLARD2b14d2b2008-09-10 22:47:58 +02004074- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk86765902003-12-06 23:55:10 +00004075
wdenk1ebf41e2004-01-02 14:00:00 +00004076 Define this if you have a DataFlash memory device which you
wdenk86765902003-12-06 23:55:10 +00004077 want to use for the environment.
4078
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004079 - CONFIG_ENV_OFFSET:
4080 - CONFIG_ENV_ADDR:
4081 - CONFIG_ENV_SIZE:
wdenk86765902003-12-06 23:55:10 +00004082
4083 These three #defines specify the offset and size of the
4084 environment area within the total memory of your DataFlash placed
4085 at the specified address.
4086
Wu, Josh76db7bf2014-07-01 19:30:13 +08004087- CONFIG_ENV_IS_IN_SPI_FLASH:
4088
4089 Define this if you have a SPI Flash memory device which you
4090 want to use for the environment.
4091
4092 - CONFIG_ENV_OFFSET:
4093 - CONFIG_ENV_SIZE:
4094
4095 These two #defines specify the offset and size of the
4096 environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
4097 aligned to an erase sector boundary.
4098
4099 - CONFIG_ENV_SECT_SIZE:
4100
4101 Define the SPI flash's sector size.
4102
4103 - CONFIG_ENV_OFFSET_REDUND (optional):
4104
4105 This setting describes a second storage area of CONFIG_ENV_SIZE
4106 size used to hold a redundant copy of the environment data, so
4107 that there is a valid backup copy in case there is a power failure
4108 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
4109 aligned to an erase sector boundary.
4110
4111 - CONFIG_ENV_SPI_BUS (optional):
4112 - CONFIG_ENV_SPI_CS (optional):
4113
4114 Define the SPI bus and chip select. If not defined they will be 0.
4115
4116 - CONFIG_ENV_SPI_MAX_HZ (optional):
4117
4118 Define the SPI max work clock. If not defined then use 1MHz.
4119
4120 - CONFIG_ENV_SPI_MODE (optional):
4121
4122 Define the SPI work mode. If not defined then use SPI_MODE_3.
4123
Liu Gang85bcd732012-03-08 00:33:20 +00004124- CONFIG_ENV_IS_IN_REMOTE:
4125
4126 Define this if you have a remote memory space which you
4127 want to use for the local device's environment.
4128
4129 - CONFIG_ENV_ADDR:
4130 - CONFIG_ENV_SIZE:
4131
4132 These two #defines specify the address and size of the
4133 environment area within the remote memory space. The
4134 local device can get the environment from remote memory
Liu Gang357bf5a2012-08-09 05:10:01 +00004135 space by SRIO or PCIE links.
Liu Gang85bcd732012-03-08 00:33:20 +00004136
4137BE CAREFUL! For some special cases, the local device can not use
4138"saveenv" command. For example, the local device will get the
Liu Gang357bf5a2012-08-09 05:10:01 +00004139environment stored in a remote NOR flash by SRIO or PCIE link,
4140but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang85bcd732012-03-08 00:33:20 +00004141
Jean-Christophe PLAGNIOL-VILLARDdda84dd2008-09-10 22:47:58 +02004142- CONFIG_ENV_IS_IN_NAND:
wdenk79b59372004-06-09 14:58:14 +00004143
4144 Define this if you have a NAND device which you want to use
4145 for the environment.
4146
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004147 - CONFIG_ENV_OFFSET:
4148 - CONFIG_ENV_SIZE:
wdenk79b59372004-06-09 14:58:14 +00004149
4150 These two #defines specify the offset and size of the environment
Scott Wood08239322010-09-17 14:38:37 -05004151 area within the first NAND device. CONFIG_ENV_OFFSET must be
4152 aligned to an erase block boundary.
wdenk86765902003-12-06 23:55:10 +00004153
Scott Wood08239322010-09-17 14:38:37 -05004154 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004155
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004156 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Wood08239322010-09-17 14:38:37 -05004157 size used to hold a redundant copy of the environment data, so
4158 that there is a valid backup copy in case there is a power failure
Wolfgang Denk092ae952011-10-26 10:21:21 +00004159 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Wood08239322010-09-17 14:38:37 -05004160 aligned to an erase block boundary.
4161
4162 - CONFIG_ENV_RANGE (optional):
4163
4164 Specifies the length of the region in which the environment
4165 can be written. This should be a multiple of the NAND device's
4166 block size. Specifying a range with more erase blocks than
4167 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
4168 the range to be avoided.
4169
4170 - CONFIG_ENV_OFFSET_OOB (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004171
Scott Wood08239322010-09-17 14:38:37 -05004172 Enables support for dynamically retrieving the offset of the
4173 environment from block zero's out-of-band data. The
4174 "nand env.oob" command can be used to record this offset.
4175 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
4176 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004177
Guennadi Liakhovetskifad24442009-05-18 16:07:22 +02004178- CONFIG_NAND_ENV_DST
4179
4180 Defines address in RAM to which the nand_spl code should copy the
4181 environment. If redundant environment is used, it will be copied to
4182 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
4183
Joe Hershberger0c5faa82013-04-08 10:32:51 +00004184- CONFIG_ENV_IS_IN_UBI:
4185
4186 Define this if you have an UBI volume that you want to use for the
4187 environment. This has the benefit of wear-leveling the environment
4188 accesses, which is important on NAND.
4189
4190 - CONFIG_ENV_UBI_PART:
4191
4192 Define this to a string that is the mtd partition containing the UBI.
4193
4194 - CONFIG_ENV_UBI_VOLUME:
4195
4196 Define this to the name of the volume that you want to store the
4197 environment in.
4198
Joe Hershbergerdb14e862013-04-08 10:32:52 +00004199 - CONFIG_ENV_UBI_VOLUME_REDUND:
4200
4201 Define this to the name of another volume to store a second copy of
4202 the environment in. This will enable redundant environments in UBI.
4203 It is assumed that both volumes are in the same MTD partition.
4204
Joe Hershberger0c5faa82013-04-08 10:32:51 +00004205 - CONFIG_UBI_SILENCE_MSG
4206 - CONFIG_UBIFS_SILENCE_MSG
4207
4208 You will probably want to define these to avoid a really noisy system
4209 when storing the env in UBI.
4210
Wu, Josha7d0c872014-06-24 17:31:03 +08004211- CONFIG_ENV_IS_IN_FAT:
4212 Define this if you want to use the FAT file system for the environment.
4213
4214 - FAT_ENV_INTERFACE:
4215
4216 Define this to a string that is the name of the block device.
4217
4218 - FAT_ENV_DEV_AND_PART:
4219
4220 Define this to a string to specify the partition of the device. It can
4221 be as following:
4222
4223 "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
4224 - "D:P": device D partition P. Error occurs if device D has no
4225 partition table.
4226 - "D:0": device D.
4227 - "D" or "D:": device D partition 1 if device D has partition
4228 table, or the whole device D if has no partition
4229 table.
4230 - "D:auto": first partition in device D with bootable flag set.
4231 If none, first valid paratition in device D. If no
4232 partition table then means device D.
4233
4234 - FAT_ENV_FILE:
4235
4236 It's a string of the FAT file name. This file use to store the
4237 envrionment.
4238
4239 - CONFIG_FAT_WRITE:
4240 This should be defined. Otherwise it cannot save the envrionment file.
4241
Stephen Warreneedcacd2013-06-11 15:14:00 -06004242- CONFIG_ENV_IS_IN_MMC:
4243
4244 Define this if you have an MMC device which you want to use for the
4245 environment.
4246
4247 - CONFIG_SYS_MMC_ENV_DEV:
4248
4249 Specifies which MMC device the environment is stored in.
4250
4251 - CONFIG_SYS_MMC_ENV_PART (optional):
4252
4253 Specifies which MMC partition the environment is stored in. If not
4254 set, defaults to partition 0, the user area. Common values might be
4255 1 (first MMC boot partition), 2 (second MMC boot partition).
4256
4257 - CONFIG_ENV_OFFSET:
4258 - CONFIG_ENV_SIZE:
4259
4260 These two #defines specify the offset and size of the environment
4261 area within the specified MMC device.
4262
Stephen Warren24dc2032013-06-11 15:14:02 -06004263 If offset is positive (the usual case), it is treated as relative to
4264 the start of the MMC partition. If offset is negative, it is treated
4265 as relative to the end of the MMC partition. This can be useful if
4266 your board may be fitted with different MMC devices, which have
4267 different sizes for the MMC partitions, and you always want the
4268 environment placed at the very end of the partition, to leave the
4269 maximum possible space before it, to store other data.
4270
Stephen Warreneedcacd2013-06-11 15:14:00 -06004271 These two values are in units of bytes, but must be aligned to an
4272 MMC sector boundary.
4273
4274 - CONFIG_ENV_OFFSET_REDUND (optional):
4275
4276 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
4277 hold a redundant copy of the environment data. This provides a
4278 valid backup copy in case the other copy is corrupted, e.g. due
4279 to a power failure during a "saveenv" operation.
4280
Stephen Warren24dc2032013-06-11 15:14:02 -06004281 This value may also be positive or negative; this is handled in the
4282 same way as CONFIG_ENV_OFFSET.
4283
Stephen Warreneedcacd2013-06-11 15:14:00 -06004284 This value is also in units of bytes, but must also be aligned to
4285 an MMC sector boundary.
4286
4287 - CONFIG_ENV_SIZE_REDUND (optional):
4288
4289 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
4290 set. If this value is set, it must be set to the same value as
4291 CONFIG_ENV_SIZE.
4292
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004293- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00004294
4295 Defines offset to the initial SPI buffer area in DPRAM. The
4296 area is used at an early stage (ROM part) if the environment
4297 is configured to reside in the SPI EEPROM: We need a 520 byte
4298 scratch DPRAM area. It is used between the two initialization
4299 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4300 to be a good choice since it makes it far enough from the
4301 start of the data area as well as from the stack pointer.
4302
Bruce Adleredecc942007-11-02 13:15:42 -07004303Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00004304has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denk76af2782010-07-24 21:55:43 +02004305created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00004306until then to read environment variables.
4307
wdenk8dba0502003-03-31 16:34:49 +00004308The environment is protected by a CRC32 checksum. Before the monitor
4309is relocated into RAM, as a result of a bad CRC you will be working
4310with the compiled-in default environment - *silently*!!! [This is
4311necessary, because the first environment variable we need is the
4312"baudrate" setting for the console - if we have a bad CRC, we don't
4313have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00004314
4315Note: once the monitor has been relocated, then it will complain if
4316the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00004317use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00004318
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004319- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk9c53f402003-10-15 23:53:47 +00004320 Echo the inverted Ethernet link state to the fault LED.
wdenk49c3f672003-10-08 22:33:00 +00004321
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004322 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenk49c3f672003-10-08 22:33:00 +00004323 also needs to be defined.
4324
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004325- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00004326 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00004327
Ron Madriddfa028a2009-02-18 14:30:44 -08004328- CONFIG_NS16550_MIN_FUNCTIONS:
4329 Define this if you desire to only have use of the NS16550_init
4330 and NS16550_putc functions for the serial driver located at
4331 drivers/serial/ns16550.c. This option is useful for saving
4332 space for already greatly restricted images, including but not
4333 limited to NAND_SPL configurations.
4334
Simon Glass28a9e332012-11-30 13:01:18 +00004335- CONFIG_DISPLAY_BOARDINFO
4336 Display information about the board that U-Boot is running on
4337 when U-Boot starts up. The board function checkboard() is called
4338 to do this.
4339
Simon Glasse8822012012-11-30 13:01:19 +00004340- CONFIG_DISPLAY_BOARDINFO_LATE
4341 Similar to the previous option, but display this information
4342 later, once stdio is running and output goes to the LCD, if
4343 present.
4344
wdenkc6097192002-11-03 00:24:07 +00004345Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00004346---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004347
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004348- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004349 Cache Line Size of the CPU.
4350
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004351- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00004352 Default address of the IMMR after system reset.
wdenk2bb11052003-07-17 23:16:40 +00004353
wdenk9c53f402003-10-15 23:53:47 +00004354 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
4355 and RPXsuper) to be able to adjust the position of
4356 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00004357
Timur Tabid8f341c2011-08-04 18:03:41 -05004358- CONFIG_SYS_CCSRBAR_DEFAULT:
4359 Default (power-on reset) physical address of CCSR on Freescale
4360 PowerPC SOCs.
4361
4362- CONFIG_SYS_CCSRBAR:
4363 Virtual address of CCSR. On a 32-bit build, this is typically
4364 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4365
4366 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4367 for cross-platform code that uses that macro instead.
4368
4369- CONFIG_SYS_CCSRBAR_PHYS:
4370 Physical address of CCSR. CCSR can be relocated to a new
4371 physical address, if desired. In this case, this macro should
Wolfgang Denk092ae952011-10-26 10:21:21 +00004372 be set to that address. Otherwise, it should be set to the
Timur Tabid8f341c2011-08-04 18:03:41 -05004373 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
4374 is typically relocated on 36-bit builds. It is recommended
4375 that this macro be defined via the _HIGH and _LOW macros:
4376
4377 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4378 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4379
4380- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denkd590fb12011-10-07 09:58:21 +02004381 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
4382 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabid8f341c2011-08-04 18:03:41 -05004383 used in assembly code, so it must not contain typecasts or
4384 integer size suffixes (e.g. "ULL").
4385
4386- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4387 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
4388 used in assembly code, so it must not contain typecasts or
4389 integer size suffixes (e.g. "ULL").
4390
4391- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4392 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4393 forced to a value that ensures that CCSR is not relocated.
4394
wdenk1272e232002-11-10 22:06:23 +00004395- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004396 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk1272e232002-11-10 22:06:23 +00004397
4398 the default drive number (default value 0)
4399
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004400 CONFIG_SYS_ISA_IO_STRIDE
wdenk1272e232002-11-10 22:06:23 +00004401
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004402 defines the spacing between FDC chipset registers
wdenk1272e232002-11-10 22:06:23 +00004403 (default value 1)
4404
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004405 CONFIG_SYS_ISA_IO_OFFSET
wdenk1272e232002-11-10 22:06:23 +00004406
wdenk4a5c8a72003-03-06 00:02:04 +00004407 defines the offset of register from address. It
4408 depends on which part of the data bus is connected to
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004409 the FDC chipset. (default value 0)
wdenk1272e232002-11-10 22:06:23 +00004410
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004411 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
4412 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk4a5c8a72003-03-06 00:02:04 +00004413 default value.
wdenk1272e232002-11-10 22:06:23 +00004414
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004415 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk4a5c8a72003-03-06 00:02:04 +00004416 fdc_hw_init() is called at the beginning of the FDC
4417 setup. fdc_hw_init() must be provided by the board
4418 source code. It is used to make hardware dependant
4419 initializations.
wdenk1272e232002-11-10 22:06:23 +00004420
Macpaul Lind1e49942011-04-11 20:45:32 +00004421- CONFIG_IDE_AHB:
4422 Most IDE controllers were designed to be connected with PCI
4423 interface. Only few of them were designed for AHB interface.
4424 When software is doing ATA command and data transfer to
4425 IDE devices through IDE-AHB controller, some additional
4426 registers accessing to these kind of IDE-AHB controller
4427 is requierd.
4428
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004429- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00004430 DO NOT CHANGE unless you know exactly what you're
wdenkb3a4a702004-12-10 11:40:40 +00004431 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00004432
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004433- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004434
wdenkeb20ad32003-09-05 23:19:14 +00004435 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00004436 initial data and stack; please note that this must be
4437 writable memory that is working WITHOUT special
4438 initialization, i. e. you CANNOT use normal RAM which
4439 will become available only after programming the
4440 memory controller and running certain initialization
4441 sequences.
4442
4443 U-Boot uses the following memory types:
4444 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4445 - MPC824X: data cache
4446 - PPC4xx: data cache
4447
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004448- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004449
4450 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004451 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
4452 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00004453 data is located at the end of the available space
Wolfgang Denk1c2e98e2010-10-26 13:32:32 +02004454 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004455 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
4456 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4457 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00004458
4459 Note:
4460 On the MPC824X (or other systems that use the data
4461 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004462 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00004463 point to an otherwise UNUSED address space between
4464 the top of RAM and the start of the PCI space.
4465
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004466- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00004467
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004468- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00004469
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004470- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00004471
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004472- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00004473
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004474- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00004475
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004476- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00004477
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004478- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00004479 SDRAM timing
4480
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004481- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00004482 periodic timer for refresh
4483
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004484- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00004485
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004486- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4487 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4488 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4489 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004490 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4491
4492- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004493 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4494 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004495 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4496
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004497- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4498 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00004499 Machine Mode Register and Memory Periodic Timer
4500 Prescaler definitions (SDRAM timing)
4501
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004502- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004503 enable I2C microcode relocation patch (MPC8xx);
4504 define relocation offset in DPRAM [DSP2]
4505
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004506- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherc8148ed2008-01-11 01:12:07 +01004507 enable SMC microcode relocation patch (MPC8xx);
4508 define relocation offset in DPRAM [SMC1]
4509
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004510- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004511 enable SPI microcode relocation patch (MPC8xx);
4512 define relocation offset in DPRAM [SCC4]
4513
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004514- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00004515 Use OSCM clock mode on MBX8xx board. Be careful,
4516 wrong setting might damage your board. Read
4517 doc/README.MBX before setting this variable!
4518
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004519- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk4a5c8a72003-03-06 00:02:04 +00004520 Offset of the bootmode word in DPRAM used by post
4521 (Power On Self Tests). This definition overrides
4522 #define'd default value in commproc.h resp.
4523 cpm_8260.h.
wdenk2029f4d2002-11-21 23:11:29 +00004524
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004525- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4526 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4527 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4528 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4529 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4530 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4531 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4532 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roese88fbf932010-04-15 16:07:28 +02004533 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenkbf2f8c92003-05-22 22:52:13 +00004534
Dirk Eibach378d1ca2009-02-09 08:18:34 +01004535- CONFIG_PCI_DISABLE_PCIE:
4536 Disable PCI-Express on systems where it is supported but not
4537 required.
4538
Andrew Sharp61d47ca2012-08-29 14:16:32 +00004539- CONFIG_PCI_ENUM_ONLY
4540 Only scan through and get the devices on the busses.
4541 Don't do any setup work, presumably because someone or
4542 something has already done it, and we don't need to do it
4543 a second time. Useful for platforms that are pre-booted
4544 by coreboot or similar.
4545
Gabor Juhosb4458732013-05-30 07:06:12 +00004546- CONFIG_PCI_INDIRECT_BRIDGE:
4547 Enable support for indirect PCI bridges.
4548
Kumar Gala8975d7a2010-12-30 12:09:53 -06004549- CONFIG_SYS_SRIO:
4550 Chip has SRIO or not
4551
4552- CONFIG_SRIO1:
4553 Board has SRIO 1 port available
4554
4555- CONFIG_SRIO2:
4556 Board has SRIO 2 port available
4557
Liu Gang27afb9c2013-05-07 16:30:46 +08004558- CONFIG_SRIO_PCIE_BOOT_MASTER
4559 Board can support master function for Boot from SRIO and PCIE
4560
Kumar Gala8975d7a2010-12-30 12:09:53 -06004561- CONFIG_SYS_SRIOn_MEM_VIRT:
4562 Virtual Address of SRIO port 'n' memory region
4563
4564- CONFIG_SYS_SRIOn_MEM_PHYS:
4565 Physical Address of SRIO port 'n' memory region
4566
4567- CONFIG_SYS_SRIOn_MEM_SIZE:
4568 Size of SRIO port 'n' memory region
4569
Fabio Estevamf17e8782013-04-11 09:35:34 +00004570- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4571 Defined to tell the NAND controller that the NAND chip is using
4572 a 16 bit bus.
4573 Not all NAND drivers use this symbol.
Fabio Estevam417052b2013-04-11 09:35:35 +00004574 Example of drivers that use it:
Fabio Estevamf17e8782013-04-11 09:35:34 +00004575 - drivers/mtd/nand/ndfc.c
Fabio Estevam417052b2013-04-11 09:35:35 +00004576 - drivers/mtd/nand/mxc_nand.c
Alex Watermancd6aae32011-05-19 15:08:36 -04004577
4578- CONFIG_SYS_NDFC_EBC0_CFG
4579 Sets the EBC0_CFG register for the NDFC. If not defined
4580 a default value will be used.
4581
Ben Warren45657152006-09-07 16:50:54 -04004582- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004583 Get DDR timing information from an I2C EEPROM. Common
4584 with pluggable memory modules such as SODIMMs
4585
Ben Warren45657152006-09-07 16:50:54 -04004586 SPD_EEPROM_ADDRESS
4587 I2C address of the SPD EEPROM
4588
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004589- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004590 If SPD EEPROM is on an I2C bus other than the first
4591 one, specify here. Note that the value must resolve
4592 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04004593
York Sune73cc042011-06-07 09:42:16 +08004594- CONFIG_SYS_DDR_RAW_TIMING
4595 Get DDR timing information from other than SPD. Common with
4596 soldered DDR chips onboard without SPD. DDR raw timing
4597 parameters are extracted from datasheet and hard-coded into
4598 header files or board specific files.
4599
York Sunbd495cf2011-09-16 13:21:35 -07004600- CONFIG_FSL_DDR_INTERACTIVE
4601 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4602
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004603- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004604 Only for 83xx systems. If specified, then DDR should
4605 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06004606
wdenk6203e402004-04-18 10:13:26 +00004607- CONFIG_ETHER_ON_FEC[12]
4608 Define to enable FEC[12] on a 8xx series processor.
4609
4610- CONFIG_FEC[12]_PHY
4611 Define to the hardcoded PHY address which corresponds
wdenk05939202004-04-18 17:39:38 +00004612 to the given FEC; i. e.
4613 #define CONFIG_FEC1_PHY 4
wdenk6203e402004-04-18 10:13:26 +00004614 means that the PHY with address 4 is connected to FEC1
4615
4616 When set to -1, means to probe for first available.
4617
4618- CONFIG_FEC[12]_PHY_NORXERR
4619 The PHY does not have a RXERR line (RMII only).
4620 (so program the FEC to ignore it).
4621
4622- CONFIG_RMII
4623 Enable RMII mode for all FECs.
4624 Note that this is a global option, we can't
4625 have one FEC in standard MII mode and another in RMII mode.
4626
wdenk20c98a62004-04-23 20:32:05 +00004627- CONFIG_CRC32_VERIFY
4628 Add a verify option to the crc32 command.
4629 The syntax is:
4630
4631 => crc32 -v <address> <count> <crc32>
4632
4633 Where address/count indicate a memory area
4634 and crc32 is the correct crc32 which the
4635 area should have.
4636
wdenk64519362004-07-11 17:40:54 +00004637- CONFIG_LOOPW
4638 Add the "loopw" memory command. This only takes effect if
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004639 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk64519362004-07-11 17:40:54 +00004640
stroesecc3af832004-12-16 18:46:55 +00004641- CONFIG_MX_CYCLIC
4642 Add the "mdc" and "mwc" memory commands. These are cyclic
4643 "md/mw" commands.
4644 Examples:
4645
wdenk07d7e6b2004-12-16 21:44:03 +00004646 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00004647 This command will print 4 bytes (10,11,12,13) each 500 ms.
4648
wdenk07d7e6b2004-12-16 21:44:03 +00004649 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00004650 This command will write 12345678 to address 100 all 10 ms.
4651
wdenk07d7e6b2004-12-16 21:44:03 +00004652 This only takes effect if the memory commands are activated
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004653 globally (CONFIG_CMD_MEM).
stroesecc3af832004-12-16 18:46:55 +00004654
wdenk3d3d99f2005-04-04 12:44:11 +00004655- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004656 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk302141d2010-11-27 23:30:56 +01004657 low level initializations (like setting up the memory
4658 controller) are omitted and/or U-Boot does not
4659 relocate itself into RAM.
wdenk3d3d99f2005-04-04 12:44:11 +00004660
Wolfgang Denk302141d2010-11-27 23:30:56 +01004661 Normally this variable MUST NOT be defined. The only
4662 exception is when U-Boot is loaded (to RAM) by some
4663 other boot loader or by a debugger which performs
4664 these initializations itself.
wdenk3d3d99f2005-04-04 12:44:11 +00004665
Aneesh V552a3192011-07-13 05:11:07 +00004666- CONFIG_SPL_BUILD
Magnus Lilja1ec96d82009-06-13 20:50:00 +02004667 Modifies the behaviour of start.S when compiling a loader
4668 that is executed before the actual U-Boot. E.g. when
4669 compiling a NAND SPL.
wdenk336b2bc2005-04-02 23:52:25 +00004670
Ying Zhang2d2e3b62013-08-16 15:16:15 +08004671- CONFIG_TPL_BUILD
4672 Modifies the behaviour of start.S when compiling a loader
4673 that is executed after the SPL and before the actual U-Boot.
4674 It is loaded by the SPL.
4675
Ying Zhang0d4f5442013-05-20 14:07:23 +08004676- CONFIG_SYS_MPC85XX_NO_RESETVEC
4677 Only for 85xx systems. If this variable is specified, the section
4678 .resetvec is not kept and the section .bootpg is placed in the
4679 previous 4k of the .text section.
4680
Simon Glass17dabf02013-02-24 17:33:14 +00004681- CONFIG_ARCH_MAP_SYSMEM
4682 Generally U-Boot (and in particular the md command) uses
4683 effective address. It is therefore not necessary to regard
4684 U-Boot address as virtual addresses that need to be translated
4685 to physical addresses. However, sandbox requires this, since
4686 it maintains its own little RAM buffer which contains all
4687 addressable memory. This option causes some memory accesses
4688 to be mapped through map_sysmem() / unmap_sysmem().
4689
Matthias Weisser93416c12011-03-10 21:36:32 +00004690- CONFIG_USE_ARCH_MEMCPY
4691 CONFIG_USE_ARCH_MEMSET
4692 If these options are used a optimized version of memcpy/memset will
4693 be used if available. These functions may be faster under some
4694 conditions but may increase the binary size.
4695
Simon Glassbfb59802013-02-14 04:18:54 +00004696- CONFIG_X86_RESET_VECTOR
4697 If defined, the x86 reset vector code is included. This is not
4698 needed when U-Boot is running from Coreboot.
Gabe Black14f82462012-11-27 21:08:06 +00004699
Mark Jackson52b003c2013-03-04 01:27:20 +00004700- CONFIG_SYS_MPUCLK
4701 Defines the MPU clock speed (in MHz).
4702
4703 NOTE : currently only supported on AM335x platforms.
Gabe Black76ce2492012-11-29 16:23:41 +00004704
Heiko Schocher2233e462013-11-04 14:05:00 +01004705- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
4706 Enables the RTC32K OSC on AM33xx based plattforms
4707
Karicheri, Muralidharanc1dc61b2014-04-04 13:16:50 -04004708- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
4709 Option to disable subpage write in NAND driver
4710 driver that uses this:
4711 drivers/mtd/nand/davinci_nand.c
4712
Timur Tabi275f4bb2011-11-22 09:21:25 -06004713Freescale QE/FMAN Firmware Support:
4714-----------------------------------
4715
4716The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4717loading of "firmware", which is encoded in the QE firmware binary format.
4718This firmware often needs to be loaded during U-Boot booting, so macros
4719are used to identify the storage device (NOR flash, SPI, etc) and the address
4720within that device.
4721
Zhao Qiang83a90842014-03-21 16:21:44 +08004722- CONFIG_SYS_FMAN_FW_ADDR
4723 The address in the storage device where the FMAN microcode is located. The
4724 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4725 is also specified.
4726
4727- CONFIG_SYS_QE_FW_ADDR
4728 The address in the storage device where the QE microcode is located. The
Timur Tabi275f4bb2011-11-22 09:21:25 -06004729 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4730 is also specified.
4731
4732- CONFIG_SYS_QE_FMAN_FW_LENGTH
4733 The maximum possible size of the firmware. The firmware binary format
4734 has a field that specifies the actual size of the firmware, but it
4735 might not be possible to read any part of the firmware unless some
4736 local storage is allocated to hold the entire firmware first.
4737
4738- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4739 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4740 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
4741 virtual address in NOR flash.
4742
4743- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4744 Specifies that QE/FMAN firmware is located in NAND flash.
4745 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4746
4747- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4748 Specifies that QE/FMAN firmware is located on the primary SD/MMC
4749 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4750
4751- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
4752 Specifies that QE/FMAN firmware is located on the primary SPI
4753 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4754
Liu Gang1e084582012-03-08 00:33:18 +00004755- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4756 Specifies that QE/FMAN firmware is located in the remote (master)
4757 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gang357bf5a2012-08-09 05:10:01 +00004758 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4759 window->master inbound window->master LAW->the ucode address in
4760 master's memory space.
Timur Tabi275f4bb2011-11-22 09:21:25 -06004761
J. German Rivera8ff14b72014-06-23 15:15:55 -07004762Freescale Layerscape Management Complex Firmware Support:
4763---------------------------------------------------------
4764The Freescale Layerscape Management Complex (MC) supports the loading of
4765"firmware".
4766This firmware often needs to be loaded during U-Boot booting, so macros
4767are used to identify the storage device (NOR flash, SPI, etc) and the address
4768within that device.
4769
4770- CONFIG_FSL_MC_ENET
4771 Enable the MC driver for Layerscape SoCs.
4772
4773- CONFIG_SYS_LS_MC_FW_ADDR
4774 The address in the storage device where the firmware is located. The
4775 meaning of this address depends on which CONFIG_SYS_LS_MC_FW_IN_xxx macro
4776 is also specified.
4777
4778- CONFIG_SYS_LS_MC_FW_LENGTH
4779 The maximum possible size of the firmware. The firmware binary format
4780 has a field that specifies the actual size of the firmware, but it
4781 might not be possible to read any part of the firmware unless some
4782 local storage is allocated to hold the entire firmware first.
4783
4784- CONFIG_SYS_LS_MC_FW_IN_NOR
4785 Specifies that MC firmware is located in NOR flash, mapped as
4786 normal addressable memory via the LBC. CONFIG_SYS_LS_MC_FW_ADDR is the
4787 virtual address in NOR flash.
4788
wdenkc6097192002-11-03 00:24:07 +00004789Building the Software:
4790======================
4791
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004792Building U-Boot has been tested in several native build environments
4793and in many different cross environments. Of course we cannot support
4794all possibly existing versions of cross development tools in all
4795(potentially obsolete) versions. In case of tool chain problems we
4796recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4797which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004798
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004799If you are not using a native environment, it is assumed that you
4800have GNU cross compiling tools available in your path. In this case,
4801you must set the environment variable CROSS_COMPILE in your shell.
4802Note that no changes to the Makefile or any other source files are
4803necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00004804
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004805 $ CROSS_COMPILE=ppc_4xx-
4806 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00004807
Peter Tyserb06976d2009-03-13 18:54:51 -05004808Note: If you wish to generate Windows versions of the utilities in
4809 the tools directory you can use the MinGW toolchain
4810 (http://www.mingw.org). Set your HOST tools to the MinGW
4811 toolchain and execute 'make tools'. For example:
4812
4813 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
4814
4815 Binaries such as tools/mkimage.exe will be created which can
4816 be executed on computers running Windows.
4817
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004818U-Boot is intended to be simple to build. After installing the
4819sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00004820is done by typing:
4821
4822 make NAME_config
4823
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004824where "NAME_config" is the name of one of the existing configu-
Michael Jones5a7fb6f2012-03-15 22:48:10 +00004825rations; see boards.cfg for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00004826
wdenk6c59edc2004-05-03 20:45:30 +00004827Note: for some board special configuration names may exist; check if
4828 additional information is available from the board vendor; for
4829 instance, the TQM823L systems are available without (standard)
4830 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004831 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00004832
wdenk6c59edc2004-05-03 20:45:30 +00004833 make TQM823L_config
4834 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00004835
wdenk6c59edc2004-05-03 20:45:30 +00004836 make TQM823L_LCD_config
4837 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00004838
wdenk6c59edc2004-05-03 20:45:30 +00004839 etc.
wdenkc6097192002-11-03 00:24:07 +00004840
wdenkc6097192002-11-03 00:24:07 +00004841
wdenk6c59edc2004-05-03 20:45:30 +00004842Finally, type "make all", and you should get some working U-Boot
4843images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00004844
wdenk6c59edc2004-05-03 20:45:30 +00004845- "u-boot.bin" is a raw binary image
4846- "u-boot" is an image in ELF binary format
4847- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00004848
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004849By default the build is performed locally and the objects are saved
4850in the source directory. One of the two methods can be used to change
4851this behavior and build U-Boot to some external directory:
4852
48531. Add O= to the make command line invocations:
4854
4855 make O=/tmp/build distclean
4856 make O=/tmp/build NAME_config
4857 make O=/tmp/build all
4858
48592. Set environment variable BUILD_DIR to point to the desired location:
4860
4861 export BUILD_DIR=/tmp/build
4862 make distclean
4863 make NAME_config
4864 make all
4865
4866Note that the command line "O=" setting overrides the BUILD_DIR environment
4867variable.
4868
wdenkc6097192002-11-03 00:24:07 +00004869
wdenk6c59edc2004-05-03 20:45:30 +00004870Please be aware that the Makefiles assume you are using GNU make, so
4871for instance on NetBSD you might need to use "gmake" instead of
4872native "make".
wdenkc6097192002-11-03 00:24:07 +00004873
wdenkc6097192002-11-03 00:24:07 +00004874
wdenk6c59edc2004-05-03 20:45:30 +00004875If the system board that you have is not listed, then you will need
4876to port U-Boot to your hardware platform. To do this, follow these
4877steps:
wdenkc6097192002-11-03 00:24:07 +00004878
wdenk6c59edc2004-05-03 20:45:30 +000048791. Add a new configuration option for your board to the toplevel
Michael Jones5a7fb6f2012-03-15 22:48:10 +00004880 "boards.cfg" file, using the existing entries as examples.
4881 Follow the instructions there to keep the boards in order.
wdenk6c59edc2004-05-03 20:45:30 +000048822. Create a new directory to hold your board specific code. Add any
4883 files you need. In your board directory, you will need at least
4884 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
48853. Create a new configuration file "include/configs/<board>.h" for
4886 your board
48873. If you're porting U-Boot to a new CPU, then also create a new
4888 directory to hold your CPU specific code. Add any files you need.
48894. Run "make <board>_config" with your new name.
48905. Type "make", and you should get a working "u-boot.srec" file
4891 to be installed on your target system.
48926. Debug and solve any problems that might arise.
4893 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00004894
wdenkc6097192002-11-03 00:24:07 +00004895
wdenk6c59edc2004-05-03 20:45:30 +00004896Testing of U-Boot Modifications, Ports to New Hardware, etc.:
4897==============================================================
wdenkc6097192002-11-03 00:24:07 +00004898
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004899If you have modified U-Boot sources (for instance added a new board
4900or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00004901provide feedback to the other developers. The feedback normally takes
4902the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004903official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00004904
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004905But before you submit such a patch, please verify that your modifi-
4906cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00004907the supported boards compile WITHOUT ANY compiler warnings. To do so,
4908just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004909for ALL supported system. Be warned, this will take a while. You can
4910select which (cross) compiler to use by passing a `CROSS_COMPILE'
4911environment variable to the script, i. e. to use the ELDK cross tools
4912you can type
wdenkc6097192002-11-03 00:24:07 +00004913
wdenk6c59edc2004-05-03 20:45:30 +00004914 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00004915
wdenk6c59edc2004-05-03 20:45:30 +00004916or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00004917
wdenk6c59edc2004-05-03 20:45:30 +00004918 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00004919
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004920When using the MAKEALL script, the default behaviour is to build
4921U-Boot in the source directory. This location can be changed by
4922setting the BUILD_DIR environment variable. Also, for each target
4923built, the MAKEALL script saves two log files (<target>.ERR and
4924<target>.MAKEALL) in the <source dir>/LOG directory. This default
4925location can be changed by setting the MAKEALL_LOGDIR environment
4926variable. For example:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004927
4928 export BUILD_DIR=/tmp/build
4929 export MAKEALL_LOGDIR=/tmp/log
4930 CROSS_COMPILE=ppc_8xx- MAKEALL
4931
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004932With the above settings build objects are saved in the /tmp/build,
4933log files are saved in the /tmp/log and the source tree remains clean
4934during the whole build process.
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004935
4936
wdenk6c59edc2004-05-03 20:45:30 +00004937See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00004938
wdenkc6097192002-11-03 00:24:07 +00004939
wdenk6c59edc2004-05-03 20:45:30 +00004940Monitor Commands - Overview:
4941============================
wdenkc6097192002-11-03 00:24:07 +00004942
wdenk6c59edc2004-05-03 20:45:30 +00004943go - start application at address 'addr'
4944run - run commands in an environment variable
4945bootm - boot application image from memory
4946bootp - boot image via network using BootP/TFTP protocol
Marek Vasutcf41a9b2012-03-14 21:52:45 +00004947bootz - boot zImage from memory
wdenk6c59edc2004-05-03 20:45:30 +00004948tftpboot- boot image via network using TFTP protocol
4949 and env variables "ipaddr" and "serverip"
4950 (and eventually "gatewayip")
Simon Glass6a398d22011-10-24 18:00:07 +00004951tftpput - upload a file via network using TFTP protocol
wdenk6c59edc2004-05-03 20:45:30 +00004952rarpboot- boot image via network using RARP/TFTP protocol
4953diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
4954loads - load S-Record file over serial line
4955loadb - load binary file over serial line (kermit mode)
4956md - memory display
4957mm - memory modify (auto-incrementing)
4958nm - memory modify (constant address)
4959mw - memory write (fill)
4960cp - memory copy
4961cmp - memory compare
4962crc32 - checksum calculation
Peter Tyser469cde42009-04-18 22:34:03 -05004963i2c - I2C sub-system
wdenk6c59edc2004-05-03 20:45:30 +00004964sspi - SPI utility commands
4965base - print or set address offset
4966printenv- print environment variables
4967setenv - set environment variables
4968saveenv - save environment variables to persistent storage
4969protect - enable or disable FLASH write protection
4970erase - erase FLASH memory
4971flinfo - print FLASH memory information
Karl O. Pinc4baf03d2012-08-03 05:57:21 +00004972nand - NAND memory operations (see doc/README.nand)
wdenk6c59edc2004-05-03 20:45:30 +00004973bdinfo - print Board Info structure
4974iminfo - print header information for application image
4975coninfo - print console devices and informations
4976ide - IDE sub-system
4977loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00004978loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00004979mtest - simple RAM test
4980icache - enable or disable instruction cache
4981dcache - enable or disable data cache
4982reset - Perform RESET of the CPU
4983echo - echo args to console
4984version - print monitor version
4985help - print online help
4986? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00004987
wdenkc6097192002-11-03 00:24:07 +00004988
wdenk6c59edc2004-05-03 20:45:30 +00004989Monitor Commands - Detailed Description:
4990========================================
wdenkc6097192002-11-03 00:24:07 +00004991
wdenk6c59edc2004-05-03 20:45:30 +00004992TODO.
wdenkc6097192002-11-03 00:24:07 +00004993
wdenk6c59edc2004-05-03 20:45:30 +00004994For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00004995
4996
wdenk6c59edc2004-05-03 20:45:30 +00004997Environment Variables:
4998======================
wdenkc6097192002-11-03 00:24:07 +00004999
wdenk6c59edc2004-05-03 20:45:30 +00005000U-Boot supports user configuration using Environment Variables which
5001can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00005002
wdenk6c59edc2004-05-03 20:45:30 +00005003Environment Variables are set using "setenv", printed using
5004"printenv", and saved to Flash using "saveenv". Using "setenv"
5005without a value can be used to delete a variable from the
5006environment. As long as you don't save the environment you are
5007working with an in-memory copy. In case the Flash area containing the
5008environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00005009
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005010Some configuration options can be set using Environment Variables.
5011
5012List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00005013
wdenk6c59edc2004-05-03 20:45:30 +00005014 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00005015
wdenk6c59edc2004-05-03 20:45:30 +00005016 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00005017
wdenk6c59edc2004-05-03 20:45:30 +00005018 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00005019
wdenk6c59edc2004-05-03 20:45:30 +00005020 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00005021
wdenk6c59edc2004-05-03 20:45:30 +00005022 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00005023
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02005024 bootm_low - Memory range available for image processing in the bootm
5025 command can be restricted. This variable is given as
5026 a hexadecimal number and defines lowest address allowed
5027 for use by the bootm command. See also "bootm_size"
5028 environment variable. Address defined by "bootm_low" is
5029 also the base of the initial memory mapping for the Linux
Grant Likely26396382011-03-28 09:58:43 +00005030 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
5031 bootm_mapsize.
5032
Wolfgang Denk092ae952011-10-26 10:21:21 +00005033 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likely26396382011-03-28 09:58:43 +00005034 This variable is given as a hexadecimal number and it
5035 defines the size of the memory region starting at base
5036 address bootm_low that is accessible by the Linux kernel
5037 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
5038 as the default value if it is defined, and bootm_size is
5039 used otherwise.
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02005040
5041 bootm_size - Memory range available for image processing in the bootm
5042 command can be restricted. This variable is given as
5043 a hexadecimal number and defines the size of the region
5044 allowed for use by the bootm command. See also "bootm_low"
5045 environment variable.
5046
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02005047 updatefile - Location of the software update file on a TFTP server, used
5048 by the automatic software update feature. Please refer to
5049 documentation in doc/README.update for more details.
5050
wdenk6c59edc2004-05-03 20:45:30 +00005051 autoload - if set to "no" (any string beginning with 'n'),
5052 "bootp" will just load perform a lookup of the
5053 configuration from the BOOTP server, but not try to
5054 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00005055
wdenk6c59edc2004-05-03 20:45:30 +00005056 autostart - if set to "yes", an image loaded using the "bootp",
5057 "rarpboot", "tftpboot" or "diskboot" commands will
5058 be automatically started (by internally calling
5059 "bootm")
wdenkc6097192002-11-03 00:24:07 +00005060
wdenk6c59edc2004-05-03 20:45:30 +00005061 If set to "no", a standalone image passed to the
5062 "bootm" command will be copied to the load address
5063 (and eventually uncompressed), but NOT be started.
5064 This can be used to load and uncompress arbitrary
5065 data.
wdenkc6097192002-11-03 00:24:07 +00005066
David A. Longd558a4e2011-07-09 16:40:19 -04005067 fdt_high - if set this restricts the maximum address that the
5068 flattened device tree will be copied into upon boot.
Shawn Guo0ca9e982012-01-09 21:54:08 +00005069 For example, if you have a system with 1 GB memory
5070 at physical address 0x10000000, while Linux kernel
5071 only recognizes the first 704 MB as low memory, you
5072 may need to set fdt_high as 0x3C000000 to have the
5073 device tree blob be copied to the maximum address
5074 of the 704 MB low memory, so that Linux kernel can
5075 access it during the boot procedure.
5076
David A. Longd558a4e2011-07-09 16:40:19 -04005077 If this is set to the special value 0xFFFFFFFF then
5078 the fdt will not be copied at all on boot. For this
5079 to work it must reside in writable memory, have
5080 sufficient padding on the end of it for u-boot to
5081 add the information it needs into it, and the memory
5082 must be accessible by the kernel.
5083
Simon Glassdc6fa642011-10-24 19:15:34 +00005084 fdtcontroladdr- if set this is the address of the control flattened
5085 device tree used by U-Boot when CONFIG_OF_CONTROL is
5086 defined.
5087
wdenk0e2bd9c2004-06-06 21:51:03 +00005088 i2cfast - (PPC405GP|PPC405EP only)
5089 if set to 'y' configures Linux I2C driver for fast
5090 mode (400kHZ). This environment variable is used in
5091 initialization code. So, for changes to be effective
5092 it must be saved and board must be reset.
5093
wdenk6c59edc2004-05-03 20:45:30 +00005094 initrd_high - restrict positioning of initrd images:
5095 If this variable is not set, initrd images will be
5096 copied to the highest possible address in RAM; this
5097 is usually what you want since it allows for
5098 maximum initrd size. If for some reason you want to
5099 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005100 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk6c59edc2004-05-03 20:45:30 +00005101 variable to a value of "no" or "off" or "0".
5102 Alternatively, you can set it to a maximum upper
5103 address to use (U-Boot will still check that it
5104 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00005105
wdenk6c59edc2004-05-03 20:45:30 +00005106 For instance, when you have a system with 16 MB
5107 RAM, and want to reserve 4 MB from use by Linux,
5108 you can do this by adding "mem=12M" to the value of
5109 the "bootargs" variable. However, now you must make
5110 sure that the initrd image is placed in the first
5111 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00005112
wdenk6c59edc2004-05-03 20:45:30 +00005113 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00005114
wdenk6c59edc2004-05-03 20:45:30 +00005115 If you set initrd_high to 0xFFFFFFFF, this is an
5116 indication to U-Boot that all addresses are legal
5117 for the Linux kernel, including addresses in flash
5118 memory. In this case U-Boot will NOT COPY the
5119 ramdisk at all. This may be useful to reduce the
5120 boot time on your system, but requires that this
5121 feature is supported by your Linux kernel.
wdenk3f9ab982003-04-12 23:38:12 +00005122
wdenk6c59edc2004-05-03 20:45:30 +00005123 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00005124
wdenk6c59edc2004-05-03 20:45:30 +00005125 loadaddr - Default load address for commands like "bootp",
5126 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00005127
wdenk6c59edc2004-05-03 20:45:30 +00005128 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00005129
wdenk6c59edc2004-05-03 20:45:30 +00005130 serverip - TFTP server IP address; needed for tftpboot command
wdenk6f770ed2003-05-23 23:18:21 +00005131
wdenk6c59edc2004-05-03 20:45:30 +00005132 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00005133
wdenk6c59edc2004-05-03 20:45:30 +00005134 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00005135
wdenk6c59edc2004-05-03 20:45:30 +00005136 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00005137
Mike Frysingera23230c2011-10-02 10:01:27 +00005138 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00005139
Mike Frysingera23230c2011-10-02 10:01:27 +00005140 ethact - controls which interface is currently active.
5141 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00005142
Heiko Schocherc5e84052010-07-20 17:45:02 +02005143 => setenv ethact FEC
5144 => ping 192.168.0.1 # traffic sent on FEC
5145 => setenv ethact SCC
5146 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00005147
Matthias Fuchs204f0ec2008-01-17 07:45:05 +01005148 ethrotate - When set to "no" U-Boot does not go through all
5149 available network interfaces.
5150 It just stays at the currently selected interface.
5151
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005152 netretry - When set to "no" each network operation will
wdenk6c59edc2004-05-03 20:45:30 +00005153 either succeed or fail without retrying.
5154 When set to "once" the network operation will
5155 fail when all the available network interfaces
5156 are tried once without success.
5157 Useful on scripts which control the retry operation
5158 themselves.
wdenkc6097192002-11-03 00:24:07 +00005159
Jean-Christophe PLAGNIOL-VILLARD1948d6c2009-01-31 09:53:39 +01005160 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDd2164ef2008-01-07 08:41:34 +01005161
Simon Glass5db3f932013-07-16 20:10:00 -07005162 silent_linux - If set then linux will be told to boot silently, by
5163 changing the console to be empty. If "yes" it will be
5164 made silent. If "no" it will not be made silent. If
5165 unset, then it will be made silent if the U-Boot console
5166 is silent.
5167
Wolfgang Denk227b5192005-09-24 23:25:46 +02005168 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denke3cfce52005-09-24 22:37:32 +02005169 UDP source port.
5170
Wolfgang Denk227b5192005-09-24 23:25:46 +02005171 tftpdstport - If this is set, the value is used for TFTP's UDP
5172 destination port instead of the Well Know Port 69.
5173
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005174 tftpblocksize - Block size to use for TFTP transfers; if not set,
5175 we use the TFTP server's default block size
5176
5177 tftptimeout - Retransmission timeout for TFTP packets (in milli-
5178 seconds, minimum value is 1000 = 1 second). Defines
5179 when a packet is considered to be lost so it has to
5180 be retransmitted. The default is 5000 = 5 seconds.
5181 Lowering this value may make downloads succeed
5182 faster in networks with high packet loss rates or
5183 with unreliable TFTP servers.
5184
5185 vlan - When set to a value < 4095 the traffic over
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005186 Ethernet is encapsulated/received over 802.1q
wdenk6c59edc2004-05-03 20:45:30 +00005187 VLAN tagged frames.
wdenk145d2c12004-04-15 21:48:45 +00005188
Jason Hobbse3fe08e2011-08-31 05:37:28 +00005189The following image location variables contain the location of images
5190used in booting. The "Image" column gives the role of the image and is
5191not an environment variable name. The other columns are environment
5192variable names. "File Name" gives the name of the file on a TFTP
5193server, "RAM Address" gives the location in RAM the image will be
5194loaded to, and "Flash Location" gives the image's address in NOR
5195flash or offset in NAND flash.
5196
5197*Note* - these variables don't have to be defined for all boards, some
5198boards currenlty use other variables for these purposes, and some
5199boards use these variables for other purposes.
5200
Wolfgang Denk092ae952011-10-26 10:21:21 +00005201Image File Name RAM Address Flash Location
5202----- --------- ----------- --------------
5203u-boot u-boot u-boot_addr_r u-boot_addr
5204Linux kernel bootfile kernel_addr_r kernel_addr
5205device tree blob fdtfile fdt_addr_r fdt_addr
5206ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbse3fe08e2011-08-31 05:37:28 +00005207
wdenk6c59edc2004-05-03 20:45:30 +00005208The following environment variables may be used and automatically
5209updated by the network boot commands ("bootp" and "rarpboot"),
5210depending the information provided by your boot server:
wdenk145d2c12004-04-15 21:48:45 +00005211
wdenk6c59edc2004-05-03 20:45:30 +00005212 bootfile - see above
5213 dnsip - IP address of your Domain Name Server
5214 dnsip2 - IP address of your secondary Domain Name Server
5215 gatewayip - IP address of the Gateway (Router) to use
5216 hostname - Target hostname
5217 ipaddr - see above
5218 netmask - Subnet Mask
5219 rootpath - Pathname of the root filesystem on the NFS server
5220 serverip - see above
wdenk145d2c12004-04-15 21:48:45 +00005221
wdenk145d2c12004-04-15 21:48:45 +00005222
wdenk6c59edc2004-05-03 20:45:30 +00005223There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005224
wdenk6c59edc2004-05-03 20:45:30 +00005225 serial# - contains hardware identification information such
5226 as type string and/or serial number
5227 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00005228
wdenk6c59edc2004-05-03 20:45:30 +00005229These variables can be set only once (usually during manufacturing of
5230the board). U-Boot refuses to delete or overwrite these variables
5231once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00005232
5233
wdenk6c59edc2004-05-03 20:45:30 +00005234Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005235
wdenk6c59edc2004-05-03 20:45:30 +00005236 ver - Contains the U-Boot version string as printed
5237 with the "version" command. This variable is
5238 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00005239
wdenkc6097192002-11-03 00:24:07 +00005240
wdenk6c59edc2004-05-03 20:45:30 +00005241Please note that changes to some configuration parameters may take
5242only effect after the next boot (yes, that's just like Windoze :-).
stroeseb9c17c52003-04-04 15:53:41 +00005243
stroeseb9c17c52003-04-04 15:53:41 +00005244
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005245Callback functions for environment variables:
5246---------------------------------------------
5247
5248For some environment variables, the behavior of u-boot needs to change
5249when their values are changed. This functionailty allows functions to
5250be associated with arbitrary variables. On creation, overwrite, or
5251deletion, the callback will provide the opportunity for some side
5252effect to happen or for the change to be rejected.
5253
5254The callbacks are named and associated with a function using the
5255U_BOOT_ENV_CALLBACK macro in your board or driver code.
5256
5257These callbacks are associated with variables in one of two ways. The
5258static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5259in the board configuration to a string that defines a list of
5260associations. The list must be in the following format:
5261
5262 entry = variable_name[:callback_name]
5263 list = entry[,list]
5264
5265If the callback name is not specified, then the callback is deleted.
5266Spaces are also allowed anywhere in the list.
5267
5268Callbacks can also be associated by defining the ".callbacks" variable
5269with the same list format above. Any association in ".callbacks" will
5270override any association in the static list. You can define
5271CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
5272".callbacks" envirnoment variable in the default or embedded environment.
5273
5274
wdenk6c59edc2004-05-03 20:45:30 +00005275Command Line Parsing:
5276=====================
stroeseb9c17c52003-04-04 15:53:41 +00005277
wdenk6c59edc2004-05-03 20:45:30 +00005278There are two different command line parsers available with U-Boot:
5279the old "simple" one, and the much more powerful "hush" shell:
wdenkc6097192002-11-03 00:24:07 +00005280
wdenk6c59edc2004-05-03 20:45:30 +00005281Old, simple command line parser:
5282--------------------------------
wdenkc6097192002-11-03 00:24:07 +00005283
wdenk6c59edc2004-05-03 20:45:30 +00005284- supports environment variables (through setenv / saveenv commands)
5285- several commands on one line, separated by ';'
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01005286- variable substitution using "... ${name} ..." syntax
wdenk6c59edc2004-05-03 20:45:30 +00005287- special characters ('$', ';') can be escaped by prefixing with '\',
5288 for example:
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01005289 setenv bootcmd bootm \${address}
wdenk6c59edc2004-05-03 20:45:30 +00005290- You can also escape text by enclosing in single apostrophes, for example:
5291 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00005292
wdenk6c59edc2004-05-03 20:45:30 +00005293Hush shell:
5294-----------
wdenkf4688a22003-05-28 08:06:31 +00005295
wdenk6c59edc2004-05-03 20:45:30 +00005296- similar to Bourne shell, with control structures like
5297 if...then...else...fi, for...do...done; while...do...done,
5298 until...do...done, ...
5299- supports environment ("global") variables (through setenv / saveenv
5300 commands) and local shell variables (through standard shell syntax
5301 "name=value"); only environment variables can be used with "run"
5302 command
wdenkf4688a22003-05-28 08:06:31 +00005303
wdenk6c59edc2004-05-03 20:45:30 +00005304General rules:
5305--------------
wdenkf4688a22003-05-28 08:06:31 +00005306
wdenk6c59edc2004-05-03 20:45:30 +00005307(1) If a command line (or an environment variable executed by a "run"
5308 command) contains several commands separated by semicolon, and
5309 one of these commands fails, then the remaining commands will be
5310 executed anyway.
wdenkf4688a22003-05-28 08:06:31 +00005311
wdenk6c59edc2004-05-03 20:45:30 +00005312(2) If you execute several variables with one call to run (i. e.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005313 calling run with a list of variables as arguments), any failing
wdenk6c59edc2004-05-03 20:45:30 +00005314 command will cause "run" to terminate, i. e. the remaining
5315 variables are not executed.
wdenkf4688a22003-05-28 08:06:31 +00005316
wdenk6c59edc2004-05-03 20:45:30 +00005317Note for Redundant Ethernet Interfaces:
5318=======================================
wdenkf4688a22003-05-28 08:06:31 +00005319
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005320Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00005321such configurations and is capable of automatic selection of a
5322"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00005323
wdenk6c59edc2004-05-03 20:45:30 +00005324Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
5325MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5326"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00005327
wdenk6c59edc2004-05-03 20:45:30 +00005328If the network interface stores some valid MAC address (for instance
5329in SROM), this is used as default address if there is NO correspon-
5330ding setting in the environment; if the corresponding environment
5331variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00005332
wdenk6c59edc2004-05-03 20:45:30 +00005333o If the SROM has a valid MAC address, and there is no address in the
5334 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00005335
wdenk6c59edc2004-05-03 20:45:30 +00005336o If there is no valid address in the SROM, and a definition in the
5337 environment exists, then the value from the environment variable is
5338 used.
wdenkc6097192002-11-03 00:24:07 +00005339
wdenk6c59edc2004-05-03 20:45:30 +00005340o If both the SROM and the environment contain a MAC address, and
5341 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00005342
wdenk6c59edc2004-05-03 20:45:30 +00005343o If both the SROM and the environment contain a MAC address, and the
5344 addresses differ, the value from the environment is used and a
5345 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00005346
wdenk6c59edc2004-05-03 20:45:30 +00005347o If neither SROM nor the environment contain a MAC address, an error
5348 is raised.
wdenkc6097192002-11-03 00:24:07 +00005349
Ben Warren6db991a2010-04-26 11:11:46 -07005350If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denk092ae952011-10-26 10:21:21 +00005351will be programmed into hardware as part of the initialization process. This
Ben Warren6db991a2010-04-26 11:11:46 -07005352may be skipped by setting the appropriate 'ethmacskip' environment variable.
5353The naming convention is as follows:
5354"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00005355
wdenk6c59edc2004-05-03 20:45:30 +00005356Image Formats:
5357==============
wdenkc6097192002-11-03 00:24:07 +00005358
Marian Balakowicz18710b82008-03-12 12:13:13 +01005359U-Boot is capable of booting (and performing other auxiliary operations on)
5360images in two formats:
5361
5362New uImage format (FIT)
5363-----------------------
5364
5365Flexible and powerful format based on Flattened Image Tree -- FIT (similar
5366to Flattened Device Tree). It allows the use of images with multiple
5367components (several kernels, ramdisks, etc.), with contents protected by
5368SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
5369
5370
5371Old uImage format
5372-----------------
5373
5374Old image format is based on binary files which can be basically anything,
5375preceded by a special header; see the definitions in include/image.h for
5376details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00005377
wdenk6c59edc2004-05-03 20:45:30 +00005378* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5379 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05005380 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5381 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5382 INTEGRITY).
Wolfgang Denk83c15852006-10-24 14:21:16 +02005383* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Lin1cac36e2011-10-19 20:41:11 +00005384 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5385 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00005386* Compression Type (uncompressed, gzip, bzip2)
5387* Load Address
5388* Entry Point
5389* Image Name
5390* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00005391
wdenk6c59edc2004-05-03 20:45:30 +00005392The header is marked by a special Magic Number, and both the header
5393and the data portions of the image are secured against corruption by
5394CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00005395
wdenkc6097192002-11-03 00:24:07 +00005396
wdenk6c59edc2004-05-03 20:45:30 +00005397Linux Support:
5398==============
wdenkc6097192002-11-03 00:24:07 +00005399
wdenk6c59edc2004-05-03 20:45:30 +00005400Although U-Boot should support any OS or standalone application
5401easily, the main focus has always been on Linux during the design of
5402U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005403
wdenk6c59edc2004-05-03 20:45:30 +00005404U-Boot includes many features that so far have been part of some
5405special "boot loader" code within the Linux kernel. Also, any
5406"initrd" images to be used are no longer part of one big Linux image;
5407instead, kernel and "initrd" are separate images. This implementation
5408serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00005409
wdenk6c59edc2004-05-03 20:45:30 +00005410- the same features can be used for other OS or standalone
5411 applications (for instance: using compressed images to reduce the
5412 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00005413
wdenk6c59edc2004-05-03 20:45:30 +00005414- it becomes much easier to port new Linux kernel versions because
5415 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00005416
wdenk6c59edc2004-05-03 20:45:30 +00005417- the same Linux kernel image can now be used with different "initrd"
5418 images; of course this also means that different kernel images can
5419 be run with the same "initrd". This makes testing easier (you don't
5420 have to build a new "zImage.initrd" Linux image when you just
5421 change a file in your "initrd"). Also, a field-upgrade of the
5422 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00005423
wdenkc6097192002-11-03 00:24:07 +00005424
wdenk6c59edc2004-05-03 20:45:30 +00005425Linux HOWTO:
5426============
wdenkc6097192002-11-03 00:24:07 +00005427
wdenk6c59edc2004-05-03 20:45:30 +00005428Porting Linux to U-Boot based systems:
5429---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00005430
wdenk6c59edc2004-05-03 20:45:30 +00005431U-Boot cannot save you from doing all the necessary modifications to
5432configure the Linux device drivers for use with your target hardware
5433(no, we don't intend to provide a full virtual machine interface to
5434Linux :-).
wdenkc6097192002-11-03 00:24:07 +00005435
Stefan Roese88fbf932010-04-15 16:07:28 +02005436But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00005437
wdenk6c59edc2004-05-03 20:45:30 +00005438Just make sure your machine specific header file (for instance
5439include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02005440Information structure as we define in include/asm-<arch>/u-boot.h,
5441and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005442as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00005443
Simon Glassd097e592014-06-11 23:29:46 -06005444Note that U-Boot now has a driver model, a unified model for drivers.
5445If you are adding a new driver, plumb it into driver model. If there
5446is no uclass available, you are encouraged to create one. See
5447doc/driver-model.
5448
wdenkc6097192002-11-03 00:24:07 +00005449
wdenk6c59edc2004-05-03 20:45:30 +00005450Configuring the Linux kernel:
5451-----------------------------
wdenkc6097192002-11-03 00:24:07 +00005452
wdenk6c59edc2004-05-03 20:45:30 +00005453No specific requirements for U-Boot. Make sure you have some root
5454device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00005455
wdenkc6097192002-11-03 00:24:07 +00005456
wdenk6c59edc2004-05-03 20:45:30 +00005457Building a Linux Image:
5458-----------------------
wdenkc6097192002-11-03 00:24:07 +00005459
wdenk6c59edc2004-05-03 20:45:30 +00005460With U-Boot, "normal" build targets like "zImage" or "bzImage" are
5461not used. If you use recent kernel source, a new build target
5462"uImage" will exist which automatically builds an image usable by
5463U-Boot. Most older kernels also have support for a "pImage" target,
5464which was introduced for our predecessor project PPCBoot and uses a
5465100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00005466
wdenk6c59edc2004-05-03 20:45:30 +00005467Example:
wdenkc6097192002-11-03 00:24:07 +00005468
wdenk6c59edc2004-05-03 20:45:30 +00005469 make TQM850L_config
5470 make oldconfig
5471 make dep
5472 make uImage
wdenkc6097192002-11-03 00:24:07 +00005473
wdenk6c59edc2004-05-03 20:45:30 +00005474The "uImage" build target uses a special tool (in 'tools/mkimage') to
5475encapsulate a compressed Linux kernel image with header information,
5476CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00005477
wdenk6c59edc2004-05-03 20:45:30 +00005478* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00005479
wdenk6c59edc2004-05-03 20:45:30 +00005480* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00005481
wdenk6c59edc2004-05-03 20:45:30 +00005482 ${CROSS_COMPILE}-objcopy -O binary \
5483 -R .note -R .comment \
5484 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00005485
wdenk6c59edc2004-05-03 20:45:30 +00005486* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00005487
wdenk6c59edc2004-05-03 20:45:30 +00005488 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00005489
wdenk6c59edc2004-05-03 20:45:30 +00005490* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00005491
wdenk6c59edc2004-05-03 20:45:30 +00005492 mkimage -A ppc -O linux -T kernel -C gzip \
5493 -a 0 -e 0 -n "Linux Kernel Image" \
5494 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00005495
wdenkc6097192002-11-03 00:24:07 +00005496
wdenk6c59edc2004-05-03 20:45:30 +00005497The "mkimage" tool can also be used to create ramdisk images for use
5498with U-Boot, either separated from the Linux kernel image, or
5499combined into one file. "mkimage" encapsulates the images with a 64
5500byte header containing information about target architecture,
5501operating system, image type, compression method, entry points, time
5502stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00005503
wdenk6c59edc2004-05-03 20:45:30 +00005504"mkimage" can be called in two ways: to verify existing images and
5505print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00005506
wdenk6c59edc2004-05-03 20:45:30 +00005507In the first form (with "-l" option) mkimage lists the information
5508contained in the header of an existing U-Boot image; this includes
5509checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00005510
wdenk6c59edc2004-05-03 20:45:30 +00005511 tools/mkimage -l image
5512 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00005513
wdenk6c59edc2004-05-03 20:45:30 +00005514The second form (with "-d" option) is used to build a U-Boot image
5515from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00005516
wdenk6c59edc2004-05-03 20:45:30 +00005517 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5518 -n name -d data_file image
5519 -A ==> set architecture to 'arch'
5520 -O ==> set operating system to 'os'
5521 -T ==> set image type to 'type'
5522 -C ==> set compression type 'comp'
5523 -a ==> set load address to 'addr' (hex)
5524 -e ==> set entry point to 'ep' (hex)
5525 -n ==> set image name to 'name'
5526 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00005527
wdenkcd914452004-05-29 16:53:29 +00005528Right now, all Linux kernels for PowerPC systems use the same load
5529address (0x00000000), but the entry point address depends on the
5530kernel version:
wdenkc6097192002-11-03 00:24:07 +00005531
wdenk6c59edc2004-05-03 20:45:30 +00005532- 2.2.x kernels have the entry point at 0x0000000C,
5533- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00005534
wdenk6c59edc2004-05-03 20:45:30 +00005535So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00005536
wdenk6c59edc2004-05-03 20:45:30 +00005537 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5538 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005539 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk6c59edc2004-05-03 20:45:30 +00005540 > examples/uImage.TQM850L
5541 Image Name: 2.4.4 kernel for TQM850L
5542 Created: Wed Jul 19 02:34:59 2000
5543 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5544 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5545 Load Address: 0x00000000
5546 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005547
wdenk6c59edc2004-05-03 20:45:30 +00005548To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00005549
wdenk6c59edc2004-05-03 20:45:30 +00005550 -> tools/mkimage -l examples/uImage.TQM850L
5551 Image Name: 2.4.4 kernel for TQM850L
5552 Created: Wed Jul 19 02:34:59 2000
5553 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5554 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5555 Load Address: 0x00000000
5556 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005557
wdenk6c59edc2004-05-03 20:45:30 +00005558NOTE: for embedded systems where boot time is critical you can trade
5559speed for memory and install an UNCOMPRESSED image instead: this
5560needs more space in Flash, but boots much faster since it does not
5561need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00005562
Stefan Roese88fbf932010-04-15 16:07:28 +02005563 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk6c59edc2004-05-03 20:45:30 +00005564 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5565 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005566 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk6c59edc2004-05-03 20:45:30 +00005567 > examples/uImage.TQM850L-uncompressed
5568 Image Name: 2.4.4 kernel for TQM850L
5569 Created: Wed Jul 19 02:34:59 2000
5570 Image Type: PowerPC Linux Kernel Image (uncompressed)
5571 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5572 Load Address: 0x00000000
5573 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005574
wdenkc6097192002-11-03 00:24:07 +00005575
wdenk6c59edc2004-05-03 20:45:30 +00005576Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5577when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00005578
wdenk6c59edc2004-05-03 20:45:30 +00005579 -> tools/mkimage -n 'Simple Ramdisk Image' \
5580 > -A ppc -O linux -T ramdisk -C gzip \
5581 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5582 Image Name: Simple Ramdisk Image
5583 Created: Wed Jan 12 14:01:50 2000
5584 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5585 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5586 Load Address: 0x00000000
5587 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005588
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07005589The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5590option performs the converse operation of the mkimage's second form (the "-d"
5591option). Given an image built by mkimage, the dumpimage extracts a "data file"
5592from the image:
5593
5594 tools/dumpimage -i image -p position data_file
5595 -i ==> extract from the 'image' a specific 'data_file', \
5596 indexed by 'position'
5597
wdenkc6097192002-11-03 00:24:07 +00005598
wdenk6c59edc2004-05-03 20:45:30 +00005599Installing a Linux Image:
5600-------------------------
wdenkc6097192002-11-03 00:24:07 +00005601
wdenk6c59edc2004-05-03 20:45:30 +00005602To downloading a U-Boot image over the serial (console) interface,
5603you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00005604
wdenk6c59edc2004-05-03 20:45:30 +00005605 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00005606
wdenk6c59edc2004-05-03 20:45:30 +00005607The 'objcopy' does not understand the information in the U-Boot
5608image header, so the resulting S-Record file will be relative to
5609address 0x00000000. To load it to a given address, you need to
5610specify the target address as 'offset' parameter with the 'loads'
5611command.
wdenkc6097192002-11-03 00:24:07 +00005612
wdenk6c59edc2004-05-03 20:45:30 +00005613Example: install the image to address 0x40100000 (which on the
5614TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00005615
wdenk6c59edc2004-05-03 20:45:30 +00005616 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00005617
wdenk6c59edc2004-05-03 20:45:30 +00005618 .......... done
5619 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00005620
wdenk6c59edc2004-05-03 20:45:30 +00005621 => loads 40100000
5622 ## Ready for S-Record download ...
5623 ~>examples/image.srec
5624 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5625 ...
5626 15989 15990 15991 15992
5627 [file transfer complete]
5628 [connected]
5629 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005630
wdenkc6097192002-11-03 00:24:07 +00005631
wdenk6c59edc2004-05-03 20:45:30 +00005632You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005633this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00005634corruption happened:
wdenkc6097192002-11-03 00:24:07 +00005635
wdenk6c59edc2004-05-03 20:45:30 +00005636 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00005637
wdenk6c59edc2004-05-03 20:45:30 +00005638 ## Checking Image at 40100000 ...
5639 Image Name: 2.2.13 for initrd on TQM850L
5640 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5641 Data Size: 335725 Bytes = 327 kB = 0 MB
5642 Load Address: 00000000
5643 Entry Point: 0000000c
5644 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005645
5646
wdenk6c59edc2004-05-03 20:45:30 +00005647Boot Linux:
5648-----------
wdenkc6097192002-11-03 00:24:07 +00005649
wdenk6c59edc2004-05-03 20:45:30 +00005650The "bootm" command is used to boot an application that is stored in
5651memory (RAM or Flash). In case of a Linux kernel image, the contents
5652of the "bootargs" environment variable is passed to the kernel as
5653parameters. You can check and modify this variable using the
5654"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00005655
wdenkc6097192002-11-03 00:24:07 +00005656
wdenk6c59edc2004-05-03 20:45:30 +00005657 => printenv bootargs
5658 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00005659
wdenk6c59edc2004-05-03 20:45:30 +00005660 => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
wdenkc6097192002-11-03 00:24:07 +00005661
wdenk6c59edc2004-05-03 20:45:30 +00005662 => printenv bootargs
5663 bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
wdenkc6097192002-11-03 00:24:07 +00005664
wdenk6c59edc2004-05-03 20:45:30 +00005665 => bootm 40020000
5666 ## Booting Linux kernel at 40020000 ...
5667 Image Name: 2.2.13 for NFS on TQM850L
5668 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5669 Data Size: 381681 Bytes = 372 kB = 0 MB
5670 Load Address: 00000000
5671 Entry Point: 0000000c
5672 Verifying Checksum ... OK
5673 Uncompressing Kernel Image ... OK
5674 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
5675 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5676 time_init: decrementer frequency = 187500000/60
5677 Calibrating delay loop... 49.77 BogoMIPS
5678 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5679 ...
wdenkc6097192002-11-03 00:24:07 +00005680
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005681If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00005682the memory addresses of both the kernel and the initrd image (PPBCOOT
5683format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00005684
wdenk6c59edc2004-05-03 20:45:30 +00005685 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00005686
wdenk6c59edc2004-05-03 20:45:30 +00005687 ## Checking Image at 40100000 ...
5688 Image Name: 2.2.13 for initrd on TQM850L
5689 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5690 Data Size: 335725 Bytes = 327 kB = 0 MB
5691 Load Address: 00000000
5692 Entry Point: 0000000c
5693 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005694
wdenk6c59edc2004-05-03 20:45:30 +00005695 ## Checking Image at 40200000 ...
5696 Image Name: Simple Ramdisk Image
5697 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5698 Data Size: 566530 Bytes = 553 kB = 0 MB
5699 Load Address: 00000000
5700 Entry Point: 00000000
5701 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005702
wdenk6c59edc2004-05-03 20:45:30 +00005703 => bootm 40100000 40200000
5704 ## Booting Linux kernel at 40100000 ...
5705 Image Name: 2.2.13 for initrd on TQM850L
5706 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5707 Data Size: 335725 Bytes = 327 kB = 0 MB
5708 Load Address: 00000000
5709 Entry Point: 0000000c
5710 Verifying Checksum ... OK
5711 Uncompressing Kernel Image ... OK
5712 ## Loading RAMDisk Image at 40200000 ...
5713 Image Name: Simple Ramdisk Image
5714 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5715 Data Size: 566530 Bytes = 553 kB = 0 MB
5716 Load Address: 00000000
5717 Entry Point: 00000000
5718 Verifying Checksum ... OK
5719 Loading Ramdisk ... OK
5720 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
5721 Boot arguments: root=/dev/ram
5722 time_init: decrementer frequency = 187500000/60
5723 Calibrating delay loop... 49.77 BogoMIPS
5724 ...
5725 RAMDISK: Compressed image found at block 0
5726 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00005727
wdenk6c59edc2004-05-03 20:45:30 +00005728 bash#
wdenkc6097192002-11-03 00:24:07 +00005729
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005730Boot Linux and pass a flat device tree:
5731-----------
5732
5733First, U-Boot must be compiled with the appropriate defines. See the section
5734titled "Linux Kernel Interface" above for a more in depth explanation. The
5735following is an example of how to start a kernel and pass an updated
5736flat device tree:
5737
5738=> print oftaddr
5739oftaddr=0x300000
5740=> print oft
5741oft=oftrees/mpc8540ads.dtb
5742=> tftp $oftaddr $oft
5743Speed: 1000, full duplex
5744Using TSEC0 device
5745TFTP from server 192.168.1.1; our IP address is 192.168.1.101
5746Filename 'oftrees/mpc8540ads.dtb'.
5747Load address: 0x300000
5748Loading: #
5749done
5750Bytes transferred = 4106 (100a hex)
5751=> tftp $loadaddr $bootfile
5752Speed: 1000, full duplex
5753Using TSEC0 device
5754TFTP from server 192.168.1.1; our IP address is 192.168.1.2
5755Filename 'uImage'.
5756Load address: 0x200000
5757Loading:############
5758done
5759Bytes transferred = 1029407 (fb51f hex)
5760=> print loadaddr
5761loadaddr=200000
5762=> print oftaddr
5763oftaddr=0x300000
5764=> bootm $loadaddr - $oftaddr
5765## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01005766 Image Name: Linux-2.6.17-dirty
5767 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5768 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005769 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01005770 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005771 Verifying Checksum ... OK
5772 Uncompressing Kernel Image ... OK
5773Booting using flat device tree at 0x300000
5774Using MPC85xx ADS machine description
5775Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
5776[snip]
5777
5778
wdenk6c59edc2004-05-03 20:45:30 +00005779More About U-Boot Image Types:
5780------------------------------
wdenkc6097192002-11-03 00:24:07 +00005781
wdenk6c59edc2004-05-03 20:45:30 +00005782U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00005783
wdenk6c59edc2004-05-03 20:45:30 +00005784 "Standalone Programs" are directly runnable in the environment
5785 provided by U-Boot; it is expected that (if they behave
5786 well) you can continue to work in U-Boot after return from
5787 the Standalone Program.
5788 "OS Kernel Images" are usually images of some Embedded OS which
5789 will take over control completely. Usually these programs
5790 will install their own set of exception handlers, device
5791 drivers, set up the MMU, etc. - this means, that you cannot
5792 expect to re-enter U-Boot except by resetting the CPU.
5793 "RAMDisk Images" are more or less just data blocks, and their
5794 parameters (address, size) are passed to an OS kernel that is
5795 being started.
5796 "Multi-File Images" contain several images, typically an OS
5797 (Linux) kernel image and one or more data images like
5798 RAMDisks. This construct is useful for instance when you want
5799 to boot over the network using BOOTP etc., where the boot
5800 server provides just a single image file, but you want to get
5801 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00005802
wdenk6c59edc2004-05-03 20:45:30 +00005803 "Multi-File Images" start with a list of image sizes, each
5804 image size (in bytes) specified by an "uint32_t" in network
5805 byte order. This list is terminated by an "(uint32_t)0".
5806 Immediately after the terminating 0 follow the images, one by
5807 one, all aligned on "uint32_t" boundaries (size rounded up to
5808 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00005809
wdenk6c59edc2004-05-03 20:45:30 +00005810 "Firmware Images" are binary images containing firmware (like
5811 U-Boot or FPGA images) which usually will be programmed to
5812 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00005813
wdenk6c59edc2004-05-03 20:45:30 +00005814 "Script files" are command sequences that will be executed by
5815 U-Boot's command interpreter; this feature is especially
5816 useful when you configure U-Boot to use a real shell (hush)
5817 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00005818
Marek Vasutcf41a9b2012-03-14 21:52:45 +00005819Booting the Linux zImage:
5820-------------------------
5821
5822On some platforms, it's possible to boot Linux zImage. This is done
5823using the "bootz" command. The syntax of "bootz" command is the same
5824as the syntax of "bootm" command.
5825
Tom Rini45f46d12013-05-16 11:40:11 -04005826Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut28850d02012-03-18 11:47:58 +00005827kernel with raw initrd images. The syntax is slightly different, the
5828address of the initrd must be augmented by it's size, in the following
5829format: "<initrd addres>:<initrd size>".
5830
stroeseb9c17c52003-04-04 15:53:41 +00005831
wdenk6c59edc2004-05-03 20:45:30 +00005832Standalone HOWTO:
5833=================
stroeseb9c17c52003-04-04 15:53:41 +00005834
wdenk6c59edc2004-05-03 20:45:30 +00005835One of the features of U-Boot is that you can dynamically load and
5836run "standalone" applications, which can use some resources of
5837U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00005838
wdenk6c59edc2004-05-03 20:45:30 +00005839Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00005840
wdenk6c59edc2004-05-03 20:45:30 +00005841"Hello World" Demo:
5842-------------------
wdenkc6097192002-11-03 00:24:07 +00005843
wdenk6c59edc2004-05-03 20:45:30 +00005844'examples/hello_world.c' contains a small "Hello World" Demo
5845application; it is automatically compiled when you build U-Boot.
5846It's configured to run at address 0x00040004, so you can play with it
5847like that:
wdenkc6097192002-11-03 00:24:07 +00005848
wdenk6c59edc2004-05-03 20:45:30 +00005849 => loads
5850 ## Ready for S-Record download ...
5851 ~>examples/hello_world.srec
5852 1 2 3 4 5 6 7 8 9 10 11 ...
5853 [file transfer complete]
5854 [connected]
5855 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005856
wdenk6c59edc2004-05-03 20:45:30 +00005857 => go 40004 Hello World! This is a test.
5858 ## Starting application at 0x00040004 ...
5859 Hello World
5860 argc = 7
5861 argv[0] = "40004"
5862 argv[1] = "Hello"
5863 argv[2] = "World!"
5864 argv[3] = "This"
5865 argv[4] = "is"
5866 argv[5] = "a"
5867 argv[6] = "test."
5868 argv[7] = "<NULL>"
5869 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00005870
wdenk6c59edc2004-05-03 20:45:30 +00005871 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005872
wdenk6c59edc2004-05-03 20:45:30 +00005873Another example, which demonstrates how to register a CPM interrupt
5874handler with the U-Boot code, can be found in 'examples/timer.c'.
5875Here, a CPM timer is set up to generate an interrupt every second.
5876The interrupt service routine is trivial, just printing a '.'
5877character, but this is just a demo program. The application can be
5878controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00005879
wdenk6c59edc2004-05-03 20:45:30 +00005880 ? - print current values og the CPM Timer registers
5881 b - enable interrupts and start timer
5882 e - stop timer and disable interrupts
5883 q - quit application
wdenkc6097192002-11-03 00:24:07 +00005884
wdenk6c59edc2004-05-03 20:45:30 +00005885 => loads
5886 ## Ready for S-Record download ...
5887 ~>examples/timer.srec
5888 1 2 3 4 5 6 7 8 9 10 11 ...
5889 [file transfer complete]
5890 [connected]
5891 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005892
wdenk6c59edc2004-05-03 20:45:30 +00005893 => go 40004
5894 ## Starting application at 0x00040004 ...
5895 TIMERS=0xfff00980
5896 Using timer 1
5897 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00005898
wdenk6c59edc2004-05-03 20:45:30 +00005899Hit 'b':
5900 [q, b, e, ?] Set interval 1000000 us
5901 Enabling timer
5902Hit '?':
5903 [q, b, e, ?] ........
5904 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5905Hit '?':
5906 [q, b, e, ?] .
5907 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5908Hit '?':
5909 [q, b, e, ?] .
5910 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5911Hit '?':
5912 [q, b, e, ?] .
5913 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5914Hit 'e':
5915 [q, b, e, ?] ...Stopping timer
5916Hit 'q':
5917 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005918
wdenkc6097192002-11-03 00:24:07 +00005919
wdenk6c59edc2004-05-03 20:45:30 +00005920Minicom warning:
5921================
wdenkc6097192002-11-03 00:24:07 +00005922
wdenk6c59edc2004-05-03 20:45:30 +00005923Over time, many people have reported problems when trying to use the
5924"minicom" terminal emulation program for serial download. I (wd)
5925consider minicom to be broken, and recommend not to use it. Under
5926Unix, I recommend to use C-Kermit for general purpose use (and
5927especially for kermit binary protocol download ("loadb" command), and
Karl O. Pinca0189bb2012-10-01 05:11:56 +00005928use "cu" for S-Record download ("loads" command). See
5929http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5930for help with kermit.
5931
wdenkc6097192002-11-03 00:24:07 +00005932
wdenk6c59edc2004-05-03 20:45:30 +00005933Nevertheless, if you absolutely want to use it try adding this
5934configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00005935
wdenk6c59edc2004-05-03 20:45:30 +00005936 Name Program Name U/D FullScr IO-Red. Multi
5937 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
5938 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00005939
wdenk8dba0502003-03-31 16:34:49 +00005940
wdenk6c59edc2004-05-03 20:45:30 +00005941NetBSD Notes:
5942=============
wdenkc6097192002-11-03 00:24:07 +00005943
wdenk6c59edc2004-05-03 20:45:30 +00005944Starting at version 0.9.2, U-Boot supports NetBSD both as host
5945(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00005946
wdenk6c59edc2004-05-03 20:45:30 +00005947Building requires a cross environment; it is known to work on
5948NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5949need gmake since the Makefiles are not compatible with BSD make).
5950Note that the cross-powerpc package does not install include files;
5951attempting to build U-Boot will fail because <machine/ansi.h> is
5952missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00005953
wdenk6c59edc2004-05-03 20:45:30 +00005954 # cd /usr/pkg/cross/powerpc-netbsd/include
5955 # mkdir powerpc
5956 # ln -s powerpc machine
5957 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5958 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00005959
wdenk6c59edc2004-05-03 20:45:30 +00005960Native builds *don't* work due to incompatibilities between native
5961and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00005962
wdenk6c59edc2004-05-03 20:45:30 +00005963Booting assumes that (the first part of) the image booted is a
5964stage-2 loader which in turn loads and then invokes the kernel
5965proper. Loader sources will eventually appear in the NetBSD source
5966tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00005967meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00005968
wdenkc6097192002-11-03 00:24:07 +00005969
wdenk6c59edc2004-05-03 20:45:30 +00005970Implementation Internals:
5971=========================
wdenkc6097192002-11-03 00:24:07 +00005972
wdenk6c59edc2004-05-03 20:45:30 +00005973The following is not intended to be a complete description of every
5974implementation detail. However, it should help to understand the
5975inner workings of U-Boot and make it easier to port it to custom
5976hardware.
wdenkc6097192002-11-03 00:24:07 +00005977
wdenkc6097192002-11-03 00:24:07 +00005978
wdenk6c59edc2004-05-03 20:45:30 +00005979Initial Stack, Global Data:
5980---------------------------
wdenkc6097192002-11-03 00:24:07 +00005981
wdenk6c59edc2004-05-03 20:45:30 +00005982The implementation of U-Boot is complicated by the fact that U-Boot
5983starts running out of ROM (flash memory), usually without access to
5984system RAM (because the memory controller is not initialized yet).
5985This means that we don't have writable Data or BSS segments, and BSS
5986is not initialized as zero. To be able to get a C environment working
5987at all, we have to allocate at least a minimal stack. Implementation
5988options for this are defined and restricted by the CPU used: Some CPU
5989models provide on-chip memory (like the IMMR area on MPC8xx and
5990MPC826x processors), on others (parts of) the data cache can be
5991locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00005992
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005993 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005994 U-Boot mailing list:
wdenkc6097192002-11-03 00:24:07 +00005995
wdenk6c59edc2004-05-03 20:45:30 +00005996 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
5997 From: "Chris Hallinan" <clh@net1plus.com>
5998 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
5999 ...
wdenkc6097192002-11-03 00:24:07 +00006000
wdenk6c59edc2004-05-03 20:45:30 +00006001 Correct me if I'm wrong, folks, but the way I understand it
6002 is this: Using DCACHE as initial RAM for Stack, etc, does not
6003 require any physical RAM backing up the cache. The cleverness
6004 is that the cache is being used as a temporary supply of
6005 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006006 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00006007 can see how this works by studying the cache architecture and
6008 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00006009
wdenk6c59edc2004-05-03 20:45:30 +00006010 OCM is On Chip Memory, which I believe the 405GP has 4K. It
6011 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006012 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00006013 option should work for you. Using CS 4 should be fine if your
6014 board designers haven't used it for something that would
6015 cause you grief during the initial boot! It is frequently not
6016 used.
wdenkc6097192002-11-03 00:24:07 +00006017
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02006018 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00006019 with your processor/board/system design. The default value
6020 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02006021 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00006022 than your SDRAM module. If you have a 64MB SDRAM module, set
6023 it above 400_0000. Just make sure your board has no resources
6024 that are supposed to respond to that address! That code in
6025 start.S has been around a while and should work as is when
6026 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00006027
wdenk6c59edc2004-05-03 20:45:30 +00006028 -Chris Hallinan
6029 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00006030
wdenk6c59edc2004-05-03 20:45:30 +00006031It is essential to remember this, since it has some impact on the C
6032code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00006033
wdenk6c59edc2004-05-03 20:45:30 +00006034* Initialized global data (data segment) is read-only. Do not attempt
6035 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00006036
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006037* Do not use any uninitialized global data (or implicitely initialized
wdenk6c59edc2004-05-03 20:45:30 +00006038 as zero data - BSS segment) at all - this is undefined, initiali-
6039 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00006040
wdenk6c59edc2004-05-03 20:45:30 +00006041* Stack space is very limited. Avoid big data buffers or things like
6042 that.
wdenk4a5c8a72003-03-06 00:02:04 +00006043
wdenk6c59edc2004-05-03 20:45:30 +00006044Having only the stack as writable memory limits means we cannot use
6045normal global data to share information beween the code. But it
6046turned out that the implementation of U-Boot can be greatly
6047simplified by making a global data structure (gd_t) available to all
6048functions. We could pass a pointer to this data as argument to _all_
6049functions, but this would bloat the code. Instead we use a feature of
6050the GCC compiler (Global Register Variables) to share the data: we
6051place a pointer (gd) to the global data into a register which we
6052reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00006053
wdenk6c59edc2004-05-03 20:45:30 +00006054When choosing a register for such a purpose we are restricted by the
6055relevant (E)ABI specifications for the current architecture, and by
6056GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00006057
wdenk6c59edc2004-05-03 20:45:30 +00006058For PowerPC, the following registers have specific use:
6059 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01006060 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00006061 R3-R4: parameter passing and return values
6062 R5-R10: parameter passing
6063 R13: small data area pointer
6064 R30: GOT pointer
6065 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00006066
Joakim Tjernlund693c0c12010-01-19 14:41:58 +01006067 (U-Boot also uses R12 as internal GOT pointer. r12
6068 is a volatile register so r12 needs to be reset when
6069 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00006070
Wolfgang Denk69c09642008-02-14 22:43:22 +01006071 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00006072
wdenk6c59edc2004-05-03 20:45:30 +00006073 Note: on PPC, we could use a static initializer (since the
6074 address of the global data structure is known at compile time),
6075 but it turned out that reserving a register results in somewhat
6076 smaller code - although the code savings are not that big (on
6077 average for all boards 752 bytes for the whole U-Boot image,
6078 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00006079
Robin Getz2773d5f2009-08-17 15:23:02 +00006080On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger60f09302008-02-04 19:26:54 -05006081 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
6082
Robin Getz2773d5f2009-08-17 15:23:02 +00006083 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger60f09302008-02-04 19:26:54 -05006084
wdenk6c59edc2004-05-03 20:45:30 +00006085On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00006086
wdenk6c59edc2004-05-03 20:45:30 +00006087 R0: function argument word/integer result
6088 R1-R3: function argument word
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02006089 R9: platform specific
6090 R10: stack limit (used only if stack checking is enabled)
wdenk6c59edc2004-05-03 20:45:30 +00006091 R11: argument (frame) pointer
6092 R12: temporary workspace
6093 R13: stack pointer
6094 R14: link register
6095 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00006096
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02006097 ==> U-Boot will use R9 to hold a pointer to the global data
6098
6099 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00006100
Thomas Chou8fa38582010-05-21 11:08:03 +08006101On Nios II, the ABI is documented here:
6102 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
6103
6104 ==> U-Boot will use gp to hold a pointer to the global data
6105
6106 Note: on Nios II, we give "-G0" option to gcc and don't use gp
6107 to access small data sections, so gp is free.
6108
Macpaul Lin1cac36e2011-10-19 20:41:11 +00006109On NDS32, the following registers are used:
6110
6111 R0-R1: argument/return
6112 R2-R5: argument
6113 R15: temporary register for assembler
6114 R16: trampoline register
6115 R28: frame pointer (FP)
6116 R29: global pointer (GP)
6117 R30: link register (LP)
6118 R31: stack pointer (SP)
6119 PC: program counter (PC)
6120
6121 ==> U-Boot will use R10 to hold a pointer to the global data
6122
Wolfgang Denk6405a152006-03-31 18:32:53 +02006123NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
6124or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00006125
wdenk6c59edc2004-05-03 20:45:30 +00006126Memory Management:
6127------------------
wdenkc6097192002-11-03 00:24:07 +00006128
wdenk6c59edc2004-05-03 20:45:30 +00006129U-Boot runs in system state and uses physical addresses, i.e. the
6130MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00006131
wdenk6c59edc2004-05-03 20:45:30 +00006132The available memory is mapped to fixed addresses using the memory
6133controller. In this process, a contiguous block is formed for each
6134memory type (Flash, SDRAM, SRAM), even when it consists of several
6135physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00006136
wdenk6c59edc2004-05-03 20:45:30 +00006137U-Boot is installed in the first 128 kB of the first Flash bank (on
6138TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
6139booting and sizing and initializing DRAM, the code relocates itself
6140to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02006141memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00006142configuration setting]. Below that, a structure with global Board
6143Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00006144
wdenk6c59edc2004-05-03 20:45:30 +00006145Additionally, some exception handler code is copied to the low 8 kB
6146of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00006147
wdenk6c59edc2004-05-03 20:45:30 +00006148So a typical memory configuration with 16 MB of DRAM could look like
6149this:
wdenkc6097192002-11-03 00:24:07 +00006150
wdenk6c59edc2004-05-03 20:45:30 +00006151 0x0000 0000 Exception Vector code
6152 :
6153 0x0000 1FFF
6154 0x0000 2000 Free for Application Use
6155 :
6156 :
wdenkc6097192002-11-03 00:24:07 +00006157
wdenk6c59edc2004-05-03 20:45:30 +00006158 :
6159 :
6160 0x00FB FF20 Monitor Stack (Growing downward)
6161 0x00FB FFAC Board Info Data and permanent copy of global data
6162 0x00FC 0000 Malloc Arena
6163 :
6164 0x00FD FFFF
6165 0x00FE 0000 RAM Copy of Monitor Code
6166 ... eventually: LCD or video framebuffer
6167 ... eventually: pRAM (Protected RAM - unchanged by reset)
6168 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00006169
wdenkc6097192002-11-03 00:24:07 +00006170
wdenk6c59edc2004-05-03 20:45:30 +00006171System Initialization:
6172----------------------
wdenkc6097192002-11-03 00:24:07 +00006173
wdenk6c59edc2004-05-03 20:45:30 +00006174In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006175(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk6c59edc2004-05-03 20:45:30 +00006176configuration for CS0# this is a mirror of the onboard Flash memory.
6177To be able to re-map memory U-Boot then jumps to its link address.
6178To be able to implement the initialization code in C, a (small!)
6179initial stack is set up in the internal Dual Ported RAM (in case CPUs
6180which provide such a feature like MPC8xx or MPC8260), or in a locked
6181part of the data cache. After that, U-Boot initializes the CPU core,
6182the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00006183
wdenk6c59edc2004-05-03 20:45:30 +00006184Next, all (potentially) available memory banks are mapped using a
6185preliminary mapping. For example, we put them on 512 MB boundaries
6186(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
6187on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
6188programmed for SDRAM access. Using the temporary configuration, a
6189simple memory test is run that determines the size of the SDRAM
6190banks.
wdenkc6097192002-11-03 00:24:07 +00006191
wdenk6c59edc2004-05-03 20:45:30 +00006192When there is more than one SDRAM bank, and the banks are of
6193different size, the largest is mapped first. For equal size, the first
6194bank (CS2#) is mapped first. The first mapping is always for address
61950x00000000, with any additional banks following immediately to create
6196contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00006197
wdenk6c59edc2004-05-03 20:45:30 +00006198Then, the monitor installs itself at the upper end of the SDRAM area
6199and allocates memory for use by malloc() and for the global Board
6200Info data; also, the exception vector code is copied to the low RAM
6201pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00006202
wdenk6c59edc2004-05-03 20:45:30 +00006203Only after this relocation will you have a "normal" C environment;
6204until that you are restricted in several ways, mostly because you are
6205running from ROM, and because the code will have to be relocated to a
6206new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00006207
wdenkc6097192002-11-03 00:24:07 +00006208
wdenk6c59edc2004-05-03 20:45:30 +00006209U-Boot Porting Guide:
6210----------------------
wdenkc6097192002-11-03 00:24:07 +00006211
wdenk6c59edc2004-05-03 20:45:30 +00006212[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
6213list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00006214
wdenkc6097192002-11-03 00:24:07 +00006215
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006216int main(int argc, char *argv[])
wdenk6c59edc2004-05-03 20:45:30 +00006217{
6218 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00006219
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006220 signal(SIGALRM, no_more_time);
6221 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00006222
wdenk6c59edc2004-05-03 20:45:30 +00006223 if (available_money > available_manpower) {
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006224 Pay consultant to port U-Boot;
wdenk6c59edc2004-05-03 20:45:30 +00006225 return 0;
6226 }
wdenkc6097192002-11-03 00:24:07 +00006227
wdenk6c59edc2004-05-03 20:45:30 +00006228 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00006229
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006230 Subscribe to u-boot mailing list;
wdenkc6097192002-11-03 00:24:07 +00006231
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006232 if (clueless)
6233 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00006234
wdenk6c59edc2004-05-03 20:45:30 +00006235 while (learning) {
6236 Read the README file in the top level directory;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006237 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
6238 Read applicable doc/*.README;
wdenk6c59edc2004-05-03 20:45:30 +00006239 Read the source, Luke;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006240 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk6c59edc2004-05-03 20:45:30 +00006241 }
wdenkc6097192002-11-03 00:24:07 +00006242
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006243 if (available_money > toLocalCurrency ($2500))
6244 Buy a BDI3000;
6245 else
wdenk6c59edc2004-05-03 20:45:30 +00006246 Add a lot of aggravation and time;
wdenkc6097192002-11-03 00:24:07 +00006247
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006248 if (a similar board exists) { /* hopefully... */
6249 cp -a board/<similar> board/<myboard>
6250 cp include/configs/<similar>.h include/configs/<myboard>.h
6251 } else {
6252 Create your own board support subdirectory;
6253 Create your own board include/configs/<myboard>.h file;
6254 }
6255 Edit new board/<myboard> files
6256 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00006257
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006258 while (!accepted) {
6259 while (!running) {
6260 do {
6261 Add / modify source code;
6262 } until (compiles);
6263 Debug;
6264 if (clueless)
6265 email("Hi, I am having problems...");
6266 }
6267 Send patch file to the U-Boot email list;
6268 if (reasonable critiques)
6269 Incorporate improvements from email list code review;
6270 else
6271 Defend code as written;
wdenk634d2f72004-04-15 23:14:49 +00006272 }
wdenkc6097192002-11-03 00:24:07 +00006273
wdenk6c59edc2004-05-03 20:45:30 +00006274 return 0;
6275}
wdenkc6097192002-11-03 00:24:07 +00006276
wdenk6c59edc2004-05-03 20:45:30 +00006277void no_more_time (int sig)
6278{
6279 hire_a_guru();
6280}
wdenkc6097192002-11-03 00:24:07 +00006281
wdenkc6097192002-11-03 00:24:07 +00006282
wdenk6c59edc2004-05-03 20:45:30 +00006283Coding Standards:
6284-----------------
wdenkc6097192002-11-03 00:24:07 +00006285
wdenk6c59edc2004-05-03 20:45:30 +00006286All contributions to U-Boot should conform to the Linux kernel
Detlev Zundelaa63d482006-09-01 15:39:02 +02006287coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006288"scripts/Lindent" in your Linux kernel source directory.
Detlev Zundelaa63d482006-09-01 15:39:02 +02006289
6290Source files originating from a different project (for example the
6291MTD subsystem) are generally exempt from these guidelines and are not
6292reformated to ease subsequent migration to newer versions of those
6293sources.
wdenkc6097192002-11-03 00:24:07 +00006294
Detlev Zundelaa63d482006-09-01 15:39:02 +02006295Please note that U-Boot is implemented in C (and to some small parts in
6296Assembler); no C++ is used, so please do not use C++ style comments (//)
6297in your code.
wdenkad276f22004-01-04 16:28:35 +00006298
wdenk6c59edc2004-05-03 20:45:30 +00006299Please also stick to the following formatting rules:
6300- remove any trailing white space
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006301- use TAB characters for indentation and vertical alignment, not spaces
wdenk6c59edc2004-05-03 20:45:30 +00006302- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006303- do not add more than 2 consecutive empty lines to source files
wdenk6c59edc2004-05-03 20:45:30 +00006304- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00006305
wdenk6c59edc2004-05-03 20:45:30 +00006306Submissions which do not conform to the standards may be returned
6307with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00006308
wdenkc6097192002-11-03 00:24:07 +00006309
wdenk6c59edc2004-05-03 20:45:30 +00006310Submitting Patches:
6311-------------------
wdenkc6097192002-11-03 00:24:07 +00006312
wdenk6c59edc2004-05-03 20:45:30 +00006313Since the number of patches for U-Boot is growing, we need to
6314establish some rules. Submissions which do not conform to these rules
6315may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00006316
Magnus Liljaf3b287b2008-08-06 19:32:33 +02006317Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006318
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006319Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
6320see http://lists.denx.de/mailman/listinfo/u-boot
6321
wdenk6c59edc2004-05-03 20:45:30 +00006322When you send a patch, please include the following information with
6323it:
wdenkc6097192002-11-03 00:24:07 +00006324
wdenk6c59edc2004-05-03 20:45:30 +00006325* For bug fixes: a description of the bug and how your patch fixes
6326 this bug. Please try to include a way of demonstrating that the
6327 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00006328
wdenk6c59edc2004-05-03 20:45:30 +00006329* For new features: a description of the feature and your
6330 implementation.
wdenkc6097192002-11-03 00:24:07 +00006331
wdenk6c59edc2004-05-03 20:45:30 +00006332* A CHANGELOG entry as plaintext (separate from the patch)
wdenkc6097192002-11-03 00:24:07 +00006333
wdenk6c59edc2004-05-03 20:45:30 +00006334* For major contributions, your entry to the CREDITS file
wdenkc6097192002-11-03 00:24:07 +00006335
Albert ARIBAUD48e910f2013-09-11 15:52:51 +02006336* When you add support for a new board, don't forget to add a
6337 maintainer e-mail address to the boards.cfg file, too.
wdenkc6097192002-11-03 00:24:07 +00006338
wdenk6c59edc2004-05-03 20:45:30 +00006339* If your patch adds new configuration options, don't forget to
6340 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00006341
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006342* The patch itself. If you are using git (which is *strongly*
6343 recommended) you can easily generate the patch using the
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006344 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006345 the U-Boot mailing list, you will avoid most of the common problems
6346 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00006347
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006348 If you cannot use git, use "diff -purN OLD NEW". If your version of
6349 diff does not support these options, then get the latest version of
6350 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00006351
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006352 The current directory when running this command shall be the parent
6353 directory of the U-Boot source tree (i. e. please make sure that
6354 your patch includes sufficient directory information for the
6355 affected files).
6356
6357 We prefer patches as plain text. MIME attachments are discouraged,
6358 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00006359
wdenk6c59edc2004-05-03 20:45:30 +00006360* If one logical set of modifications affects or creates several
6361 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00006362
wdenk6c59edc2004-05-03 20:45:30 +00006363* Changesets that contain different, unrelated modifications shall be
6364 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00006365
wdenkc6097192002-11-03 00:24:07 +00006366
wdenk6c59edc2004-05-03 20:45:30 +00006367Notes:
wdenkc6097192002-11-03 00:24:07 +00006368
wdenk6c59edc2004-05-03 20:45:30 +00006369* Before sending the patch, run the MAKEALL script on your patched
6370 source tree and make sure that no errors or warnings are reported
6371 for any of the boards.
6372
6373* Keep your modifications to the necessary minimum: A patch
6374 containing several unrelated changes or arbitrary reformats will be
6375 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00006376
wdenk6c59edc2004-05-03 20:45:30 +00006377* If you modify existing code, make sure that your new code does not
6378 add to the memory footprint of the code ;-) Small is beautiful!
6379 When adding new features, these should compile conditionally only
6380 (using #ifdef), and the resulting code with the new feature
6381 disabled must not need more memory than the old code without your
6382 modification.
wdenkcbc49a52005-05-03 14:12:25 +00006383
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006384* Remember that there is a size limit of 100 kB per message on the
6385 u-boot mailing list. Bigger patches will be moderated. If they are
6386 reasonable and not too big, they will be acknowledged. But patches
6387 bigger than the size limit should be avoided.