blob: 276869a3d8967dbfa495ee29672da67559fd559f [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
Holger Freyther7ba4e572014-08-04 09:26:05 +0200255configurations available; just type "make <board_name>_defconfig".
wdenkc6097192002-11-03 00:24:07 +0000256
257Example: For a TQM823L module type:
258
259 cd u-boot
Holger Freyther7ba4e572014-08-04 09:26:05 +0200260 make TQM823L_defconfig
wdenkc6097192002-11-03 00:24:07 +0000261
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200262For the Cogent platform, you need to specify the CPU type as well;
Holger Freyther7ba4e572014-08-04 09:26:05 +0200263e.g. "make cogent_mpc8xx_defconfig". And also configure the cogent
wdenkc6097192002-11-03 00:24:07 +0000264directory 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
Jagannadha Sutradharudu Teki287314f2014-08-31 21:19:43 +0530275See board/sandbox/README.sandbox for more details.
Simon Glass53552c92014-03-22 17:12:59 -0600276
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
Tom Rini5ce62cd2014-08-14 06:42:36 -0400962 CONFIG_CMD_BOOTI * ARM64 Linux kernel Image support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500963 CONFIG_CMD_CACHE * icache, dcache
Michal Simeka0d28022013-11-21 13:39:02 -0800964 CONFIG_CMD_CLK * clock command support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500965 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger321ab9e2010-12-21 14:19:51 -0500966 CONFIG_CMD_CRC32 * crc32
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500967 CONFIG_CMD_DATE * support for RTC, date/time...
968 CONFIG_CMD_DHCP * DHCP support
969 CONFIG_CMD_DIAG * Diagnostics
Peter Tyser15258042008-12-17 16:36:22 -0600970 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
971 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
972 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
973 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500974 CONFIG_CMD_DTT * Digital Therm and Thermostat
975 CONFIG_CMD_ECHO echo arguments
Peter Tyser0deafa22009-10-25 15:12:56 -0500976 CONFIG_CMD_EDITENV edit env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500977 CONFIG_CMD_EEPROM * EEPROM read/write support
978 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger1b0d5512012-12-11 22:16:25 -0600979 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergera2d62b72012-12-11 22:16:33 -0600980 CONFIG_CMD_ENV_FLAGS * display details about env flags
Andrew Ruder94463402013-10-22 19:07:34 -0500981 CONFIG_CMD_ENV_EXISTS * check existence of env variable
Mike Frysingerf3ddf202010-12-26 23:09:45 -0500982 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren4f8662d2012-10-22 06:43:50 +0000983 CONFIG_CMD_EXT2 * ext2 command support
984 CONFIG_CMD_EXT4 * ext4 command support
Stephen Warren3d5a3882014-01-24 20:46:37 -0700985 CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls)
986 that work for multiple fs types
Mike Frysinger78dcaf42009-01-28 19:08:14 -0500987 CONFIG_CMD_SAVEENV saveenv
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500988 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren4f8662d2012-10-22 06:43:50 +0000989 CONFIG_CMD_FAT * FAT command support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500990 CONFIG_CMD_FLASH flinfo, erase, protect
991 CONFIG_CMD_FPGA FPGA device initialization support
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200992 CONFIG_CMD_FUSE * Device fuse support
Anton Staafd1390c82012-12-05 14:46:29 +0000993 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysinger2ed02412010-12-26 23:32:22 -0500994 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsf0c9d532011-04-05 07:15:14 +0000995 CONFIG_CMD_GREPENV * search environment
Simon Glass058bb8d2012-12-05 14:46:38 +0000996 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500997 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
998 CONFIG_CMD_I2C * I2C serial bus support
999 CONFIG_CMD_IDE * IDE harddisk support
1000 CONFIG_CMD_IMI iminfo
Vipin Kumar3df41b12012-12-16 22:32:48 +00001001 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001002 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001003 CONFIG_CMD_IMMAP * IMMR dump support
Simon Glass4dc47ca2014-06-11 23:29:41 -06001004 CONFIG_CMD_IOTRACE * I/O tracing for debugging
Mike Frysingerf3ddf202010-12-26 23:09:45 -05001005 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershberger0fd32d72012-10-03 11:15:51 +00001006 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001007 CONFIG_CMD_IRQ * irqinfo
1008 CONFIG_CMD_ITEST Integer/string test of 2 values
1009 CONFIG_CMD_JFFS2 * JFFS2 Support
1010 CONFIG_CMD_KGDB * kgdb
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001011 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00001012 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
1013 (169.254.*.*)
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001014 CONFIG_CMD_LOADB loadb
1015 CONFIG_CMD_LOADS loads
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001016 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz93d6cb02009-07-27 00:07:59 -04001017 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glasseacd14f2012-11-30 13:01:20 +00001018 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001019 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denk9d009282013-03-08 10:51:32 +00001020 loop, loopw
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001021 CONFIG_CMD_MEMTEST * mtest
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001022 CONFIG_CMD_MISC Misc functions like sleep etc
1023 CONFIG_CMD_MMC * MMC memory mapped support
1024 CONFIG_CMD_MII * MII utility commands
Stefan Roeseb1423dd2009-03-19 13:30:36 +01001025 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001026 CONFIG_CMD_NAND * NAND support
1027 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001028 CONFIG_CMD_NFS NFS support
Peter Tyser9902e422008-12-17 16:36:21 -06001029 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denk092ae952011-10-26 10:21:21 +00001030 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001031 CONFIG_CMD_PCI * pciinfo
1032 CONFIG_CMD_PCMCIA * PCMCIA support
1033 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
1034 host
1035 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersc889fb42012-12-05 14:46:30 +00001036 CONFIG_CMD_READ * Read raw data from partition
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001037 CONFIG_CMD_REGINFO * Register dump
1038 CONFIG_CMD_RUN run command in env variable
Simon Glassbf6ce792012-12-26 09:53:36 +00001039 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001040 CONFIG_CMD_SAVES * save S record dump
1041 CONFIG_CMD_SCSI * SCSI Support
1042 CONFIG_CMD_SDRAM * print SDRAM configuration information
1043 (requires CONFIG_CMD_I2C)
1044 CONFIG_CMD_SETGETDCR Support for DCR Register access
1045 (4xx only)
Eric Nelson97f5f8f2012-01-31 10:52:08 -07001046 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001047 CONFIG_CMD_SHA1SUM * print sha1 memory digest
Robin Getz93d6cb02009-07-27 00:07:59 -04001048 (requires CONFIG_CMD_MEMORY)
Bob Liua671b702013-02-05 19:05:41 +08001049 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk85c25df2009-04-01 23:34:12 +02001050 CONFIG_CMD_SOURCE "source" command Support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001051 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7aa81a42011-05-17 00:03:40 +00001052 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass6a398d22011-10-24 18:00:07 +00001053 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershberger59f3f522012-10-03 12:14:57 +00001054 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
1055 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001056 CONFIG_CMD_USB * USB support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001057 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasut71729392012-03-31 07:47:16 +00001058 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001059 CONFIG_CMD_XIMG Load part of Multi Image
Przemyslaw Marczak2eb40ee2014-04-02 10:20:05 +02001060 CONFIG_CMD_UUID * Generate random UUID or GUID string
wdenkc6097192002-11-03 00:24:07 +00001061
1062 EXAMPLE: If you want all functions except of network
1063 support you can write:
1064
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001065 #include "config_cmd_all.h"
1066 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +00001067
Gerald Van Barend6abef42007-03-31 12:23:51 -04001068 Other Commands:
1069 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +00001070
1071 Note: Don't enable the "icache" and "dcache" commands
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001072 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk4a5c8a72003-03-06 00:02:04 +00001073 what you (and your U-Boot users) are doing. Data
1074 cache cannot be enabled on systems like the 8xx or
1075 8260 (where accesses to the IMMR region must be
1076 uncached), and it cannot be disabled on all other
1077 systems where we (mis-) use the data cache to hold an
1078 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +00001079
1080
1081 XXX - this list needs to get updated!
1082
Wolfgang Denk2aceea12013-03-23 23:50:31 +00001083- Regular expression support:
1084 CONFIG_REGEX
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001085 If this variable is defined, U-Boot is linked against
1086 the SLRE (Super Light Regular Expression) library,
1087 which adds regex support to some commands, as for
1088 example "env grep" and "setexpr".
Wolfgang Denk2aceea12013-03-23 23:50:31 +00001089
Simon Glass3d686442011-10-15 05:48:20 +00001090- Device tree:
1091 CONFIG_OF_CONTROL
1092 If this variable is defined, U-Boot will use a device tree
1093 to configure its devices, instead of relying on statically
1094 compiled #defines in the board file. This option is
1095 experimental and only available on a few boards. The device
1096 tree is available in the global data as gd->fdt_blob.
1097
Simon Glass5cb34db2011-10-24 19:15:31 +00001098 U-Boot needs to get its device tree from somewhere. This can
1099 be done using one of the two options below:
Simon Glass38d6b8d2011-10-15 05:48:21 +00001100
1101 CONFIG_OF_EMBED
1102 If this variable is defined, U-Boot will embed a device tree
1103 binary in its image. This device tree file should be in the
1104 board directory and called <soc>-<board>.dts. The binary file
1105 is then picked up in board_init_f() and made available through
1106 the global data structure as gd->blob.
Simon Glass3d686442011-10-15 05:48:20 +00001107
Simon Glass5cb34db2011-10-24 19:15:31 +00001108 CONFIG_OF_SEPARATE
1109 If this variable is defined, U-Boot will build a device tree
1110 binary. It will be called u-boot.dtb. Architecture-specific
1111 code will locate it at run-time. Generally this works by:
1112
1113 cat u-boot.bin u-boot.dtb >image.bin
1114
1115 and in fact, U-Boot does this for you, creating a file called
1116 u-boot-dtb.bin which is useful in the common case. You can
1117 still use the individual files if you need something more
1118 exotic.
1119
wdenkc6097192002-11-03 00:24:07 +00001120- Watchdog:
1121 CONFIG_WATCHDOG
1122 If this variable is defined, it enables watchdog
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +00001123 support for the SoC. There must be support in the SoC
1124 specific code for a watchdog. For the 8xx and 8260
1125 CPUs, the SIU Watchdog feature is enabled in the SYPCR
1126 register. When supported for a specific SoC is
1127 available, then no further board specific code should
1128 be needed to use it.
1129
1130 CONFIG_HW_WATCHDOG
1131 When using a watchdog circuitry external to the used
1132 SoC, then define this variable and provide board
1133 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +00001134
stroeseb9c17c52003-04-04 15:53:41 +00001135- U-Boot Version:
1136 CONFIG_VERSION_VARIABLE
1137 If this variable is defined, an environment variable
1138 named "ver" is created by U-Boot showing the U-Boot
1139 version as printed by the "version" command.
Benoît Thébaudeauce9a1552012-08-13 15:01:14 +02001140 Any change to this variable will be reverted at the
1141 next reset.
stroeseb9c17c52003-04-04 15:53:41 +00001142
wdenkc6097192002-11-03 00:24:07 +00001143- Real-Time Clock:
1144
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001145 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +00001146 has to be selected, too. Define exactly one of the
1147 following options:
1148
1149 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1150 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam3f8d1782011-10-24 06:44:15 +00001151 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001152 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1fe2c702003-03-06 21:55:29 +00001153 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001154 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk0893c472003-05-20 14:25:27 +00001155 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel90491f22014-07-21 11:06:16 +02001156 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenkef5fe752003-03-12 10:41:04 +00001157 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krillb27939b2008-03-15 15:40:26 +01001158 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenkaeba06f2004-06-09 17:34:58 +00001159 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001160 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher1f1b7012011-03-28 09:24:22 +02001161 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1162 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001163
wdenkb9bbd242003-06-30 16:24:52 +00001164 Note that if the RTC uses I2C, then the I2C interface
1165 must also be configured. See I2C Support, below.
1166
Peter Tyser9902e422008-12-17 16:36:21 -06001167- GPIO Support:
1168 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tyser9902e422008-12-17 16:36:21 -06001169
Chris Packham9b383202010-12-19 10:12:13 +00001170 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1171 chip-ngpio pairs that tell the PCA953X driver the number of
1172 pins supported by a particular chip.
1173
Peter Tyser9902e422008-12-17 16:36:21 -06001174 Note that if the GPIO device uses I2C, then the I2C interface
1175 must also be configured. See I2C Support, below.
1176
Simon Glass4dc47ca2014-06-11 23:29:41 -06001177- I/O tracing:
1178 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
1179 accesses and can checksum them or write a list of them out
1180 to memory. See the 'iotrace' command for details. This is
1181 useful for testing device drivers since it can confirm that
1182 the driver behaves the same way before and after a code
1183 change. Currently this is supported on sandbox and arm. To
1184 add support for your architecture, add '#include <iotrace.h>'
1185 to the bottom of arch/<arch>/include/asm/io.h and test.
1186
1187 Example output from the 'iotrace stats' command is below.
1188 Note that if the trace buffer is exhausted, the checksum will
1189 still continue to operate.
1190
1191 iotrace is enabled
1192 Start: 10000000 (buffer start address)
1193 Size: 00010000 (buffer size)
1194 Offset: 00000120 (current buffer offset)
1195 Output: 10000120 (start + offset)
1196 Count: 00000018 (number of trace records)
1197 CRC32: 9526fb66 (CRC32 of all trace records)
1198
wdenkc6097192002-11-03 00:24:07 +00001199- Timestamp Support:
1200
wdenk4a5c8a72003-03-06 00:02:04 +00001201 When CONFIG_TIMESTAMP is selected, the timestamp
1202 (date and time) of an image is printed by image
1203 commands like bootm or iminfo. This option is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001204 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001205
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001206- Partition Labels (disklabels) Supported:
1207 Zero or more of the following:
1208 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1209 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1210 Intel architecture, USB sticks, etc.
1211 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1212 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1213 bootloader. Note 2TB partition limit; see
1214 disk/part_efi.c
1215 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001216
Wolfgang Denkb240aef2008-03-26 10:40:12 +01001217 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1218 CONFIG_CMD_SCSI) you must configure support for at
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001219 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001220
1221- IDE Reset method:
wdenk369d43d2004-03-14 14:09:05 +00001222 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1223 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001224
wdenk369d43d2004-03-14 14:09:05 +00001225 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1226 be performed by calling the function
1227 ide_set_reset(int reset)
1228 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001229
1230- ATAPI Support:
1231 CONFIG_ATAPI
1232
1233 Set this to enable ATAPI support.
1234
wdenkf602aa02004-03-13 23:29:43 +00001235- LBA48 Support
1236 CONFIG_LBA48
1237
1238 Set this to enable support for disks larger than 137GB
Heiko Schocher0f602e12009-12-03 11:21:21 +01001239 Also look at CONFIG_SYS_64BIT_LBA.
wdenkf602aa02004-03-13 23:29:43 +00001240 Whithout these , LBA48 support uses 32bit variables and will 'only'
1241 support disks up to 2.1TB.
1242
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001243 CONFIG_SYS_64BIT_LBA:
wdenkf602aa02004-03-13 23:29:43 +00001244 When enabled, makes the IDE subsystem use 64bit sector addresses.
1245 Default is 32bit.
1246
wdenkc6097192002-11-03 00:24:07 +00001247- SCSI Support:
1248 At the moment only there is only support for the
1249 SYM53C8XX SCSI controller; define
1250 CONFIG_SCSI_SYM53C8XX to enable it.
1251
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001252 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1253 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1254 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001255 maximum numbers of LUNs, SCSI ID's and target
1256 devices.
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001257 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001258
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001259 The environment variable 'scsidevs' is set to the number of
1260 SCSI devices found during the last scan.
Stefan Reinauere50a10e2012-10-29 05:23:48 +00001261
wdenkc6097192002-11-03 00:24:07 +00001262- NETWORK Support (PCI):
wdenk4e112c12003-06-03 23:54:09 +00001263 CONFIG_E1000
Kyle Moffett64b94dd2011-10-18 11:05:29 +00001264 Support for Intel 8254x/8257x gigabit chips.
1265
1266 CONFIG_E1000_SPI
1267 Utility code for direct access to the SPI bus on Intel 8257x.
1268 This does not do anything useful unless you set at least one
1269 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1270
1271 CONFIG_E1000_SPI_GENERIC
1272 Allow generic access to the SPI bus on the Intel 8257x, for
1273 example with the "sspi" command.
1274
1275 CONFIG_CMD_E1000
1276 Management command for E1000 devices. When used on devices
1277 with SPI support you can reprogram the EEPROM from U-Boot.
stroese94ef1cf2003-06-05 15:39:44 +00001278
Andre Schwarz68c2a302008-03-06 16:45:44 +01001279 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001280 default MAC for empty EEPROM after production.
Andre Schwarz68c2a302008-03-06 16:45:44 +01001281
wdenkc6097192002-11-03 00:24:07 +00001282 CONFIG_EEPRO100
1283 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001284 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001285 write routine for first time initialisation.
1286
1287 CONFIG_TULIP
1288 Support for Digital 2114x chips.
1289 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1290 modem chip initialisation (KS8761/QS6611).
1291
1292 CONFIG_NATSEMI
1293 Support for National dp83815 chips.
1294
1295 CONFIG_NS8382X
1296 Support for National dp8382[01] gigabit chips.
1297
wdenkaa603362003-05-12 21:50:16 +00001298- NETWORK Support (other):
1299
Jens Scharsigdab7cb82010-01-23 12:03:45 +01001300 CONFIG_DRIVER_AT91EMAC
1301 Support for AT91RM9200 EMAC.
1302
1303 CONFIG_RMII
1304 Define this to use reduced MII inteface
1305
1306 CONFIG_DRIVER_AT91EMAC_QUIET
1307 If this defined, the driver is quiet.
1308 The driver doen't show link status messages.
1309
Rob Herringc9830dc2011-12-15 11:15:49 +00001310 CONFIG_CALXEDA_XGMAC
1311 Support for the Calxeda XGMAC device
1312
Ashok93fb8722012-10-15 06:20:47 +00001313 CONFIG_LAN91C96
wdenkaa603362003-05-12 21:50:16 +00001314 Support for SMSC's LAN91C96 chips.
1315
1316 CONFIG_LAN91C96_BASE
1317 Define this to hold the physical address
1318 of the LAN91C96's I/O space
1319
1320 CONFIG_LAN91C96_USE_32_BIT
1321 Define this to enable 32 bit addressing
1322
Ashok93fb8722012-10-15 06:20:47 +00001323 CONFIG_SMC91111
wdenk3c711762004-06-09 13:37:52 +00001324 Support for SMSC's LAN91C111 chip
1325
1326 CONFIG_SMC91111_BASE
1327 Define this to hold the physical address
1328 of the device (I/O space)
1329
1330 CONFIG_SMC_USE_32_BIT
1331 Define this if data bus is 32 bits
1332
1333 CONFIG_SMC_USE_IOFUNCS
1334 Define this to use i/o functions instead of macros
1335 (some hardware wont work with macros)
1336
Heiko Schocher7d037f72011-11-15 10:00:04 -05001337 CONFIG_DRIVER_TI_EMAC
1338 Support for davinci emac
1339
1340 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1341 Define this if you have more then 3 PHYs.
1342
Macpaul Lin199c6252010-12-21 16:59:46 +08001343 CONFIG_FTGMAC100
1344 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1345
1346 CONFIG_FTGMAC100_EGIGA
1347 Define this to use GE link update with gigabit PHY.
1348 Define this if FTGMAC100 is connected to gigabit PHY.
1349 If your system has 10/100 PHY only, it might not occur
1350 wrong behavior. Because PHY usually return timeout or
1351 useless data when polling gigabit status and gigabit
1352 control registers. This behavior won't affect the
1353 correctnessof 10/100 link speed update.
1354
Mike Rapoportf4761af2009-11-11 10:03:03 +02001355 CONFIG_SMC911X
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001356 Support for SMSC's LAN911x and LAN921x chips
1357
Mike Rapoportf4761af2009-11-11 10:03:03 +02001358 CONFIG_SMC911X_BASE
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001359 Define this to hold the physical address
1360 of the device (I/O space)
1361
Mike Rapoportf4761af2009-11-11 10:03:03 +02001362 CONFIG_SMC911X_32_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001363 Define this if data bus is 32 bits
1364
Mike Rapoportf4761af2009-11-11 10:03:03 +02001365 CONFIG_SMC911X_16_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001366 Define this if data bus is 16 bits. If your processor
1367 automatically converts one 32 bit word to two 16 bit
Mike Rapoportf4761af2009-11-11 10:03:03 +02001368 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001369
Yoshihiro Shimodaed4cea02011-01-27 10:06:03 +09001370 CONFIG_SH_ETHER
1371 Support for Renesas on-chip Ethernet controller
1372
1373 CONFIG_SH_ETHER_USE_PORT
1374 Define the number of ports to be used
1375
1376 CONFIG_SH_ETHER_PHY_ADDR
1377 Define the ETH PHY's address
1378
Yoshihiro Shimoda281aa052011-01-27 10:06:08 +09001379 CONFIG_SH_ETHER_CACHE_WRITEBACK
1380 If this option is set, the driver enables cache flush.
1381
Heiko Schocher2b387762014-07-18 06:07:19 +02001382- PWM Support:
1383 CONFIG_PWM_IMX
1384 Support for PWM modul on the imx6.
1385
Vadim Bendeburydac69642011-10-17 08:36:14 +00001386- TPM Support:
Che-liang Chiouacea5702013-04-12 11:04:34 +00001387 CONFIG_TPM
1388 Support TPM devices.
1389
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001390 CONFIG_TPM_TIS_I2C
1391 Support for i2c bus TPM devices. Only one device
1392 per system is supported at this time.
1393
1394 CONFIG_TPM_TIS_I2C_BUS_NUMBER
1395 Define the the i2c bus number for the TPM device
1396
1397 CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
1398 Define the TPM's address on the i2c bus
1399
1400 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1401 Define the burst count bytes upper limit
1402
Dirk Eibach20489092013-06-26 15:55:15 +02001403 CONFIG_TPM_ATMEL_TWI
1404 Support for Atmel TWI TPM device. Requires I2C support.
1405
Che-liang Chiouacea5702013-04-12 11:04:34 +00001406 CONFIG_TPM_TIS_LPC
Vadim Bendeburydac69642011-10-17 08:36:14 +00001407 Support for generic parallel port TPM devices. Only one device
1408 per system is supported at this time.
1409
1410 CONFIG_TPM_TIS_BASE_ADDRESS
1411 Base address where the generic TPM device is mapped
1412 to. Contemporary x86 systems usually map it at
1413 0xfed40000.
1414
Reinhard Pfau4fece432013-06-26 15:55:13 +02001415 CONFIG_CMD_TPM
1416 Add tpm monitor functions.
1417 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1418 provides monitor access to authorized functions.
1419
1420 CONFIG_TPM
1421 Define this to enable the TPM support library which provides
1422 functional interfaces to some TPM commands.
1423 Requires support for a TPM device.
1424
1425 CONFIG_TPM_AUTH_SESSIONS
1426 Define this to enable authorized functions in the TPM library.
1427 Requires CONFIG_TPM and CONFIG_SHA1.
1428
wdenkc6097192002-11-03 00:24:07 +00001429- USB Support:
1430 At the moment only the UHCI host controller is
wdenk369d43d2004-03-14 14:09:05 +00001431 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001432 CONFIG_USB_UHCI to enable it.
1433 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenkfb30b4c2004-10-09 22:44:59 +00001434 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001435 storage devices.
1436 Note:
1437 Supported are USB Keyboards and USB Floppy drives
1438 (TEAC FD-05PUB).
wdenk369d43d2004-03-14 14:09:05 +00001439 MPC5200 USB requires additional defines:
1440 CONFIG_USB_CLOCK
1441 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt02848522009-08-13 08:32:37 -05001442 CONFIG_PSC3_USB
1443 for USB on PSC3
wdenk369d43d2004-03-14 14:09:05 +00001444 CONFIG_USB_CONFIG
1445 for differential drivers: 0x00001000
1446 for single ended drivers: 0x00005000
Eric Millbrandt02848522009-08-13 08:32:37 -05001447 for differential drivers on PSC3: 0x00000100
1448 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001449 CONFIG_SYS_USB_EVENT_POLL
Zhang Wei063f9ff2007-06-06 10:08:13 +02001450 May be defined to allow interrupt polling
1451 instead of using asynchronous interrupts
wdenk369d43d2004-03-14 14:09:05 +00001452
Simon Glass5978cdb2012-02-27 10:52:47 +00001453 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1454 txfilltuning field in the EHCI controller on reset.
1455
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001456- USB Device:
1457 Define the below if you wish to use the USB console.
1458 Once firmware is rebuilt from a serial console issue the
1459 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001460 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001461 it has found a new device. The environment variable usbtty
1462 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denke2601822006-06-14 18:14:56 +02001463 appear to a USB host as a Linux gserial device or a
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001464 Common Device Class Abstract Control Model serial device.
1465 If you select usbtty = gserial you should be able to enumerate
1466 a Linux host by
1467 # modprobe usbserial vendor=0xVendorID product=0xProductID
1468 else if using cdc_acm, simply setting the environment
1469 variable usbtty to be cdc_acm should suffice. The following
1470 might be defined in YourBoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001471
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001472 CONFIG_USB_DEVICE
1473 Define this to build a UDC device
1474
1475 CONFIG_USB_TTY
1476 Define this to have a tty type of device available to
1477 talk to the UDC device
Wolfgang Denke2601822006-06-14 18:14:56 +02001478
Vipin KUMARbdb17702012-03-26 15:38:06 +05301479 CONFIG_USBD_HS
1480 Define this to enable the high speed support for usb
1481 device and usbtty. If this feature is enabled, a routine
1482 int is_usbd_high_speed(void)
1483 also needs to be defined by the driver to dynamically poll
1484 whether the enumeration has succeded at high speed or full
1485 speed.
1486
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001487 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001488 Define this if you want stdin, stdout &/or stderr to
1489 be set to usbtty.
1490
1491 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001492 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001493 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001494 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denke2601822006-06-14 18:14:56 +02001495
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001496 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001497 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001498 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001499
Wolfgang Denke2601822006-06-14 18:14:56 +02001500 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001501 define your own vendor specific values either in BoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001502 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001503 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1504 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1505 should pretend to be a Linux device to it's target host.
1506
1507 CONFIG_USBD_MANUFACTURER
1508 Define this string as the name of your company for
1509 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denke2601822006-06-14 18:14:56 +02001510
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001511 CONFIG_USBD_PRODUCT_NAME
1512 Define this string as the name of your product
1513 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
wdenkc6097192002-11-03 00:24:07 +00001514
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001515 CONFIG_USBD_VENDORID
1516 Define this as your assigned Vendor ID from the USB
1517 Implementors Forum. This *must* be a genuine Vendor ID
1518 to avoid polluting the USB namespace.
1519 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001520
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001521 CONFIG_USBD_PRODUCTID
1522 Define this as the unique Product ID
1523 for your device
1524 - CONFIG_USBD_PRODUCTID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001525
Igor Grinbergac5f6ee2011-12-12 12:08:35 +02001526- ULPI Layer Support:
1527 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1528 the generic ULPI layer. The generic layer accesses the ULPI PHY
1529 via the platform viewport, so you need both the genric layer and
1530 the viewport enabled. Currently only Chipidea/ARC based
1531 viewport is supported.
1532 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1533 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stachf31e4112012-10-01 00:44:35 +02001534 If your ULPI phy needs a different reference clock than the
1535 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1536 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001537
wdenk7a428cc2003-06-15 22:40:42 +00001538- MMC Support:
wdenk57b2d802003-06-27 21:31:46 +00001539 The MMC controller on the Intel PXA is supported. To
1540 enable this define CONFIG_MMC. The MMC can be
1541 accessed from the boot prompt by mapping the device
wdenk7a428cc2003-06-15 22:40:42 +00001542 to physical memory similar to flash. Command line is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001543 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1544 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenk7a428cc2003-06-15 22:40:42 +00001545
Yoshihiro Shimodadb7717b2011-07-04 22:21:22 +00001546 CONFIG_SH_MMCIF
1547 Support for Renesas on-chip MMCIF controller
1548
1549 CONFIG_SH_MMCIF_ADDR
1550 Define the base address of MMCIF registers
1551
1552 CONFIG_SH_MMCIF_CLK
1553 Define the clock frequency for MMCIF
1554
Pierre Aubertbcc302c2014-04-24 10:30:08 +02001555 CONFIG_GENERIC_MMC
1556 Enable the generic MMC driver
1557
1558 CONFIG_SUPPORT_EMMC_BOOT
1559 Enable some additional features of the eMMC boot partitions.
1560
1561 CONFIG_SUPPORT_EMMC_RPMB
1562 Enable the commands for reading, writing and programming the
1563 key for the Replay Protection Memory Block partition in eMMC.
1564
Tom Rini58a8d322013-03-14 05:32:47 +00001565- USB Device Firmware Update (DFU) class support:
1566 CONFIG_DFU_FUNCTION
1567 This enables the USB portion of the DFU USB class
1568
1569 CONFIG_CMD_DFU
1570 This enables the command "dfu" which is used to have
1571 U-Boot create a DFU class device via USB. This command
1572 requires that the "dfu_alt_info" environment variable be
1573 set and define the alt settings to expose to the host.
1574
1575 CONFIG_DFU_MMC
1576 This enables support for exposing (e)MMC devices via DFU.
1577
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +00001578 CONFIG_DFU_NAND
1579 This enables support for exposing NAND devices via DFU.
1580
Afzal Mohammede3c687a2013-09-18 01:15:24 +05301581 CONFIG_DFU_RAM
1582 This enables support for exposing RAM via DFU.
1583 Note: DFU spec refer to non-volatile memory usage, but
1584 allow usages beyond the scope of spec - here RAM usage,
1585 one that would help mostly the developer.
1586
Heiko Schochera2f831e2013-06-12 06:05:51 +02001587 CONFIG_SYS_DFU_DATA_BUF_SIZE
1588 Dfu transfer uses a buffer before writing data to the
1589 raw storage device. Make the size (in bytes) of this buffer
1590 configurable. The size of this buffer is also configurable
1591 through the "dfu_bufsiz" environment variable.
1592
Pantelis Antonioua6e788d2013-03-14 05:32:48 +00001593 CONFIG_SYS_DFU_MAX_FILE_SIZE
1594 When updating files rather than the raw storage device,
1595 we use a static buffer to copy the file into and then write
1596 the buffer once we've been given the whole file. Define
1597 this to the maximum filesize (in bytes) for the buffer.
1598 Default is 4 MiB if undefined.
1599
Heiko Schochere1ba1512014-03-18 08:09:56 +01001600 DFU_DEFAULT_POLL_TIMEOUT
1601 Poll timeout [ms], is the timeout a device can send to the
1602 host. The host must wait for this timeout before sending
1603 a subsequent DFU_GET_STATUS request to the device.
1604
1605 DFU_MANIFEST_POLL_TIMEOUT
1606 Poll timeout [ms], which the device sends to the host when
1607 entering dfuMANIFEST state. Host waits this timeout, before
1608 sending again an USB request to the device.
1609
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001610- USB Device Android Fastboot support:
1611 CONFIG_CMD_FASTBOOT
1612 This enables the command "fastboot" which enables the Android
1613 fastboot mode for the platform's USB device. Fastboot is a USB
1614 protocol for downloading images, flashing and device control
1615 used on Android devices.
1616 See doc/README.android-fastboot for more information.
1617
1618 CONFIG_ANDROID_BOOT_IMAGE
1619 This enables support for booting images which use the Android
1620 image format header.
1621
1622 CONFIG_USB_FASTBOOT_BUF_ADDR
1623 The fastboot protocol requires a large memory buffer for
1624 downloads. Define this to the starting RAM address to use for
1625 downloaded images.
1626
1627 CONFIG_USB_FASTBOOT_BUF_SIZE
1628 The fastboot protocol requires a large memory buffer for
1629 downloads. This buffer should be as large as possible for a
1630 platform. Define this to the size available RAM for fastboot.
1631
wdenkda04a8b2004-08-02 23:22:59 +00001632- Journaling Flash filesystem support:
1633 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1634 CONFIG_JFFS2_NAND_DEV
1635 Define these for a default partition on a NAND device
1636
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001637 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1638 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenkda04a8b2004-08-02 23:22:59 +00001639 Define these for a default partition on a NOR device
1640
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001641 CONFIG_SYS_JFFS_CUSTOM_PART
wdenkda04a8b2004-08-02 23:22:59 +00001642 Define this to create an own partition. You have to provide a
1643 function struct part_info* jffs2_part_info(int part_num)
1644
1645 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001646 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenkda04a8b2004-08-02 23:22:59 +00001647 to disable the command chpart. This is the default when you
1648 have not defined a custom partition
1649
Donggeun Kim8f814002011-10-24 21:15:28 +00001650- FAT(File Allocation Table) filesystem write function support:
1651 CONFIG_FAT_WRITE
Donggeun Kimb44c8ab2012-03-22 04:38:56 +00001652
1653 Define this to enable support for saving memory data as a
1654 file in FAT formatted partition.
1655
1656 This will also enable the command "fatwrite" enabling the
1657 user to write files to FAT.
Donggeun Kim8f814002011-10-24 21:15:28 +00001658
Gabe Black7f8574c2012-10-12 14:26:11 +00001659CBFS (Coreboot Filesystem) support
1660 CONFIG_CMD_CBFS
1661
1662 Define this to enable support for reading from a Coreboot
1663 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1664 and cbfsload.
1665
Siva Durga Prasad Paladugu1c4cf332014-05-26 19:18:37 +05301666- FAT(File Allocation Table) filesystem cluster size:
1667 CONFIG_FS_FAT_MAX_CLUSTSIZE
1668
1669 Define the max cluster size for fat operations else
1670 a default value of 65536 will be defined.
1671
wdenkc6097192002-11-03 00:24:07 +00001672- Keyboard Support:
1673 CONFIG_ISA_KEYBOARD
1674
1675 Define this to enable standard (PC-Style) keyboard
1676 support
1677
1678 CONFIG_I8042_KBD
1679 Standard PC keyboard driver with US (is default) and
1680 GERMAN key layout (switch via environment 'keymap=de') support.
1681 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1682 for cfb_console. Supports cursor blinking.
1683
Hung-ying Tyan4a48bcf2013-05-15 18:27:32 +08001684 CONFIG_CROS_EC_KEYB
1685 Enables a Chrome OS keyboard using the CROS_EC interface.
1686 This uses CROS_EC to communicate with a second microcontroller
1687 which provides key scans on request.
1688
wdenkc6097192002-11-03 00:24:07 +00001689- Video support:
1690 CONFIG_VIDEO
1691
1692 Define this to enable video support (for output to
1693 video).
1694
1695 CONFIG_VIDEO_CT69000
1696
1697 Enable Chips & Technologies 69000 Video chip
1698
1699 CONFIG_VIDEO_SMI_LYNXEM
wdenkd3602132004-03-25 15:14:43 +00001700 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkaea86e42004-03-23 22:53:55 +00001701 video output is selected via environment 'videoout'
1702 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1703 assumed.
wdenkc6097192002-11-03 00:24:07 +00001704
wdenkd3602132004-03-25 15:14:43 +00001705 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001706 selected via environment 'videomode'. Two different ways
wdenkaea86e42004-03-23 22:53:55 +00001707 are possible:
1708 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk05939202004-04-18 17:39:38 +00001709 Following standard modes are supported (* is default):
wdenkaea86e42004-03-23 22:53:55 +00001710
1711 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1712 -------------+---------------------------------------------
1713 8 bits | 0x301* 0x303 0x305 0x161 0x307
1714 15 bits | 0x310 0x313 0x316 0x162 0x319
1715 16 bits | 0x311 0x314 0x317 0x163 0x31A
1716 24 bits | 0x312 0x315 0x318 ? 0x31B
1717 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001718 (i.e. setenv videomode 317; saveenv; reset;)
1719
wdenkd3602132004-03-25 15:14:43 +00001720 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswileraea68562007-12-30 03:30:46 +01001721 from the bootargs. (See drivers/video/videomodes.c)
wdenkaea86e42004-03-23 22:53:55 +00001722
1723
stroeseb9c17c52003-04-04 15:53:41 +00001724 CONFIG_VIDEO_SED13806
wdenk4a5c8a72003-03-06 00:02:04 +00001725 Enable Epson SED13806 driver. This driver supports 8bpp
wdenk9dd2b882002-12-03 21:28:10 +00001726 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1727 or CONFIG_VIDEO_SED13806_16BPP
1728
Timur Tabi020edd22011-02-15 17:09:19 -06001729 CONFIG_FSL_DIU_FB
Wolfgang Denk825223d2011-09-11 21:24:09 +02001730 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi020edd22011-02-15 17:09:19 -06001731 SOCs that have a DIU should define this macro to enable DIU
1732 support, and should also define these other macros:
1733
1734 CONFIG_SYS_DIU_ADDR
1735 CONFIG_VIDEO
1736 CONFIG_CMD_BMP
1737 CONFIG_CFB_CONSOLE
1738 CONFIG_VIDEO_SW_CURSOR
1739 CONFIG_VGA_AS_SINGLE_DEVICE
1740 CONFIG_VIDEO_LOGO
1741 CONFIG_VIDEO_BMP_LOGO
1742
Timur Tabi32f709e2011-04-11 14:18:22 -05001743 The DIU driver will look for the 'video-mode' environment
1744 variable, and if defined, enable the DIU as a console during
1745 boot. See the documentation file README.video for a
1746 description of this variable.
Timur Tabi020edd22011-02-15 17:09:19 -06001747
Simon Glass54df8ce2012-12-03 13:59:47 +00001748 CONFIG_VIDEO_VGA
1749
1750 Enable the VGA video / BIOS for x86. The alternative if you
1751 are using coreboot is to use the coreboot frame buffer
1752 driver.
1753
1754
wdenk4e112c12003-06-03 23:54:09 +00001755- Keyboard Support:
wdenk57b2d802003-06-27 21:31:46 +00001756 CONFIG_KEYBOARD
wdenk4e112c12003-06-03 23:54:09 +00001757
wdenk57b2d802003-06-27 21:31:46 +00001758 Define this to enable a custom keyboard support.
1759 This simply calls drv_keyboard_init() which must be
1760 defined in your board-specific files.
1761 The only board using this so far is RBC823.
wdenk9dd2b882002-12-03 21:28:10 +00001762
wdenkc6097192002-11-03 00:24:07 +00001763- LCD Support: CONFIG_LCD
1764
1765 Define this to enable LCD support (for output to LCD
1766 display); also select one of the supported displays
1767 by defining one of these:
1768
Stelian Popf6f86652008-05-09 21:57:18 +02001769 CONFIG_ATMEL_LCD:
1770
1771 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1772
wdenkc0d54ae2003-11-25 16:55:19 +00001773 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001774
wdenkc0d54ae2003-11-25 16:55:19 +00001775 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001776
wdenkc0d54ae2003-11-25 16:55:19 +00001777 CONFIG_NEC_NL6448BC20
1778
1779 NEC NL6448BC20-08. 6.5", 640x480.
1780 Active, color, single scan.
1781
1782 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +00001783
wdenkc0d54ae2003-11-25 16:55:19 +00001784 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001785 Active, color, single scan.
1786
1787 CONFIG_SHARP_16x9
1788
1789 Sharp 320x240. Active, color, single scan.
1790 It isn't 16x9, and I am not sure what it is.
1791
1792 CONFIG_SHARP_LQ64D341
1793
1794 Sharp LQ64D341 display, 640x480.
1795 Active, color, single scan.
1796
1797 CONFIG_HLD1045
1798
1799 HLD1045 display, 640x480.
1800 Active, color, single scan.
1801
1802 CONFIG_OPTREX_BW
1803
1804 Optrex CBL50840-2 NF-FW 99 22 M5
1805 or
1806 Hitachi LMG6912RPFC-00T
1807 or
1808 Hitachi SP14Q002
1809
1810 320x240. Black & white.
1811
1812 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001813 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001814
Simon Glass599a4df2012-10-17 13:24:54 +00001815 CONFIG_LCD_ALIGNMENT
1816
1817 Normally the LCD is page-aligned (tyically 4KB). If this is
1818 defined then the LCD will be aligned to this value instead.
1819 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1820 here, since it is cheaper to change data cache settings on
1821 a per-section basis.
1822
Simon Glassaf3e2802012-10-17 13:24:59 +00001823 CONFIG_CONSOLE_SCROLL_LINES
1824
1825 When the console need to be scrolled, this is the number of
1826 lines to scroll by. It defaults to 1. Increasing this makes
1827 the console jump but can help speed up operation when scrolling
1828 is slow.
Simon Glass599a4df2012-10-17 13:24:54 +00001829
Tom Wai-Hong Tam79926a42012-09-28 15:11:16 +00001830 CONFIG_LCD_BMP_RLE8
1831
1832 Support drawing of RLE8-compressed bitmaps on the LCD.
1833
Tom Wai-Hong Tam6664f202012-12-05 14:46:40 +00001834 CONFIG_I2C_EDID
1835
1836 Enables an 'i2c edid' command which can read EDID
1837 information over I2C from an attached LCD display.
1838
wdenkeb20ad32003-09-05 23:19:14 +00001839- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenk92bbe3f2003-04-20 14:04:18 +00001840
wdenk57b2d802003-06-27 21:31:46 +00001841 If this option is set, the environment is checked for
1842 a variable "splashimage". If found, the usual display
1843 of logo, copyright and system information on the LCD
wdenk01686632004-06-30 22:59:18 +00001844 is suppressed and the BMP image at the address
wdenk57b2d802003-06-27 21:31:46 +00001845 specified in "splashimage" is loaded instead. The
1846 console is redirected to the "nulldev", too. This
1847 allows for a "silent" boot where a splash screen is
1848 loaded very quickly after power-on.
wdenk92bbe3f2003-04-20 14:04:18 +00001849
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001850 CONFIG_SPLASHIMAGE_GUARD
1851
1852 If this option is set, then U-Boot will prevent the environment
1853 variable "splashimage" from being set to a problematic address
Tom Rini958a8f82014-02-25 10:27:01 -05001854 (see README.displaying-bmps).
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001855 This option is useful for targets where, due to alignment
1856 restrictions, an improperly aligned BMP image will cause a data
1857 abort. If you think you will not have problems with unaligned
1858 accesses (for example because your toolchain prevents them)
1859 there is no need to set this option.
1860
Matthias Weisser53884182009-07-09 16:07:30 +02001861 CONFIG_SPLASH_SCREEN_ALIGN
1862
1863 If this option is set the splash image can be freely positioned
1864 on the screen. Environment variable "splashpos" specifies the
1865 position as "x,y". If a positive number is given it is used as
1866 number of pixel from left/top. If a negative number is given it
1867 is used as number of pixel from right/bottom. You can also
1868 specify 'm' for centering the image.
1869
1870 Example:
1871 setenv splashpos m,m
1872 => image at center of screen
1873
1874 setenv splashpos 30,20
1875 => image at x = 30 and y = 20
1876
1877 setenv splashpos -10,m
1878 => vertically centered image
1879 at x = dspWidth - bmpWidth - 9
1880
Stefan Roesed9d97742005-09-22 09:04:17 +02001881- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1882
1883 If this option is set, additionally to standard BMP
1884 images, gzipped BMP images can be displayed via the
1885 splashscreen support or the bmp command.
1886
Anatolij Gustschin6b4e4fc2010-03-15 14:50:25 +01001887- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1888
1889 If this option is set, 8-bit RLE compressed BMP images
1890 can be displayed via the splashscreen support or the
1891 bmp command.
1892
Lei Wene4e248d2012-09-28 04:26:47 +00001893- Do compresssing for memory range:
1894 CONFIG_CMD_ZIP
1895
1896 If this option is set, it would use zlib deflate method
1897 to compress the specified memory at its best effort.
1898
wdenk710e3502003-08-29 20:57:53 +00001899- Compression support:
Kees Cook5b06e642013-08-16 07:59:12 -07001900 CONFIG_GZIP
1901
1902 Enabled by default to support gzip compressed images.
1903
wdenk710e3502003-08-29 20:57:53 +00001904 CONFIG_BZIP2
1905
1906 If this option is set, support for bzip2 compressed
1907 images is included. If not, only uncompressed and gzip
1908 compressed images are supported.
1909
wdenk9c53f402003-10-15 23:53:47 +00001910 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001911 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk9c53f402003-10-15 23:53:47 +00001912 be at least 4MB.
wdenk92bbe3f2003-04-20 14:04:18 +00001913
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001914 CONFIG_LZMA
1915
1916 If this option is set, support for lzma compressed
1917 images is included.
1918
1919 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1920 requires an amount of dynamic memory that is given by the
1921 formula:
1922
1923 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1924
1925 Where lc and lp stand for, respectively, Literal context bits
1926 and Literal pos bits.
1927
1928 This value is upper-bounded by 14MB in the worst case. Anyway,
1929 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1930 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1931 a very small buffer.
1932
1933 Use the lzmainfo tool to determinate the lc and lp values and
1934 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001935 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001936
Kees Cook5b06e642013-08-16 07:59:12 -07001937 CONFIG_LZO
1938
1939 If this option is set, support for LZO compressed images
1940 is included.
1941
wdenk0e2bd9c2004-06-06 21:51:03 +00001942- MII/PHY support:
1943 CONFIG_PHY_ADDR
1944
1945 The address of PHY on MII bus.
1946
1947 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1948
1949 The clock frequency of the MII bus
1950
1951 CONFIG_PHY_GIGE
1952
1953 If this option is set, support for speed/duplex
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001954 detection of gigabit PHY is included.
wdenk0e2bd9c2004-06-06 21:51:03 +00001955
1956 CONFIG_PHY_RESET_DELAY
1957
1958 Some PHY like Intel LXT971A need extra delay after
1959 reset before any MII register access is possible.
1960 For such PHY, set this option to the usec delay
1961 required. (minimum 300usec for LXT971A)
1962
1963 CONFIG_PHY_CMD_DELAY (ppc4xx)
1964
1965 Some PHY like Intel LXT971A need extra delay after
1966 command issued before MII status register can be read
1967
wdenkc6097192002-11-03 00:24:07 +00001968- Ethernet address:
1969 CONFIG_ETHADDR
richardretanubune5167f12008-09-29 18:28:23 -04001970 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001971 CONFIG_ETH2ADDR
1972 CONFIG_ETH3ADDR
richardretanubune5167f12008-09-29 18:28:23 -04001973 CONFIG_ETH4ADDR
1974 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001975
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001976 Define a default value for Ethernet address to use
1977 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001978 is not determined automatically.
1979
1980- IP address:
1981 CONFIG_IPADDR
1982
1983 Define a default value for the IP address to use for
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001984 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001985 determined through e.g. bootp.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001986 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001987
1988- Server IP address:
1989 CONFIG_SERVERIP
1990
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001991 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001992 server to contact when using the "tftboot" command.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001993 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001994
Robin Getz470a6d42009-07-21 12:15:28 -04001995 CONFIG_KEEP_SERVERADDR
1996
1997 Keeps the server's MAC address, in the env 'serveraddr'
1998 for passing to bootargs (like Linux's netconsole option)
1999
Wolfgang Denk26da2992011-10-26 10:21:22 +00002000- Gateway IP address:
2001 CONFIG_GATEWAYIP
2002
2003 Defines a default value for the IP address of the
2004 default router where packets to other networks are
2005 sent to.
2006 (Environment variable "gatewayip")
2007
2008- Subnet mask:
2009 CONFIG_NETMASK
2010
2011 Defines a default value for the subnet mask (or
2012 routing prefix) which is used to determine if an IP
2013 address belongs to the local subnet or needs to be
2014 forwarded through a router.
2015 (Environment variable "netmask")
2016
David Updegraff7280da72007-06-11 10:41:07 -05002017- Multicast TFTP Mode:
2018 CONFIG_MCAST_TFTP
2019
2020 Defines whether you want to support multicast TFTP as per
2021 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002022 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff7280da72007-06-11 10:41:07 -05002023 driver in use must provide a function: mcast() to join/leave a
2024 multicast group.
2025
wdenkc6097192002-11-03 00:24:07 +00002026- BOOTP Recovery Mode:
2027 CONFIG_BOOTP_RANDOM_DELAY
2028
2029 If you have many targets in a network that try to
2030 boot using BOOTP, you may want to avoid that all
2031 systems send out BOOTP requests at precisely the same
2032 moment (which would happen for instance at recovery
2033 from a power failure, when all systems will try to
2034 boot, thus flooding the BOOTP server. Defining
2035 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
2036 inserted before sending out BOOTP requests. The
Wolfgang Denkb65aaf92007-08-06 23:21:05 +02002037 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00002038
2039 1st BOOTP request: delay 0 ... 1 sec
2040 2nd BOOTP request: delay 0 ... 2 sec
2041 3rd BOOTP request: delay 0 ... 4 sec
2042 4th and following
2043 BOOTP requests: delay 0 ... 8 sec
2044
Thierry Reding8977cda2014-08-19 10:21:24 +02002045 CONFIG_BOOTP_ID_CACHE_SIZE
2046
2047 BOOTP packets are uniquely identified using a 32-bit ID. The
2048 server will copy the ID from client requests to responses and
2049 U-Boot will use this to determine if it is the destination of
2050 an incoming response. Some servers will check that addresses
2051 aren't in use before handing them out (usually using an ARP
2052 ping) and therefore take up to a few hundred milliseconds to
2053 respond. Network congestion may also influence the time it
2054 takes for a response to make it back to the client. If that
2055 time is too long, U-Boot will retransmit requests. In order
2056 to allow earlier responses to still be accepted after these
2057 retransmissions, U-Boot's BOOTP client keeps a small cache of
2058 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
2059 cache. The default is to keep IDs for up to four outstanding
2060 requests. Increasing this will allow U-Boot to accept offers
2061 from a BOOTP client in networks with unusually high latency.
2062
stroesee0aadfb2003-08-28 14:17:32 +00002063- DHCP Advanced Options:
Jon Loeliger5336a762007-07-09 22:08:34 -05002064 You can fine tune the DHCP functionality by defining
2065 CONFIG_BOOTP_* symbols:
stroesee0aadfb2003-08-28 14:17:32 +00002066
Jon Loeliger5336a762007-07-09 22:08:34 -05002067 CONFIG_BOOTP_SUBNETMASK
2068 CONFIG_BOOTP_GATEWAY
2069 CONFIG_BOOTP_HOSTNAME
2070 CONFIG_BOOTP_NISDOMAIN
2071 CONFIG_BOOTP_BOOTPATH
2072 CONFIG_BOOTP_BOOTFILESIZE
2073 CONFIG_BOOTP_DNS
2074 CONFIG_BOOTP_DNS2
2075 CONFIG_BOOTP_SEND_HOSTNAME
2076 CONFIG_BOOTP_NTPSERVER
2077 CONFIG_BOOTP_TIMEOFFSET
2078 CONFIG_BOOTP_VENDOREX
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00002079 CONFIG_BOOTP_MAY_FAIL
stroesee0aadfb2003-08-28 14:17:32 +00002080
Wilson Callan22bcd6e2007-07-28 10:56:13 -04002081 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
2082 environment variable, not the BOOTP server.
stroesee0aadfb2003-08-28 14:17:32 +00002083
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00002084 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
2085 after the configured retry count, the call will fail
2086 instead of starting over. This can be used to fail over
2087 to Link-local IP address configuration if the DHCP server
2088 is not available.
2089
stroesee0aadfb2003-08-28 14:17:32 +00002090 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
2091 serverip from a DHCP server, it is possible that more
2092 than one DNS serverip is offered to the client.
2093 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
2094 serverip will be stored in the additional environment
2095 variable "dnsip2". The first DNS serverip is always
2096 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger5336a762007-07-09 22:08:34 -05002097 is defined.
stroesee0aadfb2003-08-28 14:17:32 +00002098
2099 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
2100 to do a dynamic update of a DNS server. To do this, they
2101 need the hostname of the DHCP requester.
Wilson Callan22bcd6e2007-07-28 10:56:13 -04002102 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger5336a762007-07-09 22:08:34 -05002103 of the "hostname" environment variable is passed as
2104 option 12 to the DHCP server.
stroesee0aadfb2003-08-28 14:17:32 +00002105
Aras Vaichas72aa3f32008-03-26 09:43:57 +11002106 CONFIG_BOOTP_DHCP_REQUEST_DELAY
2107
2108 A 32bit value in microseconds for a delay between
2109 receiving a "DHCP Offer" and sending the "DHCP Request".
2110 This fixes a problem with certain DHCP servers that don't
2111 respond 100% of the time to a "DHCP request". E.g. On an
2112 AT91RM9200 processor running at 180MHz, this delay needed
2113 to be *at least* 15,000 usec before a Windows Server 2003
2114 DHCP server would reply 100% of the time. I recommend at
2115 least 50,000 usec to be safe. The alternative is to hope
2116 that one of the retries will be successful but note that
2117 the DHCP timeout and retry process takes a longer than
2118 this delay.
2119
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00002120 - Link-local IP address negotiation:
2121 Negotiate with other link-local clients on the local network
2122 for an address that doesn't require explicit configuration.
2123 This is especially useful if a DHCP server cannot be guaranteed
2124 to exist in all environments that the device must operate.
2125
2126 See doc/README.link-local for more information.
2127
wdenk145d2c12004-04-15 21:48:45 +00002128 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00002129 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00002130
2131 The device id used in CDP trigger frames.
2132
2133 CONFIG_CDP_DEVICE_ID_PREFIX
2134
2135 A two character string which is prefixed to the MAC address
2136 of the device.
2137
2138 CONFIG_CDP_PORT_ID
2139
2140 A printf format string which contains the ascii name of
2141 the port. Normally is set to "eth%d" which sets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002142 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-04-15 21:48:45 +00002143
2144 CONFIG_CDP_CAPABILITIES
2145
2146 A 32bit integer which indicates the device capabilities;
2147 0x00000010 for a normal host which does not forwards.
2148
2149 CONFIG_CDP_VERSION
2150
2151 An ascii string containing the version of the software.
2152
2153 CONFIG_CDP_PLATFORM
2154
2155 An ascii string containing the name of the platform.
2156
2157 CONFIG_CDP_TRIGGER
2158
2159 A 32bit integer sent on the trigger.
2160
2161 CONFIG_CDP_POWER_CONSUMPTION
2162
2163 A 16bit integer containing the power consumption of the
2164 device in .1 of milliwatts.
2165
2166 CONFIG_CDP_APPLIANCE_VLAN_TYPE
2167
2168 A byte containing the id of the VLAN.
2169
wdenkc6097192002-11-03 00:24:07 +00002170- Status LED: CONFIG_STATUS_LED
2171
2172 Several configurations allow to display the current
2173 status using a LED. For instance, the LED will blink
2174 fast while running U-Boot code, stop blinking as
2175 soon as a reply to a BOOTP request was received, and
2176 start blinking slow once the Linux kernel is running
2177 (supported by a status LED driver in the Linux
2178 kernel). Defining CONFIG_STATUS_LED enables this
2179 feature in U-Boot.
2180
Igor Grinberg4997a9e2013-11-08 01:03:50 +02002181 Additional options:
2182
2183 CONFIG_GPIO_LED
2184 The status LED can be connected to a GPIO pin.
2185 In such cases, the gpio_led driver can be used as a
2186 status LED backend implementation. Define CONFIG_GPIO_LED
2187 to include the gpio_led driver in the U-Boot binary.
2188
Igor Grinberg203bd9f2013-11-08 01:03:52 +02002189 CONFIG_GPIO_LED_INVERTED_TABLE
2190 Some GPIO connected LEDs may have inverted polarity in which
2191 case the GPIO high value corresponds to LED off state and
2192 GPIO low value corresponds to LED on state.
2193 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
2194 with a list of GPIO LEDs that have inverted polarity.
2195
wdenkc6097192002-11-03 00:24:07 +00002196- CAN Support: CONFIG_CAN_DRIVER
2197
2198 Defining CONFIG_CAN_DRIVER enables CAN driver support
2199 on those systems that support this (optional)
2200 feature, like the TQM8xxL modules.
2201
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002202- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00002203
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002204 This enable the NEW i2c subsystem, and will allow you to use
2205 i2c commands at the u-boot command line (as long as you set
2206 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
2207 based realtime clock chips or other i2c devices. See
2208 common/cmd_i2c.c for a description of the command line
2209 interface.
2210
2211 ported i2c driver to the new framework:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002212 - drivers/i2c/soft_i2c.c:
2213 - activate first bus with CONFIG_SYS_I2C_SOFT define
2214 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2215 for defining speed and slave address
2216 - activate second bus with I2C_SOFT_DECLARATIONS2 define
2217 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2218 for defining speed and slave address
2219 - activate third bus with I2C_SOFT_DECLARATIONS3 define
2220 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2221 for defining speed and slave address
2222 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2223 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2224 for defining speed and slave address
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002225
Heiko Schocherf2850742012-10-24 13:48:22 +02002226 - drivers/i2c/fsl_i2c.c:
2227 - activate i2c driver with CONFIG_SYS_I2C_FSL
2228 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
2229 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
2230 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
2231 bus.
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02002232 - If your board supports a second fsl i2c bus, define
Heiko Schocherf2850742012-10-24 13:48:22 +02002233 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
2234 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
2235 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
2236 second bus.
2237
Simon Glass026fefb2012-10-30 07:28:53 +00002238 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu045acfa2013-10-11 16:23:53 +09002239 - activate this driver with CONFIG_SYS_I2C_TEGRA
2240 - This driver adds 4 i2c buses with a fix speed from
2241 100000 and the slave addr 0!
Simon Glass026fefb2012-10-30 07:28:53 +00002242
Dirk Eibach42b204f2013-04-25 02:40:01 +00002243 - drivers/i2c/ppc4xx_i2c.c
2244 - activate this driver with CONFIG_SYS_I2C_PPC4XX
2245 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2246 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2247
trema49f40a2013-09-21 18:13:35 +02002248 - drivers/i2c/i2c_mxc.c
2249 - activate this driver with CONFIG_SYS_I2C_MXC
2250 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2251 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2252 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2253 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2254 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2255 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
2256 If thoses defines are not set, default value is 100000
2257 for speed, and 0 for slave.
2258
Nobuhiro Iwamatsue94ea2f2013-09-27 16:58:30 +09002259 - drivers/i2c/rcar_i2c.c:
2260 - activate this driver with CONFIG_SYS_I2C_RCAR
2261 - This driver adds 4 i2c buses
2262
2263 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2264 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2265 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2266 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2267 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2268 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2269 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2270 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2271 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2272
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09002273 - drivers/i2c/sh_i2c.c:
2274 - activate this driver with CONFIG_SYS_I2C_SH
2275 - This driver adds from 2 to 5 i2c buses
2276
2277 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
2278 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
2279 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
2280 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
2281 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
2282 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2283 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2284 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2285 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2286 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
2287 - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
2288 - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
2289 - CONFIF_SYS_I2C_SH_NUM_CONTROLLERS for nummber of i2c buses
2290
Heiko Schocherf53f2b82013-10-22 11:03:18 +02002291 - drivers/i2c/omap24xx_i2c.c
2292 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2293 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2294 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2295 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2296 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2297 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2298 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2299 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2300 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2301 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2302 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2303
Heiko Schocher465819a2013-11-08 07:30:53 +01002304 - drivers/i2c/zynq_i2c.c
2305 - activate this driver with CONFIG_SYS_I2C_ZYNQ
2306 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2307 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2308
Naveen Krishna Ch5d5efd32013-12-06 12:12:38 +05302309 - drivers/i2c/s3c24x0_i2c.c:
2310 - activate this driver with CONFIG_SYS_I2C_S3C24X0
2311 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2312 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2313 with a fix speed from 100000 and the slave addr 0!
2314
Dirk Eibachb9577432014-07-03 09:28:18 +02002315 - drivers/i2c/ihs_i2c.c
2316 - activate this driver with CONFIG_SYS_I2C_IHS
2317 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2318 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2319 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2320 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2321 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2322 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2323 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2324 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2325 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2326 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2327 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2328 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
2329
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002330 additional defines:
2331
2332 CONFIG_SYS_NUM_I2C_BUSES
2333 Hold the number of i2c busses you want to use. If you
2334 don't use/have i2c muxes on your i2c bus, this
2335 is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
2336 omit this define.
2337
2338 CONFIG_SYS_I2C_DIRECT_BUS
2339 define this, if you don't use i2c muxes on your hardware.
2340 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2341 omit this define.
2342
2343 CONFIG_SYS_I2C_MAX_HOPS
2344 define how many muxes are maximal consecutively connected
2345 on one i2c bus. If you not use i2c muxes, omit this
2346 define.
2347
2348 CONFIG_SYS_I2C_BUSES
2349 hold a list of busses you want to use, only used if
2350 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2351 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2352 CONFIG_SYS_NUM_I2C_BUSES = 9:
2353
2354 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2355 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2356 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2357 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2358 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2359 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2360 {1, {I2C_NULL_HOP}}, \
2361 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2362 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2363 }
2364
2365 which defines
2366 bus 0 on adapter 0 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002367 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2368 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2369 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2370 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2371 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002372 bus 6 on adapter 1 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002373 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2374 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002375
2376 If you do not have i2c muxes on your board, omit this define.
2377
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002378- Legacy I2C Support: CONFIG_HARD_I2C
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002379
2380 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
2381 provides the following compelling advantages:
2382
2383 - more than one i2c adapter is usable
2384 - approved multibus support
2385 - better i2c mux support
2386
2387 ** Please consider updating your I2C driver now. **
wdenkc6097192002-11-03 00:24:07 +00002388
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002389 These enable legacy I2C serial bus commands. Defining
2390 CONFIG_HARD_I2C will include the appropriate I2C driver
2391 for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00002392
wdenk21136db2003-07-16 21:53:01 +00002393 This will allow you to use i2c commands at the u-boot
Jon Loeligerc1da5c92007-06-11 19:03:39 -05002394 command line (as long as you set CONFIG_CMD_I2C in
wdenkb9bbd242003-06-30 16:24:52 +00002395 CONFIG_COMMANDS) and communicate with i2c based realtime
2396 clock chips. See common/cmd_i2c.c for a description of the
wdenk4a5c8a72003-03-06 00:02:04 +00002397 command line interface.
wdenkc6097192002-11-03 00:24:07 +00002398
Ben Warren45657152006-09-07 16:50:54 -04002399 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkb9bbd242003-06-30 16:24:52 +00002400
wdenk21136db2003-07-16 21:53:01 +00002401 There are several other quantities that must also be
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002402 defined when you define CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002403
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002404 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk21136db2003-07-16 21:53:01 +00002405 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002406 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002407 the CPU's i2c node address).
wdenk21136db2003-07-16 21:53:01 +00002408
Peter Tysere4d1abc2010-04-12 22:28:21 -05002409 Now, the u-boot i2c code for the mpc8xx
Stefan Roese88fbf932010-04-15 16:07:28 +02002410 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tysere4d1abc2010-04-12 22:28:21 -05002411 and so its address should therefore be cleared to 0 (See,
2412 eg, MPC823e User's Manual p.16-473). So, set
2413 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00002414
Eric Millbrandt12990a42009-09-03 08:09:44 -05002415 CONFIG_SYS_I2C_INIT_MPC5XXX
2416
2417 When a board is reset during an i2c bus transfer
2418 chips might think that the current transfer is still
2419 in progress. Reset the slave devices by sending start
2420 commands until the slave device responds.
2421
wdenk21136db2003-07-16 21:53:01 +00002422 That's all that's required for CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002423
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002424 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb9bbd242003-06-30 16:24:52 +00002425 then the following macros need to be defined (examples are
2426 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002427
2428 I2C_INIT
2429
wdenkb9bbd242003-06-30 16:24:52 +00002430 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00002431 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002432
wdenk544e9732004-02-06 23:19:44 +00002433 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00002434
wdenkc6097192002-11-03 00:24:07 +00002435 I2C_PORT
2436
wdenk4a5c8a72003-03-06 00:02:04 +00002437 (Only for MPC8260 CPU). The I/O port to use (the code
2438 assumes both bits are on the same port). Valid values
2439 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00002440
2441 I2C_ACTIVE
2442
2443 The code necessary to make the I2C data line active
2444 (driven). If the data line is open collector, this
2445 define can be null.
2446
wdenkb9bbd242003-06-30 16:24:52 +00002447 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2448
wdenkc6097192002-11-03 00:24:07 +00002449 I2C_TRISTATE
2450
2451 The code necessary to make the I2C data line tri-stated
2452 (inactive). If the data line is open collector, this
2453 define can be null.
2454
wdenkb9bbd242003-06-30 16:24:52 +00002455 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2456
wdenkc6097192002-11-03 00:24:07 +00002457 I2C_READ
2458
York Sun4a598092013-04-01 11:29:11 -07002459 Code that returns true if the I2C data line is high,
2460 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002461
wdenkb9bbd242003-06-30 16:24:52 +00002462 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2463
wdenkc6097192002-11-03 00:24:07 +00002464 I2C_SDA(bit)
2465
York Sun4a598092013-04-01 11:29:11 -07002466 If <bit> is true, sets the I2C data line high. If it
2467 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002468
wdenkb9bbd242003-06-30 16:24:52 +00002469 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002470 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00002471 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00002472
wdenkc6097192002-11-03 00:24:07 +00002473 I2C_SCL(bit)
2474
York Sun4a598092013-04-01 11:29:11 -07002475 If <bit> is true, sets the I2C clock line high. If it
2476 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002477
wdenkb9bbd242003-06-30 16:24:52 +00002478 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002479 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00002480 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00002481
wdenkc6097192002-11-03 00:24:07 +00002482 I2C_DELAY
2483
2484 This delay is invoked four times per clock cycle so this
2485 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00002486 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00002487 like:
2488
wdenkb9bbd242003-06-30 16:24:52 +00002489 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002490
Mike Frysingeree12d542010-07-21 13:38:02 -04002491 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2492
2493 If your arch supports the generic GPIO framework (asm/gpio.h),
2494 then you may alternatively define the two GPIOs that are to be
2495 used as SCL / SDA. Any of the previous I2C_xxx macros will
2496 have GPIO-based defaults assigned to them as appropriate.
2497
2498 You should define these to the GPIO value as given directly to
2499 the generic GPIO functions.
2500
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002501 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00002502
wdenk57b2d802003-06-27 21:31:46 +00002503 When a board is reset during an i2c bus transfer
2504 chips might think that the current transfer is still
2505 in progress. On some boards it is possible to access
2506 the i2c SCLK line directly, either by using the
2507 processor pin as a GPIO or by having a second pin
2508 connected to the bus. If this option is defined a
2509 custom i2c_init_board() routine in boards/xxx/board.c
2510 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00002511
Richard Retanubundf0149c2010-04-12 15:08:17 -04002512 CONFIG_SYS_I2C_BOARD_LATE_INIT
2513
2514 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2515 defined a custom i2c_board_late_init() routine in
2516 boards/xxx/board.c is run AFTER the operations in i2c_init()
2517 is completed. This callpoint can be used to unreset i2c bus
2518 using CPU i2c controller register accesses for CPUs whose i2c
2519 controller provide such a method. It is called at the end of
2520 i2c_init() to allow i2c_init operations to setup the i2c bus
2521 controller on the CPU (e.g. setting bus speed & slave address).
2522
wdenk0e2bd9c2004-06-06 21:51:03 +00002523 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2524
2525 This option enables configuration of bi_iic_fast[] flags
2526 in u-boot bd_info structure based on u-boot environment
2527 variable "i2cfast". (see also i2cfast)
2528
Ben Warren45657152006-09-07 16:50:54 -04002529 CONFIG_I2C_MULTI_BUS
2530
2531 This option allows the use of multiple I2C buses, each of which
Wolfgang Denk092ae952011-10-26 10:21:21 +00002532 must have a controller. At any point in time, only one bus is
2533 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warren45657152006-09-07 16:50:54 -04002534 Note that bus numbering is zero-based.
2535
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002536 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04002537
2538 This option specifies a list of I2C devices that will be skipped
Wolfgang Denk092ae952011-10-26 10:21:21 +00002539 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser469cde42009-04-18 22:34:03 -05002540 is set, specify a list of bus-device pairs. Otherwise, specify
2541 a 1D array of device addresses
Ben Warren45657152006-09-07 16:50:54 -04002542
2543 e.g.
2544 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denk092ae952011-10-26 10:21:21 +00002545 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04002546
2547 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2548
Wolfgang Denk092ae952011-10-26 10:21:21 +00002549 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002550 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-09-07 16:50:54 -04002551
2552 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2553
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002554 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-11-03 19:15:00 -06002555
2556 If defined, then this indicates the I2C bus number for DDR SPD.
2557 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2558
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002559 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002560
2561 If defined, then this indicates the I2C bus number for the RTC.
2562 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2563
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002564 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002565
2566 If defined, then this indicates the I2C bus number for the DTT.
2567 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2568
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002569 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo31856dd2008-09-09 15:13:29 -07002570
2571 If defined, specifies the I2C address of the DTT device.
2572 If not defined, then U-Boot uses predefined value for
2573 specified DTT device.
2574
Andrew Dyer58c41f92008-12-29 17:36:01 -06002575 CONFIG_SOFT_I2C_READ_REPEATED_START
2576
2577 defining this will force the i2c_read() function in
2578 the soft_i2c driver to perform an I2C repeated start
2579 between writing the address pointer and reading the
2580 data. If this define is omitted the default behaviour
2581 of doing a stop-start sequence will be used. Most I2C
2582 devices can use either method, but some require one or
2583 the other.
Timur Tabiab347542006-11-03 19:15:00 -06002584
wdenkc6097192002-11-03 00:24:07 +00002585- SPI Support: CONFIG_SPI
2586
2587 Enables SPI driver (so far only tested with
2588 SPI EEPROM, also an instance works with Crystal A/D and
2589 D/As on the SACSng board)
2590
Yoshihiro Shimoda65bd9b42011-01-31 16:50:43 +09002591 CONFIG_SH_SPI
2592
2593 Enables the driver for SPI controller on SuperH. Currently
2594 only SH7757 is supported.
2595
wdenkc6097192002-11-03 00:24:07 +00002596 CONFIG_SPI_X
2597
2598 Enables extended (16-bit) SPI EEPROM addressing.
2599 (symmetrical to CONFIG_I2C_X)
2600
2601 CONFIG_SOFT_SPI
2602
wdenk4a5c8a72003-03-06 00:02:04 +00002603 Enables a software (bit-bang) SPI driver rather than
2604 using hardware support. This is a general purpose
2605 driver that only requires three general I/O port pins
2606 (two outputs, one input) to function. If this is
2607 defined, the board configuration must define several
2608 SPI configuration items (port pins to use, etc). For
2609 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002610
Ben Warren7efe9272008-01-16 22:37:35 -05002611 CONFIG_HARD_SPI
2612
2613 Enables a hardware SPI driver for general-purpose reads
2614 and writes. As with CONFIG_SOFT_SPI, the board configuration
2615 must define a list of chip-select function pointers.
Wolfgang Denk092ae952011-10-26 10:21:21 +00002616 Currently supported on some MPC8xxx processors. For an
Ben Warren7efe9272008-01-16 22:37:35 -05002617 example, see include/configs/mpc8349emds.h.
2618
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002619 CONFIG_MXC_SPI
2620
2621 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevamdcd342c2011-10-28 08:57:46 +00002622 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002623
Heiko Schocherb77c8882014-07-14 10:22:11 +02002624 CONFIG_SYS_SPI_MXC_WAIT
2625 Timeout for waiting until spi transfer completed.
2626 default: (CONFIG_SYS_HZ/100) /* 10 ms */
2627
Matthias Fuchsa4400872007-12-27 17:12:34 +01002628- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00002629
Matthias Fuchsa4400872007-12-27 17:12:34 +01002630 Enables FPGA subsystem.
2631
2632 CONFIG_FPGA_<vendor>
2633
2634 Enables support for specific chip vendors.
2635 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00002636
Matthias Fuchsa4400872007-12-27 17:12:34 +01002637 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00002638
Matthias Fuchsa4400872007-12-27 17:12:34 +01002639 Enables support for FPGA family.
2640 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2641
2642 CONFIG_FPGA_COUNT
2643
2644 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002645
Siva Durga Prasad Paladuguadc11de2014-03-14 16:35:38 +05302646 CONFIG_CMD_FPGA_LOADMK
2647
2648 Enable support for fpga loadmk command
2649
Michal Simek64c70982014-05-02 13:43:39 +02002650 CONFIG_CMD_FPGA_LOADP
2651
2652 Enable support for fpga loadp command - load partial bitstream
2653
2654 CONFIG_CMD_FPGA_LOADBP
2655
2656 Enable support for fpga loadbp command - load partial bitstream
2657 (Xilinx only)
2658
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002659 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002660
wdenk57b2d802003-06-27 21:31:46 +00002661 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002662
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002663 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002664
wdenk4a5c8a72003-03-06 00:02:04 +00002665 Enable checks on FPGA configuration interface busy
2666 status by the configuration function. This option
2667 will require a board or device specific function to
2668 be written.
wdenkc6097192002-11-03 00:24:07 +00002669
2670 CONFIG_FPGA_DELAY
2671
2672 If defined, a function that provides delays in the FPGA
2673 configuration driver.
2674
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002675 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002676 Allow Control-C to interrupt FPGA configuration
2677
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002678 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002679
wdenk4a5c8a72003-03-06 00:02:04 +00002680 Check for configuration errors during FPGA bitfile
2681 loading. For example, abort during Virtex II
2682 configuration if the INIT_B line goes low (which
2683 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002684
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002685 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002686
wdenk4a5c8a72003-03-06 00:02:04 +00002687 Maximum time to wait for the INIT_B line to deassert
2688 after PROB_B has been deasserted during a Virtex II
2689 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002690 ms.
wdenkc6097192002-11-03 00:24:07 +00002691
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002692 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002693
wdenk4a5c8a72003-03-06 00:02:04 +00002694 Maximum time to wait for BUSY to deassert during
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002695 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002696
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002697 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002698
wdenk4a5c8a72003-03-06 00:02:04 +00002699 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002700 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002701
2702- Configuration Management:
2703 CONFIG_IDENT_STRING
2704
wdenk4a5c8a72003-03-06 00:02:04 +00002705 If defined, this string will be added to the U-Boot
2706 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002707
2708- Vendor Parameter Protection:
2709
wdenk4a5c8a72003-03-06 00:02:04 +00002710 U-Boot considers the values of the environment
2711 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00002712 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00002713 are set once by the board vendor / manufacturer, and
2714 protects these variables from casual modification by
2715 the user. Once set, these variables are read-only,
2716 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002717 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002718
2719 If CONFIG_ENV_OVERWRITE is #defined in your config
2720 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00002721 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002722 these parameters.
2723
2724 Alternatively, if you #define _both_ CONFIG_ETHADDR
2725 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002726 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002727 which can be changed exactly ONCE by the user. [The
2728 serial# is unaffected by this, i. e. it remains
2729 read-only.]
2730
Joe Hershberger71497d02012-12-11 22:16:31 -06002731 The same can be accomplished in a more flexible way
2732 for any variable by configuring the type of access
2733 to allow for those variables in the ".flags" variable
2734 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2735
wdenkc6097192002-11-03 00:24:07 +00002736- Protected RAM:
2737 CONFIG_PRAM
2738
2739 Define this variable to enable the reservation of
2740 "protected RAM", i. e. RAM which is not overwritten
2741 by U-Boot. Define CONFIG_PRAM to hold the number of
2742 kB you want to reserve for pRAM. You can overwrite
2743 this default value by defining an environment
2744 variable "pram" to the number of kB you want to
2745 reserve. Note that the board info structure will
2746 still show the full amount of RAM. If pRAM is
2747 reserved, a new environment variable "mem" will
2748 automatically be defined to hold the amount of
2749 remaining RAM in a form that can be passed as boot
2750 argument to Linux, for instance like that:
2751
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01002752 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002753 saveenv
2754
2755 This way you can tell Linux not to use this memory,
2756 either, which results in a memory region that will
2757 not be affected by reboots.
2758
2759 *WARNING* If your board configuration uses automatic
2760 detection of the RAM size, you must make sure that
2761 this memory test is non-destructive. So far, the
2762 following board configurations are known to be
2763 "pRAM-clean":
2764
Wolfgang Denk90326762012-10-24 02:36:15 +00002765 IVMS8, IVML24, SPD8xx, TQM8xxL,
2766 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denkcd4e42e2010-10-05 22:54:53 +02002767 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002768
Gabe Blacka2f3a932012-12-02 04:55:18 +00002769- Access to physical memory region (> 4GB)
2770 Some basic support is provided for operations on memory not
2771 normally accessible to U-Boot - e.g. some architectures
2772 support access to more than 4GB of memory on 32-bit
2773 machines using physical address extension or similar.
2774 Define CONFIG_PHYSMEM to access this basic support, which
2775 currently only supports clearing the memory.
2776
wdenkc6097192002-11-03 00:24:07 +00002777- Error Recovery:
2778 CONFIG_PANIC_HANG
2779
2780 Define this variable to stop the system in case of a
2781 fatal error, so that you have to reset it manually.
2782 This is probably NOT a good idea for an embedded
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002783 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002784 automatically as fast as possible, but it may be
2785 useful during development since you can try to debug
2786 the conditions that lead to the situation.
2787
2788 CONFIG_NET_RETRY_COUNT
2789
wdenk4a5c8a72003-03-06 00:02:04 +00002790 This variable defines the number of retries for
2791 network operations like ARP, RARP, TFTP, or BOOTP
2792 before giving up the operation. If not defined, a
2793 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002794
Guennadi Liakhovetskib38c2b32008-04-03 17:04:19 +02002795 CONFIG_ARP_TIMEOUT
2796
2797 Timeout waiting for an ARP reply in milliseconds.
2798
Tetsuyuki Kobayashi147e3902012-07-03 22:25:21 +00002799 CONFIG_NFS_TIMEOUT
2800
2801 Timeout in milliseconds used in NFS protocol.
2802 If you encounter "ERROR: Cannot umount" in nfs command,
2803 try longer timeout such as
2804 #define CONFIG_NFS_TIMEOUT 10000UL
2805
wdenkc6097192002-11-03 00:24:07 +00002806- Command Interpreter:
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002807 CONFIG_AUTO_COMPLETE
wdenk3902d702004-04-15 18:22:41 +00002808
2809 Enable auto completion of commands using TAB.
2810
Wolfgang Denk018147d2006-11-27 15:32:42 +01002811 Note that this feature has NOT been implemented yet
2812 for the "hush" shell.
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002813
2814
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002815 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00002816
2817 Define this variable to enable the "hush" shell (from
2818 Busybox) as command line interpreter, thus enabling
2819 powerful command line syntax like
2820 if...then...else...fi conditionals or `&&' and '||'
2821 constructs ("shell scripts").
2822
2823 If undefined, you get the old, much simpler behaviour
2824 with a somewhat smaller memory footprint.
2825
2826
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002827 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002828
2829 This defines the secondary prompt string, which is
2830 printed when the command interpreter needs more input
2831 to complete a command. Usually "> ".
2832
2833 Note:
2834
wdenk57b2d802003-06-27 21:31:46 +00002835 In the current implementation, the local variables
2836 space and global environment variables space are
2837 separated. Local variables are those you define by
2838 simply typing `name=value'. To access a local
2839 variable later on, you have write `$name' or
2840 `${name}'; to execute the contents of a variable
2841 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002842
wdenk4a5c8a72003-03-06 00:02:04 +00002843 Global environment variables are those you use
2844 setenv/printenv to work with. To run a command stored
2845 in such a variable, you need to use the run command,
2846 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002847
2848 To store commands and special characters in a
2849 variable, please use double quotation marks
2850 surrounding the whole text of the variable, instead
2851 of the backslashes before semicolons and special
2852 symbols.
2853
Wolfgang Denk2039a072006-07-21 11:35:21 +02002854- Commandline Editing and History:
2855 CONFIG_CMDLINE_EDITING
2856
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002857 Enable editing and History functions for interactive
Wolfgang Denkc80857e2006-07-21 11:56:05 +02002858 commandline input operations
Wolfgang Denk2039a072006-07-21 11:35:21 +02002859
wdenkc0aa5c52003-12-06 19:49:23 +00002860- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002861 CONFIG_EXTRA_ENV_SETTINGS
2862
wdenk4a5c8a72003-03-06 00:02:04 +00002863 Define this to contain any number of null terminated
2864 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00002865 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00002866
wdenk4a5c8a72003-03-06 00:02:04 +00002867 For example, place something like this in your
2868 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002869
2870 #define CONFIG_EXTRA_ENV_SETTINGS \
2871 "myvar1=value1\0" \
2872 "myvar2=value2\0"
2873
wdenk4a5c8a72003-03-06 00:02:04 +00002874 Warning: This method is based on knowledge about the
2875 internal format how the environment is stored by the
2876 U-Boot code. This is NOT an official, exported
2877 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00002878 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002879 You better know what you are doing here.
2880
wdenk4a5c8a72003-03-06 00:02:04 +00002881 Note: overly (ab)use of the default environment is
2882 discouraged. Make sure to check other ways to preset
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002883 the environment like the "source" command or the
wdenk4a5c8a72003-03-06 00:02:04 +00002884 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002885
Stephen Warren1465d5f2012-05-22 09:21:54 +00002886 CONFIG_ENV_VARS_UBOOT_CONFIG
2887
2888 Define this in order to add variables describing the
2889 U-Boot build configuration to the default environment.
2890 These will be named arch, cpu, board, vendor, and soc.
2891
2892 Enabling this option will cause the following to be defined:
2893
2894 - CONFIG_SYS_ARCH
2895 - CONFIG_SYS_CPU
2896 - CONFIG_SYS_BOARD
2897 - CONFIG_SYS_VENDOR
2898 - CONFIG_SYS_SOC
2899
Tom Rini4c8cc9b2012-10-24 07:28:16 +00002900 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2901
2902 Define this in order to add variables describing certain
2903 run-time determined information about the hardware to the
2904 environment. These will be named board_name, board_rev.
2905
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002906 CONFIG_DELAY_ENVIRONMENT
2907
2908 Normally the environment is loaded when the board is
2909 intialised so that it is available to U-Boot. This inhibits
2910 that so that the environment is not available until
2911 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2912 this is instead controlled by the value of
2913 /config/load-environment.
2914
wdenkc0aa5c52003-12-06 19:49:23 +00002915- DataFlash Support:
wdenk381669a2003-06-16 23:50:08 +00002916 CONFIG_HAS_DATAFLASH
2917
wdenk57b2d802003-06-27 21:31:46 +00002918 Defining this option enables DataFlash features and
2919 allows to read/write in Dataflash via the standard
2920 commands cp, md...
wdenk381669a2003-06-16 23:50:08 +00002921
Eric Nelson97f5f8f2012-01-31 10:52:08 -07002922- Serial Flash support
2923 CONFIG_CMD_SF
2924
2925 Defining this option enables SPI flash commands
2926 'sf probe/read/write/erase/update'.
2927
2928 Usage requires an initial 'probe' to define the serial
2929 flash parameters, followed by read/write/erase/update
2930 commands.
2931
2932 The following defaults may be provided by the platform
2933 to handle the common case when only a single serial
2934 flash is present on the system.
2935
2936 CONFIG_SF_DEFAULT_BUS Bus identifier
2937 CONFIG_SF_DEFAULT_CS Chip-select
2938 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2939 CONFIG_SF_DEFAULT_SPEED in Hz
2940
Simon Glass4b5545e2012-10-08 13:16:02 +00002941 CONFIG_CMD_SF_TEST
2942
2943 Define this option to include a destructive SPI flash
2944 test ('sf test').
2945
Jagannadha Sutradharudu Tekic6d173d2013-06-19 15:33:58 +05302946 CONFIG_SPI_FLASH_BAR Ban/Extended Addr Reg
2947
2948 Define this option to use the Bank addr/Extended addr
2949 support on SPI flashes which has size > 16Mbytes.
2950
Jagannadha Sutradharudu Tekid7f253b2014-01-11 15:25:04 +05302951 CONFIG_SF_DUAL_FLASH Dual flash memories
2952
2953 Define this option to use dual flash support where two flash
2954 memories can be connected with a given cs line.
2955 currently Xilinx Zynq qspi support these type of connections.
2956
Heiko Schocherd73b7ec2014-07-18 06:07:21 +02002957 CONFIG_SYS_SPI_ST_ENABLE_WP_PIN
2958 enable the W#/Vpp signal to disable writing to the status
2959 register on ST MICRON flashes like the N25Q128.
2960 The status register write enable/disable bit, combined with
2961 the W#/VPP signal provides hardware data protection for the
2962 device as follows: When the enable/disable bit is set to 1,
2963 and the W#/VPP signal is driven LOW, the status register
2964 nonvolatile bits become read-only and the WRITE STATUS REGISTER
2965 operation will not execute. The only way to exit this
2966 hardware-protected mode is to drive W#/VPP HIGH.
2967
wdenkef893942004-02-23 16:11:30 +00002968- SystemACE Support:
2969 CONFIG_SYSTEMACE
2970
2971 Adding this option adds support for Xilinx SystemACE
2972 chips attached via some sort of local bus. The address
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002973 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002974 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenkef893942004-02-23 16:11:30 +00002975
2976 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002977 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenkef893942004-02-23 16:11:30 +00002978
2979 When SystemACE support is added, the "ace" device type
2980 becomes available to the fat commands, i.e. fatls.
2981
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002982- TFTP Fixed UDP Port:
2983 CONFIG_TFTP_PORT
2984
Wolfgang Denk227b5192005-09-24 23:25:46 +02002985 If this is defined, the environment variable tftpsrcp
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002986 is used to supply the TFTP UDP source port value.
Wolfgang Denk227b5192005-09-24 23:25:46 +02002987 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002988 number generator is used.
2989
Wolfgang Denk227b5192005-09-24 23:25:46 +02002990 Also, the environment variable tftpdstp is used to supply
2991 the TFTP UDP destination port value. If tftpdstp isn't
2992 defined, the normal port 69 is used.
2993
2994 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002995 blindly start the TFTP transfer using the pre-configured
2996 target IP address and UDP port. This has the effect of
2997 "punching through" the (Windows XP) firewall, allowing
2998 the remainder of the TFTP transfer to proceed normally.
2999 A better solution is to properly configure the firewall,
3000 but sometimes that is not allowed.
3001
Simon Glass058bb8d2012-12-05 14:46:38 +00003002- Hashing support:
3003 CONFIG_CMD_HASH
3004
3005 This enables a generic 'hash' command which can produce
3006 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
3007
3008 CONFIG_HASH_VERIFY
3009
3010 Enable the hash verify command (hash -v). This adds to code
3011 size a little.
3012
3013 CONFIG_SHA1 - support SHA1 hashing
3014 CONFIG_SHA256 - support SHA256 hashing
3015
3016 Note: There is also a sha1sum command, which should perhaps
3017 be deprecated in favour of 'hash sha1'.
3018
Robert Winkler765ccf42013-07-24 17:57:06 -07003019- Freescale i.MX specific commands:
3020 CONFIG_CMD_HDMIDETECT
3021 This enables 'hdmidet' command which returns true if an
3022 HDMI monitor is detected. This command is i.MX 6 specific.
3023
3024 CONFIG_CMD_BMODE
3025 This enables the 'bmode' (bootmode) command for forcing
3026 a boot from specific media.
3027
3028 This is useful for forcing the ROM's usb downloader to
3029 activate upon a watchdog reset which is nice when iterating
3030 on U-Boot. Using the reset button or running bmode normal
3031 will set it back to normal. This command currently
3032 supports i.MX53 and i.MX6.
3033
Simon Glass35191a32013-06-13 15:10:02 -07003034- Signing support:
3035 CONFIG_RSA
3036
3037 This enables the RSA algorithm used for FIT image verification
Detlev Zundel49dc73b2014-01-20 16:21:46 +01003038 in U-Boot. See doc/uImage.FIT/signature.txt for more information.
Simon Glass35191a32013-06-13 15:10:02 -07003039
3040 The signing part is build into mkimage regardless of this
3041 option.
3042
Heiko Schocher443ca402014-01-25 07:27:13 +01003043- bootcount support:
3044 CONFIG_BOOTCOUNT_LIMIT
3045
3046 This enables the bootcounter support, see:
3047 http://www.denx.de/wiki/DULG/UBootBootCountLimit
3048
3049 CONFIG_AT91SAM9XE
3050 enable special bootcounter support on at91sam9xe based boards.
3051 CONFIG_BLACKFIN
3052 enable special bootcounter support on blackfin based boards.
3053 CONFIG_SOC_DA8XX
3054 enable special bootcounter support on da850 based boards.
3055 CONFIG_BOOTCOUNT_RAM
3056 enable support for the bootcounter in RAM
3057 CONFIG_BOOTCOUNT_I2C
3058 enable support for the bootcounter on an i2c (like RTC) device.
3059 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
3060 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
3061 the bootcounter.
3062 CONFIG_BOOTCOUNT_ALEN = address len
Simon Glass35191a32013-06-13 15:10:02 -07003063
wdenkc0aa5c52003-12-06 19:49:23 +00003064- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00003065 CONFIG_SHOW_BOOT_PROGRESS
3066
wdenk4a5c8a72003-03-06 00:02:04 +00003067 Defining this option allows to add some board-
3068 specific code (calling a user-provided function
3069 "show_boot_progress(int)") that enables you to show
3070 the system's boot progress on some display (for
3071 example, some LED's) on your board. At the moment,
3072 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00003073
Simon Glass31a870e2012-02-13 13:51:19 +00003074- Detailed boot stage timing
3075 CONFIG_BOOTSTAGE
3076 Define this option to get detailed timing of each stage
3077 of the boot process.
3078
3079 CONFIG_BOOTSTAGE_USER_COUNT
3080 This is the number of available user bootstage records.
3081 Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
3082 a new ID will be allocated from this stash. If you exceed
3083 the limit, recording will stop.
3084
3085 CONFIG_BOOTSTAGE_REPORT
3086 Define this to print a report before boot, similar to this:
3087
3088 Timer summary in microseconds:
3089 Mark Elapsed Stage
3090 0 0 reset
3091 3,575,678 3,575,678 board_init_f start
3092 3,575,695 17 arch_cpu_init A9
3093 3,575,777 82 arch_cpu_init done
3094 3,659,598 83,821 board_init_r start
3095 3,910,375 250,777 main_loop
3096 29,916,167 26,005,792 bootm_start
3097 30,361,327 445,160 start_kernel
3098
Simon Glass4afd88e2012-09-28 08:56:39 +00003099 CONFIG_CMD_BOOTSTAGE
3100 Add a 'bootstage' command which supports printing a report
3101 and un/stashing of bootstage data.
3102
Simon Glass0fa36a42012-09-28 08:56:37 +00003103 CONFIG_BOOTSTAGE_FDT
3104 Stash the bootstage information in the FDT. A root 'bootstage'
3105 node is created with each bootstage id as a child. Each child
3106 has a 'name' property and either 'mark' containing the
3107 mark time in microsecond, or 'accum' containing the
3108 accumulated time for that bootstage id in microseconds.
3109 For example:
3110
3111 bootstage {
3112 154 {
3113 name = "board_init_f";
3114 mark = <3575678>;
3115 };
3116 170 {
3117 name = "lcd";
3118 accum = <33482>;
3119 };
3120 };
3121
3122 Code in the Linux kernel can find this in /proc/devicetree.
3123
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003124Legacy uImage format:
3125
wdenkc6097192002-11-03 00:24:07 +00003126 Arg Where When
3127 1 common/cmd_bootm.c before attempting to boot an image
wdenk544e9732004-02-06 23:19:44 +00003128 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00003129 2 common/cmd_bootm.c Image header has correct magic number
wdenk544e9732004-02-06 23:19:44 +00003130 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003131 3 common/cmd_bootm.c Image header has correct checksum
wdenk544e9732004-02-06 23:19:44 +00003132 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003133 4 common/cmd_bootm.c Image data has correct checksum
3134 -4 common/cmd_bootm.c Image is for unsupported architecture
3135 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003136 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00003137 6 common/cmd_bootm.c Image Type check OK
3138 -6 common/cmd_bootm.c gunzip uncompression error
3139 -7 common/cmd_bootm.c Unimplemented compression type
3140 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003141 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00003142 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003143
3144 9 common/image.c Start initial ramdisk verification
3145 -10 common/image.c Ramdisk header has bad magic number
3146 -11 common/image.c Ramdisk header has bad checksum
3147 10 common/image.c Ramdisk header is OK
3148 -12 common/image.c Ramdisk data has bad checksum
3149 11 common/image.c Ramdisk data has correct checksum
3150 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003151 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003152 13 common/image.c Start multifile image verification
3153 14 common/image.c No initial ramdisk, no multifile, continue.
3154
Wolfgang Denk092ae952011-10-26 10:21:21 +00003155 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00003156
Stefan Roese88fbf932010-04-15 16:07:28 +02003157 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenkd729d302004-02-27 00:07:27 +00003158 -31 post/post.c POST test failed, detected by post_output_backlog()
3159 -32 post/post.c POST test failed, detected by post_run_single()
wdenke97d3d92004-02-23 22:22:28 +00003160
Heiko Schocher633e03a2007-06-22 19:11:54 +02003161 34 common/cmd_doc.c before loading a Image from a DOC device
3162 -35 common/cmd_doc.c Bad usage of "doc" command
3163 35 common/cmd_doc.c correct usage of "doc" command
3164 -36 common/cmd_doc.c No boot device
3165 36 common/cmd_doc.c correct boot device
3166 -37 common/cmd_doc.c Unknown Chip ID on boot device
3167 37 common/cmd_doc.c correct chip ID found, device available
3168 -38 common/cmd_doc.c Read Error on boot device
3169 38 common/cmd_doc.c reading Image header from DOC device OK
3170 -39 common/cmd_doc.c Image header has bad magic number
3171 39 common/cmd_doc.c Image header has correct magic number
3172 -40 common/cmd_doc.c Error reading Image from DOC device
3173 40 common/cmd_doc.c Image header has correct magic number
3174 41 common/cmd_ide.c before loading a Image from a IDE device
3175 -42 common/cmd_ide.c Bad usage of "ide" command
3176 42 common/cmd_ide.c correct usage of "ide" command
3177 -43 common/cmd_ide.c No boot device
3178 43 common/cmd_ide.c boot device found
3179 -44 common/cmd_ide.c Device not available
3180 44 common/cmd_ide.c Device available
3181 -45 common/cmd_ide.c wrong partition selected
3182 45 common/cmd_ide.c partition selected
3183 -46 common/cmd_ide.c Unknown partition table
3184 46 common/cmd_ide.c valid partition table found
3185 -47 common/cmd_ide.c Invalid partition type
3186 47 common/cmd_ide.c correct partition type
3187 -48 common/cmd_ide.c Error reading Image Header on boot device
3188 48 common/cmd_ide.c reading Image Header from IDE device OK
3189 -49 common/cmd_ide.c Image header has bad magic number
3190 49 common/cmd_ide.c Image header has correct magic number
3191 -50 common/cmd_ide.c Image header has bad checksum
3192 50 common/cmd_ide.c Image header has correct checksum
3193 -51 common/cmd_ide.c Error reading Image from IDE device
3194 51 common/cmd_ide.c reading Image from IDE device OK
3195 52 common/cmd_nand.c before loading a Image from a NAND device
3196 -53 common/cmd_nand.c Bad usage of "nand" command
3197 53 common/cmd_nand.c correct usage of "nand" command
3198 -54 common/cmd_nand.c No boot device
3199 54 common/cmd_nand.c boot device found
3200 -55 common/cmd_nand.c Unknown Chip ID on boot device
3201 55 common/cmd_nand.c correct chip ID found, device available
3202 -56 common/cmd_nand.c Error reading Image Header on boot device
3203 56 common/cmd_nand.c reading Image Header from NAND device OK
3204 -57 common/cmd_nand.c Image header has bad magic number
3205 57 common/cmd_nand.c Image header has correct magic number
3206 -58 common/cmd_nand.c Error reading Image from NAND device
3207 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00003208
Heiko Schocher633e03a2007-06-22 19:11:54 +02003209 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00003210
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003211 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher633e03a2007-06-22 19:11:54 +02003212 -64 net/eth.c no Ethernet found.
3213 65 net/eth.c Ethernet found.
wdenkc6097192002-11-03 00:24:07 +00003214
Heiko Schocher633e03a2007-06-22 19:11:54 +02003215 -80 common/cmd_net.c usage wrong
3216 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003217 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher633e03a2007-06-22 19:11:54 +02003218 81 common/cmd_net.c NetLoop() back without error
3219 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
3220 82 common/cmd_net.c trying automatic boot
Wolfgang Denk85c25df2009-04-01 23:34:12 +02003221 83 common/cmd_net.c running "source" command
3222 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher633e03a2007-06-22 19:11:54 +02003223 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00003224
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003225FIT uImage format:
3226
3227 Arg Where When
3228 100 common/cmd_bootm.c Kernel FIT Image has correct format
3229 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
3230 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
3231 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
3232 102 common/cmd_bootm.c Kernel unit name specified
3233 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +01003234 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003235 104 common/cmd_bootm.c Got kernel subimage node offset
3236 -104 common/cmd_bootm.c Kernel subimage hash verification failed
3237 105 common/cmd_bootm.c Kernel subimage hash verification OK
3238 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
3239 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003240 -106 common/cmd_bootm.c Kernel subimage has wrong type
3241 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003242 -107 common/cmd_bootm.c Can't get kernel subimage data/size
3243 108 common/cmd_bootm.c Got kernel subimage data/size
3244 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
3245 -109 common/cmd_bootm.c Can't get kernel subimage type
3246 -110 common/cmd_bootm.c Can't get kernel subimage comp
3247 -111 common/cmd_bootm.c Can't get kernel subimage os
3248 -112 common/cmd_bootm.c Can't get kernel subimage load address
3249 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
3250
3251 120 common/image.c Start initial ramdisk verification
3252 -120 common/image.c Ramdisk FIT image has incorrect format
3253 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003254 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003255 -122 common/image.c Can't get configuration for ramdisk subimage
3256 123 common/image.c Ramdisk unit name specified
3257 -124 common/image.c Can't get ramdisk subimage node offset
3258 125 common/image.c Got ramdisk subimage node offset
3259 -125 common/image.c Ramdisk subimage hash verification failed
3260 126 common/image.c Ramdisk subimage hash verification OK
3261 -126 common/image.c Ramdisk subimage for unsupported architecture
3262 127 common/image.c Architecture check OK
3263 -127 common/image.c Can't get ramdisk subimage data/size
3264 128 common/image.c Got ramdisk subimage data/size
3265 129 common/image.c Can't get ramdisk load address
3266 -129 common/image.c Got ramdisk load address
3267
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003268 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003269 131 common/cmd_doc.c FIT image format OK
3270
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003271 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003272 141 common/cmd_ide.c FIT image format OK
3273
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003274 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003275 151 common/cmd_nand.c FIT image format OK
3276
Heiko Schocher515eb122014-05-28 11:33:33 +02003277- legacy image format:
3278 CONFIG_IMAGE_FORMAT_LEGACY
3279 enables the legacy image format support in U-Boot.
3280
3281 Default:
3282 enabled if CONFIG_FIT_SIGNATURE is not defined.
3283
3284 CONFIG_DISABLE_IMAGE_LEGACY
3285 disable the legacy image format
3286
3287 This define is introduced, as the legacy image format is
3288 enabled per default for backward compatibility.
3289
Gabe Blackd572e162012-10-25 16:31:10 +00003290- FIT image support:
3291 CONFIG_FIT
3292 Enable support for the FIT uImage format.
3293
3294 CONFIG_FIT_BEST_MATCH
3295 When no configuration is explicitly selected, default to the
3296 one whose fdt's compatibility field best matches that of
3297 U-Boot itself. A match is considered "best" if it matches the
3298 most specific compatibility entry of U-Boot's fdt's root node.
3299 The order of entries in the configuration's fdt is ignored.
3300
Simon Glass58fe7e52013-06-13 15:10:00 -07003301 CONFIG_FIT_SIGNATURE
3302 This option enables signature verification of FIT uImages,
3303 using a hash signed and verified using RSA. See
3304 doc/uImage.FIT/signature.txt for more details.
3305
Heiko Schocher515eb122014-05-28 11:33:33 +02003306 WARNING: When relying on signed FIT images with required
3307 signature check the legacy image format is default
3308 disabled. If a board need legacy image format support
3309 enable this through CONFIG_IMAGE_FORMAT_LEGACY
3310
Dirk Eibach88919ca2014-07-03 09:28:26 +02003311 CONFIG_FIT_DISABLE_SHA256
3312 Supporting SHA256 hashes has quite an impact on binary size.
3313 For constrained systems sha256 hash support can be disabled
3314 with this option.
3315
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003316- Standalone program support:
3317 CONFIG_STANDALONE_LOAD_ADDR
3318
Wolfgang Denk23f78482011-10-09 21:06:34 +02003319 This option defines a board specific value for the
3320 address where standalone program gets loaded, thus
3321 overwriting the architecture dependent default
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003322 settings.
3323
3324- Frame Buffer Address:
3325 CONFIG_FB_ADDR
3326
3327 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denka71eb8e2013-01-03 00:43:59 +00003328 address for frame buffer. This is typically the case
3329 when using a graphics controller has separate video
3330 memory. U-Boot will then place the frame buffer at
3331 the given address instead of dynamically reserving it
3332 in system RAM by calling lcd_setmem(), which grabs
3333 the memory for the frame buffer depending on the
3334 configured panel size.
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003335
3336 Please see board_init_f function.
3337
Detlev Zundel0ecb6112009-12-01 17:16:19 +01003338- Automatic software updates via TFTP server
3339 CONFIG_UPDATE_TFTP
3340 CONFIG_UPDATE_TFTP_CNT_MAX
3341 CONFIG_UPDATE_TFTP_MSEC_MAX
3342
3343 These options enable and control the auto-update feature;
3344 for a more detailed description refer to doc/README.update.
3345
3346- MTD Support (mtdparts command, UBI support)
3347 CONFIG_MTD_DEVICE
3348
3349 Adds the MTD device infrastructure from the Linux kernel.
3350 Needed for mtdparts command support.
3351
3352 CONFIG_MTD_PARTITIONS
3353
3354 Adds the MTD partitioning infrastructure from the Linux
3355 kernel. Needed for UBI support.
3356
Heiko Schocherf5895d12014-06-24 10:10:04 +02003357 CONFIG_MTD_NAND_VERIFY_WRITE
3358 verify if the written data is correct reread.
3359
Joe Hershberger7d80fc12013-04-08 10:32:48 +00003360- UBI support
3361 CONFIG_CMD_UBI
3362
3363 Adds commands for interacting with MTD partitions formatted
3364 with the UBI flash translation layer
3365
3366 Requires also defining CONFIG_RBTREE
3367
Joe Hershberger47550fc2013-04-08 10:32:49 +00003368 CONFIG_UBI_SILENCE_MSG
3369
3370 Make the verbose messages from UBI stop printing. This leaves
3371 warnings and errors enabled.
3372
Heiko Schocherf5895d12014-06-24 10:10:04 +02003373
3374 CONFIG_MTD_UBI_WL_THRESHOLD
3375 This parameter defines the maximum difference between the highest
3376 erase counter value and the lowest erase counter value of eraseblocks
3377 of UBI devices. When this threshold is exceeded, UBI starts performing
3378 wear leveling by means of moving data from eraseblock with low erase
3379 counter to eraseblocks with high erase counter.
3380
3381 The default value should be OK for SLC NAND flashes, NOR flashes and
3382 other flashes which have eraseblock life-cycle 100000 or more.
3383 However, in case of MLC NAND flashes which typically have eraseblock
3384 life-cycle less than 10000, the threshold should be lessened (e.g.,
3385 to 128 or 256, although it does not have to be power of 2).
3386
3387 default: 4096
3388
3389 CONFIG_MTD_UBI_BEB_LIMIT
3390 This option specifies the maximum bad physical eraseblocks UBI
3391 expects on the MTD device (per 1024 eraseblocks). If the
3392 underlying flash does not admit of bad eraseblocks (e.g. NOR
3393 flash), this value is ignored.
3394
3395 NAND datasheets often specify the minimum and maximum NVM
3396 (Number of Valid Blocks) for the flashes' endurance lifetime.
3397 The maximum expected bad eraseblocks per 1024 eraseblocks
3398 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
3399 which gives 20 for most NANDs (MaxNVB is basically the total
3400 count of eraseblocks on the chip).
3401
3402 To put it differently, if this value is 20, UBI will try to
3403 reserve about 1.9% of physical eraseblocks for bad blocks
3404 handling. And that will be 1.9% of eraseblocks on the entire
3405 NAND chip, not just the MTD partition UBI attaches. This means
3406 that if you have, say, a NAND flash chip admits maximum 40 bad
3407 eraseblocks, and it is split on two MTD partitions of the same
3408 size, UBI will reserve 40 eraseblocks when attaching a
3409 partition.
3410
3411 default: 20
3412
3413 CONFIG_MTD_UBI_FASTMAP
3414 Fastmap is a mechanism which allows attaching an UBI device
3415 in nearly constant time. Instead of scanning the whole MTD device it
3416 only has to locate a checkpoint (called fastmap) on the device.
3417 The on-flash fastmap contains all information needed to attach
3418 the device. Using fastmap makes only sense on large devices where
3419 attaching by scanning takes long. UBI will not automatically install
3420 a fastmap on old images, but you can set the UBI parameter
3421 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
3422 that fastmap-enabled images are still usable with UBI implementations
3423 without fastmap support. On typical flash devices the whole fastmap
3424 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
3425
3426 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
3427 Set this parameter to enable fastmap automatically on images
3428 without a fastmap.
3429 default: 0
3430
Joe Hershberger7d80fc12013-04-08 10:32:48 +00003431- UBIFS support
3432 CONFIG_CMD_UBIFS
3433
3434 Adds commands for interacting with UBI volumes formatted as
3435 UBIFS. UBIFS is read-only in u-boot.
3436
3437 Requires UBI support as well as CONFIG_LZO
3438
Joe Hershberger47550fc2013-04-08 10:32:49 +00003439 CONFIG_UBIFS_SILENCE_MSG
3440
3441 Make the verbose messages from UBIFS stop printing. This leaves
3442 warnings and errors enabled.
3443
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003444- SPL framework
Wolfgang Denk825223d2011-09-11 21:24:09 +02003445 CONFIG_SPL
3446 Enable building of SPL globally.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003447
Tom Rini36853852012-02-14 07:29:40 +00003448 CONFIG_SPL_LDSCRIPT
3449 LDSCRIPT for linking the SPL binary.
3450
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003451 CONFIG_SPL_MAX_FOOTPRINT
3452 Maximum size in memory allocated to the SPL, BSS included.
3453 When defined, the linker checks that the actual memory
3454 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00003455 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003456 must not be both defined at the same time.
3457
Tom Rini36853852012-02-14 07:29:40 +00003458 CONFIG_SPL_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003459 Maximum size of the SPL image (text, data, rodata, and
3460 linker lists sections), BSS excluded.
3461 When defined, the linker checks that the actual size does
3462 not exceed it.
Tom Rini36853852012-02-14 07:29:40 +00003463
Wolfgang Denk825223d2011-09-11 21:24:09 +02003464 CONFIG_SPL_TEXT_BASE
3465 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003466
Scott Woodc4f0d002012-09-20 19:05:12 -05003467 CONFIG_SPL_RELOC_TEXT_BASE
3468 Address to relocate to. If unspecified, this is equal to
3469 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
3470
Tom Rini36853852012-02-14 07:29:40 +00003471 CONFIG_SPL_BSS_START_ADDR
3472 Link address for the BSS within the SPL binary.
3473
3474 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003475 Maximum size in memory allocated to the SPL BSS.
3476 When defined, the linker checks that the actual memory used
3477 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00003478 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003479 must not be both defined at the same time.
Tom Rini36853852012-02-14 07:29:40 +00003480
3481 CONFIG_SPL_STACK
3482 Adress of the start of the stack SPL will use
3483
Scott Woodc4f0d002012-09-20 19:05:12 -05003484 CONFIG_SPL_RELOC_STACK
3485 Adress of the start of the stack SPL will use after
3486 relocation. If unspecified, this is equal to
3487 CONFIG_SPL_STACK.
3488
Tom Rini36853852012-02-14 07:29:40 +00003489 CONFIG_SYS_SPL_MALLOC_START
3490 Starting address of the malloc pool used in SPL.
3491
3492 CONFIG_SYS_SPL_MALLOC_SIZE
3493 The size of the malloc pool used in SPL.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003494
Tom Rini28591df2012-08-13 12:03:19 -07003495 CONFIG_SPL_FRAMEWORK
3496 Enable the SPL framework under common/. This framework
3497 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3498 NAND loading of the Linux Kernel.
3499
Tom Rinic2b76002014-03-28 12:03:39 -04003500 CONFIG_SPL_OS_BOOT
3501 Enable booting directly to an OS from SPL.
3502 See also: doc/README.falcon
3503
Tom Rinife3b0c72012-08-13 11:37:56 -07003504 CONFIG_SPL_DISPLAY_PRINT
3505 For ARM, enable an optional function to print more information
3506 about the running system.
3507
Scott Wood7c810902012-09-20 16:35:21 -05003508 CONFIG_SPL_INIT_MINIMAL
3509 Arch init code should be built for a very small image
3510
Wolfgang Denk825223d2011-09-11 21:24:09 +02003511 CONFIG_SPL_LIBCOMMON_SUPPORT
3512 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003513
Wolfgang Denk825223d2011-09-11 21:24:09 +02003514 CONFIG_SPL_LIBDISK_SUPPORT
3515 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003516
Wolfgang Denk825223d2011-09-11 21:24:09 +02003517 CONFIG_SPL_I2C_SUPPORT
3518 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003519
Wolfgang Denk825223d2011-09-11 21:24:09 +02003520 CONFIG_SPL_GPIO_SUPPORT
3521 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003522
Wolfgang Denk825223d2011-09-11 21:24:09 +02003523 CONFIG_SPL_MMC_SUPPORT
3524 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003525
Tom Rini36853852012-02-14 07:29:40 +00003526 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
3527 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
3528 CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
3529 Address, size and partition on the MMC to load U-Boot from
3530 when the MMC is being used in raw mode.
3531
Peter Korsgaard01b542f2013-05-13 08:36:29 +00003532 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3533 Sector to load kernel uImage from when MMC is being
3534 used in raw mode (for Falcon mode)
3535
3536 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3537 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3538 Sector and number of sectors to load kernel argument
3539 parameters from when MMC is being used in raw mode
3540 (for falcon mode)
3541
Tom Rini36853852012-02-14 07:29:40 +00003542 CONFIG_SPL_FAT_SUPPORT
3543 Support for fs/fat/libfat.o in SPL binary
3544
3545 CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
3546 Filename to read to load U-Boot when reading from FAT
3547
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003548 CONFIG_SPL_FAT_LOAD_KERNEL_NAME
3549 Filename to read to load kernel uImage when reading
3550 from FAT (for Falcon mode)
3551
3552 CONFIG_SPL_FAT_LOAD_ARGS_NAME
3553 Filename to read to load kernel argument parameters
3554 when reading from FAT (for Falcon mode)
3555
Scott Wood2b36fbb2012-12-06 13:33:17 +00003556 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3557 Set this for NAND SPL on PPC mpc83xx targets, so that
3558 start.S waits for the rest of the SPL to load before
3559 continuing (the hardware starts execution after just
3560 loading the first page rather than the full 4K).
3561
Prabhakar Kushwaha6e2b9a32014-04-08 19:12:31 +05303562 CONFIG_SPL_SKIP_RELOCATE
3563 Avoid SPL relocation
3564
Scott Woodc352a0c2012-09-20 19:09:07 -05003565 CONFIG_SPL_NAND_BASE
3566 Include nand_base.c in the SPL. Requires
3567 CONFIG_SPL_NAND_DRIVERS.
3568
3569 CONFIG_SPL_NAND_DRIVERS
3570 SPL uses normal NAND drivers, not minimal drivers.
3571
3572 CONFIG_SPL_NAND_ECC
3573 Include standard software ECC in the SPL
3574
Tom Rini36853852012-02-14 07:29:40 +00003575 CONFIG_SPL_NAND_SIMPLE
Scott Wood36c440e2012-09-21 18:35:27 -05003576 Support for NAND boot using simple NAND drivers that
3577 expose the cmd_ctrl() interface.
Tom Rini36853852012-02-14 07:29:40 +00003578
Tom Rini543c9f12014-03-28 12:03:36 -04003579 CONFIG_SPL_MTD_SUPPORT
3580 Support for the MTD subsystem within SPL. Useful for
3581 environment on NAND support within SPL.
3582
Ying Zhang9ff70262013-08-16 15:16:11 +08003583 CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3584 Set for the SPL on PPC mpc8xxx targets, support for
York Sunf0626592013-09-30 09:22:09 -07003585 drivers/ddr/fsl/libddr.o in SPL binary.
Ying Zhang9ff70262013-08-16 15:16:11 +08003586
Ying Zhangdfb2b152013-08-16 15:16:12 +08003587 CONFIG_SPL_COMMON_INIT_DDR
3588 Set for common ddr init with serial presence detect in
3589 SPL binary.
3590
Tom Rini36853852012-02-14 07:29:40 +00003591 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3592 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3593 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3594 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3595 CONFIG_SYS_NAND_ECCBYTES
3596 Defines the size and behavior of the NAND that SPL uses
Scott Wood36c440e2012-09-21 18:35:27 -05003597 to read U-Boot
Tom Rini36853852012-02-14 07:29:40 +00003598
Prabhakar Kushwahaafffcb02013-12-11 12:42:11 +05303599 CONFIG_SPL_NAND_BOOT
3600 Add support NAND boot
3601
Tom Rini36853852012-02-14 07:29:40 +00003602 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood36c440e2012-09-21 18:35:27 -05003603 Location in NAND to read U-Boot from
3604
3605 CONFIG_SYS_NAND_U_BOOT_DST
3606 Location in memory to load U-Boot to
3607
3608 CONFIG_SYS_NAND_U_BOOT_SIZE
3609 Size of image to load
Tom Rini36853852012-02-14 07:29:40 +00003610
3611 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood36c440e2012-09-21 18:35:27 -05003612 Entry point in loaded image to jump to
Tom Rini36853852012-02-14 07:29:40 +00003613
3614 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3615 Define this if you need to first read the OOB and then the
3616 data. This is used for example on davinci plattforms.
3617
3618 CONFIG_SPL_OMAP3_ID_NAND
3619 Support for an OMAP3-specific set of functions to return the
3620 ID and MFR of the first attached NAND chip, if present.
3621
Wolfgang Denk825223d2011-09-11 21:24:09 +02003622 CONFIG_SPL_SERIAL_SUPPORT
3623 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003624
Wolfgang Denk825223d2011-09-11 21:24:09 +02003625 CONFIG_SPL_SPI_FLASH_SUPPORT
3626 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003627
Wolfgang Denk825223d2011-09-11 21:24:09 +02003628 CONFIG_SPL_SPI_SUPPORT
3629 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003630
Pavel Machekde997252012-08-30 22:42:11 +02003631 CONFIG_SPL_RAM_DEVICE
3632 Support for running image already present in ram, in SPL binary
3633
Wolfgang Denk825223d2011-09-11 21:24:09 +02003634 CONFIG_SPL_LIBGENERIC_SUPPORT
3635 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003636
Ying Zhang602f7d32013-05-20 14:07:25 +08003637 CONFIG_SPL_ENV_SUPPORT
3638 Support for the environment operating in SPL binary
3639
3640 CONFIG_SPL_NET_SUPPORT
3641 Support for the net/libnet.o in SPL binary.
3642 It conflicts with SPL env from storage medium specified by
3643 CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3644
Scott Woodeb7bd972012-12-06 13:33:16 +00003645 CONFIG_SPL_PAD_TO
Benoît Thébaudeauf0180722013-04-11 09:35:49 +00003646 Image offset to which the SPL should be padded before appending
3647 the SPL payload. By default, this is defined as
3648 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3649 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3650 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Woodeb7bd972012-12-06 13:33:16 +00003651
Scott Woodf147eb72012-09-21 16:27:32 -05003652 CONFIG_SPL_TARGET
3653 Final target image containing SPL and payload. Some SPLs
3654 use an arch-specific makefile fragment instead, for
3655 example if more than one image needs to be produced.
3656
Simon Glass82d94532013-05-08 08:05:59 +00003657 CONFIG_FIT_SPL_PRINT
3658 Printing information about a FIT image adds quite a bit of
3659 code to SPL. So this is normally disabled in SPL. Use this
3660 option to re-enable it. This will affect the output of the
3661 bootm command when booting a FIT image.
3662
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003663- TPL framework
3664 CONFIG_TPL
3665 Enable building of TPL globally.
3666
3667 CONFIG_TPL_PAD_TO
3668 Image offset to which the TPL should be padded before appending
3669 the TPL payload. By default, this is defined as
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02003670 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3671 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3672 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003673
wdenkc6097192002-11-03 00:24:07 +00003674Modem Support:
3675--------------
3676
Wolfgang Denk8f399b32011-05-01 20:44:23 +02003677[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00003678
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003679- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00003680 CONFIG_MODEM_SUPPORT
3681
3682- RTS/CTS Flow control enable:
3683 CONFIG_HWFLOW
3684
3685- Modem debug support:
3686 CONFIG_MODEM_SUPPORT_DEBUG
3687
wdenk4a5c8a72003-03-06 00:02:04 +00003688 Enables debugging stuff (char screen[1024], dbg())
3689 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00003690
wdenkc0aa5c52003-12-06 19:49:23 +00003691- Interrupt support (PPC):
3692
wdenk1ebf41e2004-01-02 14:00:00 +00003693 There are common interrupt_init() and timer_interrupt()
3694 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003695 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00003696 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003697 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00003698 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003699 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00003700 specific handling. If board has watchdog / status_led
3701 / other_activity_monitor it works automatically from
3702 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00003703
wdenkc6097192002-11-03 00:24:07 +00003704- General:
3705
wdenk4a5c8a72003-03-06 00:02:04 +00003706 In the target system modem support is enabled when a
3707 specific key (key combination) is pressed during
3708 power-on. Otherwise U-Boot will boot normally
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003709 (autoboot). The key_pressed() function is called from
wdenk4a5c8a72003-03-06 00:02:04 +00003710 board_init(). Currently key_pressed() is a dummy
3711 function, returning 1 and thus enabling modem
3712 initialization.
wdenkc6097192002-11-03 00:24:07 +00003713
wdenk4a5c8a72003-03-06 00:02:04 +00003714 If there are no modem init strings in the
3715 environment, U-Boot proceed to autoboot; the
3716 previous output (banner, info printfs) will be
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003717 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00003718
3719 See also: doc/README.Modem
3720
Helmut Raigerd5a184b2011-10-20 04:19:47 +00003721Board initialization settings:
3722------------------------------
3723
3724During Initialization u-boot calls a number of board specific functions
3725to allow the preparation of board specific prerequisites, e.g. pin setup
3726before drivers are initialized. To enable these callbacks the
3727following configuration macros have to be defined. Currently this is
3728architecture specific, so please check arch/your_architecture/lib/board.c
3729typically in board_init_f() and board_init_r().
3730
3731- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3732- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3733- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3734- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003735
wdenkc6097192002-11-03 00:24:07 +00003736Configuration Settings:
3737-----------------------
3738
York Sun6c480012014-02-26 17:03:19 -08003739- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3740 Optionally it can be defined to support 64-bit memory commands.
3741
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003742- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003743 undefine this when you're short of memory.
3744
Peter Tyserdfb72b82009-01-27 18:03:12 -06003745- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3746 width of the commands listed in the 'help' command output.
3747
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003748- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003749 prompt for user input.
3750
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003751- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003752
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003753- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003754
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003755- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003756
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003757- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003758 the application (usually a Linux kernel) when it is
3759 booted
3760
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003761- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003762 List of legal baudrate settings for this board.
3763
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003764- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk57b2d802003-06-27 21:31:46 +00003765 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00003766
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003767- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk57b2d802003-06-27 21:31:46 +00003768 If the board specific function
3769 extern int overwrite_console (void);
3770 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00003771 serial port, else the settings in the environment are used.
3772
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003773- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk57b2d802003-06-27 21:31:46 +00003774 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00003775
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003776- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00003777 Enable overwrite of previous console environment settings.
3778
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003779- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003780 Begin and End addresses of the area used by the
3781 simple memory test.
3782
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003783- CONFIG_SYS_ALT_MEMTEST:
wdenk57b2d802003-06-27 21:31:46 +00003784 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003785
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003786- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5958f4a2003-09-18 09:21:33 +00003787 Scratch address used by the alternate memory test
3788 You only need to set this if address zero isn't writeable
3789
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003790- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
3791 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01003792 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003793 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01003794 fixing up gd->ram_size the Linux kernel should gets passed
3795 the now "corrected" memory size and won't touch it either.
3796 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01003797 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01003798 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01003799 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01003800
3801 This option can be used as a workaround for the 440EPx/GRx
3802 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3803 be touched.
3804
3805 WARNING: Please make sure that this value is a multiple of
3806 the Linux page size (normally 4k). If this is not the case,
3807 then the end address of the Linux memory will be located at a
3808 non page size aligned address and this could cause major
3809 problems.
3810
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003811- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003812 Enable temporary baudrate change while serial download
3813
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003814- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003815 Physical start address of SDRAM. _Must_ be 0 here.
3816
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003817- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00003818 Physical start address of Motherboard I/O (if using a
3819 Cogent motherboard)
3820
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003821- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003822 Physical start address of Flash memory.
3823
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003824- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003825 Physical start address of boot monitor code (set by
3826 make config files to be same as the text base address
Wolfgang Denk0708bc62010-10-07 21:51:12 +02003827 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003828 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003829
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003830- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00003831 Size of memory reserved for monitor code, used to
3832 determine _at_compile_time_ (!) if the environment is
3833 embedded within the U-Boot image, or in a separate
3834 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003835
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003836- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003837 Size of DRAM reserved for malloc() use.
3838
Simon Glass863e4042014-07-10 22:23:28 -06003839- CONFIG_SYS_MALLOC_F_LEN
3840 Size of the malloc() pool for use before relocation. If
3841 this is defined, then a very simple malloc() implementation
3842 will become available before relocation. The address is just
3843 below the global data, and the stack is moved down to make
3844 space.
3845
3846 This feature allocates regions with increasing addresses
3847 within the region. calloc() is supported, but realloc()
3848 is not available. free() is supported but does nothing.
3849 The memory will be freed (or in fact just forgotton) when
3850 U-Boot relocates itself.
3851
Simon Glass0cc6f5c2014-07-10 22:23:31 -06003852 Pre-relocation malloc() is only supported on sandbox
3853 at present but is fairly easy to enable for other archs.
3854
Simon Glass1f36da02014-07-10 22:23:29 -06003855 Pre-relocation malloc() is only supported on ARM at present
3856 but is fairly easy to enable for other archs.
3857
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003858- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01003859 Normally compressed uImages are limited to an
3860 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003861 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01003862 to adjust this setting to your needs.
3863
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003864- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003865 Maximum size of memory mapped by the startup code of
3866 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003867 the Linux kernel (bd_info, boot arguments, FDT blob if
3868 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003869 environment variable is defined and non-zero. In such case
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003870 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denk092ae952011-10-26 10:21:21 +00003871 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likely26396382011-03-28 09:58:43 +00003872 variable "bootm_mapsize" will override the value of
3873 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3874 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003875
John Rigbyeea8e692010-10-13 13:57:35 -06003876- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3877 Enable initrd_high functionality. If defined then the
3878 initrd_high feature is enabled and the bootm ramdisk subcommand
3879 is enabled.
3880
3881- CONFIG_SYS_BOOT_GET_CMDLINE:
3882 Enables allocating and saving kernel cmdline in space between
3883 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3884
3885- CONFIG_SYS_BOOT_GET_KBD:
3886 Enables allocating and saving a kernel copy of the bd_info in
3887 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3888
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003889- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003890 Max number of Flash memory banks
3891
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003892- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003893 Max number of sectors on a Flash chip
3894
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003895- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003896 Timeout for Flash erase operations (in ms)
3897
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003898- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003899 Timeout for Flash write operations (in ms)
3900
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003901- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003902 Timeout for Flash set sector lock bit operation (in ms)
3903
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003904- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003905 Timeout for Flash clear lock bits operation (in ms)
3906
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003907- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00003908 If defined, hardware flash sectors protection is used
3909 instead of U-Boot software protection.
3910
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003911- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003912
3913 Enable TFTP transfers directly to flash memory;
3914 without this option such a download has to be
3915 performed in two steps: (1) download to RAM, and (2)
3916 copy from RAM to flash.
3917
3918 The two-step approach is usually more reliable, since
3919 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003920 the flash, but in some situations (when system RAM is
3921 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003922 downloaded image) this option may be very useful.
3923
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003924- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00003925 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00003926 common flash structure for storing flash geometry.
3927
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02003928- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00003929 This option also enables the building of the cfi_flash driver
3930 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003931
Piotr Ziecik3e939e92008-11-17 15:57:58 +01003932- CONFIG_FLASH_CFI_MTD
3933 This option enables the building of the cfi_mtd driver
3934 in the drivers directory. The driver exports CFI flash
3935 to the MTD layer.
3936
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003937- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02003938 Use buffered writes to flash.
3939
3940- CONFIG_FLASH_SPANSION_S29WS_N
3941 s29ws-n MirrorBit flash has non-standard addresses for buffered
3942 write commands.
3943
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003944- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01003945 If this option is defined, the common CFI flash doesn't
3946 print it's warning upon not recognized FLASH banks. This
3947 is useful, if some of the configured banks are only
3948 optionally available.
3949
Jerry Van Barenaae73572008-03-08 13:48:01 -05003950- CONFIG_FLASH_SHOW_PROGRESS
3951 If defined (must be an integer), print out countdown
3952 digits and dots. Recommended value: 45 (9..1) for 80
3953 column displays, 15 (3..1) for 40 column displays.
3954
Stefan Roesed20cba52013-04-04 15:53:14 +02003955- CONFIG_FLASH_VERIFY
3956 If defined, the content of the flash (destination) is compared
3957 against the source after the write operation. An error message
3958 will be printed when the contents are not identical.
3959 Please note that this option is useless in nearly all cases,
3960 since such flash programming errors usually are detected earlier
3961 while unprotecting/erasing/programming. Please only enable
3962 this option if you really know what you are doing.
3963
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003964- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003965 Defines the number of Ethernet receive buffers. On some
3966 Ethernet controllers it is recommended to set this value
stroese94ef1cf2003-06-05 15:39:44 +00003967 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3968 buffers can be full shortly after enabling the interface
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003969 on high Ethernet traffic.
stroese94ef1cf2003-06-05 15:39:44 +00003970 Defaults to 4 if not defined.
3971
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003972- CONFIG_ENV_MAX_ENTRIES
3973
Wolfgang Denk1136f692010-10-27 22:48:30 +02003974 Maximum number of entries in the hash table that is used
3975 internally to store the environment settings. The default
3976 setting is supposed to be generous and should work in most
3977 cases. This setting can be used to tune behaviour; see
3978 lib/hashtable.c for details.
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003979
Joe Hershberger71497d02012-12-11 22:16:31 -06003980- CONFIG_ENV_FLAGS_LIST_DEFAULT
3981- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003982 Enable validation of the values given to environment variables when
Joe Hershberger71497d02012-12-11 22:16:31 -06003983 calling env set. Variables can be restricted to only decimal,
3984 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3985 the variables can also be restricted to IP address or MAC address.
3986
3987 The format of the list is:
3988 type_attribute = [s|d|x|b|i|m]
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003989 access_atribute = [a|r|o|c]
3990 attributes = type_attribute[access_atribute]
Joe Hershberger71497d02012-12-11 22:16:31 -06003991 entry = variable_name[:attributes]
3992 list = entry[,list]
3993
3994 The type attributes are:
3995 s - String (default)
3996 d - Decimal
3997 x - Hexadecimal
3998 b - Boolean ([1yYtT|0nNfF])
3999 i - IP address
4000 m - MAC address
4001
Joe Hershberger6fe26c92012-12-11 22:16:34 -06004002 The access attributes are:
4003 a - Any (default)
4004 r - Read-only
4005 o - Write-once
4006 c - Change-default
4007
Joe Hershberger71497d02012-12-11 22:16:31 -06004008 - CONFIG_ENV_FLAGS_LIST_DEFAULT
4009 Define this to a list (string) to define the ".flags"
4010 envirnoment variable in the default or embedded environment.
4011
4012 - CONFIG_ENV_FLAGS_LIST_STATIC
4013 Define this to a list (string) to define validation that
4014 should be done if an entry is not found in the ".flags"
4015 environment variable. To override a setting in the static
4016 list, simply add an entry for the same variable name to the
4017 ".flags" variable.
4018
Joe Hershberger6fe26c92012-12-11 22:16:34 -06004019- CONFIG_ENV_ACCESS_IGNORE_FORCE
4020 If defined, don't allow the -f switch to env set override variable
4021 access flags.
4022
Simon Glass66828322013-03-08 13:45:27 +00004023- CONFIG_SYS_GENERIC_BOARD
4024 This selects the architecture-generic board system instead of the
4025 architecture-specific board files. It is intended to move boards
4026 to this new framework over time. Defining this will disable the
4027 arch/foo/lib/board.c file and use common/board_f.c and
4028 common/board_r.c instead. To use this option your architecture
4029 must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
4030 its config.mk file). If you find problems enabling this option on
4031 your board please report the problem and send patches!
4032
Lokesh Vutla100c2d82013-04-17 20:49:40 +00004033- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
4034 This is set by OMAP boards for the max time that reset should
4035 be asserted. See doc/README.omap-reset-time for details on how
4036 the value can be calulated on a given board.
Simon Glass9c9f44a2013-03-11 07:06:48 +00004037
wdenkc6097192002-11-03 00:24:07 +00004038The following definitions that deal with the placement and management
4039of environment data (variable area); in general, we support the
4040following configurations:
4041
Mike Frysinger63b8f122011-07-08 10:44:25 +00004042- CONFIG_BUILD_ENVCRC:
4043
4044 Builds up envcrc with the target environment so that external utils
4045 may easily extract it and embed it in final U-Boot images.
4046
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02004047- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00004048
4049 Define this if the environment is in flash memory.
4050
4051 a) The environment occupies one whole flash sector, which is
4052 "embedded" in the text segment with the U-Boot code. This
4053 happens usually with "bottom boot sector" or "top boot
4054 sector" type flash chips, which have several smaller
4055 sectors at the start or the end. For instance, such a
4056 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
4057 such a case you would place the environment in one of the
4058 4 kB sectors - with U-Boot code before and after it. With
4059 "top boot sector" type flash chips, you would put the
4060 environment in one of the last sectors, leaving a gap
4061 between U-Boot and the environment.
4062
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004063 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004064
4065 Offset of environment data (variable area) to the
4066 beginning of flash memory; for instance, with bottom boot
4067 type flash chips the second sector can be used: the offset
4068 for this sector is given here.
4069
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004070 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00004071
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004072 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004073
4074 This is just another way to specify the start address of
4075 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004076 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00004077
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004078 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004079
4080 Size of the sector containing the environment.
4081
4082
4083 b) Sometimes flash chips have few, equal sized, BIG sectors.
4084 In such a case you don't want to spend a whole sector for
4085 the environment.
4086
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004087 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004088
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02004089 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004090 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00004091 of this flash sector for the environment. This saves
4092 memory for the RAM copy of the environment.
4093
4094 It may also save flash memory if you decide to use this
4095 when your environment is "embedded" within U-Boot code,
4096 since then the remainder of the flash sector could be used
4097 for U-Boot code. It should be pointed out that this is
4098 STRONGLY DISCOURAGED from a robustness point of view:
4099 updating the environment in flash makes it always
4100 necessary to erase the WHOLE sector. If something goes
4101 wrong before the contents has been restored from a copy in
4102 RAM, your target system will be dead.
4103
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004104 - CONFIG_ENV_ADDR_REDUND
4105 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00004106
wdenk4a5c8a72003-03-06 00:02:04 +00004107 These settings describe a second storage area used to hold
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004108 a redundant copy of the environment data, so that there is
wdenkb02744a2003-04-05 00:53:31 +00004109 a valid backup copy in case there is a power failure during
wdenk4a5c8a72003-03-06 00:02:04 +00004110 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00004111
4112BE CAREFUL! Any changes to the flash layout, and some changes to the
4113source code will make it necessary to adapt <board>/u-boot.lds*
4114accordingly!
4115
4116
Jean-Christophe PLAGNIOL-VILLARDfdb79c32008-09-10 22:47:59 +02004117- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00004118
4119 Define this if you have some non-volatile memory device
4120 (NVRAM, battery buffered SRAM) which you want to use for the
4121 environment.
4122
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004123 - CONFIG_ENV_ADDR:
4124 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004125
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004126 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00004127 want to use for environment. It is assumed that this memory
4128 can just be read and written to, without any special
4129 provision.
4130
4131BE CAREFUL! The first access to the environment happens quite early
4132in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004133console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00004134U-Boot will hang.
4135
4136Please note that even with NVRAM we still use a copy of the
4137environment in RAM: we could work on NVRAM directly, but we want to
4138keep settings there always unmodified except somebody uses "saveenv"
4139to save the current settings.
4140
4141
Jean-Christophe PLAGNIOL-VILLARDe46af642008-09-05 09:19:30 +02004142- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00004143
4144 Use this if you have an EEPROM or similar serial access
4145 device and a driver for it.
4146
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004147 - CONFIG_ENV_OFFSET:
4148 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004149
4150 These two #defines specify the offset and size of the
4151 environment area within the total memory of your EEPROM.
4152
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004153 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004154 If defined, specified the chip address of the EEPROM device.
4155 The default address is zero.
4156
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004157 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00004158 If defined, the number of bits used to address bytes in a
4159 single page in the EEPROM device. A 64 byte page, for example
4160 would require six bits.
4161
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004162 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00004163 If defined, the number of milliseconds to delay between
wdenk544e9732004-02-06 23:19:44 +00004164 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00004165
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004166 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00004167 The length in bytes of the EEPROM memory array address. Note
4168 that this is NOT the chip address length!
4169
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004170 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk20c98a62004-04-23 20:32:05 +00004171 EEPROM chips that implement "address overflow" are ones
4172 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
4173 address and the extra bits end up in the "chip address" bit
4174 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
4175 byte chips.
4176
4177 Note that we consider the length of the address field to
4178 still be one byte because the extra address bits are hidden
4179 in the chip address.
4180
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004181 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004182 The size in bytes of the EEPROM device.
4183
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01004184 - CONFIG_ENV_EEPROM_IS_ON_I2C
4185 define this, if you have I2C and SPI activated, and your
4186 EEPROM, which holds the environment, is on the I2C bus.
4187
4188 - CONFIG_I2C_ENV_EEPROM_BUS
4189 if you have an Environment on an EEPROM reached over
4190 I2C muxes, you can define here, how to reach this
4191 EEPROM. For example:
4192
Heiko Schocher479a4cf2013-01-29 08:53:15 +01004193 #define CONFIG_I2C_ENV_EEPROM_BUS 1
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01004194
4195 EEPROM which holds the environment, is reached over
4196 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00004197
Jean-Christophe PLAGNIOL-VILLARD2b14d2b2008-09-10 22:47:58 +02004198- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk86765902003-12-06 23:55:10 +00004199
wdenk1ebf41e2004-01-02 14:00:00 +00004200 Define this if you have a DataFlash memory device which you
wdenk86765902003-12-06 23:55:10 +00004201 want to use for the environment.
4202
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004203 - CONFIG_ENV_OFFSET:
4204 - CONFIG_ENV_ADDR:
4205 - CONFIG_ENV_SIZE:
wdenk86765902003-12-06 23:55:10 +00004206
4207 These three #defines specify the offset and size of the
4208 environment area within the total memory of your DataFlash placed
4209 at the specified address.
4210
Wu, Josh76db7bf2014-07-01 19:30:13 +08004211- CONFIG_ENV_IS_IN_SPI_FLASH:
4212
4213 Define this if you have a SPI Flash memory device which you
4214 want to use for the environment.
4215
4216 - CONFIG_ENV_OFFSET:
4217 - CONFIG_ENV_SIZE:
4218
4219 These two #defines specify the offset and size of the
4220 environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
4221 aligned to an erase sector boundary.
4222
4223 - CONFIG_ENV_SECT_SIZE:
4224
4225 Define the SPI flash's sector size.
4226
4227 - CONFIG_ENV_OFFSET_REDUND (optional):
4228
4229 This setting describes a second storage area of CONFIG_ENV_SIZE
4230 size used to hold a redundant copy of the environment data, so
4231 that there is a valid backup copy in case there is a power failure
4232 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
4233 aligned to an erase sector boundary.
4234
4235 - CONFIG_ENV_SPI_BUS (optional):
4236 - CONFIG_ENV_SPI_CS (optional):
4237
4238 Define the SPI bus and chip select. If not defined they will be 0.
4239
4240 - CONFIG_ENV_SPI_MAX_HZ (optional):
4241
4242 Define the SPI max work clock. If not defined then use 1MHz.
4243
4244 - CONFIG_ENV_SPI_MODE (optional):
4245
4246 Define the SPI work mode. If not defined then use SPI_MODE_3.
4247
Liu Gang85bcd732012-03-08 00:33:20 +00004248- CONFIG_ENV_IS_IN_REMOTE:
4249
4250 Define this if you have a remote memory space which you
4251 want to use for the local device's environment.
4252
4253 - CONFIG_ENV_ADDR:
4254 - CONFIG_ENV_SIZE:
4255
4256 These two #defines specify the address and size of the
4257 environment area within the remote memory space. The
4258 local device can get the environment from remote memory
Liu Gang357bf5a2012-08-09 05:10:01 +00004259 space by SRIO or PCIE links.
Liu Gang85bcd732012-03-08 00:33:20 +00004260
4261BE CAREFUL! For some special cases, the local device can not use
4262"saveenv" command. For example, the local device will get the
Liu Gang357bf5a2012-08-09 05:10:01 +00004263environment stored in a remote NOR flash by SRIO or PCIE link,
4264but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang85bcd732012-03-08 00:33:20 +00004265
Jean-Christophe PLAGNIOL-VILLARDdda84dd2008-09-10 22:47:58 +02004266- CONFIG_ENV_IS_IN_NAND:
wdenk79b59372004-06-09 14:58:14 +00004267
4268 Define this if you have a NAND device which you want to use
4269 for the environment.
4270
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004271 - CONFIG_ENV_OFFSET:
4272 - CONFIG_ENV_SIZE:
wdenk79b59372004-06-09 14:58:14 +00004273
4274 These two #defines specify the offset and size of the environment
Scott Wood08239322010-09-17 14:38:37 -05004275 area within the first NAND device. CONFIG_ENV_OFFSET must be
4276 aligned to an erase block boundary.
wdenk86765902003-12-06 23:55:10 +00004277
Scott Wood08239322010-09-17 14:38:37 -05004278 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004279
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004280 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Wood08239322010-09-17 14:38:37 -05004281 size used to hold a redundant copy of the environment data, so
4282 that there is a valid backup copy in case there is a power failure
Wolfgang Denk092ae952011-10-26 10:21:21 +00004283 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Wood08239322010-09-17 14:38:37 -05004284 aligned to an erase block boundary.
4285
4286 - CONFIG_ENV_RANGE (optional):
4287
4288 Specifies the length of the region in which the environment
4289 can be written. This should be a multiple of the NAND device's
4290 block size. Specifying a range with more erase blocks than
4291 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
4292 the range to be avoided.
4293
4294 - CONFIG_ENV_OFFSET_OOB (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004295
Scott Wood08239322010-09-17 14:38:37 -05004296 Enables support for dynamically retrieving the offset of the
4297 environment from block zero's out-of-band data. The
4298 "nand env.oob" command can be used to record this offset.
4299 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
4300 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004301
Guennadi Liakhovetskifad24442009-05-18 16:07:22 +02004302- CONFIG_NAND_ENV_DST
4303
4304 Defines address in RAM to which the nand_spl code should copy the
4305 environment. If redundant environment is used, it will be copied to
4306 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
4307
Joe Hershberger0c5faa82013-04-08 10:32:51 +00004308- CONFIG_ENV_IS_IN_UBI:
4309
4310 Define this if you have an UBI volume that you want to use for the
4311 environment. This has the benefit of wear-leveling the environment
4312 accesses, which is important on NAND.
4313
4314 - CONFIG_ENV_UBI_PART:
4315
4316 Define this to a string that is the mtd partition containing the UBI.
4317
4318 - CONFIG_ENV_UBI_VOLUME:
4319
4320 Define this to the name of the volume that you want to store the
4321 environment in.
4322
Joe Hershbergerdb14e862013-04-08 10:32:52 +00004323 - CONFIG_ENV_UBI_VOLUME_REDUND:
4324
4325 Define this to the name of another volume to store a second copy of
4326 the environment in. This will enable redundant environments in UBI.
4327 It is assumed that both volumes are in the same MTD partition.
4328
Joe Hershberger0c5faa82013-04-08 10:32:51 +00004329 - CONFIG_UBI_SILENCE_MSG
4330 - CONFIG_UBIFS_SILENCE_MSG
4331
4332 You will probably want to define these to avoid a really noisy system
4333 when storing the env in UBI.
4334
Wu, Josha7d0c872014-06-24 17:31:03 +08004335- CONFIG_ENV_IS_IN_FAT:
4336 Define this if you want to use the FAT file system for the environment.
4337
4338 - FAT_ENV_INTERFACE:
4339
4340 Define this to a string that is the name of the block device.
4341
4342 - FAT_ENV_DEV_AND_PART:
4343
4344 Define this to a string to specify the partition of the device. It can
4345 be as following:
4346
4347 "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
4348 - "D:P": device D partition P. Error occurs if device D has no
4349 partition table.
4350 - "D:0": device D.
4351 - "D" or "D:": device D partition 1 if device D has partition
4352 table, or the whole device D if has no partition
4353 table.
4354 - "D:auto": first partition in device D with bootable flag set.
4355 If none, first valid paratition in device D. If no
4356 partition table then means device D.
4357
4358 - FAT_ENV_FILE:
4359
4360 It's a string of the FAT file name. This file use to store the
4361 envrionment.
4362
4363 - CONFIG_FAT_WRITE:
4364 This should be defined. Otherwise it cannot save the envrionment file.
4365
Stephen Warreneedcacd2013-06-11 15:14:00 -06004366- CONFIG_ENV_IS_IN_MMC:
4367
4368 Define this if you have an MMC device which you want to use for the
4369 environment.
4370
4371 - CONFIG_SYS_MMC_ENV_DEV:
4372
4373 Specifies which MMC device the environment is stored in.
4374
4375 - CONFIG_SYS_MMC_ENV_PART (optional):
4376
4377 Specifies which MMC partition the environment is stored in. If not
4378 set, defaults to partition 0, the user area. Common values might be
4379 1 (first MMC boot partition), 2 (second MMC boot partition).
4380
4381 - CONFIG_ENV_OFFSET:
4382 - CONFIG_ENV_SIZE:
4383
4384 These two #defines specify the offset and size of the environment
4385 area within the specified MMC device.
4386
Stephen Warren24dc2032013-06-11 15:14:02 -06004387 If offset is positive (the usual case), it is treated as relative to
4388 the start of the MMC partition. If offset is negative, it is treated
4389 as relative to the end of the MMC partition. This can be useful if
4390 your board may be fitted with different MMC devices, which have
4391 different sizes for the MMC partitions, and you always want the
4392 environment placed at the very end of the partition, to leave the
4393 maximum possible space before it, to store other data.
4394
Stephen Warreneedcacd2013-06-11 15:14:00 -06004395 These two values are in units of bytes, but must be aligned to an
4396 MMC sector boundary.
4397
4398 - CONFIG_ENV_OFFSET_REDUND (optional):
4399
4400 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
4401 hold a redundant copy of the environment data. This provides a
4402 valid backup copy in case the other copy is corrupted, e.g. due
4403 to a power failure during a "saveenv" operation.
4404
Stephen Warren24dc2032013-06-11 15:14:02 -06004405 This value may also be positive or negative; this is handled in the
4406 same way as CONFIG_ENV_OFFSET.
4407
Stephen Warreneedcacd2013-06-11 15:14:00 -06004408 This value is also in units of bytes, but must also be aligned to
4409 an MMC sector boundary.
4410
4411 - CONFIG_ENV_SIZE_REDUND (optional):
4412
4413 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
4414 set. If this value is set, it must be set to the same value as
4415 CONFIG_ENV_SIZE.
4416
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004417- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00004418
4419 Defines offset to the initial SPI buffer area in DPRAM. The
4420 area is used at an early stage (ROM part) if the environment
4421 is configured to reside in the SPI EEPROM: We need a 520 byte
4422 scratch DPRAM area. It is used between the two initialization
4423 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4424 to be a good choice since it makes it far enough from the
4425 start of the data area as well as from the stack pointer.
4426
Bruce Adleredecc942007-11-02 13:15:42 -07004427Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00004428has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denk76af2782010-07-24 21:55:43 +02004429created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00004430until then to read environment variables.
4431
wdenk8dba0502003-03-31 16:34:49 +00004432The environment is protected by a CRC32 checksum. Before the monitor
4433is relocated into RAM, as a result of a bad CRC you will be working
4434with the compiled-in default environment - *silently*!!! [This is
4435necessary, because the first environment variable we need is the
4436"baudrate" setting for the console - if we have a bad CRC, we don't
4437have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00004438
4439Note: once the monitor has been relocated, then it will complain if
4440the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00004441use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00004442
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004443- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk9c53f402003-10-15 23:53:47 +00004444 Echo the inverted Ethernet link state to the fault LED.
wdenk49c3f672003-10-08 22:33:00 +00004445
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004446 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenk49c3f672003-10-08 22:33:00 +00004447 also needs to be defined.
4448
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004449- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00004450 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00004451
Ron Madriddfa028a2009-02-18 14:30:44 -08004452- CONFIG_NS16550_MIN_FUNCTIONS:
4453 Define this if you desire to only have use of the NS16550_init
4454 and NS16550_putc functions for the serial driver located at
4455 drivers/serial/ns16550.c. This option is useful for saving
4456 space for already greatly restricted images, including but not
4457 limited to NAND_SPL configurations.
4458
Simon Glass28a9e332012-11-30 13:01:18 +00004459- CONFIG_DISPLAY_BOARDINFO
4460 Display information about the board that U-Boot is running on
4461 when U-Boot starts up. The board function checkboard() is called
4462 to do this.
4463
Simon Glasse8822012012-11-30 13:01:19 +00004464- CONFIG_DISPLAY_BOARDINFO_LATE
4465 Similar to the previous option, but display this information
4466 later, once stdio is running and output goes to the LCD, if
4467 present.
4468
Sascha Silbe4b9c17c2013-08-11 16:40:43 +02004469- CONFIG_BOARD_SIZE_LIMIT:
4470 Maximum size of the U-Boot image. When defined, the
4471 build system checks that the actual size does not
4472 exceed it.
4473
wdenkc6097192002-11-03 00:24:07 +00004474Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00004475---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004476
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004477- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004478 Cache Line Size of the CPU.
4479
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004480- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00004481 Default address of the IMMR after system reset.
wdenk2bb11052003-07-17 23:16:40 +00004482
wdenk9c53f402003-10-15 23:53:47 +00004483 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
4484 and RPXsuper) to be able to adjust the position of
4485 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00004486
Timur Tabid8f341c2011-08-04 18:03:41 -05004487- CONFIG_SYS_CCSRBAR_DEFAULT:
4488 Default (power-on reset) physical address of CCSR on Freescale
4489 PowerPC SOCs.
4490
4491- CONFIG_SYS_CCSRBAR:
4492 Virtual address of CCSR. On a 32-bit build, this is typically
4493 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4494
4495 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4496 for cross-platform code that uses that macro instead.
4497
4498- CONFIG_SYS_CCSRBAR_PHYS:
4499 Physical address of CCSR. CCSR can be relocated to a new
4500 physical address, if desired. In this case, this macro should
Wolfgang Denk092ae952011-10-26 10:21:21 +00004501 be set to that address. Otherwise, it should be set to the
Timur Tabid8f341c2011-08-04 18:03:41 -05004502 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
4503 is typically relocated on 36-bit builds. It is recommended
4504 that this macro be defined via the _HIGH and _LOW macros:
4505
4506 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4507 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4508
4509- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denkd590fb12011-10-07 09:58:21 +02004510 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
4511 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabid8f341c2011-08-04 18:03:41 -05004512 used in assembly code, so it must not contain typecasts or
4513 integer size suffixes (e.g. "ULL").
4514
4515- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4516 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
4517 used in assembly code, so it must not contain typecasts or
4518 integer size suffixes (e.g. "ULL").
4519
4520- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4521 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4522 forced to a value that ensures that CCSR is not relocated.
4523
wdenk1272e232002-11-10 22:06:23 +00004524- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004525 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk1272e232002-11-10 22:06:23 +00004526
4527 the default drive number (default value 0)
4528
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004529 CONFIG_SYS_ISA_IO_STRIDE
wdenk1272e232002-11-10 22:06:23 +00004530
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004531 defines the spacing between FDC chipset registers
wdenk1272e232002-11-10 22:06:23 +00004532 (default value 1)
4533
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004534 CONFIG_SYS_ISA_IO_OFFSET
wdenk1272e232002-11-10 22:06:23 +00004535
wdenk4a5c8a72003-03-06 00:02:04 +00004536 defines the offset of register from address. It
4537 depends on which part of the data bus is connected to
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004538 the FDC chipset. (default value 0)
wdenk1272e232002-11-10 22:06:23 +00004539
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004540 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
4541 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk4a5c8a72003-03-06 00:02:04 +00004542 default value.
wdenk1272e232002-11-10 22:06:23 +00004543
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004544 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk4a5c8a72003-03-06 00:02:04 +00004545 fdc_hw_init() is called at the beginning of the FDC
4546 setup. fdc_hw_init() must be provided by the board
4547 source code. It is used to make hardware dependant
4548 initializations.
wdenk1272e232002-11-10 22:06:23 +00004549
Macpaul Lind1e49942011-04-11 20:45:32 +00004550- CONFIG_IDE_AHB:
4551 Most IDE controllers were designed to be connected with PCI
4552 interface. Only few of them were designed for AHB interface.
4553 When software is doing ATA command and data transfer to
4554 IDE devices through IDE-AHB controller, some additional
4555 registers accessing to these kind of IDE-AHB controller
4556 is requierd.
4557
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004558- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00004559 DO NOT CHANGE unless you know exactly what you're
wdenkb3a4a702004-12-10 11:40:40 +00004560 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00004561
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004562- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004563
wdenkeb20ad32003-09-05 23:19:14 +00004564 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00004565 initial data and stack; please note that this must be
4566 writable memory that is working WITHOUT special
4567 initialization, i. e. you CANNOT use normal RAM which
4568 will become available only after programming the
4569 memory controller and running certain initialization
4570 sequences.
4571
4572 U-Boot uses the following memory types:
4573 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4574 - MPC824X: data cache
4575 - PPC4xx: data cache
4576
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004577- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004578
4579 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004580 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
4581 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00004582 data is located at the end of the available space
Wolfgang Denk1c2e98e2010-10-26 13:32:32 +02004583 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004584 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
4585 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4586 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00004587
4588 Note:
4589 On the MPC824X (or other systems that use the data
4590 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004591 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00004592 point to an otherwise UNUSED address space between
4593 the top of RAM and the start of the PCI space.
4594
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004595- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00004596
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004597- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00004598
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004599- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00004600
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004601- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00004602
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004603- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00004604
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004605- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00004606
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004607- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00004608 SDRAM timing
4609
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004610- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00004611 periodic timer for refresh
4612
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004613- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00004614
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004615- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4616 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4617 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4618 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004619 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4620
4621- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004622 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4623 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004624 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4625
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004626- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4627 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00004628 Machine Mode Register and Memory Periodic Timer
4629 Prescaler definitions (SDRAM timing)
4630
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004631- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004632 enable I2C microcode relocation patch (MPC8xx);
4633 define relocation offset in DPRAM [DSP2]
4634
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004635- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherc8148ed2008-01-11 01:12:07 +01004636 enable SMC microcode relocation patch (MPC8xx);
4637 define relocation offset in DPRAM [SMC1]
4638
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004639- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004640 enable SPI microcode relocation patch (MPC8xx);
4641 define relocation offset in DPRAM [SCC4]
4642
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004643- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00004644 Use OSCM clock mode on MBX8xx board. Be careful,
4645 wrong setting might damage your board. Read
4646 doc/README.MBX before setting this variable!
4647
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004648- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk4a5c8a72003-03-06 00:02:04 +00004649 Offset of the bootmode word in DPRAM used by post
4650 (Power On Self Tests). This definition overrides
4651 #define'd default value in commproc.h resp.
4652 cpm_8260.h.
wdenk2029f4d2002-11-21 23:11:29 +00004653
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004654- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4655 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4656 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4657 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4658 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4659 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4660 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4661 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roese88fbf932010-04-15 16:07:28 +02004662 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenkbf2f8c92003-05-22 22:52:13 +00004663
Dirk Eibach378d1ca2009-02-09 08:18:34 +01004664- CONFIG_PCI_DISABLE_PCIE:
4665 Disable PCI-Express on systems where it is supported but not
4666 required.
4667
Andrew Sharp61d47ca2012-08-29 14:16:32 +00004668- CONFIG_PCI_ENUM_ONLY
4669 Only scan through and get the devices on the busses.
4670 Don't do any setup work, presumably because someone or
4671 something has already done it, and we don't need to do it
4672 a second time. Useful for platforms that are pre-booted
4673 by coreboot or similar.
4674
Gabor Juhosb4458732013-05-30 07:06:12 +00004675- CONFIG_PCI_INDIRECT_BRIDGE:
4676 Enable support for indirect PCI bridges.
4677
Kumar Gala8975d7a2010-12-30 12:09:53 -06004678- CONFIG_SYS_SRIO:
4679 Chip has SRIO or not
4680
4681- CONFIG_SRIO1:
4682 Board has SRIO 1 port available
4683
4684- CONFIG_SRIO2:
4685 Board has SRIO 2 port available
4686
Liu Gang27afb9c2013-05-07 16:30:46 +08004687- CONFIG_SRIO_PCIE_BOOT_MASTER
4688 Board can support master function for Boot from SRIO and PCIE
4689
Kumar Gala8975d7a2010-12-30 12:09:53 -06004690- CONFIG_SYS_SRIOn_MEM_VIRT:
4691 Virtual Address of SRIO port 'n' memory region
4692
4693- CONFIG_SYS_SRIOn_MEM_PHYS:
4694 Physical Address of SRIO port 'n' memory region
4695
4696- CONFIG_SYS_SRIOn_MEM_SIZE:
4697 Size of SRIO port 'n' memory region
4698
Fabio Estevamf17e8782013-04-11 09:35:34 +00004699- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4700 Defined to tell the NAND controller that the NAND chip is using
4701 a 16 bit bus.
4702 Not all NAND drivers use this symbol.
Fabio Estevam417052b2013-04-11 09:35:35 +00004703 Example of drivers that use it:
Fabio Estevamf17e8782013-04-11 09:35:34 +00004704 - drivers/mtd/nand/ndfc.c
Fabio Estevam417052b2013-04-11 09:35:35 +00004705 - drivers/mtd/nand/mxc_nand.c
Alex Watermancd6aae32011-05-19 15:08:36 -04004706
4707- CONFIG_SYS_NDFC_EBC0_CFG
4708 Sets the EBC0_CFG register for the NDFC. If not defined
4709 a default value will be used.
4710
Ben Warren45657152006-09-07 16:50:54 -04004711- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004712 Get DDR timing information from an I2C EEPROM. Common
4713 with pluggable memory modules such as SODIMMs
4714
Ben Warren45657152006-09-07 16:50:54 -04004715 SPD_EEPROM_ADDRESS
4716 I2C address of the SPD EEPROM
4717
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004718- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004719 If SPD EEPROM is on an I2C bus other than the first
4720 one, specify here. Note that the value must resolve
4721 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04004722
York Sune73cc042011-06-07 09:42:16 +08004723- CONFIG_SYS_DDR_RAW_TIMING
4724 Get DDR timing information from other than SPD. Common with
4725 soldered DDR chips onboard without SPD. DDR raw timing
4726 parameters are extracted from datasheet and hard-coded into
4727 header files or board specific files.
4728
York Sunbd495cf2011-09-16 13:21:35 -07004729- CONFIG_FSL_DDR_INTERACTIVE
4730 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4731
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004732- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004733 Only for 83xx systems. If specified, then DDR should
4734 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06004735
wdenk6203e402004-04-18 10:13:26 +00004736- CONFIG_ETHER_ON_FEC[12]
4737 Define to enable FEC[12] on a 8xx series processor.
4738
4739- CONFIG_FEC[12]_PHY
4740 Define to the hardcoded PHY address which corresponds
wdenk05939202004-04-18 17:39:38 +00004741 to the given FEC; i. e.
4742 #define CONFIG_FEC1_PHY 4
wdenk6203e402004-04-18 10:13:26 +00004743 means that the PHY with address 4 is connected to FEC1
4744
4745 When set to -1, means to probe for first available.
4746
4747- CONFIG_FEC[12]_PHY_NORXERR
4748 The PHY does not have a RXERR line (RMII only).
4749 (so program the FEC to ignore it).
4750
4751- CONFIG_RMII
4752 Enable RMII mode for all FECs.
4753 Note that this is a global option, we can't
4754 have one FEC in standard MII mode and another in RMII mode.
4755
wdenk20c98a62004-04-23 20:32:05 +00004756- CONFIG_CRC32_VERIFY
4757 Add a verify option to the crc32 command.
4758 The syntax is:
4759
4760 => crc32 -v <address> <count> <crc32>
4761
4762 Where address/count indicate a memory area
4763 and crc32 is the correct crc32 which the
4764 area should have.
4765
wdenk64519362004-07-11 17:40:54 +00004766- CONFIG_LOOPW
4767 Add the "loopw" memory command. This only takes effect if
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004768 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk64519362004-07-11 17:40:54 +00004769
stroesecc3af832004-12-16 18:46:55 +00004770- CONFIG_MX_CYCLIC
4771 Add the "mdc" and "mwc" memory commands. These are cyclic
4772 "md/mw" commands.
4773 Examples:
4774
wdenk07d7e6b2004-12-16 21:44:03 +00004775 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00004776 This command will print 4 bytes (10,11,12,13) each 500 ms.
4777
wdenk07d7e6b2004-12-16 21:44:03 +00004778 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00004779 This command will write 12345678 to address 100 all 10 ms.
4780
wdenk07d7e6b2004-12-16 21:44:03 +00004781 This only takes effect if the memory commands are activated
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004782 globally (CONFIG_CMD_MEM).
stroesecc3af832004-12-16 18:46:55 +00004783
wdenk3d3d99f2005-04-04 12:44:11 +00004784- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004785 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk302141d2010-11-27 23:30:56 +01004786 low level initializations (like setting up the memory
4787 controller) are omitted and/or U-Boot does not
4788 relocate itself into RAM.
wdenk3d3d99f2005-04-04 12:44:11 +00004789
Wolfgang Denk302141d2010-11-27 23:30:56 +01004790 Normally this variable MUST NOT be defined. The only
4791 exception is when U-Boot is loaded (to RAM) by some
4792 other boot loader or by a debugger which performs
4793 these initializations itself.
wdenk3d3d99f2005-04-04 12:44:11 +00004794
Aneesh V552a3192011-07-13 05:11:07 +00004795- CONFIG_SPL_BUILD
Magnus Lilja1ec96d82009-06-13 20:50:00 +02004796 Modifies the behaviour of start.S when compiling a loader
4797 that is executed before the actual U-Boot. E.g. when
4798 compiling a NAND SPL.
wdenk336b2bc2005-04-02 23:52:25 +00004799
Ying Zhang2d2e3b62013-08-16 15:16:15 +08004800- CONFIG_TPL_BUILD
4801 Modifies the behaviour of start.S when compiling a loader
4802 that is executed after the SPL and before the actual U-Boot.
4803 It is loaded by the SPL.
4804
Ying Zhang0d4f5442013-05-20 14:07:23 +08004805- CONFIG_SYS_MPC85XX_NO_RESETVEC
4806 Only for 85xx systems. If this variable is specified, the section
4807 .resetvec is not kept and the section .bootpg is placed in the
4808 previous 4k of the .text section.
4809
Simon Glass17dabf02013-02-24 17:33:14 +00004810- CONFIG_ARCH_MAP_SYSMEM
4811 Generally U-Boot (and in particular the md command) uses
4812 effective address. It is therefore not necessary to regard
4813 U-Boot address as virtual addresses that need to be translated
4814 to physical addresses. However, sandbox requires this, since
4815 it maintains its own little RAM buffer which contains all
4816 addressable memory. This option causes some memory accesses
4817 to be mapped through map_sysmem() / unmap_sysmem().
4818
Matthias Weisser93416c12011-03-10 21:36:32 +00004819- CONFIG_USE_ARCH_MEMCPY
4820 CONFIG_USE_ARCH_MEMSET
4821 If these options are used a optimized version of memcpy/memset will
4822 be used if available. These functions may be faster under some
4823 conditions but may increase the binary size.
4824
Simon Glassbfb59802013-02-14 04:18:54 +00004825- CONFIG_X86_RESET_VECTOR
4826 If defined, the x86 reset vector code is included. This is not
4827 needed when U-Boot is running from Coreboot.
Gabe Black14f82462012-11-27 21:08:06 +00004828
Mark Jackson52b003c2013-03-04 01:27:20 +00004829- CONFIG_SYS_MPUCLK
4830 Defines the MPU clock speed (in MHz).
4831
4832 NOTE : currently only supported on AM335x platforms.
Gabe Black76ce2492012-11-29 16:23:41 +00004833
Heiko Schocher2233e462013-11-04 14:05:00 +01004834- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
4835 Enables the RTC32K OSC on AM33xx based plattforms
4836
Karicheri, Muralidharanc1dc61b2014-04-04 13:16:50 -04004837- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
4838 Option to disable subpage write in NAND driver
4839 driver that uses this:
4840 drivers/mtd/nand/davinci_nand.c
4841
Timur Tabi275f4bb2011-11-22 09:21:25 -06004842Freescale QE/FMAN Firmware Support:
4843-----------------------------------
4844
4845The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4846loading of "firmware", which is encoded in the QE firmware binary format.
4847This firmware often needs to be loaded during U-Boot booting, so macros
4848are used to identify the storage device (NOR flash, SPI, etc) and the address
4849within that device.
4850
Zhao Qiang83a90842014-03-21 16:21:44 +08004851- CONFIG_SYS_FMAN_FW_ADDR
4852 The address in the storage device where the FMAN microcode is located. The
4853 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4854 is also specified.
4855
4856- CONFIG_SYS_QE_FW_ADDR
4857 The address in the storage device where the QE microcode is located. The
Timur Tabi275f4bb2011-11-22 09:21:25 -06004858 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4859 is also specified.
4860
4861- CONFIG_SYS_QE_FMAN_FW_LENGTH
4862 The maximum possible size of the firmware. The firmware binary format
4863 has a field that specifies the actual size of the firmware, but it
4864 might not be possible to read any part of the firmware unless some
4865 local storage is allocated to hold the entire firmware first.
4866
4867- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4868 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4869 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
4870 virtual address in NOR flash.
4871
4872- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4873 Specifies that QE/FMAN firmware is located in NAND flash.
4874 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4875
4876- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4877 Specifies that QE/FMAN firmware is located on the primary SD/MMC
4878 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4879
4880- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
4881 Specifies that QE/FMAN firmware is located on the primary SPI
4882 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4883
Liu Gang1e084582012-03-08 00:33:18 +00004884- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4885 Specifies that QE/FMAN firmware is located in the remote (master)
4886 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gang357bf5a2012-08-09 05:10:01 +00004887 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4888 window->master inbound window->master LAW->the ucode address in
4889 master's memory space.
Timur Tabi275f4bb2011-11-22 09:21:25 -06004890
J. German Rivera8ff14b72014-06-23 15:15:55 -07004891Freescale Layerscape Management Complex Firmware Support:
4892---------------------------------------------------------
4893The Freescale Layerscape Management Complex (MC) supports the loading of
4894"firmware".
4895This firmware often needs to be loaded during U-Boot booting, so macros
4896are used to identify the storage device (NOR flash, SPI, etc) and the address
4897within that device.
4898
4899- CONFIG_FSL_MC_ENET
4900 Enable the MC driver for Layerscape SoCs.
4901
4902- CONFIG_SYS_LS_MC_FW_ADDR
4903 The address in the storage device where the firmware is located. The
4904 meaning of this address depends on which CONFIG_SYS_LS_MC_FW_IN_xxx macro
4905 is also specified.
4906
4907- CONFIG_SYS_LS_MC_FW_LENGTH
4908 The maximum possible size of the firmware. The firmware binary format
4909 has a field that specifies the actual size of the firmware, but it
4910 might not be possible to read any part of the firmware unless some
4911 local storage is allocated to hold the entire firmware first.
4912
4913- CONFIG_SYS_LS_MC_FW_IN_NOR
4914 Specifies that MC firmware is located in NOR flash, mapped as
4915 normal addressable memory via the LBC. CONFIG_SYS_LS_MC_FW_ADDR is the
4916 virtual address in NOR flash.
4917
wdenkc6097192002-11-03 00:24:07 +00004918Building the Software:
4919======================
4920
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004921Building U-Boot has been tested in several native build environments
4922and in many different cross environments. Of course we cannot support
4923all possibly existing versions of cross development tools in all
4924(potentially obsolete) versions. In case of tool chain problems we
4925recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4926which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004927
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004928If you are not using a native environment, it is assumed that you
4929have GNU cross compiling tools available in your path. In this case,
4930you must set the environment variable CROSS_COMPILE in your shell.
4931Note that no changes to the Makefile or any other source files are
4932necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00004933
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004934 $ CROSS_COMPILE=ppc_4xx-
4935 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00004936
Peter Tyserb06976d2009-03-13 18:54:51 -05004937Note: If you wish to generate Windows versions of the utilities in
4938 the tools directory you can use the MinGW toolchain
4939 (http://www.mingw.org). Set your HOST tools to the MinGW
4940 toolchain and execute 'make tools'. For example:
4941
4942 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
4943
4944 Binaries such as tools/mkimage.exe will be created which can
4945 be executed on computers running Windows.
4946
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004947U-Boot is intended to be simple to build. After installing the
4948sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00004949is done by typing:
4950
Holger Freyther7ba4e572014-08-04 09:26:05 +02004951 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00004952
Holger Freyther7ba4e572014-08-04 09:26:05 +02004953where "NAME_defconfig" is the name of one of the existing configu-
Michael Jones5a7fb6f2012-03-15 22:48:10 +00004954rations; see boards.cfg for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00004955
wdenk6c59edc2004-05-03 20:45:30 +00004956Note: for some board special configuration names may exist; check if
4957 additional information is available from the board vendor; for
4958 instance, the TQM823L systems are available without (standard)
4959 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004960 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00004961
Holger Freyther7ba4e572014-08-04 09:26:05 +02004962 make TQM823L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00004963 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00004964
Holger Freyther7ba4e572014-08-04 09:26:05 +02004965 make TQM823L_LCD_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00004966 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00004967
wdenk6c59edc2004-05-03 20:45:30 +00004968 etc.
wdenkc6097192002-11-03 00:24:07 +00004969
wdenkc6097192002-11-03 00:24:07 +00004970
wdenk6c59edc2004-05-03 20:45:30 +00004971Finally, type "make all", and you should get some working U-Boot
4972images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00004973
wdenk6c59edc2004-05-03 20:45:30 +00004974- "u-boot.bin" is a raw binary image
4975- "u-boot" is an image in ELF binary format
4976- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00004977
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004978By default the build is performed locally and the objects are saved
4979in the source directory. One of the two methods can be used to change
4980this behavior and build U-Boot to some external directory:
4981
49821. Add O= to the make command line invocations:
4983
4984 make O=/tmp/build distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02004985 make O=/tmp/build NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004986 make O=/tmp/build all
4987
49882. Set environment variable BUILD_DIR to point to the desired location:
4989
4990 export BUILD_DIR=/tmp/build
4991 make distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02004992 make NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004993 make all
4994
4995Note that the command line "O=" setting overrides the BUILD_DIR environment
4996variable.
4997
wdenkc6097192002-11-03 00:24:07 +00004998
wdenk6c59edc2004-05-03 20:45:30 +00004999Please be aware that the Makefiles assume you are using GNU make, so
5000for instance on NetBSD you might need to use "gmake" instead of
5001native "make".
wdenkc6097192002-11-03 00:24:07 +00005002
wdenkc6097192002-11-03 00:24:07 +00005003
wdenk6c59edc2004-05-03 20:45:30 +00005004If the system board that you have is not listed, then you will need
5005to port U-Boot to your hardware platform. To do this, follow these
5006steps:
wdenkc6097192002-11-03 00:24:07 +00005007
wdenk6c59edc2004-05-03 20:45:30 +000050081. Add a new configuration option for your board to the toplevel
Michael Jones5a7fb6f2012-03-15 22:48:10 +00005009 "boards.cfg" file, using the existing entries as examples.
5010 Follow the instructions there to keep the boards in order.
wdenk6c59edc2004-05-03 20:45:30 +000050112. Create a new directory to hold your board specific code. Add any
5012 files you need. In your board directory, you will need at least
5013 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
50143. Create a new configuration file "include/configs/<board>.h" for
5015 your board
50163. If you're porting U-Boot to a new CPU, then also create a new
5017 directory to hold your CPU specific code. Add any files you need.
Holger Freyther7ba4e572014-08-04 09:26:05 +020050184. Run "make <board>_defconfig" with your new name.
wdenk6c59edc2004-05-03 20:45:30 +000050195. Type "make", and you should get a working "u-boot.srec" file
5020 to be installed on your target system.
50216. Debug and solve any problems that might arise.
5022 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00005023
wdenkc6097192002-11-03 00:24:07 +00005024
wdenk6c59edc2004-05-03 20:45:30 +00005025Testing of U-Boot Modifications, Ports to New Hardware, etc.:
5026==============================================================
wdenkc6097192002-11-03 00:24:07 +00005027
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005028If you have modified U-Boot sources (for instance added a new board
5029or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00005030provide feedback to the other developers. The feedback normally takes
5031the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005032official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00005033
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005034But before you submit such a patch, please verify that your modifi-
5035cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00005036the supported boards compile WITHOUT ANY compiler warnings. To do so,
5037just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005038for ALL supported system. Be warned, this will take a while. You can
5039select which (cross) compiler to use by passing a `CROSS_COMPILE'
5040environment variable to the script, i. e. to use the ELDK cross tools
5041you can type
wdenkc6097192002-11-03 00:24:07 +00005042
wdenk6c59edc2004-05-03 20:45:30 +00005043 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00005044
wdenk6c59edc2004-05-03 20:45:30 +00005045or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00005046
wdenk6c59edc2004-05-03 20:45:30 +00005047 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00005048
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005049When using the MAKEALL script, the default behaviour is to build
5050U-Boot in the source directory. This location can be changed by
5051setting the BUILD_DIR environment variable. Also, for each target
5052built, the MAKEALL script saves two log files (<target>.ERR and
5053<target>.MAKEALL) in the <source dir>/LOG directory. This default
5054location can be changed by setting the MAKEALL_LOGDIR environment
5055variable. For example:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005056
5057 export BUILD_DIR=/tmp/build
5058 export MAKEALL_LOGDIR=/tmp/log
5059 CROSS_COMPILE=ppc_8xx- MAKEALL
5060
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005061With the above settings build objects are saved in the /tmp/build,
5062log files are saved in the /tmp/log and the source tree remains clean
5063during the whole build process.
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005064
5065
wdenk6c59edc2004-05-03 20:45:30 +00005066See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00005067
wdenkc6097192002-11-03 00:24:07 +00005068
wdenk6c59edc2004-05-03 20:45:30 +00005069Monitor Commands - Overview:
5070============================
wdenkc6097192002-11-03 00:24:07 +00005071
wdenk6c59edc2004-05-03 20:45:30 +00005072go - start application at address 'addr'
5073run - run commands in an environment variable
5074bootm - boot application image from memory
5075bootp - boot image via network using BootP/TFTP protocol
Marek Vasutcf41a9b2012-03-14 21:52:45 +00005076bootz - boot zImage from memory
wdenk6c59edc2004-05-03 20:45:30 +00005077tftpboot- boot image via network using TFTP protocol
5078 and env variables "ipaddr" and "serverip"
5079 (and eventually "gatewayip")
Simon Glass6a398d22011-10-24 18:00:07 +00005080tftpput - upload a file via network using TFTP protocol
wdenk6c59edc2004-05-03 20:45:30 +00005081rarpboot- boot image via network using RARP/TFTP protocol
5082diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
5083loads - load S-Record file over serial line
5084loadb - load binary file over serial line (kermit mode)
5085md - memory display
5086mm - memory modify (auto-incrementing)
5087nm - memory modify (constant address)
5088mw - memory write (fill)
5089cp - memory copy
5090cmp - memory compare
5091crc32 - checksum calculation
Peter Tyser469cde42009-04-18 22:34:03 -05005092i2c - I2C sub-system
wdenk6c59edc2004-05-03 20:45:30 +00005093sspi - SPI utility commands
5094base - print or set address offset
5095printenv- print environment variables
5096setenv - set environment variables
5097saveenv - save environment variables to persistent storage
5098protect - enable or disable FLASH write protection
5099erase - erase FLASH memory
5100flinfo - print FLASH memory information
Karl O. Pinc4baf03d2012-08-03 05:57:21 +00005101nand - NAND memory operations (see doc/README.nand)
wdenk6c59edc2004-05-03 20:45:30 +00005102bdinfo - print Board Info structure
5103iminfo - print header information for application image
5104coninfo - print console devices and informations
5105ide - IDE sub-system
5106loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00005107loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00005108mtest - simple RAM test
5109icache - enable or disable instruction cache
5110dcache - enable or disable data cache
5111reset - Perform RESET of the CPU
5112echo - echo args to console
5113version - print monitor version
5114help - print online help
5115? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00005116
wdenkc6097192002-11-03 00:24:07 +00005117
wdenk6c59edc2004-05-03 20:45:30 +00005118Monitor Commands - Detailed Description:
5119========================================
wdenkc6097192002-11-03 00:24:07 +00005120
wdenk6c59edc2004-05-03 20:45:30 +00005121TODO.
wdenkc6097192002-11-03 00:24:07 +00005122
wdenk6c59edc2004-05-03 20:45:30 +00005123For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00005124
5125
wdenk6c59edc2004-05-03 20:45:30 +00005126Environment Variables:
5127======================
wdenkc6097192002-11-03 00:24:07 +00005128
wdenk6c59edc2004-05-03 20:45:30 +00005129U-Boot supports user configuration using Environment Variables which
5130can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00005131
wdenk6c59edc2004-05-03 20:45:30 +00005132Environment Variables are set using "setenv", printed using
5133"printenv", and saved to Flash using "saveenv". Using "setenv"
5134without a value can be used to delete a variable from the
5135environment. As long as you don't save the environment you are
5136working with an in-memory copy. In case the Flash area containing the
5137environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00005138
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005139Some configuration options can be set using Environment Variables.
5140
5141List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00005142
wdenk6c59edc2004-05-03 20:45:30 +00005143 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00005144
wdenk6c59edc2004-05-03 20:45:30 +00005145 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00005146
wdenk6c59edc2004-05-03 20:45:30 +00005147 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00005148
wdenk6c59edc2004-05-03 20:45:30 +00005149 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00005150
wdenk6c59edc2004-05-03 20:45:30 +00005151 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00005152
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02005153 bootm_low - Memory range available for image processing in the bootm
5154 command can be restricted. This variable is given as
5155 a hexadecimal number and defines lowest address allowed
5156 for use by the bootm command. See also "bootm_size"
5157 environment variable. Address defined by "bootm_low" is
5158 also the base of the initial memory mapping for the Linux
Grant Likely26396382011-03-28 09:58:43 +00005159 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
5160 bootm_mapsize.
5161
Wolfgang Denk092ae952011-10-26 10:21:21 +00005162 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likely26396382011-03-28 09:58:43 +00005163 This variable is given as a hexadecimal number and it
5164 defines the size of the memory region starting at base
5165 address bootm_low that is accessible by the Linux kernel
5166 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
5167 as the default value if it is defined, and bootm_size is
5168 used otherwise.
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02005169
5170 bootm_size - Memory range available for image processing in the bootm
5171 command can be restricted. This variable is given as
5172 a hexadecimal number and defines the size of the region
5173 allowed for use by the bootm command. See also "bootm_low"
5174 environment variable.
5175
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02005176 updatefile - Location of the software update file on a TFTP server, used
5177 by the automatic software update feature. Please refer to
5178 documentation in doc/README.update for more details.
5179
wdenk6c59edc2004-05-03 20:45:30 +00005180 autoload - if set to "no" (any string beginning with 'n'),
5181 "bootp" will just load perform a lookup of the
5182 configuration from the BOOTP server, but not try to
5183 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00005184
wdenk6c59edc2004-05-03 20:45:30 +00005185 autostart - if set to "yes", an image loaded using the "bootp",
5186 "rarpboot", "tftpboot" or "diskboot" commands will
5187 be automatically started (by internally calling
5188 "bootm")
wdenkc6097192002-11-03 00:24:07 +00005189
wdenk6c59edc2004-05-03 20:45:30 +00005190 If set to "no", a standalone image passed to the
5191 "bootm" command will be copied to the load address
5192 (and eventually uncompressed), but NOT be started.
5193 This can be used to load and uncompress arbitrary
5194 data.
wdenkc6097192002-11-03 00:24:07 +00005195
David A. Longd558a4e2011-07-09 16:40:19 -04005196 fdt_high - if set this restricts the maximum address that the
5197 flattened device tree will be copied into upon boot.
Shawn Guo0ca9e982012-01-09 21:54:08 +00005198 For example, if you have a system with 1 GB memory
5199 at physical address 0x10000000, while Linux kernel
5200 only recognizes the first 704 MB as low memory, you
5201 may need to set fdt_high as 0x3C000000 to have the
5202 device tree blob be copied to the maximum address
5203 of the 704 MB low memory, so that Linux kernel can
5204 access it during the boot procedure.
5205
David A. Longd558a4e2011-07-09 16:40:19 -04005206 If this is set to the special value 0xFFFFFFFF then
5207 the fdt will not be copied at all on boot. For this
5208 to work it must reside in writable memory, have
5209 sufficient padding on the end of it for u-boot to
5210 add the information it needs into it, and the memory
5211 must be accessible by the kernel.
5212
Simon Glassdc6fa642011-10-24 19:15:34 +00005213 fdtcontroladdr- if set this is the address of the control flattened
5214 device tree used by U-Boot when CONFIG_OF_CONTROL is
5215 defined.
5216
wdenk0e2bd9c2004-06-06 21:51:03 +00005217 i2cfast - (PPC405GP|PPC405EP only)
5218 if set to 'y' configures Linux I2C driver for fast
5219 mode (400kHZ). This environment variable is used in
5220 initialization code. So, for changes to be effective
5221 it must be saved and board must be reset.
5222
wdenk6c59edc2004-05-03 20:45:30 +00005223 initrd_high - restrict positioning of initrd images:
5224 If this variable is not set, initrd images will be
5225 copied to the highest possible address in RAM; this
5226 is usually what you want since it allows for
5227 maximum initrd size. If for some reason you want to
5228 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005229 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk6c59edc2004-05-03 20:45:30 +00005230 variable to a value of "no" or "off" or "0".
5231 Alternatively, you can set it to a maximum upper
5232 address to use (U-Boot will still check that it
5233 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00005234
wdenk6c59edc2004-05-03 20:45:30 +00005235 For instance, when you have a system with 16 MB
5236 RAM, and want to reserve 4 MB from use by Linux,
5237 you can do this by adding "mem=12M" to the value of
5238 the "bootargs" variable. However, now you must make
5239 sure that the initrd image is placed in the first
5240 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00005241
wdenk6c59edc2004-05-03 20:45:30 +00005242 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00005243
wdenk6c59edc2004-05-03 20:45:30 +00005244 If you set initrd_high to 0xFFFFFFFF, this is an
5245 indication to U-Boot that all addresses are legal
5246 for the Linux kernel, including addresses in flash
5247 memory. In this case U-Boot will NOT COPY the
5248 ramdisk at all. This may be useful to reduce the
5249 boot time on your system, but requires that this
5250 feature is supported by your Linux kernel.
wdenk3f9ab982003-04-12 23:38:12 +00005251
wdenk6c59edc2004-05-03 20:45:30 +00005252 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00005253
wdenk6c59edc2004-05-03 20:45:30 +00005254 loadaddr - Default load address for commands like "bootp",
5255 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00005256
wdenk6c59edc2004-05-03 20:45:30 +00005257 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00005258
wdenk6c59edc2004-05-03 20:45:30 +00005259 serverip - TFTP server IP address; needed for tftpboot command
wdenk6f770ed2003-05-23 23:18:21 +00005260
wdenk6c59edc2004-05-03 20:45:30 +00005261 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00005262
wdenk6c59edc2004-05-03 20:45:30 +00005263 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00005264
wdenk6c59edc2004-05-03 20:45:30 +00005265 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00005266
Mike Frysingera23230c2011-10-02 10:01:27 +00005267 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00005268
Mike Frysingera23230c2011-10-02 10:01:27 +00005269 ethact - controls which interface is currently active.
5270 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00005271
Heiko Schocherc5e84052010-07-20 17:45:02 +02005272 => setenv ethact FEC
5273 => ping 192.168.0.1 # traffic sent on FEC
5274 => setenv ethact SCC
5275 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00005276
Matthias Fuchs204f0ec2008-01-17 07:45:05 +01005277 ethrotate - When set to "no" U-Boot does not go through all
5278 available network interfaces.
5279 It just stays at the currently selected interface.
5280
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005281 netretry - When set to "no" each network operation will
wdenk6c59edc2004-05-03 20:45:30 +00005282 either succeed or fail without retrying.
5283 When set to "once" the network operation will
5284 fail when all the available network interfaces
5285 are tried once without success.
5286 Useful on scripts which control the retry operation
5287 themselves.
wdenkc6097192002-11-03 00:24:07 +00005288
Jean-Christophe PLAGNIOL-VILLARD1948d6c2009-01-31 09:53:39 +01005289 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDd2164ef2008-01-07 08:41:34 +01005290
Simon Glass5db3f932013-07-16 20:10:00 -07005291 silent_linux - If set then linux will be told to boot silently, by
5292 changing the console to be empty. If "yes" it will be
5293 made silent. If "no" it will not be made silent. If
5294 unset, then it will be made silent if the U-Boot console
5295 is silent.
5296
Wolfgang Denk227b5192005-09-24 23:25:46 +02005297 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denke3cfce52005-09-24 22:37:32 +02005298 UDP source port.
5299
Wolfgang Denk227b5192005-09-24 23:25:46 +02005300 tftpdstport - If this is set, the value is used for TFTP's UDP
5301 destination port instead of the Well Know Port 69.
5302
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005303 tftpblocksize - Block size to use for TFTP transfers; if not set,
5304 we use the TFTP server's default block size
5305
5306 tftptimeout - Retransmission timeout for TFTP packets (in milli-
5307 seconds, minimum value is 1000 = 1 second). Defines
5308 when a packet is considered to be lost so it has to
5309 be retransmitted. The default is 5000 = 5 seconds.
5310 Lowering this value may make downloads succeed
5311 faster in networks with high packet loss rates or
5312 with unreliable TFTP servers.
5313
5314 vlan - When set to a value < 4095 the traffic over
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005315 Ethernet is encapsulated/received over 802.1q
wdenk6c59edc2004-05-03 20:45:30 +00005316 VLAN tagged frames.
wdenk145d2c12004-04-15 21:48:45 +00005317
Jason Hobbse3fe08e2011-08-31 05:37:28 +00005318The following image location variables contain the location of images
5319used in booting. The "Image" column gives the role of the image and is
5320not an environment variable name. The other columns are environment
5321variable names. "File Name" gives the name of the file on a TFTP
5322server, "RAM Address" gives the location in RAM the image will be
5323loaded to, and "Flash Location" gives the image's address in NOR
5324flash or offset in NAND flash.
5325
5326*Note* - these variables don't have to be defined for all boards, some
5327boards currenlty use other variables for these purposes, and some
5328boards use these variables for other purposes.
5329
Wolfgang Denk092ae952011-10-26 10:21:21 +00005330Image File Name RAM Address Flash Location
5331----- --------- ----------- --------------
5332u-boot u-boot u-boot_addr_r u-boot_addr
5333Linux kernel bootfile kernel_addr_r kernel_addr
5334device tree blob fdtfile fdt_addr_r fdt_addr
5335ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbse3fe08e2011-08-31 05:37:28 +00005336
wdenk6c59edc2004-05-03 20:45:30 +00005337The following environment variables may be used and automatically
5338updated by the network boot commands ("bootp" and "rarpboot"),
5339depending the information provided by your boot server:
wdenk145d2c12004-04-15 21:48:45 +00005340
wdenk6c59edc2004-05-03 20:45:30 +00005341 bootfile - see above
5342 dnsip - IP address of your Domain Name Server
5343 dnsip2 - IP address of your secondary Domain Name Server
5344 gatewayip - IP address of the Gateway (Router) to use
5345 hostname - Target hostname
5346 ipaddr - see above
5347 netmask - Subnet Mask
5348 rootpath - Pathname of the root filesystem on the NFS server
5349 serverip - see above
wdenk145d2c12004-04-15 21:48:45 +00005350
wdenk145d2c12004-04-15 21:48:45 +00005351
wdenk6c59edc2004-05-03 20:45:30 +00005352There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005353
wdenk6c59edc2004-05-03 20:45:30 +00005354 serial# - contains hardware identification information such
5355 as type string and/or serial number
5356 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00005357
wdenk6c59edc2004-05-03 20:45:30 +00005358These variables can be set only once (usually during manufacturing of
5359the board). U-Boot refuses to delete or overwrite these variables
5360once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00005361
5362
wdenk6c59edc2004-05-03 20:45:30 +00005363Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005364
wdenk6c59edc2004-05-03 20:45:30 +00005365 ver - Contains the U-Boot version string as printed
5366 with the "version" command. This variable is
5367 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00005368
wdenkc6097192002-11-03 00:24:07 +00005369
wdenk6c59edc2004-05-03 20:45:30 +00005370Please note that changes to some configuration parameters may take
5371only effect after the next boot (yes, that's just like Windoze :-).
stroeseb9c17c52003-04-04 15:53:41 +00005372
stroeseb9c17c52003-04-04 15:53:41 +00005373
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005374Callback functions for environment variables:
5375---------------------------------------------
5376
5377For some environment variables, the behavior of u-boot needs to change
5378when their values are changed. This functionailty allows functions to
5379be associated with arbitrary variables. On creation, overwrite, or
5380deletion, the callback will provide the opportunity for some side
5381effect to happen or for the change to be rejected.
5382
5383The callbacks are named and associated with a function using the
5384U_BOOT_ENV_CALLBACK macro in your board or driver code.
5385
5386These callbacks are associated with variables in one of two ways. The
5387static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5388in the board configuration to a string that defines a list of
5389associations. The list must be in the following format:
5390
5391 entry = variable_name[:callback_name]
5392 list = entry[,list]
5393
5394If the callback name is not specified, then the callback is deleted.
5395Spaces are also allowed anywhere in the list.
5396
5397Callbacks can also be associated by defining the ".callbacks" variable
5398with the same list format above. Any association in ".callbacks" will
5399override any association in the static list. You can define
5400CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
5401".callbacks" envirnoment variable in the default or embedded environment.
5402
5403
wdenk6c59edc2004-05-03 20:45:30 +00005404Command Line Parsing:
5405=====================
stroeseb9c17c52003-04-04 15:53:41 +00005406
wdenk6c59edc2004-05-03 20:45:30 +00005407There are two different command line parsers available with U-Boot:
5408the old "simple" one, and the much more powerful "hush" shell:
wdenkc6097192002-11-03 00:24:07 +00005409
wdenk6c59edc2004-05-03 20:45:30 +00005410Old, simple command line parser:
5411--------------------------------
wdenkc6097192002-11-03 00:24:07 +00005412
wdenk6c59edc2004-05-03 20:45:30 +00005413- supports environment variables (through setenv / saveenv commands)
5414- several commands on one line, separated by ';'
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01005415- variable substitution using "... ${name} ..." syntax
wdenk6c59edc2004-05-03 20:45:30 +00005416- special characters ('$', ';') can be escaped by prefixing with '\',
5417 for example:
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01005418 setenv bootcmd bootm \${address}
wdenk6c59edc2004-05-03 20:45:30 +00005419- You can also escape text by enclosing in single apostrophes, for example:
5420 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00005421
wdenk6c59edc2004-05-03 20:45:30 +00005422Hush shell:
5423-----------
wdenkf4688a22003-05-28 08:06:31 +00005424
wdenk6c59edc2004-05-03 20:45:30 +00005425- similar to Bourne shell, with control structures like
5426 if...then...else...fi, for...do...done; while...do...done,
5427 until...do...done, ...
5428- supports environment ("global") variables (through setenv / saveenv
5429 commands) and local shell variables (through standard shell syntax
5430 "name=value"); only environment variables can be used with "run"
5431 command
wdenkf4688a22003-05-28 08:06:31 +00005432
wdenk6c59edc2004-05-03 20:45:30 +00005433General rules:
5434--------------
wdenkf4688a22003-05-28 08:06:31 +00005435
wdenk6c59edc2004-05-03 20:45:30 +00005436(1) If a command line (or an environment variable executed by a "run"
5437 command) contains several commands separated by semicolon, and
5438 one of these commands fails, then the remaining commands will be
5439 executed anyway.
wdenkf4688a22003-05-28 08:06:31 +00005440
wdenk6c59edc2004-05-03 20:45:30 +00005441(2) If you execute several variables with one call to run (i. e.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005442 calling run with a list of variables as arguments), any failing
wdenk6c59edc2004-05-03 20:45:30 +00005443 command will cause "run" to terminate, i. e. the remaining
5444 variables are not executed.
wdenkf4688a22003-05-28 08:06:31 +00005445
wdenk6c59edc2004-05-03 20:45:30 +00005446Note for Redundant Ethernet Interfaces:
5447=======================================
wdenkf4688a22003-05-28 08:06:31 +00005448
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005449Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00005450such configurations and is capable of automatic selection of a
5451"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00005452
wdenk6c59edc2004-05-03 20:45:30 +00005453Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
5454MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5455"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00005456
wdenk6c59edc2004-05-03 20:45:30 +00005457If the network interface stores some valid MAC address (for instance
5458in SROM), this is used as default address if there is NO correspon-
5459ding setting in the environment; if the corresponding environment
5460variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00005461
wdenk6c59edc2004-05-03 20:45:30 +00005462o If the SROM has a valid MAC address, and there is no address in the
5463 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00005464
wdenk6c59edc2004-05-03 20:45:30 +00005465o If there is no valid address in the SROM, and a definition in the
5466 environment exists, then the value from the environment variable is
5467 used.
wdenkc6097192002-11-03 00:24:07 +00005468
wdenk6c59edc2004-05-03 20:45:30 +00005469o If both the SROM and the environment contain a MAC address, and
5470 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00005471
wdenk6c59edc2004-05-03 20:45:30 +00005472o If both the SROM and the environment contain a MAC address, and the
5473 addresses differ, the value from the environment is used and a
5474 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00005475
wdenk6c59edc2004-05-03 20:45:30 +00005476o If neither SROM nor the environment contain a MAC address, an error
5477 is raised.
wdenkc6097192002-11-03 00:24:07 +00005478
Ben Warren6db991a2010-04-26 11:11:46 -07005479If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denk092ae952011-10-26 10:21:21 +00005480will be programmed into hardware as part of the initialization process. This
Ben Warren6db991a2010-04-26 11:11:46 -07005481may be skipped by setting the appropriate 'ethmacskip' environment variable.
5482The naming convention is as follows:
5483"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00005484
wdenk6c59edc2004-05-03 20:45:30 +00005485Image Formats:
5486==============
wdenkc6097192002-11-03 00:24:07 +00005487
Marian Balakowicz18710b82008-03-12 12:13:13 +01005488U-Boot is capable of booting (and performing other auxiliary operations on)
5489images in two formats:
5490
5491New uImage format (FIT)
5492-----------------------
5493
5494Flexible and powerful format based on Flattened Image Tree -- FIT (similar
5495to Flattened Device Tree). It allows the use of images with multiple
5496components (several kernels, ramdisks, etc.), with contents protected by
5497SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
5498
5499
5500Old uImage format
5501-----------------
5502
5503Old image format is based on binary files which can be basically anything,
5504preceded by a special header; see the definitions in include/image.h for
5505details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00005506
wdenk6c59edc2004-05-03 20:45:30 +00005507* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5508 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05005509 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5510 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5511 INTEGRITY).
Wolfgang Denk83c15852006-10-24 14:21:16 +02005512* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Lin1cac36e2011-10-19 20:41:11 +00005513 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5514 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00005515* Compression Type (uncompressed, gzip, bzip2)
5516* Load Address
5517* Entry Point
5518* Image Name
5519* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00005520
wdenk6c59edc2004-05-03 20:45:30 +00005521The header is marked by a special Magic Number, and both the header
5522and the data portions of the image are secured against corruption by
5523CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00005524
wdenkc6097192002-11-03 00:24:07 +00005525
wdenk6c59edc2004-05-03 20:45:30 +00005526Linux Support:
5527==============
wdenkc6097192002-11-03 00:24:07 +00005528
wdenk6c59edc2004-05-03 20:45:30 +00005529Although U-Boot should support any OS or standalone application
5530easily, the main focus has always been on Linux during the design of
5531U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005532
wdenk6c59edc2004-05-03 20:45:30 +00005533U-Boot includes many features that so far have been part of some
5534special "boot loader" code within the Linux kernel. Also, any
5535"initrd" images to be used are no longer part of one big Linux image;
5536instead, kernel and "initrd" are separate images. This implementation
5537serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00005538
wdenk6c59edc2004-05-03 20:45:30 +00005539- the same features can be used for other OS or standalone
5540 applications (for instance: using compressed images to reduce the
5541 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00005542
wdenk6c59edc2004-05-03 20:45:30 +00005543- it becomes much easier to port new Linux kernel versions because
5544 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00005545
wdenk6c59edc2004-05-03 20:45:30 +00005546- the same Linux kernel image can now be used with different "initrd"
5547 images; of course this also means that different kernel images can
5548 be run with the same "initrd". This makes testing easier (you don't
5549 have to build a new "zImage.initrd" Linux image when you just
5550 change a file in your "initrd"). Also, a field-upgrade of the
5551 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00005552
wdenkc6097192002-11-03 00:24:07 +00005553
wdenk6c59edc2004-05-03 20:45:30 +00005554Linux HOWTO:
5555============
wdenkc6097192002-11-03 00:24:07 +00005556
wdenk6c59edc2004-05-03 20:45:30 +00005557Porting Linux to U-Boot based systems:
5558---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00005559
wdenk6c59edc2004-05-03 20:45:30 +00005560U-Boot cannot save you from doing all the necessary modifications to
5561configure the Linux device drivers for use with your target hardware
5562(no, we don't intend to provide a full virtual machine interface to
5563Linux :-).
wdenkc6097192002-11-03 00:24:07 +00005564
Stefan Roese88fbf932010-04-15 16:07:28 +02005565But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00005566
wdenk6c59edc2004-05-03 20:45:30 +00005567Just make sure your machine specific header file (for instance
5568include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02005569Information structure as we define in include/asm-<arch>/u-boot.h,
5570and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005571as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00005572
Simon Glassd097e592014-06-11 23:29:46 -06005573Note that U-Boot now has a driver model, a unified model for drivers.
5574If you are adding a new driver, plumb it into driver model. If there
5575is no uclass available, you are encouraged to create one. See
5576doc/driver-model.
5577
wdenkc6097192002-11-03 00:24:07 +00005578
wdenk6c59edc2004-05-03 20:45:30 +00005579Configuring the Linux kernel:
5580-----------------------------
wdenkc6097192002-11-03 00:24:07 +00005581
wdenk6c59edc2004-05-03 20:45:30 +00005582No specific requirements for U-Boot. Make sure you have some root
5583device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00005584
wdenkc6097192002-11-03 00:24:07 +00005585
wdenk6c59edc2004-05-03 20:45:30 +00005586Building a Linux Image:
5587-----------------------
wdenkc6097192002-11-03 00:24:07 +00005588
wdenk6c59edc2004-05-03 20:45:30 +00005589With U-Boot, "normal" build targets like "zImage" or "bzImage" are
5590not used. If you use recent kernel source, a new build target
5591"uImage" will exist which automatically builds an image usable by
5592U-Boot. Most older kernels also have support for a "pImage" target,
5593which was introduced for our predecessor project PPCBoot and uses a
5594100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00005595
wdenk6c59edc2004-05-03 20:45:30 +00005596Example:
wdenkc6097192002-11-03 00:24:07 +00005597
Holger Freyther7ba4e572014-08-04 09:26:05 +02005598 make TQM850L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00005599 make oldconfig
5600 make dep
5601 make uImage
wdenkc6097192002-11-03 00:24:07 +00005602
wdenk6c59edc2004-05-03 20:45:30 +00005603The "uImage" build target uses a special tool (in 'tools/mkimage') to
5604encapsulate a compressed Linux kernel image with header information,
5605CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00005606
wdenk6c59edc2004-05-03 20:45:30 +00005607* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00005608
wdenk6c59edc2004-05-03 20:45:30 +00005609* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00005610
wdenk6c59edc2004-05-03 20:45:30 +00005611 ${CROSS_COMPILE}-objcopy -O binary \
5612 -R .note -R .comment \
5613 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00005614
wdenk6c59edc2004-05-03 20:45:30 +00005615* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00005616
wdenk6c59edc2004-05-03 20:45:30 +00005617 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00005618
wdenk6c59edc2004-05-03 20:45:30 +00005619* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00005620
wdenk6c59edc2004-05-03 20:45:30 +00005621 mkimage -A ppc -O linux -T kernel -C gzip \
5622 -a 0 -e 0 -n "Linux Kernel Image" \
5623 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00005624
wdenkc6097192002-11-03 00:24:07 +00005625
wdenk6c59edc2004-05-03 20:45:30 +00005626The "mkimage" tool can also be used to create ramdisk images for use
5627with U-Boot, either separated from the Linux kernel image, or
5628combined into one file. "mkimage" encapsulates the images with a 64
5629byte header containing information about target architecture,
5630operating system, image type, compression method, entry points, time
5631stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00005632
wdenk6c59edc2004-05-03 20:45:30 +00005633"mkimage" can be called in two ways: to verify existing images and
5634print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00005635
wdenk6c59edc2004-05-03 20:45:30 +00005636In the first form (with "-l" option) mkimage lists the information
5637contained in the header of an existing U-Boot image; this includes
5638checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00005639
wdenk6c59edc2004-05-03 20:45:30 +00005640 tools/mkimage -l image
5641 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00005642
wdenk6c59edc2004-05-03 20:45:30 +00005643The second form (with "-d" option) is used to build a U-Boot image
5644from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00005645
wdenk6c59edc2004-05-03 20:45:30 +00005646 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5647 -n name -d data_file image
5648 -A ==> set architecture to 'arch'
5649 -O ==> set operating system to 'os'
5650 -T ==> set image type to 'type'
5651 -C ==> set compression type 'comp'
5652 -a ==> set load address to 'addr' (hex)
5653 -e ==> set entry point to 'ep' (hex)
5654 -n ==> set image name to 'name'
5655 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00005656
wdenkcd914452004-05-29 16:53:29 +00005657Right now, all Linux kernels for PowerPC systems use the same load
5658address (0x00000000), but the entry point address depends on the
5659kernel version:
wdenkc6097192002-11-03 00:24:07 +00005660
wdenk6c59edc2004-05-03 20:45:30 +00005661- 2.2.x kernels have the entry point at 0x0000000C,
5662- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00005663
wdenk6c59edc2004-05-03 20:45:30 +00005664So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00005665
wdenk6c59edc2004-05-03 20:45:30 +00005666 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5667 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005668 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk6c59edc2004-05-03 20:45:30 +00005669 > examples/uImage.TQM850L
5670 Image Name: 2.4.4 kernel for TQM850L
5671 Created: Wed Jul 19 02:34:59 2000
5672 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5673 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5674 Load Address: 0x00000000
5675 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005676
wdenk6c59edc2004-05-03 20:45:30 +00005677To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00005678
wdenk6c59edc2004-05-03 20:45:30 +00005679 -> tools/mkimage -l examples/uImage.TQM850L
5680 Image Name: 2.4.4 kernel for TQM850L
5681 Created: Wed Jul 19 02:34:59 2000
5682 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5683 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5684 Load Address: 0x00000000
5685 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005686
wdenk6c59edc2004-05-03 20:45:30 +00005687NOTE: for embedded systems where boot time is critical you can trade
5688speed for memory and install an UNCOMPRESSED image instead: this
5689needs more space in Flash, but boots much faster since it does not
5690need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00005691
Stefan Roese88fbf932010-04-15 16:07:28 +02005692 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk6c59edc2004-05-03 20:45:30 +00005693 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5694 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005695 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk6c59edc2004-05-03 20:45:30 +00005696 > examples/uImage.TQM850L-uncompressed
5697 Image Name: 2.4.4 kernel for TQM850L
5698 Created: Wed Jul 19 02:34:59 2000
5699 Image Type: PowerPC Linux Kernel Image (uncompressed)
5700 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5701 Load Address: 0x00000000
5702 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005703
wdenkc6097192002-11-03 00:24:07 +00005704
wdenk6c59edc2004-05-03 20:45:30 +00005705Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5706when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00005707
wdenk6c59edc2004-05-03 20:45:30 +00005708 -> tools/mkimage -n 'Simple Ramdisk Image' \
5709 > -A ppc -O linux -T ramdisk -C gzip \
5710 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5711 Image Name: Simple Ramdisk Image
5712 Created: Wed Jan 12 14:01:50 2000
5713 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5714 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5715 Load Address: 0x00000000
5716 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005717
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07005718The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5719option performs the converse operation of the mkimage's second form (the "-d"
5720option). Given an image built by mkimage, the dumpimage extracts a "data file"
5721from the image:
5722
5723 tools/dumpimage -i image -p position data_file
5724 -i ==> extract from the 'image' a specific 'data_file', \
5725 indexed by 'position'
5726
wdenkc6097192002-11-03 00:24:07 +00005727
wdenk6c59edc2004-05-03 20:45:30 +00005728Installing a Linux Image:
5729-------------------------
wdenkc6097192002-11-03 00:24:07 +00005730
wdenk6c59edc2004-05-03 20:45:30 +00005731To downloading a U-Boot image over the serial (console) interface,
5732you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00005733
wdenk6c59edc2004-05-03 20:45:30 +00005734 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00005735
wdenk6c59edc2004-05-03 20:45:30 +00005736The 'objcopy' does not understand the information in the U-Boot
5737image header, so the resulting S-Record file will be relative to
5738address 0x00000000. To load it to a given address, you need to
5739specify the target address as 'offset' parameter with the 'loads'
5740command.
wdenkc6097192002-11-03 00:24:07 +00005741
wdenk6c59edc2004-05-03 20:45:30 +00005742Example: install the image to address 0x40100000 (which on the
5743TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00005744
wdenk6c59edc2004-05-03 20:45:30 +00005745 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00005746
wdenk6c59edc2004-05-03 20:45:30 +00005747 .......... done
5748 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00005749
wdenk6c59edc2004-05-03 20:45:30 +00005750 => loads 40100000
5751 ## Ready for S-Record download ...
5752 ~>examples/image.srec
5753 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5754 ...
5755 15989 15990 15991 15992
5756 [file transfer complete]
5757 [connected]
5758 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005759
wdenkc6097192002-11-03 00:24:07 +00005760
wdenk6c59edc2004-05-03 20:45:30 +00005761You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005762this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00005763corruption happened:
wdenkc6097192002-11-03 00:24:07 +00005764
wdenk6c59edc2004-05-03 20:45:30 +00005765 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00005766
wdenk6c59edc2004-05-03 20:45:30 +00005767 ## Checking Image at 40100000 ...
5768 Image Name: 2.2.13 for initrd on TQM850L
5769 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5770 Data Size: 335725 Bytes = 327 kB = 0 MB
5771 Load Address: 00000000
5772 Entry Point: 0000000c
5773 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005774
5775
wdenk6c59edc2004-05-03 20:45:30 +00005776Boot Linux:
5777-----------
wdenkc6097192002-11-03 00:24:07 +00005778
wdenk6c59edc2004-05-03 20:45:30 +00005779The "bootm" command is used to boot an application that is stored in
5780memory (RAM or Flash). In case of a Linux kernel image, the contents
5781of the "bootargs" environment variable is passed to the kernel as
5782parameters. You can check and modify this variable using the
5783"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00005784
wdenkc6097192002-11-03 00:24:07 +00005785
wdenk6c59edc2004-05-03 20:45:30 +00005786 => printenv bootargs
5787 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00005788
wdenk6c59edc2004-05-03 20:45:30 +00005789 => 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 +00005790
wdenk6c59edc2004-05-03 20:45:30 +00005791 => printenv bootargs
5792 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 +00005793
wdenk6c59edc2004-05-03 20:45:30 +00005794 => bootm 40020000
5795 ## Booting Linux kernel at 40020000 ...
5796 Image Name: 2.2.13 for NFS on TQM850L
5797 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5798 Data Size: 381681 Bytes = 372 kB = 0 MB
5799 Load Address: 00000000
5800 Entry Point: 0000000c
5801 Verifying Checksum ... OK
5802 Uncompressing Kernel Image ... OK
5803 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
5804 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5805 time_init: decrementer frequency = 187500000/60
5806 Calibrating delay loop... 49.77 BogoMIPS
5807 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5808 ...
wdenkc6097192002-11-03 00:24:07 +00005809
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005810If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00005811the memory addresses of both the kernel and the initrd image (PPBCOOT
5812format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00005813
wdenk6c59edc2004-05-03 20:45:30 +00005814 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00005815
wdenk6c59edc2004-05-03 20:45:30 +00005816 ## Checking Image at 40100000 ...
5817 Image Name: 2.2.13 for initrd on TQM850L
5818 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5819 Data Size: 335725 Bytes = 327 kB = 0 MB
5820 Load Address: 00000000
5821 Entry Point: 0000000c
5822 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005823
wdenk6c59edc2004-05-03 20:45:30 +00005824 ## Checking Image at 40200000 ...
5825 Image Name: Simple Ramdisk Image
5826 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5827 Data Size: 566530 Bytes = 553 kB = 0 MB
5828 Load Address: 00000000
5829 Entry Point: 00000000
5830 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005831
wdenk6c59edc2004-05-03 20:45:30 +00005832 => bootm 40100000 40200000
5833 ## Booting Linux kernel at 40100000 ...
5834 Image Name: 2.2.13 for initrd on TQM850L
5835 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5836 Data Size: 335725 Bytes = 327 kB = 0 MB
5837 Load Address: 00000000
5838 Entry Point: 0000000c
5839 Verifying Checksum ... OK
5840 Uncompressing Kernel Image ... OK
5841 ## Loading RAMDisk Image at 40200000 ...
5842 Image Name: Simple Ramdisk Image
5843 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5844 Data Size: 566530 Bytes = 553 kB = 0 MB
5845 Load Address: 00000000
5846 Entry Point: 00000000
5847 Verifying Checksum ... OK
5848 Loading Ramdisk ... OK
5849 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
5850 Boot arguments: root=/dev/ram
5851 time_init: decrementer frequency = 187500000/60
5852 Calibrating delay loop... 49.77 BogoMIPS
5853 ...
5854 RAMDISK: Compressed image found at block 0
5855 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00005856
wdenk6c59edc2004-05-03 20:45:30 +00005857 bash#
wdenkc6097192002-11-03 00:24:07 +00005858
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005859Boot Linux and pass a flat device tree:
5860-----------
5861
5862First, U-Boot must be compiled with the appropriate defines. See the section
5863titled "Linux Kernel Interface" above for a more in depth explanation. The
5864following is an example of how to start a kernel and pass an updated
5865flat device tree:
5866
5867=> print oftaddr
5868oftaddr=0x300000
5869=> print oft
5870oft=oftrees/mpc8540ads.dtb
5871=> tftp $oftaddr $oft
5872Speed: 1000, full duplex
5873Using TSEC0 device
5874TFTP from server 192.168.1.1; our IP address is 192.168.1.101
5875Filename 'oftrees/mpc8540ads.dtb'.
5876Load address: 0x300000
5877Loading: #
5878done
5879Bytes transferred = 4106 (100a hex)
5880=> tftp $loadaddr $bootfile
5881Speed: 1000, full duplex
5882Using TSEC0 device
5883TFTP from server 192.168.1.1; our IP address is 192.168.1.2
5884Filename 'uImage'.
5885Load address: 0x200000
5886Loading:############
5887done
5888Bytes transferred = 1029407 (fb51f hex)
5889=> print loadaddr
5890loadaddr=200000
5891=> print oftaddr
5892oftaddr=0x300000
5893=> bootm $loadaddr - $oftaddr
5894## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01005895 Image Name: Linux-2.6.17-dirty
5896 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5897 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005898 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01005899 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005900 Verifying Checksum ... OK
5901 Uncompressing Kernel Image ... OK
5902Booting using flat device tree at 0x300000
5903Using MPC85xx ADS machine description
5904Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
5905[snip]
5906
5907
wdenk6c59edc2004-05-03 20:45:30 +00005908More About U-Boot Image Types:
5909------------------------------
wdenkc6097192002-11-03 00:24:07 +00005910
wdenk6c59edc2004-05-03 20:45:30 +00005911U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00005912
wdenk6c59edc2004-05-03 20:45:30 +00005913 "Standalone Programs" are directly runnable in the environment
5914 provided by U-Boot; it is expected that (if they behave
5915 well) you can continue to work in U-Boot after return from
5916 the Standalone Program.
5917 "OS Kernel Images" are usually images of some Embedded OS which
5918 will take over control completely. Usually these programs
5919 will install their own set of exception handlers, device
5920 drivers, set up the MMU, etc. - this means, that you cannot
5921 expect to re-enter U-Boot except by resetting the CPU.
5922 "RAMDisk Images" are more or less just data blocks, and their
5923 parameters (address, size) are passed to an OS kernel that is
5924 being started.
5925 "Multi-File Images" contain several images, typically an OS
5926 (Linux) kernel image and one or more data images like
5927 RAMDisks. This construct is useful for instance when you want
5928 to boot over the network using BOOTP etc., where the boot
5929 server provides just a single image file, but you want to get
5930 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00005931
wdenk6c59edc2004-05-03 20:45:30 +00005932 "Multi-File Images" start with a list of image sizes, each
5933 image size (in bytes) specified by an "uint32_t" in network
5934 byte order. This list is terminated by an "(uint32_t)0".
5935 Immediately after the terminating 0 follow the images, one by
5936 one, all aligned on "uint32_t" boundaries (size rounded up to
5937 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00005938
wdenk6c59edc2004-05-03 20:45:30 +00005939 "Firmware Images" are binary images containing firmware (like
5940 U-Boot or FPGA images) which usually will be programmed to
5941 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00005942
wdenk6c59edc2004-05-03 20:45:30 +00005943 "Script files" are command sequences that will be executed by
5944 U-Boot's command interpreter; this feature is especially
5945 useful when you configure U-Boot to use a real shell (hush)
5946 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00005947
Marek Vasutcf41a9b2012-03-14 21:52:45 +00005948Booting the Linux zImage:
5949-------------------------
5950
5951On some platforms, it's possible to boot Linux zImage. This is done
5952using the "bootz" command. The syntax of "bootz" command is the same
5953as the syntax of "bootm" command.
5954
Tom Rini45f46d12013-05-16 11:40:11 -04005955Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut28850d02012-03-18 11:47:58 +00005956kernel with raw initrd images. The syntax is slightly different, the
5957address of the initrd must be augmented by it's size, in the following
5958format: "<initrd addres>:<initrd size>".
5959
stroeseb9c17c52003-04-04 15:53:41 +00005960
wdenk6c59edc2004-05-03 20:45:30 +00005961Standalone HOWTO:
5962=================
stroeseb9c17c52003-04-04 15:53:41 +00005963
wdenk6c59edc2004-05-03 20:45:30 +00005964One of the features of U-Boot is that you can dynamically load and
5965run "standalone" applications, which can use some resources of
5966U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00005967
wdenk6c59edc2004-05-03 20:45:30 +00005968Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00005969
wdenk6c59edc2004-05-03 20:45:30 +00005970"Hello World" Demo:
5971-------------------
wdenkc6097192002-11-03 00:24:07 +00005972
wdenk6c59edc2004-05-03 20:45:30 +00005973'examples/hello_world.c' contains a small "Hello World" Demo
5974application; it is automatically compiled when you build U-Boot.
5975It's configured to run at address 0x00040004, so you can play with it
5976like that:
wdenkc6097192002-11-03 00:24:07 +00005977
wdenk6c59edc2004-05-03 20:45:30 +00005978 => loads
5979 ## Ready for S-Record download ...
5980 ~>examples/hello_world.srec
5981 1 2 3 4 5 6 7 8 9 10 11 ...
5982 [file transfer complete]
5983 [connected]
5984 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005985
wdenk6c59edc2004-05-03 20:45:30 +00005986 => go 40004 Hello World! This is a test.
5987 ## Starting application at 0x00040004 ...
5988 Hello World
5989 argc = 7
5990 argv[0] = "40004"
5991 argv[1] = "Hello"
5992 argv[2] = "World!"
5993 argv[3] = "This"
5994 argv[4] = "is"
5995 argv[5] = "a"
5996 argv[6] = "test."
5997 argv[7] = "<NULL>"
5998 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00005999
wdenk6c59edc2004-05-03 20:45:30 +00006000 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00006001
wdenk6c59edc2004-05-03 20:45:30 +00006002Another example, which demonstrates how to register a CPM interrupt
6003handler with the U-Boot code, can be found in 'examples/timer.c'.
6004Here, a CPM timer is set up to generate an interrupt every second.
6005The interrupt service routine is trivial, just printing a '.'
6006character, but this is just a demo program. The application can be
6007controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00006008
wdenk6c59edc2004-05-03 20:45:30 +00006009 ? - print current values og the CPM Timer registers
6010 b - enable interrupts and start timer
6011 e - stop timer and disable interrupts
6012 q - quit application
wdenkc6097192002-11-03 00:24:07 +00006013
wdenk6c59edc2004-05-03 20:45:30 +00006014 => loads
6015 ## Ready for S-Record download ...
6016 ~>examples/timer.srec
6017 1 2 3 4 5 6 7 8 9 10 11 ...
6018 [file transfer complete]
6019 [connected]
6020 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00006021
wdenk6c59edc2004-05-03 20:45:30 +00006022 => go 40004
6023 ## Starting application at 0x00040004 ...
6024 TIMERS=0xfff00980
6025 Using timer 1
6026 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00006027
wdenk6c59edc2004-05-03 20:45:30 +00006028Hit 'b':
6029 [q, b, e, ?] Set interval 1000000 us
6030 Enabling timer
6031Hit '?':
6032 [q, b, e, ?] ........
6033 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
6034Hit '?':
6035 [q, b, e, ?] .
6036 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
6037Hit '?':
6038 [q, b, e, ?] .
6039 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
6040Hit '?':
6041 [q, b, e, ?] .
6042 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
6043Hit 'e':
6044 [q, b, e, ?] ...Stopping timer
6045Hit 'q':
6046 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00006047
wdenkc6097192002-11-03 00:24:07 +00006048
wdenk6c59edc2004-05-03 20:45:30 +00006049Minicom warning:
6050================
wdenkc6097192002-11-03 00:24:07 +00006051
wdenk6c59edc2004-05-03 20:45:30 +00006052Over time, many people have reported problems when trying to use the
6053"minicom" terminal emulation program for serial download. I (wd)
6054consider minicom to be broken, and recommend not to use it. Under
6055Unix, I recommend to use C-Kermit for general purpose use (and
6056especially for kermit binary protocol download ("loadb" command), and
Karl O. Pinca0189bb2012-10-01 05:11:56 +00006057use "cu" for S-Record download ("loads" command). See
6058http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
6059for help with kermit.
6060
wdenkc6097192002-11-03 00:24:07 +00006061
wdenk6c59edc2004-05-03 20:45:30 +00006062Nevertheless, if you absolutely want to use it try adding this
6063configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00006064
wdenk6c59edc2004-05-03 20:45:30 +00006065 Name Program Name U/D FullScr IO-Red. Multi
6066 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
6067 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00006068
wdenk8dba0502003-03-31 16:34:49 +00006069
wdenk6c59edc2004-05-03 20:45:30 +00006070NetBSD Notes:
6071=============
wdenkc6097192002-11-03 00:24:07 +00006072
wdenk6c59edc2004-05-03 20:45:30 +00006073Starting at version 0.9.2, U-Boot supports NetBSD both as host
6074(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00006075
wdenk6c59edc2004-05-03 20:45:30 +00006076Building requires a cross environment; it is known to work on
6077NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
6078need gmake since the Makefiles are not compatible with BSD make).
6079Note that the cross-powerpc package does not install include files;
6080attempting to build U-Boot will fail because <machine/ansi.h> is
6081missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00006082
wdenk6c59edc2004-05-03 20:45:30 +00006083 # cd /usr/pkg/cross/powerpc-netbsd/include
6084 # mkdir powerpc
6085 # ln -s powerpc machine
6086 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
6087 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00006088
wdenk6c59edc2004-05-03 20:45:30 +00006089Native builds *don't* work due to incompatibilities between native
6090and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00006091
wdenk6c59edc2004-05-03 20:45:30 +00006092Booting assumes that (the first part of) the image booted is a
6093stage-2 loader which in turn loads and then invokes the kernel
6094proper. Loader sources will eventually appear in the NetBSD source
6095tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00006096meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00006097
wdenkc6097192002-11-03 00:24:07 +00006098
wdenk6c59edc2004-05-03 20:45:30 +00006099Implementation Internals:
6100=========================
wdenkc6097192002-11-03 00:24:07 +00006101
wdenk6c59edc2004-05-03 20:45:30 +00006102The following is not intended to be a complete description of every
6103implementation detail. However, it should help to understand the
6104inner workings of U-Boot and make it easier to port it to custom
6105hardware.
wdenkc6097192002-11-03 00:24:07 +00006106
wdenkc6097192002-11-03 00:24:07 +00006107
wdenk6c59edc2004-05-03 20:45:30 +00006108Initial Stack, Global Data:
6109---------------------------
wdenkc6097192002-11-03 00:24:07 +00006110
wdenk6c59edc2004-05-03 20:45:30 +00006111The implementation of U-Boot is complicated by the fact that U-Boot
6112starts running out of ROM (flash memory), usually without access to
6113system RAM (because the memory controller is not initialized yet).
6114This means that we don't have writable Data or BSS segments, and BSS
6115is not initialized as zero. To be able to get a C environment working
6116at all, we have to allocate at least a minimal stack. Implementation
6117options for this are defined and restricted by the CPU used: Some CPU
6118models provide on-chip memory (like the IMMR area on MPC8xx and
6119MPC826x processors), on others (parts of) the data cache can be
6120locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00006121
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006122 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006123 U-Boot mailing list:
wdenkc6097192002-11-03 00:24:07 +00006124
wdenk6c59edc2004-05-03 20:45:30 +00006125 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
6126 From: "Chris Hallinan" <clh@net1plus.com>
6127 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
6128 ...
wdenkc6097192002-11-03 00:24:07 +00006129
wdenk6c59edc2004-05-03 20:45:30 +00006130 Correct me if I'm wrong, folks, but the way I understand it
6131 is this: Using DCACHE as initial RAM for Stack, etc, does not
6132 require any physical RAM backing up the cache. The cleverness
6133 is that the cache is being used as a temporary supply of
6134 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006135 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00006136 can see how this works by studying the cache architecture and
6137 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00006138
wdenk6c59edc2004-05-03 20:45:30 +00006139 OCM is On Chip Memory, which I believe the 405GP has 4K. It
6140 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006141 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00006142 option should work for you. Using CS 4 should be fine if your
6143 board designers haven't used it for something that would
6144 cause you grief during the initial boot! It is frequently not
6145 used.
wdenkc6097192002-11-03 00:24:07 +00006146
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02006147 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00006148 with your processor/board/system design. The default value
6149 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02006150 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00006151 than your SDRAM module. If you have a 64MB SDRAM module, set
6152 it above 400_0000. Just make sure your board has no resources
6153 that are supposed to respond to that address! That code in
6154 start.S has been around a while and should work as is when
6155 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00006156
wdenk6c59edc2004-05-03 20:45:30 +00006157 -Chris Hallinan
6158 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00006159
wdenk6c59edc2004-05-03 20:45:30 +00006160It is essential to remember this, since it has some impact on the C
6161code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00006162
wdenk6c59edc2004-05-03 20:45:30 +00006163* Initialized global data (data segment) is read-only. Do not attempt
6164 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00006165
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006166* Do not use any uninitialized global data (or implicitely initialized
wdenk6c59edc2004-05-03 20:45:30 +00006167 as zero data - BSS segment) at all - this is undefined, initiali-
6168 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00006169
wdenk6c59edc2004-05-03 20:45:30 +00006170* Stack space is very limited. Avoid big data buffers or things like
6171 that.
wdenk4a5c8a72003-03-06 00:02:04 +00006172
wdenk6c59edc2004-05-03 20:45:30 +00006173Having only the stack as writable memory limits means we cannot use
6174normal global data to share information beween the code. But it
6175turned out that the implementation of U-Boot can be greatly
6176simplified by making a global data structure (gd_t) available to all
6177functions. We could pass a pointer to this data as argument to _all_
6178functions, but this would bloat the code. Instead we use a feature of
6179the GCC compiler (Global Register Variables) to share the data: we
6180place a pointer (gd) to the global data into a register which we
6181reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00006182
wdenk6c59edc2004-05-03 20:45:30 +00006183When choosing a register for such a purpose we are restricted by the
6184relevant (E)ABI specifications for the current architecture, and by
6185GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00006186
wdenk6c59edc2004-05-03 20:45:30 +00006187For PowerPC, the following registers have specific use:
6188 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01006189 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00006190 R3-R4: parameter passing and return values
6191 R5-R10: parameter passing
6192 R13: small data area pointer
6193 R30: GOT pointer
6194 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00006195
Joakim Tjernlund693c0c12010-01-19 14:41:58 +01006196 (U-Boot also uses R12 as internal GOT pointer. r12
6197 is a volatile register so r12 needs to be reset when
6198 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00006199
Wolfgang Denk69c09642008-02-14 22:43:22 +01006200 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00006201
wdenk6c59edc2004-05-03 20:45:30 +00006202 Note: on PPC, we could use a static initializer (since the
6203 address of the global data structure is known at compile time),
6204 but it turned out that reserving a register results in somewhat
6205 smaller code - although the code savings are not that big (on
6206 average for all boards 752 bytes for the whole U-Boot image,
6207 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00006208
Robin Getz2773d5f2009-08-17 15:23:02 +00006209On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger60f09302008-02-04 19:26:54 -05006210 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
6211
Robin Getz2773d5f2009-08-17 15:23:02 +00006212 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger60f09302008-02-04 19:26:54 -05006213
wdenk6c59edc2004-05-03 20:45:30 +00006214On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00006215
wdenk6c59edc2004-05-03 20:45:30 +00006216 R0: function argument word/integer result
6217 R1-R3: function argument word
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02006218 R9: platform specific
6219 R10: stack limit (used only if stack checking is enabled)
wdenk6c59edc2004-05-03 20:45:30 +00006220 R11: argument (frame) pointer
6221 R12: temporary workspace
6222 R13: stack pointer
6223 R14: link register
6224 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00006225
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02006226 ==> U-Boot will use R9 to hold a pointer to the global data
6227
6228 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00006229
Thomas Chou8fa38582010-05-21 11:08:03 +08006230On Nios II, the ABI is documented here:
6231 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
6232
6233 ==> U-Boot will use gp to hold a pointer to the global data
6234
6235 Note: on Nios II, we give "-G0" option to gcc and don't use gp
6236 to access small data sections, so gp is free.
6237
Macpaul Lin1cac36e2011-10-19 20:41:11 +00006238On NDS32, the following registers are used:
6239
6240 R0-R1: argument/return
6241 R2-R5: argument
6242 R15: temporary register for assembler
6243 R16: trampoline register
6244 R28: frame pointer (FP)
6245 R29: global pointer (GP)
6246 R30: link register (LP)
6247 R31: stack pointer (SP)
6248 PC: program counter (PC)
6249
6250 ==> U-Boot will use R10 to hold a pointer to the global data
6251
Wolfgang Denk6405a152006-03-31 18:32:53 +02006252NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
6253or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00006254
wdenk6c59edc2004-05-03 20:45:30 +00006255Memory Management:
6256------------------
wdenkc6097192002-11-03 00:24:07 +00006257
wdenk6c59edc2004-05-03 20:45:30 +00006258U-Boot runs in system state and uses physical addresses, i.e. the
6259MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00006260
wdenk6c59edc2004-05-03 20:45:30 +00006261The available memory is mapped to fixed addresses using the memory
6262controller. In this process, a contiguous block is formed for each
6263memory type (Flash, SDRAM, SRAM), even when it consists of several
6264physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00006265
wdenk6c59edc2004-05-03 20:45:30 +00006266U-Boot is installed in the first 128 kB of the first Flash bank (on
6267TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
6268booting and sizing and initializing DRAM, the code relocates itself
6269to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02006270memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00006271configuration setting]. Below that, a structure with global Board
6272Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00006273
wdenk6c59edc2004-05-03 20:45:30 +00006274Additionally, some exception handler code is copied to the low 8 kB
6275of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00006276
wdenk6c59edc2004-05-03 20:45:30 +00006277So a typical memory configuration with 16 MB of DRAM could look like
6278this:
wdenkc6097192002-11-03 00:24:07 +00006279
wdenk6c59edc2004-05-03 20:45:30 +00006280 0x0000 0000 Exception Vector code
6281 :
6282 0x0000 1FFF
6283 0x0000 2000 Free for Application Use
6284 :
6285 :
wdenkc6097192002-11-03 00:24:07 +00006286
wdenk6c59edc2004-05-03 20:45:30 +00006287 :
6288 :
6289 0x00FB FF20 Monitor Stack (Growing downward)
6290 0x00FB FFAC Board Info Data and permanent copy of global data
6291 0x00FC 0000 Malloc Arena
6292 :
6293 0x00FD FFFF
6294 0x00FE 0000 RAM Copy of Monitor Code
6295 ... eventually: LCD or video framebuffer
6296 ... eventually: pRAM (Protected RAM - unchanged by reset)
6297 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00006298
wdenkc6097192002-11-03 00:24:07 +00006299
wdenk6c59edc2004-05-03 20:45:30 +00006300System Initialization:
6301----------------------
wdenkc6097192002-11-03 00:24:07 +00006302
wdenk6c59edc2004-05-03 20:45:30 +00006303In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006304(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk6c59edc2004-05-03 20:45:30 +00006305configuration for CS0# this is a mirror of the onboard Flash memory.
6306To be able to re-map memory U-Boot then jumps to its link address.
6307To be able to implement the initialization code in C, a (small!)
6308initial stack is set up in the internal Dual Ported RAM (in case CPUs
6309which provide such a feature like MPC8xx or MPC8260), or in a locked
6310part of the data cache. After that, U-Boot initializes the CPU core,
6311the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00006312
wdenk6c59edc2004-05-03 20:45:30 +00006313Next, all (potentially) available memory banks are mapped using a
6314preliminary mapping. For example, we put them on 512 MB boundaries
6315(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
6316on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
6317programmed for SDRAM access. Using the temporary configuration, a
6318simple memory test is run that determines the size of the SDRAM
6319banks.
wdenkc6097192002-11-03 00:24:07 +00006320
wdenk6c59edc2004-05-03 20:45:30 +00006321When there is more than one SDRAM bank, and the banks are of
6322different size, the largest is mapped first. For equal size, the first
6323bank (CS2#) is mapped first. The first mapping is always for address
63240x00000000, with any additional banks following immediately to create
6325contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00006326
wdenk6c59edc2004-05-03 20:45:30 +00006327Then, the monitor installs itself at the upper end of the SDRAM area
6328and allocates memory for use by malloc() and for the global Board
6329Info data; also, the exception vector code is copied to the low RAM
6330pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00006331
wdenk6c59edc2004-05-03 20:45:30 +00006332Only after this relocation will you have a "normal" C environment;
6333until that you are restricted in several ways, mostly because you are
6334running from ROM, and because the code will have to be relocated to a
6335new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00006336
wdenkc6097192002-11-03 00:24:07 +00006337
wdenk6c59edc2004-05-03 20:45:30 +00006338U-Boot Porting Guide:
6339----------------------
wdenkc6097192002-11-03 00:24:07 +00006340
wdenk6c59edc2004-05-03 20:45:30 +00006341[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
6342list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00006343
wdenkc6097192002-11-03 00:24:07 +00006344
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006345int main(int argc, char *argv[])
wdenk6c59edc2004-05-03 20:45:30 +00006346{
6347 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00006348
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006349 signal(SIGALRM, no_more_time);
6350 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00006351
wdenk6c59edc2004-05-03 20:45:30 +00006352 if (available_money > available_manpower) {
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006353 Pay consultant to port U-Boot;
wdenk6c59edc2004-05-03 20:45:30 +00006354 return 0;
6355 }
wdenkc6097192002-11-03 00:24:07 +00006356
wdenk6c59edc2004-05-03 20:45:30 +00006357 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00006358
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006359 Subscribe to u-boot mailing list;
wdenkc6097192002-11-03 00:24:07 +00006360
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006361 if (clueless)
6362 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00006363
wdenk6c59edc2004-05-03 20:45:30 +00006364 while (learning) {
6365 Read the README file in the top level directory;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006366 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
6367 Read applicable doc/*.README;
wdenk6c59edc2004-05-03 20:45:30 +00006368 Read the source, Luke;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006369 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk6c59edc2004-05-03 20:45:30 +00006370 }
wdenkc6097192002-11-03 00:24:07 +00006371
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006372 if (available_money > toLocalCurrency ($2500))
6373 Buy a BDI3000;
6374 else
wdenk6c59edc2004-05-03 20:45:30 +00006375 Add a lot of aggravation and time;
wdenkc6097192002-11-03 00:24:07 +00006376
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006377 if (a similar board exists) { /* hopefully... */
6378 cp -a board/<similar> board/<myboard>
6379 cp include/configs/<similar>.h include/configs/<myboard>.h
6380 } else {
6381 Create your own board support subdirectory;
6382 Create your own board include/configs/<myboard>.h file;
6383 }
6384 Edit new board/<myboard> files
6385 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00006386
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006387 while (!accepted) {
6388 while (!running) {
6389 do {
6390 Add / modify source code;
6391 } until (compiles);
6392 Debug;
6393 if (clueless)
6394 email("Hi, I am having problems...");
6395 }
6396 Send patch file to the U-Boot email list;
6397 if (reasonable critiques)
6398 Incorporate improvements from email list code review;
6399 else
6400 Defend code as written;
wdenk634d2f72004-04-15 23:14:49 +00006401 }
wdenkc6097192002-11-03 00:24:07 +00006402
wdenk6c59edc2004-05-03 20:45:30 +00006403 return 0;
6404}
wdenkc6097192002-11-03 00:24:07 +00006405
wdenk6c59edc2004-05-03 20:45:30 +00006406void no_more_time (int sig)
6407{
6408 hire_a_guru();
6409}
wdenkc6097192002-11-03 00:24:07 +00006410
wdenkc6097192002-11-03 00:24:07 +00006411
wdenk6c59edc2004-05-03 20:45:30 +00006412Coding Standards:
6413-----------------
wdenkc6097192002-11-03 00:24:07 +00006414
wdenk6c59edc2004-05-03 20:45:30 +00006415All contributions to U-Boot should conform to the Linux kernel
Detlev Zundelaa63d482006-09-01 15:39:02 +02006416coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006417"scripts/Lindent" in your Linux kernel source directory.
Detlev Zundelaa63d482006-09-01 15:39:02 +02006418
6419Source files originating from a different project (for example the
6420MTD subsystem) are generally exempt from these guidelines and are not
6421reformated to ease subsequent migration to newer versions of those
6422sources.
wdenkc6097192002-11-03 00:24:07 +00006423
Detlev Zundelaa63d482006-09-01 15:39:02 +02006424Please note that U-Boot is implemented in C (and to some small parts in
6425Assembler); no C++ is used, so please do not use C++ style comments (//)
6426in your code.
wdenkad276f22004-01-04 16:28:35 +00006427
wdenk6c59edc2004-05-03 20:45:30 +00006428Please also stick to the following formatting rules:
6429- remove any trailing white space
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006430- use TAB characters for indentation and vertical alignment, not spaces
wdenk6c59edc2004-05-03 20:45:30 +00006431- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006432- do not add more than 2 consecutive empty lines to source files
wdenk6c59edc2004-05-03 20:45:30 +00006433- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00006434
wdenk6c59edc2004-05-03 20:45:30 +00006435Submissions which do not conform to the standards may be returned
6436with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00006437
wdenkc6097192002-11-03 00:24:07 +00006438
wdenk6c59edc2004-05-03 20:45:30 +00006439Submitting Patches:
6440-------------------
wdenkc6097192002-11-03 00:24:07 +00006441
wdenk6c59edc2004-05-03 20:45:30 +00006442Since the number of patches for U-Boot is growing, we need to
6443establish some rules. Submissions which do not conform to these rules
6444may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00006445
Magnus Liljaf3b287b2008-08-06 19:32:33 +02006446Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006447
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006448Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
6449see http://lists.denx.de/mailman/listinfo/u-boot
6450
wdenk6c59edc2004-05-03 20:45:30 +00006451When you send a patch, please include the following information with
6452it:
wdenkc6097192002-11-03 00:24:07 +00006453
wdenk6c59edc2004-05-03 20:45:30 +00006454* For bug fixes: a description of the bug and how your patch fixes
6455 this bug. Please try to include a way of demonstrating that the
6456 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00006457
wdenk6c59edc2004-05-03 20:45:30 +00006458* For new features: a description of the feature and your
6459 implementation.
wdenkc6097192002-11-03 00:24:07 +00006460
wdenk6c59edc2004-05-03 20:45:30 +00006461* A CHANGELOG entry as plaintext (separate from the patch)
wdenkc6097192002-11-03 00:24:07 +00006462
wdenk6c59edc2004-05-03 20:45:30 +00006463* For major contributions, your entry to the CREDITS file
wdenkc6097192002-11-03 00:24:07 +00006464
Albert ARIBAUD48e910f2013-09-11 15:52:51 +02006465* When you add support for a new board, don't forget to add a
6466 maintainer e-mail address to the boards.cfg file, too.
wdenkc6097192002-11-03 00:24:07 +00006467
wdenk6c59edc2004-05-03 20:45:30 +00006468* If your patch adds new configuration options, don't forget to
6469 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00006470
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006471* The patch itself. If you are using git (which is *strongly*
6472 recommended) you can easily generate the patch using the
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006473 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006474 the U-Boot mailing list, you will avoid most of the common problems
6475 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00006476
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006477 If you cannot use git, use "diff -purN OLD NEW". If your version of
6478 diff does not support these options, then get the latest version of
6479 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00006480
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006481 The current directory when running this command shall be the parent
6482 directory of the U-Boot source tree (i. e. please make sure that
6483 your patch includes sufficient directory information for the
6484 affected files).
6485
6486 We prefer patches as plain text. MIME attachments are discouraged,
6487 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00006488
wdenk6c59edc2004-05-03 20:45:30 +00006489* If one logical set of modifications affects or creates several
6490 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00006491
wdenk6c59edc2004-05-03 20:45:30 +00006492* Changesets that contain different, unrelated modifications shall be
6493 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00006494
wdenkc6097192002-11-03 00:24:07 +00006495
wdenk6c59edc2004-05-03 20:45:30 +00006496Notes:
wdenkc6097192002-11-03 00:24:07 +00006497
wdenk6c59edc2004-05-03 20:45:30 +00006498* Before sending the patch, run the MAKEALL script on your patched
6499 source tree and make sure that no errors or warnings are reported
6500 for any of the boards.
6501
6502* Keep your modifications to the necessary minimum: A patch
6503 containing several unrelated changes or arbitrary reformats will be
6504 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00006505
wdenk6c59edc2004-05-03 20:45:30 +00006506* If you modify existing code, make sure that your new code does not
6507 add to the memory footprint of the code ;-) Small is beautiful!
6508 When adding new features, these should compile conditionally only
6509 (using #ifdef), and the resulting code with the new feature
6510 disabled must not need more memory than the old code without your
6511 modification.
wdenkcbc49a52005-05-03 14:12:25 +00006512
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006513* Remember that there is a size limit of 100 kB per message on the
6514 u-boot mailing list. Bigger patches will be moderated. If they are
6515 reasonable and not too big, they will be acknowledged. But patches
6516 bigger than the size limit should be avoided.