blob: f52a5f7f64d78bb87aed645598860843154701de [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Wolfgang Denkeca3aeb2013-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 Denkeca3aeb2013-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
wdenke86e5a02004-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 ARIBAUD27af9302013-09-11 15:52:51 +020038who contributed the specific port. The boards.cfg file lists board
Wolfgang Denk218ca722008-03-26 10:40:12 +010039maintainers.
wdenkc6097192002-11-03 00:24:07 +000040
Robert P. J. Dayadb9d852012-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 Tyser0c325652008-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 Denk218ca722008-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 Ziswiler11ccc332008-07-09 08:17:15 +020066any version you might be interested in. Official releases are also
Wolfgang Denk218ca722008-03-26 10:40:12 +010067available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
68directory.
69
Anatolij Gustschind4ee7112008-03-26 18:13:33 +010070Pre-built (and tested) images are available from
Wolfgang Denk218ca722008-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 Ziswiler11ccc332008-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 Lilja0d28f342008-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:
110
111 U_BOOT_VERSION u_boot_logo
112 IH_OS_U_BOOT u_boot_hush_start
wdenkc6097192002-11-03 00:24:07 +0000113
114
wdenk93f19cc2002-12-17 17:55:09 +0000115Versioning:
116===========
117
Thomas Weber360d8832010-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.
wdenk93f19cc2002-12-17 17:55:09 +0000124
Thomas Weber360d8832010-09-28 08:06:25 +0200125Examples:
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000126 U-Boot v2009.11 - Release November 2009
Thomas Weber360d8832010-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
wdenk93f19cc2002-12-17 17:55:09 +0000129
130
wdenkc6097192002-11-03 00:24:07 +0000131Directory Hierarchy:
132====================
133
Peter Tyser8d321b82010-04-12 22:28:21 -0500134/arch Architecture specific files
Masahiro Yamada6eae68e2014-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 Tyser8d321b82010-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ßmann6eb09212011-07-18 09:41:08 +0000143 /at91 Files specific to Atmel AT91RM9200 CPU
Wolfgang Denka9046b92010-06-13 17:48:15 +0200144 /imx Files specific to Freescale MC9328 i.MX CPUs
145 /s3c24x0 Files specific to Samsung S3C24X0 CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500146 /arm926ejs Files specific to ARM 926 CPUs
147 /arm1136 Files specific to ARM 1136 CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500148 /pxa Files specific to Intel XScale PXA CPUs
Peter Tyser8d321b82010-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 Tyser8d321b82010-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 Schwierzeck92bbd642011-07-27 13:22:39 +0200170 /mips32 Files specific to MIPS32 CPUs
Masahiro Yamada6eae68e2014-03-07 18:02:02 +0900171 /mips64 Files specific to MIPS64 CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500172 /lib Architecture specific library files
Macpaul Linafc1ce82011-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 Tyser8d321b82010-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. Day33c77312013-09-15 18:34:15 -0400180 /openrisc Files generic to OpenRISC architecture
181 /cpu CPU specific files
182 /lib Architecture specific library files
Stefan Roesea47a12b2010-04-15 16:07:28 +0200183 /powerpc Files generic to PowerPC architecture
Peter Tyser8d321b82010-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 Tyser8d321b82010-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. Day33c77312013-09-15 18:34:15 -0400205 /x86 Files generic to x86 architecture
206 /cpu CPU specific files
207 /lib Architecture specific library files
Peter Tyser8d321b82010-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. Day33c77312013-09-15 18:34:15 -0400214/dts Contains Makefile for building internal U-Boot fdt.
Peter Tyser8d321b82010-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. Day33c77312013-09-15 18:34:15 -0400224/spl Secondary Program Loader framework
Peter Tyser8d321b82010-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-VILLARD6d0f6bc2008-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 Freytherab584d62014-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 Freytherab584d62014-08-04 09:26:05 +0200260 make TQM823L_defconfig
wdenkc6097192002-11-03 00:24:07 +0000261
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200262For the Cogent platform, you need to specify the CPU type as well;
Holger Freytherab584d62014-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 Glass75b3c3a2014-03-22 17:12:59 -0600267Sandbox Environment:
268--------------------
269
270U-Boot can be built natively to run on a Linux host using the 'sandbox'
271board. This allows feature development which is not board- or architecture-
272specific to be undertaken on a native platform. The sandbox is also used to
273run some of U-Boot's tests.
274
Jagannadha Sutradharudu Teki6b1978f2014-08-31 21:19:43 +0530275See board/sandbox/README.sandbox for more details.
Simon Glass75b3c3a2014-03-22 17:12:59 -0600276
277
wdenkc6097192002-11-03 00:24:07 +0000278Configuration Options:
279----------------------
280
281Configuration depends on the combination of board and CPU type; all
282such information is kept in a configuration file
283"include/configs/<board_name>.h".
284
285Example: For a TQM823L module, all configuration settings are in
286"include/configs/TQM823L.h".
287
288
wdenk7f6c2cb2002-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 Phillips26281142007-08-10 13:28:25 -0500296- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000297
Kim Phillips26281142007-08-10 13:28:25 -0500298- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk6ccec442006-10-24 14:42:37 +0200299
300- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen09ea0de2007-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 Ziswiler11ccc332008-07-09 08:17:15 +0200321 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000322 a "rotator" |\-/|\-/
323
Lei Wencf946c62011-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)
wdenk5da627a2003-10-09 20:09:04 +0000330 Define exactly one of
331 CONFIG_MPC8240, CONFIG_MPC8245
wdenkc6097192002-11-03 00:24:07 +0000332
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200333- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk66ca92a2004-09-28 17:59:53 +0000334 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
335 get_gclk_freq() cannot work
wdenk5da627a2003-10-09 20:09:04 +0000336 e.g. if there is no 32KHz
337 reference PIT/RTC clock
wdenk66ca92a2004-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
wdenk66ca92a2004-09-28 17:59:53 +0000341- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200342 CONFIG_SYS_8xx_CPUCLK_MIN
343 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk66ca92a2004-09-28 17:59:53 +0000344 CONFIG_8xx_CPUCLK_DEFAULT
wdenk75d1ea72004-01-31 20:06:54 +0000345 See doc/README.MPC866
346
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200347 CONFIG_SYS_MEASURE_CPUCLK
wdenk75d1ea72004-01-31 20:06:54 +0000348
wdenkba56f622004-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-VILLARD6d0f6bc2008-10-16 15:01:15 +0200354 RTC clock or CONFIG_SYS_8XX_XIN)
wdenk75d1ea72004-01-31 20:06:54 +0000355
Heiko Schocher506f3912009-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 Gala66412c62011-02-18 05:40:54 -0600361- 85xx CPU Options:
York Sunffd06e02012-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 Gala66412c62011-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 Gala8f290842011-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 Kushwahaafa6b552012-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 Wood33eee332012-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 Kushwaha74fa22e2013-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 Wood33eee332012-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 Jain64501c62013-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 Jain765b0bd2013-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 Jain64501c62013-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 Jain765b0bd2013-04-04 09:31:54 +0530429 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
430 This value denotes start offset of DSP CCSR space.
431
Priyanka Jainb1359912013-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 Bansalfb4a2402014-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 Yuantianaade2002014-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 Schwierzeck6cb461b2012-04-02 02:57:56 +0000445- Generic CPU options:
York Sun2a1680e2014-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 Schwierzeck6cb461b2012-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 Sun5614e712013-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 Sun34e026f2014-03-27 17:54:47 -0700478 CONFIG_SYS_FSL_DDRC_GEN4
479 Freescale DDR4 controller.
480
York Sun9ac4ffb2013-09-30 14:20:51 -0700481 CONFIG_SYS_FSL_DDRC_ARM_GEN3
482 Freescale DDR3 controller for ARM-based SoCs.
483
York Sun5614e712013-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 Sun34e026f2014-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 Sun5614e712013-09-30 09:22:09 -0700505
Prabhakar Kushwaha1b4175d2014-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 Kushwaha690e4252014-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 Kushwaha89ad7be2014-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 Sun4e5b1bd2014-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 Sun6b9e3092014-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 Sun6b1e1252014-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
York Sun1d71efb2014-08-01 15:51:00 -0700541 CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
542 Number of controllers used as main memory.
543
544 CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
545 Number of controllers used for other than main memory.
546
Ruchika Gupta028dbb82014-09-09 11:50:31 +0530547 CONFIG_SYS_FSL_SEC_BE
548 Defines the SEC controller register space as Big Endian
549
550 CONFIG_SYS_FSL_SEC_LE
551 Defines the SEC controller register space as Little Endian
552
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100553- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200554 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100555
556 Defines the Monahans run mode to oscillator
557 ratio. Valid values are 8, 16, 24, 31. The core
558 frequency is this value multiplied by 13 MHz.
559
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200560 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200561
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100562 Defines the Monahans turbo mode to oscillator
563 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200564 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100565 by this value.
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200566
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200567- MIPS CPU options:
568 CONFIG_SYS_INIT_SP_OFFSET
569
570 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
571 pointer. This is needed for the temporary stack before
572 relocation.
573
574 CONFIG_SYS_MIPS_CACHE_MODE
575
576 Cache operation mode for the MIPS CPU.
577 See also arch/mips/include/asm/mipsregs.h.
578 Possible values are:
579 CONF_CM_CACHABLE_NO_WA
580 CONF_CM_CACHABLE_WA
581 CONF_CM_UNCACHED
582 CONF_CM_CACHABLE_NONCOHERENT
583 CONF_CM_CACHABLE_CE
584 CONF_CM_CACHABLE_COW
585 CONF_CM_CACHABLE_CUW
586 CONF_CM_CACHABLE_ACCELERATED
587
588 CONFIG_SYS_XWAY_EBU_BOOTCFG
589
590 Special option for Lantiq XWAY SoCs for booting from NOR flash.
591 See also arch/mips/cpu/mips32/start.S.
592
593 CONFIG_XWAY_SWAP_BYTES
594
595 Enable compilation of tools/xway-swap-bytes needed for Lantiq
596 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
597 be swapped if a flash programmer is used.
598
Christian Rieschb67d8812012-02-02 00:44:39 +0000599- ARM options:
600 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
601
602 Select high exception vectors of the ARM core, e.g., do not
603 clear the V bit of the c1 register of CP15.
604
Aneesh V5356f542012-03-08 07:20:19 +0000605 CONFIG_SYS_THUMB_BUILD
606
607 Use this flag to build U-Boot using the Thumb instruction
608 set for ARM architectures. Thumb instruction set provides
609 better code density. For ARM architectures that support
610 Thumb2 this flag will result in Thumb2 code generated by
611 GCC.
612
Stephen Warrenc5d47522013-03-04 13:29:40 +0000613 CONFIG_ARM_ERRATA_716044
Stephen Warren06785872013-02-26 12:28:27 +0000614 CONFIG_ARM_ERRATA_742230
615 CONFIG_ARM_ERRATA_743622
616 CONFIG_ARM_ERRATA_751472
Nitin Gargf71cbfe2014-04-02 08:55:01 -0500617 CONFIG_ARM_ERRATA_794072
Nitin Gargb7588e32014-04-02 08:55:02 -0500618 CONFIG_ARM_ERRATA_761320
Stephen Warren06785872013-02-26 12:28:27 +0000619
620 If set, the workarounds for these ARM errata are applied early
621 during U-Boot startup. Note that these options force the
622 workarounds to be applied; no CPU-type/version detection
623 exists, unlike the similar options in the Linux kernel. Do not
624 set these options unless they apply!
625
wdenk5da627a2003-10-09 20:09:04 +0000626- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000627 CONFIG_CLOCKS_IN_MHZ
628
629 U-Boot stores all clock information in Hz
630 internally. For binary compatibility with older Linux
631 kernels (which expect the clocks passed in the
632 bd_info data to be in MHz) the environment variable
633 "clocks_in_mhz" can be defined so that U-Boot
634 converts clock data to MHZ before passing it to the
635 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000636 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denk218ca722008-03-26 10:40:12 +0100637 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000638 default environment.
639
wdenk5da627a2003-10-09 20:09:04 +0000640 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
641
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200642 When transferring memsize parameter to linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000643 expect it to be in bytes, others in MB.
644 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
645
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400646 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200647
648 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400649 passed using flattened device trees (based on open firmware
650 concepts).
651
652 CONFIG_OF_LIBFDT
653 * New libfdt-based support
654 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500655 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400656
Marcel Ziswilerb55ae402009-09-09 21:18:41 +0200657 OF_CPU - The proper name of the cpus node (only required for
658 MPC512X and MPC5xxx based boards).
659 OF_SOC - The proper name of the soc node (only required for
660 MPC512X and MPC5xxx based boards).
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200661 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600662 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200663
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200664 boards with QUICC Engines require OF_QE to set UCC MAC
665 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500666
Kumar Gala4e253132006-01-11 13:54:17 -0600667 CONFIG_OF_BOARD_SETUP
668
669 Board code has addition modification that it wants to make
670 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000671
Matthew McClintock02677682006-06-28 10:41:37 -0500672 CONFIG_OF_BOOT_CPU
673
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200674 This define fills in the correct boot CPU in the boot
Matthew McClintock02677682006-06-28 10:41:37 -0500675 param header, the default value is zero if undefined.
676
Heiko Schocher3887c3f2009-09-23 07:56:08 +0200677 CONFIG_OF_IDE_FIXUP
678
679 U-Boot can detect if an IDE device is present or not.
680 If not, and this new config option is activated, U-Boot
681 removes the ATA node from the DTS before booting Linux,
682 so the Linux IDE driver does not probe the device and
683 crash. This is needed for buggy hardware (uc101) where
684 no pull down resistor is connected to the signal IDE5V_DD7.
685
Igor Grinberg7eb29392011-07-14 05:45:07 +0000686 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
687
688 This setting is mandatory for all boards that have only one
689 machine type and must be used to specify the machine type
690 number as it appears in the ARM machine registry
691 (see http://www.arm.linux.org.uk/developer/machines/).
692 Only boards that have multiple machine types supported
693 in a single configuration file and the machine type is
694 runtime discoverable, do not have to use this setting.
695
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100696- vxWorks boot parameters:
697
698 bootvx constructs a valid bootline using the following
699 environments variables: bootfile, ipaddr, serverip, hostname.
700 It loads the vxWorks image pointed bootfile.
701
702 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
703 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
704 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
705 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
706
707 CONFIG_SYS_VXWORKS_ADD_PARAMS
708
709 Add it at the end of the bootline. E.g "u=username pw=secret"
710
711 Note: If a "bootargs" environment is defined, it will overwride
712 the defaults discussed just above.
713
Aneesh V2c451f72011-06-16 23:30:47 +0000714- Cache Configuration:
715 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
716 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
717 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
718
Aneesh V93bc2192011-06-16 23:30:51 +0000719- Cache Configuration for ARM:
720 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
721 controller
722 CONFIG_SYS_PL310_BASE - Physical base address of PL310
723 controller register space
724
wdenk6705d812004-08-02 23:22:59 +0000725- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200726 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000727
728 Define this if you want support for Amba PrimeCell PL010 UARTs.
729
Andreas Engel48d01922008-09-08 14:30:53 +0200730 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000731
732 Define this if you want support for Amba PrimeCell PL011 UARTs.
733
734 CONFIG_PL011_CLOCK
735
736 If you have Amba PrimeCell PL011 UARTs, set this variable to
737 the clock speed of the UARTs.
738
739 CONFIG_PL01x_PORTS
740
741 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
742 define this to a list of base addresses for each (supported)
743 port. See e.g. include/configs/versatile.h
744
John Rigby910f1ae2011-04-19 10:42:39 +0000745 CONFIG_PL011_SERIAL_RLCR
746
747 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
748 have separate receive and transmit line control registers. Set
749 this variable to initialize the extra register.
750
751 CONFIG_PL011_SERIAL_FLUSH_ON_INIT
752
753 On some platforms (e.g. U8500) U-Boot is loaded by a second stage
754 boot loader that has already initialized the UART. Define this
755 variable to flush the UART at init time.
756
Karicheri, Muralidharand57dee52014-04-09 15:38:46 -0400757 CONFIG_SERIAL_HW_FLOW_CONTROL
758
759 Define this variable to enable hw flow control in serial driver.
760 Current user of this option is drivers/serial/nsl16550.c driver
wdenk6705d812004-08-02 23:22:59 +0000761
wdenkc6097192002-11-03 00:24:07 +0000762- Console Interface:
wdenk43d96162003-03-06 00:02:04 +0000763 Depending on board, define exactly one serial port
764 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
765 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
766 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000767
768 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
769 port routines must be defined elsewhere
770 (i.e. serial_init(), serial_getc(), ...)
771
772 CONFIG_CFB_CONSOLE
773 Enables console device for a color framebuffer. Needs following
Wolfgang Denkc53043b2011-12-07 12:19:20 +0000774 defines (cf. smiLynxEM, i8042)
wdenkc6097192002-11-03 00:24:07 +0000775 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
776 (default big endian)
777 VIDEO_HW_RECTFILL graphic chip supports
778 rectangle fill
779 (cf. smiLynxEM)
780 VIDEO_HW_BITBLT graphic chip supports
781 bit-blit (cf. smiLynxEM)
782 VIDEO_VISIBLE_COLS visible pixel columns
783 (cols=pitch)
wdenkba56f622004-02-06 23:19:44 +0000784 VIDEO_VISIBLE_ROWS visible pixel rows
785 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000786 VIDEO_DATA_FORMAT graphic data format
787 (0-5, cf. cfb_console.c)
wdenkba56f622004-02-06 23:19:44 +0000788 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000789 VIDEO_KBD_INIT_FCT keyboard int fct
790 (i.e. i8042_kbd_init())
791 VIDEO_TSTC_FCT test char fct
792 (i.e. i8042_tstc)
793 VIDEO_GETC_FCT get char fct
794 (i.e. i8042_getc)
795 CONFIG_CONSOLE_CURSOR cursor drawing on/off
796 (requires blink timer
797 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200798 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000799 CONFIG_CONSOLE_TIME display time/date info in
800 upper right corner
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500801 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000802 CONFIG_VIDEO_LOGO display Linux logo in
803 upper left corner
wdenka6c7ad22002-12-03 21:28:10 +0000804 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
805 linux_logo.h for logo.
806 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000807 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200808 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000809 the logo
810
Pali Rohár33a35bb2012-10-19 13:30:09 +0000811 When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
812 a limited number of ANSI escape sequences (cursor control,
813 erase functions and limited graphics rendition control).
814
wdenk43d96162003-03-06 00:02:04 +0000815 When CONFIG_CFB_CONSOLE is defined, video console is
816 default i/o. Serial console can be forced with
817 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000818
wdenkd4ca31c2004-01-02 14:00:00 +0000819 When CONFIG_SILENT_CONSOLE is defined, all console
820 messages (by U-Boot and Linux!) can be silenced with
821 the "silent" environment variable. See
822 doc/README.silent for more information.
wdenka3ad8e22003-10-19 23:22:11 +0000823
Heiko Schocher45ae2542013-10-22 11:06:06 +0200824 CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
825 is 0x00.
826 CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
827 is 0xa0.
828
wdenkc6097192002-11-03 00:24:07 +0000829- Console Baudrate:
830 CONFIG_BAUDRATE - in bps
831 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200832 CONFIG_SYS_BAUDRATE_TABLE, see below.
833 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000834
Heiko Schocherc92fac92009-01-30 12:55:38 +0100835- Console Rx buffer length
836 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
837 the maximum receive buffer length for the SMC.
Heiko Schocher2b3f12c2009-02-10 09:31:47 +0100838 This option is actual only for 82xx and 8xx possible.
Heiko Schocherc92fac92009-01-30 12:55:38 +0100839 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
840 must be defined, to setup the maximum idle timeout for
841 the SMC.
842
Graeme Russ9558b482011-09-01 00:48:27 +0000843- Pre-Console Buffer:
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200844 Prior to the console being initialised (i.e. serial UART
845 initialised etc) all console output is silently discarded.
846 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
847 buffer any console messages prior to the console being
848 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
849 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
850 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
Wolfgang Denk6feff892011-10-09 21:06:34 +0200851 bytes are output before the console is initialised, the
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200852 earlier bytes are discarded.
Graeme Russ9558b482011-09-01 00:48:27 +0000853
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200854 'Sane' compilers will generate smaller code if
855 CONFIG_PRE_CON_BUF_SZ is a power of 2
Graeme Russ9558b482011-09-01 00:48:27 +0000856
Sonny Rao046a37b2011-11-02 09:52:08 +0000857- Safe printf() functions
858 Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
859 the printf() functions. These are defined in
860 include/vsprintf.h and include snprintf(), vsnprintf() and
861 so on. Code size increase is approximately 300-500 bytes.
862 If this option is not given then these functions will
863 silently discard their buffer size argument - this means
864 you are not getting any overflow checking in this case.
865
wdenkc6097192002-11-03 00:24:07 +0000866- Boot Delay: CONFIG_BOOTDELAY - in seconds
867 Delay before automatically booting the default image;
868 set to -1 to disable autoboot.
Joe Hershberger93d72122012-08-17 10:53:12 +0000869 set to -2 to autoboot with no delay and not check for abort
870 (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
wdenkc6097192002-11-03 00:24:07 +0000871
872 See doc/README.autoboot for these options that
873 work with CONFIG_BOOTDELAY. None are required.
874 CONFIG_BOOT_RETRY_TIME
875 CONFIG_BOOT_RETRY_MIN
876 CONFIG_AUTOBOOT_KEYED
877 CONFIG_AUTOBOOT_PROMPT
878 CONFIG_AUTOBOOT_DELAY_STR
879 CONFIG_AUTOBOOT_STOP_STR
880 CONFIG_AUTOBOOT_DELAY_STR2
881 CONFIG_AUTOBOOT_STOP_STR2
882 CONFIG_ZERO_BOOTDELAY_CHECK
883 CONFIG_RESET_TO_RETRY
884
885- Autoboot Command:
886 CONFIG_BOOTCOMMAND
887 Only needed when CONFIG_BOOTDELAY is enabled;
888 define a command string that is automatically executed
889 when no character is read on the console interface
890 within "Boot Delay" after reset.
891
892 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000893 This can be used to pass arguments to the bootm
894 command. The value of CONFIG_BOOTARGS goes into the
895 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000896
897 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000898 The value of these goes into the environment as
899 "ramboot" and "nfsboot" respectively, and can be used
900 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200901 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000902
Heiko Schochereda0ba32013-11-04 14:04:59 +0100903- Bootcount:
904 CONFIG_BOOTCOUNT_LIMIT
905 Implements a mechanism for detecting a repeating reboot
906 cycle, see:
907 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
908
909 CONFIG_BOOTCOUNT_ENV
910 If no softreset save registers are found on the hardware
911 "bootcount" is stored in the environment. To prevent a
912 saveenv on all reboots, the environment variable
913 "upgrade_available" is used. If "upgrade_available" is
914 0, "bootcount" is always 0, if "upgrade_available" is
915 1 "bootcount" is incremented in the environment.
916 So the Userspace Applikation must set the "upgrade_available"
917 and "bootcount" variable to 0, if a boot was successfully.
918
wdenkc6097192002-11-03 00:24:07 +0000919- Pre-Boot Commands:
920 CONFIG_PREBOOT
921
922 When this option is #defined, the existence of the
923 environment variable "preboot" will be checked
924 immediately before starting the CONFIG_BOOTDELAY
925 countdown and/or running the auto-boot command resp.
926 entering interactive mode.
927
928 This feature is especially useful when "preboot" is
929 automatically generated or modified. For an example
930 see the LWMON board specific code: here "preboot" is
931 modified when the user holds down a certain
932 combination of keys on the (special) keyboard when
933 booting the systems
934
935- Serial Download Echo Mode:
936 CONFIG_LOADS_ECHO
937 If defined to 1, all characters received during a
938 serial download (using the "loads" command) are
939 echoed back. This might be needed by some terminal
940 emulations (like "cu"), but may as well just take
941 time on others. This setting #define's the initial
942 value of the "loads_echo" environment variable.
943
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500944- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000945 CONFIG_KGDB_BAUDRATE
946 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200947 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000948
949- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500950 Monitor commands can be included or excluded
951 from the build by using the #include files
Stephen Warrenc6c621b2012-08-05 16:07:19 +0000952 <config_cmd_all.h> and #undef'ing unwanted
953 commands, or using <config_cmd_default.h>
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500954 and augmenting with additional #define's
955 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000956
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500957 The default command configuration includes all commands
958 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000959
Marek Vasutb401b732014-03-05 19:58:39 +0100960 CONFIG_CMD_AES AES 128 CBC encrypt/decrypt
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500961 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500962 CONFIG_CMD_BDI bdinfo
963 CONFIG_CMD_BEDBUG * Include BedBug Debugger
964 CONFIG_CMD_BMP * BMP support
965 CONFIG_CMD_BSP * Board specific commands
966 CONFIG_CMD_BOOTD bootd
Tom Rinid2b2ffe2014-08-14 06:42:36 -0400967 CONFIG_CMD_BOOTI * ARM64 Linux kernel Image support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500968 CONFIG_CMD_CACHE * icache, dcache
Michal Simek08d0d6f2013-11-21 13:39:02 -0800969 CONFIG_CMD_CLK * clock command support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500970 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger710b9932010-12-21 14:19:51 -0500971 CONFIG_CMD_CRC32 * crc32
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500972 CONFIG_CMD_DATE * support for RTC, date/time...
973 CONFIG_CMD_DHCP * DHCP support
974 CONFIG_CMD_DIAG * Diagnostics
Peter Tysera7c93102008-12-17 16:36:22 -0600975 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
976 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
977 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
978 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500979 CONFIG_CMD_DTT * Digital Therm and Thermostat
980 CONFIG_CMD_ECHO echo arguments
Peter Tyser246c6922009-10-25 15:12:56 -0500981 CONFIG_CMD_EDITENV edit env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500982 CONFIG_CMD_EEPROM * EEPROM read/write support
983 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger5e2b3e02012-12-11 22:16:25 -0600984 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergerfffad712012-12-11 22:16:33 -0600985 CONFIG_CMD_ENV_FLAGS * display details about env flags
Andrew Ruder88733e22013-10-22 19:07:34 -0500986 CONFIG_CMD_ENV_EXISTS * check existence of env variable
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500987 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren03e2ecf2012-10-22 06:43:50 +0000988 CONFIG_CMD_EXT2 * ext2 command support
989 CONFIG_CMD_EXT4 * ext4 command support
Stephen Warren16f4d932014-01-24 20:46:37 -0700990 CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls)
991 that work for multiple fs types
Christian Gmeiner59e890e2014-11-12 14:35:04 +0100992 CONFIG_CMD_FS_UUID * Look up a filesystem UUID
Mike Frysingerbdab39d2009-01-28 19:08:14 -0500993 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500994 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren03e2ecf2012-10-22 06:43:50 +0000995 CONFIG_CMD_FAT * FAT command support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500996 CONFIG_CMD_FLASH flinfo, erase, protect
997 CONFIG_CMD_FPGA FPGA device initialization support
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200998 CONFIG_CMD_FUSE * Device fuse support
Anton Staaf53fdc7e2012-12-05 14:46:29 +0000999 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysingera641b972010-12-26 23:32:22 -05001000 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsa000b792011-04-05 07:15:14 +00001001 CONFIG_CMD_GREPENV * search environment
Simon Glassbf36c5d2012-12-05 14:46:38 +00001002 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001003 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
1004 CONFIG_CMD_I2C * I2C serial bus support
1005 CONFIG_CMD_IDE * IDE harddisk support
1006 CONFIG_CMD_IMI iminfo
Vipin Kumar8fdf1e02012-12-16 22:32:48 +00001007 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001008 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001009 CONFIG_CMD_IMMAP * IMMR dump support
Simon Glassaa532332014-06-11 23:29:41 -06001010 CONFIG_CMD_IOTRACE * I/O tracing for debugging
Mike Frysinger0c79cda2010-12-26 23:09:45 -05001011 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershbergerc167cc02012-10-03 11:15:51 +00001012 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001013 CONFIG_CMD_IRQ * irqinfo
1014 CONFIG_CMD_ITEST Integer/string test of 2 values
1015 CONFIG_CMD_JFFS2 * JFFS2 Support
1016 CONFIG_CMD_KGDB * kgdb
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001017 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerd22c3382012-05-23 08:00:12 +00001018 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
1019 (169.254.*.*)
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001020 CONFIG_CMD_LOADB loadb
1021 CONFIG_CMD_LOADS loads
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001022 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz02c9aa12009-07-27 00:07:59 -04001023 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glass15a33e42012-11-30 13:01:20 +00001024 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001025 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denka2681702013-03-08 10:51:32 +00001026 loop, loopw
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001027 CONFIG_CMD_MEMTEST * mtest
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001028 CONFIG_CMD_MISC Misc functions like sleep etc
1029 CONFIG_CMD_MMC * MMC memory mapped support
1030 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +01001031 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001032 CONFIG_CMD_NAND * NAND support
1033 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001034 CONFIG_CMD_NFS NFS support
Peter Tysere92739d2008-12-17 16:36:21 -06001035 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001036 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001037 CONFIG_CMD_PCI * pciinfo
1038 CONFIG_CMD_PCMCIA * PCMCIA support
1039 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
1040 host
1041 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersff048ea2012-12-05 14:46:30 +00001042 CONFIG_CMD_READ * Read raw data from partition
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001043 CONFIG_CMD_REGINFO * Register dump
1044 CONFIG_CMD_RUN run command in env variable
Simon Glassd3049312012-12-26 09:53:36 +00001045 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001046 CONFIG_CMD_SAVES * save S record dump
1047 CONFIG_CMD_SCSI * SCSI Support
1048 CONFIG_CMD_SDRAM * print SDRAM configuration information
1049 (requires CONFIG_CMD_I2C)
1050 CONFIG_CMD_SETGETDCR Support for DCR Register access
1051 (4xx only)
Eric Nelsonf61ec452012-01-31 10:52:08 -07001052 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001053 CONFIG_CMD_SHA1SUM * print sha1 memory digest
Robin Getz02c9aa12009-07-27 00:07:59 -04001054 (requires CONFIG_CMD_MEMORY)
Bob Liu7d861d92013-02-05 19:05:41 +08001055 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02001056 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001057 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7a83af02011-05-17 00:03:40 +00001058 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass1fb7cd42011-10-24 18:00:07 +00001059 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershbergerda83bcd2012-10-03 12:14:57 +00001060 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
1061 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001062 CONFIG_CMD_USB * USB support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001063 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasutc8339f52012-03-31 07:47:16 +00001064 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001065 CONFIG_CMD_XIMG Load part of Multi Image
Przemyslaw Marczak89c82302014-04-02 10:20:05 +02001066 CONFIG_CMD_UUID * Generate random UUID or GUID string
wdenkc6097192002-11-03 00:24:07 +00001067
1068 EXAMPLE: If you want all functions except of network
1069 support you can write:
1070
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001071 #include "config_cmd_all.h"
1072 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +00001073
Gerald Van Baren213bf8c2007-03-31 12:23:51 -04001074 Other Commands:
1075 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +00001076
1077 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001078 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +00001079 what you (and your U-Boot users) are doing. Data
1080 cache cannot be enabled on systems like the 8xx or
1081 8260 (where accesses to the IMMR region must be
1082 uncached), and it cannot be disabled on all other
1083 systems where we (mis-) use the data cache to hold an
1084 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +00001085
1086
1087 XXX - this list needs to get updated!
1088
Wolfgang Denka5ecbe62013-03-23 23:50:31 +00001089- Regular expression support:
1090 CONFIG_REGEX
Wolfgang Denk93e14592013-10-04 17:43:24 +02001091 If this variable is defined, U-Boot is linked against
1092 the SLRE (Super Light Regular Expression) library,
1093 which adds regex support to some commands, as for
1094 example "env grep" and "setexpr".
Wolfgang Denka5ecbe62013-03-23 23:50:31 +00001095
Simon Glass45ba8072011-10-15 05:48:20 +00001096- Device tree:
1097 CONFIG_OF_CONTROL
1098 If this variable is defined, U-Boot will use a device tree
1099 to configure its devices, instead of relying on statically
1100 compiled #defines in the board file. This option is
1101 experimental and only available on a few boards. The device
1102 tree is available in the global data as gd->fdt_blob.
1103
Simon Glass2c0f79e2011-10-24 19:15:31 +00001104 U-Boot needs to get its device tree from somewhere. This can
1105 be done using one of the two options below:
Simon Glassbbb0b122011-10-15 05:48:21 +00001106
1107 CONFIG_OF_EMBED
1108 If this variable is defined, U-Boot will embed a device tree
1109 binary in its image. This device tree file should be in the
1110 board directory and called <soc>-<board>.dts. The binary file
1111 is then picked up in board_init_f() and made available through
1112 the global data structure as gd->blob.
Simon Glass45ba8072011-10-15 05:48:20 +00001113
Simon Glass2c0f79e2011-10-24 19:15:31 +00001114 CONFIG_OF_SEPARATE
1115 If this variable is defined, U-Boot will build a device tree
1116 binary. It will be called u-boot.dtb. Architecture-specific
1117 code will locate it at run-time. Generally this works by:
1118
1119 cat u-boot.bin u-boot.dtb >image.bin
1120
1121 and in fact, U-Boot does this for you, creating a file called
1122 u-boot-dtb.bin which is useful in the common case. You can
1123 still use the individual files if you need something more
1124 exotic.
1125
wdenkc6097192002-11-03 00:24:07 +00001126- Watchdog:
1127 CONFIG_WATCHDOG
1128 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +00001129 support for the SoC. There must be support in the SoC
1130 specific code for a watchdog. For the 8xx and 8260
1131 CPUs, the SIU Watchdog feature is enabled in the SYPCR
1132 register. When supported for a specific SoC is
1133 available, then no further board specific code should
1134 be needed to use it.
1135
1136 CONFIG_HW_WATCHDOG
1137 When using a watchdog circuitry external to the used
1138 SoC, then define this variable and provide board
1139 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +00001140
stroesec1551ea2003-04-04 15:53:41 +00001141- U-Boot Version:
1142 CONFIG_VERSION_VARIABLE
1143 If this variable is defined, an environment variable
1144 named "ver" is created by U-Boot showing the U-Boot
1145 version as printed by the "version" command.
Benoît Thébaudeaua1ea8e52012-08-13 15:01:14 +02001146 Any change to this variable will be reverted at the
1147 next reset.
stroesec1551ea2003-04-04 15:53:41 +00001148
wdenkc6097192002-11-03 00:24:07 +00001149- Real-Time Clock:
1150
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001151 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +00001152 has to be selected, too. Define exactly one of the
1153 following options:
1154
1155 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1156 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam4e8b7542011-10-24 06:44:15 +00001157 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001158 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +00001159 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001160 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +00001161 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel412921d2014-07-21 11:06:16 +02001162 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenk3bac3512003-03-12 10:41:04 +00001163 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +01001164 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +00001165 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001166 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +02001167 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1168 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001169
wdenkb37c7e52003-06-30 16:24:52 +00001170 Note that if the RTC uses I2C, then the I2C interface
1171 must also be configured. See I2C Support, below.
1172
Peter Tysere92739d2008-12-17 16:36:21 -06001173- GPIO Support:
1174 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tysere92739d2008-12-17 16:36:21 -06001175
Chris Packham5dec49c2010-12-19 10:12:13 +00001176 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1177 chip-ngpio pairs that tell the PCA953X driver the number of
1178 pins supported by a particular chip.
1179
Peter Tysere92739d2008-12-17 16:36:21 -06001180 Note that if the GPIO device uses I2C, then the I2C interface
1181 must also be configured. See I2C Support, below.
1182
Simon Glassaa532332014-06-11 23:29:41 -06001183- I/O tracing:
1184 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
1185 accesses and can checksum them or write a list of them out
1186 to memory. See the 'iotrace' command for details. This is
1187 useful for testing device drivers since it can confirm that
1188 the driver behaves the same way before and after a code
1189 change. Currently this is supported on sandbox and arm. To
1190 add support for your architecture, add '#include <iotrace.h>'
1191 to the bottom of arch/<arch>/include/asm/io.h and test.
1192
1193 Example output from the 'iotrace stats' command is below.
1194 Note that if the trace buffer is exhausted, the checksum will
1195 still continue to operate.
1196
1197 iotrace is enabled
1198 Start: 10000000 (buffer start address)
1199 Size: 00010000 (buffer size)
1200 Offset: 00000120 (current buffer offset)
1201 Output: 10000120 (start + offset)
1202 Count: 00000018 (number of trace records)
1203 CRC32: 9526fb66 (CRC32 of all trace records)
1204
wdenkc6097192002-11-03 00:24:07 +00001205- Timestamp Support:
1206
wdenk43d96162003-03-06 00:02:04 +00001207 When CONFIG_TIMESTAMP is selected, the timestamp
1208 (date and time) of an image is printed by image
1209 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001210 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001211
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001212- Partition Labels (disklabels) Supported:
1213 Zero or more of the following:
1214 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1215 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1216 Intel architecture, USB sticks, etc.
1217 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1218 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1219 bootloader. Note 2TB partition limit; see
1220 disk/part_efi.c
1221 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001222
Wolfgang Denk218ca722008-03-26 10:40:12 +01001223 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1224 CONFIG_CMD_SCSI) you must configure support for at
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001225 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001226
1227- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +00001228 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1229 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001230
wdenk4d13cba2004-03-14 14:09:05 +00001231 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1232 be performed by calling the function
1233 ide_set_reset(int reset)
1234 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001235
1236- ATAPI Support:
1237 CONFIG_ATAPI
1238
1239 Set this to enable ATAPI support.
1240
wdenkc40b2952004-03-13 23:29:43 +00001241- LBA48 Support
1242 CONFIG_LBA48
1243
1244 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +01001245 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +00001246 Whithout these , LBA48 support uses 32bit variables and will 'only'
1247 support disks up to 2.1TB.
1248
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001249 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +00001250 When enabled, makes the IDE subsystem use 64bit sector addresses.
1251 Default is 32bit.
1252
wdenkc6097192002-11-03 00:24:07 +00001253- SCSI Support:
1254 At the moment only there is only support for the
1255 SYM53C8XX SCSI controller; define
1256 CONFIG_SCSI_SYM53C8XX to enable it.
1257
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001258 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1259 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1260 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001261 maximum numbers of LUNs, SCSI ID's and target
1262 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001263 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001264
Wolfgang Denk93e14592013-10-04 17:43:24 +02001265 The environment variable 'scsidevs' is set to the number of
1266 SCSI devices found during the last scan.
Stefan Reinauer447c0312012-10-29 05:23:48 +00001267
wdenkc6097192002-11-03 00:24:07 +00001268- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +00001269 CONFIG_E1000
Kyle Moffettce5207e2011-10-18 11:05:29 +00001270 Support for Intel 8254x/8257x gigabit chips.
1271
1272 CONFIG_E1000_SPI
1273 Utility code for direct access to the SPI bus on Intel 8257x.
1274 This does not do anything useful unless you set at least one
1275 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1276
1277 CONFIG_E1000_SPI_GENERIC
1278 Allow generic access to the SPI bus on the Intel 8257x, for
1279 example with the "sspi" command.
1280
1281 CONFIG_CMD_E1000
1282 Management command for E1000 devices. When used on devices
1283 with SPI support you can reprogram the EEPROM from U-Boot.
stroese53cf9432003-06-05 15:39:44 +00001284
Andre Schwarzac3315c2008-03-06 16:45:44 +01001285 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001286 default MAC for empty EEPROM after production.
Andre Schwarzac3315c2008-03-06 16:45:44 +01001287
wdenkc6097192002-11-03 00:24:07 +00001288 CONFIG_EEPRO100
1289 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001290 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001291 write routine for first time initialisation.
1292
1293 CONFIG_TULIP
1294 Support for Digital 2114x chips.
1295 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1296 modem chip initialisation (KS8761/QS6611).
1297
1298 CONFIG_NATSEMI
1299 Support for National dp83815 chips.
1300
1301 CONFIG_NS8382X
1302 Support for National dp8382[01] gigabit chips.
1303
wdenk45219c42003-05-12 21:50:16 +00001304- NETWORK Support (other):
1305
Jens Scharsigc041e9d2010-01-23 12:03:45 +01001306 CONFIG_DRIVER_AT91EMAC
1307 Support for AT91RM9200 EMAC.
1308
1309 CONFIG_RMII
1310 Define this to use reduced MII inteface
1311
1312 CONFIG_DRIVER_AT91EMAC_QUIET
1313 If this defined, the driver is quiet.
1314 The driver doen't show link status messages.
1315
Rob Herringefdd7312011-12-15 11:15:49 +00001316 CONFIG_CALXEDA_XGMAC
1317 Support for the Calxeda XGMAC device
1318
Ashok3bb46d22012-10-15 06:20:47 +00001319 CONFIG_LAN91C96
wdenk45219c42003-05-12 21:50:16 +00001320 Support for SMSC's LAN91C96 chips.
1321
1322 CONFIG_LAN91C96_BASE
1323 Define this to hold the physical address
1324 of the LAN91C96's I/O space
1325
1326 CONFIG_LAN91C96_USE_32_BIT
1327 Define this to enable 32 bit addressing
1328
Ashok3bb46d22012-10-15 06:20:47 +00001329 CONFIG_SMC91111
wdenkf39748a2004-06-09 13:37:52 +00001330 Support for SMSC's LAN91C111 chip
1331
1332 CONFIG_SMC91111_BASE
1333 Define this to hold the physical address
1334 of the device (I/O space)
1335
1336 CONFIG_SMC_USE_32_BIT
1337 Define this if data bus is 32 bits
1338
1339 CONFIG_SMC_USE_IOFUNCS
1340 Define this to use i/o functions instead of macros
1341 (some hardware wont work with macros)
1342
Heiko Schocherdc02bad2011-11-15 10:00:04 -05001343 CONFIG_DRIVER_TI_EMAC
1344 Support for davinci emac
1345
1346 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1347 Define this if you have more then 3 PHYs.
1348
Macpaul Linb3dbf4a52010-12-21 16:59:46 +08001349 CONFIG_FTGMAC100
1350 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1351
1352 CONFIG_FTGMAC100_EGIGA
1353 Define this to use GE link update with gigabit PHY.
1354 Define this if FTGMAC100 is connected to gigabit PHY.
1355 If your system has 10/100 PHY only, it might not occur
1356 wrong behavior. Because PHY usually return timeout or
1357 useless data when polling gigabit status and gigabit
1358 control registers. This behavior won't affect the
1359 correctnessof 10/100 link speed update.
1360
Mike Rapoportc2fff332009-11-11 10:03:03 +02001361 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +02001362 Support for SMSC's LAN911x and LAN921x chips
1363
Mike Rapoportc2fff332009-11-11 10:03:03 +02001364 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +02001365 Define this to hold the physical address
1366 of the device (I/O space)
1367
Mike Rapoportc2fff332009-11-11 10:03:03 +02001368 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001369 Define this if data bus is 32 bits
1370
Mike Rapoportc2fff332009-11-11 10:03:03 +02001371 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001372 Define this if data bus is 16 bits. If your processor
1373 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +02001374 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +02001375
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +09001376 CONFIG_SH_ETHER
1377 Support for Renesas on-chip Ethernet controller
1378
1379 CONFIG_SH_ETHER_USE_PORT
1380 Define the number of ports to be used
1381
1382 CONFIG_SH_ETHER_PHY_ADDR
1383 Define the ETH PHY's address
1384
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +09001385 CONFIG_SH_ETHER_CACHE_WRITEBACK
1386 If this option is set, the driver enables cache flush.
1387
Heiko Schocherb2f97cf2014-07-18 06:07:19 +02001388- PWM Support:
1389 CONFIG_PWM_IMX
1390 Support for PWM modul on the imx6.
1391
Vadim Bendebury5e124722011-10-17 08:36:14 +00001392- TPM Support:
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001393 CONFIG_TPM
1394 Support TPM devices.
1395
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +00001396 CONFIG_TPM_TIS_I2C
1397 Support for i2c bus TPM devices. Only one device
1398 per system is supported at this time.
1399
1400 CONFIG_TPM_TIS_I2C_BUS_NUMBER
1401 Define the the i2c bus number for the TPM device
1402
1403 CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
1404 Define the TPM's address on the i2c bus
1405
1406 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1407 Define the burst count bytes upper limit
1408
Dirk Eibachc01939c2013-06-26 15:55:15 +02001409 CONFIG_TPM_ATMEL_TWI
1410 Support for Atmel TWI TPM device. Requires I2C support.
1411
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001412 CONFIG_TPM_TIS_LPC
Vadim Bendebury5e124722011-10-17 08:36:14 +00001413 Support for generic parallel port TPM devices. Only one device
1414 per system is supported at this time.
1415
1416 CONFIG_TPM_TIS_BASE_ADDRESS
1417 Base address where the generic TPM device is mapped
1418 to. Contemporary x86 systems usually map it at
1419 0xfed40000.
1420
Reinhard Pfaube6c1522013-06-26 15:55:13 +02001421 CONFIG_CMD_TPM
1422 Add tpm monitor functions.
1423 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1424 provides monitor access to authorized functions.
1425
1426 CONFIG_TPM
1427 Define this to enable the TPM support library which provides
1428 functional interfaces to some TPM commands.
1429 Requires support for a TPM device.
1430
1431 CONFIG_TPM_AUTH_SESSIONS
1432 Define this to enable authorized functions in the TPM library.
1433 Requires CONFIG_TPM and CONFIG_SHA1.
1434
wdenkc6097192002-11-03 00:24:07 +00001435- USB Support:
1436 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +00001437 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001438 CONFIG_USB_UHCI to enable it.
1439 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +00001440 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001441 storage devices.
1442 Note:
1443 Supported are USB Keyboards and USB Floppy drives
1444 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +00001445 MPC5200 USB requires additional defines:
1446 CONFIG_USB_CLOCK
1447 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001448 CONFIG_PSC3_USB
1449 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +00001450 CONFIG_USB_CONFIG
1451 for differential drivers: 0x00001000
1452 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001453 for differential drivers on PSC3: 0x00000100
1454 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001455 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +02001456 May be defined to allow interrupt polling
1457 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +00001458
Simon Glass9ab4ce22012-02-27 10:52:47 +00001459 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1460 txfilltuning field in the EHCI controller on reset.
1461
Oleksandr Tymoshenko6e9e0622014-02-01 21:51:25 -07001462 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1463 HW module registers.
1464
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001465- USB Device:
1466 Define the below if you wish to use the USB console.
1467 Once firmware is rebuilt from a serial console issue the
1468 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001469 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001470 it has found a new device. The environment variable usbtty
1471 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +02001472 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001473 Common Device Class Abstract Control Model serial device.
1474 If you select usbtty = gserial you should be able to enumerate
1475 a Linux host by
1476 # modprobe usbserial vendor=0xVendorID product=0xProductID
1477 else if using cdc_acm, simply setting the environment
1478 variable usbtty to be cdc_acm should suffice. The following
1479 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001480
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001481 CONFIG_USB_DEVICE
1482 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +00001483
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001484 CONFIG_USB_TTY
1485 Define this to have a tty type of device available to
1486 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +02001487
Vipin KUMARf9da0f82012-03-26 15:38:06 +05301488 CONFIG_USBD_HS
1489 Define this to enable the high speed support for usb
1490 device and usbtty. If this feature is enabled, a routine
1491 int is_usbd_high_speed(void)
1492 also needs to be defined by the driver to dynamically poll
1493 whether the enumeration has succeded at high speed or full
1494 speed.
1495
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001496 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001497 Define this if you want stdin, stdout &/or stderr to
1498 be set to usbtty.
1499
1500 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001501 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001502 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001503 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +02001504
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001505 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001506 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001507 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001508
Wolfgang Denk386eda02006-06-14 18:14:56 +02001509 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001510 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001511 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001512 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1513 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1514 should pretend to be a Linux device to it's target host.
1515
1516 CONFIG_USBD_MANUFACTURER
1517 Define this string as the name of your company for
1518 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001519
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001520 CONFIG_USBD_PRODUCT_NAME
1521 Define this string as the name of your product
1522 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1523
1524 CONFIG_USBD_VENDORID
1525 Define this as your assigned Vendor ID from the USB
1526 Implementors Forum. This *must* be a genuine Vendor ID
1527 to avoid polluting the USB namespace.
1528 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001529
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001530 CONFIG_USBD_PRODUCTID
1531 Define this as the unique Product ID
1532 for your device
1533 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001534
Igor Grinbergd70a5602011-12-12 12:08:35 +02001535- ULPI Layer Support:
1536 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1537 the generic ULPI layer. The generic layer accesses the ULPI PHY
1538 via the platform viewport, so you need both the genric layer and
1539 the viewport enabled. Currently only Chipidea/ARC based
1540 viewport is supported.
1541 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1542 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stach6d365ea2012-10-01 00:44:35 +02001543 If your ULPI phy needs a different reference clock than the
1544 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1545 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001546
1547- MMC Support:
1548 The MMC controller on the Intel PXA is supported. To
1549 enable this define CONFIG_MMC. The MMC can be
1550 accessed from the boot prompt by mapping the device
1551 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001552 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1553 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001554
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +00001555 CONFIG_SH_MMCIF
1556 Support for Renesas on-chip MMCIF controller
1557
1558 CONFIG_SH_MMCIF_ADDR
1559 Define the base address of MMCIF registers
1560
1561 CONFIG_SH_MMCIF_CLK
1562 Define the clock frequency for MMCIF
1563
Pierre Aubert1fd93c62014-04-24 10:30:08 +02001564 CONFIG_GENERIC_MMC
1565 Enable the generic MMC driver
1566
1567 CONFIG_SUPPORT_EMMC_BOOT
1568 Enable some additional features of the eMMC boot partitions.
1569
1570 CONFIG_SUPPORT_EMMC_RPMB
1571 Enable the commands for reading, writing and programming the
1572 key for the Replay Protection Memory Block partition in eMMC.
1573
Tom Rinib3ba6e92013-03-14 05:32:47 +00001574- USB Device Firmware Update (DFU) class support:
1575 CONFIG_DFU_FUNCTION
1576 This enables the USB portion of the DFU USB class
1577
1578 CONFIG_CMD_DFU
1579 This enables the command "dfu" which is used to have
1580 U-Boot create a DFU class device via USB. This command
1581 requires that the "dfu_alt_info" environment variable be
1582 set and define the alt settings to expose to the host.
1583
1584 CONFIG_DFU_MMC
1585 This enables support for exposing (e)MMC devices via DFU.
1586
Pantelis Antoniouc6631762013-03-14 05:32:52 +00001587 CONFIG_DFU_NAND
1588 This enables support for exposing NAND devices via DFU.
1589
Afzal Mohammeda9479f02013-09-18 01:15:24 +05301590 CONFIG_DFU_RAM
1591 This enables support for exposing RAM via DFU.
1592 Note: DFU spec refer to non-volatile memory usage, but
1593 allow usages beyond the scope of spec - here RAM usage,
1594 one that would help mostly the developer.
1595
Heiko Schochere7e75c72013-06-12 06:05:51 +02001596 CONFIG_SYS_DFU_DATA_BUF_SIZE
1597 Dfu transfer uses a buffer before writing data to the
1598 raw storage device. Make the size (in bytes) of this buffer
1599 configurable. The size of this buffer is also configurable
1600 through the "dfu_bufsiz" environment variable.
1601
Pantelis Antoniouea2453d2013-03-14 05:32:48 +00001602 CONFIG_SYS_DFU_MAX_FILE_SIZE
1603 When updating files rather than the raw storage device,
1604 we use a static buffer to copy the file into and then write
1605 the buffer once we've been given the whole file. Define
1606 this to the maximum filesize (in bytes) for the buffer.
1607 Default is 4 MiB if undefined.
1608
Heiko Schocher001a8312014-03-18 08:09:56 +01001609 DFU_DEFAULT_POLL_TIMEOUT
1610 Poll timeout [ms], is the timeout a device can send to the
1611 host. The host must wait for this timeout before sending
1612 a subsequent DFU_GET_STATUS request to the device.
1613
1614 DFU_MANIFEST_POLL_TIMEOUT
1615 Poll timeout [ms], which the device sends to the host when
1616 entering dfuMANIFEST state. Host waits this timeout, before
1617 sending again an USB request to the device.
1618
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001619- USB Device Android Fastboot support:
1620 CONFIG_CMD_FASTBOOT
1621 This enables the command "fastboot" which enables the Android
1622 fastboot mode for the platform's USB device. Fastboot is a USB
1623 protocol for downloading images, flashing and device control
1624 used on Android devices.
1625 See doc/README.android-fastboot for more information.
1626
1627 CONFIG_ANDROID_BOOT_IMAGE
1628 This enables support for booting images which use the Android
1629 image format header.
1630
1631 CONFIG_USB_FASTBOOT_BUF_ADDR
1632 The fastboot protocol requires a large memory buffer for
1633 downloads. Define this to the starting RAM address to use for
1634 downloaded images.
1635
1636 CONFIG_USB_FASTBOOT_BUF_SIZE
1637 The fastboot protocol requires a large memory buffer for
1638 downloads. This buffer should be as large as possible for a
1639 platform. Define this to the size available RAM for fastboot.
1640
Steve Raed1b5ed02014-08-26 11:47:28 -07001641 CONFIG_FASTBOOT_FLASH
1642 The fastboot protocol includes a "flash" command for writing
1643 the downloaded image to a non-volatile storage device. Define
1644 this to enable the "fastboot flash" command.
1645
1646 CONFIG_FASTBOOT_FLASH_MMC_DEV
1647 The fastboot "flash" command requires additional information
1648 regarding the non-volatile storage device. Define this to
1649 the eMMC device that fastboot should use to store the image.
1650
wdenk6705d812004-08-02 23:22:59 +00001651- Journaling Flash filesystem support:
1652 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1653 CONFIG_JFFS2_NAND_DEV
1654 Define these for a default partition on a NAND device
1655
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001656 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1657 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001658 Define these for a default partition on a NOR device
1659
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001660 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +00001661 Define this to create an own partition. You have to provide a
1662 function struct part_info* jffs2_part_info(int part_num)
1663
1664 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001665 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +00001666 to disable the command chpart. This is the default when you
1667 have not defined a custom partition
1668
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001669- FAT(File Allocation Table) filesystem write function support:
1670 CONFIG_FAT_WRITE
Donggeun Kim656f4c62012-03-22 04:38:56 +00001671
1672 Define this to enable support for saving memory data as a
1673 file in FAT formatted partition.
1674
1675 This will also enable the command "fatwrite" enabling the
1676 user to write files to FAT.
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001677
Gabe Black84cd9322012-10-12 14:26:11 +00001678CBFS (Coreboot Filesystem) support
1679 CONFIG_CMD_CBFS
1680
1681 Define this to enable support for reading from a Coreboot
1682 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1683 and cbfsload.
1684
Siva Durga Prasad Paladugu4f0d1a22014-05-26 19:18:37 +05301685- FAT(File Allocation Table) filesystem cluster size:
1686 CONFIG_FS_FAT_MAX_CLUSTSIZE
1687
1688 Define the max cluster size for fat operations else
1689 a default value of 65536 will be defined.
1690
wdenkc6097192002-11-03 00:24:07 +00001691- Keyboard Support:
1692 CONFIG_ISA_KEYBOARD
1693
1694 Define this to enable standard (PC-Style) keyboard
1695 support
1696
1697 CONFIG_I8042_KBD
1698 Standard PC keyboard driver with US (is default) and
1699 GERMAN key layout (switch via environment 'keymap=de') support.
1700 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1701 for cfb_console. Supports cursor blinking.
1702
Hung-ying Tyan713cb682013-05-15 18:27:32 +08001703 CONFIG_CROS_EC_KEYB
1704 Enables a Chrome OS keyboard using the CROS_EC interface.
1705 This uses CROS_EC to communicate with a second microcontroller
1706 which provides key scans on request.
1707
wdenkc6097192002-11-03 00:24:07 +00001708- Video support:
1709 CONFIG_VIDEO
1710
1711 Define this to enable video support (for output to
1712 video).
1713
1714 CONFIG_VIDEO_CT69000
1715
1716 Enable Chips & Technologies 69000 Video chip
1717
1718 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +00001719 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +00001720 video output is selected via environment 'videoout'
1721 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1722 assumed.
wdenkc6097192002-11-03 00:24:07 +00001723
wdenkb79a11c2004-03-25 15:14:43 +00001724 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001725 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +00001726 are possible:
1727 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +00001728 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +00001729
1730 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1731 -------------+---------------------------------------------
1732 8 bits | 0x301* 0x303 0x305 0x161 0x307
1733 15 bits | 0x310 0x313 0x316 0x162 0x319
1734 16 bits | 0x311 0x314 0x317 0x163 0x31A
1735 24 bits | 0x312 0x315 0x318 ? 0x31B
1736 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001737 (i.e. setenv videomode 317; saveenv; reset;)
1738
wdenkb79a11c2004-03-25 15:14:43 +00001739 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001740 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +00001741
1742
stroesec1551ea2003-04-04 15:53:41 +00001743 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001744 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001745 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1746 or CONFIG_VIDEO_SED13806_16BPP
1747
Timur Tabi7d3053f2011-02-15 17:09:19 -06001748 CONFIG_FSL_DIU_FB
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02001749 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi7d3053f2011-02-15 17:09:19 -06001750 SOCs that have a DIU should define this macro to enable DIU
1751 support, and should also define these other macros:
1752
1753 CONFIG_SYS_DIU_ADDR
1754 CONFIG_VIDEO
1755 CONFIG_CMD_BMP
1756 CONFIG_CFB_CONSOLE
1757 CONFIG_VIDEO_SW_CURSOR
1758 CONFIG_VGA_AS_SINGLE_DEVICE
1759 CONFIG_VIDEO_LOGO
1760 CONFIG_VIDEO_BMP_LOGO
1761
Timur Tabiba8e76b2011-04-11 14:18:22 -05001762 The DIU driver will look for the 'video-mode' environment
1763 variable, and if defined, enable the DIU as a console during
1764 boot. See the documentation file README.video for a
1765 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001766
Simon Glass058d59b2012-12-03 13:59:47 +00001767 CONFIG_VIDEO_VGA
1768
1769 Enable the VGA video / BIOS for x86. The alternative if you
1770 are using coreboot is to use the coreboot frame buffer
1771 driver.
1772
1773
wdenk682011f2003-06-03 23:54:09 +00001774- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +00001775 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +00001776
wdenk8bde7f72003-06-27 21:31:46 +00001777 Define this to enable a custom keyboard support.
1778 This simply calls drv_keyboard_init() which must be
1779 defined in your board-specific files.
1780 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +00001781
wdenkc6097192002-11-03 00:24:07 +00001782- LCD Support: CONFIG_LCD
1783
1784 Define this to enable LCD support (for output to LCD
1785 display); also select one of the supported displays
1786 by defining one of these:
1787
Stelian Pop39cf4802008-05-09 21:57:18 +02001788 CONFIG_ATMEL_LCD:
1789
1790 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1791
wdenkfd3103b2003-11-25 16:55:19 +00001792 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001793
wdenkfd3103b2003-11-25 16:55:19 +00001794 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001795
wdenkfd3103b2003-11-25 16:55:19 +00001796 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001797
wdenkfd3103b2003-11-25 16:55:19 +00001798 NEC NL6448BC20-08. 6.5", 640x480.
1799 Active, color, single scan.
1800
1801 CONFIG_NEC_NL6448BC33_54
1802
1803 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001804 Active, color, single scan.
1805
1806 CONFIG_SHARP_16x9
1807
1808 Sharp 320x240. Active, color, single scan.
1809 It isn't 16x9, and I am not sure what it is.
1810
1811 CONFIG_SHARP_LQ64D341
1812
1813 Sharp LQ64D341 display, 640x480.
1814 Active, color, single scan.
1815
1816 CONFIG_HLD1045
1817
1818 HLD1045 display, 640x480.
1819 Active, color, single scan.
1820
1821 CONFIG_OPTREX_BW
1822
1823 Optrex CBL50840-2 NF-FW 99 22 M5
1824 or
1825 Hitachi LMG6912RPFC-00T
1826 or
1827 Hitachi SP14Q002
1828
1829 320x240. Black & white.
1830
1831 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001832 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001833
Simon Glass676d3192012-10-17 13:24:54 +00001834 CONFIG_LCD_ALIGNMENT
1835
1836 Normally the LCD is page-aligned (tyically 4KB). If this is
1837 defined then the LCD will be aligned to this value instead.
1838 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1839 here, since it is cheaper to change data cache settings on
1840 a per-section basis.
1841
Simon Glass0d89efe2012-10-17 13:24:59 +00001842 CONFIG_CONSOLE_SCROLL_LINES
1843
1844 When the console need to be scrolled, this is the number of
1845 lines to scroll by. It defaults to 1. Increasing this makes
1846 the console jump but can help speed up operation when scrolling
1847 is slow.
Simon Glass676d3192012-10-17 13:24:54 +00001848
Tom Wai-Hong Tam45d7f522012-09-28 15:11:16 +00001849 CONFIG_LCD_BMP_RLE8
1850
1851 Support drawing of RLE8-compressed bitmaps on the LCD.
1852
Tom Wai-Hong Tam735987c2012-12-05 14:46:40 +00001853 CONFIG_I2C_EDID
1854
1855 Enables an 'i2c edid' command which can read EDID
1856 information over I2C from an attached LCD display.
1857
wdenk7152b1d2003-09-05 23:19:14 +00001858- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001859
wdenk8bde7f72003-06-27 21:31:46 +00001860 If this option is set, the environment is checked for
1861 a variable "splashimage". If found, the usual display
1862 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001863 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001864 specified in "splashimage" is loaded instead. The
1865 console is redirected to the "nulldev", too. This
1866 allows for a "silent" boot where a splash screen is
1867 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001868
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001869 CONFIG_SPLASHIMAGE_GUARD
1870
1871 If this option is set, then U-Boot will prevent the environment
1872 variable "splashimage" from being set to a problematic address
Tom Rini1551df32014-02-25 10:27:01 -05001873 (see README.displaying-bmps).
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001874 This option is useful for targets where, due to alignment
1875 restrictions, an improperly aligned BMP image will cause a data
1876 abort. If you think you will not have problems with unaligned
1877 accesses (for example because your toolchain prevents them)
1878 there is no need to set this option.
1879
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001880 CONFIG_SPLASH_SCREEN_ALIGN
1881
1882 If this option is set the splash image can be freely positioned
1883 on the screen. Environment variable "splashpos" specifies the
1884 position as "x,y". If a positive number is given it is used as
1885 number of pixel from left/top. If a negative number is given it
1886 is used as number of pixel from right/bottom. You can also
1887 specify 'm' for centering the image.
1888
1889 Example:
1890 setenv splashpos m,m
1891 => image at center of screen
1892
1893 setenv splashpos 30,20
1894 => image at x = 30 and y = 20
1895
1896 setenv splashpos -10,m
1897 => vertically centered image
1898 at x = dspWidth - bmpWidth - 9
1899
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001900- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1901
1902 If this option is set, additionally to standard BMP
1903 images, gzipped BMP images can be displayed via the
1904 splashscreen support or the bmp command.
1905
Anatolij Gustschind5011762010-03-15 14:50:25 +01001906- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1907
1908 If this option is set, 8-bit RLE compressed BMP images
1909 can be displayed via the splashscreen support or the
1910 bmp command.
1911
Lei Wenf2b96df2012-09-28 04:26:47 +00001912- Do compresssing for memory range:
1913 CONFIG_CMD_ZIP
1914
1915 If this option is set, it would use zlib deflate method
1916 to compress the specified memory at its best effort.
1917
wdenkc29fdfc2003-08-29 20:57:53 +00001918- Compression support:
Kees Cook8ef70472013-08-16 07:59:12 -07001919 CONFIG_GZIP
1920
1921 Enabled by default to support gzip compressed images.
1922
wdenkc29fdfc2003-08-29 20:57:53 +00001923 CONFIG_BZIP2
1924
1925 If this option is set, support for bzip2 compressed
1926 images is included. If not, only uncompressed and gzip
1927 compressed images are supported.
1928
wdenk42d1f032003-10-15 23:53:47 +00001929 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001930 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001931 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001932
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001933 CONFIG_LZMA
1934
1935 If this option is set, support for lzma compressed
1936 images is included.
1937
1938 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1939 requires an amount of dynamic memory that is given by the
1940 formula:
1941
1942 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1943
1944 Where lc and lp stand for, respectively, Literal context bits
1945 and Literal pos bits.
1946
1947 This value is upper-bounded by 14MB in the worst case. Anyway,
1948 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1949 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1950 a very small buffer.
1951
1952 Use the lzmainfo tool to determinate the lc and lp values and
1953 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001954 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001955
Kees Cook8ef70472013-08-16 07:59:12 -07001956 CONFIG_LZO
1957
1958 If this option is set, support for LZO compressed images
1959 is included.
1960
wdenk17ea1172004-06-06 21:51:03 +00001961- MII/PHY support:
1962 CONFIG_PHY_ADDR
1963
1964 The address of PHY on MII bus.
1965
1966 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1967
1968 The clock frequency of the MII bus
1969
1970 CONFIG_PHY_GIGE
1971
1972 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001973 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00001974
1975 CONFIG_PHY_RESET_DELAY
1976
1977 Some PHY like Intel LXT971A need extra delay after
1978 reset before any MII register access is possible.
1979 For such PHY, set this option to the usec delay
1980 required. (minimum 300usec for LXT971A)
1981
1982 CONFIG_PHY_CMD_DELAY (ppc4xx)
1983
1984 Some PHY like Intel LXT971A need extra delay after
1985 command issued before MII status register can be read
1986
wdenkc6097192002-11-03 00:24:07 +00001987- Ethernet address:
1988 CONFIG_ETHADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001989 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001990 CONFIG_ETH2ADDR
1991 CONFIG_ETH3ADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001992 CONFIG_ETH4ADDR
1993 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001994
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001995 Define a default value for Ethernet address to use
1996 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001997 is not determined automatically.
1998
1999- IP address:
2000 CONFIG_IPADDR
2001
2002 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002003 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00002004 determined through e.g. bootp.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00002005 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00002006
2007- Server IP address:
2008 CONFIG_SERVERIP
2009
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002010 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00002011 server to contact when using the "tftboot" command.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00002012 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00002013
Robin Getz97cfe862009-07-21 12:15:28 -04002014 CONFIG_KEEP_SERVERADDR
2015
2016 Keeps the server's MAC address, in the env 'serveraddr'
2017 for passing to bootargs (like Linux's netconsole option)
2018
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00002019- Gateway IP address:
2020 CONFIG_GATEWAYIP
2021
2022 Defines a default value for the IP address of the
2023 default router where packets to other networks are
2024 sent to.
2025 (Environment variable "gatewayip")
2026
2027- Subnet mask:
2028 CONFIG_NETMASK
2029
2030 Defines a default value for the subnet mask (or
2031 routing prefix) which is used to determine if an IP
2032 address belongs to the local subnet or needs to be
2033 forwarded through a router.
2034 (Environment variable "netmask")
2035
David Updegraff53a5c422007-06-11 10:41:07 -05002036- Multicast TFTP Mode:
2037 CONFIG_MCAST_TFTP
2038
2039 Defines whether you want to support multicast TFTP as per
2040 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002041 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05002042 driver in use must provide a function: mcast() to join/leave a
2043 multicast group.
2044
wdenkc6097192002-11-03 00:24:07 +00002045- BOOTP Recovery Mode:
2046 CONFIG_BOOTP_RANDOM_DELAY
2047
2048 If you have many targets in a network that try to
2049 boot using BOOTP, you may want to avoid that all
2050 systems send out BOOTP requests at precisely the same
2051 moment (which would happen for instance at recovery
2052 from a power failure, when all systems will try to
2053 boot, thus flooding the BOOTP server. Defining
2054 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
2055 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02002056 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00002057
2058 1st BOOTP request: delay 0 ... 1 sec
2059 2nd BOOTP request: delay 0 ... 2 sec
2060 3rd BOOTP request: delay 0 ... 4 sec
2061 4th and following
2062 BOOTP requests: delay 0 ... 8 sec
2063
Thierry Reding92ac8ac2014-08-19 10:21:24 +02002064 CONFIG_BOOTP_ID_CACHE_SIZE
2065
2066 BOOTP packets are uniquely identified using a 32-bit ID. The
2067 server will copy the ID from client requests to responses and
2068 U-Boot will use this to determine if it is the destination of
2069 an incoming response. Some servers will check that addresses
2070 aren't in use before handing them out (usually using an ARP
2071 ping) and therefore take up to a few hundred milliseconds to
2072 respond. Network congestion may also influence the time it
2073 takes for a response to make it back to the client. If that
2074 time is too long, U-Boot will retransmit requests. In order
2075 to allow earlier responses to still be accepted after these
2076 retransmissions, U-Boot's BOOTP client keeps a small cache of
2077 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
2078 cache. The default is to keep IDs for up to four outstanding
2079 requests. Increasing this will allow U-Boot to accept offers
2080 from a BOOTP client in networks with unusually high latency.
2081
stroesefe389a82003-08-28 14:17:32 +00002082- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002083 You can fine tune the DHCP functionality by defining
2084 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00002085
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002086 CONFIG_BOOTP_SUBNETMASK
2087 CONFIG_BOOTP_GATEWAY
2088 CONFIG_BOOTP_HOSTNAME
2089 CONFIG_BOOTP_NISDOMAIN
2090 CONFIG_BOOTP_BOOTPATH
2091 CONFIG_BOOTP_BOOTFILESIZE
2092 CONFIG_BOOTP_DNS
2093 CONFIG_BOOTP_DNS2
2094 CONFIG_BOOTP_SEND_HOSTNAME
2095 CONFIG_BOOTP_NTPSERVER
2096 CONFIG_BOOTP_TIMEOFFSET
2097 CONFIG_BOOTP_VENDOREX
Joe Hershberger2c00e092012-05-23 07:59:19 +00002098 CONFIG_BOOTP_MAY_FAIL
stroesefe389a82003-08-28 14:17:32 +00002099
Wilson Callan5d110f02007-07-28 10:56:13 -04002100 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
2101 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00002102
Joe Hershberger2c00e092012-05-23 07:59:19 +00002103 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
2104 after the configured retry count, the call will fail
2105 instead of starting over. This can be used to fail over
2106 to Link-local IP address configuration if the DHCP server
2107 is not available.
2108
stroesefe389a82003-08-28 14:17:32 +00002109 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
2110 serverip from a DHCP server, it is possible that more
2111 than one DNS serverip is offered to the client.
2112 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
2113 serverip will be stored in the additional environment
2114 variable "dnsip2". The first DNS serverip is always
2115 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002116 is defined.
stroesefe389a82003-08-28 14:17:32 +00002117
2118 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
2119 to do a dynamic update of a DNS server. To do this, they
2120 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04002121 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002122 of the "hostname" environment variable is passed as
2123 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00002124
Aras Vaichasd9a2f412008-03-26 09:43:57 +11002125 CONFIG_BOOTP_DHCP_REQUEST_DELAY
2126
2127 A 32bit value in microseconds for a delay between
2128 receiving a "DHCP Offer" and sending the "DHCP Request".
2129 This fixes a problem with certain DHCP servers that don't
2130 respond 100% of the time to a "DHCP request". E.g. On an
2131 AT91RM9200 processor running at 180MHz, this delay needed
2132 to be *at least* 15,000 usec before a Windows Server 2003
2133 DHCP server would reply 100% of the time. I recommend at
2134 least 50,000 usec to be safe. The alternative is to hope
2135 that one of the retries will be successful but note that
2136 the DHCP timeout and retry process takes a longer than
2137 this delay.
2138
Joe Hershbergerd22c3382012-05-23 08:00:12 +00002139 - Link-local IP address negotiation:
2140 Negotiate with other link-local clients on the local network
2141 for an address that doesn't require explicit configuration.
2142 This is especially useful if a DHCP server cannot be guaranteed
2143 to exist in all environments that the device must operate.
2144
2145 See doc/README.link-local for more information.
2146
wdenka3d991b2004-04-15 21:48:45 +00002147 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00002148 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00002149
2150 The device id used in CDP trigger frames.
2151
2152 CONFIG_CDP_DEVICE_ID_PREFIX
2153
2154 A two character string which is prefixed to the MAC address
2155 of the device.
2156
2157 CONFIG_CDP_PORT_ID
2158
2159 A printf format string which contains the ascii name of
2160 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002161 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00002162
2163 CONFIG_CDP_CAPABILITIES
2164
2165 A 32bit integer which indicates the device capabilities;
2166 0x00000010 for a normal host which does not forwards.
2167
2168 CONFIG_CDP_VERSION
2169
2170 An ascii string containing the version of the software.
2171
2172 CONFIG_CDP_PLATFORM
2173
2174 An ascii string containing the name of the platform.
2175
2176 CONFIG_CDP_TRIGGER
2177
2178 A 32bit integer sent on the trigger.
2179
2180 CONFIG_CDP_POWER_CONSUMPTION
2181
2182 A 16bit integer containing the power consumption of the
2183 device in .1 of milliwatts.
2184
2185 CONFIG_CDP_APPLIANCE_VLAN_TYPE
2186
2187 A byte containing the id of the VLAN.
2188
wdenkc6097192002-11-03 00:24:07 +00002189- Status LED: CONFIG_STATUS_LED
2190
2191 Several configurations allow to display the current
2192 status using a LED. For instance, the LED will blink
2193 fast while running U-Boot code, stop blinking as
2194 soon as a reply to a BOOTP request was received, and
2195 start blinking slow once the Linux kernel is running
2196 (supported by a status LED driver in the Linux
2197 kernel). Defining CONFIG_STATUS_LED enables this
2198 feature in U-Boot.
2199
Igor Grinberg1df7bbb2013-11-08 01:03:50 +02002200 Additional options:
2201
2202 CONFIG_GPIO_LED
2203 The status LED can be connected to a GPIO pin.
2204 In such cases, the gpio_led driver can be used as a
2205 status LED backend implementation. Define CONFIG_GPIO_LED
2206 to include the gpio_led driver in the U-Boot binary.
2207
Igor Grinberg9dfdcdf2013-11-08 01:03:52 +02002208 CONFIG_GPIO_LED_INVERTED_TABLE
2209 Some GPIO connected LEDs may have inverted polarity in which
2210 case the GPIO high value corresponds to LED off state and
2211 GPIO low value corresponds to LED on state.
2212 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
2213 with a list of GPIO LEDs that have inverted polarity.
2214
wdenkc6097192002-11-03 00:24:07 +00002215- CAN Support: CONFIG_CAN_DRIVER
2216
2217 Defining CONFIG_CAN_DRIVER enables CAN driver support
2218 on those systems that support this (optional)
2219 feature, like the TQM8xxL modules.
2220
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002221- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00002222
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002223 This enable the NEW i2c subsystem, and will allow you to use
2224 i2c commands at the u-boot command line (as long as you set
2225 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
2226 based realtime clock chips or other i2c devices. See
2227 common/cmd_i2c.c for a description of the command line
2228 interface.
2229
2230 ported i2c driver to the new framework:
Heiko Schocherea818db2013-01-29 08:53:15 +01002231 - drivers/i2c/soft_i2c.c:
2232 - activate first bus with CONFIG_SYS_I2C_SOFT define
2233 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2234 for defining speed and slave address
2235 - activate second bus with I2C_SOFT_DECLARATIONS2 define
2236 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2237 for defining speed and slave address
2238 - activate third bus with I2C_SOFT_DECLARATIONS3 define
2239 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2240 for defining speed and slave address
2241 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2242 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2243 for defining speed and slave address
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002244
Heiko Schocher00f792e2012-10-24 13:48:22 +02002245 - drivers/i2c/fsl_i2c.c:
2246 - activate i2c driver with CONFIG_SYS_I2C_FSL
2247 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
2248 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
2249 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
2250 bus.
Wolfgang Denk93e14592013-10-04 17:43:24 +02002251 - If your board supports a second fsl i2c bus, define
Heiko Schocher00f792e2012-10-24 13:48:22 +02002252 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
2253 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
2254 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
2255 second bus.
2256
Simon Glass1f2ba722012-10-30 07:28:53 +00002257 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu10cee512013-10-11 16:23:53 +09002258 - activate this driver with CONFIG_SYS_I2C_TEGRA
2259 - This driver adds 4 i2c buses with a fix speed from
2260 100000 and the slave addr 0!
Simon Glass1f2ba722012-10-30 07:28:53 +00002261
Dirk Eibach880540d2013-04-25 02:40:01 +00002262 - drivers/i2c/ppc4xx_i2c.c
2263 - activate this driver with CONFIG_SYS_I2C_PPC4XX
2264 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2265 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2266
tremfac96402013-09-21 18:13:35 +02002267 - drivers/i2c/i2c_mxc.c
2268 - activate this driver with CONFIG_SYS_I2C_MXC
2269 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2270 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2271 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2272 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2273 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2274 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
2275 If thoses defines are not set, default value is 100000
2276 for speed, and 0 for slave.
2277
Nobuhiro Iwamatsu1086bfa2013-09-27 16:58:30 +09002278 - drivers/i2c/rcar_i2c.c:
2279 - activate this driver with CONFIG_SYS_I2C_RCAR
2280 - This driver adds 4 i2c buses
2281
2282 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2283 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2284 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2285 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2286 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2287 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2288 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2289 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2290 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2291
Nobuhiro Iwamatsu2035d772013-10-29 13:33:51 +09002292 - drivers/i2c/sh_i2c.c:
2293 - activate this driver with CONFIG_SYS_I2C_SH
2294 - This driver adds from 2 to 5 i2c buses
2295
2296 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
2297 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
2298 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
2299 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
2300 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
2301 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2302 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2303 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2304 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2305 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
2306 - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
2307 - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
2308 - CONFIF_SYS_I2C_SH_NUM_CONTROLLERS for nummber of i2c buses
2309
Heiko Schocher6789e842013-10-22 11:03:18 +02002310 - drivers/i2c/omap24xx_i2c.c
2311 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2312 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2313 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2314 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2315 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2316 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2317 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2318 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2319 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2320 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2321 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2322
Heiko Schocher0bdffe72013-11-08 07:30:53 +01002323 - drivers/i2c/zynq_i2c.c
2324 - activate this driver with CONFIG_SYS_I2C_ZYNQ
2325 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2326 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2327
Naveen Krishna Che717fc62013-12-06 12:12:38 +05302328 - drivers/i2c/s3c24x0_i2c.c:
2329 - activate this driver with CONFIG_SYS_I2C_S3C24X0
2330 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2331 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2332 with a fix speed from 100000 and the slave addr 0!
2333
Dirk Eibachb46226b2014-07-03 09:28:18 +02002334 - drivers/i2c/ihs_i2c.c
2335 - activate this driver with CONFIG_SYS_I2C_IHS
2336 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2337 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2338 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2339 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2340 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2341 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2342 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2343 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2344 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2345 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2346 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2347 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
2348
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002349 additional defines:
2350
2351 CONFIG_SYS_NUM_I2C_BUSES
2352 Hold the number of i2c busses you want to use. If you
2353 don't use/have i2c muxes on your i2c bus, this
2354 is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
2355 omit this define.
2356
2357 CONFIG_SYS_I2C_DIRECT_BUS
2358 define this, if you don't use i2c muxes on your hardware.
2359 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2360 omit this define.
2361
2362 CONFIG_SYS_I2C_MAX_HOPS
2363 define how many muxes are maximal consecutively connected
2364 on one i2c bus. If you not use i2c muxes, omit this
2365 define.
2366
2367 CONFIG_SYS_I2C_BUSES
2368 hold a list of busses you want to use, only used if
2369 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2370 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2371 CONFIG_SYS_NUM_I2C_BUSES = 9:
2372
2373 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2374 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2375 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2376 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2377 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2378 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2379 {1, {I2C_NULL_HOP}}, \
2380 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2381 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2382 }
2383
2384 which defines
2385 bus 0 on adapter 0 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002386 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2387 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2388 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2389 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2390 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002391 bus 6 on adapter 1 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002392 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2393 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002394
2395 If you do not have i2c muxes on your board, omit this define.
2396
Heiko Schocherea818db2013-01-29 08:53:15 +01002397- Legacy I2C Support: CONFIG_HARD_I2C
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002398
2399 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
2400 provides the following compelling advantages:
2401
2402 - more than one i2c adapter is usable
2403 - approved multibus support
2404 - better i2c mux support
2405
2406 ** Please consider updating your I2C driver now. **
2407
Heiko Schocherea818db2013-01-29 08:53:15 +01002408 These enable legacy I2C serial bus commands. Defining
2409 CONFIG_HARD_I2C will include the appropriate I2C driver
2410 for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00002411
wdenk945af8d2003-07-16 21:53:01 +00002412 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05002413 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00002414 CONFIG_COMMANDS) and communicate with i2c based realtime
2415 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00002416 command line interface.
wdenkc6097192002-11-03 00:24:07 +00002417
Ben Warrenbb99ad62006-09-07 16:50:54 -04002418 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00002419
wdenk945af8d2003-07-16 21:53:01 +00002420 There are several other quantities that must also be
Heiko Schocherea818db2013-01-29 08:53:15 +01002421 defined when you define CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002422
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002423 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00002424 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002425 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002426 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00002427
Peter Tyser8d321b82010-04-12 22:28:21 -05002428 Now, the u-boot i2c code for the mpc8xx
Stefan Roesea47a12b2010-04-15 16:07:28 +02002429 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tyser8d321b82010-04-12 22:28:21 -05002430 and so its address should therefore be cleared to 0 (See,
2431 eg, MPC823e User's Manual p.16-473). So, set
2432 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00002433
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05002434 CONFIG_SYS_I2C_INIT_MPC5XXX
2435
2436 When a board is reset during an i2c bus transfer
2437 chips might think that the current transfer is still
2438 in progress. Reset the slave devices by sending start
2439 commands until the slave device responds.
2440
wdenk945af8d2003-07-16 21:53:01 +00002441 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00002442
Heiko Schocherea818db2013-01-29 08:53:15 +01002443 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb37c7e52003-06-30 16:24:52 +00002444 then the following macros need to be defined (examples are
2445 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002446
2447 I2C_INIT
2448
wdenkb37c7e52003-06-30 16:24:52 +00002449 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00002450 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002451
wdenkba56f622004-02-06 23:19:44 +00002452 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00002453
wdenkc6097192002-11-03 00:24:07 +00002454 I2C_PORT
2455
wdenk43d96162003-03-06 00:02:04 +00002456 (Only for MPC8260 CPU). The I/O port to use (the code
2457 assumes both bits are on the same port). Valid values
2458 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00002459
2460 I2C_ACTIVE
2461
2462 The code necessary to make the I2C data line active
2463 (driven). If the data line is open collector, this
2464 define can be null.
2465
wdenkb37c7e52003-06-30 16:24:52 +00002466 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2467
wdenkc6097192002-11-03 00:24:07 +00002468 I2C_TRISTATE
2469
2470 The code necessary to make the I2C data line tri-stated
2471 (inactive). If the data line is open collector, this
2472 define can be null.
2473
wdenkb37c7e52003-06-30 16:24:52 +00002474 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2475
wdenkc6097192002-11-03 00:24:07 +00002476 I2C_READ
2477
York Sun472d5462013-04-01 11:29:11 -07002478 Code that returns true if the I2C data line is high,
2479 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002480
wdenkb37c7e52003-06-30 16:24:52 +00002481 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2482
wdenkc6097192002-11-03 00:24:07 +00002483 I2C_SDA(bit)
2484
York Sun472d5462013-04-01 11:29:11 -07002485 If <bit> is true, sets the I2C data line high. If it
2486 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002487
wdenkb37c7e52003-06-30 16:24:52 +00002488 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00002489 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00002490 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00002491
wdenkc6097192002-11-03 00:24:07 +00002492 I2C_SCL(bit)
2493
York Sun472d5462013-04-01 11:29:11 -07002494 If <bit> is true, sets the I2C clock line high. If it
2495 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002496
wdenkb37c7e52003-06-30 16:24:52 +00002497 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00002498 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00002499 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00002500
wdenkc6097192002-11-03 00:24:07 +00002501 I2C_DELAY
2502
2503 This delay is invoked four times per clock cycle so this
2504 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00002505 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00002506 like:
2507
wdenkb37c7e52003-06-30 16:24:52 +00002508 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002509
Mike Frysinger793b5722010-07-21 13:38:02 -04002510 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2511
2512 If your arch supports the generic GPIO framework (asm/gpio.h),
2513 then you may alternatively define the two GPIOs that are to be
2514 used as SCL / SDA. Any of the previous I2C_xxx macros will
2515 have GPIO-based defaults assigned to them as appropriate.
2516
2517 You should define these to the GPIO value as given directly to
2518 the generic GPIO functions.
2519
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002520 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00002521
wdenk8bde7f72003-06-27 21:31:46 +00002522 When a board is reset during an i2c bus transfer
2523 chips might think that the current transfer is still
2524 in progress. On some boards it is possible to access
2525 the i2c SCLK line directly, either by using the
2526 processor pin as a GPIO or by having a second pin
2527 connected to the bus. If this option is defined a
2528 custom i2c_init_board() routine in boards/xxx/board.c
2529 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00002530
Richard Retanubun26a33502010-04-12 15:08:17 -04002531 CONFIG_SYS_I2C_BOARD_LATE_INIT
2532
2533 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2534 defined a custom i2c_board_late_init() routine in
2535 boards/xxx/board.c is run AFTER the operations in i2c_init()
2536 is completed. This callpoint can be used to unreset i2c bus
2537 using CPU i2c controller register accesses for CPUs whose i2c
2538 controller provide such a method. It is called at the end of
2539 i2c_init() to allow i2c_init operations to setup the i2c bus
2540 controller on the CPU (e.g. setting bus speed & slave address).
2541
wdenk17ea1172004-06-06 21:51:03 +00002542 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2543
2544 This option enables configuration of bi_iic_fast[] flags
2545 in u-boot bd_info structure based on u-boot environment
2546 variable "i2cfast". (see also i2cfast)
2547
Ben Warrenbb99ad62006-09-07 16:50:54 -04002548 CONFIG_I2C_MULTI_BUS
2549
2550 This option allows the use of multiple I2C buses, each of which
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002551 must have a controller. At any point in time, only one bus is
2552 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warrenbb99ad62006-09-07 16:50:54 -04002553 Note that bus numbering is zero-based.
2554
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002555 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04002556
2557 This option specifies a list of I2C devices that will be skipped
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002558 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser0f89c542009-04-18 22:34:03 -05002559 is set, specify a list of bus-device pairs. Otherwise, specify
2560 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04002561
2562 e.g.
2563 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002564 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002565
2566 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2567
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002568 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002569 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002570
2571 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2572
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002573 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e61812006-11-03 19:15:00 -06002574
2575 If defined, then this indicates the I2C bus number for DDR SPD.
2576 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2577
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002578 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002579
2580 If defined, then this indicates the I2C bus number for the RTC.
2581 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2582
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002583 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002584
2585 If defined, then this indicates the I2C bus number for the DTT.
2586 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2587
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002588 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07002589
2590 If defined, specifies the I2C address of the DTT device.
2591 If not defined, then U-Boot uses predefined value for
2592 specified DTT device.
2593
Andrew Dyer2ac69852008-12-29 17:36:01 -06002594 CONFIG_SOFT_I2C_READ_REPEATED_START
2595
2596 defining this will force the i2c_read() function in
2597 the soft_i2c driver to perform an I2C repeated start
2598 between writing the address pointer and reading the
2599 data. If this define is omitted the default behaviour
2600 of doing a stop-start sequence will be used. Most I2C
2601 devices can use either method, but some require one or
2602 the other.
Timur Tabibe5e61812006-11-03 19:15:00 -06002603
wdenkc6097192002-11-03 00:24:07 +00002604- SPI Support: CONFIG_SPI
2605
2606 Enables SPI driver (so far only tested with
2607 SPI EEPROM, also an instance works with Crystal A/D and
2608 D/As on the SACSng board)
2609
Yoshihiro Shimoda66395622011-01-31 16:50:43 +09002610 CONFIG_SH_SPI
2611
2612 Enables the driver for SPI controller on SuperH. Currently
2613 only SH7757 is supported.
2614
wdenkc6097192002-11-03 00:24:07 +00002615 CONFIG_SPI_X
2616
2617 Enables extended (16-bit) SPI EEPROM addressing.
2618 (symmetrical to CONFIG_I2C_X)
2619
2620 CONFIG_SOFT_SPI
2621
wdenk43d96162003-03-06 00:02:04 +00002622 Enables a software (bit-bang) SPI driver rather than
2623 using hardware support. This is a general purpose
2624 driver that only requires three general I/O port pins
2625 (two outputs, one input) to function. If this is
2626 defined, the board configuration must define several
2627 SPI configuration items (port pins to use, etc). For
2628 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002629
Ben Warren04a9e112008-01-16 22:37:35 -05002630 CONFIG_HARD_SPI
2631
2632 Enables a hardware SPI driver for general-purpose reads
2633 and writes. As with CONFIG_SOFT_SPI, the board configuration
2634 must define a list of chip-select function pointers.
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002635 Currently supported on some MPC8xxx processors. For an
Ben Warren04a9e112008-01-16 22:37:35 -05002636 example, see include/configs/mpc8349emds.h.
2637
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002638 CONFIG_MXC_SPI
2639
2640 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevam2e3cd1c2011-10-28 08:57:46 +00002641 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002642
Heiko Schocherf659b572014-07-14 10:22:11 +02002643 CONFIG_SYS_SPI_MXC_WAIT
2644 Timeout for waiting until spi transfer completed.
2645 default: (CONFIG_SYS_HZ/100) /* 10 ms */
2646
Matthias Fuchs01335022007-12-27 17:12:34 +01002647- FPGA Support: CONFIG_FPGA
2648
2649 Enables FPGA subsystem.
2650
2651 CONFIG_FPGA_<vendor>
2652
2653 Enables support for specific chip vendors.
2654 (ALTERA, XILINX)
2655
2656 CONFIG_FPGA_<family>
2657
2658 Enables support for FPGA family.
2659 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2660
2661 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00002662
wdenk43d96162003-03-06 00:02:04 +00002663 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002664
Siva Durga Prasad Paladugu64e809a2014-03-14 16:35:38 +05302665 CONFIG_CMD_FPGA_LOADMK
2666
2667 Enable support for fpga loadmk command
2668
Michal Simek67193862014-05-02 13:43:39 +02002669 CONFIG_CMD_FPGA_LOADP
2670
2671 Enable support for fpga loadp command - load partial bitstream
2672
2673 CONFIG_CMD_FPGA_LOADBP
2674
2675 Enable support for fpga loadbp command - load partial bitstream
2676 (Xilinx only)
2677
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002678 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002679
wdenk8bde7f72003-06-27 21:31:46 +00002680 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002681
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002682 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002683
wdenk43d96162003-03-06 00:02:04 +00002684 Enable checks on FPGA configuration interface busy
2685 status by the configuration function. This option
2686 will require a board or device specific function to
2687 be written.
wdenkc6097192002-11-03 00:24:07 +00002688
2689 CONFIG_FPGA_DELAY
2690
2691 If defined, a function that provides delays in the FPGA
2692 configuration driver.
2693
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002694 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002695 Allow Control-C to interrupt FPGA configuration
2696
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002697 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002698
wdenk43d96162003-03-06 00:02:04 +00002699 Check for configuration errors during FPGA bitfile
2700 loading. For example, abort during Virtex II
2701 configuration if the INIT_B line goes low (which
2702 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002703
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002704 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002705
wdenk43d96162003-03-06 00:02:04 +00002706 Maximum time to wait for the INIT_B line to deassert
2707 after PROB_B has been deasserted during a Virtex II
2708 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002709 ms.
wdenkc6097192002-11-03 00:24:07 +00002710
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002711 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002712
wdenk43d96162003-03-06 00:02:04 +00002713 Maximum time to wait for BUSY to deassert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002714 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002715
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002716 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002717
wdenk43d96162003-03-06 00:02:04 +00002718 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002719 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002720
2721- Configuration Management:
Stefan Roeseb2b8a692014-10-22 12:13:24 +02002722 CONFIG_BUILD_TARGET
2723
2724 Some SoCs need special image types (e.g. U-Boot binary
2725 with a special header) as build targets. By defining
2726 CONFIG_BUILD_TARGET in the SoC / board header, this
2727 special image will be automatically built upon calling
2728 make / MAKEALL.
2729
wdenkc6097192002-11-03 00:24:07 +00002730 CONFIG_IDENT_STRING
2731
wdenk43d96162003-03-06 00:02:04 +00002732 If defined, this string will be added to the U-Boot
2733 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002734
2735- Vendor Parameter Protection:
2736
wdenk43d96162003-03-06 00:02:04 +00002737 U-Boot considers the values of the environment
2738 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00002739 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00002740 are set once by the board vendor / manufacturer, and
2741 protects these variables from casual modification by
2742 the user. Once set, these variables are read-only,
2743 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002744 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002745
2746 If CONFIG_ENV_OVERWRITE is #defined in your config
2747 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00002748 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002749 these parameters.
2750
2751 Alternatively, if you #define _both_ CONFIG_ETHADDR
2752 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002753 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002754 which can be changed exactly ONCE by the user. [The
2755 serial# is unaffected by this, i. e. it remains
2756 read-only.]
2757
Joe Hershberger25980902012-12-11 22:16:31 -06002758 The same can be accomplished in a more flexible way
2759 for any variable by configuring the type of access
2760 to allow for those variables in the ".flags" variable
2761 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2762
wdenkc6097192002-11-03 00:24:07 +00002763- Protected RAM:
2764 CONFIG_PRAM
2765
2766 Define this variable to enable the reservation of
2767 "protected RAM", i. e. RAM which is not overwritten
2768 by U-Boot. Define CONFIG_PRAM to hold the number of
2769 kB you want to reserve for pRAM. You can overwrite
2770 this default value by defining an environment
2771 variable "pram" to the number of kB you want to
2772 reserve. Note that the board info structure will
2773 still show the full amount of RAM. If pRAM is
2774 reserved, a new environment variable "mem" will
2775 automatically be defined to hold the amount of
2776 remaining RAM in a form that can be passed as boot
2777 argument to Linux, for instance like that:
2778
Wolfgang Denkfe126d82005-11-20 21:40:11 +01002779 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002780 saveenv
2781
2782 This way you can tell Linux not to use this memory,
2783 either, which results in a memory region that will
2784 not be affected by reboots.
2785
2786 *WARNING* If your board configuration uses automatic
2787 detection of the RAM size, you must make sure that
2788 this memory test is non-destructive. So far, the
2789 following board configurations are known to be
2790 "pRAM-clean":
2791
Wolfgang Denk1b0757e2012-10-24 02:36:15 +00002792 IVMS8, IVML24, SPD8xx, TQM8xxL,
2793 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denk544d97e2010-10-05 22:54:53 +02002794 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002795
Gabe Black40fef042012-12-02 04:55:18 +00002796- Access to physical memory region (> 4GB)
2797 Some basic support is provided for operations on memory not
2798 normally accessible to U-Boot - e.g. some architectures
2799 support access to more than 4GB of memory on 32-bit
2800 machines using physical address extension or similar.
2801 Define CONFIG_PHYSMEM to access this basic support, which
2802 currently only supports clearing the memory.
2803
wdenkc6097192002-11-03 00:24:07 +00002804- Error Recovery:
2805 CONFIG_PANIC_HANG
2806
2807 Define this variable to stop the system in case of a
2808 fatal error, so that you have to reset it manually.
2809 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002810 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002811 automatically as fast as possible, but it may be
2812 useful during development since you can try to debug
2813 the conditions that lead to the situation.
2814
2815 CONFIG_NET_RETRY_COUNT
2816
wdenk43d96162003-03-06 00:02:04 +00002817 This variable defines the number of retries for
2818 network operations like ARP, RARP, TFTP, or BOOTP
2819 before giving up the operation. If not defined, a
2820 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002821
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02002822 CONFIG_ARP_TIMEOUT
2823
2824 Timeout waiting for an ARP reply in milliseconds.
2825
Tetsuyuki Kobayashi48a3e992012-07-03 22:25:21 +00002826 CONFIG_NFS_TIMEOUT
2827
2828 Timeout in milliseconds used in NFS protocol.
2829 If you encounter "ERROR: Cannot umount" in nfs command,
2830 try longer timeout such as
2831 #define CONFIG_NFS_TIMEOUT 10000UL
2832
wdenkc6097192002-11-03 00:24:07 +00002833- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002834 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00002835
2836 Enable auto completion of commands using TAB.
2837
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002838 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002839
2840 This defines the secondary prompt string, which is
2841 printed when the command interpreter needs more input
2842 to complete a command. Usually "> ".
2843
2844 Note:
2845
wdenk8bde7f72003-06-27 21:31:46 +00002846 In the current implementation, the local variables
2847 space and global environment variables space are
2848 separated. Local variables are those you define by
2849 simply typing `name=value'. To access a local
2850 variable later on, you have write `$name' or
2851 `${name}'; to execute the contents of a variable
2852 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002853
wdenk43d96162003-03-06 00:02:04 +00002854 Global environment variables are those you use
2855 setenv/printenv to work with. To run a command stored
2856 in such a variable, you need to use the run command,
2857 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002858
2859 To store commands and special characters in a
2860 variable, please use double quotation marks
2861 surrounding the whole text of the variable, instead
2862 of the backslashes before semicolons and special
2863 symbols.
2864
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002865- Commandline Editing and History:
2866 CONFIG_CMDLINE_EDITING
2867
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002868 Enable editing and History functions for interactive
Wolfgang Denkb9365a22006-07-21 11:56:05 +02002869 commandline input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002870
wdenka8c7c702003-12-06 19:49:23 +00002871- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002872 CONFIG_EXTRA_ENV_SETTINGS
2873
wdenk43d96162003-03-06 00:02:04 +00002874 Define this to contain any number of null terminated
2875 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00002876 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00002877
wdenk43d96162003-03-06 00:02:04 +00002878 For example, place something like this in your
2879 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002880
2881 #define CONFIG_EXTRA_ENV_SETTINGS \
2882 "myvar1=value1\0" \
2883 "myvar2=value2\0"
2884
wdenk43d96162003-03-06 00:02:04 +00002885 Warning: This method is based on knowledge about the
2886 internal format how the environment is stored by the
2887 U-Boot code. This is NOT an official, exported
2888 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00002889 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002890 You better know what you are doing here.
2891
wdenk43d96162003-03-06 00:02:04 +00002892 Note: overly (ab)use of the default environment is
2893 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002894 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00002895 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002896
Stephen Warren5e724ca2012-05-22 09:21:54 +00002897 CONFIG_ENV_VARS_UBOOT_CONFIG
2898
2899 Define this in order to add variables describing the
2900 U-Boot build configuration to the default environment.
2901 These will be named arch, cpu, board, vendor, and soc.
2902
2903 Enabling this option will cause the following to be defined:
2904
2905 - CONFIG_SYS_ARCH
2906 - CONFIG_SYS_CPU
2907 - CONFIG_SYS_BOARD
2908 - CONFIG_SYS_VENDOR
2909 - CONFIG_SYS_SOC
2910
Tom Rini7e27f892012-10-24 07:28:16 +00002911 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2912
2913 Define this in order to add variables describing certain
2914 run-time determined information about the hardware to the
2915 environment. These will be named board_name, board_rev.
2916
Simon Glass06fd8532012-11-30 13:01:17 +00002917 CONFIG_DELAY_ENVIRONMENT
2918
2919 Normally the environment is loaded when the board is
2920 intialised so that it is available to U-Boot. This inhibits
2921 that so that the environment is not available until
2922 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2923 this is instead controlled by the value of
2924 /config/load-environment.
2925
wdenka8c7c702003-12-06 19:49:23 +00002926- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00002927 CONFIG_HAS_DATAFLASH
2928
wdenk8bde7f72003-06-27 21:31:46 +00002929 Defining this option enables DataFlash features and
2930 allows to read/write in Dataflash via the standard
2931 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00002932
Eric Nelsonf61ec452012-01-31 10:52:08 -07002933- Serial Flash support
2934 CONFIG_CMD_SF
2935
2936 Defining this option enables SPI flash commands
2937 'sf probe/read/write/erase/update'.
2938
2939 Usage requires an initial 'probe' to define the serial
2940 flash parameters, followed by read/write/erase/update
2941 commands.
2942
2943 The following defaults may be provided by the platform
2944 to handle the common case when only a single serial
2945 flash is present on the system.
2946
2947 CONFIG_SF_DEFAULT_BUS Bus identifier
2948 CONFIG_SF_DEFAULT_CS Chip-select
2949 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2950 CONFIG_SF_DEFAULT_SPEED in Hz
2951
Simon Glass24007272012-10-08 13:16:02 +00002952 CONFIG_CMD_SF_TEST
2953
2954 Define this option to include a destructive SPI flash
2955 test ('sf test').
2956
Jagannadha Sutradharudu Teki1dcd6d02013-06-19 15:33:58 +05302957 CONFIG_SPI_FLASH_BAR Ban/Extended Addr Reg
2958
2959 Define this option to use the Bank addr/Extended addr
2960 support on SPI flashes which has size > 16Mbytes.
2961
Jagannadha Sutradharudu Tekib902e072014-01-11 15:25:04 +05302962 CONFIG_SF_DUAL_FLASH Dual flash memories
2963
2964 Define this option to use dual flash support where two flash
2965 memories can be connected with a given cs line.
2966 currently Xilinx Zynq qspi support these type of connections.
2967
Heiko Schocher562f8df2014-07-18 06:07:21 +02002968 CONFIG_SYS_SPI_ST_ENABLE_WP_PIN
2969 enable the W#/Vpp signal to disable writing to the status
2970 register on ST MICRON flashes like the N25Q128.
2971 The status register write enable/disable bit, combined with
2972 the W#/VPP signal provides hardware data protection for the
2973 device as follows: When the enable/disable bit is set to 1,
2974 and the W#/VPP signal is driven LOW, the status register
2975 nonvolatile bits become read-only and the WRITE STATUS REGISTER
2976 operation will not execute. The only way to exit this
2977 hardware-protected mode is to drive W#/VPP HIGH.
2978
wdenk3f85ce22004-02-23 16:11:30 +00002979- SystemACE Support:
2980 CONFIG_SYSTEMACE
2981
2982 Adding this option adds support for Xilinx SystemACE
2983 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002984 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002985 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00002986
2987 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002988 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00002989
2990 When SystemACE support is added, the "ace" device type
2991 becomes available to the fat commands, i.e. fatls.
2992
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002993- TFTP Fixed UDP Port:
2994 CONFIG_TFTP_PORT
2995
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002996 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002997 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002998 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002999 number generator is used.
3000
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003001 Also, the environment variable tftpdstp is used to supply
3002 the TFTP UDP destination port value. If tftpdstp isn't
3003 defined, the normal port 69 is used.
3004
3005 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003006 blindly start the TFTP transfer using the pre-configured
3007 target IP address and UDP port. This has the effect of
3008 "punching through" the (Windows XP) firewall, allowing
3009 the remainder of the TFTP transfer to proceed normally.
3010 A better solution is to properly configure the firewall,
3011 but sometimes that is not allowed.
3012
Simon Glassbf36c5d2012-12-05 14:46:38 +00003013- Hashing support:
3014 CONFIG_CMD_HASH
3015
3016 This enables a generic 'hash' command which can produce
3017 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
3018
3019 CONFIG_HASH_VERIFY
3020
3021 Enable the hash verify command (hash -v). This adds to code
3022 size a little.
3023
3024 CONFIG_SHA1 - support SHA1 hashing
3025 CONFIG_SHA256 - support SHA256 hashing
3026
3027 Note: There is also a sha1sum command, which should perhaps
3028 be deprecated in favour of 'hash sha1'.
3029
Robert Winklera11f1872013-07-24 17:57:06 -07003030- Freescale i.MX specific commands:
3031 CONFIG_CMD_HDMIDETECT
3032 This enables 'hdmidet' command which returns true if an
3033 HDMI monitor is detected. This command is i.MX 6 specific.
3034
3035 CONFIG_CMD_BMODE
3036 This enables the 'bmode' (bootmode) command for forcing
3037 a boot from specific media.
3038
3039 This is useful for forcing the ROM's usb downloader to
3040 activate upon a watchdog reset which is nice when iterating
3041 on U-Boot. Using the reset button or running bmode normal
3042 will set it back to normal. This command currently
3043 supports i.MX53 and i.MX6.
3044
Simon Glass19c402a2013-06-13 15:10:02 -07003045- Signing support:
3046 CONFIG_RSA
3047
3048 This enables the RSA algorithm used for FIT image verification
Detlev Zundel8bf2aad2014-01-20 16:21:46 +01003049 in U-Boot. See doc/uImage.FIT/signature.txt for more information.
Simon Glass19c402a2013-06-13 15:10:02 -07003050
3051 The signing part is build into mkimage regardless of this
3052 option.
3053
Heiko Schocher9e50c402014-01-25 07:27:13 +01003054- bootcount support:
3055 CONFIG_BOOTCOUNT_LIMIT
3056
3057 This enables the bootcounter support, see:
3058 http://www.denx.de/wiki/DULG/UBootBootCountLimit
3059
3060 CONFIG_AT91SAM9XE
3061 enable special bootcounter support on at91sam9xe based boards.
3062 CONFIG_BLACKFIN
3063 enable special bootcounter support on blackfin based boards.
3064 CONFIG_SOC_DA8XX
3065 enable special bootcounter support on da850 based boards.
3066 CONFIG_BOOTCOUNT_RAM
3067 enable support for the bootcounter in RAM
3068 CONFIG_BOOTCOUNT_I2C
3069 enable support for the bootcounter on an i2c (like RTC) device.
3070 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
3071 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
3072 the bootcounter.
3073 CONFIG_BOOTCOUNT_ALEN = address len
Simon Glass19c402a2013-06-13 15:10:02 -07003074
wdenka8c7c702003-12-06 19:49:23 +00003075- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00003076 CONFIG_SHOW_BOOT_PROGRESS
3077
wdenk43d96162003-03-06 00:02:04 +00003078 Defining this option allows to add some board-
3079 specific code (calling a user-provided function
3080 "show_boot_progress(int)") that enables you to show
3081 the system's boot progress on some display (for
3082 example, some LED's) on your board. At the moment,
3083 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00003084
Simon Glass3a608ca2012-02-13 13:51:19 +00003085- Detailed boot stage timing
3086 CONFIG_BOOTSTAGE
3087 Define this option to get detailed timing of each stage
3088 of the boot process.
3089
3090 CONFIG_BOOTSTAGE_USER_COUNT
3091 This is the number of available user bootstage records.
3092 Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
3093 a new ID will be allocated from this stash. If you exceed
3094 the limit, recording will stop.
3095
3096 CONFIG_BOOTSTAGE_REPORT
3097 Define this to print a report before boot, similar to this:
3098
3099 Timer summary in microseconds:
3100 Mark Elapsed Stage
3101 0 0 reset
3102 3,575,678 3,575,678 board_init_f start
3103 3,575,695 17 arch_cpu_init A9
3104 3,575,777 82 arch_cpu_init done
3105 3,659,598 83,821 board_init_r start
3106 3,910,375 250,777 main_loop
3107 29,916,167 26,005,792 bootm_start
3108 30,361,327 445,160 start_kernel
3109
Simon Glass2eba38c2012-09-28 08:56:39 +00003110 CONFIG_CMD_BOOTSTAGE
3111 Add a 'bootstage' command which supports printing a report
3112 and un/stashing of bootstage data.
3113
Simon Glass94fd1312012-09-28 08:56:37 +00003114 CONFIG_BOOTSTAGE_FDT
3115 Stash the bootstage information in the FDT. A root 'bootstage'
3116 node is created with each bootstage id as a child. Each child
3117 has a 'name' property and either 'mark' containing the
3118 mark time in microsecond, or 'accum' containing the
3119 accumulated time for that bootstage id in microseconds.
3120 For example:
3121
3122 bootstage {
3123 154 {
3124 name = "board_init_f";
3125 mark = <3575678>;
3126 };
3127 170 {
3128 name = "lcd";
3129 accum = <33482>;
3130 };
3131 };
3132
3133 Code in the Linux kernel can find this in /proc/devicetree.
3134
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003135Legacy uImage format:
3136
wdenkc6097192002-11-03 00:24:07 +00003137 Arg Where When
3138 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00003139 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00003140 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00003141 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003142 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00003143 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003144 4 common/cmd_bootm.c Image data has correct checksum
3145 -4 common/cmd_bootm.c Image is for unsupported architecture
3146 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003147 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00003148 6 common/cmd_bootm.c Image Type check OK
3149 -6 common/cmd_bootm.c gunzip uncompression error
3150 -7 common/cmd_bootm.c Unimplemented compression type
3151 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003152 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00003153 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003154
3155 9 common/image.c Start initial ramdisk verification
3156 -10 common/image.c Ramdisk header has bad magic number
3157 -11 common/image.c Ramdisk header has bad checksum
3158 10 common/image.c Ramdisk header is OK
3159 -12 common/image.c Ramdisk data has bad checksum
3160 11 common/image.c Ramdisk data has correct checksum
3161 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003162 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003163 13 common/image.c Start multifile image verification
3164 14 common/image.c No initial ramdisk, no multifile, continue.
3165
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003166 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00003167
Stefan Roesea47a12b2010-04-15 16:07:28 +02003168 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd52004-02-27 00:07:27 +00003169 -31 post/post.c POST test failed, detected by post_output_backlog()
3170 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00003171
Heiko Schocher566a4942007-06-22 19:11:54 +02003172 34 common/cmd_doc.c before loading a Image from a DOC device
3173 -35 common/cmd_doc.c Bad usage of "doc" command
3174 35 common/cmd_doc.c correct usage of "doc" command
3175 -36 common/cmd_doc.c No boot device
3176 36 common/cmd_doc.c correct boot device
3177 -37 common/cmd_doc.c Unknown Chip ID on boot device
3178 37 common/cmd_doc.c correct chip ID found, device available
3179 -38 common/cmd_doc.c Read Error on boot device
3180 38 common/cmd_doc.c reading Image header from DOC device OK
3181 -39 common/cmd_doc.c Image header has bad magic number
3182 39 common/cmd_doc.c Image header has correct magic number
3183 -40 common/cmd_doc.c Error reading Image from DOC device
3184 40 common/cmd_doc.c Image header has correct magic number
3185 41 common/cmd_ide.c before loading a Image from a IDE device
3186 -42 common/cmd_ide.c Bad usage of "ide" command
3187 42 common/cmd_ide.c correct usage of "ide" command
3188 -43 common/cmd_ide.c No boot device
3189 43 common/cmd_ide.c boot device found
3190 -44 common/cmd_ide.c Device not available
3191 44 common/cmd_ide.c Device available
3192 -45 common/cmd_ide.c wrong partition selected
3193 45 common/cmd_ide.c partition selected
3194 -46 common/cmd_ide.c Unknown partition table
3195 46 common/cmd_ide.c valid partition table found
3196 -47 common/cmd_ide.c Invalid partition type
3197 47 common/cmd_ide.c correct partition type
3198 -48 common/cmd_ide.c Error reading Image Header on boot device
3199 48 common/cmd_ide.c reading Image Header from IDE device OK
3200 -49 common/cmd_ide.c Image header has bad magic number
3201 49 common/cmd_ide.c Image header has correct magic number
3202 -50 common/cmd_ide.c Image header has bad checksum
3203 50 common/cmd_ide.c Image header has correct checksum
3204 -51 common/cmd_ide.c Error reading Image from IDE device
3205 51 common/cmd_ide.c reading Image from IDE device OK
3206 52 common/cmd_nand.c before loading a Image from a NAND device
3207 -53 common/cmd_nand.c Bad usage of "nand" command
3208 53 common/cmd_nand.c correct usage of "nand" command
3209 -54 common/cmd_nand.c No boot device
3210 54 common/cmd_nand.c boot device found
3211 -55 common/cmd_nand.c Unknown Chip ID on boot device
3212 55 common/cmd_nand.c correct chip ID found, device available
3213 -56 common/cmd_nand.c Error reading Image Header on boot device
3214 56 common/cmd_nand.c reading Image Header from NAND device OK
3215 -57 common/cmd_nand.c Image header has bad magic number
3216 57 common/cmd_nand.c Image header has correct magic number
3217 -58 common/cmd_nand.c Error reading Image from NAND device
3218 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00003219
Heiko Schocher566a4942007-06-22 19:11:54 +02003220 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00003221
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003222 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02003223 -64 net/eth.c no Ethernet found.
3224 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00003225
Heiko Schocher566a4942007-06-22 19:11:54 +02003226 -80 common/cmd_net.c usage wrong
3227 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003228 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher566a4942007-06-22 19:11:54 +02003229 81 common/cmd_net.c NetLoop() back without error
3230 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
3231 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02003232 83 common/cmd_net.c running "source" command
3233 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02003234 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00003235
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003236FIT uImage format:
3237
3238 Arg Where When
3239 100 common/cmd_bootm.c Kernel FIT Image has correct format
3240 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
3241 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
3242 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
3243 102 common/cmd_bootm.c Kernel unit name specified
3244 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01003245 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003246 104 common/cmd_bootm.c Got kernel subimage node offset
3247 -104 common/cmd_bootm.c Kernel subimage hash verification failed
3248 105 common/cmd_bootm.c Kernel subimage hash verification OK
3249 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
3250 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003251 -106 common/cmd_bootm.c Kernel subimage has wrong type
3252 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003253 -107 common/cmd_bootm.c Can't get kernel subimage data/size
3254 108 common/cmd_bootm.c Got kernel subimage data/size
3255 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
3256 -109 common/cmd_bootm.c Can't get kernel subimage type
3257 -110 common/cmd_bootm.c Can't get kernel subimage comp
3258 -111 common/cmd_bootm.c Can't get kernel subimage os
3259 -112 common/cmd_bootm.c Can't get kernel subimage load address
3260 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
3261
3262 120 common/image.c Start initial ramdisk verification
3263 -120 common/image.c Ramdisk FIT image has incorrect format
3264 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003265 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003266 -122 common/image.c Can't get configuration for ramdisk subimage
3267 123 common/image.c Ramdisk unit name specified
3268 -124 common/image.c Can't get ramdisk subimage node offset
3269 125 common/image.c Got ramdisk subimage node offset
3270 -125 common/image.c Ramdisk subimage hash verification failed
3271 126 common/image.c Ramdisk subimage hash verification OK
3272 -126 common/image.c Ramdisk subimage for unsupported architecture
3273 127 common/image.c Architecture check OK
3274 -127 common/image.c Can't get ramdisk subimage data/size
3275 128 common/image.c Got ramdisk subimage data/size
3276 129 common/image.c Can't get ramdisk load address
3277 -129 common/image.c Got ramdisk load address
3278
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003279 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003280 131 common/cmd_doc.c FIT image format OK
3281
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003282 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003283 141 common/cmd_ide.c FIT image format OK
3284
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003285 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003286 151 common/cmd_nand.c FIT image format OK
3287
Heiko Schocher21d29f72014-05-28 11:33:33 +02003288- legacy image format:
3289 CONFIG_IMAGE_FORMAT_LEGACY
3290 enables the legacy image format support in U-Boot.
3291
3292 Default:
3293 enabled if CONFIG_FIT_SIGNATURE is not defined.
3294
3295 CONFIG_DISABLE_IMAGE_LEGACY
3296 disable the legacy image format
3297
3298 This define is introduced, as the legacy image format is
3299 enabled per default for backward compatibility.
3300
Gabe Blackd95f6ec2012-10-25 16:31:10 +00003301- FIT image support:
3302 CONFIG_FIT
3303 Enable support for the FIT uImage format.
3304
3305 CONFIG_FIT_BEST_MATCH
3306 When no configuration is explicitly selected, default to the
3307 one whose fdt's compatibility field best matches that of
3308 U-Boot itself. A match is considered "best" if it matches the
3309 most specific compatibility entry of U-Boot's fdt's root node.
3310 The order of entries in the configuration's fdt is ignored.
3311
Simon Glass3e569a62013-06-13 15:10:00 -07003312 CONFIG_FIT_SIGNATURE
3313 This option enables signature verification of FIT uImages,
3314 using a hash signed and verified using RSA. See
3315 doc/uImage.FIT/signature.txt for more details.
3316
Heiko Schocher21d29f72014-05-28 11:33:33 +02003317 WARNING: When relying on signed FIT images with required
3318 signature check the legacy image format is default
3319 disabled. If a board need legacy image format support
3320 enable this through CONFIG_IMAGE_FORMAT_LEGACY
3321
Dirk Eibach9a4f4792014-07-03 09:28:26 +02003322 CONFIG_FIT_DISABLE_SHA256
3323 Supporting SHA256 hashes has quite an impact on binary size.
3324 For constrained systems sha256 hash support can be disabled
3325 with this option.
3326
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003327- Standalone program support:
3328 CONFIG_STANDALONE_LOAD_ADDR
3329
Wolfgang Denk6feff892011-10-09 21:06:34 +02003330 This option defines a board specific value for the
3331 address where standalone program gets loaded, thus
3332 overwriting the architecture dependent default
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003333 settings.
3334
3335- Frame Buffer Address:
3336 CONFIG_FB_ADDR
3337
3338 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denk44a53b52013-01-03 00:43:59 +00003339 address for frame buffer. This is typically the case
3340 when using a graphics controller has separate video
3341 memory. U-Boot will then place the frame buffer at
3342 the given address instead of dynamically reserving it
3343 in system RAM by calling lcd_setmem(), which grabs
3344 the memory for the frame buffer depending on the
3345 configured panel size.
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003346
3347 Please see board_init_f function.
3348
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01003349- Automatic software updates via TFTP server
3350 CONFIG_UPDATE_TFTP
3351 CONFIG_UPDATE_TFTP_CNT_MAX
3352 CONFIG_UPDATE_TFTP_MSEC_MAX
3353
3354 These options enable and control the auto-update feature;
3355 for a more detailed description refer to doc/README.update.
3356
3357- MTD Support (mtdparts command, UBI support)
3358 CONFIG_MTD_DEVICE
3359
3360 Adds the MTD device infrastructure from the Linux kernel.
3361 Needed for mtdparts command support.
3362
3363 CONFIG_MTD_PARTITIONS
3364
3365 Adds the MTD partitioning infrastructure from the Linux
3366 kernel. Needed for UBI support.
3367
Heiko Schocherff94bc42014-06-24 10:10:04 +02003368 CONFIG_MTD_NAND_VERIFY_WRITE
3369 verify if the written data is correct reread.
3370
Joe Hershberger70c219c2013-04-08 10:32:48 +00003371- UBI support
3372 CONFIG_CMD_UBI
3373
3374 Adds commands for interacting with MTD partitions formatted
3375 with the UBI flash translation layer
3376
3377 Requires also defining CONFIG_RBTREE
3378
Joe Hershberger147162d2013-04-08 10:32:49 +00003379 CONFIG_UBI_SILENCE_MSG
3380
3381 Make the verbose messages from UBI stop printing. This leaves
3382 warnings and errors enabled.
3383
Heiko Schocherff94bc42014-06-24 10:10:04 +02003384
3385 CONFIG_MTD_UBI_WL_THRESHOLD
3386 This parameter defines the maximum difference between the highest
3387 erase counter value and the lowest erase counter value of eraseblocks
3388 of UBI devices. When this threshold is exceeded, UBI starts performing
3389 wear leveling by means of moving data from eraseblock with low erase
3390 counter to eraseblocks with high erase counter.
3391
3392 The default value should be OK for SLC NAND flashes, NOR flashes and
3393 other flashes which have eraseblock life-cycle 100000 or more.
3394 However, in case of MLC NAND flashes which typically have eraseblock
3395 life-cycle less than 10000, the threshold should be lessened (e.g.,
3396 to 128 or 256, although it does not have to be power of 2).
3397
3398 default: 4096
3399
3400 CONFIG_MTD_UBI_BEB_LIMIT
3401 This option specifies the maximum bad physical eraseblocks UBI
3402 expects on the MTD device (per 1024 eraseblocks). If the
3403 underlying flash does not admit of bad eraseblocks (e.g. NOR
3404 flash), this value is ignored.
3405
3406 NAND datasheets often specify the minimum and maximum NVM
3407 (Number of Valid Blocks) for the flashes' endurance lifetime.
3408 The maximum expected bad eraseblocks per 1024 eraseblocks
3409 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
3410 which gives 20 for most NANDs (MaxNVB is basically the total
3411 count of eraseblocks on the chip).
3412
3413 To put it differently, if this value is 20, UBI will try to
3414 reserve about 1.9% of physical eraseblocks for bad blocks
3415 handling. And that will be 1.9% of eraseblocks on the entire
3416 NAND chip, not just the MTD partition UBI attaches. This means
3417 that if you have, say, a NAND flash chip admits maximum 40 bad
3418 eraseblocks, and it is split on two MTD partitions of the same
3419 size, UBI will reserve 40 eraseblocks when attaching a
3420 partition.
3421
3422 default: 20
3423
3424 CONFIG_MTD_UBI_FASTMAP
3425 Fastmap is a mechanism which allows attaching an UBI device
3426 in nearly constant time. Instead of scanning the whole MTD device it
3427 only has to locate a checkpoint (called fastmap) on the device.
3428 The on-flash fastmap contains all information needed to attach
3429 the device. Using fastmap makes only sense on large devices where
3430 attaching by scanning takes long. UBI will not automatically install
3431 a fastmap on old images, but you can set the UBI parameter
3432 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
3433 that fastmap-enabled images are still usable with UBI implementations
3434 without fastmap support. On typical flash devices the whole fastmap
3435 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
3436
3437 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
3438 Set this parameter to enable fastmap automatically on images
3439 without a fastmap.
3440 default: 0
3441
Joe Hershberger70c219c2013-04-08 10:32:48 +00003442- UBIFS support
3443 CONFIG_CMD_UBIFS
3444
3445 Adds commands for interacting with UBI volumes formatted as
3446 UBIFS. UBIFS is read-only in u-boot.
3447
3448 Requires UBI support as well as CONFIG_LZO
3449
Joe Hershberger147162d2013-04-08 10:32:49 +00003450 CONFIG_UBIFS_SILENCE_MSG
3451
3452 Make the verbose messages from UBIFS stop printing. This leaves
3453 warnings and errors enabled.
3454
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003455- SPL framework
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003456 CONFIG_SPL
3457 Enable building of SPL globally.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003458
Tom Rini95579792012-02-14 07:29:40 +00003459 CONFIG_SPL_LDSCRIPT
3460 LDSCRIPT for linking the SPL binary.
3461
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003462 CONFIG_SPL_MAX_FOOTPRINT
3463 Maximum size in memory allocated to the SPL, BSS included.
3464 When defined, the linker checks that the actual memory
3465 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00003466 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003467 must not be both defined at the same time.
3468
Tom Rini95579792012-02-14 07:29:40 +00003469 CONFIG_SPL_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003470 Maximum size of the SPL image (text, data, rodata, and
3471 linker lists sections), BSS excluded.
3472 When defined, the linker checks that the actual size does
3473 not exceed it.
Tom Rini95579792012-02-14 07:29:40 +00003474
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003475 CONFIG_SPL_TEXT_BASE
3476 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003477
Scott Wood94a45bb2012-09-20 19:05:12 -05003478 CONFIG_SPL_RELOC_TEXT_BASE
3479 Address to relocate to. If unspecified, this is equal to
3480 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
3481
Tom Rini95579792012-02-14 07:29:40 +00003482 CONFIG_SPL_BSS_START_ADDR
3483 Link address for the BSS within the SPL binary.
3484
3485 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003486 Maximum size in memory allocated to the SPL BSS.
3487 When defined, the linker checks that the actual memory used
3488 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00003489 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003490 must not be both defined at the same time.
Tom Rini95579792012-02-14 07:29:40 +00003491
3492 CONFIG_SPL_STACK
3493 Adress of the start of the stack SPL will use
3494
Scott Wood94a45bb2012-09-20 19:05:12 -05003495 CONFIG_SPL_RELOC_STACK
3496 Adress of the start of the stack SPL will use after
3497 relocation. If unspecified, this is equal to
3498 CONFIG_SPL_STACK.
3499
Tom Rini95579792012-02-14 07:29:40 +00003500 CONFIG_SYS_SPL_MALLOC_START
3501 Starting address of the malloc pool used in SPL.
3502
3503 CONFIG_SYS_SPL_MALLOC_SIZE
3504 The size of the malloc pool used in SPL.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003505
Tom Rini47f7bca2012-08-13 12:03:19 -07003506 CONFIG_SPL_FRAMEWORK
3507 Enable the SPL framework under common/. This framework
3508 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3509 NAND loading of the Linux Kernel.
3510
Tom Rini9607faf2014-03-28 12:03:39 -04003511 CONFIG_SPL_OS_BOOT
3512 Enable booting directly to an OS from SPL.
3513 See also: doc/README.falcon
3514
Tom Rini861a86f2012-08-13 11:37:56 -07003515 CONFIG_SPL_DISPLAY_PRINT
3516 For ARM, enable an optional function to print more information
3517 about the running system.
3518
Scott Wood4b919722012-09-20 16:35:21 -05003519 CONFIG_SPL_INIT_MINIMAL
3520 Arch init code should be built for a very small image
3521
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003522 CONFIG_SPL_LIBCOMMON_SUPPORT
3523 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003524
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003525 CONFIG_SPL_LIBDISK_SUPPORT
3526 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003527
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003528 CONFIG_SPL_I2C_SUPPORT
3529 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003530
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003531 CONFIG_SPL_GPIO_SUPPORT
3532 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003533
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003534 CONFIG_SPL_MMC_SUPPORT
3535 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003536
Tom Rini95579792012-02-14 07:29:40 +00003537 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
3538 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003539 CONFIG_SYS_MMC_SD_FS_BOOT_PARTITION
Tom Rini95579792012-02-14 07:29:40 +00003540 Address, size and partition on the MMC to load U-Boot from
3541 when the MMC is being used in raw mode.
3542
Peter Korsgaard2b75b0a2013-05-13 08:36:29 +00003543 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3544 Sector to load kernel uImage from when MMC is being
3545 used in raw mode (for Falcon mode)
3546
3547 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3548 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3549 Sector and number of sectors to load kernel argument
3550 parameters from when MMC is being used in raw mode
3551 (for falcon mode)
3552
Tom Rini95579792012-02-14 07:29:40 +00003553 CONFIG_SPL_FAT_SUPPORT
3554 Support for fs/fat/libfat.o in SPL binary
3555
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003556 CONFIG_SPL_EXT_SUPPORT
3557 Support for EXT filesystem in SPL binary
Tom Rini95579792012-02-14 07:29:40 +00003558
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003559 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
3560 Filename to read to load U-Boot when reading from filesystem
3561
3562 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003563 Filename to read to load kernel uImage when reading
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003564 from filesystem (for Falcon mode)
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003565
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003566 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003567 Filename to read to load kernel argument parameters
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003568 when reading from filesystem (for Falcon mode)
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003569
Scott Wood06f60ae2012-12-06 13:33:17 +00003570 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3571 Set this for NAND SPL on PPC mpc83xx targets, so that
3572 start.S waits for the rest of the SPL to load before
3573 continuing (the hardware starts execution after just
3574 loading the first page rather than the full 4K).
3575
Prabhakar Kushwaha651fcf62014-04-08 19:12:31 +05303576 CONFIG_SPL_SKIP_RELOCATE
3577 Avoid SPL relocation
3578
Scott Wood6f2f01b2012-09-20 19:09:07 -05003579 CONFIG_SPL_NAND_BASE
3580 Include nand_base.c in the SPL. Requires
3581 CONFIG_SPL_NAND_DRIVERS.
3582
3583 CONFIG_SPL_NAND_DRIVERS
3584 SPL uses normal NAND drivers, not minimal drivers.
3585
3586 CONFIG_SPL_NAND_ECC
3587 Include standard software ECC in the SPL
3588
Tom Rini95579792012-02-14 07:29:40 +00003589 CONFIG_SPL_NAND_SIMPLE
Scott Wood7d4b7952012-09-21 18:35:27 -05003590 Support for NAND boot using simple NAND drivers that
3591 expose the cmd_ctrl() interface.
Tom Rini95579792012-02-14 07:29:40 +00003592
Tom Rini6dd3b562014-03-28 12:03:36 -04003593 CONFIG_SPL_MTD_SUPPORT
3594 Support for the MTD subsystem within SPL. Useful for
3595 environment on NAND support within SPL.
3596
Heiko Schocher0c3117b2014-10-31 08:31:00 +01003597 CONFIG_SPL_NAND_RAW_ONLY
3598 Support to boot only raw u-boot.bin images. Use this only
3599 if you need to save space.
3600
Ying Zhangbb0dc102013-08-16 15:16:11 +08003601 CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3602 Set for the SPL on PPC mpc8xxx targets, support for
York Sun5614e712013-09-30 09:22:09 -07003603 drivers/ddr/fsl/libddr.o in SPL binary.
Ying Zhangbb0dc102013-08-16 15:16:11 +08003604
Ying Zhang7c8eea52013-08-16 15:16:12 +08003605 CONFIG_SPL_COMMON_INIT_DDR
3606 Set for common ddr init with serial presence detect in
3607 SPL binary.
3608
Tom Rini95579792012-02-14 07:29:40 +00003609 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3610 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3611 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3612 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3613 CONFIG_SYS_NAND_ECCBYTES
3614 Defines the size and behavior of the NAND that SPL uses
Scott Wood7d4b7952012-09-21 18:35:27 -05003615 to read U-Boot
Tom Rini95579792012-02-14 07:29:40 +00003616
Prabhakar Kushwahafbe76ae2013-12-11 12:42:11 +05303617 CONFIG_SPL_NAND_BOOT
3618 Add support NAND boot
3619
Tom Rini95579792012-02-14 07:29:40 +00003620 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood7d4b7952012-09-21 18:35:27 -05003621 Location in NAND to read U-Boot from
3622
3623 CONFIG_SYS_NAND_U_BOOT_DST
3624 Location in memory to load U-Boot to
3625
3626 CONFIG_SYS_NAND_U_BOOT_SIZE
3627 Size of image to load
Tom Rini95579792012-02-14 07:29:40 +00003628
3629 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood7d4b7952012-09-21 18:35:27 -05003630 Entry point in loaded image to jump to
Tom Rini95579792012-02-14 07:29:40 +00003631
3632 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3633 Define this if you need to first read the OOB and then the
3634 data. This is used for example on davinci plattforms.
3635
3636 CONFIG_SPL_OMAP3_ID_NAND
3637 Support for an OMAP3-specific set of functions to return the
3638 ID and MFR of the first attached NAND chip, if present.
3639
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003640 CONFIG_SPL_SERIAL_SUPPORT
3641 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003642
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003643 CONFIG_SPL_SPI_FLASH_SUPPORT
3644 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003645
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003646 CONFIG_SPL_SPI_SUPPORT
3647 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003648
Pavel Machekc57b9532012-08-30 22:42:11 +02003649 CONFIG_SPL_RAM_DEVICE
3650 Support for running image already present in ram, in SPL binary
3651
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003652 CONFIG_SPL_LIBGENERIC_SUPPORT
3653 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003654
Ying Zhangba1bee42013-05-20 14:07:25 +08003655 CONFIG_SPL_ENV_SUPPORT
3656 Support for the environment operating in SPL binary
3657
3658 CONFIG_SPL_NET_SUPPORT
3659 Support for the net/libnet.o in SPL binary.
3660 It conflicts with SPL env from storage medium specified by
3661 CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3662
Scott Wood74752ba2012-12-06 13:33:16 +00003663 CONFIG_SPL_PAD_TO
Benoît Thébaudeau6113d3f2013-04-11 09:35:49 +00003664 Image offset to which the SPL should be padded before appending
3665 the SPL payload. By default, this is defined as
3666 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3667 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3668 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Wood74752ba2012-12-06 13:33:16 +00003669
Scott Woodca2fca22012-09-21 16:27:32 -05003670 CONFIG_SPL_TARGET
3671 Final target image containing SPL and payload. Some SPLs
3672 use an arch-specific makefile fragment instead, for
3673 example if more than one image needs to be produced.
3674
Simon Glass87ebee32013-05-08 08:05:59 +00003675 CONFIG_FIT_SPL_PRINT
3676 Printing information about a FIT image adds quite a bit of
3677 code to SPL. So this is normally disabled in SPL. Use this
3678 option to re-enable it. This will affect the output of the
3679 bootm command when booting a FIT image.
3680
Ying Zhang3aa29de2013-08-16 15:16:15 +08003681- TPL framework
3682 CONFIG_TPL
3683 Enable building of TPL globally.
3684
3685 CONFIG_TPL_PAD_TO
3686 Image offset to which the TPL should be padded before appending
3687 the TPL payload. By default, this is defined as
Wolfgang Denk93e14592013-10-04 17:43:24 +02003688 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3689 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3690 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang3aa29de2013-08-16 15:16:15 +08003691
wdenkc6097192002-11-03 00:24:07 +00003692Modem Support:
3693--------------
3694
Wolfgang Denk566e5cf2011-05-01 20:44:23 +02003695[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00003696
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003697- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00003698 CONFIG_MODEM_SUPPORT
3699
3700- RTS/CTS Flow control enable:
3701 CONFIG_HWFLOW
3702
3703- Modem debug support:
3704 CONFIG_MODEM_SUPPORT_DEBUG
3705
wdenk43d96162003-03-06 00:02:04 +00003706 Enables debugging stuff (char screen[1024], dbg())
3707 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00003708
wdenka8c7c702003-12-06 19:49:23 +00003709- Interrupt support (PPC):
3710
wdenkd4ca31c2004-01-02 14:00:00 +00003711 There are common interrupt_init() and timer_interrupt()
3712 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003713 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00003714 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003715 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00003716 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003717 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00003718 specific handling. If board has watchdog / status_led
3719 / other_activity_monitor it works automatically from
3720 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00003721
wdenkc6097192002-11-03 00:24:07 +00003722- General:
3723
wdenk43d96162003-03-06 00:02:04 +00003724 In the target system modem support is enabled when a
3725 specific key (key combination) is pressed during
3726 power-on. Otherwise U-Boot will boot normally
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003727 (autoboot). The key_pressed() function is called from
wdenk43d96162003-03-06 00:02:04 +00003728 board_init(). Currently key_pressed() is a dummy
3729 function, returning 1 and thus enabling modem
3730 initialization.
wdenkc6097192002-11-03 00:24:07 +00003731
wdenk43d96162003-03-06 00:02:04 +00003732 If there are no modem init strings in the
3733 environment, U-Boot proceed to autoboot; the
3734 previous output (banner, info printfs) will be
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003735 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00003736
3737 See also: doc/README.Modem
3738
Helmut Raiger9660e442011-10-20 04:19:47 +00003739Board initialization settings:
3740------------------------------
3741
3742During Initialization u-boot calls a number of board specific functions
3743to allow the preparation of board specific prerequisites, e.g. pin setup
3744before drivers are initialized. To enable these callbacks the
3745following configuration macros have to be defined. Currently this is
3746architecture specific, so please check arch/your_architecture/lib/board.c
3747typically in board_init_f() and board_init_r().
3748
3749- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3750- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3751- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3752- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003753
wdenkc6097192002-11-03 00:24:07 +00003754Configuration Settings:
3755-----------------------
3756
York Sun4d1fd7f2014-02-26 17:03:19 -08003757- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3758 Optionally it can be defined to support 64-bit memory commands.
3759
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003760- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003761 undefine this when you're short of memory.
3762
Peter Tyser2fb26042009-01-27 18:03:12 -06003763- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3764 width of the commands listed in the 'help' command output.
3765
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003766- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003767 prompt for user input.
3768
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003769- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003770
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003771- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003772
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003773- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003774
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003775- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003776 the application (usually a Linux kernel) when it is
3777 booted
3778
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003779- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003780 List of legal baudrate settings for this board.
3781
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003782- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00003783 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00003784
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003785- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00003786 If the board specific function
3787 extern int overwrite_console (void);
3788 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00003789 serial port, else the settings in the environment are used.
3790
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003791- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00003792 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00003793
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003794- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00003795 Enable overwrite of previous console environment settings.
3796
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003797- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003798 Begin and End addresses of the area used by the
3799 simple memory test.
3800
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003801- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00003802 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003803
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003804- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00003805 Scratch address used by the alternate memory test
3806 You only need to set this if address zero isn't writeable
3807
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003808- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
3809 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01003810 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003811 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01003812 fixing up gd->ram_size the Linux kernel should gets passed
3813 the now "corrected" memory size and won't touch it either.
3814 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01003815 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01003816 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01003817 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01003818
3819 This option can be used as a workaround for the 440EPx/GRx
3820 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3821 be touched.
3822
3823 WARNING: Please make sure that this value is a multiple of
3824 the Linux page size (normally 4k). If this is not the case,
3825 then the end address of the Linux memory will be located at a
3826 non page size aligned address and this could cause major
3827 problems.
3828
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003829- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003830 Enable temporary baudrate change while serial download
3831
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003832- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003833 Physical start address of SDRAM. _Must_ be 0 here.
3834
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003835- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00003836 Physical start address of Motherboard I/O (if using a
3837 Cogent motherboard)
3838
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003839- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003840 Physical start address of Flash memory.
3841
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003842- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003843 Physical start address of boot monitor code (set by
3844 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02003845 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003846 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003847
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003848- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00003849 Size of memory reserved for monitor code, used to
3850 determine _at_compile_time_ (!) if the environment is
3851 embedded within the U-Boot image, or in a separate
3852 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003853
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003854- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003855 Size of DRAM reserved for malloc() use.
3856
Simon Glassd59476b2014-07-10 22:23:28 -06003857- CONFIG_SYS_MALLOC_F_LEN
3858 Size of the malloc() pool for use before relocation. If
3859 this is defined, then a very simple malloc() implementation
3860 will become available before relocation. The address is just
3861 below the global data, and the stack is moved down to make
3862 space.
3863
3864 This feature allocates regions with increasing addresses
3865 within the region. calloc() is supported, but realloc()
3866 is not available. free() is supported but does nothing.
3867 The memory will be freed (or in fact just forgotton) when
3868 U-Boot relocates itself.
3869
Simon Glasse7b14e92014-09-15 06:33:18 -06003870 Pre-relocation malloc() is only supported on ARM and sandbox
Simon Glass29afe9e2014-07-10 22:23:31 -06003871 at present but is fairly easy to enable for other archs.
3872
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003873- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01003874 Normally compressed uImages are limited to an
3875 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003876 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01003877 to adjust this setting to your needs.
3878
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003879- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003880 Maximum size of memory mapped by the startup code of
3881 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003882 the Linux kernel (bd_info, boot arguments, FDT blob if
3883 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04003884 environment variable is defined and non-zero. In such case
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003885 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003886 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likelyc3624e62011-03-28 09:58:43 +00003887 variable "bootm_mapsize" will override the value of
3888 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3889 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003890
John Rigbyfca43cc2010-10-13 13:57:35 -06003891- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3892 Enable initrd_high functionality. If defined then the
3893 initrd_high feature is enabled and the bootm ramdisk subcommand
3894 is enabled.
3895
3896- CONFIG_SYS_BOOT_GET_CMDLINE:
3897 Enables allocating and saving kernel cmdline in space between
3898 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3899
3900- CONFIG_SYS_BOOT_GET_KBD:
3901 Enables allocating and saving a kernel copy of the bd_info in
3902 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3903
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003904- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003905 Max number of Flash memory banks
3906
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003907- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003908 Max number of sectors on a Flash chip
3909
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003910- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003911 Timeout for Flash erase operations (in ms)
3912
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003913- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003914 Timeout for Flash write operations (in ms)
3915
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003916- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003917 Timeout for Flash set sector lock bit operation (in ms)
3918
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003919- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003920 Timeout for Flash clear lock bits operation (in ms)
3921
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003922- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00003923 If defined, hardware flash sectors protection is used
3924 instead of U-Boot software protection.
3925
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003926- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003927
3928 Enable TFTP transfers directly to flash memory;
3929 without this option such a download has to be
3930 performed in two steps: (1) download to RAM, and (2)
3931 copy from RAM to flash.
3932
3933 The two-step approach is usually more reliable, since
3934 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003935 the flash, but in some situations (when system RAM is
3936 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003937 downloaded image) this option may be very useful.
3938
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003939- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00003940 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00003941 common flash structure for storing flash geometry.
3942
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02003943- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00003944 This option also enables the building of the cfi_flash driver
3945 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003946
Piotr Ziecik91809ed2008-11-17 15:57:58 +01003947- CONFIG_FLASH_CFI_MTD
3948 This option enables the building of the cfi_mtd driver
3949 in the drivers directory. The driver exports CFI flash
3950 to the MTD layer.
3951
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003952- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02003953 Use buffered writes to flash.
3954
3955- CONFIG_FLASH_SPANSION_S29WS_N
3956 s29ws-n MirrorBit flash has non-standard addresses for buffered
3957 write commands.
3958
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003959- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01003960 If this option is defined, the common CFI flash doesn't
3961 print it's warning upon not recognized FLASH banks. This
3962 is useful, if some of the configured banks are only
3963 optionally available.
3964
Jerry Van Baren9a042e92008-03-08 13:48:01 -05003965- CONFIG_FLASH_SHOW_PROGRESS
3966 If defined (must be an integer), print out countdown
3967 digits and dots. Recommended value: 45 (9..1) for 80
3968 column displays, 15 (3..1) for 40 column displays.
3969
Stefan Roese352ef3f2013-04-04 15:53:14 +02003970- CONFIG_FLASH_VERIFY
3971 If defined, the content of the flash (destination) is compared
3972 against the source after the write operation. An error message
3973 will be printed when the contents are not identical.
3974 Please note that this option is useless in nearly all cases,
3975 since such flash programming errors usually are detected earlier
3976 while unprotecting/erasing/programming. Please only enable
3977 this option if you really know what you are doing.
3978
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003979- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003980 Defines the number of Ethernet receive buffers. On some
3981 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00003982 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3983 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003984 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00003985 Defaults to 4 if not defined.
3986
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003987- CONFIG_ENV_MAX_ENTRIES
3988
Wolfgang Denk071bc922010-10-27 22:48:30 +02003989 Maximum number of entries in the hash table that is used
3990 internally to store the environment settings. The default
3991 setting is supposed to be generous and should work in most
3992 cases. This setting can be used to tune behaviour; see
3993 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003994
Joe Hershberger25980902012-12-11 22:16:31 -06003995- CONFIG_ENV_FLAGS_LIST_DEFAULT
3996- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04003997 Enable validation of the values given to environment variables when
Joe Hershberger25980902012-12-11 22:16:31 -06003998 calling env set. Variables can be restricted to only decimal,
3999 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
4000 the variables can also be restricted to IP address or MAC address.
4001
4002 The format of the list is:
4003 type_attribute = [s|d|x|b|i|m]
Joe Hershberger267541f2012-12-11 22:16:34 -06004004 access_atribute = [a|r|o|c]
4005 attributes = type_attribute[access_atribute]
Joe Hershberger25980902012-12-11 22:16:31 -06004006 entry = variable_name[:attributes]
4007 list = entry[,list]
4008
4009 The type attributes are:
4010 s - String (default)
4011 d - Decimal
4012 x - Hexadecimal
4013 b - Boolean ([1yYtT|0nNfF])
4014 i - IP address
4015 m - MAC address
4016
Joe Hershberger267541f2012-12-11 22:16:34 -06004017 The access attributes are:
4018 a - Any (default)
4019 r - Read-only
4020 o - Write-once
4021 c - Change-default
4022
Joe Hershberger25980902012-12-11 22:16:31 -06004023 - CONFIG_ENV_FLAGS_LIST_DEFAULT
4024 Define this to a list (string) to define the ".flags"
4025 envirnoment variable in the default or embedded environment.
4026
4027 - CONFIG_ENV_FLAGS_LIST_STATIC
4028 Define this to a list (string) to define validation that
4029 should be done if an entry is not found in the ".flags"
4030 environment variable. To override a setting in the static
4031 list, simply add an entry for the same variable name to the
4032 ".flags" variable.
4033
Joe Hershberger267541f2012-12-11 22:16:34 -06004034- CONFIG_ENV_ACCESS_IGNORE_FORCE
4035 If defined, don't allow the -f switch to env set override variable
4036 access flags.
4037
Simon Glass5c1a7ea2013-03-08 13:45:27 +00004038- CONFIG_SYS_GENERIC_BOARD
4039 This selects the architecture-generic board system instead of the
4040 architecture-specific board files. It is intended to move boards
4041 to this new framework over time. Defining this will disable the
4042 arch/foo/lib/board.c file and use common/board_f.c and
4043 common/board_r.c instead. To use this option your architecture
4044 must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
4045 its config.mk file). If you find problems enabling this option on
4046 your board please report the problem and send patches!
4047
Lokesh Vutla0b1b60c2013-04-17 20:49:40 +00004048- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
4049 This is set by OMAP boards for the max time that reset should
4050 be asserted. See doc/README.omap-reset-time for details on how
4051 the value can be calulated on a given board.
Simon Glass632efa72013-03-11 07:06:48 +00004052
Gabe Black0d296cc2014-10-15 04:38:30 -06004053- CONFIG_USE_STDINT
4054 If stdint.h is available with your toolchain you can define this
4055 option to enable it. You can provide option 'USE_STDINT=1' when
4056 building U-Boot to enable this.
4057
wdenkc6097192002-11-03 00:24:07 +00004058The following definitions that deal with the placement and management
4059of environment data (variable area); in general, we support the
4060following configurations:
4061
Mike Frysingerc3eb3fe2011-07-08 10:44:25 +00004062- CONFIG_BUILD_ENVCRC:
4063
4064 Builds up envcrc with the target environment so that external utils
4065 may easily extract it and embed it in final U-Boot images.
4066
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02004067- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00004068
4069 Define this if the environment is in flash memory.
4070
4071 a) The environment occupies one whole flash sector, which is
4072 "embedded" in the text segment with the U-Boot code. This
4073 happens usually with "bottom boot sector" or "top boot
4074 sector" type flash chips, which have several smaller
4075 sectors at the start or the end. For instance, such a
4076 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
4077 such a case you would place the environment in one of the
4078 4 kB sectors - with U-Boot code before and after it. With
4079 "top boot sector" type flash chips, you would put the
4080 environment in one of the last sectors, leaving a gap
4081 between U-Boot and the environment.
4082
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004083 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004084
4085 Offset of environment data (variable area) to the
4086 beginning of flash memory; for instance, with bottom boot
4087 type flash chips the second sector can be used: the offset
4088 for this sector is given here.
4089
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004090 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00004091
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004092 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004093
4094 This is just another way to specify the start address of
4095 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004096 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00004097
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004098 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004099
4100 Size of the sector containing the environment.
4101
4102
4103 b) Sometimes flash chips have few, equal sized, BIG sectors.
4104 In such a case you don't want to spend a whole sector for
4105 the environment.
4106
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004107 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004108
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02004109 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004110 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00004111 of this flash sector for the environment. This saves
4112 memory for the RAM copy of the environment.
4113
4114 It may also save flash memory if you decide to use this
4115 when your environment is "embedded" within U-Boot code,
4116 since then the remainder of the flash sector could be used
4117 for U-Boot code. It should be pointed out that this is
4118 STRONGLY DISCOURAGED from a robustness point of view:
4119 updating the environment in flash makes it always
4120 necessary to erase the WHOLE sector. If something goes
4121 wrong before the contents has been restored from a copy in
4122 RAM, your target system will be dead.
4123
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004124 - CONFIG_ENV_ADDR_REDUND
4125 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00004126
wdenk43d96162003-03-06 00:02:04 +00004127 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004128 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00004129 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00004130 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00004131
4132BE CAREFUL! Any changes to the flash layout, and some changes to the
4133source code will make it necessary to adapt <board>/u-boot.lds*
4134accordingly!
4135
4136
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02004137- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00004138
4139 Define this if you have some non-volatile memory device
4140 (NVRAM, battery buffered SRAM) which you want to use for the
4141 environment.
4142
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004143 - CONFIG_ENV_ADDR:
4144 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004145
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004146 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00004147 want to use for environment. It is assumed that this memory
4148 can just be read and written to, without any special
4149 provision.
4150
4151BE CAREFUL! The first access to the environment happens quite early
4152in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004153console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00004154U-Boot will hang.
4155
4156Please note that even with NVRAM we still use a copy of the
4157environment in RAM: we could work on NVRAM directly, but we want to
4158keep settings there always unmodified except somebody uses "saveenv"
4159to save the current settings.
4160
4161
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02004162- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00004163
4164 Use this if you have an EEPROM or similar serial access
4165 device and a driver for it.
4166
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004167 - CONFIG_ENV_OFFSET:
4168 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004169
4170 These two #defines specify the offset and size of the
4171 environment area within the total memory of your EEPROM.
4172
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004173 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004174 If defined, specified the chip address of the EEPROM device.
4175 The default address is zero.
4176
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004177 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00004178 If defined, the number of bits used to address bytes in a
4179 single page in the EEPROM device. A 64 byte page, for example
4180 would require six bits.
4181
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004182 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00004183 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00004184 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00004185
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004186 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00004187 The length in bytes of the EEPROM memory array address. Note
4188 that this is NOT the chip address length!
4189
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004190 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00004191 EEPROM chips that implement "address overflow" are ones
4192 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
4193 address and the extra bits end up in the "chip address" bit
4194 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
4195 byte chips.
4196
4197 Note that we consider the length of the address field to
4198 still be one byte because the extra address bits are hidden
4199 in the chip address.
4200
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004201 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004202 The size in bytes of the EEPROM device.
4203
Heiko Schocher548738b2010-01-07 08:55:40 +01004204 - CONFIG_ENV_EEPROM_IS_ON_I2C
4205 define this, if you have I2C and SPI activated, and your
4206 EEPROM, which holds the environment, is on the I2C bus.
4207
4208 - CONFIG_I2C_ENV_EEPROM_BUS
4209 if you have an Environment on an EEPROM reached over
4210 I2C muxes, you can define here, how to reach this
4211 EEPROM. For example:
4212
Heiko Schocherea818db2013-01-29 08:53:15 +01004213 #define CONFIG_I2C_ENV_EEPROM_BUS 1
Heiko Schocher548738b2010-01-07 08:55:40 +01004214
4215 EEPROM which holds the environment, is reached over
4216 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00004217
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02004218- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00004219
wdenkd4ca31c2004-01-02 14:00:00 +00004220 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00004221 want to use for the environment.
4222
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004223 - CONFIG_ENV_OFFSET:
4224 - CONFIG_ENV_ADDR:
4225 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00004226
4227 These three #defines specify the offset and size of the
4228 environment area within the total memory of your DataFlash placed
4229 at the specified address.
4230
Wu, Joshbd83b592014-07-01 19:30:13 +08004231- CONFIG_ENV_IS_IN_SPI_FLASH:
4232
4233 Define this if you have a SPI Flash memory device which you
4234 want to use for the environment.
4235
4236 - CONFIG_ENV_OFFSET:
4237 - CONFIG_ENV_SIZE:
4238
4239 These two #defines specify the offset and size of the
4240 environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
4241 aligned to an erase sector boundary.
4242
4243 - CONFIG_ENV_SECT_SIZE:
4244
4245 Define the SPI flash's sector size.
4246
4247 - CONFIG_ENV_OFFSET_REDUND (optional):
4248
4249 This setting describes a second storage area of CONFIG_ENV_SIZE
4250 size used to hold a redundant copy of the environment data, so
4251 that there is a valid backup copy in case there is a power failure
4252 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
4253 aligned to an erase sector boundary.
4254
4255 - CONFIG_ENV_SPI_BUS (optional):
4256 - CONFIG_ENV_SPI_CS (optional):
4257
4258 Define the SPI bus and chip select. If not defined they will be 0.
4259
4260 - CONFIG_ENV_SPI_MAX_HZ (optional):
4261
4262 Define the SPI max work clock. If not defined then use 1MHz.
4263
4264 - CONFIG_ENV_SPI_MODE (optional):
4265
4266 Define the SPI work mode. If not defined then use SPI_MODE_3.
4267
Liu Gang0a85a9e2012-03-08 00:33:20 +00004268- CONFIG_ENV_IS_IN_REMOTE:
4269
4270 Define this if you have a remote memory space which you
4271 want to use for the local device's environment.
4272
4273 - CONFIG_ENV_ADDR:
4274 - CONFIG_ENV_SIZE:
4275
4276 These two #defines specify the address and size of the
4277 environment area within the remote memory space. The
4278 local device can get the environment from remote memory
Liu Gangfc54c7f2012-08-09 05:10:01 +00004279 space by SRIO or PCIE links.
Liu Gang0a85a9e2012-03-08 00:33:20 +00004280
4281BE CAREFUL! For some special cases, the local device can not use
4282"saveenv" command. For example, the local device will get the
Liu Gangfc54c7f2012-08-09 05:10:01 +00004283environment stored in a remote NOR flash by SRIO or PCIE link,
4284but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang0a85a9e2012-03-08 00:33:20 +00004285
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02004286- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00004287
4288 Define this if you have a NAND device which you want to use
4289 for the environment.
4290
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004291 - CONFIG_ENV_OFFSET:
4292 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00004293
4294 These two #defines specify the offset and size of the environment
Scott Woodfdd813d2010-09-17 14:38:37 -05004295 area within the first NAND device. CONFIG_ENV_OFFSET must be
4296 aligned to an erase block boundary.
wdenk5779d8d2003-12-06 23:55:10 +00004297
Scott Woodfdd813d2010-09-17 14:38:37 -05004298 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuechere443c942006-03-20 18:02:44 +01004299
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004300 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Woodfdd813d2010-09-17 14:38:37 -05004301 size used to hold a redundant copy of the environment data, so
4302 that there is a valid backup copy in case there is a power failure
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004303 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Woodfdd813d2010-09-17 14:38:37 -05004304 aligned to an erase block boundary.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01004305
Scott Woodfdd813d2010-09-17 14:38:37 -05004306 - CONFIG_ENV_RANGE (optional):
4307
4308 Specifies the length of the region in which the environment
4309 can be written. This should be a multiple of the NAND device's
4310 block size. Specifying a range with more erase blocks than
4311 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
4312 the range to be avoided.
4313
4314 - CONFIG_ENV_OFFSET_OOB (optional):
4315
4316 Enables support for dynamically retrieving the offset of the
4317 environment from block zero's out-of-band data. The
4318 "nand env.oob" command can be used to record this offset.
4319 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
4320 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01004321
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02004322- CONFIG_NAND_ENV_DST
4323
4324 Defines address in RAM to which the nand_spl code should copy the
4325 environment. If redundant environment is used, it will be copied to
4326 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
4327
Joe Hershberger2b744332013-04-08 10:32:51 +00004328- CONFIG_ENV_IS_IN_UBI:
4329
4330 Define this if you have an UBI volume that you want to use for the
4331 environment. This has the benefit of wear-leveling the environment
4332 accesses, which is important on NAND.
4333
4334 - CONFIG_ENV_UBI_PART:
4335
4336 Define this to a string that is the mtd partition containing the UBI.
4337
4338 - CONFIG_ENV_UBI_VOLUME:
4339
4340 Define this to the name of the volume that you want to store the
4341 environment in.
4342
Joe Hershberger785881f2013-04-08 10:32:52 +00004343 - CONFIG_ENV_UBI_VOLUME_REDUND:
4344
4345 Define this to the name of another volume to store a second copy of
4346 the environment in. This will enable redundant environments in UBI.
4347 It is assumed that both volumes are in the same MTD partition.
4348
Joe Hershberger2b744332013-04-08 10:32:51 +00004349 - CONFIG_UBI_SILENCE_MSG
4350 - CONFIG_UBIFS_SILENCE_MSG
4351
4352 You will probably want to define these to avoid a really noisy system
4353 when storing the env in UBI.
4354
Wu, Joshd1db76f2014-06-24 17:31:03 +08004355- CONFIG_ENV_IS_IN_FAT:
4356 Define this if you want to use the FAT file system for the environment.
4357
4358 - FAT_ENV_INTERFACE:
4359
4360 Define this to a string that is the name of the block device.
4361
4362 - FAT_ENV_DEV_AND_PART:
4363
4364 Define this to a string to specify the partition of the device. It can
4365 be as following:
4366
4367 "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
4368 - "D:P": device D partition P. Error occurs if device D has no
4369 partition table.
4370 - "D:0": device D.
4371 - "D" or "D:": device D partition 1 if device D has partition
4372 table, or the whole device D if has no partition
4373 table.
4374 - "D:auto": first partition in device D with bootable flag set.
4375 If none, first valid paratition in device D. If no
4376 partition table then means device D.
4377
4378 - FAT_ENV_FILE:
4379
4380 It's a string of the FAT file name. This file use to store the
4381 envrionment.
4382
4383 - CONFIG_FAT_WRITE:
4384 This should be defined. Otherwise it cannot save the envrionment file.
4385
Stephen Warren06e4ae52013-06-11 15:14:00 -06004386- CONFIG_ENV_IS_IN_MMC:
4387
4388 Define this if you have an MMC device which you want to use for the
4389 environment.
4390
4391 - CONFIG_SYS_MMC_ENV_DEV:
4392
4393 Specifies which MMC device the environment is stored in.
4394
4395 - CONFIG_SYS_MMC_ENV_PART (optional):
4396
4397 Specifies which MMC partition the environment is stored in. If not
4398 set, defaults to partition 0, the user area. Common values might be
4399 1 (first MMC boot partition), 2 (second MMC boot partition).
4400
4401 - CONFIG_ENV_OFFSET:
4402 - CONFIG_ENV_SIZE:
4403
4404 These two #defines specify the offset and size of the environment
4405 area within the specified MMC device.
4406
Stephen Warren5c088ee2013-06-11 15:14:02 -06004407 If offset is positive (the usual case), it is treated as relative to
4408 the start of the MMC partition. If offset is negative, it is treated
4409 as relative to the end of the MMC partition. This can be useful if
4410 your board may be fitted with different MMC devices, which have
4411 different sizes for the MMC partitions, and you always want the
4412 environment placed at the very end of the partition, to leave the
4413 maximum possible space before it, to store other data.
4414
Stephen Warren06e4ae52013-06-11 15:14:00 -06004415 These two values are in units of bytes, but must be aligned to an
4416 MMC sector boundary.
4417
4418 - CONFIG_ENV_OFFSET_REDUND (optional):
4419
4420 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
4421 hold a redundant copy of the environment data. This provides a
4422 valid backup copy in case the other copy is corrupted, e.g. due
4423 to a power failure during a "saveenv" operation.
4424
Stephen Warren5c088ee2013-06-11 15:14:02 -06004425 This value may also be positive or negative; this is handled in the
4426 same way as CONFIG_ENV_OFFSET.
4427
Stephen Warren06e4ae52013-06-11 15:14:00 -06004428 This value is also in units of bytes, but must also be aligned to
4429 an MMC sector boundary.
4430
4431 - CONFIG_ENV_SIZE_REDUND (optional):
4432
4433 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
4434 set. If this value is set, it must be set to the same value as
4435 CONFIG_ENV_SIZE.
4436
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004437- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00004438
4439 Defines offset to the initial SPI buffer area in DPRAM. The
4440 area is used at an early stage (ROM part) if the environment
4441 is configured to reside in the SPI EEPROM: We need a 520 byte
4442 scratch DPRAM area. It is used between the two initialization
4443 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4444 to be a good choice since it makes it far enough from the
4445 start of the data area as well as from the stack pointer.
4446
Bruce Adlere881cb52007-11-02 13:15:42 -07004447Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00004448has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02004449created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00004450until then to read environment variables.
4451
wdenk85ec0bc2003-03-31 16:34:49 +00004452The environment is protected by a CRC32 checksum. Before the monitor
4453is relocated into RAM, as a result of a bad CRC you will be working
4454with the compiled-in default environment - *silently*!!! [This is
4455necessary, because the first environment variable we need is the
4456"baudrate" setting for the console - if we have a bad CRC, we don't
4457have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00004458
4459Note: once the monitor has been relocated, then it will complain if
4460the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00004461use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00004462
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004463- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00004464 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00004465
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004466 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00004467 also needs to be defined.
4468
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004469- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00004470 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00004471
Ron Madridf5675aa2009-02-18 14:30:44 -08004472- CONFIG_NS16550_MIN_FUNCTIONS:
4473 Define this if you desire to only have use of the NS16550_init
4474 and NS16550_putc functions for the serial driver located at
4475 drivers/serial/ns16550.c. This option is useful for saving
4476 space for already greatly restricted images, including but not
4477 limited to NAND_SPL configurations.
4478
Simon Glassb2b92f52012-11-30 13:01:18 +00004479- CONFIG_DISPLAY_BOARDINFO
4480 Display information about the board that U-Boot is running on
4481 when U-Boot starts up. The board function checkboard() is called
4482 to do this.
4483
Simon Glasse2e3e2b2012-11-30 13:01:19 +00004484- CONFIG_DISPLAY_BOARDINFO_LATE
4485 Similar to the previous option, but display this information
4486 later, once stdio is running and output goes to the LCD, if
4487 present.
4488
Sascha Silbefeb85802013-08-11 16:40:43 +02004489- CONFIG_BOARD_SIZE_LIMIT:
4490 Maximum size of the U-Boot image. When defined, the
4491 build system checks that the actual size does not
4492 exceed it.
4493
wdenkc6097192002-11-03 00:24:07 +00004494Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00004495---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004496
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004497- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004498 Cache Line Size of the CPU.
4499
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004500- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00004501 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00004502
wdenk42d1f032003-10-15 23:53:47 +00004503 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
4504 and RPXsuper) to be able to adjust the position of
4505 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00004506
Timur Tabie46fedf2011-08-04 18:03:41 -05004507- CONFIG_SYS_CCSRBAR_DEFAULT:
4508 Default (power-on reset) physical address of CCSR on Freescale
4509 PowerPC SOCs.
4510
4511- CONFIG_SYS_CCSRBAR:
4512 Virtual address of CCSR. On a 32-bit build, this is typically
4513 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4514
4515 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4516 for cross-platform code that uses that macro instead.
4517
4518- CONFIG_SYS_CCSRBAR_PHYS:
4519 Physical address of CCSR. CCSR can be relocated to a new
4520 physical address, if desired. In this case, this macro should
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004521 be set to that address. Otherwise, it should be set to the
Timur Tabie46fedf2011-08-04 18:03:41 -05004522 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
4523 is typically relocated on 36-bit builds. It is recommended
4524 that this macro be defined via the _HIGH and _LOW macros:
4525
4526 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4527 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4528
4529- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denk4cf26092011-10-07 09:58:21 +02004530 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
4531 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabie46fedf2011-08-04 18:03:41 -05004532 used in assembly code, so it must not contain typecasts or
4533 integer size suffixes (e.g. "ULL").
4534
4535- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4536 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
4537 used in assembly code, so it must not contain typecasts or
4538 integer size suffixes (e.g. "ULL").
4539
4540- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4541 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4542 forced to a value that ensures that CCSR is not relocated.
4543
wdenk7f6c2cb2002-11-10 22:06:23 +00004544- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004545 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00004546
4547 the default drive number (default value 0)
4548
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004549 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00004550
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004551 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00004552 (default value 1)
4553
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004554 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00004555
wdenk43d96162003-03-06 00:02:04 +00004556 defines the offset of register from address. It
4557 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004558 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00004559
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004560 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
4561 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00004562 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00004563
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004564 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00004565 fdc_hw_init() is called at the beginning of the FDC
4566 setup. fdc_hw_init() must be provided by the board
4567 source code. It is used to make hardware dependant
4568 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00004569
Macpaul Lin0abddf82011-04-11 20:45:32 +00004570- CONFIG_IDE_AHB:
4571 Most IDE controllers were designed to be connected with PCI
4572 interface. Only few of them were designed for AHB interface.
4573 When software is doing ATA command and data transfer to
4574 IDE devices through IDE-AHB controller, some additional
4575 registers accessing to these kind of IDE-AHB controller
4576 is requierd.
4577
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004578- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00004579 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00004580 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00004581
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004582- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004583
wdenk7152b1d2003-09-05 23:19:14 +00004584 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00004585 initial data and stack; please note that this must be
4586 writable memory that is working WITHOUT special
4587 initialization, i. e. you CANNOT use normal RAM which
4588 will become available only after programming the
4589 memory controller and running certain initialization
4590 sequences.
4591
4592 U-Boot uses the following memory types:
4593 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4594 - MPC824X: data cache
4595 - PPC4xx: data cache
4596
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004597- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004598
4599 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004600 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
4601 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00004602 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02004603 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004604 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
4605 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4606 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00004607
4608 Note:
4609 On the MPC824X (or other systems that use the data
4610 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004611 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00004612 point to an otherwise UNUSED address space between
4613 the top of RAM and the start of the PCI space.
4614
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004615- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00004616
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004617- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00004618
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004619- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00004620
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004621- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00004622
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004623- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00004624
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004625- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00004626
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004627- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00004628 SDRAM timing
4629
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004630- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00004631 periodic timer for refresh
4632
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004633- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00004634
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004635- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4636 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4637 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4638 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004639 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4640
4641- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004642 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4643 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004644 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4645
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004646- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4647 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00004648 Machine Mode Register and Memory Periodic Timer
4649 Prescaler definitions (SDRAM timing)
4650
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004651- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004652 enable I2C microcode relocation patch (MPC8xx);
4653 define relocation offset in DPRAM [DSP2]
4654
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004655- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01004656 enable SMC microcode relocation patch (MPC8xx);
4657 define relocation offset in DPRAM [SMC1]
4658
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004659- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004660 enable SPI microcode relocation patch (MPC8xx);
4661 define relocation offset in DPRAM [SCC4]
4662
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004663- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00004664 Use OSCM clock mode on MBX8xx board. Be careful,
4665 wrong setting might damage your board. Read
4666 doc/README.MBX before setting this variable!
4667
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004668- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00004669 Offset of the bootmode word in DPRAM used by post
4670 (Power On Self Tests). This definition overrides
4671 #define'd default value in commproc.h resp.
4672 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00004673
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004674- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4675 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4676 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4677 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4678 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4679 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4680 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4681 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roesea47a12b2010-04-15 16:07:28 +02004682 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenk5d232d02003-05-22 22:52:13 +00004683
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01004684- CONFIG_PCI_DISABLE_PCIE:
4685 Disable PCI-Express on systems where it is supported but not
4686 required.
4687
Andrew Sharp69fd2d32012-08-29 14:16:32 +00004688- CONFIG_PCI_ENUM_ONLY
4689 Only scan through and get the devices on the busses.
4690 Don't do any setup work, presumably because someone or
4691 something has already done it, and we don't need to do it
4692 a second time. Useful for platforms that are pre-booted
4693 by coreboot or similar.
4694
Gabor Juhos842033e2013-05-30 07:06:12 +00004695- CONFIG_PCI_INDIRECT_BRIDGE:
4696 Enable support for indirect PCI bridges.
4697
Kumar Galaa09b9b62010-12-30 12:09:53 -06004698- CONFIG_SYS_SRIO:
4699 Chip has SRIO or not
4700
4701- CONFIG_SRIO1:
4702 Board has SRIO 1 port available
4703
4704- CONFIG_SRIO2:
4705 Board has SRIO 2 port available
4706
Liu Gangc8b28152013-05-07 16:30:46 +08004707- CONFIG_SRIO_PCIE_BOOT_MASTER
4708 Board can support master function for Boot from SRIO and PCIE
4709
Kumar Galaa09b9b62010-12-30 12:09:53 -06004710- CONFIG_SYS_SRIOn_MEM_VIRT:
4711 Virtual Address of SRIO port 'n' memory region
4712
4713- CONFIG_SYS_SRIOn_MEM_PHYS:
4714 Physical Address of SRIO port 'n' memory region
4715
4716- CONFIG_SYS_SRIOn_MEM_SIZE:
4717 Size of SRIO port 'n' memory region
4718
Fabio Estevam66bd1842013-04-11 09:35:34 +00004719- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4720 Defined to tell the NAND controller that the NAND chip is using
4721 a 16 bit bus.
4722 Not all NAND drivers use this symbol.
Fabio Estevama430e912013-04-11 09:35:35 +00004723 Example of drivers that use it:
Fabio Estevam66bd1842013-04-11 09:35:34 +00004724 - drivers/mtd/nand/ndfc.c
Fabio Estevama430e912013-04-11 09:35:35 +00004725 - drivers/mtd/nand/mxc_nand.c
Alex Watermaneced4622011-05-19 15:08:36 -04004726
4727- CONFIG_SYS_NDFC_EBC0_CFG
4728 Sets the EBC0_CFG register for the NDFC. If not defined
4729 a default value will be used.
4730
Ben Warrenbb99ad62006-09-07 16:50:54 -04004731- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01004732 Get DDR timing information from an I2C EEPROM. Common
4733 with pluggable memory modules such as SODIMMs
4734
Ben Warrenbb99ad62006-09-07 16:50:54 -04004735 SPD_EEPROM_ADDRESS
4736 I2C address of the SPD EEPROM
4737
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004738- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01004739 If SPD EEPROM is on an I2C bus other than the first
4740 one, specify here. Note that the value must resolve
4741 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04004742
York Sun1b3e3c42011-06-07 09:42:16 +08004743- CONFIG_SYS_DDR_RAW_TIMING
4744 Get DDR timing information from other than SPD. Common with
4745 soldered DDR chips onboard without SPD. DDR raw timing
4746 parameters are extracted from datasheet and hard-coded into
4747 header files or board specific files.
4748
York Sun6f5e1dc2011-09-16 13:21:35 -07004749- CONFIG_FSL_DDR_INTERACTIVE
4750 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4751
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004752- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01004753 Only for 83xx systems. If specified, then DDR should
4754 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06004755
wdenkc26e4542004-04-18 10:13:26 +00004756- CONFIG_ETHER_ON_FEC[12]
4757 Define to enable FEC[12] on a 8xx series processor.
4758
4759- CONFIG_FEC[12]_PHY
4760 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00004761 to the given FEC; i. e.
4762 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00004763 means that the PHY with address 4 is connected to FEC1
4764
4765 When set to -1, means to probe for first available.
4766
4767- CONFIG_FEC[12]_PHY_NORXERR
4768 The PHY does not have a RXERR line (RMII only).
4769 (so program the FEC to ignore it).
4770
4771- CONFIG_RMII
4772 Enable RMII mode for all FECs.
4773 Note that this is a global option, we can't
4774 have one FEC in standard MII mode and another in RMII mode.
4775
wdenk5cf91d62004-04-23 20:32:05 +00004776- CONFIG_CRC32_VERIFY
4777 Add a verify option to the crc32 command.
4778 The syntax is:
4779
4780 => crc32 -v <address> <count> <crc32>
4781
4782 Where address/count indicate a memory area
4783 and crc32 is the correct crc32 which the
4784 area should have.
4785
wdenk56523f12004-07-11 17:40:54 +00004786- CONFIG_LOOPW
4787 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05004788 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00004789
stroese7b466642004-12-16 18:46:55 +00004790- CONFIG_MX_CYCLIC
4791 Add the "mdc" and "mwc" memory commands. These are cyclic
4792 "md/mw" commands.
4793 Examples:
4794
wdenkefe2a4d2004-12-16 21:44:03 +00004795 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00004796 This command will print 4 bytes (10,11,12,13) each 500 ms.
4797
wdenkefe2a4d2004-12-16 21:44:03 +00004798 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00004799 This command will write 12345678 to address 100 all 10 ms.
4800
wdenkefe2a4d2004-12-16 21:44:03 +00004801 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05004802 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00004803
wdenk8aa1a2d2005-04-04 12:44:11 +00004804- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Linafc1ce82011-10-19 20:41:11 +00004805 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk844f07d2010-11-27 23:30:56 +01004806 low level initializations (like setting up the memory
4807 controller) are omitted and/or U-Boot does not
4808 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00004809
Wolfgang Denk844f07d2010-11-27 23:30:56 +01004810 Normally this variable MUST NOT be defined. The only
4811 exception is when U-Boot is loaded (to RAM) by some
4812 other boot loader or by a debugger which performs
4813 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00004814
Aneesh V401bb302011-07-13 05:11:07 +00004815- CONFIG_SPL_BUILD
Magnus Liljadf812382009-06-13 20:50:00 +02004816 Modifies the behaviour of start.S when compiling a loader
4817 that is executed before the actual U-Boot. E.g. when
4818 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00004819
Ying Zhang3aa29de2013-08-16 15:16:15 +08004820- CONFIG_TPL_BUILD
4821 Modifies the behaviour of start.S when compiling a loader
4822 that is executed after the SPL and before the actual U-Boot.
4823 It is loaded by the SPL.
4824
Ying Zhang5df572f2013-05-20 14:07:23 +08004825- CONFIG_SYS_MPC85XX_NO_RESETVEC
4826 Only for 85xx systems. If this variable is specified, the section
4827 .resetvec is not kept and the section .bootpg is placed in the
4828 previous 4k of the .text section.
4829
Simon Glass4213fc22013-02-24 17:33:14 +00004830- CONFIG_ARCH_MAP_SYSMEM
4831 Generally U-Boot (and in particular the md command) uses
4832 effective address. It is therefore not necessary to regard
4833 U-Boot address as virtual addresses that need to be translated
4834 to physical addresses. However, sandbox requires this, since
4835 it maintains its own little RAM buffer which contains all
4836 addressable memory. This option causes some memory accesses
4837 to be mapped through map_sysmem() / unmap_sysmem().
4838
Matthias Weisserd8834a12011-03-10 21:36:32 +00004839- CONFIG_USE_ARCH_MEMCPY
4840 CONFIG_USE_ARCH_MEMSET
4841 If these options are used a optimized version of memcpy/memset will
4842 be used if available. These functions may be faster under some
4843 conditions but may increase the binary size.
4844
Simon Glass588a13f2013-02-14 04:18:54 +00004845- CONFIG_X86_RESET_VECTOR
4846 If defined, the x86 reset vector code is included. This is not
4847 needed when U-Boot is running from Coreboot.
Gabe Blackb16f5212012-11-27 21:08:06 +00004848
Mark Jacksonfc337052013-03-04 01:27:20 +00004849- CONFIG_SYS_MPUCLK
4850 Defines the MPU clock speed (in MHz).
4851
4852 NOTE : currently only supported on AM335x platforms.
Gabe Black5b5ece92012-11-29 16:23:41 +00004853
Heiko Schocher16678eb2013-11-04 14:05:00 +01004854- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
4855 Enables the RTC32K OSC on AM33xx based plattforms
4856
Karicheri, Muralidharan999d7d32014-04-04 13:16:50 -04004857- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
4858 Option to disable subpage write in NAND driver
4859 driver that uses this:
4860 drivers/mtd/nand/davinci_nand.c
4861
Timur Tabif2717b42011-11-22 09:21:25 -06004862Freescale QE/FMAN Firmware Support:
4863-----------------------------------
4864
4865The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4866loading of "firmware", which is encoded in the QE firmware binary format.
4867This firmware often needs to be loaded during U-Boot booting, so macros
4868are used to identify the storage device (NOR flash, SPI, etc) and the address
4869within that device.
4870
Zhao Qiangdcf1d772014-03-21 16:21:44 +08004871- CONFIG_SYS_FMAN_FW_ADDR
4872 The address in the storage device where the FMAN microcode is located. The
4873 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4874 is also specified.
4875
4876- CONFIG_SYS_QE_FW_ADDR
4877 The address in the storage device where the QE microcode is located. The
Timur Tabif2717b42011-11-22 09:21:25 -06004878 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4879 is also specified.
4880
4881- CONFIG_SYS_QE_FMAN_FW_LENGTH
4882 The maximum possible size of the firmware. The firmware binary format
4883 has a field that specifies the actual size of the firmware, but it
4884 might not be possible to read any part of the firmware unless some
4885 local storage is allocated to hold the entire firmware first.
4886
4887- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4888 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4889 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
4890 virtual address in NOR flash.
4891
4892- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4893 Specifies that QE/FMAN firmware is located in NAND flash.
4894 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4895
4896- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4897 Specifies that QE/FMAN firmware is located on the primary SD/MMC
4898 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4899
4900- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
4901 Specifies that QE/FMAN firmware is located on the primary SPI
4902 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4903
Liu Gang292dc6c2012-03-08 00:33:18 +00004904- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4905 Specifies that QE/FMAN firmware is located in the remote (master)
4906 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gangfc54c7f2012-08-09 05:10:01 +00004907 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4908 window->master inbound window->master LAW->the ucode address in
4909 master's memory space.
Timur Tabif2717b42011-11-22 09:21:25 -06004910
J. German Riverab940ca62014-06-23 15:15:55 -07004911Freescale Layerscape Management Complex Firmware Support:
4912---------------------------------------------------------
4913The Freescale Layerscape Management Complex (MC) supports the loading of
4914"firmware".
4915This firmware often needs to be loaded during U-Boot booting, so macros
4916are used to identify the storage device (NOR flash, SPI, etc) and the address
4917within that device.
4918
4919- CONFIG_FSL_MC_ENET
4920 Enable the MC driver for Layerscape SoCs.
4921
4922- CONFIG_SYS_LS_MC_FW_ADDR
4923 The address in the storage device where the firmware is located. The
4924 meaning of this address depends on which CONFIG_SYS_LS_MC_FW_IN_xxx macro
4925 is also specified.
4926
4927- CONFIG_SYS_LS_MC_FW_LENGTH
4928 The maximum possible size of the firmware. The firmware binary format
4929 has a field that specifies the actual size of the firmware, but it
4930 might not be possible to read any part of the firmware unless some
4931 local storage is allocated to hold the entire firmware first.
4932
4933- CONFIG_SYS_LS_MC_FW_IN_NOR
4934 Specifies that MC firmware is located in NOR flash, mapped as
4935 normal addressable memory via the LBC. CONFIG_SYS_LS_MC_FW_ADDR is the
4936 virtual address in NOR flash.
4937
wdenkc6097192002-11-03 00:24:07 +00004938Building the Software:
4939======================
4940
Wolfgang Denk218ca722008-03-26 10:40:12 +01004941Building U-Boot has been tested in several native build environments
4942and in many different cross environments. Of course we cannot support
4943all possibly existing versions of cross development tools in all
4944(potentially obsolete) versions. In case of tool chain problems we
4945recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4946which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004947
Wolfgang Denk218ca722008-03-26 10:40:12 +01004948If you are not using a native environment, it is assumed that you
4949have GNU cross compiling tools available in your path. In this case,
4950you must set the environment variable CROSS_COMPILE in your shell.
4951Note that no changes to the Makefile or any other source files are
4952necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00004953
Wolfgang Denk218ca722008-03-26 10:40:12 +01004954 $ CROSS_COMPILE=ppc_4xx-
4955 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00004956
Peter Tyser2f8d3962009-03-13 18:54:51 -05004957Note: If you wish to generate Windows versions of the utilities in
4958 the tools directory you can use the MinGW toolchain
4959 (http://www.mingw.org). Set your HOST tools to the MinGW
4960 toolchain and execute 'make tools'. For example:
4961
4962 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
4963
4964 Binaries such as tools/mkimage.exe will be created which can
4965 be executed on computers running Windows.
4966
Wolfgang Denk218ca722008-03-26 10:40:12 +01004967U-Boot is intended to be simple to build. After installing the
4968sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00004969is done by typing:
4970
Holger Freytherab584d62014-08-04 09:26:05 +02004971 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00004972
Holger Freytherab584d62014-08-04 09:26:05 +02004973where "NAME_defconfig" is the name of one of the existing configu-
Michael Jones4d675ae2012-03-15 22:48:10 +00004974rations; see boards.cfg for supported names.
wdenk54387ac2003-10-08 22:45:44 +00004975
wdenk2729af92004-05-03 20:45:30 +00004976Note: for some board special configuration names may exist; check if
4977 additional information is available from the board vendor; for
4978 instance, the TQM823L systems are available without (standard)
4979 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004980 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00004981
Holger Freytherab584d62014-08-04 09:26:05 +02004982 make TQM823L_defconfig
wdenk2729af92004-05-03 20:45:30 +00004983 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00004984
Holger Freytherab584d62014-08-04 09:26:05 +02004985 make TQM823L_LCD_defconfig
wdenk2729af92004-05-03 20:45:30 +00004986 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00004987
wdenk2729af92004-05-03 20:45:30 +00004988 etc.
wdenkc6097192002-11-03 00:24:07 +00004989
wdenkc6097192002-11-03 00:24:07 +00004990
wdenk2729af92004-05-03 20:45:30 +00004991Finally, type "make all", and you should get some working U-Boot
4992images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00004993
wdenk2729af92004-05-03 20:45:30 +00004994- "u-boot.bin" is a raw binary image
4995- "u-boot" is an image in ELF binary format
4996- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00004997
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004998By default the build is performed locally and the objects are saved
4999in the source directory. One of the two methods can be used to change
5000this behavior and build U-Boot to some external directory:
5001
50021. Add O= to the make command line invocations:
5003
5004 make O=/tmp/build distclean
Holger Freytherab584d62014-08-04 09:26:05 +02005005 make O=/tmp/build NAME_defconfig
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005006 make O=/tmp/build all
5007
Timo Ketolaadbba992014-11-06 14:39:05 +020050082. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005009
Timo Ketolaadbba992014-11-06 14:39:05 +02005010 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005011 make distclean
Holger Freytherab584d62014-08-04 09:26:05 +02005012 make NAME_defconfig
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005013 make all
5014
Timo Ketolaadbba992014-11-06 14:39:05 +02005015Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005016variable.
5017
wdenkc6097192002-11-03 00:24:07 +00005018
wdenk2729af92004-05-03 20:45:30 +00005019Please be aware that the Makefiles assume you are using GNU make, so
5020for instance on NetBSD you might need to use "gmake" instead of
5021native "make".
wdenkc6097192002-11-03 00:24:07 +00005022
wdenkc6097192002-11-03 00:24:07 +00005023
wdenk2729af92004-05-03 20:45:30 +00005024If the system board that you have is not listed, then you will need
5025to port U-Boot to your hardware platform. To do this, follow these
5026steps:
wdenkc6097192002-11-03 00:24:07 +00005027
wdenk2729af92004-05-03 20:45:30 +000050281. Add a new configuration option for your board to the toplevel
Michael Jones4d675ae2012-03-15 22:48:10 +00005029 "boards.cfg" file, using the existing entries as examples.
5030 Follow the instructions there to keep the boards in order.
wdenk2729af92004-05-03 20:45:30 +000050312. Create a new directory to hold your board specific code. Add any
5032 files you need. In your board directory, you will need at least
5033 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
50343. Create a new configuration file "include/configs/<board>.h" for
5035 your board
50363. If you're porting U-Boot to a new CPU, then also create a new
5037 directory to hold your CPU specific code. Add any files you need.
Holger Freytherab584d62014-08-04 09:26:05 +020050384. Run "make <board>_defconfig" with your new name.
wdenk2729af92004-05-03 20:45:30 +000050395. Type "make", and you should get a working "u-boot.srec" file
5040 to be installed on your target system.
50416. Debug and solve any problems that might arise.
5042 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00005043
wdenkc6097192002-11-03 00:24:07 +00005044
wdenk2729af92004-05-03 20:45:30 +00005045Testing of U-Boot Modifications, Ports to New Hardware, etc.:
5046==============================================================
wdenkc6097192002-11-03 00:24:07 +00005047
Wolfgang Denk218ca722008-03-26 10:40:12 +01005048If you have modified U-Boot sources (for instance added a new board
5049or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00005050provide feedback to the other developers. The feedback normally takes
5051the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01005052official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00005053
Wolfgang Denk218ca722008-03-26 10:40:12 +01005054But before you submit such a patch, please verify that your modifi-
5055cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00005056the supported boards compile WITHOUT ANY compiler warnings. To do so,
5057just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01005058for ALL supported system. Be warned, this will take a while. You can
5059select which (cross) compiler to use by passing a `CROSS_COMPILE'
5060environment variable to the script, i. e. to use the ELDK cross tools
5061you can type
wdenkc6097192002-11-03 00:24:07 +00005062
wdenk2729af92004-05-03 20:45:30 +00005063 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00005064
wdenk2729af92004-05-03 20:45:30 +00005065or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00005066
wdenk2729af92004-05-03 20:45:30 +00005067 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00005068
Wolfgang Denk218ca722008-03-26 10:40:12 +01005069When using the MAKEALL script, the default behaviour is to build
5070U-Boot in the source directory. This location can be changed by
5071setting the BUILD_DIR environment variable. Also, for each target
5072built, the MAKEALL script saves two log files (<target>.ERR and
5073<target>.MAKEALL) in the <source dir>/LOG directory. This default
5074location can be changed by setting the MAKEALL_LOGDIR environment
5075variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005076
5077 export BUILD_DIR=/tmp/build
5078 export MAKEALL_LOGDIR=/tmp/log
5079 CROSS_COMPILE=ppc_8xx- MAKEALL
5080
Wolfgang Denk218ca722008-03-26 10:40:12 +01005081With the above settings build objects are saved in the /tmp/build,
5082log files are saved in the /tmp/log and the source tree remains clean
5083during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005084
5085
wdenk2729af92004-05-03 20:45:30 +00005086See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00005087
wdenkc6097192002-11-03 00:24:07 +00005088
wdenk2729af92004-05-03 20:45:30 +00005089Monitor Commands - Overview:
5090============================
wdenkc6097192002-11-03 00:24:07 +00005091
wdenk2729af92004-05-03 20:45:30 +00005092go - start application at address 'addr'
5093run - run commands in an environment variable
5094bootm - boot application image from memory
5095bootp - boot image via network using BootP/TFTP protocol
Marek Vasut44f074c2012-03-14 21:52:45 +00005096bootz - boot zImage from memory
wdenk2729af92004-05-03 20:45:30 +00005097tftpboot- boot image via network using TFTP protocol
5098 and env variables "ipaddr" and "serverip"
5099 (and eventually "gatewayip")
Simon Glass1fb7cd42011-10-24 18:00:07 +00005100tftpput - upload a file via network using TFTP protocol
wdenk2729af92004-05-03 20:45:30 +00005101rarpboot- boot image via network using RARP/TFTP protocol
5102diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
5103loads - load S-Record file over serial line
5104loadb - load binary file over serial line (kermit mode)
5105md - memory display
5106mm - memory modify (auto-incrementing)
5107nm - memory modify (constant address)
5108mw - memory write (fill)
5109cp - memory copy
5110cmp - memory compare
5111crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05005112i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00005113sspi - SPI utility commands
5114base - print or set address offset
5115printenv- print environment variables
5116setenv - set environment variables
5117saveenv - save environment variables to persistent storage
5118protect - enable or disable FLASH write protection
5119erase - erase FLASH memory
5120flinfo - print FLASH memory information
Karl O. Pinc10635af2012-08-03 05:57:21 +00005121nand - NAND memory operations (see doc/README.nand)
wdenk2729af92004-05-03 20:45:30 +00005122bdinfo - print Board Info structure
5123iminfo - print header information for application image
5124coninfo - print console devices and informations
5125ide - IDE sub-system
5126loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00005127loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00005128mtest - simple RAM test
5129icache - enable or disable instruction cache
5130dcache - enable or disable data cache
5131reset - Perform RESET of the CPU
5132echo - echo args to console
5133version - print monitor version
5134help - print online help
5135? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00005136
wdenkc6097192002-11-03 00:24:07 +00005137
wdenk2729af92004-05-03 20:45:30 +00005138Monitor Commands - Detailed Description:
5139========================================
wdenkc6097192002-11-03 00:24:07 +00005140
wdenk2729af92004-05-03 20:45:30 +00005141TODO.
wdenkc6097192002-11-03 00:24:07 +00005142
wdenk2729af92004-05-03 20:45:30 +00005143For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00005144
5145
wdenk2729af92004-05-03 20:45:30 +00005146Environment Variables:
5147======================
wdenkc6097192002-11-03 00:24:07 +00005148
wdenk2729af92004-05-03 20:45:30 +00005149U-Boot supports user configuration using Environment Variables which
5150can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00005151
wdenk2729af92004-05-03 20:45:30 +00005152Environment Variables are set using "setenv", printed using
5153"printenv", and saved to Flash using "saveenv". Using "setenv"
5154without a value can be used to delete a variable from the
5155environment. As long as you don't save the environment you are
5156working with an in-memory copy. In case the Flash area containing the
5157environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00005158
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01005159Some configuration options can be set using Environment Variables.
5160
5161List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00005162
wdenk2729af92004-05-03 20:45:30 +00005163 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00005164
wdenk2729af92004-05-03 20:45:30 +00005165 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00005166
wdenk2729af92004-05-03 20:45:30 +00005167 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00005168
wdenk2729af92004-05-03 20:45:30 +00005169 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00005170
wdenk2729af92004-05-03 20:45:30 +00005171 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00005172
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02005173 bootm_low - Memory range available for image processing in the bootm
5174 command can be restricted. This variable is given as
5175 a hexadecimal number and defines lowest address allowed
5176 for use by the bootm command. See also "bootm_size"
5177 environment variable. Address defined by "bootm_low" is
5178 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00005179 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
5180 bootm_mapsize.
5181
Wolfgang Denkc0f40852011-10-26 10:21:21 +00005182 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likelyc3624e62011-03-28 09:58:43 +00005183 This variable is given as a hexadecimal number and it
5184 defines the size of the memory region starting at base
5185 address bootm_low that is accessible by the Linux kernel
5186 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
5187 as the default value if it is defined, and bootm_size is
5188 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02005189
5190 bootm_size - Memory range available for image processing in the bootm
5191 command can be restricted. This variable is given as
5192 a hexadecimal number and defines the size of the region
5193 allowed for use by the bootm command. See also "bootm_low"
5194 environment variable.
5195
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02005196 updatefile - Location of the software update file on a TFTP server, used
5197 by the automatic software update feature. Please refer to
5198 documentation in doc/README.update for more details.
5199
wdenk2729af92004-05-03 20:45:30 +00005200 autoload - if set to "no" (any string beginning with 'n'),
5201 "bootp" will just load perform a lookup of the
5202 configuration from the BOOTP server, but not try to
5203 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00005204
wdenk2729af92004-05-03 20:45:30 +00005205 autostart - if set to "yes", an image loaded using the "bootp",
5206 "rarpboot", "tftpboot" or "diskboot" commands will
5207 be automatically started (by internally calling
5208 "bootm")
wdenkc6097192002-11-03 00:24:07 +00005209
wdenk2729af92004-05-03 20:45:30 +00005210 If set to "no", a standalone image passed to the
5211 "bootm" command will be copied to the load address
5212 (and eventually uncompressed), but NOT be started.
5213 This can be used to load and uncompress arbitrary
5214 data.
wdenkc6097192002-11-03 00:24:07 +00005215
David A. Longa28afca2011-07-09 16:40:19 -04005216 fdt_high - if set this restricts the maximum address that the
5217 flattened device tree will be copied into upon boot.
Shawn Guofa34f6b2012-01-09 21:54:08 +00005218 For example, if you have a system with 1 GB memory
5219 at physical address 0x10000000, while Linux kernel
5220 only recognizes the first 704 MB as low memory, you
5221 may need to set fdt_high as 0x3C000000 to have the
5222 device tree blob be copied to the maximum address
5223 of the 704 MB low memory, so that Linux kernel can
5224 access it during the boot procedure.
5225
David A. Longa28afca2011-07-09 16:40:19 -04005226 If this is set to the special value 0xFFFFFFFF then
5227 the fdt will not be copied at all on boot. For this
5228 to work it must reside in writable memory, have
5229 sufficient padding on the end of it for u-boot to
5230 add the information it needs into it, and the memory
5231 must be accessible by the kernel.
5232
Simon Glasseea63e02011-10-24 19:15:34 +00005233 fdtcontroladdr- if set this is the address of the control flattened
5234 device tree used by U-Boot when CONFIG_OF_CONTROL is
5235 defined.
5236
wdenk17ea1172004-06-06 21:51:03 +00005237 i2cfast - (PPC405GP|PPC405EP only)
5238 if set to 'y' configures Linux I2C driver for fast
5239 mode (400kHZ). This environment variable is used in
5240 initialization code. So, for changes to be effective
5241 it must be saved and board must be reset.
5242
wdenk2729af92004-05-03 20:45:30 +00005243 initrd_high - restrict positioning of initrd images:
5244 If this variable is not set, initrd images will be
5245 copied to the highest possible address in RAM; this
5246 is usually what you want since it allows for
5247 maximum initrd size. If for some reason you want to
5248 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005249 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00005250 variable to a value of "no" or "off" or "0".
5251 Alternatively, you can set it to a maximum upper
5252 address to use (U-Boot will still check that it
5253 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00005254
wdenk2729af92004-05-03 20:45:30 +00005255 For instance, when you have a system with 16 MB
5256 RAM, and want to reserve 4 MB from use by Linux,
5257 you can do this by adding "mem=12M" to the value of
5258 the "bootargs" variable. However, now you must make
5259 sure that the initrd image is placed in the first
5260 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00005261
wdenk2729af92004-05-03 20:45:30 +00005262 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00005263
wdenk2729af92004-05-03 20:45:30 +00005264 If you set initrd_high to 0xFFFFFFFF, this is an
5265 indication to U-Boot that all addresses are legal
5266 for the Linux kernel, including addresses in flash
5267 memory. In this case U-Boot will NOT COPY the
5268 ramdisk at all. This may be useful to reduce the
5269 boot time on your system, but requires that this
5270 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00005271
wdenk2729af92004-05-03 20:45:30 +00005272 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00005273
wdenk2729af92004-05-03 20:45:30 +00005274 loadaddr - Default load address for commands like "bootp",
5275 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00005276
wdenk2729af92004-05-03 20:45:30 +00005277 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00005278
wdenk2729af92004-05-03 20:45:30 +00005279 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00005280
wdenk2729af92004-05-03 20:45:30 +00005281 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00005282
wdenk2729af92004-05-03 20:45:30 +00005283 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00005284
wdenk2729af92004-05-03 20:45:30 +00005285 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00005286
Mike Frysingere2a53452011-10-02 10:01:27 +00005287 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00005288
Mike Frysingere2a53452011-10-02 10:01:27 +00005289 ethact - controls which interface is currently active.
5290 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00005291
Heiko Schocher48690d82010-07-20 17:45:02 +02005292 => setenv ethact FEC
5293 => ping 192.168.0.1 # traffic sent on FEC
5294 => setenv ethact SCC
5295 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00005296
Matthias Fuchse1692572008-01-17 07:45:05 +01005297 ethrotate - When set to "no" U-Boot does not go through all
5298 available network interfaces.
5299 It just stays at the currently selected interface.
5300
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01005301 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00005302 either succeed or fail without retrying.
5303 When set to "once" the network operation will
5304 fail when all the available network interfaces
5305 are tried once without success.
5306 Useful on scripts which control the retry operation
5307 themselves.
wdenkc6097192002-11-03 00:24:07 +00005308
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01005309 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01005310
Simon Glass8d51aac2013-07-16 20:10:00 -07005311 silent_linux - If set then linux will be told to boot silently, by
5312 changing the console to be empty. If "yes" it will be
5313 made silent. If "no" it will not be made silent. If
5314 unset, then it will be made silent if the U-Boot console
5315 is silent.
5316
Wolfgang Denk28cb9372005-09-24 23:25:46 +02005317 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02005318 UDP source port.
5319
Wolfgang Denk28cb9372005-09-24 23:25:46 +02005320 tftpdstport - If this is set, the value is used for TFTP's UDP
5321 destination port instead of the Well Know Port 69.
5322
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01005323 tftpblocksize - Block size to use for TFTP transfers; if not set,
5324 we use the TFTP server's default block size
5325
5326 tftptimeout - Retransmission timeout for TFTP packets (in milli-
5327 seconds, minimum value is 1000 = 1 second). Defines
5328 when a packet is considered to be lost so it has to
5329 be retransmitted. The default is 5000 = 5 seconds.
5330 Lowering this value may make downloads succeed
5331 faster in networks with high packet loss rates or
5332 with unreliable TFTP servers.
5333
5334 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005335 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00005336 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00005337
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00005338The following image location variables contain the location of images
5339used in booting. The "Image" column gives the role of the image and is
5340not an environment variable name. The other columns are environment
5341variable names. "File Name" gives the name of the file on a TFTP
5342server, "RAM Address" gives the location in RAM the image will be
5343loaded to, and "Flash Location" gives the image's address in NOR
5344flash or offset in NAND flash.
5345
5346*Note* - these variables don't have to be defined for all boards, some
5347boards currenlty use other variables for these purposes, and some
5348boards use these variables for other purposes.
5349
Wolfgang Denkc0f40852011-10-26 10:21:21 +00005350Image File Name RAM Address Flash Location
5351----- --------- ----------- --------------
5352u-boot u-boot u-boot_addr_r u-boot_addr
5353Linux kernel bootfile kernel_addr_r kernel_addr
5354device tree blob fdtfile fdt_addr_r fdt_addr
5355ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00005356
wdenk2729af92004-05-03 20:45:30 +00005357The following environment variables may be used and automatically
5358updated by the network boot commands ("bootp" and "rarpboot"),
5359depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00005360
wdenk2729af92004-05-03 20:45:30 +00005361 bootfile - see above
5362 dnsip - IP address of your Domain Name Server
5363 dnsip2 - IP address of your secondary Domain Name Server
5364 gatewayip - IP address of the Gateway (Router) to use
5365 hostname - Target hostname
5366 ipaddr - see above
5367 netmask - Subnet Mask
5368 rootpath - Pathname of the root filesystem on the NFS server
5369 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00005370
wdenka3d991b2004-04-15 21:48:45 +00005371
wdenk2729af92004-05-03 20:45:30 +00005372There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005373
wdenk2729af92004-05-03 20:45:30 +00005374 serial# - contains hardware identification information such
5375 as type string and/or serial number
5376 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00005377
wdenk2729af92004-05-03 20:45:30 +00005378These variables can be set only once (usually during manufacturing of
5379the board). U-Boot refuses to delete or overwrite these variables
5380once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00005381
5382
wdenk2729af92004-05-03 20:45:30 +00005383Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005384
wdenk2729af92004-05-03 20:45:30 +00005385 ver - Contains the U-Boot version string as printed
5386 with the "version" command. This variable is
5387 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00005388
wdenkc6097192002-11-03 00:24:07 +00005389
wdenk2729af92004-05-03 20:45:30 +00005390Please note that changes to some configuration parameters may take
5391only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00005392
stroesec1551ea2003-04-04 15:53:41 +00005393
Joe Hershberger170ab112012-12-11 22:16:24 -06005394Callback functions for environment variables:
5395---------------------------------------------
5396
5397For some environment variables, the behavior of u-boot needs to change
5398when their values are changed. This functionailty allows functions to
5399be associated with arbitrary variables. On creation, overwrite, or
5400deletion, the callback will provide the opportunity for some side
5401effect to happen or for the change to be rejected.
5402
5403The callbacks are named and associated with a function using the
5404U_BOOT_ENV_CALLBACK macro in your board or driver code.
5405
5406These callbacks are associated with variables in one of two ways. The
5407static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5408in the board configuration to a string that defines a list of
5409associations. The list must be in the following format:
5410
5411 entry = variable_name[:callback_name]
5412 list = entry[,list]
5413
5414If the callback name is not specified, then the callback is deleted.
5415Spaces are also allowed anywhere in the list.
5416
5417Callbacks can also be associated by defining the ".callbacks" variable
5418with the same list format above. Any association in ".callbacks" will
5419override any association in the static list. You can define
5420CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
5421".callbacks" envirnoment variable in the default or embedded environment.
5422
5423
wdenk2729af92004-05-03 20:45:30 +00005424Command Line Parsing:
5425=====================
stroesec1551ea2003-04-04 15:53:41 +00005426
wdenk2729af92004-05-03 20:45:30 +00005427There are two different command line parsers available with U-Boot:
5428the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00005429
wdenk2729af92004-05-03 20:45:30 +00005430Old, simple command line parser:
5431--------------------------------
wdenkc6097192002-11-03 00:24:07 +00005432
wdenk2729af92004-05-03 20:45:30 +00005433- supports environment variables (through setenv / saveenv commands)
5434- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01005435- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00005436- special characters ('$', ';') can be escaped by prefixing with '\',
5437 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01005438 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00005439- You can also escape text by enclosing in single apostrophes, for example:
5440 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00005441
wdenk2729af92004-05-03 20:45:30 +00005442Hush shell:
5443-----------
wdenkf07771c2003-05-28 08:06:31 +00005444
wdenk2729af92004-05-03 20:45:30 +00005445- similar to Bourne shell, with control structures like
5446 if...then...else...fi, for...do...done; while...do...done,
5447 until...do...done, ...
5448- supports environment ("global") variables (through setenv / saveenv
5449 commands) and local shell variables (through standard shell syntax
5450 "name=value"); only environment variables can be used with "run"
5451 command
wdenkf07771c2003-05-28 08:06:31 +00005452
wdenk2729af92004-05-03 20:45:30 +00005453General rules:
5454--------------
wdenkf07771c2003-05-28 08:06:31 +00005455
wdenk2729af92004-05-03 20:45:30 +00005456(1) If a command line (or an environment variable executed by a "run"
5457 command) contains several commands separated by semicolon, and
5458 one of these commands fails, then the remaining commands will be
5459 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00005460
wdenk2729af92004-05-03 20:45:30 +00005461(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005462 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00005463 command will cause "run" to terminate, i. e. the remaining
5464 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00005465
wdenk2729af92004-05-03 20:45:30 +00005466Note for Redundant Ethernet Interfaces:
5467=======================================
wdenkf07771c2003-05-28 08:06:31 +00005468
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005469Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00005470such configurations and is capable of automatic selection of a
5471"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00005472
wdenk2729af92004-05-03 20:45:30 +00005473Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
5474MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5475"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00005476
wdenk2729af92004-05-03 20:45:30 +00005477If the network interface stores some valid MAC address (for instance
5478in SROM), this is used as default address if there is NO correspon-
5479ding setting in the environment; if the corresponding environment
5480variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00005481
wdenk2729af92004-05-03 20:45:30 +00005482o If the SROM has a valid MAC address, and there is no address in the
5483 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00005484
wdenk2729af92004-05-03 20:45:30 +00005485o If there is no valid address in the SROM, and a definition in the
5486 environment exists, then the value from the environment variable is
5487 used.
wdenkc6097192002-11-03 00:24:07 +00005488
wdenk2729af92004-05-03 20:45:30 +00005489o If both the SROM and the environment contain a MAC address, and
5490 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00005491
wdenk2729af92004-05-03 20:45:30 +00005492o If both the SROM and the environment contain a MAC address, and the
5493 addresses differ, the value from the environment is used and a
5494 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00005495
wdenk2729af92004-05-03 20:45:30 +00005496o If neither SROM nor the environment contain a MAC address, an error
5497 is raised.
wdenkc6097192002-11-03 00:24:07 +00005498
Ben Warrenecee9322010-04-26 11:11:46 -07005499If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denkc0f40852011-10-26 10:21:21 +00005500will be programmed into hardware as part of the initialization process. This
Ben Warrenecee9322010-04-26 11:11:46 -07005501may be skipped by setting the appropriate 'ethmacskip' environment variable.
5502The naming convention is as follows:
5503"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00005504
wdenk2729af92004-05-03 20:45:30 +00005505Image Formats:
5506==============
wdenkc6097192002-11-03 00:24:07 +00005507
Marian Balakowicz3310c542008-03-12 12:13:13 +01005508U-Boot is capable of booting (and performing other auxiliary operations on)
5509images in two formats:
5510
5511New uImage format (FIT)
5512-----------------------
5513
5514Flexible and powerful format based on Flattened Image Tree -- FIT (similar
5515to Flattened Device Tree). It allows the use of images with multiple
5516components (several kernels, ramdisks, etc.), with contents protected by
5517SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
5518
5519
5520Old uImage format
5521-----------------
5522
5523Old image format is based on binary files which can be basically anything,
5524preceded by a special header; see the definitions in include/image.h for
5525details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00005526
wdenk2729af92004-05-03 20:45:30 +00005527* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5528 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05005529 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5530 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5531 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02005532* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Linafc1ce82011-10-19 20:41:11 +00005533 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5534 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00005535* Compression Type (uncompressed, gzip, bzip2)
5536* Load Address
5537* Entry Point
5538* Image Name
5539* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00005540
wdenk2729af92004-05-03 20:45:30 +00005541The header is marked by a special Magic Number, and both the header
5542and the data portions of the image are secured against corruption by
5543CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00005544
wdenkc6097192002-11-03 00:24:07 +00005545
wdenk2729af92004-05-03 20:45:30 +00005546Linux Support:
5547==============
wdenkc6097192002-11-03 00:24:07 +00005548
wdenk2729af92004-05-03 20:45:30 +00005549Although U-Boot should support any OS or standalone application
5550easily, the main focus has always been on Linux during the design of
5551U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005552
wdenk2729af92004-05-03 20:45:30 +00005553U-Boot includes many features that so far have been part of some
5554special "boot loader" code within the Linux kernel. Also, any
5555"initrd" images to be used are no longer part of one big Linux image;
5556instead, kernel and "initrd" are separate images. This implementation
5557serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00005558
wdenk2729af92004-05-03 20:45:30 +00005559- the same features can be used for other OS or standalone
5560 applications (for instance: using compressed images to reduce the
5561 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00005562
wdenk2729af92004-05-03 20:45:30 +00005563- it becomes much easier to port new Linux kernel versions because
5564 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00005565
wdenk2729af92004-05-03 20:45:30 +00005566- the same Linux kernel image can now be used with different "initrd"
5567 images; of course this also means that different kernel images can
5568 be run with the same "initrd". This makes testing easier (you don't
5569 have to build a new "zImage.initrd" Linux image when you just
5570 change a file in your "initrd"). Also, a field-upgrade of the
5571 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00005572
wdenkc6097192002-11-03 00:24:07 +00005573
wdenk2729af92004-05-03 20:45:30 +00005574Linux HOWTO:
5575============
wdenkc6097192002-11-03 00:24:07 +00005576
wdenk2729af92004-05-03 20:45:30 +00005577Porting Linux to U-Boot based systems:
5578---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00005579
wdenk2729af92004-05-03 20:45:30 +00005580U-Boot cannot save you from doing all the necessary modifications to
5581configure the Linux device drivers for use with your target hardware
5582(no, we don't intend to provide a full virtual machine interface to
5583Linux :-).
wdenkc6097192002-11-03 00:24:07 +00005584
Stefan Roesea47a12b2010-04-15 16:07:28 +02005585But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00005586
wdenk2729af92004-05-03 20:45:30 +00005587Just make sure your machine specific header file (for instance
5588include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02005589Information structure as we define in include/asm-<arch>/u-boot.h,
5590and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005591as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00005592
Simon Glass2eb31b12014-06-11 23:29:46 -06005593Note that U-Boot now has a driver model, a unified model for drivers.
5594If you are adding a new driver, plumb it into driver model. If there
5595is no uclass available, you are encouraged to create one. See
5596doc/driver-model.
5597
wdenkc6097192002-11-03 00:24:07 +00005598
wdenk2729af92004-05-03 20:45:30 +00005599Configuring the Linux kernel:
5600-----------------------------
wdenkc6097192002-11-03 00:24:07 +00005601
wdenk2729af92004-05-03 20:45:30 +00005602No specific requirements for U-Boot. Make sure you have some root
5603device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00005604
wdenkc6097192002-11-03 00:24:07 +00005605
wdenk2729af92004-05-03 20:45:30 +00005606Building a Linux Image:
5607-----------------------
wdenkc6097192002-11-03 00:24:07 +00005608
wdenk2729af92004-05-03 20:45:30 +00005609With U-Boot, "normal" build targets like "zImage" or "bzImage" are
5610not used. If you use recent kernel source, a new build target
5611"uImage" will exist which automatically builds an image usable by
5612U-Boot. Most older kernels also have support for a "pImage" target,
5613which was introduced for our predecessor project PPCBoot and uses a
5614100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00005615
wdenk2729af92004-05-03 20:45:30 +00005616Example:
wdenkc6097192002-11-03 00:24:07 +00005617
Holger Freytherab584d62014-08-04 09:26:05 +02005618 make TQM850L_defconfig
wdenk2729af92004-05-03 20:45:30 +00005619 make oldconfig
5620 make dep
5621 make uImage
wdenkc6097192002-11-03 00:24:07 +00005622
wdenk2729af92004-05-03 20:45:30 +00005623The "uImage" build target uses a special tool (in 'tools/mkimage') to
5624encapsulate a compressed Linux kernel image with header information,
5625CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00005626
wdenk2729af92004-05-03 20:45:30 +00005627* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00005628
wdenk2729af92004-05-03 20:45:30 +00005629* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00005630
wdenk2729af92004-05-03 20:45:30 +00005631 ${CROSS_COMPILE}-objcopy -O binary \
5632 -R .note -R .comment \
5633 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00005634
wdenk2729af92004-05-03 20:45:30 +00005635* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00005636
wdenk2729af92004-05-03 20:45:30 +00005637 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00005638
wdenk2729af92004-05-03 20:45:30 +00005639* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00005640
wdenk2729af92004-05-03 20:45:30 +00005641 mkimage -A ppc -O linux -T kernel -C gzip \
5642 -a 0 -e 0 -n "Linux Kernel Image" \
5643 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00005644
wdenk24ee89b2002-11-03 17:56:27 +00005645
wdenk2729af92004-05-03 20:45:30 +00005646The "mkimage" tool can also be used to create ramdisk images for use
5647with U-Boot, either separated from the Linux kernel image, or
5648combined into one file. "mkimage" encapsulates the images with a 64
5649byte header containing information about target architecture,
5650operating system, image type, compression method, entry points, time
5651stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00005652
wdenk2729af92004-05-03 20:45:30 +00005653"mkimage" can be called in two ways: to verify existing images and
5654print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00005655
wdenk2729af92004-05-03 20:45:30 +00005656In the first form (with "-l" option) mkimage lists the information
5657contained in the header of an existing U-Boot image; this includes
5658checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00005659
wdenk2729af92004-05-03 20:45:30 +00005660 tools/mkimage -l image
5661 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00005662
wdenk2729af92004-05-03 20:45:30 +00005663The second form (with "-d" option) is used to build a U-Boot image
5664from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00005665
wdenk2729af92004-05-03 20:45:30 +00005666 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5667 -n name -d data_file image
5668 -A ==> set architecture to 'arch'
5669 -O ==> set operating system to 'os'
5670 -T ==> set image type to 'type'
5671 -C ==> set compression type 'comp'
5672 -a ==> set load address to 'addr' (hex)
5673 -e ==> set entry point to 'ep' (hex)
5674 -n ==> set image name to 'name'
5675 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00005676
wdenk69459792004-05-29 16:53:29 +00005677Right now, all Linux kernels for PowerPC systems use the same load
5678address (0x00000000), but the entry point address depends on the
5679kernel version:
wdenkc6097192002-11-03 00:24:07 +00005680
wdenk2729af92004-05-03 20:45:30 +00005681- 2.2.x kernels have the entry point at 0x0000000C,
5682- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00005683
wdenk2729af92004-05-03 20:45:30 +00005684So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00005685
wdenk2729af92004-05-03 20:45:30 +00005686 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5687 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02005688 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00005689 > examples/uImage.TQM850L
5690 Image Name: 2.4.4 kernel for TQM850L
5691 Created: Wed Jul 19 02:34:59 2000
5692 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5693 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5694 Load Address: 0x00000000
5695 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005696
wdenk2729af92004-05-03 20:45:30 +00005697To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00005698
wdenk2729af92004-05-03 20:45:30 +00005699 -> tools/mkimage -l examples/uImage.TQM850L
5700 Image Name: 2.4.4 kernel for TQM850L
5701 Created: Wed Jul 19 02:34:59 2000
5702 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5703 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5704 Load Address: 0x00000000
5705 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005706
wdenk2729af92004-05-03 20:45:30 +00005707NOTE: for embedded systems where boot time is critical you can trade
5708speed for memory and install an UNCOMPRESSED image instead: this
5709needs more space in Flash, but boots much faster since it does not
5710need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00005711
Stefan Roesea47a12b2010-04-15 16:07:28 +02005712 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00005713 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5714 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02005715 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00005716 > examples/uImage.TQM850L-uncompressed
5717 Image Name: 2.4.4 kernel for TQM850L
5718 Created: Wed Jul 19 02:34:59 2000
5719 Image Type: PowerPC Linux Kernel Image (uncompressed)
5720 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5721 Load Address: 0x00000000
5722 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005723
wdenkc6097192002-11-03 00:24:07 +00005724
wdenk2729af92004-05-03 20:45:30 +00005725Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5726when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00005727
wdenk2729af92004-05-03 20:45:30 +00005728 -> tools/mkimage -n 'Simple Ramdisk Image' \
5729 > -A ppc -O linux -T ramdisk -C gzip \
5730 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5731 Image Name: Simple Ramdisk Image
5732 Created: Wed Jan 12 14:01:50 2000
5733 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5734 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5735 Load Address: 0x00000000
5736 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00005737
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -07005738The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5739option performs the converse operation of the mkimage's second form (the "-d"
5740option). Given an image built by mkimage, the dumpimage extracts a "data file"
5741from the image:
5742
5743 tools/dumpimage -i image -p position data_file
5744 -i ==> extract from the 'image' a specific 'data_file', \
5745 indexed by 'position'
5746
wdenkdb01a2e2004-04-15 23:14:49 +00005747
wdenk2729af92004-05-03 20:45:30 +00005748Installing a Linux Image:
5749-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00005750
wdenk2729af92004-05-03 20:45:30 +00005751To downloading a U-Boot image over the serial (console) interface,
5752you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00005753
wdenk2729af92004-05-03 20:45:30 +00005754 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00005755
wdenk2729af92004-05-03 20:45:30 +00005756The 'objcopy' does not understand the information in the U-Boot
5757image header, so the resulting S-Record file will be relative to
5758address 0x00000000. To load it to a given address, you need to
5759specify the target address as 'offset' parameter with the 'loads'
5760command.
wdenkc6097192002-11-03 00:24:07 +00005761
wdenk2729af92004-05-03 20:45:30 +00005762Example: install the image to address 0x40100000 (which on the
5763TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00005764
wdenk2729af92004-05-03 20:45:30 +00005765 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00005766
wdenk2729af92004-05-03 20:45:30 +00005767 .......... done
5768 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00005769
wdenk2729af92004-05-03 20:45:30 +00005770 => loads 40100000
5771 ## Ready for S-Record download ...
5772 ~>examples/image.srec
5773 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5774 ...
5775 15989 15990 15991 15992
5776 [file transfer complete]
5777 [connected]
5778 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005779
5780
wdenk2729af92004-05-03 20:45:30 +00005781You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01005782this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00005783corruption happened:
wdenkc6097192002-11-03 00:24:07 +00005784
wdenk2729af92004-05-03 20:45:30 +00005785 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00005786
wdenk2729af92004-05-03 20:45:30 +00005787 ## Checking Image at 40100000 ...
5788 Image Name: 2.2.13 for initrd on TQM850L
5789 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5790 Data Size: 335725 Bytes = 327 kB = 0 MB
5791 Load Address: 00000000
5792 Entry Point: 0000000c
5793 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005794
5795
wdenk2729af92004-05-03 20:45:30 +00005796Boot Linux:
5797-----------
wdenkc6097192002-11-03 00:24:07 +00005798
wdenk2729af92004-05-03 20:45:30 +00005799The "bootm" command is used to boot an application that is stored in
5800memory (RAM or Flash). In case of a Linux kernel image, the contents
5801of the "bootargs" environment variable is passed to the kernel as
5802parameters. You can check and modify this variable using the
5803"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00005804
5805
wdenk2729af92004-05-03 20:45:30 +00005806 => printenv bootargs
5807 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00005808
wdenk2729af92004-05-03 20:45:30 +00005809 => 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 +00005810
wdenk2729af92004-05-03 20:45:30 +00005811 => printenv bootargs
5812 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 +00005813
wdenk2729af92004-05-03 20:45:30 +00005814 => bootm 40020000
5815 ## Booting Linux kernel at 40020000 ...
5816 Image Name: 2.2.13 for NFS on TQM850L
5817 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5818 Data Size: 381681 Bytes = 372 kB = 0 MB
5819 Load Address: 00000000
5820 Entry Point: 0000000c
5821 Verifying Checksum ... OK
5822 Uncompressing Kernel Image ... OK
5823 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
5824 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5825 time_init: decrementer frequency = 187500000/60
5826 Calibrating delay loop... 49.77 BogoMIPS
5827 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5828 ...
wdenkc6097192002-11-03 00:24:07 +00005829
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005830If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00005831the memory addresses of both the kernel and the initrd image (PPBCOOT
5832format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00005833
wdenk2729af92004-05-03 20:45:30 +00005834 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00005835
wdenk2729af92004-05-03 20:45:30 +00005836 ## Checking Image at 40100000 ...
5837 Image Name: 2.2.13 for initrd on TQM850L
5838 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5839 Data Size: 335725 Bytes = 327 kB = 0 MB
5840 Load Address: 00000000
5841 Entry Point: 0000000c
5842 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005843
wdenk2729af92004-05-03 20:45:30 +00005844 ## Checking Image at 40200000 ...
5845 Image Name: Simple Ramdisk Image
5846 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5847 Data Size: 566530 Bytes = 553 kB = 0 MB
5848 Load Address: 00000000
5849 Entry Point: 00000000
5850 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005851
wdenk2729af92004-05-03 20:45:30 +00005852 => bootm 40100000 40200000
5853 ## Booting Linux kernel at 40100000 ...
5854 Image Name: 2.2.13 for initrd on TQM850L
5855 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5856 Data Size: 335725 Bytes = 327 kB = 0 MB
5857 Load Address: 00000000
5858 Entry Point: 0000000c
5859 Verifying Checksum ... OK
5860 Uncompressing Kernel Image ... OK
5861 ## Loading RAMDisk Image at 40200000 ...
5862 Image Name: Simple Ramdisk Image
5863 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5864 Data Size: 566530 Bytes = 553 kB = 0 MB
5865 Load Address: 00000000
5866 Entry Point: 00000000
5867 Verifying Checksum ... OK
5868 Loading Ramdisk ... OK
5869 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
5870 Boot arguments: root=/dev/ram
5871 time_init: decrementer frequency = 187500000/60
5872 Calibrating delay loop... 49.77 BogoMIPS
5873 ...
5874 RAMDISK: Compressed image found at block 0
5875 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00005876
wdenk2729af92004-05-03 20:45:30 +00005877 bash#
wdenkc6097192002-11-03 00:24:07 +00005878
Matthew McClintock02677682006-06-28 10:41:37 -05005879Boot Linux and pass a flat device tree:
5880-----------
5881
5882First, U-Boot must be compiled with the appropriate defines. See the section
5883titled "Linux Kernel Interface" above for a more in depth explanation. The
5884following is an example of how to start a kernel and pass an updated
5885flat device tree:
5886
5887=> print oftaddr
5888oftaddr=0x300000
5889=> print oft
5890oft=oftrees/mpc8540ads.dtb
5891=> tftp $oftaddr $oft
5892Speed: 1000, full duplex
5893Using TSEC0 device
5894TFTP from server 192.168.1.1; our IP address is 192.168.1.101
5895Filename 'oftrees/mpc8540ads.dtb'.
5896Load address: 0x300000
5897Loading: #
5898done
5899Bytes transferred = 4106 (100a hex)
5900=> tftp $loadaddr $bootfile
5901Speed: 1000, full duplex
5902Using TSEC0 device
5903TFTP from server 192.168.1.1; our IP address is 192.168.1.2
5904Filename 'uImage'.
5905Load address: 0x200000
5906Loading:############
5907done
5908Bytes transferred = 1029407 (fb51f hex)
5909=> print loadaddr
5910loadaddr=200000
5911=> print oftaddr
5912oftaddr=0x300000
5913=> bootm $loadaddr - $oftaddr
5914## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01005915 Image Name: Linux-2.6.17-dirty
5916 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5917 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05005918 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01005919 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05005920 Verifying Checksum ... OK
5921 Uncompressing Kernel Image ... OK
5922Booting using flat device tree at 0x300000
5923Using MPC85xx ADS machine description
5924Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
5925[snip]
5926
5927
wdenk2729af92004-05-03 20:45:30 +00005928More About U-Boot Image Types:
5929------------------------------
wdenk6069ff22003-02-28 00:49:47 +00005930
wdenk2729af92004-05-03 20:45:30 +00005931U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00005932
wdenk2729af92004-05-03 20:45:30 +00005933 "Standalone Programs" are directly runnable in the environment
5934 provided by U-Boot; it is expected that (if they behave
5935 well) you can continue to work in U-Boot after return from
5936 the Standalone Program.
5937 "OS Kernel Images" are usually images of some Embedded OS which
5938 will take over control completely. Usually these programs
5939 will install their own set of exception handlers, device
5940 drivers, set up the MMU, etc. - this means, that you cannot
5941 expect to re-enter U-Boot except by resetting the CPU.
5942 "RAMDisk Images" are more or less just data blocks, and their
5943 parameters (address, size) are passed to an OS kernel that is
5944 being started.
5945 "Multi-File Images" contain several images, typically an OS
5946 (Linux) kernel image and one or more data images like
5947 RAMDisks. This construct is useful for instance when you want
5948 to boot over the network using BOOTP etc., where the boot
5949 server provides just a single image file, but you want to get
5950 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00005951
wdenk2729af92004-05-03 20:45:30 +00005952 "Multi-File Images" start with a list of image sizes, each
5953 image size (in bytes) specified by an "uint32_t" in network
5954 byte order. This list is terminated by an "(uint32_t)0".
5955 Immediately after the terminating 0 follow the images, one by
5956 one, all aligned on "uint32_t" boundaries (size rounded up to
5957 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00005958
wdenk2729af92004-05-03 20:45:30 +00005959 "Firmware Images" are binary images containing firmware (like
5960 U-Boot or FPGA images) which usually will be programmed to
5961 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00005962
wdenk2729af92004-05-03 20:45:30 +00005963 "Script files" are command sequences that will be executed by
5964 U-Boot's command interpreter; this feature is especially
5965 useful when you configure U-Boot to use a real shell (hush)
5966 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00005967
Marek Vasut44f074c2012-03-14 21:52:45 +00005968Booting the Linux zImage:
5969-------------------------
5970
5971On some platforms, it's possible to boot Linux zImage. This is done
5972using the "bootz" command. The syntax of "bootz" command is the same
5973as the syntax of "bootm" command.
5974
Tom Rini8ac28562013-05-16 11:40:11 -04005975Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut017e1f32012-03-18 11:47:58 +00005976kernel with raw initrd images. The syntax is slightly different, the
5977address of the initrd must be augmented by it's size, in the following
5978format: "<initrd addres>:<initrd size>".
5979
wdenkc6097192002-11-03 00:24:07 +00005980
wdenk2729af92004-05-03 20:45:30 +00005981Standalone HOWTO:
5982=================
wdenkc6097192002-11-03 00:24:07 +00005983
wdenk2729af92004-05-03 20:45:30 +00005984One of the features of U-Boot is that you can dynamically load and
5985run "standalone" applications, which can use some resources of
5986U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00005987
wdenk2729af92004-05-03 20:45:30 +00005988Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00005989
wdenk2729af92004-05-03 20:45:30 +00005990"Hello World" Demo:
5991-------------------
wdenkc6097192002-11-03 00:24:07 +00005992
wdenk2729af92004-05-03 20:45:30 +00005993'examples/hello_world.c' contains a small "Hello World" Demo
5994application; it is automatically compiled when you build U-Boot.
5995It's configured to run at address 0x00040004, so you can play with it
5996like that:
wdenkc6097192002-11-03 00:24:07 +00005997
wdenk2729af92004-05-03 20:45:30 +00005998 => loads
5999 ## Ready for S-Record download ...
6000 ~>examples/hello_world.srec
6001 1 2 3 4 5 6 7 8 9 10 11 ...
6002 [file transfer complete]
6003 [connected]
6004 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00006005
wdenk2729af92004-05-03 20:45:30 +00006006 => go 40004 Hello World! This is a test.
6007 ## Starting application at 0x00040004 ...
6008 Hello World
6009 argc = 7
6010 argv[0] = "40004"
6011 argv[1] = "Hello"
6012 argv[2] = "World!"
6013 argv[3] = "This"
6014 argv[4] = "is"
6015 argv[5] = "a"
6016 argv[6] = "test."
6017 argv[7] = "<NULL>"
6018 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00006019
wdenk2729af92004-05-03 20:45:30 +00006020 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00006021
wdenk2729af92004-05-03 20:45:30 +00006022Another example, which demonstrates how to register a CPM interrupt
6023handler with the U-Boot code, can be found in 'examples/timer.c'.
6024Here, a CPM timer is set up to generate an interrupt every second.
6025The interrupt service routine is trivial, just printing a '.'
6026character, but this is just a demo program. The application can be
6027controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00006028
wdenk2729af92004-05-03 20:45:30 +00006029 ? - print current values og the CPM Timer registers
6030 b - enable interrupts and start timer
6031 e - stop timer and disable interrupts
6032 q - quit application
wdenkc6097192002-11-03 00:24:07 +00006033
wdenk2729af92004-05-03 20:45:30 +00006034 => loads
6035 ## Ready for S-Record download ...
6036 ~>examples/timer.srec
6037 1 2 3 4 5 6 7 8 9 10 11 ...
6038 [file transfer complete]
6039 [connected]
6040 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00006041
wdenk2729af92004-05-03 20:45:30 +00006042 => go 40004
6043 ## Starting application at 0x00040004 ...
6044 TIMERS=0xfff00980
6045 Using timer 1
6046 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00006047
wdenk2729af92004-05-03 20:45:30 +00006048Hit 'b':
6049 [q, b, e, ?] Set interval 1000000 us
6050 Enabling timer
6051Hit '?':
6052 [q, b, e, ?] ........
6053 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
6054Hit '?':
6055 [q, b, e, ?] .
6056 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
6057Hit '?':
6058 [q, b, e, ?] .
6059 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
6060Hit '?':
6061 [q, b, e, ?] .
6062 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
6063Hit 'e':
6064 [q, b, e, ?] ...Stopping timer
6065Hit 'q':
6066 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00006067
6068
wdenk2729af92004-05-03 20:45:30 +00006069Minicom warning:
6070================
wdenk85ec0bc2003-03-31 16:34:49 +00006071
wdenk2729af92004-05-03 20:45:30 +00006072Over time, many people have reported problems when trying to use the
6073"minicom" terminal emulation program for serial download. I (wd)
6074consider minicom to be broken, and recommend not to use it. Under
6075Unix, I recommend to use C-Kermit for general purpose use (and
6076especially for kermit binary protocol download ("loadb" command), and
Karl O. Pince53515a2012-10-01 05:11:56 +00006077use "cu" for S-Record download ("loads" command). See
6078http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
6079for help with kermit.
6080
wdenk85ec0bc2003-03-31 16:34:49 +00006081
wdenk2729af92004-05-03 20:45:30 +00006082Nevertheless, if you absolutely want to use it try adding this
6083configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00006084
wdenk2729af92004-05-03 20:45:30 +00006085 Name Program Name U/D FullScr IO-Red. Multi
6086 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
6087 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00006088
6089
wdenk2729af92004-05-03 20:45:30 +00006090NetBSD Notes:
6091=============
wdenkc6097192002-11-03 00:24:07 +00006092
wdenk2729af92004-05-03 20:45:30 +00006093Starting at version 0.9.2, U-Boot supports NetBSD both as host
6094(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00006095
wdenk2729af92004-05-03 20:45:30 +00006096Building requires a cross environment; it is known to work on
6097NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
6098need gmake since the Makefiles are not compatible with BSD make).
6099Note that the cross-powerpc package does not install include files;
6100attempting to build U-Boot will fail because <machine/ansi.h> is
6101missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00006102
wdenk2729af92004-05-03 20:45:30 +00006103 # cd /usr/pkg/cross/powerpc-netbsd/include
6104 # mkdir powerpc
6105 # ln -s powerpc machine
6106 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
6107 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00006108
wdenk2729af92004-05-03 20:45:30 +00006109Native builds *don't* work due to incompatibilities between native
6110and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00006111
wdenk2729af92004-05-03 20:45:30 +00006112Booting assumes that (the first part of) the image booted is a
6113stage-2 loader which in turn loads and then invokes the kernel
6114proper. Loader sources will eventually appear in the NetBSD source
6115tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00006116meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00006117
6118
wdenk2729af92004-05-03 20:45:30 +00006119Implementation Internals:
6120=========================
wdenkc6097192002-11-03 00:24:07 +00006121
wdenk2729af92004-05-03 20:45:30 +00006122The following is not intended to be a complete description of every
6123implementation detail. However, it should help to understand the
6124inner workings of U-Boot and make it easier to port it to custom
6125hardware.
wdenkc6097192002-11-03 00:24:07 +00006126
6127
wdenk2729af92004-05-03 20:45:30 +00006128Initial Stack, Global Data:
6129---------------------------
wdenkc6097192002-11-03 00:24:07 +00006130
wdenk2729af92004-05-03 20:45:30 +00006131The implementation of U-Boot is complicated by the fact that U-Boot
6132starts running out of ROM (flash memory), usually without access to
6133system RAM (because the memory controller is not initialized yet).
6134This means that we don't have writable Data or BSS segments, and BSS
6135is not initialized as zero. To be able to get a C environment working
6136at all, we have to allocate at least a minimal stack. Implementation
6137options for this are defined and restricted by the CPU used: Some CPU
6138models provide on-chip memory (like the IMMR area on MPC8xx and
6139MPC826x processors), on others (parts of) the data cache can be
6140locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00006141
Wolfgang Denk218ca722008-03-26 10:40:12 +01006142 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01006143 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00006144
wdenk2729af92004-05-03 20:45:30 +00006145 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
6146 From: "Chris Hallinan" <clh@net1plus.com>
6147 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
6148 ...
wdenk43d96162003-03-06 00:02:04 +00006149
wdenk2729af92004-05-03 20:45:30 +00006150 Correct me if I'm wrong, folks, but the way I understand it
6151 is this: Using DCACHE as initial RAM for Stack, etc, does not
6152 require any physical RAM backing up the cache. The cleverness
6153 is that the cache is being used as a temporary supply of
6154 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02006155 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00006156 can see how this works by studying the cache architecture and
6157 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00006158
wdenk2729af92004-05-03 20:45:30 +00006159 OCM is On Chip Memory, which I believe the 405GP has 4K. It
6160 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02006161 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00006162 option should work for you. Using CS 4 should be fine if your
6163 board designers haven't used it for something that would
6164 cause you grief during the initial boot! It is frequently not
6165 used.
wdenk43d96162003-03-06 00:02:04 +00006166
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02006167 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00006168 with your processor/board/system design. The default value
6169 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02006170 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00006171 than your SDRAM module. If you have a 64MB SDRAM module, set
6172 it above 400_0000. Just make sure your board has no resources
6173 that are supposed to respond to that address! That code in
6174 start.S has been around a while and should work as is when
6175 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00006176
wdenk2729af92004-05-03 20:45:30 +00006177 -Chris Hallinan
6178 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00006179
wdenk2729af92004-05-03 20:45:30 +00006180It is essential to remember this, since it has some impact on the C
6181code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00006182
wdenk2729af92004-05-03 20:45:30 +00006183* Initialized global data (data segment) is read-only. Do not attempt
6184 to write it.
wdenkc6097192002-11-03 00:24:07 +00006185
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02006186* Do not use any uninitialized global data (or implicitely initialized
wdenk2729af92004-05-03 20:45:30 +00006187 as zero data - BSS segment) at all - this is undefined, initiali-
6188 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00006189
wdenk2729af92004-05-03 20:45:30 +00006190* Stack space is very limited. Avoid big data buffers or things like
6191 that.
wdenkc6097192002-11-03 00:24:07 +00006192
wdenk2729af92004-05-03 20:45:30 +00006193Having only the stack as writable memory limits means we cannot use
6194normal global data to share information beween the code. But it
6195turned out that the implementation of U-Boot can be greatly
6196simplified by making a global data structure (gd_t) available to all
6197functions. We could pass a pointer to this data as argument to _all_
6198functions, but this would bloat the code. Instead we use a feature of
6199the GCC compiler (Global Register Variables) to share the data: we
6200place a pointer (gd) to the global data into a register which we
6201reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00006202
wdenk2729af92004-05-03 20:45:30 +00006203When choosing a register for such a purpose we are restricted by the
6204relevant (E)ABI specifications for the current architecture, and by
6205GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00006206
wdenk2729af92004-05-03 20:45:30 +00006207For PowerPC, the following registers have specific use:
6208 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01006209 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00006210 R3-R4: parameter passing and return values
6211 R5-R10: parameter passing
6212 R13: small data area pointer
6213 R30: GOT pointer
6214 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00006215
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01006216 (U-Boot also uses R12 as internal GOT pointer. r12
6217 is a volatile register so r12 needs to be reset when
6218 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00006219
Wolfgang Denke7670f62008-02-14 22:43:22 +01006220 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00006221
wdenk2729af92004-05-03 20:45:30 +00006222 Note: on PPC, we could use a static initializer (since the
6223 address of the global data structure is known at compile time),
6224 but it turned out that reserving a register results in somewhat
6225 smaller code - although the code savings are not that big (on
6226 average for all boards 752 bytes for the whole U-Boot image,
6227 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00006228
Robin Getzc4db3352009-08-17 15:23:02 +00006229On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger4c58eb52008-02-04 19:26:54 -05006230 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
6231
Robin Getzc4db3352009-08-17 15:23:02 +00006232 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger4c58eb52008-02-04 19:26:54 -05006233
wdenk2729af92004-05-03 20:45:30 +00006234On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00006235
wdenk2729af92004-05-03 20:45:30 +00006236 R0: function argument word/integer result
6237 R1-R3: function argument word
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02006238 R9: platform specific
6239 R10: stack limit (used only if stack checking is enabled)
wdenk2729af92004-05-03 20:45:30 +00006240 R11: argument (frame) pointer
6241 R12: temporary workspace
6242 R13: stack pointer
6243 R14: link register
6244 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00006245
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02006246 ==> U-Boot will use R9 to hold a pointer to the global data
6247
6248 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00006249
Thomas Chou0df01fd2010-05-21 11:08:03 +08006250On Nios II, the ABI is documented here:
6251 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
6252
6253 ==> U-Boot will use gp to hold a pointer to the global data
6254
6255 Note: on Nios II, we give "-G0" option to gcc and don't use gp
6256 to access small data sections, so gp is free.
6257
Macpaul Linafc1ce82011-10-19 20:41:11 +00006258On NDS32, the following registers are used:
6259
6260 R0-R1: argument/return
6261 R2-R5: argument
6262 R15: temporary register for assembler
6263 R16: trampoline register
6264 R28: frame pointer (FP)
6265 R29: global pointer (GP)
6266 R30: link register (LP)
6267 R31: stack pointer (SP)
6268 PC: program counter (PC)
6269
6270 ==> U-Boot will use R10 to hold a pointer to the global data
6271
Wolfgang Denkd87080b2006-03-31 18:32:53 +02006272NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
6273or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00006274
wdenk2729af92004-05-03 20:45:30 +00006275Memory Management:
6276------------------
wdenkc6097192002-11-03 00:24:07 +00006277
wdenk2729af92004-05-03 20:45:30 +00006278U-Boot runs in system state and uses physical addresses, i.e. the
6279MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00006280
wdenk2729af92004-05-03 20:45:30 +00006281The available memory is mapped to fixed addresses using the memory
6282controller. In this process, a contiguous block is formed for each
6283memory type (Flash, SDRAM, SRAM), even when it consists of several
6284physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00006285
wdenk2729af92004-05-03 20:45:30 +00006286U-Boot is installed in the first 128 kB of the first Flash bank (on
6287TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
6288booting and sizing and initializing DRAM, the code relocates itself
6289to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02006290memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00006291configuration setting]. Below that, a structure with global Board
6292Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00006293
wdenk2729af92004-05-03 20:45:30 +00006294Additionally, some exception handler code is copied to the low 8 kB
6295of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00006296
wdenk2729af92004-05-03 20:45:30 +00006297So a typical memory configuration with 16 MB of DRAM could look like
6298this:
wdenkc6097192002-11-03 00:24:07 +00006299
wdenk2729af92004-05-03 20:45:30 +00006300 0x0000 0000 Exception Vector code
6301 :
6302 0x0000 1FFF
6303 0x0000 2000 Free for Application Use
6304 :
6305 :
wdenkc6097192002-11-03 00:24:07 +00006306
wdenk2729af92004-05-03 20:45:30 +00006307 :
6308 :
6309 0x00FB FF20 Monitor Stack (Growing downward)
6310 0x00FB FFAC Board Info Data and permanent copy of global data
6311 0x00FC 0000 Malloc Arena
6312 :
6313 0x00FD FFFF
6314 0x00FE 0000 RAM Copy of Monitor Code
6315 ... eventually: LCD or video framebuffer
6316 ... eventually: pRAM (Protected RAM - unchanged by reset)
6317 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00006318
6319
wdenk2729af92004-05-03 20:45:30 +00006320System Initialization:
6321----------------------
wdenkc6097192002-11-03 00:24:07 +00006322
wdenk2729af92004-05-03 20:45:30 +00006323In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02006324(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk2729af92004-05-03 20:45:30 +00006325configuration for CS0# this is a mirror of the onboard Flash memory.
6326To be able to re-map memory U-Boot then jumps to its link address.
6327To be able to implement the initialization code in C, a (small!)
6328initial stack is set up in the internal Dual Ported RAM (in case CPUs
6329which provide such a feature like MPC8xx or MPC8260), or in a locked
6330part of the data cache. After that, U-Boot initializes the CPU core,
6331the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00006332
wdenk2729af92004-05-03 20:45:30 +00006333Next, all (potentially) available memory banks are mapped using a
6334preliminary mapping. For example, we put them on 512 MB boundaries
6335(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
6336on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
6337programmed for SDRAM access. Using the temporary configuration, a
6338simple memory test is run that determines the size of the SDRAM
6339banks.
wdenkc6097192002-11-03 00:24:07 +00006340
wdenk2729af92004-05-03 20:45:30 +00006341When there is more than one SDRAM bank, and the banks are of
6342different size, the largest is mapped first. For equal size, the first
6343bank (CS2#) is mapped first. The first mapping is always for address
63440x00000000, with any additional banks following immediately to create
6345contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00006346
wdenk2729af92004-05-03 20:45:30 +00006347Then, the monitor installs itself at the upper end of the SDRAM area
6348and allocates memory for use by malloc() and for the global Board
6349Info data; also, the exception vector code is copied to the low RAM
6350pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00006351
wdenk2729af92004-05-03 20:45:30 +00006352Only after this relocation will you have a "normal" C environment;
6353until that you are restricted in several ways, mostly because you are
6354running from ROM, and because the code will have to be relocated to a
6355new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00006356
6357
wdenk2729af92004-05-03 20:45:30 +00006358U-Boot Porting Guide:
6359----------------------
wdenkc6097192002-11-03 00:24:07 +00006360
wdenk2729af92004-05-03 20:45:30 +00006361[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
6362list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00006363
6364
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006365int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00006366{
6367 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00006368
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006369 signal(SIGALRM, no_more_time);
6370 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00006371
wdenk2729af92004-05-03 20:45:30 +00006372 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006373 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00006374 return 0;
6375 }
6376
wdenk2729af92004-05-03 20:45:30 +00006377 Download latest U-Boot source;
6378
Wolfgang Denk06682362008-12-30 22:56:11 +01006379 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00006380
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006381 if (clueless)
6382 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00006383
wdenk2729af92004-05-03 20:45:30 +00006384 while (learning) {
6385 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006386 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
6387 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00006388 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006389 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00006390 }
wdenkc6097192002-11-03 00:24:07 +00006391
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006392 if (available_money > toLocalCurrency ($2500))
6393 Buy a BDI3000;
6394 else
wdenk2729af92004-05-03 20:45:30 +00006395 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006396
6397 if (a similar board exists) { /* hopefully... */
6398 cp -a board/<similar> board/<myboard>
6399 cp include/configs/<similar>.h include/configs/<myboard>.h
6400 } else {
6401 Create your own board support subdirectory;
6402 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00006403 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006404 Edit new board/<myboard> files
6405 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00006406
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006407 while (!accepted) {
6408 while (!running) {
6409 do {
6410 Add / modify source code;
6411 } until (compiles);
6412 Debug;
6413 if (clueless)
6414 email("Hi, I am having problems...");
6415 }
6416 Send patch file to the U-Boot email list;
6417 if (reasonable critiques)
6418 Incorporate improvements from email list code review;
6419 else
6420 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00006421 }
wdenkc6097192002-11-03 00:24:07 +00006422
wdenk2729af92004-05-03 20:45:30 +00006423 return 0;
6424}
6425
6426void no_more_time (int sig)
6427{
6428 hire_a_guru();
6429}
wdenkc6097192002-11-03 00:24:07 +00006430
6431
wdenk2729af92004-05-03 20:45:30 +00006432Coding Standards:
6433-----------------
wdenkc6097192002-11-03 00:24:07 +00006434
wdenk2729af92004-05-03 20:45:30 +00006435All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02006436coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006437"scripts/Lindent" in your Linux kernel source directory.
wdenk2729af92004-05-03 20:45:30 +00006438
Detlev Zundel2c051652006-09-01 15:39:02 +02006439Source files originating from a different project (for example the
6440MTD subsystem) are generally exempt from these guidelines and are not
6441reformated to ease subsequent migration to newer versions of those
6442sources.
6443
6444Please note that U-Boot is implemented in C (and to some small parts in
6445Assembler); no C++ is used, so please do not use C++ style comments (//)
6446in your code.
wdenk2729af92004-05-03 20:45:30 +00006447
6448Please also stick to the following formatting rules:
6449- remove any trailing white space
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006450- use TAB characters for indentation and vertical alignment, not spaces
wdenk2729af92004-05-03 20:45:30 +00006451- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006452- do not add more than 2 consecutive empty lines to source files
wdenk2729af92004-05-03 20:45:30 +00006453- do not add trailing empty lines to source files
6454
6455Submissions which do not conform to the standards may be returned
6456with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00006457
6458
wdenk2729af92004-05-03 20:45:30 +00006459Submitting Patches:
6460-------------------
wdenkc6097192002-11-03 00:24:07 +00006461
wdenk2729af92004-05-03 20:45:30 +00006462Since the number of patches for U-Boot is growing, we need to
6463establish some rules. Submissions which do not conform to these rules
6464may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00006465
Magnus Lilja0d28f342008-08-06 19:32:33 +02006466Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01006467
Wolfgang Denk06682362008-12-30 22:56:11 +01006468Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
6469see http://lists.denx.de/mailman/listinfo/u-boot
6470
wdenk2729af92004-05-03 20:45:30 +00006471When you send a patch, please include the following information with
6472it:
wdenkc6097192002-11-03 00:24:07 +00006473
wdenk2729af92004-05-03 20:45:30 +00006474* For bug fixes: a description of the bug and how your patch fixes
6475 this bug. Please try to include a way of demonstrating that the
6476 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00006477
wdenk2729af92004-05-03 20:45:30 +00006478* For new features: a description of the feature and your
6479 implementation.
wdenkc6097192002-11-03 00:24:07 +00006480
wdenk2729af92004-05-03 20:45:30 +00006481* A CHANGELOG entry as plaintext (separate from the patch)
6482
6483* For major contributions, your entry to the CREDITS file
6484
Albert ARIBAUD27af9302013-09-11 15:52:51 +02006485* When you add support for a new board, don't forget to add a
6486 maintainer e-mail address to the boards.cfg file, too.
wdenk2729af92004-05-03 20:45:30 +00006487
6488* If your patch adds new configuration options, don't forget to
6489 document these in the README file.
6490
Wolfgang Denk218ca722008-03-26 10:40:12 +01006491* The patch itself. If you are using git (which is *strongly*
6492 recommended) you can easily generate the patch using the
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006493 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denk218ca722008-03-26 10:40:12 +01006494 the U-Boot mailing list, you will avoid most of the common problems
6495 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00006496
Wolfgang Denk218ca722008-03-26 10:40:12 +01006497 If you cannot use git, use "diff -purN OLD NEW". If your version of
6498 diff does not support these options, then get the latest version of
6499 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00006500
Wolfgang Denk218ca722008-03-26 10:40:12 +01006501 The current directory when running this command shall be the parent
6502 directory of the U-Boot source tree (i. e. please make sure that
6503 your patch includes sufficient directory information for the
6504 affected files).
6505
6506 We prefer patches as plain text. MIME attachments are discouraged,
6507 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00006508
6509* If one logical set of modifications affects or creates several
6510 files, all these changes shall be submitted in a SINGLE patch file.
6511
6512* Changesets that contain different, unrelated modifications shall be
6513 submitted as SEPARATE patches, one patch per changeset.
6514
6515
6516Notes:
6517
6518* Before sending the patch, run the MAKEALL script on your patched
6519 source tree and make sure that no errors or warnings are reported
6520 for any of the boards.
6521
6522* Keep your modifications to the necessary minimum: A patch
6523 containing several unrelated changes or arbitrary reformats will be
6524 returned with a request to re-formatting / split it.
6525
6526* If you modify existing code, make sure that your new code does not
6527 add to the memory footprint of the code ;-) Small is beautiful!
6528 When adding new features, these should compile conditionally only
6529 (using #ifdef), and the resulting code with the new feature
6530 disabled must not need more memory than the old code without your
6531 modification.
wdenk90dc6702005-05-03 14:12:25 +00006532
Wolfgang Denk06682362008-12-30 22:56:11 +01006533* Remember that there is a size limit of 100 kB per message on the
6534 u-boot mailing list. Bigger patches will be moderated. If they are
6535 reasonable and not too big, they will be acknowledged. But patches
6536 bigger than the size limit should be avoided.