blob: 2e79fea327438e2516ab124a5cbfff47b5b6a48f [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 /m68k Files generic to m68k architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500140 /microblaze Files generic to microblaze architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500141 /mips Files generic to MIPS architecture
Macpaul Lin1cac36e2011-10-19 20:41:11 +0000142 /nds32 Files generic to NDS32 architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500143 /nios2 Files generic to Altera NIOS2 architecture
Robert P. J. Daya269c932013-09-15 18:34:15 -0400144 /openrisc Files generic to OpenRISC architecture
Stefan Roese88fbf932010-04-15 16:07:28 +0200145 /powerpc Files generic to PowerPC architecture
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500146 /sandbox Files generic to HW-independent "sandbox"
Peter Tysere4d1abc2010-04-12 22:28:21 -0500147 /sh Files generic to SH architecture
Robert P. J. Daya269c932013-09-15 18:34:15 -0400148 /x86 Files generic to x86 architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500149/api Machine/arch independent API for external apps
150/board Board dependent files
Xu Ziyuanfb1f9392016-08-26 19:54:49 +0800151/cmd U-Boot commands functions
Peter Tysere4d1abc2010-04-12 22:28:21 -0500152/common Misc architecture independent functions
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500153/configs Board default configuration files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500154/disk Code for disk drive partition handling
155/doc Documentation (don't expect too much)
156/drivers Commonly used device drivers
Robert P. J. Daya269c932013-09-15 18:34:15 -0400157/dts Contains Makefile for building internal U-Boot fdt.
Peter Tysere4d1abc2010-04-12 22:28:21 -0500158/examples Example code for standalone applications, etc.
159/fs Filesystem code (cramfs, ext2, jffs2, etc.)
160/include Header Files
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500161/lib Library routines generic to all architectures
162/Licenses Various license files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500163/net Networking code
164/post Power On Self Test
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500165/scripts Various build scripts and Makefiles
166/test Various unit test files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500167/tools Tools to build S-Record or U-Boot images, etc.
wdenkc6097192002-11-03 00:24:07 +0000168
wdenkc6097192002-11-03 00:24:07 +0000169Software Configuration:
170=======================
171
172Configuration is usually done using C preprocessor defines; the
173rationale behind that is to avoid dead code whenever possible.
174
175There are two classes of configuration variables:
176
177* Configuration _OPTIONS_:
178 These are selectable by the user and have names beginning with
179 "CONFIG_".
180
181* Configuration _SETTINGS_:
182 These depend on the hardware etc. and should not be meddled with if
183 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200184 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000185
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500186Previously, all configuration was done by hand, which involved creating
187symbolic links and editing configuration files manually. More recently,
188U-Boot has added the Kbuild infrastructure used by the Linux kernel,
189allowing you to use the "make menuconfig" command to configure your
190build.
wdenkc6097192002-11-03 00:24:07 +0000191
192
193Selection of Processor Architecture and Board Type:
194---------------------------------------------------
195
196For all supported boards there are ready-to-use default
Holger Freyther7ba4e572014-08-04 09:26:05 +0200197configurations available; just type "make <board_name>_defconfig".
wdenkc6097192002-11-03 00:24:07 +0000198
199Example: For a TQM823L module type:
200
201 cd u-boot
Holger Freyther7ba4e572014-08-04 09:26:05 +0200202 make TQM823L_defconfig
wdenkc6097192002-11-03 00:24:07 +0000203
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500204Note: If you're looking for the default configuration file for a board
205you're sure used to be there but is now missing, check the file
206doc/README.scrapyard for a list of no longer supported boards.
wdenkc6097192002-11-03 00:24:07 +0000207
Simon Glass53552c92014-03-22 17:12:59 -0600208Sandbox Environment:
209--------------------
210
211U-Boot can be built natively to run on a Linux host using the 'sandbox'
212board. This allows feature development which is not board- or architecture-
213specific to be undertaken on a native platform. The sandbox is also used to
214run some of U-Boot's tests.
215
Jagannadha Sutradharudu Teki287314f2014-08-31 21:19:43 +0530216See board/sandbox/README.sandbox for more details.
Simon Glass53552c92014-03-22 17:12:59 -0600217
218
Simon Glassd8711af2015-03-03 08:03:00 -0700219Board Initialisation Flow:
220--------------------------
221
222This is the intended start-up flow for boards. This should apply for both
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500223SPL and U-Boot proper (i.e. they both follow the same rules).
224
225Note: "SPL" stands for "Secondary Program Loader," which is explained in
226more detail later in this file.
227
228At present, SPL mostly uses a separate code path, but the function names
229and roles of each function are the same. Some boards or architectures
230may not conform to this. At least most ARM boards which use
231CONFIG_SPL_FRAMEWORK conform to this.
Simon Glassd8711af2015-03-03 08:03:00 -0700232
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500233Execution typically starts with an architecture-specific (and possibly
234CPU-specific) start.S file, such as:
235
236 - arch/arm/cpu/armv7/start.S
237 - arch/powerpc/cpu/mpc83xx/start.S
238 - arch/mips/cpu/start.S
239
240and so on. From there, three functions are called; the purpose and
241limitations of each of these functions are described below.
Simon Glassd8711af2015-03-03 08:03:00 -0700242
243lowlevel_init():
244 - purpose: essential init to permit execution to reach board_init_f()
245 - no global_data or BSS
246 - there is no stack (ARMv7 may have one but it will soon be removed)
247 - must not set up SDRAM or use console
248 - must only do the bare minimum to allow execution to continue to
249 board_init_f()
250 - this is almost never needed
251 - return normally from this function
252
253board_init_f():
254 - purpose: set up the machine ready for running board_init_r():
255 i.e. SDRAM and serial UART
256 - global_data is available
257 - stack is in SRAM
258 - BSS is not available, so you cannot use global/static variables,
259 only stack variables and global_data
260
261 Non-SPL-specific notes:
262 - dram_init() is called to set up DRAM. If already done in SPL this
263 can do nothing
264
265 SPL-specific notes:
266 - you can override the entire board_init_f() function with your own
267 version as needed.
268 - preloader_console_init() can be called here in extremis
269 - should set up SDRAM, and anything needed to make the UART work
270 - these is no need to clear BSS, it will be done by crt0.S
271 - must return normally from this function (don't call board_init_r()
272 directly)
273
274Here the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at
275this point the stack and global_data are relocated to below
276CONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of
277memory.
278
279board_init_r():
280 - purpose: main execution, common code
281 - global_data is available
282 - SDRAM is available
283 - BSS is available, all static/global variables can be used
284 - execution eventually continues to main_loop()
285
286 Non-SPL-specific notes:
287 - U-Boot is relocated to the top of memory and is now running from
288 there.
289
290 SPL-specific notes:
291 - stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and
292 CONFIG_SPL_STACK_R_ADDR points into SDRAM
293 - preloader_console_init() can be called here - typically this is
Ley Foon Tan48fcc4a2017-05-03 17:13:32 +0800294 done by selecting CONFIG_SPL_BOARD_INIT and then supplying a
Simon Glassd8711af2015-03-03 08:03:00 -0700295 spl_board_init() function containing this call
296 - loads U-Boot or (in falcon mode) Linux
297
298
299
wdenkc6097192002-11-03 00:24:07 +0000300Configuration Options:
301----------------------
302
303Configuration depends on the combination of board and CPU type; all
304such information is kept in a configuration file
305"include/configs/<board_name>.h".
306
307Example: For a TQM823L module, all configuration settings are in
308"include/configs/TQM823L.h".
309
310
wdenk1272e232002-11-10 22:06:23 +0000311Many of the options are named exactly as the corresponding Linux
312kernel configuration options. The intention is to make it easier to
313build a config tool - later.
314
315
wdenkc6097192002-11-03 00:24:07 +0000316The following options need to be configured:
317
Kim Phillips203fee32007-08-10 13:28:25 -0500318- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000319
Kim Phillips203fee32007-08-10 13:28:25 -0500320- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk994ad962006-10-24 14:42:37 +0200321
Lei Wen20014762011-02-09 18:06:58 +0530322- Marvell Family Member
323 CONFIG_SYS_MVFS - define it if you want to enable
324 multiple fs option at one time
325 for marvell soc family
326
Kumar Galaf4fb90f2011-02-18 05:40:54 -0600327- 85xx CPU Options:
York Sun2394a0f2012-10-08 07:44:30 +0000328 CONFIG_SYS_PPC64
329
330 Specifies that the core is a 64-bit PowerPC implementation (implements
331 the "64" category of the Power ISA). This is necessary for ePAPR
332 compliance, among other possible reasons.
333
Kumar Galaf4fb90f2011-02-18 05:40:54 -0600334 CONFIG_SYS_FSL_TBCLK_DIV
335
336 Defines the core time base clock divider ratio compared to the
337 system clock. On most PQ3 devices this is 8, on newer QorIQ
338 devices it can be 16 or 32. The ratio varies from SoC to Soc.
339
Kumar Gala179b1b22011-05-20 00:39:21 -0500340 CONFIG_SYS_FSL_PCIE_COMPAT
341
342 Defines the string to utilize when trying to match PCIe device
343 tree nodes for the given platform.
344
Scott Wood80806962012-08-14 10:14:53 +0000345 CONFIG_SYS_FSL_ERRATUM_A004510
346
347 Enables a workaround for erratum A004510. If set,
348 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
349 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
350
351 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
352 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
353
354 Defines one or two SoC revisions (low 8 bits of SVR)
355 for which the A004510 workaround should be applied.
356
357 The rest of SVR is either not relevant to the decision
358 of whether the erratum is present (e.g. p2040 versus
359 p2041) or is implied by the build target, which controls
360 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
361
362 See Freescale App Note 4493 for more information about
363 this erratum.
364
Prabhakar Kushwahad324f472013-04-16 13:27:44 +0530365 CONFIG_A003399_NOR_WORKAROUND
366 Enables a workaround for IFC erratum A003399. It is only
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800367 required during NOR boot.
Prabhakar Kushwahad324f472013-04-16 13:27:44 +0530368
Prabhakar Kushwahac4c10d12014-10-29 22:33:09 +0530369 CONFIG_A008044_WORKAROUND
370 Enables a workaround for T1040/T1042 erratum A008044. It is only
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800371 required during NAND boot and valid for Rev 1.0 SoC revision
Prabhakar Kushwahac4c10d12014-10-29 22:33:09 +0530372
Scott Wood80806962012-08-14 10:14:53 +0000373 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
374
375 This is the value to write into CCSR offset 0x18600
376 according to the A004510 workaround.
377
Priyanka Jainc73b9032013-07-02 09:21:04 +0530378 CONFIG_SYS_FSL_DSP_DDR_ADDR
379 This value denotes start offset of DDR memory which is
380 connected exclusively to the DSP cores.
381
Priyanka Jainf81e8b22013-04-04 09:31:54 +0530382 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
383 This value denotes start offset of M2 memory
384 which is directly connected to the DSP core.
385
Priyanka Jainc73b9032013-07-02 09:21:04 +0530386 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
387 This value denotes start offset of M3 memory which is directly
388 connected to the DSP core.
389
Priyanka Jainf81e8b22013-04-04 09:31:54 +0530390 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
391 This value denotes start offset of DSP CCSR space.
392
Priyanka Jaine9dcaa82013-12-17 14:25:52 +0530393 CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
394 Single Source Clock is clocking mode present in some of FSL SoC's.
395 In this mode, a single differential clock is used to supply
396 clocks to the sysclock, ddrclock and usbclock.
397
Aneesh Bansal8bcbc272014-03-18 23:40:26 +0530398 CONFIG_SYS_CPC_REINIT_F
399 This CONFIG is defined when the CPC is configured as SRAM at the
Bin Meng75574052016-02-05 19:30:11 -0800400 time of U-Boot entry and is required to be re-initialized.
Aneesh Bansal8bcbc272014-03-18 23:40:26 +0530401
Tang Yuantiana7364af2014-04-17 15:33:46 +0800402 CONFIG_DEEP_SLEEP
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800403 Indicates this SoC supports deep sleep feature. If deep sleep is
Tang Yuantiana7364af2014-04-17 15:33:46 +0800404 supported, core will start to execute uboot when wakes up.
405
Daniel Schwierzeckd8a49ca2012-04-02 02:57:56 +0000406- Generic CPU options:
York Sun021d2022014-05-02 17:28:04 -0700407 CONFIG_SYS_GENERIC_GLOBAL_DATA
408 Defines global data is initialized in generic board board_init_f().
409 If this macro is defined, global data is created and cleared in
410 generic board board_init_f(). Without this macro, architecture/board
411 should initialize global data before calling board_init_f().
412
Daniel Schwierzeckd8a49ca2012-04-02 02:57:56 +0000413 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
414
415 Defines the endianess of the CPU. Implementation of those
416 values is arch specific.
417
York Sunf0626592013-09-30 09:22:09 -0700418 CONFIG_SYS_FSL_DDR
419 Freescale DDR driver in use. This type of DDR controller is
420 found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
421 SoCs.
422
423 CONFIG_SYS_FSL_DDR_ADDR
424 Freescale DDR memory-mapped register base.
425
426 CONFIG_SYS_FSL_DDR_EMU
427 Specify emulator support for DDR. Some DDR features such as
428 deskew training are not available.
429
430 CONFIG_SYS_FSL_DDRC_GEN1
431 Freescale DDR1 controller.
432
433 CONFIG_SYS_FSL_DDRC_GEN2
434 Freescale DDR2 controller.
435
436 CONFIG_SYS_FSL_DDRC_GEN3
437 Freescale DDR3 controller.
438
York Sun2896cb72014-03-27 17:54:47 -0700439 CONFIG_SYS_FSL_DDRC_GEN4
440 Freescale DDR4 controller.
441
York Sun461c9392013-09-30 14:20:51 -0700442 CONFIG_SYS_FSL_DDRC_ARM_GEN3
443 Freescale DDR3 controller for ARM-based SoCs.
444
York Sunf0626592013-09-30 09:22:09 -0700445 CONFIG_SYS_FSL_DDR1
446 Board config to use DDR1. It can be enabled for SoCs with
447 Freescale DDR1 or DDR2 controllers, depending on the board
448 implemetation.
449
450 CONFIG_SYS_FSL_DDR2
Robert P. J. Day8d56db92016-07-15 13:44:45 -0400451 Board config to use DDR2. It can be enabled for SoCs with
York Sunf0626592013-09-30 09:22:09 -0700452 Freescale DDR2 or DDR3 controllers, depending on the board
453 implementation.
454
455 CONFIG_SYS_FSL_DDR3
456 Board config to use DDR3. It can be enabled for SoCs with
York Sun2896cb72014-03-27 17:54:47 -0700457 Freescale DDR3 or DDR3L controllers.
458
459 CONFIG_SYS_FSL_DDR3L
460 Board config to use DDR3L. It can be enabled for SoCs with
461 DDR3L controllers.
462
463 CONFIG_SYS_FSL_DDR4
464 Board config to use DDR4. It can be enabled for SoCs with
465 DDR4 controllers.
York Sunf0626592013-09-30 09:22:09 -0700466
Prabhakar Kushwaha62908c22014-01-18 12:28:30 +0530467 CONFIG_SYS_FSL_IFC_BE
468 Defines the IFC controller register space as Big Endian
469
470 CONFIG_SYS_FSL_IFC_LE
471 Defines the IFC controller register space as Little Endian
472
Prabhakar Kushwaha3c48f582017-02-02 15:01:26 +0530473 CONFIG_SYS_FSL_IFC_CLK_DIV
474 Defines divider of platform clock(clock input to IFC controller).
475
Prabhakar Kushwahabedc5622017-02-02 15:02:00 +0530476 CONFIG_SYS_FSL_LBC_CLK_DIV
477 Defines divider of platform clock(clock input to eLBC controller).
478
Prabhakar Kushwaha950f2f72014-01-13 11:28:04 +0530479 CONFIG_SYS_FSL_PBL_PBI
480 It enables addition of RCW (Power on reset configuration) in built image.
481 Please refer doc/README.pblimage for more details
482
483 CONFIG_SYS_FSL_PBL_RCW
484 It adds PBI(pre-boot instructions) commands in u-boot build image.
485 PBI commands can be used to configure SoC before it starts the execution.
486 Please refer doc/README.pblimage for more details
487
Prabhakar Kushwaha2c27f122014-04-08 19:13:34 +0530488 CONFIG_SPL_FSL_PBL
489 It adds a target to create boot binary having SPL binary in PBI format
490 concatenated with u-boot binary.
491
York Sun29647ab2014-02-10 13:59:42 -0800492 CONFIG_SYS_FSL_DDR_BE
493 Defines the DDR controller register space as Big Endian
494
495 CONFIG_SYS_FSL_DDR_LE
496 Defines the DDR controller register space as Little Endian
497
York Sun3a0916d2014-02-10 13:59:43 -0800498 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
499 Physical address from the view of DDR controllers. It is the
500 same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But
501 it could be different for ARM SoCs.
502
York Sunc459ae62014-02-10 13:59:44 -0800503 CONFIG_SYS_FSL_DDR_INTLV_256B
504 DDR controller interleaving on 256-byte. This is a special
505 interleaving mode, handled by Dickens for Freescale layerscape
506 SoCs with ARM core.
507
York Sun79a779b2014-08-01 15:51:00 -0700508 CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
509 Number of controllers used as main memory.
510
511 CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
512 Number of controllers used for other than main memory.
513
Prabhakar Kushwaha122bcfd2015-11-09 16:42:07 +0530514 CONFIG_SYS_FSL_HAS_DP_DDR
515 Defines the SoC has DP-DDR used for DPAA.
516
Ruchika Guptabb7143b2014-09-09 11:50:31 +0530517 CONFIG_SYS_FSL_SEC_BE
518 Defines the SEC controller register space as Big Endian
519
520 CONFIG_SYS_FSL_SEC_LE
521 Defines the SEC controller register space as Little Endian
522
Daniel Schwierzeckd52a6232011-07-27 13:22:39 +0200523- MIPS CPU options:
524 CONFIG_SYS_INIT_SP_OFFSET
525
526 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
527 pointer. This is needed for the temporary stack before
528 relocation.
529
530 CONFIG_SYS_MIPS_CACHE_MODE
531
532 Cache operation mode for the MIPS CPU.
533 See also arch/mips/include/asm/mipsregs.h.
534 Possible values are:
535 CONF_CM_CACHABLE_NO_WA
536 CONF_CM_CACHABLE_WA
537 CONF_CM_UNCACHED
538 CONF_CM_CACHABLE_NONCOHERENT
539 CONF_CM_CACHABLE_CE
540 CONF_CM_CACHABLE_COW
541 CONF_CM_CACHABLE_CUW
542 CONF_CM_CACHABLE_ACCELERATED
543
544 CONFIG_SYS_XWAY_EBU_BOOTCFG
545
546 Special option for Lantiq XWAY SoCs for booting from NOR flash.
547 See also arch/mips/cpu/mips32/start.S.
548
549 CONFIG_XWAY_SWAP_BYTES
550
551 Enable compilation of tools/xway-swap-bytes needed for Lantiq
552 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
553 be swapped if a flash programmer is used.
554
Christian Riesch48c2d6d2012-02-02 00:44:39 +0000555- ARM options:
556 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
557
558 Select high exception vectors of the ARM core, e.g., do not
559 clear the V bit of the c1 register of CP15.
560
York Sun77a10972015-03-20 19:28:08 -0700561 COUNTER_FREQUENCY
562 Generic timer clock source frequency.
563
564 COUNTER_FREQUENCY_REAL
565 Generic timer clock source frequency if the real clock is
566 different from COUNTER_FREQUENCY, and can only be determined
567 at run time.
568
Stephen Warren8d1fb312015-01-19 16:25:52 -0700569- Tegra SoC options:
570 CONFIG_TEGRA_SUPPORT_NON_SECURE
571
572 Support executing U-Boot in non-secure (NS) mode. Certain
573 impossible actions will be skipped if the CPU is in NS mode,
574 such as ARM architectural timer initialization.
575
wdenk9b7f3842003-10-09 20:09:04 +0000576- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000577 CONFIG_CLOCKS_IN_MHZ
578
579 U-Boot stores all clock information in Hz
580 internally. For binary compatibility with older Linux
581 kernels (which expect the clocks passed in the
582 bd_info data to be in MHz) the environment variable
583 "clocks_in_mhz" can be defined so that U-Boot
584 converts clock data to MHZ before passing it to the
585 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000586 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denkb240aef2008-03-26 10:40:12 +0100587 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000588 default environment.
589
wdenk9b7f3842003-10-09 20:09:04 +0000590 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
591
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800592 When transferring memsize parameter to Linux, some versions
wdenk9b7f3842003-10-09 20:09:04 +0000593 expect it to be in bytes, others in MB.
594 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
595
Gerald Van Barenfcd91bb2008-06-03 20:34:45 -0400596 CONFIG_OF_LIBFDT
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200597
598 New kernel versions are expecting firmware settings to be
Gerald Van Barend6abef42007-03-31 12:23:51 -0400599 passed using flattened device trees (based on open firmware
600 concepts).
601
602 CONFIG_OF_LIBFDT
603 * New libfdt-based support
604 * Adds the "fdt" command
Kim Phillips9b46eb62007-08-10 14:34:14 -0500605 * The bootm command automatically updates the fdt
Gerald Van Barend6abef42007-03-31 12:23:51 -0400606
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200607 OF_TBCLK - The timebase frequency.
Kumar Galae40c2b52006-01-11 13:59:02 -0600608 OF_STDOUT_PATH - The path to the console device
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200609
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200610 boards with QUICC Engines require OF_QE to set UCC MAC
611 addresses
Kim Phillips9b46eb62007-08-10 14:34:14 -0500612
Kumar Gala1e26aa52006-01-11 13:54:17 -0600613 CONFIG_OF_BOARD_SETUP
614
615 Board code has addition modification that it wants to make
616 to the flat device tree before handing it off to the kernel
wdenkda04a8b2004-08-02 23:22:59 +0000617
Simon Glass6c0be912014-10-23 18:58:54 -0600618 CONFIG_OF_SYSTEM_SETUP
619
620 Other code has addition modification that it wants to make
621 to the flat device tree before handing it off to the kernel.
622 This causes ft_system_setup() to be called before booting
623 the kernel.
624
Heiko Schocherffb293a2009-09-23 07:56:08 +0200625 CONFIG_OF_IDE_FIXUP
626
627 U-Boot can detect if an IDE device is present or not.
628 If not, and this new config option is activated, U-Boot
629 removes the ATA node from the DTS before booting Linux,
630 so the Linux IDE driver does not probe the device and
631 crash. This is needed for buggy hardware (uc101) where
632 no pull down resistor is connected to the signal IDE5V_DD7.
633
Igor Grinberg06890672011-07-14 05:45:07 +0000634 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
635
636 This setting is mandatory for all boards that have only one
637 machine type and must be used to specify the machine type
638 number as it appears in the ARM machine registry
639 (see http://www.arm.linux.org.uk/developer/machines/).
640 Only boards that have multiple machine types supported
641 in a single configuration file and the machine type is
642 runtime discoverable, do not have to use this setting.
643
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100644- vxWorks boot parameters:
645
646 bootvx constructs a valid bootline using the following
Bin Mengfb694b92015-10-07 20:19:17 -0700647 environments variables: bootdev, bootfile, ipaddr, netmask,
648 serverip, gatewayip, hostname, othbootargs.
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100649 It loads the vxWorks image pointed bootfile.
650
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100651 Note: If a "bootargs" environment is defined, it will overwride
652 the defaults discussed just above.
653
Aneesh V960f5c02011-06-16 23:30:47 +0000654- Cache Configuration:
655 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
656 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
657 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
658
Aneesh V686a0752011-06-16 23:30:51 +0000659- Cache Configuration for ARM:
660 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
661 controller
662 CONFIG_SYS_PL310_BASE - Physical base address of PL310
663 controller register space
664
wdenkda04a8b2004-08-02 23:22:59 +0000665- Serial Ports:
Andreas Engel0813b122008-09-08 14:30:53 +0200666 CONFIG_PL010_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000667
668 Define this if you want support for Amba PrimeCell PL010 UARTs.
669
Andreas Engel0813b122008-09-08 14:30:53 +0200670 CONFIG_PL011_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000671
672 Define this if you want support for Amba PrimeCell PL011 UARTs.
673
674 CONFIG_PL011_CLOCK
675
676 If you have Amba PrimeCell PL011 UARTs, set this variable to
677 the clock speed of the UARTs.
678
679 CONFIG_PL01x_PORTS
680
681 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
682 define this to a list of base addresses for each (supported)
683 port. See e.g. include/configs/versatile.h
684
Karicheri, Muralidharancbc08882014-04-09 15:38:46 -0400685 CONFIG_SERIAL_HW_FLOW_CONTROL
686
687 Define this variable to enable hw flow control in serial driver.
688 Current user of this option is drivers/serial/nsl16550.c driver
wdenkda04a8b2004-08-02 23:22:59 +0000689
wdenkc6097192002-11-03 00:24:07 +0000690- Console Baudrate:
691 CONFIG_BAUDRATE - in bps
692 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200693 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000694
wdenkc6097192002-11-03 00:24:07 +0000695- Autoboot Command:
696 CONFIG_BOOTCOMMAND
697 Only needed when CONFIG_BOOTDELAY is enabled;
698 define a command string that is automatically executed
699 when no character is read on the console interface
700 within "Boot Delay" after reset.
701
702 CONFIG_BOOTARGS
wdenk4a5c8a72003-03-06 00:02:04 +0000703 This can be used to pass arguments to the bootm
704 command. The value of CONFIG_BOOTARGS goes into the
705 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000706
707 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk4a5c8a72003-03-06 00:02:04 +0000708 The value of these goes into the environment as
709 "ramboot" and "nfsboot" respectively, and can be used
710 as a convenience, when switching between booting from
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200711 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000712
Heiko Schocher040c5c32013-11-04 14:04:59 +0100713- Bootcount:
714 CONFIG_BOOTCOUNT_LIMIT
715 Implements a mechanism for detecting a repeating reboot
716 cycle, see:
717 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
718
719 CONFIG_BOOTCOUNT_ENV
720 If no softreset save registers are found on the hardware
721 "bootcount" is stored in the environment. To prevent a
722 saveenv on all reboots, the environment variable
723 "upgrade_available" is used. If "upgrade_available" is
724 0, "bootcount" is always 0, if "upgrade_available" is
725 1 "bootcount" is incremented in the environment.
726 So the Userspace Applikation must set the "upgrade_available"
727 and "bootcount" variable to 0, if a boot was successfully.
728
wdenkc6097192002-11-03 00:24:07 +0000729- Pre-Boot Commands:
730 CONFIG_PREBOOT
731
732 When this option is #defined, the existence of the
733 environment variable "preboot" will be checked
734 immediately before starting the CONFIG_BOOTDELAY
735 countdown and/or running the auto-boot command resp.
736 entering interactive mode.
737
738 This feature is especially useful when "preboot" is
739 automatically generated or modified. For an example
740 see the LWMON board specific code: here "preboot" is
741 modified when the user holds down a certain
742 combination of keys on the (special) keyboard when
743 booting the systems
744
745- Serial Download Echo Mode:
746 CONFIG_LOADS_ECHO
747 If defined to 1, all characters received during a
748 serial download (using the "loads" command) are
749 echoed back. This might be needed by some terminal
750 emulations (like "cu"), but may as well just take
751 time on others. This setting #define's the initial
752 value of the "loads_echo" environment variable.
753
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500754- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000755 CONFIG_KGDB_BAUDRATE
756 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200757 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000758
759- Monitor Functions:
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500760 Monitor commands can be included or excluded
761 from the build by using the #include files
Stephen Warren963a7cf2012-08-05 16:07:19 +0000762 <config_cmd_all.h> and #undef'ing unwanted
Joe Hershberger5a9d7f12015-06-22 16:15:30 -0500763 commands, or adding #define's for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000764
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500765 The default command configuration includes all commands
766 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000767
Marek Vasutc4d8a1b2014-03-05 19:58:39 +0100768 CONFIG_CMD_AES AES 128 CBC encrypt/decrypt
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500769 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500770 CONFIG_CMD_BDI bdinfo
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500771 CONFIG_CMD_BOOTD bootd
Tom Rini5ce62cd2014-08-14 06:42:36 -0400772 CONFIG_CMD_BOOTI * ARM64 Linux kernel Image support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500773 CONFIG_CMD_CACHE * icache, dcache
774 CONFIG_CMD_CONSOLE coninfo
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500775 CONFIG_CMD_DHCP * DHCP support
776 CONFIG_CMD_DIAG * Diagnostics
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500777 CONFIG_CMD_ECHO echo arguments
Peter Tyser0deafa22009-10-25 15:12:56 -0500778 CONFIG_CMD_EDITENV edit env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500779 CONFIG_CMD_ELF * bootelf, bootvx
Andrew Ruder94463402013-10-22 19:07:34 -0500780 CONFIG_CMD_ENV_EXISTS * check existence of env variable
Mike Frysingerf3ddf202010-12-26 23:09:45 -0500781 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren4f8662d2012-10-22 06:43:50 +0000782 CONFIG_CMD_EXT2 * ext2 command support
783 CONFIG_CMD_EXT4 * ext4 command support
Stephen Warren3d5a3882014-01-24 20:46:37 -0700784 CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls)
785 that work for multiple fs types
Christian Gmeiner9f9eec32014-11-12 14:35:04 +0100786 CONFIG_CMD_FS_UUID * Look up a filesystem UUID
Mike Frysinger78dcaf42009-01-28 19:08:14 -0500787 CONFIG_CMD_SAVEENV saveenv
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500788 CONFIG_CMD_FLASH flinfo, erase, protect
789 CONFIG_CMD_FPGA FPGA device initialization support
Mike Frysinger2ed02412010-12-26 23:32:22 -0500790 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsf0c9d532011-04-05 07:15:14 +0000791 CONFIG_CMD_GREPENV * search environment
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500792 CONFIG_CMD_I2C * I2C serial bus support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500793 CONFIG_CMD_IMI iminfo
Vipin Kumar3df41b12012-12-16 22:32:48 +0000794 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200795 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Mike Frysingerf3ddf202010-12-26 23:09:45 -0500796 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershberger0fd32d72012-10-03 11:15:51 +0000797 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500798 CONFIG_CMD_ITEST Integer/string test of 2 values
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200799 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerb35a3a62012-05-23 08:00:12 +0000800 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
801 (169.254.*.*)
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500802 CONFIG_CMD_LOADB loadb
803 CONFIG_CMD_LOADS loads
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200804 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz93d6cb02009-07-27 00:07:59 -0400805 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glasseacd14f2012-11-30 13:01:20 +0000806 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500807 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denk9d009282013-03-08 10:51:32 +0000808 loop, loopw
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200809 CONFIG_CMD_MEMTEST * mtest
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500810 CONFIG_CMD_MISC Misc functions like sleep etc
811 CONFIG_CMD_MMC * MMC memory mapped support
812 CONFIG_CMD_MII * MII utility commands
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500813 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200814 CONFIG_CMD_NFS NFS support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500815 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
816 host
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500817 CONFIG_CMD_RUN run command in env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500818 CONFIG_CMD_SDRAM * print SDRAM configuration information
819 (requires CONFIG_CMD_I2C)
Eric Nelson97f5f8f2012-01-31 10:52:08 -0700820 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Bob Liua671b702013-02-05 19:05:41 +0800821 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk85c25df2009-04-01 23:34:12 +0200822 CONFIG_CMD_SOURCE "source" command Support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500823 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7aa81a42011-05-17 00:03:40 +0000824 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass6a398d22011-10-24 18:00:07 +0000825 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershberger59f3f522012-10-03 12:14:57 +0000826 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
827 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500828 CONFIG_CMD_USB * USB support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500829 CONFIG_CMD_CDP * Cisco Discover Protocol support
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200830 CONFIG_CMD_XIMG Load part of Multi Image
Przemyslaw Marczak2eb40ee2014-04-02 10:20:05 +0200831 CONFIG_CMD_UUID * Generate random UUID or GUID string
wdenkc6097192002-11-03 00:24:07 +0000832
833 EXAMPLE: If you want all functions except of network
834 support you can write:
835
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500836 #include "config_cmd_all.h"
837 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000838
Gerald Van Barend6abef42007-03-31 12:23:51 -0400839 Other Commands:
840 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000841
842 Note: Don't enable the "icache" and "dcache" commands
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500843 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk4a5c8a72003-03-06 00:02:04 +0000844 what you (and your U-Boot users) are doing. Data
Heiko Schocher65d94db2017-06-07 17:33:09 +0200845 cache cannot be enabled on systems like the
Christophe Leroy069fa832017-07-06 10:23:22 +0200846 8xx (where accesses to the IMMR region must be
wdenk4a5c8a72003-03-06 00:02:04 +0000847 uncached), and it cannot be disabled on all other
848 systems where we (mis-) use the data cache to hold an
849 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000850
851
852 XXX - this list needs to get updated!
853
Simon Glassaa34ef22016-03-13 19:07:28 -0600854- Removal of commands
855 If no commands are needed to boot, you can disable
856 CONFIG_CMDLINE to remove them. In this case, the command line
857 will not be available, and when U-Boot wants to execute the
858 boot command (on start-up) it will call board_run_command()
859 instead. This can reduce image size significantly for very
860 simple boot procedures.
861
Wolfgang Denk2aceea12013-03-23 23:50:31 +0000862- Regular expression support:
863 CONFIG_REGEX
Wolfgang Denkec7fbf52013-10-04 17:43:24 +0200864 If this variable is defined, U-Boot is linked against
865 the SLRE (Super Light Regular Expression) library,
866 which adds regex support to some commands, as for
867 example "env grep" and "setexpr".
Wolfgang Denk2aceea12013-03-23 23:50:31 +0000868
Simon Glass3d686442011-10-15 05:48:20 +0000869- Device tree:
870 CONFIG_OF_CONTROL
871 If this variable is defined, U-Boot will use a device tree
872 to configure its devices, instead of relying on statically
873 compiled #defines in the board file. This option is
874 experimental and only available on a few boards. The device
875 tree is available in the global data as gd->fdt_blob.
876
Simon Glass5cb34db2011-10-24 19:15:31 +0000877 U-Boot needs to get its device tree from somewhere. This can
Alex Deymo5b661ec2017-04-02 01:25:20 -0700878 be done using one of the three options below:
Simon Glass38d6b8d2011-10-15 05:48:21 +0000879
880 CONFIG_OF_EMBED
881 If this variable is defined, U-Boot will embed a device tree
882 binary in its image. This device tree file should be in the
883 board directory and called <soc>-<board>.dts. The binary file
884 is then picked up in board_init_f() and made available through
885 the global data structure as gd->blob.
Simon Glass3d686442011-10-15 05:48:20 +0000886
Simon Glass5cb34db2011-10-24 19:15:31 +0000887 CONFIG_OF_SEPARATE
888 If this variable is defined, U-Boot will build a device tree
889 binary. It will be called u-boot.dtb. Architecture-specific
890 code will locate it at run-time. Generally this works by:
891
892 cat u-boot.bin u-boot.dtb >image.bin
893
894 and in fact, U-Boot does this for you, creating a file called
895 u-boot-dtb.bin which is useful in the common case. You can
896 still use the individual files if you need something more
897 exotic.
898
Alex Deymo5b661ec2017-04-02 01:25:20 -0700899 CONFIG_OF_BOARD
900 If this variable is defined, U-Boot will use the device tree
901 provided by the board at runtime instead of embedding one with
902 the image. Only boards defining board_fdt_blob_setup() support
903 this option (see include/fdtdec.h file).
904
wdenkc6097192002-11-03 00:24:07 +0000905- Watchdog:
906 CONFIG_WATCHDOG
907 If this variable is defined, it enables watchdog
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +0000908 support for the SoC. There must be support in the SoC
Christophe Leroy069fa832017-07-06 10:23:22 +0200909 specific code for a watchdog. For the 8xx
910 CPUs, the SIU Watchdog feature is enabled in the SYPCR
911 register. When supported for a specific SoC is
912 available, then no further board specific code should
913 be needed to use it.
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +0000914
915 CONFIG_HW_WATCHDOG
916 When using a watchdog circuitry external to the used
917 SoC, then define this variable and provide board
918 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000919
Heiko Schocher735326c2015-01-21 08:38:22 +0100920 CONFIG_AT91_HW_WDT_TIMEOUT
921 specify the timeout in seconds. default 2 seconds.
922
stroeseb9c17c52003-04-04 15:53:41 +0000923- U-Boot Version:
924 CONFIG_VERSION_VARIABLE
925 If this variable is defined, an environment variable
926 named "ver" is created by U-Boot showing the U-Boot
927 version as printed by the "version" command.
Benoît Thébaudeauce9a1552012-08-13 15:01:14 +0200928 Any change to this variable will be reverted at the
929 next reset.
stroeseb9c17c52003-04-04 15:53:41 +0000930
wdenkc6097192002-11-03 00:24:07 +0000931- Real-Time Clock:
932
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500933 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000934 has to be selected, too. Define exactly one of the
935 following options:
936
wdenkc6097192002-11-03 00:24:07 +0000937 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam3f8d1782011-10-24 06:44:15 +0000938 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +0000939 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1fe2c702003-03-06 21:55:29 +0000940 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000941 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk0893c472003-05-20 14:25:27 +0000942 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel90491f22014-07-21 11:06:16 +0200943 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenkef5fe752003-03-12 10:41:04 +0000944 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krillb27939b2008-03-15 15:40:26 +0100945 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenkaeba06f2004-06-09 17:34:58 +0000946 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Chris Packham2d3ac512017-05-30 12:03:33 +1200947 CONFIG_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher1f1b7012011-03-28 09:24:22 +0200948 CONFIG_SYS_RV3029_TCR - enable trickle charger on
949 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +0000950
wdenkb9bbd242003-06-30 16:24:52 +0000951 Note that if the RTC uses I2C, then the I2C interface
952 must also be configured. See I2C Support, below.
953
Peter Tyser9902e422008-12-17 16:36:21 -0600954- GPIO Support:
955 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tyser9902e422008-12-17 16:36:21 -0600956
Chris Packham9b383202010-12-19 10:12:13 +0000957 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
958 chip-ngpio pairs that tell the PCA953X driver the number of
959 pins supported by a particular chip.
960
Peter Tyser9902e422008-12-17 16:36:21 -0600961 Note that if the GPIO device uses I2C, then the I2C interface
962 must also be configured. See I2C Support, below.
963
Simon Glass4dc47ca2014-06-11 23:29:41 -0600964- I/O tracing:
965 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
966 accesses and can checksum them or write a list of them out
967 to memory. See the 'iotrace' command for details. This is
968 useful for testing device drivers since it can confirm that
969 the driver behaves the same way before and after a code
970 change. Currently this is supported on sandbox and arm. To
971 add support for your architecture, add '#include <iotrace.h>'
972 to the bottom of arch/<arch>/include/asm/io.h and test.
973
974 Example output from the 'iotrace stats' command is below.
975 Note that if the trace buffer is exhausted, the checksum will
976 still continue to operate.
977
978 iotrace is enabled
979 Start: 10000000 (buffer start address)
980 Size: 00010000 (buffer size)
981 Offset: 00000120 (current buffer offset)
982 Output: 10000120 (start + offset)
983 Count: 00000018 (number of trace records)
984 CRC32: 9526fb66 (CRC32 of all trace records)
985
wdenkc6097192002-11-03 00:24:07 +0000986- Timestamp Support:
987
wdenk4a5c8a72003-03-06 00:02:04 +0000988 When CONFIG_TIMESTAMP is selected, the timestamp
989 (date and time) of an image is printed by image
990 commands like bootm or iminfo. This option is
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500991 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000992
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +0000993- Partition Labels (disklabels) Supported:
994 Zero or more of the following:
995 CONFIG_MAC_PARTITION Apple's MacOS partition table.
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +0000996 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
997 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
998 bootloader. Note 2TB partition limit; see
999 disk/part_efi.c
1000 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001001
Simon Glassb569a012017-05-17 03:25:30 -06001002 If IDE or SCSI support is enabled (CONFIG_IDE or
Simon Glass8706b812016-05-01 11:36:02 -06001003 CONFIG_SCSI) you must configure support for at
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001004 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001005
1006- IDE Reset method:
wdenk369d43d2004-03-14 14:09:05 +00001007 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1008 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001009
wdenk369d43d2004-03-14 14:09:05 +00001010 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1011 be performed by calling the function
1012 ide_set_reset(int reset)
1013 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001014
1015- ATAPI Support:
1016 CONFIG_ATAPI
1017
1018 Set this to enable ATAPI support.
1019
wdenkf602aa02004-03-13 23:29:43 +00001020- LBA48 Support
1021 CONFIG_LBA48
1022
1023 Set this to enable support for disks larger than 137GB
Heiko Schocher0f602e12009-12-03 11:21:21 +01001024 Also look at CONFIG_SYS_64BIT_LBA.
wdenkf602aa02004-03-13 23:29:43 +00001025 Whithout these , LBA48 support uses 32bit variables and will 'only'
1026 support disks up to 2.1TB.
1027
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001028 CONFIG_SYS_64BIT_LBA:
wdenkf602aa02004-03-13 23:29:43 +00001029 When enabled, makes the IDE subsystem use 64bit sector addresses.
1030 Default is 32bit.
1031
wdenkc6097192002-11-03 00:24:07 +00001032- SCSI Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001033 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1034 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1035 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001036 maximum numbers of LUNs, SCSI ID's and target
1037 devices.
wdenkc6097192002-11-03 00:24:07 +00001038
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001039 The environment variable 'scsidevs' is set to the number of
1040 SCSI devices found during the last scan.
Stefan Reinauere50a10e2012-10-29 05:23:48 +00001041
wdenkc6097192002-11-03 00:24:07 +00001042- NETWORK Support (PCI):
wdenk4e112c12003-06-03 23:54:09 +00001043 CONFIG_E1000
Kyle Moffett64b94dd2011-10-18 11:05:29 +00001044 Support for Intel 8254x/8257x gigabit chips.
1045
1046 CONFIG_E1000_SPI
1047 Utility code for direct access to the SPI bus on Intel 8257x.
1048 This does not do anything useful unless you set at least one
1049 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1050
1051 CONFIG_E1000_SPI_GENERIC
1052 Allow generic access to the SPI bus on the Intel 8257x, for
1053 example with the "sspi" command.
1054
1055 CONFIG_CMD_E1000
1056 Management command for E1000 devices. When used on devices
1057 with SPI support you can reprogram the EEPROM from U-Boot.
stroese94ef1cf2003-06-05 15:39:44 +00001058
wdenkc6097192002-11-03 00:24:07 +00001059 CONFIG_EEPRO100
1060 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001061 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001062 write routine for first time initialisation.
1063
1064 CONFIG_TULIP
1065 Support for Digital 2114x chips.
1066 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1067 modem chip initialisation (KS8761/QS6611).
1068
1069 CONFIG_NATSEMI
1070 Support for National dp83815 chips.
1071
1072 CONFIG_NS8382X
1073 Support for National dp8382[01] gigabit chips.
1074
wdenkaa603362003-05-12 21:50:16 +00001075- NETWORK Support (other):
1076
Jens Scharsigdab7cb82010-01-23 12:03:45 +01001077 CONFIG_DRIVER_AT91EMAC
1078 Support for AT91RM9200 EMAC.
1079
1080 CONFIG_RMII
1081 Define this to use reduced MII inteface
1082
1083 CONFIG_DRIVER_AT91EMAC_QUIET
1084 If this defined, the driver is quiet.
1085 The driver doen't show link status messages.
1086
Rob Herringc9830dc2011-12-15 11:15:49 +00001087 CONFIG_CALXEDA_XGMAC
1088 Support for the Calxeda XGMAC device
1089
Ashok93fb8722012-10-15 06:20:47 +00001090 CONFIG_LAN91C96
wdenkaa603362003-05-12 21:50:16 +00001091 Support for SMSC's LAN91C96 chips.
1092
wdenkaa603362003-05-12 21:50:16 +00001093 CONFIG_LAN91C96_USE_32_BIT
1094 Define this to enable 32 bit addressing
1095
Ashok93fb8722012-10-15 06:20:47 +00001096 CONFIG_SMC91111
wdenk3c711762004-06-09 13:37:52 +00001097 Support for SMSC's LAN91C111 chip
1098
1099 CONFIG_SMC91111_BASE
1100 Define this to hold the physical address
1101 of the device (I/O space)
1102
1103 CONFIG_SMC_USE_32_BIT
1104 Define this if data bus is 32 bits
1105
1106 CONFIG_SMC_USE_IOFUNCS
1107 Define this to use i/o functions instead of macros
1108 (some hardware wont work with macros)
1109
Heiko Schocher7d037f72011-11-15 10:00:04 -05001110 CONFIG_DRIVER_TI_EMAC
1111 Support for davinci emac
1112
1113 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1114 Define this if you have more then 3 PHYs.
1115
Macpaul Lin199c6252010-12-21 16:59:46 +08001116 CONFIG_FTGMAC100
1117 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1118
1119 CONFIG_FTGMAC100_EGIGA
1120 Define this to use GE link update with gigabit PHY.
1121 Define this if FTGMAC100 is connected to gigabit PHY.
1122 If your system has 10/100 PHY only, it might not occur
1123 wrong behavior. Because PHY usually return timeout or
1124 useless data when polling gigabit status and gigabit
1125 control registers. This behavior won't affect the
1126 correctnessof 10/100 link speed update.
1127
Mike Rapoportf4761af2009-11-11 10:03:03 +02001128 CONFIG_SMC911X
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001129 Support for SMSC's LAN911x and LAN921x chips
1130
Mike Rapoportf4761af2009-11-11 10:03:03 +02001131 CONFIG_SMC911X_BASE
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001132 Define this to hold the physical address
1133 of the device (I/O space)
1134
Mike Rapoportf4761af2009-11-11 10:03:03 +02001135 CONFIG_SMC911X_32_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001136 Define this if data bus is 32 bits
1137
Mike Rapoportf4761af2009-11-11 10:03:03 +02001138 CONFIG_SMC911X_16_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001139 Define this if data bus is 16 bits. If your processor
1140 automatically converts one 32 bit word to two 16 bit
Mike Rapoportf4761af2009-11-11 10:03:03 +02001141 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001142
Yoshihiro Shimodaed4cea02011-01-27 10:06:03 +09001143 CONFIG_SH_ETHER
1144 Support for Renesas on-chip Ethernet controller
1145
1146 CONFIG_SH_ETHER_USE_PORT
1147 Define the number of ports to be used
1148
1149 CONFIG_SH_ETHER_PHY_ADDR
1150 Define the ETH PHY's address
1151
Yoshihiro Shimoda281aa052011-01-27 10:06:08 +09001152 CONFIG_SH_ETHER_CACHE_WRITEBACK
1153 If this option is set, the driver enables cache flush.
1154
Heiko Schocher2b387762014-07-18 06:07:19 +02001155- PWM Support:
1156 CONFIG_PWM_IMX
Robert P. J. Day1f8378a2016-09-13 08:35:18 -04001157 Support for PWM module on the imx6.
Heiko Schocher2b387762014-07-18 06:07:19 +02001158
Vadim Bendeburydac69642011-10-17 08:36:14 +00001159- TPM Support:
Che-liang Chiouacea5702013-04-12 11:04:34 +00001160 CONFIG_TPM
1161 Support TPM devices.
1162
Christophe Ricard8759ff82015-10-06 22:54:41 +02001163 CONFIG_TPM_TIS_INFINEON
1164 Support for Infineon i2c bus TPM devices. Only one device
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001165 per system is supported at this time.
1166
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001167 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1168 Define the burst count bytes upper limit
1169
Christophe Ricard88249232016-01-21 23:27:13 +01001170 CONFIG_TPM_ST33ZP24
1171 Support for STMicroelectronics TPM devices. Requires DM_TPM support.
1172
1173 CONFIG_TPM_ST33ZP24_I2C
1174 Support for STMicroelectronics ST33ZP24 I2C devices.
1175 Requires TPM_ST33ZP24 and I2C.
1176
Christophe Ricard5ffadc32016-01-21 23:27:14 +01001177 CONFIG_TPM_ST33ZP24_SPI
1178 Support for STMicroelectronics ST33ZP24 SPI devices.
1179 Requires TPM_ST33ZP24 and SPI.
1180
Dirk Eibach20489092013-06-26 15:55:15 +02001181 CONFIG_TPM_ATMEL_TWI
1182 Support for Atmel TWI TPM device. Requires I2C support.
1183
Che-liang Chiouacea5702013-04-12 11:04:34 +00001184 CONFIG_TPM_TIS_LPC
Vadim Bendeburydac69642011-10-17 08:36:14 +00001185 Support for generic parallel port TPM devices. Only one device
1186 per system is supported at this time.
1187
1188 CONFIG_TPM_TIS_BASE_ADDRESS
1189 Base address where the generic TPM device is mapped
1190 to. Contemporary x86 systems usually map it at
1191 0xfed40000.
1192
Reinhard Pfau4fece432013-06-26 15:55:13 +02001193 CONFIG_CMD_TPM
1194 Add tpm monitor functions.
1195 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1196 provides monitor access to authorized functions.
1197
1198 CONFIG_TPM
1199 Define this to enable the TPM support library which provides
1200 functional interfaces to some TPM commands.
1201 Requires support for a TPM device.
1202
1203 CONFIG_TPM_AUTH_SESSIONS
1204 Define this to enable authorized functions in the TPM library.
1205 Requires CONFIG_TPM and CONFIG_SHA1.
1206
wdenkc6097192002-11-03 00:24:07 +00001207- USB Support:
1208 At the moment only the UHCI host controller is
Heiko Schocher6f90e582017-06-14 05:49:40 +02001209 supported (PIP405, MIP405); define
wdenkc6097192002-11-03 00:24:07 +00001210 CONFIG_USB_UHCI to enable it.
1211 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenkfb30b4c2004-10-09 22:44:59 +00001212 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001213 storage devices.
1214 Note:
1215 Supported are USB Keyboards and USB Floppy drives
1216 (TEAC FD-05PUB).
wdenk369d43d2004-03-14 14:09:05 +00001217
Simon Glass5978cdb2012-02-27 10:52:47 +00001218 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1219 txfilltuning field in the EHCI controller on reset.
1220
Oleksandr Tymoshenko7a881752014-02-01 21:51:25 -07001221 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1222 HW module registers.
1223
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001224- USB Device:
1225 Define the below if you wish to use the USB console.
1226 Once firmware is rebuilt from a serial console issue the
1227 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001228 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001229 it has found a new device. The environment variable usbtty
1230 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denke2601822006-06-14 18:14:56 +02001231 appear to a USB host as a Linux gserial device or a
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001232 Common Device Class Abstract Control Model serial device.
1233 If you select usbtty = gserial you should be able to enumerate
1234 a Linux host by
1235 # modprobe usbserial vendor=0xVendorID product=0xProductID
1236 else if using cdc_acm, simply setting the environment
1237 variable usbtty to be cdc_acm should suffice. The following
1238 might be defined in YourBoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001239
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001240 CONFIG_USB_DEVICE
1241 Define this to build a UDC device
1242
1243 CONFIG_USB_TTY
1244 Define this to have a tty type of device available to
1245 talk to the UDC device
Wolfgang Denke2601822006-06-14 18:14:56 +02001246
Vipin KUMARbdb17702012-03-26 15:38:06 +05301247 CONFIG_USBD_HS
1248 Define this to enable the high speed support for usb
1249 device and usbtty. If this feature is enabled, a routine
1250 int is_usbd_high_speed(void)
1251 also needs to be defined by the driver to dynamically poll
1252 whether the enumeration has succeded at high speed or full
1253 speed.
1254
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001255 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001256 Define this if you want stdin, stdout &/or stderr to
1257 be set to usbtty.
1258
Wolfgang Denke2601822006-06-14 18:14:56 +02001259 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001260 define your own vendor specific values either in BoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001261 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001262 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1263 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1264 should pretend to be a Linux device to it's target host.
1265
1266 CONFIG_USBD_MANUFACTURER
1267 Define this string as the name of your company for
1268 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denke2601822006-06-14 18:14:56 +02001269
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001270 CONFIG_USBD_PRODUCT_NAME
1271 Define this string as the name of your product
1272 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
wdenkc6097192002-11-03 00:24:07 +00001273
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001274 CONFIG_USBD_VENDORID
1275 Define this as your assigned Vendor ID from the USB
1276 Implementors Forum. This *must* be a genuine Vendor ID
1277 to avoid polluting the USB namespace.
1278 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001279
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001280 CONFIG_USBD_PRODUCTID
1281 Define this as the unique Product ID
1282 for your device
1283 - CONFIG_USBD_PRODUCTID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001284
Igor Grinbergac5f6ee2011-12-12 12:08:35 +02001285- ULPI Layer Support:
1286 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1287 the generic ULPI layer. The generic layer accesses the ULPI PHY
1288 via the platform viewport, so you need both the genric layer and
1289 the viewport enabled. Currently only Chipidea/ARC based
1290 viewport is supported.
1291 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1292 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stachf31e4112012-10-01 00:44:35 +02001293 If your ULPI phy needs a different reference clock than the
1294 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1295 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001296
wdenk7a428cc2003-06-15 22:40:42 +00001297- MMC Support:
wdenk57b2d802003-06-27 21:31:46 +00001298 The MMC controller on the Intel PXA is supported. To
1299 enable this define CONFIG_MMC. The MMC can be
1300 accessed from the boot prompt by mapping the device
wdenk7a428cc2003-06-15 22:40:42 +00001301 to physical memory similar to flash. Command line is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001302 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1303 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenk7a428cc2003-06-15 22:40:42 +00001304
Yoshihiro Shimodadb7717b2011-07-04 22:21:22 +00001305 CONFIG_SH_MMCIF
1306 Support for Renesas on-chip MMCIF controller
1307
1308 CONFIG_SH_MMCIF_ADDR
1309 Define the base address of MMCIF registers
1310
1311 CONFIG_SH_MMCIF_CLK
1312 Define the clock frequency for MMCIF
1313
Pierre Aubertbcc302c2014-04-24 10:30:08 +02001314 CONFIG_SUPPORT_EMMC_BOOT
1315 Enable some additional features of the eMMC boot partitions.
1316
1317 CONFIG_SUPPORT_EMMC_RPMB
1318 Enable the commands for reading, writing and programming the
1319 key for the Replay Protection Memory Block partition in eMMC.
1320
Tom Rini58a8d322013-03-14 05:32:47 +00001321- USB Device Firmware Update (DFU) class support:
Paul Kocialkowski045d6052015-06-12 19:56:58 +02001322 CONFIG_USB_FUNCTION_DFU
Tom Rini58a8d322013-03-14 05:32:47 +00001323 This enables the USB portion of the DFU USB class
1324
1325 CONFIG_CMD_DFU
1326 This enables the command "dfu" which is used to have
1327 U-Boot create a DFU class device via USB. This command
1328 requires that the "dfu_alt_info" environment variable be
1329 set and define the alt settings to expose to the host.
1330
1331 CONFIG_DFU_MMC
1332 This enables support for exposing (e)MMC devices via DFU.
1333
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +00001334 CONFIG_DFU_NAND
1335 This enables support for exposing NAND devices via DFU.
1336
Afzal Mohammede3c687a2013-09-18 01:15:24 +05301337 CONFIG_DFU_RAM
1338 This enables support for exposing RAM via DFU.
1339 Note: DFU spec refer to non-volatile memory usage, but
1340 allow usages beyond the scope of spec - here RAM usage,
1341 one that would help mostly the developer.
1342
Heiko Schochera2f831e2013-06-12 06:05:51 +02001343 CONFIG_SYS_DFU_DATA_BUF_SIZE
1344 Dfu transfer uses a buffer before writing data to the
1345 raw storage device. Make the size (in bytes) of this buffer
1346 configurable. The size of this buffer is also configurable
1347 through the "dfu_bufsiz" environment variable.
1348
Pantelis Antonioua6e788d2013-03-14 05:32:48 +00001349 CONFIG_SYS_DFU_MAX_FILE_SIZE
1350 When updating files rather than the raw storage device,
1351 we use a static buffer to copy the file into and then write
1352 the buffer once we've been given the whole file. Define
1353 this to the maximum filesize (in bytes) for the buffer.
1354 Default is 4 MiB if undefined.
1355
Heiko Schochere1ba1512014-03-18 08:09:56 +01001356 DFU_DEFAULT_POLL_TIMEOUT
1357 Poll timeout [ms], is the timeout a device can send to the
1358 host. The host must wait for this timeout before sending
1359 a subsequent DFU_GET_STATUS request to the device.
1360
1361 DFU_MANIFEST_POLL_TIMEOUT
1362 Poll timeout [ms], which the device sends to the host when
1363 entering dfuMANIFEST state. Host waits this timeout, before
1364 sending again an USB request to the device.
1365
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001366- USB Device Android Fastboot support:
Paul Kocialkowskid55acc02015-06-12 19:56:59 +02001367 CONFIG_USB_FUNCTION_FASTBOOT
1368 This enables the USB part of the fastboot gadget
1369
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001370 CONFIG_CMD_FASTBOOT
1371 This enables the command "fastboot" which enables the Android
1372 fastboot mode for the platform's USB device. Fastboot is a USB
1373 protocol for downloading images, flashing and device control
1374 used on Android devices.
1375 See doc/README.android-fastboot for more information.
1376
1377 CONFIG_ANDROID_BOOT_IMAGE
1378 This enables support for booting images which use the Android
1379 image format header.
1380
Paul Kocialkowskif84f0912015-07-20 12:38:22 +02001381 CONFIG_FASTBOOT_BUF_ADDR
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001382 The fastboot protocol requires a large memory buffer for
1383 downloads. Define this to the starting RAM address to use for
1384 downloaded images.
1385
Paul Kocialkowskif84f0912015-07-20 12:38:22 +02001386 CONFIG_FASTBOOT_BUF_SIZE
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001387 The fastboot protocol requires a large memory buffer for
1388 downloads. This buffer should be as large as possible for a
1389 platform. Define this to the size available RAM for fastboot.
1390
Steve Raebfb9ba42014-08-26 11:47:28 -07001391 CONFIG_FASTBOOT_FLASH
1392 The fastboot protocol includes a "flash" command for writing
1393 the downloaded image to a non-volatile storage device. Define
1394 this to enable the "fastboot flash" command.
1395
1396 CONFIG_FASTBOOT_FLASH_MMC_DEV
1397 The fastboot "flash" command requires additional information
1398 regarding the non-volatile storage device. Define this to
1399 the eMMC device that fastboot should use to store the image.
1400
Steve Rae7d059342014-12-12 15:51:54 -08001401 CONFIG_FASTBOOT_GPT_NAME
1402 The fastboot "flash" command supports writing the downloaded
1403 image to the Protective MBR and the Primary GUID Partition
1404 Table. (Additionally, this downloaded image is post-processed
1405 to generate and write the Backup GUID Partition Table.)
1406 This occurs when the specified "partition name" on the
1407 "fastboot flash" command line matches this value.
Petr Kulhavy4ed1eca2016-09-09 10:27:18 +02001408 The default is "gpt" if undefined.
Steve Rae7d059342014-12-12 15:51:54 -08001409
Petr Kulhavy9f174c92016-09-09 10:27:16 +02001410 CONFIG_FASTBOOT_MBR_NAME
1411 The fastboot "flash" command supports writing the downloaded
1412 image to DOS MBR.
1413 This occurs when the "partition name" specified on the
1414 "fastboot flash" command line matches this value.
1415 If not defined the default value "mbr" is used.
1416
wdenkda04a8b2004-08-02 23:22:59 +00001417- Journaling Flash filesystem support:
Simon Glassfa8527b2016-10-02 18:00:59 -06001418 CONFIG_JFFS2_NAND
wdenkda04a8b2004-08-02 23:22:59 +00001419 Define these for a default partition on a NAND device
1420
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001421 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1422 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenkda04a8b2004-08-02 23:22:59 +00001423 Define these for a default partition on a NOR device
1424
wdenkc6097192002-11-03 00:24:07 +00001425- Keyboard Support:
Simon Glasseaba37e2015-11-11 10:05:47 -07001426 See Kconfig help for available keyboard drivers.
1427
1428 CONFIG_KEYBOARD
1429
1430 Define this to enable a custom keyboard support.
1431 This simply calls drv_keyboard_init() which must be
1432 defined in your board-specific files. This option is deprecated
1433 and is only used by novena. For new boards, use driver model
1434 instead.
wdenkc6097192002-11-03 00:24:07 +00001435
1436- Video support:
Timur Tabi020edd22011-02-15 17:09:19 -06001437 CONFIG_FSL_DIU_FB
Wolfgang Denk825223d2011-09-11 21:24:09 +02001438 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi020edd22011-02-15 17:09:19 -06001439 SOCs that have a DIU should define this macro to enable DIU
1440 support, and should also define these other macros:
1441
1442 CONFIG_SYS_DIU_ADDR
1443 CONFIG_VIDEO
Timur Tabi020edd22011-02-15 17:09:19 -06001444 CONFIG_CFB_CONSOLE
1445 CONFIG_VIDEO_SW_CURSOR
1446 CONFIG_VGA_AS_SINGLE_DEVICE
1447 CONFIG_VIDEO_LOGO
1448 CONFIG_VIDEO_BMP_LOGO
1449
Timur Tabi32f709e2011-04-11 14:18:22 -05001450 The DIU driver will look for the 'video-mode' environment
1451 variable, and if defined, enable the DIU as a console during
Fabio Estevamd3ad5e52016-04-02 11:53:18 -03001452 boot. See the documentation file doc/README.video for a
Timur Tabi32f709e2011-04-11 14:18:22 -05001453 description of this variable.
Timur Tabi020edd22011-02-15 17:09:19 -06001454
wdenkc6097192002-11-03 00:24:07 +00001455- LCD Support: CONFIG_LCD
1456
1457 Define this to enable LCD support (for output to LCD
1458 display); also select one of the supported displays
1459 by defining one of these:
1460
Stelian Popf6f86652008-05-09 21:57:18 +02001461 CONFIG_ATMEL_LCD:
1462
1463 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1464
wdenkc0d54ae2003-11-25 16:55:19 +00001465 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001466
wdenkc0d54ae2003-11-25 16:55:19 +00001467 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001468
wdenkc0d54ae2003-11-25 16:55:19 +00001469 CONFIG_NEC_NL6448BC20
1470
1471 NEC NL6448BC20-08. 6.5", 640x480.
1472 Active, color, single scan.
1473
1474 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +00001475
wdenkc0d54ae2003-11-25 16:55:19 +00001476 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001477 Active, color, single scan.
1478
1479 CONFIG_SHARP_16x9
1480
1481 Sharp 320x240. Active, color, single scan.
1482 It isn't 16x9, and I am not sure what it is.
1483
1484 CONFIG_SHARP_LQ64D341
1485
1486 Sharp LQ64D341 display, 640x480.
1487 Active, color, single scan.
1488
1489 CONFIG_HLD1045
1490
1491 HLD1045 display, 640x480.
1492 Active, color, single scan.
1493
1494 CONFIG_OPTREX_BW
1495
1496 Optrex CBL50840-2 NF-FW 99 22 M5
1497 or
1498 Hitachi LMG6912RPFC-00T
1499 or
1500 Hitachi SP14Q002
1501
1502 320x240. Black & white.
1503
Simon Glass599a4df2012-10-17 13:24:54 +00001504 CONFIG_LCD_ALIGNMENT
1505
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001506 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass599a4df2012-10-17 13:24:54 +00001507 defined then the LCD will be aligned to this value instead.
1508 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1509 here, since it is cheaper to change data cache settings on
1510 a per-section basis.
1511
1512
Hannes Petermaiera3c8e862015-03-27 08:01:38 +01001513 CONFIG_LCD_ROTATION
1514
1515 Sometimes, for example if the display is mounted in portrait
1516 mode or even if it's mounted landscape but rotated by 180degree,
1517 we need to rotate our content of the display relative to the
1518 framebuffer, so that user can read the messages which are
1519 printed out.
1520 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1521 initialized with a given rotation from "vl_rot" out of
1522 "vidinfo_t" which is provided by the board specific code.
1523 The value for vl_rot is coded as following (matching to
1524 fbcon=rotate:<n> linux-kernel commandline):
1525 0 = no rotation respectively 0 degree
1526 1 = 90 degree rotation
1527 2 = 180 degree rotation
1528 3 = 270 degree rotation
1529
1530 If CONFIG_LCD_ROTATION is not defined, the console will be
1531 initialized with 0degree rotation.
1532
Tom Wai-Hong Tam79926a42012-09-28 15:11:16 +00001533 CONFIG_LCD_BMP_RLE8
1534
1535 Support drawing of RLE8-compressed bitmaps on the LCD.
1536
Tom Wai-Hong Tam6664f202012-12-05 14:46:40 +00001537 CONFIG_I2C_EDID
1538
1539 Enables an 'i2c edid' command which can read EDID
1540 information over I2C from an attached LCD display.
1541
wdenkeb20ad32003-09-05 23:19:14 +00001542- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenk92bbe3f2003-04-20 14:04:18 +00001543
wdenk57b2d802003-06-27 21:31:46 +00001544 If this option is set, the environment is checked for
1545 a variable "splashimage". If found, the usual display
1546 of logo, copyright and system information on the LCD
wdenk01686632004-06-30 22:59:18 +00001547 is suppressed and the BMP image at the address
wdenk57b2d802003-06-27 21:31:46 +00001548 specified in "splashimage" is loaded instead. The
1549 console is redirected to the "nulldev", too. This
1550 allows for a "silent" boot where a splash screen is
1551 loaded very quickly after power-on.
wdenk92bbe3f2003-04-20 14:04:18 +00001552
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001553 CONFIG_SPLASHIMAGE_GUARD
1554
1555 If this option is set, then U-Boot will prevent the environment
1556 variable "splashimage" from being set to a problematic address
Fabio Estevama58b4912016-03-23 12:46:12 -03001557 (see doc/README.displaying-bmps).
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001558 This option is useful for targets where, due to alignment
1559 restrictions, an improperly aligned BMP image will cause a data
1560 abort. If you think you will not have problems with unaligned
1561 accesses (for example because your toolchain prevents them)
1562 there is no need to set this option.
1563
Matthias Weisser53884182009-07-09 16:07:30 +02001564 CONFIG_SPLASH_SCREEN_ALIGN
1565
1566 If this option is set the splash image can be freely positioned
1567 on the screen. Environment variable "splashpos" specifies the
1568 position as "x,y". If a positive number is given it is used as
1569 number of pixel from left/top. If a negative number is given it
1570 is used as number of pixel from right/bottom. You can also
1571 specify 'm' for centering the image.
1572
1573 Example:
1574 setenv splashpos m,m
1575 => image at center of screen
1576
1577 setenv splashpos 30,20
1578 => image at x = 30 and y = 20
1579
1580 setenv splashpos -10,m
1581 => vertically centered image
1582 at x = dspWidth - bmpWidth - 9
1583
Stefan Roesed9d97742005-09-22 09:04:17 +02001584- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1585
1586 If this option is set, additionally to standard BMP
1587 images, gzipped BMP images can be displayed via the
1588 splashscreen support or the bmp command.
1589
Anatolij Gustschin6b4e4fc2010-03-15 14:50:25 +01001590- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1591
1592 If this option is set, 8-bit RLE compressed BMP images
1593 can be displayed via the splashscreen support or the
1594 bmp command.
1595
wdenk710e3502003-08-29 20:57:53 +00001596- Compression support:
Kees Cook5b06e642013-08-16 07:59:12 -07001597 CONFIG_GZIP
1598
1599 Enabled by default to support gzip compressed images.
1600
wdenk710e3502003-08-29 20:57:53 +00001601 CONFIG_BZIP2
1602
1603 If this option is set, support for bzip2 compressed
1604 images is included. If not, only uncompressed and gzip
1605 compressed images are supported.
1606
wdenk9c53f402003-10-15 23:53:47 +00001607 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001608 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk9c53f402003-10-15 23:53:47 +00001609 be at least 4MB.
wdenk92bbe3f2003-04-20 14:04:18 +00001610
wdenk0e2bd9c2004-06-06 21:51:03 +00001611- MII/PHY support:
1612 CONFIG_PHY_ADDR
1613
1614 The address of PHY on MII bus.
1615
1616 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1617
1618 The clock frequency of the MII bus
1619
wdenk0e2bd9c2004-06-06 21:51:03 +00001620 CONFIG_PHY_RESET_DELAY
1621
1622 Some PHY like Intel LXT971A need extra delay after
1623 reset before any MII register access is possible.
1624 For such PHY, set this option to the usec delay
1625 required. (minimum 300usec for LXT971A)
1626
1627 CONFIG_PHY_CMD_DELAY (ppc4xx)
1628
1629 Some PHY like Intel LXT971A need extra delay after
1630 command issued before MII status register can be read
1631
wdenkc6097192002-11-03 00:24:07 +00001632- IP address:
1633 CONFIG_IPADDR
1634
1635 Define a default value for the IP address to use for
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001636 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001637 determined through e.g. bootp.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001638 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001639
1640- Server IP address:
1641 CONFIG_SERVERIP
1642
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001643 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001644 server to contact when using the "tftboot" command.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001645 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001646
Robin Getz470a6d42009-07-21 12:15:28 -04001647 CONFIG_KEEP_SERVERADDR
1648
1649 Keeps the server's MAC address, in the env 'serveraddr'
1650 for passing to bootargs (like Linux's netconsole option)
1651
Wolfgang Denk26da2992011-10-26 10:21:22 +00001652- Gateway IP address:
1653 CONFIG_GATEWAYIP
1654
1655 Defines a default value for the IP address of the
1656 default router where packets to other networks are
1657 sent to.
1658 (Environment variable "gatewayip")
1659
1660- Subnet mask:
1661 CONFIG_NETMASK
1662
1663 Defines a default value for the subnet mask (or
1664 routing prefix) which is used to determine if an IP
1665 address belongs to the local subnet or needs to be
1666 forwarded through a router.
1667 (Environment variable "netmask")
1668
David Updegraff7280da72007-06-11 10:41:07 -05001669- Multicast TFTP Mode:
1670 CONFIG_MCAST_TFTP
1671
1672 Defines whether you want to support multicast TFTP as per
1673 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001674 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff7280da72007-06-11 10:41:07 -05001675 driver in use must provide a function: mcast() to join/leave a
1676 multicast group.
1677
wdenkc6097192002-11-03 00:24:07 +00001678- BOOTP Recovery Mode:
1679 CONFIG_BOOTP_RANDOM_DELAY
1680
1681 If you have many targets in a network that try to
1682 boot using BOOTP, you may want to avoid that all
1683 systems send out BOOTP requests at precisely the same
1684 moment (which would happen for instance at recovery
1685 from a power failure, when all systems will try to
1686 boot, thus flooding the BOOTP server. Defining
1687 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1688 inserted before sending out BOOTP requests. The
Wolfgang Denkb65aaf92007-08-06 23:21:05 +02001689 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001690
1691 1st BOOTP request: delay 0 ... 1 sec
1692 2nd BOOTP request: delay 0 ... 2 sec
1693 3rd BOOTP request: delay 0 ... 4 sec
1694 4th and following
1695 BOOTP requests: delay 0 ... 8 sec
1696
Thierry Reding8977cda2014-08-19 10:21:24 +02001697 CONFIG_BOOTP_ID_CACHE_SIZE
1698
1699 BOOTP packets are uniquely identified using a 32-bit ID. The
1700 server will copy the ID from client requests to responses and
1701 U-Boot will use this to determine if it is the destination of
1702 an incoming response. Some servers will check that addresses
1703 aren't in use before handing them out (usually using an ARP
1704 ping) and therefore take up to a few hundred milliseconds to
1705 respond. Network congestion may also influence the time it
1706 takes for a response to make it back to the client. If that
1707 time is too long, U-Boot will retransmit requests. In order
1708 to allow earlier responses to still be accepted after these
1709 retransmissions, U-Boot's BOOTP client keeps a small cache of
1710 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
1711 cache. The default is to keep IDs for up to four outstanding
1712 requests. Increasing this will allow U-Boot to accept offers
1713 from a BOOTP client in networks with unusually high latency.
1714
stroesee0aadfb2003-08-28 14:17:32 +00001715- DHCP Advanced Options:
Jon Loeliger5336a762007-07-09 22:08:34 -05001716 You can fine tune the DHCP functionality by defining
1717 CONFIG_BOOTP_* symbols:
stroesee0aadfb2003-08-28 14:17:32 +00001718
Jon Loeliger5336a762007-07-09 22:08:34 -05001719 CONFIG_BOOTP_SUBNETMASK
1720 CONFIG_BOOTP_GATEWAY
1721 CONFIG_BOOTP_HOSTNAME
1722 CONFIG_BOOTP_NISDOMAIN
1723 CONFIG_BOOTP_BOOTPATH
1724 CONFIG_BOOTP_BOOTFILESIZE
1725 CONFIG_BOOTP_DNS
1726 CONFIG_BOOTP_DNS2
1727 CONFIG_BOOTP_SEND_HOSTNAME
1728 CONFIG_BOOTP_NTPSERVER
1729 CONFIG_BOOTP_TIMEOFFSET
1730 CONFIG_BOOTP_VENDOREX
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001731 CONFIG_BOOTP_MAY_FAIL
stroesee0aadfb2003-08-28 14:17:32 +00001732
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001733 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1734 environment variable, not the BOOTP server.
stroesee0aadfb2003-08-28 14:17:32 +00001735
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001736 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1737 after the configured retry count, the call will fail
1738 instead of starting over. This can be used to fail over
1739 to Link-local IP address configuration if the DHCP server
1740 is not available.
1741
stroesee0aadfb2003-08-28 14:17:32 +00001742 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1743 serverip from a DHCP server, it is possible that more
1744 than one DNS serverip is offered to the client.
1745 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1746 serverip will be stored in the additional environment
1747 variable "dnsip2". The first DNS serverip is always
1748 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger5336a762007-07-09 22:08:34 -05001749 is defined.
stroesee0aadfb2003-08-28 14:17:32 +00001750
1751 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1752 to do a dynamic update of a DNS server. To do this, they
1753 need the hostname of the DHCP requester.
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001754 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger5336a762007-07-09 22:08:34 -05001755 of the "hostname" environment variable is passed as
1756 option 12 to the DHCP server.
stroesee0aadfb2003-08-28 14:17:32 +00001757
Aras Vaichas72aa3f32008-03-26 09:43:57 +11001758 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1759
1760 A 32bit value in microseconds for a delay between
1761 receiving a "DHCP Offer" and sending the "DHCP Request".
1762 This fixes a problem with certain DHCP servers that don't
1763 respond 100% of the time to a "DHCP request". E.g. On an
1764 AT91RM9200 processor running at 180MHz, this delay needed
1765 to be *at least* 15,000 usec before a Windows Server 2003
1766 DHCP server would reply 100% of the time. I recommend at
1767 least 50,000 usec to be safe. The alternative is to hope
1768 that one of the retries will be successful but note that
1769 the DHCP timeout and retry process takes a longer than
1770 this delay.
1771
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00001772 - Link-local IP address negotiation:
1773 Negotiate with other link-local clients on the local network
1774 for an address that doesn't require explicit configuration.
1775 This is especially useful if a DHCP server cannot be guaranteed
1776 to exist in all environments that the device must operate.
1777
1778 See doc/README.link-local for more information.
1779
wdenk145d2c12004-04-15 21:48:45 +00001780 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00001781 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00001782
1783 The device id used in CDP trigger frames.
1784
1785 CONFIG_CDP_DEVICE_ID_PREFIX
1786
1787 A two character string which is prefixed to the MAC address
1788 of the device.
1789
1790 CONFIG_CDP_PORT_ID
1791
1792 A printf format string which contains the ascii name of
1793 the port. Normally is set to "eth%d" which sets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001794 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-04-15 21:48:45 +00001795
1796 CONFIG_CDP_CAPABILITIES
1797
1798 A 32bit integer which indicates the device capabilities;
1799 0x00000010 for a normal host which does not forwards.
1800
1801 CONFIG_CDP_VERSION
1802
1803 An ascii string containing the version of the software.
1804
1805 CONFIG_CDP_PLATFORM
1806
1807 An ascii string containing the name of the platform.
1808
1809 CONFIG_CDP_TRIGGER
1810
1811 A 32bit integer sent on the trigger.
1812
1813 CONFIG_CDP_POWER_CONSUMPTION
1814
1815 A 16bit integer containing the power consumption of the
1816 device in .1 of milliwatts.
1817
1818 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1819
1820 A byte containing the id of the VLAN.
1821
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001822- Status LED: CONFIG_LED_STATUS
wdenkc6097192002-11-03 00:24:07 +00001823
1824 Several configurations allow to display the current
1825 status using a LED. For instance, the LED will blink
1826 fast while running U-Boot code, stop blinking as
1827 soon as a reply to a BOOTP request was received, and
1828 start blinking slow once the Linux kernel is running
1829 (supported by a status LED driver in the Linux
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001830 kernel). Defining CONFIG_LED_STATUS enables this
wdenkc6097192002-11-03 00:24:07 +00001831 feature in U-Boot.
1832
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001833 Additional options:
1834
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001835 CONFIG_LED_STATUS_GPIO
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001836 The status LED can be connected to a GPIO pin.
1837 In such cases, the gpio_led driver can be used as a
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001838 status LED backend implementation. Define CONFIG_LED_STATUS_GPIO
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001839 to include the gpio_led driver in the U-Boot binary.
1840
Igor Grinberg203bd9f2013-11-08 01:03:52 +02001841 CONFIG_GPIO_LED_INVERTED_TABLE
1842 Some GPIO connected LEDs may have inverted polarity in which
1843 case the GPIO high value corresponds to LED off state and
1844 GPIO low value corresponds to LED on state.
1845 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
1846 with a list of GPIO LEDs that have inverted polarity.
1847
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001848- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00001849
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001850 This enable the NEW i2c subsystem, and will allow you to use
1851 i2c commands at the u-boot command line (as long as you set
1852 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
1853 based realtime clock chips or other i2c devices. See
1854 common/cmd_i2c.c for a description of the command line
1855 interface.
1856
1857 ported i2c driver to the new framework:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01001858 - drivers/i2c/soft_i2c.c:
1859 - activate first bus with CONFIG_SYS_I2C_SOFT define
1860 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
1861 for defining speed and slave address
1862 - activate second bus with I2C_SOFT_DECLARATIONS2 define
1863 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
1864 for defining speed and slave address
1865 - activate third bus with I2C_SOFT_DECLARATIONS3 define
1866 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
1867 for defining speed and slave address
1868 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
1869 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
1870 for defining speed and slave address
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001871
Heiko Schocherf2850742012-10-24 13:48:22 +02001872 - drivers/i2c/fsl_i2c.c:
1873 - activate i2c driver with CONFIG_SYS_I2C_FSL
1874 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
1875 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
1876 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
1877 bus.
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001878 - If your board supports a second fsl i2c bus, define
Heiko Schocherf2850742012-10-24 13:48:22 +02001879 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
1880 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
1881 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
1882 second bus.
1883
Simon Glass026fefb2012-10-30 07:28:53 +00001884 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu045acfa2013-10-11 16:23:53 +09001885 - activate this driver with CONFIG_SYS_I2C_TEGRA
1886 - This driver adds 4 i2c buses with a fix speed from
1887 100000 and the slave addr 0!
Simon Glass026fefb2012-10-30 07:28:53 +00001888
Dirk Eibach42b204f2013-04-25 02:40:01 +00001889 - drivers/i2c/ppc4xx_i2c.c
1890 - activate this driver with CONFIG_SYS_I2C_PPC4XX
1891 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
1892 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
1893
trema49f40a2013-09-21 18:13:35 +02001894 - drivers/i2c/i2c_mxc.c
1895 - activate this driver with CONFIG_SYS_I2C_MXC
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02001896 - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
1897 - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
1898 - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
1899 - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
trema49f40a2013-09-21 18:13:35 +02001900 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
1901 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
1902 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
1903 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
1904 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
1905 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02001906 - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
1907 - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001908 If those defines are not set, default value is 100000
trema49f40a2013-09-21 18:13:35 +02001909 for speed, and 0 for slave.
1910
Nobuhiro Iwamatsue94ea2f2013-09-27 16:58:30 +09001911 - drivers/i2c/rcar_i2c.c:
1912 - activate this driver with CONFIG_SYS_I2C_RCAR
1913 - This driver adds 4 i2c buses
1914
1915 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
1916 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
1917 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
1918 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
1919 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
1920 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
1921 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
1922 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
1923 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
1924
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09001925 - drivers/i2c/sh_i2c.c:
1926 - activate this driver with CONFIG_SYS_I2C_SH
1927 - This driver adds from 2 to 5 i2c buses
1928
1929 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
1930 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
1931 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
1932 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
1933 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
1934 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
1935 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
1936 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
1937 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
1938 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001939 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09001940
Heiko Schocherf53f2b82013-10-22 11:03:18 +02001941 - drivers/i2c/omap24xx_i2c.c
1942 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
1943 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
1944 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
1945 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
1946 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
1947 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
1948 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
1949 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
1950 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
1951 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
1952 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
1953
Heiko Schocher465819a2013-11-08 07:30:53 +01001954 - drivers/i2c/zynq_i2c.c
1955 - activate this driver with CONFIG_SYS_I2C_ZYNQ
1956 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
1957 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
1958
Naveen Krishna Ch5d5efd32013-12-06 12:12:38 +05301959 - drivers/i2c/s3c24x0_i2c.c:
1960 - activate this driver with CONFIG_SYS_I2C_S3C24X0
1961 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
1962 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
1963 with a fix speed from 100000 and the slave addr 0!
1964
Dirk Eibachb9577432014-07-03 09:28:18 +02001965 - drivers/i2c/ihs_i2c.c
1966 - activate this driver with CONFIG_SYS_I2C_IHS
1967 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
1968 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
1969 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
1970 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
1971 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
1972 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
1973 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
1974 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
1975 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
1976 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
1977 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
1978 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
Dirk Eibach9ac33852015-10-28 11:46:22 +01001979 - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
1980 - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
1981 - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
1982 - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
1983 - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
1984 - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
1985 - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
1986 - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
1987 - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
Dirk Eibachb9577432014-07-03 09:28:18 +02001988
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001989 additional defines:
1990
1991 CONFIG_SYS_NUM_I2C_BUSES
Simon Glassb05e2b32016-10-02 18:01:05 -06001992 Hold the number of i2c buses you want to use.
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001993
1994 CONFIG_SYS_I2C_DIRECT_BUS
1995 define this, if you don't use i2c muxes on your hardware.
1996 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
1997 omit this define.
1998
1999 CONFIG_SYS_I2C_MAX_HOPS
2000 define how many muxes are maximal consecutively connected
2001 on one i2c bus. If you not use i2c muxes, omit this
2002 define.
2003
2004 CONFIG_SYS_I2C_BUSES
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002005 hold a list of buses you want to use, only used if
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002006 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2007 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2008 CONFIG_SYS_NUM_I2C_BUSES = 9:
2009
2010 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2011 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2012 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2013 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2014 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2015 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2016 {1, {I2C_NULL_HOP}}, \
2017 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2018 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2019 }
2020
2021 which defines
2022 bus 0 on adapter 0 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002023 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2024 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2025 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2026 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2027 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002028 bus 6 on adapter 1 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002029 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2030 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002031
2032 If you do not have i2c muxes on your board, omit this define.
2033
Simon Glass3efce392017-05-12 21:10:00 -06002034- Legacy I2C Support:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002035 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb9bbd242003-06-30 16:24:52 +00002036 then the following macros need to be defined (examples are
2037 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002038
2039 I2C_INIT
2040
wdenkb9bbd242003-06-30 16:24:52 +00002041 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00002042 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002043
wdenk544e9732004-02-06 23:19:44 +00002044 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00002045
wdenkc6097192002-11-03 00:24:07 +00002046 I2C_ACTIVE
2047
2048 The code necessary to make the I2C data line active
2049 (driven). If the data line is open collector, this
2050 define can be null.
2051
wdenkb9bbd242003-06-30 16:24:52 +00002052 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2053
wdenkc6097192002-11-03 00:24:07 +00002054 I2C_TRISTATE
2055
2056 The code necessary to make the I2C data line tri-stated
2057 (inactive). If the data line is open collector, this
2058 define can be null.
2059
wdenkb9bbd242003-06-30 16:24:52 +00002060 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2061
wdenkc6097192002-11-03 00:24:07 +00002062 I2C_READ
2063
York Sun4a598092013-04-01 11:29:11 -07002064 Code that returns true if the I2C data line is high,
2065 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002066
wdenkb9bbd242003-06-30 16:24:52 +00002067 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2068
wdenkc6097192002-11-03 00:24:07 +00002069 I2C_SDA(bit)
2070
York Sun4a598092013-04-01 11:29:11 -07002071 If <bit> is true, sets the I2C data line high. If it
2072 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002073
wdenkb9bbd242003-06-30 16:24:52 +00002074 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002075 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00002076 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00002077
wdenkc6097192002-11-03 00:24:07 +00002078 I2C_SCL(bit)
2079
York Sun4a598092013-04-01 11:29:11 -07002080 If <bit> is true, sets the I2C clock line high. If it
2081 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002082
wdenkb9bbd242003-06-30 16:24:52 +00002083 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002084 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00002085 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00002086
wdenkc6097192002-11-03 00:24:07 +00002087 I2C_DELAY
2088
2089 This delay is invoked four times per clock cycle so this
2090 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00002091 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00002092 like:
2093
wdenkb9bbd242003-06-30 16:24:52 +00002094 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002095
Mike Frysingeree12d542010-07-21 13:38:02 -04002096 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2097
2098 If your arch supports the generic GPIO framework (asm/gpio.h),
2099 then you may alternatively define the two GPIOs that are to be
2100 used as SCL / SDA. Any of the previous I2C_xxx macros will
2101 have GPIO-based defaults assigned to them as appropriate.
2102
2103 You should define these to the GPIO value as given directly to
2104 the generic GPIO functions.
2105
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002106 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00002107
wdenk57b2d802003-06-27 21:31:46 +00002108 When a board is reset during an i2c bus transfer
2109 chips might think that the current transfer is still
2110 in progress. On some boards it is possible to access
2111 the i2c SCLK line directly, either by using the
2112 processor pin as a GPIO or by having a second pin
2113 connected to the bus. If this option is defined a
2114 custom i2c_init_board() routine in boards/xxx/board.c
2115 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00002116
Ben Warren45657152006-09-07 16:50:54 -04002117 CONFIG_I2C_MULTI_BUS
2118
2119 This option allows the use of multiple I2C buses, each of which
Wolfgang Denk092ae952011-10-26 10:21:21 +00002120 must have a controller. At any point in time, only one bus is
2121 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warren45657152006-09-07 16:50:54 -04002122 Note that bus numbering is zero-based.
2123
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002124 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04002125
2126 This option specifies a list of I2C devices that will be skipped
Wolfgang Denk092ae952011-10-26 10:21:21 +00002127 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser469cde42009-04-18 22:34:03 -05002128 is set, specify a list of bus-device pairs. Otherwise, specify
2129 a 1D array of device addresses
Ben Warren45657152006-09-07 16:50:54 -04002130
2131 e.g.
2132 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denk092ae952011-10-26 10:21:21 +00002133 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04002134
2135 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2136
Wolfgang Denk092ae952011-10-26 10:21:21 +00002137 #define CONFIG_I2C_MULTI_BUS
Simon Glassb05e2b32016-10-02 18:01:05 -06002138 #define CONFIG_SYS_I2C_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-09-07 16:50:54 -04002139
2140 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2141
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002142 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-11-03 19:15:00 -06002143
2144 If defined, then this indicates the I2C bus number for DDR SPD.
2145 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2146
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002147 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002148
2149 If defined, then this indicates the I2C bus number for the RTC.
2150 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2151
Andrew Dyer58c41f92008-12-29 17:36:01 -06002152 CONFIG_SOFT_I2C_READ_REPEATED_START
2153
2154 defining this will force the i2c_read() function in
2155 the soft_i2c driver to perform an I2C repeated start
2156 between writing the address pointer and reading the
2157 data. If this define is omitted the default behaviour
2158 of doing a stop-start sequence will be used. Most I2C
2159 devices can use either method, but some require one or
2160 the other.
Timur Tabiab347542006-11-03 19:15:00 -06002161
wdenkc6097192002-11-03 00:24:07 +00002162- SPI Support: CONFIG_SPI
2163
2164 Enables SPI driver (so far only tested with
2165 SPI EEPROM, also an instance works with Crystal A/D and
2166 D/As on the SACSng board)
2167
Yoshihiro Shimoda65bd9b42011-01-31 16:50:43 +09002168 CONFIG_SH_SPI
2169
2170 Enables the driver for SPI controller on SuperH. Currently
2171 only SH7757 is supported.
2172
wdenkc6097192002-11-03 00:24:07 +00002173 CONFIG_SOFT_SPI
2174
wdenk4a5c8a72003-03-06 00:02:04 +00002175 Enables a software (bit-bang) SPI driver rather than
2176 using hardware support. This is a general purpose
2177 driver that only requires three general I/O port pins
2178 (two outputs, one input) to function. If this is
2179 defined, the board configuration must define several
2180 SPI configuration items (port pins to use, etc). For
2181 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002182
Ben Warren7efe9272008-01-16 22:37:35 -05002183 CONFIG_HARD_SPI
2184
2185 Enables a hardware SPI driver for general-purpose reads
2186 and writes. As with CONFIG_SOFT_SPI, the board configuration
2187 must define a list of chip-select function pointers.
Wolfgang Denk092ae952011-10-26 10:21:21 +00002188 Currently supported on some MPC8xxx processors. For an
Ben Warren7efe9272008-01-16 22:37:35 -05002189 example, see include/configs/mpc8349emds.h.
2190
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002191 CONFIG_MXC_SPI
2192
2193 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevamdcd342c2011-10-28 08:57:46 +00002194 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002195
Heiko Schocherb77c8882014-07-14 10:22:11 +02002196 CONFIG_SYS_SPI_MXC_WAIT
2197 Timeout for waiting until spi transfer completed.
2198 default: (CONFIG_SYS_HZ/100) /* 10 ms */
2199
Matthias Fuchsa4400872007-12-27 17:12:34 +01002200- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00002201
Matthias Fuchsa4400872007-12-27 17:12:34 +01002202 Enables FPGA subsystem.
2203
2204 CONFIG_FPGA_<vendor>
2205
2206 Enables support for specific chip vendors.
2207 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00002208
Matthias Fuchsa4400872007-12-27 17:12:34 +01002209 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00002210
Matthias Fuchsa4400872007-12-27 17:12:34 +01002211 Enables support for FPGA family.
2212 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2213
2214 CONFIG_FPGA_COUNT
2215
2216 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002217
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002218 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002219
wdenk57b2d802003-06-27 21:31:46 +00002220 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002221
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002222 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002223
wdenk4a5c8a72003-03-06 00:02:04 +00002224 Enable checks on FPGA configuration interface busy
2225 status by the configuration function. This option
2226 will require a board or device specific function to
2227 be written.
wdenkc6097192002-11-03 00:24:07 +00002228
2229 CONFIG_FPGA_DELAY
2230
2231 If defined, a function that provides delays in the FPGA
2232 configuration driver.
2233
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002234 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002235 Allow Control-C to interrupt FPGA configuration
2236
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002237 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002238
wdenk4a5c8a72003-03-06 00:02:04 +00002239 Check for configuration errors during FPGA bitfile
2240 loading. For example, abort during Virtex II
2241 configuration if the INIT_B line goes low (which
2242 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002243
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002244 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002245
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002246 Maximum time to wait for the INIT_B line to de-assert
2247 after PROB_B has been de-asserted during a Virtex II
wdenk4a5c8a72003-03-06 00:02:04 +00002248 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002249 ms.
wdenkc6097192002-11-03 00:24:07 +00002250
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002251 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002252
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002253 Maximum time to wait for BUSY to de-assert during
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002254 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002255
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002256 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002257
wdenk4a5c8a72003-03-06 00:02:04 +00002258 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002259 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002260
2261- Configuration Management:
Stefan Roese141ed202014-10-22 12:13:24 +02002262 CONFIG_BUILD_TARGET
2263
2264 Some SoCs need special image types (e.g. U-Boot binary
2265 with a special header) as build targets. By defining
2266 CONFIG_BUILD_TARGET in the SoC / board header, this
2267 special image will be automatically built upon calling
Simon Glassdc27def2016-07-27 20:33:08 -06002268 make / buildman.
Stefan Roese141ed202014-10-22 12:13:24 +02002269
wdenkc6097192002-11-03 00:24:07 +00002270 CONFIG_IDENT_STRING
2271
wdenk4a5c8a72003-03-06 00:02:04 +00002272 If defined, this string will be added to the U-Boot
2273 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002274
2275- Vendor Parameter Protection:
2276
wdenk4a5c8a72003-03-06 00:02:04 +00002277 U-Boot considers the values of the environment
2278 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00002279 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00002280 are set once by the board vendor / manufacturer, and
2281 protects these variables from casual modification by
2282 the user. Once set, these variables are read-only,
2283 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002284 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002285
2286 If CONFIG_ENV_OVERWRITE is #defined in your config
2287 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00002288 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002289 these parameters.
2290
Joe Hershberger76f353e2015-05-04 14:55:14 -05002291 Alternatively, if you define _both_ an ethaddr in the
2292 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002293 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002294 which can be changed exactly ONCE by the user. [The
2295 serial# is unaffected by this, i. e. it remains
2296 read-only.]
2297
Joe Hershberger71497d02012-12-11 22:16:31 -06002298 The same can be accomplished in a more flexible way
2299 for any variable by configuring the type of access
2300 to allow for those variables in the ".flags" variable
2301 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2302
wdenkc6097192002-11-03 00:24:07 +00002303- Protected RAM:
2304 CONFIG_PRAM
2305
2306 Define this variable to enable the reservation of
2307 "protected RAM", i. e. RAM which is not overwritten
2308 by U-Boot. Define CONFIG_PRAM to hold the number of
2309 kB you want to reserve for pRAM. You can overwrite
2310 this default value by defining an environment
2311 variable "pram" to the number of kB you want to
2312 reserve. Note that the board info structure will
2313 still show the full amount of RAM. If pRAM is
2314 reserved, a new environment variable "mem" will
2315 automatically be defined to hold the amount of
2316 remaining RAM in a form that can be passed as boot
2317 argument to Linux, for instance like that:
2318
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01002319 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002320 saveenv
2321
2322 This way you can tell Linux not to use this memory,
2323 either, which results in a memory region that will
2324 not be affected by reboots.
2325
2326 *WARNING* If your board configuration uses automatic
2327 detection of the RAM size, you must make sure that
2328 this memory test is non-destructive. So far, the
2329 following board configurations are known to be
2330 "pRAM-clean":
2331
Heiko Schocher65d94db2017-06-07 17:33:09 +02002332 IVMS8, IVML24, SPD8xx,
Wolfgang Denk90326762012-10-24 02:36:15 +00002333 HERMES, IP860, RPXlite, LWMON,
Heiko Schocher71cb3e92017-06-07 17:33:10 +02002334 FLAGADM
wdenkc6097192002-11-03 00:24:07 +00002335
Gabe Blacka2f3a932012-12-02 04:55:18 +00002336- Access to physical memory region (> 4GB)
2337 Some basic support is provided for operations on memory not
2338 normally accessible to U-Boot - e.g. some architectures
2339 support access to more than 4GB of memory on 32-bit
2340 machines using physical address extension or similar.
2341 Define CONFIG_PHYSMEM to access this basic support, which
2342 currently only supports clearing the memory.
2343
wdenkc6097192002-11-03 00:24:07 +00002344- Error Recovery:
2345 CONFIG_PANIC_HANG
2346
2347 Define this variable to stop the system in case of a
2348 fatal error, so that you have to reset it manually.
2349 This is probably NOT a good idea for an embedded
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002350 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002351 automatically as fast as possible, but it may be
2352 useful during development since you can try to debug
2353 the conditions that lead to the situation.
2354
2355 CONFIG_NET_RETRY_COUNT
2356
wdenk4a5c8a72003-03-06 00:02:04 +00002357 This variable defines the number of retries for
2358 network operations like ARP, RARP, TFTP, or BOOTP
2359 before giving up the operation. If not defined, a
2360 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002361
Guennadi Liakhovetskib38c2b32008-04-03 17:04:19 +02002362 CONFIG_ARP_TIMEOUT
2363
2364 Timeout waiting for an ARP reply in milliseconds.
2365
Tetsuyuki Kobayashi147e3902012-07-03 22:25:21 +00002366 CONFIG_NFS_TIMEOUT
2367
2368 Timeout in milliseconds used in NFS protocol.
2369 If you encounter "ERROR: Cannot umount" in nfs command,
2370 try longer timeout such as
2371 #define CONFIG_NFS_TIMEOUT 10000UL
2372
wdenkc6097192002-11-03 00:24:07 +00002373- Command Interpreter:
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002374 CONFIG_AUTO_COMPLETE
wdenk3902d702004-04-15 18:22:41 +00002375
2376 Enable auto completion of commands using TAB.
2377
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002378 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002379
2380 This defines the secondary prompt string, which is
2381 printed when the command interpreter needs more input
2382 to complete a command. Usually "> ".
2383
2384 Note:
2385
wdenk57b2d802003-06-27 21:31:46 +00002386 In the current implementation, the local variables
2387 space and global environment variables space are
2388 separated. Local variables are those you define by
2389 simply typing `name=value'. To access a local
2390 variable later on, you have write `$name' or
2391 `${name}'; to execute the contents of a variable
2392 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002393
wdenk4a5c8a72003-03-06 00:02:04 +00002394 Global environment variables are those you use
2395 setenv/printenv to work with. To run a command stored
2396 in such a variable, you need to use the run command,
2397 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002398
2399 To store commands and special characters in a
2400 variable, please use double quotation marks
2401 surrounding the whole text of the variable, instead
2402 of the backslashes before semicolons and special
2403 symbols.
2404
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002405- Command Line Editing and History:
Wolfgang Denk2039a072006-07-21 11:35:21 +02002406 CONFIG_CMDLINE_EDITING
2407
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002408 Enable editing and History functions for interactive
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002409 command line input operations
Wolfgang Denk2039a072006-07-21 11:35:21 +02002410
Marek Vasut734fb042016-01-27 04:47:55 +01002411- Command Line PS1/PS2 support:
2412 CONFIG_CMDLINE_PS_SUPPORT
2413
2414 Enable support for changing the command prompt string
2415 at run-time. Only static string is supported so far.
2416 The string is obtained from environment variables PS1
2417 and PS2.
2418
wdenkc0aa5c52003-12-06 19:49:23 +00002419- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002420 CONFIG_EXTRA_ENV_SETTINGS
2421
wdenk4a5c8a72003-03-06 00:02:04 +00002422 Define this to contain any number of null terminated
2423 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00002424 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00002425
wdenk4a5c8a72003-03-06 00:02:04 +00002426 For example, place something like this in your
2427 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002428
2429 #define CONFIG_EXTRA_ENV_SETTINGS \
2430 "myvar1=value1\0" \
2431 "myvar2=value2\0"
2432
wdenk4a5c8a72003-03-06 00:02:04 +00002433 Warning: This method is based on knowledge about the
2434 internal format how the environment is stored by the
2435 U-Boot code. This is NOT an official, exported
2436 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00002437 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002438 You better know what you are doing here.
2439
wdenk4a5c8a72003-03-06 00:02:04 +00002440 Note: overly (ab)use of the default environment is
2441 discouraged. Make sure to check other ways to preset
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002442 the environment like the "source" command or the
wdenk4a5c8a72003-03-06 00:02:04 +00002443 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002444
Stephen Warren1465d5f2012-05-22 09:21:54 +00002445 CONFIG_ENV_VARS_UBOOT_CONFIG
2446
2447 Define this in order to add variables describing the
2448 U-Boot build configuration to the default environment.
2449 These will be named arch, cpu, board, vendor, and soc.
2450
2451 Enabling this option will cause the following to be defined:
2452
2453 - CONFIG_SYS_ARCH
2454 - CONFIG_SYS_CPU
2455 - CONFIG_SYS_BOARD
2456 - CONFIG_SYS_VENDOR
2457 - CONFIG_SYS_SOC
2458
Tom Rini4c8cc9b2012-10-24 07:28:16 +00002459 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2460
2461 Define this in order to add variables describing certain
2462 run-time determined information about the hardware to the
2463 environment. These will be named board_name, board_rev.
2464
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002465 CONFIG_DELAY_ENVIRONMENT
2466
2467 Normally the environment is loaded when the board is
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002468 initialised so that it is available to U-Boot. This inhibits
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002469 that so that the environment is not available until
2470 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2471 this is instead controlled by the value of
2472 /config/load-environment.
2473
wdenkc0aa5c52003-12-06 19:49:23 +00002474- DataFlash Support:
wdenk381669a2003-06-16 23:50:08 +00002475 CONFIG_HAS_DATAFLASH
2476
wdenk57b2d802003-06-27 21:31:46 +00002477 Defining this option enables DataFlash features and
2478 allows to read/write in Dataflash via the standard
2479 commands cp, md...
wdenk381669a2003-06-16 23:50:08 +00002480
Eric Nelson97f5f8f2012-01-31 10:52:08 -07002481- Serial Flash support
2482 CONFIG_CMD_SF
2483
2484 Defining this option enables SPI flash commands
2485 'sf probe/read/write/erase/update'.
2486
2487 Usage requires an initial 'probe' to define the serial
2488 flash parameters, followed by read/write/erase/update
2489 commands.
2490
2491 The following defaults may be provided by the platform
2492 to handle the common case when only a single serial
2493 flash is present on the system.
2494
2495 CONFIG_SF_DEFAULT_BUS Bus identifier
2496 CONFIG_SF_DEFAULT_CS Chip-select
2497 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2498 CONFIG_SF_DEFAULT_SPEED in Hz
2499
Simon Glass4b5545e2012-10-08 13:16:02 +00002500 CONFIG_CMD_SF_TEST
2501
2502 Define this option to include a destructive SPI flash
2503 test ('sf test').
2504
wdenkef893942004-02-23 16:11:30 +00002505- SystemACE Support:
2506 CONFIG_SYSTEMACE
2507
2508 Adding this option adds support for Xilinx SystemACE
2509 chips attached via some sort of local bus. The address
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002510 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002511 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenkef893942004-02-23 16:11:30 +00002512
2513 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002514 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenkef893942004-02-23 16:11:30 +00002515
2516 When SystemACE support is added, the "ace" device type
2517 becomes available to the fat commands, i.e. fatls.
2518
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002519- TFTP Fixed UDP Port:
2520 CONFIG_TFTP_PORT
2521
Wolfgang Denk227b5192005-09-24 23:25:46 +02002522 If this is defined, the environment variable tftpsrcp
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002523 is used to supply the TFTP UDP source port value.
Wolfgang Denk227b5192005-09-24 23:25:46 +02002524 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002525 number generator is used.
2526
Wolfgang Denk227b5192005-09-24 23:25:46 +02002527 Also, the environment variable tftpdstp is used to supply
2528 the TFTP UDP destination port value. If tftpdstp isn't
2529 defined, the normal port 69 is used.
2530
2531 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002532 blindly start the TFTP transfer using the pre-configured
2533 target IP address and UDP port. This has the effect of
2534 "punching through" the (Windows XP) firewall, allowing
2535 the remainder of the TFTP transfer to proceed normally.
2536 A better solution is to properly configure the firewall,
2537 but sometimes that is not allowed.
2538
Heiko Schocher443ca402014-01-25 07:27:13 +01002539- bootcount support:
2540 CONFIG_BOOTCOUNT_LIMIT
2541
2542 This enables the bootcounter support, see:
2543 http://www.denx.de/wiki/DULG/UBootBootCountLimit
2544
2545 CONFIG_AT91SAM9XE
2546 enable special bootcounter support on at91sam9xe based boards.
Heiko Schocher443ca402014-01-25 07:27:13 +01002547 CONFIG_SOC_DA8XX
2548 enable special bootcounter support on da850 based boards.
2549 CONFIG_BOOTCOUNT_RAM
2550 enable support for the bootcounter in RAM
2551 CONFIG_BOOTCOUNT_I2C
2552 enable support for the bootcounter on an i2c (like RTC) device.
2553 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
2554 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
2555 the bootcounter.
2556 CONFIG_BOOTCOUNT_ALEN = address len
Simon Glass35191a32013-06-13 15:10:02 -07002557
wdenkc0aa5c52003-12-06 19:49:23 +00002558- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002559 CONFIG_SHOW_BOOT_PROGRESS
2560
wdenk4a5c8a72003-03-06 00:02:04 +00002561 Defining this option allows to add some board-
2562 specific code (calling a user-provided function
2563 "show_boot_progress(int)") that enables you to show
2564 the system's boot progress on some display (for
2565 example, some LED's) on your board. At the moment,
2566 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002567
Simon Glass0fa36a42012-09-28 08:56:37 +00002568
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002569Legacy uImage format:
2570
wdenkc6097192002-11-03 00:24:07 +00002571 Arg Where When
2572 1 common/cmd_bootm.c before attempting to boot an image
wdenk544e9732004-02-06 23:19:44 +00002573 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002574 2 common/cmd_bootm.c Image header has correct magic number
wdenk544e9732004-02-06 23:19:44 +00002575 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002576 3 common/cmd_bootm.c Image header has correct checksum
wdenk544e9732004-02-06 23:19:44 +00002577 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002578 4 common/cmd_bootm.c Image data has correct checksum
2579 -4 common/cmd_bootm.c Image is for unsupported architecture
2580 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002581 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002582 6 common/cmd_bootm.c Image Type check OK
2583 -6 common/cmd_bootm.c gunzip uncompression error
2584 -7 common/cmd_bootm.c Unimplemented compression type
2585 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002586 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002587 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002588
2589 9 common/image.c Start initial ramdisk verification
2590 -10 common/image.c Ramdisk header has bad magic number
2591 -11 common/image.c Ramdisk header has bad checksum
2592 10 common/image.c Ramdisk header is OK
2593 -12 common/image.c Ramdisk data has bad checksum
2594 11 common/image.c Ramdisk data has correct checksum
2595 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002596 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002597 13 common/image.c Start multifile image verification
2598 14 common/image.c No initial ramdisk, no multifile, continue.
2599
Wolfgang Denk092ae952011-10-26 10:21:21 +00002600 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002601
Stefan Roese88fbf932010-04-15 16:07:28 +02002602 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenkd729d302004-02-27 00:07:27 +00002603 -31 post/post.c POST test failed, detected by post_output_backlog()
2604 -32 post/post.c POST test failed, detected by post_run_single()
wdenke97d3d92004-02-23 22:22:28 +00002605
Heiko Schocher633e03a2007-06-22 19:11:54 +02002606 34 common/cmd_doc.c before loading a Image from a DOC device
2607 -35 common/cmd_doc.c Bad usage of "doc" command
2608 35 common/cmd_doc.c correct usage of "doc" command
2609 -36 common/cmd_doc.c No boot device
2610 36 common/cmd_doc.c correct boot device
2611 -37 common/cmd_doc.c Unknown Chip ID on boot device
2612 37 common/cmd_doc.c correct chip ID found, device available
2613 -38 common/cmd_doc.c Read Error on boot device
2614 38 common/cmd_doc.c reading Image header from DOC device OK
2615 -39 common/cmd_doc.c Image header has bad magic number
2616 39 common/cmd_doc.c Image header has correct magic number
2617 -40 common/cmd_doc.c Error reading Image from DOC device
2618 40 common/cmd_doc.c Image header has correct magic number
2619 41 common/cmd_ide.c before loading a Image from a IDE device
2620 -42 common/cmd_ide.c Bad usage of "ide" command
2621 42 common/cmd_ide.c correct usage of "ide" command
2622 -43 common/cmd_ide.c No boot device
2623 43 common/cmd_ide.c boot device found
2624 -44 common/cmd_ide.c Device not available
2625 44 common/cmd_ide.c Device available
2626 -45 common/cmd_ide.c wrong partition selected
2627 45 common/cmd_ide.c partition selected
2628 -46 common/cmd_ide.c Unknown partition table
2629 46 common/cmd_ide.c valid partition table found
2630 -47 common/cmd_ide.c Invalid partition type
2631 47 common/cmd_ide.c correct partition type
2632 -48 common/cmd_ide.c Error reading Image Header on boot device
2633 48 common/cmd_ide.c reading Image Header from IDE device OK
2634 -49 common/cmd_ide.c Image header has bad magic number
2635 49 common/cmd_ide.c Image header has correct magic number
2636 -50 common/cmd_ide.c Image header has bad checksum
2637 50 common/cmd_ide.c Image header has correct checksum
2638 -51 common/cmd_ide.c Error reading Image from IDE device
2639 51 common/cmd_ide.c reading Image from IDE device OK
2640 52 common/cmd_nand.c before loading a Image from a NAND device
2641 -53 common/cmd_nand.c Bad usage of "nand" command
2642 53 common/cmd_nand.c correct usage of "nand" command
2643 -54 common/cmd_nand.c No boot device
2644 54 common/cmd_nand.c boot device found
2645 -55 common/cmd_nand.c Unknown Chip ID on boot device
2646 55 common/cmd_nand.c correct chip ID found, device available
2647 -56 common/cmd_nand.c Error reading Image Header on boot device
2648 56 common/cmd_nand.c reading Image Header from NAND device OK
2649 -57 common/cmd_nand.c Image header has bad magic number
2650 57 common/cmd_nand.c Image header has correct magic number
2651 -58 common/cmd_nand.c Error reading Image from NAND device
2652 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002653
Heiko Schocher633e03a2007-06-22 19:11:54 +02002654 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002655
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002656 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher633e03a2007-06-22 19:11:54 +02002657 -64 net/eth.c no Ethernet found.
2658 65 net/eth.c Ethernet found.
wdenkc6097192002-11-03 00:24:07 +00002659
Heiko Schocher633e03a2007-06-22 19:11:54 +02002660 -80 common/cmd_net.c usage wrong
Joe Hershbergerc80b41b02015-04-08 01:41:21 -05002661 80 common/cmd_net.c before calling net_loop()
2662 -81 common/cmd_net.c some error in net_loop() occurred
2663 81 common/cmd_net.c net_loop() back without error
Heiko Schocher633e03a2007-06-22 19:11:54 +02002664 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2665 82 common/cmd_net.c trying automatic boot
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002666 83 common/cmd_net.c running "source" command
2667 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher633e03a2007-06-22 19:11:54 +02002668 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002669
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002670FIT uImage format:
2671
2672 Arg Where When
2673 100 common/cmd_bootm.c Kernel FIT Image has correct format
2674 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2675 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2676 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2677 102 common/cmd_bootm.c Kernel unit name specified
2678 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +01002679 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002680 104 common/cmd_bootm.c Got kernel subimage node offset
2681 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2682 105 common/cmd_bootm.c Kernel subimage hash verification OK
2683 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2684 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002685 -106 common/cmd_bootm.c Kernel subimage has wrong type
2686 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002687 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2688 108 common/cmd_bootm.c Got kernel subimage data/size
2689 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2690 -109 common/cmd_bootm.c Can't get kernel subimage type
2691 -110 common/cmd_bootm.c Can't get kernel subimage comp
2692 -111 common/cmd_bootm.c Can't get kernel subimage os
2693 -112 common/cmd_bootm.c Can't get kernel subimage load address
2694 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2695
2696 120 common/image.c Start initial ramdisk verification
2697 -120 common/image.c Ramdisk FIT image has incorrect format
2698 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002699 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002700 -122 common/image.c Can't get configuration for ramdisk subimage
2701 123 common/image.c Ramdisk unit name specified
2702 -124 common/image.c Can't get ramdisk subimage node offset
2703 125 common/image.c Got ramdisk subimage node offset
2704 -125 common/image.c Ramdisk subimage hash verification failed
2705 126 common/image.c Ramdisk subimage hash verification OK
2706 -126 common/image.c Ramdisk subimage for unsupported architecture
2707 127 common/image.c Architecture check OK
2708 -127 common/image.c Can't get ramdisk subimage data/size
2709 128 common/image.c Got ramdisk subimage data/size
2710 129 common/image.c Can't get ramdisk load address
2711 -129 common/image.c Got ramdisk load address
2712
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002713 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002714 131 common/cmd_doc.c FIT image format OK
2715
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002716 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002717 141 common/cmd_ide.c FIT image format OK
2718
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002719 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002720 151 common/cmd_nand.c FIT image format OK
2721
Heiko Schocher515eb122014-05-28 11:33:33 +02002722- legacy image format:
2723 CONFIG_IMAGE_FORMAT_LEGACY
2724 enables the legacy image format support in U-Boot.
2725
2726 Default:
2727 enabled if CONFIG_FIT_SIGNATURE is not defined.
2728
2729 CONFIG_DISABLE_IMAGE_LEGACY
2730 disable the legacy image format
2731
2732 This define is introduced, as the legacy image format is
2733 enabled per default for backward compatibility.
2734
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002735- Standalone program support:
2736 CONFIG_STANDALONE_LOAD_ADDR
2737
Wolfgang Denk23f78482011-10-09 21:06:34 +02002738 This option defines a board specific value for the
2739 address where standalone program gets loaded, thus
2740 overwriting the architecture dependent default
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002741 settings.
2742
2743- Frame Buffer Address:
2744 CONFIG_FB_ADDR
2745
2746 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denka71eb8e2013-01-03 00:43:59 +00002747 address for frame buffer. This is typically the case
2748 when using a graphics controller has separate video
2749 memory. U-Boot will then place the frame buffer at
2750 the given address instead of dynamically reserving it
2751 in system RAM by calling lcd_setmem(), which grabs
2752 the memory for the frame buffer depending on the
2753 configured panel size.
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002754
2755 Please see board_init_f function.
2756
Detlev Zundel0ecb6112009-12-01 17:16:19 +01002757- Automatic software updates via TFTP server
2758 CONFIG_UPDATE_TFTP
2759 CONFIG_UPDATE_TFTP_CNT_MAX
2760 CONFIG_UPDATE_TFTP_MSEC_MAX
2761
2762 These options enable and control the auto-update feature;
2763 for a more detailed description refer to doc/README.update.
2764
2765- MTD Support (mtdparts command, UBI support)
2766 CONFIG_MTD_DEVICE
2767
2768 Adds the MTD device infrastructure from the Linux kernel.
2769 Needed for mtdparts command support.
2770
2771 CONFIG_MTD_PARTITIONS
2772
2773 Adds the MTD partitioning infrastructure from the Linux
2774 kernel. Needed for UBI support.
2775
Joe Hershberger7d80fc12013-04-08 10:32:48 +00002776- UBI support
Joe Hershberger47550fc2013-04-08 10:32:49 +00002777 CONFIG_UBI_SILENCE_MSG
2778
2779 Make the verbose messages from UBI stop printing. This leaves
2780 warnings and errors enabled.
2781
Heiko Schocherf5895d12014-06-24 10:10:04 +02002782
2783 CONFIG_MTD_UBI_WL_THRESHOLD
2784 This parameter defines the maximum difference between the highest
2785 erase counter value and the lowest erase counter value of eraseblocks
2786 of UBI devices. When this threshold is exceeded, UBI starts performing
2787 wear leveling by means of moving data from eraseblock with low erase
2788 counter to eraseblocks with high erase counter.
2789
2790 The default value should be OK for SLC NAND flashes, NOR flashes and
2791 other flashes which have eraseblock life-cycle 100000 or more.
2792 However, in case of MLC NAND flashes which typically have eraseblock
2793 life-cycle less than 10000, the threshold should be lessened (e.g.,
2794 to 128 or 256, although it does not have to be power of 2).
2795
2796 default: 4096
Simon Glass6c0be912014-10-23 18:58:54 -06002797
Heiko Schocherf5895d12014-06-24 10:10:04 +02002798 CONFIG_MTD_UBI_BEB_LIMIT
2799 This option specifies the maximum bad physical eraseblocks UBI
2800 expects on the MTD device (per 1024 eraseblocks). If the
2801 underlying flash does not admit of bad eraseblocks (e.g. NOR
2802 flash), this value is ignored.
2803
2804 NAND datasheets often specify the minimum and maximum NVM
2805 (Number of Valid Blocks) for the flashes' endurance lifetime.
2806 The maximum expected bad eraseblocks per 1024 eraseblocks
2807 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
2808 which gives 20 for most NANDs (MaxNVB is basically the total
2809 count of eraseblocks on the chip).
2810
2811 To put it differently, if this value is 20, UBI will try to
2812 reserve about 1.9% of physical eraseblocks for bad blocks
2813 handling. And that will be 1.9% of eraseblocks on the entire
2814 NAND chip, not just the MTD partition UBI attaches. This means
2815 that if you have, say, a NAND flash chip admits maximum 40 bad
2816 eraseblocks, and it is split on two MTD partitions of the same
2817 size, UBI will reserve 40 eraseblocks when attaching a
2818 partition.
2819
2820 default: 20
2821
2822 CONFIG_MTD_UBI_FASTMAP
2823 Fastmap is a mechanism which allows attaching an UBI device
2824 in nearly constant time. Instead of scanning the whole MTD device it
2825 only has to locate a checkpoint (called fastmap) on the device.
2826 The on-flash fastmap contains all information needed to attach
2827 the device. Using fastmap makes only sense on large devices where
2828 attaching by scanning takes long. UBI will not automatically install
2829 a fastmap on old images, but you can set the UBI parameter
2830 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
2831 that fastmap-enabled images are still usable with UBI implementations
2832 without fastmap support. On typical flash devices the whole fastmap
2833 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
2834
2835 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
2836 Set this parameter to enable fastmap automatically on images
2837 without a fastmap.
2838 default: 0
2839
Heiko Schocher94b66de2015-10-22 06:19:21 +02002840 CONFIG_MTD_UBI_FM_DEBUG
2841 Enable UBI fastmap debug
2842 default: 0
2843
Joe Hershberger7d80fc12013-04-08 10:32:48 +00002844- UBIFS support
Joe Hershberger47550fc2013-04-08 10:32:49 +00002845 CONFIG_UBIFS_SILENCE_MSG
2846
2847 Make the verbose messages from UBIFS stop printing. This leaves
2848 warnings and errors enabled.
2849
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002850- SPL framework
Wolfgang Denk825223d2011-09-11 21:24:09 +02002851 CONFIG_SPL
2852 Enable building of SPL globally.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002853
Tom Rini36853852012-02-14 07:29:40 +00002854 CONFIG_SPL_LDSCRIPT
2855 LDSCRIPT for linking the SPL binary.
2856
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002857 CONFIG_SPL_MAX_FOOTPRINT
2858 Maximum size in memory allocated to the SPL, BSS included.
2859 When defined, the linker checks that the actual memory
2860 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00002861 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002862 must not be both defined at the same time.
2863
Tom Rini36853852012-02-14 07:29:40 +00002864 CONFIG_SPL_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002865 Maximum size of the SPL image (text, data, rodata, and
2866 linker lists sections), BSS excluded.
2867 When defined, the linker checks that the actual size does
2868 not exceed it.
Tom Rini36853852012-02-14 07:29:40 +00002869
Wolfgang Denk825223d2011-09-11 21:24:09 +02002870 CONFIG_SPL_TEXT_BASE
2871 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002872
Scott Woodc4f0d002012-09-20 19:05:12 -05002873 CONFIG_SPL_RELOC_TEXT_BASE
2874 Address to relocate to. If unspecified, this is equal to
2875 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
2876
Tom Rini36853852012-02-14 07:29:40 +00002877 CONFIG_SPL_BSS_START_ADDR
2878 Link address for the BSS within the SPL binary.
2879
2880 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002881 Maximum size in memory allocated to the SPL BSS.
2882 When defined, the linker checks that the actual memory used
2883 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00002884 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002885 must not be both defined at the same time.
Tom Rini36853852012-02-14 07:29:40 +00002886
2887 CONFIG_SPL_STACK
2888 Adress of the start of the stack SPL will use
2889
Albert ARIBAUD \(3ADEV\)287b0942015-03-31 11:40:50 +02002890 CONFIG_SPL_PANIC_ON_RAW_IMAGE
2891 When defined, SPL will panic() if the image it has
2892 loaded does not have a signature.
2893 Defining this is useful when code which loads images
2894 in SPL cannot guarantee that absolutely all read errors
2895 will be caught.
2896 An example is the LPC32XX MLC NAND driver, which will
2897 consider that a completely unreadable NAND block is bad,
2898 and thus should be skipped silently.
2899
Scott Woodc4f0d002012-09-20 19:05:12 -05002900 CONFIG_SPL_RELOC_STACK
2901 Adress of the start of the stack SPL will use after
2902 relocation. If unspecified, this is equal to
2903 CONFIG_SPL_STACK.
2904
Tom Rini36853852012-02-14 07:29:40 +00002905 CONFIG_SYS_SPL_MALLOC_START
2906 Starting address of the malloc pool used in SPL.
Fabio Estevam38e1a972015-11-12 12:30:19 -02002907 When this option is set the full malloc is used in SPL and
2908 it is set up by spl_init() and before that, the simple malloc()
2909 can be used if CONFIG_SYS_MALLOC_F is defined.
Tom Rini36853852012-02-14 07:29:40 +00002910
2911 CONFIG_SYS_SPL_MALLOC_SIZE
2912 The size of the malloc pool used in SPL.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002913
Tom Rini28591df2012-08-13 12:03:19 -07002914 CONFIG_SPL_FRAMEWORK
2915 Enable the SPL framework under common/. This framework
2916 supports MMC, NAND and YMODEM loading of U-Boot and NAND
2917 NAND loading of the Linux Kernel.
2918
Tom Rinic2b76002014-03-28 12:03:39 -04002919 CONFIG_SPL_OS_BOOT
2920 Enable booting directly to an OS from SPL.
2921 See also: doc/README.falcon
2922
Tom Rinife3b0c72012-08-13 11:37:56 -07002923 CONFIG_SPL_DISPLAY_PRINT
2924 For ARM, enable an optional function to print more information
2925 about the running system.
2926
Scott Wood7c810902012-09-20 16:35:21 -05002927 CONFIG_SPL_INIT_MINIMAL
2928 Arch init code should be built for a very small image
2929
Paul Kocialkowski17675c82014-11-08 23:14:56 +01002930 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
2931 Partition on the MMC to load U-Boot from when the MMC is being
2932 used in raw mode
2933
Peter Korsgaard01b542f2013-05-13 08:36:29 +00002934 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
2935 Sector to load kernel uImage from when MMC is being
2936 used in raw mode (for Falcon mode)
2937
2938 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
2939 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
2940 Sector and number of sectors to load kernel argument
2941 parameters from when MMC is being used in raw mode
2942 (for falcon mode)
2943
Paul Kocialkowski341e8cd2014-11-08 23:14:55 +01002944 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
2945 Partition on the MMC to load U-Boot from when the MMC is being
2946 used in fs mode
2947
Guillaume GARDET5065b712014-10-15 17:53:13 +02002948 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
2949 Filename to read to load U-Boot when reading from filesystem
2950
2951 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00002952 Filename to read to load kernel uImage when reading
Guillaume GARDET5065b712014-10-15 17:53:13 +02002953 from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00002954
Guillaume GARDET5065b712014-10-15 17:53:13 +02002955 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00002956 Filename to read to load kernel argument parameters
Guillaume GARDET5065b712014-10-15 17:53:13 +02002957 when reading from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00002958
Scott Wood2b36fbb2012-12-06 13:33:17 +00002959 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
2960 Set this for NAND SPL on PPC mpc83xx targets, so that
2961 start.S waits for the rest of the SPL to load before
2962 continuing (the hardware starts execution after just
2963 loading the first page rather than the full 4K).
2964
Prabhakar Kushwaha6e2b9a32014-04-08 19:12:31 +05302965 CONFIG_SPL_SKIP_RELOCATE
2966 Avoid SPL relocation
2967
Scott Woodc352a0c2012-09-20 19:09:07 -05002968 CONFIG_SPL_NAND_BASE
2969 Include nand_base.c in the SPL. Requires
2970 CONFIG_SPL_NAND_DRIVERS.
2971
2972 CONFIG_SPL_NAND_DRIVERS
2973 SPL uses normal NAND drivers, not minimal drivers.
2974
2975 CONFIG_SPL_NAND_ECC
2976 Include standard software ECC in the SPL
2977
Tom Rini36853852012-02-14 07:29:40 +00002978 CONFIG_SPL_NAND_SIMPLE
Scott Wood36c440e2012-09-21 18:35:27 -05002979 Support for NAND boot using simple NAND drivers that
2980 expose the cmd_ctrl() interface.
Tom Rini36853852012-02-14 07:29:40 +00002981
Thomas Gleixner820d24d2016-07-12 20:28:12 +02002982 CONFIG_SPL_UBI
2983 Support for a lightweight UBI (fastmap) scanner and
2984 loader
2985
Heiko Schochercf000272014-10-31 08:31:00 +01002986 CONFIG_SPL_NAND_RAW_ONLY
2987 Support to boot only raw u-boot.bin images. Use this only
2988 if you need to save space.
2989
Ying Zhangdfb2b152013-08-16 15:16:12 +08002990 CONFIG_SPL_COMMON_INIT_DDR
2991 Set for common ddr init with serial presence detect in
2992 SPL binary.
2993
Tom Rini36853852012-02-14 07:29:40 +00002994 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
2995 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
2996 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
2997 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
2998 CONFIG_SYS_NAND_ECCBYTES
2999 Defines the size and behavior of the NAND that SPL uses
Scott Wood36c440e2012-09-21 18:35:27 -05003000 to read U-Boot
Tom Rini36853852012-02-14 07:29:40 +00003001
Prabhakar Kushwahaafffcb02013-12-11 12:42:11 +05303002 CONFIG_SPL_NAND_BOOT
3003 Add support NAND boot
3004
Tom Rini36853852012-02-14 07:29:40 +00003005 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood36c440e2012-09-21 18:35:27 -05003006 Location in NAND to read U-Boot from
3007
3008 CONFIG_SYS_NAND_U_BOOT_DST
3009 Location in memory to load U-Boot to
3010
3011 CONFIG_SYS_NAND_U_BOOT_SIZE
3012 Size of image to load
Tom Rini36853852012-02-14 07:29:40 +00003013
3014 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood36c440e2012-09-21 18:35:27 -05003015 Entry point in loaded image to jump to
Tom Rini36853852012-02-14 07:29:40 +00003016
3017 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3018 Define this if you need to first read the OOB and then the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003019 data. This is used, for example, on davinci platforms.
Tom Rini36853852012-02-14 07:29:40 +00003020
3021 CONFIG_SPL_OMAP3_ID_NAND
3022 Support for an OMAP3-specific set of functions to return the
3023 ID and MFR of the first attached NAND chip, if present.
3024
Pavel Machekde997252012-08-30 22:42:11 +02003025 CONFIG_SPL_RAM_DEVICE
3026 Support for running image already present in ram, in SPL binary
3027
Scott Woodeb7bd972012-12-06 13:33:16 +00003028 CONFIG_SPL_PAD_TO
Benoît Thébaudeauf0180722013-04-11 09:35:49 +00003029 Image offset to which the SPL should be padded before appending
3030 the SPL payload. By default, this is defined as
3031 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3032 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3033 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Woodeb7bd972012-12-06 13:33:16 +00003034
Scott Woodf147eb72012-09-21 16:27:32 -05003035 CONFIG_SPL_TARGET
3036 Final target image containing SPL and payload. Some SPLs
3037 use an arch-specific makefile fragment instead, for
3038 example if more than one image needs to be produced.
3039
Simon Glass82d94532013-05-08 08:05:59 +00003040 CONFIG_FIT_SPL_PRINT
3041 Printing information about a FIT image adds quite a bit of
3042 code to SPL. So this is normally disabled in SPL. Use this
3043 option to re-enable it. This will affect the output of the
3044 bootm command when booting a FIT image.
3045
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003046- TPL framework
3047 CONFIG_TPL
3048 Enable building of TPL globally.
3049
3050 CONFIG_TPL_PAD_TO
3051 Image offset to which the TPL should be padded before appending
3052 the TPL payload. By default, this is defined as
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02003053 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3054 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3055 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003056
wdenkc0aa5c52003-12-06 19:49:23 +00003057- Interrupt support (PPC):
3058
wdenk1ebf41e2004-01-02 14:00:00 +00003059 There are common interrupt_init() and timer_interrupt()
3060 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003061 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00003062 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003063 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00003064 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003065 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00003066 specific handling. If board has watchdog / status_led
3067 / other_activity_monitor it works automatically from
3068 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00003069
wdenkc6097192002-11-03 00:24:07 +00003070
Helmut Raigerd5a184b2011-10-20 04:19:47 +00003071Board initialization settings:
3072------------------------------
3073
3074During Initialization u-boot calls a number of board specific functions
3075to allow the preparation of board specific prerequisites, e.g. pin setup
3076before drivers are initialized. To enable these callbacks the
3077following configuration macros have to be defined. Currently this is
3078architecture specific, so please check arch/your_architecture/lib/board.c
3079typically in board_init_f() and board_init_r().
3080
3081- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3082- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3083- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3084- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003085
wdenkc6097192002-11-03 00:24:07 +00003086Configuration Settings:
3087-----------------------
3088
York Sun6c480012014-02-26 17:03:19 -08003089- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3090 Optionally it can be defined to support 64-bit memory commands.
3091
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003092- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003093 undefine this when you're short of memory.
3094
Peter Tyserdfb72b82009-01-27 18:03:12 -06003095- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3096 width of the commands listed in the 'help' command output.
3097
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003098- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003099 prompt for user input.
3100
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003101- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003102
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003103- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003104
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003105- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003106
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003107- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003108 the application (usually a Linux kernel) when it is
3109 booted
3110
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003111- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003112 List of legal baudrate settings for this board.
3113
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003114- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003115 Begin and End addresses of the area used by the
3116 simple memory test.
3117
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003118- CONFIG_SYS_ALT_MEMTEST:
wdenk57b2d802003-06-27 21:31:46 +00003119 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003120
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003121- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5958f4a2003-09-18 09:21:33 +00003122 Scratch address used by the alternate memory test
3123 You only need to set this if address zero isn't writeable
3124
York Sun5d286cd2015-12-04 11:57:07 -08003125- CONFIG_SYS_MEM_RESERVE_SECURE
York Sun1ef95cc2016-06-24 16:46:18 -07003126 Only implemented for ARMv8 for now.
York Sun5d286cd2015-12-04 11:57:07 -08003127 If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
3128 is substracted from total RAM and won't be reported to OS.
3129 This memory can be used as secure memory. A variable
York Sun1ef95cc2016-06-24 16:46:18 -07003130 gd->arch.secure_ram is used to track the location. In systems
York Sun5d286cd2015-12-04 11:57:07 -08003131 the RAM base is not zero, or RAM is divided into banks,
3132 this variable needs to be recalcuated to get the address.
3133
York Sun50739372015-12-07 11:05:29 -08003134- CONFIG_SYS_MEM_TOP_HIDE:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003135 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01003136 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003137 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01003138 fixing up gd->ram_size the Linux kernel should gets passed
3139 the now "corrected" memory size and won't touch it either.
3140 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01003141 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01003142 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01003143 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01003144
3145 This option can be used as a workaround for the 440EPx/GRx
3146 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3147 be touched.
3148
3149 WARNING: Please make sure that this value is a multiple of
3150 the Linux page size (normally 4k). If this is not the case,
3151 then the end address of the Linux memory will be located at a
3152 non page size aligned address and this could cause major
3153 problems.
3154
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003155- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003156 Enable temporary baudrate change while serial download
3157
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003158- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003159 Physical start address of SDRAM. _Must_ be 0 here.
3160
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003161- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003162 Physical start address of Flash memory.
3163
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003164- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003165 Physical start address of boot monitor code (set by
3166 make config files to be same as the text base address
Wolfgang Denk0708bc62010-10-07 21:51:12 +02003167 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003168 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003169
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003170- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00003171 Size of memory reserved for monitor code, used to
3172 determine _at_compile_time_ (!) if the environment is
3173 embedded within the U-Boot image, or in a separate
3174 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003175
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003176- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003177 Size of DRAM reserved for malloc() use.
3178
Simon Glass863e4042014-07-10 22:23:28 -06003179- CONFIG_SYS_MALLOC_F_LEN
3180 Size of the malloc() pool for use before relocation. If
3181 this is defined, then a very simple malloc() implementation
3182 will become available before relocation. The address is just
3183 below the global data, and the stack is moved down to make
3184 space.
3185
3186 This feature allocates regions with increasing addresses
3187 within the region. calloc() is supported, but realloc()
3188 is not available. free() is supported but does nothing.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003189 The memory will be freed (or in fact just forgotten) when
Simon Glass863e4042014-07-10 22:23:28 -06003190 U-Boot relocates itself.
3191
Simon Glass9fa901b2014-11-10 17:16:54 -07003192- CONFIG_SYS_MALLOC_SIMPLE
3193 Provides a simple and small malloc() and calloc() for those
3194 boards which do not use the full malloc in SPL (which is
3195 enabled with CONFIG_SYS_SPL_MALLOC_START).
3196
Thierry Redingc97d9742014-12-09 22:25:22 -07003197- CONFIG_SYS_NONCACHED_MEMORY:
3198 Size of non-cached memory area. This area of memory will be
3199 typically located right below the malloc() area and mapped
3200 uncached in the MMU. This is useful for drivers that would
3201 otherwise require a lot of explicit cache maintenance. For
3202 some drivers it's also impossible to properly maintain the
3203 cache. For example if the regions that need to be flushed
3204 are not a multiple of the cache-line size, *and* padding
3205 cannot be allocated between the regions to align them (i.e.
3206 if the HW requires a contiguous array of regions, and the
3207 size of each region is not cache-aligned), then a flush of
3208 one region may result in overwriting data that hardware has
3209 written to another region in the same cache-line. This can
3210 happen for example in network drivers where descriptors for
3211 buffers are typically smaller than the CPU cache-line (e.g.
3212 16 bytes vs. 32 or 64 bytes).
3213
3214 Non-cached memory is only supported on 32-bit ARM at present.
3215
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003216- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01003217 Normally compressed uImages are limited to an
3218 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003219 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01003220 to adjust this setting to your needs.
3221
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003222- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003223 Maximum size of memory mapped by the startup code of
3224 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003225 the Linux kernel (bd_info, boot arguments, FDT blob if
3226 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003227 environment variable is defined and non-zero. In such case
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003228 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denk092ae952011-10-26 10:21:21 +00003229 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likely26396382011-03-28 09:58:43 +00003230 variable "bootm_mapsize" will override the value of
3231 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3232 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003233
John Rigbyeea8e692010-10-13 13:57:35 -06003234- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3235 Enable initrd_high functionality. If defined then the
3236 initrd_high feature is enabled and the bootm ramdisk subcommand
3237 is enabled.
3238
3239- CONFIG_SYS_BOOT_GET_CMDLINE:
3240 Enables allocating and saving kernel cmdline in space between
3241 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3242
3243- CONFIG_SYS_BOOT_GET_KBD:
3244 Enables allocating and saving a kernel copy of the bd_info in
3245 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3246
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003247- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003248 Max number of Flash memory banks
3249
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003250- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003251 Max number of sectors on a Flash chip
3252
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003253- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003254 Timeout for Flash erase operations (in ms)
3255
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003256- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003257 Timeout for Flash write operations (in ms)
3258
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003259- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003260 Timeout for Flash set sector lock bit operation (in ms)
3261
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003262- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003263 Timeout for Flash clear lock bits operation (in ms)
3264
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003265- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00003266 If defined, hardware flash sectors protection is used
3267 instead of U-Boot software protection.
3268
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003269- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003270
3271 Enable TFTP transfers directly to flash memory;
3272 without this option such a download has to be
3273 performed in two steps: (1) download to RAM, and (2)
3274 copy from RAM to flash.
3275
3276 The two-step approach is usually more reliable, since
3277 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003278 the flash, but in some situations (when system RAM is
3279 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003280 downloaded image) this option may be very useful.
3281
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003282- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00003283 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00003284 common flash structure for storing flash geometry.
3285
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02003286- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00003287 This option also enables the building of the cfi_flash driver
3288 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003289
Piotr Ziecik3e939e92008-11-17 15:57:58 +01003290- CONFIG_FLASH_CFI_MTD
3291 This option enables the building of the cfi_mtd driver
3292 in the drivers directory. The driver exports CFI flash
3293 to the MTD layer.
3294
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003295- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02003296 Use buffered writes to flash.
3297
3298- CONFIG_FLASH_SPANSION_S29WS_N
3299 s29ws-n MirrorBit flash has non-standard addresses for buffered
3300 write commands.
3301
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003302- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01003303 If this option is defined, the common CFI flash doesn't
3304 print it's warning upon not recognized FLASH banks. This
3305 is useful, if some of the configured banks are only
3306 optionally available.
3307
Jerry Van Barenaae73572008-03-08 13:48:01 -05003308- CONFIG_FLASH_SHOW_PROGRESS
3309 If defined (must be an integer), print out countdown
3310 digits and dots. Recommended value: 45 (9..1) for 80
3311 column displays, 15 (3..1) for 40 column displays.
3312
Stefan Roesed20cba52013-04-04 15:53:14 +02003313- CONFIG_FLASH_VERIFY
3314 If defined, the content of the flash (destination) is compared
3315 against the source after the write operation. An error message
3316 will be printed when the contents are not identical.
3317 Please note that this option is useless in nearly all cases,
3318 since such flash programming errors usually are detected earlier
3319 while unprotecting/erasing/programming. Please only enable
3320 this option if you really know what you are doing.
3321
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003322- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003323 Defines the number of Ethernet receive buffers. On some
3324 Ethernet controllers it is recommended to set this value
stroese94ef1cf2003-06-05 15:39:44 +00003325 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3326 buffers can be full shortly after enabling the interface
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003327 on high Ethernet traffic.
stroese94ef1cf2003-06-05 15:39:44 +00003328 Defaults to 4 if not defined.
3329
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003330- CONFIG_ENV_MAX_ENTRIES
3331
Wolfgang Denk1136f692010-10-27 22:48:30 +02003332 Maximum number of entries in the hash table that is used
3333 internally to store the environment settings. The default
3334 setting is supposed to be generous and should work in most
3335 cases. This setting can be used to tune behaviour; see
3336 lib/hashtable.c for details.
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003337
Joe Hershberger71497d02012-12-11 22:16:31 -06003338- CONFIG_ENV_FLAGS_LIST_DEFAULT
3339- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003340 Enable validation of the values given to environment variables when
Joe Hershberger71497d02012-12-11 22:16:31 -06003341 calling env set. Variables can be restricted to only decimal,
3342 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3343 the variables can also be restricted to IP address or MAC address.
3344
3345 The format of the list is:
3346 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003347 access_attribute = [a|r|o|c]
3348 attributes = type_attribute[access_attribute]
Joe Hershberger71497d02012-12-11 22:16:31 -06003349 entry = variable_name[:attributes]
3350 list = entry[,list]
3351
3352 The type attributes are:
3353 s - String (default)
3354 d - Decimal
3355 x - Hexadecimal
3356 b - Boolean ([1yYtT|0nNfF])
3357 i - IP address
3358 m - MAC address
3359
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003360 The access attributes are:
3361 a - Any (default)
3362 r - Read-only
3363 o - Write-once
3364 c - Change-default
3365
Joe Hershberger71497d02012-12-11 22:16:31 -06003366 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3367 Define this to a list (string) to define the ".flags"
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003368 environment variable in the default or embedded environment.
Joe Hershberger71497d02012-12-11 22:16:31 -06003369
3370 - CONFIG_ENV_FLAGS_LIST_STATIC
3371 Define this to a list (string) to define validation that
3372 should be done if an entry is not found in the ".flags"
3373 environment variable. To override a setting in the static
3374 list, simply add an entry for the same variable name to the
3375 ".flags" variable.
3376
Joe Hershberger6db9fd42015-05-20 14:27:20 -05003377 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
3378 regular expression. This allows multiple variables to define the same
3379 flags without explicitly listing them for each variable.
3380
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003381- CONFIG_ENV_ACCESS_IGNORE_FORCE
3382 If defined, don't allow the -f switch to env set override variable
3383 access flags.
3384
Gabe Black3687fe42014-10-15 04:38:30 -06003385- CONFIG_USE_STDINT
3386 If stdint.h is available with your toolchain you can define this
3387 option to enable it. You can provide option 'USE_STDINT=1' when
3388 building U-Boot to enable this.
3389
wdenkc6097192002-11-03 00:24:07 +00003390The following definitions that deal with the placement and management
3391of environment data (variable area); in general, we support the
3392following configurations:
3393
Mike Frysinger63b8f122011-07-08 10:44:25 +00003394- CONFIG_BUILD_ENVCRC:
3395
3396 Builds up envcrc with the target environment so that external utils
3397 may easily extract it and embed it in final U-Boot images.
3398
wdenkc6097192002-11-03 00:24:07 +00003399BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003400in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003401console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00003402U-Boot will hang.
3403
3404Please note that even with NVRAM we still use a copy of the
3405environment in RAM: we could work on NVRAM directly, but we want to
3406keep settings there always unmodified except somebody uses "saveenv"
3407to save the current settings.
3408
Liu Gang85bcd732012-03-08 00:33:20 +00003409BE CAREFUL! For some special cases, the local device can not use
3410"saveenv" command. For example, the local device will get the
Liu Gang357bf5a2012-08-09 05:10:01 +00003411environment stored in a remote NOR flash by SRIO or PCIE link,
3412but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang85bcd732012-03-08 00:33:20 +00003413
Guennadi Liakhovetskifad24442009-05-18 16:07:22 +02003414- CONFIG_NAND_ENV_DST
3415
3416 Defines address in RAM to which the nand_spl code should copy the
3417 environment. If redundant environment is used, it will be copied to
3418 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3419
Bruce Adleredecc942007-11-02 13:15:42 -07003420Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00003421has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denk76af2782010-07-24 21:55:43 +02003422created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00003423until then to read environment variables.
3424
wdenk8dba0502003-03-31 16:34:49 +00003425The environment is protected by a CRC32 checksum. Before the monitor
3426is relocated into RAM, as a result of a bad CRC you will be working
3427with the compiled-in default environment - *silently*!!! [This is
3428necessary, because the first environment variable we need is the
3429"baudrate" setting for the console - if we have a bad CRC, we don't
3430have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00003431
3432Note: once the monitor has been relocated, then it will complain if
3433the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00003434use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00003435
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003436- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk9c53f402003-10-15 23:53:47 +00003437 Echo the inverted Ethernet link state to the fault LED.
wdenk49c3f672003-10-08 22:33:00 +00003438
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003439 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenk49c3f672003-10-08 22:33:00 +00003440 also needs to be defined.
3441
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003442- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00003443 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00003444
Ron Madriddfa028a2009-02-18 14:30:44 -08003445- CONFIG_NS16550_MIN_FUNCTIONS:
3446 Define this if you desire to only have use of the NS16550_init
3447 and NS16550_putc functions for the serial driver located at
3448 drivers/serial/ns16550.c. This option is useful for saving
3449 space for already greatly restricted images, including but not
3450 limited to NAND_SPL configurations.
3451
Simon Glass28a9e332012-11-30 13:01:18 +00003452- CONFIG_DISPLAY_BOARDINFO
3453 Display information about the board that U-Boot is running on
3454 when U-Boot starts up. The board function checkboard() is called
3455 to do this.
3456
Simon Glasse8822012012-11-30 13:01:19 +00003457- CONFIG_DISPLAY_BOARDINFO_LATE
3458 Similar to the previous option, but display this information
3459 later, once stdio is running and output goes to the LCD, if
3460 present.
3461
Sascha Silbe4b9c17c2013-08-11 16:40:43 +02003462- CONFIG_BOARD_SIZE_LIMIT:
3463 Maximum size of the U-Boot image. When defined, the
3464 build system checks that the actual size does not
3465 exceed it.
3466
wdenkc6097192002-11-03 00:24:07 +00003467Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00003468---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003469
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003470- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003471 Cache Line Size of the CPU.
3472
Timur Tabid8f341c2011-08-04 18:03:41 -05003473- CONFIG_SYS_CCSRBAR_DEFAULT:
3474 Default (power-on reset) physical address of CCSR on Freescale
3475 PowerPC SOCs.
3476
3477- CONFIG_SYS_CCSRBAR:
3478 Virtual address of CCSR. On a 32-bit build, this is typically
3479 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3480
Timur Tabid8f341c2011-08-04 18:03:41 -05003481- CONFIG_SYS_CCSRBAR_PHYS:
3482 Physical address of CCSR. CCSR can be relocated to a new
3483 physical address, if desired. In this case, this macro should
Wolfgang Denk092ae952011-10-26 10:21:21 +00003484 be set to that address. Otherwise, it should be set to the
Timur Tabid8f341c2011-08-04 18:03:41 -05003485 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
3486 is typically relocated on 36-bit builds. It is recommended
3487 that this macro be defined via the _HIGH and _LOW macros:
3488
3489 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3490 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3491
3492- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003493 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
3494 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabid8f341c2011-08-04 18:03:41 -05003495 used in assembly code, so it must not contain typecasts or
3496 integer size suffixes (e.g. "ULL").
3497
3498- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3499 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
3500 used in assembly code, so it must not contain typecasts or
3501 integer size suffixes (e.g. "ULL").
3502
3503- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3504 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3505 forced to a value that ensures that CCSR is not relocated.
3506
wdenk1272e232002-11-10 22:06:23 +00003507- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003508 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk1272e232002-11-10 22:06:23 +00003509
3510 the default drive number (default value 0)
3511
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003512 CONFIG_SYS_ISA_IO_STRIDE
wdenk1272e232002-11-10 22:06:23 +00003513
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003514 defines the spacing between FDC chipset registers
wdenk1272e232002-11-10 22:06:23 +00003515 (default value 1)
3516
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003517 CONFIG_SYS_ISA_IO_OFFSET
wdenk1272e232002-11-10 22:06:23 +00003518
wdenk4a5c8a72003-03-06 00:02:04 +00003519 defines the offset of register from address. It
3520 depends on which part of the data bus is connected to
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003521 the FDC chipset. (default value 0)
wdenk1272e232002-11-10 22:06:23 +00003522
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003523 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
3524 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk4a5c8a72003-03-06 00:02:04 +00003525 default value.
wdenk1272e232002-11-10 22:06:23 +00003526
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003527 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk4a5c8a72003-03-06 00:02:04 +00003528 fdc_hw_init() is called at the beginning of the FDC
3529 setup. fdc_hw_init() must be provided by the board
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003530 source code. It is used to make hardware-dependent
wdenk4a5c8a72003-03-06 00:02:04 +00003531 initializations.
wdenk1272e232002-11-10 22:06:23 +00003532
Macpaul Lind1e49942011-04-11 20:45:32 +00003533- CONFIG_IDE_AHB:
3534 Most IDE controllers were designed to be connected with PCI
3535 interface. Only few of them were designed for AHB interface.
3536 When software is doing ATA command and data transfer to
3537 IDE devices through IDE-AHB controller, some additional
3538 registers accessing to these kind of IDE-AHB controller
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003539 is required.
Macpaul Lind1e49942011-04-11 20:45:32 +00003540
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003541- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00003542 DO NOT CHANGE unless you know exactly what you're
Christophe Leroy069fa832017-07-06 10:23:22 +02003543 doing! (11-4) [MPC8xx systems only]
wdenkc6097192002-11-03 00:24:07 +00003544
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003545- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003546
wdenkeb20ad32003-09-05 23:19:14 +00003547 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00003548 initial data and stack; please note that this must be
3549 writable memory that is working WITHOUT special
3550 initialization, i. e. you CANNOT use normal RAM which
3551 will become available only after programming the
3552 memory controller and running certain initialization
3553 sequences.
3554
3555 U-Boot uses the following memory types:
Christophe Leroy069fa832017-07-06 10:23:22 +02003556 - MPC8xx: IMMR (internal memory of the CPU)
wdenkc6097192002-11-03 00:24:07 +00003557
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003558- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003559
3560 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003561 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
3562 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00003563 data is located at the end of the available space
Wolfgang Denk1c2e98e2010-10-26 13:32:32 +02003564 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Simon Glass9a6ac8b2016-10-02 18:01:06 -06003565 GENERATED_GBL_DATA_SIZE), and the initial stack is just
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003566 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
3567 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00003568
3569 Note:
3570 On the MPC824X (or other systems that use the data
3571 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003572 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00003573 point to an otherwise UNUSED address space between
3574 the top of RAM and the start of the PCI space.
3575
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003576- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00003577
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003578- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00003579 SDRAM timing
3580
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003581- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00003582 periodic timer for refresh
3583
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003584- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
3585 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
3586 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
3587 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003588 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3589
3590- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003591 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
3592 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003593 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3594
Andrew Sharp61d47ca2012-08-29 14:16:32 +00003595- CONFIG_PCI_ENUM_ONLY
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003596 Only scan through and get the devices on the buses.
Andrew Sharp61d47ca2012-08-29 14:16:32 +00003597 Don't do any setup work, presumably because someone or
3598 something has already done it, and we don't need to do it
3599 a second time. Useful for platforms that are pre-booted
3600 by coreboot or similar.
3601
Gabor Juhosb4458732013-05-30 07:06:12 +00003602- CONFIG_PCI_INDIRECT_BRIDGE:
3603 Enable support for indirect PCI bridges.
3604
Kumar Gala8975d7a2010-12-30 12:09:53 -06003605- CONFIG_SYS_SRIO:
3606 Chip has SRIO or not
3607
3608- CONFIG_SRIO1:
3609 Board has SRIO 1 port available
3610
3611- CONFIG_SRIO2:
3612 Board has SRIO 2 port available
3613
Liu Gang27afb9c2013-05-07 16:30:46 +08003614- CONFIG_SRIO_PCIE_BOOT_MASTER
3615 Board can support master function for Boot from SRIO and PCIE
3616
Kumar Gala8975d7a2010-12-30 12:09:53 -06003617- CONFIG_SYS_SRIOn_MEM_VIRT:
3618 Virtual Address of SRIO port 'n' memory region
3619
3620- CONFIG_SYS_SRIOn_MEM_PHYS:
3621 Physical Address of SRIO port 'n' memory region
3622
3623- CONFIG_SYS_SRIOn_MEM_SIZE:
3624 Size of SRIO port 'n' memory region
3625
Fabio Estevamf17e8782013-04-11 09:35:34 +00003626- CONFIG_SYS_NAND_BUSWIDTH_16BIT
3627 Defined to tell the NAND controller that the NAND chip is using
3628 a 16 bit bus.
3629 Not all NAND drivers use this symbol.
Fabio Estevam417052b2013-04-11 09:35:35 +00003630 Example of drivers that use it:
Fabio Estevamf17e8782013-04-11 09:35:34 +00003631 - drivers/mtd/nand/ndfc.c
Fabio Estevam417052b2013-04-11 09:35:35 +00003632 - drivers/mtd/nand/mxc_nand.c
Alex Watermancd6aae32011-05-19 15:08:36 -04003633
3634- CONFIG_SYS_NDFC_EBC0_CFG
3635 Sets the EBC0_CFG register for the NDFC. If not defined
3636 a default value will be used.
3637
Ben Warren45657152006-09-07 16:50:54 -04003638- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003639 Get DDR timing information from an I2C EEPROM. Common
3640 with pluggable memory modules such as SODIMMs
3641
Ben Warren45657152006-09-07 16:50:54 -04003642 SPD_EEPROM_ADDRESS
3643 I2C address of the SPD EEPROM
3644
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003645- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003646 If SPD EEPROM is on an I2C bus other than the first
3647 one, specify here. Note that the value must resolve
3648 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04003649
York Sune73cc042011-06-07 09:42:16 +08003650- CONFIG_SYS_DDR_RAW_TIMING
3651 Get DDR timing information from other than SPD. Common with
3652 soldered DDR chips onboard without SPD. DDR raw timing
3653 parameters are extracted from datasheet and hard-coded into
3654 header files or board specific files.
3655
York Sunbd495cf2011-09-16 13:21:35 -07003656- CONFIG_FSL_DDR_INTERACTIVE
3657 Enable interactive DDR debugging. See doc/README.fsl-ddr.
3658
York Sun8ced0502015-01-06 13:18:55 -08003659- CONFIG_FSL_DDR_SYNC_REFRESH
3660 Enable sync of refresh for multiple controllers.
3661
York Sunb6a35f82015-03-19 09:30:28 -07003662- CONFIG_FSL_DDR_BIST
3663 Enable built-in memory test for Freescale DDR controllers.
3664
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003665- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003666 Only for 83xx systems. If specified, then DDR should
3667 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06003668
wdenk6203e402004-04-18 10:13:26 +00003669- CONFIG_RMII
3670 Enable RMII mode for all FECs.
3671 Note that this is a global option, we can't
3672 have one FEC in standard MII mode and another in RMII mode.
3673
wdenk20c98a62004-04-23 20:32:05 +00003674- CONFIG_CRC32_VERIFY
3675 Add a verify option to the crc32 command.
3676 The syntax is:
3677
3678 => crc32 -v <address> <count> <crc32>
3679
3680 Where address/count indicate a memory area
3681 and crc32 is the correct crc32 which the
3682 area should have.
3683
wdenk64519362004-07-11 17:40:54 +00003684- CONFIG_LOOPW
3685 Add the "loopw" memory command. This only takes effect if
Simon Glass92ffdee2017-08-04 16:34:27 -06003686 the memory commands are activated globally (CONFIG_CMD_MEMORY).
wdenk64519362004-07-11 17:40:54 +00003687
stroesecc3af832004-12-16 18:46:55 +00003688- CONFIG_MX_CYCLIC
3689 Add the "mdc" and "mwc" memory commands. These are cyclic
3690 "md/mw" commands.
3691 Examples:
3692
wdenk07d7e6b2004-12-16 21:44:03 +00003693 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00003694 This command will print 4 bytes (10,11,12,13) each 500 ms.
3695
wdenk07d7e6b2004-12-16 21:44:03 +00003696 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00003697 This command will write 12345678 to address 100 all 10 ms.
3698
wdenk07d7e6b2004-12-16 21:44:03 +00003699 This only takes effect if the memory commands are activated
Simon Glass92ffdee2017-08-04 16:34:27 -06003700 globally (CONFIG_CMD_MEMORY).
stroesecc3af832004-12-16 18:46:55 +00003701
wdenk3d3d99f2005-04-04 12:44:11 +00003702- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Lin1cac36e2011-10-19 20:41:11 +00003703 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk302141d2010-11-27 23:30:56 +01003704 low level initializations (like setting up the memory
3705 controller) are omitted and/or U-Boot does not
3706 relocate itself into RAM.
wdenk3d3d99f2005-04-04 12:44:11 +00003707
Wolfgang Denk302141d2010-11-27 23:30:56 +01003708 Normally this variable MUST NOT be defined. The only
3709 exception is when U-Boot is loaded (to RAM) by some
3710 other boot loader or by a debugger which performs
3711 these initializations itself.
wdenk3d3d99f2005-04-04 12:44:11 +00003712
Simon Glass90844072016-05-05 07:28:06 -06003713- CONFIG_SKIP_LOWLEVEL_INIT_ONLY
3714 [ARM926EJ-S only] This allows just the call to lowlevel_init()
yeongjun Kim7a203682016-07-20 22:56:12 +09003715 to be skipped. The normal CP15 init (such as enabling the
Simon Glass90844072016-05-05 07:28:06 -06003716 instruction cache) is still performed.
3717
Aneesh V552a3192011-07-13 05:11:07 +00003718- CONFIG_SPL_BUILD
Magnus Lilja1ec96d82009-06-13 20:50:00 +02003719 Modifies the behaviour of start.S when compiling a loader
3720 that is executed before the actual U-Boot. E.g. when
3721 compiling a NAND SPL.
wdenk336b2bc2005-04-02 23:52:25 +00003722
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003723- CONFIG_TPL_BUILD
3724 Modifies the behaviour of start.S when compiling a loader
3725 that is executed after the SPL and before the actual U-Boot.
3726 It is loaded by the SPL.
3727
Ying Zhang0d4f5442013-05-20 14:07:23 +08003728- CONFIG_SYS_MPC85XX_NO_RESETVEC
3729 Only for 85xx systems. If this variable is specified, the section
3730 .resetvec is not kept and the section .bootpg is placed in the
3731 previous 4k of the .text section.
3732
Simon Glass17dabf02013-02-24 17:33:14 +00003733- CONFIG_ARCH_MAP_SYSMEM
3734 Generally U-Boot (and in particular the md command) uses
3735 effective address. It is therefore not necessary to regard
3736 U-Boot address as virtual addresses that need to be translated
3737 to physical addresses. However, sandbox requires this, since
3738 it maintains its own little RAM buffer which contains all
3739 addressable memory. This option causes some memory accesses
3740 to be mapped through map_sysmem() / unmap_sysmem().
3741
Simon Glassbfb59802013-02-14 04:18:54 +00003742- CONFIG_X86_RESET_VECTOR
3743 If defined, the x86 reset vector code is included. This is not
3744 needed when U-Boot is running from Coreboot.
Gabe Black14f82462012-11-27 21:08:06 +00003745
Heiko Schocher2233e462013-11-04 14:05:00 +01003746- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
3747 Enables the RTC32K OSC on AM33xx based plattforms
3748
Karicheri, Muralidharanc1dc61b2014-04-04 13:16:50 -04003749- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
3750 Option to disable subpage write in NAND driver
3751 driver that uses this:
3752 drivers/mtd/nand/davinci_nand.c
3753
Timur Tabi275f4bb2011-11-22 09:21:25 -06003754Freescale QE/FMAN Firmware Support:
3755-----------------------------------
3756
3757The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
3758loading of "firmware", which is encoded in the QE firmware binary format.
3759This firmware often needs to be loaded during U-Boot booting, so macros
3760are used to identify the storage device (NOR flash, SPI, etc) and the address
3761within that device.
3762
Zhao Qiang83a90842014-03-21 16:21:44 +08003763- CONFIG_SYS_FMAN_FW_ADDR
3764 The address in the storage device where the FMAN microcode is located. The
3765 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3766 is also specified.
3767
3768- CONFIG_SYS_QE_FW_ADDR
3769 The address in the storage device where the QE microcode is located. The
Timur Tabi275f4bb2011-11-22 09:21:25 -06003770 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3771 is also specified.
3772
3773- CONFIG_SYS_QE_FMAN_FW_LENGTH
3774 The maximum possible size of the firmware. The firmware binary format
3775 has a field that specifies the actual size of the firmware, but it
3776 might not be possible to read any part of the firmware unless some
3777 local storage is allocated to hold the entire firmware first.
3778
3779- CONFIG_SYS_QE_FMAN_FW_IN_NOR
3780 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
3781 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
3782 virtual address in NOR flash.
3783
3784- CONFIG_SYS_QE_FMAN_FW_IN_NAND
3785 Specifies that QE/FMAN firmware is located in NAND flash.
3786 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
3787
3788- CONFIG_SYS_QE_FMAN_FW_IN_MMC
3789 Specifies that QE/FMAN firmware is located on the primary SD/MMC
3790 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3791
Liu Gang1e084582012-03-08 00:33:18 +00003792- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
3793 Specifies that QE/FMAN firmware is located in the remote (master)
3794 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gang357bf5a2012-08-09 05:10:01 +00003795 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
3796 window->master inbound window->master LAW->the ucode address in
3797 master's memory space.
Timur Tabi275f4bb2011-11-22 09:21:25 -06003798
J. German Rivera8ff14b72014-06-23 15:15:55 -07003799Freescale Layerscape Management Complex Firmware Support:
3800---------------------------------------------------------
3801The Freescale Layerscape Management Complex (MC) supports the loading of
3802"firmware".
3803This firmware often needs to be loaded during U-Boot booting, so macros
3804are used to identify the storage device (NOR flash, SPI, etc) and the address
3805within that device.
3806
3807- CONFIG_FSL_MC_ENET
3808 Enable the MC driver for Layerscape SoCs.
3809
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05303810Freescale Layerscape Debug Server Support:
3811-------------------------------------------
3812The Freescale Layerscape Debug Server Support supports the loading of
3813"Debug Server firmware" and triggering SP boot-rom.
3814This firmware often needs to be loaded during U-Boot booting.
3815
York Sun928b6812015-12-07 11:08:58 -08003816- CONFIG_SYS_MC_RSV_MEM_ALIGN
3817 Define alignment of reserved memory MC requires
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05303818
Paul Kocialkowski7b917022015-07-26 18:48:15 +02003819Reproducible builds
3820-------------------
3821
3822In order to achieve reproducible builds, timestamps used in the U-Boot build
3823process have to be set to a fixed value.
3824
3825This is done using the SOURCE_DATE_EPOCH environment variable.
3826SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
3827option for U-Boot or an environment variable in U-Boot.
3828
3829SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
3830
wdenkc6097192002-11-03 00:24:07 +00003831Building the Software:
3832======================
3833
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003834Building U-Boot has been tested in several native build environments
3835and in many different cross environments. Of course we cannot support
3836all possibly existing versions of cross development tools in all
3837(potentially obsolete) versions. In case of tool chain problems we
3838recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3839which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003840
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003841If you are not using a native environment, it is assumed that you
3842have GNU cross compiling tools available in your path. In this case,
3843you must set the environment variable CROSS_COMPILE in your shell.
3844Note that no changes to the Makefile or any other source files are
3845necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00003846
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003847 $ CROSS_COMPILE=ppc_4xx-
3848 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00003849
Peter Tyserb06976d2009-03-13 18:54:51 -05003850Note: If you wish to generate Windows versions of the utilities in
3851 the tools directory you can use the MinGW toolchain
3852 (http://www.mingw.org). Set your HOST tools to the MinGW
3853 toolchain and execute 'make tools'. For example:
3854
3855 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
3856
3857 Binaries such as tools/mkimage.exe will be created which can
3858 be executed on computers running Windows.
3859
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003860U-Boot is intended to be simple to build. After installing the
3861sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00003862is done by typing:
3863
Holger Freyther7ba4e572014-08-04 09:26:05 +02003864 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00003865
Holger Freyther7ba4e572014-08-04 09:26:05 +02003866where "NAME_defconfig" is the name of one of the existing configu-
Michael Jones5a7fb6f2012-03-15 22:48:10 +00003867rations; see boards.cfg for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00003868
wdenk6c59edc2004-05-03 20:45:30 +00003869Note: for some board special configuration names may exist; check if
3870 additional information is available from the board vendor; for
3871 instance, the TQM823L systems are available without (standard)
3872 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003873 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00003874
Holger Freyther7ba4e572014-08-04 09:26:05 +02003875 make TQM823L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00003876 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00003877
Holger Freyther7ba4e572014-08-04 09:26:05 +02003878 make TQM823L_LCD_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00003879 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00003880
wdenk6c59edc2004-05-03 20:45:30 +00003881 etc.
wdenkc6097192002-11-03 00:24:07 +00003882
wdenkc6097192002-11-03 00:24:07 +00003883
wdenk6c59edc2004-05-03 20:45:30 +00003884Finally, type "make all", and you should get some working U-Boot
3885images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00003886
wdenk6c59edc2004-05-03 20:45:30 +00003887- "u-boot.bin" is a raw binary image
3888- "u-boot" is an image in ELF binary format
3889- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00003890
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003891By default the build is performed locally and the objects are saved
3892in the source directory. One of the two methods can be used to change
3893this behavior and build U-Boot to some external directory:
3894
38951. Add O= to the make command line invocations:
3896
3897 make O=/tmp/build distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02003898 make O=/tmp/build NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003899 make O=/tmp/build all
3900
Timo Ketolac8c67602014-11-06 14:39:05 +020039012. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003902
Timo Ketolac8c67602014-11-06 14:39:05 +02003903 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003904 make distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02003905 make NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003906 make all
3907
Timo Ketolac8c67602014-11-06 14:39:05 +02003908Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003909variable.
3910
wdenkc6097192002-11-03 00:24:07 +00003911
wdenk6c59edc2004-05-03 20:45:30 +00003912Please be aware that the Makefiles assume you are using GNU make, so
3913for instance on NetBSD you might need to use "gmake" instead of
3914native "make".
wdenkc6097192002-11-03 00:24:07 +00003915
wdenkc6097192002-11-03 00:24:07 +00003916
wdenk6c59edc2004-05-03 20:45:30 +00003917If the system board that you have is not listed, then you will need
3918to port U-Boot to your hardware platform. To do this, follow these
3919steps:
wdenkc6097192002-11-03 00:24:07 +00003920
Phil Sutterc77b4882015-12-25 14:41:18 +010039211. Create a new directory to hold your board specific code. Add any
wdenk6c59edc2004-05-03 20:45:30 +00003922 files you need. In your board directory, you will need at least
Phil Sutterc77b4882015-12-25 14:41:18 +01003923 the "Makefile" and a "<board>.c".
39242. Create a new configuration file "include/configs/<board>.h" for
3925 your board.
wdenk6c59edc2004-05-03 20:45:30 +000039263. If you're porting U-Boot to a new CPU, then also create a new
3927 directory to hold your CPU specific code. Add any files you need.
Holger Freyther7ba4e572014-08-04 09:26:05 +020039284. Run "make <board>_defconfig" with your new name.
wdenk6c59edc2004-05-03 20:45:30 +000039295. Type "make", and you should get a working "u-boot.srec" file
3930 to be installed on your target system.
39316. Debug and solve any problems that might arise.
3932 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00003933
wdenkc6097192002-11-03 00:24:07 +00003934
wdenk6c59edc2004-05-03 20:45:30 +00003935Testing of U-Boot Modifications, Ports to New Hardware, etc.:
3936==============================================================
wdenkc6097192002-11-03 00:24:07 +00003937
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003938If you have modified U-Boot sources (for instance added a new board
3939or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00003940provide feedback to the other developers. The feedback normally takes
3941the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003942official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00003943
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003944But before you submit such a patch, please verify that your modifi-
3945cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00003946the supported boards compile WITHOUT ANY compiler warnings. To do so,
Simon Glassdc27def2016-07-27 20:33:08 -06003947just run the buildman script (tools/buildman/buildman), which will
3948configure and build U-Boot for ALL supported system. Be warned, this
3949will take a while. Please see the buildman README, or run 'buildman -H'
3950for documentation.
wdenkc6097192002-11-03 00:24:07 +00003951
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003952
wdenk6c59edc2004-05-03 20:45:30 +00003953See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00003954
wdenkc6097192002-11-03 00:24:07 +00003955
wdenk6c59edc2004-05-03 20:45:30 +00003956Monitor Commands - Overview:
3957============================
wdenkc6097192002-11-03 00:24:07 +00003958
wdenk6c59edc2004-05-03 20:45:30 +00003959go - start application at address 'addr'
3960run - run commands in an environment variable
3961bootm - boot application image from memory
3962bootp - boot image via network using BootP/TFTP protocol
Marek Vasutcf41a9b2012-03-14 21:52:45 +00003963bootz - boot zImage from memory
wdenk6c59edc2004-05-03 20:45:30 +00003964tftpboot- boot image via network using TFTP protocol
3965 and env variables "ipaddr" and "serverip"
3966 (and eventually "gatewayip")
Simon Glass6a398d22011-10-24 18:00:07 +00003967tftpput - upload a file via network using TFTP protocol
wdenk6c59edc2004-05-03 20:45:30 +00003968rarpboot- boot image via network using RARP/TFTP protocol
3969diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
3970loads - load S-Record file over serial line
3971loadb - load binary file over serial line (kermit mode)
3972md - memory display
3973mm - memory modify (auto-incrementing)
3974nm - memory modify (constant address)
3975mw - memory write (fill)
3976cp - memory copy
3977cmp - memory compare
3978crc32 - checksum calculation
Peter Tyser469cde42009-04-18 22:34:03 -05003979i2c - I2C sub-system
wdenk6c59edc2004-05-03 20:45:30 +00003980sspi - SPI utility commands
3981base - print or set address offset
3982printenv- print environment variables
3983setenv - set environment variables
3984saveenv - save environment variables to persistent storage
3985protect - enable or disable FLASH write protection
3986erase - erase FLASH memory
3987flinfo - print FLASH memory information
Karl O. Pinc4baf03d2012-08-03 05:57:21 +00003988nand - NAND memory operations (see doc/README.nand)
wdenk6c59edc2004-05-03 20:45:30 +00003989bdinfo - print Board Info structure
3990iminfo - print header information for application image
3991coninfo - print console devices and informations
3992ide - IDE sub-system
3993loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00003994loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00003995mtest - simple RAM test
3996icache - enable or disable instruction cache
3997dcache - enable or disable data cache
3998reset - Perform RESET of the CPU
3999echo - echo args to console
4000version - print monitor version
4001help - print online help
4002? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00004003
wdenkc6097192002-11-03 00:24:07 +00004004
wdenk6c59edc2004-05-03 20:45:30 +00004005Monitor Commands - Detailed Description:
4006========================================
wdenkc6097192002-11-03 00:24:07 +00004007
wdenk6c59edc2004-05-03 20:45:30 +00004008TODO.
wdenkc6097192002-11-03 00:24:07 +00004009
wdenk6c59edc2004-05-03 20:45:30 +00004010For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00004011
4012
wdenk6c59edc2004-05-03 20:45:30 +00004013Environment Variables:
4014======================
wdenkc6097192002-11-03 00:24:07 +00004015
wdenk6c59edc2004-05-03 20:45:30 +00004016U-Boot supports user configuration using Environment Variables which
4017can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00004018
wdenk6c59edc2004-05-03 20:45:30 +00004019Environment Variables are set using "setenv", printed using
4020"printenv", and saved to Flash using "saveenv". Using "setenv"
4021without a value can be used to delete a variable from the
4022environment. As long as you don't save the environment you are
4023working with an in-memory copy. In case the Flash area containing the
4024environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00004025
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004026Some configuration options can be set using Environment Variables.
4027
4028List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00004029
wdenk6c59edc2004-05-03 20:45:30 +00004030 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00004031
wdenk6c59edc2004-05-03 20:45:30 +00004032 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00004033
wdenk6c59edc2004-05-03 20:45:30 +00004034 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00004035
wdenk6c59edc2004-05-03 20:45:30 +00004036 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00004037
wdenk6c59edc2004-05-03 20:45:30 +00004038 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00004039
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004040 bootm_low - Memory range available for image processing in the bootm
4041 command can be restricted. This variable is given as
4042 a hexadecimal number and defines lowest address allowed
4043 for use by the bootm command. See also "bootm_size"
4044 environment variable. Address defined by "bootm_low" is
4045 also the base of the initial memory mapping for the Linux
Grant Likely26396382011-03-28 09:58:43 +00004046 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4047 bootm_mapsize.
4048
Wolfgang Denk092ae952011-10-26 10:21:21 +00004049 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likely26396382011-03-28 09:58:43 +00004050 This variable is given as a hexadecimal number and it
4051 defines the size of the memory region starting at base
4052 address bootm_low that is accessible by the Linux kernel
4053 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
4054 as the default value if it is defined, and bootm_size is
4055 used otherwise.
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004056
4057 bootm_size - Memory range available for image processing in the bootm
4058 command can be restricted. This variable is given as
4059 a hexadecimal number and defines the size of the region
4060 allowed for use by the bootm command. See also "bootm_low"
4061 environment variable.
4062
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02004063 updatefile - Location of the software update file on a TFTP server, used
4064 by the automatic software update feature. Please refer to
4065 documentation in doc/README.update for more details.
4066
wdenk6c59edc2004-05-03 20:45:30 +00004067 autoload - if set to "no" (any string beginning with 'n'),
4068 "bootp" will just load perform a lookup of the
4069 configuration from the BOOTP server, but not try to
4070 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00004071
wdenk6c59edc2004-05-03 20:45:30 +00004072 autostart - if set to "yes", an image loaded using the "bootp",
4073 "rarpboot", "tftpboot" or "diskboot" commands will
4074 be automatically started (by internally calling
4075 "bootm")
wdenkc6097192002-11-03 00:24:07 +00004076
wdenk6c59edc2004-05-03 20:45:30 +00004077 If set to "no", a standalone image passed to the
4078 "bootm" command will be copied to the load address
4079 (and eventually uncompressed), but NOT be started.
4080 This can be used to load and uncompress arbitrary
4081 data.
wdenkc6097192002-11-03 00:24:07 +00004082
David A. Longd558a4e2011-07-09 16:40:19 -04004083 fdt_high - if set this restricts the maximum address that the
4084 flattened device tree will be copied into upon boot.
Shawn Guo0ca9e982012-01-09 21:54:08 +00004085 For example, if you have a system with 1 GB memory
4086 at physical address 0x10000000, while Linux kernel
4087 only recognizes the first 704 MB as low memory, you
4088 may need to set fdt_high as 0x3C000000 to have the
4089 device tree blob be copied to the maximum address
4090 of the 704 MB low memory, so that Linux kernel can
4091 access it during the boot procedure.
4092
David A. Longd558a4e2011-07-09 16:40:19 -04004093 If this is set to the special value 0xFFFFFFFF then
4094 the fdt will not be copied at all on boot. For this
4095 to work it must reside in writable memory, have
4096 sufficient padding on the end of it for u-boot to
4097 add the information it needs into it, and the memory
4098 must be accessible by the kernel.
4099
Simon Glassdc6fa642011-10-24 19:15:34 +00004100 fdtcontroladdr- if set this is the address of the control flattened
4101 device tree used by U-Boot when CONFIG_OF_CONTROL is
4102 defined.
4103
wdenk0e2bd9c2004-06-06 21:51:03 +00004104 i2cfast - (PPC405GP|PPC405EP only)
4105 if set to 'y' configures Linux I2C driver for fast
4106 mode (400kHZ). This environment variable is used in
4107 initialization code. So, for changes to be effective
4108 it must be saved and board must be reset.
4109
wdenk6c59edc2004-05-03 20:45:30 +00004110 initrd_high - restrict positioning of initrd images:
4111 If this variable is not set, initrd images will be
4112 copied to the highest possible address in RAM; this
4113 is usually what you want since it allows for
4114 maximum initrd size. If for some reason you want to
4115 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004116 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk6c59edc2004-05-03 20:45:30 +00004117 variable to a value of "no" or "off" or "0".
4118 Alternatively, you can set it to a maximum upper
4119 address to use (U-Boot will still check that it
4120 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00004121
wdenk6c59edc2004-05-03 20:45:30 +00004122 For instance, when you have a system with 16 MB
4123 RAM, and want to reserve 4 MB from use by Linux,
4124 you can do this by adding "mem=12M" to the value of
4125 the "bootargs" variable. However, now you must make
4126 sure that the initrd image is placed in the first
4127 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00004128
wdenk6c59edc2004-05-03 20:45:30 +00004129 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00004130
wdenk6c59edc2004-05-03 20:45:30 +00004131 If you set initrd_high to 0xFFFFFFFF, this is an
4132 indication to U-Boot that all addresses are legal
4133 for the Linux kernel, including addresses in flash
4134 memory. In this case U-Boot will NOT COPY the
4135 ramdisk at all. This may be useful to reduce the
4136 boot time on your system, but requires that this
4137 feature is supported by your Linux kernel.
wdenk3f9ab982003-04-12 23:38:12 +00004138
wdenk6c59edc2004-05-03 20:45:30 +00004139 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00004140
wdenk6c59edc2004-05-03 20:45:30 +00004141 loadaddr - Default load address for commands like "bootp",
4142 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00004143
wdenk6c59edc2004-05-03 20:45:30 +00004144 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00004145
wdenk6c59edc2004-05-03 20:45:30 +00004146 serverip - TFTP server IP address; needed for tftpboot command
wdenk6f770ed2003-05-23 23:18:21 +00004147
wdenk6c59edc2004-05-03 20:45:30 +00004148 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00004149
wdenk6c59edc2004-05-03 20:45:30 +00004150 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00004151
wdenk6c59edc2004-05-03 20:45:30 +00004152 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00004153
Mike Frysingera23230c2011-10-02 10:01:27 +00004154 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00004155
Mike Frysingera23230c2011-10-02 10:01:27 +00004156 ethact - controls which interface is currently active.
4157 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00004158
Heiko Schocherc5e84052010-07-20 17:45:02 +02004159 => setenv ethact FEC
4160 => ping 192.168.0.1 # traffic sent on FEC
4161 => setenv ethact SCC
4162 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00004163
Matthias Fuchs204f0ec2008-01-17 07:45:05 +01004164 ethrotate - When set to "no" U-Boot does not go through all
4165 available network interfaces.
4166 It just stays at the currently selected interface.
4167
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004168 netretry - When set to "no" each network operation will
wdenk6c59edc2004-05-03 20:45:30 +00004169 either succeed or fail without retrying.
4170 When set to "once" the network operation will
4171 fail when all the available network interfaces
4172 are tried once without success.
4173 Useful on scripts which control the retry operation
4174 themselves.
wdenkc6097192002-11-03 00:24:07 +00004175
Jean-Christophe PLAGNIOL-VILLARD1948d6c2009-01-31 09:53:39 +01004176 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDd2164ef2008-01-07 08:41:34 +01004177
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004178 silent_linux - If set then Linux will be told to boot silently, by
Simon Glass5db3f932013-07-16 20:10:00 -07004179 changing the console to be empty. If "yes" it will be
4180 made silent. If "no" it will not be made silent. If
4181 unset, then it will be made silent if the U-Boot console
4182 is silent.
4183
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02004184 tftpsrcp - If this is set, the value is used for TFTP's
Wolfgang Denke3cfce52005-09-24 22:37:32 +02004185 UDP source port.
4186
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02004187 tftpdstp - If this is set, the value is used for TFTP's UDP
Wolfgang Denk227b5192005-09-24 23:25:46 +02004188 destination port instead of the Well Know Port 69.
4189
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004190 tftpblocksize - Block size to use for TFTP transfers; if not set,
4191 we use the TFTP server's default block size
4192
4193 tftptimeout - Retransmission timeout for TFTP packets (in milli-
4194 seconds, minimum value is 1000 = 1 second). Defines
4195 when a packet is considered to be lost so it has to
4196 be retransmitted. The default is 5000 = 5 seconds.
4197 Lowering this value may make downloads succeed
4198 faster in networks with high packet loss rates or
4199 with unreliable TFTP servers.
4200
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02004201 tftptimeoutcountmax - maximum count of TFTP timeouts (no
4202 unit, minimum value = 0). Defines how many timeouts
4203 can happen during a single file transfer before that
4204 transfer is aborted. The default is 10, and 0 means
4205 'no timeouts allowed'. Increasing this value may help
4206 downloads succeed with high packet loss rates, or with
4207 unreliable TFTP servers or client hardware.
4208
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004209 vlan - When set to a value < 4095 the traffic over
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004210 Ethernet is encapsulated/received over 802.1q
wdenk6c59edc2004-05-03 20:45:30 +00004211 VLAN tagged frames.
wdenk145d2c12004-04-15 21:48:45 +00004212
Alexandre Messier15971322016-02-01 17:08:57 -05004213 bootpretryperiod - Period during which BOOTP/DHCP sends retries.
4214 Unsigned value, in milliseconds. If not set, the period will
4215 be either the default (28000), or a value based on
4216 CONFIG_NET_RETRY_COUNT, if defined. This value has
4217 precedence over the valu based on CONFIG_NET_RETRY_COUNT.
4218
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004219The following image location variables contain the location of images
4220used in booting. The "Image" column gives the role of the image and is
4221not an environment variable name. The other columns are environment
4222variable names. "File Name" gives the name of the file on a TFTP
4223server, "RAM Address" gives the location in RAM the image will be
4224loaded to, and "Flash Location" gives the image's address in NOR
4225flash or offset in NAND flash.
4226
4227*Note* - these variables don't have to be defined for all boards, some
Fabio Estevambb7d4972015-04-25 18:53:10 -03004228boards currently use other variables for these purposes, and some
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004229boards use these variables for other purposes.
4230
Wolfgang Denk092ae952011-10-26 10:21:21 +00004231Image File Name RAM Address Flash Location
4232----- --------- ----------- --------------
4233u-boot u-boot u-boot_addr_r u-boot_addr
4234Linux kernel bootfile kernel_addr_r kernel_addr
4235device tree blob fdtfile fdt_addr_r fdt_addr
4236ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004237
wdenk6c59edc2004-05-03 20:45:30 +00004238The following environment variables may be used and automatically
4239updated by the network boot commands ("bootp" and "rarpboot"),
4240depending the information provided by your boot server:
wdenk145d2c12004-04-15 21:48:45 +00004241
wdenk6c59edc2004-05-03 20:45:30 +00004242 bootfile - see above
4243 dnsip - IP address of your Domain Name Server
4244 dnsip2 - IP address of your secondary Domain Name Server
4245 gatewayip - IP address of the Gateway (Router) to use
4246 hostname - Target hostname
4247 ipaddr - see above
4248 netmask - Subnet Mask
4249 rootpath - Pathname of the root filesystem on the NFS server
4250 serverip - see above
wdenk145d2c12004-04-15 21:48:45 +00004251
wdenk145d2c12004-04-15 21:48:45 +00004252
wdenk6c59edc2004-05-03 20:45:30 +00004253There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004254
wdenk6c59edc2004-05-03 20:45:30 +00004255 serial# - contains hardware identification information such
4256 as type string and/or serial number
4257 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00004258
wdenk6c59edc2004-05-03 20:45:30 +00004259These variables can be set only once (usually during manufacturing of
4260the board). U-Boot refuses to delete or overwrite these variables
4261once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00004262
4263
wdenk6c59edc2004-05-03 20:45:30 +00004264Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004265
wdenk6c59edc2004-05-03 20:45:30 +00004266 ver - Contains the U-Boot version string as printed
4267 with the "version" command. This variable is
4268 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00004269
wdenkc6097192002-11-03 00:24:07 +00004270
wdenk6c59edc2004-05-03 20:45:30 +00004271Please note that changes to some configuration parameters may take
4272only effect after the next boot (yes, that's just like Windoze :-).
stroeseb9c17c52003-04-04 15:53:41 +00004273
stroeseb9c17c52003-04-04 15:53:41 +00004274
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004275Callback functions for environment variables:
4276---------------------------------------------
4277
4278For some environment variables, the behavior of u-boot needs to change
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004279when their values are changed. This functionality allows functions to
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004280be associated with arbitrary variables. On creation, overwrite, or
4281deletion, the callback will provide the opportunity for some side
4282effect to happen or for the change to be rejected.
4283
4284The callbacks are named and associated with a function using the
4285U_BOOT_ENV_CALLBACK macro in your board or driver code.
4286
4287These callbacks are associated with variables in one of two ways. The
4288static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4289in the board configuration to a string that defines a list of
4290associations. The list must be in the following format:
4291
4292 entry = variable_name[:callback_name]
4293 list = entry[,list]
4294
4295If the callback name is not specified, then the callback is deleted.
4296Spaces are also allowed anywhere in the list.
4297
4298Callbacks can also be associated by defining the ".callbacks" variable
4299with the same list format above. Any association in ".callbacks" will
4300override any association in the static list. You can define
4301CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004302".callbacks" environment variable in the default or embedded environment.
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004303
Joe Hershberger6db9fd42015-05-20 14:27:20 -05004304If CONFIG_REGEX is defined, the variable_name above is evaluated as a
4305regular expression. This allows multiple variables to be connected to
4306the same callback without explicitly listing them all out.
4307
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004308
wdenk6c59edc2004-05-03 20:45:30 +00004309Command Line Parsing:
4310=====================
stroeseb9c17c52003-04-04 15:53:41 +00004311
wdenk6c59edc2004-05-03 20:45:30 +00004312There are two different command line parsers available with U-Boot:
4313the old "simple" one, and the much more powerful "hush" shell:
wdenkc6097192002-11-03 00:24:07 +00004314
wdenk6c59edc2004-05-03 20:45:30 +00004315Old, simple command line parser:
4316--------------------------------
wdenkc6097192002-11-03 00:24:07 +00004317
wdenk6c59edc2004-05-03 20:45:30 +00004318- supports environment variables (through setenv / saveenv commands)
4319- several commands on one line, separated by ';'
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01004320- variable substitution using "... ${name} ..." syntax
wdenk6c59edc2004-05-03 20:45:30 +00004321- special characters ('$', ';') can be escaped by prefixing with '\',
4322 for example:
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01004323 setenv bootcmd bootm \${address}
wdenk6c59edc2004-05-03 20:45:30 +00004324- You can also escape text by enclosing in single apostrophes, for example:
4325 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00004326
wdenk6c59edc2004-05-03 20:45:30 +00004327Hush shell:
4328-----------
wdenkf4688a22003-05-28 08:06:31 +00004329
wdenk6c59edc2004-05-03 20:45:30 +00004330- similar to Bourne shell, with control structures like
4331 if...then...else...fi, for...do...done; while...do...done,
4332 until...do...done, ...
4333- supports environment ("global") variables (through setenv / saveenv
4334 commands) and local shell variables (through standard shell syntax
4335 "name=value"); only environment variables can be used with "run"
4336 command
wdenkf4688a22003-05-28 08:06:31 +00004337
wdenk6c59edc2004-05-03 20:45:30 +00004338General rules:
4339--------------
wdenkf4688a22003-05-28 08:06:31 +00004340
wdenk6c59edc2004-05-03 20:45:30 +00004341(1) If a command line (or an environment variable executed by a "run"
4342 command) contains several commands separated by semicolon, and
4343 one of these commands fails, then the remaining commands will be
4344 executed anyway.
wdenkf4688a22003-05-28 08:06:31 +00004345
wdenk6c59edc2004-05-03 20:45:30 +00004346(2) If you execute several variables with one call to run (i. e.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004347 calling run with a list of variables as arguments), any failing
wdenk6c59edc2004-05-03 20:45:30 +00004348 command will cause "run" to terminate, i. e. the remaining
4349 variables are not executed.
wdenkf4688a22003-05-28 08:06:31 +00004350
wdenk6c59edc2004-05-03 20:45:30 +00004351Note for Redundant Ethernet Interfaces:
4352=======================================
wdenkf4688a22003-05-28 08:06:31 +00004353
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004354Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00004355such configurations and is capable of automatic selection of a
4356"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00004357
wdenk6c59edc2004-05-03 20:45:30 +00004358Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
4359MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4360"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00004361
wdenk6c59edc2004-05-03 20:45:30 +00004362If the network interface stores some valid MAC address (for instance
4363in SROM), this is used as default address if there is NO correspon-
4364ding setting in the environment; if the corresponding environment
4365variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00004366
wdenk6c59edc2004-05-03 20:45:30 +00004367o If the SROM has a valid MAC address, and there is no address in the
4368 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00004369
wdenk6c59edc2004-05-03 20:45:30 +00004370o If there is no valid address in the SROM, and a definition in the
4371 environment exists, then the value from the environment variable is
4372 used.
wdenkc6097192002-11-03 00:24:07 +00004373
wdenk6c59edc2004-05-03 20:45:30 +00004374o If both the SROM and the environment contain a MAC address, and
4375 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00004376
wdenk6c59edc2004-05-03 20:45:30 +00004377o If both the SROM and the environment contain a MAC address, and the
4378 addresses differ, the value from the environment is used and a
4379 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00004380
wdenk6c59edc2004-05-03 20:45:30 +00004381o If neither SROM nor the environment contain a MAC address, an error
Joe Hershberger2dc2b5d2015-05-04 14:55:13 -05004382 is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
4383 a random, locally-assigned MAC is used.
wdenkc6097192002-11-03 00:24:07 +00004384
Ben Warren6db991a2010-04-26 11:11:46 -07004385If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denk092ae952011-10-26 10:21:21 +00004386will be programmed into hardware as part of the initialization process. This
Ben Warren6db991a2010-04-26 11:11:46 -07004387may be skipped by setting the appropriate 'ethmacskip' environment variable.
4388The naming convention is as follows:
4389"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00004390
wdenk6c59edc2004-05-03 20:45:30 +00004391Image Formats:
4392==============
wdenkc6097192002-11-03 00:24:07 +00004393
Marian Balakowicz18710b82008-03-12 12:13:13 +01004394U-Boot is capable of booting (and performing other auxiliary operations on)
4395images in two formats:
4396
4397New uImage format (FIT)
4398-----------------------
4399
4400Flexible and powerful format based on Flattened Image Tree -- FIT (similar
4401to Flattened Device Tree). It allows the use of images with multiple
4402components (several kernels, ramdisks, etc.), with contents protected by
4403SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
4404
4405
4406Old uImage format
4407-----------------
4408
4409Old image format is based on binary files which can be basically anything,
4410preceded by a special header; see the definitions in include/image.h for
4411details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00004412
wdenk6c59edc2004-05-03 20:45:30 +00004413* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4414 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05004415 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4416 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4417 INTEGRITY).
Andy Shevchenko8cb5cdd2017-07-05 16:25:22 +03004418* Target CPU Architecture (Provisions for Alpha, ARM, Intel x86,
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004419 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
Andy Shevchenko8cb5cdd2017-07-05 16:25:22 +03004420 Currently supported: ARM, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00004421* Compression Type (uncompressed, gzip, bzip2)
4422* Load Address
4423* Entry Point
4424* Image Name
4425* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00004426
wdenk6c59edc2004-05-03 20:45:30 +00004427The header is marked by a special Magic Number, and both the header
4428and the data portions of the image are secured against corruption by
4429CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00004430
wdenkc6097192002-11-03 00:24:07 +00004431
wdenk6c59edc2004-05-03 20:45:30 +00004432Linux Support:
4433==============
wdenkc6097192002-11-03 00:24:07 +00004434
wdenk6c59edc2004-05-03 20:45:30 +00004435Although U-Boot should support any OS or standalone application
4436easily, the main focus has always been on Linux during the design of
4437U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004438
wdenk6c59edc2004-05-03 20:45:30 +00004439U-Boot includes many features that so far have been part of some
4440special "boot loader" code within the Linux kernel. Also, any
4441"initrd" images to be used are no longer part of one big Linux image;
4442instead, kernel and "initrd" are separate images. This implementation
4443serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00004444
wdenk6c59edc2004-05-03 20:45:30 +00004445- the same features can be used for other OS or standalone
4446 applications (for instance: using compressed images to reduce the
4447 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00004448
wdenk6c59edc2004-05-03 20:45:30 +00004449- it becomes much easier to port new Linux kernel versions because
4450 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00004451
wdenk6c59edc2004-05-03 20:45:30 +00004452- the same Linux kernel image can now be used with different "initrd"
4453 images; of course this also means that different kernel images can
4454 be run with the same "initrd". This makes testing easier (you don't
4455 have to build a new "zImage.initrd" Linux image when you just
4456 change a file in your "initrd"). Also, a field-upgrade of the
4457 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00004458
wdenkc6097192002-11-03 00:24:07 +00004459
wdenk6c59edc2004-05-03 20:45:30 +00004460Linux HOWTO:
4461============
wdenkc6097192002-11-03 00:24:07 +00004462
wdenk6c59edc2004-05-03 20:45:30 +00004463Porting Linux to U-Boot based systems:
4464---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004465
wdenk6c59edc2004-05-03 20:45:30 +00004466U-Boot cannot save you from doing all the necessary modifications to
4467configure the Linux device drivers for use with your target hardware
4468(no, we don't intend to provide a full virtual machine interface to
4469Linux :-).
wdenkc6097192002-11-03 00:24:07 +00004470
Stefan Roese88fbf932010-04-15 16:07:28 +02004471But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00004472
wdenk6c59edc2004-05-03 20:45:30 +00004473Just make sure your machine specific header file (for instance
4474include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02004475Information structure as we define in include/asm-<arch>/u-boot.h,
4476and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004477as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00004478
Simon Glassd097e592014-06-11 23:29:46 -06004479Note that U-Boot now has a driver model, a unified model for drivers.
4480If you are adding a new driver, plumb it into driver model. If there
4481is no uclass available, you are encouraged to create one. See
4482doc/driver-model.
4483
wdenkc6097192002-11-03 00:24:07 +00004484
wdenk6c59edc2004-05-03 20:45:30 +00004485Configuring the Linux kernel:
4486-----------------------------
wdenkc6097192002-11-03 00:24:07 +00004487
wdenk6c59edc2004-05-03 20:45:30 +00004488No specific requirements for U-Boot. Make sure you have some root
4489device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00004490
wdenkc6097192002-11-03 00:24:07 +00004491
wdenk6c59edc2004-05-03 20:45:30 +00004492Building a Linux Image:
4493-----------------------
wdenkc6097192002-11-03 00:24:07 +00004494
wdenk6c59edc2004-05-03 20:45:30 +00004495With U-Boot, "normal" build targets like "zImage" or "bzImage" are
4496not used. If you use recent kernel source, a new build target
4497"uImage" will exist which automatically builds an image usable by
4498U-Boot. Most older kernels also have support for a "pImage" target,
4499which was introduced for our predecessor project PPCBoot and uses a
4500100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00004501
wdenk6c59edc2004-05-03 20:45:30 +00004502Example:
wdenkc6097192002-11-03 00:24:07 +00004503
Holger Freyther7ba4e572014-08-04 09:26:05 +02004504 make TQM850L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00004505 make oldconfig
4506 make dep
4507 make uImage
wdenkc6097192002-11-03 00:24:07 +00004508
wdenk6c59edc2004-05-03 20:45:30 +00004509The "uImage" build target uses a special tool (in 'tools/mkimage') to
4510encapsulate a compressed Linux kernel image with header information,
4511CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00004512
wdenk6c59edc2004-05-03 20:45:30 +00004513* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00004514
wdenk6c59edc2004-05-03 20:45:30 +00004515* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00004516
wdenk6c59edc2004-05-03 20:45:30 +00004517 ${CROSS_COMPILE}-objcopy -O binary \
4518 -R .note -R .comment \
4519 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00004520
wdenk6c59edc2004-05-03 20:45:30 +00004521* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00004522
wdenk6c59edc2004-05-03 20:45:30 +00004523 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00004524
wdenk6c59edc2004-05-03 20:45:30 +00004525* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00004526
wdenk6c59edc2004-05-03 20:45:30 +00004527 mkimage -A ppc -O linux -T kernel -C gzip \
4528 -a 0 -e 0 -n "Linux Kernel Image" \
4529 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00004530
wdenkc6097192002-11-03 00:24:07 +00004531
wdenk6c59edc2004-05-03 20:45:30 +00004532The "mkimage" tool can also be used to create ramdisk images for use
4533with U-Boot, either separated from the Linux kernel image, or
4534combined into one file. "mkimage" encapsulates the images with a 64
4535byte header containing information about target architecture,
4536operating system, image type, compression method, entry points, time
4537stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00004538
wdenk6c59edc2004-05-03 20:45:30 +00004539"mkimage" can be called in two ways: to verify existing images and
4540print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00004541
wdenk6c59edc2004-05-03 20:45:30 +00004542In the first form (with "-l" option) mkimage lists the information
4543contained in the header of an existing U-Boot image; this includes
4544checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00004545
wdenk6c59edc2004-05-03 20:45:30 +00004546 tools/mkimage -l image
4547 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00004548
wdenk6c59edc2004-05-03 20:45:30 +00004549The second form (with "-d" option) is used to build a U-Boot image
4550from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00004551
wdenk6c59edc2004-05-03 20:45:30 +00004552 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4553 -n name -d data_file image
4554 -A ==> set architecture to 'arch'
4555 -O ==> set operating system to 'os'
4556 -T ==> set image type to 'type'
4557 -C ==> set compression type 'comp'
4558 -a ==> set load address to 'addr' (hex)
4559 -e ==> set entry point to 'ep' (hex)
4560 -n ==> set image name to 'name'
4561 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00004562
wdenkcd914452004-05-29 16:53:29 +00004563Right now, all Linux kernels for PowerPC systems use the same load
4564address (0x00000000), but the entry point address depends on the
4565kernel version:
wdenkc6097192002-11-03 00:24:07 +00004566
wdenk6c59edc2004-05-03 20:45:30 +00004567- 2.2.x kernels have the entry point at 0x0000000C,
4568- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00004569
wdenk6c59edc2004-05-03 20:45:30 +00004570So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00004571
wdenk6c59edc2004-05-03 20:45:30 +00004572 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4573 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02004574 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk6c59edc2004-05-03 20:45:30 +00004575 > examples/uImage.TQM850L
4576 Image Name: 2.4.4 kernel for TQM850L
4577 Created: Wed Jul 19 02:34:59 2000
4578 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4579 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4580 Load Address: 0x00000000
4581 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004582
wdenk6c59edc2004-05-03 20:45:30 +00004583To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00004584
wdenk6c59edc2004-05-03 20:45:30 +00004585 -> tools/mkimage -l examples/uImage.TQM850L
4586 Image Name: 2.4.4 kernel for TQM850L
4587 Created: Wed Jul 19 02:34:59 2000
4588 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4589 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4590 Load Address: 0x00000000
4591 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004592
wdenk6c59edc2004-05-03 20:45:30 +00004593NOTE: for embedded systems where boot time is critical you can trade
4594speed for memory and install an UNCOMPRESSED image instead: this
4595needs more space in Flash, but boots much faster since it does not
4596need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00004597
Stefan Roese88fbf932010-04-15 16:07:28 +02004598 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk6c59edc2004-05-03 20:45:30 +00004599 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4600 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02004601 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk6c59edc2004-05-03 20:45:30 +00004602 > examples/uImage.TQM850L-uncompressed
4603 Image Name: 2.4.4 kernel for TQM850L
4604 Created: Wed Jul 19 02:34:59 2000
4605 Image Type: PowerPC Linux Kernel Image (uncompressed)
4606 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
4607 Load Address: 0x00000000
4608 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004609
wdenkc6097192002-11-03 00:24:07 +00004610
wdenk6c59edc2004-05-03 20:45:30 +00004611Similar you can build U-Boot images from a 'ramdisk.image.gz' file
4612when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00004613
wdenk6c59edc2004-05-03 20:45:30 +00004614 -> tools/mkimage -n 'Simple Ramdisk Image' \
4615 > -A ppc -O linux -T ramdisk -C gzip \
4616 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
4617 Image Name: Simple Ramdisk Image
4618 Created: Wed Jan 12 14:01:50 2000
4619 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4620 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
4621 Load Address: 0x00000000
4622 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004623
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07004624The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
4625option performs the converse operation of the mkimage's second form (the "-d"
4626option). Given an image built by mkimage, the dumpimage extracts a "data file"
4627from the image:
4628
Guilherme Maciel Ferreira40bf5632015-01-15 02:54:40 -02004629 tools/dumpimage -i image -T type -p position data_file
4630 -i ==> extract from the 'image' a specific 'data_file'
4631 -T ==> set image type to 'type'
4632 -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07004633
wdenkc6097192002-11-03 00:24:07 +00004634
wdenk6c59edc2004-05-03 20:45:30 +00004635Installing a Linux Image:
4636-------------------------
wdenkc6097192002-11-03 00:24:07 +00004637
wdenk6c59edc2004-05-03 20:45:30 +00004638To downloading a U-Boot image over the serial (console) interface,
4639you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00004640
wdenk6c59edc2004-05-03 20:45:30 +00004641 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00004642
wdenk6c59edc2004-05-03 20:45:30 +00004643The 'objcopy' does not understand the information in the U-Boot
4644image header, so the resulting S-Record file will be relative to
4645address 0x00000000. To load it to a given address, you need to
4646specify the target address as 'offset' parameter with the 'loads'
4647command.
wdenkc6097192002-11-03 00:24:07 +00004648
wdenk6c59edc2004-05-03 20:45:30 +00004649Example: install the image to address 0x40100000 (which on the
4650TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00004651
wdenk6c59edc2004-05-03 20:45:30 +00004652 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00004653
wdenk6c59edc2004-05-03 20:45:30 +00004654 .......... done
4655 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00004656
wdenk6c59edc2004-05-03 20:45:30 +00004657 => loads 40100000
4658 ## Ready for S-Record download ...
4659 ~>examples/image.srec
4660 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
4661 ...
4662 15989 15990 15991 15992
4663 [file transfer complete]
4664 [connected]
4665 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004666
wdenkc6097192002-11-03 00:24:07 +00004667
wdenk6c59edc2004-05-03 20:45:30 +00004668You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004669this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00004670corruption happened:
wdenkc6097192002-11-03 00:24:07 +00004671
wdenk6c59edc2004-05-03 20:45:30 +00004672 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00004673
wdenk6c59edc2004-05-03 20:45:30 +00004674 ## Checking Image at 40100000 ...
4675 Image Name: 2.2.13 for initrd on TQM850L
4676 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4677 Data Size: 335725 Bytes = 327 kB = 0 MB
4678 Load Address: 00000000
4679 Entry Point: 0000000c
4680 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004681
4682
wdenk6c59edc2004-05-03 20:45:30 +00004683Boot Linux:
4684-----------
wdenkc6097192002-11-03 00:24:07 +00004685
wdenk6c59edc2004-05-03 20:45:30 +00004686The "bootm" command is used to boot an application that is stored in
4687memory (RAM or Flash). In case of a Linux kernel image, the contents
4688of the "bootargs" environment variable is passed to the kernel as
4689parameters. You can check and modify this variable using the
4690"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00004691
wdenkc6097192002-11-03 00:24:07 +00004692
wdenk6c59edc2004-05-03 20:45:30 +00004693 => printenv bootargs
4694 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00004695
wdenk6c59edc2004-05-03 20:45:30 +00004696 => 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 +00004697
wdenk6c59edc2004-05-03 20:45:30 +00004698 => printenv bootargs
4699 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 +00004700
wdenk6c59edc2004-05-03 20:45:30 +00004701 => bootm 40020000
4702 ## Booting Linux kernel at 40020000 ...
4703 Image Name: 2.2.13 for NFS on TQM850L
4704 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4705 Data Size: 381681 Bytes = 372 kB = 0 MB
4706 Load Address: 00000000
4707 Entry Point: 0000000c
4708 Verifying Checksum ... OK
4709 Uncompressing Kernel Image ... OK
4710 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
4711 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4712 time_init: decrementer frequency = 187500000/60
4713 Calibrating delay loop... 49.77 BogoMIPS
4714 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
4715 ...
wdenkc6097192002-11-03 00:24:07 +00004716
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004717If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00004718the memory addresses of both the kernel and the initrd image (PPBCOOT
4719format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00004720
wdenk6c59edc2004-05-03 20:45:30 +00004721 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00004722
wdenk6c59edc2004-05-03 20:45:30 +00004723 ## Checking Image at 40100000 ...
4724 Image Name: 2.2.13 for initrd on TQM850L
4725 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4726 Data Size: 335725 Bytes = 327 kB = 0 MB
4727 Load Address: 00000000
4728 Entry Point: 0000000c
4729 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004730
wdenk6c59edc2004-05-03 20:45:30 +00004731 ## Checking Image at 40200000 ...
4732 Image Name: Simple Ramdisk Image
4733 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4734 Data Size: 566530 Bytes = 553 kB = 0 MB
4735 Load Address: 00000000
4736 Entry Point: 00000000
4737 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004738
wdenk6c59edc2004-05-03 20:45:30 +00004739 => bootm 40100000 40200000
4740 ## Booting Linux kernel at 40100000 ...
4741 Image Name: 2.2.13 for initrd on TQM850L
4742 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4743 Data Size: 335725 Bytes = 327 kB = 0 MB
4744 Load Address: 00000000
4745 Entry Point: 0000000c
4746 Verifying Checksum ... OK
4747 Uncompressing Kernel Image ... OK
4748 ## Loading RAMDisk Image at 40200000 ...
4749 Image Name: Simple Ramdisk Image
4750 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4751 Data Size: 566530 Bytes = 553 kB = 0 MB
4752 Load Address: 00000000
4753 Entry Point: 00000000
4754 Verifying Checksum ... OK
4755 Loading Ramdisk ... OK
4756 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
4757 Boot arguments: root=/dev/ram
4758 time_init: decrementer frequency = 187500000/60
4759 Calibrating delay loop... 49.77 BogoMIPS
4760 ...
4761 RAMDISK: Compressed image found at block 0
4762 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00004763
wdenk6c59edc2004-05-03 20:45:30 +00004764 bash#
wdenkc6097192002-11-03 00:24:07 +00004765
Matthew McClintockefae4ca2006-06-28 10:41:37 -05004766Boot Linux and pass a flat device tree:
4767-----------
4768
4769First, U-Boot must be compiled with the appropriate defines. See the section
4770titled "Linux Kernel Interface" above for a more in depth explanation. The
4771following is an example of how to start a kernel and pass an updated
4772flat device tree:
4773
4774=> print oftaddr
4775oftaddr=0x300000
4776=> print oft
4777oft=oftrees/mpc8540ads.dtb
4778=> tftp $oftaddr $oft
4779Speed: 1000, full duplex
4780Using TSEC0 device
4781TFTP from server 192.168.1.1; our IP address is 192.168.1.101
4782Filename 'oftrees/mpc8540ads.dtb'.
4783Load address: 0x300000
4784Loading: #
4785done
4786Bytes transferred = 4106 (100a hex)
4787=> tftp $loadaddr $bootfile
4788Speed: 1000, full duplex
4789Using TSEC0 device
4790TFTP from server 192.168.1.1; our IP address is 192.168.1.2
4791Filename 'uImage'.
4792Load address: 0x200000
4793Loading:############
4794done
4795Bytes transferred = 1029407 (fb51f hex)
4796=> print loadaddr
4797loadaddr=200000
4798=> print oftaddr
4799oftaddr=0x300000
4800=> bootm $loadaddr - $oftaddr
4801## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01004802 Image Name: Linux-2.6.17-dirty
4803 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4804 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05004805 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01004806 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05004807 Verifying Checksum ... OK
4808 Uncompressing Kernel Image ... OK
4809Booting using flat device tree at 0x300000
4810Using MPC85xx ADS machine description
4811Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
4812[snip]
4813
4814
wdenk6c59edc2004-05-03 20:45:30 +00004815More About U-Boot Image Types:
4816------------------------------
wdenkc6097192002-11-03 00:24:07 +00004817
wdenk6c59edc2004-05-03 20:45:30 +00004818U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00004819
wdenk6c59edc2004-05-03 20:45:30 +00004820 "Standalone Programs" are directly runnable in the environment
4821 provided by U-Boot; it is expected that (if they behave
4822 well) you can continue to work in U-Boot after return from
4823 the Standalone Program.
4824 "OS Kernel Images" are usually images of some Embedded OS which
4825 will take over control completely. Usually these programs
4826 will install their own set of exception handlers, device
4827 drivers, set up the MMU, etc. - this means, that you cannot
4828 expect to re-enter U-Boot except by resetting the CPU.
4829 "RAMDisk Images" are more or less just data blocks, and their
4830 parameters (address, size) are passed to an OS kernel that is
4831 being started.
4832 "Multi-File Images" contain several images, typically an OS
4833 (Linux) kernel image and one or more data images like
4834 RAMDisks. This construct is useful for instance when you want
4835 to boot over the network using BOOTP etc., where the boot
4836 server provides just a single image file, but you want to get
4837 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00004838
wdenk6c59edc2004-05-03 20:45:30 +00004839 "Multi-File Images" start with a list of image sizes, each
4840 image size (in bytes) specified by an "uint32_t" in network
4841 byte order. This list is terminated by an "(uint32_t)0".
4842 Immediately after the terminating 0 follow the images, one by
4843 one, all aligned on "uint32_t" boundaries (size rounded up to
4844 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00004845
wdenk6c59edc2004-05-03 20:45:30 +00004846 "Firmware Images" are binary images containing firmware (like
4847 U-Boot or FPGA images) which usually will be programmed to
4848 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00004849
wdenk6c59edc2004-05-03 20:45:30 +00004850 "Script files" are command sequences that will be executed by
4851 U-Boot's command interpreter; this feature is especially
4852 useful when you configure U-Boot to use a real shell (hush)
4853 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00004854
Marek Vasutcf41a9b2012-03-14 21:52:45 +00004855Booting the Linux zImage:
4856-------------------------
4857
4858On some platforms, it's possible to boot Linux zImage. This is done
4859using the "bootz" command. The syntax of "bootz" command is the same
4860as the syntax of "bootm" command.
4861
Tom Rini45f46d12013-05-16 11:40:11 -04004862Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut28850d02012-03-18 11:47:58 +00004863kernel with raw initrd images. The syntax is slightly different, the
4864address of the initrd must be augmented by it's size, in the following
4865format: "<initrd addres>:<initrd size>".
4866
stroeseb9c17c52003-04-04 15:53:41 +00004867
wdenk6c59edc2004-05-03 20:45:30 +00004868Standalone HOWTO:
4869=================
stroeseb9c17c52003-04-04 15:53:41 +00004870
wdenk6c59edc2004-05-03 20:45:30 +00004871One of the features of U-Boot is that you can dynamically load and
4872run "standalone" applications, which can use some resources of
4873U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00004874
wdenk6c59edc2004-05-03 20:45:30 +00004875Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00004876
wdenk6c59edc2004-05-03 20:45:30 +00004877"Hello World" Demo:
4878-------------------
wdenkc6097192002-11-03 00:24:07 +00004879
wdenk6c59edc2004-05-03 20:45:30 +00004880'examples/hello_world.c' contains a small "Hello World" Demo
4881application; it is automatically compiled when you build U-Boot.
4882It's configured to run at address 0x00040004, so you can play with it
4883like that:
wdenkc6097192002-11-03 00:24:07 +00004884
wdenk6c59edc2004-05-03 20:45:30 +00004885 => loads
4886 ## Ready for S-Record download ...
4887 ~>examples/hello_world.srec
4888 1 2 3 4 5 6 7 8 9 10 11 ...
4889 [file transfer complete]
4890 [connected]
4891 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004892
wdenk6c59edc2004-05-03 20:45:30 +00004893 => go 40004 Hello World! This is a test.
4894 ## Starting application at 0x00040004 ...
4895 Hello World
4896 argc = 7
4897 argv[0] = "40004"
4898 argv[1] = "Hello"
4899 argv[2] = "World!"
4900 argv[3] = "This"
4901 argv[4] = "is"
4902 argv[5] = "a"
4903 argv[6] = "test."
4904 argv[7] = "<NULL>"
4905 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00004906
wdenk6c59edc2004-05-03 20:45:30 +00004907 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004908
wdenk6c59edc2004-05-03 20:45:30 +00004909Another example, which demonstrates how to register a CPM interrupt
4910handler with the U-Boot code, can be found in 'examples/timer.c'.
4911Here, a CPM timer is set up to generate an interrupt every second.
4912The interrupt service routine is trivial, just printing a '.'
4913character, but this is just a demo program. The application can be
4914controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00004915
wdenk6c59edc2004-05-03 20:45:30 +00004916 ? - print current values og the CPM Timer registers
4917 b - enable interrupts and start timer
4918 e - stop timer and disable interrupts
4919 q - quit application
wdenkc6097192002-11-03 00:24:07 +00004920
wdenk6c59edc2004-05-03 20:45:30 +00004921 => loads
4922 ## Ready for S-Record download ...
4923 ~>examples/timer.srec
4924 1 2 3 4 5 6 7 8 9 10 11 ...
4925 [file transfer complete]
4926 [connected]
4927 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004928
wdenk6c59edc2004-05-03 20:45:30 +00004929 => go 40004
4930 ## Starting application at 0x00040004 ...
4931 TIMERS=0xfff00980
4932 Using timer 1
4933 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00004934
wdenk6c59edc2004-05-03 20:45:30 +00004935Hit 'b':
4936 [q, b, e, ?] Set interval 1000000 us
4937 Enabling timer
4938Hit '?':
4939 [q, b, e, ?] ........
4940 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4941Hit '?':
4942 [q, b, e, ?] .
4943 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4944Hit '?':
4945 [q, b, e, ?] .
4946 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4947Hit '?':
4948 [q, b, e, ?] .
4949 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4950Hit 'e':
4951 [q, b, e, ?] ...Stopping timer
4952Hit 'q':
4953 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004954
wdenkc6097192002-11-03 00:24:07 +00004955
wdenk6c59edc2004-05-03 20:45:30 +00004956Minicom warning:
4957================
wdenkc6097192002-11-03 00:24:07 +00004958
wdenk6c59edc2004-05-03 20:45:30 +00004959Over time, many people have reported problems when trying to use the
4960"minicom" terminal emulation program for serial download. I (wd)
4961consider minicom to be broken, and recommend not to use it. Under
4962Unix, I recommend to use C-Kermit for general purpose use (and
4963especially for kermit binary protocol download ("loadb" command), and
Karl O. Pinca0189bb2012-10-01 05:11:56 +00004964use "cu" for S-Record download ("loads" command). See
4965http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
4966for help with kermit.
4967
wdenkc6097192002-11-03 00:24:07 +00004968
wdenk6c59edc2004-05-03 20:45:30 +00004969Nevertheless, if you absolutely want to use it try adding this
4970configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00004971
wdenk6c59edc2004-05-03 20:45:30 +00004972 Name Program Name U/D FullScr IO-Red. Multi
4973 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
4974 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00004975
wdenk8dba0502003-03-31 16:34:49 +00004976
wdenk6c59edc2004-05-03 20:45:30 +00004977NetBSD Notes:
4978=============
wdenkc6097192002-11-03 00:24:07 +00004979
wdenk6c59edc2004-05-03 20:45:30 +00004980Starting at version 0.9.2, U-Boot supports NetBSD both as host
4981(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00004982
wdenk6c59edc2004-05-03 20:45:30 +00004983Building requires a cross environment; it is known to work on
4984NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4985need gmake since the Makefiles are not compatible with BSD make).
4986Note that the cross-powerpc package does not install include files;
4987attempting to build U-Boot will fail because <machine/ansi.h> is
4988missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00004989
wdenk6c59edc2004-05-03 20:45:30 +00004990 # cd /usr/pkg/cross/powerpc-netbsd/include
4991 # mkdir powerpc
4992 # ln -s powerpc machine
4993 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4994 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00004995
wdenk6c59edc2004-05-03 20:45:30 +00004996Native builds *don't* work due to incompatibilities between native
4997and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00004998
wdenk6c59edc2004-05-03 20:45:30 +00004999Booting assumes that (the first part of) the image booted is a
5000stage-2 loader which in turn loads and then invokes the kernel
5001proper. Loader sources will eventually appear in the NetBSD source
5002tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00005003meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00005004
wdenkc6097192002-11-03 00:24:07 +00005005
wdenk6c59edc2004-05-03 20:45:30 +00005006Implementation Internals:
5007=========================
wdenkc6097192002-11-03 00:24:07 +00005008
wdenk6c59edc2004-05-03 20:45:30 +00005009The following is not intended to be a complete description of every
5010implementation detail. However, it should help to understand the
5011inner workings of U-Boot and make it easier to port it to custom
5012hardware.
wdenkc6097192002-11-03 00:24:07 +00005013
wdenkc6097192002-11-03 00:24:07 +00005014
wdenk6c59edc2004-05-03 20:45:30 +00005015Initial Stack, Global Data:
5016---------------------------
wdenkc6097192002-11-03 00:24:07 +00005017
wdenk6c59edc2004-05-03 20:45:30 +00005018The implementation of U-Boot is complicated by the fact that U-Boot
5019starts running out of ROM (flash memory), usually without access to
5020system RAM (because the memory controller is not initialized yet).
5021This means that we don't have writable Data or BSS segments, and BSS
5022is not initialized as zero. To be able to get a C environment working
5023at all, we have to allocate at least a minimal stack. Implementation
5024options for this are defined and restricted by the CPU used: Some CPU
5025models provide on-chip memory (like the IMMR area on MPC8xx and
5026MPC826x processors), on others (parts of) the data cache can be
5027locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00005028
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005029 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005030 U-Boot mailing list:
wdenkc6097192002-11-03 00:24:07 +00005031
wdenk6c59edc2004-05-03 20:45:30 +00005032 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
5033 From: "Chris Hallinan" <clh@net1plus.com>
5034 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
5035 ...
wdenkc6097192002-11-03 00:24:07 +00005036
wdenk6c59edc2004-05-03 20:45:30 +00005037 Correct me if I'm wrong, folks, but the way I understand it
5038 is this: Using DCACHE as initial RAM for Stack, etc, does not
5039 require any physical RAM backing up the cache. The cleverness
5040 is that the cache is being used as a temporary supply of
5041 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005042 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00005043 can see how this works by studying the cache architecture and
5044 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00005045
wdenk6c59edc2004-05-03 20:45:30 +00005046 OCM is On Chip Memory, which I believe the 405GP has 4K. It
5047 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005048 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00005049 option should work for you. Using CS 4 should be fine if your
5050 board designers haven't used it for something that would
5051 cause you grief during the initial boot! It is frequently not
5052 used.
wdenkc6097192002-11-03 00:24:07 +00005053
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005054 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00005055 with your processor/board/system design. The default value
5056 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02005057 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00005058 than your SDRAM module. If you have a 64MB SDRAM module, set
5059 it above 400_0000. Just make sure your board has no resources
5060 that are supposed to respond to that address! That code in
5061 start.S has been around a while and should work as is when
5062 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00005063
wdenk6c59edc2004-05-03 20:45:30 +00005064 -Chris Hallinan
5065 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00005066
wdenk6c59edc2004-05-03 20:45:30 +00005067It is essential to remember this, since it has some impact on the C
5068code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00005069
wdenk6c59edc2004-05-03 20:45:30 +00005070* Initialized global data (data segment) is read-only. Do not attempt
5071 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00005072
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005073* Do not use any uninitialized global data (or implicitly initialized
wdenk6c59edc2004-05-03 20:45:30 +00005074 as zero data - BSS segment) at all - this is undefined, initiali-
5075 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00005076
wdenk6c59edc2004-05-03 20:45:30 +00005077* Stack space is very limited. Avoid big data buffers or things like
5078 that.
wdenk4a5c8a72003-03-06 00:02:04 +00005079
wdenk6c59edc2004-05-03 20:45:30 +00005080Having only the stack as writable memory limits means we cannot use
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005081normal global data to share information between the code. But it
wdenk6c59edc2004-05-03 20:45:30 +00005082turned out that the implementation of U-Boot can be greatly
5083simplified by making a global data structure (gd_t) available to all
5084functions. We could pass a pointer to this data as argument to _all_
5085functions, but this would bloat the code. Instead we use a feature of
5086the GCC compiler (Global Register Variables) to share the data: we
5087place a pointer (gd) to the global data into a register which we
5088reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00005089
wdenk6c59edc2004-05-03 20:45:30 +00005090When choosing a register for such a purpose we are restricted by the
5091relevant (E)ABI specifications for the current architecture, and by
5092GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00005093
wdenk6c59edc2004-05-03 20:45:30 +00005094For PowerPC, the following registers have specific use:
5095 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01005096 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00005097 R3-R4: parameter passing and return values
5098 R5-R10: parameter passing
5099 R13: small data area pointer
5100 R30: GOT pointer
5101 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00005102
Joakim Tjernlund693c0c12010-01-19 14:41:58 +01005103 (U-Boot also uses R12 as internal GOT pointer. r12
5104 is a volatile register so r12 needs to be reset when
5105 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00005106
Wolfgang Denk69c09642008-02-14 22:43:22 +01005107 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005108
wdenk6c59edc2004-05-03 20:45:30 +00005109 Note: on PPC, we could use a static initializer (since the
5110 address of the global data structure is known at compile time),
5111 but it turned out that reserving a register results in somewhat
5112 smaller code - although the code savings are not that big (on
5113 average for all boards 752 bytes for the whole U-Boot image,
5114 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00005115
wdenk6c59edc2004-05-03 20:45:30 +00005116On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00005117
wdenk6c59edc2004-05-03 20:45:30 +00005118 R0: function argument word/integer result
5119 R1-R3: function argument word
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02005120 R9: platform specific
5121 R10: stack limit (used only if stack checking is enabled)
wdenk6c59edc2004-05-03 20:45:30 +00005122 R11: argument (frame) pointer
5123 R12: temporary workspace
5124 R13: stack pointer
5125 R14: link register
5126 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00005127
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02005128 ==> U-Boot will use R9 to hold a pointer to the global data
5129
5130 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00005131
Thomas Chou8fa38582010-05-21 11:08:03 +08005132On Nios II, the ABI is documented here:
5133 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
5134
5135 ==> U-Boot will use gp to hold a pointer to the global data
5136
5137 Note: on Nios II, we give "-G0" option to gcc and don't use gp
5138 to access small data sections, so gp is free.
5139
Macpaul Lin1cac36e2011-10-19 20:41:11 +00005140On NDS32, the following registers are used:
5141
5142 R0-R1: argument/return
5143 R2-R5: argument
5144 R15: temporary register for assembler
5145 R16: trampoline register
5146 R28: frame pointer (FP)
5147 R29: global pointer (GP)
5148 R30: link register (LP)
5149 R31: stack pointer (SP)
5150 PC: program counter (PC)
5151
5152 ==> U-Boot will use R10 to hold a pointer to the global data
5153
Wolfgang Denk6405a152006-03-31 18:32:53 +02005154NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5155or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00005156
wdenk6c59edc2004-05-03 20:45:30 +00005157Memory Management:
5158------------------
wdenkc6097192002-11-03 00:24:07 +00005159
wdenk6c59edc2004-05-03 20:45:30 +00005160U-Boot runs in system state and uses physical addresses, i.e. the
5161MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00005162
wdenk6c59edc2004-05-03 20:45:30 +00005163The available memory is mapped to fixed addresses using the memory
5164controller. In this process, a contiguous block is formed for each
5165memory type (Flash, SDRAM, SRAM), even when it consists of several
5166physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00005167
wdenk6c59edc2004-05-03 20:45:30 +00005168U-Boot is installed in the first 128 kB of the first Flash bank (on
5169TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5170booting and sizing and initializing DRAM, the code relocates itself
5171to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005172memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00005173configuration setting]. Below that, a structure with global Board
5174Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00005175
wdenk6c59edc2004-05-03 20:45:30 +00005176Additionally, some exception handler code is copied to the low 8 kB
5177of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00005178
wdenk6c59edc2004-05-03 20:45:30 +00005179So a typical memory configuration with 16 MB of DRAM could look like
5180this:
wdenkc6097192002-11-03 00:24:07 +00005181
wdenk6c59edc2004-05-03 20:45:30 +00005182 0x0000 0000 Exception Vector code
5183 :
5184 0x0000 1FFF
5185 0x0000 2000 Free for Application Use
5186 :
5187 :
wdenkc6097192002-11-03 00:24:07 +00005188
wdenk6c59edc2004-05-03 20:45:30 +00005189 :
5190 :
5191 0x00FB FF20 Monitor Stack (Growing downward)
5192 0x00FB FFAC Board Info Data and permanent copy of global data
5193 0x00FC 0000 Malloc Arena
5194 :
5195 0x00FD FFFF
5196 0x00FE 0000 RAM Copy of Monitor Code
5197 ... eventually: LCD or video framebuffer
5198 ... eventually: pRAM (Protected RAM - unchanged by reset)
5199 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00005200
wdenkc6097192002-11-03 00:24:07 +00005201
wdenk6c59edc2004-05-03 20:45:30 +00005202System Initialization:
5203----------------------
wdenkc6097192002-11-03 00:24:07 +00005204
wdenk6c59edc2004-05-03 20:45:30 +00005205In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005206(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005207configuration for CS0# this is a mirror of the on board Flash memory.
wdenk6c59edc2004-05-03 20:45:30 +00005208To be able to re-map memory U-Boot then jumps to its link address.
5209To be able to implement the initialization code in C, a (small!)
5210initial stack is set up in the internal Dual Ported RAM (in case CPUs
Heiko Schocher71cb3e92017-06-07 17:33:10 +02005211which provide such a feature like), or in a locked part of the data
5212cache. After that, U-Boot initializes the CPU core, the caches and
5213the SIU.
wdenkc6097192002-11-03 00:24:07 +00005214
wdenk6c59edc2004-05-03 20:45:30 +00005215Next, all (potentially) available memory banks are mapped using a
5216preliminary mapping. For example, we put them on 512 MB boundaries
5217(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5218on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5219programmed for SDRAM access. Using the temporary configuration, a
5220simple memory test is run that determines the size of the SDRAM
5221banks.
wdenkc6097192002-11-03 00:24:07 +00005222
wdenk6c59edc2004-05-03 20:45:30 +00005223When there is more than one SDRAM bank, and the banks are of
5224different size, the largest is mapped first. For equal size, the first
5225bank (CS2#) is mapped first. The first mapping is always for address
52260x00000000, with any additional banks following immediately to create
5227contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00005228
wdenk6c59edc2004-05-03 20:45:30 +00005229Then, the monitor installs itself at the upper end of the SDRAM area
5230and allocates memory for use by malloc() and for the global Board
5231Info data; also, the exception vector code is copied to the low RAM
5232pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00005233
wdenk6c59edc2004-05-03 20:45:30 +00005234Only after this relocation will you have a "normal" C environment;
5235until that you are restricted in several ways, mostly because you are
5236running from ROM, and because the code will have to be relocated to a
5237new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00005238
wdenkc6097192002-11-03 00:24:07 +00005239
wdenk6c59edc2004-05-03 20:45:30 +00005240U-Boot Porting Guide:
5241----------------------
wdenkc6097192002-11-03 00:24:07 +00005242
wdenk6c59edc2004-05-03 20:45:30 +00005243[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
5244list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00005245
wdenkc6097192002-11-03 00:24:07 +00005246
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005247int main(int argc, char *argv[])
wdenk6c59edc2004-05-03 20:45:30 +00005248{
5249 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00005250
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005251 signal(SIGALRM, no_more_time);
5252 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00005253
wdenk6c59edc2004-05-03 20:45:30 +00005254 if (available_money > available_manpower) {
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005255 Pay consultant to port U-Boot;
wdenk6c59edc2004-05-03 20:45:30 +00005256 return 0;
5257 }
wdenkc6097192002-11-03 00:24:07 +00005258
wdenk6c59edc2004-05-03 20:45:30 +00005259 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00005260
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005261 Subscribe to u-boot mailing list;
wdenkc6097192002-11-03 00:24:07 +00005262
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005263 if (clueless)
5264 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00005265
wdenk6c59edc2004-05-03 20:45:30 +00005266 while (learning) {
5267 Read the README file in the top level directory;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005268 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
5269 Read applicable doc/*.README;
wdenk6c59edc2004-05-03 20:45:30 +00005270 Read the source, Luke;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005271 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk6c59edc2004-05-03 20:45:30 +00005272 }
wdenkc6097192002-11-03 00:24:07 +00005273
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005274 if (available_money > toLocalCurrency ($2500))
5275 Buy a BDI3000;
5276 else
wdenk6c59edc2004-05-03 20:45:30 +00005277 Add a lot of aggravation and time;
wdenkc6097192002-11-03 00:24:07 +00005278
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005279 if (a similar board exists) { /* hopefully... */
5280 cp -a board/<similar> board/<myboard>
5281 cp include/configs/<similar>.h include/configs/<myboard>.h
5282 } else {
5283 Create your own board support subdirectory;
5284 Create your own board include/configs/<myboard>.h file;
5285 }
5286 Edit new board/<myboard> files
5287 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00005288
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005289 while (!accepted) {
5290 while (!running) {
5291 do {
5292 Add / modify source code;
5293 } until (compiles);
5294 Debug;
5295 if (clueless)
5296 email("Hi, I am having problems...");
5297 }
5298 Send patch file to the U-Boot email list;
5299 if (reasonable critiques)
5300 Incorporate improvements from email list code review;
5301 else
5302 Defend code as written;
wdenk634d2f72004-04-15 23:14:49 +00005303 }
wdenkc6097192002-11-03 00:24:07 +00005304
wdenk6c59edc2004-05-03 20:45:30 +00005305 return 0;
5306}
wdenkc6097192002-11-03 00:24:07 +00005307
wdenk6c59edc2004-05-03 20:45:30 +00005308void no_more_time (int sig)
5309{
5310 hire_a_guru();
5311}
wdenkc6097192002-11-03 00:24:07 +00005312
wdenkc6097192002-11-03 00:24:07 +00005313
wdenk6c59edc2004-05-03 20:45:30 +00005314Coding Standards:
5315-----------------
wdenkc6097192002-11-03 00:24:07 +00005316
wdenk6c59edc2004-05-03 20:45:30 +00005317All contributions to U-Boot should conform to the Linux kernel
Detlev Zundelaa63d482006-09-01 15:39:02 +02005318coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005319"scripts/Lindent" in your Linux kernel source directory.
Detlev Zundelaa63d482006-09-01 15:39:02 +02005320
5321Source files originating from a different project (for example the
5322MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005323reformatted to ease subsequent migration to newer versions of those
Detlev Zundelaa63d482006-09-01 15:39:02 +02005324sources.
wdenkc6097192002-11-03 00:24:07 +00005325
Detlev Zundelaa63d482006-09-01 15:39:02 +02005326Please note that U-Boot is implemented in C (and to some small parts in
5327Assembler); no C++ is used, so please do not use C++ style comments (//)
5328in your code.
wdenkad276f22004-01-04 16:28:35 +00005329
wdenk6c59edc2004-05-03 20:45:30 +00005330Please also stick to the following formatting rules:
5331- remove any trailing white space
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005332- use TAB characters for indentation and vertical alignment, not spaces
wdenk6c59edc2004-05-03 20:45:30 +00005333- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005334- do not add more than 2 consecutive empty lines to source files
wdenk6c59edc2004-05-03 20:45:30 +00005335- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00005336
wdenk6c59edc2004-05-03 20:45:30 +00005337Submissions which do not conform to the standards may be returned
5338with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00005339
wdenkc6097192002-11-03 00:24:07 +00005340
wdenk6c59edc2004-05-03 20:45:30 +00005341Submitting Patches:
5342-------------------
wdenkc6097192002-11-03 00:24:07 +00005343
wdenk6c59edc2004-05-03 20:45:30 +00005344Since the number of patches for U-Boot is growing, we need to
5345establish some rules. Submissions which do not conform to these rules
5346may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00005347
Magnus Liljaf3b287b2008-08-06 19:32:33 +02005348Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005349
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005350Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
5351see http://lists.denx.de/mailman/listinfo/u-boot
5352
wdenk6c59edc2004-05-03 20:45:30 +00005353When you send a patch, please include the following information with
5354it:
wdenkc6097192002-11-03 00:24:07 +00005355
wdenk6c59edc2004-05-03 20:45:30 +00005356* For bug fixes: a description of the bug and how your patch fixes
5357 this bug. Please try to include a way of demonstrating that the
5358 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00005359
wdenk6c59edc2004-05-03 20:45:30 +00005360* For new features: a description of the feature and your
5361 implementation.
wdenkc6097192002-11-03 00:24:07 +00005362
wdenk6c59edc2004-05-03 20:45:30 +00005363* A CHANGELOG entry as plaintext (separate from the patch)
wdenkc6097192002-11-03 00:24:07 +00005364
Robert P. J. Day076ed9b2015-12-19 07:16:10 -05005365* For major contributions, add a MAINTAINERS file with your
5366 information and associated file and directory references.
wdenkc6097192002-11-03 00:24:07 +00005367
Albert ARIBAUD48e910f2013-09-11 15:52:51 +02005368* When you add support for a new board, don't forget to add a
5369 maintainer e-mail address to the boards.cfg file, too.
wdenkc6097192002-11-03 00:24:07 +00005370
wdenk6c59edc2004-05-03 20:45:30 +00005371* If your patch adds new configuration options, don't forget to
5372 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00005373
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005374* The patch itself. If you are using git (which is *strongly*
5375 recommended) you can easily generate the patch using the
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005376 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005377 the U-Boot mailing list, you will avoid most of the common problems
5378 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00005379
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005380 If you cannot use git, use "diff -purN OLD NEW". If your version of
5381 diff does not support these options, then get the latest version of
5382 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00005383
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005384 The current directory when running this command shall be the parent
5385 directory of the U-Boot source tree (i. e. please make sure that
5386 your patch includes sufficient directory information for the
5387 affected files).
5388
5389 We prefer patches as plain text. MIME attachments are discouraged,
5390 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00005391
wdenk6c59edc2004-05-03 20:45:30 +00005392* If one logical set of modifications affects or creates several
5393 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00005394
wdenk6c59edc2004-05-03 20:45:30 +00005395* Changesets that contain different, unrelated modifications shall be
5396 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00005397
wdenkc6097192002-11-03 00:24:07 +00005398
wdenk6c59edc2004-05-03 20:45:30 +00005399Notes:
wdenkc6097192002-11-03 00:24:07 +00005400
Simon Glassdc27def2016-07-27 20:33:08 -06005401* Before sending the patch, run the buildman script on your patched
wdenk6c59edc2004-05-03 20:45:30 +00005402 source tree and make sure that no errors or warnings are reported
5403 for any of the boards.
5404
5405* Keep your modifications to the necessary minimum: A patch
5406 containing several unrelated changes or arbitrary reformats will be
5407 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00005408
wdenk6c59edc2004-05-03 20:45:30 +00005409* If you modify existing code, make sure that your new code does not
5410 add to the memory footprint of the code ;-) Small is beautiful!
5411 When adding new features, these should compile conditionally only
5412 (using #ifdef), and the resulting code with the new feature
5413 disabled must not need more memory than the old code without your
5414 modification.
wdenkcbc49a52005-05-03 14:12:25 +00005415
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005416* Remember that there is a size limit of 100 kB per message on the
5417 u-boot mailing list. Bigger patches will be moderated. If they are
5418 reasonable and not too big, they will be acknowledged. But patches
5419 bigger than the size limit should be avoided.