blob: 99ee448a5ecd63e9f328a562dc533451a0d9d501 [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Wolfgang Denk1234ce72013-06-21 10:22:36 +02002# (C) Copyright 2000 - 2013
wdenkc6097192002-11-03 00:24:07 +00003# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4#
Wolfgang Denk1234ce72013-06-21 10:22:36 +02005# SPDX-License-Identifier: GPL-2.0+
wdenkc6097192002-11-03 00:24:07 +00006#
7
8Summary:
9========
10
wdenk24ee89b2002-11-03 17:56:27 +000011This directory contains the source code for U-Boot, a boot loader for
wdenkce4832c2004-10-17 21:12:06 +000012Embedded boards based on PowerPC, ARM, MIPS and several other
13processors, which can be installed in a boot ROM and used to
14initialize and test the hardware or to download and run application
15code.
wdenkc6097192002-11-03 00:24:07 +000016
17The development of U-Boot is closely related to Linux: some parts of
wdenk24ee89b2002-11-03 17:56:27 +000018the source code originate in the Linux source tree, we have some
19header files in common, and special provision has been made to
wdenkc6097192002-11-03 00:24:07 +000020support booting of Linux images.
21
22Some attention has been paid to make this software easily
23configurable and extendable. For instance, all monitor commands are
24implemented with the same call interface, so that it's very easy to
25add new commands. Also, instead of permanently adding rarely used
26code (for instance hardware test utilities) to the monitor, you can
27load and run it dynamically.
28
29
30Status:
31=======
32
33In general, all boards for which a configuration option exists in the
wdenk24ee89b2002-11-03 17:56:27 +000034Makefile have been tested to some extent and can be considered
wdenkc6097192002-11-03 00:24:07 +000035"working". In fact, many of them are used in production systems.
36
Robert P. J. Day076ed9b2015-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. Day076ed9b2015-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. Day974ed2f2012-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. Day076ed9b2015-12-19 07:16:10 -050053U-Boot, you should send a message to the U-Boot mailing list at
Peter Tyser8804a612008-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 Denkb240aef2008-03-26 10:40:12 +010060Where to get source code:
61=========================
62
Robert P. J. Day076ed9b2015-12-19 07:16:10 -050063The U-Boot source code is maintained in the Git repository at
Wolfgang Denkb240aef2008-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 Ziswilerabd8dcb2008-07-09 08:17:15 +020068any version you might be interested in. Official releases are also
Wolfgang Denkb240aef2008-03-26 10:40:12 +010069available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
70directory.
71
Anatolij Gustschin08337f32008-03-26 18:13:33 +010072Pre-built (and tested) images are available from
Wolfgang Denkb240aef2008-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 Ziswilerabd8dcb2008-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 Liljaf3b287b2008-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:
wdenkc6097192002-11-03 00:24:07 +0000112
wdenk24ee89b2002-11-03 17:56:27 +0000113 U_BOOT_VERSION u_boot_logo
114 IH_OS_U_BOOT u_boot_hush_start
115
wdenkc6097192002-11-03 00:24:07 +0000116
wdenk7474aca2002-12-17 17:55:09 +0000117Versioning:
118===========
119
Thomas Webere89e6282010-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.
wdenk7474aca2002-12-17 17:55:09 +0000126
Thomas Webere89e6282010-09-28 08:06:25 +0200127Examples:
Wolfgang Denk092ae952011-10-26 10:21:21 +0000128 U-Boot v2009.11 - Release November 2009
Thomas Webere89e6282010-09-28 08:06:25 +0200129 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
Jelle van der Waa30245ca2016-10-30 17:30:30 +0100130 U-Boot v2010.09-rc1 - Release candidate 1 for September 2010 release
wdenk7474aca2002-12-17 17:55:09 +0000131
132
wdenkc6097192002-11-03 00:24:07 +0000133Directory Hierarchy:
134====================
135
Peter Tysere4d1abc2010-04-12 22:28:21 -0500136/arch Architecture specific files
Masahiro Yamadaef6ebff2014-03-07 18:02:02 +0900137 /arc Files generic to ARC architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500138 /arm Files generic to ARM architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500139 /avr32 Files generic to AVR32 architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500140 /m68k Files generic to m68k architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500141 /microblaze Files generic to microblaze architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500142 /mips Files generic to MIPS architecture
Macpaul Lin1cac36e2011-10-19 20:41:11 +0000143 /nds32 Files generic to NDS32 architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500144 /nios2 Files generic to Altera NIOS2 architecture
Robert P. J. Daya269c932013-09-15 18:34:15 -0400145 /openrisc Files generic to OpenRISC architecture
Stefan Roese88fbf932010-04-15 16:07:28 +0200146 /powerpc Files generic to PowerPC architecture
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500147 /sandbox Files generic to HW-independent "sandbox"
Peter Tysere4d1abc2010-04-12 22:28:21 -0500148 /sh Files generic to SH architecture
Robert P. J. Daya269c932013-09-15 18:34:15 -0400149 /x86 Files generic to x86 architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500150/api Machine/arch independent API for external apps
151/board Board dependent files
Xu Ziyuanfb1f9392016-08-26 19:54:49 +0800152/cmd U-Boot commands functions
Peter Tysere4d1abc2010-04-12 22:28:21 -0500153/common Misc architecture independent functions
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500154/configs Board default configuration files
Peter Tysere4d1abc2010-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. Daya269c932013-09-15 18:34:15 -0400158/dts Contains Makefile for building internal U-Boot fdt.
Peter Tysere4d1abc2010-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. Day076ed9b2015-12-19 07:16:10 -0500162/lib Library routines generic to all architectures
163/Licenses Various license files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500164/net Networking code
165/post Power On Self Test
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500166/scripts Various build scripts and Makefiles
167/test Various unit test files
Peter Tysere4d1abc2010-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-VILLARD03836942008-10-16 15:01:15 +0200185 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000186
Robert P. J. Day076ed9b2015-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 Freyther7ba4e572014-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 Freyther7ba4e572014-08-04 09:26:05 +0200203 make TQM823L_defconfig
wdenkc6097192002-11-03 00:24:07 +0000204
Robert P. J. Day076ed9b2015-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 Glass53552c92014-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 Teki287314f2014-08-31 21:19:43 +0530217See board/sandbox/README.sandbox for more details.
Simon Glass53552c92014-03-22 17:12:59 -0600218
219
Simon Glassd8711af2015-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. Day076ed9b2015-12-19 07:16:10 -0500224SPL and U-Boot proper (i.e. they both follow the same rules).
225
226Note: "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.
Simon Glassd8711af2015-03-03 08:03:00 -0700233
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500234Execution 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 Glassd8711af2015-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 Tan48fcc4a2017-05-03 17:13:32 +0800295 done by selecting CONFIG_SPL_BOARD_INIT and then supplying a
Simon Glassd8711af2015-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
wdenk1272e232002-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 Phillips203fee32007-08-10 13:28:25 -0500319- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000320
Kim Phillips203fee32007-08-10 13:28:25 -0500321- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk994ad962006-10-24 14:42:37 +0200322
323- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen9d5a43f2007-11-01 12:44:20 +0100324 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000325
Lei Wen20014762011-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 Galaf4fb90f2011-02-18 05:40:54 -0600331- 85xx CPU Options:
York Sun2394a0f2012-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 Galaf4fb90f2011-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 Gala179b1b22011-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 Wood80806962012-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 Kushwahad324f472013-04-16 13:27:44 +0530369 CONFIG_A003399_NOR_WORKAROUND
370 Enables a workaround for IFC erratum A003399. It is only
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800371 required during NOR boot.
Prabhakar Kushwahad324f472013-04-16 13:27:44 +0530372
Prabhakar Kushwahac4c10d12014-10-29 22:33:09 +0530373 CONFIG_A008044_WORKAROUND
374 Enables a workaround for T1040/T1042 erratum A008044. It is only
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800375 required during NAND boot and valid for Rev 1.0 SoC revision
Prabhakar Kushwahac4c10d12014-10-29 22:33:09 +0530376
Scott Wood80806962012-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 Jainc73b9032013-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 Jainf81e8b22013-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 Jainc73b9032013-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 Jainf81e8b22013-04-04 09:31:54 +0530394 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
395 This value denotes start offset of DSP CCSR space.
396
Priyanka Jaine9dcaa82013-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 Bansal8bcbc272014-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 Meng75574052016-02-05 19:30:11 -0800404 time of U-Boot entry and is required to be re-initialized.
Aneesh Bansal8bcbc272014-03-18 23:40:26 +0530405
Tang Yuantiana7364af2014-04-17 15:33:46 +0800406 CONFIG_DEEP_SLEEP
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800407 Indicates this SoC supports deep sleep feature. If deep sleep is
Tang Yuantiana7364af2014-04-17 15:33:46 +0800408 supported, core will start to execute uboot when wakes up.
409
Daniel Schwierzeckd8a49ca2012-04-02 02:57:56 +0000410- Generic CPU options:
York Sun021d2022014-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 Schwierzeckd8a49ca2012-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 Sunf0626592013-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 Sun2896cb72014-03-27 17:54:47 -0700443 CONFIG_SYS_FSL_DDRC_GEN4
444 Freescale DDR4 controller.
445
York Sun461c9392013-09-30 14:20:51 -0700446 CONFIG_SYS_FSL_DDRC_ARM_GEN3
447 Freescale DDR3 controller for ARM-based SoCs.
448
York Sunf0626592013-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. Day8d56db92016-07-15 13:44:45 -0400455 Board config to use DDR2. It can be enabled for SoCs with
York Sunf0626592013-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 Sun2896cb72014-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 Sunf0626592013-09-30 09:22:09 -0700470
Prabhakar Kushwaha62908c22014-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 Kushwaha3c48f582017-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 Kushwahabedc5622017-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 Kushwaha950f2f72014-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 Kushwaha2c27f122014-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 Sun29647ab2014-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 Sun3a0916d2014-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 Sunc459ae62014-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 Sun79a779b2014-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 Kushwaha122bcfd2015-11-09 16:42:07 +0530518 CONFIG_SYS_FSL_HAS_DP_DDR
519 Defines the SoC has DP-DDR used for DPAA.
520
Ruchika Guptabb7143b2014-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 Schwierzeckd52a6232011-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 Riesch48c2d6d2012-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 Sun77a10972015-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 Warren8d1fb312015-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
wdenk9b7f3842003-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 Denkb240aef2008-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
wdenk9b7f3842003-10-09 20:09:04 +0000594 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
595
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800596 When transferring memsize parameter to Linux, some versions
wdenk9b7f3842003-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 Barenfcd91bb2008-06-03 20:34:45 -0400600 CONFIG_OF_LIBFDT
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200601
602 New kernel versions are expecting firmware settings to be
Gerald Van Barend6abef42007-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 Phillips9b46eb62007-08-10 14:34:14 -0500609 * The bootm command automatically updates the fdt
Gerald Van Barend6abef42007-03-31 12:23:51 -0400610
Marcel Ziswilerb29bc712009-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 Denk27a5b0b2005-10-13 01:45:54 +0200615 OF_TBCLK - The timebase frequency.
Kumar Galae40c2b52006-01-11 13:59:02 -0600616 OF_STDOUT_PATH - The path to the console device
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200617
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200618 boards with QUICC Engines require OF_QE to set UCC MAC
619 addresses
Kim Phillips9b46eb62007-08-10 14:34:14 -0500620
Kumar Gala1e26aa52006-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
wdenkda04a8b2004-08-02 23:22:59 +0000625
Simon Glass6c0be912014-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 Schocherffb293a2009-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 Grinberg06890672011-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 Giger0ab978d2008-11-03 22:13:47 +0100652- vxWorks boot parameters:
653
654 bootvx constructs a valid bootline using the following
Bin Mengfb694b92015-10-07 20:19:17 -0700655 environments variables: bootdev, bootfile, ipaddr, netmask,
656 serverip, gatewayip, hostname, othbootargs.
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100657 It loads the vxWorks image pointed bootfile.
658
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100659 Note: If a "bootargs" environment is defined, it will overwride
660 the defaults discussed just above.
661
Aneesh V960f5c02011-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 V686a0752011-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
wdenkda04a8b2004-08-02 23:22:59 +0000673- Serial Ports:
Andreas Engel0813b122008-09-08 14:30:53 +0200674 CONFIG_PL010_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000675
676 Define this if you want support for Amba PrimeCell PL010 UARTs.
677
Andreas Engel0813b122008-09-08 14:30:53 +0200678 CONFIG_PL011_SERIAL
wdenkda04a8b2004-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, Muralidharancbc08882014-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
wdenkda04a8b2004-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-VILLARD03836942008-10-16 15:01:15 +0200701 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000702
wdenkc6097192002-11-03 00:24:07 +0000703- Autoboot Command:
704 CONFIG_BOOTCOMMAND
705 Only needed when CONFIG_BOOTDELAY is enabled;
706 define a command string that is automatically executed
707 when no character is read on the console interface
708 within "Boot Delay" after reset.
709
710 CONFIG_BOOTARGS
wdenk4a5c8a72003-03-06 00:02:04 +0000711 This can be used to pass arguments to the bootm
712 command. The value of CONFIG_BOOTARGS goes into the
713 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000714
715 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk4a5c8a72003-03-06 00:02:04 +0000716 The value of these goes into the environment as
717 "ramboot" and "nfsboot" respectively, and can be used
718 as a convenience, when switching between booting from
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200719 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000720
Heiko Schocher040c5c32013-11-04 14:04:59 +0100721- Bootcount:
722 CONFIG_BOOTCOUNT_LIMIT
723 Implements a mechanism for detecting a repeating reboot
724 cycle, see:
725 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
726
727 CONFIG_BOOTCOUNT_ENV
728 If no softreset save registers are found on the hardware
729 "bootcount" is stored in the environment. To prevent a
730 saveenv on all reboots, the environment variable
731 "upgrade_available" is used. If "upgrade_available" is
732 0, "bootcount" is always 0, if "upgrade_available" is
733 1 "bootcount" is incremented in the environment.
734 So the Userspace Applikation must set the "upgrade_available"
735 and "bootcount" variable to 0, if a boot was successfully.
736
wdenkc6097192002-11-03 00:24:07 +0000737- Pre-Boot Commands:
738 CONFIG_PREBOOT
739
740 When this option is #defined, the existence of the
741 environment variable "preboot" will be checked
742 immediately before starting the CONFIG_BOOTDELAY
743 countdown and/or running the auto-boot command resp.
744 entering interactive mode.
745
746 This feature is especially useful when "preboot" is
747 automatically generated or modified. For an example
748 see the LWMON board specific code: here "preboot" is
749 modified when the user holds down a certain
750 combination of keys on the (special) keyboard when
751 booting the systems
752
753- Serial Download Echo Mode:
754 CONFIG_LOADS_ECHO
755 If defined to 1, all characters received during a
756 serial download (using the "loads" command) are
757 echoed back. This might be needed by some terminal
758 emulations (like "cu"), but may as well just take
759 time on others. This setting #define's the initial
760 value of the "loads_echo" environment variable.
761
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500762- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000763 CONFIG_KGDB_BAUDRATE
764 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200765 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000766
767- Monitor Functions:
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500768 Monitor commands can be included or excluded
769 from the build by using the #include files
Stephen Warren963a7cf2012-08-05 16:07:19 +0000770 <config_cmd_all.h> and #undef'ing unwanted
Joe Hershberger5a9d7f12015-06-22 16:15:30 -0500771 commands, or adding #define's for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000772
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500773 The default command configuration includes all commands
774 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000775
Marek Vasutc4d8a1b2014-03-05 19:58:39 +0100776 CONFIG_CMD_AES AES 128 CBC encrypt/decrypt
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500777 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500778 CONFIG_CMD_BDI bdinfo
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500779 CONFIG_CMD_BOOTD bootd
Tom Rini5ce62cd2014-08-14 06:42:36 -0400780 CONFIG_CMD_BOOTI * ARM64 Linux kernel Image support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500781 CONFIG_CMD_CACHE * icache, dcache
782 CONFIG_CMD_CONSOLE coninfo
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500783 CONFIG_CMD_DHCP * DHCP support
784 CONFIG_CMD_DIAG * Diagnostics
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500785 CONFIG_CMD_ECHO echo arguments
Peter Tyser0deafa22009-10-25 15:12:56 -0500786 CONFIG_CMD_EDITENV edit env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500787 CONFIG_CMD_ELF * bootelf, bootvx
Andrew Ruder94463402013-10-22 19:07:34 -0500788 CONFIG_CMD_ENV_EXISTS * check existence of env variable
Mike Frysingerf3ddf202010-12-26 23:09:45 -0500789 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren4f8662d2012-10-22 06:43:50 +0000790 CONFIG_CMD_EXT2 * ext2 command support
791 CONFIG_CMD_EXT4 * ext4 command support
Stephen Warren3d5a3882014-01-24 20:46:37 -0700792 CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls)
793 that work for multiple fs types
Christian Gmeiner9f9eec32014-11-12 14:35:04 +0100794 CONFIG_CMD_FS_UUID * Look up a filesystem UUID
Mike Frysinger78dcaf42009-01-28 19:08:14 -0500795 CONFIG_CMD_SAVEENV saveenv
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500796 CONFIG_CMD_FLASH flinfo, erase, protect
797 CONFIG_CMD_FPGA FPGA device initialization support
Mike Frysinger2ed02412010-12-26 23:32:22 -0500798 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsf0c9d532011-04-05 07:15:14 +0000799 CONFIG_CMD_GREPENV * search environment
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500800 CONFIG_CMD_I2C * I2C serial bus support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500801 CONFIG_CMD_IMI iminfo
Vipin Kumar3df41b12012-12-16 22:32:48 +0000802 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200803 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Mike Frysingerf3ddf202010-12-26 23:09:45 -0500804 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershberger0fd32d72012-10-03 11:15:51 +0000805 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500806 CONFIG_CMD_ITEST Integer/string test of 2 values
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200807 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerb35a3a62012-05-23 08:00:12 +0000808 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
809 (169.254.*.*)
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500810 CONFIG_CMD_LOADB loadb
811 CONFIG_CMD_LOADS loads
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200812 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz93d6cb02009-07-27 00:07:59 -0400813 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glasseacd14f2012-11-30 13:01:20 +0000814 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500815 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denk9d009282013-03-08 10:51:32 +0000816 loop, loopw
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200817 CONFIG_CMD_MEMTEST * mtest
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500818 CONFIG_CMD_MISC Misc functions like sleep etc
819 CONFIG_CMD_MMC * MMC memory mapped support
820 CONFIG_CMD_MII * MII utility commands
Stefan Roeseb1423dd2009-03-19 13:30:36 +0100821 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500822 CONFIG_CMD_NAND * NAND support
823 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200824 CONFIG_CMD_NFS NFS support
Peter Tyser9902e422008-12-17 16:36:21 -0600825 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denk092ae952011-10-26 10:21:21 +0000826 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500827 CONFIG_CMD_PCI * pciinfo
828 CONFIG_CMD_PCMCIA * PCMCIA support
829 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
830 host
831 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersc889fb42012-12-05 14:46:30 +0000832 CONFIG_CMD_READ * Read raw data from partition
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500833 CONFIG_CMD_REGINFO * Register dump
834 CONFIG_CMD_RUN run command in env variable
Simon Glassbf6ce792012-12-26 09:53:36 +0000835 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500836 CONFIG_CMD_SAVES * save S record dump
Simon Glass8706b812016-05-01 11:36:02 -0600837 CONFIG_SCSI * SCSI Support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500838 CONFIG_CMD_SDRAM * print SDRAM configuration information
839 (requires CONFIG_CMD_I2C)
840 CONFIG_CMD_SETGETDCR Support for DCR Register access
841 (4xx only)
Eric Nelson97f5f8f2012-01-31 10:52:08 -0700842 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Bob Liua671b702013-02-05 19:05:41 +0800843 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk85c25df2009-04-01 23:34:12 +0200844 CONFIG_CMD_SOURCE "source" command Support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500845 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7aa81a42011-05-17 00:03:40 +0000846 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass6a398d22011-10-24 18:00:07 +0000847 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershberger59f3f522012-10-03 12:14:57 +0000848 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
849 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500850 CONFIG_CMD_USB * USB support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500851 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasut71729392012-03-31 07:47:16 +0000852 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200853 CONFIG_CMD_XIMG Load part of Multi Image
Przemyslaw Marczak2eb40ee2014-04-02 10:20:05 +0200854 CONFIG_CMD_UUID * Generate random UUID or GUID string
wdenkc6097192002-11-03 00:24:07 +0000855
856 EXAMPLE: If you want all functions except of network
857 support you can write:
858
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500859 #include "config_cmd_all.h"
860 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000861
Gerald Van Barend6abef42007-03-31 12:23:51 -0400862 Other Commands:
863 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000864
865 Note: Don't enable the "icache" and "dcache" commands
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500866 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk4a5c8a72003-03-06 00:02:04 +0000867 what you (and your U-Boot users) are doing. Data
Heiko Schocher65d94db2017-06-07 17:33:09 +0200868 cache cannot be enabled on systems like the
wdenk4a5c8a72003-03-06 00:02:04 +0000869 8260 (where accesses to the IMMR region must be
870 uncached), and it cannot be disabled on all other
871 systems where we (mis-) use the data cache to hold an
872 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000873
874
875 XXX - this list needs to get updated!
876
Simon Glassaa34ef22016-03-13 19:07:28 -0600877- Removal of commands
878 If no commands are needed to boot, you can disable
879 CONFIG_CMDLINE to remove them. In this case, the command line
880 will not be available, and when U-Boot wants to execute the
881 boot command (on start-up) it will call board_run_command()
882 instead. This can reduce image size significantly for very
883 simple boot procedures.
884
Wolfgang Denk2aceea12013-03-23 23:50:31 +0000885- Regular expression support:
886 CONFIG_REGEX
Wolfgang Denkec7fbf52013-10-04 17:43:24 +0200887 If this variable is defined, U-Boot is linked against
888 the SLRE (Super Light Regular Expression) library,
889 which adds regex support to some commands, as for
890 example "env grep" and "setexpr".
Wolfgang Denk2aceea12013-03-23 23:50:31 +0000891
Simon Glass3d686442011-10-15 05:48:20 +0000892- Device tree:
893 CONFIG_OF_CONTROL
894 If this variable is defined, U-Boot will use a device tree
895 to configure its devices, instead of relying on statically
896 compiled #defines in the board file. This option is
897 experimental and only available on a few boards. The device
898 tree is available in the global data as gd->fdt_blob.
899
Simon Glass5cb34db2011-10-24 19:15:31 +0000900 U-Boot needs to get its device tree from somewhere. This can
Alex Deymo5b661ec2017-04-02 01:25:20 -0700901 be done using one of the three options below:
Simon Glass38d6b8d2011-10-15 05:48:21 +0000902
903 CONFIG_OF_EMBED
904 If this variable is defined, U-Boot will embed a device tree
905 binary in its image. This device tree file should be in the
906 board directory and called <soc>-<board>.dts. The binary file
907 is then picked up in board_init_f() and made available through
908 the global data structure as gd->blob.
Simon Glass3d686442011-10-15 05:48:20 +0000909
Simon Glass5cb34db2011-10-24 19:15:31 +0000910 CONFIG_OF_SEPARATE
911 If this variable is defined, U-Boot will build a device tree
912 binary. It will be called u-boot.dtb. Architecture-specific
913 code will locate it at run-time. Generally this works by:
914
915 cat u-boot.bin u-boot.dtb >image.bin
916
917 and in fact, U-Boot does this for you, creating a file called
918 u-boot-dtb.bin which is useful in the common case. You can
919 still use the individual files if you need something more
920 exotic.
921
Alex Deymo5b661ec2017-04-02 01:25:20 -0700922 CONFIG_OF_BOARD
923 If this variable is defined, U-Boot will use the device tree
924 provided by the board at runtime instead of embedding one with
925 the image. Only boards defining board_fdt_blob_setup() support
926 this option (see include/fdtdec.h file).
927
wdenkc6097192002-11-03 00:24:07 +0000928- Watchdog:
929 CONFIG_WATCHDOG
930 If this variable is defined, it enables watchdog
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +0000931 support for the SoC. There must be support in the SoC
Heiko Schocher71cb3e92017-06-07 17:33:10 +0200932 specific code for a watchdog. When supported for a
933 specific SoC is available, then no further board specific
934 code should be needed to use it.
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +0000935
936 CONFIG_HW_WATCHDOG
937 When using a watchdog circuitry external to the used
938 SoC, then define this variable and provide board
939 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000940
Heiko Schocher735326c2015-01-21 08:38:22 +0100941 CONFIG_AT91_HW_WDT_TIMEOUT
942 specify the timeout in seconds. default 2 seconds.
943
stroeseb9c17c52003-04-04 15:53:41 +0000944- U-Boot Version:
945 CONFIG_VERSION_VARIABLE
946 If this variable is defined, an environment variable
947 named "ver" is created by U-Boot showing the U-Boot
948 version as printed by the "version" command.
Benoît Thébaudeauce9a1552012-08-13 15:01:14 +0200949 Any change to this variable will be reverted at the
950 next reset.
stroeseb9c17c52003-04-04 15:53:41 +0000951
wdenkc6097192002-11-03 00:24:07 +0000952- Real-Time Clock:
953
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500954 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000955 has to be selected, too. Define exactly one of the
956 following options:
957
wdenkc6097192002-11-03 00:24:07 +0000958 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam3f8d1782011-10-24 06:44:15 +0000959 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +0000960 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1fe2c702003-03-06 21:55:29 +0000961 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000962 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk0893c472003-05-20 14:25:27 +0000963 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel90491f22014-07-21 11:06:16 +0200964 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenkef5fe752003-03-12 10:41:04 +0000965 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krillb27939b2008-03-15 15:40:26 +0100966 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenkaeba06f2004-06-09 17:34:58 +0000967 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Chris Packham2d3ac512017-05-30 12:03:33 +1200968 CONFIG_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher1f1b7012011-03-28 09:24:22 +0200969 CONFIG_SYS_RV3029_TCR - enable trickle charger on
970 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +0000971
wdenkb9bbd242003-06-30 16:24:52 +0000972 Note that if the RTC uses I2C, then the I2C interface
973 must also be configured. See I2C Support, below.
974
Peter Tyser9902e422008-12-17 16:36:21 -0600975- GPIO Support:
976 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tyser9902e422008-12-17 16:36:21 -0600977
Chris Packham9b383202010-12-19 10:12:13 +0000978 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
979 chip-ngpio pairs that tell the PCA953X driver the number of
980 pins supported by a particular chip.
981
Peter Tyser9902e422008-12-17 16:36:21 -0600982 Note that if the GPIO device uses I2C, then the I2C interface
983 must also be configured. See I2C Support, below.
984
Simon Glass4dc47ca2014-06-11 23:29:41 -0600985- I/O tracing:
986 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
987 accesses and can checksum them or write a list of them out
988 to memory. See the 'iotrace' command for details. This is
989 useful for testing device drivers since it can confirm that
990 the driver behaves the same way before and after a code
991 change. Currently this is supported on sandbox and arm. To
992 add support for your architecture, add '#include <iotrace.h>'
993 to the bottom of arch/<arch>/include/asm/io.h and test.
994
995 Example output from the 'iotrace stats' command is below.
996 Note that if the trace buffer is exhausted, the checksum will
997 still continue to operate.
998
999 iotrace is enabled
1000 Start: 10000000 (buffer start address)
1001 Size: 00010000 (buffer size)
1002 Offset: 00000120 (current buffer offset)
1003 Output: 10000120 (start + offset)
1004 Count: 00000018 (number of trace records)
1005 CRC32: 9526fb66 (CRC32 of all trace records)
1006
wdenkc6097192002-11-03 00:24:07 +00001007- Timestamp Support:
1008
wdenk4a5c8a72003-03-06 00:02:04 +00001009 When CONFIG_TIMESTAMP is selected, the timestamp
1010 (date and time) of an image is printed by image
1011 commands like bootm or iminfo. This option is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001012 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001013
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001014- Partition Labels (disklabels) Supported:
1015 Zero or more of the following:
1016 CONFIG_MAC_PARTITION Apple's MacOS partition table.
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001017 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1018 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1019 bootloader. Note 2TB partition limit; see
1020 disk/part_efi.c
1021 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001022
Simon Glassb569a012017-05-17 03:25:30 -06001023 If IDE or SCSI support is enabled (CONFIG_IDE or
Simon Glass8706b812016-05-01 11:36:02 -06001024 CONFIG_SCSI) you must configure support for at
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001025 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001026
1027- IDE Reset method:
wdenk369d43d2004-03-14 14:09:05 +00001028 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1029 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001030
wdenk369d43d2004-03-14 14:09:05 +00001031 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1032 be performed by calling the function
1033 ide_set_reset(int reset)
1034 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001035
1036- ATAPI Support:
1037 CONFIG_ATAPI
1038
1039 Set this to enable ATAPI support.
1040
wdenkf602aa02004-03-13 23:29:43 +00001041- LBA48 Support
1042 CONFIG_LBA48
1043
1044 Set this to enable support for disks larger than 137GB
Heiko Schocher0f602e12009-12-03 11:21:21 +01001045 Also look at CONFIG_SYS_64BIT_LBA.
wdenkf602aa02004-03-13 23:29:43 +00001046 Whithout these , LBA48 support uses 32bit variables and will 'only'
1047 support disks up to 2.1TB.
1048
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001049 CONFIG_SYS_64BIT_LBA:
wdenkf602aa02004-03-13 23:29:43 +00001050 When enabled, makes the IDE subsystem use 64bit sector addresses.
1051 Default is 32bit.
1052
wdenkc6097192002-11-03 00:24:07 +00001053- SCSI Support:
1054 At the moment only there is only support for the
1055 SYM53C8XX SCSI controller; define
1056 CONFIG_SCSI_SYM53C8XX to enable it.
1057
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001058 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1059 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1060 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001061 maximum numbers of LUNs, SCSI ID's and target
1062 devices.
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001063 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001064
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001065 The environment variable 'scsidevs' is set to the number of
1066 SCSI devices found during the last scan.
Stefan Reinauere50a10e2012-10-29 05:23:48 +00001067
wdenkc6097192002-11-03 00:24:07 +00001068- NETWORK Support (PCI):
wdenk4e112c12003-06-03 23:54:09 +00001069 CONFIG_E1000
Kyle Moffett64b94dd2011-10-18 11:05:29 +00001070 Support for Intel 8254x/8257x gigabit chips.
1071
1072 CONFIG_E1000_SPI
1073 Utility code for direct access to the SPI bus on Intel 8257x.
1074 This does not do anything useful unless you set at least one
1075 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1076
1077 CONFIG_E1000_SPI_GENERIC
1078 Allow generic access to the SPI bus on the Intel 8257x, for
1079 example with the "sspi" command.
1080
1081 CONFIG_CMD_E1000
1082 Management command for E1000 devices. When used on devices
1083 with SPI support you can reprogram the EEPROM from U-Boot.
stroese94ef1cf2003-06-05 15:39:44 +00001084
wdenkc6097192002-11-03 00:24:07 +00001085 CONFIG_EEPRO100
1086 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001087 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001088 write routine for first time initialisation.
1089
1090 CONFIG_TULIP
1091 Support for Digital 2114x chips.
1092 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1093 modem chip initialisation (KS8761/QS6611).
1094
1095 CONFIG_NATSEMI
1096 Support for National dp83815 chips.
1097
1098 CONFIG_NS8382X
1099 Support for National dp8382[01] gigabit chips.
1100
wdenkaa603362003-05-12 21:50:16 +00001101- NETWORK Support (other):
1102
Jens Scharsigdab7cb82010-01-23 12:03:45 +01001103 CONFIG_DRIVER_AT91EMAC
1104 Support for AT91RM9200 EMAC.
1105
1106 CONFIG_RMII
1107 Define this to use reduced MII inteface
1108
1109 CONFIG_DRIVER_AT91EMAC_QUIET
1110 If this defined, the driver is quiet.
1111 The driver doen't show link status messages.
1112
Rob Herringc9830dc2011-12-15 11:15:49 +00001113 CONFIG_CALXEDA_XGMAC
1114 Support for the Calxeda XGMAC device
1115
Ashok93fb8722012-10-15 06:20:47 +00001116 CONFIG_LAN91C96
wdenkaa603362003-05-12 21:50:16 +00001117 Support for SMSC's LAN91C96 chips.
1118
wdenkaa603362003-05-12 21:50:16 +00001119 CONFIG_LAN91C96_USE_32_BIT
1120 Define this to enable 32 bit addressing
1121
Ashok93fb8722012-10-15 06:20:47 +00001122 CONFIG_SMC91111
wdenk3c711762004-06-09 13:37:52 +00001123 Support for SMSC's LAN91C111 chip
1124
1125 CONFIG_SMC91111_BASE
1126 Define this to hold the physical address
1127 of the device (I/O space)
1128
1129 CONFIG_SMC_USE_32_BIT
1130 Define this if data bus is 32 bits
1131
1132 CONFIG_SMC_USE_IOFUNCS
1133 Define this to use i/o functions instead of macros
1134 (some hardware wont work with macros)
1135
Heiko Schocher7d037f72011-11-15 10:00:04 -05001136 CONFIG_DRIVER_TI_EMAC
1137 Support for davinci emac
1138
1139 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1140 Define this if you have more then 3 PHYs.
1141
Macpaul Lin199c6252010-12-21 16:59:46 +08001142 CONFIG_FTGMAC100
1143 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1144
1145 CONFIG_FTGMAC100_EGIGA
1146 Define this to use GE link update with gigabit PHY.
1147 Define this if FTGMAC100 is connected to gigabit PHY.
1148 If your system has 10/100 PHY only, it might not occur
1149 wrong behavior. Because PHY usually return timeout or
1150 useless data when polling gigabit status and gigabit
1151 control registers. This behavior won't affect the
1152 correctnessof 10/100 link speed update.
1153
Mike Rapoportf4761af2009-11-11 10:03:03 +02001154 CONFIG_SMC911X
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001155 Support for SMSC's LAN911x and LAN921x chips
1156
Mike Rapoportf4761af2009-11-11 10:03:03 +02001157 CONFIG_SMC911X_BASE
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001158 Define this to hold the physical address
1159 of the device (I/O space)
1160
Mike Rapoportf4761af2009-11-11 10:03:03 +02001161 CONFIG_SMC911X_32_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001162 Define this if data bus is 32 bits
1163
Mike Rapoportf4761af2009-11-11 10:03:03 +02001164 CONFIG_SMC911X_16_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001165 Define this if data bus is 16 bits. If your processor
1166 automatically converts one 32 bit word to two 16 bit
Mike Rapoportf4761af2009-11-11 10:03:03 +02001167 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001168
Yoshihiro Shimodaed4cea02011-01-27 10:06:03 +09001169 CONFIG_SH_ETHER
1170 Support for Renesas on-chip Ethernet controller
1171
1172 CONFIG_SH_ETHER_USE_PORT
1173 Define the number of ports to be used
1174
1175 CONFIG_SH_ETHER_PHY_ADDR
1176 Define the ETH PHY's address
1177
Yoshihiro Shimoda281aa052011-01-27 10:06:08 +09001178 CONFIG_SH_ETHER_CACHE_WRITEBACK
1179 If this option is set, the driver enables cache flush.
1180
Heiko Schocher2b387762014-07-18 06:07:19 +02001181- PWM Support:
1182 CONFIG_PWM_IMX
Robert P. J. Day1f8378a2016-09-13 08:35:18 -04001183 Support for PWM module on the imx6.
Heiko Schocher2b387762014-07-18 06:07:19 +02001184
Vadim Bendeburydac69642011-10-17 08:36:14 +00001185- TPM Support:
Che-liang Chiouacea5702013-04-12 11:04:34 +00001186 CONFIG_TPM
1187 Support TPM devices.
1188
Christophe Ricard8759ff82015-10-06 22:54:41 +02001189 CONFIG_TPM_TIS_INFINEON
1190 Support for Infineon i2c bus TPM devices. Only one device
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001191 per system is supported at this time.
1192
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001193 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1194 Define the burst count bytes upper limit
1195
Christophe Ricard88249232016-01-21 23:27:13 +01001196 CONFIG_TPM_ST33ZP24
1197 Support for STMicroelectronics TPM devices. Requires DM_TPM support.
1198
1199 CONFIG_TPM_ST33ZP24_I2C
1200 Support for STMicroelectronics ST33ZP24 I2C devices.
1201 Requires TPM_ST33ZP24 and I2C.
1202
Christophe Ricard5ffadc32016-01-21 23:27:14 +01001203 CONFIG_TPM_ST33ZP24_SPI
1204 Support for STMicroelectronics ST33ZP24 SPI devices.
1205 Requires TPM_ST33ZP24 and SPI.
1206
Dirk Eibach20489092013-06-26 15:55:15 +02001207 CONFIG_TPM_ATMEL_TWI
1208 Support for Atmel TWI TPM device. Requires I2C support.
1209
Che-liang Chiouacea5702013-04-12 11:04:34 +00001210 CONFIG_TPM_TIS_LPC
Vadim Bendeburydac69642011-10-17 08:36:14 +00001211 Support for generic parallel port TPM devices. Only one device
1212 per system is supported at this time.
1213
1214 CONFIG_TPM_TIS_BASE_ADDRESS
1215 Base address where the generic TPM device is mapped
1216 to. Contemporary x86 systems usually map it at
1217 0xfed40000.
1218
Reinhard Pfau4fece432013-06-26 15:55:13 +02001219 CONFIG_CMD_TPM
1220 Add tpm monitor functions.
1221 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1222 provides monitor access to authorized functions.
1223
1224 CONFIG_TPM
1225 Define this to enable the TPM support library which provides
1226 functional interfaces to some TPM commands.
1227 Requires support for a TPM device.
1228
1229 CONFIG_TPM_AUTH_SESSIONS
1230 Define this to enable authorized functions in the TPM library.
1231 Requires CONFIG_TPM and CONFIG_SHA1.
1232
wdenkc6097192002-11-03 00:24:07 +00001233- USB Support:
1234 At the moment only the UHCI host controller is
wdenk369d43d2004-03-14 14:09:05 +00001235 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001236 CONFIG_USB_UHCI to enable it.
1237 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenkfb30b4c2004-10-09 22:44:59 +00001238 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001239 storage devices.
1240 Note:
1241 Supported are USB Keyboards and USB Floppy drives
1242 (TEAC FD-05PUB).
wdenk369d43d2004-03-14 14:09:05 +00001243 MPC5200 USB requires additional defines:
1244 CONFIG_USB_CLOCK
1245 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt02848522009-08-13 08:32:37 -05001246 CONFIG_PSC3_USB
1247 for USB on PSC3
wdenk369d43d2004-03-14 14:09:05 +00001248 CONFIG_USB_CONFIG
1249 for differential drivers: 0x00001000
1250 for single ended drivers: 0x00005000
Eric Millbrandt02848522009-08-13 08:32:37 -05001251 for differential drivers on PSC3: 0x00000100
1252 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001253 CONFIG_SYS_USB_EVENT_POLL
Zhang Wei063f9ff2007-06-06 10:08:13 +02001254 May be defined to allow interrupt polling
1255 instead of using asynchronous interrupts
wdenk369d43d2004-03-14 14:09:05 +00001256
Simon Glass5978cdb2012-02-27 10:52:47 +00001257 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1258 txfilltuning field in the EHCI controller on reset.
1259
Oleksandr Tymoshenko7a881752014-02-01 21:51:25 -07001260 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1261 HW module registers.
1262
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001263- USB Device:
1264 Define the below if you wish to use the USB console.
1265 Once firmware is rebuilt from a serial console issue the
1266 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001267 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001268 it has found a new device. The environment variable usbtty
1269 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denke2601822006-06-14 18:14:56 +02001270 appear to a USB host as a Linux gserial device or a
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001271 Common Device Class Abstract Control Model serial device.
1272 If you select usbtty = gserial you should be able to enumerate
1273 a Linux host by
1274 # modprobe usbserial vendor=0xVendorID product=0xProductID
1275 else if using cdc_acm, simply setting the environment
1276 variable usbtty to be cdc_acm should suffice. The following
1277 might be defined in YourBoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001278
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001279 CONFIG_USB_DEVICE
1280 Define this to build a UDC device
1281
1282 CONFIG_USB_TTY
1283 Define this to have a tty type of device available to
1284 talk to the UDC device
Wolfgang Denke2601822006-06-14 18:14:56 +02001285
Vipin KUMARbdb17702012-03-26 15:38:06 +05301286 CONFIG_USBD_HS
1287 Define this to enable the high speed support for usb
1288 device and usbtty. If this feature is enabled, a routine
1289 int is_usbd_high_speed(void)
1290 also needs to be defined by the driver to dynamically poll
1291 whether the enumeration has succeded at high speed or full
1292 speed.
1293
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001294 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001295 Define this if you want stdin, stdout &/or stderr to
1296 be set to usbtty.
1297
Wolfgang Denke2601822006-06-14 18:14:56 +02001298 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001299 define your own vendor specific values either in BoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001300 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001301 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1302 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1303 should pretend to be a Linux device to it's target host.
1304
1305 CONFIG_USBD_MANUFACTURER
1306 Define this string as the name of your company for
1307 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denke2601822006-06-14 18:14:56 +02001308
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001309 CONFIG_USBD_PRODUCT_NAME
1310 Define this string as the name of your product
1311 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
wdenkc6097192002-11-03 00:24:07 +00001312
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001313 CONFIG_USBD_VENDORID
1314 Define this as your assigned Vendor ID from the USB
1315 Implementors Forum. This *must* be a genuine Vendor ID
1316 to avoid polluting the USB namespace.
1317 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001318
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001319 CONFIG_USBD_PRODUCTID
1320 Define this as the unique Product ID
1321 for your device
1322 - CONFIG_USBD_PRODUCTID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001323
Igor Grinbergac5f6ee2011-12-12 12:08:35 +02001324- ULPI Layer Support:
1325 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1326 the generic ULPI layer. The generic layer accesses the ULPI PHY
1327 via the platform viewport, so you need both the genric layer and
1328 the viewport enabled. Currently only Chipidea/ARC based
1329 viewport is supported.
1330 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1331 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stachf31e4112012-10-01 00:44:35 +02001332 If your ULPI phy needs a different reference clock than the
1333 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1334 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001335
wdenk7a428cc2003-06-15 22:40:42 +00001336- MMC Support:
wdenk57b2d802003-06-27 21:31:46 +00001337 The MMC controller on the Intel PXA is supported. To
1338 enable this define CONFIG_MMC. The MMC can be
1339 accessed from the boot prompt by mapping the device
wdenk7a428cc2003-06-15 22:40:42 +00001340 to physical memory similar to flash. Command line is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001341 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1342 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenk7a428cc2003-06-15 22:40:42 +00001343
Yoshihiro Shimodadb7717b2011-07-04 22:21:22 +00001344 CONFIG_SH_MMCIF
1345 Support for Renesas on-chip MMCIF controller
1346
1347 CONFIG_SH_MMCIF_ADDR
1348 Define the base address of MMCIF registers
1349
1350 CONFIG_SH_MMCIF_CLK
1351 Define the clock frequency for MMCIF
1352
Pierre Aubertbcc302c2014-04-24 10:30:08 +02001353 CONFIG_SUPPORT_EMMC_BOOT
1354 Enable some additional features of the eMMC boot partitions.
1355
1356 CONFIG_SUPPORT_EMMC_RPMB
1357 Enable the commands for reading, writing and programming the
1358 key for the Replay Protection Memory Block partition in eMMC.
1359
Tom Rini58a8d322013-03-14 05:32:47 +00001360- USB Device Firmware Update (DFU) class support:
Paul Kocialkowski045d6052015-06-12 19:56:58 +02001361 CONFIG_USB_FUNCTION_DFU
Tom Rini58a8d322013-03-14 05:32:47 +00001362 This enables the USB portion of the DFU USB class
1363
1364 CONFIG_CMD_DFU
1365 This enables the command "dfu" which is used to have
1366 U-Boot create a DFU class device via USB. This command
1367 requires that the "dfu_alt_info" environment variable be
1368 set and define the alt settings to expose to the host.
1369
1370 CONFIG_DFU_MMC
1371 This enables support for exposing (e)MMC devices via DFU.
1372
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +00001373 CONFIG_DFU_NAND
1374 This enables support for exposing NAND devices via DFU.
1375
Afzal Mohammede3c687a2013-09-18 01:15:24 +05301376 CONFIG_DFU_RAM
1377 This enables support for exposing RAM via DFU.
1378 Note: DFU spec refer to non-volatile memory usage, but
1379 allow usages beyond the scope of spec - here RAM usage,
1380 one that would help mostly the developer.
1381
Heiko Schochera2f831e2013-06-12 06:05:51 +02001382 CONFIG_SYS_DFU_DATA_BUF_SIZE
1383 Dfu transfer uses a buffer before writing data to the
1384 raw storage device. Make the size (in bytes) of this buffer
1385 configurable. The size of this buffer is also configurable
1386 through the "dfu_bufsiz" environment variable.
1387
Pantelis Antonioua6e788d2013-03-14 05:32:48 +00001388 CONFIG_SYS_DFU_MAX_FILE_SIZE
1389 When updating files rather than the raw storage device,
1390 we use a static buffer to copy the file into and then write
1391 the buffer once we've been given the whole file. Define
1392 this to the maximum filesize (in bytes) for the buffer.
1393 Default is 4 MiB if undefined.
1394
Heiko Schochere1ba1512014-03-18 08:09:56 +01001395 DFU_DEFAULT_POLL_TIMEOUT
1396 Poll timeout [ms], is the timeout a device can send to the
1397 host. The host must wait for this timeout before sending
1398 a subsequent DFU_GET_STATUS request to the device.
1399
1400 DFU_MANIFEST_POLL_TIMEOUT
1401 Poll timeout [ms], which the device sends to the host when
1402 entering dfuMANIFEST state. Host waits this timeout, before
1403 sending again an USB request to the device.
1404
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001405- USB Device Android Fastboot support:
Paul Kocialkowskid55acc02015-06-12 19:56:59 +02001406 CONFIG_USB_FUNCTION_FASTBOOT
1407 This enables the USB part of the fastboot gadget
1408
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001409 CONFIG_CMD_FASTBOOT
1410 This enables the command "fastboot" which enables the Android
1411 fastboot mode for the platform's USB device. Fastboot is a USB
1412 protocol for downloading images, flashing and device control
1413 used on Android devices.
1414 See doc/README.android-fastboot for more information.
1415
1416 CONFIG_ANDROID_BOOT_IMAGE
1417 This enables support for booting images which use the Android
1418 image format header.
1419
Paul Kocialkowskif84f0912015-07-20 12:38:22 +02001420 CONFIG_FASTBOOT_BUF_ADDR
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001421 The fastboot protocol requires a large memory buffer for
1422 downloads. Define this to the starting RAM address to use for
1423 downloaded images.
1424
Paul Kocialkowskif84f0912015-07-20 12:38:22 +02001425 CONFIG_FASTBOOT_BUF_SIZE
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001426 The fastboot protocol requires a large memory buffer for
1427 downloads. This buffer should be as large as possible for a
1428 platform. Define this to the size available RAM for fastboot.
1429
Steve Raebfb9ba42014-08-26 11:47:28 -07001430 CONFIG_FASTBOOT_FLASH
1431 The fastboot protocol includes a "flash" command for writing
1432 the downloaded image to a non-volatile storage device. Define
1433 this to enable the "fastboot flash" command.
1434
1435 CONFIG_FASTBOOT_FLASH_MMC_DEV
1436 The fastboot "flash" command requires additional information
1437 regarding the non-volatile storage device. Define this to
1438 the eMMC device that fastboot should use to store the image.
1439
Steve Rae7d059342014-12-12 15:51:54 -08001440 CONFIG_FASTBOOT_GPT_NAME
1441 The fastboot "flash" command supports writing the downloaded
1442 image to the Protective MBR and the Primary GUID Partition
1443 Table. (Additionally, this downloaded image is post-processed
1444 to generate and write the Backup GUID Partition Table.)
1445 This occurs when the specified "partition name" on the
1446 "fastboot flash" command line matches this value.
Petr Kulhavy4ed1eca2016-09-09 10:27:18 +02001447 The default is "gpt" if undefined.
Steve Rae7d059342014-12-12 15:51:54 -08001448
Petr Kulhavy9f174c92016-09-09 10:27:16 +02001449 CONFIG_FASTBOOT_MBR_NAME
1450 The fastboot "flash" command supports writing the downloaded
1451 image to DOS MBR.
1452 This occurs when the "partition name" specified on the
1453 "fastboot flash" command line matches this value.
1454 If not defined the default value "mbr" is used.
1455
wdenkda04a8b2004-08-02 23:22:59 +00001456- Journaling Flash filesystem support:
Simon Glassfa8527b2016-10-02 18:00:59 -06001457 CONFIG_JFFS2_NAND
wdenkda04a8b2004-08-02 23:22:59 +00001458 Define these for a default partition on a NAND device
1459
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001460 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1461 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenkda04a8b2004-08-02 23:22:59 +00001462 Define these for a default partition on a NOR device
1463
wdenkc6097192002-11-03 00:24:07 +00001464- Keyboard Support:
Simon Glasseaba37e2015-11-11 10:05:47 -07001465 See Kconfig help for available keyboard drivers.
1466
1467 CONFIG_KEYBOARD
1468
1469 Define this to enable a custom keyboard support.
1470 This simply calls drv_keyboard_init() which must be
1471 defined in your board-specific files. This option is deprecated
1472 and is only used by novena. For new boards, use driver model
1473 instead.
wdenkc6097192002-11-03 00:24:07 +00001474
1475- Video support:
Timur Tabi020edd22011-02-15 17:09:19 -06001476 CONFIG_FSL_DIU_FB
Wolfgang Denk825223d2011-09-11 21:24:09 +02001477 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi020edd22011-02-15 17:09:19 -06001478 SOCs that have a DIU should define this macro to enable DIU
1479 support, and should also define these other macros:
1480
1481 CONFIG_SYS_DIU_ADDR
1482 CONFIG_VIDEO
Timur Tabi020edd22011-02-15 17:09:19 -06001483 CONFIG_CFB_CONSOLE
1484 CONFIG_VIDEO_SW_CURSOR
1485 CONFIG_VGA_AS_SINGLE_DEVICE
1486 CONFIG_VIDEO_LOGO
1487 CONFIG_VIDEO_BMP_LOGO
1488
Timur Tabi32f709e2011-04-11 14:18:22 -05001489 The DIU driver will look for the 'video-mode' environment
1490 variable, and if defined, enable the DIU as a console during
Fabio Estevamd3ad5e52016-04-02 11:53:18 -03001491 boot. See the documentation file doc/README.video for a
Timur Tabi32f709e2011-04-11 14:18:22 -05001492 description of this variable.
Timur Tabi020edd22011-02-15 17:09:19 -06001493
wdenkc6097192002-11-03 00:24:07 +00001494- LCD Support: CONFIG_LCD
1495
1496 Define this to enable LCD support (for output to LCD
1497 display); also select one of the supported displays
1498 by defining one of these:
1499
Stelian Popf6f86652008-05-09 21:57:18 +02001500 CONFIG_ATMEL_LCD:
1501
1502 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1503
wdenkc0d54ae2003-11-25 16:55:19 +00001504 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001505
wdenkc0d54ae2003-11-25 16:55:19 +00001506 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001507
wdenkc0d54ae2003-11-25 16:55:19 +00001508 CONFIG_NEC_NL6448BC20
1509
1510 NEC NL6448BC20-08. 6.5", 640x480.
1511 Active, color, single scan.
1512
1513 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +00001514
wdenkc0d54ae2003-11-25 16:55:19 +00001515 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001516 Active, color, single scan.
1517
1518 CONFIG_SHARP_16x9
1519
1520 Sharp 320x240. Active, color, single scan.
1521 It isn't 16x9, and I am not sure what it is.
1522
1523 CONFIG_SHARP_LQ64D341
1524
1525 Sharp LQ64D341 display, 640x480.
1526 Active, color, single scan.
1527
1528 CONFIG_HLD1045
1529
1530 HLD1045 display, 640x480.
1531 Active, color, single scan.
1532
1533 CONFIG_OPTREX_BW
1534
1535 Optrex CBL50840-2 NF-FW 99 22 M5
1536 or
1537 Hitachi LMG6912RPFC-00T
1538 or
1539 Hitachi SP14Q002
1540
1541 320x240. Black & white.
1542
Simon Glass599a4df2012-10-17 13:24:54 +00001543 CONFIG_LCD_ALIGNMENT
1544
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001545 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass599a4df2012-10-17 13:24:54 +00001546 defined then the LCD will be aligned to this value instead.
1547 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1548 here, since it is cheaper to change data cache settings on
1549 a per-section basis.
1550
1551
Hannes Petermaiera3c8e862015-03-27 08:01:38 +01001552 CONFIG_LCD_ROTATION
1553
1554 Sometimes, for example if the display is mounted in portrait
1555 mode or even if it's mounted landscape but rotated by 180degree,
1556 we need to rotate our content of the display relative to the
1557 framebuffer, so that user can read the messages which are
1558 printed out.
1559 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1560 initialized with a given rotation from "vl_rot" out of
1561 "vidinfo_t" which is provided by the board specific code.
1562 The value for vl_rot is coded as following (matching to
1563 fbcon=rotate:<n> linux-kernel commandline):
1564 0 = no rotation respectively 0 degree
1565 1 = 90 degree rotation
1566 2 = 180 degree rotation
1567 3 = 270 degree rotation
1568
1569 If CONFIG_LCD_ROTATION is not defined, the console will be
1570 initialized with 0degree rotation.
1571
Tom Wai-Hong Tam79926a42012-09-28 15:11:16 +00001572 CONFIG_LCD_BMP_RLE8
1573
1574 Support drawing of RLE8-compressed bitmaps on the LCD.
1575
Tom Wai-Hong Tam6664f202012-12-05 14:46:40 +00001576 CONFIG_I2C_EDID
1577
1578 Enables an 'i2c edid' command which can read EDID
1579 information over I2C from an attached LCD display.
1580
wdenkeb20ad32003-09-05 23:19:14 +00001581- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenk92bbe3f2003-04-20 14:04:18 +00001582
wdenk57b2d802003-06-27 21:31:46 +00001583 If this option is set, the environment is checked for
1584 a variable "splashimage". If found, the usual display
1585 of logo, copyright and system information on the LCD
wdenk01686632004-06-30 22:59:18 +00001586 is suppressed and the BMP image at the address
wdenk57b2d802003-06-27 21:31:46 +00001587 specified in "splashimage" is loaded instead. The
1588 console is redirected to the "nulldev", too. This
1589 allows for a "silent" boot where a splash screen is
1590 loaded very quickly after power-on.
wdenk92bbe3f2003-04-20 14:04:18 +00001591
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001592 CONFIG_SPLASHIMAGE_GUARD
1593
1594 If this option is set, then U-Boot will prevent the environment
1595 variable "splashimage" from being set to a problematic address
Fabio Estevama58b4912016-03-23 12:46:12 -03001596 (see doc/README.displaying-bmps).
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001597 This option is useful for targets where, due to alignment
1598 restrictions, an improperly aligned BMP image will cause a data
1599 abort. If you think you will not have problems with unaligned
1600 accesses (for example because your toolchain prevents them)
1601 there is no need to set this option.
1602
Matthias Weisser53884182009-07-09 16:07:30 +02001603 CONFIG_SPLASH_SCREEN_ALIGN
1604
1605 If this option is set the splash image can be freely positioned
1606 on the screen. Environment variable "splashpos" specifies the
1607 position as "x,y". If a positive number is given it is used as
1608 number of pixel from left/top. If a negative number is given it
1609 is used as number of pixel from right/bottom. You can also
1610 specify 'm' for centering the image.
1611
1612 Example:
1613 setenv splashpos m,m
1614 => image at center of screen
1615
1616 setenv splashpos 30,20
1617 => image at x = 30 and y = 20
1618
1619 setenv splashpos -10,m
1620 => vertically centered image
1621 at x = dspWidth - bmpWidth - 9
1622
Stefan Roesed9d97742005-09-22 09:04:17 +02001623- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1624
1625 If this option is set, additionally to standard BMP
1626 images, gzipped BMP images can be displayed via the
1627 splashscreen support or the bmp command.
1628
Anatolij Gustschin6b4e4fc2010-03-15 14:50:25 +01001629- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1630
1631 If this option is set, 8-bit RLE compressed BMP images
1632 can be displayed via the splashscreen support or the
1633 bmp command.
1634
wdenk710e3502003-08-29 20:57:53 +00001635- Compression support:
Kees Cook5b06e642013-08-16 07:59:12 -07001636 CONFIG_GZIP
1637
1638 Enabled by default to support gzip compressed images.
1639
wdenk710e3502003-08-29 20:57:53 +00001640 CONFIG_BZIP2
1641
1642 If this option is set, support for bzip2 compressed
1643 images is included. If not, only uncompressed and gzip
1644 compressed images are supported.
1645
wdenk9c53f402003-10-15 23:53:47 +00001646 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001647 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk9c53f402003-10-15 23:53:47 +00001648 be at least 4MB.
wdenk92bbe3f2003-04-20 14:04:18 +00001649
Kees Cook5b06e642013-08-16 07:59:12 -07001650 CONFIG_LZO
1651
1652 If this option is set, support for LZO compressed images
1653 is included.
1654
wdenk0e2bd9c2004-06-06 21:51:03 +00001655- MII/PHY support:
1656 CONFIG_PHY_ADDR
1657
1658 The address of PHY on MII bus.
1659
1660 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1661
1662 The clock frequency of the MII bus
1663
1664 CONFIG_PHY_GIGE
1665
1666 If this option is set, support for speed/duplex
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001667 detection of gigabit PHY is included.
wdenk0e2bd9c2004-06-06 21:51:03 +00001668
1669 CONFIG_PHY_RESET_DELAY
1670
1671 Some PHY like Intel LXT971A need extra delay after
1672 reset before any MII register access is possible.
1673 For such PHY, set this option to the usec delay
1674 required. (minimum 300usec for LXT971A)
1675
1676 CONFIG_PHY_CMD_DELAY (ppc4xx)
1677
1678 Some PHY like Intel LXT971A need extra delay after
1679 command issued before MII status register can be read
1680
wdenkc6097192002-11-03 00:24:07 +00001681- IP address:
1682 CONFIG_IPADDR
1683
1684 Define a default value for the IP address to use for
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001685 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001686 determined through e.g. bootp.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001687 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001688
1689- Server IP address:
1690 CONFIG_SERVERIP
1691
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001692 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001693 server to contact when using the "tftboot" command.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001694 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001695
Robin Getz470a6d42009-07-21 12:15:28 -04001696 CONFIG_KEEP_SERVERADDR
1697
1698 Keeps the server's MAC address, in the env 'serveraddr'
1699 for passing to bootargs (like Linux's netconsole option)
1700
Wolfgang Denk26da2992011-10-26 10:21:22 +00001701- Gateway IP address:
1702 CONFIG_GATEWAYIP
1703
1704 Defines a default value for the IP address of the
1705 default router where packets to other networks are
1706 sent to.
1707 (Environment variable "gatewayip")
1708
1709- Subnet mask:
1710 CONFIG_NETMASK
1711
1712 Defines a default value for the subnet mask (or
1713 routing prefix) which is used to determine if an IP
1714 address belongs to the local subnet or needs to be
1715 forwarded through a router.
1716 (Environment variable "netmask")
1717
David Updegraff7280da72007-06-11 10:41:07 -05001718- Multicast TFTP Mode:
1719 CONFIG_MCAST_TFTP
1720
1721 Defines whether you want to support multicast TFTP as per
1722 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001723 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff7280da72007-06-11 10:41:07 -05001724 driver in use must provide a function: mcast() to join/leave a
1725 multicast group.
1726
wdenkc6097192002-11-03 00:24:07 +00001727- BOOTP Recovery Mode:
1728 CONFIG_BOOTP_RANDOM_DELAY
1729
1730 If you have many targets in a network that try to
1731 boot using BOOTP, you may want to avoid that all
1732 systems send out BOOTP requests at precisely the same
1733 moment (which would happen for instance at recovery
1734 from a power failure, when all systems will try to
1735 boot, thus flooding the BOOTP server. Defining
1736 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1737 inserted before sending out BOOTP requests. The
Wolfgang Denkb65aaf92007-08-06 23:21:05 +02001738 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001739
1740 1st BOOTP request: delay 0 ... 1 sec
1741 2nd BOOTP request: delay 0 ... 2 sec
1742 3rd BOOTP request: delay 0 ... 4 sec
1743 4th and following
1744 BOOTP requests: delay 0 ... 8 sec
1745
Thierry Reding8977cda2014-08-19 10:21:24 +02001746 CONFIG_BOOTP_ID_CACHE_SIZE
1747
1748 BOOTP packets are uniquely identified using a 32-bit ID. The
1749 server will copy the ID from client requests to responses and
1750 U-Boot will use this to determine if it is the destination of
1751 an incoming response. Some servers will check that addresses
1752 aren't in use before handing them out (usually using an ARP
1753 ping) and therefore take up to a few hundred milliseconds to
1754 respond. Network congestion may also influence the time it
1755 takes for a response to make it back to the client. If that
1756 time is too long, U-Boot will retransmit requests. In order
1757 to allow earlier responses to still be accepted after these
1758 retransmissions, U-Boot's BOOTP client keeps a small cache of
1759 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
1760 cache. The default is to keep IDs for up to four outstanding
1761 requests. Increasing this will allow U-Boot to accept offers
1762 from a BOOTP client in networks with unusually high latency.
1763
stroesee0aadfb2003-08-28 14:17:32 +00001764- DHCP Advanced Options:
Jon Loeliger5336a762007-07-09 22:08:34 -05001765 You can fine tune the DHCP functionality by defining
1766 CONFIG_BOOTP_* symbols:
stroesee0aadfb2003-08-28 14:17:32 +00001767
Jon Loeliger5336a762007-07-09 22:08:34 -05001768 CONFIG_BOOTP_SUBNETMASK
1769 CONFIG_BOOTP_GATEWAY
1770 CONFIG_BOOTP_HOSTNAME
1771 CONFIG_BOOTP_NISDOMAIN
1772 CONFIG_BOOTP_BOOTPATH
1773 CONFIG_BOOTP_BOOTFILESIZE
1774 CONFIG_BOOTP_DNS
1775 CONFIG_BOOTP_DNS2
1776 CONFIG_BOOTP_SEND_HOSTNAME
1777 CONFIG_BOOTP_NTPSERVER
1778 CONFIG_BOOTP_TIMEOFFSET
1779 CONFIG_BOOTP_VENDOREX
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001780 CONFIG_BOOTP_MAY_FAIL
stroesee0aadfb2003-08-28 14:17:32 +00001781
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001782 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1783 environment variable, not the BOOTP server.
stroesee0aadfb2003-08-28 14:17:32 +00001784
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001785 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1786 after the configured retry count, the call will fail
1787 instead of starting over. This can be used to fail over
1788 to Link-local IP address configuration if the DHCP server
1789 is not available.
1790
stroesee0aadfb2003-08-28 14:17:32 +00001791 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1792 serverip from a DHCP server, it is possible that more
1793 than one DNS serverip is offered to the client.
1794 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1795 serverip will be stored in the additional environment
1796 variable "dnsip2". The first DNS serverip is always
1797 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger5336a762007-07-09 22:08:34 -05001798 is defined.
stroesee0aadfb2003-08-28 14:17:32 +00001799
1800 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1801 to do a dynamic update of a DNS server. To do this, they
1802 need the hostname of the DHCP requester.
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001803 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger5336a762007-07-09 22:08:34 -05001804 of the "hostname" environment variable is passed as
1805 option 12 to the DHCP server.
stroesee0aadfb2003-08-28 14:17:32 +00001806
Aras Vaichas72aa3f32008-03-26 09:43:57 +11001807 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1808
1809 A 32bit value in microseconds for a delay between
1810 receiving a "DHCP Offer" and sending the "DHCP Request".
1811 This fixes a problem with certain DHCP servers that don't
1812 respond 100% of the time to a "DHCP request". E.g. On an
1813 AT91RM9200 processor running at 180MHz, this delay needed
1814 to be *at least* 15,000 usec before a Windows Server 2003
1815 DHCP server would reply 100% of the time. I recommend at
1816 least 50,000 usec to be safe. The alternative is to hope
1817 that one of the retries will be successful but note that
1818 the DHCP timeout and retry process takes a longer than
1819 this delay.
1820
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00001821 - Link-local IP address negotiation:
1822 Negotiate with other link-local clients on the local network
1823 for an address that doesn't require explicit configuration.
1824 This is especially useful if a DHCP server cannot be guaranteed
1825 to exist in all environments that the device must operate.
1826
1827 See doc/README.link-local for more information.
1828
wdenk145d2c12004-04-15 21:48:45 +00001829 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00001830 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00001831
1832 The device id used in CDP trigger frames.
1833
1834 CONFIG_CDP_DEVICE_ID_PREFIX
1835
1836 A two character string which is prefixed to the MAC address
1837 of the device.
1838
1839 CONFIG_CDP_PORT_ID
1840
1841 A printf format string which contains the ascii name of
1842 the port. Normally is set to "eth%d" which sets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001843 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-04-15 21:48:45 +00001844
1845 CONFIG_CDP_CAPABILITIES
1846
1847 A 32bit integer which indicates the device capabilities;
1848 0x00000010 for a normal host which does not forwards.
1849
1850 CONFIG_CDP_VERSION
1851
1852 An ascii string containing the version of the software.
1853
1854 CONFIG_CDP_PLATFORM
1855
1856 An ascii string containing the name of the platform.
1857
1858 CONFIG_CDP_TRIGGER
1859
1860 A 32bit integer sent on the trigger.
1861
1862 CONFIG_CDP_POWER_CONSUMPTION
1863
1864 A 16bit integer containing the power consumption of the
1865 device in .1 of milliwatts.
1866
1867 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1868
1869 A byte containing the id of the VLAN.
1870
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001871- Status LED: CONFIG_LED_STATUS
wdenkc6097192002-11-03 00:24:07 +00001872
1873 Several configurations allow to display the current
1874 status using a LED. For instance, the LED will blink
1875 fast while running U-Boot code, stop blinking as
1876 soon as a reply to a BOOTP request was received, and
1877 start blinking slow once the Linux kernel is running
1878 (supported by a status LED driver in the Linux
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001879 kernel). Defining CONFIG_LED_STATUS enables this
wdenkc6097192002-11-03 00:24:07 +00001880 feature in U-Boot.
1881
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001882 Additional options:
1883
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001884 CONFIG_LED_STATUS_GPIO
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001885 The status LED can be connected to a GPIO pin.
1886 In such cases, the gpio_led driver can be used as a
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001887 status LED backend implementation. Define CONFIG_LED_STATUS_GPIO
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001888 to include the gpio_led driver in the U-Boot binary.
1889
Igor Grinberg203bd9f2013-11-08 01:03:52 +02001890 CONFIG_GPIO_LED_INVERTED_TABLE
1891 Some GPIO connected LEDs may have inverted polarity in which
1892 case the GPIO high value corresponds to LED off state and
1893 GPIO low value corresponds to LED on state.
1894 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
1895 with a list of GPIO LEDs that have inverted polarity.
1896
wdenkc6097192002-11-03 00:24:07 +00001897- CAN Support: CONFIG_CAN_DRIVER
1898
1899 Defining CONFIG_CAN_DRIVER enables CAN driver support
1900 on those systems that support this (optional)
Heiko Schocher65d94db2017-06-07 17:33:09 +02001901 feature.
wdenkc6097192002-11-03 00:24:07 +00001902
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001903- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00001904
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001905 This enable the NEW i2c subsystem, and will allow you to use
1906 i2c commands at the u-boot command line (as long as you set
1907 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
1908 based realtime clock chips or other i2c devices. See
1909 common/cmd_i2c.c for a description of the command line
1910 interface.
1911
1912 ported i2c driver to the new framework:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01001913 - drivers/i2c/soft_i2c.c:
1914 - activate first bus with CONFIG_SYS_I2C_SOFT define
1915 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
1916 for defining speed and slave address
1917 - activate second bus with I2C_SOFT_DECLARATIONS2 define
1918 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
1919 for defining speed and slave address
1920 - activate third bus with I2C_SOFT_DECLARATIONS3 define
1921 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
1922 for defining speed and slave address
1923 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
1924 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
1925 for defining speed and slave address
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001926
Heiko Schocherf2850742012-10-24 13:48:22 +02001927 - drivers/i2c/fsl_i2c.c:
1928 - activate i2c driver with CONFIG_SYS_I2C_FSL
1929 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
1930 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
1931 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
1932 bus.
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001933 - If your board supports a second fsl i2c bus, define
Heiko Schocherf2850742012-10-24 13:48:22 +02001934 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
1935 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
1936 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
1937 second bus.
1938
Simon Glass026fefb2012-10-30 07:28:53 +00001939 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu045acfa2013-10-11 16:23:53 +09001940 - activate this driver with CONFIG_SYS_I2C_TEGRA
1941 - This driver adds 4 i2c buses with a fix speed from
1942 100000 and the slave addr 0!
Simon Glass026fefb2012-10-30 07:28:53 +00001943
Dirk Eibach42b204f2013-04-25 02:40:01 +00001944 - drivers/i2c/ppc4xx_i2c.c
1945 - activate this driver with CONFIG_SYS_I2C_PPC4XX
1946 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
1947 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
1948
trema49f40a2013-09-21 18:13:35 +02001949 - drivers/i2c/i2c_mxc.c
1950 - activate this driver with CONFIG_SYS_I2C_MXC
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02001951 - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
1952 - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
1953 - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
1954 - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
trema49f40a2013-09-21 18:13:35 +02001955 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
1956 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
1957 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
1958 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
1959 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
1960 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02001961 - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
1962 - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001963 If those defines are not set, default value is 100000
trema49f40a2013-09-21 18:13:35 +02001964 for speed, and 0 for slave.
1965
Nobuhiro Iwamatsue94ea2f2013-09-27 16:58:30 +09001966 - drivers/i2c/rcar_i2c.c:
1967 - activate this driver with CONFIG_SYS_I2C_RCAR
1968 - This driver adds 4 i2c buses
1969
1970 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
1971 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
1972 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
1973 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
1974 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
1975 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
1976 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
1977 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
1978 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
1979
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09001980 - drivers/i2c/sh_i2c.c:
1981 - activate this driver with CONFIG_SYS_I2C_SH
1982 - This driver adds from 2 to 5 i2c buses
1983
1984 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
1985 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
1986 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
1987 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
1988 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
1989 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
1990 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
1991 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
1992 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
1993 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001994 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09001995
Heiko Schocherf53f2b82013-10-22 11:03:18 +02001996 - drivers/i2c/omap24xx_i2c.c
1997 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
1998 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
1999 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2000 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2001 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2002 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2003 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2004 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2005 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2006 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2007 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2008
Heiko Schocher465819a2013-11-08 07:30:53 +01002009 - drivers/i2c/zynq_i2c.c
2010 - activate this driver with CONFIG_SYS_I2C_ZYNQ
2011 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2012 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2013
Naveen Krishna Ch5d5efd32013-12-06 12:12:38 +05302014 - drivers/i2c/s3c24x0_i2c.c:
2015 - activate this driver with CONFIG_SYS_I2C_S3C24X0
2016 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2017 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2018 with a fix speed from 100000 and the slave addr 0!
2019
Dirk Eibachb9577432014-07-03 09:28:18 +02002020 - drivers/i2c/ihs_i2c.c
2021 - activate this driver with CONFIG_SYS_I2C_IHS
2022 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2023 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2024 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2025 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2026 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2027 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2028 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2029 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2030 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2031 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2032 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2033 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
Dirk Eibach9ac33852015-10-28 11:46:22 +01002034 - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
2035 - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
2036 - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
2037 - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
2038 - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
2039 - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
2040 - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
2041 - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
2042 - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
Dirk Eibachb9577432014-07-03 09:28:18 +02002043
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002044 additional defines:
2045
2046 CONFIG_SYS_NUM_I2C_BUSES
Simon Glassb05e2b32016-10-02 18:01:05 -06002047 Hold the number of i2c buses you want to use.
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002048
2049 CONFIG_SYS_I2C_DIRECT_BUS
2050 define this, if you don't use i2c muxes on your hardware.
2051 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2052 omit this define.
2053
2054 CONFIG_SYS_I2C_MAX_HOPS
2055 define how many muxes are maximal consecutively connected
2056 on one i2c bus. If you not use i2c muxes, omit this
2057 define.
2058
2059 CONFIG_SYS_I2C_BUSES
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002060 hold a list of buses you want to use, only used if
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002061 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2062 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2063 CONFIG_SYS_NUM_I2C_BUSES = 9:
2064
2065 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2066 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2067 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2068 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2069 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2070 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2071 {1, {I2C_NULL_HOP}}, \
2072 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2073 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2074 }
2075
2076 which defines
2077 bus 0 on adapter 0 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002078 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2079 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2080 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2081 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2082 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002083 bus 6 on adapter 1 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002084 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2085 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002086
2087 If you do not have i2c muxes on your board, omit this define.
2088
Simon Glass3efce392017-05-12 21:10:00 -06002089- Legacy I2C Support:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002090 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb9bbd242003-06-30 16:24:52 +00002091 then the following macros need to be defined (examples are
2092 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002093
2094 I2C_INIT
2095
wdenkb9bbd242003-06-30 16:24:52 +00002096 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00002097 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002098
wdenk544e9732004-02-06 23:19:44 +00002099 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00002100
wdenkc6097192002-11-03 00:24:07 +00002101 I2C_ACTIVE
2102
2103 The code necessary to make the I2C data line active
2104 (driven). If the data line is open collector, this
2105 define can be null.
2106
wdenkb9bbd242003-06-30 16:24:52 +00002107 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2108
wdenkc6097192002-11-03 00:24:07 +00002109 I2C_TRISTATE
2110
2111 The code necessary to make the I2C data line tri-stated
2112 (inactive). If the data line is open collector, this
2113 define can be null.
2114
wdenkb9bbd242003-06-30 16:24:52 +00002115 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2116
wdenkc6097192002-11-03 00:24:07 +00002117 I2C_READ
2118
York Sun4a598092013-04-01 11:29:11 -07002119 Code that returns true if the I2C data line is high,
2120 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002121
wdenkb9bbd242003-06-30 16:24:52 +00002122 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2123
wdenkc6097192002-11-03 00:24:07 +00002124 I2C_SDA(bit)
2125
York Sun4a598092013-04-01 11:29:11 -07002126 If <bit> is true, sets the I2C data line high. If it
2127 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002128
wdenkb9bbd242003-06-30 16:24:52 +00002129 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002130 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00002131 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00002132
wdenkc6097192002-11-03 00:24:07 +00002133 I2C_SCL(bit)
2134
York Sun4a598092013-04-01 11:29:11 -07002135 If <bit> is true, sets the I2C clock line high. If it
2136 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002137
wdenkb9bbd242003-06-30 16:24:52 +00002138 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002139 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00002140 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00002141
wdenkc6097192002-11-03 00:24:07 +00002142 I2C_DELAY
2143
2144 This delay is invoked four times per clock cycle so this
2145 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00002146 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00002147 like:
2148
wdenkb9bbd242003-06-30 16:24:52 +00002149 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002150
Mike Frysingeree12d542010-07-21 13:38:02 -04002151 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2152
2153 If your arch supports the generic GPIO framework (asm/gpio.h),
2154 then you may alternatively define the two GPIOs that are to be
2155 used as SCL / SDA. Any of the previous I2C_xxx macros will
2156 have GPIO-based defaults assigned to them as appropriate.
2157
2158 You should define these to the GPIO value as given directly to
2159 the generic GPIO functions.
2160
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002161 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00002162
wdenk57b2d802003-06-27 21:31:46 +00002163 When a board is reset during an i2c bus transfer
2164 chips might think that the current transfer is still
2165 in progress. On some boards it is possible to access
2166 the i2c SCLK line directly, either by using the
2167 processor pin as a GPIO or by having a second pin
2168 connected to the bus. If this option is defined a
2169 custom i2c_init_board() routine in boards/xxx/board.c
2170 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00002171
Ben Warren45657152006-09-07 16:50:54 -04002172 CONFIG_I2C_MULTI_BUS
2173
2174 This option allows the use of multiple I2C buses, each of which
Wolfgang Denk092ae952011-10-26 10:21:21 +00002175 must have a controller. At any point in time, only one bus is
2176 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warren45657152006-09-07 16:50:54 -04002177 Note that bus numbering is zero-based.
2178
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002179 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04002180
2181 This option specifies a list of I2C devices that will be skipped
Wolfgang Denk092ae952011-10-26 10:21:21 +00002182 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser469cde42009-04-18 22:34:03 -05002183 is set, specify a list of bus-device pairs. Otherwise, specify
2184 a 1D array of device addresses
Ben Warren45657152006-09-07 16:50:54 -04002185
2186 e.g.
2187 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denk092ae952011-10-26 10:21:21 +00002188 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04002189
2190 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2191
Wolfgang Denk092ae952011-10-26 10:21:21 +00002192 #define CONFIG_I2C_MULTI_BUS
Simon Glassb05e2b32016-10-02 18:01:05 -06002193 #define CONFIG_SYS_I2C_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-09-07 16:50:54 -04002194
2195 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2196
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002197 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-11-03 19:15:00 -06002198
2199 If defined, then this indicates the I2C bus number for DDR SPD.
2200 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2201
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002202 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002203
2204 If defined, then this indicates the I2C bus number for the RTC.
2205 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2206
Andrew Dyer58c41f92008-12-29 17:36:01 -06002207 CONFIG_SOFT_I2C_READ_REPEATED_START
2208
2209 defining this will force the i2c_read() function in
2210 the soft_i2c driver to perform an I2C repeated start
2211 between writing the address pointer and reading the
2212 data. If this define is omitted the default behaviour
2213 of doing a stop-start sequence will be used. Most I2C
2214 devices can use either method, but some require one or
2215 the other.
Timur Tabiab347542006-11-03 19:15:00 -06002216
wdenkc6097192002-11-03 00:24:07 +00002217- SPI Support: CONFIG_SPI
2218
2219 Enables SPI driver (so far only tested with
2220 SPI EEPROM, also an instance works with Crystal A/D and
2221 D/As on the SACSng board)
2222
Yoshihiro Shimoda65bd9b42011-01-31 16:50:43 +09002223 CONFIG_SH_SPI
2224
2225 Enables the driver for SPI controller on SuperH. Currently
2226 only SH7757 is supported.
2227
wdenkc6097192002-11-03 00:24:07 +00002228 CONFIG_SOFT_SPI
2229
wdenk4a5c8a72003-03-06 00:02:04 +00002230 Enables a software (bit-bang) SPI driver rather than
2231 using hardware support. This is a general purpose
2232 driver that only requires three general I/O port pins
2233 (two outputs, one input) to function. If this is
2234 defined, the board configuration must define several
2235 SPI configuration items (port pins to use, etc). For
2236 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002237
Ben Warren7efe9272008-01-16 22:37:35 -05002238 CONFIG_HARD_SPI
2239
2240 Enables a hardware SPI driver for general-purpose reads
2241 and writes. As with CONFIG_SOFT_SPI, the board configuration
2242 must define a list of chip-select function pointers.
Wolfgang Denk092ae952011-10-26 10:21:21 +00002243 Currently supported on some MPC8xxx processors. For an
Ben Warren7efe9272008-01-16 22:37:35 -05002244 example, see include/configs/mpc8349emds.h.
2245
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002246 CONFIG_MXC_SPI
2247
2248 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevamdcd342c2011-10-28 08:57:46 +00002249 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002250
Heiko Schocherb77c8882014-07-14 10:22:11 +02002251 CONFIG_SYS_SPI_MXC_WAIT
2252 Timeout for waiting until spi transfer completed.
2253 default: (CONFIG_SYS_HZ/100) /* 10 ms */
2254
Matthias Fuchsa4400872007-12-27 17:12:34 +01002255- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00002256
Matthias Fuchsa4400872007-12-27 17:12:34 +01002257 Enables FPGA subsystem.
2258
2259 CONFIG_FPGA_<vendor>
2260
2261 Enables support for specific chip vendors.
2262 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00002263
Matthias Fuchsa4400872007-12-27 17:12:34 +01002264 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00002265
Matthias Fuchsa4400872007-12-27 17:12:34 +01002266 Enables support for FPGA family.
2267 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2268
2269 CONFIG_FPGA_COUNT
2270
2271 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002272
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002273 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002274
wdenk57b2d802003-06-27 21:31:46 +00002275 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002276
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002277 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002278
wdenk4a5c8a72003-03-06 00:02:04 +00002279 Enable checks on FPGA configuration interface busy
2280 status by the configuration function. This option
2281 will require a board or device specific function to
2282 be written.
wdenkc6097192002-11-03 00:24:07 +00002283
2284 CONFIG_FPGA_DELAY
2285
2286 If defined, a function that provides delays in the FPGA
2287 configuration driver.
2288
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002289 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002290 Allow Control-C to interrupt FPGA configuration
2291
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002292 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002293
wdenk4a5c8a72003-03-06 00:02:04 +00002294 Check for configuration errors during FPGA bitfile
2295 loading. For example, abort during Virtex II
2296 configuration if the INIT_B line goes low (which
2297 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002298
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002299 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002300
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002301 Maximum time to wait for the INIT_B line to de-assert
2302 after PROB_B has been de-asserted during a Virtex II
wdenk4a5c8a72003-03-06 00:02:04 +00002303 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002304 ms.
wdenkc6097192002-11-03 00:24:07 +00002305
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002306 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002307
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002308 Maximum time to wait for BUSY to de-assert during
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002309 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002310
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002311 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002312
wdenk4a5c8a72003-03-06 00:02:04 +00002313 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002314 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002315
2316- Configuration Management:
Stefan Roese141ed202014-10-22 12:13:24 +02002317 CONFIG_BUILD_TARGET
2318
2319 Some SoCs need special image types (e.g. U-Boot binary
2320 with a special header) as build targets. By defining
2321 CONFIG_BUILD_TARGET in the SoC / board header, this
2322 special image will be automatically built upon calling
Simon Glassdc27def2016-07-27 20:33:08 -06002323 make / buildman.
Stefan Roese141ed202014-10-22 12:13:24 +02002324
wdenkc6097192002-11-03 00:24:07 +00002325 CONFIG_IDENT_STRING
2326
wdenk4a5c8a72003-03-06 00:02:04 +00002327 If defined, this string will be added to the U-Boot
2328 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002329
2330- Vendor Parameter Protection:
2331
wdenk4a5c8a72003-03-06 00:02:04 +00002332 U-Boot considers the values of the environment
2333 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00002334 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00002335 are set once by the board vendor / manufacturer, and
2336 protects these variables from casual modification by
2337 the user. Once set, these variables are read-only,
2338 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002339 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002340
2341 If CONFIG_ENV_OVERWRITE is #defined in your config
2342 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00002343 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002344 these parameters.
2345
Joe Hershberger76f353e2015-05-04 14:55:14 -05002346 Alternatively, if you define _both_ an ethaddr in the
2347 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002348 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002349 which can be changed exactly ONCE by the user. [The
2350 serial# is unaffected by this, i. e. it remains
2351 read-only.]
2352
Joe Hershberger71497d02012-12-11 22:16:31 -06002353 The same can be accomplished in a more flexible way
2354 for any variable by configuring the type of access
2355 to allow for those variables in the ".flags" variable
2356 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2357
wdenkc6097192002-11-03 00:24:07 +00002358- Protected RAM:
2359 CONFIG_PRAM
2360
2361 Define this variable to enable the reservation of
2362 "protected RAM", i. e. RAM which is not overwritten
2363 by U-Boot. Define CONFIG_PRAM to hold the number of
2364 kB you want to reserve for pRAM. You can overwrite
2365 this default value by defining an environment
2366 variable "pram" to the number of kB you want to
2367 reserve. Note that the board info structure will
2368 still show the full amount of RAM. If pRAM is
2369 reserved, a new environment variable "mem" will
2370 automatically be defined to hold the amount of
2371 remaining RAM in a form that can be passed as boot
2372 argument to Linux, for instance like that:
2373
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01002374 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002375 saveenv
2376
2377 This way you can tell Linux not to use this memory,
2378 either, which results in a memory region that will
2379 not be affected by reboots.
2380
2381 *WARNING* If your board configuration uses automatic
2382 detection of the RAM size, you must make sure that
2383 this memory test is non-destructive. So far, the
2384 following board configurations are known to be
2385 "pRAM-clean":
2386
Heiko Schocher65d94db2017-06-07 17:33:09 +02002387 IVMS8, IVML24, SPD8xx,
Wolfgang Denk90326762012-10-24 02:36:15 +00002388 HERMES, IP860, RPXlite, LWMON,
Heiko Schocher71cb3e92017-06-07 17:33:10 +02002389 FLAGADM
wdenkc6097192002-11-03 00:24:07 +00002390
Gabe Blacka2f3a932012-12-02 04:55:18 +00002391- Access to physical memory region (> 4GB)
2392 Some basic support is provided for operations on memory not
2393 normally accessible to U-Boot - e.g. some architectures
2394 support access to more than 4GB of memory on 32-bit
2395 machines using physical address extension or similar.
2396 Define CONFIG_PHYSMEM to access this basic support, which
2397 currently only supports clearing the memory.
2398
wdenkc6097192002-11-03 00:24:07 +00002399- Error Recovery:
2400 CONFIG_PANIC_HANG
2401
2402 Define this variable to stop the system in case of a
2403 fatal error, so that you have to reset it manually.
2404 This is probably NOT a good idea for an embedded
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002405 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002406 automatically as fast as possible, but it may be
2407 useful during development since you can try to debug
2408 the conditions that lead to the situation.
2409
2410 CONFIG_NET_RETRY_COUNT
2411
wdenk4a5c8a72003-03-06 00:02:04 +00002412 This variable defines the number of retries for
2413 network operations like ARP, RARP, TFTP, or BOOTP
2414 before giving up the operation. If not defined, a
2415 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002416
Guennadi Liakhovetskib38c2b32008-04-03 17:04:19 +02002417 CONFIG_ARP_TIMEOUT
2418
2419 Timeout waiting for an ARP reply in milliseconds.
2420
Tetsuyuki Kobayashi147e3902012-07-03 22:25:21 +00002421 CONFIG_NFS_TIMEOUT
2422
2423 Timeout in milliseconds used in NFS protocol.
2424 If you encounter "ERROR: Cannot umount" in nfs command,
2425 try longer timeout such as
2426 #define CONFIG_NFS_TIMEOUT 10000UL
2427
wdenkc6097192002-11-03 00:24:07 +00002428- Command Interpreter:
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002429 CONFIG_AUTO_COMPLETE
wdenk3902d702004-04-15 18:22:41 +00002430
2431 Enable auto completion of commands using TAB.
2432
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002433 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002434
2435 This defines the secondary prompt string, which is
2436 printed when the command interpreter needs more input
2437 to complete a command. Usually "> ".
2438
2439 Note:
2440
wdenk57b2d802003-06-27 21:31:46 +00002441 In the current implementation, the local variables
2442 space and global environment variables space are
2443 separated. Local variables are those you define by
2444 simply typing `name=value'. To access a local
2445 variable later on, you have write `$name' or
2446 `${name}'; to execute the contents of a variable
2447 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002448
wdenk4a5c8a72003-03-06 00:02:04 +00002449 Global environment variables are those you use
2450 setenv/printenv to work with. To run a command stored
2451 in such a variable, you need to use the run command,
2452 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002453
2454 To store commands and special characters in a
2455 variable, please use double quotation marks
2456 surrounding the whole text of the variable, instead
2457 of the backslashes before semicolons and special
2458 symbols.
2459
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002460- Command Line Editing and History:
Wolfgang Denk2039a072006-07-21 11:35:21 +02002461 CONFIG_CMDLINE_EDITING
2462
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002463 Enable editing and History functions for interactive
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002464 command line input operations
Wolfgang Denk2039a072006-07-21 11:35:21 +02002465
Marek Vasut734fb042016-01-27 04:47:55 +01002466- Command Line PS1/PS2 support:
2467 CONFIG_CMDLINE_PS_SUPPORT
2468
2469 Enable support for changing the command prompt string
2470 at run-time. Only static string is supported so far.
2471 The string is obtained from environment variables PS1
2472 and PS2.
2473
wdenkc0aa5c52003-12-06 19:49:23 +00002474- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002475 CONFIG_EXTRA_ENV_SETTINGS
2476
wdenk4a5c8a72003-03-06 00:02:04 +00002477 Define this to contain any number of null terminated
2478 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00002479 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00002480
wdenk4a5c8a72003-03-06 00:02:04 +00002481 For example, place something like this in your
2482 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002483
2484 #define CONFIG_EXTRA_ENV_SETTINGS \
2485 "myvar1=value1\0" \
2486 "myvar2=value2\0"
2487
wdenk4a5c8a72003-03-06 00:02:04 +00002488 Warning: This method is based on knowledge about the
2489 internal format how the environment is stored by the
2490 U-Boot code. This is NOT an official, exported
2491 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00002492 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002493 You better know what you are doing here.
2494
wdenk4a5c8a72003-03-06 00:02:04 +00002495 Note: overly (ab)use of the default environment is
2496 discouraged. Make sure to check other ways to preset
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002497 the environment like the "source" command or the
wdenk4a5c8a72003-03-06 00:02:04 +00002498 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002499
Stephen Warren1465d5f2012-05-22 09:21:54 +00002500 CONFIG_ENV_VARS_UBOOT_CONFIG
2501
2502 Define this in order to add variables describing the
2503 U-Boot build configuration to the default environment.
2504 These will be named arch, cpu, board, vendor, and soc.
2505
2506 Enabling this option will cause the following to be defined:
2507
2508 - CONFIG_SYS_ARCH
2509 - CONFIG_SYS_CPU
2510 - CONFIG_SYS_BOARD
2511 - CONFIG_SYS_VENDOR
2512 - CONFIG_SYS_SOC
2513
Tom Rini4c8cc9b2012-10-24 07:28:16 +00002514 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2515
2516 Define this in order to add variables describing certain
2517 run-time determined information about the hardware to the
2518 environment. These will be named board_name, board_rev.
2519
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002520 CONFIG_DELAY_ENVIRONMENT
2521
2522 Normally the environment is loaded when the board is
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002523 initialised so that it is available to U-Boot. This inhibits
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002524 that so that the environment is not available until
2525 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2526 this is instead controlled by the value of
2527 /config/load-environment.
2528
wdenkc0aa5c52003-12-06 19:49:23 +00002529- DataFlash Support:
wdenk381669a2003-06-16 23:50:08 +00002530 CONFIG_HAS_DATAFLASH
2531
wdenk57b2d802003-06-27 21:31:46 +00002532 Defining this option enables DataFlash features and
2533 allows to read/write in Dataflash via the standard
2534 commands cp, md...
wdenk381669a2003-06-16 23:50:08 +00002535
Eric Nelson97f5f8f2012-01-31 10:52:08 -07002536- Serial Flash support
2537 CONFIG_CMD_SF
2538
2539 Defining this option enables SPI flash commands
2540 'sf probe/read/write/erase/update'.
2541
2542 Usage requires an initial 'probe' to define the serial
2543 flash parameters, followed by read/write/erase/update
2544 commands.
2545
2546 The following defaults may be provided by the platform
2547 to handle the common case when only a single serial
2548 flash is present on the system.
2549
2550 CONFIG_SF_DEFAULT_BUS Bus identifier
2551 CONFIG_SF_DEFAULT_CS Chip-select
2552 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2553 CONFIG_SF_DEFAULT_SPEED in Hz
2554
Simon Glass4b5545e2012-10-08 13:16:02 +00002555 CONFIG_CMD_SF_TEST
2556
2557 Define this option to include a destructive SPI flash
2558 test ('sf test').
2559
Jagannadha Sutradharudu Tekid7f253b2014-01-11 15:25:04 +05302560 CONFIG_SF_DUAL_FLASH Dual flash memories
2561
2562 Define this option to use dual flash support where two flash
2563 memories can be connected with a given cs line.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002564 Currently Xilinx Zynq qspi supports these type of connections.
Jagannadha Sutradharudu Tekid7f253b2014-01-11 15:25:04 +05302565
wdenkef893942004-02-23 16:11:30 +00002566- SystemACE Support:
2567 CONFIG_SYSTEMACE
2568
2569 Adding this option adds support for Xilinx SystemACE
2570 chips attached via some sort of local bus. The address
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002571 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002572 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenkef893942004-02-23 16:11:30 +00002573
2574 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002575 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenkef893942004-02-23 16:11:30 +00002576
2577 When SystemACE support is added, the "ace" device type
2578 becomes available to the fat commands, i.e. fatls.
2579
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002580- TFTP Fixed UDP Port:
2581 CONFIG_TFTP_PORT
2582
Wolfgang Denk227b5192005-09-24 23:25:46 +02002583 If this is defined, the environment variable tftpsrcp
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002584 is used to supply the TFTP UDP source port value.
Wolfgang Denk227b5192005-09-24 23:25:46 +02002585 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002586 number generator is used.
2587
Wolfgang Denk227b5192005-09-24 23:25:46 +02002588 Also, the environment variable tftpdstp is used to supply
2589 the TFTP UDP destination port value. If tftpdstp isn't
2590 defined, the normal port 69 is used.
2591
2592 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002593 blindly start the TFTP transfer using the pre-configured
2594 target IP address and UDP port. This has the effect of
2595 "punching through" the (Windows XP) firewall, allowing
2596 the remainder of the TFTP transfer to proceed normally.
2597 A better solution is to properly configure the firewall,
2598 but sometimes that is not allowed.
2599
Heiko Schocher443ca402014-01-25 07:27:13 +01002600- bootcount support:
2601 CONFIG_BOOTCOUNT_LIMIT
2602
2603 This enables the bootcounter support, see:
2604 http://www.denx.de/wiki/DULG/UBootBootCountLimit
2605
2606 CONFIG_AT91SAM9XE
2607 enable special bootcounter support on at91sam9xe based boards.
Heiko Schocher443ca402014-01-25 07:27:13 +01002608 CONFIG_SOC_DA8XX
2609 enable special bootcounter support on da850 based boards.
2610 CONFIG_BOOTCOUNT_RAM
2611 enable support for the bootcounter in RAM
2612 CONFIG_BOOTCOUNT_I2C
2613 enable support for the bootcounter on an i2c (like RTC) device.
2614 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
2615 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
2616 the bootcounter.
2617 CONFIG_BOOTCOUNT_ALEN = address len
Simon Glass35191a32013-06-13 15:10:02 -07002618
wdenkc0aa5c52003-12-06 19:49:23 +00002619- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002620 CONFIG_SHOW_BOOT_PROGRESS
2621
wdenk4a5c8a72003-03-06 00:02:04 +00002622 Defining this option allows to add some board-
2623 specific code (calling a user-provided function
2624 "show_boot_progress(int)") that enables you to show
2625 the system's boot progress on some display (for
2626 example, some LED's) on your board. At the moment,
2627 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002628
Simon Glass0fa36a42012-09-28 08:56:37 +00002629
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002630Legacy uImage format:
2631
wdenkc6097192002-11-03 00:24:07 +00002632 Arg Where When
2633 1 common/cmd_bootm.c before attempting to boot an image
wdenk544e9732004-02-06 23:19:44 +00002634 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002635 2 common/cmd_bootm.c Image header has correct magic number
wdenk544e9732004-02-06 23:19:44 +00002636 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002637 3 common/cmd_bootm.c Image header has correct checksum
wdenk544e9732004-02-06 23:19:44 +00002638 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002639 4 common/cmd_bootm.c Image data has correct checksum
2640 -4 common/cmd_bootm.c Image is for unsupported architecture
2641 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002642 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002643 6 common/cmd_bootm.c Image Type check OK
2644 -6 common/cmd_bootm.c gunzip uncompression error
2645 -7 common/cmd_bootm.c Unimplemented compression type
2646 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002647 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002648 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002649
2650 9 common/image.c Start initial ramdisk verification
2651 -10 common/image.c Ramdisk header has bad magic number
2652 -11 common/image.c Ramdisk header has bad checksum
2653 10 common/image.c Ramdisk header is OK
2654 -12 common/image.c Ramdisk data has bad checksum
2655 11 common/image.c Ramdisk data has correct checksum
2656 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002657 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002658 13 common/image.c Start multifile image verification
2659 14 common/image.c No initial ramdisk, no multifile, continue.
2660
Wolfgang Denk092ae952011-10-26 10:21:21 +00002661 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002662
Stefan Roese88fbf932010-04-15 16:07:28 +02002663 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenkd729d302004-02-27 00:07:27 +00002664 -31 post/post.c POST test failed, detected by post_output_backlog()
2665 -32 post/post.c POST test failed, detected by post_run_single()
wdenke97d3d92004-02-23 22:22:28 +00002666
Heiko Schocher633e03a2007-06-22 19:11:54 +02002667 34 common/cmd_doc.c before loading a Image from a DOC device
2668 -35 common/cmd_doc.c Bad usage of "doc" command
2669 35 common/cmd_doc.c correct usage of "doc" command
2670 -36 common/cmd_doc.c No boot device
2671 36 common/cmd_doc.c correct boot device
2672 -37 common/cmd_doc.c Unknown Chip ID on boot device
2673 37 common/cmd_doc.c correct chip ID found, device available
2674 -38 common/cmd_doc.c Read Error on boot device
2675 38 common/cmd_doc.c reading Image header from DOC device OK
2676 -39 common/cmd_doc.c Image header has bad magic number
2677 39 common/cmd_doc.c Image header has correct magic number
2678 -40 common/cmd_doc.c Error reading Image from DOC device
2679 40 common/cmd_doc.c Image header has correct magic number
2680 41 common/cmd_ide.c before loading a Image from a IDE device
2681 -42 common/cmd_ide.c Bad usage of "ide" command
2682 42 common/cmd_ide.c correct usage of "ide" command
2683 -43 common/cmd_ide.c No boot device
2684 43 common/cmd_ide.c boot device found
2685 -44 common/cmd_ide.c Device not available
2686 44 common/cmd_ide.c Device available
2687 -45 common/cmd_ide.c wrong partition selected
2688 45 common/cmd_ide.c partition selected
2689 -46 common/cmd_ide.c Unknown partition table
2690 46 common/cmd_ide.c valid partition table found
2691 -47 common/cmd_ide.c Invalid partition type
2692 47 common/cmd_ide.c correct partition type
2693 -48 common/cmd_ide.c Error reading Image Header on boot device
2694 48 common/cmd_ide.c reading Image Header from IDE device OK
2695 -49 common/cmd_ide.c Image header has bad magic number
2696 49 common/cmd_ide.c Image header has correct magic number
2697 -50 common/cmd_ide.c Image header has bad checksum
2698 50 common/cmd_ide.c Image header has correct checksum
2699 -51 common/cmd_ide.c Error reading Image from IDE device
2700 51 common/cmd_ide.c reading Image from IDE device OK
2701 52 common/cmd_nand.c before loading a Image from a NAND device
2702 -53 common/cmd_nand.c Bad usage of "nand" command
2703 53 common/cmd_nand.c correct usage of "nand" command
2704 -54 common/cmd_nand.c No boot device
2705 54 common/cmd_nand.c boot device found
2706 -55 common/cmd_nand.c Unknown Chip ID on boot device
2707 55 common/cmd_nand.c correct chip ID found, device available
2708 -56 common/cmd_nand.c Error reading Image Header on boot device
2709 56 common/cmd_nand.c reading Image Header from NAND device OK
2710 -57 common/cmd_nand.c Image header has bad magic number
2711 57 common/cmd_nand.c Image header has correct magic number
2712 -58 common/cmd_nand.c Error reading Image from NAND device
2713 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002714
Heiko Schocher633e03a2007-06-22 19:11:54 +02002715 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002716
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002717 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher633e03a2007-06-22 19:11:54 +02002718 -64 net/eth.c no Ethernet found.
2719 65 net/eth.c Ethernet found.
wdenkc6097192002-11-03 00:24:07 +00002720
Heiko Schocher633e03a2007-06-22 19:11:54 +02002721 -80 common/cmd_net.c usage wrong
Joe Hershbergerc80b41b02015-04-08 01:41:21 -05002722 80 common/cmd_net.c before calling net_loop()
2723 -81 common/cmd_net.c some error in net_loop() occurred
2724 81 common/cmd_net.c net_loop() back without error
Heiko Schocher633e03a2007-06-22 19:11:54 +02002725 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2726 82 common/cmd_net.c trying automatic boot
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002727 83 common/cmd_net.c running "source" command
2728 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher633e03a2007-06-22 19:11:54 +02002729 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002730
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002731FIT uImage format:
2732
2733 Arg Where When
2734 100 common/cmd_bootm.c Kernel FIT Image has correct format
2735 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2736 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2737 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2738 102 common/cmd_bootm.c Kernel unit name specified
2739 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +01002740 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002741 104 common/cmd_bootm.c Got kernel subimage node offset
2742 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2743 105 common/cmd_bootm.c Kernel subimage hash verification OK
2744 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2745 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002746 -106 common/cmd_bootm.c Kernel subimage has wrong type
2747 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002748 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2749 108 common/cmd_bootm.c Got kernel subimage data/size
2750 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2751 -109 common/cmd_bootm.c Can't get kernel subimage type
2752 -110 common/cmd_bootm.c Can't get kernel subimage comp
2753 -111 common/cmd_bootm.c Can't get kernel subimage os
2754 -112 common/cmd_bootm.c Can't get kernel subimage load address
2755 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2756
2757 120 common/image.c Start initial ramdisk verification
2758 -120 common/image.c Ramdisk FIT image has incorrect format
2759 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002760 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002761 -122 common/image.c Can't get configuration for ramdisk subimage
2762 123 common/image.c Ramdisk unit name specified
2763 -124 common/image.c Can't get ramdisk subimage node offset
2764 125 common/image.c Got ramdisk subimage node offset
2765 -125 common/image.c Ramdisk subimage hash verification failed
2766 126 common/image.c Ramdisk subimage hash verification OK
2767 -126 common/image.c Ramdisk subimage for unsupported architecture
2768 127 common/image.c Architecture check OK
2769 -127 common/image.c Can't get ramdisk subimage data/size
2770 128 common/image.c Got ramdisk subimage data/size
2771 129 common/image.c Can't get ramdisk load address
2772 -129 common/image.c Got ramdisk load address
2773
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002774 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002775 131 common/cmd_doc.c FIT image format OK
2776
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002777 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002778 141 common/cmd_ide.c FIT image format OK
2779
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002780 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002781 151 common/cmd_nand.c FIT image format OK
2782
Heiko Schocher515eb122014-05-28 11:33:33 +02002783- legacy image format:
2784 CONFIG_IMAGE_FORMAT_LEGACY
2785 enables the legacy image format support in U-Boot.
2786
2787 Default:
2788 enabled if CONFIG_FIT_SIGNATURE is not defined.
2789
2790 CONFIG_DISABLE_IMAGE_LEGACY
2791 disable the legacy image format
2792
2793 This define is introduced, as the legacy image format is
2794 enabled per default for backward compatibility.
2795
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002796- Standalone program support:
2797 CONFIG_STANDALONE_LOAD_ADDR
2798
Wolfgang Denk23f78482011-10-09 21:06:34 +02002799 This option defines a board specific value for the
2800 address where standalone program gets loaded, thus
2801 overwriting the architecture dependent default
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002802 settings.
2803
2804- Frame Buffer Address:
2805 CONFIG_FB_ADDR
2806
2807 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denka71eb8e2013-01-03 00:43:59 +00002808 address for frame buffer. This is typically the case
2809 when using a graphics controller has separate video
2810 memory. U-Boot will then place the frame buffer at
2811 the given address instead of dynamically reserving it
2812 in system RAM by calling lcd_setmem(), which grabs
2813 the memory for the frame buffer depending on the
2814 configured panel size.
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002815
2816 Please see board_init_f function.
2817
Detlev Zundel0ecb6112009-12-01 17:16:19 +01002818- Automatic software updates via TFTP server
2819 CONFIG_UPDATE_TFTP
2820 CONFIG_UPDATE_TFTP_CNT_MAX
2821 CONFIG_UPDATE_TFTP_MSEC_MAX
2822
2823 These options enable and control the auto-update feature;
2824 for a more detailed description refer to doc/README.update.
2825
2826- MTD Support (mtdparts command, UBI support)
2827 CONFIG_MTD_DEVICE
2828
2829 Adds the MTD device infrastructure from the Linux kernel.
2830 Needed for mtdparts command support.
2831
2832 CONFIG_MTD_PARTITIONS
2833
2834 Adds the MTD partitioning infrastructure from the Linux
2835 kernel. Needed for UBI support.
2836
Joe Hershberger7d80fc12013-04-08 10:32:48 +00002837- UBI support
2838 CONFIG_CMD_UBI
2839
2840 Adds commands for interacting with MTD partitions formatted
2841 with the UBI flash translation layer
2842
2843 Requires also defining CONFIG_RBTREE
2844
Joe Hershberger47550fc2013-04-08 10:32:49 +00002845 CONFIG_UBI_SILENCE_MSG
2846
2847 Make the verbose messages from UBI stop printing. This leaves
2848 warnings and errors enabled.
2849
Heiko Schocherf5895d12014-06-24 10:10:04 +02002850
2851 CONFIG_MTD_UBI_WL_THRESHOLD
2852 This parameter defines the maximum difference between the highest
2853 erase counter value and the lowest erase counter value of eraseblocks
2854 of UBI devices. When this threshold is exceeded, UBI starts performing
2855 wear leveling by means of moving data from eraseblock with low erase
2856 counter to eraseblocks with high erase counter.
2857
2858 The default value should be OK for SLC NAND flashes, NOR flashes and
2859 other flashes which have eraseblock life-cycle 100000 or more.
2860 However, in case of MLC NAND flashes which typically have eraseblock
2861 life-cycle less than 10000, the threshold should be lessened (e.g.,
2862 to 128 or 256, although it does not have to be power of 2).
2863
2864 default: 4096
Simon Glass6c0be912014-10-23 18:58:54 -06002865
Heiko Schocherf5895d12014-06-24 10:10:04 +02002866 CONFIG_MTD_UBI_BEB_LIMIT
2867 This option specifies the maximum bad physical eraseblocks UBI
2868 expects on the MTD device (per 1024 eraseblocks). If the
2869 underlying flash does not admit of bad eraseblocks (e.g. NOR
2870 flash), this value is ignored.
2871
2872 NAND datasheets often specify the minimum and maximum NVM
2873 (Number of Valid Blocks) for the flashes' endurance lifetime.
2874 The maximum expected bad eraseblocks per 1024 eraseblocks
2875 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
2876 which gives 20 for most NANDs (MaxNVB is basically the total
2877 count of eraseblocks on the chip).
2878
2879 To put it differently, if this value is 20, UBI will try to
2880 reserve about 1.9% of physical eraseblocks for bad blocks
2881 handling. And that will be 1.9% of eraseblocks on the entire
2882 NAND chip, not just the MTD partition UBI attaches. This means
2883 that if you have, say, a NAND flash chip admits maximum 40 bad
2884 eraseblocks, and it is split on two MTD partitions of the same
2885 size, UBI will reserve 40 eraseblocks when attaching a
2886 partition.
2887
2888 default: 20
2889
2890 CONFIG_MTD_UBI_FASTMAP
2891 Fastmap is a mechanism which allows attaching an UBI device
2892 in nearly constant time. Instead of scanning the whole MTD device it
2893 only has to locate a checkpoint (called fastmap) on the device.
2894 The on-flash fastmap contains all information needed to attach
2895 the device. Using fastmap makes only sense on large devices where
2896 attaching by scanning takes long. UBI will not automatically install
2897 a fastmap on old images, but you can set the UBI parameter
2898 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
2899 that fastmap-enabled images are still usable with UBI implementations
2900 without fastmap support. On typical flash devices the whole fastmap
2901 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
2902
2903 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
2904 Set this parameter to enable fastmap automatically on images
2905 without a fastmap.
2906 default: 0
2907
Heiko Schocher94b66de2015-10-22 06:19:21 +02002908 CONFIG_MTD_UBI_FM_DEBUG
2909 Enable UBI fastmap debug
2910 default: 0
2911
Joe Hershberger7d80fc12013-04-08 10:32:48 +00002912- UBIFS support
2913 CONFIG_CMD_UBIFS
2914
2915 Adds commands for interacting with UBI volumes formatted as
2916 UBIFS. UBIFS is read-only in u-boot.
2917
2918 Requires UBI support as well as CONFIG_LZO
2919
Joe Hershberger47550fc2013-04-08 10:32:49 +00002920 CONFIG_UBIFS_SILENCE_MSG
2921
2922 Make the verbose messages from UBIFS stop printing. This leaves
2923 warnings and errors enabled.
2924
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002925- SPL framework
Wolfgang Denk825223d2011-09-11 21:24:09 +02002926 CONFIG_SPL
2927 Enable building of SPL globally.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002928
Tom Rini36853852012-02-14 07:29:40 +00002929 CONFIG_SPL_LDSCRIPT
2930 LDSCRIPT for linking the SPL binary.
2931
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002932 CONFIG_SPL_MAX_FOOTPRINT
2933 Maximum size in memory allocated to the SPL, BSS included.
2934 When defined, the linker checks that the actual memory
2935 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00002936 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002937 must not be both defined at the same time.
2938
Tom Rini36853852012-02-14 07:29:40 +00002939 CONFIG_SPL_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002940 Maximum size of the SPL image (text, data, rodata, and
2941 linker lists sections), BSS excluded.
2942 When defined, the linker checks that the actual size does
2943 not exceed it.
Tom Rini36853852012-02-14 07:29:40 +00002944
Wolfgang Denk825223d2011-09-11 21:24:09 +02002945 CONFIG_SPL_TEXT_BASE
2946 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002947
Scott Woodc4f0d002012-09-20 19:05:12 -05002948 CONFIG_SPL_RELOC_TEXT_BASE
2949 Address to relocate to. If unspecified, this is equal to
2950 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
2951
Tom Rini36853852012-02-14 07:29:40 +00002952 CONFIG_SPL_BSS_START_ADDR
2953 Link address for the BSS within the SPL binary.
2954
2955 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002956 Maximum size in memory allocated to the SPL BSS.
2957 When defined, the linker checks that the actual memory used
2958 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00002959 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002960 must not be both defined at the same time.
Tom Rini36853852012-02-14 07:29:40 +00002961
2962 CONFIG_SPL_STACK
2963 Adress of the start of the stack SPL will use
2964
Albert ARIBAUD \(3ADEV\)287b0942015-03-31 11:40:50 +02002965 CONFIG_SPL_PANIC_ON_RAW_IMAGE
2966 When defined, SPL will panic() if the image it has
2967 loaded does not have a signature.
2968 Defining this is useful when code which loads images
2969 in SPL cannot guarantee that absolutely all read errors
2970 will be caught.
2971 An example is the LPC32XX MLC NAND driver, which will
2972 consider that a completely unreadable NAND block is bad,
2973 and thus should be skipped silently.
2974
Scott Woodc4f0d002012-09-20 19:05:12 -05002975 CONFIG_SPL_RELOC_STACK
2976 Adress of the start of the stack SPL will use after
2977 relocation. If unspecified, this is equal to
2978 CONFIG_SPL_STACK.
2979
Tom Rini36853852012-02-14 07:29:40 +00002980 CONFIG_SYS_SPL_MALLOC_START
2981 Starting address of the malloc pool used in SPL.
Fabio Estevam38e1a972015-11-12 12:30:19 -02002982 When this option is set the full malloc is used in SPL and
2983 it is set up by spl_init() and before that, the simple malloc()
2984 can be used if CONFIG_SYS_MALLOC_F is defined.
Tom Rini36853852012-02-14 07:29:40 +00002985
2986 CONFIG_SYS_SPL_MALLOC_SIZE
2987 The size of the malloc pool used in SPL.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002988
Tom Rini28591df2012-08-13 12:03:19 -07002989 CONFIG_SPL_FRAMEWORK
2990 Enable the SPL framework under common/. This framework
2991 supports MMC, NAND and YMODEM loading of U-Boot and NAND
2992 NAND loading of the Linux Kernel.
2993
Tom Rinic2b76002014-03-28 12:03:39 -04002994 CONFIG_SPL_OS_BOOT
2995 Enable booting directly to an OS from SPL.
2996 See also: doc/README.falcon
2997
Tom Rinife3b0c72012-08-13 11:37:56 -07002998 CONFIG_SPL_DISPLAY_PRINT
2999 For ARM, enable an optional function to print more information
3000 about the running system.
3001
Scott Wood7c810902012-09-20 16:35:21 -05003002 CONFIG_SPL_INIT_MINIMAL
3003 Arch init code should be built for a very small image
3004
Paul Kocialkowski17675c82014-11-08 23:14:56 +01003005 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
3006 Partition on the MMC to load U-Boot from when the MMC is being
3007 used in raw mode
3008
Peter Korsgaard01b542f2013-05-13 08:36:29 +00003009 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3010 Sector to load kernel uImage from when MMC is being
3011 used in raw mode (for Falcon mode)
3012
3013 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3014 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3015 Sector and number of sectors to load kernel argument
3016 parameters from when MMC is being used in raw mode
3017 (for falcon mode)
3018
Paul Kocialkowski341e8cd2014-11-08 23:14:55 +01003019 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
3020 Partition on the MMC to load U-Boot from when the MMC is being
3021 used in fs mode
3022
Guillaume GARDET5065b712014-10-15 17:53:13 +02003023 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
3024 Filename to read to load U-Boot when reading from filesystem
3025
3026 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003027 Filename to read to load kernel uImage when reading
Guillaume GARDET5065b712014-10-15 17:53:13 +02003028 from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003029
Guillaume GARDET5065b712014-10-15 17:53:13 +02003030 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003031 Filename to read to load kernel argument parameters
Guillaume GARDET5065b712014-10-15 17:53:13 +02003032 when reading from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003033
Scott Wood2b36fbb2012-12-06 13:33:17 +00003034 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3035 Set this for NAND SPL on PPC mpc83xx targets, so that
3036 start.S waits for the rest of the SPL to load before
3037 continuing (the hardware starts execution after just
3038 loading the first page rather than the full 4K).
3039
Prabhakar Kushwaha6e2b9a32014-04-08 19:12:31 +05303040 CONFIG_SPL_SKIP_RELOCATE
3041 Avoid SPL relocation
3042
Scott Woodc352a0c2012-09-20 19:09:07 -05003043 CONFIG_SPL_NAND_BASE
3044 Include nand_base.c in the SPL. Requires
3045 CONFIG_SPL_NAND_DRIVERS.
3046
3047 CONFIG_SPL_NAND_DRIVERS
3048 SPL uses normal NAND drivers, not minimal drivers.
3049
3050 CONFIG_SPL_NAND_ECC
3051 Include standard software ECC in the SPL
3052
Tom Rini36853852012-02-14 07:29:40 +00003053 CONFIG_SPL_NAND_SIMPLE
Scott Wood36c440e2012-09-21 18:35:27 -05003054 Support for NAND boot using simple NAND drivers that
3055 expose the cmd_ctrl() interface.
Tom Rini36853852012-02-14 07:29:40 +00003056
Thomas Gleixner820d24d2016-07-12 20:28:12 +02003057 CONFIG_SPL_UBI
3058 Support for a lightweight UBI (fastmap) scanner and
3059 loader
3060
Heiko Schochercf000272014-10-31 08:31:00 +01003061 CONFIG_SPL_NAND_RAW_ONLY
3062 Support to boot only raw u-boot.bin images. Use this only
3063 if you need to save space.
3064
Ying Zhangdfb2b152013-08-16 15:16:12 +08003065 CONFIG_SPL_COMMON_INIT_DDR
3066 Set for common ddr init with serial presence detect in
3067 SPL binary.
3068
Tom Rini36853852012-02-14 07:29:40 +00003069 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3070 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3071 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3072 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3073 CONFIG_SYS_NAND_ECCBYTES
3074 Defines the size and behavior of the NAND that SPL uses
Scott Wood36c440e2012-09-21 18:35:27 -05003075 to read U-Boot
Tom Rini36853852012-02-14 07:29:40 +00003076
Prabhakar Kushwahaafffcb02013-12-11 12:42:11 +05303077 CONFIG_SPL_NAND_BOOT
3078 Add support NAND boot
3079
Tom Rini36853852012-02-14 07:29:40 +00003080 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood36c440e2012-09-21 18:35:27 -05003081 Location in NAND to read U-Boot from
3082
3083 CONFIG_SYS_NAND_U_BOOT_DST
3084 Location in memory to load U-Boot to
3085
3086 CONFIG_SYS_NAND_U_BOOT_SIZE
3087 Size of image to load
Tom Rini36853852012-02-14 07:29:40 +00003088
3089 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood36c440e2012-09-21 18:35:27 -05003090 Entry point in loaded image to jump to
Tom Rini36853852012-02-14 07:29:40 +00003091
3092 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3093 Define this if you need to first read the OOB and then the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003094 data. This is used, for example, on davinci platforms.
Tom Rini36853852012-02-14 07:29:40 +00003095
3096 CONFIG_SPL_OMAP3_ID_NAND
3097 Support for an OMAP3-specific set of functions to return the
3098 ID and MFR of the first attached NAND chip, if present.
3099
Pavel Machekde997252012-08-30 22:42:11 +02003100 CONFIG_SPL_RAM_DEVICE
3101 Support for running image already present in ram, in SPL binary
3102
Scott Woodeb7bd972012-12-06 13:33:16 +00003103 CONFIG_SPL_PAD_TO
Benoît Thébaudeauf0180722013-04-11 09:35:49 +00003104 Image offset to which the SPL should be padded before appending
3105 the SPL payload. By default, this is defined as
3106 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3107 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3108 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Woodeb7bd972012-12-06 13:33:16 +00003109
Scott Woodf147eb72012-09-21 16:27:32 -05003110 CONFIG_SPL_TARGET
3111 Final target image containing SPL and payload. Some SPLs
3112 use an arch-specific makefile fragment instead, for
3113 example if more than one image needs to be produced.
3114
Simon Glass82d94532013-05-08 08:05:59 +00003115 CONFIG_FIT_SPL_PRINT
3116 Printing information about a FIT image adds quite a bit of
3117 code to SPL. So this is normally disabled in SPL. Use this
3118 option to re-enable it. This will affect the output of the
3119 bootm command when booting a FIT image.
3120
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003121- TPL framework
3122 CONFIG_TPL
3123 Enable building of TPL globally.
3124
3125 CONFIG_TPL_PAD_TO
3126 Image offset to which the TPL should be padded before appending
3127 the TPL payload. By default, this is defined as
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02003128 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3129 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3130 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003131
wdenkc0aa5c52003-12-06 19:49:23 +00003132- Interrupt support (PPC):
3133
wdenk1ebf41e2004-01-02 14:00:00 +00003134 There are common interrupt_init() and timer_interrupt()
3135 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003136 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00003137 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003138 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00003139 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003140 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00003141 specific handling. If board has watchdog / status_led
3142 / other_activity_monitor it works automatically from
3143 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00003144
wdenkc6097192002-11-03 00:24:07 +00003145
Helmut Raigerd5a184b2011-10-20 04:19:47 +00003146Board initialization settings:
3147------------------------------
3148
3149During Initialization u-boot calls a number of board specific functions
3150to allow the preparation of board specific prerequisites, e.g. pin setup
3151before drivers are initialized. To enable these callbacks the
3152following configuration macros have to be defined. Currently this is
3153architecture specific, so please check arch/your_architecture/lib/board.c
3154typically in board_init_f() and board_init_r().
3155
3156- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3157- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3158- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3159- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003160
wdenkc6097192002-11-03 00:24:07 +00003161Configuration Settings:
3162-----------------------
3163
York Sun6c480012014-02-26 17:03:19 -08003164- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3165 Optionally it can be defined to support 64-bit memory commands.
3166
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003167- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003168 undefine this when you're short of memory.
3169
Peter Tyserdfb72b82009-01-27 18:03:12 -06003170- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3171 width of the commands listed in the 'help' command output.
3172
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003173- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003174 prompt for user input.
3175
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003176- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003177
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003178- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003179
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003180- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003181
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003182- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003183 the application (usually a Linux kernel) when it is
3184 booted
3185
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003186- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003187 List of legal baudrate settings for this board.
3188
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003189- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003190 Begin and End addresses of the area used by the
3191 simple memory test.
3192
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003193- CONFIG_SYS_ALT_MEMTEST:
wdenk57b2d802003-06-27 21:31:46 +00003194 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003195
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003196- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5958f4a2003-09-18 09:21:33 +00003197 Scratch address used by the alternate memory test
3198 You only need to set this if address zero isn't writeable
3199
York Sun5d286cd2015-12-04 11:57:07 -08003200- CONFIG_SYS_MEM_RESERVE_SECURE
York Sun1ef95cc2016-06-24 16:46:18 -07003201 Only implemented for ARMv8 for now.
York Sun5d286cd2015-12-04 11:57:07 -08003202 If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
3203 is substracted from total RAM and won't be reported to OS.
3204 This memory can be used as secure memory. A variable
York Sun1ef95cc2016-06-24 16:46:18 -07003205 gd->arch.secure_ram is used to track the location. In systems
York Sun5d286cd2015-12-04 11:57:07 -08003206 the RAM base is not zero, or RAM is divided into banks,
3207 this variable needs to be recalcuated to get the address.
3208
York Sun50739372015-12-07 11:05:29 -08003209- CONFIG_SYS_MEM_TOP_HIDE:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003210 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01003211 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003212 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01003213 fixing up gd->ram_size the Linux kernel should gets passed
3214 the now "corrected" memory size and won't touch it either.
3215 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01003216 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01003217 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01003218 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01003219
3220 This option can be used as a workaround for the 440EPx/GRx
3221 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3222 be touched.
3223
3224 WARNING: Please make sure that this value is a multiple of
3225 the Linux page size (normally 4k). If this is not the case,
3226 then the end address of the Linux memory will be located at a
3227 non page size aligned address and this could cause major
3228 problems.
3229
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003230- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003231 Enable temporary baudrate change while serial download
3232
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003233- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003234 Physical start address of SDRAM. _Must_ be 0 here.
3235
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003236- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003237 Physical start address of Flash memory.
3238
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003239- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003240 Physical start address of boot monitor code (set by
3241 make config files to be same as the text base address
Wolfgang Denk0708bc62010-10-07 21:51:12 +02003242 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003243 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003244
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003245- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00003246 Size of memory reserved for monitor code, used to
3247 determine _at_compile_time_ (!) if the environment is
3248 embedded within the U-Boot image, or in a separate
3249 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003250
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003251- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003252 Size of DRAM reserved for malloc() use.
3253
Simon Glass863e4042014-07-10 22:23:28 -06003254- CONFIG_SYS_MALLOC_F_LEN
3255 Size of the malloc() pool for use before relocation. If
3256 this is defined, then a very simple malloc() implementation
3257 will become available before relocation. The address is just
3258 below the global data, and the stack is moved down to make
3259 space.
3260
3261 This feature allocates regions with increasing addresses
3262 within the region. calloc() is supported, but realloc()
3263 is not available. free() is supported but does nothing.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003264 The memory will be freed (or in fact just forgotten) when
Simon Glass863e4042014-07-10 22:23:28 -06003265 U-Boot relocates itself.
3266
Simon Glass9fa901b2014-11-10 17:16:54 -07003267- CONFIG_SYS_MALLOC_SIMPLE
3268 Provides a simple and small malloc() and calloc() for those
3269 boards which do not use the full malloc in SPL (which is
3270 enabled with CONFIG_SYS_SPL_MALLOC_START).
3271
Thierry Redingc97d9742014-12-09 22:25:22 -07003272- CONFIG_SYS_NONCACHED_MEMORY:
3273 Size of non-cached memory area. This area of memory will be
3274 typically located right below the malloc() area and mapped
3275 uncached in the MMU. This is useful for drivers that would
3276 otherwise require a lot of explicit cache maintenance. For
3277 some drivers it's also impossible to properly maintain the
3278 cache. For example if the regions that need to be flushed
3279 are not a multiple of the cache-line size, *and* padding
3280 cannot be allocated between the regions to align them (i.e.
3281 if the HW requires a contiguous array of regions, and the
3282 size of each region is not cache-aligned), then a flush of
3283 one region may result in overwriting data that hardware has
3284 written to another region in the same cache-line. This can
3285 happen for example in network drivers where descriptors for
3286 buffers are typically smaller than the CPU cache-line (e.g.
3287 16 bytes vs. 32 or 64 bytes).
3288
3289 Non-cached memory is only supported on 32-bit ARM at present.
3290
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003291- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01003292 Normally compressed uImages are limited to an
3293 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003294 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01003295 to adjust this setting to your needs.
3296
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003297- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003298 Maximum size of memory mapped by the startup code of
3299 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003300 the Linux kernel (bd_info, boot arguments, FDT blob if
3301 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003302 environment variable is defined and non-zero. In such case
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003303 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denk092ae952011-10-26 10:21:21 +00003304 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likely26396382011-03-28 09:58:43 +00003305 variable "bootm_mapsize" will override the value of
3306 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3307 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003308
John Rigbyeea8e692010-10-13 13:57:35 -06003309- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3310 Enable initrd_high functionality. If defined then the
3311 initrd_high feature is enabled and the bootm ramdisk subcommand
3312 is enabled.
3313
3314- CONFIG_SYS_BOOT_GET_CMDLINE:
3315 Enables allocating and saving kernel cmdline in space between
3316 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3317
3318- CONFIG_SYS_BOOT_GET_KBD:
3319 Enables allocating and saving a kernel copy of the bd_info in
3320 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3321
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003322- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003323 Max number of Flash memory banks
3324
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003325- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003326 Max number of sectors on a Flash chip
3327
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003328- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003329 Timeout for Flash erase operations (in ms)
3330
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003331- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003332 Timeout for Flash write operations (in ms)
3333
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003334- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003335 Timeout for Flash set sector lock bit operation (in ms)
3336
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003337- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003338 Timeout for Flash clear lock bits operation (in ms)
3339
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003340- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00003341 If defined, hardware flash sectors protection is used
3342 instead of U-Boot software protection.
3343
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003344- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003345
3346 Enable TFTP transfers directly to flash memory;
3347 without this option such a download has to be
3348 performed in two steps: (1) download to RAM, and (2)
3349 copy from RAM to flash.
3350
3351 The two-step approach is usually more reliable, since
3352 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003353 the flash, but in some situations (when system RAM is
3354 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003355 downloaded image) this option may be very useful.
3356
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003357- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00003358 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00003359 common flash structure for storing flash geometry.
3360
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02003361- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00003362 This option also enables the building of the cfi_flash driver
3363 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003364
Piotr Ziecik3e939e92008-11-17 15:57:58 +01003365- CONFIG_FLASH_CFI_MTD
3366 This option enables the building of the cfi_mtd driver
3367 in the drivers directory. The driver exports CFI flash
3368 to the MTD layer.
3369
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003370- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02003371 Use buffered writes to flash.
3372
3373- CONFIG_FLASH_SPANSION_S29WS_N
3374 s29ws-n MirrorBit flash has non-standard addresses for buffered
3375 write commands.
3376
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003377- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01003378 If this option is defined, the common CFI flash doesn't
3379 print it's warning upon not recognized FLASH banks. This
3380 is useful, if some of the configured banks are only
3381 optionally available.
3382
Jerry Van Barenaae73572008-03-08 13:48:01 -05003383- CONFIG_FLASH_SHOW_PROGRESS
3384 If defined (must be an integer), print out countdown
3385 digits and dots. Recommended value: 45 (9..1) for 80
3386 column displays, 15 (3..1) for 40 column displays.
3387
Stefan Roesed20cba52013-04-04 15:53:14 +02003388- CONFIG_FLASH_VERIFY
3389 If defined, the content of the flash (destination) is compared
3390 against the source after the write operation. An error message
3391 will be printed when the contents are not identical.
3392 Please note that this option is useless in nearly all cases,
3393 since such flash programming errors usually are detected earlier
3394 while unprotecting/erasing/programming. Please only enable
3395 this option if you really know what you are doing.
3396
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003397- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003398 Defines the number of Ethernet receive buffers. On some
3399 Ethernet controllers it is recommended to set this value
stroese94ef1cf2003-06-05 15:39:44 +00003400 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3401 buffers can be full shortly after enabling the interface
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003402 on high Ethernet traffic.
stroese94ef1cf2003-06-05 15:39:44 +00003403 Defaults to 4 if not defined.
3404
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003405- CONFIG_ENV_MAX_ENTRIES
3406
Wolfgang Denk1136f692010-10-27 22:48:30 +02003407 Maximum number of entries in the hash table that is used
3408 internally to store the environment settings. The default
3409 setting is supposed to be generous and should work in most
3410 cases. This setting can be used to tune behaviour; see
3411 lib/hashtable.c for details.
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003412
Joe Hershberger71497d02012-12-11 22:16:31 -06003413- CONFIG_ENV_FLAGS_LIST_DEFAULT
3414- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003415 Enable validation of the values given to environment variables when
Joe Hershberger71497d02012-12-11 22:16:31 -06003416 calling env set. Variables can be restricted to only decimal,
3417 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3418 the variables can also be restricted to IP address or MAC address.
3419
3420 The format of the list is:
3421 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003422 access_attribute = [a|r|o|c]
3423 attributes = type_attribute[access_attribute]
Joe Hershberger71497d02012-12-11 22:16:31 -06003424 entry = variable_name[:attributes]
3425 list = entry[,list]
3426
3427 The type attributes are:
3428 s - String (default)
3429 d - Decimal
3430 x - Hexadecimal
3431 b - Boolean ([1yYtT|0nNfF])
3432 i - IP address
3433 m - MAC address
3434
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003435 The access attributes are:
3436 a - Any (default)
3437 r - Read-only
3438 o - Write-once
3439 c - Change-default
3440
Joe Hershberger71497d02012-12-11 22:16:31 -06003441 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3442 Define this to a list (string) to define the ".flags"
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003443 environment variable in the default or embedded environment.
Joe Hershberger71497d02012-12-11 22:16:31 -06003444
3445 - CONFIG_ENV_FLAGS_LIST_STATIC
3446 Define this to a list (string) to define validation that
3447 should be done if an entry is not found in the ".flags"
3448 environment variable. To override a setting in the static
3449 list, simply add an entry for the same variable name to the
3450 ".flags" variable.
3451
Joe Hershberger6db9fd42015-05-20 14:27:20 -05003452 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
3453 regular expression. This allows multiple variables to define the same
3454 flags without explicitly listing them for each variable.
3455
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003456- CONFIG_ENV_ACCESS_IGNORE_FORCE
3457 If defined, don't allow the -f switch to env set override variable
3458 access flags.
3459
Gabe Black3687fe42014-10-15 04:38:30 -06003460- CONFIG_USE_STDINT
3461 If stdint.h is available with your toolchain you can define this
3462 option to enable it. You can provide option 'USE_STDINT=1' when
3463 building U-Boot to enable this.
3464
wdenkc6097192002-11-03 00:24:07 +00003465The following definitions that deal with the placement and management
3466of environment data (variable area); in general, we support the
3467following configurations:
3468
Mike Frysinger63b8f122011-07-08 10:44:25 +00003469- CONFIG_BUILD_ENVCRC:
3470
3471 Builds up envcrc with the target environment so that external utils
3472 may easily extract it and embed it in final U-Boot images.
3473
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02003474- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00003475
3476 Define this if the environment is in flash memory.
3477
3478 a) The environment occupies one whole flash sector, which is
3479 "embedded" in the text segment with the U-Boot code. This
3480 happens usually with "bottom boot sector" or "top boot
3481 sector" type flash chips, which have several smaller
3482 sectors at the start or the end. For instance, such a
3483 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3484 such a case you would place the environment in one of the
3485 4 kB sectors - with U-Boot code before and after it. With
3486 "top boot sector" type flash chips, you would put the
3487 environment in one of the last sectors, leaving a gap
3488 between U-Boot and the environment.
3489
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003490 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003491
3492 Offset of environment data (variable area) to the
3493 beginning of flash memory; for instance, with bottom boot
3494 type flash chips the second sector can be used: the offset
3495 for this sector is given here.
3496
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003497 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00003498
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003499 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003500
3501 This is just another way to specify the start address of
3502 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003503 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00003504
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003505 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003506
3507 Size of the sector containing the environment.
3508
3509
3510 b) Sometimes flash chips have few, equal sized, BIG sectors.
3511 In such a case you don't want to spend a whole sector for
3512 the environment.
3513
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003514 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003515
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02003516 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003517 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00003518 of this flash sector for the environment. This saves
3519 memory for the RAM copy of the environment.
3520
3521 It may also save flash memory if you decide to use this
3522 when your environment is "embedded" within U-Boot code,
3523 since then the remainder of the flash sector could be used
3524 for U-Boot code. It should be pointed out that this is
3525 STRONGLY DISCOURAGED from a robustness point of view:
3526 updating the environment in flash makes it always
3527 necessary to erase the WHOLE sector. If something goes
3528 wrong before the contents has been restored from a copy in
3529 RAM, your target system will be dead.
3530
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003531 - CONFIG_ENV_ADDR_REDUND
3532 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00003533
wdenk4a5c8a72003-03-06 00:02:04 +00003534 These settings describe a second storage area used to hold
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003535 a redundant copy of the environment data, so that there is
wdenkb02744a2003-04-05 00:53:31 +00003536 a valid backup copy in case there is a power failure during
wdenk4a5c8a72003-03-06 00:02:04 +00003537 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00003538
3539BE CAREFUL! Any changes to the flash layout, and some changes to the
3540source code will make it necessary to adapt <board>/u-boot.lds*
3541accordingly!
3542
3543
Jean-Christophe PLAGNIOL-VILLARDfdb79c32008-09-10 22:47:59 +02003544- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00003545
3546 Define this if you have some non-volatile memory device
3547 (NVRAM, battery buffered SRAM) which you want to use for the
3548 environment.
3549
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003550 - CONFIG_ENV_ADDR:
3551 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003552
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003553 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00003554 want to use for environment. It is assumed that this memory
3555 can just be read and written to, without any special
3556 provision.
3557
3558BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003559in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003560console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00003561U-Boot will hang.
3562
3563Please note that even with NVRAM we still use a copy of the
3564environment in RAM: we could work on NVRAM directly, but we want to
3565keep settings there always unmodified except somebody uses "saveenv"
3566to save the current settings.
3567
3568
Jean-Christophe PLAGNIOL-VILLARDe46af642008-09-05 09:19:30 +02003569- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00003570
3571 Use this if you have an EEPROM or similar serial access
3572 device and a driver for it.
3573
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003574 - CONFIG_ENV_OFFSET:
3575 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003576
3577 These two #defines specify the offset and size of the
3578 environment area within the total memory of your EEPROM.
3579
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003580 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003581 If defined, specified the chip address of the EEPROM device.
3582 The default address is zero.
3583
Christian Gmeiner4c5b7542015-02-11 15:19:31 +01003584 - CONFIG_SYS_I2C_EEPROM_BUS:
3585 If defined, specified the i2c bus of the EEPROM device.
3586
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003587 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00003588 If defined, the number of bits used to address bytes in a
3589 single page in the EEPROM device. A 64 byte page, for example
3590 would require six bits.
3591
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003592 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00003593 If defined, the number of milliseconds to delay between
wdenk544e9732004-02-06 23:19:44 +00003594 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00003595
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003596 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00003597 The length in bytes of the EEPROM memory array address. Note
3598 that this is NOT the chip address length!
3599
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003600 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk20c98a62004-04-23 20:32:05 +00003601 EEPROM chips that implement "address overflow" are ones
3602 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
3603 address and the extra bits end up in the "chip address" bit
3604 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
3605 byte chips.
3606
3607 Note that we consider the length of the address field to
3608 still be one byte because the extra address bits are hidden
3609 in the chip address.
3610
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003611 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003612 The size in bytes of the EEPROM device.
3613
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01003614 - CONFIG_ENV_EEPROM_IS_ON_I2C
3615 define this, if you have I2C and SPI activated, and your
3616 EEPROM, which holds the environment, is on the I2C bus.
3617
3618 - CONFIG_I2C_ENV_EEPROM_BUS
3619 if you have an Environment on an EEPROM reached over
3620 I2C muxes, you can define here, how to reach this
3621 EEPROM. For example:
3622
Heiko Schocher479a4cf2013-01-29 08:53:15 +01003623 #define CONFIG_I2C_ENV_EEPROM_BUS 1
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01003624
3625 EEPROM which holds the environment, is reached over
3626 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00003627
Jean-Christophe PLAGNIOL-VILLARD2b14d2b2008-09-10 22:47:58 +02003628- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk86765902003-12-06 23:55:10 +00003629
wdenk1ebf41e2004-01-02 14:00:00 +00003630 Define this if you have a DataFlash memory device which you
wdenk86765902003-12-06 23:55:10 +00003631 want to use for the environment.
3632
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003633 - CONFIG_ENV_OFFSET:
3634 - CONFIG_ENV_ADDR:
3635 - CONFIG_ENV_SIZE:
wdenk86765902003-12-06 23:55:10 +00003636
3637 These three #defines specify the offset and size of the
3638 environment area within the total memory of your DataFlash placed
3639 at the specified address.
3640
Wu, Josh76db7bf2014-07-01 19:30:13 +08003641- CONFIG_ENV_IS_IN_SPI_FLASH:
3642
3643 Define this if you have a SPI Flash memory device which you
3644 want to use for the environment.
3645
3646 - CONFIG_ENV_OFFSET:
3647 - CONFIG_ENV_SIZE:
3648
3649 These two #defines specify the offset and size of the
3650 environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
3651 aligned to an erase sector boundary.
3652
3653 - CONFIG_ENV_SECT_SIZE:
3654
3655 Define the SPI flash's sector size.
3656
3657 - CONFIG_ENV_OFFSET_REDUND (optional):
3658
3659 This setting describes a second storage area of CONFIG_ENV_SIZE
3660 size used to hold a redundant copy of the environment data, so
3661 that there is a valid backup copy in case there is a power failure
Simon Glass5b9a5172016-10-02 18:00:58 -06003662 during a "saveenv" operation. CONFIG_ENV_OFFSET_REDUND must be
Wu, Josh76db7bf2014-07-01 19:30:13 +08003663 aligned to an erase sector boundary.
3664
3665 - CONFIG_ENV_SPI_BUS (optional):
3666 - CONFIG_ENV_SPI_CS (optional):
3667
3668 Define the SPI bus and chip select. If not defined they will be 0.
3669
3670 - CONFIG_ENV_SPI_MAX_HZ (optional):
3671
3672 Define the SPI max work clock. If not defined then use 1MHz.
3673
3674 - CONFIG_ENV_SPI_MODE (optional):
3675
3676 Define the SPI work mode. If not defined then use SPI_MODE_3.
3677
Liu Gang85bcd732012-03-08 00:33:20 +00003678- CONFIG_ENV_IS_IN_REMOTE:
3679
3680 Define this if you have a remote memory space which you
3681 want to use for the local device's environment.
3682
3683 - CONFIG_ENV_ADDR:
3684 - CONFIG_ENV_SIZE:
3685
3686 These two #defines specify the address and size of the
3687 environment area within the remote memory space. The
3688 local device can get the environment from remote memory
Liu Gang357bf5a2012-08-09 05:10:01 +00003689 space by SRIO or PCIE links.
Liu Gang85bcd732012-03-08 00:33:20 +00003690
3691BE CAREFUL! For some special cases, the local device can not use
3692"saveenv" command. For example, the local device will get the
Liu Gang357bf5a2012-08-09 05:10:01 +00003693environment stored in a remote NOR flash by SRIO or PCIE link,
3694but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang85bcd732012-03-08 00:33:20 +00003695
Jean-Christophe PLAGNIOL-VILLARDdda84dd2008-09-10 22:47:58 +02003696- CONFIG_ENV_IS_IN_NAND:
wdenk79b59372004-06-09 14:58:14 +00003697
3698 Define this if you have a NAND device which you want to use
3699 for the environment.
3700
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003701 - CONFIG_ENV_OFFSET:
3702 - CONFIG_ENV_SIZE:
wdenk79b59372004-06-09 14:58:14 +00003703
3704 These two #defines specify the offset and size of the environment
Scott Wood08239322010-09-17 14:38:37 -05003705 area within the first NAND device. CONFIG_ENV_OFFSET must be
3706 aligned to an erase block boundary.
wdenk86765902003-12-06 23:55:10 +00003707
Scott Wood08239322010-09-17 14:38:37 -05003708 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01003709
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003710 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Wood08239322010-09-17 14:38:37 -05003711 size used to hold a redundant copy of the environment data, so
3712 that there is a valid backup copy in case there is a power failure
Simon Glass5b9a5172016-10-02 18:00:58 -06003713 during a "saveenv" operation. CONFIG_ENV_OFFSET_REDUND must be
Scott Wood08239322010-09-17 14:38:37 -05003714 aligned to an erase block boundary.
3715
3716 - CONFIG_ENV_RANGE (optional):
3717
3718 Specifies the length of the region in which the environment
3719 can be written. This should be a multiple of the NAND device's
3720 block size. Specifying a range with more erase blocks than
3721 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3722 the range to be avoided.
3723
3724 - CONFIG_ENV_OFFSET_OOB (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01003725
Scott Wood08239322010-09-17 14:38:37 -05003726 Enables support for dynamically retrieving the offset of the
3727 environment from block zero's out-of-band data. The
3728 "nand env.oob" command can be used to record this offset.
3729 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3730 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01003731
Guennadi Liakhovetskifad24442009-05-18 16:07:22 +02003732- CONFIG_NAND_ENV_DST
3733
3734 Defines address in RAM to which the nand_spl code should copy the
3735 environment. If redundant environment is used, it will be copied to
3736 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3737
Joe Hershberger0c5faa82013-04-08 10:32:51 +00003738- CONFIG_ENV_IS_IN_UBI:
3739
3740 Define this if you have an UBI volume that you want to use for the
3741 environment. This has the benefit of wear-leveling the environment
3742 accesses, which is important on NAND.
3743
3744 - CONFIG_ENV_UBI_PART:
3745
3746 Define this to a string that is the mtd partition containing the UBI.
3747
3748 - CONFIG_ENV_UBI_VOLUME:
3749
3750 Define this to the name of the volume that you want to store the
3751 environment in.
3752
Joe Hershbergerdb14e862013-04-08 10:32:52 +00003753 - CONFIG_ENV_UBI_VOLUME_REDUND:
3754
3755 Define this to the name of another volume to store a second copy of
3756 the environment in. This will enable redundant environments in UBI.
3757 It is assumed that both volumes are in the same MTD partition.
3758
Joe Hershberger0c5faa82013-04-08 10:32:51 +00003759 - CONFIG_UBI_SILENCE_MSG
3760 - CONFIG_UBIFS_SILENCE_MSG
3761
3762 You will probably want to define these to avoid a really noisy system
3763 when storing the env in UBI.
3764
Wu, Josha7d0c872014-06-24 17:31:03 +08003765- CONFIG_ENV_IS_IN_FAT:
3766 Define this if you want to use the FAT file system for the environment.
3767
3768 - FAT_ENV_INTERFACE:
3769
3770 Define this to a string that is the name of the block device.
3771
Nicolae Rosia86811f22016-11-21 17:33:58 +02003772 - FAT_ENV_DEVICE_AND_PART:
Wu, Josha7d0c872014-06-24 17:31:03 +08003773
3774 Define this to a string to specify the partition of the device. It can
3775 be as following:
3776
3777 "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
3778 - "D:P": device D partition P. Error occurs if device D has no
3779 partition table.
3780 - "D:0": device D.
3781 - "D" or "D:": device D partition 1 if device D has partition
3782 table, or the whole device D if has no partition
3783 table.
3784 - "D:auto": first partition in device D with bootable flag set.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003785 If none, first valid partition in device D. If no
Wu, Josha7d0c872014-06-24 17:31:03 +08003786 partition table then means device D.
3787
3788 - FAT_ENV_FILE:
3789
3790 It's a string of the FAT file name. This file use to store the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003791 environment.
Wu, Josha7d0c872014-06-24 17:31:03 +08003792
3793 - CONFIG_FAT_WRITE:
Tom Rinid8532af2017-06-02 11:03:50 -04003794 This must be enabled. Otherwise it cannot save the environment file.
Wu, Josha7d0c872014-06-24 17:31:03 +08003795
Stephen Warreneedcacd2013-06-11 15:14:00 -06003796- CONFIG_ENV_IS_IN_MMC:
3797
3798 Define this if you have an MMC device which you want to use for the
3799 environment.
3800
3801 - CONFIG_SYS_MMC_ENV_DEV:
3802
3803 Specifies which MMC device the environment is stored in.
3804
3805 - CONFIG_SYS_MMC_ENV_PART (optional):
3806
3807 Specifies which MMC partition the environment is stored in. If not
3808 set, defaults to partition 0, the user area. Common values might be
3809 1 (first MMC boot partition), 2 (second MMC boot partition).
3810
3811 - CONFIG_ENV_OFFSET:
3812 - CONFIG_ENV_SIZE:
3813
3814 These two #defines specify the offset and size of the environment
3815 area within the specified MMC device.
3816
Stephen Warren24dc2032013-06-11 15:14:02 -06003817 If offset is positive (the usual case), it is treated as relative to
3818 the start of the MMC partition. If offset is negative, it is treated
3819 as relative to the end of the MMC partition. This can be useful if
3820 your board may be fitted with different MMC devices, which have
3821 different sizes for the MMC partitions, and you always want the
3822 environment placed at the very end of the partition, to leave the
3823 maximum possible space before it, to store other data.
3824
Stephen Warreneedcacd2013-06-11 15:14:00 -06003825 These two values are in units of bytes, but must be aligned to an
3826 MMC sector boundary.
3827
3828 - CONFIG_ENV_OFFSET_REDUND (optional):
3829
3830 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
3831 hold a redundant copy of the environment data. This provides a
3832 valid backup copy in case the other copy is corrupted, e.g. due
3833 to a power failure during a "saveenv" operation.
3834
Stephen Warren24dc2032013-06-11 15:14:02 -06003835 This value may also be positive or negative; this is handled in the
3836 same way as CONFIG_ENV_OFFSET.
3837
Stephen Warreneedcacd2013-06-11 15:14:00 -06003838 This value is also in units of bytes, but must also be aligned to
3839 an MMC sector boundary.
3840
3841 - CONFIG_ENV_SIZE_REDUND (optional):
3842
3843 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
3844 set. If this value is set, it must be set to the same value as
3845 CONFIG_ENV_SIZE.
3846
Bruce Adleredecc942007-11-02 13:15:42 -07003847Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00003848has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denk76af2782010-07-24 21:55:43 +02003849created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00003850until then to read environment variables.
3851
wdenk8dba0502003-03-31 16:34:49 +00003852The environment is protected by a CRC32 checksum. Before the monitor
3853is relocated into RAM, as a result of a bad CRC you will be working
3854with the compiled-in default environment - *silently*!!! [This is
3855necessary, because the first environment variable we need is the
3856"baudrate" setting for the console - if we have a bad CRC, we don't
3857have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00003858
3859Note: once the monitor has been relocated, then it will complain if
3860the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00003861use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00003862
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003863- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk9c53f402003-10-15 23:53:47 +00003864 Echo the inverted Ethernet link state to the fault LED.
wdenk49c3f672003-10-08 22:33:00 +00003865
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003866 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenk49c3f672003-10-08 22:33:00 +00003867 also needs to be defined.
3868
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003869- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00003870 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00003871
Ron Madriddfa028a2009-02-18 14:30:44 -08003872- CONFIG_NS16550_MIN_FUNCTIONS:
3873 Define this if you desire to only have use of the NS16550_init
3874 and NS16550_putc functions for the serial driver located at
3875 drivers/serial/ns16550.c. This option is useful for saving
3876 space for already greatly restricted images, including but not
3877 limited to NAND_SPL configurations.
3878
Simon Glass28a9e332012-11-30 13:01:18 +00003879- CONFIG_DISPLAY_BOARDINFO
3880 Display information about the board that U-Boot is running on
3881 when U-Boot starts up. The board function checkboard() is called
3882 to do this.
3883
Simon Glasse8822012012-11-30 13:01:19 +00003884- CONFIG_DISPLAY_BOARDINFO_LATE
3885 Similar to the previous option, but display this information
3886 later, once stdio is running and output goes to the LCD, if
3887 present.
3888
Sascha Silbe4b9c17c2013-08-11 16:40:43 +02003889- CONFIG_BOARD_SIZE_LIMIT:
3890 Maximum size of the U-Boot image. When defined, the
3891 build system checks that the actual size does not
3892 exceed it.
3893
wdenkc6097192002-11-03 00:24:07 +00003894Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00003895---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003896
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003897- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003898 Cache Line Size of the CPU.
3899
Timur Tabid8f341c2011-08-04 18:03:41 -05003900- CONFIG_SYS_CCSRBAR_DEFAULT:
3901 Default (power-on reset) physical address of CCSR on Freescale
3902 PowerPC SOCs.
3903
3904- CONFIG_SYS_CCSRBAR:
3905 Virtual address of CCSR. On a 32-bit build, this is typically
3906 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3907
Timur Tabid8f341c2011-08-04 18:03:41 -05003908- CONFIG_SYS_CCSRBAR_PHYS:
3909 Physical address of CCSR. CCSR can be relocated to a new
3910 physical address, if desired. In this case, this macro should
Wolfgang Denk092ae952011-10-26 10:21:21 +00003911 be set to that address. Otherwise, it should be set to the
Timur Tabid8f341c2011-08-04 18:03:41 -05003912 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
3913 is typically relocated on 36-bit builds. It is recommended
3914 that this macro be defined via the _HIGH and _LOW macros:
3915
3916 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3917 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3918
3919- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003920 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
3921 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabid8f341c2011-08-04 18:03:41 -05003922 used in assembly code, so it must not contain typecasts or
3923 integer size suffixes (e.g. "ULL").
3924
3925- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3926 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
3927 used in assembly code, so it must not contain typecasts or
3928 integer size suffixes (e.g. "ULL").
3929
3930- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3931 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3932 forced to a value that ensures that CCSR is not relocated.
3933
wdenk1272e232002-11-10 22:06:23 +00003934- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003935 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk1272e232002-11-10 22:06:23 +00003936
3937 the default drive number (default value 0)
3938
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003939 CONFIG_SYS_ISA_IO_STRIDE
wdenk1272e232002-11-10 22:06:23 +00003940
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003941 defines the spacing between FDC chipset registers
wdenk1272e232002-11-10 22:06:23 +00003942 (default value 1)
3943
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003944 CONFIG_SYS_ISA_IO_OFFSET
wdenk1272e232002-11-10 22:06:23 +00003945
wdenk4a5c8a72003-03-06 00:02:04 +00003946 defines the offset of register from address. It
3947 depends on which part of the data bus is connected to
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003948 the FDC chipset. (default value 0)
wdenk1272e232002-11-10 22:06:23 +00003949
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003950 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
3951 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk4a5c8a72003-03-06 00:02:04 +00003952 default value.
wdenk1272e232002-11-10 22:06:23 +00003953
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003954 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk4a5c8a72003-03-06 00:02:04 +00003955 fdc_hw_init() is called at the beginning of the FDC
3956 setup. fdc_hw_init() must be provided by the board
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003957 source code. It is used to make hardware-dependent
wdenk4a5c8a72003-03-06 00:02:04 +00003958 initializations.
wdenk1272e232002-11-10 22:06:23 +00003959
Macpaul Lind1e49942011-04-11 20:45:32 +00003960- CONFIG_IDE_AHB:
3961 Most IDE controllers were designed to be connected with PCI
3962 interface. Only few of them were designed for AHB interface.
3963 When software is doing ATA command and data transfer to
3964 IDE devices through IDE-AHB controller, some additional
3965 registers accessing to these kind of IDE-AHB controller
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003966 is required.
Macpaul Lind1e49942011-04-11 20:45:32 +00003967
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003968- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00003969 DO NOT CHANGE unless you know exactly what you're
Heiko Schocher65d94db2017-06-07 17:33:09 +02003970 doing! (11-4) [82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00003971
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003972- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003973
wdenkeb20ad32003-09-05 23:19:14 +00003974 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00003975 initial data and stack; please note that this must be
3976 writable memory that is working WITHOUT special
3977 initialization, i. e. you CANNOT use normal RAM which
3978 will become available only after programming the
3979 memory controller and running certain initialization
3980 sequences.
3981
3982 U-Boot uses the following memory types:
wdenkc6097192002-11-03 00:24:07 +00003983 - PPC4xx: data cache
3984
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003985- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003986
3987 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003988 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
3989 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00003990 data is located at the end of the available space
Wolfgang Denk1c2e98e2010-10-26 13:32:32 +02003991 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Simon Glass9a6ac8b2016-10-02 18:01:06 -06003992 GENERATED_GBL_DATA_SIZE), and the initial stack is just
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003993 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
3994 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00003995
3996 Note:
3997 On the MPC824X (or other systems that use the data
3998 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003999 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00004000 point to an otherwise UNUSED address space between
4001 the top of RAM and the start of the PCI space.
4002
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004003- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00004004
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004005- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00004006
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004007- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00004008
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004009- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00004010
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004011- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00004012
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004013- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00004014
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004015- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00004016 SDRAM timing
4017
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004018- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00004019 periodic timer for refresh
4020
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004021- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00004022
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004023- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4024 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4025 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4026 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004027 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4028
4029- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004030 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4031 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004032 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4033
Dirk Eibach378d1ca2009-02-09 08:18:34 +01004034- CONFIG_PCI_DISABLE_PCIE:
4035 Disable PCI-Express on systems where it is supported but not
4036 required.
4037
Andrew Sharp61d47ca2012-08-29 14:16:32 +00004038- CONFIG_PCI_ENUM_ONLY
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004039 Only scan through and get the devices on the buses.
Andrew Sharp61d47ca2012-08-29 14:16:32 +00004040 Don't do any setup work, presumably because someone or
4041 something has already done it, and we don't need to do it
4042 a second time. Useful for platforms that are pre-booted
4043 by coreboot or similar.
4044
Gabor Juhosb4458732013-05-30 07:06:12 +00004045- CONFIG_PCI_INDIRECT_BRIDGE:
4046 Enable support for indirect PCI bridges.
4047
Kumar Gala8975d7a2010-12-30 12:09:53 -06004048- CONFIG_SYS_SRIO:
4049 Chip has SRIO or not
4050
4051- CONFIG_SRIO1:
4052 Board has SRIO 1 port available
4053
4054- CONFIG_SRIO2:
4055 Board has SRIO 2 port available
4056
Liu Gang27afb9c2013-05-07 16:30:46 +08004057- CONFIG_SRIO_PCIE_BOOT_MASTER
4058 Board can support master function for Boot from SRIO and PCIE
4059
Kumar Gala8975d7a2010-12-30 12:09:53 -06004060- CONFIG_SYS_SRIOn_MEM_VIRT:
4061 Virtual Address of SRIO port 'n' memory region
4062
4063- CONFIG_SYS_SRIOn_MEM_PHYS:
4064 Physical Address of SRIO port 'n' memory region
4065
4066- CONFIG_SYS_SRIOn_MEM_SIZE:
4067 Size of SRIO port 'n' memory region
4068
Fabio Estevamf17e8782013-04-11 09:35:34 +00004069- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4070 Defined to tell the NAND controller that the NAND chip is using
4071 a 16 bit bus.
4072 Not all NAND drivers use this symbol.
Fabio Estevam417052b2013-04-11 09:35:35 +00004073 Example of drivers that use it:
Fabio Estevamf17e8782013-04-11 09:35:34 +00004074 - drivers/mtd/nand/ndfc.c
Fabio Estevam417052b2013-04-11 09:35:35 +00004075 - drivers/mtd/nand/mxc_nand.c
Alex Watermancd6aae32011-05-19 15:08:36 -04004076
4077- CONFIG_SYS_NDFC_EBC0_CFG
4078 Sets the EBC0_CFG register for the NDFC. If not defined
4079 a default value will be used.
4080
Ben Warren45657152006-09-07 16:50:54 -04004081- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004082 Get DDR timing information from an I2C EEPROM. Common
4083 with pluggable memory modules such as SODIMMs
4084
Ben Warren45657152006-09-07 16:50:54 -04004085 SPD_EEPROM_ADDRESS
4086 I2C address of the SPD EEPROM
4087
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004088- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004089 If SPD EEPROM is on an I2C bus other than the first
4090 one, specify here. Note that the value must resolve
4091 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04004092
York Sune73cc042011-06-07 09:42:16 +08004093- CONFIG_SYS_DDR_RAW_TIMING
4094 Get DDR timing information from other than SPD. Common with
4095 soldered DDR chips onboard without SPD. DDR raw timing
4096 parameters are extracted from datasheet and hard-coded into
4097 header files or board specific files.
4098
York Sunbd495cf2011-09-16 13:21:35 -07004099- CONFIG_FSL_DDR_INTERACTIVE
4100 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4101
York Sun8ced0502015-01-06 13:18:55 -08004102- CONFIG_FSL_DDR_SYNC_REFRESH
4103 Enable sync of refresh for multiple controllers.
4104
York Sunb6a35f82015-03-19 09:30:28 -07004105- CONFIG_FSL_DDR_BIST
4106 Enable built-in memory test for Freescale DDR controllers.
4107
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004108- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004109 Only for 83xx systems. If specified, then DDR should
4110 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06004111
wdenk6203e402004-04-18 10:13:26 +00004112- CONFIG_RMII
4113 Enable RMII mode for all FECs.
4114 Note that this is a global option, we can't
4115 have one FEC in standard MII mode and another in RMII mode.
4116
wdenk20c98a62004-04-23 20:32:05 +00004117- CONFIG_CRC32_VERIFY
4118 Add a verify option to the crc32 command.
4119 The syntax is:
4120
4121 => crc32 -v <address> <count> <crc32>
4122
4123 Where address/count indicate a memory area
4124 and crc32 is the correct crc32 which the
4125 area should have.
4126
wdenk64519362004-07-11 17:40:54 +00004127- CONFIG_LOOPW
4128 Add the "loopw" memory command. This only takes effect if
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004129 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk64519362004-07-11 17:40:54 +00004130
stroesecc3af832004-12-16 18:46:55 +00004131- CONFIG_MX_CYCLIC
4132 Add the "mdc" and "mwc" memory commands. These are cyclic
4133 "md/mw" commands.
4134 Examples:
4135
wdenk07d7e6b2004-12-16 21:44:03 +00004136 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00004137 This command will print 4 bytes (10,11,12,13) each 500 ms.
4138
wdenk07d7e6b2004-12-16 21:44:03 +00004139 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00004140 This command will write 12345678 to address 100 all 10 ms.
4141
wdenk07d7e6b2004-12-16 21:44:03 +00004142 This only takes effect if the memory commands are activated
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004143 globally (CONFIG_CMD_MEM).
stroesecc3af832004-12-16 18:46:55 +00004144
wdenk3d3d99f2005-04-04 12:44:11 +00004145- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004146 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk302141d2010-11-27 23:30:56 +01004147 low level initializations (like setting up the memory
4148 controller) are omitted and/or U-Boot does not
4149 relocate itself into RAM.
wdenk3d3d99f2005-04-04 12:44:11 +00004150
Wolfgang Denk302141d2010-11-27 23:30:56 +01004151 Normally this variable MUST NOT be defined. The only
4152 exception is when U-Boot is loaded (to RAM) by some
4153 other boot loader or by a debugger which performs
4154 these initializations itself.
wdenk3d3d99f2005-04-04 12:44:11 +00004155
Simon Glass90844072016-05-05 07:28:06 -06004156- CONFIG_SKIP_LOWLEVEL_INIT_ONLY
4157 [ARM926EJ-S only] This allows just the call to lowlevel_init()
yeongjun Kim7a203682016-07-20 22:56:12 +09004158 to be skipped. The normal CP15 init (such as enabling the
Simon Glass90844072016-05-05 07:28:06 -06004159 instruction cache) is still performed.
4160
Aneesh V552a3192011-07-13 05:11:07 +00004161- CONFIG_SPL_BUILD
Magnus Lilja1ec96d82009-06-13 20:50:00 +02004162 Modifies the behaviour of start.S when compiling a loader
4163 that is executed before the actual U-Boot. E.g. when
4164 compiling a NAND SPL.
wdenk336b2bc2005-04-02 23:52:25 +00004165
Ying Zhang2d2e3b62013-08-16 15:16:15 +08004166- CONFIG_TPL_BUILD
4167 Modifies the behaviour of start.S when compiling a loader
4168 that is executed after the SPL and before the actual U-Boot.
4169 It is loaded by the SPL.
4170
Ying Zhang0d4f5442013-05-20 14:07:23 +08004171- CONFIG_SYS_MPC85XX_NO_RESETVEC
4172 Only for 85xx systems. If this variable is specified, the section
4173 .resetvec is not kept and the section .bootpg is placed in the
4174 previous 4k of the .text section.
4175
Simon Glass17dabf02013-02-24 17:33:14 +00004176- CONFIG_ARCH_MAP_SYSMEM
4177 Generally U-Boot (and in particular the md command) uses
4178 effective address. It is therefore not necessary to regard
4179 U-Boot address as virtual addresses that need to be translated
4180 to physical addresses. However, sandbox requires this, since
4181 it maintains its own little RAM buffer which contains all
4182 addressable memory. This option causes some memory accesses
4183 to be mapped through map_sysmem() / unmap_sysmem().
4184
Simon Glassbfb59802013-02-14 04:18:54 +00004185- CONFIG_X86_RESET_VECTOR
4186 If defined, the x86 reset vector code is included. This is not
4187 needed when U-Boot is running from Coreboot.
Gabe Black14f82462012-11-27 21:08:06 +00004188
Heiko Schocher2233e462013-11-04 14:05:00 +01004189- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
4190 Enables the RTC32K OSC on AM33xx based plattforms
4191
Karicheri, Muralidharanc1dc61b2014-04-04 13:16:50 -04004192- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
4193 Option to disable subpage write in NAND driver
4194 driver that uses this:
4195 drivers/mtd/nand/davinci_nand.c
4196
Timur Tabi275f4bb2011-11-22 09:21:25 -06004197Freescale QE/FMAN Firmware Support:
4198-----------------------------------
4199
4200The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4201loading of "firmware", which is encoded in the QE firmware binary format.
4202This firmware often needs to be loaded during U-Boot booting, so macros
4203are used to identify the storage device (NOR flash, SPI, etc) and the address
4204within that device.
4205
Zhao Qiang83a90842014-03-21 16:21:44 +08004206- CONFIG_SYS_FMAN_FW_ADDR
4207 The address in the storage device where the FMAN microcode is located. The
4208 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4209 is also specified.
4210
4211- CONFIG_SYS_QE_FW_ADDR
4212 The address in the storage device where the QE microcode is located. The
Timur Tabi275f4bb2011-11-22 09:21:25 -06004213 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4214 is also specified.
4215
4216- CONFIG_SYS_QE_FMAN_FW_LENGTH
4217 The maximum possible size of the firmware. The firmware binary format
4218 has a field that specifies the actual size of the firmware, but it
4219 might not be possible to read any part of the firmware unless some
4220 local storage is allocated to hold the entire firmware first.
4221
4222- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4223 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4224 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
4225 virtual address in NOR flash.
4226
4227- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4228 Specifies that QE/FMAN firmware is located in NAND flash.
4229 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4230
4231- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4232 Specifies that QE/FMAN firmware is located on the primary SD/MMC
4233 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4234
Liu Gang1e084582012-03-08 00:33:18 +00004235- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4236 Specifies that QE/FMAN firmware is located in the remote (master)
4237 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gang357bf5a2012-08-09 05:10:01 +00004238 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4239 window->master inbound window->master LAW->the ucode address in
4240 master's memory space.
Timur Tabi275f4bb2011-11-22 09:21:25 -06004241
J. German Rivera8ff14b72014-06-23 15:15:55 -07004242Freescale Layerscape Management Complex Firmware Support:
4243---------------------------------------------------------
4244The Freescale Layerscape Management Complex (MC) supports the loading of
4245"firmware".
4246This firmware often needs to be loaded during U-Boot booting, so macros
4247are used to identify the storage device (NOR flash, SPI, etc) and the address
4248within that device.
4249
4250- CONFIG_FSL_MC_ENET
4251 Enable the MC driver for Layerscape SoCs.
4252
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05304253Freescale Layerscape Debug Server Support:
4254-------------------------------------------
4255The Freescale Layerscape Debug Server Support supports the loading of
4256"Debug Server firmware" and triggering SP boot-rom.
4257This firmware often needs to be loaded during U-Boot booting.
4258
York Sun928b6812015-12-07 11:08:58 -08004259- CONFIG_SYS_MC_RSV_MEM_ALIGN
4260 Define alignment of reserved memory MC requires
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05304261
Paul Kocialkowski7b917022015-07-26 18:48:15 +02004262Reproducible builds
4263-------------------
4264
4265In order to achieve reproducible builds, timestamps used in the U-Boot build
4266process have to be set to a fixed value.
4267
4268This is done using the SOURCE_DATE_EPOCH environment variable.
4269SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
4270option for U-Boot or an environment variable in U-Boot.
4271
4272SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
4273
wdenkc6097192002-11-03 00:24:07 +00004274Building the Software:
4275======================
4276
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004277Building U-Boot has been tested in several native build environments
4278and in many different cross environments. Of course we cannot support
4279all possibly existing versions of cross development tools in all
4280(potentially obsolete) versions. In case of tool chain problems we
4281recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4282which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004283
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004284If you are not using a native environment, it is assumed that you
4285have GNU cross compiling tools available in your path. In this case,
4286you must set the environment variable CROSS_COMPILE in your shell.
4287Note that no changes to the Makefile or any other source files are
4288necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00004289
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004290 $ CROSS_COMPILE=ppc_4xx-
4291 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00004292
Peter Tyserb06976d2009-03-13 18:54:51 -05004293Note: If you wish to generate Windows versions of the utilities in
4294 the tools directory you can use the MinGW toolchain
4295 (http://www.mingw.org). Set your HOST tools to the MinGW
4296 toolchain and execute 'make tools'. For example:
4297
4298 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
4299
4300 Binaries such as tools/mkimage.exe will be created which can
4301 be executed on computers running Windows.
4302
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004303U-Boot is intended to be simple to build. After installing the
4304sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00004305is done by typing:
4306
Holger Freyther7ba4e572014-08-04 09:26:05 +02004307 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00004308
Holger Freyther7ba4e572014-08-04 09:26:05 +02004309where "NAME_defconfig" is the name of one of the existing configu-
Michael Jones5a7fb6f2012-03-15 22:48:10 +00004310rations; see boards.cfg for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00004311
wdenk6c59edc2004-05-03 20:45:30 +00004312Note: for some board special configuration names may exist; check if
4313 additional information is available from the board vendor; for
4314 instance, the TQM823L systems are available without (standard)
4315 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004316 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00004317
Holger Freyther7ba4e572014-08-04 09:26:05 +02004318 make TQM823L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00004319 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00004320
Holger Freyther7ba4e572014-08-04 09:26:05 +02004321 make TQM823L_LCD_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00004322 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00004323
wdenk6c59edc2004-05-03 20:45:30 +00004324 etc.
wdenkc6097192002-11-03 00:24:07 +00004325
wdenkc6097192002-11-03 00:24:07 +00004326
wdenk6c59edc2004-05-03 20:45:30 +00004327Finally, type "make all", and you should get some working U-Boot
4328images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00004329
wdenk6c59edc2004-05-03 20:45:30 +00004330- "u-boot.bin" is a raw binary image
4331- "u-boot" is an image in ELF binary format
4332- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00004333
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004334By default the build is performed locally and the objects are saved
4335in the source directory. One of the two methods can be used to change
4336this behavior and build U-Boot to some external directory:
4337
43381. Add O= to the make command line invocations:
4339
4340 make O=/tmp/build distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02004341 make O=/tmp/build NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004342 make O=/tmp/build all
4343
Timo Ketolac8c67602014-11-06 14:39:05 +020043442. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004345
Timo Ketolac8c67602014-11-06 14:39:05 +02004346 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004347 make distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02004348 make NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004349 make all
4350
Timo Ketolac8c67602014-11-06 14:39:05 +02004351Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004352variable.
4353
wdenkc6097192002-11-03 00:24:07 +00004354
wdenk6c59edc2004-05-03 20:45:30 +00004355Please be aware that the Makefiles assume you are using GNU make, so
4356for instance on NetBSD you might need to use "gmake" instead of
4357native "make".
wdenkc6097192002-11-03 00:24:07 +00004358
wdenkc6097192002-11-03 00:24:07 +00004359
wdenk6c59edc2004-05-03 20:45:30 +00004360If the system board that you have is not listed, then you will need
4361to port U-Boot to your hardware platform. To do this, follow these
4362steps:
wdenkc6097192002-11-03 00:24:07 +00004363
Phil Sutterc77b4882015-12-25 14:41:18 +010043641. Create a new directory to hold your board specific code. Add any
wdenk6c59edc2004-05-03 20:45:30 +00004365 files you need. In your board directory, you will need at least
Phil Sutterc77b4882015-12-25 14:41:18 +01004366 the "Makefile" and a "<board>.c".
43672. Create a new configuration file "include/configs/<board>.h" for
4368 your board.
wdenk6c59edc2004-05-03 20:45:30 +000043693. If you're porting U-Boot to a new CPU, then also create a new
4370 directory to hold your CPU specific code. Add any files you need.
Holger Freyther7ba4e572014-08-04 09:26:05 +020043714. Run "make <board>_defconfig" with your new name.
wdenk6c59edc2004-05-03 20:45:30 +000043725. Type "make", and you should get a working "u-boot.srec" file
4373 to be installed on your target system.
43746. Debug and solve any problems that might arise.
4375 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00004376
wdenkc6097192002-11-03 00:24:07 +00004377
wdenk6c59edc2004-05-03 20:45:30 +00004378Testing of U-Boot Modifications, Ports to New Hardware, etc.:
4379==============================================================
wdenkc6097192002-11-03 00:24:07 +00004380
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004381If you have modified U-Boot sources (for instance added a new board
4382or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00004383provide feedback to the other developers. The feedback normally takes
4384the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004385official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00004386
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004387But before you submit such a patch, please verify that your modifi-
4388cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00004389the supported boards compile WITHOUT ANY compiler warnings. To do so,
Simon Glassdc27def2016-07-27 20:33:08 -06004390just run the buildman script (tools/buildman/buildman), which will
4391configure and build U-Boot for ALL supported system. Be warned, this
4392will take a while. Please see the buildman README, or run 'buildman -H'
4393for documentation.
wdenkc6097192002-11-03 00:24:07 +00004394
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004395
wdenk6c59edc2004-05-03 20:45:30 +00004396See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00004397
wdenkc6097192002-11-03 00:24:07 +00004398
wdenk6c59edc2004-05-03 20:45:30 +00004399Monitor Commands - Overview:
4400============================
wdenkc6097192002-11-03 00:24:07 +00004401
wdenk6c59edc2004-05-03 20:45:30 +00004402go - start application at address 'addr'
4403run - run commands in an environment variable
4404bootm - boot application image from memory
4405bootp - boot image via network using BootP/TFTP protocol
Marek Vasutcf41a9b2012-03-14 21:52:45 +00004406bootz - boot zImage from memory
wdenk6c59edc2004-05-03 20:45:30 +00004407tftpboot- boot image via network using TFTP protocol
4408 and env variables "ipaddr" and "serverip"
4409 (and eventually "gatewayip")
Simon Glass6a398d22011-10-24 18:00:07 +00004410tftpput - upload a file via network using TFTP protocol
wdenk6c59edc2004-05-03 20:45:30 +00004411rarpboot- boot image via network using RARP/TFTP protocol
4412diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
4413loads - load S-Record file over serial line
4414loadb - load binary file over serial line (kermit mode)
4415md - memory display
4416mm - memory modify (auto-incrementing)
4417nm - memory modify (constant address)
4418mw - memory write (fill)
4419cp - memory copy
4420cmp - memory compare
4421crc32 - checksum calculation
Peter Tyser469cde42009-04-18 22:34:03 -05004422i2c - I2C sub-system
wdenk6c59edc2004-05-03 20:45:30 +00004423sspi - SPI utility commands
4424base - print or set address offset
4425printenv- print environment variables
4426setenv - set environment variables
4427saveenv - save environment variables to persistent storage
4428protect - enable or disable FLASH write protection
4429erase - erase FLASH memory
4430flinfo - print FLASH memory information
Karl O. Pinc4baf03d2012-08-03 05:57:21 +00004431nand - NAND memory operations (see doc/README.nand)
wdenk6c59edc2004-05-03 20:45:30 +00004432bdinfo - print Board Info structure
4433iminfo - print header information for application image
4434coninfo - print console devices and informations
4435ide - IDE sub-system
4436loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00004437loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00004438mtest - simple RAM test
4439icache - enable or disable instruction cache
4440dcache - enable or disable data cache
4441reset - Perform RESET of the CPU
4442echo - echo args to console
4443version - print monitor version
4444help - print online help
4445? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00004446
wdenkc6097192002-11-03 00:24:07 +00004447
wdenk6c59edc2004-05-03 20:45:30 +00004448Monitor Commands - Detailed Description:
4449========================================
wdenkc6097192002-11-03 00:24:07 +00004450
wdenk6c59edc2004-05-03 20:45:30 +00004451TODO.
wdenkc6097192002-11-03 00:24:07 +00004452
wdenk6c59edc2004-05-03 20:45:30 +00004453For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00004454
4455
wdenk6c59edc2004-05-03 20:45:30 +00004456Environment Variables:
4457======================
wdenkc6097192002-11-03 00:24:07 +00004458
wdenk6c59edc2004-05-03 20:45:30 +00004459U-Boot supports user configuration using Environment Variables which
4460can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00004461
wdenk6c59edc2004-05-03 20:45:30 +00004462Environment Variables are set using "setenv", printed using
4463"printenv", and saved to Flash using "saveenv". Using "setenv"
4464without a value can be used to delete a variable from the
4465environment. As long as you don't save the environment you are
4466working with an in-memory copy. In case the Flash area containing the
4467environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00004468
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004469Some configuration options can be set using Environment Variables.
4470
4471List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00004472
wdenk6c59edc2004-05-03 20:45:30 +00004473 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00004474
wdenk6c59edc2004-05-03 20:45:30 +00004475 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00004476
wdenk6c59edc2004-05-03 20:45:30 +00004477 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00004478
wdenk6c59edc2004-05-03 20:45:30 +00004479 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00004480
wdenk6c59edc2004-05-03 20:45:30 +00004481 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00004482
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004483 bootm_low - Memory range available for image processing in the bootm
4484 command can be restricted. This variable is given as
4485 a hexadecimal number and defines lowest address allowed
4486 for use by the bootm command. See also "bootm_size"
4487 environment variable. Address defined by "bootm_low" is
4488 also the base of the initial memory mapping for the Linux
Grant Likely26396382011-03-28 09:58:43 +00004489 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4490 bootm_mapsize.
4491
Wolfgang Denk092ae952011-10-26 10:21:21 +00004492 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likely26396382011-03-28 09:58:43 +00004493 This variable is given as a hexadecimal number and it
4494 defines the size of the memory region starting at base
4495 address bootm_low that is accessible by the Linux kernel
4496 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
4497 as the default value if it is defined, and bootm_size is
4498 used otherwise.
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004499
4500 bootm_size - Memory range available for image processing in the bootm
4501 command can be restricted. This variable is given as
4502 a hexadecimal number and defines the size of the region
4503 allowed for use by the bootm command. See also "bootm_low"
4504 environment variable.
4505
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02004506 updatefile - Location of the software update file on a TFTP server, used
4507 by the automatic software update feature. Please refer to
4508 documentation in doc/README.update for more details.
4509
wdenk6c59edc2004-05-03 20:45:30 +00004510 autoload - if set to "no" (any string beginning with 'n'),
4511 "bootp" will just load perform a lookup of the
4512 configuration from the BOOTP server, but not try to
4513 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00004514
wdenk6c59edc2004-05-03 20:45:30 +00004515 autostart - if set to "yes", an image loaded using the "bootp",
4516 "rarpboot", "tftpboot" or "diskboot" commands will
4517 be automatically started (by internally calling
4518 "bootm")
wdenkc6097192002-11-03 00:24:07 +00004519
wdenk6c59edc2004-05-03 20:45:30 +00004520 If set to "no", a standalone image passed to the
4521 "bootm" command will be copied to the load address
4522 (and eventually uncompressed), but NOT be started.
4523 This can be used to load and uncompress arbitrary
4524 data.
wdenkc6097192002-11-03 00:24:07 +00004525
David A. Longd558a4e2011-07-09 16:40:19 -04004526 fdt_high - if set this restricts the maximum address that the
4527 flattened device tree will be copied into upon boot.
Shawn Guo0ca9e982012-01-09 21:54:08 +00004528 For example, if you have a system with 1 GB memory
4529 at physical address 0x10000000, while Linux kernel
4530 only recognizes the first 704 MB as low memory, you
4531 may need to set fdt_high as 0x3C000000 to have the
4532 device tree blob be copied to the maximum address
4533 of the 704 MB low memory, so that Linux kernel can
4534 access it during the boot procedure.
4535
David A. Longd558a4e2011-07-09 16:40:19 -04004536 If this is set to the special value 0xFFFFFFFF then
4537 the fdt will not be copied at all on boot. For this
4538 to work it must reside in writable memory, have
4539 sufficient padding on the end of it for u-boot to
4540 add the information it needs into it, and the memory
4541 must be accessible by the kernel.
4542
Simon Glassdc6fa642011-10-24 19:15:34 +00004543 fdtcontroladdr- if set this is the address of the control flattened
4544 device tree used by U-Boot when CONFIG_OF_CONTROL is
4545 defined.
4546
wdenk0e2bd9c2004-06-06 21:51:03 +00004547 i2cfast - (PPC405GP|PPC405EP only)
4548 if set to 'y' configures Linux I2C driver for fast
4549 mode (400kHZ). This environment variable is used in
4550 initialization code. So, for changes to be effective
4551 it must be saved and board must be reset.
4552
wdenk6c59edc2004-05-03 20:45:30 +00004553 initrd_high - restrict positioning of initrd images:
4554 If this variable is not set, initrd images will be
4555 copied to the highest possible address in RAM; this
4556 is usually what you want since it allows for
4557 maximum initrd size. If for some reason you want to
4558 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004559 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk6c59edc2004-05-03 20:45:30 +00004560 variable to a value of "no" or "off" or "0".
4561 Alternatively, you can set it to a maximum upper
4562 address to use (U-Boot will still check that it
4563 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00004564
wdenk6c59edc2004-05-03 20:45:30 +00004565 For instance, when you have a system with 16 MB
4566 RAM, and want to reserve 4 MB from use by Linux,
4567 you can do this by adding "mem=12M" to the value of
4568 the "bootargs" variable. However, now you must make
4569 sure that the initrd image is placed in the first
4570 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00004571
wdenk6c59edc2004-05-03 20:45:30 +00004572 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00004573
wdenk6c59edc2004-05-03 20:45:30 +00004574 If you set initrd_high to 0xFFFFFFFF, this is an
4575 indication to U-Boot that all addresses are legal
4576 for the Linux kernel, including addresses in flash
4577 memory. In this case U-Boot will NOT COPY the
4578 ramdisk at all. This may be useful to reduce the
4579 boot time on your system, but requires that this
4580 feature is supported by your Linux kernel.
wdenk3f9ab982003-04-12 23:38:12 +00004581
wdenk6c59edc2004-05-03 20:45:30 +00004582 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00004583
wdenk6c59edc2004-05-03 20:45:30 +00004584 loadaddr - Default load address for commands like "bootp",
4585 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00004586
wdenk6c59edc2004-05-03 20:45:30 +00004587 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00004588
wdenk6c59edc2004-05-03 20:45:30 +00004589 serverip - TFTP server IP address; needed for tftpboot command
wdenk6f770ed2003-05-23 23:18:21 +00004590
wdenk6c59edc2004-05-03 20:45:30 +00004591 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00004592
wdenk6c59edc2004-05-03 20:45:30 +00004593 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00004594
wdenk6c59edc2004-05-03 20:45:30 +00004595 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00004596
Mike Frysingera23230c2011-10-02 10:01:27 +00004597 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00004598
Mike Frysingera23230c2011-10-02 10:01:27 +00004599 ethact - controls which interface is currently active.
4600 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00004601
Heiko Schocherc5e84052010-07-20 17:45:02 +02004602 => setenv ethact FEC
4603 => ping 192.168.0.1 # traffic sent on FEC
4604 => setenv ethact SCC
4605 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00004606
Matthias Fuchs204f0ec2008-01-17 07:45:05 +01004607 ethrotate - When set to "no" U-Boot does not go through all
4608 available network interfaces.
4609 It just stays at the currently selected interface.
4610
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004611 netretry - When set to "no" each network operation will
wdenk6c59edc2004-05-03 20:45:30 +00004612 either succeed or fail without retrying.
4613 When set to "once" the network operation will
4614 fail when all the available network interfaces
4615 are tried once without success.
4616 Useful on scripts which control the retry operation
4617 themselves.
wdenkc6097192002-11-03 00:24:07 +00004618
Jean-Christophe PLAGNIOL-VILLARD1948d6c2009-01-31 09:53:39 +01004619 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDd2164ef2008-01-07 08:41:34 +01004620
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004621 silent_linux - If set then Linux will be told to boot silently, by
Simon Glass5db3f932013-07-16 20:10:00 -07004622 changing the console to be empty. If "yes" it will be
4623 made silent. If "no" it will not be made silent. If
4624 unset, then it will be made silent if the U-Boot console
4625 is silent.
4626
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02004627 tftpsrcp - If this is set, the value is used for TFTP's
Wolfgang Denke3cfce52005-09-24 22:37:32 +02004628 UDP source port.
4629
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02004630 tftpdstp - If this is set, the value is used for TFTP's UDP
Wolfgang Denk227b5192005-09-24 23:25:46 +02004631 destination port instead of the Well Know Port 69.
4632
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004633 tftpblocksize - Block size to use for TFTP transfers; if not set,
4634 we use the TFTP server's default block size
4635
4636 tftptimeout - Retransmission timeout for TFTP packets (in milli-
4637 seconds, minimum value is 1000 = 1 second). Defines
4638 when a packet is considered to be lost so it has to
4639 be retransmitted. The default is 5000 = 5 seconds.
4640 Lowering this value may make downloads succeed
4641 faster in networks with high packet loss rates or
4642 with unreliable TFTP servers.
4643
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02004644 tftptimeoutcountmax - maximum count of TFTP timeouts (no
4645 unit, minimum value = 0). Defines how many timeouts
4646 can happen during a single file transfer before that
4647 transfer is aborted. The default is 10, and 0 means
4648 'no timeouts allowed'. Increasing this value may help
4649 downloads succeed with high packet loss rates, or with
4650 unreliable TFTP servers or client hardware.
4651
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004652 vlan - When set to a value < 4095 the traffic over
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004653 Ethernet is encapsulated/received over 802.1q
wdenk6c59edc2004-05-03 20:45:30 +00004654 VLAN tagged frames.
wdenk145d2c12004-04-15 21:48:45 +00004655
Alexandre Messier15971322016-02-01 17:08:57 -05004656 bootpretryperiod - Period during which BOOTP/DHCP sends retries.
4657 Unsigned value, in milliseconds. If not set, the period will
4658 be either the default (28000), or a value based on
4659 CONFIG_NET_RETRY_COUNT, if defined. This value has
4660 precedence over the valu based on CONFIG_NET_RETRY_COUNT.
4661
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004662The following image location variables contain the location of images
4663used in booting. The "Image" column gives the role of the image and is
4664not an environment variable name. The other columns are environment
4665variable names. "File Name" gives the name of the file on a TFTP
4666server, "RAM Address" gives the location in RAM the image will be
4667loaded to, and "Flash Location" gives the image's address in NOR
4668flash or offset in NAND flash.
4669
4670*Note* - these variables don't have to be defined for all boards, some
Fabio Estevambb7d4972015-04-25 18:53:10 -03004671boards currently use other variables for these purposes, and some
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004672boards use these variables for other purposes.
4673
Wolfgang Denk092ae952011-10-26 10:21:21 +00004674Image File Name RAM Address Flash Location
4675----- --------- ----------- --------------
4676u-boot u-boot u-boot_addr_r u-boot_addr
4677Linux kernel bootfile kernel_addr_r kernel_addr
4678device tree blob fdtfile fdt_addr_r fdt_addr
4679ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004680
wdenk6c59edc2004-05-03 20:45:30 +00004681The following environment variables may be used and automatically
4682updated by the network boot commands ("bootp" and "rarpboot"),
4683depending the information provided by your boot server:
wdenk145d2c12004-04-15 21:48:45 +00004684
wdenk6c59edc2004-05-03 20:45:30 +00004685 bootfile - see above
4686 dnsip - IP address of your Domain Name Server
4687 dnsip2 - IP address of your secondary Domain Name Server
4688 gatewayip - IP address of the Gateway (Router) to use
4689 hostname - Target hostname
4690 ipaddr - see above
4691 netmask - Subnet Mask
4692 rootpath - Pathname of the root filesystem on the NFS server
4693 serverip - see above
wdenk145d2c12004-04-15 21:48:45 +00004694
wdenk145d2c12004-04-15 21:48:45 +00004695
wdenk6c59edc2004-05-03 20:45:30 +00004696There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004697
wdenk6c59edc2004-05-03 20:45:30 +00004698 serial# - contains hardware identification information such
4699 as type string and/or serial number
4700 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00004701
wdenk6c59edc2004-05-03 20:45:30 +00004702These variables can be set only once (usually during manufacturing of
4703the board). U-Boot refuses to delete or overwrite these variables
4704once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00004705
4706
wdenk6c59edc2004-05-03 20:45:30 +00004707Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004708
wdenk6c59edc2004-05-03 20:45:30 +00004709 ver - Contains the U-Boot version string as printed
4710 with the "version" command. This variable is
4711 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00004712
wdenkc6097192002-11-03 00:24:07 +00004713
wdenk6c59edc2004-05-03 20:45:30 +00004714Please note that changes to some configuration parameters may take
4715only effect after the next boot (yes, that's just like Windoze :-).
stroeseb9c17c52003-04-04 15:53:41 +00004716
stroeseb9c17c52003-04-04 15:53:41 +00004717
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004718Callback functions for environment variables:
4719---------------------------------------------
4720
4721For some environment variables, the behavior of u-boot needs to change
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004722when their values are changed. This functionality allows functions to
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004723be associated with arbitrary variables. On creation, overwrite, or
4724deletion, the callback will provide the opportunity for some side
4725effect to happen or for the change to be rejected.
4726
4727The callbacks are named and associated with a function using the
4728U_BOOT_ENV_CALLBACK macro in your board or driver code.
4729
4730These callbacks are associated with variables in one of two ways. The
4731static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4732in the board configuration to a string that defines a list of
4733associations. The list must be in the following format:
4734
4735 entry = variable_name[:callback_name]
4736 list = entry[,list]
4737
4738If the callback name is not specified, then the callback is deleted.
4739Spaces are also allowed anywhere in the list.
4740
4741Callbacks can also be associated by defining the ".callbacks" variable
4742with the same list format above. Any association in ".callbacks" will
4743override any association in the static list. You can define
4744CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004745".callbacks" environment variable in the default or embedded environment.
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004746
Joe Hershberger6db9fd42015-05-20 14:27:20 -05004747If CONFIG_REGEX is defined, the variable_name above is evaluated as a
4748regular expression. This allows multiple variables to be connected to
4749the same callback without explicitly listing them all out.
4750
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004751
wdenk6c59edc2004-05-03 20:45:30 +00004752Command Line Parsing:
4753=====================
stroeseb9c17c52003-04-04 15:53:41 +00004754
wdenk6c59edc2004-05-03 20:45:30 +00004755There are two different command line parsers available with U-Boot:
4756the old "simple" one, and the much more powerful "hush" shell:
wdenkc6097192002-11-03 00:24:07 +00004757
wdenk6c59edc2004-05-03 20:45:30 +00004758Old, simple command line parser:
4759--------------------------------
wdenkc6097192002-11-03 00:24:07 +00004760
wdenk6c59edc2004-05-03 20:45:30 +00004761- supports environment variables (through setenv / saveenv commands)
4762- several commands on one line, separated by ';'
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01004763- variable substitution using "... ${name} ..." syntax
wdenk6c59edc2004-05-03 20:45:30 +00004764- special characters ('$', ';') can be escaped by prefixing with '\',
4765 for example:
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01004766 setenv bootcmd bootm \${address}
wdenk6c59edc2004-05-03 20:45:30 +00004767- You can also escape text by enclosing in single apostrophes, for example:
4768 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00004769
wdenk6c59edc2004-05-03 20:45:30 +00004770Hush shell:
4771-----------
wdenkf4688a22003-05-28 08:06:31 +00004772
wdenk6c59edc2004-05-03 20:45:30 +00004773- similar to Bourne shell, with control structures like
4774 if...then...else...fi, for...do...done; while...do...done,
4775 until...do...done, ...
4776- supports environment ("global") variables (through setenv / saveenv
4777 commands) and local shell variables (through standard shell syntax
4778 "name=value"); only environment variables can be used with "run"
4779 command
wdenkf4688a22003-05-28 08:06:31 +00004780
wdenk6c59edc2004-05-03 20:45:30 +00004781General rules:
4782--------------
wdenkf4688a22003-05-28 08:06:31 +00004783
wdenk6c59edc2004-05-03 20:45:30 +00004784(1) If a command line (or an environment variable executed by a "run"
4785 command) contains several commands separated by semicolon, and
4786 one of these commands fails, then the remaining commands will be
4787 executed anyway.
wdenkf4688a22003-05-28 08:06:31 +00004788
wdenk6c59edc2004-05-03 20:45:30 +00004789(2) If you execute several variables with one call to run (i. e.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004790 calling run with a list of variables as arguments), any failing
wdenk6c59edc2004-05-03 20:45:30 +00004791 command will cause "run" to terminate, i. e. the remaining
4792 variables are not executed.
wdenkf4688a22003-05-28 08:06:31 +00004793
wdenk6c59edc2004-05-03 20:45:30 +00004794Note for Redundant Ethernet Interfaces:
4795=======================================
wdenkf4688a22003-05-28 08:06:31 +00004796
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004797Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00004798such configurations and is capable of automatic selection of a
4799"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00004800
wdenk6c59edc2004-05-03 20:45:30 +00004801Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
4802MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4803"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00004804
wdenk6c59edc2004-05-03 20:45:30 +00004805If the network interface stores some valid MAC address (for instance
4806in SROM), this is used as default address if there is NO correspon-
4807ding setting in the environment; if the corresponding environment
4808variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00004809
wdenk6c59edc2004-05-03 20:45:30 +00004810o If the SROM has a valid MAC address, and there is no address in the
4811 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00004812
wdenk6c59edc2004-05-03 20:45:30 +00004813o If there is no valid address in the SROM, and a definition in the
4814 environment exists, then the value from the environment variable is
4815 used.
wdenkc6097192002-11-03 00:24:07 +00004816
wdenk6c59edc2004-05-03 20:45:30 +00004817o If both the SROM and the environment contain a MAC address, and
4818 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00004819
wdenk6c59edc2004-05-03 20:45:30 +00004820o If both the SROM and the environment contain a MAC address, and the
4821 addresses differ, the value from the environment is used and a
4822 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00004823
wdenk6c59edc2004-05-03 20:45:30 +00004824o If neither SROM nor the environment contain a MAC address, an error
Joe Hershberger2dc2b5d2015-05-04 14:55:13 -05004825 is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
4826 a random, locally-assigned MAC is used.
wdenkc6097192002-11-03 00:24:07 +00004827
Ben Warren6db991a2010-04-26 11:11:46 -07004828If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denk092ae952011-10-26 10:21:21 +00004829will be programmed into hardware as part of the initialization process. This
Ben Warren6db991a2010-04-26 11:11:46 -07004830may be skipped by setting the appropriate 'ethmacskip' environment variable.
4831The naming convention is as follows:
4832"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00004833
wdenk6c59edc2004-05-03 20:45:30 +00004834Image Formats:
4835==============
wdenkc6097192002-11-03 00:24:07 +00004836
Marian Balakowicz18710b82008-03-12 12:13:13 +01004837U-Boot is capable of booting (and performing other auxiliary operations on)
4838images in two formats:
4839
4840New uImage format (FIT)
4841-----------------------
4842
4843Flexible and powerful format based on Flattened Image Tree -- FIT (similar
4844to Flattened Device Tree). It allows the use of images with multiple
4845components (several kernels, ramdisks, etc.), with contents protected by
4846SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
4847
4848
4849Old uImage format
4850-----------------
4851
4852Old image format is based on binary files which can be basically anything,
4853preceded by a special header; see the definitions in include/image.h for
4854details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00004855
wdenk6c59edc2004-05-03 20:45:30 +00004856* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4857 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05004858 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4859 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4860 INTEGRITY).
Wolfgang Denk83c15852006-10-24 14:21:16 +02004861* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004862 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
4863 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00004864* Compression Type (uncompressed, gzip, bzip2)
4865* Load Address
4866* Entry Point
4867* Image Name
4868* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00004869
wdenk6c59edc2004-05-03 20:45:30 +00004870The header is marked by a special Magic Number, and both the header
4871and the data portions of the image are secured against corruption by
4872CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00004873
wdenkc6097192002-11-03 00:24:07 +00004874
wdenk6c59edc2004-05-03 20:45:30 +00004875Linux Support:
4876==============
wdenkc6097192002-11-03 00:24:07 +00004877
wdenk6c59edc2004-05-03 20:45:30 +00004878Although U-Boot should support any OS or standalone application
4879easily, the main focus has always been on Linux during the design of
4880U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004881
wdenk6c59edc2004-05-03 20:45:30 +00004882U-Boot includes many features that so far have been part of some
4883special "boot loader" code within the Linux kernel. Also, any
4884"initrd" images to be used are no longer part of one big Linux image;
4885instead, kernel and "initrd" are separate images. This implementation
4886serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00004887
wdenk6c59edc2004-05-03 20:45:30 +00004888- the same features can be used for other OS or standalone
4889 applications (for instance: using compressed images to reduce the
4890 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00004891
wdenk6c59edc2004-05-03 20:45:30 +00004892- it becomes much easier to port new Linux kernel versions because
4893 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00004894
wdenk6c59edc2004-05-03 20:45:30 +00004895- the same Linux kernel image can now be used with different "initrd"
4896 images; of course this also means that different kernel images can
4897 be run with the same "initrd". This makes testing easier (you don't
4898 have to build a new "zImage.initrd" Linux image when you just
4899 change a file in your "initrd"). Also, a field-upgrade of the
4900 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00004901
wdenkc6097192002-11-03 00:24:07 +00004902
wdenk6c59edc2004-05-03 20:45:30 +00004903Linux HOWTO:
4904============
wdenkc6097192002-11-03 00:24:07 +00004905
wdenk6c59edc2004-05-03 20:45:30 +00004906Porting Linux to U-Boot based systems:
4907---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004908
wdenk6c59edc2004-05-03 20:45:30 +00004909U-Boot cannot save you from doing all the necessary modifications to
4910configure the Linux device drivers for use with your target hardware
4911(no, we don't intend to provide a full virtual machine interface to
4912Linux :-).
wdenkc6097192002-11-03 00:24:07 +00004913
Stefan Roese88fbf932010-04-15 16:07:28 +02004914But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00004915
wdenk6c59edc2004-05-03 20:45:30 +00004916Just make sure your machine specific header file (for instance
4917include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02004918Information structure as we define in include/asm-<arch>/u-boot.h,
4919and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004920as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00004921
Simon Glassd097e592014-06-11 23:29:46 -06004922Note that U-Boot now has a driver model, a unified model for drivers.
4923If you are adding a new driver, plumb it into driver model. If there
4924is no uclass available, you are encouraged to create one. See
4925doc/driver-model.
4926
wdenkc6097192002-11-03 00:24:07 +00004927
wdenk6c59edc2004-05-03 20:45:30 +00004928Configuring the Linux kernel:
4929-----------------------------
wdenkc6097192002-11-03 00:24:07 +00004930
wdenk6c59edc2004-05-03 20:45:30 +00004931No specific requirements for U-Boot. Make sure you have some root
4932device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00004933
wdenkc6097192002-11-03 00:24:07 +00004934
wdenk6c59edc2004-05-03 20:45:30 +00004935Building a Linux Image:
4936-----------------------
wdenkc6097192002-11-03 00:24:07 +00004937
wdenk6c59edc2004-05-03 20:45:30 +00004938With U-Boot, "normal" build targets like "zImage" or "bzImage" are
4939not used. If you use recent kernel source, a new build target
4940"uImage" will exist which automatically builds an image usable by
4941U-Boot. Most older kernels also have support for a "pImage" target,
4942which was introduced for our predecessor project PPCBoot and uses a
4943100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00004944
wdenk6c59edc2004-05-03 20:45:30 +00004945Example:
wdenkc6097192002-11-03 00:24:07 +00004946
Holger Freyther7ba4e572014-08-04 09:26:05 +02004947 make TQM850L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00004948 make oldconfig
4949 make dep
4950 make uImage
wdenkc6097192002-11-03 00:24:07 +00004951
wdenk6c59edc2004-05-03 20:45:30 +00004952The "uImage" build target uses a special tool (in 'tools/mkimage') to
4953encapsulate a compressed Linux kernel image with header information,
4954CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00004955
wdenk6c59edc2004-05-03 20:45:30 +00004956* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00004957
wdenk6c59edc2004-05-03 20:45:30 +00004958* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00004959
wdenk6c59edc2004-05-03 20:45:30 +00004960 ${CROSS_COMPILE}-objcopy -O binary \
4961 -R .note -R .comment \
4962 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00004963
wdenk6c59edc2004-05-03 20:45:30 +00004964* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00004965
wdenk6c59edc2004-05-03 20:45:30 +00004966 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00004967
wdenk6c59edc2004-05-03 20:45:30 +00004968* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00004969
wdenk6c59edc2004-05-03 20:45:30 +00004970 mkimage -A ppc -O linux -T kernel -C gzip \
4971 -a 0 -e 0 -n "Linux Kernel Image" \
4972 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00004973
wdenkc6097192002-11-03 00:24:07 +00004974
wdenk6c59edc2004-05-03 20:45:30 +00004975The "mkimage" tool can also be used to create ramdisk images for use
4976with U-Boot, either separated from the Linux kernel image, or
4977combined into one file. "mkimage" encapsulates the images with a 64
4978byte header containing information about target architecture,
4979operating system, image type, compression method, entry points, time
4980stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00004981
wdenk6c59edc2004-05-03 20:45:30 +00004982"mkimage" can be called in two ways: to verify existing images and
4983print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00004984
wdenk6c59edc2004-05-03 20:45:30 +00004985In the first form (with "-l" option) mkimage lists the information
4986contained in the header of an existing U-Boot image; this includes
4987checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00004988
wdenk6c59edc2004-05-03 20:45:30 +00004989 tools/mkimage -l image
4990 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00004991
wdenk6c59edc2004-05-03 20:45:30 +00004992The second form (with "-d" option) is used to build a U-Boot image
4993from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00004994
wdenk6c59edc2004-05-03 20:45:30 +00004995 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4996 -n name -d data_file image
4997 -A ==> set architecture to 'arch'
4998 -O ==> set operating system to 'os'
4999 -T ==> set image type to 'type'
5000 -C ==> set compression type 'comp'
5001 -a ==> set load address to 'addr' (hex)
5002 -e ==> set entry point to 'ep' (hex)
5003 -n ==> set image name to 'name'
5004 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00005005
wdenkcd914452004-05-29 16:53:29 +00005006Right now, all Linux kernels for PowerPC systems use the same load
5007address (0x00000000), but the entry point address depends on the
5008kernel version:
wdenkc6097192002-11-03 00:24:07 +00005009
wdenk6c59edc2004-05-03 20:45:30 +00005010- 2.2.x kernels have the entry point at 0x0000000C,
5011- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00005012
wdenk6c59edc2004-05-03 20:45:30 +00005013So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00005014
wdenk6c59edc2004-05-03 20:45:30 +00005015 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5016 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005017 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk6c59edc2004-05-03 20:45:30 +00005018 > examples/uImage.TQM850L
5019 Image Name: 2.4.4 kernel for TQM850L
5020 Created: Wed Jul 19 02:34:59 2000
5021 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5022 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5023 Load Address: 0x00000000
5024 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005025
wdenk6c59edc2004-05-03 20:45:30 +00005026To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00005027
wdenk6c59edc2004-05-03 20:45:30 +00005028 -> tools/mkimage -l examples/uImage.TQM850L
5029 Image Name: 2.4.4 kernel for TQM850L
5030 Created: Wed Jul 19 02:34:59 2000
5031 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5032 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5033 Load Address: 0x00000000
5034 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005035
wdenk6c59edc2004-05-03 20:45:30 +00005036NOTE: for embedded systems where boot time is critical you can trade
5037speed for memory and install an UNCOMPRESSED image instead: this
5038needs more space in Flash, but boots much faster since it does not
5039need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00005040
Stefan Roese88fbf932010-04-15 16:07:28 +02005041 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk6c59edc2004-05-03 20:45:30 +00005042 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5043 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005044 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk6c59edc2004-05-03 20:45:30 +00005045 > examples/uImage.TQM850L-uncompressed
5046 Image Name: 2.4.4 kernel for TQM850L
5047 Created: Wed Jul 19 02:34:59 2000
5048 Image Type: PowerPC Linux Kernel Image (uncompressed)
5049 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5050 Load Address: 0x00000000
5051 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005052
wdenkc6097192002-11-03 00:24:07 +00005053
wdenk6c59edc2004-05-03 20:45:30 +00005054Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5055when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00005056
wdenk6c59edc2004-05-03 20:45:30 +00005057 -> tools/mkimage -n 'Simple Ramdisk Image' \
5058 > -A ppc -O linux -T ramdisk -C gzip \
5059 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5060 Image Name: Simple Ramdisk Image
5061 Created: Wed Jan 12 14:01:50 2000
5062 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5063 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5064 Load Address: 0x00000000
5065 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005066
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07005067The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5068option performs the converse operation of the mkimage's second form (the "-d"
5069option). Given an image built by mkimage, the dumpimage extracts a "data file"
5070from the image:
5071
Guilherme Maciel Ferreira40bf5632015-01-15 02:54:40 -02005072 tools/dumpimage -i image -T type -p position data_file
5073 -i ==> extract from the 'image' a specific 'data_file'
5074 -T ==> set image type to 'type'
5075 -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07005076
wdenkc6097192002-11-03 00:24:07 +00005077
wdenk6c59edc2004-05-03 20:45:30 +00005078Installing a Linux Image:
5079-------------------------
wdenkc6097192002-11-03 00:24:07 +00005080
wdenk6c59edc2004-05-03 20:45:30 +00005081To downloading a U-Boot image over the serial (console) interface,
5082you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00005083
wdenk6c59edc2004-05-03 20:45:30 +00005084 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00005085
wdenk6c59edc2004-05-03 20:45:30 +00005086The 'objcopy' does not understand the information in the U-Boot
5087image header, so the resulting S-Record file will be relative to
5088address 0x00000000. To load it to a given address, you need to
5089specify the target address as 'offset' parameter with the 'loads'
5090command.
wdenkc6097192002-11-03 00:24:07 +00005091
wdenk6c59edc2004-05-03 20:45:30 +00005092Example: install the image to address 0x40100000 (which on the
5093TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00005094
wdenk6c59edc2004-05-03 20:45:30 +00005095 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00005096
wdenk6c59edc2004-05-03 20:45:30 +00005097 .......... done
5098 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00005099
wdenk6c59edc2004-05-03 20:45:30 +00005100 => loads 40100000
5101 ## Ready for S-Record download ...
5102 ~>examples/image.srec
5103 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5104 ...
5105 15989 15990 15991 15992
5106 [file transfer complete]
5107 [connected]
5108 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005109
wdenkc6097192002-11-03 00:24:07 +00005110
wdenk6c59edc2004-05-03 20:45:30 +00005111You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005112this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00005113corruption happened:
wdenkc6097192002-11-03 00:24:07 +00005114
wdenk6c59edc2004-05-03 20:45:30 +00005115 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00005116
wdenk6c59edc2004-05-03 20:45:30 +00005117 ## Checking Image at 40100000 ...
5118 Image Name: 2.2.13 for initrd on TQM850L
5119 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5120 Data Size: 335725 Bytes = 327 kB = 0 MB
5121 Load Address: 00000000
5122 Entry Point: 0000000c
5123 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005124
5125
wdenk6c59edc2004-05-03 20:45:30 +00005126Boot Linux:
5127-----------
wdenkc6097192002-11-03 00:24:07 +00005128
wdenk6c59edc2004-05-03 20:45:30 +00005129The "bootm" command is used to boot an application that is stored in
5130memory (RAM or Flash). In case of a Linux kernel image, the contents
5131of the "bootargs" environment variable is passed to the kernel as
5132parameters. You can check and modify this variable using the
5133"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00005134
wdenkc6097192002-11-03 00:24:07 +00005135
wdenk6c59edc2004-05-03 20:45:30 +00005136 => printenv bootargs
5137 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00005138
wdenk6c59edc2004-05-03 20:45:30 +00005139 => 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 +00005140
wdenk6c59edc2004-05-03 20:45:30 +00005141 => printenv bootargs
5142 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 +00005143
wdenk6c59edc2004-05-03 20:45:30 +00005144 => bootm 40020000
5145 ## Booting Linux kernel at 40020000 ...
5146 Image Name: 2.2.13 for NFS on TQM850L
5147 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5148 Data Size: 381681 Bytes = 372 kB = 0 MB
5149 Load Address: 00000000
5150 Entry Point: 0000000c
5151 Verifying Checksum ... OK
5152 Uncompressing Kernel Image ... OK
5153 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
5154 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5155 time_init: decrementer frequency = 187500000/60
5156 Calibrating delay loop... 49.77 BogoMIPS
5157 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5158 ...
wdenkc6097192002-11-03 00:24:07 +00005159
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005160If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00005161the memory addresses of both the kernel and the initrd image (PPBCOOT
5162format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00005163
wdenk6c59edc2004-05-03 20:45:30 +00005164 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00005165
wdenk6c59edc2004-05-03 20:45:30 +00005166 ## Checking Image at 40100000 ...
5167 Image Name: 2.2.13 for initrd on TQM850L
5168 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5169 Data Size: 335725 Bytes = 327 kB = 0 MB
5170 Load Address: 00000000
5171 Entry Point: 0000000c
5172 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005173
wdenk6c59edc2004-05-03 20:45:30 +00005174 ## Checking Image at 40200000 ...
5175 Image Name: Simple Ramdisk Image
5176 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5177 Data Size: 566530 Bytes = 553 kB = 0 MB
5178 Load Address: 00000000
5179 Entry Point: 00000000
5180 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005181
wdenk6c59edc2004-05-03 20:45:30 +00005182 => bootm 40100000 40200000
5183 ## Booting Linux kernel at 40100000 ...
5184 Image Name: 2.2.13 for initrd on TQM850L
5185 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5186 Data Size: 335725 Bytes = 327 kB = 0 MB
5187 Load Address: 00000000
5188 Entry Point: 0000000c
5189 Verifying Checksum ... OK
5190 Uncompressing Kernel Image ... OK
5191 ## Loading RAMDisk Image at 40200000 ...
5192 Image Name: Simple Ramdisk Image
5193 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5194 Data Size: 566530 Bytes = 553 kB = 0 MB
5195 Load Address: 00000000
5196 Entry Point: 00000000
5197 Verifying Checksum ... OK
5198 Loading Ramdisk ... OK
5199 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
5200 Boot arguments: root=/dev/ram
5201 time_init: decrementer frequency = 187500000/60
5202 Calibrating delay loop... 49.77 BogoMIPS
5203 ...
5204 RAMDISK: Compressed image found at block 0
5205 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00005206
wdenk6c59edc2004-05-03 20:45:30 +00005207 bash#
wdenkc6097192002-11-03 00:24:07 +00005208
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005209Boot Linux and pass a flat device tree:
5210-----------
5211
5212First, U-Boot must be compiled with the appropriate defines. See the section
5213titled "Linux Kernel Interface" above for a more in depth explanation. The
5214following is an example of how to start a kernel and pass an updated
5215flat device tree:
5216
5217=> print oftaddr
5218oftaddr=0x300000
5219=> print oft
5220oft=oftrees/mpc8540ads.dtb
5221=> tftp $oftaddr $oft
5222Speed: 1000, full duplex
5223Using TSEC0 device
5224TFTP from server 192.168.1.1; our IP address is 192.168.1.101
5225Filename 'oftrees/mpc8540ads.dtb'.
5226Load address: 0x300000
5227Loading: #
5228done
5229Bytes transferred = 4106 (100a hex)
5230=> tftp $loadaddr $bootfile
5231Speed: 1000, full duplex
5232Using TSEC0 device
5233TFTP from server 192.168.1.1; our IP address is 192.168.1.2
5234Filename 'uImage'.
5235Load address: 0x200000
5236Loading:############
5237done
5238Bytes transferred = 1029407 (fb51f hex)
5239=> print loadaddr
5240loadaddr=200000
5241=> print oftaddr
5242oftaddr=0x300000
5243=> bootm $loadaddr - $oftaddr
5244## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01005245 Image Name: Linux-2.6.17-dirty
5246 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5247 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005248 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01005249 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005250 Verifying Checksum ... OK
5251 Uncompressing Kernel Image ... OK
5252Booting using flat device tree at 0x300000
5253Using MPC85xx ADS machine description
5254Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
5255[snip]
5256
5257
wdenk6c59edc2004-05-03 20:45:30 +00005258More About U-Boot Image Types:
5259------------------------------
wdenkc6097192002-11-03 00:24:07 +00005260
wdenk6c59edc2004-05-03 20:45:30 +00005261U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00005262
wdenk6c59edc2004-05-03 20:45:30 +00005263 "Standalone Programs" are directly runnable in the environment
5264 provided by U-Boot; it is expected that (if they behave
5265 well) you can continue to work in U-Boot after return from
5266 the Standalone Program.
5267 "OS Kernel Images" are usually images of some Embedded OS which
5268 will take over control completely. Usually these programs
5269 will install their own set of exception handlers, device
5270 drivers, set up the MMU, etc. - this means, that you cannot
5271 expect to re-enter U-Boot except by resetting the CPU.
5272 "RAMDisk Images" are more or less just data blocks, and their
5273 parameters (address, size) are passed to an OS kernel that is
5274 being started.
5275 "Multi-File Images" contain several images, typically an OS
5276 (Linux) kernel image and one or more data images like
5277 RAMDisks. This construct is useful for instance when you want
5278 to boot over the network using BOOTP etc., where the boot
5279 server provides just a single image file, but you want to get
5280 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00005281
wdenk6c59edc2004-05-03 20:45:30 +00005282 "Multi-File Images" start with a list of image sizes, each
5283 image size (in bytes) specified by an "uint32_t" in network
5284 byte order. This list is terminated by an "(uint32_t)0".
5285 Immediately after the terminating 0 follow the images, one by
5286 one, all aligned on "uint32_t" boundaries (size rounded up to
5287 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00005288
wdenk6c59edc2004-05-03 20:45:30 +00005289 "Firmware Images" are binary images containing firmware (like
5290 U-Boot or FPGA images) which usually will be programmed to
5291 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00005292
wdenk6c59edc2004-05-03 20:45:30 +00005293 "Script files" are command sequences that will be executed by
5294 U-Boot's command interpreter; this feature is especially
5295 useful when you configure U-Boot to use a real shell (hush)
5296 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00005297
Marek Vasutcf41a9b2012-03-14 21:52:45 +00005298Booting the Linux zImage:
5299-------------------------
5300
5301On some platforms, it's possible to boot Linux zImage. This is done
5302using the "bootz" command. The syntax of "bootz" command is the same
5303as the syntax of "bootm" command.
5304
Tom Rini45f46d12013-05-16 11:40:11 -04005305Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut28850d02012-03-18 11:47:58 +00005306kernel with raw initrd images. The syntax is slightly different, the
5307address of the initrd must be augmented by it's size, in the following
5308format: "<initrd addres>:<initrd size>".
5309
stroeseb9c17c52003-04-04 15:53:41 +00005310
wdenk6c59edc2004-05-03 20:45:30 +00005311Standalone HOWTO:
5312=================
stroeseb9c17c52003-04-04 15:53:41 +00005313
wdenk6c59edc2004-05-03 20:45:30 +00005314One of the features of U-Boot is that you can dynamically load and
5315run "standalone" applications, which can use some resources of
5316U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00005317
wdenk6c59edc2004-05-03 20:45:30 +00005318Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00005319
wdenk6c59edc2004-05-03 20:45:30 +00005320"Hello World" Demo:
5321-------------------
wdenkc6097192002-11-03 00:24:07 +00005322
wdenk6c59edc2004-05-03 20:45:30 +00005323'examples/hello_world.c' contains a small "Hello World" Demo
5324application; it is automatically compiled when you build U-Boot.
5325It's configured to run at address 0x00040004, so you can play with it
5326like that:
wdenkc6097192002-11-03 00:24:07 +00005327
wdenk6c59edc2004-05-03 20:45:30 +00005328 => loads
5329 ## Ready for S-Record download ...
5330 ~>examples/hello_world.srec
5331 1 2 3 4 5 6 7 8 9 10 11 ...
5332 [file transfer complete]
5333 [connected]
5334 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005335
wdenk6c59edc2004-05-03 20:45:30 +00005336 => go 40004 Hello World! This is a test.
5337 ## Starting application at 0x00040004 ...
5338 Hello World
5339 argc = 7
5340 argv[0] = "40004"
5341 argv[1] = "Hello"
5342 argv[2] = "World!"
5343 argv[3] = "This"
5344 argv[4] = "is"
5345 argv[5] = "a"
5346 argv[6] = "test."
5347 argv[7] = "<NULL>"
5348 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00005349
wdenk6c59edc2004-05-03 20:45:30 +00005350 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005351
wdenk6c59edc2004-05-03 20:45:30 +00005352Another example, which demonstrates how to register a CPM interrupt
5353handler with the U-Boot code, can be found in 'examples/timer.c'.
5354Here, a CPM timer is set up to generate an interrupt every second.
5355The interrupt service routine is trivial, just printing a '.'
5356character, but this is just a demo program. The application can be
5357controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00005358
wdenk6c59edc2004-05-03 20:45:30 +00005359 ? - print current values og the CPM Timer registers
5360 b - enable interrupts and start timer
5361 e - stop timer and disable interrupts
5362 q - quit application
wdenkc6097192002-11-03 00:24:07 +00005363
wdenk6c59edc2004-05-03 20:45:30 +00005364 => loads
5365 ## Ready for S-Record download ...
5366 ~>examples/timer.srec
5367 1 2 3 4 5 6 7 8 9 10 11 ...
5368 [file transfer complete]
5369 [connected]
5370 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005371
wdenk6c59edc2004-05-03 20:45:30 +00005372 => go 40004
5373 ## Starting application at 0x00040004 ...
5374 TIMERS=0xfff00980
5375 Using timer 1
5376 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00005377
wdenk6c59edc2004-05-03 20:45:30 +00005378Hit 'b':
5379 [q, b, e, ?] Set interval 1000000 us
5380 Enabling timer
5381Hit '?':
5382 [q, b, e, ?] ........
5383 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5384Hit '?':
5385 [q, b, e, ?] .
5386 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5387Hit '?':
5388 [q, b, e, ?] .
5389 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5390Hit '?':
5391 [q, b, e, ?] .
5392 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5393Hit 'e':
5394 [q, b, e, ?] ...Stopping timer
5395Hit 'q':
5396 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005397
wdenkc6097192002-11-03 00:24:07 +00005398
wdenk6c59edc2004-05-03 20:45:30 +00005399Minicom warning:
5400================
wdenkc6097192002-11-03 00:24:07 +00005401
wdenk6c59edc2004-05-03 20:45:30 +00005402Over time, many people have reported problems when trying to use the
5403"minicom" terminal emulation program for serial download. I (wd)
5404consider minicom to be broken, and recommend not to use it. Under
5405Unix, I recommend to use C-Kermit for general purpose use (and
5406especially for kermit binary protocol download ("loadb" command), and
Karl O. Pinca0189bb2012-10-01 05:11:56 +00005407use "cu" for S-Record download ("loads" command). See
5408http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5409for help with kermit.
5410
wdenkc6097192002-11-03 00:24:07 +00005411
wdenk6c59edc2004-05-03 20:45:30 +00005412Nevertheless, if you absolutely want to use it try adding this
5413configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00005414
wdenk6c59edc2004-05-03 20:45:30 +00005415 Name Program Name U/D FullScr IO-Red. Multi
5416 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
5417 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00005418
wdenk8dba0502003-03-31 16:34:49 +00005419
wdenk6c59edc2004-05-03 20:45:30 +00005420NetBSD Notes:
5421=============
wdenkc6097192002-11-03 00:24:07 +00005422
wdenk6c59edc2004-05-03 20:45:30 +00005423Starting at version 0.9.2, U-Boot supports NetBSD both as host
5424(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00005425
wdenk6c59edc2004-05-03 20:45:30 +00005426Building requires a cross environment; it is known to work on
5427NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5428need gmake since the Makefiles are not compatible with BSD make).
5429Note that the cross-powerpc package does not install include files;
5430attempting to build U-Boot will fail because <machine/ansi.h> is
5431missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00005432
wdenk6c59edc2004-05-03 20:45:30 +00005433 # cd /usr/pkg/cross/powerpc-netbsd/include
5434 # mkdir powerpc
5435 # ln -s powerpc machine
5436 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5437 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00005438
wdenk6c59edc2004-05-03 20:45:30 +00005439Native builds *don't* work due to incompatibilities between native
5440and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00005441
wdenk6c59edc2004-05-03 20:45:30 +00005442Booting assumes that (the first part of) the image booted is a
5443stage-2 loader which in turn loads and then invokes the kernel
5444proper. Loader sources will eventually appear in the NetBSD source
5445tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00005446meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00005447
wdenkc6097192002-11-03 00:24:07 +00005448
wdenk6c59edc2004-05-03 20:45:30 +00005449Implementation Internals:
5450=========================
wdenkc6097192002-11-03 00:24:07 +00005451
wdenk6c59edc2004-05-03 20:45:30 +00005452The following is not intended to be a complete description of every
5453implementation detail. However, it should help to understand the
5454inner workings of U-Boot and make it easier to port it to custom
5455hardware.
wdenkc6097192002-11-03 00:24:07 +00005456
wdenkc6097192002-11-03 00:24:07 +00005457
wdenk6c59edc2004-05-03 20:45:30 +00005458Initial Stack, Global Data:
5459---------------------------
wdenkc6097192002-11-03 00:24:07 +00005460
wdenk6c59edc2004-05-03 20:45:30 +00005461The implementation of U-Boot is complicated by the fact that U-Boot
5462starts running out of ROM (flash memory), usually without access to
5463system RAM (because the memory controller is not initialized yet).
5464This means that we don't have writable Data or BSS segments, and BSS
5465is not initialized as zero. To be able to get a C environment working
5466at all, we have to allocate at least a minimal stack. Implementation
5467options for this are defined and restricted by the CPU used: Some CPU
5468models provide on-chip memory (like the IMMR area on MPC8xx and
5469MPC826x processors), on others (parts of) the data cache can be
5470locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00005471
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005472 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005473 U-Boot mailing list:
wdenkc6097192002-11-03 00:24:07 +00005474
wdenk6c59edc2004-05-03 20:45:30 +00005475 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
5476 From: "Chris Hallinan" <clh@net1plus.com>
5477 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
5478 ...
wdenkc6097192002-11-03 00:24:07 +00005479
wdenk6c59edc2004-05-03 20:45:30 +00005480 Correct me if I'm wrong, folks, but the way I understand it
5481 is this: Using DCACHE as initial RAM for Stack, etc, does not
5482 require any physical RAM backing up the cache. The cleverness
5483 is that the cache is being used as a temporary supply of
5484 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005485 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00005486 can see how this works by studying the cache architecture and
5487 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00005488
wdenk6c59edc2004-05-03 20:45:30 +00005489 OCM is On Chip Memory, which I believe the 405GP has 4K. It
5490 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005491 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00005492 option should work for you. Using CS 4 should be fine if your
5493 board designers haven't used it for something that would
5494 cause you grief during the initial boot! It is frequently not
5495 used.
wdenkc6097192002-11-03 00:24:07 +00005496
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005497 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00005498 with your processor/board/system design. The default value
5499 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02005500 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00005501 than your SDRAM module. If you have a 64MB SDRAM module, set
5502 it above 400_0000. Just make sure your board has no resources
5503 that are supposed to respond to that address! That code in
5504 start.S has been around a while and should work as is when
5505 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00005506
wdenk6c59edc2004-05-03 20:45:30 +00005507 -Chris Hallinan
5508 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00005509
wdenk6c59edc2004-05-03 20:45:30 +00005510It is essential to remember this, since it has some impact on the C
5511code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00005512
wdenk6c59edc2004-05-03 20:45:30 +00005513* Initialized global data (data segment) is read-only. Do not attempt
5514 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00005515
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005516* Do not use any uninitialized global data (or implicitly initialized
wdenk6c59edc2004-05-03 20:45:30 +00005517 as zero data - BSS segment) at all - this is undefined, initiali-
5518 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00005519
wdenk6c59edc2004-05-03 20:45:30 +00005520* Stack space is very limited. Avoid big data buffers or things like
5521 that.
wdenk4a5c8a72003-03-06 00:02:04 +00005522
wdenk6c59edc2004-05-03 20:45:30 +00005523Having only the stack as writable memory limits means we cannot use
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005524normal global data to share information between the code. But it
wdenk6c59edc2004-05-03 20:45:30 +00005525turned out that the implementation of U-Boot can be greatly
5526simplified by making a global data structure (gd_t) available to all
5527functions. We could pass a pointer to this data as argument to _all_
5528functions, but this would bloat the code. Instead we use a feature of
5529the GCC compiler (Global Register Variables) to share the data: we
5530place a pointer (gd) to the global data into a register which we
5531reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00005532
wdenk6c59edc2004-05-03 20:45:30 +00005533When choosing a register for such a purpose we are restricted by the
5534relevant (E)ABI specifications for the current architecture, and by
5535GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00005536
wdenk6c59edc2004-05-03 20:45:30 +00005537For PowerPC, the following registers have specific use:
5538 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01005539 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00005540 R3-R4: parameter passing and return values
5541 R5-R10: parameter passing
5542 R13: small data area pointer
5543 R30: GOT pointer
5544 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00005545
Joakim Tjernlund693c0c12010-01-19 14:41:58 +01005546 (U-Boot also uses R12 as internal GOT pointer. r12
5547 is a volatile register so r12 needs to be reset when
5548 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00005549
Wolfgang Denk69c09642008-02-14 22:43:22 +01005550 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005551
wdenk6c59edc2004-05-03 20:45:30 +00005552 Note: on PPC, we could use a static initializer (since the
5553 address of the global data structure is known at compile time),
5554 but it turned out that reserving a register results in somewhat
5555 smaller code - although the code savings are not that big (on
5556 average for all boards 752 bytes for the whole U-Boot image,
5557 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00005558
wdenk6c59edc2004-05-03 20:45:30 +00005559On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00005560
wdenk6c59edc2004-05-03 20:45:30 +00005561 R0: function argument word/integer result
5562 R1-R3: function argument word
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02005563 R9: platform specific
5564 R10: stack limit (used only if stack checking is enabled)
wdenk6c59edc2004-05-03 20:45:30 +00005565 R11: argument (frame) pointer
5566 R12: temporary workspace
5567 R13: stack pointer
5568 R14: link register
5569 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00005570
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02005571 ==> U-Boot will use R9 to hold a pointer to the global data
5572
5573 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00005574
Thomas Chou8fa38582010-05-21 11:08:03 +08005575On Nios II, the ABI is documented here:
5576 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
5577
5578 ==> U-Boot will use gp to hold a pointer to the global data
5579
5580 Note: on Nios II, we give "-G0" option to gcc and don't use gp
5581 to access small data sections, so gp is free.
5582
Macpaul Lin1cac36e2011-10-19 20:41:11 +00005583On NDS32, the following registers are used:
5584
5585 R0-R1: argument/return
5586 R2-R5: argument
5587 R15: temporary register for assembler
5588 R16: trampoline register
5589 R28: frame pointer (FP)
5590 R29: global pointer (GP)
5591 R30: link register (LP)
5592 R31: stack pointer (SP)
5593 PC: program counter (PC)
5594
5595 ==> U-Boot will use R10 to hold a pointer to the global data
5596
Wolfgang Denk6405a152006-03-31 18:32:53 +02005597NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5598or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00005599
wdenk6c59edc2004-05-03 20:45:30 +00005600Memory Management:
5601------------------
wdenkc6097192002-11-03 00:24:07 +00005602
wdenk6c59edc2004-05-03 20:45:30 +00005603U-Boot runs in system state and uses physical addresses, i.e. the
5604MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00005605
wdenk6c59edc2004-05-03 20:45:30 +00005606The available memory is mapped to fixed addresses using the memory
5607controller. In this process, a contiguous block is formed for each
5608memory type (Flash, SDRAM, SRAM), even when it consists of several
5609physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00005610
wdenk6c59edc2004-05-03 20:45:30 +00005611U-Boot is installed in the first 128 kB of the first Flash bank (on
5612TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5613booting and sizing and initializing DRAM, the code relocates itself
5614to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005615memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00005616configuration setting]. Below that, a structure with global Board
5617Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00005618
wdenk6c59edc2004-05-03 20:45:30 +00005619Additionally, some exception handler code is copied to the low 8 kB
5620of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00005621
wdenk6c59edc2004-05-03 20:45:30 +00005622So a typical memory configuration with 16 MB of DRAM could look like
5623this:
wdenkc6097192002-11-03 00:24:07 +00005624
wdenk6c59edc2004-05-03 20:45:30 +00005625 0x0000 0000 Exception Vector code
5626 :
5627 0x0000 1FFF
5628 0x0000 2000 Free for Application Use
5629 :
5630 :
wdenkc6097192002-11-03 00:24:07 +00005631
wdenk6c59edc2004-05-03 20:45:30 +00005632 :
5633 :
5634 0x00FB FF20 Monitor Stack (Growing downward)
5635 0x00FB FFAC Board Info Data and permanent copy of global data
5636 0x00FC 0000 Malloc Arena
5637 :
5638 0x00FD FFFF
5639 0x00FE 0000 RAM Copy of Monitor Code
5640 ... eventually: LCD or video framebuffer
5641 ... eventually: pRAM (Protected RAM - unchanged by reset)
5642 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00005643
wdenkc6097192002-11-03 00:24:07 +00005644
wdenk6c59edc2004-05-03 20:45:30 +00005645System Initialization:
5646----------------------
wdenkc6097192002-11-03 00:24:07 +00005647
wdenk6c59edc2004-05-03 20:45:30 +00005648In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005649(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005650configuration for CS0# this is a mirror of the on board Flash memory.
wdenk6c59edc2004-05-03 20:45:30 +00005651To be able to re-map memory U-Boot then jumps to its link address.
5652To be able to implement the initialization code in C, a (small!)
5653initial stack is set up in the internal Dual Ported RAM (in case CPUs
Heiko Schocher71cb3e92017-06-07 17:33:10 +02005654which provide such a feature like), or in a locked part of the data
5655cache. After that, U-Boot initializes the CPU core, the caches and
5656the SIU.
wdenkc6097192002-11-03 00:24:07 +00005657
wdenk6c59edc2004-05-03 20:45:30 +00005658Next, all (potentially) available memory banks are mapped using a
5659preliminary mapping. For example, we put them on 512 MB boundaries
5660(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5661on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5662programmed for SDRAM access. Using the temporary configuration, a
5663simple memory test is run that determines the size of the SDRAM
5664banks.
wdenkc6097192002-11-03 00:24:07 +00005665
wdenk6c59edc2004-05-03 20:45:30 +00005666When there is more than one SDRAM bank, and the banks are of
5667different size, the largest is mapped first. For equal size, the first
5668bank (CS2#) is mapped first. The first mapping is always for address
56690x00000000, with any additional banks following immediately to create
5670contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00005671
wdenk6c59edc2004-05-03 20:45:30 +00005672Then, the monitor installs itself at the upper end of the SDRAM area
5673and allocates memory for use by malloc() and for the global Board
5674Info data; also, the exception vector code is copied to the low RAM
5675pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00005676
wdenk6c59edc2004-05-03 20:45:30 +00005677Only after this relocation will you have a "normal" C environment;
5678until that you are restricted in several ways, mostly because you are
5679running from ROM, and because the code will have to be relocated to a
5680new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00005681
wdenkc6097192002-11-03 00:24:07 +00005682
wdenk6c59edc2004-05-03 20:45:30 +00005683U-Boot Porting Guide:
5684----------------------
wdenkc6097192002-11-03 00:24:07 +00005685
wdenk6c59edc2004-05-03 20:45:30 +00005686[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
5687list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00005688
wdenkc6097192002-11-03 00:24:07 +00005689
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005690int main(int argc, char *argv[])
wdenk6c59edc2004-05-03 20:45:30 +00005691{
5692 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00005693
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005694 signal(SIGALRM, no_more_time);
5695 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00005696
wdenk6c59edc2004-05-03 20:45:30 +00005697 if (available_money > available_manpower) {
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005698 Pay consultant to port U-Boot;
wdenk6c59edc2004-05-03 20:45:30 +00005699 return 0;
5700 }
wdenkc6097192002-11-03 00:24:07 +00005701
wdenk6c59edc2004-05-03 20:45:30 +00005702 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00005703
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005704 Subscribe to u-boot mailing list;
wdenkc6097192002-11-03 00:24:07 +00005705
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005706 if (clueless)
5707 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00005708
wdenk6c59edc2004-05-03 20:45:30 +00005709 while (learning) {
5710 Read the README file in the top level directory;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005711 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
5712 Read applicable doc/*.README;
wdenk6c59edc2004-05-03 20:45:30 +00005713 Read the source, Luke;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005714 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk6c59edc2004-05-03 20:45:30 +00005715 }
wdenkc6097192002-11-03 00:24:07 +00005716
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005717 if (available_money > toLocalCurrency ($2500))
5718 Buy a BDI3000;
5719 else
wdenk6c59edc2004-05-03 20:45:30 +00005720 Add a lot of aggravation and time;
wdenkc6097192002-11-03 00:24:07 +00005721
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005722 if (a similar board exists) { /* hopefully... */
5723 cp -a board/<similar> board/<myboard>
5724 cp include/configs/<similar>.h include/configs/<myboard>.h
5725 } else {
5726 Create your own board support subdirectory;
5727 Create your own board include/configs/<myboard>.h file;
5728 }
5729 Edit new board/<myboard> files
5730 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00005731
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005732 while (!accepted) {
5733 while (!running) {
5734 do {
5735 Add / modify source code;
5736 } until (compiles);
5737 Debug;
5738 if (clueless)
5739 email("Hi, I am having problems...");
5740 }
5741 Send patch file to the U-Boot email list;
5742 if (reasonable critiques)
5743 Incorporate improvements from email list code review;
5744 else
5745 Defend code as written;
wdenk634d2f72004-04-15 23:14:49 +00005746 }
wdenkc6097192002-11-03 00:24:07 +00005747
wdenk6c59edc2004-05-03 20:45:30 +00005748 return 0;
5749}
wdenkc6097192002-11-03 00:24:07 +00005750
wdenk6c59edc2004-05-03 20:45:30 +00005751void no_more_time (int sig)
5752{
5753 hire_a_guru();
5754}
wdenkc6097192002-11-03 00:24:07 +00005755
wdenkc6097192002-11-03 00:24:07 +00005756
wdenk6c59edc2004-05-03 20:45:30 +00005757Coding Standards:
5758-----------------
wdenkc6097192002-11-03 00:24:07 +00005759
wdenk6c59edc2004-05-03 20:45:30 +00005760All contributions to U-Boot should conform to the Linux kernel
Detlev Zundelaa63d482006-09-01 15:39:02 +02005761coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005762"scripts/Lindent" in your Linux kernel source directory.
Detlev Zundelaa63d482006-09-01 15:39:02 +02005763
5764Source files originating from a different project (for example the
5765MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005766reformatted to ease subsequent migration to newer versions of those
Detlev Zundelaa63d482006-09-01 15:39:02 +02005767sources.
wdenkc6097192002-11-03 00:24:07 +00005768
Detlev Zundelaa63d482006-09-01 15:39:02 +02005769Please note that U-Boot is implemented in C (and to some small parts in
5770Assembler); no C++ is used, so please do not use C++ style comments (//)
5771in your code.
wdenkad276f22004-01-04 16:28:35 +00005772
wdenk6c59edc2004-05-03 20:45:30 +00005773Please also stick to the following formatting rules:
5774- remove any trailing white space
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005775- use TAB characters for indentation and vertical alignment, not spaces
wdenk6c59edc2004-05-03 20:45:30 +00005776- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005777- do not add more than 2 consecutive empty lines to source files
wdenk6c59edc2004-05-03 20:45:30 +00005778- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00005779
wdenk6c59edc2004-05-03 20:45:30 +00005780Submissions which do not conform to the standards may be returned
5781with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00005782
wdenkc6097192002-11-03 00:24:07 +00005783
wdenk6c59edc2004-05-03 20:45:30 +00005784Submitting Patches:
5785-------------------
wdenkc6097192002-11-03 00:24:07 +00005786
wdenk6c59edc2004-05-03 20:45:30 +00005787Since the number of patches for U-Boot is growing, we need to
5788establish some rules. Submissions which do not conform to these rules
5789may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00005790
Magnus Liljaf3b287b2008-08-06 19:32:33 +02005791Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005792
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005793Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
5794see http://lists.denx.de/mailman/listinfo/u-boot
5795
wdenk6c59edc2004-05-03 20:45:30 +00005796When you send a patch, please include the following information with
5797it:
wdenkc6097192002-11-03 00:24:07 +00005798
wdenk6c59edc2004-05-03 20:45:30 +00005799* For bug fixes: a description of the bug and how your patch fixes
5800 this bug. Please try to include a way of demonstrating that the
5801 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00005802
wdenk6c59edc2004-05-03 20:45:30 +00005803* For new features: a description of the feature and your
5804 implementation.
wdenkc6097192002-11-03 00:24:07 +00005805
wdenk6c59edc2004-05-03 20:45:30 +00005806* A CHANGELOG entry as plaintext (separate from the patch)
wdenkc6097192002-11-03 00:24:07 +00005807
Robert P. J. Day076ed9b2015-12-19 07:16:10 -05005808* For major contributions, add a MAINTAINERS file with your
5809 information and associated file and directory references.
wdenkc6097192002-11-03 00:24:07 +00005810
Albert ARIBAUD48e910f2013-09-11 15:52:51 +02005811* When you add support for a new board, don't forget to add a
5812 maintainer e-mail address to the boards.cfg file, too.
wdenkc6097192002-11-03 00:24:07 +00005813
wdenk6c59edc2004-05-03 20:45:30 +00005814* If your patch adds new configuration options, don't forget to
5815 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00005816
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005817* The patch itself. If you are using git (which is *strongly*
5818 recommended) you can easily generate the patch using the
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005819 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005820 the U-Boot mailing list, you will avoid most of the common problems
5821 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00005822
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005823 If you cannot use git, use "diff -purN OLD NEW". If your version of
5824 diff does not support these options, then get the latest version of
5825 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00005826
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005827 The current directory when running this command shall be the parent
5828 directory of the U-Boot source tree (i. e. please make sure that
5829 your patch includes sufficient directory information for the
5830 affected files).
5831
5832 We prefer patches as plain text. MIME attachments are discouraged,
5833 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00005834
wdenk6c59edc2004-05-03 20:45:30 +00005835* If one logical set of modifications affects or creates several
5836 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00005837
wdenk6c59edc2004-05-03 20:45:30 +00005838* Changesets that contain different, unrelated modifications shall be
5839 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00005840
wdenkc6097192002-11-03 00:24:07 +00005841
wdenk6c59edc2004-05-03 20:45:30 +00005842Notes:
wdenkc6097192002-11-03 00:24:07 +00005843
Simon Glassdc27def2016-07-27 20:33:08 -06005844* Before sending the patch, run the buildman script on your patched
wdenk6c59edc2004-05-03 20:45:30 +00005845 source tree and make sure that no errors or warnings are reported
5846 for any of the boards.
5847
5848* Keep your modifications to the necessary minimum: A patch
5849 containing several unrelated changes or arbitrary reformats will be
5850 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00005851
wdenk6c59edc2004-05-03 20:45:30 +00005852* If you modify existing code, make sure that your new code does not
5853 add to the memory footprint of the code ;-) Small is beautiful!
5854 When adding new features, these should compile conditionally only
5855 (using #ifdef), and the resulting code with the new feature
5856 disabled must not need more memory than the old code without your
5857 modification.
wdenkcbc49a52005-05-03 14:12:25 +00005858
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005859* Remember that there is a size limit of 100 kB per message on the
5860 u-boot mailing list. Bigger patches will be moderated. If they are
5861 reasonable and not too big, they will be acknowledged. But patches
5862 bigger than the size limit should be avoided.