blob: 4819696deb64d0b34b1b3fac1337b456662733f7 [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
Robert P. J. Day7207b362015-12-19 07:16:10 -050037In case of problems see the CHANGELOG file to find out who contributed
38the specific port. In addition, there are various MAINTAINERS files
39scattered throughout the U-Boot source identifying the people or
40companies responsible for various boards and subsystems.
wdenkc6097192002-11-03 00:24:07 +000041
Robert P. J. Day7207b362015-12-19 07:16:10 -050042Note: As of August, 2010, there is no longer a CHANGELOG file in the
43actual U-Boot source tree; however, it can be created dynamically
44from the Git log using:
Robert P. J. Dayadb9d852012-11-14 02:03:20 +000045
46 make CHANGELOG
47
wdenkc6097192002-11-03 00:24:07 +000048
49Where to get help:
50==================
51
wdenk24ee89b2002-11-03 17:56:27 +000052In case you have questions about, problems with or contributions for
Robert P. J. Day7207b362015-12-19 07:16:10 -050053U-Boot, you should send a message to the U-Boot mailing list at
Peter Tyser0c325652008-09-10 09:18:34 -050054<u-boot@lists.denx.de>. There is also an archive of previous traffic
55on the mailing list - please search the archive before asking FAQ's.
56Please see http://lists.denx.de/pipermail/u-boot and
57http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
wdenkc6097192002-11-03 00:24:07 +000058
59
Wolfgang Denk218ca722008-03-26 10:40:12 +010060Where to get source code:
61=========================
62
Robert P. J. Day7207b362015-12-19 07:16:10 -050063The U-Boot source code is maintained in the Git repository at
Wolfgang Denk218ca722008-03-26 10:40:12 +010064git://www.denx.de/git/u-boot.git ; you can browse it online at
65http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
66
67The "snapshot" links on this page allow you to download tarballs of
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020068any version you might be interested in. Official releases are also
Wolfgang Denk218ca722008-03-26 10:40:12 +010069available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
70directory.
71
Anatolij Gustschind4ee7112008-03-26 18:13:33 +010072Pre-built (and tested) images are available from
Wolfgang Denk218ca722008-03-26 10:40:12 +010073ftp://ftp.denx.de/pub/u-boot/images/
74
75
wdenkc6097192002-11-03 00:24:07 +000076Where we come from:
77===================
78
79- start from 8xxrom sources
wdenk24ee89b2002-11-03 17:56:27 +000080- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenkc6097192002-11-03 00:24:07 +000081- clean up code
82- make it easier to add custom boards
83- make it possible to add other [PowerPC] CPUs
84- extend functions, especially:
85 * Provide extended interface to Linux boot loader
86 * S-Record download
87 * network boot
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020088 * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
wdenk24ee89b2002-11-03 17:56:27 +000089- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenkc6097192002-11-03 00:24:07 +000090- add other CPU families (starting with ARM)
wdenk24ee89b2002-11-03 17:56:27 +000091- create U-Boot project (http://sourceforge.net/projects/u-boot)
Magnus Lilja0d28f342008-08-06 19:32:33 +020092- current project page: see http://www.denx.de/wiki/U-Boot
wdenk24ee89b2002-11-03 17:56:27 +000093
94
95Names and Spelling:
96===================
97
98The "official" name of this project is "Das U-Boot". The spelling
99"U-Boot" shall be used in all written text (documentation, comments
100in source files etc.). Example:
101
102 This is the README file for the U-Boot project.
103
104File names etc. shall be based on the string "u-boot". Examples:
105
106 include/asm-ppc/u-boot.h
107
108 #include <asm/u-boot.h>
109
110Variable names, preprocessor constants etc. shall be either based on
111the string "u_boot" or on "U_BOOT". Example:
112
113 U_BOOT_VERSION u_boot_logo
114 IH_OS_U_BOOT u_boot_hush_start
wdenkc6097192002-11-03 00:24:07 +0000115
116
wdenk93f19cc2002-12-17 17:55:09 +0000117Versioning:
118===========
119
Thomas Weber360d8832010-09-28 08:06:25 +0200120Starting with the release in October 2008, the names of the releases
121were changed from numerical release numbers without deeper meaning
122into a time stamp based numbering. Regular releases are identified by
123names consisting of the calendar year and month of the release date.
124Additional fields (if present) indicate release candidates or bug fix
125releases in "stable" maintenance trees.
wdenk93f19cc2002-12-17 17:55:09 +0000126
Thomas Weber360d8832010-09-28 08:06:25 +0200127Examples:
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000128 U-Boot v2009.11 - Release November 2009
Thomas Weber360d8832010-09-28 08:06:25 +0200129 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
Jelle van der Waa0de21ec2016-10-30 17:30:30 +0100130 U-Boot v2010.09-rc1 - Release candidate 1 for September 2010 release
wdenk93f19cc2002-12-17 17:55:09 +0000131
132
wdenkc6097192002-11-03 00:24:07 +0000133Directory Hierarchy:
134====================
135
Peter Tyser8d321b82010-04-12 22:28:21 -0500136/arch Architecture specific files
Masahiro Yamada6eae68e2014-03-07 18:02:02 +0900137 /arc Files generic to ARC architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500138 /arm Files generic to ARM architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500139 /avr32 Files generic to AVR32 architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500140 /m68k Files generic to m68k architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500141 /microblaze Files generic to microblaze architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500142 /mips Files generic to MIPS architecture
Macpaul Linafc1ce82011-10-19 20:41:11 +0000143 /nds32 Files generic to NDS32 architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500144 /nios2 Files generic to Altera NIOS2 architecture
Robert P. J. Day33c77312013-09-15 18:34:15 -0400145 /openrisc Files generic to OpenRISC architecture
Stefan Roesea47a12b2010-04-15 16:07:28 +0200146 /powerpc Files generic to PowerPC architecture
Robert P. J. Day7207b362015-12-19 07:16:10 -0500147 /sandbox Files generic to HW-independent "sandbox"
Peter Tyser8d321b82010-04-12 22:28:21 -0500148 /sh Files generic to SH architecture
Robert P. J. Day33c77312013-09-15 18:34:15 -0400149 /x86 Files generic to x86 architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500150/api Machine/arch independent API for external apps
151/board Board dependent files
Xu Ziyuan740f7e52016-08-26 19:54:49 +0800152/cmd U-Boot commands functions
Peter Tyser8d321b82010-04-12 22:28:21 -0500153/common Misc architecture independent functions
Robert P. J. Day7207b362015-12-19 07:16:10 -0500154/configs Board default configuration files
Peter Tyser8d321b82010-04-12 22:28:21 -0500155/disk Code for disk drive partition handling
156/doc Documentation (don't expect too much)
157/drivers Commonly used device drivers
Robert P. J. Day33c77312013-09-15 18:34:15 -0400158/dts Contains Makefile for building internal U-Boot fdt.
Peter Tyser8d321b82010-04-12 22:28:21 -0500159/examples Example code for standalone applications, etc.
160/fs Filesystem code (cramfs, ext2, jffs2, etc.)
161/include Header Files
Robert P. J. Day7207b362015-12-19 07:16:10 -0500162/lib Library routines generic to all architectures
163/Licenses Various license files
Peter Tyser8d321b82010-04-12 22:28:21 -0500164/net Networking code
165/post Power On Self Test
Robert P. J. Day7207b362015-12-19 07:16:10 -0500166/scripts Various build scripts and Makefiles
167/test Various unit test files
Peter Tyser8d321b82010-04-12 22:28:21 -0500168/tools Tools to build S-Record or U-Boot images, etc.
wdenkc6097192002-11-03 00:24:07 +0000169
wdenkc6097192002-11-03 00:24:07 +0000170Software Configuration:
171=======================
172
173Configuration is usually done using C preprocessor defines; the
174rationale behind that is to avoid dead code whenever possible.
175
176There are two classes of configuration variables:
177
178* Configuration _OPTIONS_:
179 These are selectable by the user and have names beginning with
180 "CONFIG_".
181
182* Configuration _SETTINGS_:
183 These depend on the hardware etc. and should not be meddled with if
184 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200185 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000186
Robert P. J. Day7207b362015-12-19 07:16:10 -0500187Previously, all configuration was done by hand, which involved creating
188symbolic links and editing configuration files manually. More recently,
189U-Boot has added the Kbuild infrastructure used by the Linux kernel,
190allowing you to use the "make menuconfig" command to configure your
191build.
wdenkc6097192002-11-03 00:24:07 +0000192
193
194Selection of Processor Architecture and Board Type:
195---------------------------------------------------
196
197For all supported boards there are ready-to-use default
Holger Freytherab584d62014-08-04 09:26:05 +0200198configurations available; just type "make <board_name>_defconfig".
wdenkc6097192002-11-03 00:24:07 +0000199
200Example: For a TQM823L module type:
201
202 cd u-boot
Holger Freytherab584d62014-08-04 09:26:05 +0200203 make TQM823L_defconfig
wdenkc6097192002-11-03 00:24:07 +0000204
Robert P. J. Day7207b362015-12-19 07:16:10 -0500205Note: If you're looking for the default configuration file for a board
206you're sure used to be there but is now missing, check the file
207doc/README.scrapyard for a list of no longer supported boards.
wdenkc6097192002-11-03 00:24:07 +0000208
Simon Glass75b3c3a2014-03-22 17:12:59 -0600209Sandbox Environment:
210--------------------
211
212U-Boot can be built natively to run on a Linux host using the 'sandbox'
213board. This allows feature development which is not board- or architecture-
214specific to be undertaken on a native platform. The sandbox is also used to
215run some of U-Boot's tests.
216
Jagannadha Sutradharudu Teki6b1978f2014-08-31 21:19:43 +0530217See board/sandbox/README.sandbox for more details.
Simon Glass75b3c3a2014-03-22 17:12:59 -0600218
219
Simon Glassdb910352015-03-03 08:03:00 -0700220Board Initialisation Flow:
221--------------------------
222
223This is the intended start-up flow for boards. This should apply for both
Robert P. J. Day7207b362015-12-19 07:16:10 -0500224SPL and U-Boot proper (i.e. they both follow the same rules).
Simon Glassdb910352015-03-03 08:03:00 -0700225
Robert P. J. Day7207b362015-12-19 07:16:10 -0500226Note: "SPL" stands for "Secondary Program Loader," which is explained in
227more detail later in this file.
228
229At present, SPL mostly uses a separate code path, but the function names
230and roles of each function are the same. Some boards or architectures
231may not conform to this. At least most ARM boards which use
232CONFIG_SPL_FRAMEWORK conform to this.
233
234Execution typically starts with an architecture-specific (and possibly
235CPU-specific) start.S file, such as:
236
237 - arch/arm/cpu/armv7/start.S
238 - arch/powerpc/cpu/mpc83xx/start.S
239 - arch/mips/cpu/start.S
240
241and so on. From there, three functions are called; the purpose and
242limitations of each of these functions are described below.
Simon Glassdb910352015-03-03 08:03:00 -0700243
244lowlevel_init():
245 - purpose: essential init to permit execution to reach board_init_f()
246 - no global_data or BSS
247 - there is no stack (ARMv7 may have one but it will soon be removed)
248 - must not set up SDRAM or use console
249 - must only do the bare minimum to allow execution to continue to
250 board_init_f()
251 - this is almost never needed
252 - return normally from this function
253
254board_init_f():
255 - purpose: set up the machine ready for running board_init_r():
256 i.e. SDRAM and serial UART
257 - global_data is available
258 - stack is in SRAM
259 - BSS is not available, so you cannot use global/static variables,
260 only stack variables and global_data
261
262 Non-SPL-specific notes:
263 - dram_init() is called to set up DRAM. If already done in SPL this
264 can do nothing
265
266 SPL-specific notes:
267 - you can override the entire board_init_f() function with your own
268 version as needed.
269 - preloader_console_init() can be called here in extremis
270 - should set up SDRAM, and anything needed to make the UART work
271 - these is no need to clear BSS, it will be done by crt0.S
272 - must return normally from this function (don't call board_init_r()
273 directly)
274
275Here the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at
276this point the stack and global_data are relocated to below
277CONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of
278memory.
279
280board_init_r():
281 - purpose: main execution, common code
282 - global_data is available
283 - SDRAM is available
284 - BSS is available, all static/global variables can be used
285 - execution eventually continues to main_loop()
286
287 Non-SPL-specific notes:
288 - U-Boot is relocated to the top of memory and is now running from
289 there.
290
291 SPL-specific notes:
292 - stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and
293 CONFIG_SPL_STACK_R_ADDR points into SDRAM
294 - preloader_console_init() can be called here - typically this is
Ley Foon Tan0680f1b2017-05-03 17:13:32 +0800295 done by selecting CONFIG_SPL_BOARD_INIT and then supplying a
Simon Glassdb910352015-03-03 08:03:00 -0700296 spl_board_init() function containing this call
297 - loads U-Boot or (in falcon mode) Linux
298
299
300
wdenkc6097192002-11-03 00:24:07 +0000301Configuration Options:
302----------------------
303
304Configuration depends on the combination of board and CPU type; all
305such information is kept in a configuration file
306"include/configs/<board_name>.h".
307
308Example: For a TQM823L module, all configuration settings are in
309"include/configs/TQM823L.h".
310
311
wdenk7f6c2cb2002-11-10 22:06:23 +0000312Many of the options are named exactly as the corresponding Linux
313kernel configuration options. The intention is to make it easier to
314build a config tool - later.
315
316
wdenkc6097192002-11-03 00:24:07 +0000317The following options need to be configured:
318
Kim Phillips26281142007-08-10 13:28:25 -0500319- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000320
Kim Phillips26281142007-08-10 13:28:25 -0500321- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk6ccec442006-10-24 14:42:37 +0200322
323- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen09ea0de2007-11-01 12:44:20 +0100324 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000325
Lei Wencf946c62011-02-09 18:06:58 +0530326- Marvell Family Member
327 CONFIG_SYS_MVFS - define it if you want to enable
328 multiple fs option at one time
329 for marvell soc family
330
Kumar Gala66412c62011-02-18 05:40:54 -0600331- 85xx CPU Options:
York Sunffd06e02012-10-08 07:44:30 +0000332 CONFIG_SYS_PPC64
333
334 Specifies that the core is a 64-bit PowerPC implementation (implements
335 the "64" category of the Power ISA). This is necessary for ePAPR
336 compliance, among other possible reasons.
337
Kumar Gala66412c62011-02-18 05:40:54 -0600338 CONFIG_SYS_FSL_TBCLK_DIV
339
340 Defines the core time base clock divider ratio compared to the
341 system clock. On most PQ3 devices this is 8, on newer QorIQ
342 devices it can be 16 or 32. The ratio varies from SoC to Soc.
343
Kumar Gala8f290842011-05-20 00:39:21 -0500344 CONFIG_SYS_FSL_PCIE_COMPAT
345
346 Defines the string to utilize when trying to match PCIe device
347 tree nodes for the given platform.
348
Scott Wood33eee332012-08-14 10:14:53 +0000349 CONFIG_SYS_FSL_ERRATUM_A004510
350
351 Enables a workaround for erratum A004510. If set,
352 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
353 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
354
355 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
356 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
357
358 Defines one or two SoC revisions (low 8 bits of SVR)
359 for which the A004510 workaround should be applied.
360
361 The rest of SVR is either not relevant to the decision
362 of whether the erratum is present (e.g. p2040 versus
363 p2041) or is implied by the build target, which controls
364 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
365
366 See Freescale App Note 4493 for more information about
367 this erratum.
368
Prabhakar Kushwaha74fa22e2013-04-16 13:27:44 +0530369 CONFIG_A003399_NOR_WORKAROUND
370 Enables a workaround for IFC erratum A003399. It is only
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800371 required during NOR boot.
Prabhakar Kushwaha74fa22e2013-04-16 13:27:44 +0530372
Prabhakar Kushwaha9f074e62014-10-29 22:33:09 +0530373 CONFIG_A008044_WORKAROUND
374 Enables a workaround for T1040/T1042 erratum A008044. It is only
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800375 required during NAND boot and valid for Rev 1.0 SoC revision
Prabhakar Kushwaha9f074e62014-10-29 22:33:09 +0530376
Scott Wood33eee332012-08-14 10:14:53 +0000377 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
378
379 This is the value to write into CCSR offset 0x18600
380 according to the A004510 workaround.
381
Priyanka Jain64501c62013-07-02 09:21:04 +0530382 CONFIG_SYS_FSL_DSP_DDR_ADDR
383 This value denotes start offset of DDR memory which is
384 connected exclusively to the DSP cores.
385
Priyanka Jain765b0bd2013-04-04 09:31:54 +0530386 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
387 This value denotes start offset of M2 memory
388 which is directly connected to the DSP core.
389
Priyanka Jain64501c62013-07-02 09:21:04 +0530390 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
391 This value denotes start offset of M3 memory which is directly
392 connected to the DSP core.
393
Priyanka Jain765b0bd2013-04-04 09:31:54 +0530394 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
395 This value denotes start offset of DSP CCSR space.
396
Priyanka Jainb1359912013-12-17 14:25:52 +0530397 CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
398 Single Source Clock is clocking mode present in some of FSL SoC's.
399 In this mode, a single differential clock is used to supply
400 clocks to the sysclock, ddrclock and usbclock.
401
Aneesh Bansalfb4a2402014-03-18 23:40:26 +0530402 CONFIG_SYS_CPC_REINIT_F
403 This CONFIG is defined when the CPC is configured as SRAM at the
Bin Menga1875592016-02-05 19:30:11 -0800404 time of U-Boot entry and is required to be re-initialized.
Aneesh Bansalfb4a2402014-03-18 23:40:26 +0530405
Tang Yuantianaade2002014-04-17 15:33:46 +0800406 CONFIG_DEEP_SLEEP
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800407 Indicates this SoC supports deep sleep feature. If deep sleep is
Tang Yuantianaade2002014-04-17 15:33:46 +0800408 supported, core will start to execute uboot when wakes up.
409
Daniel Schwierzeck6cb461b2012-04-02 02:57:56 +0000410- Generic CPU options:
York Sun2a1680e2014-05-02 17:28:04 -0700411 CONFIG_SYS_GENERIC_GLOBAL_DATA
412 Defines global data is initialized in generic board board_init_f().
413 If this macro is defined, global data is created and cleared in
414 generic board board_init_f(). Without this macro, architecture/board
415 should initialize global data before calling board_init_f().
416
Daniel Schwierzeck6cb461b2012-04-02 02:57:56 +0000417 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
418
419 Defines the endianess of the CPU. Implementation of those
420 values is arch specific.
421
York Sun5614e712013-09-30 09:22:09 -0700422 CONFIG_SYS_FSL_DDR
423 Freescale DDR driver in use. This type of DDR controller is
424 found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
425 SoCs.
426
427 CONFIG_SYS_FSL_DDR_ADDR
428 Freescale DDR memory-mapped register base.
429
430 CONFIG_SYS_FSL_DDR_EMU
431 Specify emulator support for DDR. Some DDR features such as
432 deskew training are not available.
433
434 CONFIG_SYS_FSL_DDRC_GEN1
435 Freescale DDR1 controller.
436
437 CONFIG_SYS_FSL_DDRC_GEN2
438 Freescale DDR2 controller.
439
440 CONFIG_SYS_FSL_DDRC_GEN3
441 Freescale DDR3 controller.
442
York Sun34e026f2014-03-27 17:54:47 -0700443 CONFIG_SYS_FSL_DDRC_GEN4
444 Freescale DDR4 controller.
445
York Sun9ac4ffb2013-09-30 14:20:51 -0700446 CONFIG_SYS_FSL_DDRC_ARM_GEN3
447 Freescale DDR3 controller for ARM-based SoCs.
448
York Sun5614e712013-09-30 09:22:09 -0700449 CONFIG_SYS_FSL_DDR1
450 Board config to use DDR1. It can be enabled for SoCs with
451 Freescale DDR1 or DDR2 controllers, depending on the board
452 implemetation.
453
454 CONFIG_SYS_FSL_DDR2
Robert P. J. Day62a3b7d2016-07-15 13:44:45 -0400455 Board config to use DDR2. It can be enabled for SoCs with
York Sun5614e712013-09-30 09:22:09 -0700456 Freescale DDR2 or DDR3 controllers, depending on the board
457 implementation.
458
459 CONFIG_SYS_FSL_DDR3
460 Board config to use DDR3. It can be enabled for SoCs with
York Sun34e026f2014-03-27 17:54:47 -0700461 Freescale DDR3 or DDR3L controllers.
462
463 CONFIG_SYS_FSL_DDR3L
464 Board config to use DDR3L. It can be enabled for SoCs with
465 DDR3L controllers.
466
467 CONFIG_SYS_FSL_DDR4
468 Board config to use DDR4. It can be enabled for SoCs with
469 DDR4 controllers.
York Sun5614e712013-09-30 09:22:09 -0700470
Prabhakar Kushwaha1b4175d2014-01-18 12:28:30 +0530471 CONFIG_SYS_FSL_IFC_BE
472 Defines the IFC controller register space as Big Endian
473
474 CONFIG_SYS_FSL_IFC_LE
475 Defines the IFC controller register space as Little Endian
476
Prabhakar Kushwaha1c407072017-02-02 15:01:26 +0530477 CONFIG_SYS_FSL_IFC_CLK_DIV
478 Defines divider of platform clock(clock input to IFC controller).
479
Prabhakar Kushwahaadd63f92017-02-02 15:02:00 +0530480 CONFIG_SYS_FSL_LBC_CLK_DIV
481 Defines divider of platform clock(clock input to eLBC controller).
482
Prabhakar Kushwaha690e4252014-01-13 11:28:04 +0530483 CONFIG_SYS_FSL_PBL_PBI
484 It enables addition of RCW (Power on reset configuration) in built image.
485 Please refer doc/README.pblimage for more details
486
487 CONFIG_SYS_FSL_PBL_RCW
488 It adds PBI(pre-boot instructions) commands in u-boot build image.
489 PBI commands can be used to configure SoC before it starts the execution.
490 Please refer doc/README.pblimage for more details
491
Prabhakar Kushwaha89ad7be2014-04-08 19:13:34 +0530492 CONFIG_SPL_FSL_PBL
493 It adds a target to create boot binary having SPL binary in PBI format
494 concatenated with u-boot binary.
495
York Sun4e5b1bd2014-02-10 13:59:42 -0800496 CONFIG_SYS_FSL_DDR_BE
497 Defines the DDR controller register space as Big Endian
498
499 CONFIG_SYS_FSL_DDR_LE
500 Defines the DDR controller register space as Little Endian
501
York Sun6b9e3092014-02-10 13:59:43 -0800502 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
503 Physical address from the view of DDR controllers. It is the
504 same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But
505 it could be different for ARM SoCs.
506
York Sun6b1e1252014-02-10 13:59:44 -0800507 CONFIG_SYS_FSL_DDR_INTLV_256B
508 DDR controller interleaving on 256-byte. This is a special
509 interleaving mode, handled by Dickens for Freescale layerscape
510 SoCs with ARM core.
511
York Sun1d71efb2014-08-01 15:51:00 -0700512 CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
513 Number of controllers used as main memory.
514
515 CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
516 Number of controllers used for other than main memory.
517
Prabhakar Kushwaha44937212015-11-09 16:42:07 +0530518 CONFIG_SYS_FSL_HAS_DP_DDR
519 Defines the SoC has DP-DDR used for DPAA.
520
Ruchika Gupta028dbb82014-09-09 11:50:31 +0530521 CONFIG_SYS_FSL_SEC_BE
522 Defines the SEC controller register space as Big Endian
523
524 CONFIG_SYS_FSL_SEC_LE
525 Defines the SEC controller register space as Little Endian
526
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200527- MIPS CPU options:
528 CONFIG_SYS_INIT_SP_OFFSET
529
530 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
531 pointer. This is needed for the temporary stack before
532 relocation.
533
534 CONFIG_SYS_MIPS_CACHE_MODE
535
536 Cache operation mode for the MIPS CPU.
537 See also arch/mips/include/asm/mipsregs.h.
538 Possible values are:
539 CONF_CM_CACHABLE_NO_WA
540 CONF_CM_CACHABLE_WA
541 CONF_CM_UNCACHED
542 CONF_CM_CACHABLE_NONCOHERENT
543 CONF_CM_CACHABLE_CE
544 CONF_CM_CACHABLE_COW
545 CONF_CM_CACHABLE_CUW
546 CONF_CM_CACHABLE_ACCELERATED
547
548 CONFIG_SYS_XWAY_EBU_BOOTCFG
549
550 Special option for Lantiq XWAY SoCs for booting from NOR flash.
551 See also arch/mips/cpu/mips32/start.S.
552
553 CONFIG_XWAY_SWAP_BYTES
554
555 Enable compilation of tools/xway-swap-bytes needed for Lantiq
556 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
557 be swapped if a flash programmer is used.
558
Christian Rieschb67d8812012-02-02 00:44:39 +0000559- ARM options:
560 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
561
562 Select high exception vectors of the ARM core, e.g., do not
563 clear the V bit of the c1 register of CP15.
564
York Sun207774b2015-03-20 19:28:08 -0700565 COUNTER_FREQUENCY
566 Generic timer clock source frequency.
567
568 COUNTER_FREQUENCY_REAL
569 Generic timer clock source frequency if the real clock is
570 different from COUNTER_FREQUENCY, and can only be determined
571 at run time.
572
Stephen Warren73c38932015-01-19 16:25:52 -0700573- Tegra SoC options:
574 CONFIG_TEGRA_SUPPORT_NON_SECURE
575
576 Support executing U-Boot in non-secure (NS) mode. Certain
577 impossible actions will be skipped if the CPU is in NS mode,
578 such as ARM architectural timer initialization.
579
wdenk5da627a2003-10-09 20:09:04 +0000580- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000581 CONFIG_CLOCKS_IN_MHZ
582
583 U-Boot stores all clock information in Hz
584 internally. For binary compatibility with older Linux
585 kernels (which expect the clocks passed in the
586 bd_info data to be in MHz) the environment variable
587 "clocks_in_mhz" can be defined so that U-Boot
588 converts clock data to MHZ before passing it to the
589 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000590 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denk218ca722008-03-26 10:40:12 +0100591 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000592 default environment.
593
wdenk5da627a2003-10-09 20:09:04 +0000594 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
595
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800596 When transferring memsize parameter to Linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000597 expect it to be in bytes, others in MB.
598 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
599
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400600 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200601
602 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400603 passed using flattened device trees (based on open firmware
604 concepts).
605
606 CONFIG_OF_LIBFDT
607 * New libfdt-based support
608 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500609 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400610
Marcel Ziswilerb55ae402009-09-09 21:18:41 +0200611 OF_CPU - The proper name of the cpus node (only required for
612 MPC512X and MPC5xxx based boards).
613 OF_SOC - The proper name of the soc node (only required for
614 MPC512X and MPC5xxx based boards).
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200615 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600616 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200617
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200618 boards with QUICC Engines require OF_QE to set UCC MAC
619 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500620
Kumar Gala4e253132006-01-11 13:54:17 -0600621 CONFIG_OF_BOARD_SETUP
622
623 Board code has addition modification that it wants to make
624 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000625
Simon Glassc654b512014-10-23 18:58:54 -0600626 CONFIG_OF_SYSTEM_SETUP
627
628 Other code has addition modification that it wants to make
629 to the flat device tree before handing it off to the kernel.
630 This causes ft_system_setup() to be called before booting
631 the kernel.
632
Heiko Schocher3887c3f2009-09-23 07:56:08 +0200633 CONFIG_OF_IDE_FIXUP
634
635 U-Boot can detect if an IDE device is present or not.
636 If not, and this new config option is activated, U-Boot
637 removes the ATA node from the DTS before booting Linux,
638 so the Linux IDE driver does not probe the device and
639 crash. This is needed for buggy hardware (uc101) where
640 no pull down resistor is connected to the signal IDE5V_DD7.
641
Igor Grinberg7eb29392011-07-14 05:45:07 +0000642 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
643
644 This setting is mandatory for all boards that have only one
645 machine type and must be used to specify the machine type
646 number as it appears in the ARM machine registry
647 (see http://www.arm.linux.org.uk/developer/machines/).
648 Only boards that have multiple machine types supported
649 in a single configuration file and the machine type is
650 runtime discoverable, do not have to use this setting.
651
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100652- vxWorks boot parameters:
653
654 bootvx constructs a valid bootline using the following
Bin Meng9e98b7e2015-10-07 20:19:17 -0700655 environments variables: bootdev, bootfile, ipaddr, netmask,
656 serverip, gatewayip, hostname, othbootargs.
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100657 It loads the vxWorks image pointed bootfile.
658
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100659 Note: If a "bootargs" environment is defined, it will overwride
660 the defaults discussed just above.
661
Aneesh V2c451f72011-06-16 23:30:47 +0000662- Cache Configuration:
663 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
664 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
665 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
666
Aneesh V93bc2192011-06-16 23:30:51 +0000667- Cache Configuration for ARM:
668 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
669 controller
670 CONFIG_SYS_PL310_BASE - Physical base address of PL310
671 controller register space
672
wdenk6705d812004-08-02 23:22:59 +0000673- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200674 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000675
676 Define this if you want support for Amba PrimeCell PL010 UARTs.
677
Andreas Engel48d01922008-09-08 14:30:53 +0200678 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000679
680 Define this if you want support for Amba PrimeCell PL011 UARTs.
681
682 CONFIG_PL011_CLOCK
683
684 If you have Amba PrimeCell PL011 UARTs, set this variable to
685 the clock speed of the UARTs.
686
687 CONFIG_PL01x_PORTS
688
689 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
690 define this to a list of base addresses for each (supported)
691 port. See e.g. include/configs/versatile.h
692
Karicheri, Muralidharand57dee52014-04-09 15:38:46 -0400693 CONFIG_SERIAL_HW_FLOW_CONTROL
694
695 Define this variable to enable hw flow control in serial driver.
696 Current user of this option is drivers/serial/nsl16550.c driver
wdenk6705d812004-08-02 23:22:59 +0000697
wdenkc6097192002-11-03 00:24:07 +0000698- Console Baudrate:
699 CONFIG_BAUDRATE - in bps
700 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200701 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000702
Heiko Schocherc92fac92009-01-30 12:55:38 +0100703- Console Rx buffer length
704 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
705 the maximum receive buffer length for the SMC.
Heiko Schocher5b8e76c2017-06-07 17:33:09 +0200706 This option is actual only for 82xx possible.
Heiko Schocherc92fac92009-01-30 12:55:38 +0100707 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
708 must be defined, to setup the maximum idle timeout for
709 the SMC.
710
wdenkc6097192002-11-03 00:24:07 +0000711- Autoboot Command:
712 CONFIG_BOOTCOMMAND
713 Only needed when CONFIG_BOOTDELAY is enabled;
714 define a command string that is automatically executed
715 when no character is read on the console interface
716 within "Boot Delay" after reset.
717
718 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000719 This can be used to pass arguments to the bootm
720 command. The value of CONFIG_BOOTARGS goes into the
721 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000722
723 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000724 The value of these goes into the environment as
725 "ramboot" and "nfsboot" respectively, and can be used
726 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200727 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000728
Heiko Schochereda0ba32013-11-04 14:04:59 +0100729- Bootcount:
730 CONFIG_BOOTCOUNT_LIMIT
731 Implements a mechanism for detecting a repeating reboot
732 cycle, see:
733 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
734
735 CONFIG_BOOTCOUNT_ENV
736 If no softreset save registers are found on the hardware
737 "bootcount" is stored in the environment. To prevent a
738 saveenv on all reboots, the environment variable
739 "upgrade_available" is used. If "upgrade_available" is
740 0, "bootcount" is always 0, if "upgrade_available" is
741 1 "bootcount" is incremented in the environment.
742 So the Userspace Applikation must set the "upgrade_available"
743 and "bootcount" variable to 0, if a boot was successfully.
744
wdenkc6097192002-11-03 00:24:07 +0000745- Pre-Boot Commands:
746 CONFIG_PREBOOT
747
748 When this option is #defined, the existence of the
749 environment variable "preboot" will be checked
750 immediately before starting the CONFIG_BOOTDELAY
751 countdown and/or running the auto-boot command resp.
752 entering interactive mode.
753
754 This feature is especially useful when "preboot" is
755 automatically generated or modified. For an example
756 see the LWMON board specific code: here "preboot" is
757 modified when the user holds down a certain
758 combination of keys on the (special) keyboard when
759 booting the systems
760
761- Serial Download Echo Mode:
762 CONFIG_LOADS_ECHO
763 If defined to 1, all characters received during a
764 serial download (using the "loads" command) are
765 echoed back. This might be needed by some terminal
766 emulations (like "cu"), but may as well just take
767 time on others. This setting #define's the initial
768 value of the "loads_echo" environment variable.
769
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500770- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000771 CONFIG_KGDB_BAUDRATE
772 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200773 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000774
775- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500776 Monitor commands can be included or excluded
777 from the build by using the #include files
Stephen Warrenc6c621b2012-08-05 16:07:19 +0000778 <config_cmd_all.h> and #undef'ing unwanted
Joe Hershbergeref0f2f52015-06-22 16:15:30 -0500779 commands, or adding #define's for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000780
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500781 The default command configuration includes all commands
782 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000783
Marek Vasutb401b732014-03-05 19:58:39 +0100784 CONFIG_CMD_AES AES 128 CBC encrypt/decrypt
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500785 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500786 CONFIG_CMD_BDI bdinfo
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500787 CONFIG_CMD_BOOTD bootd
Tom Rinid2b2ffe2014-08-14 06:42:36 -0400788 CONFIG_CMD_BOOTI * ARM64 Linux kernel Image support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500789 CONFIG_CMD_CACHE * icache, dcache
790 CONFIG_CMD_CONSOLE coninfo
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500791 CONFIG_CMD_DHCP * DHCP support
792 CONFIG_CMD_DIAG * Diagnostics
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500793 CONFIG_CMD_ECHO echo arguments
Peter Tyser246c6922009-10-25 15:12:56 -0500794 CONFIG_CMD_EDITENV edit env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500795 CONFIG_CMD_ELF * bootelf, bootvx
Andrew Ruder88733e22013-10-22 19:07:34 -0500796 CONFIG_CMD_ENV_EXISTS * check existence of env variable
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500797 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren03e2ecf2012-10-22 06:43:50 +0000798 CONFIG_CMD_EXT2 * ext2 command support
799 CONFIG_CMD_EXT4 * ext4 command support
Stephen Warren16f4d932014-01-24 20:46:37 -0700800 CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls)
801 that work for multiple fs types
Christian Gmeiner59e890e2014-11-12 14:35:04 +0100802 CONFIG_CMD_FS_UUID * Look up a filesystem UUID
Mike Frysingerbdab39d2009-01-28 19:08:14 -0500803 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500804 CONFIG_CMD_FLASH flinfo, erase, protect
805 CONFIG_CMD_FPGA FPGA device initialization support
Mike Frysingera641b972010-12-26 23:32:22 -0500806 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsa000b792011-04-05 07:15:14 +0000807 CONFIG_CMD_GREPENV * search environment
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500808 CONFIG_CMD_I2C * I2C serial bus support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500809 CONFIG_CMD_IMI iminfo
Vipin Kumar8fdf1e02012-12-16 22:32:48 +0000810 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200811 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500812 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershbergerc167cc02012-10-03 11:15:51 +0000813 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500814 CONFIG_CMD_ITEST Integer/string test of 2 values
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200815 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerd22c3382012-05-23 08:00:12 +0000816 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
817 (169.254.*.*)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500818 CONFIG_CMD_LOADB loadb
819 CONFIG_CMD_LOADS loads
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200820 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz02c9aa12009-07-27 00:07:59 -0400821 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glass15a33e42012-11-30 13:01:20 +0000822 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500823 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denka2681702013-03-08 10:51:32 +0000824 loop, loopw
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200825 CONFIG_CMD_MEMTEST * mtest
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500826 CONFIG_CMD_MISC Misc functions like sleep etc
827 CONFIG_CMD_MMC * MMC memory mapped support
828 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +0100829 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500830 CONFIG_CMD_NAND * NAND support
831 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200832 CONFIG_CMD_NFS NFS support
Peter Tysere92739d2008-12-17 16:36:21 -0600833 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000834 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500835 CONFIG_CMD_PCI * pciinfo
836 CONFIG_CMD_PCMCIA * PCMCIA support
837 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
838 host
839 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersff048ea2012-12-05 14:46:30 +0000840 CONFIG_CMD_READ * Read raw data from partition
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500841 CONFIG_CMD_REGINFO * Register dump
842 CONFIG_CMD_RUN run command in env variable
Simon Glassd3049312012-12-26 09:53:36 +0000843 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500844 CONFIG_CMD_SAVES * save S record dump
Simon Glassc649e3c2016-05-01 11:36:02 -0600845 CONFIG_SCSI * SCSI Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500846 CONFIG_CMD_SDRAM * print SDRAM configuration information
847 (requires CONFIG_CMD_I2C)
848 CONFIG_CMD_SETGETDCR Support for DCR Register access
849 (4xx only)
Eric Nelsonf61ec452012-01-31 10:52:08 -0700850 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Bob Liu7d861d92013-02-05 19:05:41 +0800851 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk74de7ae2009-04-01 23:34:12 +0200852 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500853 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7a83af02011-05-17 00:03:40 +0000854 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass1fb7cd42011-10-24 18:00:07 +0000855 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershbergerda83bcd2012-10-03 12:14:57 +0000856 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
857 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500858 CONFIG_CMD_USB * USB support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500859 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasutc8339f52012-03-31 07:47:16 +0000860 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200861 CONFIG_CMD_XIMG Load part of Multi Image
Przemyslaw Marczak89c82302014-04-02 10:20:05 +0200862 CONFIG_CMD_UUID * Generate random UUID or GUID string
wdenkc6097192002-11-03 00:24:07 +0000863
864 EXAMPLE: If you want all functions except of network
865 support you can write:
866
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500867 #include "config_cmd_all.h"
868 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000869
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400870 Other Commands:
871 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000872
873 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500874 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +0000875 what you (and your U-Boot users) are doing. Data
Heiko Schocher5b8e76c2017-06-07 17:33:09 +0200876 cache cannot be enabled on systems like the
wdenk43d96162003-03-06 00:02:04 +0000877 8260 (where accesses to the IMMR region must be
878 uncached), and it cannot be disabled on all other
879 systems where we (mis-) use the data cache to hold an
880 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000881
882
883 XXX - this list needs to get updated!
884
Simon Glass302a6482016-03-13 19:07:28 -0600885- Removal of commands
886 If no commands are needed to boot, you can disable
887 CONFIG_CMDLINE to remove them. In this case, the command line
888 will not be available, and when U-Boot wants to execute the
889 boot command (on start-up) it will call board_run_command()
890 instead. This can reduce image size significantly for very
891 simple boot procedures.
892
Wolfgang Denka5ecbe62013-03-23 23:50:31 +0000893- Regular expression support:
894 CONFIG_REGEX
Wolfgang Denk93e14592013-10-04 17:43:24 +0200895 If this variable is defined, U-Boot is linked against
896 the SLRE (Super Light Regular Expression) library,
897 which adds regex support to some commands, as for
898 example "env grep" and "setexpr".
Wolfgang Denka5ecbe62013-03-23 23:50:31 +0000899
Simon Glass45ba8072011-10-15 05:48:20 +0000900- Device tree:
901 CONFIG_OF_CONTROL
902 If this variable is defined, U-Boot will use a device tree
903 to configure its devices, instead of relying on statically
904 compiled #defines in the board file. This option is
905 experimental and only available on a few boards. The device
906 tree is available in the global data as gd->fdt_blob.
907
Simon Glass2c0f79e2011-10-24 19:15:31 +0000908 U-Boot needs to get its device tree from somewhere. This can
Alex Deymo82f766d2017-04-02 01:25:20 -0700909 be done using one of the three options below:
Simon Glassbbb0b122011-10-15 05:48:21 +0000910
911 CONFIG_OF_EMBED
912 If this variable is defined, U-Boot will embed a device tree
913 binary in its image. This device tree file should be in the
914 board directory and called <soc>-<board>.dts. The binary file
915 is then picked up in board_init_f() and made available through
916 the global data structure as gd->blob.
Simon Glass45ba8072011-10-15 05:48:20 +0000917
Simon Glass2c0f79e2011-10-24 19:15:31 +0000918 CONFIG_OF_SEPARATE
919 If this variable is defined, U-Boot will build a device tree
920 binary. It will be called u-boot.dtb. Architecture-specific
921 code will locate it at run-time. Generally this works by:
922
923 cat u-boot.bin u-boot.dtb >image.bin
924
925 and in fact, U-Boot does this for you, creating a file called
926 u-boot-dtb.bin which is useful in the common case. You can
927 still use the individual files if you need something more
928 exotic.
929
Alex Deymo82f766d2017-04-02 01:25:20 -0700930 CONFIG_OF_BOARD
931 If this variable is defined, U-Boot will use the device tree
932 provided by the board at runtime instead of embedding one with
933 the image. Only boards defining board_fdt_blob_setup() support
934 this option (see include/fdtdec.h file).
935
wdenkc6097192002-11-03 00:24:07 +0000936- Watchdog:
937 CONFIG_WATCHDOG
938 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +0000939 support for the SoC. There must be support in the SoC
Heiko Schocher5b8e76c2017-06-07 17:33:09 +0200940 specific code for a watchdog. For the 8260
Detlev Zundel6abe6fb2011-04-27 05:25:59 +0000941 CPUs, the SIU Watchdog feature is enabled in the SYPCR
942 register. When supported for a specific SoC is
943 available, then no further board specific code should
944 be needed to use it.
945
946 CONFIG_HW_WATCHDOG
947 When using a watchdog circuitry external to the used
948 SoC, then define this variable and provide board
949 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000950
Heiko Schocher7bae0d62015-01-21 08:38:22 +0100951 CONFIG_AT91_HW_WDT_TIMEOUT
952 specify the timeout in seconds. default 2 seconds.
953
stroesec1551ea2003-04-04 15:53:41 +0000954- U-Boot Version:
955 CONFIG_VERSION_VARIABLE
956 If this variable is defined, an environment variable
957 named "ver" is created by U-Boot showing the U-Boot
958 version as printed by the "version" command.
Benoît Thébaudeaua1ea8e52012-08-13 15:01:14 +0200959 Any change to this variable will be reverted at the
960 next reset.
stroesec1551ea2003-04-04 15:53:41 +0000961
wdenkc6097192002-11-03 00:24:07 +0000962- Real-Time Clock:
963
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500964 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000965 has to be selected, too. Define exactly one of the
966 following options:
967
wdenkc6097192002-11-03 00:24:07 +0000968 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam4e8b7542011-10-24 06:44:15 +0000969 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +0000970 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +0000971 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000972 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +0000973 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel412921d2014-07-21 11:06:16 +0200974 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenk3bac3512003-03-12 10:41:04 +0000975 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +0100976 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +0000977 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Chris Packham2bd3cab2017-05-30 12:03:33 +1200978 CONFIG_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +0200979 CONFIG_SYS_RV3029_TCR - enable trickle charger on
980 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +0000981
wdenkb37c7e52003-06-30 16:24:52 +0000982 Note that if the RTC uses I2C, then the I2C interface
983 must also be configured. See I2C Support, below.
984
Peter Tysere92739d2008-12-17 16:36:21 -0600985- GPIO Support:
986 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tysere92739d2008-12-17 16:36:21 -0600987
Chris Packham5dec49c2010-12-19 10:12:13 +0000988 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
989 chip-ngpio pairs that tell the PCA953X driver the number of
990 pins supported by a particular chip.
991
Peter Tysere92739d2008-12-17 16:36:21 -0600992 Note that if the GPIO device uses I2C, then the I2C interface
993 must also be configured. See I2C Support, below.
994
Simon Glassaa532332014-06-11 23:29:41 -0600995- I/O tracing:
996 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
997 accesses and can checksum them or write a list of them out
998 to memory. See the 'iotrace' command for details. This is
999 useful for testing device drivers since it can confirm that
1000 the driver behaves the same way before and after a code
1001 change. Currently this is supported on sandbox and arm. To
1002 add support for your architecture, add '#include <iotrace.h>'
1003 to the bottom of arch/<arch>/include/asm/io.h and test.
1004
1005 Example output from the 'iotrace stats' command is below.
1006 Note that if the trace buffer is exhausted, the checksum will
1007 still continue to operate.
1008
1009 iotrace is enabled
1010 Start: 10000000 (buffer start address)
1011 Size: 00010000 (buffer size)
1012 Offset: 00000120 (current buffer offset)
1013 Output: 10000120 (start + offset)
1014 Count: 00000018 (number of trace records)
1015 CRC32: 9526fb66 (CRC32 of all trace records)
1016
wdenkc6097192002-11-03 00:24:07 +00001017- Timestamp Support:
1018
wdenk43d96162003-03-06 00:02:04 +00001019 When CONFIG_TIMESTAMP is selected, the timestamp
1020 (date and time) of an image is printed by image
1021 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001022 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001023
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001024- Partition Labels (disklabels) Supported:
1025 Zero or more of the following:
1026 CONFIG_MAC_PARTITION Apple's MacOS partition table.
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001027 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1028 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1029 bootloader. Note 2TB partition limit; see
1030 disk/part_efi.c
1031 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001032
Simon Glassfc843a02017-05-17 03:25:30 -06001033 If IDE or SCSI support is enabled (CONFIG_IDE or
Simon Glassc649e3c2016-05-01 11:36:02 -06001034 CONFIG_SCSI) you must configure support for at
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001035 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001036
1037- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +00001038 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1039 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001040
wdenk4d13cba2004-03-14 14:09:05 +00001041 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1042 be performed by calling the function
1043 ide_set_reset(int reset)
1044 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001045
1046- ATAPI Support:
1047 CONFIG_ATAPI
1048
1049 Set this to enable ATAPI support.
1050
wdenkc40b2952004-03-13 23:29:43 +00001051- LBA48 Support
1052 CONFIG_LBA48
1053
1054 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +01001055 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +00001056 Whithout these , LBA48 support uses 32bit variables and will 'only'
1057 support disks up to 2.1TB.
1058
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001059 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +00001060 When enabled, makes the IDE subsystem use 64bit sector addresses.
1061 Default is 32bit.
1062
wdenkc6097192002-11-03 00:24:07 +00001063- SCSI Support:
1064 At the moment only there is only support for the
1065 SYM53C8XX SCSI controller; define
1066 CONFIG_SCSI_SYM53C8XX to enable it.
1067
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001068 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1069 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1070 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001071 maximum numbers of LUNs, SCSI ID's and target
1072 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001073 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001074
Wolfgang Denk93e14592013-10-04 17:43:24 +02001075 The environment variable 'scsidevs' is set to the number of
1076 SCSI devices found during the last scan.
Stefan Reinauer447c0312012-10-29 05:23:48 +00001077
wdenkc6097192002-11-03 00:24:07 +00001078- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +00001079 CONFIG_E1000
Kyle Moffettce5207e2011-10-18 11:05:29 +00001080 Support for Intel 8254x/8257x gigabit chips.
1081
1082 CONFIG_E1000_SPI
1083 Utility code for direct access to the SPI bus on Intel 8257x.
1084 This does not do anything useful unless you set at least one
1085 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1086
1087 CONFIG_E1000_SPI_GENERIC
1088 Allow generic access to the SPI bus on the Intel 8257x, for
1089 example with the "sspi" command.
1090
1091 CONFIG_CMD_E1000
1092 Management command for E1000 devices. When used on devices
1093 with SPI support you can reprogram the EEPROM from U-Boot.
stroese53cf9432003-06-05 15:39:44 +00001094
wdenkc6097192002-11-03 00:24:07 +00001095 CONFIG_EEPRO100
1096 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001097 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001098 write routine for first time initialisation.
1099
1100 CONFIG_TULIP
1101 Support for Digital 2114x chips.
1102 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1103 modem chip initialisation (KS8761/QS6611).
1104
1105 CONFIG_NATSEMI
1106 Support for National dp83815 chips.
1107
1108 CONFIG_NS8382X
1109 Support for National dp8382[01] gigabit chips.
1110
wdenk45219c42003-05-12 21:50:16 +00001111- NETWORK Support (other):
1112
Jens Scharsigc041e9d2010-01-23 12:03:45 +01001113 CONFIG_DRIVER_AT91EMAC
1114 Support for AT91RM9200 EMAC.
1115
1116 CONFIG_RMII
1117 Define this to use reduced MII inteface
1118
1119 CONFIG_DRIVER_AT91EMAC_QUIET
1120 If this defined, the driver is quiet.
1121 The driver doen't show link status messages.
1122
Rob Herringefdd7312011-12-15 11:15:49 +00001123 CONFIG_CALXEDA_XGMAC
1124 Support for the Calxeda XGMAC device
1125
Ashok3bb46d22012-10-15 06:20:47 +00001126 CONFIG_LAN91C96
wdenk45219c42003-05-12 21:50:16 +00001127 Support for SMSC's LAN91C96 chips.
1128
wdenk45219c42003-05-12 21:50:16 +00001129 CONFIG_LAN91C96_USE_32_BIT
1130 Define this to enable 32 bit addressing
1131
Ashok3bb46d22012-10-15 06:20:47 +00001132 CONFIG_SMC91111
wdenkf39748a2004-06-09 13:37:52 +00001133 Support for SMSC's LAN91C111 chip
1134
1135 CONFIG_SMC91111_BASE
1136 Define this to hold the physical address
1137 of the device (I/O space)
1138
1139 CONFIG_SMC_USE_32_BIT
1140 Define this if data bus is 32 bits
1141
1142 CONFIG_SMC_USE_IOFUNCS
1143 Define this to use i/o functions instead of macros
1144 (some hardware wont work with macros)
1145
Heiko Schocherdc02bad2011-11-15 10:00:04 -05001146 CONFIG_DRIVER_TI_EMAC
1147 Support for davinci emac
1148
1149 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1150 Define this if you have more then 3 PHYs.
1151
Macpaul Linb3dbf4a52010-12-21 16:59:46 +08001152 CONFIG_FTGMAC100
1153 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1154
1155 CONFIG_FTGMAC100_EGIGA
1156 Define this to use GE link update with gigabit PHY.
1157 Define this if FTGMAC100 is connected to gigabit PHY.
1158 If your system has 10/100 PHY only, it might not occur
1159 wrong behavior. Because PHY usually return timeout or
1160 useless data when polling gigabit status and gigabit
1161 control registers. This behavior won't affect the
1162 correctnessof 10/100 link speed update.
1163
Mike Rapoportc2fff332009-11-11 10:03:03 +02001164 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +02001165 Support for SMSC's LAN911x and LAN921x chips
1166
Mike Rapoportc2fff332009-11-11 10:03:03 +02001167 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +02001168 Define this to hold the physical address
1169 of the device (I/O space)
1170
Mike Rapoportc2fff332009-11-11 10:03:03 +02001171 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001172 Define this if data bus is 32 bits
1173
Mike Rapoportc2fff332009-11-11 10:03:03 +02001174 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001175 Define this if data bus is 16 bits. If your processor
1176 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +02001177 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +02001178
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +09001179 CONFIG_SH_ETHER
1180 Support for Renesas on-chip Ethernet controller
1181
1182 CONFIG_SH_ETHER_USE_PORT
1183 Define the number of ports to be used
1184
1185 CONFIG_SH_ETHER_PHY_ADDR
1186 Define the ETH PHY's address
1187
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +09001188 CONFIG_SH_ETHER_CACHE_WRITEBACK
1189 If this option is set, the driver enables cache flush.
1190
Heiko Schocherb2f97cf2014-07-18 06:07:19 +02001191- PWM Support:
1192 CONFIG_PWM_IMX
Robert P. J. Day5052e812016-09-13 08:35:18 -04001193 Support for PWM module on the imx6.
Heiko Schocherb2f97cf2014-07-18 06:07:19 +02001194
Vadim Bendebury5e124722011-10-17 08:36:14 +00001195- TPM Support:
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001196 CONFIG_TPM
1197 Support TPM devices.
1198
Christophe Ricard0766ad22015-10-06 22:54:41 +02001199 CONFIG_TPM_TIS_INFINEON
1200 Support for Infineon i2c bus TPM devices. Only one device
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +00001201 per system is supported at this time.
1202
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +00001203 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1204 Define the burst count bytes upper limit
1205
Christophe Ricard3aa74082016-01-21 23:27:13 +01001206 CONFIG_TPM_ST33ZP24
1207 Support for STMicroelectronics TPM devices. Requires DM_TPM support.
1208
1209 CONFIG_TPM_ST33ZP24_I2C
1210 Support for STMicroelectronics ST33ZP24 I2C devices.
1211 Requires TPM_ST33ZP24 and I2C.
1212
Christophe Ricardb75fdc12016-01-21 23:27:14 +01001213 CONFIG_TPM_ST33ZP24_SPI
1214 Support for STMicroelectronics ST33ZP24 SPI devices.
1215 Requires TPM_ST33ZP24 and SPI.
1216
Dirk Eibachc01939c2013-06-26 15:55:15 +02001217 CONFIG_TPM_ATMEL_TWI
1218 Support for Atmel TWI TPM device. Requires I2C support.
1219
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001220 CONFIG_TPM_TIS_LPC
Vadim Bendebury5e124722011-10-17 08:36:14 +00001221 Support for generic parallel port TPM devices. Only one device
1222 per system is supported at this time.
1223
1224 CONFIG_TPM_TIS_BASE_ADDRESS
1225 Base address where the generic TPM device is mapped
1226 to. Contemporary x86 systems usually map it at
1227 0xfed40000.
1228
Reinhard Pfaube6c1522013-06-26 15:55:13 +02001229 CONFIG_CMD_TPM
1230 Add tpm monitor functions.
1231 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1232 provides monitor access to authorized functions.
1233
1234 CONFIG_TPM
1235 Define this to enable the TPM support library which provides
1236 functional interfaces to some TPM commands.
1237 Requires support for a TPM device.
1238
1239 CONFIG_TPM_AUTH_SESSIONS
1240 Define this to enable authorized functions in the TPM library.
1241 Requires CONFIG_TPM and CONFIG_SHA1.
1242
wdenkc6097192002-11-03 00:24:07 +00001243- USB Support:
1244 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +00001245 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001246 CONFIG_USB_UHCI to enable it.
1247 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +00001248 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001249 storage devices.
1250 Note:
1251 Supported are USB Keyboards and USB Floppy drives
1252 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +00001253 MPC5200 USB requires additional defines:
1254 CONFIG_USB_CLOCK
1255 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001256 CONFIG_PSC3_USB
1257 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +00001258 CONFIG_USB_CONFIG
1259 for differential drivers: 0x00001000
1260 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001261 for differential drivers on PSC3: 0x00000100
1262 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001263 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +02001264 May be defined to allow interrupt polling
1265 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +00001266
Simon Glass9ab4ce22012-02-27 10:52:47 +00001267 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1268 txfilltuning field in the EHCI controller on reset.
1269
Oleksandr Tymoshenko6e9e0622014-02-01 21:51:25 -07001270 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1271 HW module registers.
1272
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001273- USB Device:
1274 Define the below if you wish to use the USB console.
1275 Once firmware is rebuilt from a serial console issue the
1276 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001277 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001278 it has found a new device. The environment variable usbtty
1279 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +02001280 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001281 Common Device Class Abstract Control Model serial device.
1282 If you select usbtty = gserial you should be able to enumerate
1283 a Linux host by
1284 # modprobe usbserial vendor=0xVendorID product=0xProductID
1285 else if using cdc_acm, simply setting the environment
1286 variable usbtty to be cdc_acm should suffice. The following
1287 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001288
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001289 CONFIG_USB_DEVICE
1290 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +00001291
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001292 CONFIG_USB_TTY
1293 Define this to have a tty type of device available to
1294 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +02001295
Vipin KUMARf9da0f82012-03-26 15:38:06 +05301296 CONFIG_USBD_HS
1297 Define this to enable the high speed support for usb
1298 device and usbtty. If this feature is enabled, a routine
1299 int is_usbd_high_speed(void)
1300 also needs to be defined by the driver to dynamically poll
1301 whether the enumeration has succeded at high speed or full
1302 speed.
1303
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001304 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001305 Define this if you want stdin, stdout &/or stderr to
1306 be set to usbtty.
1307
Wolfgang Denk386eda02006-06-14 18:14:56 +02001308 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001309 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001310 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001311 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1312 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1313 should pretend to be a Linux device to it's target host.
1314
1315 CONFIG_USBD_MANUFACTURER
1316 Define this string as the name of your company for
1317 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001318
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001319 CONFIG_USBD_PRODUCT_NAME
1320 Define this string as the name of your product
1321 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1322
1323 CONFIG_USBD_VENDORID
1324 Define this as your assigned Vendor ID from the USB
1325 Implementors Forum. This *must* be a genuine Vendor ID
1326 to avoid polluting the USB namespace.
1327 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001328
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001329 CONFIG_USBD_PRODUCTID
1330 Define this as the unique Product ID
1331 for your device
1332 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001333
Igor Grinbergd70a5602011-12-12 12:08:35 +02001334- ULPI Layer Support:
1335 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1336 the generic ULPI layer. The generic layer accesses the ULPI PHY
1337 via the platform viewport, so you need both the genric layer and
1338 the viewport enabled. Currently only Chipidea/ARC based
1339 viewport is supported.
1340 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1341 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stach6d365ea2012-10-01 00:44:35 +02001342 If your ULPI phy needs a different reference clock than the
1343 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1344 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001345
1346- MMC Support:
1347 The MMC controller on the Intel PXA is supported. To
1348 enable this define CONFIG_MMC. The MMC can be
1349 accessed from the boot prompt by mapping the device
1350 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001351 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1352 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001353
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +00001354 CONFIG_SH_MMCIF
1355 Support for Renesas on-chip MMCIF controller
1356
1357 CONFIG_SH_MMCIF_ADDR
1358 Define the base address of MMCIF registers
1359
1360 CONFIG_SH_MMCIF_CLK
1361 Define the clock frequency for MMCIF
1362
Pierre Aubert1fd93c62014-04-24 10:30:08 +02001363 CONFIG_SUPPORT_EMMC_BOOT
1364 Enable some additional features of the eMMC boot partitions.
1365
1366 CONFIG_SUPPORT_EMMC_RPMB
1367 Enable the commands for reading, writing and programming the
1368 key for the Replay Protection Memory Block partition in eMMC.
1369
Tom Rinib3ba6e92013-03-14 05:32:47 +00001370- USB Device Firmware Update (DFU) class support:
Paul Kocialkowski01acd6a2015-06-12 19:56:58 +02001371 CONFIG_USB_FUNCTION_DFU
Tom Rinib3ba6e92013-03-14 05:32:47 +00001372 This enables the USB portion of the DFU USB class
1373
1374 CONFIG_CMD_DFU
1375 This enables the command "dfu" which is used to have
1376 U-Boot create a DFU class device via USB. This command
1377 requires that the "dfu_alt_info" environment variable be
1378 set and define the alt settings to expose to the host.
1379
1380 CONFIG_DFU_MMC
1381 This enables support for exposing (e)MMC devices via DFU.
1382
Pantelis Antoniouc6631762013-03-14 05:32:52 +00001383 CONFIG_DFU_NAND
1384 This enables support for exposing NAND devices via DFU.
1385
Afzal Mohammeda9479f02013-09-18 01:15:24 +05301386 CONFIG_DFU_RAM
1387 This enables support for exposing RAM via DFU.
1388 Note: DFU spec refer to non-volatile memory usage, but
1389 allow usages beyond the scope of spec - here RAM usage,
1390 one that would help mostly the developer.
1391
Heiko Schochere7e75c72013-06-12 06:05:51 +02001392 CONFIG_SYS_DFU_DATA_BUF_SIZE
1393 Dfu transfer uses a buffer before writing data to the
1394 raw storage device. Make the size (in bytes) of this buffer
1395 configurable. The size of this buffer is also configurable
1396 through the "dfu_bufsiz" environment variable.
1397
Pantelis Antoniouea2453d2013-03-14 05:32:48 +00001398 CONFIG_SYS_DFU_MAX_FILE_SIZE
1399 When updating files rather than the raw storage device,
1400 we use a static buffer to copy the file into and then write
1401 the buffer once we've been given the whole file. Define
1402 this to the maximum filesize (in bytes) for the buffer.
1403 Default is 4 MiB if undefined.
1404
Heiko Schocher001a8312014-03-18 08:09:56 +01001405 DFU_DEFAULT_POLL_TIMEOUT
1406 Poll timeout [ms], is the timeout a device can send to the
1407 host. The host must wait for this timeout before sending
1408 a subsequent DFU_GET_STATUS request to the device.
1409
1410 DFU_MANIFEST_POLL_TIMEOUT
1411 Poll timeout [ms], which the device sends to the host when
1412 entering dfuMANIFEST state. Host waits this timeout, before
1413 sending again an USB request to the device.
1414
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001415- USB Device Android Fastboot support:
Paul Kocialkowski17da3c02015-06-12 19:56:59 +02001416 CONFIG_USB_FUNCTION_FASTBOOT
1417 This enables the USB part of the fastboot gadget
1418
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001419 CONFIG_CMD_FASTBOOT
1420 This enables the command "fastboot" which enables the Android
1421 fastboot mode for the platform's USB device. Fastboot is a USB
1422 protocol for downloading images, flashing and device control
1423 used on Android devices.
1424 See doc/README.android-fastboot for more information.
1425
1426 CONFIG_ANDROID_BOOT_IMAGE
1427 This enables support for booting images which use the Android
1428 image format header.
1429
Paul Kocialkowskia588d992015-07-20 12:38:22 +02001430 CONFIG_FASTBOOT_BUF_ADDR
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001431 The fastboot protocol requires a large memory buffer for
1432 downloads. Define this to the starting RAM address to use for
1433 downloaded images.
1434
Paul Kocialkowskia588d992015-07-20 12:38:22 +02001435 CONFIG_FASTBOOT_BUF_SIZE
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001436 The fastboot protocol requires a large memory buffer for
1437 downloads. This buffer should be as large as possible for a
1438 platform. Define this to the size available RAM for fastboot.
1439
Steve Raed1b5ed02014-08-26 11:47:28 -07001440 CONFIG_FASTBOOT_FLASH
1441 The fastboot protocol includes a "flash" command for writing
1442 the downloaded image to a non-volatile storage device. Define
1443 this to enable the "fastboot flash" command.
1444
1445 CONFIG_FASTBOOT_FLASH_MMC_DEV
1446 The fastboot "flash" command requires additional information
1447 regarding the non-volatile storage device. Define this to
1448 the eMMC device that fastboot should use to store the image.
1449
Steve Rae0ff7e582014-12-12 15:51:54 -08001450 CONFIG_FASTBOOT_GPT_NAME
1451 The fastboot "flash" command supports writing the downloaded
1452 image to the Protective MBR and the Primary GUID Partition
1453 Table. (Additionally, this downloaded image is post-processed
1454 to generate and write the Backup GUID Partition Table.)
1455 This occurs when the specified "partition name" on the
1456 "fastboot flash" command line matches this value.
Petr Kulhavy6f6c8632016-09-09 10:27:18 +02001457 The default is "gpt" if undefined.
Steve Rae0ff7e582014-12-12 15:51:54 -08001458
Petr Kulhavyb6dd69a2016-09-09 10:27:16 +02001459 CONFIG_FASTBOOT_MBR_NAME
1460 The fastboot "flash" command supports writing the downloaded
1461 image to DOS MBR.
1462 This occurs when the "partition name" specified on the
1463 "fastboot flash" command line matches this value.
1464 If not defined the default value "mbr" is used.
1465
wdenk6705d812004-08-02 23:22:59 +00001466- Journaling Flash filesystem support:
Simon Glassb2482df2016-10-02 18:00:59 -06001467 CONFIG_JFFS2_NAND
wdenk6705d812004-08-02 23:22:59 +00001468 Define these for a default partition on a NAND device
1469
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001470 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1471 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001472 Define these for a default partition on a NOR device
1473
wdenkc6097192002-11-03 00:24:07 +00001474- Keyboard Support:
Simon Glass39f615e2015-11-11 10:05:47 -07001475 See Kconfig help for available keyboard drivers.
1476
1477 CONFIG_KEYBOARD
1478
1479 Define this to enable a custom keyboard support.
1480 This simply calls drv_keyboard_init() which must be
1481 defined in your board-specific files. This option is deprecated
1482 and is only used by novena. For new boards, use driver model
1483 instead.
wdenkc6097192002-11-03 00:24:07 +00001484
1485- Video support:
Timur Tabi7d3053f2011-02-15 17:09:19 -06001486 CONFIG_FSL_DIU_FB
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02001487 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi7d3053f2011-02-15 17:09:19 -06001488 SOCs that have a DIU should define this macro to enable DIU
1489 support, and should also define these other macros:
1490
1491 CONFIG_SYS_DIU_ADDR
1492 CONFIG_VIDEO
Timur Tabi7d3053f2011-02-15 17:09:19 -06001493 CONFIG_CFB_CONSOLE
1494 CONFIG_VIDEO_SW_CURSOR
1495 CONFIG_VGA_AS_SINGLE_DEVICE
1496 CONFIG_VIDEO_LOGO
1497 CONFIG_VIDEO_BMP_LOGO
1498
Timur Tabiba8e76b2011-04-11 14:18:22 -05001499 The DIU driver will look for the 'video-mode' environment
1500 variable, and if defined, enable the DIU as a console during
Fabio Estevam8eca9432016-04-02 11:53:18 -03001501 boot. See the documentation file doc/README.video for a
Timur Tabiba8e76b2011-04-11 14:18:22 -05001502 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001503
wdenkc6097192002-11-03 00:24:07 +00001504- LCD Support: CONFIG_LCD
1505
1506 Define this to enable LCD support (for output to LCD
1507 display); also select one of the supported displays
1508 by defining one of these:
1509
Stelian Pop39cf4802008-05-09 21:57:18 +02001510 CONFIG_ATMEL_LCD:
1511
1512 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1513
wdenkfd3103b2003-11-25 16:55:19 +00001514 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001515
wdenkfd3103b2003-11-25 16:55:19 +00001516 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001517
wdenkfd3103b2003-11-25 16:55:19 +00001518 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001519
wdenkfd3103b2003-11-25 16:55:19 +00001520 NEC NL6448BC20-08. 6.5", 640x480.
1521 Active, color, single scan.
1522
1523 CONFIG_NEC_NL6448BC33_54
1524
1525 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001526 Active, color, single scan.
1527
1528 CONFIG_SHARP_16x9
1529
1530 Sharp 320x240. Active, color, single scan.
1531 It isn't 16x9, and I am not sure what it is.
1532
1533 CONFIG_SHARP_LQ64D341
1534
1535 Sharp LQ64D341 display, 640x480.
1536 Active, color, single scan.
1537
1538 CONFIG_HLD1045
1539
1540 HLD1045 display, 640x480.
1541 Active, color, single scan.
1542
1543 CONFIG_OPTREX_BW
1544
1545 Optrex CBL50840-2 NF-FW 99 22 M5
1546 or
1547 Hitachi LMG6912RPFC-00T
1548 or
1549 Hitachi SP14Q002
1550
1551 320x240. Black & white.
1552
Simon Glass676d3192012-10-17 13:24:54 +00001553 CONFIG_LCD_ALIGNMENT
1554
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001555 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass676d3192012-10-17 13:24:54 +00001556 defined then the LCD will be aligned to this value instead.
1557 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1558 here, since it is cheaper to change data cache settings on
1559 a per-section basis.
1560
1561
Hannes Petermaier604c7d42015-03-27 08:01:38 +01001562 CONFIG_LCD_ROTATION
1563
1564 Sometimes, for example if the display is mounted in portrait
1565 mode or even if it's mounted landscape but rotated by 180degree,
1566 we need to rotate our content of the display relative to the
1567 framebuffer, so that user can read the messages which are
1568 printed out.
1569 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1570 initialized with a given rotation from "vl_rot" out of
1571 "vidinfo_t" which is provided by the board specific code.
1572 The value for vl_rot is coded as following (matching to
1573 fbcon=rotate:<n> linux-kernel commandline):
1574 0 = no rotation respectively 0 degree
1575 1 = 90 degree rotation
1576 2 = 180 degree rotation
1577 3 = 270 degree rotation
1578
1579 If CONFIG_LCD_ROTATION is not defined, the console will be
1580 initialized with 0degree rotation.
1581
Tom Wai-Hong Tam45d7f522012-09-28 15:11:16 +00001582 CONFIG_LCD_BMP_RLE8
1583
1584 Support drawing of RLE8-compressed bitmaps on the LCD.
1585
Tom Wai-Hong Tam735987c2012-12-05 14:46:40 +00001586 CONFIG_I2C_EDID
1587
1588 Enables an 'i2c edid' command which can read EDID
1589 information over I2C from an attached LCD display.
1590
wdenk7152b1d2003-09-05 23:19:14 +00001591- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001592
wdenk8bde7f72003-06-27 21:31:46 +00001593 If this option is set, the environment is checked for
1594 a variable "splashimage". If found, the usual display
1595 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001596 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001597 specified in "splashimage" is loaded instead. The
1598 console is redirected to the "nulldev", too. This
1599 allows for a "silent" boot where a splash screen is
1600 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001601
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001602 CONFIG_SPLASHIMAGE_GUARD
1603
1604 If this option is set, then U-Boot will prevent the environment
1605 variable "splashimage" from being set to a problematic address
Fabio Estevamab5645f2016-03-23 12:46:12 -03001606 (see doc/README.displaying-bmps).
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001607 This option is useful for targets where, due to alignment
1608 restrictions, an improperly aligned BMP image will cause a data
1609 abort. If you think you will not have problems with unaligned
1610 accesses (for example because your toolchain prevents them)
1611 there is no need to set this option.
1612
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001613 CONFIG_SPLASH_SCREEN_ALIGN
1614
1615 If this option is set the splash image can be freely positioned
1616 on the screen. Environment variable "splashpos" specifies the
1617 position as "x,y". If a positive number is given it is used as
1618 number of pixel from left/top. If a negative number is given it
1619 is used as number of pixel from right/bottom. You can also
1620 specify 'm' for centering the image.
1621
1622 Example:
1623 setenv splashpos m,m
1624 => image at center of screen
1625
1626 setenv splashpos 30,20
1627 => image at x = 30 and y = 20
1628
1629 setenv splashpos -10,m
1630 => vertically centered image
1631 at x = dspWidth - bmpWidth - 9
1632
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001633- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1634
1635 If this option is set, additionally to standard BMP
1636 images, gzipped BMP images can be displayed via the
1637 splashscreen support or the bmp command.
1638
Anatolij Gustschind5011762010-03-15 14:50:25 +01001639- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1640
1641 If this option is set, 8-bit RLE compressed BMP images
1642 can be displayed via the splashscreen support or the
1643 bmp command.
1644
wdenkc29fdfc2003-08-29 20:57:53 +00001645- Compression support:
Kees Cook8ef70472013-08-16 07:59:12 -07001646 CONFIG_GZIP
1647
1648 Enabled by default to support gzip compressed images.
1649
wdenkc29fdfc2003-08-29 20:57:53 +00001650 CONFIG_BZIP2
1651
1652 If this option is set, support for bzip2 compressed
1653 images is included. If not, only uncompressed and gzip
1654 compressed images are supported.
1655
wdenk42d1f032003-10-15 23:53:47 +00001656 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001657 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001658 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001659
Kees Cook8ef70472013-08-16 07:59:12 -07001660 CONFIG_LZO
1661
1662 If this option is set, support for LZO compressed images
1663 is included.
1664
wdenk17ea1172004-06-06 21:51:03 +00001665- MII/PHY support:
1666 CONFIG_PHY_ADDR
1667
1668 The address of PHY on MII bus.
1669
1670 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1671
1672 The clock frequency of the MII bus
1673
1674 CONFIG_PHY_GIGE
1675
1676 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001677 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00001678
1679 CONFIG_PHY_RESET_DELAY
1680
1681 Some PHY like Intel LXT971A need extra delay after
1682 reset before any MII register access is possible.
1683 For such PHY, set this option to the usec delay
1684 required. (minimum 300usec for LXT971A)
1685
1686 CONFIG_PHY_CMD_DELAY (ppc4xx)
1687
1688 Some PHY like Intel LXT971A need extra delay after
1689 command issued before MII status register can be read
1690
wdenkc6097192002-11-03 00:24:07 +00001691- IP address:
1692 CONFIG_IPADDR
1693
1694 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001695 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001696 determined through e.g. bootp.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001697 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001698
1699- Server IP address:
1700 CONFIG_SERVERIP
1701
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001702 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001703 server to contact when using the "tftboot" command.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001704 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001705
Robin Getz97cfe862009-07-21 12:15:28 -04001706 CONFIG_KEEP_SERVERADDR
1707
1708 Keeps the server's MAC address, in the env 'serveraddr'
1709 for passing to bootargs (like Linux's netconsole option)
1710
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001711- Gateway IP address:
1712 CONFIG_GATEWAYIP
1713
1714 Defines a default value for the IP address of the
1715 default router where packets to other networks are
1716 sent to.
1717 (Environment variable "gatewayip")
1718
1719- Subnet mask:
1720 CONFIG_NETMASK
1721
1722 Defines a default value for the subnet mask (or
1723 routing prefix) which is used to determine if an IP
1724 address belongs to the local subnet or needs to be
1725 forwarded through a router.
1726 (Environment variable "netmask")
1727
David Updegraff53a5c422007-06-11 10:41:07 -05001728- Multicast TFTP Mode:
1729 CONFIG_MCAST_TFTP
1730
1731 Defines whether you want to support multicast TFTP as per
1732 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001733 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05001734 driver in use must provide a function: mcast() to join/leave a
1735 multicast group.
1736
wdenkc6097192002-11-03 00:24:07 +00001737- BOOTP Recovery Mode:
1738 CONFIG_BOOTP_RANDOM_DELAY
1739
1740 If you have many targets in a network that try to
1741 boot using BOOTP, you may want to avoid that all
1742 systems send out BOOTP requests at precisely the same
1743 moment (which would happen for instance at recovery
1744 from a power failure, when all systems will try to
1745 boot, thus flooding the BOOTP server. Defining
1746 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1747 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02001748 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001749
1750 1st BOOTP request: delay 0 ... 1 sec
1751 2nd BOOTP request: delay 0 ... 2 sec
1752 3rd BOOTP request: delay 0 ... 4 sec
1753 4th and following
1754 BOOTP requests: delay 0 ... 8 sec
1755
Thierry Reding92ac8ac2014-08-19 10:21:24 +02001756 CONFIG_BOOTP_ID_CACHE_SIZE
1757
1758 BOOTP packets are uniquely identified using a 32-bit ID. The
1759 server will copy the ID from client requests to responses and
1760 U-Boot will use this to determine if it is the destination of
1761 an incoming response. Some servers will check that addresses
1762 aren't in use before handing them out (usually using an ARP
1763 ping) and therefore take up to a few hundred milliseconds to
1764 respond. Network congestion may also influence the time it
1765 takes for a response to make it back to the client. If that
1766 time is too long, U-Boot will retransmit requests. In order
1767 to allow earlier responses to still be accepted after these
1768 retransmissions, U-Boot's BOOTP client keeps a small cache of
1769 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
1770 cache. The default is to keep IDs for up to four outstanding
1771 requests. Increasing this will allow U-Boot to accept offers
1772 from a BOOTP client in networks with unusually high latency.
1773
stroesefe389a82003-08-28 14:17:32 +00001774- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001775 You can fine tune the DHCP functionality by defining
1776 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00001777
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001778 CONFIG_BOOTP_SUBNETMASK
1779 CONFIG_BOOTP_GATEWAY
1780 CONFIG_BOOTP_HOSTNAME
1781 CONFIG_BOOTP_NISDOMAIN
1782 CONFIG_BOOTP_BOOTPATH
1783 CONFIG_BOOTP_BOOTFILESIZE
1784 CONFIG_BOOTP_DNS
1785 CONFIG_BOOTP_DNS2
1786 CONFIG_BOOTP_SEND_HOSTNAME
1787 CONFIG_BOOTP_NTPSERVER
1788 CONFIG_BOOTP_TIMEOFFSET
1789 CONFIG_BOOTP_VENDOREX
Joe Hershberger2c00e092012-05-23 07:59:19 +00001790 CONFIG_BOOTP_MAY_FAIL
stroesefe389a82003-08-28 14:17:32 +00001791
Wilson Callan5d110f02007-07-28 10:56:13 -04001792 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1793 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00001794
Joe Hershberger2c00e092012-05-23 07:59:19 +00001795 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1796 after the configured retry count, the call will fail
1797 instead of starting over. This can be used to fail over
1798 to Link-local IP address configuration if the DHCP server
1799 is not available.
1800
stroesefe389a82003-08-28 14:17:32 +00001801 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1802 serverip from a DHCP server, it is possible that more
1803 than one DNS serverip is offered to the client.
1804 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1805 serverip will be stored in the additional environment
1806 variable "dnsip2". The first DNS serverip is always
1807 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001808 is defined.
stroesefe389a82003-08-28 14:17:32 +00001809
1810 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1811 to do a dynamic update of a DNS server. To do this, they
1812 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04001813 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001814 of the "hostname" environment variable is passed as
1815 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00001816
Aras Vaichasd9a2f412008-03-26 09:43:57 +11001817 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1818
1819 A 32bit value in microseconds for a delay between
1820 receiving a "DHCP Offer" and sending the "DHCP Request".
1821 This fixes a problem with certain DHCP servers that don't
1822 respond 100% of the time to a "DHCP request". E.g. On an
1823 AT91RM9200 processor running at 180MHz, this delay needed
1824 to be *at least* 15,000 usec before a Windows Server 2003
1825 DHCP server would reply 100% of the time. I recommend at
1826 least 50,000 usec to be safe. The alternative is to hope
1827 that one of the retries will be successful but note that
1828 the DHCP timeout and retry process takes a longer than
1829 this delay.
1830
Joe Hershbergerd22c3382012-05-23 08:00:12 +00001831 - Link-local IP address negotiation:
1832 Negotiate with other link-local clients on the local network
1833 for an address that doesn't require explicit configuration.
1834 This is especially useful if a DHCP server cannot be guaranteed
1835 to exist in all environments that the device must operate.
1836
1837 See doc/README.link-local for more information.
1838
wdenka3d991b2004-04-15 21:48:45 +00001839 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00001840 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00001841
1842 The device id used in CDP trigger frames.
1843
1844 CONFIG_CDP_DEVICE_ID_PREFIX
1845
1846 A two character string which is prefixed to the MAC address
1847 of the device.
1848
1849 CONFIG_CDP_PORT_ID
1850
1851 A printf format string which contains the ascii name of
1852 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001853 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00001854
1855 CONFIG_CDP_CAPABILITIES
1856
1857 A 32bit integer which indicates the device capabilities;
1858 0x00000010 for a normal host which does not forwards.
1859
1860 CONFIG_CDP_VERSION
1861
1862 An ascii string containing the version of the software.
1863
1864 CONFIG_CDP_PLATFORM
1865
1866 An ascii string containing the name of the platform.
1867
1868 CONFIG_CDP_TRIGGER
1869
1870 A 32bit integer sent on the trigger.
1871
1872 CONFIG_CDP_POWER_CONSUMPTION
1873
1874 A 16bit integer containing the power consumption of the
1875 device in .1 of milliwatts.
1876
1877 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1878
1879 A byte containing the id of the VLAN.
1880
Uri Mashiach79267ed2017-01-19 10:51:05 +02001881- Status LED: CONFIG_LED_STATUS
wdenkc6097192002-11-03 00:24:07 +00001882
1883 Several configurations allow to display the current
1884 status using a LED. For instance, the LED will blink
1885 fast while running U-Boot code, stop blinking as
1886 soon as a reply to a BOOTP request was received, and
1887 start blinking slow once the Linux kernel is running
1888 (supported by a status LED driver in the Linux
Uri Mashiach79267ed2017-01-19 10:51:05 +02001889 kernel). Defining CONFIG_LED_STATUS enables this
wdenkc6097192002-11-03 00:24:07 +00001890 feature in U-Boot.
1891
Igor Grinberg1df7bbb2013-11-08 01:03:50 +02001892 Additional options:
1893
Uri Mashiach79267ed2017-01-19 10:51:05 +02001894 CONFIG_LED_STATUS_GPIO
Igor Grinberg1df7bbb2013-11-08 01:03:50 +02001895 The status LED can be connected to a GPIO pin.
1896 In such cases, the gpio_led driver can be used as a
Uri Mashiach79267ed2017-01-19 10:51:05 +02001897 status LED backend implementation. Define CONFIG_LED_STATUS_GPIO
Igor Grinberg1df7bbb2013-11-08 01:03:50 +02001898 to include the gpio_led driver in the U-Boot binary.
1899
Igor Grinberg9dfdcdf2013-11-08 01:03:52 +02001900 CONFIG_GPIO_LED_INVERTED_TABLE
1901 Some GPIO connected LEDs may have inverted polarity in which
1902 case the GPIO high value corresponds to LED off state and
1903 GPIO low value corresponds to LED on state.
1904 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
1905 with a list of GPIO LEDs that have inverted polarity.
1906
wdenkc6097192002-11-03 00:24:07 +00001907- CAN Support: CONFIG_CAN_DRIVER
1908
1909 Defining CONFIG_CAN_DRIVER enables CAN driver support
1910 on those systems that support this (optional)
Heiko Schocher5b8e76c2017-06-07 17:33:09 +02001911 feature.
wdenkc6097192002-11-03 00:24:07 +00001912
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001913- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00001914
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001915 This enable the NEW i2c subsystem, and will allow you to use
1916 i2c commands at the u-boot command line (as long as you set
1917 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
1918 based realtime clock chips or other i2c devices. See
1919 common/cmd_i2c.c for a description of the command line
1920 interface.
1921
1922 ported i2c driver to the new framework:
Heiko Schocherea818db2013-01-29 08:53:15 +01001923 - drivers/i2c/soft_i2c.c:
1924 - activate first bus with CONFIG_SYS_I2C_SOFT define
1925 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
1926 for defining speed and slave address
1927 - activate second bus with I2C_SOFT_DECLARATIONS2 define
1928 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
1929 for defining speed and slave address
1930 - activate third bus with I2C_SOFT_DECLARATIONS3 define
1931 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
1932 for defining speed and slave address
1933 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
1934 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
1935 for defining speed and slave address
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001936
Heiko Schocher00f792e2012-10-24 13:48:22 +02001937 - drivers/i2c/fsl_i2c.c:
1938 - activate i2c driver with CONFIG_SYS_I2C_FSL
1939 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
1940 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
1941 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
1942 bus.
Wolfgang Denk93e14592013-10-04 17:43:24 +02001943 - If your board supports a second fsl i2c bus, define
Heiko Schocher00f792e2012-10-24 13:48:22 +02001944 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
1945 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
1946 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
1947 second bus.
1948
Simon Glass1f2ba722012-10-30 07:28:53 +00001949 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu10cee512013-10-11 16:23:53 +09001950 - activate this driver with CONFIG_SYS_I2C_TEGRA
1951 - This driver adds 4 i2c buses with a fix speed from
1952 100000 and the slave addr 0!
Simon Glass1f2ba722012-10-30 07:28:53 +00001953
Dirk Eibach880540d2013-04-25 02:40:01 +00001954 - drivers/i2c/ppc4xx_i2c.c
1955 - activate this driver with CONFIG_SYS_I2C_PPC4XX
1956 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
1957 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
1958
tremfac96402013-09-21 18:13:35 +02001959 - drivers/i2c/i2c_mxc.c
1960 - activate this driver with CONFIG_SYS_I2C_MXC
Albert ARIBAUD \\(3ADEV\\)03544c62015-09-21 22:43:38 +02001961 - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
1962 - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
1963 - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
1964 - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
tremfac96402013-09-21 18:13:35 +02001965 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
1966 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
1967 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
1968 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
1969 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
1970 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
Albert ARIBAUD \\(3ADEV\\)03544c62015-09-21 22:43:38 +02001971 - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
1972 - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001973 If those defines are not set, default value is 100000
tremfac96402013-09-21 18:13:35 +02001974 for speed, and 0 for slave.
1975
Nobuhiro Iwamatsu1086bfa2013-09-27 16:58:30 +09001976 - drivers/i2c/rcar_i2c.c:
1977 - activate this driver with CONFIG_SYS_I2C_RCAR
1978 - This driver adds 4 i2c buses
1979
1980 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
1981 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
1982 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
1983 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
1984 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
1985 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
1986 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
1987 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
1988 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
1989
Nobuhiro Iwamatsu2035d772013-10-29 13:33:51 +09001990 - drivers/i2c/sh_i2c.c:
1991 - activate this driver with CONFIG_SYS_I2C_SH
1992 - This driver adds from 2 to 5 i2c buses
1993
1994 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
1995 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
1996 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
1997 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
1998 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
1999 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2000 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2001 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2002 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2003 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002004 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
Nobuhiro Iwamatsu2035d772013-10-29 13:33:51 +09002005
Heiko Schocher6789e842013-10-22 11:03:18 +02002006 - drivers/i2c/omap24xx_i2c.c
2007 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2008 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2009 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2010 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2011 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2012 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2013 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2014 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2015 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2016 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2017 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2018
Heiko Schocher0bdffe72013-11-08 07:30:53 +01002019 - drivers/i2c/zynq_i2c.c
2020 - activate this driver with CONFIG_SYS_I2C_ZYNQ
2021 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2022 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2023
Naveen Krishna Che717fc62013-12-06 12:12:38 +05302024 - drivers/i2c/s3c24x0_i2c.c:
2025 - activate this driver with CONFIG_SYS_I2C_S3C24X0
2026 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2027 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2028 with a fix speed from 100000 and the slave addr 0!
2029
Dirk Eibachb46226b2014-07-03 09:28:18 +02002030 - drivers/i2c/ihs_i2c.c
2031 - activate this driver with CONFIG_SYS_I2C_IHS
2032 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2033 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2034 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2035 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2036 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2037 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2038 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2039 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2040 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2041 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2042 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2043 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
Dirk Eibach071be892015-10-28 11:46:22 +01002044 - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
2045 - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
2046 - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
2047 - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
2048 - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
2049 - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
2050 - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
2051 - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
2052 - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
Dirk Eibachb46226b2014-07-03 09:28:18 +02002053
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002054 additional defines:
2055
2056 CONFIG_SYS_NUM_I2C_BUSES
Simon Glass945a18e2016-10-02 18:01:05 -06002057 Hold the number of i2c buses you want to use.
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002058
2059 CONFIG_SYS_I2C_DIRECT_BUS
2060 define this, if you don't use i2c muxes on your hardware.
2061 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2062 omit this define.
2063
2064 CONFIG_SYS_I2C_MAX_HOPS
2065 define how many muxes are maximal consecutively connected
2066 on one i2c bus. If you not use i2c muxes, omit this
2067 define.
2068
2069 CONFIG_SYS_I2C_BUSES
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002070 hold a list of buses you want to use, only used if
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002071 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2072 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2073 CONFIG_SYS_NUM_I2C_BUSES = 9:
2074
2075 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2076 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2077 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2078 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2079 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2080 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2081 {1, {I2C_NULL_HOP}}, \
2082 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2083 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2084 }
2085
2086 which defines
2087 bus 0 on adapter 0 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002088 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2089 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2090 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2091 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2092 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002093 bus 6 on adapter 1 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002094 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2095 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002096
2097 If you do not have i2c muxes on your board, omit this define.
2098
Simon Glassce3b5d62017-05-12 21:10:00 -06002099- Legacy I2C Support:
Heiko Schocherea818db2013-01-29 08:53:15 +01002100 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb37c7e52003-06-30 16:24:52 +00002101 then the following macros need to be defined (examples are
2102 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002103
2104 I2C_INIT
2105
wdenkb37c7e52003-06-30 16:24:52 +00002106 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00002107 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002108
wdenkba56f622004-02-06 23:19:44 +00002109 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00002110
wdenkc6097192002-11-03 00:24:07 +00002111 I2C_PORT
2112
wdenk43d96162003-03-06 00:02:04 +00002113 (Only for MPC8260 CPU). The I/O port to use (the code
2114 assumes both bits are on the same port). Valid values
2115 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00002116
2117 I2C_ACTIVE
2118
2119 The code necessary to make the I2C data line active
2120 (driven). If the data line is open collector, this
2121 define can be null.
2122
wdenkb37c7e52003-06-30 16:24:52 +00002123 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2124
wdenkc6097192002-11-03 00:24:07 +00002125 I2C_TRISTATE
2126
2127 The code necessary to make the I2C data line tri-stated
2128 (inactive). If the data line is open collector, this
2129 define can be null.
2130
wdenkb37c7e52003-06-30 16:24:52 +00002131 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2132
wdenkc6097192002-11-03 00:24:07 +00002133 I2C_READ
2134
York Sun472d5462013-04-01 11:29:11 -07002135 Code that returns true if the I2C data line is high,
2136 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002137
wdenkb37c7e52003-06-30 16:24:52 +00002138 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2139
wdenkc6097192002-11-03 00:24:07 +00002140 I2C_SDA(bit)
2141
York Sun472d5462013-04-01 11:29:11 -07002142 If <bit> is true, sets the I2C data line high. If it
2143 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002144
wdenkb37c7e52003-06-30 16:24:52 +00002145 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00002146 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00002147 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00002148
wdenkc6097192002-11-03 00:24:07 +00002149 I2C_SCL(bit)
2150
York Sun472d5462013-04-01 11:29:11 -07002151 If <bit> is true, sets the I2C clock line high. If it
2152 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002153
wdenkb37c7e52003-06-30 16:24:52 +00002154 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00002155 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00002156 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00002157
wdenkc6097192002-11-03 00:24:07 +00002158 I2C_DELAY
2159
2160 This delay is invoked four times per clock cycle so this
2161 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00002162 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00002163 like:
2164
wdenkb37c7e52003-06-30 16:24:52 +00002165 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002166
Mike Frysinger793b5722010-07-21 13:38:02 -04002167 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2168
2169 If your arch supports the generic GPIO framework (asm/gpio.h),
2170 then you may alternatively define the two GPIOs that are to be
2171 used as SCL / SDA. Any of the previous I2C_xxx macros will
2172 have GPIO-based defaults assigned to them as appropriate.
2173
2174 You should define these to the GPIO value as given directly to
2175 the generic GPIO functions.
2176
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002177 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00002178
wdenk8bde7f72003-06-27 21:31:46 +00002179 When a board is reset during an i2c bus transfer
2180 chips might think that the current transfer is still
2181 in progress. On some boards it is possible to access
2182 the i2c SCLK line directly, either by using the
2183 processor pin as a GPIO or by having a second pin
2184 connected to the bus. If this option is defined a
2185 custom i2c_init_board() routine in boards/xxx/board.c
2186 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00002187
Ben Warrenbb99ad62006-09-07 16:50:54 -04002188 CONFIG_I2C_MULTI_BUS
2189
2190 This option allows the use of multiple I2C buses, each of which
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002191 must have a controller. At any point in time, only one bus is
2192 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warrenbb99ad62006-09-07 16:50:54 -04002193 Note that bus numbering is zero-based.
2194
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002195 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04002196
2197 This option specifies a list of I2C devices that will be skipped
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002198 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser0f89c542009-04-18 22:34:03 -05002199 is set, specify a list of bus-device pairs. Otherwise, specify
2200 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04002201
2202 e.g.
2203 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002204 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002205
2206 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2207
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002208 #define CONFIG_I2C_MULTI_BUS
Simon Glass945a18e2016-10-02 18:01:05 -06002209 #define CONFIG_SYS_I2C_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002210
2211 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2212
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002213 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06002214
2215 If defined, then this indicates the I2C bus number for DDR SPD.
2216 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2217
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002218 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002219
2220 If defined, then this indicates the I2C bus number for the RTC.
2221 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2222
Andrew Dyer2ac69852008-12-29 17:36:01 -06002223 CONFIG_SOFT_I2C_READ_REPEATED_START
2224
2225 defining this will force the i2c_read() function in
2226 the soft_i2c driver to perform an I2C repeated start
2227 between writing the address pointer and reading the
2228 data. If this define is omitted the default behaviour
2229 of doing a stop-start sequence will be used. Most I2C
2230 devices can use either method, but some require one or
2231 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06002232
wdenkc6097192002-11-03 00:24:07 +00002233- SPI Support: CONFIG_SPI
2234
2235 Enables SPI driver (so far only tested with
2236 SPI EEPROM, also an instance works with Crystal A/D and
2237 D/As on the SACSng board)
2238
Yoshihiro Shimoda66395622011-01-31 16:50:43 +09002239 CONFIG_SH_SPI
2240
2241 Enables the driver for SPI controller on SuperH. Currently
2242 only SH7757 is supported.
2243
wdenkc6097192002-11-03 00:24:07 +00002244 CONFIG_SOFT_SPI
2245
wdenk43d96162003-03-06 00:02:04 +00002246 Enables a software (bit-bang) SPI driver rather than
2247 using hardware support. This is a general purpose
2248 driver that only requires three general I/O port pins
2249 (two outputs, one input) to function. If this is
2250 defined, the board configuration must define several
2251 SPI configuration items (port pins to use, etc). For
2252 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002253
Ben Warren04a9e112008-01-16 22:37:35 -05002254 CONFIG_HARD_SPI
2255
2256 Enables a hardware SPI driver for general-purpose reads
2257 and writes. As with CONFIG_SOFT_SPI, the board configuration
2258 must define a list of chip-select function pointers.
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002259 Currently supported on some MPC8xxx processors. For an
Ben Warren04a9e112008-01-16 22:37:35 -05002260 example, see include/configs/mpc8349emds.h.
2261
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002262 CONFIG_MXC_SPI
2263
2264 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevam2e3cd1c2011-10-28 08:57:46 +00002265 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002266
Heiko Schocherf659b572014-07-14 10:22:11 +02002267 CONFIG_SYS_SPI_MXC_WAIT
2268 Timeout for waiting until spi transfer completed.
2269 default: (CONFIG_SYS_HZ/100) /* 10 ms */
2270
Matthias Fuchs01335022007-12-27 17:12:34 +01002271- FPGA Support: CONFIG_FPGA
2272
2273 Enables FPGA subsystem.
2274
2275 CONFIG_FPGA_<vendor>
2276
2277 Enables support for specific chip vendors.
2278 (ALTERA, XILINX)
2279
2280 CONFIG_FPGA_<family>
2281
2282 Enables support for FPGA family.
2283 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2284
2285 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00002286
wdenk43d96162003-03-06 00:02:04 +00002287 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002288
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002289 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002290
wdenk8bde7f72003-06-27 21:31:46 +00002291 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002292
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002293 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002294
wdenk43d96162003-03-06 00:02:04 +00002295 Enable checks on FPGA configuration interface busy
2296 status by the configuration function. This option
2297 will require a board or device specific function to
2298 be written.
wdenkc6097192002-11-03 00:24:07 +00002299
2300 CONFIG_FPGA_DELAY
2301
2302 If defined, a function that provides delays in the FPGA
2303 configuration driver.
2304
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002305 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002306 Allow Control-C to interrupt FPGA configuration
2307
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002308 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002309
wdenk43d96162003-03-06 00:02:04 +00002310 Check for configuration errors during FPGA bitfile
2311 loading. For example, abort during Virtex II
2312 configuration if the INIT_B line goes low (which
2313 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002314
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002315 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002316
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002317 Maximum time to wait for the INIT_B line to de-assert
2318 after PROB_B has been de-asserted during a Virtex II
wdenk43d96162003-03-06 00:02:04 +00002319 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002320 ms.
wdenkc6097192002-11-03 00:24:07 +00002321
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002322 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002323
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002324 Maximum time to wait for BUSY to de-assert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002325 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002326
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002327 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002328
wdenk43d96162003-03-06 00:02:04 +00002329 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002330 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002331
2332- Configuration Management:
Stefan Roeseb2b8a692014-10-22 12:13:24 +02002333 CONFIG_BUILD_TARGET
2334
2335 Some SoCs need special image types (e.g. U-Boot binary
2336 with a special header) as build targets. By defining
2337 CONFIG_BUILD_TARGET in the SoC / board header, this
2338 special image will be automatically built upon calling
Simon Glass6de80f22016-07-27 20:33:08 -06002339 make / buildman.
Stefan Roeseb2b8a692014-10-22 12:13:24 +02002340
wdenkc6097192002-11-03 00:24:07 +00002341 CONFIG_IDENT_STRING
2342
wdenk43d96162003-03-06 00:02:04 +00002343 If defined, this string will be added to the U-Boot
2344 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002345
2346- Vendor Parameter Protection:
2347
wdenk43d96162003-03-06 00:02:04 +00002348 U-Boot considers the values of the environment
2349 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00002350 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00002351 are set once by the board vendor / manufacturer, and
2352 protects these variables from casual modification by
2353 the user. Once set, these variables are read-only,
2354 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002355 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002356
2357 If CONFIG_ENV_OVERWRITE is #defined in your config
2358 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00002359 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002360 these parameters.
2361
Joe Hershberger92ac5202015-05-04 14:55:14 -05002362 Alternatively, if you define _both_ an ethaddr in the
2363 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002364 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002365 which can be changed exactly ONCE by the user. [The
2366 serial# is unaffected by this, i. e. it remains
2367 read-only.]
2368
Joe Hershberger25980902012-12-11 22:16:31 -06002369 The same can be accomplished in a more flexible way
2370 for any variable by configuring the type of access
2371 to allow for those variables in the ".flags" variable
2372 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2373
wdenkc6097192002-11-03 00:24:07 +00002374- Protected RAM:
2375 CONFIG_PRAM
2376
2377 Define this variable to enable the reservation of
2378 "protected RAM", i. e. RAM which is not overwritten
2379 by U-Boot. Define CONFIG_PRAM to hold the number of
2380 kB you want to reserve for pRAM. You can overwrite
2381 this default value by defining an environment
2382 variable "pram" to the number of kB you want to
2383 reserve. Note that the board info structure will
2384 still show the full amount of RAM. If pRAM is
2385 reserved, a new environment variable "mem" will
2386 automatically be defined to hold the amount of
2387 remaining RAM in a form that can be passed as boot
2388 argument to Linux, for instance like that:
2389
Wolfgang Denkfe126d82005-11-20 21:40:11 +01002390 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002391 saveenv
2392
2393 This way you can tell Linux not to use this memory,
2394 either, which results in a memory region that will
2395 not be affected by reboots.
2396
2397 *WARNING* If your board configuration uses automatic
2398 detection of the RAM size, you must make sure that
2399 this memory test is non-destructive. So far, the
2400 following board configurations are known to be
2401 "pRAM-clean":
2402
Heiko Schocher5b8e76c2017-06-07 17:33:09 +02002403 IVMS8, IVML24, SPD8xx,
Wolfgang Denk1b0757e2012-10-24 02:36:15 +00002404 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denk544d97e2010-10-05 22:54:53 +02002405 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002406
Gabe Black40fef042012-12-02 04:55:18 +00002407- Access to physical memory region (> 4GB)
2408 Some basic support is provided for operations on memory not
2409 normally accessible to U-Boot - e.g. some architectures
2410 support access to more than 4GB of memory on 32-bit
2411 machines using physical address extension or similar.
2412 Define CONFIG_PHYSMEM to access this basic support, which
2413 currently only supports clearing the memory.
2414
wdenkc6097192002-11-03 00:24:07 +00002415- Error Recovery:
2416 CONFIG_PANIC_HANG
2417
2418 Define this variable to stop the system in case of a
2419 fatal error, so that you have to reset it manually.
2420 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002421 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002422 automatically as fast as possible, but it may be
2423 useful during development since you can try to debug
2424 the conditions that lead to the situation.
2425
2426 CONFIG_NET_RETRY_COUNT
2427
wdenk43d96162003-03-06 00:02:04 +00002428 This variable defines the number of retries for
2429 network operations like ARP, RARP, TFTP, or BOOTP
2430 before giving up the operation. If not defined, a
2431 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002432
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02002433 CONFIG_ARP_TIMEOUT
2434
2435 Timeout waiting for an ARP reply in milliseconds.
2436
Tetsuyuki Kobayashi48a3e992012-07-03 22:25:21 +00002437 CONFIG_NFS_TIMEOUT
2438
2439 Timeout in milliseconds used in NFS protocol.
2440 If you encounter "ERROR: Cannot umount" in nfs command,
2441 try longer timeout such as
2442 #define CONFIG_NFS_TIMEOUT 10000UL
2443
wdenkc6097192002-11-03 00:24:07 +00002444- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002445 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00002446
2447 Enable auto completion of commands using TAB.
2448
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002449 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002450
2451 This defines the secondary prompt string, which is
2452 printed when the command interpreter needs more input
2453 to complete a command. Usually "> ".
2454
2455 Note:
2456
wdenk8bde7f72003-06-27 21:31:46 +00002457 In the current implementation, the local variables
2458 space and global environment variables space are
2459 separated. Local variables are those you define by
2460 simply typing `name=value'. To access a local
2461 variable later on, you have write `$name' or
2462 `${name}'; to execute the contents of a variable
2463 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002464
wdenk43d96162003-03-06 00:02:04 +00002465 Global environment variables are those you use
2466 setenv/printenv to work with. To run a command stored
2467 in such a variable, you need to use the run command,
2468 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002469
2470 To store commands and special characters in a
2471 variable, please use double quotation marks
2472 surrounding the whole text of the variable, instead
2473 of the backslashes before semicolons and special
2474 symbols.
2475
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002476- Command Line Editing and History:
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002477 CONFIG_CMDLINE_EDITING
2478
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002479 Enable editing and History functions for interactive
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002480 command line input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002481
Marek Vasutf3b267b2016-01-27 04:47:55 +01002482- Command Line PS1/PS2 support:
2483 CONFIG_CMDLINE_PS_SUPPORT
2484
2485 Enable support for changing the command prompt string
2486 at run-time. Only static string is supported so far.
2487 The string is obtained from environment variables PS1
2488 and PS2.
2489
wdenka8c7c702003-12-06 19:49:23 +00002490- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002491 CONFIG_EXTRA_ENV_SETTINGS
2492
wdenk43d96162003-03-06 00:02:04 +00002493 Define this to contain any number of null terminated
2494 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00002495 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00002496
wdenk43d96162003-03-06 00:02:04 +00002497 For example, place something like this in your
2498 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002499
2500 #define CONFIG_EXTRA_ENV_SETTINGS \
2501 "myvar1=value1\0" \
2502 "myvar2=value2\0"
2503
wdenk43d96162003-03-06 00:02:04 +00002504 Warning: This method is based on knowledge about the
2505 internal format how the environment is stored by the
2506 U-Boot code. This is NOT an official, exported
2507 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00002508 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002509 You better know what you are doing here.
2510
wdenk43d96162003-03-06 00:02:04 +00002511 Note: overly (ab)use of the default environment is
2512 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002513 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00002514 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002515
Stephen Warren5e724ca2012-05-22 09:21:54 +00002516 CONFIG_ENV_VARS_UBOOT_CONFIG
2517
2518 Define this in order to add variables describing the
2519 U-Boot build configuration to the default environment.
2520 These will be named arch, cpu, board, vendor, and soc.
2521
2522 Enabling this option will cause the following to be defined:
2523
2524 - CONFIG_SYS_ARCH
2525 - CONFIG_SYS_CPU
2526 - CONFIG_SYS_BOARD
2527 - CONFIG_SYS_VENDOR
2528 - CONFIG_SYS_SOC
2529
Tom Rini7e27f892012-10-24 07:28:16 +00002530 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2531
2532 Define this in order to add variables describing certain
2533 run-time determined information about the hardware to the
2534 environment. These will be named board_name, board_rev.
2535
Simon Glass06fd8532012-11-30 13:01:17 +00002536 CONFIG_DELAY_ENVIRONMENT
2537
2538 Normally the environment is loaded when the board is
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002539 initialised so that it is available to U-Boot. This inhibits
Simon Glass06fd8532012-11-30 13:01:17 +00002540 that so that the environment is not available until
2541 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2542 this is instead controlled by the value of
2543 /config/load-environment.
2544
wdenka8c7c702003-12-06 19:49:23 +00002545- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00002546 CONFIG_HAS_DATAFLASH
2547
wdenk8bde7f72003-06-27 21:31:46 +00002548 Defining this option enables DataFlash features and
2549 allows to read/write in Dataflash via the standard
2550 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00002551
Eric Nelsonf61ec452012-01-31 10:52:08 -07002552- Serial Flash support
2553 CONFIG_CMD_SF
2554
2555 Defining this option enables SPI flash commands
2556 'sf probe/read/write/erase/update'.
2557
2558 Usage requires an initial 'probe' to define the serial
2559 flash parameters, followed by read/write/erase/update
2560 commands.
2561
2562 The following defaults may be provided by the platform
2563 to handle the common case when only a single serial
2564 flash is present on the system.
2565
2566 CONFIG_SF_DEFAULT_BUS Bus identifier
2567 CONFIG_SF_DEFAULT_CS Chip-select
2568 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2569 CONFIG_SF_DEFAULT_SPEED in Hz
2570
Simon Glass24007272012-10-08 13:16:02 +00002571 CONFIG_CMD_SF_TEST
2572
2573 Define this option to include a destructive SPI flash
2574 test ('sf test').
2575
Jagannadha Sutradharudu Tekib902e072014-01-11 15:25:04 +05302576 CONFIG_SF_DUAL_FLASH Dual flash memories
2577
2578 Define this option to use dual flash support where two flash
2579 memories can be connected with a given cs line.
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002580 Currently Xilinx Zynq qspi supports these type of connections.
Jagannadha Sutradharudu Tekib902e072014-01-11 15:25:04 +05302581
wdenk3f85ce22004-02-23 16:11:30 +00002582- SystemACE Support:
2583 CONFIG_SYSTEMACE
2584
2585 Adding this option adds support for Xilinx SystemACE
2586 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002587 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002588 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00002589
2590 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002591 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00002592
2593 When SystemACE support is added, the "ace" device type
2594 becomes available to the fat commands, i.e. fatls.
2595
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002596- TFTP Fixed UDP Port:
2597 CONFIG_TFTP_PORT
2598
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002599 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002600 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002601 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002602 number generator is used.
2603
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002604 Also, the environment variable tftpdstp is used to supply
2605 the TFTP UDP destination port value. If tftpdstp isn't
2606 defined, the normal port 69 is used.
2607
2608 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002609 blindly start the TFTP transfer using the pre-configured
2610 target IP address and UDP port. This has the effect of
2611 "punching through" the (Windows XP) firewall, allowing
2612 the remainder of the TFTP transfer to proceed normally.
2613 A better solution is to properly configure the firewall,
2614 but sometimes that is not allowed.
2615
Heiko Schocher9e50c402014-01-25 07:27:13 +01002616- bootcount support:
2617 CONFIG_BOOTCOUNT_LIMIT
2618
2619 This enables the bootcounter support, see:
2620 http://www.denx.de/wiki/DULG/UBootBootCountLimit
2621
2622 CONFIG_AT91SAM9XE
2623 enable special bootcounter support on at91sam9xe based boards.
Heiko Schocher9e50c402014-01-25 07:27:13 +01002624 CONFIG_SOC_DA8XX
2625 enable special bootcounter support on da850 based boards.
2626 CONFIG_BOOTCOUNT_RAM
2627 enable support for the bootcounter in RAM
2628 CONFIG_BOOTCOUNT_I2C
2629 enable support for the bootcounter on an i2c (like RTC) device.
2630 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
2631 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
2632 the bootcounter.
2633 CONFIG_BOOTCOUNT_ALEN = address len
Simon Glass19c402a2013-06-13 15:10:02 -07002634
wdenka8c7c702003-12-06 19:49:23 +00002635- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002636 CONFIG_SHOW_BOOT_PROGRESS
2637
wdenk43d96162003-03-06 00:02:04 +00002638 Defining this option allows to add some board-
2639 specific code (calling a user-provided function
2640 "show_boot_progress(int)") that enables you to show
2641 the system's boot progress on some display (for
2642 example, some LED's) on your board. At the moment,
2643 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002644
Simon Glass94fd1312012-09-28 08:56:37 +00002645
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002646Legacy uImage format:
2647
wdenkc6097192002-11-03 00:24:07 +00002648 Arg Where When
2649 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00002650 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002651 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00002652 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002653 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00002654 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002655 4 common/cmd_bootm.c Image data has correct checksum
2656 -4 common/cmd_bootm.c Image is for unsupported architecture
2657 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002658 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002659 6 common/cmd_bootm.c Image Type check OK
2660 -6 common/cmd_bootm.c gunzip uncompression error
2661 -7 common/cmd_bootm.c Unimplemented compression type
2662 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002663 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002664 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002665
2666 9 common/image.c Start initial ramdisk verification
2667 -10 common/image.c Ramdisk header has bad magic number
2668 -11 common/image.c Ramdisk header has bad checksum
2669 10 common/image.c Ramdisk header is OK
2670 -12 common/image.c Ramdisk data has bad checksum
2671 11 common/image.c Ramdisk data has correct checksum
2672 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002673 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002674 13 common/image.c Start multifile image verification
2675 14 common/image.c No initial ramdisk, no multifile, continue.
2676
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002677 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002678
Stefan Roesea47a12b2010-04-15 16:07:28 +02002679 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd52004-02-27 00:07:27 +00002680 -31 post/post.c POST test failed, detected by post_output_backlog()
2681 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00002682
Heiko Schocher566a4942007-06-22 19:11:54 +02002683 34 common/cmd_doc.c before loading a Image from a DOC device
2684 -35 common/cmd_doc.c Bad usage of "doc" command
2685 35 common/cmd_doc.c correct usage of "doc" command
2686 -36 common/cmd_doc.c No boot device
2687 36 common/cmd_doc.c correct boot device
2688 -37 common/cmd_doc.c Unknown Chip ID on boot device
2689 37 common/cmd_doc.c correct chip ID found, device available
2690 -38 common/cmd_doc.c Read Error on boot device
2691 38 common/cmd_doc.c reading Image header from DOC device OK
2692 -39 common/cmd_doc.c Image header has bad magic number
2693 39 common/cmd_doc.c Image header has correct magic number
2694 -40 common/cmd_doc.c Error reading Image from DOC device
2695 40 common/cmd_doc.c Image header has correct magic number
2696 41 common/cmd_ide.c before loading a Image from a IDE device
2697 -42 common/cmd_ide.c Bad usage of "ide" command
2698 42 common/cmd_ide.c correct usage of "ide" command
2699 -43 common/cmd_ide.c No boot device
2700 43 common/cmd_ide.c boot device found
2701 -44 common/cmd_ide.c Device not available
2702 44 common/cmd_ide.c Device available
2703 -45 common/cmd_ide.c wrong partition selected
2704 45 common/cmd_ide.c partition selected
2705 -46 common/cmd_ide.c Unknown partition table
2706 46 common/cmd_ide.c valid partition table found
2707 -47 common/cmd_ide.c Invalid partition type
2708 47 common/cmd_ide.c correct partition type
2709 -48 common/cmd_ide.c Error reading Image Header on boot device
2710 48 common/cmd_ide.c reading Image Header from IDE device OK
2711 -49 common/cmd_ide.c Image header has bad magic number
2712 49 common/cmd_ide.c Image header has correct magic number
2713 -50 common/cmd_ide.c Image header has bad checksum
2714 50 common/cmd_ide.c Image header has correct checksum
2715 -51 common/cmd_ide.c Error reading Image from IDE device
2716 51 common/cmd_ide.c reading Image from IDE device OK
2717 52 common/cmd_nand.c before loading a Image from a NAND device
2718 -53 common/cmd_nand.c Bad usage of "nand" command
2719 53 common/cmd_nand.c correct usage of "nand" command
2720 -54 common/cmd_nand.c No boot device
2721 54 common/cmd_nand.c boot device found
2722 -55 common/cmd_nand.c Unknown Chip ID on boot device
2723 55 common/cmd_nand.c correct chip ID found, device available
2724 -56 common/cmd_nand.c Error reading Image Header on boot device
2725 56 common/cmd_nand.c reading Image Header from NAND device OK
2726 -57 common/cmd_nand.c Image header has bad magic number
2727 57 common/cmd_nand.c Image header has correct magic number
2728 -58 common/cmd_nand.c Error reading Image from NAND device
2729 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002730
Heiko Schocher566a4942007-06-22 19:11:54 +02002731 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002732
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002733 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02002734 -64 net/eth.c no Ethernet found.
2735 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00002736
Heiko Schocher566a4942007-06-22 19:11:54 +02002737 -80 common/cmd_net.c usage wrong
Joe Hershbergerbc0571f2015-04-08 01:41:21 -05002738 80 common/cmd_net.c before calling net_loop()
2739 -81 common/cmd_net.c some error in net_loop() occurred
2740 81 common/cmd_net.c net_loop() back without error
Heiko Schocher566a4942007-06-22 19:11:54 +02002741 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2742 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002743 83 common/cmd_net.c running "source" command
2744 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02002745 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002746
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002747FIT uImage format:
2748
2749 Arg Where When
2750 100 common/cmd_bootm.c Kernel FIT Image has correct format
2751 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2752 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2753 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2754 102 common/cmd_bootm.c Kernel unit name specified
2755 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01002756 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002757 104 common/cmd_bootm.c Got kernel subimage node offset
2758 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2759 105 common/cmd_bootm.c Kernel subimage hash verification OK
2760 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2761 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002762 -106 common/cmd_bootm.c Kernel subimage has wrong type
2763 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002764 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2765 108 common/cmd_bootm.c Got kernel subimage data/size
2766 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2767 -109 common/cmd_bootm.c Can't get kernel subimage type
2768 -110 common/cmd_bootm.c Can't get kernel subimage comp
2769 -111 common/cmd_bootm.c Can't get kernel subimage os
2770 -112 common/cmd_bootm.c Can't get kernel subimage load address
2771 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2772
2773 120 common/image.c Start initial ramdisk verification
2774 -120 common/image.c Ramdisk FIT image has incorrect format
2775 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002776 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002777 -122 common/image.c Can't get configuration for ramdisk subimage
2778 123 common/image.c Ramdisk unit name specified
2779 -124 common/image.c Can't get ramdisk subimage node offset
2780 125 common/image.c Got ramdisk subimage node offset
2781 -125 common/image.c Ramdisk subimage hash verification failed
2782 126 common/image.c Ramdisk subimage hash verification OK
2783 -126 common/image.c Ramdisk subimage for unsupported architecture
2784 127 common/image.c Architecture check OK
2785 -127 common/image.c Can't get ramdisk subimage data/size
2786 128 common/image.c Got ramdisk subimage data/size
2787 129 common/image.c Can't get ramdisk load address
2788 -129 common/image.c Got ramdisk load address
2789
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002790 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002791 131 common/cmd_doc.c FIT image format OK
2792
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002793 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002794 141 common/cmd_ide.c FIT image format OK
2795
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002796 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002797 151 common/cmd_nand.c FIT image format OK
2798
Heiko Schocher21d29f72014-05-28 11:33:33 +02002799- legacy image format:
2800 CONFIG_IMAGE_FORMAT_LEGACY
2801 enables the legacy image format support in U-Boot.
2802
2803 Default:
2804 enabled if CONFIG_FIT_SIGNATURE is not defined.
2805
2806 CONFIG_DISABLE_IMAGE_LEGACY
2807 disable the legacy image format
2808
2809 This define is introduced, as the legacy image format is
2810 enabled per default for backward compatibility.
2811
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002812- Standalone program support:
2813 CONFIG_STANDALONE_LOAD_ADDR
2814
Wolfgang Denk6feff892011-10-09 21:06:34 +02002815 This option defines a board specific value for the
2816 address where standalone program gets loaded, thus
2817 overwriting the architecture dependent default
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002818 settings.
2819
2820- Frame Buffer Address:
2821 CONFIG_FB_ADDR
2822
2823 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denk44a53b52013-01-03 00:43:59 +00002824 address for frame buffer. This is typically the case
2825 when using a graphics controller has separate video
2826 memory. U-Boot will then place the frame buffer at
2827 the given address instead of dynamically reserving it
2828 in system RAM by calling lcd_setmem(), which grabs
2829 the memory for the frame buffer depending on the
2830 configured panel size.
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002831
2832 Please see board_init_f function.
2833
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01002834- Automatic software updates via TFTP server
2835 CONFIG_UPDATE_TFTP
2836 CONFIG_UPDATE_TFTP_CNT_MAX
2837 CONFIG_UPDATE_TFTP_MSEC_MAX
2838
2839 These options enable and control the auto-update feature;
2840 for a more detailed description refer to doc/README.update.
2841
2842- MTD Support (mtdparts command, UBI support)
2843 CONFIG_MTD_DEVICE
2844
2845 Adds the MTD device infrastructure from the Linux kernel.
2846 Needed for mtdparts command support.
2847
2848 CONFIG_MTD_PARTITIONS
2849
2850 Adds the MTD partitioning infrastructure from the Linux
2851 kernel. Needed for UBI support.
2852
Joe Hershberger70c219c2013-04-08 10:32:48 +00002853- UBI support
2854 CONFIG_CMD_UBI
2855
2856 Adds commands for interacting with MTD partitions formatted
2857 with the UBI flash translation layer
2858
2859 Requires also defining CONFIG_RBTREE
2860
Joe Hershberger147162d2013-04-08 10:32:49 +00002861 CONFIG_UBI_SILENCE_MSG
2862
2863 Make the verbose messages from UBI stop printing. This leaves
2864 warnings and errors enabled.
2865
Heiko Schocherff94bc42014-06-24 10:10:04 +02002866
2867 CONFIG_MTD_UBI_WL_THRESHOLD
2868 This parameter defines the maximum difference between the highest
2869 erase counter value and the lowest erase counter value of eraseblocks
2870 of UBI devices. When this threshold is exceeded, UBI starts performing
2871 wear leveling by means of moving data from eraseblock with low erase
2872 counter to eraseblocks with high erase counter.
2873
2874 The default value should be OK for SLC NAND flashes, NOR flashes and
2875 other flashes which have eraseblock life-cycle 100000 or more.
2876 However, in case of MLC NAND flashes which typically have eraseblock
2877 life-cycle less than 10000, the threshold should be lessened (e.g.,
2878 to 128 or 256, although it does not have to be power of 2).
2879
2880 default: 4096
Simon Glassc654b512014-10-23 18:58:54 -06002881
Heiko Schocherff94bc42014-06-24 10:10:04 +02002882 CONFIG_MTD_UBI_BEB_LIMIT
2883 This option specifies the maximum bad physical eraseblocks UBI
2884 expects on the MTD device (per 1024 eraseblocks). If the
2885 underlying flash does not admit of bad eraseblocks (e.g. NOR
2886 flash), this value is ignored.
2887
2888 NAND datasheets often specify the minimum and maximum NVM
2889 (Number of Valid Blocks) for the flashes' endurance lifetime.
2890 The maximum expected bad eraseblocks per 1024 eraseblocks
2891 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
2892 which gives 20 for most NANDs (MaxNVB is basically the total
2893 count of eraseblocks on the chip).
2894
2895 To put it differently, if this value is 20, UBI will try to
2896 reserve about 1.9% of physical eraseblocks for bad blocks
2897 handling. And that will be 1.9% of eraseblocks on the entire
2898 NAND chip, not just the MTD partition UBI attaches. This means
2899 that if you have, say, a NAND flash chip admits maximum 40 bad
2900 eraseblocks, and it is split on two MTD partitions of the same
2901 size, UBI will reserve 40 eraseblocks when attaching a
2902 partition.
2903
2904 default: 20
2905
2906 CONFIG_MTD_UBI_FASTMAP
2907 Fastmap is a mechanism which allows attaching an UBI device
2908 in nearly constant time. Instead of scanning the whole MTD device it
2909 only has to locate a checkpoint (called fastmap) on the device.
2910 The on-flash fastmap contains all information needed to attach
2911 the device. Using fastmap makes only sense on large devices where
2912 attaching by scanning takes long. UBI will not automatically install
2913 a fastmap on old images, but you can set the UBI parameter
2914 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
2915 that fastmap-enabled images are still usable with UBI implementations
2916 without fastmap support. On typical flash devices the whole fastmap
2917 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
2918
2919 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
2920 Set this parameter to enable fastmap automatically on images
2921 without a fastmap.
2922 default: 0
2923
Heiko Schocher0195a7b2015-10-22 06:19:21 +02002924 CONFIG_MTD_UBI_FM_DEBUG
2925 Enable UBI fastmap debug
2926 default: 0
2927
Joe Hershberger70c219c2013-04-08 10:32:48 +00002928- UBIFS support
2929 CONFIG_CMD_UBIFS
2930
2931 Adds commands for interacting with UBI volumes formatted as
2932 UBIFS. UBIFS is read-only in u-boot.
2933
2934 Requires UBI support as well as CONFIG_LZO
2935
Joe Hershberger147162d2013-04-08 10:32:49 +00002936 CONFIG_UBIFS_SILENCE_MSG
2937
2938 Make the verbose messages from UBIFS stop printing. This leaves
2939 warnings and errors enabled.
2940
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002941- SPL framework
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002942 CONFIG_SPL
2943 Enable building of SPL globally.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002944
Tom Rini95579792012-02-14 07:29:40 +00002945 CONFIG_SPL_LDSCRIPT
2946 LDSCRIPT for linking the SPL binary.
2947
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002948 CONFIG_SPL_MAX_FOOTPRINT
2949 Maximum size in memory allocated to the SPL, BSS included.
2950 When defined, the linker checks that the actual memory
2951 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00002952 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002953 must not be both defined at the same time.
2954
Tom Rini95579792012-02-14 07:29:40 +00002955 CONFIG_SPL_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002956 Maximum size of the SPL image (text, data, rodata, and
2957 linker lists sections), BSS excluded.
2958 When defined, the linker checks that the actual size does
2959 not exceed it.
Tom Rini95579792012-02-14 07:29:40 +00002960
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002961 CONFIG_SPL_TEXT_BASE
2962 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002963
Scott Wood94a45bb2012-09-20 19:05:12 -05002964 CONFIG_SPL_RELOC_TEXT_BASE
2965 Address to relocate to. If unspecified, this is equal to
2966 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
2967
Tom Rini95579792012-02-14 07:29:40 +00002968 CONFIG_SPL_BSS_START_ADDR
2969 Link address for the BSS within the SPL binary.
2970
2971 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002972 Maximum size in memory allocated to the SPL BSS.
2973 When defined, the linker checks that the actual memory used
2974 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00002975 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002976 must not be both defined at the same time.
Tom Rini95579792012-02-14 07:29:40 +00002977
2978 CONFIG_SPL_STACK
2979 Adress of the start of the stack SPL will use
2980
Albert ARIBAUD \(3ADEV\)8c80eb32015-03-31 11:40:50 +02002981 CONFIG_SPL_PANIC_ON_RAW_IMAGE
2982 When defined, SPL will panic() if the image it has
2983 loaded does not have a signature.
2984 Defining this is useful when code which loads images
2985 in SPL cannot guarantee that absolutely all read errors
2986 will be caught.
2987 An example is the LPC32XX MLC NAND driver, which will
2988 consider that a completely unreadable NAND block is bad,
2989 and thus should be skipped silently.
2990
Scott Wood94a45bb2012-09-20 19:05:12 -05002991 CONFIG_SPL_RELOC_STACK
2992 Adress of the start of the stack SPL will use after
2993 relocation. If unspecified, this is equal to
2994 CONFIG_SPL_STACK.
2995
Tom Rini95579792012-02-14 07:29:40 +00002996 CONFIG_SYS_SPL_MALLOC_START
2997 Starting address of the malloc pool used in SPL.
Fabio Estevam9ac4fc82015-11-12 12:30:19 -02002998 When this option is set the full malloc is used in SPL and
2999 it is set up by spl_init() and before that, the simple malloc()
3000 can be used if CONFIG_SYS_MALLOC_F is defined.
Tom Rini95579792012-02-14 07:29:40 +00003001
3002 CONFIG_SYS_SPL_MALLOC_SIZE
3003 The size of the malloc pool used in SPL.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003004
Tom Rini47f7bca2012-08-13 12:03:19 -07003005 CONFIG_SPL_FRAMEWORK
3006 Enable the SPL framework under common/. This framework
3007 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3008 NAND loading of the Linux Kernel.
3009
Tom Rini9607faf2014-03-28 12:03:39 -04003010 CONFIG_SPL_OS_BOOT
3011 Enable booting directly to an OS from SPL.
3012 See also: doc/README.falcon
3013
Tom Rini861a86f2012-08-13 11:37:56 -07003014 CONFIG_SPL_DISPLAY_PRINT
3015 For ARM, enable an optional function to print more information
3016 about the running system.
3017
Scott Wood4b919722012-09-20 16:35:21 -05003018 CONFIG_SPL_INIT_MINIMAL
3019 Arch init code should be built for a very small image
3020
Paul Kocialkowskib97300b2014-11-08 23:14:56 +01003021 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
3022 Partition on the MMC to load U-Boot from when the MMC is being
3023 used in raw mode
3024
Peter Korsgaard2b75b0a2013-05-13 08:36:29 +00003025 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3026 Sector to load kernel uImage from when MMC is being
3027 used in raw mode (for Falcon mode)
3028
3029 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3030 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3031 Sector and number of sectors to load kernel argument
3032 parameters from when MMC is being used in raw mode
3033 (for falcon mode)
3034
Paul Kocialkowskie2ccdf82014-11-08 23:14:55 +01003035 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
3036 Partition on the MMC to load U-Boot from when the MMC is being
3037 used in fs mode
3038
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003039 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
3040 Filename to read to load U-Boot when reading from filesystem
3041
3042 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003043 Filename to read to load kernel uImage when reading
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003044 from filesystem (for Falcon mode)
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003045
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003046 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003047 Filename to read to load kernel argument parameters
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003048 when reading from filesystem (for Falcon mode)
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003049
Scott Wood06f60ae2012-12-06 13:33:17 +00003050 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3051 Set this for NAND SPL on PPC mpc83xx targets, so that
3052 start.S waits for the rest of the SPL to load before
3053 continuing (the hardware starts execution after just
3054 loading the first page rather than the full 4K).
3055
Prabhakar Kushwaha651fcf62014-04-08 19:12:31 +05303056 CONFIG_SPL_SKIP_RELOCATE
3057 Avoid SPL relocation
3058
Scott Wood6f2f01b2012-09-20 19:09:07 -05003059 CONFIG_SPL_NAND_BASE
3060 Include nand_base.c in the SPL. Requires
3061 CONFIG_SPL_NAND_DRIVERS.
3062
3063 CONFIG_SPL_NAND_DRIVERS
3064 SPL uses normal NAND drivers, not minimal drivers.
3065
3066 CONFIG_SPL_NAND_ECC
3067 Include standard software ECC in the SPL
3068
Tom Rini95579792012-02-14 07:29:40 +00003069 CONFIG_SPL_NAND_SIMPLE
Scott Wood7d4b7952012-09-21 18:35:27 -05003070 Support for NAND boot using simple NAND drivers that
3071 expose the cmd_ctrl() interface.
Tom Rini95579792012-02-14 07:29:40 +00003072
Thomas Gleixner6f4e7d32016-07-12 20:28:12 +02003073 CONFIG_SPL_UBI
3074 Support for a lightweight UBI (fastmap) scanner and
3075 loader
3076
Heiko Schocher0c3117b2014-10-31 08:31:00 +01003077 CONFIG_SPL_NAND_RAW_ONLY
3078 Support to boot only raw u-boot.bin images. Use this only
3079 if you need to save space.
3080
Ying Zhang7c8eea52013-08-16 15:16:12 +08003081 CONFIG_SPL_COMMON_INIT_DDR
3082 Set for common ddr init with serial presence detect in
3083 SPL binary.
3084
Tom Rini95579792012-02-14 07:29:40 +00003085 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3086 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3087 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3088 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3089 CONFIG_SYS_NAND_ECCBYTES
3090 Defines the size and behavior of the NAND that SPL uses
Scott Wood7d4b7952012-09-21 18:35:27 -05003091 to read U-Boot
Tom Rini95579792012-02-14 07:29:40 +00003092
Prabhakar Kushwahafbe76ae2013-12-11 12:42:11 +05303093 CONFIG_SPL_NAND_BOOT
3094 Add support NAND boot
3095
Tom Rini95579792012-02-14 07:29:40 +00003096 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood7d4b7952012-09-21 18:35:27 -05003097 Location in NAND to read U-Boot from
3098
3099 CONFIG_SYS_NAND_U_BOOT_DST
3100 Location in memory to load U-Boot to
3101
3102 CONFIG_SYS_NAND_U_BOOT_SIZE
3103 Size of image to load
Tom Rini95579792012-02-14 07:29:40 +00003104
3105 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood7d4b7952012-09-21 18:35:27 -05003106 Entry point in loaded image to jump to
Tom Rini95579792012-02-14 07:29:40 +00003107
3108 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3109 Define this if you need to first read the OOB and then the
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003110 data. This is used, for example, on davinci platforms.
Tom Rini95579792012-02-14 07:29:40 +00003111
3112 CONFIG_SPL_OMAP3_ID_NAND
3113 Support for an OMAP3-specific set of functions to return the
3114 ID and MFR of the first attached NAND chip, if present.
3115
Pavel Machekc57b9532012-08-30 22:42:11 +02003116 CONFIG_SPL_RAM_DEVICE
3117 Support for running image already present in ram, in SPL binary
3118
Scott Wood74752ba2012-12-06 13:33:16 +00003119 CONFIG_SPL_PAD_TO
Benoît Thébaudeau6113d3f2013-04-11 09:35:49 +00003120 Image offset to which the SPL should be padded before appending
3121 the SPL payload. By default, this is defined as
3122 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3123 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3124 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Wood74752ba2012-12-06 13:33:16 +00003125
Scott Woodca2fca22012-09-21 16:27:32 -05003126 CONFIG_SPL_TARGET
3127 Final target image containing SPL and payload. Some SPLs
3128 use an arch-specific makefile fragment instead, for
3129 example if more than one image needs to be produced.
3130
Simon Glass87ebee32013-05-08 08:05:59 +00003131 CONFIG_FIT_SPL_PRINT
3132 Printing information about a FIT image adds quite a bit of
3133 code to SPL. So this is normally disabled in SPL. Use this
3134 option to re-enable it. This will affect the output of the
3135 bootm command when booting a FIT image.
3136
Ying Zhang3aa29de2013-08-16 15:16:15 +08003137- TPL framework
3138 CONFIG_TPL
3139 Enable building of TPL globally.
3140
3141 CONFIG_TPL_PAD_TO
3142 Image offset to which the TPL should be padded before appending
3143 the TPL payload. By default, this is defined as
Wolfgang Denk93e14592013-10-04 17:43:24 +02003144 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3145 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3146 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang3aa29de2013-08-16 15:16:15 +08003147
wdenka8c7c702003-12-06 19:49:23 +00003148- Interrupt support (PPC):
3149
wdenkd4ca31c2004-01-02 14:00:00 +00003150 There are common interrupt_init() and timer_interrupt()
3151 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003152 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00003153 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003154 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00003155 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003156 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00003157 specific handling. If board has watchdog / status_led
3158 / other_activity_monitor it works automatically from
3159 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00003160
wdenkc6097192002-11-03 00:24:07 +00003161
Helmut Raiger9660e442011-10-20 04:19:47 +00003162Board initialization settings:
3163------------------------------
3164
3165During Initialization u-boot calls a number of board specific functions
3166to allow the preparation of board specific prerequisites, e.g. pin setup
3167before drivers are initialized. To enable these callbacks the
3168following configuration macros have to be defined. Currently this is
3169architecture specific, so please check arch/your_architecture/lib/board.c
3170typically in board_init_f() and board_init_r().
3171
3172- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3173- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3174- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3175- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003176
wdenkc6097192002-11-03 00:24:07 +00003177Configuration Settings:
3178-----------------------
3179
York Sun4d1fd7f2014-02-26 17:03:19 -08003180- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3181 Optionally it can be defined to support 64-bit memory commands.
3182
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003183- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003184 undefine this when you're short of memory.
3185
Peter Tyser2fb26042009-01-27 18:03:12 -06003186- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3187 width of the commands listed in the 'help' command output.
3188
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003189- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003190 prompt for user input.
3191
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003192- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003193
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003194- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003195
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003196- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003197
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003198- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003199 the application (usually a Linux kernel) when it is
3200 booted
3201
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003202- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003203 List of legal baudrate settings for this board.
3204
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003205- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003206 Begin and End addresses of the area used by the
3207 simple memory test.
3208
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003209- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00003210 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003211
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003212- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00003213 Scratch address used by the alternate memory test
3214 You only need to set this if address zero isn't writeable
3215
York Sune8149522015-12-04 11:57:07 -08003216- CONFIG_SYS_MEM_RESERVE_SECURE
York Sune61a7532016-06-24 16:46:18 -07003217 Only implemented for ARMv8 for now.
York Sune8149522015-12-04 11:57:07 -08003218 If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
3219 is substracted from total RAM and won't be reported to OS.
3220 This memory can be used as secure memory. A variable
York Sune61a7532016-06-24 16:46:18 -07003221 gd->arch.secure_ram is used to track the location. In systems
York Sune8149522015-12-04 11:57:07 -08003222 the RAM base is not zero, or RAM is divided into banks,
3223 this variable needs to be recalcuated to get the address.
3224
York Sunaabd7dd2015-12-07 11:05:29 -08003225- CONFIG_SYS_MEM_TOP_HIDE:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003226 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01003227 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003228 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01003229 fixing up gd->ram_size the Linux kernel should gets passed
3230 the now "corrected" memory size and won't touch it either.
3231 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01003232 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01003233 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01003234 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01003235
3236 This option can be used as a workaround for the 440EPx/GRx
3237 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3238 be touched.
3239
3240 WARNING: Please make sure that this value is a multiple of
3241 the Linux page size (normally 4k). If this is not the case,
3242 then the end address of the Linux memory will be located at a
3243 non page size aligned address and this could cause major
3244 problems.
3245
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003246- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003247 Enable temporary baudrate change while serial download
3248
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003249- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003250 Physical start address of SDRAM. _Must_ be 0 here.
3251
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003252- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003253 Physical start address of Flash memory.
3254
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003255- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003256 Physical start address of boot monitor code (set by
3257 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02003258 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003259 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003260
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003261- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00003262 Size of memory reserved for monitor code, used to
3263 determine _at_compile_time_ (!) if the environment is
3264 embedded within the U-Boot image, or in a separate
3265 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003266
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003267- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003268 Size of DRAM reserved for malloc() use.
3269
Simon Glassd59476b2014-07-10 22:23:28 -06003270- CONFIG_SYS_MALLOC_F_LEN
3271 Size of the malloc() pool for use before relocation. If
3272 this is defined, then a very simple malloc() implementation
3273 will become available before relocation. The address is just
3274 below the global data, and the stack is moved down to make
3275 space.
3276
3277 This feature allocates regions with increasing addresses
3278 within the region. calloc() is supported, but realloc()
3279 is not available. free() is supported but does nothing.
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003280 The memory will be freed (or in fact just forgotten) when
Simon Glassd59476b2014-07-10 22:23:28 -06003281 U-Boot relocates itself.
3282
Simon Glass38687ae2014-11-10 17:16:54 -07003283- CONFIG_SYS_MALLOC_SIMPLE
3284 Provides a simple and small malloc() and calloc() for those
3285 boards which do not use the full malloc in SPL (which is
3286 enabled with CONFIG_SYS_SPL_MALLOC_START).
3287
Thierry Reding1dfdd9b2014-12-09 22:25:22 -07003288- CONFIG_SYS_NONCACHED_MEMORY:
3289 Size of non-cached memory area. This area of memory will be
3290 typically located right below the malloc() area and mapped
3291 uncached in the MMU. This is useful for drivers that would
3292 otherwise require a lot of explicit cache maintenance. For
3293 some drivers it's also impossible to properly maintain the
3294 cache. For example if the regions that need to be flushed
3295 are not a multiple of the cache-line size, *and* padding
3296 cannot be allocated between the regions to align them (i.e.
3297 if the HW requires a contiguous array of regions, and the
3298 size of each region is not cache-aligned), then a flush of
3299 one region may result in overwriting data that hardware has
3300 written to another region in the same cache-line. This can
3301 happen for example in network drivers where descriptors for
3302 buffers are typically smaller than the CPU cache-line (e.g.
3303 16 bytes vs. 32 or 64 bytes).
3304
3305 Non-cached memory is only supported on 32-bit ARM at present.
3306
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003307- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01003308 Normally compressed uImages are limited to an
3309 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003310 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01003311 to adjust this setting to your needs.
3312
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003313- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003314 Maximum size of memory mapped by the startup code of
3315 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003316 the Linux kernel (bd_info, boot arguments, FDT blob if
3317 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04003318 environment variable is defined and non-zero. In such case
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003319 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003320 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likelyc3624e62011-03-28 09:58:43 +00003321 variable "bootm_mapsize" will override the value of
3322 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3323 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003324
John Rigbyfca43cc2010-10-13 13:57:35 -06003325- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3326 Enable initrd_high functionality. If defined then the
3327 initrd_high feature is enabled and the bootm ramdisk subcommand
3328 is enabled.
3329
3330- CONFIG_SYS_BOOT_GET_CMDLINE:
3331 Enables allocating and saving kernel cmdline in space between
3332 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3333
3334- CONFIG_SYS_BOOT_GET_KBD:
3335 Enables allocating and saving a kernel copy of the bd_info in
3336 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3337
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003338- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003339 Max number of Flash memory banks
3340
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003341- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003342 Max number of sectors on a Flash chip
3343
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003344- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003345 Timeout for Flash erase operations (in ms)
3346
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003347- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003348 Timeout for Flash write operations (in ms)
3349
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003350- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003351 Timeout for Flash set sector lock bit operation (in ms)
3352
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003353- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003354 Timeout for Flash clear lock bits operation (in ms)
3355
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003356- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00003357 If defined, hardware flash sectors protection is used
3358 instead of U-Boot software protection.
3359
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003360- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003361
3362 Enable TFTP transfers directly to flash memory;
3363 without this option such a download has to be
3364 performed in two steps: (1) download to RAM, and (2)
3365 copy from RAM to flash.
3366
3367 The two-step approach is usually more reliable, since
3368 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003369 the flash, but in some situations (when system RAM is
3370 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003371 downloaded image) this option may be very useful.
3372
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003373- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00003374 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00003375 common flash structure for storing flash geometry.
3376
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02003377- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00003378 This option also enables the building of the cfi_flash driver
3379 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003380
Piotr Ziecik91809ed2008-11-17 15:57:58 +01003381- CONFIG_FLASH_CFI_MTD
3382 This option enables the building of the cfi_mtd driver
3383 in the drivers directory. The driver exports CFI flash
3384 to the MTD layer.
3385
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003386- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02003387 Use buffered writes to flash.
3388
3389- CONFIG_FLASH_SPANSION_S29WS_N
3390 s29ws-n MirrorBit flash has non-standard addresses for buffered
3391 write commands.
3392
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003393- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01003394 If this option is defined, the common CFI flash doesn't
3395 print it's warning upon not recognized FLASH banks. This
3396 is useful, if some of the configured banks are only
3397 optionally available.
3398
Jerry Van Baren9a042e92008-03-08 13:48:01 -05003399- CONFIG_FLASH_SHOW_PROGRESS
3400 If defined (must be an integer), print out countdown
3401 digits and dots. Recommended value: 45 (9..1) for 80
3402 column displays, 15 (3..1) for 40 column displays.
3403
Stefan Roese352ef3f2013-04-04 15:53:14 +02003404- CONFIG_FLASH_VERIFY
3405 If defined, the content of the flash (destination) is compared
3406 against the source after the write operation. An error message
3407 will be printed when the contents are not identical.
3408 Please note that this option is useless in nearly all cases,
3409 since such flash programming errors usually are detected earlier
3410 while unprotecting/erasing/programming. Please only enable
3411 this option if you really know what you are doing.
3412
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003413- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003414 Defines the number of Ethernet receive buffers. On some
3415 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00003416 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3417 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003418 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00003419 Defaults to 4 if not defined.
3420
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003421- CONFIG_ENV_MAX_ENTRIES
3422
Wolfgang Denk071bc922010-10-27 22:48:30 +02003423 Maximum number of entries in the hash table that is used
3424 internally to store the environment settings. The default
3425 setting is supposed to be generous and should work in most
3426 cases. This setting can be used to tune behaviour; see
3427 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003428
Joe Hershberger25980902012-12-11 22:16:31 -06003429- CONFIG_ENV_FLAGS_LIST_DEFAULT
3430- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04003431 Enable validation of the values given to environment variables when
Joe Hershberger25980902012-12-11 22:16:31 -06003432 calling env set. Variables can be restricted to only decimal,
3433 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3434 the variables can also be restricted to IP address or MAC address.
3435
3436 The format of the list is:
3437 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003438 access_attribute = [a|r|o|c]
3439 attributes = type_attribute[access_attribute]
Joe Hershberger25980902012-12-11 22:16:31 -06003440 entry = variable_name[:attributes]
3441 list = entry[,list]
3442
3443 The type attributes are:
3444 s - String (default)
3445 d - Decimal
3446 x - Hexadecimal
3447 b - Boolean ([1yYtT|0nNfF])
3448 i - IP address
3449 m - MAC address
3450
Joe Hershberger267541f2012-12-11 22:16:34 -06003451 The access attributes are:
3452 a - Any (default)
3453 r - Read-only
3454 o - Write-once
3455 c - Change-default
3456
Joe Hershberger25980902012-12-11 22:16:31 -06003457 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3458 Define this to a list (string) to define the ".flags"
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003459 environment variable in the default or embedded environment.
Joe Hershberger25980902012-12-11 22:16:31 -06003460
3461 - CONFIG_ENV_FLAGS_LIST_STATIC
3462 Define this to a list (string) to define validation that
3463 should be done if an entry is not found in the ".flags"
3464 environment variable. To override a setting in the static
3465 list, simply add an entry for the same variable name to the
3466 ".flags" variable.
3467
Joe Hershbergerbdf1fe42015-05-20 14:27:20 -05003468 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
3469 regular expression. This allows multiple variables to define the same
3470 flags without explicitly listing them for each variable.
3471
Joe Hershberger267541f2012-12-11 22:16:34 -06003472- CONFIG_ENV_ACCESS_IGNORE_FORCE
3473 If defined, don't allow the -f switch to env set override variable
3474 access flags.
3475
Gabe Black0d296cc2014-10-15 04:38:30 -06003476- CONFIG_USE_STDINT
3477 If stdint.h is available with your toolchain you can define this
3478 option to enable it. You can provide option 'USE_STDINT=1' when
3479 building U-Boot to enable this.
3480
wdenkc6097192002-11-03 00:24:07 +00003481The following definitions that deal with the placement and management
3482of environment data (variable area); in general, we support the
3483following configurations:
3484
Mike Frysingerc3eb3fe2011-07-08 10:44:25 +00003485- CONFIG_BUILD_ENVCRC:
3486
3487 Builds up envcrc with the target environment so that external utils
3488 may easily extract it and embed it in final U-Boot images.
3489
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02003490- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00003491
3492 Define this if the environment is in flash memory.
3493
3494 a) The environment occupies one whole flash sector, which is
3495 "embedded" in the text segment with the U-Boot code. This
3496 happens usually with "bottom boot sector" or "top boot
3497 sector" type flash chips, which have several smaller
3498 sectors at the start or the end. For instance, such a
3499 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3500 such a case you would place the environment in one of the
3501 4 kB sectors - with U-Boot code before and after it. With
3502 "top boot sector" type flash chips, you would put the
3503 environment in one of the last sectors, leaving a gap
3504 between U-Boot and the environment.
3505
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003506 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003507
3508 Offset of environment data (variable area) to the
3509 beginning of flash memory; for instance, with bottom boot
3510 type flash chips the second sector can be used: the offset
3511 for this sector is given here.
3512
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003513 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00003514
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003515 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003516
3517 This is just another way to specify the start address of
3518 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003519 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00003520
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003521 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003522
3523 Size of the sector containing the environment.
3524
3525
3526 b) Sometimes flash chips have few, equal sized, BIG sectors.
3527 In such a case you don't want to spend a whole sector for
3528 the environment.
3529
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003530 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003531
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02003532 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003533 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00003534 of this flash sector for the environment. This saves
3535 memory for the RAM copy of the environment.
3536
3537 It may also save flash memory if you decide to use this
3538 when your environment is "embedded" within U-Boot code,
3539 since then the remainder of the flash sector could be used
3540 for U-Boot code. It should be pointed out that this is
3541 STRONGLY DISCOURAGED from a robustness point of view:
3542 updating the environment in flash makes it always
3543 necessary to erase the WHOLE sector. If something goes
3544 wrong before the contents has been restored from a copy in
3545 RAM, your target system will be dead.
3546
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003547 - CONFIG_ENV_ADDR_REDUND
3548 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00003549
wdenk43d96162003-03-06 00:02:04 +00003550 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003551 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00003552 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00003553 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00003554
3555BE CAREFUL! Any changes to the flash layout, and some changes to the
3556source code will make it necessary to adapt <board>/u-boot.lds*
3557accordingly!
3558
3559
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02003560- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00003561
3562 Define this if you have some non-volatile memory device
3563 (NVRAM, battery buffered SRAM) which you want to use for the
3564 environment.
3565
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003566 - CONFIG_ENV_ADDR:
3567 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003568
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003569 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00003570 want to use for environment. It is assumed that this memory
3571 can just be read and written to, without any special
3572 provision.
3573
3574BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003575in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003576console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00003577U-Boot will hang.
3578
3579Please note that even with NVRAM we still use a copy of the
3580environment in RAM: we could work on NVRAM directly, but we want to
3581keep settings there always unmodified except somebody uses "saveenv"
3582to save the current settings.
3583
3584
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02003585- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00003586
3587 Use this if you have an EEPROM or similar serial access
3588 device and a driver for it.
3589
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003590 - CONFIG_ENV_OFFSET:
3591 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003592
3593 These two #defines specify the offset and size of the
3594 environment area within the total memory of your EEPROM.
3595
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003596 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003597 If defined, specified the chip address of the EEPROM device.
3598 The default address is zero.
3599
Christian Gmeiner189d2572015-02-11 15:19:31 +01003600 - CONFIG_SYS_I2C_EEPROM_BUS:
3601 If defined, specified the i2c bus of the EEPROM device.
3602
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003603 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00003604 If defined, the number of bits used to address bytes in a
3605 single page in the EEPROM device. A 64 byte page, for example
3606 would require six bits.
3607
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003608 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00003609 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00003610 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00003611
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003612 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00003613 The length in bytes of the EEPROM memory array address. Note
3614 that this is NOT the chip address length!
3615
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003616 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00003617 EEPROM chips that implement "address overflow" are ones
3618 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
3619 address and the extra bits end up in the "chip address" bit
3620 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
3621 byte chips.
3622
3623 Note that we consider the length of the address field to
3624 still be one byte because the extra address bits are hidden
3625 in the chip address.
3626
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003627 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003628 The size in bytes of the EEPROM device.
3629
Heiko Schocher548738b2010-01-07 08:55:40 +01003630 - CONFIG_ENV_EEPROM_IS_ON_I2C
3631 define this, if you have I2C and SPI activated, and your
3632 EEPROM, which holds the environment, is on the I2C bus.
3633
3634 - CONFIG_I2C_ENV_EEPROM_BUS
3635 if you have an Environment on an EEPROM reached over
3636 I2C muxes, you can define here, how to reach this
3637 EEPROM. For example:
3638
Heiko Schocherea818db2013-01-29 08:53:15 +01003639 #define CONFIG_I2C_ENV_EEPROM_BUS 1
Heiko Schocher548738b2010-01-07 08:55:40 +01003640
3641 EEPROM which holds the environment, is reached over
3642 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00003643
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02003644- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00003645
wdenkd4ca31c2004-01-02 14:00:00 +00003646 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00003647 want to use for the environment.
3648
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003649 - CONFIG_ENV_OFFSET:
3650 - CONFIG_ENV_ADDR:
3651 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00003652
3653 These three #defines specify the offset and size of the
3654 environment area within the total memory of your DataFlash placed
3655 at the specified address.
3656
Wu, Joshbd83b592014-07-01 19:30:13 +08003657- CONFIG_ENV_IS_IN_SPI_FLASH:
3658
3659 Define this if you have a SPI Flash memory device which you
3660 want to use for the environment.
3661
3662 - CONFIG_ENV_OFFSET:
3663 - CONFIG_ENV_SIZE:
3664
3665 These two #defines specify the offset and size of the
3666 environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
3667 aligned to an erase sector boundary.
3668
3669 - CONFIG_ENV_SECT_SIZE:
3670
3671 Define the SPI flash's sector size.
3672
3673 - CONFIG_ENV_OFFSET_REDUND (optional):
3674
3675 This setting describes a second storage area of CONFIG_ENV_SIZE
3676 size used to hold a redundant copy of the environment data, so
3677 that there is a valid backup copy in case there is a power failure
Simon Glass9dd05fb2016-10-02 18:00:58 -06003678 during a "saveenv" operation. CONFIG_ENV_OFFSET_REDUND must be
Wu, Joshbd83b592014-07-01 19:30:13 +08003679 aligned to an erase sector boundary.
3680
3681 - CONFIG_ENV_SPI_BUS (optional):
3682 - CONFIG_ENV_SPI_CS (optional):
3683
3684 Define the SPI bus and chip select. If not defined they will be 0.
3685
3686 - CONFIG_ENV_SPI_MAX_HZ (optional):
3687
3688 Define the SPI max work clock. If not defined then use 1MHz.
3689
3690 - CONFIG_ENV_SPI_MODE (optional):
3691
3692 Define the SPI work mode. If not defined then use SPI_MODE_3.
3693
Liu Gang0a85a9e2012-03-08 00:33:20 +00003694- CONFIG_ENV_IS_IN_REMOTE:
3695
3696 Define this if you have a remote memory space which you
3697 want to use for the local device's environment.
3698
3699 - CONFIG_ENV_ADDR:
3700 - CONFIG_ENV_SIZE:
3701
3702 These two #defines specify the address and size of the
3703 environment area within the remote memory space. The
3704 local device can get the environment from remote memory
Liu Gangfc54c7f2012-08-09 05:10:01 +00003705 space by SRIO or PCIE links.
Liu Gang0a85a9e2012-03-08 00:33:20 +00003706
3707BE CAREFUL! For some special cases, the local device can not use
3708"saveenv" command. For example, the local device will get the
Liu Gangfc54c7f2012-08-09 05:10:01 +00003709environment stored in a remote NOR flash by SRIO or PCIE link,
3710but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang0a85a9e2012-03-08 00:33:20 +00003711
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02003712- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00003713
3714 Define this if you have a NAND device which you want to use
3715 for the environment.
3716
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003717 - CONFIG_ENV_OFFSET:
3718 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00003719
3720 These two #defines specify the offset and size of the environment
Scott Woodfdd813d2010-09-17 14:38:37 -05003721 area within the first NAND device. CONFIG_ENV_OFFSET must be
3722 aligned to an erase block boundary.
wdenk5779d8d2003-12-06 23:55:10 +00003723
Scott Woodfdd813d2010-09-17 14:38:37 -05003724 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003725
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003726 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Woodfdd813d2010-09-17 14:38:37 -05003727 size used to hold a redundant copy of the environment data, so
3728 that there is a valid backup copy in case there is a power failure
Simon Glass9dd05fb2016-10-02 18:00:58 -06003729 during a "saveenv" operation. CONFIG_ENV_OFFSET_REDUND must be
Scott Woodfdd813d2010-09-17 14:38:37 -05003730 aligned to an erase block boundary.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003731
Scott Woodfdd813d2010-09-17 14:38:37 -05003732 - CONFIG_ENV_RANGE (optional):
3733
3734 Specifies the length of the region in which the environment
3735 can be written. This should be a multiple of the NAND device's
3736 block size. Specifying a range with more erase blocks than
3737 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3738 the range to be avoided.
3739
3740 - CONFIG_ENV_OFFSET_OOB (optional):
3741
3742 Enables support for dynamically retrieving the offset of the
3743 environment from block zero's out-of-band data. The
3744 "nand env.oob" command can be used to record this offset.
3745 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3746 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003747
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02003748- CONFIG_NAND_ENV_DST
3749
3750 Defines address in RAM to which the nand_spl code should copy the
3751 environment. If redundant environment is used, it will be copied to
3752 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3753
Joe Hershberger2b744332013-04-08 10:32:51 +00003754- CONFIG_ENV_IS_IN_UBI:
3755
3756 Define this if you have an UBI volume that you want to use for the
3757 environment. This has the benefit of wear-leveling the environment
3758 accesses, which is important on NAND.
3759
3760 - CONFIG_ENV_UBI_PART:
3761
3762 Define this to a string that is the mtd partition containing the UBI.
3763
3764 - CONFIG_ENV_UBI_VOLUME:
3765
3766 Define this to the name of the volume that you want to store the
3767 environment in.
3768
Joe Hershberger785881f2013-04-08 10:32:52 +00003769 - CONFIG_ENV_UBI_VOLUME_REDUND:
3770
3771 Define this to the name of another volume to store a second copy of
3772 the environment in. This will enable redundant environments in UBI.
3773 It is assumed that both volumes are in the same MTD partition.
3774
Joe Hershberger2b744332013-04-08 10:32:51 +00003775 - CONFIG_UBI_SILENCE_MSG
3776 - CONFIG_UBIFS_SILENCE_MSG
3777
3778 You will probably want to define these to avoid a really noisy system
3779 when storing the env in UBI.
3780
Wu, Joshd1db76f2014-06-24 17:31:03 +08003781- CONFIG_ENV_IS_IN_FAT:
3782 Define this if you want to use the FAT file system for the environment.
3783
3784 - FAT_ENV_INTERFACE:
3785
3786 Define this to a string that is the name of the block device.
3787
Nicolae Rosia41987782016-11-21 17:33:58 +02003788 - FAT_ENV_DEVICE_AND_PART:
Wu, Joshd1db76f2014-06-24 17:31:03 +08003789
3790 Define this to a string to specify the partition of the device. It can
3791 be as following:
3792
3793 "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
3794 - "D:P": device D partition P. Error occurs if device D has no
3795 partition table.
3796 - "D:0": device D.
3797 - "D" or "D:": device D partition 1 if device D has partition
3798 table, or the whole device D if has no partition
3799 table.
3800 - "D:auto": first partition in device D with bootable flag set.
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003801 If none, first valid partition in device D. If no
Wu, Joshd1db76f2014-06-24 17:31:03 +08003802 partition table then means device D.
3803
3804 - FAT_ENV_FILE:
3805
3806 It's a string of the FAT file name. This file use to store the
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003807 environment.
Wu, Joshd1db76f2014-06-24 17:31:03 +08003808
3809 - CONFIG_FAT_WRITE:
Tom Rini91d27a12017-06-02 11:03:50 -04003810 This must be enabled. Otherwise it cannot save the environment file.
Wu, Joshd1db76f2014-06-24 17:31:03 +08003811
Stephen Warren06e4ae52013-06-11 15:14:00 -06003812- CONFIG_ENV_IS_IN_MMC:
3813
3814 Define this if you have an MMC device which you want to use for the
3815 environment.
3816
3817 - CONFIG_SYS_MMC_ENV_DEV:
3818
3819 Specifies which MMC device the environment is stored in.
3820
3821 - CONFIG_SYS_MMC_ENV_PART (optional):
3822
3823 Specifies which MMC partition the environment is stored in. If not
3824 set, defaults to partition 0, the user area. Common values might be
3825 1 (first MMC boot partition), 2 (second MMC boot partition).
3826
3827 - CONFIG_ENV_OFFSET:
3828 - CONFIG_ENV_SIZE:
3829
3830 These two #defines specify the offset and size of the environment
3831 area within the specified MMC device.
3832
Stephen Warren5c088ee2013-06-11 15:14:02 -06003833 If offset is positive (the usual case), it is treated as relative to
3834 the start of the MMC partition. If offset is negative, it is treated
3835 as relative to the end of the MMC partition. This can be useful if
3836 your board may be fitted with different MMC devices, which have
3837 different sizes for the MMC partitions, and you always want the
3838 environment placed at the very end of the partition, to leave the
3839 maximum possible space before it, to store other data.
3840
Stephen Warren06e4ae52013-06-11 15:14:00 -06003841 These two values are in units of bytes, but must be aligned to an
3842 MMC sector boundary.
3843
3844 - CONFIG_ENV_OFFSET_REDUND (optional):
3845
3846 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
3847 hold a redundant copy of the environment data. This provides a
3848 valid backup copy in case the other copy is corrupted, e.g. due
3849 to a power failure during a "saveenv" operation.
3850
Stephen Warren5c088ee2013-06-11 15:14:02 -06003851 This value may also be positive or negative; this is handled in the
3852 same way as CONFIG_ENV_OFFSET.
3853
Stephen Warren06e4ae52013-06-11 15:14:00 -06003854 This value is also in units of bytes, but must also be aligned to
3855 an MMC sector boundary.
3856
3857 - CONFIG_ENV_SIZE_REDUND (optional):
3858
3859 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
3860 set. If this value is set, it must be set to the same value as
3861 CONFIG_ENV_SIZE.
3862
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003863- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00003864
3865 Defines offset to the initial SPI buffer area in DPRAM. The
3866 area is used at an early stage (ROM part) if the environment
3867 is configured to reside in the SPI EEPROM: We need a 520 byte
3868 scratch DPRAM area. It is used between the two initialization
3869 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
3870 to be a good choice since it makes it far enough from the
3871 start of the data area as well as from the stack pointer.
3872
Bruce Adlere881cb52007-11-02 13:15:42 -07003873Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00003874has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02003875created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00003876until then to read environment variables.
3877
wdenk85ec0bc2003-03-31 16:34:49 +00003878The environment is protected by a CRC32 checksum. Before the monitor
3879is relocated into RAM, as a result of a bad CRC you will be working
3880with the compiled-in default environment - *silently*!!! [This is
3881necessary, because the first environment variable we need is the
3882"baudrate" setting for the console - if we have a bad CRC, we don't
3883have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00003884
3885Note: once the monitor has been relocated, then it will complain if
3886the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00003887use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00003888
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003889- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00003890 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00003891
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003892 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00003893 also needs to be defined.
3894
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003895- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00003896 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00003897
Ron Madridf5675aa2009-02-18 14:30:44 -08003898- CONFIG_NS16550_MIN_FUNCTIONS:
3899 Define this if you desire to only have use of the NS16550_init
3900 and NS16550_putc functions for the serial driver located at
3901 drivers/serial/ns16550.c. This option is useful for saving
3902 space for already greatly restricted images, including but not
3903 limited to NAND_SPL configurations.
3904
Simon Glassb2b92f52012-11-30 13:01:18 +00003905- CONFIG_DISPLAY_BOARDINFO
3906 Display information about the board that U-Boot is running on
3907 when U-Boot starts up. The board function checkboard() is called
3908 to do this.
3909
Simon Glasse2e3e2b2012-11-30 13:01:19 +00003910- CONFIG_DISPLAY_BOARDINFO_LATE
3911 Similar to the previous option, but display this information
3912 later, once stdio is running and output goes to the LCD, if
3913 present.
3914
Sascha Silbefeb85802013-08-11 16:40:43 +02003915- CONFIG_BOARD_SIZE_LIMIT:
3916 Maximum size of the U-Boot image. When defined, the
3917 build system checks that the actual size does not
3918 exceed it.
3919
wdenkc6097192002-11-03 00:24:07 +00003920Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00003921---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003922
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003923- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003924 Cache Line Size of the CPU.
3925
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003926- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00003927 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00003928
wdenk42d1f032003-10-15 23:53:47 +00003929 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
3930 and RPXsuper) to be able to adjust the position of
3931 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00003932
Timur Tabie46fedf2011-08-04 18:03:41 -05003933- CONFIG_SYS_CCSRBAR_DEFAULT:
3934 Default (power-on reset) physical address of CCSR on Freescale
3935 PowerPC SOCs.
3936
3937- CONFIG_SYS_CCSRBAR:
3938 Virtual address of CCSR. On a 32-bit build, this is typically
3939 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3940
3941 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
3942 for cross-platform code that uses that macro instead.
3943
3944- CONFIG_SYS_CCSRBAR_PHYS:
3945 Physical address of CCSR. CCSR can be relocated to a new
3946 physical address, if desired. In this case, this macro should
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003947 be set to that address. Otherwise, it should be set to the
Timur Tabie46fedf2011-08-04 18:03:41 -05003948 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
3949 is typically relocated on 36-bit builds. It is recommended
3950 that this macro be defined via the _HIGH and _LOW macros:
3951
3952 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3953 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3954
3955- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003956 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
3957 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabie46fedf2011-08-04 18:03:41 -05003958 used in assembly code, so it must not contain typecasts or
3959 integer size suffixes (e.g. "ULL").
3960
3961- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3962 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
3963 used in assembly code, so it must not contain typecasts or
3964 integer size suffixes (e.g. "ULL").
3965
3966- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3967 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3968 forced to a value that ensures that CCSR is not relocated.
3969
wdenk7f6c2cb2002-11-10 22:06:23 +00003970- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003971 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00003972
3973 the default drive number (default value 0)
3974
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003975 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00003976
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003977 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00003978 (default value 1)
3979
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003980 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00003981
wdenk43d96162003-03-06 00:02:04 +00003982 defines the offset of register from address. It
3983 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003984 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00003985
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003986 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
3987 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00003988 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00003989
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003990 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00003991 fdc_hw_init() is called at the beginning of the FDC
3992 setup. fdc_hw_init() must be provided by the board
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003993 source code. It is used to make hardware-dependent
wdenk43d96162003-03-06 00:02:04 +00003994 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00003995
Macpaul Lin0abddf82011-04-11 20:45:32 +00003996- CONFIG_IDE_AHB:
3997 Most IDE controllers were designed to be connected with PCI
3998 interface. Only few of them were designed for AHB interface.
3999 When software is doing ATA command and data transfer to
4000 IDE devices through IDE-AHB controller, some additional
4001 registers accessing to these kind of IDE-AHB controller
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004002 is required.
Macpaul Lin0abddf82011-04-11 20:45:32 +00004003
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004004- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00004005 DO NOT CHANGE unless you know exactly what you're
Heiko Schocher5b8e76c2017-06-07 17:33:09 +02004006 doing! (11-4) [82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00004007
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004008- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004009
wdenk7152b1d2003-09-05 23:19:14 +00004010 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00004011 initial data and stack; please note that this must be
4012 writable memory that is working WITHOUT special
4013 initialization, i. e. you CANNOT use normal RAM which
4014 will become available only after programming the
4015 memory controller and running certain initialization
4016 sequences.
4017
4018 U-Boot uses the following memory types:
Heiko Schocher5b8e76c2017-06-07 17:33:09 +02004019 - MPC8260: IMMR (internal memory of the CPU)
wdenkc6097192002-11-03 00:24:07 +00004020 - MPC824X: data cache
4021 - PPC4xx: data cache
4022
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004023- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004024
4025 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004026 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
4027 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00004028 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02004029 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Simon Glassacd51f92016-10-02 18:01:06 -06004030 GENERATED_GBL_DATA_SIZE), and the initial stack is just
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004031 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4032 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00004033
4034 Note:
4035 On the MPC824X (or other systems that use the data
4036 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004037 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00004038 point to an otherwise UNUSED address space between
4039 the top of RAM and the start of the PCI space.
4040
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004041- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00004042
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004043- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00004044
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004045- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00004046
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004047- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00004048
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004049- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00004050
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004051- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00004052
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004053- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00004054 SDRAM timing
4055
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004056- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00004057 periodic timer for refresh
4058
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004059- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00004060
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004061- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4062 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4063 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4064 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004065 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4066
4067- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004068 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4069 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004070 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4071
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004072- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4073 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00004074 Machine Mode Register and Memory Periodic Timer
4075 Prescaler definitions (SDRAM timing)
4076
Heiko Schocher5b8e76c2017-06-07 17:33:09 +02004077- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00004078 Offset of the bootmode word in DPRAM used by post
4079 (Power On Self Tests). This definition overrides
4080 #define'd default value in commproc.h resp.
4081 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00004082
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004083- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4084 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4085 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4086 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4087 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4088 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4089 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4090 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roesea47a12b2010-04-15 16:07:28 +02004091 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenk5d232d02003-05-22 22:52:13 +00004092
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01004093- CONFIG_PCI_DISABLE_PCIE:
4094 Disable PCI-Express on systems where it is supported but not
4095 required.
4096
Andrew Sharp69fd2d32012-08-29 14:16:32 +00004097- CONFIG_PCI_ENUM_ONLY
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004098 Only scan through and get the devices on the buses.
Andrew Sharp69fd2d32012-08-29 14:16:32 +00004099 Don't do any setup work, presumably because someone or
4100 something has already done it, and we don't need to do it
4101 a second time. Useful for platforms that are pre-booted
4102 by coreboot or similar.
4103
Gabor Juhos842033e2013-05-30 07:06:12 +00004104- CONFIG_PCI_INDIRECT_BRIDGE:
4105 Enable support for indirect PCI bridges.
4106
Kumar Galaa09b9b62010-12-30 12:09:53 -06004107- CONFIG_SYS_SRIO:
4108 Chip has SRIO or not
4109
4110- CONFIG_SRIO1:
4111 Board has SRIO 1 port available
4112
4113- CONFIG_SRIO2:
4114 Board has SRIO 2 port available
4115
Liu Gangc8b28152013-05-07 16:30:46 +08004116- CONFIG_SRIO_PCIE_BOOT_MASTER
4117 Board can support master function for Boot from SRIO and PCIE
4118
Kumar Galaa09b9b62010-12-30 12:09:53 -06004119- CONFIG_SYS_SRIOn_MEM_VIRT:
4120 Virtual Address of SRIO port 'n' memory region
4121
4122- CONFIG_SYS_SRIOn_MEM_PHYS:
4123 Physical Address of SRIO port 'n' memory region
4124
4125- CONFIG_SYS_SRIOn_MEM_SIZE:
4126 Size of SRIO port 'n' memory region
4127
Fabio Estevam66bd1842013-04-11 09:35:34 +00004128- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4129 Defined to tell the NAND controller that the NAND chip is using
4130 a 16 bit bus.
4131 Not all NAND drivers use this symbol.
Fabio Estevama430e912013-04-11 09:35:35 +00004132 Example of drivers that use it:
Fabio Estevam66bd1842013-04-11 09:35:34 +00004133 - drivers/mtd/nand/ndfc.c
Fabio Estevama430e912013-04-11 09:35:35 +00004134 - drivers/mtd/nand/mxc_nand.c
Alex Watermaneced4622011-05-19 15:08:36 -04004135
4136- CONFIG_SYS_NDFC_EBC0_CFG
4137 Sets the EBC0_CFG register for the NDFC. If not defined
4138 a default value will be used.
4139
Ben Warrenbb99ad62006-09-07 16:50:54 -04004140- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01004141 Get DDR timing information from an I2C EEPROM. Common
4142 with pluggable memory modules such as SODIMMs
4143
Ben Warrenbb99ad62006-09-07 16:50:54 -04004144 SPD_EEPROM_ADDRESS
4145 I2C address of the SPD EEPROM
4146
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004147- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01004148 If SPD EEPROM is on an I2C bus other than the first
4149 one, specify here. Note that the value must resolve
4150 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04004151
York Sun1b3e3c42011-06-07 09:42:16 +08004152- CONFIG_SYS_DDR_RAW_TIMING
4153 Get DDR timing information from other than SPD. Common with
4154 soldered DDR chips onboard without SPD. DDR raw timing
4155 parameters are extracted from datasheet and hard-coded into
4156 header files or board specific files.
4157
York Sun6f5e1dc2011-09-16 13:21:35 -07004158- CONFIG_FSL_DDR_INTERACTIVE
4159 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4160
York Sune32d59a2015-01-06 13:18:55 -08004161- CONFIG_FSL_DDR_SYNC_REFRESH
4162 Enable sync of refresh for multiple controllers.
4163
York Sun4516ff82015-03-19 09:30:28 -07004164- CONFIG_FSL_DDR_BIST
4165 Enable built-in memory test for Freescale DDR controllers.
4166
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004167- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01004168 Only for 83xx systems. If specified, then DDR should
4169 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06004170
wdenkc26e4542004-04-18 10:13:26 +00004171- CONFIG_RMII
4172 Enable RMII mode for all FECs.
4173 Note that this is a global option, we can't
4174 have one FEC in standard MII mode and another in RMII mode.
4175
wdenk5cf91d62004-04-23 20:32:05 +00004176- CONFIG_CRC32_VERIFY
4177 Add a verify option to the crc32 command.
4178 The syntax is:
4179
4180 => crc32 -v <address> <count> <crc32>
4181
4182 Where address/count indicate a memory area
4183 and crc32 is the correct crc32 which the
4184 area should have.
4185
wdenk56523f12004-07-11 17:40:54 +00004186- CONFIG_LOOPW
4187 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05004188 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00004189
stroese7b466642004-12-16 18:46:55 +00004190- CONFIG_MX_CYCLIC
4191 Add the "mdc" and "mwc" memory commands. These are cyclic
4192 "md/mw" commands.
4193 Examples:
4194
wdenkefe2a4d2004-12-16 21:44:03 +00004195 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00004196 This command will print 4 bytes (10,11,12,13) each 500 ms.
4197
wdenkefe2a4d2004-12-16 21:44:03 +00004198 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00004199 This command will write 12345678 to address 100 all 10 ms.
4200
wdenkefe2a4d2004-12-16 21:44:03 +00004201 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05004202 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00004203
wdenk8aa1a2d2005-04-04 12:44:11 +00004204- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Linafc1ce82011-10-19 20:41:11 +00004205 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk844f07d2010-11-27 23:30:56 +01004206 low level initializations (like setting up the memory
4207 controller) are omitted and/or U-Boot does not
4208 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00004209
Wolfgang Denk844f07d2010-11-27 23:30:56 +01004210 Normally this variable MUST NOT be defined. The only
4211 exception is when U-Boot is loaded (to RAM) by some
4212 other boot loader or by a debugger which performs
4213 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00004214
Simon Glassb5bd0982016-05-05 07:28:06 -06004215- CONFIG_SKIP_LOWLEVEL_INIT_ONLY
4216 [ARM926EJ-S only] This allows just the call to lowlevel_init()
yeongjun Kim90211f72016-07-20 22:56:12 +09004217 to be skipped. The normal CP15 init (such as enabling the
Simon Glassb5bd0982016-05-05 07:28:06 -06004218 instruction cache) is still performed.
4219
Aneesh V401bb302011-07-13 05:11:07 +00004220- CONFIG_SPL_BUILD
Magnus Liljadf812382009-06-13 20:50:00 +02004221 Modifies the behaviour of start.S when compiling a loader
4222 that is executed before the actual U-Boot. E.g. when
4223 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00004224
Ying Zhang3aa29de2013-08-16 15:16:15 +08004225- CONFIG_TPL_BUILD
4226 Modifies the behaviour of start.S when compiling a loader
4227 that is executed after the SPL and before the actual U-Boot.
4228 It is loaded by the SPL.
4229
Ying Zhang5df572f2013-05-20 14:07:23 +08004230- CONFIG_SYS_MPC85XX_NO_RESETVEC
4231 Only for 85xx systems. If this variable is specified, the section
4232 .resetvec is not kept and the section .bootpg is placed in the
4233 previous 4k of the .text section.
4234
Simon Glass4213fc22013-02-24 17:33:14 +00004235- CONFIG_ARCH_MAP_SYSMEM
4236 Generally U-Boot (and in particular the md command) uses
4237 effective address. It is therefore not necessary to regard
4238 U-Boot address as virtual addresses that need to be translated
4239 to physical addresses. However, sandbox requires this, since
4240 it maintains its own little RAM buffer which contains all
4241 addressable memory. This option causes some memory accesses
4242 to be mapped through map_sysmem() / unmap_sysmem().
4243
Simon Glass588a13f2013-02-14 04:18:54 +00004244- CONFIG_X86_RESET_VECTOR
4245 If defined, the x86 reset vector code is included. This is not
4246 needed when U-Boot is running from Coreboot.
Gabe Blackb16f5212012-11-27 21:08:06 +00004247
Heiko Schocher16678eb2013-11-04 14:05:00 +01004248- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
4249 Enables the RTC32K OSC on AM33xx based plattforms
4250
Karicheri, Muralidharan999d7d32014-04-04 13:16:50 -04004251- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
4252 Option to disable subpage write in NAND driver
4253 driver that uses this:
4254 drivers/mtd/nand/davinci_nand.c
4255
Timur Tabif2717b42011-11-22 09:21:25 -06004256Freescale QE/FMAN Firmware Support:
4257-----------------------------------
4258
4259The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4260loading of "firmware", which is encoded in the QE firmware binary format.
4261This firmware often needs to be loaded during U-Boot booting, so macros
4262are used to identify the storage device (NOR flash, SPI, etc) and the address
4263within that device.
4264
Zhao Qiangdcf1d772014-03-21 16:21:44 +08004265- CONFIG_SYS_FMAN_FW_ADDR
4266 The address in the storage device where the FMAN microcode is located. The
4267 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4268 is also specified.
4269
4270- CONFIG_SYS_QE_FW_ADDR
4271 The address in the storage device where the QE microcode is located. The
Timur Tabif2717b42011-11-22 09:21:25 -06004272 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4273 is also specified.
4274
4275- CONFIG_SYS_QE_FMAN_FW_LENGTH
4276 The maximum possible size of the firmware. The firmware binary format
4277 has a field that specifies the actual size of the firmware, but it
4278 might not be possible to read any part of the firmware unless some
4279 local storage is allocated to hold the entire firmware first.
4280
4281- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4282 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4283 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
4284 virtual address in NOR flash.
4285
4286- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4287 Specifies that QE/FMAN firmware is located in NAND flash.
4288 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4289
4290- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4291 Specifies that QE/FMAN firmware is located on the primary SD/MMC
4292 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4293
Liu Gang292dc6c2012-03-08 00:33:18 +00004294- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4295 Specifies that QE/FMAN firmware is located in the remote (master)
4296 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gangfc54c7f2012-08-09 05:10:01 +00004297 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4298 window->master inbound window->master LAW->the ucode address in
4299 master's memory space.
Timur Tabif2717b42011-11-22 09:21:25 -06004300
J. German Riverab940ca62014-06-23 15:15:55 -07004301Freescale Layerscape Management Complex Firmware Support:
4302---------------------------------------------------------
4303The Freescale Layerscape Management Complex (MC) supports the loading of
4304"firmware".
4305This firmware often needs to be loaded during U-Boot booting, so macros
4306are used to identify the storage device (NOR flash, SPI, etc) and the address
4307within that device.
4308
4309- CONFIG_FSL_MC_ENET
4310 Enable the MC driver for Layerscape SoCs.
4311
Prabhakar Kushwaha5c055082015-06-02 10:55:52 +05304312Freescale Layerscape Debug Server Support:
4313-------------------------------------------
4314The Freescale Layerscape Debug Server Support supports the loading of
4315"Debug Server firmware" and triggering SP boot-rom.
4316This firmware often needs to be loaded during U-Boot booting.
4317
York Sunc0492142015-12-07 11:08:58 -08004318- CONFIG_SYS_MC_RSV_MEM_ALIGN
4319 Define alignment of reserved memory MC requires
Prabhakar Kushwaha5c055082015-06-02 10:55:52 +05304320
Paul Kocialkowskif3f431a2015-07-26 18:48:15 +02004321Reproducible builds
4322-------------------
4323
4324In order to achieve reproducible builds, timestamps used in the U-Boot build
4325process have to be set to a fixed value.
4326
4327This is done using the SOURCE_DATE_EPOCH environment variable.
4328SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
4329option for U-Boot or an environment variable in U-Boot.
4330
4331SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
4332
wdenkc6097192002-11-03 00:24:07 +00004333Building the Software:
4334======================
4335
Wolfgang Denk218ca722008-03-26 10:40:12 +01004336Building U-Boot has been tested in several native build environments
4337and in many different cross environments. Of course we cannot support
4338all possibly existing versions of cross development tools in all
4339(potentially obsolete) versions. In case of tool chain problems we
4340recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4341which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004342
Wolfgang Denk218ca722008-03-26 10:40:12 +01004343If you are not using a native environment, it is assumed that you
4344have GNU cross compiling tools available in your path. In this case,
4345you must set the environment variable CROSS_COMPILE in your shell.
4346Note that no changes to the Makefile or any other source files are
4347necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00004348
Wolfgang Denk218ca722008-03-26 10:40:12 +01004349 $ CROSS_COMPILE=ppc_4xx-
4350 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00004351
Peter Tyser2f8d3962009-03-13 18:54:51 -05004352Note: If you wish to generate Windows versions of the utilities in
4353 the tools directory you can use the MinGW toolchain
4354 (http://www.mingw.org). Set your HOST tools to the MinGW
4355 toolchain and execute 'make tools'. For example:
4356
4357 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
4358
4359 Binaries such as tools/mkimage.exe will be created which can
4360 be executed on computers running Windows.
4361
Wolfgang Denk218ca722008-03-26 10:40:12 +01004362U-Boot is intended to be simple to build. After installing the
4363sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00004364is done by typing:
4365
Holger Freytherab584d62014-08-04 09:26:05 +02004366 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00004367
Holger Freytherab584d62014-08-04 09:26:05 +02004368where "NAME_defconfig" is the name of one of the existing configu-
Michael Jones4d675ae2012-03-15 22:48:10 +00004369rations; see boards.cfg for supported names.
wdenk54387ac2003-10-08 22:45:44 +00004370
wdenk2729af92004-05-03 20:45:30 +00004371Note: for some board special configuration names may exist; check if
4372 additional information is available from the board vendor; for
4373 instance, the TQM823L systems are available without (standard)
4374 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004375 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00004376
Holger Freytherab584d62014-08-04 09:26:05 +02004377 make TQM823L_defconfig
wdenk2729af92004-05-03 20:45:30 +00004378 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00004379
Holger Freytherab584d62014-08-04 09:26:05 +02004380 make TQM823L_LCD_defconfig
wdenk2729af92004-05-03 20:45:30 +00004381 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00004382
wdenk2729af92004-05-03 20:45:30 +00004383 etc.
wdenkc6097192002-11-03 00:24:07 +00004384
wdenkc6097192002-11-03 00:24:07 +00004385
wdenk2729af92004-05-03 20:45:30 +00004386Finally, type "make all", and you should get some working U-Boot
4387images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00004388
wdenk2729af92004-05-03 20:45:30 +00004389- "u-boot.bin" is a raw binary image
4390- "u-boot" is an image in ELF binary format
4391- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00004392
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004393By default the build is performed locally and the objects are saved
4394in the source directory. One of the two methods can be used to change
4395this behavior and build U-Boot to some external directory:
4396
43971. Add O= to the make command line invocations:
4398
4399 make O=/tmp/build distclean
Holger Freytherab584d62014-08-04 09:26:05 +02004400 make O=/tmp/build NAME_defconfig
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004401 make O=/tmp/build all
4402
Timo Ketolaadbba992014-11-06 14:39:05 +020044032. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004404
Timo Ketolaadbba992014-11-06 14:39:05 +02004405 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004406 make distclean
Holger Freytherab584d62014-08-04 09:26:05 +02004407 make NAME_defconfig
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004408 make all
4409
Timo Ketolaadbba992014-11-06 14:39:05 +02004410Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004411variable.
4412
wdenkc6097192002-11-03 00:24:07 +00004413
wdenk2729af92004-05-03 20:45:30 +00004414Please be aware that the Makefiles assume you are using GNU make, so
4415for instance on NetBSD you might need to use "gmake" instead of
4416native "make".
wdenkc6097192002-11-03 00:24:07 +00004417
wdenkc6097192002-11-03 00:24:07 +00004418
wdenk2729af92004-05-03 20:45:30 +00004419If the system board that you have is not listed, then you will need
4420to port U-Boot to your hardware platform. To do this, follow these
4421steps:
wdenkc6097192002-11-03 00:24:07 +00004422
Phil Sutter3c1496c2015-12-25 14:41:18 +010044231. Create a new directory to hold your board specific code. Add any
wdenk2729af92004-05-03 20:45:30 +00004424 files you need. In your board directory, you will need at least
Phil Sutter3c1496c2015-12-25 14:41:18 +01004425 the "Makefile" and a "<board>.c".
44262. Create a new configuration file "include/configs/<board>.h" for
4427 your board.
wdenk2729af92004-05-03 20:45:30 +000044283. If you're porting U-Boot to a new CPU, then also create a new
4429 directory to hold your CPU specific code. Add any files you need.
Holger Freytherab584d62014-08-04 09:26:05 +020044304. Run "make <board>_defconfig" with your new name.
wdenk2729af92004-05-03 20:45:30 +000044315. Type "make", and you should get a working "u-boot.srec" file
4432 to be installed on your target system.
44336. Debug and solve any problems that might arise.
4434 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00004435
wdenkc6097192002-11-03 00:24:07 +00004436
wdenk2729af92004-05-03 20:45:30 +00004437Testing of U-Boot Modifications, Ports to New Hardware, etc.:
4438==============================================================
wdenkc6097192002-11-03 00:24:07 +00004439
Wolfgang Denk218ca722008-03-26 10:40:12 +01004440If you have modified U-Boot sources (for instance added a new board
4441or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00004442provide feedback to the other developers. The feedback normally takes
4443the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01004444official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00004445
Wolfgang Denk218ca722008-03-26 10:40:12 +01004446But before you submit such a patch, please verify that your modifi-
4447cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00004448the supported boards compile WITHOUT ANY compiler warnings. To do so,
Simon Glass6de80f22016-07-27 20:33:08 -06004449just run the buildman script (tools/buildman/buildman), which will
4450configure and build U-Boot for ALL supported system. Be warned, this
4451will take a while. Please see the buildman README, or run 'buildman -H'
4452for documentation.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004453
4454
wdenk2729af92004-05-03 20:45:30 +00004455See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00004456
wdenkc6097192002-11-03 00:24:07 +00004457
wdenk2729af92004-05-03 20:45:30 +00004458Monitor Commands - Overview:
4459============================
wdenkc6097192002-11-03 00:24:07 +00004460
wdenk2729af92004-05-03 20:45:30 +00004461go - start application at address 'addr'
4462run - run commands in an environment variable
4463bootm - boot application image from memory
4464bootp - boot image via network using BootP/TFTP protocol
Marek Vasut44f074c2012-03-14 21:52:45 +00004465bootz - boot zImage from memory
wdenk2729af92004-05-03 20:45:30 +00004466tftpboot- boot image via network using TFTP protocol
4467 and env variables "ipaddr" and "serverip"
4468 (and eventually "gatewayip")
Simon Glass1fb7cd42011-10-24 18:00:07 +00004469tftpput - upload a file via network using TFTP protocol
wdenk2729af92004-05-03 20:45:30 +00004470rarpboot- boot image via network using RARP/TFTP protocol
4471diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
4472loads - load S-Record file over serial line
4473loadb - load binary file over serial line (kermit mode)
4474md - memory display
4475mm - memory modify (auto-incrementing)
4476nm - memory modify (constant address)
4477mw - memory write (fill)
4478cp - memory copy
4479cmp - memory compare
4480crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05004481i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00004482sspi - SPI utility commands
4483base - print or set address offset
4484printenv- print environment variables
4485setenv - set environment variables
4486saveenv - save environment variables to persistent storage
4487protect - enable or disable FLASH write protection
4488erase - erase FLASH memory
4489flinfo - print FLASH memory information
Karl O. Pinc10635af2012-08-03 05:57:21 +00004490nand - NAND memory operations (see doc/README.nand)
wdenk2729af92004-05-03 20:45:30 +00004491bdinfo - print Board Info structure
4492iminfo - print header information for application image
4493coninfo - print console devices and informations
4494ide - IDE sub-system
4495loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00004496loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00004497mtest - simple RAM test
4498icache - enable or disable instruction cache
4499dcache - enable or disable data cache
4500reset - Perform RESET of the CPU
4501echo - echo args to console
4502version - print monitor version
4503help - print online help
4504? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00004505
wdenkc6097192002-11-03 00:24:07 +00004506
wdenk2729af92004-05-03 20:45:30 +00004507Monitor Commands - Detailed Description:
4508========================================
wdenkc6097192002-11-03 00:24:07 +00004509
wdenk2729af92004-05-03 20:45:30 +00004510TODO.
wdenkc6097192002-11-03 00:24:07 +00004511
wdenk2729af92004-05-03 20:45:30 +00004512For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00004513
4514
wdenk2729af92004-05-03 20:45:30 +00004515Environment Variables:
4516======================
wdenkc6097192002-11-03 00:24:07 +00004517
wdenk2729af92004-05-03 20:45:30 +00004518U-Boot supports user configuration using Environment Variables which
4519can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00004520
wdenk2729af92004-05-03 20:45:30 +00004521Environment Variables are set using "setenv", printed using
4522"printenv", and saved to Flash using "saveenv". Using "setenv"
4523without a value can be used to delete a variable from the
4524environment. As long as you don't save the environment you are
4525working with an in-memory copy. In case the Flash area containing the
4526environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00004527
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004528Some configuration options can be set using Environment Variables.
4529
4530List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00004531
wdenk2729af92004-05-03 20:45:30 +00004532 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00004533
wdenk2729af92004-05-03 20:45:30 +00004534 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00004535
wdenk2729af92004-05-03 20:45:30 +00004536 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00004537
wdenk2729af92004-05-03 20:45:30 +00004538 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00004539
wdenk2729af92004-05-03 20:45:30 +00004540 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00004541
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02004542 bootm_low - Memory range available for image processing in the bootm
4543 command can be restricted. This variable is given as
4544 a hexadecimal number and defines lowest address allowed
4545 for use by the bootm command. See also "bootm_size"
4546 environment variable. Address defined by "bootm_low" is
4547 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00004548 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4549 bootm_mapsize.
4550
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004551 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likelyc3624e62011-03-28 09:58:43 +00004552 This variable is given as a hexadecimal number and it
4553 defines the size of the memory region starting at base
4554 address bootm_low that is accessible by the Linux kernel
4555 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
4556 as the default value if it is defined, and bootm_size is
4557 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02004558
4559 bootm_size - Memory range available for image processing in the bootm
4560 command can be restricted. This variable is given as
4561 a hexadecimal number and defines the size of the region
4562 allowed for use by the bootm command. See also "bootm_low"
4563 environment variable.
4564
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02004565 updatefile - Location of the software update file on a TFTP server, used
4566 by the automatic software update feature. Please refer to
4567 documentation in doc/README.update for more details.
4568
wdenk2729af92004-05-03 20:45:30 +00004569 autoload - if set to "no" (any string beginning with 'n'),
4570 "bootp" will just load perform a lookup of the
4571 configuration from the BOOTP server, but not try to
4572 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00004573
wdenk2729af92004-05-03 20:45:30 +00004574 autostart - if set to "yes", an image loaded using the "bootp",
4575 "rarpboot", "tftpboot" or "diskboot" commands will
4576 be automatically started (by internally calling
4577 "bootm")
wdenkc6097192002-11-03 00:24:07 +00004578
wdenk2729af92004-05-03 20:45:30 +00004579 If set to "no", a standalone image passed to the
4580 "bootm" command will be copied to the load address
4581 (and eventually uncompressed), but NOT be started.
4582 This can be used to load and uncompress arbitrary
4583 data.
wdenkc6097192002-11-03 00:24:07 +00004584
David A. Longa28afca2011-07-09 16:40:19 -04004585 fdt_high - if set this restricts the maximum address that the
4586 flattened device tree will be copied into upon boot.
Shawn Guofa34f6b2012-01-09 21:54:08 +00004587 For example, if you have a system with 1 GB memory
4588 at physical address 0x10000000, while Linux kernel
4589 only recognizes the first 704 MB as low memory, you
4590 may need to set fdt_high as 0x3C000000 to have the
4591 device tree blob be copied to the maximum address
4592 of the 704 MB low memory, so that Linux kernel can
4593 access it during the boot procedure.
4594
David A. Longa28afca2011-07-09 16:40:19 -04004595 If this is set to the special value 0xFFFFFFFF then
4596 the fdt will not be copied at all on boot. For this
4597 to work it must reside in writable memory, have
4598 sufficient padding on the end of it for u-boot to
4599 add the information it needs into it, and the memory
4600 must be accessible by the kernel.
4601
Simon Glasseea63e02011-10-24 19:15:34 +00004602 fdtcontroladdr- if set this is the address of the control flattened
4603 device tree used by U-Boot when CONFIG_OF_CONTROL is
4604 defined.
4605
wdenk17ea1172004-06-06 21:51:03 +00004606 i2cfast - (PPC405GP|PPC405EP only)
4607 if set to 'y' configures Linux I2C driver for fast
4608 mode (400kHZ). This environment variable is used in
4609 initialization code. So, for changes to be effective
4610 it must be saved and board must be reset.
4611
wdenk2729af92004-05-03 20:45:30 +00004612 initrd_high - restrict positioning of initrd images:
4613 If this variable is not set, initrd images will be
4614 copied to the highest possible address in RAM; this
4615 is usually what you want since it allows for
4616 maximum initrd size. If for some reason you want to
4617 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004618 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00004619 variable to a value of "no" or "off" or "0".
4620 Alternatively, you can set it to a maximum upper
4621 address to use (U-Boot will still check that it
4622 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00004623
wdenk2729af92004-05-03 20:45:30 +00004624 For instance, when you have a system with 16 MB
4625 RAM, and want to reserve 4 MB from use by Linux,
4626 you can do this by adding "mem=12M" to the value of
4627 the "bootargs" variable. However, now you must make
4628 sure that the initrd image is placed in the first
4629 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00004630
wdenk2729af92004-05-03 20:45:30 +00004631 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00004632
wdenk2729af92004-05-03 20:45:30 +00004633 If you set initrd_high to 0xFFFFFFFF, this is an
4634 indication to U-Boot that all addresses are legal
4635 for the Linux kernel, including addresses in flash
4636 memory. In this case U-Boot will NOT COPY the
4637 ramdisk at all. This may be useful to reduce the
4638 boot time on your system, but requires that this
4639 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00004640
wdenk2729af92004-05-03 20:45:30 +00004641 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00004642
wdenk2729af92004-05-03 20:45:30 +00004643 loadaddr - Default load address for commands like "bootp",
4644 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00004645
wdenk2729af92004-05-03 20:45:30 +00004646 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00004647
wdenk2729af92004-05-03 20:45:30 +00004648 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00004649
wdenk2729af92004-05-03 20:45:30 +00004650 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00004651
wdenk2729af92004-05-03 20:45:30 +00004652 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00004653
wdenk2729af92004-05-03 20:45:30 +00004654 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00004655
Mike Frysingere2a53452011-10-02 10:01:27 +00004656 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00004657
Mike Frysingere2a53452011-10-02 10:01:27 +00004658 ethact - controls which interface is currently active.
4659 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00004660
Heiko Schocher48690d82010-07-20 17:45:02 +02004661 => setenv ethact FEC
4662 => ping 192.168.0.1 # traffic sent on FEC
4663 => setenv ethact SCC
4664 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00004665
Matthias Fuchse1692572008-01-17 07:45:05 +01004666 ethrotate - When set to "no" U-Boot does not go through all
4667 available network interfaces.
4668 It just stays at the currently selected interface.
4669
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004670 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00004671 either succeed or fail without retrying.
4672 When set to "once" the network operation will
4673 fail when all the available network interfaces
4674 are tried once without success.
4675 Useful on scripts which control the retry operation
4676 themselves.
wdenkc6097192002-11-03 00:24:07 +00004677
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01004678 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01004679
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004680 silent_linux - If set then Linux will be told to boot silently, by
Simon Glass8d51aac2013-07-16 20:10:00 -07004681 changing the console to be empty. If "yes" it will be
4682 made silent. If "no" it will not be made silent. If
4683 unset, then it will be made silent if the U-Boot console
4684 is silent.
4685
Albert ARIBAUD \(3ADEV\)f5fb7342015-10-12 00:02:57 +02004686 tftpsrcp - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02004687 UDP source port.
4688
Albert ARIBAUD \(3ADEV\)f5fb7342015-10-12 00:02:57 +02004689 tftpdstp - If this is set, the value is used for TFTP's UDP
Wolfgang Denk28cb9372005-09-24 23:25:46 +02004690 destination port instead of the Well Know Port 69.
4691
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004692 tftpblocksize - Block size to use for TFTP transfers; if not set,
4693 we use the TFTP server's default block size
4694
4695 tftptimeout - Retransmission timeout for TFTP packets (in milli-
4696 seconds, minimum value is 1000 = 1 second). Defines
4697 when a packet is considered to be lost so it has to
4698 be retransmitted. The default is 5000 = 5 seconds.
4699 Lowering this value may make downloads succeed
4700 faster in networks with high packet loss rates or
4701 with unreliable TFTP servers.
4702
Albert ARIBAUD \(3ADEV\)f5fb7342015-10-12 00:02:57 +02004703 tftptimeoutcountmax - maximum count of TFTP timeouts (no
4704 unit, minimum value = 0). Defines how many timeouts
4705 can happen during a single file transfer before that
4706 transfer is aborted. The default is 10, and 0 means
4707 'no timeouts allowed'. Increasing this value may help
4708 downloads succeed with high packet loss rates, or with
4709 unreliable TFTP servers or client hardware.
4710
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004711 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004712 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00004713 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00004714
Alexandre Messier50768f52016-02-01 17:08:57 -05004715 bootpretryperiod - Period during which BOOTP/DHCP sends retries.
4716 Unsigned value, in milliseconds. If not set, the period will
4717 be either the default (28000), or a value based on
4718 CONFIG_NET_RETRY_COUNT, if defined. This value has
4719 precedence over the valu based on CONFIG_NET_RETRY_COUNT.
4720
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00004721The following image location variables contain the location of images
4722used in booting. The "Image" column gives the role of the image and is
4723not an environment variable name. The other columns are environment
4724variable names. "File Name" gives the name of the file on a TFTP
4725server, "RAM Address" gives the location in RAM the image will be
4726loaded to, and "Flash Location" gives the image's address in NOR
4727flash or offset in NAND flash.
4728
4729*Note* - these variables don't have to be defined for all boards, some
Fabio Estevamaed9fed2015-04-25 18:53:10 -03004730boards currently use other variables for these purposes, and some
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00004731boards use these variables for other purposes.
4732
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004733Image File Name RAM Address Flash Location
4734----- --------- ----------- --------------
4735u-boot u-boot u-boot_addr_r u-boot_addr
4736Linux kernel bootfile kernel_addr_r kernel_addr
4737device tree blob fdtfile fdt_addr_r fdt_addr
4738ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00004739
wdenk2729af92004-05-03 20:45:30 +00004740The following environment variables may be used and automatically
4741updated by the network boot commands ("bootp" and "rarpboot"),
4742depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00004743
wdenk2729af92004-05-03 20:45:30 +00004744 bootfile - see above
4745 dnsip - IP address of your Domain Name Server
4746 dnsip2 - IP address of your secondary Domain Name Server
4747 gatewayip - IP address of the Gateway (Router) to use
4748 hostname - Target hostname
4749 ipaddr - see above
4750 netmask - Subnet Mask
4751 rootpath - Pathname of the root filesystem on the NFS server
4752 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00004753
wdenka3d991b2004-04-15 21:48:45 +00004754
wdenk2729af92004-05-03 20:45:30 +00004755There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004756
wdenk2729af92004-05-03 20:45:30 +00004757 serial# - contains hardware identification information such
4758 as type string and/or serial number
4759 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00004760
wdenk2729af92004-05-03 20:45:30 +00004761These variables can be set only once (usually during manufacturing of
4762the board). U-Boot refuses to delete or overwrite these variables
4763once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00004764
4765
wdenk2729af92004-05-03 20:45:30 +00004766Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004767
wdenk2729af92004-05-03 20:45:30 +00004768 ver - Contains the U-Boot version string as printed
4769 with the "version" command. This variable is
4770 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00004771
wdenkc6097192002-11-03 00:24:07 +00004772
wdenk2729af92004-05-03 20:45:30 +00004773Please note that changes to some configuration parameters may take
4774only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00004775
stroesec1551ea2003-04-04 15:53:41 +00004776
Joe Hershberger170ab112012-12-11 22:16:24 -06004777Callback functions for environment variables:
4778---------------------------------------------
4779
4780For some environment variables, the behavior of u-boot needs to change
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004781when their values are changed. This functionality allows functions to
Joe Hershberger170ab112012-12-11 22:16:24 -06004782be associated with arbitrary variables. On creation, overwrite, or
4783deletion, the callback will provide the opportunity for some side
4784effect to happen or for the change to be rejected.
4785
4786The callbacks are named and associated with a function using the
4787U_BOOT_ENV_CALLBACK macro in your board or driver code.
4788
4789These callbacks are associated with variables in one of two ways. The
4790static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4791in the board configuration to a string that defines a list of
4792associations. The list must be in the following format:
4793
4794 entry = variable_name[:callback_name]
4795 list = entry[,list]
4796
4797If the callback name is not specified, then the callback is deleted.
4798Spaces are also allowed anywhere in the list.
4799
4800Callbacks can also be associated by defining the ".callbacks" variable
4801with the same list format above. Any association in ".callbacks" will
4802override any association in the static list. You can define
4803CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004804".callbacks" environment variable in the default or embedded environment.
Joe Hershberger170ab112012-12-11 22:16:24 -06004805
Joe Hershbergerbdf1fe42015-05-20 14:27:20 -05004806If CONFIG_REGEX is defined, the variable_name above is evaluated as a
4807regular expression. This allows multiple variables to be connected to
4808the same callback without explicitly listing them all out.
4809
Joe Hershberger170ab112012-12-11 22:16:24 -06004810
wdenk2729af92004-05-03 20:45:30 +00004811Command Line Parsing:
4812=====================
stroesec1551ea2003-04-04 15:53:41 +00004813
wdenk2729af92004-05-03 20:45:30 +00004814There are two different command line parsers available with U-Boot:
4815the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00004816
wdenk2729af92004-05-03 20:45:30 +00004817Old, simple command line parser:
4818--------------------------------
wdenkc6097192002-11-03 00:24:07 +00004819
wdenk2729af92004-05-03 20:45:30 +00004820- supports environment variables (through setenv / saveenv commands)
4821- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01004822- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00004823- special characters ('$', ';') can be escaped by prefixing with '\',
4824 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01004825 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00004826- You can also escape text by enclosing in single apostrophes, for example:
4827 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00004828
wdenk2729af92004-05-03 20:45:30 +00004829Hush shell:
4830-----------
wdenkf07771c2003-05-28 08:06:31 +00004831
wdenk2729af92004-05-03 20:45:30 +00004832- similar to Bourne shell, with control structures like
4833 if...then...else...fi, for...do...done; while...do...done,
4834 until...do...done, ...
4835- supports environment ("global") variables (through setenv / saveenv
4836 commands) and local shell variables (through standard shell syntax
4837 "name=value"); only environment variables can be used with "run"
4838 command
wdenkf07771c2003-05-28 08:06:31 +00004839
wdenk2729af92004-05-03 20:45:30 +00004840General rules:
4841--------------
wdenkf07771c2003-05-28 08:06:31 +00004842
wdenk2729af92004-05-03 20:45:30 +00004843(1) If a command line (or an environment variable executed by a "run"
4844 command) contains several commands separated by semicolon, and
4845 one of these commands fails, then the remaining commands will be
4846 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00004847
wdenk2729af92004-05-03 20:45:30 +00004848(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004849 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00004850 command will cause "run" to terminate, i. e. the remaining
4851 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00004852
wdenk2729af92004-05-03 20:45:30 +00004853Note for Redundant Ethernet Interfaces:
4854=======================================
wdenkf07771c2003-05-28 08:06:31 +00004855
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004856Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00004857such configurations and is capable of automatic selection of a
4858"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00004859
wdenk2729af92004-05-03 20:45:30 +00004860Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
4861MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4862"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00004863
wdenk2729af92004-05-03 20:45:30 +00004864If the network interface stores some valid MAC address (for instance
4865in SROM), this is used as default address if there is NO correspon-
4866ding setting in the environment; if the corresponding environment
4867variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00004868
wdenk2729af92004-05-03 20:45:30 +00004869o If the SROM has a valid MAC address, and there is no address in the
4870 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00004871
wdenk2729af92004-05-03 20:45:30 +00004872o If there is no valid address in the SROM, and a definition in the
4873 environment exists, then the value from the environment variable is
4874 used.
wdenkc6097192002-11-03 00:24:07 +00004875
wdenk2729af92004-05-03 20:45:30 +00004876o If both the SROM and the environment contain a MAC address, and
4877 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00004878
wdenk2729af92004-05-03 20:45:30 +00004879o If both the SROM and the environment contain a MAC address, and the
4880 addresses differ, the value from the environment is used and a
4881 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00004882
wdenk2729af92004-05-03 20:45:30 +00004883o If neither SROM nor the environment contain a MAC address, an error
Joe Hershbergerbef10142015-05-04 14:55:13 -05004884 is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
4885 a random, locally-assigned MAC is used.
wdenkc6097192002-11-03 00:24:07 +00004886
Ben Warrenecee9322010-04-26 11:11:46 -07004887If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004888will be programmed into hardware as part of the initialization process. This
Ben Warrenecee9322010-04-26 11:11:46 -07004889may be skipped by setting the appropriate 'ethmacskip' environment variable.
4890The naming convention is as follows:
4891"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00004892
wdenk2729af92004-05-03 20:45:30 +00004893Image Formats:
4894==============
wdenkc6097192002-11-03 00:24:07 +00004895
Marian Balakowicz3310c542008-03-12 12:13:13 +01004896U-Boot is capable of booting (and performing other auxiliary operations on)
4897images in two formats:
4898
4899New uImage format (FIT)
4900-----------------------
4901
4902Flexible and powerful format based on Flattened Image Tree -- FIT (similar
4903to Flattened Device Tree). It allows the use of images with multiple
4904components (several kernels, ramdisks, etc.), with contents protected by
4905SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
4906
4907
4908Old uImage format
4909-----------------
4910
4911Old image format is based on binary files which can be basically anything,
4912preceded by a special header; see the definitions in include/image.h for
4913details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00004914
wdenk2729af92004-05-03 20:45:30 +00004915* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4916 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05004917 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4918 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4919 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02004920* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Linafc1ce82011-10-19 20:41:11 +00004921 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
4922 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00004923* Compression Type (uncompressed, gzip, bzip2)
4924* Load Address
4925* Entry Point
4926* Image Name
4927* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00004928
wdenk2729af92004-05-03 20:45:30 +00004929The header is marked by a special Magic Number, and both the header
4930and the data portions of the image are secured against corruption by
4931CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00004932
wdenkc6097192002-11-03 00:24:07 +00004933
wdenk2729af92004-05-03 20:45:30 +00004934Linux Support:
4935==============
wdenkc6097192002-11-03 00:24:07 +00004936
wdenk2729af92004-05-03 20:45:30 +00004937Although U-Boot should support any OS or standalone application
4938easily, the main focus has always been on Linux during the design of
4939U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004940
wdenk2729af92004-05-03 20:45:30 +00004941U-Boot includes many features that so far have been part of some
4942special "boot loader" code within the Linux kernel. Also, any
4943"initrd" images to be used are no longer part of one big Linux image;
4944instead, kernel and "initrd" are separate images. This implementation
4945serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00004946
wdenk2729af92004-05-03 20:45:30 +00004947- the same features can be used for other OS or standalone
4948 applications (for instance: using compressed images to reduce the
4949 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00004950
wdenk2729af92004-05-03 20:45:30 +00004951- it becomes much easier to port new Linux kernel versions because
4952 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00004953
wdenk2729af92004-05-03 20:45:30 +00004954- the same Linux kernel image can now be used with different "initrd"
4955 images; of course this also means that different kernel images can
4956 be run with the same "initrd". This makes testing easier (you don't
4957 have to build a new "zImage.initrd" Linux image when you just
4958 change a file in your "initrd"). Also, a field-upgrade of the
4959 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00004960
wdenkc6097192002-11-03 00:24:07 +00004961
wdenk2729af92004-05-03 20:45:30 +00004962Linux HOWTO:
4963============
wdenkc6097192002-11-03 00:24:07 +00004964
wdenk2729af92004-05-03 20:45:30 +00004965Porting Linux to U-Boot based systems:
4966---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004967
wdenk2729af92004-05-03 20:45:30 +00004968U-Boot cannot save you from doing all the necessary modifications to
4969configure the Linux device drivers for use with your target hardware
4970(no, we don't intend to provide a full virtual machine interface to
4971Linux :-).
wdenkc6097192002-11-03 00:24:07 +00004972
Stefan Roesea47a12b2010-04-15 16:07:28 +02004973But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00004974
wdenk2729af92004-05-03 20:45:30 +00004975Just make sure your machine specific header file (for instance
4976include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02004977Information structure as we define in include/asm-<arch>/u-boot.h,
4978and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004979as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00004980
Simon Glass2eb31b12014-06-11 23:29:46 -06004981Note that U-Boot now has a driver model, a unified model for drivers.
4982If you are adding a new driver, plumb it into driver model. If there
4983is no uclass available, you are encouraged to create one. See
4984doc/driver-model.
4985
wdenkc6097192002-11-03 00:24:07 +00004986
wdenk2729af92004-05-03 20:45:30 +00004987Configuring the Linux kernel:
4988-----------------------------
wdenkc6097192002-11-03 00:24:07 +00004989
wdenk2729af92004-05-03 20:45:30 +00004990No specific requirements for U-Boot. Make sure you have some root
4991device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00004992
wdenkc6097192002-11-03 00:24:07 +00004993
wdenk2729af92004-05-03 20:45:30 +00004994Building a Linux Image:
4995-----------------------
wdenkc6097192002-11-03 00:24:07 +00004996
wdenk2729af92004-05-03 20:45:30 +00004997With U-Boot, "normal" build targets like "zImage" or "bzImage" are
4998not used. If you use recent kernel source, a new build target
4999"uImage" will exist which automatically builds an image usable by
5000U-Boot. Most older kernels also have support for a "pImage" target,
5001which was introduced for our predecessor project PPCBoot and uses a
5002100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00005003
wdenk2729af92004-05-03 20:45:30 +00005004Example:
wdenkc6097192002-11-03 00:24:07 +00005005
Holger Freytherab584d62014-08-04 09:26:05 +02005006 make TQM850L_defconfig
wdenk2729af92004-05-03 20:45:30 +00005007 make oldconfig
5008 make dep
5009 make uImage
wdenkc6097192002-11-03 00:24:07 +00005010
wdenk2729af92004-05-03 20:45:30 +00005011The "uImage" build target uses a special tool (in 'tools/mkimage') to
5012encapsulate a compressed Linux kernel image with header information,
5013CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00005014
wdenk2729af92004-05-03 20:45:30 +00005015* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00005016
wdenk2729af92004-05-03 20:45:30 +00005017* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00005018
wdenk2729af92004-05-03 20:45:30 +00005019 ${CROSS_COMPILE}-objcopy -O binary \
5020 -R .note -R .comment \
5021 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00005022
wdenk2729af92004-05-03 20:45:30 +00005023* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00005024
wdenk2729af92004-05-03 20:45:30 +00005025 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00005026
wdenk2729af92004-05-03 20:45:30 +00005027* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00005028
wdenk2729af92004-05-03 20:45:30 +00005029 mkimage -A ppc -O linux -T kernel -C gzip \
5030 -a 0 -e 0 -n "Linux Kernel Image" \
5031 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00005032
wdenk24ee89b2002-11-03 17:56:27 +00005033
wdenk2729af92004-05-03 20:45:30 +00005034The "mkimage" tool can also be used to create ramdisk images for use
5035with U-Boot, either separated from the Linux kernel image, or
5036combined into one file. "mkimage" encapsulates the images with a 64
5037byte header containing information about target architecture,
5038operating system, image type, compression method, entry points, time
5039stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00005040
wdenk2729af92004-05-03 20:45:30 +00005041"mkimage" can be called in two ways: to verify existing images and
5042print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00005043
wdenk2729af92004-05-03 20:45:30 +00005044In the first form (with "-l" option) mkimage lists the information
5045contained in the header of an existing U-Boot image; this includes
5046checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00005047
wdenk2729af92004-05-03 20:45:30 +00005048 tools/mkimage -l image
5049 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00005050
wdenk2729af92004-05-03 20:45:30 +00005051The second form (with "-d" option) is used to build a U-Boot image
5052from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00005053
wdenk2729af92004-05-03 20:45:30 +00005054 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5055 -n name -d data_file image
5056 -A ==> set architecture to 'arch'
5057 -O ==> set operating system to 'os'
5058 -T ==> set image type to 'type'
5059 -C ==> set compression type 'comp'
5060 -a ==> set load address to 'addr' (hex)
5061 -e ==> set entry point to 'ep' (hex)
5062 -n ==> set image name to 'name'
5063 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00005064
wdenk69459792004-05-29 16:53:29 +00005065Right now, all Linux kernels for PowerPC systems use the same load
5066address (0x00000000), but the entry point address depends on the
5067kernel version:
wdenkc6097192002-11-03 00:24:07 +00005068
wdenk2729af92004-05-03 20:45:30 +00005069- 2.2.x kernels have the entry point at 0x0000000C,
5070- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00005071
wdenk2729af92004-05-03 20:45:30 +00005072So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00005073
wdenk2729af92004-05-03 20:45:30 +00005074 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5075 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02005076 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00005077 > examples/uImage.TQM850L
5078 Image Name: 2.4.4 kernel for TQM850L
5079 Created: Wed Jul 19 02:34:59 2000
5080 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5081 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5082 Load Address: 0x00000000
5083 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005084
wdenk2729af92004-05-03 20:45:30 +00005085To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00005086
wdenk2729af92004-05-03 20:45:30 +00005087 -> tools/mkimage -l examples/uImage.TQM850L
5088 Image Name: 2.4.4 kernel for TQM850L
5089 Created: Wed Jul 19 02:34:59 2000
5090 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5091 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5092 Load Address: 0x00000000
5093 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005094
wdenk2729af92004-05-03 20:45:30 +00005095NOTE: for embedded systems where boot time is critical you can trade
5096speed for memory and install an UNCOMPRESSED image instead: this
5097needs more space in Flash, but boots much faster since it does not
5098need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00005099
Stefan Roesea47a12b2010-04-15 16:07:28 +02005100 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00005101 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5102 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02005103 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00005104 > examples/uImage.TQM850L-uncompressed
5105 Image Name: 2.4.4 kernel for TQM850L
5106 Created: Wed Jul 19 02:34:59 2000
5107 Image Type: PowerPC Linux Kernel Image (uncompressed)
5108 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5109 Load Address: 0x00000000
5110 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005111
wdenkc6097192002-11-03 00:24:07 +00005112
wdenk2729af92004-05-03 20:45:30 +00005113Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5114when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00005115
wdenk2729af92004-05-03 20:45:30 +00005116 -> tools/mkimage -n 'Simple Ramdisk Image' \
5117 > -A ppc -O linux -T ramdisk -C gzip \
5118 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5119 Image Name: Simple Ramdisk Image
5120 Created: Wed Jan 12 14:01:50 2000
5121 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5122 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5123 Load Address: 0x00000000
5124 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00005125
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -07005126The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5127option performs the converse operation of the mkimage's second form (the "-d"
5128option). Given an image built by mkimage, the dumpimage extracts a "data file"
5129from the image:
5130
Guilherme Maciel Ferreiraf41f5b72015-01-15 02:54:40 -02005131 tools/dumpimage -i image -T type -p position data_file
5132 -i ==> extract from the 'image' a specific 'data_file'
5133 -T ==> set image type to 'type'
5134 -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -07005135
wdenkdb01a2e2004-04-15 23:14:49 +00005136
wdenk2729af92004-05-03 20:45:30 +00005137Installing a Linux Image:
5138-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00005139
wdenk2729af92004-05-03 20:45:30 +00005140To downloading a U-Boot image over the serial (console) interface,
5141you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00005142
wdenk2729af92004-05-03 20:45:30 +00005143 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00005144
wdenk2729af92004-05-03 20:45:30 +00005145The 'objcopy' does not understand the information in the U-Boot
5146image header, so the resulting S-Record file will be relative to
5147address 0x00000000. To load it to a given address, you need to
5148specify the target address as 'offset' parameter with the 'loads'
5149command.
wdenkc6097192002-11-03 00:24:07 +00005150
wdenk2729af92004-05-03 20:45:30 +00005151Example: install the image to address 0x40100000 (which on the
5152TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00005153
wdenk2729af92004-05-03 20:45:30 +00005154 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00005155
wdenk2729af92004-05-03 20:45:30 +00005156 .......... done
5157 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00005158
wdenk2729af92004-05-03 20:45:30 +00005159 => loads 40100000
5160 ## Ready for S-Record download ...
5161 ~>examples/image.srec
5162 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5163 ...
5164 15989 15990 15991 15992
5165 [file transfer complete]
5166 [connected]
5167 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005168
5169
wdenk2729af92004-05-03 20:45:30 +00005170You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01005171this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00005172corruption happened:
wdenkc6097192002-11-03 00:24:07 +00005173
wdenk2729af92004-05-03 20:45:30 +00005174 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00005175
wdenk2729af92004-05-03 20:45:30 +00005176 ## Checking Image at 40100000 ...
5177 Image Name: 2.2.13 for initrd on TQM850L
5178 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5179 Data Size: 335725 Bytes = 327 kB = 0 MB
5180 Load Address: 00000000
5181 Entry Point: 0000000c
5182 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005183
5184
wdenk2729af92004-05-03 20:45:30 +00005185Boot Linux:
5186-----------
wdenkc6097192002-11-03 00:24:07 +00005187
wdenk2729af92004-05-03 20:45:30 +00005188The "bootm" command is used to boot an application that is stored in
5189memory (RAM or Flash). In case of a Linux kernel image, the contents
5190of the "bootargs" environment variable is passed to the kernel as
5191parameters. You can check and modify this variable using the
5192"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00005193
5194
wdenk2729af92004-05-03 20:45:30 +00005195 => printenv bootargs
5196 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00005197
wdenk2729af92004-05-03 20:45:30 +00005198 => 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 +00005199
wdenk2729af92004-05-03 20:45:30 +00005200 => printenv bootargs
5201 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 +00005202
wdenk2729af92004-05-03 20:45:30 +00005203 => bootm 40020000
5204 ## Booting Linux kernel at 40020000 ...
5205 Image Name: 2.2.13 for NFS on TQM850L
5206 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5207 Data Size: 381681 Bytes = 372 kB = 0 MB
5208 Load Address: 00000000
5209 Entry Point: 0000000c
5210 Verifying Checksum ... OK
5211 Uncompressing Kernel Image ... OK
5212 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
5213 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5214 time_init: decrementer frequency = 187500000/60
5215 Calibrating delay loop... 49.77 BogoMIPS
5216 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5217 ...
wdenkc6097192002-11-03 00:24:07 +00005218
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005219If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00005220the memory addresses of both the kernel and the initrd image (PPBCOOT
5221format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00005222
wdenk2729af92004-05-03 20:45:30 +00005223 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00005224
wdenk2729af92004-05-03 20:45:30 +00005225 ## Checking Image at 40100000 ...
5226 Image Name: 2.2.13 for initrd on TQM850L
5227 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5228 Data Size: 335725 Bytes = 327 kB = 0 MB
5229 Load Address: 00000000
5230 Entry Point: 0000000c
5231 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005232
wdenk2729af92004-05-03 20:45:30 +00005233 ## Checking Image at 40200000 ...
5234 Image Name: Simple Ramdisk Image
5235 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5236 Data Size: 566530 Bytes = 553 kB = 0 MB
5237 Load Address: 00000000
5238 Entry Point: 00000000
5239 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005240
wdenk2729af92004-05-03 20:45:30 +00005241 => bootm 40100000 40200000
5242 ## Booting Linux kernel at 40100000 ...
5243 Image Name: 2.2.13 for initrd on TQM850L
5244 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5245 Data Size: 335725 Bytes = 327 kB = 0 MB
5246 Load Address: 00000000
5247 Entry Point: 0000000c
5248 Verifying Checksum ... OK
5249 Uncompressing Kernel Image ... OK
5250 ## Loading RAMDisk Image at 40200000 ...
5251 Image Name: Simple Ramdisk Image
5252 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5253 Data Size: 566530 Bytes = 553 kB = 0 MB
5254 Load Address: 00000000
5255 Entry Point: 00000000
5256 Verifying Checksum ... OK
5257 Loading Ramdisk ... OK
5258 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
5259 Boot arguments: root=/dev/ram
5260 time_init: decrementer frequency = 187500000/60
5261 Calibrating delay loop... 49.77 BogoMIPS
5262 ...
5263 RAMDISK: Compressed image found at block 0
5264 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00005265
wdenk2729af92004-05-03 20:45:30 +00005266 bash#
wdenkc6097192002-11-03 00:24:07 +00005267
Matthew McClintock02677682006-06-28 10:41:37 -05005268Boot Linux and pass a flat device tree:
5269-----------
5270
5271First, U-Boot must be compiled with the appropriate defines. See the section
5272titled "Linux Kernel Interface" above for a more in depth explanation. The
5273following is an example of how to start a kernel and pass an updated
5274flat device tree:
5275
5276=> print oftaddr
5277oftaddr=0x300000
5278=> print oft
5279oft=oftrees/mpc8540ads.dtb
5280=> tftp $oftaddr $oft
5281Speed: 1000, full duplex
5282Using TSEC0 device
5283TFTP from server 192.168.1.1; our IP address is 192.168.1.101
5284Filename 'oftrees/mpc8540ads.dtb'.
5285Load address: 0x300000
5286Loading: #
5287done
5288Bytes transferred = 4106 (100a hex)
5289=> tftp $loadaddr $bootfile
5290Speed: 1000, full duplex
5291Using TSEC0 device
5292TFTP from server 192.168.1.1; our IP address is 192.168.1.2
5293Filename 'uImage'.
5294Load address: 0x200000
5295Loading:############
5296done
5297Bytes transferred = 1029407 (fb51f hex)
5298=> print loadaddr
5299loadaddr=200000
5300=> print oftaddr
5301oftaddr=0x300000
5302=> bootm $loadaddr - $oftaddr
5303## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01005304 Image Name: Linux-2.6.17-dirty
5305 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5306 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05005307 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01005308 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05005309 Verifying Checksum ... OK
5310 Uncompressing Kernel Image ... OK
5311Booting using flat device tree at 0x300000
5312Using MPC85xx ADS machine description
5313Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
5314[snip]
5315
5316
wdenk2729af92004-05-03 20:45:30 +00005317More About U-Boot Image Types:
5318------------------------------
wdenk6069ff22003-02-28 00:49:47 +00005319
wdenk2729af92004-05-03 20:45:30 +00005320U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00005321
wdenk2729af92004-05-03 20:45:30 +00005322 "Standalone Programs" are directly runnable in the environment
5323 provided by U-Boot; it is expected that (if they behave
5324 well) you can continue to work in U-Boot after return from
5325 the Standalone Program.
5326 "OS Kernel Images" are usually images of some Embedded OS which
5327 will take over control completely. Usually these programs
5328 will install their own set of exception handlers, device
5329 drivers, set up the MMU, etc. - this means, that you cannot
5330 expect to re-enter U-Boot except by resetting the CPU.
5331 "RAMDisk Images" are more or less just data blocks, and their
5332 parameters (address, size) are passed to an OS kernel that is
5333 being started.
5334 "Multi-File Images" contain several images, typically an OS
5335 (Linux) kernel image and one or more data images like
5336 RAMDisks. This construct is useful for instance when you want
5337 to boot over the network using BOOTP etc., where the boot
5338 server provides just a single image file, but you want to get
5339 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00005340
wdenk2729af92004-05-03 20:45:30 +00005341 "Multi-File Images" start with a list of image sizes, each
5342 image size (in bytes) specified by an "uint32_t" in network
5343 byte order. This list is terminated by an "(uint32_t)0".
5344 Immediately after the terminating 0 follow the images, one by
5345 one, all aligned on "uint32_t" boundaries (size rounded up to
5346 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00005347
wdenk2729af92004-05-03 20:45:30 +00005348 "Firmware Images" are binary images containing firmware (like
5349 U-Boot or FPGA images) which usually will be programmed to
5350 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00005351
wdenk2729af92004-05-03 20:45:30 +00005352 "Script files" are command sequences that will be executed by
5353 U-Boot's command interpreter; this feature is especially
5354 useful when you configure U-Boot to use a real shell (hush)
5355 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00005356
Marek Vasut44f074c2012-03-14 21:52:45 +00005357Booting the Linux zImage:
5358-------------------------
5359
5360On some platforms, it's possible to boot Linux zImage. This is done
5361using the "bootz" command. The syntax of "bootz" command is the same
5362as the syntax of "bootm" command.
5363
Tom Rini8ac28562013-05-16 11:40:11 -04005364Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut017e1f32012-03-18 11:47:58 +00005365kernel with raw initrd images. The syntax is slightly different, the
5366address of the initrd must be augmented by it's size, in the following
5367format: "<initrd addres>:<initrd size>".
5368
wdenkc6097192002-11-03 00:24:07 +00005369
wdenk2729af92004-05-03 20:45:30 +00005370Standalone HOWTO:
5371=================
wdenkc6097192002-11-03 00:24:07 +00005372
wdenk2729af92004-05-03 20:45:30 +00005373One of the features of U-Boot is that you can dynamically load and
5374run "standalone" applications, which can use some resources of
5375U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00005376
wdenk2729af92004-05-03 20:45:30 +00005377Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00005378
wdenk2729af92004-05-03 20:45:30 +00005379"Hello World" Demo:
5380-------------------
wdenkc6097192002-11-03 00:24:07 +00005381
wdenk2729af92004-05-03 20:45:30 +00005382'examples/hello_world.c' contains a small "Hello World" Demo
5383application; it is automatically compiled when you build U-Boot.
5384It's configured to run at address 0x00040004, so you can play with it
5385like that:
wdenkc6097192002-11-03 00:24:07 +00005386
wdenk2729af92004-05-03 20:45:30 +00005387 => loads
5388 ## Ready for S-Record download ...
5389 ~>examples/hello_world.srec
5390 1 2 3 4 5 6 7 8 9 10 11 ...
5391 [file transfer complete]
5392 [connected]
5393 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005394
wdenk2729af92004-05-03 20:45:30 +00005395 => go 40004 Hello World! This is a test.
5396 ## Starting application at 0x00040004 ...
5397 Hello World
5398 argc = 7
5399 argv[0] = "40004"
5400 argv[1] = "Hello"
5401 argv[2] = "World!"
5402 argv[3] = "This"
5403 argv[4] = "is"
5404 argv[5] = "a"
5405 argv[6] = "test."
5406 argv[7] = "<NULL>"
5407 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00005408
wdenk2729af92004-05-03 20:45:30 +00005409 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005410
wdenk2729af92004-05-03 20:45:30 +00005411Another example, which demonstrates how to register a CPM interrupt
5412handler with the U-Boot code, can be found in 'examples/timer.c'.
5413Here, a CPM timer is set up to generate an interrupt every second.
5414The interrupt service routine is trivial, just printing a '.'
5415character, but this is just a demo program. The application can be
5416controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00005417
wdenk2729af92004-05-03 20:45:30 +00005418 ? - print current values og the CPM Timer registers
5419 b - enable interrupts and start timer
5420 e - stop timer and disable interrupts
5421 q - quit application
wdenkc6097192002-11-03 00:24:07 +00005422
wdenk2729af92004-05-03 20:45:30 +00005423 => loads
5424 ## Ready for S-Record download ...
5425 ~>examples/timer.srec
5426 1 2 3 4 5 6 7 8 9 10 11 ...
5427 [file transfer complete]
5428 [connected]
5429 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005430
wdenk2729af92004-05-03 20:45:30 +00005431 => go 40004
5432 ## Starting application at 0x00040004 ...
5433 TIMERS=0xfff00980
5434 Using timer 1
5435 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00005436
wdenk2729af92004-05-03 20:45:30 +00005437Hit 'b':
5438 [q, b, e, ?] Set interval 1000000 us
5439 Enabling timer
5440Hit '?':
5441 [q, b, e, ?] ........
5442 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5443Hit '?':
5444 [q, b, e, ?] .
5445 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5446Hit '?':
5447 [q, b, e, ?] .
5448 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5449Hit '?':
5450 [q, b, e, ?] .
5451 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5452Hit 'e':
5453 [q, b, e, ?] ...Stopping timer
5454Hit 'q':
5455 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005456
5457
wdenk2729af92004-05-03 20:45:30 +00005458Minicom warning:
5459================
wdenk85ec0bc2003-03-31 16:34:49 +00005460
wdenk2729af92004-05-03 20:45:30 +00005461Over time, many people have reported problems when trying to use the
5462"minicom" terminal emulation program for serial download. I (wd)
5463consider minicom to be broken, and recommend not to use it. Under
5464Unix, I recommend to use C-Kermit for general purpose use (and
5465especially for kermit binary protocol download ("loadb" command), and
Karl O. Pince53515a2012-10-01 05:11:56 +00005466use "cu" for S-Record download ("loads" command). See
5467http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5468for help with kermit.
5469
wdenk85ec0bc2003-03-31 16:34:49 +00005470
wdenk2729af92004-05-03 20:45:30 +00005471Nevertheless, if you absolutely want to use it try adding this
5472configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00005473
wdenk2729af92004-05-03 20:45:30 +00005474 Name Program Name U/D FullScr IO-Red. Multi
5475 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
5476 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00005477
5478
wdenk2729af92004-05-03 20:45:30 +00005479NetBSD Notes:
5480=============
wdenkc6097192002-11-03 00:24:07 +00005481
wdenk2729af92004-05-03 20:45:30 +00005482Starting at version 0.9.2, U-Boot supports NetBSD both as host
5483(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00005484
wdenk2729af92004-05-03 20:45:30 +00005485Building requires a cross environment; it is known to work on
5486NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5487need gmake since the Makefiles are not compatible with BSD make).
5488Note that the cross-powerpc package does not install include files;
5489attempting to build U-Boot will fail because <machine/ansi.h> is
5490missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00005491
wdenk2729af92004-05-03 20:45:30 +00005492 # cd /usr/pkg/cross/powerpc-netbsd/include
5493 # mkdir powerpc
5494 # ln -s powerpc machine
5495 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5496 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00005497
wdenk2729af92004-05-03 20:45:30 +00005498Native builds *don't* work due to incompatibilities between native
5499and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00005500
wdenk2729af92004-05-03 20:45:30 +00005501Booting assumes that (the first part of) the image booted is a
5502stage-2 loader which in turn loads and then invokes the kernel
5503proper. Loader sources will eventually appear in the NetBSD source
5504tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00005505meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00005506
5507
wdenk2729af92004-05-03 20:45:30 +00005508Implementation Internals:
5509=========================
wdenkc6097192002-11-03 00:24:07 +00005510
wdenk2729af92004-05-03 20:45:30 +00005511The following is not intended to be a complete description of every
5512implementation detail. However, it should help to understand the
5513inner workings of U-Boot and make it easier to port it to custom
5514hardware.
wdenkc6097192002-11-03 00:24:07 +00005515
5516
wdenk2729af92004-05-03 20:45:30 +00005517Initial Stack, Global Data:
5518---------------------------
wdenkc6097192002-11-03 00:24:07 +00005519
wdenk2729af92004-05-03 20:45:30 +00005520The implementation of U-Boot is complicated by the fact that U-Boot
5521starts running out of ROM (flash memory), usually without access to
5522system RAM (because the memory controller is not initialized yet).
5523This means that we don't have writable Data or BSS segments, and BSS
5524is not initialized as zero. To be able to get a C environment working
5525at all, we have to allocate at least a minimal stack. Implementation
5526options for this are defined and restricted by the CPU used: Some CPU
5527models provide on-chip memory (like the IMMR area on MPC8xx and
5528MPC826x processors), on others (parts of) the data cache can be
5529locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00005530
Wolfgang Denk218ca722008-03-26 10:40:12 +01005531 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01005532 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00005533
wdenk2729af92004-05-03 20:45:30 +00005534 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
5535 From: "Chris Hallinan" <clh@net1plus.com>
5536 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
5537 ...
wdenk43d96162003-03-06 00:02:04 +00005538
wdenk2729af92004-05-03 20:45:30 +00005539 Correct me if I'm wrong, folks, but the way I understand it
5540 is this: Using DCACHE as initial RAM for Stack, etc, does not
5541 require any physical RAM backing up the cache. The cleverness
5542 is that the cache is being used as a temporary supply of
5543 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005544 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00005545 can see how this works by studying the cache architecture and
5546 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00005547
wdenk2729af92004-05-03 20:45:30 +00005548 OCM is On Chip Memory, which I believe the 405GP has 4K. It
5549 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005550 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00005551 option should work for you. Using CS 4 should be fine if your
5552 board designers haven't used it for something that would
5553 cause you grief during the initial boot! It is frequently not
5554 used.
wdenk43d96162003-03-06 00:02:04 +00005555
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005556 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00005557 with your processor/board/system design. The default value
5558 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02005559 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00005560 than your SDRAM module. If you have a 64MB SDRAM module, set
5561 it above 400_0000. Just make sure your board has no resources
5562 that are supposed to respond to that address! That code in
5563 start.S has been around a while and should work as is when
5564 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00005565
wdenk2729af92004-05-03 20:45:30 +00005566 -Chris Hallinan
5567 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00005568
wdenk2729af92004-05-03 20:45:30 +00005569It is essential to remember this, since it has some impact on the C
5570code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00005571
wdenk2729af92004-05-03 20:45:30 +00005572* Initialized global data (data segment) is read-only. Do not attempt
5573 to write it.
wdenkc6097192002-11-03 00:24:07 +00005574
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08005575* Do not use any uninitialized global data (or implicitly initialized
wdenk2729af92004-05-03 20:45:30 +00005576 as zero data - BSS segment) at all - this is undefined, initiali-
5577 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00005578
wdenk2729af92004-05-03 20:45:30 +00005579* Stack space is very limited. Avoid big data buffers or things like
5580 that.
wdenkc6097192002-11-03 00:24:07 +00005581
wdenk2729af92004-05-03 20:45:30 +00005582Having only the stack as writable memory limits means we cannot use
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08005583normal global data to share information between the code. But it
wdenk2729af92004-05-03 20:45:30 +00005584turned out that the implementation of U-Boot can be greatly
5585simplified by making a global data structure (gd_t) available to all
5586functions. We could pass a pointer to this data as argument to _all_
5587functions, but this would bloat the code. Instead we use a feature of
5588the GCC compiler (Global Register Variables) to share the data: we
5589place a pointer (gd) to the global data into a register which we
5590reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00005591
wdenk2729af92004-05-03 20:45:30 +00005592When choosing a register for such a purpose we are restricted by the
5593relevant (E)ABI specifications for the current architecture, and by
5594GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00005595
wdenk2729af92004-05-03 20:45:30 +00005596For PowerPC, the following registers have specific use:
5597 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01005598 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00005599 R3-R4: parameter passing and return values
5600 R5-R10: parameter passing
5601 R13: small data area pointer
5602 R30: GOT pointer
5603 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00005604
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01005605 (U-Boot also uses R12 as internal GOT pointer. r12
5606 is a volatile register so r12 needs to be reset when
5607 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00005608
Wolfgang Denke7670f62008-02-14 22:43:22 +01005609 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005610
wdenk2729af92004-05-03 20:45:30 +00005611 Note: on PPC, we could use a static initializer (since the
5612 address of the global data structure is known at compile time),
5613 but it turned out that reserving a register results in somewhat
5614 smaller code - although the code savings are not that big (on
5615 average for all boards 752 bytes for the whole U-Boot image,
5616 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00005617
wdenk2729af92004-05-03 20:45:30 +00005618On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00005619
wdenk2729af92004-05-03 20:45:30 +00005620 R0: function argument word/integer result
5621 R1-R3: function argument word
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02005622 R9: platform specific
5623 R10: stack limit (used only if stack checking is enabled)
wdenk2729af92004-05-03 20:45:30 +00005624 R11: argument (frame) pointer
5625 R12: temporary workspace
5626 R13: stack pointer
5627 R14: link register
5628 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00005629
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02005630 ==> U-Boot will use R9 to hold a pointer to the global data
5631
5632 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00005633
Thomas Chou0df01fd2010-05-21 11:08:03 +08005634On Nios II, the ABI is documented here:
5635 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
5636
5637 ==> U-Boot will use gp to hold a pointer to the global data
5638
5639 Note: on Nios II, we give "-G0" option to gcc and don't use gp
5640 to access small data sections, so gp is free.
5641
Macpaul Linafc1ce82011-10-19 20:41:11 +00005642On NDS32, the following registers are used:
5643
5644 R0-R1: argument/return
5645 R2-R5: argument
5646 R15: temporary register for assembler
5647 R16: trampoline register
5648 R28: frame pointer (FP)
5649 R29: global pointer (GP)
5650 R30: link register (LP)
5651 R31: stack pointer (SP)
5652 PC: program counter (PC)
5653
5654 ==> U-Boot will use R10 to hold a pointer to the global data
5655
Wolfgang Denkd87080b2006-03-31 18:32:53 +02005656NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5657or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00005658
wdenk2729af92004-05-03 20:45:30 +00005659Memory Management:
5660------------------
wdenkc6097192002-11-03 00:24:07 +00005661
wdenk2729af92004-05-03 20:45:30 +00005662U-Boot runs in system state and uses physical addresses, i.e. the
5663MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00005664
wdenk2729af92004-05-03 20:45:30 +00005665The available memory is mapped to fixed addresses using the memory
5666controller. In this process, a contiguous block is formed for each
5667memory type (Flash, SDRAM, SRAM), even when it consists of several
5668physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00005669
wdenk2729af92004-05-03 20:45:30 +00005670U-Boot is installed in the first 128 kB of the first Flash bank (on
5671TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5672booting and sizing and initializing DRAM, the code relocates itself
5673to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005674memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00005675configuration setting]. Below that, a structure with global Board
5676Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00005677
wdenk2729af92004-05-03 20:45:30 +00005678Additionally, some exception handler code is copied to the low 8 kB
5679of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00005680
wdenk2729af92004-05-03 20:45:30 +00005681So a typical memory configuration with 16 MB of DRAM could look like
5682this:
wdenkc6097192002-11-03 00:24:07 +00005683
wdenk2729af92004-05-03 20:45:30 +00005684 0x0000 0000 Exception Vector code
5685 :
5686 0x0000 1FFF
5687 0x0000 2000 Free for Application Use
5688 :
5689 :
wdenkc6097192002-11-03 00:24:07 +00005690
wdenk2729af92004-05-03 20:45:30 +00005691 :
5692 :
5693 0x00FB FF20 Monitor Stack (Growing downward)
5694 0x00FB FFAC Board Info Data and permanent copy of global data
5695 0x00FC 0000 Malloc Arena
5696 :
5697 0x00FD FFFF
5698 0x00FE 0000 RAM Copy of Monitor Code
5699 ... eventually: LCD or video framebuffer
5700 ... eventually: pRAM (Protected RAM - unchanged by reset)
5701 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00005702
5703
wdenk2729af92004-05-03 20:45:30 +00005704System Initialization:
5705----------------------
wdenkc6097192002-11-03 00:24:07 +00005706
wdenk2729af92004-05-03 20:45:30 +00005707In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005708(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08005709configuration for CS0# this is a mirror of the on board Flash memory.
wdenk2729af92004-05-03 20:45:30 +00005710To be able to re-map memory U-Boot then jumps to its link address.
5711To be able to implement the initialization code in C, a (small!)
5712initial stack is set up in the internal Dual Ported RAM (in case CPUs
5713which provide such a feature like MPC8xx or MPC8260), or in a locked
5714part of the data cache. After that, U-Boot initializes the CPU core,
5715the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00005716
wdenk2729af92004-05-03 20:45:30 +00005717Next, all (potentially) available memory banks are mapped using a
5718preliminary mapping. For example, we put them on 512 MB boundaries
5719(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5720on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5721programmed for SDRAM access. Using the temporary configuration, a
5722simple memory test is run that determines the size of the SDRAM
5723banks.
wdenkc6097192002-11-03 00:24:07 +00005724
wdenk2729af92004-05-03 20:45:30 +00005725When there is more than one SDRAM bank, and the banks are of
5726different size, the largest is mapped first. For equal size, the first
5727bank (CS2#) is mapped first. The first mapping is always for address
57280x00000000, with any additional banks following immediately to create
5729contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00005730
wdenk2729af92004-05-03 20:45:30 +00005731Then, the monitor installs itself at the upper end of the SDRAM area
5732and allocates memory for use by malloc() and for the global Board
5733Info data; also, the exception vector code is copied to the low RAM
5734pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00005735
wdenk2729af92004-05-03 20:45:30 +00005736Only after this relocation will you have a "normal" C environment;
5737until that you are restricted in several ways, mostly because you are
5738running from ROM, and because the code will have to be relocated to a
5739new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00005740
5741
wdenk2729af92004-05-03 20:45:30 +00005742U-Boot Porting Guide:
5743----------------------
wdenkc6097192002-11-03 00:24:07 +00005744
wdenk2729af92004-05-03 20:45:30 +00005745[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
5746list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00005747
5748
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005749int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00005750{
5751 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00005752
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005753 signal(SIGALRM, no_more_time);
5754 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00005755
wdenk2729af92004-05-03 20:45:30 +00005756 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005757 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00005758 return 0;
5759 }
5760
wdenk2729af92004-05-03 20:45:30 +00005761 Download latest U-Boot source;
5762
Wolfgang Denk06682362008-12-30 22:56:11 +01005763 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00005764
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005765 if (clueless)
5766 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00005767
wdenk2729af92004-05-03 20:45:30 +00005768 while (learning) {
5769 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005770 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
5771 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00005772 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005773 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00005774 }
wdenkc6097192002-11-03 00:24:07 +00005775
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005776 if (available_money > toLocalCurrency ($2500))
5777 Buy a BDI3000;
5778 else
wdenk2729af92004-05-03 20:45:30 +00005779 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005780
5781 if (a similar board exists) { /* hopefully... */
5782 cp -a board/<similar> board/<myboard>
5783 cp include/configs/<similar>.h include/configs/<myboard>.h
5784 } else {
5785 Create your own board support subdirectory;
5786 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00005787 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005788 Edit new board/<myboard> files
5789 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00005790
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005791 while (!accepted) {
5792 while (!running) {
5793 do {
5794 Add / modify source code;
5795 } until (compiles);
5796 Debug;
5797 if (clueless)
5798 email("Hi, I am having problems...");
5799 }
5800 Send patch file to the U-Boot email list;
5801 if (reasonable critiques)
5802 Incorporate improvements from email list code review;
5803 else
5804 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00005805 }
wdenkc6097192002-11-03 00:24:07 +00005806
wdenk2729af92004-05-03 20:45:30 +00005807 return 0;
5808}
5809
5810void no_more_time (int sig)
5811{
5812 hire_a_guru();
5813}
wdenkc6097192002-11-03 00:24:07 +00005814
5815
wdenk2729af92004-05-03 20:45:30 +00005816Coding Standards:
5817-----------------
wdenkc6097192002-11-03 00:24:07 +00005818
wdenk2729af92004-05-03 20:45:30 +00005819All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02005820coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005821"scripts/Lindent" in your Linux kernel source directory.
wdenk2729af92004-05-03 20:45:30 +00005822
Detlev Zundel2c051652006-09-01 15:39:02 +02005823Source files originating from a different project (for example the
5824MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08005825reformatted to ease subsequent migration to newer versions of those
Detlev Zundel2c051652006-09-01 15:39:02 +02005826sources.
5827
5828Please note that U-Boot is implemented in C (and to some small parts in
5829Assembler); no C++ is used, so please do not use C++ style comments (//)
5830in your code.
wdenk2729af92004-05-03 20:45:30 +00005831
5832Please also stick to the following formatting rules:
5833- remove any trailing white space
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005834- use TAB characters for indentation and vertical alignment, not spaces
wdenk2729af92004-05-03 20:45:30 +00005835- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005836- do not add more than 2 consecutive empty lines to source files
wdenk2729af92004-05-03 20:45:30 +00005837- do not add trailing empty lines to source files
5838
5839Submissions which do not conform to the standards may be returned
5840with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00005841
5842
wdenk2729af92004-05-03 20:45:30 +00005843Submitting Patches:
5844-------------------
wdenkc6097192002-11-03 00:24:07 +00005845
wdenk2729af92004-05-03 20:45:30 +00005846Since the number of patches for U-Boot is growing, we need to
5847establish some rules. Submissions which do not conform to these rules
5848may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00005849
Magnus Lilja0d28f342008-08-06 19:32:33 +02005850Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01005851
Wolfgang Denk06682362008-12-30 22:56:11 +01005852Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
5853see http://lists.denx.de/mailman/listinfo/u-boot
5854
wdenk2729af92004-05-03 20:45:30 +00005855When you send a patch, please include the following information with
5856it:
wdenkc6097192002-11-03 00:24:07 +00005857
wdenk2729af92004-05-03 20:45:30 +00005858* For bug fixes: a description of the bug and how your patch fixes
5859 this bug. Please try to include a way of demonstrating that the
5860 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00005861
wdenk2729af92004-05-03 20:45:30 +00005862* For new features: a description of the feature and your
5863 implementation.
wdenkc6097192002-11-03 00:24:07 +00005864
wdenk2729af92004-05-03 20:45:30 +00005865* A CHANGELOG entry as plaintext (separate from the patch)
5866
Robert P. J. Day7207b362015-12-19 07:16:10 -05005867* For major contributions, add a MAINTAINERS file with your
5868 information and associated file and directory references.
wdenk2729af92004-05-03 20:45:30 +00005869
Albert ARIBAUD27af9302013-09-11 15:52:51 +02005870* When you add support for a new board, don't forget to add a
5871 maintainer e-mail address to the boards.cfg file, too.
wdenk2729af92004-05-03 20:45:30 +00005872
5873* If your patch adds new configuration options, don't forget to
5874 document these in the README file.
5875
Wolfgang Denk218ca722008-03-26 10:40:12 +01005876* The patch itself. If you are using git (which is *strongly*
5877 recommended) you can easily generate the patch using the
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005878 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denk218ca722008-03-26 10:40:12 +01005879 the U-Boot mailing list, you will avoid most of the common problems
5880 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00005881
Wolfgang Denk218ca722008-03-26 10:40:12 +01005882 If you cannot use git, use "diff -purN OLD NEW". If your version of
5883 diff does not support these options, then get the latest version of
5884 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00005885
Wolfgang Denk218ca722008-03-26 10:40:12 +01005886 The current directory when running this command shall be the parent
5887 directory of the U-Boot source tree (i. e. please make sure that
5888 your patch includes sufficient directory information for the
5889 affected files).
5890
5891 We prefer patches as plain text. MIME attachments are discouraged,
5892 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00005893
5894* If one logical set of modifications affects or creates several
5895 files, all these changes shall be submitted in a SINGLE patch file.
5896
5897* Changesets that contain different, unrelated modifications shall be
5898 submitted as SEPARATE patches, one patch per changeset.
5899
5900
5901Notes:
5902
Simon Glass6de80f22016-07-27 20:33:08 -06005903* Before sending the patch, run the buildman script on your patched
wdenk2729af92004-05-03 20:45:30 +00005904 source tree and make sure that no errors or warnings are reported
5905 for any of the boards.
5906
5907* Keep your modifications to the necessary minimum: A patch
5908 containing several unrelated changes or arbitrary reformats will be
5909 returned with a request to re-formatting / split it.
5910
5911* If you modify existing code, make sure that your new code does not
5912 add to the memory footprint of the code ;-) Small is beautiful!
5913 When adding new features, these should compile conditionally only
5914 (using #ifdef), and the resulting code with the new feature
5915 disabled must not need more memory than the old code without your
5916 modification.
wdenk90dc6702005-05-03 14:12:25 +00005917
Wolfgang Denk06682362008-12-30 22:56:11 +01005918* Remember that there is a size limit of 100 kB per message on the
5919 u-boot mailing list. Bigger patches will be moderated. If they are
5920 reasonable and not too big, they will be acknowledged. But patches
5921 bigger than the size limit should be avoided.