blob: 5f4f97cb016e23365f380eb32e4d7e7ecd0c4a42 [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
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200611 OF_TBCLK - The timebase frequency.
Kumar Galae40c2b52006-01-11 13:59:02 -0600612 OF_STDOUT_PATH - The path to the console device
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200613
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200614 boards with QUICC Engines require OF_QE to set UCC MAC
615 addresses
Kim Phillips9b46eb62007-08-10 14:34:14 -0500616
Kumar Gala1e26aa52006-01-11 13:54:17 -0600617 CONFIG_OF_BOARD_SETUP
618
619 Board code has addition modification that it wants to make
620 to the flat device tree before handing it off to the kernel
wdenkda04a8b2004-08-02 23:22:59 +0000621
Simon Glass6c0be912014-10-23 18:58:54 -0600622 CONFIG_OF_SYSTEM_SETUP
623
624 Other code has addition modification that it wants to make
625 to the flat device tree before handing it off to the kernel.
626 This causes ft_system_setup() to be called before booting
627 the kernel.
628
Heiko Schocherffb293a2009-09-23 07:56:08 +0200629 CONFIG_OF_IDE_FIXUP
630
631 U-Boot can detect if an IDE device is present or not.
632 If not, and this new config option is activated, U-Boot
633 removes the ATA node from the DTS before booting Linux,
634 so the Linux IDE driver does not probe the device and
635 crash. This is needed for buggy hardware (uc101) where
636 no pull down resistor is connected to the signal IDE5V_DD7.
637
Igor Grinberg06890672011-07-14 05:45:07 +0000638 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
639
640 This setting is mandatory for all boards that have only one
641 machine type and must be used to specify the machine type
642 number as it appears in the ARM machine registry
643 (see http://www.arm.linux.org.uk/developer/machines/).
644 Only boards that have multiple machine types supported
645 in a single configuration file and the machine type is
646 runtime discoverable, do not have to use this setting.
647
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100648- vxWorks boot parameters:
649
650 bootvx constructs a valid bootline using the following
Bin Mengfb694b92015-10-07 20:19:17 -0700651 environments variables: bootdev, bootfile, ipaddr, netmask,
652 serverip, gatewayip, hostname, othbootargs.
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100653 It loads the vxWorks image pointed bootfile.
654
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100655 Note: If a "bootargs" environment is defined, it will overwride
656 the defaults discussed just above.
657
Aneesh V960f5c02011-06-16 23:30:47 +0000658- Cache Configuration:
659 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
660 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
661 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
662
Aneesh V686a0752011-06-16 23:30:51 +0000663- Cache Configuration for ARM:
664 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
665 controller
666 CONFIG_SYS_PL310_BASE - Physical base address of PL310
667 controller register space
668
wdenkda04a8b2004-08-02 23:22:59 +0000669- Serial Ports:
Andreas Engel0813b122008-09-08 14:30:53 +0200670 CONFIG_PL010_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000671
672 Define this if you want support for Amba PrimeCell PL010 UARTs.
673
Andreas Engel0813b122008-09-08 14:30:53 +0200674 CONFIG_PL011_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000675
676 Define this if you want support for Amba PrimeCell PL011 UARTs.
677
678 CONFIG_PL011_CLOCK
679
680 If you have Amba PrimeCell PL011 UARTs, set this variable to
681 the clock speed of the UARTs.
682
683 CONFIG_PL01x_PORTS
684
685 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
686 define this to a list of base addresses for each (supported)
687 port. See e.g. include/configs/versatile.h
688
Karicheri, Muralidharancbc08882014-04-09 15:38:46 -0400689 CONFIG_SERIAL_HW_FLOW_CONTROL
690
691 Define this variable to enable hw flow control in serial driver.
692 Current user of this option is drivers/serial/nsl16550.c driver
wdenkda04a8b2004-08-02 23:22:59 +0000693
wdenkc6097192002-11-03 00:24:07 +0000694- Console Baudrate:
695 CONFIG_BAUDRATE - in bps
696 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200697 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000698
wdenkc6097192002-11-03 00:24:07 +0000699- Autoboot Command:
700 CONFIG_BOOTCOMMAND
701 Only needed when CONFIG_BOOTDELAY is enabled;
702 define a command string that is automatically executed
703 when no character is read on the console interface
704 within "Boot Delay" after reset.
705
706 CONFIG_BOOTARGS
wdenk4a5c8a72003-03-06 00:02:04 +0000707 This can be used to pass arguments to the bootm
708 command. The value of CONFIG_BOOTARGS goes into the
709 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000710
711 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk4a5c8a72003-03-06 00:02:04 +0000712 The value of these goes into the environment as
713 "ramboot" and "nfsboot" respectively, and can be used
714 as a convenience, when switching between booting from
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200715 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000716
Heiko Schocher040c5c32013-11-04 14:04:59 +0100717- Bootcount:
718 CONFIG_BOOTCOUNT_LIMIT
719 Implements a mechanism for detecting a repeating reboot
720 cycle, see:
721 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
722
723 CONFIG_BOOTCOUNT_ENV
724 If no softreset save registers are found on the hardware
725 "bootcount" is stored in the environment. To prevent a
726 saveenv on all reboots, the environment variable
727 "upgrade_available" is used. If "upgrade_available" is
728 0, "bootcount" is always 0, if "upgrade_available" is
729 1 "bootcount" is incremented in the environment.
730 So the Userspace Applikation must set the "upgrade_available"
731 and "bootcount" variable to 0, if a boot was successfully.
732
wdenkc6097192002-11-03 00:24:07 +0000733- Pre-Boot Commands:
734 CONFIG_PREBOOT
735
736 When this option is #defined, the existence of the
737 environment variable "preboot" will be checked
738 immediately before starting the CONFIG_BOOTDELAY
739 countdown and/or running the auto-boot command resp.
740 entering interactive mode.
741
742 This feature is especially useful when "preboot" is
743 automatically generated or modified. For an example
744 see the LWMON board specific code: here "preboot" is
745 modified when the user holds down a certain
746 combination of keys on the (special) keyboard when
747 booting the systems
748
749- Serial Download Echo Mode:
750 CONFIG_LOADS_ECHO
751 If defined to 1, all characters received during a
752 serial download (using the "loads" command) are
753 echoed back. This might be needed by some terminal
754 emulations (like "cu"), but may as well just take
755 time on others. This setting #define's the initial
756 value of the "loads_echo" environment variable.
757
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500758- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000759 CONFIG_KGDB_BAUDRATE
760 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200761 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000762
763- Monitor Functions:
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500764 Monitor commands can be included or excluded
765 from the build by using the #include files
Stephen Warren963a7cf2012-08-05 16:07:19 +0000766 <config_cmd_all.h> and #undef'ing unwanted
Joe Hershberger5a9d7f12015-06-22 16:15:30 -0500767 commands, or adding #define's for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000768
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500769 The default command configuration includes all commands
770 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000771
Marek Vasutc4d8a1b2014-03-05 19:58:39 +0100772 CONFIG_CMD_AES AES 128 CBC encrypt/decrypt
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500773 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500774 CONFIG_CMD_BDI bdinfo
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500775 CONFIG_CMD_BOOTD bootd
Tom Rini5ce62cd2014-08-14 06:42:36 -0400776 CONFIG_CMD_BOOTI * ARM64 Linux kernel Image support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500777 CONFIG_CMD_CACHE * icache, dcache
778 CONFIG_CMD_CONSOLE coninfo
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500779 CONFIG_CMD_DHCP * DHCP support
780 CONFIG_CMD_DIAG * Diagnostics
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500781 CONFIG_CMD_ECHO echo arguments
Peter Tyser0deafa22009-10-25 15:12:56 -0500782 CONFIG_CMD_EDITENV edit env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500783 CONFIG_CMD_ELF * bootelf, bootvx
Andrew Ruder94463402013-10-22 19:07:34 -0500784 CONFIG_CMD_ENV_EXISTS * check existence of env variable
Mike Frysingerf3ddf202010-12-26 23:09:45 -0500785 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren4f8662d2012-10-22 06:43:50 +0000786 CONFIG_CMD_EXT2 * ext2 command support
787 CONFIG_CMD_EXT4 * ext4 command support
Stephen Warren3d5a3882014-01-24 20:46:37 -0700788 CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls)
789 that work for multiple fs types
Christian Gmeiner9f9eec32014-11-12 14:35:04 +0100790 CONFIG_CMD_FS_UUID * Look up a filesystem UUID
Mike Frysinger78dcaf42009-01-28 19:08:14 -0500791 CONFIG_CMD_SAVEENV saveenv
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500792 CONFIG_CMD_FLASH flinfo, erase, protect
793 CONFIG_CMD_FPGA FPGA device initialization support
Mike Frysinger2ed02412010-12-26 23:32:22 -0500794 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsf0c9d532011-04-05 07:15:14 +0000795 CONFIG_CMD_GREPENV * search environment
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500796 CONFIG_CMD_I2C * I2C serial bus support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500797 CONFIG_CMD_IMI iminfo
Vipin Kumar3df41b12012-12-16 22:32:48 +0000798 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200799 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Mike Frysingerf3ddf202010-12-26 23:09:45 -0500800 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershberger0fd32d72012-10-03 11:15:51 +0000801 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500802 CONFIG_CMD_ITEST Integer/string test of 2 values
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200803 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerb35a3a62012-05-23 08:00:12 +0000804 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
805 (169.254.*.*)
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500806 CONFIG_CMD_LOADB loadb
807 CONFIG_CMD_LOADS loads
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200808 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz93d6cb02009-07-27 00:07:59 -0400809 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glasseacd14f2012-11-30 13:01:20 +0000810 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500811 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denk9d009282013-03-08 10:51:32 +0000812 loop, loopw
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200813 CONFIG_CMD_MEMTEST * mtest
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500814 CONFIG_CMD_MISC Misc functions like sleep etc
815 CONFIG_CMD_MMC * MMC memory mapped support
816 CONFIG_CMD_MII * MII utility commands
Stefan Roeseb1423dd2009-03-19 13:30:36 +0100817 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500818 CONFIG_CMD_NAND * NAND support
819 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200820 CONFIG_CMD_NFS NFS support
Peter Tyser9902e422008-12-17 16:36:21 -0600821 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denk092ae952011-10-26 10:21:21 +0000822 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500823 CONFIG_CMD_PCI * pciinfo
824 CONFIG_CMD_PCMCIA * PCMCIA support
825 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
826 host
827 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersc889fb42012-12-05 14:46:30 +0000828 CONFIG_CMD_READ * Read raw data from partition
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500829 CONFIG_CMD_REGINFO * Register dump
830 CONFIG_CMD_RUN run command in env variable
Simon Glassbf6ce792012-12-26 09:53:36 +0000831 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500832 CONFIG_CMD_SAVES * save S record dump
Simon Glass8706b812016-05-01 11:36:02 -0600833 CONFIG_SCSI * SCSI Support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500834 CONFIG_CMD_SDRAM * print SDRAM configuration information
835 (requires CONFIG_CMD_I2C)
Eric Nelson97f5f8f2012-01-31 10:52:08 -0700836 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Bob Liua671b702013-02-05 19:05:41 +0800837 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk85c25df2009-04-01 23:34:12 +0200838 CONFIG_CMD_SOURCE "source" command Support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500839 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7aa81a42011-05-17 00:03:40 +0000840 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass6a398d22011-10-24 18:00:07 +0000841 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershberger59f3f522012-10-03 12:14:57 +0000842 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
843 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500844 CONFIG_CMD_USB * USB support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500845 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasut71729392012-03-31 07:47:16 +0000846 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200847 CONFIG_CMD_XIMG Load part of Multi Image
Przemyslaw Marczak2eb40ee2014-04-02 10:20:05 +0200848 CONFIG_CMD_UUID * Generate random UUID or GUID string
wdenkc6097192002-11-03 00:24:07 +0000849
850 EXAMPLE: If you want all functions except of network
851 support you can write:
852
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500853 #include "config_cmd_all.h"
854 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000855
Gerald Van Barend6abef42007-03-31 12:23:51 -0400856 Other Commands:
857 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000858
859 Note: Don't enable the "icache" and "dcache" commands
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500860 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk4a5c8a72003-03-06 00:02:04 +0000861 what you (and your U-Boot users) are doing. Data
Heiko Schocher65d94db2017-06-07 17:33:09 +0200862 cache cannot be enabled on systems like the
wdenk4a5c8a72003-03-06 00:02:04 +0000863 8260 (where accesses to the IMMR region must be
864 uncached), and it cannot be disabled on all other
865 systems where we (mis-) use the data cache to hold an
866 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000867
868
869 XXX - this list needs to get updated!
870
Simon Glassaa34ef22016-03-13 19:07:28 -0600871- Removal of commands
872 If no commands are needed to boot, you can disable
873 CONFIG_CMDLINE to remove them. In this case, the command line
874 will not be available, and when U-Boot wants to execute the
875 boot command (on start-up) it will call board_run_command()
876 instead. This can reduce image size significantly for very
877 simple boot procedures.
878
Wolfgang Denk2aceea12013-03-23 23:50:31 +0000879- Regular expression support:
880 CONFIG_REGEX
Wolfgang Denkec7fbf52013-10-04 17:43:24 +0200881 If this variable is defined, U-Boot is linked against
882 the SLRE (Super Light Regular Expression) library,
883 which adds regex support to some commands, as for
884 example "env grep" and "setexpr".
Wolfgang Denk2aceea12013-03-23 23:50:31 +0000885
Simon Glass3d686442011-10-15 05:48:20 +0000886- Device tree:
887 CONFIG_OF_CONTROL
888 If this variable is defined, U-Boot will use a device tree
889 to configure its devices, instead of relying on statically
890 compiled #defines in the board file. This option is
891 experimental and only available on a few boards. The device
892 tree is available in the global data as gd->fdt_blob.
893
Simon Glass5cb34db2011-10-24 19:15:31 +0000894 U-Boot needs to get its device tree from somewhere. This can
Alex Deymo5b661ec2017-04-02 01:25:20 -0700895 be done using one of the three options below:
Simon Glass38d6b8d2011-10-15 05:48:21 +0000896
897 CONFIG_OF_EMBED
898 If this variable is defined, U-Boot will embed a device tree
899 binary in its image. This device tree file should be in the
900 board directory and called <soc>-<board>.dts. The binary file
901 is then picked up in board_init_f() and made available through
902 the global data structure as gd->blob.
Simon Glass3d686442011-10-15 05:48:20 +0000903
Simon Glass5cb34db2011-10-24 19:15:31 +0000904 CONFIG_OF_SEPARATE
905 If this variable is defined, U-Boot will build a device tree
906 binary. It will be called u-boot.dtb. Architecture-specific
907 code will locate it at run-time. Generally this works by:
908
909 cat u-boot.bin u-boot.dtb >image.bin
910
911 and in fact, U-Boot does this for you, creating a file called
912 u-boot-dtb.bin which is useful in the common case. You can
913 still use the individual files if you need something more
914 exotic.
915
Alex Deymo5b661ec2017-04-02 01:25:20 -0700916 CONFIG_OF_BOARD
917 If this variable is defined, U-Boot will use the device tree
918 provided by the board at runtime instead of embedding one with
919 the image. Only boards defining board_fdt_blob_setup() support
920 this option (see include/fdtdec.h file).
921
wdenkc6097192002-11-03 00:24:07 +0000922- Watchdog:
923 CONFIG_WATCHDOG
924 If this variable is defined, it enables watchdog
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +0000925 support for the SoC. There must be support in the SoC
Heiko Schocher71cb3e92017-06-07 17:33:10 +0200926 specific code for a watchdog. When supported for a
927 specific SoC is available, then no further board specific
928 code should be needed to use it.
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +0000929
930 CONFIG_HW_WATCHDOG
931 When using a watchdog circuitry external to the used
932 SoC, then define this variable and provide board
933 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000934
Heiko Schocher735326c2015-01-21 08:38:22 +0100935 CONFIG_AT91_HW_WDT_TIMEOUT
936 specify the timeout in seconds. default 2 seconds.
937
stroeseb9c17c52003-04-04 15:53:41 +0000938- U-Boot Version:
939 CONFIG_VERSION_VARIABLE
940 If this variable is defined, an environment variable
941 named "ver" is created by U-Boot showing the U-Boot
942 version as printed by the "version" command.
Benoît Thébaudeauce9a1552012-08-13 15:01:14 +0200943 Any change to this variable will be reverted at the
944 next reset.
stroeseb9c17c52003-04-04 15:53:41 +0000945
wdenkc6097192002-11-03 00:24:07 +0000946- Real-Time Clock:
947
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500948 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000949 has to be selected, too. Define exactly one of the
950 following options:
951
wdenkc6097192002-11-03 00:24:07 +0000952 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam3f8d1782011-10-24 06:44:15 +0000953 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +0000954 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1fe2c702003-03-06 21:55:29 +0000955 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000956 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk0893c472003-05-20 14:25:27 +0000957 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel90491f22014-07-21 11:06:16 +0200958 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenkef5fe752003-03-12 10:41:04 +0000959 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krillb27939b2008-03-15 15:40:26 +0100960 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenkaeba06f2004-06-09 17:34:58 +0000961 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Chris Packham2d3ac512017-05-30 12:03:33 +1200962 CONFIG_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher1f1b7012011-03-28 09:24:22 +0200963 CONFIG_SYS_RV3029_TCR - enable trickle charger on
964 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +0000965
wdenkb9bbd242003-06-30 16:24:52 +0000966 Note that if the RTC uses I2C, then the I2C interface
967 must also be configured. See I2C Support, below.
968
Peter Tyser9902e422008-12-17 16:36:21 -0600969- GPIO Support:
970 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tyser9902e422008-12-17 16:36:21 -0600971
Chris Packham9b383202010-12-19 10:12:13 +0000972 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
973 chip-ngpio pairs that tell the PCA953X driver the number of
974 pins supported by a particular chip.
975
Peter Tyser9902e422008-12-17 16:36:21 -0600976 Note that if the GPIO device uses I2C, then the I2C interface
977 must also be configured. See I2C Support, below.
978
Simon Glass4dc47ca2014-06-11 23:29:41 -0600979- I/O tracing:
980 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
981 accesses and can checksum them or write a list of them out
982 to memory. See the 'iotrace' command for details. This is
983 useful for testing device drivers since it can confirm that
984 the driver behaves the same way before and after a code
985 change. Currently this is supported on sandbox and arm. To
986 add support for your architecture, add '#include <iotrace.h>'
987 to the bottom of arch/<arch>/include/asm/io.h and test.
988
989 Example output from the 'iotrace stats' command is below.
990 Note that if the trace buffer is exhausted, the checksum will
991 still continue to operate.
992
993 iotrace is enabled
994 Start: 10000000 (buffer start address)
995 Size: 00010000 (buffer size)
996 Offset: 00000120 (current buffer offset)
997 Output: 10000120 (start + offset)
998 Count: 00000018 (number of trace records)
999 CRC32: 9526fb66 (CRC32 of all trace records)
1000
wdenkc6097192002-11-03 00:24:07 +00001001- Timestamp Support:
1002
wdenk4a5c8a72003-03-06 00:02:04 +00001003 When CONFIG_TIMESTAMP is selected, the timestamp
1004 (date and time) of an image is printed by image
1005 commands like bootm or iminfo. This option is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001006 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001007
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001008- Partition Labels (disklabels) Supported:
1009 Zero or more of the following:
1010 CONFIG_MAC_PARTITION Apple's MacOS partition table.
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001011 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1012 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1013 bootloader. Note 2TB partition limit; see
1014 disk/part_efi.c
1015 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001016
Simon Glassb569a012017-05-17 03:25:30 -06001017 If IDE or SCSI support is enabled (CONFIG_IDE or
Simon Glass8706b812016-05-01 11:36:02 -06001018 CONFIG_SCSI) you must configure support for at
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001019 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001020
1021- IDE Reset method:
wdenk369d43d2004-03-14 14:09:05 +00001022 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1023 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001024
wdenk369d43d2004-03-14 14:09:05 +00001025 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1026 be performed by calling the function
1027 ide_set_reset(int reset)
1028 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001029
1030- ATAPI Support:
1031 CONFIG_ATAPI
1032
1033 Set this to enable ATAPI support.
1034
wdenkf602aa02004-03-13 23:29:43 +00001035- LBA48 Support
1036 CONFIG_LBA48
1037
1038 Set this to enable support for disks larger than 137GB
Heiko Schocher0f602e12009-12-03 11:21:21 +01001039 Also look at CONFIG_SYS_64BIT_LBA.
wdenkf602aa02004-03-13 23:29:43 +00001040 Whithout these , LBA48 support uses 32bit variables and will 'only'
1041 support disks up to 2.1TB.
1042
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001043 CONFIG_SYS_64BIT_LBA:
wdenkf602aa02004-03-13 23:29:43 +00001044 When enabled, makes the IDE subsystem use 64bit sector addresses.
1045 Default is 32bit.
1046
wdenkc6097192002-11-03 00:24:07 +00001047- SCSI Support:
1048 At the moment only there is only support for the
1049 SYM53C8XX SCSI controller; define
1050 CONFIG_SCSI_SYM53C8XX to enable it.
1051
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001052 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1053 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1054 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001055 maximum numbers of LUNs, SCSI ID's and target
1056 devices.
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001057 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001058
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001059 The environment variable 'scsidevs' is set to the number of
1060 SCSI devices found during the last scan.
Stefan Reinauere50a10e2012-10-29 05:23:48 +00001061
wdenkc6097192002-11-03 00:24:07 +00001062- NETWORK Support (PCI):
wdenk4e112c12003-06-03 23:54:09 +00001063 CONFIG_E1000
Kyle Moffett64b94dd2011-10-18 11:05:29 +00001064 Support for Intel 8254x/8257x gigabit chips.
1065
1066 CONFIG_E1000_SPI
1067 Utility code for direct access to the SPI bus on Intel 8257x.
1068 This does not do anything useful unless you set at least one
1069 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1070
1071 CONFIG_E1000_SPI_GENERIC
1072 Allow generic access to the SPI bus on the Intel 8257x, for
1073 example with the "sspi" command.
1074
1075 CONFIG_CMD_E1000
1076 Management command for E1000 devices. When used on devices
1077 with SPI support you can reprogram the EEPROM from U-Boot.
stroese94ef1cf2003-06-05 15:39:44 +00001078
wdenkc6097192002-11-03 00:24:07 +00001079 CONFIG_EEPRO100
1080 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001081 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001082 write routine for first time initialisation.
1083
1084 CONFIG_TULIP
1085 Support for Digital 2114x chips.
1086 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1087 modem chip initialisation (KS8761/QS6611).
1088
1089 CONFIG_NATSEMI
1090 Support for National dp83815 chips.
1091
1092 CONFIG_NS8382X
1093 Support for National dp8382[01] gigabit chips.
1094
wdenkaa603362003-05-12 21:50:16 +00001095- NETWORK Support (other):
1096
Jens Scharsigdab7cb82010-01-23 12:03:45 +01001097 CONFIG_DRIVER_AT91EMAC
1098 Support for AT91RM9200 EMAC.
1099
1100 CONFIG_RMII
1101 Define this to use reduced MII inteface
1102
1103 CONFIG_DRIVER_AT91EMAC_QUIET
1104 If this defined, the driver is quiet.
1105 The driver doen't show link status messages.
1106
Rob Herringc9830dc2011-12-15 11:15:49 +00001107 CONFIG_CALXEDA_XGMAC
1108 Support for the Calxeda XGMAC device
1109
Ashok93fb8722012-10-15 06:20:47 +00001110 CONFIG_LAN91C96
wdenkaa603362003-05-12 21:50:16 +00001111 Support for SMSC's LAN91C96 chips.
1112
wdenkaa603362003-05-12 21:50:16 +00001113 CONFIG_LAN91C96_USE_32_BIT
1114 Define this to enable 32 bit addressing
1115
Ashok93fb8722012-10-15 06:20:47 +00001116 CONFIG_SMC91111
wdenk3c711762004-06-09 13:37:52 +00001117 Support for SMSC's LAN91C111 chip
1118
1119 CONFIG_SMC91111_BASE
1120 Define this to hold the physical address
1121 of the device (I/O space)
1122
1123 CONFIG_SMC_USE_32_BIT
1124 Define this if data bus is 32 bits
1125
1126 CONFIG_SMC_USE_IOFUNCS
1127 Define this to use i/o functions instead of macros
1128 (some hardware wont work with macros)
1129
Heiko Schocher7d037f72011-11-15 10:00:04 -05001130 CONFIG_DRIVER_TI_EMAC
1131 Support for davinci emac
1132
1133 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1134 Define this if you have more then 3 PHYs.
1135
Macpaul Lin199c6252010-12-21 16:59:46 +08001136 CONFIG_FTGMAC100
1137 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1138
1139 CONFIG_FTGMAC100_EGIGA
1140 Define this to use GE link update with gigabit PHY.
1141 Define this if FTGMAC100 is connected to gigabit PHY.
1142 If your system has 10/100 PHY only, it might not occur
1143 wrong behavior. Because PHY usually return timeout or
1144 useless data when polling gigabit status and gigabit
1145 control registers. This behavior won't affect the
1146 correctnessof 10/100 link speed update.
1147
Mike Rapoportf4761af2009-11-11 10:03:03 +02001148 CONFIG_SMC911X
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001149 Support for SMSC's LAN911x and LAN921x chips
1150
Mike Rapoportf4761af2009-11-11 10:03:03 +02001151 CONFIG_SMC911X_BASE
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001152 Define this to hold the physical address
1153 of the device (I/O space)
1154
Mike Rapoportf4761af2009-11-11 10:03:03 +02001155 CONFIG_SMC911X_32_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001156 Define this if data bus is 32 bits
1157
Mike Rapoportf4761af2009-11-11 10:03:03 +02001158 CONFIG_SMC911X_16_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001159 Define this if data bus is 16 bits. If your processor
1160 automatically converts one 32 bit word to two 16 bit
Mike Rapoportf4761af2009-11-11 10:03:03 +02001161 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001162
Yoshihiro Shimodaed4cea02011-01-27 10:06:03 +09001163 CONFIG_SH_ETHER
1164 Support for Renesas on-chip Ethernet controller
1165
1166 CONFIG_SH_ETHER_USE_PORT
1167 Define the number of ports to be used
1168
1169 CONFIG_SH_ETHER_PHY_ADDR
1170 Define the ETH PHY's address
1171
Yoshihiro Shimoda281aa052011-01-27 10:06:08 +09001172 CONFIG_SH_ETHER_CACHE_WRITEBACK
1173 If this option is set, the driver enables cache flush.
1174
Heiko Schocher2b387762014-07-18 06:07:19 +02001175- PWM Support:
1176 CONFIG_PWM_IMX
Robert P. J. Day1f8378a2016-09-13 08:35:18 -04001177 Support for PWM module on the imx6.
Heiko Schocher2b387762014-07-18 06:07:19 +02001178
Vadim Bendeburydac69642011-10-17 08:36:14 +00001179- TPM Support:
Che-liang Chiouacea5702013-04-12 11:04:34 +00001180 CONFIG_TPM
1181 Support TPM devices.
1182
Christophe Ricard8759ff82015-10-06 22:54:41 +02001183 CONFIG_TPM_TIS_INFINEON
1184 Support for Infineon i2c bus TPM devices. Only one device
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001185 per system is supported at this time.
1186
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001187 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1188 Define the burst count bytes upper limit
1189
Christophe Ricard88249232016-01-21 23:27:13 +01001190 CONFIG_TPM_ST33ZP24
1191 Support for STMicroelectronics TPM devices. Requires DM_TPM support.
1192
1193 CONFIG_TPM_ST33ZP24_I2C
1194 Support for STMicroelectronics ST33ZP24 I2C devices.
1195 Requires TPM_ST33ZP24 and I2C.
1196
Christophe Ricard5ffadc32016-01-21 23:27:14 +01001197 CONFIG_TPM_ST33ZP24_SPI
1198 Support for STMicroelectronics ST33ZP24 SPI devices.
1199 Requires TPM_ST33ZP24 and SPI.
1200
Dirk Eibach20489092013-06-26 15:55:15 +02001201 CONFIG_TPM_ATMEL_TWI
1202 Support for Atmel TWI TPM device. Requires I2C support.
1203
Che-liang Chiouacea5702013-04-12 11:04:34 +00001204 CONFIG_TPM_TIS_LPC
Vadim Bendeburydac69642011-10-17 08:36:14 +00001205 Support for generic parallel port TPM devices. Only one device
1206 per system is supported at this time.
1207
1208 CONFIG_TPM_TIS_BASE_ADDRESS
1209 Base address where the generic TPM device is mapped
1210 to. Contemporary x86 systems usually map it at
1211 0xfed40000.
1212
Reinhard Pfau4fece432013-06-26 15:55:13 +02001213 CONFIG_CMD_TPM
1214 Add tpm monitor functions.
1215 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1216 provides monitor access to authorized functions.
1217
1218 CONFIG_TPM
1219 Define this to enable the TPM support library which provides
1220 functional interfaces to some TPM commands.
1221 Requires support for a TPM device.
1222
1223 CONFIG_TPM_AUTH_SESSIONS
1224 Define this to enable authorized functions in the TPM library.
1225 Requires CONFIG_TPM and CONFIG_SHA1.
1226
wdenkc6097192002-11-03 00:24:07 +00001227- USB Support:
1228 At the moment only the UHCI host controller is
Heiko Schocher6f90e582017-06-14 05:49:40 +02001229 supported (PIP405, MIP405); define
wdenkc6097192002-11-03 00:24:07 +00001230 CONFIG_USB_UHCI to enable it.
1231 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenkfb30b4c2004-10-09 22:44:59 +00001232 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001233 storage devices.
1234 Note:
1235 Supported are USB Keyboards and USB Floppy drives
1236 (TEAC FD-05PUB).
wdenk369d43d2004-03-14 14:09:05 +00001237
Simon Glass5978cdb2012-02-27 10:52:47 +00001238 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1239 txfilltuning field in the EHCI controller on reset.
1240
Oleksandr Tymoshenko7a881752014-02-01 21:51:25 -07001241 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1242 HW module registers.
1243
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001244- USB Device:
1245 Define the below if you wish to use the USB console.
1246 Once firmware is rebuilt from a serial console issue the
1247 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001248 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001249 it has found a new device. The environment variable usbtty
1250 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denke2601822006-06-14 18:14:56 +02001251 appear to a USB host as a Linux gserial device or a
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001252 Common Device Class Abstract Control Model serial device.
1253 If you select usbtty = gserial you should be able to enumerate
1254 a Linux host by
1255 # modprobe usbserial vendor=0xVendorID product=0xProductID
1256 else if using cdc_acm, simply setting the environment
1257 variable usbtty to be cdc_acm should suffice. The following
1258 might be defined in YourBoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001259
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001260 CONFIG_USB_DEVICE
1261 Define this to build a UDC device
1262
1263 CONFIG_USB_TTY
1264 Define this to have a tty type of device available to
1265 talk to the UDC device
Wolfgang Denke2601822006-06-14 18:14:56 +02001266
Vipin KUMARbdb17702012-03-26 15:38:06 +05301267 CONFIG_USBD_HS
1268 Define this to enable the high speed support for usb
1269 device and usbtty. If this feature is enabled, a routine
1270 int is_usbd_high_speed(void)
1271 also needs to be defined by the driver to dynamically poll
1272 whether the enumeration has succeded at high speed or full
1273 speed.
1274
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001275 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001276 Define this if you want stdin, stdout &/or stderr to
1277 be set to usbtty.
1278
Wolfgang Denke2601822006-06-14 18:14:56 +02001279 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001280 define your own vendor specific values either in BoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001281 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001282 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1283 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1284 should pretend to be a Linux device to it's target host.
1285
1286 CONFIG_USBD_MANUFACTURER
1287 Define this string as the name of your company for
1288 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denke2601822006-06-14 18:14:56 +02001289
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001290 CONFIG_USBD_PRODUCT_NAME
1291 Define this string as the name of your product
1292 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
wdenkc6097192002-11-03 00:24:07 +00001293
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001294 CONFIG_USBD_VENDORID
1295 Define this as your assigned Vendor ID from the USB
1296 Implementors Forum. This *must* be a genuine Vendor ID
1297 to avoid polluting the USB namespace.
1298 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001299
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001300 CONFIG_USBD_PRODUCTID
1301 Define this as the unique Product ID
1302 for your device
1303 - CONFIG_USBD_PRODUCTID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001304
Igor Grinbergac5f6ee2011-12-12 12:08:35 +02001305- ULPI Layer Support:
1306 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1307 the generic ULPI layer. The generic layer accesses the ULPI PHY
1308 via the platform viewport, so you need both the genric layer and
1309 the viewport enabled. Currently only Chipidea/ARC based
1310 viewport is supported.
1311 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1312 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stachf31e4112012-10-01 00:44:35 +02001313 If your ULPI phy needs a different reference clock than the
1314 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1315 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001316
wdenk7a428cc2003-06-15 22:40:42 +00001317- MMC Support:
wdenk57b2d802003-06-27 21:31:46 +00001318 The MMC controller on the Intel PXA is supported. To
1319 enable this define CONFIG_MMC. The MMC can be
1320 accessed from the boot prompt by mapping the device
wdenk7a428cc2003-06-15 22:40:42 +00001321 to physical memory similar to flash. Command line is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001322 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1323 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenk7a428cc2003-06-15 22:40:42 +00001324
Yoshihiro Shimodadb7717b2011-07-04 22:21:22 +00001325 CONFIG_SH_MMCIF
1326 Support for Renesas on-chip MMCIF controller
1327
1328 CONFIG_SH_MMCIF_ADDR
1329 Define the base address of MMCIF registers
1330
1331 CONFIG_SH_MMCIF_CLK
1332 Define the clock frequency for MMCIF
1333
Pierre Aubertbcc302c2014-04-24 10:30:08 +02001334 CONFIG_SUPPORT_EMMC_BOOT
1335 Enable some additional features of the eMMC boot partitions.
1336
1337 CONFIG_SUPPORT_EMMC_RPMB
1338 Enable the commands for reading, writing and programming the
1339 key for the Replay Protection Memory Block partition in eMMC.
1340
Tom Rini58a8d322013-03-14 05:32:47 +00001341- USB Device Firmware Update (DFU) class support:
Paul Kocialkowski045d6052015-06-12 19:56:58 +02001342 CONFIG_USB_FUNCTION_DFU
Tom Rini58a8d322013-03-14 05:32:47 +00001343 This enables the USB portion of the DFU USB class
1344
1345 CONFIG_CMD_DFU
1346 This enables the command "dfu" which is used to have
1347 U-Boot create a DFU class device via USB. This command
1348 requires that the "dfu_alt_info" environment variable be
1349 set and define the alt settings to expose to the host.
1350
1351 CONFIG_DFU_MMC
1352 This enables support for exposing (e)MMC devices via DFU.
1353
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +00001354 CONFIG_DFU_NAND
1355 This enables support for exposing NAND devices via DFU.
1356
Afzal Mohammede3c687a2013-09-18 01:15:24 +05301357 CONFIG_DFU_RAM
1358 This enables support for exposing RAM via DFU.
1359 Note: DFU spec refer to non-volatile memory usage, but
1360 allow usages beyond the scope of spec - here RAM usage,
1361 one that would help mostly the developer.
1362
Heiko Schochera2f831e2013-06-12 06:05:51 +02001363 CONFIG_SYS_DFU_DATA_BUF_SIZE
1364 Dfu transfer uses a buffer before writing data to the
1365 raw storage device. Make the size (in bytes) of this buffer
1366 configurable. The size of this buffer is also configurable
1367 through the "dfu_bufsiz" environment variable.
1368
Pantelis Antonioua6e788d2013-03-14 05:32:48 +00001369 CONFIG_SYS_DFU_MAX_FILE_SIZE
1370 When updating files rather than the raw storage device,
1371 we use a static buffer to copy the file into and then write
1372 the buffer once we've been given the whole file. Define
1373 this to the maximum filesize (in bytes) for the buffer.
1374 Default is 4 MiB if undefined.
1375
Heiko Schochere1ba1512014-03-18 08:09:56 +01001376 DFU_DEFAULT_POLL_TIMEOUT
1377 Poll timeout [ms], is the timeout a device can send to the
1378 host. The host must wait for this timeout before sending
1379 a subsequent DFU_GET_STATUS request to the device.
1380
1381 DFU_MANIFEST_POLL_TIMEOUT
1382 Poll timeout [ms], which the device sends to the host when
1383 entering dfuMANIFEST state. Host waits this timeout, before
1384 sending again an USB request to the device.
1385
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001386- USB Device Android Fastboot support:
Paul Kocialkowskid55acc02015-06-12 19:56:59 +02001387 CONFIG_USB_FUNCTION_FASTBOOT
1388 This enables the USB part of the fastboot gadget
1389
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001390 CONFIG_CMD_FASTBOOT
1391 This enables the command "fastboot" which enables the Android
1392 fastboot mode for the platform's USB device. Fastboot is a USB
1393 protocol for downloading images, flashing and device control
1394 used on Android devices.
1395 See doc/README.android-fastboot for more information.
1396
1397 CONFIG_ANDROID_BOOT_IMAGE
1398 This enables support for booting images which use the Android
1399 image format header.
1400
Paul Kocialkowskif84f0912015-07-20 12:38:22 +02001401 CONFIG_FASTBOOT_BUF_ADDR
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001402 The fastboot protocol requires a large memory buffer for
1403 downloads. Define this to the starting RAM address to use for
1404 downloaded images.
1405
Paul Kocialkowskif84f0912015-07-20 12:38:22 +02001406 CONFIG_FASTBOOT_BUF_SIZE
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001407 The fastboot protocol requires a large memory buffer for
1408 downloads. This buffer should be as large as possible for a
1409 platform. Define this to the size available RAM for fastboot.
1410
Steve Raebfb9ba42014-08-26 11:47:28 -07001411 CONFIG_FASTBOOT_FLASH
1412 The fastboot protocol includes a "flash" command for writing
1413 the downloaded image to a non-volatile storage device. Define
1414 this to enable the "fastboot flash" command.
1415
1416 CONFIG_FASTBOOT_FLASH_MMC_DEV
1417 The fastboot "flash" command requires additional information
1418 regarding the non-volatile storage device. Define this to
1419 the eMMC device that fastboot should use to store the image.
1420
Steve Rae7d059342014-12-12 15:51:54 -08001421 CONFIG_FASTBOOT_GPT_NAME
1422 The fastboot "flash" command supports writing the downloaded
1423 image to the Protective MBR and the Primary GUID Partition
1424 Table. (Additionally, this downloaded image is post-processed
1425 to generate and write the Backup GUID Partition Table.)
1426 This occurs when the specified "partition name" on the
1427 "fastboot flash" command line matches this value.
Petr Kulhavy4ed1eca2016-09-09 10:27:18 +02001428 The default is "gpt" if undefined.
Steve Rae7d059342014-12-12 15:51:54 -08001429
Petr Kulhavy9f174c92016-09-09 10:27:16 +02001430 CONFIG_FASTBOOT_MBR_NAME
1431 The fastboot "flash" command supports writing the downloaded
1432 image to DOS MBR.
1433 This occurs when the "partition name" specified on the
1434 "fastboot flash" command line matches this value.
1435 If not defined the default value "mbr" is used.
1436
wdenkda04a8b2004-08-02 23:22:59 +00001437- Journaling Flash filesystem support:
Simon Glassfa8527b2016-10-02 18:00:59 -06001438 CONFIG_JFFS2_NAND
wdenkda04a8b2004-08-02 23:22:59 +00001439 Define these for a default partition on a NAND device
1440
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001441 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1442 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenkda04a8b2004-08-02 23:22:59 +00001443 Define these for a default partition on a NOR device
1444
wdenkc6097192002-11-03 00:24:07 +00001445- Keyboard Support:
Simon Glasseaba37e2015-11-11 10:05:47 -07001446 See Kconfig help for available keyboard drivers.
1447
1448 CONFIG_KEYBOARD
1449
1450 Define this to enable a custom keyboard support.
1451 This simply calls drv_keyboard_init() which must be
1452 defined in your board-specific files. This option is deprecated
1453 and is only used by novena. For new boards, use driver model
1454 instead.
wdenkc6097192002-11-03 00:24:07 +00001455
1456- Video support:
Timur Tabi020edd22011-02-15 17:09:19 -06001457 CONFIG_FSL_DIU_FB
Wolfgang Denk825223d2011-09-11 21:24:09 +02001458 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi020edd22011-02-15 17:09:19 -06001459 SOCs that have a DIU should define this macro to enable DIU
1460 support, and should also define these other macros:
1461
1462 CONFIG_SYS_DIU_ADDR
1463 CONFIG_VIDEO
Timur Tabi020edd22011-02-15 17:09:19 -06001464 CONFIG_CFB_CONSOLE
1465 CONFIG_VIDEO_SW_CURSOR
1466 CONFIG_VGA_AS_SINGLE_DEVICE
1467 CONFIG_VIDEO_LOGO
1468 CONFIG_VIDEO_BMP_LOGO
1469
Timur Tabi32f709e2011-04-11 14:18:22 -05001470 The DIU driver will look for the 'video-mode' environment
1471 variable, and if defined, enable the DIU as a console during
Fabio Estevamd3ad5e52016-04-02 11:53:18 -03001472 boot. See the documentation file doc/README.video for a
Timur Tabi32f709e2011-04-11 14:18:22 -05001473 description of this variable.
Timur Tabi020edd22011-02-15 17:09:19 -06001474
wdenkc6097192002-11-03 00:24:07 +00001475- LCD Support: CONFIG_LCD
1476
1477 Define this to enable LCD support (for output to LCD
1478 display); also select one of the supported displays
1479 by defining one of these:
1480
Stelian Popf6f86652008-05-09 21:57:18 +02001481 CONFIG_ATMEL_LCD:
1482
1483 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1484
wdenkc0d54ae2003-11-25 16:55:19 +00001485 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001486
wdenkc0d54ae2003-11-25 16:55:19 +00001487 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001488
wdenkc0d54ae2003-11-25 16:55:19 +00001489 CONFIG_NEC_NL6448BC20
1490
1491 NEC NL6448BC20-08. 6.5", 640x480.
1492 Active, color, single scan.
1493
1494 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +00001495
wdenkc0d54ae2003-11-25 16:55:19 +00001496 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001497 Active, color, single scan.
1498
1499 CONFIG_SHARP_16x9
1500
1501 Sharp 320x240. Active, color, single scan.
1502 It isn't 16x9, and I am not sure what it is.
1503
1504 CONFIG_SHARP_LQ64D341
1505
1506 Sharp LQ64D341 display, 640x480.
1507 Active, color, single scan.
1508
1509 CONFIG_HLD1045
1510
1511 HLD1045 display, 640x480.
1512 Active, color, single scan.
1513
1514 CONFIG_OPTREX_BW
1515
1516 Optrex CBL50840-2 NF-FW 99 22 M5
1517 or
1518 Hitachi LMG6912RPFC-00T
1519 or
1520 Hitachi SP14Q002
1521
1522 320x240. Black & white.
1523
Simon Glass599a4df2012-10-17 13:24:54 +00001524 CONFIG_LCD_ALIGNMENT
1525
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001526 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass599a4df2012-10-17 13:24:54 +00001527 defined then the LCD will be aligned to this value instead.
1528 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1529 here, since it is cheaper to change data cache settings on
1530 a per-section basis.
1531
1532
Hannes Petermaiera3c8e862015-03-27 08:01:38 +01001533 CONFIG_LCD_ROTATION
1534
1535 Sometimes, for example if the display is mounted in portrait
1536 mode or even if it's mounted landscape but rotated by 180degree,
1537 we need to rotate our content of the display relative to the
1538 framebuffer, so that user can read the messages which are
1539 printed out.
1540 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1541 initialized with a given rotation from "vl_rot" out of
1542 "vidinfo_t" which is provided by the board specific code.
1543 The value for vl_rot is coded as following (matching to
1544 fbcon=rotate:<n> linux-kernel commandline):
1545 0 = no rotation respectively 0 degree
1546 1 = 90 degree rotation
1547 2 = 180 degree rotation
1548 3 = 270 degree rotation
1549
1550 If CONFIG_LCD_ROTATION is not defined, the console will be
1551 initialized with 0degree rotation.
1552
Tom Wai-Hong Tam79926a42012-09-28 15:11:16 +00001553 CONFIG_LCD_BMP_RLE8
1554
1555 Support drawing of RLE8-compressed bitmaps on the LCD.
1556
Tom Wai-Hong Tam6664f202012-12-05 14:46:40 +00001557 CONFIG_I2C_EDID
1558
1559 Enables an 'i2c edid' command which can read EDID
1560 information over I2C from an attached LCD display.
1561
wdenkeb20ad32003-09-05 23:19:14 +00001562- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenk92bbe3f2003-04-20 14:04:18 +00001563
wdenk57b2d802003-06-27 21:31:46 +00001564 If this option is set, the environment is checked for
1565 a variable "splashimage". If found, the usual display
1566 of logo, copyright and system information on the LCD
wdenk01686632004-06-30 22:59:18 +00001567 is suppressed and the BMP image at the address
wdenk57b2d802003-06-27 21:31:46 +00001568 specified in "splashimage" is loaded instead. The
1569 console is redirected to the "nulldev", too. This
1570 allows for a "silent" boot where a splash screen is
1571 loaded very quickly after power-on.
wdenk92bbe3f2003-04-20 14:04:18 +00001572
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001573 CONFIG_SPLASHIMAGE_GUARD
1574
1575 If this option is set, then U-Boot will prevent the environment
1576 variable "splashimage" from being set to a problematic address
Fabio Estevama58b4912016-03-23 12:46:12 -03001577 (see doc/README.displaying-bmps).
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001578 This option is useful for targets where, due to alignment
1579 restrictions, an improperly aligned BMP image will cause a data
1580 abort. If you think you will not have problems with unaligned
1581 accesses (for example because your toolchain prevents them)
1582 there is no need to set this option.
1583
Matthias Weisser53884182009-07-09 16:07:30 +02001584 CONFIG_SPLASH_SCREEN_ALIGN
1585
1586 If this option is set the splash image can be freely positioned
1587 on the screen. Environment variable "splashpos" specifies the
1588 position as "x,y". If a positive number is given it is used as
1589 number of pixel from left/top. If a negative number is given it
1590 is used as number of pixel from right/bottom. You can also
1591 specify 'm' for centering the image.
1592
1593 Example:
1594 setenv splashpos m,m
1595 => image at center of screen
1596
1597 setenv splashpos 30,20
1598 => image at x = 30 and y = 20
1599
1600 setenv splashpos -10,m
1601 => vertically centered image
1602 at x = dspWidth - bmpWidth - 9
1603
Stefan Roesed9d97742005-09-22 09:04:17 +02001604- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1605
1606 If this option is set, additionally to standard BMP
1607 images, gzipped BMP images can be displayed via the
1608 splashscreen support or the bmp command.
1609
Anatolij Gustschin6b4e4fc2010-03-15 14:50:25 +01001610- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1611
1612 If this option is set, 8-bit RLE compressed BMP images
1613 can be displayed via the splashscreen support or the
1614 bmp command.
1615
wdenk710e3502003-08-29 20:57:53 +00001616- Compression support:
Kees Cook5b06e642013-08-16 07:59:12 -07001617 CONFIG_GZIP
1618
1619 Enabled by default to support gzip compressed images.
1620
wdenk710e3502003-08-29 20:57:53 +00001621 CONFIG_BZIP2
1622
1623 If this option is set, support for bzip2 compressed
1624 images is included. If not, only uncompressed and gzip
1625 compressed images are supported.
1626
wdenk9c53f402003-10-15 23:53:47 +00001627 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001628 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk9c53f402003-10-15 23:53:47 +00001629 be at least 4MB.
wdenk92bbe3f2003-04-20 14:04:18 +00001630
Kees Cook5b06e642013-08-16 07:59:12 -07001631 CONFIG_LZO
1632
1633 If this option is set, support for LZO compressed images
1634 is included.
1635
wdenk0e2bd9c2004-06-06 21:51:03 +00001636- MII/PHY support:
1637 CONFIG_PHY_ADDR
1638
1639 The address of PHY on MII bus.
1640
1641 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1642
1643 The clock frequency of the MII bus
1644
1645 CONFIG_PHY_GIGE
1646
1647 If this option is set, support for speed/duplex
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001648 detection of gigabit PHY is included.
wdenk0e2bd9c2004-06-06 21:51:03 +00001649
1650 CONFIG_PHY_RESET_DELAY
1651
1652 Some PHY like Intel LXT971A need extra delay after
1653 reset before any MII register access is possible.
1654 For such PHY, set this option to the usec delay
1655 required. (minimum 300usec for LXT971A)
1656
1657 CONFIG_PHY_CMD_DELAY (ppc4xx)
1658
1659 Some PHY like Intel LXT971A need extra delay after
1660 command issued before MII status register can be read
1661
wdenkc6097192002-11-03 00:24:07 +00001662- IP address:
1663 CONFIG_IPADDR
1664
1665 Define a default value for the IP address to use for
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001666 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001667 determined through e.g. bootp.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001668 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001669
1670- Server IP address:
1671 CONFIG_SERVERIP
1672
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001673 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001674 server to contact when using the "tftboot" command.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001675 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001676
Robin Getz470a6d42009-07-21 12:15:28 -04001677 CONFIG_KEEP_SERVERADDR
1678
1679 Keeps the server's MAC address, in the env 'serveraddr'
1680 for passing to bootargs (like Linux's netconsole option)
1681
Wolfgang Denk26da2992011-10-26 10:21:22 +00001682- Gateway IP address:
1683 CONFIG_GATEWAYIP
1684
1685 Defines a default value for the IP address of the
1686 default router where packets to other networks are
1687 sent to.
1688 (Environment variable "gatewayip")
1689
1690- Subnet mask:
1691 CONFIG_NETMASK
1692
1693 Defines a default value for the subnet mask (or
1694 routing prefix) which is used to determine if an IP
1695 address belongs to the local subnet or needs to be
1696 forwarded through a router.
1697 (Environment variable "netmask")
1698
David Updegraff7280da72007-06-11 10:41:07 -05001699- Multicast TFTP Mode:
1700 CONFIG_MCAST_TFTP
1701
1702 Defines whether you want to support multicast TFTP as per
1703 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001704 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff7280da72007-06-11 10:41:07 -05001705 driver in use must provide a function: mcast() to join/leave a
1706 multicast group.
1707
wdenkc6097192002-11-03 00:24:07 +00001708- BOOTP Recovery Mode:
1709 CONFIG_BOOTP_RANDOM_DELAY
1710
1711 If you have many targets in a network that try to
1712 boot using BOOTP, you may want to avoid that all
1713 systems send out BOOTP requests at precisely the same
1714 moment (which would happen for instance at recovery
1715 from a power failure, when all systems will try to
1716 boot, thus flooding the BOOTP server. Defining
1717 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1718 inserted before sending out BOOTP requests. The
Wolfgang Denkb65aaf92007-08-06 23:21:05 +02001719 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001720
1721 1st BOOTP request: delay 0 ... 1 sec
1722 2nd BOOTP request: delay 0 ... 2 sec
1723 3rd BOOTP request: delay 0 ... 4 sec
1724 4th and following
1725 BOOTP requests: delay 0 ... 8 sec
1726
Thierry Reding8977cda2014-08-19 10:21:24 +02001727 CONFIG_BOOTP_ID_CACHE_SIZE
1728
1729 BOOTP packets are uniquely identified using a 32-bit ID. The
1730 server will copy the ID from client requests to responses and
1731 U-Boot will use this to determine if it is the destination of
1732 an incoming response. Some servers will check that addresses
1733 aren't in use before handing them out (usually using an ARP
1734 ping) and therefore take up to a few hundred milliseconds to
1735 respond. Network congestion may also influence the time it
1736 takes for a response to make it back to the client. If that
1737 time is too long, U-Boot will retransmit requests. In order
1738 to allow earlier responses to still be accepted after these
1739 retransmissions, U-Boot's BOOTP client keeps a small cache of
1740 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
1741 cache. The default is to keep IDs for up to four outstanding
1742 requests. Increasing this will allow U-Boot to accept offers
1743 from a BOOTP client in networks with unusually high latency.
1744
stroesee0aadfb2003-08-28 14:17:32 +00001745- DHCP Advanced Options:
Jon Loeliger5336a762007-07-09 22:08:34 -05001746 You can fine tune the DHCP functionality by defining
1747 CONFIG_BOOTP_* symbols:
stroesee0aadfb2003-08-28 14:17:32 +00001748
Jon Loeliger5336a762007-07-09 22:08:34 -05001749 CONFIG_BOOTP_SUBNETMASK
1750 CONFIG_BOOTP_GATEWAY
1751 CONFIG_BOOTP_HOSTNAME
1752 CONFIG_BOOTP_NISDOMAIN
1753 CONFIG_BOOTP_BOOTPATH
1754 CONFIG_BOOTP_BOOTFILESIZE
1755 CONFIG_BOOTP_DNS
1756 CONFIG_BOOTP_DNS2
1757 CONFIG_BOOTP_SEND_HOSTNAME
1758 CONFIG_BOOTP_NTPSERVER
1759 CONFIG_BOOTP_TIMEOFFSET
1760 CONFIG_BOOTP_VENDOREX
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001761 CONFIG_BOOTP_MAY_FAIL
stroesee0aadfb2003-08-28 14:17:32 +00001762
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001763 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1764 environment variable, not the BOOTP server.
stroesee0aadfb2003-08-28 14:17:32 +00001765
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001766 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1767 after the configured retry count, the call will fail
1768 instead of starting over. This can be used to fail over
1769 to Link-local IP address configuration if the DHCP server
1770 is not available.
1771
stroesee0aadfb2003-08-28 14:17:32 +00001772 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1773 serverip from a DHCP server, it is possible that more
1774 than one DNS serverip is offered to the client.
1775 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1776 serverip will be stored in the additional environment
1777 variable "dnsip2". The first DNS serverip is always
1778 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger5336a762007-07-09 22:08:34 -05001779 is defined.
stroesee0aadfb2003-08-28 14:17:32 +00001780
1781 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1782 to do a dynamic update of a DNS server. To do this, they
1783 need the hostname of the DHCP requester.
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001784 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger5336a762007-07-09 22:08:34 -05001785 of the "hostname" environment variable is passed as
1786 option 12 to the DHCP server.
stroesee0aadfb2003-08-28 14:17:32 +00001787
Aras Vaichas72aa3f32008-03-26 09:43:57 +11001788 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1789
1790 A 32bit value in microseconds for a delay between
1791 receiving a "DHCP Offer" and sending the "DHCP Request".
1792 This fixes a problem with certain DHCP servers that don't
1793 respond 100% of the time to a "DHCP request". E.g. On an
1794 AT91RM9200 processor running at 180MHz, this delay needed
1795 to be *at least* 15,000 usec before a Windows Server 2003
1796 DHCP server would reply 100% of the time. I recommend at
1797 least 50,000 usec to be safe. The alternative is to hope
1798 that one of the retries will be successful but note that
1799 the DHCP timeout and retry process takes a longer than
1800 this delay.
1801
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00001802 - Link-local IP address negotiation:
1803 Negotiate with other link-local clients on the local network
1804 for an address that doesn't require explicit configuration.
1805 This is especially useful if a DHCP server cannot be guaranteed
1806 to exist in all environments that the device must operate.
1807
1808 See doc/README.link-local for more information.
1809
wdenk145d2c12004-04-15 21:48:45 +00001810 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00001811 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00001812
1813 The device id used in CDP trigger frames.
1814
1815 CONFIG_CDP_DEVICE_ID_PREFIX
1816
1817 A two character string which is prefixed to the MAC address
1818 of the device.
1819
1820 CONFIG_CDP_PORT_ID
1821
1822 A printf format string which contains the ascii name of
1823 the port. Normally is set to "eth%d" which sets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001824 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-04-15 21:48:45 +00001825
1826 CONFIG_CDP_CAPABILITIES
1827
1828 A 32bit integer which indicates the device capabilities;
1829 0x00000010 for a normal host which does not forwards.
1830
1831 CONFIG_CDP_VERSION
1832
1833 An ascii string containing the version of the software.
1834
1835 CONFIG_CDP_PLATFORM
1836
1837 An ascii string containing the name of the platform.
1838
1839 CONFIG_CDP_TRIGGER
1840
1841 A 32bit integer sent on the trigger.
1842
1843 CONFIG_CDP_POWER_CONSUMPTION
1844
1845 A 16bit integer containing the power consumption of the
1846 device in .1 of milliwatts.
1847
1848 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1849
1850 A byte containing the id of the VLAN.
1851
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001852- Status LED: CONFIG_LED_STATUS
wdenkc6097192002-11-03 00:24:07 +00001853
1854 Several configurations allow to display the current
1855 status using a LED. For instance, the LED will blink
1856 fast while running U-Boot code, stop blinking as
1857 soon as a reply to a BOOTP request was received, and
1858 start blinking slow once the Linux kernel is running
1859 (supported by a status LED driver in the Linux
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001860 kernel). Defining CONFIG_LED_STATUS enables this
wdenkc6097192002-11-03 00:24:07 +00001861 feature in U-Boot.
1862
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001863 Additional options:
1864
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001865 CONFIG_LED_STATUS_GPIO
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001866 The status LED can be connected to a GPIO pin.
1867 In such cases, the gpio_led driver can be used as a
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001868 status LED backend implementation. Define CONFIG_LED_STATUS_GPIO
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001869 to include the gpio_led driver in the U-Boot binary.
1870
Igor Grinberg203bd9f2013-11-08 01:03:52 +02001871 CONFIG_GPIO_LED_INVERTED_TABLE
1872 Some GPIO connected LEDs may have inverted polarity in which
1873 case the GPIO high value corresponds to LED off state and
1874 GPIO low value corresponds to LED on state.
1875 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
1876 with a list of GPIO LEDs that have inverted polarity.
1877
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001878- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00001879
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001880 This enable the NEW i2c subsystem, and will allow you to use
1881 i2c commands at the u-boot command line (as long as you set
1882 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
1883 based realtime clock chips or other i2c devices. See
1884 common/cmd_i2c.c for a description of the command line
1885 interface.
1886
1887 ported i2c driver to the new framework:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01001888 - drivers/i2c/soft_i2c.c:
1889 - activate first bus with CONFIG_SYS_I2C_SOFT define
1890 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
1891 for defining speed and slave address
1892 - activate second bus with I2C_SOFT_DECLARATIONS2 define
1893 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
1894 for defining speed and slave address
1895 - activate third bus with I2C_SOFT_DECLARATIONS3 define
1896 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
1897 for defining speed and slave address
1898 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
1899 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
1900 for defining speed and slave address
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001901
Heiko Schocherf2850742012-10-24 13:48:22 +02001902 - drivers/i2c/fsl_i2c.c:
1903 - activate i2c driver with CONFIG_SYS_I2C_FSL
1904 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
1905 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
1906 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
1907 bus.
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001908 - If your board supports a second fsl i2c bus, define
Heiko Schocherf2850742012-10-24 13:48:22 +02001909 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
1910 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
1911 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
1912 second bus.
1913
Simon Glass026fefb2012-10-30 07:28:53 +00001914 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu045acfa2013-10-11 16:23:53 +09001915 - activate this driver with CONFIG_SYS_I2C_TEGRA
1916 - This driver adds 4 i2c buses with a fix speed from
1917 100000 and the slave addr 0!
Simon Glass026fefb2012-10-30 07:28:53 +00001918
Dirk Eibach42b204f2013-04-25 02:40:01 +00001919 - drivers/i2c/ppc4xx_i2c.c
1920 - activate this driver with CONFIG_SYS_I2C_PPC4XX
1921 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
1922 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
1923
trema49f40a2013-09-21 18:13:35 +02001924 - drivers/i2c/i2c_mxc.c
1925 - activate this driver with CONFIG_SYS_I2C_MXC
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02001926 - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
1927 - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
1928 - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
1929 - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
trema49f40a2013-09-21 18:13:35 +02001930 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
1931 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
1932 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
1933 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
1934 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
1935 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02001936 - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
1937 - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001938 If those defines are not set, default value is 100000
trema49f40a2013-09-21 18:13:35 +02001939 for speed, and 0 for slave.
1940
Nobuhiro Iwamatsue94ea2f2013-09-27 16:58:30 +09001941 - drivers/i2c/rcar_i2c.c:
1942 - activate this driver with CONFIG_SYS_I2C_RCAR
1943 - This driver adds 4 i2c buses
1944
1945 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
1946 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
1947 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
1948 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
1949 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
1950 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
1951 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
1952 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
1953 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
1954
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09001955 - drivers/i2c/sh_i2c.c:
1956 - activate this driver with CONFIG_SYS_I2C_SH
1957 - This driver adds from 2 to 5 i2c buses
1958
1959 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
1960 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
1961 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
1962 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
1963 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
1964 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
1965 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
1966 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
1967 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
1968 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001969 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09001970
Heiko Schocherf53f2b82013-10-22 11:03:18 +02001971 - drivers/i2c/omap24xx_i2c.c
1972 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
1973 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
1974 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
1975 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
1976 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
1977 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
1978 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
1979 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
1980 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
1981 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
1982 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
1983
Heiko Schocher465819a2013-11-08 07:30:53 +01001984 - drivers/i2c/zynq_i2c.c
1985 - activate this driver with CONFIG_SYS_I2C_ZYNQ
1986 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
1987 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
1988
Naveen Krishna Ch5d5efd32013-12-06 12:12:38 +05301989 - drivers/i2c/s3c24x0_i2c.c:
1990 - activate this driver with CONFIG_SYS_I2C_S3C24X0
1991 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
1992 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
1993 with a fix speed from 100000 and the slave addr 0!
1994
Dirk Eibachb9577432014-07-03 09:28:18 +02001995 - drivers/i2c/ihs_i2c.c
1996 - activate this driver with CONFIG_SYS_I2C_IHS
1997 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
1998 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
1999 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2000 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2001 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2002 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2003 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2004 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2005 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2006 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2007 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2008 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
Dirk Eibach9ac33852015-10-28 11:46:22 +01002009 - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
2010 - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
2011 - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
2012 - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
2013 - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
2014 - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
2015 - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
2016 - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
2017 - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
Dirk Eibachb9577432014-07-03 09:28:18 +02002018
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002019 additional defines:
2020
2021 CONFIG_SYS_NUM_I2C_BUSES
Simon Glassb05e2b32016-10-02 18:01:05 -06002022 Hold the number of i2c buses you want to use.
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002023
2024 CONFIG_SYS_I2C_DIRECT_BUS
2025 define this, if you don't use i2c muxes on your hardware.
2026 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2027 omit this define.
2028
2029 CONFIG_SYS_I2C_MAX_HOPS
2030 define how many muxes are maximal consecutively connected
2031 on one i2c bus. If you not use i2c muxes, omit this
2032 define.
2033
2034 CONFIG_SYS_I2C_BUSES
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002035 hold a list of buses you want to use, only used if
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002036 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2037 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2038 CONFIG_SYS_NUM_I2C_BUSES = 9:
2039
2040 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2041 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2042 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2043 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2044 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2045 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2046 {1, {I2C_NULL_HOP}}, \
2047 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2048 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2049 }
2050
2051 which defines
2052 bus 0 on adapter 0 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002053 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2054 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2055 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2056 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2057 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002058 bus 6 on adapter 1 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002059 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2060 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002061
2062 If you do not have i2c muxes on your board, omit this define.
2063
Simon Glass3efce392017-05-12 21:10:00 -06002064- Legacy I2C Support:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002065 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb9bbd242003-06-30 16:24:52 +00002066 then the following macros need to be defined (examples are
2067 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002068
2069 I2C_INIT
2070
wdenkb9bbd242003-06-30 16:24:52 +00002071 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00002072 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002073
wdenk544e9732004-02-06 23:19:44 +00002074 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00002075
wdenkc6097192002-11-03 00:24:07 +00002076 I2C_ACTIVE
2077
2078 The code necessary to make the I2C data line active
2079 (driven). If the data line is open collector, this
2080 define can be null.
2081
wdenkb9bbd242003-06-30 16:24:52 +00002082 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2083
wdenkc6097192002-11-03 00:24:07 +00002084 I2C_TRISTATE
2085
2086 The code necessary to make the I2C data line tri-stated
2087 (inactive). If the data line is open collector, this
2088 define can be null.
2089
wdenkb9bbd242003-06-30 16:24:52 +00002090 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2091
wdenkc6097192002-11-03 00:24:07 +00002092 I2C_READ
2093
York Sun4a598092013-04-01 11:29:11 -07002094 Code that returns true if the I2C data line is high,
2095 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002096
wdenkb9bbd242003-06-30 16:24:52 +00002097 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2098
wdenkc6097192002-11-03 00:24:07 +00002099 I2C_SDA(bit)
2100
York Sun4a598092013-04-01 11:29:11 -07002101 If <bit> is true, sets the I2C data line high. If it
2102 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002103
wdenkb9bbd242003-06-30 16:24:52 +00002104 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002105 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00002106 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00002107
wdenkc6097192002-11-03 00:24:07 +00002108 I2C_SCL(bit)
2109
York Sun4a598092013-04-01 11:29:11 -07002110 If <bit> is true, sets the I2C clock line high. If it
2111 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002112
wdenkb9bbd242003-06-30 16:24:52 +00002113 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002114 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00002115 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00002116
wdenkc6097192002-11-03 00:24:07 +00002117 I2C_DELAY
2118
2119 This delay is invoked four times per clock cycle so this
2120 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00002121 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00002122 like:
2123
wdenkb9bbd242003-06-30 16:24:52 +00002124 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002125
Mike Frysingeree12d542010-07-21 13:38:02 -04002126 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2127
2128 If your arch supports the generic GPIO framework (asm/gpio.h),
2129 then you may alternatively define the two GPIOs that are to be
2130 used as SCL / SDA. Any of the previous I2C_xxx macros will
2131 have GPIO-based defaults assigned to them as appropriate.
2132
2133 You should define these to the GPIO value as given directly to
2134 the generic GPIO functions.
2135
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002136 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00002137
wdenk57b2d802003-06-27 21:31:46 +00002138 When a board is reset during an i2c bus transfer
2139 chips might think that the current transfer is still
2140 in progress. On some boards it is possible to access
2141 the i2c SCLK line directly, either by using the
2142 processor pin as a GPIO or by having a second pin
2143 connected to the bus. If this option is defined a
2144 custom i2c_init_board() routine in boards/xxx/board.c
2145 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00002146
Ben Warren45657152006-09-07 16:50:54 -04002147 CONFIG_I2C_MULTI_BUS
2148
2149 This option allows the use of multiple I2C buses, each of which
Wolfgang Denk092ae952011-10-26 10:21:21 +00002150 must have a controller. At any point in time, only one bus is
2151 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warren45657152006-09-07 16:50:54 -04002152 Note that bus numbering is zero-based.
2153
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002154 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04002155
2156 This option specifies a list of I2C devices that will be skipped
Wolfgang Denk092ae952011-10-26 10:21:21 +00002157 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser469cde42009-04-18 22:34:03 -05002158 is set, specify a list of bus-device pairs. Otherwise, specify
2159 a 1D array of device addresses
Ben Warren45657152006-09-07 16:50:54 -04002160
2161 e.g.
2162 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denk092ae952011-10-26 10:21:21 +00002163 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04002164
2165 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2166
Wolfgang Denk092ae952011-10-26 10:21:21 +00002167 #define CONFIG_I2C_MULTI_BUS
Simon Glassb05e2b32016-10-02 18:01:05 -06002168 #define CONFIG_SYS_I2C_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-09-07 16:50:54 -04002169
2170 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2171
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002172 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-11-03 19:15:00 -06002173
2174 If defined, then this indicates the I2C bus number for DDR SPD.
2175 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2176
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002177 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002178
2179 If defined, then this indicates the I2C bus number for the RTC.
2180 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2181
Andrew Dyer58c41f92008-12-29 17:36:01 -06002182 CONFIG_SOFT_I2C_READ_REPEATED_START
2183
2184 defining this will force the i2c_read() function in
2185 the soft_i2c driver to perform an I2C repeated start
2186 between writing the address pointer and reading the
2187 data. If this define is omitted the default behaviour
2188 of doing a stop-start sequence will be used. Most I2C
2189 devices can use either method, but some require one or
2190 the other.
Timur Tabiab347542006-11-03 19:15:00 -06002191
wdenkc6097192002-11-03 00:24:07 +00002192- SPI Support: CONFIG_SPI
2193
2194 Enables SPI driver (so far only tested with
2195 SPI EEPROM, also an instance works with Crystal A/D and
2196 D/As on the SACSng board)
2197
Yoshihiro Shimoda65bd9b42011-01-31 16:50:43 +09002198 CONFIG_SH_SPI
2199
2200 Enables the driver for SPI controller on SuperH. Currently
2201 only SH7757 is supported.
2202
wdenkc6097192002-11-03 00:24:07 +00002203 CONFIG_SOFT_SPI
2204
wdenk4a5c8a72003-03-06 00:02:04 +00002205 Enables a software (bit-bang) SPI driver rather than
2206 using hardware support. This is a general purpose
2207 driver that only requires three general I/O port pins
2208 (two outputs, one input) to function. If this is
2209 defined, the board configuration must define several
2210 SPI configuration items (port pins to use, etc). For
2211 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002212
Ben Warren7efe9272008-01-16 22:37:35 -05002213 CONFIG_HARD_SPI
2214
2215 Enables a hardware SPI driver for general-purpose reads
2216 and writes. As with CONFIG_SOFT_SPI, the board configuration
2217 must define a list of chip-select function pointers.
Wolfgang Denk092ae952011-10-26 10:21:21 +00002218 Currently supported on some MPC8xxx processors. For an
Ben Warren7efe9272008-01-16 22:37:35 -05002219 example, see include/configs/mpc8349emds.h.
2220
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002221 CONFIG_MXC_SPI
2222
2223 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevamdcd342c2011-10-28 08:57:46 +00002224 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002225
Heiko Schocherb77c8882014-07-14 10:22:11 +02002226 CONFIG_SYS_SPI_MXC_WAIT
2227 Timeout for waiting until spi transfer completed.
2228 default: (CONFIG_SYS_HZ/100) /* 10 ms */
2229
Matthias Fuchsa4400872007-12-27 17:12:34 +01002230- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00002231
Matthias Fuchsa4400872007-12-27 17:12:34 +01002232 Enables FPGA subsystem.
2233
2234 CONFIG_FPGA_<vendor>
2235
2236 Enables support for specific chip vendors.
2237 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00002238
Matthias Fuchsa4400872007-12-27 17:12:34 +01002239 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00002240
Matthias Fuchsa4400872007-12-27 17:12:34 +01002241 Enables support for FPGA family.
2242 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2243
2244 CONFIG_FPGA_COUNT
2245
2246 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002247
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002248 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002249
wdenk57b2d802003-06-27 21:31:46 +00002250 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002251
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002252 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002253
wdenk4a5c8a72003-03-06 00:02:04 +00002254 Enable checks on FPGA configuration interface busy
2255 status by the configuration function. This option
2256 will require a board or device specific function to
2257 be written.
wdenkc6097192002-11-03 00:24:07 +00002258
2259 CONFIG_FPGA_DELAY
2260
2261 If defined, a function that provides delays in the FPGA
2262 configuration driver.
2263
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002264 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002265 Allow Control-C to interrupt FPGA configuration
2266
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002267 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002268
wdenk4a5c8a72003-03-06 00:02:04 +00002269 Check for configuration errors during FPGA bitfile
2270 loading. For example, abort during Virtex II
2271 configuration if the INIT_B line goes low (which
2272 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002273
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002274 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002275
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002276 Maximum time to wait for the INIT_B line to de-assert
2277 after PROB_B has been de-asserted during a Virtex II
wdenk4a5c8a72003-03-06 00:02:04 +00002278 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002279 ms.
wdenkc6097192002-11-03 00:24:07 +00002280
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002281 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002282
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002283 Maximum time to wait for BUSY to de-assert during
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002284 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002285
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002286 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002287
wdenk4a5c8a72003-03-06 00:02:04 +00002288 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002289 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002290
2291- Configuration Management:
Stefan Roese141ed202014-10-22 12:13:24 +02002292 CONFIG_BUILD_TARGET
2293
2294 Some SoCs need special image types (e.g. U-Boot binary
2295 with a special header) as build targets. By defining
2296 CONFIG_BUILD_TARGET in the SoC / board header, this
2297 special image will be automatically built upon calling
Simon Glassdc27def2016-07-27 20:33:08 -06002298 make / buildman.
Stefan Roese141ed202014-10-22 12:13:24 +02002299
wdenkc6097192002-11-03 00:24:07 +00002300 CONFIG_IDENT_STRING
2301
wdenk4a5c8a72003-03-06 00:02:04 +00002302 If defined, this string will be added to the U-Boot
2303 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002304
2305- Vendor Parameter Protection:
2306
wdenk4a5c8a72003-03-06 00:02:04 +00002307 U-Boot considers the values of the environment
2308 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00002309 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00002310 are set once by the board vendor / manufacturer, and
2311 protects these variables from casual modification by
2312 the user. Once set, these variables are read-only,
2313 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002314 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002315
2316 If CONFIG_ENV_OVERWRITE is #defined in your config
2317 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00002318 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002319 these parameters.
2320
Joe Hershberger76f353e2015-05-04 14:55:14 -05002321 Alternatively, if you define _both_ an ethaddr in the
2322 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002323 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002324 which can be changed exactly ONCE by the user. [The
2325 serial# is unaffected by this, i. e. it remains
2326 read-only.]
2327
Joe Hershberger71497d02012-12-11 22:16:31 -06002328 The same can be accomplished in a more flexible way
2329 for any variable by configuring the type of access
2330 to allow for those variables in the ".flags" variable
2331 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2332
wdenkc6097192002-11-03 00:24:07 +00002333- Protected RAM:
2334 CONFIG_PRAM
2335
2336 Define this variable to enable the reservation of
2337 "protected RAM", i. e. RAM which is not overwritten
2338 by U-Boot. Define CONFIG_PRAM to hold the number of
2339 kB you want to reserve for pRAM. You can overwrite
2340 this default value by defining an environment
2341 variable "pram" to the number of kB you want to
2342 reserve. Note that the board info structure will
2343 still show the full amount of RAM. If pRAM is
2344 reserved, a new environment variable "mem" will
2345 automatically be defined to hold the amount of
2346 remaining RAM in a form that can be passed as boot
2347 argument to Linux, for instance like that:
2348
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01002349 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002350 saveenv
2351
2352 This way you can tell Linux not to use this memory,
2353 either, which results in a memory region that will
2354 not be affected by reboots.
2355
2356 *WARNING* If your board configuration uses automatic
2357 detection of the RAM size, you must make sure that
2358 this memory test is non-destructive. So far, the
2359 following board configurations are known to be
2360 "pRAM-clean":
2361
Heiko Schocher65d94db2017-06-07 17:33:09 +02002362 IVMS8, IVML24, SPD8xx,
Wolfgang Denk90326762012-10-24 02:36:15 +00002363 HERMES, IP860, RPXlite, LWMON,
Heiko Schocher71cb3e92017-06-07 17:33:10 +02002364 FLAGADM
wdenkc6097192002-11-03 00:24:07 +00002365
Gabe Blacka2f3a932012-12-02 04:55:18 +00002366- Access to physical memory region (> 4GB)
2367 Some basic support is provided for operations on memory not
2368 normally accessible to U-Boot - e.g. some architectures
2369 support access to more than 4GB of memory on 32-bit
2370 machines using physical address extension or similar.
2371 Define CONFIG_PHYSMEM to access this basic support, which
2372 currently only supports clearing the memory.
2373
wdenkc6097192002-11-03 00:24:07 +00002374- Error Recovery:
2375 CONFIG_PANIC_HANG
2376
2377 Define this variable to stop the system in case of a
2378 fatal error, so that you have to reset it manually.
2379 This is probably NOT a good idea for an embedded
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002380 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002381 automatically as fast as possible, but it may be
2382 useful during development since you can try to debug
2383 the conditions that lead to the situation.
2384
2385 CONFIG_NET_RETRY_COUNT
2386
wdenk4a5c8a72003-03-06 00:02:04 +00002387 This variable defines the number of retries for
2388 network operations like ARP, RARP, TFTP, or BOOTP
2389 before giving up the operation. If not defined, a
2390 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002391
Guennadi Liakhovetskib38c2b32008-04-03 17:04:19 +02002392 CONFIG_ARP_TIMEOUT
2393
2394 Timeout waiting for an ARP reply in milliseconds.
2395
Tetsuyuki Kobayashi147e3902012-07-03 22:25:21 +00002396 CONFIG_NFS_TIMEOUT
2397
2398 Timeout in milliseconds used in NFS protocol.
2399 If you encounter "ERROR: Cannot umount" in nfs command,
2400 try longer timeout such as
2401 #define CONFIG_NFS_TIMEOUT 10000UL
2402
wdenkc6097192002-11-03 00:24:07 +00002403- Command Interpreter:
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002404 CONFIG_AUTO_COMPLETE
wdenk3902d702004-04-15 18:22:41 +00002405
2406 Enable auto completion of commands using TAB.
2407
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002408 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002409
2410 This defines the secondary prompt string, which is
2411 printed when the command interpreter needs more input
2412 to complete a command. Usually "> ".
2413
2414 Note:
2415
wdenk57b2d802003-06-27 21:31:46 +00002416 In the current implementation, the local variables
2417 space and global environment variables space are
2418 separated. Local variables are those you define by
2419 simply typing `name=value'. To access a local
2420 variable later on, you have write `$name' or
2421 `${name}'; to execute the contents of a variable
2422 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002423
wdenk4a5c8a72003-03-06 00:02:04 +00002424 Global environment variables are those you use
2425 setenv/printenv to work with. To run a command stored
2426 in such a variable, you need to use the run command,
2427 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002428
2429 To store commands and special characters in a
2430 variable, please use double quotation marks
2431 surrounding the whole text of the variable, instead
2432 of the backslashes before semicolons and special
2433 symbols.
2434
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002435- Command Line Editing and History:
Wolfgang Denk2039a072006-07-21 11:35:21 +02002436 CONFIG_CMDLINE_EDITING
2437
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002438 Enable editing and History functions for interactive
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002439 command line input operations
Wolfgang Denk2039a072006-07-21 11:35:21 +02002440
Marek Vasut734fb042016-01-27 04:47:55 +01002441- Command Line PS1/PS2 support:
2442 CONFIG_CMDLINE_PS_SUPPORT
2443
2444 Enable support for changing the command prompt string
2445 at run-time. Only static string is supported so far.
2446 The string is obtained from environment variables PS1
2447 and PS2.
2448
wdenkc0aa5c52003-12-06 19:49:23 +00002449- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002450 CONFIG_EXTRA_ENV_SETTINGS
2451
wdenk4a5c8a72003-03-06 00:02:04 +00002452 Define this to contain any number of null terminated
2453 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00002454 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00002455
wdenk4a5c8a72003-03-06 00:02:04 +00002456 For example, place something like this in your
2457 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002458
2459 #define CONFIG_EXTRA_ENV_SETTINGS \
2460 "myvar1=value1\0" \
2461 "myvar2=value2\0"
2462
wdenk4a5c8a72003-03-06 00:02:04 +00002463 Warning: This method is based on knowledge about the
2464 internal format how the environment is stored by the
2465 U-Boot code. This is NOT an official, exported
2466 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00002467 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002468 You better know what you are doing here.
2469
wdenk4a5c8a72003-03-06 00:02:04 +00002470 Note: overly (ab)use of the default environment is
2471 discouraged. Make sure to check other ways to preset
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002472 the environment like the "source" command or the
wdenk4a5c8a72003-03-06 00:02:04 +00002473 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002474
Stephen Warren1465d5f2012-05-22 09:21:54 +00002475 CONFIG_ENV_VARS_UBOOT_CONFIG
2476
2477 Define this in order to add variables describing the
2478 U-Boot build configuration to the default environment.
2479 These will be named arch, cpu, board, vendor, and soc.
2480
2481 Enabling this option will cause the following to be defined:
2482
2483 - CONFIG_SYS_ARCH
2484 - CONFIG_SYS_CPU
2485 - CONFIG_SYS_BOARD
2486 - CONFIG_SYS_VENDOR
2487 - CONFIG_SYS_SOC
2488
Tom Rini4c8cc9b2012-10-24 07:28:16 +00002489 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2490
2491 Define this in order to add variables describing certain
2492 run-time determined information about the hardware to the
2493 environment. These will be named board_name, board_rev.
2494
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002495 CONFIG_DELAY_ENVIRONMENT
2496
2497 Normally the environment is loaded when the board is
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002498 initialised so that it is available to U-Boot. This inhibits
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002499 that so that the environment is not available until
2500 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2501 this is instead controlled by the value of
2502 /config/load-environment.
2503
wdenkc0aa5c52003-12-06 19:49:23 +00002504- DataFlash Support:
wdenk381669a2003-06-16 23:50:08 +00002505 CONFIG_HAS_DATAFLASH
2506
wdenk57b2d802003-06-27 21:31:46 +00002507 Defining this option enables DataFlash features and
2508 allows to read/write in Dataflash via the standard
2509 commands cp, md...
wdenk381669a2003-06-16 23:50:08 +00002510
Eric Nelson97f5f8f2012-01-31 10:52:08 -07002511- Serial Flash support
2512 CONFIG_CMD_SF
2513
2514 Defining this option enables SPI flash commands
2515 'sf probe/read/write/erase/update'.
2516
2517 Usage requires an initial 'probe' to define the serial
2518 flash parameters, followed by read/write/erase/update
2519 commands.
2520
2521 The following defaults may be provided by the platform
2522 to handle the common case when only a single serial
2523 flash is present on the system.
2524
2525 CONFIG_SF_DEFAULT_BUS Bus identifier
2526 CONFIG_SF_DEFAULT_CS Chip-select
2527 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2528 CONFIG_SF_DEFAULT_SPEED in Hz
2529
Simon Glass4b5545e2012-10-08 13:16:02 +00002530 CONFIG_CMD_SF_TEST
2531
2532 Define this option to include a destructive SPI flash
2533 test ('sf test').
2534
wdenkef893942004-02-23 16:11:30 +00002535- SystemACE Support:
2536 CONFIG_SYSTEMACE
2537
2538 Adding this option adds support for Xilinx SystemACE
2539 chips attached via some sort of local bus. The address
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002540 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002541 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenkef893942004-02-23 16:11:30 +00002542
2543 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002544 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenkef893942004-02-23 16:11:30 +00002545
2546 When SystemACE support is added, the "ace" device type
2547 becomes available to the fat commands, i.e. fatls.
2548
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002549- TFTP Fixed UDP Port:
2550 CONFIG_TFTP_PORT
2551
Wolfgang Denk227b5192005-09-24 23:25:46 +02002552 If this is defined, the environment variable tftpsrcp
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002553 is used to supply the TFTP UDP source port value.
Wolfgang Denk227b5192005-09-24 23:25:46 +02002554 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002555 number generator is used.
2556
Wolfgang Denk227b5192005-09-24 23:25:46 +02002557 Also, the environment variable tftpdstp is used to supply
2558 the TFTP UDP destination port value. If tftpdstp isn't
2559 defined, the normal port 69 is used.
2560
2561 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002562 blindly start the TFTP transfer using the pre-configured
2563 target IP address and UDP port. This has the effect of
2564 "punching through" the (Windows XP) firewall, allowing
2565 the remainder of the TFTP transfer to proceed normally.
2566 A better solution is to properly configure the firewall,
2567 but sometimes that is not allowed.
2568
Heiko Schocher443ca402014-01-25 07:27:13 +01002569- bootcount support:
2570 CONFIG_BOOTCOUNT_LIMIT
2571
2572 This enables the bootcounter support, see:
2573 http://www.denx.de/wiki/DULG/UBootBootCountLimit
2574
2575 CONFIG_AT91SAM9XE
2576 enable special bootcounter support on at91sam9xe based boards.
Heiko Schocher443ca402014-01-25 07:27:13 +01002577 CONFIG_SOC_DA8XX
2578 enable special bootcounter support on da850 based boards.
2579 CONFIG_BOOTCOUNT_RAM
2580 enable support for the bootcounter in RAM
2581 CONFIG_BOOTCOUNT_I2C
2582 enable support for the bootcounter on an i2c (like RTC) device.
2583 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
2584 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
2585 the bootcounter.
2586 CONFIG_BOOTCOUNT_ALEN = address len
Simon Glass35191a32013-06-13 15:10:02 -07002587
wdenkc0aa5c52003-12-06 19:49:23 +00002588- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002589 CONFIG_SHOW_BOOT_PROGRESS
2590
wdenk4a5c8a72003-03-06 00:02:04 +00002591 Defining this option allows to add some board-
2592 specific code (calling a user-provided function
2593 "show_boot_progress(int)") that enables you to show
2594 the system's boot progress on some display (for
2595 example, some LED's) on your board. At the moment,
2596 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002597
Simon Glass0fa36a42012-09-28 08:56:37 +00002598
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002599Legacy uImage format:
2600
wdenkc6097192002-11-03 00:24:07 +00002601 Arg Where When
2602 1 common/cmd_bootm.c before attempting to boot an image
wdenk544e9732004-02-06 23:19:44 +00002603 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002604 2 common/cmd_bootm.c Image header has correct magic number
wdenk544e9732004-02-06 23:19:44 +00002605 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002606 3 common/cmd_bootm.c Image header has correct checksum
wdenk544e9732004-02-06 23:19:44 +00002607 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002608 4 common/cmd_bootm.c Image data has correct checksum
2609 -4 common/cmd_bootm.c Image is for unsupported architecture
2610 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002611 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002612 6 common/cmd_bootm.c Image Type check OK
2613 -6 common/cmd_bootm.c gunzip uncompression error
2614 -7 common/cmd_bootm.c Unimplemented compression type
2615 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002616 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002617 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002618
2619 9 common/image.c Start initial ramdisk verification
2620 -10 common/image.c Ramdisk header has bad magic number
2621 -11 common/image.c Ramdisk header has bad checksum
2622 10 common/image.c Ramdisk header is OK
2623 -12 common/image.c Ramdisk data has bad checksum
2624 11 common/image.c Ramdisk data has correct checksum
2625 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002626 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002627 13 common/image.c Start multifile image verification
2628 14 common/image.c No initial ramdisk, no multifile, continue.
2629
Wolfgang Denk092ae952011-10-26 10:21:21 +00002630 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002631
Stefan Roese88fbf932010-04-15 16:07:28 +02002632 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenkd729d302004-02-27 00:07:27 +00002633 -31 post/post.c POST test failed, detected by post_output_backlog()
2634 -32 post/post.c POST test failed, detected by post_run_single()
wdenke97d3d92004-02-23 22:22:28 +00002635
Heiko Schocher633e03a2007-06-22 19:11:54 +02002636 34 common/cmd_doc.c before loading a Image from a DOC device
2637 -35 common/cmd_doc.c Bad usage of "doc" command
2638 35 common/cmd_doc.c correct usage of "doc" command
2639 -36 common/cmd_doc.c No boot device
2640 36 common/cmd_doc.c correct boot device
2641 -37 common/cmd_doc.c Unknown Chip ID on boot device
2642 37 common/cmd_doc.c correct chip ID found, device available
2643 -38 common/cmd_doc.c Read Error on boot device
2644 38 common/cmd_doc.c reading Image header from DOC device OK
2645 -39 common/cmd_doc.c Image header has bad magic number
2646 39 common/cmd_doc.c Image header has correct magic number
2647 -40 common/cmd_doc.c Error reading Image from DOC device
2648 40 common/cmd_doc.c Image header has correct magic number
2649 41 common/cmd_ide.c before loading a Image from a IDE device
2650 -42 common/cmd_ide.c Bad usage of "ide" command
2651 42 common/cmd_ide.c correct usage of "ide" command
2652 -43 common/cmd_ide.c No boot device
2653 43 common/cmd_ide.c boot device found
2654 -44 common/cmd_ide.c Device not available
2655 44 common/cmd_ide.c Device available
2656 -45 common/cmd_ide.c wrong partition selected
2657 45 common/cmd_ide.c partition selected
2658 -46 common/cmd_ide.c Unknown partition table
2659 46 common/cmd_ide.c valid partition table found
2660 -47 common/cmd_ide.c Invalid partition type
2661 47 common/cmd_ide.c correct partition type
2662 -48 common/cmd_ide.c Error reading Image Header on boot device
2663 48 common/cmd_ide.c reading Image Header from IDE device OK
2664 -49 common/cmd_ide.c Image header has bad magic number
2665 49 common/cmd_ide.c Image header has correct magic number
2666 -50 common/cmd_ide.c Image header has bad checksum
2667 50 common/cmd_ide.c Image header has correct checksum
2668 -51 common/cmd_ide.c Error reading Image from IDE device
2669 51 common/cmd_ide.c reading Image from IDE device OK
2670 52 common/cmd_nand.c before loading a Image from a NAND device
2671 -53 common/cmd_nand.c Bad usage of "nand" command
2672 53 common/cmd_nand.c correct usage of "nand" command
2673 -54 common/cmd_nand.c No boot device
2674 54 common/cmd_nand.c boot device found
2675 -55 common/cmd_nand.c Unknown Chip ID on boot device
2676 55 common/cmd_nand.c correct chip ID found, device available
2677 -56 common/cmd_nand.c Error reading Image Header on boot device
2678 56 common/cmd_nand.c reading Image Header from NAND device OK
2679 -57 common/cmd_nand.c Image header has bad magic number
2680 57 common/cmd_nand.c Image header has correct magic number
2681 -58 common/cmd_nand.c Error reading Image from NAND device
2682 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002683
Heiko Schocher633e03a2007-06-22 19:11:54 +02002684 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002685
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002686 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher633e03a2007-06-22 19:11:54 +02002687 -64 net/eth.c no Ethernet found.
2688 65 net/eth.c Ethernet found.
wdenkc6097192002-11-03 00:24:07 +00002689
Heiko Schocher633e03a2007-06-22 19:11:54 +02002690 -80 common/cmd_net.c usage wrong
Joe Hershbergerc80b41b02015-04-08 01:41:21 -05002691 80 common/cmd_net.c before calling net_loop()
2692 -81 common/cmd_net.c some error in net_loop() occurred
2693 81 common/cmd_net.c net_loop() back without error
Heiko Schocher633e03a2007-06-22 19:11:54 +02002694 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2695 82 common/cmd_net.c trying automatic boot
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002696 83 common/cmd_net.c running "source" command
2697 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher633e03a2007-06-22 19:11:54 +02002698 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002699
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002700FIT uImage format:
2701
2702 Arg Where When
2703 100 common/cmd_bootm.c Kernel FIT Image has correct format
2704 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2705 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2706 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2707 102 common/cmd_bootm.c Kernel unit name specified
2708 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +01002709 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002710 104 common/cmd_bootm.c Got kernel subimage node offset
2711 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2712 105 common/cmd_bootm.c Kernel subimage hash verification OK
2713 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2714 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002715 -106 common/cmd_bootm.c Kernel subimage has wrong type
2716 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002717 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2718 108 common/cmd_bootm.c Got kernel subimage data/size
2719 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2720 -109 common/cmd_bootm.c Can't get kernel subimage type
2721 -110 common/cmd_bootm.c Can't get kernel subimage comp
2722 -111 common/cmd_bootm.c Can't get kernel subimage os
2723 -112 common/cmd_bootm.c Can't get kernel subimage load address
2724 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2725
2726 120 common/image.c Start initial ramdisk verification
2727 -120 common/image.c Ramdisk FIT image has incorrect format
2728 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002729 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002730 -122 common/image.c Can't get configuration for ramdisk subimage
2731 123 common/image.c Ramdisk unit name specified
2732 -124 common/image.c Can't get ramdisk subimage node offset
2733 125 common/image.c Got ramdisk subimage node offset
2734 -125 common/image.c Ramdisk subimage hash verification failed
2735 126 common/image.c Ramdisk subimage hash verification OK
2736 -126 common/image.c Ramdisk subimage for unsupported architecture
2737 127 common/image.c Architecture check OK
2738 -127 common/image.c Can't get ramdisk subimage data/size
2739 128 common/image.c Got ramdisk subimage data/size
2740 129 common/image.c Can't get ramdisk load address
2741 -129 common/image.c Got ramdisk load address
2742
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002743 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002744 131 common/cmd_doc.c FIT image format OK
2745
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002746 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002747 141 common/cmd_ide.c FIT image format OK
2748
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002749 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002750 151 common/cmd_nand.c FIT image format OK
2751
Heiko Schocher515eb122014-05-28 11:33:33 +02002752- legacy image format:
2753 CONFIG_IMAGE_FORMAT_LEGACY
2754 enables the legacy image format support in U-Boot.
2755
2756 Default:
2757 enabled if CONFIG_FIT_SIGNATURE is not defined.
2758
2759 CONFIG_DISABLE_IMAGE_LEGACY
2760 disable the legacy image format
2761
2762 This define is introduced, as the legacy image format is
2763 enabled per default for backward compatibility.
2764
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002765- Standalone program support:
2766 CONFIG_STANDALONE_LOAD_ADDR
2767
Wolfgang Denk23f78482011-10-09 21:06:34 +02002768 This option defines a board specific value for the
2769 address where standalone program gets loaded, thus
2770 overwriting the architecture dependent default
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002771 settings.
2772
2773- Frame Buffer Address:
2774 CONFIG_FB_ADDR
2775
2776 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denka71eb8e2013-01-03 00:43:59 +00002777 address for frame buffer. This is typically the case
2778 when using a graphics controller has separate video
2779 memory. U-Boot will then place the frame buffer at
2780 the given address instead of dynamically reserving it
2781 in system RAM by calling lcd_setmem(), which grabs
2782 the memory for the frame buffer depending on the
2783 configured panel size.
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002784
2785 Please see board_init_f function.
2786
Detlev Zundel0ecb6112009-12-01 17:16:19 +01002787- Automatic software updates via TFTP server
2788 CONFIG_UPDATE_TFTP
2789 CONFIG_UPDATE_TFTP_CNT_MAX
2790 CONFIG_UPDATE_TFTP_MSEC_MAX
2791
2792 These options enable and control the auto-update feature;
2793 for a more detailed description refer to doc/README.update.
2794
2795- MTD Support (mtdparts command, UBI support)
2796 CONFIG_MTD_DEVICE
2797
2798 Adds the MTD device infrastructure from the Linux kernel.
2799 Needed for mtdparts command support.
2800
2801 CONFIG_MTD_PARTITIONS
2802
2803 Adds the MTD partitioning infrastructure from the Linux
2804 kernel. Needed for UBI support.
2805
Joe Hershberger7d80fc12013-04-08 10:32:48 +00002806- UBI support
2807 CONFIG_CMD_UBI
2808
2809 Adds commands for interacting with MTD partitions formatted
2810 with the UBI flash translation layer
2811
2812 Requires also defining CONFIG_RBTREE
2813
Joe Hershberger47550fc2013-04-08 10:32:49 +00002814 CONFIG_UBI_SILENCE_MSG
2815
2816 Make the verbose messages from UBI stop printing. This leaves
2817 warnings and errors enabled.
2818
Heiko Schocherf5895d12014-06-24 10:10:04 +02002819
2820 CONFIG_MTD_UBI_WL_THRESHOLD
2821 This parameter defines the maximum difference between the highest
2822 erase counter value and the lowest erase counter value of eraseblocks
2823 of UBI devices. When this threshold is exceeded, UBI starts performing
2824 wear leveling by means of moving data from eraseblock with low erase
2825 counter to eraseblocks with high erase counter.
2826
2827 The default value should be OK for SLC NAND flashes, NOR flashes and
2828 other flashes which have eraseblock life-cycle 100000 or more.
2829 However, in case of MLC NAND flashes which typically have eraseblock
2830 life-cycle less than 10000, the threshold should be lessened (e.g.,
2831 to 128 or 256, although it does not have to be power of 2).
2832
2833 default: 4096
Simon Glass6c0be912014-10-23 18:58:54 -06002834
Heiko Schocherf5895d12014-06-24 10:10:04 +02002835 CONFIG_MTD_UBI_BEB_LIMIT
2836 This option specifies the maximum bad physical eraseblocks UBI
2837 expects on the MTD device (per 1024 eraseblocks). If the
2838 underlying flash does not admit of bad eraseblocks (e.g. NOR
2839 flash), this value is ignored.
2840
2841 NAND datasheets often specify the minimum and maximum NVM
2842 (Number of Valid Blocks) for the flashes' endurance lifetime.
2843 The maximum expected bad eraseblocks per 1024 eraseblocks
2844 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
2845 which gives 20 for most NANDs (MaxNVB is basically the total
2846 count of eraseblocks on the chip).
2847
2848 To put it differently, if this value is 20, UBI will try to
2849 reserve about 1.9% of physical eraseblocks for bad blocks
2850 handling. And that will be 1.9% of eraseblocks on the entire
2851 NAND chip, not just the MTD partition UBI attaches. This means
2852 that if you have, say, a NAND flash chip admits maximum 40 bad
2853 eraseblocks, and it is split on two MTD partitions of the same
2854 size, UBI will reserve 40 eraseblocks when attaching a
2855 partition.
2856
2857 default: 20
2858
2859 CONFIG_MTD_UBI_FASTMAP
2860 Fastmap is a mechanism which allows attaching an UBI device
2861 in nearly constant time. Instead of scanning the whole MTD device it
2862 only has to locate a checkpoint (called fastmap) on the device.
2863 The on-flash fastmap contains all information needed to attach
2864 the device. Using fastmap makes only sense on large devices where
2865 attaching by scanning takes long. UBI will not automatically install
2866 a fastmap on old images, but you can set the UBI parameter
2867 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
2868 that fastmap-enabled images are still usable with UBI implementations
2869 without fastmap support. On typical flash devices the whole fastmap
2870 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
2871
2872 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
2873 Set this parameter to enable fastmap automatically on images
2874 without a fastmap.
2875 default: 0
2876
Heiko Schocher94b66de2015-10-22 06:19:21 +02002877 CONFIG_MTD_UBI_FM_DEBUG
2878 Enable UBI fastmap debug
2879 default: 0
2880
Joe Hershberger7d80fc12013-04-08 10:32:48 +00002881- UBIFS support
2882 CONFIG_CMD_UBIFS
2883
2884 Adds commands for interacting with UBI volumes formatted as
2885 UBIFS. UBIFS is read-only in u-boot.
2886
2887 Requires UBI support as well as CONFIG_LZO
2888
Joe Hershberger47550fc2013-04-08 10:32:49 +00002889 CONFIG_UBIFS_SILENCE_MSG
2890
2891 Make the verbose messages from UBIFS stop printing. This leaves
2892 warnings and errors enabled.
2893
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002894- SPL framework
Wolfgang Denk825223d2011-09-11 21:24:09 +02002895 CONFIG_SPL
2896 Enable building of SPL globally.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002897
Tom Rini36853852012-02-14 07:29:40 +00002898 CONFIG_SPL_LDSCRIPT
2899 LDSCRIPT for linking the SPL binary.
2900
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002901 CONFIG_SPL_MAX_FOOTPRINT
2902 Maximum size in memory allocated to the SPL, BSS included.
2903 When defined, the linker checks that the actual memory
2904 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00002905 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002906 must not be both defined at the same time.
2907
Tom Rini36853852012-02-14 07:29:40 +00002908 CONFIG_SPL_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002909 Maximum size of the SPL image (text, data, rodata, and
2910 linker lists sections), BSS excluded.
2911 When defined, the linker checks that the actual size does
2912 not exceed it.
Tom Rini36853852012-02-14 07:29:40 +00002913
Wolfgang Denk825223d2011-09-11 21:24:09 +02002914 CONFIG_SPL_TEXT_BASE
2915 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002916
Scott Woodc4f0d002012-09-20 19:05:12 -05002917 CONFIG_SPL_RELOC_TEXT_BASE
2918 Address to relocate to. If unspecified, this is equal to
2919 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
2920
Tom Rini36853852012-02-14 07:29:40 +00002921 CONFIG_SPL_BSS_START_ADDR
2922 Link address for the BSS within the SPL binary.
2923
2924 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002925 Maximum size in memory allocated to the SPL BSS.
2926 When defined, the linker checks that the actual memory used
2927 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00002928 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002929 must not be both defined at the same time.
Tom Rini36853852012-02-14 07:29:40 +00002930
2931 CONFIG_SPL_STACK
2932 Adress of the start of the stack SPL will use
2933
Albert ARIBAUD \(3ADEV\)287b0942015-03-31 11:40:50 +02002934 CONFIG_SPL_PANIC_ON_RAW_IMAGE
2935 When defined, SPL will panic() if the image it has
2936 loaded does not have a signature.
2937 Defining this is useful when code which loads images
2938 in SPL cannot guarantee that absolutely all read errors
2939 will be caught.
2940 An example is the LPC32XX MLC NAND driver, which will
2941 consider that a completely unreadable NAND block is bad,
2942 and thus should be skipped silently.
2943
Scott Woodc4f0d002012-09-20 19:05:12 -05002944 CONFIG_SPL_RELOC_STACK
2945 Adress of the start of the stack SPL will use after
2946 relocation. If unspecified, this is equal to
2947 CONFIG_SPL_STACK.
2948
Tom Rini36853852012-02-14 07:29:40 +00002949 CONFIG_SYS_SPL_MALLOC_START
2950 Starting address of the malloc pool used in SPL.
Fabio Estevam38e1a972015-11-12 12:30:19 -02002951 When this option is set the full malloc is used in SPL and
2952 it is set up by spl_init() and before that, the simple malloc()
2953 can be used if CONFIG_SYS_MALLOC_F is defined.
Tom Rini36853852012-02-14 07:29:40 +00002954
2955 CONFIG_SYS_SPL_MALLOC_SIZE
2956 The size of the malloc pool used in SPL.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002957
Tom Rini28591df2012-08-13 12:03:19 -07002958 CONFIG_SPL_FRAMEWORK
2959 Enable the SPL framework under common/. This framework
2960 supports MMC, NAND and YMODEM loading of U-Boot and NAND
2961 NAND loading of the Linux Kernel.
2962
Tom Rinic2b76002014-03-28 12:03:39 -04002963 CONFIG_SPL_OS_BOOT
2964 Enable booting directly to an OS from SPL.
2965 See also: doc/README.falcon
2966
Tom Rinife3b0c72012-08-13 11:37:56 -07002967 CONFIG_SPL_DISPLAY_PRINT
2968 For ARM, enable an optional function to print more information
2969 about the running system.
2970
Scott Wood7c810902012-09-20 16:35:21 -05002971 CONFIG_SPL_INIT_MINIMAL
2972 Arch init code should be built for a very small image
2973
Paul Kocialkowski17675c82014-11-08 23:14:56 +01002974 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
2975 Partition on the MMC to load U-Boot from when the MMC is being
2976 used in raw mode
2977
Peter Korsgaard01b542f2013-05-13 08:36:29 +00002978 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
2979 Sector to load kernel uImage from when MMC is being
2980 used in raw mode (for Falcon mode)
2981
2982 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
2983 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
2984 Sector and number of sectors to load kernel argument
2985 parameters from when MMC is being used in raw mode
2986 (for falcon mode)
2987
Paul Kocialkowski341e8cd2014-11-08 23:14:55 +01002988 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
2989 Partition on the MMC to load U-Boot from when the MMC is being
2990 used in fs mode
2991
Guillaume GARDET5065b712014-10-15 17:53:13 +02002992 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
2993 Filename to read to load U-Boot when reading from filesystem
2994
2995 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00002996 Filename to read to load kernel uImage when reading
Guillaume GARDET5065b712014-10-15 17:53:13 +02002997 from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00002998
Guillaume GARDET5065b712014-10-15 17:53:13 +02002999 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003000 Filename to read to load kernel argument parameters
Guillaume GARDET5065b712014-10-15 17:53:13 +02003001 when reading from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003002
Scott Wood2b36fbb2012-12-06 13:33:17 +00003003 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3004 Set this for NAND SPL on PPC mpc83xx targets, so that
3005 start.S waits for the rest of the SPL to load before
3006 continuing (the hardware starts execution after just
3007 loading the first page rather than the full 4K).
3008
Prabhakar Kushwaha6e2b9a32014-04-08 19:12:31 +05303009 CONFIG_SPL_SKIP_RELOCATE
3010 Avoid SPL relocation
3011
Scott Woodc352a0c2012-09-20 19:09:07 -05003012 CONFIG_SPL_NAND_BASE
3013 Include nand_base.c in the SPL. Requires
3014 CONFIG_SPL_NAND_DRIVERS.
3015
3016 CONFIG_SPL_NAND_DRIVERS
3017 SPL uses normal NAND drivers, not minimal drivers.
3018
3019 CONFIG_SPL_NAND_ECC
3020 Include standard software ECC in the SPL
3021
Tom Rini36853852012-02-14 07:29:40 +00003022 CONFIG_SPL_NAND_SIMPLE
Scott Wood36c440e2012-09-21 18:35:27 -05003023 Support for NAND boot using simple NAND drivers that
3024 expose the cmd_ctrl() interface.
Tom Rini36853852012-02-14 07:29:40 +00003025
Thomas Gleixner820d24d2016-07-12 20:28:12 +02003026 CONFIG_SPL_UBI
3027 Support for a lightweight UBI (fastmap) scanner and
3028 loader
3029
Heiko Schochercf000272014-10-31 08:31:00 +01003030 CONFIG_SPL_NAND_RAW_ONLY
3031 Support to boot only raw u-boot.bin images. Use this only
3032 if you need to save space.
3033
Ying Zhangdfb2b152013-08-16 15:16:12 +08003034 CONFIG_SPL_COMMON_INIT_DDR
3035 Set for common ddr init with serial presence detect in
3036 SPL binary.
3037
Tom Rini36853852012-02-14 07:29:40 +00003038 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3039 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3040 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3041 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3042 CONFIG_SYS_NAND_ECCBYTES
3043 Defines the size and behavior of the NAND that SPL uses
Scott Wood36c440e2012-09-21 18:35:27 -05003044 to read U-Boot
Tom Rini36853852012-02-14 07:29:40 +00003045
Prabhakar Kushwahaafffcb02013-12-11 12:42:11 +05303046 CONFIG_SPL_NAND_BOOT
3047 Add support NAND boot
3048
Tom Rini36853852012-02-14 07:29:40 +00003049 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood36c440e2012-09-21 18:35:27 -05003050 Location in NAND to read U-Boot from
3051
3052 CONFIG_SYS_NAND_U_BOOT_DST
3053 Location in memory to load U-Boot to
3054
3055 CONFIG_SYS_NAND_U_BOOT_SIZE
3056 Size of image to load
Tom Rini36853852012-02-14 07:29:40 +00003057
3058 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood36c440e2012-09-21 18:35:27 -05003059 Entry point in loaded image to jump to
Tom Rini36853852012-02-14 07:29:40 +00003060
3061 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3062 Define this if you need to first read the OOB and then the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003063 data. This is used, for example, on davinci platforms.
Tom Rini36853852012-02-14 07:29:40 +00003064
3065 CONFIG_SPL_OMAP3_ID_NAND
3066 Support for an OMAP3-specific set of functions to return the
3067 ID and MFR of the first attached NAND chip, if present.
3068
Pavel Machekde997252012-08-30 22:42:11 +02003069 CONFIG_SPL_RAM_DEVICE
3070 Support for running image already present in ram, in SPL binary
3071
Scott Woodeb7bd972012-12-06 13:33:16 +00003072 CONFIG_SPL_PAD_TO
Benoît Thébaudeauf0180722013-04-11 09:35:49 +00003073 Image offset to which the SPL should be padded before appending
3074 the SPL payload. By default, this is defined as
3075 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3076 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3077 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Woodeb7bd972012-12-06 13:33:16 +00003078
Scott Woodf147eb72012-09-21 16:27:32 -05003079 CONFIG_SPL_TARGET
3080 Final target image containing SPL and payload. Some SPLs
3081 use an arch-specific makefile fragment instead, for
3082 example if more than one image needs to be produced.
3083
Simon Glass82d94532013-05-08 08:05:59 +00003084 CONFIG_FIT_SPL_PRINT
3085 Printing information about a FIT image adds quite a bit of
3086 code to SPL. So this is normally disabled in SPL. Use this
3087 option to re-enable it. This will affect the output of the
3088 bootm command when booting a FIT image.
3089
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003090- TPL framework
3091 CONFIG_TPL
3092 Enable building of TPL globally.
3093
3094 CONFIG_TPL_PAD_TO
3095 Image offset to which the TPL should be padded before appending
3096 the TPL payload. By default, this is defined as
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02003097 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3098 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3099 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003100
wdenkc0aa5c52003-12-06 19:49:23 +00003101- Interrupt support (PPC):
3102
wdenk1ebf41e2004-01-02 14:00:00 +00003103 There are common interrupt_init() and timer_interrupt()
3104 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003105 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00003106 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003107 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00003108 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003109 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00003110 specific handling. If board has watchdog / status_led
3111 / other_activity_monitor it works automatically from
3112 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00003113
wdenkc6097192002-11-03 00:24:07 +00003114
Helmut Raigerd5a184b2011-10-20 04:19:47 +00003115Board initialization settings:
3116------------------------------
3117
3118During Initialization u-boot calls a number of board specific functions
3119to allow the preparation of board specific prerequisites, e.g. pin setup
3120before drivers are initialized. To enable these callbacks the
3121following configuration macros have to be defined. Currently this is
3122architecture specific, so please check arch/your_architecture/lib/board.c
3123typically in board_init_f() and board_init_r().
3124
3125- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3126- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3127- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3128- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003129
wdenkc6097192002-11-03 00:24:07 +00003130Configuration Settings:
3131-----------------------
3132
York Sun6c480012014-02-26 17:03:19 -08003133- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3134 Optionally it can be defined to support 64-bit memory commands.
3135
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003136- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003137 undefine this when you're short of memory.
3138
Peter Tyserdfb72b82009-01-27 18:03:12 -06003139- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3140 width of the commands listed in the 'help' command output.
3141
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003142- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003143 prompt for user input.
3144
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003145- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003146
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003147- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003148
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003149- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003150
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003151- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003152 the application (usually a Linux kernel) when it is
3153 booted
3154
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003155- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003156 List of legal baudrate settings for this board.
3157
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003158- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003159 Begin and End addresses of the area used by the
3160 simple memory test.
3161
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003162- CONFIG_SYS_ALT_MEMTEST:
wdenk57b2d802003-06-27 21:31:46 +00003163 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003164
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003165- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5958f4a2003-09-18 09:21:33 +00003166 Scratch address used by the alternate memory test
3167 You only need to set this if address zero isn't writeable
3168
York Sun5d286cd2015-12-04 11:57:07 -08003169- CONFIG_SYS_MEM_RESERVE_SECURE
York Sun1ef95cc2016-06-24 16:46:18 -07003170 Only implemented for ARMv8 for now.
York Sun5d286cd2015-12-04 11:57:07 -08003171 If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
3172 is substracted from total RAM and won't be reported to OS.
3173 This memory can be used as secure memory. A variable
York Sun1ef95cc2016-06-24 16:46:18 -07003174 gd->arch.secure_ram is used to track the location. In systems
York Sun5d286cd2015-12-04 11:57:07 -08003175 the RAM base is not zero, or RAM is divided into banks,
3176 this variable needs to be recalcuated to get the address.
3177
York Sun50739372015-12-07 11:05:29 -08003178- CONFIG_SYS_MEM_TOP_HIDE:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003179 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01003180 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003181 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01003182 fixing up gd->ram_size the Linux kernel should gets passed
3183 the now "corrected" memory size and won't touch it either.
3184 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01003185 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01003186 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01003187 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01003188
3189 This option can be used as a workaround for the 440EPx/GRx
3190 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3191 be touched.
3192
3193 WARNING: Please make sure that this value is a multiple of
3194 the Linux page size (normally 4k). If this is not the case,
3195 then the end address of the Linux memory will be located at a
3196 non page size aligned address and this could cause major
3197 problems.
3198
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003199- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003200 Enable temporary baudrate change while serial download
3201
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003202- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003203 Physical start address of SDRAM. _Must_ be 0 here.
3204
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003205- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003206 Physical start address of Flash memory.
3207
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003208- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003209 Physical start address of boot monitor code (set by
3210 make config files to be same as the text base address
Wolfgang Denk0708bc62010-10-07 21:51:12 +02003211 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003212 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003213
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003214- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00003215 Size of memory reserved for monitor code, used to
3216 determine _at_compile_time_ (!) if the environment is
3217 embedded within the U-Boot image, or in a separate
3218 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003219
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003220- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003221 Size of DRAM reserved for malloc() use.
3222
Simon Glass863e4042014-07-10 22:23:28 -06003223- CONFIG_SYS_MALLOC_F_LEN
3224 Size of the malloc() pool for use before relocation. If
3225 this is defined, then a very simple malloc() implementation
3226 will become available before relocation. The address is just
3227 below the global data, and the stack is moved down to make
3228 space.
3229
3230 This feature allocates regions with increasing addresses
3231 within the region. calloc() is supported, but realloc()
3232 is not available. free() is supported but does nothing.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003233 The memory will be freed (or in fact just forgotten) when
Simon Glass863e4042014-07-10 22:23:28 -06003234 U-Boot relocates itself.
3235
Simon Glass9fa901b2014-11-10 17:16:54 -07003236- CONFIG_SYS_MALLOC_SIMPLE
3237 Provides a simple and small malloc() and calloc() for those
3238 boards which do not use the full malloc in SPL (which is
3239 enabled with CONFIG_SYS_SPL_MALLOC_START).
3240
Thierry Redingc97d9742014-12-09 22:25:22 -07003241- CONFIG_SYS_NONCACHED_MEMORY:
3242 Size of non-cached memory area. This area of memory will be
3243 typically located right below the malloc() area and mapped
3244 uncached in the MMU. This is useful for drivers that would
3245 otherwise require a lot of explicit cache maintenance. For
3246 some drivers it's also impossible to properly maintain the
3247 cache. For example if the regions that need to be flushed
3248 are not a multiple of the cache-line size, *and* padding
3249 cannot be allocated between the regions to align them (i.e.
3250 if the HW requires a contiguous array of regions, and the
3251 size of each region is not cache-aligned), then a flush of
3252 one region may result in overwriting data that hardware has
3253 written to another region in the same cache-line. This can
3254 happen for example in network drivers where descriptors for
3255 buffers are typically smaller than the CPU cache-line (e.g.
3256 16 bytes vs. 32 or 64 bytes).
3257
3258 Non-cached memory is only supported on 32-bit ARM at present.
3259
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003260- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01003261 Normally compressed uImages are limited to an
3262 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003263 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01003264 to adjust this setting to your needs.
3265
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003266- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003267 Maximum size of memory mapped by the startup code of
3268 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003269 the Linux kernel (bd_info, boot arguments, FDT blob if
3270 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003271 environment variable is defined and non-zero. In such case
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003272 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denk092ae952011-10-26 10:21:21 +00003273 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likely26396382011-03-28 09:58:43 +00003274 variable "bootm_mapsize" will override the value of
3275 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3276 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003277
John Rigbyeea8e692010-10-13 13:57:35 -06003278- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3279 Enable initrd_high functionality. If defined then the
3280 initrd_high feature is enabled and the bootm ramdisk subcommand
3281 is enabled.
3282
3283- CONFIG_SYS_BOOT_GET_CMDLINE:
3284 Enables allocating and saving kernel cmdline in space between
3285 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3286
3287- CONFIG_SYS_BOOT_GET_KBD:
3288 Enables allocating and saving a kernel copy of the bd_info in
3289 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3290
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003291- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003292 Max number of Flash memory banks
3293
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003294- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003295 Max number of sectors on a Flash chip
3296
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003297- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003298 Timeout for Flash erase operations (in ms)
3299
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003300- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003301 Timeout for Flash write operations (in ms)
3302
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003303- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003304 Timeout for Flash set sector lock bit operation (in ms)
3305
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003306- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003307 Timeout for Flash clear lock bits operation (in ms)
3308
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003309- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00003310 If defined, hardware flash sectors protection is used
3311 instead of U-Boot software protection.
3312
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003313- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003314
3315 Enable TFTP transfers directly to flash memory;
3316 without this option such a download has to be
3317 performed in two steps: (1) download to RAM, and (2)
3318 copy from RAM to flash.
3319
3320 The two-step approach is usually more reliable, since
3321 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003322 the flash, but in some situations (when system RAM is
3323 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003324 downloaded image) this option may be very useful.
3325
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003326- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00003327 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00003328 common flash structure for storing flash geometry.
3329
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02003330- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00003331 This option also enables the building of the cfi_flash driver
3332 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003333
Piotr Ziecik3e939e92008-11-17 15:57:58 +01003334- CONFIG_FLASH_CFI_MTD
3335 This option enables the building of the cfi_mtd driver
3336 in the drivers directory. The driver exports CFI flash
3337 to the MTD layer.
3338
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003339- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02003340 Use buffered writes to flash.
3341
3342- CONFIG_FLASH_SPANSION_S29WS_N
3343 s29ws-n MirrorBit flash has non-standard addresses for buffered
3344 write commands.
3345
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003346- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01003347 If this option is defined, the common CFI flash doesn't
3348 print it's warning upon not recognized FLASH banks. This
3349 is useful, if some of the configured banks are only
3350 optionally available.
3351
Jerry Van Barenaae73572008-03-08 13:48:01 -05003352- CONFIG_FLASH_SHOW_PROGRESS
3353 If defined (must be an integer), print out countdown
3354 digits and dots. Recommended value: 45 (9..1) for 80
3355 column displays, 15 (3..1) for 40 column displays.
3356
Stefan Roesed20cba52013-04-04 15:53:14 +02003357- CONFIG_FLASH_VERIFY
3358 If defined, the content of the flash (destination) is compared
3359 against the source after the write operation. An error message
3360 will be printed when the contents are not identical.
3361 Please note that this option is useless in nearly all cases,
3362 since such flash programming errors usually are detected earlier
3363 while unprotecting/erasing/programming. Please only enable
3364 this option if you really know what you are doing.
3365
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003366- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003367 Defines the number of Ethernet receive buffers. On some
3368 Ethernet controllers it is recommended to set this value
stroese94ef1cf2003-06-05 15:39:44 +00003369 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3370 buffers can be full shortly after enabling the interface
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003371 on high Ethernet traffic.
stroese94ef1cf2003-06-05 15:39:44 +00003372 Defaults to 4 if not defined.
3373
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003374- CONFIG_ENV_MAX_ENTRIES
3375
Wolfgang Denk1136f692010-10-27 22:48:30 +02003376 Maximum number of entries in the hash table that is used
3377 internally to store the environment settings. The default
3378 setting is supposed to be generous and should work in most
3379 cases. This setting can be used to tune behaviour; see
3380 lib/hashtable.c for details.
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003381
Joe Hershberger71497d02012-12-11 22:16:31 -06003382- CONFIG_ENV_FLAGS_LIST_DEFAULT
3383- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003384 Enable validation of the values given to environment variables when
Joe Hershberger71497d02012-12-11 22:16:31 -06003385 calling env set. Variables can be restricted to only decimal,
3386 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3387 the variables can also be restricted to IP address or MAC address.
3388
3389 The format of the list is:
3390 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003391 access_attribute = [a|r|o|c]
3392 attributes = type_attribute[access_attribute]
Joe Hershberger71497d02012-12-11 22:16:31 -06003393 entry = variable_name[:attributes]
3394 list = entry[,list]
3395
3396 The type attributes are:
3397 s - String (default)
3398 d - Decimal
3399 x - Hexadecimal
3400 b - Boolean ([1yYtT|0nNfF])
3401 i - IP address
3402 m - MAC address
3403
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003404 The access attributes are:
3405 a - Any (default)
3406 r - Read-only
3407 o - Write-once
3408 c - Change-default
3409
Joe Hershberger71497d02012-12-11 22:16:31 -06003410 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3411 Define this to a list (string) to define the ".flags"
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003412 environment variable in the default or embedded environment.
Joe Hershberger71497d02012-12-11 22:16:31 -06003413
3414 - CONFIG_ENV_FLAGS_LIST_STATIC
3415 Define this to a list (string) to define validation that
3416 should be done if an entry is not found in the ".flags"
3417 environment variable. To override a setting in the static
3418 list, simply add an entry for the same variable name to the
3419 ".flags" variable.
3420
Joe Hershberger6db9fd42015-05-20 14:27:20 -05003421 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
3422 regular expression. This allows multiple variables to define the same
3423 flags without explicitly listing them for each variable.
3424
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003425- CONFIG_ENV_ACCESS_IGNORE_FORCE
3426 If defined, don't allow the -f switch to env set override variable
3427 access flags.
3428
Gabe Black3687fe42014-10-15 04:38:30 -06003429- CONFIG_USE_STDINT
3430 If stdint.h is available with your toolchain you can define this
3431 option to enable it. You can provide option 'USE_STDINT=1' when
3432 building U-Boot to enable this.
3433
wdenkc6097192002-11-03 00:24:07 +00003434The following definitions that deal with the placement and management
3435of environment data (variable area); in general, we support the
3436following configurations:
3437
Mike Frysinger63b8f122011-07-08 10:44:25 +00003438- CONFIG_BUILD_ENVCRC:
3439
3440 Builds up envcrc with the target environment so that external utils
3441 may easily extract it and embed it in final U-Boot images.
3442
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02003443- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00003444
3445 Define this if the environment is in flash memory.
3446
3447 a) The environment occupies one whole flash sector, which is
3448 "embedded" in the text segment with the U-Boot code. This
3449 happens usually with "bottom boot sector" or "top boot
3450 sector" type flash chips, which have several smaller
3451 sectors at the start or the end. For instance, such a
3452 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3453 such a case you would place the environment in one of the
3454 4 kB sectors - with U-Boot code before and after it. With
3455 "top boot sector" type flash chips, you would put the
3456 environment in one of the last sectors, leaving a gap
3457 between U-Boot and the environment.
3458
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003459 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003460
3461 Offset of environment data (variable area) to the
3462 beginning of flash memory; for instance, with bottom boot
3463 type flash chips the second sector can be used: the offset
3464 for this sector is given here.
3465
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003466 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00003467
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003468 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003469
3470 This is just another way to specify the start address of
3471 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003472 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00003473
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003474 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003475
3476 Size of the sector containing the environment.
3477
3478
3479 b) Sometimes flash chips have few, equal sized, BIG sectors.
3480 In such a case you don't want to spend a whole sector for
3481 the environment.
3482
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003483 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003484
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02003485 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003486 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00003487 of this flash sector for the environment. This saves
3488 memory for the RAM copy of the environment.
3489
3490 It may also save flash memory if you decide to use this
3491 when your environment is "embedded" within U-Boot code,
3492 since then the remainder of the flash sector could be used
3493 for U-Boot code. It should be pointed out that this is
3494 STRONGLY DISCOURAGED from a robustness point of view:
3495 updating the environment in flash makes it always
3496 necessary to erase the WHOLE sector. If something goes
3497 wrong before the contents has been restored from a copy in
3498 RAM, your target system will be dead.
3499
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003500 - CONFIG_ENV_ADDR_REDUND
3501 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00003502
wdenk4a5c8a72003-03-06 00:02:04 +00003503 These settings describe a second storage area used to hold
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003504 a redundant copy of the environment data, so that there is
wdenkb02744a2003-04-05 00:53:31 +00003505 a valid backup copy in case there is a power failure during
wdenk4a5c8a72003-03-06 00:02:04 +00003506 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00003507
3508BE CAREFUL! Any changes to the flash layout, and some changes to the
3509source code will make it necessary to adapt <board>/u-boot.lds*
3510accordingly!
3511
3512
Jean-Christophe PLAGNIOL-VILLARDfdb79c32008-09-10 22:47:59 +02003513- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00003514
3515 Define this if you have some non-volatile memory device
3516 (NVRAM, battery buffered SRAM) which you want to use for the
3517 environment.
3518
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003519 - CONFIG_ENV_ADDR:
3520 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003521
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003522 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00003523 want to use for environment. It is assumed that this memory
3524 can just be read and written to, without any special
3525 provision.
3526
3527BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003528in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003529console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00003530U-Boot will hang.
3531
3532Please note that even with NVRAM we still use a copy of the
3533environment in RAM: we could work on NVRAM directly, but we want to
3534keep settings there always unmodified except somebody uses "saveenv"
3535to save the current settings.
3536
3537
Jean-Christophe PLAGNIOL-VILLARDe46af642008-09-05 09:19:30 +02003538- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00003539
3540 Use this if you have an EEPROM or similar serial access
3541 device and a driver for it.
3542
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003543 - CONFIG_ENV_OFFSET:
3544 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003545
3546 These two #defines specify the offset and size of the
3547 environment area within the total memory of your EEPROM.
3548
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003549 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003550 If defined, specified the chip address of the EEPROM device.
3551 The default address is zero.
3552
Christian Gmeiner4c5b7542015-02-11 15:19:31 +01003553 - CONFIG_SYS_I2C_EEPROM_BUS:
3554 If defined, specified the i2c bus of the EEPROM device.
3555
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003556 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00003557 If defined, the number of bits used to address bytes in a
3558 single page in the EEPROM device. A 64 byte page, for example
3559 would require six bits.
3560
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003561 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00003562 If defined, the number of milliseconds to delay between
wdenk544e9732004-02-06 23:19:44 +00003563 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00003564
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003565 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00003566 The length in bytes of the EEPROM memory array address. Note
3567 that this is NOT the chip address length!
3568
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003569 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk20c98a62004-04-23 20:32:05 +00003570 EEPROM chips that implement "address overflow" are ones
3571 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
3572 address and the extra bits end up in the "chip address" bit
3573 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
3574 byte chips.
3575
3576 Note that we consider the length of the address field to
3577 still be one byte because the extra address bits are hidden
3578 in the chip address.
3579
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003580 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003581 The size in bytes of the EEPROM device.
3582
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01003583 - CONFIG_ENV_EEPROM_IS_ON_I2C
3584 define this, if you have I2C and SPI activated, and your
3585 EEPROM, which holds the environment, is on the I2C bus.
3586
3587 - CONFIG_I2C_ENV_EEPROM_BUS
3588 if you have an Environment on an EEPROM reached over
3589 I2C muxes, you can define here, how to reach this
3590 EEPROM. For example:
3591
Heiko Schocher479a4cf2013-01-29 08:53:15 +01003592 #define CONFIG_I2C_ENV_EEPROM_BUS 1
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01003593
3594 EEPROM which holds the environment, is reached over
3595 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00003596
Jean-Christophe PLAGNIOL-VILLARD2b14d2b2008-09-10 22:47:58 +02003597- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk86765902003-12-06 23:55:10 +00003598
wdenk1ebf41e2004-01-02 14:00:00 +00003599 Define this if you have a DataFlash memory device which you
wdenk86765902003-12-06 23:55:10 +00003600 want to use for the environment.
3601
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003602 - CONFIG_ENV_OFFSET:
3603 - CONFIG_ENV_ADDR:
3604 - CONFIG_ENV_SIZE:
wdenk86765902003-12-06 23:55:10 +00003605
3606 These three #defines specify the offset and size of the
3607 environment area within the total memory of your DataFlash placed
3608 at the specified address.
3609
Wu, Josh76db7bf2014-07-01 19:30:13 +08003610- CONFIG_ENV_IS_IN_SPI_FLASH:
3611
3612 Define this if you have a SPI Flash memory device which you
3613 want to use for the environment.
3614
3615 - CONFIG_ENV_OFFSET:
3616 - CONFIG_ENV_SIZE:
3617
3618 These two #defines specify the offset and size of the
3619 environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
3620 aligned to an erase sector boundary.
3621
3622 - CONFIG_ENV_SECT_SIZE:
3623
3624 Define the SPI flash's sector size.
3625
3626 - CONFIG_ENV_OFFSET_REDUND (optional):
3627
3628 This setting describes a second storage area of CONFIG_ENV_SIZE
3629 size used to hold a redundant copy of the environment data, so
3630 that there is a valid backup copy in case there is a power failure
Simon Glass5b9a5172016-10-02 18:00:58 -06003631 during a "saveenv" operation. CONFIG_ENV_OFFSET_REDUND must be
Wu, Josh76db7bf2014-07-01 19:30:13 +08003632 aligned to an erase sector boundary.
3633
3634 - CONFIG_ENV_SPI_BUS (optional):
3635 - CONFIG_ENV_SPI_CS (optional):
3636
3637 Define the SPI bus and chip select. If not defined they will be 0.
3638
3639 - CONFIG_ENV_SPI_MAX_HZ (optional):
3640
3641 Define the SPI max work clock. If not defined then use 1MHz.
3642
3643 - CONFIG_ENV_SPI_MODE (optional):
3644
3645 Define the SPI work mode. If not defined then use SPI_MODE_3.
3646
Liu Gang85bcd732012-03-08 00:33:20 +00003647- CONFIG_ENV_IS_IN_REMOTE:
3648
3649 Define this if you have a remote memory space which you
3650 want to use for the local device's environment.
3651
3652 - CONFIG_ENV_ADDR:
3653 - CONFIG_ENV_SIZE:
3654
3655 These two #defines specify the address and size of the
3656 environment area within the remote memory space. The
3657 local device can get the environment from remote memory
Liu Gang357bf5a2012-08-09 05:10:01 +00003658 space by SRIO or PCIE links.
Liu Gang85bcd732012-03-08 00:33:20 +00003659
3660BE CAREFUL! For some special cases, the local device can not use
3661"saveenv" command. For example, the local device will get the
Liu Gang357bf5a2012-08-09 05:10:01 +00003662environment stored in a remote NOR flash by SRIO or PCIE link,
3663but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang85bcd732012-03-08 00:33:20 +00003664
Jean-Christophe PLAGNIOL-VILLARDdda84dd2008-09-10 22:47:58 +02003665- CONFIG_ENV_IS_IN_NAND:
wdenk79b59372004-06-09 14:58:14 +00003666
3667 Define this if you have a NAND device which you want to use
3668 for the environment.
3669
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003670 - CONFIG_ENV_OFFSET:
3671 - CONFIG_ENV_SIZE:
wdenk79b59372004-06-09 14:58:14 +00003672
3673 These two #defines specify the offset and size of the environment
Scott Wood08239322010-09-17 14:38:37 -05003674 area within the first NAND device. CONFIG_ENV_OFFSET must be
3675 aligned to an erase block boundary.
wdenk86765902003-12-06 23:55:10 +00003676
Scott Wood08239322010-09-17 14:38:37 -05003677 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01003678
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003679 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Wood08239322010-09-17 14:38:37 -05003680 size used to hold a redundant copy of the environment data, so
3681 that there is a valid backup copy in case there is a power failure
Simon Glass5b9a5172016-10-02 18:00:58 -06003682 during a "saveenv" operation. CONFIG_ENV_OFFSET_REDUND must be
Scott Wood08239322010-09-17 14:38:37 -05003683 aligned to an erase block boundary.
3684
3685 - CONFIG_ENV_RANGE (optional):
3686
3687 Specifies the length of the region in which the environment
3688 can be written. This should be a multiple of the NAND device's
3689 block size. Specifying a range with more erase blocks than
3690 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3691 the range to be avoided.
3692
3693 - CONFIG_ENV_OFFSET_OOB (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01003694
Scott Wood08239322010-09-17 14:38:37 -05003695 Enables support for dynamically retrieving the offset of the
3696 environment from block zero's out-of-band data. The
3697 "nand env.oob" command can be used to record this offset.
3698 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3699 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01003700
Guennadi Liakhovetskifad24442009-05-18 16:07:22 +02003701- CONFIG_NAND_ENV_DST
3702
3703 Defines address in RAM to which the nand_spl code should copy the
3704 environment. If redundant environment is used, it will be copied to
3705 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3706
Joe Hershberger0c5faa82013-04-08 10:32:51 +00003707- CONFIG_ENV_IS_IN_UBI:
3708
3709 Define this if you have an UBI volume that you want to use for the
3710 environment. This has the benefit of wear-leveling the environment
3711 accesses, which is important on NAND.
3712
3713 - CONFIG_ENV_UBI_PART:
3714
3715 Define this to a string that is the mtd partition containing the UBI.
3716
3717 - CONFIG_ENV_UBI_VOLUME:
3718
3719 Define this to the name of the volume that you want to store the
3720 environment in.
3721
Joe Hershbergerdb14e862013-04-08 10:32:52 +00003722 - CONFIG_ENV_UBI_VOLUME_REDUND:
3723
3724 Define this to the name of another volume to store a second copy of
3725 the environment in. This will enable redundant environments in UBI.
3726 It is assumed that both volumes are in the same MTD partition.
3727
Joe Hershberger0c5faa82013-04-08 10:32:51 +00003728 - CONFIG_UBI_SILENCE_MSG
3729 - CONFIG_UBIFS_SILENCE_MSG
3730
3731 You will probably want to define these to avoid a really noisy system
3732 when storing the env in UBI.
3733
Wu, Josha7d0c872014-06-24 17:31:03 +08003734- CONFIG_ENV_IS_IN_FAT:
3735 Define this if you want to use the FAT file system for the environment.
3736
3737 - FAT_ENV_INTERFACE:
3738
3739 Define this to a string that is the name of the block device.
3740
Nicolae Rosia86811f22016-11-21 17:33:58 +02003741 - FAT_ENV_DEVICE_AND_PART:
Wu, Josha7d0c872014-06-24 17:31:03 +08003742
3743 Define this to a string to specify the partition of the device. It can
3744 be as following:
3745
3746 "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
3747 - "D:P": device D partition P. Error occurs if device D has no
3748 partition table.
3749 - "D:0": device D.
3750 - "D" or "D:": device D partition 1 if device D has partition
3751 table, or the whole device D if has no partition
3752 table.
3753 - "D:auto": first partition in device D with bootable flag set.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003754 If none, first valid partition in device D. If no
Wu, Josha7d0c872014-06-24 17:31:03 +08003755 partition table then means device D.
3756
3757 - FAT_ENV_FILE:
3758
3759 It's a string of the FAT file name. This file use to store the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003760 environment.
Wu, Josha7d0c872014-06-24 17:31:03 +08003761
3762 - CONFIG_FAT_WRITE:
Tom Rinid8532af2017-06-02 11:03:50 -04003763 This must be enabled. Otherwise it cannot save the environment file.
Wu, Josha7d0c872014-06-24 17:31:03 +08003764
Stephen Warreneedcacd2013-06-11 15:14:00 -06003765- CONFIG_ENV_IS_IN_MMC:
3766
3767 Define this if you have an MMC device which you want to use for the
3768 environment.
3769
3770 - CONFIG_SYS_MMC_ENV_DEV:
3771
3772 Specifies which MMC device the environment is stored in.
3773
3774 - CONFIG_SYS_MMC_ENV_PART (optional):
3775
3776 Specifies which MMC partition the environment is stored in. If not
3777 set, defaults to partition 0, the user area. Common values might be
3778 1 (first MMC boot partition), 2 (second MMC boot partition).
3779
3780 - CONFIG_ENV_OFFSET:
3781 - CONFIG_ENV_SIZE:
3782
3783 These two #defines specify the offset and size of the environment
3784 area within the specified MMC device.
3785
Stephen Warren24dc2032013-06-11 15:14:02 -06003786 If offset is positive (the usual case), it is treated as relative to
3787 the start of the MMC partition. If offset is negative, it is treated
3788 as relative to the end of the MMC partition. This can be useful if
3789 your board may be fitted with different MMC devices, which have
3790 different sizes for the MMC partitions, and you always want the
3791 environment placed at the very end of the partition, to leave the
3792 maximum possible space before it, to store other data.
3793
Stephen Warreneedcacd2013-06-11 15:14:00 -06003794 These two values are in units of bytes, but must be aligned to an
3795 MMC sector boundary.
3796
3797 - CONFIG_ENV_OFFSET_REDUND (optional):
3798
3799 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
3800 hold a redundant copy of the environment data. This provides a
3801 valid backup copy in case the other copy is corrupted, e.g. due
3802 to a power failure during a "saveenv" operation.
3803
Stephen Warren24dc2032013-06-11 15:14:02 -06003804 This value may also be positive or negative; this is handled in the
3805 same way as CONFIG_ENV_OFFSET.
3806
Stephen Warreneedcacd2013-06-11 15:14:00 -06003807 This value is also in units of bytes, but must also be aligned to
3808 an MMC sector boundary.
3809
3810 - CONFIG_ENV_SIZE_REDUND (optional):
3811
3812 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
3813 set. If this value is set, it must be set to the same value as
3814 CONFIG_ENV_SIZE.
3815
Bruce Adleredecc942007-11-02 13:15:42 -07003816Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00003817has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denk76af2782010-07-24 21:55:43 +02003818created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00003819until then to read environment variables.
3820
wdenk8dba0502003-03-31 16:34:49 +00003821The environment is protected by a CRC32 checksum. Before the monitor
3822is relocated into RAM, as a result of a bad CRC you will be working
3823with the compiled-in default environment - *silently*!!! [This is
3824necessary, because the first environment variable we need is the
3825"baudrate" setting for the console - if we have a bad CRC, we don't
3826have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00003827
3828Note: once the monitor has been relocated, then it will complain if
3829the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00003830use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00003831
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003832- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk9c53f402003-10-15 23:53:47 +00003833 Echo the inverted Ethernet link state to the fault LED.
wdenk49c3f672003-10-08 22:33:00 +00003834
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003835 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenk49c3f672003-10-08 22:33:00 +00003836 also needs to be defined.
3837
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003838- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00003839 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00003840
Ron Madriddfa028a2009-02-18 14:30:44 -08003841- CONFIG_NS16550_MIN_FUNCTIONS:
3842 Define this if you desire to only have use of the NS16550_init
3843 and NS16550_putc functions for the serial driver located at
3844 drivers/serial/ns16550.c. This option is useful for saving
3845 space for already greatly restricted images, including but not
3846 limited to NAND_SPL configurations.
3847
Simon Glass28a9e332012-11-30 13:01:18 +00003848- CONFIG_DISPLAY_BOARDINFO
3849 Display information about the board that U-Boot is running on
3850 when U-Boot starts up. The board function checkboard() is called
3851 to do this.
3852
Simon Glasse8822012012-11-30 13:01:19 +00003853- CONFIG_DISPLAY_BOARDINFO_LATE
3854 Similar to the previous option, but display this information
3855 later, once stdio is running and output goes to the LCD, if
3856 present.
3857
Sascha Silbe4b9c17c2013-08-11 16:40:43 +02003858- CONFIG_BOARD_SIZE_LIMIT:
3859 Maximum size of the U-Boot image. When defined, the
3860 build system checks that the actual size does not
3861 exceed it.
3862
wdenkc6097192002-11-03 00:24:07 +00003863Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00003864---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003865
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003866- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003867 Cache Line Size of the CPU.
3868
Timur Tabid8f341c2011-08-04 18:03:41 -05003869- CONFIG_SYS_CCSRBAR_DEFAULT:
3870 Default (power-on reset) physical address of CCSR on Freescale
3871 PowerPC SOCs.
3872
3873- CONFIG_SYS_CCSRBAR:
3874 Virtual address of CCSR. On a 32-bit build, this is typically
3875 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3876
Timur Tabid8f341c2011-08-04 18:03:41 -05003877- CONFIG_SYS_CCSRBAR_PHYS:
3878 Physical address of CCSR. CCSR can be relocated to a new
3879 physical address, if desired. In this case, this macro should
Wolfgang Denk092ae952011-10-26 10:21:21 +00003880 be set to that address. Otherwise, it should be set to the
Timur Tabid8f341c2011-08-04 18:03:41 -05003881 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
3882 is typically relocated on 36-bit builds. It is recommended
3883 that this macro be defined via the _HIGH and _LOW macros:
3884
3885 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3886 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3887
3888- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003889 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
3890 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabid8f341c2011-08-04 18:03:41 -05003891 used in assembly code, so it must not contain typecasts or
3892 integer size suffixes (e.g. "ULL").
3893
3894- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3895 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
3896 used in assembly code, so it must not contain typecasts or
3897 integer size suffixes (e.g. "ULL").
3898
3899- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3900 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3901 forced to a value that ensures that CCSR is not relocated.
3902
wdenk1272e232002-11-10 22:06:23 +00003903- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003904 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk1272e232002-11-10 22:06:23 +00003905
3906 the default drive number (default value 0)
3907
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003908 CONFIG_SYS_ISA_IO_STRIDE
wdenk1272e232002-11-10 22:06:23 +00003909
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003910 defines the spacing between FDC chipset registers
wdenk1272e232002-11-10 22:06:23 +00003911 (default value 1)
3912
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003913 CONFIG_SYS_ISA_IO_OFFSET
wdenk1272e232002-11-10 22:06:23 +00003914
wdenk4a5c8a72003-03-06 00:02:04 +00003915 defines the offset of register from address. It
3916 depends on which part of the data bus is connected to
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003917 the FDC chipset. (default value 0)
wdenk1272e232002-11-10 22:06:23 +00003918
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003919 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
3920 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk4a5c8a72003-03-06 00:02:04 +00003921 default value.
wdenk1272e232002-11-10 22:06:23 +00003922
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003923 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk4a5c8a72003-03-06 00:02:04 +00003924 fdc_hw_init() is called at the beginning of the FDC
3925 setup. fdc_hw_init() must be provided by the board
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003926 source code. It is used to make hardware-dependent
wdenk4a5c8a72003-03-06 00:02:04 +00003927 initializations.
wdenk1272e232002-11-10 22:06:23 +00003928
Macpaul Lind1e49942011-04-11 20:45:32 +00003929- CONFIG_IDE_AHB:
3930 Most IDE controllers were designed to be connected with PCI
3931 interface. Only few of them were designed for AHB interface.
3932 When software is doing ATA command and data transfer to
3933 IDE devices through IDE-AHB controller, some additional
3934 registers accessing to these kind of IDE-AHB controller
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003935 is required.
Macpaul Lind1e49942011-04-11 20:45:32 +00003936
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003937- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00003938 DO NOT CHANGE unless you know exactly what you're
Heiko Schocher65d94db2017-06-07 17:33:09 +02003939 doing! (11-4) [82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00003940
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003941- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003942
wdenkeb20ad32003-09-05 23:19:14 +00003943 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00003944 initial data and stack; please note that this must be
3945 writable memory that is working WITHOUT special
3946 initialization, i. e. you CANNOT use normal RAM which
3947 will become available only after programming the
3948 memory controller and running certain initialization
3949 sequences.
3950
3951 U-Boot uses the following memory types:
wdenkc6097192002-11-03 00:24:07 +00003952
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003953- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003954
3955 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003956 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
3957 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00003958 data is located at the end of the available space
Wolfgang Denk1c2e98e2010-10-26 13:32:32 +02003959 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Simon Glass9a6ac8b2016-10-02 18:01:06 -06003960 GENERATED_GBL_DATA_SIZE), and the initial stack is just
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003961 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
3962 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00003963
3964 Note:
3965 On the MPC824X (or other systems that use the data
3966 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003967 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00003968 point to an otherwise UNUSED address space between
3969 the top of RAM and the start of the PCI space.
3970
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003971- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00003972
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003973- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00003974 SDRAM timing
3975
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003976- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00003977 periodic timer for refresh
3978
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003979- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
3980 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
3981 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
3982 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003983 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3984
3985- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003986 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
3987 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003988 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3989
Andrew Sharp61d47ca2012-08-29 14:16:32 +00003990- CONFIG_PCI_ENUM_ONLY
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003991 Only scan through and get the devices on the buses.
Andrew Sharp61d47ca2012-08-29 14:16:32 +00003992 Don't do any setup work, presumably because someone or
3993 something has already done it, and we don't need to do it
3994 a second time. Useful for platforms that are pre-booted
3995 by coreboot or similar.
3996
Gabor Juhosb4458732013-05-30 07:06:12 +00003997- CONFIG_PCI_INDIRECT_BRIDGE:
3998 Enable support for indirect PCI bridges.
3999
Kumar Gala8975d7a2010-12-30 12:09:53 -06004000- CONFIG_SYS_SRIO:
4001 Chip has SRIO or not
4002
4003- CONFIG_SRIO1:
4004 Board has SRIO 1 port available
4005
4006- CONFIG_SRIO2:
4007 Board has SRIO 2 port available
4008
Liu Gang27afb9c2013-05-07 16:30:46 +08004009- CONFIG_SRIO_PCIE_BOOT_MASTER
4010 Board can support master function for Boot from SRIO and PCIE
4011
Kumar Gala8975d7a2010-12-30 12:09:53 -06004012- CONFIG_SYS_SRIOn_MEM_VIRT:
4013 Virtual Address of SRIO port 'n' memory region
4014
4015- CONFIG_SYS_SRIOn_MEM_PHYS:
4016 Physical Address of SRIO port 'n' memory region
4017
4018- CONFIG_SYS_SRIOn_MEM_SIZE:
4019 Size of SRIO port 'n' memory region
4020
Fabio Estevamf17e8782013-04-11 09:35:34 +00004021- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4022 Defined to tell the NAND controller that the NAND chip is using
4023 a 16 bit bus.
4024 Not all NAND drivers use this symbol.
Fabio Estevam417052b2013-04-11 09:35:35 +00004025 Example of drivers that use it:
Fabio Estevamf17e8782013-04-11 09:35:34 +00004026 - drivers/mtd/nand/ndfc.c
Fabio Estevam417052b2013-04-11 09:35:35 +00004027 - drivers/mtd/nand/mxc_nand.c
Alex Watermancd6aae32011-05-19 15:08:36 -04004028
4029- CONFIG_SYS_NDFC_EBC0_CFG
4030 Sets the EBC0_CFG register for the NDFC. If not defined
4031 a default value will be used.
4032
Ben Warren45657152006-09-07 16:50:54 -04004033- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004034 Get DDR timing information from an I2C EEPROM. Common
4035 with pluggable memory modules such as SODIMMs
4036
Ben Warren45657152006-09-07 16:50:54 -04004037 SPD_EEPROM_ADDRESS
4038 I2C address of the SPD EEPROM
4039
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004040- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004041 If SPD EEPROM is on an I2C bus other than the first
4042 one, specify here. Note that the value must resolve
4043 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04004044
York Sune73cc042011-06-07 09:42:16 +08004045- CONFIG_SYS_DDR_RAW_TIMING
4046 Get DDR timing information from other than SPD. Common with
4047 soldered DDR chips onboard without SPD. DDR raw timing
4048 parameters are extracted from datasheet and hard-coded into
4049 header files or board specific files.
4050
York Sunbd495cf2011-09-16 13:21:35 -07004051- CONFIG_FSL_DDR_INTERACTIVE
4052 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4053
York Sun8ced0502015-01-06 13:18:55 -08004054- CONFIG_FSL_DDR_SYNC_REFRESH
4055 Enable sync of refresh for multiple controllers.
4056
York Sunb6a35f82015-03-19 09:30:28 -07004057- CONFIG_FSL_DDR_BIST
4058 Enable built-in memory test for Freescale DDR controllers.
4059
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004060- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004061 Only for 83xx systems. If specified, then DDR should
4062 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06004063
wdenk6203e402004-04-18 10:13:26 +00004064- CONFIG_RMII
4065 Enable RMII mode for all FECs.
4066 Note that this is a global option, we can't
4067 have one FEC in standard MII mode and another in RMII mode.
4068
wdenk20c98a62004-04-23 20:32:05 +00004069- CONFIG_CRC32_VERIFY
4070 Add a verify option to the crc32 command.
4071 The syntax is:
4072
4073 => crc32 -v <address> <count> <crc32>
4074
4075 Where address/count indicate a memory area
4076 and crc32 is the correct crc32 which the
4077 area should have.
4078
wdenk64519362004-07-11 17:40:54 +00004079- CONFIG_LOOPW
4080 Add the "loopw" memory command. This only takes effect if
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004081 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk64519362004-07-11 17:40:54 +00004082
stroesecc3af832004-12-16 18:46:55 +00004083- CONFIG_MX_CYCLIC
4084 Add the "mdc" and "mwc" memory commands. These are cyclic
4085 "md/mw" commands.
4086 Examples:
4087
wdenk07d7e6b2004-12-16 21:44:03 +00004088 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00004089 This command will print 4 bytes (10,11,12,13) each 500 ms.
4090
wdenk07d7e6b2004-12-16 21:44:03 +00004091 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00004092 This command will write 12345678 to address 100 all 10 ms.
4093
wdenk07d7e6b2004-12-16 21:44:03 +00004094 This only takes effect if the memory commands are activated
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004095 globally (CONFIG_CMD_MEM).
stroesecc3af832004-12-16 18:46:55 +00004096
wdenk3d3d99f2005-04-04 12:44:11 +00004097- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004098 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk302141d2010-11-27 23:30:56 +01004099 low level initializations (like setting up the memory
4100 controller) are omitted and/or U-Boot does not
4101 relocate itself into RAM.
wdenk3d3d99f2005-04-04 12:44:11 +00004102
Wolfgang Denk302141d2010-11-27 23:30:56 +01004103 Normally this variable MUST NOT be defined. The only
4104 exception is when U-Boot is loaded (to RAM) by some
4105 other boot loader or by a debugger which performs
4106 these initializations itself.
wdenk3d3d99f2005-04-04 12:44:11 +00004107
Simon Glass90844072016-05-05 07:28:06 -06004108- CONFIG_SKIP_LOWLEVEL_INIT_ONLY
4109 [ARM926EJ-S only] This allows just the call to lowlevel_init()
yeongjun Kim7a203682016-07-20 22:56:12 +09004110 to be skipped. The normal CP15 init (such as enabling the
Simon Glass90844072016-05-05 07:28:06 -06004111 instruction cache) is still performed.
4112
Aneesh V552a3192011-07-13 05:11:07 +00004113- CONFIG_SPL_BUILD
Magnus Lilja1ec96d82009-06-13 20:50:00 +02004114 Modifies the behaviour of start.S when compiling a loader
4115 that is executed before the actual U-Boot. E.g. when
4116 compiling a NAND SPL.
wdenk336b2bc2005-04-02 23:52:25 +00004117
Ying Zhang2d2e3b62013-08-16 15:16:15 +08004118- CONFIG_TPL_BUILD
4119 Modifies the behaviour of start.S when compiling a loader
4120 that is executed after the SPL and before the actual U-Boot.
4121 It is loaded by the SPL.
4122
Ying Zhang0d4f5442013-05-20 14:07:23 +08004123- CONFIG_SYS_MPC85XX_NO_RESETVEC
4124 Only for 85xx systems. If this variable is specified, the section
4125 .resetvec is not kept and the section .bootpg is placed in the
4126 previous 4k of the .text section.
4127
Simon Glass17dabf02013-02-24 17:33:14 +00004128- CONFIG_ARCH_MAP_SYSMEM
4129 Generally U-Boot (and in particular the md command) uses
4130 effective address. It is therefore not necessary to regard
4131 U-Boot address as virtual addresses that need to be translated
4132 to physical addresses. However, sandbox requires this, since
4133 it maintains its own little RAM buffer which contains all
4134 addressable memory. This option causes some memory accesses
4135 to be mapped through map_sysmem() / unmap_sysmem().
4136
Simon Glassbfb59802013-02-14 04:18:54 +00004137- CONFIG_X86_RESET_VECTOR
4138 If defined, the x86 reset vector code is included. This is not
4139 needed when U-Boot is running from Coreboot.
Gabe Black14f82462012-11-27 21:08:06 +00004140
Heiko Schocher2233e462013-11-04 14:05:00 +01004141- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
4142 Enables the RTC32K OSC on AM33xx based plattforms
4143
Karicheri, Muralidharanc1dc61b2014-04-04 13:16:50 -04004144- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
4145 Option to disable subpage write in NAND driver
4146 driver that uses this:
4147 drivers/mtd/nand/davinci_nand.c
4148
Timur Tabi275f4bb2011-11-22 09:21:25 -06004149Freescale QE/FMAN Firmware Support:
4150-----------------------------------
4151
4152The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4153loading of "firmware", which is encoded in the QE firmware binary format.
4154This firmware often needs to be loaded during U-Boot booting, so macros
4155are used to identify the storage device (NOR flash, SPI, etc) and the address
4156within that device.
4157
Zhao Qiang83a90842014-03-21 16:21:44 +08004158- CONFIG_SYS_FMAN_FW_ADDR
4159 The address in the storage device where the FMAN microcode is located. The
4160 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4161 is also specified.
4162
4163- CONFIG_SYS_QE_FW_ADDR
4164 The address in the storage device where the QE microcode is located. The
Timur Tabi275f4bb2011-11-22 09:21:25 -06004165 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4166 is also specified.
4167
4168- CONFIG_SYS_QE_FMAN_FW_LENGTH
4169 The maximum possible size of the firmware. The firmware binary format
4170 has a field that specifies the actual size of the firmware, but it
4171 might not be possible to read any part of the firmware unless some
4172 local storage is allocated to hold the entire firmware first.
4173
4174- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4175 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4176 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
4177 virtual address in NOR flash.
4178
4179- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4180 Specifies that QE/FMAN firmware is located in NAND flash.
4181 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4182
4183- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4184 Specifies that QE/FMAN firmware is located on the primary SD/MMC
4185 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4186
Liu Gang1e084582012-03-08 00:33:18 +00004187- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4188 Specifies that QE/FMAN firmware is located in the remote (master)
4189 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gang357bf5a2012-08-09 05:10:01 +00004190 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4191 window->master inbound window->master LAW->the ucode address in
4192 master's memory space.
Timur Tabi275f4bb2011-11-22 09:21:25 -06004193
J. German Rivera8ff14b72014-06-23 15:15:55 -07004194Freescale Layerscape Management Complex Firmware Support:
4195---------------------------------------------------------
4196The Freescale Layerscape Management Complex (MC) supports the loading of
4197"firmware".
4198This firmware often needs to be loaded during U-Boot booting, so macros
4199are used to identify the storage device (NOR flash, SPI, etc) and the address
4200within that device.
4201
4202- CONFIG_FSL_MC_ENET
4203 Enable the MC driver for Layerscape SoCs.
4204
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05304205Freescale Layerscape Debug Server Support:
4206-------------------------------------------
4207The Freescale Layerscape Debug Server Support supports the loading of
4208"Debug Server firmware" and triggering SP boot-rom.
4209This firmware often needs to be loaded during U-Boot booting.
4210
York Sun928b6812015-12-07 11:08:58 -08004211- CONFIG_SYS_MC_RSV_MEM_ALIGN
4212 Define alignment of reserved memory MC requires
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05304213
Paul Kocialkowski7b917022015-07-26 18:48:15 +02004214Reproducible builds
4215-------------------
4216
4217In order to achieve reproducible builds, timestamps used in the U-Boot build
4218process have to be set to a fixed value.
4219
4220This is done using the SOURCE_DATE_EPOCH environment variable.
4221SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
4222option for U-Boot or an environment variable in U-Boot.
4223
4224SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
4225
wdenkc6097192002-11-03 00:24:07 +00004226Building the Software:
4227======================
4228
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004229Building U-Boot has been tested in several native build environments
4230and in many different cross environments. Of course we cannot support
4231all possibly existing versions of cross development tools in all
4232(potentially obsolete) versions. In case of tool chain problems we
4233recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4234which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004235
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004236If you are not using a native environment, it is assumed that you
4237have GNU cross compiling tools available in your path. In this case,
4238you must set the environment variable CROSS_COMPILE in your shell.
4239Note that no changes to the Makefile or any other source files are
4240necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00004241
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004242 $ CROSS_COMPILE=ppc_4xx-
4243 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00004244
Peter Tyserb06976d2009-03-13 18:54:51 -05004245Note: If you wish to generate Windows versions of the utilities in
4246 the tools directory you can use the MinGW toolchain
4247 (http://www.mingw.org). Set your HOST tools to the MinGW
4248 toolchain and execute 'make tools'. For example:
4249
4250 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
4251
4252 Binaries such as tools/mkimage.exe will be created which can
4253 be executed on computers running Windows.
4254
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004255U-Boot is intended to be simple to build. After installing the
4256sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00004257is done by typing:
4258
Holger Freyther7ba4e572014-08-04 09:26:05 +02004259 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00004260
Holger Freyther7ba4e572014-08-04 09:26:05 +02004261where "NAME_defconfig" is the name of one of the existing configu-
Michael Jones5a7fb6f2012-03-15 22:48:10 +00004262rations; see boards.cfg for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00004263
wdenk6c59edc2004-05-03 20:45:30 +00004264Note: for some board special configuration names may exist; check if
4265 additional information is available from the board vendor; for
4266 instance, the TQM823L systems are available without (standard)
4267 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004268 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00004269
Holger Freyther7ba4e572014-08-04 09:26:05 +02004270 make TQM823L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00004271 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00004272
Holger Freyther7ba4e572014-08-04 09:26:05 +02004273 make TQM823L_LCD_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00004274 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00004275
wdenk6c59edc2004-05-03 20:45:30 +00004276 etc.
wdenkc6097192002-11-03 00:24:07 +00004277
wdenkc6097192002-11-03 00:24:07 +00004278
wdenk6c59edc2004-05-03 20:45:30 +00004279Finally, type "make all", and you should get some working U-Boot
4280images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00004281
wdenk6c59edc2004-05-03 20:45:30 +00004282- "u-boot.bin" is a raw binary image
4283- "u-boot" is an image in ELF binary format
4284- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00004285
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004286By default the build is performed locally and the objects are saved
4287in the source directory. One of the two methods can be used to change
4288this behavior and build U-Boot to some external directory:
4289
42901. Add O= to the make command line invocations:
4291
4292 make O=/tmp/build distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02004293 make O=/tmp/build NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004294 make O=/tmp/build all
4295
Timo Ketolac8c67602014-11-06 14:39:05 +020042962. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004297
Timo Ketolac8c67602014-11-06 14:39:05 +02004298 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004299 make distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02004300 make NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004301 make all
4302
Timo Ketolac8c67602014-11-06 14:39:05 +02004303Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004304variable.
4305
wdenkc6097192002-11-03 00:24:07 +00004306
wdenk6c59edc2004-05-03 20:45:30 +00004307Please be aware that the Makefiles assume you are using GNU make, so
4308for instance on NetBSD you might need to use "gmake" instead of
4309native "make".
wdenkc6097192002-11-03 00:24:07 +00004310
wdenkc6097192002-11-03 00:24:07 +00004311
wdenk6c59edc2004-05-03 20:45:30 +00004312If the system board that you have is not listed, then you will need
4313to port U-Boot to your hardware platform. To do this, follow these
4314steps:
wdenkc6097192002-11-03 00:24:07 +00004315
Phil Sutterc77b4882015-12-25 14:41:18 +010043161. Create a new directory to hold your board specific code. Add any
wdenk6c59edc2004-05-03 20:45:30 +00004317 files you need. In your board directory, you will need at least
Phil Sutterc77b4882015-12-25 14:41:18 +01004318 the "Makefile" and a "<board>.c".
43192. Create a new configuration file "include/configs/<board>.h" for
4320 your board.
wdenk6c59edc2004-05-03 20:45:30 +000043213. If you're porting U-Boot to a new CPU, then also create a new
4322 directory to hold your CPU specific code. Add any files you need.
Holger Freyther7ba4e572014-08-04 09:26:05 +020043234. Run "make <board>_defconfig" with your new name.
wdenk6c59edc2004-05-03 20:45:30 +000043245. Type "make", and you should get a working "u-boot.srec" file
4325 to be installed on your target system.
43266. Debug and solve any problems that might arise.
4327 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00004328
wdenkc6097192002-11-03 00:24:07 +00004329
wdenk6c59edc2004-05-03 20:45:30 +00004330Testing of U-Boot Modifications, Ports to New Hardware, etc.:
4331==============================================================
wdenkc6097192002-11-03 00:24:07 +00004332
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004333If you have modified U-Boot sources (for instance added a new board
4334or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00004335provide feedback to the other developers. The feedback normally takes
4336the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004337official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00004338
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004339But before you submit such a patch, please verify that your modifi-
4340cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00004341the supported boards compile WITHOUT ANY compiler warnings. To do so,
Simon Glassdc27def2016-07-27 20:33:08 -06004342just run the buildman script (tools/buildman/buildman), which will
4343configure and build U-Boot for ALL supported system. Be warned, this
4344will take a while. Please see the buildman README, or run 'buildman -H'
4345for documentation.
wdenkc6097192002-11-03 00:24:07 +00004346
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004347
wdenk6c59edc2004-05-03 20:45:30 +00004348See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00004349
wdenkc6097192002-11-03 00:24:07 +00004350
wdenk6c59edc2004-05-03 20:45:30 +00004351Monitor Commands - Overview:
4352============================
wdenkc6097192002-11-03 00:24:07 +00004353
wdenk6c59edc2004-05-03 20:45:30 +00004354go - start application at address 'addr'
4355run - run commands in an environment variable
4356bootm - boot application image from memory
4357bootp - boot image via network using BootP/TFTP protocol
Marek Vasutcf41a9b2012-03-14 21:52:45 +00004358bootz - boot zImage from memory
wdenk6c59edc2004-05-03 20:45:30 +00004359tftpboot- boot image via network using TFTP protocol
4360 and env variables "ipaddr" and "serverip"
4361 (and eventually "gatewayip")
Simon Glass6a398d22011-10-24 18:00:07 +00004362tftpput - upload a file via network using TFTP protocol
wdenk6c59edc2004-05-03 20:45:30 +00004363rarpboot- boot image via network using RARP/TFTP protocol
4364diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
4365loads - load S-Record file over serial line
4366loadb - load binary file over serial line (kermit mode)
4367md - memory display
4368mm - memory modify (auto-incrementing)
4369nm - memory modify (constant address)
4370mw - memory write (fill)
4371cp - memory copy
4372cmp - memory compare
4373crc32 - checksum calculation
Peter Tyser469cde42009-04-18 22:34:03 -05004374i2c - I2C sub-system
wdenk6c59edc2004-05-03 20:45:30 +00004375sspi - SPI utility commands
4376base - print or set address offset
4377printenv- print environment variables
4378setenv - set environment variables
4379saveenv - save environment variables to persistent storage
4380protect - enable or disable FLASH write protection
4381erase - erase FLASH memory
4382flinfo - print FLASH memory information
Karl O. Pinc4baf03d2012-08-03 05:57:21 +00004383nand - NAND memory operations (see doc/README.nand)
wdenk6c59edc2004-05-03 20:45:30 +00004384bdinfo - print Board Info structure
4385iminfo - print header information for application image
4386coninfo - print console devices and informations
4387ide - IDE sub-system
4388loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00004389loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00004390mtest - simple RAM test
4391icache - enable or disable instruction cache
4392dcache - enable or disable data cache
4393reset - Perform RESET of the CPU
4394echo - echo args to console
4395version - print monitor version
4396help - print online help
4397? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00004398
wdenkc6097192002-11-03 00:24:07 +00004399
wdenk6c59edc2004-05-03 20:45:30 +00004400Monitor Commands - Detailed Description:
4401========================================
wdenkc6097192002-11-03 00:24:07 +00004402
wdenk6c59edc2004-05-03 20:45:30 +00004403TODO.
wdenkc6097192002-11-03 00:24:07 +00004404
wdenk6c59edc2004-05-03 20:45:30 +00004405For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00004406
4407
wdenk6c59edc2004-05-03 20:45:30 +00004408Environment Variables:
4409======================
wdenkc6097192002-11-03 00:24:07 +00004410
wdenk6c59edc2004-05-03 20:45:30 +00004411U-Boot supports user configuration using Environment Variables which
4412can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00004413
wdenk6c59edc2004-05-03 20:45:30 +00004414Environment Variables are set using "setenv", printed using
4415"printenv", and saved to Flash using "saveenv". Using "setenv"
4416without a value can be used to delete a variable from the
4417environment. As long as you don't save the environment you are
4418working with an in-memory copy. In case the Flash area containing the
4419environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00004420
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004421Some configuration options can be set using Environment Variables.
4422
4423List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00004424
wdenk6c59edc2004-05-03 20:45:30 +00004425 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00004426
wdenk6c59edc2004-05-03 20:45:30 +00004427 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00004428
wdenk6c59edc2004-05-03 20:45:30 +00004429 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00004430
wdenk6c59edc2004-05-03 20:45:30 +00004431 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00004432
wdenk6c59edc2004-05-03 20:45:30 +00004433 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00004434
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004435 bootm_low - Memory range available for image processing in the bootm
4436 command can be restricted. This variable is given as
4437 a hexadecimal number and defines lowest address allowed
4438 for use by the bootm command. See also "bootm_size"
4439 environment variable. Address defined by "bootm_low" is
4440 also the base of the initial memory mapping for the Linux
Grant Likely26396382011-03-28 09:58:43 +00004441 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4442 bootm_mapsize.
4443
Wolfgang Denk092ae952011-10-26 10:21:21 +00004444 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likely26396382011-03-28 09:58:43 +00004445 This variable is given as a hexadecimal number and it
4446 defines the size of the memory region starting at base
4447 address bootm_low that is accessible by the Linux kernel
4448 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
4449 as the default value if it is defined, and bootm_size is
4450 used otherwise.
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004451
4452 bootm_size - Memory range available for image processing in the bootm
4453 command can be restricted. This variable is given as
4454 a hexadecimal number and defines the size of the region
4455 allowed for use by the bootm command. See also "bootm_low"
4456 environment variable.
4457
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02004458 updatefile - Location of the software update file on a TFTP server, used
4459 by the automatic software update feature. Please refer to
4460 documentation in doc/README.update for more details.
4461
wdenk6c59edc2004-05-03 20:45:30 +00004462 autoload - if set to "no" (any string beginning with 'n'),
4463 "bootp" will just load perform a lookup of the
4464 configuration from the BOOTP server, but not try to
4465 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00004466
wdenk6c59edc2004-05-03 20:45:30 +00004467 autostart - if set to "yes", an image loaded using the "bootp",
4468 "rarpboot", "tftpboot" or "diskboot" commands will
4469 be automatically started (by internally calling
4470 "bootm")
wdenkc6097192002-11-03 00:24:07 +00004471
wdenk6c59edc2004-05-03 20:45:30 +00004472 If set to "no", a standalone image passed to the
4473 "bootm" command will be copied to the load address
4474 (and eventually uncompressed), but NOT be started.
4475 This can be used to load and uncompress arbitrary
4476 data.
wdenkc6097192002-11-03 00:24:07 +00004477
David A. Longd558a4e2011-07-09 16:40:19 -04004478 fdt_high - if set this restricts the maximum address that the
4479 flattened device tree will be copied into upon boot.
Shawn Guo0ca9e982012-01-09 21:54:08 +00004480 For example, if you have a system with 1 GB memory
4481 at physical address 0x10000000, while Linux kernel
4482 only recognizes the first 704 MB as low memory, you
4483 may need to set fdt_high as 0x3C000000 to have the
4484 device tree blob be copied to the maximum address
4485 of the 704 MB low memory, so that Linux kernel can
4486 access it during the boot procedure.
4487
David A. Longd558a4e2011-07-09 16:40:19 -04004488 If this is set to the special value 0xFFFFFFFF then
4489 the fdt will not be copied at all on boot. For this
4490 to work it must reside in writable memory, have
4491 sufficient padding on the end of it for u-boot to
4492 add the information it needs into it, and the memory
4493 must be accessible by the kernel.
4494
Simon Glassdc6fa642011-10-24 19:15:34 +00004495 fdtcontroladdr- if set this is the address of the control flattened
4496 device tree used by U-Boot when CONFIG_OF_CONTROL is
4497 defined.
4498
wdenk0e2bd9c2004-06-06 21:51:03 +00004499 i2cfast - (PPC405GP|PPC405EP only)
4500 if set to 'y' configures Linux I2C driver for fast
4501 mode (400kHZ). This environment variable is used in
4502 initialization code. So, for changes to be effective
4503 it must be saved and board must be reset.
4504
wdenk6c59edc2004-05-03 20:45:30 +00004505 initrd_high - restrict positioning of initrd images:
4506 If this variable is not set, initrd images will be
4507 copied to the highest possible address in RAM; this
4508 is usually what you want since it allows for
4509 maximum initrd size. If for some reason you want to
4510 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004511 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk6c59edc2004-05-03 20:45:30 +00004512 variable to a value of "no" or "off" or "0".
4513 Alternatively, you can set it to a maximum upper
4514 address to use (U-Boot will still check that it
4515 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00004516
wdenk6c59edc2004-05-03 20:45:30 +00004517 For instance, when you have a system with 16 MB
4518 RAM, and want to reserve 4 MB from use by Linux,
4519 you can do this by adding "mem=12M" to the value of
4520 the "bootargs" variable. However, now you must make
4521 sure that the initrd image is placed in the first
4522 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00004523
wdenk6c59edc2004-05-03 20:45:30 +00004524 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00004525
wdenk6c59edc2004-05-03 20:45:30 +00004526 If you set initrd_high to 0xFFFFFFFF, this is an
4527 indication to U-Boot that all addresses are legal
4528 for the Linux kernel, including addresses in flash
4529 memory. In this case U-Boot will NOT COPY the
4530 ramdisk at all. This may be useful to reduce the
4531 boot time on your system, but requires that this
4532 feature is supported by your Linux kernel.
wdenk3f9ab982003-04-12 23:38:12 +00004533
wdenk6c59edc2004-05-03 20:45:30 +00004534 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00004535
wdenk6c59edc2004-05-03 20:45:30 +00004536 loadaddr - Default load address for commands like "bootp",
4537 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00004538
wdenk6c59edc2004-05-03 20:45:30 +00004539 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00004540
wdenk6c59edc2004-05-03 20:45:30 +00004541 serverip - TFTP server IP address; needed for tftpboot command
wdenk6f770ed2003-05-23 23:18:21 +00004542
wdenk6c59edc2004-05-03 20:45:30 +00004543 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00004544
wdenk6c59edc2004-05-03 20:45:30 +00004545 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00004546
wdenk6c59edc2004-05-03 20:45:30 +00004547 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00004548
Mike Frysingera23230c2011-10-02 10:01:27 +00004549 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00004550
Mike Frysingera23230c2011-10-02 10:01:27 +00004551 ethact - controls which interface is currently active.
4552 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00004553
Heiko Schocherc5e84052010-07-20 17:45:02 +02004554 => setenv ethact FEC
4555 => ping 192.168.0.1 # traffic sent on FEC
4556 => setenv ethact SCC
4557 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00004558
Matthias Fuchs204f0ec2008-01-17 07:45:05 +01004559 ethrotate - When set to "no" U-Boot does not go through all
4560 available network interfaces.
4561 It just stays at the currently selected interface.
4562
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004563 netretry - When set to "no" each network operation will
wdenk6c59edc2004-05-03 20:45:30 +00004564 either succeed or fail without retrying.
4565 When set to "once" the network operation will
4566 fail when all the available network interfaces
4567 are tried once without success.
4568 Useful on scripts which control the retry operation
4569 themselves.
wdenkc6097192002-11-03 00:24:07 +00004570
Jean-Christophe PLAGNIOL-VILLARD1948d6c2009-01-31 09:53:39 +01004571 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDd2164ef2008-01-07 08:41:34 +01004572
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004573 silent_linux - If set then Linux will be told to boot silently, by
Simon Glass5db3f932013-07-16 20:10:00 -07004574 changing the console to be empty. If "yes" it will be
4575 made silent. If "no" it will not be made silent. If
4576 unset, then it will be made silent if the U-Boot console
4577 is silent.
4578
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02004579 tftpsrcp - If this is set, the value is used for TFTP's
Wolfgang Denke3cfce52005-09-24 22:37:32 +02004580 UDP source port.
4581
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02004582 tftpdstp - If this is set, the value is used for TFTP's UDP
Wolfgang Denk227b5192005-09-24 23:25:46 +02004583 destination port instead of the Well Know Port 69.
4584
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004585 tftpblocksize - Block size to use for TFTP transfers; if not set,
4586 we use the TFTP server's default block size
4587
4588 tftptimeout - Retransmission timeout for TFTP packets (in milli-
4589 seconds, minimum value is 1000 = 1 second). Defines
4590 when a packet is considered to be lost so it has to
4591 be retransmitted. The default is 5000 = 5 seconds.
4592 Lowering this value may make downloads succeed
4593 faster in networks with high packet loss rates or
4594 with unreliable TFTP servers.
4595
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02004596 tftptimeoutcountmax - maximum count of TFTP timeouts (no
4597 unit, minimum value = 0). Defines how many timeouts
4598 can happen during a single file transfer before that
4599 transfer is aborted. The default is 10, and 0 means
4600 'no timeouts allowed'. Increasing this value may help
4601 downloads succeed with high packet loss rates, or with
4602 unreliable TFTP servers or client hardware.
4603
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004604 vlan - When set to a value < 4095 the traffic over
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004605 Ethernet is encapsulated/received over 802.1q
wdenk6c59edc2004-05-03 20:45:30 +00004606 VLAN tagged frames.
wdenk145d2c12004-04-15 21:48:45 +00004607
Alexandre Messier15971322016-02-01 17:08:57 -05004608 bootpretryperiod - Period during which BOOTP/DHCP sends retries.
4609 Unsigned value, in milliseconds. If not set, the period will
4610 be either the default (28000), or a value based on
4611 CONFIG_NET_RETRY_COUNT, if defined. This value has
4612 precedence over the valu based on CONFIG_NET_RETRY_COUNT.
4613
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004614The following image location variables contain the location of images
4615used in booting. The "Image" column gives the role of the image and is
4616not an environment variable name. The other columns are environment
4617variable names. "File Name" gives the name of the file on a TFTP
4618server, "RAM Address" gives the location in RAM the image will be
4619loaded to, and "Flash Location" gives the image's address in NOR
4620flash or offset in NAND flash.
4621
4622*Note* - these variables don't have to be defined for all boards, some
Fabio Estevambb7d4972015-04-25 18:53:10 -03004623boards currently use other variables for these purposes, and some
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004624boards use these variables for other purposes.
4625
Wolfgang Denk092ae952011-10-26 10:21:21 +00004626Image File Name RAM Address Flash Location
4627----- --------- ----------- --------------
4628u-boot u-boot u-boot_addr_r u-boot_addr
4629Linux kernel bootfile kernel_addr_r kernel_addr
4630device tree blob fdtfile fdt_addr_r fdt_addr
4631ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004632
wdenk6c59edc2004-05-03 20:45:30 +00004633The following environment variables may be used and automatically
4634updated by the network boot commands ("bootp" and "rarpboot"),
4635depending the information provided by your boot server:
wdenk145d2c12004-04-15 21:48:45 +00004636
wdenk6c59edc2004-05-03 20:45:30 +00004637 bootfile - see above
4638 dnsip - IP address of your Domain Name Server
4639 dnsip2 - IP address of your secondary Domain Name Server
4640 gatewayip - IP address of the Gateway (Router) to use
4641 hostname - Target hostname
4642 ipaddr - see above
4643 netmask - Subnet Mask
4644 rootpath - Pathname of the root filesystem on the NFS server
4645 serverip - see above
wdenk145d2c12004-04-15 21:48:45 +00004646
wdenk145d2c12004-04-15 21:48:45 +00004647
wdenk6c59edc2004-05-03 20:45:30 +00004648There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004649
wdenk6c59edc2004-05-03 20:45:30 +00004650 serial# - contains hardware identification information such
4651 as type string and/or serial number
4652 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00004653
wdenk6c59edc2004-05-03 20:45:30 +00004654These variables can be set only once (usually during manufacturing of
4655the board). U-Boot refuses to delete or overwrite these variables
4656once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00004657
4658
wdenk6c59edc2004-05-03 20:45:30 +00004659Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004660
wdenk6c59edc2004-05-03 20:45:30 +00004661 ver - Contains the U-Boot version string as printed
4662 with the "version" command. This variable is
4663 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00004664
wdenkc6097192002-11-03 00:24:07 +00004665
wdenk6c59edc2004-05-03 20:45:30 +00004666Please note that changes to some configuration parameters may take
4667only effect after the next boot (yes, that's just like Windoze :-).
stroeseb9c17c52003-04-04 15:53:41 +00004668
stroeseb9c17c52003-04-04 15:53:41 +00004669
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004670Callback functions for environment variables:
4671---------------------------------------------
4672
4673For some environment variables, the behavior of u-boot needs to change
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004674when their values are changed. This functionality allows functions to
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004675be associated with arbitrary variables. On creation, overwrite, or
4676deletion, the callback will provide the opportunity for some side
4677effect to happen or for the change to be rejected.
4678
4679The callbacks are named and associated with a function using the
4680U_BOOT_ENV_CALLBACK macro in your board or driver code.
4681
4682These callbacks are associated with variables in one of two ways. The
4683static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4684in the board configuration to a string that defines a list of
4685associations. The list must be in the following format:
4686
4687 entry = variable_name[:callback_name]
4688 list = entry[,list]
4689
4690If the callback name is not specified, then the callback is deleted.
4691Spaces are also allowed anywhere in the list.
4692
4693Callbacks can also be associated by defining the ".callbacks" variable
4694with the same list format above. Any association in ".callbacks" will
4695override any association in the static list. You can define
4696CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004697".callbacks" environment variable in the default or embedded environment.
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004698
Joe Hershberger6db9fd42015-05-20 14:27:20 -05004699If CONFIG_REGEX is defined, the variable_name above is evaluated as a
4700regular expression. This allows multiple variables to be connected to
4701the same callback without explicitly listing them all out.
4702
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004703
wdenk6c59edc2004-05-03 20:45:30 +00004704Command Line Parsing:
4705=====================
stroeseb9c17c52003-04-04 15:53:41 +00004706
wdenk6c59edc2004-05-03 20:45:30 +00004707There are two different command line parsers available with U-Boot:
4708the old "simple" one, and the much more powerful "hush" shell:
wdenkc6097192002-11-03 00:24:07 +00004709
wdenk6c59edc2004-05-03 20:45:30 +00004710Old, simple command line parser:
4711--------------------------------
wdenkc6097192002-11-03 00:24:07 +00004712
wdenk6c59edc2004-05-03 20:45:30 +00004713- supports environment variables (through setenv / saveenv commands)
4714- several commands on one line, separated by ';'
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01004715- variable substitution using "... ${name} ..." syntax
wdenk6c59edc2004-05-03 20:45:30 +00004716- special characters ('$', ';') can be escaped by prefixing with '\',
4717 for example:
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01004718 setenv bootcmd bootm \${address}
wdenk6c59edc2004-05-03 20:45:30 +00004719- You can also escape text by enclosing in single apostrophes, for example:
4720 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00004721
wdenk6c59edc2004-05-03 20:45:30 +00004722Hush shell:
4723-----------
wdenkf4688a22003-05-28 08:06:31 +00004724
wdenk6c59edc2004-05-03 20:45:30 +00004725- similar to Bourne shell, with control structures like
4726 if...then...else...fi, for...do...done; while...do...done,
4727 until...do...done, ...
4728- supports environment ("global") variables (through setenv / saveenv
4729 commands) and local shell variables (through standard shell syntax
4730 "name=value"); only environment variables can be used with "run"
4731 command
wdenkf4688a22003-05-28 08:06:31 +00004732
wdenk6c59edc2004-05-03 20:45:30 +00004733General rules:
4734--------------
wdenkf4688a22003-05-28 08:06:31 +00004735
wdenk6c59edc2004-05-03 20:45:30 +00004736(1) If a command line (or an environment variable executed by a "run"
4737 command) contains several commands separated by semicolon, and
4738 one of these commands fails, then the remaining commands will be
4739 executed anyway.
wdenkf4688a22003-05-28 08:06:31 +00004740
wdenk6c59edc2004-05-03 20:45:30 +00004741(2) If you execute several variables with one call to run (i. e.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004742 calling run with a list of variables as arguments), any failing
wdenk6c59edc2004-05-03 20:45:30 +00004743 command will cause "run" to terminate, i. e. the remaining
4744 variables are not executed.
wdenkf4688a22003-05-28 08:06:31 +00004745
wdenk6c59edc2004-05-03 20:45:30 +00004746Note for Redundant Ethernet Interfaces:
4747=======================================
wdenkf4688a22003-05-28 08:06:31 +00004748
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004749Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00004750such configurations and is capable of automatic selection of a
4751"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00004752
wdenk6c59edc2004-05-03 20:45:30 +00004753Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
4754MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4755"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00004756
wdenk6c59edc2004-05-03 20:45:30 +00004757If the network interface stores some valid MAC address (for instance
4758in SROM), this is used as default address if there is NO correspon-
4759ding setting in the environment; if the corresponding environment
4760variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00004761
wdenk6c59edc2004-05-03 20:45:30 +00004762o If the SROM has a valid MAC address, and there is no address in the
4763 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00004764
wdenk6c59edc2004-05-03 20:45:30 +00004765o If there is no valid address in the SROM, and a definition in the
4766 environment exists, then the value from the environment variable is
4767 used.
wdenkc6097192002-11-03 00:24:07 +00004768
wdenk6c59edc2004-05-03 20:45:30 +00004769o If both the SROM and the environment contain a MAC address, and
4770 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00004771
wdenk6c59edc2004-05-03 20:45:30 +00004772o If both the SROM and the environment contain a MAC address, and the
4773 addresses differ, the value from the environment is used and a
4774 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00004775
wdenk6c59edc2004-05-03 20:45:30 +00004776o If neither SROM nor the environment contain a MAC address, an error
Joe Hershberger2dc2b5d2015-05-04 14:55:13 -05004777 is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
4778 a random, locally-assigned MAC is used.
wdenkc6097192002-11-03 00:24:07 +00004779
Ben Warren6db991a2010-04-26 11:11:46 -07004780If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denk092ae952011-10-26 10:21:21 +00004781will be programmed into hardware as part of the initialization process. This
Ben Warren6db991a2010-04-26 11:11:46 -07004782may be skipped by setting the appropriate 'ethmacskip' environment variable.
4783The naming convention is as follows:
4784"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00004785
wdenk6c59edc2004-05-03 20:45:30 +00004786Image Formats:
4787==============
wdenkc6097192002-11-03 00:24:07 +00004788
Marian Balakowicz18710b82008-03-12 12:13:13 +01004789U-Boot is capable of booting (and performing other auxiliary operations on)
4790images in two formats:
4791
4792New uImage format (FIT)
4793-----------------------
4794
4795Flexible and powerful format based on Flattened Image Tree -- FIT (similar
4796to Flattened Device Tree). It allows the use of images with multiple
4797components (several kernels, ramdisks, etc.), with contents protected by
4798SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
4799
4800
4801Old uImage format
4802-----------------
4803
4804Old image format is based on binary files which can be basically anything,
4805preceded by a special header; see the definitions in include/image.h for
4806details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00004807
wdenk6c59edc2004-05-03 20:45:30 +00004808* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4809 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05004810 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4811 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4812 INTEGRITY).
Wolfgang Denk83c15852006-10-24 14:21:16 +02004813* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004814 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
4815 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00004816* Compression Type (uncompressed, gzip, bzip2)
4817* Load Address
4818* Entry Point
4819* Image Name
4820* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00004821
wdenk6c59edc2004-05-03 20:45:30 +00004822The header is marked by a special Magic Number, and both the header
4823and the data portions of the image are secured against corruption by
4824CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00004825
wdenkc6097192002-11-03 00:24:07 +00004826
wdenk6c59edc2004-05-03 20:45:30 +00004827Linux Support:
4828==============
wdenkc6097192002-11-03 00:24:07 +00004829
wdenk6c59edc2004-05-03 20:45:30 +00004830Although U-Boot should support any OS or standalone application
4831easily, the main focus has always been on Linux during the design of
4832U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004833
wdenk6c59edc2004-05-03 20:45:30 +00004834U-Boot includes many features that so far have been part of some
4835special "boot loader" code within the Linux kernel. Also, any
4836"initrd" images to be used are no longer part of one big Linux image;
4837instead, kernel and "initrd" are separate images. This implementation
4838serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00004839
wdenk6c59edc2004-05-03 20:45:30 +00004840- the same features can be used for other OS or standalone
4841 applications (for instance: using compressed images to reduce the
4842 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00004843
wdenk6c59edc2004-05-03 20:45:30 +00004844- it becomes much easier to port new Linux kernel versions because
4845 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00004846
wdenk6c59edc2004-05-03 20:45:30 +00004847- the same Linux kernel image can now be used with different "initrd"
4848 images; of course this also means that different kernel images can
4849 be run with the same "initrd". This makes testing easier (you don't
4850 have to build a new "zImage.initrd" Linux image when you just
4851 change a file in your "initrd"). Also, a field-upgrade of the
4852 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00004853
wdenkc6097192002-11-03 00:24:07 +00004854
wdenk6c59edc2004-05-03 20:45:30 +00004855Linux HOWTO:
4856============
wdenkc6097192002-11-03 00:24:07 +00004857
wdenk6c59edc2004-05-03 20:45:30 +00004858Porting Linux to U-Boot based systems:
4859---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004860
wdenk6c59edc2004-05-03 20:45:30 +00004861U-Boot cannot save you from doing all the necessary modifications to
4862configure the Linux device drivers for use with your target hardware
4863(no, we don't intend to provide a full virtual machine interface to
4864Linux :-).
wdenkc6097192002-11-03 00:24:07 +00004865
Stefan Roese88fbf932010-04-15 16:07:28 +02004866But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00004867
wdenk6c59edc2004-05-03 20:45:30 +00004868Just make sure your machine specific header file (for instance
4869include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02004870Information structure as we define in include/asm-<arch>/u-boot.h,
4871and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004872as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00004873
Simon Glassd097e592014-06-11 23:29:46 -06004874Note that U-Boot now has a driver model, a unified model for drivers.
4875If you are adding a new driver, plumb it into driver model. If there
4876is no uclass available, you are encouraged to create one. See
4877doc/driver-model.
4878
wdenkc6097192002-11-03 00:24:07 +00004879
wdenk6c59edc2004-05-03 20:45:30 +00004880Configuring the Linux kernel:
4881-----------------------------
wdenkc6097192002-11-03 00:24:07 +00004882
wdenk6c59edc2004-05-03 20:45:30 +00004883No specific requirements for U-Boot. Make sure you have some root
4884device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00004885
wdenkc6097192002-11-03 00:24:07 +00004886
wdenk6c59edc2004-05-03 20:45:30 +00004887Building a Linux Image:
4888-----------------------
wdenkc6097192002-11-03 00:24:07 +00004889
wdenk6c59edc2004-05-03 20:45:30 +00004890With U-Boot, "normal" build targets like "zImage" or "bzImage" are
4891not used. If you use recent kernel source, a new build target
4892"uImage" will exist which automatically builds an image usable by
4893U-Boot. Most older kernels also have support for a "pImage" target,
4894which was introduced for our predecessor project PPCBoot and uses a
4895100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00004896
wdenk6c59edc2004-05-03 20:45:30 +00004897Example:
wdenkc6097192002-11-03 00:24:07 +00004898
Holger Freyther7ba4e572014-08-04 09:26:05 +02004899 make TQM850L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00004900 make oldconfig
4901 make dep
4902 make uImage
wdenkc6097192002-11-03 00:24:07 +00004903
wdenk6c59edc2004-05-03 20:45:30 +00004904The "uImage" build target uses a special tool (in 'tools/mkimage') to
4905encapsulate a compressed Linux kernel image with header information,
4906CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00004907
wdenk6c59edc2004-05-03 20:45:30 +00004908* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00004909
wdenk6c59edc2004-05-03 20:45:30 +00004910* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00004911
wdenk6c59edc2004-05-03 20:45:30 +00004912 ${CROSS_COMPILE}-objcopy -O binary \
4913 -R .note -R .comment \
4914 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00004915
wdenk6c59edc2004-05-03 20:45:30 +00004916* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00004917
wdenk6c59edc2004-05-03 20:45:30 +00004918 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00004919
wdenk6c59edc2004-05-03 20:45:30 +00004920* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00004921
wdenk6c59edc2004-05-03 20:45:30 +00004922 mkimage -A ppc -O linux -T kernel -C gzip \
4923 -a 0 -e 0 -n "Linux Kernel Image" \
4924 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00004925
wdenkc6097192002-11-03 00:24:07 +00004926
wdenk6c59edc2004-05-03 20:45:30 +00004927The "mkimage" tool can also be used to create ramdisk images for use
4928with U-Boot, either separated from the Linux kernel image, or
4929combined into one file. "mkimage" encapsulates the images with a 64
4930byte header containing information about target architecture,
4931operating system, image type, compression method, entry points, time
4932stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00004933
wdenk6c59edc2004-05-03 20:45:30 +00004934"mkimage" can be called in two ways: to verify existing images and
4935print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00004936
wdenk6c59edc2004-05-03 20:45:30 +00004937In the first form (with "-l" option) mkimage lists the information
4938contained in the header of an existing U-Boot image; this includes
4939checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00004940
wdenk6c59edc2004-05-03 20:45:30 +00004941 tools/mkimage -l image
4942 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00004943
wdenk6c59edc2004-05-03 20:45:30 +00004944The second form (with "-d" option) is used to build a U-Boot image
4945from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00004946
wdenk6c59edc2004-05-03 20:45:30 +00004947 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4948 -n name -d data_file image
4949 -A ==> set architecture to 'arch'
4950 -O ==> set operating system to 'os'
4951 -T ==> set image type to 'type'
4952 -C ==> set compression type 'comp'
4953 -a ==> set load address to 'addr' (hex)
4954 -e ==> set entry point to 'ep' (hex)
4955 -n ==> set image name to 'name'
4956 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00004957
wdenkcd914452004-05-29 16:53:29 +00004958Right now, all Linux kernels for PowerPC systems use the same load
4959address (0x00000000), but the entry point address depends on the
4960kernel version:
wdenkc6097192002-11-03 00:24:07 +00004961
wdenk6c59edc2004-05-03 20:45:30 +00004962- 2.2.x kernels have the entry point at 0x0000000C,
4963- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00004964
wdenk6c59edc2004-05-03 20:45:30 +00004965So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00004966
wdenk6c59edc2004-05-03 20:45:30 +00004967 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4968 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02004969 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk6c59edc2004-05-03 20:45:30 +00004970 > examples/uImage.TQM850L
4971 Image Name: 2.4.4 kernel for TQM850L
4972 Created: Wed Jul 19 02:34:59 2000
4973 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4974 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4975 Load Address: 0x00000000
4976 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004977
wdenk6c59edc2004-05-03 20:45:30 +00004978To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00004979
wdenk6c59edc2004-05-03 20:45:30 +00004980 -> tools/mkimage -l examples/uImage.TQM850L
4981 Image Name: 2.4.4 kernel for TQM850L
4982 Created: Wed Jul 19 02:34:59 2000
4983 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4984 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4985 Load Address: 0x00000000
4986 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004987
wdenk6c59edc2004-05-03 20:45:30 +00004988NOTE: for embedded systems where boot time is critical you can trade
4989speed for memory and install an UNCOMPRESSED image instead: this
4990needs more space in Flash, but boots much faster since it does not
4991need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00004992
Stefan Roese88fbf932010-04-15 16:07:28 +02004993 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk6c59edc2004-05-03 20:45:30 +00004994 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4995 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02004996 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk6c59edc2004-05-03 20:45:30 +00004997 > examples/uImage.TQM850L-uncompressed
4998 Image Name: 2.4.4 kernel for TQM850L
4999 Created: Wed Jul 19 02:34:59 2000
5000 Image Type: PowerPC Linux Kernel Image (uncompressed)
5001 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5002 Load Address: 0x00000000
5003 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005004
wdenkc6097192002-11-03 00:24:07 +00005005
wdenk6c59edc2004-05-03 20:45:30 +00005006Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5007when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00005008
wdenk6c59edc2004-05-03 20:45:30 +00005009 -> tools/mkimage -n 'Simple Ramdisk Image' \
5010 > -A ppc -O linux -T ramdisk -C gzip \
5011 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5012 Image Name: Simple Ramdisk Image
5013 Created: Wed Jan 12 14:01:50 2000
5014 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5015 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5016 Load Address: 0x00000000
5017 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005018
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07005019The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5020option performs the converse operation of the mkimage's second form (the "-d"
5021option). Given an image built by mkimage, the dumpimage extracts a "data file"
5022from the image:
5023
Guilherme Maciel Ferreira40bf5632015-01-15 02:54:40 -02005024 tools/dumpimage -i image -T type -p position data_file
5025 -i ==> extract from the 'image' a specific 'data_file'
5026 -T ==> set image type to 'type'
5027 -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07005028
wdenkc6097192002-11-03 00:24:07 +00005029
wdenk6c59edc2004-05-03 20:45:30 +00005030Installing a Linux Image:
5031-------------------------
wdenkc6097192002-11-03 00:24:07 +00005032
wdenk6c59edc2004-05-03 20:45:30 +00005033To downloading a U-Boot image over the serial (console) interface,
5034you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00005035
wdenk6c59edc2004-05-03 20:45:30 +00005036 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00005037
wdenk6c59edc2004-05-03 20:45:30 +00005038The 'objcopy' does not understand the information in the U-Boot
5039image header, so the resulting S-Record file will be relative to
5040address 0x00000000. To load it to a given address, you need to
5041specify the target address as 'offset' parameter with the 'loads'
5042command.
wdenkc6097192002-11-03 00:24:07 +00005043
wdenk6c59edc2004-05-03 20:45:30 +00005044Example: install the image to address 0x40100000 (which on the
5045TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00005046
wdenk6c59edc2004-05-03 20:45:30 +00005047 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00005048
wdenk6c59edc2004-05-03 20:45:30 +00005049 .......... done
5050 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00005051
wdenk6c59edc2004-05-03 20:45:30 +00005052 => loads 40100000
5053 ## Ready for S-Record download ...
5054 ~>examples/image.srec
5055 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5056 ...
5057 15989 15990 15991 15992
5058 [file transfer complete]
5059 [connected]
5060 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005061
wdenkc6097192002-11-03 00:24:07 +00005062
wdenk6c59edc2004-05-03 20:45:30 +00005063You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005064this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00005065corruption happened:
wdenkc6097192002-11-03 00:24:07 +00005066
wdenk6c59edc2004-05-03 20:45:30 +00005067 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00005068
wdenk6c59edc2004-05-03 20:45:30 +00005069 ## Checking Image at 40100000 ...
5070 Image Name: 2.2.13 for initrd on TQM850L
5071 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5072 Data Size: 335725 Bytes = 327 kB = 0 MB
5073 Load Address: 00000000
5074 Entry Point: 0000000c
5075 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005076
5077
wdenk6c59edc2004-05-03 20:45:30 +00005078Boot Linux:
5079-----------
wdenkc6097192002-11-03 00:24:07 +00005080
wdenk6c59edc2004-05-03 20:45:30 +00005081The "bootm" command is used to boot an application that is stored in
5082memory (RAM or Flash). In case of a Linux kernel image, the contents
5083of the "bootargs" environment variable is passed to the kernel as
5084parameters. You can check and modify this variable using the
5085"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00005086
wdenkc6097192002-11-03 00:24:07 +00005087
wdenk6c59edc2004-05-03 20:45:30 +00005088 => printenv bootargs
5089 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00005090
wdenk6c59edc2004-05-03 20:45:30 +00005091 => 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 +00005092
wdenk6c59edc2004-05-03 20:45:30 +00005093 => printenv bootargs
5094 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 +00005095
wdenk6c59edc2004-05-03 20:45:30 +00005096 => bootm 40020000
5097 ## Booting Linux kernel at 40020000 ...
5098 Image Name: 2.2.13 for NFS on TQM850L
5099 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5100 Data Size: 381681 Bytes = 372 kB = 0 MB
5101 Load Address: 00000000
5102 Entry Point: 0000000c
5103 Verifying Checksum ... OK
5104 Uncompressing Kernel Image ... OK
5105 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
5106 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5107 time_init: decrementer frequency = 187500000/60
5108 Calibrating delay loop... 49.77 BogoMIPS
5109 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5110 ...
wdenkc6097192002-11-03 00:24:07 +00005111
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005112If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00005113the memory addresses of both the kernel and the initrd image (PPBCOOT
5114format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00005115
wdenk6c59edc2004-05-03 20:45:30 +00005116 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00005117
wdenk6c59edc2004-05-03 20:45:30 +00005118 ## Checking Image at 40100000 ...
5119 Image Name: 2.2.13 for initrd on TQM850L
5120 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5121 Data Size: 335725 Bytes = 327 kB = 0 MB
5122 Load Address: 00000000
5123 Entry Point: 0000000c
5124 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005125
wdenk6c59edc2004-05-03 20:45:30 +00005126 ## Checking Image at 40200000 ...
5127 Image Name: Simple Ramdisk Image
5128 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5129 Data Size: 566530 Bytes = 553 kB = 0 MB
5130 Load Address: 00000000
5131 Entry Point: 00000000
5132 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005133
wdenk6c59edc2004-05-03 20:45:30 +00005134 => bootm 40100000 40200000
5135 ## Booting Linux kernel at 40100000 ...
5136 Image Name: 2.2.13 for initrd on TQM850L
5137 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5138 Data Size: 335725 Bytes = 327 kB = 0 MB
5139 Load Address: 00000000
5140 Entry Point: 0000000c
5141 Verifying Checksum ... OK
5142 Uncompressing Kernel Image ... OK
5143 ## Loading RAMDisk Image at 40200000 ...
5144 Image Name: Simple Ramdisk Image
5145 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5146 Data Size: 566530 Bytes = 553 kB = 0 MB
5147 Load Address: 00000000
5148 Entry Point: 00000000
5149 Verifying Checksum ... OK
5150 Loading Ramdisk ... OK
5151 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
5152 Boot arguments: root=/dev/ram
5153 time_init: decrementer frequency = 187500000/60
5154 Calibrating delay loop... 49.77 BogoMIPS
5155 ...
5156 RAMDISK: Compressed image found at block 0
5157 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00005158
wdenk6c59edc2004-05-03 20:45:30 +00005159 bash#
wdenkc6097192002-11-03 00:24:07 +00005160
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005161Boot Linux and pass a flat device tree:
5162-----------
5163
5164First, U-Boot must be compiled with the appropriate defines. See the section
5165titled "Linux Kernel Interface" above for a more in depth explanation. The
5166following is an example of how to start a kernel and pass an updated
5167flat device tree:
5168
5169=> print oftaddr
5170oftaddr=0x300000
5171=> print oft
5172oft=oftrees/mpc8540ads.dtb
5173=> tftp $oftaddr $oft
5174Speed: 1000, full duplex
5175Using TSEC0 device
5176TFTP from server 192.168.1.1; our IP address is 192.168.1.101
5177Filename 'oftrees/mpc8540ads.dtb'.
5178Load address: 0x300000
5179Loading: #
5180done
5181Bytes transferred = 4106 (100a hex)
5182=> tftp $loadaddr $bootfile
5183Speed: 1000, full duplex
5184Using TSEC0 device
5185TFTP from server 192.168.1.1; our IP address is 192.168.1.2
5186Filename 'uImage'.
5187Load address: 0x200000
5188Loading:############
5189done
5190Bytes transferred = 1029407 (fb51f hex)
5191=> print loadaddr
5192loadaddr=200000
5193=> print oftaddr
5194oftaddr=0x300000
5195=> bootm $loadaddr - $oftaddr
5196## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01005197 Image Name: Linux-2.6.17-dirty
5198 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5199 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005200 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01005201 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005202 Verifying Checksum ... OK
5203 Uncompressing Kernel Image ... OK
5204Booting using flat device tree at 0x300000
5205Using MPC85xx ADS machine description
5206Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
5207[snip]
5208
5209
wdenk6c59edc2004-05-03 20:45:30 +00005210More About U-Boot Image Types:
5211------------------------------
wdenkc6097192002-11-03 00:24:07 +00005212
wdenk6c59edc2004-05-03 20:45:30 +00005213U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00005214
wdenk6c59edc2004-05-03 20:45:30 +00005215 "Standalone Programs" are directly runnable in the environment
5216 provided by U-Boot; it is expected that (if they behave
5217 well) you can continue to work in U-Boot after return from
5218 the Standalone Program.
5219 "OS Kernel Images" are usually images of some Embedded OS which
5220 will take over control completely. Usually these programs
5221 will install their own set of exception handlers, device
5222 drivers, set up the MMU, etc. - this means, that you cannot
5223 expect to re-enter U-Boot except by resetting the CPU.
5224 "RAMDisk Images" are more or less just data blocks, and their
5225 parameters (address, size) are passed to an OS kernel that is
5226 being started.
5227 "Multi-File Images" contain several images, typically an OS
5228 (Linux) kernel image and one or more data images like
5229 RAMDisks. This construct is useful for instance when you want
5230 to boot over the network using BOOTP etc., where the boot
5231 server provides just a single image file, but you want to get
5232 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00005233
wdenk6c59edc2004-05-03 20:45:30 +00005234 "Multi-File Images" start with a list of image sizes, each
5235 image size (in bytes) specified by an "uint32_t" in network
5236 byte order. This list is terminated by an "(uint32_t)0".
5237 Immediately after the terminating 0 follow the images, one by
5238 one, all aligned on "uint32_t" boundaries (size rounded up to
5239 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00005240
wdenk6c59edc2004-05-03 20:45:30 +00005241 "Firmware Images" are binary images containing firmware (like
5242 U-Boot or FPGA images) which usually will be programmed to
5243 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00005244
wdenk6c59edc2004-05-03 20:45:30 +00005245 "Script files" are command sequences that will be executed by
5246 U-Boot's command interpreter; this feature is especially
5247 useful when you configure U-Boot to use a real shell (hush)
5248 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00005249
Marek Vasutcf41a9b2012-03-14 21:52:45 +00005250Booting the Linux zImage:
5251-------------------------
5252
5253On some platforms, it's possible to boot Linux zImage. This is done
5254using the "bootz" command. The syntax of "bootz" command is the same
5255as the syntax of "bootm" command.
5256
Tom Rini45f46d12013-05-16 11:40:11 -04005257Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut28850d02012-03-18 11:47:58 +00005258kernel with raw initrd images. The syntax is slightly different, the
5259address of the initrd must be augmented by it's size, in the following
5260format: "<initrd addres>:<initrd size>".
5261
stroeseb9c17c52003-04-04 15:53:41 +00005262
wdenk6c59edc2004-05-03 20:45:30 +00005263Standalone HOWTO:
5264=================
stroeseb9c17c52003-04-04 15:53:41 +00005265
wdenk6c59edc2004-05-03 20:45:30 +00005266One of the features of U-Boot is that you can dynamically load and
5267run "standalone" applications, which can use some resources of
5268U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00005269
wdenk6c59edc2004-05-03 20:45:30 +00005270Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00005271
wdenk6c59edc2004-05-03 20:45:30 +00005272"Hello World" Demo:
5273-------------------
wdenkc6097192002-11-03 00:24:07 +00005274
wdenk6c59edc2004-05-03 20:45:30 +00005275'examples/hello_world.c' contains a small "Hello World" Demo
5276application; it is automatically compiled when you build U-Boot.
5277It's configured to run at address 0x00040004, so you can play with it
5278like that:
wdenkc6097192002-11-03 00:24:07 +00005279
wdenk6c59edc2004-05-03 20:45:30 +00005280 => loads
5281 ## Ready for S-Record download ...
5282 ~>examples/hello_world.srec
5283 1 2 3 4 5 6 7 8 9 10 11 ...
5284 [file transfer complete]
5285 [connected]
5286 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005287
wdenk6c59edc2004-05-03 20:45:30 +00005288 => go 40004 Hello World! This is a test.
5289 ## Starting application at 0x00040004 ...
5290 Hello World
5291 argc = 7
5292 argv[0] = "40004"
5293 argv[1] = "Hello"
5294 argv[2] = "World!"
5295 argv[3] = "This"
5296 argv[4] = "is"
5297 argv[5] = "a"
5298 argv[6] = "test."
5299 argv[7] = "<NULL>"
5300 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00005301
wdenk6c59edc2004-05-03 20:45:30 +00005302 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005303
wdenk6c59edc2004-05-03 20:45:30 +00005304Another example, which demonstrates how to register a CPM interrupt
5305handler with the U-Boot code, can be found in 'examples/timer.c'.
5306Here, a CPM timer is set up to generate an interrupt every second.
5307The interrupt service routine is trivial, just printing a '.'
5308character, but this is just a demo program. The application can be
5309controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00005310
wdenk6c59edc2004-05-03 20:45:30 +00005311 ? - print current values og the CPM Timer registers
5312 b - enable interrupts and start timer
5313 e - stop timer and disable interrupts
5314 q - quit application
wdenkc6097192002-11-03 00:24:07 +00005315
wdenk6c59edc2004-05-03 20:45:30 +00005316 => loads
5317 ## Ready for S-Record download ...
5318 ~>examples/timer.srec
5319 1 2 3 4 5 6 7 8 9 10 11 ...
5320 [file transfer complete]
5321 [connected]
5322 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005323
wdenk6c59edc2004-05-03 20:45:30 +00005324 => go 40004
5325 ## Starting application at 0x00040004 ...
5326 TIMERS=0xfff00980
5327 Using timer 1
5328 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00005329
wdenk6c59edc2004-05-03 20:45:30 +00005330Hit 'b':
5331 [q, b, e, ?] Set interval 1000000 us
5332 Enabling timer
5333Hit '?':
5334 [q, b, e, ?] ........
5335 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5336Hit '?':
5337 [q, b, e, ?] .
5338 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5339Hit '?':
5340 [q, b, e, ?] .
5341 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5342Hit '?':
5343 [q, b, e, ?] .
5344 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5345Hit 'e':
5346 [q, b, e, ?] ...Stopping timer
5347Hit 'q':
5348 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005349
wdenkc6097192002-11-03 00:24:07 +00005350
wdenk6c59edc2004-05-03 20:45:30 +00005351Minicom warning:
5352================
wdenkc6097192002-11-03 00:24:07 +00005353
wdenk6c59edc2004-05-03 20:45:30 +00005354Over time, many people have reported problems when trying to use the
5355"minicom" terminal emulation program for serial download. I (wd)
5356consider minicom to be broken, and recommend not to use it. Under
5357Unix, I recommend to use C-Kermit for general purpose use (and
5358especially for kermit binary protocol download ("loadb" command), and
Karl O. Pinca0189bb2012-10-01 05:11:56 +00005359use "cu" for S-Record download ("loads" command). See
5360http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5361for help with kermit.
5362
wdenkc6097192002-11-03 00:24:07 +00005363
wdenk6c59edc2004-05-03 20:45:30 +00005364Nevertheless, if you absolutely want to use it try adding this
5365configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00005366
wdenk6c59edc2004-05-03 20:45:30 +00005367 Name Program Name U/D FullScr IO-Red. Multi
5368 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
5369 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00005370
wdenk8dba0502003-03-31 16:34:49 +00005371
wdenk6c59edc2004-05-03 20:45:30 +00005372NetBSD Notes:
5373=============
wdenkc6097192002-11-03 00:24:07 +00005374
wdenk6c59edc2004-05-03 20:45:30 +00005375Starting at version 0.9.2, U-Boot supports NetBSD both as host
5376(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00005377
wdenk6c59edc2004-05-03 20:45:30 +00005378Building requires a cross environment; it is known to work on
5379NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5380need gmake since the Makefiles are not compatible with BSD make).
5381Note that the cross-powerpc package does not install include files;
5382attempting to build U-Boot will fail because <machine/ansi.h> is
5383missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00005384
wdenk6c59edc2004-05-03 20:45:30 +00005385 # cd /usr/pkg/cross/powerpc-netbsd/include
5386 # mkdir powerpc
5387 # ln -s powerpc machine
5388 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5389 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00005390
wdenk6c59edc2004-05-03 20:45:30 +00005391Native builds *don't* work due to incompatibilities between native
5392and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00005393
wdenk6c59edc2004-05-03 20:45:30 +00005394Booting assumes that (the first part of) the image booted is a
5395stage-2 loader which in turn loads and then invokes the kernel
5396proper. Loader sources will eventually appear in the NetBSD source
5397tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00005398meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00005399
wdenkc6097192002-11-03 00:24:07 +00005400
wdenk6c59edc2004-05-03 20:45:30 +00005401Implementation Internals:
5402=========================
wdenkc6097192002-11-03 00:24:07 +00005403
wdenk6c59edc2004-05-03 20:45:30 +00005404The following is not intended to be a complete description of every
5405implementation detail. However, it should help to understand the
5406inner workings of U-Boot and make it easier to port it to custom
5407hardware.
wdenkc6097192002-11-03 00:24:07 +00005408
wdenkc6097192002-11-03 00:24:07 +00005409
wdenk6c59edc2004-05-03 20:45:30 +00005410Initial Stack, Global Data:
5411---------------------------
wdenkc6097192002-11-03 00:24:07 +00005412
wdenk6c59edc2004-05-03 20:45:30 +00005413The implementation of U-Boot is complicated by the fact that U-Boot
5414starts running out of ROM (flash memory), usually without access to
5415system RAM (because the memory controller is not initialized yet).
5416This means that we don't have writable Data or BSS segments, and BSS
5417is not initialized as zero. To be able to get a C environment working
5418at all, we have to allocate at least a minimal stack. Implementation
5419options for this are defined and restricted by the CPU used: Some CPU
5420models provide on-chip memory (like the IMMR area on MPC8xx and
5421MPC826x processors), on others (parts of) the data cache can be
5422locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00005423
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005424 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005425 U-Boot mailing list:
wdenkc6097192002-11-03 00:24:07 +00005426
wdenk6c59edc2004-05-03 20:45:30 +00005427 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
5428 From: "Chris Hallinan" <clh@net1plus.com>
5429 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
5430 ...
wdenkc6097192002-11-03 00:24:07 +00005431
wdenk6c59edc2004-05-03 20:45:30 +00005432 Correct me if I'm wrong, folks, but the way I understand it
5433 is this: Using DCACHE as initial RAM for Stack, etc, does not
5434 require any physical RAM backing up the cache. The cleverness
5435 is that the cache is being used as a temporary supply of
5436 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005437 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00005438 can see how this works by studying the cache architecture and
5439 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00005440
wdenk6c59edc2004-05-03 20:45:30 +00005441 OCM is On Chip Memory, which I believe the 405GP has 4K. It
5442 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005443 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00005444 option should work for you. Using CS 4 should be fine if your
5445 board designers haven't used it for something that would
5446 cause you grief during the initial boot! It is frequently not
5447 used.
wdenkc6097192002-11-03 00:24:07 +00005448
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005449 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00005450 with your processor/board/system design. The default value
5451 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02005452 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00005453 than your SDRAM module. If you have a 64MB SDRAM module, set
5454 it above 400_0000. Just make sure your board has no resources
5455 that are supposed to respond to that address! That code in
5456 start.S has been around a while and should work as is when
5457 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00005458
wdenk6c59edc2004-05-03 20:45:30 +00005459 -Chris Hallinan
5460 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00005461
wdenk6c59edc2004-05-03 20:45:30 +00005462It is essential to remember this, since it has some impact on the C
5463code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00005464
wdenk6c59edc2004-05-03 20:45:30 +00005465* Initialized global data (data segment) is read-only. Do not attempt
5466 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00005467
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005468* Do not use any uninitialized global data (or implicitly initialized
wdenk6c59edc2004-05-03 20:45:30 +00005469 as zero data - BSS segment) at all - this is undefined, initiali-
5470 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00005471
wdenk6c59edc2004-05-03 20:45:30 +00005472* Stack space is very limited. Avoid big data buffers or things like
5473 that.
wdenk4a5c8a72003-03-06 00:02:04 +00005474
wdenk6c59edc2004-05-03 20:45:30 +00005475Having only the stack as writable memory limits means we cannot use
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005476normal global data to share information between the code. But it
wdenk6c59edc2004-05-03 20:45:30 +00005477turned out that the implementation of U-Boot can be greatly
5478simplified by making a global data structure (gd_t) available to all
5479functions. We could pass a pointer to this data as argument to _all_
5480functions, but this would bloat the code. Instead we use a feature of
5481the GCC compiler (Global Register Variables) to share the data: we
5482place a pointer (gd) to the global data into a register which we
5483reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00005484
wdenk6c59edc2004-05-03 20:45:30 +00005485When choosing a register for such a purpose we are restricted by the
5486relevant (E)ABI specifications for the current architecture, and by
5487GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00005488
wdenk6c59edc2004-05-03 20:45:30 +00005489For PowerPC, the following registers have specific use:
5490 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01005491 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00005492 R3-R4: parameter passing and return values
5493 R5-R10: parameter passing
5494 R13: small data area pointer
5495 R30: GOT pointer
5496 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00005497
Joakim Tjernlund693c0c12010-01-19 14:41:58 +01005498 (U-Boot also uses R12 as internal GOT pointer. r12
5499 is a volatile register so r12 needs to be reset when
5500 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00005501
Wolfgang Denk69c09642008-02-14 22:43:22 +01005502 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005503
wdenk6c59edc2004-05-03 20:45:30 +00005504 Note: on PPC, we could use a static initializer (since the
5505 address of the global data structure is known at compile time),
5506 but it turned out that reserving a register results in somewhat
5507 smaller code - although the code savings are not that big (on
5508 average for all boards 752 bytes for the whole U-Boot image,
5509 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00005510
wdenk6c59edc2004-05-03 20:45:30 +00005511On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00005512
wdenk6c59edc2004-05-03 20:45:30 +00005513 R0: function argument word/integer result
5514 R1-R3: function argument word
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02005515 R9: platform specific
5516 R10: stack limit (used only if stack checking is enabled)
wdenk6c59edc2004-05-03 20:45:30 +00005517 R11: argument (frame) pointer
5518 R12: temporary workspace
5519 R13: stack pointer
5520 R14: link register
5521 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00005522
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02005523 ==> U-Boot will use R9 to hold a pointer to the global data
5524
5525 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00005526
Thomas Chou8fa38582010-05-21 11:08:03 +08005527On Nios II, the ABI is documented here:
5528 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
5529
5530 ==> U-Boot will use gp to hold a pointer to the global data
5531
5532 Note: on Nios II, we give "-G0" option to gcc and don't use gp
5533 to access small data sections, so gp is free.
5534
Macpaul Lin1cac36e2011-10-19 20:41:11 +00005535On NDS32, the following registers are used:
5536
5537 R0-R1: argument/return
5538 R2-R5: argument
5539 R15: temporary register for assembler
5540 R16: trampoline register
5541 R28: frame pointer (FP)
5542 R29: global pointer (GP)
5543 R30: link register (LP)
5544 R31: stack pointer (SP)
5545 PC: program counter (PC)
5546
5547 ==> U-Boot will use R10 to hold a pointer to the global data
5548
Wolfgang Denk6405a152006-03-31 18:32:53 +02005549NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5550or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00005551
wdenk6c59edc2004-05-03 20:45:30 +00005552Memory Management:
5553------------------
wdenkc6097192002-11-03 00:24:07 +00005554
wdenk6c59edc2004-05-03 20:45:30 +00005555U-Boot runs in system state and uses physical addresses, i.e. the
5556MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00005557
wdenk6c59edc2004-05-03 20:45:30 +00005558The available memory is mapped to fixed addresses using the memory
5559controller. In this process, a contiguous block is formed for each
5560memory type (Flash, SDRAM, SRAM), even when it consists of several
5561physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00005562
wdenk6c59edc2004-05-03 20:45:30 +00005563U-Boot is installed in the first 128 kB of the first Flash bank (on
5564TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5565booting and sizing and initializing DRAM, the code relocates itself
5566to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005567memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00005568configuration setting]. Below that, a structure with global Board
5569Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00005570
wdenk6c59edc2004-05-03 20:45:30 +00005571Additionally, some exception handler code is copied to the low 8 kB
5572of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00005573
wdenk6c59edc2004-05-03 20:45:30 +00005574So a typical memory configuration with 16 MB of DRAM could look like
5575this:
wdenkc6097192002-11-03 00:24:07 +00005576
wdenk6c59edc2004-05-03 20:45:30 +00005577 0x0000 0000 Exception Vector code
5578 :
5579 0x0000 1FFF
5580 0x0000 2000 Free for Application Use
5581 :
5582 :
wdenkc6097192002-11-03 00:24:07 +00005583
wdenk6c59edc2004-05-03 20:45:30 +00005584 :
5585 :
5586 0x00FB FF20 Monitor Stack (Growing downward)
5587 0x00FB FFAC Board Info Data and permanent copy of global data
5588 0x00FC 0000 Malloc Arena
5589 :
5590 0x00FD FFFF
5591 0x00FE 0000 RAM Copy of Monitor Code
5592 ... eventually: LCD or video framebuffer
5593 ... eventually: pRAM (Protected RAM - unchanged by reset)
5594 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00005595
wdenkc6097192002-11-03 00:24:07 +00005596
wdenk6c59edc2004-05-03 20:45:30 +00005597System Initialization:
5598----------------------
wdenkc6097192002-11-03 00:24:07 +00005599
wdenk6c59edc2004-05-03 20:45:30 +00005600In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005601(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005602configuration for CS0# this is a mirror of the on board Flash memory.
wdenk6c59edc2004-05-03 20:45:30 +00005603To be able to re-map memory U-Boot then jumps to its link address.
5604To be able to implement the initialization code in C, a (small!)
5605initial stack is set up in the internal Dual Ported RAM (in case CPUs
Heiko Schocher71cb3e92017-06-07 17:33:10 +02005606which provide such a feature like), or in a locked part of the data
5607cache. After that, U-Boot initializes the CPU core, the caches and
5608the SIU.
wdenkc6097192002-11-03 00:24:07 +00005609
wdenk6c59edc2004-05-03 20:45:30 +00005610Next, all (potentially) available memory banks are mapped using a
5611preliminary mapping. For example, we put them on 512 MB boundaries
5612(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5613on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5614programmed for SDRAM access. Using the temporary configuration, a
5615simple memory test is run that determines the size of the SDRAM
5616banks.
wdenkc6097192002-11-03 00:24:07 +00005617
wdenk6c59edc2004-05-03 20:45:30 +00005618When there is more than one SDRAM bank, and the banks are of
5619different size, the largest is mapped first. For equal size, the first
5620bank (CS2#) is mapped first. The first mapping is always for address
56210x00000000, with any additional banks following immediately to create
5622contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00005623
wdenk6c59edc2004-05-03 20:45:30 +00005624Then, the monitor installs itself at the upper end of the SDRAM area
5625and allocates memory for use by malloc() and for the global Board
5626Info data; also, the exception vector code is copied to the low RAM
5627pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00005628
wdenk6c59edc2004-05-03 20:45:30 +00005629Only after this relocation will you have a "normal" C environment;
5630until that you are restricted in several ways, mostly because you are
5631running from ROM, and because the code will have to be relocated to a
5632new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00005633
wdenkc6097192002-11-03 00:24:07 +00005634
wdenk6c59edc2004-05-03 20:45:30 +00005635U-Boot Porting Guide:
5636----------------------
wdenkc6097192002-11-03 00:24:07 +00005637
wdenk6c59edc2004-05-03 20:45:30 +00005638[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
5639list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00005640
wdenkc6097192002-11-03 00:24:07 +00005641
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005642int main(int argc, char *argv[])
wdenk6c59edc2004-05-03 20:45:30 +00005643{
5644 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00005645
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005646 signal(SIGALRM, no_more_time);
5647 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00005648
wdenk6c59edc2004-05-03 20:45:30 +00005649 if (available_money > available_manpower) {
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005650 Pay consultant to port U-Boot;
wdenk6c59edc2004-05-03 20:45:30 +00005651 return 0;
5652 }
wdenkc6097192002-11-03 00:24:07 +00005653
wdenk6c59edc2004-05-03 20:45:30 +00005654 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00005655
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005656 Subscribe to u-boot mailing list;
wdenkc6097192002-11-03 00:24:07 +00005657
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005658 if (clueless)
5659 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00005660
wdenk6c59edc2004-05-03 20:45:30 +00005661 while (learning) {
5662 Read the README file in the top level directory;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005663 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
5664 Read applicable doc/*.README;
wdenk6c59edc2004-05-03 20:45:30 +00005665 Read the source, Luke;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005666 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk6c59edc2004-05-03 20:45:30 +00005667 }
wdenkc6097192002-11-03 00:24:07 +00005668
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005669 if (available_money > toLocalCurrency ($2500))
5670 Buy a BDI3000;
5671 else
wdenk6c59edc2004-05-03 20:45:30 +00005672 Add a lot of aggravation and time;
wdenkc6097192002-11-03 00:24:07 +00005673
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005674 if (a similar board exists) { /* hopefully... */
5675 cp -a board/<similar> board/<myboard>
5676 cp include/configs/<similar>.h include/configs/<myboard>.h
5677 } else {
5678 Create your own board support subdirectory;
5679 Create your own board include/configs/<myboard>.h file;
5680 }
5681 Edit new board/<myboard> files
5682 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00005683
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005684 while (!accepted) {
5685 while (!running) {
5686 do {
5687 Add / modify source code;
5688 } until (compiles);
5689 Debug;
5690 if (clueless)
5691 email("Hi, I am having problems...");
5692 }
5693 Send patch file to the U-Boot email list;
5694 if (reasonable critiques)
5695 Incorporate improvements from email list code review;
5696 else
5697 Defend code as written;
wdenk634d2f72004-04-15 23:14:49 +00005698 }
wdenkc6097192002-11-03 00:24:07 +00005699
wdenk6c59edc2004-05-03 20:45:30 +00005700 return 0;
5701}
wdenkc6097192002-11-03 00:24:07 +00005702
wdenk6c59edc2004-05-03 20:45:30 +00005703void no_more_time (int sig)
5704{
5705 hire_a_guru();
5706}
wdenkc6097192002-11-03 00:24:07 +00005707
wdenkc6097192002-11-03 00:24:07 +00005708
wdenk6c59edc2004-05-03 20:45:30 +00005709Coding Standards:
5710-----------------
wdenkc6097192002-11-03 00:24:07 +00005711
wdenk6c59edc2004-05-03 20:45:30 +00005712All contributions to U-Boot should conform to the Linux kernel
Detlev Zundelaa63d482006-09-01 15:39:02 +02005713coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005714"scripts/Lindent" in your Linux kernel source directory.
Detlev Zundelaa63d482006-09-01 15:39:02 +02005715
5716Source files originating from a different project (for example the
5717MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005718reformatted to ease subsequent migration to newer versions of those
Detlev Zundelaa63d482006-09-01 15:39:02 +02005719sources.
wdenkc6097192002-11-03 00:24:07 +00005720
Detlev Zundelaa63d482006-09-01 15:39:02 +02005721Please note that U-Boot is implemented in C (and to some small parts in
5722Assembler); no C++ is used, so please do not use C++ style comments (//)
5723in your code.
wdenkad276f22004-01-04 16:28:35 +00005724
wdenk6c59edc2004-05-03 20:45:30 +00005725Please also stick to the following formatting rules:
5726- remove any trailing white space
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005727- use TAB characters for indentation and vertical alignment, not spaces
wdenk6c59edc2004-05-03 20:45:30 +00005728- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005729- do not add more than 2 consecutive empty lines to source files
wdenk6c59edc2004-05-03 20:45:30 +00005730- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00005731
wdenk6c59edc2004-05-03 20:45:30 +00005732Submissions which do not conform to the standards may be returned
5733with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00005734
wdenkc6097192002-11-03 00:24:07 +00005735
wdenk6c59edc2004-05-03 20:45:30 +00005736Submitting Patches:
5737-------------------
wdenkc6097192002-11-03 00:24:07 +00005738
wdenk6c59edc2004-05-03 20:45:30 +00005739Since the number of patches for U-Boot is growing, we need to
5740establish some rules. Submissions which do not conform to these rules
5741may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00005742
Magnus Liljaf3b287b2008-08-06 19:32:33 +02005743Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005744
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005745Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
5746see http://lists.denx.de/mailman/listinfo/u-boot
5747
wdenk6c59edc2004-05-03 20:45:30 +00005748When you send a patch, please include the following information with
5749it:
wdenkc6097192002-11-03 00:24:07 +00005750
wdenk6c59edc2004-05-03 20:45:30 +00005751* For bug fixes: a description of the bug and how your patch fixes
5752 this bug. Please try to include a way of demonstrating that the
5753 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00005754
wdenk6c59edc2004-05-03 20:45:30 +00005755* For new features: a description of the feature and your
5756 implementation.
wdenkc6097192002-11-03 00:24:07 +00005757
wdenk6c59edc2004-05-03 20:45:30 +00005758* A CHANGELOG entry as plaintext (separate from the patch)
wdenkc6097192002-11-03 00:24:07 +00005759
Robert P. J. Day076ed9b2015-12-19 07:16:10 -05005760* For major contributions, add a MAINTAINERS file with your
5761 information and associated file and directory references.
wdenkc6097192002-11-03 00:24:07 +00005762
Albert ARIBAUD48e910f2013-09-11 15:52:51 +02005763* When you add support for a new board, don't forget to add a
5764 maintainer e-mail address to the boards.cfg file, too.
wdenkc6097192002-11-03 00:24:07 +00005765
wdenk6c59edc2004-05-03 20:45:30 +00005766* If your patch adds new configuration options, don't forget to
5767 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00005768
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005769* The patch itself. If you are using git (which is *strongly*
5770 recommended) you can easily generate the patch using the
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005771 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005772 the U-Boot mailing list, you will avoid most of the common problems
5773 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00005774
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005775 If you cannot use git, use "diff -purN OLD NEW". If your version of
5776 diff does not support these options, then get the latest version of
5777 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00005778
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005779 The current directory when running this command shall be the parent
5780 directory of the U-Boot source tree (i. e. please make sure that
5781 your patch includes sufficient directory information for the
5782 affected files).
5783
5784 We prefer patches as plain text. MIME attachments are discouraged,
5785 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00005786
wdenk6c59edc2004-05-03 20:45:30 +00005787* If one logical set of modifications affects or creates several
5788 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00005789
wdenk6c59edc2004-05-03 20:45:30 +00005790* Changesets that contain different, unrelated modifications shall be
5791 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00005792
wdenkc6097192002-11-03 00:24:07 +00005793
wdenk6c59edc2004-05-03 20:45:30 +00005794Notes:
wdenkc6097192002-11-03 00:24:07 +00005795
Simon Glassdc27def2016-07-27 20:33:08 -06005796* Before sending the patch, run the buildman script on your patched
wdenk6c59edc2004-05-03 20:45:30 +00005797 source tree and make sure that no errors or warnings are reported
5798 for any of the boards.
5799
5800* Keep your modifications to the necessary minimum: A patch
5801 containing several unrelated changes or arbitrary reformats will be
5802 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00005803
wdenk6c59edc2004-05-03 20:45:30 +00005804* If you modify existing code, make sure that your new code does not
5805 add to the memory footprint of the code ;-) Small is beautiful!
5806 When adding new features, these should compile conditionally only
5807 (using #ifdef), and the resulting code with the new feature
5808 disabled must not need more memory than the old code without your
5809 modification.
wdenkcbc49a52005-05-03 14:12:25 +00005810
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005811* Remember that there is a size limit of 100 kB per message on the
5812 u-boot mailing list. Bigger patches will be moderated. If they are
5813 reasonable and not too big, they will be acknowledged. But patches
5814 bigger than the size limit should be avoided.