blob: 2abba91b6475d0781e1791336f6e5a37d3966cbc [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)
836 CONFIG_CMD_SETGETDCR Support for DCR Register access
837 (4xx only)
Eric Nelson97f5f8f2012-01-31 10:52:08 -0700838 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Bob Liua671b702013-02-05 19:05:41 +0800839 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk85c25df2009-04-01 23:34:12 +0200840 CONFIG_CMD_SOURCE "source" command Support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500841 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7aa81a42011-05-17 00:03:40 +0000842 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass6a398d22011-10-24 18:00:07 +0000843 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershberger59f3f522012-10-03 12:14:57 +0000844 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
845 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500846 CONFIG_CMD_USB * USB support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500847 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasut71729392012-03-31 07:47:16 +0000848 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200849 CONFIG_CMD_XIMG Load part of Multi Image
Przemyslaw Marczak2eb40ee2014-04-02 10:20:05 +0200850 CONFIG_CMD_UUID * Generate random UUID or GUID string
wdenkc6097192002-11-03 00:24:07 +0000851
852 EXAMPLE: If you want all functions except of network
853 support you can write:
854
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500855 #include "config_cmd_all.h"
856 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000857
Gerald Van Barend6abef42007-03-31 12:23:51 -0400858 Other Commands:
859 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000860
861 Note: Don't enable the "icache" and "dcache" commands
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500862 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk4a5c8a72003-03-06 00:02:04 +0000863 what you (and your U-Boot users) are doing. Data
Heiko Schocher65d94db2017-06-07 17:33:09 +0200864 cache cannot be enabled on systems like the
wdenk4a5c8a72003-03-06 00:02:04 +0000865 8260 (where accesses to the IMMR region must be
866 uncached), and it cannot be disabled on all other
867 systems where we (mis-) use the data cache to hold an
868 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000869
870
871 XXX - this list needs to get updated!
872
Simon Glassaa34ef22016-03-13 19:07:28 -0600873- Removal of commands
874 If no commands are needed to boot, you can disable
875 CONFIG_CMDLINE to remove them. In this case, the command line
876 will not be available, and when U-Boot wants to execute the
877 boot command (on start-up) it will call board_run_command()
878 instead. This can reduce image size significantly for very
879 simple boot procedures.
880
Wolfgang Denk2aceea12013-03-23 23:50:31 +0000881- Regular expression support:
882 CONFIG_REGEX
Wolfgang Denkec7fbf52013-10-04 17:43:24 +0200883 If this variable is defined, U-Boot is linked against
884 the SLRE (Super Light Regular Expression) library,
885 which adds regex support to some commands, as for
886 example "env grep" and "setexpr".
Wolfgang Denk2aceea12013-03-23 23:50:31 +0000887
Simon Glass3d686442011-10-15 05:48:20 +0000888- Device tree:
889 CONFIG_OF_CONTROL
890 If this variable is defined, U-Boot will use a device tree
891 to configure its devices, instead of relying on statically
892 compiled #defines in the board file. This option is
893 experimental and only available on a few boards. The device
894 tree is available in the global data as gd->fdt_blob.
895
Simon Glass5cb34db2011-10-24 19:15:31 +0000896 U-Boot needs to get its device tree from somewhere. This can
Alex Deymo5b661ec2017-04-02 01:25:20 -0700897 be done using one of the three options below:
Simon Glass38d6b8d2011-10-15 05:48:21 +0000898
899 CONFIG_OF_EMBED
900 If this variable is defined, U-Boot will embed a device tree
901 binary in its image. This device tree file should be in the
902 board directory and called <soc>-<board>.dts. The binary file
903 is then picked up in board_init_f() and made available through
904 the global data structure as gd->blob.
Simon Glass3d686442011-10-15 05:48:20 +0000905
Simon Glass5cb34db2011-10-24 19:15:31 +0000906 CONFIG_OF_SEPARATE
907 If this variable is defined, U-Boot will build a device tree
908 binary. It will be called u-boot.dtb. Architecture-specific
909 code will locate it at run-time. Generally this works by:
910
911 cat u-boot.bin u-boot.dtb >image.bin
912
913 and in fact, U-Boot does this for you, creating a file called
914 u-boot-dtb.bin which is useful in the common case. You can
915 still use the individual files if you need something more
916 exotic.
917
Alex Deymo5b661ec2017-04-02 01:25:20 -0700918 CONFIG_OF_BOARD
919 If this variable is defined, U-Boot will use the device tree
920 provided by the board at runtime instead of embedding one with
921 the image. Only boards defining board_fdt_blob_setup() support
922 this option (see include/fdtdec.h file).
923
wdenkc6097192002-11-03 00:24:07 +0000924- Watchdog:
925 CONFIG_WATCHDOG
926 If this variable is defined, it enables watchdog
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +0000927 support for the SoC. There must be support in the SoC
Heiko Schocher71cb3e92017-06-07 17:33:10 +0200928 specific code for a watchdog. When supported for a
929 specific SoC is available, then no further board specific
930 code should be needed to use it.
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +0000931
932 CONFIG_HW_WATCHDOG
933 When using a watchdog circuitry external to the used
934 SoC, then define this variable and provide board
935 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000936
Heiko Schocher735326c2015-01-21 08:38:22 +0100937 CONFIG_AT91_HW_WDT_TIMEOUT
938 specify the timeout in seconds. default 2 seconds.
939
stroeseb9c17c52003-04-04 15:53:41 +0000940- U-Boot Version:
941 CONFIG_VERSION_VARIABLE
942 If this variable is defined, an environment variable
943 named "ver" is created by U-Boot showing the U-Boot
944 version as printed by the "version" command.
Benoît Thébaudeauce9a1552012-08-13 15:01:14 +0200945 Any change to this variable will be reverted at the
946 next reset.
stroeseb9c17c52003-04-04 15:53:41 +0000947
wdenkc6097192002-11-03 00:24:07 +0000948- Real-Time Clock:
949
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500950 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000951 has to be selected, too. Define exactly one of the
952 following options:
953
wdenkc6097192002-11-03 00:24:07 +0000954 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam3f8d1782011-10-24 06:44:15 +0000955 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +0000956 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1fe2c702003-03-06 21:55:29 +0000957 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000958 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk0893c472003-05-20 14:25:27 +0000959 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel90491f22014-07-21 11:06:16 +0200960 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenkef5fe752003-03-12 10:41:04 +0000961 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krillb27939b2008-03-15 15:40:26 +0100962 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenkaeba06f2004-06-09 17:34:58 +0000963 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Chris Packham2d3ac512017-05-30 12:03:33 +1200964 CONFIG_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher1f1b7012011-03-28 09:24:22 +0200965 CONFIG_SYS_RV3029_TCR - enable trickle charger on
966 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +0000967
wdenkb9bbd242003-06-30 16:24:52 +0000968 Note that if the RTC uses I2C, then the I2C interface
969 must also be configured. See I2C Support, below.
970
Peter Tyser9902e422008-12-17 16:36:21 -0600971- GPIO Support:
972 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tyser9902e422008-12-17 16:36:21 -0600973
Chris Packham9b383202010-12-19 10:12:13 +0000974 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
975 chip-ngpio pairs that tell the PCA953X driver the number of
976 pins supported by a particular chip.
977
Peter Tyser9902e422008-12-17 16:36:21 -0600978 Note that if the GPIO device uses I2C, then the I2C interface
979 must also be configured. See I2C Support, below.
980
Simon Glass4dc47ca2014-06-11 23:29:41 -0600981- I/O tracing:
982 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
983 accesses and can checksum them or write a list of them out
984 to memory. See the 'iotrace' command for details. This is
985 useful for testing device drivers since it can confirm that
986 the driver behaves the same way before and after a code
987 change. Currently this is supported on sandbox and arm. To
988 add support for your architecture, add '#include <iotrace.h>'
989 to the bottom of arch/<arch>/include/asm/io.h and test.
990
991 Example output from the 'iotrace stats' command is below.
992 Note that if the trace buffer is exhausted, the checksum will
993 still continue to operate.
994
995 iotrace is enabled
996 Start: 10000000 (buffer start address)
997 Size: 00010000 (buffer size)
998 Offset: 00000120 (current buffer offset)
999 Output: 10000120 (start + offset)
1000 Count: 00000018 (number of trace records)
1001 CRC32: 9526fb66 (CRC32 of all trace records)
1002
wdenkc6097192002-11-03 00:24:07 +00001003- Timestamp Support:
1004
wdenk4a5c8a72003-03-06 00:02:04 +00001005 When CONFIG_TIMESTAMP is selected, the timestamp
1006 (date and time) of an image is printed by image
1007 commands like bootm or iminfo. This option is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001008 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001009
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001010- Partition Labels (disklabels) Supported:
1011 Zero or more of the following:
1012 CONFIG_MAC_PARTITION Apple's MacOS partition table.
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001013 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1014 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1015 bootloader. Note 2TB partition limit; see
1016 disk/part_efi.c
1017 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001018
Simon Glassb569a012017-05-17 03:25:30 -06001019 If IDE or SCSI support is enabled (CONFIG_IDE or
Simon Glass8706b812016-05-01 11:36:02 -06001020 CONFIG_SCSI) you must configure support for at
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001021 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001022
1023- IDE Reset method:
wdenk369d43d2004-03-14 14:09:05 +00001024 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1025 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001026
wdenk369d43d2004-03-14 14:09:05 +00001027 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1028 be performed by calling the function
1029 ide_set_reset(int reset)
1030 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001031
1032- ATAPI Support:
1033 CONFIG_ATAPI
1034
1035 Set this to enable ATAPI support.
1036
wdenkf602aa02004-03-13 23:29:43 +00001037- LBA48 Support
1038 CONFIG_LBA48
1039
1040 Set this to enable support for disks larger than 137GB
Heiko Schocher0f602e12009-12-03 11:21:21 +01001041 Also look at CONFIG_SYS_64BIT_LBA.
wdenkf602aa02004-03-13 23:29:43 +00001042 Whithout these , LBA48 support uses 32bit variables and will 'only'
1043 support disks up to 2.1TB.
1044
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001045 CONFIG_SYS_64BIT_LBA:
wdenkf602aa02004-03-13 23:29:43 +00001046 When enabled, makes the IDE subsystem use 64bit sector addresses.
1047 Default is 32bit.
1048
wdenkc6097192002-11-03 00:24:07 +00001049- SCSI Support:
1050 At the moment only there is only support for the
1051 SYM53C8XX SCSI controller; define
1052 CONFIG_SCSI_SYM53C8XX to enable it.
1053
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001054 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1055 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1056 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001057 maximum numbers of LUNs, SCSI ID's and target
1058 devices.
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001059 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001060
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001061 The environment variable 'scsidevs' is set to the number of
1062 SCSI devices found during the last scan.
Stefan Reinauere50a10e2012-10-29 05:23:48 +00001063
wdenkc6097192002-11-03 00:24:07 +00001064- NETWORK Support (PCI):
wdenk4e112c12003-06-03 23:54:09 +00001065 CONFIG_E1000
Kyle Moffett64b94dd2011-10-18 11:05:29 +00001066 Support for Intel 8254x/8257x gigabit chips.
1067
1068 CONFIG_E1000_SPI
1069 Utility code for direct access to the SPI bus on Intel 8257x.
1070 This does not do anything useful unless you set at least one
1071 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1072
1073 CONFIG_E1000_SPI_GENERIC
1074 Allow generic access to the SPI bus on the Intel 8257x, for
1075 example with the "sspi" command.
1076
1077 CONFIG_CMD_E1000
1078 Management command for E1000 devices. When used on devices
1079 with SPI support you can reprogram the EEPROM from U-Boot.
stroese94ef1cf2003-06-05 15:39:44 +00001080
wdenkc6097192002-11-03 00:24:07 +00001081 CONFIG_EEPRO100
1082 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001083 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001084 write routine for first time initialisation.
1085
1086 CONFIG_TULIP
1087 Support for Digital 2114x chips.
1088 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1089 modem chip initialisation (KS8761/QS6611).
1090
1091 CONFIG_NATSEMI
1092 Support for National dp83815 chips.
1093
1094 CONFIG_NS8382X
1095 Support for National dp8382[01] gigabit chips.
1096
wdenkaa603362003-05-12 21:50:16 +00001097- NETWORK Support (other):
1098
Jens Scharsigdab7cb82010-01-23 12:03:45 +01001099 CONFIG_DRIVER_AT91EMAC
1100 Support for AT91RM9200 EMAC.
1101
1102 CONFIG_RMII
1103 Define this to use reduced MII inteface
1104
1105 CONFIG_DRIVER_AT91EMAC_QUIET
1106 If this defined, the driver is quiet.
1107 The driver doen't show link status messages.
1108
Rob Herringc9830dc2011-12-15 11:15:49 +00001109 CONFIG_CALXEDA_XGMAC
1110 Support for the Calxeda XGMAC device
1111
Ashok93fb8722012-10-15 06:20:47 +00001112 CONFIG_LAN91C96
wdenkaa603362003-05-12 21:50:16 +00001113 Support for SMSC's LAN91C96 chips.
1114
wdenkaa603362003-05-12 21:50:16 +00001115 CONFIG_LAN91C96_USE_32_BIT
1116 Define this to enable 32 bit addressing
1117
Ashok93fb8722012-10-15 06:20:47 +00001118 CONFIG_SMC91111
wdenk3c711762004-06-09 13:37:52 +00001119 Support for SMSC's LAN91C111 chip
1120
1121 CONFIG_SMC91111_BASE
1122 Define this to hold the physical address
1123 of the device (I/O space)
1124
1125 CONFIG_SMC_USE_32_BIT
1126 Define this if data bus is 32 bits
1127
1128 CONFIG_SMC_USE_IOFUNCS
1129 Define this to use i/o functions instead of macros
1130 (some hardware wont work with macros)
1131
Heiko Schocher7d037f72011-11-15 10:00:04 -05001132 CONFIG_DRIVER_TI_EMAC
1133 Support for davinci emac
1134
1135 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1136 Define this if you have more then 3 PHYs.
1137
Macpaul Lin199c6252010-12-21 16:59:46 +08001138 CONFIG_FTGMAC100
1139 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1140
1141 CONFIG_FTGMAC100_EGIGA
1142 Define this to use GE link update with gigabit PHY.
1143 Define this if FTGMAC100 is connected to gigabit PHY.
1144 If your system has 10/100 PHY only, it might not occur
1145 wrong behavior. Because PHY usually return timeout or
1146 useless data when polling gigabit status and gigabit
1147 control registers. This behavior won't affect the
1148 correctnessof 10/100 link speed update.
1149
Mike Rapoportf4761af2009-11-11 10:03:03 +02001150 CONFIG_SMC911X
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001151 Support for SMSC's LAN911x and LAN921x chips
1152
Mike Rapoportf4761af2009-11-11 10:03:03 +02001153 CONFIG_SMC911X_BASE
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001154 Define this to hold the physical address
1155 of the device (I/O space)
1156
Mike Rapoportf4761af2009-11-11 10:03:03 +02001157 CONFIG_SMC911X_32_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001158 Define this if data bus is 32 bits
1159
Mike Rapoportf4761af2009-11-11 10:03:03 +02001160 CONFIG_SMC911X_16_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001161 Define this if data bus is 16 bits. If your processor
1162 automatically converts one 32 bit word to two 16 bit
Mike Rapoportf4761af2009-11-11 10:03:03 +02001163 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001164
Yoshihiro Shimodaed4cea02011-01-27 10:06:03 +09001165 CONFIG_SH_ETHER
1166 Support for Renesas on-chip Ethernet controller
1167
1168 CONFIG_SH_ETHER_USE_PORT
1169 Define the number of ports to be used
1170
1171 CONFIG_SH_ETHER_PHY_ADDR
1172 Define the ETH PHY's address
1173
Yoshihiro Shimoda281aa052011-01-27 10:06:08 +09001174 CONFIG_SH_ETHER_CACHE_WRITEBACK
1175 If this option is set, the driver enables cache flush.
1176
Heiko Schocher2b387762014-07-18 06:07:19 +02001177- PWM Support:
1178 CONFIG_PWM_IMX
Robert P. J. Day1f8378a2016-09-13 08:35:18 -04001179 Support for PWM module on the imx6.
Heiko Schocher2b387762014-07-18 06:07:19 +02001180
Vadim Bendeburydac69642011-10-17 08:36:14 +00001181- TPM Support:
Che-liang Chiouacea5702013-04-12 11:04:34 +00001182 CONFIG_TPM
1183 Support TPM devices.
1184
Christophe Ricard8759ff82015-10-06 22:54:41 +02001185 CONFIG_TPM_TIS_INFINEON
1186 Support for Infineon i2c bus TPM devices. Only one device
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001187 per system is supported at this time.
1188
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001189 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1190 Define the burst count bytes upper limit
1191
Christophe Ricard88249232016-01-21 23:27:13 +01001192 CONFIG_TPM_ST33ZP24
1193 Support for STMicroelectronics TPM devices. Requires DM_TPM support.
1194
1195 CONFIG_TPM_ST33ZP24_I2C
1196 Support for STMicroelectronics ST33ZP24 I2C devices.
1197 Requires TPM_ST33ZP24 and I2C.
1198
Christophe Ricard5ffadc32016-01-21 23:27:14 +01001199 CONFIG_TPM_ST33ZP24_SPI
1200 Support for STMicroelectronics ST33ZP24 SPI devices.
1201 Requires TPM_ST33ZP24 and SPI.
1202
Dirk Eibach20489092013-06-26 15:55:15 +02001203 CONFIG_TPM_ATMEL_TWI
1204 Support for Atmel TWI TPM device. Requires I2C support.
1205
Che-liang Chiouacea5702013-04-12 11:04:34 +00001206 CONFIG_TPM_TIS_LPC
Vadim Bendeburydac69642011-10-17 08:36:14 +00001207 Support for generic parallel port TPM devices. Only one device
1208 per system is supported at this time.
1209
1210 CONFIG_TPM_TIS_BASE_ADDRESS
1211 Base address where the generic TPM device is mapped
1212 to. Contemporary x86 systems usually map it at
1213 0xfed40000.
1214
Reinhard Pfau4fece432013-06-26 15:55:13 +02001215 CONFIG_CMD_TPM
1216 Add tpm monitor functions.
1217 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1218 provides monitor access to authorized functions.
1219
1220 CONFIG_TPM
1221 Define this to enable the TPM support library which provides
1222 functional interfaces to some TPM commands.
1223 Requires support for a TPM device.
1224
1225 CONFIG_TPM_AUTH_SESSIONS
1226 Define this to enable authorized functions in the TPM library.
1227 Requires CONFIG_TPM and CONFIG_SHA1.
1228
wdenkc6097192002-11-03 00:24:07 +00001229- USB Support:
1230 At the moment only the UHCI host controller is
Heiko Schocher6f90e582017-06-14 05:49:40 +02001231 supported (PIP405, MIP405); define
wdenkc6097192002-11-03 00:24:07 +00001232 CONFIG_USB_UHCI to enable it.
1233 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenkfb30b4c2004-10-09 22:44:59 +00001234 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001235 storage devices.
1236 Note:
1237 Supported are USB Keyboards and USB Floppy drives
1238 (TEAC FD-05PUB).
wdenk369d43d2004-03-14 14:09:05 +00001239
Simon Glass5978cdb2012-02-27 10:52:47 +00001240 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1241 txfilltuning field in the EHCI controller on reset.
1242
Oleksandr Tymoshenko7a881752014-02-01 21:51:25 -07001243 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1244 HW module registers.
1245
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001246- USB Device:
1247 Define the below if you wish to use the USB console.
1248 Once firmware is rebuilt from a serial console issue the
1249 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001250 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001251 it has found a new device. The environment variable usbtty
1252 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denke2601822006-06-14 18:14:56 +02001253 appear to a USB host as a Linux gserial device or a
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001254 Common Device Class Abstract Control Model serial device.
1255 If you select usbtty = gserial you should be able to enumerate
1256 a Linux host by
1257 # modprobe usbserial vendor=0xVendorID product=0xProductID
1258 else if using cdc_acm, simply setting the environment
1259 variable usbtty to be cdc_acm should suffice. The following
1260 might be defined in YourBoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001261
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001262 CONFIG_USB_DEVICE
1263 Define this to build a UDC device
1264
1265 CONFIG_USB_TTY
1266 Define this to have a tty type of device available to
1267 talk to the UDC device
Wolfgang Denke2601822006-06-14 18:14:56 +02001268
Vipin KUMARbdb17702012-03-26 15:38:06 +05301269 CONFIG_USBD_HS
1270 Define this to enable the high speed support for usb
1271 device and usbtty. If this feature is enabled, a routine
1272 int is_usbd_high_speed(void)
1273 also needs to be defined by the driver to dynamically poll
1274 whether the enumeration has succeded at high speed or full
1275 speed.
1276
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001277 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001278 Define this if you want stdin, stdout &/or stderr to
1279 be set to usbtty.
1280
Wolfgang Denke2601822006-06-14 18:14:56 +02001281 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001282 define your own vendor specific values either in BoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001283 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001284 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1285 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1286 should pretend to be a Linux device to it's target host.
1287
1288 CONFIG_USBD_MANUFACTURER
1289 Define this string as the name of your company for
1290 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denke2601822006-06-14 18:14:56 +02001291
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001292 CONFIG_USBD_PRODUCT_NAME
1293 Define this string as the name of your product
1294 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
wdenkc6097192002-11-03 00:24:07 +00001295
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001296 CONFIG_USBD_VENDORID
1297 Define this as your assigned Vendor ID from the USB
1298 Implementors Forum. This *must* be a genuine Vendor ID
1299 to avoid polluting the USB namespace.
1300 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001301
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001302 CONFIG_USBD_PRODUCTID
1303 Define this as the unique Product ID
1304 for your device
1305 - CONFIG_USBD_PRODUCTID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001306
Igor Grinbergac5f6ee2011-12-12 12:08:35 +02001307- ULPI Layer Support:
1308 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1309 the generic ULPI layer. The generic layer accesses the ULPI PHY
1310 via the platform viewport, so you need both the genric layer and
1311 the viewport enabled. Currently only Chipidea/ARC based
1312 viewport is supported.
1313 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1314 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stachf31e4112012-10-01 00:44:35 +02001315 If your ULPI phy needs a different reference clock than the
1316 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1317 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001318
wdenk7a428cc2003-06-15 22:40:42 +00001319- MMC Support:
wdenk57b2d802003-06-27 21:31:46 +00001320 The MMC controller on the Intel PXA is supported. To
1321 enable this define CONFIG_MMC. The MMC can be
1322 accessed from the boot prompt by mapping the device
wdenk7a428cc2003-06-15 22:40:42 +00001323 to physical memory similar to flash. Command line is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001324 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1325 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenk7a428cc2003-06-15 22:40:42 +00001326
Yoshihiro Shimodadb7717b2011-07-04 22:21:22 +00001327 CONFIG_SH_MMCIF
1328 Support for Renesas on-chip MMCIF controller
1329
1330 CONFIG_SH_MMCIF_ADDR
1331 Define the base address of MMCIF registers
1332
1333 CONFIG_SH_MMCIF_CLK
1334 Define the clock frequency for MMCIF
1335
Pierre Aubertbcc302c2014-04-24 10:30:08 +02001336 CONFIG_SUPPORT_EMMC_BOOT
1337 Enable some additional features of the eMMC boot partitions.
1338
1339 CONFIG_SUPPORT_EMMC_RPMB
1340 Enable the commands for reading, writing and programming the
1341 key for the Replay Protection Memory Block partition in eMMC.
1342
Tom Rini58a8d322013-03-14 05:32:47 +00001343- USB Device Firmware Update (DFU) class support:
Paul Kocialkowski045d6052015-06-12 19:56:58 +02001344 CONFIG_USB_FUNCTION_DFU
Tom Rini58a8d322013-03-14 05:32:47 +00001345 This enables the USB portion of the DFU USB class
1346
1347 CONFIG_CMD_DFU
1348 This enables the command "dfu" which is used to have
1349 U-Boot create a DFU class device via USB. This command
1350 requires that the "dfu_alt_info" environment variable be
1351 set and define the alt settings to expose to the host.
1352
1353 CONFIG_DFU_MMC
1354 This enables support for exposing (e)MMC devices via DFU.
1355
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +00001356 CONFIG_DFU_NAND
1357 This enables support for exposing NAND devices via DFU.
1358
Afzal Mohammede3c687a2013-09-18 01:15:24 +05301359 CONFIG_DFU_RAM
1360 This enables support for exposing RAM via DFU.
1361 Note: DFU spec refer to non-volatile memory usage, but
1362 allow usages beyond the scope of spec - here RAM usage,
1363 one that would help mostly the developer.
1364
Heiko Schochera2f831e2013-06-12 06:05:51 +02001365 CONFIG_SYS_DFU_DATA_BUF_SIZE
1366 Dfu transfer uses a buffer before writing data to the
1367 raw storage device. Make the size (in bytes) of this buffer
1368 configurable. The size of this buffer is also configurable
1369 through the "dfu_bufsiz" environment variable.
1370
Pantelis Antonioua6e788d2013-03-14 05:32:48 +00001371 CONFIG_SYS_DFU_MAX_FILE_SIZE
1372 When updating files rather than the raw storage device,
1373 we use a static buffer to copy the file into and then write
1374 the buffer once we've been given the whole file. Define
1375 this to the maximum filesize (in bytes) for the buffer.
1376 Default is 4 MiB if undefined.
1377
Heiko Schochere1ba1512014-03-18 08:09:56 +01001378 DFU_DEFAULT_POLL_TIMEOUT
1379 Poll timeout [ms], is the timeout a device can send to the
1380 host. The host must wait for this timeout before sending
1381 a subsequent DFU_GET_STATUS request to the device.
1382
1383 DFU_MANIFEST_POLL_TIMEOUT
1384 Poll timeout [ms], which the device sends to the host when
1385 entering dfuMANIFEST state. Host waits this timeout, before
1386 sending again an USB request to the device.
1387
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001388- USB Device Android Fastboot support:
Paul Kocialkowskid55acc02015-06-12 19:56:59 +02001389 CONFIG_USB_FUNCTION_FASTBOOT
1390 This enables the USB part of the fastboot gadget
1391
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001392 CONFIG_CMD_FASTBOOT
1393 This enables the command "fastboot" which enables the Android
1394 fastboot mode for the platform's USB device. Fastboot is a USB
1395 protocol for downloading images, flashing and device control
1396 used on Android devices.
1397 See doc/README.android-fastboot for more information.
1398
1399 CONFIG_ANDROID_BOOT_IMAGE
1400 This enables support for booting images which use the Android
1401 image format header.
1402
Paul Kocialkowskif84f0912015-07-20 12:38:22 +02001403 CONFIG_FASTBOOT_BUF_ADDR
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001404 The fastboot protocol requires a large memory buffer for
1405 downloads. Define this to the starting RAM address to use for
1406 downloaded images.
1407
Paul Kocialkowskif84f0912015-07-20 12:38:22 +02001408 CONFIG_FASTBOOT_BUF_SIZE
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001409 The fastboot protocol requires a large memory buffer for
1410 downloads. This buffer should be as large as possible for a
1411 platform. Define this to the size available RAM for fastboot.
1412
Steve Raebfb9ba42014-08-26 11:47:28 -07001413 CONFIG_FASTBOOT_FLASH
1414 The fastboot protocol includes a "flash" command for writing
1415 the downloaded image to a non-volatile storage device. Define
1416 this to enable the "fastboot flash" command.
1417
1418 CONFIG_FASTBOOT_FLASH_MMC_DEV
1419 The fastboot "flash" command requires additional information
1420 regarding the non-volatile storage device. Define this to
1421 the eMMC device that fastboot should use to store the image.
1422
Steve Rae7d059342014-12-12 15:51:54 -08001423 CONFIG_FASTBOOT_GPT_NAME
1424 The fastboot "flash" command supports writing the downloaded
1425 image to the Protective MBR and the Primary GUID Partition
1426 Table. (Additionally, this downloaded image is post-processed
1427 to generate and write the Backup GUID Partition Table.)
1428 This occurs when the specified "partition name" on the
1429 "fastboot flash" command line matches this value.
Petr Kulhavy4ed1eca2016-09-09 10:27:18 +02001430 The default is "gpt" if undefined.
Steve Rae7d059342014-12-12 15:51:54 -08001431
Petr Kulhavy9f174c92016-09-09 10:27:16 +02001432 CONFIG_FASTBOOT_MBR_NAME
1433 The fastboot "flash" command supports writing the downloaded
1434 image to DOS MBR.
1435 This occurs when the "partition name" specified on the
1436 "fastboot flash" command line matches this value.
1437 If not defined the default value "mbr" is used.
1438
wdenkda04a8b2004-08-02 23:22:59 +00001439- Journaling Flash filesystem support:
Simon Glassfa8527b2016-10-02 18:00:59 -06001440 CONFIG_JFFS2_NAND
wdenkda04a8b2004-08-02 23:22:59 +00001441 Define these for a default partition on a NAND device
1442
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001443 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1444 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenkda04a8b2004-08-02 23:22:59 +00001445 Define these for a default partition on a NOR device
1446
wdenkc6097192002-11-03 00:24:07 +00001447- Keyboard Support:
Simon Glasseaba37e2015-11-11 10:05:47 -07001448 See Kconfig help for available keyboard drivers.
1449
1450 CONFIG_KEYBOARD
1451
1452 Define this to enable a custom keyboard support.
1453 This simply calls drv_keyboard_init() which must be
1454 defined in your board-specific files. This option is deprecated
1455 and is only used by novena. For new boards, use driver model
1456 instead.
wdenkc6097192002-11-03 00:24:07 +00001457
1458- Video support:
Timur Tabi020edd22011-02-15 17:09:19 -06001459 CONFIG_FSL_DIU_FB
Wolfgang Denk825223d2011-09-11 21:24:09 +02001460 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi020edd22011-02-15 17:09:19 -06001461 SOCs that have a DIU should define this macro to enable DIU
1462 support, and should also define these other macros:
1463
1464 CONFIG_SYS_DIU_ADDR
1465 CONFIG_VIDEO
Timur Tabi020edd22011-02-15 17:09:19 -06001466 CONFIG_CFB_CONSOLE
1467 CONFIG_VIDEO_SW_CURSOR
1468 CONFIG_VGA_AS_SINGLE_DEVICE
1469 CONFIG_VIDEO_LOGO
1470 CONFIG_VIDEO_BMP_LOGO
1471
Timur Tabi32f709e2011-04-11 14:18:22 -05001472 The DIU driver will look for the 'video-mode' environment
1473 variable, and if defined, enable the DIU as a console during
Fabio Estevamd3ad5e52016-04-02 11:53:18 -03001474 boot. See the documentation file doc/README.video for a
Timur Tabi32f709e2011-04-11 14:18:22 -05001475 description of this variable.
Timur Tabi020edd22011-02-15 17:09:19 -06001476
wdenkc6097192002-11-03 00:24:07 +00001477- LCD Support: CONFIG_LCD
1478
1479 Define this to enable LCD support (for output to LCD
1480 display); also select one of the supported displays
1481 by defining one of these:
1482
Stelian Popf6f86652008-05-09 21:57:18 +02001483 CONFIG_ATMEL_LCD:
1484
1485 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1486
wdenkc0d54ae2003-11-25 16:55:19 +00001487 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001488
wdenkc0d54ae2003-11-25 16:55:19 +00001489 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001490
wdenkc0d54ae2003-11-25 16:55:19 +00001491 CONFIG_NEC_NL6448BC20
1492
1493 NEC NL6448BC20-08. 6.5", 640x480.
1494 Active, color, single scan.
1495
1496 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +00001497
wdenkc0d54ae2003-11-25 16:55:19 +00001498 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001499 Active, color, single scan.
1500
1501 CONFIG_SHARP_16x9
1502
1503 Sharp 320x240. Active, color, single scan.
1504 It isn't 16x9, and I am not sure what it is.
1505
1506 CONFIG_SHARP_LQ64D341
1507
1508 Sharp LQ64D341 display, 640x480.
1509 Active, color, single scan.
1510
1511 CONFIG_HLD1045
1512
1513 HLD1045 display, 640x480.
1514 Active, color, single scan.
1515
1516 CONFIG_OPTREX_BW
1517
1518 Optrex CBL50840-2 NF-FW 99 22 M5
1519 or
1520 Hitachi LMG6912RPFC-00T
1521 or
1522 Hitachi SP14Q002
1523
1524 320x240. Black & white.
1525
Simon Glass599a4df2012-10-17 13:24:54 +00001526 CONFIG_LCD_ALIGNMENT
1527
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001528 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass599a4df2012-10-17 13:24:54 +00001529 defined then the LCD will be aligned to this value instead.
1530 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1531 here, since it is cheaper to change data cache settings on
1532 a per-section basis.
1533
1534
Hannes Petermaiera3c8e862015-03-27 08:01:38 +01001535 CONFIG_LCD_ROTATION
1536
1537 Sometimes, for example if the display is mounted in portrait
1538 mode or even if it's mounted landscape but rotated by 180degree,
1539 we need to rotate our content of the display relative to the
1540 framebuffer, so that user can read the messages which are
1541 printed out.
1542 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1543 initialized with a given rotation from "vl_rot" out of
1544 "vidinfo_t" which is provided by the board specific code.
1545 The value for vl_rot is coded as following (matching to
1546 fbcon=rotate:<n> linux-kernel commandline):
1547 0 = no rotation respectively 0 degree
1548 1 = 90 degree rotation
1549 2 = 180 degree rotation
1550 3 = 270 degree rotation
1551
1552 If CONFIG_LCD_ROTATION is not defined, the console will be
1553 initialized with 0degree rotation.
1554
Tom Wai-Hong Tam79926a42012-09-28 15:11:16 +00001555 CONFIG_LCD_BMP_RLE8
1556
1557 Support drawing of RLE8-compressed bitmaps on the LCD.
1558
Tom Wai-Hong Tam6664f202012-12-05 14:46:40 +00001559 CONFIG_I2C_EDID
1560
1561 Enables an 'i2c edid' command which can read EDID
1562 information over I2C from an attached LCD display.
1563
wdenkeb20ad32003-09-05 23:19:14 +00001564- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenk92bbe3f2003-04-20 14:04:18 +00001565
wdenk57b2d802003-06-27 21:31:46 +00001566 If this option is set, the environment is checked for
1567 a variable "splashimage". If found, the usual display
1568 of logo, copyright and system information on the LCD
wdenk01686632004-06-30 22:59:18 +00001569 is suppressed and the BMP image at the address
wdenk57b2d802003-06-27 21:31:46 +00001570 specified in "splashimage" is loaded instead. The
1571 console is redirected to the "nulldev", too. This
1572 allows for a "silent" boot where a splash screen is
1573 loaded very quickly after power-on.
wdenk92bbe3f2003-04-20 14:04:18 +00001574
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001575 CONFIG_SPLASHIMAGE_GUARD
1576
1577 If this option is set, then U-Boot will prevent the environment
1578 variable "splashimage" from being set to a problematic address
Fabio Estevama58b4912016-03-23 12:46:12 -03001579 (see doc/README.displaying-bmps).
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001580 This option is useful for targets where, due to alignment
1581 restrictions, an improperly aligned BMP image will cause a data
1582 abort. If you think you will not have problems with unaligned
1583 accesses (for example because your toolchain prevents them)
1584 there is no need to set this option.
1585
Matthias Weisser53884182009-07-09 16:07:30 +02001586 CONFIG_SPLASH_SCREEN_ALIGN
1587
1588 If this option is set the splash image can be freely positioned
1589 on the screen. Environment variable "splashpos" specifies the
1590 position as "x,y". If a positive number is given it is used as
1591 number of pixel from left/top. If a negative number is given it
1592 is used as number of pixel from right/bottom. You can also
1593 specify 'm' for centering the image.
1594
1595 Example:
1596 setenv splashpos m,m
1597 => image at center of screen
1598
1599 setenv splashpos 30,20
1600 => image at x = 30 and y = 20
1601
1602 setenv splashpos -10,m
1603 => vertically centered image
1604 at x = dspWidth - bmpWidth - 9
1605
Stefan Roesed9d97742005-09-22 09:04:17 +02001606- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1607
1608 If this option is set, additionally to standard BMP
1609 images, gzipped BMP images can be displayed via the
1610 splashscreen support or the bmp command.
1611
Anatolij Gustschin6b4e4fc2010-03-15 14:50:25 +01001612- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1613
1614 If this option is set, 8-bit RLE compressed BMP images
1615 can be displayed via the splashscreen support or the
1616 bmp command.
1617
wdenk710e3502003-08-29 20:57:53 +00001618- Compression support:
Kees Cook5b06e642013-08-16 07:59:12 -07001619 CONFIG_GZIP
1620
1621 Enabled by default to support gzip compressed images.
1622
wdenk710e3502003-08-29 20:57:53 +00001623 CONFIG_BZIP2
1624
1625 If this option is set, support for bzip2 compressed
1626 images is included. If not, only uncompressed and gzip
1627 compressed images are supported.
1628
wdenk9c53f402003-10-15 23:53:47 +00001629 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001630 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk9c53f402003-10-15 23:53:47 +00001631 be at least 4MB.
wdenk92bbe3f2003-04-20 14:04:18 +00001632
Kees Cook5b06e642013-08-16 07:59:12 -07001633 CONFIG_LZO
1634
1635 If this option is set, support for LZO compressed images
1636 is included.
1637
wdenk0e2bd9c2004-06-06 21:51:03 +00001638- MII/PHY support:
1639 CONFIG_PHY_ADDR
1640
1641 The address of PHY on MII bus.
1642
1643 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1644
1645 The clock frequency of the MII bus
1646
1647 CONFIG_PHY_GIGE
1648
1649 If this option is set, support for speed/duplex
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001650 detection of gigabit PHY is included.
wdenk0e2bd9c2004-06-06 21:51:03 +00001651
1652 CONFIG_PHY_RESET_DELAY
1653
1654 Some PHY like Intel LXT971A need extra delay after
1655 reset before any MII register access is possible.
1656 For such PHY, set this option to the usec delay
1657 required. (minimum 300usec for LXT971A)
1658
1659 CONFIG_PHY_CMD_DELAY (ppc4xx)
1660
1661 Some PHY like Intel LXT971A need extra delay after
1662 command issued before MII status register can be read
1663
wdenkc6097192002-11-03 00:24:07 +00001664- IP address:
1665 CONFIG_IPADDR
1666
1667 Define a default value for the IP address to use for
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001668 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001669 determined through e.g. bootp.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001670 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001671
1672- Server IP address:
1673 CONFIG_SERVERIP
1674
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001675 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001676 server to contact when using the "tftboot" command.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001677 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001678
Robin Getz470a6d42009-07-21 12:15:28 -04001679 CONFIG_KEEP_SERVERADDR
1680
1681 Keeps the server's MAC address, in the env 'serveraddr'
1682 for passing to bootargs (like Linux's netconsole option)
1683
Wolfgang Denk26da2992011-10-26 10:21:22 +00001684- Gateway IP address:
1685 CONFIG_GATEWAYIP
1686
1687 Defines a default value for the IP address of the
1688 default router where packets to other networks are
1689 sent to.
1690 (Environment variable "gatewayip")
1691
1692- Subnet mask:
1693 CONFIG_NETMASK
1694
1695 Defines a default value for the subnet mask (or
1696 routing prefix) which is used to determine if an IP
1697 address belongs to the local subnet or needs to be
1698 forwarded through a router.
1699 (Environment variable "netmask")
1700
David Updegraff7280da72007-06-11 10:41:07 -05001701- Multicast TFTP Mode:
1702 CONFIG_MCAST_TFTP
1703
1704 Defines whether you want to support multicast TFTP as per
1705 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001706 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff7280da72007-06-11 10:41:07 -05001707 driver in use must provide a function: mcast() to join/leave a
1708 multicast group.
1709
wdenkc6097192002-11-03 00:24:07 +00001710- BOOTP Recovery Mode:
1711 CONFIG_BOOTP_RANDOM_DELAY
1712
1713 If you have many targets in a network that try to
1714 boot using BOOTP, you may want to avoid that all
1715 systems send out BOOTP requests at precisely the same
1716 moment (which would happen for instance at recovery
1717 from a power failure, when all systems will try to
1718 boot, thus flooding the BOOTP server. Defining
1719 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1720 inserted before sending out BOOTP requests. The
Wolfgang Denkb65aaf92007-08-06 23:21:05 +02001721 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001722
1723 1st BOOTP request: delay 0 ... 1 sec
1724 2nd BOOTP request: delay 0 ... 2 sec
1725 3rd BOOTP request: delay 0 ... 4 sec
1726 4th and following
1727 BOOTP requests: delay 0 ... 8 sec
1728
Thierry Reding8977cda2014-08-19 10:21:24 +02001729 CONFIG_BOOTP_ID_CACHE_SIZE
1730
1731 BOOTP packets are uniquely identified using a 32-bit ID. The
1732 server will copy the ID from client requests to responses and
1733 U-Boot will use this to determine if it is the destination of
1734 an incoming response. Some servers will check that addresses
1735 aren't in use before handing them out (usually using an ARP
1736 ping) and therefore take up to a few hundred milliseconds to
1737 respond. Network congestion may also influence the time it
1738 takes for a response to make it back to the client. If that
1739 time is too long, U-Boot will retransmit requests. In order
1740 to allow earlier responses to still be accepted after these
1741 retransmissions, U-Boot's BOOTP client keeps a small cache of
1742 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
1743 cache. The default is to keep IDs for up to four outstanding
1744 requests. Increasing this will allow U-Boot to accept offers
1745 from a BOOTP client in networks with unusually high latency.
1746
stroesee0aadfb2003-08-28 14:17:32 +00001747- DHCP Advanced Options:
Jon Loeliger5336a762007-07-09 22:08:34 -05001748 You can fine tune the DHCP functionality by defining
1749 CONFIG_BOOTP_* symbols:
stroesee0aadfb2003-08-28 14:17:32 +00001750
Jon Loeliger5336a762007-07-09 22:08:34 -05001751 CONFIG_BOOTP_SUBNETMASK
1752 CONFIG_BOOTP_GATEWAY
1753 CONFIG_BOOTP_HOSTNAME
1754 CONFIG_BOOTP_NISDOMAIN
1755 CONFIG_BOOTP_BOOTPATH
1756 CONFIG_BOOTP_BOOTFILESIZE
1757 CONFIG_BOOTP_DNS
1758 CONFIG_BOOTP_DNS2
1759 CONFIG_BOOTP_SEND_HOSTNAME
1760 CONFIG_BOOTP_NTPSERVER
1761 CONFIG_BOOTP_TIMEOFFSET
1762 CONFIG_BOOTP_VENDOREX
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001763 CONFIG_BOOTP_MAY_FAIL
stroesee0aadfb2003-08-28 14:17:32 +00001764
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001765 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1766 environment variable, not the BOOTP server.
stroesee0aadfb2003-08-28 14:17:32 +00001767
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001768 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1769 after the configured retry count, the call will fail
1770 instead of starting over. This can be used to fail over
1771 to Link-local IP address configuration if the DHCP server
1772 is not available.
1773
stroesee0aadfb2003-08-28 14:17:32 +00001774 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1775 serverip from a DHCP server, it is possible that more
1776 than one DNS serverip is offered to the client.
1777 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1778 serverip will be stored in the additional environment
1779 variable "dnsip2". The first DNS serverip is always
1780 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger5336a762007-07-09 22:08:34 -05001781 is defined.
stroesee0aadfb2003-08-28 14:17:32 +00001782
1783 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1784 to do a dynamic update of a DNS server. To do this, they
1785 need the hostname of the DHCP requester.
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001786 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger5336a762007-07-09 22:08:34 -05001787 of the "hostname" environment variable is passed as
1788 option 12 to the DHCP server.
stroesee0aadfb2003-08-28 14:17:32 +00001789
Aras Vaichas72aa3f32008-03-26 09:43:57 +11001790 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1791
1792 A 32bit value in microseconds for a delay between
1793 receiving a "DHCP Offer" and sending the "DHCP Request".
1794 This fixes a problem with certain DHCP servers that don't
1795 respond 100% of the time to a "DHCP request". E.g. On an
1796 AT91RM9200 processor running at 180MHz, this delay needed
1797 to be *at least* 15,000 usec before a Windows Server 2003
1798 DHCP server would reply 100% of the time. I recommend at
1799 least 50,000 usec to be safe. The alternative is to hope
1800 that one of the retries will be successful but note that
1801 the DHCP timeout and retry process takes a longer than
1802 this delay.
1803
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00001804 - Link-local IP address negotiation:
1805 Negotiate with other link-local clients on the local network
1806 for an address that doesn't require explicit configuration.
1807 This is especially useful if a DHCP server cannot be guaranteed
1808 to exist in all environments that the device must operate.
1809
1810 See doc/README.link-local for more information.
1811
wdenk145d2c12004-04-15 21:48:45 +00001812 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00001813 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00001814
1815 The device id used in CDP trigger frames.
1816
1817 CONFIG_CDP_DEVICE_ID_PREFIX
1818
1819 A two character string which is prefixed to the MAC address
1820 of the device.
1821
1822 CONFIG_CDP_PORT_ID
1823
1824 A printf format string which contains the ascii name of
1825 the port. Normally is set to "eth%d" which sets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001826 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-04-15 21:48:45 +00001827
1828 CONFIG_CDP_CAPABILITIES
1829
1830 A 32bit integer which indicates the device capabilities;
1831 0x00000010 for a normal host which does not forwards.
1832
1833 CONFIG_CDP_VERSION
1834
1835 An ascii string containing the version of the software.
1836
1837 CONFIG_CDP_PLATFORM
1838
1839 An ascii string containing the name of the platform.
1840
1841 CONFIG_CDP_TRIGGER
1842
1843 A 32bit integer sent on the trigger.
1844
1845 CONFIG_CDP_POWER_CONSUMPTION
1846
1847 A 16bit integer containing the power consumption of the
1848 device in .1 of milliwatts.
1849
1850 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1851
1852 A byte containing the id of the VLAN.
1853
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001854- Status LED: CONFIG_LED_STATUS
wdenkc6097192002-11-03 00:24:07 +00001855
1856 Several configurations allow to display the current
1857 status using a LED. For instance, the LED will blink
1858 fast while running U-Boot code, stop blinking as
1859 soon as a reply to a BOOTP request was received, and
1860 start blinking slow once the Linux kernel is running
1861 (supported by a status LED driver in the Linux
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001862 kernel). Defining CONFIG_LED_STATUS enables this
wdenkc6097192002-11-03 00:24:07 +00001863 feature in U-Boot.
1864
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001865 Additional options:
1866
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001867 CONFIG_LED_STATUS_GPIO
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001868 The status LED can be connected to a GPIO pin.
1869 In such cases, the gpio_led driver can be used as a
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001870 status LED backend implementation. Define CONFIG_LED_STATUS_GPIO
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001871 to include the gpio_led driver in the U-Boot binary.
1872
Igor Grinberg203bd9f2013-11-08 01:03:52 +02001873 CONFIG_GPIO_LED_INVERTED_TABLE
1874 Some GPIO connected LEDs may have inverted polarity in which
1875 case the GPIO high value corresponds to LED off state and
1876 GPIO low value corresponds to LED on state.
1877 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
1878 with a list of GPIO LEDs that have inverted polarity.
1879
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001880- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00001881
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001882 This enable the NEW i2c subsystem, and will allow you to use
1883 i2c commands at the u-boot command line (as long as you set
1884 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
1885 based realtime clock chips or other i2c devices. See
1886 common/cmd_i2c.c for a description of the command line
1887 interface.
1888
1889 ported i2c driver to the new framework:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01001890 - drivers/i2c/soft_i2c.c:
1891 - activate first bus with CONFIG_SYS_I2C_SOFT define
1892 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
1893 for defining speed and slave address
1894 - activate second bus with I2C_SOFT_DECLARATIONS2 define
1895 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
1896 for defining speed and slave address
1897 - activate third bus with I2C_SOFT_DECLARATIONS3 define
1898 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
1899 for defining speed and slave address
1900 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
1901 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
1902 for defining speed and slave address
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001903
Heiko Schocherf2850742012-10-24 13:48:22 +02001904 - drivers/i2c/fsl_i2c.c:
1905 - activate i2c driver with CONFIG_SYS_I2C_FSL
1906 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
1907 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
1908 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
1909 bus.
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001910 - If your board supports a second fsl i2c bus, define
Heiko Schocherf2850742012-10-24 13:48:22 +02001911 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
1912 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
1913 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
1914 second bus.
1915
Simon Glass026fefb2012-10-30 07:28:53 +00001916 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu045acfa2013-10-11 16:23:53 +09001917 - activate this driver with CONFIG_SYS_I2C_TEGRA
1918 - This driver adds 4 i2c buses with a fix speed from
1919 100000 and the slave addr 0!
Simon Glass026fefb2012-10-30 07:28:53 +00001920
Dirk Eibach42b204f2013-04-25 02:40:01 +00001921 - drivers/i2c/ppc4xx_i2c.c
1922 - activate this driver with CONFIG_SYS_I2C_PPC4XX
1923 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
1924 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
1925
trema49f40a2013-09-21 18:13:35 +02001926 - drivers/i2c/i2c_mxc.c
1927 - activate this driver with CONFIG_SYS_I2C_MXC
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02001928 - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
1929 - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
1930 - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
1931 - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
trema49f40a2013-09-21 18:13:35 +02001932 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
1933 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
1934 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
1935 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
1936 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
1937 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02001938 - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
1939 - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001940 If those defines are not set, default value is 100000
trema49f40a2013-09-21 18:13:35 +02001941 for speed, and 0 for slave.
1942
Nobuhiro Iwamatsue94ea2f2013-09-27 16:58:30 +09001943 - drivers/i2c/rcar_i2c.c:
1944 - activate this driver with CONFIG_SYS_I2C_RCAR
1945 - This driver adds 4 i2c buses
1946
1947 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
1948 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
1949 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
1950 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
1951 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
1952 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
1953 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
1954 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
1955 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
1956
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09001957 - drivers/i2c/sh_i2c.c:
1958 - activate this driver with CONFIG_SYS_I2C_SH
1959 - This driver adds from 2 to 5 i2c buses
1960
1961 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
1962 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
1963 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
1964 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
1965 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
1966 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
1967 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
1968 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
1969 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
1970 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001971 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09001972
Heiko Schocherf53f2b82013-10-22 11:03:18 +02001973 - drivers/i2c/omap24xx_i2c.c
1974 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
1975 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
1976 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
1977 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
1978 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
1979 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
1980 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
1981 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
1982 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
1983 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
1984 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
1985
Heiko Schocher465819a2013-11-08 07:30:53 +01001986 - drivers/i2c/zynq_i2c.c
1987 - activate this driver with CONFIG_SYS_I2C_ZYNQ
1988 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
1989 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
1990
Naveen Krishna Ch5d5efd32013-12-06 12:12:38 +05301991 - drivers/i2c/s3c24x0_i2c.c:
1992 - activate this driver with CONFIG_SYS_I2C_S3C24X0
1993 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
1994 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
1995 with a fix speed from 100000 and the slave addr 0!
1996
Dirk Eibachb9577432014-07-03 09:28:18 +02001997 - drivers/i2c/ihs_i2c.c
1998 - activate this driver with CONFIG_SYS_I2C_IHS
1999 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2000 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2001 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2002 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2003 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2004 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2005 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2006 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2007 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2008 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2009 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2010 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
Dirk Eibach9ac33852015-10-28 11:46:22 +01002011 - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
2012 - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
2013 - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
2014 - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
2015 - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
2016 - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
2017 - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
2018 - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
2019 - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
Dirk Eibachb9577432014-07-03 09:28:18 +02002020
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002021 additional defines:
2022
2023 CONFIG_SYS_NUM_I2C_BUSES
Simon Glassb05e2b32016-10-02 18:01:05 -06002024 Hold the number of i2c buses you want to use.
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002025
2026 CONFIG_SYS_I2C_DIRECT_BUS
2027 define this, if you don't use i2c muxes on your hardware.
2028 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2029 omit this define.
2030
2031 CONFIG_SYS_I2C_MAX_HOPS
2032 define how many muxes are maximal consecutively connected
2033 on one i2c bus. If you not use i2c muxes, omit this
2034 define.
2035
2036 CONFIG_SYS_I2C_BUSES
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002037 hold a list of buses you want to use, only used if
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002038 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2039 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2040 CONFIG_SYS_NUM_I2C_BUSES = 9:
2041
2042 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2043 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2044 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2045 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2046 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2047 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2048 {1, {I2C_NULL_HOP}}, \
2049 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2050 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2051 }
2052
2053 which defines
2054 bus 0 on adapter 0 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002055 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2056 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2057 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2058 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2059 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002060 bus 6 on adapter 1 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002061 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2062 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002063
2064 If you do not have i2c muxes on your board, omit this define.
2065
Simon Glass3efce392017-05-12 21:10:00 -06002066- Legacy I2C Support:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002067 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb9bbd242003-06-30 16:24:52 +00002068 then the following macros need to be defined (examples are
2069 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002070
2071 I2C_INIT
2072
wdenkb9bbd242003-06-30 16:24:52 +00002073 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00002074 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002075
wdenk544e9732004-02-06 23:19:44 +00002076 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00002077
wdenkc6097192002-11-03 00:24:07 +00002078 I2C_ACTIVE
2079
2080 The code necessary to make the I2C data line active
2081 (driven). If the data line is open collector, this
2082 define can be null.
2083
wdenkb9bbd242003-06-30 16:24:52 +00002084 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2085
wdenkc6097192002-11-03 00:24:07 +00002086 I2C_TRISTATE
2087
2088 The code necessary to make the I2C data line tri-stated
2089 (inactive). If the data line is open collector, this
2090 define can be null.
2091
wdenkb9bbd242003-06-30 16:24:52 +00002092 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2093
wdenkc6097192002-11-03 00:24:07 +00002094 I2C_READ
2095
York Sun4a598092013-04-01 11:29:11 -07002096 Code that returns true if the I2C data line is high,
2097 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002098
wdenkb9bbd242003-06-30 16:24:52 +00002099 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2100
wdenkc6097192002-11-03 00:24:07 +00002101 I2C_SDA(bit)
2102
York Sun4a598092013-04-01 11:29:11 -07002103 If <bit> is true, sets the I2C data line high. If it
2104 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002105
wdenkb9bbd242003-06-30 16:24:52 +00002106 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002107 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00002108 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00002109
wdenkc6097192002-11-03 00:24:07 +00002110 I2C_SCL(bit)
2111
York Sun4a598092013-04-01 11:29:11 -07002112 If <bit> is true, sets the I2C clock line high. If it
2113 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002114
wdenkb9bbd242003-06-30 16:24:52 +00002115 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002116 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00002117 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00002118
wdenkc6097192002-11-03 00:24:07 +00002119 I2C_DELAY
2120
2121 This delay is invoked four times per clock cycle so this
2122 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00002123 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00002124 like:
2125
wdenkb9bbd242003-06-30 16:24:52 +00002126 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002127
Mike Frysingeree12d542010-07-21 13:38:02 -04002128 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2129
2130 If your arch supports the generic GPIO framework (asm/gpio.h),
2131 then you may alternatively define the two GPIOs that are to be
2132 used as SCL / SDA. Any of the previous I2C_xxx macros will
2133 have GPIO-based defaults assigned to them as appropriate.
2134
2135 You should define these to the GPIO value as given directly to
2136 the generic GPIO functions.
2137
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002138 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00002139
wdenk57b2d802003-06-27 21:31:46 +00002140 When a board is reset during an i2c bus transfer
2141 chips might think that the current transfer is still
2142 in progress. On some boards it is possible to access
2143 the i2c SCLK line directly, either by using the
2144 processor pin as a GPIO or by having a second pin
2145 connected to the bus. If this option is defined a
2146 custom i2c_init_board() routine in boards/xxx/board.c
2147 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00002148
Ben Warren45657152006-09-07 16:50:54 -04002149 CONFIG_I2C_MULTI_BUS
2150
2151 This option allows the use of multiple I2C buses, each of which
Wolfgang Denk092ae952011-10-26 10:21:21 +00002152 must have a controller. At any point in time, only one bus is
2153 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warren45657152006-09-07 16:50:54 -04002154 Note that bus numbering is zero-based.
2155
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002156 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04002157
2158 This option specifies a list of I2C devices that will be skipped
Wolfgang Denk092ae952011-10-26 10:21:21 +00002159 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser469cde42009-04-18 22:34:03 -05002160 is set, specify a list of bus-device pairs. Otherwise, specify
2161 a 1D array of device addresses
Ben Warren45657152006-09-07 16:50:54 -04002162
2163 e.g.
2164 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denk092ae952011-10-26 10:21:21 +00002165 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04002166
2167 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2168
Wolfgang Denk092ae952011-10-26 10:21:21 +00002169 #define CONFIG_I2C_MULTI_BUS
Simon Glassb05e2b32016-10-02 18:01:05 -06002170 #define CONFIG_SYS_I2C_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-09-07 16:50:54 -04002171
2172 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2173
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002174 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-11-03 19:15:00 -06002175
2176 If defined, then this indicates the I2C bus number for DDR SPD.
2177 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2178
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002179 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002180
2181 If defined, then this indicates the I2C bus number for the RTC.
2182 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2183
Andrew Dyer58c41f92008-12-29 17:36:01 -06002184 CONFIG_SOFT_I2C_READ_REPEATED_START
2185
2186 defining this will force the i2c_read() function in
2187 the soft_i2c driver to perform an I2C repeated start
2188 between writing the address pointer and reading the
2189 data. If this define is omitted the default behaviour
2190 of doing a stop-start sequence will be used. Most I2C
2191 devices can use either method, but some require one or
2192 the other.
Timur Tabiab347542006-11-03 19:15:00 -06002193
wdenkc6097192002-11-03 00:24:07 +00002194- SPI Support: CONFIG_SPI
2195
2196 Enables SPI driver (so far only tested with
2197 SPI EEPROM, also an instance works with Crystal A/D and
2198 D/As on the SACSng board)
2199
Yoshihiro Shimoda65bd9b42011-01-31 16:50:43 +09002200 CONFIG_SH_SPI
2201
2202 Enables the driver for SPI controller on SuperH. Currently
2203 only SH7757 is supported.
2204
wdenkc6097192002-11-03 00:24:07 +00002205 CONFIG_SOFT_SPI
2206
wdenk4a5c8a72003-03-06 00:02:04 +00002207 Enables a software (bit-bang) SPI driver rather than
2208 using hardware support. This is a general purpose
2209 driver that only requires three general I/O port pins
2210 (two outputs, one input) to function. If this is
2211 defined, the board configuration must define several
2212 SPI configuration items (port pins to use, etc). For
2213 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002214
Ben Warren7efe9272008-01-16 22:37:35 -05002215 CONFIG_HARD_SPI
2216
2217 Enables a hardware SPI driver for general-purpose reads
2218 and writes. As with CONFIG_SOFT_SPI, the board configuration
2219 must define a list of chip-select function pointers.
Wolfgang Denk092ae952011-10-26 10:21:21 +00002220 Currently supported on some MPC8xxx processors. For an
Ben Warren7efe9272008-01-16 22:37:35 -05002221 example, see include/configs/mpc8349emds.h.
2222
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002223 CONFIG_MXC_SPI
2224
2225 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevamdcd342c2011-10-28 08:57:46 +00002226 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002227
Heiko Schocherb77c8882014-07-14 10:22:11 +02002228 CONFIG_SYS_SPI_MXC_WAIT
2229 Timeout for waiting until spi transfer completed.
2230 default: (CONFIG_SYS_HZ/100) /* 10 ms */
2231
Matthias Fuchsa4400872007-12-27 17:12:34 +01002232- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00002233
Matthias Fuchsa4400872007-12-27 17:12:34 +01002234 Enables FPGA subsystem.
2235
2236 CONFIG_FPGA_<vendor>
2237
2238 Enables support for specific chip vendors.
2239 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00002240
Matthias Fuchsa4400872007-12-27 17:12:34 +01002241 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00002242
Matthias Fuchsa4400872007-12-27 17:12:34 +01002243 Enables support for FPGA family.
2244 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2245
2246 CONFIG_FPGA_COUNT
2247
2248 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002249
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002250 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002251
wdenk57b2d802003-06-27 21:31:46 +00002252 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002253
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002254 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002255
wdenk4a5c8a72003-03-06 00:02:04 +00002256 Enable checks on FPGA configuration interface busy
2257 status by the configuration function. This option
2258 will require a board or device specific function to
2259 be written.
wdenkc6097192002-11-03 00:24:07 +00002260
2261 CONFIG_FPGA_DELAY
2262
2263 If defined, a function that provides delays in the FPGA
2264 configuration driver.
2265
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002266 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002267 Allow Control-C to interrupt FPGA configuration
2268
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002269 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002270
wdenk4a5c8a72003-03-06 00:02:04 +00002271 Check for configuration errors during FPGA bitfile
2272 loading. For example, abort during Virtex II
2273 configuration if the INIT_B line goes low (which
2274 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002275
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002276 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002277
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002278 Maximum time to wait for the INIT_B line to de-assert
2279 after PROB_B has been de-asserted during a Virtex II
wdenk4a5c8a72003-03-06 00:02:04 +00002280 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002281 ms.
wdenkc6097192002-11-03 00:24:07 +00002282
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002283 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002284
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002285 Maximum time to wait for BUSY to de-assert during
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002286 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002287
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002288 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002289
wdenk4a5c8a72003-03-06 00:02:04 +00002290 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002291 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002292
2293- Configuration Management:
Stefan Roese141ed202014-10-22 12:13:24 +02002294 CONFIG_BUILD_TARGET
2295
2296 Some SoCs need special image types (e.g. U-Boot binary
2297 with a special header) as build targets. By defining
2298 CONFIG_BUILD_TARGET in the SoC / board header, this
2299 special image will be automatically built upon calling
Simon Glassdc27def2016-07-27 20:33:08 -06002300 make / buildman.
Stefan Roese141ed202014-10-22 12:13:24 +02002301
wdenkc6097192002-11-03 00:24:07 +00002302 CONFIG_IDENT_STRING
2303
wdenk4a5c8a72003-03-06 00:02:04 +00002304 If defined, this string will be added to the U-Boot
2305 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002306
2307- Vendor Parameter Protection:
2308
wdenk4a5c8a72003-03-06 00:02:04 +00002309 U-Boot considers the values of the environment
2310 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00002311 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00002312 are set once by the board vendor / manufacturer, and
2313 protects these variables from casual modification by
2314 the user. Once set, these variables are read-only,
2315 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002316 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002317
2318 If CONFIG_ENV_OVERWRITE is #defined in your config
2319 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00002320 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002321 these parameters.
2322
Joe Hershberger76f353e2015-05-04 14:55:14 -05002323 Alternatively, if you define _both_ an ethaddr in the
2324 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002325 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002326 which can be changed exactly ONCE by the user. [The
2327 serial# is unaffected by this, i. e. it remains
2328 read-only.]
2329
Joe Hershberger71497d02012-12-11 22:16:31 -06002330 The same can be accomplished in a more flexible way
2331 for any variable by configuring the type of access
2332 to allow for those variables in the ".flags" variable
2333 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2334
wdenkc6097192002-11-03 00:24:07 +00002335- Protected RAM:
2336 CONFIG_PRAM
2337
2338 Define this variable to enable the reservation of
2339 "protected RAM", i. e. RAM which is not overwritten
2340 by U-Boot. Define CONFIG_PRAM to hold the number of
2341 kB you want to reserve for pRAM. You can overwrite
2342 this default value by defining an environment
2343 variable "pram" to the number of kB you want to
2344 reserve. Note that the board info structure will
2345 still show the full amount of RAM. If pRAM is
2346 reserved, a new environment variable "mem" will
2347 automatically be defined to hold the amount of
2348 remaining RAM in a form that can be passed as boot
2349 argument to Linux, for instance like that:
2350
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01002351 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002352 saveenv
2353
2354 This way you can tell Linux not to use this memory,
2355 either, which results in a memory region that will
2356 not be affected by reboots.
2357
2358 *WARNING* If your board configuration uses automatic
2359 detection of the RAM size, you must make sure that
2360 this memory test is non-destructive. So far, the
2361 following board configurations are known to be
2362 "pRAM-clean":
2363
Heiko Schocher65d94db2017-06-07 17:33:09 +02002364 IVMS8, IVML24, SPD8xx,
Wolfgang Denk90326762012-10-24 02:36:15 +00002365 HERMES, IP860, RPXlite, LWMON,
Heiko Schocher71cb3e92017-06-07 17:33:10 +02002366 FLAGADM
wdenkc6097192002-11-03 00:24:07 +00002367
Gabe Blacka2f3a932012-12-02 04:55:18 +00002368- Access to physical memory region (> 4GB)
2369 Some basic support is provided for operations on memory not
2370 normally accessible to U-Boot - e.g. some architectures
2371 support access to more than 4GB of memory on 32-bit
2372 machines using physical address extension or similar.
2373 Define CONFIG_PHYSMEM to access this basic support, which
2374 currently only supports clearing the memory.
2375
wdenkc6097192002-11-03 00:24:07 +00002376- Error Recovery:
2377 CONFIG_PANIC_HANG
2378
2379 Define this variable to stop the system in case of a
2380 fatal error, so that you have to reset it manually.
2381 This is probably NOT a good idea for an embedded
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002382 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002383 automatically as fast as possible, but it may be
2384 useful during development since you can try to debug
2385 the conditions that lead to the situation.
2386
2387 CONFIG_NET_RETRY_COUNT
2388
wdenk4a5c8a72003-03-06 00:02:04 +00002389 This variable defines the number of retries for
2390 network operations like ARP, RARP, TFTP, or BOOTP
2391 before giving up the operation. If not defined, a
2392 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002393
Guennadi Liakhovetskib38c2b32008-04-03 17:04:19 +02002394 CONFIG_ARP_TIMEOUT
2395
2396 Timeout waiting for an ARP reply in milliseconds.
2397
Tetsuyuki Kobayashi147e3902012-07-03 22:25:21 +00002398 CONFIG_NFS_TIMEOUT
2399
2400 Timeout in milliseconds used in NFS protocol.
2401 If you encounter "ERROR: Cannot umount" in nfs command,
2402 try longer timeout such as
2403 #define CONFIG_NFS_TIMEOUT 10000UL
2404
wdenkc6097192002-11-03 00:24:07 +00002405- Command Interpreter:
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002406 CONFIG_AUTO_COMPLETE
wdenk3902d702004-04-15 18:22:41 +00002407
2408 Enable auto completion of commands using TAB.
2409
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002410 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002411
2412 This defines the secondary prompt string, which is
2413 printed when the command interpreter needs more input
2414 to complete a command. Usually "> ".
2415
2416 Note:
2417
wdenk57b2d802003-06-27 21:31:46 +00002418 In the current implementation, the local variables
2419 space and global environment variables space are
2420 separated. Local variables are those you define by
2421 simply typing `name=value'. To access a local
2422 variable later on, you have write `$name' or
2423 `${name}'; to execute the contents of a variable
2424 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002425
wdenk4a5c8a72003-03-06 00:02:04 +00002426 Global environment variables are those you use
2427 setenv/printenv to work with. To run a command stored
2428 in such a variable, you need to use the run command,
2429 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002430
2431 To store commands and special characters in a
2432 variable, please use double quotation marks
2433 surrounding the whole text of the variable, instead
2434 of the backslashes before semicolons and special
2435 symbols.
2436
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002437- Command Line Editing and History:
Wolfgang Denk2039a072006-07-21 11:35:21 +02002438 CONFIG_CMDLINE_EDITING
2439
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002440 Enable editing and History functions for interactive
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002441 command line input operations
Wolfgang Denk2039a072006-07-21 11:35:21 +02002442
Marek Vasut734fb042016-01-27 04:47:55 +01002443- Command Line PS1/PS2 support:
2444 CONFIG_CMDLINE_PS_SUPPORT
2445
2446 Enable support for changing the command prompt string
2447 at run-time. Only static string is supported so far.
2448 The string is obtained from environment variables PS1
2449 and PS2.
2450
wdenkc0aa5c52003-12-06 19:49:23 +00002451- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002452 CONFIG_EXTRA_ENV_SETTINGS
2453
wdenk4a5c8a72003-03-06 00:02:04 +00002454 Define this to contain any number of null terminated
2455 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00002456 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00002457
wdenk4a5c8a72003-03-06 00:02:04 +00002458 For example, place something like this in your
2459 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002460
2461 #define CONFIG_EXTRA_ENV_SETTINGS \
2462 "myvar1=value1\0" \
2463 "myvar2=value2\0"
2464
wdenk4a5c8a72003-03-06 00:02:04 +00002465 Warning: This method is based on knowledge about the
2466 internal format how the environment is stored by the
2467 U-Boot code. This is NOT an official, exported
2468 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00002469 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002470 You better know what you are doing here.
2471
wdenk4a5c8a72003-03-06 00:02:04 +00002472 Note: overly (ab)use of the default environment is
2473 discouraged. Make sure to check other ways to preset
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002474 the environment like the "source" command or the
wdenk4a5c8a72003-03-06 00:02:04 +00002475 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002476
Stephen Warren1465d5f2012-05-22 09:21:54 +00002477 CONFIG_ENV_VARS_UBOOT_CONFIG
2478
2479 Define this in order to add variables describing the
2480 U-Boot build configuration to the default environment.
2481 These will be named arch, cpu, board, vendor, and soc.
2482
2483 Enabling this option will cause the following to be defined:
2484
2485 - CONFIG_SYS_ARCH
2486 - CONFIG_SYS_CPU
2487 - CONFIG_SYS_BOARD
2488 - CONFIG_SYS_VENDOR
2489 - CONFIG_SYS_SOC
2490
Tom Rini4c8cc9b2012-10-24 07:28:16 +00002491 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2492
2493 Define this in order to add variables describing certain
2494 run-time determined information about the hardware to the
2495 environment. These will be named board_name, board_rev.
2496
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002497 CONFIG_DELAY_ENVIRONMENT
2498
2499 Normally the environment is loaded when the board is
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002500 initialised so that it is available to U-Boot. This inhibits
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002501 that so that the environment is not available until
2502 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2503 this is instead controlled by the value of
2504 /config/load-environment.
2505
wdenkc0aa5c52003-12-06 19:49:23 +00002506- DataFlash Support:
wdenk381669a2003-06-16 23:50:08 +00002507 CONFIG_HAS_DATAFLASH
2508
wdenk57b2d802003-06-27 21:31:46 +00002509 Defining this option enables DataFlash features and
2510 allows to read/write in Dataflash via the standard
2511 commands cp, md...
wdenk381669a2003-06-16 23:50:08 +00002512
Eric Nelson97f5f8f2012-01-31 10:52:08 -07002513- Serial Flash support
2514 CONFIG_CMD_SF
2515
2516 Defining this option enables SPI flash commands
2517 'sf probe/read/write/erase/update'.
2518
2519 Usage requires an initial 'probe' to define the serial
2520 flash parameters, followed by read/write/erase/update
2521 commands.
2522
2523 The following defaults may be provided by the platform
2524 to handle the common case when only a single serial
2525 flash is present on the system.
2526
2527 CONFIG_SF_DEFAULT_BUS Bus identifier
2528 CONFIG_SF_DEFAULT_CS Chip-select
2529 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2530 CONFIG_SF_DEFAULT_SPEED in Hz
2531
Simon Glass4b5545e2012-10-08 13:16:02 +00002532 CONFIG_CMD_SF_TEST
2533
2534 Define this option to include a destructive SPI flash
2535 test ('sf test').
2536
wdenkef893942004-02-23 16:11:30 +00002537- SystemACE Support:
2538 CONFIG_SYSTEMACE
2539
2540 Adding this option adds support for Xilinx SystemACE
2541 chips attached via some sort of local bus. The address
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002542 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002543 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenkef893942004-02-23 16:11:30 +00002544
2545 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002546 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenkef893942004-02-23 16:11:30 +00002547
2548 When SystemACE support is added, the "ace" device type
2549 becomes available to the fat commands, i.e. fatls.
2550
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002551- TFTP Fixed UDP Port:
2552 CONFIG_TFTP_PORT
2553
Wolfgang Denk227b5192005-09-24 23:25:46 +02002554 If this is defined, the environment variable tftpsrcp
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002555 is used to supply the TFTP UDP source port value.
Wolfgang Denk227b5192005-09-24 23:25:46 +02002556 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002557 number generator is used.
2558
Wolfgang Denk227b5192005-09-24 23:25:46 +02002559 Also, the environment variable tftpdstp is used to supply
2560 the TFTP UDP destination port value. If tftpdstp isn't
2561 defined, the normal port 69 is used.
2562
2563 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002564 blindly start the TFTP transfer using the pre-configured
2565 target IP address and UDP port. This has the effect of
2566 "punching through" the (Windows XP) firewall, allowing
2567 the remainder of the TFTP transfer to proceed normally.
2568 A better solution is to properly configure the firewall,
2569 but sometimes that is not allowed.
2570
Heiko Schocher443ca402014-01-25 07:27:13 +01002571- bootcount support:
2572 CONFIG_BOOTCOUNT_LIMIT
2573
2574 This enables the bootcounter support, see:
2575 http://www.denx.de/wiki/DULG/UBootBootCountLimit
2576
2577 CONFIG_AT91SAM9XE
2578 enable special bootcounter support on at91sam9xe based boards.
Heiko Schocher443ca402014-01-25 07:27:13 +01002579 CONFIG_SOC_DA8XX
2580 enable special bootcounter support on da850 based boards.
2581 CONFIG_BOOTCOUNT_RAM
2582 enable support for the bootcounter in RAM
2583 CONFIG_BOOTCOUNT_I2C
2584 enable support for the bootcounter on an i2c (like RTC) device.
2585 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
2586 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
2587 the bootcounter.
2588 CONFIG_BOOTCOUNT_ALEN = address len
Simon Glass35191a32013-06-13 15:10:02 -07002589
wdenkc0aa5c52003-12-06 19:49:23 +00002590- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002591 CONFIG_SHOW_BOOT_PROGRESS
2592
wdenk4a5c8a72003-03-06 00:02:04 +00002593 Defining this option allows to add some board-
2594 specific code (calling a user-provided function
2595 "show_boot_progress(int)") that enables you to show
2596 the system's boot progress on some display (for
2597 example, some LED's) on your board. At the moment,
2598 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002599
Simon Glass0fa36a42012-09-28 08:56:37 +00002600
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002601Legacy uImage format:
2602
wdenkc6097192002-11-03 00:24:07 +00002603 Arg Where When
2604 1 common/cmd_bootm.c before attempting to boot an image
wdenk544e9732004-02-06 23:19:44 +00002605 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002606 2 common/cmd_bootm.c Image header has correct magic number
wdenk544e9732004-02-06 23:19:44 +00002607 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002608 3 common/cmd_bootm.c Image header has correct checksum
wdenk544e9732004-02-06 23:19:44 +00002609 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002610 4 common/cmd_bootm.c Image data has correct checksum
2611 -4 common/cmd_bootm.c Image is for unsupported architecture
2612 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002613 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002614 6 common/cmd_bootm.c Image Type check OK
2615 -6 common/cmd_bootm.c gunzip uncompression error
2616 -7 common/cmd_bootm.c Unimplemented compression type
2617 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002618 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002619 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002620
2621 9 common/image.c Start initial ramdisk verification
2622 -10 common/image.c Ramdisk header has bad magic number
2623 -11 common/image.c Ramdisk header has bad checksum
2624 10 common/image.c Ramdisk header is OK
2625 -12 common/image.c Ramdisk data has bad checksum
2626 11 common/image.c Ramdisk data has correct checksum
2627 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002628 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002629 13 common/image.c Start multifile image verification
2630 14 common/image.c No initial ramdisk, no multifile, continue.
2631
Wolfgang Denk092ae952011-10-26 10:21:21 +00002632 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002633
Stefan Roese88fbf932010-04-15 16:07:28 +02002634 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenkd729d302004-02-27 00:07:27 +00002635 -31 post/post.c POST test failed, detected by post_output_backlog()
2636 -32 post/post.c POST test failed, detected by post_run_single()
wdenke97d3d92004-02-23 22:22:28 +00002637
Heiko Schocher633e03a2007-06-22 19:11:54 +02002638 34 common/cmd_doc.c before loading a Image from a DOC device
2639 -35 common/cmd_doc.c Bad usage of "doc" command
2640 35 common/cmd_doc.c correct usage of "doc" command
2641 -36 common/cmd_doc.c No boot device
2642 36 common/cmd_doc.c correct boot device
2643 -37 common/cmd_doc.c Unknown Chip ID on boot device
2644 37 common/cmd_doc.c correct chip ID found, device available
2645 -38 common/cmd_doc.c Read Error on boot device
2646 38 common/cmd_doc.c reading Image header from DOC device OK
2647 -39 common/cmd_doc.c Image header has bad magic number
2648 39 common/cmd_doc.c Image header has correct magic number
2649 -40 common/cmd_doc.c Error reading Image from DOC device
2650 40 common/cmd_doc.c Image header has correct magic number
2651 41 common/cmd_ide.c before loading a Image from a IDE device
2652 -42 common/cmd_ide.c Bad usage of "ide" command
2653 42 common/cmd_ide.c correct usage of "ide" command
2654 -43 common/cmd_ide.c No boot device
2655 43 common/cmd_ide.c boot device found
2656 -44 common/cmd_ide.c Device not available
2657 44 common/cmd_ide.c Device available
2658 -45 common/cmd_ide.c wrong partition selected
2659 45 common/cmd_ide.c partition selected
2660 -46 common/cmd_ide.c Unknown partition table
2661 46 common/cmd_ide.c valid partition table found
2662 -47 common/cmd_ide.c Invalid partition type
2663 47 common/cmd_ide.c correct partition type
2664 -48 common/cmd_ide.c Error reading Image Header on boot device
2665 48 common/cmd_ide.c reading Image Header from IDE device OK
2666 -49 common/cmd_ide.c Image header has bad magic number
2667 49 common/cmd_ide.c Image header has correct magic number
2668 -50 common/cmd_ide.c Image header has bad checksum
2669 50 common/cmd_ide.c Image header has correct checksum
2670 -51 common/cmd_ide.c Error reading Image from IDE device
2671 51 common/cmd_ide.c reading Image from IDE device OK
2672 52 common/cmd_nand.c before loading a Image from a NAND device
2673 -53 common/cmd_nand.c Bad usage of "nand" command
2674 53 common/cmd_nand.c correct usage of "nand" command
2675 -54 common/cmd_nand.c No boot device
2676 54 common/cmd_nand.c boot device found
2677 -55 common/cmd_nand.c Unknown Chip ID on boot device
2678 55 common/cmd_nand.c correct chip ID found, device available
2679 -56 common/cmd_nand.c Error reading Image Header on boot device
2680 56 common/cmd_nand.c reading Image Header from NAND device OK
2681 -57 common/cmd_nand.c Image header has bad magic number
2682 57 common/cmd_nand.c Image header has correct magic number
2683 -58 common/cmd_nand.c Error reading Image from NAND device
2684 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002685
Heiko Schocher633e03a2007-06-22 19:11:54 +02002686 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002687
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002688 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher633e03a2007-06-22 19:11:54 +02002689 -64 net/eth.c no Ethernet found.
2690 65 net/eth.c Ethernet found.
wdenkc6097192002-11-03 00:24:07 +00002691
Heiko Schocher633e03a2007-06-22 19:11:54 +02002692 -80 common/cmd_net.c usage wrong
Joe Hershbergerc80b41b02015-04-08 01:41:21 -05002693 80 common/cmd_net.c before calling net_loop()
2694 -81 common/cmd_net.c some error in net_loop() occurred
2695 81 common/cmd_net.c net_loop() back without error
Heiko Schocher633e03a2007-06-22 19:11:54 +02002696 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2697 82 common/cmd_net.c trying automatic boot
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002698 83 common/cmd_net.c running "source" command
2699 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher633e03a2007-06-22 19:11:54 +02002700 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002701
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002702FIT uImage format:
2703
2704 Arg Where When
2705 100 common/cmd_bootm.c Kernel FIT Image has correct format
2706 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2707 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2708 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2709 102 common/cmd_bootm.c Kernel unit name specified
2710 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +01002711 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002712 104 common/cmd_bootm.c Got kernel subimage node offset
2713 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2714 105 common/cmd_bootm.c Kernel subimage hash verification OK
2715 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2716 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002717 -106 common/cmd_bootm.c Kernel subimage has wrong type
2718 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002719 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2720 108 common/cmd_bootm.c Got kernel subimage data/size
2721 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2722 -109 common/cmd_bootm.c Can't get kernel subimage type
2723 -110 common/cmd_bootm.c Can't get kernel subimage comp
2724 -111 common/cmd_bootm.c Can't get kernel subimage os
2725 -112 common/cmd_bootm.c Can't get kernel subimage load address
2726 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2727
2728 120 common/image.c Start initial ramdisk verification
2729 -120 common/image.c Ramdisk FIT image has incorrect format
2730 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002731 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002732 -122 common/image.c Can't get configuration for ramdisk subimage
2733 123 common/image.c Ramdisk unit name specified
2734 -124 common/image.c Can't get ramdisk subimage node offset
2735 125 common/image.c Got ramdisk subimage node offset
2736 -125 common/image.c Ramdisk subimage hash verification failed
2737 126 common/image.c Ramdisk subimage hash verification OK
2738 -126 common/image.c Ramdisk subimage for unsupported architecture
2739 127 common/image.c Architecture check OK
2740 -127 common/image.c Can't get ramdisk subimage data/size
2741 128 common/image.c Got ramdisk subimage data/size
2742 129 common/image.c Can't get ramdisk load address
2743 -129 common/image.c Got ramdisk load address
2744
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002745 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002746 131 common/cmd_doc.c FIT image format OK
2747
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002748 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002749 141 common/cmd_ide.c FIT image format OK
2750
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002751 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002752 151 common/cmd_nand.c FIT image format OK
2753
Heiko Schocher515eb122014-05-28 11:33:33 +02002754- legacy image format:
2755 CONFIG_IMAGE_FORMAT_LEGACY
2756 enables the legacy image format support in U-Boot.
2757
2758 Default:
2759 enabled if CONFIG_FIT_SIGNATURE is not defined.
2760
2761 CONFIG_DISABLE_IMAGE_LEGACY
2762 disable the legacy image format
2763
2764 This define is introduced, as the legacy image format is
2765 enabled per default for backward compatibility.
2766
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002767- Standalone program support:
2768 CONFIG_STANDALONE_LOAD_ADDR
2769
Wolfgang Denk23f78482011-10-09 21:06:34 +02002770 This option defines a board specific value for the
2771 address where standalone program gets loaded, thus
2772 overwriting the architecture dependent default
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002773 settings.
2774
2775- Frame Buffer Address:
2776 CONFIG_FB_ADDR
2777
2778 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denka71eb8e2013-01-03 00:43:59 +00002779 address for frame buffer. This is typically the case
2780 when using a graphics controller has separate video
2781 memory. U-Boot will then place the frame buffer at
2782 the given address instead of dynamically reserving it
2783 in system RAM by calling lcd_setmem(), which grabs
2784 the memory for the frame buffer depending on the
2785 configured panel size.
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002786
2787 Please see board_init_f function.
2788
Detlev Zundel0ecb6112009-12-01 17:16:19 +01002789- Automatic software updates via TFTP server
2790 CONFIG_UPDATE_TFTP
2791 CONFIG_UPDATE_TFTP_CNT_MAX
2792 CONFIG_UPDATE_TFTP_MSEC_MAX
2793
2794 These options enable and control the auto-update feature;
2795 for a more detailed description refer to doc/README.update.
2796
2797- MTD Support (mtdparts command, UBI support)
2798 CONFIG_MTD_DEVICE
2799
2800 Adds the MTD device infrastructure from the Linux kernel.
2801 Needed for mtdparts command support.
2802
2803 CONFIG_MTD_PARTITIONS
2804
2805 Adds the MTD partitioning infrastructure from the Linux
2806 kernel. Needed for UBI support.
2807
Joe Hershberger7d80fc12013-04-08 10:32:48 +00002808- UBI support
2809 CONFIG_CMD_UBI
2810
2811 Adds commands for interacting with MTD partitions formatted
2812 with the UBI flash translation layer
2813
2814 Requires also defining CONFIG_RBTREE
2815
Joe Hershberger47550fc2013-04-08 10:32:49 +00002816 CONFIG_UBI_SILENCE_MSG
2817
2818 Make the verbose messages from UBI stop printing. This leaves
2819 warnings and errors enabled.
2820
Heiko Schocherf5895d12014-06-24 10:10:04 +02002821
2822 CONFIG_MTD_UBI_WL_THRESHOLD
2823 This parameter defines the maximum difference between the highest
2824 erase counter value and the lowest erase counter value of eraseblocks
2825 of UBI devices. When this threshold is exceeded, UBI starts performing
2826 wear leveling by means of moving data from eraseblock with low erase
2827 counter to eraseblocks with high erase counter.
2828
2829 The default value should be OK for SLC NAND flashes, NOR flashes and
2830 other flashes which have eraseblock life-cycle 100000 or more.
2831 However, in case of MLC NAND flashes which typically have eraseblock
2832 life-cycle less than 10000, the threshold should be lessened (e.g.,
2833 to 128 or 256, although it does not have to be power of 2).
2834
2835 default: 4096
Simon Glass6c0be912014-10-23 18:58:54 -06002836
Heiko Schocherf5895d12014-06-24 10:10:04 +02002837 CONFIG_MTD_UBI_BEB_LIMIT
2838 This option specifies the maximum bad physical eraseblocks UBI
2839 expects on the MTD device (per 1024 eraseblocks). If the
2840 underlying flash does not admit of bad eraseblocks (e.g. NOR
2841 flash), this value is ignored.
2842
2843 NAND datasheets often specify the minimum and maximum NVM
2844 (Number of Valid Blocks) for the flashes' endurance lifetime.
2845 The maximum expected bad eraseblocks per 1024 eraseblocks
2846 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
2847 which gives 20 for most NANDs (MaxNVB is basically the total
2848 count of eraseblocks on the chip).
2849
2850 To put it differently, if this value is 20, UBI will try to
2851 reserve about 1.9% of physical eraseblocks for bad blocks
2852 handling. And that will be 1.9% of eraseblocks on the entire
2853 NAND chip, not just the MTD partition UBI attaches. This means
2854 that if you have, say, a NAND flash chip admits maximum 40 bad
2855 eraseblocks, and it is split on two MTD partitions of the same
2856 size, UBI will reserve 40 eraseblocks when attaching a
2857 partition.
2858
2859 default: 20
2860
2861 CONFIG_MTD_UBI_FASTMAP
2862 Fastmap is a mechanism which allows attaching an UBI device
2863 in nearly constant time. Instead of scanning the whole MTD device it
2864 only has to locate a checkpoint (called fastmap) on the device.
2865 The on-flash fastmap contains all information needed to attach
2866 the device. Using fastmap makes only sense on large devices where
2867 attaching by scanning takes long. UBI will not automatically install
2868 a fastmap on old images, but you can set the UBI parameter
2869 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
2870 that fastmap-enabled images are still usable with UBI implementations
2871 without fastmap support. On typical flash devices the whole fastmap
2872 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
2873
2874 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
2875 Set this parameter to enable fastmap automatically on images
2876 without a fastmap.
2877 default: 0
2878
Heiko Schocher94b66de2015-10-22 06:19:21 +02002879 CONFIG_MTD_UBI_FM_DEBUG
2880 Enable UBI fastmap debug
2881 default: 0
2882
Joe Hershberger7d80fc12013-04-08 10:32:48 +00002883- UBIFS support
2884 CONFIG_CMD_UBIFS
2885
2886 Adds commands for interacting with UBI volumes formatted as
2887 UBIFS. UBIFS is read-only in u-boot.
2888
2889 Requires UBI support as well as CONFIG_LZO
2890
Joe Hershberger47550fc2013-04-08 10:32:49 +00002891 CONFIG_UBIFS_SILENCE_MSG
2892
2893 Make the verbose messages from UBIFS stop printing. This leaves
2894 warnings and errors enabled.
2895
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002896- SPL framework
Wolfgang Denk825223d2011-09-11 21:24:09 +02002897 CONFIG_SPL
2898 Enable building of SPL globally.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002899
Tom Rini36853852012-02-14 07:29:40 +00002900 CONFIG_SPL_LDSCRIPT
2901 LDSCRIPT for linking the SPL binary.
2902
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002903 CONFIG_SPL_MAX_FOOTPRINT
2904 Maximum size in memory allocated to the SPL, BSS included.
2905 When defined, the linker checks that the actual memory
2906 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00002907 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002908 must not be both defined at the same time.
2909
Tom Rini36853852012-02-14 07:29:40 +00002910 CONFIG_SPL_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002911 Maximum size of the SPL image (text, data, rodata, and
2912 linker lists sections), BSS excluded.
2913 When defined, the linker checks that the actual size does
2914 not exceed it.
Tom Rini36853852012-02-14 07:29:40 +00002915
Wolfgang Denk825223d2011-09-11 21:24:09 +02002916 CONFIG_SPL_TEXT_BASE
2917 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002918
Scott Woodc4f0d002012-09-20 19:05:12 -05002919 CONFIG_SPL_RELOC_TEXT_BASE
2920 Address to relocate to. If unspecified, this is equal to
2921 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
2922
Tom Rini36853852012-02-14 07:29:40 +00002923 CONFIG_SPL_BSS_START_ADDR
2924 Link address for the BSS within the SPL binary.
2925
2926 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002927 Maximum size in memory allocated to the SPL BSS.
2928 When defined, the linker checks that the actual memory used
2929 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00002930 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002931 must not be both defined at the same time.
Tom Rini36853852012-02-14 07:29:40 +00002932
2933 CONFIG_SPL_STACK
2934 Adress of the start of the stack SPL will use
2935
Albert ARIBAUD \(3ADEV\)287b0942015-03-31 11:40:50 +02002936 CONFIG_SPL_PANIC_ON_RAW_IMAGE
2937 When defined, SPL will panic() if the image it has
2938 loaded does not have a signature.
2939 Defining this is useful when code which loads images
2940 in SPL cannot guarantee that absolutely all read errors
2941 will be caught.
2942 An example is the LPC32XX MLC NAND driver, which will
2943 consider that a completely unreadable NAND block is bad,
2944 and thus should be skipped silently.
2945
Scott Woodc4f0d002012-09-20 19:05:12 -05002946 CONFIG_SPL_RELOC_STACK
2947 Adress of the start of the stack SPL will use after
2948 relocation. If unspecified, this is equal to
2949 CONFIG_SPL_STACK.
2950
Tom Rini36853852012-02-14 07:29:40 +00002951 CONFIG_SYS_SPL_MALLOC_START
2952 Starting address of the malloc pool used in SPL.
Fabio Estevam38e1a972015-11-12 12:30:19 -02002953 When this option is set the full malloc is used in SPL and
2954 it is set up by spl_init() and before that, the simple malloc()
2955 can be used if CONFIG_SYS_MALLOC_F is defined.
Tom Rini36853852012-02-14 07:29:40 +00002956
2957 CONFIG_SYS_SPL_MALLOC_SIZE
2958 The size of the malloc pool used in SPL.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002959
Tom Rini28591df2012-08-13 12:03:19 -07002960 CONFIG_SPL_FRAMEWORK
2961 Enable the SPL framework under common/. This framework
2962 supports MMC, NAND and YMODEM loading of U-Boot and NAND
2963 NAND loading of the Linux Kernel.
2964
Tom Rinic2b76002014-03-28 12:03:39 -04002965 CONFIG_SPL_OS_BOOT
2966 Enable booting directly to an OS from SPL.
2967 See also: doc/README.falcon
2968
Tom Rinife3b0c72012-08-13 11:37:56 -07002969 CONFIG_SPL_DISPLAY_PRINT
2970 For ARM, enable an optional function to print more information
2971 about the running system.
2972
Scott Wood7c810902012-09-20 16:35:21 -05002973 CONFIG_SPL_INIT_MINIMAL
2974 Arch init code should be built for a very small image
2975
Paul Kocialkowski17675c82014-11-08 23:14:56 +01002976 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
2977 Partition on the MMC to load U-Boot from when the MMC is being
2978 used in raw mode
2979
Peter Korsgaard01b542f2013-05-13 08:36:29 +00002980 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
2981 Sector to load kernel uImage from when MMC is being
2982 used in raw mode (for Falcon mode)
2983
2984 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
2985 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
2986 Sector and number of sectors to load kernel argument
2987 parameters from when MMC is being used in raw mode
2988 (for falcon mode)
2989
Paul Kocialkowski341e8cd2014-11-08 23:14:55 +01002990 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
2991 Partition on the MMC to load U-Boot from when the MMC is being
2992 used in fs mode
2993
Guillaume GARDET5065b712014-10-15 17:53:13 +02002994 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
2995 Filename to read to load U-Boot when reading from filesystem
2996
2997 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00002998 Filename to read to load kernel uImage when reading
Guillaume GARDET5065b712014-10-15 17:53:13 +02002999 from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003000
Guillaume GARDET5065b712014-10-15 17:53:13 +02003001 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003002 Filename to read to load kernel argument parameters
Guillaume GARDET5065b712014-10-15 17:53:13 +02003003 when reading from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003004
Scott Wood2b36fbb2012-12-06 13:33:17 +00003005 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3006 Set this for NAND SPL on PPC mpc83xx targets, so that
3007 start.S waits for the rest of the SPL to load before
3008 continuing (the hardware starts execution after just
3009 loading the first page rather than the full 4K).
3010
Prabhakar Kushwaha6e2b9a32014-04-08 19:12:31 +05303011 CONFIG_SPL_SKIP_RELOCATE
3012 Avoid SPL relocation
3013
Scott Woodc352a0c2012-09-20 19:09:07 -05003014 CONFIG_SPL_NAND_BASE
3015 Include nand_base.c in the SPL. Requires
3016 CONFIG_SPL_NAND_DRIVERS.
3017
3018 CONFIG_SPL_NAND_DRIVERS
3019 SPL uses normal NAND drivers, not minimal drivers.
3020
3021 CONFIG_SPL_NAND_ECC
3022 Include standard software ECC in the SPL
3023
Tom Rini36853852012-02-14 07:29:40 +00003024 CONFIG_SPL_NAND_SIMPLE
Scott Wood36c440e2012-09-21 18:35:27 -05003025 Support for NAND boot using simple NAND drivers that
3026 expose the cmd_ctrl() interface.
Tom Rini36853852012-02-14 07:29:40 +00003027
Thomas Gleixner820d24d2016-07-12 20:28:12 +02003028 CONFIG_SPL_UBI
3029 Support for a lightweight UBI (fastmap) scanner and
3030 loader
3031
Heiko Schochercf000272014-10-31 08:31:00 +01003032 CONFIG_SPL_NAND_RAW_ONLY
3033 Support to boot only raw u-boot.bin images. Use this only
3034 if you need to save space.
3035
Ying Zhangdfb2b152013-08-16 15:16:12 +08003036 CONFIG_SPL_COMMON_INIT_DDR
3037 Set for common ddr init with serial presence detect in
3038 SPL binary.
3039
Tom Rini36853852012-02-14 07:29:40 +00003040 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3041 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3042 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3043 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3044 CONFIG_SYS_NAND_ECCBYTES
3045 Defines the size and behavior of the NAND that SPL uses
Scott Wood36c440e2012-09-21 18:35:27 -05003046 to read U-Boot
Tom Rini36853852012-02-14 07:29:40 +00003047
Prabhakar Kushwahaafffcb02013-12-11 12:42:11 +05303048 CONFIG_SPL_NAND_BOOT
3049 Add support NAND boot
3050
Tom Rini36853852012-02-14 07:29:40 +00003051 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood36c440e2012-09-21 18:35:27 -05003052 Location in NAND to read U-Boot from
3053
3054 CONFIG_SYS_NAND_U_BOOT_DST
3055 Location in memory to load U-Boot to
3056
3057 CONFIG_SYS_NAND_U_BOOT_SIZE
3058 Size of image to load
Tom Rini36853852012-02-14 07:29:40 +00003059
3060 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood36c440e2012-09-21 18:35:27 -05003061 Entry point in loaded image to jump to
Tom Rini36853852012-02-14 07:29:40 +00003062
3063 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3064 Define this if you need to first read the OOB and then the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003065 data. This is used, for example, on davinci platforms.
Tom Rini36853852012-02-14 07:29:40 +00003066
3067 CONFIG_SPL_OMAP3_ID_NAND
3068 Support for an OMAP3-specific set of functions to return the
3069 ID and MFR of the first attached NAND chip, if present.
3070
Pavel Machekde997252012-08-30 22:42:11 +02003071 CONFIG_SPL_RAM_DEVICE
3072 Support for running image already present in ram, in SPL binary
3073
Scott Woodeb7bd972012-12-06 13:33:16 +00003074 CONFIG_SPL_PAD_TO
Benoît Thébaudeauf0180722013-04-11 09:35:49 +00003075 Image offset to which the SPL should be padded before appending
3076 the SPL payload. By default, this is defined as
3077 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3078 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3079 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Woodeb7bd972012-12-06 13:33:16 +00003080
Scott Woodf147eb72012-09-21 16:27:32 -05003081 CONFIG_SPL_TARGET
3082 Final target image containing SPL and payload. Some SPLs
3083 use an arch-specific makefile fragment instead, for
3084 example if more than one image needs to be produced.
3085
Simon Glass82d94532013-05-08 08:05:59 +00003086 CONFIG_FIT_SPL_PRINT
3087 Printing information about a FIT image adds quite a bit of
3088 code to SPL. So this is normally disabled in SPL. Use this
3089 option to re-enable it. This will affect the output of the
3090 bootm command when booting a FIT image.
3091
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003092- TPL framework
3093 CONFIG_TPL
3094 Enable building of TPL globally.
3095
3096 CONFIG_TPL_PAD_TO
3097 Image offset to which the TPL should be padded before appending
3098 the TPL payload. By default, this is defined as
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02003099 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3100 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3101 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003102
wdenkc0aa5c52003-12-06 19:49:23 +00003103- Interrupt support (PPC):
3104
wdenk1ebf41e2004-01-02 14:00:00 +00003105 There are common interrupt_init() and timer_interrupt()
3106 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003107 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00003108 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003109 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00003110 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003111 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00003112 specific handling. If board has watchdog / status_led
3113 / other_activity_monitor it works automatically from
3114 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00003115
wdenkc6097192002-11-03 00:24:07 +00003116
Helmut Raigerd5a184b2011-10-20 04:19:47 +00003117Board initialization settings:
3118------------------------------
3119
3120During Initialization u-boot calls a number of board specific functions
3121to allow the preparation of board specific prerequisites, e.g. pin setup
3122before drivers are initialized. To enable these callbacks the
3123following configuration macros have to be defined. Currently this is
3124architecture specific, so please check arch/your_architecture/lib/board.c
3125typically in board_init_f() and board_init_r().
3126
3127- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3128- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3129- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3130- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003131
wdenkc6097192002-11-03 00:24:07 +00003132Configuration Settings:
3133-----------------------
3134
York Sun6c480012014-02-26 17:03:19 -08003135- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3136 Optionally it can be defined to support 64-bit memory commands.
3137
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003138- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003139 undefine this when you're short of memory.
3140
Peter Tyserdfb72b82009-01-27 18:03:12 -06003141- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3142 width of the commands listed in the 'help' command output.
3143
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003144- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003145 prompt for user input.
3146
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003147- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003148
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003149- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003150
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003151- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003152
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003153- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003154 the application (usually a Linux kernel) when it is
3155 booted
3156
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003157- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003158 List of legal baudrate settings for this board.
3159
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003160- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003161 Begin and End addresses of the area used by the
3162 simple memory test.
3163
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003164- CONFIG_SYS_ALT_MEMTEST:
wdenk57b2d802003-06-27 21:31:46 +00003165 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003166
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003167- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5958f4a2003-09-18 09:21:33 +00003168 Scratch address used by the alternate memory test
3169 You only need to set this if address zero isn't writeable
3170
York Sun5d286cd2015-12-04 11:57:07 -08003171- CONFIG_SYS_MEM_RESERVE_SECURE
York Sun1ef95cc2016-06-24 16:46:18 -07003172 Only implemented for ARMv8 for now.
York Sun5d286cd2015-12-04 11:57:07 -08003173 If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
3174 is substracted from total RAM and won't be reported to OS.
3175 This memory can be used as secure memory. A variable
York Sun1ef95cc2016-06-24 16:46:18 -07003176 gd->arch.secure_ram is used to track the location. In systems
York Sun5d286cd2015-12-04 11:57:07 -08003177 the RAM base is not zero, or RAM is divided into banks,
3178 this variable needs to be recalcuated to get the address.
3179
York Sun50739372015-12-07 11:05:29 -08003180- CONFIG_SYS_MEM_TOP_HIDE:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003181 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01003182 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003183 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01003184 fixing up gd->ram_size the Linux kernel should gets passed
3185 the now "corrected" memory size and won't touch it either.
3186 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01003187 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01003188 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01003189 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01003190
3191 This option can be used as a workaround for the 440EPx/GRx
3192 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3193 be touched.
3194
3195 WARNING: Please make sure that this value is a multiple of
3196 the Linux page size (normally 4k). If this is not the case,
3197 then the end address of the Linux memory will be located at a
3198 non page size aligned address and this could cause major
3199 problems.
3200
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003201- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003202 Enable temporary baudrate change while serial download
3203
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003204- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003205 Physical start address of SDRAM. _Must_ be 0 here.
3206
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003207- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003208 Physical start address of Flash memory.
3209
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003210- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003211 Physical start address of boot monitor code (set by
3212 make config files to be same as the text base address
Wolfgang Denk0708bc62010-10-07 21:51:12 +02003213 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003214 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003215
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003216- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00003217 Size of memory reserved for monitor code, used to
3218 determine _at_compile_time_ (!) if the environment is
3219 embedded within the U-Boot image, or in a separate
3220 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003221
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003222- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003223 Size of DRAM reserved for malloc() use.
3224
Simon Glass863e4042014-07-10 22:23:28 -06003225- CONFIG_SYS_MALLOC_F_LEN
3226 Size of the malloc() pool for use before relocation. If
3227 this is defined, then a very simple malloc() implementation
3228 will become available before relocation. The address is just
3229 below the global data, and the stack is moved down to make
3230 space.
3231
3232 This feature allocates regions with increasing addresses
3233 within the region. calloc() is supported, but realloc()
3234 is not available. free() is supported but does nothing.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003235 The memory will be freed (or in fact just forgotten) when
Simon Glass863e4042014-07-10 22:23:28 -06003236 U-Boot relocates itself.
3237
Simon Glass9fa901b2014-11-10 17:16:54 -07003238- CONFIG_SYS_MALLOC_SIMPLE
3239 Provides a simple and small malloc() and calloc() for those
3240 boards which do not use the full malloc in SPL (which is
3241 enabled with CONFIG_SYS_SPL_MALLOC_START).
3242
Thierry Redingc97d9742014-12-09 22:25:22 -07003243- CONFIG_SYS_NONCACHED_MEMORY:
3244 Size of non-cached memory area. This area of memory will be
3245 typically located right below the malloc() area and mapped
3246 uncached in the MMU. This is useful for drivers that would
3247 otherwise require a lot of explicit cache maintenance. For
3248 some drivers it's also impossible to properly maintain the
3249 cache. For example if the regions that need to be flushed
3250 are not a multiple of the cache-line size, *and* padding
3251 cannot be allocated between the regions to align them (i.e.
3252 if the HW requires a contiguous array of regions, and the
3253 size of each region is not cache-aligned), then a flush of
3254 one region may result in overwriting data that hardware has
3255 written to another region in the same cache-line. This can
3256 happen for example in network drivers where descriptors for
3257 buffers are typically smaller than the CPU cache-line (e.g.
3258 16 bytes vs. 32 or 64 bytes).
3259
3260 Non-cached memory is only supported on 32-bit ARM at present.
3261
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003262- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01003263 Normally compressed uImages are limited to an
3264 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003265 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01003266 to adjust this setting to your needs.
3267
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003268- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003269 Maximum size of memory mapped by the startup code of
3270 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003271 the Linux kernel (bd_info, boot arguments, FDT blob if
3272 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003273 environment variable is defined and non-zero. In such case
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003274 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denk092ae952011-10-26 10:21:21 +00003275 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likely26396382011-03-28 09:58:43 +00003276 variable "bootm_mapsize" will override the value of
3277 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3278 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003279
John Rigbyeea8e692010-10-13 13:57:35 -06003280- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3281 Enable initrd_high functionality. If defined then the
3282 initrd_high feature is enabled and the bootm ramdisk subcommand
3283 is enabled.
3284
3285- CONFIG_SYS_BOOT_GET_CMDLINE:
3286 Enables allocating and saving kernel cmdline in space between
3287 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3288
3289- CONFIG_SYS_BOOT_GET_KBD:
3290 Enables allocating and saving a kernel copy of the bd_info in
3291 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3292
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003293- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003294 Max number of Flash memory banks
3295
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003296- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003297 Max number of sectors on a Flash chip
3298
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003299- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003300 Timeout for Flash erase operations (in ms)
3301
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003302- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003303 Timeout for Flash write operations (in ms)
3304
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003305- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003306 Timeout for Flash set sector lock bit operation (in ms)
3307
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003308- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003309 Timeout for Flash clear lock bits operation (in ms)
3310
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003311- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00003312 If defined, hardware flash sectors protection is used
3313 instead of U-Boot software protection.
3314
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003315- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003316
3317 Enable TFTP transfers directly to flash memory;
3318 without this option such a download has to be
3319 performed in two steps: (1) download to RAM, and (2)
3320 copy from RAM to flash.
3321
3322 The two-step approach is usually more reliable, since
3323 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003324 the flash, but in some situations (when system RAM is
3325 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003326 downloaded image) this option may be very useful.
3327
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003328- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00003329 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00003330 common flash structure for storing flash geometry.
3331
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02003332- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00003333 This option also enables the building of the cfi_flash driver
3334 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003335
Piotr Ziecik3e939e92008-11-17 15:57:58 +01003336- CONFIG_FLASH_CFI_MTD
3337 This option enables the building of the cfi_mtd driver
3338 in the drivers directory. The driver exports CFI flash
3339 to the MTD layer.
3340
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003341- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02003342 Use buffered writes to flash.
3343
3344- CONFIG_FLASH_SPANSION_S29WS_N
3345 s29ws-n MirrorBit flash has non-standard addresses for buffered
3346 write commands.
3347
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003348- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01003349 If this option is defined, the common CFI flash doesn't
3350 print it's warning upon not recognized FLASH banks. This
3351 is useful, if some of the configured banks are only
3352 optionally available.
3353
Jerry Van Barenaae73572008-03-08 13:48:01 -05003354- CONFIG_FLASH_SHOW_PROGRESS
3355 If defined (must be an integer), print out countdown
3356 digits and dots. Recommended value: 45 (9..1) for 80
3357 column displays, 15 (3..1) for 40 column displays.
3358
Stefan Roesed20cba52013-04-04 15:53:14 +02003359- CONFIG_FLASH_VERIFY
3360 If defined, the content of the flash (destination) is compared
3361 against the source after the write operation. An error message
3362 will be printed when the contents are not identical.
3363 Please note that this option is useless in nearly all cases,
3364 since such flash programming errors usually are detected earlier
3365 while unprotecting/erasing/programming. Please only enable
3366 this option if you really know what you are doing.
3367
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003368- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003369 Defines the number of Ethernet receive buffers. On some
3370 Ethernet controllers it is recommended to set this value
stroese94ef1cf2003-06-05 15:39:44 +00003371 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3372 buffers can be full shortly after enabling the interface
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003373 on high Ethernet traffic.
stroese94ef1cf2003-06-05 15:39:44 +00003374 Defaults to 4 if not defined.
3375
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003376- CONFIG_ENV_MAX_ENTRIES
3377
Wolfgang Denk1136f692010-10-27 22:48:30 +02003378 Maximum number of entries in the hash table that is used
3379 internally to store the environment settings. The default
3380 setting is supposed to be generous and should work in most
3381 cases. This setting can be used to tune behaviour; see
3382 lib/hashtable.c for details.
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003383
Joe Hershberger71497d02012-12-11 22:16:31 -06003384- CONFIG_ENV_FLAGS_LIST_DEFAULT
3385- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003386 Enable validation of the values given to environment variables when
Joe Hershberger71497d02012-12-11 22:16:31 -06003387 calling env set. Variables can be restricted to only decimal,
3388 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3389 the variables can also be restricted to IP address or MAC address.
3390
3391 The format of the list is:
3392 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003393 access_attribute = [a|r|o|c]
3394 attributes = type_attribute[access_attribute]
Joe Hershberger71497d02012-12-11 22:16:31 -06003395 entry = variable_name[:attributes]
3396 list = entry[,list]
3397
3398 The type attributes are:
3399 s - String (default)
3400 d - Decimal
3401 x - Hexadecimal
3402 b - Boolean ([1yYtT|0nNfF])
3403 i - IP address
3404 m - MAC address
3405
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003406 The access attributes are:
3407 a - Any (default)
3408 r - Read-only
3409 o - Write-once
3410 c - Change-default
3411
Joe Hershberger71497d02012-12-11 22:16:31 -06003412 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3413 Define this to a list (string) to define the ".flags"
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003414 environment variable in the default or embedded environment.
Joe Hershberger71497d02012-12-11 22:16:31 -06003415
3416 - CONFIG_ENV_FLAGS_LIST_STATIC
3417 Define this to a list (string) to define validation that
3418 should be done if an entry is not found in the ".flags"
3419 environment variable. To override a setting in the static
3420 list, simply add an entry for the same variable name to the
3421 ".flags" variable.
3422
Joe Hershberger6db9fd42015-05-20 14:27:20 -05003423 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
3424 regular expression. This allows multiple variables to define the same
3425 flags without explicitly listing them for each variable.
3426
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003427- CONFIG_ENV_ACCESS_IGNORE_FORCE
3428 If defined, don't allow the -f switch to env set override variable
3429 access flags.
3430
Gabe Black3687fe42014-10-15 04:38:30 -06003431- CONFIG_USE_STDINT
3432 If stdint.h is available with your toolchain you can define this
3433 option to enable it. You can provide option 'USE_STDINT=1' when
3434 building U-Boot to enable this.
3435
wdenkc6097192002-11-03 00:24:07 +00003436The following definitions that deal with the placement and management
3437of environment data (variable area); in general, we support the
3438following configurations:
3439
Mike Frysinger63b8f122011-07-08 10:44:25 +00003440- CONFIG_BUILD_ENVCRC:
3441
3442 Builds up envcrc with the target environment so that external utils
3443 may easily extract it and embed it in final U-Boot images.
3444
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02003445- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00003446
3447 Define this if the environment is in flash memory.
3448
3449 a) The environment occupies one whole flash sector, which is
3450 "embedded" in the text segment with the U-Boot code. This
3451 happens usually with "bottom boot sector" or "top boot
3452 sector" type flash chips, which have several smaller
3453 sectors at the start or the end. For instance, such a
3454 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3455 such a case you would place the environment in one of the
3456 4 kB sectors - with U-Boot code before and after it. With
3457 "top boot sector" type flash chips, you would put the
3458 environment in one of the last sectors, leaving a gap
3459 between U-Boot and the environment.
3460
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003461 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003462
3463 Offset of environment data (variable area) to the
3464 beginning of flash memory; for instance, with bottom boot
3465 type flash chips the second sector can be used: the offset
3466 for this sector is given here.
3467
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003468 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00003469
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003470 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003471
3472 This is just another way to specify the start address of
3473 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003474 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00003475
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003476 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003477
3478 Size of the sector containing the environment.
3479
3480
3481 b) Sometimes flash chips have few, equal sized, BIG sectors.
3482 In such a case you don't want to spend a whole sector for
3483 the environment.
3484
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003485 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003486
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02003487 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003488 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00003489 of this flash sector for the environment. This saves
3490 memory for the RAM copy of the environment.
3491
3492 It may also save flash memory if you decide to use this
3493 when your environment is "embedded" within U-Boot code,
3494 since then the remainder of the flash sector could be used
3495 for U-Boot code. It should be pointed out that this is
3496 STRONGLY DISCOURAGED from a robustness point of view:
3497 updating the environment in flash makes it always
3498 necessary to erase the WHOLE sector. If something goes
3499 wrong before the contents has been restored from a copy in
3500 RAM, your target system will be dead.
3501
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003502 - CONFIG_ENV_ADDR_REDUND
3503 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00003504
wdenk4a5c8a72003-03-06 00:02:04 +00003505 These settings describe a second storage area used to hold
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003506 a redundant copy of the environment data, so that there is
wdenkb02744a2003-04-05 00:53:31 +00003507 a valid backup copy in case there is a power failure during
wdenk4a5c8a72003-03-06 00:02:04 +00003508 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00003509
3510BE CAREFUL! Any changes to the flash layout, and some changes to the
3511source code will make it necessary to adapt <board>/u-boot.lds*
3512accordingly!
3513
3514
Jean-Christophe PLAGNIOL-VILLARDfdb79c32008-09-10 22:47:59 +02003515- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00003516
3517 Define this if you have some non-volatile memory device
3518 (NVRAM, battery buffered SRAM) which you want to use for the
3519 environment.
3520
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003521 - CONFIG_ENV_ADDR:
3522 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003523
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003524 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00003525 want to use for environment. It is assumed that this memory
3526 can just be read and written to, without any special
3527 provision.
3528
3529BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003530in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003531console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00003532U-Boot will hang.
3533
3534Please note that even with NVRAM we still use a copy of the
3535environment in RAM: we could work on NVRAM directly, but we want to
3536keep settings there always unmodified except somebody uses "saveenv"
3537to save the current settings.
3538
3539
Jean-Christophe PLAGNIOL-VILLARDe46af642008-09-05 09:19:30 +02003540- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00003541
3542 Use this if you have an EEPROM or similar serial access
3543 device and a driver for it.
3544
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003545 - CONFIG_ENV_OFFSET:
3546 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003547
3548 These two #defines specify the offset and size of the
3549 environment area within the total memory of your EEPROM.
3550
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003551 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003552 If defined, specified the chip address of the EEPROM device.
3553 The default address is zero.
3554
Christian Gmeiner4c5b7542015-02-11 15:19:31 +01003555 - CONFIG_SYS_I2C_EEPROM_BUS:
3556 If defined, specified the i2c bus of the EEPROM device.
3557
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003558 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00003559 If defined, the number of bits used to address bytes in a
3560 single page in the EEPROM device. A 64 byte page, for example
3561 would require six bits.
3562
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003563 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00003564 If defined, the number of milliseconds to delay between
wdenk544e9732004-02-06 23:19:44 +00003565 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00003566
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003567 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00003568 The length in bytes of the EEPROM memory array address. Note
3569 that this is NOT the chip address length!
3570
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003571 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk20c98a62004-04-23 20:32:05 +00003572 EEPROM chips that implement "address overflow" are ones
3573 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
3574 address and the extra bits end up in the "chip address" bit
3575 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
3576 byte chips.
3577
3578 Note that we consider the length of the address field to
3579 still be one byte because the extra address bits are hidden
3580 in the chip address.
3581
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003582 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003583 The size in bytes of the EEPROM device.
3584
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01003585 - CONFIG_ENV_EEPROM_IS_ON_I2C
3586 define this, if you have I2C and SPI activated, and your
3587 EEPROM, which holds the environment, is on the I2C bus.
3588
3589 - CONFIG_I2C_ENV_EEPROM_BUS
3590 if you have an Environment on an EEPROM reached over
3591 I2C muxes, you can define here, how to reach this
3592 EEPROM. For example:
3593
Heiko Schocher479a4cf2013-01-29 08:53:15 +01003594 #define CONFIG_I2C_ENV_EEPROM_BUS 1
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01003595
3596 EEPROM which holds the environment, is reached over
3597 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00003598
Jean-Christophe PLAGNIOL-VILLARD2b14d2b2008-09-10 22:47:58 +02003599- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk86765902003-12-06 23:55:10 +00003600
wdenk1ebf41e2004-01-02 14:00:00 +00003601 Define this if you have a DataFlash memory device which you
wdenk86765902003-12-06 23:55:10 +00003602 want to use for the environment.
3603
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003604 - CONFIG_ENV_OFFSET:
3605 - CONFIG_ENV_ADDR:
3606 - CONFIG_ENV_SIZE:
wdenk86765902003-12-06 23:55:10 +00003607
3608 These three #defines specify the offset and size of the
3609 environment area within the total memory of your DataFlash placed
3610 at the specified address.
3611
Wu, Josh76db7bf2014-07-01 19:30:13 +08003612- CONFIG_ENV_IS_IN_SPI_FLASH:
3613
3614 Define this if you have a SPI Flash memory device which you
3615 want to use for the environment.
3616
3617 - CONFIG_ENV_OFFSET:
3618 - CONFIG_ENV_SIZE:
3619
3620 These two #defines specify the offset and size of the
3621 environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
3622 aligned to an erase sector boundary.
3623
3624 - CONFIG_ENV_SECT_SIZE:
3625
3626 Define the SPI flash's sector size.
3627
3628 - CONFIG_ENV_OFFSET_REDUND (optional):
3629
3630 This setting describes a second storage area of CONFIG_ENV_SIZE
3631 size used to hold a redundant copy of the environment data, so
3632 that there is a valid backup copy in case there is a power failure
Simon Glass5b9a5172016-10-02 18:00:58 -06003633 during a "saveenv" operation. CONFIG_ENV_OFFSET_REDUND must be
Wu, Josh76db7bf2014-07-01 19:30:13 +08003634 aligned to an erase sector boundary.
3635
3636 - CONFIG_ENV_SPI_BUS (optional):
3637 - CONFIG_ENV_SPI_CS (optional):
3638
3639 Define the SPI bus and chip select. If not defined they will be 0.
3640
3641 - CONFIG_ENV_SPI_MAX_HZ (optional):
3642
3643 Define the SPI max work clock. If not defined then use 1MHz.
3644
3645 - CONFIG_ENV_SPI_MODE (optional):
3646
3647 Define the SPI work mode. If not defined then use SPI_MODE_3.
3648
Liu Gang85bcd732012-03-08 00:33:20 +00003649- CONFIG_ENV_IS_IN_REMOTE:
3650
3651 Define this if you have a remote memory space which you
3652 want to use for the local device's environment.
3653
3654 - CONFIG_ENV_ADDR:
3655 - CONFIG_ENV_SIZE:
3656
3657 These two #defines specify the address and size of the
3658 environment area within the remote memory space. The
3659 local device can get the environment from remote memory
Liu Gang357bf5a2012-08-09 05:10:01 +00003660 space by SRIO or PCIE links.
Liu Gang85bcd732012-03-08 00:33:20 +00003661
3662BE CAREFUL! For some special cases, the local device can not use
3663"saveenv" command. For example, the local device will get the
Liu Gang357bf5a2012-08-09 05:10:01 +00003664environment stored in a remote NOR flash by SRIO or PCIE link,
3665but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang85bcd732012-03-08 00:33:20 +00003666
Jean-Christophe PLAGNIOL-VILLARDdda84dd2008-09-10 22:47:58 +02003667- CONFIG_ENV_IS_IN_NAND:
wdenk79b59372004-06-09 14:58:14 +00003668
3669 Define this if you have a NAND device which you want to use
3670 for the environment.
3671
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003672 - CONFIG_ENV_OFFSET:
3673 - CONFIG_ENV_SIZE:
wdenk79b59372004-06-09 14:58:14 +00003674
3675 These two #defines specify the offset and size of the environment
Scott Wood08239322010-09-17 14:38:37 -05003676 area within the first NAND device. CONFIG_ENV_OFFSET must be
3677 aligned to an erase block boundary.
wdenk86765902003-12-06 23:55:10 +00003678
Scott Wood08239322010-09-17 14:38:37 -05003679 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01003680
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003681 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Wood08239322010-09-17 14:38:37 -05003682 size used to hold a redundant copy of the environment data, so
3683 that there is a valid backup copy in case there is a power failure
Simon Glass5b9a5172016-10-02 18:00:58 -06003684 during a "saveenv" operation. CONFIG_ENV_OFFSET_REDUND must be
Scott Wood08239322010-09-17 14:38:37 -05003685 aligned to an erase block boundary.
3686
3687 - CONFIG_ENV_RANGE (optional):
3688
3689 Specifies the length of the region in which the environment
3690 can be written. This should be a multiple of the NAND device's
3691 block size. Specifying a range with more erase blocks than
3692 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3693 the range to be avoided.
3694
3695 - CONFIG_ENV_OFFSET_OOB (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01003696
Scott Wood08239322010-09-17 14:38:37 -05003697 Enables support for dynamically retrieving the offset of the
3698 environment from block zero's out-of-band data. The
3699 "nand env.oob" command can be used to record this offset.
3700 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3701 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01003702
Guennadi Liakhovetskifad24442009-05-18 16:07:22 +02003703- CONFIG_NAND_ENV_DST
3704
3705 Defines address in RAM to which the nand_spl code should copy the
3706 environment. If redundant environment is used, it will be copied to
3707 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3708
Joe Hershberger0c5faa82013-04-08 10:32:51 +00003709- CONFIG_ENV_IS_IN_UBI:
3710
3711 Define this if you have an UBI volume that you want to use for the
3712 environment. This has the benefit of wear-leveling the environment
3713 accesses, which is important on NAND.
3714
3715 - CONFIG_ENV_UBI_PART:
3716
3717 Define this to a string that is the mtd partition containing the UBI.
3718
3719 - CONFIG_ENV_UBI_VOLUME:
3720
3721 Define this to the name of the volume that you want to store the
3722 environment in.
3723
Joe Hershbergerdb14e862013-04-08 10:32:52 +00003724 - CONFIG_ENV_UBI_VOLUME_REDUND:
3725
3726 Define this to the name of another volume to store a second copy of
3727 the environment in. This will enable redundant environments in UBI.
3728 It is assumed that both volumes are in the same MTD partition.
3729
Joe Hershberger0c5faa82013-04-08 10:32:51 +00003730 - CONFIG_UBI_SILENCE_MSG
3731 - CONFIG_UBIFS_SILENCE_MSG
3732
3733 You will probably want to define these to avoid a really noisy system
3734 when storing the env in UBI.
3735
Wu, Josha7d0c872014-06-24 17:31:03 +08003736- CONFIG_ENV_IS_IN_FAT:
3737 Define this if you want to use the FAT file system for the environment.
3738
3739 - FAT_ENV_INTERFACE:
3740
3741 Define this to a string that is the name of the block device.
3742
Nicolae Rosia86811f22016-11-21 17:33:58 +02003743 - FAT_ENV_DEVICE_AND_PART:
Wu, Josha7d0c872014-06-24 17:31:03 +08003744
3745 Define this to a string to specify the partition of the device. It can
3746 be as following:
3747
3748 "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
3749 - "D:P": device D partition P. Error occurs if device D has no
3750 partition table.
3751 - "D:0": device D.
3752 - "D" or "D:": device D partition 1 if device D has partition
3753 table, or the whole device D if has no partition
3754 table.
3755 - "D:auto": first partition in device D with bootable flag set.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003756 If none, first valid partition in device D. If no
Wu, Josha7d0c872014-06-24 17:31:03 +08003757 partition table then means device D.
3758
3759 - FAT_ENV_FILE:
3760
3761 It's a string of the FAT file name. This file use to store the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003762 environment.
Wu, Josha7d0c872014-06-24 17:31:03 +08003763
3764 - CONFIG_FAT_WRITE:
Tom Rinid8532af2017-06-02 11:03:50 -04003765 This must be enabled. Otherwise it cannot save the environment file.
Wu, Josha7d0c872014-06-24 17:31:03 +08003766
Stephen Warreneedcacd2013-06-11 15:14:00 -06003767- CONFIG_ENV_IS_IN_MMC:
3768
3769 Define this if you have an MMC device which you want to use for the
3770 environment.
3771
3772 - CONFIG_SYS_MMC_ENV_DEV:
3773
3774 Specifies which MMC device the environment is stored in.
3775
3776 - CONFIG_SYS_MMC_ENV_PART (optional):
3777
3778 Specifies which MMC partition the environment is stored in. If not
3779 set, defaults to partition 0, the user area. Common values might be
3780 1 (first MMC boot partition), 2 (second MMC boot partition).
3781
3782 - CONFIG_ENV_OFFSET:
3783 - CONFIG_ENV_SIZE:
3784
3785 These two #defines specify the offset and size of the environment
3786 area within the specified MMC device.
3787
Stephen Warren24dc2032013-06-11 15:14:02 -06003788 If offset is positive (the usual case), it is treated as relative to
3789 the start of the MMC partition. If offset is negative, it is treated
3790 as relative to the end of the MMC partition. This can be useful if
3791 your board may be fitted with different MMC devices, which have
3792 different sizes for the MMC partitions, and you always want the
3793 environment placed at the very end of the partition, to leave the
3794 maximum possible space before it, to store other data.
3795
Stephen Warreneedcacd2013-06-11 15:14:00 -06003796 These two values are in units of bytes, but must be aligned to an
3797 MMC sector boundary.
3798
3799 - CONFIG_ENV_OFFSET_REDUND (optional):
3800
3801 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
3802 hold a redundant copy of the environment data. This provides a
3803 valid backup copy in case the other copy is corrupted, e.g. due
3804 to a power failure during a "saveenv" operation.
3805
Stephen Warren24dc2032013-06-11 15:14:02 -06003806 This value may also be positive or negative; this is handled in the
3807 same way as CONFIG_ENV_OFFSET.
3808
Stephen Warreneedcacd2013-06-11 15:14:00 -06003809 This value is also in units of bytes, but must also be aligned to
3810 an MMC sector boundary.
3811
3812 - CONFIG_ENV_SIZE_REDUND (optional):
3813
3814 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
3815 set. If this value is set, it must be set to the same value as
3816 CONFIG_ENV_SIZE.
3817
Bruce Adleredecc942007-11-02 13:15:42 -07003818Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00003819has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denk76af2782010-07-24 21:55:43 +02003820created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00003821until then to read environment variables.
3822
wdenk8dba0502003-03-31 16:34:49 +00003823The environment is protected by a CRC32 checksum. Before the monitor
3824is relocated into RAM, as a result of a bad CRC you will be working
3825with the compiled-in default environment - *silently*!!! [This is
3826necessary, because the first environment variable we need is the
3827"baudrate" setting for the console - if we have a bad CRC, we don't
3828have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00003829
3830Note: once the monitor has been relocated, then it will complain if
3831the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00003832use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00003833
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003834- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk9c53f402003-10-15 23:53:47 +00003835 Echo the inverted Ethernet link state to the fault LED.
wdenk49c3f672003-10-08 22:33:00 +00003836
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003837 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenk49c3f672003-10-08 22:33:00 +00003838 also needs to be defined.
3839
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003840- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00003841 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00003842
Ron Madriddfa028a2009-02-18 14:30:44 -08003843- CONFIG_NS16550_MIN_FUNCTIONS:
3844 Define this if you desire to only have use of the NS16550_init
3845 and NS16550_putc functions for the serial driver located at
3846 drivers/serial/ns16550.c. This option is useful for saving
3847 space for already greatly restricted images, including but not
3848 limited to NAND_SPL configurations.
3849
Simon Glass28a9e332012-11-30 13:01:18 +00003850- CONFIG_DISPLAY_BOARDINFO
3851 Display information about the board that U-Boot is running on
3852 when U-Boot starts up. The board function checkboard() is called
3853 to do this.
3854
Simon Glasse8822012012-11-30 13:01:19 +00003855- CONFIG_DISPLAY_BOARDINFO_LATE
3856 Similar to the previous option, but display this information
3857 later, once stdio is running and output goes to the LCD, if
3858 present.
3859
Sascha Silbe4b9c17c2013-08-11 16:40:43 +02003860- CONFIG_BOARD_SIZE_LIMIT:
3861 Maximum size of the U-Boot image. When defined, the
3862 build system checks that the actual size does not
3863 exceed it.
3864
wdenkc6097192002-11-03 00:24:07 +00003865Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00003866---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003867
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003868- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003869 Cache Line Size of the CPU.
3870
Timur Tabid8f341c2011-08-04 18:03:41 -05003871- CONFIG_SYS_CCSRBAR_DEFAULT:
3872 Default (power-on reset) physical address of CCSR on Freescale
3873 PowerPC SOCs.
3874
3875- CONFIG_SYS_CCSRBAR:
3876 Virtual address of CCSR. On a 32-bit build, this is typically
3877 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3878
Timur Tabid8f341c2011-08-04 18:03:41 -05003879- CONFIG_SYS_CCSRBAR_PHYS:
3880 Physical address of CCSR. CCSR can be relocated to a new
3881 physical address, if desired. In this case, this macro should
Wolfgang Denk092ae952011-10-26 10:21:21 +00003882 be set to that address. Otherwise, it should be set to the
Timur Tabid8f341c2011-08-04 18:03:41 -05003883 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
3884 is typically relocated on 36-bit builds. It is recommended
3885 that this macro be defined via the _HIGH and _LOW macros:
3886
3887 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3888 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3889
3890- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003891 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
3892 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabid8f341c2011-08-04 18:03:41 -05003893 used in assembly code, so it must not contain typecasts or
3894 integer size suffixes (e.g. "ULL").
3895
3896- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3897 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
3898 used in assembly code, so it must not contain typecasts or
3899 integer size suffixes (e.g. "ULL").
3900
3901- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3902 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3903 forced to a value that ensures that CCSR is not relocated.
3904
wdenk1272e232002-11-10 22:06:23 +00003905- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003906 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk1272e232002-11-10 22:06:23 +00003907
3908 the default drive number (default value 0)
3909
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003910 CONFIG_SYS_ISA_IO_STRIDE
wdenk1272e232002-11-10 22:06:23 +00003911
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003912 defines the spacing between FDC chipset registers
wdenk1272e232002-11-10 22:06:23 +00003913 (default value 1)
3914
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003915 CONFIG_SYS_ISA_IO_OFFSET
wdenk1272e232002-11-10 22:06:23 +00003916
wdenk4a5c8a72003-03-06 00:02:04 +00003917 defines the offset of register from address. It
3918 depends on which part of the data bus is connected to
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003919 the FDC chipset. (default value 0)
wdenk1272e232002-11-10 22:06:23 +00003920
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003921 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
3922 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk4a5c8a72003-03-06 00:02:04 +00003923 default value.
wdenk1272e232002-11-10 22:06:23 +00003924
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003925 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk4a5c8a72003-03-06 00:02:04 +00003926 fdc_hw_init() is called at the beginning of the FDC
3927 setup. fdc_hw_init() must be provided by the board
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003928 source code. It is used to make hardware-dependent
wdenk4a5c8a72003-03-06 00:02:04 +00003929 initializations.
wdenk1272e232002-11-10 22:06:23 +00003930
Macpaul Lind1e49942011-04-11 20:45:32 +00003931- CONFIG_IDE_AHB:
3932 Most IDE controllers were designed to be connected with PCI
3933 interface. Only few of them were designed for AHB interface.
3934 When software is doing ATA command and data transfer to
3935 IDE devices through IDE-AHB controller, some additional
3936 registers accessing to these kind of IDE-AHB controller
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003937 is required.
Macpaul Lind1e49942011-04-11 20:45:32 +00003938
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003939- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00003940 DO NOT CHANGE unless you know exactly what you're
Heiko Schocher65d94db2017-06-07 17:33:09 +02003941 doing! (11-4) [82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00003942
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003943- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003944
wdenkeb20ad32003-09-05 23:19:14 +00003945 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00003946 initial data and stack; please note that this must be
3947 writable memory that is working WITHOUT special
3948 initialization, i. e. you CANNOT use normal RAM which
3949 will become available only after programming the
3950 memory controller and running certain initialization
3951 sequences.
3952
3953 U-Boot uses the following memory types:
wdenkc6097192002-11-03 00:24:07 +00003954 - PPC4xx: data cache
3955
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003956- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003957
3958 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003959 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
3960 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00003961 data is located at the end of the available space
Wolfgang Denk1c2e98e2010-10-26 13:32:32 +02003962 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Simon Glass9a6ac8b2016-10-02 18:01:06 -06003963 GENERATED_GBL_DATA_SIZE), and the initial stack is just
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003964 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
3965 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00003966
3967 Note:
3968 On the MPC824X (or other systems that use the data
3969 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003970 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00003971 point to an otherwise UNUSED address space between
3972 the top of RAM and the start of the PCI space.
3973
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003974- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00003975
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003976- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00003977 SDRAM timing
3978
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003979- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00003980 periodic timer for refresh
3981
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003982- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
3983 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
3984 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
3985 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003986 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3987
3988- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003989 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
3990 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003991 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3992
Dirk Eibach378d1ca2009-02-09 08:18:34 +01003993- CONFIG_PCI_DISABLE_PCIE:
3994 Disable PCI-Express on systems where it is supported but not
3995 required.
3996
Andrew Sharp61d47ca2012-08-29 14:16:32 +00003997- CONFIG_PCI_ENUM_ONLY
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003998 Only scan through and get the devices on the buses.
Andrew Sharp61d47ca2012-08-29 14:16:32 +00003999 Don't do any setup work, presumably because someone or
4000 something has already done it, and we don't need to do it
4001 a second time. Useful for platforms that are pre-booted
4002 by coreboot or similar.
4003
Gabor Juhosb4458732013-05-30 07:06:12 +00004004- CONFIG_PCI_INDIRECT_BRIDGE:
4005 Enable support for indirect PCI bridges.
4006
Kumar Gala8975d7a2010-12-30 12:09:53 -06004007- CONFIG_SYS_SRIO:
4008 Chip has SRIO or not
4009
4010- CONFIG_SRIO1:
4011 Board has SRIO 1 port available
4012
4013- CONFIG_SRIO2:
4014 Board has SRIO 2 port available
4015
Liu Gang27afb9c2013-05-07 16:30:46 +08004016- CONFIG_SRIO_PCIE_BOOT_MASTER
4017 Board can support master function for Boot from SRIO and PCIE
4018
Kumar Gala8975d7a2010-12-30 12:09:53 -06004019- CONFIG_SYS_SRIOn_MEM_VIRT:
4020 Virtual Address of SRIO port 'n' memory region
4021
4022- CONFIG_SYS_SRIOn_MEM_PHYS:
4023 Physical Address of SRIO port 'n' memory region
4024
4025- CONFIG_SYS_SRIOn_MEM_SIZE:
4026 Size of SRIO port 'n' memory region
4027
Fabio Estevamf17e8782013-04-11 09:35:34 +00004028- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4029 Defined to tell the NAND controller that the NAND chip is using
4030 a 16 bit bus.
4031 Not all NAND drivers use this symbol.
Fabio Estevam417052b2013-04-11 09:35:35 +00004032 Example of drivers that use it:
Fabio Estevamf17e8782013-04-11 09:35:34 +00004033 - drivers/mtd/nand/ndfc.c
Fabio Estevam417052b2013-04-11 09:35:35 +00004034 - drivers/mtd/nand/mxc_nand.c
Alex Watermancd6aae32011-05-19 15:08:36 -04004035
4036- CONFIG_SYS_NDFC_EBC0_CFG
4037 Sets the EBC0_CFG register for the NDFC. If not defined
4038 a default value will be used.
4039
Ben Warren45657152006-09-07 16:50:54 -04004040- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004041 Get DDR timing information from an I2C EEPROM. Common
4042 with pluggable memory modules such as SODIMMs
4043
Ben Warren45657152006-09-07 16:50:54 -04004044 SPD_EEPROM_ADDRESS
4045 I2C address of the SPD EEPROM
4046
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004047- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004048 If SPD EEPROM is on an I2C bus other than the first
4049 one, specify here. Note that the value must resolve
4050 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04004051
York Sune73cc042011-06-07 09:42:16 +08004052- CONFIG_SYS_DDR_RAW_TIMING
4053 Get DDR timing information from other than SPD. Common with
4054 soldered DDR chips onboard without SPD. DDR raw timing
4055 parameters are extracted from datasheet and hard-coded into
4056 header files or board specific files.
4057
York Sunbd495cf2011-09-16 13:21:35 -07004058- CONFIG_FSL_DDR_INTERACTIVE
4059 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4060
York Sun8ced0502015-01-06 13:18:55 -08004061- CONFIG_FSL_DDR_SYNC_REFRESH
4062 Enable sync of refresh for multiple controllers.
4063
York Sunb6a35f82015-03-19 09:30:28 -07004064- CONFIG_FSL_DDR_BIST
4065 Enable built-in memory test for Freescale DDR controllers.
4066
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004067- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004068 Only for 83xx systems. If specified, then DDR should
4069 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06004070
wdenk6203e402004-04-18 10:13:26 +00004071- CONFIG_RMII
4072 Enable RMII mode for all FECs.
4073 Note that this is a global option, we can't
4074 have one FEC in standard MII mode and another in RMII mode.
4075
wdenk20c98a62004-04-23 20:32:05 +00004076- CONFIG_CRC32_VERIFY
4077 Add a verify option to the crc32 command.
4078 The syntax is:
4079
4080 => crc32 -v <address> <count> <crc32>
4081
4082 Where address/count indicate a memory area
4083 and crc32 is the correct crc32 which the
4084 area should have.
4085
wdenk64519362004-07-11 17:40:54 +00004086- CONFIG_LOOPW
4087 Add the "loopw" memory command. This only takes effect if
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004088 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk64519362004-07-11 17:40:54 +00004089
stroesecc3af832004-12-16 18:46:55 +00004090- CONFIG_MX_CYCLIC
4091 Add the "mdc" and "mwc" memory commands. These are cyclic
4092 "md/mw" commands.
4093 Examples:
4094
wdenk07d7e6b2004-12-16 21:44:03 +00004095 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00004096 This command will print 4 bytes (10,11,12,13) each 500 ms.
4097
wdenk07d7e6b2004-12-16 21:44:03 +00004098 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00004099 This command will write 12345678 to address 100 all 10 ms.
4100
wdenk07d7e6b2004-12-16 21:44:03 +00004101 This only takes effect if the memory commands are activated
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004102 globally (CONFIG_CMD_MEM).
stroesecc3af832004-12-16 18:46:55 +00004103
wdenk3d3d99f2005-04-04 12:44:11 +00004104- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004105 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk302141d2010-11-27 23:30:56 +01004106 low level initializations (like setting up the memory
4107 controller) are omitted and/or U-Boot does not
4108 relocate itself into RAM.
wdenk3d3d99f2005-04-04 12:44:11 +00004109
Wolfgang Denk302141d2010-11-27 23:30:56 +01004110 Normally this variable MUST NOT be defined. The only
4111 exception is when U-Boot is loaded (to RAM) by some
4112 other boot loader or by a debugger which performs
4113 these initializations itself.
wdenk3d3d99f2005-04-04 12:44:11 +00004114
Simon Glass90844072016-05-05 07:28:06 -06004115- CONFIG_SKIP_LOWLEVEL_INIT_ONLY
4116 [ARM926EJ-S only] This allows just the call to lowlevel_init()
yeongjun Kim7a203682016-07-20 22:56:12 +09004117 to be skipped. The normal CP15 init (such as enabling the
Simon Glass90844072016-05-05 07:28:06 -06004118 instruction cache) is still performed.
4119
Aneesh V552a3192011-07-13 05:11:07 +00004120- CONFIG_SPL_BUILD
Magnus Lilja1ec96d82009-06-13 20:50:00 +02004121 Modifies the behaviour of start.S when compiling a loader
4122 that is executed before the actual U-Boot. E.g. when
4123 compiling a NAND SPL.
wdenk336b2bc2005-04-02 23:52:25 +00004124
Ying Zhang2d2e3b62013-08-16 15:16:15 +08004125- CONFIG_TPL_BUILD
4126 Modifies the behaviour of start.S when compiling a loader
4127 that is executed after the SPL and before the actual U-Boot.
4128 It is loaded by the SPL.
4129
Ying Zhang0d4f5442013-05-20 14:07:23 +08004130- CONFIG_SYS_MPC85XX_NO_RESETVEC
4131 Only for 85xx systems. If this variable is specified, the section
4132 .resetvec is not kept and the section .bootpg is placed in the
4133 previous 4k of the .text section.
4134
Simon Glass17dabf02013-02-24 17:33:14 +00004135- CONFIG_ARCH_MAP_SYSMEM
4136 Generally U-Boot (and in particular the md command) uses
4137 effective address. It is therefore not necessary to regard
4138 U-Boot address as virtual addresses that need to be translated
4139 to physical addresses. However, sandbox requires this, since
4140 it maintains its own little RAM buffer which contains all
4141 addressable memory. This option causes some memory accesses
4142 to be mapped through map_sysmem() / unmap_sysmem().
4143
Simon Glassbfb59802013-02-14 04:18:54 +00004144- CONFIG_X86_RESET_VECTOR
4145 If defined, the x86 reset vector code is included. This is not
4146 needed when U-Boot is running from Coreboot.
Gabe Black14f82462012-11-27 21:08:06 +00004147
Heiko Schocher2233e462013-11-04 14:05:00 +01004148- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
4149 Enables the RTC32K OSC on AM33xx based plattforms
4150
Karicheri, Muralidharanc1dc61b2014-04-04 13:16:50 -04004151- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
4152 Option to disable subpage write in NAND driver
4153 driver that uses this:
4154 drivers/mtd/nand/davinci_nand.c
4155
Timur Tabi275f4bb2011-11-22 09:21:25 -06004156Freescale QE/FMAN Firmware Support:
4157-----------------------------------
4158
4159The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4160loading of "firmware", which is encoded in the QE firmware binary format.
4161This firmware often needs to be loaded during U-Boot booting, so macros
4162are used to identify the storage device (NOR flash, SPI, etc) and the address
4163within that device.
4164
Zhao Qiang83a90842014-03-21 16:21:44 +08004165- CONFIG_SYS_FMAN_FW_ADDR
4166 The address in the storage device where the FMAN microcode is located. The
4167 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4168 is also specified.
4169
4170- CONFIG_SYS_QE_FW_ADDR
4171 The address in the storage device where the QE microcode is located. The
Timur Tabi275f4bb2011-11-22 09:21:25 -06004172 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4173 is also specified.
4174
4175- CONFIG_SYS_QE_FMAN_FW_LENGTH
4176 The maximum possible size of the firmware. The firmware binary format
4177 has a field that specifies the actual size of the firmware, but it
4178 might not be possible to read any part of the firmware unless some
4179 local storage is allocated to hold the entire firmware first.
4180
4181- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4182 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4183 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
4184 virtual address in NOR flash.
4185
4186- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4187 Specifies that QE/FMAN firmware is located in NAND flash.
4188 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4189
4190- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4191 Specifies that QE/FMAN firmware is located on the primary SD/MMC
4192 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4193
Liu Gang1e084582012-03-08 00:33:18 +00004194- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4195 Specifies that QE/FMAN firmware is located in the remote (master)
4196 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gang357bf5a2012-08-09 05:10:01 +00004197 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4198 window->master inbound window->master LAW->the ucode address in
4199 master's memory space.
Timur Tabi275f4bb2011-11-22 09:21:25 -06004200
J. German Rivera8ff14b72014-06-23 15:15:55 -07004201Freescale Layerscape Management Complex Firmware Support:
4202---------------------------------------------------------
4203The Freescale Layerscape Management Complex (MC) supports the loading of
4204"firmware".
4205This firmware often needs to be loaded during U-Boot booting, so macros
4206are used to identify the storage device (NOR flash, SPI, etc) and the address
4207within that device.
4208
4209- CONFIG_FSL_MC_ENET
4210 Enable the MC driver for Layerscape SoCs.
4211
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05304212Freescale Layerscape Debug Server Support:
4213-------------------------------------------
4214The Freescale Layerscape Debug Server Support supports the loading of
4215"Debug Server firmware" and triggering SP boot-rom.
4216This firmware often needs to be loaded during U-Boot booting.
4217
York Sun928b6812015-12-07 11:08:58 -08004218- CONFIG_SYS_MC_RSV_MEM_ALIGN
4219 Define alignment of reserved memory MC requires
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05304220
Paul Kocialkowski7b917022015-07-26 18:48:15 +02004221Reproducible builds
4222-------------------
4223
4224In order to achieve reproducible builds, timestamps used in the U-Boot build
4225process have to be set to a fixed value.
4226
4227This is done using the SOURCE_DATE_EPOCH environment variable.
4228SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
4229option for U-Boot or an environment variable in U-Boot.
4230
4231SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
4232
wdenkc6097192002-11-03 00:24:07 +00004233Building the Software:
4234======================
4235
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004236Building U-Boot has been tested in several native build environments
4237and in many different cross environments. Of course we cannot support
4238all possibly existing versions of cross development tools in all
4239(potentially obsolete) versions. In case of tool chain problems we
4240recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4241which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004242
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004243If you are not using a native environment, it is assumed that you
4244have GNU cross compiling tools available in your path. In this case,
4245you must set the environment variable CROSS_COMPILE in your shell.
4246Note that no changes to the Makefile or any other source files are
4247necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00004248
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004249 $ CROSS_COMPILE=ppc_4xx-
4250 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00004251
Peter Tyserb06976d2009-03-13 18:54:51 -05004252Note: If you wish to generate Windows versions of the utilities in
4253 the tools directory you can use the MinGW toolchain
4254 (http://www.mingw.org). Set your HOST tools to the MinGW
4255 toolchain and execute 'make tools'. For example:
4256
4257 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
4258
4259 Binaries such as tools/mkimage.exe will be created which can
4260 be executed on computers running Windows.
4261
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004262U-Boot is intended to be simple to build. After installing the
4263sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00004264is done by typing:
4265
Holger Freyther7ba4e572014-08-04 09:26:05 +02004266 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00004267
Holger Freyther7ba4e572014-08-04 09:26:05 +02004268where "NAME_defconfig" is the name of one of the existing configu-
Michael Jones5a7fb6f2012-03-15 22:48:10 +00004269rations; see boards.cfg for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00004270
wdenk6c59edc2004-05-03 20:45:30 +00004271Note: for some board special configuration names may exist; check if
4272 additional information is available from the board vendor; for
4273 instance, the TQM823L systems are available without (standard)
4274 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004275 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00004276
Holger Freyther7ba4e572014-08-04 09:26:05 +02004277 make TQM823L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00004278 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00004279
Holger Freyther7ba4e572014-08-04 09:26:05 +02004280 make TQM823L_LCD_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00004281 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00004282
wdenk6c59edc2004-05-03 20:45:30 +00004283 etc.
wdenkc6097192002-11-03 00:24:07 +00004284
wdenkc6097192002-11-03 00:24:07 +00004285
wdenk6c59edc2004-05-03 20:45:30 +00004286Finally, type "make all", and you should get some working U-Boot
4287images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00004288
wdenk6c59edc2004-05-03 20:45:30 +00004289- "u-boot.bin" is a raw binary image
4290- "u-boot" is an image in ELF binary format
4291- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00004292
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004293By default the build is performed locally and the objects are saved
4294in the source directory. One of the two methods can be used to change
4295this behavior and build U-Boot to some external directory:
4296
42971. Add O= to the make command line invocations:
4298
4299 make O=/tmp/build distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02004300 make O=/tmp/build NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004301 make O=/tmp/build all
4302
Timo Ketolac8c67602014-11-06 14:39:05 +020043032. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004304
Timo Ketolac8c67602014-11-06 14:39:05 +02004305 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004306 make distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02004307 make NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004308 make all
4309
Timo Ketolac8c67602014-11-06 14:39:05 +02004310Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004311variable.
4312
wdenkc6097192002-11-03 00:24:07 +00004313
wdenk6c59edc2004-05-03 20:45:30 +00004314Please be aware that the Makefiles assume you are using GNU make, so
4315for instance on NetBSD you might need to use "gmake" instead of
4316native "make".
wdenkc6097192002-11-03 00:24:07 +00004317
wdenkc6097192002-11-03 00:24:07 +00004318
wdenk6c59edc2004-05-03 20:45:30 +00004319If the system board that you have is not listed, then you will need
4320to port U-Boot to your hardware platform. To do this, follow these
4321steps:
wdenkc6097192002-11-03 00:24:07 +00004322
Phil Sutterc77b4882015-12-25 14:41:18 +010043231. Create a new directory to hold your board specific code. Add any
wdenk6c59edc2004-05-03 20:45:30 +00004324 files you need. In your board directory, you will need at least
Phil Sutterc77b4882015-12-25 14:41:18 +01004325 the "Makefile" and a "<board>.c".
43262. Create a new configuration file "include/configs/<board>.h" for
4327 your board.
wdenk6c59edc2004-05-03 20:45:30 +000043283. If you're porting U-Boot to a new CPU, then also create a new
4329 directory to hold your CPU specific code. Add any files you need.
Holger Freyther7ba4e572014-08-04 09:26:05 +020043304. Run "make <board>_defconfig" with your new name.
wdenk6c59edc2004-05-03 20:45:30 +000043315. Type "make", and you should get a working "u-boot.srec" file
4332 to be installed on your target system.
43336. Debug and solve any problems that might arise.
4334 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00004335
wdenkc6097192002-11-03 00:24:07 +00004336
wdenk6c59edc2004-05-03 20:45:30 +00004337Testing of U-Boot Modifications, Ports to New Hardware, etc.:
4338==============================================================
wdenkc6097192002-11-03 00:24:07 +00004339
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004340If you have modified U-Boot sources (for instance added a new board
4341or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00004342provide feedback to the other developers. The feedback normally takes
4343the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004344official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00004345
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004346But before you submit such a patch, please verify that your modifi-
4347cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00004348the supported boards compile WITHOUT ANY compiler warnings. To do so,
Simon Glassdc27def2016-07-27 20:33:08 -06004349just run the buildman script (tools/buildman/buildman), which will
4350configure and build U-Boot for ALL supported system. Be warned, this
4351will take a while. Please see the buildman README, or run 'buildman -H'
4352for documentation.
wdenkc6097192002-11-03 00:24:07 +00004353
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004354
wdenk6c59edc2004-05-03 20:45:30 +00004355See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00004356
wdenkc6097192002-11-03 00:24:07 +00004357
wdenk6c59edc2004-05-03 20:45:30 +00004358Monitor Commands - Overview:
4359============================
wdenkc6097192002-11-03 00:24:07 +00004360
wdenk6c59edc2004-05-03 20:45:30 +00004361go - start application at address 'addr'
4362run - run commands in an environment variable
4363bootm - boot application image from memory
4364bootp - boot image via network using BootP/TFTP protocol
Marek Vasutcf41a9b2012-03-14 21:52:45 +00004365bootz - boot zImage from memory
wdenk6c59edc2004-05-03 20:45:30 +00004366tftpboot- boot image via network using TFTP protocol
4367 and env variables "ipaddr" and "serverip"
4368 (and eventually "gatewayip")
Simon Glass6a398d22011-10-24 18:00:07 +00004369tftpput - upload a file via network using TFTP protocol
wdenk6c59edc2004-05-03 20:45:30 +00004370rarpboot- boot image via network using RARP/TFTP protocol
4371diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
4372loads - load S-Record file over serial line
4373loadb - load binary file over serial line (kermit mode)
4374md - memory display
4375mm - memory modify (auto-incrementing)
4376nm - memory modify (constant address)
4377mw - memory write (fill)
4378cp - memory copy
4379cmp - memory compare
4380crc32 - checksum calculation
Peter Tyser469cde42009-04-18 22:34:03 -05004381i2c - I2C sub-system
wdenk6c59edc2004-05-03 20:45:30 +00004382sspi - SPI utility commands
4383base - print or set address offset
4384printenv- print environment variables
4385setenv - set environment variables
4386saveenv - save environment variables to persistent storage
4387protect - enable or disable FLASH write protection
4388erase - erase FLASH memory
4389flinfo - print FLASH memory information
Karl O. Pinc4baf03d2012-08-03 05:57:21 +00004390nand - NAND memory operations (see doc/README.nand)
wdenk6c59edc2004-05-03 20:45:30 +00004391bdinfo - print Board Info structure
4392iminfo - print header information for application image
4393coninfo - print console devices and informations
4394ide - IDE sub-system
4395loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00004396loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00004397mtest - simple RAM test
4398icache - enable or disable instruction cache
4399dcache - enable or disable data cache
4400reset - Perform RESET of the CPU
4401echo - echo args to console
4402version - print monitor version
4403help - print online help
4404? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00004405
wdenkc6097192002-11-03 00:24:07 +00004406
wdenk6c59edc2004-05-03 20:45:30 +00004407Monitor Commands - Detailed Description:
4408========================================
wdenkc6097192002-11-03 00:24:07 +00004409
wdenk6c59edc2004-05-03 20:45:30 +00004410TODO.
wdenkc6097192002-11-03 00:24:07 +00004411
wdenk6c59edc2004-05-03 20:45:30 +00004412For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00004413
4414
wdenk6c59edc2004-05-03 20:45:30 +00004415Environment Variables:
4416======================
wdenkc6097192002-11-03 00:24:07 +00004417
wdenk6c59edc2004-05-03 20:45:30 +00004418U-Boot supports user configuration using Environment Variables which
4419can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00004420
wdenk6c59edc2004-05-03 20:45:30 +00004421Environment Variables are set using "setenv", printed using
4422"printenv", and saved to Flash using "saveenv". Using "setenv"
4423without a value can be used to delete a variable from the
4424environment. As long as you don't save the environment you are
4425working with an in-memory copy. In case the Flash area containing the
4426environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00004427
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004428Some configuration options can be set using Environment Variables.
4429
4430List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00004431
wdenk6c59edc2004-05-03 20:45:30 +00004432 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00004433
wdenk6c59edc2004-05-03 20:45:30 +00004434 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00004435
wdenk6c59edc2004-05-03 20:45:30 +00004436 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00004437
wdenk6c59edc2004-05-03 20:45:30 +00004438 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00004439
wdenk6c59edc2004-05-03 20:45:30 +00004440 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00004441
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004442 bootm_low - Memory range available for image processing in the bootm
4443 command can be restricted. This variable is given as
4444 a hexadecimal number and defines lowest address allowed
4445 for use by the bootm command. See also "bootm_size"
4446 environment variable. Address defined by "bootm_low" is
4447 also the base of the initial memory mapping for the Linux
Grant Likely26396382011-03-28 09:58:43 +00004448 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4449 bootm_mapsize.
4450
Wolfgang Denk092ae952011-10-26 10:21:21 +00004451 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likely26396382011-03-28 09:58:43 +00004452 This variable is given as a hexadecimal number and it
4453 defines the size of the memory region starting at base
4454 address bootm_low that is accessible by the Linux kernel
4455 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
4456 as the default value if it is defined, and bootm_size is
4457 used otherwise.
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004458
4459 bootm_size - Memory range available for image processing in the bootm
4460 command can be restricted. This variable is given as
4461 a hexadecimal number and defines the size of the region
4462 allowed for use by the bootm command. See also "bootm_low"
4463 environment variable.
4464
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02004465 updatefile - Location of the software update file on a TFTP server, used
4466 by the automatic software update feature. Please refer to
4467 documentation in doc/README.update for more details.
4468
wdenk6c59edc2004-05-03 20:45:30 +00004469 autoload - if set to "no" (any string beginning with 'n'),
4470 "bootp" will just load perform a lookup of the
4471 configuration from the BOOTP server, but not try to
4472 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00004473
wdenk6c59edc2004-05-03 20:45:30 +00004474 autostart - if set to "yes", an image loaded using the "bootp",
4475 "rarpboot", "tftpboot" or "diskboot" commands will
4476 be automatically started (by internally calling
4477 "bootm")
wdenkc6097192002-11-03 00:24:07 +00004478
wdenk6c59edc2004-05-03 20:45:30 +00004479 If set to "no", a standalone image passed to the
4480 "bootm" command will be copied to the load address
4481 (and eventually uncompressed), but NOT be started.
4482 This can be used to load and uncompress arbitrary
4483 data.
wdenkc6097192002-11-03 00:24:07 +00004484
David A. Longd558a4e2011-07-09 16:40:19 -04004485 fdt_high - if set this restricts the maximum address that the
4486 flattened device tree will be copied into upon boot.
Shawn Guo0ca9e982012-01-09 21:54:08 +00004487 For example, if you have a system with 1 GB memory
4488 at physical address 0x10000000, while Linux kernel
4489 only recognizes the first 704 MB as low memory, you
4490 may need to set fdt_high as 0x3C000000 to have the
4491 device tree blob be copied to the maximum address
4492 of the 704 MB low memory, so that Linux kernel can
4493 access it during the boot procedure.
4494
David A. Longd558a4e2011-07-09 16:40:19 -04004495 If this is set to the special value 0xFFFFFFFF then
4496 the fdt will not be copied at all on boot. For this
4497 to work it must reside in writable memory, have
4498 sufficient padding on the end of it for u-boot to
4499 add the information it needs into it, and the memory
4500 must be accessible by the kernel.
4501
Simon Glassdc6fa642011-10-24 19:15:34 +00004502 fdtcontroladdr- if set this is the address of the control flattened
4503 device tree used by U-Boot when CONFIG_OF_CONTROL is
4504 defined.
4505
wdenk0e2bd9c2004-06-06 21:51:03 +00004506 i2cfast - (PPC405GP|PPC405EP only)
4507 if set to 'y' configures Linux I2C driver for fast
4508 mode (400kHZ). This environment variable is used in
4509 initialization code. So, for changes to be effective
4510 it must be saved and board must be reset.
4511
wdenk6c59edc2004-05-03 20:45:30 +00004512 initrd_high - restrict positioning of initrd images:
4513 If this variable is not set, initrd images will be
4514 copied to the highest possible address in RAM; this
4515 is usually what you want since it allows for
4516 maximum initrd size. If for some reason you want to
4517 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004518 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk6c59edc2004-05-03 20:45:30 +00004519 variable to a value of "no" or "off" or "0".
4520 Alternatively, you can set it to a maximum upper
4521 address to use (U-Boot will still check that it
4522 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00004523
wdenk6c59edc2004-05-03 20:45:30 +00004524 For instance, when you have a system with 16 MB
4525 RAM, and want to reserve 4 MB from use by Linux,
4526 you can do this by adding "mem=12M" to the value of
4527 the "bootargs" variable. However, now you must make
4528 sure that the initrd image is placed in the first
4529 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00004530
wdenk6c59edc2004-05-03 20:45:30 +00004531 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00004532
wdenk6c59edc2004-05-03 20:45:30 +00004533 If you set initrd_high to 0xFFFFFFFF, this is an
4534 indication to U-Boot that all addresses are legal
4535 for the Linux kernel, including addresses in flash
4536 memory. In this case U-Boot will NOT COPY the
4537 ramdisk at all. This may be useful to reduce the
4538 boot time on your system, but requires that this
4539 feature is supported by your Linux kernel.
wdenk3f9ab982003-04-12 23:38:12 +00004540
wdenk6c59edc2004-05-03 20:45:30 +00004541 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00004542
wdenk6c59edc2004-05-03 20:45:30 +00004543 loadaddr - Default load address for commands like "bootp",
4544 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00004545
wdenk6c59edc2004-05-03 20:45:30 +00004546 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00004547
wdenk6c59edc2004-05-03 20:45:30 +00004548 serverip - TFTP server IP address; needed for tftpboot command
wdenk6f770ed2003-05-23 23:18:21 +00004549
wdenk6c59edc2004-05-03 20:45:30 +00004550 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00004551
wdenk6c59edc2004-05-03 20:45:30 +00004552 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00004553
wdenk6c59edc2004-05-03 20:45:30 +00004554 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00004555
Mike Frysingera23230c2011-10-02 10:01:27 +00004556 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00004557
Mike Frysingera23230c2011-10-02 10:01:27 +00004558 ethact - controls which interface is currently active.
4559 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00004560
Heiko Schocherc5e84052010-07-20 17:45:02 +02004561 => setenv ethact FEC
4562 => ping 192.168.0.1 # traffic sent on FEC
4563 => setenv ethact SCC
4564 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00004565
Matthias Fuchs204f0ec2008-01-17 07:45:05 +01004566 ethrotate - When set to "no" U-Boot does not go through all
4567 available network interfaces.
4568 It just stays at the currently selected interface.
4569
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004570 netretry - When set to "no" each network operation will
wdenk6c59edc2004-05-03 20:45:30 +00004571 either succeed or fail without retrying.
4572 When set to "once" the network operation will
4573 fail when all the available network interfaces
4574 are tried once without success.
4575 Useful on scripts which control the retry operation
4576 themselves.
wdenkc6097192002-11-03 00:24:07 +00004577
Jean-Christophe PLAGNIOL-VILLARD1948d6c2009-01-31 09:53:39 +01004578 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDd2164ef2008-01-07 08:41:34 +01004579
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004580 silent_linux - If set then Linux will be told to boot silently, by
Simon Glass5db3f932013-07-16 20:10:00 -07004581 changing the console to be empty. If "yes" it will be
4582 made silent. If "no" it will not be made silent. If
4583 unset, then it will be made silent if the U-Boot console
4584 is silent.
4585
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02004586 tftpsrcp - If this is set, the value is used for TFTP's
Wolfgang Denke3cfce52005-09-24 22:37:32 +02004587 UDP source port.
4588
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02004589 tftpdstp - If this is set, the value is used for TFTP's UDP
Wolfgang Denk227b5192005-09-24 23:25:46 +02004590 destination port instead of the Well Know Port 69.
4591
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004592 tftpblocksize - Block size to use for TFTP transfers; if not set,
4593 we use the TFTP server's default block size
4594
4595 tftptimeout - Retransmission timeout for TFTP packets (in milli-
4596 seconds, minimum value is 1000 = 1 second). Defines
4597 when a packet is considered to be lost so it has to
4598 be retransmitted. The default is 5000 = 5 seconds.
4599 Lowering this value may make downloads succeed
4600 faster in networks with high packet loss rates or
4601 with unreliable TFTP servers.
4602
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02004603 tftptimeoutcountmax - maximum count of TFTP timeouts (no
4604 unit, minimum value = 0). Defines how many timeouts
4605 can happen during a single file transfer before that
4606 transfer is aborted. The default is 10, and 0 means
4607 'no timeouts allowed'. Increasing this value may help
4608 downloads succeed with high packet loss rates, or with
4609 unreliable TFTP servers or client hardware.
4610
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004611 vlan - When set to a value < 4095 the traffic over
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004612 Ethernet is encapsulated/received over 802.1q
wdenk6c59edc2004-05-03 20:45:30 +00004613 VLAN tagged frames.
wdenk145d2c12004-04-15 21:48:45 +00004614
Alexandre Messier15971322016-02-01 17:08:57 -05004615 bootpretryperiod - Period during which BOOTP/DHCP sends retries.
4616 Unsigned value, in milliseconds. If not set, the period will
4617 be either the default (28000), or a value based on
4618 CONFIG_NET_RETRY_COUNT, if defined. This value has
4619 precedence over the valu based on CONFIG_NET_RETRY_COUNT.
4620
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004621The following image location variables contain the location of images
4622used in booting. The "Image" column gives the role of the image and is
4623not an environment variable name. The other columns are environment
4624variable names. "File Name" gives the name of the file on a TFTP
4625server, "RAM Address" gives the location in RAM the image will be
4626loaded to, and "Flash Location" gives the image's address in NOR
4627flash or offset in NAND flash.
4628
4629*Note* - these variables don't have to be defined for all boards, some
Fabio Estevambb7d4972015-04-25 18:53:10 -03004630boards currently use other variables for these purposes, and some
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004631boards use these variables for other purposes.
4632
Wolfgang Denk092ae952011-10-26 10:21:21 +00004633Image File Name RAM Address Flash Location
4634----- --------- ----------- --------------
4635u-boot u-boot u-boot_addr_r u-boot_addr
4636Linux kernel bootfile kernel_addr_r kernel_addr
4637device tree blob fdtfile fdt_addr_r fdt_addr
4638ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004639
wdenk6c59edc2004-05-03 20:45:30 +00004640The following environment variables may be used and automatically
4641updated by the network boot commands ("bootp" and "rarpboot"),
4642depending the information provided by your boot server:
wdenk145d2c12004-04-15 21:48:45 +00004643
wdenk6c59edc2004-05-03 20:45:30 +00004644 bootfile - see above
4645 dnsip - IP address of your Domain Name Server
4646 dnsip2 - IP address of your secondary Domain Name Server
4647 gatewayip - IP address of the Gateway (Router) to use
4648 hostname - Target hostname
4649 ipaddr - see above
4650 netmask - Subnet Mask
4651 rootpath - Pathname of the root filesystem on the NFS server
4652 serverip - see above
wdenk145d2c12004-04-15 21:48:45 +00004653
wdenk145d2c12004-04-15 21:48:45 +00004654
wdenk6c59edc2004-05-03 20:45:30 +00004655There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004656
wdenk6c59edc2004-05-03 20:45:30 +00004657 serial# - contains hardware identification information such
4658 as type string and/or serial number
4659 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00004660
wdenk6c59edc2004-05-03 20:45:30 +00004661These variables can be set only once (usually during manufacturing of
4662the board). U-Boot refuses to delete or overwrite these variables
4663once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00004664
4665
wdenk6c59edc2004-05-03 20:45:30 +00004666Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004667
wdenk6c59edc2004-05-03 20:45:30 +00004668 ver - Contains the U-Boot version string as printed
4669 with the "version" command. This variable is
4670 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00004671
wdenkc6097192002-11-03 00:24:07 +00004672
wdenk6c59edc2004-05-03 20:45:30 +00004673Please note that changes to some configuration parameters may take
4674only effect after the next boot (yes, that's just like Windoze :-).
stroeseb9c17c52003-04-04 15:53:41 +00004675
stroeseb9c17c52003-04-04 15:53:41 +00004676
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004677Callback functions for environment variables:
4678---------------------------------------------
4679
4680For some environment variables, the behavior of u-boot needs to change
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004681when their values are changed. This functionality allows functions to
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004682be associated with arbitrary variables. On creation, overwrite, or
4683deletion, the callback will provide the opportunity for some side
4684effect to happen or for the change to be rejected.
4685
4686The callbacks are named and associated with a function using the
4687U_BOOT_ENV_CALLBACK macro in your board or driver code.
4688
4689These callbacks are associated with variables in one of two ways. The
4690static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4691in the board configuration to a string that defines a list of
4692associations. The list must be in the following format:
4693
4694 entry = variable_name[:callback_name]
4695 list = entry[,list]
4696
4697If the callback name is not specified, then the callback is deleted.
4698Spaces are also allowed anywhere in the list.
4699
4700Callbacks can also be associated by defining the ".callbacks" variable
4701with the same list format above. Any association in ".callbacks" will
4702override any association in the static list. You can define
4703CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004704".callbacks" environment variable in the default or embedded environment.
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004705
Joe Hershberger6db9fd42015-05-20 14:27:20 -05004706If CONFIG_REGEX is defined, the variable_name above is evaluated as a
4707regular expression. This allows multiple variables to be connected to
4708the same callback without explicitly listing them all out.
4709
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004710
wdenk6c59edc2004-05-03 20:45:30 +00004711Command Line Parsing:
4712=====================
stroeseb9c17c52003-04-04 15:53:41 +00004713
wdenk6c59edc2004-05-03 20:45:30 +00004714There are two different command line parsers available with U-Boot:
4715the old "simple" one, and the much more powerful "hush" shell:
wdenkc6097192002-11-03 00:24:07 +00004716
wdenk6c59edc2004-05-03 20:45:30 +00004717Old, simple command line parser:
4718--------------------------------
wdenkc6097192002-11-03 00:24:07 +00004719
wdenk6c59edc2004-05-03 20:45:30 +00004720- supports environment variables (through setenv / saveenv commands)
4721- several commands on one line, separated by ';'
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01004722- variable substitution using "... ${name} ..." syntax
wdenk6c59edc2004-05-03 20:45:30 +00004723- special characters ('$', ';') can be escaped by prefixing with '\',
4724 for example:
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01004725 setenv bootcmd bootm \${address}
wdenk6c59edc2004-05-03 20:45:30 +00004726- You can also escape text by enclosing in single apostrophes, for example:
4727 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00004728
wdenk6c59edc2004-05-03 20:45:30 +00004729Hush shell:
4730-----------
wdenkf4688a22003-05-28 08:06:31 +00004731
wdenk6c59edc2004-05-03 20:45:30 +00004732- similar to Bourne shell, with control structures like
4733 if...then...else...fi, for...do...done; while...do...done,
4734 until...do...done, ...
4735- supports environment ("global") variables (through setenv / saveenv
4736 commands) and local shell variables (through standard shell syntax
4737 "name=value"); only environment variables can be used with "run"
4738 command
wdenkf4688a22003-05-28 08:06:31 +00004739
wdenk6c59edc2004-05-03 20:45:30 +00004740General rules:
4741--------------
wdenkf4688a22003-05-28 08:06:31 +00004742
wdenk6c59edc2004-05-03 20:45:30 +00004743(1) If a command line (or an environment variable executed by a "run"
4744 command) contains several commands separated by semicolon, and
4745 one of these commands fails, then the remaining commands will be
4746 executed anyway.
wdenkf4688a22003-05-28 08:06:31 +00004747
wdenk6c59edc2004-05-03 20:45:30 +00004748(2) If you execute several variables with one call to run (i. e.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004749 calling run with a list of variables as arguments), any failing
wdenk6c59edc2004-05-03 20:45:30 +00004750 command will cause "run" to terminate, i. e. the remaining
4751 variables are not executed.
wdenkf4688a22003-05-28 08:06:31 +00004752
wdenk6c59edc2004-05-03 20:45:30 +00004753Note for Redundant Ethernet Interfaces:
4754=======================================
wdenkf4688a22003-05-28 08:06:31 +00004755
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004756Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00004757such configurations and is capable of automatic selection of a
4758"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00004759
wdenk6c59edc2004-05-03 20:45:30 +00004760Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
4761MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4762"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00004763
wdenk6c59edc2004-05-03 20:45:30 +00004764If the network interface stores some valid MAC address (for instance
4765in SROM), this is used as default address if there is NO correspon-
4766ding setting in the environment; if the corresponding environment
4767variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00004768
wdenk6c59edc2004-05-03 20:45:30 +00004769o If the SROM has a valid MAC address, and there is no address in the
4770 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00004771
wdenk6c59edc2004-05-03 20:45:30 +00004772o If there is no valid address in the SROM, and a definition in the
4773 environment exists, then the value from the environment variable is
4774 used.
wdenkc6097192002-11-03 00:24:07 +00004775
wdenk6c59edc2004-05-03 20:45:30 +00004776o If both the SROM and the environment contain a MAC address, and
4777 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00004778
wdenk6c59edc2004-05-03 20:45:30 +00004779o If both the SROM and the environment contain a MAC address, and the
4780 addresses differ, the value from the environment is used and a
4781 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00004782
wdenk6c59edc2004-05-03 20:45:30 +00004783o If neither SROM nor the environment contain a MAC address, an error
Joe Hershberger2dc2b5d2015-05-04 14:55:13 -05004784 is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
4785 a random, locally-assigned MAC is used.
wdenkc6097192002-11-03 00:24:07 +00004786
Ben Warren6db991a2010-04-26 11:11:46 -07004787If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denk092ae952011-10-26 10:21:21 +00004788will be programmed into hardware as part of the initialization process. This
Ben Warren6db991a2010-04-26 11:11:46 -07004789may be skipped by setting the appropriate 'ethmacskip' environment variable.
4790The naming convention is as follows:
4791"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00004792
wdenk6c59edc2004-05-03 20:45:30 +00004793Image Formats:
4794==============
wdenkc6097192002-11-03 00:24:07 +00004795
Marian Balakowicz18710b82008-03-12 12:13:13 +01004796U-Boot is capable of booting (and performing other auxiliary operations on)
4797images in two formats:
4798
4799New uImage format (FIT)
4800-----------------------
4801
4802Flexible and powerful format based on Flattened Image Tree -- FIT (similar
4803to Flattened Device Tree). It allows the use of images with multiple
4804components (several kernels, ramdisks, etc.), with contents protected by
4805SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
4806
4807
4808Old uImage format
4809-----------------
4810
4811Old image format is based on binary files which can be basically anything,
4812preceded by a special header; see the definitions in include/image.h for
4813details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00004814
wdenk6c59edc2004-05-03 20:45:30 +00004815* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4816 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05004817 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4818 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4819 INTEGRITY).
Wolfgang Denk83c15852006-10-24 14:21:16 +02004820* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004821 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
4822 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00004823* Compression Type (uncompressed, gzip, bzip2)
4824* Load Address
4825* Entry Point
4826* Image Name
4827* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00004828
wdenk6c59edc2004-05-03 20:45:30 +00004829The header is marked by a special Magic Number, and both the header
4830and the data portions of the image are secured against corruption by
4831CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00004832
wdenkc6097192002-11-03 00:24:07 +00004833
wdenk6c59edc2004-05-03 20:45:30 +00004834Linux Support:
4835==============
wdenkc6097192002-11-03 00:24:07 +00004836
wdenk6c59edc2004-05-03 20:45:30 +00004837Although U-Boot should support any OS or standalone application
4838easily, the main focus has always been on Linux during the design of
4839U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004840
wdenk6c59edc2004-05-03 20:45:30 +00004841U-Boot includes many features that so far have been part of some
4842special "boot loader" code within the Linux kernel. Also, any
4843"initrd" images to be used are no longer part of one big Linux image;
4844instead, kernel and "initrd" are separate images. This implementation
4845serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00004846
wdenk6c59edc2004-05-03 20:45:30 +00004847- the same features can be used for other OS or standalone
4848 applications (for instance: using compressed images to reduce the
4849 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00004850
wdenk6c59edc2004-05-03 20:45:30 +00004851- it becomes much easier to port new Linux kernel versions because
4852 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00004853
wdenk6c59edc2004-05-03 20:45:30 +00004854- the same Linux kernel image can now be used with different "initrd"
4855 images; of course this also means that different kernel images can
4856 be run with the same "initrd". This makes testing easier (you don't
4857 have to build a new "zImage.initrd" Linux image when you just
4858 change a file in your "initrd"). Also, a field-upgrade of the
4859 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00004860
wdenkc6097192002-11-03 00:24:07 +00004861
wdenk6c59edc2004-05-03 20:45:30 +00004862Linux HOWTO:
4863============
wdenkc6097192002-11-03 00:24:07 +00004864
wdenk6c59edc2004-05-03 20:45:30 +00004865Porting Linux to U-Boot based systems:
4866---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004867
wdenk6c59edc2004-05-03 20:45:30 +00004868U-Boot cannot save you from doing all the necessary modifications to
4869configure the Linux device drivers for use with your target hardware
4870(no, we don't intend to provide a full virtual machine interface to
4871Linux :-).
wdenkc6097192002-11-03 00:24:07 +00004872
Stefan Roese88fbf932010-04-15 16:07:28 +02004873But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00004874
wdenk6c59edc2004-05-03 20:45:30 +00004875Just make sure your machine specific header file (for instance
4876include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02004877Information structure as we define in include/asm-<arch>/u-boot.h,
4878and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004879as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00004880
Simon Glassd097e592014-06-11 23:29:46 -06004881Note that U-Boot now has a driver model, a unified model for drivers.
4882If you are adding a new driver, plumb it into driver model. If there
4883is no uclass available, you are encouraged to create one. See
4884doc/driver-model.
4885
wdenkc6097192002-11-03 00:24:07 +00004886
wdenk6c59edc2004-05-03 20:45:30 +00004887Configuring the Linux kernel:
4888-----------------------------
wdenkc6097192002-11-03 00:24:07 +00004889
wdenk6c59edc2004-05-03 20:45:30 +00004890No specific requirements for U-Boot. Make sure you have some root
4891device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00004892
wdenkc6097192002-11-03 00:24:07 +00004893
wdenk6c59edc2004-05-03 20:45:30 +00004894Building a Linux Image:
4895-----------------------
wdenkc6097192002-11-03 00:24:07 +00004896
wdenk6c59edc2004-05-03 20:45:30 +00004897With U-Boot, "normal" build targets like "zImage" or "bzImage" are
4898not used. If you use recent kernel source, a new build target
4899"uImage" will exist which automatically builds an image usable by
4900U-Boot. Most older kernels also have support for a "pImage" target,
4901which was introduced for our predecessor project PPCBoot and uses a
4902100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00004903
wdenk6c59edc2004-05-03 20:45:30 +00004904Example:
wdenkc6097192002-11-03 00:24:07 +00004905
Holger Freyther7ba4e572014-08-04 09:26:05 +02004906 make TQM850L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00004907 make oldconfig
4908 make dep
4909 make uImage
wdenkc6097192002-11-03 00:24:07 +00004910
wdenk6c59edc2004-05-03 20:45:30 +00004911The "uImage" build target uses a special tool (in 'tools/mkimage') to
4912encapsulate a compressed Linux kernel image with header information,
4913CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00004914
wdenk6c59edc2004-05-03 20:45:30 +00004915* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00004916
wdenk6c59edc2004-05-03 20:45:30 +00004917* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00004918
wdenk6c59edc2004-05-03 20:45:30 +00004919 ${CROSS_COMPILE}-objcopy -O binary \
4920 -R .note -R .comment \
4921 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00004922
wdenk6c59edc2004-05-03 20:45:30 +00004923* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00004924
wdenk6c59edc2004-05-03 20:45:30 +00004925 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00004926
wdenk6c59edc2004-05-03 20:45:30 +00004927* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00004928
wdenk6c59edc2004-05-03 20:45:30 +00004929 mkimage -A ppc -O linux -T kernel -C gzip \
4930 -a 0 -e 0 -n "Linux Kernel Image" \
4931 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00004932
wdenkc6097192002-11-03 00:24:07 +00004933
wdenk6c59edc2004-05-03 20:45:30 +00004934The "mkimage" tool can also be used to create ramdisk images for use
4935with U-Boot, either separated from the Linux kernel image, or
4936combined into one file. "mkimage" encapsulates the images with a 64
4937byte header containing information about target architecture,
4938operating system, image type, compression method, entry points, time
4939stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00004940
wdenk6c59edc2004-05-03 20:45:30 +00004941"mkimage" can be called in two ways: to verify existing images and
4942print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00004943
wdenk6c59edc2004-05-03 20:45:30 +00004944In the first form (with "-l" option) mkimage lists the information
4945contained in the header of an existing U-Boot image; this includes
4946checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00004947
wdenk6c59edc2004-05-03 20:45:30 +00004948 tools/mkimage -l image
4949 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00004950
wdenk6c59edc2004-05-03 20:45:30 +00004951The second form (with "-d" option) is used to build a U-Boot image
4952from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00004953
wdenk6c59edc2004-05-03 20:45:30 +00004954 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4955 -n name -d data_file image
4956 -A ==> set architecture to 'arch'
4957 -O ==> set operating system to 'os'
4958 -T ==> set image type to 'type'
4959 -C ==> set compression type 'comp'
4960 -a ==> set load address to 'addr' (hex)
4961 -e ==> set entry point to 'ep' (hex)
4962 -n ==> set image name to 'name'
4963 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00004964
wdenkcd914452004-05-29 16:53:29 +00004965Right now, all Linux kernels for PowerPC systems use the same load
4966address (0x00000000), but the entry point address depends on the
4967kernel version:
wdenkc6097192002-11-03 00:24:07 +00004968
wdenk6c59edc2004-05-03 20:45:30 +00004969- 2.2.x kernels have the entry point at 0x0000000C,
4970- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00004971
wdenk6c59edc2004-05-03 20:45:30 +00004972So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00004973
wdenk6c59edc2004-05-03 20:45:30 +00004974 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4975 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02004976 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk6c59edc2004-05-03 20:45:30 +00004977 > examples/uImage.TQM850L
4978 Image Name: 2.4.4 kernel for TQM850L
4979 Created: Wed Jul 19 02:34:59 2000
4980 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4981 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4982 Load Address: 0x00000000
4983 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004984
wdenk6c59edc2004-05-03 20:45:30 +00004985To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00004986
wdenk6c59edc2004-05-03 20:45:30 +00004987 -> tools/mkimage -l examples/uImage.TQM850L
4988 Image Name: 2.4.4 kernel for TQM850L
4989 Created: Wed Jul 19 02:34:59 2000
4990 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4991 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4992 Load Address: 0x00000000
4993 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004994
wdenk6c59edc2004-05-03 20:45:30 +00004995NOTE: for embedded systems where boot time is critical you can trade
4996speed for memory and install an UNCOMPRESSED image instead: this
4997needs more space in Flash, but boots much faster since it does not
4998need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00004999
Stefan Roese88fbf932010-04-15 16:07:28 +02005000 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk6c59edc2004-05-03 20:45:30 +00005001 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5002 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005003 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk6c59edc2004-05-03 20:45:30 +00005004 > examples/uImage.TQM850L-uncompressed
5005 Image Name: 2.4.4 kernel for TQM850L
5006 Created: Wed Jul 19 02:34:59 2000
5007 Image Type: PowerPC Linux Kernel Image (uncompressed)
5008 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5009 Load Address: 0x00000000
5010 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005011
wdenkc6097192002-11-03 00:24:07 +00005012
wdenk6c59edc2004-05-03 20:45:30 +00005013Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5014when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00005015
wdenk6c59edc2004-05-03 20:45:30 +00005016 -> tools/mkimage -n 'Simple Ramdisk Image' \
5017 > -A ppc -O linux -T ramdisk -C gzip \
5018 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5019 Image Name: Simple Ramdisk Image
5020 Created: Wed Jan 12 14:01:50 2000
5021 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5022 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5023 Load Address: 0x00000000
5024 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005025
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07005026The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5027option performs the converse operation of the mkimage's second form (the "-d"
5028option). Given an image built by mkimage, the dumpimage extracts a "data file"
5029from the image:
5030
Guilherme Maciel Ferreira40bf5632015-01-15 02:54:40 -02005031 tools/dumpimage -i image -T type -p position data_file
5032 -i ==> extract from the 'image' a specific 'data_file'
5033 -T ==> set image type to 'type'
5034 -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07005035
wdenkc6097192002-11-03 00:24:07 +00005036
wdenk6c59edc2004-05-03 20:45:30 +00005037Installing a Linux Image:
5038-------------------------
wdenkc6097192002-11-03 00:24:07 +00005039
wdenk6c59edc2004-05-03 20:45:30 +00005040To downloading a U-Boot image over the serial (console) interface,
5041you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00005042
wdenk6c59edc2004-05-03 20:45:30 +00005043 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00005044
wdenk6c59edc2004-05-03 20:45:30 +00005045The 'objcopy' does not understand the information in the U-Boot
5046image header, so the resulting S-Record file will be relative to
5047address 0x00000000. To load it to a given address, you need to
5048specify the target address as 'offset' parameter with the 'loads'
5049command.
wdenkc6097192002-11-03 00:24:07 +00005050
wdenk6c59edc2004-05-03 20:45:30 +00005051Example: install the image to address 0x40100000 (which on the
5052TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00005053
wdenk6c59edc2004-05-03 20:45:30 +00005054 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00005055
wdenk6c59edc2004-05-03 20:45:30 +00005056 .......... done
5057 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00005058
wdenk6c59edc2004-05-03 20:45:30 +00005059 => loads 40100000
5060 ## Ready for S-Record download ...
5061 ~>examples/image.srec
5062 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5063 ...
5064 15989 15990 15991 15992
5065 [file transfer complete]
5066 [connected]
5067 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005068
wdenkc6097192002-11-03 00:24:07 +00005069
wdenk6c59edc2004-05-03 20:45:30 +00005070You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005071this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00005072corruption happened:
wdenkc6097192002-11-03 00:24:07 +00005073
wdenk6c59edc2004-05-03 20:45:30 +00005074 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00005075
wdenk6c59edc2004-05-03 20:45:30 +00005076 ## Checking Image at 40100000 ...
5077 Image Name: 2.2.13 for initrd on TQM850L
5078 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5079 Data Size: 335725 Bytes = 327 kB = 0 MB
5080 Load Address: 00000000
5081 Entry Point: 0000000c
5082 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005083
5084
wdenk6c59edc2004-05-03 20:45:30 +00005085Boot Linux:
5086-----------
wdenkc6097192002-11-03 00:24:07 +00005087
wdenk6c59edc2004-05-03 20:45:30 +00005088The "bootm" command is used to boot an application that is stored in
5089memory (RAM or Flash). In case of a Linux kernel image, the contents
5090of the "bootargs" environment variable is passed to the kernel as
5091parameters. You can check and modify this variable using the
5092"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00005093
wdenkc6097192002-11-03 00:24:07 +00005094
wdenk6c59edc2004-05-03 20:45:30 +00005095 => printenv bootargs
5096 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00005097
wdenk6c59edc2004-05-03 20:45:30 +00005098 => 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 +00005099
wdenk6c59edc2004-05-03 20:45:30 +00005100 => printenv bootargs
5101 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 +00005102
wdenk6c59edc2004-05-03 20:45:30 +00005103 => bootm 40020000
5104 ## Booting Linux kernel at 40020000 ...
5105 Image Name: 2.2.13 for NFS on TQM850L
5106 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5107 Data Size: 381681 Bytes = 372 kB = 0 MB
5108 Load Address: 00000000
5109 Entry Point: 0000000c
5110 Verifying Checksum ... OK
5111 Uncompressing Kernel Image ... OK
5112 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
5113 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5114 time_init: decrementer frequency = 187500000/60
5115 Calibrating delay loop... 49.77 BogoMIPS
5116 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5117 ...
wdenkc6097192002-11-03 00:24:07 +00005118
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005119If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00005120the memory addresses of both the kernel and the initrd image (PPBCOOT
5121format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00005122
wdenk6c59edc2004-05-03 20:45:30 +00005123 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00005124
wdenk6c59edc2004-05-03 20:45:30 +00005125 ## Checking Image at 40100000 ...
5126 Image Name: 2.2.13 for initrd on TQM850L
5127 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5128 Data Size: 335725 Bytes = 327 kB = 0 MB
5129 Load Address: 00000000
5130 Entry Point: 0000000c
5131 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005132
wdenk6c59edc2004-05-03 20:45:30 +00005133 ## Checking Image at 40200000 ...
5134 Image Name: Simple Ramdisk Image
5135 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5136 Data Size: 566530 Bytes = 553 kB = 0 MB
5137 Load Address: 00000000
5138 Entry Point: 00000000
5139 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005140
wdenk6c59edc2004-05-03 20:45:30 +00005141 => bootm 40100000 40200000
5142 ## Booting Linux kernel at 40100000 ...
5143 Image Name: 2.2.13 for initrd on TQM850L
5144 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5145 Data Size: 335725 Bytes = 327 kB = 0 MB
5146 Load Address: 00000000
5147 Entry Point: 0000000c
5148 Verifying Checksum ... OK
5149 Uncompressing Kernel Image ... OK
5150 ## Loading RAMDisk Image at 40200000 ...
5151 Image Name: Simple Ramdisk Image
5152 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5153 Data Size: 566530 Bytes = 553 kB = 0 MB
5154 Load Address: 00000000
5155 Entry Point: 00000000
5156 Verifying Checksum ... OK
5157 Loading Ramdisk ... OK
5158 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
5159 Boot arguments: root=/dev/ram
5160 time_init: decrementer frequency = 187500000/60
5161 Calibrating delay loop... 49.77 BogoMIPS
5162 ...
5163 RAMDISK: Compressed image found at block 0
5164 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00005165
wdenk6c59edc2004-05-03 20:45:30 +00005166 bash#
wdenkc6097192002-11-03 00:24:07 +00005167
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005168Boot Linux and pass a flat device tree:
5169-----------
5170
5171First, U-Boot must be compiled with the appropriate defines. See the section
5172titled "Linux Kernel Interface" above for a more in depth explanation. The
5173following is an example of how to start a kernel and pass an updated
5174flat device tree:
5175
5176=> print oftaddr
5177oftaddr=0x300000
5178=> print oft
5179oft=oftrees/mpc8540ads.dtb
5180=> tftp $oftaddr $oft
5181Speed: 1000, full duplex
5182Using TSEC0 device
5183TFTP from server 192.168.1.1; our IP address is 192.168.1.101
5184Filename 'oftrees/mpc8540ads.dtb'.
5185Load address: 0x300000
5186Loading: #
5187done
5188Bytes transferred = 4106 (100a hex)
5189=> tftp $loadaddr $bootfile
5190Speed: 1000, full duplex
5191Using TSEC0 device
5192TFTP from server 192.168.1.1; our IP address is 192.168.1.2
5193Filename 'uImage'.
5194Load address: 0x200000
5195Loading:############
5196done
5197Bytes transferred = 1029407 (fb51f hex)
5198=> print loadaddr
5199loadaddr=200000
5200=> print oftaddr
5201oftaddr=0x300000
5202=> bootm $loadaddr - $oftaddr
5203## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01005204 Image Name: Linux-2.6.17-dirty
5205 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5206 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005207 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01005208 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005209 Verifying Checksum ... OK
5210 Uncompressing Kernel Image ... OK
5211Booting using flat device tree at 0x300000
5212Using MPC85xx ADS machine description
5213Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
5214[snip]
5215
5216
wdenk6c59edc2004-05-03 20:45:30 +00005217More About U-Boot Image Types:
5218------------------------------
wdenkc6097192002-11-03 00:24:07 +00005219
wdenk6c59edc2004-05-03 20:45:30 +00005220U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00005221
wdenk6c59edc2004-05-03 20:45:30 +00005222 "Standalone Programs" are directly runnable in the environment
5223 provided by U-Boot; it is expected that (if they behave
5224 well) you can continue to work in U-Boot after return from
5225 the Standalone Program.
5226 "OS Kernel Images" are usually images of some Embedded OS which
5227 will take over control completely. Usually these programs
5228 will install their own set of exception handlers, device
5229 drivers, set up the MMU, etc. - this means, that you cannot
5230 expect to re-enter U-Boot except by resetting the CPU.
5231 "RAMDisk Images" are more or less just data blocks, and their
5232 parameters (address, size) are passed to an OS kernel that is
5233 being started.
5234 "Multi-File Images" contain several images, typically an OS
5235 (Linux) kernel image and one or more data images like
5236 RAMDisks. This construct is useful for instance when you want
5237 to boot over the network using BOOTP etc., where the boot
5238 server provides just a single image file, but you want to get
5239 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00005240
wdenk6c59edc2004-05-03 20:45:30 +00005241 "Multi-File Images" start with a list of image sizes, each
5242 image size (in bytes) specified by an "uint32_t" in network
5243 byte order. This list is terminated by an "(uint32_t)0".
5244 Immediately after the terminating 0 follow the images, one by
5245 one, all aligned on "uint32_t" boundaries (size rounded up to
5246 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00005247
wdenk6c59edc2004-05-03 20:45:30 +00005248 "Firmware Images" are binary images containing firmware (like
5249 U-Boot or FPGA images) which usually will be programmed to
5250 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00005251
wdenk6c59edc2004-05-03 20:45:30 +00005252 "Script files" are command sequences that will be executed by
5253 U-Boot's command interpreter; this feature is especially
5254 useful when you configure U-Boot to use a real shell (hush)
5255 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00005256
Marek Vasutcf41a9b2012-03-14 21:52:45 +00005257Booting the Linux zImage:
5258-------------------------
5259
5260On some platforms, it's possible to boot Linux zImage. This is done
5261using the "bootz" command. The syntax of "bootz" command is the same
5262as the syntax of "bootm" command.
5263
Tom Rini45f46d12013-05-16 11:40:11 -04005264Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut28850d02012-03-18 11:47:58 +00005265kernel with raw initrd images. The syntax is slightly different, the
5266address of the initrd must be augmented by it's size, in the following
5267format: "<initrd addres>:<initrd size>".
5268
stroeseb9c17c52003-04-04 15:53:41 +00005269
wdenk6c59edc2004-05-03 20:45:30 +00005270Standalone HOWTO:
5271=================
stroeseb9c17c52003-04-04 15:53:41 +00005272
wdenk6c59edc2004-05-03 20:45:30 +00005273One of the features of U-Boot is that you can dynamically load and
5274run "standalone" applications, which can use some resources of
5275U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00005276
wdenk6c59edc2004-05-03 20:45:30 +00005277Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00005278
wdenk6c59edc2004-05-03 20:45:30 +00005279"Hello World" Demo:
5280-------------------
wdenkc6097192002-11-03 00:24:07 +00005281
wdenk6c59edc2004-05-03 20:45:30 +00005282'examples/hello_world.c' contains a small "Hello World" Demo
5283application; it is automatically compiled when you build U-Boot.
5284It's configured to run at address 0x00040004, so you can play with it
5285like that:
wdenkc6097192002-11-03 00:24:07 +00005286
wdenk6c59edc2004-05-03 20:45:30 +00005287 => loads
5288 ## Ready for S-Record download ...
5289 ~>examples/hello_world.srec
5290 1 2 3 4 5 6 7 8 9 10 11 ...
5291 [file transfer complete]
5292 [connected]
5293 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005294
wdenk6c59edc2004-05-03 20:45:30 +00005295 => go 40004 Hello World! This is a test.
5296 ## Starting application at 0x00040004 ...
5297 Hello World
5298 argc = 7
5299 argv[0] = "40004"
5300 argv[1] = "Hello"
5301 argv[2] = "World!"
5302 argv[3] = "This"
5303 argv[4] = "is"
5304 argv[5] = "a"
5305 argv[6] = "test."
5306 argv[7] = "<NULL>"
5307 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00005308
wdenk6c59edc2004-05-03 20:45:30 +00005309 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005310
wdenk6c59edc2004-05-03 20:45:30 +00005311Another example, which demonstrates how to register a CPM interrupt
5312handler with the U-Boot code, can be found in 'examples/timer.c'.
5313Here, a CPM timer is set up to generate an interrupt every second.
5314The interrupt service routine is trivial, just printing a '.'
5315character, but this is just a demo program. The application can be
5316controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00005317
wdenk6c59edc2004-05-03 20:45:30 +00005318 ? - print current values og the CPM Timer registers
5319 b - enable interrupts and start timer
5320 e - stop timer and disable interrupts
5321 q - quit application
wdenkc6097192002-11-03 00:24:07 +00005322
wdenk6c59edc2004-05-03 20:45:30 +00005323 => loads
5324 ## Ready for S-Record download ...
5325 ~>examples/timer.srec
5326 1 2 3 4 5 6 7 8 9 10 11 ...
5327 [file transfer complete]
5328 [connected]
5329 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005330
wdenk6c59edc2004-05-03 20:45:30 +00005331 => go 40004
5332 ## Starting application at 0x00040004 ...
5333 TIMERS=0xfff00980
5334 Using timer 1
5335 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00005336
wdenk6c59edc2004-05-03 20:45:30 +00005337Hit 'b':
5338 [q, b, e, ?] Set interval 1000000 us
5339 Enabling timer
5340Hit '?':
5341 [q, b, e, ?] ........
5342 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5343Hit '?':
5344 [q, b, e, ?] .
5345 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5346Hit '?':
5347 [q, b, e, ?] .
5348 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5349Hit '?':
5350 [q, b, e, ?] .
5351 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5352Hit 'e':
5353 [q, b, e, ?] ...Stopping timer
5354Hit 'q':
5355 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005356
wdenkc6097192002-11-03 00:24:07 +00005357
wdenk6c59edc2004-05-03 20:45:30 +00005358Minicom warning:
5359================
wdenkc6097192002-11-03 00:24:07 +00005360
wdenk6c59edc2004-05-03 20:45:30 +00005361Over time, many people have reported problems when trying to use the
5362"minicom" terminal emulation program for serial download. I (wd)
5363consider minicom to be broken, and recommend not to use it. Under
5364Unix, I recommend to use C-Kermit for general purpose use (and
5365especially for kermit binary protocol download ("loadb" command), and
Karl O. Pinca0189bb2012-10-01 05:11:56 +00005366use "cu" for S-Record download ("loads" command). See
5367http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5368for help with kermit.
5369
wdenkc6097192002-11-03 00:24:07 +00005370
wdenk6c59edc2004-05-03 20:45:30 +00005371Nevertheless, if you absolutely want to use it try adding this
5372configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00005373
wdenk6c59edc2004-05-03 20:45:30 +00005374 Name Program Name U/D FullScr IO-Red. Multi
5375 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
5376 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00005377
wdenk8dba0502003-03-31 16:34:49 +00005378
wdenk6c59edc2004-05-03 20:45:30 +00005379NetBSD Notes:
5380=============
wdenkc6097192002-11-03 00:24:07 +00005381
wdenk6c59edc2004-05-03 20:45:30 +00005382Starting at version 0.9.2, U-Boot supports NetBSD both as host
5383(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00005384
wdenk6c59edc2004-05-03 20:45:30 +00005385Building requires a cross environment; it is known to work on
5386NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5387need gmake since the Makefiles are not compatible with BSD make).
5388Note that the cross-powerpc package does not install include files;
5389attempting to build U-Boot will fail because <machine/ansi.h> is
5390missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00005391
wdenk6c59edc2004-05-03 20:45:30 +00005392 # cd /usr/pkg/cross/powerpc-netbsd/include
5393 # mkdir powerpc
5394 # ln -s powerpc machine
5395 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5396 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00005397
wdenk6c59edc2004-05-03 20:45:30 +00005398Native builds *don't* work due to incompatibilities between native
5399and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00005400
wdenk6c59edc2004-05-03 20:45:30 +00005401Booting assumes that (the first part of) the image booted is a
5402stage-2 loader which in turn loads and then invokes the kernel
5403proper. Loader sources will eventually appear in the NetBSD source
5404tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00005405meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00005406
wdenkc6097192002-11-03 00:24:07 +00005407
wdenk6c59edc2004-05-03 20:45:30 +00005408Implementation Internals:
5409=========================
wdenkc6097192002-11-03 00:24:07 +00005410
wdenk6c59edc2004-05-03 20:45:30 +00005411The following is not intended to be a complete description of every
5412implementation detail. However, it should help to understand the
5413inner workings of U-Boot and make it easier to port it to custom
5414hardware.
wdenkc6097192002-11-03 00:24:07 +00005415
wdenkc6097192002-11-03 00:24:07 +00005416
wdenk6c59edc2004-05-03 20:45:30 +00005417Initial Stack, Global Data:
5418---------------------------
wdenkc6097192002-11-03 00:24:07 +00005419
wdenk6c59edc2004-05-03 20:45:30 +00005420The implementation of U-Boot is complicated by the fact that U-Boot
5421starts running out of ROM (flash memory), usually without access to
5422system RAM (because the memory controller is not initialized yet).
5423This means that we don't have writable Data or BSS segments, and BSS
5424is not initialized as zero. To be able to get a C environment working
5425at all, we have to allocate at least a minimal stack. Implementation
5426options for this are defined and restricted by the CPU used: Some CPU
5427models provide on-chip memory (like the IMMR area on MPC8xx and
5428MPC826x processors), on others (parts of) the data cache can be
5429locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00005430
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005431 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005432 U-Boot mailing list:
wdenkc6097192002-11-03 00:24:07 +00005433
wdenk6c59edc2004-05-03 20:45:30 +00005434 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
5435 From: "Chris Hallinan" <clh@net1plus.com>
5436 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
5437 ...
wdenkc6097192002-11-03 00:24:07 +00005438
wdenk6c59edc2004-05-03 20:45:30 +00005439 Correct me if I'm wrong, folks, but the way I understand it
5440 is this: Using DCACHE as initial RAM for Stack, etc, does not
5441 require any physical RAM backing up the cache. The cleverness
5442 is that the cache is being used as a temporary supply of
5443 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005444 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00005445 can see how this works by studying the cache architecture and
5446 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00005447
wdenk6c59edc2004-05-03 20:45:30 +00005448 OCM is On Chip Memory, which I believe the 405GP has 4K. It
5449 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005450 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00005451 option should work for you. Using CS 4 should be fine if your
5452 board designers haven't used it for something that would
5453 cause you grief during the initial boot! It is frequently not
5454 used.
wdenkc6097192002-11-03 00:24:07 +00005455
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005456 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00005457 with your processor/board/system design. The default value
5458 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02005459 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00005460 than your SDRAM module. If you have a 64MB SDRAM module, set
5461 it above 400_0000. Just make sure your board has no resources
5462 that are supposed to respond to that address! That code in
5463 start.S has been around a while and should work as is when
5464 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00005465
wdenk6c59edc2004-05-03 20:45:30 +00005466 -Chris Hallinan
5467 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00005468
wdenk6c59edc2004-05-03 20:45:30 +00005469It is essential to remember this, since it has some impact on the C
5470code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00005471
wdenk6c59edc2004-05-03 20:45:30 +00005472* Initialized global data (data segment) is read-only. Do not attempt
5473 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00005474
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005475* Do not use any uninitialized global data (or implicitly initialized
wdenk6c59edc2004-05-03 20:45:30 +00005476 as zero data - BSS segment) at all - this is undefined, initiali-
5477 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00005478
wdenk6c59edc2004-05-03 20:45:30 +00005479* Stack space is very limited. Avoid big data buffers or things like
5480 that.
wdenk4a5c8a72003-03-06 00:02:04 +00005481
wdenk6c59edc2004-05-03 20:45:30 +00005482Having only the stack as writable memory limits means we cannot use
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005483normal global data to share information between the code. But it
wdenk6c59edc2004-05-03 20:45:30 +00005484turned out that the implementation of U-Boot can be greatly
5485simplified by making a global data structure (gd_t) available to all
5486functions. We could pass a pointer to this data as argument to _all_
5487functions, but this would bloat the code. Instead we use a feature of
5488the GCC compiler (Global Register Variables) to share the data: we
5489place a pointer (gd) to the global data into a register which we
5490reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00005491
wdenk6c59edc2004-05-03 20:45:30 +00005492When choosing a register for such a purpose we are restricted by the
5493relevant (E)ABI specifications for the current architecture, and by
5494GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00005495
wdenk6c59edc2004-05-03 20:45:30 +00005496For PowerPC, the following registers have specific use:
5497 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01005498 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00005499 R3-R4: parameter passing and return values
5500 R5-R10: parameter passing
5501 R13: small data area pointer
5502 R30: GOT pointer
5503 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00005504
Joakim Tjernlund693c0c12010-01-19 14:41:58 +01005505 (U-Boot also uses R12 as internal GOT pointer. r12
5506 is a volatile register so r12 needs to be reset when
5507 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00005508
Wolfgang Denk69c09642008-02-14 22:43:22 +01005509 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005510
wdenk6c59edc2004-05-03 20:45:30 +00005511 Note: on PPC, we could use a static initializer (since the
5512 address of the global data structure is known at compile time),
5513 but it turned out that reserving a register results in somewhat
5514 smaller code - although the code savings are not that big (on
5515 average for all boards 752 bytes for the whole U-Boot image,
5516 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00005517
wdenk6c59edc2004-05-03 20:45:30 +00005518On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00005519
wdenk6c59edc2004-05-03 20:45:30 +00005520 R0: function argument word/integer result
5521 R1-R3: function argument word
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02005522 R9: platform specific
5523 R10: stack limit (used only if stack checking is enabled)
wdenk6c59edc2004-05-03 20:45:30 +00005524 R11: argument (frame) pointer
5525 R12: temporary workspace
5526 R13: stack pointer
5527 R14: link register
5528 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00005529
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02005530 ==> U-Boot will use R9 to hold a pointer to the global data
5531
5532 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00005533
Thomas Chou8fa38582010-05-21 11:08:03 +08005534On Nios II, the ABI is documented here:
5535 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
5536
5537 ==> U-Boot will use gp to hold a pointer to the global data
5538
5539 Note: on Nios II, we give "-G0" option to gcc and don't use gp
5540 to access small data sections, so gp is free.
5541
Macpaul Lin1cac36e2011-10-19 20:41:11 +00005542On NDS32, the following registers are used:
5543
5544 R0-R1: argument/return
5545 R2-R5: argument
5546 R15: temporary register for assembler
5547 R16: trampoline register
5548 R28: frame pointer (FP)
5549 R29: global pointer (GP)
5550 R30: link register (LP)
5551 R31: stack pointer (SP)
5552 PC: program counter (PC)
5553
5554 ==> U-Boot will use R10 to hold a pointer to the global data
5555
Wolfgang Denk6405a152006-03-31 18:32:53 +02005556NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5557or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00005558
wdenk6c59edc2004-05-03 20:45:30 +00005559Memory Management:
5560------------------
wdenkc6097192002-11-03 00:24:07 +00005561
wdenk6c59edc2004-05-03 20:45:30 +00005562U-Boot runs in system state and uses physical addresses, i.e. the
5563MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00005564
wdenk6c59edc2004-05-03 20:45:30 +00005565The available memory is mapped to fixed addresses using the memory
5566controller. In this process, a contiguous block is formed for each
5567memory type (Flash, SDRAM, SRAM), even when it consists of several
5568physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00005569
wdenk6c59edc2004-05-03 20:45:30 +00005570U-Boot is installed in the first 128 kB of the first Flash bank (on
5571TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5572booting and sizing and initializing DRAM, the code relocates itself
5573to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005574memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00005575configuration setting]. Below that, a structure with global Board
5576Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00005577
wdenk6c59edc2004-05-03 20:45:30 +00005578Additionally, some exception handler code is copied to the low 8 kB
5579of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00005580
wdenk6c59edc2004-05-03 20:45:30 +00005581So a typical memory configuration with 16 MB of DRAM could look like
5582this:
wdenkc6097192002-11-03 00:24:07 +00005583
wdenk6c59edc2004-05-03 20:45:30 +00005584 0x0000 0000 Exception Vector code
5585 :
5586 0x0000 1FFF
5587 0x0000 2000 Free for Application Use
5588 :
5589 :
wdenkc6097192002-11-03 00:24:07 +00005590
wdenk6c59edc2004-05-03 20:45:30 +00005591 :
5592 :
5593 0x00FB FF20 Monitor Stack (Growing downward)
5594 0x00FB FFAC Board Info Data and permanent copy of global data
5595 0x00FC 0000 Malloc Arena
5596 :
5597 0x00FD FFFF
5598 0x00FE 0000 RAM Copy of Monitor Code
5599 ... eventually: LCD or video framebuffer
5600 ... eventually: pRAM (Protected RAM - unchanged by reset)
5601 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00005602
wdenkc6097192002-11-03 00:24:07 +00005603
wdenk6c59edc2004-05-03 20:45:30 +00005604System Initialization:
5605----------------------
wdenkc6097192002-11-03 00:24:07 +00005606
wdenk6c59edc2004-05-03 20:45:30 +00005607In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005608(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005609configuration for CS0# this is a mirror of the on board Flash memory.
wdenk6c59edc2004-05-03 20:45:30 +00005610To be able to re-map memory U-Boot then jumps to its link address.
5611To be able to implement the initialization code in C, a (small!)
5612initial stack is set up in the internal Dual Ported RAM (in case CPUs
Heiko Schocher71cb3e92017-06-07 17:33:10 +02005613which provide such a feature like), or in a locked part of the data
5614cache. After that, U-Boot initializes the CPU core, the caches and
5615the SIU.
wdenkc6097192002-11-03 00:24:07 +00005616
wdenk6c59edc2004-05-03 20:45:30 +00005617Next, all (potentially) available memory banks are mapped using a
5618preliminary mapping. For example, we put them on 512 MB boundaries
5619(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5620on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5621programmed for SDRAM access. Using the temporary configuration, a
5622simple memory test is run that determines the size of the SDRAM
5623banks.
wdenkc6097192002-11-03 00:24:07 +00005624
wdenk6c59edc2004-05-03 20:45:30 +00005625When there is more than one SDRAM bank, and the banks are of
5626different size, the largest is mapped first. For equal size, the first
5627bank (CS2#) is mapped first. The first mapping is always for address
56280x00000000, with any additional banks following immediately to create
5629contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00005630
wdenk6c59edc2004-05-03 20:45:30 +00005631Then, the monitor installs itself at the upper end of the SDRAM area
5632and allocates memory for use by malloc() and for the global Board
5633Info data; also, the exception vector code is copied to the low RAM
5634pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00005635
wdenk6c59edc2004-05-03 20:45:30 +00005636Only after this relocation will you have a "normal" C environment;
5637until that you are restricted in several ways, mostly because you are
5638running from ROM, and because the code will have to be relocated to a
5639new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00005640
wdenkc6097192002-11-03 00:24:07 +00005641
wdenk6c59edc2004-05-03 20:45:30 +00005642U-Boot Porting Guide:
5643----------------------
wdenkc6097192002-11-03 00:24:07 +00005644
wdenk6c59edc2004-05-03 20:45:30 +00005645[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
5646list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00005647
wdenkc6097192002-11-03 00:24:07 +00005648
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005649int main(int argc, char *argv[])
wdenk6c59edc2004-05-03 20:45:30 +00005650{
5651 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00005652
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005653 signal(SIGALRM, no_more_time);
5654 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00005655
wdenk6c59edc2004-05-03 20:45:30 +00005656 if (available_money > available_manpower) {
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005657 Pay consultant to port U-Boot;
wdenk6c59edc2004-05-03 20:45:30 +00005658 return 0;
5659 }
wdenkc6097192002-11-03 00:24:07 +00005660
wdenk6c59edc2004-05-03 20:45:30 +00005661 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00005662
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005663 Subscribe to u-boot mailing list;
wdenkc6097192002-11-03 00:24:07 +00005664
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005665 if (clueless)
5666 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00005667
wdenk6c59edc2004-05-03 20:45:30 +00005668 while (learning) {
5669 Read the README file in the top level directory;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005670 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
5671 Read applicable doc/*.README;
wdenk6c59edc2004-05-03 20:45:30 +00005672 Read the source, Luke;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005673 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk6c59edc2004-05-03 20:45:30 +00005674 }
wdenkc6097192002-11-03 00:24:07 +00005675
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005676 if (available_money > toLocalCurrency ($2500))
5677 Buy a BDI3000;
5678 else
wdenk6c59edc2004-05-03 20:45:30 +00005679 Add a lot of aggravation and time;
wdenkc6097192002-11-03 00:24:07 +00005680
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005681 if (a similar board exists) { /* hopefully... */
5682 cp -a board/<similar> board/<myboard>
5683 cp include/configs/<similar>.h include/configs/<myboard>.h
5684 } else {
5685 Create your own board support subdirectory;
5686 Create your own board include/configs/<myboard>.h file;
5687 }
5688 Edit new board/<myboard> files
5689 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00005690
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005691 while (!accepted) {
5692 while (!running) {
5693 do {
5694 Add / modify source code;
5695 } until (compiles);
5696 Debug;
5697 if (clueless)
5698 email("Hi, I am having problems...");
5699 }
5700 Send patch file to the U-Boot email list;
5701 if (reasonable critiques)
5702 Incorporate improvements from email list code review;
5703 else
5704 Defend code as written;
wdenk634d2f72004-04-15 23:14:49 +00005705 }
wdenkc6097192002-11-03 00:24:07 +00005706
wdenk6c59edc2004-05-03 20:45:30 +00005707 return 0;
5708}
wdenkc6097192002-11-03 00:24:07 +00005709
wdenk6c59edc2004-05-03 20:45:30 +00005710void no_more_time (int sig)
5711{
5712 hire_a_guru();
5713}
wdenkc6097192002-11-03 00:24:07 +00005714
wdenkc6097192002-11-03 00:24:07 +00005715
wdenk6c59edc2004-05-03 20:45:30 +00005716Coding Standards:
5717-----------------
wdenkc6097192002-11-03 00:24:07 +00005718
wdenk6c59edc2004-05-03 20:45:30 +00005719All contributions to U-Boot should conform to the Linux kernel
Detlev Zundelaa63d482006-09-01 15:39:02 +02005720coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005721"scripts/Lindent" in your Linux kernel source directory.
Detlev Zundelaa63d482006-09-01 15:39:02 +02005722
5723Source files originating from a different project (for example the
5724MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005725reformatted to ease subsequent migration to newer versions of those
Detlev Zundelaa63d482006-09-01 15:39:02 +02005726sources.
wdenkc6097192002-11-03 00:24:07 +00005727
Detlev Zundelaa63d482006-09-01 15:39:02 +02005728Please note that U-Boot is implemented in C (and to some small parts in
5729Assembler); no C++ is used, so please do not use C++ style comments (//)
5730in your code.
wdenkad276f22004-01-04 16:28:35 +00005731
wdenk6c59edc2004-05-03 20:45:30 +00005732Please also stick to the following formatting rules:
5733- remove any trailing white space
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005734- use TAB characters for indentation and vertical alignment, not spaces
wdenk6c59edc2004-05-03 20:45:30 +00005735- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005736- do not add more than 2 consecutive empty lines to source files
wdenk6c59edc2004-05-03 20:45:30 +00005737- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00005738
wdenk6c59edc2004-05-03 20:45:30 +00005739Submissions which do not conform to the standards may be returned
5740with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00005741
wdenkc6097192002-11-03 00:24:07 +00005742
wdenk6c59edc2004-05-03 20:45:30 +00005743Submitting Patches:
5744-------------------
wdenkc6097192002-11-03 00:24:07 +00005745
wdenk6c59edc2004-05-03 20:45:30 +00005746Since the number of patches for U-Boot is growing, we need to
5747establish some rules. Submissions which do not conform to these rules
5748may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00005749
Magnus Liljaf3b287b2008-08-06 19:32:33 +02005750Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005751
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005752Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
5753see http://lists.denx.de/mailman/listinfo/u-boot
5754
wdenk6c59edc2004-05-03 20:45:30 +00005755When you send a patch, please include the following information with
5756it:
wdenkc6097192002-11-03 00:24:07 +00005757
wdenk6c59edc2004-05-03 20:45:30 +00005758* For bug fixes: a description of the bug and how your patch fixes
5759 this bug. Please try to include a way of demonstrating that the
5760 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00005761
wdenk6c59edc2004-05-03 20:45:30 +00005762* For new features: a description of the feature and your
5763 implementation.
wdenkc6097192002-11-03 00:24:07 +00005764
wdenk6c59edc2004-05-03 20:45:30 +00005765* A CHANGELOG entry as plaintext (separate from the patch)
wdenkc6097192002-11-03 00:24:07 +00005766
Robert P. J. Day076ed9b2015-12-19 07:16:10 -05005767* For major contributions, add a MAINTAINERS file with your
5768 information and associated file and directory references.
wdenkc6097192002-11-03 00:24:07 +00005769
Albert ARIBAUD48e910f2013-09-11 15:52:51 +02005770* When you add support for a new board, don't forget to add a
5771 maintainer e-mail address to the boards.cfg file, too.
wdenkc6097192002-11-03 00:24:07 +00005772
wdenk6c59edc2004-05-03 20:45:30 +00005773* If your patch adds new configuration options, don't forget to
5774 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00005775
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005776* The patch itself. If you are using git (which is *strongly*
5777 recommended) you can easily generate the patch using the
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005778 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005779 the U-Boot mailing list, you will avoid most of the common problems
5780 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00005781
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005782 If you cannot use git, use "diff -purN OLD NEW". If your version of
5783 diff does not support these options, then get the latest version of
5784 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00005785
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005786 The current directory when running this command shall be the parent
5787 directory of the U-Boot source tree (i. e. please make sure that
5788 your patch includes sufficient directory information for the
5789 affected files).
5790
5791 We prefer patches as plain text. MIME attachments are discouraged,
5792 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00005793
wdenk6c59edc2004-05-03 20:45:30 +00005794* If one logical set of modifications affects or creates several
5795 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00005796
wdenk6c59edc2004-05-03 20:45:30 +00005797* Changesets that contain different, unrelated modifications shall be
5798 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00005799
wdenkc6097192002-11-03 00:24:07 +00005800
wdenk6c59edc2004-05-03 20:45:30 +00005801Notes:
wdenkc6097192002-11-03 00:24:07 +00005802
Simon Glassdc27def2016-07-27 20:33:08 -06005803* Before sending the patch, run the buildman script on your patched
wdenk6c59edc2004-05-03 20:45:30 +00005804 source tree and make sure that no errors or warnings are reported
5805 for any of the boards.
5806
5807* Keep your modifications to the necessary minimum: A patch
5808 containing several unrelated changes or arbitrary reformats will be
5809 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00005810
wdenk6c59edc2004-05-03 20:45:30 +00005811* If you modify existing code, make sure that your new code does not
5812 add to the memory footprint of the code ;-) Small is beautiful!
5813 When adding new features, these should compile conditionally only
5814 (using #ifdef), and the resulting code with the new feature
5815 disabled must not need more memory than the old code without your
5816 modification.
wdenkcbc49a52005-05-03 14:12:25 +00005817
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005818* Remember that there is a size limit of 100 kB per message on the
5819 u-boot mailing list. Bigger patches will be moderated. If they are
5820 reasonable and not too big, they will be acknowledged. But patches
5821 bigger than the size limit should be avoided.