blob: 5c85fe0f91cd0cb6014f87e5f14231da2e5f9c93 [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
275See board/sandbox/sandbox/README.sandbox for more details.
276
277
wdenkc6097192002-11-03 00:24:07 +0000278Configuration Options:
279----------------------
280
281Configuration depends on the combination of board and CPU type; all
282such information is kept in a configuration file
283"include/configs/<board_name>.h".
284
285Example: For a TQM823L module, all configuration settings are in
286"include/configs/TQM823L.h".
287
288
wdenk1272e232002-11-10 22:06:23 +0000289Many of the options are named exactly as the corresponding Linux
290kernel configuration options. The intention is to make it easier to
291build a config tool - later.
292
293
wdenkc6097192002-11-03 00:24:07 +0000294The following options need to be configured:
295
Kim Phillips203fee32007-08-10 13:28:25 -0500296- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000297
Kim Phillips203fee32007-08-10 13:28:25 -0500298- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk994ad962006-10-24 14:42:37 +0200299
300- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen9d5a43f2007-11-01 12:44:20 +0100301 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000302
303- CPU Module Type: (if CONFIG_COGENT is defined)
304 Define exactly one of
305 CONFIG_CMA286_60_OLD
306--- FIXME --- not tested yet:
307 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
308 CONFIG_CMA287_23, CONFIG_CMA287_50
309
310- Motherboard Type: (if CONFIG_COGENT is defined)
311 Define exactly one of
312 CONFIG_CMA101, CONFIG_CMA102
313
314- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
315 Define one or more of
316 CONFIG_CMA302
317
318- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
319 Define one or more of
320 CONFIG_LCD_HEARTBEAT - update a character position on
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200321 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000322 a "rotator" |\-/|\-/
323
Lei Wen20014762011-02-09 18:06:58 +0530324- Marvell Family Member
325 CONFIG_SYS_MVFS - define it if you want to enable
326 multiple fs option at one time
327 for marvell soc family
328
wdenkc6097192002-11-03 00:24:07 +0000329- MPC824X Family Member (if CONFIG_MPC824X is defined)
wdenk9b7f3842003-10-09 20:09:04 +0000330 Define exactly one of
331 CONFIG_MPC8240, CONFIG_MPC8245
wdenkc6097192002-11-03 00:24:07 +0000332
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200333- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk20bddb32004-09-28 17:59:53 +0000334 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
335 get_gclk_freq() cannot work
wdenk9b7f3842003-10-09 20:09:04 +0000336 e.g. if there is no 32KHz
337 reference PIT/RTC clock
wdenk20bddb32004-09-28 17:59:53 +0000338 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
339 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000340
wdenk20bddb32004-09-28 17:59:53 +0000341- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200342 CONFIG_SYS_8xx_CPUCLK_MIN
343 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk20bddb32004-09-28 17:59:53 +0000344 CONFIG_8xx_CPUCLK_DEFAULT
wdenkfde37042004-01-31 20:06:54 +0000345 See doc/README.MPC866
346
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200347 CONFIG_SYS_MEASURE_CPUCLK
wdenkfde37042004-01-31 20:06:54 +0000348
wdenk544e9732004-02-06 23:19:44 +0000349 Define this to measure the actual CPU clock instead
350 of relying on the correctness of the configured
351 values. Mostly useful for board bringup to make sure
352 the PLL is locked at the intended frequency. Note
353 that this requires a (stable) reference clock (32 kHz
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200354 RTC clock or CONFIG_SYS_8XX_XIN)
wdenkfde37042004-01-31 20:06:54 +0000355
Heiko Schocher734f0272009-03-12 07:37:15 +0100356 CONFIG_SYS_DELAYED_ICACHE
357
358 Define this option if you want to enable the
359 ICache only when Code runs from RAM.
360
Kumar Galaf4fb90f2011-02-18 05:40:54 -0600361- 85xx CPU Options:
York Sun2394a0f2012-10-08 07:44:30 +0000362 CONFIG_SYS_PPC64
363
364 Specifies that the core is a 64-bit PowerPC implementation (implements
365 the "64" category of the Power ISA). This is necessary for ePAPR
366 compliance, among other possible reasons.
367
Kumar Galaf4fb90f2011-02-18 05:40:54 -0600368 CONFIG_SYS_FSL_TBCLK_DIV
369
370 Defines the core time base clock divider ratio compared to the
371 system clock. On most PQ3 devices this is 8, on newer QorIQ
372 devices it can be 16 or 32. The ratio varies from SoC to Soc.
373
Kumar Gala179b1b22011-05-20 00:39:21 -0500374 CONFIG_SYS_FSL_PCIE_COMPAT
375
376 Defines the string to utilize when trying to match PCIe device
377 tree nodes for the given platform.
378
Prabhakar Kushwahaa6a30622012-04-29 23:56:13 +0000379 CONFIG_SYS_PPC_E500_DEBUG_TLB
380
381 Enables a temporary TLB entry to be used during boot to work
382 around limitations in e500v1 and e500v2 external debugger
383 support. This reduces the portions of the boot code where
384 breakpoints and single stepping do not work. The value of this
385 symbol should be set to the TLB1 entry to be used for this
386 purpose.
387
Scott Wood80806962012-08-14 10:14:53 +0000388 CONFIG_SYS_FSL_ERRATUM_A004510
389
390 Enables a workaround for erratum A004510. If set,
391 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
392 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
393
394 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
395 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
396
397 Defines one or two SoC revisions (low 8 bits of SVR)
398 for which the A004510 workaround should be applied.
399
400 The rest of SVR is either not relevant to the decision
401 of whether the erratum is present (e.g. p2040 versus
402 p2041) or is implied by the build target, which controls
403 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
404
405 See Freescale App Note 4493 for more information about
406 this erratum.
407
Prabhakar Kushwahad324f472013-04-16 13:27:44 +0530408 CONFIG_A003399_NOR_WORKAROUND
409 Enables a workaround for IFC erratum A003399. It is only
410 requred during NOR boot.
411
Scott Wood80806962012-08-14 10:14:53 +0000412 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
413
414 This is the value to write into CCSR offset 0x18600
415 according to the A004510 workaround.
416
Priyanka Jainc73b9032013-07-02 09:21:04 +0530417 CONFIG_SYS_FSL_DSP_DDR_ADDR
418 This value denotes start offset of DDR memory which is
419 connected exclusively to the DSP cores.
420
Priyanka Jainf81e8b22013-04-04 09:31:54 +0530421 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
422 This value denotes start offset of M2 memory
423 which is directly connected to the DSP core.
424
Priyanka Jainc73b9032013-07-02 09:21:04 +0530425 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
426 This value denotes start offset of M3 memory which is directly
427 connected to the DSP core.
428
Priyanka Jainf81e8b22013-04-04 09:31:54 +0530429 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
430 This value denotes start offset of DSP CCSR space.
431
Priyanka Jaine9dcaa82013-12-17 14:25:52 +0530432 CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
433 Single Source Clock is clocking mode present in some of FSL SoC's.
434 In this mode, a single differential clock is used to supply
435 clocks to the sysclock, ddrclock and usbclock.
436
Aneesh Bansal8bcbc272014-03-18 23:40:26 +0530437 CONFIG_SYS_CPC_REINIT_F
438 This CONFIG is defined when the CPC is configured as SRAM at the
439 time of U-boot entry and is required to be re-initialized.
440
Tang Yuantiana7364af2014-04-17 15:33:46 +0800441 CONFIG_DEEP_SLEEP
442 Inidcates this SoC supports deep sleep feature. If deep sleep is
443 supported, core will start to execute uboot when wakes up.
444
Daniel Schwierzeckd8a49ca2012-04-02 02:57:56 +0000445- Generic CPU options:
York Sun021d2022014-05-02 17:28:04 -0700446 CONFIG_SYS_GENERIC_GLOBAL_DATA
447 Defines global data is initialized in generic board board_init_f().
448 If this macro is defined, global data is created and cleared in
449 generic board board_init_f(). Without this macro, architecture/board
450 should initialize global data before calling board_init_f().
451
Daniel Schwierzeckd8a49ca2012-04-02 02:57:56 +0000452 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
453
454 Defines the endianess of the CPU. Implementation of those
455 values is arch specific.
456
York Sunf0626592013-09-30 09:22:09 -0700457 CONFIG_SYS_FSL_DDR
458 Freescale DDR driver in use. This type of DDR controller is
459 found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
460 SoCs.
461
462 CONFIG_SYS_FSL_DDR_ADDR
463 Freescale DDR memory-mapped register base.
464
465 CONFIG_SYS_FSL_DDR_EMU
466 Specify emulator support for DDR. Some DDR features such as
467 deskew training are not available.
468
469 CONFIG_SYS_FSL_DDRC_GEN1
470 Freescale DDR1 controller.
471
472 CONFIG_SYS_FSL_DDRC_GEN2
473 Freescale DDR2 controller.
474
475 CONFIG_SYS_FSL_DDRC_GEN3
476 Freescale DDR3 controller.
477
York Sun2896cb72014-03-27 17:54:47 -0700478 CONFIG_SYS_FSL_DDRC_GEN4
479 Freescale DDR4 controller.
480
York Sun461c9392013-09-30 14:20:51 -0700481 CONFIG_SYS_FSL_DDRC_ARM_GEN3
482 Freescale DDR3 controller for ARM-based SoCs.
483
York Sunf0626592013-09-30 09:22:09 -0700484 CONFIG_SYS_FSL_DDR1
485 Board config to use DDR1. It can be enabled for SoCs with
486 Freescale DDR1 or DDR2 controllers, depending on the board
487 implemetation.
488
489 CONFIG_SYS_FSL_DDR2
490 Board config to use DDR2. It can be eanbeld for SoCs with
491 Freescale DDR2 or DDR3 controllers, depending on the board
492 implementation.
493
494 CONFIG_SYS_FSL_DDR3
495 Board config to use DDR3. It can be enabled for SoCs with
York Sun2896cb72014-03-27 17:54:47 -0700496 Freescale DDR3 or DDR3L controllers.
497
498 CONFIG_SYS_FSL_DDR3L
499 Board config to use DDR3L. It can be enabled for SoCs with
500 DDR3L controllers.
501
502 CONFIG_SYS_FSL_DDR4
503 Board config to use DDR4. It can be enabled for SoCs with
504 DDR4 controllers.
York Sunf0626592013-09-30 09:22:09 -0700505
Prabhakar Kushwaha62908c22014-01-18 12:28:30 +0530506 CONFIG_SYS_FSL_IFC_BE
507 Defines the IFC controller register space as Big Endian
508
509 CONFIG_SYS_FSL_IFC_LE
510 Defines the IFC controller register space as Little Endian
511
Prabhakar Kushwaha950f2f72014-01-13 11:28:04 +0530512 CONFIG_SYS_FSL_PBL_PBI
513 It enables addition of RCW (Power on reset configuration) in built image.
514 Please refer doc/README.pblimage for more details
515
516 CONFIG_SYS_FSL_PBL_RCW
517 It adds PBI(pre-boot instructions) commands in u-boot build image.
518 PBI commands can be used to configure SoC before it starts the execution.
519 Please refer doc/README.pblimage for more details
520
Prabhakar Kushwaha2c27f122014-04-08 19:13:34 +0530521 CONFIG_SPL_FSL_PBL
522 It adds a target to create boot binary having SPL binary in PBI format
523 concatenated with u-boot binary.
524
York Sun29647ab2014-02-10 13:59:42 -0800525 CONFIG_SYS_FSL_DDR_BE
526 Defines the DDR controller register space as Big Endian
527
528 CONFIG_SYS_FSL_DDR_LE
529 Defines the DDR controller register space as Little Endian
530
York Sun3a0916d2014-02-10 13:59:43 -0800531 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
532 Physical address from the view of DDR controllers. It is the
533 same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But
534 it could be different for ARM SoCs.
535
York Sunc459ae62014-02-10 13:59:44 -0800536 CONFIG_SYS_FSL_DDR_INTLV_256B
537 DDR controller interleaving on 256-byte. This is a special
538 interleaving mode, handled by Dickens for Freescale layerscape
539 SoCs with ARM core.
540
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100541- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200542 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100543
544 Defines the Monahans run mode to oscillator
545 ratio. Valid values are 8, 16, 24, 31. The core
546 frequency is this value multiplied by 13 MHz.
547
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200548 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200549
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100550 Defines the Monahans turbo mode to oscillator
551 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200552 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100553 by this value.
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200554
Daniel Schwierzeckd52a6232011-07-27 13:22:39 +0200555- MIPS CPU options:
556 CONFIG_SYS_INIT_SP_OFFSET
557
558 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
559 pointer. This is needed for the temporary stack before
560 relocation.
561
562 CONFIG_SYS_MIPS_CACHE_MODE
563
564 Cache operation mode for the MIPS CPU.
565 See also arch/mips/include/asm/mipsregs.h.
566 Possible values are:
567 CONF_CM_CACHABLE_NO_WA
568 CONF_CM_CACHABLE_WA
569 CONF_CM_UNCACHED
570 CONF_CM_CACHABLE_NONCOHERENT
571 CONF_CM_CACHABLE_CE
572 CONF_CM_CACHABLE_COW
573 CONF_CM_CACHABLE_CUW
574 CONF_CM_CACHABLE_ACCELERATED
575
576 CONFIG_SYS_XWAY_EBU_BOOTCFG
577
578 Special option for Lantiq XWAY SoCs for booting from NOR flash.
579 See also arch/mips/cpu/mips32/start.S.
580
581 CONFIG_XWAY_SWAP_BYTES
582
583 Enable compilation of tools/xway-swap-bytes needed for Lantiq
584 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
585 be swapped if a flash programmer is used.
586
Christian Riesch48c2d6d2012-02-02 00:44:39 +0000587- ARM options:
588 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
589
590 Select high exception vectors of the ARM core, e.g., do not
591 clear the V bit of the c1 register of CP15.
592
Aneesh Vb8e40802012-03-08 07:20:19 +0000593 CONFIG_SYS_THUMB_BUILD
594
595 Use this flag to build U-Boot using the Thumb instruction
596 set for ARM architectures. Thumb instruction set provides
597 better code density. For ARM architectures that support
598 Thumb2 this flag will result in Thumb2 code generated by
599 GCC.
600
Stephen Warrenc63c3502013-03-04 13:29:40 +0000601 CONFIG_ARM_ERRATA_716044
Stephen Warrene9d59c92013-02-26 12:28:27 +0000602 CONFIG_ARM_ERRATA_742230
603 CONFIG_ARM_ERRATA_743622
604 CONFIG_ARM_ERRATA_751472
Nitin Garg7f17aed2014-04-02 08:55:01 -0500605 CONFIG_ARM_ERRATA_794072
Nitin Garg245defa2014-04-02 08:55:02 -0500606 CONFIG_ARM_ERRATA_761320
Stephen Warrene9d59c92013-02-26 12:28:27 +0000607
608 If set, the workarounds for these ARM errata are applied early
609 during U-Boot startup. Note that these options force the
610 workarounds to be applied; no CPU-type/version detection
611 exists, unlike the similar options in the Linux kernel. Do not
612 set these options unless they apply!
613
Stephen Warren445d56c2013-03-27 17:06:41 +0000614- CPU timer options:
615 CONFIG_SYS_HZ
616
617 The frequency of the timer returned by get_timer().
618 get_timer() must operate in milliseconds and this CONFIG
619 option must be set to 1000.
620
wdenk9b7f3842003-10-09 20:09:04 +0000621- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000622 CONFIG_CLOCKS_IN_MHZ
623
624 U-Boot stores all clock information in Hz
625 internally. For binary compatibility with older Linux
626 kernels (which expect the clocks passed in the
627 bd_info data to be in MHz) the environment variable
628 "clocks_in_mhz" can be defined so that U-Boot
629 converts clock data to MHZ before passing it to the
630 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000631 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denkb240aef2008-03-26 10:40:12 +0100632 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000633 default environment.
634
wdenk9b7f3842003-10-09 20:09:04 +0000635 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
636
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200637 When transferring memsize parameter to linux, some versions
wdenk9b7f3842003-10-09 20:09:04 +0000638 expect it to be in bytes, others in MB.
639 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
640
Gerald Van Barenfcd91bb2008-06-03 20:34:45 -0400641 CONFIG_OF_LIBFDT
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200642
643 New kernel versions are expecting firmware settings to be
Gerald Van Barend6abef42007-03-31 12:23:51 -0400644 passed using flattened device trees (based on open firmware
645 concepts).
646
647 CONFIG_OF_LIBFDT
648 * New libfdt-based support
649 * Adds the "fdt" command
Kim Phillips9b46eb62007-08-10 14:34:14 -0500650 * The bootm command automatically updates the fdt
Gerald Van Barend6abef42007-03-31 12:23:51 -0400651
Marcel Ziswilerb29bc712009-09-09 21:18:41 +0200652 OF_CPU - The proper name of the cpus node (only required for
653 MPC512X and MPC5xxx based boards).
654 OF_SOC - The proper name of the soc node (only required for
655 MPC512X and MPC5xxx based boards).
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200656 OF_TBCLK - The timebase frequency.
Kumar Galae40c2b52006-01-11 13:59:02 -0600657 OF_STDOUT_PATH - The path to the console device
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200658
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200659 boards with QUICC Engines require OF_QE to set UCC MAC
660 addresses
Kim Phillips9b46eb62007-08-10 14:34:14 -0500661
Kumar Gala1e26aa52006-01-11 13:54:17 -0600662 CONFIG_OF_BOARD_SETUP
663
664 Board code has addition modification that it wants to make
665 to the flat device tree before handing it off to the kernel
wdenkda04a8b2004-08-02 23:22:59 +0000666
Matthew McClintockefae4ca2006-06-28 10:41:37 -0500667 CONFIG_OF_BOOT_CPU
668
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200669 This define fills in the correct boot CPU in the boot
Matthew McClintockefae4ca2006-06-28 10:41:37 -0500670 param header, the default value is zero if undefined.
671
Heiko Schocherffb293a2009-09-23 07:56:08 +0200672 CONFIG_OF_IDE_FIXUP
673
674 U-Boot can detect if an IDE device is present or not.
675 If not, and this new config option is activated, U-Boot
676 removes the ATA node from the DTS before booting Linux,
677 so the Linux IDE driver does not probe the device and
678 crash. This is needed for buggy hardware (uc101) where
679 no pull down resistor is connected to the signal IDE5V_DD7.
680
Igor Grinberg06890672011-07-14 05:45:07 +0000681 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
682
683 This setting is mandatory for all boards that have only one
684 machine type and must be used to specify the machine type
685 number as it appears in the ARM machine registry
686 (see http://www.arm.linux.org.uk/developer/machines/).
687 Only boards that have multiple machine types supported
688 in a single configuration file and the machine type is
689 runtime discoverable, do not have to use this setting.
690
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100691- vxWorks boot parameters:
692
693 bootvx constructs a valid bootline using the following
694 environments variables: bootfile, ipaddr, serverip, hostname.
695 It loads the vxWorks image pointed bootfile.
696
697 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
698 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
699 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
700 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
701
702 CONFIG_SYS_VXWORKS_ADD_PARAMS
703
704 Add it at the end of the bootline. E.g "u=username pw=secret"
705
706 Note: If a "bootargs" environment is defined, it will overwride
707 the defaults discussed just above.
708
Aneesh V960f5c02011-06-16 23:30:47 +0000709- Cache Configuration:
710 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
711 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
712 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
713
Aneesh V686a0752011-06-16 23:30:51 +0000714- Cache Configuration for ARM:
715 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
716 controller
717 CONFIG_SYS_PL310_BASE - Physical base address of PL310
718 controller register space
719
wdenkda04a8b2004-08-02 23:22:59 +0000720- Serial Ports:
Andreas Engel0813b122008-09-08 14:30:53 +0200721 CONFIG_PL010_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000722
723 Define this if you want support for Amba PrimeCell PL010 UARTs.
724
Andreas Engel0813b122008-09-08 14:30:53 +0200725 CONFIG_PL011_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000726
727 Define this if you want support for Amba PrimeCell PL011 UARTs.
728
729 CONFIG_PL011_CLOCK
730
731 If you have Amba PrimeCell PL011 UARTs, set this variable to
732 the clock speed of the UARTs.
733
734 CONFIG_PL01x_PORTS
735
736 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
737 define this to a list of base addresses for each (supported)
738 port. See e.g. include/configs/versatile.h
739
John Rigby34e21ee2011-04-19 10:42:39 +0000740 CONFIG_PL011_SERIAL_RLCR
741
742 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
743 have separate receive and transmit line control registers. Set
744 this variable to initialize the extra register.
745
746 CONFIG_PL011_SERIAL_FLUSH_ON_INIT
747
748 On some platforms (e.g. U8500) U-Boot is loaded by a second stage
749 boot loader that has already initialized the UART. Define this
750 variable to flush the UART at init time.
751
Karicheri, Muralidharancbc08882014-04-09 15:38:46 -0400752 CONFIG_SERIAL_HW_FLOW_CONTROL
753
754 Define this variable to enable hw flow control in serial driver.
755 Current user of this option is drivers/serial/nsl16550.c driver
wdenkda04a8b2004-08-02 23:22:59 +0000756
wdenkc6097192002-11-03 00:24:07 +0000757- Console Interface:
wdenk4a5c8a72003-03-06 00:02:04 +0000758 Depending on board, define exactly one serial port
759 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
760 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
761 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000762
763 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
764 port routines must be defined elsewhere
765 (i.e. serial_init(), serial_getc(), ...)
766
767 CONFIG_CFB_CONSOLE
768 Enables console device for a color framebuffer. Needs following
Wolfgang Denkf6e50a42011-12-07 12:19:20 +0000769 defines (cf. smiLynxEM, i8042)
wdenkc6097192002-11-03 00:24:07 +0000770 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
771 (default big endian)
772 VIDEO_HW_RECTFILL graphic chip supports
773 rectangle fill
774 (cf. smiLynxEM)
775 VIDEO_HW_BITBLT graphic chip supports
776 bit-blit (cf. smiLynxEM)
777 VIDEO_VISIBLE_COLS visible pixel columns
778 (cols=pitch)
wdenk544e9732004-02-06 23:19:44 +0000779 VIDEO_VISIBLE_ROWS visible pixel rows
780 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000781 VIDEO_DATA_FORMAT graphic data format
782 (0-5, cf. cfb_console.c)
wdenk544e9732004-02-06 23:19:44 +0000783 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000784 VIDEO_KBD_INIT_FCT keyboard int fct
785 (i.e. i8042_kbd_init())
786 VIDEO_TSTC_FCT test char fct
787 (i.e. i8042_tstc)
788 VIDEO_GETC_FCT get char fct
789 (i.e. i8042_getc)
790 CONFIG_CONSOLE_CURSOR cursor drawing on/off
791 (requires blink timer
792 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200793 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000794 CONFIG_CONSOLE_TIME display time/date info in
795 upper right corner
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500796 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000797 CONFIG_VIDEO_LOGO display Linux logo in
798 upper left corner
wdenk9dd2b882002-12-03 21:28:10 +0000799 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
800 linux_logo.h for logo.
801 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000802 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200803 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000804 the logo
805
Pali Rohár4a57da32012-10-19 13:30:09 +0000806 When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
807 a limited number of ANSI escape sequences (cursor control,
808 erase functions and limited graphics rendition control).
809
wdenk4a5c8a72003-03-06 00:02:04 +0000810 When CONFIG_CFB_CONSOLE is defined, video console is
811 default i/o. Serial console can be forced with
812 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000813
wdenk1ebf41e2004-01-02 14:00:00 +0000814 When CONFIG_SILENT_CONSOLE is defined, all console
815 messages (by U-Boot and Linux!) can be silenced with
816 the "silent" environment variable. See
817 doc/README.silent for more information.
wdenk3da587e2003-10-19 23:22:11 +0000818
Heiko Schocher62759562013-10-22 11:06:06 +0200819 CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
820 is 0x00.
821 CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
822 is 0xa0.
823
wdenkc6097192002-11-03 00:24:07 +0000824- Console Baudrate:
825 CONFIG_BAUDRATE - in bps
826 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200827 CONFIG_SYS_BAUDRATE_TABLE, see below.
828 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000829
Heiko Schocher327480a2009-01-30 12:55:38 +0100830- Console Rx buffer length
831 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
832 the maximum receive buffer length for the SMC.
Heiko Schocher362447f2009-02-10 09:31:47 +0100833 This option is actual only for 82xx and 8xx possible.
Heiko Schocher327480a2009-01-30 12:55:38 +0100834 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
835 must be defined, to setup the maximum idle timeout for
836 the SMC.
837
Graeme Russ3c28f482011-09-01 00:48:27 +0000838- Pre-Console Buffer:
Wolfgang Denkd590fb12011-10-07 09:58:21 +0200839 Prior to the console being initialised (i.e. serial UART
840 initialised etc) all console output is silently discarded.
841 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
842 buffer any console messages prior to the console being
843 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
844 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
845 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
Wolfgang Denk23f78482011-10-09 21:06:34 +0200846 bytes are output before the console is initialised, the
Wolfgang Denkd590fb12011-10-07 09:58:21 +0200847 earlier bytes are discarded.
Graeme Russ3c28f482011-09-01 00:48:27 +0000848
Wolfgang Denkd590fb12011-10-07 09:58:21 +0200849 'Sane' compilers will generate smaller code if
850 CONFIG_PRE_CON_BUF_SZ is a power of 2
Graeme Russ3c28f482011-09-01 00:48:27 +0000851
Sonny Raocd55bde2011-11-02 09:52:08 +0000852- Safe printf() functions
853 Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
854 the printf() functions. These are defined in
855 include/vsprintf.h and include snprintf(), vsnprintf() and
856 so on. Code size increase is approximately 300-500 bytes.
857 If this option is not given then these functions will
858 silently discard their buffer size argument - this means
859 you are not getting any overflow checking in this case.
860
wdenkc6097192002-11-03 00:24:07 +0000861- Boot Delay: CONFIG_BOOTDELAY - in seconds
862 Delay before automatically booting the default image;
863 set to -1 to disable autoboot.
Joe Hershberger96ccaf32012-08-17 10:53:12 +0000864 set to -2 to autoboot with no delay and not check for abort
865 (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
wdenkc6097192002-11-03 00:24:07 +0000866
867 See doc/README.autoboot for these options that
868 work with CONFIG_BOOTDELAY. None are required.
869 CONFIG_BOOT_RETRY_TIME
870 CONFIG_BOOT_RETRY_MIN
871 CONFIG_AUTOBOOT_KEYED
872 CONFIG_AUTOBOOT_PROMPT
873 CONFIG_AUTOBOOT_DELAY_STR
874 CONFIG_AUTOBOOT_STOP_STR
875 CONFIG_AUTOBOOT_DELAY_STR2
876 CONFIG_AUTOBOOT_STOP_STR2
877 CONFIG_ZERO_BOOTDELAY_CHECK
878 CONFIG_RESET_TO_RETRY
879
880- Autoboot Command:
881 CONFIG_BOOTCOMMAND
882 Only needed when CONFIG_BOOTDELAY is enabled;
883 define a command string that is automatically executed
884 when no character is read on the console interface
885 within "Boot Delay" after reset.
886
887 CONFIG_BOOTARGS
wdenk4a5c8a72003-03-06 00:02:04 +0000888 This can be used to pass arguments to the bootm
889 command. The value of CONFIG_BOOTARGS goes into the
890 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000891
892 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk4a5c8a72003-03-06 00:02:04 +0000893 The value of these goes into the environment as
894 "ramboot" and "nfsboot" respectively, and can be used
895 as a convenience, when switching between booting from
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200896 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000897
Heiko Schocher040c5c32013-11-04 14:04:59 +0100898- Bootcount:
899 CONFIG_BOOTCOUNT_LIMIT
900 Implements a mechanism for detecting a repeating reboot
901 cycle, see:
902 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
903
904 CONFIG_BOOTCOUNT_ENV
905 If no softreset save registers are found on the hardware
906 "bootcount" is stored in the environment. To prevent a
907 saveenv on all reboots, the environment variable
908 "upgrade_available" is used. If "upgrade_available" is
909 0, "bootcount" is always 0, if "upgrade_available" is
910 1 "bootcount" is incremented in the environment.
911 So the Userspace Applikation must set the "upgrade_available"
912 and "bootcount" variable to 0, if a boot was successfully.
913
wdenkc6097192002-11-03 00:24:07 +0000914- Pre-Boot Commands:
915 CONFIG_PREBOOT
916
917 When this option is #defined, the existence of the
918 environment variable "preboot" will be checked
919 immediately before starting the CONFIG_BOOTDELAY
920 countdown and/or running the auto-boot command resp.
921 entering interactive mode.
922
923 This feature is especially useful when "preboot" is
924 automatically generated or modified. For an example
925 see the LWMON board specific code: here "preboot" is
926 modified when the user holds down a certain
927 combination of keys on the (special) keyboard when
928 booting the systems
929
930- Serial Download Echo Mode:
931 CONFIG_LOADS_ECHO
932 If defined to 1, all characters received during a
933 serial download (using the "loads" command) are
934 echoed back. This might be needed by some terminal
935 emulations (like "cu"), but may as well just take
936 time on others. This setting #define's the initial
937 value of the "loads_echo" environment variable.
938
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500939- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000940 CONFIG_KGDB_BAUDRATE
941 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200942 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000943
944- Monitor Functions:
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500945 Monitor commands can be included or excluded
946 from the build by using the #include files
Stephen Warren963a7cf2012-08-05 16:07:19 +0000947 <config_cmd_all.h> and #undef'ing unwanted
948 commands, or using <config_cmd_default.h>
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500949 and augmenting with additional #define's
950 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000951
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500952 The default command configuration includes all commands
953 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000954
Marek Vasutc4d8a1b2014-03-05 19:58:39 +0100955 CONFIG_CMD_AES AES 128 CBC encrypt/decrypt
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500956 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500957 CONFIG_CMD_BDI bdinfo
958 CONFIG_CMD_BEDBUG * Include BedBug Debugger
959 CONFIG_CMD_BMP * BMP support
960 CONFIG_CMD_BSP * Board specific commands
961 CONFIG_CMD_BOOTD bootd
962 CONFIG_CMD_CACHE * icache, dcache
Michal Simeka0d28022013-11-21 13:39:02 -0800963 CONFIG_CMD_CLK * clock command support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500964 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger321ab9e2010-12-21 14:19:51 -0500965 CONFIG_CMD_CRC32 * crc32
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500966 CONFIG_CMD_DATE * support for RTC, date/time...
967 CONFIG_CMD_DHCP * DHCP support
968 CONFIG_CMD_DIAG * Diagnostics
Peter Tyser15258042008-12-17 16:36:22 -0600969 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
970 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
971 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
972 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500973 CONFIG_CMD_DTT * Digital Therm and Thermostat
974 CONFIG_CMD_ECHO echo arguments
Peter Tyser0deafa22009-10-25 15:12:56 -0500975 CONFIG_CMD_EDITENV edit env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500976 CONFIG_CMD_EEPROM * EEPROM read/write support
977 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger1b0d5512012-12-11 22:16:25 -0600978 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergera2d62b72012-12-11 22:16:33 -0600979 CONFIG_CMD_ENV_FLAGS * display details about env flags
Andrew Ruder94463402013-10-22 19:07:34 -0500980 CONFIG_CMD_ENV_EXISTS * check existence of env variable
Mike Frysingerf3ddf202010-12-26 23:09:45 -0500981 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren4f8662d2012-10-22 06:43:50 +0000982 CONFIG_CMD_EXT2 * ext2 command support
983 CONFIG_CMD_EXT4 * ext4 command support
Stephen Warren3d5a3882014-01-24 20:46:37 -0700984 CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls)
985 that work for multiple fs types
Mike Frysinger78dcaf42009-01-28 19:08:14 -0500986 CONFIG_CMD_SAVEENV saveenv
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500987 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren4f8662d2012-10-22 06:43:50 +0000988 CONFIG_CMD_FAT * FAT command support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500989 CONFIG_CMD_FLASH flinfo, erase, protect
990 CONFIG_CMD_FPGA FPGA device initialization support
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200991 CONFIG_CMD_FUSE * Device fuse support
Anton Staafd1390c82012-12-05 14:46:29 +0000992 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysinger2ed02412010-12-26 23:32:22 -0500993 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsf0c9d532011-04-05 07:15:14 +0000994 CONFIG_CMD_GREPENV * search environment
Simon Glass058bb8d2012-12-05 14:46:38 +0000995 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500996 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
997 CONFIG_CMD_I2C * I2C serial bus support
998 CONFIG_CMD_IDE * IDE harddisk support
999 CONFIG_CMD_IMI iminfo
Vipin Kumar3df41b12012-12-16 22:32:48 +00001000 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001001 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001002 CONFIG_CMD_IMMAP * IMMR dump support
Simon Glass4dc47ca2014-06-11 23:29:41 -06001003 CONFIG_CMD_IOTRACE * I/O tracing for debugging
Mike Frysingerf3ddf202010-12-26 23:09:45 -05001004 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershberger0fd32d72012-10-03 11:15:51 +00001005 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001006 CONFIG_CMD_IRQ * irqinfo
1007 CONFIG_CMD_ITEST Integer/string test of 2 values
1008 CONFIG_CMD_JFFS2 * JFFS2 Support
1009 CONFIG_CMD_KGDB * kgdb
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001010 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00001011 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
1012 (169.254.*.*)
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001013 CONFIG_CMD_LOADB loadb
1014 CONFIG_CMD_LOADS loads
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001015 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz93d6cb02009-07-27 00:07:59 -04001016 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glasseacd14f2012-11-30 13:01:20 +00001017 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001018 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denk9d009282013-03-08 10:51:32 +00001019 loop, loopw
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001020 CONFIG_CMD_MEMTEST * mtest
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001021 CONFIG_CMD_MISC Misc functions like sleep etc
1022 CONFIG_CMD_MMC * MMC memory mapped support
1023 CONFIG_CMD_MII * MII utility commands
Stefan Roeseb1423dd2009-03-19 13:30:36 +01001024 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001025 CONFIG_CMD_NAND * NAND support
1026 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001027 CONFIG_CMD_NFS NFS support
Peter Tyser9902e422008-12-17 16:36:21 -06001028 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denk092ae952011-10-26 10:21:21 +00001029 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001030 CONFIG_CMD_PCI * pciinfo
1031 CONFIG_CMD_PCMCIA * PCMCIA support
1032 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
1033 host
1034 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersc889fb42012-12-05 14:46:30 +00001035 CONFIG_CMD_READ * Read raw data from partition
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001036 CONFIG_CMD_REGINFO * Register dump
1037 CONFIG_CMD_RUN run command in env variable
Simon Glassbf6ce792012-12-26 09:53:36 +00001038 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001039 CONFIG_CMD_SAVES * save S record dump
1040 CONFIG_CMD_SCSI * SCSI Support
1041 CONFIG_CMD_SDRAM * print SDRAM configuration information
1042 (requires CONFIG_CMD_I2C)
1043 CONFIG_CMD_SETGETDCR Support for DCR Register access
1044 (4xx only)
Eric Nelson97f5f8f2012-01-31 10:52:08 -07001045 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001046 CONFIG_CMD_SHA1SUM * print sha1 memory digest
Robin Getz93d6cb02009-07-27 00:07:59 -04001047 (requires CONFIG_CMD_MEMORY)
Bob Liua671b702013-02-05 19:05:41 +08001048 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk85c25df2009-04-01 23:34:12 +02001049 CONFIG_CMD_SOURCE "source" command Support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001050 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7aa81a42011-05-17 00:03:40 +00001051 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass6a398d22011-10-24 18:00:07 +00001052 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershberger59f3f522012-10-03 12:14:57 +00001053 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
1054 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001055 CONFIG_CMD_USB * USB support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001056 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasut71729392012-03-31 07:47:16 +00001057 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001058 CONFIG_CMD_XIMG Load part of Multi Image
Przemyslaw Marczak2eb40ee2014-04-02 10:20:05 +02001059 CONFIG_CMD_UUID * Generate random UUID or GUID string
wdenkc6097192002-11-03 00:24:07 +00001060
1061 EXAMPLE: If you want all functions except of network
1062 support you can write:
1063
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001064 #include "config_cmd_all.h"
1065 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +00001066
Gerald Van Barend6abef42007-03-31 12:23:51 -04001067 Other Commands:
1068 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +00001069
1070 Note: Don't enable the "icache" and "dcache" commands
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001071 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk4a5c8a72003-03-06 00:02:04 +00001072 what you (and your U-Boot users) are doing. Data
1073 cache cannot be enabled on systems like the 8xx or
1074 8260 (where accesses to the IMMR region must be
1075 uncached), and it cannot be disabled on all other
1076 systems where we (mis-) use the data cache to hold an
1077 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +00001078
1079
1080 XXX - this list needs to get updated!
1081
Wolfgang Denk2aceea12013-03-23 23:50:31 +00001082- Regular expression support:
1083 CONFIG_REGEX
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001084 If this variable is defined, U-Boot is linked against
1085 the SLRE (Super Light Regular Expression) library,
1086 which adds regex support to some commands, as for
1087 example "env grep" and "setexpr".
Wolfgang Denk2aceea12013-03-23 23:50:31 +00001088
Simon Glass3d686442011-10-15 05:48:20 +00001089- Device tree:
1090 CONFIG_OF_CONTROL
1091 If this variable is defined, U-Boot will use a device tree
1092 to configure its devices, instead of relying on statically
1093 compiled #defines in the board file. This option is
1094 experimental and only available on a few boards. The device
1095 tree is available in the global data as gd->fdt_blob.
1096
Simon Glass5cb34db2011-10-24 19:15:31 +00001097 U-Boot needs to get its device tree from somewhere. This can
1098 be done using one of the two options below:
Simon Glass38d6b8d2011-10-15 05:48:21 +00001099
1100 CONFIG_OF_EMBED
1101 If this variable is defined, U-Boot will embed a device tree
1102 binary in its image. This device tree file should be in the
1103 board directory and called <soc>-<board>.dts. The binary file
1104 is then picked up in board_init_f() and made available through
1105 the global data structure as gd->blob.
Simon Glass3d686442011-10-15 05:48:20 +00001106
Simon Glass5cb34db2011-10-24 19:15:31 +00001107 CONFIG_OF_SEPARATE
1108 If this variable is defined, U-Boot will build a device tree
1109 binary. It will be called u-boot.dtb. Architecture-specific
1110 code will locate it at run-time. Generally this works by:
1111
1112 cat u-boot.bin u-boot.dtb >image.bin
1113
1114 and in fact, U-Boot does this for you, creating a file called
1115 u-boot-dtb.bin which is useful in the common case. You can
1116 still use the individual files if you need something more
1117 exotic.
1118
wdenkc6097192002-11-03 00:24:07 +00001119- Watchdog:
1120 CONFIG_WATCHDOG
1121 If this variable is defined, it enables watchdog
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +00001122 support for the SoC. There must be support in the SoC
1123 specific code for a watchdog. For the 8xx and 8260
1124 CPUs, the SIU Watchdog feature is enabled in the SYPCR
1125 register. When supported for a specific SoC is
1126 available, then no further board specific code should
1127 be needed to use it.
1128
1129 CONFIG_HW_WATCHDOG
1130 When using a watchdog circuitry external to the used
1131 SoC, then define this variable and provide board
1132 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +00001133
stroeseb9c17c52003-04-04 15:53:41 +00001134- U-Boot Version:
1135 CONFIG_VERSION_VARIABLE
1136 If this variable is defined, an environment variable
1137 named "ver" is created by U-Boot showing the U-Boot
1138 version as printed by the "version" command.
Benoît Thébaudeauce9a1552012-08-13 15:01:14 +02001139 Any change to this variable will be reverted at the
1140 next reset.
stroeseb9c17c52003-04-04 15:53:41 +00001141
wdenkc6097192002-11-03 00:24:07 +00001142- Real-Time Clock:
1143
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001144 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +00001145 has to be selected, too. Define exactly one of the
1146 following options:
1147
1148 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1149 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam3f8d1782011-10-24 06:44:15 +00001150 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001151 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1fe2c702003-03-06 21:55:29 +00001152 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001153 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk0893c472003-05-20 14:25:27 +00001154 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel90491f22014-07-21 11:06:16 +02001155 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenkef5fe752003-03-12 10:41:04 +00001156 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krillb27939b2008-03-15 15:40:26 +01001157 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenkaeba06f2004-06-09 17:34:58 +00001158 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001159 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher1f1b7012011-03-28 09:24:22 +02001160 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1161 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001162
wdenkb9bbd242003-06-30 16:24:52 +00001163 Note that if the RTC uses I2C, then the I2C interface
1164 must also be configured. See I2C Support, below.
1165
Peter Tyser9902e422008-12-17 16:36:21 -06001166- GPIO Support:
1167 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tyser9902e422008-12-17 16:36:21 -06001168
Chris Packham9b383202010-12-19 10:12:13 +00001169 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1170 chip-ngpio pairs that tell the PCA953X driver the number of
1171 pins supported by a particular chip.
1172
Peter Tyser9902e422008-12-17 16:36:21 -06001173 Note that if the GPIO device uses I2C, then the I2C interface
1174 must also be configured. See I2C Support, below.
1175
Simon Glass4dc47ca2014-06-11 23:29:41 -06001176- I/O tracing:
1177 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
1178 accesses and can checksum them or write a list of them out
1179 to memory. See the 'iotrace' command for details. This is
1180 useful for testing device drivers since it can confirm that
1181 the driver behaves the same way before and after a code
1182 change. Currently this is supported on sandbox and arm. To
1183 add support for your architecture, add '#include <iotrace.h>'
1184 to the bottom of arch/<arch>/include/asm/io.h and test.
1185
1186 Example output from the 'iotrace stats' command is below.
1187 Note that if the trace buffer is exhausted, the checksum will
1188 still continue to operate.
1189
1190 iotrace is enabled
1191 Start: 10000000 (buffer start address)
1192 Size: 00010000 (buffer size)
1193 Offset: 00000120 (current buffer offset)
1194 Output: 10000120 (start + offset)
1195 Count: 00000018 (number of trace records)
1196 CRC32: 9526fb66 (CRC32 of all trace records)
1197
wdenkc6097192002-11-03 00:24:07 +00001198- Timestamp Support:
1199
wdenk4a5c8a72003-03-06 00:02:04 +00001200 When CONFIG_TIMESTAMP is selected, the timestamp
1201 (date and time) of an image is printed by image
1202 commands like bootm or iminfo. This option is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001203 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001204
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001205- Partition Labels (disklabels) Supported:
1206 Zero or more of the following:
1207 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1208 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1209 Intel architecture, USB sticks, etc.
1210 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1211 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1212 bootloader. Note 2TB partition limit; see
1213 disk/part_efi.c
1214 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001215
Wolfgang Denkb240aef2008-03-26 10:40:12 +01001216 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1217 CONFIG_CMD_SCSI) you must configure support for at
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001218 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001219
1220- IDE Reset method:
wdenk369d43d2004-03-14 14:09:05 +00001221 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1222 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001223
wdenk369d43d2004-03-14 14:09:05 +00001224 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1225 be performed by calling the function
1226 ide_set_reset(int reset)
1227 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001228
1229- ATAPI Support:
1230 CONFIG_ATAPI
1231
1232 Set this to enable ATAPI support.
1233
wdenkf602aa02004-03-13 23:29:43 +00001234- LBA48 Support
1235 CONFIG_LBA48
1236
1237 Set this to enable support for disks larger than 137GB
Heiko Schocher0f602e12009-12-03 11:21:21 +01001238 Also look at CONFIG_SYS_64BIT_LBA.
wdenkf602aa02004-03-13 23:29:43 +00001239 Whithout these , LBA48 support uses 32bit variables and will 'only'
1240 support disks up to 2.1TB.
1241
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001242 CONFIG_SYS_64BIT_LBA:
wdenkf602aa02004-03-13 23:29:43 +00001243 When enabled, makes the IDE subsystem use 64bit sector addresses.
1244 Default is 32bit.
1245
wdenkc6097192002-11-03 00:24:07 +00001246- SCSI Support:
1247 At the moment only there is only support for the
1248 SYM53C8XX SCSI controller; define
1249 CONFIG_SCSI_SYM53C8XX to enable it.
1250
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001251 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1252 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1253 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001254 maximum numbers of LUNs, SCSI ID's and target
1255 devices.
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001256 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001257
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001258 The environment variable 'scsidevs' is set to the number of
1259 SCSI devices found during the last scan.
Stefan Reinauere50a10e2012-10-29 05:23:48 +00001260
wdenkc6097192002-11-03 00:24:07 +00001261- NETWORK Support (PCI):
wdenk4e112c12003-06-03 23:54:09 +00001262 CONFIG_E1000
Kyle Moffett64b94dd2011-10-18 11:05:29 +00001263 Support for Intel 8254x/8257x gigabit chips.
1264
1265 CONFIG_E1000_SPI
1266 Utility code for direct access to the SPI bus on Intel 8257x.
1267 This does not do anything useful unless you set at least one
1268 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1269
1270 CONFIG_E1000_SPI_GENERIC
1271 Allow generic access to the SPI bus on the Intel 8257x, for
1272 example with the "sspi" command.
1273
1274 CONFIG_CMD_E1000
1275 Management command for E1000 devices. When used on devices
1276 with SPI support you can reprogram the EEPROM from U-Boot.
stroese94ef1cf2003-06-05 15:39:44 +00001277
Andre Schwarz68c2a302008-03-06 16:45:44 +01001278 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001279 default MAC for empty EEPROM after production.
Andre Schwarz68c2a302008-03-06 16:45:44 +01001280
wdenkc6097192002-11-03 00:24:07 +00001281 CONFIG_EEPRO100
1282 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001283 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001284 write routine for first time initialisation.
1285
1286 CONFIG_TULIP
1287 Support for Digital 2114x chips.
1288 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1289 modem chip initialisation (KS8761/QS6611).
1290
1291 CONFIG_NATSEMI
1292 Support for National dp83815 chips.
1293
1294 CONFIG_NS8382X
1295 Support for National dp8382[01] gigabit chips.
1296
wdenkaa603362003-05-12 21:50:16 +00001297- NETWORK Support (other):
1298
Jens Scharsigdab7cb82010-01-23 12:03:45 +01001299 CONFIG_DRIVER_AT91EMAC
1300 Support for AT91RM9200 EMAC.
1301
1302 CONFIG_RMII
1303 Define this to use reduced MII inteface
1304
1305 CONFIG_DRIVER_AT91EMAC_QUIET
1306 If this defined, the driver is quiet.
1307 The driver doen't show link status messages.
1308
Rob Herringc9830dc2011-12-15 11:15:49 +00001309 CONFIG_CALXEDA_XGMAC
1310 Support for the Calxeda XGMAC device
1311
Ashok93fb8722012-10-15 06:20:47 +00001312 CONFIG_LAN91C96
wdenkaa603362003-05-12 21:50:16 +00001313 Support for SMSC's LAN91C96 chips.
1314
1315 CONFIG_LAN91C96_BASE
1316 Define this to hold the physical address
1317 of the LAN91C96's I/O space
1318
1319 CONFIG_LAN91C96_USE_32_BIT
1320 Define this to enable 32 bit addressing
1321
Ashok93fb8722012-10-15 06:20:47 +00001322 CONFIG_SMC91111
wdenk3c711762004-06-09 13:37:52 +00001323 Support for SMSC's LAN91C111 chip
1324
1325 CONFIG_SMC91111_BASE
1326 Define this to hold the physical address
1327 of the device (I/O space)
1328
1329 CONFIG_SMC_USE_32_BIT
1330 Define this if data bus is 32 bits
1331
1332 CONFIG_SMC_USE_IOFUNCS
1333 Define this to use i/o functions instead of macros
1334 (some hardware wont work with macros)
1335
Heiko Schocher7d037f72011-11-15 10:00:04 -05001336 CONFIG_DRIVER_TI_EMAC
1337 Support for davinci emac
1338
1339 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1340 Define this if you have more then 3 PHYs.
1341
Macpaul Lin199c6252010-12-21 16:59:46 +08001342 CONFIG_FTGMAC100
1343 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1344
1345 CONFIG_FTGMAC100_EGIGA
1346 Define this to use GE link update with gigabit PHY.
1347 Define this if FTGMAC100 is connected to gigabit PHY.
1348 If your system has 10/100 PHY only, it might not occur
1349 wrong behavior. Because PHY usually return timeout or
1350 useless data when polling gigabit status and gigabit
1351 control registers. This behavior won't affect the
1352 correctnessof 10/100 link speed update.
1353
Mike Rapoportf4761af2009-11-11 10:03:03 +02001354 CONFIG_SMC911X
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001355 Support for SMSC's LAN911x and LAN921x chips
1356
Mike Rapoportf4761af2009-11-11 10:03:03 +02001357 CONFIG_SMC911X_BASE
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001358 Define this to hold the physical address
1359 of the device (I/O space)
1360
Mike Rapoportf4761af2009-11-11 10:03:03 +02001361 CONFIG_SMC911X_32_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001362 Define this if data bus is 32 bits
1363
Mike Rapoportf4761af2009-11-11 10:03:03 +02001364 CONFIG_SMC911X_16_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001365 Define this if data bus is 16 bits. If your processor
1366 automatically converts one 32 bit word to two 16 bit
Mike Rapoportf4761af2009-11-11 10:03:03 +02001367 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001368
Yoshihiro Shimodaed4cea02011-01-27 10:06:03 +09001369 CONFIG_SH_ETHER
1370 Support for Renesas on-chip Ethernet controller
1371
1372 CONFIG_SH_ETHER_USE_PORT
1373 Define the number of ports to be used
1374
1375 CONFIG_SH_ETHER_PHY_ADDR
1376 Define the ETH PHY's address
1377
Yoshihiro Shimoda281aa052011-01-27 10:06:08 +09001378 CONFIG_SH_ETHER_CACHE_WRITEBACK
1379 If this option is set, the driver enables cache flush.
1380
Vadim Bendeburydac69642011-10-17 08:36:14 +00001381- TPM Support:
Che-liang Chiouacea5702013-04-12 11:04:34 +00001382 CONFIG_TPM
1383 Support TPM devices.
1384
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001385 CONFIG_TPM_TIS_I2C
1386 Support for i2c bus TPM devices. Only one device
1387 per system is supported at this time.
1388
1389 CONFIG_TPM_TIS_I2C_BUS_NUMBER
1390 Define the the i2c bus number for the TPM device
1391
1392 CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
1393 Define the TPM's address on the i2c bus
1394
1395 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1396 Define the burst count bytes upper limit
1397
Dirk Eibach20489092013-06-26 15:55:15 +02001398 CONFIG_TPM_ATMEL_TWI
1399 Support for Atmel TWI TPM device. Requires I2C support.
1400
Che-liang Chiouacea5702013-04-12 11:04:34 +00001401 CONFIG_TPM_TIS_LPC
Vadim Bendeburydac69642011-10-17 08:36:14 +00001402 Support for generic parallel port TPM devices. Only one device
1403 per system is supported at this time.
1404
1405 CONFIG_TPM_TIS_BASE_ADDRESS
1406 Base address where the generic TPM device is mapped
1407 to. Contemporary x86 systems usually map it at
1408 0xfed40000.
1409
Reinhard Pfau4fece432013-06-26 15:55:13 +02001410 CONFIG_CMD_TPM
1411 Add tpm monitor functions.
1412 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1413 provides monitor access to authorized functions.
1414
1415 CONFIG_TPM
1416 Define this to enable the TPM support library which provides
1417 functional interfaces to some TPM commands.
1418 Requires support for a TPM device.
1419
1420 CONFIG_TPM_AUTH_SESSIONS
1421 Define this to enable authorized functions in the TPM library.
1422 Requires CONFIG_TPM and CONFIG_SHA1.
1423
wdenkc6097192002-11-03 00:24:07 +00001424- USB Support:
1425 At the moment only the UHCI host controller is
wdenk369d43d2004-03-14 14:09:05 +00001426 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001427 CONFIG_USB_UHCI to enable it.
1428 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenkfb30b4c2004-10-09 22:44:59 +00001429 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001430 storage devices.
1431 Note:
1432 Supported are USB Keyboards and USB Floppy drives
1433 (TEAC FD-05PUB).
wdenk369d43d2004-03-14 14:09:05 +00001434 MPC5200 USB requires additional defines:
1435 CONFIG_USB_CLOCK
1436 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt02848522009-08-13 08:32:37 -05001437 CONFIG_PSC3_USB
1438 for USB on PSC3
wdenk369d43d2004-03-14 14:09:05 +00001439 CONFIG_USB_CONFIG
1440 for differential drivers: 0x00001000
1441 for single ended drivers: 0x00005000
Eric Millbrandt02848522009-08-13 08:32:37 -05001442 for differential drivers on PSC3: 0x00000100
1443 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001444 CONFIG_SYS_USB_EVENT_POLL
Zhang Wei063f9ff2007-06-06 10:08:13 +02001445 May be defined to allow interrupt polling
1446 instead of using asynchronous interrupts
wdenk369d43d2004-03-14 14:09:05 +00001447
Simon Glass5978cdb2012-02-27 10:52:47 +00001448 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1449 txfilltuning field in the EHCI controller on reset.
1450
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001451- USB Device:
1452 Define the below if you wish to use the USB console.
1453 Once firmware is rebuilt from a serial console issue the
1454 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001455 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001456 it has found a new device. The environment variable usbtty
1457 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denke2601822006-06-14 18:14:56 +02001458 appear to a USB host as a Linux gserial device or a
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001459 Common Device Class Abstract Control Model serial device.
1460 If you select usbtty = gserial you should be able to enumerate
1461 a Linux host by
1462 # modprobe usbserial vendor=0xVendorID product=0xProductID
1463 else if using cdc_acm, simply setting the environment
1464 variable usbtty to be cdc_acm should suffice. The following
1465 might be defined in YourBoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001466
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001467 CONFIG_USB_DEVICE
1468 Define this to build a UDC device
1469
1470 CONFIG_USB_TTY
1471 Define this to have a tty type of device available to
1472 talk to the UDC device
Wolfgang Denke2601822006-06-14 18:14:56 +02001473
Vipin KUMARbdb17702012-03-26 15:38:06 +05301474 CONFIG_USBD_HS
1475 Define this to enable the high speed support for usb
1476 device and usbtty. If this feature is enabled, a routine
1477 int is_usbd_high_speed(void)
1478 also needs to be defined by the driver to dynamically poll
1479 whether the enumeration has succeded at high speed or full
1480 speed.
1481
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001482 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001483 Define this if you want stdin, stdout &/or stderr to
1484 be set to usbtty.
1485
1486 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001487 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001488 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001489 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denke2601822006-06-14 18:14:56 +02001490
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001491 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001492 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001493 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001494
Wolfgang Denke2601822006-06-14 18:14:56 +02001495 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001496 define your own vendor specific values either in BoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001497 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001498 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1499 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1500 should pretend to be a Linux device to it's target host.
1501
1502 CONFIG_USBD_MANUFACTURER
1503 Define this string as the name of your company for
1504 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denke2601822006-06-14 18:14:56 +02001505
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001506 CONFIG_USBD_PRODUCT_NAME
1507 Define this string as the name of your product
1508 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
wdenkc6097192002-11-03 00:24:07 +00001509
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001510 CONFIG_USBD_VENDORID
1511 Define this as your assigned Vendor ID from the USB
1512 Implementors Forum. This *must* be a genuine Vendor ID
1513 to avoid polluting the USB namespace.
1514 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001515
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001516 CONFIG_USBD_PRODUCTID
1517 Define this as the unique Product ID
1518 for your device
1519 - CONFIG_USBD_PRODUCTID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001520
Igor Grinbergac5f6ee2011-12-12 12:08:35 +02001521- ULPI Layer Support:
1522 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1523 the generic ULPI layer. The generic layer accesses the ULPI PHY
1524 via the platform viewport, so you need both the genric layer and
1525 the viewport enabled. Currently only Chipidea/ARC based
1526 viewport is supported.
1527 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1528 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stachf31e4112012-10-01 00:44:35 +02001529 If your ULPI phy needs a different reference clock than the
1530 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1531 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001532
wdenk7a428cc2003-06-15 22:40:42 +00001533- MMC Support:
wdenk57b2d802003-06-27 21:31:46 +00001534 The MMC controller on the Intel PXA is supported. To
1535 enable this define CONFIG_MMC. The MMC can be
1536 accessed from the boot prompt by mapping the device
wdenk7a428cc2003-06-15 22:40:42 +00001537 to physical memory similar to flash. Command line is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001538 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1539 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenk7a428cc2003-06-15 22:40:42 +00001540
Yoshihiro Shimodadb7717b2011-07-04 22:21:22 +00001541 CONFIG_SH_MMCIF
1542 Support for Renesas on-chip MMCIF controller
1543
1544 CONFIG_SH_MMCIF_ADDR
1545 Define the base address of MMCIF registers
1546
1547 CONFIG_SH_MMCIF_CLK
1548 Define the clock frequency for MMCIF
1549
Pierre Aubertbcc302c2014-04-24 10:30:08 +02001550 CONFIG_GENERIC_MMC
1551 Enable the generic MMC driver
1552
1553 CONFIG_SUPPORT_EMMC_BOOT
1554 Enable some additional features of the eMMC boot partitions.
1555
1556 CONFIG_SUPPORT_EMMC_RPMB
1557 Enable the commands for reading, writing and programming the
1558 key for the Replay Protection Memory Block partition in eMMC.
1559
Tom Rini58a8d322013-03-14 05:32:47 +00001560- USB Device Firmware Update (DFU) class support:
1561 CONFIG_DFU_FUNCTION
1562 This enables the USB portion of the DFU USB class
1563
1564 CONFIG_CMD_DFU
1565 This enables the command "dfu" which is used to have
1566 U-Boot create a DFU class device via USB. This command
1567 requires that the "dfu_alt_info" environment variable be
1568 set and define the alt settings to expose to the host.
1569
1570 CONFIG_DFU_MMC
1571 This enables support for exposing (e)MMC devices via DFU.
1572
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +00001573 CONFIG_DFU_NAND
1574 This enables support for exposing NAND devices via DFU.
1575
Afzal Mohammede3c687a2013-09-18 01:15:24 +05301576 CONFIG_DFU_RAM
1577 This enables support for exposing RAM via DFU.
1578 Note: DFU spec refer to non-volatile memory usage, but
1579 allow usages beyond the scope of spec - here RAM usage,
1580 one that would help mostly the developer.
1581
Heiko Schochera2f831e2013-06-12 06:05:51 +02001582 CONFIG_SYS_DFU_DATA_BUF_SIZE
1583 Dfu transfer uses a buffer before writing data to the
1584 raw storage device. Make the size (in bytes) of this buffer
1585 configurable. The size of this buffer is also configurable
1586 through the "dfu_bufsiz" environment variable.
1587
Pantelis Antonioua6e788d2013-03-14 05:32:48 +00001588 CONFIG_SYS_DFU_MAX_FILE_SIZE
1589 When updating files rather than the raw storage device,
1590 we use a static buffer to copy the file into and then write
1591 the buffer once we've been given the whole file. Define
1592 this to the maximum filesize (in bytes) for the buffer.
1593 Default is 4 MiB if undefined.
1594
Heiko Schochere1ba1512014-03-18 08:09:56 +01001595 DFU_DEFAULT_POLL_TIMEOUT
1596 Poll timeout [ms], is the timeout a device can send to the
1597 host. The host must wait for this timeout before sending
1598 a subsequent DFU_GET_STATUS request to the device.
1599
1600 DFU_MANIFEST_POLL_TIMEOUT
1601 Poll timeout [ms], which the device sends to the host when
1602 entering dfuMANIFEST state. Host waits this timeout, before
1603 sending again an USB request to the device.
1604
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001605- USB Device Android Fastboot support:
1606 CONFIG_CMD_FASTBOOT
1607 This enables the command "fastboot" which enables the Android
1608 fastboot mode for the platform's USB device. Fastboot is a USB
1609 protocol for downloading images, flashing and device control
1610 used on Android devices.
1611 See doc/README.android-fastboot for more information.
1612
1613 CONFIG_ANDROID_BOOT_IMAGE
1614 This enables support for booting images which use the Android
1615 image format header.
1616
1617 CONFIG_USB_FASTBOOT_BUF_ADDR
1618 The fastboot protocol requires a large memory buffer for
1619 downloads. Define this to the starting RAM address to use for
1620 downloaded images.
1621
1622 CONFIG_USB_FASTBOOT_BUF_SIZE
1623 The fastboot protocol requires a large memory buffer for
1624 downloads. This buffer should be as large as possible for a
1625 platform. Define this to the size available RAM for fastboot.
1626
wdenkda04a8b2004-08-02 23:22:59 +00001627- Journaling Flash filesystem support:
1628 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1629 CONFIG_JFFS2_NAND_DEV
1630 Define these for a default partition on a NAND device
1631
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001632 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1633 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenkda04a8b2004-08-02 23:22:59 +00001634 Define these for a default partition on a NOR device
1635
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001636 CONFIG_SYS_JFFS_CUSTOM_PART
wdenkda04a8b2004-08-02 23:22:59 +00001637 Define this to create an own partition. You have to provide a
1638 function struct part_info* jffs2_part_info(int part_num)
1639
1640 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001641 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenkda04a8b2004-08-02 23:22:59 +00001642 to disable the command chpart. This is the default when you
1643 have not defined a custom partition
1644
Donggeun Kim8f814002011-10-24 21:15:28 +00001645- FAT(File Allocation Table) filesystem write function support:
1646 CONFIG_FAT_WRITE
Donggeun Kimb44c8ab2012-03-22 04:38:56 +00001647
1648 Define this to enable support for saving memory data as a
1649 file in FAT formatted partition.
1650
1651 This will also enable the command "fatwrite" enabling the
1652 user to write files to FAT.
Donggeun Kim8f814002011-10-24 21:15:28 +00001653
Gabe Black7f8574c2012-10-12 14:26:11 +00001654CBFS (Coreboot Filesystem) support
1655 CONFIG_CMD_CBFS
1656
1657 Define this to enable support for reading from a Coreboot
1658 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1659 and cbfsload.
1660
Siva Durga Prasad Paladugu1c4cf332014-05-26 19:18:37 +05301661- FAT(File Allocation Table) filesystem cluster size:
1662 CONFIG_FS_FAT_MAX_CLUSTSIZE
1663
1664 Define the max cluster size for fat operations else
1665 a default value of 65536 will be defined.
1666
wdenkc6097192002-11-03 00:24:07 +00001667- Keyboard Support:
1668 CONFIG_ISA_KEYBOARD
1669
1670 Define this to enable standard (PC-Style) keyboard
1671 support
1672
1673 CONFIG_I8042_KBD
1674 Standard PC keyboard driver with US (is default) and
1675 GERMAN key layout (switch via environment 'keymap=de') support.
1676 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1677 for cfb_console. Supports cursor blinking.
1678
Hung-ying Tyan4a48bcf2013-05-15 18:27:32 +08001679 CONFIG_CROS_EC_KEYB
1680 Enables a Chrome OS keyboard using the CROS_EC interface.
1681 This uses CROS_EC to communicate with a second microcontroller
1682 which provides key scans on request.
1683
wdenkc6097192002-11-03 00:24:07 +00001684- Video support:
1685 CONFIG_VIDEO
1686
1687 Define this to enable video support (for output to
1688 video).
1689
1690 CONFIG_VIDEO_CT69000
1691
1692 Enable Chips & Technologies 69000 Video chip
1693
1694 CONFIG_VIDEO_SMI_LYNXEM
wdenkd3602132004-03-25 15:14:43 +00001695 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkaea86e42004-03-23 22:53:55 +00001696 video output is selected via environment 'videoout'
1697 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1698 assumed.
wdenkc6097192002-11-03 00:24:07 +00001699
wdenkd3602132004-03-25 15:14:43 +00001700 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001701 selected via environment 'videomode'. Two different ways
wdenkaea86e42004-03-23 22:53:55 +00001702 are possible:
1703 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk05939202004-04-18 17:39:38 +00001704 Following standard modes are supported (* is default):
wdenkaea86e42004-03-23 22:53:55 +00001705
1706 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1707 -------------+---------------------------------------------
1708 8 bits | 0x301* 0x303 0x305 0x161 0x307
1709 15 bits | 0x310 0x313 0x316 0x162 0x319
1710 16 bits | 0x311 0x314 0x317 0x163 0x31A
1711 24 bits | 0x312 0x315 0x318 ? 0x31B
1712 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001713 (i.e. setenv videomode 317; saveenv; reset;)
1714
wdenkd3602132004-03-25 15:14:43 +00001715 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswileraea68562007-12-30 03:30:46 +01001716 from the bootargs. (See drivers/video/videomodes.c)
wdenkaea86e42004-03-23 22:53:55 +00001717
1718
stroeseb9c17c52003-04-04 15:53:41 +00001719 CONFIG_VIDEO_SED13806
wdenk4a5c8a72003-03-06 00:02:04 +00001720 Enable Epson SED13806 driver. This driver supports 8bpp
wdenk9dd2b882002-12-03 21:28:10 +00001721 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1722 or CONFIG_VIDEO_SED13806_16BPP
1723
Timur Tabi020edd22011-02-15 17:09:19 -06001724 CONFIG_FSL_DIU_FB
Wolfgang Denk825223d2011-09-11 21:24:09 +02001725 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi020edd22011-02-15 17:09:19 -06001726 SOCs that have a DIU should define this macro to enable DIU
1727 support, and should also define these other macros:
1728
1729 CONFIG_SYS_DIU_ADDR
1730 CONFIG_VIDEO
1731 CONFIG_CMD_BMP
1732 CONFIG_CFB_CONSOLE
1733 CONFIG_VIDEO_SW_CURSOR
1734 CONFIG_VGA_AS_SINGLE_DEVICE
1735 CONFIG_VIDEO_LOGO
1736 CONFIG_VIDEO_BMP_LOGO
1737
Timur Tabi32f709e2011-04-11 14:18:22 -05001738 The DIU driver will look for the 'video-mode' environment
1739 variable, and if defined, enable the DIU as a console during
1740 boot. See the documentation file README.video for a
1741 description of this variable.
Timur Tabi020edd22011-02-15 17:09:19 -06001742
Simon Glass54df8ce2012-12-03 13:59:47 +00001743 CONFIG_VIDEO_VGA
1744
1745 Enable the VGA video / BIOS for x86. The alternative if you
1746 are using coreboot is to use the coreboot frame buffer
1747 driver.
1748
1749
wdenk4e112c12003-06-03 23:54:09 +00001750- Keyboard Support:
wdenk57b2d802003-06-27 21:31:46 +00001751 CONFIG_KEYBOARD
wdenk4e112c12003-06-03 23:54:09 +00001752
wdenk57b2d802003-06-27 21:31:46 +00001753 Define this to enable a custom keyboard support.
1754 This simply calls drv_keyboard_init() which must be
1755 defined in your board-specific files.
1756 The only board using this so far is RBC823.
wdenk9dd2b882002-12-03 21:28:10 +00001757
wdenkc6097192002-11-03 00:24:07 +00001758- LCD Support: CONFIG_LCD
1759
1760 Define this to enable LCD support (for output to LCD
1761 display); also select one of the supported displays
1762 by defining one of these:
1763
Stelian Popf6f86652008-05-09 21:57:18 +02001764 CONFIG_ATMEL_LCD:
1765
1766 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1767
wdenkc0d54ae2003-11-25 16:55:19 +00001768 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001769
wdenkc0d54ae2003-11-25 16:55:19 +00001770 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001771
wdenkc0d54ae2003-11-25 16:55:19 +00001772 CONFIG_NEC_NL6448BC20
1773
1774 NEC NL6448BC20-08. 6.5", 640x480.
1775 Active, color, single scan.
1776
1777 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +00001778
wdenkc0d54ae2003-11-25 16:55:19 +00001779 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001780 Active, color, single scan.
1781
1782 CONFIG_SHARP_16x9
1783
1784 Sharp 320x240. Active, color, single scan.
1785 It isn't 16x9, and I am not sure what it is.
1786
1787 CONFIG_SHARP_LQ64D341
1788
1789 Sharp LQ64D341 display, 640x480.
1790 Active, color, single scan.
1791
1792 CONFIG_HLD1045
1793
1794 HLD1045 display, 640x480.
1795 Active, color, single scan.
1796
1797 CONFIG_OPTREX_BW
1798
1799 Optrex CBL50840-2 NF-FW 99 22 M5
1800 or
1801 Hitachi LMG6912RPFC-00T
1802 or
1803 Hitachi SP14Q002
1804
1805 320x240. Black & white.
1806
1807 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001808 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001809
Simon Glass599a4df2012-10-17 13:24:54 +00001810 CONFIG_LCD_ALIGNMENT
1811
1812 Normally the LCD is page-aligned (tyically 4KB). If this is
1813 defined then the LCD will be aligned to this value instead.
1814 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1815 here, since it is cheaper to change data cache settings on
1816 a per-section basis.
1817
Simon Glassaf3e2802012-10-17 13:24:59 +00001818 CONFIG_CONSOLE_SCROLL_LINES
1819
1820 When the console need to be scrolled, this is the number of
1821 lines to scroll by. It defaults to 1. Increasing this makes
1822 the console jump but can help speed up operation when scrolling
1823 is slow.
Simon Glass599a4df2012-10-17 13:24:54 +00001824
Tom Wai-Hong Tam79926a42012-09-28 15:11:16 +00001825 CONFIG_LCD_BMP_RLE8
1826
1827 Support drawing of RLE8-compressed bitmaps on the LCD.
1828
Tom Wai-Hong Tam6664f202012-12-05 14:46:40 +00001829 CONFIG_I2C_EDID
1830
1831 Enables an 'i2c edid' command which can read EDID
1832 information over I2C from an attached LCD display.
1833
wdenkeb20ad32003-09-05 23:19:14 +00001834- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenk92bbe3f2003-04-20 14:04:18 +00001835
wdenk57b2d802003-06-27 21:31:46 +00001836 If this option is set, the environment is checked for
1837 a variable "splashimage". If found, the usual display
1838 of logo, copyright and system information on the LCD
wdenk01686632004-06-30 22:59:18 +00001839 is suppressed and the BMP image at the address
wdenk57b2d802003-06-27 21:31:46 +00001840 specified in "splashimage" is loaded instead. The
1841 console is redirected to the "nulldev", too. This
1842 allows for a "silent" boot where a splash screen is
1843 loaded very quickly after power-on.
wdenk92bbe3f2003-04-20 14:04:18 +00001844
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001845 CONFIG_SPLASHIMAGE_GUARD
1846
1847 If this option is set, then U-Boot will prevent the environment
1848 variable "splashimage" from being set to a problematic address
Tom Rini958a8f82014-02-25 10:27:01 -05001849 (see README.displaying-bmps).
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001850 This option is useful for targets where, due to alignment
1851 restrictions, an improperly aligned BMP image will cause a data
1852 abort. If you think you will not have problems with unaligned
1853 accesses (for example because your toolchain prevents them)
1854 there is no need to set this option.
1855
Matthias Weisser53884182009-07-09 16:07:30 +02001856 CONFIG_SPLASH_SCREEN_ALIGN
1857
1858 If this option is set the splash image can be freely positioned
1859 on the screen. Environment variable "splashpos" specifies the
1860 position as "x,y". If a positive number is given it is used as
1861 number of pixel from left/top. If a negative number is given it
1862 is used as number of pixel from right/bottom. You can also
1863 specify 'm' for centering the image.
1864
1865 Example:
1866 setenv splashpos m,m
1867 => image at center of screen
1868
1869 setenv splashpos 30,20
1870 => image at x = 30 and y = 20
1871
1872 setenv splashpos -10,m
1873 => vertically centered image
1874 at x = dspWidth - bmpWidth - 9
1875
Stefan Roesed9d97742005-09-22 09:04:17 +02001876- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1877
1878 If this option is set, additionally to standard BMP
1879 images, gzipped BMP images can be displayed via the
1880 splashscreen support or the bmp command.
1881
Anatolij Gustschin6b4e4fc2010-03-15 14:50:25 +01001882- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1883
1884 If this option is set, 8-bit RLE compressed BMP images
1885 can be displayed via the splashscreen support or the
1886 bmp command.
1887
Lei Wene4e248d2012-09-28 04:26:47 +00001888- Do compresssing for memory range:
1889 CONFIG_CMD_ZIP
1890
1891 If this option is set, it would use zlib deflate method
1892 to compress the specified memory at its best effort.
1893
wdenk710e3502003-08-29 20:57:53 +00001894- Compression support:
Kees Cook5b06e642013-08-16 07:59:12 -07001895 CONFIG_GZIP
1896
1897 Enabled by default to support gzip compressed images.
1898
wdenk710e3502003-08-29 20:57:53 +00001899 CONFIG_BZIP2
1900
1901 If this option is set, support for bzip2 compressed
1902 images is included. If not, only uncompressed and gzip
1903 compressed images are supported.
1904
wdenk9c53f402003-10-15 23:53:47 +00001905 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001906 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk9c53f402003-10-15 23:53:47 +00001907 be at least 4MB.
wdenk92bbe3f2003-04-20 14:04:18 +00001908
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001909 CONFIG_LZMA
1910
1911 If this option is set, support for lzma compressed
1912 images is included.
1913
1914 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1915 requires an amount of dynamic memory that is given by the
1916 formula:
1917
1918 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1919
1920 Where lc and lp stand for, respectively, Literal context bits
1921 and Literal pos bits.
1922
1923 This value is upper-bounded by 14MB in the worst case. Anyway,
1924 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1925 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1926 a very small buffer.
1927
1928 Use the lzmainfo tool to determinate the lc and lp values and
1929 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001930 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001931
Kees Cook5b06e642013-08-16 07:59:12 -07001932 CONFIG_LZO
1933
1934 If this option is set, support for LZO compressed images
1935 is included.
1936
wdenk0e2bd9c2004-06-06 21:51:03 +00001937- MII/PHY support:
1938 CONFIG_PHY_ADDR
1939
1940 The address of PHY on MII bus.
1941
1942 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1943
1944 The clock frequency of the MII bus
1945
1946 CONFIG_PHY_GIGE
1947
1948 If this option is set, support for speed/duplex
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001949 detection of gigabit PHY is included.
wdenk0e2bd9c2004-06-06 21:51:03 +00001950
1951 CONFIG_PHY_RESET_DELAY
1952
1953 Some PHY like Intel LXT971A need extra delay after
1954 reset before any MII register access is possible.
1955 For such PHY, set this option to the usec delay
1956 required. (minimum 300usec for LXT971A)
1957
1958 CONFIG_PHY_CMD_DELAY (ppc4xx)
1959
1960 Some PHY like Intel LXT971A need extra delay after
1961 command issued before MII status register can be read
1962
wdenkc6097192002-11-03 00:24:07 +00001963- Ethernet address:
1964 CONFIG_ETHADDR
richardretanubune5167f12008-09-29 18:28:23 -04001965 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001966 CONFIG_ETH2ADDR
1967 CONFIG_ETH3ADDR
richardretanubune5167f12008-09-29 18:28:23 -04001968 CONFIG_ETH4ADDR
1969 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001970
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001971 Define a default value for Ethernet address to use
1972 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001973 is not determined automatically.
1974
1975- IP address:
1976 CONFIG_IPADDR
1977
1978 Define a default value for the IP address to use for
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001979 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001980 determined through e.g. bootp.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001981 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001982
1983- Server IP address:
1984 CONFIG_SERVERIP
1985
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001986 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001987 server to contact when using the "tftboot" command.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001988 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001989
Robin Getz470a6d42009-07-21 12:15:28 -04001990 CONFIG_KEEP_SERVERADDR
1991
1992 Keeps the server's MAC address, in the env 'serveraddr'
1993 for passing to bootargs (like Linux's netconsole option)
1994
Wolfgang Denk26da2992011-10-26 10:21:22 +00001995- Gateway IP address:
1996 CONFIG_GATEWAYIP
1997
1998 Defines a default value for the IP address of the
1999 default router where packets to other networks are
2000 sent to.
2001 (Environment variable "gatewayip")
2002
2003- Subnet mask:
2004 CONFIG_NETMASK
2005
2006 Defines a default value for the subnet mask (or
2007 routing prefix) which is used to determine if an IP
2008 address belongs to the local subnet or needs to be
2009 forwarded through a router.
2010 (Environment variable "netmask")
2011
David Updegraff7280da72007-06-11 10:41:07 -05002012- Multicast TFTP Mode:
2013 CONFIG_MCAST_TFTP
2014
2015 Defines whether you want to support multicast TFTP as per
2016 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002017 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff7280da72007-06-11 10:41:07 -05002018 driver in use must provide a function: mcast() to join/leave a
2019 multicast group.
2020
wdenkc6097192002-11-03 00:24:07 +00002021- BOOTP Recovery Mode:
2022 CONFIG_BOOTP_RANDOM_DELAY
2023
2024 If you have many targets in a network that try to
2025 boot using BOOTP, you may want to avoid that all
2026 systems send out BOOTP requests at precisely the same
2027 moment (which would happen for instance at recovery
2028 from a power failure, when all systems will try to
2029 boot, thus flooding the BOOTP server. Defining
2030 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
2031 inserted before sending out BOOTP requests. The
Wolfgang Denkb65aaf92007-08-06 23:21:05 +02002032 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00002033
2034 1st BOOTP request: delay 0 ... 1 sec
2035 2nd BOOTP request: delay 0 ... 2 sec
2036 3rd BOOTP request: delay 0 ... 4 sec
2037 4th and following
2038 BOOTP requests: delay 0 ... 8 sec
2039
stroesee0aadfb2003-08-28 14:17:32 +00002040- DHCP Advanced Options:
Jon Loeliger5336a762007-07-09 22:08:34 -05002041 You can fine tune the DHCP functionality by defining
2042 CONFIG_BOOTP_* symbols:
stroesee0aadfb2003-08-28 14:17:32 +00002043
Jon Loeliger5336a762007-07-09 22:08:34 -05002044 CONFIG_BOOTP_SUBNETMASK
2045 CONFIG_BOOTP_GATEWAY
2046 CONFIG_BOOTP_HOSTNAME
2047 CONFIG_BOOTP_NISDOMAIN
2048 CONFIG_BOOTP_BOOTPATH
2049 CONFIG_BOOTP_BOOTFILESIZE
2050 CONFIG_BOOTP_DNS
2051 CONFIG_BOOTP_DNS2
2052 CONFIG_BOOTP_SEND_HOSTNAME
2053 CONFIG_BOOTP_NTPSERVER
2054 CONFIG_BOOTP_TIMEOFFSET
2055 CONFIG_BOOTP_VENDOREX
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00002056 CONFIG_BOOTP_MAY_FAIL
stroesee0aadfb2003-08-28 14:17:32 +00002057
Wilson Callan22bcd6e2007-07-28 10:56:13 -04002058 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
2059 environment variable, not the BOOTP server.
stroesee0aadfb2003-08-28 14:17:32 +00002060
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00002061 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
2062 after the configured retry count, the call will fail
2063 instead of starting over. This can be used to fail over
2064 to Link-local IP address configuration if the DHCP server
2065 is not available.
2066
stroesee0aadfb2003-08-28 14:17:32 +00002067 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
2068 serverip from a DHCP server, it is possible that more
2069 than one DNS serverip is offered to the client.
2070 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
2071 serverip will be stored in the additional environment
2072 variable "dnsip2". The first DNS serverip is always
2073 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger5336a762007-07-09 22:08:34 -05002074 is defined.
stroesee0aadfb2003-08-28 14:17:32 +00002075
2076 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
2077 to do a dynamic update of a DNS server. To do this, they
2078 need the hostname of the DHCP requester.
Wilson Callan22bcd6e2007-07-28 10:56:13 -04002079 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger5336a762007-07-09 22:08:34 -05002080 of the "hostname" environment variable is passed as
2081 option 12 to the DHCP server.
stroesee0aadfb2003-08-28 14:17:32 +00002082
Aras Vaichas72aa3f32008-03-26 09:43:57 +11002083 CONFIG_BOOTP_DHCP_REQUEST_DELAY
2084
2085 A 32bit value in microseconds for a delay between
2086 receiving a "DHCP Offer" and sending the "DHCP Request".
2087 This fixes a problem with certain DHCP servers that don't
2088 respond 100% of the time to a "DHCP request". E.g. On an
2089 AT91RM9200 processor running at 180MHz, this delay needed
2090 to be *at least* 15,000 usec before a Windows Server 2003
2091 DHCP server would reply 100% of the time. I recommend at
2092 least 50,000 usec to be safe. The alternative is to hope
2093 that one of the retries will be successful but note that
2094 the DHCP timeout and retry process takes a longer than
2095 this delay.
2096
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00002097 - Link-local IP address negotiation:
2098 Negotiate with other link-local clients on the local network
2099 for an address that doesn't require explicit configuration.
2100 This is especially useful if a DHCP server cannot be guaranteed
2101 to exist in all environments that the device must operate.
2102
2103 See doc/README.link-local for more information.
2104
wdenk145d2c12004-04-15 21:48:45 +00002105 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00002106 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00002107
2108 The device id used in CDP trigger frames.
2109
2110 CONFIG_CDP_DEVICE_ID_PREFIX
2111
2112 A two character string which is prefixed to the MAC address
2113 of the device.
2114
2115 CONFIG_CDP_PORT_ID
2116
2117 A printf format string which contains the ascii name of
2118 the port. Normally is set to "eth%d" which sets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002119 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-04-15 21:48:45 +00002120
2121 CONFIG_CDP_CAPABILITIES
2122
2123 A 32bit integer which indicates the device capabilities;
2124 0x00000010 for a normal host which does not forwards.
2125
2126 CONFIG_CDP_VERSION
2127
2128 An ascii string containing the version of the software.
2129
2130 CONFIG_CDP_PLATFORM
2131
2132 An ascii string containing the name of the platform.
2133
2134 CONFIG_CDP_TRIGGER
2135
2136 A 32bit integer sent on the trigger.
2137
2138 CONFIG_CDP_POWER_CONSUMPTION
2139
2140 A 16bit integer containing the power consumption of the
2141 device in .1 of milliwatts.
2142
2143 CONFIG_CDP_APPLIANCE_VLAN_TYPE
2144
2145 A byte containing the id of the VLAN.
2146
wdenkc6097192002-11-03 00:24:07 +00002147- Status LED: CONFIG_STATUS_LED
2148
2149 Several configurations allow to display the current
2150 status using a LED. For instance, the LED will blink
2151 fast while running U-Boot code, stop blinking as
2152 soon as a reply to a BOOTP request was received, and
2153 start blinking slow once the Linux kernel is running
2154 (supported by a status LED driver in the Linux
2155 kernel). Defining CONFIG_STATUS_LED enables this
2156 feature in U-Boot.
2157
Igor Grinberg4997a9e2013-11-08 01:03:50 +02002158 Additional options:
2159
2160 CONFIG_GPIO_LED
2161 The status LED can be connected to a GPIO pin.
2162 In such cases, the gpio_led driver can be used as a
2163 status LED backend implementation. Define CONFIG_GPIO_LED
2164 to include the gpio_led driver in the U-Boot binary.
2165
Igor Grinberg203bd9f2013-11-08 01:03:52 +02002166 CONFIG_GPIO_LED_INVERTED_TABLE
2167 Some GPIO connected LEDs may have inverted polarity in which
2168 case the GPIO high value corresponds to LED off state and
2169 GPIO low value corresponds to LED on state.
2170 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
2171 with a list of GPIO LEDs that have inverted polarity.
2172
wdenkc6097192002-11-03 00:24:07 +00002173- CAN Support: CONFIG_CAN_DRIVER
2174
2175 Defining CONFIG_CAN_DRIVER enables CAN driver support
2176 on those systems that support this (optional)
2177 feature, like the TQM8xxL modules.
2178
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002179- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00002180
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002181 This enable the NEW i2c subsystem, and will allow you to use
2182 i2c commands at the u-boot command line (as long as you set
2183 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
2184 based realtime clock chips or other i2c devices. See
2185 common/cmd_i2c.c for a description of the command line
2186 interface.
2187
2188 ported i2c driver to the new framework:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002189 - drivers/i2c/soft_i2c.c:
2190 - activate first bus with CONFIG_SYS_I2C_SOFT define
2191 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2192 for defining speed and slave address
2193 - activate second bus with I2C_SOFT_DECLARATIONS2 define
2194 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2195 for defining speed and slave address
2196 - activate third bus with I2C_SOFT_DECLARATIONS3 define
2197 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2198 for defining speed and slave address
2199 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2200 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2201 for defining speed and slave address
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002202
Heiko Schocherf2850742012-10-24 13:48:22 +02002203 - drivers/i2c/fsl_i2c.c:
2204 - activate i2c driver with CONFIG_SYS_I2C_FSL
2205 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
2206 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
2207 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
2208 bus.
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02002209 - If your board supports a second fsl i2c bus, define
Heiko Schocherf2850742012-10-24 13:48:22 +02002210 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
2211 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
2212 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
2213 second bus.
2214
Simon Glass026fefb2012-10-30 07:28:53 +00002215 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu045acfa2013-10-11 16:23:53 +09002216 - activate this driver with CONFIG_SYS_I2C_TEGRA
2217 - This driver adds 4 i2c buses with a fix speed from
2218 100000 and the slave addr 0!
Simon Glass026fefb2012-10-30 07:28:53 +00002219
Dirk Eibach42b204f2013-04-25 02:40:01 +00002220 - drivers/i2c/ppc4xx_i2c.c
2221 - activate this driver with CONFIG_SYS_I2C_PPC4XX
2222 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2223 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2224
trema49f40a2013-09-21 18:13:35 +02002225 - drivers/i2c/i2c_mxc.c
2226 - activate this driver with CONFIG_SYS_I2C_MXC
2227 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2228 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2229 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2230 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2231 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2232 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
2233 If thoses defines are not set, default value is 100000
2234 for speed, and 0 for slave.
2235
Nobuhiro Iwamatsue94ea2f2013-09-27 16:58:30 +09002236 - drivers/i2c/rcar_i2c.c:
2237 - activate this driver with CONFIG_SYS_I2C_RCAR
2238 - This driver adds 4 i2c buses
2239
2240 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2241 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2242 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2243 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2244 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2245 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2246 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2247 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2248 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2249
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09002250 - drivers/i2c/sh_i2c.c:
2251 - activate this driver with CONFIG_SYS_I2C_SH
2252 - This driver adds from 2 to 5 i2c buses
2253
2254 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
2255 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
2256 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
2257 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
2258 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
2259 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2260 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2261 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2262 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2263 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
2264 - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
2265 - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
2266 - CONFIF_SYS_I2C_SH_NUM_CONTROLLERS for nummber of i2c buses
2267
Heiko Schocherf53f2b82013-10-22 11:03:18 +02002268 - drivers/i2c/omap24xx_i2c.c
2269 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2270 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2271 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2272 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2273 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2274 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2275 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2276 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2277 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2278 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2279 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2280
Heiko Schocher465819a2013-11-08 07:30:53 +01002281 - drivers/i2c/zynq_i2c.c
2282 - activate this driver with CONFIG_SYS_I2C_ZYNQ
2283 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2284 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2285
Naveen Krishna Ch5d5efd32013-12-06 12:12:38 +05302286 - drivers/i2c/s3c24x0_i2c.c:
2287 - activate this driver with CONFIG_SYS_I2C_S3C24X0
2288 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2289 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2290 with a fix speed from 100000 and the slave addr 0!
2291
Dirk Eibachb9577432014-07-03 09:28:18 +02002292 - drivers/i2c/ihs_i2c.c
2293 - activate this driver with CONFIG_SYS_I2C_IHS
2294 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2295 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2296 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2297 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2298 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2299 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2300 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2301 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2302 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2303 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2304 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2305 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
2306
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002307 additional defines:
2308
2309 CONFIG_SYS_NUM_I2C_BUSES
2310 Hold the number of i2c busses you want to use. If you
2311 don't use/have i2c muxes on your i2c bus, this
2312 is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
2313 omit this define.
2314
2315 CONFIG_SYS_I2C_DIRECT_BUS
2316 define this, if you don't use i2c muxes on your hardware.
2317 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2318 omit this define.
2319
2320 CONFIG_SYS_I2C_MAX_HOPS
2321 define how many muxes are maximal consecutively connected
2322 on one i2c bus. If you not use i2c muxes, omit this
2323 define.
2324
2325 CONFIG_SYS_I2C_BUSES
2326 hold a list of busses you want to use, only used if
2327 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2328 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2329 CONFIG_SYS_NUM_I2C_BUSES = 9:
2330
2331 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2332 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2333 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2334 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2335 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2336 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2337 {1, {I2C_NULL_HOP}}, \
2338 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2339 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2340 }
2341
2342 which defines
2343 bus 0 on adapter 0 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002344 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2345 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2346 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2347 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2348 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002349 bus 6 on adapter 1 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002350 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2351 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002352
2353 If you do not have i2c muxes on your board, omit this define.
2354
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002355- Legacy I2C Support: CONFIG_HARD_I2C
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002356
2357 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
2358 provides the following compelling advantages:
2359
2360 - more than one i2c adapter is usable
2361 - approved multibus support
2362 - better i2c mux support
2363
2364 ** Please consider updating your I2C driver now. **
wdenkc6097192002-11-03 00:24:07 +00002365
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002366 These enable legacy I2C serial bus commands. Defining
2367 CONFIG_HARD_I2C will include the appropriate I2C driver
2368 for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00002369
wdenk21136db2003-07-16 21:53:01 +00002370 This will allow you to use i2c commands at the u-boot
Jon Loeligerc1da5c92007-06-11 19:03:39 -05002371 command line (as long as you set CONFIG_CMD_I2C in
wdenkb9bbd242003-06-30 16:24:52 +00002372 CONFIG_COMMANDS) and communicate with i2c based realtime
2373 clock chips. See common/cmd_i2c.c for a description of the
wdenk4a5c8a72003-03-06 00:02:04 +00002374 command line interface.
wdenkc6097192002-11-03 00:24:07 +00002375
Ben Warren45657152006-09-07 16:50:54 -04002376 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkb9bbd242003-06-30 16:24:52 +00002377
wdenk21136db2003-07-16 21:53:01 +00002378 There are several other quantities that must also be
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002379 defined when you define CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002380
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002381 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk21136db2003-07-16 21:53:01 +00002382 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002383 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002384 the CPU's i2c node address).
wdenk21136db2003-07-16 21:53:01 +00002385
Peter Tysere4d1abc2010-04-12 22:28:21 -05002386 Now, the u-boot i2c code for the mpc8xx
Stefan Roese88fbf932010-04-15 16:07:28 +02002387 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tysere4d1abc2010-04-12 22:28:21 -05002388 and so its address should therefore be cleared to 0 (See,
2389 eg, MPC823e User's Manual p.16-473). So, set
2390 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00002391
Eric Millbrandt12990a42009-09-03 08:09:44 -05002392 CONFIG_SYS_I2C_INIT_MPC5XXX
2393
2394 When a board is reset during an i2c bus transfer
2395 chips might think that the current transfer is still
2396 in progress. Reset the slave devices by sending start
2397 commands until the slave device responds.
2398
wdenk21136db2003-07-16 21:53:01 +00002399 That's all that's required for CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002400
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002401 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb9bbd242003-06-30 16:24:52 +00002402 then the following macros need to be defined (examples are
2403 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002404
2405 I2C_INIT
2406
wdenkb9bbd242003-06-30 16:24:52 +00002407 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00002408 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002409
wdenk544e9732004-02-06 23:19:44 +00002410 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00002411
wdenkc6097192002-11-03 00:24:07 +00002412 I2C_PORT
2413
wdenk4a5c8a72003-03-06 00:02:04 +00002414 (Only for MPC8260 CPU). The I/O port to use (the code
2415 assumes both bits are on the same port). Valid values
2416 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00002417
2418 I2C_ACTIVE
2419
2420 The code necessary to make the I2C data line active
2421 (driven). If the data line is open collector, this
2422 define can be null.
2423
wdenkb9bbd242003-06-30 16:24:52 +00002424 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2425
wdenkc6097192002-11-03 00:24:07 +00002426 I2C_TRISTATE
2427
2428 The code necessary to make the I2C data line tri-stated
2429 (inactive). If the data line is open collector, this
2430 define can be null.
2431
wdenkb9bbd242003-06-30 16:24:52 +00002432 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2433
wdenkc6097192002-11-03 00:24:07 +00002434 I2C_READ
2435
York Sun4a598092013-04-01 11:29:11 -07002436 Code that returns true if the I2C data line is high,
2437 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002438
wdenkb9bbd242003-06-30 16:24:52 +00002439 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2440
wdenkc6097192002-11-03 00:24:07 +00002441 I2C_SDA(bit)
2442
York Sun4a598092013-04-01 11:29:11 -07002443 If <bit> is true, sets the I2C data line high. If it
2444 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002445
wdenkb9bbd242003-06-30 16:24:52 +00002446 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002447 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00002448 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00002449
wdenkc6097192002-11-03 00:24:07 +00002450 I2C_SCL(bit)
2451
York Sun4a598092013-04-01 11:29:11 -07002452 If <bit> is true, sets the I2C clock line high. If it
2453 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002454
wdenkb9bbd242003-06-30 16:24:52 +00002455 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002456 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00002457 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00002458
wdenkc6097192002-11-03 00:24:07 +00002459 I2C_DELAY
2460
2461 This delay is invoked four times per clock cycle so this
2462 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00002463 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00002464 like:
2465
wdenkb9bbd242003-06-30 16:24:52 +00002466 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002467
Mike Frysingeree12d542010-07-21 13:38:02 -04002468 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2469
2470 If your arch supports the generic GPIO framework (asm/gpio.h),
2471 then you may alternatively define the two GPIOs that are to be
2472 used as SCL / SDA. Any of the previous I2C_xxx macros will
2473 have GPIO-based defaults assigned to them as appropriate.
2474
2475 You should define these to the GPIO value as given directly to
2476 the generic GPIO functions.
2477
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002478 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00002479
wdenk57b2d802003-06-27 21:31:46 +00002480 When a board is reset during an i2c bus transfer
2481 chips might think that the current transfer is still
2482 in progress. On some boards it is possible to access
2483 the i2c SCLK line directly, either by using the
2484 processor pin as a GPIO or by having a second pin
2485 connected to the bus. If this option is defined a
2486 custom i2c_init_board() routine in boards/xxx/board.c
2487 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00002488
Richard Retanubundf0149c2010-04-12 15:08:17 -04002489 CONFIG_SYS_I2C_BOARD_LATE_INIT
2490
2491 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2492 defined a custom i2c_board_late_init() routine in
2493 boards/xxx/board.c is run AFTER the operations in i2c_init()
2494 is completed. This callpoint can be used to unreset i2c bus
2495 using CPU i2c controller register accesses for CPUs whose i2c
2496 controller provide such a method. It is called at the end of
2497 i2c_init() to allow i2c_init operations to setup the i2c bus
2498 controller on the CPU (e.g. setting bus speed & slave address).
2499
wdenk0e2bd9c2004-06-06 21:51:03 +00002500 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2501
2502 This option enables configuration of bi_iic_fast[] flags
2503 in u-boot bd_info structure based on u-boot environment
2504 variable "i2cfast". (see also i2cfast)
2505
Ben Warren45657152006-09-07 16:50:54 -04002506 CONFIG_I2C_MULTI_BUS
2507
2508 This option allows the use of multiple I2C buses, each of which
Wolfgang Denk092ae952011-10-26 10:21:21 +00002509 must have a controller. At any point in time, only one bus is
2510 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warren45657152006-09-07 16:50:54 -04002511 Note that bus numbering is zero-based.
2512
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002513 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04002514
2515 This option specifies a list of I2C devices that will be skipped
Wolfgang Denk092ae952011-10-26 10:21:21 +00002516 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser469cde42009-04-18 22:34:03 -05002517 is set, specify a list of bus-device pairs. Otherwise, specify
2518 a 1D array of device addresses
Ben Warren45657152006-09-07 16:50:54 -04002519
2520 e.g.
2521 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denk092ae952011-10-26 10:21:21 +00002522 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04002523
2524 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2525
Wolfgang Denk092ae952011-10-26 10:21:21 +00002526 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002527 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-09-07 16:50:54 -04002528
2529 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2530
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002531 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-11-03 19:15:00 -06002532
2533 If defined, then this indicates the I2C bus number for DDR SPD.
2534 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2535
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002536 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002537
2538 If defined, then this indicates the I2C bus number for the RTC.
2539 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2540
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002541 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002542
2543 If defined, then this indicates the I2C bus number for the DTT.
2544 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2545
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002546 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo31856dd2008-09-09 15:13:29 -07002547
2548 If defined, specifies the I2C address of the DTT device.
2549 If not defined, then U-Boot uses predefined value for
2550 specified DTT device.
2551
Andrew Dyer58c41f92008-12-29 17:36:01 -06002552 CONFIG_SOFT_I2C_READ_REPEATED_START
2553
2554 defining this will force the i2c_read() function in
2555 the soft_i2c driver to perform an I2C repeated start
2556 between writing the address pointer and reading the
2557 data. If this define is omitted the default behaviour
2558 of doing a stop-start sequence will be used. Most I2C
2559 devices can use either method, but some require one or
2560 the other.
Timur Tabiab347542006-11-03 19:15:00 -06002561
wdenkc6097192002-11-03 00:24:07 +00002562- SPI Support: CONFIG_SPI
2563
2564 Enables SPI driver (so far only tested with
2565 SPI EEPROM, also an instance works with Crystal A/D and
2566 D/As on the SACSng board)
2567
Yoshihiro Shimoda65bd9b42011-01-31 16:50:43 +09002568 CONFIG_SH_SPI
2569
2570 Enables the driver for SPI controller on SuperH. Currently
2571 only SH7757 is supported.
2572
wdenkc6097192002-11-03 00:24:07 +00002573 CONFIG_SPI_X
2574
2575 Enables extended (16-bit) SPI EEPROM addressing.
2576 (symmetrical to CONFIG_I2C_X)
2577
2578 CONFIG_SOFT_SPI
2579
wdenk4a5c8a72003-03-06 00:02:04 +00002580 Enables a software (bit-bang) SPI driver rather than
2581 using hardware support. This is a general purpose
2582 driver that only requires three general I/O port pins
2583 (two outputs, one input) to function. If this is
2584 defined, the board configuration must define several
2585 SPI configuration items (port pins to use, etc). For
2586 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002587
Ben Warren7efe9272008-01-16 22:37:35 -05002588 CONFIG_HARD_SPI
2589
2590 Enables a hardware SPI driver for general-purpose reads
2591 and writes. As with CONFIG_SOFT_SPI, the board configuration
2592 must define a list of chip-select function pointers.
Wolfgang Denk092ae952011-10-26 10:21:21 +00002593 Currently supported on some MPC8xxx processors. For an
Ben Warren7efe9272008-01-16 22:37:35 -05002594 example, see include/configs/mpc8349emds.h.
2595
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002596 CONFIG_MXC_SPI
2597
2598 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevamdcd342c2011-10-28 08:57:46 +00002599 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002600
Heiko Schocherb77c8882014-07-14 10:22:11 +02002601 CONFIG_SYS_SPI_MXC_WAIT
2602 Timeout for waiting until spi transfer completed.
2603 default: (CONFIG_SYS_HZ/100) /* 10 ms */
2604
Matthias Fuchsa4400872007-12-27 17:12:34 +01002605- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00002606
Matthias Fuchsa4400872007-12-27 17:12:34 +01002607 Enables FPGA subsystem.
2608
2609 CONFIG_FPGA_<vendor>
2610
2611 Enables support for specific chip vendors.
2612 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00002613
Matthias Fuchsa4400872007-12-27 17:12:34 +01002614 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00002615
Matthias Fuchsa4400872007-12-27 17:12:34 +01002616 Enables support for FPGA family.
2617 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2618
2619 CONFIG_FPGA_COUNT
2620
2621 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002622
Siva Durga Prasad Paladuguadc11de2014-03-14 16:35:38 +05302623 CONFIG_CMD_FPGA_LOADMK
2624
2625 Enable support for fpga loadmk command
2626
Michal Simek64c70982014-05-02 13:43:39 +02002627 CONFIG_CMD_FPGA_LOADP
2628
2629 Enable support for fpga loadp command - load partial bitstream
2630
2631 CONFIG_CMD_FPGA_LOADBP
2632
2633 Enable support for fpga loadbp command - load partial bitstream
2634 (Xilinx only)
2635
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002636 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002637
wdenk57b2d802003-06-27 21:31:46 +00002638 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002639
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002640 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002641
wdenk4a5c8a72003-03-06 00:02:04 +00002642 Enable checks on FPGA configuration interface busy
2643 status by the configuration function. This option
2644 will require a board or device specific function to
2645 be written.
wdenkc6097192002-11-03 00:24:07 +00002646
2647 CONFIG_FPGA_DELAY
2648
2649 If defined, a function that provides delays in the FPGA
2650 configuration driver.
2651
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002652 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002653 Allow Control-C to interrupt FPGA configuration
2654
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002655 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002656
wdenk4a5c8a72003-03-06 00:02:04 +00002657 Check for configuration errors during FPGA bitfile
2658 loading. For example, abort during Virtex II
2659 configuration if the INIT_B line goes low (which
2660 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002661
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002662 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002663
wdenk4a5c8a72003-03-06 00:02:04 +00002664 Maximum time to wait for the INIT_B line to deassert
2665 after PROB_B has been deasserted during a Virtex II
2666 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002667 ms.
wdenkc6097192002-11-03 00:24:07 +00002668
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002669 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002670
wdenk4a5c8a72003-03-06 00:02:04 +00002671 Maximum time to wait for BUSY to deassert during
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002672 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002673
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002674 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002675
wdenk4a5c8a72003-03-06 00:02:04 +00002676 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002677 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002678
2679- Configuration Management:
2680 CONFIG_IDENT_STRING
2681
wdenk4a5c8a72003-03-06 00:02:04 +00002682 If defined, this string will be added to the U-Boot
2683 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002684
2685- Vendor Parameter Protection:
2686
wdenk4a5c8a72003-03-06 00:02:04 +00002687 U-Boot considers the values of the environment
2688 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00002689 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00002690 are set once by the board vendor / manufacturer, and
2691 protects these variables from casual modification by
2692 the user. Once set, these variables are read-only,
2693 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002694 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002695
2696 If CONFIG_ENV_OVERWRITE is #defined in your config
2697 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00002698 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002699 these parameters.
2700
2701 Alternatively, if you #define _both_ CONFIG_ETHADDR
2702 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002703 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002704 which can be changed exactly ONCE by the user. [The
2705 serial# is unaffected by this, i. e. it remains
2706 read-only.]
2707
Joe Hershberger71497d02012-12-11 22:16:31 -06002708 The same can be accomplished in a more flexible way
2709 for any variable by configuring the type of access
2710 to allow for those variables in the ".flags" variable
2711 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2712
wdenkc6097192002-11-03 00:24:07 +00002713- Protected RAM:
2714 CONFIG_PRAM
2715
2716 Define this variable to enable the reservation of
2717 "protected RAM", i. e. RAM which is not overwritten
2718 by U-Boot. Define CONFIG_PRAM to hold the number of
2719 kB you want to reserve for pRAM. You can overwrite
2720 this default value by defining an environment
2721 variable "pram" to the number of kB you want to
2722 reserve. Note that the board info structure will
2723 still show the full amount of RAM. If pRAM is
2724 reserved, a new environment variable "mem" will
2725 automatically be defined to hold the amount of
2726 remaining RAM in a form that can be passed as boot
2727 argument to Linux, for instance like that:
2728
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01002729 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002730 saveenv
2731
2732 This way you can tell Linux not to use this memory,
2733 either, which results in a memory region that will
2734 not be affected by reboots.
2735
2736 *WARNING* If your board configuration uses automatic
2737 detection of the RAM size, you must make sure that
2738 this memory test is non-destructive. So far, the
2739 following board configurations are known to be
2740 "pRAM-clean":
2741
Wolfgang Denk90326762012-10-24 02:36:15 +00002742 IVMS8, IVML24, SPD8xx, TQM8xxL,
2743 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denkcd4e42e2010-10-05 22:54:53 +02002744 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002745
Gabe Blacka2f3a932012-12-02 04:55:18 +00002746- Access to physical memory region (> 4GB)
2747 Some basic support is provided for operations on memory not
2748 normally accessible to U-Boot - e.g. some architectures
2749 support access to more than 4GB of memory on 32-bit
2750 machines using physical address extension or similar.
2751 Define CONFIG_PHYSMEM to access this basic support, which
2752 currently only supports clearing the memory.
2753
wdenkc6097192002-11-03 00:24:07 +00002754- Error Recovery:
2755 CONFIG_PANIC_HANG
2756
2757 Define this variable to stop the system in case of a
2758 fatal error, so that you have to reset it manually.
2759 This is probably NOT a good idea for an embedded
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002760 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002761 automatically as fast as possible, but it may be
2762 useful during development since you can try to debug
2763 the conditions that lead to the situation.
2764
2765 CONFIG_NET_RETRY_COUNT
2766
wdenk4a5c8a72003-03-06 00:02:04 +00002767 This variable defines the number of retries for
2768 network operations like ARP, RARP, TFTP, or BOOTP
2769 before giving up the operation. If not defined, a
2770 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002771
Guennadi Liakhovetskib38c2b32008-04-03 17:04:19 +02002772 CONFIG_ARP_TIMEOUT
2773
2774 Timeout waiting for an ARP reply in milliseconds.
2775
Tetsuyuki Kobayashi147e3902012-07-03 22:25:21 +00002776 CONFIG_NFS_TIMEOUT
2777
2778 Timeout in milliseconds used in NFS protocol.
2779 If you encounter "ERROR: Cannot umount" in nfs command,
2780 try longer timeout such as
2781 #define CONFIG_NFS_TIMEOUT 10000UL
2782
wdenkc6097192002-11-03 00:24:07 +00002783- Command Interpreter:
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002784 CONFIG_AUTO_COMPLETE
wdenk3902d702004-04-15 18:22:41 +00002785
2786 Enable auto completion of commands using TAB.
2787
Wolfgang Denk018147d2006-11-27 15:32:42 +01002788 Note that this feature has NOT been implemented yet
2789 for the "hush" shell.
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002790
2791
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002792 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00002793
2794 Define this variable to enable the "hush" shell (from
2795 Busybox) as command line interpreter, thus enabling
2796 powerful command line syntax like
2797 if...then...else...fi conditionals or `&&' and '||'
2798 constructs ("shell scripts").
2799
2800 If undefined, you get the old, much simpler behaviour
2801 with a somewhat smaller memory footprint.
2802
2803
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002804 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002805
2806 This defines the secondary prompt string, which is
2807 printed when the command interpreter needs more input
2808 to complete a command. Usually "> ".
2809
2810 Note:
2811
wdenk57b2d802003-06-27 21:31:46 +00002812 In the current implementation, the local variables
2813 space and global environment variables space are
2814 separated. Local variables are those you define by
2815 simply typing `name=value'. To access a local
2816 variable later on, you have write `$name' or
2817 `${name}'; to execute the contents of a variable
2818 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002819
wdenk4a5c8a72003-03-06 00:02:04 +00002820 Global environment variables are those you use
2821 setenv/printenv to work with. To run a command stored
2822 in such a variable, you need to use the run command,
2823 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002824
2825 To store commands and special characters in a
2826 variable, please use double quotation marks
2827 surrounding the whole text of the variable, instead
2828 of the backslashes before semicolons and special
2829 symbols.
2830
Wolfgang Denk2039a072006-07-21 11:35:21 +02002831- Commandline Editing and History:
2832 CONFIG_CMDLINE_EDITING
2833
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002834 Enable editing and History functions for interactive
Wolfgang Denkc80857e2006-07-21 11:56:05 +02002835 commandline input operations
Wolfgang Denk2039a072006-07-21 11:35:21 +02002836
wdenkc0aa5c52003-12-06 19:49:23 +00002837- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002838 CONFIG_EXTRA_ENV_SETTINGS
2839
wdenk4a5c8a72003-03-06 00:02:04 +00002840 Define this to contain any number of null terminated
2841 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00002842 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00002843
wdenk4a5c8a72003-03-06 00:02:04 +00002844 For example, place something like this in your
2845 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002846
2847 #define CONFIG_EXTRA_ENV_SETTINGS \
2848 "myvar1=value1\0" \
2849 "myvar2=value2\0"
2850
wdenk4a5c8a72003-03-06 00:02:04 +00002851 Warning: This method is based on knowledge about the
2852 internal format how the environment is stored by the
2853 U-Boot code. This is NOT an official, exported
2854 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00002855 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002856 You better know what you are doing here.
2857
wdenk4a5c8a72003-03-06 00:02:04 +00002858 Note: overly (ab)use of the default environment is
2859 discouraged. Make sure to check other ways to preset
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002860 the environment like the "source" command or the
wdenk4a5c8a72003-03-06 00:02:04 +00002861 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002862
Stephen Warren1465d5f2012-05-22 09:21:54 +00002863 CONFIG_ENV_VARS_UBOOT_CONFIG
2864
2865 Define this in order to add variables describing the
2866 U-Boot build configuration to the default environment.
2867 These will be named arch, cpu, board, vendor, and soc.
2868
2869 Enabling this option will cause the following to be defined:
2870
2871 - CONFIG_SYS_ARCH
2872 - CONFIG_SYS_CPU
2873 - CONFIG_SYS_BOARD
2874 - CONFIG_SYS_VENDOR
2875 - CONFIG_SYS_SOC
2876
Tom Rini4c8cc9b2012-10-24 07:28:16 +00002877 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2878
2879 Define this in order to add variables describing certain
2880 run-time determined information about the hardware to the
2881 environment. These will be named board_name, board_rev.
2882
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002883 CONFIG_DELAY_ENVIRONMENT
2884
2885 Normally the environment is loaded when the board is
2886 intialised so that it is available to U-Boot. This inhibits
2887 that so that the environment is not available until
2888 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2889 this is instead controlled by the value of
2890 /config/load-environment.
2891
wdenkc0aa5c52003-12-06 19:49:23 +00002892- DataFlash Support:
wdenk381669a2003-06-16 23:50:08 +00002893 CONFIG_HAS_DATAFLASH
2894
wdenk57b2d802003-06-27 21:31:46 +00002895 Defining this option enables DataFlash features and
2896 allows to read/write in Dataflash via the standard
2897 commands cp, md...
wdenk381669a2003-06-16 23:50:08 +00002898
Eric Nelson97f5f8f2012-01-31 10:52:08 -07002899- Serial Flash support
2900 CONFIG_CMD_SF
2901
2902 Defining this option enables SPI flash commands
2903 'sf probe/read/write/erase/update'.
2904
2905 Usage requires an initial 'probe' to define the serial
2906 flash parameters, followed by read/write/erase/update
2907 commands.
2908
2909 The following defaults may be provided by the platform
2910 to handle the common case when only a single serial
2911 flash is present on the system.
2912
2913 CONFIG_SF_DEFAULT_BUS Bus identifier
2914 CONFIG_SF_DEFAULT_CS Chip-select
2915 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2916 CONFIG_SF_DEFAULT_SPEED in Hz
2917
Simon Glass4b5545e2012-10-08 13:16:02 +00002918 CONFIG_CMD_SF_TEST
2919
2920 Define this option to include a destructive SPI flash
2921 test ('sf test').
2922
Jagannadha Sutradharudu Tekic6d173d2013-06-19 15:33:58 +05302923 CONFIG_SPI_FLASH_BAR Ban/Extended Addr Reg
2924
2925 Define this option to use the Bank addr/Extended addr
2926 support on SPI flashes which has size > 16Mbytes.
2927
Jagannadha Sutradharudu Tekid7f253b2014-01-11 15:25:04 +05302928 CONFIG_SF_DUAL_FLASH Dual flash memories
2929
2930 Define this option to use dual flash support where two flash
2931 memories can be connected with a given cs line.
2932 currently Xilinx Zynq qspi support these type of connections.
2933
wdenkef893942004-02-23 16:11:30 +00002934- SystemACE Support:
2935 CONFIG_SYSTEMACE
2936
2937 Adding this option adds support for Xilinx SystemACE
2938 chips attached via some sort of local bus. The address
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002939 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002940 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenkef893942004-02-23 16:11:30 +00002941
2942 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002943 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenkef893942004-02-23 16:11:30 +00002944
2945 When SystemACE support is added, the "ace" device type
2946 becomes available to the fat commands, i.e. fatls.
2947
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002948- TFTP Fixed UDP Port:
2949 CONFIG_TFTP_PORT
2950
Wolfgang Denk227b5192005-09-24 23:25:46 +02002951 If this is defined, the environment variable tftpsrcp
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002952 is used to supply the TFTP UDP source port value.
Wolfgang Denk227b5192005-09-24 23:25:46 +02002953 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002954 number generator is used.
2955
Wolfgang Denk227b5192005-09-24 23:25:46 +02002956 Also, the environment variable tftpdstp is used to supply
2957 the TFTP UDP destination port value. If tftpdstp isn't
2958 defined, the normal port 69 is used.
2959
2960 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002961 blindly start the TFTP transfer using the pre-configured
2962 target IP address and UDP port. This has the effect of
2963 "punching through" the (Windows XP) firewall, allowing
2964 the remainder of the TFTP transfer to proceed normally.
2965 A better solution is to properly configure the firewall,
2966 but sometimes that is not allowed.
2967
Simon Glass058bb8d2012-12-05 14:46:38 +00002968- Hashing support:
2969 CONFIG_CMD_HASH
2970
2971 This enables a generic 'hash' command which can produce
2972 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
2973
2974 CONFIG_HASH_VERIFY
2975
2976 Enable the hash verify command (hash -v). This adds to code
2977 size a little.
2978
2979 CONFIG_SHA1 - support SHA1 hashing
2980 CONFIG_SHA256 - support SHA256 hashing
2981
2982 Note: There is also a sha1sum command, which should perhaps
2983 be deprecated in favour of 'hash sha1'.
2984
Robert Winkler765ccf42013-07-24 17:57:06 -07002985- Freescale i.MX specific commands:
2986 CONFIG_CMD_HDMIDETECT
2987 This enables 'hdmidet' command which returns true if an
2988 HDMI monitor is detected. This command is i.MX 6 specific.
2989
2990 CONFIG_CMD_BMODE
2991 This enables the 'bmode' (bootmode) command for forcing
2992 a boot from specific media.
2993
2994 This is useful for forcing the ROM's usb downloader to
2995 activate upon a watchdog reset which is nice when iterating
2996 on U-Boot. Using the reset button or running bmode normal
2997 will set it back to normal. This command currently
2998 supports i.MX53 and i.MX6.
2999
Simon Glass35191a32013-06-13 15:10:02 -07003000- Signing support:
3001 CONFIG_RSA
3002
3003 This enables the RSA algorithm used for FIT image verification
Detlev Zundel49dc73b2014-01-20 16:21:46 +01003004 in U-Boot. See doc/uImage.FIT/signature.txt for more information.
Simon Glass35191a32013-06-13 15:10:02 -07003005
3006 The signing part is build into mkimage regardless of this
3007 option.
3008
Heiko Schocher443ca402014-01-25 07:27:13 +01003009- bootcount support:
3010 CONFIG_BOOTCOUNT_LIMIT
3011
3012 This enables the bootcounter support, see:
3013 http://www.denx.de/wiki/DULG/UBootBootCountLimit
3014
3015 CONFIG_AT91SAM9XE
3016 enable special bootcounter support on at91sam9xe based boards.
3017 CONFIG_BLACKFIN
3018 enable special bootcounter support on blackfin based boards.
3019 CONFIG_SOC_DA8XX
3020 enable special bootcounter support on da850 based boards.
3021 CONFIG_BOOTCOUNT_RAM
3022 enable support for the bootcounter in RAM
3023 CONFIG_BOOTCOUNT_I2C
3024 enable support for the bootcounter on an i2c (like RTC) device.
3025 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
3026 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
3027 the bootcounter.
3028 CONFIG_BOOTCOUNT_ALEN = address len
Simon Glass35191a32013-06-13 15:10:02 -07003029
wdenkc0aa5c52003-12-06 19:49:23 +00003030- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00003031 CONFIG_SHOW_BOOT_PROGRESS
3032
wdenk4a5c8a72003-03-06 00:02:04 +00003033 Defining this option allows to add some board-
3034 specific code (calling a user-provided function
3035 "show_boot_progress(int)") that enables you to show
3036 the system's boot progress on some display (for
3037 example, some LED's) on your board. At the moment,
3038 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00003039
Simon Glass31a870e2012-02-13 13:51:19 +00003040- Detailed boot stage timing
3041 CONFIG_BOOTSTAGE
3042 Define this option to get detailed timing of each stage
3043 of the boot process.
3044
3045 CONFIG_BOOTSTAGE_USER_COUNT
3046 This is the number of available user bootstage records.
3047 Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
3048 a new ID will be allocated from this stash. If you exceed
3049 the limit, recording will stop.
3050
3051 CONFIG_BOOTSTAGE_REPORT
3052 Define this to print a report before boot, similar to this:
3053
3054 Timer summary in microseconds:
3055 Mark Elapsed Stage
3056 0 0 reset
3057 3,575,678 3,575,678 board_init_f start
3058 3,575,695 17 arch_cpu_init A9
3059 3,575,777 82 arch_cpu_init done
3060 3,659,598 83,821 board_init_r start
3061 3,910,375 250,777 main_loop
3062 29,916,167 26,005,792 bootm_start
3063 30,361,327 445,160 start_kernel
3064
Simon Glass4afd88e2012-09-28 08:56:39 +00003065 CONFIG_CMD_BOOTSTAGE
3066 Add a 'bootstage' command which supports printing a report
3067 and un/stashing of bootstage data.
3068
Simon Glass0fa36a42012-09-28 08:56:37 +00003069 CONFIG_BOOTSTAGE_FDT
3070 Stash the bootstage information in the FDT. A root 'bootstage'
3071 node is created with each bootstage id as a child. Each child
3072 has a 'name' property and either 'mark' containing the
3073 mark time in microsecond, or 'accum' containing the
3074 accumulated time for that bootstage id in microseconds.
3075 For example:
3076
3077 bootstage {
3078 154 {
3079 name = "board_init_f";
3080 mark = <3575678>;
3081 };
3082 170 {
3083 name = "lcd";
3084 accum = <33482>;
3085 };
3086 };
3087
3088 Code in the Linux kernel can find this in /proc/devicetree.
3089
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003090Legacy uImage format:
3091
wdenkc6097192002-11-03 00:24:07 +00003092 Arg Where When
3093 1 common/cmd_bootm.c before attempting to boot an image
wdenk544e9732004-02-06 23:19:44 +00003094 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00003095 2 common/cmd_bootm.c Image header has correct magic number
wdenk544e9732004-02-06 23:19:44 +00003096 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003097 3 common/cmd_bootm.c Image header has correct checksum
wdenk544e9732004-02-06 23:19:44 +00003098 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003099 4 common/cmd_bootm.c Image data has correct checksum
3100 -4 common/cmd_bootm.c Image is for unsupported architecture
3101 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003102 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00003103 6 common/cmd_bootm.c Image Type check OK
3104 -6 common/cmd_bootm.c gunzip uncompression error
3105 -7 common/cmd_bootm.c Unimplemented compression type
3106 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003107 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00003108 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003109
3110 9 common/image.c Start initial ramdisk verification
3111 -10 common/image.c Ramdisk header has bad magic number
3112 -11 common/image.c Ramdisk header has bad checksum
3113 10 common/image.c Ramdisk header is OK
3114 -12 common/image.c Ramdisk data has bad checksum
3115 11 common/image.c Ramdisk data has correct checksum
3116 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003117 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003118 13 common/image.c Start multifile image verification
3119 14 common/image.c No initial ramdisk, no multifile, continue.
3120
Wolfgang Denk092ae952011-10-26 10:21:21 +00003121 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00003122
Stefan Roese88fbf932010-04-15 16:07:28 +02003123 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenkd729d302004-02-27 00:07:27 +00003124 -31 post/post.c POST test failed, detected by post_output_backlog()
3125 -32 post/post.c POST test failed, detected by post_run_single()
wdenke97d3d92004-02-23 22:22:28 +00003126
Heiko Schocher633e03a2007-06-22 19:11:54 +02003127 34 common/cmd_doc.c before loading a Image from a DOC device
3128 -35 common/cmd_doc.c Bad usage of "doc" command
3129 35 common/cmd_doc.c correct usage of "doc" command
3130 -36 common/cmd_doc.c No boot device
3131 36 common/cmd_doc.c correct boot device
3132 -37 common/cmd_doc.c Unknown Chip ID on boot device
3133 37 common/cmd_doc.c correct chip ID found, device available
3134 -38 common/cmd_doc.c Read Error on boot device
3135 38 common/cmd_doc.c reading Image header from DOC device OK
3136 -39 common/cmd_doc.c Image header has bad magic number
3137 39 common/cmd_doc.c Image header has correct magic number
3138 -40 common/cmd_doc.c Error reading Image from DOC device
3139 40 common/cmd_doc.c Image header has correct magic number
3140 41 common/cmd_ide.c before loading a Image from a IDE device
3141 -42 common/cmd_ide.c Bad usage of "ide" command
3142 42 common/cmd_ide.c correct usage of "ide" command
3143 -43 common/cmd_ide.c No boot device
3144 43 common/cmd_ide.c boot device found
3145 -44 common/cmd_ide.c Device not available
3146 44 common/cmd_ide.c Device available
3147 -45 common/cmd_ide.c wrong partition selected
3148 45 common/cmd_ide.c partition selected
3149 -46 common/cmd_ide.c Unknown partition table
3150 46 common/cmd_ide.c valid partition table found
3151 -47 common/cmd_ide.c Invalid partition type
3152 47 common/cmd_ide.c correct partition type
3153 -48 common/cmd_ide.c Error reading Image Header on boot device
3154 48 common/cmd_ide.c reading Image Header from IDE device OK
3155 -49 common/cmd_ide.c Image header has bad magic number
3156 49 common/cmd_ide.c Image header has correct magic number
3157 -50 common/cmd_ide.c Image header has bad checksum
3158 50 common/cmd_ide.c Image header has correct checksum
3159 -51 common/cmd_ide.c Error reading Image from IDE device
3160 51 common/cmd_ide.c reading Image from IDE device OK
3161 52 common/cmd_nand.c before loading a Image from a NAND device
3162 -53 common/cmd_nand.c Bad usage of "nand" command
3163 53 common/cmd_nand.c correct usage of "nand" command
3164 -54 common/cmd_nand.c No boot device
3165 54 common/cmd_nand.c boot device found
3166 -55 common/cmd_nand.c Unknown Chip ID on boot device
3167 55 common/cmd_nand.c correct chip ID found, device available
3168 -56 common/cmd_nand.c Error reading Image Header on boot device
3169 56 common/cmd_nand.c reading Image Header from NAND device OK
3170 -57 common/cmd_nand.c Image header has bad magic number
3171 57 common/cmd_nand.c Image header has correct magic number
3172 -58 common/cmd_nand.c Error reading Image from NAND device
3173 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00003174
Heiko Schocher633e03a2007-06-22 19:11:54 +02003175 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00003176
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003177 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher633e03a2007-06-22 19:11:54 +02003178 -64 net/eth.c no Ethernet found.
3179 65 net/eth.c Ethernet found.
wdenkc6097192002-11-03 00:24:07 +00003180
Heiko Schocher633e03a2007-06-22 19:11:54 +02003181 -80 common/cmd_net.c usage wrong
3182 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003183 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher633e03a2007-06-22 19:11:54 +02003184 81 common/cmd_net.c NetLoop() back without error
3185 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
3186 82 common/cmd_net.c trying automatic boot
Wolfgang Denk85c25df2009-04-01 23:34:12 +02003187 83 common/cmd_net.c running "source" command
3188 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher633e03a2007-06-22 19:11:54 +02003189 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00003190
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003191FIT uImage format:
3192
3193 Arg Where When
3194 100 common/cmd_bootm.c Kernel FIT Image has correct format
3195 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
3196 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
3197 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
3198 102 common/cmd_bootm.c Kernel unit name specified
3199 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +01003200 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003201 104 common/cmd_bootm.c Got kernel subimage node offset
3202 -104 common/cmd_bootm.c Kernel subimage hash verification failed
3203 105 common/cmd_bootm.c Kernel subimage hash verification OK
3204 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
3205 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003206 -106 common/cmd_bootm.c Kernel subimage has wrong type
3207 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003208 -107 common/cmd_bootm.c Can't get kernel subimage data/size
3209 108 common/cmd_bootm.c Got kernel subimage data/size
3210 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
3211 -109 common/cmd_bootm.c Can't get kernel subimage type
3212 -110 common/cmd_bootm.c Can't get kernel subimage comp
3213 -111 common/cmd_bootm.c Can't get kernel subimage os
3214 -112 common/cmd_bootm.c Can't get kernel subimage load address
3215 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
3216
3217 120 common/image.c Start initial ramdisk verification
3218 -120 common/image.c Ramdisk FIT image has incorrect format
3219 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003220 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003221 -122 common/image.c Can't get configuration for ramdisk subimage
3222 123 common/image.c Ramdisk unit name specified
3223 -124 common/image.c Can't get ramdisk subimage node offset
3224 125 common/image.c Got ramdisk subimage node offset
3225 -125 common/image.c Ramdisk subimage hash verification failed
3226 126 common/image.c Ramdisk subimage hash verification OK
3227 -126 common/image.c Ramdisk subimage for unsupported architecture
3228 127 common/image.c Architecture check OK
3229 -127 common/image.c Can't get ramdisk subimage data/size
3230 128 common/image.c Got ramdisk subimage data/size
3231 129 common/image.c Can't get ramdisk load address
3232 -129 common/image.c Got ramdisk load address
3233
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003234 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003235 131 common/cmd_doc.c FIT image format OK
3236
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003237 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003238 141 common/cmd_ide.c FIT image format OK
3239
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003240 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003241 151 common/cmd_nand.c FIT image format OK
3242
Heiko Schocher515eb122014-05-28 11:33:33 +02003243- legacy image format:
3244 CONFIG_IMAGE_FORMAT_LEGACY
3245 enables the legacy image format support in U-Boot.
3246
3247 Default:
3248 enabled if CONFIG_FIT_SIGNATURE is not defined.
3249
3250 CONFIG_DISABLE_IMAGE_LEGACY
3251 disable the legacy image format
3252
3253 This define is introduced, as the legacy image format is
3254 enabled per default for backward compatibility.
3255
Gabe Blackd572e162012-10-25 16:31:10 +00003256- FIT image support:
3257 CONFIG_FIT
3258 Enable support for the FIT uImage format.
3259
3260 CONFIG_FIT_BEST_MATCH
3261 When no configuration is explicitly selected, default to the
3262 one whose fdt's compatibility field best matches that of
3263 U-Boot itself. A match is considered "best" if it matches the
3264 most specific compatibility entry of U-Boot's fdt's root node.
3265 The order of entries in the configuration's fdt is ignored.
3266
Simon Glass58fe7e52013-06-13 15:10:00 -07003267 CONFIG_FIT_SIGNATURE
3268 This option enables signature verification of FIT uImages,
3269 using a hash signed and verified using RSA. See
3270 doc/uImage.FIT/signature.txt for more details.
3271
Heiko Schocher515eb122014-05-28 11:33:33 +02003272 WARNING: When relying on signed FIT images with required
3273 signature check the legacy image format is default
3274 disabled. If a board need legacy image format support
3275 enable this through CONFIG_IMAGE_FORMAT_LEGACY
3276
Dirk Eibach88919ca2014-07-03 09:28:26 +02003277 CONFIG_FIT_DISABLE_SHA256
3278 Supporting SHA256 hashes has quite an impact on binary size.
3279 For constrained systems sha256 hash support can be disabled
3280 with this option.
3281
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003282- Standalone program support:
3283 CONFIG_STANDALONE_LOAD_ADDR
3284
Wolfgang Denk23f78482011-10-09 21:06:34 +02003285 This option defines a board specific value for the
3286 address where standalone program gets loaded, thus
3287 overwriting the architecture dependent default
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003288 settings.
3289
3290- Frame Buffer Address:
3291 CONFIG_FB_ADDR
3292
3293 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denka71eb8e2013-01-03 00:43:59 +00003294 address for frame buffer. This is typically the case
3295 when using a graphics controller has separate video
3296 memory. U-Boot will then place the frame buffer at
3297 the given address instead of dynamically reserving it
3298 in system RAM by calling lcd_setmem(), which grabs
3299 the memory for the frame buffer depending on the
3300 configured panel size.
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003301
3302 Please see board_init_f function.
3303
Detlev Zundel0ecb6112009-12-01 17:16:19 +01003304- Automatic software updates via TFTP server
3305 CONFIG_UPDATE_TFTP
3306 CONFIG_UPDATE_TFTP_CNT_MAX
3307 CONFIG_UPDATE_TFTP_MSEC_MAX
3308
3309 These options enable and control the auto-update feature;
3310 for a more detailed description refer to doc/README.update.
3311
3312- MTD Support (mtdparts command, UBI support)
3313 CONFIG_MTD_DEVICE
3314
3315 Adds the MTD device infrastructure from the Linux kernel.
3316 Needed for mtdparts command support.
3317
3318 CONFIG_MTD_PARTITIONS
3319
3320 Adds the MTD partitioning infrastructure from the Linux
3321 kernel. Needed for UBI support.
3322
Joe Hershberger7d80fc12013-04-08 10:32:48 +00003323- UBI support
3324 CONFIG_CMD_UBI
3325
3326 Adds commands for interacting with MTD partitions formatted
3327 with the UBI flash translation layer
3328
3329 Requires also defining CONFIG_RBTREE
3330
Joe Hershberger47550fc2013-04-08 10:32:49 +00003331 CONFIG_UBI_SILENCE_MSG
3332
3333 Make the verbose messages from UBI stop printing. This leaves
3334 warnings and errors enabled.
3335
Joe Hershberger7d80fc12013-04-08 10:32:48 +00003336- UBIFS support
3337 CONFIG_CMD_UBIFS
3338
3339 Adds commands for interacting with UBI volumes formatted as
3340 UBIFS. UBIFS is read-only in u-boot.
3341
3342 Requires UBI support as well as CONFIG_LZO
3343
Joe Hershberger47550fc2013-04-08 10:32:49 +00003344 CONFIG_UBIFS_SILENCE_MSG
3345
3346 Make the verbose messages from UBIFS stop printing. This leaves
3347 warnings and errors enabled.
3348
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003349- SPL framework
Wolfgang Denk825223d2011-09-11 21:24:09 +02003350 CONFIG_SPL
3351 Enable building of SPL globally.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003352
Tom Rini36853852012-02-14 07:29:40 +00003353 CONFIG_SPL_LDSCRIPT
3354 LDSCRIPT for linking the SPL binary.
3355
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003356 CONFIG_SPL_MAX_FOOTPRINT
3357 Maximum size in memory allocated to the SPL, BSS included.
3358 When defined, the linker checks that the actual memory
3359 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00003360 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003361 must not be both defined at the same time.
3362
Tom Rini36853852012-02-14 07:29:40 +00003363 CONFIG_SPL_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003364 Maximum size of the SPL image (text, data, rodata, and
3365 linker lists sections), BSS excluded.
3366 When defined, the linker checks that the actual size does
3367 not exceed it.
Tom Rini36853852012-02-14 07:29:40 +00003368
Wolfgang Denk825223d2011-09-11 21:24:09 +02003369 CONFIG_SPL_TEXT_BASE
3370 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003371
Scott Woodc4f0d002012-09-20 19:05:12 -05003372 CONFIG_SPL_RELOC_TEXT_BASE
3373 Address to relocate to. If unspecified, this is equal to
3374 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
3375
Tom Rini36853852012-02-14 07:29:40 +00003376 CONFIG_SPL_BSS_START_ADDR
3377 Link address for the BSS within the SPL binary.
3378
3379 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003380 Maximum size in memory allocated to the SPL BSS.
3381 When defined, the linker checks that the actual memory used
3382 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00003383 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003384 must not be both defined at the same time.
Tom Rini36853852012-02-14 07:29:40 +00003385
3386 CONFIG_SPL_STACK
3387 Adress of the start of the stack SPL will use
3388
Scott Woodc4f0d002012-09-20 19:05:12 -05003389 CONFIG_SPL_RELOC_STACK
3390 Adress of the start of the stack SPL will use after
3391 relocation. If unspecified, this is equal to
3392 CONFIG_SPL_STACK.
3393
Tom Rini36853852012-02-14 07:29:40 +00003394 CONFIG_SYS_SPL_MALLOC_START
3395 Starting address of the malloc pool used in SPL.
3396
3397 CONFIG_SYS_SPL_MALLOC_SIZE
3398 The size of the malloc pool used in SPL.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003399
Tom Rini28591df2012-08-13 12:03:19 -07003400 CONFIG_SPL_FRAMEWORK
3401 Enable the SPL framework under common/. This framework
3402 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3403 NAND loading of the Linux Kernel.
3404
Tom Rinic2b76002014-03-28 12:03:39 -04003405 CONFIG_SPL_OS_BOOT
3406 Enable booting directly to an OS from SPL.
3407 See also: doc/README.falcon
3408
Tom Rinife3b0c72012-08-13 11:37:56 -07003409 CONFIG_SPL_DISPLAY_PRINT
3410 For ARM, enable an optional function to print more information
3411 about the running system.
3412
Scott Wood7c810902012-09-20 16:35:21 -05003413 CONFIG_SPL_INIT_MINIMAL
3414 Arch init code should be built for a very small image
3415
Wolfgang Denk825223d2011-09-11 21:24:09 +02003416 CONFIG_SPL_LIBCOMMON_SUPPORT
3417 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003418
Wolfgang Denk825223d2011-09-11 21:24:09 +02003419 CONFIG_SPL_LIBDISK_SUPPORT
3420 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003421
Wolfgang Denk825223d2011-09-11 21:24:09 +02003422 CONFIG_SPL_I2C_SUPPORT
3423 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003424
Wolfgang Denk825223d2011-09-11 21:24:09 +02003425 CONFIG_SPL_GPIO_SUPPORT
3426 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003427
Wolfgang Denk825223d2011-09-11 21:24:09 +02003428 CONFIG_SPL_MMC_SUPPORT
3429 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003430
Tom Rini36853852012-02-14 07:29:40 +00003431 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
3432 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
3433 CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
3434 Address, size and partition on the MMC to load U-Boot from
3435 when the MMC is being used in raw mode.
3436
Peter Korsgaard01b542f2013-05-13 08:36:29 +00003437 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3438 Sector to load kernel uImage from when MMC is being
3439 used in raw mode (for Falcon mode)
3440
3441 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3442 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3443 Sector and number of sectors to load kernel argument
3444 parameters from when MMC is being used in raw mode
3445 (for falcon mode)
3446
Tom Rini36853852012-02-14 07:29:40 +00003447 CONFIG_SPL_FAT_SUPPORT
3448 Support for fs/fat/libfat.o in SPL binary
3449
3450 CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
3451 Filename to read to load U-Boot when reading from FAT
3452
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003453 CONFIG_SPL_FAT_LOAD_KERNEL_NAME
3454 Filename to read to load kernel uImage when reading
3455 from FAT (for Falcon mode)
3456
3457 CONFIG_SPL_FAT_LOAD_ARGS_NAME
3458 Filename to read to load kernel argument parameters
3459 when reading from FAT (for Falcon mode)
3460
Scott Wood2b36fbb2012-12-06 13:33:17 +00003461 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3462 Set this for NAND SPL on PPC mpc83xx targets, so that
3463 start.S waits for the rest of the SPL to load before
3464 continuing (the hardware starts execution after just
3465 loading the first page rather than the full 4K).
3466
Prabhakar Kushwaha6e2b9a32014-04-08 19:12:31 +05303467 CONFIG_SPL_SKIP_RELOCATE
3468 Avoid SPL relocation
3469
Scott Woodc352a0c2012-09-20 19:09:07 -05003470 CONFIG_SPL_NAND_BASE
3471 Include nand_base.c in the SPL. Requires
3472 CONFIG_SPL_NAND_DRIVERS.
3473
3474 CONFIG_SPL_NAND_DRIVERS
3475 SPL uses normal NAND drivers, not minimal drivers.
3476
3477 CONFIG_SPL_NAND_ECC
3478 Include standard software ECC in the SPL
3479
Tom Rini36853852012-02-14 07:29:40 +00003480 CONFIG_SPL_NAND_SIMPLE
Scott Wood36c440e2012-09-21 18:35:27 -05003481 Support for NAND boot using simple NAND drivers that
3482 expose the cmd_ctrl() interface.
Tom Rini36853852012-02-14 07:29:40 +00003483
Tom Rini543c9f12014-03-28 12:03:36 -04003484 CONFIG_SPL_MTD_SUPPORT
3485 Support for the MTD subsystem within SPL. Useful for
3486 environment on NAND support within SPL.
3487
Ying Zhang9ff70262013-08-16 15:16:11 +08003488 CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3489 Set for the SPL on PPC mpc8xxx targets, support for
York Sunf0626592013-09-30 09:22:09 -07003490 drivers/ddr/fsl/libddr.o in SPL binary.
Ying Zhang9ff70262013-08-16 15:16:11 +08003491
Ying Zhangdfb2b152013-08-16 15:16:12 +08003492 CONFIG_SPL_COMMON_INIT_DDR
3493 Set for common ddr init with serial presence detect in
3494 SPL binary.
3495
Tom Rini36853852012-02-14 07:29:40 +00003496 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3497 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3498 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3499 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3500 CONFIG_SYS_NAND_ECCBYTES
3501 Defines the size and behavior of the NAND that SPL uses
Scott Wood36c440e2012-09-21 18:35:27 -05003502 to read U-Boot
Tom Rini36853852012-02-14 07:29:40 +00003503
Prabhakar Kushwahaafffcb02013-12-11 12:42:11 +05303504 CONFIG_SPL_NAND_BOOT
3505 Add support NAND boot
3506
Tom Rini36853852012-02-14 07:29:40 +00003507 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood36c440e2012-09-21 18:35:27 -05003508 Location in NAND to read U-Boot from
3509
3510 CONFIG_SYS_NAND_U_BOOT_DST
3511 Location in memory to load U-Boot to
3512
3513 CONFIG_SYS_NAND_U_BOOT_SIZE
3514 Size of image to load
Tom Rini36853852012-02-14 07:29:40 +00003515
3516 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood36c440e2012-09-21 18:35:27 -05003517 Entry point in loaded image to jump to
Tom Rini36853852012-02-14 07:29:40 +00003518
3519 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3520 Define this if you need to first read the OOB and then the
3521 data. This is used for example on davinci plattforms.
3522
3523 CONFIG_SPL_OMAP3_ID_NAND
3524 Support for an OMAP3-specific set of functions to return the
3525 ID and MFR of the first attached NAND chip, if present.
3526
Wolfgang Denk825223d2011-09-11 21:24:09 +02003527 CONFIG_SPL_SERIAL_SUPPORT
3528 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003529
Wolfgang Denk825223d2011-09-11 21:24:09 +02003530 CONFIG_SPL_SPI_FLASH_SUPPORT
3531 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003532
Wolfgang Denk825223d2011-09-11 21:24:09 +02003533 CONFIG_SPL_SPI_SUPPORT
3534 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003535
Pavel Machekde997252012-08-30 22:42:11 +02003536 CONFIG_SPL_RAM_DEVICE
3537 Support for running image already present in ram, in SPL binary
3538
Wolfgang Denk825223d2011-09-11 21:24:09 +02003539 CONFIG_SPL_LIBGENERIC_SUPPORT
3540 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003541
Ying Zhang602f7d32013-05-20 14:07:25 +08003542 CONFIG_SPL_ENV_SUPPORT
3543 Support for the environment operating in SPL binary
3544
3545 CONFIG_SPL_NET_SUPPORT
3546 Support for the net/libnet.o in SPL binary.
3547 It conflicts with SPL env from storage medium specified by
3548 CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3549
Scott Woodeb7bd972012-12-06 13:33:16 +00003550 CONFIG_SPL_PAD_TO
Benoît Thébaudeauf0180722013-04-11 09:35:49 +00003551 Image offset to which the SPL should be padded before appending
3552 the SPL payload. By default, this is defined as
3553 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3554 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3555 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Woodeb7bd972012-12-06 13:33:16 +00003556
Scott Woodf147eb72012-09-21 16:27:32 -05003557 CONFIG_SPL_TARGET
3558 Final target image containing SPL and payload. Some SPLs
3559 use an arch-specific makefile fragment instead, for
3560 example if more than one image needs to be produced.
3561
Simon Glass82d94532013-05-08 08:05:59 +00003562 CONFIG_FIT_SPL_PRINT
3563 Printing information about a FIT image adds quite a bit of
3564 code to SPL. So this is normally disabled in SPL. Use this
3565 option to re-enable it. This will affect the output of the
3566 bootm command when booting a FIT image.
3567
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003568- TPL framework
3569 CONFIG_TPL
3570 Enable building of TPL globally.
3571
3572 CONFIG_TPL_PAD_TO
3573 Image offset to which the TPL should be padded before appending
3574 the TPL payload. By default, this is defined as
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02003575 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3576 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3577 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003578
wdenkc6097192002-11-03 00:24:07 +00003579Modem Support:
3580--------------
3581
Wolfgang Denk8f399b32011-05-01 20:44:23 +02003582[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00003583
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003584- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00003585 CONFIG_MODEM_SUPPORT
3586
3587- RTS/CTS Flow control enable:
3588 CONFIG_HWFLOW
3589
3590- Modem debug support:
3591 CONFIG_MODEM_SUPPORT_DEBUG
3592
wdenk4a5c8a72003-03-06 00:02:04 +00003593 Enables debugging stuff (char screen[1024], dbg())
3594 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00003595
wdenkc0aa5c52003-12-06 19:49:23 +00003596- Interrupt support (PPC):
3597
wdenk1ebf41e2004-01-02 14:00:00 +00003598 There are common interrupt_init() and timer_interrupt()
3599 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003600 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00003601 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003602 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00003603 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003604 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00003605 specific handling. If board has watchdog / status_led
3606 / other_activity_monitor it works automatically from
3607 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00003608
wdenkc6097192002-11-03 00:24:07 +00003609- General:
3610
wdenk4a5c8a72003-03-06 00:02:04 +00003611 In the target system modem support is enabled when a
3612 specific key (key combination) is pressed during
3613 power-on. Otherwise U-Boot will boot normally
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003614 (autoboot). The key_pressed() function is called from
wdenk4a5c8a72003-03-06 00:02:04 +00003615 board_init(). Currently key_pressed() is a dummy
3616 function, returning 1 and thus enabling modem
3617 initialization.
wdenkc6097192002-11-03 00:24:07 +00003618
wdenk4a5c8a72003-03-06 00:02:04 +00003619 If there are no modem init strings in the
3620 environment, U-Boot proceed to autoboot; the
3621 previous output (banner, info printfs) will be
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003622 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00003623
3624 See also: doc/README.Modem
3625
Helmut Raigerd5a184b2011-10-20 04:19:47 +00003626Board initialization settings:
3627------------------------------
3628
3629During Initialization u-boot calls a number of board specific functions
3630to allow the preparation of board specific prerequisites, e.g. pin setup
3631before drivers are initialized. To enable these callbacks the
3632following configuration macros have to be defined. Currently this is
3633architecture specific, so please check arch/your_architecture/lib/board.c
3634typically in board_init_f() and board_init_r().
3635
3636- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3637- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3638- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3639- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003640
wdenkc6097192002-11-03 00:24:07 +00003641Configuration Settings:
3642-----------------------
3643
York Sun6c480012014-02-26 17:03:19 -08003644- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3645 Optionally it can be defined to support 64-bit memory commands.
3646
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003647- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003648 undefine this when you're short of memory.
3649
Peter Tyserdfb72b82009-01-27 18:03:12 -06003650- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3651 width of the commands listed in the 'help' command output.
3652
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003653- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003654 prompt for user input.
3655
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003656- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003657
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003658- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003659
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003660- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003661
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003662- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003663 the application (usually a Linux kernel) when it is
3664 booted
3665
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003666- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003667 List of legal baudrate settings for this board.
3668
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003669- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk57b2d802003-06-27 21:31:46 +00003670 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00003671
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003672- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk57b2d802003-06-27 21:31:46 +00003673 If the board specific function
3674 extern int overwrite_console (void);
3675 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00003676 serial port, else the settings in the environment are used.
3677
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003678- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk57b2d802003-06-27 21:31:46 +00003679 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00003680
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003681- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00003682 Enable overwrite of previous console environment settings.
3683
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003684- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003685 Begin and End addresses of the area used by the
3686 simple memory test.
3687
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003688- CONFIG_SYS_ALT_MEMTEST:
wdenk57b2d802003-06-27 21:31:46 +00003689 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003690
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003691- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5958f4a2003-09-18 09:21:33 +00003692 Scratch address used by the alternate memory test
3693 You only need to set this if address zero isn't writeable
3694
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003695- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
3696 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01003697 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003698 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01003699 fixing up gd->ram_size the Linux kernel should gets passed
3700 the now "corrected" memory size and won't touch it either.
3701 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01003702 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01003703 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01003704 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01003705
3706 This option can be used as a workaround for the 440EPx/GRx
3707 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3708 be touched.
3709
3710 WARNING: Please make sure that this value is a multiple of
3711 the Linux page size (normally 4k). If this is not the case,
3712 then the end address of the Linux memory will be located at a
3713 non page size aligned address and this could cause major
3714 problems.
3715
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003716- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003717 Enable temporary baudrate change while serial download
3718
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003719- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003720 Physical start address of SDRAM. _Must_ be 0 here.
3721
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003722- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00003723 Physical start address of Motherboard I/O (if using a
3724 Cogent motherboard)
3725
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003726- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003727 Physical start address of Flash memory.
3728
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003729- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003730 Physical start address of boot monitor code (set by
3731 make config files to be same as the text base address
Wolfgang Denk0708bc62010-10-07 21:51:12 +02003732 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003733 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003734
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003735- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00003736 Size of memory reserved for monitor code, used to
3737 determine _at_compile_time_ (!) if the environment is
3738 embedded within the U-Boot image, or in a separate
3739 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003740
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003741- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003742 Size of DRAM reserved for malloc() use.
3743
Simon Glass863e4042014-07-10 22:23:28 -06003744- CONFIG_SYS_MALLOC_F_LEN
3745 Size of the malloc() pool for use before relocation. If
3746 this is defined, then a very simple malloc() implementation
3747 will become available before relocation. The address is just
3748 below the global data, and the stack is moved down to make
3749 space.
3750
3751 This feature allocates regions with increasing addresses
3752 within the region. calloc() is supported, but realloc()
3753 is not available. free() is supported but does nothing.
3754 The memory will be freed (or in fact just forgotton) when
3755 U-Boot relocates itself.
3756
Simon Glass0cc6f5c2014-07-10 22:23:31 -06003757 Pre-relocation malloc() is only supported on sandbox
3758 at present but is fairly easy to enable for other archs.
3759
Simon Glass1f36da02014-07-10 22:23:29 -06003760 Pre-relocation malloc() is only supported on ARM at present
3761 but is fairly easy to enable for other archs.
3762
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003763- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01003764 Normally compressed uImages are limited to an
3765 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003766 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01003767 to adjust this setting to your needs.
3768
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003769- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003770 Maximum size of memory mapped by the startup code of
3771 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003772 the Linux kernel (bd_info, boot arguments, FDT blob if
3773 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003774 environment variable is defined and non-zero. In such case
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003775 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denk092ae952011-10-26 10:21:21 +00003776 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likely26396382011-03-28 09:58:43 +00003777 variable "bootm_mapsize" will override the value of
3778 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3779 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003780
John Rigbyeea8e692010-10-13 13:57:35 -06003781- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3782 Enable initrd_high functionality. If defined then the
3783 initrd_high feature is enabled and the bootm ramdisk subcommand
3784 is enabled.
3785
3786- CONFIG_SYS_BOOT_GET_CMDLINE:
3787 Enables allocating and saving kernel cmdline in space between
3788 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3789
3790- CONFIG_SYS_BOOT_GET_KBD:
3791 Enables allocating and saving a kernel copy of the bd_info in
3792 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3793
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003794- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003795 Max number of Flash memory banks
3796
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003797- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003798 Max number of sectors on a Flash chip
3799
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003800- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003801 Timeout for Flash erase operations (in ms)
3802
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003803- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003804 Timeout for Flash write operations (in ms)
3805
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003806- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003807 Timeout for Flash set sector lock bit operation (in ms)
3808
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003809- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003810 Timeout for Flash clear lock bits operation (in ms)
3811
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003812- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00003813 If defined, hardware flash sectors protection is used
3814 instead of U-Boot software protection.
3815
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003816- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003817
3818 Enable TFTP transfers directly to flash memory;
3819 without this option such a download has to be
3820 performed in two steps: (1) download to RAM, and (2)
3821 copy from RAM to flash.
3822
3823 The two-step approach is usually more reliable, since
3824 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003825 the flash, but in some situations (when system RAM is
3826 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003827 downloaded image) this option may be very useful.
3828
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003829- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00003830 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00003831 common flash structure for storing flash geometry.
3832
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02003833- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00003834 This option also enables the building of the cfi_flash driver
3835 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003836
Piotr Ziecik3e939e92008-11-17 15:57:58 +01003837- CONFIG_FLASH_CFI_MTD
3838 This option enables the building of the cfi_mtd driver
3839 in the drivers directory. The driver exports CFI flash
3840 to the MTD layer.
3841
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003842- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02003843 Use buffered writes to flash.
3844
3845- CONFIG_FLASH_SPANSION_S29WS_N
3846 s29ws-n MirrorBit flash has non-standard addresses for buffered
3847 write commands.
3848
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003849- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01003850 If this option is defined, the common CFI flash doesn't
3851 print it's warning upon not recognized FLASH banks. This
3852 is useful, if some of the configured banks are only
3853 optionally available.
3854
Jerry Van Barenaae73572008-03-08 13:48:01 -05003855- CONFIG_FLASH_SHOW_PROGRESS
3856 If defined (must be an integer), print out countdown
3857 digits and dots. Recommended value: 45 (9..1) for 80
3858 column displays, 15 (3..1) for 40 column displays.
3859
Stefan Roesed20cba52013-04-04 15:53:14 +02003860- CONFIG_FLASH_VERIFY
3861 If defined, the content of the flash (destination) is compared
3862 against the source after the write operation. An error message
3863 will be printed when the contents are not identical.
3864 Please note that this option is useless in nearly all cases,
3865 since such flash programming errors usually are detected earlier
3866 while unprotecting/erasing/programming. Please only enable
3867 this option if you really know what you are doing.
3868
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003869- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003870 Defines the number of Ethernet receive buffers. On some
3871 Ethernet controllers it is recommended to set this value
stroese94ef1cf2003-06-05 15:39:44 +00003872 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3873 buffers can be full shortly after enabling the interface
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003874 on high Ethernet traffic.
stroese94ef1cf2003-06-05 15:39:44 +00003875 Defaults to 4 if not defined.
3876
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003877- CONFIG_ENV_MAX_ENTRIES
3878
Wolfgang Denk1136f692010-10-27 22:48:30 +02003879 Maximum number of entries in the hash table that is used
3880 internally to store the environment settings. The default
3881 setting is supposed to be generous and should work in most
3882 cases. This setting can be used to tune behaviour; see
3883 lib/hashtable.c for details.
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003884
Joe Hershberger71497d02012-12-11 22:16:31 -06003885- CONFIG_ENV_FLAGS_LIST_DEFAULT
3886- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003887 Enable validation of the values given to environment variables when
Joe Hershberger71497d02012-12-11 22:16:31 -06003888 calling env set. Variables can be restricted to only decimal,
3889 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3890 the variables can also be restricted to IP address or MAC address.
3891
3892 The format of the list is:
3893 type_attribute = [s|d|x|b|i|m]
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003894 access_atribute = [a|r|o|c]
3895 attributes = type_attribute[access_atribute]
Joe Hershberger71497d02012-12-11 22:16:31 -06003896 entry = variable_name[:attributes]
3897 list = entry[,list]
3898
3899 The type attributes are:
3900 s - String (default)
3901 d - Decimal
3902 x - Hexadecimal
3903 b - Boolean ([1yYtT|0nNfF])
3904 i - IP address
3905 m - MAC address
3906
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003907 The access attributes are:
3908 a - Any (default)
3909 r - Read-only
3910 o - Write-once
3911 c - Change-default
3912
Joe Hershberger71497d02012-12-11 22:16:31 -06003913 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3914 Define this to a list (string) to define the ".flags"
3915 envirnoment variable in the default or embedded environment.
3916
3917 - CONFIG_ENV_FLAGS_LIST_STATIC
3918 Define this to a list (string) to define validation that
3919 should be done if an entry is not found in the ".flags"
3920 environment variable. To override a setting in the static
3921 list, simply add an entry for the same variable name to the
3922 ".flags" variable.
3923
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003924- CONFIG_ENV_ACCESS_IGNORE_FORCE
3925 If defined, don't allow the -f switch to env set override variable
3926 access flags.
3927
Simon Glass66828322013-03-08 13:45:27 +00003928- CONFIG_SYS_GENERIC_BOARD
3929 This selects the architecture-generic board system instead of the
3930 architecture-specific board files. It is intended to move boards
3931 to this new framework over time. Defining this will disable the
3932 arch/foo/lib/board.c file and use common/board_f.c and
3933 common/board_r.c instead. To use this option your architecture
3934 must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
3935 its config.mk file). If you find problems enabling this option on
3936 your board please report the problem and send patches!
3937
Lokesh Vutla100c2d82013-04-17 20:49:40 +00003938- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
3939 This is set by OMAP boards for the max time that reset should
3940 be asserted. See doc/README.omap-reset-time for details on how
3941 the value can be calulated on a given board.
Simon Glass9c9f44a2013-03-11 07:06:48 +00003942
wdenkc6097192002-11-03 00:24:07 +00003943The following definitions that deal with the placement and management
3944of environment data (variable area); in general, we support the
3945following configurations:
3946
Mike Frysinger63b8f122011-07-08 10:44:25 +00003947- CONFIG_BUILD_ENVCRC:
3948
3949 Builds up envcrc with the target environment so that external utils
3950 may easily extract it and embed it in final U-Boot images.
3951
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02003952- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00003953
3954 Define this if the environment is in flash memory.
3955
3956 a) The environment occupies one whole flash sector, which is
3957 "embedded" in the text segment with the U-Boot code. This
3958 happens usually with "bottom boot sector" or "top boot
3959 sector" type flash chips, which have several smaller
3960 sectors at the start or the end. For instance, such a
3961 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3962 such a case you would place the environment in one of the
3963 4 kB sectors - with U-Boot code before and after it. With
3964 "top boot sector" type flash chips, you would put the
3965 environment in one of the last sectors, leaving a gap
3966 between U-Boot and the environment.
3967
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003968 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003969
3970 Offset of environment data (variable area) to the
3971 beginning of flash memory; for instance, with bottom boot
3972 type flash chips the second sector can be used: the offset
3973 for this sector is given here.
3974
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003975 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00003976
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003977 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003978
3979 This is just another way to specify the start address of
3980 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003981 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00003982
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003983 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003984
3985 Size of the sector containing the environment.
3986
3987
3988 b) Sometimes flash chips have few, equal sized, BIG sectors.
3989 In such a case you don't want to spend a whole sector for
3990 the environment.
3991
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003992 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003993
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02003994 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003995 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00003996 of this flash sector for the environment. This saves
3997 memory for the RAM copy of the environment.
3998
3999 It may also save flash memory if you decide to use this
4000 when your environment is "embedded" within U-Boot code,
4001 since then the remainder of the flash sector could be used
4002 for U-Boot code. It should be pointed out that this is
4003 STRONGLY DISCOURAGED from a robustness point of view:
4004 updating the environment in flash makes it always
4005 necessary to erase the WHOLE sector. If something goes
4006 wrong before the contents has been restored from a copy in
4007 RAM, your target system will be dead.
4008
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004009 - CONFIG_ENV_ADDR_REDUND
4010 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00004011
wdenk4a5c8a72003-03-06 00:02:04 +00004012 These settings describe a second storage area used to hold
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004013 a redundant copy of the environment data, so that there is
wdenkb02744a2003-04-05 00:53:31 +00004014 a valid backup copy in case there is a power failure during
wdenk4a5c8a72003-03-06 00:02:04 +00004015 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00004016
4017BE CAREFUL! Any changes to the flash layout, and some changes to the
4018source code will make it necessary to adapt <board>/u-boot.lds*
4019accordingly!
4020
4021
Jean-Christophe PLAGNIOL-VILLARDfdb79c32008-09-10 22:47:59 +02004022- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00004023
4024 Define this if you have some non-volatile memory device
4025 (NVRAM, battery buffered SRAM) which you want to use for the
4026 environment.
4027
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004028 - CONFIG_ENV_ADDR:
4029 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004030
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004031 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00004032 want to use for environment. It is assumed that this memory
4033 can just be read and written to, without any special
4034 provision.
4035
4036BE CAREFUL! The first access to the environment happens quite early
4037in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004038console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00004039U-Boot will hang.
4040
4041Please note that even with NVRAM we still use a copy of the
4042environment in RAM: we could work on NVRAM directly, but we want to
4043keep settings there always unmodified except somebody uses "saveenv"
4044to save the current settings.
4045
4046
Jean-Christophe PLAGNIOL-VILLARDe46af642008-09-05 09:19:30 +02004047- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00004048
4049 Use this if you have an EEPROM or similar serial access
4050 device and a driver for it.
4051
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004052 - CONFIG_ENV_OFFSET:
4053 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004054
4055 These two #defines specify the offset and size of the
4056 environment area within the total memory of your EEPROM.
4057
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004058 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004059 If defined, specified the chip address of the EEPROM device.
4060 The default address is zero.
4061
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004062 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00004063 If defined, the number of bits used to address bytes in a
4064 single page in the EEPROM device. A 64 byte page, for example
4065 would require six bits.
4066
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004067 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00004068 If defined, the number of milliseconds to delay between
wdenk544e9732004-02-06 23:19:44 +00004069 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00004070
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004071 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00004072 The length in bytes of the EEPROM memory array address. Note
4073 that this is NOT the chip address length!
4074
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004075 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk20c98a62004-04-23 20:32:05 +00004076 EEPROM chips that implement "address overflow" are ones
4077 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
4078 address and the extra bits end up in the "chip address" bit
4079 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
4080 byte chips.
4081
4082 Note that we consider the length of the address field to
4083 still be one byte because the extra address bits are hidden
4084 in the chip address.
4085
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004086 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004087 The size in bytes of the EEPROM device.
4088
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01004089 - CONFIG_ENV_EEPROM_IS_ON_I2C
4090 define this, if you have I2C and SPI activated, and your
4091 EEPROM, which holds the environment, is on the I2C bus.
4092
4093 - CONFIG_I2C_ENV_EEPROM_BUS
4094 if you have an Environment on an EEPROM reached over
4095 I2C muxes, you can define here, how to reach this
4096 EEPROM. For example:
4097
Heiko Schocher479a4cf2013-01-29 08:53:15 +01004098 #define CONFIG_I2C_ENV_EEPROM_BUS 1
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01004099
4100 EEPROM which holds the environment, is reached over
4101 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00004102
Jean-Christophe PLAGNIOL-VILLARD2b14d2b2008-09-10 22:47:58 +02004103- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk86765902003-12-06 23:55:10 +00004104
wdenk1ebf41e2004-01-02 14:00:00 +00004105 Define this if you have a DataFlash memory device which you
wdenk86765902003-12-06 23:55:10 +00004106 want to use for the environment.
4107
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004108 - CONFIG_ENV_OFFSET:
4109 - CONFIG_ENV_ADDR:
4110 - CONFIG_ENV_SIZE:
wdenk86765902003-12-06 23:55:10 +00004111
4112 These three #defines specify the offset and size of the
4113 environment area within the total memory of your DataFlash placed
4114 at the specified address.
4115
Wu, Josh76db7bf2014-07-01 19:30:13 +08004116- CONFIG_ENV_IS_IN_SPI_FLASH:
4117
4118 Define this if you have a SPI Flash memory device which you
4119 want to use for the environment.
4120
4121 - CONFIG_ENV_OFFSET:
4122 - CONFIG_ENV_SIZE:
4123
4124 These two #defines specify the offset and size of the
4125 environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
4126 aligned to an erase sector boundary.
4127
4128 - CONFIG_ENV_SECT_SIZE:
4129
4130 Define the SPI flash's sector size.
4131
4132 - CONFIG_ENV_OFFSET_REDUND (optional):
4133
4134 This setting describes a second storage area of CONFIG_ENV_SIZE
4135 size used to hold a redundant copy of the environment data, so
4136 that there is a valid backup copy in case there is a power failure
4137 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
4138 aligned to an erase sector boundary.
4139
4140 - CONFIG_ENV_SPI_BUS (optional):
4141 - CONFIG_ENV_SPI_CS (optional):
4142
4143 Define the SPI bus and chip select. If not defined they will be 0.
4144
4145 - CONFIG_ENV_SPI_MAX_HZ (optional):
4146
4147 Define the SPI max work clock. If not defined then use 1MHz.
4148
4149 - CONFIG_ENV_SPI_MODE (optional):
4150
4151 Define the SPI work mode. If not defined then use SPI_MODE_3.
4152
Liu Gang85bcd732012-03-08 00:33:20 +00004153- CONFIG_ENV_IS_IN_REMOTE:
4154
4155 Define this if you have a remote memory space which you
4156 want to use for the local device's environment.
4157
4158 - CONFIG_ENV_ADDR:
4159 - CONFIG_ENV_SIZE:
4160
4161 These two #defines specify the address and size of the
4162 environment area within the remote memory space. The
4163 local device can get the environment from remote memory
Liu Gang357bf5a2012-08-09 05:10:01 +00004164 space by SRIO or PCIE links.
Liu Gang85bcd732012-03-08 00:33:20 +00004165
4166BE CAREFUL! For some special cases, the local device can not use
4167"saveenv" command. For example, the local device will get the
Liu Gang357bf5a2012-08-09 05:10:01 +00004168environment stored in a remote NOR flash by SRIO or PCIE link,
4169but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang85bcd732012-03-08 00:33:20 +00004170
Jean-Christophe PLAGNIOL-VILLARDdda84dd2008-09-10 22:47:58 +02004171- CONFIG_ENV_IS_IN_NAND:
wdenk79b59372004-06-09 14:58:14 +00004172
4173 Define this if you have a NAND device which you want to use
4174 for the environment.
4175
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004176 - CONFIG_ENV_OFFSET:
4177 - CONFIG_ENV_SIZE:
wdenk79b59372004-06-09 14:58:14 +00004178
4179 These two #defines specify the offset and size of the environment
Scott Wood08239322010-09-17 14:38:37 -05004180 area within the first NAND device. CONFIG_ENV_OFFSET must be
4181 aligned to an erase block boundary.
wdenk86765902003-12-06 23:55:10 +00004182
Scott Wood08239322010-09-17 14:38:37 -05004183 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004184
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004185 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Wood08239322010-09-17 14:38:37 -05004186 size used to hold a redundant copy of the environment data, so
4187 that there is a valid backup copy in case there is a power failure
Wolfgang Denk092ae952011-10-26 10:21:21 +00004188 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Wood08239322010-09-17 14:38:37 -05004189 aligned to an erase block boundary.
4190
4191 - CONFIG_ENV_RANGE (optional):
4192
4193 Specifies the length of the region in which the environment
4194 can be written. This should be a multiple of the NAND device's
4195 block size. Specifying a range with more erase blocks than
4196 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
4197 the range to be avoided.
4198
4199 - CONFIG_ENV_OFFSET_OOB (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004200
Scott Wood08239322010-09-17 14:38:37 -05004201 Enables support for dynamically retrieving the offset of the
4202 environment from block zero's out-of-band data. The
4203 "nand env.oob" command can be used to record this offset.
4204 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
4205 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004206
Guennadi Liakhovetskifad24442009-05-18 16:07:22 +02004207- CONFIG_NAND_ENV_DST
4208
4209 Defines address in RAM to which the nand_spl code should copy the
4210 environment. If redundant environment is used, it will be copied to
4211 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
4212
Joe Hershberger0c5faa82013-04-08 10:32:51 +00004213- CONFIG_ENV_IS_IN_UBI:
4214
4215 Define this if you have an UBI volume that you want to use for the
4216 environment. This has the benefit of wear-leveling the environment
4217 accesses, which is important on NAND.
4218
4219 - CONFIG_ENV_UBI_PART:
4220
4221 Define this to a string that is the mtd partition containing the UBI.
4222
4223 - CONFIG_ENV_UBI_VOLUME:
4224
4225 Define this to the name of the volume that you want to store the
4226 environment in.
4227
Joe Hershbergerdb14e862013-04-08 10:32:52 +00004228 - CONFIG_ENV_UBI_VOLUME_REDUND:
4229
4230 Define this to the name of another volume to store a second copy of
4231 the environment in. This will enable redundant environments in UBI.
4232 It is assumed that both volumes are in the same MTD partition.
4233
Joe Hershberger0c5faa82013-04-08 10:32:51 +00004234 - CONFIG_UBI_SILENCE_MSG
4235 - CONFIG_UBIFS_SILENCE_MSG
4236
4237 You will probably want to define these to avoid a really noisy system
4238 when storing the env in UBI.
4239
Wu, Josha7d0c872014-06-24 17:31:03 +08004240- CONFIG_ENV_IS_IN_FAT:
4241 Define this if you want to use the FAT file system for the environment.
4242
4243 - FAT_ENV_INTERFACE:
4244
4245 Define this to a string that is the name of the block device.
4246
4247 - FAT_ENV_DEV_AND_PART:
4248
4249 Define this to a string to specify the partition of the device. It can
4250 be as following:
4251
4252 "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
4253 - "D:P": device D partition P. Error occurs if device D has no
4254 partition table.
4255 - "D:0": device D.
4256 - "D" or "D:": device D partition 1 if device D has partition
4257 table, or the whole device D if has no partition
4258 table.
4259 - "D:auto": first partition in device D with bootable flag set.
4260 If none, first valid paratition in device D. If no
4261 partition table then means device D.
4262
4263 - FAT_ENV_FILE:
4264
4265 It's a string of the FAT file name. This file use to store the
4266 envrionment.
4267
4268 - CONFIG_FAT_WRITE:
4269 This should be defined. Otherwise it cannot save the envrionment file.
4270
Stephen Warreneedcacd2013-06-11 15:14:00 -06004271- CONFIG_ENV_IS_IN_MMC:
4272
4273 Define this if you have an MMC device which you want to use for the
4274 environment.
4275
4276 - CONFIG_SYS_MMC_ENV_DEV:
4277
4278 Specifies which MMC device the environment is stored in.
4279
4280 - CONFIG_SYS_MMC_ENV_PART (optional):
4281
4282 Specifies which MMC partition the environment is stored in. If not
4283 set, defaults to partition 0, the user area. Common values might be
4284 1 (first MMC boot partition), 2 (second MMC boot partition).
4285
4286 - CONFIG_ENV_OFFSET:
4287 - CONFIG_ENV_SIZE:
4288
4289 These two #defines specify the offset and size of the environment
4290 area within the specified MMC device.
4291
Stephen Warren24dc2032013-06-11 15:14:02 -06004292 If offset is positive (the usual case), it is treated as relative to
4293 the start of the MMC partition. If offset is negative, it is treated
4294 as relative to the end of the MMC partition. This can be useful if
4295 your board may be fitted with different MMC devices, which have
4296 different sizes for the MMC partitions, and you always want the
4297 environment placed at the very end of the partition, to leave the
4298 maximum possible space before it, to store other data.
4299
Stephen Warreneedcacd2013-06-11 15:14:00 -06004300 These two values are in units of bytes, but must be aligned to an
4301 MMC sector boundary.
4302
4303 - CONFIG_ENV_OFFSET_REDUND (optional):
4304
4305 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
4306 hold a redundant copy of the environment data. This provides a
4307 valid backup copy in case the other copy is corrupted, e.g. due
4308 to a power failure during a "saveenv" operation.
4309
Stephen Warren24dc2032013-06-11 15:14:02 -06004310 This value may also be positive or negative; this is handled in the
4311 same way as CONFIG_ENV_OFFSET.
4312
Stephen Warreneedcacd2013-06-11 15:14:00 -06004313 This value is also in units of bytes, but must also be aligned to
4314 an MMC sector boundary.
4315
4316 - CONFIG_ENV_SIZE_REDUND (optional):
4317
4318 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
4319 set. If this value is set, it must be set to the same value as
4320 CONFIG_ENV_SIZE.
4321
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004322- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00004323
4324 Defines offset to the initial SPI buffer area in DPRAM. The
4325 area is used at an early stage (ROM part) if the environment
4326 is configured to reside in the SPI EEPROM: We need a 520 byte
4327 scratch DPRAM area. It is used between the two initialization
4328 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4329 to be a good choice since it makes it far enough from the
4330 start of the data area as well as from the stack pointer.
4331
Bruce Adleredecc942007-11-02 13:15:42 -07004332Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00004333has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denk76af2782010-07-24 21:55:43 +02004334created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00004335until then to read environment variables.
4336
wdenk8dba0502003-03-31 16:34:49 +00004337The environment is protected by a CRC32 checksum. Before the monitor
4338is relocated into RAM, as a result of a bad CRC you will be working
4339with the compiled-in default environment - *silently*!!! [This is
4340necessary, because the first environment variable we need is the
4341"baudrate" setting for the console - if we have a bad CRC, we don't
4342have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00004343
4344Note: once the monitor has been relocated, then it will complain if
4345the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00004346use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00004347
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004348- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk9c53f402003-10-15 23:53:47 +00004349 Echo the inverted Ethernet link state to the fault LED.
wdenk49c3f672003-10-08 22:33:00 +00004350
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004351 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenk49c3f672003-10-08 22:33:00 +00004352 also needs to be defined.
4353
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004354- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00004355 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00004356
Ron Madriddfa028a2009-02-18 14:30:44 -08004357- CONFIG_NS16550_MIN_FUNCTIONS:
4358 Define this if you desire to only have use of the NS16550_init
4359 and NS16550_putc functions for the serial driver located at
4360 drivers/serial/ns16550.c. This option is useful for saving
4361 space for already greatly restricted images, including but not
4362 limited to NAND_SPL configurations.
4363
Simon Glass28a9e332012-11-30 13:01:18 +00004364- CONFIG_DISPLAY_BOARDINFO
4365 Display information about the board that U-Boot is running on
4366 when U-Boot starts up. The board function checkboard() is called
4367 to do this.
4368
Simon Glasse8822012012-11-30 13:01:19 +00004369- CONFIG_DISPLAY_BOARDINFO_LATE
4370 Similar to the previous option, but display this information
4371 later, once stdio is running and output goes to the LCD, if
4372 present.
4373
Sascha Silbe4b9c17c2013-08-11 16:40:43 +02004374- CONFIG_BOARD_SIZE_LIMIT:
4375 Maximum size of the U-Boot image. When defined, the
4376 build system checks that the actual size does not
4377 exceed it.
4378
wdenkc6097192002-11-03 00:24:07 +00004379Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00004380---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004381
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004382- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004383 Cache Line Size of the CPU.
4384
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004385- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00004386 Default address of the IMMR after system reset.
wdenk2bb11052003-07-17 23:16:40 +00004387
wdenk9c53f402003-10-15 23:53:47 +00004388 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
4389 and RPXsuper) to be able to adjust the position of
4390 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00004391
Timur Tabid8f341c2011-08-04 18:03:41 -05004392- CONFIG_SYS_CCSRBAR_DEFAULT:
4393 Default (power-on reset) physical address of CCSR on Freescale
4394 PowerPC SOCs.
4395
4396- CONFIG_SYS_CCSRBAR:
4397 Virtual address of CCSR. On a 32-bit build, this is typically
4398 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4399
4400 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4401 for cross-platform code that uses that macro instead.
4402
4403- CONFIG_SYS_CCSRBAR_PHYS:
4404 Physical address of CCSR. CCSR can be relocated to a new
4405 physical address, if desired. In this case, this macro should
Wolfgang Denk092ae952011-10-26 10:21:21 +00004406 be set to that address. Otherwise, it should be set to the
Timur Tabid8f341c2011-08-04 18:03:41 -05004407 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
4408 is typically relocated on 36-bit builds. It is recommended
4409 that this macro be defined via the _HIGH and _LOW macros:
4410
4411 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4412 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4413
4414- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denkd590fb12011-10-07 09:58:21 +02004415 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
4416 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabid8f341c2011-08-04 18:03:41 -05004417 used in assembly code, so it must not contain typecasts or
4418 integer size suffixes (e.g. "ULL").
4419
4420- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4421 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
4422 used in assembly code, so it must not contain typecasts or
4423 integer size suffixes (e.g. "ULL").
4424
4425- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4426 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4427 forced to a value that ensures that CCSR is not relocated.
4428
wdenk1272e232002-11-10 22:06:23 +00004429- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004430 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk1272e232002-11-10 22:06:23 +00004431
4432 the default drive number (default value 0)
4433
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004434 CONFIG_SYS_ISA_IO_STRIDE
wdenk1272e232002-11-10 22:06:23 +00004435
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004436 defines the spacing between FDC chipset registers
wdenk1272e232002-11-10 22:06:23 +00004437 (default value 1)
4438
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004439 CONFIG_SYS_ISA_IO_OFFSET
wdenk1272e232002-11-10 22:06:23 +00004440
wdenk4a5c8a72003-03-06 00:02:04 +00004441 defines the offset of register from address. It
4442 depends on which part of the data bus is connected to
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004443 the FDC chipset. (default value 0)
wdenk1272e232002-11-10 22:06:23 +00004444
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004445 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
4446 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk4a5c8a72003-03-06 00:02:04 +00004447 default value.
wdenk1272e232002-11-10 22:06:23 +00004448
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004449 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk4a5c8a72003-03-06 00:02:04 +00004450 fdc_hw_init() is called at the beginning of the FDC
4451 setup. fdc_hw_init() must be provided by the board
4452 source code. It is used to make hardware dependant
4453 initializations.
wdenk1272e232002-11-10 22:06:23 +00004454
Macpaul Lind1e49942011-04-11 20:45:32 +00004455- CONFIG_IDE_AHB:
4456 Most IDE controllers were designed to be connected with PCI
4457 interface. Only few of them were designed for AHB interface.
4458 When software is doing ATA command and data transfer to
4459 IDE devices through IDE-AHB controller, some additional
4460 registers accessing to these kind of IDE-AHB controller
4461 is requierd.
4462
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004463- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00004464 DO NOT CHANGE unless you know exactly what you're
wdenkb3a4a702004-12-10 11:40:40 +00004465 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00004466
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004467- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004468
wdenkeb20ad32003-09-05 23:19:14 +00004469 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00004470 initial data and stack; please note that this must be
4471 writable memory that is working WITHOUT special
4472 initialization, i. e. you CANNOT use normal RAM which
4473 will become available only after programming the
4474 memory controller and running certain initialization
4475 sequences.
4476
4477 U-Boot uses the following memory types:
4478 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4479 - MPC824X: data cache
4480 - PPC4xx: data cache
4481
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004482- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004483
4484 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004485 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
4486 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00004487 data is located at the end of the available space
Wolfgang Denk1c2e98e2010-10-26 13:32:32 +02004488 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004489 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
4490 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4491 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00004492
4493 Note:
4494 On the MPC824X (or other systems that use the data
4495 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004496 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00004497 point to an otherwise UNUSED address space between
4498 the top of RAM and the start of the PCI space.
4499
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004500- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00004501
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004502- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00004503
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004504- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00004505
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004506- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00004507
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004508- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00004509
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004510- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00004511
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004512- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00004513 SDRAM timing
4514
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004515- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00004516 periodic timer for refresh
4517
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004518- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00004519
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004520- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4521 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4522 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4523 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004524 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4525
4526- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004527 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4528 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004529 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4530
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004531- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4532 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00004533 Machine Mode Register and Memory Periodic Timer
4534 Prescaler definitions (SDRAM timing)
4535
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004536- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004537 enable I2C microcode relocation patch (MPC8xx);
4538 define relocation offset in DPRAM [DSP2]
4539
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004540- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherc8148ed2008-01-11 01:12:07 +01004541 enable SMC microcode relocation patch (MPC8xx);
4542 define relocation offset in DPRAM [SMC1]
4543
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004544- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004545 enable SPI microcode relocation patch (MPC8xx);
4546 define relocation offset in DPRAM [SCC4]
4547
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004548- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00004549 Use OSCM clock mode on MBX8xx board. Be careful,
4550 wrong setting might damage your board. Read
4551 doc/README.MBX before setting this variable!
4552
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004553- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk4a5c8a72003-03-06 00:02:04 +00004554 Offset of the bootmode word in DPRAM used by post
4555 (Power On Self Tests). This definition overrides
4556 #define'd default value in commproc.h resp.
4557 cpm_8260.h.
wdenk2029f4d2002-11-21 23:11:29 +00004558
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004559- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4560 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4561 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4562 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4563 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4564 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4565 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4566 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roese88fbf932010-04-15 16:07:28 +02004567 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenkbf2f8c92003-05-22 22:52:13 +00004568
Dirk Eibach378d1ca2009-02-09 08:18:34 +01004569- CONFIG_PCI_DISABLE_PCIE:
4570 Disable PCI-Express on systems where it is supported but not
4571 required.
4572
Andrew Sharp61d47ca2012-08-29 14:16:32 +00004573- CONFIG_PCI_ENUM_ONLY
4574 Only scan through and get the devices on the busses.
4575 Don't do any setup work, presumably because someone or
4576 something has already done it, and we don't need to do it
4577 a second time. Useful for platforms that are pre-booted
4578 by coreboot or similar.
4579
Gabor Juhosb4458732013-05-30 07:06:12 +00004580- CONFIG_PCI_INDIRECT_BRIDGE:
4581 Enable support for indirect PCI bridges.
4582
Kumar Gala8975d7a2010-12-30 12:09:53 -06004583- CONFIG_SYS_SRIO:
4584 Chip has SRIO or not
4585
4586- CONFIG_SRIO1:
4587 Board has SRIO 1 port available
4588
4589- CONFIG_SRIO2:
4590 Board has SRIO 2 port available
4591
Liu Gang27afb9c2013-05-07 16:30:46 +08004592- CONFIG_SRIO_PCIE_BOOT_MASTER
4593 Board can support master function for Boot from SRIO and PCIE
4594
Kumar Gala8975d7a2010-12-30 12:09:53 -06004595- CONFIG_SYS_SRIOn_MEM_VIRT:
4596 Virtual Address of SRIO port 'n' memory region
4597
4598- CONFIG_SYS_SRIOn_MEM_PHYS:
4599 Physical Address of SRIO port 'n' memory region
4600
4601- CONFIG_SYS_SRIOn_MEM_SIZE:
4602 Size of SRIO port 'n' memory region
4603
Fabio Estevamf17e8782013-04-11 09:35:34 +00004604- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4605 Defined to tell the NAND controller that the NAND chip is using
4606 a 16 bit bus.
4607 Not all NAND drivers use this symbol.
Fabio Estevam417052b2013-04-11 09:35:35 +00004608 Example of drivers that use it:
Fabio Estevamf17e8782013-04-11 09:35:34 +00004609 - drivers/mtd/nand/ndfc.c
Fabio Estevam417052b2013-04-11 09:35:35 +00004610 - drivers/mtd/nand/mxc_nand.c
Alex Watermancd6aae32011-05-19 15:08:36 -04004611
4612- CONFIG_SYS_NDFC_EBC0_CFG
4613 Sets the EBC0_CFG register for the NDFC. If not defined
4614 a default value will be used.
4615
Ben Warren45657152006-09-07 16:50:54 -04004616- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004617 Get DDR timing information from an I2C EEPROM. Common
4618 with pluggable memory modules such as SODIMMs
4619
Ben Warren45657152006-09-07 16:50:54 -04004620 SPD_EEPROM_ADDRESS
4621 I2C address of the SPD EEPROM
4622
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004623- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004624 If SPD EEPROM is on an I2C bus other than the first
4625 one, specify here. Note that the value must resolve
4626 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04004627
York Sune73cc042011-06-07 09:42:16 +08004628- CONFIG_SYS_DDR_RAW_TIMING
4629 Get DDR timing information from other than SPD. Common with
4630 soldered DDR chips onboard without SPD. DDR raw timing
4631 parameters are extracted from datasheet and hard-coded into
4632 header files or board specific files.
4633
York Sunbd495cf2011-09-16 13:21:35 -07004634- CONFIG_FSL_DDR_INTERACTIVE
4635 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4636
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004637- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004638 Only for 83xx systems. If specified, then DDR should
4639 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06004640
wdenk6203e402004-04-18 10:13:26 +00004641- CONFIG_ETHER_ON_FEC[12]
4642 Define to enable FEC[12] on a 8xx series processor.
4643
4644- CONFIG_FEC[12]_PHY
4645 Define to the hardcoded PHY address which corresponds
wdenk05939202004-04-18 17:39:38 +00004646 to the given FEC; i. e.
4647 #define CONFIG_FEC1_PHY 4
wdenk6203e402004-04-18 10:13:26 +00004648 means that the PHY with address 4 is connected to FEC1
4649
4650 When set to -1, means to probe for first available.
4651
4652- CONFIG_FEC[12]_PHY_NORXERR
4653 The PHY does not have a RXERR line (RMII only).
4654 (so program the FEC to ignore it).
4655
4656- CONFIG_RMII
4657 Enable RMII mode for all FECs.
4658 Note that this is a global option, we can't
4659 have one FEC in standard MII mode and another in RMII mode.
4660
wdenk20c98a62004-04-23 20:32:05 +00004661- CONFIG_CRC32_VERIFY
4662 Add a verify option to the crc32 command.
4663 The syntax is:
4664
4665 => crc32 -v <address> <count> <crc32>
4666
4667 Where address/count indicate a memory area
4668 and crc32 is the correct crc32 which the
4669 area should have.
4670
wdenk64519362004-07-11 17:40:54 +00004671- CONFIG_LOOPW
4672 Add the "loopw" memory command. This only takes effect if
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004673 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk64519362004-07-11 17:40:54 +00004674
stroesecc3af832004-12-16 18:46:55 +00004675- CONFIG_MX_CYCLIC
4676 Add the "mdc" and "mwc" memory commands. These are cyclic
4677 "md/mw" commands.
4678 Examples:
4679
wdenk07d7e6b2004-12-16 21:44:03 +00004680 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00004681 This command will print 4 bytes (10,11,12,13) each 500 ms.
4682
wdenk07d7e6b2004-12-16 21:44:03 +00004683 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00004684 This command will write 12345678 to address 100 all 10 ms.
4685
wdenk07d7e6b2004-12-16 21:44:03 +00004686 This only takes effect if the memory commands are activated
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004687 globally (CONFIG_CMD_MEM).
stroesecc3af832004-12-16 18:46:55 +00004688
wdenk3d3d99f2005-04-04 12:44:11 +00004689- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004690 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk302141d2010-11-27 23:30:56 +01004691 low level initializations (like setting up the memory
4692 controller) are omitted and/or U-Boot does not
4693 relocate itself into RAM.
wdenk3d3d99f2005-04-04 12:44:11 +00004694
Wolfgang Denk302141d2010-11-27 23:30:56 +01004695 Normally this variable MUST NOT be defined. The only
4696 exception is when U-Boot is loaded (to RAM) by some
4697 other boot loader or by a debugger which performs
4698 these initializations itself.
wdenk3d3d99f2005-04-04 12:44:11 +00004699
Aneesh V552a3192011-07-13 05:11:07 +00004700- CONFIG_SPL_BUILD
Magnus Lilja1ec96d82009-06-13 20:50:00 +02004701 Modifies the behaviour of start.S when compiling a loader
4702 that is executed before the actual U-Boot. E.g. when
4703 compiling a NAND SPL.
wdenk336b2bc2005-04-02 23:52:25 +00004704
Ying Zhang2d2e3b62013-08-16 15:16:15 +08004705- CONFIG_TPL_BUILD
4706 Modifies the behaviour of start.S when compiling a loader
4707 that is executed after the SPL and before the actual U-Boot.
4708 It is loaded by the SPL.
4709
Ying Zhang0d4f5442013-05-20 14:07:23 +08004710- CONFIG_SYS_MPC85XX_NO_RESETVEC
4711 Only for 85xx systems. If this variable is specified, the section
4712 .resetvec is not kept and the section .bootpg is placed in the
4713 previous 4k of the .text section.
4714
Simon Glass17dabf02013-02-24 17:33:14 +00004715- CONFIG_ARCH_MAP_SYSMEM
4716 Generally U-Boot (and in particular the md command) uses
4717 effective address. It is therefore not necessary to regard
4718 U-Boot address as virtual addresses that need to be translated
4719 to physical addresses. However, sandbox requires this, since
4720 it maintains its own little RAM buffer which contains all
4721 addressable memory. This option causes some memory accesses
4722 to be mapped through map_sysmem() / unmap_sysmem().
4723
Matthias Weisser93416c12011-03-10 21:36:32 +00004724- CONFIG_USE_ARCH_MEMCPY
4725 CONFIG_USE_ARCH_MEMSET
4726 If these options are used a optimized version of memcpy/memset will
4727 be used if available. These functions may be faster under some
4728 conditions but may increase the binary size.
4729
Simon Glassbfb59802013-02-14 04:18:54 +00004730- CONFIG_X86_RESET_VECTOR
4731 If defined, the x86 reset vector code is included. This is not
4732 needed when U-Boot is running from Coreboot.
Gabe Black14f82462012-11-27 21:08:06 +00004733
Mark Jackson52b003c2013-03-04 01:27:20 +00004734- CONFIG_SYS_MPUCLK
4735 Defines the MPU clock speed (in MHz).
4736
4737 NOTE : currently only supported on AM335x platforms.
Gabe Black76ce2492012-11-29 16:23:41 +00004738
Heiko Schocher2233e462013-11-04 14:05:00 +01004739- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
4740 Enables the RTC32K OSC on AM33xx based plattforms
4741
Karicheri, Muralidharanc1dc61b2014-04-04 13:16:50 -04004742- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
4743 Option to disable subpage write in NAND driver
4744 driver that uses this:
4745 drivers/mtd/nand/davinci_nand.c
4746
Timur Tabi275f4bb2011-11-22 09:21:25 -06004747Freescale QE/FMAN Firmware Support:
4748-----------------------------------
4749
4750The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4751loading of "firmware", which is encoded in the QE firmware binary format.
4752This firmware often needs to be loaded during U-Boot booting, so macros
4753are used to identify the storage device (NOR flash, SPI, etc) and the address
4754within that device.
4755
Zhao Qiang83a90842014-03-21 16:21:44 +08004756- CONFIG_SYS_FMAN_FW_ADDR
4757 The address in the storage device where the FMAN microcode is located. The
4758 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4759 is also specified.
4760
4761- CONFIG_SYS_QE_FW_ADDR
4762 The address in the storage device where the QE microcode is located. The
Timur Tabi275f4bb2011-11-22 09:21:25 -06004763 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4764 is also specified.
4765
4766- CONFIG_SYS_QE_FMAN_FW_LENGTH
4767 The maximum possible size of the firmware. The firmware binary format
4768 has a field that specifies the actual size of the firmware, but it
4769 might not be possible to read any part of the firmware unless some
4770 local storage is allocated to hold the entire firmware first.
4771
4772- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4773 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4774 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
4775 virtual address in NOR flash.
4776
4777- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4778 Specifies that QE/FMAN firmware is located in NAND flash.
4779 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4780
4781- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4782 Specifies that QE/FMAN firmware is located on the primary SD/MMC
4783 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4784
4785- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
4786 Specifies that QE/FMAN firmware is located on the primary SPI
4787 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4788
Liu Gang1e084582012-03-08 00:33:18 +00004789- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4790 Specifies that QE/FMAN firmware is located in the remote (master)
4791 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gang357bf5a2012-08-09 05:10:01 +00004792 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4793 window->master inbound window->master LAW->the ucode address in
4794 master's memory space.
Timur Tabi275f4bb2011-11-22 09:21:25 -06004795
J. German Rivera8ff14b72014-06-23 15:15:55 -07004796Freescale Layerscape Management Complex Firmware Support:
4797---------------------------------------------------------
4798The Freescale Layerscape Management Complex (MC) supports the loading of
4799"firmware".
4800This firmware often needs to be loaded during U-Boot booting, so macros
4801are used to identify the storage device (NOR flash, SPI, etc) and the address
4802within that device.
4803
4804- CONFIG_FSL_MC_ENET
4805 Enable the MC driver for Layerscape SoCs.
4806
4807- CONFIG_SYS_LS_MC_FW_ADDR
4808 The address in the storage device where the firmware is located. The
4809 meaning of this address depends on which CONFIG_SYS_LS_MC_FW_IN_xxx macro
4810 is also specified.
4811
4812- CONFIG_SYS_LS_MC_FW_LENGTH
4813 The maximum possible size of the firmware. The firmware binary format
4814 has a field that specifies the actual size of the firmware, but it
4815 might not be possible to read any part of the firmware unless some
4816 local storage is allocated to hold the entire firmware first.
4817
4818- CONFIG_SYS_LS_MC_FW_IN_NOR
4819 Specifies that MC firmware is located in NOR flash, mapped as
4820 normal addressable memory via the LBC. CONFIG_SYS_LS_MC_FW_ADDR is the
4821 virtual address in NOR flash.
4822
wdenkc6097192002-11-03 00:24:07 +00004823Building the Software:
4824======================
4825
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004826Building U-Boot has been tested in several native build environments
4827and in many different cross environments. Of course we cannot support
4828all possibly existing versions of cross development tools in all
4829(potentially obsolete) versions. In case of tool chain problems we
4830recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4831which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004832
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004833If you are not using a native environment, it is assumed that you
4834have GNU cross compiling tools available in your path. In this case,
4835you must set the environment variable CROSS_COMPILE in your shell.
4836Note that no changes to the Makefile or any other source files are
4837necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00004838
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004839 $ CROSS_COMPILE=ppc_4xx-
4840 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00004841
Peter Tyserb06976d2009-03-13 18:54:51 -05004842Note: If you wish to generate Windows versions of the utilities in
4843 the tools directory you can use the MinGW toolchain
4844 (http://www.mingw.org). Set your HOST tools to the MinGW
4845 toolchain and execute 'make tools'. For example:
4846
4847 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
4848
4849 Binaries such as tools/mkimage.exe will be created which can
4850 be executed on computers running Windows.
4851
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004852U-Boot is intended to be simple to build. After installing the
4853sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00004854is done by typing:
4855
Holger Freyther7ba4e572014-08-04 09:26:05 +02004856 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00004857
Holger Freyther7ba4e572014-08-04 09:26:05 +02004858where "NAME_defconfig" is the name of one of the existing configu-
Michael Jones5a7fb6f2012-03-15 22:48:10 +00004859rations; see boards.cfg for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00004860
wdenk6c59edc2004-05-03 20:45:30 +00004861Note: for some board special configuration names may exist; check if
4862 additional information is available from the board vendor; for
4863 instance, the TQM823L systems are available without (standard)
4864 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004865 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00004866
Holger Freyther7ba4e572014-08-04 09:26:05 +02004867 make TQM823L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00004868 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00004869
Holger Freyther7ba4e572014-08-04 09:26:05 +02004870 make TQM823L_LCD_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00004871 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00004872
wdenk6c59edc2004-05-03 20:45:30 +00004873 etc.
wdenkc6097192002-11-03 00:24:07 +00004874
wdenkc6097192002-11-03 00:24:07 +00004875
wdenk6c59edc2004-05-03 20:45:30 +00004876Finally, type "make all", and you should get some working U-Boot
4877images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00004878
wdenk6c59edc2004-05-03 20:45:30 +00004879- "u-boot.bin" is a raw binary image
4880- "u-boot" is an image in ELF binary format
4881- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00004882
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004883By default the build is performed locally and the objects are saved
4884in the source directory. One of the two methods can be used to change
4885this behavior and build U-Boot to some external directory:
4886
48871. Add O= to the make command line invocations:
4888
4889 make O=/tmp/build distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02004890 make O=/tmp/build NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004891 make O=/tmp/build all
4892
48932. Set environment variable BUILD_DIR to point to the desired location:
4894
4895 export BUILD_DIR=/tmp/build
4896 make distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02004897 make NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004898 make all
4899
4900Note that the command line "O=" setting overrides the BUILD_DIR environment
4901variable.
4902
wdenkc6097192002-11-03 00:24:07 +00004903
wdenk6c59edc2004-05-03 20:45:30 +00004904Please be aware that the Makefiles assume you are using GNU make, so
4905for instance on NetBSD you might need to use "gmake" instead of
4906native "make".
wdenkc6097192002-11-03 00:24:07 +00004907
wdenkc6097192002-11-03 00:24:07 +00004908
wdenk6c59edc2004-05-03 20:45:30 +00004909If the system board that you have is not listed, then you will need
4910to port U-Boot to your hardware platform. To do this, follow these
4911steps:
wdenkc6097192002-11-03 00:24:07 +00004912
wdenk6c59edc2004-05-03 20:45:30 +000049131. Add a new configuration option for your board to the toplevel
Michael Jones5a7fb6f2012-03-15 22:48:10 +00004914 "boards.cfg" file, using the existing entries as examples.
4915 Follow the instructions there to keep the boards in order.
wdenk6c59edc2004-05-03 20:45:30 +000049162. Create a new directory to hold your board specific code. Add any
4917 files you need. In your board directory, you will need at least
4918 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
49193. Create a new configuration file "include/configs/<board>.h" for
4920 your board
49213. If you're porting U-Boot to a new CPU, then also create a new
4922 directory to hold your CPU specific code. Add any files you need.
Holger Freyther7ba4e572014-08-04 09:26:05 +020049234. Run "make <board>_defconfig" with your new name.
wdenk6c59edc2004-05-03 20:45:30 +000049245. Type "make", and you should get a working "u-boot.srec" file
4925 to be installed on your target system.
49266. Debug and solve any problems that might arise.
4927 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00004928
wdenkc6097192002-11-03 00:24:07 +00004929
wdenk6c59edc2004-05-03 20:45:30 +00004930Testing of U-Boot Modifications, Ports to New Hardware, etc.:
4931==============================================================
wdenkc6097192002-11-03 00:24:07 +00004932
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004933If you have modified U-Boot sources (for instance added a new board
4934or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00004935provide feedback to the other developers. The feedback normally takes
4936the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004937official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00004938
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004939But before you submit such a patch, please verify that your modifi-
4940cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00004941the supported boards compile WITHOUT ANY compiler warnings. To do so,
4942just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004943for ALL supported system. Be warned, this will take a while. You can
4944select which (cross) compiler to use by passing a `CROSS_COMPILE'
4945environment variable to the script, i. e. to use the ELDK cross tools
4946you can type
wdenkc6097192002-11-03 00:24:07 +00004947
wdenk6c59edc2004-05-03 20:45:30 +00004948 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00004949
wdenk6c59edc2004-05-03 20:45:30 +00004950or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00004951
wdenk6c59edc2004-05-03 20:45:30 +00004952 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00004953
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004954When using the MAKEALL script, the default behaviour is to build
4955U-Boot in the source directory. This location can be changed by
4956setting the BUILD_DIR environment variable. Also, for each target
4957built, the MAKEALL script saves two log files (<target>.ERR and
4958<target>.MAKEALL) in the <source dir>/LOG directory. This default
4959location can be changed by setting the MAKEALL_LOGDIR environment
4960variable. For example:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004961
4962 export BUILD_DIR=/tmp/build
4963 export MAKEALL_LOGDIR=/tmp/log
4964 CROSS_COMPILE=ppc_8xx- MAKEALL
4965
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004966With the above settings build objects are saved in the /tmp/build,
4967log files are saved in the /tmp/log and the source tree remains clean
4968during the whole build process.
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004969
4970
wdenk6c59edc2004-05-03 20:45:30 +00004971See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00004972
wdenkc6097192002-11-03 00:24:07 +00004973
wdenk6c59edc2004-05-03 20:45:30 +00004974Monitor Commands - Overview:
4975============================
wdenkc6097192002-11-03 00:24:07 +00004976
wdenk6c59edc2004-05-03 20:45:30 +00004977go - start application at address 'addr'
4978run - run commands in an environment variable
4979bootm - boot application image from memory
4980bootp - boot image via network using BootP/TFTP protocol
Marek Vasutcf41a9b2012-03-14 21:52:45 +00004981bootz - boot zImage from memory
wdenk6c59edc2004-05-03 20:45:30 +00004982tftpboot- boot image via network using TFTP protocol
4983 and env variables "ipaddr" and "serverip"
4984 (and eventually "gatewayip")
Simon Glass6a398d22011-10-24 18:00:07 +00004985tftpput - upload a file via network using TFTP protocol
wdenk6c59edc2004-05-03 20:45:30 +00004986rarpboot- boot image via network using RARP/TFTP protocol
4987diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
4988loads - load S-Record file over serial line
4989loadb - load binary file over serial line (kermit mode)
4990md - memory display
4991mm - memory modify (auto-incrementing)
4992nm - memory modify (constant address)
4993mw - memory write (fill)
4994cp - memory copy
4995cmp - memory compare
4996crc32 - checksum calculation
Peter Tyser469cde42009-04-18 22:34:03 -05004997i2c - I2C sub-system
wdenk6c59edc2004-05-03 20:45:30 +00004998sspi - SPI utility commands
4999base - print or set address offset
5000printenv- print environment variables
5001setenv - set environment variables
5002saveenv - save environment variables to persistent storage
5003protect - enable or disable FLASH write protection
5004erase - erase FLASH memory
5005flinfo - print FLASH memory information
Karl O. Pinc4baf03d2012-08-03 05:57:21 +00005006nand - NAND memory operations (see doc/README.nand)
wdenk6c59edc2004-05-03 20:45:30 +00005007bdinfo - print Board Info structure
5008iminfo - print header information for application image
5009coninfo - print console devices and informations
5010ide - IDE sub-system
5011loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00005012loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00005013mtest - simple RAM test
5014icache - enable or disable instruction cache
5015dcache - enable or disable data cache
5016reset - Perform RESET of the CPU
5017echo - echo args to console
5018version - print monitor version
5019help - print online help
5020? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00005021
wdenkc6097192002-11-03 00:24:07 +00005022
wdenk6c59edc2004-05-03 20:45:30 +00005023Monitor Commands - Detailed Description:
5024========================================
wdenkc6097192002-11-03 00:24:07 +00005025
wdenk6c59edc2004-05-03 20:45:30 +00005026TODO.
wdenkc6097192002-11-03 00:24:07 +00005027
wdenk6c59edc2004-05-03 20:45:30 +00005028For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00005029
5030
wdenk6c59edc2004-05-03 20:45:30 +00005031Environment Variables:
5032======================
wdenkc6097192002-11-03 00:24:07 +00005033
wdenk6c59edc2004-05-03 20:45:30 +00005034U-Boot supports user configuration using Environment Variables which
5035can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00005036
wdenk6c59edc2004-05-03 20:45:30 +00005037Environment Variables are set using "setenv", printed using
5038"printenv", and saved to Flash using "saveenv". Using "setenv"
5039without a value can be used to delete a variable from the
5040environment. As long as you don't save the environment you are
5041working with an in-memory copy. In case the Flash area containing the
5042environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00005043
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005044Some configuration options can be set using Environment Variables.
5045
5046List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00005047
wdenk6c59edc2004-05-03 20:45:30 +00005048 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00005049
wdenk6c59edc2004-05-03 20:45:30 +00005050 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00005051
wdenk6c59edc2004-05-03 20:45:30 +00005052 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00005053
wdenk6c59edc2004-05-03 20:45:30 +00005054 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00005055
wdenk6c59edc2004-05-03 20:45:30 +00005056 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00005057
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02005058 bootm_low - Memory range available for image processing in the bootm
5059 command can be restricted. This variable is given as
5060 a hexadecimal number and defines lowest address allowed
5061 for use by the bootm command. See also "bootm_size"
5062 environment variable. Address defined by "bootm_low" is
5063 also the base of the initial memory mapping for the Linux
Grant Likely26396382011-03-28 09:58:43 +00005064 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
5065 bootm_mapsize.
5066
Wolfgang Denk092ae952011-10-26 10:21:21 +00005067 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likely26396382011-03-28 09:58:43 +00005068 This variable is given as a hexadecimal number and it
5069 defines the size of the memory region starting at base
5070 address bootm_low that is accessible by the Linux kernel
5071 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
5072 as the default value if it is defined, and bootm_size is
5073 used otherwise.
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02005074
5075 bootm_size - Memory range available for image processing in the bootm
5076 command can be restricted. This variable is given as
5077 a hexadecimal number and defines the size of the region
5078 allowed for use by the bootm command. See also "bootm_low"
5079 environment variable.
5080
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02005081 updatefile - Location of the software update file on a TFTP server, used
5082 by the automatic software update feature. Please refer to
5083 documentation in doc/README.update for more details.
5084
wdenk6c59edc2004-05-03 20:45:30 +00005085 autoload - if set to "no" (any string beginning with 'n'),
5086 "bootp" will just load perform a lookup of the
5087 configuration from the BOOTP server, but not try to
5088 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00005089
wdenk6c59edc2004-05-03 20:45:30 +00005090 autostart - if set to "yes", an image loaded using the "bootp",
5091 "rarpboot", "tftpboot" or "diskboot" commands will
5092 be automatically started (by internally calling
5093 "bootm")
wdenkc6097192002-11-03 00:24:07 +00005094
wdenk6c59edc2004-05-03 20:45:30 +00005095 If set to "no", a standalone image passed to the
5096 "bootm" command will be copied to the load address
5097 (and eventually uncompressed), but NOT be started.
5098 This can be used to load and uncompress arbitrary
5099 data.
wdenkc6097192002-11-03 00:24:07 +00005100
David A. Longd558a4e2011-07-09 16:40:19 -04005101 fdt_high - if set this restricts the maximum address that the
5102 flattened device tree will be copied into upon boot.
Shawn Guo0ca9e982012-01-09 21:54:08 +00005103 For example, if you have a system with 1 GB memory
5104 at physical address 0x10000000, while Linux kernel
5105 only recognizes the first 704 MB as low memory, you
5106 may need to set fdt_high as 0x3C000000 to have the
5107 device tree blob be copied to the maximum address
5108 of the 704 MB low memory, so that Linux kernel can
5109 access it during the boot procedure.
5110
David A. Longd558a4e2011-07-09 16:40:19 -04005111 If this is set to the special value 0xFFFFFFFF then
5112 the fdt will not be copied at all on boot. For this
5113 to work it must reside in writable memory, have
5114 sufficient padding on the end of it for u-boot to
5115 add the information it needs into it, and the memory
5116 must be accessible by the kernel.
5117
Simon Glassdc6fa642011-10-24 19:15:34 +00005118 fdtcontroladdr- if set this is the address of the control flattened
5119 device tree used by U-Boot when CONFIG_OF_CONTROL is
5120 defined.
5121
wdenk0e2bd9c2004-06-06 21:51:03 +00005122 i2cfast - (PPC405GP|PPC405EP only)
5123 if set to 'y' configures Linux I2C driver for fast
5124 mode (400kHZ). This environment variable is used in
5125 initialization code. So, for changes to be effective
5126 it must be saved and board must be reset.
5127
wdenk6c59edc2004-05-03 20:45:30 +00005128 initrd_high - restrict positioning of initrd images:
5129 If this variable is not set, initrd images will be
5130 copied to the highest possible address in RAM; this
5131 is usually what you want since it allows for
5132 maximum initrd size. If for some reason you want to
5133 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005134 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk6c59edc2004-05-03 20:45:30 +00005135 variable to a value of "no" or "off" or "0".
5136 Alternatively, you can set it to a maximum upper
5137 address to use (U-Boot will still check that it
5138 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00005139
wdenk6c59edc2004-05-03 20:45:30 +00005140 For instance, when you have a system with 16 MB
5141 RAM, and want to reserve 4 MB from use by Linux,
5142 you can do this by adding "mem=12M" to the value of
5143 the "bootargs" variable. However, now you must make
5144 sure that the initrd image is placed in the first
5145 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00005146
wdenk6c59edc2004-05-03 20:45:30 +00005147 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00005148
wdenk6c59edc2004-05-03 20:45:30 +00005149 If you set initrd_high to 0xFFFFFFFF, this is an
5150 indication to U-Boot that all addresses are legal
5151 for the Linux kernel, including addresses in flash
5152 memory. In this case U-Boot will NOT COPY the
5153 ramdisk at all. This may be useful to reduce the
5154 boot time on your system, but requires that this
5155 feature is supported by your Linux kernel.
wdenk3f9ab982003-04-12 23:38:12 +00005156
wdenk6c59edc2004-05-03 20:45:30 +00005157 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00005158
wdenk6c59edc2004-05-03 20:45:30 +00005159 loadaddr - Default load address for commands like "bootp",
5160 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00005161
wdenk6c59edc2004-05-03 20:45:30 +00005162 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00005163
wdenk6c59edc2004-05-03 20:45:30 +00005164 serverip - TFTP server IP address; needed for tftpboot command
wdenk6f770ed2003-05-23 23:18:21 +00005165
wdenk6c59edc2004-05-03 20:45:30 +00005166 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00005167
wdenk6c59edc2004-05-03 20:45:30 +00005168 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00005169
wdenk6c59edc2004-05-03 20:45:30 +00005170 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00005171
Mike Frysingera23230c2011-10-02 10:01:27 +00005172 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00005173
Mike Frysingera23230c2011-10-02 10:01:27 +00005174 ethact - controls which interface is currently active.
5175 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00005176
Heiko Schocherc5e84052010-07-20 17:45:02 +02005177 => setenv ethact FEC
5178 => ping 192.168.0.1 # traffic sent on FEC
5179 => setenv ethact SCC
5180 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00005181
Matthias Fuchs204f0ec2008-01-17 07:45:05 +01005182 ethrotate - When set to "no" U-Boot does not go through all
5183 available network interfaces.
5184 It just stays at the currently selected interface.
5185
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005186 netretry - When set to "no" each network operation will
wdenk6c59edc2004-05-03 20:45:30 +00005187 either succeed or fail without retrying.
5188 When set to "once" the network operation will
5189 fail when all the available network interfaces
5190 are tried once without success.
5191 Useful on scripts which control the retry operation
5192 themselves.
wdenkc6097192002-11-03 00:24:07 +00005193
Jean-Christophe PLAGNIOL-VILLARD1948d6c2009-01-31 09:53:39 +01005194 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDd2164ef2008-01-07 08:41:34 +01005195
Simon Glass5db3f932013-07-16 20:10:00 -07005196 silent_linux - If set then linux will be told to boot silently, by
5197 changing the console to be empty. If "yes" it will be
5198 made silent. If "no" it will not be made silent. If
5199 unset, then it will be made silent if the U-Boot console
5200 is silent.
5201
Wolfgang Denk227b5192005-09-24 23:25:46 +02005202 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denke3cfce52005-09-24 22:37:32 +02005203 UDP source port.
5204
Wolfgang Denk227b5192005-09-24 23:25:46 +02005205 tftpdstport - If this is set, the value is used for TFTP's UDP
5206 destination port instead of the Well Know Port 69.
5207
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005208 tftpblocksize - Block size to use for TFTP transfers; if not set,
5209 we use the TFTP server's default block size
5210
5211 tftptimeout - Retransmission timeout for TFTP packets (in milli-
5212 seconds, minimum value is 1000 = 1 second). Defines
5213 when a packet is considered to be lost so it has to
5214 be retransmitted. The default is 5000 = 5 seconds.
5215 Lowering this value may make downloads succeed
5216 faster in networks with high packet loss rates or
5217 with unreliable TFTP servers.
5218
5219 vlan - When set to a value < 4095 the traffic over
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005220 Ethernet is encapsulated/received over 802.1q
wdenk6c59edc2004-05-03 20:45:30 +00005221 VLAN tagged frames.
wdenk145d2c12004-04-15 21:48:45 +00005222
Jason Hobbse3fe08e2011-08-31 05:37:28 +00005223The following image location variables contain the location of images
5224used in booting. The "Image" column gives the role of the image and is
5225not an environment variable name. The other columns are environment
5226variable names. "File Name" gives the name of the file on a TFTP
5227server, "RAM Address" gives the location in RAM the image will be
5228loaded to, and "Flash Location" gives the image's address in NOR
5229flash or offset in NAND flash.
5230
5231*Note* - these variables don't have to be defined for all boards, some
5232boards currenlty use other variables for these purposes, and some
5233boards use these variables for other purposes.
5234
Wolfgang Denk092ae952011-10-26 10:21:21 +00005235Image File Name RAM Address Flash Location
5236----- --------- ----------- --------------
5237u-boot u-boot u-boot_addr_r u-boot_addr
5238Linux kernel bootfile kernel_addr_r kernel_addr
5239device tree blob fdtfile fdt_addr_r fdt_addr
5240ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbse3fe08e2011-08-31 05:37:28 +00005241
wdenk6c59edc2004-05-03 20:45:30 +00005242The following environment variables may be used and automatically
5243updated by the network boot commands ("bootp" and "rarpboot"),
5244depending the information provided by your boot server:
wdenk145d2c12004-04-15 21:48:45 +00005245
wdenk6c59edc2004-05-03 20:45:30 +00005246 bootfile - see above
5247 dnsip - IP address of your Domain Name Server
5248 dnsip2 - IP address of your secondary Domain Name Server
5249 gatewayip - IP address of the Gateway (Router) to use
5250 hostname - Target hostname
5251 ipaddr - see above
5252 netmask - Subnet Mask
5253 rootpath - Pathname of the root filesystem on the NFS server
5254 serverip - see above
wdenk145d2c12004-04-15 21:48:45 +00005255
wdenk145d2c12004-04-15 21:48:45 +00005256
wdenk6c59edc2004-05-03 20:45:30 +00005257There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005258
wdenk6c59edc2004-05-03 20:45:30 +00005259 serial# - contains hardware identification information such
5260 as type string and/or serial number
5261 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00005262
wdenk6c59edc2004-05-03 20:45:30 +00005263These variables can be set only once (usually during manufacturing of
5264the board). U-Boot refuses to delete or overwrite these variables
5265once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00005266
5267
wdenk6c59edc2004-05-03 20:45:30 +00005268Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005269
wdenk6c59edc2004-05-03 20:45:30 +00005270 ver - Contains the U-Boot version string as printed
5271 with the "version" command. This variable is
5272 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00005273
wdenkc6097192002-11-03 00:24:07 +00005274
wdenk6c59edc2004-05-03 20:45:30 +00005275Please note that changes to some configuration parameters may take
5276only effect after the next boot (yes, that's just like Windoze :-).
stroeseb9c17c52003-04-04 15:53:41 +00005277
stroeseb9c17c52003-04-04 15:53:41 +00005278
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005279Callback functions for environment variables:
5280---------------------------------------------
5281
5282For some environment variables, the behavior of u-boot needs to change
5283when their values are changed. This functionailty allows functions to
5284be associated with arbitrary variables. On creation, overwrite, or
5285deletion, the callback will provide the opportunity for some side
5286effect to happen or for the change to be rejected.
5287
5288The callbacks are named and associated with a function using the
5289U_BOOT_ENV_CALLBACK macro in your board or driver code.
5290
5291These callbacks are associated with variables in one of two ways. The
5292static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5293in the board configuration to a string that defines a list of
5294associations. The list must be in the following format:
5295
5296 entry = variable_name[:callback_name]
5297 list = entry[,list]
5298
5299If the callback name is not specified, then the callback is deleted.
5300Spaces are also allowed anywhere in the list.
5301
5302Callbacks can also be associated by defining the ".callbacks" variable
5303with the same list format above. Any association in ".callbacks" will
5304override any association in the static list. You can define
5305CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
5306".callbacks" envirnoment variable in the default or embedded environment.
5307
5308
wdenk6c59edc2004-05-03 20:45:30 +00005309Command Line Parsing:
5310=====================
stroeseb9c17c52003-04-04 15:53:41 +00005311
wdenk6c59edc2004-05-03 20:45:30 +00005312There are two different command line parsers available with U-Boot:
5313the old "simple" one, and the much more powerful "hush" shell:
wdenkc6097192002-11-03 00:24:07 +00005314
wdenk6c59edc2004-05-03 20:45:30 +00005315Old, simple command line parser:
5316--------------------------------
wdenkc6097192002-11-03 00:24:07 +00005317
wdenk6c59edc2004-05-03 20:45:30 +00005318- supports environment variables (through setenv / saveenv commands)
5319- several commands on one line, separated by ';'
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01005320- variable substitution using "... ${name} ..." syntax
wdenk6c59edc2004-05-03 20:45:30 +00005321- special characters ('$', ';') can be escaped by prefixing with '\',
5322 for example:
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01005323 setenv bootcmd bootm \${address}
wdenk6c59edc2004-05-03 20:45:30 +00005324- You can also escape text by enclosing in single apostrophes, for example:
5325 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00005326
wdenk6c59edc2004-05-03 20:45:30 +00005327Hush shell:
5328-----------
wdenkf4688a22003-05-28 08:06:31 +00005329
wdenk6c59edc2004-05-03 20:45:30 +00005330- similar to Bourne shell, with control structures like
5331 if...then...else...fi, for...do...done; while...do...done,
5332 until...do...done, ...
5333- supports environment ("global") variables (through setenv / saveenv
5334 commands) and local shell variables (through standard shell syntax
5335 "name=value"); only environment variables can be used with "run"
5336 command
wdenkf4688a22003-05-28 08:06:31 +00005337
wdenk6c59edc2004-05-03 20:45:30 +00005338General rules:
5339--------------
wdenkf4688a22003-05-28 08:06:31 +00005340
wdenk6c59edc2004-05-03 20:45:30 +00005341(1) If a command line (or an environment variable executed by a "run"
5342 command) contains several commands separated by semicolon, and
5343 one of these commands fails, then the remaining commands will be
5344 executed anyway.
wdenkf4688a22003-05-28 08:06:31 +00005345
wdenk6c59edc2004-05-03 20:45:30 +00005346(2) If you execute several variables with one call to run (i. e.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005347 calling run with a list of variables as arguments), any failing
wdenk6c59edc2004-05-03 20:45:30 +00005348 command will cause "run" to terminate, i. e. the remaining
5349 variables are not executed.
wdenkf4688a22003-05-28 08:06:31 +00005350
wdenk6c59edc2004-05-03 20:45:30 +00005351Note for Redundant Ethernet Interfaces:
5352=======================================
wdenkf4688a22003-05-28 08:06:31 +00005353
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005354Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00005355such configurations and is capable of automatic selection of a
5356"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00005357
wdenk6c59edc2004-05-03 20:45:30 +00005358Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
5359MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5360"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00005361
wdenk6c59edc2004-05-03 20:45:30 +00005362If the network interface stores some valid MAC address (for instance
5363in SROM), this is used as default address if there is NO correspon-
5364ding setting in the environment; if the corresponding environment
5365variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00005366
wdenk6c59edc2004-05-03 20:45:30 +00005367o If the SROM has a valid MAC address, and there is no address in the
5368 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00005369
wdenk6c59edc2004-05-03 20:45:30 +00005370o If there is no valid address in the SROM, and a definition in the
5371 environment exists, then the value from the environment variable is
5372 used.
wdenkc6097192002-11-03 00:24:07 +00005373
wdenk6c59edc2004-05-03 20:45:30 +00005374o If both the SROM and the environment contain a MAC address, and
5375 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00005376
wdenk6c59edc2004-05-03 20:45:30 +00005377o If both the SROM and the environment contain a MAC address, and the
5378 addresses differ, the value from the environment is used and a
5379 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00005380
wdenk6c59edc2004-05-03 20:45:30 +00005381o If neither SROM nor the environment contain a MAC address, an error
5382 is raised.
wdenkc6097192002-11-03 00:24:07 +00005383
Ben Warren6db991a2010-04-26 11:11:46 -07005384If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denk092ae952011-10-26 10:21:21 +00005385will be programmed into hardware as part of the initialization process. This
Ben Warren6db991a2010-04-26 11:11:46 -07005386may be skipped by setting the appropriate 'ethmacskip' environment variable.
5387The naming convention is as follows:
5388"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00005389
wdenk6c59edc2004-05-03 20:45:30 +00005390Image Formats:
5391==============
wdenkc6097192002-11-03 00:24:07 +00005392
Marian Balakowicz18710b82008-03-12 12:13:13 +01005393U-Boot is capable of booting (and performing other auxiliary operations on)
5394images in two formats:
5395
5396New uImage format (FIT)
5397-----------------------
5398
5399Flexible and powerful format based on Flattened Image Tree -- FIT (similar
5400to Flattened Device Tree). It allows the use of images with multiple
5401components (several kernels, ramdisks, etc.), with contents protected by
5402SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
5403
5404
5405Old uImage format
5406-----------------
5407
5408Old image format is based on binary files which can be basically anything,
5409preceded by a special header; see the definitions in include/image.h for
5410details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00005411
wdenk6c59edc2004-05-03 20:45:30 +00005412* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5413 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05005414 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5415 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5416 INTEGRITY).
Wolfgang Denk83c15852006-10-24 14:21:16 +02005417* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Lin1cac36e2011-10-19 20:41:11 +00005418 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5419 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00005420* Compression Type (uncompressed, gzip, bzip2)
5421* Load Address
5422* Entry Point
5423* Image Name
5424* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00005425
wdenk6c59edc2004-05-03 20:45:30 +00005426The header is marked by a special Magic Number, and both the header
5427and the data portions of the image are secured against corruption by
5428CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00005429
wdenkc6097192002-11-03 00:24:07 +00005430
wdenk6c59edc2004-05-03 20:45:30 +00005431Linux Support:
5432==============
wdenkc6097192002-11-03 00:24:07 +00005433
wdenk6c59edc2004-05-03 20:45:30 +00005434Although U-Boot should support any OS or standalone application
5435easily, the main focus has always been on Linux during the design of
5436U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005437
wdenk6c59edc2004-05-03 20:45:30 +00005438U-Boot includes many features that so far have been part of some
5439special "boot loader" code within the Linux kernel. Also, any
5440"initrd" images to be used are no longer part of one big Linux image;
5441instead, kernel and "initrd" are separate images. This implementation
5442serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00005443
wdenk6c59edc2004-05-03 20:45:30 +00005444- the same features can be used for other OS or standalone
5445 applications (for instance: using compressed images to reduce the
5446 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00005447
wdenk6c59edc2004-05-03 20:45:30 +00005448- it becomes much easier to port new Linux kernel versions because
5449 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00005450
wdenk6c59edc2004-05-03 20:45:30 +00005451- the same Linux kernel image can now be used with different "initrd"
5452 images; of course this also means that different kernel images can
5453 be run with the same "initrd". This makes testing easier (you don't
5454 have to build a new "zImage.initrd" Linux image when you just
5455 change a file in your "initrd"). Also, a field-upgrade of the
5456 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00005457
wdenkc6097192002-11-03 00:24:07 +00005458
wdenk6c59edc2004-05-03 20:45:30 +00005459Linux HOWTO:
5460============
wdenkc6097192002-11-03 00:24:07 +00005461
wdenk6c59edc2004-05-03 20:45:30 +00005462Porting Linux to U-Boot based systems:
5463---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00005464
wdenk6c59edc2004-05-03 20:45:30 +00005465U-Boot cannot save you from doing all the necessary modifications to
5466configure the Linux device drivers for use with your target hardware
5467(no, we don't intend to provide a full virtual machine interface to
5468Linux :-).
wdenkc6097192002-11-03 00:24:07 +00005469
Stefan Roese88fbf932010-04-15 16:07:28 +02005470But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00005471
wdenk6c59edc2004-05-03 20:45:30 +00005472Just make sure your machine specific header file (for instance
5473include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02005474Information structure as we define in include/asm-<arch>/u-boot.h,
5475and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005476as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00005477
Simon Glassd097e592014-06-11 23:29:46 -06005478Note that U-Boot now has a driver model, a unified model for drivers.
5479If you are adding a new driver, plumb it into driver model. If there
5480is no uclass available, you are encouraged to create one. See
5481doc/driver-model.
5482
wdenkc6097192002-11-03 00:24:07 +00005483
wdenk6c59edc2004-05-03 20:45:30 +00005484Configuring the Linux kernel:
5485-----------------------------
wdenkc6097192002-11-03 00:24:07 +00005486
wdenk6c59edc2004-05-03 20:45:30 +00005487No specific requirements for U-Boot. Make sure you have some root
5488device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00005489
wdenkc6097192002-11-03 00:24:07 +00005490
wdenk6c59edc2004-05-03 20:45:30 +00005491Building a Linux Image:
5492-----------------------
wdenkc6097192002-11-03 00:24:07 +00005493
wdenk6c59edc2004-05-03 20:45:30 +00005494With U-Boot, "normal" build targets like "zImage" or "bzImage" are
5495not used. If you use recent kernel source, a new build target
5496"uImage" will exist which automatically builds an image usable by
5497U-Boot. Most older kernels also have support for a "pImage" target,
5498which was introduced for our predecessor project PPCBoot and uses a
5499100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00005500
wdenk6c59edc2004-05-03 20:45:30 +00005501Example:
wdenkc6097192002-11-03 00:24:07 +00005502
Holger Freyther7ba4e572014-08-04 09:26:05 +02005503 make TQM850L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00005504 make oldconfig
5505 make dep
5506 make uImage
wdenkc6097192002-11-03 00:24:07 +00005507
wdenk6c59edc2004-05-03 20:45:30 +00005508The "uImage" build target uses a special tool (in 'tools/mkimage') to
5509encapsulate a compressed Linux kernel image with header information,
5510CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00005511
wdenk6c59edc2004-05-03 20:45:30 +00005512* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00005513
wdenk6c59edc2004-05-03 20:45:30 +00005514* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00005515
wdenk6c59edc2004-05-03 20:45:30 +00005516 ${CROSS_COMPILE}-objcopy -O binary \
5517 -R .note -R .comment \
5518 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00005519
wdenk6c59edc2004-05-03 20:45:30 +00005520* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00005521
wdenk6c59edc2004-05-03 20:45:30 +00005522 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00005523
wdenk6c59edc2004-05-03 20:45:30 +00005524* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00005525
wdenk6c59edc2004-05-03 20:45:30 +00005526 mkimage -A ppc -O linux -T kernel -C gzip \
5527 -a 0 -e 0 -n "Linux Kernel Image" \
5528 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00005529
wdenkc6097192002-11-03 00:24:07 +00005530
wdenk6c59edc2004-05-03 20:45:30 +00005531The "mkimage" tool can also be used to create ramdisk images for use
5532with U-Boot, either separated from the Linux kernel image, or
5533combined into one file. "mkimage" encapsulates the images with a 64
5534byte header containing information about target architecture,
5535operating system, image type, compression method, entry points, time
5536stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00005537
wdenk6c59edc2004-05-03 20:45:30 +00005538"mkimage" can be called in two ways: to verify existing images and
5539print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00005540
wdenk6c59edc2004-05-03 20:45:30 +00005541In the first form (with "-l" option) mkimage lists the information
5542contained in the header of an existing U-Boot image; this includes
5543checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00005544
wdenk6c59edc2004-05-03 20:45:30 +00005545 tools/mkimage -l image
5546 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00005547
wdenk6c59edc2004-05-03 20:45:30 +00005548The second form (with "-d" option) is used to build a U-Boot image
5549from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00005550
wdenk6c59edc2004-05-03 20:45:30 +00005551 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5552 -n name -d data_file image
5553 -A ==> set architecture to 'arch'
5554 -O ==> set operating system to 'os'
5555 -T ==> set image type to 'type'
5556 -C ==> set compression type 'comp'
5557 -a ==> set load address to 'addr' (hex)
5558 -e ==> set entry point to 'ep' (hex)
5559 -n ==> set image name to 'name'
5560 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00005561
wdenkcd914452004-05-29 16:53:29 +00005562Right now, all Linux kernels for PowerPC systems use the same load
5563address (0x00000000), but the entry point address depends on the
5564kernel version:
wdenkc6097192002-11-03 00:24:07 +00005565
wdenk6c59edc2004-05-03 20:45:30 +00005566- 2.2.x kernels have the entry point at 0x0000000C,
5567- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00005568
wdenk6c59edc2004-05-03 20:45:30 +00005569So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00005570
wdenk6c59edc2004-05-03 20:45:30 +00005571 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5572 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005573 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk6c59edc2004-05-03 20:45:30 +00005574 > examples/uImage.TQM850L
5575 Image Name: 2.4.4 kernel for TQM850L
5576 Created: Wed Jul 19 02:34:59 2000
5577 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5578 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5579 Load Address: 0x00000000
5580 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005581
wdenk6c59edc2004-05-03 20:45:30 +00005582To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00005583
wdenk6c59edc2004-05-03 20:45:30 +00005584 -> tools/mkimage -l examples/uImage.TQM850L
5585 Image Name: 2.4.4 kernel for TQM850L
5586 Created: Wed Jul 19 02:34:59 2000
5587 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5588 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5589 Load Address: 0x00000000
5590 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005591
wdenk6c59edc2004-05-03 20:45:30 +00005592NOTE: for embedded systems where boot time is critical you can trade
5593speed for memory and install an UNCOMPRESSED image instead: this
5594needs more space in Flash, but boots much faster since it does not
5595need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00005596
Stefan Roese88fbf932010-04-15 16:07:28 +02005597 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk6c59edc2004-05-03 20:45:30 +00005598 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5599 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005600 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk6c59edc2004-05-03 20:45:30 +00005601 > examples/uImage.TQM850L-uncompressed
5602 Image Name: 2.4.4 kernel for TQM850L
5603 Created: Wed Jul 19 02:34:59 2000
5604 Image Type: PowerPC Linux Kernel Image (uncompressed)
5605 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5606 Load Address: 0x00000000
5607 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005608
wdenkc6097192002-11-03 00:24:07 +00005609
wdenk6c59edc2004-05-03 20:45:30 +00005610Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5611when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00005612
wdenk6c59edc2004-05-03 20:45:30 +00005613 -> tools/mkimage -n 'Simple Ramdisk Image' \
5614 > -A ppc -O linux -T ramdisk -C gzip \
5615 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5616 Image Name: Simple Ramdisk Image
5617 Created: Wed Jan 12 14:01:50 2000
5618 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5619 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5620 Load Address: 0x00000000
5621 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005622
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07005623The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5624option performs the converse operation of the mkimage's second form (the "-d"
5625option). Given an image built by mkimage, the dumpimage extracts a "data file"
5626from the image:
5627
5628 tools/dumpimage -i image -p position data_file
5629 -i ==> extract from the 'image' a specific 'data_file', \
5630 indexed by 'position'
5631
wdenkc6097192002-11-03 00:24:07 +00005632
wdenk6c59edc2004-05-03 20:45:30 +00005633Installing a Linux Image:
5634-------------------------
wdenkc6097192002-11-03 00:24:07 +00005635
wdenk6c59edc2004-05-03 20:45:30 +00005636To downloading a U-Boot image over the serial (console) interface,
5637you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00005638
wdenk6c59edc2004-05-03 20:45:30 +00005639 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00005640
wdenk6c59edc2004-05-03 20:45:30 +00005641The 'objcopy' does not understand the information in the U-Boot
5642image header, so the resulting S-Record file will be relative to
5643address 0x00000000. To load it to a given address, you need to
5644specify the target address as 'offset' parameter with the 'loads'
5645command.
wdenkc6097192002-11-03 00:24:07 +00005646
wdenk6c59edc2004-05-03 20:45:30 +00005647Example: install the image to address 0x40100000 (which on the
5648TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00005649
wdenk6c59edc2004-05-03 20:45:30 +00005650 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00005651
wdenk6c59edc2004-05-03 20:45:30 +00005652 .......... done
5653 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00005654
wdenk6c59edc2004-05-03 20:45:30 +00005655 => loads 40100000
5656 ## Ready for S-Record download ...
5657 ~>examples/image.srec
5658 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5659 ...
5660 15989 15990 15991 15992
5661 [file transfer complete]
5662 [connected]
5663 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005664
wdenkc6097192002-11-03 00:24:07 +00005665
wdenk6c59edc2004-05-03 20:45:30 +00005666You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005667this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00005668corruption happened:
wdenkc6097192002-11-03 00:24:07 +00005669
wdenk6c59edc2004-05-03 20:45:30 +00005670 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00005671
wdenk6c59edc2004-05-03 20:45:30 +00005672 ## Checking Image at 40100000 ...
5673 Image Name: 2.2.13 for initrd on TQM850L
5674 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5675 Data Size: 335725 Bytes = 327 kB = 0 MB
5676 Load Address: 00000000
5677 Entry Point: 0000000c
5678 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005679
5680
wdenk6c59edc2004-05-03 20:45:30 +00005681Boot Linux:
5682-----------
wdenkc6097192002-11-03 00:24:07 +00005683
wdenk6c59edc2004-05-03 20:45:30 +00005684The "bootm" command is used to boot an application that is stored in
5685memory (RAM or Flash). In case of a Linux kernel image, the contents
5686of the "bootargs" environment variable is passed to the kernel as
5687parameters. You can check and modify this variable using the
5688"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00005689
wdenkc6097192002-11-03 00:24:07 +00005690
wdenk6c59edc2004-05-03 20:45:30 +00005691 => printenv bootargs
5692 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00005693
wdenk6c59edc2004-05-03 20:45:30 +00005694 => 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 +00005695
wdenk6c59edc2004-05-03 20:45:30 +00005696 => printenv bootargs
5697 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 +00005698
wdenk6c59edc2004-05-03 20:45:30 +00005699 => bootm 40020000
5700 ## Booting Linux kernel at 40020000 ...
5701 Image Name: 2.2.13 for NFS on TQM850L
5702 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5703 Data Size: 381681 Bytes = 372 kB = 0 MB
5704 Load Address: 00000000
5705 Entry Point: 0000000c
5706 Verifying Checksum ... OK
5707 Uncompressing Kernel Image ... OK
5708 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
5709 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5710 time_init: decrementer frequency = 187500000/60
5711 Calibrating delay loop... 49.77 BogoMIPS
5712 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5713 ...
wdenkc6097192002-11-03 00:24:07 +00005714
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005715If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00005716the memory addresses of both the kernel and the initrd image (PPBCOOT
5717format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00005718
wdenk6c59edc2004-05-03 20:45:30 +00005719 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00005720
wdenk6c59edc2004-05-03 20:45:30 +00005721 ## Checking Image at 40100000 ...
5722 Image Name: 2.2.13 for initrd on TQM850L
5723 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5724 Data Size: 335725 Bytes = 327 kB = 0 MB
5725 Load Address: 00000000
5726 Entry Point: 0000000c
5727 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005728
wdenk6c59edc2004-05-03 20:45:30 +00005729 ## Checking Image at 40200000 ...
5730 Image Name: Simple Ramdisk Image
5731 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5732 Data Size: 566530 Bytes = 553 kB = 0 MB
5733 Load Address: 00000000
5734 Entry Point: 00000000
5735 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005736
wdenk6c59edc2004-05-03 20:45:30 +00005737 => bootm 40100000 40200000
5738 ## Booting Linux kernel at 40100000 ...
5739 Image Name: 2.2.13 for initrd on TQM850L
5740 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5741 Data Size: 335725 Bytes = 327 kB = 0 MB
5742 Load Address: 00000000
5743 Entry Point: 0000000c
5744 Verifying Checksum ... OK
5745 Uncompressing Kernel Image ... OK
5746 ## Loading RAMDisk Image at 40200000 ...
5747 Image Name: Simple Ramdisk Image
5748 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5749 Data Size: 566530 Bytes = 553 kB = 0 MB
5750 Load Address: 00000000
5751 Entry Point: 00000000
5752 Verifying Checksum ... OK
5753 Loading Ramdisk ... OK
5754 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
5755 Boot arguments: root=/dev/ram
5756 time_init: decrementer frequency = 187500000/60
5757 Calibrating delay loop... 49.77 BogoMIPS
5758 ...
5759 RAMDISK: Compressed image found at block 0
5760 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00005761
wdenk6c59edc2004-05-03 20:45:30 +00005762 bash#
wdenkc6097192002-11-03 00:24:07 +00005763
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005764Boot Linux and pass a flat device tree:
5765-----------
5766
5767First, U-Boot must be compiled with the appropriate defines. See the section
5768titled "Linux Kernel Interface" above for a more in depth explanation. The
5769following is an example of how to start a kernel and pass an updated
5770flat device tree:
5771
5772=> print oftaddr
5773oftaddr=0x300000
5774=> print oft
5775oft=oftrees/mpc8540ads.dtb
5776=> tftp $oftaddr $oft
5777Speed: 1000, full duplex
5778Using TSEC0 device
5779TFTP from server 192.168.1.1; our IP address is 192.168.1.101
5780Filename 'oftrees/mpc8540ads.dtb'.
5781Load address: 0x300000
5782Loading: #
5783done
5784Bytes transferred = 4106 (100a hex)
5785=> tftp $loadaddr $bootfile
5786Speed: 1000, full duplex
5787Using TSEC0 device
5788TFTP from server 192.168.1.1; our IP address is 192.168.1.2
5789Filename 'uImage'.
5790Load address: 0x200000
5791Loading:############
5792done
5793Bytes transferred = 1029407 (fb51f hex)
5794=> print loadaddr
5795loadaddr=200000
5796=> print oftaddr
5797oftaddr=0x300000
5798=> bootm $loadaddr - $oftaddr
5799## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01005800 Image Name: Linux-2.6.17-dirty
5801 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5802 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005803 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01005804 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005805 Verifying Checksum ... OK
5806 Uncompressing Kernel Image ... OK
5807Booting using flat device tree at 0x300000
5808Using MPC85xx ADS machine description
5809Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
5810[snip]
5811
5812
wdenk6c59edc2004-05-03 20:45:30 +00005813More About U-Boot Image Types:
5814------------------------------
wdenkc6097192002-11-03 00:24:07 +00005815
wdenk6c59edc2004-05-03 20:45:30 +00005816U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00005817
wdenk6c59edc2004-05-03 20:45:30 +00005818 "Standalone Programs" are directly runnable in the environment
5819 provided by U-Boot; it is expected that (if they behave
5820 well) you can continue to work in U-Boot after return from
5821 the Standalone Program.
5822 "OS Kernel Images" are usually images of some Embedded OS which
5823 will take over control completely. Usually these programs
5824 will install their own set of exception handlers, device
5825 drivers, set up the MMU, etc. - this means, that you cannot
5826 expect to re-enter U-Boot except by resetting the CPU.
5827 "RAMDisk Images" are more or less just data blocks, and their
5828 parameters (address, size) are passed to an OS kernel that is
5829 being started.
5830 "Multi-File Images" contain several images, typically an OS
5831 (Linux) kernel image and one or more data images like
5832 RAMDisks. This construct is useful for instance when you want
5833 to boot over the network using BOOTP etc., where the boot
5834 server provides just a single image file, but you want to get
5835 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00005836
wdenk6c59edc2004-05-03 20:45:30 +00005837 "Multi-File Images" start with a list of image sizes, each
5838 image size (in bytes) specified by an "uint32_t" in network
5839 byte order. This list is terminated by an "(uint32_t)0".
5840 Immediately after the terminating 0 follow the images, one by
5841 one, all aligned on "uint32_t" boundaries (size rounded up to
5842 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00005843
wdenk6c59edc2004-05-03 20:45:30 +00005844 "Firmware Images" are binary images containing firmware (like
5845 U-Boot or FPGA images) which usually will be programmed to
5846 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00005847
wdenk6c59edc2004-05-03 20:45:30 +00005848 "Script files" are command sequences that will be executed by
5849 U-Boot's command interpreter; this feature is especially
5850 useful when you configure U-Boot to use a real shell (hush)
5851 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00005852
Marek Vasutcf41a9b2012-03-14 21:52:45 +00005853Booting the Linux zImage:
5854-------------------------
5855
5856On some platforms, it's possible to boot Linux zImage. This is done
5857using the "bootz" command. The syntax of "bootz" command is the same
5858as the syntax of "bootm" command.
5859
Tom Rini45f46d12013-05-16 11:40:11 -04005860Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut28850d02012-03-18 11:47:58 +00005861kernel with raw initrd images. The syntax is slightly different, the
5862address of the initrd must be augmented by it's size, in the following
5863format: "<initrd addres>:<initrd size>".
5864
stroeseb9c17c52003-04-04 15:53:41 +00005865
wdenk6c59edc2004-05-03 20:45:30 +00005866Standalone HOWTO:
5867=================
stroeseb9c17c52003-04-04 15:53:41 +00005868
wdenk6c59edc2004-05-03 20:45:30 +00005869One of the features of U-Boot is that you can dynamically load and
5870run "standalone" applications, which can use some resources of
5871U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00005872
wdenk6c59edc2004-05-03 20:45:30 +00005873Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00005874
wdenk6c59edc2004-05-03 20:45:30 +00005875"Hello World" Demo:
5876-------------------
wdenkc6097192002-11-03 00:24:07 +00005877
wdenk6c59edc2004-05-03 20:45:30 +00005878'examples/hello_world.c' contains a small "Hello World" Demo
5879application; it is automatically compiled when you build U-Boot.
5880It's configured to run at address 0x00040004, so you can play with it
5881like that:
wdenkc6097192002-11-03 00:24:07 +00005882
wdenk6c59edc2004-05-03 20:45:30 +00005883 => loads
5884 ## Ready for S-Record download ...
5885 ~>examples/hello_world.srec
5886 1 2 3 4 5 6 7 8 9 10 11 ...
5887 [file transfer complete]
5888 [connected]
5889 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005890
wdenk6c59edc2004-05-03 20:45:30 +00005891 => go 40004 Hello World! This is a test.
5892 ## Starting application at 0x00040004 ...
5893 Hello World
5894 argc = 7
5895 argv[0] = "40004"
5896 argv[1] = "Hello"
5897 argv[2] = "World!"
5898 argv[3] = "This"
5899 argv[4] = "is"
5900 argv[5] = "a"
5901 argv[6] = "test."
5902 argv[7] = "<NULL>"
5903 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00005904
wdenk6c59edc2004-05-03 20:45:30 +00005905 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005906
wdenk6c59edc2004-05-03 20:45:30 +00005907Another example, which demonstrates how to register a CPM interrupt
5908handler with the U-Boot code, can be found in 'examples/timer.c'.
5909Here, a CPM timer is set up to generate an interrupt every second.
5910The interrupt service routine is trivial, just printing a '.'
5911character, but this is just a demo program. The application can be
5912controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00005913
wdenk6c59edc2004-05-03 20:45:30 +00005914 ? - print current values og the CPM Timer registers
5915 b - enable interrupts and start timer
5916 e - stop timer and disable interrupts
5917 q - quit application
wdenkc6097192002-11-03 00:24:07 +00005918
wdenk6c59edc2004-05-03 20:45:30 +00005919 => loads
5920 ## Ready for S-Record download ...
5921 ~>examples/timer.srec
5922 1 2 3 4 5 6 7 8 9 10 11 ...
5923 [file transfer complete]
5924 [connected]
5925 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005926
wdenk6c59edc2004-05-03 20:45:30 +00005927 => go 40004
5928 ## Starting application at 0x00040004 ...
5929 TIMERS=0xfff00980
5930 Using timer 1
5931 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00005932
wdenk6c59edc2004-05-03 20:45:30 +00005933Hit 'b':
5934 [q, b, e, ?] Set interval 1000000 us
5935 Enabling timer
5936Hit '?':
5937 [q, b, e, ?] ........
5938 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5939Hit '?':
5940 [q, b, e, ?] .
5941 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5942Hit '?':
5943 [q, b, e, ?] .
5944 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5945Hit '?':
5946 [q, b, e, ?] .
5947 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5948Hit 'e':
5949 [q, b, e, ?] ...Stopping timer
5950Hit 'q':
5951 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005952
wdenkc6097192002-11-03 00:24:07 +00005953
wdenk6c59edc2004-05-03 20:45:30 +00005954Minicom warning:
5955================
wdenkc6097192002-11-03 00:24:07 +00005956
wdenk6c59edc2004-05-03 20:45:30 +00005957Over time, many people have reported problems when trying to use the
5958"minicom" terminal emulation program for serial download. I (wd)
5959consider minicom to be broken, and recommend not to use it. Under
5960Unix, I recommend to use C-Kermit for general purpose use (and
5961especially for kermit binary protocol download ("loadb" command), and
Karl O. Pinca0189bb2012-10-01 05:11:56 +00005962use "cu" for S-Record download ("loads" command). See
5963http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5964for help with kermit.
5965
wdenkc6097192002-11-03 00:24:07 +00005966
wdenk6c59edc2004-05-03 20:45:30 +00005967Nevertheless, if you absolutely want to use it try adding this
5968configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00005969
wdenk6c59edc2004-05-03 20:45:30 +00005970 Name Program Name U/D FullScr IO-Red. Multi
5971 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
5972 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00005973
wdenk8dba0502003-03-31 16:34:49 +00005974
wdenk6c59edc2004-05-03 20:45:30 +00005975NetBSD Notes:
5976=============
wdenkc6097192002-11-03 00:24:07 +00005977
wdenk6c59edc2004-05-03 20:45:30 +00005978Starting at version 0.9.2, U-Boot supports NetBSD both as host
5979(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00005980
wdenk6c59edc2004-05-03 20:45:30 +00005981Building requires a cross environment; it is known to work on
5982NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5983need gmake since the Makefiles are not compatible with BSD make).
5984Note that the cross-powerpc package does not install include files;
5985attempting to build U-Boot will fail because <machine/ansi.h> is
5986missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00005987
wdenk6c59edc2004-05-03 20:45:30 +00005988 # cd /usr/pkg/cross/powerpc-netbsd/include
5989 # mkdir powerpc
5990 # ln -s powerpc machine
5991 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5992 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00005993
wdenk6c59edc2004-05-03 20:45:30 +00005994Native builds *don't* work due to incompatibilities between native
5995and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00005996
wdenk6c59edc2004-05-03 20:45:30 +00005997Booting assumes that (the first part of) the image booted is a
5998stage-2 loader which in turn loads and then invokes the kernel
5999proper. Loader sources will eventually appear in the NetBSD source
6000tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00006001meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00006002
wdenkc6097192002-11-03 00:24:07 +00006003
wdenk6c59edc2004-05-03 20:45:30 +00006004Implementation Internals:
6005=========================
wdenkc6097192002-11-03 00:24:07 +00006006
wdenk6c59edc2004-05-03 20:45:30 +00006007The following is not intended to be a complete description of every
6008implementation detail. However, it should help to understand the
6009inner workings of U-Boot and make it easier to port it to custom
6010hardware.
wdenkc6097192002-11-03 00:24:07 +00006011
wdenkc6097192002-11-03 00:24:07 +00006012
wdenk6c59edc2004-05-03 20:45:30 +00006013Initial Stack, Global Data:
6014---------------------------
wdenkc6097192002-11-03 00:24:07 +00006015
wdenk6c59edc2004-05-03 20:45:30 +00006016The implementation of U-Boot is complicated by the fact that U-Boot
6017starts running out of ROM (flash memory), usually without access to
6018system RAM (because the memory controller is not initialized yet).
6019This means that we don't have writable Data or BSS segments, and BSS
6020is not initialized as zero. To be able to get a C environment working
6021at all, we have to allocate at least a minimal stack. Implementation
6022options for this are defined and restricted by the CPU used: Some CPU
6023models provide on-chip memory (like the IMMR area on MPC8xx and
6024MPC826x processors), on others (parts of) the data cache can be
6025locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00006026
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006027 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006028 U-Boot mailing list:
wdenkc6097192002-11-03 00:24:07 +00006029
wdenk6c59edc2004-05-03 20:45:30 +00006030 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
6031 From: "Chris Hallinan" <clh@net1plus.com>
6032 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
6033 ...
wdenkc6097192002-11-03 00:24:07 +00006034
wdenk6c59edc2004-05-03 20:45:30 +00006035 Correct me if I'm wrong, folks, but the way I understand it
6036 is this: Using DCACHE as initial RAM for Stack, etc, does not
6037 require any physical RAM backing up the cache. The cleverness
6038 is that the cache is being used as a temporary supply of
6039 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006040 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00006041 can see how this works by studying the cache architecture and
6042 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00006043
wdenk6c59edc2004-05-03 20:45:30 +00006044 OCM is On Chip Memory, which I believe the 405GP has 4K. It
6045 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006046 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00006047 option should work for you. Using CS 4 should be fine if your
6048 board designers haven't used it for something that would
6049 cause you grief during the initial boot! It is frequently not
6050 used.
wdenkc6097192002-11-03 00:24:07 +00006051
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02006052 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00006053 with your processor/board/system design. The default value
6054 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02006055 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00006056 than your SDRAM module. If you have a 64MB SDRAM module, set
6057 it above 400_0000. Just make sure your board has no resources
6058 that are supposed to respond to that address! That code in
6059 start.S has been around a while and should work as is when
6060 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00006061
wdenk6c59edc2004-05-03 20:45:30 +00006062 -Chris Hallinan
6063 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00006064
wdenk6c59edc2004-05-03 20:45:30 +00006065It is essential to remember this, since it has some impact on the C
6066code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00006067
wdenk6c59edc2004-05-03 20:45:30 +00006068* Initialized global data (data segment) is read-only. Do not attempt
6069 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00006070
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006071* Do not use any uninitialized global data (or implicitely initialized
wdenk6c59edc2004-05-03 20:45:30 +00006072 as zero data - BSS segment) at all - this is undefined, initiali-
6073 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00006074
wdenk6c59edc2004-05-03 20:45:30 +00006075* Stack space is very limited. Avoid big data buffers or things like
6076 that.
wdenk4a5c8a72003-03-06 00:02:04 +00006077
wdenk6c59edc2004-05-03 20:45:30 +00006078Having only the stack as writable memory limits means we cannot use
6079normal global data to share information beween the code. But it
6080turned out that the implementation of U-Boot can be greatly
6081simplified by making a global data structure (gd_t) available to all
6082functions. We could pass a pointer to this data as argument to _all_
6083functions, but this would bloat the code. Instead we use a feature of
6084the GCC compiler (Global Register Variables) to share the data: we
6085place a pointer (gd) to the global data into a register which we
6086reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00006087
wdenk6c59edc2004-05-03 20:45:30 +00006088When choosing a register for such a purpose we are restricted by the
6089relevant (E)ABI specifications for the current architecture, and by
6090GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00006091
wdenk6c59edc2004-05-03 20:45:30 +00006092For PowerPC, the following registers have specific use:
6093 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01006094 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00006095 R3-R4: parameter passing and return values
6096 R5-R10: parameter passing
6097 R13: small data area pointer
6098 R30: GOT pointer
6099 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00006100
Joakim Tjernlund693c0c12010-01-19 14:41:58 +01006101 (U-Boot also uses R12 as internal GOT pointer. r12
6102 is a volatile register so r12 needs to be reset when
6103 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00006104
Wolfgang Denk69c09642008-02-14 22:43:22 +01006105 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00006106
wdenk6c59edc2004-05-03 20:45:30 +00006107 Note: on PPC, we could use a static initializer (since the
6108 address of the global data structure is known at compile time),
6109 but it turned out that reserving a register results in somewhat
6110 smaller code - although the code savings are not that big (on
6111 average for all boards 752 bytes for the whole U-Boot image,
6112 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00006113
Robin Getz2773d5f2009-08-17 15:23:02 +00006114On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger60f09302008-02-04 19:26:54 -05006115 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
6116
Robin Getz2773d5f2009-08-17 15:23:02 +00006117 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger60f09302008-02-04 19:26:54 -05006118
wdenk6c59edc2004-05-03 20:45:30 +00006119On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00006120
wdenk6c59edc2004-05-03 20:45:30 +00006121 R0: function argument word/integer result
6122 R1-R3: function argument word
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02006123 R9: platform specific
6124 R10: stack limit (used only if stack checking is enabled)
wdenk6c59edc2004-05-03 20:45:30 +00006125 R11: argument (frame) pointer
6126 R12: temporary workspace
6127 R13: stack pointer
6128 R14: link register
6129 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00006130
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02006131 ==> U-Boot will use R9 to hold a pointer to the global data
6132
6133 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00006134
Thomas Chou8fa38582010-05-21 11:08:03 +08006135On Nios II, the ABI is documented here:
6136 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
6137
6138 ==> U-Boot will use gp to hold a pointer to the global data
6139
6140 Note: on Nios II, we give "-G0" option to gcc and don't use gp
6141 to access small data sections, so gp is free.
6142
Macpaul Lin1cac36e2011-10-19 20:41:11 +00006143On NDS32, the following registers are used:
6144
6145 R0-R1: argument/return
6146 R2-R5: argument
6147 R15: temporary register for assembler
6148 R16: trampoline register
6149 R28: frame pointer (FP)
6150 R29: global pointer (GP)
6151 R30: link register (LP)
6152 R31: stack pointer (SP)
6153 PC: program counter (PC)
6154
6155 ==> U-Boot will use R10 to hold a pointer to the global data
6156
Wolfgang Denk6405a152006-03-31 18:32:53 +02006157NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
6158or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00006159
wdenk6c59edc2004-05-03 20:45:30 +00006160Memory Management:
6161------------------
wdenkc6097192002-11-03 00:24:07 +00006162
wdenk6c59edc2004-05-03 20:45:30 +00006163U-Boot runs in system state and uses physical addresses, i.e. the
6164MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00006165
wdenk6c59edc2004-05-03 20:45:30 +00006166The available memory is mapped to fixed addresses using the memory
6167controller. In this process, a contiguous block is formed for each
6168memory type (Flash, SDRAM, SRAM), even when it consists of several
6169physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00006170
wdenk6c59edc2004-05-03 20:45:30 +00006171U-Boot is installed in the first 128 kB of the first Flash bank (on
6172TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
6173booting and sizing and initializing DRAM, the code relocates itself
6174to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02006175memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00006176configuration setting]. Below that, a structure with global Board
6177Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00006178
wdenk6c59edc2004-05-03 20:45:30 +00006179Additionally, some exception handler code is copied to the low 8 kB
6180of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00006181
wdenk6c59edc2004-05-03 20:45:30 +00006182So a typical memory configuration with 16 MB of DRAM could look like
6183this:
wdenkc6097192002-11-03 00:24:07 +00006184
wdenk6c59edc2004-05-03 20:45:30 +00006185 0x0000 0000 Exception Vector code
6186 :
6187 0x0000 1FFF
6188 0x0000 2000 Free for Application Use
6189 :
6190 :
wdenkc6097192002-11-03 00:24:07 +00006191
wdenk6c59edc2004-05-03 20:45:30 +00006192 :
6193 :
6194 0x00FB FF20 Monitor Stack (Growing downward)
6195 0x00FB FFAC Board Info Data and permanent copy of global data
6196 0x00FC 0000 Malloc Arena
6197 :
6198 0x00FD FFFF
6199 0x00FE 0000 RAM Copy of Monitor Code
6200 ... eventually: LCD or video framebuffer
6201 ... eventually: pRAM (Protected RAM - unchanged by reset)
6202 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00006203
wdenkc6097192002-11-03 00:24:07 +00006204
wdenk6c59edc2004-05-03 20:45:30 +00006205System Initialization:
6206----------------------
wdenkc6097192002-11-03 00:24:07 +00006207
wdenk6c59edc2004-05-03 20:45:30 +00006208In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006209(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk6c59edc2004-05-03 20:45:30 +00006210configuration for CS0# this is a mirror of the onboard Flash memory.
6211To be able to re-map memory U-Boot then jumps to its link address.
6212To be able to implement the initialization code in C, a (small!)
6213initial stack is set up in the internal Dual Ported RAM (in case CPUs
6214which provide such a feature like MPC8xx or MPC8260), or in a locked
6215part of the data cache. After that, U-Boot initializes the CPU core,
6216the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00006217
wdenk6c59edc2004-05-03 20:45:30 +00006218Next, all (potentially) available memory banks are mapped using a
6219preliminary mapping. For example, we put them on 512 MB boundaries
6220(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
6221on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
6222programmed for SDRAM access. Using the temporary configuration, a
6223simple memory test is run that determines the size of the SDRAM
6224banks.
wdenkc6097192002-11-03 00:24:07 +00006225
wdenk6c59edc2004-05-03 20:45:30 +00006226When there is more than one SDRAM bank, and the banks are of
6227different size, the largest is mapped first. For equal size, the first
6228bank (CS2#) is mapped first. The first mapping is always for address
62290x00000000, with any additional banks following immediately to create
6230contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00006231
wdenk6c59edc2004-05-03 20:45:30 +00006232Then, the monitor installs itself at the upper end of the SDRAM area
6233and allocates memory for use by malloc() and for the global Board
6234Info data; also, the exception vector code is copied to the low RAM
6235pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00006236
wdenk6c59edc2004-05-03 20:45:30 +00006237Only after this relocation will you have a "normal" C environment;
6238until that you are restricted in several ways, mostly because you are
6239running from ROM, and because the code will have to be relocated to a
6240new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00006241
wdenkc6097192002-11-03 00:24:07 +00006242
wdenk6c59edc2004-05-03 20:45:30 +00006243U-Boot Porting Guide:
6244----------------------
wdenkc6097192002-11-03 00:24:07 +00006245
wdenk6c59edc2004-05-03 20:45:30 +00006246[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
6247list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00006248
wdenkc6097192002-11-03 00:24:07 +00006249
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006250int main(int argc, char *argv[])
wdenk6c59edc2004-05-03 20:45:30 +00006251{
6252 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00006253
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006254 signal(SIGALRM, no_more_time);
6255 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00006256
wdenk6c59edc2004-05-03 20:45:30 +00006257 if (available_money > available_manpower) {
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006258 Pay consultant to port U-Boot;
wdenk6c59edc2004-05-03 20:45:30 +00006259 return 0;
6260 }
wdenkc6097192002-11-03 00:24:07 +00006261
wdenk6c59edc2004-05-03 20:45:30 +00006262 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00006263
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006264 Subscribe to u-boot mailing list;
wdenkc6097192002-11-03 00:24:07 +00006265
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006266 if (clueless)
6267 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00006268
wdenk6c59edc2004-05-03 20:45:30 +00006269 while (learning) {
6270 Read the README file in the top level directory;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006271 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
6272 Read applicable doc/*.README;
wdenk6c59edc2004-05-03 20:45:30 +00006273 Read the source, Luke;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006274 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk6c59edc2004-05-03 20:45:30 +00006275 }
wdenkc6097192002-11-03 00:24:07 +00006276
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006277 if (available_money > toLocalCurrency ($2500))
6278 Buy a BDI3000;
6279 else
wdenk6c59edc2004-05-03 20:45:30 +00006280 Add a lot of aggravation and time;
wdenkc6097192002-11-03 00:24:07 +00006281
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006282 if (a similar board exists) { /* hopefully... */
6283 cp -a board/<similar> board/<myboard>
6284 cp include/configs/<similar>.h include/configs/<myboard>.h
6285 } else {
6286 Create your own board support subdirectory;
6287 Create your own board include/configs/<myboard>.h file;
6288 }
6289 Edit new board/<myboard> files
6290 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00006291
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006292 while (!accepted) {
6293 while (!running) {
6294 do {
6295 Add / modify source code;
6296 } until (compiles);
6297 Debug;
6298 if (clueless)
6299 email("Hi, I am having problems...");
6300 }
6301 Send patch file to the U-Boot email list;
6302 if (reasonable critiques)
6303 Incorporate improvements from email list code review;
6304 else
6305 Defend code as written;
wdenk634d2f72004-04-15 23:14:49 +00006306 }
wdenkc6097192002-11-03 00:24:07 +00006307
wdenk6c59edc2004-05-03 20:45:30 +00006308 return 0;
6309}
wdenkc6097192002-11-03 00:24:07 +00006310
wdenk6c59edc2004-05-03 20:45:30 +00006311void no_more_time (int sig)
6312{
6313 hire_a_guru();
6314}
wdenkc6097192002-11-03 00:24:07 +00006315
wdenkc6097192002-11-03 00:24:07 +00006316
wdenk6c59edc2004-05-03 20:45:30 +00006317Coding Standards:
6318-----------------
wdenkc6097192002-11-03 00:24:07 +00006319
wdenk6c59edc2004-05-03 20:45:30 +00006320All contributions to U-Boot should conform to the Linux kernel
Detlev Zundelaa63d482006-09-01 15:39:02 +02006321coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006322"scripts/Lindent" in your Linux kernel source directory.
Detlev Zundelaa63d482006-09-01 15:39:02 +02006323
6324Source files originating from a different project (for example the
6325MTD subsystem) are generally exempt from these guidelines and are not
6326reformated to ease subsequent migration to newer versions of those
6327sources.
wdenkc6097192002-11-03 00:24:07 +00006328
Detlev Zundelaa63d482006-09-01 15:39:02 +02006329Please note that U-Boot is implemented in C (and to some small parts in
6330Assembler); no C++ is used, so please do not use C++ style comments (//)
6331in your code.
wdenkad276f22004-01-04 16:28:35 +00006332
wdenk6c59edc2004-05-03 20:45:30 +00006333Please also stick to the following formatting rules:
6334- remove any trailing white space
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006335- use TAB characters for indentation and vertical alignment, not spaces
wdenk6c59edc2004-05-03 20:45:30 +00006336- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006337- do not add more than 2 consecutive empty lines to source files
wdenk6c59edc2004-05-03 20:45:30 +00006338- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00006339
wdenk6c59edc2004-05-03 20:45:30 +00006340Submissions which do not conform to the standards may be returned
6341with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00006342
wdenkc6097192002-11-03 00:24:07 +00006343
wdenk6c59edc2004-05-03 20:45:30 +00006344Submitting Patches:
6345-------------------
wdenkc6097192002-11-03 00:24:07 +00006346
wdenk6c59edc2004-05-03 20:45:30 +00006347Since the number of patches for U-Boot is growing, we need to
6348establish some rules. Submissions which do not conform to these rules
6349may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00006350
Magnus Liljaf3b287b2008-08-06 19:32:33 +02006351Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006352
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006353Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
6354see http://lists.denx.de/mailman/listinfo/u-boot
6355
wdenk6c59edc2004-05-03 20:45:30 +00006356When you send a patch, please include the following information with
6357it:
wdenkc6097192002-11-03 00:24:07 +00006358
wdenk6c59edc2004-05-03 20:45:30 +00006359* For bug fixes: a description of the bug and how your patch fixes
6360 this bug. Please try to include a way of demonstrating that the
6361 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00006362
wdenk6c59edc2004-05-03 20:45:30 +00006363* For new features: a description of the feature and your
6364 implementation.
wdenkc6097192002-11-03 00:24:07 +00006365
wdenk6c59edc2004-05-03 20:45:30 +00006366* A CHANGELOG entry as plaintext (separate from the patch)
wdenkc6097192002-11-03 00:24:07 +00006367
wdenk6c59edc2004-05-03 20:45:30 +00006368* For major contributions, your entry to the CREDITS file
wdenkc6097192002-11-03 00:24:07 +00006369
Albert ARIBAUD48e910f2013-09-11 15:52:51 +02006370* When you add support for a new board, don't forget to add a
6371 maintainer e-mail address to the boards.cfg file, too.
wdenkc6097192002-11-03 00:24:07 +00006372
wdenk6c59edc2004-05-03 20:45:30 +00006373* If your patch adds new configuration options, don't forget to
6374 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00006375
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006376* The patch itself. If you are using git (which is *strongly*
6377 recommended) you can easily generate the patch using the
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006378 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006379 the U-Boot mailing list, you will avoid most of the common problems
6380 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00006381
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006382 If you cannot use git, use "diff -purN OLD NEW". If your version of
6383 diff does not support these options, then get the latest version of
6384 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00006385
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006386 The current directory when running this command shall be the parent
6387 directory of the U-Boot source tree (i. e. please make sure that
6388 your patch includes sufficient directory information for the
6389 affected files).
6390
6391 We prefer patches as plain text. MIME attachments are discouraged,
6392 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00006393
wdenk6c59edc2004-05-03 20:45:30 +00006394* If one logical set of modifications affects or creates several
6395 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00006396
wdenk6c59edc2004-05-03 20:45:30 +00006397* Changesets that contain different, unrelated modifications shall be
6398 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00006399
wdenkc6097192002-11-03 00:24:07 +00006400
wdenk6c59edc2004-05-03 20:45:30 +00006401Notes:
wdenkc6097192002-11-03 00:24:07 +00006402
wdenk6c59edc2004-05-03 20:45:30 +00006403* Before sending the patch, run the MAKEALL script on your patched
6404 source tree and make sure that no errors or warnings are reported
6405 for any of the boards.
6406
6407* Keep your modifications to the necessary minimum: A patch
6408 containing several unrelated changes or arbitrary reformats will be
6409 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00006410
wdenk6c59edc2004-05-03 20:45:30 +00006411* If you modify existing code, make sure that your new code does not
6412 add to the memory footprint of the code ;-) Small is beautiful!
6413 When adding new features, these should compile conditionally only
6414 (using #ifdef), and the resulting code with the new feature
6415 disabled must not need more memory than the old code without your
6416 modification.
wdenkcbc49a52005-05-03 14:12:25 +00006417
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006418* Remember that there is a size limit of 100 kB per message on the
6419 u-boot mailing list. Bigger patches will be moderated. If they are
6420 reasonable and not too big, they will be acknowledged. But patches
6421 bigger than the size limit should be avoided.