blob: 0b5dafc1f23fd661e193f7f8edc2af550b6911b7 [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
Simon Glassbf6ce792012-12-26 09:53:36 +0000818 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500819 CONFIG_CMD_SAVES * save S record dump
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500820 CONFIG_CMD_SDRAM * print SDRAM configuration information
821 (requires CONFIG_CMD_I2C)
Eric Nelson97f5f8f2012-01-31 10:52:08 -0700822 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Bob Liua671b702013-02-05 19:05:41 +0800823 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk85c25df2009-04-01 23:34:12 +0200824 CONFIG_CMD_SOURCE "source" command Support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500825 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7aa81a42011-05-17 00:03:40 +0000826 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass6a398d22011-10-24 18:00:07 +0000827 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershberger59f3f522012-10-03 12:14:57 +0000828 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
829 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500830 CONFIG_CMD_USB * USB support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500831 CONFIG_CMD_CDP * Cisco Discover Protocol support
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200832 CONFIG_CMD_XIMG Load part of Multi Image
Przemyslaw Marczak2eb40ee2014-04-02 10:20:05 +0200833 CONFIG_CMD_UUID * Generate random UUID or GUID string
wdenkc6097192002-11-03 00:24:07 +0000834
835 EXAMPLE: If you want all functions except of network
836 support you can write:
837
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500838 #include "config_cmd_all.h"
839 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000840
Gerald Van Barend6abef42007-03-31 12:23:51 -0400841 Other Commands:
842 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000843
844 Note: Don't enable the "icache" and "dcache" commands
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500845 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk4a5c8a72003-03-06 00:02:04 +0000846 what you (and your U-Boot users) are doing. Data
Heiko Schocher65d94db2017-06-07 17:33:09 +0200847 cache cannot be enabled on systems like the
Christophe Leroy069fa832017-07-06 10:23:22 +0200848 8xx (where accesses to the IMMR region must be
wdenk4a5c8a72003-03-06 00:02:04 +0000849 uncached), and it cannot be disabled on all other
850 systems where we (mis-) use the data cache to hold an
851 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000852
853
854 XXX - this list needs to get updated!
855
Simon Glassaa34ef22016-03-13 19:07:28 -0600856- Removal of commands
857 If no commands are needed to boot, you can disable
858 CONFIG_CMDLINE to remove them. In this case, the command line
859 will not be available, and when U-Boot wants to execute the
860 boot command (on start-up) it will call board_run_command()
861 instead. This can reduce image size significantly for very
862 simple boot procedures.
863
Wolfgang Denk2aceea12013-03-23 23:50:31 +0000864- Regular expression support:
865 CONFIG_REGEX
Wolfgang Denkec7fbf52013-10-04 17:43:24 +0200866 If this variable is defined, U-Boot is linked against
867 the SLRE (Super Light Regular Expression) library,
868 which adds regex support to some commands, as for
869 example "env grep" and "setexpr".
Wolfgang Denk2aceea12013-03-23 23:50:31 +0000870
Simon Glass3d686442011-10-15 05:48:20 +0000871- Device tree:
872 CONFIG_OF_CONTROL
873 If this variable is defined, U-Boot will use a device tree
874 to configure its devices, instead of relying on statically
875 compiled #defines in the board file. This option is
876 experimental and only available on a few boards. The device
877 tree is available in the global data as gd->fdt_blob.
878
Simon Glass5cb34db2011-10-24 19:15:31 +0000879 U-Boot needs to get its device tree from somewhere. This can
Alex Deymo5b661ec2017-04-02 01:25:20 -0700880 be done using one of the three options below:
Simon Glass38d6b8d2011-10-15 05:48:21 +0000881
882 CONFIG_OF_EMBED
883 If this variable is defined, U-Boot will embed a device tree
884 binary in its image. This device tree file should be in the
885 board directory and called <soc>-<board>.dts. The binary file
886 is then picked up in board_init_f() and made available through
887 the global data structure as gd->blob.
Simon Glass3d686442011-10-15 05:48:20 +0000888
Simon Glass5cb34db2011-10-24 19:15:31 +0000889 CONFIG_OF_SEPARATE
890 If this variable is defined, U-Boot will build a device tree
891 binary. It will be called u-boot.dtb. Architecture-specific
892 code will locate it at run-time. Generally this works by:
893
894 cat u-boot.bin u-boot.dtb >image.bin
895
896 and in fact, U-Boot does this for you, creating a file called
897 u-boot-dtb.bin which is useful in the common case. You can
898 still use the individual files if you need something more
899 exotic.
900
Alex Deymo5b661ec2017-04-02 01:25:20 -0700901 CONFIG_OF_BOARD
902 If this variable is defined, U-Boot will use the device tree
903 provided by the board at runtime instead of embedding one with
904 the image. Only boards defining board_fdt_blob_setup() support
905 this option (see include/fdtdec.h file).
906
wdenkc6097192002-11-03 00:24:07 +0000907- Watchdog:
908 CONFIG_WATCHDOG
909 If this variable is defined, it enables watchdog
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +0000910 support for the SoC. There must be support in the SoC
Christophe Leroy069fa832017-07-06 10:23:22 +0200911 specific code for a watchdog. For the 8xx
912 CPUs, the SIU Watchdog feature is enabled in the SYPCR
913 register. When supported for a specific SoC is
914 available, then no further board specific code should
915 be needed to use it.
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +0000916
917 CONFIG_HW_WATCHDOG
918 When using a watchdog circuitry external to the used
919 SoC, then define this variable and provide board
920 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000921
Heiko Schocher735326c2015-01-21 08:38:22 +0100922 CONFIG_AT91_HW_WDT_TIMEOUT
923 specify the timeout in seconds. default 2 seconds.
924
stroeseb9c17c52003-04-04 15:53:41 +0000925- U-Boot Version:
926 CONFIG_VERSION_VARIABLE
927 If this variable is defined, an environment variable
928 named "ver" is created by U-Boot showing the U-Boot
929 version as printed by the "version" command.
Benoît Thébaudeauce9a1552012-08-13 15:01:14 +0200930 Any change to this variable will be reverted at the
931 next reset.
stroeseb9c17c52003-04-04 15:53:41 +0000932
wdenkc6097192002-11-03 00:24:07 +0000933- Real-Time Clock:
934
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500935 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000936 has to be selected, too. Define exactly one of the
937 following options:
938
wdenkc6097192002-11-03 00:24:07 +0000939 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam3f8d1782011-10-24 06:44:15 +0000940 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +0000941 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1fe2c702003-03-06 21:55:29 +0000942 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000943 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk0893c472003-05-20 14:25:27 +0000944 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel90491f22014-07-21 11:06:16 +0200945 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenkef5fe752003-03-12 10:41:04 +0000946 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krillb27939b2008-03-15 15:40:26 +0100947 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenkaeba06f2004-06-09 17:34:58 +0000948 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Chris Packham2d3ac512017-05-30 12:03:33 +1200949 CONFIG_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher1f1b7012011-03-28 09:24:22 +0200950 CONFIG_SYS_RV3029_TCR - enable trickle charger on
951 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +0000952
wdenkb9bbd242003-06-30 16:24:52 +0000953 Note that if the RTC uses I2C, then the I2C interface
954 must also be configured. See I2C Support, below.
955
Peter Tyser9902e422008-12-17 16:36:21 -0600956- GPIO Support:
957 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tyser9902e422008-12-17 16:36:21 -0600958
Chris Packham9b383202010-12-19 10:12:13 +0000959 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
960 chip-ngpio pairs that tell the PCA953X driver the number of
961 pins supported by a particular chip.
962
Peter Tyser9902e422008-12-17 16:36:21 -0600963 Note that if the GPIO device uses I2C, then the I2C interface
964 must also be configured. See I2C Support, below.
965
Simon Glass4dc47ca2014-06-11 23:29:41 -0600966- I/O tracing:
967 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
968 accesses and can checksum them or write a list of them out
969 to memory. See the 'iotrace' command for details. This is
970 useful for testing device drivers since it can confirm that
971 the driver behaves the same way before and after a code
972 change. Currently this is supported on sandbox and arm. To
973 add support for your architecture, add '#include <iotrace.h>'
974 to the bottom of arch/<arch>/include/asm/io.h and test.
975
976 Example output from the 'iotrace stats' command is below.
977 Note that if the trace buffer is exhausted, the checksum will
978 still continue to operate.
979
980 iotrace is enabled
981 Start: 10000000 (buffer start address)
982 Size: 00010000 (buffer size)
983 Offset: 00000120 (current buffer offset)
984 Output: 10000120 (start + offset)
985 Count: 00000018 (number of trace records)
986 CRC32: 9526fb66 (CRC32 of all trace records)
987
wdenkc6097192002-11-03 00:24:07 +0000988- Timestamp Support:
989
wdenk4a5c8a72003-03-06 00:02:04 +0000990 When CONFIG_TIMESTAMP is selected, the timestamp
991 (date and time) of an image is printed by image
992 commands like bootm or iminfo. This option is
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500993 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000994
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +0000995- Partition Labels (disklabels) Supported:
996 Zero or more of the following:
997 CONFIG_MAC_PARTITION Apple's MacOS partition table.
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +0000998 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
999 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1000 bootloader. Note 2TB partition limit; see
1001 disk/part_efi.c
1002 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001003
Simon Glassb569a012017-05-17 03:25:30 -06001004 If IDE or SCSI support is enabled (CONFIG_IDE or
Simon Glass8706b812016-05-01 11:36:02 -06001005 CONFIG_SCSI) you must configure support for at
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001006 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001007
1008- IDE Reset method:
wdenk369d43d2004-03-14 14:09:05 +00001009 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1010 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001011
wdenk369d43d2004-03-14 14:09:05 +00001012 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1013 be performed by calling the function
1014 ide_set_reset(int reset)
1015 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001016
1017- ATAPI Support:
1018 CONFIG_ATAPI
1019
1020 Set this to enable ATAPI support.
1021
wdenkf602aa02004-03-13 23:29:43 +00001022- LBA48 Support
1023 CONFIG_LBA48
1024
1025 Set this to enable support for disks larger than 137GB
Heiko Schocher0f602e12009-12-03 11:21:21 +01001026 Also look at CONFIG_SYS_64BIT_LBA.
wdenkf602aa02004-03-13 23:29:43 +00001027 Whithout these , LBA48 support uses 32bit variables and will 'only'
1028 support disks up to 2.1TB.
1029
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001030 CONFIG_SYS_64BIT_LBA:
wdenkf602aa02004-03-13 23:29:43 +00001031 When enabled, makes the IDE subsystem use 64bit sector addresses.
1032 Default is 32bit.
1033
wdenkc6097192002-11-03 00:24:07 +00001034- SCSI Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001035 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1036 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1037 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001038 maximum numbers of LUNs, SCSI ID's and target
1039 devices.
wdenkc6097192002-11-03 00:24:07 +00001040
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001041 The environment variable 'scsidevs' is set to the number of
1042 SCSI devices found during the last scan.
Stefan Reinauere50a10e2012-10-29 05:23:48 +00001043
wdenkc6097192002-11-03 00:24:07 +00001044- NETWORK Support (PCI):
wdenk4e112c12003-06-03 23:54:09 +00001045 CONFIG_E1000
Kyle Moffett64b94dd2011-10-18 11:05:29 +00001046 Support for Intel 8254x/8257x gigabit chips.
1047
1048 CONFIG_E1000_SPI
1049 Utility code for direct access to the SPI bus on Intel 8257x.
1050 This does not do anything useful unless you set at least one
1051 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1052
1053 CONFIG_E1000_SPI_GENERIC
1054 Allow generic access to the SPI bus on the Intel 8257x, for
1055 example with the "sspi" command.
1056
1057 CONFIG_CMD_E1000
1058 Management command for E1000 devices. When used on devices
1059 with SPI support you can reprogram the EEPROM from U-Boot.
stroese94ef1cf2003-06-05 15:39:44 +00001060
wdenkc6097192002-11-03 00:24:07 +00001061 CONFIG_EEPRO100
1062 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001063 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001064 write routine for first time initialisation.
1065
1066 CONFIG_TULIP
1067 Support for Digital 2114x chips.
1068 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1069 modem chip initialisation (KS8761/QS6611).
1070
1071 CONFIG_NATSEMI
1072 Support for National dp83815 chips.
1073
1074 CONFIG_NS8382X
1075 Support for National dp8382[01] gigabit chips.
1076
wdenkaa603362003-05-12 21:50:16 +00001077- NETWORK Support (other):
1078
Jens Scharsigdab7cb82010-01-23 12:03:45 +01001079 CONFIG_DRIVER_AT91EMAC
1080 Support for AT91RM9200 EMAC.
1081
1082 CONFIG_RMII
1083 Define this to use reduced MII inteface
1084
1085 CONFIG_DRIVER_AT91EMAC_QUIET
1086 If this defined, the driver is quiet.
1087 The driver doen't show link status messages.
1088
Rob Herringc9830dc2011-12-15 11:15:49 +00001089 CONFIG_CALXEDA_XGMAC
1090 Support for the Calxeda XGMAC device
1091
Ashok93fb8722012-10-15 06:20:47 +00001092 CONFIG_LAN91C96
wdenkaa603362003-05-12 21:50:16 +00001093 Support for SMSC's LAN91C96 chips.
1094
wdenkaa603362003-05-12 21:50:16 +00001095 CONFIG_LAN91C96_USE_32_BIT
1096 Define this to enable 32 bit addressing
1097
Ashok93fb8722012-10-15 06:20:47 +00001098 CONFIG_SMC91111
wdenk3c711762004-06-09 13:37:52 +00001099 Support for SMSC's LAN91C111 chip
1100
1101 CONFIG_SMC91111_BASE
1102 Define this to hold the physical address
1103 of the device (I/O space)
1104
1105 CONFIG_SMC_USE_32_BIT
1106 Define this if data bus is 32 bits
1107
1108 CONFIG_SMC_USE_IOFUNCS
1109 Define this to use i/o functions instead of macros
1110 (some hardware wont work with macros)
1111
Heiko Schocher7d037f72011-11-15 10:00:04 -05001112 CONFIG_DRIVER_TI_EMAC
1113 Support for davinci emac
1114
1115 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1116 Define this if you have more then 3 PHYs.
1117
Macpaul Lin199c6252010-12-21 16:59:46 +08001118 CONFIG_FTGMAC100
1119 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1120
1121 CONFIG_FTGMAC100_EGIGA
1122 Define this to use GE link update with gigabit PHY.
1123 Define this if FTGMAC100 is connected to gigabit PHY.
1124 If your system has 10/100 PHY only, it might not occur
1125 wrong behavior. Because PHY usually return timeout or
1126 useless data when polling gigabit status and gigabit
1127 control registers. This behavior won't affect the
1128 correctnessof 10/100 link speed update.
1129
Mike Rapoportf4761af2009-11-11 10:03:03 +02001130 CONFIG_SMC911X
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001131 Support for SMSC's LAN911x and LAN921x chips
1132
Mike Rapoportf4761af2009-11-11 10:03:03 +02001133 CONFIG_SMC911X_BASE
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001134 Define this to hold the physical address
1135 of the device (I/O space)
1136
Mike Rapoportf4761af2009-11-11 10:03:03 +02001137 CONFIG_SMC911X_32_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001138 Define this if data bus is 32 bits
1139
Mike Rapoportf4761af2009-11-11 10:03:03 +02001140 CONFIG_SMC911X_16_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001141 Define this if data bus is 16 bits. If your processor
1142 automatically converts one 32 bit word to two 16 bit
Mike Rapoportf4761af2009-11-11 10:03:03 +02001143 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001144
Yoshihiro Shimodaed4cea02011-01-27 10:06:03 +09001145 CONFIG_SH_ETHER
1146 Support for Renesas on-chip Ethernet controller
1147
1148 CONFIG_SH_ETHER_USE_PORT
1149 Define the number of ports to be used
1150
1151 CONFIG_SH_ETHER_PHY_ADDR
1152 Define the ETH PHY's address
1153
Yoshihiro Shimoda281aa052011-01-27 10:06:08 +09001154 CONFIG_SH_ETHER_CACHE_WRITEBACK
1155 If this option is set, the driver enables cache flush.
1156
Heiko Schocher2b387762014-07-18 06:07:19 +02001157- PWM Support:
1158 CONFIG_PWM_IMX
Robert P. J. Day1f8378a2016-09-13 08:35:18 -04001159 Support for PWM module on the imx6.
Heiko Schocher2b387762014-07-18 06:07:19 +02001160
Vadim Bendeburydac69642011-10-17 08:36:14 +00001161- TPM Support:
Che-liang Chiouacea5702013-04-12 11:04:34 +00001162 CONFIG_TPM
1163 Support TPM devices.
1164
Christophe Ricard8759ff82015-10-06 22:54:41 +02001165 CONFIG_TPM_TIS_INFINEON
1166 Support for Infineon i2c bus TPM devices. Only one device
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001167 per system is supported at this time.
1168
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001169 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1170 Define the burst count bytes upper limit
1171
Christophe Ricard88249232016-01-21 23:27:13 +01001172 CONFIG_TPM_ST33ZP24
1173 Support for STMicroelectronics TPM devices. Requires DM_TPM support.
1174
1175 CONFIG_TPM_ST33ZP24_I2C
1176 Support for STMicroelectronics ST33ZP24 I2C devices.
1177 Requires TPM_ST33ZP24 and I2C.
1178
Christophe Ricard5ffadc32016-01-21 23:27:14 +01001179 CONFIG_TPM_ST33ZP24_SPI
1180 Support for STMicroelectronics ST33ZP24 SPI devices.
1181 Requires TPM_ST33ZP24 and SPI.
1182
Dirk Eibach20489092013-06-26 15:55:15 +02001183 CONFIG_TPM_ATMEL_TWI
1184 Support for Atmel TWI TPM device. Requires I2C support.
1185
Che-liang Chiouacea5702013-04-12 11:04:34 +00001186 CONFIG_TPM_TIS_LPC
Vadim Bendeburydac69642011-10-17 08:36:14 +00001187 Support for generic parallel port TPM devices. Only one device
1188 per system is supported at this time.
1189
1190 CONFIG_TPM_TIS_BASE_ADDRESS
1191 Base address where the generic TPM device is mapped
1192 to. Contemporary x86 systems usually map it at
1193 0xfed40000.
1194
Reinhard Pfau4fece432013-06-26 15:55:13 +02001195 CONFIG_CMD_TPM
1196 Add tpm monitor functions.
1197 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1198 provides monitor access to authorized functions.
1199
1200 CONFIG_TPM
1201 Define this to enable the TPM support library which provides
1202 functional interfaces to some TPM commands.
1203 Requires support for a TPM device.
1204
1205 CONFIG_TPM_AUTH_SESSIONS
1206 Define this to enable authorized functions in the TPM library.
1207 Requires CONFIG_TPM and CONFIG_SHA1.
1208
wdenkc6097192002-11-03 00:24:07 +00001209- USB Support:
1210 At the moment only the UHCI host controller is
Heiko Schocher6f90e582017-06-14 05:49:40 +02001211 supported (PIP405, MIP405); define
wdenkc6097192002-11-03 00:24:07 +00001212 CONFIG_USB_UHCI to enable it.
1213 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenkfb30b4c2004-10-09 22:44:59 +00001214 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001215 storage devices.
1216 Note:
1217 Supported are USB Keyboards and USB Floppy drives
1218 (TEAC FD-05PUB).
wdenk369d43d2004-03-14 14:09:05 +00001219
Simon Glass5978cdb2012-02-27 10:52:47 +00001220 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1221 txfilltuning field in the EHCI controller on reset.
1222
Oleksandr Tymoshenko7a881752014-02-01 21:51:25 -07001223 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1224 HW module registers.
1225
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001226- USB Device:
1227 Define the below if you wish to use the USB console.
1228 Once firmware is rebuilt from a serial console issue the
1229 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001230 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001231 it has found a new device. The environment variable usbtty
1232 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denke2601822006-06-14 18:14:56 +02001233 appear to a USB host as a Linux gserial device or a
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001234 Common Device Class Abstract Control Model serial device.
1235 If you select usbtty = gserial you should be able to enumerate
1236 a Linux host by
1237 # modprobe usbserial vendor=0xVendorID product=0xProductID
1238 else if using cdc_acm, simply setting the environment
1239 variable usbtty to be cdc_acm should suffice. The following
1240 might be defined in YourBoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001241
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001242 CONFIG_USB_DEVICE
1243 Define this to build a UDC device
1244
1245 CONFIG_USB_TTY
1246 Define this to have a tty type of device available to
1247 talk to the UDC device
Wolfgang Denke2601822006-06-14 18:14:56 +02001248
Vipin KUMARbdb17702012-03-26 15:38:06 +05301249 CONFIG_USBD_HS
1250 Define this to enable the high speed support for usb
1251 device and usbtty. If this feature is enabled, a routine
1252 int is_usbd_high_speed(void)
1253 also needs to be defined by the driver to dynamically poll
1254 whether the enumeration has succeded at high speed or full
1255 speed.
1256
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001257 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001258 Define this if you want stdin, stdout &/or stderr to
1259 be set to usbtty.
1260
Wolfgang Denke2601822006-06-14 18:14:56 +02001261 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001262 define your own vendor specific values either in BoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001263 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001264 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1265 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1266 should pretend to be a Linux device to it's target host.
1267
1268 CONFIG_USBD_MANUFACTURER
1269 Define this string as the name of your company for
1270 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denke2601822006-06-14 18:14:56 +02001271
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001272 CONFIG_USBD_PRODUCT_NAME
1273 Define this string as the name of your product
1274 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
wdenkc6097192002-11-03 00:24:07 +00001275
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001276 CONFIG_USBD_VENDORID
1277 Define this as your assigned Vendor ID from the USB
1278 Implementors Forum. This *must* be a genuine Vendor ID
1279 to avoid polluting the USB namespace.
1280 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001281
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001282 CONFIG_USBD_PRODUCTID
1283 Define this as the unique Product ID
1284 for your device
1285 - CONFIG_USBD_PRODUCTID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001286
Igor Grinbergac5f6ee2011-12-12 12:08:35 +02001287- ULPI Layer Support:
1288 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1289 the generic ULPI layer. The generic layer accesses the ULPI PHY
1290 via the platform viewport, so you need both the genric layer and
1291 the viewport enabled. Currently only Chipidea/ARC based
1292 viewport is supported.
1293 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1294 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stachf31e4112012-10-01 00:44:35 +02001295 If your ULPI phy needs a different reference clock than the
1296 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1297 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001298
wdenk7a428cc2003-06-15 22:40:42 +00001299- MMC Support:
wdenk57b2d802003-06-27 21:31:46 +00001300 The MMC controller on the Intel PXA is supported. To
1301 enable this define CONFIG_MMC. The MMC can be
1302 accessed from the boot prompt by mapping the device
wdenk7a428cc2003-06-15 22:40:42 +00001303 to physical memory similar to flash. Command line is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001304 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1305 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenk7a428cc2003-06-15 22:40:42 +00001306
Yoshihiro Shimodadb7717b2011-07-04 22:21:22 +00001307 CONFIG_SH_MMCIF
1308 Support for Renesas on-chip MMCIF controller
1309
1310 CONFIG_SH_MMCIF_ADDR
1311 Define the base address of MMCIF registers
1312
1313 CONFIG_SH_MMCIF_CLK
1314 Define the clock frequency for MMCIF
1315
Pierre Aubertbcc302c2014-04-24 10:30:08 +02001316 CONFIG_SUPPORT_EMMC_BOOT
1317 Enable some additional features of the eMMC boot partitions.
1318
1319 CONFIG_SUPPORT_EMMC_RPMB
1320 Enable the commands for reading, writing and programming the
1321 key for the Replay Protection Memory Block partition in eMMC.
1322
Tom Rini58a8d322013-03-14 05:32:47 +00001323- USB Device Firmware Update (DFU) class support:
Paul Kocialkowski045d6052015-06-12 19:56:58 +02001324 CONFIG_USB_FUNCTION_DFU
Tom Rini58a8d322013-03-14 05:32:47 +00001325 This enables the USB portion of the DFU USB class
1326
1327 CONFIG_CMD_DFU
1328 This enables the command "dfu" which is used to have
1329 U-Boot create a DFU class device via USB. This command
1330 requires that the "dfu_alt_info" environment variable be
1331 set and define the alt settings to expose to the host.
1332
1333 CONFIG_DFU_MMC
1334 This enables support for exposing (e)MMC devices via DFU.
1335
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +00001336 CONFIG_DFU_NAND
1337 This enables support for exposing NAND devices via DFU.
1338
Afzal Mohammede3c687a2013-09-18 01:15:24 +05301339 CONFIG_DFU_RAM
1340 This enables support for exposing RAM via DFU.
1341 Note: DFU spec refer to non-volatile memory usage, but
1342 allow usages beyond the scope of spec - here RAM usage,
1343 one that would help mostly the developer.
1344
Heiko Schochera2f831e2013-06-12 06:05:51 +02001345 CONFIG_SYS_DFU_DATA_BUF_SIZE
1346 Dfu transfer uses a buffer before writing data to the
1347 raw storage device. Make the size (in bytes) of this buffer
1348 configurable. The size of this buffer is also configurable
1349 through the "dfu_bufsiz" environment variable.
1350
Pantelis Antonioua6e788d2013-03-14 05:32:48 +00001351 CONFIG_SYS_DFU_MAX_FILE_SIZE
1352 When updating files rather than the raw storage device,
1353 we use a static buffer to copy the file into and then write
1354 the buffer once we've been given the whole file. Define
1355 this to the maximum filesize (in bytes) for the buffer.
1356 Default is 4 MiB if undefined.
1357
Heiko Schochere1ba1512014-03-18 08:09:56 +01001358 DFU_DEFAULT_POLL_TIMEOUT
1359 Poll timeout [ms], is the timeout a device can send to the
1360 host. The host must wait for this timeout before sending
1361 a subsequent DFU_GET_STATUS request to the device.
1362
1363 DFU_MANIFEST_POLL_TIMEOUT
1364 Poll timeout [ms], which the device sends to the host when
1365 entering dfuMANIFEST state. Host waits this timeout, before
1366 sending again an USB request to the device.
1367
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001368- USB Device Android Fastboot support:
Paul Kocialkowskid55acc02015-06-12 19:56:59 +02001369 CONFIG_USB_FUNCTION_FASTBOOT
1370 This enables the USB part of the fastboot gadget
1371
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001372 CONFIG_CMD_FASTBOOT
1373 This enables the command "fastboot" which enables the Android
1374 fastboot mode for the platform's USB device. Fastboot is a USB
1375 protocol for downloading images, flashing and device control
1376 used on Android devices.
1377 See doc/README.android-fastboot for more information.
1378
1379 CONFIG_ANDROID_BOOT_IMAGE
1380 This enables support for booting images which use the Android
1381 image format header.
1382
Paul Kocialkowskif84f0912015-07-20 12:38:22 +02001383 CONFIG_FASTBOOT_BUF_ADDR
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001384 The fastboot protocol requires a large memory buffer for
1385 downloads. Define this to the starting RAM address to use for
1386 downloaded images.
1387
Paul Kocialkowskif84f0912015-07-20 12:38:22 +02001388 CONFIG_FASTBOOT_BUF_SIZE
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001389 The fastboot protocol requires a large memory buffer for
1390 downloads. This buffer should be as large as possible for a
1391 platform. Define this to the size available RAM for fastboot.
1392
Steve Raebfb9ba42014-08-26 11:47:28 -07001393 CONFIG_FASTBOOT_FLASH
1394 The fastboot protocol includes a "flash" command for writing
1395 the downloaded image to a non-volatile storage device. Define
1396 this to enable the "fastboot flash" command.
1397
1398 CONFIG_FASTBOOT_FLASH_MMC_DEV
1399 The fastboot "flash" command requires additional information
1400 regarding the non-volatile storage device. Define this to
1401 the eMMC device that fastboot should use to store the image.
1402
Steve Rae7d059342014-12-12 15:51:54 -08001403 CONFIG_FASTBOOT_GPT_NAME
1404 The fastboot "flash" command supports writing the downloaded
1405 image to the Protective MBR and the Primary GUID Partition
1406 Table. (Additionally, this downloaded image is post-processed
1407 to generate and write the Backup GUID Partition Table.)
1408 This occurs when the specified "partition name" on the
1409 "fastboot flash" command line matches this value.
Petr Kulhavy4ed1eca2016-09-09 10:27:18 +02001410 The default is "gpt" if undefined.
Steve Rae7d059342014-12-12 15:51:54 -08001411
Petr Kulhavy9f174c92016-09-09 10:27:16 +02001412 CONFIG_FASTBOOT_MBR_NAME
1413 The fastboot "flash" command supports writing the downloaded
1414 image to DOS MBR.
1415 This occurs when the "partition name" specified on the
1416 "fastboot flash" command line matches this value.
1417 If not defined the default value "mbr" is used.
1418
wdenkda04a8b2004-08-02 23:22:59 +00001419- Journaling Flash filesystem support:
Simon Glassfa8527b2016-10-02 18:00:59 -06001420 CONFIG_JFFS2_NAND
wdenkda04a8b2004-08-02 23:22:59 +00001421 Define these for a default partition on a NAND device
1422
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001423 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1424 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenkda04a8b2004-08-02 23:22:59 +00001425 Define these for a default partition on a NOR device
1426
wdenkc6097192002-11-03 00:24:07 +00001427- Keyboard Support:
Simon Glasseaba37e2015-11-11 10:05:47 -07001428 See Kconfig help for available keyboard drivers.
1429
1430 CONFIG_KEYBOARD
1431
1432 Define this to enable a custom keyboard support.
1433 This simply calls drv_keyboard_init() which must be
1434 defined in your board-specific files. This option is deprecated
1435 and is only used by novena. For new boards, use driver model
1436 instead.
wdenkc6097192002-11-03 00:24:07 +00001437
1438- Video support:
Timur Tabi020edd22011-02-15 17:09:19 -06001439 CONFIG_FSL_DIU_FB
Wolfgang Denk825223d2011-09-11 21:24:09 +02001440 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi020edd22011-02-15 17:09:19 -06001441 SOCs that have a DIU should define this macro to enable DIU
1442 support, and should also define these other macros:
1443
1444 CONFIG_SYS_DIU_ADDR
1445 CONFIG_VIDEO
Timur Tabi020edd22011-02-15 17:09:19 -06001446 CONFIG_CFB_CONSOLE
1447 CONFIG_VIDEO_SW_CURSOR
1448 CONFIG_VGA_AS_SINGLE_DEVICE
1449 CONFIG_VIDEO_LOGO
1450 CONFIG_VIDEO_BMP_LOGO
1451
Timur Tabi32f709e2011-04-11 14:18:22 -05001452 The DIU driver will look for the 'video-mode' environment
1453 variable, and if defined, enable the DIU as a console during
Fabio Estevamd3ad5e52016-04-02 11:53:18 -03001454 boot. See the documentation file doc/README.video for a
Timur Tabi32f709e2011-04-11 14:18:22 -05001455 description of this variable.
Timur Tabi020edd22011-02-15 17:09:19 -06001456
wdenkc6097192002-11-03 00:24:07 +00001457- LCD Support: CONFIG_LCD
1458
1459 Define this to enable LCD support (for output to LCD
1460 display); also select one of the supported displays
1461 by defining one of these:
1462
Stelian Popf6f86652008-05-09 21:57:18 +02001463 CONFIG_ATMEL_LCD:
1464
1465 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1466
wdenkc0d54ae2003-11-25 16:55:19 +00001467 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001468
wdenkc0d54ae2003-11-25 16:55:19 +00001469 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001470
wdenkc0d54ae2003-11-25 16:55:19 +00001471 CONFIG_NEC_NL6448BC20
1472
1473 NEC NL6448BC20-08. 6.5", 640x480.
1474 Active, color, single scan.
1475
1476 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +00001477
wdenkc0d54ae2003-11-25 16:55:19 +00001478 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001479 Active, color, single scan.
1480
1481 CONFIG_SHARP_16x9
1482
1483 Sharp 320x240. Active, color, single scan.
1484 It isn't 16x9, and I am not sure what it is.
1485
1486 CONFIG_SHARP_LQ64D341
1487
1488 Sharp LQ64D341 display, 640x480.
1489 Active, color, single scan.
1490
1491 CONFIG_HLD1045
1492
1493 HLD1045 display, 640x480.
1494 Active, color, single scan.
1495
1496 CONFIG_OPTREX_BW
1497
1498 Optrex CBL50840-2 NF-FW 99 22 M5
1499 or
1500 Hitachi LMG6912RPFC-00T
1501 or
1502 Hitachi SP14Q002
1503
1504 320x240. Black & white.
1505
Simon Glass599a4df2012-10-17 13:24:54 +00001506 CONFIG_LCD_ALIGNMENT
1507
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001508 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass599a4df2012-10-17 13:24:54 +00001509 defined then the LCD will be aligned to this value instead.
1510 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1511 here, since it is cheaper to change data cache settings on
1512 a per-section basis.
1513
1514
Hannes Petermaiera3c8e862015-03-27 08:01:38 +01001515 CONFIG_LCD_ROTATION
1516
1517 Sometimes, for example if the display is mounted in portrait
1518 mode or even if it's mounted landscape but rotated by 180degree,
1519 we need to rotate our content of the display relative to the
1520 framebuffer, so that user can read the messages which are
1521 printed out.
1522 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1523 initialized with a given rotation from "vl_rot" out of
1524 "vidinfo_t" which is provided by the board specific code.
1525 The value for vl_rot is coded as following (matching to
1526 fbcon=rotate:<n> linux-kernel commandline):
1527 0 = no rotation respectively 0 degree
1528 1 = 90 degree rotation
1529 2 = 180 degree rotation
1530 3 = 270 degree rotation
1531
1532 If CONFIG_LCD_ROTATION is not defined, the console will be
1533 initialized with 0degree rotation.
1534
Tom Wai-Hong Tam79926a42012-09-28 15:11:16 +00001535 CONFIG_LCD_BMP_RLE8
1536
1537 Support drawing of RLE8-compressed bitmaps on the LCD.
1538
Tom Wai-Hong Tam6664f202012-12-05 14:46:40 +00001539 CONFIG_I2C_EDID
1540
1541 Enables an 'i2c edid' command which can read EDID
1542 information over I2C from an attached LCD display.
1543
wdenkeb20ad32003-09-05 23:19:14 +00001544- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenk92bbe3f2003-04-20 14:04:18 +00001545
wdenk57b2d802003-06-27 21:31:46 +00001546 If this option is set, the environment is checked for
1547 a variable "splashimage". If found, the usual display
1548 of logo, copyright and system information on the LCD
wdenk01686632004-06-30 22:59:18 +00001549 is suppressed and the BMP image at the address
wdenk57b2d802003-06-27 21:31:46 +00001550 specified in "splashimage" is loaded instead. The
1551 console is redirected to the "nulldev", too. This
1552 allows for a "silent" boot where a splash screen is
1553 loaded very quickly after power-on.
wdenk92bbe3f2003-04-20 14:04:18 +00001554
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001555 CONFIG_SPLASHIMAGE_GUARD
1556
1557 If this option is set, then U-Boot will prevent the environment
1558 variable "splashimage" from being set to a problematic address
Fabio Estevama58b4912016-03-23 12:46:12 -03001559 (see doc/README.displaying-bmps).
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001560 This option is useful for targets where, due to alignment
1561 restrictions, an improperly aligned BMP image will cause a data
1562 abort. If you think you will not have problems with unaligned
1563 accesses (for example because your toolchain prevents them)
1564 there is no need to set this option.
1565
Matthias Weisser53884182009-07-09 16:07:30 +02001566 CONFIG_SPLASH_SCREEN_ALIGN
1567
1568 If this option is set the splash image can be freely positioned
1569 on the screen. Environment variable "splashpos" specifies the
1570 position as "x,y". If a positive number is given it is used as
1571 number of pixel from left/top. If a negative number is given it
1572 is used as number of pixel from right/bottom. You can also
1573 specify 'm' for centering the image.
1574
1575 Example:
1576 setenv splashpos m,m
1577 => image at center of screen
1578
1579 setenv splashpos 30,20
1580 => image at x = 30 and y = 20
1581
1582 setenv splashpos -10,m
1583 => vertically centered image
1584 at x = dspWidth - bmpWidth - 9
1585
Stefan Roesed9d97742005-09-22 09:04:17 +02001586- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1587
1588 If this option is set, additionally to standard BMP
1589 images, gzipped BMP images can be displayed via the
1590 splashscreen support or the bmp command.
1591
Anatolij Gustschin6b4e4fc2010-03-15 14:50:25 +01001592- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1593
1594 If this option is set, 8-bit RLE compressed BMP images
1595 can be displayed via the splashscreen support or the
1596 bmp command.
1597
wdenk710e3502003-08-29 20:57:53 +00001598- Compression support:
Kees Cook5b06e642013-08-16 07:59:12 -07001599 CONFIG_GZIP
1600
1601 Enabled by default to support gzip compressed images.
1602
wdenk710e3502003-08-29 20:57:53 +00001603 CONFIG_BZIP2
1604
1605 If this option is set, support for bzip2 compressed
1606 images is included. If not, only uncompressed and gzip
1607 compressed images are supported.
1608
wdenk9c53f402003-10-15 23:53:47 +00001609 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001610 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk9c53f402003-10-15 23:53:47 +00001611 be at least 4MB.
wdenk92bbe3f2003-04-20 14:04:18 +00001612
wdenk0e2bd9c2004-06-06 21:51:03 +00001613- MII/PHY support:
1614 CONFIG_PHY_ADDR
1615
1616 The address of PHY on MII bus.
1617
1618 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1619
1620 The clock frequency of the MII bus
1621
wdenk0e2bd9c2004-06-06 21:51:03 +00001622 CONFIG_PHY_RESET_DELAY
1623
1624 Some PHY like Intel LXT971A need extra delay after
1625 reset before any MII register access is possible.
1626 For such PHY, set this option to the usec delay
1627 required. (minimum 300usec for LXT971A)
1628
1629 CONFIG_PHY_CMD_DELAY (ppc4xx)
1630
1631 Some PHY like Intel LXT971A need extra delay after
1632 command issued before MII status register can be read
1633
wdenkc6097192002-11-03 00:24:07 +00001634- IP address:
1635 CONFIG_IPADDR
1636
1637 Define a default value for the IP address to use for
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001638 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001639 determined through e.g. bootp.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001640 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001641
1642- Server IP address:
1643 CONFIG_SERVERIP
1644
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001645 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001646 server to contact when using the "tftboot" command.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001647 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001648
Robin Getz470a6d42009-07-21 12:15:28 -04001649 CONFIG_KEEP_SERVERADDR
1650
1651 Keeps the server's MAC address, in the env 'serveraddr'
1652 for passing to bootargs (like Linux's netconsole option)
1653
Wolfgang Denk26da2992011-10-26 10:21:22 +00001654- Gateway IP address:
1655 CONFIG_GATEWAYIP
1656
1657 Defines a default value for the IP address of the
1658 default router where packets to other networks are
1659 sent to.
1660 (Environment variable "gatewayip")
1661
1662- Subnet mask:
1663 CONFIG_NETMASK
1664
1665 Defines a default value for the subnet mask (or
1666 routing prefix) which is used to determine if an IP
1667 address belongs to the local subnet or needs to be
1668 forwarded through a router.
1669 (Environment variable "netmask")
1670
David Updegraff7280da72007-06-11 10:41:07 -05001671- Multicast TFTP Mode:
1672 CONFIG_MCAST_TFTP
1673
1674 Defines whether you want to support multicast TFTP as per
1675 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001676 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff7280da72007-06-11 10:41:07 -05001677 driver in use must provide a function: mcast() to join/leave a
1678 multicast group.
1679
wdenkc6097192002-11-03 00:24:07 +00001680- BOOTP Recovery Mode:
1681 CONFIG_BOOTP_RANDOM_DELAY
1682
1683 If you have many targets in a network that try to
1684 boot using BOOTP, you may want to avoid that all
1685 systems send out BOOTP requests at precisely the same
1686 moment (which would happen for instance at recovery
1687 from a power failure, when all systems will try to
1688 boot, thus flooding the BOOTP server. Defining
1689 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1690 inserted before sending out BOOTP requests. The
Wolfgang Denkb65aaf92007-08-06 23:21:05 +02001691 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001692
1693 1st BOOTP request: delay 0 ... 1 sec
1694 2nd BOOTP request: delay 0 ... 2 sec
1695 3rd BOOTP request: delay 0 ... 4 sec
1696 4th and following
1697 BOOTP requests: delay 0 ... 8 sec
1698
Thierry Reding8977cda2014-08-19 10:21:24 +02001699 CONFIG_BOOTP_ID_CACHE_SIZE
1700
1701 BOOTP packets are uniquely identified using a 32-bit ID. The
1702 server will copy the ID from client requests to responses and
1703 U-Boot will use this to determine if it is the destination of
1704 an incoming response. Some servers will check that addresses
1705 aren't in use before handing them out (usually using an ARP
1706 ping) and therefore take up to a few hundred milliseconds to
1707 respond. Network congestion may also influence the time it
1708 takes for a response to make it back to the client. If that
1709 time is too long, U-Boot will retransmit requests. In order
1710 to allow earlier responses to still be accepted after these
1711 retransmissions, U-Boot's BOOTP client keeps a small cache of
1712 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
1713 cache. The default is to keep IDs for up to four outstanding
1714 requests. Increasing this will allow U-Boot to accept offers
1715 from a BOOTP client in networks with unusually high latency.
1716
stroesee0aadfb2003-08-28 14:17:32 +00001717- DHCP Advanced Options:
Jon Loeliger5336a762007-07-09 22:08:34 -05001718 You can fine tune the DHCP functionality by defining
1719 CONFIG_BOOTP_* symbols:
stroesee0aadfb2003-08-28 14:17:32 +00001720
Jon Loeliger5336a762007-07-09 22:08:34 -05001721 CONFIG_BOOTP_SUBNETMASK
1722 CONFIG_BOOTP_GATEWAY
1723 CONFIG_BOOTP_HOSTNAME
1724 CONFIG_BOOTP_NISDOMAIN
1725 CONFIG_BOOTP_BOOTPATH
1726 CONFIG_BOOTP_BOOTFILESIZE
1727 CONFIG_BOOTP_DNS
1728 CONFIG_BOOTP_DNS2
1729 CONFIG_BOOTP_SEND_HOSTNAME
1730 CONFIG_BOOTP_NTPSERVER
1731 CONFIG_BOOTP_TIMEOFFSET
1732 CONFIG_BOOTP_VENDOREX
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001733 CONFIG_BOOTP_MAY_FAIL
stroesee0aadfb2003-08-28 14:17:32 +00001734
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001735 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1736 environment variable, not the BOOTP server.
stroesee0aadfb2003-08-28 14:17:32 +00001737
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001738 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1739 after the configured retry count, the call will fail
1740 instead of starting over. This can be used to fail over
1741 to Link-local IP address configuration if the DHCP server
1742 is not available.
1743
stroesee0aadfb2003-08-28 14:17:32 +00001744 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1745 serverip from a DHCP server, it is possible that more
1746 than one DNS serverip is offered to the client.
1747 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1748 serverip will be stored in the additional environment
1749 variable "dnsip2". The first DNS serverip is always
1750 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger5336a762007-07-09 22:08:34 -05001751 is defined.
stroesee0aadfb2003-08-28 14:17:32 +00001752
1753 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1754 to do a dynamic update of a DNS server. To do this, they
1755 need the hostname of the DHCP requester.
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001756 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger5336a762007-07-09 22:08:34 -05001757 of the "hostname" environment variable is passed as
1758 option 12 to the DHCP server.
stroesee0aadfb2003-08-28 14:17:32 +00001759
Aras Vaichas72aa3f32008-03-26 09:43:57 +11001760 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1761
1762 A 32bit value in microseconds for a delay between
1763 receiving a "DHCP Offer" and sending the "DHCP Request".
1764 This fixes a problem with certain DHCP servers that don't
1765 respond 100% of the time to a "DHCP request". E.g. On an
1766 AT91RM9200 processor running at 180MHz, this delay needed
1767 to be *at least* 15,000 usec before a Windows Server 2003
1768 DHCP server would reply 100% of the time. I recommend at
1769 least 50,000 usec to be safe. The alternative is to hope
1770 that one of the retries will be successful but note that
1771 the DHCP timeout and retry process takes a longer than
1772 this delay.
1773
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00001774 - Link-local IP address negotiation:
1775 Negotiate with other link-local clients on the local network
1776 for an address that doesn't require explicit configuration.
1777 This is especially useful if a DHCP server cannot be guaranteed
1778 to exist in all environments that the device must operate.
1779
1780 See doc/README.link-local for more information.
1781
wdenk145d2c12004-04-15 21:48:45 +00001782 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00001783 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00001784
1785 The device id used in CDP trigger frames.
1786
1787 CONFIG_CDP_DEVICE_ID_PREFIX
1788
1789 A two character string which is prefixed to the MAC address
1790 of the device.
1791
1792 CONFIG_CDP_PORT_ID
1793
1794 A printf format string which contains the ascii name of
1795 the port. Normally is set to "eth%d" which sets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001796 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-04-15 21:48:45 +00001797
1798 CONFIG_CDP_CAPABILITIES
1799
1800 A 32bit integer which indicates the device capabilities;
1801 0x00000010 for a normal host which does not forwards.
1802
1803 CONFIG_CDP_VERSION
1804
1805 An ascii string containing the version of the software.
1806
1807 CONFIG_CDP_PLATFORM
1808
1809 An ascii string containing the name of the platform.
1810
1811 CONFIG_CDP_TRIGGER
1812
1813 A 32bit integer sent on the trigger.
1814
1815 CONFIG_CDP_POWER_CONSUMPTION
1816
1817 A 16bit integer containing the power consumption of the
1818 device in .1 of milliwatts.
1819
1820 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1821
1822 A byte containing the id of the VLAN.
1823
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001824- Status LED: CONFIG_LED_STATUS
wdenkc6097192002-11-03 00:24:07 +00001825
1826 Several configurations allow to display the current
1827 status using a LED. For instance, the LED will blink
1828 fast while running U-Boot code, stop blinking as
1829 soon as a reply to a BOOTP request was received, and
1830 start blinking slow once the Linux kernel is running
1831 (supported by a status LED driver in the Linux
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001832 kernel). Defining CONFIG_LED_STATUS enables this
wdenkc6097192002-11-03 00:24:07 +00001833 feature in U-Boot.
1834
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001835 Additional options:
1836
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001837 CONFIG_LED_STATUS_GPIO
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001838 The status LED can be connected to a GPIO pin.
1839 In such cases, the gpio_led driver can be used as a
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001840 status LED backend implementation. Define CONFIG_LED_STATUS_GPIO
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001841 to include the gpio_led driver in the U-Boot binary.
1842
Igor Grinberg203bd9f2013-11-08 01:03:52 +02001843 CONFIG_GPIO_LED_INVERTED_TABLE
1844 Some GPIO connected LEDs may have inverted polarity in which
1845 case the GPIO high value corresponds to LED off state and
1846 GPIO low value corresponds to LED on state.
1847 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
1848 with a list of GPIO LEDs that have inverted polarity.
1849
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001850- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00001851
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001852 This enable the NEW i2c subsystem, and will allow you to use
1853 i2c commands at the u-boot command line (as long as you set
1854 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
1855 based realtime clock chips or other i2c devices. See
1856 common/cmd_i2c.c for a description of the command line
1857 interface.
1858
1859 ported i2c driver to the new framework:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01001860 - drivers/i2c/soft_i2c.c:
1861 - activate first bus with CONFIG_SYS_I2C_SOFT define
1862 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
1863 for defining speed and slave address
1864 - activate second bus with I2C_SOFT_DECLARATIONS2 define
1865 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
1866 for defining speed and slave address
1867 - activate third bus with I2C_SOFT_DECLARATIONS3 define
1868 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
1869 for defining speed and slave address
1870 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
1871 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
1872 for defining speed and slave address
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001873
Heiko Schocherf2850742012-10-24 13:48:22 +02001874 - drivers/i2c/fsl_i2c.c:
1875 - activate i2c driver with CONFIG_SYS_I2C_FSL
1876 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
1877 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
1878 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
1879 bus.
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001880 - If your board supports a second fsl i2c bus, define
Heiko Schocherf2850742012-10-24 13:48:22 +02001881 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
1882 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
1883 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
1884 second bus.
1885
Simon Glass026fefb2012-10-30 07:28:53 +00001886 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu045acfa2013-10-11 16:23:53 +09001887 - activate this driver with CONFIG_SYS_I2C_TEGRA
1888 - This driver adds 4 i2c buses with a fix speed from
1889 100000 and the slave addr 0!
Simon Glass026fefb2012-10-30 07:28:53 +00001890
Dirk Eibach42b204f2013-04-25 02:40:01 +00001891 - drivers/i2c/ppc4xx_i2c.c
1892 - activate this driver with CONFIG_SYS_I2C_PPC4XX
1893 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
1894 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
1895
trema49f40a2013-09-21 18:13:35 +02001896 - drivers/i2c/i2c_mxc.c
1897 - activate this driver with CONFIG_SYS_I2C_MXC
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02001898 - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
1899 - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
1900 - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
1901 - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
trema49f40a2013-09-21 18:13:35 +02001902 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
1903 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
1904 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
1905 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
1906 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
1907 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02001908 - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
1909 - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001910 If those defines are not set, default value is 100000
trema49f40a2013-09-21 18:13:35 +02001911 for speed, and 0 for slave.
1912
Nobuhiro Iwamatsue94ea2f2013-09-27 16:58:30 +09001913 - drivers/i2c/rcar_i2c.c:
1914 - activate this driver with CONFIG_SYS_I2C_RCAR
1915 - This driver adds 4 i2c buses
1916
1917 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
1918 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
1919 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
1920 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
1921 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
1922 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
1923 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
1924 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
1925 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
1926
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09001927 - drivers/i2c/sh_i2c.c:
1928 - activate this driver with CONFIG_SYS_I2C_SH
1929 - This driver adds from 2 to 5 i2c buses
1930
1931 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
1932 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
1933 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
1934 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
1935 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
1936 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
1937 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
1938 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
1939 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
1940 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001941 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09001942
Heiko Schocherf53f2b82013-10-22 11:03:18 +02001943 - drivers/i2c/omap24xx_i2c.c
1944 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
1945 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
1946 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
1947 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
1948 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
1949 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
1950 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
1951 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
1952 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
1953 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
1954 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
1955
Heiko Schocher465819a2013-11-08 07:30:53 +01001956 - drivers/i2c/zynq_i2c.c
1957 - activate this driver with CONFIG_SYS_I2C_ZYNQ
1958 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
1959 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
1960
Naveen Krishna Ch5d5efd32013-12-06 12:12:38 +05301961 - drivers/i2c/s3c24x0_i2c.c:
1962 - activate this driver with CONFIG_SYS_I2C_S3C24X0
1963 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
1964 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
1965 with a fix speed from 100000 and the slave addr 0!
1966
Dirk Eibachb9577432014-07-03 09:28:18 +02001967 - drivers/i2c/ihs_i2c.c
1968 - activate this driver with CONFIG_SYS_I2C_IHS
1969 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
1970 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
1971 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
1972 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
1973 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
1974 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
1975 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
1976 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
1977 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
1978 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
1979 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
1980 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
Dirk Eibach9ac33852015-10-28 11:46:22 +01001981 - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
1982 - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
1983 - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
1984 - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
1985 - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
1986 - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
1987 - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
1988 - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
1989 - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
Dirk Eibachb9577432014-07-03 09:28:18 +02001990
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001991 additional defines:
1992
1993 CONFIG_SYS_NUM_I2C_BUSES
Simon Glassb05e2b32016-10-02 18:01:05 -06001994 Hold the number of i2c buses you want to use.
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001995
1996 CONFIG_SYS_I2C_DIRECT_BUS
1997 define this, if you don't use i2c muxes on your hardware.
1998 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
1999 omit this define.
2000
2001 CONFIG_SYS_I2C_MAX_HOPS
2002 define how many muxes are maximal consecutively connected
2003 on one i2c bus. If you not use i2c muxes, omit this
2004 define.
2005
2006 CONFIG_SYS_I2C_BUSES
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002007 hold a list of buses you want to use, only used if
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002008 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2009 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2010 CONFIG_SYS_NUM_I2C_BUSES = 9:
2011
2012 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2013 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2014 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2015 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2016 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2017 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2018 {1, {I2C_NULL_HOP}}, \
2019 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2020 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2021 }
2022
2023 which defines
2024 bus 0 on adapter 0 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002025 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2026 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2027 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2028 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2029 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002030 bus 6 on adapter 1 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002031 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2032 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002033
2034 If you do not have i2c muxes on your board, omit this define.
2035
Simon Glass3efce392017-05-12 21:10:00 -06002036- Legacy I2C Support:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002037 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb9bbd242003-06-30 16:24:52 +00002038 then the following macros need to be defined (examples are
2039 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002040
2041 I2C_INIT
2042
wdenkb9bbd242003-06-30 16:24:52 +00002043 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00002044 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002045
wdenk544e9732004-02-06 23:19:44 +00002046 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00002047
wdenkc6097192002-11-03 00:24:07 +00002048 I2C_ACTIVE
2049
2050 The code necessary to make the I2C data line active
2051 (driven). If the data line is open collector, this
2052 define can be null.
2053
wdenkb9bbd242003-06-30 16:24:52 +00002054 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2055
wdenkc6097192002-11-03 00:24:07 +00002056 I2C_TRISTATE
2057
2058 The code necessary to make the I2C data line tri-stated
2059 (inactive). If the data line is open collector, this
2060 define can be null.
2061
wdenkb9bbd242003-06-30 16:24:52 +00002062 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2063
wdenkc6097192002-11-03 00:24:07 +00002064 I2C_READ
2065
York Sun4a598092013-04-01 11:29:11 -07002066 Code that returns true if the I2C data line is high,
2067 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002068
wdenkb9bbd242003-06-30 16:24:52 +00002069 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2070
wdenkc6097192002-11-03 00:24:07 +00002071 I2C_SDA(bit)
2072
York Sun4a598092013-04-01 11:29:11 -07002073 If <bit> is true, sets the I2C data line high. If it
2074 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002075
wdenkb9bbd242003-06-30 16:24:52 +00002076 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002077 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00002078 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00002079
wdenkc6097192002-11-03 00:24:07 +00002080 I2C_SCL(bit)
2081
York Sun4a598092013-04-01 11:29:11 -07002082 If <bit> is true, sets the I2C clock line high. If it
2083 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002084
wdenkb9bbd242003-06-30 16:24:52 +00002085 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002086 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00002087 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00002088
wdenkc6097192002-11-03 00:24:07 +00002089 I2C_DELAY
2090
2091 This delay is invoked four times per clock cycle so this
2092 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00002093 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00002094 like:
2095
wdenkb9bbd242003-06-30 16:24:52 +00002096 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002097
Mike Frysingeree12d542010-07-21 13:38:02 -04002098 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2099
2100 If your arch supports the generic GPIO framework (asm/gpio.h),
2101 then you may alternatively define the two GPIOs that are to be
2102 used as SCL / SDA. Any of the previous I2C_xxx macros will
2103 have GPIO-based defaults assigned to them as appropriate.
2104
2105 You should define these to the GPIO value as given directly to
2106 the generic GPIO functions.
2107
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002108 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00002109
wdenk57b2d802003-06-27 21:31:46 +00002110 When a board is reset during an i2c bus transfer
2111 chips might think that the current transfer is still
2112 in progress. On some boards it is possible to access
2113 the i2c SCLK line directly, either by using the
2114 processor pin as a GPIO or by having a second pin
2115 connected to the bus. If this option is defined a
2116 custom i2c_init_board() routine in boards/xxx/board.c
2117 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00002118
Ben Warren45657152006-09-07 16:50:54 -04002119 CONFIG_I2C_MULTI_BUS
2120
2121 This option allows the use of multiple I2C buses, each of which
Wolfgang Denk092ae952011-10-26 10:21:21 +00002122 must have a controller. At any point in time, only one bus is
2123 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warren45657152006-09-07 16:50:54 -04002124 Note that bus numbering is zero-based.
2125
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002126 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04002127
2128 This option specifies a list of I2C devices that will be skipped
Wolfgang Denk092ae952011-10-26 10:21:21 +00002129 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser469cde42009-04-18 22:34:03 -05002130 is set, specify a list of bus-device pairs. Otherwise, specify
2131 a 1D array of device addresses
Ben Warren45657152006-09-07 16:50:54 -04002132
2133 e.g.
2134 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denk092ae952011-10-26 10:21:21 +00002135 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04002136
2137 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2138
Wolfgang Denk092ae952011-10-26 10:21:21 +00002139 #define CONFIG_I2C_MULTI_BUS
Simon Glassb05e2b32016-10-02 18:01:05 -06002140 #define CONFIG_SYS_I2C_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-09-07 16:50:54 -04002141
2142 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2143
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002144 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-11-03 19:15:00 -06002145
2146 If defined, then this indicates the I2C bus number for DDR SPD.
2147 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2148
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002149 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002150
2151 If defined, then this indicates the I2C bus number for the RTC.
2152 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2153
Andrew Dyer58c41f92008-12-29 17:36:01 -06002154 CONFIG_SOFT_I2C_READ_REPEATED_START
2155
2156 defining this will force the i2c_read() function in
2157 the soft_i2c driver to perform an I2C repeated start
2158 between writing the address pointer and reading the
2159 data. If this define is omitted the default behaviour
2160 of doing a stop-start sequence will be used. Most I2C
2161 devices can use either method, but some require one or
2162 the other.
Timur Tabiab347542006-11-03 19:15:00 -06002163
wdenkc6097192002-11-03 00:24:07 +00002164- SPI Support: CONFIG_SPI
2165
2166 Enables SPI driver (so far only tested with
2167 SPI EEPROM, also an instance works with Crystal A/D and
2168 D/As on the SACSng board)
2169
Yoshihiro Shimoda65bd9b42011-01-31 16:50:43 +09002170 CONFIG_SH_SPI
2171
2172 Enables the driver for SPI controller on SuperH. Currently
2173 only SH7757 is supported.
2174
wdenkc6097192002-11-03 00:24:07 +00002175 CONFIG_SOFT_SPI
2176
wdenk4a5c8a72003-03-06 00:02:04 +00002177 Enables a software (bit-bang) SPI driver rather than
2178 using hardware support. This is a general purpose
2179 driver that only requires three general I/O port pins
2180 (two outputs, one input) to function. If this is
2181 defined, the board configuration must define several
2182 SPI configuration items (port pins to use, etc). For
2183 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002184
Ben Warren7efe9272008-01-16 22:37:35 -05002185 CONFIG_HARD_SPI
2186
2187 Enables a hardware SPI driver for general-purpose reads
2188 and writes. As with CONFIG_SOFT_SPI, the board configuration
2189 must define a list of chip-select function pointers.
Wolfgang Denk092ae952011-10-26 10:21:21 +00002190 Currently supported on some MPC8xxx processors. For an
Ben Warren7efe9272008-01-16 22:37:35 -05002191 example, see include/configs/mpc8349emds.h.
2192
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002193 CONFIG_MXC_SPI
2194
2195 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevamdcd342c2011-10-28 08:57:46 +00002196 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002197
Heiko Schocherb77c8882014-07-14 10:22:11 +02002198 CONFIG_SYS_SPI_MXC_WAIT
2199 Timeout for waiting until spi transfer completed.
2200 default: (CONFIG_SYS_HZ/100) /* 10 ms */
2201
Matthias Fuchsa4400872007-12-27 17:12:34 +01002202- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00002203
Matthias Fuchsa4400872007-12-27 17:12:34 +01002204 Enables FPGA subsystem.
2205
2206 CONFIG_FPGA_<vendor>
2207
2208 Enables support for specific chip vendors.
2209 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00002210
Matthias Fuchsa4400872007-12-27 17:12:34 +01002211 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00002212
Matthias Fuchsa4400872007-12-27 17:12:34 +01002213 Enables support for FPGA family.
2214 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2215
2216 CONFIG_FPGA_COUNT
2217
2218 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002219
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002220 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002221
wdenk57b2d802003-06-27 21:31:46 +00002222 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002223
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002224 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002225
wdenk4a5c8a72003-03-06 00:02:04 +00002226 Enable checks on FPGA configuration interface busy
2227 status by the configuration function. This option
2228 will require a board or device specific function to
2229 be written.
wdenkc6097192002-11-03 00:24:07 +00002230
2231 CONFIG_FPGA_DELAY
2232
2233 If defined, a function that provides delays in the FPGA
2234 configuration driver.
2235
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002236 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002237 Allow Control-C to interrupt FPGA configuration
2238
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002239 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002240
wdenk4a5c8a72003-03-06 00:02:04 +00002241 Check for configuration errors during FPGA bitfile
2242 loading. For example, abort during Virtex II
2243 configuration if the INIT_B line goes low (which
2244 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002245
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002246 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002247
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002248 Maximum time to wait for the INIT_B line to de-assert
2249 after PROB_B has been de-asserted during a Virtex II
wdenk4a5c8a72003-03-06 00:02:04 +00002250 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002251 ms.
wdenkc6097192002-11-03 00:24:07 +00002252
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002253 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002254
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002255 Maximum time to wait for BUSY to de-assert during
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002256 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002257
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002258 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002259
wdenk4a5c8a72003-03-06 00:02:04 +00002260 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002261 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002262
2263- Configuration Management:
Stefan Roese141ed202014-10-22 12:13:24 +02002264 CONFIG_BUILD_TARGET
2265
2266 Some SoCs need special image types (e.g. U-Boot binary
2267 with a special header) as build targets. By defining
2268 CONFIG_BUILD_TARGET in the SoC / board header, this
2269 special image will be automatically built upon calling
Simon Glassdc27def2016-07-27 20:33:08 -06002270 make / buildman.
Stefan Roese141ed202014-10-22 12:13:24 +02002271
wdenkc6097192002-11-03 00:24:07 +00002272 CONFIG_IDENT_STRING
2273
wdenk4a5c8a72003-03-06 00:02:04 +00002274 If defined, this string will be added to the U-Boot
2275 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002276
2277- Vendor Parameter Protection:
2278
wdenk4a5c8a72003-03-06 00:02:04 +00002279 U-Boot considers the values of the environment
2280 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00002281 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00002282 are set once by the board vendor / manufacturer, and
2283 protects these variables from casual modification by
2284 the user. Once set, these variables are read-only,
2285 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002286 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002287
2288 If CONFIG_ENV_OVERWRITE is #defined in your config
2289 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00002290 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002291 these parameters.
2292
Joe Hershberger76f353e2015-05-04 14:55:14 -05002293 Alternatively, if you define _both_ an ethaddr in the
2294 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002295 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002296 which can be changed exactly ONCE by the user. [The
2297 serial# is unaffected by this, i. e. it remains
2298 read-only.]
2299
Joe Hershberger71497d02012-12-11 22:16:31 -06002300 The same can be accomplished in a more flexible way
2301 for any variable by configuring the type of access
2302 to allow for those variables in the ".flags" variable
2303 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2304
wdenkc6097192002-11-03 00:24:07 +00002305- Protected RAM:
2306 CONFIG_PRAM
2307
2308 Define this variable to enable the reservation of
2309 "protected RAM", i. e. RAM which is not overwritten
2310 by U-Boot. Define CONFIG_PRAM to hold the number of
2311 kB you want to reserve for pRAM. You can overwrite
2312 this default value by defining an environment
2313 variable "pram" to the number of kB you want to
2314 reserve. Note that the board info structure will
2315 still show the full amount of RAM. If pRAM is
2316 reserved, a new environment variable "mem" will
2317 automatically be defined to hold the amount of
2318 remaining RAM in a form that can be passed as boot
2319 argument to Linux, for instance like that:
2320
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01002321 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002322 saveenv
2323
2324 This way you can tell Linux not to use this memory,
2325 either, which results in a memory region that will
2326 not be affected by reboots.
2327
2328 *WARNING* If your board configuration uses automatic
2329 detection of the RAM size, you must make sure that
2330 this memory test is non-destructive. So far, the
2331 following board configurations are known to be
2332 "pRAM-clean":
2333
Heiko Schocher65d94db2017-06-07 17:33:09 +02002334 IVMS8, IVML24, SPD8xx,
Wolfgang Denk90326762012-10-24 02:36:15 +00002335 HERMES, IP860, RPXlite, LWMON,
Heiko Schocher71cb3e92017-06-07 17:33:10 +02002336 FLAGADM
wdenkc6097192002-11-03 00:24:07 +00002337
Gabe Blacka2f3a932012-12-02 04:55:18 +00002338- Access to physical memory region (> 4GB)
2339 Some basic support is provided for operations on memory not
2340 normally accessible to U-Boot - e.g. some architectures
2341 support access to more than 4GB of memory on 32-bit
2342 machines using physical address extension or similar.
2343 Define CONFIG_PHYSMEM to access this basic support, which
2344 currently only supports clearing the memory.
2345
wdenkc6097192002-11-03 00:24:07 +00002346- Error Recovery:
2347 CONFIG_PANIC_HANG
2348
2349 Define this variable to stop the system in case of a
2350 fatal error, so that you have to reset it manually.
2351 This is probably NOT a good idea for an embedded
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002352 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002353 automatically as fast as possible, but it may be
2354 useful during development since you can try to debug
2355 the conditions that lead to the situation.
2356
2357 CONFIG_NET_RETRY_COUNT
2358
wdenk4a5c8a72003-03-06 00:02:04 +00002359 This variable defines the number of retries for
2360 network operations like ARP, RARP, TFTP, or BOOTP
2361 before giving up the operation. If not defined, a
2362 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002363
Guennadi Liakhovetskib38c2b32008-04-03 17:04:19 +02002364 CONFIG_ARP_TIMEOUT
2365
2366 Timeout waiting for an ARP reply in milliseconds.
2367
Tetsuyuki Kobayashi147e3902012-07-03 22:25:21 +00002368 CONFIG_NFS_TIMEOUT
2369
2370 Timeout in milliseconds used in NFS protocol.
2371 If you encounter "ERROR: Cannot umount" in nfs command,
2372 try longer timeout such as
2373 #define CONFIG_NFS_TIMEOUT 10000UL
2374
wdenkc6097192002-11-03 00:24:07 +00002375- Command Interpreter:
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002376 CONFIG_AUTO_COMPLETE
wdenk3902d702004-04-15 18:22:41 +00002377
2378 Enable auto completion of commands using TAB.
2379
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002380 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002381
2382 This defines the secondary prompt string, which is
2383 printed when the command interpreter needs more input
2384 to complete a command. Usually "> ".
2385
2386 Note:
2387
wdenk57b2d802003-06-27 21:31:46 +00002388 In the current implementation, the local variables
2389 space and global environment variables space are
2390 separated. Local variables are those you define by
2391 simply typing `name=value'. To access a local
2392 variable later on, you have write `$name' or
2393 `${name}'; to execute the contents of a variable
2394 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002395
wdenk4a5c8a72003-03-06 00:02:04 +00002396 Global environment variables are those you use
2397 setenv/printenv to work with. To run a command stored
2398 in such a variable, you need to use the run command,
2399 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002400
2401 To store commands and special characters in a
2402 variable, please use double quotation marks
2403 surrounding the whole text of the variable, instead
2404 of the backslashes before semicolons and special
2405 symbols.
2406
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002407- Command Line Editing and History:
Wolfgang Denk2039a072006-07-21 11:35:21 +02002408 CONFIG_CMDLINE_EDITING
2409
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002410 Enable editing and History functions for interactive
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002411 command line input operations
Wolfgang Denk2039a072006-07-21 11:35:21 +02002412
Marek Vasut734fb042016-01-27 04:47:55 +01002413- Command Line PS1/PS2 support:
2414 CONFIG_CMDLINE_PS_SUPPORT
2415
2416 Enable support for changing the command prompt string
2417 at run-time. Only static string is supported so far.
2418 The string is obtained from environment variables PS1
2419 and PS2.
2420
wdenkc0aa5c52003-12-06 19:49:23 +00002421- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002422 CONFIG_EXTRA_ENV_SETTINGS
2423
wdenk4a5c8a72003-03-06 00:02:04 +00002424 Define this to contain any number of null terminated
2425 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00002426 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00002427
wdenk4a5c8a72003-03-06 00:02:04 +00002428 For example, place something like this in your
2429 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002430
2431 #define CONFIG_EXTRA_ENV_SETTINGS \
2432 "myvar1=value1\0" \
2433 "myvar2=value2\0"
2434
wdenk4a5c8a72003-03-06 00:02:04 +00002435 Warning: This method is based on knowledge about the
2436 internal format how the environment is stored by the
2437 U-Boot code. This is NOT an official, exported
2438 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00002439 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002440 You better know what you are doing here.
2441
wdenk4a5c8a72003-03-06 00:02:04 +00002442 Note: overly (ab)use of the default environment is
2443 discouraged. Make sure to check other ways to preset
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002444 the environment like the "source" command or the
wdenk4a5c8a72003-03-06 00:02:04 +00002445 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002446
Stephen Warren1465d5f2012-05-22 09:21:54 +00002447 CONFIG_ENV_VARS_UBOOT_CONFIG
2448
2449 Define this in order to add variables describing the
2450 U-Boot build configuration to the default environment.
2451 These will be named arch, cpu, board, vendor, and soc.
2452
2453 Enabling this option will cause the following to be defined:
2454
2455 - CONFIG_SYS_ARCH
2456 - CONFIG_SYS_CPU
2457 - CONFIG_SYS_BOARD
2458 - CONFIG_SYS_VENDOR
2459 - CONFIG_SYS_SOC
2460
Tom Rini4c8cc9b2012-10-24 07:28:16 +00002461 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2462
2463 Define this in order to add variables describing certain
2464 run-time determined information about the hardware to the
2465 environment. These will be named board_name, board_rev.
2466
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002467 CONFIG_DELAY_ENVIRONMENT
2468
2469 Normally the environment is loaded when the board is
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002470 initialised so that it is available to U-Boot. This inhibits
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002471 that so that the environment is not available until
2472 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2473 this is instead controlled by the value of
2474 /config/load-environment.
2475
wdenkc0aa5c52003-12-06 19:49:23 +00002476- DataFlash Support:
wdenk381669a2003-06-16 23:50:08 +00002477 CONFIG_HAS_DATAFLASH
2478
wdenk57b2d802003-06-27 21:31:46 +00002479 Defining this option enables DataFlash features and
2480 allows to read/write in Dataflash via the standard
2481 commands cp, md...
wdenk381669a2003-06-16 23:50:08 +00002482
Eric Nelson97f5f8f2012-01-31 10:52:08 -07002483- Serial Flash support
2484 CONFIG_CMD_SF
2485
2486 Defining this option enables SPI flash commands
2487 'sf probe/read/write/erase/update'.
2488
2489 Usage requires an initial 'probe' to define the serial
2490 flash parameters, followed by read/write/erase/update
2491 commands.
2492
2493 The following defaults may be provided by the platform
2494 to handle the common case when only a single serial
2495 flash is present on the system.
2496
2497 CONFIG_SF_DEFAULT_BUS Bus identifier
2498 CONFIG_SF_DEFAULT_CS Chip-select
2499 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2500 CONFIG_SF_DEFAULT_SPEED in Hz
2501
Simon Glass4b5545e2012-10-08 13:16:02 +00002502 CONFIG_CMD_SF_TEST
2503
2504 Define this option to include a destructive SPI flash
2505 test ('sf test').
2506
wdenkef893942004-02-23 16:11:30 +00002507- SystemACE Support:
2508 CONFIG_SYSTEMACE
2509
2510 Adding this option adds support for Xilinx SystemACE
2511 chips attached via some sort of local bus. The address
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002512 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002513 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenkef893942004-02-23 16:11:30 +00002514
2515 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002516 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenkef893942004-02-23 16:11:30 +00002517
2518 When SystemACE support is added, the "ace" device type
2519 becomes available to the fat commands, i.e. fatls.
2520
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002521- TFTP Fixed UDP Port:
2522 CONFIG_TFTP_PORT
2523
Wolfgang Denk227b5192005-09-24 23:25:46 +02002524 If this is defined, the environment variable tftpsrcp
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002525 is used to supply the TFTP UDP source port value.
Wolfgang Denk227b5192005-09-24 23:25:46 +02002526 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002527 number generator is used.
2528
Wolfgang Denk227b5192005-09-24 23:25:46 +02002529 Also, the environment variable tftpdstp is used to supply
2530 the TFTP UDP destination port value. If tftpdstp isn't
2531 defined, the normal port 69 is used.
2532
2533 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002534 blindly start the TFTP transfer using the pre-configured
2535 target IP address and UDP port. This has the effect of
2536 "punching through" the (Windows XP) firewall, allowing
2537 the remainder of the TFTP transfer to proceed normally.
2538 A better solution is to properly configure the firewall,
2539 but sometimes that is not allowed.
2540
Heiko Schocher443ca402014-01-25 07:27:13 +01002541- bootcount support:
2542 CONFIG_BOOTCOUNT_LIMIT
2543
2544 This enables the bootcounter support, see:
2545 http://www.denx.de/wiki/DULG/UBootBootCountLimit
2546
2547 CONFIG_AT91SAM9XE
2548 enable special bootcounter support on at91sam9xe based boards.
Heiko Schocher443ca402014-01-25 07:27:13 +01002549 CONFIG_SOC_DA8XX
2550 enable special bootcounter support on da850 based boards.
2551 CONFIG_BOOTCOUNT_RAM
2552 enable support for the bootcounter in RAM
2553 CONFIG_BOOTCOUNT_I2C
2554 enable support for the bootcounter on an i2c (like RTC) device.
2555 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
2556 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
2557 the bootcounter.
2558 CONFIG_BOOTCOUNT_ALEN = address len
Simon Glass35191a32013-06-13 15:10:02 -07002559
wdenkc0aa5c52003-12-06 19:49:23 +00002560- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002561 CONFIG_SHOW_BOOT_PROGRESS
2562
wdenk4a5c8a72003-03-06 00:02:04 +00002563 Defining this option allows to add some board-
2564 specific code (calling a user-provided function
2565 "show_boot_progress(int)") that enables you to show
2566 the system's boot progress on some display (for
2567 example, some LED's) on your board. At the moment,
2568 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002569
Simon Glass0fa36a42012-09-28 08:56:37 +00002570
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002571Legacy uImage format:
2572
wdenkc6097192002-11-03 00:24:07 +00002573 Arg Where When
2574 1 common/cmd_bootm.c before attempting to boot an image
wdenk544e9732004-02-06 23:19:44 +00002575 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002576 2 common/cmd_bootm.c Image header has correct magic number
wdenk544e9732004-02-06 23:19:44 +00002577 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002578 3 common/cmd_bootm.c Image header has correct checksum
wdenk544e9732004-02-06 23:19:44 +00002579 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002580 4 common/cmd_bootm.c Image data has correct checksum
2581 -4 common/cmd_bootm.c Image is for unsupported architecture
2582 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002583 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002584 6 common/cmd_bootm.c Image Type check OK
2585 -6 common/cmd_bootm.c gunzip uncompression error
2586 -7 common/cmd_bootm.c Unimplemented compression type
2587 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002588 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002589 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002590
2591 9 common/image.c Start initial ramdisk verification
2592 -10 common/image.c Ramdisk header has bad magic number
2593 -11 common/image.c Ramdisk header has bad checksum
2594 10 common/image.c Ramdisk header is OK
2595 -12 common/image.c Ramdisk data has bad checksum
2596 11 common/image.c Ramdisk data has correct checksum
2597 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002598 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002599 13 common/image.c Start multifile image verification
2600 14 common/image.c No initial ramdisk, no multifile, continue.
2601
Wolfgang Denk092ae952011-10-26 10:21:21 +00002602 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002603
Stefan Roese88fbf932010-04-15 16:07:28 +02002604 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenkd729d302004-02-27 00:07:27 +00002605 -31 post/post.c POST test failed, detected by post_output_backlog()
2606 -32 post/post.c POST test failed, detected by post_run_single()
wdenke97d3d92004-02-23 22:22:28 +00002607
Heiko Schocher633e03a2007-06-22 19:11:54 +02002608 34 common/cmd_doc.c before loading a Image from a DOC device
2609 -35 common/cmd_doc.c Bad usage of "doc" command
2610 35 common/cmd_doc.c correct usage of "doc" command
2611 -36 common/cmd_doc.c No boot device
2612 36 common/cmd_doc.c correct boot device
2613 -37 common/cmd_doc.c Unknown Chip ID on boot device
2614 37 common/cmd_doc.c correct chip ID found, device available
2615 -38 common/cmd_doc.c Read Error on boot device
2616 38 common/cmd_doc.c reading Image header from DOC device OK
2617 -39 common/cmd_doc.c Image header has bad magic number
2618 39 common/cmd_doc.c Image header has correct magic number
2619 -40 common/cmd_doc.c Error reading Image from DOC device
2620 40 common/cmd_doc.c Image header has correct magic number
2621 41 common/cmd_ide.c before loading a Image from a IDE device
2622 -42 common/cmd_ide.c Bad usage of "ide" command
2623 42 common/cmd_ide.c correct usage of "ide" command
2624 -43 common/cmd_ide.c No boot device
2625 43 common/cmd_ide.c boot device found
2626 -44 common/cmd_ide.c Device not available
2627 44 common/cmd_ide.c Device available
2628 -45 common/cmd_ide.c wrong partition selected
2629 45 common/cmd_ide.c partition selected
2630 -46 common/cmd_ide.c Unknown partition table
2631 46 common/cmd_ide.c valid partition table found
2632 -47 common/cmd_ide.c Invalid partition type
2633 47 common/cmd_ide.c correct partition type
2634 -48 common/cmd_ide.c Error reading Image Header on boot device
2635 48 common/cmd_ide.c reading Image Header from IDE device OK
2636 -49 common/cmd_ide.c Image header has bad magic number
2637 49 common/cmd_ide.c Image header has correct magic number
2638 -50 common/cmd_ide.c Image header has bad checksum
2639 50 common/cmd_ide.c Image header has correct checksum
2640 -51 common/cmd_ide.c Error reading Image from IDE device
2641 51 common/cmd_ide.c reading Image from IDE device OK
2642 52 common/cmd_nand.c before loading a Image from a NAND device
2643 -53 common/cmd_nand.c Bad usage of "nand" command
2644 53 common/cmd_nand.c correct usage of "nand" command
2645 -54 common/cmd_nand.c No boot device
2646 54 common/cmd_nand.c boot device found
2647 -55 common/cmd_nand.c Unknown Chip ID on boot device
2648 55 common/cmd_nand.c correct chip ID found, device available
2649 -56 common/cmd_nand.c Error reading Image Header on boot device
2650 56 common/cmd_nand.c reading Image Header from NAND device OK
2651 -57 common/cmd_nand.c Image header has bad magic number
2652 57 common/cmd_nand.c Image header has correct magic number
2653 -58 common/cmd_nand.c Error reading Image from NAND device
2654 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002655
Heiko Schocher633e03a2007-06-22 19:11:54 +02002656 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002657
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002658 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher633e03a2007-06-22 19:11:54 +02002659 -64 net/eth.c no Ethernet found.
2660 65 net/eth.c Ethernet found.
wdenkc6097192002-11-03 00:24:07 +00002661
Heiko Schocher633e03a2007-06-22 19:11:54 +02002662 -80 common/cmd_net.c usage wrong
Joe Hershbergerc80b41b02015-04-08 01:41:21 -05002663 80 common/cmd_net.c before calling net_loop()
2664 -81 common/cmd_net.c some error in net_loop() occurred
2665 81 common/cmd_net.c net_loop() back without error
Heiko Schocher633e03a2007-06-22 19:11:54 +02002666 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2667 82 common/cmd_net.c trying automatic boot
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002668 83 common/cmd_net.c running "source" command
2669 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher633e03a2007-06-22 19:11:54 +02002670 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002671
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002672FIT uImage format:
2673
2674 Arg Where When
2675 100 common/cmd_bootm.c Kernel FIT Image has correct format
2676 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2677 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2678 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2679 102 common/cmd_bootm.c Kernel unit name specified
2680 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +01002681 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002682 104 common/cmd_bootm.c Got kernel subimage node offset
2683 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2684 105 common/cmd_bootm.c Kernel subimage hash verification OK
2685 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2686 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002687 -106 common/cmd_bootm.c Kernel subimage has wrong type
2688 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002689 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2690 108 common/cmd_bootm.c Got kernel subimage data/size
2691 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2692 -109 common/cmd_bootm.c Can't get kernel subimage type
2693 -110 common/cmd_bootm.c Can't get kernel subimage comp
2694 -111 common/cmd_bootm.c Can't get kernel subimage os
2695 -112 common/cmd_bootm.c Can't get kernel subimage load address
2696 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2697
2698 120 common/image.c Start initial ramdisk verification
2699 -120 common/image.c Ramdisk FIT image has incorrect format
2700 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002701 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002702 -122 common/image.c Can't get configuration for ramdisk subimage
2703 123 common/image.c Ramdisk unit name specified
2704 -124 common/image.c Can't get ramdisk subimage node offset
2705 125 common/image.c Got ramdisk subimage node offset
2706 -125 common/image.c Ramdisk subimage hash verification failed
2707 126 common/image.c Ramdisk subimage hash verification OK
2708 -126 common/image.c Ramdisk subimage for unsupported architecture
2709 127 common/image.c Architecture check OK
2710 -127 common/image.c Can't get ramdisk subimage data/size
2711 128 common/image.c Got ramdisk subimage data/size
2712 129 common/image.c Can't get ramdisk load address
2713 -129 common/image.c Got ramdisk load address
2714
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002715 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002716 131 common/cmd_doc.c FIT image format OK
2717
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002718 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002719 141 common/cmd_ide.c FIT image format OK
2720
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002721 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002722 151 common/cmd_nand.c FIT image format OK
2723
Heiko Schocher515eb122014-05-28 11:33:33 +02002724- legacy image format:
2725 CONFIG_IMAGE_FORMAT_LEGACY
2726 enables the legacy image format support in U-Boot.
2727
2728 Default:
2729 enabled if CONFIG_FIT_SIGNATURE is not defined.
2730
2731 CONFIG_DISABLE_IMAGE_LEGACY
2732 disable the legacy image format
2733
2734 This define is introduced, as the legacy image format is
2735 enabled per default for backward compatibility.
2736
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002737- Standalone program support:
2738 CONFIG_STANDALONE_LOAD_ADDR
2739
Wolfgang Denk23f78482011-10-09 21:06:34 +02002740 This option defines a board specific value for the
2741 address where standalone program gets loaded, thus
2742 overwriting the architecture dependent default
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002743 settings.
2744
2745- Frame Buffer Address:
2746 CONFIG_FB_ADDR
2747
2748 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denka71eb8e2013-01-03 00:43:59 +00002749 address for frame buffer. This is typically the case
2750 when using a graphics controller has separate video
2751 memory. U-Boot will then place the frame buffer at
2752 the given address instead of dynamically reserving it
2753 in system RAM by calling lcd_setmem(), which grabs
2754 the memory for the frame buffer depending on the
2755 configured panel size.
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002756
2757 Please see board_init_f function.
2758
Detlev Zundel0ecb6112009-12-01 17:16:19 +01002759- Automatic software updates via TFTP server
2760 CONFIG_UPDATE_TFTP
2761 CONFIG_UPDATE_TFTP_CNT_MAX
2762 CONFIG_UPDATE_TFTP_MSEC_MAX
2763
2764 These options enable and control the auto-update feature;
2765 for a more detailed description refer to doc/README.update.
2766
2767- MTD Support (mtdparts command, UBI support)
2768 CONFIG_MTD_DEVICE
2769
2770 Adds the MTD device infrastructure from the Linux kernel.
2771 Needed for mtdparts command support.
2772
2773 CONFIG_MTD_PARTITIONS
2774
2775 Adds the MTD partitioning infrastructure from the Linux
2776 kernel. Needed for UBI support.
2777
Joe Hershberger7d80fc12013-04-08 10:32:48 +00002778- UBI support
Joe Hershberger47550fc2013-04-08 10:32:49 +00002779 CONFIG_UBI_SILENCE_MSG
2780
2781 Make the verbose messages from UBI stop printing. This leaves
2782 warnings and errors enabled.
2783
Heiko Schocherf5895d12014-06-24 10:10:04 +02002784
2785 CONFIG_MTD_UBI_WL_THRESHOLD
2786 This parameter defines the maximum difference between the highest
2787 erase counter value and the lowest erase counter value of eraseblocks
2788 of UBI devices. When this threshold is exceeded, UBI starts performing
2789 wear leveling by means of moving data from eraseblock with low erase
2790 counter to eraseblocks with high erase counter.
2791
2792 The default value should be OK for SLC NAND flashes, NOR flashes and
2793 other flashes which have eraseblock life-cycle 100000 or more.
2794 However, in case of MLC NAND flashes which typically have eraseblock
2795 life-cycle less than 10000, the threshold should be lessened (e.g.,
2796 to 128 or 256, although it does not have to be power of 2).
2797
2798 default: 4096
Simon Glass6c0be912014-10-23 18:58:54 -06002799
Heiko Schocherf5895d12014-06-24 10:10:04 +02002800 CONFIG_MTD_UBI_BEB_LIMIT
2801 This option specifies the maximum bad physical eraseblocks UBI
2802 expects on the MTD device (per 1024 eraseblocks). If the
2803 underlying flash does not admit of bad eraseblocks (e.g. NOR
2804 flash), this value is ignored.
2805
2806 NAND datasheets often specify the minimum and maximum NVM
2807 (Number of Valid Blocks) for the flashes' endurance lifetime.
2808 The maximum expected bad eraseblocks per 1024 eraseblocks
2809 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
2810 which gives 20 for most NANDs (MaxNVB is basically the total
2811 count of eraseblocks on the chip).
2812
2813 To put it differently, if this value is 20, UBI will try to
2814 reserve about 1.9% of physical eraseblocks for bad blocks
2815 handling. And that will be 1.9% of eraseblocks on the entire
2816 NAND chip, not just the MTD partition UBI attaches. This means
2817 that if you have, say, a NAND flash chip admits maximum 40 bad
2818 eraseblocks, and it is split on two MTD partitions of the same
2819 size, UBI will reserve 40 eraseblocks when attaching a
2820 partition.
2821
2822 default: 20
2823
2824 CONFIG_MTD_UBI_FASTMAP
2825 Fastmap is a mechanism which allows attaching an UBI device
2826 in nearly constant time. Instead of scanning the whole MTD device it
2827 only has to locate a checkpoint (called fastmap) on the device.
2828 The on-flash fastmap contains all information needed to attach
2829 the device. Using fastmap makes only sense on large devices where
2830 attaching by scanning takes long. UBI will not automatically install
2831 a fastmap on old images, but you can set the UBI parameter
2832 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
2833 that fastmap-enabled images are still usable with UBI implementations
2834 without fastmap support. On typical flash devices the whole fastmap
2835 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
2836
2837 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
2838 Set this parameter to enable fastmap automatically on images
2839 without a fastmap.
2840 default: 0
2841
Heiko Schocher94b66de2015-10-22 06:19:21 +02002842 CONFIG_MTD_UBI_FM_DEBUG
2843 Enable UBI fastmap debug
2844 default: 0
2845
Joe Hershberger7d80fc12013-04-08 10:32:48 +00002846- UBIFS support
Joe Hershberger47550fc2013-04-08 10:32:49 +00002847 CONFIG_UBIFS_SILENCE_MSG
2848
2849 Make the verbose messages from UBIFS stop printing. This leaves
2850 warnings and errors enabled.
2851
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002852- SPL framework
Wolfgang Denk825223d2011-09-11 21:24:09 +02002853 CONFIG_SPL
2854 Enable building of SPL globally.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002855
Tom Rini36853852012-02-14 07:29:40 +00002856 CONFIG_SPL_LDSCRIPT
2857 LDSCRIPT for linking the SPL binary.
2858
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002859 CONFIG_SPL_MAX_FOOTPRINT
2860 Maximum size in memory allocated to the SPL, BSS included.
2861 When defined, the linker checks that the actual memory
2862 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00002863 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002864 must not be both defined at the same time.
2865
Tom Rini36853852012-02-14 07:29:40 +00002866 CONFIG_SPL_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002867 Maximum size of the SPL image (text, data, rodata, and
2868 linker lists sections), BSS excluded.
2869 When defined, the linker checks that the actual size does
2870 not exceed it.
Tom Rini36853852012-02-14 07:29:40 +00002871
Wolfgang Denk825223d2011-09-11 21:24:09 +02002872 CONFIG_SPL_TEXT_BASE
2873 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002874
Scott Woodc4f0d002012-09-20 19:05:12 -05002875 CONFIG_SPL_RELOC_TEXT_BASE
2876 Address to relocate to. If unspecified, this is equal to
2877 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
2878
Tom Rini36853852012-02-14 07:29:40 +00002879 CONFIG_SPL_BSS_START_ADDR
2880 Link address for the BSS within the SPL binary.
2881
2882 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002883 Maximum size in memory allocated to the SPL BSS.
2884 When defined, the linker checks that the actual memory used
2885 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00002886 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002887 must not be both defined at the same time.
Tom Rini36853852012-02-14 07:29:40 +00002888
2889 CONFIG_SPL_STACK
2890 Adress of the start of the stack SPL will use
2891
Albert ARIBAUD \(3ADEV\)287b0942015-03-31 11:40:50 +02002892 CONFIG_SPL_PANIC_ON_RAW_IMAGE
2893 When defined, SPL will panic() if the image it has
2894 loaded does not have a signature.
2895 Defining this is useful when code which loads images
2896 in SPL cannot guarantee that absolutely all read errors
2897 will be caught.
2898 An example is the LPC32XX MLC NAND driver, which will
2899 consider that a completely unreadable NAND block is bad,
2900 and thus should be skipped silently.
2901
Scott Woodc4f0d002012-09-20 19:05:12 -05002902 CONFIG_SPL_RELOC_STACK
2903 Adress of the start of the stack SPL will use after
2904 relocation. If unspecified, this is equal to
2905 CONFIG_SPL_STACK.
2906
Tom Rini36853852012-02-14 07:29:40 +00002907 CONFIG_SYS_SPL_MALLOC_START
2908 Starting address of the malloc pool used in SPL.
Fabio Estevam38e1a972015-11-12 12:30:19 -02002909 When this option is set the full malloc is used in SPL and
2910 it is set up by spl_init() and before that, the simple malloc()
2911 can be used if CONFIG_SYS_MALLOC_F is defined.
Tom Rini36853852012-02-14 07:29:40 +00002912
2913 CONFIG_SYS_SPL_MALLOC_SIZE
2914 The size of the malloc pool used in SPL.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002915
Tom Rini28591df2012-08-13 12:03:19 -07002916 CONFIG_SPL_FRAMEWORK
2917 Enable the SPL framework under common/. This framework
2918 supports MMC, NAND and YMODEM loading of U-Boot and NAND
2919 NAND loading of the Linux Kernel.
2920
Tom Rinic2b76002014-03-28 12:03:39 -04002921 CONFIG_SPL_OS_BOOT
2922 Enable booting directly to an OS from SPL.
2923 See also: doc/README.falcon
2924
Tom Rinife3b0c72012-08-13 11:37:56 -07002925 CONFIG_SPL_DISPLAY_PRINT
2926 For ARM, enable an optional function to print more information
2927 about the running system.
2928
Scott Wood7c810902012-09-20 16:35:21 -05002929 CONFIG_SPL_INIT_MINIMAL
2930 Arch init code should be built for a very small image
2931
Paul Kocialkowski17675c82014-11-08 23:14:56 +01002932 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
2933 Partition on the MMC to load U-Boot from when the MMC is being
2934 used in raw mode
2935
Peter Korsgaard01b542f2013-05-13 08:36:29 +00002936 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
2937 Sector to load kernel uImage from when MMC is being
2938 used in raw mode (for Falcon mode)
2939
2940 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
2941 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
2942 Sector and number of sectors to load kernel argument
2943 parameters from when MMC is being used in raw mode
2944 (for falcon mode)
2945
Paul Kocialkowski341e8cd2014-11-08 23:14:55 +01002946 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
2947 Partition on the MMC to load U-Boot from when the MMC is being
2948 used in fs mode
2949
Guillaume GARDET5065b712014-10-15 17:53:13 +02002950 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
2951 Filename to read to load U-Boot when reading from filesystem
2952
2953 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00002954 Filename to read to load kernel uImage when reading
Guillaume GARDET5065b712014-10-15 17:53:13 +02002955 from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00002956
Guillaume GARDET5065b712014-10-15 17:53:13 +02002957 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00002958 Filename to read to load kernel argument parameters
Guillaume GARDET5065b712014-10-15 17:53:13 +02002959 when reading from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00002960
Scott Wood2b36fbb2012-12-06 13:33:17 +00002961 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
2962 Set this for NAND SPL on PPC mpc83xx targets, so that
2963 start.S waits for the rest of the SPL to load before
2964 continuing (the hardware starts execution after just
2965 loading the first page rather than the full 4K).
2966
Prabhakar Kushwaha6e2b9a32014-04-08 19:12:31 +05302967 CONFIG_SPL_SKIP_RELOCATE
2968 Avoid SPL relocation
2969
Scott Woodc352a0c2012-09-20 19:09:07 -05002970 CONFIG_SPL_NAND_BASE
2971 Include nand_base.c in the SPL. Requires
2972 CONFIG_SPL_NAND_DRIVERS.
2973
2974 CONFIG_SPL_NAND_DRIVERS
2975 SPL uses normal NAND drivers, not minimal drivers.
2976
2977 CONFIG_SPL_NAND_ECC
2978 Include standard software ECC in the SPL
2979
Tom Rini36853852012-02-14 07:29:40 +00002980 CONFIG_SPL_NAND_SIMPLE
Scott Wood36c440e2012-09-21 18:35:27 -05002981 Support for NAND boot using simple NAND drivers that
2982 expose the cmd_ctrl() interface.
Tom Rini36853852012-02-14 07:29:40 +00002983
Thomas Gleixner820d24d2016-07-12 20:28:12 +02002984 CONFIG_SPL_UBI
2985 Support for a lightweight UBI (fastmap) scanner and
2986 loader
2987
Heiko Schochercf000272014-10-31 08:31:00 +01002988 CONFIG_SPL_NAND_RAW_ONLY
2989 Support to boot only raw u-boot.bin images. Use this only
2990 if you need to save space.
2991
Ying Zhangdfb2b152013-08-16 15:16:12 +08002992 CONFIG_SPL_COMMON_INIT_DDR
2993 Set for common ddr init with serial presence detect in
2994 SPL binary.
2995
Tom Rini36853852012-02-14 07:29:40 +00002996 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
2997 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
2998 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
2999 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3000 CONFIG_SYS_NAND_ECCBYTES
3001 Defines the size and behavior of the NAND that SPL uses
Scott Wood36c440e2012-09-21 18:35:27 -05003002 to read U-Boot
Tom Rini36853852012-02-14 07:29:40 +00003003
Prabhakar Kushwahaafffcb02013-12-11 12:42:11 +05303004 CONFIG_SPL_NAND_BOOT
3005 Add support NAND boot
3006
Tom Rini36853852012-02-14 07:29:40 +00003007 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood36c440e2012-09-21 18:35:27 -05003008 Location in NAND to read U-Boot from
3009
3010 CONFIG_SYS_NAND_U_BOOT_DST
3011 Location in memory to load U-Boot to
3012
3013 CONFIG_SYS_NAND_U_BOOT_SIZE
3014 Size of image to load
Tom Rini36853852012-02-14 07:29:40 +00003015
3016 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood36c440e2012-09-21 18:35:27 -05003017 Entry point in loaded image to jump to
Tom Rini36853852012-02-14 07:29:40 +00003018
3019 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3020 Define this if you need to first read the OOB and then the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003021 data. This is used, for example, on davinci platforms.
Tom Rini36853852012-02-14 07:29:40 +00003022
3023 CONFIG_SPL_OMAP3_ID_NAND
3024 Support for an OMAP3-specific set of functions to return the
3025 ID and MFR of the first attached NAND chip, if present.
3026
Pavel Machekde997252012-08-30 22:42:11 +02003027 CONFIG_SPL_RAM_DEVICE
3028 Support for running image already present in ram, in SPL binary
3029
Scott Woodeb7bd972012-12-06 13:33:16 +00003030 CONFIG_SPL_PAD_TO
Benoît Thébaudeauf0180722013-04-11 09:35:49 +00003031 Image offset to which the SPL should be padded before appending
3032 the SPL payload. By default, this is defined as
3033 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3034 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3035 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Woodeb7bd972012-12-06 13:33:16 +00003036
Scott Woodf147eb72012-09-21 16:27:32 -05003037 CONFIG_SPL_TARGET
3038 Final target image containing SPL and payload. Some SPLs
3039 use an arch-specific makefile fragment instead, for
3040 example if more than one image needs to be produced.
3041
Simon Glass82d94532013-05-08 08:05:59 +00003042 CONFIG_FIT_SPL_PRINT
3043 Printing information about a FIT image adds quite a bit of
3044 code to SPL. So this is normally disabled in SPL. Use this
3045 option to re-enable it. This will affect the output of the
3046 bootm command when booting a FIT image.
3047
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003048- TPL framework
3049 CONFIG_TPL
3050 Enable building of TPL globally.
3051
3052 CONFIG_TPL_PAD_TO
3053 Image offset to which the TPL should be padded before appending
3054 the TPL payload. By default, this is defined as
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02003055 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3056 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3057 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003058
wdenkc0aa5c52003-12-06 19:49:23 +00003059- Interrupt support (PPC):
3060
wdenk1ebf41e2004-01-02 14:00:00 +00003061 There are common interrupt_init() and timer_interrupt()
3062 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003063 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00003064 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003065 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00003066 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003067 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00003068 specific handling. If board has watchdog / status_led
3069 / other_activity_monitor it works automatically from
3070 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00003071
wdenkc6097192002-11-03 00:24:07 +00003072
Helmut Raigerd5a184b2011-10-20 04:19:47 +00003073Board initialization settings:
3074------------------------------
3075
3076During Initialization u-boot calls a number of board specific functions
3077to allow the preparation of board specific prerequisites, e.g. pin setup
3078before drivers are initialized. To enable these callbacks the
3079following configuration macros have to be defined. Currently this is
3080architecture specific, so please check arch/your_architecture/lib/board.c
3081typically in board_init_f() and board_init_r().
3082
3083- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3084- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3085- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3086- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003087
wdenkc6097192002-11-03 00:24:07 +00003088Configuration Settings:
3089-----------------------
3090
York Sun6c480012014-02-26 17:03:19 -08003091- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3092 Optionally it can be defined to support 64-bit memory commands.
3093
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003094- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003095 undefine this when you're short of memory.
3096
Peter Tyserdfb72b82009-01-27 18:03:12 -06003097- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3098 width of the commands listed in the 'help' command output.
3099
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003100- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003101 prompt for user input.
3102
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003103- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003104
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003105- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003106
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003107- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003108
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003109- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003110 the application (usually a Linux kernel) when it is
3111 booted
3112
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003113- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003114 List of legal baudrate settings for this board.
3115
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003116- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003117 Begin and End addresses of the area used by the
3118 simple memory test.
3119
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003120- CONFIG_SYS_ALT_MEMTEST:
wdenk57b2d802003-06-27 21:31:46 +00003121 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003122
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003123- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5958f4a2003-09-18 09:21:33 +00003124 Scratch address used by the alternate memory test
3125 You only need to set this if address zero isn't writeable
3126
York Sun5d286cd2015-12-04 11:57:07 -08003127- CONFIG_SYS_MEM_RESERVE_SECURE
York Sun1ef95cc2016-06-24 16:46:18 -07003128 Only implemented for ARMv8 for now.
York Sun5d286cd2015-12-04 11:57:07 -08003129 If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
3130 is substracted from total RAM and won't be reported to OS.
3131 This memory can be used as secure memory. A variable
York Sun1ef95cc2016-06-24 16:46:18 -07003132 gd->arch.secure_ram is used to track the location. In systems
York Sun5d286cd2015-12-04 11:57:07 -08003133 the RAM base is not zero, or RAM is divided into banks,
3134 this variable needs to be recalcuated to get the address.
3135
York Sun50739372015-12-07 11:05:29 -08003136- CONFIG_SYS_MEM_TOP_HIDE:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003137 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01003138 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003139 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01003140 fixing up gd->ram_size the Linux kernel should gets passed
3141 the now "corrected" memory size and won't touch it either.
3142 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01003143 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01003144 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01003145 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01003146
3147 This option can be used as a workaround for the 440EPx/GRx
3148 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3149 be touched.
3150
3151 WARNING: Please make sure that this value is a multiple of
3152 the Linux page size (normally 4k). If this is not the case,
3153 then the end address of the Linux memory will be located at a
3154 non page size aligned address and this could cause major
3155 problems.
3156
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003157- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003158 Enable temporary baudrate change while serial download
3159
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003160- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003161 Physical start address of SDRAM. _Must_ be 0 here.
3162
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003163- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003164 Physical start address of Flash memory.
3165
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003166- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003167 Physical start address of boot monitor code (set by
3168 make config files to be same as the text base address
Wolfgang Denk0708bc62010-10-07 21:51:12 +02003169 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003170 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003171
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003172- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00003173 Size of memory reserved for monitor code, used to
3174 determine _at_compile_time_ (!) if the environment is
3175 embedded within the U-Boot image, or in a separate
3176 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003177
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003178- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003179 Size of DRAM reserved for malloc() use.
3180
Simon Glass863e4042014-07-10 22:23:28 -06003181- CONFIG_SYS_MALLOC_F_LEN
3182 Size of the malloc() pool for use before relocation. If
3183 this is defined, then a very simple malloc() implementation
3184 will become available before relocation. The address is just
3185 below the global data, and the stack is moved down to make
3186 space.
3187
3188 This feature allocates regions with increasing addresses
3189 within the region. calloc() is supported, but realloc()
3190 is not available. free() is supported but does nothing.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003191 The memory will be freed (or in fact just forgotten) when
Simon Glass863e4042014-07-10 22:23:28 -06003192 U-Boot relocates itself.
3193
Simon Glass9fa901b2014-11-10 17:16:54 -07003194- CONFIG_SYS_MALLOC_SIMPLE
3195 Provides a simple and small malloc() and calloc() for those
3196 boards which do not use the full malloc in SPL (which is
3197 enabled with CONFIG_SYS_SPL_MALLOC_START).
3198
Thierry Redingc97d9742014-12-09 22:25:22 -07003199- CONFIG_SYS_NONCACHED_MEMORY:
3200 Size of non-cached memory area. This area of memory will be
3201 typically located right below the malloc() area and mapped
3202 uncached in the MMU. This is useful for drivers that would
3203 otherwise require a lot of explicit cache maintenance. For
3204 some drivers it's also impossible to properly maintain the
3205 cache. For example if the regions that need to be flushed
3206 are not a multiple of the cache-line size, *and* padding
3207 cannot be allocated between the regions to align them (i.e.
3208 if the HW requires a contiguous array of regions, and the
3209 size of each region is not cache-aligned), then a flush of
3210 one region may result in overwriting data that hardware has
3211 written to another region in the same cache-line. This can
3212 happen for example in network drivers where descriptors for
3213 buffers are typically smaller than the CPU cache-line (e.g.
3214 16 bytes vs. 32 or 64 bytes).
3215
3216 Non-cached memory is only supported on 32-bit ARM at present.
3217
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003218- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01003219 Normally compressed uImages are limited to an
3220 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003221 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01003222 to adjust this setting to your needs.
3223
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003224- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003225 Maximum size of memory mapped by the startup code of
3226 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003227 the Linux kernel (bd_info, boot arguments, FDT blob if
3228 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003229 environment variable is defined and non-zero. In such case
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003230 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denk092ae952011-10-26 10:21:21 +00003231 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likely26396382011-03-28 09:58:43 +00003232 variable "bootm_mapsize" will override the value of
3233 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3234 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003235
John Rigbyeea8e692010-10-13 13:57:35 -06003236- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3237 Enable initrd_high functionality. If defined then the
3238 initrd_high feature is enabled and the bootm ramdisk subcommand
3239 is enabled.
3240
3241- CONFIG_SYS_BOOT_GET_CMDLINE:
3242 Enables allocating and saving kernel cmdline in space between
3243 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3244
3245- CONFIG_SYS_BOOT_GET_KBD:
3246 Enables allocating and saving a kernel copy of the bd_info in
3247 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3248
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003249- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003250 Max number of Flash memory banks
3251
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003252- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003253 Max number of sectors on a Flash chip
3254
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003255- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003256 Timeout for Flash erase operations (in ms)
3257
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003258- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003259 Timeout for Flash write operations (in ms)
3260
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003261- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003262 Timeout for Flash set sector lock bit operation (in ms)
3263
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003264- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003265 Timeout for Flash clear lock bits operation (in ms)
3266
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003267- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00003268 If defined, hardware flash sectors protection is used
3269 instead of U-Boot software protection.
3270
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003271- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003272
3273 Enable TFTP transfers directly to flash memory;
3274 without this option such a download has to be
3275 performed in two steps: (1) download to RAM, and (2)
3276 copy from RAM to flash.
3277
3278 The two-step approach is usually more reliable, since
3279 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003280 the flash, but in some situations (when system RAM is
3281 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003282 downloaded image) this option may be very useful.
3283
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003284- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00003285 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00003286 common flash structure for storing flash geometry.
3287
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02003288- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00003289 This option also enables the building of the cfi_flash driver
3290 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003291
Piotr Ziecik3e939e92008-11-17 15:57:58 +01003292- CONFIG_FLASH_CFI_MTD
3293 This option enables the building of the cfi_mtd driver
3294 in the drivers directory. The driver exports CFI flash
3295 to the MTD layer.
3296
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003297- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02003298 Use buffered writes to flash.
3299
3300- CONFIG_FLASH_SPANSION_S29WS_N
3301 s29ws-n MirrorBit flash has non-standard addresses for buffered
3302 write commands.
3303
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003304- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01003305 If this option is defined, the common CFI flash doesn't
3306 print it's warning upon not recognized FLASH banks. This
3307 is useful, if some of the configured banks are only
3308 optionally available.
3309
Jerry Van Barenaae73572008-03-08 13:48:01 -05003310- CONFIG_FLASH_SHOW_PROGRESS
3311 If defined (must be an integer), print out countdown
3312 digits and dots. Recommended value: 45 (9..1) for 80
3313 column displays, 15 (3..1) for 40 column displays.
3314
Stefan Roesed20cba52013-04-04 15:53:14 +02003315- CONFIG_FLASH_VERIFY
3316 If defined, the content of the flash (destination) is compared
3317 against the source after the write operation. An error message
3318 will be printed when the contents are not identical.
3319 Please note that this option is useless in nearly all cases,
3320 since such flash programming errors usually are detected earlier
3321 while unprotecting/erasing/programming. Please only enable
3322 this option if you really know what you are doing.
3323
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003324- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003325 Defines the number of Ethernet receive buffers. On some
3326 Ethernet controllers it is recommended to set this value
stroese94ef1cf2003-06-05 15:39:44 +00003327 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3328 buffers can be full shortly after enabling the interface
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003329 on high Ethernet traffic.
stroese94ef1cf2003-06-05 15:39:44 +00003330 Defaults to 4 if not defined.
3331
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003332- CONFIG_ENV_MAX_ENTRIES
3333
Wolfgang Denk1136f692010-10-27 22:48:30 +02003334 Maximum number of entries in the hash table that is used
3335 internally to store the environment settings. The default
3336 setting is supposed to be generous and should work in most
3337 cases. This setting can be used to tune behaviour; see
3338 lib/hashtable.c for details.
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003339
Joe Hershberger71497d02012-12-11 22:16:31 -06003340- CONFIG_ENV_FLAGS_LIST_DEFAULT
3341- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003342 Enable validation of the values given to environment variables when
Joe Hershberger71497d02012-12-11 22:16:31 -06003343 calling env set. Variables can be restricted to only decimal,
3344 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3345 the variables can also be restricted to IP address or MAC address.
3346
3347 The format of the list is:
3348 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003349 access_attribute = [a|r|o|c]
3350 attributes = type_attribute[access_attribute]
Joe Hershberger71497d02012-12-11 22:16:31 -06003351 entry = variable_name[:attributes]
3352 list = entry[,list]
3353
3354 The type attributes are:
3355 s - String (default)
3356 d - Decimal
3357 x - Hexadecimal
3358 b - Boolean ([1yYtT|0nNfF])
3359 i - IP address
3360 m - MAC address
3361
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003362 The access attributes are:
3363 a - Any (default)
3364 r - Read-only
3365 o - Write-once
3366 c - Change-default
3367
Joe Hershberger71497d02012-12-11 22:16:31 -06003368 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3369 Define this to a list (string) to define the ".flags"
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003370 environment variable in the default or embedded environment.
Joe Hershberger71497d02012-12-11 22:16:31 -06003371
3372 - CONFIG_ENV_FLAGS_LIST_STATIC
3373 Define this to a list (string) to define validation that
3374 should be done if an entry is not found in the ".flags"
3375 environment variable. To override a setting in the static
3376 list, simply add an entry for the same variable name to the
3377 ".flags" variable.
3378
Joe Hershberger6db9fd42015-05-20 14:27:20 -05003379 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
3380 regular expression. This allows multiple variables to define the same
3381 flags without explicitly listing them for each variable.
3382
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003383- CONFIG_ENV_ACCESS_IGNORE_FORCE
3384 If defined, don't allow the -f switch to env set override variable
3385 access flags.
3386
Gabe Black3687fe42014-10-15 04:38:30 -06003387- CONFIG_USE_STDINT
3388 If stdint.h is available with your toolchain you can define this
3389 option to enable it. You can provide option 'USE_STDINT=1' when
3390 building U-Boot to enable this.
3391
wdenkc6097192002-11-03 00:24:07 +00003392The following definitions that deal with the placement and management
3393of environment data (variable area); in general, we support the
3394following configurations:
3395
Mike Frysinger63b8f122011-07-08 10:44:25 +00003396- CONFIG_BUILD_ENVCRC:
3397
3398 Builds up envcrc with the target environment so that external utils
3399 may easily extract it and embed it in final U-Boot images.
3400
wdenkc6097192002-11-03 00:24:07 +00003401BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003402in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003403console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00003404U-Boot will hang.
3405
3406Please note that even with NVRAM we still use a copy of the
3407environment in RAM: we could work on NVRAM directly, but we want to
3408keep settings there always unmodified except somebody uses "saveenv"
3409to save the current settings.
3410
Liu Gang85bcd732012-03-08 00:33:20 +00003411BE CAREFUL! For some special cases, the local device can not use
3412"saveenv" command. For example, the local device will get the
Liu Gang357bf5a2012-08-09 05:10:01 +00003413environment stored in a remote NOR flash by SRIO or PCIE link,
3414but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang85bcd732012-03-08 00:33:20 +00003415
Guennadi Liakhovetskifad24442009-05-18 16:07:22 +02003416- CONFIG_NAND_ENV_DST
3417
3418 Defines address in RAM to which the nand_spl code should copy the
3419 environment. If redundant environment is used, it will be copied to
3420 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3421
Bruce Adleredecc942007-11-02 13:15:42 -07003422Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00003423has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denk76af2782010-07-24 21:55:43 +02003424created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00003425until then to read environment variables.
3426
wdenk8dba0502003-03-31 16:34:49 +00003427The environment is protected by a CRC32 checksum. Before the monitor
3428is relocated into RAM, as a result of a bad CRC you will be working
3429with the compiled-in default environment - *silently*!!! [This is
3430necessary, because the first environment variable we need is the
3431"baudrate" setting for the console - if we have a bad CRC, we don't
3432have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00003433
3434Note: once the monitor has been relocated, then it will complain if
3435the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00003436use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00003437
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003438- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk9c53f402003-10-15 23:53:47 +00003439 Echo the inverted Ethernet link state to the fault LED.
wdenk49c3f672003-10-08 22:33:00 +00003440
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003441 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenk49c3f672003-10-08 22:33:00 +00003442 also needs to be defined.
3443
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003444- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00003445 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00003446
Ron Madriddfa028a2009-02-18 14:30:44 -08003447- CONFIG_NS16550_MIN_FUNCTIONS:
3448 Define this if you desire to only have use of the NS16550_init
3449 and NS16550_putc functions for the serial driver located at
3450 drivers/serial/ns16550.c. This option is useful for saving
3451 space for already greatly restricted images, including but not
3452 limited to NAND_SPL configurations.
3453
Simon Glass28a9e332012-11-30 13:01:18 +00003454- CONFIG_DISPLAY_BOARDINFO
3455 Display information about the board that U-Boot is running on
3456 when U-Boot starts up. The board function checkboard() is called
3457 to do this.
3458
Simon Glasse8822012012-11-30 13:01:19 +00003459- CONFIG_DISPLAY_BOARDINFO_LATE
3460 Similar to the previous option, but display this information
3461 later, once stdio is running and output goes to the LCD, if
3462 present.
3463
Sascha Silbe4b9c17c2013-08-11 16:40:43 +02003464- CONFIG_BOARD_SIZE_LIMIT:
3465 Maximum size of the U-Boot image. When defined, the
3466 build system checks that the actual size does not
3467 exceed it.
3468
wdenkc6097192002-11-03 00:24:07 +00003469Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00003470---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003471
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003472- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003473 Cache Line Size of the CPU.
3474
Timur Tabid8f341c2011-08-04 18:03:41 -05003475- CONFIG_SYS_CCSRBAR_DEFAULT:
3476 Default (power-on reset) physical address of CCSR on Freescale
3477 PowerPC SOCs.
3478
3479- CONFIG_SYS_CCSRBAR:
3480 Virtual address of CCSR. On a 32-bit build, this is typically
3481 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3482
Timur Tabid8f341c2011-08-04 18:03:41 -05003483- CONFIG_SYS_CCSRBAR_PHYS:
3484 Physical address of CCSR. CCSR can be relocated to a new
3485 physical address, if desired. In this case, this macro should
Wolfgang Denk092ae952011-10-26 10:21:21 +00003486 be set to that address. Otherwise, it should be set to the
Timur Tabid8f341c2011-08-04 18:03:41 -05003487 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
3488 is typically relocated on 36-bit builds. It is recommended
3489 that this macro be defined via the _HIGH and _LOW macros:
3490
3491 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3492 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3493
3494- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003495 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
3496 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabid8f341c2011-08-04 18:03:41 -05003497 used in assembly code, so it must not contain typecasts or
3498 integer size suffixes (e.g. "ULL").
3499
3500- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3501 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
3502 used in assembly code, so it must not contain typecasts or
3503 integer size suffixes (e.g. "ULL").
3504
3505- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3506 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3507 forced to a value that ensures that CCSR is not relocated.
3508
wdenk1272e232002-11-10 22:06:23 +00003509- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003510 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk1272e232002-11-10 22:06:23 +00003511
3512 the default drive number (default value 0)
3513
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003514 CONFIG_SYS_ISA_IO_STRIDE
wdenk1272e232002-11-10 22:06:23 +00003515
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003516 defines the spacing between FDC chipset registers
wdenk1272e232002-11-10 22:06:23 +00003517 (default value 1)
3518
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003519 CONFIG_SYS_ISA_IO_OFFSET
wdenk1272e232002-11-10 22:06:23 +00003520
wdenk4a5c8a72003-03-06 00:02:04 +00003521 defines the offset of register from address. It
3522 depends on which part of the data bus is connected to
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003523 the FDC chipset. (default value 0)
wdenk1272e232002-11-10 22:06:23 +00003524
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003525 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
3526 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk4a5c8a72003-03-06 00:02:04 +00003527 default value.
wdenk1272e232002-11-10 22:06:23 +00003528
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003529 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk4a5c8a72003-03-06 00:02:04 +00003530 fdc_hw_init() is called at the beginning of the FDC
3531 setup. fdc_hw_init() must be provided by the board
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003532 source code. It is used to make hardware-dependent
wdenk4a5c8a72003-03-06 00:02:04 +00003533 initializations.
wdenk1272e232002-11-10 22:06:23 +00003534
Macpaul Lind1e49942011-04-11 20:45:32 +00003535- CONFIG_IDE_AHB:
3536 Most IDE controllers were designed to be connected with PCI
3537 interface. Only few of them were designed for AHB interface.
3538 When software is doing ATA command and data transfer to
3539 IDE devices through IDE-AHB controller, some additional
3540 registers accessing to these kind of IDE-AHB controller
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003541 is required.
Macpaul Lind1e49942011-04-11 20:45:32 +00003542
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003543- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00003544 DO NOT CHANGE unless you know exactly what you're
Christophe Leroy069fa832017-07-06 10:23:22 +02003545 doing! (11-4) [MPC8xx systems only]
wdenkc6097192002-11-03 00:24:07 +00003546
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003547- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003548
wdenkeb20ad32003-09-05 23:19:14 +00003549 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00003550 initial data and stack; please note that this must be
3551 writable memory that is working WITHOUT special
3552 initialization, i. e. you CANNOT use normal RAM which
3553 will become available only after programming the
3554 memory controller and running certain initialization
3555 sequences.
3556
3557 U-Boot uses the following memory types:
Christophe Leroy069fa832017-07-06 10:23:22 +02003558 - MPC8xx: IMMR (internal memory of the CPU)
wdenkc6097192002-11-03 00:24:07 +00003559
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003560- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003561
3562 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003563 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
3564 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00003565 data is located at the end of the available space
Wolfgang Denk1c2e98e2010-10-26 13:32:32 +02003566 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Simon Glass9a6ac8b2016-10-02 18:01:06 -06003567 GENERATED_GBL_DATA_SIZE), and the initial stack is just
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003568 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
3569 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00003570
3571 Note:
3572 On the MPC824X (or other systems that use the data
3573 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003574 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00003575 point to an otherwise UNUSED address space between
3576 the top of RAM and the start of the PCI space.
3577
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003578- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00003579
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003580- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00003581 SDRAM timing
3582
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003583- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00003584 periodic timer for refresh
3585
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003586- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
3587 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
3588 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
3589 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003590 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3591
3592- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003593 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
3594 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003595 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3596
Andrew Sharp61d47ca2012-08-29 14:16:32 +00003597- CONFIG_PCI_ENUM_ONLY
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003598 Only scan through and get the devices on the buses.
Andrew Sharp61d47ca2012-08-29 14:16:32 +00003599 Don't do any setup work, presumably because someone or
3600 something has already done it, and we don't need to do it
3601 a second time. Useful for platforms that are pre-booted
3602 by coreboot or similar.
3603
Gabor Juhosb4458732013-05-30 07:06:12 +00003604- CONFIG_PCI_INDIRECT_BRIDGE:
3605 Enable support for indirect PCI bridges.
3606
Kumar Gala8975d7a2010-12-30 12:09:53 -06003607- CONFIG_SYS_SRIO:
3608 Chip has SRIO or not
3609
3610- CONFIG_SRIO1:
3611 Board has SRIO 1 port available
3612
3613- CONFIG_SRIO2:
3614 Board has SRIO 2 port available
3615
Liu Gang27afb9c2013-05-07 16:30:46 +08003616- CONFIG_SRIO_PCIE_BOOT_MASTER
3617 Board can support master function for Boot from SRIO and PCIE
3618
Kumar Gala8975d7a2010-12-30 12:09:53 -06003619- CONFIG_SYS_SRIOn_MEM_VIRT:
3620 Virtual Address of SRIO port 'n' memory region
3621
3622- CONFIG_SYS_SRIOn_MEM_PHYS:
3623 Physical Address of SRIO port 'n' memory region
3624
3625- CONFIG_SYS_SRIOn_MEM_SIZE:
3626 Size of SRIO port 'n' memory region
3627
Fabio Estevamf17e8782013-04-11 09:35:34 +00003628- CONFIG_SYS_NAND_BUSWIDTH_16BIT
3629 Defined to tell the NAND controller that the NAND chip is using
3630 a 16 bit bus.
3631 Not all NAND drivers use this symbol.
Fabio Estevam417052b2013-04-11 09:35:35 +00003632 Example of drivers that use it:
Fabio Estevamf17e8782013-04-11 09:35:34 +00003633 - drivers/mtd/nand/ndfc.c
Fabio Estevam417052b2013-04-11 09:35:35 +00003634 - drivers/mtd/nand/mxc_nand.c
Alex Watermancd6aae32011-05-19 15:08:36 -04003635
3636- CONFIG_SYS_NDFC_EBC0_CFG
3637 Sets the EBC0_CFG register for the NDFC. If not defined
3638 a default value will be used.
3639
Ben Warren45657152006-09-07 16:50:54 -04003640- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003641 Get DDR timing information from an I2C EEPROM. Common
3642 with pluggable memory modules such as SODIMMs
3643
Ben Warren45657152006-09-07 16:50:54 -04003644 SPD_EEPROM_ADDRESS
3645 I2C address of the SPD EEPROM
3646
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003647- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003648 If SPD EEPROM is on an I2C bus other than the first
3649 one, specify here. Note that the value must resolve
3650 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04003651
York Sune73cc042011-06-07 09:42:16 +08003652- CONFIG_SYS_DDR_RAW_TIMING
3653 Get DDR timing information from other than SPD. Common with
3654 soldered DDR chips onboard without SPD. DDR raw timing
3655 parameters are extracted from datasheet and hard-coded into
3656 header files or board specific files.
3657
York Sunbd495cf2011-09-16 13:21:35 -07003658- CONFIG_FSL_DDR_INTERACTIVE
3659 Enable interactive DDR debugging. See doc/README.fsl-ddr.
3660
York Sun8ced0502015-01-06 13:18:55 -08003661- CONFIG_FSL_DDR_SYNC_REFRESH
3662 Enable sync of refresh for multiple controllers.
3663
York Sunb6a35f82015-03-19 09:30:28 -07003664- CONFIG_FSL_DDR_BIST
3665 Enable built-in memory test for Freescale DDR controllers.
3666
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003667- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003668 Only for 83xx systems. If specified, then DDR should
3669 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06003670
wdenk6203e402004-04-18 10:13:26 +00003671- CONFIG_RMII
3672 Enable RMII mode for all FECs.
3673 Note that this is a global option, we can't
3674 have one FEC in standard MII mode and another in RMII mode.
3675
wdenk20c98a62004-04-23 20:32:05 +00003676- CONFIG_CRC32_VERIFY
3677 Add a verify option to the crc32 command.
3678 The syntax is:
3679
3680 => crc32 -v <address> <count> <crc32>
3681
3682 Where address/count indicate a memory area
3683 and crc32 is the correct crc32 which the
3684 area should have.
3685
wdenk64519362004-07-11 17:40:54 +00003686- CONFIG_LOOPW
3687 Add the "loopw" memory command. This only takes effect if
Simon Glass92ffdee2017-08-04 16:34:27 -06003688 the memory commands are activated globally (CONFIG_CMD_MEMORY).
wdenk64519362004-07-11 17:40:54 +00003689
stroesecc3af832004-12-16 18:46:55 +00003690- CONFIG_MX_CYCLIC
3691 Add the "mdc" and "mwc" memory commands. These are cyclic
3692 "md/mw" commands.
3693 Examples:
3694
wdenk07d7e6b2004-12-16 21:44:03 +00003695 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00003696 This command will print 4 bytes (10,11,12,13) each 500 ms.
3697
wdenk07d7e6b2004-12-16 21:44:03 +00003698 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00003699 This command will write 12345678 to address 100 all 10 ms.
3700
wdenk07d7e6b2004-12-16 21:44:03 +00003701 This only takes effect if the memory commands are activated
Simon Glass92ffdee2017-08-04 16:34:27 -06003702 globally (CONFIG_CMD_MEMORY).
stroesecc3af832004-12-16 18:46:55 +00003703
wdenk3d3d99f2005-04-04 12:44:11 +00003704- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Lin1cac36e2011-10-19 20:41:11 +00003705 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk302141d2010-11-27 23:30:56 +01003706 low level initializations (like setting up the memory
3707 controller) are omitted and/or U-Boot does not
3708 relocate itself into RAM.
wdenk3d3d99f2005-04-04 12:44:11 +00003709
Wolfgang Denk302141d2010-11-27 23:30:56 +01003710 Normally this variable MUST NOT be defined. The only
3711 exception is when U-Boot is loaded (to RAM) by some
3712 other boot loader or by a debugger which performs
3713 these initializations itself.
wdenk3d3d99f2005-04-04 12:44:11 +00003714
Simon Glass90844072016-05-05 07:28:06 -06003715- CONFIG_SKIP_LOWLEVEL_INIT_ONLY
3716 [ARM926EJ-S only] This allows just the call to lowlevel_init()
yeongjun Kim7a203682016-07-20 22:56:12 +09003717 to be skipped. The normal CP15 init (such as enabling the
Simon Glass90844072016-05-05 07:28:06 -06003718 instruction cache) is still performed.
3719
Aneesh V552a3192011-07-13 05:11:07 +00003720- CONFIG_SPL_BUILD
Magnus Lilja1ec96d82009-06-13 20:50:00 +02003721 Modifies the behaviour of start.S when compiling a loader
3722 that is executed before the actual U-Boot. E.g. when
3723 compiling a NAND SPL.
wdenk336b2bc2005-04-02 23:52:25 +00003724
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003725- CONFIG_TPL_BUILD
3726 Modifies the behaviour of start.S when compiling a loader
3727 that is executed after the SPL and before the actual U-Boot.
3728 It is loaded by the SPL.
3729
Ying Zhang0d4f5442013-05-20 14:07:23 +08003730- CONFIG_SYS_MPC85XX_NO_RESETVEC
3731 Only for 85xx systems. If this variable is specified, the section
3732 .resetvec is not kept and the section .bootpg is placed in the
3733 previous 4k of the .text section.
3734
Simon Glass17dabf02013-02-24 17:33:14 +00003735- CONFIG_ARCH_MAP_SYSMEM
3736 Generally U-Boot (and in particular the md command) uses
3737 effective address. It is therefore not necessary to regard
3738 U-Boot address as virtual addresses that need to be translated
3739 to physical addresses. However, sandbox requires this, since
3740 it maintains its own little RAM buffer which contains all
3741 addressable memory. This option causes some memory accesses
3742 to be mapped through map_sysmem() / unmap_sysmem().
3743
Simon Glassbfb59802013-02-14 04:18:54 +00003744- CONFIG_X86_RESET_VECTOR
3745 If defined, the x86 reset vector code is included. This is not
3746 needed when U-Boot is running from Coreboot.
Gabe Black14f82462012-11-27 21:08:06 +00003747
Heiko Schocher2233e462013-11-04 14:05:00 +01003748- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
3749 Enables the RTC32K OSC on AM33xx based plattforms
3750
Karicheri, Muralidharanc1dc61b2014-04-04 13:16:50 -04003751- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
3752 Option to disable subpage write in NAND driver
3753 driver that uses this:
3754 drivers/mtd/nand/davinci_nand.c
3755
Timur Tabi275f4bb2011-11-22 09:21:25 -06003756Freescale QE/FMAN Firmware Support:
3757-----------------------------------
3758
3759The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
3760loading of "firmware", which is encoded in the QE firmware binary format.
3761This firmware often needs to be loaded during U-Boot booting, so macros
3762are used to identify the storage device (NOR flash, SPI, etc) and the address
3763within that device.
3764
Zhao Qiang83a90842014-03-21 16:21:44 +08003765- CONFIG_SYS_FMAN_FW_ADDR
3766 The address in the storage device where the FMAN microcode is located. The
3767 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3768 is also specified.
3769
3770- CONFIG_SYS_QE_FW_ADDR
3771 The address in the storage device where the QE microcode is located. The
Timur Tabi275f4bb2011-11-22 09:21:25 -06003772 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3773 is also specified.
3774
3775- CONFIG_SYS_QE_FMAN_FW_LENGTH
3776 The maximum possible size of the firmware. The firmware binary format
3777 has a field that specifies the actual size of the firmware, but it
3778 might not be possible to read any part of the firmware unless some
3779 local storage is allocated to hold the entire firmware first.
3780
3781- CONFIG_SYS_QE_FMAN_FW_IN_NOR
3782 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
3783 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
3784 virtual address in NOR flash.
3785
3786- CONFIG_SYS_QE_FMAN_FW_IN_NAND
3787 Specifies that QE/FMAN firmware is located in NAND flash.
3788 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
3789
3790- CONFIG_SYS_QE_FMAN_FW_IN_MMC
3791 Specifies that QE/FMAN firmware is located on the primary SD/MMC
3792 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3793
Liu Gang1e084582012-03-08 00:33:18 +00003794- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
3795 Specifies that QE/FMAN firmware is located in the remote (master)
3796 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gang357bf5a2012-08-09 05:10:01 +00003797 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
3798 window->master inbound window->master LAW->the ucode address in
3799 master's memory space.
Timur Tabi275f4bb2011-11-22 09:21:25 -06003800
J. German Rivera8ff14b72014-06-23 15:15:55 -07003801Freescale Layerscape Management Complex Firmware Support:
3802---------------------------------------------------------
3803The Freescale Layerscape Management Complex (MC) supports the loading of
3804"firmware".
3805This firmware often needs to be loaded during U-Boot booting, so macros
3806are used to identify the storage device (NOR flash, SPI, etc) and the address
3807within that device.
3808
3809- CONFIG_FSL_MC_ENET
3810 Enable the MC driver for Layerscape SoCs.
3811
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05303812Freescale Layerscape Debug Server Support:
3813-------------------------------------------
3814The Freescale Layerscape Debug Server Support supports the loading of
3815"Debug Server firmware" and triggering SP boot-rom.
3816This firmware often needs to be loaded during U-Boot booting.
3817
York Sun928b6812015-12-07 11:08:58 -08003818- CONFIG_SYS_MC_RSV_MEM_ALIGN
3819 Define alignment of reserved memory MC requires
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05303820
Paul Kocialkowski7b917022015-07-26 18:48:15 +02003821Reproducible builds
3822-------------------
3823
3824In order to achieve reproducible builds, timestamps used in the U-Boot build
3825process have to be set to a fixed value.
3826
3827This is done using the SOURCE_DATE_EPOCH environment variable.
3828SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
3829option for U-Boot or an environment variable in U-Boot.
3830
3831SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
3832
wdenkc6097192002-11-03 00:24:07 +00003833Building the Software:
3834======================
3835
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003836Building U-Boot has been tested in several native build environments
3837and in many different cross environments. Of course we cannot support
3838all possibly existing versions of cross development tools in all
3839(potentially obsolete) versions. In case of tool chain problems we
3840recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3841which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003842
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003843If you are not using a native environment, it is assumed that you
3844have GNU cross compiling tools available in your path. In this case,
3845you must set the environment variable CROSS_COMPILE in your shell.
3846Note that no changes to the Makefile or any other source files are
3847necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00003848
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003849 $ CROSS_COMPILE=ppc_4xx-
3850 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00003851
Peter Tyserb06976d2009-03-13 18:54:51 -05003852Note: If you wish to generate Windows versions of the utilities in
3853 the tools directory you can use the MinGW toolchain
3854 (http://www.mingw.org). Set your HOST tools to the MinGW
3855 toolchain and execute 'make tools'. For example:
3856
3857 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
3858
3859 Binaries such as tools/mkimage.exe will be created which can
3860 be executed on computers running Windows.
3861
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003862U-Boot is intended to be simple to build. After installing the
3863sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00003864is done by typing:
3865
Holger Freyther7ba4e572014-08-04 09:26:05 +02003866 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00003867
Holger Freyther7ba4e572014-08-04 09:26:05 +02003868where "NAME_defconfig" is the name of one of the existing configu-
Michael Jones5a7fb6f2012-03-15 22:48:10 +00003869rations; see boards.cfg for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00003870
wdenk6c59edc2004-05-03 20:45:30 +00003871Note: for some board special configuration names may exist; check if
3872 additional information is available from the board vendor; for
3873 instance, the TQM823L systems are available without (standard)
3874 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003875 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00003876
Holger Freyther7ba4e572014-08-04 09:26:05 +02003877 make TQM823L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00003878 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00003879
Holger Freyther7ba4e572014-08-04 09:26:05 +02003880 make TQM823L_LCD_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00003881 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00003882
wdenk6c59edc2004-05-03 20:45:30 +00003883 etc.
wdenkc6097192002-11-03 00:24:07 +00003884
wdenkc6097192002-11-03 00:24:07 +00003885
wdenk6c59edc2004-05-03 20:45:30 +00003886Finally, type "make all", and you should get some working U-Boot
3887images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00003888
wdenk6c59edc2004-05-03 20:45:30 +00003889- "u-boot.bin" is a raw binary image
3890- "u-boot" is an image in ELF binary format
3891- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00003892
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003893By default the build is performed locally and the objects are saved
3894in the source directory. One of the two methods can be used to change
3895this behavior and build U-Boot to some external directory:
3896
38971. Add O= to the make command line invocations:
3898
3899 make O=/tmp/build distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02003900 make O=/tmp/build NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003901 make O=/tmp/build all
3902
Timo Ketolac8c67602014-11-06 14:39:05 +020039032. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003904
Timo Ketolac8c67602014-11-06 14:39:05 +02003905 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003906 make distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02003907 make NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003908 make all
3909
Timo Ketolac8c67602014-11-06 14:39:05 +02003910Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003911variable.
3912
wdenkc6097192002-11-03 00:24:07 +00003913
wdenk6c59edc2004-05-03 20:45:30 +00003914Please be aware that the Makefiles assume you are using GNU make, so
3915for instance on NetBSD you might need to use "gmake" instead of
3916native "make".
wdenkc6097192002-11-03 00:24:07 +00003917
wdenkc6097192002-11-03 00:24:07 +00003918
wdenk6c59edc2004-05-03 20:45:30 +00003919If the system board that you have is not listed, then you will need
3920to port U-Boot to your hardware platform. To do this, follow these
3921steps:
wdenkc6097192002-11-03 00:24:07 +00003922
Phil Sutterc77b4882015-12-25 14:41:18 +010039231. Create a new directory to hold your board specific code. Add any
wdenk6c59edc2004-05-03 20:45:30 +00003924 files you need. In your board directory, you will need at least
Phil Sutterc77b4882015-12-25 14:41:18 +01003925 the "Makefile" and a "<board>.c".
39262. Create a new configuration file "include/configs/<board>.h" for
3927 your board.
wdenk6c59edc2004-05-03 20:45:30 +000039283. If you're porting U-Boot to a new CPU, then also create a new
3929 directory to hold your CPU specific code. Add any files you need.
Holger Freyther7ba4e572014-08-04 09:26:05 +020039304. Run "make <board>_defconfig" with your new name.
wdenk6c59edc2004-05-03 20:45:30 +000039315. Type "make", and you should get a working "u-boot.srec" file
3932 to be installed on your target system.
39336. Debug and solve any problems that might arise.
3934 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00003935
wdenkc6097192002-11-03 00:24:07 +00003936
wdenk6c59edc2004-05-03 20:45:30 +00003937Testing of U-Boot Modifications, Ports to New Hardware, etc.:
3938==============================================================
wdenkc6097192002-11-03 00:24:07 +00003939
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003940If you have modified U-Boot sources (for instance added a new board
3941or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00003942provide feedback to the other developers. The feedback normally takes
3943the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003944official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00003945
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003946But before you submit such a patch, please verify that your modifi-
3947cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00003948the supported boards compile WITHOUT ANY compiler warnings. To do so,
Simon Glassdc27def2016-07-27 20:33:08 -06003949just run the buildman script (tools/buildman/buildman), which will
3950configure and build U-Boot for ALL supported system. Be warned, this
3951will take a while. Please see the buildman README, or run 'buildman -H'
3952for documentation.
wdenkc6097192002-11-03 00:24:07 +00003953
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003954
wdenk6c59edc2004-05-03 20:45:30 +00003955See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00003956
wdenkc6097192002-11-03 00:24:07 +00003957
wdenk6c59edc2004-05-03 20:45:30 +00003958Monitor Commands - Overview:
3959============================
wdenkc6097192002-11-03 00:24:07 +00003960
wdenk6c59edc2004-05-03 20:45:30 +00003961go - start application at address 'addr'
3962run - run commands in an environment variable
3963bootm - boot application image from memory
3964bootp - boot image via network using BootP/TFTP protocol
Marek Vasutcf41a9b2012-03-14 21:52:45 +00003965bootz - boot zImage from memory
wdenk6c59edc2004-05-03 20:45:30 +00003966tftpboot- boot image via network using TFTP protocol
3967 and env variables "ipaddr" and "serverip"
3968 (and eventually "gatewayip")
Simon Glass6a398d22011-10-24 18:00:07 +00003969tftpput - upload a file via network using TFTP protocol
wdenk6c59edc2004-05-03 20:45:30 +00003970rarpboot- boot image via network using RARP/TFTP protocol
3971diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
3972loads - load S-Record file over serial line
3973loadb - load binary file over serial line (kermit mode)
3974md - memory display
3975mm - memory modify (auto-incrementing)
3976nm - memory modify (constant address)
3977mw - memory write (fill)
3978cp - memory copy
3979cmp - memory compare
3980crc32 - checksum calculation
Peter Tyser469cde42009-04-18 22:34:03 -05003981i2c - I2C sub-system
wdenk6c59edc2004-05-03 20:45:30 +00003982sspi - SPI utility commands
3983base - print or set address offset
3984printenv- print environment variables
3985setenv - set environment variables
3986saveenv - save environment variables to persistent storage
3987protect - enable or disable FLASH write protection
3988erase - erase FLASH memory
3989flinfo - print FLASH memory information
Karl O. Pinc4baf03d2012-08-03 05:57:21 +00003990nand - NAND memory operations (see doc/README.nand)
wdenk6c59edc2004-05-03 20:45:30 +00003991bdinfo - print Board Info structure
3992iminfo - print header information for application image
3993coninfo - print console devices and informations
3994ide - IDE sub-system
3995loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00003996loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00003997mtest - simple RAM test
3998icache - enable or disable instruction cache
3999dcache - enable or disable data cache
4000reset - Perform RESET of the CPU
4001echo - echo args to console
4002version - print monitor version
4003help - print online help
4004? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00004005
wdenkc6097192002-11-03 00:24:07 +00004006
wdenk6c59edc2004-05-03 20:45:30 +00004007Monitor Commands - Detailed Description:
4008========================================
wdenkc6097192002-11-03 00:24:07 +00004009
wdenk6c59edc2004-05-03 20:45:30 +00004010TODO.
wdenkc6097192002-11-03 00:24:07 +00004011
wdenk6c59edc2004-05-03 20:45:30 +00004012For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00004013
4014
wdenk6c59edc2004-05-03 20:45:30 +00004015Environment Variables:
4016======================
wdenkc6097192002-11-03 00:24:07 +00004017
wdenk6c59edc2004-05-03 20:45:30 +00004018U-Boot supports user configuration using Environment Variables which
4019can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00004020
wdenk6c59edc2004-05-03 20:45:30 +00004021Environment Variables are set using "setenv", printed using
4022"printenv", and saved to Flash using "saveenv". Using "setenv"
4023without a value can be used to delete a variable from the
4024environment. As long as you don't save the environment you are
4025working with an in-memory copy. In case the Flash area containing the
4026environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00004027
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004028Some configuration options can be set using Environment Variables.
4029
4030List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00004031
wdenk6c59edc2004-05-03 20:45:30 +00004032 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00004033
wdenk6c59edc2004-05-03 20:45:30 +00004034 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00004035
wdenk6c59edc2004-05-03 20:45:30 +00004036 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00004037
wdenk6c59edc2004-05-03 20:45:30 +00004038 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00004039
wdenk6c59edc2004-05-03 20:45:30 +00004040 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00004041
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004042 bootm_low - Memory range available for image processing in the bootm
4043 command can be restricted. This variable is given as
4044 a hexadecimal number and defines lowest address allowed
4045 for use by the bootm command. See also "bootm_size"
4046 environment variable. Address defined by "bootm_low" is
4047 also the base of the initial memory mapping for the Linux
Grant Likely26396382011-03-28 09:58:43 +00004048 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4049 bootm_mapsize.
4050
Wolfgang Denk092ae952011-10-26 10:21:21 +00004051 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likely26396382011-03-28 09:58:43 +00004052 This variable is given as a hexadecimal number and it
4053 defines the size of the memory region starting at base
4054 address bootm_low that is accessible by the Linux kernel
4055 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
4056 as the default value if it is defined, and bootm_size is
4057 used otherwise.
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004058
4059 bootm_size - Memory range available for image processing in the bootm
4060 command can be restricted. This variable is given as
4061 a hexadecimal number and defines the size of the region
4062 allowed for use by the bootm command. See also "bootm_low"
4063 environment variable.
4064
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02004065 updatefile - Location of the software update file on a TFTP server, used
4066 by the automatic software update feature. Please refer to
4067 documentation in doc/README.update for more details.
4068
wdenk6c59edc2004-05-03 20:45:30 +00004069 autoload - if set to "no" (any string beginning with 'n'),
4070 "bootp" will just load perform a lookup of the
4071 configuration from the BOOTP server, but not try to
4072 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00004073
wdenk6c59edc2004-05-03 20:45:30 +00004074 autostart - if set to "yes", an image loaded using the "bootp",
4075 "rarpboot", "tftpboot" or "diskboot" commands will
4076 be automatically started (by internally calling
4077 "bootm")
wdenkc6097192002-11-03 00:24:07 +00004078
wdenk6c59edc2004-05-03 20:45:30 +00004079 If set to "no", a standalone image passed to the
4080 "bootm" command will be copied to the load address
4081 (and eventually uncompressed), but NOT be started.
4082 This can be used to load and uncompress arbitrary
4083 data.
wdenkc6097192002-11-03 00:24:07 +00004084
David A. Longd558a4e2011-07-09 16:40:19 -04004085 fdt_high - if set this restricts the maximum address that the
4086 flattened device tree will be copied into upon boot.
Shawn Guo0ca9e982012-01-09 21:54:08 +00004087 For example, if you have a system with 1 GB memory
4088 at physical address 0x10000000, while Linux kernel
4089 only recognizes the first 704 MB as low memory, you
4090 may need to set fdt_high as 0x3C000000 to have the
4091 device tree blob be copied to the maximum address
4092 of the 704 MB low memory, so that Linux kernel can
4093 access it during the boot procedure.
4094
David A. Longd558a4e2011-07-09 16:40:19 -04004095 If this is set to the special value 0xFFFFFFFF then
4096 the fdt will not be copied at all on boot. For this
4097 to work it must reside in writable memory, have
4098 sufficient padding on the end of it for u-boot to
4099 add the information it needs into it, and the memory
4100 must be accessible by the kernel.
4101
Simon Glassdc6fa642011-10-24 19:15:34 +00004102 fdtcontroladdr- if set this is the address of the control flattened
4103 device tree used by U-Boot when CONFIG_OF_CONTROL is
4104 defined.
4105
wdenk0e2bd9c2004-06-06 21:51:03 +00004106 i2cfast - (PPC405GP|PPC405EP only)
4107 if set to 'y' configures Linux I2C driver for fast
4108 mode (400kHZ). This environment variable is used in
4109 initialization code. So, for changes to be effective
4110 it must be saved and board must be reset.
4111
wdenk6c59edc2004-05-03 20:45:30 +00004112 initrd_high - restrict positioning of initrd images:
4113 If this variable is not set, initrd images will be
4114 copied to the highest possible address in RAM; this
4115 is usually what you want since it allows for
4116 maximum initrd size. If for some reason you want to
4117 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004118 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk6c59edc2004-05-03 20:45:30 +00004119 variable to a value of "no" or "off" or "0".
4120 Alternatively, you can set it to a maximum upper
4121 address to use (U-Boot will still check that it
4122 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00004123
wdenk6c59edc2004-05-03 20:45:30 +00004124 For instance, when you have a system with 16 MB
4125 RAM, and want to reserve 4 MB from use by Linux,
4126 you can do this by adding "mem=12M" to the value of
4127 the "bootargs" variable. However, now you must make
4128 sure that the initrd image is placed in the first
4129 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00004130
wdenk6c59edc2004-05-03 20:45:30 +00004131 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00004132
wdenk6c59edc2004-05-03 20:45:30 +00004133 If you set initrd_high to 0xFFFFFFFF, this is an
4134 indication to U-Boot that all addresses are legal
4135 for the Linux kernel, including addresses in flash
4136 memory. In this case U-Boot will NOT COPY the
4137 ramdisk at all. This may be useful to reduce the
4138 boot time on your system, but requires that this
4139 feature is supported by your Linux kernel.
wdenk3f9ab982003-04-12 23:38:12 +00004140
wdenk6c59edc2004-05-03 20:45:30 +00004141 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00004142
wdenk6c59edc2004-05-03 20:45:30 +00004143 loadaddr - Default load address for commands like "bootp",
4144 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00004145
wdenk6c59edc2004-05-03 20:45:30 +00004146 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00004147
wdenk6c59edc2004-05-03 20:45:30 +00004148 serverip - TFTP server IP address; needed for tftpboot command
wdenk6f770ed2003-05-23 23:18:21 +00004149
wdenk6c59edc2004-05-03 20:45:30 +00004150 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00004151
wdenk6c59edc2004-05-03 20:45:30 +00004152 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00004153
wdenk6c59edc2004-05-03 20:45:30 +00004154 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00004155
Mike Frysingera23230c2011-10-02 10:01:27 +00004156 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00004157
Mike Frysingera23230c2011-10-02 10:01:27 +00004158 ethact - controls which interface is currently active.
4159 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00004160
Heiko Schocherc5e84052010-07-20 17:45:02 +02004161 => setenv ethact FEC
4162 => ping 192.168.0.1 # traffic sent on FEC
4163 => setenv ethact SCC
4164 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00004165
Matthias Fuchs204f0ec2008-01-17 07:45:05 +01004166 ethrotate - When set to "no" U-Boot does not go through all
4167 available network interfaces.
4168 It just stays at the currently selected interface.
4169
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004170 netretry - When set to "no" each network operation will
wdenk6c59edc2004-05-03 20:45:30 +00004171 either succeed or fail without retrying.
4172 When set to "once" the network operation will
4173 fail when all the available network interfaces
4174 are tried once without success.
4175 Useful on scripts which control the retry operation
4176 themselves.
wdenkc6097192002-11-03 00:24:07 +00004177
Jean-Christophe PLAGNIOL-VILLARD1948d6c2009-01-31 09:53:39 +01004178 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDd2164ef2008-01-07 08:41:34 +01004179
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004180 silent_linux - If set then Linux will be told to boot silently, by
Simon Glass5db3f932013-07-16 20:10:00 -07004181 changing the console to be empty. If "yes" it will be
4182 made silent. If "no" it will not be made silent. If
4183 unset, then it will be made silent if the U-Boot console
4184 is silent.
4185
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02004186 tftpsrcp - If this is set, the value is used for TFTP's
Wolfgang Denke3cfce52005-09-24 22:37:32 +02004187 UDP source port.
4188
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02004189 tftpdstp - If this is set, the value is used for TFTP's UDP
Wolfgang Denk227b5192005-09-24 23:25:46 +02004190 destination port instead of the Well Know Port 69.
4191
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004192 tftpblocksize - Block size to use for TFTP transfers; if not set,
4193 we use the TFTP server's default block size
4194
4195 tftptimeout - Retransmission timeout for TFTP packets (in milli-
4196 seconds, minimum value is 1000 = 1 second). Defines
4197 when a packet is considered to be lost so it has to
4198 be retransmitted. The default is 5000 = 5 seconds.
4199 Lowering this value may make downloads succeed
4200 faster in networks with high packet loss rates or
4201 with unreliable TFTP servers.
4202
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02004203 tftptimeoutcountmax - maximum count of TFTP timeouts (no
4204 unit, minimum value = 0). Defines how many timeouts
4205 can happen during a single file transfer before that
4206 transfer is aborted. The default is 10, and 0 means
4207 'no timeouts allowed'. Increasing this value may help
4208 downloads succeed with high packet loss rates, or with
4209 unreliable TFTP servers or client hardware.
4210
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004211 vlan - When set to a value < 4095 the traffic over
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004212 Ethernet is encapsulated/received over 802.1q
wdenk6c59edc2004-05-03 20:45:30 +00004213 VLAN tagged frames.
wdenk145d2c12004-04-15 21:48:45 +00004214
Alexandre Messier15971322016-02-01 17:08:57 -05004215 bootpretryperiod - Period during which BOOTP/DHCP sends retries.
4216 Unsigned value, in milliseconds. If not set, the period will
4217 be either the default (28000), or a value based on
4218 CONFIG_NET_RETRY_COUNT, if defined. This value has
4219 precedence over the valu based on CONFIG_NET_RETRY_COUNT.
4220
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004221The following image location variables contain the location of images
4222used in booting. The "Image" column gives the role of the image and is
4223not an environment variable name. The other columns are environment
4224variable names. "File Name" gives the name of the file on a TFTP
4225server, "RAM Address" gives the location in RAM the image will be
4226loaded to, and "Flash Location" gives the image's address in NOR
4227flash or offset in NAND flash.
4228
4229*Note* - these variables don't have to be defined for all boards, some
Fabio Estevambb7d4972015-04-25 18:53:10 -03004230boards currently use other variables for these purposes, and some
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004231boards use these variables for other purposes.
4232
Wolfgang Denk092ae952011-10-26 10:21:21 +00004233Image File Name RAM Address Flash Location
4234----- --------- ----------- --------------
4235u-boot u-boot u-boot_addr_r u-boot_addr
4236Linux kernel bootfile kernel_addr_r kernel_addr
4237device tree blob fdtfile fdt_addr_r fdt_addr
4238ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004239
wdenk6c59edc2004-05-03 20:45:30 +00004240The following environment variables may be used and automatically
4241updated by the network boot commands ("bootp" and "rarpboot"),
4242depending the information provided by your boot server:
wdenk145d2c12004-04-15 21:48:45 +00004243
wdenk6c59edc2004-05-03 20:45:30 +00004244 bootfile - see above
4245 dnsip - IP address of your Domain Name Server
4246 dnsip2 - IP address of your secondary Domain Name Server
4247 gatewayip - IP address of the Gateway (Router) to use
4248 hostname - Target hostname
4249 ipaddr - see above
4250 netmask - Subnet Mask
4251 rootpath - Pathname of the root filesystem on the NFS server
4252 serverip - see above
wdenk145d2c12004-04-15 21:48:45 +00004253
wdenk145d2c12004-04-15 21:48:45 +00004254
wdenk6c59edc2004-05-03 20:45:30 +00004255There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004256
wdenk6c59edc2004-05-03 20:45:30 +00004257 serial# - contains hardware identification information such
4258 as type string and/or serial number
4259 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00004260
wdenk6c59edc2004-05-03 20:45:30 +00004261These variables can be set only once (usually during manufacturing of
4262the board). U-Boot refuses to delete or overwrite these variables
4263once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00004264
4265
wdenk6c59edc2004-05-03 20:45:30 +00004266Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004267
wdenk6c59edc2004-05-03 20:45:30 +00004268 ver - Contains the U-Boot version string as printed
4269 with the "version" command. This variable is
4270 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00004271
wdenkc6097192002-11-03 00:24:07 +00004272
wdenk6c59edc2004-05-03 20:45:30 +00004273Please note that changes to some configuration parameters may take
4274only effect after the next boot (yes, that's just like Windoze :-).
stroeseb9c17c52003-04-04 15:53:41 +00004275
stroeseb9c17c52003-04-04 15:53:41 +00004276
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004277Callback functions for environment variables:
4278---------------------------------------------
4279
4280For some environment variables, the behavior of u-boot needs to change
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004281when their values are changed. This functionality allows functions to
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004282be associated with arbitrary variables. On creation, overwrite, or
4283deletion, the callback will provide the opportunity for some side
4284effect to happen or for the change to be rejected.
4285
4286The callbacks are named and associated with a function using the
4287U_BOOT_ENV_CALLBACK macro in your board or driver code.
4288
4289These callbacks are associated with variables in one of two ways. The
4290static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4291in the board configuration to a string that defines a list of
4292associations. The list must be in the following format:
4293
4294 entry = variable_name[:callback_name]
4295 list = entry[,list]
4296
4297If the callback name is not specified, then the callback is deleted.
4298Spaces are also allowed anywhere in the list.
4299
4300Callbacks can also be associated by defining the ".callbacks" variable
4301with the same list format above. Any association in ".callbacks" will
4302override any association in the static list. You can define
4303CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004304".callbacks" environment variable in the default or embedded environment.
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004305
Joe Hershberger6db9fd42015-05-20 14:27:20 -05004306If CONFIG_REGEX is defined, the variable_name above is evaluated as a
4307regular expression. This allows multiple variables to be connected to
4308the same callback without explicitly listing them all out.
4309
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004310
wdenk6c59edc2004-05-03 20:45:30 +00004311Command Line Parsing:
4312=====================
stroeseb9c17c52003-04-04 15:53:41 +00004313
wdenk6c59edc2004-05-03 20:45:30 +00004314There are two different command line parsers available with U-Boot:
4315the old "simple" one, and the much more powerful "hush" shell:
wdenkc6097192002-11-03 00:24:07 +00004316
wdenk6c59edc2004-05-03 20:45:30 +00004317Old, simple command line parser:
4318--------------------------------
wdenkc6097192002-11-03 00:24:07 +00004319
wdenk6c59edc2004-05-03 20:45:30 +00004320- supports environment variables (through setenv / saveenv commands)
4321- several commands on one line, separated by ';'
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01004322- variable substitution using "... ${name} ..." syntax
wdenk6c59edc2004-05-03 20:45:30 +00004323- special characters ('$', ';') can be escaped by prefixing with '\',
4324 for example:
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01004325 setenv bootcmd bootm \${address}
wdenk6c59edc2004-05-03 20:45:30 +00004326- You can also escape text by enclosing in single apostrophes, for example:
4327 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00004328
wdenk6c59edc2004-05-03 20:45:30 +00004329Hush shell:
4330-----------
wdenkf4688a22003-05-28 08:06:31 +00004331
wdenk6c59edc2004-05-03 20:45:30 +00004332- similar to Bourne shell, with control structures like
4333 if...then...else...fi, for...do...done; while...do...done,
4334 until...do...done, ...
4335- supports environment ("global") variables (through setenv / saveenv
4336 commands) and local shell variables (through standard shell syntax
4337 "name=value"); only environment variables can be used with "run"
4338 command
wdenkf4688a22003-05-28 08:06:31 +00004339
wdenk6c59edc2004-05-03 20:45:30 +00004340General rules:
4341--------------
wdenkf4688a22003-05-28 08:06:31 +00004342
wdenk6c59edc2004-05-03 20:45:30 +00004343(1) If a command line (or an environment variable executed by a "run"
4344 command) contains several commands separated by semicolon, and
4345 one of these commands fails, then the remaining commands will be
4346 executed anyway.
wdenkf4688a22003-05-28 08:06:31 +00004347
wdenk6c59edc2004-05-03 20:45:30 +00004348(2) If you execute several variables with one call to run (i. e.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004349 calling run with a list of variables as arguments), any failing
wdenk6c59edc2004-05-03 20:45:30 +00004350 command will cause "run" to terminate, i. e. the remaining
4351 variables are not executed.
wdenkf4688a22003-05-28 08:06:31 +00004352
wdenk6c59edc2004-05-03 20:45:30 +00004353Note for Redundant Ethernet Interfaces:
4354=======================================
wdenkf4688a22003-05-28 08:06:31 +00004355
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004356Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00004357such configurations and is capable of automatic selection of a
4358"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00004359
wdenk6c59edc2004-05-03 20:45:30 +00004360Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
4361MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4362"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00004363
wdenk6c59edc2004-05-03 20:45:30 +00004364If the network interface stores some valid MAC address (for instance
4365in SROM), this is used as default address if there is NO correspon-
4366ding setting in the environment; if the corresponding environment
4367variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00004368
wdenk6c59edc2004-05-03 20:45:30 +00004369o If the SROM has a valid MAC address, and there is no address in the
4370 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00004371
wdenk6c59edc2004-05-03 20:45:30 +00004372o If there is no valid address in the SROM, and a definition in the
4373 environment exists, then the value from the environment variable is
4374 used.
wdenkc6097192002-11-03 00:24:07 +00004375
wdenk6c59edc2004-05-03 20:45:30 +00004376o If both the SROM and the environment contain a MAC address, and
4377 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00004378
wdenk6c59edc2004-05-03 20:45:30 +00004379o If both the SROM and the environment contain a MAC address, and the
4380 addresses differ, the value from the environment is used and a
4381 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00004382
wdenk6c59edc2004-05-03 20:45:30 +00004383o If neither SROM nor the environment contain a MAC address, an error
Joe Hershberger2dc2b5d2015-05-04 14:55:13 -05004384 is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
4385 a random, locally-assigned MAC is used.
wdenkc6097192002-11-03 00:24:07 +00004386
Ben Warren6db991a2010-04-26 11:11:46 -07004387If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denk092ae952011-10-26 10:21:21 +00004388will be programmed into hardware as part of the initialization process. This
Ben Warren6db991a2010-04-26 11:11:46 -07004389may be skipped by setting the appropriate 'ethmacskip' environment variable.
4390The naming convention is as follows:
4391"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00004392
wdenk6c59edc2004-05-03 20:45:30 +00004393Image Formats:
4394==============
wdenkc6097192002-11-03 00:24:07 +00004395
Marian Balakowicz18710b82008-03-12 12:13:13 +01004396U-Boot is capable of booting (and performing other auxiliary operations on)
4397images in two formats:
4398
4399New uImage format (FIT)
4400-----------------------
4401
4402Flexible and powerful format based on Flattened Image Tree -- FIT (similar
4403to Flattened Device Tree). It allows the use of images with multiple
4404components (several kernels, ramdisks, etc.), with contents protected by
4405SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
4406
4407
4408Old uImage format
4409-----------------
4410
4411Old image format is based on binary files which can be basically anything,
4412preceded by a special header; see the definitions in include/image.h for
4413details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00004414
wdenk6c59edc2004-05-03 20:45:30 +00004415* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4416 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05004417 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4418 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4419 INTEGRITY).
Andy Shevchenko8cb5cdd2017-07-05 16:25:22 +03004420* Target CPU Architecture (Provisions for Alpha, ARM, Intel x86,
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004421 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
Andy Shevchenko8cb5cdd2017-07-05 16:25:22 +03004422 Currently supported: ARM, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00004423* Compression Type (uncompressed, gzip, bzip2)
4424* Load Address
4425* Entry Point
4426* Image Name
4427* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00004428
wdenk6c59edc2004-05-03 20:45:30 +00004429The header is marked by a special Magic Number, and both the header
4430and the data portions of the image are secured against corruption by
4431CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00004432
wdenkc6097192002-11-03 00:24:07 +00004433
wdenk6c59edc2004-05-03 20:45:30 +00004434Linux Support:
4435==============
wdenkc6097192002-11-03 00:24:07 +00004436
wdenk6c59edc2004-05-03 20:45:30 +00004437Although U-Boot should support any OS or standalone application
4438easily, the main focus has always been on Linux during the design of
4439U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004440
wdenk6c59edc2004-05-03 20:45:30 +00004441U-Boot includes many features that so far have been part of some
4442special "boot loader" code within the Linux kernel. Also, any
4443"initrd" images to be used are no longer part of one big Linux image;
4444instead, kernel and "initrd" are separate images. This implementation
4445serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00004446
wdenk6c59edc2004-05-03 20:45:30 +00004447- the same features can be used for other OS or standalone
4448 applications (for instance: using compressed images to reduce the
4449 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00004450
wdenk6c59edc2004-05-03 20:45:30 +00004451- it becomes much easier to port new Linux kernel versions because
4452 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00004453
wdenk6c59edc2004-05-03 20:45:30 +00004454- the same Linux kernel image can now be used with different "initrd"
4455 images; of course this also means that different kernel images can
4456 be run with the same "initrd". This makes testing easier (you don't
4457 have to build a new "zImage.initrd" Linux image when you just
4458 change a file in your "initrd"). Also, a field-upgrade of the
4459 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00004460
wdenkc6097192002-11-03 00:24:07 +00004461
wdenk6c59edc2004-05-03 20:45:30 +00004462Linux HOWTO:
4463============
wdenkc6097192002-11-03 00:24:07 +00004464
wdenk6c59edc2004-05-03 20:45:30 +00004465Porting Linux to U-Boot based systems:
4466---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004467
wdenk6c59edc2004-05-03 20:45:30 +00004468U-Boot cannot save you from doing all the necessary modifications to
4469configure the Linux device drivers for use with your target hardware
4470(no, we don't intend to provide a full virtual machine interface to
4471Linux :-).
wdenkc6097192002-11-03 00:24:07 +00004472
Stefan Roese88fbf932010-04-15 16:07:28 +02004473But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00004474
wdenk6c59edc2004-05-03 20:45:30 +00004475Just make sure your machine specific header file (for instance
4476include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02004477Information structure as we define in include/asm-<arch>/u-boot.h,
4478and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004479as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00004480
Simon Glassd097e592014-06-11 23:29:46 -06004481Note that U-Boot now has a driver model, a unified model for drivers.
4482If you are adding a new driver, plumb it into driver model. If there
4483is no uclass available, you are encouraged to create one. See
4484doc/driver-model.
4485
wdenkc6097192002-11-03 00:24:07 +00004486
wdenk6c59edc2004-05-03 20:45:30 +00004487Configuring the Linux kernel:
4488-----------------------------
wdenkc6097192002-11-03 00:24:07 +00004489
wdenk6c59edc2004-05-03 20:45:30 +00004490No specific requirements for U-Boot. Make sure you have some root
4491device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00004492
wdenkc6097192002-11-03 00:24:07 +00004493
wdenk6c59edc2004-05-03 20:45:30 +00004494Building a Linux Image:
4495-----------------------
wdenkc6097192002-11-03 00:24:07 +00004496
wdenk6c59edc2004-05-03 20:45:30 +00004497With U-Boot, "normal" build targets like "zImage" or "bzImage" are
4498not used. If you use recent kernel source, a new build target
4499"uImage" will exist which automatically builds an image usable by
4500U-Boot. Most older kernels also have support for a "pImage" target,
4501which was introduced for our predecessor project PPCBoot and uses a
4502100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00004503
wdenk6c59edc2004-05-03 20:45:30 +00004504Example:
wdenkc6097192002-11-03 00:24:07 +00004505
Holger Freyther7ba4e572014-08-04 09:26:05 +02004506 make TQM850L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00004507 make oldconfig
4508 make dep
4509 make uImage
wdenkc6097192002-11-03 00:24:07 +00004510
wdenk6c59edc2004-05-03 20:45:30 +00004511The "uImage" build target uses a special tool (in 'tools/mkimage') to
4512encapsulate a compressed Linux kernel image with header information,
4513CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00004514
wdenk6c59edc2004-05-03 20:45:30 +00004515* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00004516
wdenk6c59edc2004-05-03 20:45:30 +00004517* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00004518
wdenk6c59edc2004-05-03 20:45:30 +00004519 ${CROSS_COMPILE}-objcopy -O binary \
4520 -R .note -R .comment \
4521 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00004522
wdenk6c59edc2004-05-03 20:45:30 +00004523* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00004524
wdenk6c59edc2004-05-03 20:45:30 +00004525 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00004526
wdenk6c59edc2004-05-03 20:45:30 +00004527* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00004528
wdenk6c59edc2004-05-03 20:45:30 +00004529 mkimage -A ppc -O linux -T kernel -C gzip \
4530 -a 0 -e 0 -n "Linux Kernel Image" \
4531 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00004532
wdenkc6097192002-11-03 00:24:07 +00004533
wdenk6c59edc2004-05-03 20:45:30 +00004534The "mkimage" tool can also be used to create ramdisk images for use
4535with U-Boot, either separated from the Linux kernel image, or
4536combined into one file. "mkimage" encapsulates the images with a 64
4537byte header containing information about target architecture,
4538operating system, image type, compression method, entry points, time
4539stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00004540
wdenk6c59edc2004-05-03 20:45:30 +00004541"mkimage" can be called in two ways: to verify existing images and
4542print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00004543
wdenk6c59edc2004-05-03 20:45:30 +00004544In the first form (with "-l" option) mkimage lists the information
4545contained in the header of an existing U-Boot image; this includes
4546checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00004547
wdenk6c59edc2004-05-03 20:45:30 +00004548 tools/mkimage -l image
4549 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00004550
wdenk6c59edc2004-05-03 20:45:30 +00004551The second form (with "-d" option) is used to build a U-Boot image
4552from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00004553
wdenk6c59edc2004-05-03 20:45:30 +00004554 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4555 -n name -d data_file image
4556 -A ==> set architecture to 'arch'
4557 -O ==> set operating system to 'os'
4558 -T ==> set image type to 'type'
4559 -C ==> set compression type 'comp'
4560 -a ==> set load address to 'addr' (hex)
4561 -e ==> set entry point to 'ep' (hex)
4562 -n ==> set image name to 'name'
4563 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00004564
wdenkcd914452004-05-29 16:53:29 +00004565Right now, all Linux kernels for PowerPC systems use the same load
4566address (0x00000000), but the entry point address depends on the
4567kernel version:
wdenkc6097192002-11-03 00:24:07 +00004568
wdenk6c59edc2004-05-03 20:45:30 +00004569- 2.2.x kernels have the entry point at 0x0000000C,
4570- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00004571
wdenk6c59edc2004-05-03 20:45:30 +00004572So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00004573
wdenk6c59edc2004-05-03 20:45:30 +00004574 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4575 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02004576 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk6c59edc2004-05-03 20:45:30 +00004577 > examples/uImage.TQM850L
4578 Image Name: 2.4.4 kernel for TQM850L
4579 Created: Wed Jul 19 02:34:59 2000
4580 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4581 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4582 Load Address: 0x00000000
4583 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004584
wdenk6c59edc2004-05-03 20:45:30 +00004585To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00004586
wdenk6c59edc2004-05-03 20:45:30 +00004587 -> tools/mkimage -l examples/uImage.TQM850L
4588 Image Name: 2.4.4 kernel for TQM850L
4589 Created: Wed Jul 19 02:34:59 2000
4590 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4591 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4592 Load Address: 0x00000000
4593 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004594
wdenk6c59edc2004-05-03 20:45:30 +00004595NOTE: for embedded systems where boot time is critical you can trade
4596speed for memory and install an UNCOMPRESSED image instead: this
4597needs more space in Flash, but boots much faster since it does not
4598need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00004599
Stefan Roese88fbf932010-04-15 16:07:28 +02004600 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk6c59edc2004-05-03 20:45:30 +00004601 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4602 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02004603 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk6c59edc2004-05-03 20:45:30 +00004604 > examples/uImage.TQM850L-uncompressed
4605 Image Name: 2.4.4 kernel for TQM850L
4606 Created: Wed Jul 19 02:34:59 2000
4607 Image Type: PowerPC Linux Kernel Image (uncompressed)
4608 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
4609 Load Address: 0x00000000
4610 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004611
wdenkc6097192002-11-03 00:24:07 +00004612
wdenk6c59edc2004-05-03 20:45:30 +00004613Similar you can build U-Boot images from a 'ramdisk.image.gz' file
4614when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00004615
wdenk6c59edc2004-05-03 20:45:30 +00004616 -> tools/mkimage -n 'Simple Ramdisk Image' \
4617 > -A ppc -O linux -T ramdisk -C gzip \
4618 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
4619 Image Name: Simple Ramdisk Image
4620 Created: Wed Jan 12 14:01:50 2000
4621 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4622 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
4623 Load Address: 0x00000000
4624 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004625
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07004626The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
4627option performs the converse operation of the mkimage's second form (the "-d"
4628option). Given an image built by mkimage, the dumpimage extracts a "data file"
4629from the image:
4630
Guilherme Maciel Ferreira40bf5632015-01-15 02:54:40 -02004631 tools/dumpimage -i image -T type -p position data_file
4632 -i ==> extract from the 'image' a specific 'data_file'
4633 -T ==> set image type to 'type'
4634 -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07004635
wdenkc6097192002-11-03 00:24:07 +00004636
wdenk6c59edc2004-05-03 20:45:30 +00004637Installing a Linux Image:
4638-------------------------
wdenkc6097192002-11-03 00:24:07 +00004639
wdenk6c59edc2004-05-03 20:45:30 +00004640To downloading a U-Boot image over the serial (console) interface,
4641you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00004642
wdenk6c59edc2004-05-03 20:45:30 +00004643 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00004644
wdenk6c59edc2004-05-03 20:45:30 +00004645The 'objcopy' does not understand the information in the U-Boot
4646image header, so the resulting S-Record file will be relative to
4647address 0x00000000. To load it to a given address, you need to
4648specify the target address as 'offset' parameter with the 'loads'
4649command.
wdenkc6097192002-11-03 00:24:07 +00004650
wdenk6c59edc2004-05-03 20:45:30 +00004651Example: install the image to address 0x40100000 (which on the
4652TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00004653
wdenk6c59edc2004-05-03 20:45:30 +00004654 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00004655
wdenk6c59edc2004-05-03 20:45:30 +00004656 .......... done
4657 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00004658
wdenk6c59edc2004-05-03 20:45:30 +00004659 => loads 40100000
4660 ## Ready for S-Record download ...
4661 ~>examples/image.srec
4662 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
4663 ...
4664 15989 15990 15991 15992
4665 [file transfer complete]
4666 [connected]
4667 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004668
wdenkc6097192002-11-03 00:24:07 +00004669
wdenk6c59edc2004-05-03 20:45:30 +00004670You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004671this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00004672corruption happened:
wdenkc6097192002-11-03 00:24:07 +00004673
wdenk6c59edc2004-05-03 20:45:30 +00004674 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00004675
wdenk6c59edc2004-05-03 20:45:30 +00004676 ## Checking Image at 40100000 ...
4677 Image Name: 2.2.13 for initrd on TQM850L
4678 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4679 Data Size: 335725 Bytes = 327 kB = 0 MB
4680 Load Address: 00000000
4681 Entry Point: 0000000c
4682 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004683
4684
wdenk6c59edc2004-05-03 20:45:30 +00004685Boot Linux:
4686-----------
wdenkc6097192002-11-03 00:24:07 +00004687
wdenk6c59edc2004-05-03 20:45:30 +00004688The "bootm" command is used to boot an application that is stored in
4689memory (RAM or Flash). In case of a Linux kernel image, the contents
4690of the "bootargs" environment variable is passed to the kernel as
4691parameters. You can check and modify this variable using the
4692"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00004693
wdenkc6097192002-11-03 00:24:07 +00004694
wdenk6c59edc2004-05-03 20:45:30 +00004695 => printenv bootargs
4696 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00004697
wdenk6c59edc2004-05-03 20:45:30 +00004698 => 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 +00004699
wdenk6c59edc2004-05-03 20:45:30 +00004700 => printenv bootargs
4701 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 +00004702
wdenk6c59edc2004-05-03 20:45:30 +00004703 => bootm 40020000
4704 ## Booting Linux kernel at 40020000 ...
4705 Image Name: 2.2.13 for NFS on TQM850L
4706 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4707 Data Size: 381681 Bytes = 372 kB = 0 MB
4708 Load Address: 00000000
4709 Entry Point: 0000000c
4710 Verifying Checksum ... OK
4711 Uncompressing Kernel Image ... OK
4712 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
4713 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4714 time_init: decrementer frequency = 187500000/60
4715 Calibrating delay loop... 49.77 BogoMIPS
4716 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
4717 ...
wdenkc6097192002-11-03 00:24:07 +00004718
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004719If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00004720the memory addresses of both the kernel and the initrd image (PPBCOOT
4721format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00004722
wdenk6c59edc2004-05-03 20:45:30 +00004723 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00004724
wdenk6c59edc2004-05-03 20:45:30 +00004725 ## Checking Image at 40100000 ...
4726 Image Name: 2.2.13 for initrd on TQM850L
4727 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4728 Data Size: 335725 Bytes = 327 kB = 0 MB
4729 Load Address: 00000000
4730 Entry Point: 0000000c
4731 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004732
wdenk6c59edc2004-05-03 20:45:30 +00004733 ## Checking Image at 40200000 ...
4734 Image Name: Simple Ramdisk Image
4735 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4736 Data Size: 566530 Bytes = 553 kB = 0 MB
4737 Load Address: 00000000
4738 Entry Point: 00000000
4739 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004740
wdenk6c59edc2004-05-03 20:45:30 +00004741 => bootm 40100000 40200000
4742 ## Booting Linux kernel at 40100000 ...
4743 Image Name: 2.2.13 for initrd on TQM850L
4744 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4745 Data Size: 335725 Bytes = 327 kB = 0 MB
4746 Load Address: 00000000
4747 Entry Point: 0000000c
4748 Verifying Checksum ... OK
4749 Uncompressing Kernel Image ... OK
4750 ## Loading RAMDisk Image at 40200000 ...
4751 Image Name: Simple Ramdisk Image
4752 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4753 Data Size: 566530 Bytes = 553 kB = 0 MB
4754 Load Address: 00000000
4755 Entry Point: 00000000
4756 Verifying Checksum ... OK
4757 Loading Ramdisk ... OK
4758 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
4759 Boot arguments: root=/dev/ram
4760 time_init: decrementer frequency = 187500000/60
4761 Calibrating delay loop... 49.77 BogoMIPS
4762 ...
4763 RAMDISK: Compressed image found at block 0
4764 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00004765
wdenk6c59edc2004-05-03 20:45:30 +00004766 bash#
wdenkc6097192002-11-03 00:24:07 +00004767
Matthew McClintockefae4ca2006-06-28 10:41:37 -05004768Boot Linux and pass a flat device tree:
4769-----------
4770
4771First, U-Boot must be compiled with the appropriate defines. See the section
4772titled "Linux Kernel Interface" above for a more in depth explanation. The
4773following is an example of how to start a kernel and pass an updated
4774flat device tree:
4775
4776=> print oftaddr
4777oftaddr=0x300000
4778=> print oft
4779oft=oftrees/mpc8540ads.dtb
4780=> tftp $oftaddr $oft
4781Speed: 1000, full duplex
4782Using TSEC0 device
4783TFTP from server 192.168.1.1; our IP address is 192.168.1.101
4784Filename 'oftrees/mpc8540ads.dtb'.
4785Load address: 0x300000
4786Loading: #
4787done
4788Bytes transferred = 4106 (100a hex)
4789=> tftp $loadaddr $bootfile
4790Speed: 1000, full duplex
4791Using TSEC0 device
4792TFTP from server 192.168.1.1; our IP address is 192.168.1.2
4793Filename 'uImage'.
4794Load address: 0x200000
4795Loading:############
4796done
4797Bytes transferred = 1029407 (fb51f hex)
4798=> print loadaddr
4799loadaddr=200000
4800=> print oftaddr
4801oftaddr=0x300000
4802=> bootm $loadaddr - $oftaddr
4803## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01004804 Image Name: Linux-2.6.17-dirty
4805 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4806 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05004807 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01004808 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05004809 Verifying Checksum ... OK
4810 Uncompressing Kernel Image ... OK
4811Booting using flat device tree at 0x300000
4812Using MPC85xx ADS machine description
4813Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
4814[snip]
4815
4816
wdenk6c59edc2004-05-03 20:45:30 +00004817More About U-Boot Image Types:
4818------------------------------
wdenkc6097192002-11-03 00:24:07 +00004819
wdenk6c59edc2004-05-03 20:45:30 +00004820U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00004821
wdenk6c59edc2004-05-03 20:45:30 +00004822 "Standalone Programs" are directly runnable in the environment
4823 provided by U-Boot; it is expected that (if they behave
4824 well) you can continue to work in U-Boot after return from
4825 the Standalone Program.
4826 "OS Kernel Images" are usually images of some Embedded OS which
4827 will take over control completely. Usually these programs
4828 will install their own set of exception handlers, device
4829 drivers, set up the MMU, etc. - this means, that you cannot
4830 expect to re-enter U-Boot except by resetting the CPU.
4831 "RAMDisk Images" are more or less just data blocks, and their
4832 parameters (address, size) are passed to an OS kernel that is
4833 being started.
4834 "Multi-File Images" contain several images, typically an OS
4835 (Linux) kernel image and one or more data images like
4836 RAMDisks. This construct is useful for instance when you want
4837 to boot over the network using BOOTP etc., where the boot
4838 server provides just a single image file, but you want to get
4839 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00004840
wdenk6c59edc2004-05-03 20:45:30 +00004841 "Multi-File Images" start with a list of image sizes, each
4842 image size (in bytes) specified by an "uint32_t" in network
4843 byte order. This list is terminated by an "(uint32_t)0".
4844 Immediately after the terminating 0 follow the images, one by
4845 one, all aligned on "uint32_t" boundaries (size rounded up to
4846 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00004847
wdenk6c59edc2004-05-03 20:45:30 +00004848 "Firmware Images" are binary images containing firmware (like
4849 U-Boot or FPGA images) which usually will be programmed to
4850 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00004851
wdenk6c59edc2004-05-03 20:45:30 +00004852 "Script files" are command sequences that will be executed by
4853 U-Boot's command interpreter; this feature is especially
4854 useful when you configure U-Boot to use a real shell (hush)
4855 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00004856
Marek Vasutcf41a9b2012-03-14 21:52:45 +00004857Booting the Linux zImage:
4858-------------------------
4859
4860On some platforms, it's possible to boot Linux zImage. This is done
4861using the "bootz" command. The syntax of "bootz" command is the same
4862as the syntax of "bootm" command.
4863
Tom Rini45f46d12013-05-16 11:40:11 -04004864Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut28850d02012-03-18 11:47:58 +00004865kernel with raw initrd images. The syntax is slightly different, the
4866address of the initrd must be augmented by it's size, in the following
4867format: "<initrd addres>:<initrd size>".
4868
stroeseb9c17c52003-04-04 15:53:41 +00004869
wdenk6c59edc2004-05-03 20:45:30 +00004870Standalone HOWTO:
4871=================
stroeseb9c17c52003-04-04 15:53:41 +00004872
wdenk6c59edc2004-05-03 20:45:30 +00004873One of the features of U-Boot is that you can dynamically load and
4874run "standalone" applications, which can use some resources of
4875U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00004876
wdenk6c59edc2004-05-03 20:45:30 +00004877Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00004878
wdenk6c59edc2004-05-03 20:45:30 +00004879"Hello World" Demo:
4880-------------------
wdenkc6097192002-11-03 00:24:07 +00004881
wdenk6c59edc2004-05-03 20:45:30 +00004882'examples/hello_world.c' contains a small "Hello World" Demo
4883application; it is automatically compiled when you build U-Boot.
4884It's configured to run at address 0x00040004, so you can play with it
4885like that:
wdenkc6097192002-11-03 00:24:07 +00004886
wdenk6c59edc2004-05-03 20:45:30 +00004887 => loads
4888 ## Ready for S-Record download ...
4889 ~>examples/hello_world.srec
4890 1 2 3 4 5 6 7 8 9 10 11 ...
4891 [file transfer complete]
4892 [connected]
4893 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004894
wdenk6c59edc2004-05-03 20:45:30 +00004895 => go 40004 Hello World! This is a test.
4896 ## Starting application at 0x00040004 ...
4897 Hello World
4898 argc = 7
4899 argv[0] = "40004"
4900 argv[1] = "Hello"
4901 argv[2] = "World!"
4902 argv[3] = "This"
4903 argv[4] = "is"
4904 argv[5] = "a"
4905 argv[6] = "test."
4906 argv[7] = "<NULL>"
4907 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00004908
wdenk6c59edc2004-05-03 20:45:30 +00004909 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004910
wdenk6c59edc2004-05-03 20:45:30 +00004911Another example, which demonstrates how to register a CPM interrupt
4912handler with the U-Boot code, can be found in 'examples/timer.c'.
4913Here, a CPM timer is set up to generate an interrupt every second.
4914The interrupt service routine is trivial, just printing a '.'
4915character, but this is just a demo program. The application can be
4916controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00004917
wdenk6c59edc2004-05-03 20:45:30 +00004918 ? - print current values og the CPM Timer registers
4919 b - enable interrupts and start timer
4920 e - stop timer and disable interrupts
4921 q - quit application
wdenkc6097192002-11-03 00:24:07 +00004922
wdenk6c59edc2004-05-03 20:45:30 +00004923 => loads
4924 ## Ready for S-Record download ...
4925 ~>examples/timer.srec
4926 1 2 3 4 5 6 7 8 9 10 11 ...
4927 [file transfer complete]
4928 [connected]
4929 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004930
wdenk6c59edc2004-05-03 20:45:30 +00004931 => go 40004
4932 ## Starting application at 0x00040004 ...
4933 TIMERS=0xfff00980
4934 Using timer 1
4935 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00004936
wdenk6c59edc2004-05-03 20:45:30 +00004937Hit 'b':
4938 [q, b, e, ?] Set interval 1000000 us
4939 Enabling timer
4940Hit '?':
4941 [q, b, e, ?] ........
4942 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4943Hit '?':
4944 [q, b, e, ?] .
4945 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4946Hit '?':
4947 [q, b, e, ?] .
4948 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4949Hit '?':
4950 [q, b, e, ?] .
4951 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4952Hit 'e':
4953 [q, b, e, ?] ...Stopping timer
4954Hit 'q':
4955 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004956
wdenkc6097192002-11-03 00:24:07 +00004957
wdenk6c59edc2004-05-03 20:45:30 +00004958Minicom warning:
4959================
wdenkc6097192002-11-03 00:24:07 +00004960
wdenk6c59edc2004-05-03 20:45:30 +00004961Over time, many people have reported problems when trying to use the
4962"minicom" terminal emulation program for serial download. I (wd)
4963consider minicom to be broken, and recommend not to use it. Under
4964Unix, I recommend to use C-Kermit for general purpose use (and
4965especially for kermit binary protocol download ("loadb" command), and
Karl O. Pinca0189bb2012-10-01 05:11:56 +00004966use "cu" for S-Record download ("loads" command). See
4967http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
4968for help with kermit.
4969
wdenkc6097192002-11-03 00:24:07 +00004970
wdenk6c59edc2004-05-03 20:45:30 +00004971Nevertheless, if you absolutely want to use it try adding this
4972configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00004973
wdenk6c59edc2004-05-03 20:45:30 +00004974 Name Program Name U/D FullScr IO-Red. Multi
4975 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
4976 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00004977
wdenk8dba0502003-03-31 16:34:49 +00004978
wdenk6c59edc2004-05-03 20:45:30 +00004979NetBSD Notes:
4980=============
wdenkc6097192002-11-03 00:24:07 +00004981
wdenk6c59edc2004-05-03 20:45:30 +00004982Starting at version 0.9.2, U-Boot supports NetBSD both as host
4983(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00004984
wdenk6c59edc2004-05-03 20:45:30 +00004985Building requires a cross environment; it is known to work on
4986NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4987need gmake since the Makefiles are not compatible with BSD make).
4988Note that the cross-powerpc package does not install include files;
4989attempting to build U-Boot will fail because <machine/ansi.h> is
4990missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00004991
wdenk6c59edc2004-05-03 20:45:30 +00004992 # cd /usr/pkg/cross/powerpc-netbsd/include
4993 # mkdir powerpc
4994 # ln -s powerpc machine
4995 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4996 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00004997
wdenk6c59edc2004-05-03 20:45:30 +00004998Native builds *don't* work due to incompatibilities between native
4999and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00005000
wdenk6c59edc2004-05-03 20:45:30 +00005001Booting assumes that (the first part of) the image booted is a
5002stage-2 loader which in turn loads and then invokes the kernel
5003proper. Loader sources will eventually appear in the NetBSD source
5004tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00005005meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00005006
wdenkc6097192002-11-03 00:24:07 +00005007
wdenk6c59edc2004-05-03 20:45:30 +00005008Implementation Internals:
5009=========================
wdenkc6097192002-11-03 00:24:07 +00005010
wdenk6c59edc2004-05-03 20:45:30 +00005011The following is not intended to be a complete description of every
5012implementation detail. However, it should help to understand the
5013inner workings of U-Boot and make it easier to port it to custom
5014hardware.
wdenkc6097192002-11-03 00:24:07 +00005015
wdenkc6097192002-11-03 00:24:07 +00005016
wdenk6c59edc2004-05-03 20:45:30 +00005017Initial Stack, Global Data:
5018---------------------------
wdenkc6097192002-11-03 00:24:07 +00005019
wdenk6c59edc2004-05-03 20:45:30 +00005020The implementation of U-Boot is complicated by the fact that U-Boot
5021starts running out of ROM (flash memory), usually without access to
5022system RAM (because the memory controller is not initialized yet).
5023This means that we don't have writable Data or BSS segments, and BSS
5024is not initialized as zero. To be able to get a C environment working
5025at all, we have to allocate at least a minimal stack. Implementation
5026options for this are defined and restricted by the CPU used: Some CPU
5027models provide on-chip memory (like the IMMR area on MPC8xx and
5028MPC826x processors), on others (parts of) the data cache can be
5029locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00005030
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005031 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005032 U-Boot mailing list:
wdenkc6097192002-11-03 00:24:07 +00005033
wdenk6c59edc2004-05-03 20:45:30 +00005034 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
5035 From: "Chris Hallinan" <clh@net1plus.com>
5036 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
5037 ...
wdenkc6097192002-11-03 00:24:07 +00005038
wdenk6c59edc2004-05-03 20:45:30 +00005039 Correct me if I'm wrong, folks, but the way I understand it
5040 is this: Using DCACHE as initial RAM for Stack, etc, does not
5041 require any physical RAM backing up the cache. The cleverness
5042 is that the cache is being used as a temporary supply of
5043 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005044 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00005045 can see how this works by studying the cache architecture and
5046 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00005047
wdenk6c59edc2004-05-03 20:45:30 +00005048 OCM is On Chip Memory, which I believe the 405GP has 4K. It
5049 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005050 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00005051 option should work for you. Using CS 4 should be fine if your
5052 board designers haven't used it for something that would
5053 cause you grief during the initial boot! It is frequently not
5054 used.
wdenkc6097192002-11-03 00:24:07 +00005055
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005056 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00005057 with your processor/board/system design. The default value
5058 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02005059 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00005060 than your SDRAM module. If you have a 64MB SDRAM module, set
5061 it above 400_0000. Just make sure your board has no resources
5062 that are supposed to respond to that address! That code in
5063 start.S has been around a while and should work as is when
5064 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00005065
wdenk6c59edc2004-05-03 20:45:30 +00005066 -Chris Hallinan
5067 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00005068
wdenk6c59edc2004-05-03 20:45:30 +00005069It is essential to remember this, since it has some impact on the C
5070code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00005071
wdenk6c59edc2004-05-03 20:45:30 +00005072* Initialized global data (data segment) is read-only. Do not attempt
5073 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00005074
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005075* Do not use any uninitialized global data (or implicitly initialized
wdenk6c59edc2004-05-03 20:45:30 +00005076 as zero data - BSS segment) at all - this is undefined, initiali-
5077 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00005078
wdenk6c59edc2004-05-03 20:45:30 +00005079* Stack space is very limited. Avoid big data buffers or things like
5080 that.
wdenk4a5c8a72003-03-06 00:02:04 +00005081
wdenk6c59edc2004-05-03 20:45:30 +00005082Having only the stack as writable memory limits means we cannot use
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005083normal global data to share information between the code. But it
wdenk6c59edc2004-05-03 20:45:30 +00005084turned out that the implementation of U-Boot can be greatly
5085simplified by making a global data structure (gd_t) available to all
5086functions. We could pass a pointer to this data as argument to _all_
5087functions, but this would bloat the code. Instead we use a feature of
5088the GCC compiler (Global Register Variables) to share the data: we
5089place a pointer (gd) to the global data into a register which we
5090reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00005091
wdenk6c59edc2004-05-03 20:45:30 +00005092When choosing a register for such a purpose we are restricted by the
5093relevant (E)ABI specifications for the current architecture, and by
5094GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00005095
wdenk6c59edc2004-05-03 20:45:30 +00005096For PowerPC, the following registers have specific use:
5097 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01005098 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00005099 R3-R4: parameter passing and return values
5100 R5-R10: parameter passing
5101 R13: small data area pointer
5102 R30: GOT pointer
5103 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00005104
Joakim Tjernlund693c0c12010-01-19 14:41:58 +01005105 (U-Boot also uses R12 as internal GOT pointer. r12
5106 is a volatile register so r12 needs to be reset when
5107 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00005108
Wolfgang Denk69c09642008-02-14 22:43:22 +01005109 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005110
wdenk6c59edc2004-05-03 20:45:30 +00005111 Note: on PPC, we could use a static initializer (since the
5112 address of the global data structure is known at compile time),
5113 but it turned out that reserving a register results in somewhat
5114 smaller code - although the code savings are not that big (on
5115 average for all boards 752 bytes for the whole U-Boot image,
5116 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00005117
wdenk6c59edc2004-05-03 20:45:30 +00005118On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00005119
wdenk6c59edc2004-05-03 20:45:30 +00005120 R0: function argument word/integer result
5121 R1-R3: function argument word
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02005122 R9: platform specific
5123 R10: stack limit (used only if stack checking is enabled)
wdenk6c59edc2004-05-03 20:45:30 +00005124 R11: argument (frame) pointer
5125 R12: temporary workspace
5126 R13: stack pointer
5127 R14: link register
5128 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00005129
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02005130 ==> U-Boot will use R9 to hold a pointer to the global data
5131
5132 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00005133
Thomas Chou8fa38582010-05-21 11:08:03 +08005134On Nios II, the ABI is documented here:
5135 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
5136
5137 ==> U-Boot will use gp to hold a pointer to the global data
5138
5139 Note: on Nios II, we give "-G0" option to gcc and don't use gp
5140 to access small data sections, so gp is free.
5141
Macpaul Lin1cac36e2011-10-19 20:41:11 +00005142On NDS32, the following registers are used:
5143
5144 R0-R1: argument/return
5145 R2-R5: argument
5146 R15: temporary register for assembler
5147 R16: trampoline register
5148 R28: frame pointer (FP)
5149 R29: global pointer (GP)
5150 R30: link register (LP)
5151 R31: stack pointer (SP)
5152 PC: program counter (PC)
5153
5154 ==> U-Boot will use R10 to hold a pointer to the global data
5155
Wolfgang Denk6405a152006-03-31 18:32:53 +02005156NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5157or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00005158
wdenk6c59edc2004-05-03 20:45:30 +00005159Memory Management:
5160------------------
wdenkc6097192002-11-03 00:24:07 +00005161
wdenk6c59edc2004-05-03 20:45:30 +00005162U-Boot runs in system state and uses physical addresses, i.e. the
5163MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00005164
wdenk6c59edc2004-05-03 20:45:30 +00005165The available memory is mapped to fixed addresses using the memory
5166controller. In this process, a contiguous block is formed for each
5167memory type (Flash, SDRAM, SRAM), even when it consists of several
5168physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00005169
wdenk6c59edc2004-05-03 20:45:30 +00005170U-Boot is installed in the first 128 kB of the first Flash bank (on
5171TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5172booting and sizing and initializing DRAM, the code relocates itself
5173to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005174memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00005175configuration setting]. Below that, a structure with global Board
5176Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00005177
wdenk6c59edc2004-05-03 20:45:30 +00005178Additionally, some exception handler code is copied to the low 8 kB
5179of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00005180
wdenk6c59edc2004-05-03 20:45:30 +00005181So a typical memory configuration with 16 MB of DRAM could look like
5182this:
wdenkc6097192002-11-03 00:24:07 +00005183
wdenk6c59edc2004-05-03 20:45:30 +00005184 0x0000 0000 Exception Vector code
5185 :
5186 0x0000 1FFF
5187 0x0000 2000 Free for Application Use
5188 :
5189 :
wdenkc6097192002-11-03 00:24:07 +00005190
wdenk6c59edc2004-05-03 20:45:30 +00005191 :
5192 :
5193 0x00FB FF20 Monitor Stack (Growing downward)
5194 0x00FB FFAC Board Info Data and permanent copy of global data
5195 0x00FC 0000 Malloc Arena
5196 :
5197 0x00FD FFFF
5198 0x00FE 0000 RAM Copy of Monitor Code
5199 ... eventually: LCD or video framebuffer
5200 ... eventually: pRAM (Protected RAM - unchanged by reset)
5201 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00005202
wdenkc6097192002-11-03 00:24:07 +00005203
wdenk6c59edc2004-05-03 20:45:30 +00005204System Initialization:
5205----------------------
wdenkc6097192002-11-03 00:24:07 +00005206
wdenk6c59edc2004-05-03 20:45:30 +00005207In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005208(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005209configuration for CS0# this is a mirror of the on board Flash memory.
wdenk6c59edc2004-05-03 20:45:30 +00005210To be able to re-map memory U-Boot then jumps to its link address.
5211To be able to implement the initialization code in C, a (small!)
5212initial stack is set up in the internal Dual Ported RAM (in case CPUs
Heiko Schocher71cb3e92017-06-07 17:33:10 +02005213which provide such a feature like), or in a locked part of the data
5214cache. After that, U-Boot initializes the CPU core, the caches and
5215the SIU.
wdenkc6097192002-11-03 00:24:07 +00005216
wdenk6c59edc2004-05-03 20:45:30 +00005217Next, all (potentially) available memory banks are mapped using a
5218preliminary mapping. For example, we put them on 512 MB boundaries
5219(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5220on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5221programmed for SDRAM access. Using the temporary configuration, a
5222simple memory test is run that determines the size of the SDRAM
5223banks.
wdenkc6097192002-11-03 00:24:07 +00005224
wdenk6c59edc2004-05-03 20:45:30 +00005225When there is more than one SDRAM bank, and the banks are of
5226different size, the largest is mapped first. For equal size, the first
5227bank (CS2#) is mapped first. The first mapping is always for address
52280x00000000, with any additional banks following immediately to create
5229contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00005230
wdenk6c59edc2004-05-03 20:45:30 +00005231Then, the monitor installs itself at the upper end of the SDRAM area
5232and allocates memory for use by malloc() and for the global Board
5233Info data; also, the exception vector code is copied to the low RAM
5234pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00005235
wdenk6c59edc2004-05-03 20:45:30 +00005236Only after this relocation will you have a "normal" C environment;
5237until that you are restricted in several ways, mostly because you are
5238running from ROM, and because the code will have to be relocated to a
5239new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00005240
wdenkc6097192002-11-03 00:24:07 +00005241
wdenk6c59edc2004-05-03 20:45:30 +00005242U-Boot Porting Guide:
5243----------------------
wdenkc6097192002-11-03 00:24:07 +00005244
wdenk6c59edc2004-05-03 20:45:30 +00005245[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
5246list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00005247
wdenkc6097192002-11-03 00:24:07 +00005248
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005249int main(int argc, char *argv[])
wdenk6c59edc2004-05-03 20:45:30 +00005250{
5251 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00005252
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005253 signal(SIGALRM, no_more_time);
5254 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00005255
wdenk6c59edc2004-05-03 20:45:30 +00005256 if (available_money > available_manpower) {
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005257 Pay consultant to port U-Boot;
wdenk6c59edc2004-05-03 20:45:30 +00005258 return 0;
5259 }
wdenkc6097192002-11-03 00:24:07 +00005260
wdenk6c59edc2004-05-03 20:45:30 +00005261 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00005262
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005263 Subscribe to u-boot mailing list;
wdenkc6097192002-11-03 00:24:07 +00005264
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005265 if (clueless)
5266 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00005267
wdenk6c59edc2004-05-03 20:45:30 +00005268 while (learning) {
5269 Read the README file in the top level directory;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005270 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
5271 Read applicable doc/*.README;
wdenk6c59edc2004-05-03 20:45:30 +00005272 Read the source, Luke;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005273 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk6c59edc2004-05-03 20:45:30 +00005274 }
wdenkc6097192002-11-03 00:24:07 +00005275
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005276 if (available_money > toLocalCurrency ($2500))
5277 Buy a BDI3000;
5278 else
wdenk6c59edc2004-05-03 20:45:30 +00005279 Add a lot of aggravation and time;
wdenkc6097192002-11-03 00:24:07 +00005280
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005281 if (a similar board exists) { /* hopefully... */
5282 cp -a board/<similar> board/<myboard>
5283 cp include/configs/<similar>.h include/configs/<myboard>.h
5284 } else {
5285 Create your own board support subdirectory;
5286 Create your own board include/configs/<myboard>.h file;
5287 }
5288 Edit new board/<myboard> files
5289 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00005290
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005291 while (!accepted) {
5292 while (!running) {
5293 do {
5294 Add / modify source code;
5295 } until (compiles);
5296 Debug;
5297 if (clueless)
5298 email("Hi, I am having problems...");
5299 }
5300 Send patch file to the U-Boot email list;
5301 if (reasonable critiques)
5302 Incorporate improvements from email list code review;
5303 else
5304 Defend code as written;
wdenk634d2f72004-04-15 23:14:49 +00005305 }
wdenkc6097192002-11-03 00:24:07 +00005306
wdenk6c59edc2004-05-03 20:45:30 +00005307 return 0;
5308}
wdenkc6097192002-11-03 00:24:07 +00005309
wdenk6c59edc2004-05-03 20:45:30 +00005310void no_more_time (int sig)
5311{
5312 hire_a_guru();
5313}
wdenkc6097192002-11-03 00:24:07 +00005314
wdenkc6097192002-11-03 00:24:07 +00005315
wdenk6c59edc2004-05-03 20:45:30 +00005316Coding Standards:
5317-----------------
wdenkc6097192002-11-03 00:24:07 +00005318
wdenk6c59edc2004-05-03 20:45:30 +00005319All contributions to U-Boot should conform to the Linux kernel
Detlev Zundelaa63d482006-09-01 15:39:02 +02005320coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005321"scripts/Lindent" in your Linux kernel source directory.
Detlev Zundelaa63d482006-09-01 15:39:02 +02005322
5323Source files originating from a different project (for example the
5324MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005325reformatted to ease subsequent migration to newer versions of those
Detlev Zundelaa63d482006-09-01 15:39:02 +02005326sources.
wdenkc6097192002-11-03 00:24:07 +00005327
Detlev Zundelaa63d482006-09-01 15:39:02 +02005328Please note that U-Boot is implemented in C (and to some small parts in
5329Assembler); no C++ is used, so please do not use C++ style comments (//)
5330in your code.
wdenkad276f22004-01-04 16:28:35 +00005331
wdenk6c59edc2004-05-03 20:45:30 +00005332Please also stick to the following formatting rules:
5333- remove any trailing white space
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005334- use TAB characters for indentation and vertical alignment, not spaces
wdenk6c59edc2004-05-03 20:45:30 +00005335- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005336- do not add more than 2 consecutive empty lines to source files
wdenk6c59edc2004-05-03 20:45:30 +00005337- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00005338
wdenk6c59edc2004-05-03 20:45:30 +00005339Submissions which do not conform to the standards may be returned
5340with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00005341
wdenkc6097192002-11-03 00:24:07 +00005342
wdenk6c59edc2004-05-03 20:45:30 +00005343Submitting Patches:
5344-------------------
wdenkc6097192002-11-03 00:24:07 +00005345
wdenk6c59edc2004-05-03 20:45:30 +00005346Since the number of patches for U-Boot is growing, we need to
5347establish some rules. Submissions which do not conform to these rules
5348may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00005349
Magnus Liljaf3b287b2008-08-06 19:32:33 +02005350Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005351
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005352Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
5353see http://lists.denx.de/mailman/listinfo/u-boot
5354
wdenk6c59edc2004-05-03 20:45:30 +00005355When you send a patch, please include the following information with
5356it:
wdenkc6097192002-11-03 00:24:07 +00005357
wdenk6c59edc2004-05-03 20:45:30 +00005358* For bug fixes: a description of the bug and how your patch fixes
5359 this bug. Please try to include a way of demonstrating that the
5360 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00005361
wdenk6c59edc2004-05-03 20:45:30 +00005362* For new features: a description of the feature and your
5363 implementation.
wdenkc6097192002-11-03 00:24:07 +00005364
wdenk6c59edc2004-05-03 20:45:30 +00005365* A CHANGELOG entry as plaintext (separate from the patch)
wdenkc6097192002-11-03 00:24:07 +00005366
Robert P. J. Day076ed9b2015-12-19 07:16:10 -05005367* For major contributions, add a MAINTAINERS file with your
5368 information and associated file and directory references.
wdenkc6097192002-11-03 00:24:07 +00005369
Albert ARIBAUD48e910f2013-09-11 15:52:51 +02005370* When you add support for a new board, don't forget to add a
5371 maintainer e-mail address to the boards.cfg file, too.
wdenkc6097192002-11-03 00:24:07 +00005372
wdenk6c59edc2004-05-03 20:45:30 +00005373* If your patch adds new configuration options, don't forget to
5374 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00005375
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005376* The patch itself. If you are using git (which is *strongly*
5377 recommended) you can easily generate the patch using the
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005378 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005379 the U-Boot mailing list, you will avoid most of the common problems
5380 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00005381
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005382 If you cannot use git, use "diff -purN OLD NEW". If your version of
5383 diff does not support these options, then get the latest version of
5384 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00005385
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005386 The current directory when running this command shall be the parent
5387 directory of the U-Boot source tree (i. e. please make sure that
5388 your patch includes sufficient directory information for the
5389 affected files).
5390
5391 We prefer patches as plain text. MIME attachments are discouraged,
5392 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00005393
wdenk6c59edc2004-05-03 20:45:30 +00005394* If one logical set of modifications affects or creates several
5395 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00005396
wdenk6c59edc2004-05-03 20:45:30 +00005397* Changesets that contain different, unrelated modifications shall be
5398 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00005399
wdenkc6097192002-11-03 00:24:07 +00005400
wdenk6c59edc2004-05-03 20:45:30 +00005401Notes:
wdenkc6097192002-11-03 00:24:07 +00005402
Simon Glassdc27def2016-07-27 20:33:08 -06005403* Before sending the patch, run the buildman script on your patched
wdenk6c59edc2004-05-03 20:45:30 +00005404 source tree and make sure that no errors or warnings are reported
5405 for any of the boards.
5406
5407* Keep your modifications to the necessary minimum: A patch
5408 containing several unrelated changes or arbitrary reformats will be
5409 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00005410
wdenk6c59edc2004-05-03 20:45:30 +00005411* If you modify existing code, make sure that your new code does not
5412 add to the memory footprint of the code ;-) Small is beautiful!
5413 When adding new features, these should compile conditionally only
5414 (using #ifdef), and the resulting code with the new feature
5415 disabled must not need more memory than the old code without your
5416 modification.
wdenkcbc49a52005-05-03 14:12:25 +00005417
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005418* Remember that there is a size limit of 100 kB per message on the
5419 u-boot mailing list. Bigger patches will be moderated. If they are
5420 reasonable and not too big, they will be acknowledged. But patches
5421 bigger than the size limit should be avoided.